掌握Coinbase API：轻松获取数据，安全交易？新手指南！

阅读：16 分类： 解答

Coinbase API 接口获取

Coinbase 提供了强大的 API (应用程序编程接口)，允许开发者集成 Coinbase 的各种功能到自己的应用程序中，例如获取实时市场数据、管理账户、进行交易等。 本文将详细介绍如何使用 Coinbase API 获取数据和进行操作。

准备工作

在使用 Coinbase API 之前，为了确保顺利集成和安全操作，你需要完成以下准备步骤：

  1. 创建 Coinbase 开发者账户： 访问 Coinbase Developer Portal 并注册一个开发者账户。 开发者账户是访问和管理你的 Coinbase API 密钥、监控 API 使用情况以及获取开发者支持的基础。请务必使用有效的电子邮件地址注册，并妥善保管你的账户凭据。
  2. 创建 API 密钥： 成功登录你的开发者账户后，你需要创建一个新的 API 密钥，用于验证你的应用程序对 Coinbase API 的访问权限。在创建 API 密钥时，务必仔细选择适当的权限范围 (scopes)。权限范围决定了你的应用程序可以访问哪些资源以及执行哪些操作。常用的权限范围包括 wallet:accounts:read (读取账户信息), wallet:accounts:write (创建和修改账户), wallet:transactions:read (读取交易记录), wallet:transactions:write (发起交易), wallet:buys:create (创建购买订单), wallet:sells:create (创建出售订单) 等。为了最大限度地保证账户安全，强烈建议遵循最小权限原则，即仅选择你的应用程序实际需要的权限。请务必妥善保管你的 API 密钥，避免将其泄露给未经授权的第三方。泄露的 API 密钥可能被用于恶意活动，导致资金损失或账户安全问题。 Coinbase 提供了 sandbox 环境，允许开发者在模拟环境中测试 API 集成，而无需使用真实资金。强烈建议在生产环境中使用 API 密钥之前，务必在 sandbox 环境中进行充分的测试，以确保应用程序的稳定性和安全性。
  3. 选择编程语言和库： 根据你的技术栈和项目需求，选择你熟悉的编程语言（例如 Python、Java、Node.js、Go、PHP 等）和相应的 HTTP 客户端库。 HTTP 客户端库负责处理与 Coinbase API 服务器之间的 HTTP 请求和响应。常用的 HTTP 客户端库包括 Python 的 requests 库、Java 的 HttpClient 或 OkHttp 、Node.js 的 axios 或 node-fetch 、Go 的 net/http 包、PHP 的 Guzzle 等。除了 HTTP 客户端库之外，Coinbase 官方和社区还提供了多种编程语言的 SDK（软件开发工具包），这些 SDK 封装了 Coinbase API 的常用功能，可以大大简化开发过程，减少直接与 API 交互的复杂性。使用 SDK 可以提高开发效率，减少出错的可能性，并使代码更易于维护。

API 认证

Coinbase API 采用基于 API 密钥的认证机制，确保只有授权的应用程序才能访问用户数据和执行操作。 为了成功通过认证，您需要在每个发送到 Coinbase API 的 HTTP 请求头中包含以下三个关键字段： CB-ACCESS-KEY 、 CB-ACCESS-SIGN 和 CB-ACCESS-TIMESTAMP 。 这些字段协同工作，验证请求的来源和完整性。

  • CB-ACCESS-KEY: 这是您的唯一 API 密钥，用于标识您的应用程序。 您需要在 Coinbase 开发者平台上创建和获取此密钥。请务必妥善保管您的 API 密钥，防止泄露，因为它会授予未经授权的访问权限。
  • CB-ACCESS-SIGN: 这是一个使用您的 API Secret、请求方法（例如 GET、POST）、请求路径、时间戳和请求体（如果存在）计算出的加密 HMAC 签名。 该签名用于验证请求的真实性，确保请求在传输过程中没有被篡改。 HMAC 签名算法通常使用 SHA256 哈希函数。
  • CB-ACCESS-TIMESTAMP: 这是请求发送时的 Unix 时间戳（以秒为单位）。 时间戳用于防止重放攻击，在这种攻击中，恶意行为者试图重新发送之前捕获的有效请求。Coinbase 的服务器会验证时间戳的有效性，如果时间戳过旧，请求将被拒绝。

以下是使用 Python 计算签名的示例代码，包含了必要的库和更完整的请求处理：

import hmac import hashlib import time import requests import # 引入 库来处理 JSON 数据

api_key = 'YOUR_API_KEY' api_secret = 'YOUR_API_SECRET' base_url = 'https://api.coinbase.com/v2'

def generate_signature(timestamp, method, request_path, body=''): """生成 Coinbase API 请求的 HMAC 签名。""" message = str(timestamp) + method + request_path + body hmac_object = hmac.new(api_secret.encode('utf-8'), message.encode('utf-8'), hashlib.sha256) return hmac_object.hexdigest()

def make_request(method, path, data=None): """向 Coinbase API 发送请求并处理响应。""" timestamp = str(int(time.time())) if data: body = .dumps(data) # 将数据转换为 JSON 字符串 else: body = '' signature = generate_signature(timestamp, method, path, body) 

