Swift4 API client for TBAAPIv3Kit

Overview

Information and statistics about FIRST Robotics Competition teams and events.

Authentication

All endpoints require an Auth Key to be passed in the header X-TBA-Auth-Key. If you do not have an auth key yet, you can obtain one from your Account Page.

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

Overview

This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.

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

Installation

Carthage

Run carthage update

CocoaPods

Run pod install

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
DistrictAPI	getDistrictEvents	GET /district/{district_key}/events
DistrictAPI	getDistrictEventsKeys	GET /district/{district_key}/events/keys
DistrictAPI	getDistrictEventsSimple	GET /district/{district_key}/events/simple
DistrictAPI	getDistrictRankings	GET /district/{district_key}/rankings
DistrictAPI	getDistrictTeams	GET /district/{district_key}/teams
DistrictAPI	getDistrictTeamsKeys	GET /district/{district_key}/teams/keys
DistrictAPI	getDistrictTeamsSimple	GET /district/{district_key}/teams/simple
DistrictAPI	getDistrictsByYear	GET /districts/{year}
DistrictAPI	getEventDistrictPoints	GET /event/{event_key}/district_points
DistrictAPI	getTeamDistricts	GET /team/{team_key}/districts
EventAPI	getDistrictEvents	GET /district/{district_key}/events
EventAPI	getDistrictEventsKeys	GET /district/{district_key}/events/keys
EventAPI	getDistrictEventsSimple	GET /district/{district_key}/events/simple
EventAPI	getEvent	GET /event/{event_key}
EventAPI	getEventAlliances	GET /event/{event_key}/alliances
EventAPI	getEventAwards	GET /event/{event_key}/awards
EventAPI	getEventDistrictPoints	GET /event/{event_key}/district_points
EventAPI	getEventInsights	GET /event/{event_key}/insights
EventAPI	getEventMatchTimeseries	GET /event/{event_key}/matches/timeseries
EventAPI	getEventMatches	GET /event/{event_key}/matches
EventAPI	getEventMatchesKeys	GET /event/{event_key}/matches/keys
EventAPI	getEventMatchesSimple	GET /event/{event_key}/matches/simple
EventAPI	getEventOPRs	GET /event/{event_key}/oprs
EventAPI	getEventPredictions	GET /event/{event_key}/predictions
EventAPI	getEventRankings	GET /event/{event_key}/rankings
EventAPI	getEventSimple	GET /event/{event_key}/simple
EventAPI	getEventTeams	GET /event/{event_key}/teams
EventAPI	getEventTeamsKeys	GET /event/{event_key}/teams/keys
EventAPI	getEventTeamsSimple	GET /event/{event_key}/teams/simple
EventAPI	getEventTeamsStatuses	GET /event/{event_key}/teams/statuses
EventAPI	getEventsByYear	GET /events/{year}
EventAPI	getEventsByYearKeys	GET /events/{year}/keys
EventAPI	getEventsByYearSimple	GET /events/{year}/simple
EventAPI	getTeamEventAwards	GET /team/{team_key}/event/{event_key}/awards
EventAPI	getTeamEventMatches	GET /team/{team_key}/event/{event_key}/matches
EventAPI	getTeamEventMatchesKeys	GET /team/{team_key}/event/{event_key}/matches/keys
EventAPI	getTeamEventMatchesSimple	GET /team/{team_key}/event/{event_key}/matches/simple
EventAPI	getTeamEventStatus	GET /team/{team_key}/event/{event_key}/status
EventAPI	getTeamEvents	GET /team/{team_key}/events
EventAPI	getTeamEventsByYear	GET /team/{team_key}/events/{year}
EventAPI	getTeamEventsByYearKeys	GET /team/{team_key}/events/{year}/keys
EventAPI	getTeamEventsByYearSimple	GET /team/{team_key}/events/{year}/simple
EventAPI	getTeamEventsKeys	GET /team/{team_key}/events/keys
EventAPI	getTeamEventsSimple	GET /team/{team_key}/events/simple
EventAPI	getTeamEventsStatusesByYear	GET /team/{team_key}/events/{year}/statuses
ListAPI	getDistrictEvents	GET /district/{district_key}/events
ListAPI	getDistrictEventsKeys	GET /district/{district_key}/events/keys
ListAPI	getDistrictEventsSimple	GET /district/{district_key}/events/simple
ListAPI	getDistrictRankings	GET /district/{district_key}/rankings
ListAPI	getDistrictTeams	GET /district/{district_key}/teams
ListAPI	getDistrictTeamsKeys	GET /district/{district_key}/teams/keys
ListAPI	getDistrictTeamsSimple	GET /district/{district_key}/teams/simple
ListAPI	getEventTeams	GET /event/{event_key}/teams
ListAPI	getEventTeamsKeys	GET /event/{event_key}/teams/keys
ListAPI	getEventTeamsSimple	GET /event/{event_key}/teams/simple
ListAPI	getEventTeamsStatuses	GET /event/{event_key}/teams/statuses
ListAPI	getEventsByYear	GET /events/{year}
ListAPI	getEventsByYearKeys	GET /events/{year}/keys
ListAPI	getEventsByYearSimple	GET /events/{year}/simple
ListAPI	getTeamEventsStatusesByYear	GET /team/{team_key}/events/{year}/statuses
ListAPI	getTeams	GET /teams/{page_num}
ListAPI	getTeamsByYear	GET /teams/{year}/{page_num}
ListAPI	getTeamsByYearKeys	GET /teams/{year}/{page_num}/keys
ListAPI	getTeamsByYearSimple	GET /teams/{year}/{page_num}/simple
ListAPI	getTeamsKeys	GET /teams/{page_num}/keys
ListAPI	getTeamsSimple	GET /teams/{page_num}/simple
MatchAPI	getEventMatchTimeseries	GET /event/{event_key}/matches/timeseries
MatchAPI	getEventMatches	GET /event/{event_key}/matches
MatchAPI	getEventMatchesKeys	GET /event/{event_key}/matches/keys
MatchAPI	getEventMatchesSimple	GET /event/{event_key}/matches/simple
MatchAPI	getMatch	GET /match/{match_key}
MatchAPI	getMatchSimple	GET /match/{match_key}/simple
MatchAPI	getMatchTimeseries	GET /match/{match_key}/timeseries
MatchAPI	getMatchZebra	GET /match/{match_key}/zebra_motionworks
MatchAPI	getTeamEventMatches	GET /team/{team_key}/event/{event_key}/matches
MatchAPI	getTeamEventMatchesKeys	GET /team/{team_key}/event/{event_key}/matches/keys
MatchAPI	getTeamEventMatchesSimple	GET /team/{team_key}/event/{event_key}/matches/simple
MatchAPI	getTeamMatchesByYear	GET /team/{team_key}/matches/{year}
MatchAPI	getTeamMatchesByYearKeys	GET /team/{team_key}/matches/{year}/keys
MatchAPI	getTeamMatchesByYearSimple	GET /team/{team_key}/matches/{year}/simple
TBAAPI	getStatus	GET /status
TeamAPI	getDistrictRankings	GET /district/{district_key}/rankings
TeamAPI	getDistrictTeams	GET /district/{district_key}/teams
TeamAPI	getDistrictTeamsKeys	GET /district/{district_key}/teams/keys
TeamAPI	getDistrictTeamsSimple	GET /district/{district_key}/teams/simple
TeamAPI	getEventTeams	GET /event/{event_key}/teams
TeamAPI	getEventTeamsKeys	GET /event/{event_key}/teams/keys
TeamAPI	getEventTeamsSimple	GET /event/{event_key}/teams/simple
TeamAPI	getEventTeamsStatuses	GET /event/{event_key}/teams/statuses
TeamAPI	getTeam	GET /team/{team_key}
TeamAPI	getTeamAwards	GET /team/{team_key}/awards
TeamAPI	getTeamAwardsByYear	GET /team/{team_key}/awards/{year}
TeamAPI	getTeamDistricts	GET /team/{team_key}/districts
TeamAPI	getTeamEventAwards	GET /team/{team_key}/event/{event_key}/awards
TeamAPI	getTeamEventMatches	GET /team/{team_key}/event/{event_key}/matches
TeamAPI	getTeamEventMatchesKeys	GET /team/{team_key}/event/{event_key}/matches/keys
TeamAPI	getTeamEventMatchesSimple	GET /team/{team_key}/event/{event_key}/matches/simple
TeamAPI	getTeamEventStatus	GET /team/{team_key}/event/{event_key}/status
TeamAPI	getTeamEvents	GET /team/{team_key}/events
TeamAPI	getTeamEventsByYear	GET /team/{team_key}/events/{year}
TeamAPI	getTeamEventsByYearKeys	GET /team/{team_key}/events/{year}/keys
TeamAPI	getTeamEventsByYearSimple	GET /team/{team_key}/events/{year}/simple
TeamAPI	getTeamEventsKeys	GET /team/{team_key}/events/keys
TeamAPI	getTeamEventsSimple	GET /team/{team_key}/events/simple
TeamAPI	getTeamEventsStatusesByYear	GET /team/{team_key}/events/{year}/statuses
TeamAPI	getTeamMatchesByYear	GET /team/{team_key}/matches/{year}
TeamAPI	getTeamMatchesByYearKeys	GET /team/{team_key}/matches/{year}/keys
TeamAPI	getTeamMatchesByYearSimple	GET /team/{team_key}/matches/{year}/simple
TeamAPI	getTeamMediaByTag	GET /team/{team_key}/media/tag/{media_tag}
TeamAPI	getTeamMediaByTagYear	GET /team/{team_key}/media/tag/{media_tag}/{year}
TeamAPI	getTeamMediaByYear	GET /team/{team_key}/media/{year}
TeamAPI	getTeamRobots	GET /team/{team_key}/robots
TeamAPI	getTeamSimple	GET /team/{team_key}/simple
TeamAPI	getTeamSocialMedia	GET /team/{team_key}/social_media
TeamAPI	getTeamYearsParticipated	GET /team/{team_key}/years_participated
TeamAPI	getTeams	GET /teams/{page_num}
TeamAPI	getTeamsByYear	GET /teams/{year}/{page_num}
TeamAPI	getTeamsByYearKeys	GET /teams/{year}/{page_num}/keys
TeamAPI	getTeamsByYearSimple	GET /teams/{year}/{page_num}/simple
TeamAPI	getTeamsKeys	GET /teams/{page_num}/keys
TeamAPI	getTeamsSimple	GET /teams/{page_num}/simple

