BitMEX API 掘金指南：Python交易实战，抓住合约机遇！

BitMEX 平台的 API 接口如何调用使用

1. 概述

BitMEX 是一家领先的加密货币衍生品交易所，以其高杠杆合约交易而闻名。它为交易者提供比特币（BTC）、以太坊（ETH）等多种加密货币的永续合约、期货合约和期权合约。其强大的 API 接口是 BitMEX 平台的核心组件，允许开发者和机构投资者通过编程方式高效地与平台交互，实现自动化交易、市场数据分析和风险管理。

BitMEX API 接口提供全面的功能，涵盖市场数据、账户管理、下单执行等。通过 API，开发者可以实时获取市场深度信息、历史交易数据、指数数据等，并构建自定义的交易策略。同时，API 还允许用户创建、修改和取消订单，查询账户余额和仓位信息，以及监控交易历史和风险指标。这使得 API 成为程序化交易和量化交易的关键工具。

本文将深入探讨如何调用和有效利用 BitMEX 平台的 API 接口。我们将详细介绍 API 的认证机制、不同端点的功能和使用方法，并提供 Python 等编程语言的示例代码，演示如何获取市场数据、执行交易和管理账户。理解并掌握 BitMEX API 的使用，能够帮助开发者充分利用 BitMEX 平台的功能，提高交易效率和投资回报。

2. API 密钥与权限

在使用 BitMEX API 之前，必须生成 API 密钥。 登录您的 BitMEX 账户，导航至 API 密钥管理页面，该页面通常位于账户设置或个人资料设置区域。 在此页面，您可以创建一个新的 API 密钥。 在创建密钥时，设置适当的权限至关重要，精确控制密钥的功能。 您可以选择仅允许读取数据，例如访问实时 Orderbook 数据或历史交易数据，或者赋予密钥进行交易的权限，以便自动执行交易策略。 仔细选择与您的使用场景匹配的权限集，降低潜在风险。 请务必以最高级别的安全措施保管您的 API 密钥和 API Secret，切勿将其泄露给任何第三方。 为进一步增强安全性，建议定期更换 API 密钥，从而限制任何潜在的损害，即使密钥曾经被泄露。

BitMEX 提供两种关键的 API 密钥组成部分：

• API Key： 此密钥作为您的身份标识，用于对您的 API 请求进行身份验证和授权。它需要与生成的签名一起传递给 API，以验证请求的来源和有效性。
• API Secret： 此密钥至关重要，用于生成数字签名，对 API 请求进行签名。这些签名确保请求的完整性，防止篡改，并验证请求确实来自授权用户。API Secret 必须严格保密，任何泄露都可能导致未经授权的账户访问。

3. API 端点

BitMEX API 提供了丰富的端点，允许开发者访问其平台上的各种功能。这些端点通过 HTTP 请求进行交互，并以 JSON 格式返回数据。合理利用这些端点，可以构建自动化交易机器人、数据分析工具和账户管理系统。

• /api/v1/order: 此端点是订单管理的核心。通过它，可以实现创建新的订单（包括市价单、限价单、止损单等）、修改现有订单的参数（如价格、数量），以及取消未成交的订单。该端点支持多种订单类型和参数设置，以满足不同的交易策略需求。
• /api/v1/position: 该端点用于检索当前账户的仓位信息。返回的数据包括持仓数量、平均入场价格、未实现盈亏、杠杆倍数等关键指标。通过监控仓位信息，可以实时掌握风险敞口，并根据市场变化及时调整交易策略。
• /api/v1/instrument: 用于获取特定交易对（也称为 instrument）的详细信息。这些信息包括合约类型（如永续合约、期货合约）、最小交易单位、保证金要求、结算时间等。该端点返回的数据对于理解合约规则和制定交易计划至关重要。
• /api/v1/user/wallet: 此端点提供账户钱包余额的查询功能。返回的数据包括可用余额、已用保证金、已实现盈亏等信息。开发者可以使用该端点监控账户资金状况，确保有足够的资金进行交易。
• /api/v1/trade: 该端点允许开发者获取历史交易数据。可以指定交易对、时间范围等参数来筛选数据。返回的数据包括交易价格、数量、成交时间等。历史交易数据可以用于回测交易策略、分析市场趋势和评估交易表现。
• /api/v1/schema: 此端点提供 API 数据结构的详细描述。它返回一个 JSON Schema，描述了每个端点的请求和响应的数据格式、字段类型和约束。通过使用 Schema，开发者可以更好地理解 API 的数据结构，并减少开发过程中的错误。

