Upbit

Upbit Skill

Use the upbit CLI binary for all Upbit REST API interactions.

⚠️ Onboarding — when credentials are missing

When UPBIT_ACCESS_KEY / UPBIT_SECRET_KEY are not set, or an authenticated command returns 401:

In a single turn, do ALL of the following in this exact order:

1. Call bash("curl -s https://api.ipify.org") to get the outbound IP. 2. Write the setup instructions below in your reply text (substitute <ip> with the real IP from step 1):

---

Step 1 — Allowlist this IP on Upbit

Upbit only accepts API calls from IP addresses you explicitly allow. Add this IP:

<ip>

Step 2 — Create an API key

1. Log in to upbit.com → profile → API 관리 (API Management) 2. Click API 키 발급 (Issue API Key) 3. When prompted for an IP, paste <ip> 4. Enable scopes:

• 자산조회 (View assets) — always required
• 주문조회 (View orders) — required
• 주문생성 (Place orders) — required to trade
• 출금 (Withdraw) — only if you want withdrawal support

5. Complete 2FA + email verification, then copy your Access Key and Secret Key

Step 3 — Enter your keys

Enter your Access Key and Secret Key in the secure input card below.

---

Language Behavior

Detect the user's language and respond accordingly:

• Korean user: respond in Korean, use Korean terminology from references/glossary.md (e.g., 주문, 매수, 잔고, 체결, 호가)
• English user: respond in English, use English terminology from the same glossary
• Mixed/ambiguous: follow the language of the most recent message

When explaining API fields or command output, always translate field names into the user's language using the glossary. For example, if the user asks in Korean, explain bid as "매수", ask as "매도", balance as "보유 잔고".

Load references/glossary.md when translating terminology or explaining response fields.

Setup

If upbit is not installed or credentials are not configured, load references/setup.md and follow the steps there.

Check if upbit is available:

upbit --version

Authentication

Private endpoints require credentials. Configure via the CLI (recommended):

upbit config set

Credentials are saved to ~/.upbit/config and automatically used for all CLI commands.

Alternatively, set via environment variables:

export UPBIT_ACCESS_KEY=<your-access-key>
export UPBIT_SECRET_KEY=<your-secret-key>

Or pass inline per command:

upbit <resource> <command> --access-key <key> --secret-key <secret>

Private (require auth): accounts, api-keys, orders, withdraws, deposits, travel-rule, wallet-status Public (no auth): tickers, orderbooks, trades, candles, trading-pairs

Safety Rule — Write Operations

Before executing any write operation, show the full command and ask the user to type CONFIRM.

Write operations:

• orders create, orders cancel, orders cancel-and-new, orders cancel-by-uuids, orders cancel-open
• withdraws create-withdrawal, withdraws create-krw-withdrawal, withdraws cancel-withdrawal
• deposits deposit-krw, deposits create-coin-address
• travel-rule verify-deposit-by-txid, travel-rule verify-deposit-by-uuid

orders test-create is a dry-run — no CONFIRM needed.

Upbit Domain Concepts

Market Pair Format

• Field name: market
• Format: {QUOTE}-{BASE} — quote currency first, base asset second
• Delimiter: hyphen (-), not slash (/)
• Always uppercase
• Quote currencies: KRW, BTC, USDT
• Not {BASE}-{QUOTE} or {BASE}/{QUOTE} — Upbit reverses the conventional order used by most exchanges

Account Balance Fields

Each entry from accounts list:

Total holdings = balance + locked

Order Types (ord_type)

`best` order rules:

• time_in_force must be ioc or fok (NOT post_only)
• If side=bid (buy): requires price, must omit volume
• If side=ask (sell): requires volume, must omit price

`post_only` + `smp_type` conflict: these two are mutually exclusive — do not set both.

Side Values

Order States

Order Fee Fields

First-Time Order Placement

Before placing an order on an unfamiliar market, run orders retrieve-chance to confirm:

