TeamApi.md

tba_api_v3.api.TeamApi

Load the API package

import 'package:tba_api_v3/api.dart';

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

Method	HTTP request	Description
getDistrictRankings	GET /district/{district_key}/rankings
getDistrictTeams	GET /district/{district_key}/teams
getDistrictTeamsKeys	GET /district/{district_key}/teams/keys
getDistrictTeamsSimple	GET /district/{district_key}/teams/simple
getEventTeams	GET /event/{event_key}/teams
getEventTeamsKeys	GET /event/{event_key}/teams/keys
getEventTeamsSimple	GET /event/{event_key}/teams/simple
getEventTeamsStatuses	GET /event/{event_key}/teams/statuses
getTeam	GET /team/{team_key}
getTeamAwards	GET /team/{team_key}/awards
getTeamAwardsByYear	GET /team/{team_key}/awards/{year}
getTeamDistricts	GET /team/{team_key}/districts
getTeamEventAwards	GET /team/{team_key}/event/{event_key}/awards
getTeamEventMatches	GET /team/{team_key}/event/{event_key}/matches
getTeamEventMatchesKeys	GET /team/{team_key}/event/{event_key}/matches/keys
getTeamEventMatchesSimple	GET /team/{team_key}/event/{event_key}/matches/simple
getTeamEventStatus	GET /team/{team_key}/event/{event_key}/status
getTeamEvents	GET /team/{team_key}/events
getTeamEventsByYear	GET /team/{team_key}/events/{year}
getTeamEventsByYearKeys	GET /team/{team_key}/events/{year}/keys
getTeamEventsByYearSimple	GET /team/{team_key}/events/{year}/simple
getTeamEventsKeys	GET /team/{team_key}/events/keys
getTeamEventsSimple	GET /team/{team_key}/events/simple
getTeamEventsStatusesByYear	GET /team/{team_key}/events/{year}/statuses
getTeamMatchesByYear	GET /team/{team_key}/matches/{year}
getTeamMatchesByYearKeys	GET /team/{team_key}/matches/{year}/keys
getTeamMatchesByYearSimple	GET /team/{team_key}/matches/{year}/simple
getTeamMediaByTag	GET /team/{team_key}/media/tag/{media_tag}
getTeamMediaByTagYear	GET /team/{team_key}/media/tag/{media_tag}/{year}
getTeamMediaByYear	GET /team/{team_key}/media/{year}
getTeamRobots	GET /team/{team_key}/robots
getTeamSimple	GET /team/{team_key}/simple
getTeamSocialMedia	GET /team/{team_key}/social_media
getTeamYearsParticipated	GET /team/{team_key}/years_participated
getTeams	GET /teams/{page_num}
getTeamsByYear	GET /teams/{year}/{page_num}
getTeamsByYearKeys	GET /teams/{year}/{page_num}/keys
getTeamsByYearSimple	GET /teams/{year}/{page_num}/simple
getTeamsKeys	GET /teams/{page_num}/keys
getTeamsSimple	GET /teams/{page_num}/simple

getDistrictRankings

BuiltList getDistrictRankings(districtKey, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String districtKey = districtKey_example; // String | TBA District Key, eg `2016fim`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getDistrictRankings(districtKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getDistrictRankings: $e\n');
}

Parameters

Name	Type	Description	Notes
districtKey	String	TBA District Key, eg 2016fim
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<DistrictRanking>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getDistrictTeams

BuiltList getDistrictTeams(districtKey, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String districtKey = districtKey_example; // String | TBA District Key, eg `2016fim`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getDistrictTeams(districtKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getDistrictTeams: $e\n');
}

Parameters

Name	Type	Description	Notes
districtKey	String	TBA District Key, eg 2016fim
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<Team>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getDistrictTeamsKeys

BuiltList getDistrictTeamsKeys(districtKey, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String districtKey = districtKey_example; // String | TBA District Key, eg `2016fim`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getDistrictTeamsKeys(districtKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getDistrictTeamsKeys: $e\n');
}

Parameters

Name	Type	Description	Notes
districtKey	String	TBA District Key, eg 2016fim
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<String>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getDistrictTeamsSimple

BuiltList getDistrictTeamsSimple(districtKey, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String districtKey = districtKey_example; // String | TBA District Key, eg `2016fim`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getDistrictTeamsSimple(districtKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getDistrictTeamsSimple: $e\n');
}

Parameters

Name	Type	Description	Notes
districtKey	String	TBA District Key, eg 2016fim
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<TeamSimple>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEventTeams

