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.

Rate limits and quotas

Each key has a per-minute rate limit and daily and monthly quotas.

The limits for your key are shown in the console, and every response carries the RateLimit-Limit, RateLimit-Remaining and RateLimit-Reset headers. No figures are published in this guide.

  • rate_limited: you sent too many requests in the current minute.
  • quota_exceeded: the daily or monthly quota for the key has been used.

Both come back as HTTP 429 with a Retry-After header holding the number of seconds to wait. Wait that long, then retry with exponential back-off. Do not retry in a tight loop.

Usage is monitored. Patterns that look like copying the data set, or like a key being shared, can lead to a key being paused.