Get an item
One product in depth: prices, 7 days hourly, a year daily and the order book.
Everything about one product. hourly covers the last 7 days and daily the last 365, both oldest first. topOrders are the 10 best open buy orders and cheapestListings the 10 cheapest listings. For older prices, use price history.
The key is a product key, for example diamond or netherite_sword[sharpness:5,unbreaking:3]. URL encode it: brackets, commas and colons all need escaping.
Authentication
Cached for
Data updates
Path parameters
keystringrequiredProduct key. Find keys with
GET /v1/items.
Response
The item.
itemobjectAn Item with the extra detail fields below.
ShowHide16 child fields
keystringUnique product key: the item id, plus the variant in square brackets when there is one. Examples:
diamond,elytra[mending,unbreaking:3],potion[poison]. Use it withproduct=filters and/v1/items/{key}.itemstringMinecraft item id without the
minecraft:namespace, for examplenetherite_sword. Many products can share one item id.namestringDisplay name, for example
Potion of Poison.variantstringWhat sets this product apart from the plain item. Empty for plain items. See variants for the rules.
categorystring | nullOne of
combat,tools,valuables,drops,food,potions,blocksormisc.detailsProductDetails | nullStructured extras such as enchantments, shulker box contents or a custom name.
ShowHide5 child fields
enchantmentsEnchantment[]Enchantments on the item itself, sorted by id. Left out when there are none.
ShowHide2 child fields
idstringEnchantment id without the
minecraft:namespace, for examplesharpness.levelintegerEnchantment level, starting at 1.
storedEnchantmentsEnchantment[]Enchantments stored in an enchanted book. Left out for every other item.
ShowHide2 child fields
idstringEnchantment id without the
minecraft:namespace, for examplesharpness.levelintegerEnchantment level, starting at 1.
contentsContainerEntry[]What a shulker box holds, one entry per item id with counts added together, largest first.
ShowHide2 child fields
itemstringItem id, for example
netherite_sword.countintegerTotal number of that item in the box.
customNamestringThe name shown in game when it differs from the default item name. DonutSMP renames some items, for example
Dried Ghaston a skeleton skull.flightDurationintegerFlight duration of a firework rocket, from 1 to 3.
pricesPrice | nullCurrent market figures.
ShowHide10 child fields
pricenumber | nullMarket price per item: the median unit price of the 5 cheapest open listings.
nullwhen nothing is listed.lownumber | nullCheapest open listing, per item.
mediannumber | nullMedian unit price across every open listing of the product.
bidnumber | nullBest open buy order, per item. Lowball orders under 25% of the market price are ignored unless they have already been filled for at least 1%.
listingsintegerNumber of open auction listings.
quantityintegerItems for sale across those listings.
ordersintegerNumber of open buy orders counted towards
bid.demandintegerItems those buy orders still want.
orderValuenumberMoney those buy orders would still pay out: the sum of price times remaining amount.
updatedAttimestampWhen these figures were computed.
change1dnumber | nullPrice change since yesterday as a fraction:
0.05is 5% up.change7dnumber | nullPrice change over 7 days as a fraction.
shardCostinteger | nullPrice in the shard shop, when it is sold there.
hourlyPricePoint[]Last 7 days, one point per hour.
ShowHide9 child fields
ttimestampStart of the hour or day this point covers, in UTC.
pricenumber | nullMarket price at the end of the period.
lownumber | nullCheapest listing at the end of the period.
mediannumber | nullMedian listing at the end of the period.
bidnumber | nullBest buy order at the end of the period.
listingsintegerOpen listings at the end of the period.
quantityintegerItems for sale at the end of the period.
ordersintegerOpen buy orders at the end of the period. Only in the full price history.
demandintegerItems those buy orders still wanted. Only in the full price history.
dailyPricePoint[]Last 365 days, one point per day.
ShowHide9 child fields
ttimestampStart of the hour or day this point covers, in UTC.
pricenumber | nullMarket price at the end of the period.
lownumber | nullCheapest listing at the end of the period.
mediannumber | nullMedian listing at the end of the period.
bidnumber | nullBest buy order at the end of the period.
listingsintegerOpen listings at the end of the period.
quantityintegerItems for sale at the end of the period.
ordersintegerOpen buy orders at the end of the period. Only in the full price history.
demandintegerItems those buy orders still wanted. Only in the full price history.
topOrdersOrder[]The 10 best open buy orders.
ShowHide10 child fields
idintegerStable id of the buy order.
productProductWhat the order wants to buy.
ShowHide6 child fields
keystringUnique product key: the item id, plus the variant in square brackets when there is one. Examples:
diamond,elytra[mending,unbreaking:3],potion[poison]. Use it withproduct=filters and/v1/items/{key}.itemstringMinecraft item id without the
minecraft:namespace, for examplenetherite_sword. Many products can share one item id.namestringDisplay name, for example
Potion of Poison.variantstringWhat sets this product apart from the plain item. Empty for plain items. See variants for the rules.
categorystring | nullOne of
combat,tools,valuables,drops,food,potions,blocksormisc.detailsProductDetails | nullStructured extras such as enchantments, shulker box contents or a custom name.
unitPricenumberWhat the order pays per item delivered.
amountintegerTotal number of items the order asks for.
deliveredintegerItems delivered so far.
remainingintegerItems still wanted:
amountminusdelivered.firstSeenAttimestampWhen the order first appeared.
lastSeenAttimestampWhen the order was last confirmed open.
progressedAttimestamp | nullWhen a delivery to this order was last recorded.
nullif none yet.marketPricenumber | nullCurrent market price of the product.
cheapestListingsListing[]The 10 cheapest listings.
ShowHide10 child fields
idintegerStable id of the listing. It never changes or gets reused.
productProductWhat is being sold.
ShowHide6 child fields
keystringUnique product key: the item id, plus the variant in square brackets when there is one. Examples:
diamond,elytra[mending,unbreaking:3],potion[poison]. Use it withproduct=filters and/v1/items/{key}.itemstringMinecraft item id without the
minecraft:namespace, for examplenetherite_sword. Many products can share one item id.namestringDisplay name, for example
Potion of Poison.variantstringWhat sets this product apart from the plain item. Empty for plain items. See variants for the rules.
categorystring | nullOne of
combat,tools,valuables,drops,food,potions,blocksormisc.detailsProductDetails | nullStructured extras such as enchantments, shulker box contents or a custom name.
countintegerStack size, from 1 to 64.
pricenumberAsking price for the whole stack.
unitPricenumberAsking price per item:
pricedivided bycount.detailsProductDetails | nullDetails of this exact stack. They can carry more than the product does, such as the full contents of a shulker box.
ShowHide5 child fields
enchantmentsEnchantment[]Enchantments on the item itself, sorted by id. Left out when there are none.
storedEnchantmentsEnchantment[]Enchantments stored in an enchanted book. Left out for every other item.
contentsContainerEntry[]What a shulker box holds, one entry per item id with counts added together, largest first.
customNamestringThe name shown in game when it differs from the default item name. DonutSMP renames some items, for example
Dried Ghaston a skeleton skull.flightDurationintegerFlight duration of a firework rocket, from 1 to 3.
firstSeenAttimestampWhen the listing first appeared.
lastSeenAttimestampWhen the listing was last confirmed on the auction house.
marketPricenumber | nullCurrent market price of the product, so you can compare the ask at a glance.
sellerstring | nullUsername of the seller, once known.
nulluntil then.
filled24hintegerItems delivered to orders for this product in the last 24 hours.
paidOut24hnumberMoney paid out for those deliveries.
