フィードバック

当サービスに関する報告・ご要望・お問い合わせを管理者宛に送信します。
回答をご希望の方は、ご連絡先を入力してください。

ご連絡先任意
メッセージ

ZIPCODA API

ご利用の前に必ず このサイトについて をご確認ください。

Request URI

GET https://zipcoda.net/api

リクエストURIにGETパラメータを付与してアクセスしてください。 全てのレスポンスはJSON形式で返却されます。

Request Parameters

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

現在はCORS対応がなされておりJSONPを使用する必要はないため、非推奨の機能です。

  • zipcodeで検索をすると郵便番号で検索をおこないます。 渡した数値が7桁に満たない場合は前方一致で検索されます。 7桁を超過した場合は結果は返りません。
  • addressで検索をすると住所で部分一致検索をおこないます。 空白文字で区切ることで、AND検索をする事ができます。
  • addresszipcodeが共に渡されると、zipcodeが優先され郵便番号による検索をおこないます。 この場合addressの指定は無視されます。

Response Data

{
  "status": 200,
  "length": 1,
  "items": [
    {
      "zipcode": "1050011",
      "pref": "東京都",
      "state_name": "東京都",
      "components": ["東京都", "港区", "芝公園"],
      "address": "港区芝公園"
    }
  ]
}
statusnumberステータスコードが数値で返却されます。
(200, 400, 404...)
itemsAddressItem[]検索結果が AddressItem の配列で返却されます。
結果の数が100件を超過した場合は最初の100件のみが返却されます。
lengthnumber検索結果数が数値で返却されます。
件数が100を超過してitemsが100件に絞られた場合でも実際の件数が返されます。

AddressItem

zipcodestring郵便番号文字列
prefstring都道府県名文字列
componentsstring[]住所の部品を文字列の配列で列挙(都道府県名を含む)
address住所文字列都道府県名を除いた住所文字列
notesstring備考文字列(住所データ行に付記された括弧内の文字列があれば返されます)

Examples

Fetch API

const params = new URLSearchParams({ zipcode: "1050011" });

fetch("https://zipcoda.net/api?" + params)
  .then((response) => response.json())
  .then((data) => console.log(data.items));

Axios

axios
  .get("https://zipcoda.net/api", {
    params: {
      zipcode: "1050011",
    },
  })
  .then((response) => console.log(response.data.items));

jQuery

$.getJSON("https://zipcoda.net/api", { zipcode: "1050011" }).then((data) =>
  console.log(data.items),
);

注意事項

  • このサイトについてをご確認いただき、ご理解いただいた上でご利用ください。
  • 過度なアクセスは固くお断りします。 プログラムから連続してアクセスをする場合は、数秒のインターバルをおいて処理をおこなってください。
  • APIアクセスはスロットリングによる制限を設けています。 同一IPアドレスからのアクセスが制限を超過した場合、アクセスが一時的に制限されます。
  • サービスの運用に悪影響を及ぼすと判断した場合、アクセスを制限させていただく場合があります。