Hướng dẫn tích hợp Housing Market API
Các bảng tham chiếu, mô tả endpoint, mã lỗi và ví dụ được tạo từ đặc tả API và được giữ nguyên bằng tiếng Anh ở mọi ngôn ngữ. Tên, tham số và mã đều giống nhau ở mọi nơi.
Phân trang
Mọi endpoint trả về danh sách đều dùng con trỏ. Phản hồi chứa data, next_cursor và has_more.
Truyền next_cursor của một phản hồi làm cursor của yêu cầu tiếp theo, và dừng lại khi has_more là false.
Không có tổng số và không có số trang. Đây là chủ ý thiết kế: API được xây dựng để tra cứu tin đăng, không phải để sao chép cơ sở dữ liệu.
Tham số limit đặt kích thước trang. Giá trị mặc định là 50 và không được vượt quá 100.
Con trỏ là giá trị không minh bạch (opaque). Không phân tích cú pháp, tự tạo hay lưu lại con trỏ để dùng sau. Con trỏ gắn với khóa của bạn và với các bộ lọc của yêu cầu đã tạo ra nó, và con trỏ không hợp lệ sẽ bị từ chối với invalid_cursor.
Kết quả được trả về theo thứ tự ổn định trong một lượt duyệt, nhưng thứ tự đó không mang ý nghĩa gì. Đừng dựa vào nó.
Response shape
| Field | Type | Description |
|---|---|---|
data required | array | The items on this page. |
next_cursor required | string | null | Pass as cursor to get the next page. Null on the last page. |
has_more required | boolean | False when there is no further page. |
Request parameters
| Parameter | Type | Required | Values | Description |
|---|---|---|---|---|
limit | integer | no | default 50min 1max 100 | Page size. At most the maximum shown; larger values are refused with invalid_parameter. |
cursor | string | no | The next_cursor of the previous page. Opaque: do not parse it, store
it, or build one. It is bound to your key and to the filters of the
request that produced it, and a cursor used with different filters is
refused with invalid_cursor. |