BitMEX API自动化交易：新手指南与实战技巧！

2025-03-08 09:32:00 47

BitMEX API接口开通使用详细教程

本文将详细介绍如何在BitMEX平台上开通并使用API接口，帮助您构建自己的自动化交易程序或数据分析工具。BitMEX API提供了强大的功能，允许用户通过编程方式访问市场数据、下单、管理账户等。

一、准备工作

在使用BitMEX API之前，务必进行充分的准备，这将直接影响到您与BitMEX交易所交互的效率和安全性。以下是详细的准备步骤：

  1. BitMEX账户： 您必须拥有一个已注册且激活的BitMEX账户。这包括完成账户注册流程，设置安全的密码，并启用双因素认证（2FA）以增强账户安全性。如果尚未拥有BitMEX账户，请访问BitMEX官方网站（请务必确认网址的真实性，谨防钓鱼网站）进行注册。根据BitMEX的规定，部分地区的用户可能需要完成KYC（了解您的客户）认证才能进行交易，请根据您的所在地区和BitMEX的政策要求完成相应的认证流程。
  2. Python环境： 推荐使用Python编程语言来调用BitMEX API。Python因其简洁的语法和丰富的库支持，成为与交易所API交互的首选语言之一。请确保您的计算机上安装了Python 3.6或更高版本，以兼容BitMEX API所需的库和功能。可以通过Python官方网站（https://www.python.org/downloads/）下载并安装Python。安装完成后，建议配置Python环境变量，以便在命令行中直接使用 python 和 pip 命令。
  3. 相关Python库： 需要安装一系列必要的Python库，以便于进行HTTP请求、WebSocket连接和数据处理。这些库包括 requests 、 websocket-client 和 urllib3 。 requests 库用于发送HTTP请求， websocket-client 库用于建立和维护WebSocket连接（用于实时数据订阅）， urllib3 是Python的HTTP客户端， requests 底层依赖于它。您可以使用Python的包管理器 pip 来安装这些库。打开命令行终端，执行以下命令进行安装： 
    pip install requests websocket-client urllib3

    如果您的网络环境访问PyPI不稳定，可以考虑使用国内的镜像源来加速下载，例如： 

    pip install requests websocket-client urllib3 -i https://pypi.tuna.tsinghua.edu.cn/simple

    安装完成后，建议检查库的版本，确保安装的库符合BitMEX API的要求或推荐版本，避免因版本不兼容导致的问题。

二、获取API密钥

  1. 登录BitMEX账户： 使用您已注册的账户名和密码安全地登录BitMEX官方网站。请确保访问的是官方网站，谨防钓鱼网站窃取您的凭据。建议启用双重验证（2FA）以提高账户安全性。
  2. 进入API密钥管理页面： 成功登录后，在页面右上角找到并点击您的用户头像，系统会展开一个下拉菜单。在该菜单中，找到并选择“API密钥”选项，进入API密钥管理页面。此页面是您创建和管理API密钥的中心。
  3. 创建新的API密钥： 在API密钥管理页面，您将看到一个“创建API密钥”或类似的按钮。点击此按钮，系统将引导您进入API密钥创建流程。注意，BitMEX可能会要求您再次进行身份验证以确认您的操作。
  4. 设置API密钥权限： 在API密钥创建页面，您需要详细配置API密钥的权限。BitMEX提供了精细化的权限控制选项，允许您根据实际需求精确地定义API密钥的功能。常见的权限选项包括：“读取账户信息”、“查看交易历史”、“下单交易”、“取消订单”、“提取资金（通常不建议启用）”等。 强烈建议您严格遵循最小权限原则，仅授予API密钥执行其预期功能所需的最低权限集合，从而最大程度地降低潜在的安全风险。 例如，如果您的应用程序只需要从BitMEX获取实时市场数据，而不需要执行任何交易操作，那么您应该只赋予API密钥“读取市场数据”的权限，而禁止其执行任何下单、取消订单或提取资金的操作。这样做可以有效防止API密钥被恶意利用，保障您的账户安全。仔细阅读每个权限的说明，确保您理解其含义和潜在影响。
  5. 保存API密钥： API密钥创建完成后，系统会生成一对密钥：API密钥（API Key）和API密钥Secret（API Secret）。 请务必以极其安全的方式妥善保管您的API密钥和API密钥Secret。API密钥Secret只会显示一次，这意味着如果您在创建后丢失了API密钥Secret，您将无法再次找回它，而必须重新生成一个新的API密钥对。 API密钥和API密钥Secret的组合相当于您账户的访问凭证，拥有它们就等同于拥有了您账户的部分控制权。因此，绝对不能将API密钥和API密钥Secret泄露给任何第三方，也不能将其存储在不安全的地方，例如公共代码仓库、聊天记录、电子邮件等。一旦API密钥和API密钥Secret泄露，可能会导致您的账户被恶意操控、资金被盗取等严重后果。建议使用密码管理器或其他安全存储方案来保存您的API密钥和API密钥Secret，并定期更换API密钥以提高安全性。

