欧易 API 常见问题

发布于 2024年9月20日更新于 2026年8月26日阅读时长 8 分钟144
以下内容可能不适用于所有用户
请先 登录账号,以确认本文内容是否适用于您。

“Passphrase”指的是什么?

这是您申请 API key 时填写的密码。您需要自行记住它。一旦忘记,无法找回,您需要创建新的 API key。

我如何创建 API key?

App 端:

  1. 登录欧易账号 — 点击左上角的九宫格 — 往下滑,点击【API】—【创建 API key】。

  2. 填写【备注名】—点选【账户】及【用途】— 输入【IP 地址白名单】— 点选【权限】— 输入【密码短语】。

Web 端:

  1. 登录欧易账号 — 点击右上角的头像 —【API 与连接】—【创建 API key】。

  2. 填写【备注名】—点选【账户】及【用途】— 输入【IP 地址白名单】— 点选【权限】— 输入【密码 (Passphrase)】。

注意:

  • IP 地址有助于保护您的 API key 安全。每个 key 最多可关联 20 个地址,关联时请使用逗号或空格将其分隔。

  • 密码短语是调用 API 接口的必要参数,以增强 API 安全性。请您妥善保管,如遗失请重新创建 API。

我如何管理或编辑 API key?

在欧易管理或编辑您的API key:

  1. 登录您的欧易账号,进入 个人资料 > API

  2. 您将看到您现有的 API 密钥列表。点击您想要管理的那个。

  3. 您可以从这里进行:

    • 查看 API key 名称、权限和关联的 IP 白名单。

    • 编辑密钥名称、权限(读取、交易、提币)或绑定的IP地址。

    • 如果不再需要,请删除该密钥。

注意:创建后您无法查看助记词。如果丢失,您需要删除现有密钥并重新创建。请务必妥善保管您的凭证。

如果我使用 API 进行交易,如何区分是现货交易还是杠杆交易?

现货和杠杆交易在 API 中的区分方式可能因您的账户类型和设置而异。我们建议您参考欧易 API 文档,以获取适用于您账户设置的最准确和最新的参数。

如果您需要进一步的说明,请联系欧易智能客服,获取个性化指导。

我如何创建一个演示磁盘 API key?

要在模拟盘 API 上进行交易,您需要在模拟盘上创建一个 API key。请按照以下步骤操作:

登录您的欧易账号 > 交易 > 模拟交易 > 个人中心 > 创建模拟账户 API key > 开始模拟交易

API key 会过期吗?

未绑定IP且具有交易或提币权限的API密钥,在14天无活动后将被自动删除。如果API密钥用于调用需要身份认证的私有或账户相关接口(如查看账户余额、账单数据或下单),则不会被视为无活动状态。

只有绑定了 IP 或特定权限的只读 API 密钥才不会过期。

借币、赚币和划转权限是什么?

  • 划转: 允许密钥在您的账户之间划转资金。适用于所有账户。

  • 借币: 允许该密钥借币、还币及管理借币。仅当您的账户具备相应功能资格时可见。

  • 赚取: 允许该密钥订阅和赎回赚取产品。仅当您的账户具备所需功能资格时可见。

如果您的 API Key 之前已启用交易权限,则在此次更新后,所有三项权限将自动激活,无需手动设置。

通过界面下单时,可以以货币单位下单吗?

不;对于合约委托,界面默认以合约数量为单位。如果您需要计算合约数量与代币之间的转换,可以参考合约与代币转换接口,详情见这里

如何获取界面的波动率?

界面无法直接获取价格涨跌,但可以通过计算公式计算得出。

最新交易价格相较于24小时前K线开盘价的涨跌幅度,除以24小时前K线开盘价的100%。

上述期货数据可通过市场接口此处获取。

下单时出现“51000 Parameter posSide error”错误提示的原因是什么?

您需要先检查账户模式;买卖模式/开仓和平仓模式,可在此处查看以获取 posMode。

注意:

  • 在使用合约开仓和平仓以及下单时,必须填写 posSide 参数,且填写做多或做空。

  • 如果是买卖模式,或者在开仓和平仓模式下进行数字货币或杠杆交易,posSide 仅支持净额或不传输。

哪个接口可以用来获取合约面值和最小委托数量?

您可以使用该界面获取交易产品的基本信息,详情请见这里

合约面值:ctVal,最小委托数量:minSz。

instId 的格式是什么?

您可以直接使用界面在此处获取交易产品的基本信息。

如何设置止损和止盈?

如果订单附加了止盈止损,您可以参考订单界面 这里:attachAlgoOrds 数组参数。

但是,如果是单独的委托止损,您可以参考策略返佣界面,详情请见这里

为什么设置止盈和止损的触发价格时会报错:51046、51047、51048、51049?

设置止损触发价格/止盈触发价格的规则——在卖出时,止盈触发价格高于最新交易价格,止损触发价格低于最新交易价格;在买入时,止盈触发价格低于最新交易价格,止损触发价格高于最新交易价格。

“接口错误:50102 时间戳请求已过期”是什么意思?

此错误发生在时间戳已过期时。您需要调用系统时间接口,将本地时间与我们服务器的时间同步。保持时间差在30秒以内有助于避免此问题。

注意:请求头中的时间为 UTC0。调用服务器时间接口时,时间以 UTC+8 提供。

“接口错误:50101 APIKey 与当前环境不匹配”是什么意思?

这是由于 API key 与当前环境不匹配所致。真实账户调用需要使用真实账户的 API key,且请求头中的 x-simulated-trading 参数值需为 0。模拟账户调用需要使用模拟账户的 API key,且请求头中的 x-simulated-trading 参数值需为 1。

“接口错误:51010 当前账户模式下请求不支持”是什么意思?

