API pública · v0BetaVersão do documento 0.1.0

Referência da API do Scoreboards

Leia seus rankings e envie resultados para eles a partir de qualquer coisa que faça uma requisição HTTP. Nove endpoints, uma chave, sem SDK.

URL base

https://api.scoreboards.dev/v1

Documento OpenAPI 3.1 Obter acesso no painel Docs do bot e do site

A API está em beta

O acesso é aprovado por servidor. Abra seu painel, vá até a seção API do servidor que você administra e solicite o acesso por lá; depois de concedido, você pode criar chaves. Enquanto a v0 estiver em beta, endpoints e campos de resposta ainda podem mudar, e avisamos cada integração aprovada antes disso.

Leia isto primeiro: escritas são assíncronas

Uma escrita não devolve uma posição. Ela devolve 202 Accepted e um handle, porque a API apenas enfileira um comando — todo o cálculo de pontuação pertence ao bot do Discord. Num quadro com janela de validação, nada se move no ranking até um moderador clicar em Approve no Discord, e isso pode acontecer um dia depois, ou nunca.

201 Created acontece em um único caso: a janela de validação do quadro é de zero horas e o worker terminou dentro dos cerca de três segundos que a API espera. Um tempo esgotado ainda responde 202, então trate os dois.

Consultar GET /submissions/{handle} é a única forma correta de descobrir o que aconteceu. Uma integração que trata um POST bem-sucedido como ranking atualizado já nasce quebrada.

Antes de escrever código

Oito coisas que decidem se uma integração funciona. Nenhuma delas dá para adivinhar olhando a lista de endpoints.

Uma escrita é um pedido, não um resultado

POST enfileira um comando e responde com um handle como sub_88213 e applied: false. Consulte o handle; nunca presuma que a classificação mudou.

As notas são congeladas no envio

A nota de cada participante é lida quando a partida é criada, não quando é aprovada. Dez partidas enviadas em sequência são todas calculadas sobre as notas anteriores ao torneio. É determinístico, idêntico ao bot — e surpreendente na primeira vez.

ELO recebe um vencedor, League recebe um placar

Um quadro ELO não tem campo de pontuação: envie winner como team1, team2 ou draw. Um quadro League leva team1_score e team2_score e deduz o vencedor sozinho. Cada um recusa os campos do outro com um 422 que nomeia a chave indevida.

Quadros Time recebem milissegundos

Como inteiro: 1:30 é 90000. Enviar segundos é o erro de integração mais provável desta API, e é por isso que todo quadro Time informa score_unit: milliseconds no próprio contrato de escrita.

Cada lado leva exatamente team_size

Um quadro 3v3 quer três participantes por lado; qualquer outra coisa é um 422 team_size_mismatch. A exceção é um quadro com fixed_teams: true, em que cada lado é exatamente um team_id — a partida é entre as duas entidades de time, não entre seus integrantes.

Os ids de jogador têm prefixo

As respostas trazem discord:198374652000000000, custom:Ava, role:998877 ou team:5, e caminhos e filtros aceitam os mesmos formatos. Um snowflake puro do Discord também funciona como entrada, então um id copiado do Discord pode ser colado direto.

Todo POST precisa de um Idempotency-Key

É obrigatório, não opcional: um tempo esgotado é indistinguível de uma falha, e uma escrita repetida às cegas vira uma segunda partida no canal de validação de alguém. A mesma chave com o mesmo corpo repete a resposta guardada; a mesma chave com outro corpo é um 409. Os registros ficam guardados por pelo menos 24 horas — isso é um piso, não um vencimento —, então trate uma chave como gasta para sempre em vez de reaproveitá-la.

Cursores, não deslocamentos

Um ranking muda entre requisições, então paginar por offset conta duas vezes. Os cursores são compostos — um valor mais um critério de desempate — de modo que uma quebra de página dentro de um bloco de pontuações empatadas continua dentro do bloco em vez de pular todo mundo. 50 linhas por página por padrão, 200 no máximo. Trate next_cursor como opaco.

O que cada tipo de quadro aceita

O formato da escrita é fixado pelo quadro e nunca escolhido a cada envio. Em vez de fixar esta tabela no seu código, pergunte a GET /boards/{board}: o bloco write responde para aquele quadro específico, até o fator k ou os pontos por vitória.

Tipo de quadro	Endpoint	O corpo leva	Recusado com 422	O que a aprovação aplica
Classic	POST /boards/{board}/scores	player, score	team1, team2, winner, team1_score, team2_score	Soma a pontuação enviada ao total acumulado.
Highscore	POST /boards/{board}/scores	player, score	team1, team2, winner, team1_score, team2_score	Mantém a melhor entre a pontuação antiga e a nova.
Time	POST /boards/{board}/scores	player, score	team1, team2, winner, team1_score, team2_score	Mantém o melhor tempo conforme a ordenação do quadro.
ELO	POST /boards/{board}/matches	team1, team2, winner	team1_score, team2_score, score	Uma variação de nota de soma zero para os times, mais vitória, empate ou derrota.
League	POST /boards/{board}/matches	team1, team2, team1_score, team2_score	winner, score	Pontos por vitória, empate ou derrota, mais o retrospecto.
Rating	—	—	—	Sem endpoint de escrita na v0 — um envio de rating exige o upload de uma imagem.

Autenticação

Apresente uma chave do painel como Authorization: Bearer sk_live_.... Cada chave está ligada a exatamente um dono — um servidor do Discord, ou uma conta de usuário para quadros pessoais — então uma chave nunca alcança o quadro de outra pessoa. O quadro alheio é um 404, nunca um 403: confirmar que ele existe permitiria a qualquer um mapear os quadros dos outros.

Chaves de teste são somente leitura. Uma chave sk_test_ atende qualquer leitura e recusa todos os scopes de escrita. As chaves são exibidas uma única vez na criação e guardadas apenas como hash, então se perder uma, crie outra e revogue a antiga — várias chaves ativas por dono são permitidas, o que torna a rotação livre de indisponibilidade.

Nunca coloque uma chave secreta em código de cliente. As rotas /v1 não enviam nenhum cabeçalho CORS, então um navegador não consegue chamá-las. Isso é proposital, não um esquecimento.

curl 'https://api.scoreboards.dev/v1/boards' \
  -H 'Authorization: Bearer sk_live_...'

Scopes

Menor privilégio por padrão: o nível Somente leitura do painel concede os três scopes de leitura e mais nada, e só Leitura e escrita acrescenta matches:write e scores:write. Os scopes são conferidos exatamente e não implicam uns nos outros: matches:write não concede matches:read. Os dois scopes de escrita são separados porque o estrago que causam é diferente: uma integração de pontuação ruim infla um quadro, e uma de partidas ruim move a nota de todo mundo.

Scope	Permite
boards:read	Listar quadros, ler o contrato de escrita de um quadro e resolver um handle de escrita.
entries:read	Ler a classificação e a posição de um participante.
matches:read	Ler o histórico de partidas em quadros ELO e League.
matches:write	Enfileirar uma partida ELO ou League. Nunca concedido a uma chave de teste.
scores:write	Enfileirar uma pontuação num quadro Classic, Highscore ou Time. Nunca concedido a uma chave de teste.

Endpoints

Nove operações. Todos os caminhos abaixo são relativos à URL base, toda requisição precisa de uma chave bearer, e toda resposta que não for 2xx é um documento de problema.

Boards

Boards and their derived write contracts.

get/v1/boards

List every board this key can address

Every board owned by the key's owner, oldest first, with the derived write contract on each. A key is bound to exactly one owner (a Discord guild, or a user for u_ boards) and can never address another owner's board.

Start here: write.endpoint, write.requires and write.rejects tell you what to send without reading any prose, and auto_applies tells you whether a write will ever return 201.

Requires the boards:read scope.

