还在苦恼Coinbase交易？超全API教程助你轻松搞定！

技术 2025-03-06 95 次浏览

Coinbase API提供自动化交易、市场数据获取等强大功能。本文详细介绍API密钥获取、认证及Python示例，助你轻松构建Coinbase应用。

Coinbase API 交易指南

Coinbase API 为开发者提供了一种与 Coinbase 交易所交互的强大方式。通过 API，您可以自动化交易、获取市场数据、管理账户，以及构建基于 Coinbase 的应用程序。 本文将详细介绍如何通过 Coinbase API 进行交易，包括认证、订单类型、以及常见问题。

1. API 密钥获取与认证

在使用 Coinbase API 之前，必须先生成并获取有效的 API 密钥，这是访问 Coinbase 平台功能的关键步骤。API 密钥允许您以编程方式与 Coinbase 交互，执行诸如获取账户信息、进行交易和管理加密货币等操作。

  1. 登录您的 Coinbase 账户。您需要拥有一个有效的 Coinbase 账户才能创建 API 密钥。确保您已完成注册并验证了您的账户。
  2. 导航至 API 设置页面。API 设置页面通常位于您的账户设置或开发者设置区域，具体位置可能因 Coinbase 平台更新而略有不同。在账户控制面板中寻找类似“API”、“开发者”或“集成”的选项。
  3. 创建新的 API 密钥，并谨慎设置相应的权限。在创建 API 密钥时，系统会要求您为其分配特定的权限。权限控制着该密钥能够执行的操作范围。例如，如果您的应用需要进行交易，则必须授予“交易”权限。出于安全考虑，应仅授予密钥所需的最小权限集，避免不必要的风险。
  4. 保存您的 API 密钥（包括 API 密钥和 API 密钥密语）。API 密钥由两部分组成：API 密钥本身和一个 API 密钥密语（secret）。密钥密语是用于签署 API 请求的敏感信息，务必妥善保管。Coinbase 通常只在创建密钥时显示一次密钥密语，因此请立即将其安全存储在您信任的地方，例如密码管理器。如果丢失密钥密语，您可能需要重新生成 API 密钥。

获取 API 密钥后，您需要将其用于身份验证，才能安全地访问 Coinbase API。Coinbase API 采用 OAuth 2.0 协议进行身份验证和授权。这意味着您需要使用 API 密钥生成访问令牌，然后将该令牌包含在后续的 API 请求头中，以证明您的身份并获得访问权限。OAuth 2.0 是一种行业标准的授权框架，它允许用户授予第三方应用程序访问其资源的权限，而无需共享其密码。

不同的编程语言和库提供了不同的 OAuth 2.0 实现方式。以下是一个使用 Python 和 requests 库的示例，演示如何使用 API 密钥进行身份验证并生成访问令牌（请确保已安装 requests 库： pip install requests ）：

import requests

API KEY = "YOUR API KEY"
API SECRET = "YOUR API SECRET"

生成访问令牌 (需要Coinbase OAuth)

Coinbase OAuth 流程较为复杂，通常需要用户授权

这里提供一个简化的示例，实际应用中需要完善OAuth流程

建议使用官方库或者成熟的OAuth库

以下只是一个占位符，真实使用需要实现OAuth 2.0授权流程

get_access_token() 函数的功能是获取访问令牌(Access Token)，这是与Coinbase API进行交互的必要凭证。在实际应用中，必须实现完整的OAuth 2.0授权流程，才能安全地获取该令牌。该函数的主要职责包括：

  • 用户授权重定向: 将用户重定向到Coinbase的授权服务器，用户需要在此处登录并授权您的应用程序访问其Coinbase账户。
  • 授权码交换: 在用户授权后，Coinbase会将用户重定向回您的应用程序，并附带一个授权码(Authorization Code)。您的应用程序需要使用此授权码向Coinbase的令牌端点(Token Endpoint)发送请求。
  • 访问令牌获取: 在收到Coinbase的令牌端点的响应后，您将获得访问令牌(Access Token)以及刷新令牌(Refresh Token)。访问令牌用于对后续的API请求进行身份验证，而刷新令牌用于在访问令牌过期后获取新的访问令牌，无需用户再次授权。
  • 错误处理: 在授权流程的任何阶段，都可能发生错误，例如用户拒绝授权或网络连接问题。您的应用程序需要妥善处理这些错误，并向用户提供友好的错误提示。 
