Bitget交易所RESTAPI文档解析与接口分类介绍

2025-02-08 分析 78℃

Bitget交易所REST API文档解析

一、API基础概述

Bitget交易所为开发者和技术用户提供了一套功能丰富且高度可定制的REST API接口，旨在满足各种自动化交易、市场数据获取、账户管理等需求。通过这套API，用户能够在无需手动干预的情况下实现交易策略的自动化执行，同时获取最新的市场数据，执行账户管理操作，甚至进行实时监控和风险管理。API提供了对市场行情、订单簿、历史交易数据、实时价格、深度图等多种数据的访问方式，极大地提升了交易效率。

Bitget的REST API设计遵循HTTP协议标准，支持所有标准HTTP方法（如GET、POST、PUT、DELETE等），使得与API的交互更为直观和简便。API还兼容OAuth认证机制，为用户提供了更安全、灵活的认证方式，避免了暴露敏感信息的风险。API密钥管理系统允许用户生成多个密钥对，以便根据不同的需求设置访问权限，最大限度地提高了API的安全性和灵活性。

API接口的每个请求都具有明确的访问限制和速率限制，确保交易所服务器的稳定性和高效性。对于高频交易和复杂数据查询的需求，Bitget还提供了优化的性能支持，使得大量请求能够在高并发环境下稳定运行。API文档详细列出了每个接口的功能、请求参数及返回值，帮助开发者快速上手并实现定制化的交易策略和数据分析应用。

1.1 API访问方式

所有API请求均通过HTTPS协议进行，以确保数据在传输过程中的机密性和完整性，防止中间人攻击和数据篡改。HTTPS使用SSL/TLS协议加密通信，保障用户数据免受潜在的网络威胁。为了确保接口的安全性与访问控制，所有API请求都需要附带有效的API密钥。API密钥作为身份验证的一部分，确保只有经过授权的用户或系统可以访问相关资源。每个API密钥都是唯一的，并与特定的用户或应用程序绑定，便于进行权限管理和审计日志记录。

为了避免恶意访问并强化接口的安全性，所有API请求都必须遵循严格的权限设置。权限设置定义了API密钥可以访问的资源范围和操作权限，确保用户只能执行其授权范围内的操作。通过这种方式，可以防止未经授权的访问、数据泄露或其他安全风险。每次调用API时，系统会验证请求的API密钥和权限，确保符合预设的访问规则。

1.2 认证与安全

Bitget交易所的REST API采用严格的API密钥认证方式，旨在保障用户数据的安全性和交易的可靠性。每个API密钥由两部分组成：API Key和API Secret，其中API Key是公开的标识符，用于唯一标识每个API请求；而API Secret则是保密的密钥，用于在请求过程中生成签名。API Secret始终保密，并且不可泄露，因为它直接关系到请求的真实性和安全性。

为了确保请求的合法性和数据传输的完整性，Bitget API使用了基于HMAC-SHA256加密算法的签名机制。通过API Secret和请求的参数，系统生成一个签名，该签名会随每次请求一并发送。接收到请求后，服务器会重新计算签名并与传输过来的签名进行对比，若一致，则证明请求没有被篡改且是合法的。这样可以有效防止重放攻击和中间人攻击，确保API通信过程的机密性与完整性。

除了API密钥的认证机制外，Bitget还为用户提供了完善的安全措施，诸如IP白名单限制、请求频率限制等，进一步提高了API的安全防护能力。IP白名单功能允许用户限制只能从特定的IP地址发起API请求，避免恶意第三方利用盗取的API密钥进行攻击。同时，Bitget的API接口具备频率限制，防止过多的请求导致服务的性能下降或被滥用。

为了提升交易的安全性，Bitget还建议用户在创建API密钥时启用特定的权限控制，例如仅限读取数据、提交订单、资金提取等权限设置，确保API密钥在不同场景下的最小化权限使用。通过细化权限管理，用户能够更好地控制API密钥的使用范围，避免因权限过大而带来的安全隐患。

Bitget的API认证与安全体系结合了多重加密和权限管理机制，通过有效的密钥认证、签名验证以及权限控制，确保API操作过程的安全性、数据传输的完整性以及交易执行的可靠性。

二、接口分类

Bitget交易所的REST API接口根据功能的不同，主要可以分为以下几大类别，每个类别提供了一系列相关的操作和服务，帮助开发者实现对交易所的全面管理与操作：

