欧易 API 交易：像高手一样玩转自动化 (仅限 50 人)

如何使用欧易平台的API进行交易

本文将介绍如何使用欧易（OKX）平台的应用程序编程接口（API）进行交易。通过API，您可以编写程序来自动化交易策略，获取市场数据，管理账户等。 本文将涵盖API密钥的申请与配置、常用API接口介绍、交易流程以及一些注意事项。

1. API 密钥申请与配置

要通过欧易 API 进行自动化交易或数据获取，您首先需要创建并配置 API 密钥。API 密钥是您访问欧易 API 的凭证，类似于用户名和密码，但具有更精细的权限控制。请按照以下步骤操作：

1. 登录欧易账户： 访问欧易官方网站（www.okx.com）并使用您的账户凭据登录。确保您已启用双重身份验证以提高账户安全性。
2. 进入 API 管理页面： 成功登录后，将鼠标悬停在页面右上角的账户头像上，在下拉菜单中找到并点击“API”选项，进入 API 管理页面。您也可以在账户设置或安全设置中找到 API 管理入口。
3. 创建 API 密钥： 在 API 管理页面，找到并点击“创建 API”或类似按钮。这将启动 API 密钥创建流程。在创建过程中，您需要为您的密钥设置一个易于识别的名称（例如，“交易机器人”、“数据分析”），并详细配置权限。
4. 选择权限： 权限是 API 密钥安全性的核心。欧易 API 提供了多种权限选项，您必须根据您的实际需求谨慎选择。常见的权限包括：
   • 交易权限： 允许您的应用程序进行下单、撤单、修改订单等交易操作。如果您使用 API 进行自动交易，则必须授予此权限。
   • 提现权限： 允许您的应用程序从您的欧易账户提取资金。 强烈建议您不要授予此权限，除非您对您的应用程序和相关风险有充分的了解。如果您的 API 密钥泄露且具有提现权限，您的资金将面临严重风险。
   • 只读权限： 允许您的应用程序获取账户余额、交易历史、市场数据等信息，但不能执行任何交易或提现操作。如果您只是需要获取数据进行分析，建议仅授予此权限。
   • 资金划转权限: 允许你的应用程序在你的不同账户之间进行资金划转，比如从交易账户划转到资金账户。
   • 合约权限： 允许应用程序进行合约交易相关操作。

   请务必遵循最小权限原则，即只授予您的应用程序所需的最低权限。例如，如果您的应用程序只需要进行交易，则不要授予提现权限。为了进一步提高安全性，您可以为不同的应用程序创建不同的 API 密钥，并为每个密钥分配不同的权限。

5. 绑定IP地址： 欧易允许您将 API 密钥绑定到一个或多个特定的 IP 地址。这意味着只有来自这些 IP 地址的请求才会被接受，从而有效防止未经授权的访问。强烈建议您尽可能将您的 API 密钥绑定到您的服务器或电脑的公共 IP 地址。您可以通过访问类似 "what is my ip" 的网站来查找您的公共 IP 地址。 请注意，如果您使用动态 IP 地址，您可能需要定期更新绑定的 IP 地址。
6. 获取 API 密钥： 成功创建 API 密钥后，您将获得三个关键信息：API Key（公钥）、Secret Key（私钥）和 Passphrase（密码）。 请务必将您的 Secret Key 和 Passphrase 妥善保管，切勿泄露给任何人。 它们是您访问欧易 API 的重要凭证。 API Key 相当于您的账户名，用于标识您的身份；Secret Key 用于对 API 请求进行签名，确保请求的完整性和真实性；Passphrase 是您在创建 API 密钥时设置的密码，用于加密某些敏感的 API 调用，例如提现请求。 请将这些信息存储在安全的地方，例如加密的配置文件或密钥管理系统。
7. 安全提示：
• 开启 Google Authenticator (2FA) 或其他双重验证方式： 这将为您的欧易账户增加一层额外的安全保护，即使您的 API 密钥泄露，攻击者也无法轻易访问您的账户。
• 定期更换 API 密钥： 建议您定期更换 API 密钥，例如每三个月或半年更换一次。这可以降低密钥泄露后造成损失的风险。
• 监控 API 使用情况，及时发现异常活动： 欧易 API 提供了一些监控工具，您可以利用这些工具来监控 API 的使用情况，例如请求频率、请求类型等。如果发现异常活动，例如未经授权的请求或异常的交易行为，请立即采取措施，例如禁用 API 密钥并调查原因。
• 使用 API 限流： 为了防止 API 被滥用，欧易通常会对 API 请求进行限流。请确保您的应用程序能够处理 API 限流，并采取适当的重试机制。
• 阅读并理解欧易 API 文档： 在使用欧易 API 之前，请务必仔细阅读并理解欧易 API 文档，了解 API 的使用方法、参数说明、错误代码等。

