メインコンテンツまでスキップ
API docs by Redocly

mixway API Documents

探索

経路探索

指定した以下の区間の経路を探索した結果が返却されます。

  • 駅
  • 座標情報
  • シェアサイクルのポート
  • オンデマンド交通のポート

以下の交通手段を利用した経路が返却されます。

  • 公共交通
  • 徒歩
  • タクシー
  • シェアサイクル
  • オンデマンド交通
query Parameters
key
required
string

アクセスキー。

viaList
required
string
Example: viaList=35.6860674,139.7180299:35.6918772,139.6517387

以下のリスト。複数指定可。

  • 駅コード
  • 駅の名称
  • 座標情報(※1)
  • シェアサイクルのポートコード
  • オンデマンド交通のポートコード

先頭が出発地、末尾が到着地、(3つ以上指定の場合)間が経由地として扱われます。経由地には駅コードのみが指定できます。
※1.測地系は世界測地系にのみ対応しています。

fixedRailList
string
Example: fixedRailList=ＪＲ埼京線

固定平均路線の名称リスト。
searchTypeにplainを指定した場合のみ有効です。
省略時は路線が固定されません。
詳しくはこちらを参照。

fixedRailDirectionList
string
Example: fixedRailDirectionList=Up

固定平均路線の方向リスト。
searchTypeにplainを指定し、かつfixedRailList指定した場合のみ有効です。
省略時は方向が自動的に判断されます。

date
string <YYYYMMDD>
Default: "現在年月日"
Example: date=20230724

探索日付。

time
string <HHMM>
Default: "現在時刻"
Example: time=1030

探索時刻。
searchTypeにplainを指定した場合は無効です。

searchType
string
Default: "departure"
Enum: "departure" "arrival" "lastTrain" "firstTrain" "plain"

探索種別。
指定できる値は探索種別を参照。

sort
string
Default: "ekispert"
Enum: "ekispert" "price" "time" "teiki" "transfer" "teiki1" "teiki3" "teiki6"

ソート種別。

指定できる値

  • ekispert: 駅すぱあと探索順
  • price: 料金順
  • time: 時間順
  • teiki: 定期券の料金順
  • transfer: 乗換回数順
  • teiki1: １ヶ月定期券の料金順
  • teiki3: ３ヶ月定期券の料金順
  • teiki6: ６ヶ月定期券の料金順

詳しくはこちらを参照。

answerCount
int <= 20
Default: 5

最大回答数。

searchCount
int <= 20

最大探索数。
未指定時はanswerCountと同じ値が設定されます。

conditionDetail
string
Default: "T3221233232319:F332112212000:A23121141:"

詳細探索条件データ。
IC運賃計算の有無や、バス・新幹線・飛行機・フェリーなど交通種別ごとの利用有無、初期値として返す特急料金の席種別、 乗換時間、エクスプレス予約などを指定することができます。
探索条件生成から取得できます。

corporationBind
string
Example: corporationBind=東急電鉄

固定会社リスト。
指定した会社のみが利用されます。
複数指定可。最大40件。省略時は制限の無い通常の探索となります。

interruptCorporationList
string
Example: interruptCorporationList=東急電鉄

不通会社リスト。
指定した会社を利用しない経路が返却されます。
searchType に plain を指定している場合、路線バス（コミュニティバス含む）の指定は無効となります。 複数指定可。最大40件。省略時は制限のない通常の探索となります。

interruptRailList
string
Example: interruptRailList=ＪＲ埼京線

不通平均路線リスト。
利用しない路線の平均路線コードを指定します。
指定した平均路線を利用しない経路が返却されます。
searchTypeがplainの場合にのみ有効。
複数指定可。最大10件。省略時は制限のない通常の探索となります。
interruptOperationLineCodeListと排他。

interruptOperationLineCodeList
string
Example: interruptOperationLineCodeList=106

不通運行路線コードリスト。
利用しない路線の運行路線コードを指定します。
指定した運行路線を利用しない経路が返却されます。
複数指定可。最大10件。省略時は制限のない通常の探索となります。
interruptRailListと排他。

interruptTransferStationCodeList
string
Example: interruptTransferStationCodeList=22828

乗換しない駅リスト。
乗換しない駅の駅コードを指定します。
指定した駅を利用しない経路が返却されます。
複数指定可。最大30件。省略時は制限のない通常の探索となります。

checkEngineVersion
boolean
Default: false

指定した定期経路の再現を行うとき、定期経路シリアライズデータ作成時のエンジンバージョンと再現時のエンジンバージョンが同一かがチェックされます。
エンジンバージョンが異なる場合は、エラーが返却されます。

指定できる値

  • true: チェックされます
  • false: チェックされません
assignTeikiSerializeData
string

定期経路シリアライズデータ。
assignRoute, assignDetailRouteと排他。
※ 詳しくは定期情報の取得と定期情報の更新及び定期券利用時の運賃計算をご確認ください。

assignDetailRoute
string
Example: assignDetailRoute=高円寺:ＪＲ中央線快速:Up:新宿:ＪＲ山手線外回り:Down:池袋

定期経路文字列。駅の名称:平均路線:方向:駅の名称...の羅列。
assignTeikiSerializeDataと排他。
※ 詳しくは定期情報の取得と定期情報の更新及び定期券利用時の運賃計算をご確認ください。

coupon
string
Example: coupon=新幹線回数券(自由席)

回数券詳細名称。

bringAssignmentError
boolean
Default: false

通常の経路探索における定期券と回数券の利用では、定期券や回数券が利用できない場合でもエラーとならず経路探索結果が返却されますが、trueを指定することで、定期券や回数券が利用できない場合等にエラーを返却されます。

指定できる値

  • true: 利用エラーが発生します
  • false: 利用エラーが発生しません

※ 現在、定期券利用時の運賃計算において、bringAssignmentErrorによるエラーハンドリングは非推奨としています。これから開発を始める方は、addAssignStatusをご利用ください。

addChange
boolean
Default: false

結果に次の路線への乗り換えに便利な乗車位置情報が付加されます。
ダイヤによる探索時のみ有効。

指定できる値

  • true: 付加されます
  • false: 付加されません
mode
string
Default: "public"
Enum: "public" "cycle" "demand"

探索する経路に利用する交通機関。

指定できる値

  • public: 公共交通機関、シェアサイクル、オンデマンド交通を利用する経路
  • cycle: シェアサイクルを利用し、公共交通機関を利用しない経路
  • demand: オンデマンド交通を利用し、公共交通機関を利用しない経路
walkSpeed
float
Default: 4.8

徒歩速度。
単位: km/h

maxWalkDistance
int
Default: 2000

徒歩で移動する距離の上限。
単位: メートル

maxWalkDistanceLocalBus
int
Default: 500

路線バスのバス停まで徒歩で移動する距離の上限。
単位: メートル

applyMaxWalkDistanceStrict
boolean
Default: false

出発地あるいは到着地から最寄駅までの距離制約が厳密に適用されます。

指定できる値

  • true: maxWalkDistanceに指定した距離以上に離れている駅は、最寄駅として採用されません
  • false: 最も近い駅がmaxWalkDistanceに指定した距離以上に離れている場合は、その駅を最寄駅として採用されます
carSpeed
float
Default: 30

タクシーでの移動速度。
単位: km/h

minCarDistance
int
Default: 0

タクシーで移動する距離の下限。
単位: メートル

maxCarDistance
int
Default: 0

タクシーで移動する距離の上限。
単位: メートル

applyMaxCarDistanceStrict
boolean
Default: false

出発地あるいは到着地から最寄駅までの距離制約が厳密に適用されます。

指定できる値

  • true: maxCarDistanceに指定した距離以上に離れている駅は、最寄駅として採用されません
  • false: 最も近い駅がmaxCarDistanceに指定した距離以上に離れている場合は、その駅を最寄駅として採用されます
cycleSpeed
float
Default: 9.5

シェアサイクルでの移動速度。
単位: km/h

minCycleDistance
int
Default: 1000

シェアサイクルで移動する距離の下限。
単位: メートル

maxCycleDistance
int <= 10000
Default: 3000

シェアサイクルで移動する距離の上限。
単位: メートル

maxWalkDistanceCycle
int
Default: 500

シェアサイクルポートまで徒歩で移動する距離の上限。
単位: メートル

cycleCorporationBind
string
Example: cycleCorporationBind=DOCOMO:POROCLE

シェアサイクル事業者絞り込み。複数指定可。省略時は制限の無い通常の探索となります。
シェアサイクル事業者コード一覧

maxWalkDistanceDemand
int
Default: 2000

オンデマンド交通ポートまで徒歩で移動する距離の上限。
単位: メートル

demandCorporationBind
string
Example: demandCorporationBind=KOMONODEMANDTAXI:MAERUNRUNBUS

オンデマンド交通事業者絞り込み。複数指定可。省略時は制限の無い通常の探索となります。
オンデマンド交通事業者コード一覧

fromName
string
Example: fromName=出発地

出発地の名称。
結果経路の出発地の名称(ResultSet / Course / Route / Point / Name)にこの値が返却されます。

toName
string
Example: toName=到着地

到着地の名称。
結果経路の到着地の名称(ResultSet / Course / Route / Point / Name)にこの値が返却されます。

fromStation
string
Example: fromStation=22671

出発駅コード。複数指定可。指定した駅のみ出発駅として利用されます。

toStation
string
Example: toStation=22828

到着駅コード。複数指定可。指定した駅のみ到着駅として利用されます。

multipleLineComment
boolean
Default: false

区間に対するコメント(ResultSet / Course / Route / Line / Comment)の返却方法を指定します。

  • true: 区間に対するコメントが配列で返却されます。（推奨）
  • false（デフォルト）: 区間に対するコメントがオブジェクトで返却されます。

false（デフォルト）では、区間に対するコメントを全て取得できるとは限りません。区間に対するコメントを全て取得したい場合は、trueを指定することを推奨します。

addSeatType
boolean
Default: false

結果のPrice要素(ResultSet / Course / Price)に列車ごとの座席種別(SeatType)を付加します。省略可。

  • true: 列車ごとの座席種別を付加する
  • false（デフォルト）: 列車ごとの座席種別を付加しない

Responses

Response Schema: application/json
required
object

レスポンスの最下部を表す要素

apiVersion
string

