Skip to main content

​
Get items on sale

GET /inventory/onSale
GET /inventory/onSale/{userid}
Permission: Connected (admin for {userid} variant)
​
userid
string
SteamID of user (admin only)
​
skip
integer
default:"0"
Pagination offset
​
limit
integer
default:"10"
Number of items per page
​
search
string
Search filter (matches against item name and effect)
Returns items currently listed for sale by the user. Items are grouped by item definition (for non-CS2 items without special attributes) and price.

​
Response item type

FieldTypeDescription
idsstringComma-separated backpack asset IDs (grouped)
countintegerNumber of items in this group
item_idintegerItem definition ID
namestringItem name
effectstringUnusual effect (TF2)
urlstringItem URL slug
gameintegerGame App ID
qualitystringItem quality
imagestringItem image URL
assetIdstringRepresentative asset ID
botstringBot holding the item
stateinteger1 (on sale)
priceintegerListed price in cents

​
Get items in inventory

GET /inventory/onInventory
GET /inventory/onInventory/{userid}
Permission: Connected (admin for {userid} variant)
​
userid
string
SteamID of user (admin only)
​
skip
integer
default:"0"
Pagination offset
​
limit
integer
default:"10"
Number of items per page
​
search
string
Search filter
Returns items in the user’s on-site inventory that are not listed for sale (state = 0). Same response structure as onSale.

​
Withdraw items

POST /inventory/withdraw
Permission: Connected Withdraws items from your on-site inventory back to your Steam account. Creates a trade offer.

​
Request body

​
ids
string
required
Comma-separated list of backpack entry IDs to withdraw
{
  "ids": "12345,67890,11111"
}

​
Response

{
  "updated": 3,
  "locked": 0
}
FieldTypeDescription
updatedintegerNumber of items successfully queued for withdrawal
lockedintegerNumber of items that could not be withdrawn (locked, expired, etc.)
Items with an active expire lock cannot be withdrawn until the lock expires.

​
Random Hat

POST /inventory/randomHat
Permission: Connected Converts multiple hats into a random hat. TF2-specific feature.

​
Request body

​
ids
string
required
Comma-separated list of backpack entry IDs (hats to sacrifice)
{
  "ids": "1,2,3,4,5"
}