鉄道駅時刻表
Attention!
This page has not been translated into English yet.
It is possible that some parts of description may contains old information.
Please see Japanese Documents if you need the latest and accurate information.
鉄道運行路線の時刻表を取得します。 利用方法は以下の手順となります。
- codeパラメータを指定せずに方面別一覧を取得
- 時刻表を取得したい方面のコードを指定して、鉄道駅時刻表を取得
GET /v1/{format}/operationLine/timetable
parameters
Name | Type | Description |
---|---|---|
format | string | レスポンスのデータ形式の指定。必須指定できる値:- xml: xml形式のデータ- json: json形式のデータ |
key | string | アクセスキー。必須 |
stationCode | int | 駅コード。stationNameが指定されていない場合必須。交通種別がtrainのもののみ指定可能です。 |
stationName | string | 駅の名称。stationCodeが指定されていない場合必須。交通種別がtrainのもののみ指定可能です。 |
date | int | 時刻表取得日付。省略可。省略時は日付を考慮しない時刻表になります。dateGroup指定時は、指定曜日区分の直近未来の日付になります。Format: YYYYMMDD |
dateGroup | string | 取得する時刻表の曜日区分。省略可。複数指定可。- 平日: weekday- 土曜: saturday- 日・祝日: holiday Default: 現在日付の曜日区分(date指定時は、指定日付の曜日区分になります。) |
code | int | 時刻表を特定する一意のコード。省略可。省略時は駅時刻表の方面別一覧を返します。 |
addTrainInformation | string | 臨時・運転日注意フラグを持つ列車の情報を付加します。省略可。-true: 付加します-false: 付加しませんDefault: false |
response
Name | Description |
---|---|
ResultSet | レスポンスの最下部を表す要素 |
ResultSet / apiVersion | WebAPIバージョン |
ResultSet / engineVersion | エンジンバージョン |
ResultSet / TimeTable | 時刻表を表す要素 |
ResultSet / TimeTable / code | 時刻表を特定する一意のコード。基本的に長期の保存が可能ですが、路線の廃線等による定義の変更があると利用できなくなる場合があります。 |
ResultSet / TimeTable / dateGroup | 曜日区分 |
ResultSet / TimeTable / Datetime | 日時を表す要素 |
ResultSet / TimeTable / Datetime / operation | 運行日判定- today: 日時通り- yesterday: 前日 |
ResultSet / TimeTable / HourTable | 時(Hour)に関連した要素を並べて表す要素 |
ResultSet / TimeTable / HourTable / Hour | 時(Hour)を表す要素 |
ResultSet / TimeTable / HourTable / MinuteTable | 分(Minute)に関連した要素を並べて表す要素 |
ResultSet / TimeTable / HourTable / MinuteTable / Minute | 分(Minute)を表す要素 |
ResultSet / TimeTable / HourTable / MinuteTable / Stop | 停車を表す要素 |
ResultSet / TimeTable / HourTable / MinuteTable / Stop / extra | 臨時・運転日注意フラグ - True: 臨時・運転日について注意が必要 Trueの場合は、 addTrainInformationにtrueを指定することで臨時・運転日注意の情報 ResultSet / TimeTable / Information が取得できます。※臨時・運転日注意フラグを持たない場合は、extra自体が返りません。 |
ResultSet / TimeTable / HourTable / MinuteTable / Stop / destinationCode | 方面コード |
ResultSet / TimeTable / HourTable / MinuteTable / Stop / kindCode | 種別コード |
ResultSet / TimeTable / HourTable / MinuteTable / Stop / lineCode | 列車等を特定するコード |
ResultSet / TimeTable / HourTable / MinuteTable / Stop / nameCode | 列車名称コード |
ResultSet / TimeTable / HourTable / MinuteTable / Stop / platformNo | 番線情報 |
ResultSet / TimeTable / HourTable / MinuteTable / Stop / Number | 番号(号、便など)を表す要素 |
ResultSet / TimeTable / HourTable / PreCautionalComment | 注意喚起コメントを表す要素 |
ResultSet / TimeTable / HourTable / TimeReliability | 時刻の信頼度を表す要素。- onTimeTable: 時刻表通り- interval: 一定間隔で運行。intervalの場合は時刻を参考程度に扱い、注意喚起コメントの表示を推奨します。(例: "都電荒川線"10時台から15時台) |
ResultSet / TimeTable / Information | 臨時・運転日注意の情報を表す要素 |
ResultSet / TimeTable / Information / Line | 路線を表す要素 |
ResultSet / TimeTable / Information / Line / code | 列車コード |
ResultSet / TimeTable / Information / Line / Name | 列車名を表す要素 |
ResultSet / TimeTable / Information / Line / Type | 列車の種別を表す要素 |
ResultSet / TimeTable / Information / Line / GuideComment | その他列車に関するコメントを表す要素 |
ResultSet / TimeTable / Information / Line / DriveComment | この列車の運行に関するコメントを表す要素 |
ResultSet / TimeTable / Information / Type | 臨時・運転日注意の情報を表す要素 |
ResultSet / TimeTable / Line | 区間 を表す要素 |
ResultSet / TimeTable / Line / Color | 路線カラーを表す要素(10進数によるRGB形式) Format: RRRGGGBBB |
ResultSet / TimeTable / Line / Direction | 具体的な行き先方面を表す要素 ※経路探索のレスポンスの ResultSet / Course / Route / Line / direction とは別物です。 |
ResultSet / TimeTable / Line / Name | 名称を表す要素 |
ResultSet / TimeTable / Line / Source | 始発方面を表す要素 |
ResultSet / TimeTable / LineDestination | 列車等の行き先情報を表す要素 |
ResultSet / TimeTable / LineDestination / code | 方面コード |
ResultSet / TimeTable / LineDestination / Mark | 時刻表用のマークを表す要素 |
ResultSet / TimeTable / LineKind | 列車等の種別情報を表す要素 |
ResultSet / TimeTable / LineKind / code | 種別コード |
ResultSet / TimeTable / LineKind / Mark | 時刻表用のマークを表す要素 |
ResultSet / TimeTable / LineName | 列車等の名称を表す要素 |
ResultSet / TimeTable / LineName / code | 列車名称コード |
ResultSet / TimeTable / LineName / Mark | 時刻表用のマークを表す要素 |
ResultSet / TimeTable / Station | 駅を表す要素 |
ResultSet / TimeTable / Station / Name | 駅の名称を表す要素 |
ResultSet / TimeTable / trainCount | 列車本数 |
example
駅コードから方面別一覧を取得する場合
GET /v1/xml/operationLine/timetable?key=アクセスキーを入力してください&stationCode=22671
<ResultSet apiVersion="1.27.0.0" engineVersion="201802_03a">
<TimeTable trainCount="225" code="1091" dateGroup="weekday">
<Station>
<Name>高円寺</Name>
</Station>
<Line>
<Name>JR中央線快速</Name>
<Direction>高尾・青梅</Direction>
<Source>東京・新宿</Source>
<Color>250060002</Color>
</Line>
:
</TimeTable>
:
</ResultSet>
GET /v1/json/operationLine/timetable?key=アクセスキーを入力してください&stationCode=22671
{
"ResultSet": {
"apiVersion": "1.27.0.0",
"engineVersion": "201802_03a",
"TimeTable": [
{
"trainCount": "225",
"code": "1091",
"dateGroup": "weekday",
"Station": {
"Name": "高円寺"
},
"Line": {
"Name": "JR中央線快速",
"Direction": "高尾・青梅",
"Source": "東京・新宿",
"Color": "250060002"
}
},
:
}
}
codeパラメータを指定して詳細な時刻表を取得する場合
GET /v1/xml/operationLine/timetable?key=アクセスキーを入力してください&stationCode=22671&code=1091
<ResultSet apiVersion="1.27.0.0" engineVersion="201802_03a">
<TimeTable trainCount="225" code="1091" dateGroup="weekday">
<Station>
<Name>高円寺</Name>
</Station>
<HourTable>
<TimeReliability>onTimeTable</TimeReliability>
<MinuteTable>
<Minute>27</Minute>
<Stop kindCode="1" platformNo="3" lineCode="29868" nameCode="1" destinationCode="1"/>
</MinuteTable>
:
<Hour>6</Hour>
</HourTable>
:
<Line>
<Name>JR中央線快速</Name>
<Direction>高尾・青梅</Direction>
<Source>東京・新宿</Source>
<Color>250060002</Color>
</Line>
<LineName code="1">
無し
<Mark/>
</LineName>
:
<LineKind code="1">
各駅停車
<Mark/>
</LineKind>
</TimeTable>
</ResultSet>
GET /v1/json/operationLine/timetable?key=アクセスキーを入力してください&stationCode=22671&code=1091
{
"ResultSet": {
"apiVersion": "1.27.0.0",
"engineVersion": "201802_03a",
"TimeTable": {
"trainCount": "225",
"code": "1091",
"dateGroup": "weekday",
"Station": {
"Name": "高円寺"
},
"HourTable": [
{
"TimeReliability": "onTimeTable",
"MinuteTable": [
{
"Minute": "27",
"Stop": {
"kindCode": "1",
"platformNo": "3",
"lineCode": "29868",
"nameCode": "1",
"destinationCode": "1"
}
},
:
],
"Hour": "6"
},
:
],
"Line": {
"Name": "JR中央線快速",
"Direction": "高尾・青梅",
"Source": "東京・新宿",
"Color": "250060002"
},
"LineName": {
"text": "無し",
"code": "1"
},
"LineDestination": [
{
"text": "高尾(東京都)",
"code": "1"
},
:
],
"LineKind": {
"text": "各駅停車",
"code": "1"
}
}
}
}