{"__v":42,"_id":"55776bbce6063e0d00481401","category":{"__v":31,"_id":"55773ac207e7110d001043ed","pages":["55776bbce6063e0d00481401","564b7a4e1ed5c823003eb64b","564b7c0fdda79a19000f2653","564b7c2385e4e92b00fb4f8a","564b7c2edda79a19000f2656","564b7c394f06ef2b006b08a5","564b7c6b85e4e92b00fb4f8c","564b7c791ed5c823003eb64f","564b7c83cc472d0d00da943d","564b7c8f766d4923004e1fbc","564b7ca385e4e92b00fb4f8f","564b7cb21ed5c823003eb654","564b7ccb766d4923004e1fbf","564b7cdf766d4923004e1fc1","564b7ceecc472d0d00da9440","564b7d014f06ef2b006b08a8","564b7d201ed5c823003eb656","564b7d2ee323d01700a51340","564b7d3b1ed5c823003eb658","564b7d4be323d01700a51344","564b7d5ee323d01700a51346","564b7d73cc472d0d00da9442","564b7d8adda79a19000f265a","564b7e0b85e4e92b00fb4f92","564b7e1be323d01700a51348","564b7e2b1ed5c823003eb65a","564b7e3f766d4923004e1fc4","564b7e4fdda79a19000f265c","564b7e5a766d4923004e1fc6","56eb12a90e62750e0060d027","56f184bf3af4942b00bb3c33"],"project":"55773a5ba042551900b002cb","version":"55773a5ba042551900b002ce","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-06-09T19:13:06.237Z","from_sync":false,"order":3,"slug":"events-api","title":"Events API"},"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-06-09T22:42:04.008Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":0,"body":"The **Events API** allows access to all event resources which includes event listings, entries and result information.\n\n[![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/9d5a74b5be18b9a80638)\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/EBM7Zl0STDeXZ4nDClvW_2015womenituhuatulcobycruse095wtmk.jpg\",\n        \"2015womenituhuatulcobycruse095wtmk.jpg\",\n        \"1500\",\n        \"993\",\n        \"#2f4074\",\n        \"\"\n      ],\n      \"caption\": \"The Events API provides all event related data\"\n    }\n  ]\n}\n[/block]\nThe Events API is comprised of the following underlying resources:\n\n* **Events** - data related to the event itself including specific event information, related media and medal tallies.\n* ** Programs** - data related to programs (or races) at an event such as course information and atmospheric conditions (which vary between programs at the same event)\n* ** Entries** - data relating to the entries of a specific program (start lists and wait lists)\n* ** Results** - data relating to the results of a specific program\n\nIn a nutshell, entry and result data belong to a **program** and each program belongs to an **event**. There can be many entries and results per program and many programs per event. For more information with working with the Events API please consult the [Getting Started with the Events API ](https://developers.triathlon.org/docs/getting-started-with-events-api) guide.\n\nEach of the resources has it's own defined type as listed below.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Basic Event Object\"\n}\n[/block]\nWhen using the event listing call or where events are returned from different API calls a **basic event object** is returned which will always conform to the following specification. If further detail is required request the full event listing using the [Retrieve Event Information](https://developers.triathlon.org/docs/retrieve-event-information) API method.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n   \\\"event_id\\\":5105,\\n   \\\"event_title\\\":\\\"2009 Dextro Energy Triathlon - ITU World Championship Grand Final Gold Coast\\\",\\n   \\\"event_slug\\\":\\\"2009_dextro_energy_triathlon_-_itu_world_championship_grand_final_gold_coas\\\",\\n   \\\"event_edit_date\\\":\\\"2013-01-29T02:26:42+00:00\\\",\\n   \\\"event_venue\\\":\\\"Gold Coast\\\",\\n   \\\"event_country\\\":\\\"Australia\\\",\\n   \\\"event_latitude\\\":-28.136289,\\n   \\\"event_longitude\\\":153.477806,\\n   \\\"event_date\\\":\\\"2009-09-09\\\",\\n   \\\"event_finish_date\\\":\\\"2009-09-13\\\",\\n   \\\"event_country_isoa2\\\":\\\"AU\\\",\\n   \\\"event_country_noc\\\":\\\"AUS\\\",\\n   \\\"event_region_id\\\":14,\\n   \\\"event_country_id\\\":111,\\n   \\\"event_region_name\\\":\\\"Oceania\\\",\\n   \\\"event_categories\\\":[\\n      {\\n         \\\"cat_name\\\":\\\"World Championships\\\",\\n         \\\"cat_id\\\":348,\\n         \\\"cat_parent_id\\\":0\\n      },\\n      {\\n         \\\"cat_name\\\":\\\"World Triathlon Series\\\",\\n         \\\"cat_id\\\":351,\\n         \\\"cat_parent_id\\\":0\\n      }\\n   ],\\n   \\\"event_specifications\\\":[\\n      {\\n         \\\"cat_name\\\":\\\"Triathlon\\\",\\n         \\\"cat_id\\\":357,\\n         \\\"cat_parent_id\\\":0\\n      },\\n      {\\n         \\\"cat_name\\\":\\\"Sprint\\\",\\n         \\\"cat_id\\\":376,\\n         \\\"cat_parent_id\\\":357\\n      },\\n      {\\n         \\\"cat_name\\\":\\\"Standard\\\",\\n         \\\"cat_id\\\":377,\\n         \\\"cat_parent_id\\\":357\\n      },\\n      {\\n         \\\"cat_name\\\":\\\"Paratriathlon\\\",\\n         \\\"cat_id\\\":381,\\n         \\\"cat_parent_id\\\":357\\n      }\\n   ],\\n   \\\"event_flag\\\":\\\"https:\\\\/\\\\/f9ca11ef49c28681fc01-0acbf57e00c47a50e70a1acb89e86c89.ssl.cf1.rackcdn.com\\\\/images\\\\/icons\\\\/au.png\\\",\\n   \\\"event_listing\\\":\\\"http:\\\\/\\\\/www.triathlon.org\\\\/events\\\\/event\\\\/2009_dextro_energy_triathlon_-_itu_world_championship_grand_final_gold_coas\\\",\\n   \\\"event_api_listing\\\":\\\"https:\\\\/\\\\/api.triathlon.org\\\\/v1\\\\/v1\\\\/events\\\\/5105\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Program Object\"\n}\n[/block]\nA program object comprises the basic data required for all programs. For more program data the [Retrieve Program Information](https://developers.triathlon.org/docs/retrieve-program-information) API method should be used.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{  \\n   \\\"prog_id\\\":269745,\\n   \\\"event_id\\\":91461,\\n   \\\"prog_name\\\":\\\"Elite Coaches\\\",\\n   \\\"prog_date\\\":\\\"2015-03-21\\\",\\n   \\\"prog_time\\\":\\\"12:34:00\\\",\\n   \\\"results\\\":false,\\n   \\\"team\\\":false\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Entry Object\"\n}\n[/block]\nAn entry object comprises an individual program entry and is made up of an athlete object together with the individual entry status and data. Typically these objects are presented in an array via the [Program Entries](doc:program-entries) method that is used for generating start and wait lists and contains other meta information regarding the event and program.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n   \\\"athlete_id\\\":21486,\\n   \\\"athlete_title\\\":\\\"Pamella Oliveira\\\",\\n   \\\"athlete_slug\\\":\\\"pamella_oliveira\\\",\\n   \\\"athlete_first\\\":\\\"Pamella\\\",\\n   \\\"athlete_last\\\":\\\"Oliveira\\\",\\n   \\\"athlete_country_id\\\":127,\\n   \\\"athlete_gender\\\":\\\"female\\\",\\n   \\\"athlete_yob\\\":\\\"1987\\\",\\n   \\\"validated\\\":false,\\n   \\\"athlete_profile_image\\\":null,\\n   \\\"athlete_noc\\\":\\\"BRA\\\",\\n   \\\"athlete_country_name\\\":\\\"Brazil\\\",\\n   \\\"athlete_country_isoa2\\\":\\\"BR\\\",\\n   \\\"athlete_listing\\\":\\\"http:\\\\/\\\\/www.triathlon.org\\\\/athletes\\\\/profile\\\\/21486\\\\/pamella_oliveira\\\",\\n   \\\"athlete_flag\\\":\\\"https:\\\\/\\\\/f9ca11ef49c28681fc01-0acbf57e00c47a50e70a1acb89e86c89.ssl.cf1.rackcdn.com\\\\/images\\\\/icons\\\\/br.png\\\",\\n   \\\"athlete_api_listing\\\":\\\"https:\\\\/\\\\/api.triathlon.org\\\\/v1\\\\/v1\\\\/athletes\\\\/21486\\\",\\n   \\\"athlete_categories\\\":[\\n      42\\n   ],\\n   \\\"entry_id\\\":353216,\\n   \\\"program_id\\\":270564,\\n   \\\"approved\\\":true,\\n   \\\"start_num\\\":33\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Result Object\"\n}\n[/block]\nA result object comprises an individual result and is made up of an athlete object together with the individual result and splits data. Typically these objects are presented in an array via the [Program Results](doc:program-results) method that is used for generating result listings and contains other meta information regarding the event and program including split information.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n   \\\"athlete_id\\\":40887,\\n   \\\"athlete_title\\\":\\\"Gwen Jorgensen\\\",\\n   \\\"athlete_slug\\\":\\\"gwen_jorgensen\\\",\\n   \\\"athlete_first\\\":\\\"Gwen\\\",\\n   \\\"athlete_last\\\":\\\"Jorgensen\\\",\\n   \\\"athlete_country_id\\\":293,\\n   \\\"athlete_gender\\\":\\\"female\\\",\\n   \\\"athlete_yob\\\":\\\"1986\\\",\\n   \\\"validated\\\":false,\\n   \\\"athlete_profile_image\\\":\\\"http:\\\\/\\\\/www.triathlon.org\\\\/images\\\\/athlete_thumbs\\\\/Gwen_Jorgensen2.jpg\\\",\\n   \\\"athlete_noc\\\":\\\"USA\\\",\\n   \\\"athlete_country_name\\\":\\\"United States\\\",\\n   \\\"athlete_country_isoa2\\\":\\\"US\\\",\\n   \\\"athlete_listing\\\":\\\"http:\\\\/\\\\/www.triathlon.org\\\\/athletes\\\\/profile\\\\/40887\\\\/gwen_jorgensen\\\",\\n   \\\"athlete_flag\\\":\\\"https:\\\\/\\\\/f9ca11ef49c28681fc01-0acbf57e00c47a50e70a1acb89e86c89.ssl.cf1.rackcdn.com\\\\/images\\\\/icons\\\\/us.png\\\",\\n   \\\"athlete_api_listing\\\":\\\"https:\\\\/\\\\/api.triathlon.org\\\\/v1\\\\/v1\\\\/athletes\\\\/40887\\\",\\n   \\\"athlete_categories\\\":[\\n      42\\n   ],\\n   \\\"splits\\\":[\\n      \\\"00:19:25\\\",\\n      \\\"00:00:28\\\",\\n      \\\"01:03:06\\\",\\n      \\\"00:00:26\\\",\\n      \\\"00:33:35\\\"\\n   ],\\n   \\\"result_id\\\":476317,\\n   \\\"position\\\":1,\\n   \\\"total_time\\\":\\\"01:56:59\\\",\\n   \\\"start_num\\\":2\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"","slug":"events-api-overview","type":"basic","title":"Events API Overview"}

Events API Overview


The **Events API** allows access to all event resources which includes event listings, entries and result information. [![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/9d5a74b5be18b9a80638) [block:image] { "images": [ { "image": [ "https://files.readme.io/EBM7Zl0STDeXZ4nDClvW_2015womenituhuatulcobycruse095wtmk.jpg", "2015womenituhuatulcobycruse095wtmk.jpg", "1500", "993", "#2f4074", "" ], "caption": "The Events API provides all event related data" } ] } [/block] The Events API is comprised of the following underlying resources: * **Events** - data related to the event itself including specific event information, related media and medal tallies. * ** Programs** - data related to programs (or races) at an event such as course information and atmospheric conditions (which vary between programs at the same event) * ** Entries** - data relating to the entries of a specific program (start lists and wait lists) * ** Results** - data relating to the results of a specific program In a nutshell, entry and result data belong to a **program** and each program belongs to an **event**. There can be many entries and results per program and many programs per event. For more information with working with the Events API please consult the [Getting Started with the Events API ](https://developers.triathlon.org/docs/getting-started-with-events-api) guide. Each of the resources has it's own defined type as listed below. [block:api-header] { "type": "basic", "title": "Basic Event Object" } [/block] When using the event listing call or where events are returned from different API calls a **basic event object** is returned which will always conform to the following specification. If further detail is required request the full event listing using the [Retrieve Event Information](https://developers.triathlon.org/docs/retrieve-event-information) API method. [block:code] { "codes": [ { "code": "{\n \"event_id\":5105,\n \"event_title\":\"2009 Dextro Energy Triathlon - ITU World Championship Grand Final Gold Coast\",\n \"event_slug\":\"2009_dextro_energy_triathlon_-_itu_world_championship_grand_final_gold_coas\",\n \"event_edit_date\":\"2013-01-29T02:26:42+00:00\",\n \"event_venue\":\"Gold Coast\",\n \"event_country\":\"Australia\",\n \"event_latitude\":-28.136289,\n \"event_longitude\":153.477806,\n \"event_date\":\"2009-09-09\",\n \"event_finish_date\":\"2009-09-13\",\n \"event_country_isoa2\":\"AU\",\n \"event_country_noc\":\"AUS\",\n \"event_region_id\":14,\n \"event_country_id\":111,\n \"event_region_name\":\"Oceania\",\n \"event_categories\":[\n {\n \"cat_name\":\"World Championships\",\n \"cat_id\":348,\n \"cat_parent_id\":0\n },\n {\n \"cat_name\":\"World Triathlon Series\",\n \"cat_id\":351,\n \"cat_parent_id\":0\n }\n ],\n \"event_specifications\":[\n {\n \"cat_name\":\"Triathlon\",\n \"cat_id\":357,\n \"cat_parent_id\":0\n },\n {\n \"cat_name\":\"Sprint\",\n \"cat_id\":376,\n \"cat_parent_id\":357\n },\n {\n \"cat_name\":\"Standard\",\n \"cat_id\":377,\n \"cat_parent_id\":357\n },\n {\n \"cat_name\":\"Paratriathlon\",\n \"cat_id\":381,\n \"cat_parent_id\":357\n }\n ],\n \"event_flag\":\"https:\\/\\/f9ca11ef49c28681fc01-0acbf57e00c47a50e70a1acb89e86c89.ssl.cf1.rackcdn.com\\/images\\/icons\\/au.png\",\n \"event_listing\":\"http:\\/\\/www.triathlon.org\\/events\\/event\\/2009_dextro_energy_triathlon_-_itu_world_championship_grand_final_gold_coas\",\n \"event_api_listing\":\"https:\\/\\/api.triathlon.org\\/v1\\/v1\\/events\\/5105\"\n}", "language": "json" } ] } [/block] [block:api-header] { "type": "basic", "title": "Program Object" } [/block] A program object comprises the basic data required for all programs. For more program data the [Retrieve Program Information](https://developers.triathlon.org/docs/retrieve-program-information) API method should be used. [block:code] { "codes": [ { "code": "{ \n \"prog_id\":269745,\n \"event_id\":91461,\n \"prog_name\":\"Elite Coaches\",\n \"prog_date\":\"2015-03-21\",\n \"prog_time\":\"12:34:00\",\n \"results\":false,\n \"team\":false\n}", "language": "json" } ] } [/block] [block:api-header] { "type": "basic", "title": "Entry Object" } [/block] An entry object comprises an individual program entry and is made up of an athlete object together with the individual entry status and data. Typically these objects are presented in an array via the [Program Entries](doc:program-entries) method that is used for generating start and wait lists and contains other meta information regarding the event and program. [block:code] { "codes": [ { "code": "{\n \"athlete_id\":21486,\n \"athlete_title\":\"Pamella Oliveira\",\n \"athlete_slug\":\"pamella_oliveira\",\n \"athlete_first\":\"Pamella\",\n \"athlete_last\":\"Oliveira\",\n \"athlete_country_id\":127,\n \"athlete_gender\":\"female\",\n \"athlete_yob\":\"1987\",\n \"validated\":false,\n \"athlete_profile_image\":null,\n \"athlete_noc\":\"BRA\",\n \"athlete_country_name\":\"Brazil\",\n \"athlete_country_isoa2\":\"BR\",\n \"athlete_listing\":\"http:\\/\\/www.triathlon.org\\/athletes\\/profile\\/21486\\/pamella_oliveira\",\n \"athlete_flag\":\"https:\\/\\/f9ca11ef49c28681fc01-0acbf57e00c47a50e70a1acb89e86c89.ssl.cf1.rackcdn.com\\/images\\/icons\\/br.png\",\n \"athlete_api_listing\":\"https:\\/\\/api.triathlon.org\\/v1\\/v1\\/athletes\\/21486\",\n \"athlete_categories\":[\n 42\n ],\n \"entry_id\":353216,\n \"program_id\":270564,\n \"approved\":true,\n \"start_num\":33\n}", "language": "json" } ] } [/block] [block:api-header] { "type": "basic", "title": "Result Object" } [/block] A result object comprises an individual result and is made up of an athlete object together with the individual result and splits data. Typically these objects are presented in an array via the [Program Results](doc:program-results) method that is used for generating result listings and contains other meta information regarding the event and program including split information. [block:code] { "codes": [ { "code": "{\n \"athlete_id\":40887,\n \"athlete_title\":\"Gwen Jorgensen\",\n \"athlete_slug\":\"gwen_jorgensen\",\n \"athlete_first\":\"Gwen\",\n \"athlete_last\":\"Jorgensen\",\n \"athlete_country_id\":293,\n \"athlete_gender\":\"female\",\n \"athlete_yob\":\"1986\",\n \"validated\":false,\n \"athlete_profile_image\":\"http:\\/\\/www.triathlon.org\\/images\\/athlete_thumbs\\/Gwen_Jorgensen2.jpg\",\n \"athlete_noc\":\"USA\",\n \"athlete_country_name\":\"United States\",\n \"athlete_country_isoa2\":\"US\",\n \"athlete_listing\":\"http:\\/\\/www.triathlon.org\\/athletes\\/profile\\/40887\\/gwen_jorgensen\",\n \"athlete_flag\":\"https:\\/\\/f9ca11ef49c28681fc01-0acbf57e00c47a50e70a1acb89e86c89.ssl.cf1.rackcdn.com\\/images\\/icons\\/us.png\",\n \"athlete_api_listing\":\"https:\\/\\/api.triathlon.org\\/v1\\/v1\\/athletes\\/40887\",\n \"athlete_categories\":[\n 42\n ],\n \"splits\":[\n \"00:19:25\",\n \"00:00:28\",\n \"01:03:06\",\n \"00:00:26\",\n \"00:33:35\"\n ],\n \"result_id\":476317,\n \"position\":1,\n \"total_time\":\"01:56:59\",\n \"start_num\":2\n}", "language": "json" } ] } [/block]