...
...
...
...
...
...
...
...
...
...
...
...

API Resources

For updates and general questions feel free to join the server at https://discord.gg/YTt2AdG.

id

Description

Latest change ID from the top of the river and the time it was fetched.

Reply fields
Param Type Condition Description
id string - The change ID
time ISO 8601 UTC time - Time the change ID was fetched
Description

List of current leagues. Entries are sorted such that event leagues appear first, followed by the challenge leagues and then the permanent leagues. SSF and private leagues are omitted.

Reply fields
Param Type Condition Description
id uint - Unique ID of the league
name string - Unique name of the league (as it appears in the official API)
display string If available Formatted league name for display, usually shortened
hardcore bool - The league is hardcore
upcoming bool - The league has not started yet
active bool - The league is currently ongoing
event bool - The league is an event league (eg Flashback)
challenge bool - The league is a challenge league (eg Incursion)
start ISO 8601 UTC time If available Start date of the league
end ISO 8601 UTC time If available End date of the league
Description

All items found in the stash API and their defining properties.

Reply fields
Param Type Condition Description
id uint - Unique ID
name string - Name of the item
type string Situational Additional base type field
category string - Primary category the item belongs to. Categories can be found under the category api.
group string - Secondary category the item belongs to. Groups can be found under the category api.
frame uint - Numeric representation of the item's rarity (eg normal/unique). Same as official usage.
mapSeries uint | null category=map 5 for Synthesis, 1 for Awakening, etc
mapTier uint | null category=map Tier of map, if applicable
baseIsShaper bool category=base The base has shaper influence
baseIsElder bool category=base The base has elder influence
baseItemLevel uint category=base Item level of base
gemLevel uint category=gem Level of gem (1-21)
gemQuality uint category=gem Quality of gem (0-23)
gemIsCorrupted bool category=gem The gem is corrupted
enchantMin float | null category=enchantment Enchantment's minimum has numeric value
enchantMax float | null category=enchantment Enchantment's maximum has numeric value
stackSize uint | null Item is stackable Default stack size of item type
linkCount uint | null Item has significant links For weapons/armour only (5 or 6)
variation string There are multiple instances of the same item but with different properties Certain items (eg Vessel of Vinktar or Doryanis Invitation) tend to have variations, this field is to tell them apart.
icon string - Icon of the item
Description

Get player character names found through the stash API. If a player has listed an item in a public stash tab, that character name is recorded.

Request parameters
Param Required Description
account Yes Case-insensitive account name
Reply fields
Param Type Condition Description
character string - Character name
league string - In league
found ISO 8601 UTC time - Time the character was first found
seen ISO 8601 UTC time - Time the character was last seen
Description

Get player account names found through the stash API. If a player has listed an item in a public stash tab, that account name is recorded.

Request parameters
Param Required Description
character Yes Case-insensitive character name
Reply fields
Param Type Condition Description
account string - Account name
found ISO 8601 UTC time - Time the account was first found
seen ISO 8601 UTC time - Time the account was last seen
Description

List of categories and groups currently in use.

Reply fields
Param Type Condition Description
id uint - Unique id of the category
name string - Unique name of the category
display string | null If set Display name of the category
groups list (group) - List of groups associated with the category. Named separately from categories.

get

Description

Returns price and item data for specified league and category. Items are listed in decreasing order from most expensive to least expensive. Request fields are case-insensitive. It's advisable to use a singular request to the compact API, rather than multiple requests to this API.

Request parameters
Param Required Description
league Yes League name
category Yes Category name (see category API)
Reply fields
Param Type Condition Description
... ... - < all parameters exactly from itemdata api >
... ... - < all parameters exactly from compact api >
change float - Price compared to 7 days ago as percentage
history list (float) - Mean prices from last 7 days. Last element is current mean.
Description

Return price data (id, mean, median, mode, min, max, total, daily, exalted) of all items of the provided active league. IDs can be found in itemdata API described above.

Request parameters
Param Required Description
league Yes Valid league name
Reply fields
Param Type Condition Description
id uint - Unique id of the item (see itemdata api)
mean float - Mean average price
median float - Median average price
mode float - Mode average price
min float - Min accepted average price
max float - Max accepted average price
exalted float - Mean price in exalted
total uint - Total nr of items found
daily uint - Nr of items found per 24h
current uint - Nr of items currently on sale
accepted uint - Nr of items accepted for price calculation
Description

Retrieves information about a specific item.

Request parameters
Param Required Description
id Yes Numeric id of an item
Reply fields
Param Type Condition Description
... ... - < all parameters exactly from itemdata api >
leagues list - List of leagues the item has appeared in and its last known prices
Description

Finds prices from past leagues. Use item api to find list of applicable leagues.

Request parameters
Param Required Description
id Yes Item ID
league Yes League name
Reply fields
Param Type Condition Description
time ISO 8601 UTC time - Time the price was collected
mean float - Mean average price
median float - Median average price
mode float - Mode average price
daily uint - Nr of items found per 24h
current uint - Nr of items currently on sale
accepted uint - Nr of items accepted for price calculation
Description

Get all item listings for an account, including the time listed, last updated, how many are listed and how many are priced. Allows filtering out items without a price. Only tracks items that are available through the itemdata api.

Request parameters
Param Required Description
league Yes League name
account Yes Case-insensitive account name
Reply fields
Param Type Condition Description
... ... - < all parameters exactly from itemdata api >
discovered ISO 8601 UTC time - Time the item was first discovered
updated ISO 8601 UTC time - Time the item was last updated
count uint - How many of the item is the user selling
buyout list (buyout) - Price listings for the item