Upbit API：量化交易黄金指南，限时开放！

Upbit API 接口设置

简介

Upbit 是韩国领先的数字资产交易所，以其广泛的交易对选择、强大的交易引擎和用户友好的界面而闻名。 为了满足机构投资者、量化交易者和希望自动化交易策略的个人用户的需求，Upbit 提供了功能全面的应用程序编程接口 (API)。 通过 Upbit API，用户可以无需手动操作，直接与交易所进行交互，从而实现高效的程序化交易和深入的数据分析。 该API允许获取实时市场数据，包括最新成交价、交易量和订单簿信息；执行买卖订单，包括市价单、限价单等多种订单类型；以及全面管理账户，例如查询账户余额、监控交易历史和管理API密钥。本文档旨在提供一个详细的分步指南，帮助您在Upbit平台上成功设置并开始使用API接口，从而解锁更高级的交易和数据分析功能。

准备工作

在开始设置 Upbit API 接口之前，务必进行充分的准备，这将显著简化后续开发过程并降低出错概率。

1. 拥有并验证 Upbit 账号： 您需要一个有效的 Upbit 账号。如果没有账号，请访问 Upbit 官方网站注册一个账号。注册后，务必完成身份验证（KYC，Know Your Customer）。身份验证通常需要提供身份证明文件和地址证明，这是访问 Upbit API 的必要条件。未经验证的账户可能无法使用某些 API 功能。
2. API 基础知识： 了解 API (Application Programming Interface) 的基本原理至关重要。API 允许不同的软件系统相互通信。理解诸如 API 的作用，常见的 HTTP 请求方法（GET 用于获取数据，POST 用于创建数据，PUT 用于更新数据，DELETE 用于删除数据），以及状态码（例如 200 OK，400 Bad Request，401 Unauthorized，500 Internal Server Error）等概念是必要的。熟悉 RESTful API 的设计原则也有助于更好地理解 Upbit API 的工作方式。
3. 编程语言和开发环境配置： 选择一种您熟悉的编程语言，例如 Python, Java, JavaScript, C# 等。根据所选语言，配置相应的开发环境。Visual Studio Code (VS Code), PyCharm, IntelliJ IDEA 等都是常用的开发环境。选择合适的开发环境可以提高开发效率。确保您的开发环境已正确安装并配置了必要的工具和依赖项。
4. 安装 Upbit API 客户端库： 根据您选择的编程语言，安装与 Upbit API 交互的客户端库。对于 Python， requests 库用于发送 HTTP 请求， pyupbit 库是专门为 Upbit API 设计的封装库，可以简化 API 交互。对于其他语言，搜索并安装相应的 Upbit API 客户端库或自行构建 HTTP 请求。使用客户端库可以简化身份验证、请求签名和数据解析等步骤。
5. 精读 Upbit API 文档： Upbit 提供了详尽的 API 文档，详细描述了每个 API 端点的功能、参数、请求格式、响应格式和错误代码。认真阅读 API 文档，了解每个 API 的用途和限制。重点关注 API 的速率限制（rate limits），以避免因超出限制而被阻止访问。理解 API 的认证机制（authentication）是正确使用 API 的关键。查阅文档中的示例代码可以帮助您更快地开始使用 API。

创建 API 密钥

要使用 Upbit API，您首先需要创建 API 密钥。API 密钥包含了 Access Key 和 Secret Key ，这两者是您访问和操作 Upbit 平台的身份凭证，务必妥善保管。

1. 登录 Upbit 账号： 使用您的 Upbit 账号登录官方 Upbit 网站。确保您访问的是官方网址，以避免钓鱼网站的风险。
2. 进入 API 管理页面： 登录 Upbit 官网后，点击您的头像，在下拉菜单中选择 "API 관리" (API Management) 进入 API 管理页面。您也可以通过直接访问链接 https://upbit.com/mypage/open_api_management 来快速进入该页面。请注意，只有登录状态下才能访问该链接。
3. 创建新密钥： 在 API 管理页面，找到并点击 "Open API 키 발급" (Issue Open API Key) 按钮。此按钮通常位于页面的右上角或底部。点击后会弹出一个对话框，引导您完成密钥创建流程。
4. 设置 API 权限： 在弹出的对话框中，您需要设置 API 的权限。 Upbit 提供了精细的权限控制选项，请务必根据您的实际需求谨慎选择。Upbit 提供的权限选项包括：
   • 조회 전용 (只读): 这是权限最低的选项，允许您获取市场行情数据、账户余额信息等，但无法执行任何交易操作。适合用于数据分析、监控等场景。
   • 거래 가능 (交易): 允许您进行交易，包括买入和卖出数字货币。选择此权限后，您可以通过 API 执行下单、取消订单等操作。请务必谨慎使用，并仔细阅读交易相关的 API 文档。
   • 출금 가능 (提现): 允许您从 Upbit 账户中提取数字资产。 强烈建议您不要开启此权限，除非您确实需要程序自动提现。开启此权限会大大增加您的账户安全风险。 如果您需要提现，建议手动在 Upbit 官网进行。

   请务必根据您的需求谨慎选择 API 权限。如果您只需要获取市场数据，强烈建议只选择 "조회 전용" 权限。如果您需要进行交易，请选择 "거래 가능" 权限，并仔细阅读交易相关的 API 文档，了解每个 API 接口的具体功能和参数。 请勿轻易开启 "출금 가능" 权限，以防止资产损失。 开启提现权限可能导致您的资产被未经授权的程序转移。

