ご利用の前に必ず このサイトについて をご確認ください。
GET https://zipcoda.net/api
リクエストURIにGETパラメータを付与してアクセスしてください。 全てのレスポンスはJSON形式で返却されます。
| zipcode | string | 半角数字（〜7桁）で郵便番号を渡します。 このパラメータが渡されると郵便番号→住所の検索を行います。 |
|---|---|---|
| address | string | 住所の文字列を渡します。 このパラメータが渡されると住所→郵便番号の検索を行います。 （ zipcodeが同時に付与された場合はzipcodeが優先されます） |
| callback | string | コールバック関数名を渡します。 このパラメータが渡されるとJSONPでレスポンスを返します。 現在はCORS対応がなされておりJSONPを使用する必要はないため、非推奨の機能です。 |
zipcodeで検索をすると郵便番号で検索をおこないます。 渡した数値が7桁に満たない場合は前方一致で検索されます。 7桁を超過した場合は結果は返りません。addressで検索をすると住所で部分一致検索をおこないます。 空白文字で区切ることで、AND検索をする事ができます。addressとzipcodeが共に渡されると、zipcodeが優先され郵便番号による検索をおこないます。 この場合addressの指定は無視されます。{
"status": 200,
"length": 1,
"items": [
{
"zipcode": "1050011",
"pref": "東京都",
"state_name": "東京都",
"components": ["東京都", "港区", "芝公園"],
"address": "港区芝公園"
}
]
}| status | number | ステータスコードが数値で返却されます。 （200, 400, 404...） |
|---|---|---|
| items | AddressItem[] | 検索結果が AddressItem の配列で返却されます。結果の数が100件を超過した場合は最初の100件のみが返却されます。 |
| length | number | 検索結果数が数値で返却されます。 件数が100を超過して itemsが100件に絞られた場合でも実際の件数が返されます。 |
| zipcode | string | 郵便番号文字列 |
|---|---|---|
| pref | string | 都道府県名文字列 |
| components | string[] | 住所の部品を文字列の配列で列挙（都道府県名を含む） |
| address | 住所文字列 | 都道府県名を除いた住所文字列 |
| notes | string | 備考文字列（住所データ行に付記された括弧内の文字列があれば返されます） |
const params = new URLSearchParams({ zipcode: "1050011" });
fetch("https://zipcoda.net/api?" + params)
.then((response) => response.json())
.then((data) => console.log(data.items));axios
.get("https://zipcoda.net/api", {
params: {
zipcode: "1050011",
},
})
.then((response) => console.log(response.data.items));$.getJSON("https://zipcoda.net/api", { zipcode: "1050011" }).then((data) =>
console.log(data.items),
);