コンテンツにスキップ

周辺施設検索

/nearby_search [GET]

基本情報

概要

検索地点の緯度経度、カテゴリコード、検索件数を指定して、指定地点周辺のスポット、駅、バス停を指定件数ずつ検索します。
検索されたスポット、駅、バス停までの徒歩移動での距離と時間が検索されます。
スポットとは下記のような施設全般を指します。

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

URL

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

※APIマーケットでは提供しておりません

出力形式

  • JSON

対応言語

  • ja

出力順

  • 指定した緯度経度形状情報からの直線距離昇順

パラメータ

パラメータ名 必須 概要 型名 デフォルト値 上下限/選択値 備考
coord 検索基点 カンマ区切りの数値 検索を行う基準地点の緯度経度
・「緯度,経度」の順で指定
・ミリ秒表記、度表記(10進数)に対応
category (✔) カテゴリコード 文字列 指定カテゴリコード数
最大:10
検索対象のカテゴリコード
・複数指定の場合は、対象カテゴリコードを「.」区切りで指定

category,station,busstopいずれかひとつは必ず指定してください
※categoryは専用データ利用オプション申し込み時のみ利用可能
station (✔) 駅検索 真偽値 false true: 駅を検索対象にする
false: 駅を検索対象にしない

category,station,busstopいずれかひとつは必ず指定してください
busstop (✔) バス停検索 真偽値 false true: バス停を検索対象にする
false: バス停を検索対象にしない

category,station,busstopいずれかひとつは必ず指定してください
※バス停の情報取得は、オプション機能のため、別途契約が必要となります
(バス時刻表利用オプションがない場合かつtrue指定時はシャトルバス用バス停のみ対象)
limit 検索上限数 数値 10 最小値:1
最大値:10
各指定カテゴリ毎の検索スポット上限数
datum 緯度経度の測地系 文字列 wgs84 wgs84:世界測地系
tokyo:旧日本測地系
coord_unit 出力データに含まれる緯度経度の単位 文字列 degree degree:度表記の10進法
millisec:ミリ秒表記

検索範囲について

半径100kmの範囲を検索します。

パラメータ構成例

  • 中目黒周辺で小学校、幼稚園/保育園、スーパー、駅、バス停を上限3件ずつ検索
/nearby_search?category=0504001.0504006001.0202001&coord=35.641754,139.701984&station=true&busstop=true&limit=3

レスポンス

名称 レスポンス名 型名 配列 説明
施設情報 items NearbyFacilityオブジェクト 周辺施設情報

NearbyFacilityオブジェクト

名称 レスポンス名 型名 配列 説明
タイプ情報 type 文字列 返却施設のタイプ情報
・スポットの場合: spot
・駅の場合:station
・バス停の場合:busstop
カテゴリ情報 category Categoryオブジェクト カテゴリ情報
type:spotの場合のみ返却
検索数 count Countオブジェクト レスポンスのヒット数などの情報
スポット一覧 spot Spotオブジェクト スポット情報

Categoryオブジェクト

名称 レスポンス名 型名 配列 説明
カテゴリコード code 文字列 カテゴリコード
カテゴリ名称 name 文字列 検索ヒットした件数
該当カテゴリのスポットが0件の場合は空で返却

Countオブジェクト

名称 レスポンス名 型名 配列 説明
検索件数 total 数値 検索ヒットした件数
リミット limit 数値 検索上限数

Spotオブジェクト

名称 レスポンス名 型名 配列 説明
スポットコード code 文字列
スポット名 name 文字列
スポット名の読み仮名 ruby 文字列
電話番号 phone 文字列
住所コード address_code 文字列
住所の表示名 address_name 文字列
緯度経度 coord Coordinateオブジェクト
郵便番号 postal_code 文字列
距離(単位:m) distance 数値 検索基点からの徒歩距離
徒歩移動時間(単位:分) time 数値 検索起点からの徒歩移動時間
出入り口名称 gateway 文字列 駅の出入口名称
category:stationの場合かつ、データが有る場合のみ出力

Coordinateオブジェクト

名称 レスポンス名 型名 配列 説明
スポットの緯度 lat 数値
スポットの経度 lon 数値

レスポンス例

{
  "items": [
    {
      "type": "spot",
      "category": {
        "code": "0504001",
        "name": "小学校"
      },
      "count": {
        "total": 3,
        "limit": 3
      },
      "spot": [
        {
          "code": "00004-13108901391",
          "name": "目黒区立中目黒小学校",
          "ruby": "めぐろくりつなかめぐろしょうがっこう",
          "phone": "0337117628",
          "address_name": "東京都目黒区中目黒3丁目13-32",
          "address_code": "13110016000",
          "coord": {
            "lat": 35.640178,
            "lon": 139.699259
          },
          "postal_code": "1530061",
          "distance": 505,
          "time": 7
        },
        ・・・
      ]
    },
    {
      "type": "spot",
      "category": {
        "code": "0504006001",
        "name": "幼稚園/保育園"
      },
      "count": {
        "total": 3,
        "limit": 3
      },
      "spot": [
        {
          "code": "00004-13109502989",
          "name": "キッズガーデン中目黒",
          "ruby": "きっずがーでんなかめぐろ",
          "phone": "0367217111",
          "address_name": "東京都目黒区中目黒3丁目5-8",
          "address_code": "13110016000",
          "coord": {
            "lat": 35.640112,
            "lon": 139.702562
          },
          "postal_code": "1530061",
          "distance": 305,
          "time": 4
        },
        ・・・
      ]
    },
    {
      "type": "spot",
      "category": {
        "code": "0202001",
        "name": "スーパー"
      },
      "count": {
        "total": 3,
        "limit": 3
      },
      "spot": [
        {
          "code": "02022-1249190",
          "name": "Bio c' Bon(ビオ セ ボン) 中目黒店",
          "ruby": "びおせぼんなかめぐろてん",
          "phone": "0364127157",
          "address_name": "東京都目黒区上目黒1-26-2 中目黒アトラスタワー内",
          "address_code": "13110005000",
          "coord": {
            "lat": 35.643636,
            "lon": 139.700836
          },
          "postal_code": "1530051",
          "distance": 274,
          "time": 4
        },
        ・・・
      ]
    },
    {
      "type": "station",
      "count": {
        "total": 3,
        "limit": 3
      },
      "spot": [
        {
          "code": "00006133",
          "name": "中目黒",
          "ruby": "なかめぐろ",
          "types": [
            "station"
          ],
          "address_name": "東京都目黒区上目黒",
          "address_code": "13110005000",
          "coord": {
            "lat": 35.644128,
            "lon": 139.699012
          },
          "distance": 472,
          "time": 8,
          "gateway": "東口1"
        },
        ・・・
      ]
    },
    {
      "type": "busstop",
      "count": {
        "total": 3,
        "limit": 3
      },
      "spot": [
        {
          "code": "00018790",
          "name": "正覚寺前(東京都)",
          "ruby": "しょうがくじまえ",
          "types": [
            "busstop"
          ],
          "address_name": "東京都目黒区上目黒",
          "address_code": "13110005000",
          "coord": {
            "lat": 35.641939,
            "lon": 139.701593
          },
          "distance": 55,
          "time": 1
        },
        ・・・
      ]
    }
  ]
}