Subscription to this function is not available for your account. To upgrade and receive access to this contact sales@datasportsgroup.com
v4 GET /swimming/get_contestants
Returns a list of contestants
Request URL
https://dsg-api.com/clients/{client_name}/swimming/get_contestants?client={client_name}&authkey={client_authkey}&type=discipline&type_id={discipline_id}&season={season_id}
API Threshold
  • 10k calls per hour (2.78 calls per second)
  • This threshold applies to ALL your calls you do across the API.
  • Your number of calls get reset every hour at :00
  • If the thresold is reached within the hour you will get a xml/json message accordingly (which is gone when the next hour starts, see previous point)
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 or ftype=json_array)
lang
string
two-character language code, defaults to 'en'
season
int Required
unique season identifier
type
string Required
type=discipline_id is required
type_id
int Required
discipline_id to be filtered
Nodes
competition❯
details about competition
area_id
unique identifier for an area
area_name
name of the area
competition_id
unique identifier for a competition
format
competition format (domestic_league, domestic_cup, domestic_league_cup, domestic_super_cup, international_cup, international_super_cup, playoff, tournament, race, unofficial)
gender
determines the gender of the competition (male or female)
last_updated
When record was last updated. Format YYYY-MM-DD HH:MM:SS in CET timezone.
name
name of the competition
type
determines if a competition is between club teams (club) or national teams (international)
contestant❯
details about the contestant
common_name
common name of the person
contestant_team_id
unique identifier for the contestant team/double
first_name
first name of the person
last_name
last name of the person
nationality_area_code
three character area code
nationality_area_id
unique identifier for an area
nationality_area_name
area name of peoples nationality
people_id
unique identifier for person
short_name
shortened name of the person
slug
widget slug to be used for athlete widget (multisport)
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 call
sport
sport value
version
version of the API
discipline❯
basic information about the discipline
discipline_id
unique identifier of the discipline
name
name of the discipline
type
type of discipline (contestant, contestant_team or team)
gender❯
details about the gender
age_group
defines the age group (senior,u23,u22,u21....)
value
gender type (male, female or mixed)
membership❯
details about the membership
membership_id
unique identifier for the membership
team_id
unique identifier of the team
team_name
current team name
method❯
details about the API function
method_id
unique ID of method
name
name of method
round❯
basic details about the round
name
name of round
round_id
unique identifier of round
season❯
details about the season
end_date
end date, format 'yyyy-mm-dd'
last_updated
When record was last updated. Format YYYY-MM-DD HH:MM:SS in CET timezone.
logo
full path URL of logo for particular season
original_name
competition name during this season
season_id
unique identifier for season
start_date
start date, format 'yyyy-mm-dd'
title
title of season
team❯
details about the team
short_name
short name of the team.
team_area_code
three-letter acronym for the area of the team
team_area_id
unique identifier for an area
team_area_name
area name of the team
team_id
unique identifier of the team
team_logo
full path URL of team logo
team_name
current team name
tla_name
three letter acronym for this team
tour❯
details about the tour
gender
gender of the tour
name
name of the particular tour
tour_id
unique tour identifier
tour_type
defines if the tournament is part of a tour or not. If not then value "non-tour"
tour_season❯
details about a tour season
logo
full path URL of logo for particular tour_season
name
name of the tour_season
title
title of the particular tour season
tour_season_id
unique identifier of a tour season
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}/swimming/get_contestants?client={client_name}&authkey={client_authkey}&type=discipline&type_id={discipline_id}&season={season_id}");
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}/swimming/get_contestants?client={client_name}&authkey={client_authkey}&type=discipline&type_id={discipline_id}&season={season_id}"
Imports System
Imports System.Net	
Imports System.IO
Imports System.Text

Public Module Module1
	Public Sub Main()
		Dim url As String = "https://dsg-api.com/clients/{client_name}/swimming/get_contestants?client={client_name}&authkey={client_authkey}&type=discipline&type_id={discipline_id}&season={season_id}"
		Dim myReq As WebRequest = WebRequest.Create(url)
		myReq.Credentials = new System.Net.NetworkCredential("{User}", "{Password}")
		Dim wr As WebResponse = myReq.GetResponse()
		Dim receiveStream As Stream = wr.GetResponseStream()
		Dim reader As StreamReader = New StreamReader(receiveStream, Encoding.UTF8)
		Dim content As String = reader.ReadToEnd()
	End Sub
End Module
response = requests.get("https://dsg-api.com/clients/{client_name}/swimming/get_contestants?client={client_name}&authkey={client_authkey}&type=discipline&type_id={discipline_id}&season={season_id}", auth=("User", "Password"))
Response Example
200 Success