Streaming API Reference

Market price subscription (price availability subject to account permissions)

Item Field Description
MARKET:{epic}

(MERGE mode)
MID_OPENOpening mid price
HIGHIntraday high price
LOWIntraday low price
CHANGEPrice change compared with open value
CHANGE_PCTPrice percent change compared with open value
UPDATE_TIMEPublish time of last price update (UK local time, i.e. GMT or BST)
MARKET_DELAYDelayed price (0=false, 1=true)
MARKET_STATEMarket status: CLOSED, OFFLINE, TRADEABLE, EDIT, AUCTION, AUCTION_NO_EDIT, SUSPENDED
BIDBid price
OFFEROffer price
STRIKE_PRICEStrike price (Sprint markets)
ODDSTrade odds (Sprint markets)

Account subscription

Item Field Description
ACCOUNT:{account identifier}

(MERGE mode)
PNLAccount profit and loss value
DEPOSITAccount minimum deposit value required for margins
AVAILABLE_CASHAmount cash available to trade value, after account balance, profit and loss and minimum deposit amount have been considered
PNLProfit/Loss
PNL_LRProfit/Loss Limited Risk
PNL_NLRProfit/Loss Non-limited Risk
FUNDSFunds
MARGINMargin
MARGIN_LRMargin Limited Risk
MARGIN_NLRMargin Non-limited Risk
AVAILABLE_TO_DEALAvailable to Trade
EQUITYEquity
EQUITY_USEDEquity Used

Trade subscription

Item Field Description
TRADE:{account identifier}

(DISTINCT mode)
CONFIRMS
Trade confirmations for an account
Constant directionBUY, SELL
Number limitLevelLimit level
String dealIdDeal identifier
Array[Object] affectedDeals
Affected deals
String dealIdDeal identifier
Constant status
Deal status
AMENDEDAmended
DELETEDDeleted
FULLY_CLOSEDFully closed
OPENEDOpened
PARTIALLY_CLOSEDPartially closed
Number stopLevelStop level
String expiryInstrument expiry
Number sizeTrade size
Constant status
Resultant position or working order status
AMENDEDAmended
CLOSEDClosed
DELETEDDeleted
OPENOpen
PARTIALLY_CLOSEDPartially Closed
String epicInstrument EPIC identifier
Number levelTrade level
Boolean guaranteedStopTrue if a guaranteed stop is in place
String dealReferenceDeal reference
Constant dealStatus
Deal status
ACCEPTEDAccepted
REJECTEDRejected
OPU
Open position updates for an account
Constant directionBUY, SELL
Number limitLevelLimit level
String dealIdDeal identifier
String dealIdOriginDeal identifier of the originating deal
Number stopLevelStop level
String expiryInstrument expiry
Date timestampEvent date and time
Number sizeTrade size
Constant status
Position status
OPENOpened
UPDATEDUpdated
DELETEDClosed
String epicInstrument EPIC identifier
Number levelTrade level
Boolean guaranteedStopTrue if a guaranteed stop is in place
String dealReferenceDeal reference
Constant dealStatus
Deal status
ACCEPTEDAccepted
REJECTEDRejected
String channelUser channel (do not bind to this value - it will be converted to a constant enum)
String currencyCurrency
Number trailingStopDistanceTrailing stop distance
Number trailingStepTrailing stop increment
WOU
Working order updates for an account
Constant directionBUY, SELL
Number limitDistanceLimit distance
String dealIdDeal identifier
Number stopDistanceStop distance
String expiryInstrument expiry
Date timestampEvent date and time
Number sizeTrade size
Constant status
Working order status
OPENOpened
UPDATEDUpdated
DELETEDClosed
String epicInstrument EPIC identifier
Number levelTrade level
Boolean guaranteedStopTrue if a guaranteed stop is in place
String dealReferenceDeal reference
Constant dealStatus
Deal status
ACCEPTEDAccepted
REJECTEDRejected
String currencyCurrency
Constant orderType
Order type
LIMITLimit order
STOPStop order
Constant timeInForce
Time in force
GOOD_TILL_CANCELLEDGood until cancelled
GOOD_TILL_DATEGood until specified date
Date goodTillDateGood until specified date
String channelUser channel (do not bind to this value - it will be converted to a constant enum)

Chart subscriptions - Tick data

Item Field Description
CHART:{epic}:TICK

(DISTINCT mode)
BIDBid price
OFROffer price
LTPLast traded price
LTVLast traded volume
TTVIncremental trading volume
UTMUpdate time (as milliseconds from the Epoch)
DAY_OPEN_MIDMid open price for the day
DAY_NET_CHG_MIDChange from open price to current (MID price)
DAY_PERC_CHG_MIDDaily percentage change (MID price)
DAY_HIGHDaily high price (MID)
DAY_LOWDaily low price (MID)

Chart subscriptions - Consolidated (candle) data

Item Field Description
CHART:{epic}:{scale}

(MERGE mode)
{scale}SECOND, 1MINUTE, 5MINUTE, HOUR
LTVLast traded volume
TTVIncremental volume
UTMUpdate time (as milliseconds from the Epoch)
DAY_OPEN_MIDMid open price for the day
DAY_NET_CHG_MIDChange from open price to current (MID price)
DAY_PERC_CHG_MIDDaily percentage change (MID price)
DAY_HIGHDaily high price (MID)
DAY_LOWDaily low price (MID)
OFR_OPENCandle open price (OFR)
OFR_HIGHCandle high price (OFR)
OFR_LOWCandle low price (OFR)
OFR_CLOSECandle close price (OFR)
BID_OPENCandle open price (BID)
BID_HIGHCandle high price (BID)
BID_LOWCandle low price (BID)
BID_CLOSECandle close price (BID)
LTP_OPENCandle open price (Last Traded Price)
LTP_HIGHCandle high price (Last Traded Price)
LTP_LOWCandle low price (Last Traded Price)
LTP_CLOSECandle close price (Last Traded Price)
CONS_END1 when candle ends, otherwise 0
CONS_TICK_COUNTNumber of ticks in candle

Uncaught exception thrown in shutdown function.

PDOException: SQLSTATE[25006]: Read only sql transaction: 7 ERROR: cannot execute DELETE in a read-only transaction: DELETE FROM {semaphore} WHERE (value = :db_condition_placeholder_0) ; Array ( [:db_condition_placeholder_0] => 950388445610b48dfa2c994.32789465 ) in lock_release_all() (line 269 of /var/ig/webcontent/drupal/includes/lock.inc).