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
      }
    }
  ]
}
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
    }
  }
}

Ready to start building?

Get your production API key and start ingesting high-signal real estate data today.