Skip to main content

Getting Player's Base Progress

Whalepass.gg

Unlike https://www.whalepass.gg/documentation/get_player_progress, This endpoint returns a lean response where you can get users basic progress elements like currentExp and lastCompletedLevel

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/base?gameId={gameId}

Expected Response:

{
"playerId": "string",
"externalPlayerId": "string",
"gameId": "string",
"battlepassId": "string",
"currentExp": 0,
"lastCompletedLevel": 0
}