Versions Compared

Key

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

Type definitions

...

Panel
bgColor#FFFFFF
titleBGColor#FFCC33
titleMarketCatalogue

Information about 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.

marketName

String

(tick)

The name of the market

marketStartTime

Date

 

The time this market starts at, only returned when the MARKET_START_TIME enum is passed in the marketProjections

description

MarketDescription

 

Details about the market

totalMatchedDouble The total amount of money matched on the market

runners

List< RunnerCatalog >

 

The runners (selections) contained in the market

eventType

EventType

 

The Event Type the market is contained within

competition

Competition

 

The competition the market is contained within. Usually only applies to Football competitions

event

Event

 

The event the market is contained within


...

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.


...

Panel
bgColor#FFFFFF
titleBGColor#FFCC33
titleMarketDescription

Market definition

Field name

Type

Required

Description

persistenceEnabled

boolean

(tick)

If 'true' the market supports 'Keep' bets if the market is to be turned in-play

bspMarket

boolean

(tick)

If 'true' the market supports Betfair SP betting

marketTime

Date

(tick)

The market start time

suspendTime

Date

(tick)

The market suspend time

settleTime

Date

 

settled time

bettingType

MarketBettingType

(tick)

See MarketBettingType

turnInPlayEnabled

boolean

(tick)

If 'true' the market is set to turn in-play

marketType

String

(tick)

Market base type

regulator

String

(tick)

The market regulator

marketBaseRate

double

(tick)

The commission rate applicable to the market

discountAllowed

boolean

(tick)

Indicates whether or not the user's discount rate is taken into account on this market. If ‘false’ all users will be charged the same commission rate, regardless of discount rate.

wallet

String

 The wallet to which the market belongs (UK/AUS).

rules

String

 The market rules.

rulesHasDate

boolean

  
eachWayDivisordouble The divisor is returned for the marketType EACH_WAY only and refers to the fraction of the win odds at which the place portion of an each way bet is settled

clarifications

String

 Any additional information regarding the market

lineRangeInfo

MarketLineRangeInfo

 

Line range info for line markets

raceType

String

 

An external identifier of a race type

priceLadderDescription

PriceLadderDescription

 

Details about the price ladder in use for this market.


...