Bigone API 怎么用？2024年最新数字货币交易API接口指南

时间：2025-03-05 11:58:06 目录：资讯阅读：88

BigoneAPI 数据解析与应用

Bigone 作为一家数字资产交易平台，其 API 提供了丰富的数据接口，允许开发者访问实时市场数据、历史交易数据、账户信息等。通过深入理解和有效利用这些 API 数据，可以构建各种自动化交易策略、数据分析工具以及风险管理系统。

API 概览

Bigone API 遵循 RESTful 设计原则，通过 HTTP 协议进行通信，数据交换格式为 JSON。这种架构风格使得API易于理解和使用，并具有良好的可扩展性。主要功能模块可以归纳为以下几类：

行情数据 (Market Data): 提供全面的实时市场行情信息，包括但不限于：最新成交价格（Last Price）、最高价格（High Price）、最低价格（Low Price）、成交量（Volume）、24小时成交量、24小时价格变动百分比、买一价/卖一价及对应数量（Bid/Ask Price and Size）、深度数据（Order Book）等。这些数据对于了解市场动态、制定交易策略至关重要。
历史数据 (Historical Data): 提供详细的历史市场数据，例如：K线数据（包括不同时间周期，如1分钟、5分钟、1小时、1天等）、历史交易记录（Trade History），允许用户进行深入的技术分析、量化回测和趋势预测。K线数据通常包括开盘价（Open）、收盘价（Close）、最高价（High）、最低价（Low）以及成交量（Volume）。
账户数据 (Account Data): 提供用户账户相关的各种信息，包括：账户资产信息（例如不同币种的余额、可用余额、冻结余额）、交易历史记录（包括成交价格、成交数量、交易时间等）、委托订单信息（包括未成交订单、已成交订单、已撤销订单，以及订单的价格、数量、状态等），方便用户进行账户管理、风险控制以及盈亏分析。为了保证账户安全，此类API通常需要进行身份验证。
交易接口 (Trading API): 提供一系列用于执行交易操作的接口，包括：创建订单（下单，可以指定价格、数量、交易方向等）、撤销订单（取消未成交的订单）、查询订单状态（查询订单的当前状态，例如是否已成交、部分成交、已撤销等）、批量下单/撤单等。这些接口允许用户自动化交易策略，实现程序化交易。

针对每个 API 接口，Bigone 提供详尽的文档说明，详细描述了请求方式（包括 GET, POST, PUT, DELETE 等 HTTP 方法）、请求参数（包括参数名称、参数类型、是否必选、参数说明等）、返回数据格式（JSON 格式，包括每个字段的名称、类型、含义等），以及错误码说明，方便开发者快速上手和调试。

行情数据 API

行情数据是加密货币交易决策的基石。准确、及时的行情信息对于制定交易策略、风险管理以及把握市场机会至关重要。Bigone API 提供了一套全面的接口，旨在满足不同层次用户的行情数据需求。

获取单个币对行情： Bigone API 允许用户精确查询特定交易对的详细行情数据。通过该功能，您可以获取指定币对的关键指标，例如最新的成交价格（ last ）、24 小时内的最高价（ high ）和最低价（ low ）、买一价（ bid ）和卖一价（ ask ），以及 24 小时成交量（ volume ）等。这些数据对于评估市场趋势和短期波动至关重要。例如，获取 BTC/USDT 的行情：
GET /markets/BTC-USDT

返回的 JSON 数据将包含以下字段，方便您进行数据分析： bid (当前最佳买入价), ask (当前最佳卖出价), last (最新成交价格), high (过去 24 小时内的最高成交价), low (过去 24 小时内的最低成交价), volume (过去 24 小时内的成交量)。还可能包含时间戳等辅助信息，帮助您追踪历史数据。
获取所有币对行情： 为了方便用户全面了解市场概况，Bigone API 提供了获取所有已上线交易对行情数据的功能。该接口返回所有币对的行情数据，并且可以根据用户的需求进行排序，例如按照交易量从高到低、涨跌幅从大到小等。这使得用户能够快速识别热门币种和潜在投资机会。
GET /markets

返回的数据结构是一个 JSON 数组，其中每个元素代表一个交易对的行情信息。数组中的每个元素都将包含该币对的 bid , ask , last , high , low , volume 等关键字段。通过分析此数据，用户可以了解整个市场的活跃程度和趋势。
实时行情订阅： 对于需要极速响应的市场参与者，Bigone API 提供了基于 WebSocket 协议的实时行情订阅功能。通过建立 WebSocket 连接，用户可以实时接收指定交易对的行情推送，而无需频繁轮询 API 接口。这种方式大幅降低了延迟，并提高了数据获取效率，对于高频交易策略和实时风险监控至关重要。
WSS /markets/{market_id}/depth

