API Documentation

Integrate proprietary real estate intelligence directly into your models and CRMs.

Authentication

All API requests require an API key passed via the x-api-key header or as a query parameter ?apiKey=.

curl -H "x-api-key: YOUR_KEY" https://api.addressintel.com/v1/market-signals
Download OpenAPI Spec (JSON)Perfect for integrating with OpenAI Function Calling or LangChain.

Endpoints

GET/api/v1/market-signals

Retrieves top investment opportunities scored by our proprietary engine. For the Peninsula, properties are scored on teardown potential. For Nantucket, properties are scored on flippability and historic charm.

Query Parameters

  • market(Optional) Filter by market ("peninsula" or "nantucket"). Defaults to peninsula.
  • city(Optional) Filter by city name (e.g., "Atherton")
  • address(Optional) Search for a specific address

Response

{
  "success": true,
  "count": 50,
  "data": [
    {
      "id": "abc-123",
      "address": "123 Main St",
      "city": "Menlo Park",
      "price": 2400000,
      "status": "Active",
      "teardownScore": 95.5,
      "flippabilityScore": 0,
      "developerROI": 32.1,
      "conditionScore": 3.5,
      "visionAnalysis": "...",
      "metadata": {
        "sqft": 1100,
        "lotSize": 14500,
        "daysOnMarket": 4
      }
    }
  ]
}

Interactive Playground

Test the API directly from your browser. Click the button below to fetch live data using a demo API key.

GET/api/v1/market-signals?apiKey=demo

Click "Run Request" to see a live demo of the API response.

Using the demo API key restricts results to 2 items.

GET/api/v1/properties/:idFree Tier

Retrieves detailed intelligence for a single property, including aggregated comp data and proprietary scores.

Path Parameters

  • idThe unique identifier of the property

Response

{
  "success": true,
  "data": {
    "id": "abc-123",
    "address": "123 Main St",
    "city": "Menlo Park",
    "price": 2400000,
    "intelligence": {
      "teardownScore": 95.5,
      "flippabilityScore": 0,
      "marketHeatIndex": 82,
      "biddingWarPredictor": 65
    },
    "comparables": {
      "recentSalesCount": 5,
      "avgPricePerSqft": 1250
    }
  }
}

Usage & Limits

Beta Limits Unlocked

Free

During our early access beta, all generated API keys are automatically upgraded to production limits for 3 months.

  • Up to 100 results per request
  • Rate limit: 100 requests per minute
  • Full access to real-time Webhooks

Pagination

To retrieve more results, use the limit and offset query parameters. For example, appending ?limit=50&offset=50 will return the second page of 50 results.

Error Handling

The API uses standard HTTP status codes to indicate the success or failure of an API request. Errors are returned as JSON with an error description.

{
  "error": "Unauthorized. Missing API Key."
}

Real-time Webhooks

Push real estate intelligence directly into your CRM or internal systems. Subscribe to webhook events to receive real-time notifications when major construction or demolition permits are filed.

Subscribing to Webhooks

You can register your webhook endpoint via the API or using the form below.

Register via UI
Register via API
curl -X POST https://api.addressintel.com/v1/webhooks/register \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://your-domain.com/webhook"}'

Supported Events

  • permit.created - Fired when a new high-value permit is recorded
  • property.score_updated - Fired when a property's teardown or flippability score changes

Example Payload (permit.created)

{
  "event": "permit.created",
  "market": "sf-peninsula",
  "data": {
    "permitId": "B24-1052",
    "type": "Demolition",
    "address": "123 Main St, Menlo Park",
    "estimatedValue": 150000,
    "description": "Demolish existing single family residence to prepare for new construction",
    "teardownScore": 95.5
  },
  "timestamp": "2026-06-12T15:30:00Z"
}

Start Building for Free

During our early access beta, developers get a guaranteed 3 months free of our top-tier plan limits upon signup. No credit card required.

Starter

$49/mo
  • 25 results per request
  • Community support
Included Free

Pro

$99$0/mo
  • 100 results per request
  • Real-time Webhooks
  • Priority support