Zum Hauptinhalt springen

Dokumentation

Alles, was Sie für die Integration brauchen

Leitfaden, Referenz und Spezifikation werden aus einer einzigen OpenAPI-Datei generiert und stimmen daher immer überein. Bezeichner sind in jeder Sprache gleich.

  • Integrationsleitfaden

    Schlüssel erhalten, Authentifizierung, Filter, Paginierung, Limits und Fehler — in Ihrer Sprache.

    Leitfaden öffnen

  • OpenAPI-Spezifikation

    Die OpenAPI 3.1-Datei, aus der die Referenz generiert wird, für Codegeneratoren und API-Tools.

    Spezifikation herunterladen

  • PDF-Leitfaden

    Der Integrationsleitfaden als ein einziges Dokument, zum Offline-Lesen oder zum Teilen mit Ihrem Team.

    PDF herunterladen

Die Dokumentation ist öffentlich. Einen Schlüssel benötigen Sie nur, um die API aufzurufen.

Schnellstart

Ihren Schlüssel und die Adresse prüfen, die wir sehen
curl -H "x-api-key: $HMA_API_KEY" \
  "https://api.housingmarketapi.com/v1/ping"
Die erste Seite der Inserate eines Landes abrufen
curl -H "x-api-key: $HMA_API_KEY" \
  "https://api.housingmarketapi.com/v1/properties?country=TH&listing_type=sale&property_type=condominium&limit=100"

Auf einen Blick

Basis-URL
https://api.housingmarketapi.com
Authentifizierung
Der Schlüssel im Header x-api-key, gesendet von der dafür registrierten Serveradresse.

Endpunkte

EndpunktStufeBeschreibung
GET /v1/pingStandardBestätigt, dass Ihr Schlüssel von der Adresse aus funktioniert, für die er registriert ist, und gibt diese Adresse zurück.
GET /v1/propertiesStandardVeröffentlichte Inserate für ein Land, das Ihr Schlüssel abdeckt, Seite für Seite.
GET /v1/insights/*AdvancedAggregierte Marktdaten nach Ort und Zeitraum, für Advanced-Schlüssel. Demnächst: Diese Endpunkte sind noch nicht live.

Fehlercodes

Jeder Fehler enthält einen HTTP-Status und einen dieser Codes. Werten Sie den Code aus, nicht die Meldung.

  • 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-Schlüssel erhaltenPreise ansehen