WebAPIバージョン

engineVersion
string

エンジンバージョン

Array of objects

経路探索の結果である経路を表す要素。探索の結果、経路が見つからなかった場合はこの要素自体が存在しません。

Response Schema: application/json
required
object

レスポンスの最下部を表す要素。

apiVersion
required
string

WebAPIバージョン

engineVersion
required
string

エンジンバージョン

object

エラー内容を表す要素。

Response Schema: application/json
required
object

レスポンスの最下部を表す要素。

apiVersion
required
string

WebAPIバージョン

engineVersion
required
string

エンジンバージョン

object

エラー内容を表す要素。

Response samples

Content type
application/json
{
  • "ResultSet": {
    }
}

前後のダイヤ探索

指定された経路シリアライズデータ、 区間インデックスパラメータを元に、指定された区間インデックス以降の経路を探索します。

以下のケースでは、シェアサイクルまたはデマンド交通を利用する経路は返却されません。

  • 出発時刻・到着時刻が、その事業者の営業期間外の場合
  • 出発時刻・到着時刻が、その発着ポートの営業時間外の場合
query Parameters
serializeData
required
string

探索対象とする経路を表す経路シリアライズデータ。平均待ち時間による探索の経路シリアライズデータ・駅すぱあと API形式経路シリアライズデータは利用できません。

sectionIndex
required
integer

区間インデックス。該当の区間の交通手段がtrain bus plane shipの時のみ指定可能です。

answerCount
integer
Default: 5

最大回答数。最大20件。省略可。

previousCount
integer

出発日時が基準の経路の出発日時より前となる経路の回答数。 省略可。
0以上answerCount未満 (0 < answerCount) の値が指定可能です。
Default: (answerCount - 1) / 2 の小数点を切り捨てた整数。基準となる経路は必ず回答に含まれるため、割り切れない場合は、指定経路より後方の経路を1経路多く回答します。
（例：answerCountが5の場合、previousCountのデフォルト値は2になります。前の経路数2, 指定経路数1, 後ろの経路数2です。）
（例：answerCountが4の場合、previousCountのデフォルト値は1になります。前の経路数1, 指定経路数1, 後ろの経路数2です。）

assignInstruction
string
Default: "SearchAfter"

前後のダイヤにおける再探索モード。省略可。
指定できる値:

  • SearchAll: 経路全体を再探索
  • SearchAfter: sectionIndexで指定した区間より後ろの区間を再探索
addOperationLinePattern
boolean
Default: false
Enum: true false

結果に経路の区間に紐づく運行路線パターンを付加します。省略可。
指定できる値:

  • true: 付加します
  • false: 付加しません
addChange
boolean
Default: false
Enum: true false

結果に次の路線への乗り換えに便利な乗車位置情報を付加します。ダイヤによる探索時のみ有効。省略可。
指定できる値:

  • true: 付加します
  • false: 付加しません
addStop
boolean
Default: false
Enum: true false

経路の区間に停車駅一覧を付加する。ダイヤによる探索時のみ有効。省略可。
指定できる値:

  • true: 付加します
  • false: 付加しません
checkEngineVersion
boolean
Default: false
Enum: true false

完全な定期経路シリアライズデータ、及び経路シリアライズデータの再現を行う場合は、シリアライズデータ作成時のエンジンバージョンと再現時のエンジンバージョンが同一かのチェックを有効にします。エンジンバージョンが異なる場合は、エラーを返します。省略可。
指定できる値:

  • true: チェックする
  • false: チェックしない

※ 駅すぱあと APIとはデフォルト値が異なります。

multipleLineComment
boolean
Default: false

区間に対するコメント(ResultSet / Course / Route / Line / Comment)の返却方法を指定します。

  • true: 区間に対するコメントが配列で返却されます。（推奨）
  • false（デフォルト）: 区間に対するコメントがオブジェクトで返却されます。

false（デフォルト）では、区間に対するコメントを全て取得できるとは限りません。区間に対するコメントを全て取得したい場合は、trueを指定することを推奨します。

addSeatType
boolean
Default: false

結果のPrice要素(ResultSet / Course / Price)に列車ごとの座席種別(SeatType)を付加します。省略可。

  • true: 列車ごとの座席種別を付加する
  • false（デフォルト）: 列車ごとの座席種別を付加しない
trimBeforeSection
boolean
Default: false

元の経路情報から、sectionIndexで指定した区間より前の区間を除外するかどうかを指定します。省略可。

  • true: 元の経路情報から、指定された区間より前のすべての区間を除外した上で、指定区間以降の経路のみを処理およびレスポンスの対象とします。
  • false（デフォルト）: 元の経路情報を区間除外せず、経路全体を処理およびレスポンスの対象とします。

※trimBeforeSectionがtrueの場合、assignInstructionの値がSearchAllまたはSearchAfterのいずれであっても、結果は同一となります。

Responses

Response Schema: application/json
required
object

レスポンスの最下部を表す要素

apiVersion
string

WebAPIバージョン

engineVersion
string

エンジンバージョン

Array of objects

経路探索の結果である経路を表す要素。探索の結果、経路が見つからなかった場合はこの要素自体が存在しません。

Response Schema: application/json
required
object

レスポンスの最下部を表す要素。

apiVersion
required
string

WebAPIバージョン

engineVersion
required
string

エンジンバージョン

object

エラー内容を表す要素。

Response samples

Content type
application/json
{
  • "ResultSet": {
    }
}

経路探索（リアルタイム）

指定された駅もしくは地点間の経路を探索します。公共交通、徒歩、タクシー、シェアサイクル、オンデマンド交通を利用した経路を取得できます。経路の算出には鉄道やバスのリアルタイムな情報が加味されます。
本機能を利用するには、mixway APIの契約に加え別途契約が必要です。詳細はお問い合わせフォームへご連絡ください。

query Parameters
key
required
string

アクセスキー

viaList
required
string
Example: viaList=35.6860674,139.7180299:35.6918772,139.6517387

以下のリスト。複数指定可。

  • 駅コード
  • 駅の名称
  • 座標情報(※1)
  • シェアサイクルのポートコード
  • オンデマンド交通のポートコード

先頭が出発地、末尾が到着地、(3つ以上指定の場合)間が経由地として扱われます。経由地には駅コードのみが指定できます。
※1.測地系は世界測地系にのみ対応しています。

date
integer

探索日付。省略可。未指定時は現在日で探索されます。
Format: YYYYMMDD

time
integer

探索時刻。省略可。未指定時は現在時刻で探索されます。
Format: HHMM

searchType
string
Default: "departure"
Enum: "departure" "arrival" "lastTrain" "firstTrain"

探索種別。省略可。指定値の意味は探索種別を参照。
ただし平均待ち時間探索(plain)は利用できません。

sort
string
Default: "ekispert"
Enum: "ekispert" "price" "time" "teiki" "transfer" "teiki1" "teiki3" "teiki6"

ソート種別。省略可。

指定できる値:

  • ekispert: 駅すぱあと探索順
  • price: 料金順
  • time: 時間順
  • teiki: 定期券の料金順
  • transfer: 乗換回数順
  • teiki1: １ヶ月定期券の料金順
  • teiki3: ３ヶ月定期券の料金順
  • teiki6: ６ヶ月定期券の料金順

詳しくはこちらを参照

answerCount
integer
Default: 5

最大回答数。最大20件。省略可。

searchCount
integer

最大探索数。最大20件。省略可。未指定時はanswerCountと同じ値が設定されます。

conditionDetail
string
Default: "T3221233232319:F332112212000:A23121141:"

詳細探索条件データ。 IC運賃計算の有無や、バス・新幹線・飛行機・フェリーなど交通種別ごとの利用有無、初期値として返す特急料金の席種別、 乗換時間、エクスプレス予約などを指定することができます。探索条件生成から取得できます。省略可。

corporationBind
string

固定会社リスト。
指定した会社のみが利用されます。
複数指定可。最大40件。省略時は制限の無い通常の探索となります。

interruptCorporationList
string
Example: interruptCorporationList=東急電鉄

不通会社リスト。
指定した会社を利用しない経路が返却されます。
searchType に plain を指定している場合、路線バス（コミュニティバス含む）の指定は無効となります。 複数指定可。最大40件。省略時は制限のない通常の探索となります。

interruptOperationLineCodeList
string

不通運行路線コードリスト。指定した運行路線を利用しない経路を求めます。複数指定可。 最大10件程度が目安です。省略可。省略時は制限のない通常の探索となります。

interruptTransferStationCodeList
string

乗換しない駅リスト。乗り換えたくない駅の駅コードを指定します。複数指定可。最大30件。省略可。省略時は制限のない通常の探索となります。

addOperationLinePattern
boolean
Default: false

結果に経路の区間に紐づく運行路線パターンを付加します。省略可。

指定できる値:

  • true: 付加する
  • false: 付加しない
checkEngineVersion
boolean
Default: false

指定した定期経路の再現を行うとき、定期経路シリアライズデータ作成時のエンジンバージョンと再現時のエンジンバージョンが同一かをチェックします。エンジンバージョンが異なる場合は、エラーを返します。省略可。

指定できる値:

  • true: チェックする
  • false: チェックしない
assignTeikiSerializeData
string

定期経路シリアライズデータ。省略可。
assignRoute assignDetailRoute と排他。
※ 詳しくは定期情報の取得と定期情報の更新及び定期券利用時の運賃計算をご確認ください。

assignDetailRoute
string
Example: assignDetailRoute=高円寺:ＪＲ中央線快速:Up:新宿:ＪＲ山手線外回り:Down:池袋

定期経路文字列。駅の名称:平均路線:方向:駅の名称...の羅列。省略可。
assignTeikiSerializeData と排他。
※ 詳しくは定期情報の取得と定期情報の更新及び定期券利用時の運賃計算をご確認ください。

coupon
string

回数券詳細名称。省略可

bringAssignmentError
boolean
Default: false

通常の経路探索における定期券と回数券の利用では、定期券や回数券が利用できない場合でもエラーとならず経路探索結果を返しますが、trueを指定することで、定期券や回数券が利用できない場合等にエラーを返します。省略可。

指定できる値:

  • true: 利用エラーを発生させる
  • false: 利用エラーを発生させない

