Skip to content

API Reference / Inventory

List inventory items grouped by account group or account

Returns a page of the workspace's inventory items counted and summed per account group, or per holding Steam account, under the same InventoryItemFilter as ListInventoryItems: the item count, buy price total, and the tradable, trade hold, listed and arriving counts of each group. Grouped by account with account_names, it reads the items held on a page of accounts in one call. An account in two account groups counts in both and the response says so.

POST/contracts.v1.Contracts/ListInventoryItemGroups

Request body

application/jsonRequired

Request for one page of the caller's workspace inventory counted and summed per account group or per holding account, under the same filter as ListInventoryItems.

cursor?string

Opaque cursor from the previous page. Bound to the actor workspace, the filter, the grouping and the order.

descending?boolean

Order descending instead of ascending. The group key tiebreak follows the same direction.

filter?InventoryItemFilter

The same filter as the item list and count, applied to items before they are grouped.

Show attributes
accountGroupIds?array<string>

Items held by an account that is a member of one of these account groups of the workspace, OR within the field, compared as ListInventoryItemGroups groups them. A deleted group selects nothing. Empty includes every item. At most 200 ids.

accountNames?array<string>

Exact Steam account names holding the item, OR within the field. Empty includes every account. At most 200 names, each nonempty.

acquiredBefore?string

Only items that reached the Steam inventory before this time. Absent sets no upper bound.

Format"date-time"

acquiredFrom?string

Only items that reached the Steam inventory at or after this time. An item still arriving has no acquired_at and never matches a bound. Absent sets no lower bound.

Format"date-time"

contractId?string

Only items attributed to this buying contract, the one that bought them.

Format"byte" base64

coveringSellingContractIds?array<string>

Held items (arriving, in the inventory or listed) whose covering selling contract, resolved now exactly as GetCoveringSellingContract resolves it (Sell from account groups honoured), is one of these, OR within the field. Items that left never match. Empty includes every item. At most 200 ids.

currentAssetIds?array<string>

Exact current Steam asset ids, OR within the field, matching current_asset_id, so a page of Steam inventory tiles resolves what each item cost in one call. A tile with no match was not bought through the platform. Empty includes every item. At most 200 ids, each nonempty.

hasCoveringSellingContract?boolean

True selects only held items (arriving, in the inventory or listed) a selling contract covers now, as GetCoveringSellingContract resolves it. False selects only held items none covers, the items nothing will list. Items that left never match either value. Omitted includes every item.

listingContractIds?array<string>

Listing contracts, OR within the field: the selling contract pricing the item's newest listing (listing_contract_id). An item never listed, or listed with no contract, never matches. Combine with the LISTED status for what a contract has listed now. Empty includes every item. At most 200 ids.

listingMarketplaces?array<string>

Listing marketplaces, OR within the field: the marketplace of the item's newest listing (listing_marketplace), salespanel for the listing. An item never listed never matches. Combine with the LISTED status for what is listed there now. Empty includes every item. At most 50 values, each nonempty.

marketHashNames?array<string>

Exact market_hash_name set, OR within the field, for an item's own holdings. Empty includes every item.

paintSeeds?array<integer>

Exact paint seeds (pattern indexes, 0 to 1000), OR within the field. An item with no known seed never matches. Empty includes every item. At most 200 seeds.

purchaseIds?array<string>

Only the items produced by these purchases, OR within the field. A purchase resolves to at most one inventory item, so a purchases page resolves its page of items in one call, and a purchase detail page resolves the real inventory_item_id before calling ListAssetIDLinks. Empty includes every purchase.

purchaseStrategies?array<string>

Buying mechanisms of the purchase that produced the item, OR within the field. Empty includes every strategy.

Value in"PURCHASE_STRATEGY_LISTING""PURCHASE_STRATEGY_BUY_ORDER""PURCHASE_STRATEGY_AUCTION""PURCHASE_STRATEGY_OFFER"

query?string

Case-insensitive literal substring of the item's market_hash_name or of the Steam account name holding it, or the item's full id in its canonical text form. Not a regular expression or wildcard pattern. Absent or empty matches every item.

sellable?boolean

True selects only items outside Valve's post-trade hold: tradable rows whose tradable_after is absent or no longer in the future. False selects only held or untradable items. Omitted includes both. Every selling market service sets true, so the hold logic lives in contracts once and no market offers an undeliverable held item.

sellingContractIds?array<string>

Selling contracts, OR within the field: the contract that sold the item (selling_contract_id). An item not sold, or sold with no contract, never matches. Empty includes every item. At most 200 ids.

sellingMarketplaces?array<string>

Selling marketplaces, OR within the field: the marketplace that sold the item (selling_marketplace). An item not sold, or sold with no market named, never matches. Empty includes every item. At most 50 values, each nonempty.

soldBefore?string

Only items sold before this time, exclusive, with the same sale time as sold_from. Absent sets no upper bound.

