APIについて

※ご利用の前に必ず ご利用について をご一読ください。

リクエストURIにGETパラメータを付与してアクセスしてください。 返されるデータは全てJSONで取得されます。

リクエストURI

GET http://zipcoda.net/api

パラメータ

zipcode 半角英数字で郵便番号を渡します。
このパラメータがあった場合は郵便番号→住所の検索を行います。
(addressが同時に付与された場合はzipcodeが優先されます)
address 住所の文字列を渡します。
このパラメータがあった場合は住所→郵便番号の検索を行います。
(zipcodeが同時に付与された場合はzipcodeが優先されます)
callback コールバック関数名を渡します。
このパラメータがあった場合はJSONPとしてレスポンスを返します。

レスポンスデータ

status String ステータス("success", "error" )
length Number 抽出されたアイテム数
items Array 後述の 'item' オブジェクトを格納した配列。

item オブジェクト

state Number 1-43の都道府県コード
state_name String 都道府県名
zipcode String 郵便番号。
components Array 住所の部品文字列。
address String 住所の文字列。

例:

{
    "status": "success",
    "length": 1,
    "items": [
        {
            "state": 13,
            "state_name": "東京都",
            "zipcode": "1500011",
            "components": ["東京都", "港区", "芝公園"],
            "address": "東京都港区芝公園"
        }                       
    ]
}

jQueryでの利用例

(function($){
    $.ajax({
        url: "http://zipcoda.net/api",
        dataType: "jsonp",
        data: {
            zipcode: "1500011"
        }
    })
    .then(function(data){
        console.log(data);
    })
}(jQuery));

このサイトについて

Zipcoda (zipcoda.net)は、 郵便番号から住所を、あるいは住所から郵便番号の候補を検索したり、 現在の位置情報から郵便番号を検索する為のWebサービスです。 サイト上のフォームによる検索の他、開発者用の API を提供します。

当サービスの不明点・不具合などに関するお問い合わせは @zipcoda までお寄せください。 サービス内容の変更等については同アカウントよりお知らせ致します。

ご利用規約

以下の規約に同意いただける方のみ当サービスをご利用ください。 (ご利用いただいた時点で、規約に同意いただいたものと致します)

  1. 商用・非商用に関わらず無償でご利用いただけます。
  2. 過度なアクセス等、当サービスに悪影響を及ぼす物につきましては一時的・部分的に制限を掛けさせていただく場合がございます。
  3. 当サービスの検索フォームならびにAPIのご利用においては可能な限りの正確性と安定性に務めますが、 完全に安定した情報の提供を約束するものではありません。
  4. 当サービスは作者の都合により、変更・停止・閉鎖させていただく場合がございます。
  5. 当サービスをご利用いただいた事、または利用できない状態になった事による一切の損害について、責任は負いません。

動作環境

当サービスは下記の環境での動作を保証いたしません。

  • InternetExplorer8 以前の旧世代のブラウザ環境
  • 位置情報サービスをサポートしない環境(「現在位置からの検索」のみ)
  • Googleの位置情報ライブラリならびにアドセンスのJavaScriptコードがサポートしない環境