# 这里只是一个简单的模拟，用于演示目的，并不安全，不能用于生产环境。
# 真正的OAuth 2.0流程需要处理状态参数、PKCE (Proof Key for Code Exchange) 等安全措施。
def get_access_token():
    # 实际的OAuth 2.0授权流程涉及以下步骤：
    # 1. 构建授权URL，并将用户重定向到Coinbase授权服务器。
    # 2. 用户登录Coinbase并授权您的应用程序。
    # 3. Coinbase将用户重定向回您的应用程序，并附带授权码。
    # 4. 使用授权码向Coinbase的令牌端点发送POST请求，交换访问令牌。
    # 5. 从响应中提取访问令牌和刷新令牌。
    # 6. 安全地存储访问令牌和刷新令牌。

    # 以下代码仅为示例，请替换为实际的OAuth 2.0实现。
    # 例如，您可以使用requests_oauthlib库来简化OAuth 2.0流程。

    # 请务必将"YOUR_CLIENT_ID"和"YOUR_CLIENT_SECRET"替换为您在Coinbase开发者平台注册的应用程序的客户端ID和客户端密钥。
    # 同时，确保"YOUR_REDIRECT_URI"与您在Coinbase开发者平台注册的回调URL一致。

    # 建议使用PKCE (Proof Key for Code Exchange) 来增强OAuth 2.0的安全性。

    #  示例（不完整，仅供参考）：
    # from requests_oauthlib import OAuth2Session
    #
    # client_id = "YOUR_CLIENT_ID"
    # client_secret = "YOUR_CLIENT_SECRET"
    # redirect_uri = "YOUR_REDIRECT_URI"
    #
    # coinbase = OAuth2Session(client_id, redirect_uri=redirect_uri, scope=['wallet:accounts:read', 'wallet:addresses:create'])
    # authorization_url, state = coinbase.authorization_url('https://www.coinbase.com/oauth/authorize')
    #
    # print('请访问以下URL进行授权：', authorization_url)
    # redirect_response = input('请输入重定向后的URL：')
    #
    # token = coinbase.fetch_token('https://api.coinbase.com/oauth/token', client_secret=client_secret, authorization_response=redirect_response)
    #
    # return token['access_token']
    return "YOUR_ACCESS_TOKEN"  # 模拟返回的访问令牌，切勿在生产环境中使用

ACCESS_TOKEN = get_access_token() 这行代码调用 get_access_token() 函数来获取访问令牌，并将该令牌存储在名为 ACCESS_TOKEN 的变量中。后续所有需要身份验证的API请求都需要携带此令牌。 请务必妥善保管您的访问令牌，避免泄露。

示例：获取 Coinbase 账户信息并验证 API 密钥有效性

通过向 Coinbase API 发送请求，我们可以验证 API 密钥的有效性并获取账户信息。 以下代码片段展示了如何构造带有必要身份验证头的 HTTP 请求。 请注意，虽然某些示例可能直接使用 API 密钥和密钥，但最佳实践是利用 HMAC 签名来提高安全性。

url = "https://api.coinbase.com/v2/accounts"

请求头 ( headers ) 包含 API 密钥和身份验证信息。 Authorization 头使用 Bearer 令牌， CB-ACCESS-KEY 指定 API 密钥。 CB-ACCESS-SIGN 通常不直接使用密钥，而应包含根据请求参数和密钥生成的 HMAC 签名。 CB-ACCESS-TIMESTAMP 同样需要按照 Coinbase API 规范计算并包含在请求头中，它用于防止重放攻击。

headers = { "Authorization": f"Bearer {ACCESS_TOKEN}", "CB-ACCESS-KEY": API_KEY, "CB-ACCESS-SIGN": "HMAC 签名 (根据 API 规范生成)", "CB-ACCESS-TIMESTAMP": "Unix 时间戳 (秒级)" }

使用 requests.get 函数发送 GET 请求到指定的 URL，并将构造的请求头包含在内。

response = requests.get(url, headers=headers)

检查响应状态码 ( response.status_code ) 以确定请求是否成功。 200 的状态码表示请求已成功处理。 如果状态码不是 200 ，则表示发生了错误。 从 response.text 中可以获取更详细的错误信息。

