Versions Compared

Key

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

Resource information

...

NameTypeDescription
tokenxsd:stringREQUIRED. More information concerning authorization in API introduction section
langxsd:string

Determines the language for the output data

pagexsd:intDetermines offset of paginated data. Default value is 1 which means first page
limitxsd:int

Determines maximum number of returned records on page. Used in paginated data. Default value is 500

Possible values: 5, 10, 25, 50, 100, 250, 500

area_typexsd:stringDetermines type of area in which competitions are played. Possible values:
  • country
  • international
typexsd:string

Determines type competition. Possible values:

  • country_league - e.g. Premier Division
  • country_cups - e.g. FA Cup
  • international - e.g. World Cup
  • international_clubs - e.g. Champions League 
  • friendly - friendly matches
  • individual - for speedway individual competitions such as Speedway GP
  • team - for speedway national competitions
  • single - for tennis competitions
  • double - for tennis competitions
  • mixed - for tennis competitions
  • undefined - for other competitions

For more than one area type you should provide values separated by a comma ","

area_idxsd:int

Determines the area in which competition are played. API provides the following areas: areas.index

For more than one area you should provide values separated by a comma ","

sport_idxsd:intDetermines the sport identificator in which the competitions are played. API provides the following sports: sports.index
tour_idxsd:intDetermines the tour identificator in which the competitions are played. API provides the following tours: tours.index
multi_idsxsd:stringList of competition identifiers should be separated by a comma (e.g. 123,234,321) for the selected competitions details.
genderxsd:string

Determines competition gender. Allows selection of e.g. only WTA Womens Competitions in Tennis. Possible values:

  • male
  • female
  • mixed
timestampxsd:unix_timestampSelection date, format UNIX_TIMESTAMP. Only changes in competitions that occurred or were updated after this timestamp will be returned
short_namexsd:string
Determines competition short_name. The attribute must have minimum 3 characters.
sort_typexsd:stringDetermines sort type for competitions (internal usage only). Possible values: 
  • tour 
date_fromxsd:stringSelection datetime, format 'yyyy-mm-dd hh:mm:ss'. UTC Format. Return only competition with event starte date greater than or equal date_from.
date_toxsd:string Selection datetime, format 'yyyy-mm-dd hh:mm:ss'. UTC Format. Return only competition with event starte date less than or equal date_to.
event_status_type
xsd:stringReturn only competition with event status live,finished,scheduled,other,cancelled,interrupted,deleted.
tzxsd:stringCustome timezone for data_from and date_to.

...


.competitions
..competition
idUnique identifier for the competition
nameName of the the competition e.g. U19 World Champ
short_nameAbbreviated name of the competition e.g. U19 WCH, Max 20 characters
mini_name

Mini name of the competition. Max 3 characters in length e.g. U19

gender

Competition gender. Possible values:

  • male
  • female
  • mixed
type

Competitions type. Possible values:

  • country_league - e.g Premier Division
  • country_cups - e.g. FA Cup
  • international - e.g. World Cup
  • international_clubs - e.g. Champions League 
  • friendly - friendly matches
  • individual - for speedway individual competitions such as Speedway GP
  • team - for speedway national competitions
  • single - for tennis competitions
  • double - for tennis competitions
  • mixed - for tennis competitions
  • undefined - other
area_idUnique identifier for area in which competitions are played 
area_nameName of area in which competitions are played
area_type

 Type of area in which competitions are played. Possible values:

  • country
  • international
area_sortThe parameter used to sort competitions in a country e.g. Premier League is 1st and the Championship is 2nd in English competitions. Sorting direction is ascending
area_codeMax 3 characters, area in which competitions are played
overall_sortThe parameter used to sort competitions. Sorting direction is ascending
sport_idUnique identifier for the sport in which the competition is played 
sport_nameName of the sport in which the competition is played
tour_idUnique identifier for the tour in which thecompetition is played
tour_nameName of the tour in which the competition is played
utInformation about when the date and time of the competition record was last updated. Format UNIX_TIMESTAMP
old_competition_idDEPRECATED. The attribute will be removed in the next API version
slugfriendly url for competition



event_status_type