ข้ามไปยังเนื้อหาหลัก

เอกสาร

ทุกสิ่งที่คุณต้องใช้ในการเชื่อมต่อระบบ

คู่มือ เอกสารอ้างอิง และข้อกำหนดทางเทคนิคสร้างจากไฟล์ 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 ของคุณดูราคา