Démarrage
Quickstart
Votre premier appel à l'API Stream Estate
Une fois authentifié, lançons une recherche.
Rechercher des propriétés
Le point d'entrée de la recherche est POST /properties avec un body JSON :
curl -X POST "https://api-v2.stream.estate/properties" \
-H "X-API-Key: <votre_clé>" \
-H "Content-Type: application/json" \
-d '{
"transactionType": "SELL",
"propertyTypes": ["FLAT"],
"price": { "gte": 200000, "lte": 500000 },
"rooms": { "gte": 3 },
"cityIds": [75056],
"searchMode": "classic",
"paginationType": "page",
"page": 1,
"size": 10
}'L'API supporte JSON (application/json) ou JSON:API (application/vnd.api+json) selon l'en-tête Accept.
Exemple JavaScript
const res = await fetch("https://api-v2.stream.estate/properties", {
method: "POST",
headers: {
"X-API-Key": process.env.STREAM_ESTATE_KEY!,
"Content-Type": "application/json",
},
body: JSON.stringify({
transactionType: "SELL",
propertyTypes: ["FLAT"],
price: { gte: 200000, lte: 500000 },
searchMode: "classic",
paginationType: "page",
page: 1,
size: 10,
}),
});
const data = await res.json();
console.log(data.items, data.totalItems);Récupérer une property précise
curl "https://api-v2.stream.estate/properties/<uuid>" \
-H "X-API-Key: <votre_clé>"Rechercher par URL d'annonce
curl "https://api-v2.stream.estate/properties/search-by-url?url=<url_annonce>" \
-H "X-API-Key: <votre_clé>"Prochaines étapes
- Filtrage — tous les critères de recherche
- Pagination — curseur
search_after - Alert — sauvegarder une recherche et recevoir des notifications