Start with the client state
Check that the client is in game before reading player or area data.
Client state · DPB1Client state · DPB2Explore DPB1 and DPB2 by type, member or use case. Every reference includes its signatures, arguments, available results and links to related APIs.
Check that the client is in game before reading player or area data.
Client state · DPB1Client state · DPB2Discover typed objects and refresh their state after interaction or travel.
Object discovery · DPB1Object discovery · DPB2Use the bot, plugin and task contracts to integrate your own behavior.
Task contract · DPB1Task contract · DPB2This is an internal data class, you usually don't directly access this data.
Represents passive skill graph node in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents server effect in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents server stash tab in the current game state. Obtain the object from its owning API and refresh it after an area change.
Callback contract for set settings delegate. The Invoke signature below shows the arguments supplied to the callback.
Provides sextant data data and the operations listed below. Related types link to the values this API consumes or returns.
Provides shield data and the operations listed below. Related types link to the values this API consumes or returns.
Callback contract for should view item delegate. The Invoke signature below shows the arguments supplied to the callback.
Reads show ritual reward element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Provides shrine data and the operations listed below. Related types link to the values this API consumes or returns.
Represents shrine in the current game state. Obtain the object from its owning API and refresh it after an area change.
Reads single slot ui element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Inspect an available skill, its readiness and related properties. Check the appropriate skill-bar action before attempting to use it.
Reads skill bar element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Provides skill blacklist data and the operations listed below. Related types link to the values this API consumes or returns.
Configuration for skill blacklist settings. Properties below describe the available settings.
Reads skill element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Provides skill gem data and the operations listed below. Related types link to the values this API consumes or returns.
Reads skill gem hud element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Represents skill gem wrapper in the current game state. Obtain the object from its owning API and refresh it after an area change.
Provides skill id data and the operations listed below. Related types link to the values this API consumes or returns.
Provides skill name data and the operations listed below. Related types link to the values this API consumes or returns.
Reads skip tutorial element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Provides slow cache value data and the operations listed below. Related types link to the values this API consumes or returns.
Provides sockets data and the operations listed below. Related types link to the values this API consumes or returns.
Provides socketed gem data and the operations listed below. Related types link to the values this API consumes or returns.
Reads soclial pannel element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Provides sphere data and the operations listed below. Related types link to the values this API consumes or returns.
Provides split button data and the operations listed below. Related types link to the values this API consumes or returns.
Reads split stack ui element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
This reference covers the developer-facing declarations in the reviewed Release source snapshot, including inherited APIs through their base-type links. Product versions are documented separately so differences remain visible.