alpaca-trade-api 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b11b95c51e70df9f8dede233caff85b1f6ba320ef48223f352fb9aad667a7be
-  data.tar.gz: 34ec4d4d1d1a7e30cdae40bfcff47a672f604776b3165ec5b58ec837d5b37eed
+  metadata.gz: 4226e3207279468a4ccafa2fd3bb303bf1d3695446a9e245f42437c6a5209614
+  data.tar.gz: a54c2fbe8f5cd7b1f8c0a2a161122b7ef9d4088be73309649c9898a421c75095
 SHA512:
-  metadata.gz: 6c6e449816b441014290897abb54fec95c555f8a2d505ae7ca2e61bd11b234660fd72ea1705bd3b6c16d2aff2b55de6d2a349269dcf08bd39c5b7a0e39f251ad
-  data.tar.gz: 6237db054e3a43eb502be7676d6d13addc1f8d20dd52977297ee454081791360b7e987be4b6bfca5c5b86b4c0cc1e0edaf0acc7922350fbbca283a24ab14787d
+  metadata.gz: fc02ec91bf7d1f41adf99142665f0c2d690379afb2e064832453eb49e4afc3ca0fbc5714ce746a011fbac878c2d9d8b95a1235a2c0b9d8a88d68c9137f47d934
+  data.tar.gz: 02b4c968b277f98a6d2a017d4917326b96744790611641cbb02066abc0c0f90b23b1c927232a4ca92f3a0dd21c01b33a345fa39fc5bf34cec6078a48897fc16e

