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.HeistAlertLevelUi
This Class let you interact with and retrieve info about Heist Alert Level Panel.
DPB1Class · Interface and panels
LokiPoe.InGameState.HeistBlueprintUi
This class let you interact with the Heist Blueprint reveal panel.
DPB1Class · Interface and panels
LokiPoe.InGameState.HeistBlueprintUi.BlueprintAgentSelectionUI
This class let you interact with the Heist Blueprint Agent Selection panel.
DPB1Class · Interface and panels
LokiPoe.InGameState.HeistContractUi
This class let you interact and retrieve info about the Heist Contract panels, to navigate the mine.
DPB1Class · Interface and panels
LokiPoe.InGameState.HeistContractUi.Agent
Provides agent data and the operations listed below. Related types link to the values this API consumes or returns.
DPB1Class · Interface and panels
LokiPoe.InGameState.HeistLockerUi
This Class let you interact with and retrieve info about Heist Locker Panel.
DPB1Class · Interface and panels
LokiPoe.InGameState.HelpUi
This class only tell you if the Help panel is open.
DPB1Class · Interface and panels
LokiPoe.InGameState.HideoutEditorUi
This class let you interact with the Hideout Editor panel (the panel used to import and export Ho, and edit all the Ho features.) The main usage of this class, is to Import a specific Ho layout.
DPB1Class · Interface and panels
LokiPoe.InGameState.HideoutSelectionUi
This class let you interact with the Hideout Selection panel.
DPB1Class · Interface and panels
LokiPoe.InGameState.HideoutSelectionUi.HideoutTemplate
Provides hideout template data and the operations listed below. Related types link to the values this API consumes or returns.
DPB1Class · Interface and panels
LokiPoe.InGameState.HideoutUnlockedUi
This class has only 1 property `IsOpened` and return true when the small label that let you know that a new Hideout is been unlocked is visible. This can be used to make sure you completed one of the areas that let you unlock new Ho. Just check for this class IsOpened property in Tick, while you clear the area, as soon as the property is true, you have completed the area and unlocked the Ho.
DPB1Class · Interface and panels
LokiPoe.InGameState.HorticraftingBenchPannelUi
This Class let you interact with and retrieve info about Horticrafting Bench Panel.
DPB1Class · Interface and panels
LokiPoe.InGameState.InstanceManagerUi
This class let you interact and retrieve info about the Instance manager, the window that appear if you press Ctrl when selecting a new world area.
DPB1Class · Interface and panels
LokiPoe.InGameState.InventoryUi
This class let you intercat and retrieve informations about your inventory and all equipped items.
DPB1Class · Interface and panels
LokiPoe.InGameState.InventoryUi.Sentinels
Provides sentinels data and the operations listed below. Related types link to the values this API consumes or returns.
DPB1Class · Interface and panels
LokiPoe.InGameState.Kingsmarch
Retrieve information and perform actions over various Kingsmarch panels.
DPB1Class · Interface and panels
LokiPoe.InGameState.Kingsmarch.DisenchantPanelUi
Retrieve information and perform actions over the Kingsmarch Disenchant panel.
DPB1Class · Interface and panels
LokiPoe.InGameState.Kingsmarch.HarbourPanelUi
Retrieve information and perform actions over the Kingsmarch Harbour panel.
DPB1Class · Interface and panels
LokiPoe.InGameState.Kingsmarch.HarbourPanelUi.FavoredResource
Provides favored resource data and the operations listed below. Related types link to the values this API consumes or returns.
DPB1Class · Interface and panels
LokiPoe.InGameState.Kingsmarch.HarbourPanelUi.Port
Provides port data and the operations listed below. Related types link to the values this API consumes or returns.
DPB1Class · Interface and panels
LokiPoe.InGameState.Kingsmarch.HarbourPanelUi.PrepareShipmentUi
Retrieve information and perform actions over the Kingsmarch Harbour Prepare Shipment panel.
DPB1Class · Interface and panels
LokiPoe.InGameState.Kingsmarch.HarbourPanelUi.PrepareShipmentUi.Product
Provides product data and the operations listed below. Related types link to the values this API consumes or returns.
DPB1Class · Interface and panels
LokiPoe.InGameState.Kingsmarch.HarbourPanelUi.Ship
Provides ship data and the operations listed below. Related types link to the values this API consumes or returns.
DPB1Class · Interface and panels
LokiPoe.InGameState.Kingsmarch.Job
Provides job data and the operations listed below. Related types link to the values this API consumes or returns.
DPB1Class · Interface and panels
LokiPoe.InGameState.Kingsmarch.KingsmarchPanelUi
Retieve information and perform actions over the Kingsmarch panel.
DPB1Class · Interface and panels
LokiPoe.InGameState.Kingsmarch.KingsmarchPanelUi.Resource
Represents a Kingsmarch resource quantity and, when available, its amount being processed.
DPB1Class · Interface and panels
LokiPoe.InGameState.Kingsmarch.MappingPanelUi
Reads mapping 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.MappingPanelUi.RunnableMap
Provides runnable map data and the operations listed below. Related types link to the values this API consumes or returns.
DPB1Class · Interface and panels
LokiPoe.InGameState.Kingsmarch.RecruitPanelUi
Retieve information and perform actions over the Kingsmarch Recruit panel.
DPB1Class · Interface and panels
LokiPoe.InGameState.Kingsmarch.RecruitPanelUi.Employers
Provides employers 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.