Page Comparison

textQuery

String

Restrict markets by any text associated with the Event name. You can include a wildcard (*) character as long as it is not the first character. Please note - the textQuery field doesn't evaluate market or selection names.

exchangeIds

Set<String>

DEPRECATED

eventTypeIds

Set<String>

Restrict markets by event type associated with the market. (i.e., Football, Hockey, etc)

eventIds

Set<String>

Restrict markets by the event id associated with the market.

competitionIds

Set<String>

Restrict markets by the competitions associated with the market.

marketIds

Set<String>

Restrict markets by the market id associated with the market.

venues

Set<String>

Restrict markets by the venue associated with the market. Currently, only Horse & Greyhound racing markets have venues.

bspOnly

boolean

Restrict to bsp markets only, if True or non-bsp markets if False. If not specified then returns both BSP and non-BSP markets

turnInPlayEnabled

boolean

Restrict to markets that will turn in play if True or will not turn in play if false. If not specified, returns both.

inPlayOnly

boolean

Restrict to markets that are currently in play if True or are not currently in play if false. If not specified, returns both.

marketBettingTypes

Set< MarketBettingType >

Restrict to markets that match the betting type of the market (i.e. Odds, Asian Handicap Singles, Asian Handicap Doubles or Line)

marketCountries

Set<String>

Restrict to markets that are in the specified country or countries.  Please note: the default value is 'GB' when the correct country code cannot be determined.

marketTypeCodes

Set<String>

Restrict to markets that match the type of the market (i.e., MATCH_ODDS, HALF_TIME_SCORE). You should use this instead of relying on the market name as the market type codes are the same in all locales. Please note: All market types are available via the listMarketTypes operations.

marketStartTime

Betting Type Definitions#TimeRangeTimeRange

Restrict to markets with a market start time before or after the specified date

withOrders

Set< OrderStatus >

Restrict to markets where I have one or more orders in these states.

raceTypes

Set<String>

Restrict to markets of a specific raceType. Valid values are -Harness, Flat, Hurdle, Chase, Bumper, NH Flat, Steeple (AUS/NZ races), and NO_VALUE (when no valid race type has been mapped).   

For AUS/NZ races, the following definitions apply:

• Flat’ – Used for standard ANZ thoroughbred races

• ‘Harness’ – Self-explanatory – used for Aus/NZ harness racing events.

• ‘Steeple’ – Used for Aus/NZ steeple chase races.

• ‘Hurdle’ - Used for Aus/NZ hurdle races.

marketId

String

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

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

Betting Type Definitions#MarketDescriptionMarketDescription

Details about the market

totalMatched

Double

The total amount of money matched on the market.  Please note:  The returned value is cached.  For the live total matched value please use listMarketBook.

runners

List< Betting Type Definitions#RunnerCatalog List <RunnerCatalog>

The runners (selections) contained in the market

eventType

Betting Type Definitions#EventTypeEventType

The Event Type the market is contained within

competition

Betting Type Definitions#CompetitionCompetition

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

event

Betting Type Definitions#EventEvent

The event the market is contained within

marketId

String

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

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

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< Betting Type Definitions#Runner 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 of the runner (selection). Please note - the same selectionId and runnerName pairs are used accross all Betfair markets which contain them.

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

Betting Type Definitions#StartingPricesStartingPrices

The BSP related prices for this runner

ex

Betting Type Definitions#ExchangePricesExchangePrices

The Exchange prices available for this runner

orders

List< Betting Type Definitions#Order Order >

List of orders in the market

matches

List< Betting Type Definitions#Match 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< Betting Type Definitions#PriceSize 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< Betting Type Definitions#PriceSize PriceSize >

