市场数据
GET /v1/prices/snapshot.ndjson.gz — 完整价格快照
以 gzip 压缩的 NDJSON 文件下载完整的 CSBoard 价格目录,每行一个 PriceRow。专为批量摄取设计,支持基于 ETag 的条件性获取。
GET
Full price-list snapshot (gzipped NDJSON)
snapshot 端点以单个 gzip 压缩的 NDJSON 文件形式提供完整的 CSBoard 价格列表。解压后的每一行都是一个
解压输出示例:
PriceRow JSON 对象——与 GET /v1/prices 返回的模式相同。它专为全目录消费者设计,如比价站点、套利机器人或需要完整本地价格列表副本的数据管道。如果只是对部分商品进行有针对性的查询,请改用 GET /v1/prices。
需要身份验证。 请将密钥作为 Authorization: Bearer csb_pub_... 发送。
速率限制: 每分钟 1 次请求,独立于一般的 30 次/分钟限制。请相应规划您的轮询间隔。
请求头
传入上一次快照响应中的
ETag 值,以发起条件请求。如果自该 ETag 以来快照未发生变化,服务器将返回 304 Not Modified 且无响应体,从而节省带宽并避免一次新的下载。响应头
| 响应头 | 说明 |
|---|---|
ETag | 标识该快照的不透明版本字符串。请将其保存并在下一次请求时作为 If-None-Match 发回。 |
Content-Encoding | gzip——响应体始终经过 gzip 压缩。 |
响应体
一个 gzip 压缩的数据流。解压后,每个以换行分隔的行都是一个符合PriceRow 模式的有效 JSON 对象:
| 字段 | 类型 | 说明 |
|---|---|---|
market_hash_name | string | Steam 市场哈希名称。 |
wear | string | null | 磨损档位,或 null。 |
doppler_phase | string | null | 多普勒相位,或 null。 |
min_price_usd | number | 当前最低美元报价。 |
qty | integer | 该组中的挂单数量。 |
示例:下载并查看
示例:使用 ETag 的条件请求
首次下载时,您会收到一个ETag 响应头。在后续请求中将其传回,可避免重新下载未变化的快照:
304 Not Modified 响应意味着快照与您本地已有的副本完全一致——无需重新下载。
错误代码
| HTTP 状态码 | 代码 | 含义 |
|---|---|---|
| 304 | (无响应体) | 自所提供的 If-None-Match ETag 以来,快照未发生变化。 |
| 401 | unauthorized | API 密钥缺失或无效。 |
| 429 | snapshot_rate_limited | 超过快照专属的 1 次/分钟速率限制。请稍后再试。 |
此端点专为全目录摄取设计。如果您只需要特定商品或经过过滤的子集的价格,请改用
GET /v1/prices——它支持 search、category 和 wear 过滤,且不会计入快照速率限制。授权
Send your key as a Bearer token on every request: Authorization: Bearer csb_pub_.... Generate keys in your CSBoard profile.
请求头
Conditional request. Pass the ETag from a previous snapshot to receive 304 if unchanged.
响应
Gzipped NDJSON stream. Each decompressed line is one PriceRow JSON object. Sets an ETag header.
The response is of type file.