Stash Documentation
Integration GuidesAPI ReferenceWork with Us

Get player by ID

Retrieves an existing player by ID. Returns player information including profile data and in-game currency balance.

GET
/api/v1/player

Authorization

stash-hmac-signature<token>

HMAC signature generated by signing the request body with the Egress API key from Stash Studio. Used for secure server-to-server communication between game backends and Stash services.

In: header

Query Parameters

playerIdstring

The player ID to retrieve

Response Body

curl -X GET "https://loading/api/v1/player?playerId=string"
{
  "player": {
    "playerId": "string",
    "name": "string",
    "avatarUrl": "string",
    "language": "string",
    "inGameLevel": 0,
    "inGameCurrency": 0
  }
}
{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string",
      "property1": null,
      "property2": null
    }
  ]
}

How is this guide?