Information and statistics about FIRST Robotics Competition teams and events.
All endpoints require an Auth Key to be passed in the header X-TBA-Auth-Key
. If you do not have an auth key yet, you can obtain one from your Account Page.
A User-Agent
header may need to be set to prevent a 403 Unauthorized error.
This PHP package is automatically generated by the OpenAPI Generator project:
- API version: 3.8.0
- Build package: org.openapitools.codegen.languages.PhpClientCodegen
PHP 7.3 and later
To install the bindings via Composer, add the following to composer.json
:
{
"repositories": [
{
"type": "vcs",
"url": "https://github.com/tba-api/tba-api-client-php.git"
}
],
"require": {
"tba-api/tba-api-client-php": "*@dev"
}
}
Then run composer install
Download the files and include autoload.php
:
require_once('/path/to/TBA-API-v3client/vendor/autoload.php');
To run the unit tests:
composer install
./vendor/bin/phpunit
Please follow the installation procedure and then run the following:
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: apiKey
$config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKey('X-TBA-Auth-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = TBAAPI\v3client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-TBA-Auth-Key', 'Bearer');
$apiInstance = new TBAAPI\v3client\Api\DistrictApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$district_key = 'district_key_example'; // string | TBA District Key, eg `2016fim`
$if_modified_since = 'if_modified_since_example'; // string | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
$result = $apiInstance->getDistrictEvents($district_key, $if_modified_since);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling DistrictApi->getDistrictEvents: ', $e->getMessage(), PHP_EOL;
}
?>
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 |
- 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
- Type: API key
- API key parameter name: X-TBA-Auth-Key
- Location: HTTP header