コンテンツにスキップ

住所別スポット件数

/spot_count [GET]

基本情報

概要

検索ワードを用いて、住所ごとにスポットの件数を取得します。
スポットとは下記のような施設全般を指します。

  • 飲食店、医療機関、娯楽施設、宿泊施設、小売店、公共施設、観光地 など

※当APIをご利用の場合は、専用データ利用のオプション契約が別途必要となります

URL

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

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

出力形式

  • JSON

対応言語

  • ja, en, ko, zh-CN, zh-TW, th

出力順

  • 検索対象となっている住所コード昇順

パラメータ

パラメータ名 必須 概要 型名 デフォルト値 上下限/選択値 備考
word ✔ 検索ワード 文字列
category_filter カテゴリフィルター 文字列 カテゴリを絞り込むフィルター
カテゴリコード(code)を指定する
・指定コードによる絞り込み：code
・指定コードの除外：-code
・複数指定の場合は上記指定を「.」区切りで指定
address 住所コード 文字列 ・2桁（都道府県レベル）もしくは5桁（市町村レベル）のみ指定可能
・指定しない場合は都道府県ごとの結果を返却
lang 言語 文字列 ja: 日本語
en: 英語
ko: 韓国語
zh-CN: 中国語(簡体字)
zh-TW: 中国語(繁体字)
th: タイ語		 出力する言語を指定します
・ピリオド区切りで複数指定可能
※多言語オプション申込時のみ利用可能
(APIマーケットでは利用不可)

langパラメータの指定時の注意点

多言語に対応したレスポンスはMultilingualオブジェクトとして出力されることにご注意ください。

パラメータ構成例

  • 東京都内で検索ワード「コンビニ」に当てはまる住所ごとのスポット件数
/spot_count?word=コンビニ&address=13

レスポンス

名称 レスポンス名 型名 配列 Nullable 説明
住所ごとの件数 items AddressFacetオブジェクト 〇 住所ごとの件数

AddressFacetオブジェクト

名称 レスポンス名 型名 配列 Nullable 説明
住所情報 address AddressLevelオブジェクト
件数 count 数値

AddressLevelオブジェクト

名称 レスポンス名 型名 配列 Nullable 説明
住所コード code 文字列 nullable
住所名 name 文字列/Multilingualオブジェクト langパラメータ指定時は、Multilingualオブジェクトで出力
住所名のふりがな ruby 文字列 多言語指定時も日本語で出力
住所のレベル level 文字列 住所レベル
1：都道府県
2：市区町村
3：大字・町

Multilingualオブジェクト

名称 レスポンス名 型名 配列 Nullable 説明
英語名称 en 文字列 nullable
日本語名称 ja 文字列 nullable
韓国語名称 ko 文字列 nullable
タイ語名称 th 文字列 nullable
中国語(簡体字)名称 zh-CN 文字列 nullable
中国語(繁体字)名称 zh-TW 文字列 nullable

レスポンス例

{
    "items": [
        {
            "address": {
                "code": "13101",
                "name": "千代田区",
                "ruby": "ちよだく",
                "level": "2"
            },
            "count": 354
        },
        ・
        ・
        ・
    ]
}

レスポンス例(多言語返却時 ※lang=ja.en.ko指定)

{
    "items": [
        {
            "address": {
                "code": "13101",
                "name": {
                    "en": "Chiyoda",
                    "ja": "千代田区",
                    "ko": "치요다구"
                },
                "ruby": "ちよだく",
                "level": "2"
            },
            "count": 337
        },
        ・
        ・
        ・
    ]
}

エラー情報

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

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

HTTPステータス エラーメッセージ 発生理由
405 This http method is invalid : 許可されていないHTTPメソッドでアクセスした場合に発生します。
400 parameter error: word: ['required field'] wordが未指定の場合に発生します。
400 parameter error: word: ['empty values not allowed'] wordが空文字の場合に発生します。
400 parameter error: category_filter: ['an invalid category filter: {value}'] category_filterの形式が不正な場合（2桁・4桁・7桁・10桁の数値以外）に発生します。
400 parameter error: address: ['an invalid code: {value}'] addressが不正な住所コードの場合（2桁または5桁の数値以外）に発生します。
400 parameter error: lang: ['an invalid item: {item}'] langにja・en・ko・zh-CN・zh-TW・th以外の値を指定した場合に発生します。
400 bad usage on this contract　:　Multilingual lang パラメータを指定したが、契約で多言語オプションが有効化されていない場合に発生します。