alpaca-trade-api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0745d9ff9c3a0a67985cbccd1f39490dc2cbd5ad4e49fc84bfe5ce303b91820
-  data.tar.gz: 4c6958398bbbedad4e86fb229d36377a922dbb4b16bd747d8013949c616ec06e
+  metadata.gz: eb5dd189cbc0f77a733ae7a00b6a3448f8071b89bc47f90b749d64c1a34d2709
+  data.tar.gz: f5a81f245c4bd2de6b2670cb07d3dfa80988cb1e7eeec8e794969a35493a890e
 SHA512:
-  metadata.gz: 1d3ddbc1adc6fb0a78e400fa52505413170ef6adfe19f03dd203d5d90823f0b81cb5d9f909902756e2b5b4d13104d99ead36a7e200b21e0d590f9c195b612faa
-  data.tar.gz: ea47ae148c14210bcd49c5c40d6a810a7593a45df0e35606964626b0d4b5b9b9956148795f5606077a88aabc14dfb8086b7f928771afb77fa27c2c6174b386c4
+  metadata.gz: 9e7090ca6b7ab5dbcb57903d3a90538f76abe585c147294ecc00a366c94e07cce9ac4107bcc537396553ddf5ab9dff8d4138da27d0404635ff9651cdee54755e
+  data.tar.gz: fc7b23fa07cb3dad7b9f705ac812a9370c78f92434bdca44beb30e3c891eecd5424aea72fa0173d898e5bb2c16759387fa594763132e60cad9d9c44130540a99

data/CHANGELOG.md

@@ -4,7 +4,13 @@ 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).
 
-## [Unreleased]
+## [0.2.0] - 2019-07-10
+### Added
+- Implemented Client#calendar.
+- Implemented Client#clock.
+- Added Client#assets.
+- Implemented new methods in Client: new_order, order, orders, position, positions.
+- Implemented Client#cancel_order.
 
 ## [0.1.0] - 2019-07-04
 ### Added

data/lib/alpaca/trade/api.rb

@@ -6,6 +6,11 @@ require 'alpaca/trade/api/configuration'
 require 'alpaca/trade/api/account'
 require 'alpaca/trade/api/asset'
 require 'alpaca/trade/api/bar'
+require 'alpaca/trade/api/calendar'
+require 'alpaca/trade/api/clock'
+require 'alpaca/trade/api/order'
+require 'alpaca/trade/api/position'
+
 require 'alpaca/trade/api/client'
 require 'alpaca/trade/api/errors'
 

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

@@ -15,9 +15,9 @@ module Alpaca
           @id = json['id']
           @status = json['status']
           @currency = json['currency']
-          @buying_power = json['buying_power']
-          @cash = json['cash']
-          @portfolio_value = json['portfolio_value']
+          @buying_power = BigDecimal(json['buying_power'])
+          @cash = BigDecimal(json['cash'])
+          @portfolio_value = BigDecimal(json['portfolio_value'])
           @pattern_day_trader = json['pattern_day_trader']
           @trade_suspended_by_user = json['trade_suspended_by_user']
           @trading_blocked = json['trading_blocked']
@@ -25,12 +25,12 @@ module Alpaca
           @created_at = json['created_at']
           @shorting_enabled = json['shorting_enabled']
           @multiplier = json['multiplier']
-          @long_market_value = json['long_market_value']
-          @short_market_value = json['short_market_value']
-          @equity = json['equity']
-          @last_equity = json['last_equity']
-          @initial_margin = json['initial_margin']
-          @maintenance_margin = json['maintenance_margin']
+          @long_market_value = BigDecimal(json['long_market_value'])
+          @short_market_value = BigDecimal(json['short_market_value'])
+          @equity = BigDecimal(json['equity'])
+          @last_equity = BigDecimal(json['last_equity'])
+          @initial_margin = BigDecimal(json['initial_margin'])
+          @maintenance_margin = BigDecimal(json['maintenance_margin'])
           @daytrade_count = json['daytrade_count']
           @sma = json['sma']
         end

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

@@ -8,10 +8,10 @@ module Alpaca
 
         def initialize(json)
           @time = Time.at(json['t'])
-          @open = json['o']
-          @high = json['h']
-          @low = json['l']
-          @close = json['c']
+          @open = BigDecimal(json['o'], 2)
+          @high = BigDecimal(json['h'], 2)
+          @low = BigDecimal(json['l'], 2)
+          @close = BigDecimal(json['c'], 2)
           @volume = json['v']
         end
       end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Alpaca
