Démarrage
Démarrage rapide
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 corps JSON construit autour d'un arbre criteria (voir Filtrage) :
curl -X POST "https://api-v2.stream.estate/properties" \
-H "X-API-KEY: <votre_clé>" \
-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
}'Sans en-tête Accept, la réponse est au format JSON:API : les biens sont dans data[], la pagination dans meta (totalItems, hasNextPage, cursor), et les annonces / annonceurs complets dans included. Envoyez Accept: application/json pour un JSON « à plat ». Voir Format de réponse.
Récupérer une property précise
curl "https://api-v2.stream.estate/properties/<uuid>" \
-H "X-API-KEY: <votre_clé>"Prochaines étapes
- Filtrage — composer un arbre
criteriaavecand/or - Pagination — modes
PAGEetCURSOR - Alert — sauvegarder une recherche et recevoir des notifications