※ 現在、定期券利用時の運賃計算において、 bringAssignmentError によるエラーハンドリングは非推奨としています。これから開発を始める方は、 addAssignStatus をご利用ください。

addChange
boolean
Default: false

結果に次の路線への乗り換えに便利な乗車位置情報を付加します。省略可。

指定できる値:

  • true: 付加する
  • false: 付加しない
mode
string
Default: "public"

探索する経路に利用する交通機関。省略可。

指定できる値:

  • public: 公共交通機関、シェアサイクル、デマンドモビリティを利用する経路
  • cycle: シェアサイクルを利用し、公共交通機関を利用しない経路
  • demand: デマンドモビリティを利用し、公共交通機関を利用しない経路
walkSpeed
number
Default: 4.8

徒歩速度。省略可。単位: km/h

maxWalkDistance
number
Default: 2000

徒歩で移動する距離の上限。省略可。単位: メートル

maxWalkDistanceLocalBus
number
Default: 500

路線バスのバス停まで徒歩で移動する距離の上限。省略可。単位: メートル

applyMaxWalkDistanceStrict
boolean
Default: false

出発地あるいは到着地から最寄駅までの距離制約を厳密に適用する。省略可。

指定できる値:

  • true: maxWalkDistanceに指定した距離以上に離れている駅は、最寄駅として採用しない
  • false: 最も近い駅がmaxWalkDistanceに指定した距離以上に離れている場合は、その駅を最寄駅として採用する
carSpeed
number
Default: 30

タクシーでの移動速度。省略可。単位: km/h

minCarDistance
number
Default: 0

タクシーで移動する距離の下限。省略可。単位: メートル

maxCarDistance
number
Default: 0

タクシーで移動する距離の上限。省略可。単位: メートル

applyMaxCarDistanceStrict
boolean
Default: false

出発地あるいは到着地から最寄駅までの距離制約を厳密に適用する。省略可。

指定できる値:

  • true: maxCarDistanceに指定した距離以上に離れている駅は、最寄駅として採用しない
  • false: 最も近い駅がmaxCarDistanceに指定した距離以上に離れている場合は、その駅を最寄駅として採用する
cycleSpeed
number
Default: 9.5

シェアサイクルでの移動速度。省略可。単位: km/h

minCycleDistance
number
Default: 1000

シェアサイクルで移動する距離の下限。省略可。単位: メートル

maxCycleDistance
number
Default: 3000

シェアサイクルで移動する距離の上限。最大3000。省略可。単位: メートル

maxWalkDistanceCycle
number
Default: 500

シェアサイクルポートまで徒歩で移動する距離の上限。省略可。単位: メートル

cycleCorporationBind
string
Example: cycleCorporationBind=DOCOMO:POROCLE

利用するシェアサイクル事業者の絞り込み。複数指定可。省略時は制限の無い通常の探索となります。
シェアサイクル事業者コード一覧

maxWalkDistanceDemand
number
Default: 2000

オンデマンド交通ポートまで徒歩で移動する距離の上限。省略可。単位: メートル

demandCorporationBind
string
Example: demandCorporationBind=KOMONODEMANDTAXI:MAERUNRUNBUS

オンデマンド交通事業者絞り込み。複数指定可。省略時は制限の無い通常の探索となります。
デマンド交通事業者コード一覧

fromName
string

出発地点の名称。結果経路の出発地の名称として採用されます。省略可。

toName
string

到着地点の名称。結果経路の到着地の名称として採用されます。省略可。

fromStation
string
Example: fromStation=22671

出発駅コード。指定した駅のみ出発駅として利用します。省略可。

toStation
string
Example: toStation=22828

到着駅コード。指定した駅のみ到着駅として利用します。省略可。

multipleLineComment
boolean
Default: false

区間に対するコメント(ResultSet / Course / Route / Line / Comment)の返却方法を指定します。

  • true: 区間に対するコメントが配列で返却されます。（推奨）
  • false（デフォルト）: 区間に対するコメントがオブジェクトで返却されます。

false（デフォルト）では、区間に対するコメントを全て取得できるとは限りません。区間に対するコメントを全て取得したい場合は、trueを指定することを推奨します。

addSeatType
boolean
Default: false

結果のPrice要素(ResultSet / Course / Price)に列車ごとの座席種別(SeatType)を付加します。省略可。

  • true: 列車ごとの座席種別を付加する
  • false（デフォルト）: 列車ごとの座席種別を付加しない

Responses

Response Schema: application/json
required
object

レスポンスの最下部を表す要素

apiVersion
string

WebAPIバージョン

engineVersion
string

エンジンバージョン

realtimeDataTimestamp
string

リアルタイムデータのバイナリ作成日時

Array of objects

経路探索の結果である経路を表す要素。探索の結果、経路が見つからなかった場合はこの要素自体が存在しません。

Response Schema: application/json
required
object

レスポンスの最下部を表す要素。

apiVersion
required
string

WebAPIバージョン

engineVersion
required
string

エンジンバージョン

object

エラー内容を表す要素。

Response samples

Content type
application/json
{
  • "ResultSet": {
    }
}

前後のダイヤ探索（リアルタイム）

指定された経路シリアライズデータ・区間インデックスを基準に、その前後の便を利用する経路を探索します。経路の算出には鉄道やバスのリアルタイムな情報が加味されます。
本機能を利用するには、mixway APIの契約に加え別途契約が必要です。詳細はお問い合わせフォームへご連絡ください。

以下のケースでは、シェアサイクルまたはデマンド交通を利用する経路は返却されません。

  • 出発時刻・到着時刻が、その事業者の営業期間外の場合
  • 出発時刻・到着時刻が、その発着ポートの営業時間外の場合
query Parameters
key
required
string

アクセスキー

serializeData
required
string

探索対象とする経路を表す経路シリアライズデータ。平均待ち時間による探索の経路シリアライズデータ・駅すぱあと API形式経路シリアライズデータは利用できません。

sectionIndex
required
integer

探索の基準とする区間を指し示す区間インデックス。交通手段がtrain bus plane shipである区間が指定可能です。それ以外の区間を指定した場合はエラーが返却されます。

answerCount
integer
Default: 5

最大回答数。最大20件。省略可。

previousCount
integer

出発日時が基準の経路の出発日時より前となる経路の回答数。 省略可。0以上answerCount未満 (0 < answerCount) の値が指定可能。 未指定時は (answerCount - 1) / 2 の小数点を切り捨てた整数が指定されます。基準となる経路は必ず回答に含まれるため、割り切れない場合は、指定経路より後方の経路を1経路多く回答します。
（例：answerCountが5の場合、previousCountのデフォルト値は2。この時返却される経路数は前の経路数2, 指定経路数1, 後ろの経路数2です。）
（例：answerCountが4の場合、previousCountのデフォルト値は1。この時返却される経路数は前の経路数1, 指定経路数1, 後ろの経路数2です。）

addOperationLinePattern
string
Default: false

結果に経路の区間に紐づく運行路線パターンを付加します。省略可。

指定できる値:

  • true: 付加する
  • false: 付加しない
addChange
boolean
Default: false

結果に次の路線への乗り換えに便利な乗車位置情報を付加します。省略可。

指定できる値:

  • true: 付加する
  • false: 付加しない
addStop
boolean
Default: false

経路の区間に停車駅一覧を付加する。省略可。

指定できる値:

  • true: 付加する
  • false: 付加しない
checkEngineVersion
string
Default: false

指定した経路の再現を行うとき、経路シリアライズデータ作成時のエンジンバージョンと再現時のエンジンバージョンが同一かをチェックします。エンジンバージョンが異なる場合は、エラーを返します。省略可。

指定できる値:

  • true: チェックする
  • false: チェックしない
multipleLineComment
boolean
Default: false

区間に対するコメント(ResultSet / Course / Route / Line / Comment)の返却方法を指定します。

  • true: 区間に対するコメントが配列で返却されます。（推奨）
  • false（デフォルト）: 区間に対するコメントがオブジェクトで返却されます。

false（デフォルト）では、区間に対するコメントを全て取得できるとは限りません。区間に対するコメントを全て取得したい場合は、trueを指定することを推奨します。

addSeatType
boolean
Default: false

結果のPrice要素(ResultSet / Course / Price)に列車ごとの座席種別(SeatType)を付加します。省略可。

  • true: 列車ごとの座席種別を付加する
  • false（デフォルト）: 列車ごとの座席種別を付加しない
trimBeforeSection
boolean
Default: false

元の経路情報から、sectionIndexで指定した区間より前の区間を除外するかどうかを指定します。省略可。

  • true: 元の経路情報から、指定された区間より前のすべての区間を除外した上で、指定区間以降の経路のみを処理およびレスポンスの対象とします。
  • false（デフォルト）: 元の経路情報を区間除外せず、経路全体を処理およびレスポンスの対象とします。

※trimBeforeSectionがtrueの場合、assignInstructionの値がSearchAllまたはSearchAfterのいずれであっても、結果は同一となります。

Responses

Response Schema: application/json
required
object

レスポンスの最下部を表す要素

apiVersion
string

WebAPIバージョン

engineVersion
string

エンジンバージョン

realtimeDataTimestamp
string

リアルタイムデータのバイナリ作成日時

Array of objects

経路探索の結果である経路を表す要素。探索の結果、経路が見つからなかった場合はこの要素自体が存在しません。

Response Schema: application/json
required
object

レスポンスの最下部を表す要素。

apiVersion
required
string

WebAPIバージョン

engineVersion
required
string

エンジンバージョン

object

エラー内容を表す要素。

Response samples

Content type
application/json
{
  • "ResultSet": {
    }
}

駅の情報

駅情報

指定された条件に当てはまる駅の情報を取得できます。
駅すぱあと APIの対応するAPI

query Parameters
name
string

候補文字列。oldName, code, corporationName, railName, operationLineCode と排他。かつ省略可なため、排他のパラメータが存在しない場合はname省略扱いとなります。

oldName
string

駅の旧名称。name, code, corporationName, railName, operationLineCode と排他。 ※路線バス停名は旧名称に対応していません。

code
integer

駅コード。name, oldName, corporationName, railName, operationLineCode と排他。

corporationName
string

会社。name, code, railName, operationLineCode と排他。

railName
string

「駅すぱあと」の平均路線名。name, code, corporationName, operationLineCode と排他。

operationLineCode
string

