#api-client #api #trading #client #stock #alpaca

alpaca_api_client

Unofficial Alpaca API Client

15 releases (4 breaking)

0.5.0 Mar 25, 2024
0.4.1 Feb 23, 2024
0.3.2 Jul 7, 2023
0.2.1 Jun 27, 2023
0.1.6 Jun 19, 2023

#33 in Finance

Download history 141/week @ 2024-02-17 83/week @ 2024-02-24 11/week @ 2024-03-02 7/week @ 2024-03-09 2/week @ 2024-03-16 128/week @ 2024-03-23 32/week @ 2024-03-30

160 downloads per month

MIT/Apache

28KB
636 lines

Alpaca API Client in Rust

Still a Work In Progress Not Production Ready. Not Liable for Any Issues. Recommended for Paper Accounts only.

Build Status Version 0.5.0

Table of Contents

Introduction

Alpaca is a trading platform for developers and app makers, and they provide various endpoints to access over http. The goal of this package is to provide the bare minimum tools for using the Alpaca API.

Features

  • Get Stock Bars
  • Get Stock Trades
  • Get Positions
  • Place Orders
  • View Account
  • View Activity

Installation

To install the Alpaca API Client, you will need Rust installed on your machine. If you don't have Rust installed, you can follow the official guide.

Once Rust is installed, you can install the Alpaca API Client using cargo:

cargo install alpaca_api_client

Add your API keys to an .env file in the root of your directory with these names.

/.env

APCA_API_KEY_ID=<pub_key>
APCA_API_SECRET_KEY=<secret_key>

Usage

RS Docs

Get Bars for a single stock

use alpaca_api_client::get_bars;

// Args(symbol, timeframe, query)
let bars = get_bars("BTU", "1Day", Some("start=2023-02-23")).unwrap();

Get Bars for multiple symbols

use alpaca_api_client::{get_multi_bars, MultiBars};

let watchlist: [&str; 3] = ["META", "DIS", "VZ"];

let multiple_bars = get_multi_bars(&watchlist, "1Day", Some("start=2023-01-01")).unwrap();

Place Market order

use alpaca_api_client::{place_market_order, OrderSide};

// Args(symbol, quantity, side)
let order = place_market_order("SO", 3.0, OrderSide::Buy).unwrap();

Place Bracket order

use alpaca_api_client::{place_bracket_order, OrderSide};

// Args(symbol, quantity, side, take_profit, stop_loss)
let order = place_bracket_order("ABBV", 3.0, OrderSide::Buy, 170.00, 120.00).unwrap();

Contribution

Any and all PR's are welcome. I see a need for this type of Rust client to support Alpaca's v2 API.

License

This project is licensed under the MIT and APACHE License.

Dependencies

~2.8–4MB
~107K SLoC