您现在的位置是：首页 > 论坛

欧易数字货币交易所API文档与认证机制介绍

时间：2025-02-20 10:43:43 分类：论坛浏览：91

欧易数字货币交易所 API 文档

API 概述

欧易数字货币交易所为开发者提供了一套功能丰富且高效的 API 接口，使得外部系统能够与交易所平台进行无缝集成。通过这些 API，开发者可以轻松实现对交易所多种核心功能的调用，包括但不限于自动化交易、实时市场数据查询、账户余额查看、订单管理、资产转账等操作。这些 API 接口支持多种请求方式，如 GET、POST、PUT 和 DELETE，能够满足不同应用场景的需求。

为了确保高效的数据传输和低延迟，欧易交易所的 API 采用了广泛应用的 RESTful 架构风格，使得调用方式简洁、灵活且易于理解。同时，所有接口均通过 HTTPS 协议进行加密传输，保证了数据的安全性和隐私保护。

通过使用这些 API，用户不仅能够实时获取市场行情、最新的交易对信息、深度数据，还能执行基于特定策略的自动交易，或通过第三方应用与交易所进行无缝对接。API 还支持 WebSocket 协议，提供实时数据流功能，能够帮助开发者实现高频交易、动态行情监控等更为复杂的需求。

这些 API 还包含了完善的认证机制，用户需要通过 API 密钥和签名等方式确保调用的安全性。无论是在开发个人交易机器人，还是进行资产分析和管理，欧易交易所的 API 都为开发者提供了强大的支持。

认证机制

为了保障 API 的安全性和确保精确的权限管理，欧易数字货币交易所采用了严格的 API Key 认证机制。这种认证方式能够有效地防止未经授权的访问，并确保只有经过授权的用户能够执行特定的操作。每个 API 请求都必须附带有效的 API Key 和 Secret 密钥，这两者是识别用户身份、验证请求权限以及确保通信安全的核心元素。

API Key 是由欧易交易所为每个用户生成的唯一标识符，它用于标识请求发起者并关联到特定的账户。而 Secret 密钥则是一个密文字符串，必须与 API Key 配对使用，并且应当始终保密。用户在请求时，必须在请求头或请求体中提供这两个参数，才能成功通过认证。

为了进一步提升安全性，欧易交易所还支持 IP 白名单功能。用户可以通过设置 IP 白名单来限制仅允许来自特定 IP 地址的请求访问 API，从而有效降低潜在的安全风险。API Key 和 Secret 的生成、管理与使用过程中，建议用户定期更新密钥，避免长时间使用相同的认证信息，减少因密钥泄露而导致的安全威胁。

该认证机制不仅有助于保护用户的账户安全，还能够提供细粒度的权限控制。用户可以根据实际需求配置不同级别的 API 权限，限制特定的操作或数据访问权限，从而降低因权限滥用或错误配置所带来的风险。

获取 API Key

登录到您的欧易交易所账户。确保您已经完成账户验证和其他相关设置。
在登录后，导航至网站顶部菜单或账户设置区域，找到并进入【API 管理】页面，点击页面上的“创建 API Key”按钮，以开始创建新 API Key。
在创建 API Key 的过程中，您需要为该 API Key 输入一个清晰且易于识别的名称，以便后续管理。接着，您需要根据需求设置该 API Key 的权限，例如选择“仅查询权限”以查看市场数据，或“交易权限”以执行买卖操作。确保只授予必要的权限，以最大限度地减少安全风险。
完成 API Key 名称和权限设置后，点击“创建”按钮，系统会自动生成一个独一无二的 API Key 和对应的 Secret Key。请妥善保存这两个密钥，因为 Secret Key 仅会显示一次，丢失后无法找回。

API 请求签名

对于所有需要进行身份验证和安全保护的接口，客户端必须在请求中提供有效的签名信息。该签名用于确认请求的合法性以及数据未被篡改，防止恶意用户伪造请求或篡改请求数据。签名的生成规则如下：

