API Documentation

GetFixtures

The endpoint {fixtures} allows you to retrieve active fixtures in one sport from one country. Active fixtures are all fixtures in a state before and up to 2 hours after their cut-off date. Mandatory input parameters are the Sport ID and the Country. The fixtures are returned together with their markets, options, and prices. The refresh interval for this endpoint is 2 seconds.

Request

GET /offer/api/{sportId}/{country}/fixtures[?language&competitionIds&fixtureIds&isInPlay&onlyMainMarkets&since]

Parameters

Name	Type	Default	Notes
*sportId			The unique ID of the sport. Mandatory.
*country			The country's Alpha-2 code, as defined in ISO 3166. Mandatory. See https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes for details.
language		en	The Language Code as defined in the list of supported language codes. If not specified, "en" is assumed.
competitionIds			A list of Competition IDs. Make sure that the competitions are defined for the specified sport.
fixtureIds			A list of unique IDs of fixtures. Optional. Limits the response to the fixtures with the given IDs.
isInPlay			A filter for including only fixtures in pre-match ({false}) or in-play ({true}) state. If not specified, both are included.
onlyMainMarkets		True	A filter to include only markets previously defined as main markets, including the balanced line markets.
since			A timestamp in UTC time. Data is retrieved from this point up to now. Format: {yyyyMMddHHmmss}.

Responses

Status Code	Type	Description	Samples
200	FixtureResultEnvelope	Success

GetFixtureIndex

The endpoint {fixtureIndex} allows you to retrieve an overview of the active fixtures in one sport from one country. "Active" fixtures are all fixtures in a state before and up to 2 hours after their cut-off date. Mandatory input parameters are the Sport ID and the Country Code. The fixtures are returned without markets, options, and prices. The refresh interval for this endpoint is 2 seconds.

Request

GET /offer/api/{sportId}/{country}/fixtureIndex[?language&competitionIds&fixtureIds&isInPlay&since]

Parameters

Name	Type	Default	Notes
*sportId			The unique ID of the sport. Mandatory.
*country			The country's Alpha-2 code, as defined in ISO 3166. Mandatory. See https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes for details.
language		en	The Language Code as defined in the list of supported language codes. If not specified, "en" is assumed.
competitionIds			A list of Competition IDs. Make sure that the competitions are defined for the specified sport.
fixtureIds			A list of unique IDs of fixtures. Optional. Limits the response to the fixtures with the given IDs.
isInPlay			A filter for including only fixtures in pre-match ({false}) or in-play ({true}) state. If not specified, both are included.
since			A timestamp in UTC time. Data is retrieved from this point up to now. Format: {yyyyMMddHHmmss}.

Responses

Status Code	Type	Description	Samples
200	FixtureIndexResultEnvelope	Success

GetCompetitions

The endpoint {competitions} allows you to retrieve the available competitions in one sport from one country. Mandatory input parameters are the Sport ID and the Country Code. The refresh interval for this endpoint is 1 second.

Request

GET /offer/api/{sportId}/{country}/competitions[?participants&language]

Parameters

Name	Type	Default	Notes
*sportId			The unique ID of the sport. Mandatory.
*country			The country's Alpha-2 code, as defined in ISO 3166. Mandatory. See https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes for details.
participants			A filter for including the list of participants (teams/players) in the competition ({true}) or not ({false}). Optional. If not specified, the list is not included.
language		en	The Language Code as defined in the list of supported language codes. If not specified, "en" is assumed.

Responses

Status Code	Type	Description	Samples
200	CompetitionResultEnvelope	Success

GetSports

The endpoint {sports} allows you to retrieve available sports in one country. Mandatory input parameter is the Country Code. The refresh interval for this endpoint is 1 second.

Request

GET /offer/api/{country}/sports[?language]

Parameters

Name	Type	Default	Notes
*country			The country's Alpha-2 code, as defined in ISO 3166. Mandatory. See https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes for details.
language		en	The Language Code as defined in the list of supported language codes. If not specified, "en" is assumed.

Responses

Status Code	Type	Description	Samples
200	SportResultEnvelope	Success

GetSupportedLanguageCodes

The endpoint {languageCodes} allows you to retrieve the complete list of supported language codes.

Request

GET /offer/api/languageCodes

Responses

Status Code	Type	Description	Samples
200	array	Success

GetScoreboards

