Bitfinex API：5分钟搞定交易数据？这绝对是你的秘密武器！

如何使用 Bitfinex 交易所的 API 接口

Bitfinex 交易所提供了一套功能强大的 API 接口，允许开发者以编程方式访问其平台上的各种功能，例如获取市场数据、进行交易、管理账户等。本文将介绍如何使用 Bitfinex 的 API 接口，并提供一些示例代码。

API 概览

Bitfinex API 主要分为三个部分，分别服务于不同的数据访问和交易需求：

• 公共 API (Public API): 公共 API 允许用户无需任何身份验证即可访问 Bitfinex 交易所的各种公共数据。这包括实时的市场行情信息，例如交易对的最新价格、最高价、最低价和交易量；详细的交易对信息，例如交易对的精度、最小交易量和手续费率；以及历史成交记录，包括成交价格、成交时间和成交量。公共 API 非常适合用于构建行情展示应用、数据分析工具和交易策略回测系统。
• 私有 API (Private API): 私有 API 用于执行需要用户授权的敏感操作，例如下单（包括市价单、限价单、止损单等各种订单类型）、撤单和查询账户余额（包括可用余额和已用余额）。为了确保账户安全，私有 API 访问需要 API 密钥和签名进行身份验证。用户需要在 Bitfinex 交易所生成 API 密钥，并使用密钥对请求进行签名，以证明请求的合法性。正确使用私有 API 至关重要，错误的操作可能导致资金损失。
• WebSocket API: WebSocket API 提供了实时推送的市场数据和账户更新，避免了轮询 API 带来的延迟。通过 WebSocket API，用户可以实时订阅各种市场数据，例如实时价格、深度行情和交易信息。同时，WebSocket API 还支持实时推送账户更新，例如订单状态变化和余额变动。获取账户信息等敏感操作同样需要身份验证。WebSocket API 非常适合用于构建高性能的交易应用和实时监控系统。

准备工作

在使用 Bitfinex API 之前，为了确保顺利进行开发，您需要完成以下准备工作，这些准备步骤至关重要，能有效避免后续开发中可能遇到的问题：

1. 创建 Bitfinex 账户: 如果您尚未拥有 Bitfinex 账户，请务必先注册一个。访问 Bitfinex 官方网站，按照注册流程填写所需信息，并完成身份验证。请务必使用安全的密码，并启用双重验证（2FA），以提高账户的安全性。
2. 生成 API 密钥: 成功登录 Bitfinex 账户后，导航至 API 密钥管理页面。该页面通常位于 "Account" 或 "Security" 菜单下的 "API Keys" 选项中。在此页面，创建一个新的 API 密钥对。创建密钥时，Bitfinex 会要求您为密钥分配权限，务必根据您的应用程序需求，谨慎选择所需的权限。例如，如果您只需要读取市场数据，则只需授予 "Read" 权限；如果需要进行交易，则需要授予 "Trade" 权限。 创建完成后，Bitfinex 会提供 API 密钥（API Key）和密钥密码（API Secret）。请务必将这两个值安全地保存在本地，切勿泄露给他人。API Secret 只会显示一次，丢失后需要重新生成新的 API 密钥对。如果您在创建密钥时设置了密钥密码（Passphrase），也需要妥善保管。
3. 选择编程语言和库: 根据您的技术背景和项目需求，选择合适的编程语言，例如 Python、JavaScript 或 Java。选择一种您熟悉的语言将有助于您更快地理解和使用 Bitfinex API。 选择合适的 HTTP 客户端库，例如 Python 的 requests 库或 JavaScript 的 node-fetch 库，将简化您与 Bitfinex API 的交互。这些库提供了便捷的方法来发送 HTTP 请求和处理 API 响应。如果您计划使用 WebSocket API，则还需要选择一个 WebSocket 客户端库，例如 Python 的 websockets 库或 JavaScript 的 ws 库。 WebSocket API 提供了实时的市场数据更新，非常适合需要高频交易或实时监控的应用场景。 确保您选择的库是最新版本，并仔细阅读其文档，以便更好地了解其功能和使用方法。

公共 API 的使用

公共 API 的使用通常较为直接，多数情况下无需进行身份验证。这些 API 为开发者提供了快速访问市场数据、交易信息等关键数据的途径。 以下是一个使用 Python 的 requests 库获取 Bitfinex 交易所 BTC/USD 交易对 ticker 信息的示例：

