> ## Documentation Index
> Fetch the complete documentation index at: https://docs.propaideals.co.uk/llms.txt
> Use this file to discover all available pages before exploring further.

# Prop AI Deals API

> REST API for UK property data, market intelligence, investment analysis, and AI-powered search. Access 2.1M+ live and sold UK properties with PostGIS spatial search, BMV scoring, rental yields, and HM Land Registry history.

# Prop AI Deals API

The Prop AI Deals API gives you programmatic access to the UK's largest live property dataset — **2.1M+ on-market UK listings plus an exclusive off-market lead pool**, enriched with HM Land Registry sold history, EPC certificates, rental estimates, BMV (below-market-value) scoring, and AI-powered investment analysis.

Built for property investors, fintech apps, lettings platforms, valuation tools, and research teams that need fresh, structured UK real estate data.

## Base URL

```
https://api.propaideals.co.uk
```

All endpoints are versioned under `/api/v1/`.

## What you can do

| Capability                                                         | Endpoints                                   |
| ------------------------------------------------------------------ | ------------------------------------------- |
| Search live for-sale and rental listings                           | `GET /api/v1/properties`                    |
| Get full property details                                          | `GET /api/v1/properties/{id}`               |
| Search by viewport, polygon, or radius                             | `POST /api/v1/spatial/search/*`             |
| Look up sold history (HM Land Registry + multi-portal aggregation) | `GET /api/v1/market-data/{id}/sold-history` |
| Source **off-market** distressed / motivated-seller leads          | `GET /api/v1/off-market-lead-generators/*`  |
| Find on-street comparable sales                                    | `GET /api/v1/market-data/{id}/on-street`    |
| Pull rental estimates and yields                                   | `GET /api/v1/rentals/*`                     |
| Run BTL, BRRR, flip, HMO, SA calculators                           | `POST /api/v1/calculations/*`               |
| Get area market intelligence                                       | `GET /api/v1/market-intelligence/*`         |
| Query off-market and motivated-seller leads                        | `GET /api/v1/off-market/*`                  |
| Chat with the property AI                                          | `POST /api/v1/ultimate-ai/chat`             |

## Quick example

```bash theme={null}
curl https://api.propaideals.co.uk/api/v1/properties?area=London&min_price=300000&max_price=500000 \
  -H "Authorization: Bearer paid_your_api_key_here"
```

```javascript theme={null}
const res = await fetch(
  'https://api.propaideals.co.uk/api/v1/properties?area=London&min_price=300000&max_price=500000',
  { headers: { Authorization: 'Bearer paid_your_api_key_here' } }
)
const { data, meta } = await res.json()
console.log(data.properties)
```

```python theme={null}
import requests

res = requests.get(
    "https://api.propaideals.co.uk/api/v1/properties",
    params={"area": "London", "min_price": 300000, "max_price": 500000},
    headers={"Authorization": "Bearer paid_your_api_key_here"},
)
res.raise_for_status()
print(res.json()["data"]["properties"])
```

## Get started

1. **[Quickstart](./quickstart)** — Make your first request in under 3 minutes
2. **[Authentication](./authentication)** — Create and use API keys
3. **[Rate limits](./rate-limits)** — Per-second and monthly quotas
4. **[Errors](./errors)** — Error codes and how to handle them
5. **[Response format](./response-format)** — Envelope, pagination, headers

## API reference

* **[Properties](./endpoints/properties)** — Search, list, and retrieve UK property listings
* **[Spatial search](./endpoints/spatial)** — Viewport, polygon, radius queries
* **[Market data](./endpoints/market-data)** — Sold history, comparables, price trends
* **[AI chat](./endpoints/ai-chat)** — Conversational property intelligence
* **[API keys (dashboard)](./endpoints/api-keys)** — Create and manage your keys

## SDK & tooling

* **[OpenAPI spec](https://api.propaideals.co.uk/openapi.json)** — machine-readable OpenAPI 3.1 definition
* **[Status page](https://status.propaideals.co.uk)** — real-time API uptime and incident history
* **[Changelog](./changelog)** — version history and breaking changes
* **[llms.txt](https://docs.propaideals.co.uk/llms.txt)** — Markdown index for LLM-based agents (llmstxt.org spec)

## Support

* Email: `info@propaideals.co.uk`
* Office hours: Mon–Fri 09:00–17:00 GMT