運賃区分取得

/fare_table [GET]

基本情報

概要

ルート検索の結果に含まれる運賃の区分を取得します。

URL

https://{HOST}/{CID}/v1/fare_table

※APIマーケットの場合はURL体系が異なります

出力形式

JSON

対応言語

ja

運賃データの運用について

運賃には公共交通機関の運賃と、車経路で出現する高速道路の運賃の２種類があり、以下のルールで運用されています

種類	ID採番ルール	変更方針
公共交通機関	0 - 900 番台	変更・削除は無し追加の可能性は有り
高速道路	1000 番以降	不定期・かつ頻繁に更新、文言変更も有りキャッシュは非推奨です

オフピーク定期券について

オフピーク定期券の運賃に該当するものは下記となります。
・fare_160：時差定期券運賃（通勤1ヶ月）
・fare_162：時差定期券運賃（通勤3ヶ月）
・fare_165：時差定期券運賃（通勤6ヶ月）

過去の運賃区分について

過去に存在した運賃区分も含まれます。
料金改定により、現状出力されないものもあります。

パラメータ

なし

リクエスト例

/fare_table

レスポンス

名称	レスポンス名	型名	配列	説明
運賃情報	items	FareTableオブジェクト	〇

FareTableオブジェクト

名称	レスポンス名	型名	配列	説明
ID	id	数値
探索結果上で出力されるキー	key	文字列
区分の概要	caption	文字列
道路グループ（主に運用会社など）	road_group	RoadGroupオブジェクト
割引内容	discount	文字列
支払い条件（ETC・現金など）	payment	文字列
対象車種	vehicle_type	文字列	〇	対象車種を表す文字列として以下が出力されます。・moped : 原付二輪・motorcycle : 自動二輪・small : 軽自動車等・standard : 普通車・medium : 中型車・large : 大型車・extra_large : 特大車
対象日	apply_days	文字列	〇	対象日を表す文字列として以下が出力されます。・sunday : 日曜・monday : 月曜・tuesday : 火曜・wednesday : 水曜・thursday : 木曜・friday : 金曜・saturday : 土曜・holiday : 祝日
対象時間	apply_times	文字列	〇
備考	note	文字列

RoadGroupオブジェクト

名称	レスポンス名	型名	配列	説明
名称	name	文字列		"NEXCO"など

レスポンス例

{
    "items": [
        {
            "id": 0,
            "key": "fare_0",
            "caption": "普通運賃"
        },
        {
            "id": 1,
            "key": "fare_1",
            "caption": "自由席料金"
        },
        {
            "id": 2,
            "key": "fare_2",
            "caption": "指定席料金"
        },
        {
            "id": 3,
            "key": "fare_3",
            "caption": "グリーン料金"
        },
        …
        {
            "id": 1024,
            "key": "fare_1024",
            "caption": "通常料金",
            "road_group": {
                "name": "全共通"
            },
            "vehicle_type": [
                "small",
                "standard",
                "medium",
                "large",
                "extra_large"
            ],
            "apply_days": [
                "sunday",
                "monday",
                "tuesday",
                "wednesday",
                "thursday",
                "friday",
                "saturday",
                "holiday"
            ],
            "apply_times": [
                "終日"
            ]
        },
        …
    ]
}

取得できる料金

下記の料金を取得できます。
・普通運賃
・各種特急料金
・寝台料金
・IC運賃
・各種定期券料金
・高速料金(現金)
・高速料金(ETC)
　- 各種割引に対応

'id' と 'key' のどちらで管理して頂いても構いません。

ルート検索結果上での出力について

ルート検索結果には Fare オブジェクトとして運賃が出力されます。
オブジェクト上のプロパティでは 'unit_{運賃区分ID}' と出力されます。

"fare": {
    "unit_0": 950, // 普通運賃 950 円
    "unit_138": 38080, // 通学3ヶ月(共通or大学) 38,080 円
    "unit_133": 136080, // 通勤6ヶ月 136,080 円
    ...
}

また、高速料金は車種ごとに以下のように細分化されています。

車種ID	説明
0	未定義
1	軽自動車
2	普通自動車
3	中型車
4	大型車
5	特大車
99	原付二輪
100	自動二輪

Fare オブジェクト上では 'unit_{運賃区分ID}_{車種ID}' と出力されます。

"fare:" {
    "unit_1024_1": 1300, // 現金車の料金（軽自動車） 1,300 円
    "unit_1024_2": 1400, // 現金車の料金（普通自動車） 1,400 円
    "unit_1024_3": 1450, // 現金車の料金（中型車） 1,450 円
    "unit_1024_4": 2500, // 現金車の料金（大型車） 2,500 円
    "unit_1024_5": 2900　// 現金車の料金（特大車） 2,900 円
}