モバイラーズオアシス公開API仕様 - モバイラーズオアシス

概要

指定した緯度経度範囲に含まれるスポット情報を、中心点からの距離順で返します。タグ・カテゴリ・無線LANで絞り込みできます。

エンドポイント

GET /public_api/v2/spots
GET /public_api/v2/spots.json

レスポンス形式はJSONです。

リクエストパラメータ

名前	必須	説明
n, s, w, e	必須	検索範囲の北端・南端・西端・東端の緯度経度。
latitude, longitude	任意	距離計算の基準点。省略時は n/s/w/e の中心点を使用。
tags	任意	その他タグ名をカンマ区切りで指定（OR検索）。
categories	任意	カテゴリ名をカンマ区切りで指定（OR検索）。
wireless	任意	無線LANタグ名をカンマ区切りで指定（OR検索）。
limit	任意	返却件数の上限。1以上の整数。
max_spots	任意	許容最大件数。デフォルト500、上限500。
contains_invalid	任意	指定時は非公開・期限切れスポットも含めます。

tags / categories / wireless はそれぞれ OR 条件で、項目間は AND 条件です。

レスポンス

レスポンスは次の形式で返ります。

{
  "status": "OK",
  "results": [
    {
      "id": 123,
      "ee_id": "EE12345",
      "title": "店舗名",
      "address": "住所",
      "tel": "電話番号",
      "latitude": 35.0,
      "longitude": 139.0,
      "url": "https://example.com",
      "other": "追加情報(HTML文字列)",
      "distance": 0.42,
      "status": "open",
      "expiration_date": null,
      "mo_url": "https://oasis.mogya.com/spot/xxxx",
      "wireless": [ ... ],
      "categories": [ ... ],
      "tags": [ ... ],
      "prime_category": { ... },
      "icon": "https://..."
    }
  ]
}

wireless / categories / tags / prime_category の各要素は、id・name・image・importance などのタグ属性を含むオブジェクトです。

status の値

OK: 正常終了。
TOO_MUCH_SPOTS: 条件に一致する件数が max_spots を超過。

必須パラメータ不足時は HTTP 400（Bad Request）になります。

サンプル

GET /public_api/v2/spots.json?n=35.70&s=35.60&w=139.60&e=139.80&tags=電源:お客様用コンセント&wireless=ソフトバンクWi-Fi

APIの利用について

いずれのAPIも、商用に利用できません。
有償利用のご契約(30,000円/月)をいただいた会社様には個別にAPIを提供させていただいておりますので、お気軽にお問い合わせくださいませ。
無償利用のAPIは、予告なく提供を終了する場合があります。

お問い合わせ: /contact/