ジョルダン株式会社

乗換案内オープンAPI仕様書
1.目次
乗換案内オープンAPI仕様書
1.目次
2.本ドキュメントについて
3.改版履歴4.リクエスト要件
5.レスポンスデータ形式
6.文字コード
7.共通仕様共通リクエストパラメーター
共通レスポンスパラメーター
レスポンスサンプル
8.駅名検索 (sen)リクエストパラメーター
レスポンスパラメーター
レスポンスサンプル
9.路線名検索 (srn)
リクエストパラメーター
レスポンスパラメーター
レスポンスサンプル
10.駅の接続路線取得(ger)リクエストパラメーター
レスポンスパラメーター
レスポンスサンプル
11.路線の所属駅取得(gre)リクエストパラメーター
レスポンスパラメーター

レスポンスサンプル
12.経路検索(sr)リクエストパラメーター
レスポンスパラメーター
レスポンスサンプル
13.エラーコード一覧

2.本ドキュメントについて
本ドキュメントは、乗換案内オープンAPI仕様書です。

3.改版履歴日付

内容

2018/06/05

初版作成

2018/06/06

リクエスト要件の追記、文字コード項目の追加

2018/07/04

表記ミスの修正

4.リクエスト要件
サーバーへのリクエストは、POSTメソッドによって行われます。

5.レスポンスデータ形式
レスポンスデータのデータ形式は「JSON」となります。

6.文字コード
文字コードは、リクエスト・レスポンス共に「UTF-8」となります。

7.共通仕様本APIをご利用する場合には、個別に発行されるアクセスキーが必要になります。アクセスキーは入力パラメーター内でご指定ください。
※APIリクエストの際、パラメーターに日本語などのマルチバイト文字や記号等が含む場合、文字コード

にutf-8を用いた上でURLエンコードする必要があります。本仕様書におけるAPIリクエストの例では未エンコードの文字列を記載しています。

共通リクエストパラメーター
パラメーター名
称
ak

説明

値
文字

アクセスキー

列

指定した数値を結果のhead内にそのまま返却します。
rq

どのリクエストに対する結果かを判別する用途等でご使用ください。

共通レスポンスパラメーター
パラメーター名称

説明

NorikaeBizApiResult

結果自体

head

結果に関する内容

functionCode

呼び出した機能名(API)errorCode

エラーコードrq

入力パラメーターで指定された値を出力します

body

結果の内容を示します

レスポンスサンプル値

0:正常終了任意の数値
未指定時:0

文字
列

必
須
○

-

