`lobby`

The cached lobby state — currency, class, rank, friends and dungeons.

Read straight from what the server has already pushed, so it costs no round trip and is safe to poll. Blocks the server has not sent yet come back empty rather than absent.

In Session & character.

Request

POST /api/v1/sessions/{accountKey}/actions/lobby

Takes no arguments.

Response

The lobby snapshot: currencies, class progress, rank, open dungeons, friends and the quest log.

Field	Type	Meaning
`currencies[]`	object[]	`{type, name, value}` — gold, Red Shards and the rest, named rather than left as ids.
`rank`	object	The ranked card. Empty `{}` when the account has no rank this season.
`dungeons[]`	object[]	The dungeons currently open, with the `tag` and `gameType` that `selectDungeon` takes.
`friends[].status`	string	`offline`, `lobby`, `in_game` and so on, named rather than numeric.

Example response

{
  "currencies": [
    { "type": 1, "name": "Gold", "value": 184320 },
    { "type": 2, "name": "Red Shard", "value": 40 }
  ],
  "classLevel": { "level": 20, "exp": 41200 },
  "classEquip": [
    { "index": 0, "requiredLevel": 1, "type": 1, "kind": "Perk", "name": "Combo Attack" },
    { "index": 1, "requiredLevel": 4, "type": 2, "kind": "Skill", "name": "Sprint" }
  ],
  "rank": {
    "rankId": "Novice I", "rankPoint": 120, "needPoint": 200,
    "characterClass": "Fighter", "season": "Season 7", "unlockedCards": []
  },
  "mmr": [ { "gameType": 1, "rankId": "Novice I", "placementsLeft": 0 } ],
  "arenaStats": [],
  "dungeons": [
    { "gameType": 1, "tag": "Goblin_Caves", "pool": { "gearPoolIndex": 0 } },
    { "gameType": 2, "tag": "Ruins", "pool": { "gearPoolIndex": 1 } }
  ],
  "workshops": [],
  "friends": [ { "name": "Alice", "status": "lobby" } ],
  "invites": [],
  "questLog": [],
  "newParcels": 0,
  "accountStatus": {}
}

Errors

Code	When
`action_failed`	No character is in the lobby.

lobby

Request

Response

Example response

Errors

See also

`lobby`