2. 常用 API 接口介绍

欧易 API 提供了全面的接口服务，覆盖现货、合约、期权等多种交易类型，以及账户管理、市场数据检索等关键功能。开发者可以通过这些接口高效地访问和操作欧易平台的数据和功能。以下是一些常用的接口及其详细说明：

• 获取账户信息： /api/v5/account/account - 用于查询用户的账户余额、可用资金、冻结资金以及账户权益等详细信息。该接口支持查询不同类型的账户，例如现货账户、合约账户、期权账户等，通过不同的参数设置，可以获取特定账户的详细资产信息。 建议开发者定期调用此接口，监控账户状态，及时调整交易策略。
• 获取订单信息： /api/v5/trade/order - 查询指定订单的详细信息，包括订单状态、订单价格、订单数量、成交数量、手续费等。可以通过订单 ID 查询单个订单，也可以通过交易对和订单状态筛选订单列表。此接口是订单管理的基础，可以帮助开发者了解订单执行情况。
• 下单： /api/v5/trade/order - 创建新的订单。 需要指定交易对、交易方向（买入/卖出）、订单类型（限价/市价/高级限价/冰山委托/时间加权平均价格TWAP）、数量、价格（限价单时）等参数。 不同的订单类型适用于不同的交易场景，开发者需要根据实际需求选择合适的订单类型。 下单接口是进行交易的核心接口，需要仔细设置参数，避免下单错误。
• 撤单： /api/v5/trade/cancel-order - 取消指定的订单。 可以通过订单 ID 取消单个订单，也可以通过交易对和订单状态批量取消订单。 撤单接口可以帮助开发者及时止损或调整交易策略。
• 获取市场数据： /api/v5/market/ticker - 获取指定交易对的最新价格信息，包括最新成交价、最高价、最低价、成交量、买一价、卖一价等。 此接口是获取实时行情数据的最常用接口，可以帮助开发者快速了解市场动态。
• 获取K线数据： /api/v5/market/candles - 获取指定交易对的K线数据，用于技术分析。 K线数据包括开盘价、收盘价、最高价、最低价、成交量等，可以用于绘制K线图，进行技术分析。 可以指定K线的时间周期，例如 1 分钟、5 分钟、1 小时、1 天等。
• 获取交易历史： /api/v5/trade/fills - 获取成交历史记录。 可以查询指定交易对的成交记录，包括成交价格、成交数量、手续费等。 此接口可以帮助开发者分析交易行为，优化交易策略。
• 资金划转： /api/v5/asset/transfer - 进行资金在不同账户之间的划转，例如从交易账户划转到资金账户，或者从现货账户划转到合约账户。 需要指定划转的币种、数量、划转方向等参数。 资金划转接口是进行资金管理的重要接口，可以帮助开发者灵活调配资金。

3. 交易流程

一个典型的使用欧易 API 进行交易的流程涉及多个步骤，从初始化配置到订单管理，都需要精心设计以确保交易策略的有效执行。

