公共交通データHUBシステム
API仕様書配信機能（一般公開）
Ver 2.02
ジョルダン株式会社
2023/8/9

1.概要
API利用イメージ

22

2.仕様
2-1.基本仕様

33

3.API仕様
3-1.データ公開会社一覧取得API（GetAgencyList）
3-2.会社改正日一覧取得API（GetAgencyDetail）
3-3.静的・動的データ取得API（GetContentData）
3-4.動的データ（位置情報）の取得（GetVehiclePosition）
3-5.運行状況の取得（GetTripUpdate）
3-6.運行情報の取得（GetAlert）
3-7.アクセスキー確認（GetMyUID）（非推奨）静的データ取得API445
678910114.データ仕様
静的データ
動的データ

1212125.更新履歴

13

1

1.概要
公共交通データHUBシステムは、「標準的なバス情報フォーマット」をオープンデータとして公開するシステムです。
本ドキュメントでは、ファイルを取得する際に用いるAPIについて記載します。

API利用イメージ

22.仕様2-1.基本仕様●

プロトコル：https （httpアクセスは、httpsへリダイレクトされます）●

入力要求：POST（GETも現在は許容しますが、将来的に廃止予定です）●

url ：https://www.ptd-hs.jp/

33.API仕様
データ出力は、断りのない限りJSON形式となります。

3-1.データ公開会社一覧取得API（GetAgencyList）
説明：公共交通データHUBシステムで公開されている会社の一覧を取得します。
HTTPメソッド：POST
URI：https://www.ptd-hs.jp/GetAgencyList
・入力パラメータ
必須 keyvalue

・出力パラメータ（JSON形式）
key
Agencyagency_id
agency_namecurrent_version

description

value
文字列
文字列
文字列

description
返却値を格納する配列
会社ID
会社名
静的データの最終更新日

・入力例
curl https://www.ptd-hs.jp/GetAgencyList
・出力例{
Agency: [{agency_id : “0702”,
agency_name : “会津乗合自動車”
current_version : “2019/03/07 14:31:18”,
DL_LINK : “利用者のみ利用可”},{
agency_id : “0904”,
agency_name : “関東自動車”
current_version : “2019/03/14 17:55:24”,
DL_LINK : “利用者のみ利用可”
},
]
}

4

3-2.会社改正日一覧取得API（GetAgencyDetail）
説明：登録されている会社の静的データの改正日、改正内容を取得します。
HTTPメソッド：POST
URI：https://www.ptd-hs.jp/GetAgencyDetail
・入力パラメータ
必須 key○agency_id

value
利用するGTFSデー
タのagency_id

・出力パラメータ（JSON形式）
keyagency_id
Datas
timestamp

value
文字列
配列
文字列

versioncontent

文字列
文字列

expiresstart_date
end_date

配列
文字列
文字列

description
取得したいGTFSデータのagency_idを指定してください。

description指定された agency_id
返却値を格納する配列
データの更新日※ 改正のあった日ではありません
登録時のバージョン番号
改正内容※ 登録されていない場合は、空欄となります
時刻表の有効期限の始点
時刻表の有効期限の終点

・入力例
curl -X POST -H "Content-Type: application/json" -d '{"agency_id":"0904"}'
https://www.ptd-hs.jp/GetAgencyDetail
・出力例{"agency_id": "0904","Datas": [{"timestamp": "2022/06/23 11:12:30","version": "20220623111230","content": "5月定期更新","expires": {"start_date": "2022-06-01","end_date": "2022-11-30"}
}
},
…
]

5

6

3-3.静的・動的データ取得API（GetContentData）
説明：公共交通データHUBシステムで公開されているデータを取得します。静的データ、動的データのいずれも取得可能です。
HTTPメソッド：POST
URI：https://www.ptd-hs.jp/GetContentData
・入力パラメータ(全て必須)
必須 keyvalue○
uid
AccessKey○

agency_id
type

利用するGTFSデー
タのagency_id'static' or 'realtime'

versionバージョン

output'binary' or ' json'

・出力パラメータ（JSON形式）
key
ファイル

value
file

STATUS

文字列

description
アカウントごとに提供されたAccessKeyを指定してください。
AccessKeyごとに利用できるデータが設定されており、指定したデータを利用する権限がない場合はエラーが返却されます。
利用するGTFSデータのagency_idを指定してください。
利用するGTFSデータのタイプ（静的 or リアルタイム）を指定します。
省略時は static（静的）が設定されます。
type=static の場合のみ有効です。
過去のバージョンなどを取得したい場合に指定します。省略時は最新バージョンを利用します。
type=realtime の場合のみ有効です。
出力フォーマットを選択します。省略時は binary（ProtocolBuffers形式）を返却します。

description
static：zip形式のデータファイルを返却します。
realtime：output で指定した形式のデータファイルを返却します。
エラー時に原因を返却

・入力例
curl -X POST -H "Content-Type: application/json" -d'{"uid":"xxxxxx","agency_id":"0904","type":"static","output":"json"}'https://www.ptd-hs.jp/GetContentData
・出力例{
agency_id: "0702",Datas: [{timestamp: "2018/09/07 11:31:25",
version: "20180907113125",
content: "夏期運行臨時データ解除"
}

7]
}

