コンテンツにスキップ

道路検索

/road [GET]

基本情報

概要

キーワードを指定して道路情報を取得します。

URL

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

※APIマーケットの場合はURL体系が異なります

出力形式

  • JSON

対応言語

  • ja

出力順

  • キーワードの類似度と検索のランキングを考慮した株式会社ナビタイムジャパン独自のスコア降順

パラメータ

パラメータ名 必須 概要 型名 デフォルト値 上下限/選択値 備考
word (✔) 検索ワード（道路名称） 文字列 wordかaddressのどちらかを必ず指定（両方指定も可能）
address (✔) 住所コード 文字列 wordかaddressのどちらかを必ず指定（両方指定も可能）
市区町村レベル（5桁）まで指定可能
複数指定の場合は、上記指定を「.」区切りで指定
type 道路区分 文字列 highway: 高速道路
local: 一般道路
toll_types 道路料金区分 文字列 free: 無料
toll_highway: 高速道路国道/都市高速道路
toll_local: 一般有料道路		 ピリオド区切りで複数指定可能
offset データの出力開始位置 数値 0 最小値：0
最大値：2000		 何件目から表示されるか(1件目が0)を指定します
limit データの出力件数 数値 10 最小値：1
最大値：100		 道路情報の出力数

パラメータ構成例

  • 検索ワード「青山通り」で道路検索
/road?word=青山通り

レスポンス

名称 レスポンス名 型名 配列 説明
検索数 count Countオブジェクト レスポンスのヒット数などの情報
道路情報 items Roadオブジェクト ○ 道路情報のまとまり

Countオブジェクト

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

Roadオブジェクト

名称 レスポンス名 型名 配列 説明
道路ID id 文字列
道路名称 name 文字列
道路の読み仮名 ruby 文字列
道路区分 types 文字列 ○ highway: 高速道路
local: 一般道路
住所コード address_codes 文字列 ○
道路料金区分 toll_types 文字列 ○ free: 無料
toll_highway: 高速道路国道/都市高速道路
toll_local: 一般有料道路
道路の通称名 common_name 文字列 ○ データがある場合のみ出力

　

道路の通称名で検索を行った場合、正式名称の道路情報としてヒットする場合があります。
また、すべての道路名が検索対象として網羅されているわけではありません。

レスポンス例

{
    "count": {
        "total": 2,
        "offset": 0,
        "limit": 10
    },
    "items": [
        {
            "id": "17886",
            "name": "青山通り",
            "ruby": "アオヤマドオリ",
            "types": [
                "local"
            ],
            "address_codes": [
                "44202"
            ],
            "toll_types": [
                "free"
            ]
        },
        ・・・
    ]
}