Module response_types

REST response types

Structs

• AccountTransfer
  Response type for a transfer to a linked Futures account
• AddOrder
  Response type for AddOrder
• AddOrderBatch
  Response type for AddOrderBatch
• AddOrderDescription
  English description of an added order and closing order instruction (if given)
• Allocation
  Description of assets allocated to a strategy
• AllocationState
  State of a single allocation to a strategy
• AllocationStatus
  Response type for AllocateStatus
• AmendOrder
• AmountAllocated
  Details of an allocation to a particular strategy
• AprEstimate
  Bracketed estimate for a strategy’s APR
• AssetInfo
  Asset details (e.g. for ETH, USDC, BTC, etc)
• AutoCompound
  Wrapper type for compounding nature of a strategy
• BatchedOrder
  Description of an added batch order, including potential error value.
• BidAsk
  Bid or Ask
• BondingDetail
  Details of an earn strategy’s commitments and rewards
• CancelAllOrdersAfter
  Response for CancelAllOrdersAfter
• CancelOrder
  Response for CancelOrder
• ClosedOrder
  Order object for closed orders
• ClosedOrders
  Response type for mapping order ids to orders
• ConfirmationRefId
  Response type containing only a ref id for confirmation
• DeleteExportReport
  Response type for deleting an export report
• DepositAddress
  Description of a deposit address
• DepositMethod
  Description of a deposit method
• DepositWithdrawal
  Description of a deposit or withdrawal
• DepositWithdrawalCursor
  Cursor response that wraps a deposit
• EarnAllocation
  Description of an allocation to an earn strategy
• EarnAllocations
  Response type for Earn/Allocations
• EarnAmount
  Amount earned by an allocation in the requested and native assets
• EarnStrategies
  Paginated response type for /Earn/Strategies
• EarnStrategy
  Description of an individual earn strategy
• ExportReport
  Response type for ExportReport
• ExportReportStatus
  Description of an export report
• ExtendedBalance
  Detailed balance data, including holds and credit (if available)
• FeeByVolume
  Tiered fee description
• Fees
  Description of fee tier
• LastTrade
  Price and volume for the most recent trade
• LedgerEntry
  Entry in the user’s ledger
• LedgerInfo
  Response type for Ledgers and QueryLedgers
• LockTypeDetail
  Details of how funds are locked by an earn strategy
• OHLC
  Candlestick data for the given interval
• OhlcResponse
  OHLC data by pair
• OpenOrders
  Wrapper to map open orders by Kraken ref-id
• OpenPosition
  Details of an open margin position
• Order
  Order object for OpenOrders and QueryOrders
• OrderAmend
• OrderAmends
• OrderDescription
  Details of individual order
• OrderEdit
  Response type for an edited order
• Orderbook
  Orderbook containing some depth of bids and asks
• Payout
  Description of the payout for a particular allocation
• RecentSpreads
  Spreads for one or many assets
• RecentTrade
  A public trade
• RecentTrades
  Wrapper type for recent trade response
• RestTickerBidAsk
  Best bid or ask
• RestTickerInfo
  Complete ticker information for an asset
• Spread
  Bid-ask spread at a given time
• SystemStatusInfo
  Kraken server status, including an RFC3339 timestamp.
• SystemTime
  Kraken server time given in both unix timestamp and RFC1123
• TickerBidAsk
  Best bid or ask
• TickerDecimal
  Ticker helper type to serve differently typed data for the last 24 hours.
• TickerTrades
  Ticker containing trade count data for the last 24 hours
• TradableAssetPair
  Trading pair details, including all necessary details for formatting orders
• Trade
  A private trade
• TradeBalances
  Detailed margin balance data
• TradeVolume
  Response type for TradeVolume
• TradesHistory
  Response type for user’s trade history
• WebsocketToken
  Response type for GetWebSocketsToken
• WithdrawMethod
  Description of a withdrawal method
• Withdrawal
  Description of a withdrawal
• WithdrawalAddress
  Description of a withdrawal method
• YieldSource
  Wrapper type for the origin of rewards from a strategy

Enums

• AccountTransferStatus
  Status of a transfer between accounts
• AmendType
  The type of Order Amend
• AssetStatus
  Status for an asset (e.g. ETH, ATOM, USDC)
• AutoCompoundType
  Type of compounding for a given strategy
• BidOrAsk
  Whether a given BidAsk is a Bid or an Ask
• BoolOrString
  Wrapper type for odd responses that contain either a bool or a String
• BuySell
  Order side
• BuySellChar
  Single-character enum for buy and sell
• DepositWithdrawResponse
  Response type for status of a deposit or withdrawal
• EarnFee
  Wrapper type for loose typing of allocation/earn fees
• ExportReportStatusType
  Status of a requested export report
• LedgerEntryType
  Type of ledger entry in user’s ledger
• LockType
  Type of asset lock-up for a given earn strategy
• MarketLimitChar
  Single-character enum for market and limit orders
• OrderEditStatus
  Status of an edit requested for an order
• OrderFlag
  Flags that can be applied to order requests.
• OrderStatus
  Status of an order
• OrderStatusV2
  Status of an order
• OrderType
  Order type, e.g. Market, Limit, StopLossLimit
• PositionStatus
  Status of a position
• PositionStatusV2
  Status of a position
• StatusProp
  Additional status properties about a deposit or withdrawal
• SystemStatus
  Status of the exchange
• TradableAssetStatus
  Status of a given asset pair for trading (e.g. BTC-USD, ATOM-USD)
• TradeType
  Trade type, separate from OrderType due to different serialization semantics
• TransferStatus
  Status of a requested transfer
• VerificationTier
  A user’s level of KYC verification with Kraken
• YieldSourceType
  Source of yield for a given earn strategy

Type Aliases

• AccountBalances
  Convenience type for asset: amount balances
• ExtendedBalances
  Convenience type for asset: extended balances
• OpenPositions
  Mapping of position id: OpenPosition
• QueryLedgerInfo
  Mapping of ledger id: ledger entry
• TradesInfo
  Mapping of trade-id: trade object