Parâmetros

Nome	Local	Tipo	Descrição
limitopcional	query	integer	Page size. Default 50, maximum 200. Out of range is a 422.
cursoropcional	query	string	Opaque cursor. Pass the previous page's `next_cursor` back verbatim, or omit it to start at the top. Cursors are composite `(value, tie-breaker)` so a page boundary inside a block of tied scores resumes mid-tie. A malformed cursor is a 400; cursors are NOT signed, so a hand-built one is accepted and silently starts you at an arbitrary position. Never synthesize one.

Respostas

Status	Descrição
200	A page of boards.
400	`invalid_request` at the transport level: a body that is not JSON, a missing or unusable `Idempotency-Key`, a malformed cursor, or a player id that is not one this API issues. A body that parsed but was semantically wrong is a 422 instead.
401	Missing, malformed, unknown or revoked API key. Present the key as `Authorization: Bearer sk_live_...`. Authentication runs before the rate limiter, so this response carries no `RateLimit-*` headers.
403	The key authenticated but may not do this: it is missing the scope the operation needs, or it is a `sk_test_` key, which is read-only and is never granted a write scope.
422	The request was understood and refused. `code` says which rule: `invalid_request` (schema, including a `.strict()` body naming the unrecognized key), `board_type_mismatch`, `team_size_mismatch`, `duplicate_participant` or `unknown_player`.
429	Per-key token bucket: 600 reads and 60 writes per minute, tracked as separate buckets so a burst of writes cannot starve the polling that watches for their result. Rate limiting is evaluated BEFORE idempotency, so a 429 is never a replay.
500	Something failed on our side. The detail is deliberately generic — quote `request_id`, which joins your report to our log line.

Campo	Tipo	Descrição
data	Board[]
has_more	boolean	True when another page exists. Do not infer it from a short page — a page can be short and still have more.
next_cursor	string \| null	Pass back as `?cursor=`. `null` on the last page. Opaque: never parse it, never build one.

Resposta de exemplo · 200

