The Blue Alliance API v3
Overview
Information and statistics about FIRST Robotics Competition teams and events.
Authentication
All endpoints require an Auth Key to be passed in the header X-TBA-Auth-Key. If you do not have an auth key yet, you can obtain one from your .
- Homepage
- https://api.apis.guru/v2/specs/thebluealliance.com/3.8.2.json
- Provider
- thebluealliance.com
- OpenAPI version
- 3.0.1
- Spec (JSON)
- https://api.apis.guru/v2/specs/thebluealliance.com/3.8.2/openapi.json
- Spec (YAML)
- https://api.apis.guru/v2/specs/thebluealliance.com/3.8.2/openapi.yaml
Tools (67)
Extracted live via the executor SDK.
-
district.getDistrictEventsGets a list of events in the given district.
-
district.getDistrictEventsKeysGets a list of event keys for events in the given district.
-
district.getDistrictEventsSimpleGets a short-form list of events in the given district.
-
district.getDistrictRankingsGets a list of team district rankings for the given district.
-
district.getDistrictsByYearGets a list of districts and their corresponding district key, for the given year.
-
district.getDistrictTeamsGets a list of
Teamobjects that competed in events in the given district. -
district.getDistrictTeamsKeysGets a list of
Teamobjects that competed in events in the given district. -
district.getDistrictTeamsSimpleGets a short-form list of
Teamobjects that competed in events in the given district. -
event.getEventGets an Event.
-
event.getEventAlliancesGets a list of Elimination Alliances for the given Event.
-
event.getEventAwardsGets a list of awards from the given event.
-
event.getEventDistrictPointsGets a list of team rankings for the Event.
-
event.getEventInsightsGets a set of Event-specific insights for the given Event.
-
event.getEventMatchesGets a list of matches for the given event.
-
event.getEventMatchesKeysGets a list of match keys for the given event.
-
event.getEventMatchesSimpleGets a short-form list of matches for the given event.
-
event.getEventMatchTimeseriesGets an array of Match Keys for the given event key that have timeseries data. Returns an empty array if no matches have timeseries data. WARNING: This is not official data, and is subject to a significant possibility of error, or missing data. Do not rely on this data for any purpose. In fact, pretend we made it up. WARNING: This endpoint and corresponding data models are under active development and may change at any time, including in breaking ways.
-
event.getEventOpRsGets a set of Event OPRs (including OPR, DPR, and CCWM) for the given Event.
-
event.getEventPredictionsGets 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.
-
event.getEventRankingsGets a list of team rankings for the Event.
-
event.getEventsByYearGets a list of events in the given year.
-
event.getEventsByYearKeysGets a list of event keys in the given year.
-
event.getEventsByYearSimpleGets a short-form list of events in the given year.
-
event.getEventSimpleGets a short-form Event.
-
event.getEventTeamsGets a list of
Teamobjects that competed in the given event. -
event.getEventTeamsKeysGets a list of
Teamkeys that competed in the given event. -
event.getEventTeamsSimpleGets a short-form list of
Teamobjects that competed in the given event. -
event.getEventTeamsStatusesGets a key-value list of the event statuses for teams competing at the given event.
-
list.getTeamEventsStatusesByYearGets a key-value list of the event statuses for events this team has competed at in the given year.
-
match.getMatchGets a
Matchobject for the given match key. -
match.getMatchSimpleGets a short-form
Matchobject for the given match key. -
match.getMatchTimeseriesGets an array of game-specific Match Timeseries objects for the given match key or an empty array if not available. WARNING: This is not official data, and is subject to a significant possibility of error, or missing data. Do not rely on this data for any purpose. In fact, pretend we made it up. WARNING: This endpoint and corresponding data models are under active development and may change at any time, including in breaking ways.
-
match.getMatchZebraGets Zebra MotionWorks data for a Match for the given match key.
-
tba.getStatusReturns API status, and TBA status information.
-
team.getTeamGets a
Teamobject for the team referenced by the given key. -
team.getTeamAwardsGets a list of awards the given team has won.
-
team.getTeamAwardsByYearGets a list of awards the given team has won in a given year.
-
team.getTeamDistrictsGets 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.
-
team.getTeamEventAwardsGets a list of awards the given team won at the given event.
-
team.getTeamEventMatchesGets a list of matches for the given team and event.
-
team.getTeamEventMatchesKeysGets a list of match keys for matches for the given team and event.
-
team.getTeamEventMatchesSimpleGets a short-form list of matches for the given team and event.
-
team.getTeamEventsGets a list of all events this team has competed at.
-
team.getTeamEventsByYearGets a list of events this team has competed at in the given year.
-
team.getTeamEventsByYearKeysGets a list of the event keys for events this team has competed at in the given year.
-
team.getTeamEventsByYearSimpleGets a short-form list of events this team has competed at in the given year.
-
team.getTeamEventsKeysGets a list of the event keys for all events this team has competed at.
-
team.getTeamEventsSimpleGets a short-form list of all events this team has competed at.
-
team.getTeamEventStatusGets the competition rank and status of the team at the given event.
-
team.getTeamMatchesByYearGets a list of matches for the given team and year.
-
team.getTeamMatchesByYearKeysGets a list of match keys for matches for the given team and year.
-
team.getTeamMatchesByYearSimpleGets a short-form list of matches for the given team and year.
-
team.getTeamMediaByTagGets a list of Media (videos / pictures) for the given team and tag.
-
team.getTeamMediaByTagYearGets a list of Media (videos / pictures) for the given team, tag and year.
-
team.getTeamMediaByYearGets a list of Media (videos / pictures) for the given team and year.
-
team.getTeamRobotsGets 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.
-
team.getTeamsGets a list of
Teamobjects, paginated in groups of 500. -
team.getTeamsByYearGets a list of
Teamobjects that competed in the given year, paginated in groups of 500. -
team.getTeamsByYearKeysGets a list Team Keys that competed in the given year, paginated in groups of 500.
-
team.getTeamsByYearSimpleGets a list of short form
Team_Simpleobjects that competed in the given year, paginated in groups of 500. -
team.getTeamSimpleGets a
Team_Simpleobject for the team referenced by the given key. -
team.getTeamsKeysGets 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.)
-
team.getTeamSocialMediaGets a list of Media (social media) for the given team.
-
team.getTeamsSimpleGets a list of short form
Team_Simpleobjects, paginated in groups of 500. -
team.getTeamYearsParticipatedGets a list of years in which the team participated in at least one competition.
-
openapi.previewSpecPreview an OpenAPI document before adding it as a source
-
openapi.addSourceAdd an OpenAPI source and register its operations as tools