Introduction
Technical documentation for the Stream Estate platform
Documentation for the Stream Estate API — real-estate listings aggregation with advanced search, alerts, and notification webhooks.
The v2 API is in Beta: stable and production-ready, but still growing (estimation endpoints, non-interactive key creation). Any breaking change is announced ahead of time in the changelog.
What you can do
One API key unlocks three actions: search properties via POST /properties, manage favorites on /favorite-properties, and create alerts on /alerts — which then trigger signed-webhook notifications.
Sections
Getting Started
API key and first call
Migration v1 → v2
Breaking changes and endpoint mapping
Concepts
Property, Source, Alert, Favorites, Analytics (soon), Geo
Guides
Filtering and pagination
Reference
Error codes
API Reference
All auto-generated routes from OpenAPI
Useful links
- Status — stream-estate.openstatus.dev