将请求中的所有参数按照字典顺序进行排序，确保每次请求的参数顺序一致。排序时需考虑所有的查询参数，包括路径参数、查询字符串等。
接着，使用 & 符号连接所有排序后的参数。每个参数键值对之间的连接格式应为 key=value ，不同的参数键值对之间用 & 分隔。
在拼接后的签名字符串末尾，追加 API Secret，确保 API Secret 的保密性和唯一性。该 API Secret 是在注册应用时由服务端提供的一个密钥，具有唯一性并且必须妥善保管。
对拼接后的字符串使用 HMAC-SHA256 算法进行加密，使用 API Secret 作为密钥进行签名。该加密过程能够确保请求数据的完整性和真实性，从而防止外部篡改或伪造请求。

以下是生成签名的请求示例：

plaintext
GET /api/v1/account

签名计算方法：

plaintext
signature = HMAC SHA256(api secret, query_string)

其中， api_secret 是你的私密密钥， query_string 是按照上述规则生成的排序并连接后的请求字符串。

例如，如果请求的 URL 是 GET /api/v1/account?user_id=123&timestamp=1617978000 ，首先将参数 user_id=123 和 timestamp=1617978000 按照字典顺序排序为 timestamp=1617978000&user_id=123 ，然后再与 API Secret 拼接进行 HMAC-SHA256 签名。

账户接口

欧易平台提供了一系列账户相关的API接口，旨在为用户提供高效、安全的账户信息管理和余额查询服务。这些接口涵盖了账户的各个方面，包括余额查询、账户信息修改、资产管理、交易记录查询等，旨在为开发者和用户提供灵活的操作方式。通过这些接口，用户可以实时获取账户的最新状态，查询各类资产余额，管理账户安全设置，以及处理交易和资金划转等操作。接口的使用可以帮助用户更加便捷地管理账户资产，支持更高效的资金调度和资产监控。同时，所有账户接口均符合高标准的安全协议，确保账户操作的安全性和数据的隐私保护。

获取账户信息

接口描述：此接口用于获取当前用户账户的详细基本信息，包括用户ID、电子邮件地址以及账户状态。用户可以通过此接口查询其账户的相关信息，便于在系统中进行后续操作或进行账户管理。

请求方式： GET

请求示例：

http
GET /api/v1/account

请求参数：该接口不需要额外的请求参数，仅需提供有效的身份认证信息（如Token或API密钥），以确保请求的合法性与安全性。

响应示例：

成功响应示例：

{
  "code": 200,
  "msg": "success",
  "data": {
    "user_id": 12345,
    "email": "[email protected]",
    "status": "active"
  }
}

响应字段说明：

code : 状态码，200表示请求成功。
msg : 提示信息，"success"表示操作成功。
data : 包含账户信息的主体数据对象。
user_id : 用户的唯一标识符。
email : 用户注册时绑定的电子邮件地址。
status : 用户账户的当前状态，可能的值包括"active"（激活）、"inactive"（未激活）、"suspended"（暂停）等。

错误响应示例：

{
  "code": 401,
  "msg": "Unauthorized",
  "data": null
}

响应说明：

401 Unauthorized : 未授权，用户未提供有效的身份认证信息。
403 Forbidden : 禁止访问，当前用户无权限查看该账户信息。
500 Internal Server Error : 服务器内部错误，通常表示请求处理过程中出现异常。

注意事项：调用此接口时，必须确保用户身份已通过有效的身份验证机制进行认证，且账户未被冻结或被暂停。对于频繁调用该接口的请求，可能会受到系统的访问频率限制。

获取账户余额

接口描述：此接口用于查询用户在交易所账户中的资产余额，支持多种数字货币的查询，能够帮助用户及时了解其账户的资金状况。通过该接口，用户可以获取到包括主流数字货币如比特币（BTC）、以太坊（ETH）、稳定币如Tether（USDT）等在内的所有支持的资产类型的余额信息。

请求方式： GET

请求路径：该接口通过GET请求方式访问，路径为：

GET /api/v1/asset/spot

请求参数：该接口无需传入额外参数，仅需用户认证信息（如API密钥）即可访问。

响应示例：

成功时，响应返回的结果如下：

