Versions Compared

Key

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

Operation

...

Panel
bgColor#FFFFFF
titleBGColor#C8D0E4
titlelistMarketCatalogue
List< MarketCatalogue > listMarketCatalogue ( MarketFilter filter ,Set< MarketProjection >marketProjection, MarketSort sort, intmaxResults ,Stringlocale ) throws APINGException

Returns a list of information about published (ACTIVE/SUSPENDED) markets that does not change (or changes very rarely). You use listMarketCatalogue to retrieve the name of the market, the names of selections and other information about markets.  Market Data Request Limits apply to requests made to listMarketCatalogue.

Please note: listMarketCatalogue does not return markets that are CLOSED.

Parameter name

Type

Required

Description

filter

MarketFilter

(tick)

The filter to select desired markets. All markets that match the criteria in the filter are selected.

marketProjection

Set< MarketProjection >

 

The type and amount of data returned about the market.

sort

MarketSort

 

The order of the results. Will default to RANK if not passed. RANK is an assigned priority that is determined by our Market Operations team in our back-end system. A result's overall rank is derived from the ranking given to the flowing attributes for the result. EventType, Competition, StartTime, MarketType, MarketId. For example, EventType is ranked by the most popular sports types and marketTypes are ranked in the following order: ODDS ASIAN LINE RANGE If all other dimensions of the result are equal, then the results are ranked in MarketId order.

maxResults

int

(tick)

limit on the total number of results returned, must be greater than 0 and less than or equal to 1000

locale

String

 

The language used for the response. If not specified, the default is returned.

Return type

Description

List< MarketCatalogue >

output data

Throws

Description

APINGException

Generic exception that is thrown if this operation fails for any reason.

Since 1.0.0

...