No Subscription to this function
GET /american_football/get_competitions
Returns all competitions from an area.
Request URL
https://dsg-api.com/clients/{client_name}/american_football/get_competitions?client={client_name}&authkey={client_authkey}
Parameters
area_id
int
area to get the subareas or specific area from
authkey
string Required
client authentification key
client
string Required
unique client ID
ftype
string
changes feed type from XML to json (ftype=json)
lang
string
two-character language code, defaults to 'en'
Nodes
area
Details about area
area_id
unique identifier for an area.
country_code
Three character country code
name
name of the area.
parent_area_id
unique identifier of the parent area (either continent or World)
competition
Details about competition
area_id
unique identifier for area.
area_name
contains the area name.
competition_id
unique identifier for a competition.
format
competition format to filter out leagues or cups
last_updated
When record was last updated. Format YYYY-MM-DD HH:MM:SS in CET timezone.
name
name of the competition.
teamtype
determines the type of team/competition (male,female,male_youth,female_youth)
type
determines if a competition is between club teams (club) or national teams (international).
datasportsgroup
details about the API version, sport, language and generation timestamp
generated_utc
UTC timestamp when the API output was generated
lang
language of the API
sport
sport of the API
version
version of the API
method
details about the API function
method_id
unique ID of method.
name
name of method.
Response Headers
200
Success
401
Unauthorized
429
Too Many Requests
Code Samples
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://dsg-api.com/clients/{client_name}/american_football/get_competitions?client={client_name}&authkey={client_authkey}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_USERPWD, "{User}:{Password}");
$content = curl_exec($ch);
curl_close($ch);
?>
curl GET -u "User:Password" "https://dsg-api.com/clients/{client_name}/american_football/get_competitions?client={client_name}&authkey={client_authkey}"
response = requests.get("https://dsg-api.com/clients/{client_name}/american_football/get_competitions?client={client_name}&authkey={client_authkey}", auth=("User", "Password"))
Response Example
200 Success
{"datasportsgroup":{"version":"1.0","sport":"american_football","lang":"en","method":{"method_id":"66","name":"get_competitions"},"competition":[{"competition_id":"1093","name":"CFL","teamtype":"male","type":"club","format":"domestic_league","area_id":"43","area_name":"Canada","last_updated":"2018-06-06 11:33:23"},{"competition_id":"1","name":"NFL","teamtype":"male","type":"club","format":"domestic_league","area_id":"203","area_name":"United States","last_updated":"2019-01-05 03:12:48"},{"competition_id":"1002","name":"NCAA Division I FBS","teamtype":"male","type":"club","format":"domestic_league","area_id":"203","area_name":"United States","last_updated":"2018-06-06 10:58:40"}]}}