Page Comparison

marketId

String

The unique identifier for the market. MarketId's are prefixed with '1.' or '2.' 1. = UK Exchange 2. = AUS Exchange.

marketName

String

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

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

marketId

String

The unique identifier for the market. MarketId's are prefixed with '1.' or '2.' 1. = UK Exchange 2. = AUS Exchange.

isMarketDataDelayed

boolean

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

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

selectionId

long

The unique id for the selection.

runnerName

String

The name of the runner

handicap

double

The handicap

sortPriority

int

The sort priority of this runner

metadata

Map<String,String>

Metadata associated with the runner.  For a description of this data for Horse Racing, please see Runner Metadata Description

selectionId

long

The unique id of the runner (selection)

handicap

double

The handicap.  Enter the specific handicap value (returned by RUNNER in listMaketBook) if the market is an Asian handicap market.

status

RunnerStatus

The status of the selection (i.e., ACTIVE, REMOVED, WINNER, PLACED, LOSER, HIDDEN) Runner status information is available for 90 days following market settlement.

adjustmentFactor

double

The adjustment factor applied if the selection is removed

lastPriceTraded

double

The price of the most recent bet matched on this selection

totalMatched

double

The total amount matched on this runner

removalDate

Date

If date and time the runner was removed

sp

StartingPrices

The BSP related prices for this runner

ex

ExchangePrices

The Exchange prices available for this runner

orders

List< Order >

List of orders in the market

matches

List< Match >

List of matches (i.e, orders that have been fully or partially executed)

matchesByStrategy

Map<String,Matches>

List of matches for each strategy, ordered by matched data

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.

betId

String

orderType

OrderType

BSP Order type.

status

OrderStatus

Either EXECUTABLE (an unmatched amount remains) or EXECUTION_COMPLETE (no unmatched amount remains).

persistenceType

PersistenceType

What to do with the order at turn-in-play

side

Side

For LINE markets customers either Buy a line (LAY bet, winning if outcome is greater than the taken line (price)) or Sell a line (BACK bet, winning if outcome is less than the taken line (price)) 

price

double

The price of the bet. Please note: LINE markets operate at even-money odds of 2.0. However, price for these markets refers to the line positions available as defined by the markets min-max range and interval steps 

size

double

The size of the bet.

bspLiability

double

Not to be confused with size. This is the liability of a given BSP bet.

placedDate

Date

The date, to the second, the bet was placed.

avgPriceMatched

double

The average price matched at. Voided match fragments are removed from this average calculation. For MARKET_ON_CLOSE BSP bets this reports the matched SP price following the SP reconciliation process. This value is not meaningful for activity on LINE markets and is not guaranteed to be returned or maintained for these markets.

sizeMatched

double

The current amount of this bet that was matched.

sizeRemaining

double

The current amount of this bet that is unmatched.

sizeLapsed

double

The current amount of this bet that was lapsed.

sizeCancelled

double

The current amount of this bet that was cancelled.

sizeVoided

double

The current amount of this bet that was voided.

customerOrderRef

CustomerOrderRef

The customer order reference sent for this bet

customerStrategyRef

CustomerStrategyRef

The customer strategy reference sent for this bet

betId

String

Only present if no rollup

matchId

String

Only present if no rollup

side

Side

price

double

Either actual match price or avg match price depending on rollup. This value is not meaningful for activity on LINE markets and is not guaranteed to be returned or maintained for these markets. 

size

double

Size matched at in this fragment, or at this price or avg price depending on rollup

matchDate

Date

Only present if no rollup

persistenceEnabled

boolean

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

bspMarket

boolean

marketTime

Date

The market start time

suspendTime

Date

The market suspend time

settleTime

Date

settled time

bettingType

MarketBettingType

See MarketBettingType

turnInPlayEnabled

boolean

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

marketType

String

Market base type

regulator

String

The market regulator

marketBaseRate

double

discountAllowed

boolean

wallet

String

rules

String

rulesHasDate

boolean

clarifications

