Upbit 交易所 API 接入指南：从零开始
1. 准备工作
在开始之前，请确保您已经完成了以下准备工作，这些步骤对于顺利使用 Upbit API 至关重要：
- Upbit 账户: 您需要一个已注册并完成身份验证的 Upbit 账户。实名认证是使用 Upbit API 的前提，确保您的账户符合 Upbit 的 KYC（Know Your Customer）要求。未经验证的账户可能无法访问 API 功能。
-
开发环境:
选择您熟悉的编程语言和环境，并确保其能够处理 RESTful API 请求。本文将以 Python 为例进行演示，Python 拥有丰富的库和社区支持，非常适合与 API 交互。您需要安装 Python 3.6 或更高版本，以及相关的库，例如
requests（用于发送 HTTP 请求）和pip install requests。 -
API 密钥:
这是连接 Upbit API 的关键凭证，用于验证您的身份和授权访问 Upbit 的数据和功能。请按照以下步骤获取，并仔细阅读相关说明：
- 登录您的 Upbit 账户。使用您的用户名和密码安全地登录 Upbit 平台。启用双重身份验证（2FA）可以进一步提高账户的安全性。
- 导航至“我的页面” -> “开放 API 管理”。通常，此选项位于用户设置或账户管理相关的页面。
- 输入 API 密钥名称，并勾选您需要的权限（例如，交易、查询余额等）。一个好的命名约定可以帮助您区分不同的 API 密钥，方便管理。 注意：请谨慎选择权限，只授予必要的权限以确保账户安全。 例如，如果您的应用程序只需要查询账户余额，则不要勾选交易权限。权限最小化原则是 API 安全的最佳实践。
- 阅读并同意 API 使用协议。仔细阅读 Upbit 提供的 API 使用条款，确保您了解 API 的使用限制和责任。违反 API 协议可能会导致 API 密钥被禁用。
- 点击“生成 API 密钥”按钮。系统将生成您的 Access Key 和 Secret Key。
- 您将获得一个 Access Key 和一个 Secret Key。Access Key 用于标识您的应用程序，Secret Key 用于验证您的身份。 务必妥善保管您的 Secret Key，切勿泄露给他人。 Secret Key 就像您的密码一样，泄露会导致您的账户面临风险。建议将 Secret Key 存储在安全的地方，例如加密的配置文件或环境变量中。避免将 Secret Key 直接硬编码在代码中。如果 Secret Key 泄露，请立即撤销并重新生成。
2. 安装必要的 Python 库
为了顺利完成 API 交互，我们需要安装几个关键的 Python 库。
requests
库将负责处理 HTTP 请求，使得我们可以向服务器发送数据并接收响应。
pyjwt
(JSON Web Token) 库用于生成符合安全标准的 JWT 签名，这是许多 API 验证用户身份和授权访问的常用方法。
uuid
库则用于生成唯一标识符 (UUID)，在某些 API 请求中可能需要用到，例如生成唯一的交易 ID 或请求 ID。
请使用 pip 包管理器安装这些库。打开你的终端或命令提示符，然后执行以下命令：
pip install requests pyjwt uuid
这条命令会从 Python Package Index (PyPI) 下载并安装
requests
,
pyjwt
和
uuid
库及其依赖项。请确保你的 Python 环境配置正确，并且 pip 命令可用。安装完成后，你就可以在 Python 脚本中导入这些库并使用它们的功能了。例如：
import requests
import jwt
import uuid
如果安装过程中遇到权限问题，可以尝试使用
sudo
(在 Linux 或 macOS 上) 或以管理员身份运行命令提示符 (在 Windows 上)。如果 pip 命令不可用，你可能需要先安装或更新 pip。
3. API 请求签名 (Authentication)
Upbit API 使用 JWT (JSON Web Token) 进行身份验证，以确保请求的安全性。您需要使用您的 Access Key 和 Secret Key 生成符合 JWT 规范的令牌，并在请求头中包含此 JWT，以便 Upbit 服务器验证您的身份和授权。
身份验证流程的核心在于使用您的 Access Key（类似于用户名）和 Secret Key（类似于密码）对请求进行签名。Secret Key 必须妥善保管，切勿泄露给他人，因为它能完全控制您的 Upbit 账户访问权限。使用 JWT 可以防止您的 Access Key 和 Secret Key 在网络传输过程中暴露，增加安全性。
以下是一个使用 Python 生成 JWT 的示例代码，该示例使用了 `pyjwt` 库。您可以通过 `pip install pyjwt` 命令安装此库。该代码演示了如何构造 JWT 的 payload (载荷)，并使用 HS256 算法对 payload 进行签名。请注意替换示例代码中的 `YOUR_ACCESS_KEY` 和 `YOUR_SECRET_KEY` 为您实际的 Access Key 和 Secret Key。
import jwt
import uuid
import hashlib
access_key = "YOUR_ACCESS_KEY" # 替换为您的 Access Key
secret_key = "YOUR_SECRET_KEY" # 替换为您的 Secret Key
def generate_jwt(access_key, secret_key):
"""
生成 JWT 令牌。
Args:
access_key (str): 您的 Upbit Access Key.
secret_key (str): 您的 Upbit Secret Key.
Returns:
str: 生成的 JWT 令牌.
"""
payload = {
'access_key': access_key,
'nonce': str(uuid.uuid4()) # nonce 用于防止重放攻击
}
jwt_token = jwt.encode(payload, secret_key, algorithm="HS256")
return jwt_token
jwt_token = generate_jwt(access_key, secret_key)
print(f"JWT Token: {jwt_token}")
代码解释：
- `jwt`：Python 的 JWT 库，用于编码和解码 JWT 令牌。
- `uuid`：用于生成唯一的 nonce 值，防止重放攻击。每个请求都应该使用一个新的 nonce 值。
- `access_key` 和 `secret_key`：您的 Upbit API 密钥。
- `payload`：JWT 的载荷，包含 `access_key` 和 `nonce`。 `nonce` 必须是唯一的字符串，通常使用 UUID 生成。 时间戳也可用于生成 `nonce`, 但确保其唯一性是关键。
- `jwt.encode(payload, secret_key, algorithm="HS256")`：使用 HS256 算法对载荷进行签名，生成 JWT 令牌。 HS256 是一种对称加密算法，使用相同的密钥进行加密和解密。
生成的 JWT 令牌需要在 API 请求的 `Authorization` 头部中传递，格式为 `Authorization: Bearer
代码解释:
-
access_key和secret_key：请务必将这些占位符替换为您从 Upbit 账户获得的真实 Access Key 和 Secret Key。 Access Key 用于标识您的身份，而 Secret Key 用于安全地对请求进行签名。保管好您的 Secret Key 至关重要，切勿公开或泄露给他人，以防止未经授权的访问。 -
payload：这是一个关键的字典结构，其中包含构建 JSON Web Token (JWT) 所需的必要信息。除了access_key之外，nonce(随机数) 是一个必不可少的组成部分。nonce的作用是确保每个请求的唯一性，从而有效地防御重放攻击。重放攻击是指攻击者截获并重新发送先前有效的请求，以达到欺骗系统的目的。通过每次请求都生成一个唯一的nonce值，即使攻击者截获了请求，也无法成功重放，因为nonce值已经失效。生成nonce的常见方法是使用时间戳或随机生成的字符串。 -
jwt.encode()：此函数使用 PyJWT 库，基于HS256(HMAC-SHA256) 算法，并结合您的 Secret Key，对先前构建的payload字典进行签名，从而生成最终的 JWT。HS256是一种对称加密算法，这意味着用于签名和验证 JWT 的密钥是相同的，即您的 Secret Key。生成的 JWT 是一个包含头部、有效载荷和签名的字符串，可以安全地传递给 Upbit API 进行身份验证。请注意，如果您的 Secret Key 泄露，攻击者可以使用它来生成有效的 JWT，因此务必妥善保管。
4. 发送 API 请求：查询账户信息
在获取到有效的 JWT (JSON Web Token) 后，便可利用它向 Upbit API 发送经过身份验证的请求。 以下示例展示了如何使用 Python 中的
requests
库，以及上一步骤中生成的 JWT 来查询账户信息。
import requests
access key = "YOUR ACCESS KEY" # 请替换为您的实际 Access Key，务必妥善保管 secret key = "YOUR SECRET KEY" # 请替换为您的实际 Secret Key，切勿泄露
为了简化 JWT 的生成过程，以下提供一个名为
generate_jwt
的 Python 函数，该函数接受 Access Key 和 Secret Key 作为输入，并返回一个 JWT。
def generate jwt(access key, secret key): import jwt # 导入 PyJWT 库 import uuid # 导入 UUID 库用于生成唯一 nonce 值 payload = { 'access_key': access_key, 'nonce': str(uuid.uuid4()) # 使用 UUID 生成唯一 nonce 值 }
jwt_token = jwt.encode(payload, secret_key, algorithm="HS256") # 使用 HS256 算法对 payload 进行签名
return jwt_token
调用
generate_jwt
函数，使用您的 Access Key 和 Secret Key 生成 JWT。
jwt token = generate jwt(access key, secret key)
定义 API 端点 URL，此处为 Upbit 的账户信息查询接口。
url = "https://api.upbit.com/v1/accounts"
构建包含 "Authorization" 头的 HTTP 请求头，其中 "Authorization" 字段的值为 "Bearer " 后跟生成的 JWT。
headers = {"Authorization": f"Bearer {jwt_token}"}
使用
requests.get
方法向 API 端点发送 GET 请求，并将包含 JWT 的请求头传递给
headers
参数。
res = requests.get(url, headers=headers)
打印 API 响应的内容。 如果身份验证成功，您将看到包含账户信息的 JSON 数据。
print(res.text)
重要提示：
-
请确保已安装
requests和PyJWT库。 您可以使用pip install requests pyjwt命令进行安装。 - 出于安全考虑，请勿将您的 Access Key 和 Secret Key 硬编码到代码中。 建议使用环境变量或配置文件来存储这些敏感信息。
- 请仔细阅读 Upbit API 的文档，了解每个 API 端点的具体参数和返回值。
- Nonce（Number used once）是用于防止重放攻击的随机字符串，务必保证每次请求的 nonce 值都是唯一的。
代码解释:
-
url：指向 Upbit API 的账户信息查询终端节点。这个特定的终端节点允许用户获取其在Upbit交易所的账户余额、持仓以及其他相关的账户详情。它代表了API服务器上的一个特定位置，可以通过HTTP请求访问以检索或修改数据。 -
headers：一个 Python 字典，其中包含一个名为Authorization的键，它的值是Bearer加上您的 JWT（JSON Web Token）。 JWT 是一个经过编码的字符串，用于安全地传递用户信息，并验证请求的身份。Bearer是一种授权方案，表明JWT是用于授权访问API的令牌。正确的JWT对于成功地向Upbit API进行身份验证至关重要。 -
requests.get()：使用 Python 的requests库发送一个 HTTP GET 请求到 Upbit API。 GET 请求是用于从服务器检索数据的标准方法。requests库简化了发送 HTTP 请求的过程，并处理了诸如连接管理和数据编码等底层细节。该函数将 URL 和 headers 作为参数，headers 包含您的身份验证信息。 -
res.()：将从 Upbit API 收到的响应内容解析为 JSON 格式。JSON (JavaScript Object Notation) 是一种轻量级的数据交换格式，易于人类阅读和机器解析。Upbit API 返回的数据通常是 JSON 格式，因此需要使用此方法将其转换为 Python 对象（字典或列表），以便在代码中进一步处理和使用。
运行这段代码后，您会获得一个 JSON 数据结构，其中包含有关您账户的详细信息。以下是一个示例输出，展示了您可能看到的数据类型和结构：
[ { "currency": "KRW", "balance": "1000000.0", "locked": "0.0", "avg_buy_price": "0", "avg_buy_price_modified": false, "unit_currency": "KRW" }, { "currency": "BTC", "balance": "0.001", "locked": "0.0", "avg_buy_price": "60000000", "avg_buy_price_modified": false, "unit_currency": "KRW" } ]
在此JSON 响应示例中，每个对象代表一种特定的加密货币。字段含义如下:
-
currency: 表示货币的符号 (例如: KRW 代表韩元，BTC 代表比特币). -
balance: 表示账户中该货币的可用余额。 -
locked: 表示账户中被锁定的该货币数量，通常是由于挂单或其他操作造成的。 -
avg_buy_price: 表示该货币的平均购买价格。 -
avg_buy_price_modified: 表示平均购买价格是否被修改过。 -
unit_currency: 表示计价单位。
5. 其他常用 API 请求
以下是一些其他常用的 Upbit API 请求示例，涵盖了账户信息、交易历史、委托状态等多个方面，方便开发者构建完整的交易应用和数据分析工具。
5.1 账户信息查询
开发者可以通过
/accounts
端点查询用户的账户信息，包括持有的各种加密货币余额、可用余额、锁定余额等。该接口需要身份验证，确保只有授权用户才能访问其账户信息。返回的数据通常包括币种代码、总余额、可用余额和锁定余额，方便用户实时掌握自己的资产状况。
5.2 交易历史查询
使用
/trades/ticks
端点可以获取特定交易对的交易历史记录，包括成交时间、成交价格、成交数量等信息。通过调整请求参数，可以筛选特定时间段内的交易记录，也可以按照时间顺序或价格顺序排序。此接口对于分析市场趋势和回测交易策略至关重要。
5.3 委托列表查询
/orders
端点允许用户查询当前挂单和历史委托单的信息，包括委托类型（买入/卖出）、委托价格、委托数量、委托状态（待成交、已成交、已取消）等。通过该接口，用户可以实时监控自己的交易委托，并及时调整交易策略。还可以根据订单状态、市场代码等条件进行过滤。
5.4 单个委托查询
通过
/order
(GET) 端点，可以根据订单 UUID 查询特定委托单的详细信息。这对于确认订单状态和核对交易数据非常有用。返回的信息包括订单的全部细节，如订单创建时间、订单类型、已成交数量、剩余数量等。
5.5 委托取消
使用
/order
(DELETE) 端点，可以根据订单 UUID 取消尚未成交的委托单。取消委托可以帮助用户避免因市场波动造成的损失。取消成功后，API 会返回取消订单的状态信息。
5.6 行情 WebSocket API
除了 REST API，Upbit 还提供了 WebSocket API，用于实时推送市场行情数据，如最新成交价、实时交易量、深度行情等。使用 WebSocket API 可以实现低延迟的数据获取，适用于高频交易和实时监控应用。开发者需要建立 WebSocket 连接，并订阅感兴趣的交易对和数据类型。
以上仅为部分常用 API 示例，Upbit API 还提供了更多功能，开发者可以参考官方文档获取更详细的信息。在使用 API 时，务必注意 API 的调用频率限制，避免被限制访问。
5.1. 获取市场行情 (Tickers)
在加密货币交易中，获取实时的市场行情数据至关重要。TICKER 数据提供了关于特定交易对（例如 KRW-BTC）的最新成交价、成交量、涨跌幅等关键信息，这些信息是进行交易决策的基础。
Python 提供了强大的第三方库
requests
，可以方便地发送 HTTP 请求并获取 API 数据。在使用前，请确保已安装该库：
pip install requests
以下代码演示了如何使用
requests
库从 Upbit 交易所的 API 获取市场行情数据：
import requests
market = "KRW-BTC" # 例如：KRW-BTC (韩元-比特币), BTC-ETH (比特币-以太坊)
url = f"https://api.upbit.com/v1/ticker?markets={market}"
try:
res = requests.get(url)
res.raise_for_status() # 检查请求是否成功，如果状态码不是 200，则抛出异常
data = res.()
print(data)
except requests.exceptions.RequestException as e:
print(f"请求出错: {e}")
except ValueError as e:
print(f"JSON 解析出错: {e}")
代码解释：
-
market = "KRW-BTC"：指定要查询的交易对。常见的交易对格式为[交易货币]-[基础货币]。 -
url = f"https://api.upbit.com/v1/ticker?markets={market}"：构建 Upbit API 的请求 URL。通过markets参数指定要查询的交易对。 -
res = requests.get(url)：发送 GET 请求到指定的 URL，并获取响应对象。 -
res.raise_for_status()：检查HTTP请求状态码，如果不是200则抛出异常，用于处理请求失败的情况。 -
data = res.()：将响应内容解析为 JSON 格式的数据。 -
print(data)：打印获取到的 JSON 数据。该数据包含了 KRW-BTC 交易对的最新行情信息，例如当前价格、成交量、涨跌幅等。 -
try...except：使用异常处理机制，捕获可能出现的请求错误（如网络连接错误）和 JSON 解析错误，保证程序的健壮性。
返回的 JSON 数据格式如下所示 (示例):
[
{
"market": "KRW-BTC",
"trade_date": "20231027",
"trade_time": "075744",
"trade_date_kst": "20231027",
"trade_time_kst": "165744",
"trade_timestamp": 1698396664000,
"opening_price": 40000000.0,
"high_price": 40500000.0,
"low_price": 39800000.0,
"trade_price": 40200000.0,
"prev_closing_price": 39900000.0,
"change": "RISE",
"change_price": 300000.0,
"change_rate": 0.007518796992481203,
"signed_change_price": 300000.0,
"signed_change_rate": 0.007518796992481203,
"trade_volume": 0.12345678,
"acc_trade_price": 1234567890.0,
"acc_trade_price_24h": 2345678901.0,
"acc_trade_volume": 123.456789,
"acc_trade_volume_24h": 234.567890,
"highest_52_week_price": 80000000.0,
"highest_52_week_date": "2023-01-01",
"lowest_52_week_price": 20000000.0,
"lowest_52_week_date": "2023-07-01",
"timestamp": 1698396664000
}
]
请注意，不同的交易所 API 可能会有不同的请求方式和返回数据格式。使用前请务必查阅相关 API 文档。
5.2. 获取最近交易历史 (Trades)
获取指定交易对的最近交易历史记录是分析市场动态的关键步骤。通过Upbit API，开发者可以轻松检索指定交易对的实时交易数据，用于算法交易、市场分析和风险管理等应用场景。
导入
requests
库，它是Python中进行HTTP请求的标准库，允许我们与Upbit API进行通信。
import requests
接下来，定义要查询的交易对
market
和要获取的交易记录数量
count
。
market
变量指定了交易对，例如 "KRW-BTC" 代表韩元对比特币。
count
变量用于指定返回的交易记录数量，Upbit API通常有数量限制，例如最多返回200条。
market = "KRW-BTC"
count = 20 # 获取最近 20 条交易记录
构造API请求的URL。URL包含了API的endpoint（
/v1/trades/ticks
），以及查询参数
market
和
count
。使用f-string可以方便地将变量嵌入到URL字符串中。Upbit API要求所有请求都通过HTTPS协议进行，确保数据传输的安全性。
url = f"https://api.upbit.com/v1/trades/ticks?market={market}&count={count}"
使用
requests.get()
方法发送GET请求到Upbit API。
res
对象包含了API的响应，包括状态码、头部信息和响应内容。请求过程中，需要注意处理可能的网络异常和API错误。
res = requests.get(url)
打印API的响应内容。使用
res.()
方法将JSON格式的响应内容解析为Python字典或列表，方便后续处理和分析。开发者可以根据实际需求，提取交易时间、交易价格、交易量等信息。
print(res.())响应通常返回一个JSON数组，每个元素代表一笔交易，包含时间戳、价格、数量、买卖方向等详细信息。通过分析这些数据，可以了解市场的实时动态和趋势。
5.3. 下单 (Orders)
注意：下单操作需要配置相应的 API 权限，务必谨慎处理潜在的错误，并进行充分的风险评估。
以下代码示例展示了如何使用 Python 的
requests
、
uuid
和
jwt
库来构建和发送 Upbit 交易所的下单请求。
import requests
import uuid
import jwt
请务必将以下占位符替换为您真实的 API 密钥。
access_key
是您的访问密钥，
secret_key
是您的安全密钥。妥善保管您的密钥，避免泄露。
access_key = "YOUR_ACCESS_KEY" # 替换为您的 Access Key
secret_key = "YOUR_SECRET_KEY" # 替换为您的 Secret Key
generate_jwt
函数用于生成 JSON Web Token (JWT)，该 Token 用于身份验证。它使用您的
access_key
和
secret_key
对有效载荷进行签名。
def generate_jwt(access_key, secret_key):
payload = {
'access_key': access_key,
'nonce': str(uuid.uuid4()) # 使用 UUID 生成唯一随机数，防止重放攻击
}
该函数使用 HS256 算法对有效载荷进行签名。务必选择与您的 API 密钥匹配的正确算法。
jwt_token = jwt.encode(payload, secret_key, algorithm="HS256")
return jwt_token
调用
generate_jwt
函数生成 JWT Token，后续的 API 请求将使用此 Token 进行身份验证。
jwt_token = generate_jwt(access_key, secret_key)
以下变量定义了下单的具体参数。
market
指定交易市场 (例如 "KRW-BTC")，
side
指定买卖方向 ("bid" 为买入, "ask" 为卖出)，
volume
指定数量，
price
指定价格，
ord_type
指定订单类型 (例如 "limit" 为限价单, 其他类型请参考 Upbit API 文档)。
market = "KRW-BTC" # 交易市场
side = "bid" # 买入 "bid", 卖出 "ask"
volume = "0.0001" # 数量
price = "65000000" # 价格
ord_type = "limit" # 市价 "price", 限价 "limit"
url
变量定义了 Upbit API 的下单端点。
url = "https://api.upbit.com/v1/orders"
headers
包含身份验证信息，其中 Authorization 字段的值为 "Bearer " 加上生成的 JWT Token。
headers = {"Authorization": f"Bearer {jwt_token}"}
data
字典包含了下单请求的参数。请确保所有参数都符合 Upbit API 的要求。
data = {
"market": market,
"side": side,
"volume": volume,
"price": price,
"ord_type": ord_type
}
使用
requests.post
函数发送 POST 请求到 Upbit API。传递 URL, headers 和 data 参数。
res = requests.post(url, headers=headers, data=data)
打印服务器返回的响应内容。请仔细检查响应内容，以确定下单是否成功。根据 Upbit API 的返回码进行错误处理。
print(res.text)
6. 错误处理
在实际的加密货币交易应用开发中，对 Upbit API 请求进行严谨的错误处理至关重要。由于网络环境的不确定性以及API本身可能存在的问题，应用程序必须能够妥善处理各种潜在的错误情况，以保证交易的顺利进行和用户资金的安全。Upbit API 通常会返回包含详细错误信息的 JSON 响应，以便开发者能够诊断并解决问题。
您应该始终检查 API 响应的状态码（HTTP Status Code），它指示了请求是否成功。常见的状态码及其含义如下：
- 200 OK: 请求成功。
- 400 Bad Request: 客户端请求错误，例如参数无效或缺失。
- 401 Unauthorized: 未授权，通常是因为 API 密钥无效或缺失。
- 403 Forbidden: 禁止访问，通常是因为权限不足。
- 429 Too Many Requests: 请求过于频繁，触发了速率限制。
- 500 Internal Server Error: 服务器内部错误。
- 503 Service Unavailable: 服务不可用。
除了状态码，您还应该检查 JSON 响应体中是否包含错误信息。Upbit API 通常会在响应体中包含一个
error
字段，该字段包含
message
(错误消息) 和
name
(错误代码) 两个属性。根据不同的错误代码和消息，您可以采取不同的处理措施，例如：
- 重试请求: 对于网络错误或服务器临时故障，可以尝试在稍后重试请求。需要注意的是，在重试之前应该加入适当的延迟，避免加剧服务器压力。
- 调整请求参数: 对于参数错误，检查并更正请求参数。
- 处理速率限制: 如果触发了速率限制，应该暂停请求一段时间，并根据 API 文档调整请求频率。
- 记录错误信息: 将错误信息记录到日志中，方便排查问题。
- 通知用户: 在适当的情况下，向用户显示友好的错误提示信息。
例如，以下 Python 代码演示了如何使用
requests
库发送 API 请求，并检查响应状态码和错误信息：
import requests
import
def make_api_request(url, headers=None, params=None):
try:
response = requests.get(url, headers=headers, params=params)
response.raise_for_status() # 抛出 HTTPError 异常，如果状态码不是 200
return response.()
except requests.exceptions.HTTPError as errh:
print(f"HTTP Error: {errh}")
try:
error_data = response.()
if 'error' in error_data:
print(f"Upbit API Error Name: {error_data['error']['name']}")
print(f"Upbit API Error Message: {error_data['error']['message']}")
except .JSONDecodeError:
print("Could not decode JSON response from error.")
except requests.exceptions.ConnectionError as errc:
print(f"Connection Error: {errc}")
except requests.exceptions.Timeout as errt:
print(f"Timeout Error: {errt}")
except requests.exceptions.RequestException as err:
print(f"Other Error: {err}")
return None
# 示例用法
url = "https://api.upbit.com/v1/market/all" # 假设的 Upbit API 端点
headers = {"Authorization": "Bearer YOUR_API_KEY"} #如果API需要授权
params = {"isDetails": "true"} #如果API需要参数
data = make_api_request(url, headers, params)
if data:
print(.dumps(data, indent=4)) # Pretty print the response
在以上代码中，
response.raise_for_status()
会检查响应状态码，如果状态码表示错误（例如 400 或 500），则会抛出一个
HTTPError
异常。您可以捕获这个异常并检查响应体中的错误信息。
requests.exceptions
包含其他的可能发生的异常，比如网络连接错误 (
ConnectionError
) 和请求超时 (
Timeout
)，应该一并处理。
通过对 API 请求进行全面的错误处理，可以提高应用程序的健壮性和可靠性，从而为用户提供更好的交易体验。
... (省略 JWT 生成代码)
目标 API 端点：
https://api.upbit.com/v1/accounts
。此端点用于获取用户在Upbit交易所的账户信息。
请求头信息：
headers = {"Authorization": f"Bearer {jwt_token}"}
。 此处的
Authorization
头是使用 JWT (JSON Web Token) 进行身份验证的关键。
jwt_token
变量持有通过 JWT 生成流程生成的令牌，该令牌用于向 Upbit API 证明请求的合法性。
发起 GET 请求：
res = requests.get(url, headers=headers)
。 使用 Python 的
requests
库向指定的 URL 发送 GET 请求。 请求中包含之前构造的
headers
，其中包含了 JWT 身份验证信息。GET 请求是用于从服务器检索数据的常用 HTTP 方法。
检查 API 响应状态码：
if res.status_code == 200:
。 验证 API 请求是否成功。 HTTP 状态码 200 表示请求已成功处理。 如果状态码为 200，则表示服务器已成功返回请求的数据。
成功响应处理：
print(res.())
。 如果 API 请求成功（状态码为 200），则解析并打印 API 响应的 JSON 内容。
res.()
方法将响应体解析为 Python 字典，方便进一步处理和使用。
错误处理：
else:
print(f"API 请求失败，状态码：{res.status_code}")
print(f"错误信息：{res.text()}")
。 当 API 请求失败时（状态码不是 200），打印错误信息，包括状态码和响应文本。
res.status_code
包含 HTTP 状态码，指示失败的原因。
res.text()
包含服务器返回的错误消息，提供关于错误的详细信息。这有助于调试和诊断 API 集成问题。
7. API 使用限制
Upbit API 为了保障服务器稳定性和公平性，对请求频率设置了严格的限制。开发者必须仔细阅读 Upbit 官方 API 文档，特别是关于“请求频率限制”的部分，全面了解不同接口的请求配额、时间窗口和违规处罚措施。文档通常会详细说明每个API端点允许的每分钟、每秒或每日请求次数上限。请务必在代码中实现速率限制机制，通过监控请求频率并动态调整请求发送速度，避免超出限制，从而防止 API 密钥被临时或永久封禁。
违反速率限制通常会导致 API 返回 429 错误（请求过多）。处理此类错误的最佳实践是采用指数退避算法。当收到 429 错误时，您的应用程序应该暂停发送请求，等待一段时间后再进行重试。等待时间不应固定，而应该随着重试次数的增加而呈指数增长。例如，第一次重试等待1秒，第二次等待2秒，第三次等待4秒，以此类推。这种策略可以有效避免短时间内的大量重试请求再次触发速率限制，从而提高请求成功的概率，同时减轻服务器压力。指数退避算法的具体实现可以根据实际情况和 Upbit API 文档的建议进行调整，确保应用程序能够平稳地适应 API 的速率限制策略。
除了简单的指数退避，还可以考虑使用更高级的速率限制策略，例如令牌桶算法或漏桶算法。这些算法可以更精细地控制请求的发送速率，允许应用程序在一定程度上突发请求，同时保证平均速率不超过限制。选择哪种策略取决于应用程序的具体需求和 Upbit API 的限制特点。
监控 API 请求频率也是非常重要的。您可以使用各种监控工具或自定义代码来记录每个 API 端点的请求次数和错误率。通过分析这些数据，您可以及时发现潜在的速率限制问题，并采取相应的措施进行优化，例如优化代码逻辑、缓存数据或减少不必要的 API 调用。有效的监控可以帮助您更好地了解 API 的使用情况，并确保应用程序能够稳定可靠地运行。
8. 安全注意事项
- 妥善保管您的 Secret Key (密钥)。 切勿将 Secret Key 硬编码在应用程序代码中，或将其提交至公开的代码仓库，如 GitHub、GitLab 或 Bitbucket。这样做会使您的密钥暴露给潜在的攻击者。推荐使用更安全的替代方案，例如环境变量、配置文件或专门的密钥管理系统。
- 谨慎选择 API 权限。 Upbit API 提供了多种权限等级，务必根据应用程序的实际需求，授予其所需的最小权限集合。避免授予过高的权限，以降低潜在的安全风险。例如，如果应用程序仅需要读取市场数据，则只需授予读取权限，无需授予交易权限。
- 定期轮换 API 密钥。 为了保障账户安全，建议定期生成新的 API 密钥，并及时废弃旧的密钥。轮换周期取决于您的安全策略，但应尽可能缩短。在生成新密钥后，务必更新应用程序中的密钥配置，并确保旧密钥不再有效。
- 使用 HTTPS 连接。 与 Upbit API 进行交互时，务必始终使用 HTTPS (安全超文本传输协议) 连接。HTTPS 使用 SSL/TLS 协议对数据进行加密，可以有效防止数据在传输过程中被窃取或篡改。确保您的代码库中所有 API 请求都使用 `https://` 开头的 URL。
- 监控您的账户活动。 定期检查您的 Upbit 账户活动记录，包括交易历史、API 密钥使用情况等，以确保没有未经授权的交易或其他异常行为。如发现任何可疑活动，请立即更改您的 API 密钥和账户密码，并联系 Upbit 客服。建议开启Upbit提供的双重验证(2FA)等安全措施。
