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 · DPB2Reads map element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Provides maps data and the operations listed below. Related types link to the values this API consumes or returns.
Reads maps tab element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Provides maps inventory data and the operations listed below. Related types link to the values this API consumes or returns.
Provides tier element class data and the operations listed below. Related types link to the values this API consumes or returns.
Reads map stash tab element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Provides map sub inventory info data and the operations listed below. Related types link to the values this API consumes or returns.
Provides map sub inventory key data and the operations listed below. Related types link to the values this API consumes or returns.
Provides math ex data and the operations listed below. Related types link to the values this API consumes or returns.
Provides math hepler data and the operations listed below. Related types link to the values this API consumes or returns.
Provides matrix data and the operations listed below. Related types link to the values this API consumes or returns.
Provides menu button data and the operations listed below. Related types link to the values this API consumes or returns.
Reads merchant panel element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Carry a named request and its arguments between components. Read inputs and outputs using the agreed message contract.
Reads metamorph summon element state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
Provides minimap icon data and the operations listed below. Related types link to the values this API consumes or returns.
Provides minimap icons dat data and the operations listed below. Related types link to the values this API consumes or returns.
Provides minimap icon wrapper data and the operations listed below. Related types link to the values this API consumes or returns.
Represents mini monolith in the current game state. Obtain the object from its owning API and refresh it after an area change.
Provides misc data and the operations listed below. Related types link to the values this API consumes or returns.
The client's MiscAnimated definitions; different rows may reference the same animated-object file.
Represents mission marker in the current game state. Obtain the object from its owning API and refresh it after an area change.
Represents mod affix in the current game state. Obtain the object from its owning API and refresh it after an area change.
Provides mods data and the operations listed below. Related types link to the values this API consumes or returns.
Provides mods dat data and the operations listed below. Related types link to the values this API consumes or returns.
Provides mod tier key data and the operations listed below. Related types link to the values this API consumes or returns.
Provides monolith data and the operations listed below. Related types link to the values this API consumes or returns.
Represents monolith in the current game state. Obtain the object from its owning API and refresh it after an area change.
Inspect a monster's current properties. Inherited object APIs provide identity, position and interaction state.
Inspect a monster's current properties. Inherited object APIs provide identity, position and interaction state.
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.