iex-ruby-client 1.1.0 → 1.4.0

data/lib/iex/endpoints/price.rb

@@ -2,7 +2,7 @@ module IEX
   module Endpoints
     module Price
       def price(symbol, options = {})
-        get("stock/#{symbol}/price", options)
+        get("stock/#{symbol}/price", { token: publishable_token }.merge(options))
       rescue Faraday::ResourceNotFound => e
         raise IEX::Errors::SymbolNotFoundError.new(symbol, e.response[:body])
       end

data/lib/iex/endpoints/quote.rb

@@ -2,7 +2,7 @@ module IEX
   module Endpoints
     module Quote
       def quote(symbol, options = {})
-        IEX::Resources::Quote.new(get("stock/#{symbol}/quote", options))
+        IEX::Resources::Quote.new(get("stock/#{symbol}/quote", { token: publishable_token }.merge(options)))
       rescue Faraday::ResourceNotFound => e
         raise IEX::Errors::SymbolNotFoundError.new(symbol, e.response[:body])
       end

data/lib/iex/endpoints/ref_data.rb

@@ -0,0 +1,22 @@
+module IEX
+  module Endpoints
+    module RefData
+      def ref_data_isin(isins, options = {})
+        response = get('ref-data/isin', { token: publishable_token, isin: Array(isins).join(',') }.merge(options))
+
+        if response.is_a?(Hash) # mapped option was set
+          response.transform_values do |rows|
+            rows&.map { |row| IEX::Resources::Symbol.new(row) }
+          end
+        else
+          response.map { |row| IEX::Resources::Symbol.new(row) }
+        end
+      end
+
+      def ref_data_symbols(options = {})
+        response = get('ref-data/symbols', { token: publishable_token }.merge(options))
+        response.map { |row| IEX::Resources::Symbols.new(row) }
+      end
+    end
+  end
+end

data/lib/iex/endpoints/sectors.rb

@@ -6,7 +6,7 @@ module IEX
           'stock',
           symbol,
           'sector-performance'
-        ].compact.join('/'), options).map do |data|
+        ].compact.join('/'), { token: publishable_token }.merge(options)).map do |data|
           IEX::Resources::Sectors.new(data)
         end
       rescue Faraday::ResourceNotFound => e

data/lib/iex/endpoints/stock_market.rb

@@ -0,0 +1,11 @@
+module IEX
+  module Endpoints
+    module StockMarket
+      def stock_market_list(list_type, options = {})
+        get("stock/market/list/#{list_type}", { token: publishable_token }.merge(options)).map do |data|
+          IEX::Resources::Quote.new(data)
+        end
+      end
+    end
+  end
+end

data/lib/iex/resources.rb

@@ -1,9 +1,13 @@
 require_relative 'resources/resource'
 
+require_relative 'resources/advanced_stats'
+require_relative 'resources/balance_sheet'
+require_relative 'resources/cash_flow'
 require_relative 'resources/chart'
 require_relative 'resources/company'
 require_relative 'resources/dividends'
 require_relative 'resources/earnings'
+require_relative 'resources/historical_prices'
 require_relative 'resources/income'
 require_relative 'resources/key_stats'
 require_relative 'resources/largest_trades'
@@ -13,3 +17,5 @@ require_relative 'resources/ohlc'
 require_relative 'resources/quote'
 require_relative 'resources/sectors'
 require_relative 'resources/crypto'
+require_relative 'resources/symbol'
+require_relative 'resources/symbols'

data/lib/iex/resources/advanced_stats.rb