+  module Trade
+    module Api
+      class Calendar
+        attr_reader :date, :open, :close
+
+        def initialize(json)
+          @date = json['date']
+          @open = json['open']
+          @close = json['close']
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'date'
 require 'faraday'
 
 module Alpaca
@@ -27,6 +28,12 @@ module Alpaca
           Asset.new(JSON.parse(response.body))
         end
 
+        def assets(status: nil, asset_class: nil)
+          response = get_request(endpoint, "v2/assets", { status: status, asset_class: asset_class }.compact)
+          json = JSON.parse(response.body)
+          json.map { |item| Asset.new(item) }
+        end
+
         def bars(timeframe, symbols)
           response = get_request(data_endpoint, "v1/bars/#{timeframe}", symbols: symbols.join(','))
           json = JSON.parse(response.body)
@@ -35,8 +42,85 @@ module Alpaca
           end
         end
 
+        def calendar(start_date: Date.today, end_date: (Date.today + 30))
+          params = { "start" => start_date.iso8601, "end" => end_date.iso8601 }
+          response = get_request(endpoint, "v2/calendar", params)
+          json = JSON.parse(response.body)
+          json.map { |item| Calendar.new(item) }
+        end
+
+        def cancel_order(id:)
+          response = delete_request(endpoint, "v2/orders/#{id}")
+          raise InvalidOrderId, JSON.parse(response.body)['message'] if response.status == 404
+          raise OrderNotCancelable if response.status == 422
+        end
+
+        def clock
+          response = get_request(endpoint, 'v2/clock')
+          Clock.new(JSON.parse(response.body))
+        end
+
+        def new_order(symbol:, qty:, side:, type:, time_in_force:, limit_price: nil,
+          stop_price: nil, extended_hours:, client_order_id: nil)
+
+          params = {
+            symbol: symbol,
+            qty: qty,
+            side: side,
+            type: type,
+            time_in_force: time_in_force,
+            limit_price: limit_price,
+            stop_price: stop_price,
+            extended_hours: extended_hours,
+            client_order_id: client_order_id
+          }
+          response = post_request(endpoint, 'v2/orders', params.compact)
+          raise InsufficientFunds, JSON.parse(response.body)['message'] if response.status == 403
+          raise MissingParameters, JSON.parse(response.body)['message'] if response.status == 422
+
+          Order.new(JSON.parse(response.body))
+        end
+
+        def order(id:)
+          response = get_request(endpoint, "v2/orders/#{id}")
+          raise InvalidOrderId, JSON.parse(response.body)['message'] if response.status == 404
+
+          Order.new(JSON.parse(response.body))
+        end
+
+        def orders(status: nil, after: nil, until_time: nil, direction: nil, limit: 50)
+          params = { status: status, after: after, until: until_time, direction: direction, limit: limit }
+          response = get_request(endpoint, "v2/orders", params.compact)
+          json = JSON.parse(response.body)
+          json.map { |item| Order.new(item) }
+        end
+
+        def position(symbol: nil)
+          response = get_request(endpoint, ["v2/positions", symbol].compact.join('/'))
+          raise NoPositionForSymbol, JSON.parse(response.body)['message'] if response.status == 404
+
+          Position.new(JSON.parse(response.body))
+        end
+
+        def positions(symbol: nil)
+          response = get_request(endpoint, ["v2/positions", symbol].compact.join('/'))
+          json = JSON.parse(response.body)
+          json.map { |item| Position.new(item) }
+        end
+
         private
 
+        def delete_request(endpoint, uri)
+          conn = Faraday.new(url: endpoint)
+          response = conn.delete(uri) do |req|
+            req.headers['APCA-API-KEY-ID'] = key_id
+            req.headers['APCA-API-SECRET-KEY'] = key_secret
+          end
+
+          possibly_raise_exception(response)
+          response
+        end
+
         def get_request(endpoint, uri, params = {})
           conn = Faraday.new(url: endpoint)
           response = conn.get(uri) do |req|
@@ -45,11 +129,33 @@ module Alpaca
             req.headers['APCA-API-SECRET-KEY'] = key_secret
           end
 
