Getting started

Quickstart

Send your first listing in test mode. Nothing is published, and you get the same report a live delivery gets.

1. Create a test key

Create a developer account in the developer console, then a test key. Note the client ID, the secret (shown once) and your sandbox ID: SB and four letters.

2. Get an access token

Exchange the key for a token. It lasts an hour, so reuse it.

shell

curl -s https://liststream.com.au/oauth/token \
  -u "$CLIENT_ID:$CLIENT_SECRET" -d grant_type=client_credentials
# → { "access_token": "…", "token_type": "Bearer", "expires_in": 3600 }

3. Send a listing

Send a listing to your sandbox ID. It's checked like a live one, then reported and thrown away.

shell

curl -s -X PUT https://liststream.com.au/v1/listings/$SANDBOX_ID/SAMPLE-1 \
  -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  -d '{"type":"residential","status":"current","modifiedAt":"2026-11-10T09:30:00+10:00",
       "address":{"streetNumber":"12","street":"Sample Street","suburb":"Eumundi","state":"QLD","postcode":"4562"},
       "headline":"Sample home","price":{"text":"Offers over $750,000"},
       "agents":[{"name":"Jordan Hale","mobile":"0491 570 156"}]}'
# → 202 { "deliveryId": "…", "status": "queued", "report": "https://liststream.com.au/v1/deliveries/…" }

4. Read the report

Open the report URL from the answer, with the same token. Or add a webhook in the console and wait for delivery.completed (Webhooks).

5. Go live

Create a live key, ask each agency to connect (Connections), and send its listings with its ListStream ID instead of your sandbox ID. Every endpoint is in the API reference.