跳至主要內容

文件

整合所需的一切

指南、參考文件與規格皆由同一個 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 金鑰查看價格