乗換時刻表クラウド Web API 仕様書 (1.0)

Download OpenAPI specification:

(株)ナビタイムジャパンが提供する乗換時刻表クラウドと連携可能な Web API の仕様書です。

ベースURL

https://{host}

※ host は個別にご連絡いたします。

駅・バス停候補一覧取得API

指定されたワードから、駅・バス停の候補一覧を取得いたします。

path Parameters

customerId

required

string

顧客ID

query Parameters

word required	string Example: word=%E6%B8%8B%E8%B0%B7 ワードの文字列 UTF-8でURLエンコードしてください。 Exampleは「渋谷」をURLエンコードした値です。
limit	integer [ 0 .. 100 ] Default: 10 最大取得数
offset	integer [ 0 .. 2000 ] Default: 0 結果の開始位置
language	string Default: "ja" Enum: "ja" "en" 言語コード以下いずれかの値になります。 ja - 日本語 en - 英語

Responses

Response samples

Content type

application/json; charset=utf-8

{"count": {"total": 100
},
"items": [{"id": "00240050",
"name": "渋谷駅",
"ruby": "しぶやえき",
"type": "busstop"
}
]
}

乗換案内ページ連携API

指定されたパラメータで、経路探索し、乗換案内ページを表示いたします。
必須パラメータが不足している場合、不正である場合、エラーページになります。

path Parameters

customerId

required

string

顧客ID

query Parameters

origin required	string 出発地の駅・バス停ID IDはナビタイムが管理しているものになります。駅・バス停候補一覧取得APIで取得したIDを指定してください。
destination required	string 目的地の駅・バス停ID IDはナビタイムが管理しているものになります。駅・バス停候補一覧取得APIで取得したIDを指定してください。
datetime required	string <date-time> Example: datetime=2023-04-17T11%3A02%3A00%2B09%3A00 日時 ISO 8601形式で指定し、UTF-8でURLエンコードしてください。 Exampleは「2023-04-17T11:02:00+09:00」をURLエンコードした結果です。
mode	string Default: "departure" Enum: "departure" "arrival" "first" "last" 探索モード以下いずれかの値を指定してください。 departure - 発時刻探索 arrival - 着時刻探索 first - 始発探索 last - 終発探索
order	string Default: "time" Enum: "time" "cost" "transfer" 経路の表示順以下いずれかの値を指定してください。 time 出発日時探索・始発探索 - 到着日時が早い順（早く到着できる順）到着日時探索・終発探索 - 出発日時が遅い順（遅く出発できる順） cost - 総額が安い順 transfer - 乗換回数が少ない順
walking-speed	string Default: "standard" Enum: "standard" "slow" "fast" 徒歩速度以下いずれかの値を指定してください。 standard - 標準 slow - ゆっくり fast - せかせか

Responses

乗換案内ページ連携API（外国語）

指定されたパラメータで、経路探索し、外国語の乗換案内ページを表示いたします。
必須パラメータが不足している場合、不正である場合、エラーページになります。

path Parameters

language required	string Value: "en" 言語コード以下いずれかの値になります。 en - 英語
customerId required	string 顧客ID

query Parameters

origin required	string 出発地の駅・バス停ID IDはナビタイムが管理しているものになります。駅・バス停候補一覧取得APIで取得したIDを指定してください。
destination required	string 目的地の駅・バス停ID IDはナビタイムが管理しているものになります。駅・バス停候補一覧取得APIで取得したIDを指定してください。
datetime required	string <date-time> Example: datetime=2023-04-17T11%3A02%3A00%2B09%3A00 日時 ISO 8601形式で指定し、UTF-8でURLエンコードしてください。 Exampleは「2023-04-17T11:02:00+09:00」をURLエンコードした結果です。
mode	string Default: "departure" Enum: "departure" "arrival" "first" "last" 探索モード以下いずれかの値を指定してください。 departure - 発時刻探索 arrival - 着時刻探索 first - 始発探索 last - 終発探索
order	string Default: "time" Enum: "time" "cost" "transfer" 経路の表示順以下いずれかの値を指定してください。 time 出発日時探索・始発探索 - 到着日時が早い順（早く到着できる順）到着日時探索・終発探索 - 出発日時が遅い順（遅く出発できる順） cost - 総額が安い順 transfer - 乗換回数が少ない順
walking-speed	string Default: "standard" Enum: "standard" "slow" "fast" 徒歩速度以下いずれかの値を指定してください。 standard - 標準 slow - ゆっくり fast - せかせか

Responses

バス停系統一覧ページ連携API

指定されたバス停の系統一覧ページを表示いたします。
busstop か external-busstop のどちらのパラメータを必須で指定ください。
必須パラメータが不足している場合、不正である場合、エラーページになります。

path Parameters

customerId

required

string

顧客ID

query Parameters

busstop	string バス停ID IDはナビタイムが管理しているものになります。駅・バス停候補一覧取得APIで取得したIDを指定してください。
external-busstop	string 停留所コードコードは顧客が管理しているものになります。 QRコード等で、バス停系統一覧ページに直接連携する場合、ご利用ください。

Responses

バス停間発着時刻表ページ連携API

指定された乗降バス停区間の発着時刻表ページを表示いたします。
以下どちらか組み合わせで、パラメータを指定する必要があります。

departure-busstop と arrival-busstop
external-departure-busstop と external-arrival-busstop

必須パラメータが不足している場合、不正である場合、エラーページになります。

path Parameters

customerId

required

string

顧客ID

query Parameters

departure-busstop	string 乗車バス停ID IDはナビタイムが管理しているものになります。駅・バス停候補一覧取得APIで取得したIDを指定してください。
arrival-busstop	string 降車バス停ID IDはナビタイムが管理しているものになります。駅・バス停候補一覧取得APIで取得したIDを指定してください。
external-departure-busstop	string 乗車停留所コードコードは顧客が管理しているものになります。
external-arrival-busstop	string 降車停留所コードコードは顧客が管理しているものになります。
date required	string <date> Example: date=2024-07-01 運行日 ISO 8601形式で指定してください。

Responses

バス接近情報ページ連携API

指定の方法で、バス接近情報ページを表示いたします。
以下どちらか組み合わせで、パラメータを指定する必要があります。

external-busstop と external-pole
external-busstop と external-arrival-busstop

必須パラメータが不足している場合、不正である場合、エラーページになります。

path Parameters

customerId

required

string

顧客ID

query Parameters

external-busstop	string 停留所コードコードは顧客が管理しているものになります。
external-pole	string 標柱コードコードは顧客が管理しているものになります。
external-arrival-busstop	string 降車停留所コードコードは顧客が管理しているものになります。