dartpilot Public API

Read-only REST API for dartpilot games, lobbies, boards, players, and tournaments. Authenticate every request with an API key in the x-api-key header. Create a key from the API Keys section of your profile; see https://docs.dartpilot.app/api-keys/. Each key is granted read scopes (games, tournaments, account) when it is created; a request to an endpoint outside a key’s scopes returns 403. Responses carry an x-d1-bookmark header identifying the D1 version they were read from; send it back and the next session starts at least as new as that version. Read endpoints are served from an edge cache for 5-60 seconds; a request that sends x-d1-bookmark always misses that cache, so the header still guarantees a session at least as new as that version.

Rate limits: each API key is limited to 120 requests/minute, each principal (user or organization) to 600 requests/minute across all of its keys, and each client IP to 600 requests/minute. Requests over a limit return 429 with a Retry-After header.

Account

Identify the API key owner.

• GET
  Identify the API key owner/whoami

Games

Read the key owner’s games and their events.

• GET
  List games/games
• GET
  List live games/games/live
• GET
  List game events/games/{id}/events
• GET
  Get a live game summary/games/{id}/summary
• GET
  Get a game/games/{id}

Boards

Read public board status and the game currently on a board.

• GET
  Get board status/boards/{id}

Lobbies

Discover public lobbies and read the lobbies the key owner may view.

• GET
  List public lobbies/lobbies
• GET
  Get a lobby/lobbies/{id}

Players

Read player profiles, friends, statistics and game history for the key owner and their friends.

• GET
  List the key owner's friends/players/me/friends
• GET
  Get a player/players/{id}
• GET
  Get player statistics/players/{id}/statistics
• GET
  Get a player's game trend/players/{id}/trend
• GET
  List a player's recent games/players/{id}/games

Tournaments

Discover public tournaments and follow the key owner’s tournaments, their brackets, and live match games.

• GET
  List tournaments/tournaments
• GET
  Get a tournament match/tournaments/{id}/matches/{matchId}
• GET
  Get a tournament/tournaments/{id}

Webhooks

• POST
  dartpilot webhook eventeventDelivery