停車駅一覧取得

/transport_stops [GET]

基本情報

概要

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

URL

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

※RapidAPIでは提供しておりません。

出力形式

  • JSON

対応言語

  • ja

出力順

  • 停車順

パラメータ

パラメータ名 必須 概要 型名 デフォルト値 上下限/選択値 備考
id 運行ID 文字列 詳細はこちらをご覧ください
node ノードID 文字列 詳細はこちらをご覧ください
date 日付 文字列(日付)
YYYY-MM-DD
詳細はこちらをご覧ください
datum 緯度経度の測地系 文字列 wgs84 wgs84:世界測地系
tokyo:旧日本測地系
coord_unit 出力データに含まれる緯度経度の単位 文字列 degree degree:度表記の10進法
millisec:ミリ秒表記

id‧nodeの指定方法について

必須パラメータの指定方法は以下の通りです。
‧運行ID(id):「時刻表取得API(/transport_diagram/segment)」のレスポンスにて返却される「運行ID (id)」を指定してください。
‧ノードID(node):検索する運行IDにて列車/バスが停車する駅/バス停のうち、任意の駅/バス停IDを指定してくださ い。

dateの指定について

dateパラメータに指定する日付は「nodeパラメータに指定した駅を出発する日付」になります。
例えば2020年10月1日の23時に始発駅を出発し、2020年10月2日の0時にnodeパラメータに指定した駅を出発する場合、date=2020-10-02となります。

運行IDについて

運行IDは定期的に更新されますので、「時刻表取得API(/transport_diagram/segment)」にて都度取得いただきますよう、お願い致します。

パラメータ構成例

  • 運行ID「008501ab」、駅ID「00007820」、日付「2020-10-09」の停車駅一覧を取得
/transport_stops?id=008501ab&node=00007820&date=2020-10-09

レスポンス

名称 レスポンス名 型名 配列 説明
地点間の移動情報 items RouteItemオブジェクト 停車駅に関する地点情報‧移動情報のまとまり
単位情報 unit Unitオブジェクト 出力される単位の情報

レスポンスの項目制限について

契約上許諾されていない運行会社の地点情報・移動情報については、出力項目が制限されます。

RouteItemオブジェクト(type=point:地点情報)

名称 レスポンス名 型名 配列 説明
タイプ type 文字列 常に'point'が入る
緯度経度 coord Coordinateオブジェクト
駅/バス停の名称 name 文字列
駅/バス停ID node_id 文字列
駅ナンバリング情報 numbering RouteNodeNumberオブジェクト 駅ナンバリングに対応した駅のみ出力

Coordinateオブジェクト

名称 レスポンス名 型名 配列 説明
地点の緯度 lat 数値
地点の経度 lon 数値

RouteNodeNumberオブジェクト

名称 レスポンス名 型名 配列 説明
出発ノード departure NodeNumberオブジェクト
到着ノード arrival NodeNumberオブジェクト

NodeNumberオブジェクト

名称 レスポンス名 型名 配列 説明
駅シンボル記号 symbol 文字列
駅番号 number 文字列

RouteItemオブジェクト(move:地点間の移動情報)

名称 レスポンス名 型名 配列 説明
利用する公共交通機関の詳細情報 transport Transportオブジェクト 公共交通機関を利用しない場合は出力されません
タイプ type 文字列 常に'move'が入る
出発時間 from_time 日付時刻 一つ上のpointからの出発時刻
契約上許諾されていない場合は出力されません
到着時間 to_time 日付時刻 一つ下のpointへの到着時刻
契約上許諾されていない場合は出力されません
総移動時間(単位:分) time 数値 type=point間の移動時間
契約上許諾されていない場合は出力されません
列車番号 train_id 文字列 契約上許諾されていない場合は出力されません
路線の名称 name 文字列 契約上許諾されていない場合は出力されません
路線種別 operation_type 文字列 契約上許諾されていない場合は出力されません

Transportオブジェクト

名称 レスポンス名 型名 配列 説明
路線の推奨色 color 文字列 データがある場合のみ出力
路線の名称 name 文字列 契約上許諾されていない場合は出力されません
会社情報 company Companyオブジェクト
路線のID id 文字列

Companyオブジェクト

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

Unitオブジェクト

名称 レスポンス名 型名 配列 説明
緯度経度の測地系 datum 文字列
緯度経度の出力形式 coord_unit 文字列
所要時間の単位 time 文字列

レスポンス例

{
    "items": [
        {
            "type": "point",
            "coord": {
                "lat": 35.872365,
                "lon": 140.010866
            },
            "name": "我孫子(千葉県)",
            "node_id": "00001119",
            "numbering": {
                "departure": [
                    {
                        "symbol": "JJ",
                        "number": "08"
                    },
                    {
                        "symbol": "JL",
                        "number": "30"
                    }
                ]
            }
        },
        {
            "transport": {
                "color": "#3333FF",
                "name": "JR常磐線",
                "company": {
                    "id": "00000004",
                    "name": "JR東日本"
                },
                "id": "00000151"
            },
            "type": "move",
            "from_time": "2020-10-09T04:30:00+09:00",
            "to_time": "2020-10-09T04:33:00+09:00",
            "time": 3,
            "train_id": "414K",
            "name": "JR常磐線各停",
            "operation_type": "各停"
        },
        ・・・
    ]
}