Woksteamapi

WOK Steam Inventory API

Steam inventory API for eight named Steam games, plus numeric AppIDs, with bounded Steam Market pricing for all eight named games and richer cross-source…

Media & content#games--comics

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Steam inventory API for eight named Steam games, plus numeric AppIDs, with bounded Steam Market pricing for all eight named games and richer cross-source coverage for CS2/Rust/TF2/Dota 2, with inventory values, profiles, visible profile comments, batch requests, price refresh and CS2 inspect links and class metadata preview. Account, payment and admin routes are intentionally excluded.

Endpoints 74

Compatibility

  • GETCompatible inventory array/steam/api/inventory?steam_id=stringBearer is recommended. The legacy key query is deprecated. include_inspect=1 requires the Inspect add-on. Optional local currency conversion, field projection…
  • GETCompatible Steam profile/steam/api/profileCore avatar/avatarmedium/profilestate fields preserve source values. Activity is opt-in; not_requested/unavailable fields are null and cannot prove offline…
  • GETSteam profile comments (WOK response alias)/steam/api/profile/commentsReads one newest-first page of comments visible to an anonymous Steam Community visitor. This is a structured WOK response from Community's public comment…
  • GETRender a CS2 inspect certificate as PNG/steam/api/float/screenshotDecodes the modern hex certificate locally and streams a deterministic 1280x720 PNG. Exactly one of url or certificate is required. Legacy S/M inspect links…
  • GETVisible games and selected achievement progress/steam/api/profile/games?steamid=76561198000000001include_recent=1 adds recent_playtime and fills known two-week minutes for matching AppIDs. Owned + recent data takes up to two cold lookups; combining…
  • GETSteam app metadata and live metrics/steam/api/apps?appid=1Read one AppID, requesting only selected store/reviews/current_players sections. Omit sections for all existing sources. US/USD Store price and nullable…

Keys

  • GETCurrent key plan and quota/v1/keyReturns effective plan limits, current usage, remaining units and UTC reset timestamps. This read-only lookup does not consume quota.

Inventory

  • GETInventory totals and priced items/v1/inventory?steam_id=stringOptional local currency conversion, field projection and response-row pagination reuse the loaded inventory. Default USD/JSON/no-limit keeps its existing…
  • POSTRefresh prices without fetching Steam inventory/v1/inventory/refresh-pricesReads the active inventory snapshot and updates its prices from the local catalog. It never falls back to Steam; 404 inventory_cache_miss means the caller…
  • GETList this key's recent inventory observations/v1/inventory-snapshots?steam_id=76561198000000001Lists metadata only, not stored item quantities.
  • POSTOpt in to one valid cached inventory observation/v1/inventory-snapshotsStores only exact market hash name quantities from the current complete local inventory cache. No Steam call or automatic ongoing scan occurs. A repeated…
  • DELETEDelete this key's snapshots for one player and game/v1/inventory-snapshots?steam_id=76561198000000001Deletion uses Bearer authentication but consumes no quota unit and remains available after this key's quota is exhausted or the key expires.
  • GETObserved quantity changes since the preceding snapshot/v1/inventory-snapshots/:snapshot_id/diffCursor-paginated added and removed name quantities between two retained observations owned by the same key. Cursors bind both observations. If retention…
  • POSTSynchronous inventory batch/v1/inventoriesUp to 20 players, 4 games and 80 player-game pairs. Pair failures remain inside results. Set refresh_prices=true to update only valuation from WOK's local…