運行路線コード。name, oldName, code, corporationName, railName と排他。

type
string

駅の路線の交通種別 。oldName, code, corporationName, railName, operationLineCode 利用時には無効です。複数指定可。省略可。省略時は指定なしとなります。

prefectureCode
integer

都道府県コード。省略可。複数指定可。oldName, code, railName, operationLineCode 指定時無効です。省略時は全国が対象となります。

offset
integer

データの取得開始位置。省略可。oldName, code, railName, operationLineCode 指定時無効です。
Default: 1
※ 詳しくは駅情報を全件取得するをご確認ください。

limit
integer

データのブロック件数。省略可。oldName, code, railName, operationLineCode 指定時無効です。最大100件。
Default: 100

direction
string

路線の停車駅取得方向。railName, operationLineCode 指定時のみ有効。 指定できる値:

  • up: 通常
  • down: 反転
  • none: 指定なし

Default: up

corporationBind
string

固定会社名。指定した会社のみ利用します。複数指定可。最大10件。省略可。省略時は制限のない通常の取得となります。

addGateGroup
string

結果の駅に出口グループ(鉄道のみ)を付加するかどうかを指定します。省略可。 指定できる値:

  • true: 付加します
  • false: 付加しません

Default: false

gcs
string

リクエストやレスポンスに座標が含まれる場合、座標の測地系を指定することができます。また、リクエストパラメータの座標情報はgcsパラメータとは別の測地系を個別に指定可能です。省略可。 指定できる値:

  • tokyo: 日本測地系
  • wgs84: 世界測地系

Default: tokyo

Responses

Response Schema: application/json
object

レスポンスを表す要素

apiVersion
string

APIバージョン

engineVersion
string

エンジンバージョン

RoundTripType
string
Enum: "same" "different" "none" "other"

往復の種類を表す要素。
※ railName指定時付加

  • same: 往復が同じ停車駅を通過する場合
  • different: 往復で異なる停車駅を通過する場合
  • none: 往復共に停車駅が存在しない場合(廃止路線等)
  • other: same, different, noneに当てはまらない場合(環状線や片道運行等)
max
string

データの全件数。
※ 一度に取得できない場合は、offsetの指定を繰り上げて取得してください。詳しくは駅情報・路線情報・会社情報を全件取得するをご確認ください。

offset
string

データ開始位置のオフセット値

schemas-Point (object) or Array of schemas-Point (objects)

Response samples

Content type
application/json
{
  • "ResultSet": {
    }
}

駅簡易情報

指定された条件に当てはまる駅の簡易情報を返します。

このAPIは主に候補駅の確定を想定しているため、必要最低限の簡易データのみ返します。 また、一度に取得できる最大件数は30件です。 候補駅の確定(インクリメンタルサーチ)などで利用される場合、アクセスの回数は最大2回/1秒程度を目安にご利用ください。

query Parameters
name
string

候補文字列。codeと排他。かつ省略可なため、codeが存在しない場合はname扱いとなります。

code
integer

駅コード。name と排他。

type
string

駅の交通種別 。複数指定可。省略可。省略時は指定なしとなります。

prefectureCode
integer

都道府県コード。code利用時には無効です。複数指定可。省略可。省略時は全国が対象となります。

corporationBind
string

固定会社名。指定した会社のみ利用します。複数指定可。最大10件。省略可。省略時は制限のない通常の取得となります。

communityBus
string
Default: "contain"
Enum: "contain" "except"

取得結果の路線バスに対するコミュニティバスの扱いを指定します。
type未指定時またはtypeにbusおよびbus.local指定時のみ有効。
code, corporationBind 利用時には無効。
省略可。

指定できる値:

  • contain: 除外しない
  • except: 除外する
nameMatchType
string
Default: "forward"
Enum: "forward" "partial"

nameのマッチング方式の指定。
nameパラメータ指定時のみ有効。
省略可。

指定できる値:

  • forward: 前方一致
  • partial: 部分一致

※部分一致の場合、名称の末尾に付く括弧内やスラッシュ以降の補足情報はマッチング対象外となります。 （例: 「中野(東京都)」の(東京都)部分、「浦安駅／東京ベイシティバス」の／東京ベイシティバス部分）

Responses

Response Schema: application/json
object

レスポンスを表す要素

apiVersion
string

APIバージョン

engineVersion
string

エンジンバージョン

light_schemas-Point (object) or Array of light_schemas-Point (objects)

地点を表す要素

Response Schema: application/json
object

レスポンスを表す要素

apiVersion
string

APIバージョン

engineVersion
string

エンジンバージョン

object

エラーを表す要素

Response samples

Content type
application/json
{
  • "ResultSet": {
    }
}

区間の駅情報

経路シリアライズデータと区間インデックスから、指定経路・指定区間の停車駅一覧を取得できます。
駅すぱあと APIの対応するAPI

query Parameters
serializeData
required
string

mixway形式経路シリアライズデータ。駅すぱあと API形式経路シリアライズデータは利用できません。

sectionIndex
required
integer

区間インデックス。

checkEngineVersion
integer

シリアライズデータ作成時のエンジンバージョンと再現時のエンジンバージョンが同一かのチェックを有効。省略可。

sectionOnly
string

停車駅取得の範囲。trueは区間のみ。falseは全体。省略可。

Responses

Response Schema: application/json
object

レスポンスを表す要素

apiVersion
string

APIバージョン

engineVersion
string

エンジンバージョン

Array of objects

区間を表す要素

Array of objects

地点を表す要素

Response samples

Content type
application/json
{
  • "ResultSet": {
    }
}

通過駅情報

経路シリアライズデータの経路もしくは区間から、通過する駅と停車する駅の一覧を取得できます。
駅すぱあと APIの対応するAPI

query Parameters
serializeData
required
string

mixway形式経路シリアライズデータ。駅すぱあと API形式経路シリアライズデータは利用できません。必須。

checkEngineVersion
string

完全な定期経路シリアライズデータ、及びmixway形式経路シリアライズデータの再現を行う場合は、シリアライズデータ作成時のエンジンバージョンと再現時のエンジンバージョンが同一かのチェックを有効にします。エンジンバージョンが異なる場合は、エラーを返します。省略可。 指定できる値:

  • true: チェックする
  • false: チェックしない

Default: false
※ 駅すぱあと APIとはデフォルト値が異なります。

sectionIndex
integer

区間インデックス。 省略可。省略時は経路全体を対象とします。

Responses

Response Schema: application/json
object

レスポンスを表す要素

apiVersion
string

APIバージョン

engineVersion
string

エンジンバージョン

Array of objects

地点を表す要素

Response samples

Content type
application/json
{
  • "ResultSet": {
    }
}

列車等の停車駅情報

概要

経路シリアライズデータと区間インデックスから、特定の列車等の停車駅一覧を取得できます。
駅すぱあと APIの対応するAPI

query Parameters
serializeData
required
string

mixway形式経路シリアライズデータ。駅すぱあと API形式経路シリアライズデータは利用できません。必須。

checkEngineVersion
string

完全な定期経路シリアライズデータ、及びmixway形式経路シリアライズデータの再現を行う場合は、シリアライズデータ作成時のエンジンバージョンと再現時のエンジンバージョンが同一かのチェックを有効にします。エンジンバージョンが異なる場合は、エラーを返します。省略可。 指定できる値:

  • true: チェックする
  • false: チェックしない

Default: false
※ 駅すぱあと APIとはデフォルト値が異なります。

sectionIndex
required
integer
lineCode
required
string

列車等を特定するコードの指定。必須 詳しくはこちらを参照。

sectionOnly
string

停車駅取得の範囲。省略可。
指定できる値:

  • true: 区間のみ
  • false: 全体

Default: true
詳しくはこちらを参照。

Responses

Response Schema: application/json
object

レスポンスを表す要素

apiVersion
string

APIバージョン

engineVersion
string

エンジンバージョン

Array of objects

区間を表す要素

Array of objects

地点を表す要素

Response samples

Content type
application/json
{
  • "ResultSet": {
    }
}

経路のシェイプ情報

経路探索結果のシェイプ情報

概要

経路探索結果（経路シリアライズデータ）から、経路のシェイプ情報（地図に経路をポリライン描画するための情報）を取得します。レスポンスとしては、経路の区間（ResultSet / Course / Route / Line）毎にシェイプポイントの情報が返ります。

query Parameters
serializeData
required
string

mixway形式経路シリアライズデータ。駅すぱあと API形式経路シリアライズデータは利用できません。

※ 平均待ち時間による探索で取得した経路の経路シリアライズデータを指定することはできません。

checkEngineVersion
string

完全な定期経路シリアライズデータ、及び経路シリアライズデータの再現を行う場合は、シリアライズデータ作成時のエンジンバージョンと再現時のエンジンバージョンが同一かのチェックを有効にします。エンジンバージョンが異なる場合は、エラーを返します。省略可。 指定できる値:

  • true: チェックする
  • false: チェックしない

Default: false
※ 駅すぱあと APIとはデフォルト値が異なります。

Responses

Response Schema: application/json
object

レスポンスを表す要素

apiVersion
string

APIバージョン

engineVersion
string

エンジンバージョン

object

経路探索の結果である経路を表す要素

Response samples

Content type
application/json
{
  • "ResultSet": {
    }
}

経路の運賃計算操作

探索結果の運賃切り替え

経路の運賃を切り替えて再計算します。

query Parameters
serializeData
required
string

mixway形式経路シリアライズデータ。駅すぱあと API形式経路シリアライズデータは利用できません。

checkEngineVersion
string
Default: false

完全な定期経路シリアライズデータ、及び経路シリアライズデータの再現を行う場合は、シリアライズデータ作成時のエンジンバージョンと再現時のエンジンバージョンが同一かのチェックを有効にします。エンジンバージョンが異なる場合は、エラーを返します。省略可。

指定できる値:

  • true: チェックする
  • false: チェックしない

※ 駅すぱあと APIとはデフォルト値が異なります。

fareIndex
string

利用運賃のインデックス指定。Price（kind="Fare"）のindexの値を指定します。
交通手段がtrain bus plane shipである区間が指定可能です。それ以外の区間を指定した場合はエラーが返却されます。 複数指定可。他の~IndexまたはteikiKindを指定した場合のみ省略可。

chargeIndex
string