@@ -0,0 +1,84 @@
+module IEX
+  module Resources
+    class AdvancedStats < Resource
+      property 'total_cash', from: 'totalCash'
+      property 'total_cash_dollars', from: 'totalCash', with: ->(v) { Resource.to_dollar(amount: v) }
+      property 'current_debt', from: 'currentDebt'
+      property 'current_debt_dollars', from: 'currentDebt', with: ->(v) { Resource.to_dollar(amount: v) }
+      property 'revenue'
+      property 'revenue_dollars', from: 'revenue', with: ->(v) { Resource.to_dollar(amount: v) }
+      property 'gross_profit', from: 'grossProfit'
+      property 'gross_profit_dollar', from: 'grossProfit', with: ->(v) { Resource.to_dollar(amount: v) }
+      property 'total_revenue', from: 'totalRevenue'
+      property 'total_revenue_dollar', from: 'totalRevenue', with: ->(v) { Resource.to_dollar(amount: v) }
+      property 'ebitda', from: 'EBITDA'
+      property 'ebitda_dollar', from: 'EBITDA', with: ->(v) { Resource.to_dollar(amount: v) }
+      property 'revenue_per_share', from: 'revenuePerShare'
+      property 'revenue_per_share_dollars', from: 'revenuePerShare', with: ->(v) { Resource.to_dollar(amount: v) }
+      property 'revenue_per_employee', from: 'revenuePerEmployee'
+      property 'revenue_per_employee_dollar', from: 'revenuePerEmployee', with: ->(v) { Resource.to_dollar(amount: v) }
+      property 'debt_to_equity', from: 'debtToEquity'
+      property 'profit_margin', from: 'profitMargin'
+      property 'enterprise_value', from: 'enterpriseValue'
+      property 'enterprise_value_dollar', from: 'enterpriseValue', with: ->(v) { Resource.to_dollar(amount: v) }
+      property 'enterprise_value_to_revenue', from: 'enterpriseValueToRevenue'
+      property 'price_to_sales', from: 'priceToSales'
+      property 'price_to_sales_dollar', from: 'priceToSales', with: ->(v) { Resource.to_dollar(amount: v) }
+      property 'price_to_book', from: 'priceToBook'
+      property 'forward_pe_ratio', from: 'forwardPERatio'
+      property 'pe_high', from: 'peHigh'
+      property 'pe_low', from: 'peLow'
+      property 'peg_ratio', from: 'pegRatio'
+      property 'week_52_high_date', from: 'week52highDate'
+      property 'week_52_low_date', from: 'week52lowDate'
+      property 'beta'
+      property 'put_call_ratio', from: 'putCallRatio'
+      property 'company_name', from: 'companyName'
+      property 'market_cap', from: 'marketcap'
+      property 'market_cap_dollar', from: 'marketcap', with: ->(v) { Resource.to_dollar(amount: v) }
+      property 'week_52_high', from: 'week52high'
+      property 'week_52_high_dollar', from: 'week52high', with: ->(v) { Resource.to_dollar(amount: v, ignore_cents: false) }
+      property 'week_52_low', from: 'week52low'
+      property 'week_52_low_dollar', from: 'week52low', with: ->(v) { Resource.to_dollar(amount: v, ignore_cents: false) }
+      property 'week_52_change', from: 'week52change'
+      property 'week_52_change_dollar', from: 'week52change', with: ->(v) { Resource.to_dollar(amount: v, ignore_cents: false) }
+      property 'dividend_yield', from: 'dividendYield'
+      property 'ex_dividend_date', from: 'exDividendDate'
+      property 'shares_outstanding', from: 'sharesOutstanding'
+      property 'float'
+      property 'ttm_eps', from: 'ttmEPS'
+      property 'day_200_moving_avg', from: 'day200MovingAvg'
+      property 'day_50_moving_avg', from: 'day50MovingAvg'
+      property 'year_5_change_percent', from: 'year5ChangePercent'
+      property 'year_5_change_percent_s', from: 'year5ChangePercent', with: ->(v) { Resource.float_to_percentage(v) }
+      property 'year_2_change_percent', from: 'year2ChangePercent'
+      property 'year_2_change_percent_s', from: 'year2ChangePercent', with: ->(v) { Resource.float_to_percentage(v) }
+      property 'year_1_change_percent', from: 'year1ChangePercent'
+      property 'year_1_change_percent_s', from: 'year1ChangePercent', with: ->(v) { Resource.float_to_percentage(v) }
+      property 'ytd_change_percent', from: 'ytdChangePercent'
+      property 'ytd_change_percent_s', from: 'ytdChangePercent', with: ->(v) { Resource.float_to_percentage(v) }
+      property 'month_6_change_percent', from: 'month6ChangePercent'
+      property 'month_6_change_percent_s', from: 'month6ChangePercent', with: ->(v) { Resource.float_to_percentage(v) }
+      property 'month_3_change_percent', from: 'month3ChangePercent'
+      property 'month_3_change_percent_s', from: 'month3ChangePercent', with: ->(v) { Resource.float_to_percentage(v) }
+      property 'month_1_change_percent', from: 'month1ChangePercent'
+      property 'month_1_change_percent_s', from: 'month1ChangePercent', with: ->(v) { Resource.float_to_percentage(v) }
+      property 'day_5_change_percent', from: 'day5ChangePercent'
+      property 'day_5_change_percent_s', from: 'day5ChangePercent', with: ->(v) { Resource.float_to_percentage(v) }
+      property 'employees'
+      property 'avg_10_volume', from: 'avg10Volume'
+      property 'avg_30_volume', from: 'avg30Volume'
+      property 'ttm_dividend_rate', from: 'ttmDividendRate'
+      property 'max_change_percent', from: 'maxChangePercent'
+      property 'day_30_change_percent', from: 'day30ChangePercent'
+      property 'day_30_change_percent_s', from: 'day30ChangePercent', with: ->(v) { Resource.float_to_percentage(v) }
+      property 'next_dividend_date', from: 'nextDividendDate'
+      property 'next_earnings_date', from: 'nextEarningsDate'
+      property 'pe_ratio', from: 'peRatio'
+
+      def initialize(data = {})
+        super
+      end
+    end
+  end
+end