import requests

url = "https://api-pub.bitfinex.com/v2/ticker/tBTCUSD"

try: response = requests.get(url) response.raise_for_status() # 检查 HTTP 响应状态码是否指示成功 data = response.() print(data) except requests.exceptions.RequestException as e: print(f"请求失败: {e}")

这段代码首先导入 Python 的 HTTP 客户端库 requests 。然后，定义了 Bitfinex 公共 API 中 BTC/USD 交易对 ticker 信息的 URL。接下来，使用 requests.get() 方法向该 URL 发送一个 HTTP GET 请求。 response.raise_for_status() 方法用于检查响应的状态码。如果状态码在 200-399 之间，表示请求成功，否则会抛出一个 HTTPError 异常。如果请求成功， response.() 方法将响应内容（通常是 JSON 格式）解析为 Python 字典或列表，然后使用 print() 函数将其打印到控制台。如果请求过程中发生任何异常（例如网络错误、连接超时等），则会捕获 requests.exceptions.RequestException 类型的异常，并打印出错误信息。实际应用中，应更详细地处理各种可能出现的异常，例如根据 HTTP 状态码进行不同的错误处理。可以使用更复杂的 JSON 解析方法，并对返回的数据进行验证，确保数据的准确性和完整性。还可以设置请求头，例如指定 User-Agent，以避免被服务器拒绝访问。为了提高程序的健壮性，可以添加重试机制，在请求失败时自动重试若干次。更进一步，可以使用异步请求库（例如 aiohttp ）来并发地发送多个请求，从而提高程序的效率。注意，不同的交易所 API 可能有不同的请求频率限制，需要遵守这些限制，避免被封禁 IP 地址。

私有 API 的使用

访问 Bitfinex 的私有 API 需要进行身份验证，以确保账户安全和数据完整性。Bitfinex 采用 HMAC-SHA384 签名算法对每个 API 请求进行签名。这要求您使用您的 API 密钥和密钥密码来生成一个唯一的签名，该签名与您的请求一起发送。 服务器端将使用相同的密钥和数据重新计算签名，如果签名匹配，则请求将被接受并处理，否则将被拒绝。

以下是一个使用 Python 的 requests 库和 hmac 以及 hashlib 库进行身份验证的示例。 该示例展示了如何构造一个带有正确身份验证头的请求，并发送到 Bitfinex API。 注意，你需要替换 API_KEY 和 API_SECRET 为你自己的 API 密钥和密钥密码。 nonce 值必须是一个单调递增的整数，通常使用 Unix 时间戳来生成，以防止重放攻击。

import requests
import hmac
import hashlib
import time
import

API_KEY = 'YOUR_API_KEY'
API_SECRET = 'YOUR_API_SECRET'

url = 'https://api.bitfinex.com/v2/account_info' # 示例 API 端点

nonce = str(int(time.time() * 1000))

body = {} # 请求体，根据 API 端点需要进行修改
_body = .dumps(body)

signature = hmac.new(
API_SECRET.encode('utf8'),
( '/api/v2/account_info' + nonce + _body).encode('utf8'),
hashlib.sha384
).hexdigest()

headers = {
'bfx-nonce': nonce,
'bfx-apikey': API_KEY,
'bfx-signature': signature,
'Content-Type': 'application/'
}

response = requests.post(url, headers=headers, data=_body)

print(response.status_code)
print(response.())

你的 API 密钥和密钥密码 (替换为你的实际值)

api_key = "YOUR_API_KEY"

api_secret = "YOUR_API_SECRET"

上述代码段展示了如何设置你的 Bitfinex API 密钥和密钥密码。 请务必用你自己的实际值替换 "YOUR_API_KEY" 和 "YOUR_API_SECRET" 。API 密钥和密钥密码是访问 Bitfinex 私有 API 端点的凭证，务必妥善保管。

以下 Python 函数用于生成 API 请求签名，该签名用于验证请求的真实性和完整性。

