Market Data

Get live orderbook for a single outcome

GET
/orderbook/outcome/{outcomeId}

Authorization

appId
headerx-app-id<token>

Your application ID. Required on app-tier and user-tier routes. Omitted on routes that authenticate with x-app-api-key only.

Path Parameters

outcomeId*string

Query Parameters

depth?number

Response Body

200

application/json
  1. response
venueMarketOutcomeId*string
venueMarketId*string
venue*string
orderbook*
midpoint*number
spread*number
seq*number
checksum*number
timestamp*number
tick*number

Price increment of this outcome's book, as a 0-1 price (e.g. 0.01). null until it has been inferred from the book.

markSource*MarkSource

How midpoint was derived. local: (best bid + best ask) / 2 on this book. local_merged: a missing side was filled from the complementary outcome's book. local_one_sided: only one side exists, so the mark is that side's best price, not a true midpoint. sibling: 1 minus the complementary outcome's mark. local_boundary: the book sits at 0 or 1 (e.g. a settled market). local_stub: the only book is a placeholder quote at the price bounds; indicative only, not tradeable quality. none: no mark available.

Value in"local""local_merged""local_one_sided""sibling""local_boundary""local_stub""none"
Example Request
curl -X GET 'https://api.t.sufwankhalid.com/orderbook/outcome/string'
Example Response
{  "venueMarketOutcomeId": "string",  "venueMarketId": "string",  "venue": "string",  "orderbook": {    "bids": [      {        "price": 0,        "size": 0      }    ],    "asks": [      {        "price": 0,        "size": 0      }    ]  },  "midpoint": 0,  "spread": 0,  "seq": 0,  "checksum": 0,  "timestamp": 0,  "tick": 0,  "markSource": "local"}