String

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.

marketBaseRate

double

marketBaseRate

discountAllowed

boolean

discountAllowed

wallet

String

The wallet from which funds will be taken when betting on this market

rules

String

The rules for this market

rulesHasDate

boolean

The market's start date and time are relevant to the rules.

clarifications

String

Clarifications to the rules for the market

maxUnitValue

double

maxPrice - Maximum value for the outcome, in market units for this market (eg 100 runs)

minUnitValue

double

minPrice - Minimum value for the outcome, in market units for this market (eg 0 runs) 

interval

double

interval - The odds ladder on this market will be between the range of minUnitValue and maxUnitValue, in increments of the inverval value.e.g. If minUnitValue=10 runs, maxUnitValue=20 runs, interval=0.5 runs, then valid odds include 10, 10.5, 11, 11.5 up to 20 runs.

marketUnit

String

unit - The type of unit the lines are incremented in by the interval (e.g: runs, goals or seconds.

price

double

size

double

clearedOrders

List<ClearedOrderSummary>

The list of cleared orders returned by your query. This will be a valid list (i.e. empty or non-empty but never 'null').

moreAvailable

boolean

Indicates whether there are further result items beyond this page. Note that underlying data is highly time-dependent and the subsequent search orders query might return an empty result.

currentOrders

List< CurrentOrderSummary >

The list of current orders returned by your query. This will be a valid list (i.e. empty or non-empty but never 'null').

moreAvailable

boolean

Indicates whether there are further result items beyond this page. Note that underlying data is highly time-dependent and the subsequent search orders query might return an empty result.

betId

String

The bet ID of the original place order.

marketId

String

The market id the order is for.

selectionId

long

The selection id the order is for.

handicap

double

The handicap associated with the runner in case of Asian handicap markets, null otherwise.

priceSize

PriceSize

The price and size of the bet.

bspLiability

double

Not to be confused with size. This is the liability of a given BSP bet.

side

Side

BACK/LAY

status

OrderStatus

Either EXECUTABLE (an unmatched amount remains) or EXECUTION_COMPLETE (no unmatched amount remains).

persistenceType

PersistenceType

What to do with the order at turn-in-play.

orderType

OrderType

BSP Order type.

placedDate

Date

The date, to the second, the bet was placed.

averagePriceMatched

double

The average price matched at. Voided match fragments are removed from this average calculation. The price is automatically adjusted in the event of non runners being declared with applicable reduction factors. Please note: This value is not meaningful for activity on LINE markets and is not guaranteed to be returned or maintained for these markets. 

sizeMatched

double

The current amount of this bet that was matched.

sizeRemaining

double

The current amount of this bet that is unmatched.

sizeLapsed

double

The current amount of this bet that was lapsed.

sizeCancelled

double

The current amount of this bet that was cancelled.

sizeVoided

double

The current amount of this bet that was voided.

regulatorAuthCode

String

The regulator authorisation code.

regulatorCode

String

The regulator Code.

customerOrderRef

String

The order reference defined by the customer for this bet

customerStrategyRef

String

The strategy reference defined by the customer for this bet

orderType

OrderType

selectionId

long

The selection_id.

handicap

double

The handicap associated with the runner in case of Asian handicap markets (e.g. marketTypes ASIAN_HANDICAP_DOUBLE_LINE, ASIAN_HANDICAP_SINGLE_LINE) null otherwise.

side

Side

Back or Lay

limitOrder

LimitOrder

limitOnCloseOrder

LimitOnCloseOrder

marketOnCloseOrder

MarketOnCloseOrder

customerOrderRef

String

customerRef

String

Echo of the customerRef if passed.

status

ExecutionReportStatus

errorCode

ExecutionReportErrorCode

marketId

String

Echo of marketId passed

instructionReports

List< PlaceInstructionReport >

size

double

The size of the bet. Please note: For market type EACH_WAY. The total stake = size x 2

price

double

The limit price. For LINE markets, the price at which the bet is settled and struck will always be 2.0 (Evens). On these bets, the Price field is used to indicate the line value which is being bought or sold 

persistenceType

PersistenceType

What to do with the order at turn-in-play

timeInForce

TimeInForce

The type of TimeInForce value to use. This value takes precedence over any PersistenceType value chosen. 
If this attribute is populated along with the PersistenceType field, then the PersistenceType will be 
ignored. When using FILL_OR_KILL for a Line market the Volume Weighted Average Price (VWAP) functionality is disabled

minFillSize

Size

An optional field used if the TimeInForce attribute is populated. 
If specified without TimeInForce then this field is ignored. 
If no minFillSize is specified, the order is killed unless the entire size can be matched. 
If minFillSize is specified, the order is killed unless at least the minFillSize can be matched. 
The minFillSize cannot be greater than the order's size. 
If specified for a BetTargetType and FILL_OR_KILL order, then this value will be ignored

betTargetType

BetTargetType

An optional field to allow betting to a targeted PAYOUT or BACKERS_PROFIT. 
It's invalid to specify both a Size and BetTargetType 
Matching provides best execution at the requested price or better up to the payout or profit. 
If the bet is not matched completely and immediately, the remaining portion enters the unmatched pool of bets on the exchange

BetTargetType bets are invalid for LINE markets

betTargetSize

Size

An optional field which must be specified if BetTargetType is specified for this order 
The requested outcome size of either the payout or profit. 
This is named from the backer's perspective. For Lay bets the profit represents the bet's liability

liability

double

The size of the bet. See Min BSP Liability

price

double

The limit price of the bet if LOC

liability

double

The size of the bet.

status

InstructionReportStatus

whether the command succeeded or failed

errorCode

InstructionReportErrorCode

cause of failure, or null if command succeeds

orderStatus

OrderStatus

The status of the order, if the instruction succeeded. 
If the instruction was unsuccessful, no value is provided.

instruction

PlaceInstruction

The instruction that was requested

betId

String

The bet ID of the new bet. Will be null on failure or if order was placed asynchronously.

placedDate

Date

Will be null if order was placed asynchronously

averagePriceMatched

Price

Will be null if order was placed asynchronously. This value is not meaningful for activity on LINE markets and is not guaranteed to be returned or maintained for these markets. 

sizeMatched

Size

Will be null if order was placed asynchronously

betId

String

sizeReduction

double

If supplied then this is a partial cancel.  Should be set to 'null' if no size reduction is required.

customerRef

String

Echo of the customerRef if passed.

status

ExecutionReportStatus

errorCode

ExecutionReportErrorCode

marketId

String

Echo of marketId passed

instructionReports

List< CancelInstructionReport >

betId

String

newPrice

double

The price to replace the bet at

customerRef

String

Echo of the customerRef if passed.

status

ExecutionReportStatus

errorCode

ExecutionReportErrorCode

marketId

String

Echo of marketId passed

instructionReports

List< ReplaceInstructionReport >

status

InstructionReportStatus

whether the command succeeded or failed

errorCode

InstructionReportErrorCode

cause of failure, or null if command succeeds

cancelInstructionReport

CancelInstructionReport

Cancelation report for the original order

placeInstructionReport

PlaceInstructionReport

Placement report for the new order

status

InstructionReportStatus

whether the command succeeded or failed

errorCode

InstructionReportErrorCode

cause of failure, or null if command succeeds

instruction

CancelInstruction

The instruction that was requested

sizeCancelled

double

cancelledDate

Date

betId

String

newPersistenceType

PersistenceType

The new persistence type to update this bet to

customerRef

String

Echo of the customerRef if passed.

status

ExecutionReportStatus

errorCode

ExecutionReportErrorCode

marketId

String

Echo of marketId passed

instructionReports

List< UpdateInstructionReport >

status

InstructionReportStatus

whether the command succeeded or failed

errorCode

InstructionReportErrorCode

cause of failure, or null if command succeeds

instruction

UpdateInstruction

The instruction that was requested