運賃比較

/fare_comparison [GET]

基本情報

概要

定期券を購入した場合と、出社日分を都度購入した場合の運賃を比較します。

 

比較対象となる定期券は通勤定期券の運賃となります。

URL

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

※RapidAPIの場合はURL体系が異なります

出力形式

  • json

対応言語

  • ja

パラメータ

  • 「ルート検索(トータルナビ) /route_transit」と同等のパラメータを受け付けます
  • 本API独自のパラメータは以下の通りです
パラメータ名 必須 概要 型名 デフォルト値 上下限/選択値 備考
days 1ヶ月の通勤日数(単位:日) 数値 最小値:1
最大値:31
1ヶ月に通勤する日数を指定
payment 運賃の支払い方法 文字列 ic ic:IC支払い
ticket:切符支払い
運賃の支払い方法を指定

パラメータ指定時の注意点について

ルート全体に通勤定期券運賃が存在しない場合はエラーとなります
【例】下記2つの移動区間があるルートの場合
移動区間1 : 1ヶ月通勤定期券運賃と3ヶ月通勤定期券運賃が存在
移動区間2 : 通勤定期券運賃が存在しない
この場合、移動区間2の通勤定期券運賃が存在しないことから、ルート全体の通勤定期券が存在しないためエラーとなります。

パラメータ構成例

  • 出発地:新宿駅、目的地:表参道駅のルートの運賃を、1ヶ月の通勤日数:15日、支払い方法:IC支払いで運賃比較
/fare_comparison?start=00004254&goal=00007820&days=15&payment=ic&start_time=2020-06-20T09:00:00
  • 出発地:ナビタイムジャパン、目的地:東京スカイツリーのルートの運賃を、1ヶ月の通勤日数:20日、支払い方法:切符支払いで運賃比較
/fare_comparison?start={"lat":"35.667399","lon":"139.714888","name":"ナビタイムジャパン"}&goal={"lat":"35.71006","lon":"139.810689","name":"東京スカイツリー"}&days=20&payment=ticket&start_time=2021-05-01T10:00:00

レスポンス

名称 レスポンス名 型名 配列 説明
パラメータ情報 params_info ParamsInfoオブジェクト
運賃比較情報 items FareComparisonオブジェクト 運賃比較情報のまとまり

ParamsInfoオブジェクト

名称 レスポンス名 型名 配列 説明
1ヶ月の通勤日数 days 数値
支払い方法 payment 文字列 ic:IC支払い
ticket:切符支払い

FareComparisonオブジェクト

名称 レスポンス名 型名 配列 説明
運賃の概要 summary FareSummaryオブジェクト
各路線の運賃情報 sections FareSectionsオブジェクト

FareSummaryオブジェクト

名称 レスポンス名 型名 配列 説明
1ヶ月の運賃 1_month FareMoveオブジェクト 1ヶ月通勤定期のデータが存在する場合のみ出力
3ヶ月の運賃 3_months FareMoveオブジェクト 3ヶ月通勤定期のデータが存在する場合のみ出力
6ヶ月の運賃 6_months FareMoveオブジェクト 6ヶ月通勤定期のデータが存在する場合のみ出力

FareMoveオブジェクト

名称 レスポンス名 型名 配列 説明
列車の運賃 train Fareオブジェクト 列車の運賃が存在する場合のみ出力
バスの運賃 bus Fareオブジェクト バスの運賃が存在する場合のみ出力

Fareオブジェクト

名称 レスポンス名 型名 配列 説明
都度購入運賃 every_time_pay 数値
定期券運賃 commuter_pass 数値

FareSectionsオブジェクト

名称 レスポンス名 型名 配列 説明
出発駅と到着駅情報 node Nodeオブジェクト
路線名 line_name 文字列
1ヶ月の運賃 1_month FareMoveオブジェクト 1ヶ月通勤定期のデータが存在する場合のみ出力
3ヶ月の運賃 3_months FareMoveオブジェクト 3ヶ月通勤定期のデータが存在する場合のみ出力
6ヶ月の運賃 6_months FareMoveオブジェクト 6ヶ月通勤定期のデータが存在する場合のみ出力

Nodeオブジェクト

名称 レスポンス名 型名 配列 説明
出発駅名称 from_node 文字列
到着駅名称 to_node 文字列

レスポンス例

{
    "params_info": {
        "days": "15",
        "payment": "ic"
    },
    "items": [
        {
            "summary": {
                "1_month": {
                    "train": {
                        "every_time_pay": 9120.0,
                        "commuter_pass": 10210.0
                    }
                },
                "3_months": {
                    "train": {
                        "every_time_pay": 27360.0,
                        "commuter_pass": 29120.0
                    }
                },
                "6_months": {
                    "train": {
                        "every_time_pay": 54720.0,
                        "commuter_pass": 52790.0
                    }
                }
            },
            "sections": [
                {
                    "line_name": "JR山手線",
                    "node": {
                        "from_node": "新宿",
                        "to_node": "原宿"
                    },
                    "1_month": {
                        "every_time_pay": 4080.0,
                        "commuter_pass": 3950.0
                    },
                    "3_months": {
                        "every_time_pay": 12240.0,
                        "commuter_pass": 11270.0
                    },
                    "6_months": {
                        "every_time_pay": 24480.0,
                        "commuter_pass": 18980.0
                    }
                },
                {
                    "line_name": "東京メトロ千代田線",
                    "node": {
                        "from_node": "明治神宮前",
                        "to_node": "表参道"
                    },
                    "1_month": {
                        "every_time_pay": 5040.0,
                        "commuter_pass": 6260.0
                    },
                    "3_months": {
                        "every_time_pay": 15120.0,
                        "commuter_pass": 17850.0
                    },
                    "6_months": {
                        "every_time_pay": 30240.0,
                        "commuter_pass": 33810.0
                    }
                }
            ]
        },
        {
            ・・・
        }
    ]
}