if response.status_code == 200: print("身份验证成功!") print(.dumps(response.(), indent=4)) else: print(f"身份验证失败: {response.status_code} - {response.text}")

成功时，打印验证成功消息和格式化的 JSON 响应内容。 失败时，打印错误消息，其中包含状态码和服务器返回的错误文本。

重要提示: 上述代码段仅为示例，真实的OAuth授权流程更为复杂，需要使用专门的OAuth库并处理用户重定向和授权。同时，签名计算也需要根据Coinbase API的官方文档进行。

2. 订单类型与参数

Coinbase API 提供了一系列订单类型，赋予用户高度的交易策略灵活性。理解这些订单类型及其参数对于有效利用Coinbase平台至关重要。常见的订单类型详细说明如下：

  • 市价单 (Market Order): 指示交易所立即以当前最佳可用市场价格执行买入或卖出操作的订单。 市价单的首要目标是快速成交，因此成交是有保证的，但最终成交价格可能会因市场波动而与预期有所差异。应谨慎使用市价单，尤其是在市场波动剧烈时期。
  • 限价单 (Limit Order): 是一种指定了交易执行价格上限（买入）或下限（卖出）的订单。 只有当市场价格达到或优于指定价格时，限价单才会被执行。 限价单允许交易者控制交易价格，但不能保证一定能成交，因为市场价格可能永远不会达到指定的限价。 它可以用于在期望的价格点进入或退出市场。
  • 止损单 (Stop Order): 当市场价格达到或超过预设的止损价格时，止损单会被触发，并自动转换为市价单。 止损单的主要目的是限制潜在损失，当价格向不利方向移动时，可以自动平仓。 止损单无法保证成交价格，最终成交价格可能低于或高于止损价格，尤其是在快速变化的市场中。
  • 止损限价单 (Stop Limit Order): 结合了止损单和限价单的特性。 当市场价格达到止损价格时，止损限价单会被触发，并创建一个限价单。 与止损单不同，止损限价单允许交易者指定执行订单的价格范围。 这提供了比止损单更精细的控制，但如果市场价格迅速变化，订单可能无法成交。 止损限价单要求指定两个价格：止损价格（触发订单）和限价（订单的执行价格）。

为了正确创建和执行订单，必须提供必要的参数。 每个订单类型都依赖于一组特定的参数。下面列出了一些关键的参数及其含义：

  • type : 指定订单的类型。 常见的值包括 "market" (市价单), "limit" (限价单), "stop" (止损单), 和 "stop_limit" (止损限价单)。
  • side : 指示交易的方向。 可选值为 "buy" (买入) 或 "sell" (卖出)。
  • product_id : 明确指定要交易的交易对。 例如，"BTC-USD" 表示比特币与美元的交易对。
  • size : 表示要买入或卖出的资产数量。 例如，"0.01 BTC" 表示交易 0.01 个比特币。 请注意，Coinbase 对最小交易规模有限制。
  • price : 对于限价单和止损限价单，此参数指定订单执行的限价。 这是买入订单愿意支付的最高价格，或者卖出订单愿意接受的最低价格。
  • stop_price : 对于止损单和止损限价单，此参数定义了触发订单的止损价格。 当市场价格达到或超过此价格时，订单将被激活。
  • client_oid : 一个由客户端生成的唯一订单标识符。 这允许您轻松跟踪和管理您的订单。 建议使用 UUID 等标准方法生成唯一 ID。

3. 发起交易请求

通过 API 密钥完成身份验证后，下一步是构造并发送交易请求。交易请求是与 Coinbase API 交互的核心，允许用户执行买卖操作，查询账户信息等。请求通常通过 HTTPS 协议发送，保证数据传输的安全性。

交易请求主要采用 HTTP POST 方法，目标端点是 Coinbase API 的 /orders 端点。该端点接收包含交易详细信息的 JSON 格式请求体，并根据请求参数执行相应的操作。请求体必须包含必要的参数，如交易类型、交易对、数量和价格。缺少或错误的参数会导致请求失败。

身份验证信息需要通过 HTTP Header 传递，确保 API 能够验证请求的来源并授权执行操作。常用的身份验证方式包括使用 API 密钥和签名。API 密钥用于标识用户，签名用于验证请求的完整性和真实性，防止篡改。

