Aller au contenu principal

Documentation

Tout ce qu’il vous faut pour l’intégration

Le guide, la référence et la spécification sont générés à partir d’un seul fichier OpenAPI : ils concordent donc toujours. Les identifiants sont les mêmes dans toutes les langues.

  • Guide d’intégration

    Obtention d’une clé, authentification, filtres, pagination, limites et erreurs, dans votre langue.

    Ouvrir le guide

  • Spécification OpenAPI

    Le fichier OpenAPI 3.1 à partir duquel la référence est générée, pour les générateurs de code et les outils d’API.

    Télécharger la spécification

  • Guide PDF

    Le guide d’intégration en un seul document, à lire hors ligne ou à partager avec votre équipe.

    Télécharger le PDF

La documentation est publique. Une clé n’est nécessaire que pour appeler l’API.

Démarrage rapide

Vérifier votre clé et l’adresse que nous voyons
curl -H "x-api-key: $HMA_API_KEY" \
  "https://api.housingmarketapi.com/v1/ping"
Lire la première page d’annonces d’un pays
curl -H "x-api-key: $HMA_API_KEY" \
  "https://api.housingmarketapi.com/v1/properties?country=TH&listing_type=sale&property_type=condominium&limit=100"

En un coup d’œil

URL de base
https://api.housingmarketapi.com
Authentification
La clé dans l’en-tête x-api-key, envoyée depuis l’adresse de serveur enregistrée pour cette clé.

Endpoints

EndpointFormuleDescription
GET /v1/pingStandardConfirme que votre clé fonctionne depuis l’adresse pour laquelle elle est enregistrée, et renvoie cette adresse.
GET /v1/propertiesStandardLes annonces publiées d’un pays couvert par votre clé, une page à la fois.
GET /v1/insights/*AvancéeDonnées de marché agrégées par lieu et par période, pour les clés de la formule Avancée. Bientôt disponible : ces endpoints ne sont pas encore actifs.

Codes d’erreur

Chaque erreur comporte un statut HTTP et l’un de ces codes. Fiez-vous au code, pas au 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
Obtenir votre clé APIVoir les tarifs