# 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](/account).
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://www.thebluealliance.com/api/v3
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
# 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](/account).
| method | path | what the vendor says it does |
|---|---|---|
GET | /district/{district_key}/events | Gets a list of events in the given district. district event list |
GET | /district/{district_key}/events/keys | Gets a list of event keys for events in the given district. district event list |
GET | /district/{district_key}/events/simple | Gets a short-form list of events in the given district. district event list |
GET | /district/{district_key}/rankings | Gets a list of team district rankings for the given district. district team list |
GET | /district/{district_key}/teams | Gets a list of `Team` objects that competed in events in the given district. district team list |
GET | /district/{district_key}/teams/keys | Gets a list of `Team` objects that competed in events in the given district. district team list |
GET | /district/{district_key}/teams/simple | Gets a short-form list of `Team` objects that competed in events in the given district. district team list |
GET | /districts/{year} | Gets a list of districts and their corresponding district key, for the given year. district |
GET | /event/{event_key} | Gets an Event. event |
GET | /event/{event_key}/alliances | Gets a list of Elimination Alliances for the given Event. event |
GET | /event/{event_key}/awards | Gets a list of awards from the given event. event |
GET | /event/{event_key}/district_points | Gets a list of team rankings for the Event. event district |
GET | /event/{event_key}/insights | Gets a set of Event-specific insights for the given Event. event |
GET | /event/{event_key}/matches | Gets a list of matches for the given event. event match |
GET | /event/{event_key}/matches/keys | Gets a list of match keys for the given event. event match |
GET | /event/{event_key}/matches/simple | Gets a short-form list of matches for the given event. event match |
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 ma |
GET | /event/{event_key}/oprs | Gets a set of Event OPRs (including OPR, DPR, and CCWM) for the given Event. event |
GET | /event/{event_key}/predictions | Gets information on TBA-generated predictions for the given Event. Contains year-specific information. *WARNIN |
GET | /event/{event_key}/rankings | Gets a list of team rankings for the Event. event |
GET | /event/{event_key}/simple | Gets a short-form Event. event |
GET | /event/{event_key}/teams | Gets a list of `Team` objects that competed in the given event. event team list |
GET | /event/{event_key}/teams/keys | Gets a list of `Team` keys that competed in the given event. event team list |
GET | /event/{event_key}/teams/simple | Gets a short-form list of `Team` objects that competed in the given event. event team list |
GET | /event/{event_key}/teams/statuses | Gets a key-value list of the event statuses for teams competing at the given event. event team list |
GET | /events/{year} | Gets a list of events in the given year. event list |
GET | /events/{year}/keys | Gets a list of event keys in the given year. event list |
GET | /events/{year}/simple | Gets a short-form list of events in the given year. event list |
GET | /match/{match_key} | Gets a `Match` object for the given match key. match |
GET | /match/{match_key}/simple | Gets a short-form `Match` object for the given match key. match |
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 avail |
GET | /match/{match_key}/zebra_motionworks | Gets Zebra MotionWorks data for a Match for the given match key. match |
GET | /status | Returns API status, and TBA status information. TBA |
GET | /team/{team_key} | Gets a `Team` object for the team referenced by the given key. team |
GET | /team/{team_key}/awards | Gets a list of awards the given team has won. team |
GET | /team/{team_key}/awards/{year} | Gets a list of awards the given team has won in a given year. team |
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 th |
GET | /team/{team_key}/event/{event_key}/awards | Gets a list of awards the given team won at the given event. team event |
GET | /team/{team_key}/event/{event_key}/matches | Gets a list of matches for the given team and event. team event match |
GET | /team/{team_key}/event/{event_key}/matches/keys | Gets a list of match keys for matches for the given team and event. team event match |
and 25 more operation(s) in this specification, all searchable.
specification origin: https://www.thebluealliance.com/swagger/api_v3.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.