marketBook: marketBook method

Description Arguments Details

Description

dynamic data about markets. Data includes prices, the status of the market, the status of selections, the traded volume, and the status of any orders you have placed in the market.

Arguments

marketIds

(string) one or more market Ids. The number of markets returned depends on the amount of data you request via the price projection.

priceProjection

the projection of price data you want to receive in the response, see section PriceProjection in BettingEnums.

orderProjection

the orders you want to receive in the response, see section OrderProjection in BettingEnums.

matchProjection

if you ask for orders, specifies the representation of matches, see section MatchProjection in BettingEnums.

getRunners

this parameter allows users to retrieve data about the runners in the market, it does this by making a request using the marketCatalogue method, pass in RUNNER_DESCRIPTION or RUNNER_METADATA to retrieve data about the runners

Details

Seperate requests should be made for ACTIVE and CLOSED markets. Requests that include both ACTIVE and CLOSED markets will only return those markets that are active.

Data request limits apply to requests using marketBook that include price or order projections. Calls to marketBook should be made up to a maximum of 5 times per second to a single marketId.

BEST PRACTICE: those seeking to use marketBook to obtain price, volume, unmatched orders and matched position in a single operation should provide an orderProjection of EXECUTABLE in their marketBook request and receive all unmatched orders and the aggregated matched volume from all orders. The level of matched volume aggregation (matchProjection) should be ROLLED_UP_BY_AVG_PRICE or ROLLED_UP_BY_PRICE, the former being preferred. This provides a single call in which you can track prices, traded volume, unmatched orders, and your evolving matched position with a reasonably fixed, minimally sized response.


durtal/betfaiR documentation built on May 15, 2019, 6:01 p.m.