Retrieves a list of competitions for a given class id.

GET

/classes/{classId}/competitions/

sportsdata

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - response

{
 "competitions": [
 {
 "id": "OB_TY1733",
 "name": "Manchester Senior Cup",
 "status": "A"
 }
 ]
}

Request

Path Params

classId

string

required

The class 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

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

culture

string

optional

Header Params

apiKey

string

required

Your API Key available from your developer portal

Responses

🟢200Success

application/json

Body

competitions

array[object (competition) {12}]

optional

betInRunningDelay

number

optional

Delay in seconds between bet being sent and bet being placed

cashinAvailable

boolean

optional

Indicates whether cashin is available on the events of this competition

channels

array[string]

optional

A list of channels that apply to this competition

description

string

optional

The description of the competition

displayed

boolean

optional

Whether the competition should be displayed or not

flags

array[string]

optional

A list of flags that apply to this competition

string

required

The Id of the Competition

isPublished

boolean

optional

Indicates if the item is published or not

name

string

required

The name of the competition

order

integer

optional

The display order of the competition

parentIds

array[string]

optional

A list of IDs of parent entities

status

string

required

The status of the competition (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 list of events for a given class id.