以下是一个使用 Python 和 requests 库的示例，演示如何创建一个限价买单： 

import requests
import hmac
import hashlib
import time
import 
from requests.auth import AuthBase

# 创建自定义身份验证类
class CoinbaseExchangeAuth(AuthBase):
    def __init__(self, api_key, secret_key, passphrase):
        self.api_key = api_key
        self.secret_key = secret_key
        self.passphrase = passphrase

    def __call__(self, request):
        timestamp = str(time.time())
        message = timestamp + request.method + request.path_url + (request.body or '')
        hmac_key = self.secret_key.encode('utf-8')
        message = message.encode('utf-8')
        signature = hmac.new(hmac_key, message, hashlib.sha256).hexdigest()

        request.headers.update({
            'CB-ACCESS-SIGN': signature,
            'CB-ACCESS-TIMESTAMP': timestamp,
            'CB-ACCESS-KEY': self.api_key,
            'CB-ACCESS-PASSPHRASE': self.passphrase,
            'Content-Type': 'application/'
        })
        return request

API_KEY = "YOUR_API_KEY"
API_SECRET = "YOUR_API_SECRET"
API_PASSPHRASE = "YOUR_API_PASSPHRASE" #通常情况下，Coinbase API需要passphrase
api_url = "https://api.coinbase.com" #注意：正式环境和沙盒环境的API URL不同

auth = CoinbaseExchangeAuth(API_KEY, API_SECRET, API_PASSPHRASE)

order = {
    "size": "0.01", # 交易数量
    "price": "9000", # 限价价格
    "side": "buy", # 交易方向：buy（买入）或 sell（卖出）
    "product_id": "BTC-USD", # 交易对：例如 BTC-USD（比特币/美元）
    "type": "limit", # 订单类型：limit（限价单）或 market（市价单）
    "time_in_force": "GTC" # GTC (Good-Til-Cancelled)订单会一直有效，直到被取消
}

try:
    response = requests.post(api_url + '/orders', =order, auth=auth)
    response.raise_for_status() # 检查HTTP错误
    print(response.()) # 打印响应内容
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")

API KEY = "YOUR API KEY" API SECRET = "YOUR API SECRET"

生成访问令牌 (需要Coinbase OAuth)

Coinbase OAuth 流程较为复杂，通常需要用户授权

这里提供一个简化的示例，实际应用中需要完善OAuth流程

建议使用官方库或者成熟的OAuth库

以下只是一个占位符，真实使用需要实现OAuth授权流程

get_access_token() 函数用于获取访问令牌。在实际应用中，需要实现完整的 OAuth 2.0 授权流程，而不是简单地返回一个占位符。OAuth 2.0 授权流程通常包括：

  • 重定向用户到 Coinbase 进行授权： 应用程序需要将用户重定向到 Coinbase 的授权端点，用户在此处登录并授予应用程序访问其 Coinbase 账户的权限。
  • 交换授权码以获取访问令牌： 成功授权后，Coinbase 会将用户重定向回应用程序，并附带一个授权码。应用程序需要将此授权码发送到 Coinbase 的令牌端点，以换取访问令牌 (access token) 和刷新令牌 (refresh token)。
  • 使用刷新令牌获取新的访问令牌： 访问令牌具有有效期。当访问令牌过期时，可以使用刷新令牌来获取新的访问令牌，而无需再次提示用户授权。 
# 这里只是一个简单的模拟，并不完整
def get_access_token():
  # 替换为实际的OAuth授权流程
  # 这通常涉及重定向用户到Coinbase进行授权，
  # 并交换授权码以获得访问令牌。
  return "YOUR_ACCESS_TOKEN"

ACCESS_TOKEN = get_access_token() 将通过 OAuth 流程获得的访问令牌赋值给变量 ACCESS_TOKEN 。该令牌是后续 API 请求中进行身份验证的关键。

url = "https://api.coinbase.com/v2/orders" 定义了 Coinbase API 的订单创建端点 URL。所有向 Coinbase 下单的请求都会发送到这个地址。

