Notifications
The SDK consumes a shared realtime notification service where the solver publishes quote and position state transitions (instant open accepted, price filled, close requested, failures, and so on). It exposes that service two ways: a WebSocket live stream for real-time updates, and a REST search over stored history for backfill, replay, or audit.
Both surfaces deliver the same normalized Notification shape, so a UI can consume live and historical frames through one code path. The stream reuses the SDK’s shared, reconnecting socket pool; the search hits the service’s POST /api/v1/search endpoint.
Each method and type has its own page with the full signature, parameters, return shape, and examples.
Live stream
REST search
Helpers
Turn a raw wire frame into a normalized Notification.
Classify a raw action_status into a NotificationType.
Parse an inbound socket frame into a raw notification, or null for control/malformed frames.
Build the JSON subscribe frame sent on every (re)connect.
Types
The normalized, classified notification the SDK delivers to consumers.
RawPositionNotificationThe snake_case wire frame as it arrives from the service.
NotificationTypeBroad classification derived from a frame’s action_status.
Free-form equality filter accepted by searchNotifications.
Normalized result of a notification search: total, count, documents.
Related
- WebSocket concept — the pooled, reconnecting socket primitive and the
SocketStatuslifecycle behindwatchNotifications. - Unified Quotes —
classifyQuoteNotificationActionandapplyNotificationToQuotesconsume these frames, but live in the quotes domain, not here. - TP/SL — conditional-order state transitions arrive on a separate channel with their own frame shape.
- React
useNotifications— the hook wrapper over this stream and search for React apps.