• Minimum order amount (bid.min_total, ask.min_total)
• Supported order types (bid_types, ask_types)
• Fee rates (bid_fee, ask_fee, maker_bid_fee, maker_ask_fee)

upbit orders retrieve-chance --market "KRW-BTC"

Withdrawal — Multi-Chain Assets

For assets available on multiple networks (e.g., USDT), net_type is required to specify the blockchain. Use withdraws list-coin-addresses to see supported networks and addresses before withdrawing:

upbit withdraws list-coin-addresses --currency "USDT"

Withdrawal — Secondary Address

Some assets require a secondary address (Destination Tag, Memo, etc.) in addition to the main address. Always check the registered address via withdraws list-coin-addresses to see if secondary_address is present before sending.

Withdrawal — Address Not Registered (withdraw_address_not_registered)

When withdraws create-withdrawal returns a 400 error with name: withdraw_address_not_registered, the address has not been registered in the Upbit Open API withdrawal allowlist.

To register a withdrawal address, visit the allowlist management page for your environment:

After registering, run withdraws list-coin-addresses to confirm the address appears before retrying.

Deposit / Withdraw States

When a deposit is in TRAVEL_RULE_SUSPECTED state, use travel-rule commands to verify.

Wallet Status

wallet-status list returns per-asset network status:

Candle Units & Limits

• Minute candles: supported units are 1, 3, 5, 10, 15, 30, 60, 240 only
• Second candles: data retention is 3 months maximum (older queries return empty array)
• count: default 1, max 200 per request

Trade Pagination

• count: max 500 per request
• cursor: pass sequential_id from last result to page forward
• days_ago: integer 1–7 (UTC-based day offset)

Ticker Key Fields

Price Direction Enum (change, ask_bid)

Units & Formats

Day boundaries (opening_price, acc_trade_price, etc.) are based on UTC 00:00, not KST.

Command Reference

When you need detailed flag information for a resource, read the corresponding reference file.

For flags not listed in reference files, run: upbit <resource> <command> --help

Environment

upbit accounts list                   # kr (default)
upbit accounts list --environment sg  # sg | id | th
upbit accounts list --base-url <url>  # custom base URL

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.

"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:

(a) You must give any other recipients of the Work or Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.

You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.

Copyright 2026 Upbit

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Accounts

Get Account Balances

Auth required

upbit accounts list

---

Api Keys

List API Keys

Auth required

upbit api-keys list

---

Wallet Status

Get Deposit/Withdrawal Service Status

Auth required

upbit wallet-status list

---

Candles

List Second Candles

upbit candles list-seconds \
  --market "KRW-BTC"

---

List Minute Candles

upbit candles list-minutes \
  --unit 15 \
  --market "KRW-BTC"

---

List Day Candles

upbit candles list-days \
  --market "KRW-BTC"

---

List Week Candles

upbit candles list-weeks \
  --market "KRW-BTC"

---

List Month Candles

upbit candles list-months \
  --market "KRW-BTC"

---

List Year Candles

upbit candles list-years \
  --market "KRW-BTC"

---

Deposits

Get Available Deposit Information

Auth required

upbit deposits retrieve-chance \
  --currency "BTC" \
  --net-type "BTC"

---

Create Deposit Address

Auth required

upbit deposits create-coin-address \
  --currency "BTC" \
  --net-type "BTC"

---

Get Deposit Address

Auth required

upbit deposits retrieve-coin-address \
  --currency "BTC" \
  --net-type "BTC"

---

List Deposit Addresses

Auth required

upbit deposits list-coin-addresses

---

Deposit KRW

Auth required

upbit deposits deposit-krw \
  --amount "10000" \
  --two-factor-type "naver"

---

List Deposits

Auth required

upbit deposits list \
  --currency "KRW"

---

Get Deposit

Auth required

upbit deposits retrieve \
  --uuid "94332e99-3a87-4a35-ad98-28b0c969f830"

---

