intrinio-sdk 3.0.0 → 3.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +9 -3
- data/docs/AccumulationDistributionIndexTechnicalValue.md +18 -6
- data/docs/ApiResponseCompanies.md +21 -6
- data/docs/ApiResponseCompaniesSearch.md +20 -5
- data/docs/ApiResponseCompanyFilings.md +26 -8
- data/docs/ApiResponseCompanyFundamentals.md +26 -8
- data/docs/ApiResponseCompanyHistoricalData.md +26 -8
- data/docs/ApiResponseCompanyNews.md +26 -8
- data/docs/ApiResponseCompanySecurities.md +26 -8
- data/docs/ApiResponseCryptoAccumulationDistributionIndex.md +35 -11
- data/docs/ApiResponseCryptoAverageDailyTradingVolume.md +35 -11
- data/docs/ApiResponseCryptoAverageDirectionalIndex.md +35 -11
- data/docs/ApiResponseCryptoAverageTrueRange.md +35 -11
- data/docs/ApiResponseCryptoAwesomeOscillator.md +35 -11
- data/docs/ApiResponseCryptoBollingerBands.md +35 -11
- data/docs/ApiResponseCryptoBook.md +34 -10
- data/docs/ApiResponseCryptoBookAsks.md +30 -9
- data/docs/ApiResponseCryptoBookBids.md +30 -9
- data/docs/ApiResponseCryptoChaikinMoneyFlow.md +35 -11
- data/docs/ApiResponseCryptoCommodityChannelIndex.md +35 -11
- data/docs/ApiResponseCryptoCurrencies.md +20 -5
- data/docs/ApiResponseCryptoDetrendedPriceOscillator.md +35 -11
- data/docs/ApiResponseCryptoDonchianChannel.md +35 -11
- data/docs/ApiResponseCryptoEaseOfMovement.md +35 -11
- data/docs/ApiResponseCryptoExchanges.md +20 -5
- data/docs/ApiResponseCryptoForceIndex.md +35 -11
- data/docs/ApiResponseCryptoIchimokuKinkoHyo.md +35 -11
- data/docs/ApiResponseCryptoKeltnerChannel.md +35 -11
- data/docs/ApiResponseCryptoKnowSureThing.md +35 -11
- data/docs/ApiResponseCryptoMassIndex.md +35 -11
- data/docs/ApiResponseCryptoMoneyFlowIndex.md +35 -11
- data/docs/ApiResponseCryptoMovingAverageConvergenceDivergence.md +35 -11
- data/docs/ApiResponseCryptoNegativeVolumeIndex.md +35 -11
- data/docs/ApiResponseCryptoOnBalanceVolume.md +35 -11
- data/docs/ApiResponseCryptoOnBalanceVolumeMean.md +35 -11
- data/docs/ApiResponseCryptoPairs.md +21 -6
- data/docs/ApiResponseCryptoPrices.md +31 -10
- data/docs/ApiResponseCryptoRelativeStrengthIndex.md +35 -11
- data/docs/ApiResponseCryptoSimpleMovingAverage.md +35 -11
- data/docs/ApiResponseCryptoSnapshot.md +29 -8
- data/docs/ApiResponseCryptoStats.md +20 -5
- data/docs/ApiResponseCryptoStochasticOscillator.md +35 -11
- data/docs/ApiResponseCryptoTripleExponentialAverage.md +35 -11
- data/docs/ApiResponseCryptoTrueStrengthIndex.md +35 -11
- data/docs/ApiResponseCryptoUltimateOscillator.md +35 -11
- data/docs/ApiResponseCryptoVolumePriceTrend.md +35 -11
- data/docs/ApiResponseCryptoVolumeWeightedAveragePrice.md +35 -11
- data/docs/ApiResponseCryptoVortexIndicator.md +35 -11
- data/docs/ApiResponseCryptoWilliamsR.md +35 -11
- data/docs/ApiResponseDataTags.md +21 -6
- data/docs/ApiResponseDataTagsSearch.md +20 -5
- data/docs/ApiResponseEconomicIndexHistoricalData.md +26 -8
- data/docs/ApiResponseEconomicIndices.md +21 -6
- data/docs/ApiResponseEconomicIndicesSearch.md +20 -5
- data/docs/ApiResponseFilingFundamentals.md +28 -0
- data/docs/ApiResponseFilingNotes.md +21 -6
- data/docs/ApiResponseFilingNotesSearch.md +20 -5
- data/docs/ApiResponseFilings.md +21 -6
- data/docs/ApiResponseForexCurrencies.md +20 -5
- data/docs/ApiResponseForexPairs.md +20 -5
- data/docs/ApiResponseForexPrices.md +26 -8
- data/docs/ApiResponseHistoricalData.md +21 -6
- data/docs/ApiResponseMunicipalities.md +21 -6
- data/docs/ApiResponseMunicipalitiyFinancials.md +24 -6
- data/docs/ApiResponseNews.md +21 -6
- data/docs/ApiResponseOptionPrices.md +26 -8
- data/docs/ApiResponseOptions.md +21 -6
- data/docs/ApiResponseOptionsChain.md +20 -5
- data/docs/ApiResponseOptionsExpirations.md +17 -5
- data/docs/ApiResponseReportedFinancials.md +26 -8
- data/docs/ApiResponseSICIndexHistoricalData.md +26 -8
- data/docs/ApiResponseSICIndices.md +21 -6
- data/docs/ApiResponseSICIndicesSearch.md +20 -5
- data/docs/ApiResponseSecurities.md +21 -6
- data/docs/ApiResponseSecuritiesSearch.md +20 -5
- data/docs/ApiResponseSecurityAccumulationDistributionIndex.md +30 -9
- data/docs/ApiResponseSecurityAverageDailyTradingVolume.md +30 -9
- data/docs/ApiResponseSecurityAverageDirectionalIndex.md +30 -9
- data/docs/ApiResponseSecurityAverageTrueRange.md +30 -9
- data/docs/ApiResponseSecurityAwesomeOscillator.md +30 -9
- data/docs/ApiResponseSecurityBollingerBands.md +30 -9
- data/docs/ApiResponseSecurityChaikinMoneyFlow.md +30 -9
- data/docs/ApiResponseSecurityCommodityChannelIndex.md +30 -9
- data/docs/ApiResponseSecurityDetrendedPriceOscillator.md +30 -9
- data/docs/ApiResponseSecurityDonchianChannel.md +30 -9
- data/docs/ApiResponseSecurityEaseOfMovement.md +30 -9
- data/docs/ApiResponseSecurityForceIndex.md +30 -9
- data/docs/ApiResponseSecurityHistoricalData.md +26 -8
- data/docs/ApiResponseSecurityIchimokuKinkoHyo.md +30 -9
- data/docs/ApiResponseSecurityIntradayPrices.md +27 -9
- data/docs/ApiResponseSecurityKeltnerChannel.md +30 -9
- data/docs/ApiResponseSecurityKnowSureThing.md +30 -9
- data/docs/ApiResponseSecurityMassIndex.md +30 -9
- data/docs/ApiResponseSecurityMoneyFlowIndex.md +30 -9
- data/docs/ApiResponseSecurityMovingAverageConvergenceDivergence.md +30 -9
- data/docs/ApiResponseSecurityNegativeVolumeIndex.md +30 -9
- data/docs/ApiResponseSecurityOnBalanceVolume.md +30 -9
- data/docs/ApiResponseSecurityOnBalanceVolumeMean.md +30 -9
- data/docs/ApiResponseSecurityRelativeStrengthIndex.md +30 -9
- data/docs/ApiResponseSecuritySimpleMovingAverage.md +30 -9
- data/docs/ApiResponseSecurityStochasticOscillator.md +30 -9
- data/docs/ApiResponseSecurityStockPriceAdjustments.md +26 -8
- data/docs/ApiResponseSecurityStockPrices.md +26 -8
- data/docs/ApiResponseSecurityTripleExponentialAverage.md +30 -9
- data/docs/ApiResponseSecurityTrueStrengthIndex.md +30 -9
- data/docs/ApiResponseSecurityUltimateOscillator.md +30 -9
- data/docs/ApiResponseSecurityVolumePriceTrend.md +30 -9
- data/docs/ApiResponseSecurityVolumeWeightedAveragePrice.md +30 -9
- data/docs/ApiResponseSecurityVortexIndicator.md +30 -9
- data/docs/ApiResponseSecurityWilliamsR.md +30 -9
- data/docs/ApiResponseSecurityZacksAnalystRatings.md +26 -8
- data/docs/ApiResponseSecurityZacksAnalystRatingsSnapshot.md +24 -6
- data/docs/ApiResponseSecurityZacksEPSSurprises.md +26 -8
- data/docs/ApiResponseSecurityZacksSalesSurprises.md +26 -8
- data/docs/ApiResponseStandardizedFinancials.md +26 -8
- data/docs/ApiResponseStockExchangeRealtimeStockPrices.md +24 -6
- data/docs/ApiResponseStockExchangeSecurities.md +26 -8
- data/docs/ApiResponseStockExchangeStockPriceAdjustments.md +26 -8
- data/docs/ApiResponseStockExchangeStockPrices.md +26 -8
- data/docs/ApiResponseStockExchanges.md +21 -6
- data/docs/ApiResponseStockMarketIndexHistoricalData.md +26 -8
- data/docs/ApiResponseStockMarketIndices.md +21 -6
- data/docs/ApiResponseStockMarketIndicesSearch.md +20 -5
- data/docs/ApiResponseZacksAnalystRatings.md +21 -6
- data/docs/ApiResponseZacksEPSSurprises.md +21 -6
- data/docs/ApiResponseZacksSalesSurprises.md +21 -6
- data/docs/AverageDailyTradingVolumeTechnicalValue.md +18 -6
- data/docs/AverageDirectionalIndexTechnicalValue.md +21 -9
- data/docs/AverageTrueRangeTechnicalValue.md +18 -6
- data/docs/AwesomeOscillatorTechnicalValue.md +18 -6
- data/docs/BollingerBandsTechnicalValue.md +21 -9
- data/docs/ChaikinMoneyFlowTechnicalValue.md +18 -6
- data/docs/CommodityChannelIndexTechnicalValue.md +18 -6
- data/docs/Company.md +53 -41
- data/docs/CompanyApi.md +593 -89
- data/docs/CompanyFiling.md +30 -15
- data/docs/CompanyNews.md +26 -11
- data/docs/CompanyNewsSummary.md +22 -10
- data/docs/CompanySummary.md +22 -10
- data/docs/CryptoApi.md +2242 -562
- data/docs/CryptoAsk.md +18 -6
- data/docs/CryptoBid.md +18 -6
- data/docs/CryptoBookEntry.md +18 -6
- data/docs/CryptoCurrency.md +22 -10
- data/docs/CryptoExchange.md +23 -11
- data/docs/CryptoExchangeSummary.md +18 -6
- data/docs/CryptoPair.md +25 -13
- data/docs/CryptoPairSummary.md +18 -6
- data/docs/CryptoPrice.md +23 -11
- data/docs/CryptoSnapshot.md +32 -20
- data/docs/CryptoStat.md +25 -13
- data/docs/DataPointApi.md +94 -10
- data/docs/DataTag.md +28 -16
- data/docs/DataTagApi.md +145 -19
- data/docs/DataTagSummary.md +25 -13
- data/docs/DetrendedPriceOscillatorTechnicalValue.md +18 -6
- data/docs/DividendRecord.md +30 -15
- data/docs/DonchianChannelTechnicalValue.md +20 -8
- data/docs/EarningsRecord.md +43 -28
- data/docs/EaseOfMovementTechnicalValue.md +18 -6
- data/docs/EconomicIndex.md +29 -17
- data/docs/EconomicIndexSummary.md +28 -16
- data/docs/Filing.md +30 -15
- data/docs/FilingApi.md +443 -47
- data/docs/FilingNote.md +24 -9
- data/docs/FilingNoteFiling.md +21 -9
- data/docs/FilingNoteSummary.md +23 -8
- data/docs/FilingSummary.md +26 -14
- data/docs/ForceIndexTechnicalValue.md +18 -6
- data/docs/ForexApi.md +144 -18
- data/docs/ForexCurrency.md +20 -8
- data/docs/ForexPair.md +20 -8
- data/docs/ForexPrice.md +27 -15
- data/docs/Fundamental.md +29 -14
- data/docs/FundamentalSummary.md +25 -13
- data/docs/FundamentalsApi.md +187 -19
- data/docs/HistoricalData.md +18 -6
- data/docs/HistoricalDataApi.md +54 -12
- data/docs/IchimokuKinkoHyoTechnicalValue.md +23 -11
- data/docs/IndexApi.md +867 -105
- data/docs/IntradayStockPrice.md +25 -13
- data/docs/KeltnerChannelTechnicalValue.md +21 -9
- data/docs/KnowSureThingTechnicalValue.md +18 -6
- data/docs/MassIndexTechnicalValue.md +18 -6
- data/docs/MoneyFlowIndexTechnicalValue.md +18 -6
- data/docs/MovingAverageConvergenceDivergenceTechnicalValue.md +21 -9
- data/docs/Municipality.md +36 -24
- data/docs/MunicipalityApi.md +152 -25
- data/docs/MunicipalityFinancial.md +59 -47
- data/docs/NegativeVolumeIndexTechnicalValue.md +18 -6
- data/docs/OnBalanceVolumeMeanTechnicalValue.md +18 -6
- data/docs/OnBalanceVolumeTechnicalValue.md +18 -6
- data/docs/Option.md +23 -11
- data/docs/OptionChain.md +24 -6
- data/docs/OptionPrice.md +31 -19
- data/docs/OptionsApi.md +206 -38
- data/docs/RealtimeStockPrice.md +34 -19
- data/docs/RealtimeStockPriceSecurity.md +22 -10
- data/docs/RelativeStrengthIndexTechnicalValue.md +18 -6
- data/docs/ReportedFinancial.md +26 -8
- data/docs/ReportedFinancialDimension.md +18 -6
- data/docs/ReportedTag.md +24 -12
- data/docs/SICIndex.md +22 -10
- data/docs/Security.md +45 -33
- data/docs/SecurityApi.md +2445 -429
- data/docs/SecurityScreenClause.md +20 -8
- data/docs/SecurityScreenGroup.md +26 -8
- data/docs/SecurityScreenResult.md +24 -6
- data/docs/SecurityScreenResultData.md +20 -8
- data/docs/SecuritySummary.md +27 -15
- data/docs/SimpleMovingAverageTechnicalValue.md +18 -6
- data/docs/StandardizedFinancial.md +21 -6
- data/docs/StochasticOscillatorTechnicalValue.md +20 -8
- data/docs/StockExchange.md +27 -15
- data/docs/StockExchangeApi.md +290 -38
- data/docs/StockMarketIndex.md +27 -15
- data/docs/StockMarketIndexSummary.md +26 -14
- data/docs/StockPrice.md +34 -19
- data/docs/StockPriceAdjustment.md +26 -11
- data/docs/StockPriceAdjustmentSummary.md +22 -10
- data/docs/StockPriceSummary.md +30 -18
- data/docs/TechnicalApi.md +3419 -815
- data/docs/TechnicalIndicator.md +18 -6
- data/docs/TripleExponentialAverageTechnicalValue.md +18 -6
- data/docs/TrueStrengthIndexTechnicalValue.md +18 -6
- data/docs/UltimateOscillatorTechnicalValue.md +18 -6
- data/docs/VolumePriceTrendTechnicalValue.md +18 -6
- data/docs/VolumeWeightedAveragePriceValue.md +18 -6
- data/docs/VortexIndicatorTechnicalValue.md +20 -8
- data/docs/WilliamsRTechnicalValue.md +18 -6
- data/docs/ZacksAnalystRating.md +30 -15
- data/docs/ZacksAnalystRatingSnapshot.md +28 -16
- data/docs/ZacksAnalystRatingSummary.md +26 -14
- data/docs/ZacksApi.md +186 -60
- data/docs/ZacksEPSSurprise.md +37 -22
- data/docs/ZacksEPSSurpriseSummary.md +33 -21
- data/docs/ZacksSalesSurprise.md +34 -22
- data/docs/ZacksSalesSurpriseSummary.md +38 -23
- data/intrinio-sdk.gemspec +1 -1
- data/lib/intrinio-sdk.rb +2 -1
- data/lib/intrinio-sdk/api/company_api.rb +3 -3
- data/lib/intrinio-sdk/api/crypto_api.rb +1 -1
- data/lib/intrinio-sdk/api/data_point_api.rb +1 -1
- data/lib/intrinio-sdk/api/data_tag_api.rb +1 -1
- data/lib/intrinio-sdk/api/filing_api.rb +88 -5
- data/lib/intrinio-sdk/api/forex_api.rb +1 -1
- data/lib/intrinio-sdk/api/fundamentals_api.rb +1 -1
- data/lib/intrinio-sdk/api/historical_data_api.rb +1 -1
- data/lib/intrinio-sdk/api/index_api.rb +1 -1
- data/lib/intrinio-sdk/api/municipality_api.rb +1 -1
- data/lib/intrinio-sdk/api/options_api.rb +1 -1
- data/lib/intrinio-sdk/api/security_api.rb +1 -1
- data/lib/intrinio-sdk/api/stock_exchange_api.rb +1 -1
- data/lib/intrinio-sdk/api/technical_api.rb +1 -1
- data/lib/intrinio-sdk/api/zacks_api.rb +1 -1
- data/lib/intrinio-sdk/api_client.rb +1 -1
- data/lib/intrinio-sdk/api_error.rb +1 -1
- data/lib/intrinio-sdk/configuration.rb +1 -1
- data/lib/intrinio-sdk/models/accumulation_distribution_index_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_companies.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_companies_search.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_company_filings.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_company_fundamentals.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_company_historical_data.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_company_news.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_company_securities.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_accumulation_distribution_index.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_average_daily_trading_volume.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_average_directional_index.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_average_true_range.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_awesome_oscillator.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_bollinger_bands.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_book.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_book_asks.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_book_bids.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_chaikin_money_flow.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_commodity_channel_index.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_currencies.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_detrended_price_oscillator.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_donchian_channel.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_ease_of_movement.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_exchanges.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_force_index.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_ichimoku_kinko_hyo.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_keltner_channel.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_know_sure_thing.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_mass_index.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_money_flow_index.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_moving_average_convergence_divergence.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_negative_volume_index.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_on_balance_volume.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_on_balance_volume_mean.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_pairs.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_prices.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_relative_strength_index.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_simple_moving_average.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_snapshot.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_stats.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_stochastic_oscillator.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_triple_exponential_average.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_true_strength_index.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_ultimate_oscillator.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_volume_price_trend.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_volume_weighted_average_price.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_vortex_indicator.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_williams_r.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_data_tags.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_data_tags_search.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_economic_index_historical_data.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_economic_indices.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_economic_indices_search.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_filing_fundamentals.rb +209 -0
- data/lib/intrinio-sdk/models/api_response_filing_notes.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_filing_notes_search.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_filings.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_forex_currencies.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_forex_pairs.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_forex_prices.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_historical_data.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_municipalities.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_municipalitiy_financials.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_news.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_option_prices.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_options.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_options_chain.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_options_expirations.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_reported_financials.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_securities.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_securities_search.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_accumulation_distribution_index.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_average_daily_trading_volume.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_average_directional_index.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_average_true_range.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_awesome_oscillator.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_bollinger_bands.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_chaikin_money_flow.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_commodity_channel_index.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_detrended_price_oscillator.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_donchian_channel.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_ease_of_movement.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_force_index.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_historical_data.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_ichimoku_kinko_hyo.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_intraday_prices.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_keltner_channel.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_know_sure_thing.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_mass_index.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_money_flow_index.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_moving_average_convergence_divergence.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_negative_volume_index.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_on_balance_volume.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_on_balance_volume_mean.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_relative_strength_index.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_simple_moving_average.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_stochastic_oscillator.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_stock_price_adjustments.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_stock_prices.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_triple_exponential_average.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_true_strength_index.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_ultimate_oscillator.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_volume_price_trend.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_volume_weighted_average_price.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_vortex_indicator.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_williams_r.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_zacks_analyst_ratings.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_zacks_analyst_ratings_snapshot.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_zacks_eps_surprises.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_zacks_sales_surprises.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_sic_index_historical_data.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_sic_indices.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_sic_indices_search.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_standardized_financials.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_stock_exchange_realtime_stock_prices.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_stock_exchange_securities.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_price_adjustments.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_prices.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_stock_exchanges.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_stock_market_index_historical_data.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_stock_market_indices.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_stock_market_indices_search.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_zacks_analyst_ratings.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_zacks_eps_surprises.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_zacks_sales_surprises.rb +1 -1
- data/lib/intrinio-sdk/models/average_daily_trading_volume_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/average_directional_index_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/average_true_range_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/awesome_oscillator_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/bollinger_bands_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/chaikin_money_flow_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/commodity_channel_index_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/company.rb +1 -1
- data/lib/intrinio-sdk/models/company_filing.rb +2 -2
- data/lib/intrinio-sdk/models/company_news.rb +1 -1
- data/lib/intrinio-sdk/models/company_news_summary.rb +1 -1
- data/lib/intrinio-sdk/models/company_summary.rb +1 -1
- data/lib/intrinio-sdk/models/crypto_ask.rb +1 -1
- data/lib/intrinio-sdk/models/crypto_bid.rb +1 -1
- data/lib/intrinio-sdk/models/crypto_book_entry.rb +1 -1
- data/lib/intrinio-sdk/models/crypto_currency.rb +1 -1
- data/lib/intrinio-sdk/models/crypto_exchange.rb +1 -1
- data/lib/intrinio-sdk/models/crypto_exchange_summary.rb +1 -1
- data/lib/intrinio-sdk/models/crypto_pair.rb +1 -1
- data/lib/intrinio-sdk/models/crypto_pair_summary.rb +1 -1
- data/lib/intrinio-sdk/models/crypto_price.rb +1 -1
- data/lib/intrinio-sdk/models/crypto_snapshot.rb +1 -1
- data/lib/intrinio-sdk/models/crypto_stat.rb +1 -1
- data/lib/intrinio-sdk/models/data_tag.rb +1 -1
- data/lib/intrinio-sdk/models/data_tag_summary.rb +1 -1
- data/lib/intrinio-sdk/models/detrended_price_oscillator_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/dividend_record.rb +1 -1
- data/lib/intrinio-sdk/models/donchian_channel_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/earnings_record.rb +1 -1
- data/lib/intrinio-sdk/models/ease_of_movement_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/economic_index.rb +1 -1
- data/lib/intrinio-sdk/models/economic_index_summary.rb +1 -1
- data/lib/intrinio-sdk/models/filing.rb +2 -2
- data/lib/intrinio-sdk/models/filing_note.rb +1 -1
- data/lib/intrinio-sdk/models/filing_note_filing.rb +2 -2
- data/lib/intrinio-sdk/models/filing_note_summary.rb +1 -1
- data/lib/intrinio-sdk/models/filing_summary.rb +2 -2
- data/lib/intrinio-sdk/models/force_index_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/forex_currency.rb +1 -1
- data/lib/intrinio-sdk/models/forex_pair.rb +1 -1
- data/lib/intrinio-sdk/models/forex_price.rb +1 -1
- data/lib/intrinio-sdk/models/fundamental.rb +1 -1
- data/lib/intrinio-sdk/models/fundamental_summary.rb +1 -1
- data/lib/intrinio-sdk/models/historical_data.rb +1 -1
- data/lib/intrinio-sdk/models/ichimoku_kinko_hyo_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/intraday_stock_price.rb +1 -1
- data/lib/intrinio-sdk/models/keltner_channel_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/know_sure_thing_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/mass_index_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/money_flow_index_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/moving_average_convergence_divergence_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/municipality.rb +1 -1
- data/lib/intrinio-sdk/models/municipality_financial.rb +1 -1
- data/lib/intrinio-sdk/models/negative_volume_index_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/on_balance_volume_mean_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/on_balance_volume_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/option.rb +1 -1
- data/lib/intrinio-sdk/models/option_chain.rb +1 -1
- data/lib/intrinio-sdk/models/option_price.rb +1 -1
- data/lib/intrinio-sdk/models/realtime_stock_price.rb +1 -1
- data/lib/intrinio-sdk/models/realtime_stock_price_security.rb +1 -1
- data/lib/intrinio-sdk/models/relative_strength_index_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/reported_financial.rb +1 -1
- data/lib/intrinio-sdk/models/reported_financial_dimension.rb +1 -1
- data/lib/intrinio-sdk/models/reported_tag.rb +1 -1
- data/lib/intrinio-sdk/models/security.rb +2 -2
- data/lib/intrinio-sdk/models/security_screen_clause.rb +1 -1
- data/lib/intrinio-sdk/models/security_screen_group.rb +1 -1
- data/lib/intrinio-sdk/models/security_screen_result.rb +1 -1
- data/lib/intrinio-sdk/models/security_screen_result_data.rb +1 -1
- data/lib/intrinio-sdk/models/security_summary.rb +2 -2
- data/lib/intrinio-sdk/models/sic_index.rb +1 -1
- data/lib/intrinio-sdk/models/simple_moving_average_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/standardized_financial.rb +1 -1
- data/lib/intrinio-sdk/models/stochastic_oscillator_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/stock_exchange.rb +1 -1
- data/lib/intrinio-sdk/models/stock_market_index.rb +1 -1
- data/lib/intrinio-sdk/models/stock_market_index_summary.rb +1 -1
- data/lib/intrinio-sdk/models/stock_price.rb +1 -1
- data/lib/intrinio-sdk/models/stock_price_adjustment.rb +1 -1
- data/lib/intrinio-sdk/models/stock_price_adjustment_summary.rb +1 -1
- data/lib/intrinio-sdk/models/stock_price_summary.rb +1 -1
- data/lib/intrinio-sdk/models/technical_indicator.rb +1 -1
- data/lib/intrinio-sdk/models/triple_exponential_average_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/true_strength_index_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/ultimate_oscillator_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/volume_price_trend_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/volume_weighted_average_price_value.rb +1 -1
- data/lib/intrinio-sdk/models/vortex_indicator_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/williams_r_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/zacks_analyst_rating.rb +1 -1
- data/lib/intrinio-sdk/models/zacks_analyst_rating_snapshot.rb +1 -1
- data/lib/intrinio-sdk/models/zacks_analyst_rating_summary.rb +1 -1
- data/lib/intrinio-sdk/models/zacks_eps_surprise.rb +1 -1
- data/lib/intrinio-sdk/models/zacks_eps_surprise_summary.rb +1 -1
- data/lib/intrinio-sdk/models/zacks_sales_surprise.rb +1 -1
- data/lib/intrinio-sdk/models/zacks_sales_surprise_summary.rb +1 -1
- data/lib/intrinio-sdk/version.rb +2 -2
- data/spec/api/company_api_spec.rb +2 -2
- data/spec/api/crypto_api_spec.rb +1 -1
- data/spec/api/data_point_api_spec.rb +1 -1
- data/spec/api/data_tag_api_spec.rb +1 -1
- data/spec/api/filing_api_spec.rb +22 -3
- data/spec/api/forex_api_spec.rb +1 -1
- data/spec/api/fundamentals_api_spec.rb +1 -1
- data/spec/api/historical_data_api_spec.rb +1 -1
- data/spec/api/index_api_spec.rb +1 -1
- data/spec/api/municipality_api_spec.rb +1 -1
- data/spec/api/options_api_spec.rb +1 -1
- data/spec/api/security_api_spec.rb +1 -1
- data/spec/api/stock_exchange_api_spec.rb +1 -1
- data/spec/api/technical_api_spec.rb +1 -1
- data/spec/api/zacks_api_spec.rb +1 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/accumulation_distribution_index_technical_value_spec.rb +1 -1
- data/spec/models/api_response_companies_search_spec.rb +1 -1
- data/spec/models/api_response_companies_spec.rb +1 -1
- data/spec/models/api_response_company_filings_spec.rb +1 -1
- data/spec/models/api_response_company_fundamentals_spec.rb +1 -1
- data/spec/models/api_response_company_historical_data_spec.rb +1 -1
- data/spec/models/api_response_company_news_spec.rb +1 -1
- data/spec/models/api_response_company_securities_spec.rb +1 -1
- data/spec/models/api_response_crypto_accumulation_distribution_index_spec.rb +1 -1
- data/spec/models/api_response_crypto_average_daily_trading_volume_spec.rb +1 -1
- data/spec/models/api_response_crypto_average_directional_index_spec.rb +1 -1
- data/spec/models/api_response_crypto_average_true_range_spec.rb +1 -1
- data/spec/models/api_response_crypto_awesome_oscillator_spec.rb +1 -1
- data/spec/models/api_response_crypto_bollinger_bands_spec.rb +1 -1
- data/spec/models/api_response_crypto_book_asks_spec.rb +1 -1
- data/spec/models/api_response_crypto_book_bids_spec.rb +1 -1
- data/spec/models/api_response_crypto_book_spec.rb +1 -1
- data/spec/models/api_response_crypto_chaikin_money_flow_spec.rb +1 -1
- data/spec/models/api_response_crypto_commodity_channel_index_spec.rb +1 -1
- data/spec/models/api_response_crypto_currencies_spec.rb +1 -1
- data/spec/models/api_response_crypto_detrended_price_oscillator_spec.rb +1 -1
- data/spec/models/api_response_crypto_donchian_channel_spec.rb +1 -1
- data/spec/models/api_response_crypto_ease_of_movement_spec.rb +1 -1
- data/spec/models/api_response_crypto_exchanges_spec.rb +1 -1
- data/spec/models/api_response_crypto_force_index_spec.rb +1 -1
- data/spec/models/api_response_crypto_ichimoku_kinko_hyo_spec.rb +1 -1
- data/spec/models/api_response_crypto_keltner_channel_spec.rb +1 -1
- data/spec/models/api_response_crypto_know_sure_thing_spec.rb +1 -1
- data/spec/models/api_response_crypto_mass_index_spec.rb +1 -1
- data/spec/models/api_response_crypto_money_flow_index_spec.rb +1 -1
- data/spec/models/api_response_crypto_moving_average_convergence_divergence_spec.rb +1 -1
- data/spec/models/api_response_crypto_negative_volume_index_spec.rb +1 -1
- data/spec/models/api_response_crypto_on_balance_volume_mean_spec.rb +1 -1
- data/spec/models/api_response_crypto_on_balance_volume_spec.rb +1 -1
- data/spec/models/api_response_crypto_pairs_spec.rb +1 -1
- data/spec/models/api_response_crypto_prices_spec.rb +1 -1
- data/spec/models/api_response_crypto_relative_strength_index_spec.rb +1 -1
- data/spec/models/api_response_crypto_simple_moving_average_spec.rb +1 -1
- data/spec/models/api_response_crypto_snapshot_spec.rb +1 -1
- data/spec/models/api_response_crypto_stats_spec.rb +1 -1
- data/spec/models/api_response_crypto_stochastic_oscillator_spec.rb +1 -1
- data/spec/models/api_response_crypto_triple_exponential_average_spec.rb +1 -1
- data/spec/models/api_response_crypto_true_strength_index_spec.rb +1 -1
- data/spec/models/api_response_crypto_ultimate_oscillator_spec.rb +1 -1
- data/spec/models/api_response_crypto_volume_price_trend_spec.rb +1 -1
- data/spec/models/api_response_crypto_volume_weighted_average_price_spec.rb +1 -1
- data/spec/models/api_response_crypto_vortex_indicator_spec.rb +1 -1
- data/spec/models/api_response_crypto_williams_r_spec.rb +1 -1
- data/spec/models/api_response_data_tags_search_spec.rb +1 -1
- data/spec/models/api_response_data_tags_spec.rb +1 -1
- data/spec/models/api_response_economic_index_historical_data_spec.rb +1 -1
- data/spec/models/api_response_economic_indices_search_spec.rb +1 -1
- data/spec/models/api_response_economic_indices_spec.rb +1 -1
- data/spec/models/api_response_filing_fundamentals_spec.rb +54 -0
- data/spec/models/api_response_filing_notes_search_spec.rb +1 -1
- data/spec/models/api_response_filing_notes_spec.rb +1 -1
- data/spec/models/api_response_filings_spec.rb +1 -1
- data/spec/models/api_response_forex_currencies_spec.rb +1 -1
- data/spec/models/api_response_forex_pairs_spec.rb +1 -1
- data/spec/models/api_response_forex_prices_spec.rb +1 -1
- data/spec/models/api_response_historical_data_spec.rb +1 -1
- data/spec/models/api_response_municipalities_spec.rb +1 -1
- data/spec/models/api_response_municipalitiy_financials_spec.rb +1 -1
- data/spec/models/api_response_news_spec.rb +1 -1
- data/spec/models/api_response_option_prices_spec.rb +1 -1
- data/spec/models/api_response_options_chain_spec.rb +1 -1
- data/spec/models/api_response_options_expirations_spec.rb +1 -1
- data/spec/models/api_response_options_spec.rb +1 -1
- data/spec/models/api_response_reported_financials_spec.rb +1 -1
- data/spec/models/api_response_securities_search_spec.rb +1 -1
- data/spec/models/api_response_securities_spec.rb +1 -1
- data/spec/models/api_response_security_accumulation_distribution_index_spec.rb +1 -1
- data/spec/models/api_response_security_average_daily_trading_volume_spec.rb +1 -1
- data/spec/models/api_response_security_average_directional_index_spec.rb +1 -1
- data/spec/models/api_response_security_average_true_range_spec.rb +1 -1
- data/spec/models/api_response_security_awesome_oscillator_spec.rb +1 -1
- data/spec/models/api_response_security_bollinger_bands_spec.rb +1 -1
- data/spec/models/api_response_security_chaikin_money_flow_spec.rb +1 -1
- data/spec/models/api_response_security_commodity_channel_index_spec.rb +1 -1
- data/spec/models/api_response_security_detrended_price_oscillator_spec.rb +1 -1
- data/spec/models/api_response_security_donchian_channel_spec.rb +1 -1
- data/spec/models/api_response_security_ease_of_movement_spec.rb +1 -1
- data/spec/models/api_response_security_force_index_spec.rb +1 -1
- data/spec/models/api_response_security_historical_data_spec.rb +1 -1
- data/spec/models/api_response_security_ichimoku_kinko_hyo_spec.rb +1 -1
- data/spec/models/api_response_security_intraday_prices_spec.rb +1 -1
- data/spec/models/api_response_security_keltner_channel_spec.rb +1 -1
- data/spec/models/api_response_security_know_sure_thing_spec.rb +1 -1
- data/spec/models/api_response_security_mass_index_spec.rb +1 -1
- data/spec/models/api_response_security_money_flow_index_spec.rb +1 -1
- data/spec/models/api_response_security_moving_average_convergence_divergence_spec.rb +1 -1
- data/spec/models/api_response_security_negative_volume_index_spec.rb +1 -1
- data/spec/models/api_response_security_on_balance_volume_mean_spec.rb +1 -1
- data/spec/models/api_response_security_on_balance_volume_spec.rb +1 -1
- data/spec/models/api_response_security_relative_strength_index_spec.rb +1 -1
- data/spec/models/api_response_security_simple_moving_average_spec.rb +1 -1
- data/spec/models/api_response_security_stochastic_oscillator_spec.rb +1 -1
- data/spec/models/api_response_security_stock_price_adjustments_spec.rb +1 -1
- data/spec/models/api_response_security_stock_prices_spec.rb +1 -1
- data/spec/models/api_response_security_triple_exponential_average_spec.rb +1 -1
- data/spec/models/api_response_security_true_strength_index_spec.rb +1 -1
- data/spec/models/api_response_security_ultimate_oscillator_spec.rb +1 -1
- data/spec/models/api_response_security_volume_price_trend_spec.rb +1 -1
- data/spec/models/api_response_security_volume_weighted_average_price_spec.rb +1 -1
- data/spec/models/api_response_security_vortex_indicator_spec.rb +1 -1
- data/spec/models/api_response_security_williams_r_spec.rb +1 -1
- data/spec/models/api_response_security_zacks_analyst_ratings_snapshot_spec.rb +1 -1
- data/spec/models/api_response_security_zacks_analyst_ratings_spec.rb +1 -1
- data/spec/models/api_response_security_zacks_eps_surprises_spec.rb +1 -1
- data/spec/models/api_response_security_zacks_sales_surprises_spec.rb +1 -1
- data/spec/models/api_response_sic_index_historical_data_spec.rb +1 -1
- data/spec/models/api_response_sic_indices_search_spec.rb +1 -1
- data/spec/models/api_response_sic_indices_spec.rb +1 -1
- data/spec/models/api_response_standardized_financials_spec.rb +1 -1
- data/spec/models/api_response_stock_exchange_realtime_stock_prices_spec.rb +1 -1
- data/spec/models/api_response_stock_exchange_securities_spec.rb +1 -1
- data/spec/models/api_response_stock_exchange_stock_price_adjustments_spec.rb +1 -1
- data/spec/models/api_response_stock_exchange_stock_prices_spec.rb +1 -1
- data/spec/models/api_response_stock_exchanges_spec.rb +1 -1
- data/spec/models/api_response_stock_market_index_historical_data_spec.rb +1 -1
- data/spec/models/api_response_stock_market_indices_search_spec.rb +1 -1
- data/spec/models/api_response_stock_market_indices_spec.rb +1 -1
- data/spec/models/api_response_zacks_analyst_ratings_spec.rb +1 -1
- data/spec/models/api_response_zacks_eps_surprises_spec.rb +1 -1
- data/spec/models/api_response_zacks_sales_surprises_spec.rb +1 -1
- data/spec/models/average_daily_trading_volume_technical_value_spec.rb +1 -1
- data/spec/models/average_directional_index_technical_value_spec.rb +1 -1
- data/spec/models/average_true_range_technical_value_spec.rb +1 -1
- data/spec/models/awesome_oscillator_technical_value_spec.rb +1 -1
- data/spec/models/bollinger_bands_technical_value_spec.rb +1 -1
- data/spec/models/chaikin_money_flow_technical_value_spec.rb +1 -1
- data/spec/models/commodity_channel_index_technical_value_spec.rb +1 -1
- data/spec/models/company_filing_spec.rb +1 -1
- data/spec/models/company_news_spec.rb +1 -1
- data/spec/models/company_news_summary_spec.rb +1 -1
- data/spec/models/company_spec.rb +1 -1
- data/spec/models/company_summary_spec.rb +1 -1
- data/spec/models/crypto_ask_spec.rb +1 -1
- data/spec/models/crypto_bid_spec.rb +1 -1
- data/spec/models/crypto_book_entry_spec.rb +1 -1
- data/spec/models/crypto_currency_spec.rb +1 -1
- data/spec/models/crypto_exchange_spec.rb +1 -1
- data/spec/models/crypto_exchange_summary_spec.rb +1 -1
- data/spec/models/crypto_pair_spec.rb +1 -1
- data/spec/models/crypto_pair_summary_spec.rb +1 -1
- data/spec/models/crypto_price_spec.rb +1 -1
- data/spec/models/crypto_snapshot_spec.rb +1 -1
- data/spec/models/crypto_stat_spec.rb +1 -1
- data/spec/models/data_tag_spec.rb +1 -1
- data/spec/models/data_tag_summary_spec.rb +1 -1
- data/spec/models/detrended_price_oscillator_technical_value_spec.rb +1 -1
- data/spec/models/dividend_record_spec.rb +1 -1
- data/spec/models/donchian_channel_technical_value_spec.rb +1 -1
- data/spec/models/earnings_record_spec.rb +1 -1
- data/spec/models/ease_of_movement_technical_value_spec.rb +1 -1
- data/spec/models/economic_index_spec.rb +1 -1
- data/spec/models/economic_index_summary_spec.rb +1 -1
- data/spec/models/filing_note_filing_spec.rb +1 -1
- data/spec/models/filing_note_spec.rb +1 -1
- data/spec/models/filing_note_summary_spec.rb +1 -1
- data/spec/models/filing_spec.rb +1 -1
- data/spec/models/filing_summary_spec.rb +1 -1
- data/spec/models/force_index_technical_value_spec.rb +1 -1
- data/spec/models/forex_currency_spec.rb +1 -1
- data/spec/models/forex_pair_spec.rb +1 -1
- data/spec/models/forex_price_spec.rb +1 -1
- data/spec/models/fundamental_spec.rb +1 -1
- data/spec/models/fundamental_summary_spec.rb +1 -1
- data/spec/models/historical_data_spec.rb +1 -1
- data/spec/models/ichimoku_kinko_hyo_technical_value_spec.rb +1 -1
- data/spec/models/intraday_stock_price_spec.rb +1 -1
- data/spec/models/keltner_channel_technical_value_spec.rb +1 -1
- data/spec/models/know_sure_thing_technical_value_spec.rb +1 -1
- data/spec/models/mass_index_technical_value_spec.rb +1 -1
- data/spec/models/money_flow_index_technical_value_spec.rb +1 -1
- data/spec/models/moving_average_convergence_divergence_technical_value_spec.rb +1 -1
- data/spec/models/municipality_financial_spec.rb +1 -1
- data/spec/models/municipality_spec.rb +1 -1
- data/spec/models/negative_volume_index_technical_value_spec.rb +1 -1
- data/spec/models/on_balance_volume_mean_technical_value_spec.rb +1 -1
- data/spec/models/on_balance_volume_technical_value_spec.rb +1 -1
- data/spec/models/option_chain_spec.rb +1 -1
- data/spec/models/option_price_spec.rb +1 -1
- data/spec/models/option_spec.rb +1 -1
- data/spec/models/realtime_stock_price_security_spec.rb +1 -1
- data/spec/models/realtime_stock_price_spec.rb +1 -1
- data/spec/models/relative_strength_index_technical_value_spec.rb +1 -1
- data/spec/models/reported_financial_dimension_spec.rb +1 -1
- data/spec/models/reported_financial_spec.rb +1 -1
- data/spec/models/reported_tag_spec.rb +1 -1
- data/spec/models/security_screen_clause_spec.rb +1 -1
- data/spec/models/security_screen_group_spec.rb +1 -1
- data/spec/models/security_screen_result_data_spec.rb +1 -1
- data/spec/models/security_screen_result_spec.rb +1 -1
- data/spec/models/security_spec.rb +1 -1
- data/spec/models/security_summary_spec.rb +1 -1
- data/spec/models/sic_index_spec.rb +1 -1
- data/spec/models/simple_moving_average_technical_value_spec.rb +1 -1
- data/spec/models/standardized_financial_spec.rb +1 -1
- data/spec/models/stochastic_oscillator_technical_value_spec.rb +1 -1
- data/spec/models/stock_exchange_spec.rb +1 -1
- data/spec/models/stock_market_index_spec.rb +1 -1
- data/spec/models/stock_market_index_summary_spec.rb +1 -1
- data/spec/models/stock_price_adjustment_spec.rb +1 -1
- data/spec/models/stock_price_adjustment_summary_spec.rb +1 -1
- data/spec/models/stock_price_spec.rb +1 -1
- data/spec/models/stock_price_summary_spec.rb +1 -1
- data/spec/models/technical_indicator_spec.rb +1 -1
- data/spec/models/triple_exponential_average_technical_value_spec.rb +1 -1
- data/spec/models/true_strength_index_technical_value_spec.rb +1 -1
- data/spec/models/ultimate_oscillator_technical_value_spec.rb +1 -1
- data/spec/models/volume_price_trend_technical_value_spec.rb +1 -1
- data/spec/models/volume_weighted_average_price_value_spec.rb +1 -1
- data/spec/models/vortex_indicator_technical_value_spec.rb +1 -1
- data/spec/models/williams_r_technical_value_spec.rb +1 -1
- data/spec/models/zacks_analyst_rating_snapshot_spec.rb +1 -1
- data/spec/models/zacks_analyst_rating_spec.rb +1 -1
- data/spec/models/zacks_analyst_rating_summary_spec.rb +1 -1
- data/spec/models/zacks_eps_surprise_spec.rb +1 -1
- data/spec/models/zacks_eps_surprise_summary_spec.rb +1 -1
- data/spec/models/zacks_sales_surprise_spec.rb +1 -1
- data/spec/models/zacks_sales_surprise_summary_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +6 -2
data/docs/HistoricalData.md
CHANGED
@@ -1,9 +1,21 @@
|
|
1
|
-
# Intrinio::HistoricalData
|
2
1
|
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
|
2
|
+
|
3
|
+
[//]: # (CLASS:Intrinio::HistoricalData)
|
4
|
+
|
5
|
+
[//]: # (KIND:object)
|
6
|
+
|
7
|
+
### Intrinio::HistoricalData
|
8
|
+
|
9
|
+
#### Properties
|
10
|
+
|
11
|
+
[//]: # (START_DEFINITION)
|
12
|
+
|
13
|
+
Name | Type | Description
|
14
|
+
------------ | ------------- | -------------
|
15
|
+
**date** | Date | The date that the value is present
|
16
|
+
**value** | Float | The historical value
|
17
|
+
|
18
|
+
[//]: # (END_DEFINITION)
|
19
|
+
|
8
20
|
|
9
21
|
|
data/docs/HistoricalDataApi.md
CHANGED
@@ -7,21 +7,51 @@ Method | HTTP request | Description
|
|
7
7
|
[**get_historical_data**](HistoricalDataApi.md#get_historical_data) | **GET** /historical_data/{identifier}/{tag} | Historical Data
|
8
8
|
|
9
9
|
|
10
|
-
|
10
|
+
|
11
|
+
[//]: # (START_OPERATION)
|
12
|
+
|
13
|
+
[//]: # (CLASS:Intrinio::HistoricalDataApi)
|
14
|
+
|
15
|
+
[//]: # (METHOD:get_historical_data)
|
16
|
+
|
17
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseHistoricalData)
|
18
|
+
|
19
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
20
|
+
|
21
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseHistoricalData.md)
|
22
|
+
|
23
|
+
[//]: # (OPERATION:get_historical_data_v2)
|
24
|
+
|
25
|
+
[//]: # (ENDPOINT:/historical_data/{identifier}/{tag})
|
26
|
+
|
27
|
+
[//]: # (DOCUMENT_LINK:HistoricalDataApi.md#get_historical_data)
|
28
|
+
|
29
|
+
## **get_historical_data**
|
30
|
+
|
31
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_historical_data_v2)
|
32
|
+
|
33
|
+
[//]: # (START_OVERVIEW)
|
34
|
+
|
11
35
|
> ApiResponseHistoricalData get_historical_data(identifier, tag, opts)
|
12
36
|
|
13
|
-
Historical Data
|
37
|
+
#### Historical Data
|
38
|
+
|
14
39
|
|
15
40
|
Returns historical values for the given `tag` and the entity represented by the given `identifier`
|
16
41
|
|
42
|
+
[//]: # (END_OVERVIEW)
|
43
|
+
|
17
44
|
### Example
|
45
|
+
|
46
|
+
[//]: # (START_CODE_EXAMPLE)
|
47
|
+
|
18
48
|
```ruby
|
19
49
|
# Load the gem
|
20
50
|
require 'intrinio-sdk'
|
21
51
|
|
22
52
|
# Setup authorization
|
23
53
|
Intrinio.configure do |config|
|
24
|
-
config.api_key['api_key'] = '
|
54
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
25
55
|
end
|
26
56
|
|
27
57
|
historicalData_api = Intrinio::HistoricalDataApi.new
|
@@ -48,21 +78,33 @@ rescue Intrinio::ApiError => e
|
|
48
78
|
end
|
49
79
|
```
|
50
80
|
|
81
|
+
[//]: # (END_CODE_EXAMPLE)
|
82
|
+
|
83
|
+
[//]: # (START_DEFINITION)
|
84
|
+
|
51
85
|
### Parameters
|
52
86
|
|
87
|
+
[//]: # (START_PARAMETERS)
|
88
|
+
|
89
|
+
|
53
90
|
Name | Type | Description | Notes
|
54
91
|
------------- | ------------- | ------------- | -------------
|
55
|
-
**identifier** |
|
56
|
-
**tag** |
|
57
|
-
**frequency** |
|
58
|
-
**type** |
|
59
|
-
**start_date** |
|
60
|
-
**end_date** |
|
61
|
-
**sort_order** |
|
62
|
-
**page_size** |
|
63
|
-
**next_page** |
|
92
|
+
**identifier** | String| An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) |
|
93
|
+
**tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |
|
94
|
+
**frequency** | String| Return historical data in the given frequency | [optional] [default to daily]
|
95
|
+
**type** | String| Filter by type, when applicable | [optional]
|
96
|
+
**start_date** | Date| Get historical data on or after this date | [optional]
|
97
|
+
**end_date** | Date| Get historical date on or before this date | [optional]
|
98
|
+
**sort_order** | String| Sort by date `asc` or `desc` | [optional] [default to desc]
|
99
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
100
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
101
|
+
<br/>
|
102
|
+
|
103
|
+
[//]: # (END_PARAMETERS)
|
64
104
|
|
65
105
|
### Return type
|
66
106
|
|
67
107
|
[**ApiResponseHistoricalData**](ApiResponseHistoricalData.md)
|
68
108
|
|
109
|
+
[//]: # (END_OPERATION)
|
110
|
+
|
@@ -1,13 +1,25 @@
|
|
1
|
-
|
2
|
-
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
1
|
+
|
2
|
+
|
3
|
+
[//]: # (CLASS:Intrinio::IchimokuKinkoHyoTechnicalValue)
|
4
|
+
|
5
|
+
[//]: # (KIND:object)
|
6
|
+
|
7
|
+
### Intrinio::IchimokuKinkoHyoTechnicalValue
|
8
|
+
|
9
|
+
#### Properties
|
10
|
+
|
11
|
+
[//]: # (START_DEFINITION)
|
12
|
+
|
13
|
+
Name | Type | Description
|
14
|
+
------------ | ------------- | -------------
|
15
|
+
**date_time** | DateTime | The date_time of the observation
|
16
|
+
**chikou_span** | Float | The Chikou Span (Lagging Span) value of the Ichimoku Kinko Hyo calculation
|
17
|
+
**kijun_sen** | Float | The Kijun-sen (Base Line) value of the Ichimoku Kinko Hyo calculation
|
18
|
+
**senkou_span_a** | Float | The Senkou Span A (Leading Span A) value of the Ichimoku Kinko Hyo calculation
|
19
|
+
**senkou_span_b** | Float | The Senkou Span B (Leading Span B) value of the Ichimoku Kinko Hyo calculation
|
20
|
+
**tenkan_sen** | Float | The Tenskan-sen (Conversion Line) value of the Ichimoku Kinko Hyo calculation
|
21
|
+
|
22
|
+
[//]: # (END_DEFINITION)
|
23
|
+
|
12
24
|
|
13
25
|
|
data/docs/IndexApi.md
CHANGED
@@ -24,19 +24,50 @@ Method | HTTP request | Description
|
|
24
24
|
[**search_stock_markets_indices**](IndexApi.md#search_stock_markets_indices) | **GET** /indices/stock_market/search | Search Stock Market Indices
|
25
25
|
|
26
26
|
|
27
|
-
|
27
|
+
|
28
|
+
[//]: # (START_OPERATION)
|
29
|
+
|
30
|
+
[//]: # (CLASS:Intrinio::IndexApi)
|
31
|
+
|
32
|
+
[//]: # (METHOD:get_all_economic_indices)
|
33
|
+
|
34
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseEconomicIndices)
|
35
|
+
|
36
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
37
|
+
|
38
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseEconomicIndices.md)
|
39
|
+
|
40
|
+
[//]: # (OPERATION:get_all_economic_indices_v2)
|
41
|
+
|
42
|
+
[//]: # (ENDPOINT:/indices/economic)
|
43
|
+
|
44
|
+
[//]: # (DOCUMENT_LINK:IndexApi.md#get_all_economic_indices)
|
45
|
+
|
46
|
+
## **get_all_economic_indices**
|
47
|
+
|
48
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_all_economic_indices_v2)
|
49
|
+
|
50
|
+
[//]: # (START_OVERVIEW)
|
51
|
+
|
28
52
|
> ApiResponseEconomicIndices get_all_economic_indices(opts)
|
29
53
|
|
30
|
-
All Economic Indices
|
54
|
+
#### All Economic Indices
|
55
|
+
|
56
|
+
|
57
|
+
|
58
|
+
[//]: # (END_OVERVIEW)
|
31
59
|
|
32
60
|
### Example
|
61
|
+
|
62
|
+
[//]: # (START_CODE_EXAMPLE)
|
63
|
+
|
33
64
|
```ruby
|
34
65
|
# Load the gem
|
35
66
|
require 'intrinio-sdk'
|
36
67
|
|
37
68
|
# Setup authorization
|
38
69
|
Intrinio.configure do |config|
|
39
|
-
config.api_key['api_key'] = '
|
70
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
40
71
|
end
|
41
72
|
|
42
73
|
index_api = Intrinio::IndexApi.new
|
@@ -54,30 +85,73 @@ rescue Intrinio::ApiError => e
|
|
54
85
|
end
|
55
86
|
```
|
56
87
|
|
88
|
+
[//]: # (END_CODE_EXAMPLE)
|
89
|
+
|
90
|
+
[//]: # (START_DEFINITION)
|
91
|
+
|
57
92
|
### Parameters
|
58
93
|
|
94
|
+
[//]: # (START_PARAMETERS)
|
95
|
+
|
96
|
+
|
59
97
|
Name | Type | Description | Notes
|
60
98
|
------------- | ------------- | ------------- | -------------
|
61
|
-
**page_size** |
|
62
|
-
**next_page** |
|
99
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
100
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
101
|
+
<br/>
|
102
|
+
|
103
|
+
[//]: # (END_PARAMETERS)
|
63
104
|
|
64
105
|
### Return type
|
65
106
|
|
66
107
|
[**ApiResponseEconomicIndices**](ApiResponseEconomicIndices.md)
|
67
108
|
|
68
|
-
#
|
109
|
+
[//]: # (END_OPERATION)
|
110
|
+
|
111
|
+
|
112
|
+
[//]: # (START_OPERATION)
|
113
|
+
|
114
|
+
[//]: # (CLASS:Intrinio::IndexApi)
|
115
|
+
|
116
|
+
[//]: # (METHOD:get_all_sic_indices)
|
117
|
+
|
118
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSICIndices)
|
119
|
+
|
120
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
121
|
+
|
122
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSICIndices.md)
|
123
|
+
|
124
|
+
[//]: # (OPERATION:get_all_sic_indices_v2)
|
125
|
+
|
126
|
+
[//]: # (ENDPOINT:/indices/sic)
|
127
|
+
|
128
|
+
[//]: # (DOCUMENT_LINK:IndexApi.md#get_all_sic_indices)
|
129
|
+
|
130
|
+
## **get_all_sic_indices**
|
131
|
+
|
132
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_all_sic_indices_v2)
|
133
|
+
|
134
|
+
[//]: # (START_OVERVIEW)
|
135
|
+
|
69
136
|
> ApiResponseSICIndices get_all_sic_indices(opts)
|
70
137
|
|
71
|
-
All SIC Indices
|
138
|
+
#### All SIC Indices
|
139
|
+
|
140
|
+
|
141
|
+
|
142
|
+
[//]: # (END_OVERVIEW)
|
72
143
|
|
73
144
|
### Example
|
145
|
+
|
146
|
+
[//]: # (START_CODE_EXAMPLE)
|
147
|
+
|
74
148
|
```ruby
|
75
149
|
# Load the gem
|
76
150
|
require 'intrinio-sdk'
|
77
151
|
|
78
152
|
# Setup authorization
|
79
153
|
Intrinio.configure do |config|
|
80
|
-
config.api_key['api_key'] = '
|
154
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
81
155
|
end
|
82
156
|
|
83
157
|
index_api = Intrinio::IndexApi.new
|
@@ -95,30 +169,73 @@ rescue Intrinio::ApiError => e
|
|
95
169
|
end
|
96
170
|
```
|
97
171
|
|
172
|
+
[//]: # (END_CODE_EXAMPLE)
|
173
|
+
|
174
|
+
[//]: # (START_DEFINITION)
|
175
|
+
|
98
176
|
### Parameters
|
99
177
|
|
178
|
+
[//]: # (START_PARAMETERS)
|
179
|
+
|
180
|
+
|
100
181
|
Name | Type | Description | Notes
|
101
182
|
------------- | ------------- | ------------- | -------------
|
102
|
-
**page_size** |
|
103
|
-
**next_page** |
|
183
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
184
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
185
|
+
<br/>
|
186
|
+
|
187
|
+
[//]: # (END_PARAMETERS)
|
104
188
|
|
105
189
|
### Return type
|
106
190
|
|
107
191
|
[**ApiResponseSICIndices**](ApiResponseSICIndices.md)
|
108
192
|
|
109
|
-
#
|
193
|
+
[//]: # (END_OPERATION)
|
194
|
+
|
195
|
+
|
196
|
+
[//]: # (START_OPERATION)
|
197
|
+
|
198
|
+
[//]: # (CLASS:Intrinio::IndexApi)
|
199
|
+
|
200
|
+
[//]: # (METHOD:get_all_stock_market_indices)
|
201
|
+
|
202
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseStockMarketIndices)
|
203
|
+
|
204
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
205
|
+
|
206
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseStockMarketIndices.md)
|
207
|
+
|
208
|
+
[//]: # (OPERATION:get_all_stock_market_indices_v2)
|
209
|
+
|
210
|
+
[//]: # (ENDPOINT:/indices/stock_market)
|
211
|
+
|
212
|
+
[//]: # (DOCUMENT_LINK:IndexApi.md#get_all_stock_market_indices)
|
213
|
+
|
214
|
+
## **get_all_stock_market_indices**
|
215
|
+
|
216
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_all_stock_market_indices_v2)
|
217
|
+
|
218
|
+
[//]: # (START_OVERVIEW)
|
219
|
+
|
110
220
|
> ApiResponseStockMarketIndices get_all_stock_market_indices(opts)
|
111
221
|
|
112
|
-
All Stock Market Indices
|
222
|
+
#### All Stock Market Indices
|
223
|
+
|
224
|
+
|
225
|
+
|
226
|
+
[//]: # (END_OVERVIEW)
|
113
227
|
|
114
228
|
### Example
|
229
|
+
|
230
|
+
[//]: # (START_CODE_EXAMPLE)
|
231
|
+
|
115
232
|
```ruby
|
116
233
|
# Load the gem
|
117
234
|
require 'intrinio-sdk'
|
118
235
|
|
119
236
|
# Setup authorization
|
120
237
|
Intrinio.configure do |config|
|
121
|
-
config.api_key['api_key'] = '
|
238
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
122
239
|
end
|
123
240
|
|
124
241
|
index_api = Intrinio::IndexApi.new
|
@@ -136,30 +253,73 @@ rescue Intrinio::ApiError => e
|
|
136
253
|
end
|
137
254
|
```
|
138
255
|
|
256
|
+
[//]: # (END_CODE_EXAMPLE)
|
257
|
+
|
258
|
+
[//]: # (START_DEFINITION)
|
259
|
+
|
139
260
|
### Parameters
|
140
261
|
|
262
|
+
[//]: # (START_PARAMETERS)
|
263
|
+
|
264
|
+
|
141
265
|
Name | Type | Description | Notes
|
142
266
|
------------- | ------------- | ------------- | -------------
|
143
|
-
**page_size** |
|
144
|
-
**next_page** |
|
267
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
268
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
269
|
+
<br/>
|
270
|
+
|
271
|
+
[//]: # (END_PARAMETERS)
|
145
272
|
|
146
273
|
### Return type
|
147
274
|
|
148
275
|
[**ApiResponseStockMarketIndices**](ApiResponseStockMarketIndices.md)
|
149
276
|
|
150
|
-
#
|
277
|
+
[//]: # (END_OPERATION)
|
278
|
+
|
279
|
+
|
280
|
+
[//]: # (START_OPERATION)
|
281
|
+
|
282
|
+
[//]: # (CLASS:Intrinio::IndexApi)
|
283
|
+
|
284
|
+
[//]: # (METHOD:get_economic_index_by_id)
|
285
|
+
|
286
|
+
[//]: # (RETURN_TYPE:Intrinio::EconomicIndex)
|
287
|
+
|
288
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
289
|
+
|
290
|
+
[//]: # (RETURN_TYPE_DOC:EconomicIndex.md)
|
291
|
+
|
292
|
+
[//]: # (OPERATION:get_economic_index_by_id_v2)
|
293
|
+
|
294
|
+
[//]: # (ENDPOINT:/indices/economic/{identifier})
|
295
|
+
|
296
|
+
[//]: # (DOCUMENT_LINK:IndexApi.md#get_economic_index_by_id)
|
297
|
+
|
298
|
+
## **get_economic_index_by_id**
|
299
|
+
|
300
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_economic_index_by_id_v2)
|
301
|
+
|
302
|
+
[//]: # (START_OVERVIEW)
|
303
|
+
|
151
304
|
> EconomicIndex get_economic_index_by_id(identifier)
|
152
305
|
|
153
|
-
Lookup Economic Index
|
306
|
+
#### Lookup Economic Index
|
307
|
+
|
308
|
+
|
309
|
+
|
310
|
+
[//]: # (END_OVERVIEW)
|
154
311
|
|
155
312
|
### Example
|
313
|
+
|
314
|
+
[//]: # (START_CODE_EXAMPLE)
|
315
|
+
|
156
316
|
```ruby
|
157
317
|
# Load the gem
|
158
318
|
require 'intrinio-sdk'
|
159
319
|
|
160
320
|
# Setup authorization
|
161
321
|
Intrinio.configure do |config|
|
162
|
-
config.api_key['api_key'] = '
|
322
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
163
323
|
end
|
164
324
|
|
165
325
|
index_api = Intrinio::IndexApi.new
|
@@ -175,31 +335,73 @@ rescue Intrinio::ApiError => e
|
|
175
335
|
end
|
176
336
|
```
|
177
337
|
|
338
|
+
[//]: # (END_CODE_EXAMPLE)
|
339
|
+
|
340
|
+
[//]: # (START_DEFINITION)
|
341
|
+
|
178
342
|
### Parameters
|
179
343
|
|
344
|
+
[//]: # (START_PARAMETERS)
|
345
|
+
|
346
|
+
|
180
347
|
Name | Type | Description | Notes
|
181
348
|
------------- | ------------- | ------------- | -------------
|
182
|
-
**identifier** |
|
349
|
+
**identifier** | String| An Index Identifier (symbol, Intrinio ID) |
|
350
|
+
<br/>
|
351
|
+
|
352
|
+
[//]: # (END_PARAMETERS)
|
183
353
|
|
184
354
|
### Return type
|
185
355
|
|
186
356
|
[**EconomicIndex**](EconomicIndex.md)
|
187
357
|
|
188
|
-
#
|
358
|
+
[//]: # (END_OPERATION)
|
359
|
+
|
360
|
+
|
361
|
+
[//]: # (START_OPERATION)
|
362
|
+
|
363
|
+
[//]: # (CLASS:Intrinio::IndexApi)
|
364
|
+
|
365
|
+
[//]: # (METHOD:get_economic_index_data_point_number)
|
366
|
+
|
367
|
+
[//]: # (RETURN_TYPE:Float)
|
368
|
+
|
369
|
+
[//]: # (RETURN_TYPE_KIND:primitive)
|
370
|
+
|
371
|
+
[//]: # (RETURN_TYPE_DOC:)
|
372
|
+
|
373
|
+
[//]: # (OPERATION:get_economic_index_data_point_number_v2)
|
374
|
+
|
375
|
+
[//]: # (ENDPOINT:/indices/economic/{identifier}/data_point/{tag}/number)
|
376
|
+
|
377
|
+
[//]: # (DOCUMENT_LINK:IndexApi.md#get_economic_index_data_point_number)
|
378
|
+
|
379
|
+
## **get_economic_index_data_point_number**
|
380
|
+
|
381
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_economic_index_data_point_number_v2)
|
382
|
+
|
383
|
+
[//]: # (START_OVERVIEW)
|
384
|
+
|
189
385
|
> Float get_economic_index_data_point_number(identifier, tag)
|
190
386
|
|
191
|
-
Data Point (Number) for an Economic Index
|
387
|
+
#### Data Point (Number) for an Economic Index
|
388
|
+
|
192
389
|
|
193
390
|
Returns a numeric value for the given `tag` for the Economic Index with the given `identifier`
|
194
391
|
|
392
|
+
[//]: # (END_OVERVIEW)
|
393
|
+
|
195
394
|
### Example
|
395
|
+
|
396
|
+
[//]: # (START_CODE_EXAMPLE)
|
397
|
+
|
196
398
|
```ruby
|
197
399
|
# Load the gem
|
198
400
|
require 'intrinio-sdk'
|
199
401
|
|
200
402
|
# Setup authorization
|
201
403
|
Intrinio.configure do |config|
|
202
|
-
config.api_key['api_key'] = '
|
404
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
203
405
|
end
|
204
406
|
|
205
407
|
index_api = Intrinio::IndexApi.new
|
@@ -217,32 +419,74 @@ rescue Intrinio::ApiError => e
|
|
217
419
|
end
|
218
420
|
```
|
219
421
|
|
422
|
+
[//]: # (END_CODE_EXAMPLE)
|
423
|
+
|
424
|
+
[//]: # (START_DEFINITION)
|
425
|
+
|
220
426
|
### Parameters
|
221
427
|
|
428
|
+
[//]: # (START_PARAMETERS)
|
429
|
+
|
430
|
+
|
222
431
|
Name | Type | Description | Notes
|
223
432
|
------------- | ------------- | ------------- | -------------
|
224
|
-
**identifier** |
|
225
|
-
**tag** |
|
433
|
+
**identifier** | String| An Index Identifier (symbol, Intrinio ID) |
|
434
|
+
**tag** | String| An Intrinio data tag <a href='https://data.intrinio.com/data-tags/economic'>reference</a> |
|
435
|
+
<br/>
|
436
|
+
|
437
|
+
[//]: # (END_PARAMETERS)
|
226
438
|
|
227
439
|
### Return type
|
228
440
|
|
229
441
|
**Float**
|
230
442
|
|
231
|
-
#
|
443
|
+
[//]: # (END_OPERATION)
|
444
|
+
|
445
|
+
|
446
|
+
[//]: # (START_OPERATION)
|
447
|
+
|
448
|
+
[//]: # (CLASS:Intrinio::IndexApi)
|
449
|
+
|
450
|
+
[//]: # (METHOD:get_economic_index_data_point_text)
|
451
|
+
|
452
|
+
[//]: # (RETURN_TYPE:String)
|
453
|
+
|
454
|
+
[//]: # (RETURN_TYPE_KIND:primitive)
|
455
|
+
|
456
|
+
[//]: # (RETURN_TYPE_DOC:)
|
457
|
+
|
458
|
+
[//]: # (OPERATION:get_economic_index_data_point_text_v2)
|
459
|
+
|
460
|
+
[//]: # (ENDPOINT:/indices/economic/{identifier}/data_point/{tag}/text)
|
461
|
+
|
462
|
+
[//]: # (DOCUMENT_LINK:IndexApi.md#get_economic_index_data_point_text)
|
463
|
+
|
464
|
+
## **get_economic_index_data_point_text**
|
465
|
+
|
466
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_economic_index_data_point_text_v2)
|
467
|
+
|
468
|
+
[//]: # (START_OVERVIEW)
|
469
|
+
|
232
470
|
> String get_economic_index_data_point_text(identifier, tag)
|
233
471
|
|
234
|
-
Data Point (Text) for an Economic Index
|
472
|
+
#### Data Point (Text) for an Economic Index
|
473
|
+
|
235
474
|
|
236
475
|
Returns a text value for the given `tag` for the Economic Index with the given `identifier`
|
237
476
|
|
477
|
+
[//]: # (END_OVERVIEW)
|
478
|
+
|
238
479
|
### Example
|
480
|
+
|
481
|
+
[//]: # (START_CODE_EXAMPLE)
|
482
|
+
|
239
483
|
```ruby
|
240
484
|
# Load the gem
|
241
485
|
require 'intrinio-sdk'
|
242
486
|
|
243
487
|
# Setup authorization
|
244
488
|
Intrinio.configure do |config|
|
245
|
-
config.api_key['api_key'] = '
|
489
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
246
490
|
end
|
247
491
|
|
248
492
|
index_api = Intrinio::IndexApi.new
|
@@ -260,32 +504,74 @@ rescue Intrinio::ApiError => e
|
|
260
504
|
end
|
261
505
|
```
|
262
506
|
|
507
|
+
[//]: # (END_CODE_EXAMPLE)
|
508
|
+
|
509
|
+
[//]: # (START_DEFINITION)
|
510
|
+
|
263
511
|
### Parameters
|
264
512
|
|
513
|
+
[//]: # (START_PARAMETERS)
|
514
|
+
|
515
|
+
|
265
516
|
Name | Type | Description | Notes
|
266
517
|
------------- | ------------- | ------------- | -------------
|
267
|
-
**identifier** |
|
268
|
-
**tag** |
|
518
|
+
**identifier** | String| An Index Identifier (symbol, Intrinio ID) |
|
519
|
+
**tag** | String| An Intrinio data tag ID or code-name |
|
520
|
+
<br/>
|
521
|
+
|
522
|
+
[//]: # (END_PARAMETERS)
|
269
523
|
|
270
524
|
### Return type
|
271
525
|
|
272
526
|
**String**
|
273
527
|
|
274
|
-
#
|
528
|
+
[//]: # (END_OPERATION)
|
529
|
+
|
530
|
+
|
531
|
+
[//]: # (START_OPERATION)
|
532
|
+
|
533
|
+
[//]: # (CLASS:Intrinio::IndexApi)
|
534
|
+
|
535
|
+
[//]: # (METHOD:get_economic_index_historical_data)
|
536
|
+
|
537
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseEconomicIndexHistoricalData)
|
538
|
+
|
539
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
540
|
+
|
541
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseEconomicIndexHistoricalData.md)
|
542
|
+
|
543
|
+
[//]: # (OPERATION:get_economic_index_historical_data_v2)
|
544
|
+
|
545
|
+
[//]: # (ENDPOINT:/indices/economic/{identifier}/historical_data/{tag})
|
546
|
+
|
547
|
+
[//]: # (DOCUMENT_LINK:IndexApi.md#get_economic_index_historical_data)
|
548
|
+
|
549
|
+
## **get_economic_index_historical_data**
|
550
|
+
|
551
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_economic_index_historical_data_v2)
|
552
|
+
|
553
|
+
[//]: # (START_OVERVIEW)
|
554
|
+
|
275
555
|
> ApiResponseEconomicIndexHistoricalData get_economic_index_historical_data(identifier, tag, opts)
|
276
556
|
|
277
|
-
Historical Data for an Economic Index
|
557
|
+
#### Historical Data for an Economic Index
|
558
|
+
|
278
559
|
|
279
560
|
Returns historical values for the given `tag` and the Economic Index with the given `identifier`
|
280
561
|
|
562
|
+
[//]: # (END_OVERVIEW)
|
563
|
+
|
281
564
|
### Example
|
565
|
+
|
566
|
+
[//]: # (START_CODE_EXAMPLE)
|
567
|
+
|
282
568
|
```ruby
|
283
569
|
# Load the gem
|
284
570
|
require 'intrinio-sdk'
|
285
571
|
|
286
572
|
# Setup authorization
|
287
573
|
Intrinio.configure do |config|
|
288
|
-
config.api_key['api_key'] = '
|
574
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
289
575
|
end
|
290
576
|
|
291
577
|
index_api = Intrinio::IndexApi.new
|
@@ -311,36 +597,79 @@ rescue Intrinio::ApiError => e
|
|
311
597
|
end
|
312
598
|
```
|
313
599
|
|
600
|
+
[//]: # (END_CODE_EXAMPLE)
|
601
|
+
|
602
|
+
[//]: # (START_DEFINITION)
|
603
|
+
|
314
604
|
### Parameters
|
315
605
|
|
606
|
+
[//]: # (START_PARAMETERS)
|
607
|
+
|
608
|
+
|
316
609
|
Name | Type | Description | Notes
|
317
610
|
------------- | ------------- | ------------- | -------------
|
318
|
-
**identifier** |
|
319
|
-
**tag** |
|
320
|
-
**type** |
|
321
|
-
**start_date** |
|
322
|
-
**end_date** |
|
323
|
-
**sort_order** |
|
324
|
-
**page_size** |
|
325
|
-
**next_page** |
|
611
|
+
**identifier** | String| An Index Identifier (symbol, Intrinio ID) |
|
612
|
+
**tag** | String| An Intrinio data tag <a href='https://data.intrinio.com/data-tags/economic'>reference</a> |
|
613
|
+
**type** | String| Filter by type, when applicable | [optional]
|
614
|
+
**start_date** | Date| Get historical data on or after this date | [optional]
|
615
|
+
**end_date** | Date| Get historical data on or before this date | [optional]
|
616
|
+
**sort_order** | String| Sort by date `asc` or `desc` | [optional] [default to desc]
|
617
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
618
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
619
|
+
<br/>
|
620
|
+
|
621
|
+
[//]: # (END_PARAMETERS)
|
326
622
|
|
327
623
|
### Return type
|
328
624
|
|
329
625
|
[**ApiResponseEconomicIndexHistoricalData**](ApiResponseEconomicIndexHistoricalData.md)
|
330
626
|
|
331
|
-
#
|
627
|
+
[//]: # (END_OPERATION)
|
628
|
+
|
629
|
+
|
630
|
+
[//]: # (START_OPERATION)
|
631
|
+
|
632
|
+
[//]: # (CLASS:Intrinio::IndexApi)
|
633
|
+
|
634
|
+
[//]: # (METHOD:get_sic_index_by_id)
|
635
|
+
|
636
|
+
[//]: # (RETURN_TYPE:Intrinio::SICIndex)
|
637
|
+
|
638
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
639
|
+
|
640
|
+
[//]: # (RETURN_TYPE_DOC:SICIndex.md)
|
641
|
+
|
642
|
+
[//]: # (OPERATION:get_sic_index_by_id_v2)
|
643
|
+
|
644
|
+
[//]: # (ENDPOINT:/indices/sic/{identifier})
|
645
|
+
|
646
|
+
[//]: # (DOCUMENT_LINK:IndexApi.md#get_sic_index_by_id)
|
647
|
+
|
648
|
+
## **get_sic_index_by_id**
|
649
|
+
|
650
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_sic_index_by_id_v2)
|
651
|
+
|
652
|
+
[//]: # (START_OVERVIEW)
|
653
|
+
|
332
654
|
> SICIndex get_sic_index_by_id(identifier)
|
333
655
|
|
334
|
-
Lookup SIC Index
|
656
|
+
#### Lookup SIC Index
|
657
|
+
|
658
|
+
|
659
|
+
|
660
|
+
[//]: # (END_OVERVIEW)
|
335
661
|
|
336
662
|
### Example
|
663
|
+
|
664
|
+
[//]: # (START_CODE_EXAMPLE)
|
665
|
+
|
337
666
|
```ruby
|
338
667
|
# Load the gem
|
339
668
|
require 'intrinio-sdk'
|
340
669
|
|
341
670
|
# Setup authorization
|
342
671
|
Intrinio.configure do |config|
|
343
|
-
config.api_key['api_key'] = '
|
672
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
344
673
|
end
|
345
674
|
|
346
675
|
index_api = Intrinio::IndexApi.new
|
@@ -356,31 +685,73 @@ rescue Intrinio::ApiError => e
|
|
356
685
|
end
|
357
686
|
```
|
358
687
|
|
688
|
+
[//]: # (END_CODE_EXAMPLE)
|
689
|
+
|
690
|
+
[//]: # (START_DEFINITION)
|
691
|
+
|
359
692
|
### Parameters
|
360
693
|
|
694
|
+
[//]: # (START_PARAMETERS)
|
695
|
+
|
696
|
+
|
361
697
|
Name | Type | Description | Notes
|
362
698
|
------------- | ------------- | ------------- | -------------
|
363
|
-
**identifier** |
|
699
|
+
**identifier** | String| An Index Identifier (symbol, Intrinio ID) |
|
700
|
+
<br/>
|
701
|
+
|
702
|
+
[//]: # (END_PARAMETERS)
|
364
703
|
|
365
704
|
### Return type
|
366
705
|
|
367
706
|
[**SICIndex**](SICIndex.md)
|
368
707
|
|
369
|
-
#
|
708
|
+
[//]: # (END_OPERATION)
|
709
|
+
|
710
|
+
|
711
|
+
[//]: # (START_OPERATION)
|
712
|
+
|
713
|
+
[//]: # (CLASS:Intrinio::IndexApi)
|
714
|
+
|
715
|
+
[//]: # (METHOD:get_sic_index_data_point_number)
|
716
|
+
|
717
|
+
[//]: # (RETURN_TYPE:Float)
|
718
|
+
|
719
|
+
[//]: # (RETURN_TYPE_KIND:primitive)
|
720
|
+
|
721
|
+
[//]: # (RETURN_TYPE_DOC:)
|
722
|
+
|
723
|
+
[//]: # (OPERATION:get_sic_index_data_point_number_v2)
|
724
|
+
|
725
|
+
[//]: # (ENDPOINT:/indices/sic/{identifier}/data_point/{tag}/number)
|
726
|
+
|
727
|
+
[//]: # (DOCUMENT_LINK:IndexApi.md#get_sic_index_data_point_number)
|
728
|
+
|
729
|
+
## **get_sic_index_data_point_number**
|
730
|
+
|
731
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_sic_index_data_point_number_v2)
|
732
|
+
|
733
|
+
[//]: # (START_OVERVIEW)
|
734
|
+
|
370
735
|
> Float get_sic_index_data_point_number(identifier, tag)
|
371
736
|
|
372
|
-
Data Point (Number) for an SIC Index
|
737
|
+
#### Data Point (Number) for an SIC Index
|
738
|
+
|
373
739
|
|
374
740
|
Returns a numeric value for the given `tag` for the SIC Index with the given `identifier`
|
375
741
|
|
742
|
+
[//]: # (END_OVERVIEW)
|
743
|
+
|
376
744
|
### Example
|
745
|
+
|
746
|
+
[//]: # (START_CODE_EXAMPLE)
|
747
|
+
|
377
748
|
```ruby
|
378
749
|
# Load the gem
|
379
750
|
require 'intrinio-sdk'
|
380
751
|
|
381
752
|
# Setup authorization
|
382
753
|
Intrinio.configure do |config|
|
383
|
-
config.api_key['api_key'] = '
|
754
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
384
755
|
end
|
385
756
|
|
386
757
|
index_api = Intrinio::IndexApi.new
|
@@ -398,32 +769,74 @@ rescue Intrinio::ApiError => e
|
|
398
769
|
end
|
399
770
|
```
|
400
771
|
|
772
|
+
[//]: # (END_CODE_EXAMPLE)
|
773
|
+
|
774
|
+
[//]: # (START_DEFINITION)
|
775
|
+
|
401
776
|
### Parameters
|
402
777
|
|
778
|
+
[//]: # (START_PARAMETERS)
|
779
|
+
|
780
|
+
|
403
781
|
Name | Type | Description | Notes
|
404
782
|
------------- | ------------- | ------------- | -------------
|
405
|
-
**identifier** |
|
406
|
-
**tag** |
|
783
|
+
**identifier** | String| An Index Identifier (symbol, Intrinio ID) |
|
784
|
+
**tag** | String| An Intrinio data tag ID or code-name |
|
785
|
+
<br/>
|
786
|
+
|
787
|
+
[//]: # (END_PARAMETERS)
|
407
788
|
|
408
789
|
### Return type
|
409
790
|
|
410
791
|
**Float**
|
411
792
|
|
412
|
-
#
|
793
|
+
[//]: # (END_OPERATION)
|
794
|
+
|
795
|
+
|
796
|
+
[//]: # (START_OPERATION)
|
797
|
+
|
798
|
+
[//]: # (CLASS:Intrinio::IndexApi)
|
799
|
+
|
800
|
+
[//]: # (METHOD:get_sic_index_data_point_text)
|
801
|
+
|
802
|
+
[//]: # (RETURN_TYPE:String)
|
803
|
+
|
804
|
+
[//]: # (RETURN_TYPE_KIND:primitive)
|
805
|
+
|
806
|
+
[//]: # (RETURN_TYPE_DOC:)
|
807
|
+
|
808
|
+
[//]: # (OPERATION:get_sic_index_data_point_text_v2)
|
809
|
+
|
810
|
+
[//]: # (ENDPOINT:/indices/sic/{identifier}/data_point/{tag}/text)
|
811
|
+
|
812
|
+
[//]: # (DOCUMENT_LINK:IndexApi.md#get_sic_index_data_point_text)
|
813
|
+
|
814
|
+
## **get_sic_index_data_point_text**
|
815
|
+
|
816
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_sic_index_data_point_text_v2)
|
817
|
+
|
818
|
+
[//]: # (START_OVERVIEW)
|
819
|
+
|
413
820
|
> String get_sic_index_data_point_text(identifier, tag)
|
414
821
|
|
415
|
-
Data Point (Text) for an SIC Index
|
822
|
+
#### Data Point (Text) for an SIC Index
|
823
|
+
|
416
824
|
|
417
825
|
Returns a text value for the given `tag` for the SIC Index with the given `identifier`
|
418
826
|
|
827
|
+
[//]: # (END_OVERVIEW)
|
828
|
+
|
419
829
|
### Example
|
830
|
+
|
831
|
+
[//]: # (START_CODE_EXAMPLE)
|
832
|
+
|
420
833
|
```ruby
|
421
834
|
# Load the gem
|
422
835
|
require 'intrinio-sdk'
|
423
836
|
|
424
837
|
# Setup authorization
|
425
838
|
Intrinio.configure do |config|
|
426
|
-
config.api_key['api_key'] = '
|
839
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
427
840
|
end
|
428
841
|
|
429
842
|
index_api = Intrinio::IndexApi.new
|
@@ -441,32 +854,74 @@ rescue Intrinio::ApiError => e
|
|
441
854
|
end
|
442
855
|
```
|
443
856
|
|
857
|
+
[//]: # (END_CODE_EXAMPLE)
|
858
|
+
|
859
|
+
[//]: # (START_DEFINITION)
|
860
|
+
|
444
861
|
### Parameters
|
445
862
|
|
863
|
+
[//]: # (START_PARAMETERS)
|
864
|
+
|
865
|
+
|
446
866
|
Name | Type | Description | Notes
|
447
867
|
------------- | ------------- | ------------- | -------------
|
448
|
-
**identifier** |
|
449
|
-
**tag** |
|
868
|
+
**identifier** | String| An Index Identifier (symbol, Intrinio ID) |
|
869
|
+
**tag** | String| An Intrinio data tag ID or code-name |
|
870
|
+
<br/>
|
871
|
+
|
872
|
+
[//]: # (END_PARAMETERS)
|
450
873
|
|
451
874
|
### Return type
|
452
875
|
|
453
876
|
**String**
|
454
877
|
|
455
|
-
#
|
878
|
+
[//]: # (END_OPERATION)
|
879
|
+
|
880
|
+
|
881
|
+
[//]: # (START_OPERATION)
|
882
|
+
|
883
|
+
[//]: # (CLASS:Intrinio::IndexApi)
|
884
|
+
|
885
|
+
[//]: # (METHOD:get_sic_index_historical_data)
|
886
|
+
|
887
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSICIndexHistoricalData)
|
888
|
+
|
889
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
890
|
+
|
891
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSICIndexHistoricalData.md)
|
892
|
+
|
893
|
+
[//]: # (OPERATION:get_sic_index_historical_data_v2)
|
894
|
+
|
895
|
+
[//]: # (ENDPOINT:/indices/sic/{identifier}/historical_data/{tag})
|
896
|
+
|
897
|
+
[//]: # (DOCUMENT_LINK:IndexApi.md#get_sic_index_historical_data)
|
898
|
+
|
899
|
+
## **get_sic_index_historical_data**
|
900
|
+
|
901
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_sic_index_historical_data_v2)
|
902
|
+
|
903
|
+
[//]: # (START_OVERVIEW)
|
904
|
+
|
456
905
|
> ApiResponseSICIndexHistoricalData get_sic_index_historical_data(identifier, tag, opts)
|
457
906
|
|
458
|
-
Historical Data for an SIC Index
|
907
|
+
#### Historical Data for an SIC Index
|
908
|
+
|
459
909
|
|
460
910
|
Returns historical values for the given `tag` and the SIC Index with the given `identifier`
|
461
911
|
|
912
|
+
[//]: # (END_OVERVIEW)
|
913
|
+
|
462
914
|
### Example
|
915
|
+
|
916
|
+
[//]: # (START_CODE_EXAMPLE)
|
917
|
+
|
463
918
|
```ruby
|
464
919
|
# Load the gem
|
465
920
|
require 'intrinio-sdk'
|
466
921
|
|
467
922
|
# Setup authorization
|
468
923
|
Intrinio.configure do |config|
|
469
|
-
config.api_key['api_key'] = '
|
924
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
470
925
|
end
|
471
926
|
|
472
927
|
index_api = Intrinio::IndexApi.new
|
@@ -492,36 +947,79 @@ rescue Intrinio::ApiError => e
|
|
492
947
|
end
|
493
948
|
```
|
494
949
|
|
950
|
+
[//]: # (END_CODE_EXAMPLE)
|
951
|
+
|
952
|
+
[//]: # (START_DEFINITION)
|
953
|
+
|
495
954
|
### Parameters
|
496
955
|
|
956
|
+
[//]: # (START_PARAMETERS)
|
957
|
+
|
958
|
+
|
497
959
|
Name | Type | Description | Notes
|
498
960
|
------------- | ------------- | ------------- | -------------
|
499
|
-
**identifier** |
|
500
|
-
**tag** |
|
501
|
-
**type** |
|
502
|
-
**start_date** |
|
503
|
-
**end_date** |
|
504
|
-
**sort_order** |
|
505
|
-
**page_size** |
|
506
|
-
**next_page** |
|
961
|
+
**identifier** | String| An Index Identifier (symbol, Intrinio ID) |
|
962
|
+
**tag** | String| An Intrinio data tag ID or code-name |
|
963
|
+
**type** | String| Filter by type, when applicable | [optional]
|
964
|
+
**start_date** | Date| Get historical data on or after this date | [optional]
|
965
|
+
**end_date** | Date| Get historical data on or before this date | [optional]
|
966
|
+
**sort_order** | String| Sort by date `asc` or `desc` | [optional] [default to desc]
|
967
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
968
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
969
|
+
<br/>
|
970
|
+
|
971
|
+
[//]: # (END_PARAMETERS)
|
507
972
|
|
508
973
|
### Return type
|
509
974
|
|
510
975
|
[**ApiResponseSICIndexHistoricalData**](ApiResponseSICIndexHistoricalData.md)
|
511
976
|
|
512
|
-
#
|
977
|
+
[//]: # (END_OPERATION)
|
978
|
+
|
979
|
+
|
980
|
+
[//]: # (START_OPERATION)
|
981
|
+
|
982
|
+
[//]: # (CLASS:Intrinio::IndexApi)
|
983
|
+
|
984
|
+
[//]: # (METHOD:get_stock_market_index_by_id)
|
985
|
+
|
986
|
+
[//]: # (RETURN_TYPE:Intrinio::StockMarketIndex)
|
987
|
+
|
988
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
989
|
+
|
990
|
+
[//]: # (RETURN_TYPE_DOC:StockMarketIndex.md)
|
991
|
+
|
992
|
+
[//]: # (OPERATION:get_stock_market_index_by_id_v2)
|
993
|
+
|
994
|
+
[//]: # (ENDPOINT:/indices/stock_market/{identifier})
|
995
|
+
|
996
|
+
[//]: # (DOCUMENT_LINK:IndexApi.md#get_stock_market_index_by_id)
|
997
|
+
|
998
|
+
## **get_stock_market_index_by_id**
|
999
|
+
|
1000
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_stock_market_index_by_id_v2)
|
1001
|
+
|
1002
|
+
[//]: # (START_OVERVIEW)
|
1003
|
+
|
513
1004
|
> StockMarketIndex get_stock_market_index_by_id(identifier)
|
514
1005
|
|
515
|
-
Lookup Stock Market Index
|
1006
|
+
#### Lookup Stock Market Index
|
1007
|
+
|
1008
|
+
|
1009
|
+
|
1010
|
+
[//]: # (END_OVERVIEW)
|
516
1011
|
|
517
1012
|
### Example
|
1013
|
+
|
1014
|
+
[//]: # (START_CODE_EXAMPLE)
|
1015
|
+
|
518
1016
|
```ruby
|
519
1017
|
# Load the gem
|
520
1018
|
require 'intrinio-sdk'
|
521
1019
|
|
522
1020
|
# Setup authorization
|
523
1021
|
Intrinio.configure do |config|
|
524
|
-
config.api_key['api_key'] = '
|
1022
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
525
1023
|
end
|
526
1024
|
|
527
1025
|
index_api = Intrinio::IndexApi.new
|
@@ -537,31 +1035,73 @@ rescue Intrinio::ApiError => e
|
|
537
1035
|
end
|
538
1036
|
```
|
539
1037
|
|
1038
|
+
[//]: # (END_CODE_EXAMPLE)
|
1039
|
+
|
1040
|
+
[//]: # (START_DEFINITION)
|
1041
|
+
|
540
1042
|
### Parameters
|
541
1043
|
|
1044
|
+
[//]: # (START_PARAMETERS)
|
1045
|
+
|
1046
|
+
|
542
1047
|
Name | Type | Description | Notes
|
543
1048
|
------------- | ------------- | ------------- | -------------
|
544
|
-
**identifier** |
|
1049
|
+
**identifier** | String| An Index Identifier (symbol, Intrinio ID) |
|
1050
|
+
<br/>
|
1051
|
+
|
1052
|
+
[//]: # (END_PARAMETERS)
|
545
1053
|
|
546
1054
|
### Return type
|
547
1055
|
|
548
1056
|
[**StockMarketIndex**](StockMarketIndex.md)
|
549
1057
|
|
550
|
-
#
|
1058
|
+
[//]: # (END_OPERATION)
|
1059
|
+
|
1060
|
+
|
1061
|
+
[//]: # (START_OPERATION)
|
1062
|
+
|
1063
|
+
[//]: # (CLASS:Intrinio::IndexApi)
|
1064
|
+
|
1065
|
+
[//]: # (METHOD:get_stock_market_index_data_point_number)
|
1066
|
+
|
1067
|
+
[//]: # (RETURN_TYPE:Float)
|
1068
|
+
|
1069
|
+
[//]: # (RETURN_TYPE_KIND:primitive)
|
1070
|
+
|
1071
|
+
[//]: # (RETURN_TYPE_DOC:)
|
1072
|
+
|
1073
|
+
[//]: # (OPERATION:get_stock_market_index_data_point_number_v2)
|
1074
|
+
|
1075
|
+
[//]: # (ENDPOINT:/indices/stock_market/{identifier}/data_point/{tag}/number)
|
1076
|
+
|
1077
|
+
[//]: # (DOCUMENT_LINK:IndexApi.md#get_stock_market_index_data_point_number)
|
1078
|
+
|
1079
|
+
## **get_stock_market_index_data_point_number**
|
1080
|
+
|
1081
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_stock_market_index_data_point_number_v2)
|
1082
|
+
|
1083
|
+
[//]: # (START_OVERVIEW)
|
1084
|
+
|
551
1085
|
> Float get_stock_market_index_data_point_number(identifier, tag)
|
552
1086
|
|
553
|
-
Data Point (Number) for Stock Market Index
|
1087
|
+
#### Data Point (Number) for Stock Market Index
|
1088
|
+
|
554
1089
|
|
555
1090
|
Returns a numeric value for the given `tag` for the Stock Market Index with the given `identifier`
|
556
1091
|
|
1092
|
+
[//]: # (END_OVERVIEW)
|
1093
|
+
|
557
1094
|
### Example
|
1095
|
+
|
1096
|
+
[//]: # (START_CODE_EXAMPLE)
|
1097
|
+
|
558
1098
|
```ruby
|
559
1099
|
# Load the gem
|
560
1100
|
require 'intrinio-sdk'
|
561
1101
|
|
562
1102
|
# Setup authorization
|
563
1103
|
Intrinio.configure do |config|
|
564
|
-
config.api_key['api_key'] = '
|
1104
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
565
1105
|
end
|
566
1106
|
|
567
1107
|
index_api = Intrinio::IndexApi.new
|
@@ -579,32 +1119,74 @@ rescue Intrinio::ApiError => e
|
|
579
1119
|
end
|
580
1120
|
```
|
581
1121
|
|
1122
|
+
[//]: # (END_CODE_EXAMPLE)
|
1123
|
+
|
1124
|
+
[//]: # (START_DEFINITION)
|
1125
|
+
|
582
1126
|
### Parameters
|
583
1127
|
|
1128
|
+
[//]: # (START_PARAMETERS)
|
1129
|
+
|
1130
|
+
|
584
1131
|
Name | Type | Description | Notes
|
585
1132
|
------------- | ------------- | ------------- | -------------
|
586
|
-
**identifier** |
|
587
|
-
**tag** |
|
1133
|
+
**identifier** | String| An Index Identifier (symbol, Intrinio ID) |
|
1134
|
+
**tag** | String| An Intrinio data tag ID or code-name |
|
1135
|
+
<br/>
|
1136
|
+
|
1137
|
+
[//]: # (END_PARAMETERS)
|
588
1138
|
|
589
1139
|
### Return type
|
590
1140
|
|
591
1141
|
**Float**
|
592
1142
|
|
593
|
-
#
|
1143
|
+
[//]: # (END_OPERATION)
|
1144
|
+
|
1145
|
+
|
1146
|
+
[//]: # (START_OPERATION)
|
1147
|
+
|
1148
|
+
[//]: # (CLASS:Intrinio::IndexApi)
|
1149
|
+
|
1150
|
+
[//]: # (METHOD:get_stock_market_index_data_point_text)
|
1151
|
+
|
1152
|
+
[//]: # (RETURN_TYPE:String)
|
1153
|
+
|
1154
|
+
[//]: # (RETURN_TYPE_KIND:primitive)
|
1155
|
+
|
1156
|
+
[//]: # (RETURN_TYPE_DOC:)
|
1157
|
+
|
1158
|
+
[//]: # (OPERATION:get_stock_market_index_data_point_text_v2)
|
1159
|
+
|
1160
|
+
[//]: # (ENDPOINT:/indices/stock_market/{identifier}/data_point/{tag}/text)
|
1161
|
+
|
1162
|
+
[//]: # (DOCUMENT_LINK:IndexApi.md#get_stock_market_index_data_point_text)
|
1163
|
+
|
1164
|
+
## **get_stock_market_index_data_point_text**
|
1165
|
+
|
1166
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_stock_market_index_data_point_text_v2)
|
1167
|
+
|
1168
|
+
[//]: # (START_OVERVIEW)
|
1169
|
+
|
594
1170
|
> String get_stock_market_index_data_point_text(identifier, tag)
|
595
1171
|
|
596
|
-
Data Point (Text) for Stock Market Index
|
1172
|
+
#### Data Point (Text) for Stock Market Index
|
1173
|
+
|
597
1174
|
|
598
1175
|
Returns a text value for the given `tag` for the Stock Market Index with the given `identifier`
|
599
1176
|
|
1177
|
+
[//]: # (END_OVERVIEW)
|
1178
|
+
|
600
1179
|
### Example
|
1180
|
+
|
1181
|
+
[//]: # (START_CODE_EXAMPLE)
|
1182
|
+
|
601
1183
|
```ruby
|
602
1184
|
# Load the gem
|
603
1185
|
require 'intrinio-sdk'
|
604
1186
|
|
605
1187
|
# Setup authorization
|
606
1188
|
Intrinio.configure do |config|
|
607
|
-
config.api_key['api_key'] = '
|
1189
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
608
1190
|
end
|
609
1191
|
|
610
1192
|
index_api = Intrinio::IndexApi.new
|
@@ -622,32 +1204,74 @@ rescue Intrinio::ApiError => e
|
|
622
1204
|
end
|
623
1205
|
```
|
624
1206
|
|
1207
|
+
[//]: # (END_CODE_EXAMPLE)
|
1208
|
+
|
1209
|
+
[//]: # (START_DEFINITION)
|
1210
|
+
|
625
1211
|
### Parameters
|
626
1212
|
|
1213
|
+
[//]: # (START_PARAMETERS)
|
1214
|
+
|
1215
|
+
|
627
1216
|
Name | Type | Description | Notes
|
628
1217
|
------------- | ------------- | ------------- | -------------
|
629
|
-
**identifier** |
|
630
|
-
**tag** |
|
1218
|
+
**identifier** | String| An Index Identifier (symbol, Intrinio ID) |
|
1219
|
+
**tag** | String| An Intrinio data tag ID or code-name |
|
1220
|
+
<br/>
|
1221
|
+
|
1222
|
+
[//]: # (END_PARAMETERS)
|
631
1223
|
|
632
1224
|
### Return type
|
633
1225
|
|
634
1226
|
**String**
|
635
1227
|
|
636
|
-
#
|
1228
|
+
[//]: # (END_OPERATION)
|
1229
|
+
|
1230
|
+
|
1231
|
+
[//]: # (START_OPERATION)
|
1232
|
+
|
1233
|
+
[//]: # (CLASS:Intrinio::IndexApi)
|
1234
|
+
|
1235
|
+
[//]: # (METHOD:get_stock_market_index_historical_data)
|
1236
|
+
|
1237
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseStockMarketIndexHistoricalData)
|
1238
|
+
|
1239
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
1240
|
+
|
1241
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseStockMarketIndexHistoricalData.md)
|
1242
|
+
|
1243
|
+
[//]: # (OPERATION:get_stock_market_index_historical_data_v2)
|
1244
|
+
|
1245
|
+
[//]: # (ENDPOINT:/indices/stock_market/{identifier}/historical_data/{tag})
|
1246
|
+
|
1247
|
+
[//]: # (DOCUMENT_LINK:IndexApi.md#get_stock_market_index_historical_data)
|
1248
|
+
|
1249
|
+
## **get_stock_market_index_historical_data**
|
1250
|
+
|
1251
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_stock_market_index_historical_data_v2)
|
1252
|
+
|
1253
|
+
[//]: # (START_OVERVIEW)
|
1254
|
+
|
637
1255
|
> ApiResponseStockMarketIndexHistoricalData get_stock_market_index_historical_data(identifier, tag, opts)
|
638
1256
|
|
639
|
-
Historical Data for Stock Market Index
|
1257
|
+
#### Historical Data for Stock Market Index
|
1258
|
+
|
640
1259
|
|
641
1260
|
Returns historical values for the given `tag` and the Stock Market Index with the given `identifier`
|
642
1261
|
|
1262
|
+
[//]: # (END_OVERVIEW)
|
1263
|
+
|
643
1264
|
### Example
|
1265
|
+
|
1266
|
+
[//]: # (START_CODE_EXAMPLE)
|
1267
|
+
|
644
1268
|
```ruby
|
645
1269
|
# Load the gem
|
646
1270
|
require 'intrinio-sdk'
|
647
1271
|
|
648
1272
|
# Setup authorization
|
649
1273
|
Intrinio.configure do |config|
|
650
|
-
config.api_key['api_key'] = '
|
1274
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
651
1275
|
end
|
652
1276
|
|
653
1277
|
index_api = Intrinio::IndexApi.new
|
@@ -673,38 +1297,80 @@ rescue Intrinio::ApiError => e
|
|
673
1297
|
end
|
674
1298
|
```
|
675
1299
|
|
1300
|
+
[//]: # (END_CODE_EXAMPLE)
|
1301
|
+
|
1302
|
+
[//]: # (START_DEFINITION)
|
1303
|
+
|
676
1304
|
### Parameters
|
677
1305
|
|
1306
|
+
[//]: # (START_PARAMETERS)
|
1307
|
+
|
1308
|
+
|
678
1309
|
Name | Type | Description | Notes
|
679
1310
|
------------- | ------------- | ------------- | -------------
|
680
|
-
**identifier** |
|
681
|
-
**tag** |
|
682
|
-
**type** |
|
683
|
-
**start_date** |
|
684
|
-
**end_date** |
|
685
|
-
**sort_order** |
|
686
|
-
**page_size** |
|
687
|
-
**next_page** |
|
1311
|
+
**identifier** | String| An Index Identifier (symbol, Intrinio ID) |
|
1312
|
+
**tag** | String| An Intrinio data tag ID or code-name |
|
1313
|
+
**type** | String| Filter by type, when applicable | [optional]
|
1314
|
+
**start_date** | Date| Get historical data on or after this date | [optional]
|
1315
|
+
**end_date** | Date| Get historical data on or before this date | [optional]
|
1316
|
+
**sort_order** | String| Sort by date `asc` or `desc` | [optional] [default to desc]
|
1317
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
1318
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
1319
|
+
<br/>
|
1320
|
+
|
1321
|
+
[//]: # (END_PARAMETERS)
|
688
1322
|
|
689
1323
|
### Return type
|
690
1324
|
|
691
1325
|
[**ApiResponseStockMarketIndexHistoricalData**](ApiResponseStockMarketIndexHistoricalData.md)
|
692
1326
|
|
693
|
-
#
|
1327
|
+
[//]: # (END_OPERATION)
|
1328
|
+
|
1329
|
+
|
1330
|
+
[//]: # (START_OPERATION)
|
1331
|
+
|
1332
|
+
[//]: # (CLASS:Intrinio::IndexApi)
|
1333
|
+
|
1334
|
+
[//]: # (METHOD:search_economic_indices)
|
1335
|
+
|
1336
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseEconomicIndicesSearch)
|
1337
|
+
|
1338
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
1339
|
+
|
1340
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseEconomicIndicesSearch.md)
|
1341
|
+
|
1342
|
+
[//]: # (OPERATION:search_economic_indices_v2)
|
1343
|
+
|
1344
|
+
[//]: # (ENDPOINT:/indices/economic/search)
|
1345
|
+
|
1346
|
+
[//]: # (DOCUMENT_LINK:IndexApi.md#search_economic_indices)
|
1347
|
+
|
1348
|
+
## **search_economic_indices**
|
1349
|
+
|
1350
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/search_economic_indices_v2)
|
1351
|
+
|
1352
|
+
[//]: # (START_OVERVIEW)
|
1353
|
+
|
694
1354
|
> ApiResponseEconomicIndicesSearch search_economic_indices(query, opts)
|
695
1355
|
|
696
|
-
Search Economic Indices
|
1356
|
+
#### Search Economic Indices
|
1357
|
+
|
697
1358
|
|
698
1359
|
Searches for indices using the text in `query`
|
699
1360
|
|
1361
|
+
[//]: # (END_OVERVIEW)
|
1362
|
+
|
700
1363
|
### Example
|
1364
|
+
|
1365
|
+
[//]: # (START_CODE_EXAMPLE)
|
1366
|
+
|
701
1367
|
```ruby
|
702
1368
|
# Load the gem
|
703
1369
|
require 'intrinio-sdk'
|
704
1370
|
|
705
1371
|
# Setup authorization
|
706
1372
|
Intrinio.configure do |config|
|
707
|
-
config.api_key['api_key'] = '
|
1373
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
708
1374
|
end
|
709
1375
|
|
710
1376
|
index_api = Intrinio::IndexApi.new
|
@@ -723,32 +1389,74 @@ rescue Intrinio::ApiError => e
|
|
723
1389
|
end
|
724
1390
|
```
|
725
1391
|
|
1392
|
+
[//]: # (END_CODE_EXAMPLE)
|
1393
|
+
|
1394
|
+
[//]: # (START_DEFINITION)
|
1395
|
+
|
726
1396
|
### Parameters
|
727
1397
|
|
1398
|
+
[//]: # (START_PARAMETERS)
|
1399
|
+
|
1400
|
+
|
728
1401
|
Name | Type | Description | Notes
|
729
1402
|
------------- | ------------- | ------------- | -------------
|
730
|
-
**query** |
|
731
|
-
**page_size** |
|
1403
|
+
**query** | String| Search query |
|
1404
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
1405
|
+
<br/>
|
1406
|
+
|
1407
|
+
[//]: # (END_PARAMETERS)
|
732
1408
|
|
733
1409
|
### Return type
|
734
1410
|
|
735
1411
|
[**ApiResponseEconomicIndicesSearch**](ApiResponseEconomicIndicesSearch.md)
|
736
1412
|
|
737
|
-
#
|
1413
|
+
[//]: # (END_OPERATION)
|
1414
|
+
|
1415
|
+
|
1416
|
+
[//]: # (START_OPERATION)
|
1417
|
+
|
1418
|
+
[//]: # (CLASS:Intrinio::IndexApi)
|
1419
|
+
|
1420
|
+
[//]: # (METHOD:search_sic_indices)
|
1421
|
+
|
1422
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSICIndicesSearch)
|
1423
|
+
|
1424
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
1425
|
+
|
1426
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSICIndicesSearch.md)
|
1427
|
+
|
1428
|
+
[//]: # (OPERATION:search_sic_indices_v2)
|
1429
|
+
|
1430
|
+
[//]: # (ENDPOINT:/indices/sic/search)
|
1431
|
+
|
1432
|
+
[//]: # (DOCUMENT_LINK:IndexApi.md#search_sic_indices)
|
1433
|
+
|
1434
|
+
## **search_sic_indices**
|
1435
|
+
|
1436
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/search_sic_indices_v2)
|
1437
|
+
|
1438
|
+
[//]: # (START_OVERVIEW)
|
1439
|
+
|
738
1440
|
> ApiResponseSICIndicesSearch search_sic_indices(query, opts)
|
739
1441
|
|
740
|
-
Search SIC Indices
|
1442
|
+
#### Search SIC Indices
|
1443
|
+
|
741
1444
|
|
742
1445
|
Searches for indices using the text in `query`
|
743
1446
|
|
1447
|
+
[//]: # (END_OVERVIEW)
|
1448
|
+
|
744
1449
|
### Example
|
1450
|
+
|
1451
|
+
[//]: # (START_CODE_EXAMPLE)
|
1452
|
+
|
745
1453
|
```ruby
|
746
1454
|
# Load the gem
|
747
1455
|
require 'intrinio-sdk'
|
748
1456
|
|
749
1457
|
# Setup authorization
|
750
1458
|
Intrinio.configure do |config|
|
751
|
-
config.api_key['api_key'] = '
|
1459
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
752
1460
|
end
|
753
1461
|
|
754
1462
|
index_api = Intrinio::IndexApi.new
|
@@ -767,32 +1475,74 @@ rescue Intrinio::ApiError => e
|
|
767
1475
|
end
|
768
1476
|
```
|
769
1477
|
|
1478
|
+
[//]: # (END_CODE_EXAMPLE)
|
1479
|
+
|
1480
|
+
[//]: # (START_DEFINITION)
|
1481
|
+
|
770
1482
|
### Parameters
|
771
1483
|
|
1484
|
+
[//]: # (START_PARAMETERS)
|
1485
|
+
|
1486
|
+
|
772
1487
|
Name | Type | Description | Notes
|
773
1488
|
------------- | ------------- | ------------- | -------------
|
774
|
-
**query** |
|
775
|
-
**page_size** |
|
1489
|
+
**query** | String| Search query |
|
1490
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
1491
|
+
<br/>
|
1492
|
+
|
1493
|
+
[//]: # (END_PARAMETERS)
|
776
1494
|
|
777
1495
|
### Return type
|
778
1496
|
|
779
1497
|
[**ApiResponseSICIndicesSearch**](ApiResponseSICIndicesSearch.md)
|
780
1498
|
|
781
|
-
#
|
1499
|
+
[//]: # (END_OPERATION)
|
1500
|
+
|
1501
|
+
|
1502
|
+
[//]: # (START_OPERATION)
|
1503
|
+
|
1504
|
+
[//]: # (CLASS:Intrinio::IndexApi)
|
1505
|
+
|
1506
|
+
[//]: # (METHOD:search_stock_markets_indices)
|
1507
|
+
|
1508
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseStockMarketIndicesSearch)
|
1509
|
+
|
1510
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
1511
|
+
|
1512
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseStockMarketIndicesSearch.md)
|
1513
|
+
|
1514
|
+
[//]: # (OPERATION:search_stock_markets_indices_v2)
|
1515
|
+
|
1516
|
+
[//]: # (ENDPOINT:/indices/stock_market/search)
|
1517
|
+
|
1518
|
+
[//]: # (DOCUMENT_LINK:IndexApi.md#search_stock_markets_indices)
|
1519
|
+
|
1520
|
+
## **search_stock_markets_indices**
|
1521
|
+
|
1522
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/search_stock_markets_indices_v2)
|
1523
|
+
|
1524
|
+
[//]: # (START_OVERVIEW)
|
1525
|
+
|
782
1526
|
> ApiResponseStockMarketIndicesSearch search_stock_markets_indices(query, opts)
|
783
1527
|
|
784
|
-
Search Stock Market Indices
|
1528
|
+
#### Search Stock Market Indices
|
1529
|
+
|
785
1530
|
|
786
1531
|
Searches for indices using the text in `query`
|
787
1532
|
|
1533
|
+
[//]: # (END_OVERVIEW)
|
1534
|
+
|
788
1535
|
### Example
|
1536
|
+
|
1537
|
+
[//]: # (START_CODE_EXAMPLE)
|
1538
|
+
|
789
1539
|
```ruby
|
790
1540
|
# Load the gem
|
791
1541
|
require 'intrinio-sdk'
|
792
1542
|
|
793
1543
|
# Setup authorization
|
794
1544
|
Intrinio.configure do |config|
|
795
|
-
config.api_key['api_key'] = '
|
1545
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
796
1546
|
end
|
797
1547
|
|
798
1548
|
index_api = Intrinio::IndexApi.new
|
@@ -811,14 +1561,26 @@ rescue Intrinio::ApiError => e
|
|
811
1561
|
end
|
812
1562
|
```
|
813
1563
|
|
1564
|
+
[//]: # (END_CODE_EXAMPLE)
|
1565
|
+
|
1566
|
+
[//]: # (START_DEFINITION)
|
1567
|
+
|
814
1568
|
### Parameters
|
815
1569
|
|
1570
|
+
[//]: # (START_PARAMETERS)
|
1571
|
+
|
1572
|
+
|
816
1573
|
Name | Type | Description | Notes
|
817
1574
|
------------- | ------------- | ------------- | -------------
|
818
|
-
**query** |
|
819
|
-
**page_size** |
|
1575
|
+
**query** | String| Search query |
|
1576
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
1577
|
+
<br/>
|
1578
|
+
|
1579
|
+
[//]: # (END_PARAMETERS)
|
820
1580
|
|
821
1581
|
### Return type
|
822
1582
|
|
823
1583
|
[**ApiResponseStockMarketIndicesSearch**](ApiResponseStockMarketIndicesSearch.md)
|
824
1584
|
|
1585
|
+
[//]: # (END_OPERATION)
|
1586
|
+
|