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 · DPB2Provides fragment tab data and the operations listed below. Related types link to the values this API consumes or returns.
Interaction with the Tablets sub category.
Interaction with the Trials sub category.
Provides maps tab data and the operations listed below. Related types link to the values this API consumes or returns.
Provides map info data and the operations listed below. Related types link to the values this API consumes or returns.
Provides ritual tab data and the operations listed below. Related types link to the values this API consumes or returns.
Provides socketable tab data and the operations listed below. Related types link to the values this API consumes or returns.
Interact with the Trial of Chaos / Ultimatum offering panel. For building the Vaal Temple, use VaalTempleConsoleUi instead.
Represent The Genesis Tree.
Provides womb data and the operations listed below. Related types link to the values this API consumes or returns.
Retrieve informations about the Ingame TradePriceItemDialog, the dialog window that let you price items. This class is compatible with POE2.
This class let you interact with the Trade window.
Access to the Trial of the Sekhemas map, its rooms, resources and navigation controls.
This class only check if the Tutorial panel is displayed, its purpose is only to close the tutorial and clean the main interface.
This class let you interact and retrieve info about the Vaal Temple Console panel.
A tile of the temple map. Reacquire after placing or changing rooms.
A selectable room card in the console's current hand. Reacquire after changing the hand.
Tooltip information shared by map tiles and room cards.
This class retrieve informations about the actual Timer visible in the game interface.
This class let you interact with the world panel, the window that appear when you interact with a Waypoint or map device.
Provides waypoint data wrapper data and the operations listed below. Related types link to the values this API consumes or returns.
Class to interact with the game using keyboard.
This is the default binding keys for all the game actions.
Configuration for category settings. Properties below describe the available settings.
Provides keys combo data and the operations listed below. Related types link to the values this API consumes or returns.
Provides production config data and the operations listed below. Related types link to the values this API consumes or returns.
InstanceInfo usually retrive informations relative to the current Instance or state of the game not UI related.
This class give informations about the actual Wisp and Fuel in the Azmeri wood.
This class offer informations about CurrencyExchange.
Provides currency exchange order data and the operations listed below. Related types link to the values this API consumes or returns.
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.