Struct SpotRestClient 

pub struct SpotRestClient { /* private fields */ }

The Kraken Spot REST API client.

This client provides access to all Kraken Spot trading REST endpoints. It handles authentication, rate limiting, and automatic retries.

Example

use kraken_api_client::spot::rest::SpotRestClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Create a client for public endpoints only
    let client = SpotRestClient::new();

    // Get server time
    let time = client.get_server_time().await?;
    println!("Server time: {:?}", time);

    Ok(())
}

For private endpoints, provide credentials:

use kraken_api_client::spot::rest::SpotRestClient;
use kraken_api_client::auth::StaticCredentials;
use std::sync::Arc;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let credentials = Arc::new(StaticCredentials::new("api_key", "api_secret"));
    let client = SpotRestClient::builder()
        .credentials(credentials)
        .build();

    let balance = client.get_account_balance().await?;
    println!("Balance: {:?}", balance);

    Ok(())
}

Implementations

impl SpotRestClient

pub fn new() -> Self

Create a new client with default settings.

This client can only access public endpoints. Use SpotRestClient::builder() to configure credentials for private endpoints.

pub fn builder() -> SpotRestClientBuilder

Create a new client builder.

impl SpotRestClient

pub async fn get_account_balance( &self, ) -> Result<HashMap<String, Decimal>, KrakenError>

Get account balance.

Returns the balances of all assets in the account.

Example

use kraken_api_client::spot::rest::SpotRestClient;
use kraken_api_client::auth::StaticCredentials;
use std::sync::Arc;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let credentials = Arc::new(StaticCredentials::new("key", "secret"));
    let client = SpotRestClient::builder().credentials(credentials).build();

    let balances = client.get_account_balance().await?;
    for (asset, balance) in balances {
        println!("{}: {}", asset, balance);
    }
    Ok(())
}

pub async fn get_extended_balance( &self, ) -> Result<ExtendedBalances, KrakenError>

Get extended balance with hold amounts.

pub async fn get_trade_balance( &self, request: Option<&TradeBalanceRequest>, ) -> Result<TradeBalance, KrakenError>

Get trade balance.

Returns margin account details including equity, margin, and P&L.

pub async fn get_open_orders( &self, request: Option<&OpenOrdersRequest>, ) -> Result<OpenOrders, KrakenError>

Get open orders.

pub async fn get_closed_orders( &self, request: Option<&ClosedOrdersRequest>, ) -> Result<ClosedOrders, KrakenError>

Get closed orders.

pub async fn query_orders( &self, request: &QueryOrdersRequest, ) -> Result<HashMap<String, Order>, KrakenError>

Query specific orders by ID.

pub async fn get_trades_history( &self, request: Option<&TradesHistoryRequest>, ) -> Result<TradesHistory, KrakenError>

Get trades history.

pub async fn get_open_positions( &self, request: Option<&OpenPositionsRequest>, ) -> Result<HashMap<String, Position>, KrakenError>

Get open positions.

pub async fn get_ledgers( &self, request: Option<&LedgersRequest>, ) -> Result<LedgersInfo, KrakenError>

Get ledger entries.

pub async fn get_trade_volume( &self, request: Option<&TradeVolumeRequest>, ) -> Result<TradeVolume, KrakenError>

Get trade volume and fee info.

pub async fn get_deposit_methods( &self, request: &DepositMethodsRequest, ) -> Result<Vec<DepositMethod>, KrakenError>

Get available deposit methods for an asset.

pub async fn get_deposit_addresses( &self, request: &DepositAddressesRequest, ) -> Result<Vec<DepositAddress>, KrakenError>

Get deposit addresses for an asset and method.

pub async fn get_deposit_status( &self, request: Option<&DepositStatusRequest>, ) -> Result<DepositWithdrawStatusResponse, KrakenError>

Get deposit status.

pub async fn get_withdraw_methods( &self, request: Option<&WithdrawMethodsRequest>, ) -> Result<Vec<WithdrawMethod>, KrakenError>

