Struct krakenrs::KrakenRestAPI

pub struct KrakenRestAPI { /* fields omitted */ }

A connection to the Kraken REST API This only supports blocking http requests for now

Implementations

impl KrakenRestAPI

pub fn time(&self) -> Result<TimeResponse>

(Public) Get the kraken system’s time

pub fn system_status(&self) -> Result<SystemStatusResponse>

(Public) Get the kraken system’s status

pub fn assets(&self) -> Result<AssetsResponse>

(Public) Get the list of kraken’s supported assets, and info

pub fn asset_pairs(&self, pairs: Vec<String>) -> Result<AssetPairsResponse>

(Public) Get the list of kraken’s asset pairs, and info

Arguments:

• pairs: A list of Kraken asset pair strings to get info about. If empty then all asset pairs

pub fn ticker(&self, pairs: Vec<String>) -> Result<TickerResponse>

(Public) Get the ticker price for one or more asset pairs

Arguments:

• pairs: A list of Kraken asset pair strings to get ticker info about

pub fn get_account_balance(&self) -> Result<BalanceResponse>

(Private) Get the balance

pub fn get_websockets_token(&self) -> Result<GetWebSocketsTokenResponse>

(Private) Get a websockets authentication token

pub fn get_open_orders(
    &self,
    userref: Option<UserRefId>
) -> Result<GetOpenOrdersResponse>

(Private) Get the list of open orders

Arguments:

• userref: An optional user-reference to filter the list of open orders by

pub fn cancel_order(&self, id: String) -> Result<CancelOrderResponse>

(Private) Cancel order

Arguments:

• id: A TxId (OR a UserRefId) of order(s) to cancel

pub fn cancel_all_orders(&self) -> Result<CancelAllOrdersResponse>

(Private) Cancel all orders (regardless of user ref or tx id)

pub fn cancel_all_orders_after(
    &self,
    timeout: u64
) -> Result<CancelAllOrdersAfterResponse>

(Private) Cancel all orders after

Arguments:

• timeout: Integer timeout specified in seconds. 0 to disable the timer.

pub fn add_market_order(
    &self,
    market_order: MarketOrder,
    user_ref_id: Option<UserRefId>,
    validate: bool
) -> Result<AddOrderResponse>

(Private) Place a market order

Arguments:

• market_order: Market order object describing the parameters of the order
• user_ref_id: Optional user ref id to attach to the order
• validate: If true, the order is only validated and is not actually placed

pub fn add_limit_order(
    &self,
    limit_order: LimitOrder,
    user_ref_id: Option<UserRefId>,
    validate: bool
) -> Result<AddOrderResponse>

(Private) Place a limit order

Arguments:

• limit_order: Limit order object describing the parameters of the order
• user_ref_id: Optional user ref id to attach to the order
• validate: If true, the order is only validated and is not actually placed

Trait Implementations

impl TryFrom<KrakenRestConfig> for KrakenRestAPI

type Error = Error

The type returned in the event of a conversion error.

fn try_from(src: KrakenRestConfig) -> Result<Self>

Performs the conversion.