跳转到主要内容
GET
/
orders
List purchase history
curl --request GET \
  --url https://csboard.com/v1/orders \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "order_id": "ord_01J9Z3K8Q2",
      "steam_id": "76561198000000000",
      "status": "completed",
      "custom_id": "batch-2026-06-29-01",
      "currency": "USD",
      "charged_total_usd": 26.47,
      "item_count": 2,
      "hold_until": null,
      "created_at": "2026-06-29T17:12:04Z",
      "updated_at": "2026-06-29T17:15:40Z",
      "items": [
        {
          "market_hash_name": "AK-47 | Redline (Minimal Wear)",
          "price_usd": 14.37,
          "status": "delivered",
          "tradable_at": "2026-07-06T12:00:00Z",
          "return_reason": null,
          "steam_trade_offer_id": "5512345678",
          "steam_trade_offer_finished_at": "2026-06-29T17:15:40Z"
        }
      ]
    }
  ],
  "meta": {
    "next_cursor": "eyJpZCI6Im9yZF8wMUo5WjNLOFEyIn0=",
    "per_page": 50
  }
}
orders 端点返回您的购买历史,按时间倒序排列,使用键集分页。可按时间窗口和状态过滤,然后通过将 meta.next_cursor 作为 cursor 传回,遍历更早的页面。每个订单都附带逐件商品明细及其交付状态。 需要身份验证。 请将密钥作为 Authorization: Bearer csb_pub_... 发送。

查询参数

limit
integer
默认值:"50"
每页结果数。最小 1,最大 100
start_unix_time
integer
仅返回在该 Unix 时间戳(秒)当时或之后创建的订单。
end_unix_time
integer
仅返回在该 Unix 时间戳(秒)当时或之前创建的订单。
status
string
按订单状态过滤。可选值:completedholddeliveringpendingcancelledfailed 之一。
cursor
string
来自上次响应中 meta.next_cursor 的键集游标。传入以获取下一页。

响应字段

data
Order[]
必填
本页订单数组。
meta
object
必填

示例请求

curl "https://csboard.com/v1/orders?status=completed&limit=50" \
  -H "Authorization: Bearer csb_pub_..."

示例响应

{
  "data": [
    {
      "order_id": "ord_01J9Z3K8Q2",
      "steam_id": "76561198000000000",
      "status": "completed",
      "custom_id": "batch-2026-06-29-01",
      "currency": "USD",
      "charged_total_usd": 26.47,
      "item_count": 2,
      "hold_until": null,
      "created_at": "2026-06-29T17:12:04Z",
      "updated_at": "2026-06-29T17:15:40Z",
      "items": [
        {
          "market_hash_name": "AK-47 | Redline (Minimal Wear)",
          "price_usd": 14.37,
          "status": "delivered",
          "tradable_at": "2026-07-06T12:00:00Z",
          "return_reason": null,
          "steam_trade_offer_id": "5512345678",
          "steam_trade_offer_finished_at": "2026-06-29T17:15:40Z"
        }
      ]
    }
  ],
  "meta": { "next_cursor": "eyJpZCI6Im9yZF8wMUo5WjNLOFEyIn0=", "per_page": 50 }
}

错误代码

HTTP 状态码代码含义
401missing_api_key / invalid_api_keyAPI 密钥缺失或无效。
422invalid_request查询参数无效(例如 limit 超出范围)。
429rate_limit_exceeded请求过多。请按照 Retry-After 响应头中的秒数退避。

授权

Authorization
string
header
必填

Send your key as a Bearer token on every request: Authorization: Bearer csb_pub_.... Generate keys in your CSBoard profile.

查询参数

limit
integer
默认值:50

Results per page. 1–100. Default 50.

必填范围: 1 <= x <= 100
start_unix_time
integer

Only orders created at or after this Unix timestamp (seconds).

end_unix_time
integer

Only orders created at or before this Unix timestamp (seconds).

status
enum<string>

Filter by order status.

可用选项:
completed,
hold,
delivering,
pending,
cancelled,
failed
cursor
string

Keyset cursor from a previous response's meta.next_cursor.

响应

A page of orders.

data
object[]
必填
meta
object
必填