v1

latestSwagger 2.02026-07-14152156.8 KB
sportsdata

Retrieves a list of events for a given competition id.

Retrieves a list of events for a given competition id. 'headlineSummary' and includeAllDescendants parameters should be accompanied with 'date' filter or one of 'dateFrom' and 'dateTo' filters.

get/competitions/{competitionId}/events/

Path parameters

competitionIdstring required

The competition id to retrieve information for.

Query parameters

isPublishedstring

Specify whether only active entities should be returned, according to the William Hill definition of active

fieldsstring[]

Specify an absolute field list to return (Comma-Separated List)

includestring[]

Specify fields in addition to the default to return (Comma-Separated List)

excludestring[]

Specify fields from the default to exclude (Comma-Separated List)

displayedstring

Specify whether to return displayed entities or not

channelstring

Specify a channel filter and only results from that channel will be returned

settledboolean

Specify wether only settled entities should be returned

includeEmptyboolean

When declared as false it should exclude markets and events that have no selections / markets

statusstring

Specify a status to filter results by. This is currently A (active) or S (suspended)

sortstring

The field to order the response by, followed by the order. For example: name,desc

offsetinteger

Skip over a number of elements by specifying a start value for the query

limitinteger

Specify the number of results to return

headlineSummaryboolean

Return only headline markets (Markets with the lowest display order) Either 1 InPlay and 1 Pre-Match, or the amount specified in marketCount, if available. Markets and Outcomes will be returned.

includeAllDescendantsboolean

Include every descendant in the below heirarchy

isInPlayboolean

Show only events that are in-play

marketCountinteger

Specify the number of markets to return when requesting headlineSummary. This count of InPlay and Pre-Match markets will be returned.For example, when specifying 1, 1 In Play and 1 Pre Match market will be returned.

datestring

Return only events for the specified date (yyyy-MM-dd).

dateFromstring

The UTC datetime from the events to be returned. (yyyy-MM-ddTHH:mm:ss)

dateTostring

The UTC datetime TO the events to be returned. (yyyy-MM-ddTHH:mm:ss)

marketGroupIdstring

Filter by marketGroupId (e.g. OB_MG1276585).

eventSortstring

Filter event by event sort

culturestring

Code used to return responses in language other than English, acceptable values are en-GB|de-DE|es-ES|fr-FR|nn-NO|fi-FI|ru-RU|pt-PT|hu-HU|sl-SL|ga-IE|en-CA|sr-Latn|sv-SE|el=GR|zh-CHS|it-IT|zh-CHT|cs-CZ|de-AT|ja-JP|pl-PL|da-DK|ro-RO|nl-NL|tr-TR

marketPublishedstring

Specify whether only active entities should be returned, according to the William Hill definition of active

marketStatusstring

Specify a status to filter results by. This is currently A (active) or S (suspended)

marketDisplayedstring

Specify whether to return displayed entities or not

marketChannelstring

Specify a channel filter and only results from that channel will be returned

marketSortstring

Filter by market sort (e.g. MR (match result) -- (Outright)).

marketEWstring

Specify whether to return markets with each way betting or those without

selectionStatusstring

Specify a status to filter results by. This is currently A (active) or S (suspended)

selectionChannelstring

Specify a channel filter and only results from that channel will be returned

selectionPublishedstring

Specify whether only active entities should be returned, according to the William Hill definition of active

Headers

apiKeystring required

Your API Key available from your developer portal

Response

Success