Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Optional accountName

accountName: string

Filters by account name within the first 15000 results, only available when type=league.

Optional class

class: string

Filters the ladder by class.

0: Scion 1: Marauder 2: Ranger 3: Witch 4: Duelist 5: Templar 6: Shadow

Optional difficulty

difficulty: 1 | "Normal" | "Cruel" | "Merciless" | "Eternal" | 2 | 3 | 4

Difficulty of the labyrinth, only available when type=labyrinth.

Optional limit

limit: number

Specifies the number of ladder entries to include.

Default: 20

Max: 200

Optional offset

offset: number

Specifies the offset to the first ladder entry to include.

Default: 0

Optional realm

realm: Realm

The realm of the requested entity

Default: pc

Optional start

start: string

Only available when type=labyrinth.

Optional track

track: 0 | 1

Adds unique IDs for each character returned. These can be used when name conflicts occur.

Default: 0

Optional type

type: "league" | "pvp" | "labyrinth"

Specifies the type of ladder.

Default: league

Generated using TypeDoc