schwab-api-ruby 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b9659741b90ac05d0426da9e7ff4c6d3a03a205deeb2901d3ec97b9a8dd39165
+  data.tar.gz: 5d27d65ef5d09158b61d41d621db97869cd137d11912d339fa0ff3cbea71258e
+SHA512:
+  metadata.gz: 3f5c84e4f946111c19adc93b4d73a2d3c4c45edfd397b9f6ec3ee05e1632f18695d0c311e6fd4d07442f2bd0d7604fda875056c09a55c496b721a4bcfddc0919
+  data.tar.gz: a9ae1f55fd29ff52d032463b8e0d28ab50f51576957e78d98aefa3c7c9a15ee9e6a020dac4fec5d59d24183c24d448665a5019a6920206a45ddfd2e8321aef4a

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.idea
+.DS_STORE
+spec/test_data/sample_stream_rspec_test.binary
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+spec/test_data/sample_stream_archives
+test/tmp
+test/version_tmp
+tmp
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/CHANGELOG.md

@@ -0,0 +1,32 @@
+Version 2.0.0
+- This is version 2.0.0 becuase it's a continuation of the TDAmeritradeAPI gem.
+
+Version 1.3.0.20210215
+- Added tracking of token expiration dates to instance vars
+- API request results are now returned as a Hashie::Mash to make 'quotes' or :symbol reference of values indifferent
+- Corrected incorrect date submission in create watchlist operation
+
+Verion 1.2.0.20190915
+- (Breaking change) Make get_price_history return datetime stamp as Ruby Time vs milliseconds since epoch  
+
+Verion 1.1.1.20190915
+- Fix incorrect formatting when using startdate and enddate in get_price_history 
+
+Version 1.1.0 8/28/19
+- Enhance error messages for rate limit and invalid token
+
+Version 1.0 8/27/19
+- Change structure internally to use dependency injection of oprations
+- Price history feature
+- Real time quotes feature
+- Added RSpec test coverage
+
+Version 0.2.alpha 
+- Basic Watchlist retrieval and modification
+
+Version 0.1.alpha - 11/29/2018
+- Initial, very basic release
+- Authentication: refresh access token by refresh_token
+- Instruments: get fundamentals
+
+

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in schwab_api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 wkotzan
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# TD Ameritrade API gem for Ruby
+
+This is a gem for connecting to the OAuth/JSON-based Schwab API released in 2018. Go to
+https://beta-developer.schwab.com/ to create your OAuth application login and view the official documentation.
+
+For a gem that allows you to connect to the older version of the TDAmeritrade API, go to 
+https://github.com/wakproductions/tdameritrade_api
+
+## Installation
+
+In your Gemfile
+
+`gem 'schwab-api-ruby', git: 'https://github.com/wakproductions/schwab-api-ruby.git'`
+
+## Authenticating
+
+Currently this gem is designed for local app authorization of the "Trader API - Individual". It is based on the
+assumption that you will be using https://127.0.0.1 as the OAuth redirect_uri, as that is the only value that's
+been tested and verified to work
+
+## Basic Usage
+
+```
+client = SchwabAPI::Client.new(
+  client_id: <client_id>, 
+  redirect_uri: 'https://127.0.0.1', 
+  refresh_token: '<refresh_token>'
+)
+
+client.get_instrument_fundamentals('MSFT')
+#=> {"MSFT"=>
+      {"fundamental"=>
+        {"symbol"=>"MSFT",
+         "high52"=>425.24,
+         "low52"=>340.33,
+         ...
+```
+
+# Current State of Functionality
+
+The official API is documented [here](https://developer.tdameritrade.com/apis). This gem currently implements the
+following functionality. If you would like to expand its functionality, then please submit a pull request.
+
+- [x] Authentication
+- [ ] Accounts and Trading
+- [ ] Instruments
+- [x] Price History
+- [x] Real-time Quotes
+
+## Contributions
+
+If you would like to make a contribution, please submit a pull request to the original branch. Feel free to email me Winston Kotzan
+at wak@wakproductions.com with any feature requests, bug reports, or feedback.
+
+#### Wish List
+
+* Test Coverage in RSpec
+
+## Support
+
+Please open an issue on Github if you have any problems or questions.
+
+## Release Notes
+
+See CHANGELOG.md

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'schwab-api-ruby'
+
+# This is just a placeholder
+# task :taskname do
+#   # perform logic
+# end
+

data/lib/schwab/authentication.rb

@@ -0,0 +1,87 @@
+require 'schwab/util'
+require 'httparty'
+
+module Schwab
+  module Authentication
+    include Util
+
+    attr_reader :client_id, :secret, :redirect_uri, :authorization_code, :access_token, :refresh_token,
+                :access_token_expires_at, :refresh_token_expires_at
+
+    def authorization_header_token
+      client_id_and_secret = "#{client_id}:#{secret}"
+      Base64.strict_encode64(client_id_and_secret)
+    end
+
+    def default_headers
+      {
+        'Content-Type': 'application/x-www-form-urlencoded',
+        'Authorization': "Basic #{authorization_header_token}"
+      }
+    end
+
+    # Return value looks like:
+    #     {"expires_in"=>1800,
+    #      "token_type"=>"Bearer",
+    #      "scope"=>"api",
+    #      "refresh_token"=>"LGGun...",
+    #      "access_token"=>"I0.b2F...@",
+    #      "id_token"=>"eyJ0eXA..."}
+    def request_access_token(authorization_grant_code)
+      # headers = { 'Content-Type': 'application/x-www-form-urlencoded' } # turns out didn't need this
+      options = {
+        body: {
+          'grant_type': 'authorization_code',
+          'code': authorization_grant_code,
+          'redirect_uri': redirect_uri
+        },
+        headers: default_headers
+      }
+
+      response = HTTParty.post(
+        'https://api.schwabapi.com/v1/oauth/token',
+        options
+      )
+
+      unless response_success?(response)
+        raise Schwab::Error::SchwabAPIError.new(
+          "Unable to retrieve access tokens from API - #{response.code} - #{response.body}"
+        )
+      end
+
+      update_tokens(response)
+      response
+    end
+
+    def refresh_access_token
+      options = {
+        body: {
+          grant_type: 'refresh_token',
+          refresh_token: refresh_token,
+        },
+        headers: default_headers
+      }
+
+      response = HTTParty.post(
+        'https://api.schwabapi.com/v1/oauth/token',
+        options
+      )
+
+      update_tokens(response)
+      response
+    end
+
+    private
+
+    def update_tokens(args={})
+      raise_error("#{args['error']} - #{args['error_description']}") if args.has_key?('error')
+
+      @access_token = args['access_token']
+      @refresh_token = args['refresh_token']
+      @access_token_expires_at = Time.now + args['expires_in'].to_i
+      @refresh_token_expires_at = 7.days.from_now
+
+      args
+    end
+  end
+end

data/lib/schwab/client.rb

@@ -0,0 +1,37 @@
+require 'schwab/authentication'
+require 'schwab/client'
+require 'schwab/error'
+require 'schwab/version'
+# require 'schwab/operations/get_instrument_fundamentals'
+require 'schwab/operations/get_price_history'
+require 'schwab/operations/get_quotes'
+
+module Schwab
+  class Client
+    include Schwab::Authentication
+    include Schwab::Error
+
+    def initialize(**args)
+      @access_token = args[:access_token]
+      @refresh_token = args[:refresh_token]
+      @access_token_expires_at = args[:access_token_expires_at]
+      @refresh_token_expires_at = args[:refresh_token_expires_at]
+      @client_id = args[:client_id] || raise_error('client_id is required!')
+      @secret = args[:secret] || raise_error('client_id is required!')
+      @redirect_uri = args[:redirect_uri] || raise_error('redirect_uri is required!')
+    end
+
+    # def get_instrument_fundamentals(symbol)
+    #   Operations::GetInstrumentFundamentals.new(self).call(symbol)
+    # end
+
+    def get_price_history(symbol, **options)
+      Operations::GetPriceHistory.new(self).call(symbol, **options)
+    end
+
+    def get_quotes(symbols, **options)
+      Operations::GetQuotes.new(self).call(symbols:, **options)
+    end
+
+  end
+end

data/lib/schwab/error.rb

@@ -0,0 +1,20 @@
+module Schwab
+  class APIError < StandardError
+  end
+
+  class RateLimitError < StandardError
+  end
+
+  class NotAuthorizedError < StandardError
+  end
+
+  module Error
+    module_function
+
+    def raise_error(message, klass=Schwab::APIError)
+      error = klass.new(message)
+      error.set_backtrace(caller)
+      raise error
+    end
+  end
+end

data/lib/schwab/operations/base_operation.rb

@@ -0,0 +1,67 @@
+require 'schwab/error'
+require 'schwab/util'
+
+module Schwab
+  module Operations
+    class BaseOperation
+      include Schwab::Error
+      include Util
+
+      HTTP_DEBUG_OUTPUT=ENV['DEBUG_OUTPUT'] # to make live testing easier
+
+      attr_reader :client
+
+      def initialize(client)
+        @client = client  # inject dependency of client credentials
+      end
+
+      private
+
+      def debug_output?
+        HTTP_DEBUG_OUTPUT.to_s == 'true'
+      end
+
+      def handle_api_error(response)
+        # "Individual App's transactions per seconds restriction, please update to commercial apps for unrestricted tps"
+        if response.code == 429
+          raise Schwab::RateLimitError.new(response.body)
+        elsif response.code == 401
+          raise Schwab::NotAuthorizedError.new(response.body)
+        end
+
+        error_message = response['errors'].to_s
+        raise Schwab::APIError.new("#{response.code}: #{error_message}")
+      rescue JSON::ParserError
+        raise Schwab::APIError.new(
+          "Unable to parse error response from Schwab API: #{response.code} - #{response.body} | #{response}"
+        )
+      end
+
+      def parse_response(response)
+        raise ArgumentError unless response.is_a?(HTTParty::Response)
+        handle_api_error(response) unless response_success?(response)
+
+        response.to_h
+      end
+
+      def perform_api_get_request(url: , query: nil)
+        options = {
+          headers: {
+            'Authorization': "Bearer #{client.access_token}",
+            'Accept': "application/json"
+          }
+        }
+        options.merge!(query: query) if query
+        options.merge!(debug_output: $stdout) if debug_output?
+
+        response = HTTParty.get(
+          url,
+          options
+        )
+
+        parse_response(response)
+      end
+
+    end
+  end
+end

data/lib/schwab/operations/get_instrument_fundamentals.rb

@@ -0,0 +1,23 @@
+# require 'schwab/operations/base_operation'
+#
+# module Schwab
+#   ; module Operations
+#   class GetInstrumentFundamentals < BaseOperation
+#
+#     def call(symbol)
+#       params = {
+#         apikey: client.client_id,
+#         symbol: symbol,
+#         projection: 'fundamental'
+#       }
+#
+#       response = perform_api_get_request(
+#         url: 'https://api.tdameritrade.com/v1/instruments',
+#         query: params,
+#       )
+#
+#       parse_api_response(response)
+#     end
+#
+#   end
+# end; end

data/lib/schwab/operations/get_price_history.rb

@@ -0,0 +1,54 @@
+require 'schwab/operations/base_operation'
+
+module Schwab; module Operations
+  class GetPriceHistory < BaseOperation
+
+    # Not used right now, but can be used later on for validation
+    FREQUENCY_TYPE=[:minute, :daily, :weekly, :monthly]
+    PERIOD_TYPE=[:day, :month, :year, :ytd]
+
+    def call(
+      symbol,
+      period_type: nil,
+      period: nil,
+      frequency_type: nil,
+      frequency: nil,
+      end_date: nil, # should be a Date
+      start_date: nil, # should be a Date
+      need_extended_hours_data: false
+    )
+      raise(ArgumentError, "Can't use period if using start_date/end_date") if start_date.present? && period.present?
+
+      params = {
+        needExtendedHoursData: need_extended_hours_data,
+        symbol: symbol
+      }
+
+      params.merge!(frequencyType: frequency_type) if frequency_type
+      params.merge!(frequency: frequency) if frequency
+
+      params.merge!(periodType: period_type) if period_type
+      params.merge!(period: period) if period
+      params.merge!(startDate: "#{start_date.strftime('%s')}000") if start_date
+      params.merge!(endDate: "#{end_date.strftime('%s')}000") if end_date
+
+      response = perform_api_get_request(
+        url: 'https://api.schwabapi.com/marketdata/v1/pricehistory',
+        query: params,
+      )
+
+      if response["candles"]
+        response["candles"].map do |candle|
+          if candle["datetime"].is_a? Numeric
+            candle["datetime"] = Time.at(candle["datetime"] / 1000)
+          end
+        end
+      end
+
+      response
+    end
+
+    private
+
+  end
+end; end

data/lib/schwab/operations/get_quotes.rb

@@ -0,0 +1,23 @@
+require 'schwab/operations/base_operation'
+
+module Schwab; module Operations
+  class GetQuotes < BaseOperation
+
+    FIELDS = %i[quote fundamental]
+
+    def call(symbols: [], fields: nil)
+      raise(ArgumentError, 'fields must be :quote or :fundamental') if fields.present? && FIELDS.exclude?(fields)
+
+      params = {
+        symbols: symbols.join(','),
+      }
+      params.merge!(fields:) if fields.present?
+
+      perform_api_get_request(
+        url: "https://api.schwabapi.com/marketdata/v1/quotes",
+        query: params,
+      )
+    end
+
+  end
+end; end

data/lib/schwab/operations/support/build_watchlist_items.rb

@@ -0,0 +1,22 @@
+module Schwab
+  ; module Operations; module Support
+  module BuildWatchlistItems
+
+    # This gem only supports EQUITY type, even though there is a lot more you can do with the API
+    def build_watchlist_items(symbol_list)
+      symbol_list.map do |symbol|
+        {
+          "quantity": 0,
+          "averagePrice": 0,
+          "commission": 0,
+          "purchasedDate": (Date.today).strftime('%Y-%m-%d'),
+          "instrument": {
+            "symbol": symbol,
+            "assetType": "EQUITY"
+          }
+        }
+      end
+    end
+
+  end
+end; end; end

data/lib/schwab/util.rb

@@ -0,0 +1,12 @@
+require 'schwab/error'
+
+module Schwab
+  module Util
+    module_function
+
+    def response_success?(response)
+      response.code.to_s =~ /^2\d\d/
+    end
+
+  end
+end

data/lib/schwab/version.rb

@@ -0,0 +1,3 @@
+module Schwab
+  VERSION = '2.0.0'
+end

data/lib/schwab-api-ruby.rb

@@ -0,0 +1 @@
+require 'schwab'

data/lib/schwab.rb

@@ -0,0 +1,7 @@
+require 'httparty'
+
+require 'schwab/client'
+require 'schwab/version'
+
+module Schwab
+end

data/schwab-api-ruby.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'schwab/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "schwab-api-ruby"
+  spec.version       = Schwab::VERSION
+  spec.authors       = ["Winston Kotzan"]
+  spec.email         = ["wak@wakproductions.com"]
+  spec.summary       = %q{This is a simple gem for connecting to the Schwab OAuth API}
+  spec.description   = "This is a gem for connecting to the OAuth/JSON-based Schwab API. See "
+      "https://beta-developer.schwab.com/ for the official documentation and to create your developer account."
+  spec.homepage      = "https://github.com/wakproductions/schwab-api-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = [`git ls-files`.split($/)] + Dir["lib/**/*"]
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "bundler", ">= 2.0"
+  spec.add_dependency "rake"
+  spec.add_dependency "httparty", ">= 0.20"
+
+  spec.add_development_dependency "rspec", ">= 3.2"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "webmock"
+end