📮 Postal Ark

📮 Postal Ark

🏣郵便番号の検索APIサービスです。
  • 郵便番号から住所を検索
  • 住所から郵便番号を検索
  • 住所の一部でも検索可能(市区町村名など)
  • 検索住所は半角全角や漢数字にも対応
  • 事業所の個別郵便番号にも対応
  • レスポンス形式はJSON/XMLに対応
  • 無料版は10分間に20回の呼び出し回数制限

利用開始にはユーザー登録が必要です。

新規登録する 登録済みの方はログイン

APIリファレンス

GETリクエストに対してJSON形式でレスポンスを返します。

※ユーザー登録後に発行されるAPIキーが必要になります。

EndPoint:
https://postal.neutralark.com/api

APIキーの設定

HTTPヘッダーにAPIキーを設定してください。

X-POSTALKEY: {APIキー}

リクエストパラメーター

QueryStringに検索する郵便番号または住所を指定してください。

v={必須: 郵便番号または住所}

e={任意: 0だと事業所郵便番号を含まない、1だと事業所郵便番号を含む / 指定が無い場合は1}

p={任意: 都道府県コードで絞り込み / 指定が無い場合は全て}

g={任意: 地方公共団体コード(6桁)で絞り込み / 指定が無い場合は全て}

サンプル

1. 郵便番号を指定して住所を検索する場合(事業所郵便番号で検索)

$ curl --header "X-POSTALKEY: {APIキー}" "https://postal.neutralark.com/api?v=1508510" 
{
  "status": 200,
  "count": 1,
  "results": [
    {
      "code": "1508510",
      "government": "13113",
      "prefecture": "13",
      "address": [
        "東京都",
        "渋谷区",
        "渋谷",
        "２丁目２１番１号"
      ],
      "name": "渋谷ヒカリエ",
      "name_kana": "シブヤヒカリエ"
    }
  ]
}

2. 住所を指定して郵便番号を検索する場合

$ curl --header "X-POSTALKEY: {APIキー}" "https://postal.neutralark.com/api?v=東京都渋谷区渋谷&e=0" 
{
  "status": 200,
  "count": 50,
  "results": [
    {
      "code": "1500000",
      "government": "13113",
      "prefecture": "13",
      "address": [
        "東京都",
        "渋谷区"
      ]
    },
    {
      "code": "1500002",
      "government": "13113",
      "prefecture": "13",
      "address": [
        "東京都",
        "渋谷区",
        "渋谷"
      ]
    },
    {
      "code": "1506190",
      "government": "13113",
      "prefecture": "13",
      "address": [
        "東京都",
        "渋谷区",
        "渋谷渋谷スクランブルスクエア"
      ]
    }, ...
  ]
}