Retrieves a list of events for a given competition id.

GET

/competitions/{competitionId}/events/

sportsdata

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.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://sandbox.whapi.com/v2/sportsdata/competitions//events/' \
--header 'apiKey;'

Response Example

200 - response

{
"events": [
 {
 "id": "OB_EV2828",
 "name": "Forest Green Vs Liverpool",
 "status": "A",
 "startDateTime": "2016-01-29T20:00:00"
 },
 {
 "id": "OB_EV2829",
 "name": "XXXMan Utd Vs Man City",
 "status": "A",
 "startDateTime": "2016-01-07T11:00:00"
 },
 {
 "id": "OB_EV2849",
 "name": "Manchester Senior Cup - Winners 2015-16",
 "status": "A",
 "startDateTime": "2016-01-01T00:00:00"
 }
]
}

Request

Path Params

competitionId

string

required

The competition id to retrieve information for.

Query Params

isPublished

string

optional

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

fields

array[string]

optional

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

include

array[string]

optional

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

exclude

array[string]

optional

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

displayed

string

optional

Specify whether to return displayed entities or not

channel

string

optional

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

settled

string

optional

Specify wether only settled entities should be returned

includeEmpty

string

optional

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

status

string

optional

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

sort

string

optional

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

offset

integer

optional

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

limit

integer

optional

Specify the number of results to return

headlineSummary

string

optional

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.

includeAllDescendants

string

optional

Include every descendant in the below heirarchy

isInPlay

string

optional

Show only events that are in-play

marketCount

integer

optional

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.

date

string

optional

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

dateFrom

string

optional

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

dateTo

string

optional

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

marketGroupId

string

optional

Filter by marketGroupId (e.g. OB_MG1276585).

eventSort

string

optional

Filter event by event sort

culture

string

optional

marketPublished

string

optional

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

marketStatus

string

optional

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

marketDisplayed

string

optional

Specify whether to return displayed entities or not

marketChannel

string

optional

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

marketSort

string

optional

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

marketEW

string

optional

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

selectionStatus

string

optional

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

selectionChannel

string

optional

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

selectionPublished

string

optional

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

Header Params

apiKey

string

required

Your API Key available from your developer portal

Responses

🟢200Success

application/json

Body

events

array[object (event) {27}]

optional

betInRunningDelay

number

optional

Delay in seconds between bet being sent and bet being placed

bettingStatus

string

optional

Betting status of the event

cashinAvailable

boolean

optional

Whether cashin is available on this event

channels

array[string]

optional

A list of channels that apply to this event

country

string

optional

A string indicating the country code of this event if available

description

string

optional

The description of the event

displayed

boolean

optional

whether the event should be displayed or not

eventSort

string

optional

What type of event is this? (e.g. MTCH, TRNMT)

flags

array[string]

optional

A list of flags that apply to this event

hasInPlayMarkets

boolean

optional

Whether this event has inplay markets

hasLivePrices

boolean

optional

Whether this event has Live Prices

string

required

The Id of the event

isInPlay

boolean

optional

Whether this event has started and therefore is inplay

isPublished

boolean

optional

Indicates if the item is published

marketCountActiveInPlay

number

optional

Count of active markets in play

marketCountActivePreMatch

number

optional

count of active market pre-match

marketCountActiveTotal

number

optional

Total market count

marketCountInPlay

number

optional

Total inplay markets

marketCountPreMatch

number

optional

Total prematch markets

markets

array[object (market) {34}]

optional

A list of markets belonging to this event

name

string

required

The name of the event

order

number

optional

Display order of the event

parentIds

array[string]

optional

A list of IDs of parent entities

raceNum

string

optional

Race number for race events

settled

boolean

optional

Whether the event has been settled

startDateTime

string

required

The start date and time of the event

status

string

required

Status of the event (A for Active, S for Suspended)

🟠400Incorrect or Missing Parameter

🟠404No data found for request

Modified at 2023-08-15 06:10:46

Retrieves a specific competition

Retrieves a list of market groups for a given competition id