Spacious HK API

Hong Kong Homes for Sale and Rent, Listing Details, Buildings and Agencies as JSON

Scrappa's read-only Spacious HK API turns the Spacious property portal for Hong Kong into structured JSON. Search homes for sale and rent by bedrooms, bathrooms, price, area, neighbourhood and building, read the full record of a listing with position, areas, rooms, features, photos, lister and agency, look up buildings and neighbourhoods, and read agency profiles with their listings. Results come in English or Traditional Chinese. Failed requests are never billed.

500 free credits
No card needed
From $0.20 / 1k
Pay as you go
Structured JSON
Ready for apps
API key access
Test in minutes
6
Endpoints
Hong Kong
Market
HKD
Prices

Try it now

Make one request. Inspect structured JSON.

Use the first endpoint in this API family with a Scrappa API key. Every account includes 500 free monthly credits, so you can validate the response shape before buying credits.

Request preview
Request
curl -X GET "https://scrappa.co/api/spacious-hk/search?mode=rent&bedrooms=2&price_min=20000&price_max=30000" \
  -H "Accept: application/json" \
  -H "X-API-KEY: YOUR_API_KEY"
JSON response
{
  "success": true,
  "data": {
    "mode": "rent",
    "page": 1,
    "per_page": 14,
    "total": 1209,
    "total_pages": 87,
    "filters": {"sort": "latest", "locale": "en", "bedrooms": 2, "price_min": 20000, "price_max": 30000},
    "listings": [
      {
        "id": "15093516",
        "price": 40000,
        "currency": "HKD",
        "net_area_sqft": 611,
        "bedrooms": 2,
        "building": {"id": 151318, "name": "Vantage Park Block 2"}
      }
    ]
  },
  "meta": {"endpoint_family": "search", "billable": true}
}

What you can build

Structured data for real applications. Here are some ideas.

Hong Kong Price Monitoring

Track asking prices and prices per square foot by neighbourhood and building, for sale and rent.

Relocation Tools

Find homes by bedrooms, bathrooms, rent and area for people who move to Hong Kong.

Building Research

Resolve a building name to its id, then list every home on offer in that building.

Agency Research

Read agency names and licence numbers and page through the listings of one agency.

Spacious HK scraper API

Spacious HK API for Hong Kong property search, listing details, buildings and agencies

The Spacious HK API is built for proptech teams, analysts and relocation services that work with the Hong Kong market. Search sale and rental listings by rooms, price, area and location, then use the listing, building and agency endpoints to complete the record.

Search homes for sale and for rent in Hong Kong.

Filter by bedrooms, bathrooms, price, net or gross area, neighbourhood and building.

Get full listing details with position, features, photos, lister and agency.

Resolve building and neighbourhood names to the ids the search takes.

Read agency profiles and page through the listings of an agency.

Call 6 read-only endpoints that return structured JSON.

Choose the right Spacious HK API endpoint

Find a building and list its homes

Look up a building by name. Pass its id as building_id and its neighbourhood_id to the search.

Open Spacious HK Autocomplete API docs

Search homes for sale or rent

Choose buy or rent, add the filters you need and page through the results, 14 listings per page.

Open Spacious HK Search API docs

Read the full record of a listing

Pass the path of a search result to the listing endpoint for photos, features, lister and agency.

Open Spacious HK Listing API docs

Available endpoints

Everything you need in one API.

GET

Search

/api/spacious-hk/search

Search homes for sale or rent with rooms, price, area, neighbourhood and building filters

GET

Autocomplete

/api/spacious-hk/autocomplete

Find buildings or neighbourhoods by name and get the ids the search filters on

Scrappa vs Do-it-yourself property data extraction

See how Scrappa compares to the official API.

Dedicated Spacious HK endpoints
Scrappa: yes (6 endpoints)
Do-it-yourself property data extraction:
Output format
Scrappa: Structured JSON
Do-it-yourself property data extraction: Raw page content
Filters honoured on every row
Scrappa:
Do-it-yourself property data extraction: Build your own checks
Request mode
Scrappa: Read-only
Do-it-yourself property data extraction: Depends on implementation
Parser maintenance
Scrappa: Handled by Scrappa
Do-it-yourself property data extraction: Your team

Key features

6 read-only endpoints for the Hong Kong market
Sale and rental listings with filters for rooms, price, area, neighbourhood and building
English and Traditional Chinese results
Full listing details with position, features, photos, lister and agency
Building and neighbourhood lookup, agency search and agency listings
Failed requests are never billed

Frequently asked questions

The Spacious HK API is Scrappa's read-only REST API for Hong Kong property listings. It covers search, listing details, building and neighbourhood lookup, building info, agency search and agency profiles.

No. Scrappa is an independent service and is not affiliated with or endorsed by Spacious. A Scrappa API key is used to access the endpoints on this page.

No. Spacious shows no phone numbers because contact goes through a form. The listing shows the name and licence of the lister and the agency.

The request fails with a clear error and is not billed. The API never returns listings that break a filter you asked for.

No. All Spacious HK endpoints on this page are read-only.

Start using the Spacious HK API

Sign up and get 500 free credits. No credit card required.