通过订阅特定币对的深度数据，用户可以获得订单簿的实时变化信息。订单簿是市场供需关系的直接体现，包含买单和卖单的价格和数量。实时订单簿数据对于分析市场深度、预测价格走势和执行精确交易至关重要。通过解析 WebSocket 推送的数据，用户可以构建自己的实时行情分析系统和交易机器人。

历史数据 API

历史数据是加密货币技术分析、算法交易策略回测以及构建预测模型的重要数据来源。精确的历史数据能够帮助交易者和研究者洞察市场趋势，评估交易策略的有效性，并进行风险管理。Bigone API 提供了以下历史数据接口，方便用户获取和利用这些关键信息：

K 线数据: K 线图是展示一段时间内价格变动的常用工具。Bigone API 允许用户获取指定交易对（例如 BTC/USDT）、指定时间周期的 K 线数据，从而进行多时间尺度的分析。支持的时间周期包括 1 分钟、5 分钟、15 分钟、30 分钟、1 小时、4 小时、1 天、1 周、1 月等。更细粒度的数据支持高频交易策略的回测，而更长周期的数据则适用于长期趋势分析。
GET /markets/{market_id}/kline?period={period}&timestamp={timestamp}&limit={limit}

market_id 指定交易对，例如 "BTC-USDT"。 period 指定时间周期，单位为秒，例如 60 (1 分钟), 300 (5 分钟), 900 (15 分钟), 1800 (30 分钟), 3600 (1 小时), 14400 (4 小时), 86400 (1 天), 604800 (1 周), 2592000 (1 月)。 timestamp 指定起始时间戳（Unix 时间戳，毫秒级别）。 limit 指定返回的数据条数，默认为 100 条，最大可设置为 1000 条。返回数据会包含 open (开盘价), close (收盘价), high (最高价), low (最低价), volume (成交量), quote_volume (计价货币成交量), time (K线起始时间戳) 等关键字段。 quote_volume 可以更准确地反映市场的交易活跃度。
交易记录: 交易记录包含了每一笔成交的具体信息，是分析市场微观结构的重要数据来源。通过分析历史交易记录，用户可以了解市场的深度、流动性，以及买卖双方的交易行为。
GET /markets/{market_id}/trades?limit={limit}&before={trade_id}&after={trade_id}

market_id 指定交易对，例如 "ETH-USDT"。 limit 指定返回的交易记录条数，默认为 100 条，最大可设置为 1000 条。 before 指定返回的交易记录ID在该ID之前（不包含该ID）。 after 指定返回的交易记录ID在该ID之后（不包含该ID）。这些参数允许用户进行分页查询，获取大量的历史交易数据。返回数据会包含 price (成交价), amount (成交量), timestamp (成交时间戳，毫秒级别), side (买入/卖出，值为 "buy" 或 "sell"), trade_id (交易ID) 等关键字段。通过分析 side 和 amount ，可以观察买卖盘的分布情况，判断市场情绪。

账户数据 API

账户数据对于账户管理和风险控制至关重要。 Bigone API 提供了一系列账户数据接口，允许用户查询和管理其账户信息，以便进行更有效的交易决策和风险评估。

获取账户资产: 允许用户检索其 Bigone 账户中所有币种的余额信息。这对于了解资产配置和监控投资组合表现至关重要。
GET /accounts

返回数据包含详细的币种余额信息，具体字段包括： currency (币种代码，例如 BTC, ETH, USDT), balance (可用余额，即可用于交易的金额), locked (冻结余额，通常是由于未完成的订单或其他原因而被锁定的金额), available (等同于balance), updated_at (余额更新时间戳)。此接口需要使用 API Key 进行签名认证，确保只有授权用户才能访问其账户信息。请求时需要注意速率限制，避免频繁请求导致 API 被限制。
获取交易记录: 允许用户查询其历史交易记录，包括所有已成交的订单信息。这对于审计交易历史、计算盈亏以及生成税务报告至关重要。
GET /orders

