Kraken API reference
Classes
Interfaces
- CustodyActivity
- CustodyActivityDetails
- CustodyApiError
- CustodyAssetBalance
- CustodyDepositAddress
- CustodyDepositAddressesParams
- CustodyDepositAddressesResponse
- CustodyDepositMethod
- CustodyDepositMethodsParams
- CustodyDepositMethodsResponse
- CustodyGetActivityResponse
- CustodyGetTaskResponse
- CustodyGetTransactionParams
- CustodyGetTransactionResponse
- CustodyGetVaultResponse
- CustodyListActivitiesParams
- CustodyListActivitiesResponse
- CustodyListTasksParams
- CustodyListTasksResponse
- CustodyListTransactionsParams
- CustodyListTransactionsResponse
- CustodyListVaultsParams
- CustodyListVaultsResponse
- CustodyQuoteAsset
- CustodyTask
- CustodyTaskDetails
- CustodyTaskFilterOr
- CustodyTaskFilters
- CustodyTaskOrdering
- CustodyTaskReviewerStatistics
- CustodyTaskUser
- CustodyTransaction
- CustodyTransactionAmount
- CustodyTransactionAssetFilter
- CustodyTransactionRefIdFilter
- CustodyTransactionSide
- CustodyTransactionSorting
- CustodyTransactionStats
- CustodyVault
- CustodyVaultAssetDetail
- CustodyVaultFilterCreatedAtEquals
- CustodyVaultFilterCreatedAtIn
- CustodyVaultFilterDefaultApprovalsEquals
- CustodyVaultFilterDefaultApprovalsIn
- CustodyVaultFilterIdEquals
- CustodyVaultFilterMemberEquals
- CustodyVaultFilterNameContains
- CustodyVaultFilterNameEquals
- CustodyVaultFilterNameStartsWith
- CustodyVaultFilterUpdatedAtEquals
- CustodyVaultFilterUpdatedAtIn
- CustodyVaultWithAssets
- CustodyWithdrawAddress
- CustodyWithdrawAddressesParams
- CustodyWithdrawAddressesResponse
- CustodyWithdrawMethod
- CustodyWithdrawMethodFee
- CustodyWithdrawMethodLimit
- CustodyWithdrawMethodLimitInfo
- CustodyWithdrawMethodsParams
- CustodyWithdrawMethodsResponse
- DerivativesAPIErrorResponse
- FuturesAccountLog
- FuturesAccountLogEntry
- FuturesAccounts
- FuturesAddAssignmentPreferenceParams
- FuturesAnalyticsError
- FuturesAnalyticsResponse
- FuturesApiKeyV3Check
- FuturesAssignmentProgram
- FuturesAssignmentProgramHistory
- FuturesAssignmentProgramParticipant
- FuturesBatchOrderCancel
- FuturesBatchOrderEdit
- FuturesBatchOrderParams
- FuturesBatchOrderSend
- FuturesBatchOrderStatus
- FuturesCancelAllOrdersStatus
- FuturesCancelEvent
- FuturesCancelledOrder
- FuturesCancelOrderParams
- FuturesCancelOrderStatus
- FuturesCancelTriggerEvent
- FuturesCandle
- FuturesCandles
- FuturesCashAccount
- FuturesDeadMansSwitchStatus
- FuturesEditEvent
- FuturesEditOrderParams
- FuturesEditOrderStatus
- FuturesExecuteEvent
- FuturesFeeSchedule
FuturesFeeTier- FuturesFill
- FuturesFlexAccount
- FuturesFlexCurrencySummary
- FuturesGetAccountLogParams
- FuturesGetAnalyticsParams
- FuturesGetCandlesParams
- FuturesGetOrderEventsParams
- FuturesGetPositionEventsParams
- FuturesGetTriggerEventsParams
- FuturesHistoricalFundingRate
- FuturesHistoryBaseParams
- FuturesHistoryEventElement
- FuturesHistoryResponse
- FuturesHoldingAccount
- FuturesInitiateSubaccountTransferParams
- FuturesInitiateWalletTransferParams
- FuturesInstrument
- FuturesInstrumentStatus
- FuturesLeveragePreference
- FuturesMarginAccount
- FuturesMarginLevel
- FuturesMarginSchedule
- FuturesMarketHistoryBaseParams
- FuturesMarketHistoryEventElement
- FuturesMarketHistoryResponse
- FuturesMarketShare
- FuturesMarketShareContract
- FuturesNotification
- FuturesOpenOffer
- FuturesOpenOrder
- FuturesOpenPosition
- FuturesOptionGreeks
- FuturesOptionsUserLimitsPerBaseCurrency
- FuturesOrderBook
- FuturesOrderJson
- FuturesOrderStatusInfo
- FuturesOrderTriggerJson
- FuturesPlaceEvent
- FuturesPlaceTriggerEvent
- FuturesPnlPreference
- FuturesPortfolioMarginBreakdown
- FuturesPortfolioMarginParameters
- FuturesPortfolioSimulation
- FuturesPositionUpdateEvent
- FuturesPublicMarkPriceEvent
- FuturesRejectEvent
- FuturesRejectTriggerEvent
- FuturesRfq
- FuturesRfqLeg
- FuturesSendOrderParams
- FuturesSendOrderStatus
- FuturesSetRfqAssignmentMaxLeverageParams
- FuturesSingleCollateralAccount
- FuturesSubaccount
- FuturesSubaccountFlexAccount
- FuturesSubaccountFlexCurrency
- FuturesSubaccountsInfo
- FuturesSubmitToSpotParams
- FuturesTicker
- FuturesTradeHistoryItem
- FuturesTriggerOptions
- FuturesUnwindQueuePosition
- FuturesUpdateSelfTradeStrategyParams
- GenericAPIError
- MessageEventLike
- OauthCreateFastApiKeyParams
- OauthCreateFastApiKeyResponse
- OauthFastApiKey
- OauthGetAccessTokenParams
- OauthGetAccessTokenResponse
- OauthGetUserInfoResponse
- OauthUpdateFastApiKeyParams
- OtcActiveQuote
- OTCCheckClientResponse
- OTCCreateQuoteRequestParams
- OTCCreateQuoteResponse
- OtcExposures
- OTCGetActiveQuotesResponse
- OTCGetExposuresResponse
- OTCGetHistoricalQuotesResponse
- OTCGetPairsResponse
- OtcHistoricalQuote
- OtcPair
- OtcQuote
- OTCUpdateQuoteParams
- OTCUpdateQuoteResponse
- PartnerCancelCustomOrderParams
- PartnerCancelCustomOrderResponse
- PartnerCreateCustomOrderParams
- PartnerCreateCustomOrderResponse
- PartnerCreateUserParams
- PartnerCreateUserResponse
- PartnerCustomOrder
- PartnerCustomOrderAction
- PartnerCustomOrderPriceTrigger
- PartnerExecuteQuoteParams
- PartnerExecuteQuoteResponse
- PartnerGetAssetParams
- PartnerGetAssetResponse
- PartnerGetCustomOrderParams
- PartnerGetCustomOrderResponse
- PartnerGetEarnSummaryParams
- PartnerGetEarnSummaryResponse
- PartnerGetPortfolioHistoryParams
- PartnerGetPortfolioHistoryResponse
- PartnerGetPortfolioSummaryParams
- PartnerGetPortfolioSummaryResponse
- PartnerGetQuoteLimitsParams
- PartnerGetQuoteLimitsResponse
- PartnerGetQuoteParams
- PartnerGetQuoteResponse
- PartnerGetRampCheckoutUrlParams
- PartnerGetRampCheckoutUrlResponse
- PartnerGetRampLimitsParams
- PartnerGetRampLimitsResponse
- PartnerGetRampProspectiveQuoteParams
- PartnerGetRampProspectiveQuoteResponse
- PartnerGetSettlementReportParams
- PartnerGetSettlementReportResponse
- PartnerGetUserResponse
- PartnerListAssetRatesParams
- PartnerListAssetRatesResponse
- PartnerListAssetsParams
- PartnerListAssetsResponse
- PartnerListCustomOrdersParams
- PartnerListCustomOrdersResponse
- PartnerListEarnAssetsParams
- PartnerListEarnAssetsResponse
- PartnerListFundingTransactionsParams
- PartnerListFundingTransactionsResponse
- PartnerListPortfolioDetailsParams
- PartnerListPortfolioDetailsResponse
- PartnerListPortfolioTransactionsParams
- PartnerListPortfolioTransactionsResponse
- PartnerListRampBuyCryptoAssetsResponse
- PartnerListRampCountriesResponse
- PartnerListRampFiatCurrenciesResponse
- PartnerListRampPaymentMethodsResponse
- PartnerListSettlementReportsParams
- PartnerListSettlementReportsResponse
- PartnerProspectiveQuoteBreakdown
- PartnerProspectiveQuoteUnitPrice
- PartnerQuoteLimitAmount
- PartnerRequestProspectiveQuoteParams
- PartnerRequestProspectiveQuoteResponse
- PartnerRequestQuoteParams
- PartnerRequestQuoteResponse
- PartnerSubmitVerificationParams
- PartnerSubmitVerificationResponse
- PartnerToggleAutoEarnParams
- PartnerToggleAutoEarnResponse
- PartnerUpdateUserParams
- PartnerUpdateUserResponse
- PartnerWithdrawFundsParams
- PartnerWithdrawFundsResponse
- SpotAccountBalance
- SpotAccountTransferParams
- SpotAccountTransferResponse
- SpotAddOrderDescription
- SpotAlgoStrategy
- SpotAmendOrderParams
- SpotAPIErrorResponse
- SpotApiKeyInfo
- SpotAssetInfo
- SpotAssetPair
- SpotAssetTickerInfo
- SpotBatchOrderItem
- SpotBatchOrderResult
- SpotClosedOrder
- SpotClosedOrdersResponse
- SpotClosedStrategiesResponse
- SpotConsolidatedOpenPosition
- SpotCreditLines
- SpotCreditLinesAsset
- SpotCreditLinesMonitor
- SpotDeleteExportReportResponse
- SpotDepositAddress
- SpotDepositMethod
- SpotDepositStatus
- SpotDepositStatusResponse
- SpotEarnAllocation
- SpotEarnAllocationDetails
- SpotEarnAllocationState
- SpotEarnAmount
- SpotEarnAPREstimate
- SpotEarnAutoCompound
- SpotEarnLockType
- SpotEarnPayout
- SpotEarnStrategy
- SpotEarnYieldSource
- SpotEmergencyEvent
- SpotEmergencyNextStep
- SpotExportReportStatus
- SpotExtendedBalance
- SpotExtendedBalanceAsset
- SpotFeeTierInfo
- SpotGetAccountBalanceParams
- SpotGetApiKeyInfoParams
- SpotGetAssetPairsParams
- SpotGetClosedOrdersParams
- SpotGetClosedStrategiesParams
- SpotGetDepositAddressesParams
- SpotGetDepositMethodsParams
- SpotGetDepositStatusParams
- SpotGetGroupedBookParams
- SpotGetLedgersInfoParams
- SpotGetLevel3Params
- SpotGetOHLCParams
- SpotGetOpenOrdersParams
- SpotGetOpenPositionsParams
- SpotGetOrderBookParams
- SpotGetPostTradeDataParams
- SpotGetRecentSpreadsParams
- SpotGetRecentTradesParams
- SpotGetTradesHistoryParams
- SpotGetTradingVolumeParams
- SpotGetWithdrawalAddressesParams
- SpotGetWithdrawalInfoParams
- SpotGetWithdrawalMethodsParams
- SpotGetWithdrawalsStatusParams
- SpotGroupedBookLevel
- SpotGroupedBookResponse
- SpotLedgerEntry
- SpotLedgersInfoResponse
- SpotLevel3OrderBookResponse
- SpotLevel3OrderEntry
- SpotListEarnAllocationsParams
- SpotListEarnAllocationsResponse
- SpotListEarnStrategiesParams
- SpotListWalletAccountsResponse
- SpotMaintenanceSchedule
- SpotOHLCResponse
- SpotOpenOrder
- SpotOpenOrderDescription
- SpotOpenOrdersResponse
- SpotOpenPosition
- SpotOpenPositionsResponse
- SpotOrderAmend
- SpotOrderAmendsResponse
- SpotOrderBook
- SpotOrderBookResponse
- SpotPageCursor
- SpotPostTrade
- SpotPostTradeDataResponse
- SpotPreTradeData
- SpotPreTradeLevel
- SpotQueryLedgerEntry
- SpotQueryLedgersParams
- SpotQueryLedgersResponse
- SpotQueryOrdersParams
- SpotQueryOrdersResponse
- SpotQueryTradesParams
- SpotQueryTradesResponse
- SpotRecentSpreadsResponse
- SpotRecentTradesResponse
- SpotRequestExportReportParams
- SpotRequestExportReportResponse
- SpotScheduledMaintenanceEvent
- SpotSubmitOrderBatchParams
- SpotSubmitOrderParams
- SpotSubmitOrderResponse
- SpotSubmitStrategyParams
- SpotSystemStatus
- SpotTrade
- SpotTradeBalance
- SpotTradesHistoryResponse
- SpotTradeVolume
- SpotTradeVolumeFeeSchedule
- SpotTradeVolumeFeeScheduleTier
- SpotTradeVolumeInputs
- SpotTradeVolumePairInput
- SpotTradeVolumeSubaccount
- SpotTwapStrategyInfo
- SpotWalletAccount
- SpotWalletAccountFlags
- SpotWalletTransferParams
- SpotWebSocketsTokenResponse
- SpotWithdrawalAddress
- SpotWithdrawalInfo
- SpotWithdrawalMethod
- SpotWithdrawalStatus
- SpotWithdrawFundsParams
- TickerGreeks
- VaultFilterOr
- VaultFilters
- VaultOrdering
- VaultPagination
- WebsocketClientOptions
- WSAPIAddSpotOrderParams
- WSAPIAddSpotOrderResult
- WSAPIAmendSpotOrderParams
- WSAPIAmendSpotOrderResult
- WSAPIAuthenticationConfirmedFromServer
- WSAPIAuthenticationRequestFromServer
- WSAPIBatchAddSpotOrdersParams
- WSAPIBatchAddSpotOrdersResult
- WSAPIBatchCancelSpotOrdersParams
- WSAPIBatchCancelSpotOrdersResult
- WSAPICancelAllSpotOrdersAfterParams
- WSAPICancelAllSpotOrdersAfterResult
- WSAPICancelAllSpotOrdersResult
- WSAPICancelSpotOrderParams
- WSAPICancelSpotOrderResult
- WSAPIClientConfigurableOptions
- WSAPIEditSpotOrderParams
- WSAPIEditSpotOrderResult
- WSAPIRequestFlags
- WSAPIRequestOperationKrakenSpot
- WSAPISpotResponse
- WSAPITopicRequestParamMap
- WSAPITopicResponseMap
- WSAPIWsKeyTopicMap
- WSClientConfigurableOptions
- WsConnectionInfo
- WsDataEvent
- WSDerivativesPublicBookParams
- WsRequestOperation
- WSRequestOperationKraken
- WsServerInfo
- WSSpotBalancesSubscribeParams
- WSSpotEmergency
- WSSpotExecutionsSubscribeParams
- WSSpotInstrumentSubscribeParams
- WSSpotPublicBookParams
- WSSpotStatusData
- WSSpotStatusEvent
- WSSpotStatusNextStep
- WSSpotUpcomingMaintenance
- WSSpotV1SystemStatus
- WSTopicRequest
Type Aliases
- CustodyActivityAction
- CustodyAssetClass
- CustodyCaseMatching
- CustodyOrderDirection
- CustodyRefIdType
- CustodyTaskAction
- CustodyTaskFilterCondition
- CustodyTaskOrderBy
- CustodyTaskScope
- CustodyTaskState
- CustodyTaskStateReq
- CustodyTaskUserDecision
- CustodyTaskUserDecisionReq
- CustodyTransactionArea
- CustodyTransactionAssetClass
- CustodyTransactionAssetClassReq
- CustodyTransactionCategory
- CustodyTransactionResultType
- CustodyTransactionStatus
- CustodyTransactionType
- CustodyTransactionTypeReq
- CustodyUserRole
- CustodyVaultFilterBy
- CustodyVaultFilterCondition
- CustodyVaultOrderBy
- CustodyVaultStatus
- CustodyWithdrawAddressAssetClass
- DefaultLogger
- DerivativesAPIResponse
- DerivativesAPISuccessResponse
- Exact
- FuturesAnalyticsType
- FuturesApiKeyV3AccessLevel
- FuturesHistoryExecutionEvent
- FuturesHistoryOrderEvent
- FuturesHistoryTriggerEvent
- FuturesOrderEvent
- FuturesPublicExecutionEvent
- FuturesPublicOrderEvent
- FuturesResolution
- FuturesSelfTradeStrategy
- FuturesTickType
- LogParams
- OtcQuoteStatus
- OtcQuoteType
- OtcSettlement
- SpotAffectedService
- SpotAPIResponse
- SpotAPISuccessResponse
- SpotMaintenanceOrderSubmission
- SpotMaintenancePhase
- SpotMaintenanceRecommendedAction
- SpotOHLCData
- SpotOpenPositionsResult
- SpotOrderBookEntry
- SpotSpreadData
- SpotTradeData
- WSAPIOperation
- WSAPIWsKey
- WSDerivativesPrivateTopic
- WSDerivativesPublicTopic
- WSDerivativesTopic
- WsEventInternalSrc
- WsKey
- WsMarket
- WSOperation
- WSPublicBookParams
- WSSpotAffectedService
- WSSpotMaintenancePhase
- WSSpotPrivateTopic
- WSSpotPublicTopic
- WSSpotTopic
- WSTopic
- WSTopicRequestOrStringTopic
Variables
- DefaultLogger
- WS_API_Operations
- WS_DERIVATIVES_PRIVATE_TOPICS
- WS_DERIVATIVES_PUBLIC_TOPICS
- WS_KEY_MAP
- WS_SPOT_PRIVATE_TOPICS
- WS_SPOT_PUBLIC_TOPICS