到達圏探索（トータルナビ）
/reachable_transit [GET]
基本情報
概要
電車（航空路線、徒歩含む）を移動手段として、指定した地点から指定した時間または乗換回数で到達可能な駅を探索します。
URL
https://{HOST}/{CID}/v1/reachable_transit
※APIマーケットの場合はURL体系が異なります
出力形式
- JSON
対応言語
- ja
出力順
- 所要時間の昇順
パラメータ
| パラメータ名 | 必須 | 概要 | 型名 | デフォルト値 | 上下限/選択値 | 備考 |
|---|---|---|---|---|---|---|
| start | ✔ | 出発地点 | ・カンマ区切りの数値(緯度, 経度) ・文字列（ノードID） |
|||
| term | ✔ | 探索時間の範囲(単位：分) | 数値 | 最小値：1 最大値：180 |
||
| term_from | 探索時間の下限(単位：分) | 数値 | 0 | 最小値：0 最大値：termの値 |
||
| walk_speed | 徒歩の速度(単位：km/h) | 数値 | 4.8 | 最小値：3.0 最大値：8.0 |
小数値は第一位まで有効です | |
| transit_limit | 乗換回数の上限 | 数値 | 最小値：0 最大値：30 |
|||
| unuse | 利用しない公共移動手段 | 文字列 | ピリオド区切りで複数指定できます | |||
| consider_node_waittime | 駅の待ち時間考慮の設定 | 文字列 | all | all：全ての駅で待ち時間を考慮 without_start：出発駅以外の待ち時間を考慮 none：全ての駅で待ち時間を考慮しない |
電車を使う経路でのみ有効です | |
| offset | データの出力開始位置 | 数値 | 0 | 最小値：0 最大値：1000 |
何件目から表示されるか（1件目が0）を指定します | |
| limit | データの出力件数 | 数値 | 10 | 最小値：1 最大値：2000 |
||
| node_type | 出力するノード種別 | 文字列 | ピリオド区切りで複数指定できます | |||
| bus_data | バスデータ利用情報 | 文字列 | timetable | 当該パラメータを使用する場合、バスデータ利用のオプション契約が別途必要となります (APIマーケットでは利用不可) オプション契約なしで当該パラメータを指定するとエラーを返します |
||
| options | 追加出力情報 | 文字列 | node_detail：ノードの詳細情報 | |||
| datum | 緯度経度の測地系 | 文字列 | wgs84 | wgs84：世界測地系 tokyo：旧日本測地系 |
||
| coord_unit | 出力データに含まれる緯度経度の単位 | 文字列 | degree | degree：度表記の10進法 millisec：ミリ秒表記 |
unuse（公共移動手段・利用しないもの）
'unuse' は以下の文字列を取り得ます。
| 文字列 | 概要 | 備考 |
|---|---|---|
| domestic_flight | 航空路線 | |
| ferry | フェリー | |
| superexpress_train | 新幹線 | |
| sleeper_ultraexpress | 寝台特急 | |
| ultraexpress_train | 特急 | |
| express_train | 急行 | |
| rapid_train | 快速 | |
| semiexpress_train | 準急 | |
| local_train | 普通列車 | |
| shuttle_bus | 長距離バス（空港連絡バスを指す） | |
| local_bus | 路線バス | 路線バスの情報取得は、オプション機能のため、別途契約が必要となります (APIマーケットでは利用不可) |
| highway_bus | 高速バス | 高速バスの情報取得は、オプション機能のため、別途契約が必要となります (APIマーケットでは利用不可) |
node_type（出力するノード種別）
'node_type' は以下の文字列を取り得ます。
| 文字列 | 概要 | 備考 |
|---|---|---|
| station | 鉄道駅 | |
| airport | 空港 | |
| port | 港 | |
| busstop | 路線バスのバス停 | バス停の情報取得は、オプション機能のため、別途契約が必要となります (APIマーケットでは利用不可) |
| shuttle_busstop | 空港連絡バスのバス停 | |
| highway_busstop | 高速バスのバス停 | バス停の情報取得は、オプション機能のため、別途契約が必要となります (APIマーケットでは利用不可) |
パラメータ構成例
・船橋駅から15分〜20分以内かつ乗換回数1回で到達出来る駅を詳細情報付きで探索
/reachable_transit?start=35.701638,139.984832&term=20&term_from=15&transit_limit=1&options=node_detail&node_type=station
レスポンス
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 検索数 | count | 数値 | 出力された情報数 | ||
| 到達圏結果情報 | items | ReachablePointオブジェクト | 〇 | 到達圏結果情報のまとまり | |
| 単位情報 | unit | Unitオブジェクト | 出力される単位の情報 |
ReachablePointオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 所要時間 | time | 数値 | nullable | その地点へ到達するまでの時間 | |
| 緯度経度 | coord | Coordinateオブジェクト | 地点の緯度経度 | ||
| 名称 | name | 文字列 | nullable | 駅などの名称 | |
| ノードのID | node_id | 文字列 | nullable | ノードのID | |
| 乗換回数 | transit_count | 数値 | nullable | その地点までの乗換回数 | |
| ノードの詳細情報 | node_detail | ReachablePointDetailオブジェクト | nullable | ノードの詳細情報 |
Coordinateオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 緯度 | lat | 数値 | |||
| 経度 | lon | 数値 |
ReachablePointDetailオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 住所コード | address_code | 文字列 | |||
| 住所の表示名 | address_name | 文字列 | |||
| 路線情報 | link | ReachablePointDetailLinkオブジェクト | nullable | ||
| ノードタイプの一覧 | types | 文字列 | 〇 |
types（ノードタイプの一覧）
'types' は以下の文字列を取り得ます。
| 文字列 | 概要 | 備考 |
|---|---|---|
| station | 鉄道駅 | |
| airport | 空港 | |
| port | 港 | |
| busstop | 路線バスのバス停 | バス停の情報取得は、オプション機能のため、別途契約が必要となります (APIマーケットでは利用不可) |
| shuttle_busstop | 空港連絡バスのバス停 | |
| highway_busstop | 高速バスのバス停 | バス停の情報取得は、オプション機能のため、別途契約が必要となります (APIマーケットでは利用不可) |
ReachablePointDetailLinkオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 路線ID | id | 文字列 | |||
| 路線名称 | name | 文字列 | |||
| 路線推奨色 | color | 文字列 | nullable |
Unitオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 緯度経度の測地系 | datum | 文字列 | nullable | ||
| 緯度経度の出力形式 | coord_unit | 文字列 | nullable | ||
| 時間の単位 | time | 文字列 | nullable | minute：分 |
レスポンス例
{
"count": 10,
"items": [
{
"time": 15,
"coord": {
"lat": 35.659467,
"lon": 140.057695
},
"name": "幕張",
"node_id": "00008518",
"transit_count": 0,
"node_detail": {
"address_name": "千葉県千葉市花見川区幕張町",
"address_code": "12102023000",
"link": {
"id": "00000168",
"name": "ＪＲ総武本線（東京-銚子）",
"color": "#FFD400"
},
"types": [
"station"
]
}
},
{
"time": 15,
"coord": {
"lat": 35.722291,
"lon": 139.982893
},
"name": "塚田",
"node_id": "00006360",
"transit_count": 0,
"node_detail": {
"address_name": "千葉県船橋市前貝塚町",
"address_code": "12204069000",
"link": {
"id": "00000810",
"name": "東武野田線",
"color": "#33CCCC"
},
"types": [
"station"
]
}
},
{
・・・
}
],
"unit": {
"datum": "wgs84",
"coord_unit": "degree",
"time": "minute"
}
}
エラー情報
エラーハンドリングについて
エラーメッセージは追加/変更/削除されることがあります。
エラーハンドリングされる場合はHTTPステータスコードをもとにご対応ください。
共通エラーについてはこちらをご参照ください。
| HTTPステータス | エラーメッセージ | 発生理由 |
|---|---|---|
| 405 | "This http method is invalid : POST"（等） | 許可されていないHTTPメソッドでアクセスされた場合に発生します。 |
| 400 | parameter error: start: "required field" | 必須パラメータである start が指定されていない、または空文字の場合に発生します。 |
| 400 | parameter error: start: "no definitions validate {'anyof definition 0': ['an invalid code: {value}'], 'anyof definition 1': ['an invalid coordinate : {value}']}" | start に指定した値のフォーマットが不正、または正しくない文字列が含まれている場合に発生します。 |
| 400 | parameter error: term: "required field" | 必須パラメータである term が指定されていない、または空文字の場合に発生します。 |
| 400 | parameter error: term: "field 'term' cannot be coerced: invalid literal for int() with base 10: '{value}'" | term に数値以外の文字列を指定した場合に発生します。 |
| 400 | parameter error: term: "min value is 1" | term に下限値（1未満）の範囲外の値を指定した場合に発生します。 |
| 400 | parameter error: term: "max value is 180" | term に上限値（180超過）の範囲外の値を指定した場合に発生します。 |
| 400 | parameter error: term_from: "field 'term_from' cannot be coerced: invalid literal for int() with base 10: '{value}'" | term_from に数値以外の文字列を指定した場合に発生します。 |
| 400 | parameter error: term_from: "min value is 0" | term_from に下限値（0未満）の範囲外の値を指定した場合に発生します。 |
| 400 | "bad usage on this contract : term_from must be smaller than term." | term_from に term よりも大きい値を指定した場合に発生します。 |
| 400 | parameter error: walk_speed: "min value is 3.0" | walk_speed に数値以外の文字列を指定した場合や、下限値（3.0未満）の範囲外の値を指定した場合に発生します。 |
| 400 | parameter error: walk_speed: "max value is 8.0" | walk_speed に上限値（8.0超過）の範囲外の値を指定した場合に発生します。 |
| 400 | parameter error: transit_limit: "field 'transit_limit' cannot be coerced: invalid literal for int() with base 10: '{value}'" | transit_limit に数値以外の文字列を指定した場合に発生します。 |
| 400 | parameter error: transit_limit: "min value is 0" | transit_limit に下限値（0未満）の範囲外の値を指定した場合に発生します。 |
| 400 | parameter error: transit_limit: "max value is 30" | transit_limit に上限値（30超過）の範囲外の値を指定した場合に発生します。 |
| 400 | parameter error: unuse: "an invalid item: {value}" | unuse にピリオド区切りで許可されていない値を指定した場合に発生します（許可値: domestic_flight, ferry, superexpress_train, sleeper_ultraexpress, ultraexpress_train, express_train, rapid_train, semiexpress_train, local_train, shuttle_bus, local_bus, highway_bus）。 |
| 400 | parameter error: consider_node_waittime: "unallowed value {value}" | consider_node_waittime に all, without_start, none 以外の不正な値を指定した場合に発生します。 |
| 400 | parameter error: offset: "field 'offset' cannot be coerced: invalid literal for int() with base 10: '{value}'" | offset に数値以外の文字列を指定した場合に発生します。 |
| 400 | parameter error: offset: "min value is 0" | offset に下限値（0未満）の範囲外の値を指定した場合に発生します。 |
| 400 | parameter error: offset: "max value is 1000" | offset に上限値（1000超過）の範囲外の値を指定した場合に発生します。 |
| 400 | parameter error: limit: "field 'limit' cannot be coerced: invalid literal for int() with base 10: '{value}'" | limit に数値以外の文字列を指定した場合に発生します。 |
| 400 | parameter error: limit: "min value is 1" | limit に下限値（1未満）の範囲外の値を指定した場合に発生します。 |
| 400 | parameter error: limit: "max value is 2000" | limit に上限値（2000超過）の範囲外の値を指定した場合に発生します。 |
| 400 | parameter error: node_type: "an invalid item: {value}" | node_type にピリオド区切りで station, airport, port, busstop, shuttle_busstop, highway_busstop 以外の不正な値を指定した場合に発生します。 |
| 400 | parameter error: bus_data: "unallowed value {value}" | bus_data に timetable 以外の不正な値を指定した場合に発生します。 |
| 400 | parameter error: options: "unallowed value {value}" | options に node_detail 以外の不正な値を指定した場合に発生します。 |
| 400 | parameter error: datum: "unallowed value {value}" | datum に wgs84, tokyo 以外の不正な値を指定した場合に発生します。 |
| 400 | parameter error: coord_unit: "unallowed value {value}" | coord_unit に degree, millisec 以外の不正な値を指定した場合に発生します。 |
| 400 | "bad usage on this contract : bus_data" | bus_data を指定したが、契約でバスデータ利用のオプションが有効化されていない場合に発生します。 |
| 400 | "bad usage on this contract : use_company and unuse_company must be either." | 契約の交通機関会社の利用可否設定に不整合がある場合に発生します。 |