python-kraken-sdk
Contents:
python-kraken-sdk
Getting Started
Command-line Interface
Usage Examples
Trading Bot Templates
Spot REST Clients
Spot Websockets
Futures REST Clients
Futures Websockets
Base Clients and Internals
Custom Exceptions
Known Issues
License
python-kraken-sdk
Index
Edit on GitHub
Index
Symbols
|
A
|
C
|
D
|
E
|
F
|
G
|
I
|
K
|
L
|
M
|
O
|
P
|
R
|
S
|
T
|
U
|
W
Symbols
--api-key
kraken-futures command line option
kraken-spot command line option
--data
kraken-futures command line option
kraken-spot command line option
--query
kraken-futures command line option
--secret-key
kraken-futures command line option
kraken-spot command line option
--timeout
kraken-futures command line option
kraken-spot command line option
--verbose
kraken command line option
--version
kraken command line option
-d
kraken-futures command line option
kraken-spot command line option
-q
kraken-futures command line option
-v
kraken command line option
-X
kraken-futures command line option
kraken-spot command line option
A
account_transfer() (kraken.spot.User method)
active_private_subscriptions (kraken.spot.SpotOrderBookClient property)
(kraken.spot.SpotWSClient property)
(kraken.spot.websocket.SpotWSClientBase property)
active_public_subscriptions (kraken.spot.SpotOrderBookClient property)
(kraken.spot.SpotWSClient property)
(kraken.spot.websocket.SpotWSClientBase property)
add_book() (kraken.spot.SpotOrderBookClient method)
add_note() (kraken.exceptions.KrakenApiLimitExceededError method)
(kraken.exceptions.KrakenAuthenticationError method)
(kraken.exceptions.KrakenAuthenticationFailedError method)
(kraken.exceptions.KrakenBadRequestError method)
(kraken.exceptions.KrakenCannotOpenPositionError method)
(kraken.exceptions.KrakenCostMinimumNotMetError method)
(kraken.exceptions.KrakenDeadlineElapsedError method)
(kraken.exceptions.KrakenInsufficientAvailableFundsError method)
(kraken.exceptions.KrakenInsufficientFundsError method)
(kraken.exceptions.KrakenInsufficientMarginError method)
(kraken.exceptions.KrakenInvalidAccountError method)
(kraken.exceptions.KrakenInvalidAmountError method)
(kraken.exceptions.KrakenInvalidAPIKeyError method)
(kraken.exceptions.KrakenInvalidArgumentsError method)
(kraken.exceptions.KrakenInvalidArgumentsIndexUnavailableError method)
(kraken.exceptions.KrakenInvalidNonceError method)
(kraken.exceptions.KrakenInvalidOrderError method)
(kraken.exceptions.KrakenInvalidPriceError method)
(kraken.exceptions.KrakenInvalidReferenceIdError method)
(kraken.exceptions.KrakenInvalidSignatureError method)
(kraken.exceptions.KrakenInvalidStakingMethodError method)
(kraken.exceptions.KrakenInvalidUnitError method)
(kraken.exceptions.KrakenMarginAllowedExceededError method)
(kraken.exceptions.KrakenMarginLevelToLowError method)
(kraken.exceptions.KrakenMarginPositionSizeExceededError method)
(kraken.exceptions.KrakenMarketInOnlyCancelModeError method)
(kraken.exceptions.KrakenMarketInOnlyPostModeError method)
(kraken.exceptions.KrakenMaxFeeExceededError method)
(kraken.exceptions.KrakenNotFoundError method)
(kraken.exceptions.KrakenOrderForEditNotFoundError method)
(kraken.exceptions.KrakenOrderLimitsExceededError method)
(kraken.exceptions.KrakenOrderMinimumNotMetError method)
(kraken.exceptions.KrakenPermissionDeniedError method)
(kraken.exceptions.KrakenPositionLimitExceededError method)
(kraken.exceptions.KrakenRateLimitExceededError method)
(kraken.exceptions.KrakenRequiredArgumentMissingError method)
(kraken.exceptions.KrakenServiceUnavailableError method)
(kraken.exceptions.KrakenTemporaryLockoutError method)
(kraken.exceptions.KrakenTickSizeInvalidCheckError method)
(kraken.exceptions.KrakenToManyAddressesError method)
(kraken.exceptions.KrakenUnavailableError method)
(kraken.exceptions.KrakenUnknownAssetError method)
(kraken.exceptions.KrakenUnknownAssetPairError method)
(kraken.exceptions.KrakenUnknownMethodError method)
(kraken.exceptions.KrakenUnknownOrderError method)
(kraken.exceptions.KrakenUnknownPositionError method)
(kraken.exceptions.KrakenUnknownReferenceIdError method)
(kraken.exceptions.KrakenUnknownWithdrawKeyError method)
(kraken.exceptions.MaxReconnectError method)
allocate_earn_funds() (kraken.spot.Earn method)
amend_order() (kraken.spot.Trade method)
async_close() (kraken.base_api.FuturesAsyncClient method)
(kraken.base_api.SpotAsyncClient method)
(kraken.futures.FuturesWSClient method)
(kraken.spot.SpotOrderBookClient method)
(kraken.spot.SpotWSClient method)
(kraken.spot.websocket.SpotWSClientBase method)
C
cancel_all_orders() (kraken.futures.Trade method)
(kraken.spot.Trade method)
cancel_all_orders_after_x() (kraken.spot.Trade method)
cancel_order() (kraken.futures.Trade method)
(kraken.spot.Trade method)
cancel_order_batch() (kraken.spot.Trade method)
cancel_withdraw() (kraken.spot.Funding method)
check_trading_enabled_on_subaccount() (kraken.futures.User method)
client (kraken.spot.websocket.connectors.ConnectSpotWebsocket property)
close() (kraken.base_api.FuturesAsyncClient method)
(kraken.base_api.SpotAsyncClient method)
(kraken.futures.FuturesWSClient method)
(kraken.spot.SpotOrderBookClient method)
(kraken.spot.SpotWSClient method)
(kraken.spot.websocket.SpotWSClientBase method)
close_connection() (kraken.spot.websocket.connectors.ConnectSpotWebsocket method)
ConnectSpotWebsocket (class in kraken.spot.websocket.connectors)
create_batch_order() (kraken.futures.Trade method)
create_order() (kraken.futures.Trade method)
(kraken.spot.Trade method)
create_order_batch() (kraken.spot.Trade method)
create_subaccount() (kraken.spot.User method)
D
dead_mans_switch() (kraken.futures.Trade method)
deallocate_earn_funds() (kraken.spot.Earn method)
delete_export_report() (kraken.spot.User method)
depth (kraken.spot.SpotOrderBookClient property)
E
Earn (class in kraken.spot)
edit_order() (kraken.futures.Trade method)
(kraken.spot.Trade method)
exception_occur (kraken.futures.FuturesWSClient property)
(kraken.spot.SpotOrderBookClient property)
(kraken.spot.SpotWSClient property)
(kraken.spot.websocket.SpotWSClientBase property)
F
Funding (class in kraken.futures)
(class in kraken.spot)
FuturesAsyncClient (class in kraken.base_api)
FuturesClient (class in kraken.base_api)
FuturesWSClient (class in kraken.futures)
G
get() (kraken.spot.SpotOrderBookClient method)
get_account_balance() (kraken.spot.User method)
get_account_log() (kraken.futures.User method)
get_account_log_csv() (kraken.futures.User method)
get_active_subscriptions() (kraken.futures.FuturesWSClient method)
get_allocation_status() (kraken.spot.Earn method)
get_asset_pairs() (kraken.spot.Market method)
get_assets() (kraken.spot.Market method)
get_available_private_subscription_feeds() (kraken.futures.FuturesWSClient static method)
get_available_public_subscription_feeds() (kraken.futures.FuturesWSClient static method)
get_balance() (kraken.spot.User method)
get_balances() (kraken.spot.User method)
get_closed_orders() (kraken.spot.User method)
get_deallocation_status() (kraken.spot.Earn method)
get_deposit_address() (kraken.spot.Funding method)
get_deposit_methods() (kraken.spot.Funding method)
get_execution_events() (kraken.futures.User method)
get_export_report_status() (kraken.spot.User method)
get_fee_schedules() (kraken.futures.Market method)
get_fee_schedules_vol() (kraken.futures.Market method)
get_fills() (kraken.futures.Trade method)
get_first() (kraken.spot.SpotOrderBookClient static method)
get_historical_funding_rates() (kraken.futures.Funding method)
(kraken.futures.Market method)
get_instruments() (kraken.futures.Market method)
get_instruments_status() (kraken.futures.Market method)
get_ledgers() (kraken.spot.User method)
get_ledgers_info() (kraken.spot.User method)
get_leverage_preference() (kraken.futures.Market method)
get_max_order_size() (kraken.futures.Trade method)
get_nonce() (kraken.base_api.FuturesAsyncClient method)
(kraken.base_api.FuturesClient method)
(kraken.base_api.SpotAsyncClient method)
(kraken.base_api.SpotClient method)
(kraken.futures.Funding method)
(kraken.futures.FuturesWSClient method)
(kraken.futures.Market method)
(kraken.futures.Trade method)
(kraken.futures.User method)
(kraken.spot.Earn method)
(kraken.spot.Funding method)
(kraken.spot.Market method)
(kraken.spot.SpotOrderBookClient method)
(kraken.spot.SpotWSClient method)
(kraken.spot.Trade method)
(kraken.spot.User method)
(kraken.spot.websocket.SpotWSClientBase method)
get_notifications() (kraken.futures.User method)
get_ohlc() (kraken.futures.Market method)
(kraken.spot.Market method)
get_open_orders() (kraken.futures.User method)
(kraken.spot.User method)
get_open_positions() (kraken.futures.User method)
(kraken.spot.User method)
get_order_amends() (kraken.spot.User method)
get_order_book() (kraken.spot.Market method)
get_order_events() (kraken.futures.User method)
get_orderbook() (kraken.futures.Market method)
get_orders_info() (kraken.spot.User method)
get_orders_status() (kraken.futures.Trade method)
get_pnl_preference() (kraken.futures.Market method)
get_public_execution_events() (kraken.futures.Market method)
get_public_mark_price_events() (kraken.futures.Market method)
get_public_order_events() (kraken.futures.Market method)
get_recent_deposits_status() (kraken.spot.Funding method)
get_recent_spreads() (kraken.spot.Market method)
get_recent_trades() (kraken.spot.Market method)
get_recent_withdraw_status() (kraken.spot.Funding method)
get_resolutions() (kraken.futures.Market method)
get_sign_challenge() (kraken.futures.FuturesWSClient method)
get_subaccounts() (kraken.futures.User method)
get_system_status() (kraken.spot.Market method)
get_tick_types() (kraken.futures.Market method)
get_ticker() (kraken.spot.Market method)
get_tickers() (kraken.futures.Market method)
get_trade_balance() (kraken.spot.User method)
get_trade_history() (kraken.futures.Market method)
get_trade_volume() (kraken.spot.User method)
get_tradeable_products() (kraken.futures.Market method)
get_trades_history() (kraken.spot.User method)
get_trades_info() (kraken.spot.User method)
get_trigger_events() (kraken.futures.User method)
get_unwind_queue() (kraken.futures.User method)
get_wallets() (kraken.futures.User method)
get_withdrawal_info() (kraken.spot.Funding method)
get_ws_token() (kraken.spot.SpotOrderBookClient method)
(kraken.spot.SpotWSClient method)
(kraken.spot.websocket.SpotWSClientBase method)
I
initiate_subaccount_transfer() (kraken.futures.Funding method)
initiate_wallet_transfer() (kraken.futures.Funding method)
initiate_withdrawal_to_spot_wallet() (kraken.futures.Funding method)
is_auth (kraken.futures.FuturesWSClient property)
(kraken.spot.websocket.connectors.ConnectSpotWebsocket property)
K
key (kraken.futures.FuturesWSClient property)
kraken command line option
--verbose
--version
-v
kraken-futures command line option
--api-key
--data
--query
--secret-key
--timeout
-d
-q
-X
URL
kraken-spot command line option
--api-key
--data
--secret-key
--timeout
-d
-X
URL
kraken.exceptions
module
KrakenApiLimitExceededError
KrakenAuthenticationError
KrakenAuthenticationFailedError
KrakenBadRequestError
KrakenCannotOpenPositionError
KrakenCostMinimumNotMetError
KrakenDeadlineElapsedError
KrakenInsufficientAvailableFundsError
KrakenInsufficientFundsError
KrakenInsufficientMarginError
KrakenInvalidAccountError
KrakenInvalidAmountError
KrakenInvalidAPIKeyError
KrakenInvalidArgumentsError
KrakenInvalidArgumentsIndexUnavailableError
KrakenInvalidNonceError
KrakenInvalidOrderError
KrakenInvalidPriceError
KrakenInvalidReferenceIdError
KrakenInvalidSignatureError
KrakenInvalidStakingMethodError
KrakenInvalidUnitError
KrakenMarginAllowedExceededError
KrakenMarginLevelToLowError
KrakenMarginPositionSizeExceededError
KrakenMarketInOnlyCancelModeError
KrakenMarketInOnlyPostModeError
KrakenMaxFeeExceededError
KrakenNotFoundError
KrakenOrderForEditNotFoundError
KrakenOrderLimitsExceededError
KrakenOrderMinimumNotMetError
KrakenPermissionDeniedError
KrakenPositionLimitExceededError
KrakenRateLimitExceededError
KrakenRequiredArgumentMissingError
KrakenServiceUnavailableError
KrakenTemporaryLockoutError
KrakenTickSizeInvalidCheckError
KrakenToManyAddressesError
KrakenUnavailableError
KrakenUnknownAssetError
KrakenUnknownAssetPairError
KrakenUnknownMethodError
KrakenUnknownOrderError
KrakenUnknownPositionError
KrakenUnknownReferenceIdError
KrakenUnknownWithdrawKeyError
L
list_earn_allocations() (kraken.spot.Earn method)
list_earn_strategies() (kraken.spot.Earn method)
M
Market (class in kraken.futures)
(class in kraken.spot)
MaxReconnectError
module
kraken.exceptions
O
on_book_update() (kraken.spot.SpotOrderBookClient method)
on_message() (kraken.futures.FuturesWSClient method)
(kraken.spot.SpotOrderBookClient method)
(kraken.spot.SpotWSClient method)
(kraken.spot.websocket.SpotWSClientBase method)
P
private_channel_names (kraken.spot.SpotOrderBookClient property)
(kraken.spot.SpotWSClient property)
(kraken.spot.websocket.SpotWSClientBase property)
private_methods (kraken.spot.SpotOrderBookClient property)
(kraken.spot.SpotWSClient property)
public_channel_names (kraken.spot.SpotOrderBookClient property)
(kraken.spot.SpotWSClient property)
(kraken.spot.websocket.SpotWSClientBase property)
R
remove_book() (kraken.spot.SpotOrderBookClient method)
request() (kraken.base_api.FuturesAsyncClient method)
(kraken.base_api.FuturesClient method)
(kraken.base_api.SpotAsyncClient method)
(kraken.base_api.SpotClient method)
(kraken.futures.Funding method)
(kraken.futures.FuturesWSClient method)
(kraken.futures.Market method)
(kraken.futures.Trade method)
(kraken.futures.User method)
(kraken.spot.Earn method)
(kraken.spot.Funding method)
(kraken.spot.Market method)
(kraken.spot.SpotOrderBookClient method)
(kraken.spot.SpotWSClient method)
(kraken.spot.Trade method)
(kraken.spot.User method)
(kraken.spot.websocket.SpotWSClientBase method)
request_export_report() (kraken.spot.User method)
retrieve_export() (kraken.spot.User method)
return_unique_id (kraken.base_api.SpotAsyncClient property)
(kraken.base_api.SpotClient property)
(kraken.spot.Earn property)
(kraken.spot.Funding property)
(kraken.spot.Market property)
(kraken.spot.SpotOrderBookClient property)
(kraken.spot.SpotWSClient property)
(kraken.spot.Trade property)
(kraken.spot.User property)
(kraken.spot.websocket.SpotWSClientBase property)
S
send_message() (kraken.spot.SpotOrderBookClient method)
(kraken.spot.SpotWSClient method)
(kraken.spot.websocket.SpotWSClientBase method)
send_ping() (kraken.spot.websocket.connectors.ConnectSpotWebsocket method)
set_leverage_preference() (kraken.futures.Market method)
set_pnl_preference() (kraken.futures.Market method)
set_trading_on_subaccount() (kraken.futures.User method)
SpotAsyncClient (class in kraken.base_api)
SpotClient (class in kraken.base_api)
SpotOrderBookClient (class in kraken.spot)
SpotWSClient (class in kraken.spot)
SpotWSClientBase (class in kraken.spot.websocket)
start() (kraken.futures.FuturesWSClient method)
(kraken.spot.SpotOrderBookClient method)
(kraken.spot.SpotWSClient method)
(kraken.spot.websocket.connectors.ConnectSpotWebsocket method)
(kraken.spot.websocket.SpotWSClientBase method)
stop() (kraken.futures.FuturesWSClient method)
(kraken.spot.SpotOrderBookClient method)
(kraken.spot.SpotWSClient method)
(kraken.spot.websocket.connectors.ConnectSpotWebsocket method)
(kraken.spot.websocket.SpotWSClientBase method)
subscribe() (kraken.futures.FuturesWSClient method)
(kraken.spot.SpotOrderBookClient method)
(kraken.spot.SpotWSClient method)
(kraken.spot.websocket.SpotWSClientBase method)
subscriptions (kraken.spot.websocket.connectors.ConnectSpotWebsocket property)
T
Trade (class in kraken.futures)
(class in kraken.spot)
truncate() (kraken.spot.Trade method)
U
unsubscribe() (kraken.futures.FuturesWSClient method)
(kraken.spot.SpotOrderBookClient method)
(kraken.spot.SpotWSClient method)
(kraken.spot.websocket.SpotWSClientBase method)
URL
kraken-futures command line option
kraken-spot command line option
User (class in kraken.futures)
(class in kraken.spot)
W
wallet_transfer() (kraken.spot.Funding method)
with_traceback() (kraken.exceptions.KrakenApiLimitExceededError method)
(kraken.exceptions.KrakenAuthenticationError method)
(kraken.exceptions.KrakenAuthenticationFailedError method)
(kraken.exceptions.KrakenBadRequestError method)
(kraken.exceptions.KrakenCannotOpenPositionError method)
(kraken.exceptions.KrakenCostMinimumNotMetError method)
(kraken.exceptions.KrakenDeadlineElapsedError method)
(kraken.exceptions.KrakenInsufficientAvailableFundsError method)
(kraken.exceptions.KrakenInsufficientFundsError method)
(kraken.exceptions.KrakenInsufficientMarginError method)
(kraken.exceptions.KrakenInvalidAccountError method)
(kraken.exceptions.KrakenInvalidAmountError method)
(kraken.exceptions.KrakenInvalidAPIKeyError method)
(kraken.exceptions.KrakenInvalidArgumentsError method)
(kraken.exceptions.KrakenInvalidArgumentsIndexUnavailableError method)
(kraken.exceptions.KrakenInvalidNonceError method)
(kraken.exceptions.KrakenInvalidOrderError method)
(kraken.exceptions.KrakenInvalidPriceError method)
(kraken.exceptions.KrakenInvalidReferenceIdError method)
(kraken.exceptions.KrakenInvalidSignatureError method)
(kraken.exceptions.KrakenInvalidStakingMethodError method)
(kraken.exceptions.KrakenInvalidUnitError method)
(kraken.exceptions.KrakenMarginAllowedExceededError method)
(kraken.exceptions.KrakenMarginLevelToLowError method)
(kraken.exceptions.KrakenMarginPositionSizeExceededError method)
(kraken.exceptions.KrakenMarketInOnlyCancelModeError method)
(kraken.exceptions.KrakenMarketInOnlyPostModeError method)
(kraken.exceptions.KrakenMaxFeeExceededError method)
(kraken.exceptions.KrakenNotFoundError method)
(kraken.exceptions.KrakenOrderForEditNotFoundError method)
(kraken.exceptions.KrakenOrderLimitsExceededError method)
(kraken.exceptions.KrakenOrderMinimumNotMetError method)
(kraken.exceptions.KrakenPermissionDeniedError method)
(kraken.exceptions.KrakenPositionLimitExceededError method)
(kraken.exceptions.KrakenRateLimitExceededError method)
(kraken.exceptions.KrakenRequiredArgumentMissingError method)
(kraken.exceptions.KrakenServiceUnavailableError method)
(kraken.exceptions.KrakenTemporaryLockoutError method)
(kraken.exceptions.KrakenTickSizeInvalidCheckError method)
(kraken.exceptions.KrakenToManyAddressesError method)
(kraken.exceptions.KrakenUnavailableError method)
(kraken.exceptions.KrakenUnknownAssetError method)
(kraken.exceptions.KrakenUnknownAssetPairError method)
(kraken.exceptions.KrakenUnknownMethodError method)
(kraken.exceptions.KrakenUnknownOrderError method)
(kraken.exceptions.KrakenUnknownPositionError method)
(kraken.exceptions.KrakenUnknownReferenceIdError method)
(kraken.exceptions.KrakenUnknownWithdrawKeyError method)
(kraken.exceptions.MaxReconnectError method)
withdraw_addresses() (kraken.spot.Funding method)
withdraw_funds() (kraken.spot.Funding method)
withdraw_methods() (kraken.spot.Funding method)