Resource information
URL | https://api.softnetsportstatscore.com/v2/competitions | XSD | https://api.softnetsport.com/assets/API/docs/xsd/competitions.index.xsd |
---|---|---|---|
Method | GET | ||
Description | Returns a list of all available competitions | ||
Cache | 60 seconds | ||
Authorization required | Yes |
...
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 | |||||
date_from | xsd:string | REQUIRED. If not used, the date will be automatically set for the current day. Selection datetime, format 'yyyy-mm-dd hh:mm:ss'. UTC Format. Returns only competitions with event start date greater than or equal to date_from. | |||||
date_to | xsd:string | REQUIRED. If not used, the date will be automatically set for the current day. Selection datetime, format 'yyyy-mm-dd hh:mm:ss'. UTC Format. Returns only competitions with an event start date less than or equal date_to (the date range cannot be greater than 1 month) | |||||
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:
| |||||
type | xsd:string | Determines type competition. Possible values:
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. (Up to 100 ids) | |||||
gender | xsd:string | Determines competition gender. Allows selection of e.g. only WTA Womens Competitions in Tennis. Possible values:
| |||||
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:
| |||||
participant_ | fromid | xsd: | 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_to | xsd: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.int | Determines the identifier of the participant. To use this parameter, date_from and date_to parameters must be given. |
status_type | xsd:string | Return only competition with event status live,finished,scheduled,other,cancelled,interrupted,deleted. | |||||
tz | xsd:string | Custome timezone for data_from and date_to. |
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.statscore.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 |
Returns a list of all international cups, mens competitions for soccer which are played in Europe |
...