Skip to content
dartpilot
Esc
↑↓navigate↵open⌘Jpreview

Get a player

Returns a player’s profile, lifetime totals, personal records and current ratings. The target must be the API key owner or an accepted friend; anyone else returns 404. Current lobby and game ids are only included when they are public.

GET/players/{id}
Authorization
x-api-keyAPI key · headerrequired

A user (dp_) or organization (dp_org_) API key with read scopes.

Path parameters
idstringrequired

The entity id.

Responses
200

The player profile.

idstringrequired
namestringrequired
displayNamestring | nullrequired
imagestring | nullrequired
createdAtstringrequired
statusstringrequired
Allowed:onlineofflinein_game
currentLobbyIdstring | nullrequired
currentGameIdstring | nullrequired
lifetimePlayerLifetime | nullrequired
Show properties
Any of:
PlayerLifetime
gamesPlayedintegerrequired
min 0 · max 9007199254740991
winsintegerrequired
min 0 · max 9007199254740991
winRatePctnumber | nullrequired
dartsThrownintegerrequired
min 0 · max 9007199254740991
total180sintegerrequired
min 0 · max 9007199254740991
total140sintegerrequired
min 0 · max 9007199254740991
totalTonsintegerrequired
min 0 · max 9007199254740991
totalBullsintegerrequired
min 0 · max 9007199254740991
totalThreeInABedintegerrequired
min 0 · max 9007199254740991
totalCheckoutsintegerrequired
min 0 · max 9007199254740991
currentWinStreakintegerrequired
min 0 · max 9007199254740991
bestWinStreakintegerrequired
min 0 · max 9007199254740991
currentDailyStreakintegerrequired
min 0 · max 9007199254740991
bestDailyStreakintegerrequired
min 0 · max 9007199254740991
firstPlayedAtstring | nullrequired
lastPlayedAtstring | nullrequired
null
null
byGameTypePlayerGameTypeBreakdown[]required
Show properties
Array of PlayerGameTypeBreakdown
gameTypestringrequired
gamesPlayedintegerrequired
min 0 · max 9007199254740991
winsintegerrequired
min 0 · max 9007199254740991
recordsPlayerRecordsrequired
Show properties
bestAveragenumber | nullrequired
highestCheckoutnumber | nullrequired
most180sInGamenumber | nullrequired
mostDartsWinningCheckoutnumber | nullrequired
ratingsPlayerRating[]required
Show properties
Array of PlayerRating
gameTypestringrequired
scopestringrequired
ratingnumberrequired
deviationnumberrequired
gamesPlayedintegerrequired
min 0 · max 9007199254740991
lastRatedAtstring | nullrequired
400

Invalid request.

messagestringrequired
401

Missing or invalid API key.

messagestringrequired
403

The API key is missing a required scope or is the wrong type for this endpoint.

messagestringrequired
404

Entity not found.

messagestringrequired
429

Rate limit exceeded. See the Retry-After header.

messagestringrequired
500

Internal server error.

messagestringrequired
Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.dartpilot.app/v1/players/string' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Accept: application/json'
Response
{
  "id": "string",
  "name": "string",
  "displayName": "string",
  "image": "string",
  "createdAt": "string",
  "status": "online",
  "currentLobbyId": "string",
  "currentGameId": "string",
  "lifetime": {
    "gamesPlayed": 0,
    "wins": 0,
    "winRatePct": 0,
    "dartsThrown": 0,
    "total180s": 0,
    "total140s": 0,
    "totalTons": 0,
    "totalBulls": 0,
    "totalThreeInABed": 0,
    "totalCheckouts": 0,
    "currentWinStreak": 0,
    "bestWinStreak": 0,
    "currentDailyStreak": 0,
    "bestDailyStreak": 0,
    "firstPlayedAt": "string",
    "lastPlayedAt": "string"
  },
  "byGameType": [
    {
      "gameType": "string",
      "gamesPlayed": 0,
      "wins": 0
    }
  ],
  "records": {
    "bestAverage": 0,
    "highestCheckout": 0,
    "most180sInGame": 0,
    "mostDartsWinningCheckout": 0
  },
  "ratings": [
    {
      "gameType": "string",
      "scope": "string",
      "rating": 0,
      "deviation": 0,
      "gamesPlayed": 0,
      "lastRatedAt": "string"
    }
  ]
}

Was this page helpful?