คู่มือการผสานรวม Housing Market API

ตารางอ้างอิง คำอธิบายเอนด์พอยต์ รหัสข้อผิดพลาด และตัวอย่าง สร้างขึ้นจากสเปกของ API และคงเป็นภาษาอังกฤษในทุกภาษา ชื่อ พารามิเตอร์ และรหัสจะเหมือนกันทุกที่

การแบ่งหน้า

เอนด์พอยต์ที่ส่งคืนรายการทุกตัวใช้เคอร์เซอร์ การตอบกลับจะมี data next_cursor และ has_more

ส่ง next_cursor จากการตอบกลับหนึ่งเป็น cursor ของคำขอถัดไป และหยุดเมื่อ has_more เป็น false

ไม่มียอดรวมและไม่มีหมายเลขหน้า ซึ่งเป็นการออกแบบโดยเจตนา เพราะ API สร้างขึ้นเพื่อค้นหาประกาศ ไม่ใช่เพื่อคัดลอกฐานข้อมูล

พารามิเตอร์ limit กำหนดขนาดหน้า ค่าเริ่มต้นคือ 50 และต้องไม่เกิน 100

เคอร์เซอร์เป็นค่าทึบ (opaque) อย่าแยกวิเคราะห์ สร้างขึ้นเอง หรือเก็บไว้ใช้ภายหลัง เคอร์เซอร์ผูกกับคีย์ของคุณและกับตัวกรองของคำขอที่สร้างเคอร์เซอร์นั้น และเคอร์เซอร์ที่ไม่ถูกต้องจะถูกปฏิเสธด้วย invalid_cursor

ผลลัพธ์จะมาในลำดับที่คงที่ตลอดการไล่หน้าแต่ละรอบ แต่ลำดับนั้นไม่มีความหมายใด ๆ โปรดอย่าพึ่งพาลำดับนี้

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 `50` min `1` max `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`.