Housing Market API integration guide

The reference tables, endpoint descriptions, error codes and examples are generated from the API specification and stay in English in every language. Names, parameters and codes are identical everywhere.

Authentication

Send your key in the x-api-key header of every request.

Keep the key on your server. Never put it in a mobile app, a web page or a public repository: anyone who holds it can use your subscription.

A key belongs to one customer. Do not share it with another company; the terms forbid it, and we can see where a key is used from.

One key carries all of your access: your countries and your tier. When you add a country or upgrade, the key changes; you do not get a new one.

A missing, unknown or revoked key is refused with unauthenticated. A valid key used from an unregistered address is refused with ip_not_allowed. A paused key is refused with key_paused.

Example request

curl

curl -H "x-api-key: $HMA_API_KEY" \
  "https://api.housingmarketapi.com/v1/ping"