---
search:
  tags:
    - Bots
    - POST
seo:
  description: >-
    Reports a bot's status, profile, rules, prices, stock and features, and
    answers what is… Reference for the POST /v1/bot.push endpoint in the
    SteamSets API.
sidebar:
  label: Push a bot's status, prices, stock and features
  badge: POST
title: Push a bot's status, prices, stock and features
type: openapi-operation
---
Reports a bot's status, profile, rules, prices, stock and features, and answers what is now stored, what in the push was ignored or looks wrong, and when the bot goes stale.

Pushing is free: it uses no daily units. Authenticate with a bot key, or with your account key and `steamId64`. Push at least every 30 minutes: a bot silent for 45 minutes shows as stale, and after a day it is hidden.

### Patch rules

Every field is optional.

- A field you leave out keeps its stored value, down to each price side, count and rule. This changes the TF2 sell price of normal sets and nothing else:

  ```json
  {"sets": {"normal": {"prices": {"setsPerKey": {"tf2": {"sell": 12}}}}}}
  ```

- 0 removes a price side or a count. This stops buying normal sets for TF2 keys:

  ```json
  {"sets": {"normal": {"prices": {"setsPerKey": {"tf2": {"buy": 0}}}}}}
  ```

- A stock you send replaces the stored stock of that side. This leaves the bot with 3 normal sets of app 440 and keeps its foil stock:

  ```json
  {"sets": {"normal": {"stock": {"440": 3}}}}
  ```

- `{}` clears a stock or a map, and `[]` clears a list. This empties the game stock, drops every per-game price and clears the chat commands:

  ```json
  {"games": {"stock": {}, "priceByApp": {}}, "commands": []}
  ```

- `null` clears an object. This clears the languages, the level range and every rule:

  ```json
  {"profile": {"languages": null, "levelRange": null}, "rules": null}
  ```

### Prices

Every price is named after its unit, and `sell` and `buy` are from the bot's side.

- `sets.normal.prices.setsPerKey.tf2.sell` is the normal sets the bot gives you for one TF2 key.
- `sets.foil.prices.setsPerKey.tf2.sell` is the same for foil sets, which have their own prices.
- `sets.normal.prices.gemsPerSet.sell` is the gems it asks for one set.
- `sets.normal.prices.coinsPerSet` prices a set in cryptocurrencies, as decimal strings.
- `games.prices.keysPerGame.tf2.sell` is the keys it asks for one game, and `games.priceByApp` overrides it for single games.
- `gems.prices.gemsPerKey.tf2.sell` is the gems the bot gives you for one TF2 key.

A bot buys what it quotes a buy price for. There is no separate field that says a bot takes supply, and no bot type to send: the directory reads what a bot does from its stock and prices.

```json
{
  "sets": {
    "normal": {"stock": {"440": 3}, "prices": {"setsPerKey": {"tf2": {"sell": 12, "buy": 14}}}},
    "foil": {"stock": {"730": 1}, "prices": {"setsPerKey": {"tf2": {"sell": 0.5}}}},
    "limits": {"maxPerUserPerApp": 5, "maxStockPerApp": 10}
  },
  "games": {"stock": {"730": 2}, "priceByApp": {"730": {"keysPerGame": {"tf2": {"sell": 4}}}}}
}
```

Sale and event sets need nothing special: send them as app IDs in the normal stock.

### Profile and rules

`profile` says how users reach the bot: its website, the ISO 639-1 languages it answers in (`default` must be in `supported`), and the account levels its stock is meant for. `rules` says which users and trades it accepts. The calculator leaves out a bot whose rules turn the signed-in user away for a VAC or trade ban.

```json
{
  "profile": {
    "website": "https://example.com/order",
    "languages": {"supported": ["en", "pt"], "default": "en"},
    "levelRange": {"min": 1, "max": 200}
  },
  "rules": {"acceptsTradeHolds": false, "acceptsVacBannedUsers": true}
}
```

### Payment, commands and features

`payment` lists the Steam items, by market hash name, that count as each currency. Items for a currency the bot quotes no price in are kept and reported as `paymentWithoutPrice`. `commands` is every chat command the bot answers. Each feature can name the commands that use it; neither list is checked against the other.

