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…
Data & analytics#openapi#open-data
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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 Account Page.
Endpoints 65
TBA
- GETgetStatus
/statusReturns API status, and TBA status information.
list
- GETgetTeamEventsStatusesByYear
/team/:team_key/events/:year/statusesGets a key-value list of the event statuses for events this team has competed at in the given year.
team
- GETgetTeam
/team/:team_keyGets a Team object for the team referenced by the given key. - GETgetTeamAwards
/team/:team_key/awardsGets a list of awards the given team has won. - GETgetTeamAwardsByYear
/team/:team_key/awards/:yearGets a list of awards the given team has won in a given year. - GETgetTeamDistricts
/team/:team_key/districtsGets 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. - GETgetTeamEventAwards
/team/:team_key/event/:event_key/awardsGets a list of awards the given team won at the given event. - GETgetTeamEventMatches
/team/:team_key/event/:event_key/matchesGets a list of matches for the given team and event. - GETgetTeamEventMatchesKeys
/team/:team_key/event/:event_key/matches/keysGets a list of match keys for matches for the given team and event. - GETgetTeamEventMatchesSimple
/team/:team_key/event/:event_key/matches/simpleGets a short-form list of matches for the given team and event. - GETgetTeamEventStatus
/team/:team_key/event/:event_key/statusGets the competition rank and status of the team at the given event. - GETgetTeamEvents
/team/:team_key/eventsGets a list of all events this team has competed at. - GETgetTeamEventsKeys
/team/:team_key/events/keysGets a list of the event keys for all events this team has competed at. - GETgetTeamEventsSimple
/team/:team_key/events/simpleGets a short-form list of all events this team has competed at. - GETgetTeamEventsByYear
/team/:team_key/events/:yearGets a list of events this team has competed at in the given year. - GETgetTeamEventsByYearKeys
/team/:team_key/events/:year/keysGets a list of the event keys for events this team has competed at in the given year. - GETgetTeamEventsByYearSimple
/team/:team_key/events/:year/simpleGets a short-form list of events this team has competed at in the given year. - GETgetTeamMatchesByYear
/team/:team_key/matches/:yearGets a list of matches for the given team and year. - GETgetTeamMatchesByYearKeys
/team/:team_key/matches/:year/keysGets a list of match keys for matches for the given team and year. - GETgetTeamMatchesByYearSimple
/team/:team_key/matches/:year/simpleGets a short-form list of matches for the given team and year. - GETgetTeamMediaByTag
/team/:team_key/media/tag/:media_tagGets a list of Media (videos / pictures) for the given team and tag. - GETgetTeamMediaByTagYear
/team/:team_key/media/tag/:media_tag/:yearGets a list of Media (videos / pictures) for the given team, tag and year. - GETgetTeamMediaByYear
/team/:team_key/media/:yearGets a list of Media (videos / pictures) for the given team and year. - GETgetTeamRobots
/team/:team_key/robotsGets 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. - GETgetTeamSimple
/team/:team_key/simpleGets a Team_Simple object for the team referenced by the given key. - GETgetTeamSocialMedia
/team/:team_key/social_mediaGets a list of Media (social media) for the given team. - GETgetTeamYearsParticipated
/team/:team_key/years_participatedGets a list of years in which the team participated in at least one competition. - GETgetTeams
/teams/:page_numGets a list of Team objects, paginated in groups of 500. - GETgetTeamsKeys
/teams/:page_num/keysGets 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.) - GETgetTeamsSimple
/teams/:page_num/simpleGets a list of short form Team_Simple objects, paginated in groups of 500. - GETgetTeamsByYear
/teams/:year/:page_numGets a list of Team objects that competed in the given year, paginated in groups of 500. - GETgetTeamsByYearKeys
/teams/:year/:page_num/keysGets a list Team Keys that competed in the given year, paginated in groups of 500. - GETgetTeamsByYearSimple
/teams/:year/:page_num/simpleGets a list of short form Team_Simple objects that competed in the given year, paginated in groups of 500.
event
- GETgetEvent
/event/:event_keyGets an Event. - GETgetEventAlliances
/event/:event_key/alliancesGets a list of Elimination Alliances for the given Event. - GETgetEventAwards
/event/:event_key/awardsGets a list of awards from the given event. - GETgetEventDistrictPoints
/event/:event_key/district_pointsGets a list of team rankings for the Event. - GETgetEventInsights
/event/:event_key/insightsGets a set of Event-specific insights for the given Event. - GETgetEventMatches
/event/:event_key/matchesGets a list of matches for the given event. - GETgetEventMatchesKeys
/event/:event_key/matches/keysGets a list of match keys for the given event. - GETgetEventMatchesSimple
/event/:event_key/matches/simpleGets a short-form list of matches for the given event. - GETgetEventMatchTimeseries
/event/:event_key/matches/timeseriesGets 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… - GETgetEventOPRs
/event/:event_key/oprsGets a set of Event OPRs (including OPR, DPR, and CCWM) for the given Event. - GETgetEventPredictions
/event/:event_key/predictionsGets information on TBA-generated predictions for the given Event. Contains year-specific information. *WARNING* This endpoint is currently under development… - GETgetEventRankings
/event/:event_key/rankingsGets a list of team rankings for the Event. - GETgetEventSimple
/event/:event_key/simpleGets a short-form Event. - GETgetEventTeams
/event/:event_key/teamsGets a list of Team objects that competed in the given event. - GETgetEventTeamsKeys
/event/:event_key/teams/keysGets a list of Team keys that competed in the given event. - GETgetEventTeamsSimple
/event/:event_key/teams/simpleGets a short-form list of Team objects that competed in the given event. - GETgetEventTeamsStatuses
/event/:event_key/teams/statusesGets a key-value list of the event statuses for teams competing at the given event. - GETgetEventsByYear
/events/:yearGets a list of events in the given year. - GETgetEventsByYearKeys
/events/:year/keysGets a list of event keys in the given year. - GETgetEventsByYearSimple
/events/:year/simpleGets a short-form list of events in the given year.
match
- GETgetMatch
/match/:match_keyGets a Match object for the given match key. - GETgetMatchSimple
/match/:match_key/simpleGets a short-form Match object for the given match key. - GETgetMatchTimeseries
/match/:match_key/timeseriesGets 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,… - GETgetMatchZebra
/match/:match_key/zebra_motionworksGets Zebra MotionWorks data for a Match for the given match key.
district
- GETgetDistrictEvents
/district/:district_key/eventsGets a list of events in the given district. - GETgetDistrictEventsKeys
/district/:district_key/events/keysGets a list of event keys for events in the given district. - GETgetDistrictEventsSimple
/district/:district_key/events/simpleGets a short-form list of events in the given district. - GETgetDistrictRankings
/district/:district_key/rankingsGets a list of team district rankings for the given district. - GETgetDistrictTeams
/district/:district_key/teamsGets a list of Team objects that competed in events in the given district. - GETgetDistrictTeamsKeys
/district/:district_key/teams/keysGets a list of Team objects that competed in events in the given district. - GETgetDistrictTeamsSimple
/district/:district_key/teams/simpleGets a short-form list of Team objects that competed in events in the given district. - GETgetDistrictsByYear
/districts/:yearGets a list of districts and their corresponding district key, for the given year.
API details
- Base URL
https://www.thebluealliance.com/api/v3- Authentication
- An API key in the X-TBA-Auth-Key header
- Operations
- 65 operations on 65 pathsGET 65
- Main resources
- team 40event 35list 21match 14district 10TBA 1
- Response formats
application/json- Description format
- OpenAPI 3.0.1, API version
3.8.2 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the The Blue Alliance API v3 in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the The Blue Alliance API v3 collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the X-TBA-Auth-Key header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “getStatus” (GET /status), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the 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… It is listed under Data & analytics and has 65 endpoints.
Who publishes the The Blue Alliance API v3?
It is listed from The Blue Alliance's public API description (an OpenAPI document), not published by The Blue Alliance on Swastik Codes. Anyone who controls thebluealliance.com can claim the profile by adding a DNS TXT record.
What is the base URL of the The Blue Alliance API v3?
Requests go to https://www.thebluealliance.com/api/v3. Endpoint paths are added to this base URL.
How do I authenticate with the The Blue Alliance API v3?
With an API key in the X-TBA-Auth-Key header.
How many endpoints does the The Blue Alliance API v3 have?
65 operations on 65 paths (65 GET). The largest groups are team, event, list, match.
Is forking the The Blue Alliance API v3 free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.