GET
List public listings

Query Parameters

q
string

Keyword over headline/description/property/room

city
string

Exact city filter

district
string

Exact district filter

ward
string

Exact ward filter

province_code
string

Official province code (issue #29); applied after resolving each listing's legacy location to the 2-tier model

Maximum string length: 20
ward_code
string

Official ward code (issue #29); same resolution as province_code

Maximum string length: 20
amenity
string

Single amenity filter

min_rent
string

Minimum monthly rent as a decimal string (ADR 0008)

max_rent
string

Maximum monthly rent as a decimal string (ADR 0008)

min_area
number<double>

Minimum area in m2

max_area
number<double>

Maximum area in m2

available_on
string

Available on or before this YYYY-MM-DD date

Response

Public vacant-room listings

data
object
required

Endpoint-specific response payload. See the referenced schema for the resource fields.

request_id
string
required

Request correlation identifier returned from X-Request-Id or generated by the API.

meta
object

Optional response metadata such as pagination limits, counts, or export context.