headers = {
    'CB-ACCESS-KEY': api_key,
    'CB-ACCESS-SIGN': signature,
    'CB-ACCESS-TIMESTAMP': timestamp,
    'Content-Type': 'application/' # 明确指定内容类型为 JSON
}

url = base_url + path

try:
    if method == 'GET':
        response = requests.get(url, headers=headers)
    elif method == 'POST':
        response = requests.post(url, headers=headers, data=body)
    elif method == 'PUT':
        response = requests.put(url, headers=headers, data=body)
    elif method == 'DELETE':
        response = requests.delete(url, headers=headers)

    response.raise_for_status()  # 为错误的响应（4xx 或 5xx）引发 HTTPError
    return response.() # 将响应解析为 JSON
except requests.exceptions.RequestException as e:
    print(f"请求失败: {e}")
    return None

Example usage:

获取当前用户的账户信息

以下代码展示了如何通过 API 获取当前用户的账户信息。它使用 make_request 函数发送 GET 请求到 /accounts 接口。如果请求成功，它将以格式化的 JSON 形式打印账户信息。

请注意，在执行此代码之前，需要确保已经正确配置了 API 密钥和 Secret。 这些凭据用于生成请求签名，以验证请求的真实性和完整性。 错误配置 API 密钥和 Secret 可能会导致请求失败或安全风险。

if __name__ == '__main__': account = make_request('GET', '/accounts') if account: print(.dumps(account, indent=4)) 

# 为指定账户 ID 创建新的地址:
# account_id = 'YOUR_ACCOUNT_ID'
# new_address = make_request('POST', f'/accounts/{account_id}/addresses')
# if new_address:
#     print(.dumps(new_address, indent=4))

上述注释代码演示了如何为一个特定的账户 ID 创建新的地址。 这通过向 /accounts/{account_id}/addresses 接口发送 POST 请求来实现。 account_id 需要替换为你要创建新地址的实际账户 ID。创建新地址后，响应将包含新地址的详细信息，并以格式化的 JSON 形式打印出来。

在上述代码段中， generate_signature 函数负责计算 HMAC 签名，该签名对于验证 API 请求至关重要。 make_request 函数用于实际发送 API 请求，它处理与 API 交互的所有必要步骤，包括构建请求、添加身份验证标头以及处理响应。 需要注意的是，务必将占位符 YOUR_API_KEY 和 YOUR_API_SECRET 替换为你实际的 API 密钥和 Secret。 这些凭据对于访问 API 和确保你的请求得到正确授权至关重要。

常用 API 端点

Coinbase API 提供了众多端点，方便开发者访问和管理其 Coinbase 账户以及进行加密货币交易。以下列出了一些常用的端点，并对其功能和使用方法进行了详细说明：

  • 获取账户列表： GET /accounts

    此端点用于检索当前经过身份验证的用户的所有 Coinbase 账户列表。返回的信息包括账户 ID、账户类型（如钱包、保险库）、币种、余额等。此操作不需要额外的参数，只需有效的 API 密钥即可。

  • 获取单个账户信息： GET /accounts/:account_id

    通过指定 account_id ，此端点能够返回特定 Coinbase 账户的详细信息。返回的数据包括账户名称、币种、可用余额、状态等。有效的 account_id 必须提供，否则会返回错误。

  • 获取账户历史记录： GET /accounts/:account_id/transactions

    此端点允许你获取指定 Coinbase 账户 ID 的交易历史记录，包括买入、卖出、转账等所有类型的交易。可以通过添加查询参数来分页和过滤交易记录，例如 limit （限制返回的交易数量）和 before / after （指定交易的时间范围）。

  • 创建新的地址： POST /accounts/:account_id/addresses

    为指定的 Coinbase 账户 ID 创建一个新的加密货币地址。此功能对于接收来自外部钱包或交易所的资金非常有用。API 返回新创建的地址信息，包括地址字符串和用于生成二维码的 URL。

  • 发送资金： POST /accounts/:account_id/transactions

    从指定的 Coinbase 账户 ID 发送加密货币到另一个地址或 Coinbase 用户。此操作需要 wallet:transactions:write 权限。请求体中必须包含目标地址（ to ）、发送金额（ amount ）和货币类型（ currency ）。可以选择提供描述信息（ description ）以便于追踪交易。务必注意手续费的设置，可能需要根据网络拥堵情况进行调整。

  • 获取货币汇率： GET /exchange-rates

    获取不同货币之间的实时汇率。可以通过查询参数 currency 指定要获取汇率的目标货币。例如，要获取 BTC 兑 USD 的汇率，可以发送请求到 /exchange-rates?currency=BTC 。 返回值包含不同货币之间的汇率列表。

  • 获取现货价格： GET /prices/:currency_pair/spot

    获取指定货币对的当前现货价格，例如 BTC-USD 。现货价格反映了市场上最新的交易价格。返回值通常包含价格、货币对和时间戳。

  • 获取买入价格： GET /prices/:currency_pair/buy

    获取通过 Coinbase 平台购买指定货币对（如 BTC-USD ）的买入价格。此价格通常包含 Coinbase 的手续费。返回值包括买入价格、货币对和时间戳。

  • 获取卖出价格： GET /prices/:currency_pair/sell

    获取通过 Coinbase 平台出售指定货币对（如 BTC-USD ）的卖出价格。此价格通常会扣除 Coinbase 的手续费。 返回值包括卖出价格、货币对和时间戳。

  • 创建买单： POST /buys

    使用 Coinbase 账户购买加密货币。需要 wallet:buys:create 权限。 请求体中需要包含购买金额（ amount ）、货币类型（ currency ）和要购买的加密货币对（ currency_pair ）。可以指定 commit 参数来立即执行购买，或设置为 false 来预先查看交易详情。

  • 创建卖单： POST /sells

    出售 Coinbase 账户中的加密货币。需要 wallet:sells:create 权限。 请求体中需要包含出售金额（ amount ）、货币类型（ currency ）和要出售的加密货币对（ currency_pair ）。类似于买单，可以指定 commit 参数来立即执行出售，或设置为 false 来预先查看交易详情。

