跳到主要内容

文档

集成所需的一切

指南、参考文档和规范均由同一个 OpenAPI 文件生成，因此始终保持一致。标识符在所有语言中完全相同。

  • 集成指南

    以您的语言介绍如何获取密钥，以及身份验证、筛选条件、分页、限制和错误。

    打开指南

  • OpenAPI 规范

    生成参考文档所用的 OpenAPI 3.1 文件，适用于代码生成器和 API 工具。

    下载规范

  • PDF 指南

    整合为一份文档的集成指南，可离线阅读或与团队共享。

    下载 PDF

文档公开提供。只有调用 API 时才需要密钥。

快速入门

检查您的密钥以及我们看到的地址
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"

概览

基础 URL
https://api.housingmarketapi.com
身份验证
在 x-api-key 请求头中发送密钥，并从为其登记的服务器地址发出请求。

端点

端点级别说明
GET /v1/ping标准版确认您的密钥可从其登记的地址正常使用，并回显该地址。
GET /v1/properties标准版您的密钥所覆盖国家的已发布房源，每次返回一页。
GET /v1/insights/*高级版按地点和时期汇总的市场数据，适用于高级版密钥。即将推出：这些端点尚未上线。

错误代码

每个错误都带有 HTTP 状态码和以下代码之一。请根据代码而不是消息文本进行分支处理。

  • 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 密钥查看价格