API Reference
PRS API v2 の公開境界と主要エンドポイントのリファレンスです。Base URL: https://api.propriskapi.com
API CONTRACT
公開 API 契約では、見せる情報と隠す情報を分けています
strict public default の正本は /v2/* です。標準公開面は hazard / exposure / 一般リスク評価が中心で、financial inference は plan と source-quality に応じて扱いを切り分けます。
POST /v2/assess と POST /v2/assess/batch は公開標準面ですが、出力の深さは plan により異なります。
transaction と value_impact は hidden_strict_default として扱い、標準公開面では返さない前提です。
sea_level_rise は exposure / climate scenario 用途で公開し、現在価値への金額翻訳は標準公開面に含めません。
insurance/estimate と report/tcfd の monetary output は Pro / Enterprise 向け reference estimate です。
公開区分
| Label | Meaning | Examples |
|---|---|---|
public_full | strict public default で標準公開する情報 | hazard、exposure、一般リスク評価 |
plan_tiered | 公開するが plan により深さや可否が変わる情報 | /v2/assess の出力深度、batch、tiles、ops/export |
hidden_strict_default | 実装済みでも strict public default では標準表示しない情報 | transaction、value_impact |
launch_hold | review やデータ条件待ちで public launch では出さない情報 | stigma |
- POST /v2/assess と POST /v2/assess/batch は公開標準面の正本です。
- GET /v2/insurance/estimate と GET /v2/report/tcfd の金額影響表示は、Pro / Enterprise 向け reference estimate として扱います。
- hidden_strict_default の transaction / value_impact は、standard public output では返さない前提です。
エンドポイント一覧
| Method | Path | Description |
|---|---|---|
| POST | /v2/assess | 単一物件リスク評価 |
| POST | /v2/assess/batch | 複数物件一括評価 |
| GET | /v2/ops/health | ヘルスチェック |
| GET | /v2/ops/version | APIバージョン情報 |
| GET | /v2/ops/risks | 対応リスク種別一覧 |
| GET | /v2/ops/coverage | データカバレッジ確認 |
| GET | /v2/ops/stats | 統計情報 |
| GET | /v2/ops/data-versions | データバージョン一覧 |
| GET | /v2/ops/rate-limits | レート制限情報 |
| GET | /v2/ops/audit-log | 監査ログ取得 |
| POST | /v2/ops/export | データエクスポート作成 |
| GET | /v2/tiles/{layer}/{z}/{x}/{y}.pbf | ベクトルタイル |
| GET | /v2/tiles/{layer}/{z}/{x}/{y}.png | ラスタータイル |
| GET | /v2/tiles/layers | 利用可能レイヤー一覧 |
| GET | /v2/tiles/metadata/{layer} | レイヤーメタデータ |
エラーコード
400Bad Request
リクエストパラメータ不正。address または lat/lng が必須です。
401Unauthorized
APIキー未指定、または無効なキーが送信されました。
403Forbidden
プランで許可されていないリソースへのアクセスです。
404Not Found
指定されたリソースが存在しません。
429Too Many Requests
レート制限を超過しました。Retry-After ヘッダーを確認してください。
500Internal Server Error
サーバー内部エラーです。再試行するか、サポートにお問い合わせください。
レート制限ヘッダー
X-RateLimit-Limitウィンドウあたりの最大リクエスト数X-RateLimit-Remainingウィンドウ内の残りリクエスト数X-RateLimit-ResetウィンドウがリセットされるUNIXタイムスタンプ429レスポンス時は Retry-After ヘッダーも含まれます。指定秒数待ってからリトライしてください。