1. 初始化： 在程序中配置 API Key、Secret Key 和 Passphrase。API Key 用于标识您的身份，Secret Key 用于签名请求以确保安全性，Passphrase 则是保护 Secret Key 的一道额外屏障。务必妥善保管这些凭据，避免泄露，推荐使用环境变量或加密文件存储，切勿硬编码在代码中。
2. 获取市场数据： 使用 /api/v5/market/ticker 获取最新的市场价格，或使用 /api/v5/market/candles 获取历史 K 线数据。 /api/v5/market/ticker 接口提供特定交易对的最新成交价、买一价、卖一价、24 小时涨跌幅等信息，适合快速了解市场概况。 /api/v5/market/candles 接口则提供指定时间周期的开盘价、最高价、最低价、收盘价和成交量，适用于技术分析。选择合适的时间周期，如 1 分钟、5 分钟、1 小时等，取决于您的交易策略。
3. 分析市场： 根据获取到的市场数据，利用您的交易策略进行分析，确定买入或卖出信号。这可能涉及各种技术指标，例如移动平均线 (MA)、相对强弱指数 (RSI)、移动平均收敛散度 (MACD)、布林带 (Bollinger Bands) 等。根据您的策略设置参数，并结合成交量、深度图等信息，判断市场趋势和潜在的交易机会。
4. 下单： 使用 /api/v5/trade/order 接口发送买入或卖出订单。该接口支持多种订单类型，包括市价单 (Market Order)、限价单 (Limit Order)、止损单 (Stop Order)、跟踪委托单 (Trailing Stop Order) 等。您需要指定交易对 (如 BTC-USDT)、交易方向 (买入或卖出)、订单类型、数量和价格等参数。对于限价单，指定价格是订单成交的最低或最高价格。对于市价单，交易所会以当前最佳价格立即成交。考虑滑点和手续费的影响，合理设置价格，提高订单成交的概率。
5. 查询订单状态： 使用 /api/v5/trade/order 接口查询订单的执行状态。订单可能处于以下状态： open (挂单中，尚未成交), partially_filled (部分成交，部分订单已成交), filled (完全成交，订单全部成交), canceled (已撤销，用户主动撤销或因故被系统撤销), expired (已过期，订单在指定时间内未成交而失效)。及时查询订单状态，可以了解订单的执行情况，并根据需要进行调整，例如撤单或修改订单价格。
6. 撤单（可选）： 如果订单长时间未成交，尤其是在市场波动剧烈时，您可以使用 /api/v5/trade/cancel-order 接口取消订单。及时撤单可以避免因价格大幅波动而造成的损失。在撤单前，请仔细评估市场情况和您的交易策略，避免盲目撤单。
7. 重复循环： 重复上述步骤，持续监控市场并进行交易。这需要一个自动化系统，能够实时获取市场数据，分析市场情况，下单和管理订单。设置合理的风险管理策略，例如止损和止盈，可以有效控制交易风险。定期审查和优化您的交易策略，以适应不断变化的市场环境。

4. 代码示例 (Python)

以下是一个使用 Python 语言和 requests 库向加密货币交易所发送POST请求进行下单的示例代码。该代码演示了如何生成符合交易所要求的签名，并构建包含必要认证信息的请求头。

import requests import time import hashlib import hmac import base64

API_KEY = 'YOUR_API_KEY' # 替换为你的API密钥 SECRET_KEY = 'YOUR_SECRET_KEY' # 替换为你的密钥 PASSPHRASE = 'YOUR_PASSPHRASE' # 替换为你的口令 BASE_URL = 'https://www.okx.com' # 或者 'https://okx.com'，根据交易所API文档选择

def generate_signature(timestamp, method, request_path, body, secret_key): """生成 API 签名。 不同的交易所生成签名的方式可能不同，需要仔细阅读API文档。 通常涉及将时间戳、请求方法、请求路径和请求体组合后进行哈希运算，然后用Base64编码。 """ message = timestamp + method + request_path + body mac = hmac.new(bytes(secret_key, encoding='utf8'), bytes(message, encoding='utf-8'), hashlib.sha256) d = mac.digest() return base64.b64encode(d).decode()