Upbit Terminology Glossary / 업비트 용어 사전

Use the terms below according to the user's language. 사용자 언어에 맞게 아래 용어를 사용하라.

---

Core Trading Terms / 핵심 거래 용어

---

Order / 주문 관련

---

Deposits / 입금 관련

---

Travel Rule / 트래블룰

---

Market Data / 시세

---

Account / 잔고

---

Wallet Status / 입출금 서비스 상태

Orderbooks

Get Orderbook

upbit orderbooks list \
  --markets "KRW-BTC,KRW-ETH"

---

List Orderbook Instruments

upbit orderbooks list-instruments \
  --markets "KRW-BTC,KRW-ETH"

---

Orders

Get Available Order Info

Auth required

upbit orders retrieve-chance \
  --market "KRW-BTC"

---

Create Order

Auth required

upbit orders create \
  --market "KRW-BTC" \
  --side "bid" \
  --volume "1" \
  --price "14000000" \
  --ord-type "limit"

---

Test Order Creation

Auth required

upbit orders test-create \
  --market "KRW-BTC" \
  --side "bid" \
  --volume "1" \
  --price "14000000" \
  --ord-type "limit"

---

List Closed Orders

Auth required

upbit orders list-closed \
  --market "KRW-BTC" \
  --state "done" \
  --state "cancel"

---

Cancel and New Order

Auth required

upbit orders cancel-and-new \
  --prev-order-uuid "ad217e24-ed02-469c-9b30-c08dbbda6908" \
  --new-ord-type "limit" \
  --new-price "100000000"

---

Get Order

Auth required

upbit orders retrieve \
  --uuid "9ca023a5-851b-4fec-9f0a-48cd83c2eaae"

---

Cancel Order

Auth required

upbit orders cancel \
  --uuid "cdd92199-2897-4e14-9448-f923320408ad"

---

List Orders by IDs

Auth required

upbit orders list-by-uuids \
  --uuid "5d303952-8be9-41e6-915b-121a90026248" \
  --uuid "3944c2c1-bd8c-441a-aa25-2370d08217a9" \
  --uuid "5b95451b-971e-4e76-8f61-5ff441f078d5" \
  --uuid "3b67e543-8ad3-48d0-8451-0dad315cae73"

---

Cancel Orders by IDs

Auth required

upbit orders cancel-by-uuids \
  --uuid "bbbb8e07-1689-4769-af3e-a117016623f8" \
  --uuid "4312ba49-5f1a-4a01-9f3b-2d2bce17267e" \
  --uuid "bdb49a54-de36-4eb4-a963-9c8d4337a9da"

---

List Open Orders

Auth required

upbit orders list-open \
  --market "KRW-BTC" \
  --state "wait" \
  --state "watch"

---

Batch Cancel Orders

Auth required

upbit orders cancel-open \
  --quote-currencies "KRW,BTC" \
  --cancel-side "all" \
  --excluded-pairs "KRW-ETH,BTC-XRP"

---

Output & Filtering Reference

--format

<!-- TODO -->

--transform (GJSON)

<!-- TODO -->

--format-error / --transform-error

<!-- TODO -->

--debug

<!-- TODO -->

Auto-paging

<!-- TODO -->

--environment

<!-- TODO -->

Upbit CLI Setup

Guide the user through installing the Upbit CLI and configuring API credentials.

Step 0 — Select Environment

Detect the user's language:

• Korean: assume kr environment. Do not ask — proceed directly with KR defaults. Omit --environment flag from all commands (KR is the CLI default).
• Other language: ask which environment they are using before proceeding:

"Which environment are you using?"

