Open Scoreboard

Developers

Developer Platform

Open Scoreboard API

Technical documentation for the current v1 REST API, with copyable examples, route-by-route notes, and authenticated personal API key management.

OpenAPI schemaAuthentication
Public developer docs

Errors

The API returns structured JSON errors, stable request IDs, and standard rate-limit headers so integrators can debug failures quickly.

Available in v1

Plan for standard 4xx and 5xx responses plus a few Open Scoreboard-specific behaviors: 207 partial success for batch calls, 409 when a match is active or completed and therefore locked, and 429 when minute, daily, or monthly quotas are exceeded.

Error body{ error: { code, message, details? } }
Partial successHTTP 207
Quota backoffRetry-After on 429

Implementation notes

  • OpenScoreboard-Request-ID is present on success and error responses for correlation.
  • Pagination responses expose OpenScoreboard-Limit and OpenScoreboard-Next-Cursor headers.
  • Webhook secret rotation requires a valid Idempotency-Key header.

Endpoints

OpenAPI
GET/matches/{externalID}

Example error response

Read shape and headers, not just status codes, when handling failures.

Response

Errors always return an error object with code and message, and may include details.

JSON
{
  "error": {
    "code": "insufficient_scope",
    "message": "Missing required scope: matches.read"
  }
}
JavaScript
try {
  await api("/matches/match-5001");
}
catch (error) {
  console.error(error);
  // Also record the OpenScoreboard-Request-ID response header for support.
}