Format"date-time"

soldFrom?string

Only items sold at or after this time. Sale time is sold_at, or updated_at for a legacy sold row with none, the same time the SOLD_AT order uses. Only sold items ever match a bound. Absent sets no lower bound.

Format"date-time"

statusValues?array<string>

Status set, OR within the field, including TRADE_HOLD for a held item and NOT_DELIVERED or ARRIVING for a pending trade past or within its delivery deadline. Empty includes every status. Unlike the list's statuses, this is part of the shared filter, so counts, groups and facets take it too.

Value in"INVENTORY_ITEM_STATUS_FILTER_VALUE_PENDING_TRADE""INVENTORY_ITEM_STATUS_FILTER_VALUE_IN_INVENTORY""INVENTORY_ITEM_STATUS_FILTER_VALUE_LISTED""INVENTORY_ITEM_STATUS_FILTER_VALUE_SOLD""INVENTORY_ITEM_STATUS_FILTER_VALUE_TRADE_HOLD""INVENTORY_ITEM_STATUS_FILTER_VALUE_NOT_DELIVERED""INVENTORY_ITEM_STATUS_FILTER_VALUE_ARRIVING""INVENTORY_ITEM_STATUS_FILTER_VALUE_LOST"

tradableAfterBefore?string

Only items whose post-trade hold lifts before this time, exclusive. An item with no recorded hold is excluded. With a lower bound of now this lists the items coming off hold soonest.

Format"date-time"

groupBystring

The dimension to group by. Required.

Value in"INVENTORY_ITEM_GROUP_BY_ACCOUNT_GROUP""INVENTORY_ITEM_GROUP_BY_ACCOUNT"

limit?integer

Maximum groups to return. Zero selects the default of 100, and the server rejects a limit above 100.

Format"int32"

sortField?string

Field to order the groups by. Unspecified orders by the group key.

Value in"INVENTORY_ITEM_GROUP_SORT_FIELD_KEY""INVENTORY_ITEM_GROUP_SORT_FIELD_ITEM_COUNT""INVENTORY_ITEM_GROUP_SORT_FIELD_TOTAL_BUY_PRICE"

Response body

application/json

Success

groups?array<InventoryItemGroup>

The groups on this page, in the requested order.

Show attributes
accountGroupId?string

The account group every item's account belongs to. Unset for the group of items held by an account that is in no account group, and when grouping by account.

Format"byte" base64

accountGroupName?string

The account group's name at read time. Empty for the ungrouped items and when grouping by account.

accountName?string

The Steam account holding every item in the group when grouping by account. Empty when grouping by account group.

arrivingCount?string

Items still awaiting their delivery trade.

Format"int64"

itemCount?string

Number of items in the group. Returned as a JSON string to preserve integer precision.

Format"int64"

listedCount?string

Items listed for sale on a marketplace.

Format"int64"

totalBuyPriceCents?string

Sum of buy_price_cents over the items in the group, in cents.

Format"int64"

totalBuyPriceMicros?string

Sum of buy_price_micros over the items in the group, in millionths of a dollar. Exact to the millionth of a dollar, so a purchase charged a fraction of a cent counts at what it cost. The _cents figure beside it sums prices rounded up to a cent and is kept for limits.

Format"int64"

tradableCount?string

Items in the inventory and outside Valve's post-trade hold, evaluated at read time.

Format"int64"

tradeHoldCount?string

Items in the inventory and still held: not tradable, or tradable_after in the future, evaluated at read time.

Format"int64"

uncoveredCount?string

Held items (arriving, in the inventory or listed) no selling contract covers now, as GetCoveringSellingContract resolves it: the items nothing will list.

Format"int64"

groupsOverlap?boolean

True when an account holding a matching item belongs to more than one account group, so that account's items are counted in each of its groups and the groups do not sum to the workspace total. Always false when grouping by account.

nextCursor?string

Cursor to pass as cursor to fetch the next page. Empty when this is the last page.

curl -X POST "https://api.goldmine.to/contracts.v1.Contracts/ListInventoryItemGroups" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": {
      "statusValues": [
        "INVENTORY_ITEM_STATUS_FILTER_VALUE_IN_INVENTORY",
        "INVENTORY_ITEM_STATUS_FILTER_VALUE_LISTED"
      ]
    },
    "groupBy": "INVENTORY_ITEM_GROUP_BY_ACCOUNT_GROUP",
    "limit": 100,
    "cursor": ""
  }'
{
  "groups": [
    {
      "accountGroupId": "EBESExQVFhcYGRobHB0eHw==",
      "accountGroupName": "Main pool",
      "itemCount": "12",
      "totalBuyPriceCents": "50400",
      "tradableCount": "9",
      "tradeHoldCount": "1",
      "listedCount": "2",
      "arrivingCount": "0"
    }
  ],
  "nextCursor": "",
  "groupsOverlap": false
}