API access requires a separate API Access subscription plan. Your standard StratAlerts subscription does not include API access. Subscribe at app.stratalerts.com to get started.
Delivery modes
REST
Request historical data, current snapshots, and batch lookups over HTTPS. Best for periodic polling, backtesting, and on-demand queries.
WebSocket
Maintain a persistent connection and receive pushed updates as they happen. Best for live dashboards, execution systems, and alert ingestion.
Base URLs
| Transport | Base URL |
|---|---|
| REST | https://app.stratalerts.com/api/market/v1 |
| WebSocket | wss://app.stratalerts.com/ws/market/v1 |
REST endpoints
Every endpoint requires a valid API key with the appropriate scope. See Authentication for how to pass your key.| Method | Path | Scope | Description |
|---|---|---|---|
GET | /instruments | metadata:read | List instruments with name, exchange, type, and sector |
GET | /instruments/{symbol} | metadata:read | Fetch metadata for a single instrument |
GET | /prices/latest | prices:read | Latest trade price for one or more symbols |
GET | /candles/{symbol} | candles:read | OHLCV bars at any supported timeframe |
GET | /states/{symbol} | states:read | TFC color state and active setups for a symbol |
GET | /setups/current | states:read | All active Strat setups across the scan universe |
GET | /alerts/in-force | alerts:read | In-force alerts within a rolling time window |
GET | /alerts/simultaneous-breaks | alerts:read | Simultaneous break alerts across timeframes |
GET | /market-status | metadata:read | Current market open/close status and session times |
WebSocket channels
After connecting towss://app.stratalerts.com/ws/market/v1, you subscribe to channels by sending a JSON message with "op": "subscribe". Your key must have ws:connect scope plus the scope corresponding to each channel.
| Channel | Scope | Description |
|---|---|---|
quotes | prices:read | Real-time trade price updates for subscribed symbols |
states | states:read | Live TFC state changes and setup updates per symbol |
alerts.in_force | alerts:read | Pushed in-force alert events as they fire |
alerts.simultaneous_breaks | alerts:read | Pushed simultaneous break alert events |
Quick example
The following request fetches the current market status usingcurl. Replace YOUR_API_KEY with your actual key.
Error format
All error responses use a consistent JSON envelope regardless of the endpoint or HTTP status code.Next steps
Authentication
Learn how to obtain an API key, pass it in requests, and understand scope requirements.
Rate limits
Understand per-key throughput limits, burst behavior, and WebSocket connection rules.