三、API接口类型

BitMEX API主要分为两种核心类型，开发者可以根据自身需求选择合适的接口进行集成：

  1. REST API： 基于HTTP协议的请求-响应模式，允许开发者通过发送标准的HTTP请求（如GET、POST、PUT、DELETE）与BitMEX服务器进行交互。REST API适用于执行非实时性操作，例如：
    • 历史数据检索： 获取历史交易数据，用于分析市场趋势和回测交易策略。开发者可以通过指定时间范围和交易对，获取特定时间段内的交易、成交量等信息。
    • 订单管理： 包括创建、修改和取消订单等操作。开发者可以根据市场情况灵活调整订单策略。
    • 账户信息查询： 获取账户余额、持仓情况、交易历史等关键信息，方便开发者进行资金管理和风险控制。
    由于其请求-响应的特性，REST API在数据更新频率要求不高的场景下表现良好。
  2. WebSocket API： 利用WebSocket协议建立客户端与服务器之间的持久性连接，实现双向实时数据传输。WebSocket API特别适用于需要实时、高频率数据更新的应用场景，例如：
    • 实时市场数据推送： 实时接收最新的市场行情，包括价格、深度、交易量等，为高频交易和算法交易提供数据支持。
    • 实时账户信息更新： 实时获取账户余额、持仓变化、订单状态等信息，以便开发者及时做出反应。
    • 实时订单簿更新： 实时获取订单簿的变动情况，帮助开发者更好地了解市场深度和流动性。
    WebSocket API的优势在于其低延迟和高效率，可以满足对实时性要求极高的交易应用的需求。

四、使用REST API

REST API是与BitMEX服务器交互的常用方式。它允许开发者通过HTTP请求获取市场数据、执行交易以及管理账户。以下代码示例展示了如何使用Python的 requests 库调用BitMEX REST API获取交易对的最近成交价。 requests 库是一个简单易用的HTTP客户端，方便发送HTTP请求。

import requests

def get_last_price(symbol):

"""
获取指定交易对的最近成交价。
这个函数通过调用BitMEX的/trade端点来获取指定交易对的最新成交价。
"""

Args:
symbol: 交易对名称，例如 "XBTUSD"。这是要查询的合约代码，例如比特币/美元永续合约。