为了充分利用 BitMEX API 的强大功能，建议查阅 BitMEX 官方 API 文档，获取完整的端点列表、详细的参数说明、示例代码和速率限制信息。 官方文档是使用 API 的权威指南，能帮助开发者避免常见的错误并优化 API 使用效率。

4. API 调用方法

BitMEX API 提供了两种主要的调用方式，以满足不同应用场景的需求：REST API 和 WebSocket API。选择哪种方式取决于您的应用程序对数据实时性和交易速度的要求。

REST API: 这种调用方式基于 HTTP 协议，采用请求-响应模式。您可以通过发送 HTTP 请求（例如 GET, POST, PUT, DELETE）到指定的 API 端点来获取数据或执行交易。REST API 的优势在于其易用性和广泛的兼容性，几乎所有编程语言和平台都支持 HTTP 请求。它适用于对实时性要求不高，但需要频繁获取历史数据或执行批量操作的场景。例如，您可以利用 REST API 来获取账户余额、历史交易记录、订单簿快照，或者提交限价单、市价单。

WebSocket API: 这种调用方式建立一个持久的连接，允许服务器主动推送数据到客户端。与 REST API 相比，WebSocket API 提供了更低的延迟和更高的实时性。它适用于对数据更新有严格要求的场景，例如实时监控市场行情、高频交易或自动交易机器人。通过 WebSocket API，您可以订阅不同的数据流，例如实时交易数据、订单簿更新、账户活动。一旦服务器端有新的数据产生，它会立即推送给客户端，从而避免了频繁轮询 REST API 带来的延迟和资源消耗。

4.1 REST API

REST API (Representational State Transfer Application Programming Interface) 是一种架构风格，它使用 HTTP 协议进行客户端和服务器之间的通信。在加密货币领域，REST API 被广泛用于访问交易所、钱包、区块链浏览器等服务，以获取市场数据、管理交易、查询账户余额以及执行其他与数字资产相关的操作。 您可以使用各种编程语言中提供的 HTTP 客户端库，例如 Python 的 requests 库、JavaScript 的 fetch API 或 Node.js 的 axios 库，来构造和发送 HTTP 请求到 REST API 端点。这些库简化了处理 HTTP 响应（例如 JSON 或 XML 格式的数据）以及管理认证和授权头信息的过程。 不同的 REST API 可能会有不同的请求方法（如 GET、POST、PUT、DELETE），以及不同的 URL 端点和参数。因此，在使用特定的 REST API 之前，仔细阅读其官方文档至关重要，以便了解如何正确地构造请求以及如何解释返回的数据。

请求头部 (Headers):

在使用 REST API 进行通信时，准确地构建 HTTP 请求头部至关重要。以下是在请求头部中需要包含的关键信息，它们确保了服务器能够正确地理解和处理您的请求，并验证请求的合法性：