Documentation For Models

• APIStatus
• APIStatusAppVersion
• Award
• AwardRecipient
• DistrictList
• DistrictRanking
• DistrictRankingEventPoints
• EliminationAlliance
• EliminationAllianceBackup
• EliminationAllianceStatus
• Event
• EventDistrictPoints
• EventDistrictPointsPoints
• EventDistrictPointsTiebreakers
• EventInsights
• EventInsights2016
• EventInsights2017
• EventInsights2018
• EventOPRs
• EventRanking
• EventRankingExtraStatsInfo
• EventRankingRankings
• EventRankingSortOrderInfo
• EventSimple
• Match
• MatchAlliance
• MatchScoreBreakdown2015
• MatchScoreBreakdown2015Alliance
• MatchScoreBreakdown2016
• MatchScoreBreakdown2016Alliance
• MatchScoreBreakdown2017
• MatchScoreBreakdown2017Alliance
• MatchScoreBreakdown2018
• MatchScoreBreakdown2018Alliance
• MatchScoreBreakdown2019
• MatchScoreBreakdown2019Alliance
• MatchScoreBreakdown2020
• MatchScoreBreakdown2020Alliance
• MatchSimple
• MatchSimpleAlliances
• MatchTimeseries2018
• MatchVideos
• Media
• Team
• TeamEventStatus
• TeamEventStatusAlliance
• TeamEventStatusAllianceBackup
• TeamEventStatusPlayoff
• TeamEventStatusRank
• TeamEventStatusRankRanking
• TeamEventStatusRankSortOrderInfo
• TeamRobot
• TeamSimple
• WLTRecord
• Webcast
• Zebra
• ZebraAlliances
• ZebraTeam

Documentation For Authorization

apiKey

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

Author