Skip to main content

Documentation

Everything you need to integrate

The guide, the reference and the specification are generated from one OpenAPI file, so they always agree. Identifiers are the same in every language.

  • Integration guide

    Getting a key, authentication, filters, pagination, limits and errors, in your language.

    Open the guide

  • OpenAPI specification

    The OpenAPI 3.1 file the reference is generated from, for code generators and API tools.

    Download the specification

  • PDF guide

    The integration guide as one document, to read offline or share with your team.

    Download the PDF

The documentation is public. You need a key only to call the API.

Quick start

Check your key and the address we see
curl -H "x-api-key: $HMA_API_KEY" \
  "https://api.housingmarketapi.com/v1/ping"
Read the first page of listings for a country
curl -H "x-api-key: $HMA_API_KEY" \
  "https://api.housingmarketapi.com/v1/properties?country=TH&listing_type=sale&property_type=condominium&limit=100"

At a glance

Base URL
https://api.housingmarketapi.com
Authentication
The key in the x-api-key header, sent from the server address registered for it.

Endpoints

EndpointTierDescription
GET /v1/pingStandardConfirms your key works from the address it is registered to, and echoes that address.
GET /v1/propertiesStandardPublished listings for a country your key covers, one page at a time.
GET /v1/insights/*AdvancedAggregated market data by place and period, for Advanced keys. Coming soon: these endpoints are not live yet.

Error codes

Every error carries an HTTP status and one of these codes. Branch on the code, not on the message.

  • invalid_parameter
  • invalid_cursor
  • unauthenticated
  • ip_not_allowed
  • key_paused
  • country_not_entitled
  • upgrade_required
  • not_found
  • method_not_allowed
  • rate_limited
  • quota_exceeded
  • internal_error
  • not_configured
  • service_unavailable
Get your API keySee pricing