```json
{
  "payment": {"tf2": {"items": ["Mann Co. Supply Crate Key"]}, "gems": {"items": ["Sack of Gems", "Gems"]}},
  "commands": ["!help", "!prices", "!buytf", "!check"],
  "features": [{"feature": "badgeAware", "commands": ["!check", "!buytf"]}]
}
```

### Client

A push without `client` is named by its User-Agent (`name/version`). Send `client` so staff can tell your plugin's versions apart.

`POST /v1/bot.push`

**Request body** (`application/json`, required)

- `client` (BotPushRequestClient) — The plugin or script sending the push. When it is missing, the User-Agent header names the client.
- `commands` (string[]) — Every chat command the bot answers, as free text, at most 50 of up to 32 characters. Replaces the stored list; \[\] clears it.
- `features` (BotPushRequestFeature[]) — Everything the bot does that its prices and stock cannot show. Replaces the stored list; \[\] clears it. Currencies, buying, foil, gems, games, event sets, languages and limits are not features: the directory reads them from the rest of the push.
- `games` (BotPushRequestGames) — Steam games the bot sells or buys, as keys or gifts.
- `gems` (BotPushRequestGems) — The gem market: gems the bot holds and its gem prices.
- `isOnline` (boolean) — Whether the bot is accepting trades.
- `keys` (BotPushRequestKeys) — Keys and tickets the bot holds, which is what it can pay with when it buys.
- `payment` (BotPushRequestPayment) — The Steam items the bot takes as each currency.
- `profile` (BotPushRequestProfile) — How users reach the bot and who its stock is for.
- `rules` (object | null) — Which users and trades the bot accepts. A rule you leave out keeps its stored value; null clears every rule.
- `sets` (BotPushRequestSets) — Card sets: normal and foil stock and prices, and limits.
- `steamId64` (string) — SteamID64 of the bot this push is for. Required with your account key, which pushes for every bot you own. Optional with a bot key, and then it must be that bot's.

Request body example:

```json
{
  "client": {
    "name": "Steam-levelup-BOT",
    "version": "2.4.1"
  },
  "commands": [
    "!help",
    "!prices",
    "!buytf",
    "!check"
  ],
  "features": [
    {
      "commands": [
        "!check",
        "!buytf"
      ],
      "feature": "badgeAware"
    }
  ],
  "games": {
    "prices": {
      "keysPerGame": {
        "tf2": {
          "sell": 1.5
        }
      }
    },
    "stock": {
      "730": 2
    }
  },
  "gems": {
    "prices": {
      "gemsPerKey": {
        "tf2": {
          "buy": 3600,
          "sell": 3400
        }
      }
    },
    "stock": 100000
  },
  "isOnline": true,
  "keys": {
    "stock": {
      "tf2": 10,
      "tod": 0
    }
  },
  "payment": {
    "tf2": {
      "items": [
        "Mann Co. Supply Crate Key"
      ]
    }
  },
  "profile": {
    "languages": {
      "default": "en",
      "supported": [
        "en",
        "pt"
      ]
    },
    "levelRange": {
      "max": 200,
      "min": 1
    },
    "website": "https://example.com/order"
  },
  "rules": {
    "acceptsTradeHolds": false,
    "acceptsVacBannedUsers": true
  },
  "sets": {
    "limits": {
      "maxPerUserPerApp": 5
    },
    "normal": {
      "prices": {
        "setsPerKey": {
          "tf2": {
            "buy": 14,
            "sell": 12
          }
        }
      },
      "stock": {
        "440": 3
      }
    }
  },
  "steamId64": "76561199756787903"
}
```

**Responses**

- `200` — OK
- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `422` — Unprocessable Entity
- `429` — Too Many Requests
- `500` — Internal Server Error

Response example, 200:

```json
{
  "isClientOutdated": true,
  "issues": [
    {
      "code": "foilWithoutBadge",
      "message": "string",
      "path": "sets.foil.stock.440"
    }
  ],
  "staleAt": "2019-08-24T14:15:22Z",
  "stored": {
    "games": {
      "copies": 0,
      "titles": 0
    },
    "gems": 0,
    "keys": 0,
    "sets": {
      "apps": 0,
      "foil": 0,
      "normal": 0
    }
  }
}
```
