Chuyển đến nội dung chính

Tài liệu

Mọi thứ bạn cần để tích hợp

Hướng dẫn, tài liệu tham chiếu và đặc tả đều được tạo từ một tệp OpenAPI duy nhất, nên luôn khớp nhau. Các định danh giống nhau ở mọi ngôn ngữ.

  • Hướng dẫn tích hợp

    Lấy khóa, xác thực, bộ lọc, phân trang, giới hạn và lỗi, bằng ngôn ngữ của bạn.

    Mở hướng dẫn

  • Đặc tả OpenAPI

    Tệp OpenAPI 3.1 dùng để tạo tài liệu tham chiếu, dành cho các trình sinh mã và công cụ API.

    Tải đặc tả

  • Hướng dẫn PDF

    Hướng dẫn tích hợp trong một tài liệu duy nhất, để đọc ngoại tuyến hoặc chia sẻ với nhóm của bạn.

    Tải PDF

Tài liệu được công khai. Bạn chỉ cần khóa khi gọi API.

Bắt đầu nhanh

Kiểm tra khóa của bạn và địa chỉ mà chúng tôi nhận được
curl -H "x-api-key: $HMA_API_KEY" \
  "https://api.housingmarketapi.com/v1/ping"
Đọc trang tin đăng đầu tiên của một quốc gia
curl -H "x-api-key: $HMA_API_KEY" \
  "https://api.housingmarketapi.com/v1/properties?country=TH&listing_type=sale&property_type=condominium&limit=100"

Tóm tắt nhanh

URL cơ sở
https://api.housingmarketapi.com
Xác thực
Khóa trong header x-api-key, gửi từ địa chỉ máy chủ đã đăng ký cho khóa đó.

Endpoint

EndpointGóiMô tả
GET /v1/pingTiêu chuẩnXác nhận khóa của bạn hoạt động từ địa chỉ đã đăng ký và trả lại địa chỉ đó.
GET /v1/propertiesTiêu chuẩnTin đăng đã xuất bản cho một quốc gia mà khóa của bạn bao phủ, mỗi lần một trang.
GET /v1/insights/*Nâng caoDữ liệu thị trường tổng hợp theo địa điểm và thời kỳ, dành cho khóa gói Nâng cao. Sắp ra mắt: các điểm cuối này chưa hoạt động.

Mã lỗi

Mỗi lỗi đều có mã trạng thái HTTP và một trong các mã sau. Hãy rẽ nhánh theo mã, không theo thông báo.

  • 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
Nhận khóa APIXem bảng giá