欧易API实时数据获取：Python实战，掘金数字货币市场！

日期： 栏目：解答 浏览：85

如何使用欧易的API获取实时数据

欧易（OKX）提供了一套强大的API，允许开发者访问各种市场数据，包括实时行情、历史交易数据、账户信息等等。本文将详细介绍如何使用欧易的API获取实时数据，并提供相应的代码示例。

1. 准备工作

在使用欧易API之前，务必完成以下准备工作，确保能够安全且高效地访问和使用API：

  • 注册欧易账户： 您需要在欧易（OKX）交易所注册一个账户。这是使用欧易API的前提。访问欧易官方网站，按照注册流程填写所需信息并完成身份验证。
  • 创建API Key： 登录您的欧易账户后，前往用户中心或账户设置页面，找到API管理或API密钥相关的选项。在此页面，您可以创建一个API Key。

    创建API Key时，需要细致地设置权限。例如，如果您仅需要获取市场数据，则只需赋予“读取”或“现货交易-读取”权限。如果您需要进行交易，则需要赋予“交易”或“现货交易-交易”权限。请务必遵循最小权限原则，只赋予必要的权限，降低账户风险。

    务必妥善保存 API Key 和 Secret Key 。 API Key 用于标识您的身份， Secret Key 用于对请求进行签名。切勿将 Secret Key 泄露给他人。强烈建议开启IP限制功能，只允许特定的IP地址访问API，从而进一步增加安全性。如果您的IP地址发生变化，请及时更新IP白名单。

  • 深入了解API文档： 详细阅读欧易的官方API文档至关重要。API文档是了解各个接口功能、参数、返回值以及错误代码的权威指南。

    欧易API文档通常包含以下内容：

    • 接口描述：详细说明接口的功能和用途。
    • 请求参数：列出所有必需和可选的请求参数，以及参数的数据类型、取值范围和含义。
    • 请求示例：提供多种编程语言的请求示例，帮助您快速上手。
    • 响应示例：展示接口返回的数据格式和内容。
    • 错误代码：列出所有可能的错误代码，以及对应的错误信息和解决方法。
    • 速率限制：说明接口的调用频率限制，防止API被滥用。

    强烈建议您仔细阅读API文档，并理解各个接口的细节。官方文档地址为： https://www.okx.com/docs-v5/zh_CN/ （请根据实际情况替换为最新官方文档链接）。欧易可能会定期更新API文档，请保持关注。

  • 选择合适的编程语言： 选择您最熟悉且适合API开发的编程语言。常见的选择包括Python、Java、JavaScript、Go等。

    Python拥有丰富的API开发库和框架，例如requests、ccxt等，因此非常适合进行API开发和数据分析。本文将以Python为例进行讲解，但您可以根据自己的喜好和项目需求选择其他编程语言。

2. 安装必要的库

在使用Python访问加密货币交易所的API之前，需要安装一些关键的Python库。这些库将帮助你处理HTTP请求、生成安全签名以及解析返回的数据。

  • requests： requests 库是Python中一个强大且易于使用的HTTP客户端库。它允许你发送各种类型的HTTP请求（如GET、POST、PUT、DELETE等）到API服务器，并处理服务器返回的响应。在与加密货币交易所的API交互时， requests 库是发送交易请求、获取市场数据等操作的基础。
  • hmac： hmac （Hash-based Message Authentication Code）模块用于生成基于哈希的消息认证码。许多加密货币交易所的API使用HMAC来验证请求的来源，确保只有经过授权的用户才能访问API。 hmac 模块可以与密钥结合使用，对请求的数据进行签名，从而防止中间人攻击和数据篡改。
  • ： （JavaScript Object Notation）模块用于编码和解码JSON数据。加密货币交易所的API通常以JSON格式返回数据，例如市场行情、交易历史、账户余额等。 模块可以将JSON字符串转换为Python对象（如字典、列表），方便你进行数据处理和分析。

可以使用pip命令安装这些库。强烈建议使用虚拟环境来隔离项目依赖，避免版本冲突。以下命令演示了如何在命令行中使用pip安装所需的库： 

pip install requests hmac

请确保你的Python环境已经正确配置，并且pip命令可用。 如果提示权限错误，可以尝试使用 sudo pip install （在Linux或macOS上）或以管理员身份运行命令提示符（在Windows上）来安装。

