Versions Compared

Key

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

Type definitions

...

Panel
bgColor#FFFFFF
titleBGColor#FFCC33
titleMarketFilter


Field name

Type

Required

Description

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 Racing & 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: 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 that I have one or more orders in these status.

raceTypes

Set<String>


Restrict by race type (i.e. Hurdle, Flat, Bumper, Harness, Chase, Steeple (AUS/NZ races only)


...

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


...