返回数据包含详细的交易信息，字段包括： market_id (交易对，例如 BTC-USDT), price (成交价格，即实际成交时的单价), amount (成交数量，即成交的币种数量), timestamp (成交时间戳，精确到毫秒级), side (交易方向，买入 "buy" 或卖出 "sell"), fee (手续费，以币种和数量表示), order_id (订单ID), type (订单类型，例如 "limit" 限价单或 "market" 市价单), filled (已成交数量), fee_currency (手续费币种)。此接口需要 API Key 签名认证，并且通常支持分页查询和时间范围过滤，以便用户更方便地查找特定的交易记录。注意参数的正确使用，例如时间范围格式。
获取委托订单: 允许用户查询其当前未成交的委托订单，即挂单信息。这对于监控订单状态、取消未执行的订单以及调整交易策略至关重要。
GET /orders/{id}

返回数据包含详细的订单信息，字段包括： market_id (交易对), price (委托价格，即用户设定的挂单价格), amount (委托数量，即用户希望交易的币种数量), timestamp (委托时间戳，即订单创建的时间), side (交易方向，"buy" 或 "sell"), status (订单状态，例如 "open" 待成交, "partially_filled" 部分成交, "filled" 完全成交, "cancelled" 已取消), type (订单类型，例如 "limit" 或 "market"), filled (已成交数量), remaining (剩余未成交数量), fee (手续费), fee_currency (手续费币种), post_only (是否为只挂单模式)。此接口需要 API Key 签名认证，并通过订单 ID {id} 来查询特定订单的详细信息。用户可以通过订单状态来判断订单是否需要调整或取消。除了通过ID查询单个订单外，还可以通过 GET /orders 不带ID的方式来获取所有未完成的委托订单列表，并支持通过 market_id 参数进行过滤。

交易接口 API

交易接口用于自动化交易策略的执行。 Bigone API 提供了一系列交易接口，允许用户通过程序化方式进行数字资产交易，从而实现自动化交易和量化投资。

下单: 可以在指定币对下达买入或卖出订单，实现交易指令的自动化执行。
POST /orders

需要提供包括 market_id (交易对，例如 BTC/USDT), side (交易方向，买入 BUY 或卖出 SELL ), price (委托价格，即期望成交的价格), amount (委托数量，即买入或卖出的数字资产数量) 等关键参数。所有订单请求都需要通过 API Key 进行签名认证，以确保交易的安全性。
撤单: 可以撤销尚未成交的指定委托订单，以便根据市场变化调整交易策略。
DELETE /orders/{id}

id 是要撤销的委托订单的唯一标识符。同样，撤单请求也需要进行 API Key 签名认证，保障账户安全。
查询订单状态: 可以查询指定订单的当前状态，例如订单是否已成交、部分成交或被取消。
GET /orders/{id}

通过提供订单 ID，可以获取订单的详细信息，包括订单类型、订单价格、订单数量、成交数量以及订单的当前状态。此接口同样需要 API Key 签名认证。

API Key 签名认证

为确保用户账户和交易安全，Bigone API 强制实施 API Key 签名认证机制。用户需在 Bigone 平台生成 API Key，该 Key 由 api_key (公钥) 和 secret_key (私钥) 两部分组成。所有需要授权的 API 请求，都必须在 HTTP 请求头中包含有效的签名信息，否则将被服务器拒绝。

Bigone API 签名算法推荐使用 HMAC-SHA256。以下是详细的签名步骤：

参数排序： 将所有请求参数，包括查询参数和 POST 请求体中的参数，按照其键名（key）的字母升序进行排序。如果参数值是数组或对象，需要先将其序列化为字符串后再参与排序。
字符串拼接： 将排序后的参数按照 key=value 的格式拼接成一个字符串。如果参数有多个值，按照 key=value1&key=value2 格式拼接。参数与参数之间使用 & 符号连接。确保URL编码正确处理，避免特殊字符影响签名结果。
HMAC-SHA256 加密： 使用用户的 secret_key 作为密钥，对上一步拼接好的字符串进行 HMAC-SHA256 哈希运算。这是一个单向加密过程，无法从加密后的结果反推出原始字符串或密钥。
Base64 编码： 将 HMAC-SHA256 加密后的二进制结果进行 Base64 编码。 Base64 是一种将二进制数据转换为 ASCII 字符串的编码方式，以便在 HTTP 头部中传输。
请求头添加： 将用户的 api_key 和经过 Base64 编码后的签名信息添加到 HTTP 请求头中。通常使用 X-API-KEY 和 X-API-SIGNATURE 两个自定义头部字段。例如： X-API-KEY: your_api_key 和 X-API-SIGNATURE: your_base64_encoded_signature 。确保请求头的大小不超过服务器允许的最大值。