krakenexapi.api

Raw API

class krakenexapi.api.RawKrakenExAPI(key: Optional[str] = None, secret: Optional[str] = None)

Bases: object

Raw Kraken Exchange API adspter.

api_domain = 'https://api.kraken.com'

load_key(path: Optional[os.PathLike] = None)

nonce() → int

_query_raw(path: str, data: Dict[str, Any], headers: Dict[str, Any], timeout: Optional[Tuple[int, float]] = None) → Dict[str, Any]

_sign(api_path: str, data: Dict[str, Any]) → str

query_public(method: str, **kwargs) → Dict[str, Any]

query_private(method: str, otp: Optional[str] = None, **kwargs) → Dict[str, Any]

krakenexapi.api.NONCE_OFFSET = -1577836800.0

Nonce value offset, nonce value will start from year 2020

krakenexapi.api.API_METHODS_PUBLIC = ['Time', 'SystemStatus', 'Assets', 'AssetPairs', 'Ticker', 'OHLC', 'Depth', 'Trades', 'Spread']

List of allowed public endpoints

krakenexapi.api.API_METHODS_PRIVATE = ['Balance', 'TradeBalance', 'TradeVolume', 'DepositMethods', 'DepositAddresses', 'DepositStatus', 'WithdrawInfo', 'Withdraw', 'WithdrawCancel', 'WithdrawStatus', 'WalletTransfer', 'OpenOrders', 'QueryOrders', 'OpenPositions', 'ClosedOrders', 'QueryOrders', 'QueryTrades', 'TradesHistory', 'AddOrder', 'CancelOrder', 'Ledgers', 'QueryLedgers', 'AddExport', 'RetrieveExport', 'ExportStatus', 'RemoveExport']

List of allowed private endpoints

Notes

The nonce() will use an offset of NONCE_OFFSET for its value - so, the nonce value is comparatively smaller compared to the standard unix timestamp. Try to avoid using the same API key for different applications!

Basic Kraken Exchange API methods

Wraps the endpoints in API_METHODS_PUBLIC and API_METHODS_PRIVATE with simplified parameters and corrected return values. It will try to call rate limit both public and, when provided a tier (verification level), private API endpoints to avoid possible blacklisting. The full description of methods, parameters and return values csn be found in the Official Kraken REST API.

class krakenexapi.api.BasicKrakenExAPI(key: Optional[str] = None, secret: Optional[str] = None, tier: Optional[str] = None)

Bases: krakenexapi.api.BasicKrakenExAPIPublicMethods, krakenexapi.api.BasicKrakenExAPIPrivateUserDataMethods, krakenexapi.api.BasicKrakenExAPIPrivateUserTradingMethods, krakenexapi.api.BasicKrakenExAPIPrivateUserFundingMethods, krakenexapi.api.RawKrakenExAPI

_query_raw(path: str, data: Dict[str, Any], headers: Dict[str, Any], timeout: Optional[Tuple[int, float]] = None) → Dict[str, Any]

Public Endpoints

class krakenexapi.api.BasicKrakenExAPIPublicMethods

_get_server_time() → Dict[str, Any]

get_server_time() → datetime.datetime

get_system_status()

get_asset_info(asset: Optional[Union[str, List[str]]] = None) → Dict[str, Dict[str, Any]]

_get_asset_pairs(pair: Optional[Union[str, List[str]]] = None, info: Optional[str] = None) → Dict[str, Dict[str, Any]]

_get_asset_pairs_static_values() → Dict[str, Union[int, float, str]]

get_asset_pairs(pair: Optional[Union[str, List[str]]] = None, info: Optional[str] = None) → Dict[str, Dict[str, Any]]

_get_ticker_information(pair: Union[str, List[str]]) → Dict[str, Dict[str, Any]]

get_ticker_information(pair: Union[str, List[str]]) → Dict[str, Dict[str, Any]]

_get_ohlc_data(pair: str, interval: Optional[int] = None, since: Optional[int] = None) → Tuple[List[List[Any]], int]

