Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
The migration to V3 will occur on August 25 at 10am EST. Old API integrations will stop working. See the Migrate to V3 guide →
Subscribe to real-time changes in a market’s order book
version (see below). Apply a publication only when its version is strictly greater than the one you hold for that market — see book versioning.
CHANNEL NAME FORMAT
orderbook_v3:{marketHash}
| Name | Type | Description |
|---|---|---|
| marketHash | string | The market to subscribe to |
| Name | Type | Description |
|---|---|---|
| marketHash | string | The market this book belongs to |
| version | string | A single string that increases as the book changes. Apply an update only when it is strictly greater than the one you hold — see book versioning |
| outcomeOne | Level[] | Resting levels on outcome one, sorted best first |
| outcomeTwo | Level[] | Resting levels on outcome two, sorted best first |
Level object looks like:
| Name | Type | Description |
|---|---|---|
| percentageOdds | string | The odds the maker receives in the sx.bet protocol format. To convert to implied odds divide by 10^20. To get taker implied odds: takerOdds = 1 - percentageOdds / 10^20. See unit conversions. |
| size | string | Aggregate remaining maker size at that level, in base units. See unit conversions. |
showTakerPerspective parameter on this channel — levels are always the maker frame, unlike GET /orderbook-v3/snapshot, which accepts it.
// To subscribe
const marketHash = "0xbf06c6379c922d8118612d1d7493b20f6df6929437fbf6022904327f9516a2eb";
const sub = client.newSubscription(`orderbook_v3:${marketHash}`, { recoverable: true });
sub.on("publication", (ctx) => {
const data = ctx.data;
// message handler logic
});
sub.subscribe();
import asyncio
from centrifuge import Client, PublicationContext, SubscriptionEventHandler
async def on_publication(ctx: PublicationContext) -> None:
print(ctx.data)
async def main():
market_hash = "0xbf06c6379c922d8118612d1d7493b20f6df6929437fbf6022904327f9516a2eb"
client = Client(
"wss://realtime.sx.bet/connection/websocket",
token="YOUR_TOKEN", # from /user/realtime-token-v3/api-key
)
await client.connect()
handler = SubscriptionEventHandler(on_publication=on_publication)
sub = client.new_subscription(f"orderbook_v3:{market_hash}", handler)
await sub.subscribe()
await asyncio.Future() # keep running
asyncio.run(main())
{
"marketHash": "0xbf06c6379c922d8118612d1d7493b20f6df6929437fbf6022904327f9516a2eb",
"version": "00100000000000010015000",
"outcomeOne": [{ "percentageOdds": "40000000000000000000", "size": "1000000" }],
"outcomeTwo": []
}