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.
Getting a key
You get a key by subscribing in the console. There is no approval queue and no email to send.
- Sign in to the console, or create an account. It is the same account you use for other Housing Market products.
- Choose the countries, a region or worldwide, the tier, and monthly or annual billing.
- Enter the IP address your servers will call the API from.
- Accept the API terms of use. We keep a record of what you accepted and when.
- Pay. Your key appears only after the payment has succeeded, and it is shown once.
Copy the key straight into your secret store. We keep only a one-way hash of it, so we cannot show it to you again. A key looks like hma_<prefix>_<secret>.
You can create a replacement key in the console at any time. The old key keeps working for 24 hours after you do, so you can switch over without downtime.
Key states
- Active: the key works.
- Paused: the key is refused with
key_paused. It resumes by itself when the reason is resolved. - Revoked: the key is permanently refused with
unauthenticated.
If a renewal payment fails, your key keeps working for a grace period of 5 days while we email you at each step, and is then paused. A paused key resumes automatically as soon as the payment is settled. A payment dispute pauses the key immediately until it has been reviewed.
Adding a country or upgrading is charged pro rata straight away, and applies to the same key shortly after the payment is confirmed. Removing a country or downgrading takes effect at the next renewal.