-          raise UnauthorizedError, JSON.parse(response.body)['message'] if response.status == 401
-          raise RateLimitedError, JSON.parse(response.body)['message'] if response.status == 429
+          possibly_raise_exception(response)
+          response
+        end
+
+        def post_request(endpoint, uri, params = {})
+          conn = Faraday.new(url: endpoint)
+          response = conn.post(uri) do |req|
+            req.body = params.to_json
+            req.headers['APCA-API-KEY-ID'] = key_id
+            req.headers['APCA-API-SECRET-KEY'] = key_secret
+          end
 
+          possibly_raise_exception(response)
           response
         end
+
+        def possibly_raise_exception(response)
+          if response.status == 401
+            raise UnauthorizedError, JSON.parse(response.body)['message']
+          end
+          if response.status == 429
+            raise RateLimitedError, JSON.parse(response.body)['message']
+          end
+          if response.status == 500
+            raise InternalServerError, JSON.parse(response.body)['message']
+          end
+        end
       end
     end
   end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Alpaca
+  module Trade
+    module Api
+      class Clock
+        attr_reader :timestamp, :open, :next_open, :next_close
+
+        def initialize(json)
+          @timestamp = json['timestamp']
+          @open = json['open']
+          @next_open = json['next_open']
+          @next_close = json['next_close']
+        end
+      end
+    end
+  end
+end

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

@@ -4,6 +4,12 @@ module Alpaca
   module Trade
     module Api
       class Error < StandardError; end
+      class InsufficientFunds < Error; end
+      class InternalServerError < Error; end
+      class InvalidOrderId < Error; end
+      class MissingParameters < Error; end
+      class NoPositionForSymbol < Error; end
+      class OrderNotCancelable < Error; end
       class RateLimitedError < Error; end
       class UnauthorizedError < Error; end
     end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+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
+
+        def initialize(json)
+          @id = json['id']
+          @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']
+          @failed_at = json['failed_at']
+          @asset_id = json['asset_id']
+          @symbol = json['symbol']
+          @asset_class = json['asset_class']
+          @qty = json['qty']
+          @filled_qty = json['filled_qty']
+          @type = json['type']
+          @side = json['side']
+          @time_in_force = json['time_in_force']
+          @limit_price = json['limit_price']
+          @stop_price = json['stop_price']
+          @filled_avg_price = json['filled_avg_price']
+          @status = json['status']
+          @extended_hours = json['extended_hours']
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Alpaca
+  module Trade
+    module Api
+      class Position
+        attr_reader :asset_id, :symbol, :exchange, :asset_class, :avg_entry_price,
+          :qty, :side, :market_value, :cost_basis, :unrealized_pl, :unrealized_plpc,
+          :unrealized_intraday_pl, :unrealized_intraday_plpc, :current_price,
+          :lastday_price, :change_today
+
+        def initialize(json)
+          @asset_id = json['asset_id']
+          @symbol = json['symbol']
+          @exchange = json['exchange']
+          @asset_class = json['asset_class']
+          @avg_entry_price = json['avg_entry_price']
+          @qty = json['qty']
+          @side = json['side']
+          @market_value = json['market_value']
+          @cost_basis = json['cost_basis']
+          @unrealized_pl = json['unrealized_pl']
+          @unrealized_plpc = json['unrealized_plpc']
+          @unrealized_intraday_pl = json['unrealized_intraday_pl']
+          @unrealized_intraday_plpc = json['unrealized_intraday_plpc']
+          @current_price = json['current_price']
+          @lastday_price = json['lastday_price']
+          @change_today = json['change_today']
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@
 module Alpaca
   module Trade
     module Api
-      VERSION = '0.1.0'
+      VERSION = '0.2.0'
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alpaca-trade-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Cloves Carneiro Jr
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-05 00:00:00.000000000 Z
+date: 2019-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -160,9 +160,13 @@ files:
 - lib/alpaca/trade/api/account.rb
 - lib/alpaca/trade/api/asset.rb
 - lib/alpaca/trade/api/bar.rb
+- lib/alpaca/trade/api/calendar.rb
 - lib/alpaca/trade/api/client.rb
+- lib/alpaca/trade/api/clock.rb
 - lib/alpaca/trade/api/configuration.rb
 - lib/alpaca/trade/api/errors.rb
+- lib/alpaca/trade/api/order.rb
+- lib/alpaca/trade/api/position.rb
 - lib/alpaca/trade/api/version.rb
 homepage: https://github.com/ccjr/alpaca-trade-api
 licenses: