Python Upbit API

Installation

pip install python-upbit-api

Quick Start

인증 없이 사용하기

# example.py
from upbit import Upbit
upbit = Upbit()
res = upbit.get_markets()
data = res.json()
upbit.get_accounts() # upbit.exceptions.ApiKeyError 발생

인증 사용하기

UPBIT_OPEN_API_ACCESS_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
UPBIT_OPEN_API_SECRET_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

# example.py
import os
from upbit import Upbit
access_key = os.environ.get('UPBIT_OPEN_API_ACCESS_KEY')
secret_key = os.environ.get('UPBIT_OPEN_API_SECRET_KEY')
upbit = Upbit(access_key, secret_key)
res = upbit.get_accounts()
data = res.json()

Features

업비트 REST API를 모두 메서드로 제공

Requests 사용

예외 클래스 제공

# example.py
from upbit import Upbit, TooManyRequests, UpbitClientError, UpbitServerError
upbit = Upbit()
try:
 res = upbit.get_markets()
except TooManyRequests as e:
 status_code = e.response.status_code # 429
 # ...예외 처리 코드
except UpbitClientError as e:
 res = e.response
 # ...예외 처리 코드
except UpbitServerError as e:
 res = e.response
 # ...예외 처리 코드

잔여 요청 수 확인

# example.py
from upbit import Upbit
from upbit.models import RemainingReq
upbit = Upbit()
res = upbit.get_candles_day('KRW-BTC')
rr: RemainingReq = upbit.get_remaining_reqs('candles')
rr.minute
rr.updated
# 응답 헤더도 그대로 사용 가능
rr_text = res.headers['Remaining-Req'] # 'group=candles; min=59; sec=4'

요청 파라미터 모델 제공

# example.py
from upbit.models import OrderSide
# ...
# Type Hint
order_side: OrderSide = 'bid'
res = upbit.create_order(market='KRW-BTC', side=order_side, ord_type='limit', price='100', volume='0.01')

Docstring & Type Hint

WebSocket

Changelog