Skip to content

API Reference / Inventory

Count cached workspace holdings and inventory coverage

Read existing cached holdings of active accounts in the selected workspace. This never fetches Steam synchronously or creates managed purchase stock. Exact account and literal item-name filters apply before pagination and counting. Coverage distinguishes checked, pending, private and offline accounts.

POST/steam.v1.Steam/CountWorkspaceInventory

Request body

application/jsonRequired

Request for the number of cached holdings matching a filter across the caller's workspace, with per-account inventory coverage. Never fetches from Steam.

filter?WorkspaceInventoryFilter

The same filter as the holdings list. Coverage counts and account_set_id depend only on account_name and remain independent of the item predicates.

Show attributes
accountName?string

One exact active account name. Absent or empty includes all active accounts in the selected workspace.

categories?array<string>

Authoritative CS2 catalog categories, OR within the field, matched before paging. Empty includes every category. Items without catalog metadata do not match a non-empty set.

Value in"ITEM_CATEGORY_WEAPON_SKIN""ITEM_CATEGORY_KNIFE_SKIN""ITEM_CATEGORY_GLOVE_SKIN""ITEM_CATEGORY_STICKER""ITEM_CATEGORY_PATCH""ITEM_CATEGORY_CASE""ITEM_CATEGORY_STICKER_CAPSULE""ITEM_CATEGORY_MUSIC_KIT""ITEM_CATEGORY_AGENT""ITEM_CATEGORY_KEY""ITEM_CATEGORY_GRAFFITI""ITEM_CATEGORY_KEYCHAIN""ITEM_CATEGORY_COMMODITY_PIN""ITEM_CATEGORY_TOOL"

itemNameExact?string

Exact case-sensitive market hash name, without trimming. Use when listing other holdings of one selected item. Absent or empty includes all items.

query?string

Literal case-insensitive substring of market hash name. Wildcards are treated as ordinary characters.

tradabilities?array<string>

Tradability set, OR within the field. Empty includes every holding. Held is locked and never tradable together, so it may be combined with either.

Value in"WORKSPACE_INVENTORY_TRADABILITY_TRADABLE""WORKSPACE_INVENTORY_TRADABILITY_HELD""WORKSPACE_INVENTORY_TRADABILITY_LOCKED""WORKSPACE_INVENTORY_TRADABILITY_NEVER_TRADABLE"

weaponType?string

The exact canonical CS2 catalog weapon type, such as rifle, sniper or pistol. Items without catalog metadata do not match.

Response body

application/json

Success

accountSetId?string

SHA-256 of the selected active account names, lifecycle generations and current Steam identities from the same database snapshot as the counts. Independent of the item-name filter. Empty from older servers provides no membership proof.

cachedAssetCount?string

Number of cached asset records matching all filters, across the whole workspace rather than the loaded page. This is not a count of account-grouped list rows.

Format"int64"

cachedQuantity?string

Sum of cached stack quantities matching all filters. Returned as a JSON string to preserve integer precision.

Format"int64"

checkedAccounts?integer

Selected accounts with a recorded successful inventory check, including accounts whose checked inventory was empty.

Format"int32"

offlineAccounts?integer

Selected accounts not recorded as logged on. Their cached holdings may remain available. May overlap other coverage counts.

Format"int32"

pendingAccounts?integer

Selected accounts with no successful inventory check recorded. Their cache may contain older holdings. Pending does not mean empty.

Format"int32"

privateAccounts?integer

Selected accounts whose public inventory is currently marked private or unavailable. May overlap checked, pending or offline counts.

Format"int32"

totalAccounts?integer

Number of active accounts selected by the account filter. Coverage counts are independent of the item-name filter.

Format"int32"

curl -X POST "https://api.goldmine.to/steam.v1.Steam/CountWorkspaceInventory" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "filter": {
      "accountName": "flip_eu_02",
      "categories": [
        "ITEM_CATEGORY_WEAPON_SKIN"
      ],
      "itemNameExact": "AK-47 | Redline (Field-Tested)",
      "query": "example",
      "tradabilities": [
        "WORKSPACE_INVENTORY_TRADABILITY_TRADABLE"
      ],
      "weaponType": "example"
    }
  }'
{
  "accountSetId": "example",
  "cachedAssetCount": "3",
  "cachedQuantity": "3",
  "checkedAccounts": 3,
  "offlineAccounts": 3,
  "pendingAccounts": 3,
  "privateAccounts": 3,
  "totalAccounts": 3
}