GET /v1/prices/snapshot.ndjson.gz — 完整价格快照

GET

prices

snapshot.ndjson.gz

Full price-list snapshot (gzipped NDJSON)

curl --request GET \
  --url https://csboard.com/v1/prices/snapshot.ndjson.gz \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://csboard.com/v1/prices/snapshot.ndjson.gz', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://csboard.com/v1/prices/snapshot.ndjson.gz",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://csboard.com/v1/prices/snapshot.ndjson.gz"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://csboard.com/v1/prices/snapshot.ndjson.gz")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

"<string>"

{
  "code": "missing_api_key",
  "detail": "Provide your API key via `Authorization: Bearer csb_pub_…`. Generate one at https://csboard.com/profile?tab=api"
}

{
  "code": "rate_limit_exceeded",
  "detail": "Read rate limit of 100 requests/min exceeded. The counter restarts in 23 s. For new listings use GET /v1/listings/stream instead of polling.",
  "bucket": "read",
  "limit_per_min": 100,
  "retry_after_sec": 23
}

snapshot 端点以单个 gzip 压缩的 NDJSON 文件形式提供完整的 CSBoard 价格列表。解压后的每一行都是一个 PriceRow JSON 对象——与 GET /v1/prices 返回的模式相同。它专为全目录消费者设计，如比价站点、套利机器人或需要完整本地价格列表副本的数据管道。如果只是对部分商品进行有针对性的查询，请改用 GET /v1/prices。 需要身份验证。 请将密钥作为 Authorization: Bearer csb_pub_... 发送。 速率限制： 每分钟 1 次请求，独立于一般的 30 次/分钟限制。请相应规划您的轮询间隔。

请求头

string

传入上一次快照响应中的 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	该组中的挂单数量。

示例：下载并查看

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

解压输出示例：

{"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}

示例：使用 ETag 的条件请求

首次下载时，您会收到一个 ETag 响应头。在后续请求中将其传回，可避免重新下载未变化的快照：

# 首次请求 —— 保存响应头中的 ETag
curl https://csboard.com/v1/prices/snapshot.ndjson.gz \
  -H "Authorization: Bearer csb_pub_..." \
  --dump-header headers.txt \
  --output snapshot.ndjson.gz

# 后续请求 —— 条件性获取
curl https://csboard.com/v1/prices/snapshot.ndjson.gz \
  -H "Authorization: Bearer csb_pub_..." \
  -H "If-None-Match: \"etag-value\"" \
  --output snapshot.ndjson.gz

304 Not Modified 响应意味着快照与您本地已有的副本完全一致——无需重新下载。

错误代码

HTTP 状态码	代码	含义
304	(无响应体)	自所提供的 `If-None-Match` ETag 以来，快照未发生变化。
401	`missing_api_key`, `invalid_api_key`	API 密钥缺失或无效。
429	`snapshot_rate_limited`	超过快照专属的 1 次/分钟速率限制。请稍后再试。

请始终保存每次成功下载时返回的 ETag，并在下次请求时作为 If-None-Match 发回。304 响应不会消耗您的速率限制配额，并能让您的本地副本保持最新而无需不必要的重新下载。

此端点专为全目录摄取设计。如果您只需要特定商品或经过过滤的子集的价格，请改用 GET /v1/prices——它支持 search、category 和 wear 过滤，且不会计入快照速率限制。

授权

Authorization

string

header

必填

Send your key as a Bearer token on every request: Authorization: Bearer csb_pub_.... Generate keys in your CSBoard profile. Calls made with a key are metered only by that key's own limits — there is no per-IP limit on top — and every answer carries X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset and X-RateLimit-Bucket for the bucket the call spent. See Rate limits.

请求头

If-None-Match

string

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.

Full price-list snapshot (gzipped NDJSON)

curl --request GET \
  --url https://csboard.com/v1/prices/snapshot.ndjson.gz \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://csboard.com/v1/prices/snapshot.ndjson.gz', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://csboard.com/v1/prices/snapshot.ndjson.gz",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://csboard.com/v1/prices/snapshot.ndjson.gz"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://csboard.com/v1/prices/snapshot.ndjson.gz")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

"<string>"

{
  "code": "missing_api_key",
  "detail": "Provide your API key via `Authorization: Bearer csb_pub_…`. Generate one at https://csboard.com/profile?tab=api"
}

{
  "code": "rate_limit_exceeded",
  "detail": "Read rate limit of 100 requests/min exceeded. The counter restarts in 23 s. For new listings use GET /v1/listings/stream instead of polling.",
  "bucket": "read",
  "limit_per_min": 100,
  "retry_after_sec": 23
}

市场数据

交易

P2P

账户

状态

GET /v1/prices/snapshot.ndjson.gz — 完整价格快照

请求头

响应头

响应体

示例：下载并查看

示例：使用 ETag 的条件请求

错误代码

授权

请求头

响应