# Spacious HK Listing API

<p>Get the full record of one Spacious listing: the exact price, the position and address, net and gross area with price per square foot, bedrooms, bathrooms, neighbourhood, estate and building, features, every photo, the price estimates and price history of Spacious, the lister with licence, and the agency when the listing has one. Individual listers have no agency. Pass the `path` field of a search result. Spacious shows no phone numbers because contact goes through a form. A listing that is no longer online answers 404.</p>

- **Documentation:** [https://scrappa.co/docs/spacious-hk-api/spacious_hk_listing](https://scrappa.co/docs/spacious-hk-api/spacious_hk_listing)
- **API group:** Spacious HK API
- **Endpoint:** `GET https://scrappa.co/api/spacious-hk/listing`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `path` | string | Yes | Listing path from the `path` field of a search result, e.g. `/en/hong-kong/41-kennedy-town/151360--the-merton-tower-3/15093484-studio-1-bath`. A `/zh-tw/` path returns Chinese names. |

## Example response

```json
{
    "data": {
        "id": "15093484",
        "url": "https://www.spacious.hk/en/hong-kong/41-kennedy-town/151360--the-merton-tower-3/15093484-studio-1-bath",
        "mode": "buy",
        "price": 7680000,
        "title": "Studio, HK$7.68M, For Sale, 38, New Praya Kennedy Town (The Merton Tower 3)",
        "agency": {
            "id": 420,
            "name": "Universal Property Agency (Global) Limited",
            "licence": "C-042851"
        },
        "images": [
            "https://cdn.spacious.hk/uploads/property_image/143824810/image/large_thumb-c099c7b5a3ef.jpg"
        ],
        "lister": {
            "name": "Alex Lee",
            "licence": "C-042851",
            "quality_agent": true
        },
        "address": "38, New Praya Kennedy Town",
        "details": [
            {
                "label": "Floor",
                "value": "Low level"
            }
        ],
        "bedrooms": 0,
        "building": {
            "id": 151360,
            "name": "The Merton Tower 3"
        },
        "currency": "HKD",
        "features": [
            "Balcony",
            "Club House",
            "Gym",
            "Pool",
            "Lift"
        ],
        "latitude": 22.283481,
        "bathrooms": 1,
        "longitude": 114.1261299,
        "availability": "InStock",
        "spacious_ref": "S15093484",
        "neighbourhood": {
            "id": 41,
            "name": "Kennedy Town"
        },
        "net_area_sqft": 313,
        "price_history": [
            {
                "label": "Earliest",
                "price": 7680000
            }
        ],
        "gross_area_sqft": 401,
        "net_price_per_sqft": 24537
    },
    "meta": {
        "billable": true,
        "endpoint_family": "listing"
    },
    "success": true
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
|  | The listing, building or agency does not exist or is no longer online. This response is not billable. |  |
|  | A parameter is missing or invalid. This response is not billable. |  |
|  | 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. |  |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)