{
  "code": 200,
  "msg": "success",
  "data": {
    "BTC": "1.2",
    "ETH": "5.4",
    "USDT": "1000.0"
  }
}

响应字段说明：

code ：响应状态码，200表示成功。
msg ：返回的消息，"success"表示请求成功。
data ：包含实际资产信息的对象，键为各个币种的名称，值为对应币种的余额。
BTC ：比特币的余额。
ETH ：以太坊的余额。
USDT ：Tether（USDT）的余额。

注意：返回的数据结构可能根据交易所的不同而有所调整，但通常会遵循类似的格式。

市场数据接口

欧易提供了一个高效且精准的实时市场数据接口，旨在为用户提供各类数字货币的最新行情信息，包括但不限于价格、交易量、买卖深度、最新成交等关键数据。用户可以通过该接口获取多种交易对的即时信息，支持包括比特币、以太坊、莱特币等主流数字货币在内的多种加密资产的行情数据。数据接口具备高并发支持，可以满足大流量的实时查询需求，确保用户能够在最短时间内获取到准确的市场动态。

除了基础的市场价格数据，接口还提供了丰富的深度信息，包括当前市场买卖盘的挂单深度、买盘与卖盘的差价、交易对的24小时涨跌幅、最新成交的价格与数量等细节，帮助用户及时分析市场走势及价格波动。接口还支持历史数据查询，用户可以追溯过去一段时间内的市场变化情况，进行技术分析、趋势预测等高级操作。

该市场数据接口不仅适用于个人投资者，也为专业交易者、量化交易系统、以及第三方开发者提供了强大的数据支持。通过标准化的API接口，用户可以便捷地将欧易的市场数据集成到自有的系统、平台或应用中，进行实时监控和分析，帮助提升交易策略的准确性与执行效率。

获取市场行情

接口描述：此接口用于查询指定交易对的最新市场行情信息，包括当前的最高价、最低价、最新成交价、24小时成交量和价格变化幅度等。这些数据可以帮助用户实时了解市场动态，进行更准确的交易决策。

请求方式： GET

请求示例：

http
GET /api/v1/market/ticker?symbol=btcusdt

响应示例：

{ "code": 200, "msg": "success", "data": { "symbol": "BTCUSDT", "high": "45000.00", "low": "43000.00", "last": "44000.00", "vol": "1000.0", "change": "5.5" } }

字段说明：

symbol : 交易对的标识符，通常由两种加密货币的简称组成，例如 "BTCUSDT" 代表比特币与Tether稳定币的交易对。
high : 指定交易对在过去24小时内的最高成交价格。
low : 指定交易对在过去24小时内的最低成交价格。
last : 最近一次的成交价格，是当前市场的最新价格。
vol : 过去24小时内指定交易对的总成交量，通常单位为基础货币（例如比特币、以太坊等）。
change : 当前价格与24小时前价格的涨跌幅度，通常以百分比表示。若为正值，表示价格上涨；若为负值，则表示价格下跌。

响应状态码说明：

200 : 请求成功，返回的数据有效。
400 : 请求参数错误或缺失，可能是参数格式不正确或交易对不存在。
500 : 服务器错误，通常表示API服务器遇到异常情况。

注意事项：

接口返回的数据实时性较强，但受限于网络延迟及交易所的API更新频率，数据可能会略有滞后。
某些交易对可能会因市场流动性不足而无法获取行情数据。
若请求频率过高，可能会受到API的访问限制或被临时封禁。

获取市场深度

接口描述：此接口用于获取指定交易对的买卖盘深度信息，提供市场的实时买入与卖出挂单情况。市场深度是衡量市场流动性的重要指标，通常用于了解当前市场供需情况，并帮助交易者做出更为精准的交易决策。

请求方式： GET

请求URL：

/api/v1/market/depth 用于获取指定交易对的市场深度信息。

请求参数：

symbol (必填): 交易对名称，格式为币种对。例如， btcusdt 表示比特币对美元的交易对。

请求示例：

GET /api/v1/market/depth?symbol=btcusdt

响应示例：

成功响应示例：

