List current workspace Steam holdings grouped by account or item

Read existing cached holdings of active accounts in the selected workspace, summed per account or per item. This never fetches Steam synchronously or creates managed purchase stock. The holdings filter applies before grouping, and grouping, ordering and pagination run over the complete workspace result.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

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?

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

groupBy?string

The dimension to group by. Unspecified is invalid.

Value in

"WORKSPACE_INVENTORY_GROUP_BY_UNSPECIFIED" | "WORKSPACE_INVENTORY_GROUP_BY_ACCOUNT" | "WORKSPACE_INVENTORY_GROUP_BY_ITEM"

limit?integer

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

Formatint32

sortField?string

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

Value in

"WORKSPACE_INVENTORY_GROUP_SORT_FIELD_UNSPECIFIED" | "WORKSPACE_INVENTORY_GROUP_SORT_FIELD_KEY" | "WORKSPACE_INVENTORY_GROUP_SORT_FIELD_QUANTITY" | "WORKSPACE_INVENTORY_GROUP_SORT_FIELD_ASSET_COUNT"

Response Body

`application/json`

curl -X POST "https://api.goldmine.to/steam.v1.Steam/ListWorkspaceInventoryGroups" \  -H "Content-Type: application/json" \  -d '{}'

{
  "groups": [
    {
      "accountName": "string",
      "assetCount": "string",
      "inventoryCheckedAt": "2019-08-24T14:15:22Z",
      "inventoryPrivateSince": "2019-08-24T14:15:22Z",
      "marketHashName": "string",
      "quantity": "string",
      "sessionStatus": "SESSION_STATUS_UNSPECIFIED"
    }
  ],
  "nextCursor": "string"
}

{
  "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."
}

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`