integrations.sh
← all integrations

The Blue Alliance API v3

OpenAPI apis-guru open_data

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.getDistrictEvents

    Gets a list of events in the given district.

  • district.getDistrictEventsKeys

    Gets a list of event keys for events in the given district.

  • district.getDistrictEventsSimple

    Gets a short-form list of events in the given district.

  • district.getDistrictRankings

    Gets a list of team district rankings for the given district.

  • district.getDistrictsByYear

    Gets a list of districts and their corresponding district key, for the given year.

  • district.getDistrictTeams

    Gets a list of Team objects that competed in events in the given district.

  • district.getDistrictTeamsKeys

    Gets a list of Team objects that competed in events in the given district.

  • district.getDistrictTeamsSimple

    Gets a short-form list of Team objects that competed in events in the given district.

  • event.getEvent

    Gets an Event.

  • event.getEventAlliances

    Gets a list of Elimination Alliances for the given Event.

  • event.getEventAwards

    Gets a list of awards from the given event.

  • event.getEventDistrictPoints

    Gets a list of team rankings for the Event.

  • event.getEventInsights

    Gets a set of Event-specific insights for the given Event.

  • event.getEventMatches

    Gets a list of matches for the given event.

  • event.getEventMatchesKeys

    Gets a list of match keys for the given event.

  • event.getEventMatchesSimple

    Gets a short-form list of matches for the given event.

  • event.getEventMatchTimeseries

    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. 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.getEventOpRs

    Gets a set of Event OPRs (including OPR, DPR, and CCWM) for the given Event.

  • event.getEventPredictions

    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.

  • event.getEventRankings

    Gets a list of team rankings for the Event.

  • event.getEventsByYear

    Gets a list of events in the given year.

  • event.getEventsByYearKeys

    Gets a list of event keys in the given year.

  • event.getEventsByYearSimple

    Gets a short-form list of events in the given year.

  • event.getEventSimple

    Gets a short-form Event.

  • event.getEventTeams

    Gets a list of Team objects that competed in the given event.

  • event.getEventTeamsKeys

    Gets a list of Team keys that competed in the given event.

  • event.getEventTeamsSimple

    Gets a short-form list of Team objects that competed in the given event.

  • event.getEventTeamsStatuses

    Gets a key-value list of the event statuses for teams competing at the given event.

  • list.getTeamEventsStatusesByYear

    Gets a key-value list of the event statuses for events this team has competed at in the given year.

  • match.getMatch

    Gets a Match object for the given match key.

  • match.getMatchSimple

    Gets a short-form Match object for the given match key.

  • match.getMatchTimeseries

    Gets 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.getMatchZebra

    Gets Zebra MotionWorks data for a Match for the given match key.

  • tba.getStatus

    Returns API status, and TBA status information.

  • team.getTeam

    Gets a Team object for the team referenced by the given key.

  • team.getTeamAwards

    Gets a list of awards the given team has won.

  • team.getTeamAwardsByYear

    Gets a list of awards the given team has won in a given year.

  • team.getTeamDistricts

    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.

  • team.getTeamEventAwards

    Gets a list of awards the given team won at the given event.

  • team.getTeamEventMatches

    Gets a list of matches for the given team and event.

  • team.getTeamEventMatchesKeys

    Gets a list of match keys for matches for the given team and event.

  • team.getTeamEventMatchesSimple

    Gets a short-form list of matches for the given team and event.

  • team.getTeamEvents

    Gets a list of all events this team has competed at.

  • team.getTeamEventsByYear

    Gets a list of events this team has competed at in the given year.

  • team.getTeamEventsByYearKeys

    Gets a list of the event keys for events this team has competed at in the given year.

  • team.getTeamEventsByYearSimple

    Gets a short-form list of events this team has competed at in the given year.

  • team.getTeamEventsKeys

    Gets a list of the event keys for all events this team has competed at.

  • team.getTeamEventsSimple

    Gets a short-form list of all events this team has competed at.

  • team.getTeamEventStatus

    Gets the competition rank and status of the team at the given event.

  • team.getTeamMatchesByYear

    Gets a list of matches for the given team and year.

  • team.getTeamMatchesByYearKeys

    Gets a list of match keys for matches for the given team and year.

  • team.getTeamMatchesByYearSimple

    Gets a short-form list of matches for the given team and year.

  • team.getTeamMediaByTag

    Gets a list of Media (videos / pictures) for the given team and tag.

  • team.getTeamMediaByTagYear

    Gets a list of Media (videos / pictures) for the given team, tag and year.

  • team.getTeamMediaByYear

    Gets a list of Media (videos / pictures) for the given team and year.

  • team.getTeamRobots

    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.

  • team.getTeams

    Gets a list of Team objects, paginated in groups of 500.

  • team.getTeamsByYear

    Gets a list of Team objects that competed in the given year, paginated in groups of 500.

  • team.getTeamsByYearKeys

    Gets a list Team Keys that competed in the given year, paginated in groups of 500.

  • team.getTeamsByYearSimple

    Gets a list of short form Team_Simple objects that competed in the given year, paginated in groups of 500.

  • team.getTeamSimple

    Gets a Team_Simple object for the team referenced by the given key.

  • team.getTeamsKeys

    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.)

  • team.getTeamSocialMedia

    Gets a list of Media (social media) for the given team.

  • team.getTeamsSimple

    Gets a list of short form Team_Simple objects, paginated in groups of 500.

  • team.getTeamYearsParticipated

    Gets a list of years in which the team participated in at least one competition.

  • openapi.previewSpec

    Preview an OpenAPI document before adding it as a source

  • openapi.addSource

    Add an OpenAPI source and register its operations as tools