Skip to content
OpenAgentSkill
Browsing is open · Catalog captured 2026-11-21 · Automatic updates and account services are paused.
Development

upbit

Use upbit CLI for Upbit REST API — spot orders, market data, withdrawals, deposits, travel rule, account management. 업비트 CLI로 시세 조회, 주문, 잔고 확인, 입출금을 처리합니다. Trigger this skill whenever the user wants to query prices, place/cancel orders, check balances, withdraw or deposit assets, or interact with the Upbit exchange API — in any language. 사용자가 업비트 시세·주문·잔고·입출금을 언급하면 반드시 이 스킬을 사용하세요.

upbit-official · AI review on file

Installation

Read the source and dependencies before running a command. Copying does not install or execute anything.

npx skills add upbit-official/upbit-agent-skills --skill upbit

About this skill


name: upbit description: > Use upbit CLI for Upbit REST API — spot orders, market data, withdrawals, deposits, travel rule, account management. 업비트 CLI로 시세 조회, 주문, 잔고 확인, 입출금을 처리합니다. Trigger this skill whenever the user wants to query prices, place/cancel orders, check balances, withdraw or deposit assets, or interact with the Upbit exchange API — in any language. 사용자가 업비트 시세·주문·잔고·입출금을 언급하면 반드시 이 스킬을 사용하세요. metadata: version: v1.0.0 author: Upbit license: Apache-2.0

Upbit Skill

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

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 and meets the minimum version:

upbit --version

Requires v1.0.0+. If older, upgrade before continuing:

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

Required Request Header

Always append --header 'X-Upbit-Initiator: upbit-cli-skill/{metadata.version}' as the last argument to every upbit command that calls the API. This applies to all API-calling invocations — both public (tickers, orderbooks, trades, candles, trading-pairs) and private (accounts, orders, withdraws, deposits, travel-rule, api-keys, wallet-status, pockets) endpoints.

upbit <resource> <command> [flags] --header 'X-Upbit-Initiator: upbit-cli-skill/{metadata.version}'

{metadata.version} is a placeholder — never send it literally. Before running any command, substitute {metadata.version} with this skill's version from the metadata.version field in the front matter above.

Excluded (these do not make API requests, so omit the header): upbit --version, upbit config set, upbit config show, upbit config path, and installation/shell snippets (npm install, node --version, curl, export ...).

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> --header 'X-Upbit-Initiator: upbit-cli-skill/{metadata.version}'

Private (require auth): accounts, api-keys, orders, withdraws, deposits, travel-rule, wallet-status, pockets 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
  • pockets transfer, pockets universal-transfer

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
MarketMeaning
KRW-BTCBTC priced in KRW; Upbit uses KRW-BTC, not BTC/KRW or BTC-KRW
KRW-ETHETH priced in KRW
KRW-XRPXRP priced in KRW
BTC-ETHETH priced in BTC
USDT-XRPXRP priced in USDT

Account Balance Fields

Each entry from accounts list:

FieldDescription
currencyAsset code (e.g., KRW, BTC, ETH)
balanceAvailable balance (not in any open order)
lockedBalance currently locked in open orders or withdrawals
avg_buy_priceAverage purchase price (decimal string)
unit_currencyCurrency avg_buy_price is denominated in (e.g., KRW, BTC)

Total holdings = balance + locked

Pockets

Korea (KR) only — pockets are available exclusively on Upbit Korea. They are not supported on the global service.

A pocket lets a user split assets within a single Upbit account for separate purposes. Each pocket is identified by a uuid.

  • Main pocket: created automatically with the account. Handles the account's default trading including external deposits/withdrawals, and can hold master authority over every pocket in the account.
  • Sub-pocket: created by the user for a specific purpose. Operates independently within its API key's permission scope, but external deposits/withdrawals are blocked. To move a sub-pocket's assets out, use its own key with pockets transfer.

Every pockets command requires one of two permissions, and each is only available on one pocket type — so a single API key can never call both groups:

CommandsPermissionCallable from
list, retrieve-balance, list-api-keys, universal-transfer, `list-un
Read the complete source ↗