Housing Market API 集成指南

参考表格、端点说明、错误代码和示例均根据 API 规范生成,在所有语言版本中均保留英文。名称、参数和代码在各处完全相同。

身份验证

请在每个请求的 x-api-key 请求头中发送您的密钥。

请将密钥保存在您的服务器上。切勿将其放入移动应用、网页或公开代码仓库:任何持有密钥的人都可以使用您的订阅。

一个密钥仅属于一个客户。请勿与其他公司共享;条款禁止这样做,而且我们能够看到密钥是从何处使用的。

一个密钥承载您的全部访问权限:您的国家和版本。当您添加国家或升级时,变化的是密钥的权限;您不会获得新密钥。

缺失、未知或已吊销的密钥会被拒绝并返回 unauthenticated。从未登记地址使用的有效密钥会被拒绝并返回 ip_not_allowed。已暂停的密钥会被拒绝并返回 key_paused。

示例请求

curl
curl -H "x-api-key: $HMA_API_KEY" \
  "https://api.housingmarketapi.com/v1/ping"