TeamApi.md

TbaApiV3client.TeamApi

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

[DistrictRanking] getDistrictRankings(districtKey, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let districtKey = "districtKey_example"; // String | TBA District Key, eg `2016fim`
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getDistrictRankings(districtKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

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

Return type

[DistrictRanking]

Authorization

apiKey

HTTP request headers

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

getDistrictTeams

[Team] getDistrictTeams(districtKey, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let districtKey = "districtKey_example"; // String | TBA District Key, eg `2016fim`
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getDistrictTeams(districtKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
districtKey	String	TBA District Key, eg `2016fim`
ifModifiedSince	String	Value of the `Last-Modified` 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

getDistrictTeamsKeys

[String] getDistrictTeamsKeys(districtKey, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let districtKey = "districtKey_example"; // String | TBA District Key, eg `2016fim`
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getDistrictTeamsKeys(districtKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

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

Return type

[String]

Authorization

apiKey

HTTP request headers

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

getDistrictTeamsSimple

[TeamSimple] getDistrictTeamsSimple(districtKey, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let districtKey = "districtKey_example"; // String | TBA District Key, eg `2016fim`
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getDistrictTeamsSimple(districtKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
districtKey	String	TBA District Key, eg `2016fim`
ifModifiedSince	String	Value of the `Last-Modified` 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

getEventTeams

[Team] getEventTeams(eventKey, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let eventKey = "eventKey_example"; // String | TBA Event Key, eg `2016nytr`
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getEventTeams(eventKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
eventKey	String	TBA Event Key, eg `2016nytr`
ifModifiedSince	String	Value of the `Last-Modified` 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

getEventTeamsKeys

[String] getEventTeamsKeys(eventKey, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let eventKey = "eventKey_example"; // String | TBA Event Key, eg `2016nytr`
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getEventTeamsKeys(eventKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

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

Return type

[String]

Authorization

apiKey

HTTP request headers

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

getEventTeamsSimple

[TeamSimple] getEventTeamsSimple(eventKey, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let eventKey = "eventKey_example"; // String | TBA Event Key, eg `2016nytr`
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getEventTeamsSimple(eventKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
eventKey	String	TBA Event Key, eg `2016nytr`
ifModifiedSince	String	Value of the `Last-Modified` 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

getEventTeamsStatuses

{String: TeamEventStatus} getEventTeamsStatuses(eventKey, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let eventKey = "eventKey_example"; // String | TBA Event Key, eg `2016nytr`
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getEventTeamsStatuses(eventKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

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

Return type

{String: TeamEventStatus}

Authorization

apiKey

HTTP request headers

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

getTeam

Team getTeam(teamKey, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeam(teamKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg `frc254`
ifModifiedSince	String	Value of the `Last-Modified` 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

getTeamAwards

[Award] getTeamAwards(teamKey, opts)

Gets a list of awards the given team has won.

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeamAwards(teamKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg `frc254`
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

[Award]

Authorization

apiKey

HTTP request headers

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

getTeamAwardsByYear

[Award] getTeamAwardsByYear(teamKey, year, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
let year = 56; // Number | Competition Year (or Season). Must be 4 digits.
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeamAwardsByYear(teamKey, year, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

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

Return type

[Award]

Authorization

apiKey

HTTP request headers

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

getTeamDistricts

[DistrictList] getTeamDistricts(teamKey, opts)

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 TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeamDistricts(teamKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg `frc254`
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

[DistrictList]

Authorization

apiKey

HTTP request headers

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

getTeamEventAwards

[Award] getTeamEventAwards(teamKey, eventKey, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
let eventKey = "eventKey_example"; // String | TBA Event Key, eg `2016nytr`
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeamEventAwards(teamKey, eventKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

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

Return type

[Award]

Authorization

apiKey

HTTP request headers

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

getTeamEventMatches

[Match] getTeamEventMatches(teamKey, eventKey, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
let eventKey = "eventKey_example"; // String | TBA Event Key, eg `2016nytr`
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeamEventMatches(teamKey, eventKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

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

Return type

[Match]

Authorization

apiKey

HTTP request headers

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

getTeamEventMatchesKeys

[String] getTeamEventMatchesKeys(teamKey, eventKey, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
let eventKey = "eventKey_example"; // String | TBA Event Key, eg `2016nytr`
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeamEventMatchesKeys(teamKey, eventKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

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

Return type

[String]

Authorization

apiKey

HTTP request headers

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

getTeamEventMatchesSimple

[Match] getTeamEventMatchesSimple(teamKey, eventKey, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
let eventKey = "eventKey_example"; // String | TBA Event Key, eg `2016nytr`
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeamEventMatchesSimple(teamKey, eventKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

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

Return type

[Match]

Authorization

apiKey

HTTP request headers

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

getTeamEventStatus

TeamEventStatus getTeamEventStatus(teamKey, eventKey, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
let eventKey = "eventKey_example"; // String | TBA Event Key, eg `2016nytr`
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeamEventStatus(teamKey, eventKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg `frc254`
eventKey	String	TBA Event Key, eg `2016nytr`
ifModifiedSince	String	Value of the `Last-Modified` 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

getTeamEvents

[Event] getTeamEvents(teamKey, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeamEvents(teamKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg `frc254`
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

[Event]

Authorization

apiKey

HTTP request headers

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

getTeamEventsByYear

[Event] getTeamEventsByYear(teamKey, year, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
let year = 56; // Number | Competition Year (or Season). Must be 4 digits.
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeamEventsByYear(teamKey, year, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

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

Return type

[Event]

Authorization

apiKey

HTTP request headers

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

getTeamEventsByYearKeys

[String] getTeamEventsByYearKeys(teamKey, year, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
let year = 56; // Number | Competition Year (or Season). Must be 4 digits.
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeamEventsByYearKeys(teamKey, year, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

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

Return type

[String]

Authorization

apiKey

HTTP request headers

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

getTeamEventsByYearSimple

[EventSimple] getTeamEventsByYearSimple(teamKey, year, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
let year = 56; // Number | Competition Year (or Season). Must be 4 digits.
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeamEventsByYearSimple(teamKey, year, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

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

Return type

[EventSimple]

Authorization

apiKey

HTTP request headers

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

getTeamEventsKeys

[String] getTeamEventsKeys(teamKey, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeamEventsKeys(teamKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg `frc254`
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

[String]

Authorization

apiKey

HTTP request headers

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

getTeamEventsSimple

[EventSimple] getTeamEventsSimple(teamKey, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeamEventsSimple(teamKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg `frc254`
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

[EventSimple]

Authorization

apiKey

HTTP request headers

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

getTeamEventsStatusesByYear

{String: TeamEventStatus} getTeamEventsStatusesByYear(teamKey, year, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
let year = 56; // Number | Competition Year (or Season). Must be 4 digits.
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeamEventsStatusesByYear(teamKey, year, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

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

Return type

{String: TeamEventStatus}

Authorization

apiKey

HTTP request headers

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

getTeamMatchesByYear

[Match] getTeamMatchesByYear(teamKey, year, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
let year = 56; // Number | Competition Year (or Season). Must be 4 digits.
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeamMatchesByYear(teamKey, year, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

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

Return type

[Match]

Authorization

apiKey

HTTP request headers

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

getTeamMatchesByYearKeys

[String] getTeamMatchesByYearKeys(teamKey, year, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
let year = 56; // Number | Competition Year (or Season). Must be 4 digits.
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeamMatchesByYearKeys(teamKey, year, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

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

Return type

[String]

Authorization

apiKey

HTTP request headers

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

getTeamMatchesByYearSimple

[MatchSimple] getTeamMatchesByYearSimple(teamKey, year, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
let year = 56; // Number | Competition Year (or Season). Must be 4 digits.
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeamMatchesByYearSimple(teamKey, year, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

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

Return type

[MatchSimple]

Authorization

apiKey

HTTP request headers

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

getTeamMediaByTag

[Media] getTeamMediaByTag(teamKey, mediaTag, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
let mediaTag = "mediaTag_example"; // String | Media Tag which describes the Media.
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeamMediaByTag(teamKey, mediaTag, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

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

Return type

[Media]

Authorization

apiKey

HTTP request headers

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

getTeamMediaByTagYear

[Media] getTeamMediaByTagYear(teamKey, mediaTag, year, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
let mediaTag = "mediaTag_example"; // String | Media Tag which describes the Media.
let year = 56; // Number | Competition Year (or Season). Must be 4 digits.
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeamMediaByTagYear(teamKey, mediaTag, year, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

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

Return type

[Media]

Authorization

apiKey

HTTP request headers

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

getTeamMediaByYear

[Media] getTeamMediaByYear(teamKey, year, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
let year = 56; // Number | Competition Year (or Season). Must be 4 digits.
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeamMediaByYear(teamKey, year, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

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

Return type

[Media]

Authorization

apiKey

HTTP request headers

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

getTeamRobots

[TeamRobot] getTeamRobots(teamKey, opts)

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 TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeamRobots(teamKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg `frc254`
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

[TeamRobot]

Authorization

apiKey

HTTP request headers

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

getTeamSimple

TeamSimple getTeamSimple(teamKey, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeamSimple(teamKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg `frc254`
ifModifiedSince	String	Value of the `Last-Modified` 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

getTeamSocialMedia

[Media] getTeamSocialMedia(teamKey, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeamSocialMedia(teamKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg `frc254`
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

[Media]

Authorization

apiKey

HTTP request headers

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

getTeamYearsParticipated

[Number] getTeamYearsParticipated(teamKey, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let teamKey = "teamKey_example"; // String | TBA Team Key, eg `frc254`
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeamYearsParticipated(teamKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
teamKey	String	TBA Team Key, eg `frc254`
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

[Number]

Authorization

apiKey

HTTP request headers

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

getTeams

[Team] getTeams(pageNum, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let pageNum = 56; // Number | Page number of results to return, zero-indexed
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeams(pageNum, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
pageNum	Number	Page number of results to return, zero-indexed
ifModifiedSince	String	Value of the `Last-Modified` 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

getTeamsByYear

[Team] getTeamsByYear(year, pageNum, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let year = 56; // Number | Competition Year (or Season). Must be 4 digits.
let pageNum = 56; // Number | Page number of results to return, zero-indexed
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeamsByYear(year, pageNum, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
year	Number	Competition Year (or Season). Must be 4 digits.
pageNum	Number	Page number of results to return, zero-indexed
ifModifiedSince	String	Value of the `Last-Modified` 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

getTeamsByYearKeys

[String] getTeamsByYearKeys(year, pageNum, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let year = 56; // Number | Competition Year (or Season). Must be 4 digits.
let pageNum = 56; // Number | Page number of results to return, zero-indexed
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeamsByYearKeys(year, pageNum, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

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

Return type

[String]

Authorization

apiKey

HTTP request headers

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

getTeamsByYearSimple

[TeamSimple] getTeamsByYearSimple(year, pageNum, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let year = 56; // Number | Competition Year (or Season). Must be 4 digits.
let pageNum = 56; // Number | Page number of results to return, zero-indexed
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeamsByYearSimple(year, pageNum, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
year	Number	Competition Year (or Season). Must be 4 digits.
pageNum	Number	Page number of results to return, zero-indexed
ifModifiedSince	String	Value of the `Last-Modified` 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

getTeamsKeys

[String] getTeamsKeys(pageNum, opts)

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 TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let pageNum = 56; // Number | Page number of results to return, zero-indexed
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeamsKeys(pageNum, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
pageNum	Number	Page number of results to return, zero-indexed
ifModifiedSince	String	Value of the `Last-Modified` header in the most recently cached response by the client.	[optional]

Return type

[String]

Authorization

apiKey

HTTP request headers

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

getTeamsSimple

[TeamSimple] getTeamsSimple(pageNum, opts)

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

Example

import TbaApiV3client from 'tba-api-v3client';
let defaultClient = TbaApiV3client.ApiClient.instance;
// Configure API key authorization: apiKey
let apiKey = defaultClient.authentications['apiKey'];
apiKey.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apiKey.apiKeyPrefix = 'Token';

let apiInstance = new TbaApiV3client.TeamApi();
let pageNum = 56; // Number | Page number of results to return, zero-indexed
let opts = {
  'ifModifiedSince': "ifModifiedSince_example" // String | Value of the `Last-Modified` header in the most recently cached response by the client.
};
apiInstance.getTeamsSimple(pageNum, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name	Type	Description	Notes
pageNum	Number	Page number of results to return, zero-indexed
ifModifiedSince	String	Value of the `Last-Modified` 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