Stream EstateStream Estate

Watch a property

Adds a property to your watchlist. Without notificationConfig the watch only keeps the property in your list and is free; with it, each notification costs a credit, as an alert's does. Nothing is sent about the property's past: notifications start from the property as it is now. An unknown property returns 404; one you already watch under the same alert, or under none, returns 409 with the id of that watch; NEW_MATCH at PROPERTY scope returns 422.

POST
/watchlist
X-API-KEY<token>

Value for the X-API-KEY header parameter.

In: header

Request Body

The new Watch resource

Response Body

curl -X POST "https://example.com/watchlist" \  -H "Content-Type: application/json" \  -d '{    "propertyId": "0198f5c4-3b0a-7c1e-9d2f-4a5b6c7d8e9f"  }'
{  "propertyId": "0198f5c4-3b0a-7c1e-9d2f-4a5b6c7d8e9f",  "alertId": "0198f5c4-1a2b-7c3d-8e4f-5a6b7c8d9e0f",  "expired": false,  "enabled": true,  "notificationConfig": {    "rules": [      {        "eventType": "PRICE_CHANGE",        "scope": "PROPERTY",        "variationPercent": [          {            "gte": -5,            "lte": -3          }        ]      }    ]  },  "eventDestination": "https://example.com/",  "signingKey": "whsec_abc123...",  "signingKeyHint": "b75b1473",  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  "createdAt": "2026-01-15T10:30:00+00:00",  "updatedAt": "2026-05-20T14:45:00+00:00"}
Version 0.32.429Last updated