Returns:
最近成交价，如果出错则返回None。如果API请求成功，则返回一个浮点数表示最新成交价，否则返回None。
"""

url = f"https://www.bitmex.com/api/v1/trade?symbol={symbol}&count=1&reverse=true"
# 构建API请求URL。symbol参数指定交易对，count=1表示只获取一条数据，reverse=true表示按时间倒序排列（即最新成交在最前面）。

try:
response = requests.get(url)
# 使用requests库发送GET请求。
response.raise_for_status() # 检查HTTP状态码是否为200。如果状态码不是200，会抛出一个HTTPError异常。
data = response.()
# 将返回的JSON数据解析为Python对象。
if data and len(data) > 0:
# 检查返回的数据是否为空，并确保至少有一条数据。
return data[0]['price']
# 从返回的数据中提取最新成交价。BitMEX API返回的是一个列表，其中包含一个字典，字典中包含'price'键。
else:
return None
# 如果没有数据返回，则返回None。
except requests.exceptions.RequestException as e:
# 捕获requests库可能抛出的异常，例如网络连接错误、超时等。
print(f"Error: {e}")
# 打印错误信息。
return None
# 如果发生异常，则返回None。

if __name__ == "__main__":
# 只有当脚本直接运行时，才会执行以下代码。当脚本作为模块导入时，不会执行。

symbol = "XBTUSD"
# 设置要查询的交易对为XBTUSD（比特币/美元永续合约）。
last_price = get_last_price(symbol)
# 调用get_last_price函数获取最新成交价。
if last_price:
# 检查是否成功获取到最新成交价。
print(f"{symbol} Last Price: {last_price}")
# 打印最新成交价。
else:
# 如果获取最新成交价失败，则打印错误信息。
print(f"Failed to get last price for {symbol}")

注意事项：

  • 为了在BitMEX的测试网络环境中进行API调用，请务必将 url 中的生产环境地址 https://www.bitmex.com 替换为测试环境地址 https://testnet.bitmex.com 。 测试网络允许开发者在不使用真实资金的情况下，验证API集成的正确性和功能性。
  • BitMEX API服务器为了保证服务的稳定性和公平性，对每个用户的API请求频率进行了限制。超出限制的请求将被拒绝访问。开发者需要密切关注请求频率，并采取相应的措施，例如使用队列或延迟重试机制，来避免触发速率限制。您可以通过检查HTTP响应头中的相关字段，如 X-RateLimit-Limit （总请求数限制）, X-RateLimit-Remaining （剩余请求数）, 和 X-RateLimit-Reset （重置时间戳），来了解当前API密钥的请求频率状态。
  • 访问BitMEX API中需要身份验证的端点，例如下单、查询账户余额等，需要在每个HTTP请求的头部添加身份验证信息。这些信息包括 api-key （您的API密钥ID）和 api-signature （请求签名）。 api-signature 是使用您的API密钥Secret对请求内容进行HMAC-SHA256加密后生成的。 构建 api-signature 的具体步骤包括：将请求方法（如GET、POST）、请求的URL路径（不包含域名）以及请求正文（如果存在）按照特定格式拼接成字符串，然后使用API密钥Secret作为密钥，对该字符串进行HMAC-SHA256加密。 请确保加密算法的正确性，并妥善保管您的API密钥Secret，避免泄露。 如果请求签名不正确，API服务器将拒绝请求。

五、使用WebSocket API

以下代码示例展示了如何使用Python的 websocket-client 库连接BitMEX WebSocket API，订阅 XBTUSD 交易对的 trade 频道，并实时打印成交数据。这种方法能够近乎实时地获取市场信息，适用于需要快速响应的交易策略。

websocket-client 是一个流行的Python库，简化了与WebSocket服务器的交互。您可以使用pip进行安装： pip install websocket-client 。 除了 trade 频道，BitMEX还提供了其他多种频道，例如 orderBookL2 （深度数据）， instrument （合约信息）等，可以根据需求进行订阅。

import websocket import

def on_message(ws, message): """ 接收到WebSocket消息时的回调函数。当WebSocket连接收到消息时，此函数会被调用。它负责解析收到的JSON数据，提取交易信息，并将其打印到控制台。

Args: ws: WebSocket连接对象，代表与BitMEX服务器的连接。 message: 收到的消息，通常是包含交易数据的JSON字符串。 """ try: data = .loads(message) if 'data' in data and len(data['data']) > 0: for trade in data['data']: print(f"Timestamp: {trade['timestamp']}, Price: {trade['price']}, Size: {trade['size']}") except .JSONDecodeError as e: print(f"Error decoding JSON: {e}") print(f"Received message: {message}") # 打印原始消息，便于调试

def on_error(ws, error): """ 发生错误时的回调函数。当WebSocket连接发生错误时（例如连接中断、服务器错误），此函数会被调用。它会将错误信息打印到控制台，帮助开发者诊断问题。

Args: ws: WebSocket连接对象。 error: 错误信息，描述发生的错误。 """ print(f"Error: {error}")

def on_close(ws): """ 连接关闭时的回调函数。当WebSocket连接关闭时（无论是正常关闭还是意外关闭），此函数会被调用。它会打印一条消息到控制台，表明连接已关闭。

Args: ws: WebSocket连接对象。 """ print("### closed ###")

def on_open(ws): """ 连接建立时的回调函数。当WebSocket连接成功建立时，此函数会被调用。它负责发送订阅消息到BitMEX服务器，告诉服务器需要接收哪些频道的数据。

