Arbitrage
WS·arb·Pro Tier+·
Alerts when our arb engine finds or updates a cross-platform opportunity for a subscribed match group, and when an opportunity expires.
Overview
Use case: Drive arb terminals and notifications tied to match groups you care about.
Requirements
- Pro or Enterprise API key.
- Subscribe with group_ids only (match group ids).
- market_ids are ignored for this channel.
Send
| Field | Type | Required | Notes |
|---|---|---|---|
| action | string | yes | Must be "subscribe" for this section. |
| channel | string | yes | Must be "arb". |
| market_ids | string[] | unsupported | Ignored / not used by this channel. |
| group_ids | number[] | optional | Group scope; expands to markets linked to each group. |
| wildcard | behavior | not available | At least one supported id list should be provided. |
Receive
Data messages use the standard envelope: channel, type, ts, data. Types for this channel include: arb_update, arb_expired.
Data fields (inside data)
| Field | Type | Description |
|---|---|---|
| type | string | arb_update or arb_expired. |
| group_id | number | Match group id. |
| profit_pct / roi | number? | When present on updates from the worker. |
| yes_price / no_price | number? | Leg prices when present. |
| yes_src / no_src | string? | Venues for each leg when present. |