Getting Started

Base URL#

All endpoints are accessible via the base URL below. API versioning is applied at the root level to ensure backward compatibility as the platform evolves.

https://property-api.k8s.outra.co.uk/api/v2

Authentication#

Every request must include an Authorization header carrying your API key with the Api-Key scheme, and an accept header of application/json.

curl 'https://property-api.k8s.outra.co.uk/api/v2/property-lookup-detailed?uprn=100023336956' \
  -H 'accept: application/json' \
  -H 'Authorization: Api-Key {api_key}'

API design principles#

The Outra API follows RESTful design standards: predictable resource-based endpoints, consistent request and response structures, standard HTTP methods and clear status codes. This lets you integrate quickly and confidently across languages and frameworks while consuming data in a uniform, activation-ready format.

Responses use one of a few consistent shapes depending on the endpoint:

• Field-group endpoints (for example /property/address, /property/valuation) return a flat JSON object of UPPERCASE-keyed fields. Modelled fields often carry FIELD$CONFIDENCE and FIELD$MODELLED companion keys.
• List endpoints (/market-events/sales-listings, /market-events/rental-listings, and the paginated /property-lookup) return a paginated object, while /market-events/property-history and /address-lookup/postcode return a bare JSON array.
• Errors return an ErrorResponse — { "detail": "…" }. See Errors & Status Codes.

{
  "data": [ ],
  "page": 1,
  "page_size": 100,
  "total_items": 0,
  "total_pages": 0
}

Specifications#

PropertyAPI is built for enterprise-grade interoperability and provides downloadable specifications to support rapid integration, testing and internal documentation. These specifications can be imported directly into tools such as Postman, Swagger or any OpenAPI-compatible client — letting teams explore endpoints, validate responses and accelerate development workflows.

Testing & development#

Before deploying to production, we recommend testing your requests using a third-party client. At Outra we use Postman for both web-based and desktop testing, which supports:

• Authentication via API keys
• Inspection of request and response payloads
• Validation of pagination and filtering behaviour
• Verification of error handling

For more information, visit postman.com.

Endpoint index#