市场数据接口 ：该接口主要提供与市场行情相关的信息，包括实时市场价格、深度数据、历史K线数据等。通过该接口，用户可以获取不同交易对的实时价格变动、市场深度数据，以及历史价格数据，便于进行技术分析和市场趋势预测。该接口支持多种查询方式，允许按不同时间粒度获取历史K线数据，并提供全市场范围内的数据，确保用户能够获取到全面的市场信息。
账户管理接口 ：此接口用于操作与用户账户相关的功能，主要包括账户信息查询、资产查看、交易历史查看、资金余额查询、提现操作等。通过此接口，用户可以随时查询自己的账户余额、资金变动、订单历史等重要信息，同时支持用户进行提现操作，满足账户管理的需求。账户管理接口也能够提供与账户相关的安全设置，例如绑定邮箱、设置安全密码等。
交易接口 ：该接口涵盖了所有与交易相关的功能，包括下单、撤单、查询订单状态等操作。通过此接口，用户可以根据市场行情下达买入或卖出的订单，支持市价单、限价单等多种下单方式，同时也能实现对已挂单的撤销操作。交易接口还提供查询订单状态的功能，帮助用户实时跟踪订单的执行情况。
资金流动接口 ：此接口用于查看用户的资金流动情况，包括资金流水、转账操作等。用户可以通过此接口查询到每一笔资金的进出记录，帮助监控账户的资金流动，并且能够进行账户之间的转账操作，如主账户与子账户之间的资金划转。资金流动接口确保资金的透明度，同时也为资金管理提供了灵活的操作空间。
API密钥管理 ：该接口允许用户创建、更新、删除API密钥，从而实现对交易所API访问权限的控制。通过密钥管理接口，用户可以生成新的API密钥并指定权限，确保只有经过授权的操作才能访问用户的账户信息。同时，用户还可以随时更新或删除已有的密钥，以应对潜在的安全风险。这一接口提供了高效的权限管理机制，帮助保护用户的交易安全。

2.1 市场数据接口

市场数据接口提供了对Bitget交易所行情信息的全面访问，允许开发者实时获取各类交易对的详细数据。这些接口不仅能帮助开发者实时监控市场动向，还能为策略分析、交易决策等提供重要依据。通过这些接口，用户能够获取包括价格、成交量、买卖深度等在内的市场关键数据，支持多种查询方式，满足不同需求。主要接口包括：

GET /market/tickers ：此接口用于获取Bitget交易所所有交易对的最新行情信息。它返回每个交易对的最新成交价格、24小时交易量、涨跌幅等详细数据，开发者可以使用该接口快速获得市场的整体动态，便于做出反应和分析。返回的数据包括但不限于交易对的当前价格、24小时最高和最低价、24小时成交量、成交额等。
GET /market/orderbook ：该接口提供指定交易对的最新市场深度信息，展示该交易对当前的买卖订单簿。返回的数据包含当前挂单的买单和卖单信息，买单和卖单按照价格从高到低或从低到高排序。通过此接口，开发者能够实时掌握市场的买卖力量分布，分析市场的流动性及潜在的价格波动趋势。
GET /market/candles ：此接口允许用户获取指定交易对的历史K线数据。开发者可以通过指定时间范围、K线类型（如1分钟、5分钟、1小时等）来获取详细的历史价格走势数据。这些数据可用于技术分析、趋势识别和回测策略等应用。K线数据包含每个时间段内的开盘价、收盘价、最高价、最低价和成交量，为分析市场波动性、交易量变化等提供了有力工具。

示例

bash
GET /market/tickers

返回的数据结构为：

{ "status": "success", "data": [ { "symbol": "BTCUSDT", "last": "43000.12", "high24h": "45000.00", "low24h": "42000.00", "volume24h": "1500.0" }, { "symbol": "ETHUSDT", "last": "3200.50", "high24h": "3400.00", "low24h": "3100.00", "volume24h": "8000.0" }, { "symbol": "XRPUSDT", "last": "1.20", "high24h": "1.50", "low24h": "1.10", "volume24h": "200000.0" } ] }

该API的返回数据通常用于展示市场实时行情和各交易对的动态表现，包括当前的价格水平、交易量、价格波动等。用户可以通过该数据快速评估市场趋势并做出交易决策。

2.2 账户管理接口

