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"