乗降IC検索
/ic [GET]
基本情報
概要
キーワードを指定してIC（インターチェンジ）情報を取得します。
仕様に関する補足
取得した「id（ICのID）」は、ルート検索（車）での経由地指定に利用できます。
検索基点として「coord（緯度経度）」を指定した場合は、基点からの直線距離で対象となるICを検索します。
このAPIで取得できる距離は基点からの直線距離ですので、車での移動を想定した道なり距離を取得したい場合は、最寄りIC検索API（/ic/around）をご利用ください。
URL
https://{HOST}/{CID}/v1/ic
※APIマーケットの場合はURL体系が異なります
出力形式
- JSON
対応言語
- ja
パラメータ
| パラメータ名 | 必須 | 概要 | 型名 | デフォルト値 | 上下限/選択値 | 備考 |
|---|---|---|---|---|---|---|
| word | (✔) | 検索ワード | 文字列 | coordとの併用は不可（どちらか片方を必ず指定） | ||
| coord | (✔) | 緯度経度 | 数値(カンマ区切り) | 検索を行う基準地点の緯度経度 ・「緯度,経度」の順で指定 ・ミリ秒表記、度表記(10進数)に対応 wordとの併用は不可（どちらか片方を必ず指定） |
||
| radius | 検索範囲の半径(単位：m) | 数値 | 2000 | 最小値：1 最大値：10000 |
coord指定時のみ有効 | |
| type | IC種別 | 文字列 | entrance：IC入口 exit：IC出口 |
指定がない場合は「entrance」「exit」の両方を検索 | ||
| limit | データの出力件数 | 数値 | 10 | 最小値：1 最大値：20 |
ICデータの出力数 | |
| datum | 緯度経度の測地系 | 文字列 | wgs84 | wgs84：世界測地系 tokyo：旧日本測地系 |
||
| coord_unit | 出力データに含まれる緯度経度の単位 | 文字列 | degree | degree：度表記の10進法 millisec：ミリ秒表記 |
パラメータ構成例
- 検索ワード「新宿」で10件検索
/ic?word=新宿
レスポンス
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 検索数 | count | Countオブジェクト | レスポンスのヒット数などの情報 | |
| IC情報 | items | IcSearchオブジェクト | ○ | IC情報のまとまり |
| 単位情報 | unit | Unitオブジェクト | 出力される単位の情報 |
Countオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| トータルヒット件数 | total | 数値 | 検索ヒットした件数 | |
| データの出力件数 | limit | 数値 | データの出力件数に設定されている値 1件しかヒットしなかった場合でも、limit=10でリクエストしている場合は10と出力 |
IcSearchオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| ICのID | id | 文字列 | ||
| IC名称 | name | 文字列 | ||
| IC入口の有無フラグ | entrance | 真偽値 | true：IC入口あり false：IC入口なし |
|
| IC出口の有無フラグ | exit | 真偽値 | true：IC出口あり false：IC出口なし |
|
| 緯度経度 | coord | Coordinateオブジェクト | ||
| 高速道路名称 | road_name | 文字列 | ||
| 距離(単位：m) | distance | 数値 | 検索基点からの距離 パラメータ「coord」指定時のみ出力 |
|
| ETC専用料金所情報 | etc_only | EtcOnlyオブジェクト |
Coordinateオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 緯度 | lat | 数値 | ||
| 経度 | lon | 数値 |
Unitオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 測地系 | datum | 文字列 | ||
| 緯度経度の出力形式 | coord_unit | 文字列 |
EtcOnlyオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 入口 | entrance | 真偽値 | IC入口がETC専用料金所のみかどうか | |
| 出口 | exit | 真偽値 | IC出口がETC専用料金所のみかどうか |
レスポンス例
{
"count": {
"total": 1,
"limit": 10
},
"items": [
{
"id": "209030",
"name": "新宿",
"entrance": true,
"exit": true,
"coord": {
"lat": 35.68408,
"lon": 139.6907
},
"etc_only": {
"entrance": true,
"exit": false
},
"road_name": "首都高速４号新宿線"
}
],
"unit": {
"datum": "wgs84",
"coord_unit": "degree"
}
}