Struct alpaca_finance::Alpaca

pub struct Alpaca { /* fields omitted */ }

Alpaca contextual information that needs to be supplied to all calls.

Implementations

impl Alpaca

pub async fn live<'_, '_>(
    api_key_id: &'_ str,
    api_secret_key: &'_ str
) -> Result<Alpaca>

Creates an object for interacting with the LIVE API

Example

To get the alpaca context for the live account

let alpaca = Alpaca::live("KEY_ID", "SECRET").await.unwrap();

pub async fn paper<'_, '_>(
    api_key_id: &'_ str,
    api_secret_key: &'_ str
) -> Result<Alpaca>

Creates an object for interacting with the PAPER API

Example

To get the alpaca context for the paper account

let alpaca = Alpaca::paper("KEY_ID", "SECRET").await.unwrap();