tba-api-v3client

Requirements

Building the API client library requires Maven to be installed.

Installation

To install the API client library to your local Maven repository, simply execute:

mvn install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn deploy

Refer to the official documentation for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
    <groupId>net.thefletcher.tbaapi.v3</groupId>
    <artifactId>tba-api-v3client</artifactId>
    <version>3.0.4</version>
    <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "net.thefletcher.tbaapi.v3:tba-api-v3client:3.0.4"

Others

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

target/tba-api-v3client-3.0.4.jar
target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import net.thefletcher.tbaapi.v3client.*;
import net.thefletcher.tbaapi.v3client.auth.*;
import net.thefletcher.tbaapi.v3client.model.*;
import net.thefletcher.tbaapi.v3client.api.DistrictApi;

import java.io.File;
import java.util.*;

public class DistrictApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apiKey
        ApiKeyAuth apiKey = (ApiKeyAuth) defaultClient.getAuthentication("apiKey");
        apiKey.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apiKey.setApiKeyPrefix("Token");

        DistrictApi apiInstance = new DistrictApi();
        String districtKey = "districtKey_example"; // String | TBA District Key, eg `2016fim`
        String ifModifiedSince = "ifModifiedSince_example"; // String | Value of the `Last-Modified` header in the most recently cached response by the client.
        try {
            List<Event> result = apiInstance.getDistrictEvents(districtKey, ifModifiedSince);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DistrictApi#getDistrictEvents");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

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

Class	Method	HTTP request
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	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	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
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	getEventsByYear	GET /events/{year}
ListApi	getEventsByYearKeys	GET /events/{year}/keys
ListApi	getEventsByYearSimple	GET /events/{year}/simple
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	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	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	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	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

Documentation for Authorization

Authentication schemes defined for the API:

apiKey

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

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Name		Name	Last commit message	Last commit date
Latest commit History 5 Commits
.swagger-codegen		.swagger-codegen
docs		docs
gradle/wrapper		gradle/wrapper
src		src
.gitignore		.gitignore
.swagger-codegen-ignore		.swagger-codegen-ignore
.travis.yml		.travis.yml
README.md		README.md
build.gradle		build.gradle
build.sbt		build.sbt
git_push.sh		git_push.sh
gradle.properties		gradle.properties
gradlew		gradlew
gradlew.bat		gradlew.bat
pom.xml		pom.xml
settings.gradle		settings.gradle

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Repository files navigation

tba-api-v3client

Requirements

Installation

Maven users

Gradle users

Others

Getting Started

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

apiKey

Recommendation

Author

About

Releases

Packages

Languages

notmattlythgoe/chs_platter

Folders and files

Latest commit

History

Repository files navigation

tba-api-v3client

Requirements

Installation

Maven users

Gradle users

Others

Getting Started

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

apiKey

Recommendation

Author

About

Resources

Stars

Watchers

Forks

Releases

Packages 0

Languages

Packages