Market Channels

Orderbook Change

Subscribe

Message will be sent once the orderbook has any change (new/cancel/match order).

Field	Value	Description
channel	market.depth.diff	Channel of orderbook change
marketId	{MARKET_ID}	MarketId of subscribed market

Orderbook Change applied to a single binary market only.

For categorical market, you should subscribe each market_id individually.

Example

{"action":"SUBSCRIBE","channel":"market.depth.diff","marketId":1274}

Structure

Name	Type	Description
marketId	number	market id
rootMarketId	number	root market id if belongs to a categorical market
tokenId	string	token id of updated conditional token
outcomeSide	number	1 - yes, 2 - no
side	string	bids | asks
price	string	price
size	string	shares of conditional tokens

Sample message

{
    "marketId": 2764, 
    "tokenId": "19120407572139442221452465677574895365338028945317996490376653704877573103648", 
    "outcomeSide": 1, 
    "side": "bids", 
    "price": "0.2", 
    "size": "50", 
    "msgType": "market.depth.diff"
}

Market Price Change

Message will be sent once the latest match price has changed.

Subscribe

Field	Value	Description
channel	market.last.price	Channel of market price change
marketId	{MARKET_ID}	MarketId of subscribed binary market
rootMarketId	{ROOT_MARKET_ID}	MarketId of subscribed categorical market

If rootMarketId is defined, marketId will be omitted.

Subscribing root market will receive messages of all of its sub-markets.

Example

For Binary market:
{"action":"SUBSCRIBE","channel":"market.last.price","marketId":1274}
For Categorical market:
{"action":"SUBSCRIBE","channel":"market.last.price","rootMarketId":61}

Structure

Name	Type	Description
marketId	number	market id
rootMarketId	number	root market id if belongs to a categorical market
tokenId	string	token id of updated conditional token
price	string	price
outcomeSide	number	1 - yes, 2 - no

Sample message

{
    "tokenId": "19120407572139442221452465677574895365338028945317996490376653704877573103648", 
    "outcomeSide": 1, 
    "price": "0.85", 
    "marketId": 2764, 
    "msgType": "market.last.price"
}

Market Last Trade

Subscribe

Message will be sent once a trade matched in this market.

Please note that the matched trade does not guarantee successful execution on-chain.

And the final on-chain amount/share may vary if fee applied.

Field	Value	Description
channel	market.last.trade	Channel of market last trade
marketId	{MARKET_ID}	MarketId of subscribed binary market
rootMarketId	{ROOT_MARKET_ID}	MarketId of subscribed categorical market

If rootMarketId is defined, marketId will be omitted.

Subscribing root market will receive messages of all of its sub-markets.

Example

For Binary market:
{"action":"SUBSCRIBE","channel":"market.last.trade","marketId":1274}
For Categorical market:
{"action":"SUBSCRIBE","channel":"market.last.trade","rootMarketId":61}

Structure

Name	Type	Description
marketId	number	market id
rootMarketId	number	root market id if belongs to a categorical market
tokenId	string	token id of updated conditional token
side	string	Buy | Sell | Split | Merge
outcomeSide	number	1 - yes, 2 - no
price	string	price
shares	string	amount of conditional token
amount	string	amount of quote token

Sample message

{
    "tokenId": "19120407572139442221452465677574895365338028945317996490376653704877573103648", 
    "side": "Buy", 
    "outcomeSide": 1, 
    "price": "0.85", 
    "shares": "10", 
    "amount": "8.5", 
    "marketId": 2764, 
    "msgType": "market.last.trade"
}