メインコンテンツまでスキップ

Fractale API

オープンデータプラットフォームのAPIドキュメント

ベースURL

http://localhost:3006

認証

現在、APIは認証不要で利用できます。将来的にAPIキー認証を実装予定です。

エンドポイント

GET/api/facilities/search

施設検索

パラメータ

名前説明
qstring検索クエリ
typestring施設タイプ (hotel, restaurant, attraction)
limitnumber取得件数 (デフォルト: 50)

使用例

curl "http://localhost:3006/api/facilities/search?q=ホテル&limit=10"
GET/api/facilities/stats

統計情報取得

使用例

curl "http://localhost:3006/api/facilities/stats"
GET/api/facilities/nearby

近傍検索

パラメータ

名前説明
latnumber緯度
lngnumber経度
radiusnumber検索半径(m) (デフォルト: 1000)
limitnumber取得件数 (デフォルト: 20)

使用例

curl "http://localhost:3006/api/facilities/nearby?lat=34.6937&lng=135.5023&radius=500"

レスポンス形式

{
  "success": true,
  "data": [...],
  "count": 10
}

エラーレスポンス

{
  "success": false,
  "error": "エラーメッセージ"
}

レート制限

現在レート制限はありませんが、将来的に以下の制限を予定しています:

  • 100リクエスト/分
  • 5000リクエスト/日