3. API 认证

为了确保交易安全以及平台的稳定运行，欧易 API 必须经过严格的认证才能访问。 认证的核心机制是使用 API Key 、 Secret Key 和 Timestamp 三个关键要素，生成一个唯一的签名 ( Signature )。 这个签名被附加到每个 API 请求中，服务器通过验证该签名来确认请求的来源和完整性，从而保障数据的安全传输。

详细来说， API Key 用于标识您的身份， Secret Key 则是一个只有您知道的密钥，用于生成签名。 Timestamp ，即时间戳，用于防止重放攻击，保证请求的有效性。将这三者结合起来，通过特定的算法生成签名，能够有效防止恶意用户伪造请求。

以下是一个使用 Python 语言生成欧易 API 签名的代码示例，展示了具体的实现过程： 

import hmac
import hashlib
import base64
import time

def generate_signature(timestamp, method, request_path, body, secret_key):
  """
  生成 API 签名。

  此函数接受时间戳、HTTP 方法、请求路径、请求体和 Secret Key 作为输入，
  并使用 HMAC-SHA256 算法生成 API 签名。

  Args:
    timestamp:  Unix 时间戳（秒），表示请求发送的时间。
    method:  HTTP 方法，例如 'GET' 或 'POST'。 必须大写。
    request_path:  不包含域名的 API 请求路径，例如 '/api/v5/account/balance'。
    body:  请求体，如果是 GET 请求或者没有请求体，则为空字符串 ""。 对于 POST 请求，通常是 JSON 格式的字符串。
    secret_key:  您的 Secret Key，用于加密签名。 务必妥善保管，切勿泄露。

  Returns:
    签名字符串，用于 API 请求的 Authentication Header。
  """
  message = timestamp + method + request_path + body
  mac = hmac.new(secret_key.encode('utf-8'), message.encode('utf-8'), hashlib.sha256)
  d = mac.digest()
  return base64.b64encode(d).decode()

注意事项：

  • timestamp 必须是 Unix 时间戳，精确到秒。 可以使用 time.time() 获取当前时间戳。
  • method 必须为大写，例如 "GET" 或 "POST" 。
  • request_path 必须包含 API 的版本号，例如 /api/v5/account/balance 。
  • body 必须是字符串类型，即使是空请求体也需要使用空字符串 "" 。 对于 POST 请求，通常是 JSON 字符串。
  • secret_key 必须妥善保管，泄露会导致安全风险。
  • 生成的签名需要添加到 API 请求的 OK-ACCESS-SIGN Header 中。
  • 同时还需要将 API Key 添加到 OK-ACCESS-KEY Header 中，将 timestamp 添加到 OK-ACCESS-TIMESTAMP Header 中。

4. 获取实时行情数据

获取实时的加密货币行情数据是进行交易决策和构建量化策略的关键步骤。交易所提供的API接口是获取这些数据的常用方法。以下是使用欧易（OKX）API获取实时行情数据的示例代码，展示了如何通过编程方式访问并解析交易所数据：

import requests import time

这段代码片段首先导入了必要的Python库。 requests 库用于发送HTTP请求，与欧易API进行交互。 time 库则用于处理时间相关操作，例如控制请求频率，避免触发API的限流机制。

在实际应用中，你需要构建完整的HTTP请求，包括指定API端点、请求参数（例如交易对）、以及可能的身份验证信息（如果API需要）。获取到响应后，需要解析JSON格式的数据，提取所需的行情信息，例如最新成交价、买一价、卖一价、交易量等。请注意，不同的交易所API接口可能有所不同，需要参考相应的API文档进行调整。

务必注意API的使用频率限制，合理设置请求间隔，避免被交易所封禁IP。同时，对获取到的数据进行清洗和验证，确保数据的准确性和可靠性，这对于后续的交易策略至关重要。

你的API Key、Secret Key和Passphrase

API Key、Secret Key和Passphrase是访问加密货币交易所API的关键凭证，务必妥善保管。

API_KEY = "YOUR_API_KEY"

API Key是公开的标识符，用于识别你的账户。它允许交易所跟踪你的API请求并实施速率限制。请注意，API Key本身不足以授权交易或访问敏感信息，需要与Secret Key配合使用。

SECRET_KEY = "YOUR_SECRET_KEY"

