GuidesAPI ReferenceRecipesAnnouncementsSupport
API Reference
Start typing to search…

Overview

This page provides a comprehensive overview of Upbit API’s main features and integration process.

Upbit API Overview

Upbit API is organized into two main categories ⏤ Quotation and Exchange ⏤ based on the type of information provided:

  • Quotation: Retrieve real-time and historical price data for all trading pairs available on Upbit.
  • Exchange: Place and manage orders, deposits, withdrawals, and assets by connecting to your personal Upbit account.

The key features and scope of each API category are outlined below.

Quotation Exchange
Functionalities Trading pairs, candles(OHLCV), trade history, current price, order book retrieval Account asset inquiry, order management, deposit and withdrawal management, etc.
Authorization Public API, accessible without authentication Private API, authentication required using API Key
Operation Scope Read-only(including historical and real-time queries) Create, Read, Delete(Cancle)

Regional Endpoints

Upbit Global requires you to connect to the API endpoint that matches your service region. Using the correct endpoint ensures proper access and stable operation of the API. For more details, refer to the REST API Usage and Error Guide and WebSocket Usage and Error Guide documents.

The available endpoints by country are as follows.

REST API Endpoints

Upbit Singapore: https://sg-api.upbit.com

Upbit Indonesia: https://id-api.upbit.com

Upbit Thailand: https://th-api.upbit.com

WebSocket Endpoints

Upbit Singapore: wss://sg-api.upbit.com/websocket/v1, wss://sg-api.upbit.com/websocket/v1/private

Upbit Indonesia: wss://id-api.upbit.com/websocket/v1, wss://id-api.upbit.com/websocket/v1/private

Upbit Thailand: wss://th-api.upbit.com/websocket/v1, wss://th-api.upbit.com/websocket/v1/private


Integration Methods

Upbit API supports both REST API and WebSocket integration methods. Please refer to the comparison table below to choose the most suitable protocol for your application environment and use case.

REST API WebSocket
Communication Method Operates on a request-response basis, sending requests as needed Stream-based method that maintains continuous communication with the server after initial connection to receive real-time data
Advantages
  • Intuitive and easy to implement and test
  • Supports server environment integration based on HTTP
  • Provides clear data at the time of request
    		•
  • Optimized for real-time data reception such as market prices with low latency and fast updates
  • Traffic can be minimized by using compressed data formats and other techniques
    		•
    Disadvantages
  • Lower real-time capability (needs polling)
  • A request must be made each time
    		•
  • Higher implementation complexity: Requires managing connection (ping/pong, reconnect, etc.)
  • Continuous resource use for open connections
    		•
    Recommended Use Order creation/cancellation, deposit/withdrawal, periodic or on-demand queries Real-time market/trade subscriptions, auto-trading bots, monitoring

    The List of Upbit REST API and WebSocket Features

    The complete list of REST API and WebSocket features currently supported by Upbit is as follows.

    Category Key Features REST API WebSocket
    Quotation
    Trading Pairs    		 Retrieve list of all trading pairs supported by Upbit
  • List Trading Pairs
    		•  -
    Quotation
    Candles(OHLCV)    		 Retrieve statistics such as open, high, low, close prices, trading value, and volume by time unit Retrieve candle data for a specified single trading pair

  • List Second Candles
  • List Minute Candles
  • List Day Candles
  • List Week Candles
  • List Month Candles
  • List Year Candles
    		•  Subscribe to Real-time Pair Candle Data(Second/Minute)
    Quotation
    Trades    		 Retrieve trade information including trade time, price, volume, and direction Retrieve recent trade history for the specified pair

  • List Pair Trades
    		•  Subscribe to Real-time Pair Trade Data
    Quotation
    Tickers    		 Retrieve current price information including latest trade time, open, high, low, current price, price change, volume, and 52-week high/low
  • List Tickers by Pairs
  • List Tickers by Market
    		•  Subscribe to Real-time Current Price Data per Pair
    Quotation
    Orderbook    		 Retrieve orderbook data including buy/sell prices, quantities, and total volume
  • Get Orderbook Data
  • List Orderbook Instruments
    		•  Subscribe to Real-time Orderbook Data per Pair
    Exchange
    Assets    		 Retrieve asset balance held by the account
  • Get Account Balances
    		•  Subscribe to Real-time Account Balance Changes
    Exchange
    Orders    		 Create and cancel orders
  • Create Order
  • Cancel Order
  • Cancel Orders by IDs
  • Batch Cancel Orders
  • Cancel and New Order
    		•  -
    Order Inquiry
  • Get Available Order Information
  • Get Order
  • List Orders by IDs
  • Get Open Orders
  • Get Closed Orders
    		•  Subscribe to Real-time Order and Trade Info
    Exchange
    Withdrawals    		 Request and cancel withdrawals
  • Withdraw Digital Assets
  • Cancel Withdrawal
    		•  -
    Withdrawal Inquiry
  • Get Available Withdrawal Information
  • List Withdrawal Allowed Addresses
  • Get Withdrawal
  • List Withdrawals
    		•  -
    Exchange
    Deposits    		 Manage digital asset deposit addresses
  • Create Deposit Address
  • Get Deposit Address
  • List Deposit Addresses
    		•  -
    Manage Digital Asset Deposits
  • Get Digital Asset Deposit Availability Information
  • Get Deposit
  • List Deposits
    		•  -
    Travel Rule (Account Owner Verification Service) Management
  • List Travel Rule Supporting VASPs
  • Verify Travel Rule by Deposit UUID
  • Verify Travel Rule by Deposit TxID
    		•  -
    Exchange
    Services    		 Check deposit/withdrawal service status
  • Get Deposit/Withdrawal Service Status
    		•  -