Skip to content

API Reference / Inventory

List current workspace Steam holdings

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/ListWorkspaceInventory

Request body

application/jsonRequired

Request for one page of the cached holdings of every active account in the caller's workspace. Never fetches from Steam.

aggregateByAccount?boolean

With filter.item_name_exact, return one row per account, with item.amount equal to the sum of matching quantities. Other item fields are representative only. Pages advance by account, not asset.

cursor?string

Opaque cursor from the previous page. Bound to the actor workspace and the same filter.

descending?boolean

Order descending instead of ascending.

filter?WorkspaceInventoryFilter

Optional filters applied before pagination.

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.

limit?integer

Maximum holdings to return. The server caps pages at 100.

Format"int32"

sortField?string

Field to order the page by. Unspecified orders by account and asset id. Aggregate-by-account requests require unspecified.

Value in"WORKSPACE_INVENTORY_SORT_FIELD_MARKET_HASH_NAME"

Response body

application/json

Success

items?array<WorkspaceInventoryItem>

The holdings on this page, each with its account's freshness and connection state.

Show attributes
inventoryCheckedAt?string

The holding account's most recent successful public-inventory check. Unset when no successful check has been recorded.

Format"date-time"

inventoryPrivateSince?string

When the account's public inventory became unavailable. Cached items remain visible as last known holdings.

Format"date-time"

item?InventoryItem

A cached Steam holding with its workspace and account context populated.

Show attributes
accountName?string

The Steam account holding this item. Empty on the GetInventory response, where the caller already knows which account it queried.

amount?string

Stack size for a stackable item. 1 for a non-stackable item.

Format"int64"

appId?integer

Steam app id the item belongs to.

Format"int32"

assetId?string

The item's Steam asset id, unique within the account's inventory.

classId?string

Steam class id identifying the item's definition.

contextId?string

Steam inventory context id the item belongs to.

iconUrl?string

The item's Valve-hosted economy icon hash for this exact instance. Empty when the item carries no per-instance render.

inspectUri?string

The validated Steam inspect URI returned for this exact asset. Empty when unavailable or not yet observed.

instanceId?string

Steam instance id, distinguishing item instances that share a class id.

marketHashName?string

The item's market hash name.

tradable?boolean

Whether the item is currently tradable.

tradableAfter?string

When a held item becomes tradable. Unset when the item carries no trade hold.

Format"date-time"

workspaceId?string

Workspace the item belongs to. Zero on the GetInventory response, where the caller already knows which account it queried.

Format"byte" base64

sessionStatus?string

The account's recorded connection state. A cached holding does not prove the account is currently connected.

Value in"SESSION_STATUS_DISCONNECTED""SESSION_STATUS_CONNECTING""SESSION_STATUS_CONNECTED""SESSION_STATUS_LOGGED_ON""SESSION_STATUS_ERROR"

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/steam.v1.Steam/ListWorkspaceInventory" \
  -H "Authorization: Bearer $CSTRADER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "aggregateByAccount": false,
    "cursor": "",
    "descending": false,
    "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"
    },
    "limit": 50,
    "sortField": "WORKSPACE_INVENTORY_SORT_FIELD_MARKET_HASH_NAME"
  }'
{
  "items": [
    {
      "inventoryCheckedAt": "2026-11-03T16:10:00Z",
      "inventoryPrivateSince": "2026-11-03T16:10:00Z",
      "item": {
        "accountName": "flip_eu_02",
        "amount": "1",
        "appId": 730,
        "assetId": "39017128247",
        "classId": "310777185",
        "contextId": "2",
        "iconUrl": "https://community.cloudflare.steamstatic.com/economy/image/redline-ft",
        "inspectUri": "example",
        "instanceId": "480085569",
        "marketHashName": "AK-47 | Redline (Field-Tested)",
        "tradable": false,
        "tradableAfter": "2026-11-03T16:10:00Z",
        "workspaceId": "AY86PB0ufwCKGyw9Tl9gcQ=="
      },
      "sessionStatus": "SESSION_STATUS_DISCONNECTED"
    }
  ],
  "nextCursor": ""
}