api.md

Accounts

Types:

from upbit.types import AccountListResponse

Methods:

• client.accounts.list() -> AccountListResponse

TravelRule

Types:

from upbit.types import VerificationResult, TravelRuleListVaspsResponse

Methods:

• client.travel_rule.list_vasps() -> TravelRuleListVaspsResponse
• client.travel_rule.verify_deposit_by_txid(**params) -> VerificationResult
• client.travel_rule.verify_deposit_by_uuid(**params) -> VerificationResult

WalletStatus

Types:

from upbit.types import WalletStatusListResponse

Methods:

• client.wallet_status.list() -> WalletStatusListResponse

APIKeys

Types:

from upbit.types import APIKeyListResponse

Methods:

• client.api_keys.list() -> APIKeyListResponse

Orders

Types:

from upbit.types import (
    BatchCancelResult,
    ClosedOrderState,
    OpenOrderState,
    OrdTypeEnum,
    Order,
    SideEnum,
    SmpTypeEnum,
    TimeInForceEnum,
    OrderListByUuidsResponse,
    OrderListClosedResponse,
    OrderRetrieveChanceResponse,
)

Methods:

• client.orders.create(**params) -> Order
• client.orders.retrieve(**params) -> Order
• client.orders.cancel(**params) -> Order
• client.orders.cancel_and_new(**params) -> Order
• client.orders.cancel_by_uuids(**params) -> BatchCancelResult
• client.orders.cancel_open(**params) -> BatchCancelResult
• client.orders.list_by_uuids(**params) -> OrderListByUuidsResponse
• client.orders.list_closed(**params) -> OrderListClosedResponse
• client.orders.list_open(**params) -> SyncPageNumberPage[Order]
• client.orders.retrieve_chance(**params) -> OrderRetrieveChanceResponse
• client.orders.test_create(**params) -> Order

Withdraws

Types:

from upbit.types import (
    Withdraw,
    WithdrawCreateKrwWithdrawalResponse,
    WithdrawListCoinAddressesResponse,
    WithdrawRetrieveChanceResponse,
)

Methods:

• client.withdraws.retrieve(**params) -> Withdraw
• client.withdraws.list(**params) -> SyncUuidCursorIDPage[Withdraw]
• client.withdraws.cancel_withdrawal(**params) -> Withdraw
• client.withdraws.create_krw_withdrawal(**params) -> WithdrawCreateKrwWithdrawalResponse
• client.withdraws.create_withdrawal(**params) -> Withdraw
• client.withdraws.list_coin_addresses() -> WithdrawListCoinAddressesResponse
• client.withdraws.retrieve_chance(**params) -> WithdrawRetrieveChanceResponse

Deposits

Types:

from upbit.types import (
    Deposit,
    DepositAddress,
    DepositCreateCoinAddressResponse,
    DepositListCoinAddressesResponse,
    DepositRetrieveChanceResponse,
)

Methods:

• client.deposits.retrieve(**params) -> Deposit
• client.deposits.list(**params) -> SyncUuidCursorIDPage[Deposit]
• client.deposits.create_coin_address(**params) -> DepositCreateCoinAddressResponse
• client.deposits.deposit_krw(**params) -> Deposit
• client.deposits.list_coin_addresses() -> DepositListCoinAddressesResponse
• client.deposits.retrieve_chance(**params) -> DepositRetrieveChanceResponse
• client.deposits.retrieve_coin_address(**params) -> DepositAddress

TradingPairs

Types:

from upbit.types import TradingPairListResponse

Methods:

• client.trading_pairs.list(**params) -> TradingPairListResponse

Tickers

Types:

from upbit.types import (
    Ticker,
    TickerListByQuoteCurrenciesResponse,
    TickerListByTradingPairsResponse,
)

Methods:

• client.tickers.list_by_quote_currencies(**params) -> TickerListByQuoteCurrenciesResponse
• client.tickers.list_by_trading_pairs(**params) -> TickerListByTradingPairsResponse

Orderbooks

Types:

from upbit.types import OrderbookListResponse, OrderbookListInstrumentsResponse

Methods:

• client.orderbooks.list(**params) -> OrderbookListResponse
• client.orderbooks.list_instruments(**params) -> OrderbookListInstrumentsResponse

Trades

Types:

from upbit.types import TradeListResponse

Methods:

• client.trades.list(**params) -> TradeListResponse

Candles

Types:

from upbit.types import (
    Candle,
    CandlePeriod,
    CandleListDaysResponse,
    CandleListMinutesResponse,
    CandleListMonthsResponse,
    CandleListSecondsResponse,
    CandleListWeeksResponse,
    CandleListYearsResponse,
)

Methods:

• client.candles.list_days(**params) -> CandleListDaysResponse
• client.candles.list_minutes(unit, **params) -> CandleListMinutesResponse
• client.candles.list_months(**params) -> CandleListMonthsResponse
• client.candles.list_seconds(**params) -> CandleListSecondsResponse
• client.candles.list_weeks(**params) -> CandleListWeeksResponse
• client.candles.list_years(**params) -> CandleListYearsResponse

WsPublic

Types:

from upbit.types import ConnectPublicClientEvent, ConnectPublicServerEvent

WsPrivate

Types:

from upbit.types import ConnectPrivateClientEvent, ConnectPrivateServerEvent