Getting Started
Quickstart
Your first call to the Stream Estate API
Once authenticated, let's run a search.
Search properties
The search entry point is POST /properties with a JSON body built around a criteria tree (see Filtering):
curl -X POST "https://api-v2.stream.estate/properties" \
-H "X-API-KEY: <your_key>" \
-H "Content-Type: application/json" \
-d '{
"criteria": {
"property": {
"type": { "in": ["FLAT"] },
"transaction": { "type": "SELL" },
"pricing": { "displayed": { "gte": 200000, "lte": 500000 } },
"unit": { "rooms": { "gte": 3 } },
"locations": {
"countryCode": "FR",
"in": { "uniqueCodes": ["75056"] }
}
}
},
"paginationType": "PAGE",
"page": 1,
"size": 10
}'Without an Accept header, the response is JSON:API: properties are under data[], pagination under meta (totalItems, hasNextPage, cursor), and full listings / publishers under included. Send Accept: application/json for flat JSON. See Response format.
Fetch a specific property
curl "https://api-v2.stream.estate/properties/<uuid>" \
-H "X-API-KEY: <your_key>"Next steps
- Filtering — compose a
criteriatree withand/or - Pagination —
PAGEandCURSORmodes - Alert — save a search and get notified