Profiles

  • GETOne Steam profile/v1/profile?steam_id=stringCore avatar/avatarmedium/profilestate fields preserve source values. Activity is opt-in; not_requested/unavailable fields are null and cannot prove offline…
  • GETVisible Steam profile comments/v1/profile-comments?steam_id=76561198000000001Reads one newest-first page of comments visible to an anonymous Steam Community visitor. This is a structured WOK response from Community's public comment…
  • POSTUp to 64 Steam profiles/v1/profiles1..64 user SteamID64 strings; duplicates removed before quota. Fresh core profiles reuse the existing cache and only misses are combined in one official…
  • GETVAC, game and economy bans/v1/player-security?steam_id=76561198000000001Steam source errors retain safe typed code/category, optional upstream_status and retry_after;429 source throttling and503 capacity/budget/configuration…
  • GETCheck a trade offer link before sending an offer/v1/trade-url?url=stringParses the link (partner, 8-character token) into a SteamID64, asks Steam through a WOK bot whether the token is current and how long the trade hold is…
  • POSTVAC and ban signals for up to 100 Steam accounts/v1/player-security/batchValidates all input IDs and removes duplicates in first occurrence order before quota or upstream work. Requires a WOK Bearer key with all-purpose or Players…
  • GETSteam account level/v1/steam-level?steam_id=76561198000000001Returns the Steam account level from GetSteamLevel. Independent of Rust and all other games. Uses one WOK quota unit and the server-side Steam key. A level…
  • GETSteam profile name history/v1/aliases?steam_id=76561198000000001Returns up to ten public persona aliases from Steam Community. Steam may clear or limit this history; an empty array means no aliases were exposed. This uses…
  • GETVisible Steam games and playtime/v1/games?steam_id=76561198000000001Lists games Steam exposes for this account, sorted by lifetime playtime. Each game preserves Steam's minute values and adds decimal hours. total_playtime is…
  • POSTVisible Steam game hours for up to 20 accounts/v1/games/batchRead-only batch of 1..20 user SteamID64 strings; deduplicates in first occurrence order before quota or upstream work. All-purpose and Players access; one…
  • GETSteam playtime over the last two weeks/v1/games/recent?steam_id=76561198000000001Uses official IPlayerService/GetRecentlyPlayedGames with count=0 to request every game Steam exposes in its recent list. User SteamID64 only, all-purpose or…
  • POSTRecent Steam game hours for up to 20 accounts/v1/games/recent/batchValidates 1..20 user SteamID64 strings and optional 1..50 integer appids, deduplicating in first occurrence order before quota/upstream work. One quota unit…
  • GETSteam game achievement progress/v1/games/achievements?steam_id=76561198000000001&appid=1One AppID per call. Private or unsupported achievements return 403, not zero progress. complete=false/source_achievement_count report incomplete or invalid…
  • GETSteam app metadata and live metrics/v1/apps?appid=1Read one AppID, requesting only selected store/reviews/current_players sections. Omit sections for all existing sources. US/USD Store price and nullable…
  • GETPublic Steam friend list/v1/friends?steam_id=76561198000000001Steam source errors retain safe typed code/category, optional upstream_status and retry_after;429 source throttling and503 capacity/budget/configuration…
  • GETGroups exposed by public Steam profile XML/v1/profile/groups?steam_id=76561198000000001SteamID64 only. Anonymous XML may expose up to 100 groups but never proves complete membership; complete=false. Empty/hidden groups remain null/unknown. One…
  • GETPublished counters for one account and game/v1/game-stats?steam_id=76561198000000001&appid=1Requires a WOK Bearer key with all-purpose or Players access; one quota unit. Existing Free quota, rate and Discord membership rules apply. Direct bounded…
  • GETSteam badges, account XP and level/v1/badges?steam_id=76561198000000001Requires a WOK Bearer key with all-purpose or Players access; one quota unit. Existing Free quota, rate and Discord membership rules apply. Direct bounded…
  • GETLocalized achievement and statistic definitions/v1/apps/schema?appid=1Requires a WOK Bearer key with all-purpose or Players access; one quota unit. Existing Free quota, rate and Discord membership rules apply. Direct bounded…
  • GETSteam global achievement percentages/v1/apps/achievements/global?appid=1Requires a WOK Bearer key with all-purpose or Players access; one quota unit. Existing Free quota, rate and Discord membership rules apply. Direct bounded…
  • GETBounded public Steam app news/v1/apps/news?appid=1Requires a WOK Bearer key with all-purpose or Players access; one quota unit. Existing Free quota, rate and Discord membership rules apply. Direct bounded…
  • GETSearch locally cached Steam app names and AppIDs/v1/apps/searchOne quota unit per local page; all-purpose/Players access and existing Free rules. Zero upstream requests from public search. Exact numeric AppID or name…
  • POSTAchievements for selected account/game pairs/v1/games/achievements/batchValidate 1..20 explicit account/AppID pairs before quota; deduplicate in first occurrence order. One quota unit per unique pair, including cache hits. Four…

