All docs

Soccer API reference

Every soccer 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.

Soccer

POST /api/v1/sport/{token}/soccer/away/score/increment

Increment away team score for soccer.

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}/soccer/final/toggle

Toggle the FINAL state of a soccer 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}/soccer/home/score/increment

Increment home team score for soccer.

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}/soccer/period/increment

Increment period (half) for soccer.

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}/soccer/possession/toggle

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

POST /api/v1/sport/{token}/soccer/reset

Reset all game state to initial values for a new soccer match.

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