Skip to main content

Getting Player's Progress

Whalepass.gg

To test a specific DRAFT Battlepass, add X-Battlepass-Id header to request

Token TypeLocationFormatWhere To Find
Header TokenX-API-KEYX-API-KEY: YOURTOKENhttps://dashboard.whalepass.gg/api-key
Header TokenX-Battlepass-IdX-Battlepass-Id: YOURTOKENhttps://dashboard.whalepass.gg/campaigns
Request ParamplayerId{ "playerId": "string" }You can find in response
Request ParamgameId{ "gameId": "string" }https://www.whalepass.gg/documentation/tutorial#finding-your-game-id

Request:

GET https://api.whalepass.gg/players/{playerId}/progress?gameId={gameId}

Expected Response:

{
"player": {
"id": "string",
"externalPlayerId": "string",
"gameId": "string",
"userId": "string",
"accountConnected": true,
"createdAt": "2023-12-27T10:58:40.064Z",
"updatedAt": "2023-12-27T10:58:40.064Z"
},
"battlepassProgress": {
"battlepassId": "string",
"currentExp": 0,
"lastCompletedLevel": 0,
"levels": [
{
"id": "string",
"battlepassId": "string",
"level": 0,
"expRequired": 0,
"active": true,
"freeTierRewards": [
{
"id": "string",
"gameId": "string",
"battlepassId": "string",
"name": "string",
"amount": 0,
"amountInDecimal": 0,
"mediaUrl": "string"
}
],
"premiumTierRewards": [
{
"id": "string",
"gameId": "string",
"battlepassId": "string",
"name": "string",
"amount": 0,
"amountInDecimal": 0,
"mediaUrl": "string"
}
],
"completed": true
}
],
"challenges": [
{
"id": "string",
"battlepassId": "string",
"name": "string",
"startDate": "2023-12-27T10:58:40.064Z",
"endDate": "2023-12-27T10:58:40.064Z",
"active": true,
"premium": true,
"rewards": [
{
"id": "string",
"gameId": "string",
"battlepassId": "string",
"name": "string",
"amount": 0,
"amountInDecimal": 0,
"mediaUrl": "string"
}
],
"completed": true
}
]
}
}