Expand description
REST request types
Structs§
- Account
Transfer Request - A request to transfer assets between sub-accounts.
- Account
Transfer Request Builder - AddBatched
Order Request - A request to create up to 15 spot orders in a batch.
- AddBatched
Order Request Builder - AddOrder
Request - A request to create a new spot order.
- AddOrder
Request Builder - Allocate
Earn Funds Request - A request to allocate funds to a particular Earn strategy.
- Allocate
Earn Funds Request Builder - Amend
Order Request - Amend
Order Request Builder - Asset
Info Request - A request for details on a particular asset, such as “BTC”, “ETH”, or “USDC”.
- Asset
Info Request Builder - Batched
Order Request - An individual order request to be placed in a batch.
- Batched
Order Request Builder - Cancel
AllOrders After Request - A “dead man’s switch” for all active orders.
- Cancel
AllOrders After Request Builder - Cancel
Batch Orders Request - A request to cancel up to 50 orders in a batch by tx id or user ref.
- Cancel
Batch Orders Request Builder - Cancel
Order Request - A request to cancel an order by txid (String) or userref (Int).
- Cancel
Order Request Builder - Closed
Orders Request - A request to retrieve historical orders, 50 at a time.
- Closed
Orders Request Builder - Create
SubAccount Request - A request to create a sub-account for trading.
- Create
SubAccount Request Builder - Delete
Export Request - A request to delete an export report by id.
- Delete
Export Request Builder - Deposit
Addresses Request - A request to retrieve or generate a deposit address for a particular asset and method.
- Deposit
Addresses Request Builder - Deposit
Methods Request - A request for all available deposit methods for a given asset.
- Deposit
Methods Request Builder - Earn
Allocation Status Request - A request for the allocation status for a given strategy.
- Earn
Allocation Status Request Builder - Edit
Order Request - A request to edit an existing order.
- Edit
Order Request Builder - Export
Report Request - A request for the asynchronous generation of a report of “trades” or “ledgers”.
- Export
Report Request Builder - Export
Report Status Request - A request for the status of a requested export report.
- Export
Report Status Request Builder - Ledgers
Info Request - A request for 50 ledger entries for the account.
- Ledgers
Info Request Builder - List
Earn Allocations Request - A request to list all current earn strategy allocations.
- List
Earn Allocations Request Builder - List
Earn Strategies Request - A request for all earn strategies.
- List
Earn Strategies Request Builder - OHLC
Request - A request for OHLC data for a single pair, optionally providing a
sinceto retrieve incremental updates. - OHLC
Request Builder - Open
Orders Request - A request for all open orders on the account.
- Open
Orders Request Builder - Open
Positions Request - A request for details about an open margin position.
- Open
Positions Request Builder - Order
Amends Request - Order
Amends Request Builder - Order
Flags - Wrapper type for a
Vec<OrderFlag>that serializes to a comma-separated string. - Order
Request - A request for the details of up to 50 orders by id.
- Order
Request Builder - Orderbook
Request - A request for the orderbook of a pair, optionally at a given depth of bids and asks
(
countparameter). - Orderbook
Request Builder - Query
Ledger Request - A request for details of up to 20 ledger entries by id.
- Query
Ledger Request Builder - Recent
Spreads Request - Retrieve the most recent bid/ask spreads for a given pair, optionally with a
sinceparameter to receive only incremental updates. - Recent
Spreads Request Builder - Recent
Trades Request - A fully-paginated request for trades from a particular pair.
- Recent
Trades Request Builder - Retrieve
Export Report Request - A request to retrieve a specific export report by id.
- Retrieve
Export Report Request Builder - Status
OfDeposit Withdraw Request - A request for the status of a deposit or withdrawal request.
- Status
OfDeposit Withdraw Request Builder - StringCSV
- Wrapper type for a
Vec<String>that serializes to comma-separated. - Ticker
Request - A request for common ticker info for one or many pairs.
- Ticker
Request Builder - Tradable
Asset Pairs Request - A request for details on a particular trading pair, such as “BTCUSD”, “DOGEUSDT”, or “ETHUSD”.
- Tradable
Asset Pairs Request Builder - Trade
Balance Request - A request for margin trading data, optionally only for a specific pair.
- Trade
Balance Request Builder - Trade
Info Request - A request for details of up to 50 trades by ref id.
- Trade
Info Request Builder - Trade
Volume Request - A request for cumulative 30-day USD trading volume for the account.
- Trade
Volume Request Builder - Trades
History Request - A request for any historical trades for the account.
- Trades
History Request Builder - Wallet
Transfer Request - A request to transfer from the account’s Spot wallet to Future’s wallet.
- Wallet
Transfer Request Builder - Withdraw
Cancel Request - A request to cancel an active withdrawal.
- Withdraw
Cancel Request Builder - Withdraw
Funds Request - A request to withdraw funds.
- Withdraw
Funds Request Builder - Withdrawal
Addresses Request - A request to retrieve or generate a withdrawal address for a particular asset and method.
- Withdrawal
Addresses Request Builder - Withdrawal
Info Request - A request for the limit, amount and fee to withdraw asset.
- Withdrawal
Info Request Builder - Withdrawal
Methods Request - A request for all available withdrawal methods for the user.
- Withdrawal
Methods Request Builder
Enums§
- Asset
Pair Info - Type of information to request for asset pairs.
- Candlestick
Interval - All possible candlestick intervals for requesting OHLC data.
- Close
Time - Time to use when searching for closed orders by start and end timestamps.
- Cursor
- A sub-type for specifying if paginating (Bool), or providing a cursor for the next page (String).
- Delete
Export Type - Whether to cancel or delete a requested export report.
- IntOr
String - Wrapper type for submitting order cancels by Kraken id (String) or user-ref (Int).
- Lock
Type - Type of lock-up for a given Earn strategy.
- Report
Format Type - Format of report, either comma or tab separated values.
- Report
Type - Type of report to request generation for.
- Self
Trade Prevention - Strategy for exchange to take when handling a self-crossing order.
- Time
InForce - Time in Force for the given order.
- Time
InForce V2 - Time in Force for the given order.
- Trade
Type - Types of trades to filter for when requesting user’s trade history.
- Trigger
Type - Type of price to use for conditional orders.