Consider helping out in updating the wiki for 3.4.0 - see Path_of_Exile_Wiki:To-do_list/3.4.0

Various people have reported issues with the ads on here. Make sure to report those advertisements

Gamepedia was upgraded to MediaWiki version 1.31 on Wednesday November 14th. To learn more about the upgrade and its effects click here.

Public stash tab API

From Path of Exile Wiki
Jump to: navigation, search

Public stash tab API is a basic JSON interface to obtain information relevant for general trade using Premium Stash Tabs for PC clients. Basically the interface serves global update information (considerable as a update-"stream") on any public stash tabs recognized by the game servers.

API doesn't contain any historical data and always returns the current state of stash tabs.[1]

URL

http://www.pathofexile.com/api/public-stash-tabs

Pagination

The JSON data is prefixed with the field "next_change_id" If you want the next page of update information append the next_change_id to the URL:

For example: http://www.pathofexile.com/api/public-stash-tabs?id=220-1652-744-1341-230

Docs

Official Docs

JSON

The subsections follow the format of the json.

Key Value description Type
next_change_id string
stashes See below array[assoc]

stashes

Key Value description Type
accountName account name the stash linked to. Can be null. string/null
lastCharacterName last character name of the player. Can be null. string/null
id unique stash id string
stash stash name. Can be null string/null
stashType NormalStash/PremiumStash/QuadStash/EssenceStash/CurrencyStash/MapStash/FragmentStash/DivinationCardStash string
items See below, items included in this stash array[assoc]
public public or not bool

items

items array may empty if user make stash private or league end.

Key Value description Type Key always present
abyssJewel bool no
additionalProperties See properties array[assoc] no
artFilename Divination Card string no
category maps, currency, jewels, gems, cards, flasks or category object (explained below) string/array[assoc] yes
corrupted bool no
cosmeticMods string array no
craftedMods master mods string array no
descrText description text string no
duplicated bool no
elder item was dropped in elder map bool no
enchantMods labyrinth mods string array no
explicitMods Mods under the line string array no
flavourText string array no
frameType See below integer yes
h slot height integer yes
icon item picture art url string yes
id item id, will NOT change if you use currency on it string yes
identified bool yes
ilvl item level integer yes
implicitMods Mods above the line string array no
inventoryId slot. 'Stash25', 'Stash3', etc. string no
isRelic bool no
league Standard/Hardcore/ string yes
lockedToCharacter bool no
maxStackSize integer no
name unique name string yes
nextLevelRequirements See requirements array[assoc] no
note Mostly item price string no
properties See below array[assoc] no
prophecyDiffText prophecy difficulty text string no
prophecyText string no
requirements See below array[assoc] no
secDescrText second description text string no
shaper item was dropped in shaper map bool no
socketedItems See items array[assoc] no
sockets See below, array of sockets array[assoc] no
stackSize integer no
support bool no
talismanTier integer no
typeLine item base type, mixed with affix name for magic/rare string yes
utilityMods flask utility mods string array no
verified bool yes
w slot width integer yes
x stash position x integer yes
y stash position y integer yes
'^[\\s]RaceReward$' Rare flag for race reward items. There can be few of them, so key is 'regular expression', instead of string bool no

category

Each array contains only one string.

Key Value description Type
accessories amulet, belt or ring array[string]
armour helmet, gloves, chest, shield, quiver, boots array[string]
jewels abyss array[string]
weapons twosword, bow, dagger, staff, claw, onesword, wand, oneaxe, twoaxe, sceptre, onemace, twomace array[string]

sockets

Key Value description Type
group group id integer
attr S, I, D, G, false (type is boolean for abyss). Stands for str, int, dex, generic?. G - white socket. string/boolean
sColour G, W, R, B, A. Stands for: green, white, red, blue, abyss (though not a colour but type). string

properties/requirements

Key Value description Type
name string
values array[0] is value, array[1] is valueTypes array
displayMode integer
type properties type integer
progress additionalProperties's Experience integer

valueTypes

Key Value description
0 white, or physical
1 blue for modified value
4 fire
5 cold
6 lightning
7 chaos

frameType

Key Value description
0 normal
1 magic
2 rare
3 unique
4 gem
5 currency
6 divination card
7 quest item
8 prophecy
9 relic

Further information and reading

https://www.reddit.com/r/pathofexiledev/comments/48i4s1/information_on_the_new_stash_tab_api/

Latest ID

If you want the most recent data you'll have to start from the end of the river.

Version History

Version Changes
2.2.0
  • Introduced to the game.

References

  1. Novynn (October 4, 2016). "Development Manifesto: 2.3.0 Balance". Path of Exile Dev subreddit. Retrieved October 4, 2016.