schwab-api-ruby 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2aa249e30dc900c19f003e9085db5fe33907a69156e8eef47cd669bd09364d7
-  data.tar.gz: 298dc7d7330942e8c9f89189e3552ca165038616f8a825873cc0ce227f37fff4
+  metadata.gz: be363423988093dfb91101597addfe4c045bc1433123b1ca2eec384592f5445f
+  data.tar.gz: 6e344be9f638a121e8198d1dd473f99738d7cd50cbd2e23d4d132c2acffc9551
 SHA512:
-  metadata.gz: 8807115e742d49e4eadbbb87ace49fcae2875643ca029b62788c72189276d0e5477cdef567c0a83ab00fabb8512a5605573ca5f56d0051805daeda06ae5bd55f
-  data.tar.gz: d87fd1a1704c794cf60e7eae06026f7fa79098fb17a36af3b6fd0af0d14a0ede142b2640d019203b9d17e9d21906f4468c6675f6509e23a5349ece994608eef9
+  metadata.gz: d37d7ae1dfb667ba753a29042332416a6b832216ae3516f9e8e2927f3ff3719d4c85d673ab127fd6636cc89859ba8db2994a576a0d5ad25998062e218336bfc4
+  data.tar.gz: 5985f75a67f7f75c118b20f68de6dc839eb8183cfa8f149de27f80d69d7d9801bb7510d0ee175548b329c9953282e7722f2fed737470c2b6cdbd7a672fbd555c

data/CHANGELOG.md

@@ -1,8 +1,11 @@
+Version 2.2.0
+- Add new methods: `get_account_numbers`, `get_accounts`, `get_instrument_by_cusip`, `get_transactions`
+
 Version 2.1.0
 - Enable Instrument endpoint with "projection" param so you can query for fundamentals or other data about the ticker
 
 Version 2.0.0
-- This is version 2.0.0 becuase it's a continuation of the TDAmeritradeAPI gem.
+- This is version 2.0.0 because it's a continuation of the TDAmeritradeAPI gem.
 
 Version 1.3.0.20210215
 - Added tracking of token expiration dates to instance vars

data/README.md