def generate_signature(path, data, api_secret, nonce):
    """生成 API 请求签名.

    此函数使用 HMAC-SHA384 算法，将 API 密钥密码、API 端点路径、nonce 值和请求数据组合成一个唯一的签名。
    签名用于验证请求的来源和数据的完整性，确保只有授权用户才能访问私有 API 端点。
    """
    payload = '/api/v2' + path + nonce + data
    signature = hmac.new(
        api_secret.encode('utf8'),
        payload.encode('utf8'),
        hashlib.sha384
    ).hexdigest()
    return signature

generate_signature 函数接收四个参数：

• path : API 端点路径，例如 /auth/w/wallets 。
• data : 请求数据，JSON 格式的字符串。
• api_secret : 你的 API 密钥密码。
• nonce : 一个唯一的随机数，用于防止重放攻击。 通常使用时间戳生成。

以下函数用于发送私有 API 请求，并处理响应和潜在的错误。

def send_private_request(path, data, api_key, api_secret):
    """发送私有 API 请求.

    此函数构建请求 URL，设置必要的头部信息（包括 API 密钥、签名和 nonce），并使用 `requests` 库发送 POST 请求。
    它还处理潜在的请求错误，并返回响应数据。
    """
    url = "https://api.bitfinex.com/v2" + path
    nonce = str(int(time.time() * 1000))
    data_ = .dumps(data) if data else '{}'
    signature = generate_signature(path, data_, api_secret, nonce)

    headers = {
        "bfx-apikey": api_key,
        "bfx-signature": signature,
        "bfx-nonce": nonce,
        "Content-Type": "application/"
    }

    try:
        response = requests.post(url, headers=headers, data=data_)
        response.raise_for_status() # 如果响应状态码不是 200，则引发异常
        return response.()
    except requests.exceptions.RequestException as e:
        print(f"请求失败: {e}")
        return None

send_private_request 函数接收四个参数：

• path : API 端点路径。
• data : 请求数据，字典类型，将自动转换为 JSON 格式。 如果没有数据，则发送一个空的 JSON 对象 {} 。
• api_key : 你的 API 密钥。
• api_secret : 你的 API 密钥密码。

该函数首先构建完整的 API 请求 URL，并将当前时间戳作为 nonce 值。然后，它使用 generate_signature 函数生成请求签名，并将其添加到请求头部。使用 requests 库发送 POST 请求，并返回响应数据。如果请求失败，将打印错误信息并返回 None 。

重要提示：

• 请确保已安装 requests 和 hashlib 库。 你可以使用 pip install requests 进行安装。
• nonce 值必须是唯一的，并且每次请求都必须不同。 使用时间戳是生成 nonce 的常用方法。
• 请务必妥善保管你的 API 密钥和密钥密码，不要将其泄露给他人。
• response.raise_for_status() 会在 HTTP 请求返回错误状态码时（例如 400， 401， 500 等） 抛出一个异常， 使得程序可以及时捕获和处理错误。
• Content-Type 设置为 "application/" 以确保服务器正确解析请求体中的 JSON 数据。

示例：获取账户余额

概述： 此示例展示了如何通过私有API调用获取用户的账户余额。 私有API需要身份验证，因此需要使用API密钥和签名。以下代码段演示了必要的步骤。

path = "/auth/r/wallets" data = {} balance = send_private_request(path, data, api_key, api_secret)

代码解释：

• path : 定义了API端点的路径。 在本例中， /auth/r/wallets 通常用于获取钱包信息。 不同的交易所或服务可能使用不同的路径，请查阅API文档确认具体路径。
• data : 这是一个字典，用于存储要发送到API端点的任何附加数据。 在此示例中， data 为空，表明请求不需要任何额外的参数。 然而，在其他API调用中，可能需要传递诸如货币类型、账户类型等参数。
• send_private_request(path, data, api_key, api_secret) : 这是执行实际API请求的函数。 它接收API路径、数据、API密钥和API密钥作为参数。 重要的是要正确地处理API密钥和密钥，避免泄露。
• balance : 这是 send_private_request 函数的返回值。通常情况下，这是一个包含账户余额信息的JSON对象或字典。

if balance: print(balance)

结果处理： 如果 send_private_request 函数成功返回数据（即 balance 不为空），则将账户余额信息打印到控制台。 在实际应用中，通常需要对 balance 数据进行进一步处理，例如解析JSON格式、提取特定字段，或将其存储到数据库中。 错误处理也很重要；应考虑如果 send_private_request 函数返回错误或空值的情况。

