pyupbit Documentation

The Quotation API allows you to retrieve market data, order books, and tickers without an API key.

Rate Limits:

• Ticker, Candle, Trade, and Orderbook APIs: 10 requests per second, 600 requests per minute.
• Websocket: 5 connection requests per second, 100 requests per minute.

To perform private operations like checking balances or placing orders, you must create an Upbit object using your Upbit Access Key and Secret Key. This is equivalent to logging into the Upbit website.

Rate Limits:

• Orders: 8 requests per second, 200 requests per minute.
• Non-order requests: 30 requests per second, 900 requests per minute.

import pyupbit

access = "YOUR_ACCESS_KEY"
secret = "YOUR_SECRET_KEY"
upbit = pyupbit.Upbit(access, secret)

To use pyupbit, install it via pip. Note that it requires pyjwt >= 2.0 for certain functionalities. It is recommended to use a modern Python 3 environment (e.g., Anaconda).

pip install pyupbit
pip install pyjwt

Install the pyupbit library using pip to interact with the Upbit exchange API.

pip install pyupbit

To use the Exchange API for orders, withdrawals, deposits, and asset management, you must first initialize the Upbit class using your Upbit API access and secret keys.

import pyupbit 

access = "access key"  
secret = "secret key"
upbit = Upbit(access, secret)

Use pyupbit.get_current_price() to retrieve the current market price for a specific ticker. Pass the ticker symbol (e.g., "KRW-BTC") as a string argument.

import pyupbit 

price = pyupbit.get_current_price("KRW-BTC")
print(price)

Use pyupbit.get_tickers() to get a list of all available ticker symbols on the exchange. The returned object is a list of ticker strings.

import pyupbit 

tickers = pyupbit.get_tickers()
print(tickers)
print(type(tickers))

The Exchange API allows you to monitor service status and your own API credentials:

• Check API key list: Use upbit.get_api_key_list() to retrieve a list of your API keys and their expiration dates.
• Check deposit/withdrawal status: Monitor the current status of inflows and outflows.

import pyupbit 

access = "access key"  
secret = "secret key"
upbit = Upbit(access, secret)

api_key_info = upbit.get_api_key_list()
print(api_key_info)

Use pyupbit.get_tickers() to fetch available market tickers. You can filter the results by market type (e.g., 'KRW', 'BTC', 'USDT').

import pyupbit

# Get all available tickers
tickers = pyupbit.get_tickers()

# Get tickers for the KRW market
krw_tickers = pyupbit.get_tickers("KRW")

# Get tickers for the BTC market
btc_tickers = pyupbit.get_tickers("BTC")

# Get tickers for the USDT market
usdt_tickers = pyupbit.get_tickers("USDT")

Use the Upbit instance to retrieve balance information.

• get_balance(ticker): Returns the quantity of a specific ticker (e.g., "KRW-XRP" or "KRW" for cash).
• get_balances(): Returns a list of dictionaries containing all held cryptocurrencies, including their balances and average buy prices.

# Check specific ticker balance
print(upbit.get_balance("KRW-XRP"))

# Check KRW cash balance
print(upbit.get_balance("KRW"))

# Check all balances
print(upbit.get_balances())

The Exchange API provides several methods for managing trading activity:

• Check order availability: Use upbit.get_chance(market) (e.g., "KRW-BTC") to check orderable information for a specific market.
• Cancel an order: Use upbit.cancel_order(uuid) with the specific order UUID to cancel a pending order.
• Retrieve individual order: Query details for a specific order using its UUID.
• List orders: Retrieve a list of recent orders.
• Place an order: Execute new buy or sell orders.

# Check order availability
chance = upbit.get_chance("KRW-BTC")

# Cancel an order
import pyupbit
access = "access key"
secret = "secret key"
upbit = Upbit(access, secret)
uuid = "uuid"  # The UUID of the order to cancel
cancel_result = upbit.cancel_order(uuid)
print(cancel_result)

The get_orderbook function retrieves the current buy/sell orderbook (quotes) information.

• You can pass a single ticker string or a list of tickers.
• The return value is a list of dictionaries containing:
  • market: The ticker.
  • timestamp: The query time in milliseconds.
  • total_ask_size: Total ask size.
  • total_bid_size: Total bid size.
  • orderbook_units: A list of dictionaries containing ask_price, bid_price, ask_size, and bid_size for each price level.

import pyupbit

# Single ticker
print(pyupbit.get_orderbook(ticker="KRW-BTC"))

# Multiple tickers
print(pyupbit.get_orderbook(ticker=["KRW-BTC", "KRW-XRP"]))