data/lib/iex/resources/balance_sheet.rb

@@ -0,0 +1,60 @@
+module IEX
+  module Resources
+    class BalanceSheet < Resource
+      property 'report_date', from: 'reportDate'
+      property 'fiscal_date', from: 'fiscalDate'
+      property 'currency'
+      property 'current_cash', from: 'currentCash'
+      property 'current_cash_dollar', from: 'currentCash', with: ->(v) { to_dollar(amount: v) }
+      property 'short_term_investments', from: 'shortTermInvestments'
+      property 'short_term_investments_dollar', from: 'shortTermInvestments', with: ->(v) { to_dollar(amount: v) }
+      property 'receivables'
+      property 'receivables_dollar', from: 'receivables', with: ->(v) { to_dollar(amount: v) }
+      property 'inventory'
+      property 'inventory_dollar', from: 'inventory', with: ->(v) { to_dollar(amount: v) }
+      property 'other_current_assets', from: 'otherCurrentAssets'
+      property 'other_current_assets_dollar', from: 'otherCurrentAssets', with: ->(v) { to_dollar(amount: v) }
+      property 'current_assets', from: 'currentAssets'
+      property 'current_assets_dollar', from: 'currentAssets', with: ->(v) { to_dollar(amount: v) }
+      property 'long_term_investments', from: 'longTermInvestments'
+      property 'long_term_investments_dollar', from: 'longTermInvestments', with: ->(v) { to_dollar(amount: v) }
+      property 'property_plant_equipment', from: 'propertyPlantEquipment'
+      property 'property_plant_equipment_dollar', from: 'propertyPlantEquipment', with: ->(v) { to_dollar(amount: v) }
+      property 'goodwill'
+      property 'goodwill_dollar', from: 'goodwill', with: ->(v) { to_dollar(amount: v) }
+      property 'intangible_assets', from: 'intangibleAssets'
+      property 'intangible_assets_dollar', from: 'intangibleAssets', with: ->(v) { to_dollar(amount: v) }
+      property 'other_assets', from: 'otherAssets'
+      property 'other_assets_dollar', from: 'otherAssets', with: ->(v) { to_dollar(amount: v) }
+      property 'total_assets', from: 'totalAssets'
+      property 'total_assets_dollar', from: 'totalAssets', with: ->(v) { to_dollar(amount: v) }
+      property 'accounts_payable', from: 'accountsPayable'
+      property 'accounts_payable_dollar', from: 'accountsPayable', with: ->(v) { to_dollar(amount: v) }
+      property 'current_long_term_debt', from: 'currentLongTermDebt'
+      property 'current_long_term_debt_dollar', from: 'currentLongTermDebt', with: ->(v) { to_dollar(amount: v) }
+      property 'other_current_liabilities', from: 'otherCurrentLiabilities'
+      property 'other_current_liabilities_dollar', from: 'otherCurrentLiabilities', with: ->(v) { to_dollar(amount: v) }
+      property 'total_current_liabilities', from: 'totalCurrentLiabilities'
+      property 'total_current_liabilities_dollar', from: 'totalCurrentLiabilities', with: ->(v) { to_dollar(amount: v) }
+      property 'long_term_debt', from: 'longTermDebt'
+      property 'long_term_debt_dollar', from: 'longTermDebt', with: ->(v) { to_dollar(amount: v) }
+      property 'other_liabilities', from: 'otherLiabilities'
+      property 'other_liabilities_dollar', from: 'otherLiabilities', with: ->(v) { to_dollar(amount: v) }
+      property 'minority_interest', from: 'minorityInterest'
+      property 'minority_interest_dollar', from: 'minorityInterest', with: ->(v) { to_dollar(amount: v) }
+      property 'total_liabilities', from: 'totalLiabilities'
+      property 'total_liabilities_dollar', from: 'totalLiabilities', with: ->(v) { to_dollar(amount: v) }
+      property 'common_stock', from: 'commonStock'
+      property 'retained_earnings', from: 'retainedEarnings'
+      property 'retained_earnings_dollar', from: 'retainedEarnings', with: ->(v) { to_dollar(amount: v) }
+      property 'treasury_stock', from: 'treasuryStock'
+      property 'treasury_stock_dollar', from: 'treasuryStock', with: ->(v) { to_dollar(amount: v) }
+      property 'capital_surplus', from: 'capitalSurplus'
+      property 'capital_surplus_dollar', from: 'capitalSurplus', with: ->(v) { to_dollar(amount: v) }
+      property 'shareholder_equity', from: 'shareholderEquity'
+      property 'shareholder_equity_dollar', from: 'shareholderEquity', with: ->(v) { to_dollar(amount: v) }
+      property 'net_tangible_assets', from: 'netTangibleAssets'
+      property 'net_tangible_assets_dollar', from: 'netTangibleAssets', with: ->(v) { to_dollar(amount: v) }
+    end
+  end
+end

