駐車場検索
/parking [GET]
基本情報
概要
住所コードや緯度経度を指定して条件に合致する駐車場を検索します。
※当APIをご利用の場合は、専用データ利用のオプション契約が別途必要となります
禁止事項
本APIで取得した駐車場データについて、データ提供元により許諾されていないため、
駐車場料金の安い順で表示することはお控えください。
URL
https://{HOST}/{CID}/v1/parking
※APIマーケットでは提供しておりません
出力形式
- JSON
対応言語
- ja, en, ko, zh-CN, zh-TW, th
出力順
- スポットコードの昇順
- 緯度経度を指定した場合は指定緯度経度からの距離昇順
パラメータ
| パラメータ名 | 必須 | 概要 | 型名 | デフォルト値 | 上下限/選択値 | 備考 |
|---|---|---|---|---|---|---|
| address | (✔) | 住所コード | 文字列 | 大字レベル（11桁末尾0）まで指定可能 addressもしくはcoordのどちらか一方もしくは両方を必ず指定してください |
||
| coord | (✔) | 検索基点 | カンマ区切りの数値 | 検索を行う基準地点の緯度経度 ・「緯度,経度」の順で指定 ・ミリ秒表記、度表記(10進数)に対応 addressもしくはcoordのどちらか一方もしくは両方を必ず指定してください |
||
| radius | 検索範囲(単位：m) | 数値 | 2000 | 最大値：5000 | coord指定時のみ使用可能 | |
| car_height | 車高(単位：cm) | 数値 | 指定値以上の車高を持つ駐車場のみ出力します | |||
| car_width | 車幅(単位：cm) | 数値 | 指定値以上の車幅を持つ駐車場のみ出力します | |||
| car_length | 車長(単位：cm) | 数値 | 指定値以上の車長を持つ駐車場のみ出力します | |||
| car_weight | 車重(単位：kg) | 数値 | 指定値以上の車重を持つ駐車場のみ出力します | |||
| options | 追加出力情報 | 文字列 | exact_coord：スポット到着地点 detail：詳細情報 opening_hours：営業時間情報 |
追加で出力する情報 ・ピリオド区切りで複数指定可能 ※exact_coordはD2Dオプション申込時のみ利用可能 |
||
| limit | データの出力件数 | 数値 | 10 | 最小値：1 最大値：30 |
駐車場データの出力数 | |
| offset | データの出力開始位置 | 数値 | 0 | 最小値：0 最大値：2000 |
何件目から表示されるか(1件目が0)を指定します | |
| datum | 緯度経度の測地系 | 文字列 | wgs84 | wgs84：世界測地系 tokyo：旧日本測地系 |
||
| coord_unit | 出力データに含まれる緯度経度の単位 | 文字列 | degree | degree：度表記の10進法 millisec：ミリ秒表記 |
||
| lang | 言語 | 文字列 | ja: 日本語 en: 英語 ko: 韓国語 zh-CN: 中国語(簡体字) zh-TW: 中国語(繁体字) th: タイ語 |
出力する言語を指定します ・ピリオド区切りで複数指定可能 ※多言語オプション申込時のみ利用可能 |
radiusの検索範囲について
radiusパラメータにて検索範囲を指定した場合、coordを中心とした四角範囲内で検索が行われます。
そのため、一部指定範囲外の駐車場が出力される可能性があります。
addressとcoordを両方指定した場合の挙動について
addressとcoordを両方指定した場合の検索方法はAND検索となります。
そのため、coordにて指定した検索範囲内かつaddressにて指定した住所コードに該当する駐車場が検索されます。
パラメータ構成例
- 都内の駐車場を5件検索
/parking?address=13&limit=5
- 都内で軽自動車（車高：200cm、車幅：148cm、車長：340cm、車重：800kg）を停められる駐車場を詳細情報を出力して検索
/parking?address=13&car_height=200&car_width=148&car_length=340&car_weight=800&options=detail
レスポンス
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 検索数 | count | Countオブジェクト | レスポンスのヒット数などの情報 | |
| スポット情報 | items | Spotオブジェクト | 〇 | スポット情報（駐車場）のまとまり |
| 単位情報 | unit | Unitオブジェクト | 出力される単位の情報 |
Countオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| トータルヒット件数 | total | 数値 | 検索ヒットした件数 | |
| オフセット値 | offset | 数値 | オフセットが設定されている場合はその値を出力 | |
| データの出力件数 | limit | 数値 | データの出力件数に設定されている値 1件しかヒットしなかった場合でも、limit=10でリクエストしている場合は10と出力 |
Spotオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| スポットコード | code | 文字列 | ||
| スポット名 | name | 文字列/Multilingualオブジェクト | langパラメータ指定時は、Multilingualオブジェクトで出力 | |
| スポット名の読み仮名 | ruby | 文字列/Multilingualオブジェクト | langパラメータ指定時は、Multilingualオブジェクトで出力 ただし"ja"を含む場合のみ(日本語のみ) |
|
| 電話番号 | phone | 文字列 | ||
| 住所コード | address_code | 文字列 | ||
| 住所の表示名 | address_name | 文字列/Multilingualオブジェクト | langパラメータ指定時は、Multilingualオブジェクトで出力 | |
| 緯度経度 | coord | Coordinateオブジェクト | ||
| 距離(単位：m) | distance | 数値 | 検索基点からの距離 パラメータ「coord」指定時のみ出力 |
|
| 郵便番号 | postal_code | 文字列 | ||
| カテゴリ一覧 | categories | Categoryオブジェクト | 〇 | |
| 詳細情報 | details | SpotDetailオブジェクト | 〇 | パラメータ「options=detail」指定時かつデータが存在する場合のみ出力 出力優先度を考慮してソートされています |
| スポット到着地点の緯度経度 | exact_coord | SpotExactCoordオブジェクト | パラメータ「options=exact_coord」指定時かつデータが存在する場合のみ出力 | |
| 営業時間情報 | opening_hours | SpotOpeningHoursオブジェクト | パラメータ「options=opening_hours」指定時かつデータが存在する場合のみ出力 |
Multilingualオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 英語名称 | en | 文字列 | ||
| 日本語名称 | ja | 文字列 | ||
| 韓国語名称 | ko | 文字列 | ||
| タイ語名称 | th | 文字列 | ||
| 中国語(簡体字)名称 | zh-CN | 文字列 | ||
| 中国語(繁体字)名称 | zh-TW | 文字列 |
Coordinateオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| スポットの緯度 | lat | 数値 | ||
| スポットの経度 | lon | 数値 |
Categoryオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| カテゴリコード | code | 文字列 | ||
| カテゴリ名 | name | 文字列/Multilingualオブジェクト | langパラメータ指定時は、Multilingualオブジェクトで出力 | |
| カテゴリ名の読み仮名 | ruby | 文字列/Multilingualオブジェクト | langパラメータ指定時は、Multilingualオブジェクトで出力 ただし"ja"を含む場合のみ返却(日本語のみ) |
|
| カテゴリコードのレベル | level | 文字列 | large, middle, small, detail の４階層 |
SpotDetailオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| テキスト情報 | texts | TextItemオブジェクト | 〇 | データが存在する場合のみ出力 |
| 駐車場の満空情報 | parking_status | ParkingStatusオブジェクト | データが存在する場合のみ出力 | |
| 駐車場の静的な情報 | parking | Parkingオブジェクト | データが存在する場合のみ出力 |
TextItemオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 見出し | label | 文字列 | langパラメータ指定時は、1番目にjaを指定した場合のみ返却(日本語のみ) | |
| 文字列値 | value | 文字列 | langパラメータ指定時は、1番目にjaを指定した場合のみ返却(日本語のみ) |
ParkingStatusオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| ステータスコード | code | 文字列 | 下記のうちいずれかの数字が格納されます 0 - 空 1 - 混雑 2 - 満車 3 - 閉鎖 7 - 不明 「不明」はセンサーの障害やお祭りなどで利用できない状態を表します |
|
| 状態を表す文字列 | text | 文字列 | ステータスコードによって出力される文字列が異なります 0 - 空 1 - 混雑 2 - 満車 3 - 閉鎖 7 - 不明 「不明」はセンサーの障害やお祭りなどで利用できない状態を表します |
|
| データ更新時刻 | update_time | 文字列 |
Parkingオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 車両に関する制限 | car_regulation | ParkingCarRegulationオブジェクト | ||
| 駐車可能台数 | capacity | 数値 | ||
| 駐車場の形式 | building_type | 文字列 | 〇 | flat：平地 solid：立体 underground：地下 machine：機械式 |
| 料金支払い方法 | payment_method | 文字列 | 〇 | bill：紙幣 credit：クレジットカード e_money：電子マネー |
| 領収書の有無 | receipt | 真偽値 | 領収書がある場合のみtrueが出力されます |
ParkingCarRegulationオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 最大車高(cm) | height | 数値 | ||
| 最大車幅(cm) | width | 数値 | ||
| 最大車長(cm) | length | 数値 | ||
| 最大車重(kg) | weight | 数値 | ||
| 車種制限 | car_type | 文字列 | 〇 | 3number：3ナンバー制限 5number：5ナンバー制限 imported：外車制限 rv：RV制限 1box：1ボックス制限 |
SpotExactCoordオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 車向け到着地点緯度経度 | car | SpotExactCoordPointオブジェクト | 〇 | データに入っている場合のみ出力 |
| 徒歩向け到着地点緯度経度 | walk | SpotExactCoordPointオブジェクト | 〇 | データに入っている場合のみ出力 |
SpotExactCoordPointオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 地点名称 | name | 文字列/Multilingualオブジェクト | langパラメータ指定時は、Multilingualオブジェクトで出力 | |
| 緯度経度 | coord | Coordinateオブジェクト | ||
| 識別番号 | seq | 数値 | ・地点名称が同一の場合があり、その識別用 |
識別番号について
識別番号は、1つの到着地点緯度経度に対し任意の番号を割り当てております。
同じ緯度経度でこの番号が変わることはございません。また、同じスポット内で番号が重複することもございません。
今後、到着地点緯度経度の地点名称の変更や、到着地点緯度経度が追加・削除となる場合もございますので、差分確認などにご利用ください。
SpotOpeningHoursオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 指定した時間の営業フラグ | open | 真偽値 | true：現在時刻が営業時間内の場合 false： 現在時刻が営業時間外の場合 |
|
| 24時間営業であることを示すフラグ | open24h | 真偽値 | 24時間営業であればtrue | |
| 営業時間情報一覧 | schedule | SpotOpeningHoursScheduleオブジェクト | ○ |
SpotOpeningHoursScheduleオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 曜日ID | day_id | 文字列 | 01：月曜日 02：火曜日 03：水曜日 04：木曜日 05：金曜日 06：土曜日 07：日曜日 11：祝日 |
|
| 休業日フラグ | close | 真偽値 | 休業日であればtrue 休業日が不明の場合は表示されません |
|
| 指定した日時に該当する曜日を示すフラグ | applied | 真偽値 | 現在日時に該当する曜日のオブジェクトだった場合にtrueが出力されます 該当する曜日以外の場合は表示されません |
|
| 営業時間 | periods | SpotOpeningHoursPeriodオブジェクト | ○ |
SpotOpeningHoursPeriodオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 営業開始時間 | open_time | 文字列 | ||
| 営業終了時間 | close_time | 文字列 |
Unitオブジェクト
| 名称 | レスポンス名 | 型名 | 配列 | 説明 |
|---|---|---|---|---|
| 緯度経度の測地系 | datum | 文字列 | ||
| 緯度経度の出力形式 | coord_unit | 文字列 |
レスポンス例
{
"count": {
"total": 29,
"offset": 0,
"limit": 10
},
"items": [
{
"code": "60023-000013",
"name": "パラカ 入谷第1",
"ruby": "ぱらかいりやだい1",
"address_name": "東京都台東区入谷2-37-11",
"address_code": "13106006000",
"coord": {
"lat": 35.722219,
"lon": 139.788475
},
"postal_code": "1100013",
"categories": [
{
"code": "0805001001",
"name": "駐車場",
"ruby": "ちゅうしゃじょう",
"level": "detail"
},
{
"code": "0805001",
"name": "駐車場",
"ruby": "ちゅうしゃじょう",
"level": "small"
},
{
"code": "0805",
"name": "駐車場",
"ruby": "ちゅうしゃじょう",
"level": "middle"
},
{
"code": "08",
"name": "交通",
"ruby": "こうつう",
"level": "large"
}
]
},
・・・
],
"unit": {
"datum": "wgs84",
"coord_unit": "degree"
}
}
レスポンス例(多言語返却時 ※lang=ja.en.ko指定)
{
"count": {
"total": 29,
"offset": 0,
"limit": 10
},
"items": [
{
"code": "60023-000013",
"name": {
"en": "Paraca Iriya Dai 1",
"ja": "パラカ 入谷第1",
"ko": "빠라카 이리야 다이 1"
},
"ruby": {
"ja": "ぱらかいりやだい1"
},
"address_name": {
"en": "Tokyo Taito-ku Iriya 2-37-11",
"ja": "東京都台東区入谷2-37-11",
"ko": "도쿄도 타이토구 이리야 2-37-11"
},
"address_code": "13106006000",
"coord": {
"lat": 35.722219,
"lon": 139.788475
},
"postal_code": "1100013",
"categories": [
{
"code": "0805001001",
"name": {
"en": "Parking Lot",
"ja": "駐車場",
"ko": "주차장"
},
"ruby": {
"ja": "ちゅうしゃじょう"
},
"level": "detail"
},
{
"code": "0805001",
"name": {
"en": "Parking Lot",
"ja": "駐車場",
"ko": "주차장"
},
"ruby": {
"ja": "ちゅうしゃじょう"
},
"level": "small"
},
{
"code": "0805",
"name": {
"en": "Parking Lot",
"ja": "駐車場",
"ko": "주차장"
},
"ruby": {
"ja": "ちゅうしゃじょう"
},
"level": "middle"
},
{
"code": "08",
"name": {
"en": "Transportation",
"ja": "交通",
"ko": "교통"
},
"ruby": {
"ja": "こうつう"
},
"level": "large"
}
]
},
・・・
],
"unit": {
"datum": "wgs84",
"coord_unit": "degree"
}
}