Skip to main content

Create buy order

POST /item/buyorder
Permission: Connected + API Creates a buy order for a specific item at a specified price.

Body Parameters

itemId
integer
required
Item ID for which to create a buy order
price
integer
required
Buy order price in cents
quantity
integer
required
Number of items to buy (default: 1)

Request Example

{
  "itemId": 12345,
  "price": 15000,
  "quantity": 3
}

Response

Success
{
  "err": false,
  "success": true,
  "content": {
    "details": "Inserted"
  }
}

Error Responses

StatusMessageDescription
errorInsufficient balanceUser doesnโ€™t have enough balance to create the buy order
errorPrice too lowBuy order price is below minimum threshold
errorItem not foundInvalid item ID
errorBuy order limit reachedUser has reached the maximum number of buy orders
The total price (price ร— quantity) will be reserved from your balance when creating a buy order.

Update buy order

POST /item/buyorder/update
Permission: Connected + API Updates an existing buy orderโ€™s price or quantity.

Body Parameters

buyOrderId
integer
required
Buy order ID to update
price
integer
New price in cents (optional)
quantity
integer
New quantity (optional)

Request Example

{
  "buyOrderId": 98765,
  "price": 16000,
  "quantity": 5
}

Response

Success
{
  "err": false,
  "success": true,
  "content": "Buy order updated"
}
Updating a buy order may require additional balance if increasing price or quantity. The difference will be reserved from your available balance.

Remove buy order

POST /item/buyorder/remove
Permission: Connected + API Cancels and removes a buy order, releasing the reserved balance.

Body Parameters

buyOrderId
integer
required
Buy order ID to remove

Request Example

{
  "buyOrderId": 98765
}

Response

Success
{
  "err": false,
  "success": true,
  "content": {
    "details": "Removed"
  }
}

Get userโ€™s buy orders for an item

GET /user/buyorder/{item}
Permission: Connected + API
item
string
required
Item identifier (numeric ID)
Returns all active buy orders for a specific item created by the authenticated user.

Response

{
  "err": false,
  "success": true,
  "content": {
    "informations": {
      "id": 98765,
      "steamid": "76561198000000000",
      "itemid": 12345,
      "price": 15000,
      "amount": 3,
      "timestamp": "1706745600"
    }
  }
}

Buy Order Fields

FieldTypeDescription
idintegerBuy order ID
steamidstringUserโ€™s Steam ID
itemidintegerItem ID
priceintegerBuy order price in cents
amountintegerQuantity of items to buy
timestampstringUnix timestamp of creation

Get all userโ€™s buy orders

GET /user/getBuyorder
Permission: Connected + API Returns all active buy orders for the authenticated user across all items.

Query Parameters

page
integer
default:"0"
Page number for pagination (0-indexed)
count
integer
default:"10"
Number of results per page (max 50, must be > 0)
Search term to filter by item effect or name (minimum 3 characters)

Response

{
  "err": false,
  "success": true,
  "content": {
    "values": [
      {
        "id": 98765,
        "steamid": "76561198000000000",
        "itemid": 12345,
        "price": 15000,
        "amount": 3,
        "name": "Burning Flames Team Captain",
        "effect": "Burning Flames",
        "url": "unusual_team_captain",
        "game": 440,
        "quality": "Unusual",
        "image": "https://...",
        "type": "Hat",
        "craftable": 1,
        "SKU": "",
        "type_steam": null,
        "class": null,
        "imagePertinence": 1,
        "rarity": "",
        "featured": 0,
        "deal": null,
        "color": "",
        "slot": "",
        "hero": null,
        "weapon": null,
        "exterior": null,
        "description": null,
        "tf2shop": null
      }
    ],
    "count": {
      "nb": 15
    }
  }
}

Response Fields

Returns joined data from buyorder and items tables: Buy Order Fields:
FieldTypeDescription
idnumberBuy order ID
steamidstringUserโ€™s Steam ID
itemidnumberItem ID
pricenumberBuy order price in cents
amountnumberQuantity remaining
namestringBuy order custom name (or item name)
Item Fields (from items table): All fields from the items table are joined, including effect, name, url, game, quality, image, type, craftable, etc. Count Object:
FieldTypeDescription
count.nbnumberTotal number of buy orders
  • Results are ordered by buyorder.id DESC
  • Only returns buy orders where amount != 0
  • Search functionality requires at least 3 characters
  • The count object contains the total number of buy orders for pagination
Buy orders are automatically filled when matching items are listed at or below your buy order price. Youโ€™ll receive a notification when a buy order is filled.