List the key owner's friends

Lists the API key owner’s accepted friends, online first. Lifetime stats come from the same rollup as the MCP friend tool. currentLobbyId and currentGameId are only returned when the friend is in a public lobby or public game.

GET/players/me/friends

Authorization

x-api-keyAPI key · headerrequired

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

Query parameters

afterstring

Opaque cursor from the previous page's paging.nextCursor.

limitinteger

Number of items to return per page.

min 1 · max 50 · default: 20

Responses

200

A page of friends.

itemsFriend[]required

Show properties

Array of Friend

idstringrequired

namestringrequired

displayNamestring | nullrequired

imagestring | nullrequired

onlinebooleanrequired

statusstringrequired

Allowed:onlineofflinein_game

currentLobbyIdstring | nullrequired

currentGameIdstring | nullrequired

gamesPlayedintegerrequired

min 0 · max 9007199254740991

winsintegerrequired

min 0 · max 9007199254740991

winRatePctnumber | nullrequired

total180sintegerrequired

min 0 · max 9007199254740991

lastPlayedAtstring | nullrequired

lastSeenAtstring | nullrequired

pagingPagingrequired

Show properties

nextCursorstring | 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

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

afterqueryOpaque cursor from the previous page's `paging.nextCursor`.limitqueryNumber of items to return per page.

Request

curl -X GET 'https://api.dartpilot.app/v1/players/me/friends' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Accept: application/json'

const response = await fetch("https://api.dartpilot.app/v1/players/me/friends", {
  method: "GET",
  headers: {
    "x-api-key": "YOUR_API_KEY",
    "Accept": "application/json"
  }
});

import requests

response = requests.get(
    "https://api.dartpilot.app/v1/players/me/friends",
    headers={
        "x-api-key": "YOUR_API_KEY",
        "Accept": "application/json"
    },
)

Response

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "displayName": "string",
      "image": "string",
      "online": true,
      "status": "online",
      "currentLobbyId": "string",
      "currentGameId": "string",
      "gamesPlayed": 0,
      "wins": 0,
      "winRatePct": 0,
      "total180s": 0,
      "lastPlayedAt": "string",
      "lastSeenAt": "string"
    }
  ],
  "paging": {
    "nextCursor": "string"
  }
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}

{
  "message": "string"
}