住所別スポット件数
/spot_count [GET]
基本情報
概要
検索ワードを用いて、住所ごとにスポットの件数を取得します。
スポットとは下記のような施設全般を指します。
- 飲食店、医療機関、娯楽施設、宿泊施設、小売店、公共施設、観光地 など
URL
https://{HOST}/{CID}/v1/spot_count
※Rakuten RapidAPIでは提供しておりません
出力形式
- JSON
対応言語
- ja
出力順
- 検索対象となっている住所コード昇順
パラメータ
パラメータ名 | 必須 | 概要 | 型名 | デフォルト値 | 上下限/選択値 | 備考 |
---|---|---|---|---|---|---|
word | ✔ | 検索ワード | 文字列 | |||
category_filter | カテゴリフィルター | 文字列 | カテゴリを絞り込むフィルター カテゴリコード(code)を指定する ・指定コードによる絞り込み:code ・指定コードの除外:-code ・複数指定の場合は上記指定を「.」区切りで指定 |
|||
address | 住所コード | 文字列 | ・2桁(都道府県レベル)もしくは5桁(市町村レベル)のみ指定可能 ・指定しない場合は都道府県ごとの結果を返却 |
パラメータ構成例
- 東京都内で検索ワード「コンビニ」に当てはまる住所ごとのスポット件数
/spot_count?word=コンビニ&address=13
レスポンス
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
住所ごとの件数 | items | AddressFacetオブジェクト | 〇 | 住所ごとの件数 |
AddressFacetオブジェクト
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
住所情報 | address | AddressLevelオブジェクト | ||
件数 | count | 数値 |
AddressLevelオブジェクト
名称 | レスポンス名 | 型名 | 配列 | 説明 |
---|---|---|---|---|
住所コード | code | 文字列 | ||
住所名 | name | 文字列 | ||
住所名のふりがな | ruby | 文字列 | ||
住所のレベル | level | 文字列 | 住所レベル 1:都道府県 2:市区町村 3:大字・町 |
レスポンス例
{ "items": [ { "address": { "code": "13101", "name": "千代田区", "ruby": "ちよだく", "level": "2" }, "count": 354 }, ・ ・ ・ ] }