• Content-Type: application/ : 此头部字段明确地告诉服务器，请求体（request body）中包含的数据是采用 JSON (JavaScript Object Notation) 格式编码的。JSON 是一种轻量级的数据交换格式，易于人阅读和编写，同时也易于机器解析和生成。服务器会根据此头部来解析请求体中的数据，因此务必确保请求体的内容确实是有效的 JSON 格式。常见的错误包括格式不正确的 JSON，例如缺少引号、逗号使用错误等。
• api-key: YOUR_API_KEY : api-key 头部用于标识您的身份。每个开发者或应用程序都会被分配一个唯一的 API 密钥。这个密钥就像一个用户名，允许 API 服务器识别谁在发起请求。请务必将 YOUR_API_KEY 替换为您实际的 API 密钥。API 密钥的安全性至关重要，请不要将其泄露给他人或存储在不安全的地方，例如客户端代码或公共版本控制系统中。最佳实践是将 API 密钥存储在服务器端环境变量中，并通过安全的方式传递给您的应用程序。
• api-signature: YOUR_API_SIGNATURE : api-signature 头部提供了一种安全机制，用于验证请求的完整性和真实性。签名是通过使用您的 API Secret 和请求的其他部分（例如请求体、时间戳等）进行加密计算生成的。服务器会使用相同的算法和您的 API Secret 来重新计算签名，并将其与您在 api-signature 头部中提供的签名进行比较。如果两个签名匹配，则服务器可以确信请求没有被篡改，并且确实是由您发起的。 YOUR_API_SIGNATURE 需要替换为您根据 API 文档提供的签名算法生成的实际签名。请注意，签名算法的细节可能因 API 而异，务必仔细阅读 API 文档并遵循正确的签名生成步骤。
• api-expires: YOUR_EXPIRY : api-expires 头部指定了签名（以及整个请求）的有效期限。它包含一个 Unix 时间戳，表示签名过期的绝对时间（以秒为单位）。Unix 时间戳是从 1970 年 1 月 1 日 UTC 时间起经过的秒数。服务器会检查当前时间是否超过 api-expires 中指定的时间戳。如果请求已过期，服务器将拒绝该请求，以防止重放攻击和其他安全威胁。设置合理的过期时间非常重要。过短的过期时间可能会导致请求频繁失效，而过长的过期时间可能会增加安全风险。 YOUR_EXPIRY 需要替换为一个实际的 Unix 时间戳，该时间戳应根据您的安全策略和 API 文档的建议进行设置。

生成 API 签名:

为了确保 API 请求的安全性与完整性，防止恶意篡改和未经授权的访问，生成有效的 API 签名至关重要。您需要利用您的 API Secret，结合请求的特定信息，按照既定的流程生成唯一的签名。

1. 构建签名字符串： 将构成请求的关键要素组合成一个统一的字符串，该字符串是生成签名的基础。这包括：
   • 请求方法 (HTTP Method): 明确指定所使用的 HTTP 方法，如 GET , POST , PUT , 或 DELETE 。不同的请求方法代表不同的操作，必须准确反映。
   • 请求路径 (API Endpoint): 完整且准确的 API 路径，例如 /api/v1/order , /api/v2/user/profile 。务必包含所有必要的路径段和查询参数（如果参数也参与签名，则需要按约定的顺序排列和编码）。
   • 请求体 (Request Body, 如果存在): 如果请求包含请求体 (通常用于 POST , PUT 等方法)，需要将其内容包含在签名字符串中。 请求体的内容应按照标准的序列化格式（例如 JSON）进行字符串化，并确保编码一致（通常是 UTF-8）。 空的请求体也要考虑是否需要参与签名计算，具体取决于API的设计。
   请注意，字符串拼接的顺序必须与 API 文档中定义的顺序严格一致。 任何顺序上的偏差都会导致签名验证失败。
2. HMAC-SHA256 加密： 使用 HMAC-SHA256 (Hash-based Message Authentication Code with SHA-256) 算法对上一步构建的签名字符串进行加密。 HMAC-SHA256 是一种消息认证码算法，它使用共享密钥（即您的 API Secret）来验证消息的完整性和来源。
   • API Secret 作为密钥： 您的 API Secret 必须妥善保管，切勿泄露。 它用于对签名字符串进行加密，任何拥有您 API Secret 的人都可以伪造请求。
   • 确保编码一致性： 在进行 HMAC-SHA256 加密之前，请确保签名字符串和 API Secret 都使用相同的字符编码 (通常是 UTF-8)。 编码不一致会导致签名错误。
