> ## 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.

# CSBoard API — 市场数据与交易

> 通过单一 REST API 访问实时 CS2 皮肤挂单、float 值、贴纸数据和最低询价——以及可选的自动化购买。

CSBoard API 是一个面向开发者和 AI 智能体友好的 REST 接口，作为 CSBoard 市场的访问入口。无论您是在构建价格追踪器、为 AI 交易智能体提供动力，还是从余额中自动化购买，该 API 都能提供实时挂单、float 值、贴纸详情、minAsk 价格和汇率转换——以及可选的从 CSBoard 余额直接购买功能。所有端点都需要密钥（健康检查除外），而购买能力需要单独启用的交易密钥。

## 基础 URL

```
https://csboard.com/v1
```

## 关键概念

* **健康检查** — [`GET /v1/health`](/api-reference/get-health) 是唯一不需要身份验证的端点。在开始会话前，用它来验证 API 是否运行正常以及价格列表是否为最新。
* **挂单** — [`GET /v1/listings`](/api-reference/get-listings) 返回实时可购买物品，包括 float、paint seed、贴纸和以美元计价的询价。支持基于键的分页和丰富的过滤器。
* **价格** — [`GET /v1/prices`](/api-reference/get-prices) 提供按皮肤分组的 minAsk 价格。[`GET /v1/prices/snapshot.ndjson.gz`](/api-reference/get-prices-snapshot) 提供完整的 gzip 压缩 NDJSON 转储，用于批量目录摄入。
* **订单** — [`POST /v1/orders`](/api-reference/post-orders) 下达购买订单，从您的 CSBoard 余额扣款。需要启用了交易的密钥。
* **汇率** — 此 API 中所有价格均为 **美元（USD）**。使用 [`GET /v1/currency`](/api-reference/get-currency) 通过与站点相同的汇率表转换为本地货币。

所有列表端点的分页使用 **keyset 游标**——将一次响应中返回的 `cursor` 值作为下次请求的 `cursor` 查询参数。

## 快速开始

只有 [`GET /v1/health`](/api-reference/get-health) 无需密钥即可工作。其他所有端点都需要在 `Authorization` 头中提供 `csb_pub_` Bearer 令牌：

```bash theme={null}
curl https://csboard.com/v1/listings \
  -H "Authorization: Bearer csb_pub_..."
```

在 [csboard.com/profile?tab=api](https://csboard.com/profile?tab=api) 生成您的密钥，并查阅 [身份验证](/authentication) 页面以了解密钥类型和错误处理的完整详情。

## 探索文档

<CardGroup cols={2}>
  <Card title="身份验证" icon="key" href="/authentication">
    了解如何生成密钥、在请求中传递它，以及理解只读密钥与交易密钥的区别。
  </Card>

  <Card title="速率限制" icon="gauge" href="/rate-limits">
    了解每个密钥的请求限制、`Retry-After` 头部，以及如何处理 429 响应。
  </Card>

  <Card title="市场数据指南" icon="chart-line" href="/guides/market-data">
    查询实时挂单、获取最低询价并下载批量快照。
  </Card>

  <Card title="购买指南" icon="cart-shopping" href="/guides/buying">
    使用启用了交易的密钥从您的 CSBoard 余额下单。
  </Card>
</CardGroup>