Giter VIP home page Giter VIP logo

apca's Introduction

pipeline coverage crates.io Docs rustc

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::OrderReqInit {
  type_: Type::Limit,
  limit_price: Some(Num::from(100)),
  ..Default::default()
}
.init("AAPL", Side::Buy, order::Amount::quantity(1));

let order = client
  .issue::<order::Post>(&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.

apca's People

Contributors

d-e-s-o avatar zjijz avatar behos avatar ajmwagar avatar naltun avatar cakekindel avatar varonroy avatar nobles5e avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.