コンテンツにスキップ

時刻表取得

/transport_diagram/segment [GET]

基本情報

概要

指定した駅/バス停ID‧路線ID‧日時に合致した時刻表を取得するAPIです。
※当APIをご利用の場合は、時刻表データ利用もしくはバスデータ利用のオプション契約が別途必要となります

仕様に関する補足

指定する路線と駅に不整合がある場合は返却結果が空となります。

URL

https://{HOST}/{CID}/v1/transport_diagram/segment

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

出力形式

  • json

対応言語

  • ja

出力順

  • 時刻の昇順

パラメータ

パラメータ名 必須 概要 型名 デフォルト値 上下限/選択値 備考
node ✔ ノードID 文字列
link ✔ 路線ID 文字列
date (✔) 日付 文字列（日付）
YYYY-MM-DD		 取得する時刻表の日付を指定します
start_timeとの併用は不可（どちらか片方を必ず指定）
start_time (✔) 開始時刻 文字列（日付時刻）
YYYY-MM-DDThh:mm:ss		 取得する時刻表の起点となる時刻を指定します
dateとの併用は不可（どちらか片方を必ず指定）
term 取得する時刻表の範囲(単位：分) 数値 1440 最小値：1
最大値：2880		 start_time指定時のみ有効
stop_node 停車駅 文字列 指定した全ての駅で停車可能な列車の時刻表に絞り込みます
ピリオド区切りで複数指定できます
options 追加出力情報 文字列 congestion：混雑度情報 混雑度情報の詳細はこちらからご確認いただけます。

パラメータ構成例

  • 駅ID「00007820」、路線ID「00000769」、日付「2020-10-09」の時刻表を取得
/transport_diagram/segment?node=00007820&link=00000769&date=2020-10-09

レスポンス

名称 レスポンス名 型名 配列 説明
駅‧バス停情報 node Nodeオブジェクト
路線情報 link Linkオブジェクト
会社情報 companies Companyオブジェクト 〇
路線方面情報 direction Directionオブジェクト
時刻表一覧 time_table TimeTableオブジェクト
単位情報 unit Unitオブジェクト 出力される単位の情報

TimeTableオブジェクトについて

指定した条件に合致したものが運休の場合、TimeTableオブジェクトは空で返却されます。

Nodeオブジェクト

名称 レスポンス名 型名 配列 説明
駅/バス停のノードID id 文字列
駅/バス停の名称 name 文字列
名称 レスポンス名 型名 配列 説明
路線の ID id 文字列
路線の名称 name 文字列
路線の推奨色 color 文字列 データがある場合のみ出力
副実路線情報 sub_link SubLinkオブジェクト データがある場合のみ出力
名称 レスポンス名 型名 配列 説明
上り方面の副実路線名 up SubLinkNameオブジェクト
下り方面の副実路線名 down SubLinkNameオブジェクト

SubLinkNameオブジェクト

名称 レスポンス名 型名 配列 説明
副実路線名 name 文字列

Companyオブジェクト

名称 レスポンス名 型名 配列 説明
運行会社ID id 文字列
運行会社の名称 name 文字列

Directionオブジェクト

名称 レスポンス名 型名 配列 説明
上り路線の方面情報 up 文字列
下り路線の方面情報 down 文字列

TimeTableオブジェクト

名称 レスポンス名 型名 配列 説明
上りの時刻表情報 up_operations Operationオブジェクト 〇
下りの時刻表情報 down_operations Operationオブジェクト 〇

Operationオブジェクト

名称 レスポンス名 型名 配列 説明
出発時刻 time 文字列
運行ID id 文字列
列車番号 train_id 文字列
路線種別 type 文字列
路線名称 name 文字列
時刻表表示における推奨色 color 文字列 データがある場合のみ出力
行き先ノード情報 destination Destinationオブジェクト データがある場合のみ出力
到着ノード情報 arrivals Arrivalsオブジェクト 〇 パラメータ「stop_node」指定時のみ出力
のりば情報 platform Platformオブジェクト データがある場合のみ出力
当駅始発フラグ is_departure 真偽値 nodeに指定した駅が始発駅であるかどうかのフラグ
環状線については、実状と異なる場合があります
駅到着後の混雑度 congestion_level 数値 1~6の値で出力
値が大きいほど混雑度が高いことを示します
混雑度が存在しない場合は出力されません

Destinationオブジェクト

名称 レスポンス名 型名 配列 説明
行き先の駅/バス停ID id 文字列 一部例外を除き、環状運行する場合は出力されません
行き先の駅/バス停名称 name 文字列 一部例外を除き、環状運行する場合は出力されません

Arrivalsオブジェクト

名称 レスポンス名 型名 配列 説明
到着駅/バス停ID id 文字列
到着駅/バス停名称 name 文字列
到着時刻 time 文字列（日付時刻）
YYYY-MM-DDThh:mm:ss

Platformオブジェクト

名称 レスポンス名 型名 配列 説明
のりば名称 name 文字列 データがある場合のみ出力

Unitオブジェクト

名称 レスポンス名 型名 配列 説明
所要時間の単位 time 文字列

レスポンス例

{
    "node": {
        "id": "00007820",
        "name": "表参道"
    },
    "link": {
        "id": "00000769",
        "name": "東京メトロ千代田線",
        "color": "#00BB85"
    },
    "companies": [
        {
            "id": "00000113",
            "name": "東京地下鉄（メトロ）"
        }
    ],
    "direction": {
        "up": "代々木上原",
        "down": "綾瀬"
    },
    "time_table": {
        "up_operations": [
            {
                "time": "2020-10-09T05:34:00+09:00",
                "id": "008601b1",
                "train_id": "A415K",
                "type": "普通",
                "name": "東京メトロ千代田線",
                "color": "#000000",
                "destination": {
                    "id": "00005508",
                    "name": "代々木上原"
                },
                "platform": {
                    "name": "１番ホーム"
                },
                "is_departure": false,
                "congestion_level": 3
            },
            ・・・
        ]
    }
}