Namespace Characters

Index

Namespaces

SkillTree

Classes

Interfaces

Depth

Functions

Functions

Const get

get(accountName: string, options?: RealmOptions): Promise<Character[]>

remarks

Requires sessionId to be set in Settings if profile or character tab is private.

endpoint

https://api.pathofexile.com/character-window/get-characters

throws

APIError

Parameters
- accountName: string
- Optional options: RealmOptions
Returns Promise<Character[]>

A list of characters of an account

Const getItems

getItems(accountName: string, character: string, options?: RealmOptions): Promise<Items>

remarks

Requires sessionId to be set in Settings if profile or character tab is private.

endpoint

https://api.pathofexile.com/character-window/get-items

throws

APIError

Parameters
- accountName: string
- character: string
- Optional options: RealmOptions
Returns Promise<Items>

Const getPassiveSkills

getPassiveSkills(accountName: string, character: string, options?: RealmOptions): Promise<PassiveSkills>

remarks

Requires sessionId to be set in Settings if profile or character tab is private.

endpoint

https://api.pathofexile.com/character-window/get-passive-skills

throws

APIError

Parameters
- accountName: string
- character: string
- Optional options: RealmOptions
Returns Promise<PassiveSkills>

Generated using TypeDoc