@@ -1,4 +1,4 @@
-# TD Ameritrade API gem for Ruby
+# Schwab API (formerly 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.
@@ -42,11 +42,74 @@ The official API is documented [here](https://developer.tdameritrade.com/apis).
 following functionality. If you would like to expand its functionality, then please submit a pull request.
 
 - [x] Authentication
-- [ ] Accounts and Trading
-- [ ] Instruments
+- [X] Accounts and Trading
+- [X] Instruments
 - [x] Price History
 - [x] Real-time Quotes
 
+The following functions correspond to the Schwab Individual Trader API specification found in the online docs:
+* get_accounts(fields=nil)
+* get_account_numbers
+* get_instrument(symbol, projection)
+* get_instrument_by_cusip(cusip)
+* get_price_history(symbol, **options)
+* get_quotes(symbols, **options)
+* get_transactions(...)
+
+# Example usage
+
+```ruby
+client = Schwab::Client.new(
+  client_id: ENV.fetch('SCHWAB_CLIENT_ID'),
+  secret: ENV.fetch('SCHWAB_SECRET'),
+  redirect_uri: ENV.fetch('SCHWAB_REDIRECT_URI'),
+  access_token: '<access token you received after running the OAuth authentication step>',
+  refresh_token: '<access token you received after running the OAuth authentication step>',
+  access_token_expires_at:,
+  refresh_token_expires_at:
+)
+
+symbols = %w[SCHW HOOD MS]
+result = client.get_quotes(symbols, fields: :quote)
+#=> {"SCHW" =>
+# {"assetMainType" => "EQUITY",
+#  "assetSubType" => "COE",
+#  "quoteType" => "NBBO",
+#  "realtime" => true,
+#  "ssid" => 1516105793,
+#  "symbol" => "SCHW",
+#  "quote" =>
+#    {"52WeekHigh" => 93.35,
+#     "52WeekLow" => 61.01,
+#     "askMICId" => "ARCX",
+#     "askPrice" => 92.0,
+#     "askSize" => 1,
+#     "askTime" => 1752276764663,
+#     "bidMICId" => "ARCX",
+#     "bidPrice" => 91.5,
+#     "bidSize" => 1,
+#     "bidTime" => 1752278152374,
+#     "closePrice" => 93.04,
+#     "highPrice" => 92.99,
+#     "lastMICId" => "ARCX",
+#     "lastPrice" => 91.8,
+#     "lastSize" => 5,
+#     "lowPrice" => 91.825,
+#     "mark" => 91.97,
+#     "markChange" => -1.07,
+#     "markPercentChange" => -1.15004299,
+#     "netChange" => -1.24,
+#     "netPercentChange" => -1.3327601,
+#     "openPrice" => 92.53,
+#     "postMarketChange" => -0.17,
+#     "postMarketPercentChange" => -0.18484288,
+#     "quoteTime" => 1752278152374,
+#     "securityStatus" => "Normal",
+#     "totalVolume" => 6815842,
+#     "tradeTime" => 1752277607998}}}
+```
+
+
 ## 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
@@ -62,4 +125,4 @@ Please open an issue on Github if you have any problems or questions.
 
 ## Release Notes
 
-See CHANGELOG.md
+See CHANGELOG.md

data/lib/schwab/client.rb

@@ -2,9 +2,12 @@ require 'schwab/authentication'
 require 'schwab/client'
 require 'schwab/error'
 require 'schwab/version'
+require 'schwab/operations/get_accounts'
+require 'schwab/operations/get_account_numbers'
 require 'schwab/operations/get_instrument'
 require 'schwab/operations/get_price_history'
 require 'schwab/operations/get_quotes'
+require 'schwab/operations/get_transactions'
 
 module Schwab
   class Client
@@ -21,10 +24,22 @@ module Schwab
       @redirect_uri = args[:redirect_uri] || raise_error('redirect_uri is required!')
     end
 
+    def get_accounts(fields=nil)
+      Operations::GetAccounts.new(self).call(fields:)
+    end
+
+    def get_account_numbers
+      Operations::GetAccountNumbers.new(self).call
+    end
+
     def get_instrument(symbol, projection)
       Operations::GetInstrument.new(self).call(symbol, projection:)
     end
 
+    def get_instrument_by_cusip(cusip)
+      Operations::GetInstrumentByCusip.new(self).call(cusip)
+    end
+
     def get_price_history(symbol, **options)
       Operations::GetPriceHistory.new(self).call(symbol, **options)
     end
@@ -33,5 +48,8 @@ module Schwab
       Operations::GetQuotes.new(self).call(symbols:, **options)
     end
 
+    def get_transactions(...)
+      Operations::GetTransactions.new(self).call(...)
+    end
   end
 end

data/lib/schwab/error.rb

@@ -8,6 +8,9 @@ module Schwab
   class NotAuthorizedError < StandardError
   end
 
+  class BadRequestError < StandardError
+  end
+
   module Error
     module_function
 

data/lib/schwab/operations/base_operation.rb

@@ -27,6 +27,8 @@ module Schwab
           raise Schwab::RateLimitError.new(response.body)
         elsif response.code == 401
           raise Schwab::NotAuthorizedError.new(response.body)
+        elsif response.code == 404
+          raise Schwab::BadRequestError.new(response.body)
         end
 
         error_message = response['errors'].to_s
@@ -41,7 +43,7 @@ module Schwab
         raise ArgumentError unless response.is_a?(HTTParty::Response)
         handle_api_error(response) unless response_success?(response)
 
-        response.to_h
+        JSON.parse(response.body)
       end
 
       def perform_api_get_request(url: , query: nil)

data/lib/schwab/operations/get_account_numbers.rb

@@ -0,0 +1,11 @@
+require 'schwab/operations/base_operation'
+
+module Schwab; module Operations
+  class GetAccountNumbers < BaseOperation
+
+    def call
+      perform_api_get_request(url: 'https://api.schwabapi.com/trader/v1/accounts/accountNumbers')
+    end
+
+  end
+end; end

data/lib/schwab/operations/get_accounts.rb

@@ -0,0 +1,106 @@
+require 'schwab/operations/base_operation'
+
+module Schwab; module Operations
+  class GetAccounts < BaseOperation
+
+    # Example Response:
+    # [
+    #   {
+    #     "securitiesAccount": {
+    #       "type": "CASH",
+    #       "accountNumber": "<account1>",
+    #       "roundTrips": 0,
+    #       "isDayTrader": false,
+    #       "isClosingOnlyRestricted": false,
+    #       "pfcbFlag": false,
+    #       "positions": [
+    #         {
+    #           "shortQuantity": 0,
+    #           "averagePrice": 13.4,
+    #           "currentDayProfitLoss": -31.59,
+    #           "currentDayProfitLossPercentage": -5.44,
+    #           "longQuantity": 39,
+    #           "settledLongQuantity": 39,
+    #           "settledShortQuantity": 0,
+    #           "instrument": {
+    #             "assetType": "EQUITY",
+    #             "cusip": "83406F102",
+    #             "symbol": "SOFI",
+    #             "netChange": -0.8
+    #           },
+    #           "marketValue": 549.51,
+    #           "maintenanceRequirement": 0,
+    #           "averageLongPrice": 13.4,
+    #           "taxLotAverageLongPrice": 13.4,
+    #           "longOpenProfitLoss": 26.91,
+    #           "previousSessionLongQuantity": 39,
+    #           "currentDayCost": 0
+    #         },
+    #       ],
+    #       "initialBalances": {
+    #         "accruedInterest": 0,
+    #         "cashAvailableForTrading": 1561.98,
+    #         "cashAvailableForWithdrawal": 1561.98,
+    #         "cashBalance": 1561.98,
+    #         "bondValue": 0,
+    #         "cashReceipts": 0,
+    #         "liquidationValue": 8566.46,
+    #         "longOptionMarketValue": 0,
+    #         "longStockValue": 7004.48,
+    #         "moneyMarketFund": 0,
+    #         "mutualFundValue": 1561.98,
+    #         "shortOptionMarketValue": 0,
+    #         "shortStockValue": 0,
+    #         "isInCall": false,
+    #         "unsettledCash": 0,
+    #         "cashDebitCallValue": 0,
+    #         "pendingDeposits": 0,
+    #         "accountValue": 8566.46
+    #       },
+    #       "currentBalances": {
+    #         "accruedInterest": 0,
+    #         "cashBalance": 1561.98,
+    #         "cashReceipts": 0,
+    #         "longOptionMarketValue": 0,
+    #         "liquidationValue": 8566.46,
+    #         "longMarketValue": 7004.48,
+    #         "moneyMarketFund": 0,
+    #         "savings": 0,
+    #         "shortMarketValue": 0,
+    #         "pendingDeposits": 0,
+    #         "mutualFundValue": 0,
+    #         "bondValue": 0,
+    #         "shortOptionMarketValue": 0,
+    #         "cashAvailableForTrading": 1561.98,
+    #         "cashAvailableForWithdrawal": 1561.98,
+    #         "cashCall": 0,
+    #         "longNonMarginableMarketValue": 1561.98,
+    #         "totalCash": 1561.98,
+    #         "cashDebitCallValue": 0,
+    #         "unsettledCash": 0
+    #       },
+    #       "projectedBalances": {
+    #         "cashAvailableForTrading": 1561.98,
+    #         "cashAvailableForWithdrawal": 1561.98
+    #       }
+    #     },
+    #     "aggregatedBalance": {
+    #       "currentLiquidationValue": 8566.46,
+    #       "liquidationValue": 8566.46
+    #     }
+    #   },
+    def call(fields: 'positions')
+      params = {
+        fields:,
+      }
+
+      response = perform_api_get_request(
+        url: 'https://api.schwabapi.com/trader/v1/accounts',
+        query: params,
+        )
+
+      response
+    end
+
+  end
+end; end

data/lib/schwab/operations/get_instrument.rb

@@ -3,7 +3,11 @@ require 'schwab/operations/base_operation'
 module Schwab; module Operations
   class GetInstrument < BaseOperation
 
+    PROJECTIONS = %w[symbol-search symbol-regex desc-search desc-regex search fundamental]
+
     def call(symbols, projection:)
+      raise ArgumentError, "projection must be in #{PROJECTIONS}" unless PROJECTIONS.include?(projection)
+
       symbol = symbols.is_a?(Array) ? symbols.join(',') : symbols
 
       params = {

data/lib/schwab/operations/get_instrument_by_cusip.rb

@@ -0,0 +1,11 @@
+require 'schwab/operations/base_operation'
+
+module Schwab; module Operations
+  class GetInstrumentByCusip < BaseOperation
+
+    def call(cusip)
+      perform_api_get_request(url: "https://api.schwabapi.com/marketdata/v1/instruments/#{cusip}")
+    end
+
+  end
+end; end

data/lib/schwab/operations/get_transactions.rb

@@ -0,0 +1,44 @@
+require 'schwab/operations/base_operation'
+
+module Schwab; module Operations
+  class GetTransactions < BaseOperation
+
+    TYPES = %w[
+      TRADE
+      RECEIVE_AND_DELIVER
+      DIVIDEND_OR_INTEREST
+      ACH_RECEIPT
+      ACH_DISBURSEMENT
+      CASH_RECEIPT
+      CASH_DISBURSEMENT
+      ELECTRONIC_FUND
+      WIRE_OUT
+      WIRE_IN
+      JOURNAL
+      MEMORANDUM
+      MARGIN_CALL
+      MONEY_MARKET
+      SMA_ADJUSTMENT
+    ]
+
+    def call(account_number:, start_date:, end_date:, types:, symbol: nil)
+      raise(ArgumentError, "types must be one of #{TYPES}") unless TYPES.include?(types)
+      raise(ArgumentError, "start_date and end_date must be Time") unless [start_date, end_date].all?(Time)
+
+      params = {
+        startDate: start_date.utc.iso8601,
+        endDate: end_date.utc.iso8601,
+        types:,
+      }
+      params.merge!(symbol:) if symbol
+
+      response = perform_api_get_request(
+        url: "https://api.schwabapi.com/trader/v1/accounts/#{account_number}/transactions",
+        query: params,
+        )
+
+      response
+    end
+
+  end
+end; end

data/lib/schwab/version.rb

@@ -1,3 +1,3 @@
 module Schwab
-  VERSION = '2.1.0'
+  VERSION = '2.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schwab-api-ruby
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Winston Kotzan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-15 00:00:00.000000000 Z
+date: 2025-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,9 +114,13 @@ files:
 - lib/schwab/client.rb
 - lib/schwab/error.rb
 - lib/schwab/operations/base_operation.rb
+- lib/schwab/operations/get_account_numbers.rb
+- lib/schwab/operations/get_accounts.rb
 - lib/schwab/operations/get_instrument.rb
+- lib/schwab/operations/get_instrument_by_cusip.rb
 - lib/schwab/operations/get_price_history.rb
 - lib/schwab/operations/get_quotes.rb
+- lib/schwab/operations/get_transactions.rb
 - lib/schwab/operations/support/build_watchlist_items.rb
 - lib/schwab/util.rb
 - lib/schwab/version.rb