What you get
| Field | Type | Sample value |
|---|---|---|
title |
string | 71 Sheriff Avenue, Sydney, NS, B1P 2P6 |
price |
number | 289900 |
description |
string | Welcome to 71 Sheriff Avenue, a spacious four-bedroom home located in the heart… |
url |
string | rew.ca/properties/71-sheriff-avenue-sydne… |
bathrooms |
integer | 2 |
bookmarkable_type |
string | Listing::ForSale |
displaycard_banner |
string | Virtual Tour |
floor_area |
integer | 1497 |
All 39 fields
Key fields
titlepricedescriptionurlbathroomsbookmarkable_typedisplaycard_bannerfloor_arealisting_agent_or_brokeragesrcaddressagent_nameamenitiesbasement_detailsbedscategoryexterior_finishheating_typelisting_boardlisting_sourcelisting_urlmls_numberparking_detailsphotophoto_brandedproperty_typeproperty_viewstitle_typeappliancesvirtual_tour
Technical fields
category_pathdetail_bathroomsdetail_floor_areaidlisting_agentofficetypetyped_pricetyped_property_views
Every field with its type, and the schemas, are in contract.json.
Sample records
1 of 2 saved records. This is a saved sample, not a live run.
title |
price |
description |
url |
bathrooms |
bookmarkable_type |
|---|---|---|---|---|---|
| 71 Sheriff Avenue, Sydney, NS, B1P 2P6 | 289900 | Welcome to 71 Sheriff Avenue, a spacious four-bedroom home located in the heart… | rew.ca/properties/71-sheriff-avenue-sydne… | 2 | Listing::ForSale |
Scroll sideways to see more columns.
Inputs
-
num_bedroomschoiceOptional. Filters by the site's num bedrooms control.
enrich_records is on by default and adds the fields that only appear on each record's detail page. Send false to read list fields only. See Run an API.
Request
POST https://api.cleanedweb.com/v1/catalog/public/apis/generated_6b7aefb9818e954183d2ac31/endpoints/generated_6b7aefb9818e954183d2ac31_search/run
curl -X POST https://api.cleanedweb.com/v1/catalog/public/apis/generated_6b7aefb9818e954183d2ac31/endpoints/generated_6b7aefb9818e954183d2ac31_search/run \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Idempotency-Key: UNIQUE_REQUEST_ID" \
-H "Content-Type: application/json" \
-d '{
"input": {
"num_bedrooms": "1"
},
"version": 1,
"max_items": 25
}'
Save the Idempotency-Key before you send, and reuse it only to retry the same request. The key needs the run scope. See Run a catalog API.
version pins major v1, whose newest minor (1.0) answers. Leave it out and the call runs on the latest major.
Changelog
-
v1.0 (major) ·
Use it from an AI agent
Open in your coding agent
Add CleanedWeb to your agent as an MCP server, such as a custom connector in Claude or ChatGPT, then sign in with your CleanedWeb account. The agent can then find this API, run it and read the records. An API key with the read and run scopes works too.
https://api.cleanedweb.com/mcp?profile=catalog
Then ask, for example: Use CleanedWeb to get 25 records from the REW Sydney NS Houses for Sale API.
The agent calls get_api with generated_6b7aefb9818e954183d2ac31, then run_api. Runs are charged like any other run. See Connect an MCP client.
Coverage
- Category
- Real estate
Reach. A run reads until the source ends or your max_items, timeout_seconds or budget stops it.
CleanedWeb is not affiliated with REW.