API Objects
On this page
- API Objects
- Object groups
- Response Envelopes
- LatestPricesGetResponse
- LatestPricesPostResponse
- HistoryResponse
- ItemLiquidityGetResponse
- BUFFMarketFloatLatestResponse
- BUFFMarketFloatHistoryResponse
- ArchiveBuffResponse
- ArchiveCSFloatResponse
- ArchiveHistoryResponse
- ArchiveSteamResponse
- ArchiveYoupinResponse
- CSFloatBuyOrdersLatestResponse
- CSFloatBuyOrdersHistoryResponse
- SteamOrderbookLatestResponse
- SteamOrderbookHistoryResponse
- SchemaResponse
- FXResponse
- Items
- Item
- Variant
- HistoryItem
- HistoryVariant
- ItemLiquidityItem
- ItemLiquidityVariant
- BUFFMarketFloatItem
- BUFFMarketFloatHistoryItem
- BUFFMarketFloatVariant
- BUFFMarketFloatHistoryVariant
- ArchiveBuffItem
- ArchiveBuffVariant
- ArchiveCSFloatItem
- ArchiveCSFloatVariant
- ArchiveHistoryItem
- ArchiveHistoryVariant
- ArchiveSteamItem
- ArchiveYoupinItem
- ArchiveYoupinVariant
- CSFloatBuyOrdersItem
- CSFloatBuyOrdersVariant
- CSFloatBuyOrdersHistoryItem
- CSFloatBuyOrdersHistoryVariant
- SteamOrderbookItem
- SteamOrderbookHistoryItem
- History Buckets
- HistoryBucket
- BUFFMarketFloatLatestBucket
- BUFFMarketFloatHistoryBucket
- BUFFMarketFloatHistoryPoint
- BUFFMarketFloatRange
- ArchiveBuffPoint
- ArchiveCSFloatBucket
- ArchiveHistoryBucket
- ArchiveHistoryPlatformData
- ArchiveSteamBucket
- ArchiveYoupinSeries
- ArchiveYoupinPoint
- CSFloatBuyOrder
- CSFloatBuyOrderConditions
- CSFloatStickerCondition
- CSFloatKeychainCondition
- CSFloatBuyOrdersHistoryPoint
- SteamOrderbookTop
- SteamOrderbookDepth
- SteamOrderbookDepthSide
- SteamOrderbookHistoryPoint
- Latest Price Source Data
- BUFFSourceData
- YoupinSourceData
- CsfloatSourceData
- SkinportSourceData
- SteamSourceData
- C5GameSourceData
- SkinportPriceWindow
- OHLC Source Data
- BUFFOHLCSourceData
- YoupinOHLCSourceData
- CsfloatOHLCSourceData
- SkinportOHLCSourceData
- SteamOHLCSourceData
- C5GameOHLCSourceData
- Item Schema
- SchemaItem
- SchemaItemVariant
- SchemaCollection
- SchemaRarity
- Health
- HealthResponse
- HealthEntry
- HealthStats
- Errors
- ItemError
- ErrorResponse
Response object field reference for the cs2.sh API.
Object groups
- Response Envelopes
- Items
- History Buckets
- Latest Price Source Data
- OHLC Source Data
- Item Schema
- Health
- Errors
Response Envelopes
LatestPricesGetResponse
All-items snapshot. Returned by GET /v1/prices/latest with shared response metadata.
| Field | Type | Required | Description |
|---|---|---|---|
response_time | string (date-time) | Yes | When the response was generated. |
currency | string | Yes | Currency code for every price in the response. Matches the requested currency; defaults to USD. |
items | Record<string, Item> | Yes | Map of market_hash_name to item price data. |
LatestPricesPostResponse
Filtered per-item snapshot. Returned by POST /v1/prices/latest and includes per-item errors.
| Field | Type | Required | Description |
|---|---|---|---|
response_time | string (date-time) | Yes | When the response was generated. |
currency | string | Yes | Currency code for every price in the response. Matches the requested currency; defaults to USD. |
items | Record<string, Item> | Yes | Map of market_hash_name to item price data, filtered to the requested items. |
errors | ItemError[] | No | Per-item failures alongside successful results (partial success). |
HistoryResponse
Response shape for POST /v1/prices/history.
| Field | Type | Required | Description |
|---|---|---|---|
response_time | string (date-time) | Yes | When the response was generated. |
currency | string | Yes | Currency code for every price in the response. Matches the requested currency; defaults to USD. |
start | string (date-time) | Yes | Effective start of the queried range, floored to the interval boundary. Inclusive. |
end | string (date-time) | Yes | Effective end of the queried range, ceiled to the interval boundary. Exclusive. |
interval | string | Yes | Allowed: 5m, 30m, 1h, 1d. Requested bucket interval. |
items | Record<string, HistoryItem> | Yes | Map of market_hash_name to OHLC time-series. |
errors | ItemError[] | No | Per-item failures alongside successful results (partial success). |
ItemLiquidityGetResponse
All-items liquidity snapshot. Returned by GET /v1/liquidity/items.
| Field | Type | Required | Description |
|---|---|---|---|
response_time | string (date-time) | Yes | When the snapshot was computed. |
run_date | string (date) | Yes | UTC date for the daily computation. |
items | Record<string, ItemLiquidityItem> | Yes | Map of market_hash_name to item liquidity data. |
BUFFMarketFloatLatestResponse
All-items BUFF float and fade range snapshot. Returned by GET /v1/market/buff/latest; all prices are USD.
| Field | Type | Required | Description |
|---|---|---|---|
response_time | string (date-time) | Yes | When the response was generated. |
currency | string | Yes | Currency code for every price in the response. Matches the requested currency; defaults to USD. |
items | Record<string, BUFFMarketFloatItem> | Yes | Map of market_hash_name to per-item BUFF data. |
BUFFMarketFloatHistoryResponse
Response shape for POST /v1/market/buff/history. Returns OHLC history for each requested BUFF market float/fade bucket.
| Field | Type | Required | Description |
|---|---|---|---|
response_time | string (date-time) | Yes | When the response was generated. |
currency | string | Yes | Currency code for every price in the response. Matches the requested currency; defaults to USD. |
start | string (date-time) | Yes | Effective start of the queried range, floored to the interval boundary. Inclusive. |
end | string (date-time) | Yes | Effective end of the queried range, ceiled to the interval boundary. Exclusive. |
interval | string | Yes | Allowed: 30m, 1h, 1d. Requested bucket interval. |
items | Record<string, BUFFMarketFloatHistoryItem> | Yes | Map of market_hash_name to per-item BUFF history. |
errors | ItemError[] | No | Per-item failures alongside successful results (partial success). |
ArchiveBuffResponse
Response shape for POST /v1/archive/buff.
| Field | Type | Required | Description |
|---|---|---|---|
response_time | string (date-time) | Yes | When the response was generated. |
currency | string | Yes | Currency for sale_price. Matches the requested currency; defaults to USD. |
start | string (date-time) | Yes | Effective start of the queried range, exactly as requested or defaulted. Inclusive. |
end | string (date-time) | Yes | Effective end of the queried range, exactly as requested or defaulted. Exclusive. |
items | Record<string, ArchiveBuffItem> | Yes | Map of market_hash_name to BUFF sale series. |
errors | ItemError[] | No | Per-item failures alongside successful results (partial success). |
ArchiveCSFloatResponse
Response shape for POST /v1/archive/csfloat.
| Field | Type | Required | Description |
|---|---|---|---|
response_time | string (date-time) | Yes | When the response was generated. |
currency | string | Yes | Currency code for every price in the response. Matches the requested currency; defaults to USD. |
start | string (date-time) | Yes | Effective start of the queried range, floored to the day boundary. Inclusive. |
end | string (date-time) | Yes | Effective end of the queried range, ceiled to the day boundary. Exclusive. |
items | Record<string, ArchiveCSFloatItem> | Yes | Map of market_hash_name to CSFloat sale time-series. |
errors | ItemError[] | No | Per-item failures alongside successful results (partial success). |
ArchiveHistoryResponse
Response shape for POST /v1/archive/history.
| Field | Type | Required | Description |
|---|---|---|---|
response_time | string (date-time) | Yes | When the response was generated. |
currency | string | Yes | Currency code for every price in the response. Matches the requested currency; defaults to USD. |
start | string (date-time) | Yes | Effective start of the queried range, floored to the interval boundary. Inclusive. |
end | string (date-time) | Yes | Effective end of the queried range, ceiled to the interval boundary. Exclusive. |
interval | string | Yes | Allowed: 1h, 1d. Requested bucket interval. |
items | Record<string, ArchiveHistoryItem> | Yes | Map of market_hash_name to archive time-series. |
errors | ItemError[] | No | Per-item failures alongside successful results (partial success). |
ArchiveSteamResponse
Response shape for POST /v1/archive/steam. Valid regular items with no rows return item-level not_in_archive; if every valid regular item has no rows, the endpoint returns 404 not_found.
| Field | Type | Required | Description |
|---|---|---|---|
response_time | string (date-time) | Yes | When the response was generated. |
currency | string | Yes | Currency code for every price in the response. Matches the requested currency; defaults to USD. |
start | string (date-time) | Yes | Effective start of the queried range, floored to the interval boundary. Inclusive. |
end | string (date-time) | Yes | Effective end of the queried range, ceiled to the interval boundary. Exclusive. |
interval | string | Yes | Allowed: 1h, 1d. Requested bucket interval. |
items | Record<string, ArchiveSteamItem> | Yes | Map of market_hash_name to native Steam sale-history buckets. |
errors | ItemError[] | No | Per-item failures alongside successful results (partial success). |
ArchiveYoupinResponse
Response shape for POST /v1/archive/youpin.
| Field | Type | Required | Description |
|---|---|---|---|
response_time | string (date-time) | Yes | When the response was generated. |
currency | string | Yes | Currency code for every price in the response. Matches the requested currency; defaults to USD. |
start | string (date-time) | Yes | Effective start of the queried range, floored to the 1h boundary. Inclusive. |
end | string (date-time) | Yes | Effective end of the queried range, ceiled to the 1h boundary. Exclusive. |
items | Record<string, ArchiveYoupinItem> | Yes | Map of market_hash_name to Youpin sale series. |
errors | ItemError[] | No | Per-item failures alongside successful results (partial success). |
CSFloatBuyOrdersLatestResponse
Current CSFloat buy-order books for every item with standing orders. Returned by GET /v1/market/csfloat/latest. A book expires 12 hours after its observation time, the same window as bid on /v1/prices/latest.
| Field | Type | Required | Description |
|---|---|---|---|
response_time | string (date-time) | Yes | When this snapshot response was generated. |
currency | string | Yes | Currency code for every price in the response. Matches the requested currency; defaults to USD. |
items | Record<string, CSFloatBuyOrdersItem> | Yes | Items with current buy-order books, keyed by market_hash_name. |
CSFloatBuyOrdersHistoryResponse
Response shape for POST /v1/market/csfloat/history. Valid requested items with no rows are reported in errors.
| Field | Type | Required | Description |
|---|---|---|---|
response_time | string (date-time) | Yes | When the response was generated. |
currency | string | Yes | Currency code for every price in the response. Matches the requested currency; defaults to USD. |
start | string (date-time) | Yes | Effective start of the queried range, floored to the interval boundary. Inclusive. |
end | string (date-time) | Yes | Effective end of the queried range, ceiled to the interval boundary. Exclusive. |
interval | string | Yes | Allowed: 1h, 1d. Requested bucket interval. |
items | Record<string, CSFloatBuyOrdersHistoryItem> | Yes | Map of market_hash_name to returned buy-order book history. |
errors | ItemError[] | No | Per-item failures alongside successful results (partial success). |
SteamOrderbookLatestResponse
Latest Steam orderbook snapshot for all tracked regular items. Returned by GET /v1/market/steam/latest; variants are not supported.
| Field | Type | Required | Description |
|---|---|---|---|
response_time | string (date-time) | Yes | When this snapshot response was generated. |
currency | string | Yes | Currency code for every price in the response. Matches the requested currency; defaults to USD. |
items | Record<string, SteamOrderbookItem> | Yes | Regular items with current orderbook data, keyed by market_hash_name. |
SteamOrderbookHistoryResponse
Response shape for POST /v1/market/steam/history. Valid regular items with no rows are omitted; if all valid regular items have no rows, items is empty.
| Field | Type | Required | Description |
|---|---|---|---|
response_time | string (date-time) | Yes | When the response was generated. |
currency | string | Yes | Currency code for every price in the response. Matches the requested currency; defaults to USD. |
start | string (date-time) | Yes | Effective start of the queried range, floored to the interval boundary. Inclusive. |
end | string (date-time) | Yes | Effective end of the queried range, ceiled to the interval boundary. Exclusive. |
interval | string | Yes | Allowed: 1h, 1d. Requested bucket interval. |
items | Record<string, SteamOrderbookHistoryItem> | Yes | Map of market_hash_name to returned orderbook history. |
errors | ItemError[] | No | Per-item failures alongside successful results (partial success). |
SchemaResponse
Response shape for GET /v1/schema, the full item schema with metadata keyed by market_hash_name.
| Field | Type | Required | Description |
|---|---|---|---|
schema_version | string | Yes | Schema version. Re-sync clients when it changes. |
generation_id | string | Yes | Stable identifier for this schema generation. |
generated_at | string (date-time) | Yes | When this schema generation was built. |
counts | object | Yes | Schema entity counts. |
rarities | SchemaRarity[] | Yes | Rarity tiers. |
collections | Record<string, SchemaCollection> | Yes | Collection metadata keyed by collection name. |
items | Record<string, SchemaItem> | Yes | Item records keyed by market_hash_name. |
FXResponse
Current exchange rates. Returned by GET /v1/fx.
| Field | Type | Required | Description |
|---|---|---|---|
base | string | Yes | Base currency (always USD). |
updated_at | string (date-time) | Yes | When the rate provider published these rates. |
collected_at | string (date-time) | Yes | When cs2.sh collected them. |
fresh | boolean | Yes | false when the rates are more than 2 hours old. Latest-price conversion keeps using them for up to 24 hours. |
rates | Record<string, number> | Yes | Units of each currency per 1 USD, keyed by currency code. |
Items
Item
Price data for an item across all sources. Every source is present unless sources limits the response to the requested ones.
| Field | Type | Required | Description |
|---|---|---|---|
market_hash_name | string | Yes | Canonical Steam market_hash_name. |
buff | BUFFSourceData | No | Price data from BUFF. |
youpin | YoupinSourceData | No | Price data from Youpin. |
csfloat | CsfloatSourceData | No | Current CSFloat listing and buy-order prices. |
skinport | SkinportSourceData | No | Price data from Skinport, including Skinport-supplied rolling history windows. |
c5game | C5GameSourceData | No | Price data from C5Game. Ask and bid come from independent collection passes, so timestamps may differ for the same item. |
steam | SteamSourceData | No | Price data from the Steam Community Market. |
variants | Record<string, Variant> | No | Per-variant price data for items with Doppler and Gamma Doppler phases or Case Hardened tiers. Keyed by display name. |
Variant
A variant of an item (Doppler or Gamma Doppler phase or Case Hardened tier). youpin includes ask, bid, and bid_volume on every Doppler and Gamma Doppler phase, with ask_volume on most items.
| Field | Type | Required | Description |
|---|---|---|---|
market_hash_name | string | Yes | The base item's market_hash_name. The full variant name is name. |
name | string | Yes | The variant's full market_hash_name, e.g. ★ Karambit | Doppler (Factory New) | Phase 1. |
display_name | string | Yes | Human-readable variant label (e.g. Phase 1, Ruby, Tier 1, Blue Gem). |
version | string | Yes | Allowed: p1, p2, p3, p4, ruby, sapphire, blackpearl, emerald, t1, t2, t3, t4, singleblue. Stable variant code. Switch on this in client code. |
buff | BUFFSourceData | No | Price data from BUFF. |
youpin | YoupinSourceData | No | Price data from Youpin. |
csfloat | CsfloatSourceData | No | Current CSFloat listing and buy-order prices. |
skinport | SkinportSourceData | No | Price data from Skinport, including Skinport-supplied rolling history windows. |
c5game | C5GameSourceData | No | Price data from C5Game. Ask and bid come from independent collection passes, so timestamps may differ for the same item. |
steam | SteamSourceData | No | Price data from the Steam Community Market. |
HistoryItem
OHLC time-series for a single item.
| Field | Type | Required | Description |
|---|---|---|---|
market_hash_name | string | Yes | Canonical Steam market_hash_name. |
count | integer | Yes | Number of buckets in data. |
data | HistoryBucket[] | Yes | OHLC buckets in chronological order. |
variants | Record<string, HistoryVariant> | No | Per-variant OHLC time-series for items with Doppler and Gamma Doppler phases or Case Hardened tiers. Keyed by display name. |
HistoryVariant
OHLC time-series for one Doppler or Gamma Doppler phase or Case Hardened tier.
| Field | Type | Required | Description |
|---|---|---|---|
market_hash_name | string | Yes | The base item's market_hash_name. The full variant name is name. |
name | string | Yes | The variant's full market_hash_name, e.g. ★ Karambit | Doppler (Factory New) | Phase 1. |
display_name | string | Yes | Human-readable variant label (e.g. Phase 1, Ruby, Tier 1, Blue Gem). |
version | string | Yes | Stable variant code. Switch on this in client code. |
count | integer | Yes | Number of buckets in data. |
data | HistoryBucket[] | Yes | OHLC buckets in chronological order. |
ItemLiquidityItem
Item liquidity bucket and estimated sale time for a single item.
| Field | Type | Required | Description |
|---|---|---|---|
market_hash_name | string | Yes | Canonical Steam market_hash_name. |
liquidity | string | No | Allowed: unknown, extremely_illiquid, very_illiquid, illiquid, moderate, liquid, very_liquid, extremely_liquid. Item liquidity bucket, recomputed daily. |
estimated_sale_time | string | No | Allowed: under 1 hour, 1 - 2 hours, 2 - 6 hours, 6 - 12 hours, 12 - 24 hours, 1 - 2 days, 2 - 3 days, 3 - 4 days, 4 - 5 days, 5 - 7 days, 7 - 10 days, 10 - 14 days, 2 - 3 weeks, 3 - 4 weeks, 1 - 1.5 months, 1.5 - 2 months, 2+ months, unknown. 80th-percentile estimated time for a competitively priced listing to sell. |
variants | Record<string, ItemLiquidityVariant> | No | Per-variant item liquidity keyed by display name. |
ItemLiquidityVariant
Liquidity bucket and estimated sale time for one Doppler or Gamma Doppler phase or Case Hardened tier.
| Field | Type | Required | Description |
|---|---|---|---|
market_hash_name | string | Yes | The base item's market_hash_name. The full variant name is name. |
name | string | Yes | The variant's full market_hash_name, e.g. ★ Karambit | Doppler (Factory New) | Phase 1. |
display_name | string | Yes | Human-readable variant label (e.g. Phase 1, Ruby, Tier 1, Blue Gem). |
version | string | Yes | Stable variant code. Switch on this in client code. |
liquidity | string | Yes | Allowed: unknown, extremely_illiquid, very_illiquid, illiquid, moderate, liquid, very_liquid, extremely_liquid. Item liquidity bucket, recomputed daily. |
estimated_sale_time | string | Yes | Allowed: under 1 hour, 1 - 2 hours, 2 - 6 hours, 6 - 12 hours, 12 - 24 hours, 1 - 2 days, 2 - 3 days, 3 - 4 days, 4 - 5 days, 5 - 7 days, 7 - 10 days, 10 - 14 days, 2 - 3 weeks, 3 - 4 weeks, 1 - 1.5 months, 1.5 - 2 months, 2+ months, unknown. 80th-percentile estimated time for a competitively priced listing to sell. |
BUFFMarketFloatItem
BUFF market float/fade data for one item.
| Field | Type | Required | Description |
|---|---|---|---|
market_hash_name | string | Yes | Canonical Steam market_hash_name. |
buckets | BUFFMarketFloatLatestBucket[] | No | Latest BUFF buckets for the base listing. |
variants | Record<string, BUFFMarketFloatVariant> | No | Per-variant BUFF data for items with Doppler and Gamma Doppler phases or Case Hardened tiers. Keyed by display name (e.g. Phase 1, Ruby, Tier 1). |
BUFFMarketFloatHistoryItem
BUFF market float/fade OHLC history for one item.
| Field | Type | Required | Description |
|---|---|---|---|
market_hash_name | string | Yes | Canonical Steam market_hash_name. |
buckets | BUFFMarketFloatHistoryBucket[] | No | OHLC history for the base listing's buckets. |
variants | Record<string, BUFFMarketFloatHistoryVariant> | No | Per-variant OHLC history for items with Doppler and Gamma Doppler phases or Case Hardened tiers. Keyed by display name. |
BUFFMarketFloatVariant
BUFF latest data for a single variant of an item (Doppler or Gamma Doppler phase or Case Hardened tier).
| Field | Type | Required | Description |
|---|---|---|---|
market_hash_name | string | Yes | The base item's market_hash_name. The full variant name is name. |
name | string | Yes | The variant's full market_hash_name, e.g. ★ Karambit | Doppler (Factory New) | Phase 1. |
display_name | string | Yes | Human-readable variant label (e.g. Phase 1, Ruby, Tier 1, Blue Gem). |
version | string | Yes | Stable variant code. Switch on this in client code. |
buckets | BUFFMarketFloatLatestBucket[] | Yes | Latest BUFF buckets for this variant. |
BUFFMarketFloatHistoryVariant
BUFF OHLC history for a single variant of an item.
| Field | Type | Required | Description |
|---|---|---|---|
market_hash_name | string | Yes | The base item's market_hash_name. The full variant name is name. |
name | string | Yes | The variant's full market_hash_name, e.g. ★ Karambit | Doppler (Factory New) | Phase 1. |
display_name | string | Yes | Human-readable variant label (e.g. Phase 1, Ruby, Tier 1, Blue Gem). |
version | string | Yes | Stable variant code. Switch on this in client code. |
buckets | BUFFMarketFloatHistoryBucket[] | Yes | OHLC history per bucket for this variant. |
ArchiveBuffItem
BUFF sales and daily supply for a single item, as one chronological series.
| Field | Type | Required | Description |
|---|---|---|---|
market_hash_name | string | Yes | The base item's market_hash_name. |
count | integer | Yes | Number of points in data. |
data | ArchiveBuffPoint[] | Yes | Sales and supply-only rows in chronological order, one point per timestamp. |
variants | Record<string, ArchiveBuffVariant> | No | Per-variant BUFF series for items with Doppler and Gamma Doppler phases or Case Hardened tiers. Keyed by display name and omitted when empty. A variant series never falls back to base history. |
ArchiveBuffVariant
BUFF sales and daily supply for one Doppler or Gamma Doppler phase or Case Hardened tier.
| Field | Type | Required | Description |
|---|---|---|---|
market_hash_name | string | Yes | The base item's market_hash_name. The full variant name is name. |
count | integer | Yes | Number of points in data. |
data | ArchiveBuffPoint[] | Yes | Sales and supply-only rows in chronological order, one point per timestamp. |
name | string | Yes | The variant's full market_hash_name, e.g. ★ Karambit | Doppler (Factory New) | Phase 2. |
display_name | string | Yes | Human-readable variant label (e.g. Phase 1, Ruby, Tier 1, Blue Gem). |
version | string | Yes | Stable variant code. Switch on this in client code. |
ArchiveCSFloatItem
CSFloat sale time-series for a single item.
| Field | Type | Required | Description |
|---|---|---|---|
market_hash_name | string | Yes | Canonical Steam market_hash_name. |
count | integer | Yes | Number of days in data. |
data | ArchiveCSFloatBucket[] | Yes | Daily sale aggregates in chronological order. |
variants | Record<string, ArchiveCSFloatVariant> | No | Per-variant CSFloat sale time-series for items with Doppler and Gamma Doppler phases or Case Hardened tiers. Keyed by display name. |
ArchiveCSFloatVariant
CSFloat sale time-series for one Doppler or Gamma Doppler phase or Case Hardened tier.
| Field | Type | Required | Description |
|---|---|---|---|
market_hash_name | string | Yes | The base item's market_hash_name. The full variant name is name. |
name | string | Yes | The variant's full market_hash_name, e.g. ★ Karambit | Doppler (Factory New) | Phase 1. |
display_name | string | Yes | Human-readable variant label (e.g. Phase 1, Ruby, Tier 1, Blue Gem). |
version | string | Yes | Stable variant code. Switch on this in client code. |
count | integer | Yes | Number of days in data. |
data | ArchiveCSFloatBucket[] | Yes | Daily sale aggregates in chronological order. |
ArchiveHistoryItem
Long-term archive time-series for a single item.
| Field | Type | Required | Description |
|---|---|---|---|
market_hash_name | string | Yes | Canonical Steam market_hash_name. |
count | integer | Yes | Number of buckets in data. |
data | ArchiveHistoryBucket[] | Yes | Archive buckets in chronological order. |
variants | Record<string, ArchiveHistoryVariant> | No | Per-variant archive time-series for items with Doppler and Gamma Doppler phases or Case Hardened tiers. Keyed by display name. |
ArchiveHistoryVariant
Long-term archive time-series for one Doppler or Gamma Doppler phase or Case Hardened tier.
| Field | Type | Required | Description |
|---|---|---|---|
market_hash_name | string | Yes | The base item's market_hash_name. The full variant name is name. |
name | string | Yes | The variant's full market_hash_name, e.g. ★ Karambit | Doppler (Factory New) | Phase 1. |
display_name | string | Yes | Human-readable variant label (e.g. Phase 1, Ruby, Tier 1, Blue Gem). |
version | string | Yes | Stable variant code. Switch on this in client code. |
count | integer | Yes | Number of buckets in data. |
data | ArchiveHistoryBucket[] | Yes | Archive buckets in chronological order. |
ArchiveSteamItem
Native Steam sale-history buckets for one regular item. No variants are returned.
| Field | Type | Required | Description |
|---|---|---|---|
market_hash_name | string | Yes | Canonical Steam market_hash_name. |
count | integer | Yes | Number of buckets in data. |
data | ArchiveSteamBucket[] | Yes | Buckets in chronological order. |
ArchiveYoupinItem
Youpin sale history for a single item, with one series per sampling interval.
| Field | Type | Required | Description |
|---|---|---|---|
market_hash_name | string | Yes | Canonical Steam market_hash_name. |
intervals | object | Yes | Series keyed by sampling interval (1h, 4h, 12h). A key is present only when that interval was observed inside the requested window. |
variants | Record<string, ArchiveYoupinVariant> | No | Per-variant Youpin sale history for items with Doppler and Gamma Doppler phases or Case Hardened tiers. Keyed by display name and omitted when empty. A variant series never falls back to base history. |
ArchiveYoupinVariant
Youpin sale history for one Doppler or Gamma Doppler phase or Case Hardened tier, as one independent series per sampling interval.
| Field | Type | Required | Description |
|---|---|---|---|
market_hash_name | string | Yes | The base item's market_hash_name. The full variant name is name. |
name | string | Yes | The variant's full market_hash_name, e.g. ★ Karambit | Doppler (Factory New) | Phase 1. |
display_name | string | Yes | Human-readable variant label (e.g. Phase 1, Ruby, Tier 1, Blue Gem). |
version | string | Yes | Stable variant code. Switch on this in client code. |
intervals | object | Yes | Series for this variant, keyed by sampling interval like the item's intervals. |
CSFloatBuyOrdersItem
A base item's buy-order book. Book fields are absent when the entry exists only to carry phase books under variants.
| Field | Type | Required | Description |
|---|---|---|---|
market_hash_name | string | Yes | Canonical Steam market_hash_name. |
updated_at | string (date-time) | No | When this book was last updated. |
collected_at | string (date-time) | No | When cs2.sh collected this book. |
top_generic_bid | number | null | No | Highest order price (USD) with no conditions. null when there are no generic orders. |
orders | CSFloatBuyOrder[] | No | Price-descending order ladder. |
variants | Record<string, CSFloatBuyOrdersVariant> | No | Doppler and Gamma Doppler phase books keyed by display name. |
CSFloatBuyOrdersVariant
One Doppler or Gamma Doppler phase's buy-order book.
| Field | Type | Required | Description |
|---|---|---|---|
market_hash_name | string | Yes | The base item's market_hash_name. The full variant name is name. |
name | string | Yes | The variant's full market_hash_name, e.g. ★ Karambit | Doppler (Factory New) | Phase 1. |
display_name | string | Yes | Human-readable variant label (e.g. Phase 2, Ruby). |
version | string | Yes | Stable variant code. Switch on this in client code. |
updated_at | string (date-time) | Yes | When this book was last updated. |
collected_at | string (date-time) | Yes | When cs2.sh collected this book. |
top_generic_bid | number | null | Yes | Highest order price (USD) with no conditions. null when there are no generic orders. |
orders | CSFloatBuyOrder[] | Yes | Price-descending order ladder. |
CSFloatBuyOrdersHistoryItem
CSFloat buy-order book history for one base item. Phase series nest under variants.
| Field | Type | Required | Description |
|---|---|---|---|
market_hash_name | string | Yes | Canonical Steam market_hash_name. |
count | integer | Yes | Number of points in data. |
data | CSFloatBuyOrdersHistoryPoint[] | Yes | Points in chronological order. |
variants | Record<string, CSFloatBuyOrdersHistoryVariant> | No | Doppler and Gamma Doppler phase series keyed by display name. |
CSFloatBuyOrdersHistoryVariant
CSFloat buy-order book history for one Doppler or Gamma Doppler phase.
| Field | Type | Required | Description |
|---|---|---|---|
market_hash_name | string | Yes | The base item's market_hash_name. The full variant name is name. |
name | string | Yes | The variant's full market_hash_name, e.g. ★ Karambit | Doppler (Factory New) | Phase 1. |
display_name | string | Yes | Human-readable variant label (e.g. Phase 2, Ruby). |
version | string | Yes | Stable variant code. Switch on this in client code. |
count | integer | Yes | Number of points in data. |
data | CSFloatBuyOrdersHistoryPoint[] | Yes | Points in chronological order. |
SteamOrderbookItem
Latest full-depth Steam orderbook for one regular item.
| Field | Type | Required | Description |
|---|---|---|---|
updated_at | string (date-time) | Yes | When Steam last updated this orderbook. |
collected_at | string (date-time) | Yes | When cs2.sh collected this orderbook. |
top | SteamOrderbookTop | Yes | Top of book for a Steam orderbook: lowest ask and highest bid. Each field is null when that side is absent. |
depth | SteamOrderbookDepth | Yes | Full-depth Steam orderbook ladders in columnar form. |
SteamOrderbookHistoryItem
Steam orderbook bucket snapshots for one regular item. No variants are returned.
| Field | Type | Required | Description |
|---|---|---|---|
count | integer | Yes | Number of points in data. |
data | SteamOrderbookHistoryPoint[] | Yes | Points in chronological order. |
History Buckets
HistoryBucket
A single OHLC time bucket. bucket is the interval boundary (UTC-aligned, deterministic); open_time/close_time on each per-source object are the actual first/last observation timestamps inside it.
| Field | Type | Required | Description |
|---|---|---|---|
bucket | string (date-time) | Yes | Start of the time bucket. UTC-aligned to the interval boundary (e.g. 2026-01-08T19:00:00Z for an 1h bucket). Deterministic. |
buff | BUFFOHLCSourceData | No | OHLC bucket of BUFF prices. |
youpin | YoupinOHLCSourceData | No | OHLC bucket of Youpin prices. |
csfloat | CsfloatOHLCSourceData | No | OHLC bucket of CSFloat ask and bid prices. |
skinport | SkinportOHLCSourceData | No | OHLC bucket of Skinport ask prices. |
c5game | C5GameOHLCSourceData | No | OHLC bucket of C5Game ask and bid prices. |
steam | SteamOHLCSourceData | No | OHLC bucket of Steam Community Market ask and bid prices. |
BUFFMarketFloatLatestBucket
One latest BUFF float or fade range bucket, identified by bucket_type.
| Field | Type | Required | Description |
|---|---|---|---|
bucket_id | string | Yes | Stable bucket identifier (e.g. base, float:0.15:0.18, variant:p2|float:0.00:0.01). |
bucket_type | string | Yes | Allowed: base, float, fade, float_fade. Bucket stratification. - base: aggregated across the entire item or variant. - float: float-range slice (see float). - fade: fade-percentage slice (see fade). - float_fade: combined float and fade slice. |
float | BUFFMarketFloatRange | No | Numeric range for a float or fade bucket. min is inclusive, max is exclusive. |
fade | BUFFMarketFloatRange | No | Numeric range for a float or fade bucket. min is inclusive, max is exclusive. |
updated_at | string (date-time) | No | When BUFF last refreshed this bucket. |
collected_at | string (date-time) | No | When cs2.sh collected this bucket. |
ask | number | No | Lowest ask price (USD) in this bucket. |
avg_ask | number | No | Average ask price (USD) in the bucket. |
bid | number | No | Highest buy-order price (USD) on BUFF. |
ask_volume | integer | No | Number of items listed for sale in this bucket. |
bid_volume | integer | No | Number of active buy orders against this bucket. |
BUFFMarketFloatHistoryBucket
OHLC history for one BUFF market bucket. Each entry in data is one interval, in chronological order.
| Field | Type | Required | Description |
|---|---|---|---|
bucket_id | string | Yes | Stable bucket identifier (e.g. fade:99:100, variant:p2|float:0.00:0.01). |
bucket_type | string | Yes | Allowed: base, float, fade, float_fade. Bucket stratification. See BUFFMarketFloatLatestBucket.bucket_type. |
float | BUFFMarketFloatRange | No | Numeric range for a float or fade bucket. min is inclusive, max is exclusive. |
fade | BUFFMarketFloatRange | No | Numeric range for a float or fade bucket. min is inclusive, max is exclusive. |
data | BUFFMarketFloatHistoryPoint[] | Yes | OHLC observations for this bucket, chronological. |
BUFFMarketFloatHistoryPoint
A single OHLC observation inside a BUFF market float/fade bucket history.
| Field | Type | Required | Description |
|---|---|---|---|
bucket | string (date-time) | Yes | UTC-aligned start of the OHLC interval. |
updated_at | string (date-time) | No | When BUFF last refreshed the bucket inside this interval. |
collected_at | string (date-time) | No | When cs2.sh collected the source rows inside this interval. |
open_ask | number | No | First ask price (USD) observed in the interval. |
high_ask | number | No | Highest ask price (USD) observed in the interval. |
low_ask | number | No | Lowest ask price (USD) observed in the interval. |
close_ask | number | No | Last ask price (USD) observed in the interval. |
open_avg_ask | number | No | First avg_ask value observed in the interval. |
high_avg_ask | number | No | Highest avg_ask value observed in the interval. |
low_avg_ask | number | No | Lowest avg_ask value observed in the interval. |
close_avg_ask | number | No | Last avg_ask value observed in the interval. |
open_bid | number | No | First bid price (USD) observed in the interval. |
high_bid | number | No | Highest bid price (USD) observed in the interval. |
low_bid | number | No | Lowest bid price (USD) observed in the interval. |
close_bid | number | No | Last bid price (USD) observed in the interval. |
ask_volume | integer | No | Last observed ask volume inside the interval. |
bid_volume | integer | No | Last observed bid volume inside the interval. |
open_time | string (date-time) | Yes | Timestamp of the first observation inside the interval. Distinct from bucket (the interval boundary). |
close_time | string (date-time) | Yes | Timestamp of the last observation inside the interval. Distinct from bucket (the interval boundary). |
BUFFMarketFloatRange
Numeric range for a float or fade bucket. min is inclusive, max is exclusive.
| Field | Type | Required | Description |
|---|---|---|---|
min | number | No | Inclusive lower bound. |
max | number | No | Exclusive upper bound. |
ArchiveBuffPoint
One BUFF sale, or a supply-only row on a day with no sale.
| Field | Type | Required | Description |
|---|---|---|---|
time | string (date-time) | Yes | Sale time, UTC. Supply-only rows are stamped at China midnight (16:00 UTC). |
sale_price | number | null | Yes | Sale price (USD), converted from CNY at the sale date's historical rate. null on supply-only rows and on sales whose date has no stored rate yet. |
total_supply | integer | null | Yes | Total supply BUFF reported for the sale's China-calendar day (UTC+8). null when no supply was reported that day. |
ArchiveCSFloatBucket
One day of sale data on CSFloat.
| Field | Type | Required | Description |
|---|---|---|---|
date | string | Yes | Date in YYYY-MM-DD format (UTC). |
price | number | null | Yes | Arithmetic average of all sale prices (USD) that day. |
volume | integer | Yes | Number of sales that day. |
ArchiveHistoryBucket
A single archive time bucket. Each source key is present only when data exists for that source in this bucket.
| Field | Type | Required | Description |
|---|---|---|---|
bucket | string (date-time) | Yes | Start of the time bucket (UTC-aligned to the interval boundary). |
aggregate | ArchiveHistoryPlatformData | No | Per-source price data within an archive bucket. aggregate prices are derived from BUFF and Youpin; hourly_volume and total_supply are populated only on the aggregate source. |
buff | ArchiveHistoryPlatformData | No | Per-source price data within an archive bucket. aggregate prices are derived from BUFF and Youpin; hourly_volume and total_supply are populated only on the aggregate source. |
youpin | ArchiveHistoryPlatformData | No | Per-source price data within an archive bucket. aggregate prices are derived from BUFF and Youpin; hourly_volume and total_supply are populated only on the aggregate source. |
c5game | ArchiveHistoryPlatformData | No | Per-source price data within an archive bucket. aggregate prices are derived from BUFF and Youpin; hourly_volume and total_supply are populated only on the aggregate source. |
ArchiveHistoryPlatformData
Per-source price data within an archive bucket. aggregate prices are derived from BUFF and Youpin; hourly_volume and total_supply are populated only on the aggregate source.
| Field | Type | Required | Description |
|---|---|---|---|
time | string (date-time) | Yes | Actual timestamp of the last observation in the bucket. Distinct from the bucket boundary. |
ask | number | null | Yes | Last observed ask price (USD) in the bucket. |
ask_volume | integer | null | Yes | Last observed number of items listed for sale. |
bid | number | null | Yes | Last observed bid price (USD) in the bucket. null when it was above the source's ask. |
bid_volume | integer | null | Yes | Last observed number of buy orders. |
hourly_volume | number | null | No | Aggregated trading volume metric (aggregate source only). |
total_supply | number | null | No | Total market supply metric (aggregate source only). |
sample_count | integer | Yes | Number of observations aggregated into this bucket. |
ArchiveSteamBucket
One native Steam sale-history bucket. price is Steam's median sale price and volume is the Steam purchase count.
| Field | Type | Required | Description |
|---|---|---|---|
bucket | string (date-time) | Yes | Native Steam bucket start. |
price | number | null | Yes | Steam median sale price in USD. |
volume | integer | null | Yes | Steam purchase count. |
ArchiveYoupinSeries
Youpin sales at one sampling interval.
| Field | Type | Required | Description |
|---|---|---|---|
count | integer | Yes | Number of points in this series (the length of data), not a sale volume. 0 with an empty data means the interval was observed and nothing sold. |
data | ArchiveYoupinPoint[] | Yes | Sales at this interval, in chronological order. |
ArchiveYoupinPoint
One sale on Youpin. Youpin keeps one sale per sampling bucket, so a point is a real sale, not an aggregate.
| Field | Type | Required | Description |
|---|---|---|---|
bucket | string (date-time) | Yes | Start of the sampling bucket. |
time | string (date-time) | Yes | Actual sale time inside the bucket. |
price | number | null | Yes | Sale price (USD), converted from CNY at the sale date's own historical rate, or null when no rate for that date could be resolved. |
CSFloatBuyOrder
One standing CSFloat buy order. Its conditions live in conditions.
| Field | Type | Required | Description |
|---|---|---|---|
price | number | Yes | Order price in USD. |
quantity | integer | No | Number of items wanted at this price. |
kind | string | Yes | Allowed: generic, paint_index, float, sticker, keychain_pattern, paint_seeds, keychain, mixed. Summary of the matching rules in conditions. generic has no rules; mixed contains multiple rule families or a rule cs2.sh doesn't recognize. |
conditions | CSFloatBuyOrderConditions | Yes | Rules a listing must satisfy for this order to buy it. When several rules are present, all must match. Empty for generic orders. A mixed order can also carry unrecognized CSFloat rule keys verbatim. |
CSFloatBuyOrderConditions
Rules a listing must satisfy for this order to buy it. When several rules are present, all must match. Empty for generic orders. A mixed order can also carry unrecognized CSFloat rule keys verbatim.
| Field | Type | Required | Description |
|---|---|---|---|
paint_index | integer | No | The listing's paint index must equal this value. |
min_float | number | No | The listing's float value must be greater than or equal to this value. |
max_float | number | No | The listing's float value must be less than or equal to this value. |
stickers | CSFloatStickerCondition[] | No | The listing must satisfy every sticker requirement in this array. Repeating a sticker ID requires multiple copies of that sticker. |
min_keychain_pattern | integer | No | The applied charm's pattern value must be greater than or equal to this value. |
max_keychain_pattern | integer | No | The applied charm's pattern value must be less than or equal to this value. |
paint_seeds | integer[] | No | The listing's paint seed must equal one of these values. |
keychains | CSFloatKeychainCondition[] | No | The listing must have every charm identified in this array. |
CSFloatStickerCondition
One sticker the listing must have.
| Field | Type | Required | Description |
|---|---|---|---|
sId | integer | Yes | Numeric CSFloat ID of the sticker the listing must have. |
s | integer | No | Zero-based slot that must contain this sticker. If omitted, the sticker may be in any slot. |
CSFloatKeychainCondition
One charm the listing must have.
| Field | Type | Required | Description |
|---|---|---|---|
sId | integer | Yes | Numeric CSFloat ID of the charm the listing must have. |
CSFloatBuyOrdersHistoryPoint
The newest buy-order book observed in one UTC bucket. This is point-in-time book state, not OHLC data.
| Field | Type | Required | Description |
|---|---|---|---|
bucket | string (date-time) | Yes | UTC bucket start. |
updated_at | string (date-time) | Yes | When the book in this bucket was last updated. |
collected_at | string (date-time) | Yes | When cs2.sh collected the book represented by this bucket. |
top_generic_bid | number | null | Yes | Highest order price (USD) with no conditions. null when there are no generic orders. |
orders | CSFloatBuyOrder[] | Yes | Price-descending order ladder. |
SteamOrderbookTop
Top of book for a Steam orderbook: lowest ask and highest bid. Each field is null when that side is absent.
| Field | Type | Required | Description |
|---|---|---|---|
ask | number | null | Yes | Lowest ask price in USD, or null when absent. |
ask_volume | integer | null | Yes | Total Steam sell-order count, or null when absent. |
bid | number | null | Yes | Highest buy-order price in USD, or null when absent. |
bid_volume | integer | null | Yes | Total Steam buy-order count, or null when absent. |
SteamOrderbookDepth
Full-depth Steam orderbook ladders in columnar form.
| Field | Type | Required | Description |
|---|---|---|---|
ask_levels | integer | Yes | Number of ask levels in asks. |
bid_levels | integer | Yes | Number of bid levels in bids. |
asks | SteamOrderbookDepthSide | Yes | One side of the orderbook ladder in columnar form. prices[i] pairs with volumes[i]; each volume is the quantity available at that exact price, not cumulative. |
bids | SteamOrderbookDepthSide | Yes | One side of the orderbook ladder in columnar form. prices[i] pairs with volumes[i]; each volume is the quantity available at that exact price, not cumulative. |
SteamOrderbookDepthSide
One side of the orderbook ladder in columnar form. prices[i] pairs with volumes[i]; each volume is the quantity available at that exact price, not cumulative.
| Field | Type | Required | Description |
|---|---|---|---|
prices | number[] | Yes | Decimal USD prices. Asks ascending, bids descending. |
volumes | integer[] | Yes | Quantity available at each corresponding price. |
SteamOrderbookHistoryPoint
One latest-in-bucket full-depth Steam orderbook snapshot. This is not OHLC data.
| Field | Type | Required | Description |
|---|---|---|---|
bucket | string (date-time) | Yes | UTC bucket start. |
updated_at | string (date-time) | Yes | When Steam last updated the orderbook represented by this bucket. |
collected_at | string (date-time) | Yes | When cs2.sh collected the orderbook represented by this bucket. |
top | SteamOrderbookTop | Yes | Top of book for a Steam orderbook: lowest ask and highest bid. Each field is null when that side is absent. |
depth | SteamOrderbookDepth | Yes | Full-depth Steam orderbook ladders in columnar form. |
Latest Price Source Data
BUFFSourceData
Price data from BUFF.
| Field | Type | Required | Description |
|---|---|---|---|
updated_at | string (date-time) | null | Yes | When BUFF last updated this price. |
collected_at | string (date-time) | null | Yes | When cs2.sh collected this price. |
ask | number | null | Yes | Lowest ask price (USD). |
ask_volume | integer | null | Yes | Number of items listed for sale. |
bid | number | null | Yes | Highest buy-order price (USD). |
bid_volume | integer | null | Yes | Number of active buy orders. |
YoupinSourceData
Price data from Youpin.
| Field | Type | Required | Description |
|---|---|---|---|
updated_at | string (date-time) | null | Yes | When Youpin last updated this price. |
collected_at | string (date-time) | null | Yes | When cs2.sh collected this price. |
ask | number | null | Yes | Lowest ask price (USD). |
ask_volume | integer | null | Yes | Number of items listed for sale. |
bid | number | null | Yes | Highest buy-order price (USD). |
bid_volume | integer | null | Yes | Number of active buy orders. |
CsfloatSourceData
Current CSFloat listing and buy-order prices.
| Field | Type | Required | Description |
|---|---|---|---|
updated_at | string (date-time) | null | Yes | When CSFloat last updated this price. |
collected_at | string (date-time) | null | Yes | When cs2.sh collected this price. |
ask | number | null | Yes | Lowest ask price (USD). |
ask_volume | integer | null | Yes | Number of items listed for sale. |
bid | number | null | Yes | Highest buy-order price (USD). |
SkinportSourceData
Price data from Skinport, including Skinport-supplied rolling history windows.
| Field | Type | Required | Description |
|---|---|---|---|
updated_at | string (date-time) | null | Yes | When Skinport last updated this price. |
collected_at | string (date-time) | null | Yes | When cs2.sh collected this price. |
ask | number | null | Yes | Lowest ask price (USD). |
ask_volume | integer | null | Yes | Number of items listed for sale. |
max_ask | number | null | Yes | Highest listing price (USD). |
mean_ask | number | null | Yes | Average listing price (USD). |
median_ask | number | null | Yes | Median listing price (USD). |
24h_history | SkinportPriceWindow | null | Yes | - |
7d_history | SkinportPriceWindow | null | Yes | - |
30d_history | SkinportPriceWindow | null | Yes | - |
90d_history | SkinportPriceWindow | null | Yes | - |
SteamSourceData
Price data from the Steam Community Market.
| Field | Type | Required | Description |
|---|---|---|---|
updated_at | string (date-time) | null | Yes | When Steam last updated this price. |
collected_at | string (date-time) | null | Yes | When cs2.sh collected this price. |
ask | number | null | Yes | Lowest ask price (USD). |
ask_volume | integer | null | Yes | Number of items listed for sale. |
bid | number | null | Yes | Highest buy-order price (USD). |
bid_volume | integer | null | Yes | Number of active buy orders. |
C5GameSourceData
Price data from C5Game. Ask and bid come from independent collection passes, so timestamps may differ for the same item.
| Field | Type | Required | Description |
|---|---|---|---|
updated_at | string (date-time) | null | Yes | When C5Game last updated this price. |
collected_at | string (date-time) | null | Yes | When cs2.sh collected this price. |
ask | number | null | Yes | Lowest ask price (USD). |
ask_volume | integer | null | Yes | Number of items listed for sale. |
bid | number | null | Yes | Highest buy-order price (USD). |
SkinportPriceWindow
Skinport-supplied rolling price window. Object is null when Skinport has no recent sales for the item.
| Field | Type | Required | Description |
|---|---|---|---|
price | number | Yes | Last sale price (USD) within the window. |
max_price | number | Yes | Highest sale price (USD) within the window. |
mean_price | number | Yes | Average sale price (USD) within the window. |
median_price | number | Yes | Median sale price (USD) within the window. |
volume | integer | Yes | Number of sales within the window. |
OHLC Source Data
BUFFOHLCSourceData
OHLC bucket of BUFF prices.
| Field | Type | Required | Description |
|---|---|---|---|
open_ask | number | null | Yes | First ask price in the bucket. |
high_ask | number | null | Yes | Highest ask price in the bucket. |
low_ask | number | null | Yes | Lowest ask price in the bucket. |
close_ask | number | null | Yes | Last ask price in the bucket. |
ask_volume | integer | null | Yes | Last observed ask volume in the bucket. |
open_bid | number | null | Yes | First bid price in the bucket. |
high_bid | number | null | Yes | Highest bid price in the bucket. |
low_bid | number | null | Yes | Lowest bid price in the bucket. |
close_bid | number | null | Yes | Last bid price in the bucket. |
bid_volume | integer | null | Yes | Last observed bid volume in the bucket. |
sample_count | integer | Yes | Number of underlying 5-minute observations aggregated into this bucket. |
open_time | string (date-time) | null | Yes | Timestamp of the first observation inside this bucket. Distinct from bucket (the interval boundary). |
close_time | string (date-time) | null | Yes | Timestamp of the last observation inside this bucket. Distinct from bucket (the interval boundary). |
YoupinOHLCSourceData
OHLC bucket of Youpin prices.
| Field | Type | Required | Description |
|---|---|---|---|
open_ask | number | null | Yes | First ask price in the bucket. |
high_ask | number | null | Yes | Highest ask price in the bucket. |
low_ask | number | null | Yes | Lowest ask price in the bucket. |
close_ask | number | null | Yes | Last ask price in the bucket. |
ask_volume | integer | null | Yes | Last observed ask volume in the bucket. |
open_bid | number | null | Yes | First bid price in the bucket. |
high_bid | number | null | Yes | Highest bid price in the bucket. |
low_bid | number | null | Yes | Lowest bid price in the bucket. |
close_bid | number | null | Yes | Last bid price in the bucket. |
bid_volume | integer | null | Yes | Last observed bid volume in the bucket. |
sample_count | integer | Yes | Number of underlying 5-minute observations aggregated into this bucket. |
open_time | string (date-time) | null | Yes | Timestamp of the first observation inside this bucket. Distinct from bucket (the interval boundary). |
close_time | string (date-time) | null | Yes | Timestamp of the last observation inside this bucket. Distinct from bucket (the interval boundary). |
CsfloatOHLCSourceData
OHLC bucket of CSFloat ask and bid prices.
| Field | Type | Required | Description |
|---|---|---|---|
open_ask | number | null | Yes | First ask price in the bucket. |
high_ask | number | null | Yes | Highest ask price in the bucket. |
low_ask | number | null | Yes | Lowest ask price in the bucket. |
close_ask | number | null | Yes | Last ask price in the bucket. |
ask_volume | integer | null | Yes | Last observed ask volume in the bucket. |
open_bid | number | null | Yes | First bid price in the bucket. |
high_bid | number | null | Yes | Highest bid price in the bucket. |
low_bid | number | null | Yes | Lowest bid price in the bucket. |
close_bid | number | null | Yes | Last bid price in the bucket. |
sample_count | integer | Yes | Number of underlying 5-minute observations aggregated into this bucket. |
open_time | string (date-time) | null | Yes | Timestamp of the first observation inside this bucket. Distinct from bucket (the interval boundary). |
close_time | string (date-time) | null | Yes | Timestamp of the last observation inside this bucket. Distinct from bucket (the interval boundary). |
SkinportOHLCSourceData
OHLC bucket of Skinport ask prices.
| Field | Type | Required | Description |
|---|---|---|---|
open_ask | number | null | Yes | First ask price in the bucket. |
high_ask | number | null | Yes | Highest ask price in the bucket. |
low_ask | number | null | Yes | Lowest ask price in the bucket. |
close_ask | number | null | Yes | Last ask price in the bucket. |
ask_volume | integer | null | Yes | Last observed ask volume in the bucket. |
sample_count | integer | Yes | Number of underlying 5-minute observations aggregated into this bucket. |
open_time | string (date-time) | null | Yes | Timestamp of the first observation inside this bucket. Distinct from bucket (the interval boundary). |
close_time | string (date-time) | null | Yes | Timestamp of the last observation inside this bucket. Distinct from bucket (the interval boundary). |
SteamOHLCSourceData
OHLC bucket of Steam Community Market ask and bid prices.
| Field | Type | Required | Description |
|---|---|---|---|
open_ask | number | null | Yes | First ask price in the bucket. |
high_ask | number | null | Yes | Highest ask price in the bucket. |
low_ask | number | null | Yes | Lowest ask price in the bucket. |
close_ask | number | null | Yes | Last ask price in the bucket. |
ask_volume | integer | null | Yes | Last observed ask volume in the bucket. |
open_bid | number | null | Yes | First bid price in the bucket. |
high_bid | number | null | Yes | Highest bid price in the bucket. |
low_bid | number | null | Yes | Lowest bid price in the bucket. |
close_bid | number | null | Yes | Last bid price in the bucket. |
bid_volume | integer | null | Yes | Last observed bid volume in the bucket. |
sample_count | integer | Yes | Number of underlying 5-minute observations aggregated into this bucket. |
open_time | string (date-time) | null | Yes | Timestamp of the first observation inside this bucket. Distinct from bucket (the interval boundary). |
close_time | string (date-time) | null | Yes | Timestamp of the last observation inside this bucket. Distinct from bucket (the interval boundary). |
C5GameOHLCSourceData
OHLC bucket of C5Game ask and bid prices.
| Field | Type | Required | Description |
|---|---|---|---|
open_ask | number | null | Yes | First ask price in the bucket. |
high_ask | number | null | Yes | Highest ask price in the bucket. |
low_ask | number | null | Yes | Lowest ask price in the bucket. |
close_ask | number | null | Yes | Last ask price in the bucket. |
ask_volume | integer | null | Yes | Last observed ask volume in the bucket. |
open_bid | number | null | Yes | First bid price in the bucket. |
high_bid | number | null | Yes | Highest bid price in the bucket. |
low_bid | number | null | Yes | Lowest bid price in the bucket. |
close_bid | number | null | Yes | Last bid price in the bucket. |
sample_count | integer | Yes | Number of underlying 5-minute observations aggregated into this bucket. |
open_time | string (date-time) | null | Yes | Timestamp of the first observation inside this bucket. Distinct from bucket (the interval boundary). |
close_time | string (date-time) | null | Yes | Timestamp of the last observation inside this bucket. Distinct from bucket (the interval boundary). |
Item Schema
SchemaItem
One schema record, keyed by market_hash_name in the top-level items map. Fields that do not apply to the item are omitted.
| Field | Type | Required | Description |
|---|---|---|---|
market_hash_name | string | Yes | Canonical Steam market_hash_name, matching the price endpoints. |
category | string | Yes | Item category (e.g. skin, sticker, container, agent). |
image | string | Yes | Image URL served from cs2.sh. |
steam_image | string | No | Official Steam image URL, when available. |
is_tradable | boolean | Yes | Whether the item can be traded. |
rarity | object | No | Item rarity with name, tier, and color. |
collections | string[] | No | Collections the item belongs to. Omitted when none. |
containers | string[] | No | Containers the item drops from. Omitted when none. |
ids | object | No | Marketplace catalog ids where known. |
def_index | integer | No | Item definition index. |
base_name | string | No | Base item name without the wear suffix. Skins only. |
weapon | string | No | Weapon name. Skins only. |
finish | string | No | Finish name. Skins only. |
paint_index | integer | No | Paint kit index. Skins only; omitted on Doppler and Gamma Doppler base items. |
wears | string[] | No | Wears the item exists in. Wear-carrying items only. |
has_stattrak | boolean | No | Whether a StatTrak version exists. Wear-carrying items only. |
has_souvenir | boolean | No | Whether a Souvenir version exists. Wear-carrying items only. |
float_range | object | No | Float bounds for this item. Wear-carrying items only. |
wear | string | No | This item's wear (e.g. Field-Tested). Wear-carrying items only. |
wear_float_range | object | No | Float bounds for this exact wear row, float_range clamped to this wear's bracket. Wear-carrying items only. |
stattrak | boolean | No | Whether this row is the StatTrak version. |
souvenir | boolean | No | Whether this row is the Souvenir version. |
variants | SchemaItemVariant[] | No | Doppler and Gamma Doppler phases or Case Hardened tiers for this base item. |
variant | object | No | Back-link on a variant row to its base item. |
phase | string | No | Phase or gem name. Doppler and Gamma Doppler variant rows only. |
color | string | No | Hex accent color. Doppler and Gamma Doppler variant rows only. |
SchemaItemVariant
A Doppler or Gamma Doppler phase or Case Hardened tier listed under a base item's variants.
| Field | Type | Required | Description |
|---|---|---|---|
market_hash_name | string | Yes | Full variant market_hash_name. |
family | string | Yes | Allowed: doppler, gamma_doppler, case_hardened. Variant family. |
name | string | Yes | Variant name (e.g. Phase 2, Ruby, Tier 1). |
phase | string | No | Phase or gem name. Omitted for Case Hardened. |
color | string | No | Hex accent color. Omitted for Case Hardened. |
paint_index | integer | No | Paint kit index for this variant. |
image | string | Yes | Image URL served from cs2.sh. |
steam_image | string | No | Official Steam image URL, when available. |
SchemaCollection
Collection metadata. Keyed by collection name in the top-level collections map.
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Collection name. |
kind | string | Yes | Collection kind (e.g. weapon, sticker). |
release_date | string | No | Release date (YYYY-MM-DD), when known. An item's release date is its collection's. |
released_at | string | No | When Valve announced the collection (RFC 3339 UTC), when known. |
update_name | string | No | Valve's own name for that update, e.g. Season 5, Armory, and More. |
announcement_url | string | No | Canonical Steam announcement for that update. |
image | string | No | Image URL served from cs2.sh, when available. |
steam_image | string | No | Official Steam image URL, when available. |
SchemaRarity
A rarity tier. Listed in the top-level rarities array and referenced by item-level rarity.
| Field | Type | Required | Description |
|---|---|---|---|
key | string | Yes | Stable rarity key (e.g. ancient, legendary). |
name | string | Yes | Display name (e.g. Covert, Classified). |
tier | integer | Yes | Numeric rarity tier, ascending with rarity. |
color | string | Yes | Hex color for the rarity. |
Health
HealthResponse
Current health of cs2.sh data sources and public datasets.
| Field | Type | Required | Description |
|---|---|---|---|
status | string | Yes | Allowed: up, degraded, down. Overall API data health. |
last_refreshed_at | string (date-time) | Yes | When this health snapshot was generated. |
schema_ready | boolean | Yes | Whether the item schema is available. |
sources | Record<string, HealthEntry> | Yes | Marketplace health keyed by source. |
variants | Record<string, HealthEntry> | Yes | Variant-price health keyed by source collector. |
endpoints | Record<string, HealthEntry> | Yes | Dataset health keyed by endpoint name. fx reports the exchange rates used for currency conversion. |
stats | HealthStats | Yes | Aggregate database counts at the last health refresh. |
HealthEntry
Freshness and status for one source, variant collector, or endpoint dataset.
| Field | Type | Required | Description |
|---|---|---|---|
updated_at | string (date-time) | Yes | Most recent source-data timestamp represented by this entry. |
collected_at | string (date-time) | Yes | When cs2.sh most recently collected or produced this dataset. |
status | string | Yes | Allowed: up, degraded, down. Health derived from the dataset's expected refresh rate. |
HealthStats
Aggregate database counts at the last health refresh.
| Field | Type | Required | Description |
|---|---|---|---|
total_events | integer | Yes | Total stored market-data events. |
market_hash_names | integer | Yes | Unique item names represented in current market data. |
variant_items | integer | Yes | Unique variant item names represented in current market data. |
Errors
ItemError
Error for one item in a partial-success response.
| Field | Type | Required | Description |
|---|---|---|---|
item | string | Yes | The requested item name that failed. |
code | string | Yes | Allowed: unknown_item, not_in_cache, invalid_format, not_in_archive, unsupported_variant, unsupported_source. Error code. |
message | string | Yes | Human-readable error message. |
ErrorResponse
| Field | Type | Required | Description |
|---|---|---|---|
error | string | Yes | Error code, e.g. validation_error, unauthorized, rate_limited. |
message | string | Yes | Human-readable error message. |
request_id | string (uuid) | No | Unique request identifier for support. |
details | object | No | Additional error details; structure varies by error type. |