账户管理接口为用户提供了一整套服务，旨在帮助开发者高效地查询和管理用户账户的各类信息，并执行与资金相关的操作。通过这些接口，开发者可以获取账户余额、查看历史订单、查询资金流动等关键信息，为账户管理提供全方位支持。下面是该模块中主要的几个接口：

GET /account/assets ：该接口用于获取用户账户的总资产情况以及详细的资产分类信息。开发者可以通过此接口查询账户中各类资产（如数字货币、法币等）的具体余额和估值，帮助用户实时了解账户的资金状况。
POST /account/transfer ：此接口提供了执行资金转账的功能，支持在不同账户之间转移资产。无论是从一个子账户向主账户转账，还是进行跨平台的资金划拨，开发者都可以通过此接口实现。同时，此接口可以配置不同的转账参数，例如转账金额、转账币种、目标账户等，确保操作的灵活性和安全性。
GET /account/orders ：该接口用于查询用户的历史订单记录。开发者可以利用此接口获取特定时间范围内的交易订单，包括订单的创建时间、交易数量、成交价格等关键信息。该接口支持分页查询，允许开发者按需加载大量数据，确保查询效率不受订单数量影响。

示例

bash
GET /account/assets

请求示例中的GET请求指向了“/account/assets”这个API接口，该接口用于获取用户账户中的资产信息，包括账户的总资产、可用资产、冻结资产以及资产的币种等详细数据。请求方法为GET，通常用于查询数据。请求的路径“/account/assets”代表了用户资产的概览信息，能够返回相关的财务数据。用户在执行此请求时，无需提交任何额外的请求参数，仅需提供正确的API访问权限。

{
"status": "success",
"data": {
"total": "1000.00",
"available": "500.00",
"frozen": "500.00",
"currency": "USDT"
}
}

返回的JSON格式数据包含多个重要字段：

"status": "success" ：该字段表示API请求的执行状态。如果值为“success”，说明请求成功并且数据已正常返回。
"total": "1000.00" ：这是账户中所有资产的总额，单位为USDT，表示账户当前所有资产的合计金额。
"available": "500.00" ：表示用户当前可用的资产金额，这部分资金是可以进行交易、转账等操作的。
"frozen": "500.00" ：此字段显示账户中被冻结的资产金额，这部分资产通常由于某些限制或交易条件被暂时无法使用。
"currency": "USDT" ：表示账户资产的币种类型。在此示例中，资产类型为USDT（泰达币），是稳定币的一种。

该返回结果能清晰地展示用户账户的资产状态，帮助用户实时掌握其可用资产与冻结资产的情况，从而做出相应的操作决策。在实际应用中，API响应的数据可以用于多个场景，例如资产监控、交易决策等。

2.3 交易接口

交易接口是REST API中最常用的接口之一，专门用于实现与交易相关的各种操作，包括但不限于下单、撤单、查询订单、获取订单状态等功能。这些接口为开发者提供了灵活的自动化交易能力，能够实现实时、高效的市场参与，满足不同交易策略的需求。通过这些接口，用户可以在加密货币市场中实现全自动化的买卖操作、实时监控交易状态，并灵活调整交易策略。交易接口的设计遵循高效、简洁、安全的原则，确保开发者能够快速实现与交易所的无缝对接。常见的交易接口主要包括：

POST /order/place ：此接口用于创建新的限价单或市价单。通过该接口，开发者可以指定交易对、价格、数量等参数，发起新的交易请求。限价单是在指定价格或更好的价格成交，而市价单则以当前市场价格成交。此接口支持多种订单类型和策略，例如止损单、止盈单等，可以满足不同市场环境下的交易需求。
POST /order/cancel ：该接口用于撤销某个已经创建的订单。开发者可以通过订单ID来指定需要撤销的订单，无论订单是否已经部分成交，都可以通过此接口完全取消。此接口对实时撤单需求非常关键，尤其是在高频交易策略中，用户可能需要迅速撤销不再符合策略的订单。
GET /order/detail ：该接口用于查询指定订单的详细信息。开发者可以通过订单ID或其他参数查询订单的当前状态，包括但不限于订单的成交量、剩余量、成交价格、订单创建时间等信息。此接口可以帮助用户实时监控订单的执行情况，并作出相应调整。

示例

