Path of Exile Developer Docs

Server Endpoint

https://api.pathofexile.com

Leagues

List Leagues

GET /league

Optional Query Parameters:

Returns:

Get League

GET /league/<league>

Optional Query Parameters:

Returns:

Get League Ladder

GET /league/<league>/ladder

Optional Query Parameters:

Each ladder only contains the top 15000 entries. Attempting to fetch entries beyond this will return an empty result.

Returns:

PvP Matches

List PvP Matches

GET /pvp-match

Optional Query Parameters:

Returns:

Get PvP Match

GET /pvp-match/<match>

Optional Query Parameters:

Returns:

Get PvP Match Ladder

GET /pvp-match/<match>/ladder

Optional Query Parameters:

Each ladder only contains the top 15000 entries. Attempting to fetch entries beyond this will return an empty result.

Returns:

Account Profile

Get Profile

GET /profile

Returns:

Account Characters

List Characters

GET /character

Returns:

Get Character

GET /character/<name>

Returns:

Account Stashes

List Stashes

GET /stash/<league>

Returns:

Get Stash

GET /stash/<league>/<stash_id>[/<substash_id>]

Returns:

Account Item Filters

Get Item Filters

GET /item-filter

Returns:

Get Item Filter

GET /item-filter/<id>

Returns:

Create Item Filter

POST /item-filter

Optional Query Parameters:

Request Body Parameters (JSON):

Returns:

Update Item Filter

POST /item-filter/<id>

Optional Query Parameters:

Request Body Parameters (JSON):

Returns:

Public Stashes

Get Public Stashes

GET /public-stash-tabs

Optional Query Parameters:

Returns:

Type Definitions

The majority of our APIs return JSON content to be consumed by applications. This section details the kind of structures to expect.

Types that begin with a question mark may be null or otherwise not be present.

League

Key Value Type Extra Information
id string the league's name
realm ?string pc, xbox, or sony
description ?string
rules ?array of LeagueRule
registerAt ?string date time (ISO8601)
event ?bool always true if present
url ?string a url link to a Path of Exile forum thread
startAt ?string date time (ISO8601)
endAt ?string date time (ISO8601)
timedEvent ?bool always true if present
scoreEvent ?bool always true if present
delveEvent ?bool always true if present

LeagueRule

Key Value Type Extra Information
id string examples: Hardcore, NoParties (SSF)
name string
description ?string

LadderEntry

Key Value Type Extra Information
rank uint
dead ?bool
retired ?bool
online ?bool
public ?bool
character object
↳ id string a unique 64 digit hexadecimal string
↳ name string
↳ level uint
↳ class string
↳ time ?uint time taken to complete the league objective in seconds
↳ score ?uint count of league objective completions
↳ experience ?uint
↳ depth ?object deepest Delve depth completed
  ↳ default ?uint
  ↳ solo ?uint
account ?Account

Account

Key Value Type Extra Information
name string
realm ?string pc, xbox, or sony
guild ?Guild
challenges ?object
↳ total uint
twitch ?object
↳ name string
↳ stream ?object
  ↳ name string
  ↳ image string
  ↳ status string

Guild

Key Value Type Extra Information
id uint
name string
tag string
points ?uint
statusMessage ?string
createdAt string date time (ISO8601)

PvPMatch

Key Value Type Extra Information
id string the match's name
realm ?string pc, xbox, or sony
startAt ?string date time (ISO8601)
endAt ?string date time (ISO8601)
url ?string a url link to a Path of Exile forum thread
description string
glickoRatings bool
pvp bool always true
style string Blitz, Swiss, or Arena
registerAt ?string date time (ISO8601)
complete ?bool always true if present
upcoming ?bool always true if present
inProgress ?bool always true if present

PvPLadderTeamEntry

Key Value Type Extra Information
rank uint
rating ?uint only present if the PvP Match uses Glicko ratings
points ?uint
games_played ?uint
cumulative_opponent_points ?uint
last_game_time ?string date time (ISO8601)
members array of PvPLadderTeamMember

PvPLadderTeamMember

Key Value Type Extra Information
account Account
character object
↳ id string a unique 64 digit hexadecimal string
↳ name string
↳ level uint
↳ class string
↳ league ?string
↳ score ?uint count of league objective completions
public ?bool always true if present

PublicStashChange

Key Value Type Extra Information
id string a unique 64 digit hexadecimal string
public bool if false then optional properties will be null
accountName ?string
lastCharacterName ?string
stash ?string the name of the stash
stashType string
league ?string the league's name
items array of Item

Item