headers = { ... } 定义了 API 请求的 HTTP 头部信息。这些头部信息包括：

  • "Authorization": f"Bearer {ACCESS_TOKEN}" : 使用 Bearer 认证方案，将访问令牌包含在 Authorization 头部中。
  • "Content-Type": "application/" : 指定请求体的 MIME 类型为 JSON。
  • "CB-ACCESS-KEY": API_KEY : 你的 Coinbase API 密钥，用于标识你的应用程序。 重要提示： 强烈建议不要在客户端代码中硬编码 API 密钥。 应该通过服务器端或环境变量安全地管理密钥。
  • "CB-ACCESS-SIGN": "signature" : 数字签名，用于验证请求的完整性和真实性。 重要提示： 需要使用你的 API 密钥和 API 密钥的秘密密钥来计算签名，确保数据传输的安全。
  • "CB-ACCESS-TIMESTAMP": "timestamp" : 请求的时间戳，用于防止重放攻击。 重要提示： 时间戳必须在服务器时间戳的合理范围内。

data = { ... } 定义了创建限价单所需的 JSON 数据。这些数据包括：

  • "type": "limit" : 指定订单类型为限价单。
  • "side": "buy" : 指定订单方向为买入。
  • "product_id": "BTC-USD" : 指定交易对为 BTC-USD (比特币兑美元)。
  • "size": "0.001" : 指定购买的比特币数量为 0.001 BTC。
  • "price": "25000.00" : 指定限价单的价格为 25000.00 美元。只有当市场价格达到或低于此价格时，订单才会被执行。
  • "client_oid": "my_unique_order_id" : 客户端提供的唯一订单 ID。 用于跟踪和识别订单。 重要提示： 确保 client_oid 的唯一性。

response = requests.post(url, headers=headers, data=.dumps(data)) 使用 Python 的 requests 库向 Coinbase API 发送 POST 请求，创建限价单。 .dumps(data) 将 Python 字典转换为 JSON 字符串。

if response.status_code == 200: ... else: ... 检查 API 响应的状态码。如果状态码为 200，表示订单已成功下单。否则，表示订单下单失败，会打印错误信息，包括状态码和错误文本。 response.() 用于将响应体解析为 JSON 格式，方便查看订单详情。

重要提示: 请务必仔细阅读 Coinbase API 文档，了解每个参数的含义和要求。 错误的参数可能导致订单无法执行，甚至导致账户异常。 CB-ACCESS-SIGN 和 CB-ACCESS-TIMESTAMP 的生成需要严格按照Coinbase API文档中的HMAC签名规范进行计算。

4. 订单状态查询与取消

创建订单后，及时了解订单的状态至关重要。您可以通过API接口查询订单的当前状态，以便追踪订单执行情况。 订单状态主要包含以下几种类型：

  • "open" (未成交) ：订单已提交至交易平台，但尚未完全或部分成交。订单仍在等待被撮合。
  • "pending" (挂起) ：订单可能由于各种原因被暂时挂起，例如系统维护、风控检查或其他异常情况。具体原因需要进一步通过API获取详细信息。
  • "done" (已成交或已取消) ：订单已完全成交、部分成交后被取消或被用户主动取消。 "done"状态需要结合具体成交量来判断。

为了方便查询，API支持使用以下两种方式定位特定订单：

  • 订单ID (Order ID) ：由交易平台生成的唯一订单标识符。这是最准确的查询方式。
  • 客户端订单ID (Client Order ID) ：由用户在创建订单时自定义的订单标识符。允许用户自定义订单ID，方便内部系统管理和对账。如果使用客户端订单ID查询，请确保其唯一性，否则可能返回多个结果。

在订单未成交（状态为 "open"）或部分成交的情况下，您可以选择取消订单。通过API发送取消订单请求，可以撤销尚未成交的部分，从而有效管理您的交易策略和降低风险。请注意，已成交的部分无法取消。取消成功后，订单状态将变为 "done"。

5. 错误处理

