Basketball API reference
Every basketball endpoint of the KeepTheScore API, with its parameters, request body and responses, generated from the live API.
Keys, tokens, request bodies and rate limits are explained in the API guide.
In the paths below, {token} is a board token when you send an API key, or one of the board's own tokens without one.
This page is generated from the live API. The same reference is available as OpenAPI 3 at
/apispec.json, if you'd rather generate a client than read tables.
Basketball
Toggle bonus for away team in basketball.
When show_double_bonus is enabled on the board, this cycles through three states: no bonus -> bonus -> double bonus -> no bonus When show_double_bonus is disabled, this performs a simple toggle: no bonus <-> bonus If double_bonus is active and the bonus is toggled off, double_bonus is also turned off.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
token |
string | yes |
Responses
| Status | Meaning | Body |
|---|---|---|
204 |
No Content | — |
400 |
Malformed request | — |
403 |
This token does not allow the board to be edited | — |
404 |
Board not found | — |
429 |
Too many requests | — |
500 |
Internal server error | — |
Increment away team fouls for basketball.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
token |
string | yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | MessageResponse |
400 |
Malformed request | — |
403 |
This token does not allow the board to be edited | — |
404 |
Board not found | — |
429 |
Too many requests | — |
500 |
Internal server error | — |
Response body (200) — MessageResponse (JSON)
| Field | Type | Always present | Description |
|---|---|---|---|
message |
string | yes | Status message |
Increment away team points for basketball.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
token |
string | yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | MessageResponse |
400 |
Malformed request | — |
403 |
This token does not allow the board to be edited | — |
404 |
Board not found | — |
429 |
Too many requests | — |
500 |
Internal server error | — |
Response body (200) — MessageResponse (JSON)
| Field | Type | Always present | Description |
|---|---|---|---|
message |
string | yes | Status message |
Increment away team timeouts for basketball.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
token |
string | yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | MessageResponse |
400 |
Malformed request | — |
403 |
This token does not allow the board to be edited | — |
404 |
Board not found | — |
429 |
Too many requests | — |
500 |
Internal server error | — |
Response body (200) — MessageResponse (JSON)
| Field | Type | Always present | Description |
|---|---|---|---|
message |
string | yes | Status message |
Toggle the FINAL state of a basketball scoreboard.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
token |
string | yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | MessageResponse |
400 |
Malformed request | — |
403 |
This token does not allow the board to be edited | — |
404 |
Board not found | — |
429 |
Too many requests | — |
500 |
Internal server error | — |
Response body (200) — MessageResponse (JSON)
| Field | Type | Always present | Description |
|---|---|---|---|
message |
string | yes | Status message |
Toggle bonus for home team in basketball.
When show_double_bonus is enabled on the board, this cycles through three states: no bonus -> bonus -> double bonus -> no bonus When show_double_bonus is disabled, this performs a simple toggle: no bonus <-> bonus If double_bonus is active and the bonus is toggled off, double_bonus is also turned off.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
token |
string | yes |
Responses
| Status | Meaning | Body |
|---|---|---|
204 |
No Content | — |
400 |
Malformed request | — |
403 |
This token does not allow the board to be edited | — |
404 |
Board not found | — |
429 |
Too many requests | — |
500 |
Internal server error | — |
Increment home team fouls for basketball.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
token |
string | yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | MessageResponse |
400 |
Malformed request | — |
403 |
This token does not allow the board to be edited | — |
404 |
Board not found | — |
429 |
Too many requests | — |
500 |
Internal server error | — |
Response body (200) — MessageResponse (JSON)
| Field | Type | Always present | Description |
|---|---|---|---|
message |
string | yes | Status message |
Increment home team points for basketball.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
token |
string | yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | MessageResponse |
400 |
Malformed request | — |
403 |
This token does not allow the board to be edited | — |
404 |
Board not found | — |
429 |
Too many requests | — |
500 |
Internal server error | — |
Response body (200) — MessageResponse (JSON)
| Field | Type | Always present | Description |
|---|---|---|---|
message |
string | yes | Status message |
Increment home team timeouts for basketball.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
token |
string | yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | MessageResponse |
400 |
Malformed request | — |
403 |
This token does not allow the board to be edited | — |
404 |
Board not found | — |
429 |
Too many requests | — |
500 |
Internal server error | — |
Response body (200) — MessageResponse (JSON)
| Field | Type | Always present | Description |
|---|---|---|---|
message |
string | yes | Status message |
Increment period for basketball.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
token |
string | yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | MessageResponse |
400 |
Malformed request | — |
403 |
This token does not allow the board to be edited | — |
404 |
Board not found | — |
429 |
Too many requests | — |
500 |
Internal server error | — |
Response body (200) — MessageResponse (JSON)
| Field | Type | Always present | Description |
|---|---|---|---|
message |
string | yes | Status message |
Toggle possession between home and away teams.
When toggling possession, one team gets possession and the other loses it.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
token |
string | yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | MessageResponse |
400 |
Malformed request | — |
403 |
This token does not allow the board to be edited | — |
404 |
Board not found | — |
429 |
Too many requests | — |
500 |
Internal server error | — |
Response body (200) — MessageResponse (JSON)
| Field | Type | Always present | Description |
|---|---|---|---|
message |
string | yes | Status message |
Reset all game state to initial values for a new basketball game.
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
token |
string | yes |
Responses
| Status | Meaning | Body |
|---|---|---|
200 |
OK | MessageResponse |
400 |
Malformed request | — |
403 |
This token does not allow the board to be edited | — |
404 |
Board not found | — |
429 |
Too many requests | — |
500 |
Internal server error | — |
Response body (200) — MessageResponse (JSON)
| Field | Type | Always present | Description |
|---|---|---|---|
message |
string | yes | Status message |