Langkau ke kandungan utama

Dokumentasi

Semua yang anda perlukan untuk integrasi

Panduan, rujukan dan spesifikasi dijana daripada satu fail OpenAPI, jadi ketiga-tiganya sentiasa selaras. Pengecam adalah sama dalam setiap bahasa.

  • Panduan integrasi

    Mendapatkan kunci, pengesahan, penapis, penomboran halaman, had dan ralat, dalam bahasa anda.

    Buka panduan

  • Spesifikasi OpenAPI

    Fail OpenAPI 3.1 yang menjadi sumber rujukan, untuk penjana kod dan alat API.

    Muat turun spesifikasi

  • Panduan PDF

    Panduan integrasi dalam satu dokumen, untuk dibaca di luar talian atau dikongsi dengan pasukan anda.

    Muat turun PDF

Dokumentasi ini terbuka kepada umum. Anda hanya memerlukan kunci untuk memanggil API.

Permulaan pantas

Semak kunci anda dan alamat yang kami lihat
curl -H "x-api-key: $HMA_API_KEY" \
  "https://api.housingmarketapi.com/v1/ping"
Baca halaman pertama penyenaraian bagi sesebuah negara
curl -H "x-api-key: $HMA_API_KEY" \
  "https://api.housingmarketapi.com/v1/properties?country=TH&listing_type=sale&property_type=condominium&limit=100"

Sepintas lalu

URL asas
https://api.housingmarketapi.com
Pengesahan
Kunci dalam pengepala x-api-key, dihantar daripada alamat pelayan yang didaftarkan untuknya.

Endpoint

EndpointPeringkatPenerangan
GET /v1/pingStandardMengesahkan bahawa kunci anda berfungsi daripada alamat yang didaftarkan untuknya, dan memaparkan semula alamat tersebut.
GET /v1/propertiesStandardPenyenaraian yang diterbitkan bagi negara yang diliputi oleh kunci anda, satu halaman pada satu masa.
GET /v1/insights/*LanjutanData pasaran agregat mengikut tempat dan tempoh, untuk kunci Lanjutan. Akan datang: endpoint ini belum aktif.

Kod ralat

Setiap ralat membawa status HTTP dan salah satu kod ini. Jadikan kod, bukan mesej, sebagai asas logik anda.

  • 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
Dapatkan kunci API andaLihat harga