{"__v":2,"_id":"564a6fdf4cd0521700523edc","category":{"__v":18,"_id":"55773abaa042551900b002d5","pages":["55776c06a042551900b0034f","564a6fdf4cd0521700523edc","564b6753cc472d0d00da940e","564b78801ed5c823003eb640","564b788fcc472d0d00da942e","564b7898dda79a19000f2641","564b78bfdda79a19000f2643","564b78cd1ed5c823003eb643","564b78ebdda79a19000f2646","564b791d766d4923004e1fb3","564b7929e323d01700a5132f","564b7935766d4923004e1fb5","564b793fe323d01700a51331","564b7957cc472d0d00da9431","564b7962dda79a19000f2648","564b79b31ed5c823003eb645","564b79c31ed5c823003eb647","564b79fee323d01700a51336"],"project":"55773a5ba042551900b002cb","version":"55773a5ba042551900b002ce","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-06-09T19:12:58.040Z","from_sync":false,"order":2,"slug":"athletes-api","title":"Athletes API"},"editedParams":true,"editedParams2":true,"parentDoc":null,"project":"55773a5ba042551900b002cb","user":"546d17e2eb9cfd1400dd4529","version":{"__v":17,"_id":"55773a5ba042551900b002ce","project":"55773a5ba042551900b002cb","createdAt":"2015-06-09T19:11:23.764Z","releaseDate":"2015-06-09T19:11:23.764Z","categories":["55773a5ca042551900b002cf","55773a6ce6063e0d00481380","55773ab007e7110d001043ec","55773abaa042551900b002d5","55773ac207e7110d001043ed","55773acb07e7110d001043ee","55773ad3a042551900b002d6","55773adce6063e0d00481383","55773ae4a042551900b002d7","55773af307e7110d001043ef","55773af907e7110d001043f0","55773b0407e7110d001043f1","563a4f7ad25e8919005f3f39","563a4fcaa19edf0d00972321","564a70dc4cd0521700523edf","564b797bcc472d0d00da9435","564b855b766d4923004e1fd1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Motherboard","version_clean":"1.0.0","version":"1"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-11-17T00:07:59.970Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n   \"code\":200,\n   \"status\":\"success\",\n   \"total\":69889,\n   \"per_page\":10,\n   \"current_page\":1,\n   \"last_page\":6989,\n   \"next_page_url\":\"https:\\/\\/api.triathlon.org\\/v1\\/athletes?page=2\",\n   \"prev_page_url\":null,\n   \"from\":1,\n   \"to\":10,\n   \"data\":[\n      {\n         \"athlete_id\":103070,\n         \"athlete_title\":\"Fabian Velazquez Rangel\",\n         \"athlete_slug\":\"fabian_velazquez_rangel\",\n         \"athlete_edit_date\":\"2016-01-06T19:09:08+00:00\",\n         \"athlete_first\":\"Fabian\",\n         \"athlete_last\":\"Velazquez Rangel\",\n         \"athlete_country_id\":219,\n         \"athlete_gender\":\"male\",\n         \"athlete_yob\":\"1996\",\n         \"validated\":false,\n         \"athlete_profile_image\":null,\n         \"athlete_noc\":\"MEX\",\n         \"athlete_country_name\":\"Mexico\",\n         \"athlete_country_isoa2\":\"MX\",\n         \"athlete_listing\":\"http:\\/\\/www.triathlon.org\\/athletes\\/profile\\/103070\\/fabian_velazquez_rangel\",\n         \"athlete_flag\":\"https:\\/\\/f9ca11ef49c28681fc01-0acbf57e00c47a50e70a1acb89e86c89.ssl.cf1.rackcdn.com\\/images\\/icons\\/mx.png\",\n         \"athlete_api_listing\":\"https:\\/\\/api.triathlon.org\\/v1\\/v1\\/athletes\\/103070\",\n         \"athlete_categories\":[\n            42\n         ]\n      }\n   ]\n}","name":""}]},"settings":"","auth":"required","params":[{"_id":"564a7033e126d40d00f0e0ae","ref":"","in":"query","required":false,"desc":"How many athletes to be returned per page","default":"10","type":"int","name":"per_page"},{"_id":"564a7033e126d40d00f0e0ad","ref":"","in":"query","required":false,"desc":"The page number to be returned","default":"","type":"int","name":"page"},{"_id":"564a7033e126d40d00f0e0ac","ref":"","in":"query","required":false,"desc":"A pipe delimited list of category ids","default":"","type":"string","name":"category_id"},{"_id":"564a7033e126d40d00f0e0ab","ref":"","in":"query","required":false,"desc":"Restrict returned athletes by name","default":"","type":"string","name":"name"},{"_id":"564a7033e126d40d00f0e0aa","ref":"","in":"query","required":false,"desc":"A pipe delimited list of country ids","default":"","type":"string","name":"country_id"},{"_id":"564a7033e126d40d00f0e0a9","ref":"","in":"query","required":false,"desc":"Restrict returned athletes by gender (male|female)","default":"","type":"string","name":"gender"},{"_id":"564a7033e126d40d00f0e0a8","ref":"","in":"query","required":false,"desc":"Restrict athletes to those with points list ranking","default":"","type":"string","name":"elite"},{"_id":"564a7033e126d40d00f0e0a7","ref":"","in":"query","required":false,"desc":"A pipe delimited list of athlete ids","default":"","type":"string","name":"athlete_id"},{"_id":"56cdf2d2f6be970b0066402a","ref":"","in":"query","required":false,"desc":"Filter whether the athlete data has been validated","default":"","type":"boolean","name":"validated"}],"url":"/athletes"},"isReference":true,"order":1,"body":"The **Athlete Listings** method returns a filterable list of basic athlete objects matching the search criteria.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Better search results available via Search API\",\n  \"body\": \"The [Search API](https://developers.triathlon.org/docs/search-api-overview) offers a better(faster) experience if you are simply interested in searching athletes by name as it allows for misspellings and is better suited for applications allowing user input.\"\n}\n[/block]\nSetting the parameter `elite=yes` limits returned results to only those athletes that have a current [triathlon points list ranking](https://developers.triathlon.org/docs/rankings-api-overview). Many of the parameters accept a pipe delimited list to allow selection of multiple categories/athlete_ids.\n\nThe `name` parameter allows a fuzzy search by both first name or last name.\n\nThe following example retrieves all female elite triathletes from the United States of America.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl --header \\\"apikey: [[app:key]]\\\" https://api.triathlon.org/v1/athletes?elite=yes&country_id=293&gender=female\",\n      \"language\": \"curl\"\n    }\n  ]\n}\n[/block]\nThe `validated` parameter indicates whether the athlete's data has been verified by ITU officials.","excerpt":"","slug":"athlete-listings","type":"endpoint","title":"Athlete Listings"}