利用料金のインデックス指定。Price（kind="Charge"）のindexの値を指定します。 複数指定可。他の~IndexまたはteikiKindを指定した場合のみ省略可。

vehicleIndex
string

定期券で利用できる車両のインデックス指定。PassStatus（kind="vehicle"）のindexの値を指定します。 複数指定可。他の~IndexまたはteikiKindを指定した場合のみ省略可。

passClassIndex
string

定期券の種類のインデックス指定。PassStatus（kind="nikukanteiki"またはkind="bycorporation"）のindexの値を指定します。 複数指定可。他の~IndexまたはteikiKindを指定した場合のみ省略可。

※「定期券の種類: 二区間定期券」を利用した金額を得たい場合は、 探索条件に「二区間定期券を利用する」を設定した経路探索の経路シリアライズデータを指定する必要があります。探索条件の設定は探索条件生成で行うことができます。

teikiKind
string

定期券種別の切り替え。~Indexを指定した場合のみ省略可。

指定できる値:

  • bussiness:通勤
  • university:通学 (大学)
  • highSchool:通学 (高校)
  • juniorHighSchool:通学 (中学)
addRouteData
string
Default: false

結果にRouteの情報を含むかどうかを指定。省略可。

指定できる値:

  • true: 含む
  • false: 含まない
addChange
string
Default: false

結果にRouteの情報を含む場合、Routeの情報に次の路線への乗り換えに便利な乗車位置情報を付加します。addRouteDataにtrueを指定した場合、かつダイヤによる探索時のみ有効。省略可。

指定できる値:

  • true: 付加します
  • false: 付加しません
addSeatType
string
Default: false

結果の料金に列車ごとの座席種別を付加する。省略可。

指定できる値:

  • true: 列車ごとの座席種別を付加する
  • false: 列車ごとの座席種別を付加しない

Responses

Response Schema: application/json
object
apiVersion
string

WebAPIバージョン

engineVersion
string

エンジンバージョン

Array of objects

経路探索の結果である経路を表す要素。探索の結果、経路が見つからなかった場合はこの要素自体が存在しません。

Response Schema: application/json
required
object

レスポンスの最下部を表す要素。

apiVersion
required
string

WebAPIバージョン

engineVersion
required
string

エンジンバージョン

object

エラー内容を表す要素。

Response Schema: application/json
required
object

レスポンスの最下部を表す要素。

apiVersion
required
string

WebAPIバージョン

engineVersion
required
string

エンジンバージョン

object

エラー内容を表す要素。

Response samples

Content type
application/json
{
  • "ResultSet": {
    }
}

経路探索結果の操作

経路の再現／定期券・指定列車利用

経路シリアライズデータを利用した各種経路の操作ができる機能です。指定パラメータの組み合わせによって、機能が変わります。

パラメータの組み合わせ
serializeDataのみを指定 指定した経路シリアライズデータに基づき経路の再現を行います。
serializeDataとassignRoute,assignDetailRoute,assignTeikiSerializeDataのいずれかを指定 serializeDataの再現経路にてassignRoute,assignDetailRoute, assignTeikiSerializeDataを定期券経路として利用します。
serializeDataとcouponを指定 serializeDataの再現経路に回数券を利用します。
serializeDataとlineCode, sectionIndex, assignInstructionを指定 serializeDataの再現経路の指定区間を指定の列車に置き換えます。ただし、assignInstructionの値にAutoPrevious, AutoNextのいずれかを指定した場合は、自動的に列車を適応します。詳しくはこちら。
serializeDataとsectionIndex, assignType, date, timeを指定 serializeDataの再現経路の指定区間を指定の日時で再探索します。
query Parameters
serializeData
required
string

mixway形式経路シリアライズデータ。駅すぱあと API形式経路シリアライズデータは利用できません。

checkEngineVersion
boolean
Default: false
Enum: true false

完全な定期経路シリアライズデータ、及び経路シリアライズデータの再現を行う場合は、シリアライズデータ作成時のエンジンバージョンと再現時のエンジンバージョンが同一かのチェックを有効にします。エンジンバージョンが異なる場合は、エラーを返します。省略可。
指定できる値:

  • true: チェックする
  • false: チェックしない

※ 駅すぱあと APIとはデフォルト値が異なります。

assignTeikiSerializeData
string

定期経路シリアライズデータ。省略可。assignDetailRouteと排他。
※ 詳しくは定期情報の取得と定期情報の更新及び定期券利用時の運賃計算をご確認ください。

assignDetailRoute
string
Example: assignDetailRoute=高円寺:ＪＲ中央線快速:Up:新宿:ＪＲ山手線外回り:Down:池袋

定期経路文字列。駅の名称:平均路線:方向:駅の名称...の羅列。省略可。
※ 詳しくは定期情報の取得と定期情報の更新及び定期券利用時の運賃計算をご確認ください。

coupon
string

回数券詳細名称。省略可

sectionIndex
integer

区間インデックス。date、time、lineCodeもしくはassignType指定時は必須。

lineCode
string

列車等を特定するコード。省略可
詳しくはこちらを参照。

assignInstruction
string
Enum: "SearchAll" "SearchAfter" "SearchBefore" "Replace" "AutoNext" "AutoPrevious"

定期券・指定列車利用時の再探索モード。
指定できる値:

  • SearchAll: 経路全体を再探索
  • SearchAfter: 指定区間より後方を再探索
  • SearchBefore: 指定区間より前方を再探索
  • Replace: 指定区間を置き換える
  • AutoNext: 次に出発する最適なダイヤの組み合わせを設定する
  • AutoPrevious: 前に出発する最適なダイヤの組み合わせを設定する

詳しくはこちらを参照。

assignType
string
Enum: "departure" "arrival"

指定した日時の扱い。date、time指定時は必須。
指定できる値:

  • departure: 発時刻
  • arrival: 着時刻
date
string <YYYYMMDD>
Default: "現在年月日"

探索日付。省略可。

time
string <HHMM>
Default: "現在時刻"

探索時刻。省略可。

addChange
boolean
Default: false
Enum: true false

結果に次の路線への乗り換えに便利な乗車位置情報を付加します。ダイヤによる探索時のみ有効。省略可。
指定できる値:

  • true: 付加します
  • false: 付加しません
interruptTransferStationCodeList
string

乗換しない駅リスト。乗り換えたくない駅の駅コードを指定します。複数指定可。最大30件。省略可。
省略時は制限のない通常の探索となります。

multipleLineComment
boolean
Default: false

区間に対するコメント(ResultSet / Course / Route / Line / Comment)の返却方法を指定します。

  • true: 区間に対するコメントが配列で返却されます。（推奨）
  • false（デフォルト）: 区間に対するコメントがオブジェクトで返却されます。

false（デフォルト）では、区間に対するコメントを全て取得できるとは限りません。区間に対するコメントを全て取得したい場合は、trueを指定することを推奨します。

addSeatType
boolean
Default: false

結果のPrice要素(ResultSet / Course / Price)に列車ごとの座席種別(SeatType)を付加します。省略可。

  • true: 列車ごとの座席種別を付加する
  • false（デフォルト）: 列車ごとの座席種別を付加しない

Responses

Response Schema: application/json
required
object

レスポンスの最下部を表す要素

apiVersion
string

WebAPIバージョン

engineVersion
string

エンジンバージョン

Array of objects

経路探索の結果である経路を表す要素。探索の結果、経路が見つからなかった場合はこの要素自体が存在しません。

Response Schema: application/json
required
object

レスポンスの最下部を表す要素。

apiVersion
required
string

WebAPIバージョン

engineVersion
required
string

エンジンバージョン

object

エラー内容を表す要素。

Response samples

Content type
application/json
{
  • "ResultSet": {
    }
}

経路探索結果の操作（リアルタイム情報）

経路の再現／一本前・一本後(リアルタイム)

経路シリアライズデータを利用した各種経路の操作ができる機能です。指定パラメータの組み合わせによって、機能が変わります。結果経路にはリアルタイムデータが反映されます。

パラメータの組み合わせ
serializeDataのみを指定 指定した経路シリアライズデータに基づき経路の再現を行います。
serializeDataとassignInstructionを指定 指定に応じ再現経路の各区間を適切な列車に置き換えます。
serializeDataとsectionIndex, assignType, date, timeを指定 serializeDataの再現経路の指定区間を指定の日時で再探索します。

assignTeikiSerializeData など上記以外のパラメータはいずれの場合も結果経路に反映されます。

query Parameters
key
required
string
Example: key=myAccessKey

アクセスキー

serializeData
required
string

mixway形式経路シリアライズデータ。駅すぱあと API形式経路シリアライズデータは利用できません。

assignInstruction
string
Enum: "AutoNext" "AutoPrevious"
Example: assignInstruction=AutoNext

定期券・指定列車利用時の再探索モード。

指定できる値:

  • AutoNext: 次に出発する最適なダイヤの組み合わせを設定する
  • AutoPrevious: 前に出発する最適なダイヤの組み合わせを設定する
sectionIndex
integer

区間インデックス。date、time、assignType指定時は必須。

assignType
string
Enum: "departure" "arrival"

指定した日時の扱い。date、time指定時は必須。
指定できる値:

  • departure: 発時刻
  • arrival: 着時刻
date
string <YYYYMMDD>
Default: "現在年月日"

探索日付。省略可。

time
string <HHMM>
Default: "現在時刻"

探索時刻。省略可。

checkEngineVersion
string
Example: checkEngineVersion=true

完全な定期経路シリアライズデータ、及び経路シリアライズデータの再現を行う場合は、シリアライズデータ作成時のエンジンバージョンと再現時のエンジンバージョンが同一かのチェックを有効にします。エンジンバージョンが異なる場合は、エラーを返します。省略可。

指定できる値:

  • true: チェックする
  • false: チェックしない

Default: false

assignTeikiSerializeData
string

定期経路シリアライズデータ。省略可。assignDetailRouteと排他。 ※ 詳しくは定期情報の取得と定期情報の更新及び定期券利用時の運賃計算をご確認ください。

assignDetailRoute
string
Example: assignDetailRoute=高円寺:ＪＲ中央線快速:Up:新宿:ＪＲ山手線外回り:Down:池袋

