6 个图像模型 · 能力与价格一处查看查看价格 →
API 文档查询账户账本

OGA 开发者中心

API v1 · 最后核对 2026-08-15

查询账户账本

分页读取余额变化的不可变账本事件。

GET/api/v1/account/ledger
浏览常用接口

接口说明

账本事件用于核对充值、授权、结算与退款。调用方应使用稳定事件类型和金额字段,不要从展示文案反推业务状态。

认证:Bearer API Key

请求

查询参数

名称类型说明
pageinteger页码,从 1 开始。
page_sizeinteger每页 1–100 条,默认 20。
event_typestring按稳定账本事件类型过滤。

响应

JSON 接口使用统一响应信封。HTTP 状态表达请求结果,业务错误不会伪装成 HTTP 200。

HTTP含义
200请求成功
400业务参数或过滤条件无效
401缺少或无效的 API Key
403API Key 已禁用或无权访问
422请求结构校验失败
500服务内部错误

完整成功响应示例(可选字段可能因状态不同而变化)

{
  "code": 0,
  "message": "success",
  "data": {
    "items": [],
    "total": 0,
    "page": 1,
    "page_size": 20
  },
  "request_id": "8f25b42f-2ed1-4ad7-99de-61d7f779bc7b",
  "timestamp": "2026-08-10T00:00:00Z"
}

重要边界

  • 只读查询不会改变余额或任务状态。

查看机器可读 OpenAPI

代码与在线调试

GET · /api/v1/account/ledger

curl -X GET "$OGA_BASE_URL/api/v1/account/ledger?page=1&page_size=20&event_type=settlement" \
  -H "Authorization: Bearer <YOUR_OGA_API_KEY>" \
  -H "X-Request-Id: <UUID_V4>" \
  -H "Accept-Language: zh-CN"