Getting started
ListStream developer docs
ListStream publishes each agency's listings as pages that AI assistants and search engines can read. These docs are for CRMs, website platforms and integrators that send listings for many agencies, and for anyone reading the published data.
QuickstartGet a token and send a test listing in a few minutes.Listings API (JSON)Create, update, change the status of and remove listings.REAXMLSend the files you already make, by API, FTP, SFTP or HTTPS push.WebhooksSigned events when deliveries finish and agencies connect.API referenceEvery endpoint, parameter and schema, from the OpenAPI spec.Reading listingsListing JSON, structured data, llms.txt and crawler access.
How it works
- Create a developer account in the developer console and build against test mode: deliveries are checked and reported, never published.
- Ask each agency to connect with its six-letter ListStream ID. The agency approves you in its dashboard (Connections).
- Send its listings as JSON or REAXML. Every delivery gets a per-listing report, and a webhook when it's done.
Ways to send listings
- Listings API
- JSON, one listing per request. Listings API
- REAXML upload API
- Shaped like realestate.com.au's Listing Upload API, so existing code can point here. REAXML upload API
- FTP and SFTP
- The way CRMs already send to the portals; no code needed. FTP and SFTP
- HTTPS push
- POST REAXML with the agency's push token. HTTPS push
The basics
- Base URL
https://liststream.com.au- Auth
- OAuth 2.0 client credentials; Bearer tokens that last an hour. Keys and tokens
- Format
- JSON in and out (REAXML for the upload endpoints). Times are ISO 8601 with a time zone.
- Fees
- None from ListStream.
- Spec
- OpenAPI 3.1, for code generators and API tools.
Agencies have their own, non-technical guide: For agencies and agents. CRM providers can read what connecting involves on For CRM providers.