Streaming API Reference
Market price subscription (price availability subject to account permissions)
Item | Field | Description |
---|---|---|
MARKET:{epic} (MERGE mode) | MID_OPEN | Opening mid price |
HIGH | Intraday high price | |
LOW | Intraday low price | |
CHANGE | Price change compared with open value | |
CHANGE_PCT | Price percent change compared with open value | |
UPDATE_TIME | Publish time of last price update (UK local time, i.e. GMT or BST) | |
MARKET_DELAY | Delayed price (0=false, 1=true) | |
MARKET_STATE | Market status: CLOSED, OFFLINE, TRADEABLE, EDIT, AUCTION, AUCTION_NO_EDIT, SUSPENDED | |
BID | Bid price | |
OFFER | Offer price | |
STRIKE_PRICE | Strike price (Sprint markets) | |
ODDS | Trade odds (Sprint markets) |
Account subscription
Item | Field | Description |
---|---|---|
ACCOUNT:{account identifier} (MERGE mode) | PNL | Account profit and loss value |
DEPOSIT | Account minimum deposit value required for margins | |
AVAILABLE_CASH | Amount cash available to trade value, after account balance, profit and loss and minimum deposit amount have been considered | |
PNL | Profit/Loss | |
PNL_LR | Profit/Loss Limited Risk | |
PNL_NLR | Profit/Loss Non-limited Risk | |
FUNDS | Funds | |
MARGIN | Margin | |
MARGIN_LR | Margin Limited Risk | |
MARGIN_NLR | Margin Non-limited Risk | |
AVAILABLE_TO_DEAL | Available to Trade | |
EQUITY | Equity | |
EQUITY_USED | Equity Used |
Trade subscription
Item | Field | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
TRADE:{account identifier} (DISTINCT mode) |
CONFIRMS |
Trade confirmations for an account
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||
OPU | Open position updates for an account
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||
WOU | Working order updates for an account
|
Chart subscriptions - Tick data
Item | Field | Description |
---|---|---|
CHART:{epic}:TICK (DISTINCT mode) | BID | Bid price |
OFR | Offer price | |
LTP | Last traded price | |
LTV | Last traded volume | |
TTV | Incremental trading volume | |
UTM | Update time (as milliseconds from the Epoch) | |
DAY_OPEN_MID | Mid open price for the day | |
DAY_NET_CHG_MID | Change from open price to current (MID price) | |
DAY_PERC_CHG_MID | Daily percentage change (MID price) | |
DAY_HIGH | Daily high price (MID) | |
DAY_LOW | Daily low price (MID) |
Chart subscriptions - Consolidated (candle) data
Item | Field | Description |
---|---|---|
CHART:{epic}:{scale} (MERGE mode) | {scale} | SECOND, 1MINUTE, 5MINUTE, HOUR |
LTV | Last traded volume | |
TTV | Incremental volume | |
UTM | Update time (as milliseconds from the Epoch) | |
DAY_OPEN_MID | Mid open price for the day | |
DAY_NET_CHG_MID | Change from open price to current (MID price) | |
DAY_PERC_CHG_MID | Daily percentage change (MID price) | |
DAY_HIGH | Daily high price (MID) | |
DAY_LOW | Daily low price (MID) | |
OFR_OPEN | Candle open price (OFR) | |
OFR_HIGH | Candle high price (OFR) | |
OFR_LOW | Candle low price (OFR) | |
OFR_CLOSE | Candle close price (OFR) | |
BID_OPEN | Candle open price (BID) | |
BID_HIGH | Candle high price (BID) | |
BID_LOW | Candle low price (BID) | |
BID_CLOSE | Candle close price (BID) | |
LTP_OPEN | Candle open price (Last Traded Price) | |
LTP_HIGH | Candle high price (Last Traded Price) | |
LTP_LOW | Candle low price (Last Traded Price) | |
LTP_CLOSE | Candle close price (Last Traded Price) | |
CONS_END | 1 when candle ends, otherwise 0 | |
CONS_TICK_COUNT | Number of ticks in candle |