Versions Compared

Key

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

...

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

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


...