定期経路文字列。駅の名称:平均路線:方向:駅の名称...の羅列。省略可。 ※ 詳しくは定期情報の取得と定期情報の更新及び定期券利用時の運賃計算をご確認ください。

offpeakTeikiMode
string
Example: offpeakTeikiMode=offpeakTime

オフピーク定期券利用時の計算モード。
assignDetailRoute, assignTeikiSerializeDataのいずれか指定時のみ指定可。 省略可。省略時は、指定された定期券の種類に関わらず、通常の定期券利用時の運賃計算となります（オフピーク定期券として扱われません）。

指定できる値:

  • offpeakTime: オフピーク時間帯の利用とみなして運賃計算する
  • peakTime: ピーク時間帯の利用とみなして運賃計算する

※詳しくは定期券利用時の運賃計算 > 定期情報を「オフピーク定期券」として利用する場合および定期割り当てステータスコード > オフピーク定期券を利用する場合をご確認ください。

assignPassClassIndex
string

定期券利用時の運賃計算を行う際に、利用する定期経路に定期券の種類が複数ある場合は、PassStatus（kind="nikukanteiki"またはkind="bycorporation"）のindexの値を指定することで、定期券の種類を切り替えることができます。
複数指定可。同一区間のインデックスが複数指定された場合はどれか一つを適用します。
assignDetailRoute, assignTeikiSerializeDataのいずれか指定時のみ有効。
省略可。省略時は、デフォルトの定期券となります。
※ 詳しくは、二区間定期券などの特殊な定期券利用時の運賃計算をご確認ください。

addChange
string
Example: addChange=true

結果に次の路線への乗り換えに便利な乗車位置情報を付加します。ダイヤによる探索時のみ有効。省略可。

指定できる値:

  • true: 付加します
  • false: 付加しません

Default: false

multipleLineComment
boolean
Default: false

区間に対するコメント(ResultSet / Course / Route / Line / Comment)の返却方法を指定します。

  • true: 区間に対するコメントが配列で返却されます。（推奨）
  • false（デフォルト）: 区間に対するコメントがオブジェクトで返却されます。

false（デフォルト）では、区間に対するコメントを全て取得できるとは限りません。区間に対するコメントを全て取得したい場合は、trueを指定することを推奨します。

addSeatType
boolean
Default: false

結果のPrice要素(ResultSet / Course / Price)に列車ごとの座席種別(SeatType)を付加します。省略可。

  • true: 列車ごとの座席種別を付加する
  • false（デフォルト）: 列車ごとの座席種別を付加しない

Responses

Response Schema: application/json
required
object

レスポンスの最下部を表す要素

apiVersion
string

WebAPIバージョン

engineVersion
string

エンジンバージョン

realtimeDataTimestamp
string

リアルタイムデータのバイナリ作成日時

Array of objects

経路探索の結果である経路を表す要素。探索の結果、経路が見つからなかった場合はこの要素自体が存在しません。

Response Schema: application/json
required
object

レスポンスの最下部を表す要素。

apiVersion
required
string

WebAPIバージョン

engineVersion
required
string

エンジンバージョン

object

エラー内容を表す要素。

Response samples

Content type
application/json
{
  • "ResultSet": {
    }
}

ポートの情報

緯度経度からポート情報の検索

概要

任意の座標情報から、シェアサイクル・オンデマンド交通のポートまたは駅情報を検索し情報を返します。
半径を指定した場合、指定した座標から近い順に返却します。半径を指定しない場合は最寄りの1件を返します。

query Parameters
geoPoint
required
string

任意の場所の座標情報。緯度経度はそれぞれ,で連結し使用します。半径(メートル)を指定しない場合は、最寄りの1件を返します。

例：
半径を指定した場合：35.706220,139.651652,5000
半径を指定しない場合：35.706220,139.651652

type
string

駅すぱあと APIの駅の交通種別に加え、以下の交通種別を付与できます。複数指定可。

  • cycle：シェアサイクルのポート
  • demand：デマンドモビリティのポート
stationCount
integer >= 1

geoPointで半径を指定した場合に、有効になります。

offset
integer >= 0
Default: 0

データの取得開始位置を指定できます。省略可。

limit
integer [ 1 .. 7000 ]
Default: 7000

取得するデータの上限数を指定できます。省略可。
7000より大きい値を指定した場合は、7000件を上限として返却します。

portCorporationBind
string

シェアサイクルやオンデマンド交通の会社コード。指定された会社のポート情報のみを返します。複数指定可。省略可。省略時は制限の無い通常の探索となります。
シェアサイクルとオンデマンド交通の会社コードを指定することができます。
ポート以外の駅の情報を除外したい場合はtypeパラメータにて対象種別を指定してください。
例) シェアサイクルポートのみを取得したい場合：type=cycle
詳しくは type パラメータの説明をご参照ください。

addInformation
string

追加情報を返します。複数指定可。省略可。

  • image: ポートの画像URLがレスポンスに追加されます
  • availability: ポートの満空情報がレスポンスに追加されます
  • openingTime: ポートの営業時間がレスポンスに追加されます
  • rentalUris: ポートから車両をレンタルするためのURIがレスポンスに追加されます
addGateGroup
enum
Default: false
Enum: true false

結果の駅に出口グループ(鉄道のみ)を付加するかどうかを指定します。省略可。
指定できる値:

  • true: 付加します
  • false: 付加しません

Responses

Response Schema: application/json
object

レスポンスを表す要素

apiVersion
string

APIバージョン

engineVersion
string

エンジンバージョン

offset
string

データの取得開始位置

limit
string

取得するデータの上限数

Array of objects

ポートを表す要素

Response samples

Content type
application/json
{
  • "ResultSet": {
    }
}

ポート名や駅名の詳細情報

概要

ポート名や駅名の簡易情報で取得したコード情報を指定し、ポートや駅の詳細な情報を取得できます。

query Parameters
code
required
string

駅コード または ポートコード。それぞれのコードはポート名や駅名の簡易情報 で取得できます。

Responses

Response Schema: application/json
object

レスポンスを表す要素

apiVersion
string

APIバージョン

engineVersion
string

エンジンバージョン

object

ポートを表す要素

Response samples

Content type
application/json
{
  • "ResultSet": {
    }
}

ポート名や駅名の簡易情報

概要

任意の文字列から、シェアサイクル・オンデマンド交通のポートまたは駅情報を検索し情報を返します。
主に候補ポートまたは候補駅の確定を想定しているため、必要最低限の簡易データのみ返します。また、一度に取得できる最大件数は30件です。

query Parameters
name
required
string

任意の文字列。

type
string

駅すぱあと APIの駅の交通種別に加え、以下の交通種別を付与できます。複数指定可。

  • cycle：シェアサイクルのポート
  • demand：デマンドモビリティのポート
corporationBind
string

検索対象会社の絞り込み。指定した会社・シェアサイクル事業者・オンデマンド交通事業者の中から検索します。

以下の値が指定可能です。

交通種別 値
鉄道・バス・空路・海路 会社名
シェアサイクル シェアサイクル事業者コード
オンデマンド交通 オンデマンド交通事業者コード

複数指定可。最大40件。省略可。省略時は制限の無い通常の検索です。

Responses

Response Schema: application/json
object

レスポンスを表す要素

apiVersion
string

APIバージョン

engineVersion
string

エンジンバージョン

Array of objects

Response samples

Content type
application/json
{
  • "ResultSet": {
    }
}

路線の情報

平均路線情報

概要

「駅すぱあと」の保持する平均路線の情報を取得します。 nameを指定すると、名称の前方一致による絞り込みを行います。 oldNameを指定すると、新名称を取得できます。 fromとtoを指定した場合は、2点間を結ぶ平均路線が取得できます。 dateを指定すると、その日に運行している平均路線に絞り込めます。 serializeDataとsectionIndexを指定すると、区間の列車リストを取得できます。
駅すぱあと APIの対応するAPI

リクエストパラメータ

パラメータ名EWSmixway備考
key○○
name○○
oldName○○
corporationCode○○
corporationName○○
from○○
to○○
prefectureCode○○
date○○
type○○
offset○○
limit○○
serializeData○○mixway形式経路シリアライズデータのみ利用可能
checkEngineVersion○○デフォルト値が異なる
sectionIndex○○
○＝パラメータあり　☓＝パラメータなし　両方○でも機能差異がある場合は備考欄および後述のParameters節に記載。

レスポンス

本APIのレスポンス構造は駅すぱあと APIの対応するAPI（JSON版）と完全に同一です。

query Parameters
name
string

平均路線の名称（前方一致）。oldName, corporationName, from, to, serializeDataと排他。省略可

oldName
string

平均路線の旧名称。name, corporationName, from, to, serializeDataと排他。省略可。
※路線バス路線名は旧名称に対応していません。

corporationCode
integer

会社コード。name, oldName, corporationName, from, to, serializeDataと排他。省略可

corporationName
string

会社の名称。name, oldName, corporationCode, from, to, serializeDataと排他。省略可

from
string

駅コードまたは駅の名称。name, oldName, corporationName, serializeDataと排他。to指定時に必須

to
string

駅コードまたは駅の名称。name, oldName, corporationName, serializeDataと排他。from指定時に必須

prefectureCode
integer

都道府県コード。省略可。省略時は全国が対象となります。

date
integer

日付。省略可。省略時は全日付が対象となります。
Format: YYYYMMDD

type
string

交通種別。詳細路線種別を付加することができます。省略可。省略時は全種別が対象となります。

offset
integer

データの取得開始位置。name, serializeData指定時は無効となります。省略可。
Default: 1

limit
integer

データのブロック件数。最大100件まで指定できます。name, serializeData指定時は無効となります。省略可。
Default: 100

serializeData
string

mixway形式経路シリアライズデータ。駅すぱあと API形式経路シリアライズデータは利用できません。 name, oldName, corporationName, from, toと排他。省略可

checkEngineVersion
string

完全な経路シリアライズデータの再現を行う場合は、シリアライズデータ作成時のエンジンバージョンと再現時のエンジンバージョンが同一かのチェックを有効にします。エンジンバージョンが異なる場合は、エラーを返します。省略可。
指定できる値:
- true: チェックする
- false: チェックしない
Default: false
※ 駅すぱあと APIとはデフォルト値が異なります。

sectionIndex
integer

区間インデックス。serializeData指定時に必須

Responses

会社の情報

会社情報

