Spotr Developer Portal API (1.0.0)
Download OpenAPI specification:Download
Submit property analysis requests to Spotr and receive results via secure, signed webhooks. Authentication is via API key.
Create a new property analysis request
Authorizations:
ApiKeyAuth
Request Body schema: application/jsonrequired
Request payload for property analysis
| portfolio_id | string or null Optional portfolio identifier |
required | object (AddressBody) Property address to analyze |
| package_names required | Array of strings [ 1 .. 10 ] items Items Enum: "base" "fire_risk" "rebuild_value" "underwriting_risk" "condition" "materialisation" Names of analysis packages to apply |
Responses
Request samples
- Payload
Content type
application/json
{- "portfolio_id": "12345",
- "address": {
- "country_code": "NL",
- "city": "Amsterdam",
- "street_name": "Main St",
- "street_number": "23",
- "postal_code": "2515",
- "latitude": 34.052235,
- "longitude": -118.243683
}, - "package_names": [
- "base"
]
}Response samples
- 202
- 422
Content type
application/json
{- "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}