Rust

  • GETRust lifetime game statistics/v1/rust/stats?steam_id=76561198000000001Uses WOK Bearer authentication and a server-side Steam key. Fixed to Rust AppID 252490. Read playerstats.stats; Steam may also return…
  • GETNamed Rust kills and resources/v1/rust/summary?steam_id=76561198000000001Maps Steam's lifetime playerstats.stats[] names to kills, resources and combat. stats_by_name preserves every numeric stat Steam published. A missing counter…
  • GETRust achievements/v1/rust/achievements?steam_id=76561198000000001Fixed to Rust AppID 252490. Read playerstats.achievements: name is Steam's achievement identifier and achieved is 0 or 1. Steam may include unlocktime. One…
  • GETRust total and recent playtime/v1/rust/playtime?steam_id=76561198000000001Reads Steam owned games filtered to AppID 252490. playtime_forever and optional playtime_2weeks are minutes. playtime_hours and optional playtime_2weeks_hours…

Prices

  • GETOne cross-checked price/v1/price?name=string
  • GETSteam Market order book of one item/v1/market/orders?name=stringLive Steam Market buy and sell orders in USD: highest_buy_order, lowest_sell_order, spread, buy_order_count, sell_order_count and up to 100 levels per side…
  • POSTUp to 200 cross-checked prices/v1/prices
  • GETCursor-paginated item catalog/v1/itemsSaved price catalog with representative official Steam icons observed in public inventories or the existing Steam Market sweep. Image fields are null when WOK…
  • GETSaved catalog price coverage and freshness/v1/prices/coverageFive-minute cached, read-only report for one named game. Reports valid saved positive quotes and retained history by source. Denominators are WOK catalog…
  • GETReal daily OHLC price history/v1/price-history?name=stringOnly observed points are returned. Missing days are not invented.
  • POSTObserved daily value of a caller-supplied item basket/v1/portfolio-historySaved history for 1 to 20 exact market hash names from one named game and one saved USD source. The basket is supplied by the caller; no Steam ownership is…
  • POSTQueue bounded catalog export/v1/catalog/exportsQueues an NDJSON export from the local catalog. It never refreshes an upstream source; max_rows and max_bytes are hard bounds, and the result expires after 24…
  • GETGet export status/v1/catalog/exports/:export_id
  • DELETECancel pending export/v1/catalog/exports/:export_id
  • GETDownload completed NDJSON export/v1/catalog/exports/:export_id/downloadDownloads only the completed export owned by the Bearer key.

