questrade_client 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 366a59daa972a8ef598f95be3ef864df3e81526e
-  data.tar.gz: 775d3d26147bf9e72c9c7655f6ee33ea707f6e69
+  metadata.gz: b18f7922f87c8f75bf1019fec336f92c0bd120eb
+  data.tar.gz: efb8e2b915e91ccb3b239133709f6cab4bc94f49
 SHA512:
-  metadata.gz: 984ff575b495ea46f623f5054231a3ba94e8fd609db0d7b06b0803603c6ebe78c1932bea35cd977c61cc2f2f12e654fce29e0c639bdd089b8d09dd14d8a4bf58
-  data.tar.gz: 8eec74ff12d70bee1a10cc20743e77a38a6e8c80307e85462e8177e0e6528f9c70f496c668f07fe168ef2f70eab3f7b61b76c254eb89c479263a35a3bd4ebb4f
+  metadata.gz: 3b14a49e7b136bf20303309f2946c1f9861d0dc4a99344d4aef418a04a5cd1e2ce5868ce00706345b8b573940a71571cf5f33d30d423b80eb6253292e7ae4b20
+  data.tar.gz: bc1c756e572bb1e88301708aed540c3c0a38229ba3d1832e64b40258cc0365c4919a3004f6c5f5339f374f11cb133bb3b146eab05b800af5a1ec96efd76d8d05

data/.gitignore

@@ -7,3 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.swp
+*.swo

data/README.md