5. 输入 API 说明： 在 "API 설명" (API Description) 栏中，输入对 API 的描述，例如 "我的量化交易机器人" 或 "数据分析脚本"。这有助于您区分不同的 API 密钥，方便日后管理。请使用有意义的描述，以便在多个 API 密钥的情况下快速识别。
6. 同意条款并创建： 阅读并同意 Upbit 的 API 使用条款。请仔细阅读这些条款，了解您的权利和义务。然后，点击 "확인" (Confirm) 按钮，完成 API 密钥的创建。
7. 获取 Access Key 和 Secret Key： 创建成功后，系统会生成 Access Key 和 Secret Key。 请务必妥善保管您的 Secret Key，不要泄露给任何人。 Secret Key 只会显示一次，并且是您访问 Upbit API 的最高机密。如果丢失，您需要重新创建 API 密钥，并更新所有使用该密钥的应用程序。将 Secret Key 视为您的银行密码，务必采取一切必要的安全措施来保护它。建议使用密码管理器等工具来安全地存储 Secret Key。

   Access Key 可以公开，但 Secret Key 必须保密。可以将 Access Key 视为您的用户名，而 Secret Key 则是您的密码。任何拥有您的 Secret Key 的人都可以完全控制您的 Upbit 账户。

使用 API 密钥

创建 API 密钥后，您可以通过编程方式访问和管理您的加密货币账户。API 密钥由一个 Access Key 和一个 Secret Key 组成，Access Key 用于标识您的身份，Secret Key 用于验证您的请求。请务必妥善保管您的 Secret Key，切勿泄露给他人，否则可能导致您的账户资金损失。

下面以 Python 语言为例，演示如何使用 API 密钥获取账户余额。本示例使用 `pyupbit` 库，这是一个 Upbit 交易所的 Python 客户端库。您需要先安装该库才能运行以下代码：

pip install pyupbit

安装完成后，您可以将以下代码复制到您的 Python 环境中：

import pyupbit

access = "YOUR_ACCESS_KEY"  # 替换为你的 Access Key
secret = "YOUR_SECRET_KEY"   # 替换为你的 Secret Key

upbit = pyupbit.Upbit(access, secret)

balances = upbit.get_balances()

for balance in balances:
    print(balance)

在使用这段代码之前，请将 `YOUR_ACCESS_KEY` 替换为您实际的 Access Key，将 `YOUR_SECRET_KEY` 替换为您实际的 Secret Key。然后运行代码，您将会看到您的账户余额信息。

这段代码首先导入 `pyupbit` 库，然后使用您的 Access Key 和 Secret Key 创建一个 Upbit 客户端对象。接下来，调用 `get_balances()` 方法获取您的账户余额信息。`get_balances()` 方法返回一个列表，其中包含您的所有币种的余额信息。使用循环遍历列表，并打印每个币种的余额信息。

请注意，不同的交易所可能使用不同的 API 库和方法来获取账户余额。您需要根据您所使用的交易所的 API 文档进行相应的调整。

代码解释：

1. 导入 pyupbit 库： 使用 import pyupbit 语句将 pyupbit 库引入到您的 Python 代码中。pyupbit 库是专门为与 Upbit 交易所进行交互而设计的，它提供了访问 Upbit API 的便捷接口，简化了交易、查询市场数据和管理账户等操作的流程。安装pyupbit库可以使用pip工具： pip install pyupbit 。
2. 设置 Access Key 和 Secret Key： 为了安全地访问您的 Upbit 账户，您需要设置 Access Key 和 Secret Key。将代码中的占位符 YOUR_ACCESS_KEY 和 YOUR_SECRET_KEY 替换为您从 Upbit 交易所获得的真实密钥。请务必妥善保管您的密钥，不要将其泄露给他人，也不要将其存储在不安全的地方。您可以在Upbit官网的API管理页面创建和管理您的Access Key和Secret Key。
3. 创建 Upbit 对象： 通过调用 pyupbit.Upbit(access, secret) 函数创建一个 Upbit 对象。这个对象是您与 Upbit 交易所进行交互的桥梁。在创建对象时，您需要传入您的 Access Key 和 Secret Key，以便 Upbit 验证您的身份。这个Upbit对象将用于后续的账户余额查询、交易下单等操作。
4. 获取账户余额： 使用 upbit.get_balances() 方法可以获取您在 Upbit 交易所中的所有账户余额信息。该方法返回一个包含您所有币种余额的列表。这些余额信息包括您持有的每种加密货币的数量，以及对应的可用余额和冻结余额。注意：为了保证数据是最新的，可以考虑在获取余额信息前，先调用 upbit.get_tick() 或其他方法来同步数据。
5. 打印账户余额： 使用 for 循环遍历 upbit.get_balances() 方法返回的账户余额列表。对于列表中的每个元素（代表一个币种），我们使用 print() 函数将其信息打印到控制台上。 通常打印的信息包括币种的名称、总余额、可用余额等。 开发者可以根据自己的需求格式化输出内容，比如只显示余额大于某个阈值的币种。通过这种方式，您可以清晰地了解您在 Upbit 交易所的资产状况。

