All docs

Set-based API reference

Every set-based 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.

Set-based

POST /api/v1/sport/{token}/set-based/away/score/increment

Increment the away team's points (simple or current-set, sport auto-detected).

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}/set-based/away/set/increment

Increment the away team's sets won (simple mode).

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}/set-based/current_set/increment

Advance to the next/previous set (expanded mode).

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}/set-based/home/score/increment

Increment the home team's points (simple or current-set, sport auto-detected).

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}/set-based/home/set/increment

Increment the home team's sets won (simple mode).

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}/set-based/reset

Reset all game state to initial values for a new 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

POST /api/v1/sport/{token}/set-based/serve/toggle

Manually switch serve / side-out (pickleball-aware).

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