Documentación
Todo lo que necesita para la integración
La guía, la referencia y la especificación se generan a partir de un único archivo OpenAPI, así que siempre coinciden. Los identificadores son los mismos en todos los idiomas.
Guía de integración
Obtención de la clave, autenticación, filtros, paginación, límites y errores, en su idioma.
Especificación OpenAPI
El archivo OpenAPI 3.1 a partir del cual se genera la referencia, para generadores de código y herramientas de API.
Guía en PDF
La guía de integración en un solo documento, para leerla sin conexión o compartirla con su equipo.
La documentación es pública. Solo necesita una clave para llamar a la API.
Inicio rápido
curl -H "x-api-key: $HMA_API_KEY" \
"https://api.housingmarketapi.com/v1/ping"curl -H "x-api-key: $HMA_API_KEY" \
"https://api.housingmarketapi.com/v1/properties?country=TH&listing_type=sale&property_type=condominium&limit=100"De un vistazo
- URL base
https://api.housingmarketapi.com- Autenticación
- La clave en el encabezado x-api-key, enviada desde la dirección de servidor registrada para ella.
Endpoints
| Endpoint | Nivel | Descripción |
|---|---|---|
| GET /v1/ping | Estándar | Confirma que su clave funciona desde la dirección para la que está registrada y le devuelve esa dirección. |
| GET /v1/properties | Estándar | Anuncios publicados de un país que cubre su clave, página a página. |
| GET /v1/insights/* | Avanzado | Datos de mercado agregados por lugar y periodo, para claves Avanzado. Próximamente: estos endpoints aún no están activos. |
Códigos de error
Cada error incluye un estado HTTP y uno de estos códigos. Base su lógica en el código, no en el mensaje.
invalid_parameterinvalid_cursorunauthenticatedip_not_allowedkey_pausedcountry_not_entitledupgrade_requirednot_foundmethod_not_allowedrate_limitedquota_exceededinternal_errornot_configuredservice_unavailable