Buy orders

List buy orders

Every open buy order.

GET/v1/orders

Pages through every open buy order. By default the list is what a player would want to fill: orders that still want items, without lowballs. A lowball is an order paying under 25% of the market price that is less than 1% filled. Turn them back on with lowball=true, and include fully delivered orders with filled=true.

Authentication

API key with the read scope

Cached for

20 s

Data updates

New entries within about a minute, the busiest items every 5 minutes and everything else at least every 20 minutes.

curl "https://api.donutstats.io/v1/orders?limit=2" \
  -H "x-api-key: $DONUTSTATS_API_KEY"

Response200OK

{
  "page": 1,
  "limit": 2,
  "total": 14033,
  "updatedAt": 1792724121936,
  "entries": [
    {
      "id": 3036511,
      "product": {
        "key": "elytra[mending,unbreaking:3]",
        "item": "elytra",
        "name": "Elytra",
        "variant": "mending,unbreaking:3",
        "category": "valuables",
        "details": {
          "enchantments": [
            {
              "id": "mending",
              "level": 1
            },
            {
              "id": "unbreaking",
              "level": 3
            }
          ]
        }
      },
      "unitPrice": 350000000,
      "amount": 256,
      "delivered": 0,
      "remaining": 256,
      "firstSeenAt": 1792414508267,
      "lastSeenAt": 1792724002236,
      "progressedAt": null,
      "marketPrice": 463000000
    },
    {
      "id": 3895795,
      "product": {
        "key": "firework_rocket",
        "item": "firework_rocket",
        "name": "Firework Rocket",
        "variant": "",
        "category": "combat",
        "details": {
          "flightDuration": 1
        }
      },
      "unitPrice": 118.71,
      "amount": 500000000,
      "delivered": 302000,
      "remaining": 499698000,
      "firstSeenAt": 1792722402359,
      "lastSeenAt": 1792723982611,
      "progressedAt": 1792723347780,
      "marketPrice": 259.375
    }
  ]
}

Try itCounts towards your plan

Query parameters

qstringoptional
Search orders by product name or item id, for example totem.
1 to 64 characters
itemstringoptional
Exact item id such as diamond_sword. Matches every variant of the item.
productstringoptional
Exact product key such as diamond_sword[sharpness:5]. Matches that variant only. URL encode the brackets.
categorystringoptional
Only products in this category.
combattoolsvaluablesdropsfoodpotionsblocksmisc
sortstringoptionaldefault value
value: most money left to pay out first. price: best price per item first. newest: most recently placed first. amount: most items wanted first.
valuepricenewestamount
filledbooleanoptionaldefault false
true also returns orders that have received everything they asked for but are still open.
falsetrue
lowballbooleanoptionaldefault false
true also returns lowball orders.
falsetrue
pageintegeroptionaldefault 1
Page to return, starting at 1.
1 to 100,000
limitintegeroptionaldefault 50
Entries per page.
1 to 200

Response

A page of orders. updatedAt is when the buy orders were last refreshed.

pageinteger
The page you asked for, starting at 1.
limitinteger
Entries per page.
totalinteger
Entries across every page that match your filters.
updatedAttimestamp | null
When the underlying data last changed. null where it does not apply.
entriesOrder[]
The entries on this page.
ShowHide10 child fields
- idinteger
  Stable id of the buy order.
- productProduct
  What the order wants to buy.
  ShowHide6 child fields
  - keystring
    Unique 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 with product= filters and /v1/items/{key}.
  - itemstring
    Minecraft item id without the minecraft: namespace, for example netherite_sword. Many products can share one item id.
  - namestring
    Display name, for example Potion of Poison.
  - variantstring
    What sets this product apart from the plain item. Empty for plain items. See variants for the rules.
  - categorystring | null
    One of combat, tools, valuables, drops, food, potions, blocks or misc.
  - detailsProductDetails | null
    Structured 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.
    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.
    customNamestring
    The name shown in game when it differs from the default item name. DonutSMP renames some items, for example Dried Ghast on a skeleton skull.
    flightDurationinteger
    Flight duration of a firework rocket, from 1 to 3.
- unitPricenumber
  What the order pays per item delivered.
- amountinteger
  Total number of items the order asks for.
- deliveredinteger
  Items delivered so far.
- remaininginteger
  Items still wanted: amount minus delivered.
- firstSeenAttimestamp
  When the order first appeared.
- lastSeenAttimestamp
  When the order was last confirmed open.
- progressedAttimestamp | null
  When a delivery to this order was last recorded. null if none yet.
- marketPricenumber | null
  Current market price of the product.