getAthlete Listings


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

per_page:
integer10
How many athletes to be returned per page
page:
integer
The page number to be returned
category_id:
string
A pipe delimited list of category ids
name:
string
Restrict returned athletes by name
country_id:
string
A pipe delimited list of country ids
gender:
string
Restrict returned athletes by gender (male|female)
elite:
string
Restrict athletes to those with points list ranking
athlete_id:
string
A pipe delimited list of athlete ids
validated:
boolean
Filter whether the athlete data has been validated

Result Format


Documentation

The **Athlete Listings** method returns a filterable list of basic athlete objects matching the search criteria. [block:callout] { "type": "warning", "title": "Better search results available via Search API", "body": "The [Search API](https://developers.triathlon.org/docs/search-api-overview) offers a better(faster) experience if you are simply interested in searching athletes by name as it allows for misspellings and is better suited for applications allowing user input." } [/block] Setting the parameter `elite=yes` limits returned results to only those athletes that have a current [triathlon points list ranking](https://developers.triathlon.org/docs/rankings-api-overview). Many of the parameters accept a pipe delimited list to allow selection of multiple categories/athlete_ids. The `name` parameter allows a fuzzy search by both first name or last name. The following example retrieves all female elite triathletes from the United States of America. [block:code] { "codes": [ { "code": "curl --header \"apikey: [[app:key]]\" https://api.triathlon.org/v1/athletes?elite=yes&country_id=293&gender=female", "language": "curl" } ] } [/block] The `validated` parameter indicates whether the athlete's data has been verified by ITU officials.

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}