混雑度予測期間検索
/congestion_prediction/date [GET]
基本情報
概要
期間やノードIDなどの条件を指定して、経路検索数を基にしたノードの混雑度予測情報を返却します。
/congestion_prediction/nodeとの仕様比較についてはこちらのAPIの比較をご覧ください。
URL
https://{HOST}/{CID}/v1/congestion_prediction/date
※APIマーケットの場合はURL体系が異なります
出力形式
- JSON
対応言語
- ja
パラメータ
| パラメータ名 | 必須 | 概要 | 型名 | デフォルト値 | 上下限/選択値 | 備考 |
|---|---|---|---|---|---|---|
| start_date | ✔ | 予測期間の開始日時 | 文字列 | ・過去の日付は指定できません 日時の指定例 2021-09-26T08:00:00 |
||
| end_date | ✔ | 予測期間の終了日時 | 文字列 | 指定可能な範囲は予測期間の開始日時から1週間未満です | ・過去の日付は指定できません 日時の指定例 2021-09-26T08:00:00 |
|
| id | (✔) | ノードID | 文字列 | ・ratioに2.0未満の値を指定する場合は指定が必須です ・ピリオド区切りで複数指定可能です |
||
| ratio | 混雑比率 | 数値(小数) | 2.0 | 最小値：0 最大値：2.0 |
・指定値以上の混雑比率に絞り込みます ・2.0未満を指定する場合はidの指定が必須です |
|
| direction | 発着 | 文字列 | start：出発 goal：到着 |
|||
| search_count | 検索数 | 数値 | 最小値：0 最大値：5000 |
指定値以上の検索数に絞り込みます |
||
| median | 基準値 | 数値 | 最小値：0 最大値：5000 |
・指定値以上の基準値に絞り込みます ・過去2週間分の検索数の中央値を基準値としています |
||
| datum | 緯度経度の測地系 | 文字列 | wgs84 | wgs84：世界測地系 tokyo：旧日本測地系 |
||
| coord_unit | 出力データに含まれる緯度経度の単位 | 文字列 | degree | degree：度表記の10進法 millisec：ミリ秒表記 |
パラメータ構成例
- 2021年12月16日の到着地で混雑比率が2.0以上の混雑度予測情報を取得
/congestion_prediction/date?start_date=2021-12-16T00:00:00&end_date=2021-12-16T23:59:59&direction=goal&ratio=2.0
レスポンス
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 混雑情報 | items | CongestionInfoオブジェクト | 〇 | 検索結果の一覧 | |
| 単位情報 | unit | Unitオブジェクト |
CongestionInfoオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 駅のノードID | id | 文字列 | |||
| 駅の名称 | name | 文字列 | |||
| 駅の名称の読み仮名 | ruby | 文字列 | nullable | ||
| 住所コード | address_code | 文字列 | |||
| 住所の表示名 | address_name | 文字列 | |||
| 駅の緯度軽度 | coord | Coordinateオブジェクト | |||
| 混雑情報 | congestions | CongestionPreditionオブジェクト | 〇 |
Coordinateオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 緯度 | lat | 数値 | |||
| 経度 | lon | 数値 |
CongestionPreditionオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 日時 | time | 文字列 | |||
| 発着 | direction | 文字列 | |||
| 検索回数 | search_count | 数値 | |||
| 基準値 | median | 数値 | 過去2週間分の検索数の中央値 | ||
| 比率 | ratio | 数値 |
Unitオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | Nullable | 説明 |
|---|---|---|---|---|---|
| 測地系 | datum | 文字列 | nullable | ||
| 緯度経度の出力形式 | coord_unit | 文字列 | nullable | ||
| 所要時間の単位 | time | 文字列 | nullable |
レスポンス例
{
"items": [
{
"id": "00001699",
"name": "魚住",
"ruby": "うおずみ",
"address_name": "兵庫県明石市魚住町中尾",
"address_code": "28203009000",
"coord": {
"lat": 34.696396,
"lon": 134.906167
},
"congestions": [
{
"time": "2021-12-16T00:00:00+09:00",
"direction": "goal",
"search_count": 26,
"median": 13.0,
"ratio": 2.0
}
]
},
{
"id": "00000108",
"name": "ひばりヶ丘(東京都)",
"ruby": "ひばりがおか",
"address_name": "東京都西東京市住吉町",
"address_code": "13229008000",
"coord": {
"lat": 35.751447,
"lon": 139.545837
},
"congestions": [
{
"time": "2021-12-16T01:00:00+09:00",
"direction": "goal",
"search_count": 44,
"median": 18.0,
"ratio": 2.4
}
]
},
{
"id": "00005040",
"name": "石神井公園",
"ruby": "しゃくじいこうえん",
"address_name": "東京都練馬区石神井町",
"address_code": "13120015000",
"coord": {
"lat": 35.743726,
"lon": 139.606374
},
"congestions": [
{
"time": "2021-12-16T01:00:00+09:00",
"direction": "goal",
"search_count": 45,
"median": 2.0,
"ratio": 22.5
}
]
},
{
"id": "00008159",
"name": "保谷",
"ruby": "ほうや",
"address_name": "東京都西東京市東町",
"address_code": "13229012000",
"coord": {
"lat": 35.748059,
"lon": 139.567946
},
"congestions": [
{
"time": "2021-12-16T01:00:00+09:00",
"direction": "goal",
"search_count": 52,
"median": 1.0,
"ratio": 52.0
}
]
},
{
"id": "00002484",
"name": "航空公園",
"ruby": "こうくうこうえん",
"address_name": "埼玉県所沢市並木",
"address_code": "11208039000",
"coord": {
"lat": 35.798412,
"lon": 139.465565
},
"congestions": [
{
"time": "2021-12-16T06:00:00+09:00",
"direction": "goal",
"search_count": 27,
"median": 11.0,
"ratio": 2.5
}
]
},
{
・・・・・
}
],
"unit": {
"datum": "wgs84",
"coord_unit": "degree",
"time": "minute"
}
}
エラー情報
エラーハンドリングについて
エラーメッセージは追加/変更/削除されることがあります。
エラーハンドリングされる場合はHTTPステータスコードをもとにご対応ください。
共通エラーについてはこちらをご参照ください。
| HTTPステータス | エラーメッセージ | 発生理由 |
|---|---|---|
| 405 | This http method is invalid : POST (等) | 許可されていないHTTPメソッドでアクセスされた場合に発生します。 |
| 400 | parameter error: start_date: ['required field'] | 必須パラメータである start_date が指定されていない、または空文字の場合に発生します。 |
| 400 | parameter error: end_date: ['required field'] | 必須パラメータである end_date が指定されていない、または空文字の場合に発生します。 |
| 400 | parameter error: start_date: ['an invalid datetime: {value}'] | start_date に不正な書式の日時を指定した場合に発生します。 |
| 400 | parameter error: end_date: ['an invalid datetime: {value}'] | end_date に不正な書式の日時を指定した場合に発生します。 |
| 400 | parameter error: start_date: ['not datetime format : {value}'] | start_date に実在しない日時を指定した場合に発生します。 |
| 400 | parameter error: end_date: ['not datetime format : {value}'] | end_date に実在しない日時を指定した場合に発生します。 |
| 400 | parameter error: id: ['an invalid code: {value}'] | id にピリオド区切りで不正なノードIDを指定した場合に発生します。 |
| 400 | parameter error: ratio: ["field 'ratio' cannot be coerced: could not convert string to float: '{value}'"] | ratio に数値以外の値を指定した場合に発生します。 |
| 400 | parameter error: ratio: ['min value is 0'] | ratio に 0 未満の値を指定した場合に発生します。 |
| 400 | parameter error: ratio: ['max value is 2.0'] | ratio に 2.0 を超える値を指定した場合に発生します。 |
| 400 | parameter error: search_count: ["field 'search_count' cannot be coerced: invalid literal for int() with base 10: '{value}'"] | search_count に不正な値を指定した場合に発生します。 |
| 400 | parameter error: search_count: ['min value is 0'] | search_count に 0 未満の値を指定した場合に発生します。 |
| 400 | parameter error: search_count: ['max value is 5000'] | search_count に 5000 を超える値を指定した場合に発生します。 |
| 400 | parameter error: median: ["field 'median' cannot be coerced: invalid literal for int() with base 10: '{value}'"] | median に整数以外の値を指定した場合に発生します。 |
| 400 | parameter error: median: ['min value is 0'] | median に 0 未満の値を指定した場合に発生します。 |
| 400 | parameter error: median: ['max value is 5000'] | median に 5000 を超える値を指定した場合に発生します。 |
| 400 | parameter error: direction: ['unallowed value {value}'] | direction に start, goal 以外の不正な値を指定した場合に発生します。 |
| 400 | parameter error: datum: ['unallowed value {value}'] | datum に wgs84, tokyo 以外の不正な値を指定した場合に発生します。 |
| 400 | parameter error: coord_unit: ['unallowed value {value}'] | coord_unit に degree, millisec 以外の不正な値を指定した場合に発生します。 |
| 400 | When ratio is under 2.0, id is required. | ratio に 2.0 未満の値を指定したにもかかわらず、id を指定していない場合に発生します。 |
| 400 | invalid start_date | start_date に過去の日付を指定した場合に発生します。 |
| 400 | invalid end_date | end_date に過去の日付を指定した場合に発生します。 |
| 400 | invalid datetime term | end_date に start_date より前の日時を指定した場合に発生します。 |
| 400 | Datetime term must be less than a week. | start_date と end_date の期間が1週間以上になる場合に発生します。 |