其他示例：

• 获取市场价格：

使用 pyupbit.get_current_price("KRW-BTC") 函数可以获取指定交易对的当前市场价格。 例如， "KRW-BTC" 代表韩元（KRW）计价的比特币（BTC）价格。 该函数会返回一个浮点数，表示最新成交价。 print(price) 语句用于在控制台输出获取到的BTC韩元价格。该价格数据来源于Upbit交易所。

• 下单买入：

假设账户里有足够的韩元余额

执行以下代码可以在Upbit交易所使用市价单购买价值10000韩元的比特币。市价单会以当前市场最优价格立即成交，确保交易的快速执行。需要确保你的Upbit账户里有足够支付的韩元余额。

ret = upbit.buy_market_order("KRW-BTC", 10000)

这行代码使用 upbit.buy_market_order() 函数，指定交易市场为"KRW-BTC"（韩元计价的比特币市场），并设定购买总价值为10000韩元。该函数会返回一个包含交易信息的字典。

交易市场代码 "KRW-BTC" 明确指定了交易对。其中 "KRW" 代表韩元（Korean Won）， "BTC" 代表比特币。因此，此代码指示程序在 Upbit 交易所使用韩元购买比特币。

print(ret)

这行代码将打印出 upbit.buy_market_order() 函数返回的字典，其中包含了交易的详细信息，例如交易UUID、交易数量、平均购买价格等。通过查看返回信息，可以确认交易是否成功，并获取交易的具体数据。需要注意的是，实际购买的比特币数量会受到市场价格波动的影响，最终成交数量会略有差异。交易执行时，Upbit会收取一定比例的手续费。

注意：

• 权限要求： 订单提交和执行操作必须具备 " 거래 가능 "（交易权限）。 请确保您的API密钥已启用此权限，否则交易请求将被拒绝。 检查您的账户设置，确保已正确配置交易权限。
• API 文档： 在使用Upbit API之前，请务必详尽阅读官方 Upbit API 文档 。 理解每个API接口的详细参数说明、请求方式（如GET、POST）、数据格式（如JSON），以及返回值结构和错误代码。 熟悉文档是成功集成Upbit API 的关键。
• 风险控制： 在进行任何实盘交易之前，强烈建议进行充分的模拟测试。 利用Upbit提供的测试环境或使用小额资金进行试单。 制定并严格执行合理的止损策略，以控制潜在的交易风险。 请根据您的风险承受能力和交易目标，谨慎设置止损点。
• 安全最佳实践： 为了保障您的账户安全，请定期轮换您的API密钥。 定期更换API密钥可以降低密钥泄露的风险。 同时，务必妥善保管您的API密钥，切勿将其泄露给任何第三方，并避免在不安全的环境中存储或传输密钥。 启用双因素认证（2FA）以增强账户安全性。

常见问题

• API 密钥失效：

  您的 API 密钥是访问 Upbit API 的凭证。密钥失效通常由于以下原因：密钥过期（某些交易所会设置密钥有效期）、人为禁用（您或交易所出于安全考虑禁用了密钥）或系统自动禁用（例如，检测到异常活动）。 请立即检查您的 Upbit API 密钥的状态。登录您的 Upbit 账户，导航至 API 管理页面，查看密钥是否显示为“已激活”或类似状态。如果密钥已过期或被禁用，您需要生成新的 API 密钥对。 生成新的 API 密钥后，请务必妥善保管您的私钥，并更新您所有使用旧密钥的应用程序和脚本。切勿在公共场合（例如代码仓库、论坛）分享您的 API 密钥。