data/lib/iex/resources/cash_flow.rb

@@ -0,0 +1,43 @@
+module IEX
+  module Resources
+    class CashFlow < Resource
+      property 'report_date', from: 'reportDate'
+      property 'fiscal_date', from: 'fiscalDate'
+      property 'currency'
+      property 'net_income', from: 'netIncome'
+      property 'net_income_dollar', from: 'netIncome', with: ->(v) { to_dollar(amount: v) }
+      property 'depreciation'
+      property 'depreciation_dollar', from: 'depreciation', with: ->(v) { to_dollar(amount: v) }
+      property 'changes_in_receivables', from: 'changesInReceivables'
+      property 'changes_in_receivables_dollar', from: 'changesInReceivables', with: ->(v) { to_dollar(amount: v) }
+      property 'changes_in_inventories', from: 'changesInInventories'
+      property 'changes_in_inventories_dollar', from: 'changesInInventories', with: ->(v) { to_dollar(amount: v) }
+      property 'cash_change', from: 'cashChange'
+      property 'cash_change_dollar', from: 'cashChange', with: ->(v) { to_dollar(amount: v) }
+      property 'cash_flow', from: 'cashFlow'
+      property 'cash_flow_dollar', from: 'cashFlow', with: ->(v) { to_dollar(amount: v) }
+      property 'capital_expenditures', from: 'capitalExpenditures'
+      property 'capital_expenditures_dollar', from: 'capitalExpenditures', with: ->(v) { to_dollar(amount: v) }
+      property 'investments'
+      property 'investments_dollar', from: 'investments', with: ->(v) { to_dollar(amount: v) }
+      property 'investing_activity_other', from: 'investingActivityOther'
+      property 'investing_activity_other_dollar', from: 'investingActivityOther', with: ->(v) { to_dollar(amount: v) }
+      property 'total_investing_cash_flows', from: 'totalInvestingCashFlows'
+      property 'total_investing_cash_flows_dollar', from: 'totalInvestingCashFlows', with: ->(v) { to_dollar(amount: v) }
+      property 'dividends_paid', from: 'dividendsPaid'
+      property 'dividends_paid_dollar', from: 'dividendsPaid', with: ->(v) { to_dollar(amount: v) }
+      property 'net_borrowings', from: 'netBorrowings'
+      property 'net_borrowings_dollar', from: 'netBorrowings', with: ->(v) { to_dollar(amount: v) }
+      property 'other_financing_cash_flows', from: 'otherFinancingCashFlows'
+      property 'other_financing_cash_flows_dollar', from: 'otherFinancingCashFlows', with: ->(v) { to_dollar(amount: v) }
+      property 'cash_flow_financing', from: 'cashFlowFinancing'
+      property 'cash_flow_financing_dollar', from: 'cashFlowFinancing', with: ->(v) { to_dollar(amount: v) }
+      property 'exchange_rate_effect', from: 'exchangeRateEffect'
+      property 'exchange_rate_effect_dollar', from: 'exchangeRateEffect', with: ->(v) { to_dollar(amount: v) }
+
+      def initialize(data = {})
+        super
+      end
+    end
+  end
+end

