competitions.index

Resource information

URL	https://api.softnetsport.com/v2/competitions
XSD	https://api.softnetsport.com/assets/API/docs/xsd/competitions.index.xsd
Method	GET
Description	Returns competitions supported in the API service
Cache	60 seconds
Authorization required	Yes

Method parameters

Name	Type	Description
There are no method parameters in this resource

Query parameters

Name	Type	Description
token	xsd:string	REQUIRED. More information concerning authorization in API introduction section
lang	xsd:string	Determines the language for the output data. The complete list of possible languages can be retrieved using the API resource: languages.index
page	xsd:int	Determines offset of paginated data. Default value is 1 which means first page
limit	xsd: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_type	xsd:string	Determines type of area in which competitions are played. Possible values: country international
type	xsd: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_id	xsd: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 ",". The complete list of possible areas can be retrieved using the API resource: areas.index
sport_id	xsd:int	Determines the sport identificator in which the competitions are played. The complete list of possible sports can be retrieved using the API resource: sports.index
tour_id	xsd:int	Determines the tour identificator in which the competitions are played. The complete list of possible tours can be retrieved using the API resource: tours.index
multi_ids	xsd:string	List of competition identifiers should be separated by a comma (e.g. 123,234,321) for the selected competitions details.
gender	xsd:string	Determines competition gender. Allows selection of e.g. only WTA Womens Competitions in Tennis. Possible values: male female mixed
timestamp	xsd:unix_timestamp	Selection date, format UNIX_TIMESTAMP. Only changes in competitions that occurred or were updated after this timestamp will be returned
short_name	xsd:string	Determines competition short_name. The attribute must have minimum 3 characters.
sort_type	xsd:string	Determines sort type for competitions (internal usage only). Possible values: tour

Method calling examples

Link	Description
https://api.softnetsport.com/v2/competitions.xml?token={{YOUR_TOKEN}}	Returns a list of all competitions in XML format
https://api.softnetsport.com/v2/competitions?token={{YOUR_TOKEN}}	Returns a list of all competitions in JSON format
https://api.softnetsport.com/v2/competitions?token= {{YOUR_TOKEN}}&type=country_league&gender=male	Returns a list of all mens competitions which are country leagues
https://api.softnetsport.com/v2/competitions?token= {{YOUR_TOKEN}}&type=international_cup&sport_id=5&area_id=203&gender=male	Returns a list of all international cups, mens competitions for soccer which are played in Europe

Output elements

.competitions
..competition
id	Unique identifier for the competition
name	Name of the the competition e.g. U19 World Champ. Possible translation of the attribute
short_name	Abbreviated name of the competition e.g. U19 WCH, Max 20 characters. Possible translation of the attribute
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_id	Unique identifier for area in which competitions are played. The complete list of possible areas can be retrieved using the API resource: areas.index
area_name	Name of area in which competitions are played. Possible translation of the attribute
area_type	Type of area in which competitions are played. Possible values: country international
area_sort	The 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_code	Max 3 characters, area in which competitions are played
overall_sort	The parameter used to sort competitions. Sorting direction is ascending
sport_id	Unique identifier for the sport in which the competition is played. The complete list of possible sports can be retrieved using the API resource: sports.index
sport_name	Name of the sport in which the competition is played. Possible translation of the attribute
tour_id	Unique identifier for the tour in which thecompetition is played. The complete list of possible tours can be retrieved using the API resource: tours.index
tour_name	Name of the tour in which the competition is played
ut	Information about when the date and time of the competition record was last updated. Format UNIX_TIMESTAMP
old_competition_id	DEPRECATED. The attribute will be removed in the next API version
slug	friendly url for competition