The lay amount matched at the actual Betfair Starting Price. Pre-reconciliation, this field is zero for all prices except 1000 (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. Please note: for REMOVED runners the actualSP will be returned as 'NaN. Value may be returned as 'Infinity' if no BSP can be calculated.

availableToBack

List< Betting Type Definitions#PriceSize PriceSize >

availableToLay

List< Betting Type Definitions#PriceSize PriceSize >

tradedVolume

List< Betting Type Definitions#PriceSize PriceSize >

event

Betting Type Definitions#EventEvent

Event

marketCount

int

Count of markets associated with this event

competition

Betting Type Definitions#CompetitionCompetition

Competition

marketCount

int

Count of markets associated with this competition

competitionRegion

String

Region in which this competition is happening

eventType

Betting Type Definitions#EventTypeEventType

The ID identifying the Event Type

marketCount

int

Count of markets associated with this eventType

timeRange

Betting Type Definitions#TimeRangeTimeRange

TimeRange

marketCount

int

Count of markets associated with this TimeRange

persistenceEnabled

boolean

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

bspMarket

boolean

If 'true' the market supports Betfair SP betting

marketTime

Date

The market start time. This is the scheduled start time of the market e.g. horse race or football match etc.

suspendTime

Date

The market suspend time. This is the next time the market will be suspended for betting and is normally the same as the marketTime.

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. Value include “GIBRALTAR REGULATOR" (.com), MR_ESP (Betfair.es markets), MR_IT (Betfair.it). GIBRALTAR REGULATOR = MR_INT in the Stream API

marketBaseRate

double

The commission rate applicable to the market

discountAllowed

boolean

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.

rules

String

The market rules.

rulesHasDate

boolean

Indicates whether rules have a date included.

eachWayDivisor

double

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

Betting Type Definitions#MarketLineRangeInfoMarketLineRangeInfo

Line range info for line markets

raceType

String

An external identifier of a race type

priceLadderDescription

Betting Type Definitions#PriceLadderDescriptionPriceLadderDescription

Details about the price ladder in use for this market.

eventTypeId

Betting Type Definitions#EventTypeIdEventTypeId

The id of the event type bet on. Available at EVENT_TYPE groupBy level or lower.

eventId

Betting Type Definitions#EventIdEventId

The id of the event bet on. Available at EVENT groupBy level or lower.

marketId

Betting Type Definitions#MarketIdMarketId

The id of the market bet on. Available at MARKET groupBy level or lower.

selectionId

Betting Type Definitions#SelectionIdSelectionId

The id of the selection bet on. Available at RUNNER groupBy level or lower.

handicap

Betting Type Definitions#HandicapHandicap

The handicap.  Enter the specific handicap value (returned by RUNNER in listMaketBook) if the market is an Asian handicap market. Available at MARKET groupBy level or lower.

betId

BetId

The id of the bet. Available at BET groupBy level.

placedDate

Date

The date the bet order was placed by the customer. Only available at BET groupBy level.

persistenceType

PersistenceType

The turn in play persistence state of the order at bet placement time. This field will be empty or omitted on true SP bets. Only available at BET groupBy level.

orderType

OrderType

The type of bet (e.g standard limited-liability Exchange bet (LIMIT), a standard BSP bet (MARKET_ON_CLOSE), or a minimum-accepted-price BSP bet (LIMIT_ON_CLOSE)). If the bet has a OrderType of MARKET_ON_CLOSE and a persistenceType of MARKET_ON_CLOSE then it is a bet which has transitioned from LIMIT to MARKET_ON_CLOSE. Only available at BET groupBy level.

side

Side

Whether the bet was a back or lay bet. Available at SIDE groupBy level or lower.

itemDescription

Betting Type Definitions#ItemDescriptionItemDescription

A container for all the ancillary data and localised text valid for this Item

betOutcome

String

The settlement outcome of the bet. Tri-state (WIN/LOSE/PLACE) to account for Each Way bets where the place portion of the bet won but the win portion lost. The profit/loss amount in this case could be positive or negative depending on the price matched at. Only available at BET groupBy level.

priceRequested

Betting Type Definitions#PricePrice

The average requested price across all settled bet orders under this Item. Available at SIDE groupBy level or lower. For LINE markets this is the line position requested. For LINE markets this is the line position requested. 

settledDate

Date

The date and time the bet order was settled by Betfair. Available at SIDE groupBy level or lower.

lastMatchedDate

Date

The date and time the last bet order was matched by Betfair. Available on Settled orders only.

betCount

int

The number of actual bets within this grouping (will be 1 for BET groupBy)

commission

Size

The cumulative amount of commission paid by the customer across all bets under this Item, in the account currency. Available at EXCHANGE, EVENT_TYPE, EVENT and MARKET level groupings only.

priceMatched

Betting Type Definitions#PricePrice

The average matched price across all settled bets or bet fragments under this Item. Available at SIDE groupBy level or lower. For LINE markets this is the line position matched at. 

priceReduced

boolean

If true, then the matched price was affected by a reduction factor due to of a runner removal from this Horse Racing market.

sizeSettled

Betting Type Definitions#SizeSize

The cumulative bet size that was settled as matched or voided under this Item, in the account currency. Available at SIDE groupBy level or lower.

profit

Betting Type Definitions#SizeSize

The profit or loss (negative profit) gained on this line, in the account currency

sizeCancelled

Betting Type Definitions#SizeSize

The amount of the bet that was available to be matched, before cancellation or lapsing, in the account currency

customerOrderRef

String

The order reference defined by the customer for the bet order

customerStrategyRef

String

The strategy reference defined by the customer for the bet order

clearedOrders

List<Betting Type Definitions#ClearedOrderSummaryClearedOrderSummary>

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.

marketVersion

Betting Type Definitions#MarketVersionMarketVersion

The relevant version of the market for this item

marketId

MarketId

The id of the market bet on

selectionId

SelectionId

The id of the selection bet on

handicap

Betting Type Definitions#HandicapHandicap

The handicap associated with the runner in case of asian handicap markets, otherwise returns '0.0'.

currentOrders

List< Betting Type Definitions#CurrentOrderSummary 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

Betting Type Definitions#PriceSizePriceSize

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.

matchedDate

Date

The date, to the second, of the last matched bet fragment (where applicable)

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

currentItemDescription

Betting Type Definitions#CurrentItemDescriptionCurrentItemDescription

A container for all the ancillary data for this Item

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

Betting Type Definitions#LimitOrderLimitOrder

A simple exchange bet for immediate execution

limitOnCloseOrder

Betting Type Definitions#LimitOnCloseOrderLimitOnCloseOrder

Bets are matched if, and only if, the returned starting price is better than a specified price. In the case of back bets, LOC bets are matched if the calculated starting price is greater than the specified price. In the case of lay bets, LOC bets are matched if the starting price is less than the specified price. If the specified limit is equal to the starting price, then it may be matched, partially matched, or may not be matched at all, depending on how much is needed to balance all bets against each other (MOC, LOC and normal exchange bets)

marketOnCloseOrder

Betting Type Definitions#MarketOnCloseOrderMarketOnCloseOrder

Bets remain unmatched until the market is reconciled. They are matched and settled at a price that is representative of the market at the point the market is turned in-play. The market is reconciled to find a starting price and MOC bets are settled at whatever starting price is returned. MOC bets are always matched and settled, unless a starting price is not available for the selection. Market on Close bets can only be placed before the starting price is determined

customerOrderRef

String

An optional reference customers can set to identify instructions.. No validation will be done on uniqueness and the string is limited 
to 32 characters. If an empty string is provided it will be treated as null.

customerRef

String

Echo of the customerRef if passed.

status

ExecutionReportStatus

errorCode

ExecutionReportErrorCode

marketId

String

Echo of marketId passed

instructionReports

List< Betting Type Definitions#PlaceInstructionReport PlaceInstructionReport >

status

InstructionReportStatus

Whether the command succeeded or failed

errorCode

InstructionReportErrorCode

Cause of failure, or null if the command succeeds

orderStatus

OrderStatus

The status of the order, if the instruction succeeded. If the instruction is unsuccessful, no value is provided.  
Please note:  by default, this field is not returned for MARKET_ON_CLOSE and LIMIT_ON_CLOSE orders.

instruction

Betting Type Definitions#PlaceInstructionPlaceInstruction

The instruction that was requested

betId

String

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

placedDate

Date

Will be null if the order was placed asynchronously

averagePriceMatched

Price

Will be null if the 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 the order was placed asynchronously

customerRef

String

Echo of the customerRef if passed.

status

ExecutionReportStatus

errorCode

ExecutionReportErrorCode

marketId

String

Echo of marketId passed

instructionReports

List< Betting Type Definitions#CancelInstructionReport CancelInstructionReport >

customerRef

String

Echo of the customerRef if passed.

status

ExecutionReportStatus

errorCode

ExecutionReportErrorCode

marketId

String

Echo of marketId passed

instructionReports

List< Betting Type Definitions#ReplaceInstructionReport ReplaceInstructionReport >

status

InstructionReportStatus

whether the command succeeded or failed

errorCode

InstructionReportErrorCode

cause of failure, or null if command succeeds

cancelInstructionReport

Betting Type Definitions#CancelInstructionReportCancelInstructionReport

Cancellation report for the original order

placeInstructionReport

Betting Type Definitions#PlaceInstructionReportPlaceInstructionReport

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

Betting Type Definitions#CancelInstructionCancelInstruction

The instruction that was requested

sizeCancelled

double

cancelledDate

Date

customerRef

String

Echo of the customerRef if passed.

status

ExecutionReportStatus

errorCode

ExecutionReportErrorCode

marketId

String

Echo of marketId passed

instructionReports

List< Betting Type Definitions#UpdateInstructionReport UpdateInstructionReport >

status

InstructionReportStatus

whether the command succeeded or failed

errorCode

InstructionReportErrorCode

cause of failure, or null if command succeeds

instruction

Betting Type Definitions#UpdateInstructionUpdateInstruction

The instruction that was requested

priceData

Set< PriceData >

The basic price data you want to receive in the response.

exBestOffersOverrides

Betting Type Definitions#ExBestOffersOverridesOffersOverrides

Options to alter the default representation of best offer prices Applicable to EX_BEST_OFFERS priceData selection

virtualise

boolean

Indicates if the returned prices should include virtual prices. Applicable to EX_BEST_OFFERS and EX_ALL_OFFERS priceData selections, default value is false. Please note: This must be set to 'true' replicate the display of prices on the Betfair Exchange website.

rolloverStakes

boolean

Indicates if the volume returned at each price point should be the absolute value or a cumulative sum of volumes available at the price and all better prices. If unspecified defaults to false. Applicable to EX_BEST_OFFERS and EX_ALL_OFFERS price projections. Not supported as yet.

marketId

String

The unique identifier for the market

commissionApplied

double

The commission rate applied to P&L values. Only returned if netOfCommision option is requested

profitAndLosses

List<Betting Type Definitions#RunnerProfitAndLossRunnerProfitAndLoss>

Calculated profit and loss data.

selectionId

Betting Type Definitions#SelectionIdSelection

The unique identifier for the selection

ifWin

double

Profit or loss for the market if this selection is the winner.

ifLose

double

Profit or loss for the market if this selection is the loser. Only returned for multi-winner odds markets.

ifPlace

double

Profit or loss for the market if this selection is placed. Applies to marketType EACH_WAY only.