data/lib/iex/resources/chart.rb

@@ -5,15 +5,18 @@ module IEX
         property 'high'
         property 'low'
         property 'volume'
+        property 'open'
+        property 'close'
         property 'label'
-        property 'change_over_time', from: 'changeOverTime'
         property 'date', transform_with: ->(v) { Date.parse(v) }
       end
 
       class Default < Base
-        property 'open'
-        property 'close'
-        property 'unadjusted_volume', from: 'unadjustedVolume'
+        property 'u_high', from: 'uHigh'
+        property 'u_low', from: 'uLow'
+        property 'u_volume', from: 'uVolume'
+        property 'u_open', from: 'uOpen'
+        property 'u_close', from: 'uClose'
         property 'change'
         property 'change_percent', from: 'changePercent'
         property 'change_percent_s', from: 'changePercent', with: lambda { |v|
@@ -23,22 +26,14 @@ module IEX
             '%'
           ].join
         } # change in percent as a String with a leading + or - sign
-        property 'vwap'
+        property 'change_over_time', from: 'changeOverTime'
       end
 
       class OneDay < Base
         property 'minute'
-        property 'market_average', from: 'marketAverage'
-        property 'market_notional', from: 'marketNotional'
-        property 'market_number_of_trades', from: 'marketNumberOfTrades'
-        property 'market_high', from: 'marketHigh'
-        property 'market_low', from: 'marketLow'
-        property 'market_volume', from: 'marketVolume'
-        property 'market_change_over_time', from: 'marketChangeOverTime'
         property 'average'
         property 'notional'
         property 'number_of_trades', from: 'numberOfTrades'
-        property 'simplify_factor', from: 'simplifyFactor'
       end
     end
   end

data/lib/iex/resources/historical_prices.rb

@@ -0,0 +1,31 @@
+module IEX
+  module Resources
+    class HistorialPrices < Resource
+      property 'date'
+      property 'open'
+      property 'open_dollar', from: 'open', with: ->(v) { to_dollar(amount: v, ignore_cents: false) }
+      property 'close'
+      property 'close_dollar', from: 'close', with: ->(v) { to_dollar(amount: v, ignore_cents: false) }
+      property 'high'
+      property 'high_dollar', from: 'high', with: ->(v) { to_dollar(amount: v, ignore_cents: false) }
+      property 'low'
+      property 'low_dollar', from: 'low', with: ->(v) { to_dollar(amount: v, ignore_cents: false) }
+      property 'volume'
+      property 'u_open', from: 'uOpen'
+      property 'u_open_dollar', from: 'uOpen', with: ->(v) { to_dollar(amount: v, ignore_cents: false) }
+      property 'u_close', from: 'uClose'
+      property 'u_close_dollar', from: 'uClose', with: ->(v) { to_dollar(amount: v, ignore_cents: false) }
+      property 'u_low', from: 'uLow'
+      property 'u_low_dollar', from: 'uLow', with: ->(v) { to_dollar(amount: v, ignore_cents: false) }
+      property 'u_high', from: 'uHigh'
+      property 'u_high_dollar', from: 'uHigh', with: ->(v) { to_dollar(amount: v, ignore_cents: false) }
+      property 'u_volume', from: 'uVolume'
+      property 'change'
+      property 'change_percent', from: 'changePercent'
+      property 'change_percent_s', from: 'changePercent', with: ->(v) { percentage_to_string(v) }
+      property 'label'
+      property 'change_over_time', from: 'changeOverTime'
+      property 'change_over_time_s', from: 'changeOverTime', with: ->(v) { percentage_to_string(v) }
+    end
+  end
+end

