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

A User-Agent header may need to be set to prevent a 403 Unauthorized error.

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: 3.8.0
  • Build package: org.openapitools.codegen.languages.DartClientCodegen

Requirements

Dart 2.0 or later

Installation & Usage

Github

If this Dart package is published to Github, add the following dependency to your pubspec.yaml

dependencies:
  tba_api_client:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git

Local

To use the package in your local drive, add the following dependency to your pubspec.yaml

dependencies:
  tba_api_client:
    path: /path/to/tba_api_client

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

import 'package:tba_api_client/api.dart';

// TODO Configure API key authorization: apiKey
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('apiKey').apiKeyPrefix = 'Bearer';

var api_instance = DistrictApi();
var districtKey = districtKey_example; // String | TBA District Key, eg `2016fim`
var ifModifiedSince = ifModifiedSince_example; // String | Value of the `Last-Modified` header in the most recently cached response by the client.

try {
    var result = api_instance.getDistrictEvents(districtKey, ifModifiedSince);
    print(result);
} catch (e) {
    print("Exception when calling DistrictApi->getDistrictEvents: $e\n");
}

Documentation for API Endpoints

All URIs are relative to https://www.thebluealliance.com/api/v3

ClassMethodHTTP requestDescription
DistrictApigetDistrictEventsGET /district/{district_key}/events
DistrictApigetDistrictEventsKeysGET /district/{district_key}/events/keys
DistrictApigetDistrictEventsSimpleGET /district/{district_key}/events/simple
DistrictApigetDistrictRankingsGET /district/{district_key}/rankings
DistrictApigetDistrictTeamsGET /district/{district_key}/teams
DistrictApigetDistrictTeamsKeysGET /district/{district_key}/teams/keys
DistrictApigetDistrictTeamsSimpleGET /district/{district_key}/teams/simple
DistrictApigetDistrictsByYearGET /districts/{year}
DistrictApigetEventDistrictPointsGET /event/{event_key}/district_points
DistrictApigetTeamDistrictsGET /team/{team_key}/districts
EventApigetDistrictEventsGET /district/{district_key}/events
EventApigetDistrictEventsKeysGET /district/{district_key}/events/keys
EventApigetDistrictEventsSimpleGET /district/{district_key}/events/simple
EventApigetEventGET /event/{event_key}
EventApigetEventAlliancesGET /event/{event_key}/alliances
EventApigetEventAwardsGET /event/{event_key}/awards
EventApigetEventDistrictPointsGET /event/{event_key}/district_points
EventApigetEventInsightsGET /event/{event_key}/insights
EventApigetEventMatchTimeseriesGET /event/{event_key}/matches/timeseries
EventApigetEventMatchesGET /event/{event_key}/matches
EventApigetEventMatchesKeysGET /event/{event_key}/matches/keys
EventApigetEventMatchesSimpleGET /event/{event_key}/matches/simple
EventApigetEventOPRsGET /event/{event_key}/oprs
EventApigetEventPredictionsGET /event/{event_key}/predictions
EventApigetEventRankingsGET /event/{event_key}/rankings
EventApigetEventSimpleGET /event/{event_key}/simple
EventApigetEventTeamsGET /event/{event_key}/teams
EventApigetEventTeamsKeysGET /event/{event_key}/teams/keys
EventApigetEventTeamsSimpleGET /event/{event_key}/teams/simple
EventApigetEventTeamsStatusesGET /event/{event_key}/teams/statuses
EventApigetEventsByYearGET /events/{year}
EventApigetEventsByYearKeysGET /events/{year}/keys
EventApigetEventsByYearSimpleGET /events/{year}/simple
EventApigetTeamEventAwardsGET /team/{team_key}/event/{event_key}/awards
EventApigetTeamEventMatchesGET /team/{team_key}/event/{event_key}/matches
EventApigetTeamEventMatchesKeysGET /team/{team_key}/event/{event_key}/matches/keys
EventApigetTeamEventMatchesSimpleGET /team/{team_key}/event/{event_key}/matches/simple
EventApigetTeamEventStatusGET /team/{team_key}/event/{event_key}/status
EventApigetTeamEventsGET /team/{team_key}/events
EventApigetTeamEventsByYearGET /team/{team_key}/events/{year}
EventApigetTeamEventsByYearKeysGET /team/{team_key}/events/{year}/keys
EventApigetTeamEventsByYearSimpleGET /team/{team_key}/events/{year}/simple
EventApigetTeamEventsKeysGET /team/{team_key}/events/keys
EventApigetTeamEventsSimpleGET /team/{team_key}/events/simple
EventApigetTeamEventsStatusesByYearGET /team/{team_key}/events/{year}/statuses
ListApigetDistrictEventsGET /district/{district_key}/events
ListApigetDistrictEventsKeysGET /district/{district_key}/events/keys
ListApigetDistrictEventsSimpleGET /district/{district_key}/events/simple
ListApigetDistrictRankingsGET /district/{district_key}/rankings
ListApigetDistrictTeamsGET /district/{district_key}/teams
ListApigetDistrictTeamsKeysGET /district/{district_key}/teams/keys
ListApigetDistrictTeamsSimpleGET /district/{district_key}/teams/simple
ListApigetEventTeamsGET /event/{event_key}/teams
ListApigetEventTeamsKeysGET /event/{event_key}/teams/keys
ListApigetEventTeamsSimpleGET /event/{event_key}/teams/simple
ListApigetEventTeamsStatusesGET /event/{event_key}/teams/statuses
ListApigetEventsByYearGET /events/{year}
ListApigetEventsByYearKeysGET /events/{year}/keys
ListApigetEventsByYearSimpleGET /events/{year}/simple
ListApigetTeamEventsStatusesByYearGET /team/{team_key}/events/{year}/statuses
ListApigetTeamsGET /teams/{page_num}
ListApigetTeamsByYearGET /teams/{year}/{page_num}
ListApigetTeamsByYearKeysGET /teams/{year}/{page_num}/keys
ListApigetTeamsByYearSimpleGET /teams/{year}/{page_num}/simple
ListApigetTeamsKeysGET /teams/{page_num}/keys
ListApigetTeamsSimpleGET /teams/{page_num}/simple
MatchApigetEventMatchTimeseriesGET /event/{event_key}/matches/timeseries
MatchApigetEventMatchesGET /event/{event_key}/matches
MatchApigetEventMatchesKeysGET /event/{event_key}/matches/keys
MatchApigetEventMatchesSimpleGET /event/{event_key}/matches/simple
MatchApigetMatchGET /match/{match_key}
MatchApigetMatchSimpleGET /match/{match_key}/simple
MatchApigetMatchTimeseriesGET /match/{match_key}/timeseries
MatchApigetMatchZebraGET /match/{match_key}/zebra_motionworks
MatchApigetTeamEventMatchesGET /team/{team_key}/event/{event_key}/matches
MatchApigetTeamEventMatchesKeysGET /team/{team_key}/event/{event_key}/matches/keys
MatchApigetTeamEventMatchesSimpleGET /team/{team_key}/event/{event_key}/matches/simple
MatchApigetTeamMatchesByYearGET /team/{team_key}/matches/{year}
MatchApigetTeamMatchesByYearKeysGET /team/{team_key}/matches/{year}/keys
MatchApigetTeamMatchesByYearSimpleGET /team/{team_key}/matches/{year}/simple
TBAApigetStatusGET /status
TeamApigetDistrictRankingsGET /district/{district_key}/rankings
TeamApigetDistrictTeamsGET /district/{district_key}/teams
TeamApigetDistrictTeamsKeysGET /district/{district_key}/teams/keys
TeamApigetDistrictTeamsSimpleGET /district/{district_key}/teams/simple
TeamApigetEventTeamsGET /event/{event_key}/teams
TeamApigetEventTeamsKeysGET /event/{event_key}/teams/keys
TeamApigetEventTeamsSimpleGET /event/{event_key}/teams/simple
TeamApigetEventTeamsStatusesGET /event/{event_key}/teams/statuses
TeamApigetTeamGET /team/{team_key}
TeamApigetTeamAwardsGET /team/{team_key}/awards
TeamApigetTeamAwardsByYearGET /team/{team_key}/awards/{year}
TeamApigetTeamDistrictsGET /team/{team_key}/districts
TeamApigetTeamEventAwardsGET /team/{team_key}/event/{event_key}/awards
TeamApigetTeamEventMatchesGET /team/{team_key}/event/{event_key}/matches
TeamApigetTeamEventMatchesKeysGET /team/{team_key}/event/{event_key}/matches/keys
TeamApigetTeamEventMatchesSimpleGET /team/{team_key}/event/{event_key}/matches/simple
TeamApigetTeamEventStatusGET /team/{team_key}/event/{event_key}/status
TeamApigetTeamEventsGET /team/{team_key}/events
TeamApigetTeamEventsByYearGET /team/{team_key}/events/{year}
TeamApigetTeamEventsByYearKeysGET /team/{team_key}/events/{year}/keys
TeamApigetTeamEventsByYearSimpleGET /team/{team_key}/events/{year}/simple
TeamApigetTeamEventsKeysGET /team/{team_key}/events/keys
TeamApigetTeamEventsSimpleGET /team/{team_key}/events/simple
TeamApigetTeamEventsStatusesByYearGET /team/{team_key}/events/{year}/statuses
TeamApigetTeamMatchesByYearGET /team/{team_key}/matches/{year}
TeamApigetTeamMatchesByYearKeysGET /team/{team_key}/matches/{year}/keys
TeamApigetTeamMatchesByYearSimpleGET /team/{team_key}/matches/{year}/simple
TeamApigetTeamMediaByTagGET /team/{team_key}/media/tag/{media_tag}
TeamApigetTeamMediaByTagYearGET /team/{team_key}/media/tag/{media_tag}/{year}
TeamApigetTeamMediaByYearGET /team/{team_key}/media/{year}
TeamApigetTeamRobotsGET /team/{team_key}/robots
TeamApigetTeamSimpleGET /team/{team_key}/simple
TeamApigetTeamSocialMediaGET /team/{team_key}/social_media
TeamApigetTeamYearsParticipatedGET /team/{team_key}/years_participated
TeamApigetTeamsGET /teams/{page_num}
TeamApigetTeamsByYearGET /teams/{year}/{page_num}
TeamApigetTeamsByYearKeysGET /teams/{year}/{page_num}/keys
TeamApigetTeamsByYearSimpleGET /teams/{year}/{page_num}/simple
TeamApigetTeamsKeysGET /teams/{page_num}/keys
TeamApigetTeamsSimpleGET /teams/{page_num}/simple

Documentation For Models

Documentation For Authorization

apiKey

  • Type: API key
  • API key parameter name: X-TBA-Auth-Key
  • Location: HTTP header

Author

Libraries

tba_api_client.api