这段代码定义了两个关键函数： generate_signature() 和 send_private_request() 。

• generate_signature() : 此函数负责生成请求的数字签名，确保请求的完整性和真实性。 它通常执行以下操作：
  1. 将请求路径（ path ）、时间戳（或nonce）和请求数据（ data ）拼接成一个字符串。拼接顺序和格式必须与API文档规定的完全一致。
  2. 使用HMAC-SHA384（或API文档指定的其他哈希算法）对拼接后的字符串进行签名。 HMAC使用API密钥作为密钥来生成哈希值。
  3. 返回生成的签名。
• send_private_request() : 此函数负责发送带有身份验证信息的私有API请求。 它通常执行以下操作：
  1. 构建请求头，其中包含API密钥、签名和nonce。 请求头的名称和格式也必须与API文档规定的完全一致。
  2. 使用POST方法（或其他API文档指定的方法）向指定的API端点发送请求。
  3. 处理服务器返回的响应。 这包括检查HTTP状态码、解析JSON数据，以及处理任何错误。
  4. 返回解析后的数据（通常是JSON对象）。

签名机制： generate_signature() 函数首先将请求路径、nonce 和请求数据拼接成一个字符串。 然后，使用 HMAC-SHA384 算法对该字符串进行签名。 使用 HMAC-SHA384 的目的是为了保证消息的完整性和身份验证，防止数据在传输过程中被篡改。 不同的交易所或服务可能会使用不同的签名算法，例如 HMAC-SHA256 或其他更安全的算法。 签名算法的选择应根据具体的安全需求和API提供商的建议。

请求发送： send_private_request() 函数将 API 密钥、签名和 nonce 添加到请求头中，并发送 POST 请求。 API密钥用于标识发送请求的用户，签名用于验证请求的完整性，nonce用于防止重放攻击。 请求头中的字段名称和格式必须与API文档规定的完全一致。POST 请求通常用于发送需要身份验证的请求，因为它可以将数据包含在请求体中，而不是URL中。

至关重要的是要记住， nonce 是一个唯一的数字，通常是自Epoch以来的毫秒级时间戳。 每个请求都必须使用不同的 nonce 值，以防止重放攻击。 重放攻击是指攻击者截获并重新发送合法的请求，从而导致未经授权的操作。 使用唯一的nonce可以确保即使攻击者截获了请求，也无法重放该请求，因为nonce已经过期。 为了保证nonce的唯一性，通常使用当前的时间戳，并确保在短时间内没有重复的nonce值。

示例分析： 在示例中，我们演示了如何使用私有 API 获取账户余额。 path 变量指定了 API 接口的路径。 data 变量包含请求数据 (在这个例子中为空)。 send_private_request() 函数返回一个 JSON 格式的响应，其中包含账户余额信息。在实际应用中，返回的JSON数据可能包含更详细的信息，例如可用余额、冻结余额、货币类型等。 需要根据API文档解析JSON数据，提取所需的信息。

WebSocket API 的使用

Bitfinex 的 WebSocket API 允许开发者实时访问市场数据和个人账户更新，为高频交易、风险管理和实时监控提供高效的数据通道。以下是一个使用 Python 的 websockets 库订阅 BTC/USD 交易对 ticker 信息的示例，该示例展示了如何建立连接、发送订阅请求并处理接收到的实时数据：

import asyncio import websockets import

async def subscribe_ticker(): uri = "wss://api.bitfinex.com/ws/2" async with websockets.connect(uri) as websocket: subscribe_message = .dumps({ "event": "subscribe", "channel": "ticker", "symbol": "tBTCUSD" }) await websocket.send(subscribe_message)

        async for message in websocket:
            data = .loads(message)
            print(data)

async def main(): await subscribe_ticker()

if name == " main ": asyncio.run(main())

