{"files":{"SKILL.md":"---\nname: the-blue-alliance-api-v3\ndescription: \"The Blue Alliance API v3 API skill. Use when working with The Blue Alliance API v3 for district, districts, event. Covers 80 endpoints.\"\nversion: 1.0.0\ngenerator: lapsh\n---\n\n# The Blue Alliance API v3\nAPI version: 3.12.1\n\n## Auth\nApiKey X-TBA-Auth-Key in header\n\n## Base URL\nhttps://www.thebluealliance.com/api/v3\n\n## Setup\n1. Set your API key in the appropriate header\n2. GET /search_index -- gets a large blob of data that is used on the frontend for searching. may change without notice.\n3. Explore available endpoints below\n\n## Endpoints\n80 endpoints across 11 groups. See references/api-spec.lap for full details.\n\n### District\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /district/{district_abbreviation}/dcmp_history | Gets a list of DCMP events and awards for the given district abbreviation. |\n| GET | /district/{district_abbreviation}/history | Gets a list of District objects with the given district abbreviation. This accounts for district abbreviation changes, such as MAR to FMA. |\n| GET | /district/{district_abbreviation}/insights | Gets insights for a given district. |\n| GET | /district/{district_key}/advancement | Gets a list of advancement information per team in a district. |\n| GET | /district/{district_key}/awards | Gets a list of awards in the given district. |\n| GET | /district/{district_key}/events | Gets a list of events in the given district. |\n| GET | /district/{district_key}/events/keys | Gets a list of event keys for events in the given district. |\n| GET | /district/{district_key}/events/simple | Gets a short-form list of events in the given district. |\n| GET | /district/{district_key}/rankings | Gets a list of team district rankings for the given district. |\n| GET | /district/{district_key}/teams | Gets a list of `Team` objects that competed in events in the given district. |\n| GET | /district/{district_key}/teams/keys | Gets a list of `Team` objects that competed in events in the given district. |\n| GET | /district/{district_key}/teams/simple | Gets a short-form list of `Team` objects that competed in events in the given district. |\n\n### Districts\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /districts/{year} | Gets a list of districts and their corresponding district key, for the given year. |\n\n### Event\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /event/{event_key} | Gets an Event. |\n| GET | /event/{event_key}/advancement_points | Depending on the type of event (district/regional), this will return either district points or regional CMP points |\n| GET | /event/{event_key}/alliances | Gets a list of Elimination Alliances for the given Event. |\n| GET | /event/{event_key}/awards | Gets a list of awards from the given event. |\n| GET | /event/{event_key}/coprs | Gets a set of Event Component OPRs for the given Event. |\n| GET | /event/{event_key}/district_points | Gets a list of district points for the Event. These are always calculated, regardless of event type, and may/may not be actually useful. |\n| GET | /event/{event_key}/insights | Gets a set of Event-specific insights for the given Event. |\n| GET | /event/{event_key}/matches | Gets a list of matches for the given event. |\n| GET | /event/{event_key}/matches/keys | Gets a list of match keys for the given event. |\n| GET | /event/{event_key}/matches/simple | Gets a short-form list of matches for the given event. |\n| GET | /event/{event_key}/matches/timeseries | Gets an array of Match Keys for the given event key that have timeseries data. Returns an empty array if no matches have timeseries data. |\n| GET | /event/{event_key}/oprs | Gets a set of Event OPRs (including OPR, DPR, and CCWM) for the given Event. |\n| GET | /event/{event_key}/predictions | Gets information on TBA-generated predictions for the given Event. Contains year-specific information. *WARNING* This endpoint is currently under development and may change at any time. |\n| GET | /event/{event_key}/rankings | Gets a list of team rankings for the Event. |\n| GET | /event/{event_key}/regional_champs_pool_points | For 2025+ Regional events, this will return points towards the Championship qualification pool. |\n| GET | /event/{event_key}/simple | Gets a short-form Event. |\n| GET | /event/{event_key}/team_media | Gets a list of media objects that correspond to teams at this event. |\n| GET | /event/{event_key}/teams | Gets a list of `Team` objects that competed in the given event. |\n| GET | /event/{event_key}/teams/keys | Gets a list of `Team` keys that competed in the given event. |\n| GET | /event/{event_key}/teams/simple | Gets a short-form list of `Team` objects that competed in the given event. |\n| GET | /event/{event_key}/teams/statuses | Gets a key-value list of the event statuses for teams competing at the given event. |\n\n### Events\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /events/{year} | Gets a list of events in the given year. |\n| GET | /events/{year}/keys | Gets a list of event keys in the given year. |\n| GET | /events/{year}/simple | Gets a short-form list of events in the given year. |\n\n### Insights\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /insights/leaderboards/{year} | Gets a list of `LeaderboardInsight` objects from a specific year. Use year=0 for overall. |\n| GET | /insights/notables/{year} | Gets a list of `NotablesInsight` objects from a specific year. Use year=0 for overall. |\n\n### Match\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /match/{match_key} | Gets a `Match` object for the given match key. |\n| GET | /match/{match_key}/simple | Gets a short-form `Match` object for the given match key. |\n| GET | /match/{match_key}/timeseries | Gets an array of game-specific Match Timeseries objects for the given match key or an empty array if not available. |\n| GET | /match/{match_key}/zebra_motionworks | Gets Zebra MotionWorks data for a Match for the given match key. |\n\n### Regional_advancement\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /regional_advancement/{year} | Gets information about per-team advancement to the FIRST Championship. |\n| GET | /regional_advancement/{year}/rankings | Gets the team rankings in the regional pool for a specific year. |\n\n### Search_index\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /search_index | Gets a large blob of data that is used on the frontend for searching. May change without notice. |\n\n### Status\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /status | Returns API status, and TBA status information. |\n\n### Team\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /team/{team_key} | Gets a `Team` object for the team referenced by the given key. |\n| GET | /team/{team_key}/awards | Gets a list of awards the given team has won. |\n| GET | /team/{team_key}/awards/{year} | Gets a list of awards the given team has won in a given year. |\n| GET | /team/{team_key}/districts | Gets an array of districts representing each year the team was in a district. Will return an empty array if the team was never in a district. |\n| GET | /team/{team_key}/event/{event_key}/awards | Gets a list of awards the given team won at the given event. |\n| GET | /team/{team_key}/event/{event_key}/matches | Gets a list of matches for the given team and event. |\n| GET | /team/{team_key}/event/{event_key}/matches/keys | Gets a list of match keys for matches for the given team and event. |\n| GET | /team/{team_key}/event/{event_key}/matches/simple | Gets a short-form list of matches for the given team and event. |\n| GET | /team/{team_key}/event/{event_key}/status | Gets the competition rank and status of the team at the given event. |\n| GET | /team/{team_key}/events | Gets a list of all events this team has competed at. |\n| GET | /team/{team_key}/events/keys | Gets a list of the event keys for all events this team has competed at. |\n| GET | /team/{team_key}/events/simple | Gets a short-form list of all events this team has competed at. |\n| GET | /team/{team_key}/events/{year} | Gets a list of events this team has competed at in the given year. |\n| GET | /team/{team_key}/events/{year}/keys | Gets a list of the event keys for events this team has competed at in the given year. |\n| GET | /team/{team_key}/events/{year}/simple | Gets a short-form list of events this team has competed at in the given year. |\n| GET | /team/{team_key}/events/{year}/statuses | Gets a key-value list of the event statuses for events this team has competed at in the given year. |\n| GET | /team/{team_key}/history | Gets the history for the team referenced by the given key, including their events and awards. |\n| GET | /team/{team_key}/matches/{year} | Gets a list of matches for the given team and year. |\n| GET | /team/{team_key}/matches/{year}/keys | Gets a list of match keys for matches for the given team and year. |\n| GET | /team/{team_key}/matches/{year}/simple | Gets a short-form list of matches for the given team and year. |\n| GET | /team/{team_key}/media/tag/{media_tag} | Gets a list of Media (videos / pictures) for the given team and tag. |\n| GET | /team/{team_key}/media/tag/{media_tag}/{year} | Gets a list of Media (videos / pictures) for the given team, tag and year. |\n| GET | /team/{team_key}/media/{year} | Gets a list of Media (videos / pictures) for the given team and year. |\n| GET | /team/{team_key}/robots | Gets a list of year and robot name pairs for each year that a robot name was provided. Will return an empty array if the team has never named a robot. |\n| GET | /team/{team_key}/simple | Gets a `Team_Simple` object for the team referenced by the given key. |\n| GET | /team/{team_key}/social_media | Gets a list of Media (social media) for the given team. |\n| GET | /team/{team_key}/years_participated | Gets a list of years in which the team participated in at least one competition. |\n\n### Teams\n| Method | Path | Description |\n|--------|------|-------------|\n| GET | /teams/{page_num} | Gets a list of `Team` objects, paginated in groups of 500. |\n| GET | /teams/{page_num}/keys | Gets a list of Team keys, paginated in groups of 500. (Note, each page will not have 500 teams, but will include the teams within that range of 500.) |\n| GET | /teams/{page_num}/simple | Gets a list of short form `Team_Simple` objects, paginated in groups of 500. |\n| GET | /teams/{year}/{page_num} | Gets a list of `Team` objects that competed in the given year, paginated in groups of 500. |\n| GET | /teams/{year}/{page_num}/keys | Gets a list Team Keys that competed in the given year, paginated in groups of 500. |\n| GET | /teams/{year}/{page_num}/simple | Gets a list of short form `Team_Simple` objects that competed in the given year, paginated in groups of 500. |\n\n## Common Questions\nMatch user requests to endpoints in references/api-spec.lap. Key patterns:\n- \"List all dcmp_history?\" -> GET /district/{district_abbreviation}/dcmp_history\n- \"List all history?\" -> GET /district/{district_abbreviation}/history\n- \"List all insights?\" -> GET /district/{district_abbreviation}/insights\n- \"List all advancement?\" -> GET /district/{district_key}/advancement\n- \"List all awards?\" -> GET /district/{district_key}/awards\n- \"List all events?\" -> GET /district/{district_key}/events\n- \"List all keys?\" -> GET /district/{district_key}/events/keys\n- \"List all simple?\" -> GET /district/{district_key}/events/simple\n- \"List all rankings?\" -> GET /district/{district_key}/rankings\n- \"List all teams?\" -> GET /district/{district_key}/teams\n- \"Get district details?\" -> GET /districts/{year}\n- \"Get event details?\" -> GET /event/{event_key}\n- \"List all advancement_points?\" -> GET /event/{event_key}/advancement_points\n- \"List all alliances?\" -> GET /event/{event_key}/alliances\n- \"List all coprs?\" -> GET /event/{event_key}/coprs\n- \"List all district_points?\" -> GET /event/{event_key}/district_points\n- \"List all matches?\" -> GET /event/{event_key}/matches\n- \"List all timeseries?\" -> GET /event/{event_key}/matches/timeseries\n- \"List all oprs?\" -> GET /event/{event_key}/oprs\n- \"List all predictions?\" -> GET /event/{event_key}/predictions\n- \"List all regional_champs_pool_points?\" -> GET /event/{event_key}/regional_champs_pool_points\n- \"List all team_media?\" -> GET /event/{event_key}/team_media\n- \"List all statuses?\" -> GET /event/{event_key}/teams/statuses\n- \"Get leaderboard details?\" -> GET /insights/leaderboards/{year}\n- \"Get notable details?\" -> GET /insights/notables/{year}\n- \"Get match details?\" -> GET /match/{match_key}\n- \"List all zebra_motionworks?\" -> GET /match/{match_key}/zebra_motionworks\n- \"Get regional_advancement details?\" -> GET /regional_advancement/{year}\n- \"List all search_index?\" -> GET /search_index\n- \"List all status?\" -> GET /status\n- \"Get team details?\" -> GET /team/{team_key}\n- \"Get award details?\" -> GET /team/{team_key}/awards/{year}\n- \"List all districts?\" -> GET /team/{team_key}/districts\n- \"Get matche details?\" -> GET /team/{team_key}/matches/{year}\n- \"Get tag details?\" -> GET /team/{team_key}/media/tag/{media_tag}\n- \"Get media details?\" -> GET /team/{team_key}/media/{year}\n- \"List all robots?\" -> GET /team/{team_key}/robots\n- \"List all social_media?\" -> GET /team/{team_key}/social_media\n- \"List all years_participated?\" -> GET /team/{team_key}/years_participated\n- \"How to authenticate?\" -> See Auth section above\n\n## Response Tips\n- Check response schemas in references/api-spec.lap for field details\n- Error responses include status codes and descriptions in the spec\n\n## References\n- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas\n\n> Generated from the official API spec by [LAP](https://lap.sh)\n","references/api-spec.lap":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api The Blue Alliance API v3\n@base https://www.thebluealliance.com/api/v3\n@version 3.12.1\n@auth ApiKey X-TBA-Auth-Key in header\n@common_fields {If-None-Match: str # Value of the `ETag` header in the most recently cached response by the client.}\n@endpoints 80\n@hint download_for_search\n@toc district(12), districts(1), event(21), events(3), insights(2), match(4), regional_advancement(2), search_index(1), status(1), team(27), teams(6)\n\n@group district\n@endpoint GET /district/{district_abbreviation}/dcmp_history\n@desc Gets a list of DCMP events and awards for the given district abbreviation.\n@required {district_abbreviation: str # District abbreviation, eg `ne` or `fim`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /district/{district_abbreviation}/history\n@desc Gets a list of District objects with the given district abbreviation. This accounts for district abbreviation changes, such as MAR to FMA.\n@required {district_abbreviation: str # District abbreviation, eg `ne` or `fim`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /district/{district_abbreviation}/insights\n@desc Gets insights for a given district.\n@required {district_abbreviation: str # District abbreviation, eg `ne` or `fim`}\n@returns(200) {district_data: map{region_data: any, district_wide_data: any}, team_data: any} # Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /district/{district_key}/advancement\n@desc Gets a list of advancement information per team in a district.\n@required {district_key: str # TBA District Key, eg `2016fim`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /district/{district_key}/awards\n@desc Gets a list of awards in the given district.\n@required {district_key: str # TBA District Key, eg `2016fim`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /district/{district_key}/events\n@desc Gets a list of events in the given district.\n@required {district_key: str # TBA District Key, eg `2016fim`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /district/{district_key}/events/keys\n@desc Gets a list of event keys for events in the given district.\n@required {district_key: str # TBA District Key, eg `2016fim`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /district/{district_key}/events/simple\n@desc Gets a short-form list of events in the given district.\n@required {district_key: str # TBA District Key, eg `2016fim`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /district/{district_key}/rankings\n@desc Gets a list of team district rankings for the given district.\n@required {district_key: str # TBA District Key, eg `2016fim`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /district/{district_key}/teams\n@desc Gets a list of `Team` objects that competed in events in the given district.\n@required {district_key: str # TBA District Key, eg `2016fim`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /district/{district_key}/teams/keys\n@desc Gets a list of `Team` objects that competed in events in the given district.\n@required {district_key: str # TBA District Key, eg `2016fim`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /district/{district_key}/teams/simple\n@desc Gets a short-form list of `Team` objects that competed in events in the given district.\n@required {district_key: str # TBA District Key, eg `2016fim`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endgroup\n\n@group districts\n@endpoint GET /districts/{year}\n@desc Gets a list of districts and their corresponding district key, for the given year.\n@required {year: int # Competition Year (or Season). Must be 4 digits.}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endgroup\n\n@group event\n@endpoint GET /event/{event_key}\n@desc Gets an Event.\n@required {event_key: str # TBA Event Key, eg `2016nytr`}\n@returns(200) {key: str, name: str, event_code: str, event_type: int, district: any, city: str?, state_prov: str?, country: str?, start_date: str(date), end_date: str(date), year: int, short_name: str?, event_type_string: str, week: int?, address: str?, postal_code: str?, gmaps_place_id: str?, gmaps_url: str(url)?, lat: num(double)?, lng: num(double)?, location_name: str?, timezone: str?, website: str?, first_event_id: str?, first_event_code: str?, webcasts: [map], division_keys: [str], parent_event_key: str?, playoff_type: int?, playoff_type_string: str?, remap_teams: map?} # Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /event/{event_key}/advancement_points\n@desc Depending on the type of event (district/regional), this will return either district points or regional CMP points\n@required {event_key: str # TBA Event Key, eg `2016nytr`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /event/{event_key}/alliances\n@desc Gets a list of Elimination Alliances for the given Event.\n@required {event_key: str # TBA Event Key, eg `2016nytr`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /event/{event_key}/awards\n@desc Gets a list of awards from the given event.\n@required {event_key: str # TBA Event Key, eg `2016nytr`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /event/{event_key}/coprs\n@desc Gets a set of Event Component OPRs for the given Event.\n@required {event_key: str # TBA Event Key, eg `2016nytr`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /event/{event_key}/district_points\n@desc Gets a list of district points for the Event. These are always calculated, regardless of event type, and may/may not be actually useful.\n@required {event_key: str # TBA Event Key, eg `2016nytr`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /event/{event_key}/insights\n@desc Gets a set of Event-specific insights for the given Event.\n@required {event_key: str # TBA Event Key, eg `2016nytr`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /event/{event_key}/matches\n@desc Gets a list of matches for the given event.\n@required {event_key: str # TBA Event Key, eg `2016nytr`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /event/{event_key}/matches/keys\n@desc Gets a list of match keys for the given event.\n@required {event_key: str # TBA Event Key, eg `2016nytr`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /event/{event_key}/matches/simple\n@desc Gets a short-form list of matches for the given event.\n@required {event_key: str # TBA Event Key, eg `2016nytr`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /event/{event_key}/matches/timeseries\n@desc Gets an array of Match Keys for the given event key that have timeseries data. Returns an empty array if no matches have timeseries data.\n@required {event_key: str # TBA Event Key, eg `2016nytr`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /event/{event_key}/oprs\n@desc Gets a set of Event OPRs (including OPR, DPR, and CCWM) for the given Event.\n@required {event_key: str # TBA Event Key, eg `2016nytr`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /event/{event_key}/predictions\n@desc Gets information on TBA-generated predictions for the given Event. Contains year-specific information. *WARNING* This endpoint is currently under development and may change at any time.\n@required {event_key: str # TBA Event Key, eg `2016nytr`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /event/{event_key}/rankings\n@desc Gets a list of team rankings for the Event.\n@required {event_key: str # TBA Event Key, eg `2016nytr`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /event/{event_key}/regional_champs_pool_points\n@desc For 2025+ Regional events, this will return points towards the Championship qualification pool.\n@required {event_key: str # TBA Event Key, eg `2016nytr`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /event/{event_key}/simple\n@desc Gets a short-form Event.\n@required {event_key: str # TBA Event Key, eg `2016nytr`}\n@returns(200) {key: str, name: str, event_code: str, event_type: int, district: any, city: str?, state_prov: str?, country: str?, start_date: str(date), end_date: str(date), year: int} # Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /event/{event_key}/team_media\n@desc Gets a list of media objects that correspond to teams at this event.\n@required {event_key: str # TBA Event Key, eg `2016nytr`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /event/{event_key}/teams\n@desc Gets a list of `Team` objects that competed in the given event.\n@required {event_key: str # TBA Event Key, eg `2016nytr`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /event/{event_key}/teams/keys\n@desc Gets a list of `Team` keys that competed in the given event.\n@required {event_key: str # TBA Event Key, eg `2016nytr`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /event/{event_key}/teams/simple\n@desc Gets a short-form list of `Team` objects that competed in the given event.\n@required {event_key: str # TBA Event Key, eg `2016nytr`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /event/{event_key}/teams/statuses\n@desc Gets a key-value list of the event statuses for teams competing at the given event.\n@required {event_key: str # TBA Event Key, eg `2016nytr`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endgroup\n\n@group events\n@endpoint GET /events/{year}\n@desc Gets a list of events in the given year.\n@required {year: int # Competition Year (or Season). Must be 4 digits.}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /events/{year}/keys\n@desc Gets a list of event keys in the given year.\n@required {year: int # Competition Year (or Season). Must be 4 digits.}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /events/{year}/simple\n@desc Gets a short-form list of events in the given year.\n@required {year: int # Competition Year (or Season). Must be 4 digits.}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endgroup\n\n@group insights\n@endpoint GET /insights/leaderboards/{year}\n@desc Gets a list of `LeaderboardInsight` objects from a specific year. Use year=0 for overall.\n@required {year: int # Competition Year (or Season). Must be 4 digits.}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /insights/notables/{year}\n@desc Gets a list of `NotablesInsight` objects from a specific year. Use year=0 for overall.\n@required {year: int # Competition Year (or Season). Must be 4 digits.}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endgroup\n\n@group match\n@endpoint GET /match/{match_key}\n@desc Gets a `Match` object for the given match key.\n@required {match_key: str # TBA Match Key, eg `2016nytr_qm1`}\n@returns(200) {key: str, comp_level: str, set_number: int, match_number: int, alliances: map{red: map{score: int, team_keys: [str], surrogate_team_keys: [str], dq_team_keys: [str]}, blue: map{score: int, team_keys: [str], surrogate_team_keys: [str], dq_team_keys: [str]}}, winning_alliance: str, event_key: str, time: int(int64)?, actual_time: int(int64)?, predicted_time: int(int64)?, post_result_time: int(int64)?, score_breakdown: any, videos: [map]} # Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /match/{match_key}/simple\n@desc Gets a short-form `Match` object for the given match key.\n@required {match_key: str # TBA Match Key, eg `2016nytr_qm1`}\n@returns(200) {key: str, comp_level: str, set_number: int, match_number: int, alliances: map{red: map{score: int, team_keys: [str], surrogate_team_keys: [str], dq_team_keys: [str]}, blue: map{score: int, team_keys: [str], surrogate_team_keys: [str], dq_team_keys: [str]}}, winning_alliance: str, event_key: str, time: int(int64)?, predicted_time: int(int64)?, actual_time: int(int64)?} # Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /match/{match_key}/timeseries\n@desc Gets an array of game-specific Match Timeseries objects for the given match key or an empty array if not available.\n@required {match_key: str # TBA Match Key, eg `2016nytr_qm1`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /match/{match_key}/zebra_motionworks\n@desc Gets Zebra MotionWorks data for a Match for the given match key.\n@required {match_key: str # TBA Match Key, eg `2016nytr_qm1`}\n@returns(200) {key: str, times: [num(double)], alliances: map{red: [map], blue: [map]}} # Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endgroup\n\n@group regional_advancement\n@endpoint GET /regional_advancement/{year}\n@desc Gets information about per-team advancement to the FIRST Championship.\n@required {year: int # Competition Year (or Season). Must be 4 digits.}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /regional_advancement/{year}/rankings\n@desc Gets the team rankings in the regional pool for a specific year.\n@required {year: int # Competition Year (or Season). Must be 4 digits.}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endgroup\n\n@group search_index\n@endpoint GET /search_index\n@desc Gets a large blob of data that is used on the frontend for searching. May change without notice.\n@returns(200) {teams: [map], events: [map]} # Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endgroup\n\n@group status\n@endpoint GET /status\n@desc Returns API status, and TBA status information.\n@returns(200) {current_season: int, max_season: int, is_datafeed_down: bool, down_events: [str], ios: map{min_app_version: int, latest_app_version: int}, android: map{min_app_version: int, latest_app_version: int}, max_team_page: int} # Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endgroup\n\n@group team\n@endpoint GET /team/{team_key}\n@desc Gets a `Team` object for the team referenced by the given key.\n@required {team_key: str # TBA Team Key, eg `frc254`}\n@returns(200) {key: str, team_number: int, nickname: str, name: str, school_name: str?, city: str?, state_prov: str?, country: str?, address: str?, postal_code: str?, gmaps_place_id: str?, gmaps_url: str(url)?, lat: num(double)?, lng: num(double)?, location_name: str?, website: str(url)?, rookie_year: int?, motto: str?} # Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /team/{team_key}/awards\n@desc Gets a list of awards the given team has won.\n@required {team_key: str # TBA Team Key, eg `frc254`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /team/{team_key}/awards/{year}\n@desc Gets a list of awards the given team has won in a given year.\n@required {team_key: str # TBA Team Key, eg `frc254`, year: int # Competition Year (or Season). Must be 4 digits.}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /team/{team_key}/districts\n@desc Gets an array of districts representing each year the team was in a district. Will return an empty array if the team was never in a district.\n@required {team_key: str # TBA Team Key, eg `frc254`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /team/{team_key}/event/{event_key}/awards\n@desc Gets a list of awards the given team won at the given event.\n@required {team_key: str # TBA Team Key, eg `frc254`, event_key: str # TBA Event Key, eg `2016nytr`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /team/{team_key}/event/{event_key}/matches\n@desc Gets a list of matches for the given team and event.\n@required {team_key: str # TBA Team Key, eg `frc254`, event_key: str # TBA Event Key, eg `2016nytr`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /team/{team_key}/event/{event_key}/matches/keys\n@desc Gets a list of match keys for matches for the given team and event.\n@required {team_key: str # TBA Team Key, eg `frc254`, event_key: str # TBA Event Key, eg `2016nytr`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /team/{team_key}/event/{event_key}/matches/simple\n@desc Gets a short-form list of matches for the given team and event.\n@required {team_key: str # TBA Team Key, eg `frc254`, event_key: str # TBA Event Key, eg `2016nytr`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /team/{team_key}/event/{event_key}/status\n@desc Gets the competition rank and status of the team at the given event.\n@required {team_key: str # TBA Team Key, eg `frc254`, event_key: str # TBA Event Key, eg `2016nytr`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /team/{team_key}/events\n@desc Gets a list of all events this team has competed at.\n@required {team_key: str # TBA Team Key, eg `frc254`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /team/{team_key}/events/keys\n@desc Gets a list of the event keys for all events this team has competed at.\n@required {team_key: str # TBA Team Key, eg `frc254`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /team/{team_key}/events/simple\n@desc Gets a short-form list of all events this team has competed at.\n@required {team_key: str # TBA Team Key, eg `frc254`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /team/{team_key}/events/{year}\n@desc Gets a list of events this team has competed at in the given year.\n@required {team_key: str # TBA Team Key, eg `frc254`, year: int # Competition Year (or Season). Must be 4 digits.}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /team/{team_key}/events/{year}/keys\n@desc Gets a list of the event keys for events this team has competed at in the given year.\n@required {team_key: str # TBA Team Key, eg `frc254`, year: int # Competition Year (or Season). Must be 4 digits.}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /team/{team_key}/events/{year}/simple\n@desc Gets a short-form list of events this team has competed at in the given year.\n@required {team_key: str # TBA Team Key, eg `frc254`, year: int # Competition Year (or Season). Must be 4 digits.}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /team/{team_key}/events/{year}/statuses\n@desc Gets a key-value list of the event statuses for events this team has competed at in the given year.\n@required {team_key: str # TBA Team Key, eg `frc254`, year: int # Competition Year (or Season). Must be 4 digits.}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /team/{team_key}/history\n@desc Gets the history for the team referenced by the given key, including their events and awards.\n@required {team_key: str # TBA Team Key, eg `frc254`}\n@returns(200) {events: [map], awards: [map]} # Successful response with team's history including events and awards.\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /team/{team_key}/matches/{year}\n@desc Gets a list of matches for the given team and year.\n@required {team_key: str # TBA Team Key, eg `frc254`, year: int # Competition Year (or Season). Must be 4 digits.}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /team/{team_key}/matches/{year}/keys\n@desc Gets a list of match keys for matches for the given team and year.\n@required {team_key: str # TBA Team Key, eg `frc254`, year: int # Competition Year (or Season). Must be 4 digits.}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /team/{team_key}/matches/{year}/simple\n@desc Gets a short-form list of matches for the given team and year.\n@required {team_key: str # TBA Team Key, eg `frc254`, year: int # Competition Year (or Season). Must be 4 digits.}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /team/{team_key}/media/tag/{media_tag}\n@desc Gets a list of Media (videos / pictures) for the given team and tag.\n@required {team_key: str # TBA Team Key, eg `frc254`, media_tag: str # Media Tag which describes the Media.}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /team/{team_key}/media/tag/{media_tag}/{year}\n@desc Gets a list of Media (videos / pictures) for the given team, tag and year.\n@required {team_key: str # TBA Team Key, eg `frc254`, media_tag: str # Media Tag which describes the Media., year: int # Competition Year (or Season). Must be 4 digits.}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /team/{team_key}/media/{year}\n@desc Gets a list of Media (videos / pictures) for the given team and year.\n@required {team_key: str # TBA Team Key, eg `frc254`, year: int # Competition Year (or Season). Must be 4 digits.}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /team/{team_key}/robots\n@desc Gets a list of year and robot name pairs for each year that a robot name was provided. Will return an empty array if the team has never named a robot.\n@required {team_key: str # TBA Team Key, eg `frc254`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /team/{team_key}/simple\n@desc Gets a `Team_Simple` object for the team referenced by the given key.\n@required {team_key: str # TBA Team Key, eg `frc254`}\n@returns(200) {key: str, team_number: int, nickname: str, name: str, city: str?, state_prov: str?, country: str?} # Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /team/{team_key}/social_media\n@desc Gets a list of Media (social media) for the given team.\n@required {team_key: str # TBA Team Key, eg `frc254`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /team/{team_key}/years_participated\n@desc Gets a list of years in which the team participated in at least one competition.\n@required {team_key: str # TBA Team Key, eg `frc254`}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endgroup\n\n@group teams\n@endpoint GET /teams/{page_num}\n@desc Gets a list of `Team` objects, paginated in groups of 500.\n@required {page_num: int # Page number of results to return, zero-indexed}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /teams/{page_num}/keys\n@desc Gets a list of Team keys, paginated in groups of 500. (Note, each page will not have 500 teams, but will include the teams within that range of 500.)\n@required {page_num: int # Page number of results to return, zero-indexed}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /teams/{page_num}/simple\n@desc Gets a list of short form `Team_Simple` objects, paginated in groups of 500.\n@required {page_num: int # Page number of results to return, zero-indexed}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /teams/{year}/{page_num}\n@desc Gets a list of `Team` objects that competed in the given year, paginated in groups of 500.\n@required {year: int # Competition Year (or Season). Must be 4 digits., page_num: int # Page number of results to return, zero-indexed}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /teams/{year}/{page_num}/keys\n@desc Gets a list Team Keys that competed in the given year, paginated in groups of 500.\n@required {year: int # Competition Year (or Season). Must be 4 digits., page_num: int # Page number of results to return, zero-indexed}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endpoint GET /teams/{year}/{page_num}/simple\n@desc Gets a list of short form `Team_Simple` objects that competed in the given year, paginated in groups of 500.\n@required {year: int # Competition Year (or Season). Must be 4 digits., page_num: int # Page number of results to return, zero-indexed}\n@returns(200) Successful response\n@errors {304: Not Modified - Use Local Cached Value, 401: Authorization information is missing or invalid., 404: Not Found}\n\n@endgroup\n\n@end\n"}}