The endpoint {scoreboards} allows you to retrieve the basic scoreboard information for fixtures: the current state of a fixture, the period the event is in and the current score (if applicable for this type of fixture), and the elapsed minutes and seconds. Mandatory input parameters are the Sport ID, and the Country. The refresh interval for this endpoint is 2 seconds.

Request

GET /offer/api/{sportId}/{country}/scoreboards[?competitionIds&fixtureIds&since]

Parameters

Name	Type	Default	Notes
*sportId			The unique ID of the sport. Mandatory.
*country			The country's Alpha-2 code, as defined in ISO 3166. Mandatory. See https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes for details.
competitionIds			A list of Competition IDs. Make sure that the competitions are defined for the specified sport.
fixtureIds			A list of unique IDs of fixtures. Optional. Limits the response to the fixtures with the given IDs.
since			A timestamp in UTC time. Data is retrieved from this point up to now. Format: {yyyyMMddHHmmss}.

Responses

Status Code	Type	Description	Samples
200	ScoreboardResultEnvelope	Success

Definitions

FixtureResultEnvelope

Name	Type	Notes
items	Fixture[]
count	integer (int32)
links	object
type	ResponseType

Fixture

Name	Type	Notes
markets	Market[]
id	CompoundIdentifier[]
name	SignedTranslation[]
version	ObjectVersion
startDateUtc	string (date-time)
cutOffDateUtc	string (date-time)
isInPlay	boolean
isDisplayed	boolean
isOpenForBetting	boolean
isPlannedInPlay	boolean
state	string
type	string
fixtureGroupId	integer (int32)
competition	Tag[]
region	Tag[]
participantType	string
participants	Participant[]

Market

Name	Type	Notes
id	integer (int64)
name	SignedTranslation[]
marketType	string
happening	string
period	string
subPeriod	string
value	number (double)
isDisplayed	boolean
isOpenForBetting	boolean
isBalancedLine	boolean
options	Option[]

SignedTranslation

Name	Type	Notes
text	string
sign	string
shortText	string
shortTextSign	string

Option

Name	Type	Notes
id	integer (int64)
name	SignedTranslation[]
price	Price[]
isDisplayed	boolean
isOpenForBetting	boolean

Price

Name	Type	Notes
fraction	Fraction[]
odds	number (double)
usOdds	number (double)

Fraction

Name	Type	Notes
numerator	integer (int32)
denominator	integer (int32)

CompoundIdentifier

Name	Type	Notes
full	string
entityId	integer (int64)

ObjectVersion

Enum Values

1
2

Tag

Name	Type	Notes
id	integer (int64)
name	Translation[]

Translation

Name	Type	Notes
text	string
shortText	string

Participant

Name	Type	Notes
id	integer (int64)
name	Translation[]
participantTag	string

ResponseType

FixtureIndexResultEnvelope

Name	Type	Notes
items	FixtureIndex[]
count	integer (int32)
links	object
type	ResponseType

FixtureIndex

Name	Type	Notes
id	CompoundIdentifier[]
name	SignedTranslation[]
version	ObjectVersion
startDateUtc	string (date-time)
cutOffDateUtc	string (date-time)
isInPlay	boolean
isDisplayed	boolean
isOpenForBetting	boolean
isPlannedInPlay	boolean
state	string
type	string
fixtureGroupId	integer (int32)
competition	Tag[]
region	Tag[]
participantType	string
participants	Participant[]

CompetitionResultEnvelope

Name	Type	Notes
items	Competition[]
count	integer (int32)
links	object
type	ResponseType

Competition

Name	Type	Notes
id	integer (int32)
version	ObjectVersion
region	Tag[]
name	Translation[]
type	string
competitionGroupId	integer (int32)

SportResultEnvelope

Name	Type	Notes
items	Sport[]
count	integer (int32)
links	object
type	ResponseType

Sport

Name	Type	Notes
id	integer (int64)
name	Translation[]

ScoreboardResultEnvelope

Name	Type	Notes
items	Scoreboard[]
count	integer (int32)
links	object
type	ResponseType

Scoreboard

Name	Type	Notes
id	CompoundIdentifier[]
version	ObjectVersion
period	string
state	string
score	string
time	ScoreboardTime[]
happenings	Happening[]

ScoreboardTime

Name	Type	Notes
minutes	integer (int32)
seconds	integer (int32)
isRunning	boolean

Happening

Name	Type	Notes
id	integer (int64)
type	string
value	string
timer	HappeningTimer[]

HappeningTimer

Name	Type	Notes
minutes	integer (int32)
seconds	integer (int32)