这段代码首先导入 asyncio 、 websockets 和 库。 asyncio 提供了异步编程的基础， websockets 用于建立和维护 WebSocket 连接， 用于处理 JSON 格式的数据。 然后，定义一个 subscribe_ticker() 异步函数，负责建立 WebSocket 连接并订阅 ticker 数据。该函数首先连接到 Bitfinex 的 WebSocket API，地址为 wss://api.bitfinex.com/ws/2 。 然后，构造一个 JSON 格式的订阅消息，指定要订阅的频道为 ticker ，交易对为 tBTCUSD (即 BTC/USD)。 该订阅消息通过 websocket.send() 方法发送到 Bitfinex 服务器。接下来，代码进入一个无限循环，使用 websocket.recv() 异步接收来自 WebSocket 服务器的消息。 接收到的消息是一个 JSON 字符串，使用 .loads() 方法解析为 Python 字典，并通过 print() 函数输出到控制台。 main() 函数作为程序的入口点，调用 subscribe_ticker() 函数来启动整个流程。 asyncio.run(main()) 负责运行异步事件循环，使异步函数能够并发执行。

为了使用 WebSocket API 获取账户信息，必须进行身份验证以确保安全性。 身份验证流程与私有 API 类似，需要生成包含 API 密钥、时间戳和请求参数的签名。 然后，将此签名作为头部信息添加到 WebSocket 连接请求中。Bitfinex 使用此签名来验证请求的合法性，并允许经过授权的用户访问其账户信息，如余额、订单历史和交易活动。未经验证的连接将无法访问私有数据。

错误处理

在使用 Bitfinex API 与其进行交互时，开发者可能会遇到各种错误情况。这些错误可能源于多种原因，例如：发送格式不正确的请求参数、使用了无效或过期的 API 密钥、账户权限不足、请求频率超过限制、或者网络连接中断等。为了确保应用程序的稳定性和可靠性，必须实施完善的错误处理机制。

当 Bitfinex API 检测到错误时，通常会返回一个 JSON 对象作为响应，其中包含有关错误的详细信息。这个 JSON 对象至少包含两个关键字段： error_code 和 error_message 。 error_code 是一个数字代码，用于标识错误的类型，例如：400 代表请求错误，401 代表未授权，429 代表请求过多（速率限制）。 error_message 是一个人类可读的字符串，提供了错误的详细描述，例如：“Invalid API key” 或 “Incorrect request format”。通过分析 error_code 和 error_message ，开发者可以准确地诊断错误的根源，并采取相应的补救措施。例如，如果错误代码为 400，则表明请求参数存在问题，需要检查请求参数是否正确；如果错误代码为 429，则表明请求频率过高，需要实施速率限制策略，例如：使用指数退避算法来重试请求。

除了错误代码和错误消息之外，Bitfinex API 还可能返回其他与错误相关的字段，例如： error_details ，它提供有关错误的更详细信息。开发者应该仔细阅读 API 文档，了解所有可能的错误代码和错误消息的含义，并根据实际情况进行适当的错误处理。良好的错误处理策略应包括：记录错误日志、向用户显示友好的错误提示、自动重试失败的请求、以及在必要时通知管理员。

速率限制

为了保障平台的稳定运行，防止恶意攻击和资源滥用，Bitfinex 对其 API 接口实施了严格的速率限制策略。这种机制旨在确保所有用户的 API 请求都能公平且高效地得到处理，维护整体系统的可靠性。

当客户端（例如您的应用程序或交易机器人）向 Bitfinex API 发送请求时，平台会监控请求的频率。如果请求的发送频率超过了预设的速率限制阈值，API 将会暂时拒绝后续的请求，并返回一个错误响应代码，通常是 HTTP 状态码 429 (Too Many Requests)。错误信息中会包含关于超出速率限制的详细说明，以及建议的重试时间间隔。

理解并遵守 Bitfinex 的速率限制规则至关重要。不当的 API 请求频率不仅会导致您的应用程序无法正常工作，还可能对 Bitfinex 的服务器造成不必要的压力。因此，在设计和开发基于 Bitfinex API 的应用程序时，务必充分考虑速率限制的影响，并采取相应的措施来避免超出限制。

有效的速率限制管理策略包括：实施请求队列机制，使用指数退避算法进行重试，以及利用缓存技术来减少不必要的 API 调用。您可以在 Bitfinex 官方文档中找到关于速率限制的具体参数和详细信息，包括不同 API 端点的速率限制额度、重置周期、以及如何通过 API 响应头来监控剩余的请求额度。仔细研读官方文档，并根据实际需求调整您的应用程序，是高效利用 Bitfinex API 的关键。