Get available withdrawal methods.

pub async fn get_withdraw_addresses( &self, request: Option<&WithdrawAddressesRequest>, ) -> Result<Vec<WithdrawalAddress>, KrakenError>

Get withdrawal addresses.

pub async fn get_withdraw_info( &self, request: &WithdrawInfoRequest, ) -> Result<WithdrawInfo, KrakenError>

Get withdrawal info (limits and fees).

pub async fn withdraw_funds( &self, request: &WithdrawRequest, ) -> Result<ConfirmationRefId, KrakenError>

Withdraw funds.

pub async fn get_withdraw_status( &self, request: Option<&WithdrawStatusRequest>, ) -> Result<DepositWithdrawStatusResponse, KrakenError>

Get withdrawal status.

pub async fn withdraw_cancel( &self, request: &WithdrawCancelRequest, ) -> Result<bool, KrakenError>

Cancel a withdrawal.

pub async fn wallet_transfer( &self, request: &WalletTransferRequest, ) -> Result<ConfirmationRefId, KrakenError>

Transfer funds between wallets (e.g., Spot to Futures).

pub async fn earn_allocate( &self, request: &EarnAllocateRequest, ) -> Result<bool, KrakenError>

Allocate funds to an earn strategy.

pub async fn earn_deallocate( &self, request: &EarnAllocateRequest, ) -> Result<bool, KrakenError>

Deallocate funds from an earn strategy.

pub async fn get_earn_allocation_status( &self, request: &EarnAllocationStatusRequest, ) -> Result<AllocationStatus, KrakenError>

Get earn allocation status.

pub async fn get_earn_deallocation_status( &self, request: &EarnAllocationStatusRequest, ) -> Result<AllocationStatus, KrakenError>

Get earn deallocation status.

pub async fn list_earn_strategies( &self, request: Option<&EarnStrategiesRequest>, ) -> Result<EarnStrategies, KrakenError>

List earn strategies.

pub async fn list_earn_allocations( &self, request: Option<&EarnAllocationsRequest>, ) -> Result<EarnAllocations, KrakenError>

List earn allocations.

pub async fn add_order( &self, request: &AddOrderRequest, ) -> Result<AddOrderResponse, KrakenError>

Add a new order.

Example

use kraken_api_client::spot::rest::{SpotRestClient, private::AddOrderRequest};
use kraken_api_client::{BuySell, OrderType};
use kraken_api_client::auth::StaticCredentials;
use rust_decimal::Decimal;
use std::str::FromStr;
use std::sync::Arc;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let credentials = Arc::new(StaticCredentials::new("key", "secret"));
    let client = SpotRestClient::builder().credentials(credentials).build();

    let request = AddOrderRequest::new(
        "XBTUSD",
        BuySell::Buy,
        OrderType::Limit,
        Decimal::from_str("0.001")?,
    )
    .price(Decimal::from_str("50000")?)
    .validate(true); // Validate only, don't actually place

    let result = client.add_order(&request).await?;
    println!("Order result: {:?}", result);
    Ok(())
}

pub async fn cancel_order( &self, request: &CancelOrderRequest, ) -> Result<CancelOrderResponse, KrakenError>

Cancel an order.

pub async fn cancel_all_orders( &self, ) -> Result<CancelOrderResponse, KrakenError>

Cancel all open orders.

pub async fn get_websocket_token(&self) -> Result<WebSocketToken, KrakenError>

Get a WebSocket authentication token.

The token is valid for 15 minutes and is used to authenticate WebSocket connections to private channels.

impl SpotRestClient

pub async fn get_server_time(&self) -> Result<ServerTime, KrakenError>

Get the server time.

This is useful for synchronizing local time and checking API availability.

Example

use kraken_api_client::spot::rest::SpotRestClient;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = SpotRestClient::new();
    let time = client.get_server_time().await?;
    println!("Server time: {} ({})", time.unixtime, time.rfc1123);
    Ok(())
}

pub async fn get_system_status(&self) -> Result<SystemStatus, KrakenError>

