---
title: "Address Search"
method: GET
path: "/api/properties/address-search"
tags: ["Properties"]
---

# Address Search

`GET /api/properties/address-search`

## Request

- Base URL: `https://api.earmarkiq.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.earmarkiq.app/api/properties/address-search`
- Auth: HTTP bearer

Address autocomplete → UPRN candidates via PMI. Degrades gracefully:
on any PMI failure returns search_available=false so the client falls
back to manual postcode entry.

## Query parameters

- `q` string, required

## Response `200`

Successful Response

- AddressSearchResponse
  - `results` AddressCandidate[], required
    - `uprn` string, required
    - `address` string, required
    - `postcode` string, nullable, required
    - `confidence` number, nullable, required
  - `search_available` boolean, required
  - `reason` string, nullable
  - `message` string, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/earmarkiq/apis/earmark-api.md) · [All operations](https://skmtc.dev/earmarkiq/apis/earmark-api/llms.txt) · [OpenAPI document](https://skmtc.dev/earmarkiq/apis/earmark-api/revisions/4a2c41907105?raw)