Key Value Type Extra Information
verified bool
w uint
h uint
icon string
support ?bool always true if present
stackSize ?int
maxStackSize ?int
stackSizeText ?string
league ?string
id ?string a unique 64 digit hexadecimal string
influences ?object
elder ?bool always true if present
shaper ?bool always true if present
abyssJewel ?bool always true if present
delve ?bool always true if present
fractured ?bool always true if present
synthesised ?bool always true if present
sockets ?array of ItemSocket
socketedItems ?array of Item
name string
typeLine string
baseType string
identified bool
itemLevel ?int
ilvl int deprecated
note ?string
lockedToCharacter ?bool always true if present
lockedToAccount ?bool always true if present
duplicated ?bool always true if present
split ?bool always true if present
corrupted ?bool always true if present
cisRaceReward ?bool always true if present
seaRaceReward ?bool always true if present
thRaceReward ?bool always true if present
?properties ?array of ItemProperty
?notableProperties ?array of ItemProperty
?requirements ?array of ItemProperty
?additionalProperties ?array of ItemProperty
?nextLevelRequirements ?array of ItemProperty
talismanTier ?int
secDescrText ?string
utilityMods ?array of string
implicitMods ?array of string
ultimatumMods ?array of object
↳ type string text used to display ultimatum icons
↳ tier uint
explicitMods ?array of string
craftedMods ?array of string
enchantMods ?array of string
fracturedMods ?array of string
cosmeticMods ?array of string
veiledMods ?array of string random video identifier
veiled ?bool always true if present
descrText ?string
flavourText ?array of string
flavourTextParsed ?array of string
prophecyText ?string
isRelic ?bool always true if present
replica ?bool always true if present
incubatedItem ?object
↳ name string
↳ level uint
↳ progress uint
↳ total uint
frameType ?uint
artFilename ?string
hybrid ?object
↳ isVaalGem ?bool
↳ baseTypeName string
↳ properties ?array of ItemProperty
↳ explicitMods ?array of string
↳ secDescrText ?string
extended ?object
↳ category string
↳ subcategories array of string
↳ prefixes ?uint
↳ suffixes ?uint
x ?uint
y ?uint
inventoryId ?string
socket ?uint
colour ?string S, D, I, or G

ItemSocket

Key Value Type Extra Information
group uint
attr ?string S, D, I, G, A, or DV
sColour ?string R, G, B, W, A, or DV

ItemProperty

Key Value Type Extra Information
name string
values array
↳ 0 string
↳ 1 uint value type
displayMode uint
progress ?double rounded to 2 decimal places
type ?uint
suffix ?string

Character

Key Value Type Extra Information
id string a unique 64 digit hexadecimal string
name string
class string
league ?string
level uint
experience uint
expired ?bool always true if present
deleted ?bool always true if present
current ?bool always true if present
equipment ?array of Item
inventory ?array of Item
jewels ?array of Item
passives ?object
↳ hashes array of uint
↳ hashes_ex array of uint
↳ bandit_choice ?string one of Kraityn, Alira, Oak, or Eramir
↳ pantheon_major ?string one of TheBrineKing, Arakaali, Solaris, or Lunaris
↳ pantheon_minor ?string one of Abberath, Gruthkul, Yugul, Shakari, Tukohama, Ralakesh, Garukhan, or Ryslatha
↳ jewel_data dictionary of ItemJewelData the index value is the string value of the x property of an item from the jewels array in this request

ItemJewelData

Key Value Type Extra Information
type string
radius ?uint
radiusMin ?uint
radiusVisual ?string
subgraph ?object only present on cluster jewels
↳ groups dictionary of object
  ↳ proxy string skill hash of the placeholder node
  ↳ nodes array of string the list of nodes that belong to this group
  ↳ x float
  ↳ y float
  ↳ orbits array of uint orbits that are occupied by a node
↳ nodes dictionary of object
  ↳ skill string skill hash of the node
  ↳ name string
  ↳ icon string
  ↳ stats ?array of string
  ↳ isMastery ?bool always true if present
  ↳ group string
  ↳ orbit uint
  ↳ orbitIndex uint
  ↳ out array of string
  ↳ in array of string

StashTab

Key Value Type Extra Information
id string a 10 digit hexadecimal string
parent ?string a 10 digit hexadecimal string
name string
type string
index ?uint
metadata object
↳ public ?bool always true if present
↳ folder ?bool always true if present
↳ colour ?string 6 digit hex colour
children ?array of StashTab
items ?array of Item

ItemFilter

Key Value Type Extra Information
id string
filter_name string
realm string
description string
version string
public ?bool always true if present
filter ?string
validation ?object
↳ valid bool always true
↳ version ?string game version
↳ validated ?string date time (ISO8601)