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.
/ steam. v1. Steam/ ListWorkspaceInventoryRequest 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?booleanWith 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?stringOpaque cursor from the previous page. Bound to the actor workspace and the same filter.
descending?booleanOrder descending instead of ascending.
filter?WorkspaceInventoryFilterOptional filters applied before pagination.
Show attributes
accountName?stringOne 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_"ITEM_"ITEM_"ITEM_"ITEM_"ITEM_"ITEM_"ITEM_"ITEM_"ITEM_"ITEM_"ITEM_"ITEM_"ITEM_
itemNameExact?stringExact case-sensitive market hash name, without trimming. Use when listing other holdings of one selected item. Absent or empty includes all items.
query?stringLiteral 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_"WORKSPACE_"WORKSPACE_"WORKSPACE_
weaponType?stringThe exact canonical CS2 catalog weapon type, such as rifle, sniper or pistol. Items without catalog metadata do not match.
limit?integerMaximum holdings to return. The server caps pages at 100.
Format"int32"
sortField?stringField to order the page by. Unspecified orders by account and asset id. Aggregate-by-account requests require unspecified.
Value in"WORKSPACE_
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?stringThe holding account's most recent successful public-inventory check. Unset when no successful check has been recorded.
Format"date-time"
inventoryPrivateSince?stringWhen the account's public inventory became unavailable. Cached items remain visible as last known holdings.
Format"date-time"
item?InventoryItemA cached Steam holding with its workspace and account context populated.
Show attributes
accountName?stringThe Steam account holding this item. Empty on the GetInventory response, where the caller already knows which account it queried.
amount?stringStack size for a stackable item. 1 for a non-stackable item.
Format"int64"
appId?integerSteam app id the item belongs to.
Format"int32"
assetId?stringThe item's Steam asset id, unique within the account's inventory.
classId?stringSteam class id identifying the item's definition.
contextId?stringSteam inventory context id the item belongs to.
iconUrl?stringThe item's Valve-hosted economy icon hash for this exact instance. Empty when the item carries no per-instance render.
inspectUri?stringThe validated Steam inspect URI returned for this exact asset. Empty when unavailable or not yet observed.
instanceId?stringSteam instance id, distinguishing item instances that share a class id.
marketHashName?stringThe item's market hash name.
tradable?booleanWhether the item is currently tradable.
tradableAfter?stringWhen a held item becomes tradable. Unset when the item carries no trade hold.
Format"date-time"
workspaceId?stringWorkspace the item belongs to. Zero on the GetInventory response, where the caller already knows which account it queried.
Format"byte" base64
sessionStatus?stringThe account's recorded connection state. A cached holding does not prove the account is currently connected.
Value in"SESSION_"SESSION_"SESSION_"SESSION_"SESSION_
nextCursor?stringCursor to pass as cursor to fetch the next page. Empty when this is the last page.
application/json
The request was malformed, such as a missing required field or an unparseable cursor.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The request lacks a valid API key in the Authorization header.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The API key is not allowed to perform this action on this workspace.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
An internal server error occurred.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
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"
}'const res = await fetch("https://api.goldmine.to/steam.v1.Steam/ListWorkspaceInventory", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CSTRADER_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"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"
}),
});
const data = await res.json();body := strings.NewReader(`{
"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"
}`)
req, err := http.NewRequestWithContext(ctx, http.MethodPost, "https://api.goldmine.to/steam.v1.Steam/ListWorkspaceInventory", body)
if err != nil {
return err
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("CSTRADER_API_KEY"))
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)import os, requests
res = requests.post(
"https://api.goldmine.to/steam.v1.Steam/ListWorkspaceInventory",
headers={"Authorization": f"Bearer {os.environ['CSTRADER_API_KEY']}"},
json={
"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"
},
)
data = res.json(){
"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": ""
}{
"code": "invalid_argument",
"message": "The request was malformed, such as a missing required field or an unparseable cursor."
}{
"code": "unauthenticated",
"message": "The request lacks a valid API key in the Authorization header."
}{
"code": "permission_denied",
"message": "The API key is not allowed to perform this action on this workspace."
}{
"code": "internal",
"message": "An internal server error occurred."
}