> ## Documentation Index
> Fetch the complete documentation index at: https://api.csboard.com/llms.txt
> Use this file to discover all available pages before exploring further.
# GET /v1/prices/snapshot.ndjson.gz — Full Price Snapshot
> Download the full CSBoard price catalog as a gzipped NDJSON file. One PriceRow per line. Designed for bulk ingestion with ETag-based conditional fetching.
The snapshot endpoint serves the complete CSBoard price list as a single gzipped NDJSON file. Every decompressed line is one `PriceRow` JSON object — the same schema returned by `GET /v1/prices`. This is the intended path for full-catalog consumers such as comparison sites, arbitrage bots, or data pipelines that need a complete local copy of the price list. For targeted queries against a subset of items, use `GET /v1/prices` instead.
**Authentication required.** Send your key as `Authorization: Bearer csb_pub_...`.
**Rate limit:** 1 request per minute, separate from the general 30 requests/min limit. Plan your polling interval accordingly.
## Request headers
Pass the `ETag` value from a previous snapshot response to make a conditional request. If the snapshot has not changed since that ETag, the server returns `304 Not Modified` with no body, saving bandwidth and avoiding a fresh download.
## Response headers
| Header | Description |
| ------------------ | --------------------------------------------------------------------------------------------------------------- |
| `ETag` | Opaque version string identifying this snapshot. Store it and send back as `If-None-Match` on the next request. |
| `Content-Encoding` | `gzip` — the body is always gzip-compressed. |
## Response body
A gzip-compressed stream. After decompression, each newline-delimited line is a valid JSON object conforming to the `PriceRow` schema:
| Field | Type | Description |
| ------------------ | -------------- | --------------------------------- |
| `market_hash_name` | string | Steam market hash name. |
| `wear` | string \| null | Wear bucket, or `null`. |
| `doppler_phase` | string \| null | Doppler phase, or `null`. |
| `min_price_usd` | number | Cheapest current ask in USD. |
| `qty` | integer | Number of listings in this group. |
## Example: download and inspect
```bash theme={null}
curl https://csboard.com/v1/prices/snapshot.ndjson.gz \
-H "Authorization: Bearer csb_pub_..." \
--output snapshot.ndjson.gz \
&& gunzip -c snapshot.ndjson.gz | head -5
```
Example decompressed output:
```jsonl theme={null}
{"market_hash_name":"AK-47 | Redline (Field-Tested)","wear":"Field-Tested","doppler_phase":null,"min_price_usd":11.92,"qty":73}
{"market_hash_name":"AWP | Asiimov (Field-Tested)","wear":"Field-Tested","doppler_phase":null,"min_price_usd":54.20,"qty":12}
{"market_hash_name":"Karambit | Doppler (Factory New)","wear":"Factory New","doppler_phase":"Ruby","min_price_usd":1240.00,"qty":1}
```
## Example: conditional request with ETag
On the first download you receive an `ETag` header. Pass it back on subsequent requests to avoid re-downloading an unchanged snapshot:
```bash theme={null}
# First request — save ETag from response headers
curl https://csboard.com/v1/prices/snapshot.ndjson.gz \
-H "Authorization: Bearer csb_pub_..." \
--dump-header headers.txt \
--output snapshot.ndjson.gz
# Subsequent request — conditional fetch
curl https://csboard.com/v1/prices/snapshot.ndjson.gz \
-H "Authorization: Bearer csb_pub_..." \
-H "If-None-Match: \"etag-value\"" \
--output snapshot.ndjson.gz
```
A `304 Not Modified` response means the snapshot is identical to the one you already have — no new download needed.
## Error codes
| HTTP status | Code | Meaning |
| ----------- | ----------------------- | -------------------------------------------------------------------------- |
| 304 | *(no body)* | Snapshot unchanged since the supplied `If-None-Match` ETag. |
| 401 | `unauthorized` | Missing or invalid API key. |
| 429 | `snapshot_rate_limited` | Over the 1 request/min snapshot-specific rate limit. Wait before retrying. |
Always store the `ETag` from each successful download and send it back as `If-None-Match` on the next request. A `304` response costs nothing against your rate limit quota and keeps your local copy up to date without unnecessary re-downloads.
This endpoint is designed for **full-catalog ingestion**. If you only need prices for a specific item or a filtered subset, use `GET /v1/prices` — it supports search, category, and wear filters and does not count against the snapshot rate limit.
## OpenAPI
````yaml GET /prices/snapshot.ndjson.gz
openapi: 3.1.0
info:
title: CSBoard API
version: 1.0.0
description: >-
Market data over the CSBoard marketplace — live listings, floats, stickers,
minAsk prices, FX rates — plus opt-in buying straight from your balance.
Free to read, key-gated, built for automation.
contact:
name: CSBoard
url: https://csboard.com/docs
servers:
- url: https://csboard.com/v1
description: Production
security:
- bearerAuth: []
tags:
- name: Status
description: Liveness and freshness probes.
- name: Market data
description: Read the live catalog, prices, and FX rates.
- name: Trading
description: Buy listings from your CSBoard balance. Opt-in, key-gated.
- name: Account
description: Your balance, settled funds, and trading status.
paths:
/prices/snapshot.ndjson.gz:
get:
tags:
- Market data
summary: Full price-list snapshot (gzipped NDJSON)
description: >-
Full gzipped NDJSON dump of the price list — one price row JSON per
line. Use this for full-catalog ingestion (e.g. comparison sites), not
pagination. Rate limited to 1 request/minute. Supports ETag /
If-None-Match: an unchanged snapshot returns 304 Not Modified.
operationId: getPriceSnapshot
parameters:
- name: If-None-Match
in: header
description: >-
Conditional request. Pass the ETag from a previous snapshot to
receive 304 if unchanged.
schema:
type: string
responses:
'200':
description: >-
Gzipped NDJSON stream. Each decompressed line is one PriceRow JSON
object. Sets an ETag header.
headers:
ETag:
description: >-
Opaque snapshot version. Send back as If-None-Match to skip
unchanged downloads.
schema:
type: string
content:
application/x-ndjson:
schema:
type: string
format: binary
'304':
description: Not Modified — the snapshot has not changed since the ETag you sent.
'401':
$ref: '#/components/responses/Unauthorized'
'429':
$ref: '#/components/responses/RateLimited'
components:
responses:
Unauthorized:
description: Missing or invalid API key.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: unauthorized
message: Missing or invalid API key.
RateLimited:
description: Rate limit exceeded. Includes a Retry-After header.
headers:
Retry-After:
description: Seconds to wait before retrying.
schema:
type: integer
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
code: rate_limit_exceeded
message: Too many requests.
schemas:
Error:
type: object
description: >-
All errors return { code, detail }. Some carry extra fields (e.g.
price_moved adds current_total_usd, insufficient_balance adds
required_usd/current_usd).
properties:
code:
type: string
description: >-
Machine-readable error code, e.g. rate_limit_exceeded,
trading_not_enabled, price_moved.
detail:
type: string
description: Human-readable explanation.
required:
- code
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: >-
Send your key as a Bearer token on every request: `Authorization: Bearer
csb_pub_...`. Generate keys in your CSBoard profile.
````