BuiltList getEventTeams(eventKey, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getEventTeams(eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getEventTeams: $e\n');
}

Parameters

Name	Type	Description	Notes
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<Team>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEventTeamsKeys

BuiltList getEventTeamsKeys(eventKey, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getEventTeamsKeys(eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getEventTeamsKeys: $e\n');
}

Parameters

Name	Type	Description	Notes
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<String>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEventTeamsSimple

BuiltList getEventTeamsSimple(eventKey, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getEventTeamsSimple(eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getEventTeamsSimple: $e\n');
}

Parameters

Name	Type	Description	Notes
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<TeamSimple>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEventTeamsStatuses

BuiltMap<String, TeamEventStatus> getEventTeamsStatuses(eventKey, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getEventTeamsStatuses(eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getEventTeamsStatuses: $e\n');
}

Parameters

Name	Type	Description	Notes
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltMap<String, TeamEventStatus>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeam

Team getTeam(teamKey, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeam(teamKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeam: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

Team

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamAwards

BuiltList getTeamAwards(teamKey, ifNoneMatch)

Gets a list of awards the given team has won.

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamAwards(teamKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeamAwards: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<Award>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamAwardsByYear

BuiltList getTeamAwardsByYear(teamKey, year, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final int year = 56; // int | Competition Year (or Season). Must be 4 digits.
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamAwardsByYear(teamKey, year, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeamAwardsByYear: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
year	int	Competition Year (or Season). Must be 4 digits.
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<Award>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamDistricts

BuiltList getTeamDistricts(teamKey, ifNoneMatch)

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.

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamDistricts(teamKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeamDistricts: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<DistrictList>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamEventAwards

BuiltList getTeamEventAwards(teamKey, eventKey, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamEventAwards(teamKey, eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeamEventAwards: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<Award>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamEventMatches

BuiltList getTeamEventMatches(teamKey, eventKey, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamEventMatches(teamKey, eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeamEventMatches: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<Match>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamEventMatchesKeys

BuiltList getTeamEventMatchesKeys(teamKey, eventKey, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamEventMatchesKeys(teamKey, eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeamEventMatchesKeys: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<String>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamEventMatchesSimple

BuiltList getTeamEventMatchesSimple(teamKey, eventKey, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamEventMatchesSimple(teamKey, eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeamEventMatchesSimple: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<Match>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamEventStatus

TeamEventStatus getTeamEventStatus(teamKey, eventKey, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final String eventKey = eventKey_example; // String | TBA Event Key, eg `2016nytr`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamEventStatus(teamKey, eventKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeamEventStatus: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
eventKey	String	TBA Event Key, eg 2016nytr
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

TeamEventStatus

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamEvents

BuiltList getTeamEvents(teamKey, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamEvents(teamKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeamEvents: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<Event>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamEventsByYear

BuiltList getTeamEventsByYear(teamKey, year, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final int year = 56; // int | Competition Year (or Season). Must be 4 digits.
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamEventsByYear(teamKey, year, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeamEventsByYear: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
year	int	Competition Year (or Season). Must be 4 digits.
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<Event>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamEventsByYearKeys

BuiltList getTeamEventsByYearKeys(teamKey, year, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final int year = 56; // int | Competition Year (or Season). Must be 4 digits.
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamEventsByYearKeys(teamKey, year, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeamEventsByYearKeys: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
year	int	Competition Year (or Season). Must be 4 digits.
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<String>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamEventsByYearSimple

BuiltList getTeamEventsByYearSimple(teamKey, year, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final int year = 56; // int | Competition Year (or Season). Must be 4 digits.
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamEventsByYearSimple(teamKey, year, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeamEventsByYearSimple: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
year	int	Competition Year (or Season). Must be 4 digits.
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<EventSimple>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamEventsKeys

BuiltList getTeamEventsKeys(teamKey, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamEventsKeys(teamKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeamEventsKeys: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<String>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamEventsSimple

BuiltList getTeamEventsSimple(teamKey, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamEventsSimple(teamKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeamEventsSimple: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<EventSimple>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamEventsStatusesByYear

BuiltMap<String, TeamEventStatus> getTeamEventsStatusesByYear(teamKey, year, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final int year = 56; // int | Competition Year (or Season). Must be 4 digits.
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamEventsStatusesByYear(teamKey, year, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeamEventsStatusesByYear: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
year	int	Competition Year (or Season). Must be 4 digits.
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltMap<String, TeamEventStatus>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamMatchesByYear

BuiltList getTeamMatchesByYear(teamKey, year, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final int year = 56; // int | Competition Year (or Season). Must be 4 digits.
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamMatchesByYear(teamKey, year, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeamMatchesByYear: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
year	int	Competition Year (or Season). Must be 4 digits.
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<Match>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamMatchesByYearKeys

BuiltList getTeamMatchesByYearKeys(teamKey, year, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final int year = 56; // int | Competition Year (or Season). Must be 4 digits.
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamMatchesByYearKeys(teamKey, year, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeamMatchesByYearKeys: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
year	int	Competition Year (or Season). Must be 4 digits.
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<String>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamMatchesByYearSimple

BuiltList getTeamMatchesByYearSimple(teamKey, year, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final int year = 56; // int | Competition Year (or Season). Must be 4 digits.
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamMatchesByYearSimple(teamKey, year, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeamMatchesByYearSimple: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
year	int	Competition Year (or Season). Must be 4 digits.
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<MatchSimple>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamMediaByTag

BuiltList getTeamMediaByTag(teamKey, mediaTag, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final String mediaTag = mediaTag_example; // String | Media Tag which describes the Media.
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamMediaByTag(teamKey, mediaTag, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeamMediaByTag: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
mediaTag	String	Media Tag which describes the Media.
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<Media>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamMediaByTagYear

BuiltList getTeamMediaByTagYear(teamKey, mediaTag, year, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final String mediaTag = mediaTag_example; // String | Media Tag which describes the Media.
final int year = 56; // int | Competition Year (or Season). Must be 4 digits.
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamMediaByTagYear(teamKey, mediaTag, year, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeamMediaByTagYear: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
mediaTag	String	Media Tag which describes the Media.
year	int	Competition Year (or Season). Must be 4 digits.
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<Media>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamMediaByYear

BuiltList getTeamMediaByYear(teamKey, year, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final int year = 56; // int | Competition Year (or Season). Must be 4 digits.
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamMediaByYear(teamKey, year, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeamMediaByYear: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
year	int	Competition Year (or Season). Must be 4 digits.
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<Media>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamRobots

BuiltList getTeamRobots(teamKey, ifNoneMatch)

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.

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamRobots(teamKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeamRobots: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<TeamRobot>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamSimple

TeamSimple getTeamSimple(teamKey, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamSimple(teamKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeamSimple: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

TeamSimple

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamSocialMedia

BuiltList getTeamSocialMedia(teamKey, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamSocialMedia(teamKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeamSocialMedia: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<Media>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamYearsParticipated

BuiltList getTeamYearsParticipated(teamKey, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final String teamKey = teamKey_example; // String | TBA Team Key, eg `frc254`
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamYearsParticipated(teamKey, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeamYearsParticipated: $e\n');
}

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg frc254
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<int>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeams

BuiltList getTeams(pageNum, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final int pageNum = 56; // int | Page number of results to return, zero-indexed
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeams(pageNum, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeams: $e\n');
}

Parameters

Name	Type	Description	Notes
pageNum	int	Page number of results to return, zero-indexed
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<Team>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamsByYear

BuiltList getTeamsByYear(year, pageNum, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final int year = 56; // int | Competition Year (or Season). Must be 4 digits.
final int pageNum = 56; // int | Page number of results to return, zero-indexed
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamsByYear(year, pageNum, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeamsByYear: $e\n');
}

Parameters

Name	Type	Description	Notes
year	int	Competition Year (or Season). Must be 4 digits.
pageNum	int	Page number of results to return, zero-indexed
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<Team>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamsByYearKeys

BuiltList getTeamsByYearKeys(year, pageNum, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final int year = 56; // int | Competition Year (or Season). Must be 4 digits.
final int pageNum = 56; // int | Page number of results to return, zero-indexed
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamsByYearKeys(year, pageNum, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeamsByYearKeys: $e\n');
}

Parameters

Name	Type	Description	Notes
year	int	Competition Year (or Season). Must be 4 digits.
pageNum	int	Page number of results to return, zero-indexed
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<String>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamsByYearSimple

BuiltList getTeamsByYearSimple(year, pageNum, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final int year = 56; // int | Competition Year (or Season). Must be 4 digits.
final int pageNum = 56; // int | Page number of results to return, zero-indexed
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamsByYearSimple(year, pageNum, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeamsByYearSimple: $e\n');
}

Parameters

Name	Type	Description	Notes
year	int	Competition Year (or Season). Must be 4 digits.
pageNum	int	Page number of results to return, zero-indexed
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<TeamSimple>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamsKeys

BuiltList getTeamsKeys(pageNum, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final int pageNum = 56; // int | Page number of results to return, zero-indexed
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamsKeys(pageNum, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeamsKeys: $e\n');
}

Parameters

Name	Type	Description	Notes
pageNum	int	Page number of results to return, zero-indexed
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<String>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getTeamsSimple

BuiltList getTeamsSimple(pageNum, ifNoneMatch)

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

Example

import 'package:tba_api_v3/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';

final api = TbaApiV3().getTeamApi();
final int pageNum = 56; // int | Page number of results to return, zero-indexed
final String ifNoneMatch = ifNoneMatch_example; // String | Value of the `ETag` header in the most recently cached response by the client.

try {
    final response = api.getTeamsSimple(pageNum, ifNoneMatch);
    print(response);
} catch on DioException (e) {
    print('Exception when calling TeamApi->getTeamsSimple: $e\n');
}

Parameters

Name	Type	Description	Notes
pageNum	int	Page number of results to return, zero-indexed
ifNoneMatch	String	Value of the ETag header in the most recently cached response by the client.	[optional]

Return type

BuiltList<TeamSimple>

Authorization

apiKey

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]