Get the system status.

Returns the current system status and timestamp.

pub async fn get_assets( &self, request: Option<&AssetInfoRequest>, ) -> Result<HashMap<String, AssetInfo>, KrakenError>

Get asset information.

Returns information about the assets available on Kraken.

Arguments

• request - Optional request parameters to filter assets.

pub async fn get_asset_pairs( &self, request: Option<&AssetPairsRequest>, ) -> Result<HashMap<String, AssetPair>, KrakenError>

Get tradable asset pairs.

Returns information about the trading pairs available on Kraken.

Arguments

• request - Optional request parameters to filter pairs.

pub async fn get_ticker( &self, pairs: &str, ) -> Result<HashMap<String, TickerInfo>, KrakenError>

Get ticker information for one or more pairs.

Arguments

• pairs - Comma-separated list of pairs (e.g., “XBTUSD,ETHUSD”).

pub async fn get_ohlc( &self, request: &OhlcRequest, ) -> Result<OhlcResponse, KrakenError>

Get OHLC (candlestick) data.

Returns up to 720 OHLC data points for the specified pair and interval.

Arguments

• request - OHLC request parameters.

pub async fn get_order_book( &self, request: &OrderBookRequest, ) -> Result<HashMap<String, OrderBook>, KrakenError>

Get order book for a pair.

Arguments

• request - Order book request parameters.

pub async fn get_recent_trades( &self, request: &RecentTradesRequest, ) -> Result<RecentTradesResponse, KrakenError>

Get recent trades for a pair.

Arguments

• request - Recent trades request parameters.

pub async fn get_recent_spreads( &self, request: &RecentSpreadsRequest, ) -> Result<RecentSpreadsResponse, KrakenError>

Get recent spreads for a pair.

Arguments

• request - Recent spreads request parameters.

Trait Implementations

impl Clone for SpotRestClient

fn clone(&self) -> SpotRestClient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SpotRestClient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SpotRestClient

fn default() -> Self

Returns the “default value” for a type.

impl KrakenClient for SpotRestClient

async fn get_server_time(&self) -> Result<ServerTime, KrakenError>

Get the server time.

async fn get_system_status(&self) -> Result<SystemStatus, KrakenError>

Get the system status.

async fn get_assets( &self, request: Option<&AssetInfoRequest>, ) -> Result<HashMap<String, AssetInfo>, KrakenError>

Get asset information.

async fn get_asset_pairs( &self, request: Option<&AssetPairsRequest>, ) -> Result<HashMap<String, AssetPair>, KrakenError>

Get tradable asset pairs.

async fn get_ticker( &self, pairs: &str, ) -> Result<HashMap<String, TickerInfo>, KrakenError>

Get ticker information for one or more pairs.

async fn get_ohlc( &self, request: &OhlcRequest, ) -> Result<OhlcResponse, KrakenError>

Get OHLC (candlestick) data.

async fn get_order_book( &self, request: &OrderBookRequest, ) -> Result<HashMap<String, OrderBook>, KrakenError>

Get order book for a pair.

async fn get_recent_trades( &self, request: &RecentTradesRequest, ) -> Result<RecentTradesResponse, KrakenError>

Get recent trades for a pair.

async fn get_recent_spreads( &self, request: &RecentSpreadsRequest, ) -> Result<RecentSpreadsResponse, KrakenError>

Get recent spreads for a pair.

async fn get_account_balance( &self, ) -> Result<HashMap<String, Decimal>, KrakenError>

Get account balance.

async fn get_extended_balance(&self) -> Result<ExtendedBalances, KrakenError>

Get extended balance with hold amounts.

async fn get_trade_balance( &self, request: Option<&TradeBalanceRequest>, ) -> Result<TradeBalance, KrakenError>

Get trade balance (margin account details).

async fn get_open_orders( &self, request: Option<&OpenOrdersRequest>, ) -> Result<OpenOrders, KrakenError>

Get open orders.

async fn get_closed_orders( &self, request: Option<&ClosedOrdersRequest>, ) -> Result<ClosedOrders, KrakenError>

