💙 Python Upbit API는 간단하고 명료한 Upbit API Wrapper 입니다. 👍

pip 명령어로 간단하게 설치할 수 있습니다.

pip install python-upbit-api

각종 시세 정보를 얻기 위한 QUOTATION API만 사용한다면 인증 정보 없이 초기화 후 사용합니다.
⚠️ EXCHANGE API를 사용하면 upbit.exceptions.ApiKeyError 예외가 발생합니다.

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

인증이 필요한 EXCHANGE API를 사용해야 한다면 인증 정보를 초기화시 등록 후 사용합니다.
🙆🏻‍♀️ QUOTATION API도 사용할 수 있습니다.

.env 환경설정 파일에 발급 받은 인증 정보를 설정합니다.

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()

업비트 REST API를 Upbit 클래스의 메서드로 제공합니다. 자세한 내용은 upbit.py 파일 내 docstring 참조.

Requests 라이브러리를 사용합니다.

1. requests.Response 객체를 그대로 반환합니다.

   # example.py from upbit import Upbit upbit = Upbit() res = upbit.get_markets() data = res.json() status_code = res.status_code

2. requests.adapters.HTTPAdapter 클래스를 사용하여 재시도 횟수 등을 설정할 수 있습니다.

   # example.py from upbit import Upbit import requests adapter = requests.adapters.HTTPAdapter(max_retries=3) upbit = Upbit(http_adapter=adapter)

3. requests.Session.request 요청 파라미터 timeout 값을 설정할 수 있습니다.

   # example.py from upbit import Upbit upbit = Upbit(timeout=(10, 5)) # 모든 요청에 설정할 timeout res = upbit.get_markets(timeout=10) # 이 요청에만 설정할 timeout

모든 API 요청에서 발생한 requests.exceptions.HTTPError 예외는 이 예외를 상속한 upbit.exceptions.UpbitHTTPError 예외로 발생합니다.

아래 Upbit 공식 문서에 공개한 에러 유형에 맞는 예외 쌍을 가집니다.

• 요청 수 제한
• API 주요 에러 코드 목록

# 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 # ...예외 처리 코드

업비트 API Remaining-Req 응답 헤더에 담긴 잔여 요청 수를 upbit.models.RemainingReq 객체로 제공되어 정보에 쉽게 접근 할 수 있습니다. 요청 그룹별 최신 값을 프로퍼티에 저장하며 get_remaining_reqs() 함수를 호출하면 그룹의 최신 잔여 요청 수 객체를 확인 할 수 있습니다.

참고: Exchange API 잔여 요청 수 확인 방법

# 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'

Upbit API 요청 파라미터에 사용할 다양한 데이터 모델을 타입으로 제공합니다.

# 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 내용과 타입으로 IDE에서 사용하기 편리합니다. 📝💡

아직 지원하지 않습니다. 참고 이슈

최신 변경 사항은 아래에서 확인할 수 있습니다.

• CHANGELOG.md
• PyPI Releases