8

3-4.動的データ（位置情報）の取得（GetVehiclePosition）
説明：動的データのうち、位置情報（VehiclePosition）を全便分取得します。
HTTPメソッド：POST
URI：https://www.ptd-hs.jp/GetVehiclePosition
・入力パラメータ(全て必須)
必須 keyvalue○
uid
AccessKey○

agency_id
output利用するGTFSデー
タのagency_id'binary' or ' json'

・出力パラメータ（JSON形式）
key
ファイル
STATUS

value
file
文字列

description
アカウントごとに提供されたAccessKeyを指定してください。
AccessKeyごとに利用できるデータが設定されており、指定したデータを利用する権限がない場合はエラーが返却されます。
利用するGTFSデータのagency_idを指定してください。
出力フォーマットを選択します。省略時は binary（ProtocolBuffers形式）を返却します。

description
output で指定した形式のデータファイルを返却します。
エラー時に原因を返却

9

3-5.運行状況の取得（GetTripUpdate）
説明：動的データのうち、運行状況（TripUpdate）を全便分取得します。
HTTPメソッド：POST
URI：https://www.ptd-hs.jp/GetTripUpdate
・入力パラメータ(全て必須)
必須 keyvalue○
uid
AccessKey○

agency_id
output利用するGTFSデー
タのagency_id'binary' or ' json'

・出力パラメータ（JSON形式）
key
ファイル
STATUS

value
file
文字列

description
アカウントごとに提供されたAccessKeyを指定してください。
AccessKeyごとに利用できるデータが設定されており、指定したデータを利用する権限がない場合はエラーが返却されます。
利用するGTFSデータのagency_idを指定してください。
出力フォーマットを選択します。省略時は binary（ProtocolBuffers形式）を返却します。

description
output で指定した形式のデータファイルを返却します。
エラー時に原因を返却

10

3-6.運行情報の取得（GetAlert）
説明：動的データのうち、運行情報（Alert）を取得します。
HTTPメソッド：POST
URI：https://www.ptd-hs.jp/GetAlert・入力パラメータ(全て必須)
必須 keyvalue○
uid
AccessKey○

agency_id
output利用するGTFSデー
タのagency_id'binary' or ' json'

・出力パラメータ（JSON形式）
key
ファイル
STATUS

value
file
文字列

description
アカウントごとに提供されたAccessKeyを指定してください。
AccessKeyごとに利用できるデータが設定されており、指定したデータを利用する権限がない場合はエラーが返却されます。
利用するGTFSデータのagency_idを指定してください。
出力フォーマットを選択します。省略時は binary（ProtocolBuffers形式）を返却します。

description
output で指定した形式のデータファイルを返却します。
エラー時に原因を返却

11

3-7.アクセスキー確認（GetMyUID）
説明：アカウント情報を用いて、アクセスキーを取得します
HTTPメソッド：POST
URI：https://www.ptd-hs.jp/GetMyUID
・入力パラメータ(全て必須)
必須 keyvalue○
メールアドレスemail○

password
outputパスワード'binary' or ' json'

・出力パラメータ（JSON形式）
key
EMAIL
YOUR_ACCESS_KEY
STATUS

value
文字列
文字列
文字列

description
アカウント作成時に提供されたメールアドレスを指定してください。
出力フォーマットを選択します。省略時は binary（ProtocolBuffers形式）を返却します。

description
入力されたメールアドレス
メールアドレスに紐づいたuid
成功時は'SUCCESS'、エラー時には'FALSE'

12

（廃止予定）静的データ取得API●

コマンド：GetData●

引数：agency_id, version(省略可),uid●

出力：静的データファイル(zip形式)。agency_id・datetimeが存在しない場合、またはuidが登録されていない場合はエラー●

備考：version省略時は最新ファイルを出力
uidは発行されたAccessKeyを指定する●

出力例：kanto_bus_20180601130000.zip

13

4.データ仕様
静的データ
当APIサーバでダウンロードできるデータファイルは、国土交通省「標準的なバス情報フォーマット」に基づいている。
同フォーマットの仕様は下記を参照のこと。
http://www.mlit.go.jp/common/001179007.pdf

動的データ
動的データ​​のフォーマット仕様は、下記を参照のこと。
位置情報（VehiclePosition）●

https://developers.google.com/transit/gtfs-realtime/reference/?hl=ja#message_vehicleposition
運行状況（TripUpdate）●

https://developers.google.com/transit/gtfs-realtime/reference/?hl=ja#message_tripupdate
運行情報（Alert）●

https://developers.google.com/transit/gtfs-realtime/reference/?hl=ja#message-alert

145.更新履歴
2022/08/12

Ver 2.00

初版

2023/08/03

Ver 2.01

会社改正日一覧取得API（GetAgencyDetail）の仕様追加

2023/08/09

Ver 2.02

会社改正日一覧取得API（GetAgencyDetail）の出力パラメータ記載、出力例の修正

15