Get closed orders.

async fn query_orders( &self, request: &QueryOrdersRequest, ) -> Result<HashMap<String, Order>, KrakenError>

Query specific orders by ID.

async fn get_trades_history( &self, request: Option<&TradesHistoryRequest>, ) -> Result<TradesHistory, KrakenError>

Get trades history.

async fn get_open_positions( &self, request: Option<&OpenPositionsRequest>, ) -> Result<HashMap<String, Position>, KrakenError>

Get open positions.

async fn get_ledgers( &self, request: Option<&LedgersRequest>, ) -> Result<LedgersInfo, KrakenError>

Get ledger entries.

async fn get_trade_volume( &self, request: Option<&TradeVolumeRequest>, ) -> Result<TradeVolume, KrakenError>

Get trade volume and fee info.

async fn get_deposit_methods( &self, request: &DepositMethodsRequest, ) -> Result<Vec<DepositMethod>, KrakenError>

Get available deposit methods.

async fn get_deposit_addresses( &self, request: &DepositAddressesRequest, ) -> Result<Vec<DepositAddress>, KrakenError>

Get deposit addresses.

async fn get_deposit_status( &self, request: Option<&DepositStatusRequest>, ) -> Result<DepositWithdrawStatusResponse, KrakenError>

Get deposit status.

async fn get_withdraw_methods( &self, request: Option<&WithdrawMethodsRequest>, ) -> Result<Vec<WithdrawMethod>, KrakenError>

Get available withdrawal methods.

async fn get_withdraw_addresses( &self, request: Option<&WithdrawAddressesRequest>, ) -> Result<Vec<WithdrawalAddress>, KrakenError>

Get withdrawal addresses.

async fn get_withdraw_info( &self, request: &WithdrawInfoRequest, ) -> Result<WithdrawInfo, KrakenError>

Get withdrawal info.

async fn withdraw_funds( &self, request: &WithdrawRequest, ) -> Result<ConfirmationRefId, KrakenError>

Withdraw funds.

async fn get_withdraw_status( &self, request: Option<&WithdrawStatusRequest>, ) -> Result<DepositWithdrawStatusResponse, KrakenError>

Get withdrawal status.

async fn withdraw_cancel( &self, request: &WithdrawCancelRequest, ) -> Result<bool, KrakenError>

Cancel a withdrawal.

async fn wallet_transfer( &self, request: &WalletTransferRequest, ) -> Result<ConfirmationRefId, KrakenError>

Transfer funds between wallets.

async fn earn_allocate( &self, request: &EarnAllocateRequest, ) -> Result<bool, KrakenError>

Allocate funds to an earn strategy.

async fn earn_deallocate( &self, request: &EarnAllocateRequest, ) -> Result<bool, KrakenError>

Deallocate funds from an earn strategy.

async fn get_earn_allocation_status( &self, request: &EarnAllocationStatusRequest, ) -> Result<AllocationStatus, KrakenError>

Get earn allocation status.

async fn get_earn_deallocation_status( &self, request: &EarnAllocationStatusRequest, ) -> Result<AllocationStatus, KrakenError>

Get earn deallocation status.

async fn list_earn_strategies( &self, request: Option<&EarnStrategiesRequest>, ) -> Result<EarnStrategies, KrakenError>

List earn strategies.

async fn list_earn_allocations( &self, request: Option<&EarnAllocationsRequest>, ) -> Result<EarnAllocations, KrakenError>

List earn allocations.

async fn add_order( &self, request: &AddOrderRequest, ) -> Result<AddOrderResponse, KrakenError>

Add a new order.

async fn cancel_order( &self, request: &CancelOrderRequest, ) -> Result<CancelOrderResponse, KrakenError>

Cancel an order.

async fn cancel_all_orders(&self) -> Result<CancelOrderResponse, KrakenError>

Cancel all open orders.

async fn get_websocket_token(&self) -> Result<WebSocketToken, KrakenError>

Get a WebSocket authentication token.