住所コードでの住所検索

API名:

address/code

概要:

リクエストパラメータで指定される住所コードを元に該当する住所情報を返却します。

※多言語情報の出力には別途契約が必要です。

URI:

https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/address/code

<API使用例>
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/address/code?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&addrcode=13103,13104

リクエストパラメータ

パラメータ	必須	デフォルト値	説明
addrcode	○	-	絞込み住所コード検索範囲を指定の住所コードに限定します。複数値指定ができます。複数値指定の上限は100件です。本項目は必須項目であるため、未指定の場合はエラーとなります。
datum		TOKYO	測地系返却される住所代表点の測地系を指定します。
llunit		dec	緯度経度形式緯度経度形式を指定します。

出力データ

出力フォーマット

検索結果を住所の配列として返却します。
検索した住所文字列がマッチしなかった場合、マッチしなかった場所の配列要素がnullになります。

[{"text" : "東京都港区",
  "code" : "13103",
  "point": {"lat": 35.6548333,
            "lon": 139.7546361},
  "parts": ["東京都","港区"],
  "kana": "トウキヨウトミナトク",
  "zipcode": null,
  "end": false,
  "bounds": {"sw": {"lat": 35.6198842,"lon": 139.7119789},
             "ne": {"lat": 35.6793636,"lon": 139.7860697}},
  "kanaParts": ["トウキヨウト","ミナトク"],
  "level": "shk",
  "language": {"en": {"text": "Tokyo Minato",
                      "parts": [ "Tokyo", "Minato" ]},
               "zh-cn": {"text": "东京都 港区",
                         "parts": [ "东京都", "港区" ]},
               "zh-tw": {"text": "東京都 港區",
                         "parts": [ "東京都", "港區" ]},
               "ko": {"text": "도쿄도 미나토구",
                      "parts": [ "도쿄도", "미나토구" ]}}}, ... ]

出力例

[多言語情報出力契約時]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/address/code?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&addrcode=13103,13104

[{"text": "東京都港区",
  "code": "13103",
  "point": {"lat": 35.6548333,
            "lon": 139.7546361},
  "parts": ["東京都","港区"],
  "kana": "トウキヨウトミナトク",
  "zipcode": null,
  "end": false,
  "bounds": {"sw": {"lat": 35.6198842,
                    "lon": 139.7119789},
             "ne": {"lat": 35.6793636,
                    "lon": 139.7860697}},
  "kanaParts": ["トウキヨウト","ミナトク"],
  "level": "shk",
  "language": {"en":{"text":"Tokyo Minato",
                     "parts":["Tokyo","Minato"]},
               "zh-cn":{"text":"东京都 港区",
                        "parts":["东京都","港区"]},
               "zh-tw":{"text":"東京都 港區",
                        "parts":["東京都","港區"]},
               "ko":{"text":"도쿄도 미나토구",
                     "parts":["도쿄도","미나토구"]}}},
 {"text": "東京都新宿区",
  "code": "13104",
  "point": {"lat": 35.6906528,
            "lon": 139.7066389},
  "parts": ["東京都","新宿区"],
  "kana": "トウキヨウトシンジユクク",
  "zipcode": null,
  "end": false,
  "bounds": {"sw": {"lat": 35.6699161,
                    "lon": 139.6764747},
             "ne": {"lat": 35.7266622,
                    "lon": 139.7483933}},
  "kanaParts": ["トウキヨウト","シンジユクク"],
  "level": "shk",
  "language": {"en":{"text":"Tokyo Shinjuku",
                     "parts":["Tokyo","Shinjuku"]},
               "zh-cn":{"text":"东京都 新宿区",
                        "parts":["东京都","新宿区"]},
               "zh-tw":{"text":"東京都 新宿區",
                        "parts":["東京都","新宿區"]},
               "ko":{"text":"도쿄도 신쥬쿠구",
                     "parts":["도쿄도","신쥬쿠구"]}}}]

[多言語情報出力未契約時]
https://test.core.its-mo.com/zmaps/api/apicore/core/v1_0/address/code?if_clientid=JSZxxxxxxxxxx|xxxxx&if_auth_type=ip&addrcode=13103,13104

[{"text": "東京都港区",
  "code": "13103",
  "point": {"lat": 35.6548333,
            "lon": 139.7546361},
  "parts": ["東京都","港区"],
  "kana": "トウキヨウトミナトク",
  "zipcode": null,
  "end": false,
  "bounds": {"sw": {"lat": 35.6198842,
                    "lon": 139.7119789},
             "ne": {"lat": 35.6793636,
                    "lon": 139.7860697}},
  "kanaParts": ["トウキヨウト","ミナトク"],
  "level": "shk",
  "language": null},
 {"text": "東京都新宿区",
  "code": "13104",
  "point": {"lat": 35.6906528,
            "lon": 139.7066389},
  "parts": ["東京都","新宿区"],
  "kana": "トウキヨウトシンジユクク",
  "zipcode": null,
  "end": false,
  "bounds": {"sw": {"lat": 35.6699161,
                    "lon": 139.6764747},
             "ne": {"lat": 35.7266622,
                    "lon": 139.7483933}},
  "kanaParts": ["トウキヨウト","シンジユクク"],
  "level": "shk",
  "language": null}]