All docs
Football API reference
Every football 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.
Football
POST
/api/v1/sport/{token}/football/away/possession/toggle
Toggle away team possession for football.
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 |
POST
/api/v1/sport/{token}/football/away/score/increment
Increment away team score for football.
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 |
POST
/api/v1/sport/{token}/football/away/timeouts/increment
Increment away team timeouts for football.
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 |
POST
/api/v1/sport/{token}/football/downs/increment
Increment downs for football.
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 |
POST
/api/v1/sport/{token}/football/final/toggle
Toggle the FINAL state of a football 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 |
POST
/api/v1/sport/{token}/football/first-down-reset
Reset down and distance to 1st & 10 in a single atomic update.
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 |
POST
/api/v1/sport/{token}/football/flag/toggle
Toggle the foul/flag indicator on a football 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 |
POST
/api/v1/sport/{token}/football/home/possession/toggle
Toggle home team possession for football.
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 |
POST
/api/v1/sport/{token}/football/home/score/increment
Increment home team score for football.
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 |
POST
/api/v1/sport/{token}/football/home/timeouts/increment
Increment home team timeouts for football.
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 |
POST
/api/v1/sport/{token}/football/quarter/increment
Increment quarter for football.
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 |
POST
/api/v1/sport/{token}/football/reset
Reset all game state to initial values for a new football 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 |
POST
/api/v1/sport/{token}/football/yards/increment
Increment yards to go for football.
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 |