Start with the client state
Check that the client is in game before reading player or area data.
Client state · DPB1Client state · DPB2DreamPoeBot developer reference
Find the API.
Build the capability.
Explore DPB1 and DPB2 by type, member or use case. Every reference includes its signatures, arguments, available results and links to related APIs.
2,215 types
14,236 members
91,072 named values
DPB1 · 0.3.29.47DPB2 · 0.4.5.88Reviewed 2026-10-02
Find objects, then act
Discover typed objects and refresh their state after interaction or travel.
Object discovery · DPB1Object discovery · DPB2Build on the bot lifecycle
Use the bot, plugin and task contracts to integrate your own behavior.
Task contract · DPB1Task contract · DPB2API catalog
Find the capability you need
DPB1Class · Interface and panels
LokiPoe.InGameState.Kingsmarch.RecruitPanelUi.Recruit
Provides recruit data and the operations listed below. Related types link to the values this API consumes or returns.
DPB1Class · Interface and panels
LokiPoe.InGameState.Kingsmarch.RewardPanelUi
Retieve information and perform actions over the Kingsmarch Reward panel.
DPB1Class · Interface and panels
LokiPoe.InGameState.Kingsmarch.Worker
Provides worker data and the operations listed below. Related types link to the values this API consumes or returns.
DPB1Class · Interface and panels
LokiPoe.InGameState.Kingsmarch.WorkersPanelUi
Reads workers panel ui state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
DPB1Class · Interface and panels
LokiPoe.InGameState.Kingsmarch.WorkersPanelUi.AssignedWorker
Provides assigned worker data and the operations listed below. Related types link to the values this API consumes or returns.
DPB1Class · Interface and panels
LokiPoe.InGameState.Kingsmarch.WorkersPanelUi.AvaiableWorker
Provides avaiable worker data and the operations listed below. Related types link to the values this API consumes or returns.
DPB1Class · Interface and panels
LokiPoe.InGameState.KiracMissionsUi
Retrieve informations and let you interact with the Kirac Mission interface.
DPB1Class · Interface and panels
LokiPoe.InGameState.LabMetamorphUi
This class let you interact with the Methamorph device in the Laboratory area.
DPB1Class · Interface and panels
LokiPoe.InGameState.LabyrinthMapSelectorUi
This class let you interact with the panel to select the labitinth difficult and activate the lab.
DPB1Class · Interface and panels
LokiPoe.InGameState.LanternOfArimorUi
This Class let you interact with and retrieve info about The Lantern Of Arimor Panel.
DPB1Class · Interface and panels
LokiPoe.InGameState.LanternOfArimorUi.NecropolisInventoryControlWrapper
Provides necropolis inventory control wrapper data and the operations listed below. Related types link to the values this API consumes or returns.
DPB1Class · Interface and panels
LokiPoe.InGameState.LegionCocoonWindowUi
Reads legion cocoon window ui state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
DPB1Class · Interface and panels
LokiPoe.InGameState.MapDeviceUi
This class let you interact with the Map device panel. Please note: The MapDevice panell is the panell that you can open from the map device NOT in the Hideout. For the Hideout map device, you must use the class MasterDeviceUi. The reason for this strange name convention reside in the history of Path of exile, when the map device were only aviable in a special zone not used anymore.
DPB1Class · Interface and panels
LokiPoe.InGameState.MapUi
Retrieve informations about the Ingame Minimap and Large Minimap.
DPB1Class · Interface and panelsDeprecated
LokiPoe.InGameState.MasterDeviceUi
This class let you interact with the Map device panel while in your Hideout.. Please note: The MasterDevice panell is the panell that you can open from the map device in the Hideout. For the non Hideout map device, you must use the class MapDeviceUi. The reason for this strange name convention reside in the history of Path of exile, when the map device were only aviable in a special zone not used anymore.
DPB1Class · Interface and panels
LokiPoe.InGameState.MasterDeviceUi.ZanaMod
Provides zana mod data and the operations listed below. Related types link to the values this API consumes or returns.
DPB1Class · Interface and panels
LokiPoe.InGameState.MercenaryEncounterUi
Let you interact and get informations about the Mercenarie you encounter in zones and maps.
DPB1Class · Interface and panels
LokiPoe.InGameState.MercenaryEncounterUi.MercenarySkill
Provides mercenary skill data and the operations listed below. Related types link to the values this API consumes or returns.
DPB1Class · Interface and panels
LokiPoe.InGameState.MercenaryEncounterUi.MercenarySupportGem
Provides mercenary support gem data and the operations listed below. Related types link to the values this API consumes or returns.
DPB1Class · Interface and panels
LokiPoe.InGameState.MercenaryOptionsUi
Let you retrieve infos and interact with the Buttons to Revive and open inventory of your mercenary.
DPB1Class · Interface and panels
LokiPoe.InGameState.MercenaryOptionsUi.MercenaryOption
Provides mercenary option data and the operations listed below. Related types link to the values this API consumes or returns.
DPB1Class · Interface and panels
LokiPoe.InGameState.MerchantUI
Retrieve informations about the Ingame Merchant Ui. This class is compatible with POE.
DPB1Class · Interface and panels
LokiPoe.InGameState.MetamorphSummonUi
This class let youinteract with the small icon that let you summon the Methamorph device.
DPB1Class · Interface and panels
LokiPoe.InGameState.MetamorphUi
This class let you interact with the Methamorph device in areas that are not the Laboratory (to interact with the laboratory device use `LabMetamorphUi`).
DPB1Class · Interface and panels
LokiPoe.InGameState.MetamorphUi.Ingredient
Provides ingredient data and the operations listed below. Related types link to the values this API consumes or returns.
DPB1Class · Interface and panels
LokiPoe.InGameState.MicrotansactionShopPannelUi
This Class let you interact with and retrieve info about Microtransaction Shop Panel
DPB1Class · Interface and panels
LokiPoe.InGameState.MirroredTabletUi
Reads mirrored tablet ui state and exposes the listed interface operations. Check visibility before using panel-specific values or actions.
DPB1Class · Interface and panels
LokiPoe.InGameState.NotificationData
Provides notification data data and the operations listed below. Related types link to the values this API consumes or returns.
DPB1Class · Interface and panels
LokiPoe.InGameState.NotificationHud
This class let you interact with all the Notifications windows that appear when people invite you in a group, send you trade requests etc etc. Pls note: This option MUST be enabled ingame to allow you to see this notifications. This windows are displayed for a short period of time, so if your code is ment to use this feature, your code must account for this.
DPB1Class · Interface and panels
LokiPoe.InGameState.NpcDialogUi
This class let youinteract and retrieve info about the dialog panel, to talk with npc.
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.