Adding `apca` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add apca

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

apca = "0.29.0"

The apca library will be automatically available globally. Read the apca library documentation.

Back to the crate overview.

Readme

apca

apca is a library for interacting with the Alpaca API at alpaca.markets. The crate is entirely written in Rust and exposes a fully async API based on the native async/await language feature.

The crate provides access to the majority of functionality provided by Alpaca, including, but not limited to:

inquiring of account information
changing of the account configuration
retrieving of past account activity
accessing the market clock
submitting, changing, listing, and canceling orders
listing and closing open positions
listing and retrieving general asset information
streaming of order updates over WebSocket
historic market data retrieval through Alpaca's Data API
real time market data streaming via Alpaca's websocket API

For convenient command-line based access to the API, please use apcacli.

Usage

The following example illustrates how to create a Client object and then submit a limit order for AAPL with a limit price of USD 100:

let api_info = ApiInfo::from_env().unwrap();
let client = Client::new(api_info);

let request = order::CreateReqInit {
  type_: Type::Limit,
  limit_price: Some(Num::from(100)),
  ..Default::default()
}
.init("AAPL", Side::Buy, order::Amount::quantity(1));

let order = client
  .issue::<order::Create>(&request)
  .await
  .unwrap();

The returned order object can subsequently be inspected to find out details about the order (such as its ID). The full example is available here.

Please refer to the full documentation for more details.

Adding apca library as a dependency

Adding `apca` library as a dependency