3. 转换为十六进制字符串： HMAC-SHA256 算法的输出是二进制数据。 为了方便在 HTTP 头部或请求参数中传递签名，需要将二进制数据转换为十六进制字符串。 每个字节的二进制数据都会被转换成两个十六进制字符。 例如，二进制值 0xAB 会被转换为字符串 "AB" 。
   • 大小写一致性： 某些 API 系统可能对十六进制字符串的大小写敏感。 务必按照 API 文档中的要求，统一使用大写或小写字母。
   • 前导零： 确保所有的十六进制字符都已正确转换，并保留任何必要的前导零。
   最终生成的十六进制字符串就是您的 API 签名。 将此签名包含在您的 API 请求中（通常在 HTTP 头部或查询参数中），以便服务器可以验证请求的真实性。

示例代码 (Python):

以下代码演示了如何使用 Python 与 BitMEX API 进行交互，包括生成签名、获取深度订单簿和下单等操作。 在使用前，请确保已安装 requests 、 hashlib 、 hmac 和 time 等必要的 Python 库。 如果尚未安装，可以使用 pip install requests 进行安装。

import requests import hashlib import hmac import time import # 引入 库处理 JSON 数据

api_key = "YOUR_API_KEY" # 替换为你的 API 密钥 api_secret = "YOUR_API_SECRET" # 替换为你的 API 密钥 base_url = "https://www.bitmex.com/api/v1" # 或使用测试网 https://testnet.bitmex.com/api/v1。 建议在测试环境进行实验。

def generate_signature(api_secret, method, path, data, expires): """为 BitMEX API 请求生成签名。签名算法使用 HMAC-SHA256，确保请求的安全性。""" message = method + path + str(expires) + data # 拼接用于生成签名的消息 signature = hmac.new(api_secret.encode('utf-8'), message.encode('utf-8'), digestmod=hashlib.sha256).hexdigest() # 使用 HMAC-SHA256 算法生成签名 return signature

def get_order_book(symbol, depth=25): """获取指定交易对的深度订单簿。深度参数控制返回的订单数量，默认为 25。 订单簿信息对于了解市场深度和流动性至关重要。""" endpoint = "/orderBook/L2" # 订单簿 API 接口 url = f"{base_url}{endpoint}?symbol={symbol}&depth={depth}" # 构造完整的 API 请求 URL response = requests.get(url) # 发送 GET 请求 response.raise_for_status() # 检查请求是否成功，如果状态码不是 200，则抛出异常 return response.() # 将响应内容解析为 JSON 格式

def place_order(symbol, side, orderQty, price): """以限价单方式下单。参数包括交易对、买卖方向、数量和价格。 限价单允许交易者指定希望交易的价格。""" endpoint = "/order" # 下单 API 接口 method = "POST" # 使用 POST 方法提交订单 path = endpoint # API 路径 expires = int(time.time()) + 60 # 设置过期时间，单位为秒。 过期时间用于防止重放攻击 data = .dumps({ # 构造 JSON 格式的请求数据 "symbol": symbol, # 交易对 "side": side, # 买卖方向，可选值为 "Buy" 或 "Sell" "orderQty": orderQty, # 订单数量 "price": price, # 订单价格 "ordType": "Limit" # 订单类型，这里设置为限价单 })

signature = generate_signature(api_secret, method, path, data, expires) # 生成 API 签名

headers = { # 构造 HTTP 头部
    "Content-Type": "application/", # 指定内容类型为 JSON
    "api-key": api_key, # API 密钥
    "api-signature": signature, # API 签名
    "api-expires": str(expires) # 过期时间
}

url = f"{base_url}{endpoint}" # 构造完整的 API 请求 URL
response = requests.post(url, headers=headers, data=data) # 发送 POST 请求
response.raise_for_status() # 检查请求是否成功
return response.() # 将响应内容解析为 JSON 格式

示例调用

orderbook = getorder_book("XBTUSD")

print(order_book)

下单示例

