Without `mode` the endpoint returns the agency profile: the name, the licence number and a few current sale and rental listings. With `mode` it returns one page of all sale or rental listings of the agency, 10 per page, in the same shape as the search results, with the total. A page past the last page returns an empty list. Spacious has no page for single agents and shows no phone numbers or addresses. The name and licence of the agent come with each listing.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
1 required parameter needed before sending a request.
2 optional filters available.
string
Required
Agency id from the agency search or from the agency of a listing.
1234567890
string
Optional
Leave out for the profile. buy or rent returns one page of the listings of the agency.
example
integer
Optional
Page of the listings, 1-based, 10 per page. Used with mode.
1
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
data
meta
success
{
"data": {
"id": 420,
"url": "https://www.spacious.hk/en/c/hong-kong/agencies/420",
"name": "Universal Property Agency (Global) Limited",
"licence": "C-042851",
"rent_listings": [],
"sale_listings": [
{
"id": "15083275",
"price": 12800000,
"bedrooms": 2,
"currency": "HKD",
"bathrooms": 1,
"price_text": "HK$12.8M",
"net_area_sqft": 529,
"quality_agent": true,
"gross_area_sqft": 692
}
]
},
"meta": {
"billable": true,
"endpoint_family": "agency"
},
"success": true
}Errors
Handle these documented responses before retrying or showing customer-facing failures.
HTTP 404
The listing, building or agency does not exist or is no longer online. This response is not billable.
HTTP 422
A parameter is missing or invalid. This response is not billable.
HTTP 503
Spacious HK is temporarily unavailable, or its answer did not match the request, for example another page or an ignored filter. Retry the request. This response is not billable.
Generate Code with AI
Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.
Try It Live
Test this endpoint in our interactive playground with real data.