Developers API

Realtime Event Engine

WebSocket streaming, event webhooks, payload schemas, rule conditions, delivery lifecycle, signature verification, event history, and errors.

Event Rules

Rules evaluate market conditions and trigger webhook events.

Supported Event Types

price_alertlarge_moveabnormal_volumeunusual_value_traded

POST /api/v1/alerts/

  • Required: symbol, event_type, condition, value, webhook_id
  • Optional: once, config

GET /api/v1/alerts/

List existing rules and filter by status.

  • Query: status=active|paused|all
  • Status enum: active, paused, and triggered.
  • Mapping: once maps to stored/returned fire_once.