错误处理

Coinbase API 采用标准的 HTTP 状态码来指示请求的处理结果，为开发者提供了一种通用的方式来了解请求的成功与否。理解这些状态码对于构建健壮且可靠的应用程序至关重要。以下是一些常见的状态码及其含义：

  • 200 OK : 表示请求已成功处理。这表明服务器已成功接收、理解并处理了您的请求，并返回了预期的结果。
  • 400 Bad Request : 指示请求无效，通常是由于请求参数错误导致的。这可能包括参数缺失、参数格式不正确或参数值超出有效范围。开发者应仔细检查请求参数，确保其符合 API 的规范。
  • 401 Unauthorized : 表明认证失败。这通常是由于 API 密钥无效、过期或权限不足引起的。请确保您提供的 API 密钥是正确的，并且具有访问所需资源的权限。同时，注意 API 密钥的有效期限，并及时更新。
  • 403 Forbidden : 表示您没有权限访问所请求的资源。这可能由于您的 API 密钥没有足够的权限，或者该资源受到访问限制。请检查您的 API 密钥权限，或联系 Coinbase 支持获取更多信息。
  • 404 Not Found : 表明您请求的资源未找到。这可能由于资源 ID 不正确或资源已被删除。请检查您请求的 URL 和资源 ID，确保其正确无误。
  • 500 Internal Server Error : 指示服务器内部发生错误。这通常是一个服务器端的问题，您无法直接解决。建议您稍后重试该请求，或联系 Coinbase 支持寻求帮助。

当请求失败时，Coinbase API 通常会在响应体中返回 JSON 格式的错误信息，其中包含详细的错误代码和错误描述。这些错误信息可以帮助您诊断和解决问题。错误代码通常是一个简短的字符串，用于标识特定类型的错误，而错误描述则提供了更详细的错误信息。开发者应根据错误代码和错误描述，有针对性地调试应用程序，修复潜在的问题。为了提高应用程序的健壮性，建议在代码中添加完善的错误处理机制，例如使用 try-except 块来捕获异常，并进行适当的处理，例如记录错误日志、向用户显示友好的错误信息或自动重试请求。这可以避免应用程序因未处理的错误而崩溃，并提高用户体验。

使用限制

Coinbase API 实施了使用限制（Rate Limits），旨在保障平台的稳定性和公平性。当应用程序过于频繁地发送请求时，可能会超出这些限制，导致账户被暂时禁止访问。为了避免这种情况，开发者需要密切监控 API 的使用情况，并采取相应的应对措施。

开发者可以通过检查 HTTP 响应头中的 RateLimit-Remaining 和 RateLimit-Reset 字段，实时了解当前 API 使用情况。 RateLimit-Remaining 表示在当前时间窗口内剩余的可用请求数量，而 RateLimit-Reset 则表示到下一个时间窗口重置的剩余时间（通常以 Unix 时间戳表示）。通过分析这些信息，开发者可以及时调整请求频率，避免超出限制。

为了优化 API 使用效率，开发者应合理设计应用程序，避免发送不必要的请求。例如，可以采用缓存机制，将频繁访问且不经常变动的数据缓存在本地，减少对 API 的直接调用。还应实现重试机制，当遇到因超出速率限制而被拒绝的请求时，应用程序可以等待一段时间后自动重试，提高程序的健壮性。推荐使用指数退避算法来处理重试逻辑，以避免瞬间的大量重试请求再次触发速率限制。

Coinbase 会根据应用程序的使用情况以及所使用的 API 密钥类型，动态调整使用限制。对于有更高 API 调用需求的应用程序，开发者可以主动联系 Coinbase 官方，提交申请以获得更高的使用配额。在申请时，需要详细说明应用程序的用途、预期的 API 调用量以及对 API 性能的需求，以便 Coinbase 进行评估和审批。 同时，开发者应当定期检查并优化API调用方式，提高效率，并根据业务发展情况适时调整API调用计划。