My Geocode

郵便番号検索

郵便番号を入力すると、それが属する場所を返します。160か国に対応しています。

GEThttps://api.mygeocode.com/v1/postcode

パラメータ

パラメータ型説明
code必須文字列郵便番号。空白、ハイフン、大文字と小文字は正規化されます。
country任意文字列ISO 3166-1 alpha-2コード。郵便番号は国をまたいで一意ではないため、指定を強く推奨します。指定しない場合は、一致するすべての国の結果が人口の多い順に返されます。
lang任意文字列地名と地域名に使うISO 639-1コード。既定値はen。
key任意文字列ヘッダーで送信しない場合のAPIキー。

例

$ curl -H "X-API-Key: YOUR_KEY" "https://api.mygeocode.com/v1/postcode?code=75008&country=fr"
const url = new URL("https://api.mygeocode.com/v1/postcode");
url.searchParams.set("code", "75008");
url.searchParams.set("country", "fr");

const { results } = await (await fetch(url, { headers: { "X-API-Key": "YOUR_KEY" } })).json();
console.log(results[0].place, results[0].lat, results[0].lon);
import requests

r = requests.get("https://api.mygeocode.com/v1/postcode", params={"code": "75008", "country": "fr"}, headers={"X-API-Key": "YOUR_KEY"}, timeout=5)
first = r.json()["results"][0]
print(first["place"], first["lat"], first["lon"])
レスポンス
{
  "status": "ok",
  "postcode": "75008",
  "country_code": "FR",
  "results": [
    {
      "postcode": "75008",
      "place": "Paris 8e Arrondissement",
      "region": "Ile-de-France",
      "region_code": "IDF",
      "country": "France",
      "country_code": "FR",
      "lat": 48.8727,
      "lon": 2.3125
    }
  ]
}

レスポンスフィールド

フィールド型説明
postcode文字列正規化後のコード。
country_code文字列またはnull適用された国のフィルター（ある場合）。
results配列そのコードが対象とする場所。通常は1つですが、複数の村にまたがる農村部のコードでは複数になります。コードが不明な場合は空です。
results[].place文字列郵便事業者が使っている地名。
results[].region, region_code文字列第1レベルの行政区分とそのISO 3166-2接尾辞。
results[].lat, lon数値郵便事業者が公開している地点。公開されていない場合は、そのコード内の住所の重心。

注意事項

エラー

codeが空か16文字を超える場合、またはcountryが有効なalpha-2コードでない場合は400 invalid_request。