Coinbase API 密钥设置指南：开启自动交易之旅
Coinbase 作为一个主流的加密货币交易所，提供了强大的 API 接口，允许开发者和交易者通过程序化方式进行交易、数据分析和其他操作。利用 Coinbase API 密钥，你可以构建自己的交易机器人，实现自动化交易策略，从而解放双手，让程序为你 24/7 不间断地执行交易。本文将详细介绍如何在 Coinbase 平台上设置 API 密钥，并提供一些关键的安全建议。
一、准备工作
在开始使用Coinbase API之前，务必完成以下准备工作，以确保顺利进行开发和交易操作。
Coinbase 账户及身份验证： 你必须拥有一个有效的Coinbase账户。 为了符合安全和合规性要求，强烈建议完成Coinbase的身份验证流程。 这通常涉及提供个人信息、上传身份证明文件，并可能需要进行额外的验证步骤。 完成身份验证后，你的账户将获得更高的交易权限和安全性。
编程基础： 你需要具备一定的编程基础知识，能够理解和编写代码。 熟悉至少一种编程语言是至关重要的，例如Python、JavaScript、Node.js、Java或任何其他你擅长的语言。 选择一种你熟悉的语言将有助于你更快地掌握Coinbase API的使用，并能够更高效地开发应用程序。
API密钥： 为了能够通过代码与Coinbase API进行交互，你需要生成API密钥。 登录你的Coinbase账户，在开发者设置或API管理页面中创建新的API密钥。 务必妥善保管你的API密钥，切勿泄露给他人，避免未经授权的访问和操作。在生产环境中，考虑使用环境变量或更安全的密钥管理方案来存储你的API密钥。
API文档阅读： 仔细阅读Coinbase API的官方文档。 文档中包含了API的详细说明、可用端点、请求参数、响应格式、错误代码以及身份验证方法等重要信息。 熟悉API文档将帮助你了解API的功能和使用方法，从而能够编写出正确的代码，并解决可能遇到的问题。
开发环境配置： 根据你选择的编程语言，配置好相应的开发环境。 安装必要的库和工具，例如Python的`requests`库或Node.js的`node-fetch`库，这些库可以帮助你发送HTTP请求并处理API响应。 确保你的开发环境能够正常工作，并且能够访问互联网。
二、生成 API 密钥
- 登录账户： 访问交易所或平台的官方网站，使用您的用户名和密码登录您的账户。
- 导航至 API 管理页面： 登录后，找到账户设置或个人资料区域，通常会有一个名为“API 管理”、“API 密钥”或类似的选项。 不同交易所或平台位置可能有所不同。
- 创建新的 API 密钥： 在 API 管理页面，点击“创建 API 密钥”、“生成新密钥”或类似按钮。
-
配置 API 权限：
创建 API 密钥时，必须配置密钥的权限。仔细选择您需要的权限，例如“读取交易记录”、“下单”或“提现”。
务必遵循最小权限原则，仅授予 API 密钥所需的最小权限。
例如，如果您的应用程序只需要读取市场数据，请不要授予提现权限。
常见的权限类型包括：- 读取 (Read): 允许 API 密钥访问账户信息、市场数据和交易历史。
- 交易 (Trade): 允许 API 密钥下单、修改订单和取消订单。
- 提现 (Withdraw): 允许 API 密钥从您的账户提现资金。 该权限风险极高，请谨慎授予。
- 设置 IP 地址限制 (可选，强烈推荐)： 为了增强安全性，您可以将 API 密钥限制为特定的 IP 地址。 只有来自这些 IP 地址的请求才能使用该 API 密钥。 输入您的服务器或应用程序的公共 IP 地址。 如果您不确定您的 IP 地址，可以使用在线工具（例如 whatismyip.com）查找。
- 启用双重验证 (2FA) (如果可用，强烈推荐)： 一些平台允许您为 API 密钥启用双重验证。 启用后，每次使用 API 密钥时都需要输入来自您的身份验证器应用程序的代码。
- 生成并保存 API 密钥： 配置完权限和 IP 地址限制后，点击“生成”或“创建”按钮。 系统将生成您的 API 密钥（通常包括 API Key 和 Secret Key）。
- 安全存储 API 密钥： API Key 和 Secret Key 非常重要，类似于您的账户密码。 请务必将它们安全地存储在离线环境中或使用加密的密码管理器。 不要将它们存储在您的代码中或以纯文本形式发送它们。 Secret Key 通常只显示一次，请务必备份。
- 激活 API 密钥： 某些平台可能需要您激活新创建的 API 密钥。按照平台提供的说明进行激活。
-
重要权限：
-
wallet:accounts:read: 允许应用程序读取你的账户信息，包括但不限于账户余额、交易历史记录、账户创建时间以及与账户相关的其他元数据。该权限授予后，应用程序可以监控你的账户活动，但不能进行任何资金转移或修改。 -
wallet:accounts:update: 允许应用程序修改你的账户信息，例如更改账户名称、更新联系方式等。请务必谨慎授予此权限，因为不当使用可能导致账户信息泄露或被恶意篡改，从而带来潜在风险。在授予此权限前，请确认应用程序的安全性与可信度。 -
wallet:buys:create: 允许应用程序通过 API 自动创建购买订单，例如在交易所或其他平台上购买加密货币。授予此权限意味着应用程序可以代表你执行购买操作，请确认应用程序已采取足够的安全措施以防止未经授权的购买行为。 -
wallet:sells:create: 允许应用程序通过 API 自动创建出售订单，例如在交易所或其他平台上出售加密货币。授予此权限意味着应用程序可以代表你执行出售操作，同样需要确认应用程序的安全性，以防止非授权的出售行为，避免资产损失。 -
wallet:transactions:read: 允许应用程序读取你的所有交易记录，包括已完成的交易、待处理的交易以及交易的详细信息，例如交易时间、交易金额、交易对手地址等。此权限通常与账户信息读取权限结合使用，以便应用程序提供更全面的账户活动视图。 -
wallet:transactions:transfer: 允许应用程序在不同账户之间转移资金。这是一项非常敏感的权限，务必极其谨慎地授予。仅在绝对必要的情况下，并且在充分了解应用程序的安全机制后才应使用此权限。未经授权的资金转移可能导致严重的财务损失。建议启用双重验证或其他安全措施来保护你的资产。 -
trade:read: 允许应用程序读取交易对的相关信息，包括但不限于交易对的价格、交易量、深度图、历史交易数据等。此权限通常用于市场分析、价格监控和交易策略制定，不会影响你的账户安全或资金。 -
trade:orders:create: 允许应用程序创建新的交易订单，例如限价单、市价单等。授予此权限后，应用程序可以代表你自动提交订单到交易所或其他交易平台。请确保应用程序的交易策略符合你的风险承受能力和投资目标。 -
trade:orders:read: 允许应用程序读取已有的交易订单信息，包括订单状态、订单类型、订单价格、订单数量等。此权限通常用于监控订单执行情况、分析交易策略效果以及管理未完成的订单。 -
trade:orders:cancel: 允许应用程序取消已有的交易订单。授予此权限后，应用程序可以代表你撤销未成交的订单，从而避免潜在的损失或调整交易策略。请注意，取消订单可能会产生交易费用。
wallet:accounts:read和wallet:buys:create权限，而不要授予wallet:accounts:update或wallet:transactions:transfer等不必要的权限。 -
三、安全建议
API 密钥的安全至关重要，一旦泄露，可能导致未经授权的访问和资金损失。请务必严格遵循以下安全建议，以保障您的账户和资产安全：
-
妥善保管 API 密钥：
API 密钥应视为高度敏感信息，如同您的银行密码。切勿将 API 密钥存储在不安全的位置，如：
- 明文存储在代码中
- 提交到公共代码仓库（如 GitHub）
- 通过不安全的渠道（如电子邮件、即时通讯工具）传输
四、代码示例 (Python)
以下是一个使用 Python 调用 Coinbase API（更准确地说是 Coinbase Pro API，现在称为 Coinbase Advanced Trade API）获取账户余额的示例代码。本示例使用
cbpro
Python 库，这是一个非官方但广泛使用的 Coinbase Pro API 客户端库。
为了运行此代码，你需要安装
cbpro
库，可以使用 pip 命令：
pip install cbpro
。 你需要一个 Coinbase Advanced Trade API 密钥对，包括 API 密钥、密钥密码和 API 秘密密钥。 务必安全地存储这些凭据，并避免将它们直接嵌入到代码中。推荐使用环境变量或其他安全的密钥管理方法。
import cbpro # Coinbase Pro Python library (now Coinbase Advanced Trade API)
import os
# 从环境变量中获取 API 密钥、密钥密码和 API 秘密密钥
api_key = os.environ.get("COINBASE_API_KEY")
api_secret = os.environ.get("COINBASE_API_SECRET")
api_passphrase = os.environ.get("COINBASE_API_PASSPHRASE")
# 确保环境变量已设置
if not all([api_key, api_secret, api_passphrase]):
print("错误：请设置 COINBASE_API_KEY, COINBASE_API_SECRET 和 COINBASE_API_PASSPHRASE 环境变量。")
exit()
# 创建 Coinbase Pro API 客户端
auth_client = cbpro.AuthenticatedClient(api_key, api_secret, api_passphrase)
# 获取账户列表
try:
accounts = auth_client.get_accounts()
# 遍历账户列表并打印余额
for account in accounts:
print(f"账户 ID: {account['id']}")
print(f"货币: {account['currency']}")
print(f"可用余额: {account['available']}")
print(f"总余额: {account['balance']}")
print("-" * 20)
except Exception as e:
print(f"发生错误：{e}")
代码解释：
-
导入库：
cbpro库用于与 Coinbase Pro API 交互，os库用于访问环境变量。 - 获取 API 凭据： 从环境变量中检索 API 密钥、密钥密码和 API 秘密密钥。这是一个比直接在代码中硬编码更安全的方法。
- 创建 API 客户端： 使用提供的 API 凭据创建一个经过身份验证的 Coinbase Pro API 客户端。
-
获取账户信息：
调用
auth_client.get_accounts()方法来检索与你的 API 密钥关联的账户列表。 - 处理响应： 遍历账户列表，并打印每个账户的账户 ID、货币、可用余额和总余额。
-
错误处理：
使用
try...except块来捕获可能发生的任何异常，例如网络错误或身份验证问题。
重要提示：
- 务必保护好你的 API 密钥，不要与他人分享。
- 仔细阅读 Coinbase Pro API 文档，了解速率限制和其他限制。
- 此代码仅用于演示目的，可能需要进行修改以满足你的特定需求。
-
由于 Coinbase Pro API 已被 Coinbase Advanced Trade API 取代，请考虑使用 Coinbase 提供的官方 SDK 或更新的
cbpro库版本，它们可能更好地支持新的 API。
从环境变量中获取 API 密钥
为了安全地管理您的 Coinbase API 密钥，最佳实践是从环境变量中读取它们。
这样可以避免将敏感信息直接硬编码到您的代码中，降低泄露风险。
以下代码展示了如何使用 Python 的
os
模块来实现：
api_key = os.environ.get("COINBASE_API_KEY")
api_secret = os.environ.get("COINBASE_API_SECRET")
api_passphrase = os.environ.get("COINBASE_API_PASSPHRASE")
这段代码使用
os.environ.get()
函数来尝试从环境变量中获取对应的值。
例如，
os.environ.get("COINBASE_API_KEY")
会查找名为
COINBASE_API_KEY
的环境变量，并返回它的值。 如果环境变量不存在，
则返回
None
。
使用环境变量的好处：
- 安全性： 避免将 API 密钥直接存储在代码库中，防止意外泄露。
- 灵活性： 可以在不同的环境（例如，开发、测试、生产）中使用不同的 API 密钥，而无需修改代码。
- 易于管理： 可以通过操作系统或部署平台提供的工具来集中管理环境变量。
设置环境变量：
环境变量的设置方法取决于您使用的操作系统和环境。 以下是一些常见的方法：
-
Linux/macOS:
可以将环境变量添加到
.bashrc,.zshrc或其他 shell 配置文件中，例如：export COINBASE_API_KEY="your_api_key" export COINBASE_API_SECRET="your_api_secret" export COINBASE_API_PASSPHRASE="your_api_passphrase" - Windows: 可以通过“系统属性” -> “高级” -> “环境变量”来设置环境变量。
-
Docker:
可以在
docker run命令中使用-e选项，或者在docker-compose.yml文件中设置environment字段。 - 云平台: 大多数云平台（例如 AWS, Google Cloud, Azure）都提供专门的界面或服务来管理环境变量。
重要提示：
请务必妥善保管您的 API 密钥，不要将其泄露给他人。 避免将 API 密钥提交到公共代码仓库。 定期轮换您的 API 密钥，以降低安全风险。
创建 Coinbase Pro 客户端
与 Coinbase Pro API 交互的第一步是实例化一个经过身份验证的客户端。 这需要您的 API 密钥、API 密钥密码和 API 密钥私钥。
使用
cbpro.AuthenticatedClient
类创建客户端，并将您的凭据作为参数传递：
auth_client = cbpro.AuthenticatedClient(api_key, api_secret, api_passphrase)
api_key
是您在 Coinbase Pro 网站上生成的 API 密钥字符串。
api_secret
是与您的 API 密钥关联的私钥字符串，务必妥善保管。
api_passphrase
是您在创建 API 密钥时设置的密码。
请确保您已安装
cbpro
Python 库。如果未安装，可以使用 pip 安装：
pip install cbpro
成功创建客户端后，您就可以使用
auth_client
对象调用 Coinbase Pro API 的各种方法，例如下单、查询账户余额和获取历史数据。
获取账户列表
使用 Coinbase 交易所的 API 获取用户账户列表，是进行交易和管理资产的基础步骤。
auth_client.get_accounts()
方法用于从 Coinbase 交易所获取与已认证用户关联的所有账户信息。
该方法返回一个包含账户信息的列表，每个账户的信息可能包括账户 ID、币种、余额等。通过解析返回的数据，你可以了解用户在 Coinbase 交易所拥有的各种加密货币资产及其数量。
示例代码：
accounts = auth_client.get_accounts()
其中，
auth_client
是已经完成身份验证的 Coinbase API 客户端实例。执行此代码后，
accounts
变量将存储账户列表数据，可以进一步处理和分析。例如，可以遍历账户列表，提取每个账户的余额信息，用于构建投资组合视图或进行自动化交易决策。
打印账户余额
以下代码段展示了如何遍历账户列表并打印每个账户的详细余额信息。它使用了一个简单的循环结构，针对列表中的每个账户，提取并格式化输出账户ID、币种以及余额。这种方法便于快速查看和核对账户信息。
for account in accounts:
print(f"Account ID: {account['id']}")
print(f"Currency: {account['currency']}")
print(f"Balance: {account['balance']}")
print("-" * 20)
代码解析：
-
for account in accounts:：这是一个循环语句，它会遍历名为accounts的列表。accounts列表中的每个元素（即每个账户）在循环中被赋值给变量account。 -
print(f"Account ID: {account['id']}")：这行代码使用f-string（格式化字符串字面量）打印账户的ID。account['id']表示访问当前账户字典中键为'id'的值。 -
print(f"Currency: {account['currency']}")：类似于账户ID，这行代码打印账户的币种，从当前账户字典中获取键为'currency'的值。 -
print(f"Balance: {account['balance']}")：这行代码打印账户的余额，从当前账户字典中获取键为'balance'的值。 -
print("-" * 20)：这行代码打印20个连字符，用于在每个账户的余额信息之间创建一个分隔线，提高可读性。
注意事项：
-
确保
accounts变量是一个包含账户信息的列表，每个账户都是一个字典，且包含'id'、'currency'和'balance'这些键。 -
balance的值可能是整数、浮点数或其他数值类型。根据实际情况，可能需要对balance进行格式化，例如保留指定位数的小数。 - 此代码段仅用于演示目的。在实际应用中，可能需要添加错误处理机制，例如检查账户字典中是否存在所需的键。
重要提示：
-
安装
cbproPython 库： 在开始之前，请务必确认您的 Python 环境中已安装 Coinbase Pro API 的官方 Python 客户端库cbpro。 您可以使用 Python 的包管理器pip来安装此库，执行命令：pip install cbpro。 如果您使用的是 Jupyter Notebook 或其他类似环境，可能需要使用!pip install cbpro。 -
配置 API 密钥环境变量：
为了安全地访问 Coinbase Pro API，您需要将 API Key、API Secret 和 API Passphrase 设置为环境变量。 这避免了将敏感凭据直接嵌入到代码中，从而降低了安全风险。
- API Key： 您的 API 密钥，用于标识您的 Coinbase Pro 账户。
- API Secret： 您的 API 密钥的秘密密钥，用于签名 API 请求。
- API Passphrase： 您的 API 密钥的密码短语，提供额外的安全层。
export命令。 在 Windows 中，您可以通过“系统属性”对话框设置环境变量。 请参考您操作系统的文档获取更详细的指导。 -
代码示例的用途和局限性：
本代码示例旨在提供一个关于如何使用
cbpro库与 Coinbase Pro API 交互的基本演示。 务必理解此代码仅用于教学和演示目的。 在实际应用中，您需要根据您的特定交易策略、风险管理策略和安全需求对其进行修改和定制。 请仔细审查和测试代码，确保其符合您的预期。
五、高级用法
Coinbase API 不仅支持基础的加密货币交易，还提供了诸多高级功能，以满足开发者构建复杂交易应用和策略的需求。这些高级功能提供了更深入的市场数据和更强大的交易控制能力。
-
WebSocket API：
WebSocket API 提供了一个持久连接，允许开发者实时接收来自 Coinbase 交易所的市场数据更新。这包括：
- 实时价格更新：追踪特定交易对的最新价格变动。
- 实时交易数据：获取最新成交的交易信息，包括交易价格、交易数量和交易时间。
- 市场深度更新：了解买单和卖单的分布情况，以及其随时间的变化。
- ticker 信息: 交易对的滚动统计信息，如 24 小时交易量，最高价，最低价等。
通过订阅特定的频道，开发者可以根据自己的需求定制接收的数据类型和交易对。这对于高频交易、算法交易和实时监控应用至关重要。
-
Order Book API：
Order Book API 允许开发者获取 Coinbase 交易所的订单簿数据，也称为挂单薄。订单簿是当前市场上所有未成交买单和卖单的集合，按价格排序，展示了市场参与者的买卖意愿。通过分析订单簿数据，开发者可以：
- 评估市场深度：了解在不同价格水平上的买单和卖单数量，判断市场支撑位和阻力位。
- 识别潜在的价格变动：观察订单簿中买卖压力的变化，预测价格走势。
- 执行更优的交易策略：根据订单簿信息调整交易指令，例如选择合适的交易价格和数量。
Order Book API 通常提供不同精度的订单簿快照，开发者可以根据自己的需求选择合适的数据级别。
-
Historical Data API：
Historical Data API 允许开发者访问 Coinbase 交易所的历史交易数据。这些数据包括：
- 历史交易记录：获取特定时间段内的所有交易信息，包括交易价格、交易数量、交易时间和交易对。
- K 线数据（OHLCV）：获取指定时间间隔内的开盘价、最高价、最低价、收盘价和交易量数据，用于技术分析。
- 市场深度快照：获取历史时间点的订单薄数据，了解历史市场状况。
通过分析历史交易数据，开发者可以识别市场趋势、回测交易策略、构建预测模型和进行风险管理。Historical Data API 是量化交易和市场研究的重要工具。
熟练运用这些高级 API 功能，开发者可以设计和实施更复杂、更精密的交易策略，从而在加密货币市场中获得竞争优势。需要注意的是，合理使用 API 接口，避免过于频繁的请求导致IP被限制。