CS2

  • GETFresh CS2 prices across marketplaces/v1/cs2/market-prices?item=stringUSD bids, asks and per-market timestamps where available. A missing or stale market is omitted. One WOK quota unit.
  • GETFilter saved CS2 item names and price observations/v1/cs2/itemsCursor-paginated saved CS2 names. Base name, finish, exterior and variant come only from market_hash_name. Rarity and collection are null until a verified…
  • POSTDecode CS2 float and paint metadata/v1/cs2/inspectSelf-encoded links are resolved locally with checksum validation. Legacy S/M links resolve through WOK Steam GC workers; successful observations are cached…
  • GETResolve CS2 item class metadata/v1/cs2/item-preview?classid=stringUses Valve's GetAssetClassInfo for a CS2 class/instance ID. One WOK quota unit; the result is cached and does not use residential proxies. Steam may not index…
  • GETLive CS2 Market listings with float/v1/cs2/market-listings?name=stringReads one bounded page of individual current Steam Community Market CS2 listings. Floats, seeds and prices come from observed listing properties; missing…
  • POSTResolve a CS2 Doppler phase/v1/cs2/doppler-phaseSend exactly one inspect_link or paint_index. Non-Doppler paint indexes return status not_doppler without guessing. Legacy inspect links use Steam GC;…
  • POSTRender a deterministic CS2 inspect PNG/v1/cs2/screenshotNo Steam, Game Coordinator, browser or CS2 client is started. The modern certificate already contains the float and paint state; WOK decodes and renders it…
  • POSTOpen an item-bound 3D viewer session/v1/cs2/viewer-sessionSeparate Viewer subscription required. Viewer Trial: 10 opens per 30 days. Paid Viewer includes branding and its own monthly/day/minute view limits. Other API…
  • GETRead viewer access and settings/v1/cs2/viewer
  • PUTSave viewer origins and branding/v1/cs2/viewer
  • POSTRender a CS2 skin image/v1/cs2/screenshotsLocal material render, front/back/both, optional transparent PNG. Available to Free and paid keys; one ordinary API request per creation/retry. Polling is not…
  • GETRead a screenshot job or image/v1/cs2/screenshots/:job_idRetrieve with the same key. No additional API credits. Separate per-minute retrieval limit follows the key rate, capped at 1,500. PNG supports…
  • GETRender or retrieve a screenshot using query parameters/steam/api/screenshotLocal material render, front/back/both, optional transparent PNG. Available to Free and paid keys; one ordinary API request per creation/retry. Polling is not…
  • GETSearch observed public CS2 assets/v1/cs2/assetsBeta: search only public inventories already observed by WOK. Bounded 7-day sample, 100,000 total assets, up to 5,000 per inventory. No extra Steam request,…
  • GETRead current observed asset coverage/v1/cs2/assets/coverageBeta: search only public inventories already observed by WOK. Bounded 7-day sample, 100,000 total assets, up to 5,000 per inventory. No extra Steam request,…
  • POSTFind candidate assets for multiple filters/v1/cs2/assets/findBeta: search only public inventories already observed by WOK. Bounded 7-day sample, 100,000 total assets, up to 5,000 per inventory. No extra Steam request,…

Crawl

  • POSTQueue low-priority inventory crawl/v1/crawlCreating a crawl requires the Bulk add-on.
  • GETRead crawl state/v1/crawl/:batch

FACEIT

  • GETFACEIT player by SteamID/faceit/data/v4/players?game_player_id=76561198000000001Public FACEIT profile. Optional source-reported creation/activation timestamps, images, membership labels, friend-list entry count, Steam linkage, game level…
  • GETFACEIT lifetime stats/faceit/data/v4/players/:player_id/stats/:gameLifetime statistics and optional bounded map/competition segments from the same stats fetch. All accepted metric values remain strings; missing or invalid…
  • GETRecent FACEIT matches/faceit/data/v4/players/:player_id/historyOne bounded source page per request; page defaults to 0 and limit defaults to 5 (maximum 20). Page zero retains items/start/end only. Nonzero pages add…

Service

  • GETService health/healthz

API details

Base URL
https://woksteamapi.com
Authentication
A bearer token in the Authorization header
An API key in the key query parameter
Operations
74 operations on 70 pathsGET 53POST 18DELETE 2PUT 1
Main resources
Profiles 23CS2 16Prices 11Inventory 7Compatibility 6Rust 4FACEIT 3Crawl 2Keys 1Service 1
Response formats
application/json image/png application/x-ndjson text/csv
Description format
OpenAPI 3.1.0, API version 1.7.1

How to test the WOK Steam Inventory API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the WOK Steam Inventory API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Compatible inventory array” (GET /steam/api/inventory?steam_id=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the WOK Steam Inventory API?

Steam inventory API for eight named Steam games, plus numeric AppIDs, with bounded Steam Market pricing for all eight named games and richer cross-source… It is listed under Media & content and has 74 endpoints.

Who publishes the WOK Steam Inventory API?

It is listed from Woksteamapi's public API description (an OpenAPI document), not published by Woksteamapi on Swastik Codes. Anyone who controls woksteamapi.com can claim the profile by adding a DNS TXT record.

What is the base URL of the WOK Steam Inventory API?

Requests go to https://woksteamapi.com. Endpoint paths are added to this base URL.

How do I authenticate with the WOK Steam Inventory API?

It accepts 2 methods: A bearer token in the Authorization header; an API key in the key query parameter.

How many endpoints does the WOK Steam Inventory API have?

74 operations on 70 paths (53 GET, 18 POST, 2 DELETE, 1 PUT). The largest groups are Profiles, CS2, Prices, Inventory.

Is forking the WOK Steam Inventory API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.