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. A User-Agent header may need to be set to prevent a 403 Unauthorized error.
This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.
- API version: 3.5
- Package version: 3.5
- Build package: org.openapitools.codegen.languages.GoClientCodegen
Install the following dependencies:
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optionalPut the package under your project folder and add the following in import:
import "./openapi"All URIs are relative to https://www.thebluealliance.com/api/v3
| Class | Method | HTTP request | Description |
|---|---|---|---|
| DistrictApi | GetDistrictEvents | Get /district/{district_key}/events | |
| DistrictApi | GetDistrictEventsKeys | Get /district/{district_key}/events/keys | |
| DistrictApi | GetDistrictEventsSimple | Get /district/{district_key}/events/simple | |
| DistrictApi | GetDistrictRankings | Get /district/{district_key}/rankings | |
| DistrictApi | GetDistrictTeams | Get /district/{district_key}/teams | |
| DistrictApi | GetDistrictTeamsKeys | Get /district/{district_key}/teams/keys | |
| DistrictApi | GetDistrictTeamsSimple | Get /district/{district_key}/teams/simple | |
| DistrictApi | GetDistrictsByYear | Get /districts/{year} | |
| DistrictApi | GetEventDistrictPoints | Get /event/{event_key}/district_points | |
| DistrictApi | GetTeamDistricts | Get /team/{team_key}/districts | |
| EventApi | GetDistrictEvents | Get /district/{district_key}/events | |
| EventApi | GetDistrictEventsKeys | Get /district/{district_key}/events/keys | |
| EventApi | GetDistrictEventsSimple | Get /district/{district_key}/events/simple | |
| EventApi | GetEvent | Get /event/{event_key} | |
| EventApi | GetEventAlliances | Get /event/{event_key}/alliances | |
| EventApi | GetEventAwards | Get /event/{event_key}/awards | |
| EventApi | GetEventDistrictPoints | Get /event/{event_key}/district_points | |
| EventApi | GetEventInsights | Get /event/{event_key}/insights | |
| EventApi | GetEventMatchTimeseries | Get /event/{event_key}/matches/timeseries | |
| EventApi | GetEventMatches | Get /event/{event_key}/matches | |
| EventApi | GetEventMatchesKeys | Get /event/{event_key}/matches/keys | |
| EventApi | GetEventMatchesSimple | Get /event/{event_key}/matches/simple | |
| EventApi | GetEventOPRs | Get /event/{event_key}/oprs | |
| EventApi | GetEventPredictions | Get /event/{event_key}/predictions | |
| EventApi | GetEventRankings | Get /event/{event_key}/rankings | |
| EventApi | GetEventSimple | Get /event/{event_key}/simple | |
| EventApi | GetEventTeams | Get /event/{event_key}/teams | |
| EventApi | GetEventTeamsKeys | Get /event/{event_key}/teams/keys | |
| EventApi | GetEventTeamsSimple | Get /event/{event_key}/teams/simple | |
| EventApi | GetEventTeamsStatuses | Get /event/{event_key}/teams/statuses | |
| EventApi | GetEventsByYear | Get /events/{year} | |
| EventApi | GetEventsByYearKeys | Get /events/{year}/keys | |
| EventApi | GetEventsByYearSimple | Get /events/{year}/simple | |
| EventApi | GetTeamEventAwards | Get /team/{team_key}/event/{event_key}/awards | |
| EventApi | GetTeamEventMatches | Get /team/{team_key}/event/{event_key}/matches | |
| EventApi | GetTeamEventMatchesKeys | Get /team/{team_key}/event/{event_key}/matches/keys | |
| EventApi | GetTeamEventMatchesSimple | Get /team/{team_key}/event/{event_key}/matches/simple | |
| EventApi | GetTeamEventStatus | Get /team/{team_key}/event/{event_key}/status | |
| EventApi | GetTeamEvents | Get /team/{team_key}/events | |
| EventApi | GetTeamEventsByYear | Get /team/{team_key}/events/{year} | |
| EventApi | GetTeamEventsByYearKeys | Get /team/{team_key}/events/{year}/keys | |
| EventApi | GetTeamEventsByYearSimple | Get /team/{team_key}/events/{year}/simple | |
| EventApi | GetTeamEventsKeys | Get /team/{team_key}/events/keys | |
| EventApi | GetTeamEventsSimple | Get /team/{team_key}/events/simple | |
| EventApi | GetTeamEventsStatusesByYear | Get /team/{team_key}/events/{year}/statuses | |
| ListApi | GetDistrictEvents | Get /district/{district_key}/events | |
| ListApi | GetDistrictEventsKeys | Get /district/{district_key}/events/keys | |
| ListApi | GetDistrictEventsSimple | Get /district/{district_key}/events/simple | |
| ListApi | GetDistrictRankings | Get /district/{district_key}/rankings | |
| ListApi | GetDistrictTeams | Get /district/{district_key}/teams | |
| ListApi | GetDistrictTeamsKeys | Get /district/{district_key}/teams/keys | |
| ListApi | GetDistrictTeamsSimple | Get /district/{district_key}/teams/simple | |
| ListApi | GetEventTeams | Get /event/{event_key}/teams | |
| ListApi | GetEventTeamsKeys | Get /event/{event_key}/teams/keys | |
| ListApi | GetEventTeamsSimple | Get /event/{event_key}/teams/simple | |
| ListApi | GetEventTeamsStatuses | Get /event/{event_key}/teams/statuses | |
| ListApi | GetEventsByYear | Get /events/{year} | |
| ListApi | GetEventsByYearKeys | Get /events/{year}/keys | |
| ListApi | GetEventsByYearSimple | Get /events/{year}/simple | |
| ListApi | GetTeamEventsStatusesByYear | Get /team/{team_key}/events/{year}/statuses | |
| ListApi | GetTeams | Get /teams/{page_num} | |
| ListApi | GetTeamsByYear | Get /teams/{year}/{page_num} | |
| ListApi | GetTeamsByYearKeys | Get /teams/{year}/{page_num}/keys | |
| ListApi | GetTeamsByYearSimple | Get /teams/{year}/{page_num}/simple | |
| ListApi | GetTeamsKeys | Get /teams/{page_num}/keys | |
| ListApi | GetTeamsSimple | Get /teams/{page_num}/simple | |
| MatchApi | GetEventMatchTimeseries | Get /event/{event_key}/matches/timeseries | |
| MatchApi | GetEventMatches | Get /event/{event_key}/matches | |
| MatchApi | GetEventMatchesKeys | Get /event/{event_key}/matches/keys | |
| MatchApi | GetEventMatchesSimple | Get /event/{event_key}/matches/simple | |
| MatchApi | GetMatch | Get /match/{match_key} | |
| MatchApi | GetMatchSimple | Get /match/{match_key}/simple | |
| MatchApi | GetMatchTimeseries | Get /match/{match_key}/timeseries | |
| MatchApi | GetTeamEventMatches | Get /team/{team_key}/event/{event_key}/matches | |
| MatchApi | GetTeamEventMatchesKeys | Get /team/{team_key}/event/{event_key}/matches/keys | |
| MatchApi | GetTeamEventMatchesSimple | Get /team/{team_key}/event/{event_key}/matches/simple | |
| MatchApi | GetTeamMatchesByYear | Get /team/{team_key}/matches/{year} | |
| MatchApi | GetTeamMatchesByYearKeys | Get /team/{team_key}/matches/{year}/keys | |
| MatchApi | GetTeamMatchesByYearSimple | Get /team/{team_key}/matches/{year}/simple | |
| TBAApi | GetStatus | Get /status | |
| TeamApi | GetDistrictRankings | Get /district/{district_key}/rankings | |
| TeamApi | GetDistrictTeams | Get /district/{district_key}/teams | |
| TeamApi | GetDistrictTeamsKeys | Get /district/{district_key}/teams/keys | |
| TeamApi | GetDistrictTeamsSimple | Get /district/{district_key}/teams/simple | |
| TeamApi | GetEventTeams | Get /event/{event_key}/teams | |
| TeamApi | GetEventTeamsKeys | Get /event/{event_key}/teams/keys | |
| TeamApi | GetEventTeamsSimple | Get /event/{event_key}/teams/simple | |
| TeamApi | GetEventTeamsStatuses | Get /event/{event_key}/teams/statuses | |
| TeamApi | GetTeam | Get /team/{team_key} | |
| TeamApi | GetTeamAwards | Get /team/{team_key}/awards | |
| TeamApi | GetTeamAwardsByYear | Get /team/{team_key}/awards/{year} | |
| TeamApi | GetTeamDistricts | Get /team/{team_key}/districts | |
| TeamApi | GetTeamEventAwards | Get /team/{team_key}/event/{event_key}/awards | |
| TeamApi | GetTeamEventMatches | Get /team/{team_key}/event/{event_key}/matches | |
| TeamApi | GetTeamEventMatchesKeys | Get /team/{team_key}/event/{event_key}/matches/keys | |
| TeamApi | GetTeamEventMatchesSimple | Get /team/{team_key}/event/{event_key}/matches/simple | |
| TeamApi | GetTeamEventStatus | Get /team/{team_key}/event/{event_key}/status | |
| TeamApi | GetTeamEvents | Get /team/{team_key}/events | |
| TeamApi | GetTeamEventsByYear | Get /team/{team_key}/events/{year} | |
| TeamApi | GetTeamEventsByYearKeys | Get /team/{team_key}/events/{year}/keys | |
| TeamApi | GetTeamEventsByYearSimple | Get /team/{team_key}/events/{year}/simple | |
| TeamApi | GetTeamEventsKeys | Get /team/{team_key}/events/keys | |
| TeamApi | GetTeamEventsSimple | Get /team/{team_key}/events/simple | |
| TeamApi | GetTeamEventsStatusesByYear | Get /team/{team_key}/events/{year}/statuses | |
| TeamApi | GetTeamMatchesByYear | Get /team/{team_key}/matches/{year} | |
| TeamApi | GetTeamMatchesByYearKeys | Get /team/{team_key}/matches/{year}/keys | |
| TeamApi | GetTeamMatchesByYearSimple | Get /team/{team_key}/matches/{year}/simple | |
| TeamApi | GetTeamMediaByTag | Get /team/{team_key}/media/tag/{media_tag} | |
| TeamApi | GetTeamMediaByTagYear | Get /team/{team_key}/media/tag/{media_tag}/{year} | |
| TeamApi | GetTeamMediaByYear | Get /team/{team_key}/media/{year} | |
| TeamApi | GetTeamRobots | Get /team/{team_key}/robots | |
| TeamApi | GetTeamSimple | Get /team/{team_key}/simple | |
| TeamApi | GetTeamSocialMedia | Get /team/{team_key}/social_media | |
| TeamApi | GetTeamYearsParticipated | Get /team/{team_key}/years_participated | |
| TeamApi | GetTeams | Get /teams/{page_num} | |
| TeamApi | GetTeamsByYear | Get /teams/{year}/{page_num} | |
| TeamApi | GetTeamsByYearKeys | Get /teams/{year}/{page_num}/keys | |
| TeamApi | GetTeamsByYearSimple | Get /teams/{year}/{page_num}/simple | |
| TeamApi | GetTeamsKeys | Get /teams/{page_num}/keys | |
| TeamApi | GetTeamsSimple | Get /teams/{page_num}/simple |
- ApiStatus
- ApiStatusAppVersion
- Award
- AwardRecipient
- DistrictList
- DistrictRanking
- DistrictRankingEventPoints
- EliminationAlliance
- EliminationAllianceBackup
- EliminationAllianceStatus
- Event
- EventDistrictPoints
- EventDistrictPointsPoints
- EventDistrictPointsTiebreakers
- EventInsights
- EventInsights2016
- EventInsights2017
- EventInsights2018
- EventOpRs
- EventRanking
- EventRankingExtraStatsInfo
- EventRankingRankings
- EventRankingSortOrderInfo
- EventSimple
- Match
- MatchAlliance
- MatchScoreBreakdown2015
- MatchScoreBreakdown2015Alliance
- MatchScoreBreakdown2016
- MatchScoreBreakdown2016Alliance
- MatchScoreBreakdown2017
- MatchScoreBreakdown2017Alliance
- MatchScoreBreakdown2018
- MatchScoreBreakdown2018Alliance
- MatchScoreBreakdown2019
- MatchScoreBreakdown2019Alliance
- MatchSimple
- MatchSimpleAlliances
- MatchTimeseries2018
- MatchVideos
- Media
- Team
- TeamEventStatus
- TeamEventStatusAlliance
- TeamEventStatusAllianceBackup
- TeamEventStatusPlayoff
- TeamEventStatusRank
- TeamEventStatusRankRanking
- TeamEventStatusRankSortOrderInfo
- TeamRobot
- TeamSimple
- Webcast
- WltRecord
- Type: API key
Example
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
Key: "APIKEY",
Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)