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.
IP allowlisting
A key works only from the IP address registered for it. You register one address when you subscribe.
To find out which address we see, call GET /v1/ping from your server. The response echoes it back in the address field. Register that address, not the address of your office or your laptop.
A request from any other address is refused with ip_not_allowed, even if the key is correct. Both IPv4 and IPv6 addresses are accepted.
You can change the registered address in the console. Changes are logged and limited, so register the outbound address of a stable server, and use a static outbound address if you run on a cloud provider.
If your servers sit behind a proxy or a NAT gateway, register the address of the proxy or gateway, because that is the address we see.
GET /v1/ping
Check your key and the address we see
Confirms that the key is accepted from the address the request came from, and echoes that address. Use it to check the IP you registered before you build anything else.
Parameters
No parameters.
Responses
| Status | Description | Error codes |
|---|---|---|
200 | The key is valid and the address is registered. | |
401 | The key is missing, unknown or revoked. | unauthenticated |
403 | The key is valid but this request is refused. | ip_not_allowed key_paused |
429 | A rate limit or a quota has been reached. | rate_limited quota_exceeded |
503 | The service cannot answer right now. | service_unavailable |