路線ID検索
/transport_link/id [GET]
基本情報
概要
路線IDを指定して路線情報を取得します。
URL
https://{HOST}/{CID}/v1/transport_link/id
※APIマーケットの場合はURL体系が異なります
出力形式
- JSON
対応言語
- ja
パラメータ
| パラメータ名 | 必須 | 概要 | 型名 | デフォルト値 | 上下限/選択値 | 備考 |
|---|---|---|---|---|---|---|
| id | ✔ | 路線ID | 文字列 | ピリオド区切りで複数指定できます | ||
| options | 追加出力情報 | 文字列 | node：路線に属する駅の一覧 | |||
| sort | 追加出力情報のソート順 | 文字列 | down | up：上り down：下り |
追加出力情報の駅を「上り順」で出力するか「下り順」で出力するかを指定します | |
| bus_data | バスデータ利用情報 | 文字列 | timetable：バスデータを利用するかどうかのフラグ | バス停の情報取得は、オプション機能のため、別途契約が必要となります (APIマーケットでは利用不可) |
||
| datum | 緯度経度の測地系 | 文字列 | wgs84 | wgs84：世界測地系 tokyo：旧日本測地系 |
||
| coord_unit | 出力データに含まれる緯度経度の単位 | 文字列 | degree | degree：度表記の10進法 millisec：ミリ秒表記 |
パラメータ構成例
- 路線ID「00000769」の路線情報を取得
/transport_link/id?id=00000769
- 路線ID「00000273」の路線情報を所属駅一覧と共に取得
/transport_link/id?id=00000273&options=node
レスポンス
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 路線情報 | items | Linkオブジェクト | 〇 | |
| 単位情報 | unit | Unitオブジェクト | 出力される単位の情報 |
Linkオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 路線ID | id | 文字列 | ||
| 路線の名称 | name | 文字列 | ||
| 路線のタイプ | type | 文字列 | ||
| 運行会社情報 | company | Companyオブジェクト | ||
| 共同運行会社情報 | companies | Companyオブジェクト | 〇 | |
| 路線に属する駅の一覧 | nodes | Nodeオブジェクト | 〇 | 「options=node」指定時のみ出力されます ナビタイム独自で定義しているため、必ずしも現実世界の停車順と一致しない場合がございます。 また上下片方面のみが停車する駅であってもいずれの方向にも出力されます。 |
type（路線のタイプ）
'type' は以下の文字列を取り得ます。
| 文字列 | 概要 | 備考 |
|---|---|---|
| train | 鉄道 | |
| airplane | 飛行機 | |
| ferry | フェリー | |
| shuttle_bus | 空港連絡バス | |
| bus | 路線バス | 路線バスの情報取得は、オプション機能のため、別途契約が必要となります (APIマーケットでは利用不可) |
| highway_bus | 高速バス | 高速バスの情報取得は、オプション機能のため、別途契約が必要となります (APIマーケットでは利用不可) |
Companyオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 運行会社ID | id | 文字列 | ||
| 運行会社の名称 | name | 文字列 |
Nodeオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 駅/バス停のノードID | id | 文字列 | ||
| 駅/バス停の名称 | name | 文字列 | ||
| 駅/バス停の名称の読み仮名 | ruby | 文字列 | ||
| ノードタイプ | types | 文字列 | ||
| 住所の表示名 | address_name | 文字列 | ||
| 住所コード | address_code | 文字列 | ||
| 駅/バス停の緯度経度 | coord | Coordinateオブジェクト | 路線固有の緯度経度が存在する場合は、路線及び上り/下りに応じた駅/バス停の緯度経度を返却します | |
| 駅/バス停の代表緯度経度 | coord_representative | Coordinateオブジェクト | 株式会社ナビタイムジャパンが独自で算出しています。 バス停については、時刻表や路線図などが提示されている標識板の位置を示します。 |
Coordinateオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 緯度 | lat | 数値 | ||
| 経度 | lon | 数値 |
Unitオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 測地系 | datum | 文字列 | ||
| 緯度経度の出力形式 | coord_unit | 文字列 |
レスポンス例
{
"items": [
{
"id": "00000273",
"name": "京王井の頭線",
"type": "train",
"company": {
"id": "00000035",
"name": "京王電鉄"
},
"companies": [
{
"id": "00000035",
"name": "京王電鉄"
}
],
"nodes": [
{
"id": "00003544",
"name": "渋谷",
"ruby": "しぶや",
"type": "station",
"address_name": "東京都",
"address_code": "13113020000",
"coord": {
"lat": 35.658398,
"lon": 139.698912
},
"coord_representative": {
"lat": 35.656236,
"lon": 139.703142
}
},
{
"id": "00004450",
"name": "神泉",
"ruby": "しんせん",
"type": "station",
"address_name": "東京都",
"address_code": "13113014000",
"coord": {
"lat": 35.657218,
"lon": 139.693572
},
"coord_representative": {
"lat": 35.657218,
"lon": 139.693572
}
},
・・・
]
}
],
"unit": {
"datum": "wgs84",
"coord_unit": "degree"
}
}