Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Type definitions

...

Panel
bgColor#FFFFFF
titleBGColor#FFCC33
titleMarketBook

The dynamic data in a market

Field name

Type

Required

Description

marketId

String

(tick)

The unique identifier for the market. MarketId's are prefixed with '1.'

isMarketDataDelayed

boolean

(tick)

True if the data returned by listMarketBook will be delayed. The data may be delayed because you are not logged in with a funded account or you are using an Application Key that does not allow up to date data.

status

MarketStatus

 

The status of the market, for example OPEN, SUSPENDED, CLOSED (settled), etc.

betDelay

int

 

The number of seconds an order is held until it is submitted into the market. Orders are usually delayed when the market is in-play

bspReconciled

boolean

 

True if the market starting price has been reconciled

complete

boolean

 If false, runners may be added to the market

inplay

boolean

 

True if the market is currently in play

numberOfWinners

int

 

The number of selections that could be settled as winners

numberOfRunners

int

 

The number of runners in the market

numberOfActiveRunners

int

 

The number of runners that are currently active. An active runner is a selection available for betting

lastMatchTime

Date

 

The most recent time an order was executed

totalMatched

double

 

The total amount matched

totalAvailable

double

 

The total amount of orders that remain unmatched

crossMatching

boolean

 

True if cross matching is enabled for this market.

runnersVoidable

boolean

 

True if runners in the market can be voided. Please note - this doesn't include horse racing markets under which bets are voided on non-runners with any applicable reduction factor applied/

version

long

 

The version of the market. The version increments whenever the market status changes, for example, turning in-play, or suspended when a goal is scored.

runners

List< Runner >

 

Information about the runners (selections) in the market.

keyLineDescription

KeyLineDescription

 

Description of a markets key line for valid market types


...

Panel
bgColor#FFFFFF
titleBGColor#FFCC33
titleStartingPrices

Information about the Betfair Starting Price. Only available in BSP markets

Field name

Type

Required

Description

nearPrice

double

 

What the starting price would be if the market was reconciled now taking into account the SP bets as well as unmatched exchange bets on the same selection in the exchange. This data is cached and update every 60 seconds. Please note: Type Double may contain numbers, INF, -INF, and NaN.

farPrice

double

 

What the starting price would be if the market was reconciled now taking into account only the currently place SP bets. The Far Price is not as complicated but not as accurate and only accounts for money on the exchange at SP. This data is cached and updated every 60 seconds. Please note: Type Double may contain numbers, INF, -INF, and NaN.

backStakeTaken

List< PriceSize >

 

The total amount of back bets matched at the actual Betfair Starting Price. Pre-reconciliation, this field is zero for all prices except 1.01 (for Market on Close bets) and at the limit price for any Limit on Close bets.

layLiabilityTaken

List< PriceSize >

 

The lay amount matched at the actual Betfair Starting Price. Pre-reconciliation, this field is zero for all prices except 1.01 (for Market on Close bets) and at the limit price for any Limit on Close bets.

actualSP

double

 

The final BSP price for this runner. Only available for a BSP market that has been reconciled.


...