Lompat ke konten utama

Dokumentasi

Semua yang Anda butuhkan untuk integrasi

Panduan, referensi, dan spesifikasi dihasilkan dari satu file OpenAPI, sehingga ketiganya selalu selaras. Pengenal sama di setiap bahasa.

  • Panduan integrasi

    Mendapatkan kunci, autentikasi, filter, paginasi, batas, dan kesalahan, dalam bahasa Anda.

    Buka panduan

  • Spesifikasi OpenAPI

    File OpenAPI 3.1 yang menjadi sumber referensi, untuk generator kode dan alat API.

    Unduh spesifikasi

  • Panduan PDF

    Panduan integrasi dalam satu dokumen, untuk dibaca secara luring atau dibagikan kepada tim Anda.

    Unduh PDF

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

Mulai cepat

Periksa kunci Anda dan alamat yang kami lihat
curl -H "x-api-key: $HMA_API_KEY" \
  "https://api.housingmarketapi.com/v1/ping"
Baca halaman pertama listing untuk suatu 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"

Sekilas

URL dasar
https://api.housingmarketapi.com
Autentikasi
Kunci di header x-api-key, dikirim dari alamat server yang terdaftar untuk kunci tersebut.

Endpoint

EndpointTingkatDeskripsi
GET /v1/pingStandarMemastikan kunci Anda berfungsi dari alamat tempat kunci tersebut terdaftar, dan menampilkan kembali alamat itu.
GET /v1/propertiesStandarListing yang diterbitkan untuk negara yang dicakup kunci Anda, satu halaman setiap kali.
GET /v1/insights/*LanjutanData pasar agregat per tempat dan periode, untuk kunci Lanjutan. Segera hadir: endpoint ini belum aktif.

Kode kesalahan

Setiap kesalahan membawa status HTTP dan salah satu kode berikut. Jadikan kode, bukan pesannya, sebagai dasar logika 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