bitget-agent-sdk — 官方 Bitget AI 交易类型Script SDK

Bitget统一交易账户(UTA / v3)的基础TypeScript SDK REST API——被曝光为AI可调用内特工具,HMAC-SHA256签名和客户端比率受限.

快速启动 • 妇女 特征 • 妇女 使用量 • 妇女 模块 • 妇女 测试 • 妇女 处理错误 • 妇女 财务问题

概览

@bitget-ai/bitget-agent-sdk 这是 基础类型SDK (原始内容存档于2018-03-21). Bitget Agent Hub Entertainment. 它规定:

• 89 空运联盟业务 带完整的 JSON Schema
• 14个意向动词 aI工具使用框架,加 raw 财务报告和审定财务报表 discover 元工具
• HMAC-SHA256 请求签署 和限制客户端利率
• 零运行时间依赖关系 轻而易举并具有树能"sideEffects": false(中文(简体) )

两者 bitget-agent-cli 财务报告和审定财务报表 bitget-agent-mcp 是在SDK上方建造的.

对于开发者:构建量子策略,定制MCP服务器,LLM工具-使用管道,或自动交易bots. 不是开发商? 使用更高水平的表面 : bitget-agent-cli + 键 bitget-agent-skill 为终端AI, bitget-agent-mcp 用于桌面AI, bitget-signal 市场分析,不需要账户。 他们都没有直接要求这个SDK.

快速启动

安装

npm install @bitget-ai/bitget-agent-sdk

基本用途

import {
  loadConfig,
  buildTools,
  BitgetRestClient,
  safeInvoke,
} from "@bitget-ai/bitget-agent-sdk";

// Default surface is "intent" (curated verbs + raw + discover).
// Starting with readOnly is a safe default — every write tool is dropped.
const config = loadConfig({ modules: "all", readOnly: true });
const client = new BitgetRestClient(config);
const tools = buildTools(config);
const ctx = { config, client };

console.log(`Loaded ${tools.length} tools`); // intent verbs + raw + discover

// Public market data — no credentials required.
const market = tools.find((t) => t.name === "market")!;
const res = await safeInvoke(
  market,
  { action: "tickers", category: "SPOT", symbol: "BTCUSDT" },
  ctx,
);

if (res.ok) console.log(res.data);
else console.error(res.error);

设定证书

证书从环境变量读取—— SDK 不解析 .env 文件,从不向磁盘写入证书 :

export BITGET_API_KEY="your-api-key"
export BITGET_SECRET_KEY="your-secret-key"
export BITGET_PASSPHRASE="your-passphrase"

或传入内线 loadConfig({ apiKey, secretKey, passphrase, ... })。 。 。 .

特征

对你有什么好处

密钥导出

// Client + tool primitives
import {
  BitgetRestClient,
  buildTools,
  toToolSpec,
  loadConfig,
  safeInvoke,
  toMcpTool,
} from "@bitget-ai/bitget-agent-sdk";

// Curated verbs, discovery, raw
import {
  COMPOSITE_TOOL_NAMES,
  buildDiscoverTool,
  DISCOVER_TOOL_NAME,
  RAW_TOOL_NAME,
} from "@bitget-ai/bitget-agent-sdk";

// The generated catalog (single source of truth)
import {
  CATALOG,
  CATALOG_SPEC_VERSION,
  CATALOG_OPERATION_COUNT,
  getOperation,
} from "@bitget-ai/bitget-agent-sdk";

// Types
import type {
  BitgetConfig,
  CliOptions,
  Surface,
  ToolSpec,
  ToolContext,
  ToolResult,
  SafeResult,
  ModuleId,
} from "@bitget-ai/bitget-agent-sdk";

// Metadata
import {
  SERVER_NAME,
  SERVER_VERSION,
  API_VARIANT,
  MODULES,
  DEFAULT_MODULES,
} from "@bitget-ai/bitget-agent-sdk";

// Errors — all subclasses of BitgetMcpError
import {
  BitgetMcpError,
  BitgetApiError,
  ConfigError,
  ValidationError,
  RateLimitError,
  AuthenticationError,
  NetworkError,
  toToolErrorPayload,
} from "@bitget-ai/bitget-agent-sdk";

从包根或包根中导出的一切 @bitget-ai/bitget-agent-sdk/testing 子路径如下 铸造。没有从这些路径导出的任何内容都是内部的,可能不经通知而改变.

使用量

控制工具范围和安全

loadConfig 接受这些常用选项:

每个工具都带有 riskLevel 联 合 国 read < write < high. 高风险业务自出:它们返回a { confirmationRequired: true } 预览直到通过 confirm所以特工不能在第一回合就发出毁灭性的呼叫 坚持下去 每个 路径——被曲解的动词, 1:1 操作工具,以及 raw 逃出舱门,通过一个安全阻塞点.

运行时探索

discover 让一个模型逐渐地学习表面,而不在提示中传输单独的工具目录:

const discover = tools.find((t) => t.name === "discover")!;

await safeInvoke(discover, {}, ctx);                                    // domains + tool counts
await safeInvoke(discover, { domain: "trade" }, ctx);                   // tools in a domain
await safeInvoke(discover, { tool: "market" }, ctx);                    // one tool's full schema
await safeInvoke(discover, { tool: "market", action: "tickers" }, ctx); // one action's exact contract
await safeInvoke(discover, { search: "funding" }, ctx);                 // keyword search