Secret Key是私密的，应该像密码一样保护。它用于对API请求进行签名，证明请求的真实性和完整性。泄露Secret Key可能导致资金损失。切勿将Secret Key存储在公开的代码库或共享给任何人。

PASSPHRASE = "YOUR_PASSPHRASE" # 如果你设置了Passphrase，则需要填写

Passphrase是可选的安全措施，为你的API Key增加额外的安全层。如果你的交易所支持Passphrase，强烈建议设置。它需要与API Key和Secret Key一起使用才能授权交易或访问某些功能。如果设置了Passphrase，请务必在此处填写。忘记Passphrase可能会导致无法访问API，需要重置。

重要提示：

  • 始终使用安全的存储方法来保存你的API Key、Secret Key和Passphrase。
  • 定期轮换API Key和Secret Key以降低风险。
  • 限制API Key的权限，只授予必要的访问权限。
  • 监控你的API使用情况，及时发现异常活动。
  • 切勿将API Key、Secret Key和Passphrase硬编码到你的应用程序中。

请求参数

instrument_id 参数是指定交易对的关键，用于确定要获取哪种加密货币的行情数据。例如， instrument_id = "BTC-USDT" 表示您希望获取比特币（BTC）与泰达币（USDT）交易对的市场行情信息。这个参数必须精确，否则API将无法正确返回数据。 完整的URL构建如下：
url = f"https://www.okx.com/api/v5/market/ticker?instId={instrument_id}"
其中 https://www.okx.com 是OKX交易所的域名， /api/v5/market/ticker 是获取ticker行情的API端点， instId={instrument_id} 则是传递交易对参数的方式。

method = "GET" 指定了HTTP请求方法为GET。 GET请求通常用于从服务器获取数据，而不会对服务器上的数据进行修改。在获取行情数据时，使用GET请求是标准的做法。

request_path = "/api/v5/market/ticker" 是API请求的路径，它是URL中域名之后的部分，用于标识服务器上要访问的特定资源或功能。在构建请求时，这个参数有助于理解API的结构。

body = "" 表示对于GET请求，请求体（body）为空。GET请求通常不需要在请求体中包含任何数据，所有参数都通过URL的查询字符串传递。 如果使用POST等其他方法， body 则会包含JSON格式的请求数据。

生成签名

在加密货币交易或API交互中，生成签名是确保请求安全性和完整性的关键步骤。签名允许服务器验证请求是否来自授权方，并防止数据在传输过程中被篡改。以下是生成签名的过程详解，基于您提供的代码片段：

获取当前时间戳。时间戳通常以Unix时间表示，即自1970年1月1日午夜（UTC）以来经过的秒数。您可以使用Python的 time 模块来获取时间戳，并将其转换为字符串格式： 

timestamp = str(int(time.time()))

接下来，使用 generate_signature 函数生成签名。该函数接收以下参数：

  • timestamp : 上一步骤中获取的时间戳字符串。
  • method : HTTP请求方法，例如 "GET" 或 "POST" 。
  • request_path : 请求的路径，例如 "/api/v5/trade/order" 。
  • body : 请求体，通常是JSON格式的字符串，包含要发送的数据。对于GET请求，此参数可能为空。
  • SECRET_KEY : 您的私钥，用于对请求进行签名。务必妥善保管您的私钥，切勿泄露给他人。

generate_signature 函数的具体实现可能因不同的交易所或API而异。常见的签名算法包括HMAC-SHA256。一个示例的 generate_signature 函数 (HMAC-SHA256) 实现可能如下所示: 


import hmac
import hashlib
import base64

def generate_signature(timestamp, method, request_path, body, secret_key):
    message = timestamp + method + request_path + body
    message = message.encode('utf-8')
    secret = secret_key.encode('utf-8')
    hmac_digest = hmac.new(secret, message, digestmod=hashlib.sha256).digest()
    signature = base64.b64encode(hmac_digest).decode('utf-8')
    return signature

您的代码片段还展示了如何构建请求路径： 

request_path  + f"?instId={instrument_id}"

这表示请求路径包含一个查询参数 instId ，其值为 instrument_id 。 instrument_id 代表交易标的，例如 "BTC-USD" 。

最终的签名生成代码如下所示： 

signature = generate_signature(timestamp, method,  request_path  + f"?instId={instrument_id}",  body,  SECRET_KEY)

