คู่มือการผสานรวม Housing Market API
ตารางอ้างอิง คำอธิบายเอนด์พอยต์ รหัสข้อผิดพลาด และตัวอย่าง สร้างขึ้นจากสเปกของ API และคงเป็นภาษาอังกฤษในทุกภาษา ชื่อ พารามิเตอร์ และรหัสจะเหมือนกันทุกที่
ตัวกรอง
ต้องระบุพารามิเตอร์ country ตัวกรองอื่นทุกตัวจะจำกัดผลลัพธ์ให้แคบลง และสามารถใช้ตัวกรองร่วมกันได้
พารามิเตอร์ที่เอนด์พอยต์ไม่ได้กำหนดไว้จะถูกปฏิเสธด้วย invalid_parameter แทนที่จะถูกเพิกเฉย เพื่อไม่ให้ตัวกรองที่สะกดผิดส่งคืนหน้าที่ไม่ได้กรองโดยไม่มีการแจ้งเตือน
สามารถกรองสถานที่ตามตัวระบุหรือตามชื่อ การจับคู่ชื่อไม่คำนึงถึงตัวพิมพ์เล็กหรือใหญ่ สำหรับแต่ละระดับ ให้ใช้ชื่อหรือตัวระบุอย่างใดอย่างหนึ่ง ไม่ใช่ทั้งสองอย่าง
ตัวกรองราคาจะเปรียบเทียบตัวเลขตามที่เผยแพร่ ในสกุลเงินของแต่ละประกาศเอง ไม่มีการแปลงสกุลเงินใด ๆ
เคอร์เซอร์ผูกกับตัวกรองที่ใช้ตอนออกเคอร์เซอร์นั้น หากต้องการเปลี่ยนตัวกรอง ให้เริ่มใหม่จากหน้าแรก
พารามิเตอร์ของ GET /v1/properties
| Parameter | Type | Required | Values | Description |
|---|---|---|---|---|
country | string | yes | pattern ^[A-Z]{2}$ | ISO 3166-1 alpha-2 code of the country, for example TH. A country
outside your subscription is refused with country_not_entitled. |
listing_type | string | no | all sale rentdefault all | Which kind of listing to include. all is the default. |
property_type | string | no | Return only this property type, for example condominium. The value
is the property_type that listings carry; an unknown value returns
an empty page. | |
province_id | integer | no | min 1 | Return only listings in this province or state, by the province_id listings carry. |
city | string | no | Return only listings in this city, matched by name without regard to
case. Do not combine with city_id. | |
city_id | integer | no | min 1 | Return only listings in this city, by the city_id listings carry. |
area | string | no | Return only listings in this district or area, matched by name
without regard to case. Do not combine with area_id. | |
area_id | integer | no | min 1 | Return only listings in this district or area, by the area_id listings carry. |
min_price | number | no | min 0 | Lowest price to include, in the listing's own currency. Prices are never converted, so in a country with listings in more than one currency the filter compares the number as published. |
max_price | number | no | min 0 | Highest price to include, in the listing's own currency. |
min_bedrooms | integer | no | min 0 | Fewest bedrooms to include. Listings that do not state a number of bedrooms are left out. |
max_bedrooms | integer | no | min 0 | Most bedrooms to include. Listings that do not state a number of bedrooms are left out. |
published_since | string | no | Return only listings first published at or after this instant: a date
(YYYY-MM-DD, read as midnight UTC) or a date-time with a time zone,
for example 2026-10-01T00:00:00Z. A date-time without a time zone is
refused with invalid_parameter. | |
updated_since | string | no | Return only listings whose last_updated is at or after this instant,
in the same format as published_since. Use it to fetch what changed
since your last walk. A listing that has been withdrawn is not
returned; request it by id to confirm it is gone. | |
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. |