bash
POST /order/place
{
"symbol": "BTCUSDT",
"price": "43000.00",
"quantity": "0.1",
"side": "buy",
"type": "limit"
}

该请求用于在交易所提交一个限价单，指定买入BTC/USDT交易对，购买0.1个比特币，价格为43000.00美元。请求方法为POST，通过/order/place接口发送。此时，"symbol"参数表示交易对（在此为BTCUSDT），"price"是买入的限价，"quantity"是交易的数量，"side"字段说明这是一个买入订单，"type"字段指定订单类型为限价单。

{
"status": "success",
"data": {
"orderId": "123456789",
"symbol": "BTCUSDT",
"price": "43000.00",
"quantity": "0.1",
"side": "buy",
"status": "new"
}
}

返回的响应中，"status"字段为"success"，表示订单成功创建。"data"字段包含订单的详细信息。"orderId"字段为订单的唯一标识符，可用于查询、取消或修改订单。"symbol"再次确认了交易对，"price"和"quantity"则再次确认了订单的价格和数量。"side"确认这是一个买单。"status"字段显示订单当前状态，"new"表示订单刚刚被创建，尚未成交。

2.4 资金流动接口

资金流动接口是用于查询和管理账户内资金转入转出的关键工具，能够帮助开发者实时监控和记录账户的资金流动情况。这些接口提供了多种操作功能，确保开发者可以高效地进行资金的查询、管理和操作。通过调用相关接口，开发者不仅可以掌握资金的变动，还可以对账户中的充值、提现等操作进行详细追踪。这些接口对于交易平台、钱包应用、金融服务等场景尤为重要，它们帮助系统保持透明度，并确保资金流动的合规性和安全性。主要的资金流动接口包括：

GET /funding/records ：该接口用于查询账户的资金记录，涵盖充值、提现、转账等所有资金操作的详细信息。通过调用此接口，开发者可以获取与账户相关的所有资金流动记录，包括交易时间、交易金额、资金来源和去向等关键信息。此接口支持多种查询条件，以便开发者筛选特定的资金记录，例如按照日期、操作类型、资金状态等进行过滤。
POST /funding/withdraw ：该接口用于执行账户资金的提现操作。通过此接口，开发者可以向指定的提现地址发起资金提取请求。提现操作可以是针对用户的个人账户，也可以是针对平台的流动资金池。在调用该接口时，开发者需要提供提现金额、目标地址等相关信息，系统会验证操作的合法性及账户的可用余额。如果验证通过，资金将按照指定方式转出，接口会返回操作的结果，包括提现状态、处理时间等信息。

示例

bash
GET /funding/records

{ "status": "success", "data": [ { "transactionId": "987654321", "amount": "100.00", "type": "deposit", "status": "completed", "currency": "USD", "timestamp": "2025-02-08T14:30:00Z", "accountId": "1234567890", "paymentMethod": "credit_card", "transactionFee": "2.00", "reference": "TXN-123456789" }, { "transactionId": "123456789", "amount": "250.00", "type": "withdrawal", "status": "pending", "currency": "USD", "timestamp": "2025-02-08T15:00:00Z", "accountId": "0987654321", "paymentMethod": "bank_transfer", "transactionFee": "5.00", "reference": "TXN-987654321" } ] }

2.5 API密钥管理接口

API密钥管理接口是系统中至关重要的一部分，它负责API密钥的生成、修改和删除操作。开发者利用这些接口能够为不同的应用程序、服务或权限创建专属的API密钥，从而实现细粒度的权限管理。通过API密钥，开发者可以控制访问权限、监控API使用情况，并确保仅授权用户可以访问系统资源。以下是主要的API密钥管理接口及其功能：

POST /api/key/create ：该接口用于生成新的API密钥。开发者可以根据具体的需求为不同的应用或用户分配不同的权限，确保每个密钥的使用场景与权限控制相匹配。在密钥创建时，开发者可指定密钥的有效期、权限范围及其使用的具体资源，进而确保系统的安全性。
DELETE /api/key/delete ：此接口用于删除已存在的API密钥。当API密钥不再需要或需要更换时，开发者可以使用该接口进行安全删除。删除密钥后，相关的应用程序和服务将无法再使用该密钥进行身份验证和访问操作，确保不再泄露或滥用过期的密钥。
GET /api/key/list ：该接口用于列出系统中所有有效的API密钥。通过这个接口，开发者可以查看当前所有已创建的API密钥的详细信息，包括密钥ID、创建时间、权限类型、使用情况等。它可以帮助开发者对密钥进行有效管理，及时更新、禁用或删除不再需要的密钥。

