Introduction

Welcome to the Spotr Developer Portal — your central resource for integrating Spotr’s advanced property intelligence API into your systems. Our platform delivers machine learning-powered insights such as fire risk assessments, rebuild value estimations, and more.

Overview

Spotr’s API provides:

• Property Analysis — Retrieve comprehensive insights like fire risk and rebuild value.
• Specialized ML Models — Access tailored models for property evaluation.
• Webhook Automation — Receive asynchronous results directly into your systems.

API Authentication

The only public API endpoint that can be used with an API Key is POST https://api.spotr.ai/v1/requests, secured via an API key. All other interactions are managed through the Spotr Developer Portal.

Authentication Method

Include the following header in all POST /v1/requests calls:

X-API-Key: YOUR_API_KEY

Key Features

• Single Entry Point: One authenticated call to start your analysis.
• Webhook Support: Get results pushed directly to your system.
• Verified Delivery: Webhook payloads are cryptographically signed.
• Portal Management: Handle everything else via the web portal.

API Endpoint

Requests

• Create Request (API-accessible): Submit a property analysis request with specified packages.

Example in Curl:

curl -X POST https://api.spotr.ai/v1/requests \
  -H "Content-Type: application/json" \
  -H "X-API-Key: YOUR_API_KEY" \
  -d '{
    "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": ["fire_risk"]
  }'

Response:

{
  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

For a full reference, see the API Schema (OpenAPI/Redoc).

Available Packages

Supported packages include:

• base
• fire_risk
• rebuild_value
• underwriting_risk
• condition
• materialisation

Getting Started

1. Register on the Developer Portal.
2. Configure your API Key.
3. Set your Webhook URL.
4. Send API Requests, receive results via webhook.