API reference

class cryptocom.exchange.Account(*, api_key: str = '', api_secret: str = '', from_env: bool = False, exchange: Optional[cryptocom.exchange.market.Exchange] = None, api: Optional[cryptocom.exchange.api.ApiProvider] = None)

Provides access to account actions and data. Balance, trades, orders.

async buy_limit(pair: cryptocom.exchange.structs.Pair, quantity: float, price: float, force_type: Optional[cryptocom.exchange.structs.OrderForceType] = None, exec_type: Optional[cryptocom.exchange.structs.OrderExecType] = None, client_id: Optional[int] = None) → int

Buy limit order.

async buy_market(pair: cryptocom.exchange.structs.Pair, spend: float, wait_for_fill=False) → int

Buy market order.

async cancel_open_orders(pair: cryptocom.exchange.structs.Pair) → None

Cancel all open orders.

async cancel_order(order_id: int, pair: cryptocom.exchange.structs.Pair, check_status=False) → None

Cancel order.

async create_order(pair: cryptocom.exchange.structs.Pair, side: cryptocom.exchange.structs.OrderSide, type_: cryptocom.exchange.structs.OrderType, quantity: float, price: float = 0, force_type: Optional[cryptocom.exchange.structs.OrderForceType] = None, exec_type: Optional[cryptocom.exchange.structs.OrderExecType] = None, client_id: Optional[int] = None) → int

Create raw order with buy or sell side.

async get_balance() → Dict[cryptocom.exchange.structs.Coin, cryptocom.exchange.structs.Balance]

Return balance.

async get_deposit_history(coin: cryptocom.exchange.structs.Coin, start_ts: Optional[int] = None, end_ts: Optional[int] = None, status: Optional[cryptocom.exchange.structs.DepositStatus] = None, page: int = 0, page_size: int = 20) → List[cryptocom.exchange.structs.Deposit]

Return all history withdrawals.

async get_interest_history(coin: cryptocom.exchange.structs.Coin, start_ts: Optional[int] = None, end_ts: Optional[int] = None, page: int = 0, page_size: int = 20) → List[cryptocom.exchange.structs.Interest]

Return all history interest.

async get_open_orders(pair: Optional[cryptocom.exchange.structs.Pair] = None, page: int = 0, page_size: int = 200) → List[cryptocom.exchange.structs.Order]

Return open orders.

async get_order(order_id: int) → cryptocom.exchange.structs.Order

Get order info.

async get_orders_history(pair: Optional[cryptocom.exchange.structs.Pair] = None, start_ts: Optional[int] = None, end_ts: Optional[int] = None, page: int = 0, page_size: int = 200) → List[cryptocom.exchange.structs.Order]

Return all history orders.

async get_trades(pair: Optional[cryptocom.exchange.structs.Pair] = None, start_ts: Optional[int] = None, end_ts: Optional[int] = None, page: int = 0, page_size: int = 200) → List[cryptocom.exchange.structs.PrivateTrade]

Return trades.

async get_withdrawal_history(coin: cryptocom.exchange.structs.Coin, start_ts: Optional[int] = None, end_ts: Optional[int] = None, status: Optional[cryptocom.exchange.structs.WithdrawalStatus] = None, page: int = 0, page_size: int = 20) → List[cryptocom.exchange.structs.Withdrawal]

Return all history for withdrawal transactions.

async sell_limit(pair: cryptocom.exchange.structs.Pair, quantity: float, price: float, force_type: Optional[cryptocom.exchange.structs.OrderForceType] = None, exec_type: Optional[cryptocom.exchange.structs.OrderExecType] = None, client_id: Optional[int] = None) → int

Sell limit order.

async sell_market(pair: cryptocom.exchange.structs.Pair, quantity: float, wait_for_fill=False) → int

Sell market order.

async wait_for_status(order_id: int, statuses, delay: int = 0.1) → None

Wait for order status.

exception cryptocom.exchange.ApiError

class cryptocom.exchange.ApiProvider(*, api_key='', api_secret='', from_env=False, auth_required=True, timeout=5, retries=6, root_url='https://api.crypto.com/v2/', ws_root_url='wss://stream.crypto.com/v2/', logger=None)

Provides HTTP-api requests and websocket requests.

class cryptocom.exchange.Candle(time: int, open: float, high: float, low: float, close: float, volume: float, pair: cryptocom.exchange.structs.Pair)

class cryptocom.exchange.Coin(exchange_name: str)

class cryptocom.exchange.Deposit(coin: cryptocom.exchange.structs.Coin, fee: float, create_time: int, id: str, update_time: int, amount: float, address: str, status: cryptocom.exchange.structs.DepositStatus)

class cryptocom.exchange.DepositStatus(value)

An enumeration.

class cryptocom.exchange.Exchange(api: Optional[cryptocom.exchange.api.ApiProvider] = None)

Interface to base exchange methods.

async get_orderbook(pair: cryptocom.exchange.structs.Pair) → cryptocom.exchange.structs.OrderBook

Get the order book for a particular market, depth always 150.

async get_pairs() → List[cryptocom.exchange.structs.Pair]

List all available market pairs and store to provide pairs info.

async get_price(pair: cryptocom.exchange.structs.Pair) → float

Get latest price of pair.

async get_ticker(pair: cryptocom.exchange.structs.Pair) → cryptocom.exchange.structs.MarketTicker

Get ticker in for provided pair.

async get_tickers() → Dict[cryptocom.exchange.structs.Pair, cryptocom.exchange.structs.MarketTicker]

Get tickers in all available markets.

async get_trades(pair: cryptocom.exchange.structs.Pair) → List[cryptocom.exchange.structs.MarketTrade]

Get last 200 trades in a specified market.

async sync_pairs()

Use this method to sync pairs if you have issues with missing pairs in library side.

class cryptocom.exchange.MarketTrade(id: int, time: int, price: float, quantity: float, side: cryptocom.exchange.structs.OrderSide, pair: cryptocom.exchange.structs.Pair)

class cryptocom.exchange.Order(id: int, status: cryptocom.exchange.structs.OrderStatus, side: cryptocom.exchange.structs.OrderSide, price: float, quantity: float, client_id: str, created_at: int, updated_at: int, type: cryptocom.exchange.structs.OrderType, pair: cryptocom.exchange.structs.Pair, filled_quantity: float, filled_price: float, fees_coin: cryptocom.exchange.structs.Coin, force_type: cryptocom.exchange.structs.OrderForceType, trigger_price: float, trades: List[cryptocom.exchange.structs.PrivateTrade])

class cryptocom.exchange.OrderSide(value)

An enumeration.

class cryptocom.exchange.OrderStatus(value)

An enumeration.

class cryptocom.exchange.OrderType(value)

An enumeration.

class cryptocom.exchange.Pair(exchange_name: str, price_precision: int, quantity_precision: int)

class cryptocom.exchange.Period(value)

An enumeration.

class cryptocom.exchange.PrivateTrade(id: int, side: cryptocom.exchange.structs.OrderSide, pair: cryptocom.exchange.structs.Pair, fees: float, fees_coin: cryptocom.exchange.structs.Coin, created_at: int, filled_price: float, filled_quantity: float, order_id: int)

class cryptocom.exchange.Timeframe(value)

An enumeration.

class cryptocom.exchange.Withdrawal(coin: cryptocom.exchange.structs.Coin, fee: float, create_time: int, id: str, update_time: int, amount: float, address: str, client_wid: str, status: cryptocom.exchange.structs.WithdrawalStatus, txid: str)

class cryptocom.exchange.WithdrawalStatus(value)

An enumeration.