orderresponse = placeorder("XBTUSD", "Buy", 100, 9000)

print(order_response)

注意事项:

• 请务必将代码中的占位符 YOUR_API_KEY 和 YOUR_API_SECRET 替换成您通过交易所或服务提供商获得的真实API密钥。API密钥包含公钥（Key）和私钥（Secret），它们是您访问和操作账户的凭证，务必妥善保管，切勿泄露给他人。未经授权的密钥泄露可能导致资金损失或其他安全问题。
• expires 参数用于设定数字签名的有效期限，以Unix时间戳表示。设定合理且安全的过期时间至关重要，过短的过期时间可能导致请求频繁失效，影响应用体验；过长的过期时间则会增加密钥泄露后被恶意利用的风险。请根据业务需求和安全考虑，权衡设置合适的过期时间。建议设置一个相对较短的时间，如几分钟或几小时，并定期更换API密钥，以增强安全性。
• 在实际生产环境中，对API调用返回的各种错误信息进行全面且细致的处理是至关重要的。您的应用程序应该能够捕获并记录错误代码、错误消息和任何其他相关的诊断信息。针对不同的错误类型，实施相应的重试机制、回退策略或警报通知，从而确保系统的稳定性和可靠性。务必参考API提供商的官方文档，详细了解各种可能的错误代码及其含义，以便进行准确的错误处理。

4.2 WebSocket API

WebSocket API 提供了一种通过单一 TCP 连接实现全双工通信的强大机制，使您能够建立一个持久、低延迟的连接，从而实时接收 BitMEX 交易所的市场数据和账户信息。与传统的 HTTP 请求-响应模式不同，WebSocket 允许服务器主动向客户端推送数据，无需客户端频繁轮询，显著降低了延迟和资源消耗。 BitMEX WebSocket API 使用 JSON（JavaScript Object Notation）格式进行数据通信，JSON 是一种轻量级的数据交换格式，易于解析和生成，并被广泛应用于 Web 应用程序中。通过订阅特定的频道，您可以接收诸如实时价格更新、交易量、订单簿深度、以及您的账户余额、订单状态等关键数据。利用WebSocket API，开发者可以构建高性能的交易机器人、实时监控工具、以及其他需要快速、可靠数据传输的应用。

连接 WebSocket:

与 BitMEX API 建立实时数据连接，推荐使用 WebSocket 协议。这种方式可以显著降低延迟，并实时接收市场更新和账户信息。您可以选择多种 WebSocket 客户端库来实现连接，例如在 Python 中广泛使用的 websocket-client 库。 该库提供了简单易用的接口，方便您快速建立稳定可靠的 WebSocket 连接。

在建立连接之前，务必确认您的 BitMEX API 密钥已正确配置，并了解 BitMEX WebSocket API 的endpoint。通常，你需要根据你的交易环境（例如测试网或主网）选择不同的endpoint。连接成功后，你需要通过发送订阅消息来指定你需要接收的数据流，例如实时交易数据、订单簿更新、账户余额变化等。

合理处理 WebSocket 连接的断开和重连机制至关重要。网络波动或者服务器维护都可能导致连接中断，因此，编写健壮的重连逻辑可以保证您的程序在异常情况下也能持续获取数据。同时，为了避免对 BitMEX 服务器造成过大的压力，建议在重连时设置合理的退避策略（Exponential Backoff），逐渐增加重连的间隔时间。

认证:

在与我们的加密货币交易平台建立安全连接之后，为了确保您的账户安全以及符合监管要求，您需要发送一个认证请求，以验证您的身份。此认证过程是访问我们平台各项功能，如交易、查询余额、提取资金等，至关重要的第一步。

认证请求本质上是一个经过加密的消息，它包含以下关键要素，缺一不可：

