Versions Compared

Key

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

...

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.' or '2.' 1. = UK Exchange 2. = AUS Exchange.

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

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


Anchor
RunnerCatalog
RunnerCatalog

...

Anchor
KeyLineSelection
KeyLineSelection
KeyLineSelection

Description of a markets key line selection, comprising the selectionId and handicap of the team it is applied to.

Field name

Type

Required

Description

selectionId

SelectionId

Selection ID of the runner in the key line handicap.

handicap

Handicap

Handicap value of the key line.

 

 

Anchor
#KeyLineDescription
#KeyLineDescription

KeyLineDescription

A list of KeyLineSelection objects describing the key line for the market

Field name

Type

Required

Description

keyLine

List<KeyLineSelection>

A list of KeyLineSelection objects

 

...