Skip to main content

L2 Data

Message Types

NameAccessType ValueDescription
Order Book TickL2tobTop of book data with 10 price levels for buy and sell sides
Order TickL2torDetails of individually placed orders
Order Execution TickL2texDetails of executed orders and trade information

Message Type Details

Order Book Tick

Top of book data with buy and sell side information at up to 10 price levels.

Fields

Field NameObject KeyTypeDescription
Market TypemstringREG - Regular, FUT - Futures, ODL - Odd Lot
SymbolsstringSecurity symbol
TimestamptnumberUnix timestamp (seconds)
Buy StatsbsobjectAggregate buy side statistics (null if unavailable) - View
Buy Price LevelsblarrayTop 10 buy price levels - View
Sell StatsssobjectAggregate sell side statistics (null if unavailable) - View
Sell Price LevelsslarrayTop 10 sell price levels - View

Buy Stats Fields (bs)

Field NameObject KeyTypeDescription
PricexnumberWeighted average buy price
VolumevnumberTotal buy volume

Buy Price Level Fields (bl[])

Field NameObject KeyTypeDescription
LevellvnumberPrice level number (1-10)
PricexnumberPrice at this level
VolumevnumberVolume at this level
Number of OrdersonnumberCount of orders at this level

Sell Stats Fields (ss)

Field NameObject KeyTypeDescription
PricexnumberWeighted average sell price
VolumevnumberTotal sell volume

Sell Price Level Fields (sl[])

Field NameObject KeyTypeDescription
LevellvnumberPrice level number (1-10)
PricexnumberPrice at this level
VolumevnumberVolume at this level
Number of OrdersonnumberCount of orders at this level

Example

{
"type": "tob",
"data": {
"t": 1710485205,
"m": "REG",
"s": "TREET",
"bs": {
"x": 16.15,
"v": 792215
},
"bl": [
{
"lv": 1,
"x": 16.6,
"v": 7802,
"on": 7
},
{
"lv": 10,
"x": 16.51,
"v": 55190,
"on": 13
}
],
"ss": {
"x": 17.54,
"v": 2281099
},
"sl": [
{
"lv": 1,
"x": 16.64,
"v": 50209,
"on": 1
},
{
"lv": 10,
"x": 16.75,
"v": 15385,
"on": 5
}
]
}
}

Order Tick

Details of individually placed orders.

Fields

Field NameObject KeyTypeDescription
Market TypemstringREG - Regular, FUT - Futures, ODL - Odd Lot
SymbolsstringSecurity symbol
TimestamptnumberUnix timestamp (seconds)
Timestamp ExecutedtxnumberUnix timestamp when order was executed
Order IDidstringUnique order identifier
PricexnumberOrder price
QuantityvnumberOrder quantity
Sidesdnumber1 - Buy, 2 - Sell
Tick Sequence NumbertsqnumberSequence number of this tick order message

Example

{
"type": "tor",
"data": {
"m": "FUT",
"s": "PTC-MAR",
"t": 1710485205,
"tx": 1710485205,
"id": "0010SAD1QB00BLKF",
"x": 13.34,
"v": 500,
"sd": 1,
"tsq": 289722
}
}

Order Execution Tick

Details of executed orders and trades.

Fields

Field NameObject KeyTypeDescription
Market TypemstringREG - Regular, FUT - Futures, ODL - Odd Lot
SymbolsstringSecurity symbol
TimestamptnumberUnix timestamp (seconds)
Timestamp ExecutedtxnumberUnix timestamp when execution occurred
PricexnumberExecution price
QuantityvnumberExecuted quantity
Tick Sequence NumbertsqnumberSequence number of this execution message
Buy Order Tick SequencetsqbnumberSequence number of buy order (0 if not present)
Sell Order Tick SequencetsqsnumberSequence number of sell order (0 if not present)
Execution Instructionxistring4 - Canceled, F - Trade
Execution TypextstringB - OK to Cross

Example

{
"type": "tex",
"data": {
"m": "REG",
"s": "PPL",
"t": 1710485570,
"tx": 1710485570,
"x": 112.85,
"v": 61,
"tsq": 318909,
"tsqb": 0,
"tsqs": 302037,
"xi": "F",
"xt": "B"
}
}