{
"NorikaeBizApiResult": {"head": {"functionCode": "srn","errorCode": "0","rq": "0"},"body": {//各APIの返答結果}}}

8.駅名検索 (sen)
入力をもとに駅の候補を返却します。候補が100件を超える場合、101件目以降は返却されません。
URI
http://example.co.jp/bizapi/sen
使用例
http://example.co.jp/bizapi/sen?ak=example&eki1=新宿

リクエストパラメーター
パラメーター名称

説明

値

必須

eki1

検索する文字列

任意の文字列

○

opt1

検索モード

レスポンスパラメーター

0:前方一致検索(デフォルト)
1:完全一致優先検索-

パラメーター名称

説明

値

num

結果の候補数0~

eki

候補の内容を示します

name

候補の名称

company

会社名称
R:鉄道
P:空港連絡バス

kubun

候補の区分

H:高速バス
F:フェリー
B:路線バス

レスポンスサンプル{"NorikaeBizApiResult": {"head": {"functionCode": "sen","errorCode": "0","rq": "0"},"body": {"num": "11","eki": [{"name": "新宿","company": "-",
"kubun": "R"},{"name": "新宿御苑前","company": "-",
"kubun": "R"},{"name": "新宿三丁目","company": "-",
"kubun": "R"},{"name": "新宿西口","company": "-",
"kubun": "R"},{"name": "新宿ワシントンホテル","company": "空港連絡バス","kubun": "P"},{"name": "新宿駅西口","company": "空港連絡バス","kubun": "P"},{"name": "バスタ新宿","company": "空港連絡バス","kubun": "P"},{"name": "バスタ新宿［車椅子用］","company": "空港連絡バス","kubun": "P"},{"name": "新宿・京王プラザホテル","company": "高速バス","kubun": "H"},{"name": "新宿駅西口","company": "高速バス","kubun": "H"},{"name": "バスタ新宿","company": "高速バス","kubun": "H"
}
]
}
}
}

9.路線名検索 (srn)
入力をもとに路線の候補を返却します。候補が100件を超える場合、101件以降は返却されません。
URI
http://example.co.jp/bizapi/srn

使用例
http://example.co.jp/bizapi/srn?ak=example&rsn=中央

リクエストパラメーター
パラメーター名称

説明

値

必須

rsn

検索する文字列

任意の文字列

○

opt1

検索モード

0:前方一致検索(デフォルト)
1:完全一致優先検索-

レスポンスパラメーター
パラメーター名称

説明

値

num

結果の候補数0~

rosen

候補の内容を示します

name

候補の名称

company

会社名称※無料版では「-(ハイフン)」のみが入ります
-:在来線
A:飛行機
B:バス
C:自動車
E:有料特急

kubun

候補の区分

F:船
K:路面電車L:ライナー
Q:有料急行列車
S:新幹線
W:徒歩

diagram

時刻表有無

レスポンスサンプル{"NorikaeBizApiResult": {"head": {0:時刻表データなし
1:時刻表データあり

"functionCode": "srn","errorCode": "0","rq": "0"},"body": {"num": "6","rosen": [{"name": "中央・総武線各停","company": "-",
"kubun": "-",
"diagram": "1"},{"name": "中央ライナー","company": "-",
"kubun": "L","diagram": "1"},{"name": "中央線","company": "-",
"kubun": "-",
"diagram": "1"},{"name": "中央本線（東海）","company": "-",
"kubun": "-",
"diagram": "1"},{"name": "中央本線（東日本）","company": "-",
"kubun": "-",
"diagram": "1"},{"name": "中央本線支線","company": "-",
"kubun": "-",
"diagram": "1"
}
]
}
}
}

10.駅の接続路線取得(ger)
指定した駅で利用可能な路線一覧を取得します。
URI
http://example.co.jp/bizapi/ger
使用例
http://example.co.jp/bizapi/ger?ak=example&eki1=東京

リクエストパラメーター
パラメーター名称

説明

値

必須

eki1

駅名

文字列

○

opt1

取得モード

0:通常モード(デフォルト)
1:同一駅扱いされている駅の情報を除外

レスポンスパラメーター
パラメーター名称

説明

値

num

結果の候補数0~

rosen

路線の内容を示します

name

路線の名称
-:在来線
A:飛行機
B:バス
C:自動車
E:有料特急列車

kubun

区分

F:船
K:路面電車L:ライナー
Q:有料急行列車
S:新幹線
W:徒歩

レスポンスサンプル-{"NorikaeBizApiResult": {"head": {"functionCode": "ger","errorCode": "0","rq": "0"},"body": {"num": "35","rosen": [{"name": "山手線","kubun": "-"},{"name": "京浜東北線","kubun": "-"},{"name": "中央線","kubun": "-"},{"name": "東海道本線（東日本）","kubun": "-"},{"name": "高崎線","kubun": "-"},{"name": "東北本線","kubun": "-"},{"name": "武蔵野線","kubun": "-"
},
(

中

略

)

{
"name": "ひたち・ときわ","kubun": "E"},{"name": "サンライズ出雲","kubun": "D"},{"name": "サンライズ瀬戸","kubun": "D"},{"name": "中央ライナー","kubun": "L"},{"name": "湘南ライナー","kubun": "L"},{"name": "ホームライナー千葉","kubun": "L"},{"name": "ムーンライトながら","kubun": "-"},{"name": "徒歩","kubun": "W"
}
]
}
}
}

11.路線の所属駅取得(gre)
指定した路線に属している駅一覧を取得します。
URI
http://example.co.jp/bizapi/gre
使用例
http://example.co.jp/bizapi/gre?ak=example&rsn=山手線

リクエストパラメーター
パラメーター名称

説明

値

必須

rsn

路線名

文字列

○

レスポンスパラメーター
パラメーター名称

説明

値

num

結果の駅数

0~

eki

駅の内容を示します

name

駅の名称
R:鉄道系
B:路線バス区分kubun

H:高速バス
P:リムジンバス
F:フェリー

レスポンスサンプル{"NorikaeBizApiResult": {"head": {"functionCode": "gre","errorCode": "0","rq": "0"},"body": {"num": "29","eki": [{"name": "池袋","kubun": "R"},{"name": "大塚（東京）","kubun": "R"},{"name": "巣鴨","kubun": "R"},{"name": "駒込","kubun": "R"
},
(

中

略

)

{
"name": "田端（東京）","kubun": "R"},{"name": "新宿","kubun": "R"},{"name": "新大久保","kubun": "R"},{"name": "高田馬場",
kubun: "R"},{"name": "目白","kubun": "R"
}
]
}
}
}

12.経路検索(sr)
入力値を元に経路を検索し、結果を返却します。同一駅を指定した場合、検索に失敗します。
※1...隣接している徒歩移動が可能な駅も同一駅扱いとなる場合があります。
※2...日付によっては経路が変わる場合があります。
URI
http://example.co.jp/bizapi/sr
使用例
http://example.co.jp/bizapi/sr?ak=example&eki1=東京&eki2=新宿

リクエストパラメーター

パラメーター名称

説明

値

必須

eki1

出発地(駅・バス停・港名など)を指定

文字列

○

eki2

目的地(駅・バス停・港名など)を指定

文字列

○

A:飛行機
F:フェリー
kbn1

出発地(駅・バス停など)の区分

H:高速バス
L:ライナー-

P:空港連絡パス
R:鉄道系
kbn2

目的地(駅・バス停など)の区分

同上

-

date

検索を行う年月日

yyyymmdd-

レスポンスパラメーター
パラメーター名称

説明

値

jrdurlジョルダン『乗換案内』へのリンク

storeData

経路保存文字列(結果の再計算に利用)

route

経路ごとの情報id

経路の通し番号hyouka

経路の概要

pathCnt

路線数

1〜

jikan

経路の所要時間

分単位

hiyou

経路の費用

icHiyou

経路の費用(IC)icExist

IC運賃有無

kyori

経路の距離

norikaeCnt

乗換回数

ICカード運賃がない場合は切符と同じ値
0:IC運賃なし
1:IC運賃あり
100m単位無効な場合は負値

status

経路の評価

hayai

最も所要時間が短いか

yasui

最も費用が安いか

raku

最も乗換回数が少ない

kuuro

結果に飛行機を含む

shindai

結果に寝台列車を含む

kousoku

結果に高速バスを含む

icCard0:最短ではない
1:最も短い
0:最安ではない
1:最も安い0:最小ではない
1:最も少ない
0:空路を含まない
1:空路を含む
0:寝台列車を含まない
1:寝台列車を含む
0:高速バスを含まない
1:高速バスを含む

ICカードを仕様した際に異なる運賃があ

0:ICカード運賃なし

るか

1:ICカード運賃あり

norikae

最も乗り換え時間が短い

co2

CO2排出量が最も少ない

syubetu

検索種別

value

statusの値一覧(「,」カンマ区切り)

kubun

経路の区分

shinkansen

結果に新幹線を含む

nozomi

結果に新幹線のぞみを含む

tokkyu

結果に有料特急列車を含む

shindai

結果に寝台列車を含む

0:最短ではない
1:最も短い0:最小ではない
1:最も少ない
0:通常の検索結果

0:含まない1:含む
0:含まない1:含む
0:含まない1:含む
0:含まない1:含む
0:含まないkuuro

結果に空路を含む

bus

結果に路線バスを含む

kousoku

結果に高速バスを含む

renraku

結果に連絡バスを含む

shinya

結果に深夜急行バスを含む

ferry

結果に航路を含む

toho

結果に徒歩を含む

yuryou

結果に有料普通列車を含む

jr

結果にJRを含む

value

kubunの値一覧(「,」カンマ区切り)

path

路線ごとの情報id

路線の通し番号

rosen

路線名

1:含む
0:含まない1:含む
0:含まない1:含む
0:含まない1:含む
0:含まない1:含む
0:含まない1:含む
0:含まない1:含む
0:含まない1:含む
0:含まない1:含む

0:JR在来線
1:私鉄在来線
2:地下鉄
3:路面電車
4:徒歩
5:バス
6:飛行機
rosenSyubetu

路線種別

7:船
8:有料特急列車
9:新幹線
10:寝台列車
11:有料急行列車

12:高速バス
13:自動車14:空港連絡バス
from

出発地

fromExt

出発地拡張情報

to

到着地

toExt

到着地拡張情報kyori

距離(100m単位)

jikan

所要時間(分単位)

norikae

乗換有無

mati

乗換待ち時間(分単位)idou

移動時間(分単位)

direction

進行方向

seatName

座席名称

seatCode

座席コード

seatKubun

変更可能な座席情報

num

変更可能な座席の数

kubun

変更可能な座席の区分

id

変更可能な座席の通し番号

code

変更可能な座席の座席コード

name

変更可能な座席の座席名称

airLine

航空会社名(空路の場合)

untin

金額(空路の場合)

untin

運賃

untinOufuku

往復割引の適用

運賃ID この値の同じ範囲が運賃の有効範

0:無し(直通など)
1:乗換あり0:片道運賃
1:往復割引の片道分運賃
0:金額なしuntinTuusan

囲となります1〜:運賃ID
84:定期精算区間

untinGakusei

学生割引有無(0固定)

tokkyu

特急料金等の追加料金

tokkyuGreen

特急料金内のグリーン席分の金額

tokkyuShindai

特急料金内の寝台分の金額

0:学生割引なし-1:無し
tokkyuKisetu

季節料金区分

0:通常期
1:繁忙期

tokkyuWaribiki

tokkyuTuusan

特急乗継割引有無

0:無し
1:乗継割引あり

特急料金ID この値の同じ範囲が特急料金0:金額なしの有効範囲となります

1〜:追加料金ID

icExist

IC運賃有無icUntin-

0:IC運賃なし
1:IC運賃あり
IC運賃がない場合、切符と同じ金
額
0:金額なしicUntinTuusan-

1〜:運賃ID
84:定期精算区間

icUntinGakusei-

icTokkyu-

icTokkyuGreen-

icTokkyuTuusan-

airLine

航空会社名

fromDate

発年月日

fromTime

発時刻

0:学生割引なし

0:金額なし1〜:追加料金ID-2:通過-1:非運行
0:確定時刻fromTimeType

時刻タイプ(発)1:推定時刻
2:仮時刻 ※1
※1...時刻表がない場合に平均所要時間を加算したもの)

toDate

着年月日

toTime着時刻-2:通過-1:非運行
0:確定時刻toTimeType

時刻タイプ(着)1:推定時刻
2:仮時刻 ※1
※1...時刻表がない場合に平均所要時間を加算したもの)

lineName

列車名

lineIndex

列車識別子

selectLine

列車番号 この値が同じ場合、同一列車となります

lineType

列車種別

lineColor

路線色

type

路線色種別

num

路線色の数

rgb

RGB値

haveDiagram

路線の時刻表有無

useDiagram

結果の時刻表適用

rosenCorp

路線の会社略称

busCorp

バス会社名

josyaText

乗車位置情報fromPlatform

発駅の番線

0:通常
1:横じま

16進数でRRGGBB
0:時刻表が存在しない
1:時刻表が存在
0:時刻表適用なし
1:時刻表適用toPlatform

着駅の番線

tokurei

特例情報

data

特例データ番号

num

特例の数

info

特例の内容を示します

code

特例コード

name

特例の名称

text

特例の説明文id

特例の通し番号

icTokuei

IC特例情報data

特例データ番号(IC)num

特例の数(IC)

info

特例の内容を示します(IC)code

特例コード(IC)name

特例の名称(IC)text

特例の説明文(IC)id

IC特例の通し番号

co2

CO2排出量(g単位)

fromX

発駅の緯度

hour,minute,sec,msec

fromY

発駅の経度

hour,minute,sec,msec

toX

着駅の緯度

hour,minute,sec,msec

toY

着駅の経度

hour,minute,sec,msec

レスポンスサンプル{"NorikaeBizApiResult":{"head":{"functionCode":"sr","errorCode":"0","rq":"0"},"body":{"jrdurl":"http://www.jorudan.co.jp/norikae/cgi/nori.cgi?eki1=%E6%9D%B1%E4%BA%AC&eki2=%E6%96%B0%E5%AE%BF&Dym=201805&Ddd=09&rf=o-api&Sok=1","num":"1","storeData":"!8d0-SU5GTwAAABABM+4dA#6-CA#7-TU9ZTwAAAtA#3bf-BNT1lPAAAC0AABA#3bc-E5PREUAAAAUAAIAAE4tAAwAAYakTi0AGQABhqRQVEUyAAAAqA#4-EAAQAAAAGGpQAAAAoAZwA
NA#8f-LQA#5-UgA#25-CwAAAEVOREQA#4-","route":[{"id":"1","hyouka":{"pathCnt":"1","jikan":"13","hiyou":"200","icExist":"1","icHiyou":"194","kyori":"103","norikaeCnt":"0","status":{"hayai":"1","yasui":"1","raku":"1","kuuro":"0","shindai":"0","kousoku":"0","icCard":"1","norikae":"1","co2":"1","syubetu":"0","value":"1,1,1,0,0,0,1,1,1,0,1"},"kubun":{"shinkansen":"0","nozomi":"0","tokkyu":"0","shindai":"0","kuuro":"0","bus":"0","kousoku":"0","renraku":"0","shinya":"0","ferry":"0","toho":"0","yuryou":"0","jr":"1","value":"0,0,0,0,0,0,0,0,0,0,0,0,1"},"path":[{"id":"1","rosen":"中央線","rosenSyubetu":"0","from":"東京","fromExt":"","to":"新宿","toExt":"","kyori":"103","jikan":"13","mati":"0","idou":"0","norikae":"0","direction":"0","seatName":"","seatCode":"","seatKubun":{"num":"0"},"untin":"200","untinOufuku":"0","untinTuusan":"1","untinGakusei":"0","tokkyu":"0","tokkyuGreen":"0","tokkyuShindai":"0","tokkyuKisetu":"-1","tokkyuWaribiki":"0","tokkyuTuusan":"0","icExist":"1","icUntin":"194","icUntinTuusan":"1","icUntinGakusei":"0","icTokkyu":"0","icTokkyuGreen":"0","icTokkyuTuusan":"0","airLine":"","fromDate":"00000000","fromTime":"","fromTimeType":"-1","toDate":"00000000","toTime":"","toTimeType":"-1","lineName":"","lineIndex":"-1","selectLine":"","lineType":"","lineColor":{"type":"0","num":"1","rgb":["ff5611"]},"haveDiagram":"1","useDiagram":"0","rosenCorp":"ＪＲ","busCorp":"","josyaText":"","fromPlatform":"","toPlatform":"","tokurei":{"data":"256","num":"1","info":[{"code":"U_PASMOBETU","name":"ＩＣカード別運賃","text":"券売機や窓口できっぷを購入した場合の運賃です。ICカードを使用した場合とは異なります。","id":"1"}]},"icTokurei":{"data":"512","num":"1","info":[{"code":"U_PASMO","name":"ＩＣカード運賃","text":"ICカードを使用した場合の運賃です。券売機で購入した場合とは異なります。","id":"1"}]},"co2":"206","fromX":"139,46,10,800","fromY":"35,40,41,200","toX":"139,42,13,400","toY":"35,41,12,900"
}

]
}
]
}
}
}

