🔍 Preview CS2 Items - Lightweight Metadata (No Prices)
Baseurl: https://www.steamwebapi.com/steam/api/items/preview?key=YOUR_API_KEY
💬 **What this endpoint does:**
- Returns a lightweight preview of CS2 items without pricing data.
- Intended for fast access to item metadata and newly available items.
- For full item details including pricing, prefer using `/steam/api/items`.
🛠️ **Features:**
- Search items by name using `search` parameter (case-insensitive).
- Filter by `paint_index` or `def_index` for specific weapons/skins.
- Group results using `groupBy` to get unique values (e.g., all item types).
- Combine phase variants with `grouped=true` (default); unrelated items with the same display name remain separate.
- Returns only skin IDs by default; use `show_all=1` to include other catalog categories.
- Marks database-missing items with `preview=true` and `new=true`.
- Also marks items without a live Steam image with `new=true`; their image is served through the SteamWebAPI image proxy.
- Marks items sold for the first time within 30 days with `recent=true`.
- Filter only items with phases using `only_phases=true`.
- Supports multiple output formats via `format` parameter.
🌐 **How to use:**
- Basic call: `GET /steam/api/items/preview?key=YOUR_KEY`
- Search: `GET /steam/api/items/preview?search=AK-47&key=YOUR_KEY`
- Filter by weapon: `GET /steam/api/items/preview?def_index=7&key=YOUR_KEY`
- Get all item types: `GET /steam/api/items/preview?groupBy=itemtype&key=YOUR_KEY`
- Export as CSV: `GET /steam/api/items/preview?format=csv&key=YOUR_KEY`
Request
- Base URL: https://www.steamwebapi.com
- URL: https://www.steamwebapi.com/steam/api/items/preview
- Auth: API key in query parameter key
Query parameters
Your API key for authentication. Retrieve it from your Dashboard (top-right corner).
Optional. Search for items by name (case-insensitive). Matches partial names. - Example: search=AK-47 returns all AK-47 skins. - Example: search=Redline returns all Redline skins across weapons.
Optional. Filter by paint index (skin pattern ID). - Each skin has a unique paint_index. - Example: 282 = Redline, 418 = Doppler Phase 1.
Optional. Filter by definition index (weapon ID). - Each weapon type has a unique def_index. - Common values: 7 = AK-47, 9 = AWP, 4 = Glock-18, 61 = USP-S.
Optional. Combine phase variants (default: true). - true: Returns one entry per phased market hash name with a variants array. - Same-name items without phases remain separate because they may represent distinct levels or editions. - false: Returns all variants as separate entries.
Optional. Group results by a field and return unique values only. - Response becomes a flat array of strings/numbers. - Example: ?groupBy=itemtype returns ["ak-47", "awp", "m4a1-s", ...] - Example: ?groupBy=rarity returns ["Covert", "Classified", "Restricted", ...]
Optional. Output format for the response. - json (default): Standard JSON response. - csv, xml, html: Export formats for data analysis. - gzip, zip: Compressed JSON for large datasets. - mysql, pgsql, mongo: Database insert statements.
Optional. Pretty-print JSON output (indented, human-readable). - 0 (default): Minified JSON. - 1: Indented, formatted JSON.
Optional. Control which CS2 catalog categories are returned. - 0 or omitted: Return only items whose catalog ID starts with skin-. - 1: Return all supported catalog categories. Globally ignored prefixes remain excluded.
Optional. Filter by database availability. - 0 or omitted: Return the complete catalog with preview and new flags. - 1: Return only items that do not yet exist in the item database for CS2.
Optional. Only return items that have phases. - Useful for filtering Doppler, Gamma Doppler, Marble Fade knives. - Returns items with Phase 1, Phase 2, Phase 3, Phase 4, Ruby, Sapphire, etc.
Response
CS2 items matching the filters. Returns item metadata without pricing. When grouped=true (default), items with multiple phases include a variants array.
Changes
No recorded changes to this operation across all 1 revision of this API.