Betting Type Definitions

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

TimeRange

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

MarketDescription

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 <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.'

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< 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. The same selectionId and runnerName pairs are used accross all Betfair markets which contain them. Please note: The selectionId can be mapped to the runner name using the output from listMarketCatalogue

runnerName

String

The name of the runner.

handicap

double

The handicap applies to market with the MarketBettingType ASIAN_HANDICAP_SINGLE_LINE & ASIAN_HANDICAP_DOUBLE_LINE only otherwise '0'

sortPriority

int

The sort priority of this runner. Indicates the order in which the runners are displayed on the Betfair Exchange website.

metadata

Map<String,String>

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