Crate alpaca_api_client

Alpaca API Client (unofficial)

DO NOT USE IN A SERIOUS PROJECT, NOT LIABLE FOR ANY ISSUES

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, and to learn more about open source software building. This is not a batteries included package yet, and still requires a lot of testing.

Quick Examples

Get bars for a single stock

use alpaca_api_client::get_bars;

let bars = get_bars("BTU", "1Day", Some("start=2023-02-23"));

Get bars for multiple symbols

use alpaca_api_client::get_multi_bars;

let watchlist: [&str; 30] = [
  "META", "DIS", "CMCSA", "VZ", "T", "CHTR", "NFLX", "TMUS", "TWTR", "FOXA", "FOX", "DISH",
  "CBS", "OMC", "TME", "TTWO", "EA", "ATVI", "ZM", "MTCH", "IAC", "NTES", "BIDU", "ROKU", "SPOT",
  "LYV", "IQ", "HUYA", "DOYU", "VIAV",
];

let multi_bars: MultiBars = get_multi_bars(&watchlist, "1Day", Some("start=2022-01-01"));

Place market order

use alpaca_api_client::{place_market_order, OrderSide};

let order = place_market_order("SO", 3.0, OrderSide::Buy);

Structs

• Account
  API object for an Account
• Bar
  API object for a Bar
• Order
  API object for an Order
• Position
  API object for a Position
• Trade
  API object for a Trade
• TradeActivity
  API object for a TradeActivity

Enums

• BarTrend
  Trend enum
• OrderSide
  Buy or Sell
• OrderStatus
  Possible order statuses
• TimeFrame
  Timeframe options utility for time frames accepted by alpaca api

Traits

• BarSession
  Utility methods for interacting with Bars type

Functions

• get_account
  Get your account details
• get_bars
  Get bars for a single stock
• get_latest_trade
  Get latest trade for single stock
• get_multi_bars
  Get bars for multiple stocks at a time
• get_multi_latest_trades
  Get latest trade for multiple stocks
• get_multi_trades
  Get multiple trades for multiple stocks
• get_open_positions
  Get all open positions
• get_order_by_id
  Get order by id
• get_orders
  Get all orders
• get_position
  Get a open single position by symbol
• get_trade_activity_by_type
  Get your recent activity by type
• get_trades
  Get the trades for a specific stock with a query option
• place_bracket_order
  Submit a basic bracket order.
• place_market_order
  Submit basic market order
• place_oto_stop_loss_order
  Submit a One-Triggers-Other for a stop loss order
• place_oto_take_profit_order
  Submit a One-Triggers-Other for a take profit order
• place_trailing_stop_order
  Submit a trailing stop order, must have a filled market order for symbol

Type Aliases

• Bars
  A custom type for a vector of bars
• MultiBars
  A custom type for a hashmap of stock symbols and bars
• MultiLatestTrades
  A custom type for a hashmap of stock symbols and latest trade objects
• MultiTrades
  A custom type for a hashmap of stock symbols and trade objects