示例

bash POST /api/key/create { "permissions": ["trade", "read"] }

请求说明：

该请求是用于创建新的API密钥，授权用户对特定操作进行访问。通过POST方法向/api/key/create端点发送包含必要权限的JSON格式数据，其中"permissions"字段用于指定允许的操作权限。在此示例中，"trade"表示允许进行交易操作，"read"表示允许读取相关信息。

返回说明：

返回结果以JSON格式呈现，包含请求的处理结果和生成的API密钥及其对应的API密钥密文。具体字段如下：

status ：表示请求处理的状态，成功时返回"success"。
data ：包含返回的具体数据，数据中包括：
- apiKey ：生成的API密钥，用户在进行API调用时需要携带此密钥以进行身份验证。
- apiSecret ：与API密钥配对的密钥，通常用于加密签名验证，请务必保密。

示例返回内容：

{ "status": "success", "data": { "apiKey": "abcdef123456", "apiSecret": "ghijkl789012" } }

此响应表示API密钥成功创建，用户可以使用返回的 apiKey 和 apiSecret 来进行后续的API调用。

三、错误码说明

Bitget交易所的REST API接口返回的错误信息包含错误码和错误描述，旨在帮助开发者定位问题并进行有效的错误处理。每个错误码代表特定类型的错误，通过错误码和错误描述，开发者可以快速识别和修复API调用中的问题。以下是一些常见的错误码及其详细说明：

10001 ：API密钥无效。该错误通常发生在使用无效的API密钥进行请求时。可能原因包括密钥输入错误、密钥已过期或被禁用。开发者需要确保API密钥是正确的，并且密钥在有效期内。
10002 ：签名错误。此错误表示请求中的签名验证失败，可能是因为请求的签名与API服务器计算的签名不匹配。常见原因包括签名算法错误、参数顺序不正确或密钥不匹配。开发者应检查签名生成过程，确保请求数据和密钥的正确性。
10003 ：请求超时。该错误表示API请求未能在规定的时间内完成，通常是由于网络延迟、请求量过大或服务器响应缓慢导致的。开发者可以尝试增加超时时间，或优化请求频率，避免过多的请求导致超时。
10004 ：请求参数缺失。此错误发生在API请求缺少必要的参数时。常见情况包括忘记填写某些必需的字段或格式不符合要求。开发者在进行API调用时应仔细检查请求参数，确保所有必需参数均已提供，并且格式正确。
10005 ：权限不足，无法执行该操作。此错误意味着API密钥所绑定的账户没有足够的权限进行该操作。可能是因为账户权限设置不正确，或账户没有访问某些资源的权限。开发者应确保API密钥具有执行该操作所需的权限。

开发者在调用API时，应根据返回的错误码进行相应的错误处理。对于常见的错误，开发者可以通过查看错误描述快速定位问题并加以解决。对于较为复杂的错误，建议参考Bitget官方文档或联系客服支持进行进一步排查。

四、速率限制

为了确保交易所的服务质量和系统稳定性，Bitget在其API接口中实施了严格的速率限制措施。这一措施旨在防止由于频繁请求而导致服务器过载，从而影响到平台的整体性能。每个API密钥都具有请求频率限制，意味着在一定时间段内，每个密钥能够发起的请求次数是有限的。通常情况下，Bitget对API的请求限制设置为每分钟最多允许60次请求。超过该请求限制时，系统会返回HTTP状态码429，表示“请求过于频繁”，此时API请求将无法处理，直到进入下一个时间窗口。

速率限制不仅有助于避免服务器资源的过度消耗，还能防止恶意攻击者通过高频率请求对平台造成影响。为了更好地管理API的访问频率，Bitget建议开发者和用户合理安排API调用的时间间隔，避免因超出限制而导致的服务中断或调用失败。Bitget提供了详细的文档，帮助开发者了解如何合理设计API调用逻辑，以确保稳定、安全地与平台进行交互。

速率限制可能会根据具体的API类型和用户账户的不同而有所调整。例如，对于一些高权限用户或专门的API接口，可能会有更高的请求频率限制。因此，了解具体的API限额以及根据需求调整调用策略，能够有效提高与交易所交互的效率。