这与您的账户模式有关。如果您想使用单一货币杠杆或合约,您需要调整为除现货模式外的其他三种模式!您可以通过界面设置这里进行设置,或者在网页版或APP上进行设置。

注意:第一个设置必须在交易页面主菜单的设置选项中进行;账户模式。

“界面错误:51121 委托数量必须是批量大小的整数倍”是什么意思?

在 API 中,合约订单以张为单位,且必须是币对最小委托数量的整数倍。最小委托数量可通过产品接口的 minSz 字段获取,详情见这里

“提币错误:58207 提币地址未在认证豁免白名单中”;为什么在提币页面关闭白名单认证后,仍然报告错误?

要通过 API 接口提币,需在页面添加提币地址并勾选“非 Visa 认证”按钮。页面上的白名单认证是否开启不会影响接口功能。

“接口错误:50004 API端口请求超时”是什么意思(这不表示请求成功或失败,请检查请求结果)?

50004 错误通常是由于服务器压力过大引起的。每天的 8 点、16 点和 24 点是收取资金费用的时间点,此时服务器压力较大。建议避开这些时间段进行交易。如果在其他时间出现 50004 错误,可以稍后重试。如果下单时出现 50004 错误,这并不代表接口请求的实际结果,请求可能成功也可能失败。请以实际结果为准。

“50119 API key 不存在”错误是什么意思?

此错误通常发生在您的账户域与您的地区不匹配时。

  • 对于 EEA 用户,请将您的 API 请求域名更改为 eea.okx.com,而非 www.okx.com

  • 对于 美国用户,请将您的 API 请求域名更改为 us.okx.com,而非 www.okx.com

  • 如果您使用第三方软件连接欧易并看到此错误,请与软件提供商确认其是否支持区域域名。例如,欧洲经济区(EEA)用户必须通过 eea.okx.com 连接,否则请求将失败。

为什么绑定第三方软件时会显示错误“50110”?

如果当前的API key类型与第三方软件绑定不兼容,可能会出现此错误。请尝试申请API key的交易类型,且不绑定IP列表,然后重新连接第三方软件。

我如何获取某个币对的最新交易价格?

有关币种信息,请使用此处,有关单个币种信息,请使用此处。币种接口用于批量获取币对的最新交易价格,ticker接口用于获取单个币对的最新交易价格。

币种部分中最新成交价响应参数示例

创建 API key 的要求是什么?

创建 API 密钥需要最低 100 美元的资产管理规模(AUM)余额。

  • 需要 AUM 大于 100 美元(AUM > 100U)才能创建 API 密钥

  • 对于主账户或子账户,只有 AUM > 100U 的账户才可以创建 API 密钥

如果 WebSocket 无法连接或频繁断开,我该怎么办?

请确认您正在使用正确的 WebSocket URL 连接您的网站和 API 服务。检查您的网络、代理、TLS 设置、订阅参数、Ping/Pong 心跳以及重连逻辑。如果问题仍然存在,请提供频道、发生时间、完整错误信息和已脱敏的日志。

我应该如何排查 API 错误代码或无效请求参数?

在您网站的官方 API 文档中查找错误代码,然后认证端口、HTTP 方法、请求参数、账户模式和产品限制。如果原因仍不明确,请提供完整的错误代码、sCode/sMsg、发生时间以及已脱敏的请求和响应。

为什么我的 API 委托下单、修改或取消失败?

请使用 API 返回的错误消息和错误代码来确定具体原因。如果您不确定错误的含义,请提供完整的请求参数和错误详情,以便我们进一步调查。

如果市场数据、K线图或订单表数据看起来不正确,我应该怎么办?

确认频道名称、instId、订阅参数和请求频率,并区分快照数据与增量更新。对于订单表,还需验证序列ID和时间戳。如果数据似乎缺失,请记录频道、时间范围和已脱敏的原始响应。

为什么API中的余额、仓位或保证金数值与网站或应用程序显示的不同?

首先区分交易账户和资金账户,然后认证账户模式、货币维度、端口和数据更新时间。对于余额、仓位和保证金的计算,请使用适用于该站点的最新产品和API文档。

如果API充入、提币或划转失败,我该怎么办?

检查 API 权限、货币、网络、目标账户以及任何地址簿或白名单要求,然后根据返回的错误代码进行故障排除。账户安全、合规或风险限制可能需要相关站点的客服进一步审核。

如何为子账户创建和使用 API key?

在目标子账户下创建 API key,并使用该子账户的权限、密码短语和站点域名。请勿混用主账户和子账户的 API Key、Secret 或密码短语。

触发 API 速率限制后我应该怎么办?

根据特定端口的限制减少请求速率,并在适当情况下使用请求排队、指数退避或批量端口。速率限制的范围和配额可能因端口而异,因此不要假设所有端口共享相同的配额。

我在哪里可以找到 API 文档、SDK 和代码示例?

API 文档(V5)— www.okx.com/docs-v5/en。REST + WebSocket 参考,更新日志,错误代码,每个端口的请求/响应示例。官方 SDK(GitHub)— github.com/okxapi 代码示例可在 SDK 中找到。

如果页面显示“API无法使用”,我应该提供哪些信息?

请提供端口、HTTP 方法、预期操作、完整的错误代码或消息、发生时间、账户站点、网络环境,以及已脱敏的请求和响应。切勿发送 API Secret、Passphrase、认证码或未脱敏的签名。

注意:

如果您对 WebSocket 或其他 API 相关主题有疑问,请点击文章链接,并使用欧易 App 扫描文章底部的二维码,加入群组,与我们的 API 支持专家联系。

如何扫描:在应用中,点击九宫格图标 > 扫描图标,然后扫描二维码。