Bitmex API密钥生成及使用教程详解
Bitmex作为一家老牌的加密货币衍生品交易所，一直受到专业交易员的青睐。其提供的API接口功能强大，允许用户通过程序化交易执行各种策略。本文将详细介绍如何在Bitmex平台上生成API密钥，以及如何使用这些密钥进行程序化交易。
API密钥生成步骤
- 登录您的加密货币交易所账户。 访问您选择的加密货币交易所的官方网站，并使用您的用户名和密码安全地登录。务必启用双因素身份验证 (2FA) 以增强账户安全性。
- Order: 允许程序下达、修改和取消订单。如果你计划进行交易，这个权限是必须的。
- Order Cancel: 允许程序取消订单。可以单独授予，也可以包含在“Order”权限中。
- Withdraw: 允许程序发起提币请求。强烈建议不要授予此权限，除非你有极高的安全需求并且完全信任你的程序。 如果授予此权限，一旦API密钥泄露，你的资产将面临风险。
- Account: 允许程序查询账户信息，例如余额、持仓等。对于风险管理和策略监控来说，这个权限非常有用。
- Affiliate: 允许程序访问联盟营销相关的数据。如果你参与了Bitmex的联盟营销计划，可以授予此权限。
在设置权限时，请遵循最小权限原则，只授予程序需要的权限，避免不必要的风险。
API密钥使用示例 (Python)
以下是一个使用Python和Bitmex API库通过REST API进行交易的简单示例。Bitmex API允许开发者通过编程方式访问其交易平台，进行数据查询、订单管理等操作。
你需要安装Bitmex官方提供的Python API库。该库封装了与Bitmex API交互的复杂性，简化了开发流程。
pip install bitmex-api
该命令使用Python的包管理工具pip从Python Package Index (PyPI) 下载并安装bitmex-api库。确保你的Python环境已正确配置，并且pip工具可用。
安装完成后，你可以使用以下代码连接到Bitmex API并执行交易操作。请务必保管好你的API密钥，避免泄露。
import bitmex
这段代码导入了刚刚安装的bitmex库，允许你在Python脚本中使用Bitmex API提供的各种功能。 接下来你需要配置API密钥和私钥，并创建Bitmex客户端实例。
替换为你的API Key和API Secret
为了能够安全地访问和操作交易所或区块链平台的数据，你需要提供你的API Key和API Secret。这些密钥是验证你的身份并授权你进行特定操作的关键凭证。请务必妥善保管你的API Secret，避免泄露给他人，因为它具有极高的安全敏感性。在代码中，你需要将占位符
YOUR_API_KEY
替换为你实际的API Key，将
YOUR_API_SECRET
替换为你实际的API Secret。
api_key = "YOUR_API_KEY"
api_secret = "YOUR_API_SECRET"
请注意，API Key通常用于识别你的账户，而API Secret则用于生成签名以验证请求的真实性。在大多数情况下，API Secret应被视为密码，绝不能在客户端代码中硬编码或以任何不安全的方式存储。建议使用环境变量或配置文件等安全方式来管理你的API Secret。
选择交易环境：测试网 (Testnet) 或真实环境 (Mainnet)
在进行加密货币交易或开发相关应用时，选择合适的交易环境至关重要。通常，存在两种主要环境：测试网 (Testnet) 和真实环境 (Mainnet)，也称为主网。Testnet 允许开发者在不涉及真实资金的情况下测试和调试他们的代码，模拟真实世界的交易场景。 Mainnet 则代表实际的区块链网络，所有交易都会使用真实的加密货币进行结算。
testnet = True
此处的代码片段
testnet = True
表示已选择测试网环境。将该变量设置为
True
会指示程序或应用连接到测试网，而不是主网。在测试网中，您可以免费获得用于测试目的的加密货币，例如通过水龙头（Faucet）服务。测试网币没有任何实际价值，其唯一目的是模拟真实交易，从而帮助开发者发现和修复潜在问题，而无需承担任何经济风险。相反，如果设置为
testnet = False
，则会连接到主网，意味着任何交易都将使用真实的加密货币并产生实际的费用和价值转移。
初始化BitMEX客户端
为了与BitMEX交易所进行交互，你需要初始化一个BitMEX客户端。 这可以通过使用BitMEX提供的Python SDK来实现。初始化过程需要提供API密钥和API密钥密码，并且可以选择指定是否连接到测试网络。
client = bitmex.bitmex(test=testnet, api_key=api_key, api_secret=api_secret)
在上述代码中，
bitmex.bitmex()
函数用于创建客户端实例。参数说明如下：
-
test: 布尔值，用于指定是否连接到BitMEX的测试网络。如果设置为True，则连接到测试网络；如果设置为False，则连接到主网络。 测试网络允许开发者在不使用真实资金的情况下进行交易和测试策略。 -
api_key: 你的BitMEX API密钥。API密钥用于身份验证，允许你访问BitMEX的API。你可以在BitMEX网站的API密钥管理页面生成API密钥。 -
api_secret: 你的BitMEX API密钥密码。API密钥密码与API密钥一起使用，以确保你的身份验证安全。请妥善保管你的API密钥和API密钥密码，不要将其泄露给他人。
初始化完成后，
client
对象就可以用于调用BitMEX API的各种方法，例如查询账户余额、下单、取消订单等。
设置交易参数
在加密货币交易中，设置准确的交易参数至关重要。这些参数将直接影响您的订单执行和潜在收益。以下是一些关键参数的详细说明，以XBTUSD（比特币/美元永续合约）为例。
symbol = "XBTUSD"
symbol
参数定义了您希望交易的交易对。在这个例子中，
XBTUSD
代表比特币兑美元的永续合约。不同的交易所和交易平台可能使用不同的符号表示相同的交易对，因此请务必确认您使用的符号与您的交易所匹配。 有些交易所提供不同的合约类型(例如交割合约，反向合约)，symbol的选择需要仔细确认。
order_qty = 1
order_qty
参数指定了您希望交易的数量。在这个例子中，
order_qty = 1
表示您希望交易 1 个合约单位的 XBTUSD。 请注意，不同的合约单位代表的价值可能不同，某些平台可能是以美元计价，有些平台是以比特币计价。 在下单前请务必了解清楚一个合约单位代表的实际价值。
price = 20000
price
参数定义了您希望交易的价格。在这个例子中，
price = 20000
表示您希望以 20000 美元的价格买入或卖出 XBTUSD。 这通常用于限价单，只有当市场价格达到或优于您指定的价格时，订单才会执行。如果使用市价单，则不需要指定价格，而是会以当前市场最优价格立即成交。需要注意的是，在高波动市场中，限价单可能无法成交，而市价单可能会产生滑点，实际成交价格与预期价格存在差异。 设置合理的价格能够有效控制交易成本和风险。 您应该根据您的交易策略和市场情况来设置合适的价格。
下单 (限价单)
使用限价单，交易者可以指定希望买入或卖出加密货币的具体价格。当市场价格达到或超过设定的限价时，订单才会执行。此方法允许交易者更好地控制交易成本，但不能保证订单一定会成交，尤其是在市场波动剧烈的情况下。
以下代码示例展示了如何使用客户端库提交一个限价单。
symbol
参数指定交易对，例如 'XBTUSD'。
orderQty
参数指定订单的数量，正数表示买入，负数表示卖出。
price
参数设定限价，只有当市场价格达到或优于此价格时，订单才会被执行。
ordType='Limit'
参数明确声明这是一个限价单。
order = client.Order.Order_new(symbol=symbol, orderQty=order_qty, price=price, ordType='Limit').result()
这行代码调用客户端库中的
Order.Order_new
方法创建一个新的限价单。
result()
方法用于同步等待服务器的响应，并返回订单的相关信息。如果订单提交成功，返回的对象将包含订单ID、状态、交易价格等信息。如果订单提交失败，例如由于账户余额不足或无效的参数，将抛出异常。
print(order)
此行代码将打印返回的订单对象，以便您可以查看订单的详细信息，包括订单状态、成交价格、手续费等。这对于调试和验证订单是否正确提交非常有用。 请确保在生产环境中妥善处理订单信息，避免泄露敏感数据。
获取账户信息
在加密货币交易API的使用中，获取账户信息是至关重要的步骤，它允许用户程序matically查询账户余额、可用资金、持仓情况等关键数据。通过Bybit API，可以使用
client.User.User_getMargin()
方法来获取用户的保证金账户信息。
account = client.User.User_getMargin().result()
上述代码行首先调用Bybit API客户端的
User_getMargin()
方法。这个方法负责向Bybit服务器发起请求，请求用户的保证金账户信息。
result()
函数用于从 API 调用中提取结果数据，然后将获得的数据赋值给变量
account
。
account
变量现在包含一个数据结构，其中包含了用户的账户的各种信息，例如可用余额，已用余额，保证金率，以及其他的账户相关参数。
print(account)
执行
print(account)
语句会将存储在
account
变量中的账户信息输出到控制台。这些信息通常以JSON格式或其他类似的数据结构呈现，包含了账户的各种详细信息，例如总资产、可用资产、已用保证金、未实现盈亏等等。开发者可以解析这些信息，用于程序中的进一步处理，例如风险管理、自动交易策略、账户监控等。
更深入地了解
User_getMargin()
：此方法通常支持可选参数，允许更精细地查询特定类型的账户信息，例如仅查询特定币种的余额。具体的参数和返回值结构需要参考Bybit API的官方文档，因为不同的API版本可能会有细微差别。在实际开发中，务必查阅最新的API文档，以确保代码的正确性和兼容性。
获取持仓信息
在加密货币交易中，获取当前持仓信息是进行风险管理和策略调整的关键步骤。 使用特定的API接口，例如通过
client.Position.Position_get()
方法，可以查询当前账户的持仓情况。这个方法通常接受一个筛选器（
filter
）作为参数，允许用户根据特定条件（例如交易对
symbol
）来过滤持仓信息。例如，若要获取特定交易对（如'BTCUSDT'）的持仓数据，可将
filter
设置为
{'symbol': 'BTCUSDT'}
。API调用会返回一个结果对象，其中包含了满足筛选条件的持仓信息，例如持仓数量、平均持仓成本、未实现盈亏等。通过访问结果对象的
result()
方法，可以获得包含详细持仓数据的字典或列表，以便进一步分析和处理。 通过
print(positions)
可以将获取到的持仓信息输出到控制台，方便开发者进行调试和验证。
取消所有订单
在加密货币交易中，有时需要快速取消所有挂单。 使用特定的API接口可以实现这一功能。以下代码展示了如何使用Python客户端取消指定交易对的所有订单。
cancel_all = client.Order.Order_cancelAll(symbol=symbol).result()
上述代码片段中，
client.Order.Order_cancelAll(symbol=symbol)
调用了交易平台提供的API接口，用于取消特定交易对（
symbol
）的所有挂单。
symbol
变量需要替换为实际的交易对代码，例如"BTCUSDT"。
.result()
方法用于同步获取API调用的结果。取消操作的结果将存储在
cancel_all
变量中。该变量包含了取消操作的详细信息，例如取消成功的订单数量、取消失败的订单信息等。
print(cancel_all)
这行代码将
cancel_all
变量的内容打印到控制台。 通过查看打印输出，可以确认取消操作是否成功，并获取有关已取消订单的详细信息。 开发者可以根据实际需求，对
cancel_all
变量中的数据进行进一步处理，例如记录取消日志、更新交易状态等。
如果有仓位，则以市价单平仓
当交易账户存在仓位时，以下代码逻辑旨在快速执行平仓操作，采用市价单确保成交效率。具体流程如下：
-
仓位检测：
系统检查当前是否存在仓位。
if positions and positions[0] and positions[0]['currentQty'] != 0:这段代码验证positions列表非空，且至少存在一个仓位 (positions[0])，并且该仓位的数量 (currentQty) 不为零，意味着存在需要平仓的头寸。 -
确定平仓数量：
如果确认存在仓位，则计算平仓所需的数量。
close_order_qty = -positions[0]['currentQty']通过将当前仓位数量 (positions[0]['currentQty']) 取反，得到平仓所需的数量。例如，如果当前持有 10 个单位的多头仓位，则close_order_qty将为 -10，表示需要卖出 10 个单位。 -
创建并提交市价单：
使用交易所客户端 (
client) 创建一个新的市价单。close_order = client.Order.Order_new(symbol=symbol, orderQty=close_order_qty, ordType='Market').result()-
symbol指定交易的币对。 -
orderQty指定平仓的数量，其值已在先前步骤中确定。 -
ordType='Market'关键参数，指示这是一个市价单，意味着订单将立即以市场上最优的价格成交。 -
.result()提交订单并获取执行结果。
-
-
打印订单信息：
print(close_order)将订单的详细信息打印到控制台，用于调试和记录。 这些信息通常包括订单ID、成交价格、成交数量等。
这段代码片段的核心是利用市价单的快速成交特性，在检测到仓位后，立即以市场最优价格执行平仓，降低了因价格波动而导致平仓失败的风险。 然而，使用市价单也意味着成交价格可能与预期略有偏差，尤其是在市场波动剧烈时。 在实际应用中，需要根据具体的交易策略和风险承受能力，选择合适的订单类型。
代码解释:
-
bitmex.bitmex(test=testnet, api_key=api_key, api_secret=api_secret): 初始化BitMEX客户端，用于与BitMEX交易所的API进行交互。test=testnet参数控制连接的交易所环境。 当test=True时，客户端连接到BitMEX的测试网络，这是一个模拟交易环境，允许开发者在不承担真实资金风险的情况下测试其交易策略和API集成。test=False则连接到BitMEX的真实交易环境，涉及真实资金操作，务必谨慎。api_key和api_secret是您的BitMEX API密钥和密钥。这些密钥用于对您的API请求进行身份验证，并确保只有授权用户才能访问您的帐户数据并执行交易。 请务必在测试环境中充分验证您的代码和策略，以防止在真实环境中出现意外损失。 -
client.Order.Order_new(...): 该函数用于在BitMEX交易所下单。它允许您指定各种订单参数，包括：订单类型 (ordType)，如市价单 (Market)、限价单 (Limit)、止损单 (Stop)、止损限价单 (StopLimit)、冰山单 (Iceberg)等；交易数量 (orderQty)；价格 (price，仅限限价单)；交易方向 (side，买入或卖出)；以及其他高级订单选项，例如只减仓 (execInst)、隐藏委托 (displayQty) 等。 正确设置这些参数对于实现您的交易策略至关重要。 市价单会立即以当前市场价格执行，而限价单只有在市场价格达到或超过指定价格时才会执行。 止损单在达到触发价格时变为市价单，止损限价单在达到触发价格时变为限价单。 -
client.User.User_getMargin(): 用于获取账户的保证金信息。该信息包括：您的账户余额 (walletBalance)、可用保证金 (availableMargin)、已用保证金 (marginBalance)、未实现盈亏 (unrealisedPnl)、已实现盈亏 (realisedPnl) 等关键指标。 这些数据对于监控您的账户风险状况和调整交易策略至关重要。 您可以使用可用保证金来确定可以开立的最大仓位规模，并使用未实现盈亏来评估当前持仓的表现。 -
client.Position.Position_get(): 该函数用于检索您在BitMEX交易所的持仓信息。 它返回一个包含您所有当前持仓的列表，每个持仓都包含有关合约、数量、平均入场价格 (avgEntryPrice)、当前价值 (currentQty)、清算价格 (liquidationPrice) 等详细信息。 监控您的持仓是有效风险管理的关键。 清算价格表示如果市场朝着不利于您的方向发展，您的仓位将被强制平仓的价格。 -
client.Order.Order_cancelAll(): 用于取消所有未成交的订单。 当您需要快速退出市场或调整交易策略时，此函数非常有用。 例如，如果您检测到市场趋势发生变化，您可以使用此函数来取消所有挂单并重新评估您的交易计划。 -
平仓逻辑: 平仓是指将您的现有持仓完全或部分关闭的过程。 该逻辑首先使用
client.Position.Position_get()函数获取当前持仓信息。 然后，它检查是否存在持仓 (positions[0]['currentQty'] != 0)。 如果存在持仓，则计算需要平仓的数量 (close_order_qty = -positions[0]['currentQty'])。 请注意，平仓数量是当前持仓数量的负数，这意味着如果当前持有正数数量的合约（多头仓位），则平仓数量将为负数，表示卖出合约以平仓。 它使用client.Order.Order_new(...)函数下一个市价单，以指定的平仓数量进行交易，从而实现平仓。 使用市价单确保快速执行平仓操作，尤其是在市场波动剧烈时。
重要提示:
- 上述代码仅为示例，并非适用于所有交易场景，你需要深入理解并根据你的实际交易策略、风险承受能力以及市场具体情况进行个性化的修改和优化。参数调整、策略逻辑完善是关键。
- 在任何将资金置于风险之中的真实环境中进行交易前，请务必在Bitmex提供的测试网络（Testnet）或者模拟交易环境中进行充分且全面的测试。通过长时间的模拟交易来验证策略的有效性、稳定性以及抗风险能力，并针对可能出现的各种情况进行预案设计。
- 严格执行风险管理措施至关重要，设置合理的止损点（Stop-Loss Order）并严格遵守，有效控制单次交易的最大亏损。同时，考虑使用仓位控制策略，避免因杠杆过高或仓位过重而导致爆仓风险。风险永远是第一位的。
- 定期、持续地检查你的交易程序，确保其与交易所API保持同步，各项功能模块正常运行，并且能够正确处理各种市场事件和异常情况。日志记录、错误处理机制是必不可少的。
- 密切关注Bitmex官方API文档的更新，及时了解最新的API接口、数据结构、功能特性以及任何可能影响你交易策略的变更。遵守官方的速率限制和其他使用规则。
- 始终将你的API密钥视为高度敏感信息，绝对不要将API密钥泄露给任何他人，包括朋友、同事甚至Bitmex的客服人员。将API密钥存储在安全的地方，例如使用加密的配置文件或硬件钱包。
- 如果怀疑你的API密钥已经泄露（例如，发现异常交易活动或者收到可疑信息），请立即删除该密钥，并重新生成新的API密钥。同时，审查你的账户安全设置，启用双重验证（2FA）等安全措施。
高级用法
除了基本的下单、查询账户信息和持仓信息之外，BitMEX API还提供了许多高级功能，这些功能极大地扩展了交易策略的可能性，并允许开发者构建更加复杂和自动化的交易系统。
- WebSocket订阅: 通过WebSocket连接，您可以实时接收BitMEX交易所推送的市场数据，例如最新成交价格、成交量、深度行情（Order Book）快照、以及ticker信息。相比于轮询API，WebSocket订阅显著降低了延迟，使您能够对市场变化做出更迅速的反应。您还可以订阅特定合约、特定事件类型的数据流，以优化带宽使用和降低处理负担。
- 历史数据下载: BitMEX API允许您下载各种粒度的历史K线数据（例如1分钟K线、5分钟K线等）、成交记录（Trades）以及深度数据快照。这些数据对于量化研究、回测交易策略、以及构建预测模型至关重要。请注意，频繁请求历史数据可能会受到API速率限制，您需要合理安排请求频率。
- 杠杆调整: BitMEX允许您动态调整账户的杠杆倍数。通过API，您可以根据市场状况和风险偏好，自动调整杠杆。例如，在波动性较低的市场中提高杠杆以增加潜在收益，而在波动性较高市场中降低杠杆以降低风险。需要注意的是，过高的杠杆倍数会显著放大盈亏，请谨慎使用。
- 触发订单: 触发订单（也称为条件订单）允许您预先设置触发价格，当市场价格达到或超过/低于该触发价格时，系统会自动提交预先设定的订单。常见的触发订单类型包括止损单（Stop Loss Order）、止盈单（Take Profit Order）、以及追踪止损单（Trailing Stop Order）。触发订单是风险管理的重要工具，可以帮助您在市场不利变动时自动止损，或在市场有利变动时锁定利润。
熟练掌握这些高级功能可以显著提升您的交易效率和盈利能力，但也需要对底层机制有深入的理解。建议您仔细阅读BitMEX官方API文档，并通过模拟交易环境进行充分的实践和测试，在真实交易环境中谨慎部署。
程序化交易固然高效，但同时也伴随着潜在的风险。确保您充分理解交易算法的原理，并能够应对可能出现的各种情况，如网络延迟、API故障、以及市场剧烈波动。务必采取适当的风险管理措施，例如设置合理的止损位、控制仓位大小、以及定期监控交易系统的运行状况，才能在瞬息万变的加密货币市场中长期生存并取得成功。