• API Key (API 密钥): 这是分配给您的唯一标识符，类似于用户 ID。请务必妥善保管您的 API 密钥，切勿泄露给他人。泄露 API 密钥可能导致您的账户被盗用。
• 签名 (Signature): 这是一个通过您的 API 密钥和您的私钥，对请求参数进行加密生成的字符串。签名用于验证请求的完整性和真实性，确保请求未被篡改，并且确实来自您。签名算法通常使用 HMAC-SHA256 或类似的加密哈希函数。
• 过期时间 (Expiration Timestamp): 为了防止重放攻击，每个认证请求都必须设置一个过期时间。过期时间是一个时间戳，表示该请求的有效截止日期。超过该时间，即使签名有效，请求也会被拒绝。通常建议设置一个合理的过期时间，例如 5-15 秒，以平衡安全性和可用性。

请注意，API 密钥和私钥是您身份认证的关键凭证。 私钥应该保存在安全的地方，永远不要分享。 使用 API 密钥和私钥正确生成签名是成功认证的关键。 错误的签名将导致认证失败。

认证流程通常如下：

1. 构建包含必要参数（例如请求路径、请求方法、请求参数、过期时间）的请求。
2. 使用您的私钥和 API 密钥，以及指定的签名算法，对请求参数进行签名。
3. 将 API 密钥、签名和过期时间添加到请求头或请求体中。
4. 将请求发送到我们的 API 服务器。
5. API 服务器验证请求的签名和过期时间。 如果一切验证成功，您的身份将被验证，您可以访问我们的平台。

我们强烈建议您仔细阅读我们的 API 文档，了解关于认证请求的具体格式、签名算法和参数要求。 正确的认证过程是使用我们平台 API 的基础。

订阅数据:

成功完成身份认证之后，您便可以自由订阅我们平台提供的各类数据频道。这些频道实时推送市场动态，满足您不同的交易和分析需求。常用的数据频道包括但不限于以下几种：

• trade : 此频道提供所有已成交的交易数据。您将获得每笔交易的详细信息，包括成交价格、成交数量、交易时间等。这些数据对于追踪市场趋势、评估交易量和识别潜在的价格波动至关重要。
• orderBookL2 : 这是一个深度订单簿数据频道，提供市场买单和卖单的实时快照。通过观察订单簿的深度和分布情况，您可以了解市场的供需关系，预测价格走向，并制定更有效的交易策略。 该频道的数据精度更高，能够提供更细粒度的订单簿信息。
• position : 通过此频道，您可以实时获取您的账户持仓信息。包括当前持有的币种、数量、平均持仓成本、盈亏情况等。这有助于您及时了解您的投资组合表现，并根据市场变化调整您的仓位。

请注意，订阅不同的数据频道可能会产生不同的费用，具体费用标准请参考我们的官方文档或联系客服人员。 您可以根据您的实际需求和预算，选择最适合您的数据频道组合。订阅成功后，您将可以实时接收到所订阅频道推送的数据，从而更好地把握市场机会。

示例代码 (Python):

此示例展示了如何使用 Python 和 websocket 库连接到 BitMEX 交易所的实时 WebSocket API，并订阅交易数据。该示例包括生成 API 密钥签名以进行身份验证以及处理接收到的消息、错误和连接状态。

需要安装 websocket-client 库。可以使用 pip 进行安装：

pip install websocket-client

另外，需要安装 库(如果未安装)。可以使用 pip 进行安装：

pip install 

导入必要的库：

import websocket
import 
import hashlib
import hmac
import time

配置 API 密钥、API 密钥密码和 WebSocket 基本 URL。请务必替换 YOUR_API_KEY 和 YOUR_API_SECRET 为你自己的 BitMEX API 密钥。 base_url 定义了连接到的 BitMEX WebSocket API 的端点。使用主网时设置为 wss://www.bitmex.com/realtime ，使用测试网时设置为 wss://testnet.bitmex.com/realtime 。

api_key = "YOUR_API_KEY"
api_secret = "YOUR_API_SECRET"
base_url = "wss://www.bitmex.com/realtime"  # 或使用测试网 wss://testnet.bitmex.com/realtime

