住所内判定

/address_inclusion [GET]

基本情報

概要

緯度経度が住所コードの範囲内に含まれているかを判定します。

URL

https://{HOST}/{CID}/v1/address_inclusion

※Rakuten RapidAPIでは提供しておりません

出力形式

  • JSON

対応言語

  • ja

パラメータ

パラメータ名 必須 概要 型名 デフォルト値 上下限/選択値 備考
code 住所コード 文字列 住所コードは丁目・小字レベル(11桁)まで指定可能です
ピリオド区切りで複数指定可能です
coord 緯度経度 カンマ区切りの数値(緯度, 経度)
datum 緯度経度の測地系 文字列 wgs84 wgs84:世界測地系
tokyo:旧日本測地系

パラメータ構成例

  • 緯度経度「35.664159,139.718117」が住所コード「13(東京都)」に含まれるかを判定
/address_inclusion?code=13&coord=35.664159,139.718117

レスポンス

名称 レスポンス名 型名 配列 説明
判定結果 items AddressInclusionオブジェクト

AddressInclusionオブジェクト

名称 レスポンス名 型名 配列 説明
緯度経度が住所内に含まれるか included 真偽値

codeを複数指定した場合

codeをピリオド区切りで複数指定した場合は「OR検索」となります。
指定した住所コードのうち、どれか一つでもcoordで指定した緯度経度を含んでいればtrueと判定されます。

レスポンス例

{
    "items": [
        {
            "included": true
        }
    ]
}