Args: ws: WebSocket连接对象。 """ print("### opened ###") subscribe_message = { "op": "subscribe", "args": ["trade:XBTUSD"] } ws.send(.dumps(subscribe_message))

if __name__ == "__main__": websocket.enableTrace(False) # 开启Trace模式，可以查看WebSocket的详细日志。在生产环境中，建议关闭Trace模式，以减少性能开销。 启用后，所有发送和接收的数据包都将被打印到控制台。

# 可以切换到测试网络，方便调试和测试，避免影响真实交易。测试网络的地址为："wss://testnet.bitmex.com/realtime" ws_url = "wss://www.bitmex.com/realtime" # 或者 "wss://testnet.bitmex.com/realtime" for testnet ws = websocket.WebSocketApp(ws_url, on_message = on_message, on_error = on_error, on_close = on_close) ws.on_open = on_open ws.run_forever()

注意事项：

  • 为了在BitMEX测试网络环境中进行开发和测试，务必将代码中的WebSocket连接地址 ws_url 从正式环境的 wss://www.bitmex.com 更改为测试环境的专用地址 wss://testnet.bitmex.com 。这样做能够避免在正式交易所上产生意外交易或数据污染。请务必区分正式环境和测试环境，确保资金安全和数据准确性。
  • BitMEX的WebSocket API允许订阅多种频道和数据流。通过调整 args 参数，可以灵活地选择所需的数据。例如，使用 quote:XBTUSD 可以实时接收 XBTUSD 合约的最新报价信息，包括买一价和卖一价。而 orderBookL2_25:XBTUSD 则订阅 XBTUSD 合约的25档深度订单簿数据，提供更全面的市场深度信息。可以通过修改 args 参数订阅交易数据、账户信息等其他可用频道，具体参数和频道名称请参考BitMEX官方API文档。
  • BitMEX WebSocket API部分接口需要身份验证。对于需要权限才能访问的数据（例如账户余额、成交历史等），必须在WebSocket连接建立后，立即发送一个包含您的API密钥（ apiKey ）和签名（ signature ）的 authKey 消息。该签名是对特定数据进行哈希运算的结果，用于验证请求的合法性。请务必妥善保管您的API密钥，避免泄露，并使用安全的哈希算法生成签名。有关身份验证的详细步骤和示例代码，请查阅BitMEX API官方文档中关于WebSocket身份验证的部分。正确进行身份验证是访问私有数据的关键步骤。

六、安全注意事项

  • 保管好API密钥和API密钥Secret。 API密钥和API密钥Secret是访问BitMEX API的凭证，切勿泄露给任何第三方。泄露密钥将导致账户资金面临风险。请勿将API密钥和API密钥Secret以明文形式存储在任何地方，例如：代码仓库、配置文件、聊天记录等。推荐使用加密方式存储，并设置访问权限。
  • 遵循最小权限原则。 在创建API密钥时，仅赋予其完成交易策略所需的最小权限集合。例如，如果你的策略仅需读取市场数据，则只需赋予读取权限，避免赋予交易或提现权限。过度授权会增加潜在的安全风险，一旦密钥泄露，损失将可能扩大。
  • 使用安全的网络连接。 始终使用HTTPS协议来访问BitMEX API的REST接口，并使用WSS协议来连接WebSocket API。 HTTPS和WSS协议通过加密数据传输，防止中间人攻击，确保数据在传输过程中的安全性。避免使用公共Wi-Fi等不安全的网络环境进行API操作。
  • 定期更换API密钥。 定期更换API密钥是增强安全性的重要措施。建议至少每3个月更换一次API密钥，或者在怀疑密钥可能泄露时立即更换。更换API密钥后，请务必及时更新所有使用该密钥的应用程序和脚本。
  • 监控API使用情况。 密切监控API的使用情况，包括请求频率、交易量、错误日志等。设置异常告警，例如：当出现异常交易、高频请求或未知IP地址访问时，立即收到通知。通过监控API使用情况，可以及时发现并阻止潜在的恶意行为。

以上是BitMEX API接口开通和使用的详细教程。通过API，您可以实现自动化交易，获取更快的市场数据，并构建个性化的交易策略。请务必仔细阅读BitMEX官方API文档，了解所有API端点、参数和限制。同时，请严格遵守BitMEX API的使用规则，包括请求频率限制、数据使用协议等。不遵守规则可能会导致API访问受限甚至账户被冻结。建议在真实交易前，先在BitMEX的测试网络（Testnet）上进行充分的测试和验证。

The End

发布于：2025-03-08，除非注明，否则均为数新知原创文章，转载请注明出处。