generate_signature 函数用于为 BitMEX API 请求生成签名。它采用 API 密钥密码、HTTP 方法 (verb)、请求 URL、过期时间戳和请求数据作为输入。该函数使用 HMAC-SHA256 算法，利用 API 密钥密码对消息进行签名，生成一个十六进制摘要。此签名用于验证请求的真实性。

def generate_signature(api_secret, verb, url, expires, data):
    """为 BitMEX API 请求生成签名."""
    message = verb + url + str(expires) + data
    signature = hmac.new(api_secret.encode('utf-8'), message.encode('utf-8'), digestmod=hashlib.sha256).hexdigest()
    return signature

以下函数定义了 WebSocket 事件处理程序。 on_message 处理从 WebSocket 接收的消息，并将其打印到控制台。 on_error 处理 WebSocket 错误，并打印错误消息。 on_close 在 WebSocket 连接关闭时被调用，并打印一条消息。 on_open 在 WebSocket 连接成功建立后被调用，并打印一条消息。

def on_message(ws, message):
    """处理来自 WebSocket 的传入消息."""
    print(message)

def on_error(ws, error):
    """处理 WebSocket 错误."""
    print(error)

def on_close(ws):
    """处理 WebSocket 连接关闭."""
    print("### closed ###")

def on_open(ws):
    """处理 WebSocket 连接打开."""
    print("### opened ###")

在 on_open 处理程序中，首先生成一个过期时间戳，该时间戳表示签名有效的截止时间。过期时间戳设置为当前时间加上 60 秒。然后，使用 generate_signature 函数生成 API 密钥签名。接下来，构造一个包含身份验证数据的 JSON 对象。此对象包含操作类型 ( authKey )、API 密钥、过期时间戳和签名。使用 ws.send() 方法将身份验证数据作为 JSON 字符串发送到 WebSocket。构造一个包含订阅数据的 JSON 对象。此对象包含操作类型 ( subscribe ) 和要订阅的频道 ( trade:XBTUSD )。使用 ws.send() 方法将订阅数据作为 JSON 字符串发送到 WebSocket。

expires = int(time.time()) + 60  # 60 秒
signature = generate_signature(api_secret, 'GET', '/realtime', expires, '')

auth_data = {
    "op": "authKey",
    "args": [api_key, expires, signature]
}

ws.send(.dumps(auth_data))

# 订阅 XBTUSD 的交易频道
subscribe_data = {
    "op": "subscribe",
    "args": ["trade:XBTUSD"]
}

ws.send(.dumps(subscribe_data))

在 if __name__ == "__main__": 块中，首先启用 WebSocket 跟踪，以便调试。然后，创建一个 websocket.WebSocketApp 对象，并将基本 URL 和事件处理程序传递给它。调用 ws.run_forever() 方法来启动 WebSocket 客户端并保持连接处于活动状态。

if __name__ == "__main__":
    websocket.enableTrace(False)
    ws = websocket.WebSocketApp(base_url,
                                   on_message=on_message,
                                   on_error=on_error,
                                   on_close=on_close,
                                   on_open=on_open)

调用 ws.run_forever() 方法启动 WebSocket 客户端并保持连接活动状态。 此方法会一直运行，直到连接关闭。

ws.run_forever()

注意事项:

• 请务必替换 YOUR_API_KEY 和 YOUR_API_SECRET 为您在加密货币交易所或服务商处申请的真实有效的 API 密钥和密钥密文。 API 密钥用于身份验证和授权，务必妥善保管，切勿泄露给他人。泄露API密钥可能导致您的账户资产被盗或遭受其他安全风险。同时，定期更换API密钥也是一种良好的安全实践。
• 在实际生产环境中，需要实现完善的 WebSocket 连接管理机制，包括但不限于自动检测连接断开，尝试自动重连，以及在重连失败后进行适当的错误处理和告警。 WebSocket 连接的稳定性直接影响到数据接收的实时性和完整性，因此需要特别关注。可以采用指数退避算法来控制重连频率，避免频繁重连给服务器造成压力。同时，记录连接状态和错误日志，方便问题排查。
• 请根据实际需求，合理选择并控制订阅的数据频道。订阅过多不必要的数据频道会导致数据流量浪费，增加客户端处理负担，甚至可能超出API的使用限制。 仔细评估每个数据频道的价值，仅订阅对您的策略或应用至关重要的数据。部分交易所或服务商可能会对不同数据频道的订阅收取不同的费用，因此合理控制订阅频道也有助于降低成本。考虑使用过滤器或聚合器来进一步减少数据量。

