混雑度予測駅ID検索

/congestion_prediction/node [GET]

基本情報

概要

駅IDと日付を指定して、経路検索数や直近の検索傾向を基にした1日分の混雑度を取得します。
（指定日の午前3時から指定日翌日の午前2時までを1日分とします）

/congestion_prediction/dateとの仕様比較についてはこちらのAPIの比較をご覧ください。

URL

https://{HOST}/{CID}/v1/congestion_prediction/node

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

出力形式

JSON

対応言語

ja

出力順

時刻昇順

パラメータ

パラメータ名	必須	概要	型名	デフォルト値	上下限/選択値	備考
id	✔	ノードID	文字列
date	✔	日付	文字列(日付) YYYY-MM-DD			過去の日付は指定できません

パラメータ構成例

表参道駅の2021年10月12日の混雑度を取得

/congestion_prediction/node?id=00007820&date=2021-10-12

レスポンス

名称	レスポンス名	型名	配列	Nullable	説明
混雑情報	items	CongestionInfoオブジェクト	〇

CongestionInfoオブジェクト

名称	レスポンス名	型名	配列	Nullable	説明
ノードID	id	文字列
混雑度予測の結果	congestions	Congestionオブジェクト	〇

Congestionオブジェクト

名称	レスポンス名	型名
日時	time	文字列
予測比率	prediction_rate	数値
検索数の比率	search_count_rate	数値

予測比率と検索数の比率について

・予測比率(prediction_rate)
1日のうち最も高い混雑度の値を1とした場合の予測比率（小数点第2位まで）を返却します
・検索数の比率(search_count_rate)
1日のうち最も高い混雑度の値を1とした場合の検索数の比率（小数点第2位まで）を返却します
現在時刻より未来の場合は全て0で返却します

レスポンス例

{
    "items": [
        {
            "id": "00007820",
            "congestions": [
                {
                    "time": "2021-10-12T03:00:00+09:00",
                    "prediction_rate": 0,
                    "search_count_rate": 0
                },
                {
                    "time": "2021-10-12T04:00:00+09:00",
                    "prediction_rate": 0,
                    "search_count_rate": 0
                },
                {
                    "time": "2021-10-12T05:00:00+09:00",
                    "prediction_rate": 0.15,
                    "search_count_rate": 0.16
                },
                {
                    "time": "2021-10-12T06:00:00+09:00",
                    "prediction_rate": 0.29,
                    "search_count_rate": 0.25
                },
                {
                    "time": "2021-10-12T07:00:00+09:00",
                    "prediction_rate": 0.65,
                    "search_count_rate": 0.53
                },
                ・・・・
                {
                    "time": "2021-10-12T02:00:00+09:00",
                    "prediction_rate": 0,
                    "search_count_rate": 0
                }
            ]
        }
    ]
}

エラー情報

エラーハンドリングについて

エラーメッセージは追加/変更/削除されることがあります。
エラーハンドリングされる場合はHTTPステータスコードをもとにご対応ください。
共通エラーについてはこちらをご参照ください。

HTTPステータス	エラーメッセージ	発生理由
405	This http method is invalid : POST (等)	許可されていないHTTPメソッドでアクセスされた場合に発生します。
400	parameter error: id: ['required field']	必須パラメータである id が指定されていない場合に発生します。
400	parameter error: id: ['empty values not allowed']	id に空文字を指定した場合に発生します。
400	parameter error: id: ['an invalid code: {value}']	id に不正なノードIDを指定した場合に発生します。
400	parameter error: date: ['required field']	必須パラメータである date が指定されていない場合に発生します。
400	parameter error: date: ['empty values not allowed']	date に空文字を指定した場合に発生します。
400	parameter error: date: ['an invalid date: {value}']	date に不正な書式の日付を指定した場合に発生します。
400	parameter error: date: ['not date format : {value}']	date に実在しない日付を指定した場合に発生します。
400	invalid date	date に過去の日付を指定した場合に発生します。