CS2FarmBot API
Contents
Quick start
- Make a key in Account settings → API with your server's public IP address, and copy it: it is shown only once.
- Put the key in the environment variable
CFB_KEYon your server and make a first call,GET /v1/me:curl https://cs2farmbot.com/api/v1/me -H "Authorization: Bearer $CFB_KEY" - Poll
GET /v1/eventsto follow what happens on your accounts: see Events.
The CS2FarmBot API lets your own programs do what you do in the dashboard: add and manage your Steam accounts, start and stop them, and read their drops, matches, inventory, Steam Market and activity.
It answers JSON over HTTPS at https://cs2farmbot.com/api/v1/. The whole API is also in one OpenAPI 3.1 file for code generators and API tools.
Getting a key
- Open Account settings → API, enter the one IP address your server calls from, and choose Create key.
- The key is shown once, right after it is made: copy it then. We keep only a one-way hash of it and its first 8 characters, so it can't be shown again.
- You have one key. Refresh key makes a new one and the old key stops working at once; Delete key removes it. You can change the allowed IP address at any time.
- Any customer can make a key, but calls work only while your plan is active. Without an active plan every endpoint answers
403 plan_inactive, exceptGET /v1/me, which shows your plan. The same key works again once the plan is renewed. - Changing your password or signing out everywhere doesn't change the key. If someone else may have it, refresh or delete it.
- Settings shows when the key was last used, the last refused call and your last 20 calls, with the time and the IP address.
Authentication
Send the key in the Authorization header of every call:
Authorization: Bearer cfb_…A key is cfb_ and 40 letters and digits. The examples on this page read it from an environment variable:
export CFB_KEY='cfb_…' # your key
curl https://cs2farmbot.com/api/v1/me \
-H "Authorization: Bearer $CFB_KEY"- A missing, wrong, refreshed or deleted key, a call from another IP address and a suspended account all get the same answer:
401 unauthorized. - Bodies are JSON: send
Content-Type: application/json(else415). A body can be up to 1 MB, an import up to 20 MB (else413). - Fields an endpoint doesn't know, in the body or the query, are refused with
400 invalid_requestand the field's name. - Answers are JSON in English, whatever language your account uses. The whole API in one file: OpenAPI 3.1.
Your IP address
- A key works from exactly one IP address, IPv4 or IPv6 (no ranges). A call from any other address gets
401 unauthorized, even with the right key. - Enter the address we see: your server's public outgoing address. To see it, run this on your server and read the
ip=line:
curl https://cs2farmbot.com/cdn-cgi/trace- A server that can reach us over IPv6 usually arrives with its IPv6 address. Enter that one, or make your client use IPv4 (for example
curl -4) and enter the IPv4 address. - An IPv6 address matches however it is written (leading zeros,
::). An IPv4 address written as IPv6 (::ffff:203.0.113.7) is saved as the IPv4 address. - Private, loopback and other reserved addresses can't be used, and neither can Cloudflare's: a Cloudflare Worker calls from shared Cloudflare addresses.
- Hosting without a fixed outgoing IP address (many serverless platforms) needs one: a static outgoing IP from your host, or a small server with a fixed address in front.
- A
401answer shows the address we saw indetails.yourIp, so you can check which address to allow. - When a call is refused, Account settings → API shows its time and address under Last refused.
Errors
Every error answer has the same shape:
{
"error": {
"code": "invalid_password",
"message": "The password is not valid.",
"field": "password",
"details": {
"rule": "short",
"min": 6
}
}
}codeis stable: build on it, not on the message.messageis the code's fixed English text.fieldnames the input the error is about, as a path such asmaFiles.2.text. It never repeats what you sent.detailsholds values you can act on:rule(which check failed),min,limitandadded,accountIdwithalready_added, andyourIpwithunauthorized.invalid_passwordrules:empty,short(withmin),long,chars,space.invalid_mafilerules:empty,too_big,not_json,not_mafile,no_account_name,no_shared_secret,bad_identity_secret,bad_steam_id,other_account,unreadable.- The
429answers (rate_limited,prime_check_too_soon) carry aRetry-Afterheader: the seconds to wait. - A method a path doesn't have answers a plain
405without JSON. - A body over the size limit may be refused by our web server with a plain
413without JSON, before it reaches the API. - An unknown path answers a plain
404.
| Code | Status | Message |
|---|---|---|
unauthorized | 401 | Missing or invalid API key. |
plan_inactive | 403 | Your plan is not active. |
rate_limited | 429 | Too many requests. Try again later. |
invalid_request | 400 | The request is not valid. |
unsupported_media_type | 415 | The request body must be JSON (Content-Type: application/json). |
payload_too_large | 413 | The request body is too large. |
account_not_found | 404 | Account not found. |
internal_error | 500 | Something went wrong on our side. Try again later. |
invalid_login | 400 | The login is not a valid Steam login name. Use the Steam username (3-64 letters, digits or _ . @ + -), not the profile name. |
invalid_password | 400 | The password is not valid. |
invalid_shared_secret | 400 | The shared secret is missing or not valid. Copy it exactly from the maFile: 28 characters ending with =. |
invalid_identity_secret | 400 | The identity secret is missing or not valid. Copy it exactly from the maFile: 28 characters ending with =. |
invalid_mafile | 400 | The maFile is not valid, or it is for a different Steam account. |
invalid_country | 400 | This proxy country is not in the list. |
already_added | 409 | This account is already in your accounts. |
cannot_add | 422 | We couldn't add this account. Check the details and try again. |
intake_hold | 409 | Some accounts couldn't sign in, so adding accounts waits until we've checked them. |
plan_full | 409 | Your plan has no room for more accounts. |
daily_limit | 409 | You can add up to your plan's account limit per 24 hours. |
prime_check_not_needed | 409 | This account doesn't need a Prime check right now. |
prime_check_too_soon | 429 | This account's Prime was checked a short while ago. Try again later. |
import_too_large | 400 | The import is too big: send at most 2,000 lines and 2,000 maFiles at once. |
import_empty | 400 | The import has no lines or maFiles. Send at least one line or one maFile. |
import_has_errors | 422 | Some lines or maFiles have errors (see rows). Nothing was added. |
no_accounts | 404 | No accounts to change. |
too_many | 400 | Remove at most 1,000 accounts at a time. |
scope_changed | 409 | There are more accounts in this scope than expected. Nothing was removed. |
sell_all_panel_only | 403 | Turning on "Everything" needs the emailed code in the panel. |
These codes appear only as a row's error inside an import's rows, never as an answer's own error. A row can also have invalid_login, invalid_password, invalid_shared_secret, invalid_identity_secret or invalid_mafile.
| Code | Status | Message |
|---|---|---|
row_format | 422 | The line is not in the form login:password, optionally followed by :shared_secret and :identity_secret. |
row_duplicate | 422 | This account is listed more than once in the import (two lines or two maFiles). |
row_keys_and_file | 422 | This account has Steam Guard secrets on its line and a maFile. Keep one. |
row_no_password | 422 | This maFile has no login:password line. A maFile on its own only updates an account already in your accounts. |
Rate limits
- 120 calls a minute, over all your calls.
- Heavy reads also count in a limit of 30 a minute:
GET /v1/accounts,GET /v1/accounts/{id},GET /v1/stats,GET /v1/inventory,GET /v1/market. - At most 2 heavy reads run at the same time per customer; a third answers
429 rate_limitedwithRetry-After: 1. - After 20 failed key checks from one address in 10 minutes (for IPv6: one /64 network), that address gets
429 rate_limiteduntil the 10 minutes are over, before its key is even looked at. - Every answer to a call that passes the key check carries
X-RateLimit-Limit(120),X-RateLimit-Remaining(calls left in this minute) andX-RateLimit-Reset(seconds until the minute ends); heavy reads also carryX-RateLimit-Heavy-Limit(30),X-RateLimit-Heavy-RemainingandX-RateLimit-Heavy-Reset.
Changes also count in the dashboard's own limits, the same counters the dashboard uses, so your calls and your clicks add up:
| What | Limit |
|---|---|
| Changes to one account: adding it, changing it, a new password or secrets, a Prime check, removing it | 60 per 10 minutes |
| Adding accounts from one IP address (one by one and imports) | 60 per 10 minutes |
| Imports, checked or added | 30 per 10 minutes |
| Bulk actions | 10 per 10 minutes |
| Market settings changes (shared with the settings you save in the dashboard) | 30 per 10 minutes |
| A Prime check of one account | once per 6-hour window |
The windows start on the clock (each minute, each 10 minutes, each 6 hours), they don't slide. A limited call answers 429 with Retry-After: the seconds until its window ends.
Lists and cursors
A list answers {"data": [...], "next": "..."}:
limitsets how many rows a page has: 50 when you leave it out, at most 200.- When
nextisn't null, send it ascursor, with the same filters, for the next page.nullmeans this is the last page. - A cursor is opaque: don't build or change one. A changed or malformed cursor is refused with
400 invalid_requestoncursor; use a cursor only with the list and filters that gave it. - Lists are newest first unless the endpoint says otherwise: accounts are oldest first (by when they were added), and matches can be sorted oldest first.
- A row that stays in the list unchanged is never repeated or skipped while you page. Lists never send a total count.
- The inventory is the exception: fixed pages of 50 (no
limit). Each account's inventory is replaced whenever our servers look at it again, so a page can repeat or miss an item that changed in between.
Dates and money
- Times are ISO 8601 strings in UTC, such as
2026-11-03T09:42:10.000Z. - Times you send (
fromandtoof drops and matches) are ISO 8601 times withZor an offset; a date alone is refused. In a query string a+must be sent as%2B:from=2026-11-03T10:00:00%2B02:00. GET /v1/statstakes days instead:fromandtoasYYYY-MM-DD, both included, in the time zonetz(an IANA name such asEurope/Berlin; UTC when left out). Old alias names such asUS/PacificorCETare refused. Givepresetorfrom/to, not both.- Times and days you send must be in the years 2000 to 2099; others are refused with
400 invalid_requeston that field. - Money is a whole number of US cents:
1840is $18.40.nullmeans the price is unknown, never $0. - An event's
dayis a day (YYYY-MM-DD) in your account's time zone.
Events
There are no webhooks: we never call your server. To follow what happens on your accounts, poll GET /v1/events:
- Read the history: call it without
since. Lines come newest first, in pages withcursor. The first page also haspollCursor. - Poll for changes: call it with
sinceset to thatpollCursor. You get the lines added or changed since then, oldest change first, and anextthat is never null. Keep it and poll withsinceset to it next time. When a full page comes back, poll again at once.
- A line can come again with the same
idwhen it changed: a daily summary grows as matches end, a Steam Market sales line as more sales come in. Replace the line you have with that id. - Use the same
accountIdandgroupfilters on every call of one feed.sinceandcursordon't go together. - In the history, a daily summary that changes while you page can show up on two pages.
- Daily summaries rebuilt after a change of your time zone come with new ids; the old lines are gone, and no change announces it.
- Lines from before the API existed are only in the history, not in the change polling unless they change: a change moves them in.
- New lines can wait while a long task runs on our database. They are never lost or reordered.
accountIdis null for lines about the whole service (maintenance), several accounts at once (bulk actions) or a removed account. TheaccountIdfilter still finds a removed account's lines.textis the line as the dashboard's Activity list shows it, in English with UTC dates and US dollars, without a final full stop. It names at most 4 items;data.itemslists them all.
data has only the keys a line needs:
| Key | What it holds |
|---|---|
items | The items: name and cents (null: unknown). |
until | When the farm tries an account again after a short CS2 pause, when a Market stop ends, or when a requested trade link change takes effect (line trade_link_change_requested), as an ISO time. |
estimated | Whether a time or XP is an estimate. |
minutes | How long a short CS2 pause lasted (line cooldown_ended). |
count | How many accounts, items or sales. |
day | A daily summary's day (YYYY-MM-DD) in your time zone. |
matches, xp | A daily summary's matches and XP. |
mode | What a trade sent: drops, all, keys. |
reason | Why a trade ended as it did: moved, not_tradable, identity_invalid, trade_link_invalid, partner_cannot_trade, inventory_full, items_unavailable, canceled, countered, escrow, not_confirmed, own_account, steam_error. |
ban | Which ban (lines banned, restricted, ban_lifted): vac, game, trade, community, login_refused, cooldown. |
onAdd | The ban was already there when the account was added. |
status | Why the Steam Market stopped the account (line market_problem): locked, not_allowed, no_wallet. |
cents | A Market sales or TF2 key line's value (null: unknown). |
enabled | Maintenance started (true) or ended (false). |
The type of a line, by group:
| Group | Types |
|---|---|
matches | game_update, maintenance, account_verified, daily_summary |
drops | reached_drop, drops_claimed, medal_claimed |
trades | trade_sent, trade_accepted, trade_declined, trade_expired, trade_failed, trade_skipped, market_sold, keys_bought |
problems | cooldown, cooldown_ended, wrong_password, steam_guard, banned, restricted, ban_lifted, not_leveling, not_prime, under_review, anti_cheat_kick, job_failed, account_detached, accounts_held, market_problem |
changes | account_added, accounts_added, account_removed, account_paused, account_resumed, password_replaced, guard_replaced, prime_recheck, accounts_resumed, accounts_paused, trade_link_set, trade_link_change_requested, trade_link_changed, trade_link_change_canceled, trade_mode_all, trade_mode_drops, auto_trade_on, auto_trade_off, accounts_auto_trade_on, accounts_auto_trade_off, kick_others_on, kick_others_off, accounts_kick_others_on, accounts_kick_others_off, claim_medal_on, claim_medal_off, accounts_claim_medal_on, accounts_claim_medal_off, identity_added, identities_added, accounts_secrets_updated, trade_schedule_weekly, trade_schedule_instant, market_on, market_off, accounts_market_on, accounts_market_off, market_sell_all, market_sell_drops, market_how_instant, market_how_list, market_keys_on, market_keys_off |
GET /v1/live is the cheap check for what the bots do right now: version moves on every change the dashboard shows, so poll it and read the rest when it moves. activity is one of logging_in, updating, searching, in_match, stopping, selling; map and since are set only while an account is in_match, else null.
Dashboard rules
The API follows the dashboard's rules:
- New accounts start paused. Start them with
start: truewhen adding one, withPATCH /v1/accounts/{id}andpaused: false, or with the bulk actionstart(for an import:"scope": {"importId": ...}). - Your plan sets how many accounts you can have, and you can add up to your plan's account limit per 24 hours.
GET /v1/meshows how many you can add now (accounts.room) and, when the 24 hours' adds are used up, when the next one frees (accounts.freesAt). - When many new accounts fail to sign in, adding accounts waits until we've checked them (
409 intake_hold). - Auto-trade sends to the trade link set in the dashboard (Account settings → Auto-trade). The API turns auto-trade on or off per account; the trade link and what to send are set in the dashboard.
- Turning the Steam Market on for an account needs an active plan. Market "Everything" (sell every item Steam lets the account sell) is turned on in the dashboard only, with its emailed code; the API can choose "Farmed drops only", how to sell and TF2 keys (
403 sell_all_panel_only). - Removing an account wipes its password and secrets at once; its history stays. A bulk remove needs
expected, the number of accounts you mean to remove: when the scope holds more, nothing is removed (409 scope_changed).
Your plan
GET /v1/me
Your plan, and how many accounts you can add now.
Works without an active plan.
- Answers without an active plan too, so a client can see why the other endpoints answer
plan_inactive. accounts.roomis how many accounts you can add right now: your plan's room and its adds per 24 hours. While the 24 hours' adds are used up,accounts.freesAtsays when the next one frees.
No parameters.
Example
curl
curl https://cs2farmbot.com/api/v1/me \
-H "Authorization: Bearer $CFB_KEY"JavaScript
const res = await fetch("https://cs2farmbot.com/api/v1/me", {
method: "GET",
headers: { Authorization: `Bearer ${process.env.CFB_KEY}` }
});
const data = await res.json();
console.log(res.status, data);Python
import os
import requests
res = requests.get(
"https://cs2farmbot.com/api/v1/me",
headers={"Authorization": "Bearer " + os.environ["CFB_KEY"]},
)
print(res.status_code, res.json())Answer: 200
{
"plan": {
"status": "active",
"endedOn": null,
"endedWhy": null,
"id": "starter",
"endsAt": "2026-12-03T10:00:00.000Z",
"autoRenew": true,
"accountLimit": 50
},
"accounts": {
"added": 12,
"room": 38,
"freesAt": null
}
}Errors: unauthorized 401, rate_limited 429, invalid_request 400, internal_error 500
Accounts
GET /v1/accounts
Your accounts and their status, oldest first.
Heavy read: also counts in the limit of 30 a minute.
- Oldest first, by when the account was added. Recent events of an account:
GET /v1/events?accountId=. inventory.centsandinventory.countleave out items in an open Steam Market listing and items sold on the Steam Market.
| Name | In | Type | What it is |
|---|---|---|---|
limit | query | whole number, 1 to 200, default 50 | How many rows a page has. |
cursor | query | text, up to 1,024 characters | The next of the page before, for the page after it. Leave it out for the first page. |
status | query | one of: farming, starting, signin, logging_in, updating, searching, in_match, stopping, selling, queued, in_use, retrying, not_available, limit_reached, done, wrong_password, steam_guard, not_prime, not_leveling, attention, under_review, banned, held, cooldown, over_limit, no_plan, paused | Only accounts with this status. farming: in a match; starting: signing in, updating or searching for a game; signin: needs a new password or Steam Guard, or held; any other value is that status. |
q | query | text, up to 64 characters | Only accounts whose login or Steam name contains this text. |
Example
curl
curl https://cs2farmbot.com/api/v1/accounts \
-H "Authorization: Bearer $CFB_KEY"JavaScript
const res = await fetch("https://cs2farmbot.com/api/v1/accounts", {
method: "GET",
headers: { Authorization: `Bearer ${process.env.CFB_KEY}` }
});
const data = await res.json();
console.log(res.status, data);Python
import os
import requests
res = requests.get(
"https://cs2farmbot.com/api/v1/accounts",
headers={"Authorization": "Bearer " + os.environ["CFB_KEY"]},
)
print(res.status_code, res.json())Answer: 200
{
"data": [
{
"id": "3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41",
"login": "farm_account_01",
"name": "Farm Account 01",
"avatarUrl": null,
"level": 12,
"levelXp": 3150,
"weekProgress": 63,
"status": "in_match",
"reason": null,
"cooldownUntil": null,
"cooldownEstimated": false,
"paused": false,
"stopping": false,
"hasPassword": true,
"hasSharedSecret": true,
"hasIdentitySecret": true,
"prime": true,
"proxyCountry": "DE",
"signedInCountry": "DE",
"autoTrade": true,
"kickOtherSessions": false,
"claimServiceMedal": true,
"market": false,
"marketStatus": "off",
"marketUntil": null,
"marketSteamText": null,
"walletCents": null,
"keys": {
"held": null,
"onHold": null,
"holdUntil": null
},
"addedAt": "2026-10-01T08:30:00.000Z",
"medalClaimedAt": null,
"weekDrops": [],
"dropReceived": false,
"dropClaimed": false,
"inventory": {
"cents": 1840,
"count": 23,
"at": "2026-11-02T21:14:05.000Z"
},
"live": {
"map": "de_dust2",
"since": "2026-11-03T09:52:10.000Z"
},
"restriction": null,
"banned": false,
"cooling": false,
"tradeBlocked": false
}
],
"next": null
}Errors: unauthorized 401, rate_limited 429, plan_inactive 403, invalid_request 400, internal_error 500
GET /v1/accounts/{id}
One account and its XP this week.
Heavy read: also counts in the limit of 30 a minute.
weekXpis the account's matches and XP since the weekly reset.inventory.centsandinventory.countleave out items in an open Steam Market listing and items sold on the Steam Market.
| Name | In | Type | What it is |
|---|---|---|---|
idrequired | path | text | The account's id (id in GET /v1/accounts). |
Example
curl
curl https://cs2farmbot.com/api/v1/accounts/3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41 \
-H "Authorization: Bearer $CFB_KEY"JavaScript
const res = await fetch("https://cs2farmbot.com/api/v1/accounts/3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41", {
method: "GET",
headers: { Authorization: `Bearer ${process.env.CFB_KEY}` }
});
const data = await res.json();
console.log(res.status, data);Python
import os
import requests
res = requests.get(
"https://cs2farmbot.com/api/v1/accounts/3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41",
headers={"Authorization": "Bearer " + os.environ["CFB_KEY"]},
)
print(res.status_code, res.json())Answer: 200
{
"account": {
"id": "3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41",
"login": "farm_account_01",
"name": "Farm Account 01",
"avatarUrl": null,
"level": 12,
"levelXp": 3150,
"weekProgress": 63,
"status": "in_match",
"reason": null,
"cooldownUntil": null,
"cooldownEstimated": false,
"paused": false,
"stopping": false,
"hasPassword": true,
"hasSharedSecret": true,
"hasIdentitySecret": true,
"prime": true,
"proxyCountry": "DE",
"signedInCountry": "DE",
"autoTrade": true,
"kickOtherSessions": false,
"claimServiceMedal": true,
"market": false,
"marketStatus": "off",
"marketUntil": null,
"marketSteamText": null,
"walletCents": null,
"keys": {
"held": null,
"onHold": null,
"holdUntil": null
},
"addedAt": "2026-10-01T08:30:00.000Z",
"medalClaimedAt": null,
"weekDrops": [],
"dropReceived": false,
"dropClaimed": false,
"inventory": {
"cents": 1840,
"count": 23,
"at": "2026-11-02T21:14:05.000Z"
},
"live": {
"map": "de_dust2",
"since": "2026-11-03T09:52:10.000Z"
},
"restriction": null,
"banned": false,
"cooling": false,
"tradeBlocked": false
},
"weekXp": {
"xp": 8150,
"matches": 9,
"estimated": false
}
}Errors: unauthorized 401, rate_limited 429, plan_inactive 403, invalid_request 400, account_not_found 404, internal_error 500
POST /v1/accounts
Add one Steam account; it starts paused unless start is true.
- The account starts paused unless
startistrue. - Adding a login you already have answers
409 already_addedwith the account's id indetails.accountId, so a retry after a lost answer is safe. To change its password or secrets, use thePUTendpoints. - A login over 64 or a password over 256 characters is refused (
invalid_requestwith the field), never cut. invalid_passwordandinvalid_mafilesay which check failed indetails.rule.
| Name | In | Type | What it is |
|---|---|---|---|
loginrequired | body | text, up to 64 characters | The Steam login name (the username you sign in with, not the profile name). |
passwordrequired | body | text, up to 256 characters | The Steam password. |
sharedSecret | body | text, up to 64 characters | The Steam Guard shared secret (28 characters ending with =). Give it or a maFile. |
identitySecret | body | text, up to 64 characters | The identity secret (28 characters ending with =), needed for auto-trade and the Steam Market. Optional. |
maFile | body | text, up to 65,536 characters | The maFile's text (its JSON), instead of the secrets: the shared secret and, when it has one, the identity secret are read from it. |
country | body | text | The proxy country the account signs in to Steam through: AT, BE, BG, HR, CZ, DK, EE, FI, FR, DE, GR, HU, IE, IT, LV, LT, NL, NO, PL, PT, RO, RU, SK, SI, ES, SE, CH, TR. Leave it out for DE; an empty value is refused. |
start | body | true or false | true starts farming at once. Left out or false, the account starts paused. |
Example
curl
curl -X POST https://cs2farmbot.com/api/v1/accounts \
-H "Authorization: Bearer $CFB_KEY" \
-H "Content-Type: application/json" \
-d '{
"login": "farm_account_01",
"password": "your-steam-password",
"sharedSecret": "AAAAAAAAAAAAAAAAAAAAAAAAAAA=",
"country": "DE"
}'JavaScript
const res = await fetch("https://cs2farmbot.com/api/v1/accounts", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CFB_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
"login": "farm_account_01",
"password": "your-steam-password",
"sharedSecret": "AAAAAAAAAAAAAAAAAAAAAAAAAAA=",
"country": "DE"
})
});
const data = await res.json();
console.log(res.status, data);Python
import os
import requests
res = requests.post(
"https://cs2farmbot.com/api/v1/accounts",
headers={"Authorization": "Bearer " + os.environ["CFB_KEY"]},
json={
"login": "farm_account_01",
"password": "your-steam-password",
"sharedSecret": "AAAAAAAAAAAAAAAAAAAAAAAAAAA=",
"country": "DE"
},
)
print(res.status_code, res.json())Answer: 201
{
"account": {
"id": "3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41",
"login": "farm_account_01",
"name": "farm_account_01",
"avatarUrl": null,
"level": null,
"levelXp": 0,
"weekProgress": 0,
"status": "paused",
"reason": null,
"cooldownUntil": null,
"cooldownEstimated": false,
"paused": true,
"stopping": false,
"hasPassword": true,
"hasSharedSecret": true,
"hasIdentitySecret": true,
"prime": null,
"proxyCountry": "DE",
"signedInCountry": null,
"autoTrade": false,
"kickOtherSessions": false,
"claimServiceMedal": true,
"market": false,
"marketStatus": "off",
"marketUntil": null,
"marketSteamText": null,
"walletCents": null,
"keys": {
"held": null,
"onHold": null,
"holdUntil": null
},
"addedAt": "2026-11-03T10:15:00.000Z",
"medalClaimedAt": null,
"weekDrops": [],
"dropReceived": false,
"dropClaimed": false,
"inventory": null,
"live": null,
"restriction": null,
"banned": false,
"cooling": false,
"tradeBlocked": false
}
}Errors: unauthorized 401, rate_limited 429, plan_inactive 403, invalid_request 400, unsupported_media_type 415, payload_too_large 413, internal_error 500, invalid_login 400, invalid_password 400, invalid_shared_secret 400, invalid_identity_secret 400, invalid_mafile 400, invalid_country 400, already_added 409, cannot_add 422, intake_hold 409, plan_full 409, daily_limit 409
PATCH /v1/accounts/{id}
Turn an account's farming, kick other sessions, auto-trade, Steam Market or Claim Service Medal on or off, or change its proxy country.
- Send at least one field. Every field is checked before any is saved; a value the account already has changes nothing.
- Turning the Steam Market on needs an active plan.
| Name | In | Type | What it is |
|---|---|---|---|
idrequired | path | text | The account's id (id in GET /v1/accounts). |
paused | body | true or false | true stops farming (the account is paused), false starts it. |
kickOtherSessions | body | true or false | Kick other sessions on or off: end another session playing on the account so the farm can play. |
autoTrade | body | true or false | Auto-trade on or off. Trades go to the trade link set in the dashboard. |
market | body | true or false | The Steam Market on or off for this account. On needs an active plan. |
claimServiceMedal | body | true or false | Claim Service Medal on or off. On: at level 40 the account claims this year's Service Medal. Off: it stays at level 40 and keeps farming its weekly drop. |
proxyCountry | body | text | The proxy country the account signs in to Steam through: AT, BE, BG, HR, CZ, DK, EE, FI, FR, DE, GR, HU, IE, IT, LV, LT, NL, NO, PL, PT, RO, RU, SK, SI, ES, SE, CH, TR. |
Example
curl
curl -X PATCH https://cs2farmbot.com/api/v1/accounts/3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41 \
-H "Authorization: Bearer $CFB_KEY" \
-H "Content-Type: application/json" \
-d '{
"paused": false,
"autoTrade": true,
"proxyCountry": "NL"
}'JavaScript
const res = await fetch("https://cs2farmbot.com/api/v1/accounts/3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41", {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.CFB_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
"paused": false,
"autoTrade": true,
"proxyCountry": "NL"
})
});
const data = await res.json();
console.log(res.status, data);Python
import os
import requests
res = requests.patch(
"https://cs2farmbot.com/api/v1/accounts/3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41",
headers={"Authorization": "Bearer " + os.environ["CFB_KEY"]},
json={
"paused": False,
"autoTrade": True,
"proxyCountry": "NL"
},
)
print(res.status_code, res.json())Answer: 200
{
"account": {
"id": "3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41",
"login": "farm_account_01",
"name": "Farm Account 01",
"avatarUrl": null,
"level": 12,
"levelXp": 3150,
"weekProgress": 63,
"status": "in_match",
"reason": null,
"cooldownUntil": null,
"cooldownEstimated": false,
"paused": false,
"stopping": false,
"hasPassword": true,
"hasSharedSecret": true,
"hasIdentitySecret": true,
"prime": true,
"proxyCountry": "NL",
"signedInCountry": "DE",
"autoTrade": true,
"kickOtherSessions": false,
"claimServiceMedal": true,
"market": false,
"marketStatus": "off",
"marketUntil": null,
"marketSteamText": null,
"walletCents": null,
"keys": {
"held": null,
"onHold": null,
"holdUntil": null
},
"addedAt": "2026-10-01T08:30:00.000Z",
"medalClaimedAt": null,
"weekDrops": [],
"dropReceived": false,
"dropClaimed": false,
"inventory": {
"cents": 1840,
"count": 23,
"at": "2026-11-02T21:14:05.000Z"
},
"live": {
"map": "de_dust2",
"since": "2026-11-03T09:52:10.000Z"
},
"restriction": null,
"banned": false,
"cooling": false,
"tradeBlocked": false
}
}Errors: unauthorized 401, rate_limited 429, plan_inactive 403, invalid_request 400, unsupported_media_type 415, payload_too_large 413, internal_error 500, account_not_found 404, invalid_country 400
DELETE /v1/accounts/{id}
Remove an account: its password and secrets are wiped, its history stays.
- Its password and secrets are wiped at once. Its drops, matches and activity stay in your history.
| Name | In | Type | What it is |
|---|---|---|---|
idrequired | path | text | The account's id (id in GET /v1/accounts). |
Example
curl
curl -X DELETE https://cs2farmbot.com/api/v1/accounts/3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41 \
-H "Authorization: Bearer $CFB_KEY"JavaScript
const res = await fetch("https://cs2farmbot.com/api/v1/accounts/3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41", {
method: "DELETE",
headers: { Authorization: `Bearer ${process.env.CFB_KEY}` }
});
const data = await res.json();
console.log(res.status, data);Python
import os
import requests
res = requests.delete(
"https://cs2farmbot.com/api/v1/accounts/3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41",
headers={"Authorization": "Bearer " + os.environ["CFB_KEY"]},
)
print(res.status_code, res.json())Answer: 200
{
"removed": true
}Errors: unauthorized 401, rate_limited 429, plan_inactive 403, invalid_request 400, internal_error 500, account_not_found 404
PUT /v1/accounts/{id}/password
Replace an account's Steam password.
| Name | In | Type | What it is |
|---|---|---|---|
idrequired | path | text | The account's id (id in GET /v1/accounts). |
passwordrequired | body | text, up to 256 characters | The Steam password. |
Example
curl
curl -X PUT https://cs2farmbot.com/api/v1/accounts/3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41/password \
-H "Authorization: Bearer $CFB_KEY" \
-H "Content-Type: application/json" \
-d '{
"password": "your-new-steam-password"
}'JavaScript
const res = await fetch("https://cs2farmbot.com/api/v1/accounts/3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41/password", {
method: "PUT",
headers: {
Authorization: `Bearer ${process.env.CFB_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
"password": "your-new-steam-password"
})
});
const data = await res.json();
console.log(res.status, data);Python
import os
import requests
res = requests.put(
"https://cs2farmbot.com/api/v1/accounts/3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41/password",
headers={"Authorization": "Bearer " + os.environ["CFB_KEY"]},
json={
"password": "your-new-steam-password"
},
)
print(res.status_code, res.json())Answer: 200
{
"account": {
"id": "3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41",
"login": "farm_account_01",
"name": "Farm Account 01",
"avatarUrl": null,
"level": 12,
"levelXp": 3150,
"weekProgress": 63,
"status": "in_match",
"reason": null,
"cooldownUntil": null,
"cooldownEstimated": false,
"paused": false,
"stopping": false,
"hasPassword": true,
"hasSharedSecret": true,
"hasIdentitySecret": true,
"prime": true,
"proxyCountry": "DE",
"signedInCountry": "DE",
"autoTrade": true,
"kickOtherSessions": false,
"claimServiceMedal": true,
"market": false,
"marketStatus": "off",
"marketUntil": null,
"marketSteamText": null,
"walletCents": null,
"keys": {
"held": null,
"onHold": null,
"holdUntil": null
},
"addedAt": "2026-10-01T08:30:00.000Z",
"medalClaimedAt": null,
"weekDrops": [],
"dropReceived": false,
"dropClaimed": false,
"inventory": {
"cents": 1840,
"count": 23,
"at": "2026-11-02T21:14:05.000Z"
},
"live": {
"map": "de_dust2",
"since": "2026-11-03T09:52:10.000Z"
},
"restriction": null,
"banned": false,
"cooling": false,
"tradeBlocked": false
}
}Errors: unauthorized 401, rate_limited 429, plan_inactive 403, invalid_request 400, unsupported_media_type 415, payload_too_large 413, internal_error 500, account_not_found 404, invalid_password 400
PUT /v1/accounts/{id}/steam-guard
Replace an account's shared secret (pasted or from its maFile); a new identity secret is taken too when given.
- Give
sharedSecretormaFile.
| Name | In | Type | What it is |
|---|---|---|---|
idrequired | path | text | The account's id (id in GET /v1/accounts). |
sharedSecret | body | text, up to 64 characters | The new shared secret (28 characters ending with =). Give it or a maFile. |
identitySecret | body | text, up to 64 characters | A new identity secret too (28 characters ending with =). Optional. |
maFile | body | text, up to 65,536 characters | The maFile's text (its JSON), instead of the secrets. It must be this account's. |
Example
curl
curl -X PUT https://cs2farmbot.com/api/v1/accounts/3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41/steam-guard \
-H "Authorization: Bearer $CFB_KEY" \
-H "Content-Type: application/json" \
-d '{
"sharedSecret": "AAAAAAAAAAAAAAAAAAAAAAAAAAA="
}'JavaScript
const res = await fetch("https://cs2farmbot.com/api/v1/accounts/3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41/steam-guard", {
method: "PUT",
headers: {
Authorization: `Bearer ${process.env.CFB_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
"sharedSecret": "AAAAAAAAAAAAAAAAAAAAAAAAAAA="
})
});
const data = await res.json();
console.log(res.status, data);Python
import os
import requests
res = requests.put(
"https://cs2farmbot.com/api/v1/accounts/3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41/steam-guard",
headers={"Authorization": "Bearer " + os.environ["CFB_KEY"]},
json={
"sharedSecret": "AAAAAAAAAAAAAAAAAAAAAAAAAAA="
},
)
print(res.status_code, res.json())Answer: 200
{
"account": {
"id": "3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41",
"login": "farm_account_01",
"name": "Farm Account 01",
"avatarUrl": null,
"level": 12,
"levelXp": 3150,
"weekProgress": 63,
"status": "in_match",
"reason": null,
"cooldownUntil": null,
"cooldownEstimated": false,
"paused": false,
"stopping": false,
"hasPassword": true,
"hasSharedSecret": true,
"hasIdentitySecret": true,
"prime": true,
"proxyCountry": "DE",
"signedInCountry": "DE",
"autoTrade": true,
"kickOtherSessions": false,
"claimServiceMedal": true,
"market": false,
"marketStatus": "off",
"marketUntil": null,
"marketSteamText": null,
"walletCents": null,
"keys": {
"held": null,
"onHold": null,
"holdUntil": null
},
"addedAt": "2026-10-01T08:30:00.000Z",
"medalClaimedAt": null,
"weekDrops": [],
"dropReceived": false,
"dropClaimed": false,
"inventory": {
"cents": 1840,
"count": 23,
"at": "2026-11-02T21:14:05.000Z"
},
"live": {
"map": "de_dust2",
"since": "2026-11-03T09:52:10.000Z"
},
"restriction": null,
"banned": false,
"cooling": false,
"tradeBlocked": false
}
}Errors: unauthorized 401, rate_limited 429, plan_inactive 403, invalid_request 400, unsupported_media_type 415, payload_too_large 413, internal_error 500, account_not_found 404, invalid_shared_secret 400, invalid_identity_secret 400, invalid_mafile 400
PUT /v1/accounts/{id}/identity-secret
Add or replace an account's identity secret (pasted or from its maFile).
- Give
identitySecretormaFile.
| Name | In | Type | What it is |
|---|---|---|---|
idrequired | path | text | The account's id (id in GET /v1/accounts). |
identitySecret | body | text, up to 64 characters | The identity secret (28 characters ending with =). Give it or a maFile. |
maFile | body | text, up to 65,536 characters | The maFile's text (its JSON); its identity secret is used. It must be this account's. |
Example
curl
curl -X PUT https://cs2farmbot.com/api/v1/accounts/3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41/identity-secret \
-H "Authorization: Bearer $CFB_KEY" \
-H "Content-Type: application/json" \
-d '{
"identitySecret": "AAAAAAAAAAAAAAAAAAAAAAAAAAA="
}'JavaScript
const res = await fetch("https://cs2farmbot.com/api/v1/accounts/3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41/identity-secret", {
method: "PUT",
headers: {
Authorization: `Bearer ${process.env.CFB_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
"identitySecret": "AAAAAAAAAAAAAAAAAAAAAAAAAAA="
})
});
const data = await res.json();
console.log(res.status, data);Python
import os
import requests
res = requests.put(
"https://cs2farmbot.com/api/v1/accounts/3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41/identity-secret",
headers={"Authorization": "Bearer " + os.environ["CFB_KEY"]},
json={
"identitySecret": "AAAAAAAAAAAAAAAAAAAAAAAAAAA="
},
)
print(res.status_code, res.json())Answer: 200
{
"account": {
"id": "3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41",
"login": "farm_account_01",
"name": "Farm Account 01",
"avatarUrl": null,
"level": 12,
"levelXp": 3150,
"weekProgress": 63,
"status": "in_match",
"reason": null,
"cooldownUntil": null,
"cooldownEstimated": false,
"paused": false,
"stopping": false,
"hasPassword": true,
"hasSharedSecret": true,
"hasIdentitySecret": true,
"prime": true,
"proxyCountry": "DE",
"signedInCountry": "DE",
"autoTrade": true,
"kickOtherSessions": false,
"claimServiceMedal": true,
"market": false,
"marketStatus": "off",
"marketUntil": null,
"marketSteamText": null,
"walletCents": null,
"keys": {
"held": null,
"onHold": null,
"holdUntil": null
},
"addedAt": "2026-10-01T08:30:00.000Z",
"medalClaimedAt": null,
"weekDrops": [],
"dropReceived": false,
"dropClaimed": false,
"inventory": {
"cents": 1840,
"count": 23,
"at": "2026-11-02T21:14:05.000Z"
},
"live": {
"map": "de_dust2",
"since": "2026-11-03T09:52:10.000Z"
},
"restriction": null,
"banned": false,
"cooling": false,
"tradeBlocked": false
}
}Errors: unauthorized 401, rate_limited 429, plan_inactive 403, invalid_request 400, unsupported_media_type 415, payload_too_large 413, internal_error 500, account_not_found 404, invalid_identity_secret 400, invalid_mafile 400
POST /v1/accounts/{id}/prime-check
Check Prime again at the account's next sign-in (once per account per 6-hour window).
- Once per account per 6-hour window (the window is aligned to the clock, not to your last call): another check in the same window answers
429 prime_check_too_soonwithRetry-After. An account that doesn't need a check answers409 prime_check_not_needed.
| Name | In | Type | What it is |
|---|---|---|---|
idrequired | path | text | The account's id (id in GET /v1/accounts). |
Example
curl
curl -X POST https://cs2farmbot.com/api/v1/accounts/3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41/prime-check \
-H "Authorization: Bearer $CFB_KEY"JavaScript
const res = await fetch("https://cs2farmbot.com/api/v1/accounts/3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41/prime-check", {
method: "POST",
headers: { Authorization: `Bearer ${process.env.CFB_KEY}` }
});
const data = await res.json();
console.log(res.status, data);Python
import os
import requests
res = requests.post(
"https://cs2farmbot.com/api/v1/accounts/3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41/prime-check",
headers={"Authorization": "Bearer " + os.environ["CFB_KEY"]},
)
print(res.status_code, res.json())Answer: 202
{
"status": "queued"
}Errors: unauthorized 401, rate_limited 429, plan_inactive 403, invalid_request 400, internal_error 500, account_not_found 404, prime_check_not_needed 409, prime_check_too_soon 429
POST /v1/accounts/import
Add up to 2,000 accounts at once from login:password lines and maFiles, all or nothing (they start paused); dryRun checks them without adding.
- JSON only (no form upload, no zip), up to 20 MB, with up to 2,000 lines and 2,000 maFiles.
dryRun: trueadds nothing and answers{"ready": ..., "updates": ..., "rows": [...], "error": ...}: how many accounts are ready (0 while anything is wrong), how many of them update an account you already have, every row, and the plan's refusal, if any, as{"code": ...}.- Without
dryRun, everything is added or nothing is: when a line or maFile has an error, nothing is added and the answer is422 import_has_errorswith every row inrowsbesideerror. A row's error is a code (andrule), never your input. - A row:
{"line": 2, "file": null, "login": "farm_account_02", "error": {"code": "row_format"}, "update": null}.updatesays what an add changes on an account you already have:password,password_secretsorsecrets. - A plan refusal (
plan_full,daily_limit,intake_hold) together with bad rows answers the plan refusal only. - New accounts start paused: start them with the bulk action
startand{"importId": ...}. - Its limits are counted before the body is read.
- A maFile larger than 64 KB refuses the whole import:
400 invalid_requestwith the fieldmaFiles.N.text. GET,PATCHandDELETEon this path answer a plain405without JSON.
| Name | In | Type | What it is |
|---|---|---|---|
lines | body | text | One account per line: login:password, optionally followed by :shared_secret and :identity_secret. Give lines, maFiles or both. |
maFiles | body | list of object, up to 2,000 | maFiles as {"name": ..., "text": ...}: a name for the answer's rows (such as the file name) and the file's JSON text. A maFile goes with the line of its account; on its own it only updates an account you already have. |
country | body | text | The proxy country of the new accounts: AT, BE, BG, HR, CZ, DK, EE, FI, FR, DE, GR, HU, IE, IT, LV, LT, NL, NO, PL, PT, RO, RU, SK, SI, ES, SE, CH, TR. Leave it out for DE. |
dryRun | body | true or false | true checks every line and maFile and adds nothing. |
Example
curl
curl -X POST https://cs2farmbot.com/api/v1/accounts/import \
-H "Authorization: Bearer $CFB_KEY" \
-H "Content-Type: application/json" \
-d '{
"lines": "farm_account_01:your-steam-password:AAAAAAAAAAAAAAAAAAAAAAAAAAA=\nfarm_account_02:another-steam-password",
"maFiles": [
{
"name": "farm_account_02.maFile",
"text": "{\"account_name\":\"farm_account_02\",\"shared_secret\":\"AAAAAAAAAAAAAAAAAAAAAAAAAAA=\",\"identity_secret\":\"AAAAAAAAAAAAAAAAAAAAAAAAAAA=\"}"
}
],
"country": "DE"
}'JavaScript
const res = await fetch("https://cs2farmbot.com/api/v1/accounts/import", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CFB_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
"lines": "farm_account_01:your-steam-password:AAAAAAAAAAAAAAAAAAAAAAAAAAA=\nfarm_account_02:another-steam-password",
"maFiles": [
{
"name": "farm_account_02.maFile",
"text": "{\"account_name\":\"farm_account_02\",\"shared_secret\":\"AAAAAAAAAAAAAAAAAAAAAAAAAAA=\",\"identity_secret\":\"AAAAAAAAAAAAAAAAAAAAAAAAAAA=\"}"
}
],
"country": "DE"
})
});
const data = await res.json();
console.log(res.status, data);Python
import os
import requests
res = requests.post(
"https://cs2farmbot.com/api/v1/accounts/import",
headers={"Authorization": "Bearer " + os.environ["CFB_KEY"]},
json={
"lines": "farm_account_01:your-steam-password:AAAAAAAAAAAAAAAAAAAAAAAAAAA=\nfarm_account_02:another-steam-password",
"maFiles": [
{
"name": "farm_account_02.maFile",
"text": "{\"account_name\":\"farm_account_02\",\"shared_secret\":\"AAAAAAAAAAAAAAAAAAAAAAAAAAA=\",\"identity_secret\":\"AAAAAAAAAAAAAAAAAAAAAAAAAAA=\"}"
}
],
"country": "DE"
},
)
print(res.status_code, res.json())Answer: 200
{
"added": 2,
"updated": 0,
"importId": "c41f8e2a-6b3d-4a9c-b2e7-5d1f0a8c3e96",
"accountIds": [
"3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41",
"7a9e2d4b-1c3f-4e5a-8b6d-2f0c9e1a3b57"
]
}Errors: unauthorized 401, rate_limited 429, plan_inactive 403, invalid_request 400, unsupported_media_type 415, payload_too_large 413, internal_error 500, invalid_country 400, import_too_large 400, import_empty 400, import_has_errors 422, plan_full 409, daily_limit 409, intake_hold 409, cannot_add 422
POST /v1/accounts/bulk
Start, stop or remove many accounts, turn their auto-trade, Steam Market, kick other sessions or Claim Service Medal on or off, or set their proxy country: every account, a list of ids or one import.
- Answers how many of your accounts in the scope it changed:
{"changed": ..., "total": ...}, or{"removed": ..., "total": ...}forremove. - Only your own live accounts are changed: other ids in the scope are skipped, and a scope with none of your accounts answers
404 no_accounts. removeneedsexpectedand takes at most 1,000 accounts (too_many).- Turning the Steam Market on needs an active plan.
GET,PATCHandDELETEon this path answer a plain405without JSON.
| Name | In | Type | What it is |
|---|---|---|---|
actionrequired | body | one of: start, stop, remove, autoTrade, market, kickOtherSessions, claimServiceMedal, proxyCountry | What to do. start and stop farming, remove the accounts, or turn autoTrade, market, kickOtherSessions or claimServiceMedal on or off, or set proxyCountry. |
value | body | true or false or text | true or false for autoTrade, market, kickOtherSessions and claimServiceMedal; a country code for proxyCountry; left out for start, stop and remove. |
scoperequired | body | object | Which accounts: {"all": true} (every account), {"ids": [...]} (up to 10,000 account ids) or {"importId": "..."} (the accounts of one import). |
expected | body | whole number, 1 to 99,999 | For remove only, and needed there: how many accounts you expect to remove. When the scope holds more, nothing is removed (scope_changed). |
Example
curl
curl -X POST https://cs2farmbot.com/api/v1/accounts/bulk \
-H "Authorization: Bearer $CFB_KEY" \
-H "Content-Type: application/json" \
-d '{
"action": "stop",
"scope": {
"all": true
}
}'JavaScript
const res = await fetch("https://cs2farmbot.com/api/v1/accounts/bulk", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CFB_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
"action": "stop",
"scope": {
"all": true
}
})
});
const data = await res.json();
console.log(res.status, data);Python
import os
import requests
res = requests.post(
"https://cs2farmbot.com/api/v1/accounts/bulk",
headers={"Authorization": "Bearer " + os.environ["CFB_KEY"]},
json={
"action": "stop",
"scope": {
"all": True
}
},
)
print(res.status_code, res.json())Answer: 200
{
"changed": 12,
"total": 40
}Errors: unauthorized 401, rate_limited 429, plan_inactive 403, invalid_request 400, unsupported_media_type 415, payload_too_large 413, internal_error 500, no_accounts 404, too_many 400, scope_changed 409, invalid_country 400
Results
GET /v1/stats
Your farm's numbers over a date range, by day, week or month.
Heavy read: also counts in the limit of 30 a minute.
- Give
presetorfrom/to, not both. The days are those oftz;bucketin the answer says whether the series is by day, week or month.
| Name | In | Type | What it is |
|---|---|---|---|
preset | query | one of: week, 7d, 30d, month, all | A named range: week (this week, the default), 7d, 30d, month (this month) or all. Not together with from or to. |
from | query | date, YYYY-MM-DD | The first day, in tz. Without to, up to today. |
to | query | date, YYYY-MM-DD | The last day, in tz (included). Without from, from the start. |
tz | query | text, up to 64 characters | The time zone of the days: an IANA name such as Europe/Berlin. UTC when left out; old alias names such as US/Pacific or CET are refused. |
Example
curl
curl 'https://cs2farmbot.com/api/v1/stats?from=2026-11-02&to=2026-11-03&tz=Europe/Berlin' \
-H "Authorization: Bearer $CFB_KEY"JavaScript
const res = await fetch("https://cs2farmbot.com/api/v1/stats?from=2026-11-02&to=2026-11-03&tz=Europe/Berlin", {
method: "GET",
headers: { Authorization: `Bearer ${process.env.CFB_KEY}` }
});
const data = await res.json();
console.log(res.status, data);Python
import os
import requests
res = requests.get(
"https://cs2farmbot.com/api/v1/stats",
headers={"Authorization": "Bearer " + os.environ["CFB_KEY"]},
params={
"from": "2026-11-02",
"to": "2026-11-03",
"tz": "Europe/Berlin"
},
)
print(res.status_code, res.json())Answer: 200
{
"bucket": "day",
"fromDay": "2026-11-02",
"toDay": "2026-11-03",
"series": [
{
"bucket": "2026-11-02",
"matches": 14,
"xp": 6120,
"seconds": 8400
},
{
"bucket": "2026-11-03",
"matches": 5,
"xp": 2030,
"seconds": 3000
}
],
"totals": {
"matches": 19,
"kills": 412,
"deaths": 260,
"headshots": 171,
"score": 1180,
"seconds": 11400,
"xp": 8150,
"drops": 1
}
}Errors: unauthorized 401, rate_limited 429, plan_inactive 403, invalid_request 400, internal_error 500
GET /v1/drops
Your accounts' claimed drops, newest first.
- Newest first, by claim time.
priceCentsis the price when it dropped,currentPriceCentsthe latest known one (null: unknown).
| Name | In | Type | What it is |
|---|---|---|---|
limit | query | whole number, 1 to 200, default 50 | How many rows a page has. |
cursor | query | text, up to 1,024 characters | The next of the page before, for the page after it. Leave it out for the first page. |
accountId | query | id (UUID) | Only this account's rows (its id). |
from | query | ISO 8601 time | Only drops claimed at or after this time (ISO 8601 with Z or an offset). |
to | query | ISO 8601 time | Only drops claimed before this time (ISO 8601 with Z or an offset). |
q | query | text, up to 64 characters | Only drops whose item name contains this text. |
Example
curl
curl https://cs2farmbot.com/api/v1/drops \
-H "Authorization: Bearer $CFB_KEY"JavaScript
const res = await fetch("https://cs2farmbot.com/api/v1/drops", {
method: "GET",
headers: { Authorization: `Bearer ${process.env.CFB_KEY}` }
});
const data = await res.json();
console.log(res.status, data);Python
import os
import requests
res = requests.get(
"https://cs2farmbot.com/api/v1/drops",
headers={"Authorization": "Bearer " + os.environ["CFB_KEY"]},
)
print(res.status_code, res.json())Answer: 200
{
"data": [
{
"id": "48213",
"item": "Kilowatt Case",
"imageUrl": null,
"accountId": "3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41",
"account": "Farm Account 01",
"removed": false,
"claimedAt": "2026-11-03T07:41:12.000Z",
"priceCents": 38,
"currentPriceCents": 41
}
],
"next": "eyJ2IjoxLCJwIjpbIjIwMjYtMTEtMDNUMDc6NDE6MTIuMDAwWiIsNDgyMTNdfQ"
}Errors: unauthorized 401, rate_limited 429, plan_inactive 403, invalid_request 400, internal_error 500
GET /v1/matches
Your accounts' matches, newest first unless sorted oldest first.
- Newest first by when the match ended, unless
sort=oldest.
| Name | In | Type | What it is |
|---|---|---|---|
limit | query | whole number, 1 to 200, default 50 | How many rows a page has. |
cursor | query | text, up to 1,024 characters | The next of the page before, for the page after it. Leave it out for the first page. |
accountId | query | id (UUID) | Only this account's rows (its id). |
ended | query | text | Only matches that ended this way: one or more of xp_cap, match_end, shutdown, vote_kick, disconnected, stopped, other, separated by commas. |
map | query | text | Only matches on this map (the game's map name, such as de_dust2). |
from | query | ISO 8601 time | Only matches that ended at or after this time (ISO 8601 with Z or an offset). |
to | query | ISO 8601 time | Only matches that ended before this time (ISO 8601 with Z or an offset). |
sort | query | one of: newest, oldest | newest first (the default) or oldest first, by when the match ended. |
Example
curl
curl 'https://cs2farmbot.com/api/v1/matches?map=de_dust2&sort=oldest' \
-H "Authorization: Bearer $CFB_KEY"JavaScript
const res = await fetch("https://cs2farmbot.com/api/v1/matches?map=de_dust2&sort=oldest", {
method: "GET",
headers: { Authorization: `Bearer ${process.env.CFB_KEY}` }
});
const data = await res.json();
console.log(res.status, data);Python
import os
import requests
res = requests.get(
"https://cs2farmbot.com/api/v1/matches",
headers={"Authorization": "Bearer " + os.environ["CFB_KEY"]},
params={
"map": "de_dust2",
"sort": "oldest"
},
)
print(res.status_code, res.json())Answer: 200
{
"data": [
{
"id": "9c1d2e3f-4a5b-4c6d-8e7f-0a1b2c3d4e5f",
"map": "de_dust2",
"mode": "deathmatch",
"startedAt": "2026-11-03T09:42:10.000Z",
"endedAt": "2026-11-03T09:52:10.000Z",
"kills": 31,
"deaths": 18,
"headshots": 14,
"score": 92,
"xp": 640,
"estimated": false,
"end": "match_end",
"accountId": "3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41",
"account": "Farm Account 01",
"removed": false
}
],
"next": null
}Errors: unauthorized 401, rate_limited 429, plan_inactive 403, invalid_request 400, internal_error 500
GET /v1/accounts/{id}/matches
One account's matches, newest first unless sorted oldest first.
- Newest first by when the match ended, unless
sort=oldest.
| Name | In | Type | What it is |
|---|---|---|---|
idrequired | path | text | The account's id (id in GET /v1/accounts). |
limit | query | whole number, 1 to 200, default 50 | How many rows a page has. |
cursor | query | text, up to 1,024 characters | The next of the page before, for the page after it. Leave it out for the first page. |
ended | query | text | Only matches that ended this way: one or more of xp_cap, match_end, shutdown, vote_kick, disconnected, stopped, other, separated by commas. |
map | query | text | Only matches on this map (the game's map name, such as de_dust2). |
from | query | ISO 8601 time | Only matches that ended at or after this time (ISO 8601 with Z or an offset). |
to | query | ISO 8601 time | Only matches that ended before this time (ISO 8601 with Z or an offset). |
sort | query | one of: newest, oldest | newest first (the default) or oldest first, by when the match ended. |
Example
curl
curl https://cs2farmbot.com/api/v1/accounts/3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41/matches \
-H "Authorization: Bearer $CFB_KEY"JavaScript
const res = await fetch("https://cs2farmbot.com/api/v1/accounts/3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41/matches", {
method: "GET",
headers: { Authorization: `Bearer ${process.env.CFB_KEY}` }
});
const data = await res.json();
console.log(res.status, data);Python
import os
import requests
res = requests.get(
"https://cs2farmbot.com/api/v1/accounts/3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41/matches",
headers={"Authorization": "Bearer " + os.environ["CFB_KEY"]},
)
print(res.status_code, res.json())Answer: 200
{
"data": [
{
"id": "9c1d2e3f-4a5b-4c6d-8e7f-0a1b2c3d4e5f",
"map": "de_dust2",
"mode": "deathmatch",
"startedAt": "2026-11-03T09:42:10.000Z",
"endedAt": "2026-11-03T09:52:10.000Z",
"kills": 31,
"deaths": 18,
"headshots": 14,
"score": 92,
"xp": 640,
"estimated": false,
"end": "match_end",
"accountId": "3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41",
"account": "Farm Account 01",
"removed": false
}
],
"next": null
}Errors: unauthorized 401, rate_limited 429, plan_inactive 403, invalid_request 400, internal_error 500, account_not_found 404
GET /v1/trades
Your accounts' auto-trade offers and how they ended, newest first.
- Newest first, by when the offer was made.
| Name | In | Type | What it is |
|---|---|---|---|
limit | query | whole number, 1 to 200, default 50 | How many rows a page has. |
cursor | query | text, up to 1,024 characters | The next of the page before, for the page after it. Leave it out for the first page. |
accountId | query | id (UUID) | Only this account's rows (its id). |
Example
curl
curl https://cs2farmbot.com/api/v1/trades \
-H "Authorization: Bearer $CFB_KEY"JavaScript
const res = await fetch("https://cs2farmbot.com/api/v1/trades", {
method: "GET",
headers: { Authorization: `Bearer ${process.env.CFB_KEY}` }
});
const data = await res.json();
console.log(res.status, data);Python
import os
import requests
res = requests.get(
"https://cs2farmbot.com/api/v1/trades",
headers={"Authorization": "Bearer " + os.environ["CFB_KEY"]},
)
print(res.status_code, res.json())Answer: 200
{
"data": [
{
"id": "5e6f7a8b-9c0d-4e1f-a2b3-c4d5e6f7a8b9",
"accountId": "3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41",
"account": "Farm Account 01",
"status": "accepted",
"reason": null,
"mode": "drops",
"items": [
{
"name": "Kilowatt Case",
"priceCents": 38
}
],
"itemCount": 1,
"valueCents": 38,
"createdAt": "2026-11-03T07:45:30.000Z",
"updatedAt": "2026-11-03T08:02:11.000Z"
}
],
"next": null
}Errors: unauthorized 401, rate_limited 429, plan_inactive 403, invalid_request 400, internal_error 500
Inventory and Steam Market
GET /v1/inventory
Your accounts' stored items, most valuable first unless sorted by name, 50 a page.
Heavy read: also counts in the limit of 30 a minute.
- Fixed pages of 50 (no
limit). Each account's inventory is replaced whenever our servers look at it again, so a page can repeat or miss an item that changed in between. minCentsabovemaxCentsgives an empty list.listedistruewhile the item is in an open Steam Market listing (pending or listed). An item sold on the Steam Market is left out.
| Name | In | Type | What it is |
|---|---|---|---|
cursor | query | text, up to 1,024 characters | The next of the page before, for the page after it. Leave it out for the first page. |
q | query | text, up to 64 characters | Only items whose name contains this text. |
trade | query | one of: now, protected, listed | now: tradable now (or a trade protection that has ended); protected: trade-protected; listed: in an open Steam Market listing. now and protected leave out listed items. |
minCents | query | whole number (digits) | The lowest price in US cents (plain digits, included). Items without a known price drop out once a price bound is set. |
maxCents | query | whole number (digits) | The highest price in US cents (plain digits, included). Items without a known price drop out once a price bound is set. |
sort | query | one of: value, name | value: most valuable first, unknown prices last (the default); name: by name. |
accountId | query | id (UUID) | Only this account's rows (its id). |
Example
curl
curl https://cs2farmbot.com/api/v1/inventory \
-H "Authorization: Bearer $CFB_KEY"JavaScript
const res = await fetch("https://cs2farmbot.com/api/v1/inventory", {
method: "GET",
headers: { Authorization: `Bearer ${process.env.CFB_KEY}` }
});
const data = await res.json();
console.log(res.status, data);Python
import os
import requests
res = requests.get(
"https://cs2farmbot.com/api/v1/inventory",
headers={"Authorization": "Bearer " + os.environ["CFB_KEY"]},
)
print(res.status_code, res.json())Answer: 200
{
"data": [
{
"assetId": "38129475620",
"accountId": "3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41",
"account": "Farm Account 01",
"name": "Kilowatt Case",
"imageUrl": null,
"tradable": false,
"tradeProtectedUntil": "2026-11-10T07:41:12.000Z",
"priceCents": 41,
"tradeState": "protected",
"listed": false
}
],
"next": "eyJ2IjoxLCJwIjpbMl19"
}Errors: unauthorized 401, rate_limited 429, plan_inactive 403, invalid_request 400, internal_error 500
GET /v1/accounts/{id}/inventory
One account's stored items, most valuable first unless sorted by name, 50 a page.
- Fixed pages of 50 (no
limit), with the same rules asGET /v1/inventory.
| Name | In | Type | What it is |
|---|---|---|---|
idrequired | path | text | The account's id (id in GET /v1/accounts). |
cursor | query | text, up to 1,024 characters | The next of the page before, for the page after it. Leave it out for the first page. |
q | query | text, up to 64 characters | Only items whose name contains this text. |
trade | query | one of: now, protected, listed | now: tradable now (or a trade protection that has ended); protected: trade-protected; listed: in an open Steam Market listing. now and protected leave out listed items. |
minCents | query | whole number (digits) | The lowest price in US cents (plain digits, included). Items without a known price drop out once a price bound is set. |
maxCents | query | whole number (digits) | The highest price in US cents (plain digits, included). Items without a known price drop out once a price bound is set. |
sort | query | one of: value, name | value: most valuable first, unknown prices last (the default); name: by name. |
Example
curl
curl https://cs2farmbot.com/api/v1/accounts/3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41/inventory \
-H "Authorization: Bearer $CFB_KEY"JavaScript
const res = await fetch("https://cs2farmbot.com/api/v1/accounts/3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41/inventory", {
method: "GET",
headers: { Authorization: `Bearer ${process.env.CFB_KEY}` }
});
const data = await res.json();
console.log(res.status, data);Python
import os
import requests
res = requests.get(
"https://cs2farmbot.com/api/v1/accounts/3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41/inventory",
headers={"Authorization": "Bearer " + os.environ["CFB_KEY"]},
)
print(res.status_code, res.json())Answer: 200
{
"data": [
{
"assetId": "38129475620",
"accountId": "3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41",
"account": "Farm Account 01",
"name": "Kilowatt Case",
"imageUrl": null,
"tradable": false,
"tradeProtectedUntil": "2026-11-10T07:41:12.000Z",
"priceCents": 41,
"tradeState": "protected",
"listed": false
}
],
"next": null
}Errors: unauthorized 401, rate_limited 429, plan_inactive 403, invalid_request 400, internal_error 500, account_not_found 404
GET /v1/market
Your Steam Market totals and the accounts selling on it.
Heavy read: also counts in the limit of 30 a minute.
No parameters.
Example
curl
curl https://cs2farmbot.com/api/v1/market \
-H "Authorization: Bearer $CFB_KEY"JavaScript
const res = await fetch("https://cs2farmbot.com/api/v1/market", {
method: "GET",
headers: { Authorization: `Bearer ${process.env.CFB_KEY}` }
});
const data = await res.json();
console.log(res.status, data);Python
import os
import requests
res = requests.get(
"https://cs2farmbot.com/api/v1/market",
headers={"Authorization": "Bearer " + os.environ["CFB_KEY"]},
)
print(res.status_code, res.json())Answer: 200
{
"walletCents": 312,
"walletAccounts": 1,
"listed": {
"count": 2,
"cents": 79
},
"soldWeek": {
"count": 1,
"cents": 41
},
"keys": {
"bought": 1,
"onHold": 1,
"held": 1,
"sent": 0
},
"accounts": [
{
"id": "3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41",
"name": "Farm Account 01",
"login": "farm_account_01",
"status": "selling",
"until": null,
"steamText": null,
"walletCents": 312,
"listed": {
"count": 2,
"cents": 79
},
"soldWeek": {
"count": 1,
"cents": 41
},
"keys": {
"held": 1,
"onHold": 1,
"holdUntil": "2026-11-10T08:30:00.000Z"
}
}
]
}Errors: unauthorized 401, rate_limited 429, plan_inactive 403, invalid_request 400, internal_error 500
GET /v1/market/history
Your accounts' finished Steam Market listings and TF2 key buy orders, newest first.
- Finished rows only, newest first;
atis when the row finished. Listings and buy orders still open are inGET /v1/accounts/{id}/market.
| Name | In | Type | What it is |
|---|---|---|---|
limit | query | whole number, 1 to 200, default 50 | How many rows a page has. |
cursor | query | text, up to 1,024 characters | The next of the page before, for the page after it. Leave it out for the first page. |
accountId | query | id (UUID) | Only this account's rows (its id). |
type | query | one of: sales, keys | sales: Steam Market listings; keys: TF2 key buy orders. |
q | query | text, up to 64 characters | Only rows whose item name, account name or login contains this text. |
Example
curl
curl https://cs2farmbot.com/api/v1/market/history \
-H "Authorization: Bearer $CFB_KEY"JavaScript
const res = await fetch("https://cs2farmbot.com/api/v1/market/history", {
method: "GET",
headers: { Authorization: `Bearer ${process.env.CFB_KEY}` }
});
const data = await res.json();
console.log(res.status, data);Python
import os
import requests
res = requests.get(
"https://cs2farmbot.com/api/v1/market/history",
headers={"Authorization": "Bearer " + os.environ["CFB_KEY"]},
)
print(res.status_code, res.json())Answer: 200
{
"data": [
{
"id": "90412",
"accountId": "3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41",
"account": "Farm Account 01",
"removed": false,
"kind": "sell",
"name": "Kilowatt Case",
"quantity": 1,
"status": "sold",
"reason": null,
"steamText": null,
"eachCents": 41,
"totalCents": 41,
"at": "2026-11-03T08:12:40.000Z"
}
],
"next": "eyJ2IjoxLCJwIjpbIjIwMjYtMTEtMDNUMDg6MTI6NDAuMDAwWiIsOTA0MTJdfQ"
}Errors: unauthorized 401, rate_limited 429, plan_inactive 403, invalid_request 400, internal_error 500
GET /v1/accounts/{id}/market
One account's Steam Market listings and TF2 key buy orders still open.
- Listings and buy orders still pending or listed. Finished ones are in
GET /v1/market/history.
| Name | In | Type | What it is |
|---|---|---|---|
idrequired | path | text | The account's id (id in GET /v1/accounts). |
Example
curl
curl https://cs2farmbot.com/api/v1/accounts/3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41/market \
-H "Authorization: Bearer $CFB_KEY"JavaScript
const res = await fetch("https://cs2farmbot.com/api/v1/accounts/3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41/market", {
method: "GET",
headers: { Authorization: `Bearer ${process.env.CFB_KEY}` }
});
const data = await res.json();
console.log(res.status, data);Python
import os
import requests
res = requests.get(
"https://cs2farmbot.com/api/v1/accounts/3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41/market",
headers={"Authorization": "Bearer " + os.environ["CFB_KEY"]},
)
print(res.status_code, res.json())Answer: 200
{
"open": [
{
"id": "90431",
"accountId": "3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41",
"account": "Farm Account 01",
"removed": false,
"kind": "sell",
"name": "Kilowatt Case",
"quantity": 1,
"status": "listed",
"reason": null,
"steamText": null,
"eachCents": 41,
"totalCents": 41,
"at": "2026-11-03T09:02:05.000Z"
}
]
}Errors: unauthorized 401, rate_limited 429, plan_inactive 403, invalid_request 400, internal_error 500, account_not_found 404
GET /v1/market/settings
Your Steam Market settings: what to sell, how, and whether the money buys TF2 keys.
No parameters.
Example
curl
curl https://cs2farmbot.com/api/v1/market/settings \
-H "Authorization: Bearer $CFB_KEY"JavaScript
const res = await fetch("https://cs2farmbot.com/api/v1/market/settings", {
method: "GET",
headers: { Authorization: `Bearer ${process.env.CFB_KEY}` }
});
const data = await res.json();
console.log(res.status, data);Python
import os
import requests
res = requests.get(
"https://cs2farmbot.com/api/v1/market/settings",
headers={"Authorization": "Bearer " + os.environ["CFB_KEY"]},
)
print(res.status_code, res.json())Answer: 200
{
"sell": "drops",
"how": "list",
"keys": true
}Errors: unauthorized 401, rate_limited 429, plan_inactive 403, invalid_request 400, internal_error 500
PATCH /v1/market/settings
Change how your accounts sell on the Steam Market ("Everything" is turned on in the dashboard only).
- Send at least one field.
sell: "all"("Everything") needs the emailed code in the dashboard: it is refused with403 sell_all_panel_only(fieldsell) and nothing is saved. - The fields are saved one after another: if a call fails with
500, some of them may be saved. Read the settings again.
| Name | In | Type | What it is |
|---|---|---|---|
sell | body | one of: drops, all | What to sell: drops (farmed drops only: the weekly drops we claim for you). all ("Everything") is turned on in the dashboard only and is refused here. |
how | body | one of: instant, list | How to sell: list (listed at the lowest listing price) or instant (sold to the highest buy order). |
keys | body | true or false | true buys TF2 keys with the Steam Wallet money; false keeps the money in the Steam Wallet. |
Example
curl
curl -X PATCH https://cs2farmbot.com/api/v1/market/settings \
-H "Authorization: Bearer $CFB_KEY" \
-H "Content-Type: application/json" \
-d '{
"how": "instant",
"keys": false
}'JavaScript
const res = await fetch("https://cs2farmbot.com/api/v1/market/settings", {
method: "PATCH",
headers: {
Authorization: `Bearer ${process.env.CFB_KEY}`,
"Content-Type": "application/json"
},
body: JSON.stringify({
"how": "instant",
"keys": false
})
});
const data = await res.json();
console.log(res.status, data);Python
import os
import requests
res = requests.patch(
"https://cs2farmbot.com/api/v1/market/settings",
headers={"Authorization": "Bearer " + os.environ["CFB_KEY"]},
json={
"how": "instant",
"keys": False
},
)
print(res.status_code, res.json())Answer: 200
{
"sell": "drops",
"how": "instant",
"keys": false
}Errors: unauthorized 401, rate_limited 429, plan_inactive 403, invalid_request 400, unsupported_media_type 415, payload_too_large 413, internal_error 500, sell_all_panel_only 403
Activity and live status
GET /v1/events
Your activity feed, newest first, or with since only the lines added or changed after a cursor.
- Without
since: the history, newest first; its first page also haspollCursor. Withsince: the lines added or changed after it, oldest change first, and anextthat is never null: poll again with it. - A line can come again with the same
idwhen it changed: replace the one you have.
| Name | In | Type | What it is |
|---|---|---|---|
limit | query | whole number, 1 to 200, default 50 | How many rows a page has. |
cursor | query | text, up to 1,024 characters | The next of the page before, for the page after it. Leave it out for the first page. |
accountId | query | id (UUID) | Only this account's rows (its id). |
group | query | one of: matches, drops, trades, problems, changes | Only lines of this group. |
since | query | text, up to 1,024 characters | Change polling: a pollCursor or the next of a previous change poll. Not together with cursor. |
Example
curl
curl https://cs2farmbot.com/api/v1/events \
-H "Authorization: Bearer $CFB_KEY"JavaScript
const res = await fetch("https://cs2farmbot.com/api/v1/events", {
method: "GET",
headers: { Authorization: `Bearer ${process.env.CFB_KEY}` }
});
const data = await res.json();
console.log(res.status, data);Python
import os
import requests
res = requests.get(
"https://cs2farmbot.com/api/v1/events",
headers={"Authorization": "Bearer " + os.environ["CFB_KEY"]},
)
print(res.status_code, res.json())Answer: 200
{
"data": [
{
"id": "90412",
"type": "drops_claimed",
"accountId": "3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41",
"at": "2026-11-03T07:41:12.000Z",
"data": {
"items": [
{
"name": "Kilowatt Case",
"cents": 38
}
]
},
"text": "Farm Account 01 claimed Kilowatt Case ($0.38)"
}
],
"next": "eyJ2IjoxLCJwIjpbIjIwMjYtMTEtMDNUMDc6NDE6MTIuMDAwWiIsOTA0MTJdfQ",
"pollCursor": "eyJ2IjoxLCJwIjpbInAiLCI0ODIxNzMzIiwwXX0"
}Errors: unauthorized 401, rate_limited 429, plan_inactive 403, invalid_request 400, internal_error 500
GET /v1/live
What the bots do on your accounts right now, with a counter that moves on every change.
versionmoves on every change the dashboard shows: poll it and read the rest when it moves.mapandsinceare set only while an account isin_match. Paused accounts are not listed unless they are selling on the Steam Market. Takes no query parameters.
No parameters.
Example
curl
curl https://cs2farmbot.com/api/v1/live \
-H "Authorization: Bearer $CFB_KEY"JavaScript
const res = await fetch("https://cs2farmbot.com/api/v1/live", {
method: "GET",
headers: { Authorization: `Bearer ${process.env.CFB_KEY}` }
});
const data = await res.json();
console.log(res.status, data);Python
import os
import requests
res = requests.get(
"https://cs2farmbot.com/api/v1/live",
headers={"Authorization": "Bearer " + os.environ["CFB_KEY"]},
)
print(res.status_code, res.json())Answer: 200
{
"version": 18342,
"playing": [
{
"accountId": "3f2b6c1e-8a4d-4c2b-9f1e-5d7a2b9c0e41",
"activity": "in_match",
"map": "de_dust2",
"since": "2026-11-03T09:42:10.000Z"
},
{
"accountId": "7a1c2e3f-4b5d-4e6f-8a9b-0c1d2e3f4a5b",
"activity": "searching",
"map": null,
"since": null
}
]
}Errors: unauthorized 401, rate_limited 429, plan_inactive 403, invalid_request 400, internal_error 500