All URIs are relative to https://www.thebluealliance.com/api/v3
| Method | HTTP request | Description |
|---|---|---|
| getEventMatchTimeseries | GET /event/{event_key}/matches/timeseries | |
| getEventMatches | GET /event/{event_key}/matches | |
| getEventMatchesKeys | GET /event/{event_key}/matches/keys | |
| getEventMatchesSimple | GET /event/{event_key}/matches/simple | |
| getMatch | GET /match/{match_key} | |
| getMatchSimple | GET /match/{match_key}/simple | |
| getMatchTimeseries | GET /match/{match_key}/timeseries | |
| getMatchZebra | GET /match/{match_key}/zebra_motionworks | |
| 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 | |
| getTeamMatchesByYear | GET /team/{team_key}/matches/{year} | |
| getTeamMatchesByYearKeys | GET /team/{team_key}/matches/{year}/keys | |
| getTeamMatchesByYearSimple | GET /team/{team_key}/matches/{year}/simple |
kotlin.Array<kotlin.String> getEventMatchTimeseries(eventKey, ifMinusModifiedMinusSince)
Gets an array of Match Keys for the given event key that have timeseries data. Returns an empty array if no matches have timeseries data. WARNING: This is not official data, and is subject to a significant possibility of error, or missing data. Do not rely on this data for any purpose. In fact, pretend we made it up. WARNING: This endpoint and corresponding data models are under active development and may change at any time, including in breaking ways.
// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*
val apiInstance = MatchApi()
val eventKey : kotlin.String = eventKey_example // kotlin.String | TBA Event Key, eg `2016nytr`
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
val result : kotlin.Array<kotlin.String> = apiInstance.getEventMatchTimeseries(eventKey, ifMinusModifiedMinusSince)
println(result)
} catch (e: ClientException) {
println("4xx response calling MatchApi#getEventMatchTimeseries")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling MatchApi#getEventMatchTimeseries")
e.printStackTrace()
}| Name | Type | Description | Notes |
|---|---|---|---|
| eventKey | kotlin.String | TBA Event Key, eg `2016nytr` | |
| ifMinusModifiedMinusSince | kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
kotlin.Array<kotlin.String>
Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""
- Content-Type: Not defined
- Accept: application/json
kotlin.Array<Match> getEventMatches(eventKey, ifMinusModifiedMinusSince)
Gets a list of matches for the given event.
// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*
val apiInstance = MatchApi()
val eventKey : kotlin.String = eventKey_example // kotlin.String | TBA Event Key, eg `2016nytr`
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
val result : kotlin.Array<Match> = apiInstance.getEventMatches(eventKey, ifMinusModifiedMinusSince)
println(result)
} catch (e: ClientException) {
println("4xx response calling MatchApi#getEventMatches")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling MatchApi#getEventMatches")
e.printStackTrace()
}| Name | Type | Description | Notes |
|---|---|---|---|
| eventKey | kotlin.String | TBA Event Key, eg `2016nytr` | |
| ifMinusModifiedMinusSince | kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""
- Content-Type: Not defined
- Accept: application/json
kotlin.Array<kotlin.String> getEventMatchesKeys(eventKey, ifMinusModifiedMinusSince)
Gets a list of match keys for the given event.
// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*
val apiInstance = MatchApi()
val eventKey : kotlin.String = eventKey_example // kotlin.String | TBA Event Key, eg `2016nytr`
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
val result : kotlin.Array<kotlin.String> = apiInstance.getEventMatchesKeys(eventKey, ifMinusModifiedMinusSince)
println(result)
} catch (e: ClientException) {
println("4xx response calling MatchApi#getEventMatchesKeys")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling MatchApi#getEventMatchesKeys")
e.printStackTrace()
}| Name | Type | Description | Notes |
|---|---|---|---|
| eventKey | kotlin.String | TBA Event Key, eg `2016nytr` | |
| ifMinusModifiedMinusSince | kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
kotlin.Array<kotlin.String>
Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""
- Content-Type: Not defined
- Accept: application/json
kotlin.Array<MatchSimple> getEventMatchesSimple(eventKey, ifMinusModifiedMinusSince)
Gets a short-form list of matches for the given event.
// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*
val apiInstance = MatchApi()
val eventKey : kotlin.String = eventKey_example // kotlin.String | TBA Event Key, eg `2016nytr`
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
val result : kotlin.Array<MatchSimple> = apiInstance.getEventMatchesSimple(eventKey, ifMinusModifiedMinusSince)
println(result)
} catch (e: ClientException) {
println("4xx response calling MatchApi#getEventMatchesSimple")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling MatchApi#getEventMatchesSimple")
e.printStackTrace()
}| Name | Type | Description | Notes |
|---|---|---|---|
| eventKey | kotlin.String | TBA Event Key, eg `2016nytr` | |
| ifMinusModifiedMinusSince | kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""
- Content-Type: Not defined
- Accept: application/json
Match getMatch(matchKey, ifMinusModifiedMinusSince)
Gets a `Match` object for the given match key.
// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*
val apiInstance = MatchApi()
val matchKey : kotlin.String = matchKey_example // kotlin.String | TBA Match Key, eg `2016nytr_qm1`
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
val result : Match = apiInstance.getMatch(matchKey, ifMinusModifiedMinusSince)
println(result)
} catch (e: ClientException) {
println("4xx response calling MatchApi#getMatch")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling MatchApi#getMatch")
e.printStackTrace()
}| Name | Type | Description | Notes |
|---|---|---|---|
| matchKey | kotlin.String | TBA Match Key, eg `2016nytr_qm1` | |
| ifMinusModifiedMinusSince | kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""
- Content-Type: Not defined
- Accept: application/json
MatchSimple getMatchSimple(matchKey, ifMinusModifiedMinusSince)
Gets a short-form `Match` object for the given match key.
// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*
val apiInstance = MatchApi()
val matchKey : kotlin.String = matchKey_example // kotlin.String | TBA Match Key, eg `2016nytr_qm1`
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
val result : MatchSimple = apiInstance.getMatchSimple(matchKey, ifMinusModifiedMinusSince)
println(result)
} catch (e: ClientException) {
println("4xx response calling MatchApi#getMatchSimple")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling MatchApi#getMatchSimple")
e.printStackTrace()
}| Name | Type | Description | Notes |
|---|---|---|---|
| matchKey | kotlin.String | TBA Match Key, eg `2016nytr_qm1` | |
| ifMinusModifiedMinusSince | kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""
- Content-Type: Not defined
- Accept: application/json
kotlin.Array<kotlin.Any> getMatchTimeseries(matchKey, ifMinusModifiedMinusSince)
Gets an array of game-specific Match Timeseries objects for the given match key or an empty array if not available. WARNING: This is not official data, and is subject to a significant possibility of error, or missing data. Do not rely on this data for any purpose. In fact, pretend we made it up. WARNING: This endpoint and corresponding data models are under active development and may change at any time, including in breaking ways.
// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*
val apiInstance = MatchApi()
val matchKey : kotlin.String = matchKey_example // kotlin.String | TBA Match Key, eg `2016nytr_qm1`
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
val result : kotlin.Array<kotlin.Any> = apiInstance.getMatchTimeseries(matchKey, ifMinusModifiedMinusSince)
println(result)
} catch (e: ClientException) {
println("4xx response calling MatchApi#getMatchTimeseries")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling MatchApi#getMatchTimeseries")
e.printStackTrace()
}| Name | Type | Description | Notes |
|---|---|---|---|
| matchKey | kotlin.String | TBA Match Key, eg `2016nytr_qm1` | |
| ifMinusModifiedMinusSince | kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""
- Content-Type: Not defined
- Accept: application/json
Zebra getMatchZebra(matchKey, ifMinusModifiedMinusSince)
Gets Zebra MotionWorks data for a Match for the given match key.
// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*
val apiInstance = MatchApi()
val matchKey : kotlin.String = matchKey_example // kotlin.String | TBA Match Key, eg `2016nytr_qm1`
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
val result : Zebra = apiInstance.getMatchZebra(matchKey, ifMinusModifiedMinusSince)
println(result)
} catch (e: ClientException) {
println("4xx response calling MatchApi#getMatchZebra")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling MatchApi#getMatchZebra")
e.printStackTrace()
}| Name | Type | Description | Notes |
|---|---|---|---|
| matchKey | kotlin.String | TBA Match Key, eg `2016nytr_qm1` | |
| ifMinusModifiedMinusSince | kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""
- Content-Type: Not defined
- Accept: application/json
kotlin.Array<Match> getTeamEventMatches(teamKey, eventKey, ifMinusModifiedMinusSince)
Gets a list of matches for the given team and event.
// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*
val apiInstance = MatchApi()
val teamKey : kotlin.String = teamKey_example // kotlin.String | TBA Team Key, eg `frc254`
val eventKey : kotlin.String = eventKey_example // kotlin.String | TBA Event Key, eg `2016nytr`
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
val result : kotlin.Array<Match> = apiInstance.getTeamEventMatches(teamKey, eventKey, ifMinusModifiedMinusSince)
println(result)
} catch (e: ClientException) {
println("4xx response calling MatchApi#getTeamEventMatches")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling MatchApi#getTeamEventMatches")
e.printStackTrace()
}| Name | Type | Description | Notes |
|---|---|---|---|
| teamKey | kotlin.String | TBA Team Key, eg `frc254` | |
| eventKey | kotlin.String | TBA Event Key, eg `2016nytr` | |
| ifMinusModifiedMinusSince | kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""
- Content-Type: Not defined
- Accept: application/json
kotlin.Array<kotlin.String> getTeamEventMatchesKeys(teamKey, eventKey, ifMinusModifiedMinusSince)
Gets a list of match keys for matches for the given team and event.
// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*
val apiInstance = MatchApi()
val teamKey : kotlin.String = teamKey_example // kotlin.String | TBA Team Key, eg `frc254`
val eventKey : kotlin.String = eventKey_example // kotlin.String | TBA Event Key, eg `2016nytr`
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
val result : kotlin.Array<kotlin.String> = apiInstance.getTeamEventMatchesKeys(teamKey, eventKey, ifMinusModifiedMinusSince)
println(result)
} catch (e: ClientException) {
println("4xx response calling MatchApi#getTeamEventMatchesKeys")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling MatchApi#getTeamEventMatchesKeys")
e.printStackTrace()
}| Name | Type | Description | Notes |
|---|---|---|---|
| teamKey | kotlin.String | TBA Team Key, eg `frc254` | |
| eventKey | kotlin.String | TBA Event Key, eg `2016nytr` | |
| ifMinusModifiedMinusSince | kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
kotlin.Array<kotlin.String>
Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""
- Content-Type: Not defined
- Accept: application/json
kotlin.Array<Match> getTeamEventMatchesSimple(teamKey, eventKey, ifMinusModifiedMinusSince)
Gets a short-form list of matches for the given team and event.
// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*
val apiInstance = MatchApi()
val teamKey : kotlin.String = teamKey_example // kotlin.String | TBA Team Key, eg `frc254`
val eventKey : kotlin.String = eventKey_example // kotlin.String | TBA Event Key, eg `2016nytr`
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
val result : kotlin.Array<Match> = apiInstance.getTeamEventMatchesSimple(teamKey, eventKey, ifMinusModifiedMinusSince)
println(result)
} catch (e: ClientException) {
println("4xx response calling MatchApi#getTeamEventMatchesSimple")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling MatchApi#getTeamEventMatchesSimple")
e.printStackTrace()
}| Name | Type | Description | Notes |
|---|---|---|---|
| teamKey | kotlin.String | TBA Team Key, eg `frc254` | |
| eventKey | kotlin.String | TBA Event Key, eg `2016nytr` | |
| ifMinusModifiedMinusSince | kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""
- Content-Type: Not defined
- Accept: application/json
kotlin.Array<Match> getTeamMatchesByYear(teamKey, year, ifMinusModifiedMinusSince)
Gets a list of matches for the given team and year.
// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*
val apiInstance = MatchApi()
val teamKey : kotlin.String = teamKey_example // kotlin.String | TBA Team Key, eg `frc254`
val year : kotlin.Int = 56 // kotlin.Int | Competition Year (or Season). Must be 4 digits.
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
val result : kotlin.Array<Match> = apiInstance.getTeamMatchesByYear(teamKey, year, ifMinusModifiedMinusSince)
println(result)
} catch (e: ClientException) {
println("4xx response calling MatchApi#getTeamMatchesByYear")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling MatchApi#getTeamMatchesByYear")
e.printStackTrace()
}| Name | Type | Description | Notes |
|---|---|---|---|
| teamKey | kotlin.String | TBA Team Key, eg `frc254` | |
| year | kotlin.Int | Competition Year (or Season). Must be 4 digits. | |
| ifMinusModifiedMinusSince | kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""
- Content-Type: Not defined
- Accept: application/json
kotlin.Array<kotlin.String> getTeamMatchesByYearKeys(teamKey, year, ifMinusModifiedMinusSince)
Gets a list of match keys for matches for the given team and year.
// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*
val apiInstance = MatchApi()
val teamKey : kotlin.String = teamKey_example // kotlin.String | TBA Team Key, eg `frc254`
val year : kotlin.Int = 56 // kotlin.Int | Competition Year (or Season). Must be 4 digits.
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
val result : kotlin.Array<kotlin.String> = apiInstance.getTeamMatchesByYearKeys(teamKey, year, ifMinusModifiedMinusSince)
println(result)
} catch (e: ClientException) {
println("4xx response calling MatchApi#getTeamMatchesByYearKeys")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling MatchApi#getTeamMatchesByYearKeys")
e.printStackTrace()
}| Name | Type | Description | Notes |
|---|---|---|---|
| teamKey | kotlin.String | TBA Team Key, eg `frc254` | |
| year | kotlin.Int | Competition Year (or Season). Must be 4 digits. | |
| ifMinusModifiedMinusSince | kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
kotlin.Array<kotlin.String>
Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""
- Content-Type: Not defined
- Accept: application/json
kotlin.Array<MatchSimple> getTeamMatchesByYearSimple(teamKey, year, ifMinusModifiedMinusSince)
Gets a short-form list of matches for the given team and year.
// Import classes:
//import net.thefletcher.tbaapi.v3client.infrastructure.*
//import net.thefletcher.tbaapi.v3client.models.*
val apiInstance = MatchApi()
val teamKey : kotlin.String = teamKey_example // kotlin.String | TBA Team Key, eg `frc254`
val year : kotlin.Int = 56 // kotlin.Int | Competition Year (or Season). Must be 4 digits.
val ifMinusModifiedMinusSince : kotlin.String = ifMinusModifiedMinusSince_example // kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client.
try {
val result : kotlin.Array<MatchSimple> = apiInstance.getTeamMatchesByYearSimple(teamKey, year, ifMinusModifiedMinusSince)
println(result)
} catch (e: ClientException) {
println("4xx response calling MatchApi#getTeamMatchesByYearSimple")
e.printStackTrace()
} catch (e: ServerException) {
println("5xx response calling MatchApi#getTeamMatchesByYearSimple")
e.printStackTrace()
}| Name | Type | Description | Notes |
|---|---|---|---|
| teamKey | kotlin.String | TBA Team Key, eg `frc254` | |
| year | kotlin.Int | Competition Year (or Season). Must be 4 digits. | |
| ifMinusModifiedMinusSince | kotlin.String | Value of the `Last-Modified` header in the most recently cached response by the client. | [optional] |
Configure apiKey: ApiClient.apiKey["X-TBA-Auth-Key"] = "" ApiClient.apiKeyPrefix["X-TBA-Auth-Key"] = ""
- Content-Type: Not defined
- Accept: application/json