快速开始

本指南将带您在 5 分钟内完成使用 BigONE API 的基本步骤。

准备工作

在开始之前，您需要：

一个拥有 API 访问权限的 BigONE 账户
HTTP 和 JSON 的基础知识
一门支持 HTTP 客户端的编程语言（如 Python, Go, JavaScript 等）

第一步：创建 API Key

登录您的 BigONE 账户
前往 API 设置
点击 创建 API Key
选择您所需的权限范围 (Scopes)
立即保存您的 API Secret — 它只会显示一次

安全第一

切勿分享您的 API Secret。它拥有您账户在授权范围内的完全访问权限。

详细说明请参阅 API Key 设置。

第二步：生成 JWT Token

所有私有 API 请求都需要在请求头中包含 JWT Token。

示例：生成 Token (Python)

import jwt
import time

API_KEY = 'your_api_key_here'
API_SECRET = 'your_api_secret_here'

# 生成随机数 (nonce): 当前纳秒级时间戳
nonce = int(time.time() * 1e9)

# 创建 JWT payload
payload = {
    "type": "OpenAPIV2",
    "sub": API_KEY,
    "nonce": str(nonce),
}

# 签名 Token
token = jwt.encode(payload, API_SECRET, algorithm="HS256")

查看鉴权认证获取 Go 和 JavaScript 的代码示例。

第三步：发起您的第一个请求

使用生成的 Token 发起认证请求：

# 公共端点 - 无需认证
curl "https://api.big.one/api/v3/asset_pairs" # 获取所有可用的交易对

# 私有端点 - 需要认证
curl "https://api.big.one/api/v3/viewer/accounts" \
     -H "Authorization: Bearer YOUR_JWT_TOKEN"

第四步：处理响应

所有 API 响应都遵循以下格式：

{
  "code": 0,
  "data": { ... },
  "page_token": "abc123..."  // 仅用于分页端点
}

code: 0 表示成功
非零 code 表示错误
查看通用信息了解频率限制和错误处理

下一步

鉴权认证 — 了解 JWT Token 的工作原理
通用信息 — 了解频率限制和响应格式
API 参考 — 浏览所有可用的 API 端点

准备工作​

第一步：创建 API Key​

第二步：生成 JWT Token​

示例：生成 Token (Python)​

第三步：发起您的第一个请求​

第四步：处理响应​

下一步​