Project

alpaca-trade-api

0.04
No release in over 3 years
Low commit activity in last 3 years
There's a lot of open issues
alpaca-trade-apiccjr/alpaca-trade-apiHomepageDocumentationSource CodeBug TrackerWiki
Alpaca API lets you build and trade with real-time market data for free.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
19,102
Stars
32
Forks
23
Watchers
5
 Releases
Current version
0.8.0
Total releases
9
First release
2019-07-05
Latest release
2021-04-29
 Issues
Open Issues
3
Closed Issues
8
Total Issues
11
Issue Closure Rate
72%
 Pull Requests
Open Pull Requests
4
Closed Pull Requests
5
Merged Pull Requests
14
Pull Request Acceptance Rate
60%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2020-12-16
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 2.0
byebug
>= 0
rake
~> 13.0
rb-readline
>= 0
rspec
~> 3.0
simplecov
~> 0.16
vcr
~> 5.0
webmock
~> 3.0

Runtime

faraday
>= 0.15, < 2.0
 Project Readme

Alpaca::Trade::Api

This is a high-level Ruby wrapper for Alpaca trading API. This implementation only supports the Web API v2 API, there is no plan to support Web API v1.

Installation

Add this line to your application's Gemfile:

gem 'alpaca-trade-api'

And then execute:

$ bundle

Or install it yourself as:

$ gem install alpaca-trade-api

Usage

Configuration

By default, the library is configured to use the Paper Trading host - https://paper-api.alpaca.markets - as the endpoint it connects to, and loads both the key id and secret key from the following environment variables: ALPACA_API_KEY_ID and ALPACA_API_SECRET_KEY. To configure the library differently:

Alpaca::Trade::Api.configure do |config|
  config.endpoint = 'https://api.alpaca.markets'
  config.key_id = 'A_KEY_ID'
  config.key_secret = 'A_S3CRET'
end

Example

Here's an example on how to use the library to read details of an account's orders in paper trading.

require 'alpaca/trade/api'

Alpaca::Trade::Api.configure do |config|
  config.endpoint = 'https://paper-api.alpaca.markets'
  config.key_id = 'xxxxxxxx'
  config.key_secret = 'xxxxx'
end

client =  Alpaca::Trade::Api::Client.new
puts client.orders.last.inspect

Supported endpoints

Here's a table with all currently supported endpoints in this library:

Object Action Method
Account [GET] Get the account Client#account
Account Activities [GET] Get a list of account activities Client#account_activities(activity_type:)
Orders [GET] Get a list of orders Client#orders
[POST] Request a new order Client#new_order
[GET] Get an order Client#order(id:)
[GET] Get an order by client order id Client#order(id:)
[PATCH] Replace an order Client#replace_order
[DELETE] Cancel all orders Client#cancel_orders
[DELETE] Cancel an order Client#cancel_order(id:)
Positions [GET] Get open positions Client#positions
[GET] Get an open position Client#position(symbol:)
[DELETE] Close all positions Client#close_positions
[DELETE] Close a position Client#close_position(symbol:)
Assets [GET] Get assets Client#assets
[GET] Get assets/:id Client#asset(symbol:)
[GET] Get an asset Client#asset(symbol:)
Calendar [GET] Get the calendar Client#calendar(start_date:, end_date:)
Clock [GET] Get the clock Client#clock
Bars [GET] Get a list of bars Client#bars(timeframe, symbols, limit:)

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/ccjr/alpaca-trade-api.

License

The gem is available as open source under the terms of the MIT License.