- kr — Korea (https://www.upbit.com)

- sg — Singapore (https://sg.upbit.com)

- id — Indonesia (https://id.upbit.com)

- th — Thailand (https://th.upbit.com)

Store the selected environment and use it throughout all subsequent steps — in API key management URLs, verification commands, and examples.

Environment reference table:

---

Step 1 — Prerequisites

Check Node.js availability:

node --version

Requires Node.js 18 or later. If not installed, direct the user to https://nodejs.org.

---

Step 2 — Install upbit CLI

npm install -g @upbit-official/upbit-cli

After installation, verify:

upbit --version

If upbit is not found after installation, the user may need to update their PATH. Common fixes:

• macOS/Linux (npm global bin not in PATH):

  export PATH="$(npm bin -g):$PATH"

Add to ~/.zshrc or ~/.bashrc to persist.

• Windows: Restart the terminal or check npm config get prefix and add the \bin subdirectory to the system PATH.

---

Step 3 — Check Current IP Address

Upbit API keys can be restricted to specific IP addresses. Before the user creates their API key, retrieve and display their current public IP:

curl -s https://api.ipify.org

Show the result to the user and advise them to add this IP when configuring allowed IPs on the API management page.

If the user is on a dynamic IP or plans to use the CLI from multiple machines, they may want to add multiple IPs or leave the IP restriction empty (less secure).

---

Step 4 — Get API Keys

Direct the user to the API key management page for their selected environment (from Step 0).

Required permissions for full CLI functionality:

Public endpoints (tickers, orderbooks, candles, etc.) do not require API keys.

---

Step 5 — Configure Credentials

upbit config set requires an interactive terminal (TTY) — it cannot be run by Claude or via the ! prefix in Claude Code. The user must run it directly in a separate terminal.

Instruct the user to: 1. Open a new terminal window 2. Run:

   upbit config set

3. Enter the Access Key and Secret Key when prompted 4. Return here when done

Credentials are saved to ~/.upbit/config and automatically used for all subsequent CLI commands.

---

Step 6 — Verify Setup

After upbit config set completes, verify credentials are saved correctly:

upbit config show

Expected output:

access_key:  xxxx****xxxx  (source: file)
secret_key:  xxxx****xxxx  (source: file)
config_file: ~/.upbit/config

Then test with a live API call:

• KR: upbit accounts list
• Other: upbit accounts list --environment <selected-environment>

A successful response returns the user's asset balances. An authentication error means the keys were entered incorrectly — run upbit config set again.

---

Credential Priority

The CLI resolves credentials in this order (highest priority first):

1. CLI flags: --access-key, --secret-key 2. Environment variables: UPBIT_ACCESS_KEY, UPBIT_SECRET_KEY 3. Config file: ~/.upbit/config (set via upbit config set)

To check the active credential source:

upbit config show

To check the config file path:

upbit config path

---

Troubleshooting

Tickers

List Tickers by Pairs

upbit tickers list-by-trading-pairs \
  --markets "KRW-BTC,KRW-ETH"

---

List Tickers by Market

upbit tickers list-by-quote-currencies \
  --quote-currencies "KRW,BTC,USDT"

---

Trades

Recent Trades History

upbit trades list \
  --market "KRW-BTC"

---

Trading Pairs

Market Pair Format

Upbit uses {QUOTE}-{BASE} order — quote currency first, base asset second.

Quote currencies: KRW, BTC, USDT. Always uppercase, hyphen-delimited.

List Trading Pairs

upbit trading-pairs list

---

Travel Rule

List Travel Rule Supporting VASPs

Auth required

upbit travel-rule list-vasps

---

Verify Travel Rule by Deposit UUID

Auth required

upbit travel-rule verify-deposit-by-uuid \
  --deposit-uuid "5b871d34-fe38-4025-8f5c-9b22028f85d3" \
  --vasp-uuid "8d4fe968-82b2-42e5-822f-3840a245f802"

---

Verify Travel Rule by Deposit TxID

Auth required

upbit travel-rule verify-deposit-by-txid \
  --vasp-uuid "8d4fe968-82b2-42e5-822f-3840a245f802" \
  --txid "5b871d34-fe38-4025-8f5c-9b22028f85d3" \
  --currency "ETH" \
  --net-type "ETH"

---