get_ohlc_data(pair: str, interval: Optional[int] = None, since: Optional[int] = None) → Tuple[List[List[Any]], int]

_get_order_book(pair: str, count: Optional[int] = None) → Tuple[List, List]

get_order_book(pair: str, count: Optional[int] = None) → Tuple[List, List]

_get_recent_trades(pair: str, since: Optional[int] = None) → Tuple[List[List[Any]], int]

get_recent_trades(pair: str, since: Optional[int] = None) → Tuple[List[List[Any]], int]

_get_recent_spread_data(pair: str, since: Optional[int] = None) → Tuple[List[List[Any]], int]

get_recent_spread_data(pair: str, since: Optional[int] = None) → Tuple[List[List[Any]], int]

Private Endpoints

class krakenexapi.api.BasicKrakenExAPIPrivateUserDataMethods

get_account_balance() → Dict[str, float]

get_trade_balance(asset: Optional[str] = None) → Dict[str, float]

get_open_orders(trades: Optional[bool] = None, userref: Optional[str] = None) → Dict[str, Dict[str, Any]]

get_closed_orders(trades: Optional[bool] = None, userref: Optional[str] = None, start: Optional[Union[int, str]] = None, end: Optional[Union[int, str]] = None, offset: Optional[int] = None, closetime: Optional[str] = None) → Tuple[Dict[str, Dict[str, Any]], int]

get_orders_info(txid: Union[str, List[str]], trades: Optional[bool] = None, userref: Optional[str] = None) → Dict[str, Dict[str, Any]]

get_trades_history(type: Optional[str] = None, trades: Optional[bool] = None, start: Optional[Union[int, str]] = None, end: Optional[Union[int, str]] = None, offset: Optional[int] = None) → Tuple[Dict[str, Dict[str, Any]], int]

get_trades_info(txid: Union[str, List[str]], trades: Optional[bool] = None) → Dict[str, Dict[str, Any]]

get_open_positions(txid: Union[str, List[str]], docalcs: Optional[bool] = None, trades: Optional[bool] = None, consolidation: Optional[str] = None) → Dict[str, Dict[str, Any]]

get_ledgers_info(asset: Optional[Union[str, List[str]]] = None, type: Optional[str] = None, start: Optional[Union[int, str]] = None, end: Optional[Union[int, str]] = None, offset: Optional[int] = None) → Tuple[Dict[str, Dict[str, Any]], int]

get_ledgers(lid: Union[str, List[str]]) → Dict[str, Dict[str, Any]]

get_trade_volume(pair: Optional[Union[str, List[str]]] = None, fee_info: Optional[bool] = None) → Dict[str, Any]

class krakenexapi.api.BasicKrakenExAPIPrivateUserTradingMethods

class krakenexapi.api.BasicKrakenExAPIPrivateUserFundingMethods

Call Rate Limiting

The Kraken Exchange used different quotas for its API methods, see the article What are the API rate limits?.

class krakenexapi.api._CallRateLimitInfo(limit: float = 1, cost: float = 1, decay: float = 1.0)

decay()

time_to_call(cost: float) → float

can_call(cost: Optional[Union[int, float]] = None) → bool

check(cost: Optional[Union[int, float]] = None) → bool

check_and_wait(cost: Optional[Union[int, float]] = None)

class krakenexapi.api.KrakenExAPICallRateLimiter(tier: Optional[str] = None)

_reset_account_crl()

static _is_private(method: str)

static _get_cost(method: str) → int

check_call(method: str, wait: bool = True) → bool

Exceptions

exception krakenexapi.api.KrakenExAPIError

Bases: Exception

Generic error

exception krakenexapi.api.NoPrivateKey

Bases: krakenexapi.api.KrakenExAPIError

Thrown if trying to use a private Kraken Exchange API without a private key.

exception krakenexapi.api.NoSuchAPIMethod

Bases: krakenexapi.api.KrakenExAPIError

Error thrown if trying to use an invalid API method.