• API 请求错误：

  API 请求错误表明您的应用程序发送的请求不符合 Upbit API 的规范。常见的错误原因包括：

  • 参数缺失： 某些 API 接口需要特定的参数才能正常工作。请仔细阅读 Upbit API 文档，确保您提供了所有必需的参数。
  • 参数格式错误： 参数必须按照 API 文档中规定的格式提供。例如，日期必须是 YYYY-MM-DD 格式，数字必须是整数或浮点数。请检查您发送的参数是否符合要求的格式。
  • 权限不足： 您的 API 密钥可能没有执行特定操作的权限。Upbit 允许您为 API 密钥分配不同的权限（例如，只读、交易）。请检查您的密钥是否具有执行您所请求操作所需的权限。
  为了诊断 API 请求错误，请仔细检查 Upbit API 返回的错误信息。错误信息通常包含错误代码和详细的描述，可以帮助您确定问题的根源。您还可以使用 API 调试工具（例如 Postman）来测试您的 API 请求。

• API 请求频率限制：

  Upbit 为了防止滥用和维护系统稳定，对 API 请求频率进行了限制（也称为“限流”）。每个 API 接口都有自己的请求频率限制。如果您在短时间内发送过多的请求，Upbit 会返回错误，告知您已超过请求频率限制。 Upbit API 文档中详细说明了每个接口的请求频率限制。请务必仔细阅读文档，并确保您的应用程序不会超过这些限制。 您可以采取以下措施来避免超过请求频率限制：

  • 减少不必要的 API 请求： 优化您的应用程序，只在需要时才发送 API 请求。
  • 使用缓存： 将 API 响应缓存起来，以便在短时间内重复使用。
  • 实现速率限制器： 在您的应用程序中实现一个速率限制器，以控制 API 请求的发送速度。
  如果您需要更高的 API 请求频率，可以联系 Upbit 申请提高限制。

• 网络问题：

  不稳定的网络连接会导致 API 请求失败。请确保您的计算机或服务器已连接到互联网，并且网络连接稳定。 您可以尝试以下方法来解决网络问题：

  • 检查您的网络连接： 确保您的网络连接正常工作。您可以尝试访问其他网站或使用 ping 命令来测试您的网络连接。
  • 检查您的防火墙设置： 确保您的防火墙没有阻止 API 请求。
  • 检查您的 DNS 设置： 确保您的 DNS 设置正确。
  • 尝试使用不同的网络： 如果您使用的是 Wi-Fi 连接，请尝试使用有线连接。如果问题仍然存在，请尝试使用不同的网络。
  如果网络问题仍然存在，请联系您的网络服务提供商。

安全提示

• 妥善保管 API 密钥： 请务必采取最高级别的安全措施保管您的 Access Key 和 Secret Key。切勿以任何方式（包括但不限于截屏、邮件、聊天记录等）泄露给任何人。Access Key 和 Secret Key 一旦泄露，可能导致您的资产面临风险。务必将其视为高度机密信息，如同银行密码一般对待。
• 限制 API 权限： 请根据您的实际交易和数据需求，谨慎且精确地选择 API 权限。仔细评估每项权限的风险，只授予必要的权限。如果您仅需获取市场数据进行分析或研究，强烈建议仅选择 "조회 전용" （只读）权限，避免授予任何交易或资金操作权限，从而最大限度地降低潜在的安全风险。
• 定期更换 API 密钥： 为了进一步提升账户安全，强烈建议您养成定期更换 API 密钥的习惯。密钥更换周期可以根据您的安全需求和风险承受能力进行调整，例如每月或每季度更换一次。更换密钥后，请务必及时更新所有使用该密钥的应用程序和脚本。
• 开启双重验证 (2FA)： 强烈建议您立即开启 Upbit 账户的双重验证 (2FA) 功能，例如 Google Authenticator 或短信验证。双重验证为您的账户增加了一层额外的安全保护，即使您的密码泄露，攻击者也难以未经授权访问您的账户，显著提高账户的整体安全性。
• 监控 API 使用情况： 定期且密切地监控 API 的使用情况，例如 API 请求量、交易记录、资金变动等。设置合理的监控阈值，并在发现异常情况时立即采取行动，例如禁用 API 密钥、更改账户密码或联系 Upbit 客服。及时发现并处理异常情况是保障资金安全的关键。
• 使用安全的开发环境： 务必确保您的开发环境安全可靠。使用最新的操作系统和安全软件，定期进行安全扫描和漏洞修复。避免在公共网络或不安全的设备上存储或使用 API 密钥。对所有代码进行安全审查，防止出现安全漏洞，例如跨站脚本攻击 (XSS) 或 SQL 注入。加强开发环境的安全防护，从源头上防止 API 密钥被盗取。

通过本文的介绍，您应该已经了解了如何在 Upbit 上设置 API 接口。 希望本文能够帮助您更好地使用 Upbit API 进行程序化交易和数据分析。 在使用 API 接口的过程中，请务必注意安全，并严格遵守 Upbit 的 API 使用条款。