Coinbase API 交互中，开发者会遇到多种错误类型，有效的错误处理机制至关重要。 这些错误可能源于多个方面，包括但不限于身份验证失败、权限不足、参数不正确、账户余额不足以及市场交易时段限制等。 务必针对不同错误类型制定相应的应对策略，以确保交易流程的健壮性和可靠性。

  • 身份验证错误 (Authentication Errors): 这类错误通常指示提供的 API 密钥无效、过期或权限不足。 检查您的 API 密钥是否已正确配置，并确认密钥是否具有执行所需操作的必要权限。 定期轮换 API 密钥，并确保安全地存储它们，是防止身份验证错误的有效措施。
  • 权限错误 (Authorization Errors): 即使成功通过身份验证，您可能仍然遇到权限错误。 这意味着您的 API 密钥可能不具备执行特定操作（例如，创建交易或访问某些数据）的授权。 仔细审查您的 API 密钥的权限设置，并根据您的应用程序的需求进行调整。
  • 参数错误 (Parameter Errors): 这类错误表明您在 API 请求中传递了无效或格式不正确的参数。 仔细检查 API 文档，确保您提供的参数类型、格式和值符合要求。 使用验证库可以帮助您在发送请求之前捕获参数错误。
  • 余额不足错误 (Insufficient Funds Errors): 当您尝试执行交易时，如果您的账户余额不足以支付交易金额和手续费，就会发生此类错误。 在执行交易之前，务必查询您的账户余额，并确保有足够的资金可用。 设置余额警告可以帮助您避免因余额不足而导致的交易失败。
  • 市场未开放错误 (Market Not Open Errors): Coinbase 的某些交易对可能仅在特定的交易时段开放。 如果您尝试在市场关闭时执行交易，就会收到此类错误。 查阅 Coinbase 的市场时间表，了解各个交易对的开放时间。

处理 Coinbase API 错误时，首要步骤是查阅 Coinbase API 文档 ，详细了解错误代码的具体含义以及对应的推荐解决方案。 文档通常提供关于错误原因、可能的影响以及如何解决问题的详细信息。 除了参考官方文档，建立一套完善的日志记录系统也很重要，它可以帮助您跟踪错误发生的时间、频率和上下文，从而更快地诊断和解决问题。 实施重试机制可以自动处理一些临时性错误，例如网络连接问题，从而提高交易系统的弹性。 良好的错误处理策略不仅可以最大限度地减少交易失败的可能性，还可以提升用户体验，并确保交易系统的稳定运行。

6. 安全注意事项

在使用 Coinbase API 进行交易时，安全性至关重要。以下是一些关键的安全建议，务必认真对待：

  • 严格保管您的 API 密钥。 API 密钥如同账户密码，泄露会导致资产损失。切勿在公共场合（例如论坛、社交媒体、版本控制系统）分享您的密钥。妥善保管在安全的地方，例如加密的配置文件或密钥管理系统。
  • 限制密钥权限。 Coinbase API 允许您为每个 API 密钥分配特定的权限。仅授予密钥执行所需操作的最小权限集。例如，如果密钥只需要读取账户信息，则不要授予其交易权限。使用细粒度的权限控制，降低密钥泄露造成的潜在风险。
  • 始终使用 HTTPS 进行通信。 HTTPS 协议通过加密传输数据，防止中间人攻击。确保所有与 Coinbase API 的通信都通过 HTTPS 进行。所有正规的 API 客户端库默认都会使用 HTTPS。
  • 定期审查您的 API 密钥和权限。 定期检查您的 API 密钥和权限设置。评估密钥的必要性，并撤销不再需要的密钥。审查密钥权限，确保它们仍然符合最低权限原则。密钥泄露事件通常不会立即被发现，定期审查有助于及时发现并阻止潜在的安全威胁。
  • 采用安全的编程实践，防范代码漏洞。 编写安全的代码至关重要。避免常见的安全漏洞，例如 SQL 注入、跨站脚本攻击（XSS）和跨站请求伪造（CSRF）。进行代码审查，并使用静态代码分析工具，及早发现潜在的安全问题。
  • 启用双重身份验证（2FA）。 为您的 Coinbase 账户启用双重身份验证，增加一层额外的安全保护。即使攻击者获得了您的 API 密钥，也需要通过第二重验证才能访问您的账户。
  • 设置账户安全警报。 Coinbase 允许您设置安全警报，以便在账户发生异常活动时收到通知。例如，您可以设置警报，当账户发生大额提现或异常登录时收到通知。及时响应安全警报，可以有效降低潜在的损失。

遵循这些安全建议，结合您自身的安全需求，可以有效降低安全风险，保护您的 Coinbase 账户和资金安全。持续关注 Coinbase 官方的安全公告和建议，及时更新您的安全措施。