13.エラーコード一覧
各機能の結果として、以下のエラーコードが返却されます。
値

説明

0

成功

1

初期化失敗

2

設定ファイル読込失敗3

不正なリクエスト4

アクセスキー不一致

5

乗換案内サーバー接続失敗

6

乗換案内サーバー切断失敗

8

終了処理失敗9

API処理エラー

10

アクセス許可対象外

11

リクエスト数上限エラー

200

駅名検索 初期化エラー

201

駅名検索 処理条件設定失敗

202

駅名検索 検索失敗

300

駅名検索 初期化エラー

301

路線名検索 処理条件設定失敗

302

路線名検索 検索失敗400

駅取得 初期化エラー

401

駅取得 処理条件設定失敗

402

駅取得 処理失敗

500

路線取得 初期化エラー

501

路線取得 処理条件設定失敗

502

路線取得 処理失敗

2400

経路検索 初期化エラー

2401

経路検索 処理条件設定失敗

2402

経路検索 経路検索失敗

2403

経路検索 経路情報保存失敗

2404

経路検索 駅不足

2405

経路検索 日時指定エラー

2406

経路検索 経路検索失敗

3400

経路検索 初期化エラー

3401

経路検索 処理条件設定失敗

3402

経路検索 経路検索失敗

3403

経路検索 経路情報保存失敗

3404

経路検索 駅不足

3405

経路検索 日時指定エラー

3406

経路検索 経路検索失敗