生成签名后，通常需要将其添加到HTTP请求的头部，以便服务器进行验证。具体的头部名称可能因不同的API而异，常见的头部名称包括 "X-SIGNATURE" 或 "Authorization" 。

请务必参考您所使用的交易所或API的官方文档，了解具体的签名生成方法和请求头部的要求。

设置请求头

在与交易所的API进行交互时，设置正确的请求头至关重要。这些头部信息用于身份验证、授权以及指定请求的内容类型。以下是一个示例头部信息的配置，其中包含API密钥、签名、时间戳和Passphrase（如果已设置）：

headers = { "OK-ACCESS-KEY": API_KEY, # 您的API密钥，用于标识您的账户。 "OK-ACCESS-SIGN": signature, # 根据请求参数和密钥生成的签名，用于验证请求的完整性和真实性。 "OK-ACCESS-TIMESTAMP": timestamp, # 请求发送的时间戳，用于防止重放攻击。 "OK-ACCESS-PASSPHRASE": PASSPHRASE, # 如果您在账户中设置了Passphrase，则必须包含此项。如果未设置，请删除此行。 "Content-Type": "application/" # 指定请求体的内容类型为JSON。 }

请务必替换 API_KEY 、 signature 、 timestamp 和 PASSPHRASE 为您实际的值。 signature 的生成方式通常涉及对请求参数、API密钥和Secret Key进行哈希运算，具体算法请参考交易所的API文档。

在设置好请求头后，您可以使用 requests 库发送HTTP请求。以下是一个使用 requests.get() 方法发送GET请求的示例：

try: # 发送请求 response = requests.get(url, headers=headers) response.raise_for_status() # 检查请求是否成功，如果状态码不是200，则抛出异常。

response.raise_for_status() 会检查HTTP响应状态码，如果状态码表示错误（例如400、404、500），则会抛出一个 HTTPError 异常。这是一种方便的错误处理方式。 

# 解析JSON数据
data = response.()

# 打印结果
if data['code'] == '0':
    ticker = data['data'][0]
    print(f"Instrument ID: {ticker['instId']}")
    print(f"Last Price: {ticker['last']}")
    print(f"Bid Price: {ticker['bid']}")
    print(f"Ask Price: {ticker['ask']}")
else:
    print(f"Error: {data['msg']}")

上述代码首先使用 response.() 方法将响应体解析为JSON格式的Python字典。然后，它检查 code 字段是否为 '0' ，这通常表示请求成功。如果成功，则从 data['data'] 列表中提取第一个元素（假设它包含ticker信息），并打印 Instrument ID（交易对ID）、Last Price（最新成交价）、Bid Price（买一价）和 Ask Price（卖一价）。如果 code 不是 '0' ，则打印错误消息。

为了处理可能发生的异常情况，建议使用 try...except 块。以下是一个示例，演示如何捕获 requests.exceptions.RequestException 和 .JSONDecodeError 异常：

except requests.exceptions.RequestException as e: print(f"Request Error: {e}") except .JSONDecodeError as e: print(f"JSON Decode Error: {e}")

requests.exceptions.RequestException 异常可以捕获所有与请求相关的异常，例如网络连接错误、超时等。 .JSONDecodeError 异常则表示JSON解析失败，通常是由于响应体不是有效的JSON格式引起的。捕获这些异常可以使您的代码更加健壮，并提供有用的错误信息。

代码解释：

  1. 导入必要的库： requests 库是 Python 中一个强大的 HTTP 客户端库，用于向服务器发送 HTTP 请求，并处理服务器的响应。在加密货币交易和数据获取中，它常被用于调用交易所的 API 接口。 库用于处理 JSON (JavaScript Object Notation) 格式的数据。交易所 API 通常返回 JSON 格式的数据，因此需要使用此库进行解析和序列化。 time 库提供了与时间相关的功能，例如获取当前时间戳。时间戳在API请求中经常被用作签名的一部分，用于防止重放攻击。
  2. 设置API Key、Secret Key和Passphrase： YOUR_API_KEY 、 YOUR_SECRET_KEY 和 YOUR_PASSPHRASE 是访问交易所 API 的凭证。API Key 用于标识你的账户，Secret Key 用于生成签名，Passphrase 是一种额外的安全措施，用于进一步验证你的身份。这些信息需要从交易所官方网站获取，并且务必妥善保管，切勿泄露。请务必将其替换为你自己的有效凭证。
  3. 设置请求参数： instrument_id 用于指定要获取行情数据的交易对。不同的交易所使用不同的命名规则，例如 BTC-USDT 代表比特币兑换泰达币的交易对， ETH-BTC 代表以太坊兑换比特币的交易对。确保使用交易所支持的正确的交易对代码。
  4. 生成签名： generate_signature 函数负责生成请求的数字签名。签名是使用 Secret Key 对请求内容进行哈希运算的结果，用于验证请求的完整性和真实性，防止数据被篡改。不同的交易所采用不同的签名算法，常见的算法包括 HMAC-SHA256。该函数通常包含以下步骤：构造签名字符串、使用 Secret Key 对字符串进行哈希运算、将哈希结果进行编码。
  5. 设置请求头： 请求头 (Headers) 中包含 API Key、签名、时间戳和 Passphrase 等信息，这些信息用于交易所验证请求的身份和合法性。正确的请求头是成功调用 API 的关键。常见请求头包括：
    • Content-Type : 指定请求体的格式，通常为 application/ 。
    • OK-ACCESS-KEY (示例): 包含 API Key。交易所通常会自定义 Header 的 Key。
    • OK-ACCESS-SIGN (示例): 包含签名。
    • OK-ACCESS-TIMESTAMP (示例): 包含时间戳。
    • OK-ACCESS-PASSPHRASE (示例): 包含 Passphrase。
    根据交易所的 API 文档，设置正确的请求头。
  6. 发送请求： requests.get 函数用于发送 HTTP GET 请求。GET 请求通常用于获取数据。你需要提供 API 的 URL 地址，以及请求头等参数。 requests.post 函数用于发送 HTTP POST 请求。POST 请求通常用于提交数据，例如下单。
  7. 解析JSON数据： response.() 函数用于将服务器返回的 JSON 格式的响应数据解析为 Python 对象 (例如字典或列表)。解析后的数据可以方便地进行访问和处理。如果返回的数据不是 JSON 格式，则会抛出异常。
  8. 打印结果： 从解析后的 JSON 数据中提取所需的信息，并打印出来。根据 API 返回数据的结构，使用相应的键来访问数据。例如，如果返回数据是一个字典，可以使用 data['price'] 来获取价格信息。在实际应用中，通常会将获取到的数据存储到数据库或者进行进一步的分析和处理。
  9. 错误处理： try...except 语句用于捕获可能出现的异常，例如网络错误 ( requests.exceptions.RequestException ) 和 JSON 解析错误 ( .JSONDecodeError )。通过捕获异常，可以防止程序崩溃，并进行相应的处理，例如打印错误信息、重试请求或者记录日志。良好的错误处理是保证程序稳定性和可靠性的重要因素。

5. 获取深度数据

在加密货币交易中，深度数据（也称为订单簿数据）是指在特定交易所中，针对特定交易对，买单和卖单的实时价格和数量信息。这些数据对于交易者理解市场流动性、评估潜在的价格波动以及制定交易策略至关重要。获取并分析深度数据是量化交易、套利策略和风险管理的基础。

以下是使用欧易API获取深度数据的示例代码。请注意，你需要一个欧易API密钥才能执行此操作。确保你已正确设置API密钥和安全设置。

import requests
import
import time

代码说明：

  • requests ：这是一个常用的Python库，用于发送HTTP请求。我们将使用它来与欧易API进行交互。
  • ：用于处理API返回的JSON格式数据。
  • time ：用于在请求之间添加延迟，以避免API请求频率限制。

你的API Key、Secret Key 和 Passphrase

在开始使用交易所API进行交易或数据查询之前，你需要设置API Key、Secret Key 和 Passphrase。这些凭证用于验证你的身份并授权你的API请求。

API Key（API 密钥）是一个公开的标识符，用于识别你的账户。你可以把它理解为你的用户名，在每次API请求中都需要提供。

Secret Key（密钥）是一个私密的、只有你知道的字符串。它与API Key一起用于生成签名，以验证请求的真实性和完整性，防止恶意篡改。务必妥善保管你的 Secret Key，不要泄露给任何人。

Passphrase（口令）是部分交易所提供的额外安全措施。如果你在创建API Key时设置了Passphrase，那么在你的API请求中也必须包含它。Passphrase就像一个第二层密码，用于进一步保护你的账户安全。如果未设置，则无需填写。 

  
API_KEY  = "YOUR_API_KEY" 

SECRET_KEY =  "YOUR_SECRET_KEY"

PASSPHRASE  =  "YOUR_PASSPHRASE"   # 如果你设置了Passphrase，则需要填写

重要提示：

  • 务必妥善保管你的API Key、Secret Key 和 Passphrase。
  • 不要将它们存储在不安全的地方，例如公共代码仓库或不加密的文本文件中。
  • 定期更换你的API Key 和 Secret Key，以提高安全性。
  • 启用交易所提供的所有安全措施，例如两步验证。
  • 仔细阅读交易所的API文档，了解每个API endpoint的权限要求，并根据需要分配最小权限。
  • 使用完毕后，及时禁用或删除不再需要的API Key，降低风险。

不同的交易所获取API Key 和 Secret Key 的方式可能略有不同。通常你需要在交易所的账户设置或API管理页面创建API Key。创建过程中，你需要选择API Key的权限，例如交易、提现、查询等。请根据你的实际需求选择合适的权限。

请求参数

在访问OKX交易所的深度数据API时，需要构建相应的请求参数。以下是对关键参数的详细说明：

instrument_id = "BTC-USDT" 这是一个字符串类型的参数，用于指定需要获取深度数据的交易对。例如， "BTC-USDT" 表示获取比特币(BTC)与泰达币(USDT)交易对的深度数据。务必使用交易所支持的有效交易对代码。不同的交易所和交易平台可能使用不同的交易对代码格式，例如 "BTC-USDT" 、 "BTC/USDT" 、 "BTC_USDT" 等等，务必参考API文档选择正确的代码格式。

depth = "5" 这是一个字符串类型的参数，用于指定需要获取的深度档位数量。深度数据按照买单和卖单的价格排序， depth 参数决定了返回多少个最佳买单和卖单的价格和数量。例如， "5" 表示获取买方和卖方深度数据的前5个档位。档位越多，数据量越大，可能影响响应时间。请根据实际需求选择合适的深度档位数量。部分交易所对最大档位数量有限制，超过限制可能导致请求失败。

url = f"https://www.okx.com/api/v5/market/books?instId={instrument_id}&sz={depth}" 这是完整的API请求URL，包含了API的基础地址、API版本、API端点以及请求参数。使用Python的f-string可以方便地将 instrument_id 和 depth 参数嵌入到URL中。注意URL中的参数名可能因交易所API版本而异，请参考最新API文档。 sz={depth} 用于指定返回深度档位大小。

method = "GET" 这是一个字符串类型的参数，指定HTTP请求方法。获取深度数据通常使用 GET 方法，表示从服务器获取资源。部分API也可能支持 POST 方法，但通常用于发送数据到服务器。选择错误的请求方法可能导致请求失败。

request_path = "/api/v5/market/books" 这是一个字符串类型的参数，表示API请求的路径，不包含域名部分。 方便后续签名计算。

body = "" 这是请求体，用于在HTTP请求中发送数据到服务器。对于 GET 请求，通常不需要请求体，因此 body 为空字符串。对于 POST 请求， body 通常包含JSON格式的数据，例如交易指令、签名信息等。

生成签名

在加密货币交易平台或API交互中，生成有效的签名至关重要，它用于验证请求的来源和完整性。此过程通常涉及时间戳、请求方法、请求路径、请求体以及一个保密的密钥。以下是如何生成签名的详细步骤：

获取当前时间戳。时间戳通常以Unix时间格式表示，即自1970年1月1日00:00:00 UTC起经过的秒数。将其转换为字符串类型： 

timestamp  = str(int(time.time()))

接下来，使用 generate_signature 函数来生成签名。此函数的输入参数包括：

  • timestamp : 上一步生成的时间戳字符串。
  • method : HTTP请求方法，例如 GET , POST , PUT , DELETE 等，必须为大写。
  • request_path : 请求的API路径，不包含域名。
  • instrument_id : (可选) 交易对ID，例如 BTC-USD ， ETH-USDT 。此参数作为URL查询参数的一部分被添加到请求路径中。
  • depth : (可选) 深度参数，用于指定订单簿深度。此参数也作为URL查询参数的一部分被添加到请求路径中。
  • body : 请求体，通常是JSON格式的字符串，包含需要发送到服务器的数据。如果请求没有请求体，则此参数可以为空字符串或 None 。
  • SECRET_KEY : 你的私钥，这是用于生成签名的保密字符串。

构造完整的请求路径，包括交易对ID和深度参数（如果需要），然后调用签名生成函数： 

signature =  generate_signature(timestamp, method, request_path + f"?instId={instrument_id}&sz={depth}", body, SECRET_KEY)

generate_signature 函数的具体实现取决于所使用的加密算法和平台的安全要求。常见的加密算法包括HMAC-SHA256。函数通常会将时间戳、请求方法、请求路径和请求体连接起来，然后使用私钥对连接后的字符串进行哈希运算，生成最终的签名。生成的签名通常以Base64编码的字符串形式返回。

设置请求头

在使用RESTful API进行身份验证和授权时，设置正确的请求头至关重要。以下代码展示了如何构建包含必要身份验证信息的请求头，例如OKX交易所的API。

headers 字典包含了所有必需的HTTP头部字段：

  • OK-ACCESS-KEY : 您的API密钥。这相当于您的用户名，用于标识您的身份。
  • OK-ACCESS-SIGN : 使用您的API密钥、请求时间戳、请求方法和请求路径生成的签名。 这是安全的关键部分，用于验证请求的真实性和完整性。
  • OK-ACCESS-TIMESTAMP : 请求发送时的时间戳（以秒为单位）。 这有助于防止重放攻击。
  • OK-ACCESS-PASSPHRASE : 如果账户设置了密码短语，则必须包含此项。 若未设置，则应移除此行。
  • Content-Type : 指定请求体的MIME类型。 在本例中， application/ 表示请求正文是JSON格式的数据。

示例代码: 

headers = {
    "OK-ACCESS-KEY": API_KEY,
    "OK-ACCESS-SIGN": signature,
    "OK-ACCESS-TIMESTAMP": timestamp,
    "OK-ACCESS-PASSPHRASE": PASSPHRASE,  # 如果设置了，就加上，没有设置，就删掉这一行
    "Content-Type": "application/"
}

以下代码演示了如何使用构建好的 headers 字典发送GET请求，并处理可能出现的异常。 它还展示了如何解析JSON响应并提取所需的数据。

异常处理是健壮应用程序的关键。 try...except 块用于捕获和处理潜在的错误，例如网络问题或无效的JSON响应。

  • requests.exceptions.RequestException : 捕获所有与请求相关的异常，例如连接错误、超时等。
  • .JSONDecodeError : 处理JSON解码失败的情况，例如当API返回无效的JSON时。

示例代码: 

try:
    # 发送请求
    response = requests.get(url, headers=headers)
    response.raise_for_status()  # 检查请求是否成功，如果状态码不是 200 OK，则抛出 HTTPError 异常

    # 解析JSON数据
    data = response.()

    # 打印结果
    if data['code'] == '0':
        bids = data['data'][0]['bids']
        asks = data['data'][0]['asks']

        print(f"Instrument ID: {instrument_id}")
        print("Bids:")
        for bid in bids:
            print(f"  Price: {bid[0]}, Size: {bid[1]}")

        print("Asks:")
        for ask in asks:
            print(f"  Price: {ask[0]}, Size: {ask[1]}")
    else:
        print(f"Error: {data['msg']}")

except requests.exceptions.RequestException as e:
    print(f"Request Error: {e}")
except .JSONDecodeError as e:
    print(f"JSON Decode Error: {e}")

代码解释：

  • response = requests.get(url, headers=headers) : 使用 requests 库发送GET请求，并将构建好的 headers 传递给服务器。
  • response.raise_for_status() : 检查HTTP响应状态码。如果状态码表示错误（例如400、404、500），则会引发 HTTPError 异常。
  • data = response.() : 将JSON响应解析为Python字典。
  • if data['code'] == '0': : 检查API返回的状态码。通常， code 为 '0' 表示成功。
  • 代码提取并打印了Instrument ID，以及最优的买单(Bids)和卖单(Asks)的价格和数量。
  • 在 except 块中，打印出相应的错误信息，以便于调试。

代码解释：

这段代码的功能与获取行情数据类似，但关键区别在于其专注于市场深度信息的获取，而非简单的交易对价格。

  • 请求的URL不同： 获取市场深度数据的API端点是 /api/v5/market/books 。为了准确定位目标交易对和深度，必须包含以下查询参数：
    • instId ：该参数用于指定需要获取深度信息的交易对，例如 "BTC-USDT"。务必确保其格式与交易所支持的交易对标识符一致。
    • sz ：该参数控制返回的深度档位数量。例如， sz=20 表示请求买单和卖单深度列表中前 20 个最佳报价。调整该值会直接影响数据的粒度和详细程度。交易所通常会对该参数设置上限，以避免数据量过大。
  • 解析JSON数据的逻辑不同： 深度数据通常以JSON格式返回，其核心组成部分是买单 ( bids ) 和卖单 ( asks ) 两个数组。
    • bids 数组：包含按价格从高到低排序的买单列表。每个买单条目通常包含价格和数量信息，表示在该价格上等待买入的订单量。
    • asks 数组：包含按价格从低到高排序的卖单列表。每个卖单条目同样包含价格和数量信息，表示在该价格上等待卖出的订单量。
    正确的解析需要提取这两个数组，并将其中的价格和数量信息转化为程序可以使用的数据结构。例如，将价格和数量转换为浮点数，并存储到列表或字典中。对数据进行进一步处理前，还需要进行错误处理，检查数据是否完整和有效。

6. 注意事项

  • 频率限制： 欧易API针对不同接口设有严格的频率限制，以保障平台的稳定性和安全性。超过这些限制将导致您的账户被暂时禁止访问，影响您的交易和数据获取。务必查阅最新的 官方API文档 ，详细了解每个接口的具体频率限制（例如每分钟请求次数、每秒请求次数），并根据您的业务需求，采用合适的请求策略，例如使用队列、缓存等技术，来合理控制请求频率，避免触发限制。
  • 错误处理： 在实际开发过程中，健全的错误处理机制至关重要。您的代码应能够优雅地处理各种潜在的错误，包括但不限于： 网络连接错误 （例如连接超时、DNS解析失败）、 API返回错误 （例如无效的参数、权限不足、服务器内部错误，可以通过HTTP状态码和API返回的错误码来判断）以及 数据解析错误 （例如JSON格式错误、数据类型不匹配）。针对不同的错误类型，您应该采取相应的处理措施，例如重试、记录日志、通知用户等，以确保应用程序的稳定性和可靠性。
  • 安全： API Key和Secret Key是访问欧易API的关键凭证，必须高度重视其安全性。泄露这些凭证将可能导致您的账户被盗用，资金遭受损失。 切勿将API Key和Secret Key硬编码到代码中 ，这是一种非常危险的做法。推荐采用以下安全措施：使用环境变量或配置文件来存储API Key和Secret Key；对存储的API Key和Secret Key进行加密处理；定期更换API Key和Secret Key；限制API Key的权限范围，只授予必要的权限。避免在公共网络或不安全的设备上使用API Key和Secret Key。
  • 数据精度： 欧易API返回的数据（如价格和数量）通常具有较高的小数位数，不同的接口可能返回不同精度的数据。在使用这些数据进行计算或展示时，务必注意数据精度问题，避免由于精度损失或计算错误导致交易偏差或显示错误。建议使用高精度的数据类型（例如Decimal）来存储和处理这些数据，并根据实际需要进行必要的舍入处理。务必仔细阅读API文档，了解每个接口返回数据的具体精度，并根据业务需求进行相应的处理。
  • 持续阅读官方文档： 欧易API会不断进行更新和改进，增加新的接口和功能，修复已知的缺陷。为了保持您应用程序的兼容性和性能，务必定期阅读 官方API文档 ，了解最新的接口说明、参数变化、错误码定义等信息。关注官方发布的更新公告，及时调整您的代码，以适应API的变化。通过持续学习和实践，您可以更好地利用欧易API，构建更强大、更稳定的应用程序。

7. 总结

本文介绍了如何使用欧易的API获取实时数据，包括行情数据和深度数据。 通过这些数据，开发者可以构建各种交易应用，例如量化交易策略、市场监控系统等。 请务必仔细阅读欧易的API文档，并根据实际需求选择合适的接口和参数。

相关推荐