Skip to content

API Reference / Inventory

Count inventory items per filter option

Returns, for each requested facet field (account, buying contract, purchase strategy), how many inventory items carry each value under the same InventoryItemFilter and status selection as ListInventoryItems, with the field's own filter left out. Drives the inventory filter flyout.

POST/contracts.v1.Contracts/GetInventoryItemFacetCounts

Request body

application/jsonRequired

Request for the per value counts of up to 8 inventory item facet fields under the same filter and status selection as ListInventoryItems, so a filter flyout shows how many items each option would select.

fields?array<string>

The facet fields to count, at most 8.

Value in"INVENTORY_ITEM_FACET_FIELD_ACCOUNT_NAME""INVENTORY_ITEM_FACET_FIELD_CONTRACT""INVENTORY_ITEM_FACET_FIELD_PURCHASE_STRATEGY""INVENTORY_ITEM_FACET_FIELD_MARKET_HASH_NAME""INVENTORY_ITEM_FACET_FIELD_LISTING_MARKETPLACE""INVENTORY_ITEM_FACET_FIELD_LISTING_CONTRACT"

filter?InventoryItemFilter

The same filter as ListInventoryItems. Each facet is counted with every other field applied but not its own, so choosing one account still shows the counts of the other accounts. The market_hash_name facet is the exception: it keeps market_hash_names, so the held count of each name on a catalog page is one call with those names and the not sold statuses.

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"

statuses?array<string>

The list's lifecycle status selection, so the flyout reflects the open tab. Empty includes every status.

Value in"INVENTORY_ITEM_STATUS_PENDING_TRADE""INVENTORY_ITEM_STATUS_IN_INVENTORY""INVENTORY_ITEM_STATUS_LISTED""INVENTORY_ITEM_STATUS_SOLD""INVENTORY_ITEM_STATUS_LOST"

Response body

application/json

Success

facets?array<InventoryItemFacetCounts>

One entry per requested field, in request order.

Show attributes
counts?FacetFieldCounts

The values ordered by count descending then value, at most 50, with truncated set when more exist.

Show attributes
truncated?boolean

True when the field has more than 50 values, so the list shows only the 50 most common.

values?array<FacetValueCount>

The values and their counts, ordered by count descending then by value, at most 50.

Show attributes
count?string

Number of rows carrying the value under the facet's predicate. Returned as a JSON string to preserve integer precision.

Format"int64"

value?string

The value as the list rows carry it: an enum name, a base64 id or an account name, so a client maps it to a label exactly as it maps a row.

field?string

The facet field these counts are for.

Value in"INVENTORY_ITEM_FACET_FIELD_ACCOUNT_NAME""INVENTORY_ITEM_FACET_FIELD_CONTRACT""INVENTORY_ITEM_FACET_FIELD_PURCHASE_STRATEGY""INVENTORY_ITEM_FACET_FIELD_MARKET_HASH_NAME""INVENTORY_ITEM_FACET_FIELD_LISTING_MARKETPLACE""INVENTORY_ITEM_FACET_FIELD_LISTING_CONTRACT"

curl -X POST "https://api.goldmine.to/contracts.v1.Contracts/GetInventoryItemFacetCounts" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "statuses": [
      "INVENTORY_ITEM_STATUS_IN_INVENTORY"
    ],
    "fields": [
      "INVENTORY_ITEM_FACET_FIELD_ACCOUNT_NAME"
    ]
  }'
{
  "facets": [
    {
      "field": "INVENTORY_ITEM_FACET_FIELD_ACCOUNT_NAME",
      "counts": {
        "values": [
          {
            "value": "trader_steam_01",
            "count": "12"
          }
        ],
        "truncated": false
      }
    }
  ]
}