def post_request(endpoint, data): """发送 POST 请求。 此函数封装了发送HTTP POST请求的逻辑，包括设置必要的头部信息，如API密钥、签名、时间戳和口令。 """ timestamp = str(int(time.time())) method = 'POST' request_path = endpoint body = str(data) # 将数据转换为字符串 signature = generate_signature(timestamp, method, request_path, body, SECRET_KEY) headers = { 'OK-ACCESS-KEY': API_KEY, 'OK-ACCESS-SIGN': signature, 'OK-ACCESS-TIMESTAMP': timestamp, 'OK-ACCESS-PASSPHRASE': PASSPHRASE, 'Content-Type': 'application/' # 指定内容类型为JSON，根据API文档调整 } url = BASE_URL + endpoint response = requests.post(url, headers=headers, data=body) # 使用 data 参数发送 JSON 数据 return response.text # 返回响应体的内容

下单示例

创建交易订单，需要构造包含必要参数的订单数据字典。以下示例展示了一个用于在BTC-USDT交易对上进行币币交易的限价买单。

order_data = { 'instId': 'BTC-USDT', # 交易对，指定交易的币对，例如：BTC-USDT，表示比特币兑换USDT。务必保证交易对的准确性，避免交易到错误的币种。 'tdMode': 'cash', # 交易模式，'cash'代表币币交易，也称为现货交易。平台可能支持其他交易模式，如'cross' (全仓杠杆) 或 'isolated' (逐仓杠杆)，需根据实际情况选择。 'side': 'buy', # 交易方向，'buy'表示买入，'sell'表示卖出。根据你的交易意图选择正确的方向。 'ordType': 'limit', # 订单类型，'limit'表示限价单。限价单允许你指定买入或卖出的价格，只有当市场价格达到或优于你指定的价格时，订单才会成交。其他常见的订单类型包括'market' (市价单)等。 'sz': '0.001', # 数量，表示你想买入或卖出的币的数量。对于BTC-USDT交易对，单位通常是BTC。请注意，交易平台可能对最小交易数量有限制，需要满足平台的最小交易量要求。 'px': '26000', # 价格，表示你希望买入或卖出的价格。对于限价单，只有当市场价格等于或低于(买单)或高于(卖单)此价格时，订单才会成交。价格的精度需要符合交易平台的规定。 'posSide': 'long' # 持仓方向，'long'表示多头持仓，即预期价格上涨。'short'表示空头持仓，即预期价格下跌。此参数在单边持仓模式下使用。如果是双边持仓模式，则不需要指定此参数。 }

创建好订单数据后，需要调用交易平台的API接口提交订单。以下展示了如何使用 post_request 函数发送POST请求来创建订单。请确保你已经正确配置了API密钥和请求签名。

endpoint = '/api/v5/trade/order' response = post_request(endpoint, order_data) print(response)

其中， endpoint 指定了创建订单的API接口地址。 post_request 是一个自定义的函数，用于发送带有订单数据的POST请求到指定的API接口。 response 是API返回的响应数据，包含了订单创建的结果，例如订单ID、错误代码等。你需要检查 response 的内容来确认订单是否成功创建。

请注意：

• 请务必使用您自己的 API 密钥、私钥和密码短语替换代码中的占位符： YOUR_API_KEY , YOUR_SECRET_KEY 和 YOUR_PASSPHRASE 。 这些密钥用于验证您的身份并授权访问您的交易账户。 API 密钥允许您通过程序与交易所交互，私钥用于对交易进行签名，确保交易的安全性，而密码短语则作为额外的安全层，保护您的私钥不被未经授权的访问。请妥善保管您的API密钥等信息，切勿泄露给他人。
• 提供的代码仅为演示目的的示例代码，旨在展示如何使用 API 进行交易。 您需要根据您的具体需求和交易策略修改和完善代码，以满足您的特定目标。 例如，您可能需要调整交易参数、添加错误处理机制、以及集成风险管理策略。 请仔细审查并理解代码的每一部分，确保其符合您的预期行为。
• 在将此代码应用于真实的交易环境之前， 强烈建议您在一个受控的测试环境中进行彻底的测试和验证。 使用模拟账户或测试网络可以帮助您识别潜在的问题和错误，而不会造成实际的资金损失。 模拟交易允许您在无风险的环境中评估代码的性能和稳定性。 在测试过程中， 请监控交易执行情况、分析交易结果，并根据需要进行调整。
• posSide 参数对于指定您的仓位方向至关重要。 其取值取决于您的账户配置和交易模式。 如果您使用单边持仓模式，则 posSide 参数应设置为 long （做多）或 short （做空），分别代表买入和卖出。 如果您使用双向持仓模式（也称为套保模式），则 posSide 参数应设置为 net ，代表净持仓方向。 请务必确保 posSide 参数与您的仓位模式保持一致， 否则可能导致意外的交易结果。 错误的 posSide 设置可能会导致您的交易方向与您的预期相反，从而造成损失。 仔细检查您的账户设置和交易模式，并相应地配置 posSide 参数。

5. 注意事项

• 安全第一： 务必将您的 API 密钥视为最高机密，采取一切必要的安全措施妥善保管，例如使用加密存储、定期更换密钥等，切勿以任何形式泄露给未经授权的个人或实体。 妥善保管 Secret Key，它是找回API Key 的唯一凭证。
• 频率限制： 欧易 API 对每个接口都设有严格的频率限制，旨在保护系统稳定性和公平性。请务必遵守官方 API 文档中关于频率限制的详细规定，不同接口的限制可能不同，包括每秒请求次数、每分钟请求次数等。在高频交易场景下，更要精心设计程序逻辑，合理控制请求频率，避免触发频率限制导致访问受阻。如果需要更高的频率限制，请联系欧易官方申请。
• 错误处理： 在程序中构建健壮的错误处理机制至关重要。 全面捕获 API 请求可能返回的各种错误码，并根据不同的错误类型采取相应的处理措施，例如重试、记录日志、发送警报等。 这有助于及时发现和解决潜在问题，确保程序的稳定运行和交易的顺利进行。 参考欧易API文档的错误代码章节可以帮助你更好地进行错误处理。
• 测试环境： 在真实交易部署前，务必在欧易提供的模拟盘（也称为沙盒环境或测试网）中进行全面而充分的测试。 通过模拟盘环境，可以模拟真实的市场行情和交易行为，验证程序的逻辑正确性、性能表现和风险控制能力。 请务必模拟各种交易场景和异常情况，例如网络延迟、服务器故障、行情波动等，以确保程序在真实环境中能够稳定可靠地运行。 欧易模拟盘环境提供了与真实环境几乎一致的功能和数据，是进行 API 开发和测试的理想选择。
• 阅读文档： 深入研读欧易官方 API 文档，是成功使用 API 的基础。 仔细了解每个接口的详细参数、返回值、数据结构、请求方式和错误代码等信息。 熟悉文档中关于认证授权、频率限制、签名算法、数据格式等方面的规定。 定期关注文档更新，及时了解 API 的最新功能和变化。 欧易官方 API 文档是您使用 API 的最权威、最全面的参考资料。
• 资金安全： 使用 API 进行交易存在一定的风险，请务必保持高度的谨慎。 充分了解 API 交易的潜在风险，例如程序错误、网络攻击、市场波动等。 严格控制交易权限，例如限制 API 密钥的提币权限。 设定合理的止损策略，防止出现意外损失。 对自己的资金安全负责，并根据自身风险承受能力谨慎操作。
• 签名验证： 确保您实现的签名算法与欧易官方文档中描述的算法完全一致。 仔细检查签名算法的每个步骤，包括参数排序、字符串拼接、哈希计算、编码方式等。 使用欧易提供的签名验证工具或示例代码进行验证，确保您的签名能够通过验证。 错误的签名会导致 API 请求被拒绝，因此请务必重视签名验证的正确性。
• 网络连接： 稳定且低延迟的网络连接是进行 API 交易的先决条件。 尽量选择靠近交易所服务器的网络节点，以减少网络延迟。 使用可靠的网络服务提供商，确保网络连接的稳定性。 定期检查网络连接状况，及时发现和解决网络问题。 不稳定的网络连接可能导致交易失败或数据丢失，因此请务必重视网络连接的质量。