Expand description
REST response types
Structs§
- Account
Transfer - Response type for a transfer to a linked Futures account
- AddOrder
- Response type for AddOrder
- AddOrder
Batch - Response type for AddOrderBatch
- AddOrder
Description - English description of an added order and closing order instruction (if given)
- Allocation
- Description of assets allocated to a strategy
- Allocation
State - State of a single allocation to a strategy
- Allocation
Status - Response type for AllocateStatus
- Amend
Order - Amount
Allocated - Details of an allocation to a particular strategy
- AprEstimate
- Bracketed estimate for a strategy’s APR
- Asset
Info - Asset details (e.g. for ETH, USDC, BTC, etc)
- Auto
Compound - Wrapper type for compounding nature of a strategy
- Batched
Order - Description of an added batch order, including potential error value.
- BidAsk
- Bid or Ask
- Bonding
Detail - Details of an earn strategy’s commitments and rewards
- Cancel
AllOrders After - Response for CancelAllOrdersAfter
- Cancel
Order - Response for CancelOrder
- Closed
Order - Order object for closed orders
- Closed
Orders - Response type for mapping order ids to orders
- Confirmation
RefId - Response type containing only a ref id for confirmation
- Delete
Export Report - Response type for deleting an export report
- Deposit
Address - Description of a deposit address
- Deposit
Method - Description of a deposit method
- Deposit
Withdrawal - Description of a deposit or withdrawal
- Deposit
Withdrawal Cursor - Cursor response that wraps a deposit
- Earn
Allocation - Description of an allocation to an earn strategy
- Earn
Allocations - Response type for Earn/Allocations
- Earn
Amount - Amount earned by an allocation in the requested and native assets
- Earn
Strategies - Paginated response type for /Earn/Strategies
- Earn
Strategy - Description of an individual earn strategy
- Export
Report - Response type for ExportReport
- Export
Report Status - Description of an export report
- Extended
Balance - Detailed balance data, including holds and credit (if available)
- FeeBy
Volume - Tiered fee description
- Fees
- Description of fee tier
- Last
Trade - Price and volume for the most recent trade
- Ledger
Entry - Entry in the user’s ledger
- Ledger
Info - Response type for Ledgers and QueryLedgers
- Lock
Type Detail - Details of how funds are locked by an earn strategy
- OHLC
- Candlestick data for the given interval
- Ohlc
Response - OHLC data by pair
- Open
Orders - Wrapper to map open orders by Kraken ref-id
- Open
Position - Details of an open margin position
- Order
- Order object for OpenOrders and QueryOrders
- Order
Amend - Order
Amends - Order
Description - Details of individual order
- Order
Edit - Response type for an edited order
- Orderbook
- Orderbook containing some depth of bids and asks
- Payout
- Description of the payout for a particular allocation
- Recent
Spreads - Spreads for one or many assets
- Recent
Trade - A public trade
- Recent
Trades - Wrapper type for recent trade response
- Rest
Ticker BidAsk - Best bid or ask
- Rest
Ticker Info - Complete ticker information for an asset
- Spread
- Bid-ask spread at a given time
- System
Status Info - Kraken server status, including an RFC3339 timestamp.
- System
Time - Kraken server time given in both unix timestamp and RFC1123
- Ticker
BidAsk - Best bid or ask
- Ticker
Decimal - Ticker helper type to serve differently typed data for the last 24 hours.
- Ticker
Trades - Ticker containing trade count data for the last 24 hours
- Tradable
Asset Pair - Trading pair details, including all necessary details for formatting orders
- Trade
- A private trade
- Trade
Balances - Detailed margin balance data
- Trade
Volume - Response type for TradeVolume
- Trades
History - Response type for user’s trade history
- Websocket
Token - Response type for GetWebSocketsToken
- Withdraw
Method - Description of a withdrawal method
- Withdrawal
- Description of a withdrawal
- Withdrawal
Address - Description of a withdrawal method
- Yield
Source - Wrapper type for the origin of rewards from a strategy
Enums§
- Account
Transfer Status - Status of a transfer between accounts
- Amend
Type - The type of Order Amend
- Asset
Status - Status for an asset (e.g. ETH, ATOM, USDC)
- Auto
Compound Type - Type of compounding for a given strategy
- BidOr
Ask - Whether a given BidAsk is a
Bidor anAsk - Bool
OrString - Wrapper type for odd responses that contain either a
boolor aString - BuySell
- Order side
- BuySell
Char - Single-character enum for buy and sell
- Deposit
Withdraw Response - Response type for status of a deposit or withdrawal
- EarnFee
- Wrapper type for loose typing of allocation/earn fees
- Export
Report Status Type - Status of a requested export report
- Ledger
Entry Type - Type of ledger entry in user’s ledger
- Lock
Type - Type of asset lock-up for a given earn strategy
- Market
Limit Char - Single-character enum for market and limit orders
- Order
Edit Status - Status of an edit requested for an order
- Order
Flag - Flags that can be applied to order requests.
- Order
Status - Status of an order
- Order
Status V2 - Status of an order
- Order
Type - Order type, e.g.
Market,Limit,StopLossLimit - Position
Status - Status of a position
- Position
Status V2 - Status of a position
- Status
Prop - Additional status properties about a deposit or withdrawal
- System
Status - Status of the exchange
- Tradable
Asset Status - Status of a given asset pair for trading (e.g. BTC-USD, ATOM-USD)
- Trade
Type - Trade type, separate from OrderType due to different serialization semantics
- Transfer
Status - Status of a requested transfer
- Verification
Tier - A user’s level of KYC verification with Kraken
- Yield
Source Type - Source of yield for a given earn strategy
Type Aliases§
- Account
Balances - Convenience type for asset: amount balances
- Extended
Balances - Convenience type for asset: extended balances
- Open
Positions - Mapping of position id: OpenPosition
- Query
Ledger Info - Mapping of ledger id: ledger entry
- Trades
Info - Mapping of trade-id: trade object