{
  "data": [
    {
      "id": "board_1",
      "display_name": "Tuesday Chess",
      "type": "ELO",
      "sort": "desc",
      "team_size": 3,
      "fixed_teams": false,
      "url": "https://scoreboards.dev/leaderboards/111222333444555666/board_1",
      "write": {
        "endpoint": "/v1/boards/board_1/matches",
        "requires": [
          "team1",
          "team2",
          "winner"
        ],
        "rejects": [
          "team1_score",
          "team2_score",
          "score"
        ],
        "operator": "elo",
        "k_factor": 24,
        "start_rating": 1000
      },
      "validation_window_hours": 24,
      "auto_applies": false
    },
    {
      "id": "board_2",
      "display_name": "Sunday League",
      "type": "League",
      "sort": "desc",
      "team_size": 1,
      "fixed_teams": false,
      "url": "https://scoreboards.dev/leaderboards/111222333444555666/board_2",
      "write": {
        "endpoint": "/v1/boards/board_2/matches",
        "requires": [
          "team1",
          "team2",
          "team1_score",
          "team2_score"
        ],
        "rejects": [
          "winner",
          "score"
        ],
        "operator": "league_points",
        "points_win": 3,
        "points_draw": 1,
        "points_loss": 0
      },
      "validation_window_hours": 0,
      "auto_applies": true
    },
    {
      "id": "board_3",
      "display_name": "Speedrun",
      "type": "Highscore",
      "sort": "desc",
      "team_size": 1,
      "fixed_teams": false,
      "url": "https://scoreboards.dev/leaderboards/111222333444555666/board_3",
      "write": {
        "endpoint": "/v1/boards/board_3/scores",
        "requires": [
          "player",
          "score"
        ],
        "rejects": [
          "team1",
          "team2",
          "winner",
          "team1_score",
          "team2_score"
        ],
        "operator": "keep_highest"
      },
      "validation_window_hours": 24,
      "auto_applies": false
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Requisição de exemplo

curl 'https://api.scoreboards.dev/v1/boards?cursor=eyJzIjoxMjAwLCJwIjoiMTk4Mzc0NjUyMDAwMDAwMDAyIn0' \
  -H 'Authorization: Bearer sk_live_...'

get/v1/boards/{board}

Get one board and its write contract

Metadata plus the derived, read-only write contract. The operator is fixed by the board's type and sort when it is created — Classic accumulates, Highscore keeps the maximum, Time keeps the minimum, ELO applies a zero-sum delta, League awards points — and cannot be overridden per submission.

Read auto_applies before you build anything: when it is false, every write returns 202 and nothing changes until a moderator approves it in Discord.

Requires the boards:read scope.

Parâmetros

Nome	Local	Tipo	Descrição
boardobrigatório	path	string	The board id — `metadata.game_name`, e.g. `board_1`. Immutable, and never the display name. Older boards may carry a free-form (even non-ASCII) name, so URL-encode it.

Respostas

Status	Descrição
200	The board.
401	Missing, malformed, unknown or revoked API key. Present the key as `Authorization: Bearer sk_live_...`. Authentication runs before the rate limiter, so this response carries no `RateLimit-*` headers.
403	The key authenticated but may not do this: it is missing the scope the operation needs, or it is a `sk_test_` key, which is read-only and is never granted a write scope.
404	No such resource for this key's owner. A board that exists but belongs to somebody else returns exactly this, indistinguishable from one that does not exist — confirming existence would let a caller enumerate other people's boards.
422	The request was understood and refused. `code` says which rule: `invalid_request` (schema, including a `.strict()` body naming the unrecognized key), `board_type_mismatch`, `team_size_mismatch`, `duplicate_participant` or `unknown_player`.
429	Per-key token bucket: 600 reads and 60 writes per minute, tracked as separate buckets so a burst of writes cannot starve the polling that watches for their result. Rate limiting is evaluated BEFORE idempotency, so a 429 is never a replay.
500	Something failed on our side. The detail is deliberately generic — quote `request_id`, which joins your report to our log line.

Campo	Tipo	Descrição
id	string	Immutable public id. Use it in every path; it never changes, even when `display_name` does.
display_name	string
type	"Classic" \| "Highscore" \| "Time" \| "ELO" \| "League" \| "Rating"	Decides which write endpoint applies. ELO and League take matches; Classic, Highscore and Time take scores; Rating takes neither in v0.
sort	"desc" \| "asc"
team_size	integer	Participants per side on a match board. Each roster must carry exactly this many — unless `fixed_teams` is true, in which case each side is exactly ONE team entity.
fixed_teams	boolean	True when the board plays fixed team entities against each other. A match then names two `team_id`s, not `2 × team_size` players.
url	string
write	WriteContract \| null	What to POST. `null` on Rating boards, which have no v0 write endpoint.
validation_window_hours	integer	Hours a submission waits for a moderator. `0` auto-applies; `999` means manual review with no countdown.
auto_applies	boolean	True only when `validation_window_hours` is 0. When false, a write returns 202 and NOTHING changes on the leaderboard until a human clicks Approve in Discord.

Resposta de exemplo · 200

{
  "id": "board_1",
  "display_name": "Tuesday Chess",
  "type": "ELO",
  "sort": "desc",
  "team_size": 3,
  "fixed_teams": false,
  "url": "https://scoreboards.dev/leaderboards/111222333444555666/board_1",
  "write": {
    "endpoint": "/v1/boards/board_1/matches",
    "requires": [
      "team1",
      "team2",
      "winner"
    ],
    "rejects": [
      "team1_score",
      "team2_score",
      "score"
    ],
    "operator": "elo",
    "k_factor": 24,
    "start_rating": 1000
  },
  "validation_window_hours": 24,
  "auto_applies": false
}

Requisição de exemplo

curl 'https://api.scoreboards.dev/v1/boards/board_1' \
  -H 'Authorization: Bearer sk_live_...'

Entries

Ranked standings — one row per participant.

get/v1/boards/{board}/entries

List ranked standings

The leaderboard, best first, cursor-paginated. rank is correct on every page, including a page resumed from a cursor.

ELO boards carry elo; every other type carries score. Rating boards have no ranked entries in v0 (they store one row per submission, not per player) and return a 422 board_type_mismatch.

Requires the entries:read scope.

Parâmetros

Nome	Local	Tipo	Descrição
boardobrigatório	path	string	The board id — `metadata.game_name`, e.g. `board_1`. Immutable, and never the display name. Older boards may carry a free-form (even non-ASCII) name, so URL-encode it.
limitopcional	query	integer	Page size. Default 50, maximum 200. Out of range is a 422.
cursoropcional	query	string	Opaque cursor. Pass the previous page's `next_cursor` back verbatim, or omit it to start at the top. Cursors are composite `(value, tie-breaker)` so a page boundary inside a block of tied scores resumes mid-tie. A malformed cursor is a 400; cursors are NOT signed, so a hand-built one is accepted and silently starts you at an arbitrary position. Never synthesize one.

Respostas

Status	Descrição
200	A page of standings.
400	`invalid_request` at the transport level: a body that is not JSON, a missing or unusable `Idempotency-Key`, a malformed cursor, or a player id that is not one this API issues. A body that parsed but was semantically wrong is a 422 instead.
401	Missing, malformed, unknown or revoked API key. Present the key as `Authorization: Bearer sk_live_...`. Authentication runs before the rate limiter, so this response carries no `RateLimit-*` headers.
403	The key authenticated but may not do this: it is missing the scope the operation needs, or it is a `sk_test_` key, which is read-only and is never granted a write scope.
404	No such resource for this key's owner. A board that exists but belongs to somebody else returns exactly this, indistinguishable from one that does not exist — confirming existence would let a caller enumerate other people's boards.
422	The request was understood and refused. `code` says which rule: `invalid_request` (schema, including a `.strict()` body naming the unrecognized key), `board_type_mismatch`, `team_size_mismatch`, `duplicate_participant` or `unknown_player`.
429	Per-key token bucket: 600 reads and 60 writes per minute, tracked as separate buckets so a burst of writes cannot starve the polling that watches for their result. Rate limiting is evaluated BEFORE idempotency, so a 429 is never a replay.
500	Something failed on our side. The detail is deliberately generic — quote `request_id`, which joins your report to our log line.

Campo	Tipo	Descrição
data	Entry[]
has_more	boolean	True when another page exists. Do not infer it from a short page — a page can be short and still have more.
next_cursor	string \| null	Pass back as `?cursor=`. `null` on the last page. Opaque: never parse it, never build one.

Resposta de exemplo · 200

{
  "data": [
    {
      "rank": 1,
      "player_id": "discord:198374652000000001",
      "player_name": "Ava",
      "last_sub": "2026-07-20T12:00:00.000Z",
      "elo": 1450,
      "wins": 9,
      "draws": 2,
      "losses": 1
    },
    {
      "rank": 2,
      "player_id": "discord:198374652000000002",
      "player_name": "Ben",
      "last_sub": "2026-07-21T12:00:00.000Z",
      "elo": 1200,
      "wins": 4,
      "draws": 1,
      "losses": 4
    }
  ],
  "has_more": true,
  "next_cursor": "eyJzIjoxMjAwLCJwIjoiMTk4Mzc0NjUyMDAwMDAwMDAyIn0"
}

Requisição de exemplo

curl 'https://api.scoreboards.dev/v1/boards/board_1/entries?cursor=eyJzIjoxMjAwLCJwIjoiMTk4Mzc0NjUyMDAwMDAwMDAyIn0' \
  -H 'Authorization: Bearer sk_live_...'

get/v1/boards/{board}/entries/{player_id}

Get one participant's standing

One row of the leaderboard, with its live rank. Use a player_id exactly as an entries response returned it; a bare Discord snowflake also works.

A participant with no row on this board is a 404 — a player who has never submitted has no standing to report.

Requires the entries:read scope.

Parâmetros

Nome	Local	Tipo	Descrição
boardobrigatório	path	string	The board id — `metadata.game_name`, e.g. `board_1`. Immutable, and never the display name. Older boards may carry a free-form (even non-ASCII) name, so URL-encode it.
player_idobrigatório	path	string	A namespaced player id as returned by the entries endpoints: `discord:<snowflake>`, `custom:<name>`, `role:<id>` or `team:<id>`. A bare Discord snowflake is also accepted, so a caller can paste one straight in. Anything else is a 400.

Respostas

Status	Descrição
200	The standing.
400	`invalid_request` at the transport level: a body that is not JSON, a missing or unusable `Idempotency-Key`, a malformed cursor, or a player id that is not one this API issues. A body that parsed but was semantically wrong is a 422 instead.
401	Missing, malformed, unknown or revoked API key. Present the key as `Authorization: Bearer sk_live_...`. Authentication runs before the rate limiter, so this response carries no `RateLimit-*` headers.
403	The key authenticated but may not do this: it is missing the scope the operation needs, or it is a `sk_test_` key, which is read-only and is never granted a write scope.
404	No such resource for this key's owner. A board that exists but belongs to somebody else returns exactly this, indistinguishable from one that does not exist — confirming existence would let a caller enumerate other people's boards.
422	The request was understood and refused. `code` says which rule: `invalid_request` (schema, including a `.strict()` body naming the unrecognized key), `board_type_mismatch`, `team_size_mismatch`, `duplicate_participant` or `unknown_player`.
429	Per-key token bucket: 600 reads and 60 writes per minute, tracked as separate buckets so a burst of writes cannot starve the polling that watches for their result. Rate limiting is evaluated BEFORE idempotency, so a 429 is never a replay.
500	Something failed on our side. The detail is deliberately generic — quote `request_id`, which joins your report to our log line.

Campo	Tipo	Descrição
rank	integer	1-based, and correct on every page — a resumed page derives it with a COUNT rather than numbering from 1.
player_id	string	Namespaced: `discord:<snowflake>`, `custom:<name>`, `role:<id>` or `team:<id>`. Pass it back verbatim to `/entries/{player_id}` or `?player=`.
player_name	string
scoreopcional	number \| null
eloopcional	number \| null
winsopcional	integer \| null
drawsopcional	integer \| null
lossesopcional	integer \| null
submissionsopcional	integer \| null
last_sub	string \| null	RFC 3339 UTC. `null` when the participant has never submitted.

Resposta de exemplo · 200

{
  "rank": 1,
  "player_id": "discord:198374652000000001",
  "player_name": "Ava",
  "last_sub": "2026-07-20T12:00:00.000Z",
  "elo": 1450,
  "wins": 9,
  "draws": 2,
  "losses": 1
}

Requisição de exemplo

curl 'https://api.scoreboards.dev/v1/boards/board_1/entries/discord:198374652000000001' \
  -H 'Authorization: Bearer sk_live_...'

Matches

Match history on ELO and League boards, and the asynchronous endpoint that records one. The write returns a handle, not a result.

get/v1/boards/{board}/matches

List match history

Recorded matches, newest first. Only ELO and League boards record matches; on any other type this is a 422 board_type_mismatch pointing you at /entries.

Every participant carries the elo they held when the match was submitted, not when it was approved — so a tournament pushed as ten back-to-back matches shows pre-tournament ratings on all ten.

Requires the matches:read scope.

Parâmetros

Nome	Local	Tipo	Descrição
boardobrigatório	path	string	The board id — `metadata.game_name`, e.g. `board_1`. Immutable, and never the display name. Older boards may carry a free-form (even non-ASCII) name, so URL-encode it.
limitopcional	query	integer	Page size. Default 50, maximum 200. Out of range is a 422.
cursoropcional	query	string	Opaque cursor. Pass the previous page's `next_cursor` back verbatim, or omit it to start at the top. Cursors are composite `(value, tie-breaker)` so a page boundary inside a block of tied scores resumes mid-tie. A malformed cursor is a 400; cursors are NOT signed, so a hand-built one is accepted and silently starts you at an arbitrary position. Never synthesize one.
playeropcional	query	string	Only matches this participant took part in. Same namespaced form as `Entry.player_id`; a bare snowflake is accepted. An unusable value is a 400, not an empty list.
statusopcional	query	"pending" \| "approved" \| "rejected" \| "adjusted" \| "set"	Only matches in this review state. `adjusted` and `set` are moderator edits made in Discord.

Respostas

Status	Descrição
200	A page of matches.
400	`invalid_request` at the transport level: a body that is not JSON, a missing or unusable `Idempotency-Key`, a malformed cursor, or a player id that is not one this API issues. A body that parsed but was semantically wrong is a 422 instead.
401	Missing, malformed, unknown or revoked API key. Present the key as `Authorization: Bearer sk_live_...`. Authentication runs before the rate limiter, so this response carries no `RateLimit-*` headers.
403	The key authenticated but may not do this: it is missing the scope the operation needs, or it is a `sk_test_` key, which is read-only and is never granted a write scope.
404	No such resource for this key's owner. A board that exists but belongs to somebody else returns exactly this, indistinguishable from one that does not exist — confirming existence would let a caller enumerate other people's boards.
422	The request was understood and refused. `code` says which rule: `invalid_request` (schema, including a `.strict()` body naming the unrecognized key), `board_type_mismatch`, `team_size_mismatch`, `duplicate_participant` or `unknown_player`.
429	Per-key token bucket: 600 reads and 60 writes per minute, tracked as separate buckets so a burst of writes cannot starve the polling that watches for their result. Rate limiting is evaluated BEFORE idempotency, so a 429 is never a replay.
500	Something failed on our side. The detail is deliberately generic — quote `request_id`, which joins your report to our log line.

Campo	Tipo	Descrição
data	Match[]
has_more	boolean	True when another page exists. Do not infer it from a short page — a page can be short and still have more.
next_cursor	string \| null	Pass back as `?cursor=`. `null` on the last page. Opaque: never parse it, never build one.

Resposta de exemplo · 200

{
  "data": [
    {
      "id": 2,
      "board": "board_1",
      "team_size": 3,
      "team1": [
        {
          "player_id": "discord:198374652000000001",
          "player_name": "Ava",
          "elo": 1450
        },
        {
          "player_id": "discord:198374652000000002",
          "player_name": "Ben",
          "elo": 1200
        },
        {
          "player_id": "custom:demo_1",
          "player_name": "Demo Player",
          "elo": 1050
        }
      ],
      "team2": [
        {
          "player_id": "discord:198374652000000003",
          "player_name": "Cal",
          "elo": 1200
        },
        {
          "player_id": "discord:198374652000000004",
          "player_name": "Dee",
          "elo": 900
        },
        {
          "player_id": "custom:Ava Custom",
          "player_name": "Ava Custom",
          "elo": 1100
        }
      ],
      "winner": "team2",
      "status": "pending",
      "applied": false,
      "submitted_at": "2026-07-25T10:00:00.000Z",
      "submitted_by": "api"
    },
    {
      "id": 1,
      "board": "board_1",
      "team_size": 1,
      "team1": [
        {
          "player_id": "discord:198374652000000001",
          "player_name": "Ava",
          "elo": 1450
        }
      ],
      "team2": [
        {
          "player_id": "discord:198374652000000002",
          "player_name": "Ben",
          "elo": 1200
        }
      ],
      "winner": "team1",
      "status": "approved",
      "applied": true,
      "submitted_at": "2026-07-24T10:00:00.000Z",
      "submitted_by": "api"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Requisição de exemplo

curl 'https://api.scoreboards.dev/v1/boards/board_1/matches?cursor=eyJzIjoxMjAwLCJwIjoiMTk4Mzc0NjUyMDAwMDAwMDAyIn0&player=discord:198374652000000001&status=approved' \
  -H 'Authorization: Bearer sk_live_...'

post/v1/boards/{board}/matches

Record an ELO or League match (asynchronous)

Returns 202 Accepted and a handle, not a rank. The match is enqueued for the bot that owns the scoring; on a board with a validation window it then sits in the Discord validation channel until a moderator clicks Approve. Poll GET /submissions/{handle} to learn the outcome.

201 Created happens only on an auto-applying board (auto_applies: true) whose worker finished inside the ~3s wait budget. A timeout still returns 202. Handle both.

The body depends on the board type, and each rejects the other's fields with a 422 naming the offending key:

ELO takes team1, team2 and winner (team1 | team2 | draw). It has no score field.
League takes team1, team2, team1_score and team2_score, and DERIVES the winner from the scoreline. Sending winner is refused.

Each roster must carry exactly the board's team_size participants — except on a board with fixed_teams: true, where each side is exactly ONE team_id and the match is between the two team entities rather than their members. Anything else is a 422 team_size_mismatch.

Ratings are snapshotted when the match is created, not when it is approved.

Requires the matches:write scope and an Idempotency-Key header. sk_test_ keys are read-only.

Parâmetros

Nome	Local	Tipo	Descrição
boardobrigatório	path	string	The board id — `metadata.game_name`, e.g. `board_1`. Immutable, and never the display name. Older boards may carry a free-form (even non-ASCII) name, so URL-encode it.
Idempotency-Keyobrigatório	header	string	Required on every POST. A value you generate per logical write (a UUID is ideal) and reuse when you retry. Same key + same body replays the stored response byte for byte; same key + a DIFFERENT body is a 409, so a caller who edits and retries never silently receives the old result. Records are kept for at least 24h — that is a floor, not an expiry, so treat a key as permanently spent rather than recycling one. Omitting the header is a 400 — retrying without one risks a duplicate match in someone's validation channel.

Corpo da requisição application/json

An ELO match or a League match — whichever the board is. The two shapes are mutually exclusive.

Envie exatamente um destes formatos — o que corresponder ao quadro:

EloMatchBody

Campo	Tipo	Descrição
team1	Participant[]	min items 1 · max items 8
team2	Participant[]	min items 1 · max items 8
winner	"team1" \| "team2" \| "draw"	Words, not codes. `draw` is a legal outcome and applies the zero-sum ELO delta for a tie.

LeagueMatchBody

Campo	Tipo	Descrição
team1	Participant[]	min items 1 · max items 8
team2	Participant[]	min items 1 · max items 8
team1_score	integer	min 0 · max 9007199254740991
team2_score	integer	min 0 · max 9007199254740991

ELO, 3v3 (board_1)

Exactly `team_size` participants per side. Mixed forms are fine: members, a custom player, a role.

{
  "team1": [
    {
      "discord_id": "198374652000000001"
    },
    {
      "discord_id": "198374652000000002"
    },
    {
      "name": "Demo Player",
      "custom": true
    }
  ],
  "team2": [
    {
      "discord_id": "198374652000000003"
    },
    {
      "discord_id": "198374652000000004"
    },
    {
      "role_id": "role_998877"
    }
  ],
  "winner": "team1"
}

League, 1v1 (board_2)

Both scores required, integers >= 0. The winner is derived; sending one is a 422.

{
  "team1": [
    {
      "discord_id": "198374652000000001"
    }
  ],
  "team2": [
    {
      "discord_id": "198374652000000002"
    }
  ],
  "team1_score": 3,
  "team2_score": 1
}

ELO on a fixed-teams board

One team entity per side, regardless of `team_size`. A draw is a legal outcome.

{
  "team1": [
    {
      "team_id": "team_5"
    }
  ],
  "team2": [
    {
      "team_id": "team_6"
    }
  ],
  "winner": "draw"
}

Respostas

Status	Descrição
201	Applied. Only ever returned by a board with `auto_applies: true` whose worker finished inside the wait budget — `applied` is true and `match` is present.
202	Queued. Nothing has changed on the leaderboard. `applied` is false and stays false until the submission is approved. This is the normal response.
400	`invalid_request` at the transport level: a body that is not JSON, a missing or unusable `Idempotency-Key`, a malformed cursor, or a player id that is not one this API issues. A body that parsed but was semantically wrong is a 422 instead.
401	Missing, malformed, unknown or revoked API key. Present the key as `Authorization: Bearer sk_live_...`. Authentication runs before the rate limiter, so this response carries no `RateLimit-*` headers.
403	The key authenticated but may not do this: it is missing the scope the operation needs, or it is a `sk_test_` key, which is read-only and is never granted a write scope.
404	No such resource for this key's owner. A board that exists but belongs to somebody else returns exactly this, indistinguishable from one that does not exist — confirming existence would let a caller enumerate other people's boards.
409	The `Idempotency-Key` was already used for a request with a DIFFERENT body, or an identical request is still in flight (that variant carries `Retry-After`). Use a new key for a new request, or resend the original body byte for byte.
413	/v1 accepts at most 64 KB per request. The largest legal body — an 8v8 match — is well under a kilobyte.
422	The request was understood and refused. `code` says which rule: `invalid_request` (schema, including a `.strict()` body naming the unrecognized key), `board_type_mismatch`, `team_size_mismatch`, `duplicate_participant` or `unknown_player`.
429	Per-key token bucket: 600 reads and 60 writes per minute, tracked as separate buckets so a burst of writes cannot starve the polling that watches for their result. Rate limiting is evaluated BEFORE idempotency, so a 429 is never a replay.
500	Something failed on our side. The detail is deliberately generic — quote `request_id`, which joins your report to our log line.

Campo	Tipo	Descrição
handle	string	Poll `GET /submissions/{handle}` with this. Resolves for 30 days, then 404s. pattern ^sub_\d+$
board	string
status	"queued" \| "processing" \| "pending_review" \| "approved" \| "rejected" \| "failed"	On a 202 this is `queued` (or, rarely, `failed` — the worker ran and threw inside the wait budget); `approved` only on a 201. `pending_review` never appears here: it is what the HANDLE reports once the worker has posted the submission for review. Poll the handle for that.
applied	boolean	True only when the result is already live on the leaderboard. False on every 202.
queued_at	string	RFC 3339 UTC, when the write was enqueued. A replayed response repeats the ORIGINAL value.
matchopcional	MatchRef \| null	Present once the worker has created the match. Absent on a plain 202, which is the normal case.

Resposta de exemplo · 201

{
  "handle": "sub_88214",
  "board": "board_2",
  "status": "approved",
  "applied": true,
  "queued_at": "2026-07-26T12:00:02.881Z",
  "match": {
    "id": 2,
    "url": "https://scoreboards.dev/leaderboards/111222333444555666/board_2",
    "applied": true
  }
}

Requisição de exemplo

curl -X POST 'https://api.scoreboards.dev/v1/boards/board_1/matches' \
  -H 'Authorization: Bearer sk_live_...' \
  -H 'Idempotency-Key: 8f14e45f-ea6a-4e2b-9c1a-77c0e4d51a10' \
  -H 'Content-Type: application/json' \
  -d '{"team1":[{"discord_id":"198374652000000001"},{"discord_id":"198374652000000002"},{"name":"Demo Player","custom":true}],"team2":[{"discord_id":"198374652000000003"},{"discord_id":"198374652000000004"},{"role_id":"role_998877"}],"winner":"team1"}'

get/v1/boards/{board}/matches/{match_id}

Get one match with its rosters

One match by its per-board id, with both full rosters. League matches carry team1_score and team2_score; ELO matches have no scoreline and omit both.

Requires the matches:read scope.

Parâmetros

Nome	Local	Tipo	Descrição
boardobrigatório	path	string	The board id — `metadata.game_name`, e.g. `board_1`. Immutable, and never the display name. Older boards may carry a free-form (even non-ASCII) name, so URL-encode it.
match_idobrigatório	path	integer	The per-board match number (`Match.id`). Not globally unique.

Respostas

Status	Descrição
200	The match.
401	Missing, malformed, unknown or revoked API key. Present the key as `Authorization: Bearer sk_live_...`. Authentication runs before the rate limiter, so this response carries no `RateLimit-*` headers.
403	The key authenticated but may not do this: it is missing the scope the operation needs, or it is a `sk_test_` key, which is read-only and is never granted a write scope.
404	No such resource for this key's owner. A board that exists but belongs to somebody else returns exactly this, indistinguishable from one that does not exist — confirming existence would let a caller enumerate other people's boards.
422	The request was understood and refused. `code` says which rule: `invalid_request` (schema, including a `.strict()` body naming the unrecognized key), `board_type_mismatch`, `team_size_mismatch`, `duplicate_participant` or `unknown_player`.
429	Per-key token bucket: 600 reads and 60 writes per minute, tracked as separate buckets so a burst of writes cannot starve the polling that watches for their result. Rate limiting is evaluated BEFORE idempotency, so a 429 is never a replay.
500	Something failed on our side. The detail is deliberately generic — quote `request_id`, which joins your report to our log line.

Campo	Tipo	Descrição
id	integer	Per-board match number. Not globally unique; always address it under its board.
board	string
team_size	integer
team1	MatchParticipant[]
team2	MatchParticipant[]
winner	"team1" \| "team2" \| "draw" \| null	On a League board this is DERIVED from the scoreline, never supplied by the caller.
team1_scoreopcional	number \| null	League boards only. Absent on ELO boards, which have no scoreline.
team2_scoreopcional	number \| null	League boards only. Absent on ELO boards, which have no scoreline.
status	"pending" \| "approved" \| "rejected" \| "adjusted" \| "set"	`pending` until reviewed. `adjusted` and `set` are moderator edits made in Discord.
applied	boolean	True only once the result is live on the leaderboard (`approved`, `adjusted` or `set`).
submitted_at	string \| null	RFC 3339 UTC, when the match was submitted — not when it was approved.
submitted_byopcional	string \| null	The Discord user who submitted it, or `api` for a submission made through this API.

Resposta de exemplo · 200

{
  "id": 2,
  "board": "board_1",
  "team_size": 3,
  "team1": [
    {
      "player_id": "discord:198374652000000001",
      "player_name": "Ava",
      "elo": 1450
    },
    {
      "player_id": "discord:198374652000000002",
      "player_name": "Ben",
      "elo": 1200
    },
    {
      "player_id": "custom:demo_1",
      "player_name": "Demo Player",
      "elo": 1050
    }
  ],
  "team2": [
    {
      "player_id": "discord:198374652000000003",
      "player_name": "Cal",
      "elo": 1200
    },
    {
      "player_id": "discord:198374652000000004",
      "player_name": "Dee",
      "elo": 900
    },
    {
      "player_id": "custom:Ava Custom",
      "player_name": "Ava Custom",
      "elo": 1100
    }
  ],
  "winner": "team2",
  "status": "pending",
  "applied": false,
  "submitted_at": "2026-07-25T10:00:00.000Z",
  "submitted_by": "api"
}

Requisição de exemplo

curl 'https://api.scoreboards.dev/v1/boards/board_1/matches/2' \
  -H 'Authorization: Bearer sk_live_...'

Submissions

Score submissions on Classic, Highscore and Time boards, and resolving the handle that any write returns.

post/v1/boards/{board}/scores

Submit a score to a Classic, Highscore or Time board (asynchronous)

Returns 202 Accepted and a handle, not a new rank. Like every /v1 write it enqueues, and on a board with a validation window the score waits for a moderator. Poll GET /submissions/{handle}.

Time boards take MILLISECONDS as an integer — 1:30 is 90000. This is the most likely integration bug on the whole API; the board's write.score_unit says so too.

What the score does on approval is fixed by the board and is not a caller choice: Classic adds it to the running total, Highscore keeps the higher value, Time keeps the lower one.

ELO and League boards take matches, not scores, and answer 422 board_type_mismatch here.

Requires the scores:write scope and an Idempotency-Key header. sk_test_ keys are read-only.

Parâmetros

Nome	Local	Tipo	Descrição
boardobrigatório	path	string	The board id — `metadata.game_name`, e.g. `board_1`. Immutable, and never the display name. Older boards may carry a free-form (even non-ASCII) name, so URL-encode it.
Idempotency-Keyobrigatório	header	string	Required on every POST. A value you generate per logical write (a UUID is ideal) and reuse when you retry. Same key + same body replays the stored response byte for byte; same key + a DIFFERENT body is a 409, so a caller who edits and retries never silently receives the old result. Records are kept for at least 24h — that is a floor, not an expiry, so treat a key as permanently spent rather than recycling one. Omitting the header is a 400 — retrying without one risks a duplicate match in someone's validation channel.

Corpo da requisição application/json

One participant and one integer score.

Campo	Tipo	Descrição
player	Participant	Exactly one of the four forms. Anything else is a 422 `unknown_player`.
score	integer	Integer. On a Time board this is MILLISECONDS: `1:30` is `90000`, not `90` and not `1.5`. min -9007199254740991 · max 9007199254740991

A Discord member

{
  "player": {
    "discord_id": "198374652000000001"
  },
  "score": 145530
}

A Time board — milliseconds

A run of 2 minutes 25.530 seconds. Sending `145.53` seconds would record 145 ms.

{
  "player": {
    "name": "Ava",
    "custom": true
  },
  "score": 145530
}

Respostas

Status	Descrição
201	Applied. Only ever returned by a board with `auto_applies: true` whose worker finished inside the wait budget — `applied` is true and `match` points at the stored submission.
202	Queued. Nothing has changed on the leaderboard. The score waits in the Discord validation channel until a moderator approves it. This is the normal response.
400	`invalid_request` at the transport level: a body that is not JSON, a missing or unusable `Idempotency-Key`, a malformed cursor, or a player id that is not one this API issues. A body that parsed but was semantically wrong is a 422 instead.
401	Missing, malformed, unknown or revoked API key. Present the key as `Authorization: Bearer sk_live_...`. Authentication runs before the rate limiter, so this response carries no `RateLimit-*` headers.
403	The key authenticated but may not do this: it is missing the scope the operation needs, or it is a `sk_test_` key, which is read-only and is never granted a write scope.
404	No such resource for this key's owner. A board that exists but belongs to somebody else returns exactly this, indistinguishable from one that does not exist — confirming existence would let a caller enumerate other people's boards.
409	The `Idempotency-Key` was already used for a request with a DIFFERENT body, or an identical request is still in flight (that variant carries `Retry-After`). Use a new key for a new request, or resend the original body byte for byte.
413	/v1 accepts at most 64 KB per request. The largest legal body — an 8v8 match — is well under a kilobyte.
422	The request was understood and refused. `code` says which rule: `invalid_request` (schema, including a `.strict()` body naming the unrecognized key), `board_type_mismatch`, `team_size_mismatch`, `duplicate_participant` or `unknown_player`.
429	Per-key token bucket: 600 reads and 60 writes per minute, tracked as separate buckets so a burst of writes cannot starve the polling that watches for their result. Rate limiting is evaluated BEFORE idempotency, so a 429 is never a replay.
500	Something failed on our side. The detail is deliberately generic — quote `request_id`, which joins your report to our log line.

Campo	Tipo	Descrição
handle	string	Poll `GET /submissions/{handle}` with this. Resolves for 30 days, then 404s. pattern ^sub_\d+$
board	string
status	"queued" \| "processing" \| "pending_review" \| "approved" \| "rejected" \| "failed"	On a 202 this is `queued` (or, rarely, `failed` — the worker ran and threw inside the wait budget); `approved` only on a 201. `pending_review` never appears here: it is what the HANDLE reports once the worker has posted the submission for review. Poll the handle for that.
applied	boolean	True only when the result is already live on the leaderboard. False on every 202.
queued_at	string	RFC 3339 UTC, when the write was enqueued. A replayed response repeats the ORIGINAL value.
matchopcional	MatchRef \| null	Present once the worker has created the match. Absent on a plain 202, which is the normal case.

Resposta de exemplo · 201

{
  "handle": "sub_88216",
  "board": "board_7",
  "status": "approved",
  "applied": true,
  "queued_at": "2026-07-26T12:00:04.017Z",
  "match": {
    "id": 118,
    "url": "https://scoreboards.dev/leaderboards/111222333444555666/board_7",
    "applied": true
  }
}

Requisição de exemplo

curl -X POST 'https://api.scoreboards.dev/v1/boards/board_1/scores' \
  -H 'Authorization: Bearer sk_live_...' \
  -H 'Idempotency-Key: 8f14e45f-ea6a-4e2b-9c1a-77c0e4d51a10' \
  -H 'Content-Type: application/json' \
  -d '{"player":{"discord_id":"198374652000000001"},"score":145530}'

get/v1/submissions/{handle}

Resolve a write handle

The only correct way to learn what happened to a write. status moves queued → processing → pending_review → approved | rejected, or failed.

The answer is read from the live match or submission row, not just from the queue, so it keeps up with a moderator approving hours later. Once the row exists, match.id links to it and match.applied says whether it is live on the leaderboard.

Handles resolve for 30 days, then 404. Another owner's handle is an indistinguishable 404, so sequential handles cannot be probed across tenants.

Requires the boards:read scope.

Parâmetros

Nome	Local	Tipo	Descrição
handleobrigatório	path	string	The write handle returned by a POST, e.g. `sub_88213`. Resolves for 30 days.

Respostas

Status	Descrição
200	The submission state.
401	Missing, malformed, unknown or revoked API key. Present the key as `Authorization: Bearer sk_live_...`. Authentication runs before the rate limiter, so this response carries no `RateLimit-*` headers.
403	The key authenticated but may not do this: it is missing the scope the operation needs, or it is a `sk_test_` key, which is read-only and is never granted a write scope.
404	No such resource for this key's owner. A board that exists but belongs to somebody else returns exactly this, indistinguishable from one that does not exist — confirming existence would let a caller enumerate other people's boards.
422	The request was understood and refused. `code` says which rule: `invalid_request` (schema, including a `.strict()` body naming the unrecognized key), `board_type_mismatch`, `team_size_mismatch`, `duplicate_participant` or `unknown_player`.
429	Per-key token bucket: 600 reads and 60 writes per minute, tracked as separate buckets so a burst of writes cannot starve the polling that watches for their result. Rate limiting is evaluated BEFORE idempotency, so a 429 is never a replay.
500	Something failed on our side. The detail is deliberately generic — quote `request_id`, which joins your report to our log line.

Campo	Tipo	Descrição
handle	string	pattern ^sub_\d+$
status	"queued" \| "processing" \| "pending_review" \| "approved" \| "rejected" \| "failed"
board	string
match	MatchRef \| null

Resposta de exemplo · 200

{
  "handle": "sub_88213",
  "status": "approved",
  "board": "board_1",
  "match": {
    "id": 3,
    "url": "https://scoreboards.dev/leaderboards/111222333444555666/board_1",
    "applied": true
  }
}

Requisição de exemplo

curl 'https://api.scoreboards.dev/v1/submissions/sub_88213' \
  -H 'Authorization: Bearer sk_live_...'

Tipos de dados

Os objetos que compõem as respostas acima. Cada nome de campo e cada descrição vêm dos esquemas com que os handlers validam, então não têm como divergir do que a API de fato aceita e devolve.

Problem

Every /v1 failure, as application/problem+json (RFC 9457). Branch on code, never on title or detail — those are English prose for humans and may be reworded. The API is English-only and ignores Accept-Language.

Campo	Tipo	Descrição
type	string (uri)	A stable URI for this error class, e.g. `https://scoreboards.dev/errors/board-type-mismatch`.
title	string	Short human summary. Not machine-readable.
status	integer	Repeats the HTTP status code. min 400 · max 599
detail	string	What went wrong with THIS request, naming the offending field where there is one.
instance	string	The path that failed, e.g. `/v1/boards/board_1/matches`.
code	"invalid_request" \| "authentication_failed" \| "permission_denied" \| "not_found" \| "idempotency_conflict" \| "rate_limited" \| "board_type_mismatch" \| "team_size_mismatch" \| "duplicate_participant" \| "unknown_player" \| "board_locked" \| "internal_error"	The machine-readable contract. Stable across rewordings.
request_id	string	Correlation id, also returned as `X-Request-Id`. Quote it to support.

Board

A leaderboard, plus the derived contract for writing to it. id is the immutable game_name slug (board_123), not the display name — renaming a board never changes it.

Campo	Tipo	Descrição
id	string	Immutable public id. Use it in every path; it never changes, even when `display_name` does.
display_name	string
type	"Classic" \| "Highscore" \| "Time" \| "ELO" \| "League" \| "Rating"	Decides which write endpoint applies. ELO and League take matches; Classic, Highscore and Time take scores; Rating takes neither in v0.
sort	"desc" \| "asc"
team_size	integer	Participants per side on a match board. Each roster must carry exactly this many — unless `fixed_teams` is true, in which case each side is exactly ONE team entity.
fixed_teams	boolean	True when the board plays fixed team entities against each other. A match then names two `team_id`s, not `2 × team_size` players.
url	string
write	WriteContract \| null	What to POST. `null` on Rating boards, which have no v0 write endpoint.
validation_window_hours	integer	Hours a submission waits for a moderator. `0` auto-applies; `999` means manual review with no countdown.
auto_applies	boolean	True only when `validation_window_hours` is 0. When false, a write returns 202 and NOTHING changes on the leaderboard until a human clicks Approve in Discord.

WriteContract

What this board accepts, derived from its type and sort. operator is read-only — it is fixed when the board is created and cannot be overridden per submission.

Campo	Tipo	Descrição
endpoint	string
requires	string[]	Fields that must be present in the write body.
rejects	string[]	Fields this board type refuses. Sending one is a 422 naming the offending key.
operator	"elo" \| "league_points" \| "accumulate" \| "keep_highest" \| "keep_lowest"	How an approved submission is applied. Derived from the board type and sort; never a caller input.
score_unitopcional	string	Present on Time boards only. Scores are integer MILLISECONDS — `1:30` is `90000`.
k_factoropcional	integer
start_ratingopcional	integer
points_winopcional	integer
points_drawopcional	integer
points_lossopcional	integer

Entry

One participant's standing. elo is present on ELO boards and score on every other type; wins/draws/losses on ELO and League, submissions on Classic, Highscore and Time.

Campo	Tipo	Descrição
rank	integer	1-based, and correct on every page — a resumed page derives it with a COUNT rather than numbering from 1.
player_id	string	Namespaced: `discord:<snowflake>`, `custom:<name>`, `role:<id>` or `team:<id>`. Pass it back verbatim to `/entries/{player_id}` or `?player=`.
player_name	string
scoreopcional	number \| null
eloopcional	number \| null
winsopcional	integer \| null
drawsopcional	integer \| null
lossesopcional	integer \| null
submissionsopcional	integer \| null
last_sub	string \| null	RFC 3339 UTC. `null` when the participant has never submitted.

MatchParticipant

Campo	Tipo	Descrição
player_id	string
player_name	string
eloopcional	number \| null	The rating this participant held when the match was SUBMITTED, not when it was approved. Ten matches pushed back to back all carry pre-tournament ratings.

Match

One recorded match on an ELO or League board. id is old_id — per-board, so match URLs are always board-nested.

Campo	Tipo	Descrição
id	integer	Per-board match number. Not globally unique; always address it under its board.
board	string
team_size	integer
team1	MatchParticipant[]
team2	MatchParticipant[]
winner	"team1" \| "team2" \| "draw" \| null	On a League board this is DERIVED from the scoreline, never supplied by the caller.
team1_scoreopcional	number \| null	League boards only. Absent on ELO boards, which have no scoreline.
team2_scoreopcional	number \| null	League boards only. Absent on ELO boards, which have no scoreline.
status	"pending" \| "approved" \| "rejected" \| "adjusted" \| "set"	`pending` until reviewed. `adjusted` and `set` are moderator edits made in Discord.
applied	boolean	True only once the result is live on the leaderboard (`approved`, `adjusted` or `set`).
submitted_at	string \| null	RFC 3339 UTC, when the match was submitted — not when it was approved.
submitted_byopcional	string \| null	The Discord user who submitted it, or `api` for a submission made through this API.

MatchRef

The match a write produced, once the worker has created it.

Campo	Tipo	Descrição
id	integer
url	string
applied	boolean

DiscordParticipant

A real Discord member. Must be 17-20 digits: a shorter id is stored as a CUSTOM player of that name rather than as the member, so it is refused here instead of creating a row nobody owns.

Campo	Tipo	Descrição
discord_id	string	pattern ^\d{17,20}$

CustomParticipant

A player who is not a Discord member. custom: true is required and explicit — it is what stops a Discord id typed into name from creating a lookalike row. The internal key is built for you.

Campo	Tipo	Descrição
name	string	min length 1 · max length 100
custom	boolean

TeamParticipant

A fixed team entity. Valid only on a board with fixed_teams: true, one per side.

Campo	Tipo	Descrição
team_id	string	pattern ^team_\d+$

RoleParticipant

A Discord role competing as a single entity. Guild-owned boards only.

Campo	Tipo	Descrição
role_id	string	pattern ^role_\d+$

Participant

Exactly one of the four forms. Anything else is a 422 unknown_player.

BoardList

Cursor-paginated. Pass next_cursor back as ?cursor= for the next page.

Campo	Tipo	Descrição
data	Board[]
has_more	boolean	True when another page exists. Do not infer it from a short page — a page can be short and still have more.
next_cursor	string \| null	Pass back as `?cursor=`. `null` on the last page. Opaque: never parse it, never build one.

EntryList

Cursor-paginated on the composite (score, player_id), so a page boundary that falls inside a block of tied scores resumes mid-tie instead of skipping everyone on that score.

Campo	Tipo	Descrição
data	Entry[]
has_more	boolean	True when another page exists. Do not infer it from a short page — a page can be short and still have more.
next_cursor	string \| null	Pass back as `?cursor=`. `null` on the last page. Opaque: never parse it, never build one.

MatchList

Cursor-paginated, newest match first.

Campo	Tipo	Descrição
data	Match[]
has_more	boolean	True when another page exists. Do not infer it from a short page — a page can be short and still have more.
next_cursor	string \| null	Pass back as `?cursor=`. `null` on the last page. Opaque: never parse it, never build one.

EloMatchBody

The body an ELO board takes. An ELO board has no score field, so team1_score, team2_score and score are refused with a 422 naming the key. Each roster carries exactly the board's team_size — or exactly one team_id when fixed_teams is true.

Campo	Tipo	Descrição
team1	Participant[]	min items 1 · max items 8
team2	Participant[]	min items 1 · max items 8
winner	"team1" \| "team2" \| "draw"	Words, not codes. `draw` is a legal outcome and applies the zero-sum ELO delta for a tie.

LeagueMatchBody

The body a League board takes. League DERIVES the winner from the scoreline, so a caller-supplied winner is refused with a 422 — accepting it would let the caller contradict their own scores. Points come from the board's points_win/points_draw/points_loss.

Campo	Tipo	Descrição
team1	Participant[]	min items 1 · max items 8
team2	Participant[]	min items 1 · max items 8
team1_score	integer	min 0 · max 9007199254740991
team2_score	integer	min 0 · max 9007199254740991

ScoreSubmissionBody

The body a Classic, Highscore or Time board takes. On a Time board score is integer MILLISECONDS — 1:30 is 90000. Sending seconds is the single most likely integration bug on this API. What happens on approval is fixed by the board: Classic accumulates, Highscore keeps the maximum, Time keeps the minimum.

Campo	Tipo	Descrição
player	Participant	Exactly one of the four forms. Anything else is a 422 `unknown_player`.
score	integer	Integer. On a Time board this is MILLISECONDS: `1:30` is `90000`, not `90` and not `1.5`. min -9007199254740991 · max 9007199254740991

WriteAccepted

What a POST returns. It is a receipt, not a result: applied is false on every board with a validation window, and stays false until a moderator approves the submission in Discord.

Campo	Tipo	Descrição
handle	string	Poll `GET /submissions/{handle}` with this. Resolves for 30 days, then 404s. pattern ^sub_\d+$
board	string
status	"queued" \| "processing" \| "pending_review" \| "approved" \| "rejected" \| "failed"	On a 202 this is `queued` (or, rarely, `failed` — the worker ran and threw inside the wait budget); `approved` only on a 201. `pending_review` never appears here: it is what the HANDLE reports once the worker has posted the submission for review. Poll the handle for that.
applied	boolean	True only when the result is already live on the leaderboard. False on every 202.
queued_at	string	RFC 3339 UTC, when the write was enqueued. A replayed response repeats the ORIGINAL value.
matchopcional	MatchRef \| null	Present once the worker has created the match. Absent on a plain 202, which is the normal case.

Submission

The state of a write handle, read from the LIVE row rather than the queue — so it keeps up with a moderator approving or rejecting the match hours after the queue entry finished.

Campo	Tipo	Descrição
handle	string	pattern ^sub_\d+$
status	"queued" \| "processing" \| "pending_review" \| "approved" \| "rejected" \| "failed"
board	string
match	MatchRef \| null

Erros

Toda falha de um endpoint desta referência é um documento de problema RFC 9457 servido como application/problem+json. Ramifique pelo code: é a parte estável do contrato, enquanto title e detail são escritos para pessoas e podem ser reescritos. Um caso a prever: uma URL que não bate com rota nenhuma é respondida pela plataforma, não pela API, então uma requisição autenticada para um caminho digitado errado recebe um 404 em texto puro — confira o content type antes de fazer o parse de um corpo de erro.

A API é só em inglês e ignora Accept-Language. Isso é proposital: uma mensagem de erro que muda de idioma conforme o ambiente é mais difícil de pesquisar, não mais fácil. Esta documentação é traduzida; a API não é.

Toda resposta traz um X-Request-Id. Cite-o ao relatar um problema — é ele que liga o seu relato à nossa linha de log.

{
  "type": "https://scoreboards.dev/errors/invalid-request",
  "title": "Invalid request",
  "status": 422,
  "detail": "team1_score, team2_score: not allowed on this request",
  "instance": "/v1/boards/board_1/matches",
  "code": "invalid_request",
  "request_id": "req_8f2a1c4d6b90"
}

Código	Status	Quando aparece
invalid_request	400 · 413 · 422	Um corpo, um parâmetro de consulta ou um cursor não bateu com o esquema; o detalhe nomeia o campo problemático. Também vale para um corpo acima de 64 KB.
authentication_failed	401	Chave ausente, malformada, desconhecida ou revogada.
permission_denied	403	A chave não tem o scope — ou é uma chave de teste e o scope é de escrita.
not_found	404	Não existe esse quadro, entrada, partida ou handle para o dono desta chave. Um recurso alheio é indistinguível de um que não existe.
idempotency_conflict	409	O mesmo Idempotency-Key foi reutilizado com outro corpo, ou uma requisição idêntica ainda está em andamento.
rate_limited	429	A cota acabou. Espere os segundos indicados em Retry-After.
board_type_mismatch	422	Endpoint certo, quadro errado: uma pontuação enviada a um quadro de partidas, uma partida enviada a um quadro de pontuação, ou qualquer coisa enviada a um quadro Rating.
team_size_mismatch	422	Um lado não leva exatamente o team_size do quadro — ou um lado de um quadro de times fixos nomeia algo que não é exatamente um time.
duplicate_participant	422	O mesmo participante aparece duas vezes. A checagem é feita depois da resolução, então role_998877 e o snowflake puro 998877 contam como uma entidade só.
unknown_player	422	Um participante é inutilizável: um snowflake com menos de 17 dígitos, um cargo num quadro sem servidor do Discord, um time num quadro sem times fixos, ou um jogador personalizado enviado sem custom: true.
board_locked	409	O quadro não está aceitando escritas.
internal_error	500	Algo falhou do nosso lado. Tente de novo e cite o request_id se continuar.

Limites de uso

600 leituras e 60 escritas por minuto por chave, em dois baldes de tokens separados — uma rajada de escritas nunca deixa sem cota a consulta que espera o resultado delas. Os baldes se reabastecem continuamente, então uma rajada curta é permitida e o ritmo sustentado é limitado.

RateLimit-Reset é um número de segundos a partir de agora; X-RateLimit-Reset é um timestamp Unix. Descrevem o mesmo instante em unidades diferentes, e confundir um com o outro faz o cliente ou martelar a API ou dormir por décadas.

As duas famílias de cabeçalhos são enviadas em toda resposta após a autenticação.

Cabeçalho	Descrição
RateLimit-Limit	Requests allowed per minute for this key: 600 read, 60 write. Read and write quotas are separate buckets.
RateLimit-Remaining	Whole requests left in the current bucket.
RateLimit-Reset	DELTA-SECONDS until the quota is whole again. A duration, not a timestamp (IETF draft semantics).
X-RateLimit-Limit	Legacy spelling of `RateLimit-Limit`, same value.
X-RateLimit-Remaining	Legacy spelling of `RateLimit-Remaining`, same value.
X-RateLimit-Reset	The same instant as `RateLimit-Reset`, as a UNIX TIMESTAMP in seconds. Not a delay (legacy semantics).
Retry-After	Delta-seconds to wait before retrying. Sent on 429, and on the 409 that means an identical request is still in flight.
X-Request-Id	Correlation id for this request, echoed on every response including errors. An inbound `X-Request-Id` matching `[A-Za-z0-9._-]{1,64}` is honoured.
X-API-Lifecycle	Always `beta` today. Sent on EVERY /v1 response — including a 401 and a 404 — so a client learns the contract is provisional on its first call, without reading any documentation. The day it stops saying `beta`, the surface has been frozen and breaking changes will require a new version prefix; treat a change in this value as the signal to re-read the changelog.
Idempotent-Replayed	`true` when this response was replayed from a stored idempotency record rather than executed. Only set on POST responses.

Faltou alguma coisa?

Conte o que você está construindo. A v0 entrega leituras e três caminhos de escrita de propósito — criação de quadros, temporadas, webhooks de saída e cancelamento de partidas foram todos adiados até alguém de verdade pedir, e esse pedido vale mais que o nosso roadmap. O acesso à beta não é pedido aqui: isso acontece na seção API do seu painel.

Pergunte no nosso Discord