Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.uk.housr.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Authentication

Obtain a Bearer token by calling POST /auth/token with HTTP Basic Auth (client_id:client_secret).
Tokens expire in 1 hour by default and provide access to the Housr API based on your client credentials and associated scopes.

​
Get a token

​
cURL

curl -X POST https://v2.api.uk.housr.com/auth/token \
  -u "your_client_id:your_client_secret" \
  -H "Content-Type: application/json"