クイックスタート
APIを使い始めるための基本情報
1. APIキーを取得
APIキー管理ページで新しいAPIキーを作成してください。
2. リクエストヘッダーにAPIキーを設定
X-API-Key: rv_live_xxxxxxxxxxxxxxxx3. APIエンドポイントにリクエスト
GET https://api.houspot.jp/api/v1/b2b/score?lat=35.6812&lng=139.7671レート制限
1日あたりの制限
1,000リクエスト
リセット時刻
UTC 00:00
バッチ最大件数
100件/リクエスト
レート制限を超えた場合、HTTP 429エラーが返されます。 レスポンスヘッダーで残りリクエスト数を確認できます。
- X-RateLimit-Limit: 1日あたりの上限
- X-RateLimit-Remaining: 残りリクエスト数
- X-RateLimit-Reset: リセット時刻（ISO 8601形式）
エンドポイント一覧
GETリスクスコア取得
指定座標のリスクスコアを取得します
エンドポイント
GET https://api.houspot.jp/api/v1/b2b/scoreパラメータ
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
| lat | number | 必須 | 緯度 (-90 ~ 90) |
| lng | number | 必須 | 経度 (-180 ~ 180) |
レスポンス例
{
"success": true,
"data": {
"lat": 35.6812,
"lng": 139.7671,
"total_score": 72,
"rank": "B",
"disaster_risk": {
"total": 72,
"flood": 15,
"earthquake": 8,
"landslide": 20,
"tsunami": 20,
"ground": 9
}
},
"meta": {
"request_id": "550e8400-e29b-41d4-a716-446655440000",
"rate_limit_remaining": 950,
"rate_limit_reset": "2024-01-16T00:00:00Z"
}
}コード例
curl -X GET "https://api.houspot.jp/api/v1/b2b/score?lat=35.6812&lng=139.7671" \ -H "X-API-Key: YOUR_API_KEY"
エラーコード
APIから返される可能性のあるHTTPステータスコード
| コード | 説明 | 対処法 |
|---|---|---|
| 200 | 成功 | - |
| 400 | リクエストエラー | パラメータを確認してください |
| 401 | 認証エラー | APIキーを確認してください |
| 403 | アクセス拒否 | Pro Plusプランにアップグレードしてください |
| 429 | レート制限超過 | 翌日まで待つか、リクエスト数を減らしてください |
| 500 | サーバーエラー | しばらく待ってから再試行してください |
サポート
APIに関するご質問やサポートが必要な場合は、サポートチームにお問い合わせください。
サポートに連絡