項目
API Endpoint	api.ekispert.jp
SSL Support	TLS1.2に対応
利用可能なポート	80(http), 443(https)
利用可能なHTTPメソッド	GETのみ
利用可能なレスポンスデータフォーマット	xml, json (一部png, bmp, jpg対応)

APIの詳細な仕様

レスポンスヘッダのContent-Type

レスポンスヘッダのContent-Typeは、それぞれのフォーマットについて以下のように値が返されます。 jsonの場合は、リクエストヘッダのAcceptを考慮して返却値が下記のように変わります。品質係数が設定されたヘッダ値が送られてきた場合、優先度高い順に上記処理にしたがって設定されます。

フォーマット	Content-Type
xml	`application/xml;charset=utf-8`
json	application/json, application/* のみの場合 `application/json;charset=utf-8` text/plain, text/* のみの場合 `text/plain;charset=utf-8` * / * , 未指定の場合 `text/plain;charset=utf-8`

複数指定

各APIのリクエストパラメータの中には「複数指定可」としているものがあります。そのパラメータを複数指定する場合は、値をコロン:区切りで記述してください。

code=22828:22741

また、コロン:は、URLエンコード(パーセントエンコード)せずに指定してください。

「駅すぱあと API」では値のないパラメータを許可していないため、コロン:のみの記述だとエラーになります。

code=:

指定する値が全て空になる場合にはご注意ください。具体的な指定方法については各APIのページにあるリクエストパラメータの説明をご覧ください。

エラー

「駅すぱあと API」では、APIのエラーをHTTPプロトコルとしてのエラーとエラーレスポンスに含まれるメッセージで表現しています。
ステータスコードの一覧はHTTPステータスコードをご確認ください。

<?xml version="1.0" encoding="UTF-8"?>
<ResultSet apiVersion="1.x.x.x" engineVersion="xxxxxx_xxx">
  <Error code="内部エラーコード">
    <Message>エラーメッセージ</Message>
  </Error>
</ResultSet>

内部エラーコードのご利用は、内部エラーコード・エラーメッセージを利用する際の注意事項をご確認ください。

HTTPステータスコード

「駅すぱあと API」では下記のHTTPステータスコードを返します。
エラーの判断にご利用ください。

HTTPステータスコード	説明
200	OK. エラーではありません。リクエストが成功し、要求に応じたレスポンスが返されます。
400	Bad Request. エラーです。送信されたパラメータに誤りがある場合に返されます。
403	Forbidden. エラーです。認証できなかったか、利用できない機能を呼び出した場合などに返されます。 ※ 詳しくはアクセスキーの確認をご確認ください。
404	Not Found. エラーです。指定されたパスが存在しなかった場合に返されます。
500	Internal Error. エラーです。 API自身のエラーによって処理の続行ができない場合などに返されます。

API一覧

探索

経路探索 /v1/{format}/search/course/extreme
前後のダイヤ探索 /v1/{format}/search/course/pattern
範囲探索 /v1/{format}/search/multipleRange
範囲探索(旧版) /v1/{format}/search/range
経路簡易探索 /v1/{format}/search/course
平均待ち時間バスのみ探索 /v1/{format}/search/course/bus
平均待ち時間探索 /v1/{format}/search/course/plain

駅の情報

駅情報 /v1/{format}/station
《課金対象外》駅簡易情報 /v1/{format}/station/light
緯度経度からの周辺駅検索 /v1/{format}/geo/station
住所情報からの周辺駅検索 /v1/{format}/address/station
区間の駅情報 /v1/{format}/course/station
通過駅情報 /v1/{format}/course/passStation
列車等の停車駅情報 /v1/{format}/course/trainStation

付加情報

駅付加情報 /v1/{format}/station/info

路線の情報

運行路線情報 /v1/{format}/operationLine
平均路線情報 /v1/{format}/rail

会社の情報

会社情報 /v1/{format}/corporation

ツール

《課金対象外》地点生成 /v1/{format}/toolbox/course/point
《課金対象外》測地系変換 /v1/{format}/toolbox/geo/convert
《課金対象外》探索条件生成 /v1/{format}/toolbox/course/condition
《課金対象外》経路情報の更新判定 /v1/{format}/toolbox/course/update

経路の運賃計算操作

定期券の払い戻し計算 /v1/{format}/course/repayment
定期代の分割計算 /v1/{format}/course/teiki/divided
運賃の分割計算 /v1/{format}/course/fare/divided
探索結果の運賃切り替え /v1/{format}/course/recalculate

経路探索結果の操作

経路の再現／定期券・指定列車利用 /v1/{format}/course/edit

経路探索結果の生成

経路の生成 /v1/{format}/course/create

経路のシェイプ情報

経路探索結果のシェイプ情報 /v1/{format}/course/shape

時刻表

鉄道駅時刻表 /v1/{format}/operationLine/timetable
鉄道駅時刻表(旧版) /v1/{format}/station/timetable
鉄道駅時刻表の列車情報 /v1/{format}/station/timetable/train
区間時刻表 /v1/{format}/course/timetable
区間時刻表の列車情報 /v1/{format}/course/timetable/train
航空路線時刻表 /v1/{format}/plane/timetable
航海路線時刻表 /v1/{format}/ship/timetable
バス路線時刻表 /v1/{format}/bus/timetable
特急列車時刻表 /v1/{format}/train/timetable

回数券

《課金対象外》回数券一覧 /v1/{format}/coupon/list
《課金対象外》回数券詳細 /v1/{format}/coupon/detail

路線図

《課金対象外》路線図一覧 /v1/{format}/railmap/list
路線図画像 /v1/{format}/railmap/data
路線図駅情報 /v1/{format}/railmap/detail

鉄道運行情報

鉄道運行情報（レスキューナウ） /v1/{format}/operationLine/service/rescuenow/information
鉄道運行情報（レスキューナウ）(旧版) /v1/{format}/rail/service/rescuenow/information
《課金対象外》鉄道運行情報路線リスト(旧版) /v1/{format}/rail/service/list

バージョン情報

《課金対象外》データバージョン /v1/{format}/dataversion