Upbit API接口获取教程
一、Upbit API概述
Upbit是一家全球知名的加密货币交易平台，成立于2017年，致力于为用户提供安全、便捷的交易体验。作为市场领先的交易所之一，Upbit提供了功能全面、易于使用的API接口，旨在帮助开发者高效地集成交易功能、市场数据分析和自动化交易等操作。通过Upbit API，开发者能够方便地与平台的交易系统进行交互，执行实时市场查询、获取账户信息、执行买卖操作等一系列任务。Upbit的API不仅适用于开发自动化交易策略、构建加密货币监控系统，还能为用户提供量化分析和资产管理的高效工具。
Upbit的API包括多个模块，涵盖市场数据查询、账户管理、交易操作、资产查看等功能。开发者可以通过这些API接口轻松获取实时的加密货币市场数据，包括最新的交易价格、历史行情数据、订单深度等，并根据这些数据做出智能决策。Upbit的API还支持用户账户信息的管理，包括余额查询、交易记录获取、账户安全设置等，确保开发者能够全面控制其账户。Upbit还支持丰富的交易操作接口，使得程序能够自动进行买卖操作，极大地提升了交易的效率。
为便于开发者快速上手，Upbit提供了详细的API文档和开发者支持，文档中涵盖了API接口的使用方法、参数说明、调用示例等内容，帮助开发者理解每个接口的功能与使用场景。在本文中，将详细介绍如何获取Upbit API密钥，如何进行API调用，以及如何在应用程序中集成这些接口，实现自动化交易和数据分析等应用。
二、如何获取Upbit API密钥
要使用Upbit的API接口，首先需要获取API密钥。API密钥用于身份验证，确保只有经过授权的用户可以调用相关接口。下面是获取API密钥的步骤：
1. 注册Upbit账户
若你尚未拥有Upbit账户，首先必须通过Upbit的官方网站或官方应用程序进行账户注册。在注册过程中，确保提供准确且真实的个人信息，包括但不限于姓名、邮箱地址、手机号码以及住址等，以便后续完成身份验证。Upbit对账户注册的要求较为严格，因此务必确保所提供的所有信息均为有效且真实，以避免因信息不符而导致身份验证失败。
在注册的过程中，你还需要选择一个强密码，密码应包含字母、数字及特殊字符的组合，且长度不得低于8个字符。Upbit会通过手机短信或电子邮件向你发送验证码，用于验证你的身份信息的准确性与安全性。输入验证码后，你将进入身份验证环节，系统会要求上传有效的身份证明文件，并进行人脸识别认证。
注册完成后，系统可能要求你开启两步验证（2FA），以增强账户的安全性。2FA可通过Google Authenticator或手机短信等方式来完成，确保每次登录或进行交易时都需输入额外的验证码，从而有效防止账户被非法访问。
2. 登录Upbit账户
在完成Upbit账户的注册和身份验证流程后，用户可以通过输入注册时设置的用户名和密码，顺利登录Upbit平台。为确保账户的安全性，Upbit建议用户启用二步验证（2FA），通过Google Authenticator等应用生成动态验证码进行身份验证。登录页面提供了忘记密码和找回账户功能，用户可以通过绑定的电子邮件地址或手机号码重设密码。如果启用了二步验证，还需要在登录时输入相应的验证码，以确保账户安全。
3. 进入API管理页面
在Upbit的用户界面中，用户需在页面的右上角找到自己的头像图标并点击它，随后在下拉菜单中选择“API管理”选项。此时，系统将引导用户进入API管理的专用页面。在该页面中，用户将看到与API相关的管理功能，包括生成新的API密钥、查看现有的API密钥权限、以及进行密钥的修改或删除等操作。点击页面上的“创建API密钥”按钮后，用户将进入一个生成新的API密钥的流程，按照页面提示完成验证步骤并确认创建。创建API密钥后，用户将能够访问和控制其账户内的交易、查询和资金管理等功能。
4. 设置API权限
在创建API密钥时，你可以选择不同的权限。常见的权限选项包括：
- 读取权限：可以查询账户信息和市场数据，但不能进行交易操作。
- 交易权限：允许进行买入、卖出等交易操作。
- 提款权限：允许通过API提取资金。
根据需要选择适合的权限。注意，建议仅授予必要的权限，以增强账户安全性。
5. 创建API密钥
完成权限设置后，点击页面上的“创建API密钥”按钮，系统将自动生成一对唯一的API密钥，包含Access Key和Secret Key。其中，Access Key是公开的标识符，用于标识发起API请求的用户账户，而Secret Key是一个重要的密钥，必须妥善保管，因为它是用于对API请求进行加密验证的唯一凭证，且出于安全考虑，该密钥只会显示一次。确保在创建后将密钥保存在安全的地方，并避免将其泄露给他人。
API密钥对于与平台的任何系统交互至关重要，尤其是在自动化交易、数据获取、账户管理等方面。正确管理和存储API密钥能够有效防止未授权访问和潜在的安全风险。任何泄露的密钥都可能导致账户安全性受到威胁，因此，请特别注意Secret Key的保密性，并考虑使用密码管理工具进行安全存储。
三、Upbit API接口使用
Upbit提供的API接口采用RESTful架构风格，支持通过HTTP请求进行操作。RESTful API的设计使得开发者能够方便地与Upbit平台进行数据交互和交易操作。Upbit API包括多个功能模块，支持获取市场数据、账户信息、下单、撤单、交易历史等操作。所有请求均通过HTTPS协议发送，以确保数据传输的安全性。
为了使用Upbit的API接口，用户首先需要在Upbit账户中生成API密钥，该密钥包括访问密钥和秘密密钥。在创建密钥时，用户可以设置相应的权限，例如读取账户信息、进行交易操作等，确保API的使用符合用户的需求和安全性要求。
Upbit的API接口采用标准的HTTP请求方法，包括GET、POST、DELETE等。GET方法用于获取数据，例如查询市场行情和账户信息；POST方法用于发送请求，如创建订单、进行交易；DELETE方法用于撤销订单等操作。API请求的响应通常以JSON格式返回，包含请求结果的状态、数据及相关信息。
开发者可以利用Upbit API进行实时数据监控、自动化交易以及策略执行等多种应用，满足不同用户的需求。API接口的文档提供了详细的接口描述、请求参数和返回格式，帮助开发者更好地理解和使用这些接口。
1. 获取市场数据
获取市场数据是Upbit API中应用最广泛且功能丰富的模块之一。通过调用该API提供的多个接口，用户可以获取实时的市场行情、历史K线数据、24小时交易量、价格变动幅度等详细信息。Upbit提供了包括现货市场、期货市场等多个交易对的数据，支持各种数字资产的交易查询，帮助开发者实时监控市场动向。
Upbit的市场数据接口包括但不限于：获取某一特定交易对的当前价格、24小时内的最高价、最低价、成交量等信息；获取特定时间范围内的历史K线数据，包括时间段、开盘价、最高价、最低价和收盘价等；以及查询多种时间间隔（如1分钟、5分钟、1小时等）内的价格波动数据，这些都能够为交易者提供精准的市场趋势分析依据。
通过这些接口，开发者能够获取到最精准、最及时的行情数据，进行实时的市场分析、策略测试、以及自动化交易系统的支持。Upbit API的市场数据接口响应迅速且稳定，能够保证在高频交易和高负载情况下依旧提供可靠的实时数据支持。
1.1 获取市场列表
接口URL：https://api.upbit.com/v1/market/all
请求方式：GET
请求参数：此接口无需传递任何查询参数，直接使用GET方法调用即可。
返回结果：该接口将返回一个包含所有市场信息的JSON数组。每个市场的数据项包括了市场的唯一标识符、基础货币、目标货币以及市场类型等详细信息。数据项的结构通常包含以下字段：
- market：市场的唯一标识符，通常由两个货币对的名称组成（例如"KRW-BTC"表示韩元与比特币的交易对）。
- korean_name：市场的韩文名称。
- english_name：市场的英文名称。
- market_type：市场类型，通常为"CRYPTOCURRENCY"表示加密货币市场。
- base_currency：基础货币，即该市场交易对中的第一个货币。
- quote_currency：报价货币，即该市场交易对中的第二个货币。
响应示例：
[
{
"market": "KRW-BTC",
"korean_name": "비트코인",
"english_name": "Bitcoin",
"market_type": "CRYPTOCURRENCY",
"base_currency": "BTC",
"quote_currency": "KRW"
},
{
"market": "KRW-ETH",
"korean_name": "이더리움",
"english_name": "Ethereum",
"market_type": "CRYPTOCURRENCY",
"base_currency": "ETH",
"quote_currency": "KRW"
}
]该API接口可以帮助开发者获取所有可用的市场列表，并能够方便地通过市场标识符访问具体市场的详细信息。返回的数据结构可以帮助进行市场分析，提供交易对相关的基本信息。
示例请求：
curl -X GET "https://api.upbit.com/v1/market/all"该命令通过curl工具发送GET请求，获取所有市场的最新数据。返回的JSON响应可以用于进一步的市场分析、价格比较或其他交易策略的制定。
1.2 获取单一市场的行情
接口URL：https://api.upbit.com/v1/ticker
请求方式：GET
请求参数： - markets: 市场的标识符，用于指定查询的交易对，例如“KRW-BTC”表示查询韩国韩元市场与比特币（BTC）之间的交易对。可以通过此参数指定不同的市场，如“BTC-ETH”表示比特币与以太坊之间的交易对，或“USDT-BNB”表示Tether与Binance Coin的交易对。此参数支持多个市场标识符，可以通过逗号分隔多个市场，查询多个交易对的行情数据。
示例请求：
curl -X GET "https://api.upbit.com/v1/ticker?markets=KRW-BTC"
返回结果：该接口返回市场的实时行情数据，包含多个关键信息，以便用户了解当前市场状态。返回的数据包括但不限于：
- trade_date: 数据的日期，格式为“yyyy-mm-dd”。
- trade_time: 数据的时间，格式为“hh:mm:ss”。
- opening_price: 开盘价格，指的是该时间周期内的首个成交价格。
- high_price: 最高价格，指该时间段内的最高成交价。
- low_price: 最低价格，指该时间段内的最低成交价。
- trade_price: 最新成交价格，指当前时间点的交易成交价格。
- prev_closing_price: 前一交易日的收盘价，帮助用户了解当前价格与昨日收盘价格的差异。
- change: 价格变化的类型，可能的值包括“RISE”（上涨），“FALL”（下跌），“EQUAL”（持平）。
- change_price: 价格变化的幅度，表示当前价格与前一交易日收盘价的差额。
- supply: 市场的流通供应量，表示该交易对的可用交易量。
- acc_trade_price_24h: 24小时内的成交总额，反映该市场在过去24小时内的交易活跃度。
- acc_trade_volume_24h: 24小时内的成交总量，指的是该市场在过去24小时内的交易数量。
- timestamp: 数据生成的时间戳，表示数据更新的具体时间。
2. 获取账户信息
Upbit API提供了多个接口，允许开发者查询用户账户的各类信息，包括但不限于账户余额、资产分布、交易历史记录等。这些接口对于用户资产管理和监控非常有用，可以帮助开发者实现实时数据获取和资金流动追踪。
通过账户余额接口，开发者可以查询特定数字货币的余额，以及账户中的法币余额。API还支持查询不同交易对的余额信息，使用户可以清晰地了解自己在平台上的持仓状况。对于交易历史的查询，Upbit API可以返回一个详细的交易记录，包括每一笔交易的时间戳、交易对、成交价格、数量、交易类型等。这使得开发者能够对账户的历史交易进行全面分析，帮助用户进行数据回溯和盈亏评估。
对于账户信息的查询，Upbit还提供了过滤和分页功能，确保在查询大量数据时，开发者能够更高效地获取所需信息。接口还支持根据时间区间、交易对等条件进行筛选，以便精确定位用户的交易活动或账户余额变动。
2.1 获取账户余额
接口URL：https://api.upbit.com/v1/accounts
请求方式：GET
请求头：请求头中必须包含API密钥，该密钥用于身份验证和授权访问账户数据。使用OAuth 2.0的Bearer Token机制，将ACCESS_TOKEN替换为有效的访问令牌。
请求示例：
curl -X GET "https://api.upbit.com/v1/accounts" -H "Authorization: Bearer {ACCESS_TOKEN}"返回结果：接口会返回一个JSON数组，包含用户账户中的各类资产信息。每个数组项代表一种资产，具体包括以下字段：
- currency：资产的种类，通常为加密货币的符号，如"BTC"、"ETH"等。
- balance：该资产的可用余额，表示账户中该资产的当前可用数量。
- locked：该资产的冻结金额，指的是因为交易中未完成或其他限制而暂时无法使用的余额。
- avg_buy_price：该资产的平均购买价格，表示用户购买该资产的平均单价。
- avg_buy_price_modified：一个布尔值，指示是否修改了购买价格（如果为true，说明用户可能进行了价格调整）。
- unit_currency：用于计算余额的基本单位货币，如"KRW"（韩元）或"USD"（美元）。
返回结果示例：
[
{
"currency": "BTC",
"balance": "0.5",
"locked": "0.1",
"avg_buy_price": "50000000",
"avg_buy_price_modified": false,
"unit_currency": "KRW"
},
{
"currency": "ETH",
"balance": "2.0",
"locked": "0.5",
"avg_buy_price": "2000000",
"avg_buy_price_modified": true,
"unit_currency": "KRW"
}
]通过此接口，用户能够清晰地查看账户中每种加密资产的实时余额、冻结状态以及平均购买价格等信息，便于管理和监控资金。
3. 交易接口
Upbit API提供强大的自动化交易支持，允许开发者和用户通过API接口实现灵活的交易操作。利用该API，开发者可以执行包括买入、卖出、撤单、查询账户信息、获取市场深度、历史成交记录等多种操作。API通过HTTP协议与Upbit交易平台进行交互，支持RESTful风格的请求方式，适合于多种编程语言的调用。
在自动化交易中，开发者可以设置交易策略，并通过API接口实现自动买卖、止损、止盈等功能。API接口还可以帮助用户实时监控市场行情，获取最新的K线数据、价格、成交量等信息，确保交易决策基于实时数据。
对于有更高需求的用户，Upbit还提供WebSocket API，这种接口支持实时推送市场变化和账户状态，能够实现更为高效的交易执行，避免延迟。WebSocket API适用于需要快速响应和实时更新的高频交易系统。
Upbit API提供了详细的文档和开发者工具，支持OAuth2身份验证，确保交易操作的安全性与稳定性。开发者可以通过API密钥进行身份验证，并根据权限控制不同级别的操作权限，确保账户资金和操作的安全性。
3.1 下单
接口URL：https://api.upbit.com/v1/orders
请求方式：POST
请求参数： - market: 交易市场，指定交易对，例如“KRW-BTC”表示在韩国韩元市场交易比特币。这个参数可以包括多个市场对，如“BTC-ETH”表示比特币与以太坊之间的交易。 - side: 订单类型，决定了交易是买入还是卖出。取值为“buy”表示买入，取值为“sell”表示卖出，分别对应开多单和开空单的操作。 - price: 订单价格，适用于限价单（limit order）。当设置为限价单时，需要指定此价格，系统将按照该价格或更优价格执行订单。如果订单类型为市价单，则无需提供此参数。 - volume: 订单数量，表示交易的数量。根据市场对的不同，该值的单位可能会有所不同。例如，对于“KRW-BTC”市场，这个值通常以比特币为单位；对于“ETH-BTC”市场，则通常以以太坊为单位。 - ord_type: 订单类型，用于指定订单的执行方式。取值为“limit”表示限价单，限价单将按照用户指定的价格或更好的价格进行执行；取值为“price”表示市价单，市价单将根据当前市场价格立即成交。
请求示例：
curl -X POST "https://api.upbit.com/v1/orders" \
-H "Authorization: Bearer {ACCESS_TOKEN}" \
-H "Content-Type: application/" \
-d '{"market": "KRW-BTC", "side": "buy", "price": "5000000", "volume": "0.01", "ord_type": "limit"}'
返回结果：成功提交订单后，接口将返回创建订单的详细信息，包含以下字段： - id: 订单ID，唯一标识每个订单。 - market: 订单所属的交易市场，例如“KRW-BTC”。 - side: 订单的买卖方向，“buy”表示买入，“sell”表示卖出。 - price: 订单的指定价格，仅适用于限价单。 - volume: 订单的数量。 - remaining_volume: 未成交的数量，如果订单部分成交，将显示剩余数量。 - paid_fee: 订单支付的交易费用，通常以市场的基础货币表示。 - state: 订单的当前状态，可能的状态包括“wait”（待处理）、“done”（已完成）、“cancel”（已取消）等。 - created_at: 订单创建时间，ISO 8601格式。 - updated_at: 订单最后更新时间，ISO 8601格式。
3.2 取消订单
接口URL：https://api.upbit.com/v1/order
请求方式：DELETE
请求参数：
- uuid: 要取消的订单的唯一标识符（UUID）。每个订单在系统中都有一个独一无二的UUID，您需要提供该UUID来指定您要取消的订单。
请求示例：
curl -X DELETE "https://api.upbit.com/v1/order" \
-H "Authorization: Bearer {ACCESS_TOKEN}" \
-H "Content-Type: application/" \
-d '{"uuid": "order-uuid"}'
说明：
- Authorization 头部需要带上您的访问令牌（Access Token），这是身份验证的关键。
- Content-Type 应设置为 application/，表示请求体的格式为JSON。
- uuid 为要取消订单的唯一标识符，您可以通过查询订单历史等方式获得订单的UUID。
- 删除请求会根据提供的UUID删除相应的订单，确保UUID准确无误，以避免错误操作。
返回结果：
当订单成功取消时，系统将返回一个包含订单取消状态的JSON对象。该对象通常包含有关请求结果的详细信息，如订单是否被成功取消，或在失败的情况下的错误信息。以下是返回结果的示例：
{
"success": true,
"message": "Order successfully canceled."
}
返回对象的字段说明：
- success: 一个布尔值，表示请求是否成功。如果值为
true，则表示订单已成功取消；如果为false，则表示取消订单的操作失败。 - message: 如果取消操作失败，该字段将包含失败的原因或其他相关信息。
注意事项：
- 在订单成功取消后，该订单的状态将不再处于"待成交"或"部分成交"状态，而是标记为"已取消"。
- 取消操作通常不可撤回，因此在执行取消请求之前，请务必确认订单的UUID无误。
- 如果订单已部分成交或已完成交易，取消请求可能无法成功。
- 确保在取消订单前，订单仍在有效期内。如果订单已过期或已完全成交，则无法取消。
四、API请求注意事项
在使用Upbit API时，开发者必须遵循一系列规定和最佳实践，以确保API请求的准确性、效率和安全性。每个API请求都应包含必要的认证信息，确保只有授权用户能够访问系统资源。使用API时，开发者需注意API的访问限制、请求频率、签名算法等技术要求。为了避免潜在的安全风险，API请求必须通过HTTPS协议进行加密传输，以保护数据在传输过程中的机密性。开发者还应定期更新API密钥，并确保密钥不被泄露或滥用。对于大规模的数据请求或高频操作，建议进行请求速率的合理控制，以防止因过度请求导致的API限流或账户封禁。Upbit还提供了错误处理机制，开发者应当根据API返回的错误码进行适当的错误捕获与重试机制，以确保系统的稳定性和可靠性。开发者需要时刻关注API文档更新，确保API调用始终符合最新的规范和功能要求。为了优化用户体验，建议开发者提前了解各类API的响应时间，避免由于长时间等待导致的用户体验不佳。
2. 请求限制
Upbit平台为了保障API的稳定性和服务质量，对每个账户的API请求数量进行严格限制。此举旨在防止恶意攻击、滥用行为或过度使用带来的服务器负担，同时确保所有用户的请求都能够公平处理。若请求超过设定的限制，可能会导致IP地址被临时或永久封禁，从而影响账户的正常使用。因此，开发者和用户必须密切关注并遵循这些限制规定。
- 每分钟请求次数：每个账户每分钟最多可以发起60次API请求。超出此限制，系统将自动拒绝额外的请求，并可能会对账户进行暂时封禁处理。
- 每秒请求次数：每个账户每秒最多可以发起10次请求。若请求频率超过此限制，系统会触发保护机制，暂时限制该IP的访问，防止对平台造成负担。
为了避免因请求过度而导致的IP封禁，开发者应当合理规划API的调用频率，特别是在高并发情况下。对于需要频繁访问数据的应用，建议采用批量请求或者分时段分散请求的方式来平衡请求负载。Upbit为开发者提供了多个API端点，开发者可以根据需要选择不同的端点进行数据访问，并合理利用缓存机制以减少重复请求。
如果开发者发现API请求超限，导致接口调用受限，建议查看官方文档了解如何合理使用API，或联系Upbit的技术支持团队进行咨询。遵守API请求限制不仅能保障系统的稳定性，还能避免因违规行为带来的不必要风险。
3. 错误处理
在调用API接口时，开发者可能会遇到各种错误情况，这些错误可能由不同因素引起。常见的错误类型包括请求参数格式不正确、缺乏足够的权限、请求频率超过限制、服务器内部故障等。Upbit在每次返回错误时，都会提供详细的错误码和描述信息，帮助开发者理解发生错误的具体原因。这些错误码通常对应不同的错误类别，能够准确地反映出请求失败的具体原因。开发者可以通过查看错误码来快速定位问题，进一步分析错误的类型和性质，进而进行相应的修复或优化。
例如，当出现请求参数错误时，错误信息中可能会详细列出缺失或格式不符合要求的参数。对于权限不足的问题，错误信息可能会指示用户的API密钥是否已过期或是否未授予足够的访问权限。请求频率过高的错误则通常与Upbit设定的API调用频率限制相关，开发者可以根据这些提示调整请求的发送频率或改进调用方式。
Upbit的错误信息不仅包括错误码和描述，还可能包含更多的调试信息或建议，帮助开发者避免常见的错误。根据返回的错误信息，开发者可以采取适当的措施，如调整请求参数、更新API权限、降低请求频率或联系Upbit的技术支持团队，以解决遇到的技术难题。
五、API接口文档
Upbit平台为开发者提供了详尽的API接口文档，涵盖了所有可用的接口、功能、请求方式、参数说明以及响应格式等关键信息。这些文档为开发者提供了全面的支持，能够帮助开发者理解如何与Upbit的交易系统进行高效、安全的交互。开发者可以通过这些接口实现自动化交易、市场数据获取、订单管理等多种功能，支持多种编程语言和环境。API文档链接：Upbit API文档
通过文档，开发者可以根据具体需求快速定位所需的接口。每个接口都配有详细的请求示例和返回示例，开发者可以直接参考这些示例代码进行集成。Upbit的API接口支持多种认证方式，包括API密钥、签名机制等，确保开发者的请求具有高安全性。文档中还提供了常见问题解答、错误码说明和最佳实践，帮助开发者快速解决开发过程中的问题并提高开发效率。