data/lib/iex/resources/income.rb

@@ -2,6 +2,8 @@ module IEX
   module Resources
     class Income < Resource
       property 'report_date', from: 'reportDate'
+      property 'fiscal_date', from: 'fiscalDate'
+      property 'currency'
       property 'total_revenue', from: 'totalRevenue'
       property 'total_revenue_dollar', from: 'totalRevenue', with: ->(v) { to_dollar(amount: v) }
       property 'cost_of_revenue', from: 'costOfRevenue'

data/lib/iex/resources/key_stats.rb

@@ -8,7 +8,7 @@ module IEX
       property 'week_52_high_dollar', from: 'week52high', with: ->(v) { Resource.to_dollar(amount: v, ignore_cents: false) }
       property 'week_52_low', from: 'week52low'
       property 'week_52_low_dollar', from: 'week52low', with: ->(v) { Resource.to_dollar(amount: v, ignore_cents: false) }
-      property 'week_52_change'
+      property 'week_52_change', from: 'week52change'
       property 'week_52_change_dollar', from: 'week52change', with: ->(v) { Resource.to_dollar(amount: v, ignore_cents: false) }
       property 'dividend_yield', from: 'dividendYield'
       property 'ex_dividend_date', from: 'exDividendDate'

data/lib/iex/resources/quote.rb

@@ -24,8 +24,18 @@ module IEX
       property 'iex_last_updated_t', from: 'iexLastUpdated', with: ->(v) { v&.positive? ? Time.at(v / 1000) : nil } # last update time of the data
       property 'delayed_price', from: 'delayedPrice' # 15 minute delayed market price
       property 'delayed_price_time', from: 'delayedPriceTime' # time of the delayed market price
-      property 'extended_price', from: 'extendedPrice' # ?
-      property 'extended_price_time', from: 'extendedPriceTime' # ?
+      property 'extended_price', from: 'extendedPrice' # the pre market and post market price
+      property 'extended_change_percent', from: 'extendedChangePercent' # price change percent between extended_price and latest_price
+      property 'extended_change_percent_s', from: 'extendedChangePercent', with: lambda { |v|
+        if v
+          [
+            v.positive? ? '+' : '',
+            format('%.2f', v * 100),
+            '%'
+          ].join
+        end
+      } # change in percent as a String with a leading + or - sign
+      property 'extended_price_time', from: 'extendedPriceTime' # the last update time of extended_price
       property 'previous_close', from: 'previousClose' # adjusted close price of the last trading day of the stock
       property 'change' # change in value, calculated using calculation_price from previous_close
       property 'change_percent', from: 'changePercent' # change in percent, calculated using calculation_price from previous_close

data/lib/iex/resources/resource.rb

@@ -14,6 +14,18 @@ module IEX
         ].join
       end
 
+      # Useful for values that are already a percent but we want to convert into a 2 decimal place string
+      def self.percentage_to_string(float_percent)
+        return unless float_percent.is_a? Numeric
+        return '+0.00%' if float_percent.zero?
+
+        [
+          float_percent.positive? ? '+' : '',
+          format('%.2f', float_percent),
+          '%'
+        ].join
+      end
+
       def self.to_dollar(amount:, ignore_cents: true)
         MoneyHelper.money_to_text(amount, 'USD', nil, no_cents: ignore_cents)
       end

data/lib/iex/resources/symbol.rb

@@ -0,0 +1,10 @@
+module IEX
+  module Resources
+    class Symbol < Resource
+      property 'exchange'
+      property 'iex_id', from: 'iexId'
+      property 'region'
+      property 'symbol'
+    end
+  end
+end

data/lib/iex/resources/symbols.rb

@@ -0,0 +1,19 @@
+module IEX
+  module Resources
+    class Symbols < Resource
+      property 'symbol'
+      property 'exchange'
+      property 'name'
+      property 'date', transform_with: ->(v) { Date.parse(v) }
+      property 'enabled', from: 'isEnabled'
+      property 'type'
+      property 'region'
+      property 'currency'
+      property 'iex_id', from: 'iexId'
+      property 'figi'
+      property 'cik'
+
+      alias :enabled? enabled
+    end
+  end
+end