@@ -1,3 +1,5 @@
+[![Travis CI](https://travis-ci.org/dalehamel/questrade_client.svg)](https://travis-ci.org/dalehamel/questrade_client)
+
 # QuestradeClient
 
 Set up a practice account to play around:

data/lib/questrade_client.rb

@@ -1,5 +1,6 @@
 require 'questrade_client/version'
 require 'questrade_client/client'
+require 'questrade_client/questrade'
 
 module QuestradeClient
   USER_AGENT = "questrade_client/#{QuestradeClient::VERSION}".freeze

data/lib/questrade_client/account.rb

@@ -1,5 +1,6 @@
 module QuestradeClient
   module Account
+
     # Retrieves current server time.
     #
     # Docs: http://www.questrade.com/api/documentation/rest-operations/account-calls/time
@@ -11,5 +12,82 @@ module QuestradeClient
        DateTime.parse(get('/time')['time'])
     end
 
+    # Retrieves the accounts associated with the user on behalf of which the API client is authorized.
+    #
+    # Docs: http://www.questrade.com/api/documentation/rest-operations/account-calls/accounts
+    #
+    # @return [Array[Hash]] List of accounts
+    # @example
+    #   client.accounts
+    def accounts
+      get('/accounts')['accounts']
+    end
+
+    # Retrieves positions in a specified account.
+    #
+    # Docs: http://www.questrade.com/api/documentation/rest-operations/account-calls/accounts-id-positions
+    #
+    # @return [Array[Hash]] List of positions for the account
+    # @param id [String] The ID of the account
+    # @example
+    #   client.positions(id)
+    def positions(id)
+      get("/accounts/#{id}/positions")['positions']
+    end
+
+    # Retrieves per-currency and combined balances for a specified account.
+    #
+    # Docs: http://www.questrade.com/api/documentation/rest-operations/account-calls/accounts-id-balances
+    #
+    # @return [Hash] Balance data for this account
+    # @param id [String] The ID of the account
+    # @example
+    #   client.balances(id)
+    def balances(id)
+      get("/accounts/#{id}/balances")
+    end
+
+    # Retrieves executions for a specific account.
+    #
+    # Docs: http://www.questrade.com/api/documentation/rest-operations/account-calls/accounts-id-executions
+    #
+    # FIXME: Add support for start and end time
+    # @return [Array[Hash]] List of executions
+    # @param id [String] The ID of the account
+    # @example
+    #   client.executions(id)
+    def executions(id)
+      get("/accounts/#{id}/executions")['executions']
+    end
+
+    # Retrieves orders for specified account
+    #
+    # Docs: http://www.questrade.com/api/documentation/rest-operations/account-calls/accounts-id-orders
+    #
+    # FIXME: Add support for start and end time
+    # FIXME: Add support for statefilter
+    # @return [Array[Hash]] List of orders
+    # @param id [String] The ID of the account
+    # @param orderid [String] Only retrieve the order matching the specified order ID (optional)
+    # @example
+    #   client.orders(id)
+    def orders(id, orderid = nil)
+      get("/accounts/#{id}/orders#{orderid ? "/#{orderid}" : ''}")['orders']
+    end
+
+    # Retrieve account activities, including cash transactions, dividends, trades, etc.
+    #
+    # Docs: http://www.questrade.com/api/documentation/rest-operations/account-calls/accounts-id-activities
+    #
+    # FIXME: Add support for start and end time
+    # @return [Array[Hash]] List of orders
+    # @param id [String] The ID of the account
+    # @param orderid [String] Only retrieve the order matching the specified order ID (optional)
+    # @example
+    #   client.activities(id)
+    def activities(id)
+      get("/accounts/#{id}/activities")['activities']
+    end
+
   end
 end

data/lib/questrade_client/client.rb

@@ -1,4 +1,6 @@
 require 'questrade_client/account'
+require 'questrade_client/symbol'
+require 'questrade_client/market'
 require 'faraday_middleware'
 
 module QuestradeClient
@@ -42,6 +44,8 @@ module QuestradeClient
     end
 
     include QuestradeClient::Account
+    include QuestradeClient::Symbol
+    include QuestradeClient::Market
 
     private
 

data/lib/questrade_client/market.rb

@@ -0,0 +1,87 @@
+module QuestradeClient
+  module Market
+    CANDLESTICK_INTERVALS = {
+      oneminute: 'OneMinute',           # one candlestick per 1 minute.
+      twominutes: 'TwoMinutes',         # one candlestick per 2 minutes.
+      threeminutes: 'ThreeMinutes',     # one candlestick per 3 minutes.
+      fourminutes: 'FourMinutes',       # one candlestick per 4 minutes.
+      fiveminutes: 'FiveMinutes',       # one candlestick per 5 minutes.
+      tenminutes: 'TenMinutes',         # one candlestick per 10 minutes.
+      fifteenminutes: 'FifteenMinutes', # one candlestick per 15 minutes.
+      twentyminutes: 'TwentyMinutes',   # one candlestick per 20 minutes.
+      halfhour: 'HalfHour',             # one candlestick per 30 minutes.
+      onehour: 'OneHour',               # one candlestick per 1 hour.
+      twohours: 'TwoHours',             # one candlestick per 2 hours.
+      fourhours: 'FourHours',           # one candlestick per 4 hours.
+      oneday: 'OneDay',                 # one candlestick per 1 day.
+      oneweek: 'OneWeek',               # one candlestick per 1 week.
+      onemonth: 'OneMonth',             # one candlestick per 1 month.
+      oneyear: 'OneYear'                # one candlestick per 1 year.
+    }
+
+    # Retrieves information about supported markets.
+    #
+    # Docs: http://www.questrade.com/api/documentation/rest-operations/market-calls/markets
+    #
+    # @return [Array[Hash]] List of market data
+    # @example
+    #   client.markets
+    def markets
+      get('/markets')['markets']
+    end
+
+    # Retrieves a single Level 1 market data quote for one or more symbols.
+    #
+    # Docs: http://www.questrade.com/api/documentation/rest-operations/market-calls/markets-quotes-id
+    #
+    # @return [Array[Hash]] List of market data
+    # @param args [Int|Array[Int]] The ID of the symbol, or a list of symbol ids
+    # @example
+    #   client.quotes(9292)
+    #   client.quotes([9292,8081])
+    def quotes(args)
+      if args.is_a?(Integer)
+        get("/markets/quotes/#{args}")['quotes']
+      elsif args.is_a?(Array)
+        get("/markets/quotes?ids=#{args.join(',')}")['quotes']
+      else
+        fail "Malformed argument: #{args}"
+      end
+    end
+
+    # Retrieves a single Level 1 market data quote and Greek data for one or more option symbols.
+    #
+    # Docs: http://www.questrade.com/api/documentation/rest-operations/market-calls/markets-quotes-options
+    #
+    # FIXME - implement (docs are WRONG, it's a POST, not a GET)
+    def quoteoptions()
+      fail "Not yet implemented"
+    end
+
+    # Retrieve a calculated L1 market data quote for a single or many multi-leg strategies
+    #
+    # Docs: http://www.questrade.com/api/documentation/rest-operations/market-calls/markets-quotes-strategies
+    #
+    # FIXME - implement (docs are WRONG, it's a POST, not a GET)
+    def quotestrategies()
+      fail "Not yet implemented"
+    end
+
+
+    # Retrieves historical market data in the form of OHLC candlesticks for a specified symbol.
+    # This call is limited to returning 2,000 candlesticks in a single response.
+    #
+    # Docs: http://www.questrade.com/api/documentation/rest-operations/market-calls/markets-candles-id
+    #
+    # @return [Array[Hash]] List of market data
+    # FIXME: REQUIRES start and end time
+    # @param id [Integer] the id of the symbol to retrieve candlestick data for
+    # @param interval [Symbol] the candlestick interval to use, see allowable values in CANDLESTICK_INTERVALS
+    # @example
+    #   client.candles(9292, :oneday)
+    def candles(id, interval)
+      fail "Interval #{interval} is unsupported" unless CANDLESTICK_INTERVALS.includes?(interval)
+      get("/markets/candles/#{id}?interval=#{CANDLESTICK_INTERVALS[interval]}")['quotes']
+    end
+  end
+end

data/lib/questrade_client/questrade.rb

@@ -0,0 +1 @@
+require 'questrade_client/questrade/account'

data/lib/questrade_client/questrade/account.rb

@@ -0,0 +1,21 @@
+require 'ostruct'
+class JSONSerialized < OpenStruct
+end
+
+module QuestradeClient
+  class Questrade
+
+    def initialize(refresh_token, practice = false)
+      @client = QuestradeClient.login(refresh_token, practice)
+    end
+
+    def accounts
+      @client.accounts.map do |account_data|
+        Account.new(account_data)
+      end
+    end
+
+    class Account < JSONSerialized
+    end
+  end
+end

data/lib/questrade_client/symbol.rb

@@ -0,0 +1,53 @@
+module QuestradeClient
+  module Symbol
+
+    # Retrieves the accounts associated with the user on behalf of which the API client is authorized.
+    #
+    # Docs: http://www.questrade.com/api/documentation/rest-operations/account-calls/accounts
+    #
+    # @return [Array[Hash]] List of symbol data
+    # @param args [Int|Array[Int|String]] The ID of the symbol, or a list of symbol ids or names
+    # @example
+    #   client.symbols(9292)
+    #   client.symbols(['BMO', 'SHOP', 'VTI'])
+    #   client.symbols([9292, 8089])
+    def symbols(args)
+      if args.is_a?(Integer)
+        get("/symbols/#{args}")['symbols']
+      elsif args.length > 1 && args.first.is_a?(String)
+        get("/symbols?names=#{args.join(',')}")['symbols']
+      elsif args.length > 1 && args.first.is_a?(Integer)
+        get("/symbols?ids=#{args.join(',')}")['symbols']
+      else
+        fail "Malformed argument: #{args}"
+      end
+    end
+
+    # Retrieves symbol(s) using several search criteria.
+    #
+    # Docs: http://www.questrade.com/api/documentation/rest-operations/market-calls/symbols-search
+    #
+    # @return [Array[Hash]] List of symbol data
+    # FIXME: add offset
+    # @param prefix [String] Prefix to use in search
+    # @example
+    #   client.symbolsearch('BMO')
+    def symbolsearch(prefix, offset=nil)
+        get("/symbols/search?prefix=#{prefix}")['symbols']
+    end
+
+    # Retrieves an option chain for a particular underlying symbol.
+    #
+    # Docs: http://www.questrade.com/api/documentation/rest-operations/market-calls/symbols-id-options
+    #
+    # @return [Array[Hash]] List of option chain data for symbol
+    # @param  [Integer] Symbol id to find options for
+    # @example
+    #   client.symboloptions(9292)
+    def symboloptions(symbolid)
+        get("/symbols/#{symbolid}/options")['optionChain']
+    end
+
+
+  end
+end

data/lib/questrade_client/version.rb

@@ -1,3 +1,3 @@
 module QuestradeClient
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.0.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: questrade_client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Dale Hamel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-25 00:00:00.000000000 Z
+date: 2016-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -169,9 +169,12 @@ files:
 - bin/rubocop
 - bin/setup
 - lib/questrade_client.rb
-- lib/questrade_client/.client.rb.swp
 - lib/questrade_client/account.rb
 - lib/questrade_client/client.rb
+- lib/questrade_client/market.rb
+- lib/questrade_client/questrade.rb
+- lib/questrade_client/questrade/account.rb
+- lib/questrade_client/symbol.rb
 - lib/questrade_client/version.rb
 - questrade_client.gemspec
 homepage: https://github.com/dalehamel/questrade_client