会社の情報を取得します。 会社の分類は「バス」、「バス以外の公共交通機関(鉄道、空路、海路)」、「シェアサイクル」、「オンデマンド交通」の四種類です。

query Parameters
key
required
string
Example: key=myAccessKey

アクセスキー

code
string
Example: code=1

会社コード。type指定時以外必須。「バス以外の公共交通機関(鉄道、空路、海路)」と「シェアサイクル」と「オンデマンド交通」の会社コードが指定可能。prefectureCode, type, name, offset, limit と排他。

type
string
Enum: "train" "bus" "cycle" "demand"
Example: type=train

会社の種別。code指定時以外必須。 code と排他。

  • train: バス以外の公共交通機関(鉄道、空路、海路)
  • bus: バス
  • cycle: シェアサイクル
  • demand: オンデマンド交通
name
string
Example: name=東

会社の名称。code と排他。

prefectureCode
string
Example: prefectureCode=1:2:3

都道府県のコード。複数指定可能。省略時は全ての都道府県が対象。code と排他。type=cycle type=demandとの同時指定は不可。

offset
string
Default: 1
Example: offset=101

データの取得開始位置。code と排他。

limit
string
Default: 100
Example: limit=100

データのブロック件数。指定可能な値は1から100。code と排他。

Responses

Response Schema: application/json
object
apiVersion
string

APIバージョン

engineVersion
string

エンジンバージョン

max
string

データの全件数

offset
string

データ開始位置のオフセット値

Array of objects

会社情報を表す要素。会社情報が見つからなかった場合は空の配列が返却されます。

Response Schema: application/json
object
apiVersion
string
engineVersion
string
object

エラーを表す要素。

Response Schema: application/json
object
apiVersion
string
engineVersion
string
object

エラーを表す要素。

Response samples

Content type
application/json
{
  • "ResultSet": {
    }
}

リアルタイム便情報

リアルタイム便情報

鉄道・バスの便ごとのリアルタイムに更新される情報を取得できます。
本機能を利用するには、mixway APIの契約に加え情報を利用するための許諾が必要です。詳細はお問い合わせフォームへご連絡ください。
取得対象の交通事業者であり、また便情報が存在する便に限って情報を取得できます。そのためトリップコードを指定してもその便情報が返却されない場合があります。

query Parameters
key
required
string

アクセスキー

tripCode
required
string
Example: tripCode=99999999:88888888:77777777

トリップコード。便を特定するためのユニークなコード
コードはエンジンバージョンが変わるごとに採番されます。そのためエンジンバージョンをまたいで利用することはできません。また同じ値であってもエンジンバージョンによって示す便が異なります。 上限30まで複数指定可。

engineVersion
required
string
Example: engineVersion=202310_05a

エンジンバージョン
値はtripCodeを取得したAPIレスポンスを参照してください。
例えば、以下の機能ではResultSet / engineVersionに値が含まれています。

最新ではないエンジンバージョンを指定した場合、便情報は取得できません。

addInformation
string
Enum: "congestion" "stopPattern"
Examples: addInformation=congestion:stopPattern

レスポンスに付帯情報を追加するかの設定。複数指定可。省略可。

  • congestion: 混雑情報をレスポンスに追加する。
  • stopPattern: 便の停車パターン(停車駅またはバス停の一覧)をレスポンスに追加する。

Responses

Response Schema: application/json
required
object

レスポンスの最下部を表す要素

apiVersion
required
string

WebAPIバージョン

engineVersion
required
string

エンジンバージョン

realtimeDataTimestamp
required
string

タイムスタンプ
レスポンスの生成日時を示す値。
便において実際のリアルタイム情報が取得された日時ではありません。

required
Array of 駅・バス停に停車中 (object) or 駅・バス停間を走行中 (object)

便情報を表す要素
position: fromとposition: betweenのいずれのフォーマットになるかは、交通事業者や取得時点の便の状況によって変化します。またこのフォーマットは今後増える可能性がある点に留意してください。

Response Schema: application/json
required
object

レスポンスの最下部を表す要素。

apiVersion
required
string

WebAPIバージョン

engineVersion
required
string

エンジンバージョン

object

エラー内容を表す要素。

Response samples

Content type
application/json
{
  • "ResultSet": {
    }
}

運行路線情報

運行路線情報

概要

「駅すぱあと」の保持する運行路線の情報(鉄道のみ)を取得します。

  • codeを指定すると、指定した運行路線の情報を返します。
  • nameを指定すると、運行路線の前方一致による絞り込みを行います。部分一致検索をしたい場合はnameMatchTypeパラメータをご利用ください。
  • dateを指定すると、その日時点で有効な運行路線に絞り込めます。
query Parameters
key
required
string
Example: key=myAccessKey

アクセスキー。

code
string

運行路線コードです。nameとは排他です。

name
string

運行路線名です。codeとは排他です。（日本語名のみ受け付けます）

nameMatchType
string
Default: "forward"
Enum: "forward" "partial"

マッチング方式を指定します。nameパラメータ指定時のみ有効です。'forward'（前方一致）または'partial'（部分一致）を指定できます。

corporationCode
string

会社コード。corporationNameとは排他です。省略可能で、省略時は全ての会社が対象です。code指定時は無効です。

corporationName
string

会社名。corporationCodeとは排他です。省略可能で、省略時は全ての会社が対象です。code指定時は無効です。 corporationNameは会社情報APIから取得することができます

prefectureCode
string

都道府県コードです。省略可能で、省略時は全国が対象です。code指定時は無効です。

date
string <YYYYMMDD>

日付を指定します。省略可能で、省略時は全日付が対象です。code指定時は無効です。

offset
integer
Default: "1"

データの取得開始位置です。code指定時は無効です。省略可能です。

limit
number
Default: "100"

データのブロック件数を指定します。code指定時は無効です。指定可能な値は1から100です。省略可能です。

Responses

Response Schema: application/json
required
object

レスポンスを表す要素

apiVersion
required
string

WebAPIバージョン

engineVersion
required
string

エンジンバージョン

max
required
string

未取得分含む全体件数

offset
required
string

今回のリクエストでのオフセット値

Array of objects

事業者情報のリスト

Array of objects

路線情報のリスト

Response Schema: application/json
required
object

レスポンスの最下部を表す要素。

apiVersion
required
string

WebAPIバージョン

engineVersion
required
string

エンジンバージョン

object

エラー内容を表す要素。

Response samples

Content type
application/json
{
  • "ResultSet": {
    }
}

時刻表

鉄道駅時刻表

概要

鉄道駅について、路線・方面ごとの一日の時刻表を取得できます。以下の順でAPIをリクエストし利用します。

  1. codeパラメータを指定せずに方面別一覧を取得
  2. 時刻表を取得したい方面のコードを指定して、鉄道駅時刻表を取得
query Parameters
key
required
string
Example: key=myAccessKey

アクセスキー

stationCode
string
Example: stationCode=22671

駅コード。stationNameが指定されていない場合必須。交通種別がtrainのもののみ指定可能です。

stationName
string
Example: stationName=高円寺

駅の名称。stationCodeが指定されていない場合必須。交通種別がtrainのもののみ指定可能です。

date
string <YYYYMMDD>
Example: date=20240630

時刻表取得日付。省略可。省略時は日付を考慮しない時刻表になります。dateGroup指定時は、指定曜日区分の直近未来の日付になります。

dateGroup
string
Enum: "weekday" "saturday" "holiday"
Example: dateGroup=weekday

取得する時刻表の曜日区分。省略可。複数指定可。

  • 平日: weekday
  • 土曜: saturday
  • 日・祝日: holiday

Default: 現在日付の曜日区分（date指定時は、指定日付の曜日区分になります。）

code
string
Example: code=1091

時刻表を特定する一意のコード。省略可。省略時は駅時刻表の方面別一覧を返します。

addTrainInformation
boolean
Default: false
Enum: true false

臨時・運転日注意フラグを持つ列車の情報を付加します。省略可。

  • true: 付加します
  • false: 付加しません

Responses

Response Schema: application/json
required
object

レスポンスを表す要素

apiVersion
required
string

WebAPIバージョン

engineVersion
required
string

エンジンバージョン

required
Array of objects

時刻表を表す要素

Response Schema: application/json
required
object

レスポンスの最下部を表す要素。

apiVersion
required
string

WebAPIバージョン

engineVersion
required
string

エンジンバージョン

object

エラー内容を表す要素。

Response samples

Content type
application/json
{
  • "ResultSet": {
    }
}

バス路線時刻表

2点間のバス停から時刻表を取得します。

query Parameters
key
required
string
Example: key=myAccessKey

アクセスキー

from
required
string
Example: from=59120

出発駅。駅コードが指定できます。

to
required
string
Example: to=59393

到着駅。駅コードが指定できます。

date
string <YYYYMMDD>
Example: date=20250101

時刻表取得日付。省略可。省略時は本日日付の時刻表になります。

Responses

Response Schema: application/json
required
object

レスポンスを表す要素

apiVersion
required
string

WebAPIバージョン

engineVersion
required
string

エンジンバージョン

required
object

時刻表を表す要素

Response Schema: application/json
required
object

レスポンスの最下部を表す要素。

apiVersion
required
string

WebAPIバージョン

engineVersion
required
string

エンジンバージョン

object

エラー内容を表す要素。

Response samples

Content type
application/json
{
  • "ResultSet": {
    }
}

ツール

探索条件生成

リクエストパラメータを元に、経路探索に利用する条件を生成します。 detailの指定がない場合は、デフォルトの条件を元に探索条件を生成します。 detailを指定した場合は、detailの値に対して指定パラメータの値を置き換えます。つまり、前回生成した詳細条件探索データの一部を変更したものを取得できます。

query Parameters
detail
string

詳細探索条件データ。省略可
Default: T3221233232319:F332112212000:A23121141:

plane
string

飛行機。省略可。
指定できる値:
- light:気軽に利用 ※探索種別がplain以外の場合、normalを指定した時と同じ挙動となります。
- normal:普通に利用
- bit:極力利用しない ※探索種別がplain以外の場合、neverを指定した時と同じ挙動となります。
- never:利用しない
Default: normal (detailパラメータ指定時はdetailの値）

shinkansen
string

新幹線。省略可
指定できる値:
- normal:利用する
- never:利用しない
Default: normal (detailパラメータ指定時はdetailの値)

shinkansenNozomi
string

特急料金が加算される一部の新幹線。省略可。
対象となる新幹線 (区間):
-「ＪＲ新幹線のぞみ」 (東京 - 博多間)
-「ＪＲ新幹線みずほ」 (新大阪 - 博多間)
-「ＪＲ新幹線はやぶさ」 (東京 - 盛岡間)
-「ＪＲ新幹線こまち」 (東京 - 盛岡間)
指定できる値:
- normal:利用する
- never:利用しない ※上記の新幹線の全てが対象となります。
Default: normal (detailパラメータ指定時はdetailの値)

sleeperTrain
string

寝台列車。省略可。
指定できる値:
- possible:極力利用する ※探索種別がplain以外の場合、normalを指定した時と同じ挙動となります。
- normal:普通に利用
- never:利用しない
Default: never (detailパラメータ指定時はdetailの値)

limitedExpress
string

有料特急。省略可
指定できる値:
- normal:利用する
- never:利用しない
Default: normal (detailパラメータ指定時はdetailの値)

highwayBus
string

高速バス。省略可。
指定できる値:
- light:気軽に利用
- normal:普通に利用
- bit:極力利用しない ※探索種別がplain以外の場合、neverを指定した時と同じ挙動となります。
- never:利用しない
Default: normal (detailパラメータ指定時はdetailの値)

connectionBus
string

連絡バス 。省略可。
指定できる値:
- light:気軽に利用 ※探索種別がplain以外の場合、normalを指定した時と同じ挙動となります。
- normal:普通に利用
- bit:極力利用しない ※探索種別がplain以外の場合、neverを指定した時と同じ挙動となります。
- never:利用しない
Default: normal (detailパラメータ指定時はdetailの値)

localBus
string

路線バス 。省略可
指定できる値:
- normal:利用する
- never:利用しない
Default: normal (detailパラメータ指定時はdetailの値)

communityBus
string

路線バスに対するコミュニティバスの扱いを指定します。localBusがneverの場合無効。省略可。
指定できる値:
- contain:除外しない
- except:除外する
Default: contain (detailパラメータ指定時はdetailの値)

midnightBus
string

深夜急行バス 。探索種別がplainの場合無効。省略可
指定できる値:
- normal:利用する
- never:利用しない
Default: never (detailパラメータ指定時はdetailの値)

ship
string

船 。省略可。
指定できる値:
- light:気軽に利用 ※探索種別がplain以外の場合、normalを指定した時と同じ挙動となります。
- normal:普通に利用
- bit:極力利用しない ※探索種別がplain以外の場合、neverを指定した時と同じ挙動となります。
- never:利用しない
Default: normal (detailパラメータ指定時はdetailの値)

liner
string

ライナー（乗車整理券、ライナー券、普通車指定席券が必要な列車）。
探索種別がplainの場合無効。省略可
指定できる値:
- normal:利用する
- never:利用しない
Default: normal (detailパラメータ指定時はdetailの値)

walk
string

駅間徒歩。 探索種別がplainの場合のみ有効。省略可
指定できる値:
- normal:気にならない
- little:少し気になる
- never:利用しない
Default: normal (detailパラメータ指定時はdetailの値)

useJR
string

ＪＲ路線。探索種別がplainの場合のみ有効。省略可
指定できる値:
- light:気軽に利用
- normal:普通に利用
- bit:極力利用しない
Default: normal (detailパラメータ指定時はdetailの値)

transfer
string

乗換え。探索種別がplainの場合のみ有効。省略可
指定できる値:
- normal:気にならない
- little:少し気になる
- never:利用しない
Default: normal (detailパラメータ指定時はdetailの値)

waitAverageTime
string

出発駅乗車待ち平均時間の利用。探索種別がplainの場合のみ有効。省略可
指定できる値:
- true:平均待ち時間を利用する
- false:待ち時間なし
Default: true (detailパラメータ指定時はdetailの値)

expressStartingStation
string

特急始発駅。探索種別がplainの場合にのみ有効。省略可
指定できる値:
- possible:なるべく利用
- normal:普通に利用
Default: normal (detailパラメータ指定時はdetailの値)

localBusOnly
string

路線バスのみ探索。探索種別がplainの場合にのみ有効。省略可
指定できる値:
- true:する
- false:しない
Default: false (detailパラメータ指定時はdetailの値)

transferTime
string

乗換え時間。探索種別がplainの場合は無効。省略可
指定できる値:
- normal:「駅すぱあと」の規定値
- moreMargin:規定値より少し余裕をみる
- mostMargin:規定値より余裕をみる
- lessMargin:規定値より短い時間にする
Default: normal (detailパラメータ指定時はdetailの値)

fuzzyLine
string

固定平均路線の名称リストにおける平均路線名あいまい指定。探索種別がplainの場合にのみ、fixedRailListパラメータに対して有効。
trueの場合は平均路線名に対する部分一致の指定となりますが、意図しない路線が選択される可能性があります。省略可
指定できる値:
- true:あいまいに行う（部分一致）
- false:厳格に行う（完全一致）
Default: false (detailパラメータ指定時はdetailの値)

entryPathBehavior
string

経路を加工する際に、経由駅を継承する。省略可
指定できる値:
- true:する
- false:しない
Default: false (detailパラメータ指定時はdetailの値)
詳しくはこちらを参照。

surchargeKind
string

料金種別希望初期値。省略可
新幹線や特急列車など、運賃の他に料金が必要な列車に対し適応されます。ただし運賃のみで利用可能な座席がある列車では適応されません (例: 湘南新宿ライン、快速マリンライナーなど)。
参考: 運賃と料金について
指定できる値:
- free:自由席
- reserved:指定席
- green:グリーン
Default: free (detailパラメータ指定時はdetailの値)

teikiKind
string

定期券種別初期値。省略可
指定できる値:
- bussiness:通勤
- university:通学 (大学)
- highSchool:通学 (高校)
- juniorHighSchool:通学 (中学)
Default: bussiness (detailパラメータ指定時はdetailの値)

JRSeasonalRate
string

ＪＲ季節料金。省略可
指定できる値:
- true:繁忙期・閑散期の季節料金を考慮する
- false:無視する
Default: true (detailパラメータ指定時はdetailの値)

JRReservation
string

ＪＲ予約サービス。studentDiscountと同時指定は不可。経路探索で回数券が指定された場合は、回数券が優先されます。省略可
指定できる値:
- none: 計算しない
＜エクスプレス予約＞
- exYoyaku: ＥＸ予約
- exETokkyu: ＥＸ予約(ｅ特急券)
- exHayatoku: ＥＸ予約(ＥＸ早特)
- exHayatoku21: ＥＸ予約(ＥＸ早特２１)
- exGreenHayatoku: ＥＸ予約(ＥＸグリーン早特)
＜スマートＥＸ＞
- smartEx: スマートＥＸ
- smartExHayatoku: スマートＥＸ(ＥＸ早特)
- smartExHayatoku21: スマートＥＸ(ＥＸ早特２１)
- smartExGreenHayatoku: スマートＥＸ(ＥＸグリーン早特)
Default: none

shinkansenETicket
string

新幹線eチケットサービス。studentDiscountと同時指定は不可。経路探索で回数券が指定された場合は、回数券が優先されます。省略可
指定できる値:
- none:計算しない
- eTicket:新幹線ｅチケット
Default: none (detailパラメータ指定時はdetailの値)

studentDiscount
string

学割乗車券。JRReservationと同時指定は不可。省略可
指定できる値:
- true:計算する
- false:計算しない
Default: false (detailパラメータ指定時はdetailの値)

ticketSystemType
string

乗車券計算のシステム。省略可
指定できる値:
- normal:普通乗車券のみ計算する
- ic:ICカード乗車券も計算する
Default: normal (detailパラメータ指定時はdetailの値)

preferredTicketOrder
string

優先する乗車券の順序。乗車券計算のシステムticketSystemType に ic を設定した場合のみ有効。省略可
指定できる値:
- none:指定なし
- normal:普通乗車券を優先する
- ic:ICカード乗車券を優先する
- cheap:安い乗車券を優先する
Default: none (detailパラメータ指定時はdetailの値)

preferredIcFareMode
string

IC運賃の計算に利用するICカードの優先モード。乗車券計算のシステムticketSystemType に ic を設定した場合のみ有効。省略可
指定できる値:
- cheapest:最も安いICカードの金額
- major:全国相互利用ICカード(Suica等)の金額
Default: cheapest (detailパラメータ指定時はdetailの値)
詳しくはこちらを参照。

nikukanteiki
string

二区間定期券の利用。省略可
指定できる値:
- true:利用する
- false:利用しない
Default: false (detailパラメータ指定時はdetailの値)

offpeakTeiki
string

オフピーク定期券として計算する。省略可
指定できる値:
- true:計算する
- false:計算しない
Default: false (detailパラメータ指定時はdetailの値)
※offpeakTeiki=trueを指定した場合、経路探索の結果に定期区間が「オフピーク定期区間かの状態判定」が追加され、オフピーク定期区間の場合は定期代がオフピーク定期券の金額となります。詳しくはオフピーク定期券の定期代を調べるをご確認ください。

Responses

Response Schema: application/json
object

レスポンスを表す要素

apiVersion
string

APIバージョン

engineVersion
string

エンジンバージョン

Condition
string

詳細探索条件を表す要素

Response Schema: application/json
object

レスポンスを表す要素

apiVersion
string

APIバージョン

engineVersion
string

エンジンバージョン

object

エラーを表す要素

Response samples

Content type
application/json
{
  • "ResultSet": {
    }
}

バージョン情報

バージョン情報

概要

mixway APIのバージョン情報を取得できます。
駅すぱあと APIの対応するAPI

query Parameters
key
required
string
Example: key=myAccessKey

アクセスキー

Responses

Response Schema: application/json
object

レスポンスを表す要素

apiVersion
string

APIバージョン

engineVersion
string

エンジンバージョン

object

著作権を表す要素

Array of objects

バージョンを表す要素

Response Schema: application/json
object

レスポンスを表す要素

apiVersion
string

APIバージョン

engineVersion
string

エンジンバージョン

object

エラーを表す要素

Response samples

Content type
application/json
{
  • "ResultSet": {
    }
}