5. 错误处理

BitMEX API采用标准HTTP状态码来报告请求处理结果。 当发生错误时，API会返回相应的HTTP状态码，例如400（错误请求）、401（未授权）、403（禁止）、404（未找到）或500（服务器内部错误）等。同时，API会将详细的错误信息封装在JSON格式的响应体中。这些JSON错误信息通常包含错误代码、错误消息以及相关的上下文信息，有助于开发者理解错误的具体原因。

为了确保应用程序的健壮性和可靠性，务必在代码中实现完善的错误处理机制。你应该捕获API返回的HTTP状态码，并解析JSON格式的错误信息，以便确定错误的性质和严重程度。基于这些信息，你可以采取适当的措施，例如：

• 重试请求： 对于偶发性的错误，例如网络连接问题或服务器临时过载，可以尝试重新发送请求。你可以实现指数退避算法，逐渐增加重试间隔，以避免对API服务器造成过大的压力。
• 记录错误日志： 将错误信息记录到日志文件中，以便进行后续的分析和调试。日志信息应包含时间戳、HTTP状态码、错误代码、错误消息以及相关的请求参数。
• 向用户显示错误消息： 向用户友好地展示错误信息，避免显示过于技术化的细节。你可以根据错误代码或错误消息，提供有用的提示或建议，帮助用户解决问题。
• 停止交易或操作： 如果发生严重的错误，例如账户权限不足或API调用频率超过限制，应该立即停止相关的交易或操作，以避免造成更大的损失。

正确处理API错误对于构建稳定和可靠的BitMEX交易应用程序至关重要。通过仔细检查HTTP状态码和JSON错误信息，并采取适当的措施，你可以最大限度地减少错误对应用程序的影响，并提供更好的用户体验。

6. 限速 (Rate Limiting)

BitMEX API 实施了严格的请求频率限制机制，旨在保护系统稳定性和防止滥用。当客户端在单位时间内发送的请求数量超过预设阈值时，API 将返回 HTTP 429 状态码，表示“请求过多 (Too Many Requests)”。

为了避免触发限速，开发者必须精心设计其应用程序，合理控制对 API 的请求频率。这包括但不限于：

• 优化数据获取策略： 仅请求所需的数据，避免不必要的冗余请求。考虑使用 WebSocket 推送服务接收实时数据更新，而非频繁轮询 API。
• 实施指数退避 (Exponential Backoff)： 当收到 429 错误时，应用程序应暂停一段时间，然后重试请求。每次重试之间的时间间隔应呈指数增长，以避免持续触发限速。
• 缓存静态数据： 将不经常变化的数据缓存在本地，以减少对 API 的请求次数。
• 使用批量请求 (Bulk Requests，如果支持)： 如果 API 允许，将多个操作合并到一个请求中，以减少总体请求数量。
• 监控 API 响应头： BitMEX API 的响应头中通常包含有关剩余请求数量和重置时间的信息。开发者可以利用这些信息来动态调整请求频率。

请务必查阅 BitMEX 官方 API 文档，详细了解当前的限速策略，包括每个端点的具体限制、时间窗口以及其他相关规则。 不同的 API 端点可能具有不同的限速配置，因此需要针对每个端点进行优化。

违反限速规则可能会导致您的 IP 地址或 API 密钥被暂时或永久阻止访问 API。 因此，理解和遵守 BitMEX 的限速政策至关重要，以确保应用程序的稳定运行和可靠性。