Ana içeriğe geç

Dokümantasyon

Entegrasyon için ihtiyacınız olan her şey

Kılavuz, referans ve spesifikasyon tek bir OpenAPI dosyasından üretilir; bu yüzden her zaman birbiriyle tutarlıdır. Tanımlayıcılar her dilde aynıdır.

  • Entegrasyon kılavuzu

    Anahtar alma, kimlik doğrulama, filtreler, sayfalama, limitler ve hatalar; kendi dilinizde.

    Kılavuzu açın

  • OpenAPI spesifikasyonu

    Referansın üretildiği OpenAPI 3.1 dosyası; kod üreteçleri ve API araçları için.

    Spesifikasyonu indirin

  • PDF kılavuz

    Çevrimdışı okumak veya ekibinizle paylaşmak için tek belge hâlinde entegrasyon kılavuzu.

    PDF'yi indirin

Dokümantasyon herkese açıktır. Anahtara yalnızca API'yi çağırmak için ihtiyacınız vardır.

Hızlı başlangıç

Anahtarınızı ve bizim gördüğümüz adresi kontrol edin
curl -H "x-api-key: $HMA_API_KEY" \
  "https://api.housingmarketapi.com/v1/ping"
Bir ülke için ilanların ilk sayfasını okuyun
curl -H "x-api-key: $HMA_API_KEY" \
  "https://api.housingmarketapi.com/v1/properties?country=TH&listing_type=sale&property_type=condominium&limit=100"

Bir bakışta

Temel URL
https://api.housingmarketapi.com
Kimlik doğrulama
Anahtar, x-api-key başlığında ve kendisi için kaydedilen sunucu adresinden gönderilir.

Uç noktalar

Uç noktaPaketAçıklama
GET /v1/pingStandartAnahtarınızın kayıtlı olduğu adresten çalıştığını doğrular ve bu adresi geri döndürür.
GET /v1/propertiesStandartAnahtarınızın kapsadığı bir ülke için yayınlanmış ilanlar, her seferinde bir sayfa.
GET /v1/insights/*GelişmişYere ve döneme göre toplulaştırılmış pazar verileri, Gelişmiş paket anahtarları için. Yakında: bu uç noktalar henüz etkin değil.

Hata kodları

Her hata bir HTTP durumu ve bu kodlardan birini taşır. Mesaja göre değil, koda göre karar verin.

  • 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
API anahtarınızı alınFiyatları görün