Coinbase Pro API 接入指南：从入门到进阶
准备工作
要开始高效地使用 Coinbase Pro API，首要步骤是创建一个 Coinbase Pro 账户。若您已拥有 Coinbase 账户，则可无缝升级至 Coinbase Pro 平台，无需重新注册。账户设置完成后，务必导航至 Coinbase Pro 平台的 API 管理页面，该页面通常位于账户设置或安全设置区域，仔细查找 "API 密钥" 或 "API 访问" 选项。在此页面，您将生成 API 密钥，包括 API 密钥本身 (API Key)、API 私钥 (API Secret) 以及 API 密码 (API Passphrase)。请务必安全地存储这些密钥，因为它们是访问您 Coinbase Pro 账户和执行交易的关键凭证。任何泄露都可能导致资金损失或账户安全问题，切记不要将它们公开在代码库、公共论坛或任何不安全的地方。API 密钥允许您的应用程序安全地与 Coinbase Pro 交易所进行交互，进行数据查询、下单、取消订单等操作，极大地扩展了自动化交易和数据分析的可能性。请务必阅读 Coinbase Pro 官方 API 文档，了解速率限制、API 使用条款以及其他重要信息，以便合理、安全地使用 API。
API 密钥生成步骤：
- 登录 Coinbase Pro： 访问 Coinbase Pro 官方网站（pro.coinbase.com）并使用你的账户电子邮件地址和密码登录。确保启用双重验证（2FA）以增强账户安全性，这将需要在登录过程中输入验证码。
- 进入 API 设置： 成功登录后，导航至账户设置或用户设置区域。通常，API 密钥管理选项位于“API”或“安全”相关的子菜单中。如果在用户界面中找不到，请查阅 Coinbase Pro 官方文档或帮助中心。 具体位置可能因 Coinbase Pro 平台更新而有所变化。
- 创建新的 API 密钥： 在 API 管理页面中，点击“创建新的 API 密钥”、“生成 API 密钥”或类似的按钮。系统将提示你为该 API 密钥配置权限。
- View: 仅查看账户信息、市场数据等。
- Trade: 允许进行交易，包括下单、取消订单等。
- Transfer: 允许在账户之间转移资金 (需要谨慎使用)。
- API Key: 公钥，用于识别你的应用程序。
- API Secret: 私钥，用于对请求进行签名。 必须安全保管，切勿分享！
- Passphrase: 一个额外的安全口令，用于对请求进行签名。 同样必须安全保管！
选择合适的编程语言和库
Coinbase Pro API (现已更名为 Coinbase Advanced Trade API) 是一个 RESTful API，这意味着你可以使用任何支持发送和接收 HTTP 请求的编程语言与它进行交互。选择合适的编程语言和库是构建高效且可靠的加密货币交易应用的关键一步。以下是一些常用的选择，以及它们各自的优势和适用场景：
-
Python:
作为数据科学和自动化领域的首选语言，Python 拥有丰富的库和框架，极大地简化了与 Coinbase Advanced Trade API 的交互。常用的库包括
requests，它提供了一个简洁而强大的 HTTP 客户端，以及ccxt(CryptoCurrency eXchange Trading Library)。ccxt是一个更为高级的库，它统一了多个加密货币交易所的 API 接口，包括 Coinbase Advanced Trade。使用ccxt可以显著减少代码量，并更容易地在不同的交易所之间切换。Python 还拥有强大的数据分析和可视化库，如 NumPy, Pandas 和 Matplotlib，方便你分析交易数据和创建自定义指标。 -
JavaScript:
JavaScript 尤其适用于 Web 前端开发以及 Node.js 后端环境。在 Web 浏览器中，你可以直接使用
fetchAPI 发送 HTTP 请求。在 Node.js 环境中，可以使用axios或node-fetch等库来处理 API 请求。JavaScript 的异步编程模型非常适合处理高并发的交易数据流。 -
Java:
Java 是一种企业级语言，适用于构建大型、可扩展的应用程序。对于与 Coinbase Advanced Trade API 的交互，可以使用
OkHttp或HttpClient等成熟的 HTTP 客户端库。Java 的静态类型和强大的 IDE 支持可以帮助你编写更健壮的代码。 -
Go:
Go 语言以其高性能和并发性而闻名，非常适合构建高性能的交易系统。Go 的标准库包含
net/http包，可以方便地发送 HTTP 请求。Go 拥有出色的并发模型 (goroutines 和 channels)，能够有效地处理大量的并发连接和交易数据。
选择哪种编程语言最终取决于你的个人偏好、具体的项目需求以及你对各种语言的熟悉程度。如果你需要快速原型开发和数据分析，Python 可能是一个不错的选择。如果你需要构建高性能的交易系统，Go 语言可能更适合。对于 Web 应用，JavaScript 是一个自然的选项。Java 则适用于需要高可靠性和可维护性的企业级应用。
使用 API 进行身份验证
所有与 Coinbase Pro API 的交互都需要进行严格的身份验证，以确保安全性和授权访问。 这涉及使用您的 API 密钥 (API Key)、API 密钥密文 (API Secret) 和密码短语 (Passphrase) 对每个 API 请求进行数字签名。 此签名过程验证请求的来源和完整性，防止未经授权的访问和数据篡改。
身份验证过程的关键要素包括：
- API 密钥 (API Key)： 这是一个唯一的公共标识符，与您的 Coinbase Pro 账户相关联。 它用于识别发送 API 请求的应用程序或用户。 请务必安全地存储您的 API 密钥，并避免在不安全的环境中公开它。
- API 密钥密文 (API Secret)： 这是一个高度机密的密钥，与您的 API 密钥配对。 它用于创建用于验证每个 API 请求的数字签名。 API 密钥密文应被视为最高机密，并安全地存储在您的服务器或应用程序中。 绝不要与任何人分享您的 API 密钥密文。
- 密码短语 (Passphrase)： 这是您在创建 API 密钥时设置的额外安全层。 它充当验证您的身份的附加因素。 在生成签名时，必须包含正确的密码短语。
要对 API 请求进行身份验证，您需要执行以下步骤：
- 构建包含请求参数的规范化字符串。 此字符串必须以特定的格式创建，其中包括请求方法 (例如，GET、POST、PUT、DELETE)、请求路径和任何查询参数或请求正文。
- 使用您的 API 密钥密文和 HMAC-SHA256 算法对规范化字符串进行哈希处理。 这将生成一个唯一的数字签名。
-
将 API 密钥、时间戳和生成的签名作为 HTTP 标头包含在 API 请求中。 这些标头通常命名为
CB-ACCESS-KEY、CB-ACCESS-SIGN和CB-ACCESS-TIMESTAMP。 - 将请求发送到 Coinbase Pro API 端点。 Coinbase Pro 服务器将使用您提供的 API 密钥、签名和时间戳来验证请求。 如果签名有效，则请求将被处理；否则，将返回错误。
正确的身份验证对于保护您的 Coinbase Pro 账户和防止未经授权的访问至关重要。 请务必遵循 Coinbase Pro API 文档中提供的身份验证指南，并采取适当的安全措施来保护您的 API 密钥密文和密码短语。
签名过程:
-
构建签名字符串:
签名字符串是生成安全请求的关键，它包含了请求的多个重要组成部分，确保服务端能够验证请求的完整性和来源。详细构成如下：
-
HTTP 方法:
明确指定所使用的 HTTP 方法，例如
GET,POST,PUT,DELETE等。不同的方法代表不同的操作意图，必须准确反映。 -
请求路径:
这是 API 端点，指示你正在访问或操作的具体资源，例如
/accounts,/orders,/v2/prices。务必包含版本信息，以确保API的兼容性。 -
请求正文:
如果请求包含正文数据（通常用于
POST,PUT或PATCH请求），例如 JSON 格式的数据，则必须将其包含在签名字符串中。 在包含前，通常需要对请求体进行规范化处理，例如按照键名排序，以避免因格式差异导致签名验证失败。 - 当前时间戳: 使用 Unix 时间戳（自 1970 年 1 月 1 日 00:00:00 UTC 起经过的秒数）。这对于防止重放攻击至关重要。时间戳必须在服务器允许的时间窗口内（通常是几分钟），否则请求将被拒绝。
-
HTTP 方法:
明确指定所使用的 HTTP 方法，例如
-
使用 API Secret 进行 HMAC 签名:
使用你的 API Secret 对构建好的签名字符串进行哈希消息认证码（HMAC）签名。最佳实践是使用 SHA256 算法，因为它提供良好的安全性和性能。API Secret 应该被严格保密，绝对不能泄露给任何第三方。HMAC 过程确保只有拥有 API Secret 的人才能够生成有效的签名。签名过程如下：
- 选择合适的HMAC算法 (例如 SHA256).
- 将 API Secret 作为密钥。
- 对签名字符串进行HMAC运算。
- 得到二进制的签名结果。
-
将签名添加到 HTTP 头部:
将生成的签名和其他必要的认证信息添加到 HTTP 请求头部。这些头部用于认证你的身份并验证请求的完整性。
-
CB-ACCESS-KEY: 你的 API Key，用于标识你的身份。API Key 本身并不提供安全性，而是用于查找与你账户相关的 API Secret。 -
CB-ACCESS-SIGN: HMAC 签名结果，通常需要使用 Base64 编码，以便在 HTTP 头部中传输。Base64 编码将二进制数据转换为 ASCII 字符串。 -
CB-ACCESS-TIMESTAMP: 生成签名时使用的时间戳，确保与签名字符串中的时间戳一致。 -
CB-ACCESS-PASSPHRASE: 你的 Passphrase，作为额外的安全层，用于加密 API Secret 或其他敏感信息。如果未使用，可能需要设置为空字符串。
-
示例 (Python):
本示例展示了如何使用 Python 与 Coinbase Pro API 进行交互，包含创建签名以及发送请求的关键步骤。需要安装
requests
库。可以使用
pip install requests
命令进行安装。
import requests
import hmac
import hashlib
import time
import base64
为了成功进行 API 调用，需要以下凭证：
-
api_key: 您的 API 密钥，用于身份验证。 -
api_secret: 您的 API 密钥，用于生成签名。 -
api_passphrase: 您的 API 密码，提供额外的安全层。 -
api_url: Coinbase Pro API 的基本 URL。
请务必替换以下占位符：
api_key = 'YOUR_API_KEY'
api_secret = 'YOUR_API_SECRET'
api_passphrase = 'YOUR_API_PASSPHRASE'
api_url = 'https://api.pro.coinbase.com'
create_signature
函数用于创建 API 请求的数字签名。 此签名用于验证请求的真实性和完整性。 函数步骤如下：
- 生成当前时间戳。
- 将时间戳、HTTP 方法、请求路径和请求正文连接成一个字符串。
- 使用 API secret 作为密钥，使用 HMAC-SHA256 算法对连接后的字符串进行哈希处理。
- 将哈希结果进行 Base64 编码。
- 返回时间戳和 Base64 编码后的签名。
def create_signature(method, path, body=''):
timestamp = str(time.time())
message = timestamp + method + path + body
hmac_key = base64.b64decode(api_secret)
signature = hmac.new(hmac_key, message.encode('utf-8'), hashlib.sha256)
signature_b64 = base64.b64encode(signature.digest()).decode('utf-8')
return timestamp, signature_b64
send_request
函数负责发送 API 请求。 它接受 HTTP 方法、路径和可选的请求正文作为参数。函数步骤如下：
-
调用
create_signature函数生成时间戳和签名。 -
创建一个包含以下标头的字典：
-
CB-ACCESS-KEY: API 密钥。 -
CB-ACCESS-SIGN: 生成的签名。 -
CB-ACCESS-TIMESTAMP: 时间戳。 -
CB-ACCESS-PASSPHRASE: API 密码。 -
Content-Type: 指定请求体的媒体类型。 通常设置为application/。
-
- 根据 HTTP 方法发送请求。
-
对于
GET请求，使用requests.get函数。 -
对于
POST请求，使用requests.post函数，并将请求正文作为data参数传递。 -
处理其他 HTTP 方法，例如
PUT或DELETE（如果需要）。 - 返回响应对象。
def send_request(method, path, body=''):
timestamp, signature = create_signature(method, path, body)
headers = {
'CB-ACCESS-KEY': api_key,
'CB-ACCESS-SIGN': signature,
'CB-ACCESS-TIMESTAMP': timestamp,
'CB-ACCESS-PASSPHRASE': api_passphrase,
'Content-Type': 'application/'
}
url = api_url + path
if method == 'GET':
response = requests.get(url, headers=headers)
elif method == 'POST':
response = requests.post(url, headers=headers, data=body)
else:
return None # Handle other methods as needed
return response
示例：获取账户信息
在加密货币交易平台中，获取账户信息是常见的操作。以下示例展示了如何通过API请求获取用户的账户信息。我们使用
send_request
函数发送GET请求到
/accounts
端点。
response = send_request('GET', '/accounts')
上述代码行使用
send_request
函数，该函数接受两个参数：HTTP方法（在此示例中为
'GET'
）和API端点（在此示例中为
'/accounts'
）。
GET
方法用于从服务器检索数据。
/accounts
端点通常用于获取与用户账户相关的详细信息，例如账户余额、交易历史等。
接下来，检查响应是否成功。如果
response
对象存在（即请求成功），则提取并打印响应的内容。
if response:
print(response.())
else:
print("请求失败")
这里，
response.()
方法用于将响应内容解析为 JSON 格式，这是一种常见的数据交换格式，易于阅读和处理。如果请求失败（例如，由于网络问题、服务器错误或权限不足），则
response
对象将为
None
或 False 值，此时将打印 "请求失败" 消息。 在实际应用中，应当根据具体的错误类型进行更详细的错误处理。
常规 API 调用示例
以下是一些常见的 Coinbase Pro API 调用示例，展示了如何与交易所进行数据交互和执行交易操作：
-
获取账户信息:
使用
GET /accounts端点可以检索您的所有账户信息，包括账户 ID、货币类型、可用余额、已持有余额以及总余额。该 API 调用需要有效的身份验证凭据。 -
获取市场数据:
通过
GET /products端点，您可以获取所有可交易产品的信息。返回的数据包括产品 ID、交易对、基础货币、报价货币、交易手续费率以及市场交易状态（例如，是否可交易）。这对于了解当前交易所支持的交易对至关重要。 -
获取订单薄:
使用
GET /products/端点可以获取特定交易对的订单薄信息，例如/book GET /products/BTC-USD/book。您可以指定订单薄的深度（例如，只获取前 N 个买单和卖单），从而控制返回的数据量。订单薄信息包含了当前市场上的买单和卖单的价格和数量，对于分析市场深度和流动性非常有帮助。 -
下单:
通过
POST /orders端点，您可以提交新的交易订单。下单请求需要包含交易对、订单类型（例如，市价单、限价单）、订单方向（买入或卖出）、订单数量以及价格（如果是限价单）。成功下单后，API 将返回订单 ID，您可以使用该 ID 跟踪订单的状态。 -
取消订单:
使用
DELETE /orders/端点可以取消尚未成交的订单。您需要提供要取消的订单的 ID。成功取消订单后，API 将返回确认信息。
高级主题
- WebSocket API: Coinbase Pro 提供强大的 WebSocket API，它允许开发者接收近乎实时的市场数据和账户状态更新。相较于传统的 REST API，WebSocket 采用双向通信协议，无需客户端频繁发起请求（轮询），从而显著降低延迟，提高数据传输效率，更适合对实时性要求高的交易策略和应用场景。通过订阅特定的频道（如市场行情、订单簿、交易活动等），开发者可以即时获取所需信息，构建响应迅速的交易机器人、数据分析工具或用户界面。
- 速率限制: 为了维护系统的稳定性和公平性，Coinbase Pro 对 API 请求设置了速率限制。这意味着在特定时间段内，每个 API 密钥允许发起的请求数量是有限制的。超出速率限制会导致 API 调用失败。开发者必须充分了解并遵守这些限制，合理规划 API 请求频率。常见的应对策略包括：实施指数退避算法（当遇到速率限制错误时，逐渐增加重试间隔），使用批量请求（将多个操作合并到一个请求中），以及缓存不经常变动的数据。
- 错误处理: 与任何 API 交互一样，Coinbase Pro API 调用也可能因各种原因而失败。有效的错误处理机制对于构建健壮的应用程序至关重要。常见的错误类型包括：身份验证失败（无效的 API 密钥或签名）、速率限制错误（超出请求配额）、服务器错误（Coinbase Pro 内部问题）、以及无效的请求参数等。开发者应仔细阅读 API 文档，了解所有可能的错误代码及其含义，并编写相应的错误处理逻辑，例如重试失败的请求、记录错误日志、或向用户显示友好的错误提示。
-
安全性最佳实践:
- 切勿将 API Secret 和 Passphrase 硬编码到源代码中。 这是极不安全的做法，一旦泄露，攻击者可以完全控制你的账户。推荐使用环境变量或配置文件来安全地存储这些敏感凭据。环境变量将密钥存储在操作系统级别，而配置文件则允许你将其存储在应用程序外部。
- 限制 API 密钥的权限。 创建 API 密钥时，只授予应用程序所需的最低权限。例如，如果你的应用程序只需要读取市场数据，则不要授予其交易权限。这可以最大限度地降低密钥泄露造成的潜在损害。
- 启用 IP 地址限制。 Coinbase Pro 允许你将 API 密钥限制为特定的 IP 地址。这意味着只有来自这些 IP 地址的请求才会被接受。这可以防止未经授权的访问，即使攻击者获得了你的 API 密钥。
- 定期轮换 API 密钥。 定期更改 API 密钥是一种良好的安全习惯。即使你的密钥没有泄露，定期轮换也可以降低密钥在被利用之前的窗口期。
- 监控 API 使用情况，以检测任何可疑活动。 密切关注 API 请求的频率、来源和类型。如果发现任何异常活动，例如来自未知 IP 地址的大量交易请求，应立即采取行动，例如禁用 API 密钥或联系 Coinbase Pro 支持。
常见问题
-
我的 API 密钥不起作用。
确保你正确输入了 API Key、API Secret 和 Passphrase，并且大小写匹配。 Coinbase Pro API 区分大小写。 检查你的 API 密钥是否已激活，以及账户是否已完成必要的身份验证步骤。 请确认你的 API 密钥的权限设置是否允许你尝试执行的操作，例如交易、提现或查看账户信息。 某些 API 密钥可能仅限于只读访问权限。 检查你的 API 密钥是否存在 IP 地址限制，如果存在，请确保你的请求来源 IP 地址已添加到允许列表中。 验证你所使用的时间戳格式是否符合 Coinbase Pro API 的要求，通常是 Unix 时间戳（秒）或毫秒，并且需要与请求头中的
CB-ACCESS-TIMESTAMP一致。 -
我收到了 429 错误（请求过多）。
你已经超出了 Coinbase Pro 的速率限制。 不同 API 端点可能有不同的速率限制，请参考 Coinbase Pro API 文档了解具体的限制规则。 为了避免频繁触发 429 错误，建议实施指数退避算法以逐渐减少请求频率。 当收到 429 错误时，暂停发送后续请求，等待一段时间（例如几秒），然后重试。 每次重试时，增加等待时间（例如乘以 2）。 考虑使用队列来管理 API 请求，并控制并发请求的数量。 如果需要更高频率的请求，请考虑申请更高的速率限制或与 Coinbase Pro 洽谈企业级解决方案。
-
我收到了身份验证错误。
确保你的签名是正确的。 Coinbase Pro API 使用 HMAC SHA256 算法生成签名，签名必须与请求的 HTTP 方法、请求路径、请求体和时间戳对应。 仔细检查你的 API Key、API Secret 和 Passphrase 是否正确，并且没有空格或其他不可见字符。 请注意，API Secret 必须保密。 确保你的时间戳是准确的，并且与服务器时间相近，以避免时间戳过期错误。 时间戳通常允许在当前时间的 +/- 30 秒范围内。 检查请求头中是否包含了所有必需的身份验证信息，包括
CB-ACCESS-KEY(API Key)、CB-ACCESS-SIGN(签名) 和CB-ACCESS-TIMESTAMP(时间戳)。 -
我应该使用 REST API 还是 WebSocket API？
如果你需要实时市场数据更新、交易执行状态通知或其他需要立即响应的事件，请使用 WebSocket API。 WebSocket API 提供推送式的实时数据流，避免了频繁轮询 REST API 的开销。 如果你只需要偶尔获取历史数据、账户信息或执行批量操作，可以使用 REST API。 REST API 提供了按需请求数据的接口，适用于非实时性的数据访问场景。 根据你的应用场景和数据需求，选择合适的 API 可以提高效率并降低资源消耗。 WebSocket API 通常需要建立持久连接，并处理断线重连等问题。
通过仔细阅读 Coinbase Pro API 文档，充分理解 API 的各项功能和限制，并遵循最佳实践，例如错误处理、速率限制管理和安全性措施，你可以成功地将 Coinbase Pro API 集成到你的应用程序中，并构建可靠、高效的交易和数据分析工具。