有意动词( 默认表面)

默认 intent 表面暴露 14个主动词,启用其模块上的每个门。 这14个单元涵盖一般可用的模块:

加上两个始终存在的元工具:

• raw - 逃生舱 直接调用任何操作 operationId 当你想要 准确的1:1合同。 它穿过这里 同一安全门 作为主动词—— readOnly, (中文(简体) ), dryRun和高风险 confirm 要求仍然适用,因此 raw 宽度 到达 永远不要跳过破坏行动确认.
• discover ——回顾活性地表(见上文). 两者都存在于每一个地表和每个模式中.

模块

默认配置文件加载 account + 键 trade + 键 market包括日常交易 装入所有东西 loadConfig({ modules: "all" }),或选择一个命名子集:

经典账户用户: 如果您在 Bitget 经典账户上, 您需要先通过 API 创建代理子账户, 然后使用该子账户的 API 密钥来调用 MCP / CLI / 技能工具 . 创建代理子账户

测试

从中导入一个模拟比特 API 模拟器 @bitget-ai/bitget-agent-sdk/testing 集成测试的子路径——不需要真正的 API 密钥 :

import { MockServer, seedState } from "@bitget-ai/bitget-agent-sdk/testing";
import { loadConfig, BitgetRestClient } from "@bitget-ai/bitget-agent-sdk";

const mock = new MockServer();
await mock.start(); // ephemeral port

const config = loadConfig({
  modules: "market",
  baseUrl: mock.baseUrl,
  apiKey: "test",
  secretKey: "test",
  passphrase: "test",
});
const client = new BitgetRestClient(config);

// ... drive your tests against `client` ...

await mock.stop();

处理错误

两个互补层面:

1. 联合国. safeInvoke ——推荐路径. 从来投出. 分会 .ok数字 :

const res = await safeInvoke(tool, args, ctx);
if (res.ok) {
  // res.data, res.endpoint, res.requestTime
} else {
  // res.error — a JSON-serialisable payload, ready for an LLM tool-use reply
}

2. 打字出错——直接拨打接取器时. 每个 API 失败和配置问题都显示为输入 Error 子类 instanceof- 狭:

import { BitgetApiError, ConfigError, RateLimitError } from "@bitget-ai/bitget-agent-sdk";

try {
  await tool.handler(args, ctx);
} catch (err) {
  if (err instanceof RateLimitError) {
    // SDK applies client-side rate limiting, but Bitget can still 429 under load — back off and retry
  } else if (err instanceof BitgetApiError) {
    console.error(err.code, err.message);
  } else if (err instanceof ConfigError) {
    // Missing or invalid credentials — surface to the user
  }
}

使用 toToolErrorPayload(err) 将任何被捕获错误转换成相同的 { ok: false, error: { … } } 有效载数 safeInvoke 生产.

警卫

• 仅来自环境变量的证书: API 密钥通过 export BITGET_API_KEY=... - SDK没有分析 .env 文件,从不向磁盘写入证书.
• 本地签名:所有经认证的请求在到达Bitget的API之前都会被HMAC-SHA256在程序内签名——没有第三方服务器参与.
• 限制客户端利率:内置节流阻断了循环来打出Bitget的API限制.

兼容性

文档

• 核心发现. 这个 discover 工具返回实时、配置意识工具表面和每个操作的合同;没有外部目录可以保持同步.
• Bitget API 参考. bitget.com/ api-doc 数据

相关项目

财务问题

什么叫"特务"?

bitget-agent-sdk 是正式的 Bitget 基础 TypeScript SDK —— 涵盖89个UTA 操作, HMAC- SHA256 签名, 客户端速率限制, 以及 14 个动词 intent 表面可挂入 LLM 工具使用框架 。 两者 bitget-agent-cli 财务报告和审定财务报表 bitget-agent-mcp 使它成为整个Bitget代理Hub生态系统的基础层.

这个SDK是设计用来什么开发商的?

构建定量交易策略,自定义MCP服务器,LLM工具使用管道,自动化交易bots,以及任何需要程序访问Bitget的UTA API的TypeScript或JavaScript项目.

这和直接给Bitget REST API打电话有什么不同?

SDK处理HMAC-SHA256请求签名,客户端速率限制,并打出出出错类. 它提供了14个曲折的心动词加上 raw 全部装入LLM工具使用框架. safeInvoke 给每个呼叫都穿制服 { ok, … } 形状 —— 不需要将每个操作员包裹在尝试/捕获中.

这个SDK支持通用JS吗?

不,它只是无害环境管理("type": "module"。要求节点.js 20和 NodeNext 模块分辨率.

我该怎么装上特定的模块?

通过一个逗号分隔列表,例如. loadConfig({ modules: "account,trade" }),或 loadConfig({ modules: "all" }) 每个模块.

我在一个典型的Bitget帐户上——我能用这个吗?

是的,但经典的账户需要先通过API创建代理子账户,然后使用该子账户的API密钥来为MCP / CLI / Skill工具. 查看创建代理子账户 API —

是Bitget官方提供的,并且可以自由使用?

对 它是由Bitget根据MIT许可证发布的官方开源SDK,可自由使用.

许可证

麻省理工学院 SDK探员

_{官方 Bitget 代理 Hub 工具 ・ 交易堆栈 ・ 基础层 。 建于 SDK 上的表面: 代理- cli ; 代理- mcp ; 代理- 技能}