{

"code": 200,

"msg": "success",

"data": {

"bids": [

["44000.00", "0.5"],

["43950.00", "0.3"]

],

"asks": [

["44100.00", "0.4"],

["44200.00", "0.6"]

]

}

响应字段说明：

code : 响应代码，200表示请求成功。
msg : 响应消息，成功时返回“success”。
data : 响应数据，包含买卖盘的具体信息。
bids : 买盘信息，按价格从高到低排列，每个数组元素由两个部分组成：买入价格和买入量。例如：["44000.00", "0.5"]表示以44000美元的价格买入0.5个BTC。
asks : 卖盘信息，按价格从低到高排列，每个数组元素由两个部分组成：卖出价格和卖出量。例如：["44100.00", "0.4"]表示以44100美元的价格卖出0.4个BTC。

注意事项：

返回的数据表示市场深度的实时状态，可能随时变化。
每个交易对的深度信息都会根据不同的市场需求和挂单数量实时更新。
该接口可用于分析市场的流动性、价格趋势和可能的价格波动。

交易接口

交易接口是数字资产交易平台与用户之间的核心交互枢纽，扮演着至关重要的角色，允许用户与市场进行高效的资产交换。它不仅支持传统的现货交易，还包括了杠杆交易、期货交易、期权交易等多种交易模式，满足不同类型投资者的需求。通过交易接口，用户可以实时获取市场行情、提交买卖订单、查看交易历史，并进行资金管理。随着加密货币市场的发展，交易接口的功能也在不断优化，许多平台已经引入了更为先进的算法和技术，提升交易执行的速度和精度，减少交易延迟，确保用户能够及时响应市场波动，抓住投资机会。

下单

接口描述：该接口允许用户提交市场订单，以便进行数字货币交易。通过调用此接口，用户可以指定交易对、买卖方向、订单类型、价格及数量等信息，系统将根据用户提供的参数生成订单并提交到交易平台进行处理。

请求方式： POST

请求示例：

POST /api/v1/order

请求参数：

{
  "symbol": "btcusdt",
  "side": "buy",
  "type": "limit",
  "price": "44000.00",
  "quantity": "0.1"
}

参数说明：

symbol ：交易对的符号，格式为“基础货币-计价货币”，例如“btcusdt”表示比特币对美元的交易对。
side ：订单的方向，取值为“buy”表示买入，“sell”表示卖出。
type ：订单类型，常见的类型包括“limit”表示限价单，“market”表示市价单。
price ：限价单时填写价格，表示买入或卖出的价格。当订单类型为市价单时，该字段不需要传递。
quantity ：订单数量，表示用户要买入或卖出的数字货币数量。

响应示例：

{
  "code": 200,
  "msg": "success",
  "data": {
    "order_id": 123456789,
    "status": "open"
  }
}

响应参数说明：

code ：响应码，200表示请求成功，其他数字表示不同的错误代码。
msg ：返回的消息，通常为“success”表示操作成功，其他消息则为错误信息或说明。
data ：包含订单的详细信息，包括：
- order_id ：生成的订单ID，是唯一标识订单的数字。
- status ：订单状态，常见的状态有“open”表示订单已创建但未完成，“filled”表示订单完全成交，“canceled”表示订单已取消等。

补充说明：用户在提交订单时，如果订单类型为限价单，则必须填写价格；若订单类型为市价单，则系统将根据当前市场价格自动匹配订单。数量字段应符合交易对的最小下单单位要求，否则可能会返回错误。

查询订单状态

接口描述：该接口用于查询指定订单的当前状态，提供订单的详细信息，帮助用户了解订单的处理进度。通过此接口，用户可以获取包括订单ID、交易对、订单状态、已成交数量和成交价格等信息，以便实时监控订单执行情况。

请求方式： GET

请求示例：

http
GET /api/v1/order?order_id=123456789

请求参数：

order_id （必填）：订单的唯一标识符，用于查询特定订单的状态。

响应示例：

{ "code": 200, "msg": "success", "data": { "order_id": 123456789, "symbol": "BTCUSDT", "status": "filled", "filled_quantity": "0.1", "price": "44000.00" } }

响应参数说明：

code ：返回的状态码，200表示成功。
msg ：返回的信息，成功时为“success”。
data ：包含订单的详细信息。
- order_id ：订单的唯一标识符。
- symbol ：交易对，例如“BTCUSDT”表示比特币与美元的交易对。
- status ：订单状态，如“filled”表示订单已完全成交；其他可能的状态包括“open”表示订单未成交，“partially_filled”表示订单部分成交等。
- filled_quantity ：已成交的数量，单位与交易对一致。此例中已成交0.1个BTC。
- price ：订单的成交价格，本示例中为44000.00 USDT。

接口返回的订单状态信息有助于用户判断是否需要采取进一步的操作，如撤单或修改订单等。

取消订单

接口描述：此接口用于取消指定的未成交订单。只有状态为“未成交”的订单可以被取消。调用此接口后，系统会尝试取消该订单并返回操作结果。如果订单已被成交或正在处理中，则无法取消。

请求方式： DELETE ，该请求方式通过删除操作来取消订单。需要指定订单的唯一标识符（ order_id ），以确保准确取消目标订单。

请求URL：

/api/v1/order?order_id=123456789

请求参数说明：

order_id ：必填，整数类型，表示待取消订单的唯一标识符。通过该参数，系统能够定位并处理目标订单。

响应示例：

{ "code": 200, "msg": "success", "data": { "order_id": 123456789, "status": "canceled" } }

响应字段说明：

code ：返回的状态码， 200 表示请求成功。
msg ：返回信息，成功时为“success”，若操作失败，返回相应的错误信息。
data ：包含实际数据， order_id 字段表明成功取消的订单ID， status 字段表示订单的新状态，通常为“canceled”表示订单已被取消。

错误响应示例：

{ "code": 400, "msg": "Order not found", "data": {} }

错误码及说明：

400 ：表示请求的订单无法找到，可能是因为订单ID不正确或订单已被删除。
404 ：表示请求的订单状态不可取消，例如已成交订单。
500 ：表示服务器内部错误，通常是系统处理过程中出现异常。

注意事项：

该接口仅适用于未成交的订单。如果订单已成交或正在处理中，取消请求将被拒绝。
订单一旦取消，系统会更新订单状态，相关资金将被解冻，且无法恢复订单。
取消订单操作需具备相应权限，用户需要确保有权对订单进行取消操作。

风控接口

风控接口为平台提供了全面的风险管理功能，旨在帮助识别、监控和应对与用户账户及交易活动相关的潜在风险。通过这些接口，平台能够实时获取有关用户行为的数据，并根据预设的规则对交易进行审查、限制或阻止，从而有效防范欺诈、洗钱、异常交易等风险。

具体来说，风控接口通常涉及用户身份验证、交易行为分析、资金流动监控等多个方面。例如，接口可以分析用户的交易历史，识别出异常的交易模式，或根据市场波动情况动态调整交易限制。对于大额交易或高频交易，风控接口可通过设置阈值来自动触发警报或要求人工审核。风控接口还能够与其他安全系统（如反欺诈系统）联动，以进一步提升平台的风险防控能力。

风控接口不仅仅在交易过程中提供风险防范，还可为平台管理者提供实时的风险报告，帮助他们及时了解平台的风险状况，作出相应的策略调整。通过智能化的风控机制，平台能够更好地保护用户资产安全，提升交易环境的透明度与可信度。

查询账户风险信息

接口描述：该接口用于查询指定账户的当前风险状态，主要包括账户的保证金水平和可能的强平价格。通过此接口，用户可以实时获取账户的风险管理数据，帮助进行资产风险控制，避免由于市场波动而导致的强制平仓。

请求方式： GET 。

请求路径： /api/v1/risk/status ，该路径用于请求账户的风险相关信息。请求时无需传递任何额外的查询参数，系统会自动获取当前用户的风险状态数据。

请求示例：

GET /api/v1/risk/status

响应示例：

响应数据是一个JSON格式的对象，包含了账户的风险信息。常见的字段包括：

code ：返回的状态码，200表示请求成功。
msg ：响应信息，成功时通常为“success”。
data ：风险信息对象，包含以下关键字段：
- margin_level ：账户的保证金水平，通常用于评估账户的当前风险状况。保证金水平越高，账户的风险越低。
- liquidation_price ：强平价格，即账户需要达到的价格点，若市场价格触及此点，系统将会自动平仓以避免进一步亏损。

示例响应：

{
  "code": 200,
  "msg": "success",
  "data": {
    "margin_level": "2.0",
    "liquidation_price": "42000.00"
  }
}

在此示例中，账户的保证金水平为2.0，说明账户具备一定的风险承受能力；而强平价格为42000.00，若市场价格跌至该水平，系统会进行强平处理。

查询交易对风险

接口描述：该接口用于查询指定交易对的风险相关数据，包括当前交易对的清算价格、风险等级等信息。通过该接口，用户能够实时获取特定交易对的风险状态，从而做出更加科学的交易决策，避免因市场波动或风险管理不足而导致的损失。

请求方式： GET ，即通过GET请求来查询指定交易对的风险信息。此接口适用于需要定期或按需获取风险数据的场景，能够提供当前交易对的实时风险分析。

请求示例：

GET /api/v1/risk/symbol?symbol=btcusdt

在该请求示例中， symbol 参数表示交易对的名称，用户可以根据需要替换成不同的交易对名称，如 BTCUSDT 、 ETHUSDT 等。请求中的 symbol 是必填项，系统将返回对应交易对的风险数据。

响应示例：

{ "code": 200, "msg": "success", "data": { "symbol": "BTCUSDT", "liquidation_price": "42000.00", "risk_level": "normal" } }

响应字段说明：

code : 状态码，200表示请求成功。
msg : 返回信息，"success"表示操作成功。
data : 返回的数据内容，其中包括具体的风险信息。
symbol : 交易对名称，示例中为 BTCUSDT ，表示比特币/美元交易对。
liquidation_price : 清算价格，示例中为 42000.00 ，即当市场价格达到该价格时，交易对将触发清算。
risk_level : 风险等级，表示当前交易对的风险状态，示例中为 normal ，表示该交易对的风险水平处于正常状态。此值可能会根据市场波动情况变化，可能的风险等级包括 normal 、 high 、 low 等。

限制与注意事项

请求频率限制 ：欧易平台对其 API 的请求频率设有严格限制。每个 API Key 每秒钟最多允许发起 20 次请求。若请求频率超过此限制，系统将返回 429 错误，提示用户请求过于频繁。为了避免频繁的请求失败，开发者应合理规划请求间隔，确保请求频率在允许范围内。对于高频请求场景，建议采用请求队列或限速机制，以保证系统稳定性和 API 的正常响应。
错误处理 ：在使用 API 时，用户可能会遇到各种错误，API 返回的错误代码能帮助开发者快速定位并解决问题。常见的错误代码包括：400（请求参数错误，通常是因为请求中参数格式不正确或缺少必要参数）、401（认证失败，可能是因为提供的 API Key 或密钥无效、过期或权限不足）、429（请求频率过高，表示超出了 API 的请求限制）。开发者应根据错误代码及时进行相应处理，例如重试机制、错误提示等，以提升用户体验和系统稳定性。
时区：API 默认返回的数据时间为 UTC（协调世界时）时间，所有与时间相关的数据（如交易记录、市场数据等）都会按照 UTC 时间格式呈现。为了适应不同地区的用户需求，开发者需要根据本地时区进行时间转换，确保展示的时间与用户所在时区一致。例如，在中国大陆地区，开发者应将返回的 UTC 时间转换为北京时间（GMT+8）。开发者可参考相应的时区转换工具或库，以便准确地进行时区转换。

上一篇: Upbit法币充值比特现金教程 - 在数字资产交易的世界里，Upbit作为韩国最大的加密货币交易所之一，吸引了众多投资者的目光。对于初次接触加密货币市场的用户来说，如何在Upbit上进行法币充值并购买比特现金（BCH）可能还存在一些疑问。本文将详细讲解如何在Upbit平台上完成这一过程。

下一篇: Bitfinex比特币奖励活动，吸引新老用户参与

欧易数字货币交易所API文档与认证机制介绍