コンテンツにスキップ

交差点名検索

/intersection [GET]

基本情報

概要

キーワードを指定して交差点情報を取得します。

URL

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

※APIマーケットでは提供しておりません

出力形式

  • json

対応言語

  • ja

出力順

  • キーワードの類似度と検索のランキングを考慮した株式会社ナビタイムジャパン独自のスコア降順
  • coordを指定した場合のソート順は距離順

パラメータ

パラメータ名 必須 概要 型名 デフォルト値 上下限/選択値 備考
word ✔ 検索ワード（交差点名） 文字列
coord 緯度経度 カンマ区切りの数値（緯度,経度）
radius 検索範囲の半径（単位：m） 数値 2000 最小値：1
最大値：10000		 radiusを指定する際は必ずcoordも指定してください
limit データの出力件数 数値 10 最小値：1
最大値：100		 交差点情報の出力数
offset データの出力開始位置 数値 0 最小値：0
最大値：2000		 何件目から表示されるか(1件目が0)を指定します
datum 緯度経度の測地系 文字列 wgs84 wgs84：世界測地系
tokyo：旧日本測地系
coord_unit 出力データに含まれる緯度経度の単位 文字列 degree degree：度表記の10進法
millisec：ミリ秒表記

パラメータ構成例

  • 検索ワード「表参道」で交差点検索
/intersection?word=表参道

レスポンス

名称 レスポンス名 型名 配列 説明
検索数 count Countオブジェクト レスポンスのヒット数などの情報
住所情報 items Intersectionオブジェクト ○ 交差点情報のまとまり
単位情報 unit Unitオブジェクト 出力される単位の情報

Countオブジェクト

名称 レスポンス名 型名 配列 説明
トータルヒット件数 total 数値 検索ヒットした件数
オフセット値 offset 数値 オフセットが設定されている場合はその値を出力
データの出力件数 limit 数値 データの出力件数に設定されている値
1件しかヒットしなかった場合でも、limit=10でリクエストしている場合は10と出力

Intersectionオブジェクト

名称 レスポンス名 型名 配列 説明
交差点ID id 文字列
交差点名称 name 文字列
交差点の読み仮名 ruby 文字列
住所コード address_code 文字列
住所の表示名 address_name 文字列
緯度経度 coord Coordinateオブジェクト
指定されたcoordからの距離（m） distance 数値 coordが指定された場合のみ出力

Coordinateオブジェクト

名称 レスポンス名 型名 配列 説明
各地点の代表緯度 lat 数値
各地点の代表経度 lon 数値

Unitオブジェクト

名称 レスポンス名 型名 配列 説明
測地系 datum 文字列
緯度経度の出力形式 coord_unit 文字列
距離の単位 distance 文字列 レスポンス内にdistanceが含まれる場合のみ出力されます

レスポンス例

{
    "count": {
        "total": 1,
        "offset": 0,
        "limit": 10
    },
    "items": [
        {
            "id": "49637",
            "name": "表参道",
            "ruby": "オモテサンドウ",
            "address_code": "1310300800300005",
            "address_name": "東京都港区北青山3丁目5",
            "coord": {
                "lat": 35.665124,
                "lon": 139.712606
            }
        }
    ],
    "unit": {
        "datum": "wgs84",
        "coord_unit": "degree"
    }
}