data/CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.4.0] - 2020-02-16
+### Added
+- Supporting [Bracket Orders](https://docs.alpaca.markets/trading-on-alpaca/orders/#bracket-orders)
+- Validating time frame in Client#bars
+
 ## [0.3.0] - 2019-09-19
 ### Added
 - Implemented new endpoints:

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    alpaca-trade-api (0.3.0)
+    alpaca-trade-api (0.4.0)
       faraday (~> 0.15)
 
 GEM

data/README.md

@@ -26,23 +26,54 @@ By default, the library is configured to use the Paper Trading host - `https://p
 
 ```ruby
 Alpaca::Trade::Api.configure do |config|
-  config.endpoint = 'https://api.alapca.markets'
+  config.endpoint = 'https://api.alpaca.markets'
   config.key_id = 'A_KEY_ID'
   config.key_secret = 'A_S3CRET'
 end
 ```
 
-### Account
 
-TODO: Write usage instructions here
+### Example
 
-### Asset
+Here's an example on how to use the library to read details of an account's orders in paper trading.
 
-TODO: Write usage instructions here
+```ruby
+require 'alpaca/trade/api'
 
-### Trading
+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
+```
 
-TODO: Write usage instructions here
+### Supported endpoints
+
+Here's a table with all currently supported endpoints in this library:
+
+| Object | Action | Method |
+|------------------------------------------------------------------------------|---------------------------------------|--------------------------------|
+| [Account](https://docs.alpaca.markets/api-documentation/api-v2/account/)     | [GET] Get the account                 | Client#account                 |
+| [Orders](https://docs.alpaca.markets/api-documentation/api-v2/orders/)       | [GET] Get a list of orders            | Client#order                   |
+|                                                                              | [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](https://docs.alpaca.markets/api-documentation/api-v2/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](https://docs.alpaca.markets/api-documentation/api-v2/assets/)       | [GET] Get assets                      | Client#assets                  |
+|                                                                              | [GET] Get assets/:id                  | Client#asset(symbol:)          |
+|                                                                              | [GET] Get an asset                    | Client#asset(symbol:)          |
+| [Calendar](https://docs.alpaca.markets/api-documentation/api-v2/calendar/)   | [GET] Get the calendar                | Client#calendar(start_date:, end_date:) |
+| [Clock](https://docs.alpaca.markets/api-documentation/api-v2/clock/)         | [GET] Get the clock                   | Client#clock                            |
+| [Bars](https://docs.alpaca.markets/api-documentation/api-v2/market-data/bars/) | [GET] Get a list of bars            | Client#bars(timeframe, symbols, limit:) |
 
 ## Development
 

data/lib/alpaca/trade/api/client.rb

@@ -9,6 +9,8 @@ module Alpaca
       class Client
         attr_reader :data_endpoint, :endpoint, :key_id, :key_secret
 
+        TIMEFRAMES = ['minute', '1Min', '5Min', '15Min', 'day', '1D']
+
         def initialize(endpoint: Alpaca::Trade::Api.configuration.endpoint,
                        key_id: Alpaca::Trade::Api.configuration.key_id,
                        key_secret: Alpaca::Trade::Api.configuration.key_secret)
@@ -35,6 +37,7 @@ module Alpaca
         end
 
         def bars(timeframe, symbols, limit: 100)
+          validate_timeframe(timeframe)
           response = get_request(data_endpoint, "v1/bars/#{timeframe}", symbols: symbols.join(','), limit: limit)
           json = JSON.parse(response.body)
           json.keys.each_with_object({}) do |symbol, hash|
@@ -43,6 +46,7 @@ module Alpaca
         end
 
         def calendar(start_date: Date.today, end_date: (Date.today + 30))
+          # FIX, use start_date.strftime('%F')
           params = { "start" => start_date.iso8601, "end" => end_date.iso8601 }
           response = get_request(endpoint, "v2/calendar", params)
           json = JSON.parse(response.body)
@@ -94,7 +98,8 @@ module Alpaca
         end
 
         def new_order(symbol:, qty:, side:, type:, time_in_force:, limit_price: nil,
-          stop_price: nil, extended_hours: false, client_order_id: nil)
+          stop_price: nil, extended_hours: false, client_order_id: nil, order_class: nil,
+          take_profit: nil, stop_loss: nil)
 
           params = {
             symbol: symbol,
@@ -103,7 +108,10 @@ module Alpaca
             type: type,
             time_in_force: time_in_force,
             limit_price: limit_price,
+            order_class: order_class,
             stop_price: stop_price,
+            take_profit: take_profit,
+            stop_loss: stop_loss,
             extended_hours: extended_hours,
             client_order_id: client_order_id
           }
@@ -219,6 +227,12 @@ module Alpaca
             raise InternalServerError, JSON.parse(response.body)['message']
           end
         end
+
+        def validate_timeframe(timeframe)
+          unless TIMEFRAMES.include?(timeframe)
+            raise ArgumentError, "Invalid timeframe: #{timeframe}. Valid arguments are: #{TIMEFRAMES}"
+          end
+        end
       end
     end
   end

data/lib/alpaca/trade/api/order.rb

@@ -4,34 +4,41 @@ module Alpaca
   module Trade
     module Api
       class Order
-        attr_reader :id, :client_order_id, :created_at, :updated_at, :submitted_at,
-          :filled_at, :expired_at, :canceled_at, :failed_at, :asset_id, :symbol,
-          :asset_class, :qty, :filled_qty, :type, :side, :time_in_force, :limit_price,
-          :stop_price, :filled_avg_price, :status, :extended_hours
+        attr_reader :id, :asset_class, :asset_id, :canceled_at, :client_order_id,
+          :created_at, :expired_at, :extended_hours, :failed_at, :filled_at, :filled_avg_price,
+          :filled_qty, :legs, :limit_price, :order_class, :qty, :replaced_at, :replaced_by,
+          :replaces, :side, :status, :stop_price, :submitted_at, :symbol, :time_in_force,
+          :type, :updated_at
 
         def initialize(json)
           @id = json['id']
+
+          @asset_class = json['asset_class']
+          @asset_id = json['asset_id']
+          @canceled_at = json['canceled_at']
           @client_order_id = json['client_order_id']
           @created_at = json['created_at']
-          @updated_at = json['updated_at']
-          @submitted_at = json['submitted_at']
-          @filled_at = json['filled_at']
           @expired_at = json['expired_at']
-          @canceled_at = json['canceled_at']
+          @extended_hours = json['extended_hours']
           @failed_at = json['failed_at']
-          @asset_id = json['asset_id']
-          @symbol = json['symbol']
-          @asset_class = json['asset_class']
-          @qty = json['qty']
+          @filled_at = json['filled_at']
+          @filled_avg_price = json['filled_avg_price']
           @filled_qty = json['filled_qty']
-          @type = json['type']
-          @side = json['side']
-          @time_in_force = json['time_in_force']
+          @legs = (json['legs'] || []).map {|leg| Order.new(leg)}
           @limit_price = json['limit_price']
-          @stop_price = json['stop_price']
-          @filled_avg_price = json['filled_avg_price']
+          @order_class = json['order_class']
+          @qty = json['qty']
+          @replaced_at = json['replaced_at']
+          @replaced_by = json['replaced_by']
+          @replaces = json['replaces']
+          @side = json['side']
           @status = json['status']
-          @extended_hours = json['extended_hours']
+          @stop_price = json['stop_price']
+          @submitted_at = json['submitted_at']
+          @symbol = json['symbol']
+          @time_in_force = json['time_in_force']
+          @type = json['type']
+          @updated_at = json['updated_at']
         end
       end
     end

data/lib/alpaca/trade/api/version.rb

@@ -3,7 +3,7 @@
 module Alpaca
   module Trade
     module Api
-      VERSION = '0.3.0'
+      VERSION = '0.4.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alpaca-trade-api
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Cloves Carneiro Jr
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-20 00:00:00.000000000 Z
+date: 2020-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler