Buy orders

List order history

Every buy order that ever closed, filled or not.

GET/v1/orders/history

The complete record of closed buy orders, newest first. filled tells you whether the order got everything it asked for before it closed. Filter by item or exact product and narrow it to a time range with from and to.

Authentication

API key with the read scope

Cached for

20 s

Data updates

New entries with every buy order refresh. Kept forever.

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

Response200OK

{
  "limit": 2,
  "next": "MTc5MjcyNzI5ODU0MC4zOTAyODQx",
  "entries": [
    {
      "id": 3918758,
      "product": {
        "key": "dirt",
        "item": "dirt",
        "name": "Dirt",
        "variant": "",
        "category": "blocks",
        "details": null
      },
      "unitPrice": 21,
      "amount": 1000,
      "delivered": 20,
      "filled": false,
      "firstSeenAt": 1792727177700,
      "lastSeenAt": 1792727177700,
      "progressedAt": null,
      "closedAt": 1792727298540
    },
    {
      "id": 3902841,
      "product": {
        "key": "dirt",
        "item": "dirt",
        "name": "Dirt",
        "variant": "",
        "category": "blocks",
        "details": null
      },
      "unitPrice": 23,
      "amount": 50000,
      "delivered": 26200,
      "filled": false,
      "firstSeenAt": 1792723317708,
      "lastSeenAt": 1792726869722,
      "progressedAt": 1792726869722,
      "closedAt": 1792727298540
    }
  ]
}

Try itCounts towards your plan

Query parameters

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.
fromtimestampoptional
Only entries at or after this time, in Unix milliseconds.
totimestampoptional
Only entries before this time, in Unix milliseconds.
limitintegeroptionaldefault 100
Entries per page.
1 to 1,000
cursorstringoptional
The next value from the previous response. Leave it out for the first page. See cursors.

Response

A feed of closed orders, newest first. from and to apply to closedAt.

limitinteger
Entries per page.
nextstring | null
Pass this as cursor to get the next page. null on the last page.
entriesClosedOrder[]
The entries on this page, newest first.
ShowHide10 child fields
- idinteger
  Stable id of the buy order.
- productProduct
  What the order wanted.
  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 it paid per item.
- amountinteger
  Items it asked for.
- deliveredinteger
  Items it received before it closed.
- filledboolean
  true when it received everything it asked for, false when it was cancelled or expired first.
- firstSeenAttimestamp
  When the order first appeared.
- lastSeenAttimestamp
  When it was last confirmed open.
- progressedAttimestamp | null
  When its last delivery was recorded. null if it never got one.
- closedAttimestamp
  When the order closed.

Status codes

Status	When
400Bad Request	A filter or the `cursor` is malformed.