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/RealtimeStockPrice.md
CHANGED
|
@@ -1,21 +1,36 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
**
|
|
16
|
-
**
|
|
17
|
-
**
|
|
18
|
-
**
|
|
19
|
-
**
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
[//]: # (CLASS:Intrinio::RealtimeStockPrice)
|
|
4
|
+
|
|
5
|
+
[//]: # (KIND:object)
|
|
6
|
+
|
|
7
|
+
### Intrinio::RealtimeStockPrice
|
|
8
|
+
|
|
9
|
+
#### Properties
|
|
10
|
+
|
|
11
|
+
[//]: # (START_DEFINITION)
|
|
12
|
+
|
|
13
|
+
Name | Type | Description
|
|
14
|
+
------------ | ------------- | -------------
|
|
15
|
+
**last_price** | Float | The price of the last trade.
|
|
16
|
+
**last_time** | DateTime | The date and time when the last trade occurred.
|
|
17
|
+
**bid_price** | Float | The price of the top bid order.
|
|
18
|
+
**bid_size** | Float | The size of the top bid order.
|
|
19
|
+
**ask_price** | Float | The price of the top ask order.
|
|
20
|
+
**ask_size** | Float | The size of the top ask order.
|
|
21
|
+
**open_price** | Float | The price at the open of the trading day.
|
|
22
|
+
**high_price** | Float | The high price for the trading day.
|
|
23
|
+
**low_price** | Float | The low price for the trading day.
|
|
24
|
+
**exchange_volume** | Float | The number of shares exchanged during the trading day on the exchange.
|
|
25
|
+
**market_volume** | Float | The number of shares exchanged during the trading day for the whole market.
|
|
26
|
+
**updated_on** | DateTime | The date and time when the data was last updated.
|
|
27
|
+
**source** | String | The source of the data.
|
|
28
|
+
**security** | [**RealtimeStockPriceSecurity**](RealtimeStockPriceSecurity.md) |
|
|
29
|
+
|
|
30
|
+
[//]: # (END_DEFINITION)
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
[//]: # (CONTAINED_CLASS:Intrinio::RealtimeStockPriceSecurity)
|
|
34
|
+
|
|
20
35
|
|
|
21
36
|
|
|
@@ -1,12 +1,24 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
[//]: # (CLASS:Intrinio::RealtimeStockPriceSecurity)
|
|
4
|
+
|
|
5
|
+
[//]: # (KIND:object)
|
|
6
|
+
|
|
7
|
+
### Intrinio::RealtimeStockPriceSecurity
|
|
8
|
+
|
|
9
|
+
#### Properties
|
|
10
|
+
|
|
11
|
+
[//]: # (START_DEFINITION)
|
|
12
|
+
|
|
13
|
+
Name | Type | Description
|
|
14
|
+
------------ | ------------- | -------------
|
|
15
|
+
**id** | String | The Intrinio ID for Security
|
|
16
|
+
**ticker** | String | The common/local ticker of the Security
|
|
17
|
+
**exchange_ticker** | String | The exchange-level ticker
|
|
18
|
+
**figi** | String | The OpenFIGI identifier
|
|
19
|
+
**composite_figi** | String | The country-composite OpenFIGI identifier
|
|
20
|
+
|
|
21
|
+
[//]: # (END_DEFINITION)
|
|
22
|
+
|
|
11
23
|
|
|
12
24
|
|
|
@@ -1,9 +1,21 @@
|
|
|
1
|
-
# Intrinio::RelativeStrengthIndexTechnicalValue
|
|
2
1
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
2
|
+
|
|
3
|
+
[//]: # (CLASS:Intrinio::RelativeStrengthIndexTechnicalValue)
|
|
4
|
+
|
|
5
|
+
[//]: # (KIND:object)
|
|
6
|
+
|
|
7
|
+
### Intrinio::RelativeStrengthIndexTechnicalValue
|
|
8
|
+
|
|
9
|
+
#### Properties
|
|
10
|
+
|
|
11
|
+
[//]: # (START_DEFINITION)
|
|
12
|
+
|
|
13
|
+
Name | Type | Description
|
|
14
|
+
------------ | ------------- | -------------
|
|
15
|
+
**date_time** | DateTime | The date_time of the observation
|
|
16
|
+
**rsi** | Float | The Relative Strength Index calculation value
|
|
17
|
+
|
|
18
|
+
[//]: # (END_DEFINITION)
|
|
19
|
+
|
|
8
20
|
|
|
9
21
|
|
data/docs/ReportedFinancial.md
CHANGED
|
@@ -1,10 +1,28 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
[//]: # (CLASS:Intrinio::ReportedFinancial)
|
|
4
|
+
|
|
5
|
+
[//]: # (KIND:object)
|
|
6
|
+
|
|
7
|
+
### Intrinio::ReportedFinancial
|
|
8
|
+
|
|
9
|
+
#### Properties
|
|
10
|
+
|
|
11
|
+
[//]: # (START_DEFINITION)
|
|
12
|
+
|
|
13
|
+
Name | Type | Description
|
|
14
|
+
------------ | ------------- | -------------
|
|
15
|
+
**xbrl_tag** | [**ReportedTag**](ReportedTag.md) |
|
|
16
|
+
**value** | Float | The value reported for the XBRL Tag within the scope of the Fundamental
|
|
17
|
+
**dimensions** | [**Array<ReportedFinancialDimension>**](ReportedFinancialDimension.md) | The combination of XBRL axis and members that defines the dimensionalization of this fact (if any)
|
|
18
|
+
|
|
19
|
+
[//]: # (END_DEFINITION)
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
[//]: # (CONTAINED_CLASS:Intrinio::ReportedTag)
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
[//]: # (CONTAINED_CLASS:Intrinio::ReportedFinancialDimension)
|
|
26
|
+
|
|
9
27
|
|
|
10
28
|
|
|
@@ -1,9 +1,21 @@
|
|
|
1
|
-
# Intrinio::ReportedFinancialDimension
|
|
2
1
|
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
2
|
+
|
|
3
|
+
[//]: # (CLASS:Intrinio::ReportedFinancialDimension)
|
|
4
|
+
|
|
5
|
+
[//]: # (KIND:object)
|
|
6
|
+
|
|
7
|
+
### Intrinio::ReportedFinancialDimension
|
|
8
|
+
|
|
9
|
+
#### Properties
|
|
10
|
+
|
|
11
|
+
[//]: # (START_DEFINITION)
|
|
12
|
+
|
|
13
|
+
Name | Type | Description
|
|
14
|
+
------------ | ------------- | -------------
|
|
15
|
+
**axis** | String | The axis of the dimension
|
|
16
|
+
**member** | String | The member of the axis
|
|
17
|
+
|
|
18
|
+
[//]: # (END_DEFINITION)
|
|
19
|
+
|
|
8
20
|
|
|
9
21
|
|
data/docs/ReportedTag.md
CHANGED
|
@@ -1,14 +1,26 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
[//]: # (CLASS:Intrinio::ReportedTag)
|
|
4
|
+
|
|
5
|
+
[//]: # (KIND:object)
|
|
6
|
+
|
|
7
|
+
### Intrinio::ReportedTag
|
|
8
|
+
|
|
9
|
+
#### Properties
|
|
10
|
+
|
|
11
|
+
[//]: # (START_DEFINITION)
|
|
12
|
+
|
|
13
|
+
Name | Type | Description
|
|
14
|
+
------------ | ------------- | -------------
|
|
15
|
+
**tag** | String | The tag code
|
|
16
|
+
**name** | String | The tag name
|
|
17
|
+
**balance** | String | Whether the tag represents a credit or debit
|
|
18
|
+
**unit** | String | The unit of the tag
|
|
19
|
+
**abstract** | BOOLEAN | If true, the tag is an abstract and does not represent a nominal value
|
|
20
|
+
**sequence** | Integer | The vertical sequence of the tag when displayed in the financial statement
|
|
21
|
+
**depth** | Integer | The horizontal depth of the tag when displayed in the financial statement
|
|
22
|
+
|
|
23
|
+
[//]: # (END_DEFINITION)
|
|
24
|
+
|
|
13
25
|
|
|
14
26
|
|
data/docs/SICIndex.md
CHANGED
|
@@ -1,12 +1,24 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
[//]: # (CLASS:Intrinio::SICIndex)
|
|
4
|
+
|
|
5
|
+
[//]: # (KIND:object)
|
|
6
|
+
|
|
7
|
+
### Intrinio::SICIndex
|
|
8
|
+
|
|
9
|
+
#### Properties
|
|
10
|
+
|
|
11
|
+
[//]: # (START_DEFINITION)
|
|
12
|
+
|
|
13
|
+
Name | Type | Description
|
|
14
|
+
------------ | ------------- | -------------
|
|
15
|
+
**id** | String | Intrinio ID for the Index
|
|
16
|
+
**symbol** | String | The symbol used to identify the Index
|
|
17
|
+
**name** | String | The name of the Index
|
|
18
|
+
**continent** | String | The continent of the country of focus for the Index
|
|
19
|
+
**country** | String | The country of focus for the Index
|
|
20
|
+
|
|
21
|
+
[//]: # (END_DEFINITION)
|
|
22
|
+
|
|
11
23
|
|
|
12
24
|
|
data/docs/Security.md
CHANGED
|
@@ -1,35 +1,47 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
**
|
|
16
|
-
**
|
|
17
|
-
**
|
|
18
|
-
**
|
|
19
|
-
**
|
|
20
|
-
**
|
|
21
|
-
**
|
|
22
|
-
**
|
|
23
|
-
**
|
|
24
|
-
**
|
|
25
|
-
**
|
|
26
|
-
**
|
|
27
|
-
**
|
|
28
|
-
**
|
|
29
|
-
**
|
|
30
|
-
**
|
|
31
|
-
**
|
|
32
|
-
**
|
|
33
|
-
**
|
|
1
|
+
|
|
2
|
+
|
|
3
|
+
[//]: # (CLASS:Intrinio::Security)
|
|
4
|
+
|
|
5
|
+
[//]: # (KIND:object)
|
|
6
|
+
|
|
7
|
+
### Intrinio::Security
|
|
8
|
+
|
|
9
|
+
#### Properties
|
|
10
|
+
|
|
11
|
+
[//]: # (START_DEFINITION)
|
|
12
|
+
|
|
13
|
+
Name | Type | Description
|
|
14
|
+
------------ | ------------- | -------------
|
|
15
|
+
**id** | String | The Intrinio ID for the Security
|
|
16
|
+
**company_id** | String | The Intrinio ID for the company for which the Security is issued
|
|
17
|
+
**name** | String | The name of the Security
|
|
18
|
+
**type** | String | The Security's type
|
|
19
|
+
**code** | String | A 2-3 digit code classifying the Security (<a href=\"/documentation/security_codes\" target=\"_blank\">reference</a>)
|
|
20
|
+
**share_class** | String | The Security's share class (if applicable)
|
|
21
|
+
**currency** | String | The currency in which the Security is traded on the exchange
|
|
22
|
+
**round_lot_size** | Float | The normal unit of trading
|
|
23
|
+
**ticker** | String | The common ticker
|
|
24
|
+
**exchange_ticker** | String | The exchange-level ticker
|
|
25
|
+
**composite_ticker** | String | The country-composite ticker
|
|
26
|
+
**alternate_tickers** | Array<String> | Alternate formats of the common ticker
|
|
27
|
+
**figi** | String | The exchange-level OpenFIGI identifier
|
|
28
|
+
**cik** | String | Central Index Key issued by the SEC, which is the unique identifier for all owner filings
|
|
29
|
+
**composite_figi** | String | The country-composite OpenFIGI identifier
|
|
30
|
+
**share_class_figi** | String | The global-composite OpenFIGI identifier
|
|
31
|
+
**figi_uniqueid** | String | The OpenFIGI unique ID
|
|
32
|
+
**active** | BOOLEAN | If true, the Security is active and has been recently traded
|
|
33
|
+
**etf** | BOOLEAN | If true, this Security is an ETF
|
|
34
|
+
**delisted** | BOOLEAN | If true, the Security is no longer traded on the exchange
|
|
35
|
+
**primary_listing** | BOOLEAN | If true, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange
|
|
36
|
+
**primary_security** | BOOLEAN | If true, the Security is considered by Intrinio to be the primary Security for its company
|
|
37
|
+
**first_stock_price** | Date | The date of the first recorded stock price
|
|
38
|
+
**last_stock_price** | Date | The date of the last recorded stock price (or the most recent trading day)
|
|
39
|
+
**last_stock_price_adjustment** | Date | The date of the last stock price adjustment (dividend, split, etc)
|
|
40
|
+
**last_corporate_action** | Date | The date of the last corporate action
|
|
41
|
+
**previous_tickers** | Array<String> | Previous tickers used by this security
|
|
42
|
+
**listing_exchange_mic** | String | The MIC code of the exchange on which this security primarily trades
|
|
43
|
+
|
|
44
|
+
[//]: # (END_DEFINITION)
|
|
45
|
+
|
|
34
46
|
|
|
35
47
|
|
data/docs/SecurityApi.md
CHANGED
|
@@ -54,21 +54,51 @@ Method | HTTP request | Description
|
|
|
54
54
|
[**search_securities**](SecurityApi.md#search_securities) | **GET** /securities/search | Search Securities
|
|
55
55
|
|
|
56
56
|
|
|
57
|
-
|
|
57
|
+
|
|
58
|
+
[//]: # (START_OPERATION)
|
|
59
|
+
|
|
60
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
61
|
+
|
|
62
|
+
[//]: # (METHOD:get_all_securities)
|
|
63
|
+
|
|
64
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurities)
|
|
65
|
+
|
|
66
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
67
|
+
|
|
68
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurities.md)
|
|
69
|
+
|
|
70
|
+
[//]: # (OPERATION:get_all_securities_v2)
|
|
71
|
+
|
|
72
|
+
[//]: # (ENDPOINT:/securities)
|
|
73
|
+
|
|
74
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_all_securities)
|
|
75
|
+
|
|
76
|
+
## **get_all_securities**
|
|
77
|
+
|
|
78
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_all_securities_v2)
|
|
79
|
+
|
|
80
|
+
[//]: # (START_OVERVIEW)
|
|
81
|
+
|
|
58
82
|
> ApiResponseSecurities get_all_securities(opts)
|
|
59
83
|
|
|
60
|
-
All Securities
|
|
84
|
+
#### All Securities
|
|
85
|
+
|
|
61
86
|
|
|
62
87
|
Returns all Securities to which you have access.
|
|
63
88
|
|
|
89
|
+
[//]: # (END_OVERVIEW)
|
|
90
|
+
|
|
64
91
|
### Example
|
|
92
|
+
|
|
93
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
94
|
+
|
|
65
95
|
```ruby
|
|
66
96
|
# Load the gem
|
|
67
97
|
require 'intrinio-sdk'
|
|
68
98
|
|
|
69
99
|
# Setup authorization
|
|
70
100
|
Intrinio.configure do |config|
|
|
71
|
-
config.api_key['api_key'] = '
|
|
101
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
72
102
|
end
|
|
73
103
|
|
|
74
104
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -86,32 +116,74 @@ rescue Intrinio::ApiError => e
|
|
|
86
116
|
end
|
|
87
117
|
```
|
|
88
118
|
|
|
119
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
120
|
+
|
|
121
|
+
[//]: # (START_DEFINITION)
|
|
122
|
+
|
|
89
123
|
### Parameters
|
|
90
124
|
|
|
125
|
+
[//]: # (START_PARAMETERS)
|
|
126
|
+
|
|
127
|
+
|
|
91
128
|
Name | Type | Description | Notes
|
|
92
129
|
------------- | ------------- | ------------- | -------------
|
|
93
|
-
**page_size** |
|
|
94
|
-
**next_page** |
|
|
130
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
131
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
132
|
+
<br/>
|
|
133
|
+
|
|
134
|
+
[//]: # (END_PARAMETERS)
|
|
95
135
|
|
|
96
136
|
### Return type
|
|
97
137
|
|
|
98
138
|
[**ApiResponseSecurities**](ApiResponseSecurities.md)
|
|
99
139
|
|
|
100
|
-
#
|
|
140
|
+
[//]: # (END_OPERATION)
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
[//]: # (START_OPERATION)
|
|
144
|
+
|
|
145
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
146
|
+
|
|
147
|
+
[//]: # (METHOD:get_security_by_id)
|
|
148
|
+
|
|
149
|
+
[//]: # (RETURN_TYPE:Intrinio::Security)
|
|
150
|
+
|
|
151
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
152
|
+
|
|
153
|
+
[//]: # (RETURN_TYPE_DOC:Security.md)
|
|
154
|
+
|
|
155
|
+
[//]: # (OPERATION:get_security_by_id_v2)
|
|
156
|
+
|
|
157
|
+
[//]: # (ENDPOINT:/securities/{identifier})
|
|
158
|
+
|
|
159
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_by_id)
|
|
160
|
+
|
|
161
|
+
## **get_security_by_id**
|
|
162
|
+
|
|
163
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_by_id_v2)
|
|
164
|
+
|
|
165
|
+
[//]: # (START_OVERVIEW)
|
|
166
|
+
|
|
101
167
|
> Security get_security_by_id(identifier)
|
|
102
168
|
|
|
103
|
-
Lookup Security
|
|
169
|
+
#### Lookup Security
|
|
170
|
+
|
|
104
171
|
|
|
105
172
|
Returns the Security with the given `identifier`
|
|
106
173
|
|
|
174
|
+
[//]: # (END_OVERVIEW)
|
|
175
|
+
|
|
107
176
|
### Example
|
|
177
|
+
|
|
178
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
179
|
+
|
|
108
180
|
```ruby
|
|
109
181
|
# Load the gem
|
|
110
182
|
require 'intrinio-sdk'
|
|
111
183
|
|
|
112
184
|
# Setup authorization
|
|
113
185
|
Intrinio.configure do |config|
|
|
114
|
-
config.api_key['api_key'] = '
|
|
186
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
115
187
|
end
|
|
116
188
|
|
|
117
189
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -127,31 +199,73 @@ rescue Intrinio::ApiError => e
|
|
|
127
199
|
end
|
|
128
200
|
```
|
|
129
201
|
|
|
202
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
203
|
+
|
|
204
|
+
[//]: # (START_DEFINITION)
|
|
205
|
+
|
|
130
206
|
### Parameters
|
|
131
207
|
|
|
208
|
+
[//]: # (START_PARAMETERS)
|
|
209
|
+
|
|
210
|
+
|
|
132
211
|
Name | Type | Description | Notes
|
|
133
212
|
------------- | ------------- | ------------- | -------------
|
|
134
|
-
**identifier** |
|
|
213
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
214
|
+
<br/>
|
|
215
|
+
|
|
216
|
+
[//]: # (END_PARAMETERS)
|
|
135
217
|
|
|
136
218
|
### Return type
|
|
137
219
|
|
|
138
220
|
[**Security**](Security.md)
|
|
139
221
|
|
|
140
|
-
#
|
|
222
|
+
[//]: # (END_OPERATION)
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
[//]: # (START_OPERATION)
|
|
226
|
+
|
|
227
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
228
|
+
|
|
229
|
+
[//]: # (METHOD:get_security_data_point_number)
|
|
230
|
+
|
|
231
|
+
[//]: # (RETURN_TYPE:Float)
|
|
232
|
+
|
|
233
|
+
[//]: # (RETURN_TYPE_KIND:primitive)
|
|
234
|
+
|
|
235
|
+
[//]: # (RETURN_TYPE_DOC:)
|
|
236
|
+
|
|
237
|
+
[//]: # (OPERATION:get_security_data_point_number_v2)
|
|
238
|
+
|
|
239
|
+
[//]: # (ENDPOINT:/securities/{identifier}/data_point/{tag}/number)
|
|
240
|
+
|
|
241
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_data_point_number)
|
|
242
|
+
|
|
243
|
+
## **get_security_data_point_number**
|
|
244
|
+
|
|
245
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_data_point_number_v2)
|
|
246
|
+
|
|
247
|
+
[//]: # (START_OVERVIEW)
|
|
248
|
+
|
|
141
249
|
> Float get_security_data_point_number(identifier, tag)
|
|
142
250
|
|
|
143
|
-
Data Point (Number) for Security
|
|
251
|
+
#### Data Point (Number) for Security
|
|
252
|
+
|
|
144
253
|
|
|
145
254
|
Returns a numeric value for the given `tag` for the Security with the given `identifier`
|
|
146
255
|
|
|
256
|
+
[//]: # (END_OVERVIEW)
|
|
257
|
+
|
|
147
258
|
### Example
|
|
259
|
+
|
|
260
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
261
|
+
|
|
148
262
|
```ruby
|
|
149
263
|
# Load the gem
|
|
150
264
|
require 'intrinio-sdk'
|
|
151
265
|
|
|
152
266
|
# Setup authorization
|
|
153
267
|
Intrinio.configure do |config|
|
|
154
|
-
config.api_key['api_key'] = '
|
|
268
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
155
269
|
end
|
|
156
270
|
|
|
157
271
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -169,32 +283,74 @@ rescue Intrinio::ApiError => e
|
|
|
169
283
|
end
|
|
170
284
|
```
|
|
171
285
|
|
|
286
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
287
|
+
|
|
288
|
+
[//]: # (START_DEFINITION)
|
|
289
|
+
|
|
172
290
|
### Parameters
|
|
173
291
|
|
|
292
|
+
[//]: # (START_PARAMETERS)
|
|
293
|
+
|
|
294
|
+
|
|
174
295
|
Name | Type | Description | Notes
|
|
175
296
|
------------- | ------------- | ------------- | -------------
|
|
176
|
-
**identifier** |
|
|
177
|
-
**tag** |
|
|
297
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
298
|
+
**tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |
|
|
299
|
+
<br/>
|
|
300
|
+
|
|
301
|
+
[//]: # (END_PARAMETERS)
|
|
178
302
|
|
|
179
303
|
### Return type
|
|
180
304
|
|
|
181
305
|
**Float**
|
|
182
306
|
|
|
183
|
-
#
|
|
307
|
+
[//]: # (END_OPERATION)
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
[//]: # (START_OPERATION)
|
|
311
|
+
|
|
312
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
313
|
+
|
|
314
|
+
[//]: # (METHOD:get_security_data_point_text)
|
|
315
|
+
|
|
316
|
+
[//]: # (RETURN_TYPE:String)
|
|
317
|
+
|
|
318
|
+
[//]: # (RETURN_TYPE_KIND:primitive)
|
|
319
|
+
|
|
320
|
+
[//]: # (RETURN_TYPE_DOC:)
|
|
321
|
+
|
|
322
|
+
[//]: # (OPERATION:get_security_data_point_text_v2)
|
|
323
|
+
|
|
324
|
+
[//]: # (ENDPOINT:/securities/{identifier}/data_point/{tag}/text)
|
|
325
|
+
|
|
326
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_data_point_text)
|
|
327
|
+
|
|
328
|
+
## **get_security_data_point_text**
|
|
329
|
+
|
|
330
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_data_point_text_v2)
|
|
331
|
+
|
|
332
|
+
[//]: # (START_OVERVIEW)
|
|
333
|
+
|
|
184
334
|
> String get_security_data_point_text(identifier, tag)
|
|
185
335
|
|
|
186
|
-
Data Point (Text) for Security
|
|
336
|
+
#### Data Point (Text) for Security
|
|
337
|
+
|
|
187
338
|
|
|
188
339
|
Returns a text value for the given `tag` for the Security with the given `identifier`
|
|
189
340
|
|
|
341
|
+
[//]: # (END_OVERVIEW)
|
|
342
|
+
|
|
190
343
|
### Example
|
|
344
|
+
|
|
345
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
346
|
+
|
|
191
347
|
```ruby
|
|
192
348
|
# Load the gem
|
|
193
349
|
require 'intrinio-sdk'
|
|
194
350
|
|
|
195
351
|
# Setup authorization
|
|
196
352
|
Intrinio.configure do |config|
|
|
197
|
-
config.api_key['api_key'] = '
|
|
353
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
198
354
|
end
|
|
199
355
|
|
|
200
356
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -212,32 +368,74 @@ rescue Intrinio::ApiError => e
|
|
|
212
368
|
end
|
|
213
369
|
```
|
|
214
370
|
|
|
371
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
372
|
+
|
|
373
|
+
[//]: # (START_DEFINITION)
|
|
374
|
+
|
|
215
375
|
### Parameters
|
|
216
376
|
|
|
377
|
+
[//]: # (START_PARAMETERS)
|
|
378
|
+
|
|
379
|
+
|
|
217
380
|
Name | Type | Description | Notes
|
|
218
381
|
------------- | ------------- | ------------- | -------------
|
|
219
|
-
**identifier** |
|
|
220
|
-
**tag** |
|
|
382
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
383
|
+
**tag** | String| An Intrinio data tag ID or code-name |
|
|
384
|
+
<br/>
|
|
385
|
+
|
|
386
|
+
[//]: # (END_PARAMETERS)
|
|
221
387
|
|
|
222
388
|
### Return type
|
|
223
389
|
|
|
224
390
|
**String**
|
|
225
391
|
|
|
226
|
-
#
|
|
392
|
+
[//]: # (END_OPERATION)
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
[//]: # (START_OPERATION)
|
|
396
|
+
|
|
397
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
398
|
+
|
|
399
|
+
[//]: # (METHOD:get_security_historical_data)
|
|
400
|
+
|
|
401
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityHistoricalData)
|
|
402
|
+
|
|
403
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
404
|
+
|
|
405
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityHistoricalData.md)
|
|
406
|
+
|
|
407
|
+
[//]: # (OPERATION:get_security_historical_data_v2)
|
|
408
|
+
|
|
409
|
+
[//]: # (ENDPOINT:/securities/{identifier}/historical_data/{tag})
|
|
410
|
+
|
|
411
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_historical_data)
|
|
412
|
+
|
|
413
|
+
## **get_security_historical_data**
|
|
414
|
+
|
|
415
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_historical_data_v2)
|
|
416
|
+
|
|
417
|
+
[//]: # (START_OVERVIEW)
|
|
418
|
+
|
|
227
419
|
> ApiResponseSecurityHistoricalData get_security_historical_data(identifier, tag, opts)
|
|
228
420
|
|
|
229
|
-
Historical Data for Security
|
|
421
|
+
#### Historical Data for Security
|
|
422
|
+
|
|
230
423
|
|
|
231
424
|
Returns historical values for the given `tag` and the Security with the given `identifier`
|
|
232
425
|
|
|
426
|
+
[//]: # (END_OVERVIEW)
|
|
427
|
+
|
|
233
428
|
### Example
|
|
429
|
+
|
|
430
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
431
|
+
|
|
234
432
|
```ruby
|
|
235
433
|
# Load the gem
|
|
236
434
|
require 'intrinio-sdk'
|
|
237
435
|
|
|
238
436
|
# Setup authorization
|
|
239
437
|
Intrinio.configure do |config|
|
|
240
|
-
config.api_key['api_key'] = '
|
|
438
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
241
439
|
end
|
|
242
440
|
|
|
243
441
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -264,39 +462,81 @@ rescue Intrinio::ApiError => e
|
|
|
264
462
|
end
|
|
265
463
|
```
|
|
266
464
|
|
|
465
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
466
|
+
|
|
467
|
+
[//]: # (START_DEFINITION)
|
|
468
|
+
|
|
267
469
|
### Parameters
|
|
268
470
|
|
|
471
|
+
[//]: # (START_PARAMETERS)
|
|
472
|
+
|
|
473
|
+
|
|
269
474
|
Name | Type | Description | Notes
|
|
270
475
|
------------- | ------------- | ------------- | -------------
|
|
271
|
-
**identifier** |
|
|
272
|
-
**tag** |
|
|
273
|
-
**frequency** |
|
|
274
|
-
**type** |
|
|
275
|
-
**start_date** |
|
|
276
|
-
**end_date** |
|
|
277
|
-
**sort_order** |
|
|
278
|
-
**page_size** |
|
|
279
|
-
**next_page** |
|
|
476
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
477
|
+
**tag** | String| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |
|
|
478
|
+
**frequency** | String| Return historical data in the given frequency | [optional] [default to daily]
|
|
479
|
+
**type** | String| Filter by type, when applicable | [optional]
|
|
480
|
+
**start_date** | Date| Get historical data on or after this date | [optional]
|
|
481
|
+
**end_date** | Date| Get historical date on or before this date | [optional]
|
|
482
|
+
**sort_order** | String| Sort by date `asc` or `desc` | [optional] [default to desc]
|
|
483
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
484
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
485
|
+
<br/>
|
|
486
|
+
|
|
487
|
+
[//]: # (END_PARAMETERS)
|
|
280
488
|
|
|
281
489
|
### Return type
|
|
282
490
|
|
|
283
491
|
[**ApiResponseSecurityHistoricalData**](ApiResponseSecurityHistoricalData.md)
|
|
284
492
|
|
|
285
|
-
#
|
|
493
|
+
[//]: # (END_OPERATION)
|
|
494
|
+
|
|
495
|
+
|
|
496
|
+
[//]: # (START_OPERATION)
|
|
497
|
+
|
|
498
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
499
|
+
|
|
500
|
+
[//]: # (METHOD:get_security_intraday_prices)
|
|
501
|
+
|
|
502
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityIntradayPrices)
|
|
503
|
+
|
|
504
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
505
|
+
|
|
506
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityIntradayPrices.md)
|
|
507
|
+
|
|
508
|
+
[//]: # (OPERATION:get_security_intraday_prices_v2)
|
|
509
|
+
|
|
510
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/intraday)
|
|
511
|
+
|
|
512
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_intraday_prices)
|
|
513
|
+
|
|
514
|
+
## **get_security_intraday_prices**
|
|
515
|
+
|
|
516
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_intraday_prices_v2)
|
|
517
|
+
|
|
518
|
+
[//]: # (START_OVERVIEW)
|
|
519
|
+
|
|
286
520
|
> ApiResponseSecurityIntradayPrices get_security_intraday_prices(identifier, opts)
|
|
287
521
|
|
|
288
|
-
Intraday Stock Prices for Security
|
|
522
|
+
#### Intraday Stock Prices for Security
|
|
523
|
+
|
|
289
524
|
|
|
290
525
|
Return intraday stock prices for the Security with the given `identifier`
|
|
291
526
|
|
|
527
|
+
[//]: # (END_OVERVIEW)
|
|
528
|
+
|
|
292
529
|
### Example
|
|
530
|
+
|
|
531
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
532
|
+
|
|
293
533
|
```ruby
|
|
294
534
|
# Load the gem
|
|
295
535
|
require 'intrinio-sdk'
|
|
296
536
|
|
|
297
537
|
# Setup authorization
|
|
298
538
|
Intrinio.configure do |config|
|
|
299
|
-
config.api_key['api_key'] = '
|
|
539
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
300
540
|
end
|
|
301
541
|
|
|
302
542
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -319,36 +559,78 @@ rescue Intrinio::ApiError => e
|
|
|
319
559
|
end
|
|
320
560
|
```
|
|
321
561
|
|
|
562
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
563
|
+
|
|
564
|
+
[//]: # (START_DEFINITION)
|
|
565
|
+
|
|
322
566
|
### Parameters
|
|
323
567
|
|
|
568
|
+
[//]: # (START_PARAMETERS)
|
|
569
|
+
|
|
570
|
+
|
|
324
571
|
Name | Type | Description | Notes
|
|
325
572
|
------------- | ------------- | ------------- | -------------
|
|
326
|
-
**identifier** |
|
|
327
|
-
**source** |
|
|
328
|
-
**start_date** |
|
|
329
|
-
**start_time** |
|
|
330
|
-
**end_date** |
|
|
331
|
-
**end_time** |
|
|
573
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
574
|
+
**source** | String| Return intraday prices from the specified data source | [optional]
|
|
575
|
+
**start_date** | Date| Return intraday prices starting at the specified date | [optional]
|
|
576
|
+
**start_time** | String| Return intraday prices starting at the specified time on the `start_date` (timezone is UTC) | [optional]
|
|
577
|
+
**end_date** | Date| Return intraday prices stopping at the specified date | [optional]
|
|
578
|
+
**end_time** | String| Return intraday prices stopping at the specified time on the `end_date` (timezone is UTC) | [optional]
|
|
579
|
+
<br/>
|
|
580
|
+
|
|
581
|
+
[//]: # (END_PARAMETERS)
|
|
332
582
|
|
|
333
583
|
### Return type
|
|
334
584
|
|
|
335
585
|
[**ApiResponseSecurityIntradayPrices**](ApiResponseSecurityIntradayPrices.md)
|
|
336
586
|
|
|
337
|
-
#
|
|
587
|
+
[//]: # (END_OPERATION)
|
|
588
|
+
|
|
589
|
+
|
|
590
|
+
[//]: # (START_OPERATION)
|
|
591
|
+
|
|
592
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
593
|
+
|
|
594
|
+
[//]: # (METHOD:get_security_latest_dividend_record)
|
|
595
|
+
|
|
596
|
+
[//]: # (RETURN_TYPE:Intrinio::DividendRecord)
|
|
597
|
+
|
|
598
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
599
|
+
|
|
600
|
+
[//]: # (RETURN_TYPE_DOC:DividendRecord.md)
|
|
601
|
+
|
|
602
|
+
[//]: # (OPERATION:get_security_latest_dividend_record_v2)
|
|
603
|
+
|
|
604
|
+
[//]: # (ENDPOINT:/securities/{identifier}/dividends/latest)
|
|
605
|
+
|
|
606
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_latest_dividend_record)
|
|
607
|
+
|
|
608
|
+
## **get_security_latest_dividend_record**
|
|
609
|
+
|
|
610
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_latest_dividend_record_v2)
|
|
611
|
+
|
|
612
|
+
[//]: # (START_OVERVIEW)
|
|
613
|
+
|
|
338
614
|
> DividendRecord get_security_latest_dividend_record(identifier)
|
|
339
615
|
|
|
340
|
-
Lastest Dividend Record for Security
|
|
616
|
+
#### Lastest Dividend Record for Security
|
|
617
|
+
|
|
341
618
|
|
|
342
619
|
Returns the latest available dividend information for the Security with the given `identifier`
|
|
343
620
|
|
|
621
|
+
[//]: # (END_OVERVIEW)
|
|
622
|
+
|
|
344
623
|
### Example
|
|
624
|
+
|
|
625
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
626
|
+
|
|
345
627
|
```ruby
|
|
346
628
|
# Load the gem
|
|
347
629
|
require 'intrinio-sdk'
|
|
348
630
|
|
|
349
631
|
# Setup authorization
|
|
350
632
|
Intrinio.configure do |config|
|
|
351
|
-
config.api_key['api_key'] = '
|
|
633
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
352
634
|
end
|
|
353
635
|
|
|
354
636
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -364,31 +646,73 @@ rescue Intrinio::ApiError => e
|
|
|
364
646
|
end
|
|
365
647
|
```
|
|
366
648
|
|
|
649
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
650
|
+
|
|
651
|
+
[//]: # (START_DEFINITION)
|
|
652
|
+
|
|
367
653
|
### Parameters
|
|
368
654
|
|
|
655
|
+
[//]: # (START_PARAMETERS)
|
|
656
|
+
|
|
657
|
+
|
|
369
658
|
Name | Type | Description | Notes
|
|
370
659
|
------------- | ------------- | ------------- | -------------
|
|
371
|
-
**identifier** |
|
|
660
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
661
|
+
<br/>
|
|
662
|
+
|
|
663
|
+
[//]: # (END_PARAMETERS)
|
|
372
664
|
|
|
373
665
|
### Return type
|
|
374
666
|
|
|
375
667
|
[**DividendRecord**](DividendRecord.md)
|
|
376
668
|
|
|
377
|
-
#
|
|
669
|
+
[//]: # (END_OPERATION)
|
|
670
|
+
|
|
671
|
+
|
|
672
|
+
[//]: # (START_OPERATION)
|
|
673
|
+
|
|
674
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
675
|
+
|
|
676
|
+
[//]: # (METHOD:get_security_latest_earnings_record)
|
|
677
|
+
|
|
678
|
+
[//]: # (RETURN_TYPE:Intrinio::EarningsRecord)
|
|
679
|
+
|
|
680
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
681
|
+
|
|
682
|
+
[//]: # (RETURN_TYPE_DOC:EarningsRecord.md)
|
|
683
|
+
|
|
684
|
+
[//]: # (OPERATION:get_security_latest_earnings_record_v2)
|
|
685
|
+
|
|
686
|
+
[//]: # (ENDPOINT:/securities/{identifier}/earnings/latest)
|
|
687
|
+
|
|
688
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_latest_earnings_record)
|
|
689
|
+
|
|
690
|
+
## **get_security_latest_earnings_record**
|
|
691
|
+
|
|
692
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_latest_earnings_record_v2)
|
|
693
|
+
|
|
694
|
+
[//]: # (START_OVERVIEW)
|
|
695
|
+
|
|
378
696
|
> EarningsRecord get_security_latest_earnings_record(identifier)
|
|
379
697
|
|
|
380
|
-
Lastest Earnings Record for Security
|
|
698
|
+
#### Lastest Earnings Record for Security
|
|
699
|
+
|
|
381
700
|
|
|
382
701
|
Returns latest available earnings information for the Security with the given `identifier`
|
|
383
702
|
|
|
703
|
+
[//]: # (END_OVERVIEW)
|
|
704
|
+
|
|
384
705
|
### Example
|
|
706
|
+
|
|
707
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
708
|
+
|
|
385
709
|
```ruby
|
|
386
710
|
# Load the gem
|
|
387
711
|
require 'intrinio-sdk'
|
|
388
712
|
|
|
389
713
|
# Setup authorization
|
|
390
714
|
Intrinio.configure do |config|
|
|
391
|
-
config.api_key['api_key'] = '
|
|
715
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
392
716
|
end
|
|
393
717
|
|
|
394
718
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -404,31 +728,73 @@ rescue Intrinio::ApiError => e
|
|
|
404
728
|
end
|
|
405
729
|
```
|
|
406
730
|
|
|
731
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
732
|
+
|
|
733
|
+
[//]: # (START_DEFINITION)
|
|
734
|
+
|
|
407
735
|
### Parameters
|
|
408
736
|
|
|
737
|
+
[//]: # (START_PARAMETERS)
|
|
738
|
+
|
|
739
|
+
|
|
409
740
|
Name | Type | Description | Notes
|
|
410
741
|
------------- | ------------- | ------------- | -------------
|
|
411
|
-
**identifier** |
|
|
742
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
743
|
+
<br/>
|
|
744
|
+
|
|
745
|
+
[//]: # (END_PARAMETERS)
|
|
412
746
|
|
|
413
747
|
### Return type
|
|
414
748
|
|
|
415
749
|
[**EarningsRecord**](EarningsRecord.md)
|
|
416
750
|
|
|
417
|
-
#
|
|
751
|
+
[//]: # (END_OPERATION)
|
|
752
|
+
|
|
753
|
+
|
|
754
|
+
[//]: # (START_OPERATION)
|
|
755
|
+
|
|
756
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
757
|
+
|
|
758
|
+
[//]: # (METHOD:get_security_price_technicals_adi)
|
|
759
|
+
|
|
760
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityAccumulationDistributionIndex)
|
|
761
|
+
|
|
762
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
763
|
+
|
|
764
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityAccumulationDistributionIndex.md)
|
|
765
|
+
|
|
766
|
+
[//]: # (OPERATION:get_security_price_technicals_adi_v2)
|
|
767
|
+
|
|
768
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/adi)
|
|
769
|
+
|
|
770
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_adi)
|
|
771
|
+
|
|
772
|
+
## **get_security_price_technicals_adi**
|
|
773
|
+
|
|
774
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_adi_v2)
|
|
775
|
+
|
|
776
|
+
[//]: # (START_OVERVIEW)
|
|
777
|
+
|
|
418
778
|
> ApiResponseSecurityAccumulationDistributionIndex get_security_price_technicals_adi(identifier, opts)
|
|
419
779
|
|
|
420
|
-
Accumulation/Distribution Index
|
|
780
|
+
#### Accumulation/Distribution Index
|
|
781
|
+
|
|
421
782
|
|
|
422
783
|
Returns the Accumulation/Distribution Index values of Stock Prices for the Security with the given `identifier`
|
|
423
784
|
|
|
785
|
+
[//]: # (END_OVERVIEW)
|
|
786
|
+
|
|
424
787
|
### Example
|
|
788
|
+
|
|
789
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
790
|
+
|
|
425
791
|
```ruby
|
|
426
792
|
# Load the gem
|
|
427
793
|
require 'intrinio-sdk'
|
|
428
794
|
|
|
429
795
|
# Setup authorization
|
|
430
796
|
Intrinio.configure do |config|
|
|
431
|
-
config.api_key['api_key'] = '
|
|
797
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
432
798
|
end
|
|
433
799
|
|
|
434
800
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -450,35 +816,77 @@ rescue Intrinio::ApiError => e
|
|
|
450
816
|
end
|
|
451
817
|
```
|
|
452
818
|
|
|
819
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
820
|
+
|
|
821
|
+
[//]: # (START_DEFINITION)
|
|
822
|
+
|
|
453
823
|
### Parameters
|
|
454
824
|
|
|
825
|
+
[//]: # (START_PARAMETERS)
|
|
826
|
+
|
|
827
|
+
|
|
455
828
|
Name | Type | Description | Notes
|
|
456
829
|
------------- | ------------- | ------------- | -------------
|
|
457
|
-
**identifier** |
|
|
458
|
-
**start_date** |
|
|
459
|
-
**end_date** |
|
|
460
|
-
**page_size** |
|
|
461
|
-
**next_page** |
|
|
830
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
831
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
832
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
833
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
834
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
835
|
+
<br/>
|
|
836
|
+
|
|
837
|
+
[//]: # (END_PARAMETERS)
|
|
462
838
|
|
|
463
839
|
### Return type
|
|
464
840
|
|
|
465
841
|
[**ApiResponseSecurityAccumulationDistributionIndex**](ApiResponseSecurityAccumulationDistributionIndex.md)
|
|
466
842
|
|
|
467
|
-
#
|
|
843
|
+
[//]: # (END_OPERATION)
|
|
844
|
+
|
|
845
|
+
|
|
846
|
+
[//]: # (START_OPERATION)
|
|
847
|
+
|
|
848
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
849
|
+
|
|
850
|
+
[//]: # (METHOD:get_security_price_technicals_adtv)
|
|
851
|
+
|
|
852
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityAverageDailyTradingVolume)
|
|
853
|
+
|
|
854
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
855
|
+
|
|
856
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityAverageDailyTradingVolume.md)
|
|
857
|
+
|
|
858
|
+
[//]: # (OPERATION:get_security_price_technicals_adtv_v2)
|
|
859
|
+
|
|
860
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/adtv)
|
|
861
|
+
|
|
862
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_adtv)
|
|
863
|
+
|
|
864
|
+
## **get_security_price_technicals_adtv**
|
|
865
|
+
|
|
866
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_adtv_v2)
|
|
867
|
+
|
|
868
|
+
[//]: # (START_OVERVIEW)
|
|
869
|
+
|
|
468
870
|
> ApiResponseSecurityAverageDailyTradingVolume get_security_price_technicals_adtv(identifier, opts)
|
|
469
871
|
|
|
470
|
-
Average Daily Trading Volume
|
|
872
|
+
#### Average Daily Trading Volume
|
|
873
|
+
|
|
471
874
|
|
|
472
875
|
Returns the Average Daily Trading Volume values of Stock Prices for the Security with the given `identifier`
|
|
473
876
|
|
|
877
|
+
[//]: # (END_OVERVIEW)
|
|
878
|
+
|
|
474
879
|
### Example
|
|
880
|
+
|
|
881
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
882
|
+
|
|
475
883
|
```ruby
|
|
476
884
|
# Load the gem
|
|
477
885
|
require 'intrinio-sdk'
|
|
478
886
|
|
|
479
887
|
# Setup authorization
|
|
480
888
|
Intrinio.configure do |config|
|
|
481
|
-
config.api_key['api_key'] = '
|
|
889
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
482
890
|
end
|
|
483
891
|
|
|
484
892
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -501,36 +909,78 @@ rescue Intrinio::ApiError => e
|
|
|
501
909
|
end
|
|
502
910
|
```
|
|
503
911
|
|
|
912
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
913
|
+
|
|
914
|
+
[//]: # (START_DEFINITION)
|
|
915
|
+
|
|
504
916
|
### Parameters
|
|
505
917
|
|
|
918
|
+
[//]: # (START_PARAMETERS)
|
|
919
|
+
|
|
920
|
+
|
|
506
921
|
Name | Type | Description | Notes
|
|
507
922
|
------------- | ------------- | ------------- | -------------
|
|
508
|
-
**identifier** |
|
|
509
|
-
**period** |
|
|
510
|
-
**start_date** |
|
|
511
|
-
**end_date** |
|
|
512
|
-
**page_size** |
|
|
513
|
-
**next_page** |
|
|
923
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
924
|
+
**period** | Integer| The number of observations, per period, to calculate Average Daily Trading Volume | [optional] [default to 22]
|
|
925
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
926
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
927
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
928
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
929
|
+
<br/>
|
|
930
|
+
|
|
931
|
+
[//]: # (END_PARAMETERS)
|
|
514
932
|
|
|
515
933
|
### Return type
|
|
516
934
|
|
|
517
935
|
[**ApiResponseSecurityAverageDailyTradingVolume**](ApiResponseSecurityAverageDailyTradingVolume.md)
|
|
518
936
|
|
|
519
|
-
#
|
|
937
|
+
[//]: # (END_OPERATION)
|
|
938
|
+
|
|
939
|
+
|
|
940
|
+
[//]: # (START_OPERATION)
|
|
941
|
+
|
|
942
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
943
|
+
|
|
944
|
+
[//]: # (METHOD:get_security_price_technicals_adx)
|
|
945
|
+
|
|
946
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityAverageDirectionalIndex)
|
|
947
|
+
|
|
948
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
949
|
+
|
|
950
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityAverageDirectionalIndex.md)
|
|
951
|
+
|
|
952
|
+
[//]: # (OPERATION:get_security_price_technicals_adx_v2)
|
|
953
|
+
|
|
954
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/adx)
|
|
955
|
+
|
|
956
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_adx)
|
|
957
|
+
|
|
958
|
+
## **get_security_price_technicals_adx**
|
|
959
|
+
|
|
960
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_adx_v2)
|
|
961
|
+
|
|
962
|
+
[//]: # (START_OVERVIEW)
|
|
963
|
+
|
|
520
964
|
> ApiResponseSecurityAverageDirectionalIndex get_security_price_technicals_adx(identifier, opts)
|
|
521
965
|
|
|
522
|
-
Average Directional Index
|
|
966
|
+
#### Average Directional Index
|
|
967
|
+
|
|
523
968
|
|
|
524
969
|
Returns the Average Directional Index values of Stock Prices for the Security with the given `identifier`
|
|
525
970
|
|
|
971
|
+
[//]: # (END_OVERVIEW)
|
|
972
|
+
|
|
526
973
|
### Example
|
|
974
|
+
|
|
975
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
976
|
+
|
|
527
977
|
```ruby
|
|
528
978
|
# Load the gem
|
|
529
979
|
require 'intrinio-sdk'
|
|
530
980
|
|
|
531
981
|
# Setup authorization
|
|
532
982
|
Intrinio.configure do |config|
|
|
533
|
-
config.api_key['api_key'] = '
|
|
983
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
534
984
|
end
|
|
535
985
|
|
|
536
986
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -553,36 +1003,78 @@ rescue Intrinio::ApiError => e
|
|
|
553
1003
|
end
|
|
554
1004
|
```
|
|
555
1005
|
|
|
1006
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
1007
|
+
|
|
1008
|
+
[//]: # (START_DEFINITION)
|
|
1009
|
+
|
|
556
1010
|
### Parameters
|
|
557
1011
|
|
|
1012
|
+
[//]: # (START_PARAMETERS)
|
|
1013
|
+
|
|
1014
|
+
|
|
558
1015
|
Name | Type | Description | Notes
|
|
559
1016
|
------------- | ------------- | ------------- | -------------
|
|
560
|
-
**identifier** |
|
|
561
|
-
**period** |
|
|
562
|
-
**start_date** |
|
|
563
|
-
**end_date** |
|
|
564
|
-
**page_size** |
|
|
565
|
-
**next_page** |
|
|
1017
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
1018
|
+
**period** | Integer| The number of observations, per period, to calculate Average Directional Index | [optional] [default to 14]
|
|
1019
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
1020
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
1021
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
1022
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
1023
|
+
<br/>
|
|
1024
|
+
|
|
1025
|
+
[//]: # (END_PARAMETERS)
|
|
566
1026
|
|
|
567
1027
|
### Return type
|
|
568
1028
|
|
|
569
1029
|
[**ApiResponseSecurityAverageDirectionalIndex**](ApiResponseSecurityAverageDirectionalIndex.md)
|
|
570
1030
|
|
|
571
|
-
#
|
|
1031
|
+
[//]: # (END_OPERATION)
|
|
1032
|
+
|
|
1033
|
+
|
|
1034
|
+
[//]: # (START_OPERATION)
|
|
1035
|
+
|
|
1036
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
1037
|
+
|
|
1038
|
+
[//]: # (METHOD:get_security_price_technicals_ao)
|
|
1039
|
+
|
|
1040
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityAwesomeOscillator)
|
|
1041
|
+
|
|
1042
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
1043
|
+
|
|
1044
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityAwesomeOscillator.md)
|
|
1045
|
+
|
|
1046
|
+
[//]: # (OPERATION:get_security_price_technicals_ao_v2)
|
|
1047
|
+
|
|
1048
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/ao)
|
|
1049
|
+
|
|
1050
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_ao)
|
|
1051
|
+
|
|
1052
|
+
## **get_security_price_technicals_ao**
|
|
1053
|
+
|
|
1054
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_ao_v2)
|
|
1055
|
+
|
|
1056
|
+
[//]: # (START_OVERVIEW)
|
|
1057
|
+
|
|
572
1058
|
> ApiResponseSecurityAwesomeOscillator get_security_price_technicals_ao(identifier, opts)
|
|
573
1059
|
|
|
574
|
-
Awesome Oscillator
|
|
1060
|
+
#### Awesome Oscillator
|
|
1061
|
+
|
|
575
1062
|
|
|
576
1063
|
Returns the Awesome Oscillator values of Stock Prices for the Security with the given `identifier`
|
|
577
1064
|
|
|
1065
|
+
[//]: # (END_OVERVIEW)
|
|
1066
|
+
|
|
578
1067
|
### Example
|
|
1068
|
+
|
|
1069
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
1070
|
+
|
|
579
1071
|
```ruby
|
|
580
1072
|
# Load the gem
|
|
581
1073
|
require 'intrinio-sdk'
|
|
582
1074
|
|
|
583
1075
|
# Setup authorization
|
|
584
1076
|
Intrinio.configure do |config|
|
|
585
|
-
config.api_key['api_key'] = '
|
|
1077
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
586
1078
|
end
|
|
587
1079
|
|
|
588
1080
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -606,37 +1098,79 @@ rescue Intrinio::ApiError => e
|
|
|
606
1098
|
end
|
|
607
1099
|
```
|
|
608
1100
|
|
|
1101
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
1102
|
+
|
|
1103
|
+
[//]: # (START_DEFINITION)
|
|
1104
|
+
|
|
609
1105
|
### Parameters
|
|
610
1106
|
|
|
1107
|
+
[//]: # (START_PARAMETERS)
|
|
1108
|
+
|
|
1109
|
+
|
|
611
1110
|
Name | Type | Description | Notes
|
|
612
1111
|
------------- | ------------- | ------------- | -------------
|
|
613
|
-
**identifier** |
|
|
614
|
-
**short_period** |
|
|
615
|
-
**long_period** |
|
|
616
|
-
**start_date** |
|
|
617
|
-
**end_date** |
|
|
618
|
-
**page_size** |
|
|
619
|
-
**next_page** |
|
|
1112
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
1113
|
+
**short_period** | Integer| The number of observations, per period, to calculate short period Simple Moving Average of the Awesome Oscillator | [optional] [default to 5]
|
|
1114
|
+
**long_period** | Integer| The number of observations, per period, to calculate long period Simple Moving Average of the Awesome Oscillator | [optional] [default to 34]
|
|
1115
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
1116
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
1117
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
1118
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
1119
|
+
<br/>
|
|
1120
|
+
|
|
1121
|
+
[//]: # (END_PARAMETERS)
|
|
620
1122
|
|
|
621
1123
|
### Return type
|
|
622
1124
|
|
|
623
1125
|
[**ApiResponseSecurityAwesomeOscillator**](ApiResponseSecurityAwesomeOscillator.md)
|
|
624
1126
|
|
|
625
|
-
#
|
|
1127
|
+
[//]: # (END_OPERATION)
|
|
1128
|
+
|
|
1129
|
+
|
|
1130
|
+
[//]: # (START_OPERATION)
|
|
1131
|
+
|
|
1132
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
1133
|
+
|
|
1134
|
+
[//]: # (METHOD:get_security_price_technicals_atr)
|
|
1135
|
+
|
|
1136
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityAverageTrueRange)
|
|
1137
|
+
|
|
1138
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
1139
|
+
|
|
1140
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityAverageTrueRange.md)
|
|
1141
|
+
|
|
1142
|
+
[//]: # (OPERATION:get_security_price_technicals_atr_v2)
|
|
1143
|
+
|
|
1144
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/atr)
|
|
1145
|
+
|
|
1146
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_atr)
|
|
1147
|
+
|
|
1148
|
+
## **get_security_price_technicals_atr**
|
|
1149
|
+
|
|
1150
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_atr_v2)
|
|
1151
|
+
|
|
1152
|
+
[//]: # (START_OVERVIEW)
|
|
1153
|
+
|
|
626
1154
|
> ApiResponseSecurityAverageTrueRange get_security_price_technicals_atr(identifier, opts)
|
|
627
1155
|
|
|
628
|
-
Average True Range
|
|
1156
|
+
#### Average True Range
|
|
1157
|
+
|
|
629
1158
|
|
|
630
1159
|
Returns the Average True Range values of Stock Prices for the Security with the given `identifier`
|
|
631
1160
|
|
|
1161
|
+
[//]: # (END_OVERVIEW)
|
|
1162
|
+
|
|
632
1163
|
### Example
|
|
1164
|
+
|
|
1165
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
1166
|
+
|
|
633
1167
|
```ruby
|
|
634
1168
|
# Load the gem
|
|
635
1169
|
require 'intrinio-sdk'
|
|
636
1170
|
|
|
637
1171
|
# Setup authorization
|
|
638
1172
|
Intrinio.configure do |config|
|
|
639
|
-
config.api_key['api_key'] = '
|
|
1173
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
640
1174
|
end
|
|
641
1175
|
|
|
642
1176
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -659,36 +1193,78 @@ rescue Intrinio::ApiError => e
|
|
|
659
1193
|
end
|
|
660
1194
|
```
|
|
661
1195
|
|
|
1196
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
1197
|
+
|
|
1198
|
+
[//]: # (START_DEFINITION)
|
|
1199
|
+
|
|
662
1200
|
### Parameters
|
|
663
1201
|
|
|
1202
|
+
[//]: # (START_PARAMETERS)
|
|
1203
|
+
|
|
1204
|
+
|
|
664
1205
|
Name | Type | Description | Notes
|
|
665
1206
|
------------- | ------------- | ------------- | -------------
|
|
666
|
-
**identifier** |
|
|
667
|
-
**period** |
|
|
668
|
-
**start_date** |
|
|
669
|
-
**end_date** |
|
|
670
|
-
**page_size** |
|
|
671
|
-
**next_page** |
|
|
1207
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
1208
|
+
**period** | Integer| The number of observations, per period, to calculate Average True Range | [optional] [default to 14]
|
|
1209
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
1210
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
1211
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
1212
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
1213
|
+
<br/>
|
|
1214
|
+
|
|
1215
|
+
[//]: # (END_PARAMETERS)
|
|
672
1216
|
|
|
673
1217
|
### Return type
|
|
674
1218
|
|
|
675
1219
|
[**ApiResponseSecurityAverageTrueRange**](ApiResponseSecurityAverageTrueRange.md)
|
|
676
1220
|
|
|
677
|
-
#
|
|
1221
|
+
[//]: # (END_OPERATION)
|
|
1222
|
+
|
|
1223
|
+
|
|
1224
|
+
[//]: # (START_OPERATION)
|
|
1225
|
+
|
|
1226
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
1227
|
+
|
|
1228
|
+
[//]: # (METHOD:get_security_price_technicals_bb)
|
|
1229
|
+
|
|
1230
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityBollingerBands)
|
|
1231
|
+
|
|
1232
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
1233
|
+
|
|
1234
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityBollingerBands.md)
|
|
1235
|
+
|
|
1236
|
+
[//]: # (OPERATION:get_security_price_technicals_bb_v2)
|
|
1237
|
+
|
|
1238
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/bb)
|
|
1239
|
+
|
|
1240
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_bb)
|
|
1241
|
+
|
|
1242
|
+
## **get_security_price_technicals_bb**
|
|
1243
|
+
|
|
1244
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_bb_v2)
|
|
1245
|
+
|
|
1246
|
+
[//]: # (START_OVERVIEW)
|
|
1247
|
+
|
|
678
1248
|
> ApiResponseSecurityBollingerBands get_security_price_technicals_bb(identifier, opts)
|
|
679
1249
|
|
|
680
|
-
Bollinger Bands
|
|
1250
|
+
#### Bollinger Bands
|
|
1251
|
+
|
|
681
1252
|
|
|
682
1253
|
Returns the Bollinger Bands values of Stock Prices for the Security with the given `identifier`
|
|
683
1254
|
|
|
1255
|
+
[//]: # (END_OVERVIEW)
|
|
1256
|
+
|
|
684
1257
|
### Example
|
|
1258
|
+
|
|
1259
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
1260
|
+
|
|
685
1261
|
```ruby
|
|
686
1262
|
# Load the gem
|
|
687
1263
|
require 'intrinio-sdk'
|
|
688
1264
|
|
|
689
1265
|
# Setup authorization
|
|
690
1266
|
Intrinio.configure do |config|
|
|
691
|
-
config.api_key['api_key'] = '
|
|
1267
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
692
1268
|
end
|
|
693
1269
|
|
|
694
1270
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -713,38 +1289,80 @@ rescue Intrinio::ApiError => e
|
|
|
713
1289
|
end
|
|
714
1290
|
```
|
|
715
1291
|
|
|
716
|
-
|
|
1292
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
1293
|
+
|
|
1294
|
+
[//]: # (START_DEFINITION)
|
|
1295
|
+
|
|
1296
|
+
### Parameters
|
|
1297
|
+
|
|
1298
|
+
[//]: # (START_PARAMETERS)
|
|
1299
|
+
|
|
1300
|
+
|
|
1301
|
+
Name | Type | Description | Notes
|
|
1302
|
+
------------- | ------------- | ------------- | -------------
|
|
1303
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
1304
|
+
**period** | Integer| The number of observations, per period, to calculate Bollinger Bands | [optional] [default to 20]
|
|
1305
|
+
**standard_deviations** | Float| The number of standard deviations to calculate the upper and lower bands of the Bollinger Bands | [optional] [default to 2.0]
|
|
1306
|
+
**price_key** | String| The Stock Price field to use when calculating Bollinger Bands | [optional] [default to close]
|
|
1307
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
1308
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
1309
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
1310
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
1311
|
+
<br/>
|
|
1312
|
+
|
|
1313
|
+
[//]: # (END_PARAMETERS)
|
|
1314
|
+
|
|
1315
|
+
### Return type
|
|
1316
|
+
|
|
1317
|
+
[**ApiResponseSecurityBollingerBands**](ApiResponseSecurityBollingerBands.md)
|
|
1318
|
+
|
|
1319
|
+
[//]: # (END_OPERATION)
|
|
1320
|
+
|
|
1321
|
+
|
|
1322
|
+
[//]: # (START_OPERATION)
|
|
1323
|
+
|
|
1324
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
1325
|
+
|
|
1326
|
+
[//]: # (METHOD:get_security_price_technicals_cci)
|
|
1327
|
+
|
|
1328
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityCommodityChannelIndex)
|
|
1329
|
+
|
|
1330
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
1331
|
+
|
|
1332
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityCommodityChannelIndex.md)
|
|
1333
|
+
|
|
1334
|
+
[//]: # (OPERATION:get_security_price_technicals_cci_v2)
|
|
1335
|
+
|
|
1336
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/cci)
|
|
1337
|
+
|
|
1338
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_cci)
|
|
717
1339
|
|
|
718
|
-
|
|
719
|
-
------------- | ------------- | ------------- | -------------
|
|
720
|
-
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
721
|
-
**period** | **Integer**| The number of observations, per period, to calculate Bollinger Bands | [optional] [default to 20]
|
|
722
|
-
**standard_deviations** | **Float**| The number of standard deviations to calculate the upper and lower bands of the Bollinger Bands | [optional] [default to 2.0]
|
|
723
|
-
**price_key** | **String**| The Stock Price field to use when calculating Bollinger Bands | [optional] [default to close]
|
|
724
|
-
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
725
|
-
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
726
|
-
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
727
|
-
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
1340
|
+
## **get_security_price_technicals_cci**
|
|
728
1341
|
|
|
729
|
-
|
|
1342
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_cci_v2)
|
|
730
1343
|
|
|
731
|
-
[
|
|
1344
|
+
[//]: # (START_OVERVIEW)
|
|
732
1345
|
|
|
733
|
-
# **get_security_price_technicals_cci**
|
|
734
1346
|
> ApiResponseSecurityCommodityChannelIndex get_security_price_technicals_cci(identifier, opts)
|
|
735
1347
|
|
|
736
|
-
Commodity Channel Index
|
|
1348
|
+
#### Commodity Channel Index
|
|
1349
|
+
|
|
737
1350
|
|
|
738
1351
|
Returns the Commodity Channel Index values of Stock Prices for the Security with the given `identifier`
|
|
739
1352
|
|
|
1353
|
+
[//]: # (END_OVERVIEW)
|
|
1354
|
+
|
|
740
1355
|
### Example
|
|
1356
|
+
|
|
1357
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
1358
|
+
|
|
741
1359
|
```ruby
|
|
742
1360
|
# Load the gem
|
|
743
1361
|
require 'intrinio-sdk'
|
|
744
1362
|
|
|
745
1363
|
# Setup authorization
|
|
746
1364
|
Intrinio.configure do |config|
|
|
747
|
-
config.api_key['api_key'] = '
|
|
1365
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
748
1366
|
end
|
|
749
1367
|
|
|
750
1368
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -768,37 +1386,79 @@ rescue Intrinio::ApiError => e
|
|
|
768
1386
|
end
|
|
769
1387
|
```
|
|
770
1388
|
|
|
1389
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
1390
|
+
|
|
1391
|
+
[//]: # (START_DEFINITION)
|
|
1392
|
+
|
|
771
1393
|
### Parameters
|
|
772
1394
|
|
|
1395
|
+
[//]: # (START_PARAMETERS)
|
|
1396
|
+
|
|
1397
|
+
|
|
773
1398
|
Name | Type | Description | Notes
|
|
774
1399
|
------------- | ------------- | ------------- | -------------
|
|
775
|
-
**identifier** |
|
|
776
|
-
**period** |
|
|
777
|
-
**constant** |
|
|
778
|
-
**start_date** |
|
|
779
|
-
**end_date** |
|
|
780
|
-
**page_size** |
|
|
781
|
-
**next_page** |
|
|
1400
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
1401
|
+
**period** | Integer| The number of observations, per period, to calculate Commodity Channel Index | [optional] [default to 20]
|
|
1402
|
+
**constant** | Float| The number of observations, per period, to calculate Commodity Channel Index | [optional] [default to 0.015]
|
|
1403
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
1404
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
1405
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
1406
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
1407
|
+
<br/>
|
|
1408
|
+
|
|
1409
|
+
[//]: # (END_PARAMETERS)
|
|
782
1410
|
|
|
783
1411
|
### Return type
|
|
784
1412
|
|
|
785
1413
|
[**ApiResponseSecurityCommodityChannelIndex**](ApiResponseSecurityCommodityChannelIndex.md)
|
|
786
1414
|
|
|
787
|
-
#
|
|
1415
|
+
[//]: # (END_OPERATION)
|
|
1416
|
+
|
|
1417
|
+
|
|
1418
|
+
[//]: # (START_OPERATION)
|
|
1419
|
+
|
|
1420
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
1421
|
+
|
|
1422
|
+
[//]: # (METHOD:get_security_price_technicals_cmf)
|
|
1423
|
+
|
|
1424
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityChaikinMoneyFlow)
|
|
1425
|
+
|
|
1426
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
1427
|
+
|
|
1428
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityChaikinMoneyFlow.md)
|
|
1429
|
+
|
|
1430
|
+
[//]: # (OPERATION:get_security_price_technicals_cmf_v2)
|
|
1431
|
+
|
|
1432
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/cmf)
|
|
1433
|
+
|
|
1434
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_cmf)
|
|
1435
|
+
|
|
1436
|
+
## **get_security_price_technicals_cmf**
|
|
1437
|
+
|
|
1438
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_cmf_v2)
|
|
1439
|
+
|
|
1440
|
+
[//]: # (START_OVERVIEW)
|
|
1441
|
+
|
|
788
1442
|
> ApiResponseSecurityChaikinMoneyFlow get_security_price_technicals_cmf(identifier, opts)
|
|
789
1443
|
|
|
790
|
-
Chaikin Money Flow
|
|
1444
|
+
#### Chaikin Money Flow
|
|
1445
|
+
|
|
791
1446
|
|
|
792
1447
|
Returns the Chaikin Money Flow values of Stock Prices for the Security with the given `identifier`
|
|
793
1448
|
|
|
1449
|
+
[//]: # (END_OVERVIEW)
|
|
1450
|
+
|
|
794
1451
|
### Example
|
|
1452
|
+
|
|
1453
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
1454
|
+
|
|
795
1455
|
```ruby
|
|
796
1456
|
# Load the gem
|
|
797
1457
|
require 'intrinio-sdk'
|
|
798
1458
|
|
|
799
1459
|
# Setup authorization
|
|
800
1460
|
Intrinio.configure do |config|
|
|
801
|
-
config.api_key['api_key'] = '
|
|
1461
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
802
1462
|
end
|
|
803
1463
|
|
|
804
1464
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -821,36 +1481,78 @@ rescue Intrinio::ApiError => e
|
|
|
821
1481
|
end
|
|
822
1482
|
```
|
|
823
1483
|
|
|
1484
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
1485
|
+
|
|
1486
|
+
[//]: # (START_DEFINITION)
|
|
1487
|
+
|
|
824
1488
|
### Parameters
|
|
825
1489
|
|
|
1490
|
+
[//]: # (START_PARAMETERS)
|
|
1491
|
+
|
|
1492
|
+
|
|
826
1493
|
Name | Type | Description | Notes
|
|
827
1494
|
------------- | ------------- | ------------- | -------------
|
|
828
|
-
**identifier** |
|
|
829
|
-
**period** |
|
|
830
|
-
**start_date** |
|
|
831
|
-
**end_date** |
|
|
832
|
-
**page_size** |
|
|
833
|
-
**next_page** |
|
|
1495
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
1496
|
+
**period** | Integer| The number of observations, per period, to calculate Chaikin Money Flow | [optional] [default to 20]
|
|
1497
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
1498
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
1499
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
1500
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
1501
|
+
<br/>
|
|
1502
|
+
|
|
1503
|
+
[//]: # (END_PARAMETERS)
|
|
834
1504
|
|
|
835
1505
|
### Return type
|
|
836
1506
|
|
|
837
1507
|
[**ApiResponseSecurityChaikinMoneyFlow**](ApiResponseSecurityChaikinMoneyFlow.md)
|
|
838
1508
|
|
|
839
|
-
#
|
|
1509
|
+
[//]: # (END_OPERATION)
|
|
1510
|
+
|
|
1511
|
+
|
|
1512
|
+
[//]: # (START_OPERATION)
|
|
1513
|
+
|
|
1514
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
1515
|
+
|
|
1516
|
+
[//]: # (METHOD:get_security_price_technicals_dc)
|
|
1517
|
+
|
|
1518
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityDonchianChannel)
|
|
1519
|
+
|
|
1520
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
1521
|
+
|
|
1522
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityDonchianChannel.md)
|
|
1523
|
+
|
|
1524
|
+
[//]: # (OPERATION:get_security_price_technicals_dc_v2)
|
|
1525
|
+
|
|
1526
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/dc)
|
|
1527
|
+
|
|
1528
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_dc)
|
|
1529
|
+
|
|
1530
|
+
## **get_security_price_technicals_dc**
|
|
1531
|
+
|
|
1532
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_dc_v2)
|
|
1533
|
+
|
|
1534
|
+
[//]: # (START_OVERVIEW)
|
|
1535
|
+
|
|
840
1536
|
> ApiResponseSecurityDonchianChannel get_security_price_technicals_dc(identifier, opts)
|
|
841
1537
|
|
|
842
|
-
Donchian Channel
|
|
1538
|
+
#### Donchian Channel
|
|
1539
|
+
|
|
843
1540
|
|
|
844
1541
|
Returns the Donchian Channel values of Stock Prices for the Security with the given `identifier`
|
|
845
1542
|
|
|
1543
|
+
[//]: # (END_OVERVIEW)
|
|
1544
|
+
|
|
846
1545
|
### Example
|
|
1546
|
+
|
|
1547
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
1548
|
+
|
|
847
1549
|
```ruby
|
|
848
1550
|
# Load the gem
|
|
849
1551
|
require 'intrinio-sdk'
|
|
850
1552
|
|
|
851
1553
|
# Setup authorization
|
|
852
1554
|
Intrinio.configure do |config|
|
|
853
|
-
config.api_key['api_key'] = '
|
|
1555
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
854
1556
|
end
|
|
855
1557
|
|
|
856
1558
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -874,37 +1576,79 @@ rescue Intrinio::ApiError => e
|
|
|
874
1576
|
end
|
|
875
1577
|
```
|
|
876
1578
|
|
|
1579
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
1580
|
+
|
|
1581
|
+
[//]: # (START_DEFINITION)
|
|
1582
|
+
|
|
877
1583
|
### Parameters
|
|
878
1584
|
|
|
1585
|
+
[//]: # (START_PARAMETERS)
|
|
1586
|
+
|
|
1587
|
+
|
|
879
1588
|
Name | Type | Description | Notes
|
|
880
1589
|
------------- | ------------- | ------------- | -------------
|
|
881
|
-
**identifier** |
|
|
882
|
-
**period** |
|
|
883
|
-
**price_key** |
|
|
884
|
-
**start_date** |
|
|
885
|
-
**end_date** |
|
|
886
|
-
**page_size** |
|
|
887
|
-
**next_page** |
|
|
1590
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
1591
|
+
**period** | Integer| The number of observations, per period, to calculate Donchian Channel | [optional] [default to 20]
|
|
1592
|
+
**price_key** | String| The Stock Price field to use when calculating Donchian Channel | [optional] [default to close]
|
|
1593
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
1594
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
1595
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
1596
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
1597
|
+
<br/>
|
|
1598
|
+
|
|
1599
|
+
[//]: # (END_PARAMETERS)
|
|
888
1600
|
|
|
889
1601
|
### Return type
|
|
890
1602
|
|
|
891
1603
|
[**ApiResponseSecurityDonchianChannel**](ApiResponseSecurityDonchianChannel.md)
|
|
892
1604
|
|
|
893
|
-
#
|
|
1605
|
+
[//]: # (END_OPERATION)
|
|
1606
|
+
|
|
1607
|
+
|
|
1608
|
+
[//]: # (START_OPERATION)
|
|
1609
|
+
|
|
1610
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
1611
|
+
|
|
1612
|
+
[//]: # (METHOD:get_security_price_technicals_dpo)
|
|
1613
|
+
|
|
1614
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityDetrendedPriceOscillator)
|
|
1615
|
+
|
|
1616
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
1617
|
+
|
|
1618
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityDetrendedPriceOscillator.md)
|
|
1619
|
+
|
|
1620
|
+
[//]: # (OPERATION:get_security_price_technicals_dpo_v2)
|
|
1621
|
+
|
|
1622
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/dpo)
|
|
1623
|
+
|
|
1624
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_dpo)
|
|
1625
|
+
|
|
1626
|
+
## **get_security_price_technicals_dpo**
|
|
1627
|
+
|
|
1628
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_dpo_v2)
|
|
1629
|
+
|
|
1630
|
+
[//]: # (START_OVERVIEW)
|
|
1631
|
+
|
|
894
1632
|
> ApiResponseSecurityDetrendedPriceOscillator get_security_price_technicals_dpo(identifier, opts)
|
|
895
1633
|
|
|
896
|
-
Detrended Price Oscillator
|
|
1634
|
+
#### Detrended Price Oscillator
|
|
1635
|
+
|
|
897
1636
|
|
|
898
1637
|
Returns the Detrended Price Oscillator values of Stock Prices for the Security with the given `identifier`
|
|
899
1638
|
|
|
1639
|
+
[//]: # (END_OVERVIEW)
|
|
1640
|
+
|
|
900
1641
|
### Example
|
|
1642
|
+
|
|
1643
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
1644
|
+
|
|
901
1645
|
```ruby
|
|
902
1646
|
# Load the gem
|
|
903
1647
|
require 'intrinio-sdk'
|
|
904
1648
|
|
|
905
1649
|
# Setup authorization
|
|
906
1650
|
Intrinio.configure do |config|
|
|
907
|
-
config.api_key['api_key'] = '
|
|
1651
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
908
1652
|
end
|
|
909
1653
|
|
|
910
1654
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -928,37 +1672,79 @@ rescue Intrinio::ApiError => e
|
|
|
928
1672
|
end
|
|
929
1673
|
```
|
|
930
1674
|
|
|
1675
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
1676
|
+
|
|
1677
|
+
[//]: # (START_DEFINITION)
|
|
1678
|
+
|
|
931
1679
|
### Parameters
|
|
932
1680
|
|
|
1681
|
+
[//]: # (START_PARAMETERS)
|
|
1682
|
+
|
|
1683
|
+
|
|
933
1684
|
Name | Type | Description | Notes
|
|
934
1685
|
------------- | ------------- | ------------- | -------------
|
|
935
|
-
**identifier** |
|
|
936
|
-
**period** |
|
|
937
|
-
**price_key** |
|
|
938
|
-
**start_date** |
|
|
939
|
-
**end_date** |
|
|
940
|
-
**page_size** |
|
|
941
|
-
**next_page** |
|
|
1686
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
1687
|
+
**period** | Integer| The number of observations, per period, to calculate Detrended Price Oscillator | [optional] [default to 20]
|
|
1688
|
+
**price_key** | String| The Stock Price field to use when calculating Detrended Price Oscillator | [optional] [default to close]
|
|
1689
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
1690
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
1691
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
1692
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
1693
|
+
<br/>
|
|
1694
|
+
|
|
1695
|
+
[//]: # (END_PARAMETERS)
|
|
942
1696
|
|
|
943
1697
|
### Return type
|
|
944
1698
|
|
|
945
1699
|
[**ApiResponseSecurityDetrendedPriceOscillator**](ApiResponseSecurityDetrendedPriceOscillator.md)
|
|
946
1700
|
|
|
947
|
-
#
|
|
1701
|
+
[//]: # (END_OPERATION)
|
|
1702
|
+
|
|
1703
|
+
|
|
1704
|
+
[//]: # (START_OPERATION)
|
|
1705
|
+
|
|
1706
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
1707
|
+
|
|
1708
|
+
[//]: # (METHOD:get_security_price_technicals_eom)
|
|
1709
|
+
|
|
1710
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityEaseOfMovement)
|
|
1711
|
+
|
|
1712
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
1713
|
+
|
|
1714
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityEaseOfMovement.md)
|
|
1715
|
+
|
|
1716
|
+
[//]: # (OPERATION:get_security_price_technicals_eom_v2)
|
|
1717
|
+
|
|
1718
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/eom)
|
|
1719
|
+
|
|
1720
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_eom)
|
|
1721
|
+
|
|
1722
|
+
## **get_security_price_technicals_eom**
|
|
1723
|
+
|
|
1724
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_eom_v2)
|
|
1725
|
+
|
|
1726
|
+
[//]: # (START_OVERVIEW)
|
|
1727
|
+
|
|
948
1728
|
> ApiResponseSecurityEaseOfMovement get_security_price_technicals_eom(identifier, opts)
|
|
949
1729
|
|
|
950
|
-
Ease of Movement
|
|
1730
|
+
#### Ease of Movement
|
|
1731
|
+
|
|
951
1732
|
|
|
952
1733
|
Returns the Ease of Movement values of Stock Prices for the Security with the given `identifier`
|
|
953
1734
|
|
|
1735
|
+
[//]: # (END_OVERVIEW)
|
|
1736
|
+
|
|
954
1737
|
### Example
|
|
1738
|
+
|
|
1739
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
1740
|
+
|
|
955
1741
|
```ruby
|
|
956
1742
|
# Load the gem
|
|
957
1743
|
require 'intrinio-sdk'
|
|
958
1744
|
|
|
959
1745
|
# Setup authorization
|
|
960
1746
|
Intrinio.configure do |config|
|
|
961
|
-
config.api_key['api_key'] = '
|
|
1747
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
962
1748
|
end
|
|
963
1749
|
|
|
964
1750
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -981,36 +1767,78 @@ rescue Intrinio::ApiError => e
|
|
|
981
1767
|
end
|
|
982
1768
|
```
|
|
983
1769
|
|
|
1770
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
1771
|
+
|
|
1772
|
+
[//]: # (START_DEFINITION)
|
|
1773
|
+
|
|
984
1774
|
### Parameters
|
|
985
1775
|
|
|
1776
|
+
[//]: # (START_PARAMETERS)
|
|
1777
|
+
|
|
1778
|
+
|
|
986
1779
|
Name | Type | Description | Notes
|
|
987
1780
|
------------- | ------------- | ------------- | -------------
|
|
988
|
-
**identifier** |
|
|
989
|
-
**period** |
|
|
990
|
-
**start_date** |
|
|
991
|
-
**end_date** |
|
|
992
|
-
**page_size** |
|
|
993
|
-
**next_page** |
|
|
1781
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
1782
|
+
**period** | Integer| The number of observations, per period, to calculate Ease of Movement | [optional] [default to 20]
|
|
1783
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
1784
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
1785
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
1786
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
1787
|
+
<br/>
|
|
1788
|
+
|
|
1789
|
+
[//]: # (END_PARAMETERS)
|
|
994
1790
|
|
|
995
1791
|
### Return type
|
|
996
1792
|
|
|
997
1793
|
[**ApiResponseSecurityEaseOfMovement**](ApiResponseSecurityEaseOfMovement.md)
|
|
998
1794
|
|
|
999
|
-
#
|
|
1795
|
+
[//]: # (END_OPERATION)
|
|
1796
|
+
|
|
1797
|
+
|
|
1798
|
+
[//]: # (START_OPERATION)
|
|
1799
|
+
|
|
1800
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
1801
|
+
|
|
1802
|
+
[//]: # (METHOD:get_security_price_technicals_fi)
|
|
1803
|
+
|
|
1804
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityForceIndex)
|
|
1805
|
+
|
|
1806
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
1807
|
+
|
|
1808
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityForceIndex.md)
|
|
1809
|
+
|
|
1810
|
+
[//]: # (OPERATION:get_security_price_technicals_fi_v2)
|
|
1811
|
+
|
|
1812
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/fi)
|
|
1813
|
+
|
|
1814
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_fi)
|
|
1815
|
+
|
|
1816
|
+
## **get_security_price_technicals_fi**
|
|
1817
|
+
|
|
1818
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_fi_v2)
|
|
1819
|
+
|
|
1820
|
+
[//]: # (START_OVERVIEW)
|
|
1821
|
+
|
|
1000
1822
|
> ApiResponseSecurityForceIndex get_security_price_technicals_fi(identifier, opts)
|
|
1001
1823
|
|
|
1002
|
-
Force Index
|
|
1824
|
+
#### Force Index
|
|
1825
|
+
|
|
1003
1826
|
|
|
1004
1827
|
Returns the Force Index values of Stock Prices for the Security with the given `identifier`
|
|
1005
1828
|
|
|
1829
|
+
[//]: # (END_OVERVIEW)
|
|
1830
|
+
|
|
1006
1831
|
### Example
|
|
1832
|
+
|
|
1833
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
1834
|
+
|
|
1007
1835
|
```ruby
|
|
1008
1836
|
# Load the gem
|
|
1009
1837
|
require 'intrinio-sdk'
|
|
1010
1838
|
|
|
1011
1839
|
# Setup authorization
|
|
1012
1840
|
Intrinio.configure do |config|
|
|
1013
|
-
config.api_key['api_key'] = '
|
|
1841
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
1014
1842
|
end
|
|
1015
1843
|
|
|
1016
1844
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -1032,35 +1860,77 @@ rescue Intrinio::ApiError => e
|
|
|
1032
1860
|
end
|
|
1033
1861
|
```
|
|
1034
1862
|
|
|
1863
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
1864
|
+
|
|
1865
|
+
[//]: # (START_DEFINITION)
|
|
1866
|
+
|
|
1035
1867
|
### Parameters
|
|
1036
1868
|
|
|
1869
|
+
[//]: # (START_PARAMETERS)
|
|
1870
|
+
|
|
1871
|
+
|
|
1037
1872
|
Name | Type | Description | Notes
|
|
1038
1873
|
------------- | ------------- | ------------- | -------------
|
|
1039
|
-
**identifier** |
|
|
1040
|
-
**start_date** |
|
|
1041
|
-
**end_date** |
|
|
1042
|
-
**page_size** |
|
|
1043
|
-
**next_page** |
|
|
1874
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
1875
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
1876
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
1877
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
1878
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
1879
|
+
<br/>
|
|
1880
|
+
|
|
1881
|
+
[//]: # (END_PARAMETERS)
|
|
1044
1882
|
|
|
1045
1883
|
### Return type
|
|
1046
1884
|
|
|
1047
1885
|
[**ApiResponseSecurityForceIndex**](ApiResponseSecurityForceIndex.md)
|
|
1048
1886
|
|
|
1049
|
-
#
|
|
1887
|
+
[//]: # (END_OPERATION)
|
|
1888
|
+
|
|
1889
|
+
|
|
1890
|
+
[//]: # (START_OPERATION)
|
|
1891
|
+
|
|
1892
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
1893
|
+
|
|
1894
|
+
[//]: # (METHOD:get_security_price_technicals_ichimoku)
|
|
1895
|
+
|
|
1896
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityIchimokuKinkoHyo)
|
|
1897
|
+
|
|
1898
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
1899
|
+
|
|
1900
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityIchimokuKinkoHyo.md)
|
|
1901
|
+
|
|
1902
|
+
[//]: # (OPERATION:get_security_price_technicals_ichimoku_v2)
|
|
1903
|
+
|
|
1904
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/ichimoku)
|
|
1905
|
+
|
|
1906
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_ichimoku)
|
|
1907
|
+
|
|
1908
|
+
## **get_security_price_technicals_ichimoku**
|
|
1909
|
+
|
|
1910
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_ichimoku_v2)
|
|
1911
|
+
|
|
1912
|
+
[//]: # (START_OVERVIEW)
|
|
1913
|
+
|
|
1050
1914
|
> ApiResponseSecurityIchimokuKinkoHyo get_security_price_technicals_ichimoku(identifier, opts)
|
|
1051
1915
|
|
|
1052
|
-
Ichimoku Kinko Hyo
|
|
1916
|
+
#### Ichimoku Kinko Hyo
|
|
1917
|
+
|
|
1053
1918
|
|
|
1054
1919
|
Returns the Ichimoku Kinko Hyo values of Stock Prices for the Security with the given `identifier`
|
|
1055
1920
|
|
|
1921
|
+
[//]: # (END_OVERVIEW)
|
|
1922
|
+
|
|
1056
1923
|
### Example
|
|
1924
|
+
|
|
1925
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
1926
|
+
|
|
1057
1927
|
```ruby
|
|
1058
1928
|
# Load the gem
|
|
1059
1929
|
require 'intrinio-sdk'
|
|
1060
1930
|
|
|
1061
1931
|
# Setup authorization
|
|
1062
1932
|
Intrinio.configure do |config|
|
|
1063
|
-
config.api_key['api_key'] = '
|
|
1933
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
1064
1934
|
end
|
|
1065
1935
|
|
|
1066
1936
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -1085,38 +1955,80 @@ rescue Intrinio::ApiError => e
|
|
|
1085
1955
|
end
|
|
1086
1956
|
```
|
|
1087
1957
|
|
|
1958
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
1959
|
+
|
|
1960
|
+
[//]: # (START_DEFINITION)
|
|
1961
|
+
|
|
1088
1962
|
### Parameters
|
|
1089
1963
|
|
|
1964
|
+
[//]: # (START_PARAMETERS)
|
|
1965
|
+
|
|
1966
|
+
|
|
1090
1967
|
Name | Type | Description | Notes
|
|
1091
1968
|
------------- | ------------- | ------------- | -------------
|
|
1092
|
-
**identifier** |
|
|
1093
|
-
**low_period** |
|
|
1094
|
-
**medium_period** |
|
|
1095
|
-
**high_period** |
|
|
1096
|
-
**start_date** |
|
|
1097
|
-
**end_date** |
|
|
1098
|
-
**page_size** |
|
|
1099
|
-
**next_page** |
|
|
1969
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
1970
|
+
**low_period** | Integer| The number of observations, per period, to calculate Tenkan Sen (Conversion Line) of Ichimoku Kinko Hyo | [optional] [default to 9]
|
|
1971
|
+
**medium_period** | Integer| The number of observations, per period, to calculate Kijun Sen (Base Line), Senkou Span A (Leading Span A), and Chikou Span (Lagging Span) of Ichimoku Kinko Hyo | [optional] [default to 26]
|
|
1972
|
+
**high_period** | Integer| The number of observations, per period, to calculate Senkou Span B (Leading Span B) of Ichimoku Kinko Hyo | [optional] [default to 52]
|
|
1973
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
1974
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
1975
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
1976
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
1977
|
+
<br/>
|
|
1978
|
+
|
|
1979
|
+
[//]: # (END_PARAMETERS)
|
|
1100
1980
|
|
|
1101
1981
|
### Return type
|
|
1102
1982
|
|
|
1103
1983
|
[**ApiResponseSecurityIchimokuKinkoHyo**](ApiResponseSecurityIchimokuKinkoHyo.md)
|
|
1104
1984
|
|
|
1105
|
-
#
|
|
1985
|
+
[//]: # (END_OPERATION)
|
|
1986
|
+
|
|
1987
|
+
|
|
1988
|
+
[//]: # (START_OPERATION)
|
|
1989
|
+
|
|
1990
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
1991
|
+
|
|
1992
|
+
[//]: # (METHOD:get_security_price_technicals_kc)
|
|
1993
|
+
|
|
1994
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityKeltnerChannel)
|
|
1995
|
+
|
|
1996
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
1997
|
+
|
|
1998
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityKeltnerChannel.md)
|
|
1999
|
+
|
|
2000
|
+
[//]: # (OPERATION:get_security_price_technicals_kc_v2)
|
|
2001
|
+
|
|
2002
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/kc)
|
|
2003
|
+
|
|
2004
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_kc)
|
|
2005
|
+
|
|
2006
|
+
## **get_security_price_technicals_kc**
|
|
2007
|
+
|
|
2008
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_kc_v2)
|
|
2009
|
+
|
|
2010
|
+
[//]: # (START_OVERVIEW)
|
|
2011
|
+
|
|
1106
2012
|
> ApiResponseSecurityKeltnerChannel get_security_price_technicals_kc(identifier, opts)
|
|
1107
2013
|
|
|
1108
|
-
Keltner Channel
|
|
2014
|
+
#### Keltner Channel
|
|
2015
|
+
|
|
1109
2016
|
|
|
1110
2017
|
Returns the Keltner Channel values of Stock Prices for the Security with the given `identifier`
|
|
1111
2018
|
|
|
2019
|
+
[//]: # (END_OVERVIEW)
|
|
2020
|
+
|
|
1112
2021
|
### Example
|
|
2022
|
+
|
|
2023
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
2024
|
+
|
|
1113
2025
|
```ruby
|
|
1114
2026
|
# Load the gem
|
|
1115
2027
|
require 'intrinio-sdk'
|
|
1116
2028
|
|
|
1117
2029
|
# Setup authorization
|
|
1118
2030
|
Intrinio.configure do |config|
|
|
1119
|
-
config.api_key['api_key'] = '
|
|
2031
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
1120
2032
|
end
|
|
1121
2033
|
|
|
1122
2034
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -1139,36 +2051,78 @@ rescue Intrinio::ApiError => e
|
|
|
1139
2051
|
end
|
|
1140
2052
|
```
|
|
1141
2053
|
|
|
2054
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
2055
|
+
|
|
2056
|
+
[//]: # (START_DEFINITION)
|
|
2057
|
+
|
|
1142
2058
|
### Parameters
|
|
1143
2059
|
|
|
2060
|
+
[//]: # (START_PARAMETERS)
|
|
2061
|
+
|
|
2062
|
+
|
|
1144
2063
|
Name | Type | Description | Notes
|
|
1145
2064
|
------------- | ------------- | ------------- | -------------
|
|
1146
|
-
**identifier** |
|
|
1147
|
-
**period** |
|
|
1148
|
-
**start_date** |
|
|
1149
|
-
**end_date** |
|
|
1150
|
-
**page_size** |
|
|
1151
|
-
**next_page** |
|
|
2065
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
2066
|
+
**period** | Integer| The number of observations, per period, to calculate Kelter Channel | [optional] [default to 10]
|
|
2067
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
2068
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
2069
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
2070
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
2071
|
+
<br/>
|
|
2072
|
+
|
|
2073
|
+
[//]: # (END_PARAMETERS)
|
|
1152
2074
|
|
|
1153
2075
|
### Return type
|
|
1154
2076
|
|
|
1155
2077
|
[**ApiResponseSecurityKeltnerChannel**](ApiResponseSecurityKeltnerChannel.md)
|
|
1156
2078
|
|
|
1157
|
-
#
|
|
2079
|
+
[//]: # (END_OPERATION)
|
|
2080
|
+
|
|
2081
|
+
|
|
2082
|
+
[//]: # (START_OPERATION)
|
|
2083
|
+
|
|
2084
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
2085
|
+
|
|
2086
|
+
[//]: # (METHOD:get_security_price_technicals_kst)
|
|
2087
|
+
|
|
2088
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityKnowSureThing)
|
|
2089
|
+
|
|
2090
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
2091
|
+
|
|
2092
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityKnowSureThing.md)
|
|
2093
|
+
|
|
2094
|
+
[//]: # (OPERATION:get_security_price_technicals_kst_v2)
|
|
2095
|
+
|
|
2096
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/kst)
|
|
2097
|
+
|
|
2098
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_kst)
|
|
2099
|
+
|
|
2100
|
+
## **get_security_price_technicals_kst**
|
|
2101
|
+
|
|
2102
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_kst_v2)
|
|
2103
|
+
|
|
2104
|
+
[//]: # (START_OVERVIEW)
|
|
2105
|
+
|
|
1158
2106
|
> ApiResponseSecurityKnowSureThing get_security_price_technicals_kst(identifier, opts)
|
|
1159
2107
|
|
|
1160
|
-
Know Sure Thing
|
|
2108
|
+
#### Know Sure Thing
|
|
2109
|
+
|
|
1161
2110
|
|
|
1162
2111
|
Returns the Know Sure Thing values of Stock Prices for the Security with the given `identifier`
|
|
1163
2112
|
|
|
2113
|
+
[//]: # (END_OVERVIEW)
|
|
2114
|
+
|
|
1164
2115
|
### Example
|
|
2116
|
+
|
|
2117
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
2118
|
+
|
|
1165
2119
|
```ruby
|
|
1166
2120
|
# Load the gem
|
|
1167
2121
|
require 'intrinio-sdk'
|
|
1168
2122
|
|
|
1169
2123
|
# Setup authorization
|
|
1170
2124
|
Intrinio.configure do |config|
|
|
1171
|
-
config.api_key['api_key'] = '
|
|
2125
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
1172
2126
|
end
|
|
1173
2127
|
|
|
1174
2128
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -1199,44 +2153,86 @@ rescue Intrinio::ApiError => e
|
|
|
1199
2153
|
end
|
|
1200
2154
|
```
|
|
1201
2155
|
|
|
2156
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
2157
|
+
|
|
2158
|
+
[//]: # (START_DEFINITION)
|
|
2159
|
+
|
|
1202
2160
|
### Parameters
|
|
1203
2161
|
|
|
2162
|
+
[//]: # (START_PARAMETERS)
|
|
2163
|
+
|
|
2164
|
+
|
|
1204
2165
|
Name | Type | Description | Notes
|
|
1205
2166
|
------------- | ------------- | ------------- | -------------
|
|
1206
|
-
**identifier** |
|
|
1207
|
-
**roc1** |
|
|
1208
|
-
**roc2** |
|
|
1209
|
-
**roc3** |
|
|
1210
|
-
**roc4** |
|
|
1211
|
-
**sma1** |
|
|
1212
|
-
**sma2** |
|
|
1213
|
-
**sma3** |
|
|
1214
|
-
**sma4** |
|
|
1215
|
-
**price_key** |
|
|
1216
|
-
**start_date** |
|
|
1217
|
-
**end_date** |
|
|
1218
|
-
**page_size** |
|
|
1219
|
-
**next_page** |
|
|
2167
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
2168
|
+
**roc1** | Integer| The number of observations, per period, to calculate the rate-of-change for RCMA1 | [optional] [default to 10]
|
|
2169
|
+
**roc2** | Integer| The number of observations, per period, to calculate the rate-of-change for RCMA2 | [optional] [default to 15]
|
|
2170
|
+
**roc3** | Integer| The number of observations, per period, to calculate the rate-of-change for RCMA3 | [optional] [default to 20]
|
|
2171
|
+
**roc4** | Integer| The number of observations, per period, to calculate the rate-of-change for RCMA4 | [optional] [default to 30]
|
|
2172
|
+
**sma1** | Integer| The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA1 | [optional] [default to 10]
|
|
2173
|
+
**sma2** | Integer| The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA2 | [optional] [default to 10]
|
|
2174
|
+
**sma3** | Integer| The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA3 | [optional] [default to 10]
|
|
2175
|
+
**sma4** | Integer| The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA4 | [optional] [default to 15]
|
|
2176
|
+
**price_key** | String| The Stock Price field to use when calculating Know Sure Thing | [optional] [default to close]
|
|
2177
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
2178
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
2179
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
2180
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
2181
|
+
<br/>
|
|
2182
|
+
|
|
2183
|
+
[//]: # (END_PARAMETERS)
|
|
1220
2184
|
|
|
1221
2185
|
### Return type
|
|
1222
2186
|
|
|
1223
2187
|
[**ApiResponseSecurityKnowSureThing**](ApiResponseSecurityKnowSureThing.md)
|
|
1224
2188
|
|
|
1225
|
-
#
|
|
2189
|
+
[//]: # (END_OPERATION)
|
|
2190
|
+
|
|
2191
|
+
|
|
2192
|
+
[//]: # (START_OPERATION)
|
|
2193
|
+
|
|
2194
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
2195
|
+
|
|
2196
|
+
[//]: # (METHOD:get_security_price_technicals_macd)
|
|
2197
|
+
|
|
2198
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityMovingAverageConvergenceDivergence)
|
|
2199
|
+
|
|
2200
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
2201
|
+
|
|
2202
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityMovingAverageConvergenceDivergence.md)
|
|
2203
|
+
|
|
2204
|
+
[//]: # (OPERATION:get_security_price_technicals_macd_v2)
|
|
2205
|
+
|
|
2206
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/macd)
|
|
2207
|
+
|
|
2208
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_macd)
|
|
2209
|
+
|
|
2210
|
+
## **get_security_price_technicals_macd**
|
|
2211
|
+
|
|
2212
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_macd_v2)
|
|
2213
|
+
|
|
2214
|
+
[//]: # (START_OVERVIEW)
|
|
2215
|
+
|
|
1226
2216
|
> ApiResponseSecurityMovingAverageConvergenceDivergence get_security_price_technicals_macd(identifier, opts)
|
|
1227
2217
|
|
|
1228
|
-
Moving Average Convergence Divergence
|
|
2218
|
+
#### Moving Average Convergence Divergence
|
|
2219
|
+
|
|
1229
2220
|
|
|
1230
2221
|
Returns the Moving Average Convergence Divergence values of Stock Prices for the Security with the given `identifier`
|
|
1231
2222
|
|
|
2223
|
+
[//]: # (END_OVERVIEW)
|
|
2224
|
+
|
|
1232
2225
|
### Example
|
|
2226
|
+
|
|
2227
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
2228
|
+
|
|
1233
2229
|
```ruby
|
|
1234
2230
|
# Load the gem
|
|
1235
2231
|
require 'intrinio-sdk'
|
|
1236
2232
|
|
|
1237
2233
|
# Setup authorization
|
|
1238
2234
|
Intrinio.configure do |config|
|
|
1239
|
-
config.api_key['api_key'] = '
|
|
2235
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
1240
2236
|
end
|
|
1241
2237
|
|
|
1242
2238
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -1262,39 +2258,81 @@ rescue Intrinio::ApiError => e
|
|
|
1262
2258
|
end
|
|
1263
2259
|
```
|
|
1264
2260
|
|
|
2261
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
2262
|
+
|
|
2263
|
+
[//]: # (START_DEFINITION)
|
|
2264
|
+
|
|
1265
2265
|
### Parameters
|
|
1266
2266
|
|
|
2267
|
+
[//]: # (START_PARAMETERS)
|
|
2268
|
+
|
|
2269
|
+
|
|
1267
2270
|
Name | Type | Description | Notes
|
|
1268
2271
|
------------- | ------------- | ------------- | -------------
|
|
1269
|
-
**identifier** |
|
|
1270
|
-
**fast_period** |
|
|
1271
|
-
**slow_period** |
|
|
1272
|
-
**signal_period** |
|
|
1273
|
-
**price_key** |
|
|
1274
|
-
**start_date** |
|
|
1275
|
-
**end_date** |
|
|
1276
|
-
**page_size** |
|
|
1277
|
-
**next_page** |
|
|
2272
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
2273
|
+
**fast_period** | Integer| The number of observations, per period, to calculate the fast moving Exponential Moving Average for Moving Average Convergence Divergence | [optional] [default to 12]
|
|
2274
|
+
**slow_period** | Integer| The number of observations, per period, to calculate the slow moving Exponential Moving Average for Moving Average Convergence Divergence | [optional] [default to 26]
|
|
2275
|
+
**signal_period** | Integer| The number of observations, per period, to calculate the signal line for Moving Average Convergence Divergence | [optional] [default to 9]
|
|
2276
|
+
**price_key** | String| The Stock Price field to use when calculating Moving Average Convergence Divergence | [optional] [default to close]
|
|
2277
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
2278
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
2279
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
2280
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
2281
|
+
<br/>
|
|
2282
|
+
|
|
2283
|
+
[//]: # (END_PARAMETERS)
|
|
1278
2284
|
|
|
1279
2285
|
### Return type
|
|
1280
2286
|
|
|
1281
2287
|
[**ApiResponseSecurityMovingAverageConvergenceDivergence**](ApiResponseSecurityMovingAverageConvergenceDivergence.md)
|
|
1282
2288
|
|
|
1283
|
-
#
|
|
2289
|
+
[//]: # (END_OPERATION)
|
|
2290
|
+
|
|
2291
|
+
|
|
2292
|
+
[//]: # (START_OPERATION)
|
|
2293
|
+
|
|
2294
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
2295
|
+
|
|
2296
|
+
[//]: # (METHOD:get_security_price_technicals_mfi)
|
|
2297
|
+
|
|
2298
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityMoneyFlowIndex)
|
|
2299
|
+
|
|
2300
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
2301
|
+
|
|
2302
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityMoneyFlowIndex.md)
|
|
2303
|
+
|
|
2304
|
+
[//]: # (OPERATION:get_security_price_technicals_mfi_v2)
|
|
2305
|
+
|
|
2306
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/mfi)
|
|
2307
|
+
|
|
2308
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_mfi)
|
|
2309
|
+
|
|
2310
|
+
## **get_security_price_technicals_mfi**
|
|
2311
|
+
|
|
2312
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_mfi_v2)
|
|
2313
|
+
|
|
2314
|
+
[//]: # (START_OVERVIEW)
|
|
2315
|
+
|
|
1284
2316
|
> ApiResponseSecurityMoneyFlowIndex get_security_price_technicals_mfi(identifier, opts)
|
|
1285
2317
|
|
|
1286
|
-
Money Flow Index
|
|
2318
|
+
#### Money Flow Index
|
|
2319
|
+
|
|
1287
2320
|
|
|
1288
2321
|
Returns the Money Flow Index values of Stock Prices for the Security with the given `identifier`
|
|
1289
2322
|
|
|
2323
|
+
[//]: # (END_OVERVIEW)
|
|
2324
|
+
|
|
1290
2325
|
### Example
|
|
2326
|
+
|
|
2327
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
2328
|
+
|
|
1291
2329
|
```ruby
|
|
1292
2330
|
# Load the gem
|
|
1293
2331
|
require 'intrinio-sdk'
|
|
1294
2332
|
|
|
1295
2333
|
# Setup authorization
|
|
1296
2334
|
Intrinio.configure do |config|
|
|
1297
|
-
config.api_key['api_key'] = '
|
|
2335
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
1298
2336
|
end
|
|
1299
2337
|
|
|
1300
2338
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -1317,36 +2355,78 @@ rescue Intrinio::ApiError => e
|
|
|
1317
2355
|
end
|
|
1318
2356
|
```
|
|
1319
2357
|
|
|
2358
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
2359
|
+
|
|
2360
|
+
[//]: # (START_DEFINITION)
|
|
2361
|
+
|
|
1320
2362
|
### Parameters
|
|
1321
2363
|
|
|
2364
|
+
[//]: # (START_PARAMETERS)
|
|
2365
|
+
|
|
2366
|
+
|
|
1322
2367
|
Name | Type | Description | Notes
|
|
1323
2368
|
------------- | ------------- | ------------- | -------------
|
|
1324
|
-
**identifier** |
|
|
1325
|
-
**period** |
|
|
1326
|
-
**start_date** |
|
|
1327
|
-
**end_date** |
|
|
1328
|
-
**page_size** |
|
|
1329
|
-
**next_page** |
|
|
2369
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
2370
|
+
**period** | Integer| The number of observations, per period, to calculate Money Flow Index | [optional] [default to 14]
|
|
2371
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
2372
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
2373
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
2374
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
2375
|
+
<br/>
|
|
2376
|
+
|
|
2377
|
+
[//]: # (END_PARAMETERS)
|
|
1330
2378
|
|
|
1331
2379
|
### Return type
|
|
1332
2380
|
|
|
1333
2381
|
[**ApiResponseSecurityMoneyFlowIndex**](ApiResponseSecurityMoneyFlowIndex.md)
|
|
1334
2382
|
|
|
1335
|
-
#
|
|
2383
|
+
[//]: # (END_OPERATION)
|
|
2384
|
+
|
|
2385
|
+
|
|
2386
|
+
[//]: # (START_OPERATION)
|
|
2387
|
+
|
|
2388
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
2389
|
+
|
|
2390
|
+
[//]: # (METHOD:get_security_price_technicals_mi)
|
|
2391
|
+
|
|
2392
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityMassIndex)
|
|
2393
|
+
|
|
2394
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
2395
|
+
|
|
2396
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityMassIndex.md)
|
|
2397
|
+
|
|
2398
|
+
[//]: # (OPERATION:get_security_price_technicals_mi_v2)
|
|
2399
|
+
|
|
2400
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/mi)
|
|
2401
|
+
|
|
2402
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_mi)
|
|
2403
|
+
|
|
2404
|
+
## **get_security_price_technicals_mi**
|
|
2405
|
+
|
|
2406
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_mi_v2)
|
|
2407
|
+
|
|
2408
|
+
[//]: # (START_OVERVIEW)
|
|
2409
|
+
|
|
1336
2410
|
> ApiResponseSecurityMassIndex get_security_price_technicals_mi(identifier, opts)
|
|
1337
2411
|
|
|
1338
|
-
Mass Index
|
|
2412
|
+
#### Mass Index
|
|
2413
|
+
|
|
1339
2414
|
|
|
1340
2415
|
Returns the Mass Index values of Stock Prices for the Security with the given `identifier`
|
|
1341
2416
|
|
|
2417
|
+
[//]: # (END_OVERVIEW)
|
|
2418
|
+
|
|
1342
2419
|
### Example
|
|
2420
|
+
|
|
2421
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
2422
|
+
|
|
1343
2423
|
```ruby
|
|
1344
2424
|
# Load the gem
|
|
1345
2425
|
require 'intrinio-sdk'
|
|
1346
2426
|
|
|
1347
2427
|
# Setup authorization
|
|
1348
2428
|
Intrinio.configure do |config|
|
|
1349
|
-
config.api_key['api_key'] = '
|
|
2429
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
1350
2430
|
end
|
|
1351
2431
|
|
|
1352
2432
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -1370,37 +2450,79 @@ rescue Intrinio::ApiError => e
|
|
|
1370
2450
|
end
|
|
1371
2451
|
```
|
|
1372
2452
|
|
|
2453
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
2454
|
+
|
|
2455
|
+
[//]: # (START_DEFINITION)
|
|
2456
|
+
|
|
1373
2457
|
### Parameters
|
|
1374
2458
|
|
|
2459
|
+
[//]: # (START_PARAMETERS)
|
|
2460
|
+
|
|
2461
|
+
|
|
1375
2462
|
Name | Type | Description | Notes
|
|
1376
2463
|
------------- | ------------- | ------------- | -------------
|
|
1377
|
-
**identifier** |
|
|
1378
|
-
**ema_period** |
|
|
1379
|
-
**sum_period** |
|
|
1380
|
-
**start_date** |
|
|
1381
|
-
**end_date** |
|
|
1382
|
-
**page_size** |
|
|
1383
|
-
**next_page** |
|
|
2464
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
2465
|
+
**ema_period** | Integer| The number of observations, per period, to calculate the single Exponential Moving Average and the Double Exponential Moving Average for Mass Index | [optional] [default to 9]
|
|
2466
|
+
**sum_period** | Integer| The number of observations, per period, to calculate the sum of the Exponetinal Moving Average Ratios for Mass Index | [optional] [default to 25]
|
|
2467
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
2468
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
2469
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
2470
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
2471
|
+
<br/>
|
|
2472
|
+
|
|
2473
|
+
[//]: # (END_PARAMETERS)
|
|
1384
2474
|
|
|
1385
2475
|
### Return type
|
|
1386
2476
|
|
|
1387
2477
|
[**ApiResponseSecurityMassIndex**](ApiResponseSecurityMassIndex.md)
|
|
1388
2478
|
|
|
1389
|
-
#
|
|
2479
|
+
[//]: # (END_OPERATION)
|
|
2480
|
+
|
|
2481
|
+
|
|
2482
|
+
[//]: # (START_OPERATION)
|
|
2483
|
+
|
|
2484
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
2485
|
+
|
|
2486
|
+
[//]: # (METHOD:get_security_price_technicals_nvi)
|
|
2487
|
+
|
|
2488
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityNegativeVolumeIndex)
|
|
2489
|
+
|
|
2490
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
2491
|
+
|
|
2492
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityNegativeVolumeIndex.md)
|
|
2493
|
+
|
|
2494
|
+
[//]: # (OPERATION:get_security_price_technicals_nvi_v2)
|
|
2495
|
+
|
|
2496
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/nvi)
|
|
2497
|
+
|
|
2498
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_nvi)
|
|
2499
|
+
|
|
2500
|
+
## **get_security_price_technicals_nvi**
|
|
2501
|
+
|
|
2502
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_nvi_v2)
|
|
2503
|
+
|
|
2504
|
+
[//]: # (START_OVERVIEW)
|
|
2505
|
+
|
|
1390
2506
|
> ApiResponseSecurityNegativeVolumeIndex get_security_price_technicals_nvi(identifier, opts)
|
|
1391
2507
|
|
|
1392
|
-
Negative Volume Index
|
|
2508
|
+
#### Negative Volume Index
|
|
2509
|
+
|
|
1393
2510
|
|
|
1394
2511
|
Returns the Negative Volume Index values of Stock Prices for the Security with the given `identifier`
|
|
1395
2512
|
|
|
2513
|
+
[//]: # (END_OVERVIEW)
|
|
2514
|
+
|
|
1396
2515
|
### Example
|
|
2516
|
+
|
|
2517
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
2518
|
+
|
|
1397
2519
|
```ruby
|
|
1398
2520
|
# Load the gem
|
|
1399
2521
|
require 'intrinio-sdk'
|
|
1400
2522
|
|
|
1401
2523
|
# Setup authorization
|
|
1402
2524
|
Intrinio.configure do |config|
|
|
1403
|
-
config.api_key['api_key'] = '
|
|
2525
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
1404
2526
|
end
|
|
1405
2527
|
|
|
1406
2528
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -1422,35 +2544,77 @@ rescue Intrinio::ApiError => e
|
|
|
1422
2544
|
end
|
|
1423
2545
|
```
|
|
1424
2546
|
|
|
2547
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
2548
|
+
|
|
2549
|
+
[//]: # (START_DEFINITION)
|
|
2550
|
+
|
|
1425
2551
|
### Parameters
|
|
1426
2552
|
|
|
2553
|
+
[//]: # (START_PARAMETERS)
|
|
2554
|
+
|
|
2555
|
+
|
|
1427
2556
|
Name | Type | Description | Notes
|
|
1428
2557
|
------------- | ------------- | ------------- | -------------
|
|
1429
|
-
**identifier** |
|
|
1430
|
-
**start_date** |
|
|
1431
|
-
**end_date** |
|
|
1432
|
-
**page_size** |
|
|
1433
|
-
**next_page** |
|
|
2558
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
2559
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
2560
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
2561
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
2562
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
2563
|
+
<br/>
|
|
2564
|
+
|
|
2565
|
+
[//]: # (END_PARAMETERS)
|
|
1434
2566
|
|
|
1435
2567
|
### Return type
|
|
1436
2568
|
|
|
1437
2569
|
[**ApiResponseSecurityNegativeVolumeIndex**](ApiResponseSecurityNegativeVolumeIndex.md)
|
|
1438
2570
|
|
|
1439
|
-
#
|
|
2571
|
+
[//]: # (END_OPERATION)
|
|
2572
|
+
|
|
2573
|
+
|
|
2574
|
+
[//]: # (START_OPERATION)
|
|
2575
|
+
|
|
2576
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
2577
|
+
|
|
2578
|
+
[//]: # (METHOD:get_security_price_technicals_obv)
|
|
2579
|
+
|
|
2580
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityOnBalanceVolume)
|
|
2581
|
+
|
|
2582
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
2583
|
+
|
|
2584
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityOnBalanceVolume.md)
|
|
2585
|
+
|
|
2586
|
+
[//]: # (OPERATION:get_security_price_technicals_obv_v2)
|
|
2587
|
+
|
|
2588
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/obv)
|
|
2589
|
+
|
|
2590
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_obv)
|
|
2591
|
+
|
|
2592
|
+
## **get_security_price_technicals_obv**
|
|
2593
|
+
|
|
2594
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_obv_v2)
|
|
2595
|
+
|
|
2596
|
+
[//]: # (START_OVERVIEW)
|
|
2597
|
+
|
|
1440
2598
|
> ApiResponseSecurityOnBalanceVolume get_security_price_technicals_obv(identifier, opts)
|
|
1441
2599
|
|
|
1442
|
-
On-balance Volume
|
|
2600
|
+
#### On-balance Volume
|
|
2601
|
+
|
|
1443
2602
|
|
|
1444
2603
|
Returns the On-balance Volume values of Stock Prices for the Security with the given `identifier`
|
|
1445
2604
|
|
|
2605
|
+
[//]: # (END_OVERVIEW)
|
|
2606
|
+
|
|
1446
2607
|
### Example
|
|
2608
|
+
|
|
2609
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
2610
|
+
|
|
1447
2611
|
```ruby
|
|
1448
2612
|
# Load the gem
|
|
1449
2613
|
require 'intrinio-sdk'
|
|
1450
2614
|
|
|
1451
2615
|
# Setup authorization
|
|
1452
2616
|
Intrinio.configure do |config|
|
|
1453
|
-
config.api_key['api_key'] = '
|
|
2617
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
1454
2618
|
end
|
|
1455
2619
|
|
|
1456
2620
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -1472,35 +2636,77 @@ rescue Intrinio::ApiError => e
|
|
|
1472
2636
|
end
|
|
1473
2637
|
```
|
|
1474
2638
|
|
|
2639
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
2640
|
+
|
|
2641
|
+
[//]: # (START_DEFINITION)
|
|
2642
|
+
|
|
1475
2643
|
### Parameters
|
|
1476
2644
|
|
|
2645
|
+
[//]: # (START_PARAMETERS)
|
|
2646
|
+
|
|
2647
|
+
|
|
1477
2648
|
Name | Type | Description | Notes
|
|
1478
2649
|
------------- | ------------- | ------------- | -------------
|
|
1479
|
-
**identifier** |
|
|
1480
|
-
**start_date** |
|
|
1481
|
-
**end_date** |
|
|
1482
|
-
**page_size** |
|
|
1483
|
-
**next_page** |
|
|
2650
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
2651
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
2652
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
2653
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
2654
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
2655
|
+
<br/>
|
|
2656
|
+
|
|
2657
|
+
[//]: # (END_PARAMETERS)
|
|
1484
2658
|
|
|
1485
2659
|
### Return type
|
|
1486
2660
|
|
|
1487
2661
|
[**ApiResponseSecurityOnBalanceVolume**](ApiResponseSecurityOnBalanceVolume.md)
|
|
1488
2662
|
|
|
1489
|
-
#
|
|
2663
|
+
[//]: # (END_OPERATION)
|
|
2664
|
+
|
|
2665
|
+
|
|
2666
|
+
[//]: # (START_OPERATION)
|
|
2667
|
+
|
|
2668
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
2669
|
+
|
|
2670
|
+
[//]: # (METHOD:get_security_price_technicals_obv_mean)
|
|
2671
|
+
|
|
2672
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityOnBalanceVolumeMean)
|
|
2673
|
+
|
|
2674
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
2675
|
+
|
|
2676
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityOnBalanceVolumeMean.md)
|
|
2677
|
+
|
|
2678
|
+
[//]: # (OPERATION:get_security_price_technicals_obv_mean_v2)
|
|
2679
|
+
|
|
2680
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/obv_mean)
|
|
2681
|
+
|
|
2682
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_obv_mean)
|
|
2683
|
+
|
|
2684
|
+
## **get_security_price_technicals_obv_mean**
|
|
2685
|
+
|
|
2686
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_obv_mean_v2)
|
|
2687
|
+
|
|
2688
|
+
[//]: # (START_OVERVIEW)
|
|
2689
|
+
|
|
1490
2690
|
> ApiResponseSecurityOnBalanceVolumeMean get_security_price_technicals_obv_mean(identifier, opts)
|
|
1491
2691
|
|
|
1492
|
-
On-balance Volume Mean
|
|
2692
|
+
#### On-balance Volume Mean
|
|
2693
|
+
|
|
1493
2694
|
|
|
1494
2695
|
Returns the On-balance Volume Mean values of Stock Prices for the Security with the given `identifier`
|
|
1495
2696
|
|
|
2697
|
+
[//]: # (END_OVERVIEW)
|
|
2698
|
+
|
|
1496
2699
|
### Example
|
|
2700
|
+
|
|
2701
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
2702
|
+
|
|
1497
2703
|
```ruby
|
|
1498
2704
|
# Load the gem
|
|
1499
2705
|
require 'intrinio-sdk'
|
|
1500
2706
|
|
|
1501
2707
|
# Setup authorization
|
|
1502
2708
|
Intrinio.configure do |config|
|
|
1503
|
-
config.api_key['api_key'] = '
|
|
2709
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
1504
2710
|
end
|
|
1505
2711
|
|
|
1506
2712
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -1523,36 +2729,78 @@ rescue Intrinio::ApiError => e
|
|
|
1523
2729
|
end
|
|
1524
2730
|
```
|
|
1525
2731
|
|
|
2732
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
2733
|
+
|
|
2734
|
+
[//]: # (START_DEFINITION)
|
|
2735
|
+
|
|
1526
2736
|
### Parameters
|
|
1527
2737
|
|
|
2738
|
+
[//]: # (START_PARAMETERS)
|
|
2739
|
+
|
|
2740
|
+
|
|
1528
2741
|
Name | Type | Description | Notes
|
|
1529
2742
|
------------- | ------------- | ------------- | -------------
|
|
1530
|
-
**identifier** |
|
|
1531
|
-
**period** |
|
|
1532
|
-
**start_date** |
|
|
1533
|
-
**end_date** |
|
|
1534
|
-
**page_size** |
|
|
1535
|
-
**next_page** |
|
|
2743
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
2744
|
+
**period** | Integer| The number of observations, per period, to calculate On-balance Volume Mean | [optional] [default to 10]
|
|
2745
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
2746
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
2747
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
2748
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
2749
|
+
<br/>
|
|
2750
|
+
|
|
2751
|
+
[//]: # (END_PARAMETERS)
|
|
1536
2752
|
|
|
1537
2753
|
### Return type
|
|
1538
2754
|
|
|
1539
2755
|
[**ApiResponseSecurityOnBalanceVolumeMean**](ApiResponseSecurityOnBalanceVolumeMean.md)
|
|
1540
2756
|
|
|
1541
|
-
#
|
|
2757
|
+
[//]: # (END_OPERATION)
|
|
2758
|
+
|
|
2759
|
+
|
|
2760
|
+
[//]: # (START_OPERATION)
|
|
2761
|
+
|
|
2762
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
2763
|
+
|
|
2764
|
+
[//]: # (METHOD:get_security_price_technicals_rsi)
|
|
2765
|
+
|
|
2766
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityRelativeStrengthIndex)
|
|
2767
|
+
|
|
2768
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
2769
|
+
|
|
2770
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityRelativeStrengthIndex.md)
|
|
2771
|
+
|
|
2772
|
+
[//]: # (OPERATION:get_security_price_technicals_rsi_v2)
|
|
2773
|
+
|
|
2774
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/rsi)
|
|
2775
|
+
|
|
2776
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_rsi)
|
|
2777
|
+
|
|
2778
|
+
## **get_security_price_technicals_rsi**
|
|
2779
|
+
|
|
2780
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_rsi_v2)
|
|
2781
|
+
|
|
2782
|
+
[//]: # (START_OVERVIEW)
|
|
2783
|
+
|
|
1542
2784
|
> ApiResponseSecurityRelativeStrengthIndex get_security_price_technicals_rsi(identifier, opts)
|
|
1543
2785
|
|
|
1544
|
-
Relative Strength Index
|
|
2786
|
+
#### Relative Strength Index
|
|
2787
|
+
|
|
1545
2788
|
|
|
1546
2789
|
Returns the Relative Strength Index values of Stock Prices for the Security with the given `identifier`
|
|
1547
2790
|
|
|
2791
|
+
[//]: # (END_OVERVIEW)
|
|
2792
|
+
|
|
1548
2793
|
### Example
|
|
2794
|
+
|
|
2795
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
2796
|
+
|
|
1549
2797
|
```ruby
|
|
1550
2798
|
# Load the gem
|
|
1551
2799
|
require 'intrinio-sdk'
|
|
1552
2800
|
|
|
1553
2801
|
# Setup authorization
|
|
1554
2802
|
Intrinio.configure do |config|
|
|
1555
|
-
config.api_key['api_key'] = '
|
|
2803
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
1556
2804
|
end
|
|
1557
2805
|
|
|
1558
2806
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -1576,37 +2824,79 @@ rescue Intrinio::ApiError => e
|
|
|
1576
2824
|
end
|
|
1577
2825
|
```
|
|
1578
2826
|
|
|
2827
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
2828
|
+
|
|
2829
|
+
[//]: # (START_DEFINITION)
|
|
2830
|
+
|
|
1579
2831
|
### Parameters
|
|
1580
2832
|
|
|
2833
|
+
[//]: # (START_PARAMETERS)
|
|
2834
|
+
|
|
2835
|
+
|
|
1581
2836
|
Name | Type | Description | Notes
|
|
1582
2837
|
------------- | ------------- | ------------- | -------------
|
|
1583
|
-
**identifier** |
|
|
1584
|
-
**period** |
|
|
1585
|
-
**price_key** |
|
|
1586
|
-
**start_date** |
|
|
1587
|
-
**end_date** |
|
|
1588
|
-
**page_size** |
|
|
1589
|
-
**next_page** |
|
|
2838
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
2839
|
+
**period** | Integer| The number of observations, per period, to calculate Relative Strength Index | [optional] [default to 14]
|
|
2840
|
+
**price_key** | String| The Stock Price field to use when calculating Relative Strength Index | [optional] [default to close]
|
|
2841
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
2842
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
2843
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
2844
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
2845
|
+
<br/>
|
|
2846
|
+
|
|
2847
|
+
[//]: # (END_PARAMETERS)
|
|
1590
2848
|
|
|
1591
2849
|
### Return type
|
|
1592
2850
|
|
|
1593
2851
|
[**ApiResponseSecurityRelativeStrengthIndex**](ApiResponseSecurityRelativeStrengthIndex.md)
|
|
1594
2852
|
|
|
1595
|
-
#
|
|
2853
|
+
[//]: # (END_OPERATION)
|
|
2854
|
+
|
|
2855
|
+
|
|
2856
|
+
[//]: # (START_OPERATION)
|
|
2857
|
+
|
|
2858
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
2859
|
+
|
|
2860
|
+
[//]: # (METHOD:get_security_price_technicals_sma)
|
|
2861
|
+
|
|
2862
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecuritySimpleMovingAverage)
|
|
2863
|
+
|
|
2864
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
2865
|
+
|
|
2866
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecuritySimpleMovingAverage.md)
|
|
2867
|
+
|
|
2868
|
+
[//]: # (OPERATION:get_security_price_technicals_sma_v2)
|
|
2869
|
+
|
|
2870
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/sma)
|
|
2871
|
+
|
|
2872
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_sma)
|
|
2873
|
+
|
|
2874
|
+
## **get_security_price_technicals_sma**
|
|
2875
|
+
|
|
2876
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_sma_v2)
|
|
2877
|
+
|
|
2878
|
+
[//]: # (START_OVERVIEW)
|
|
2879
|
+
|
|
1596
2880
|
> ApiResponseSecuritySimpleMovingAverage get_security_price_technicals_sma(identifier, opts)
|
|
1597
2881
|
|
|
1598
|
-
Simple Moving Average
|
|
2882
|
+
#### Simple Moving Average
|
|
2883
|
+
|
|
1599
2884
|
|
|
1600
2885
|
Returns the Simple Moving Average values of Stock Prices for the Security with the given `identifier`
|
|
1601
2886
|
|
|
2887
|
+
[//]: # (END_OVERVIEW)
|
|
2888
|
+
|
|
1602
2889
|
### Example
|
|
2890
|
+
|
|
2891
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
2892
|
+
|
|
1603
2893
|
```ruby
|
|
1604
2894
|
# Load the gem
|
|
1605
2895
|
require 'intrinio-sdk'
|
|
1606
2896
|
|
|
1607
2897
|
# Setup authorization
|
|
1608
2898
|
Intrinio.configure do |config|
|
|
1609
|
-
config.api_key['api_key'] = '
|
|
2899
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
1610
2900
|
end
|
|
1611
2901
|
|
|
1612
2902
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -1630,37 +2920,79 @@ rescue Intrinio::ApiError => e
|
|
|
1630
2920
|
end
|
|
1631
2921
|
```
|
|
1632
2922
|
|
|
2923
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
2924
|
+
|
|
2925
|
+
[//]: # (START_DEFINITION)
|
|
2926
|
+
|
|
1633
2927
|
### Parameters
|
|
1634
2928
|
|
|
2929
|
+
[//]: # (START_PARAMETERS)
|
|
2930
|
+
|
|
2931
|
+
|
|
1635
2932
|
Name | Type | Description | Notes
|
|
1636
2933
|
------------- | ------------- | ------------- | -------------
|
|
1637
|
-
**identifier** |
|
|
1638
|
-
**period** |
|
|
1639
|
-
**price_key** |
|
|
1640
|
-
**start_date** |
|
|
1641
|
-
**end_date** |
|
|
1642
|
-
**page_size** |
|
|
1643
|
-
**next_page** |
|
|
2934
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
2935
|
+
**period** | Integer| The number of observations, per period, to calculate Simple Moving Average | [optional] [default to 20]
|
|
2936
|
+
**price_key** | String| The Stock Price field to use when calculating Simple Moving Average | [optional] [default to close]
|
|
2937
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
2938
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
2939
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
2940
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
2941
|
+
<br/>
|
|
2942
|
+
|
|
2943
|
+
[//]: # (END_PARAMETERS)
|
|
1644
2944
|
|
|
1645
2945
|
### Return type
|
|
1646
2946
|
|
|
1647
2947
|
[**ApiResponseSecuritySimpleMovingAverage**](ApiResponseSecuritySimpleMovingAverage.md)
|
|
1648
2948
|
|
|
1649
|
-
#
|
|
2949
|
+
[//]: # (END_OPERATION)
|
|
2950
|
+
|
|
2951
|
+
|
|
2952
|
+
[//]: # (START_OPERATION)
|
|
2953
|
+
|
|
2954
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
2955
|
+
|
|
2956
|
+
[//]: # (METHOD:get_security_price_technicals_sr)
|
|
2957
|
+
|
|
2958
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityStochasticOscillator)
|
|
2959
|
+
|
|
2960
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
2961
|
+
|
|
2962
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityStochasticOscillator.md)
|
|
2963
|
+
|
|
2964
|
+
[//]: # (OPERATION:get_security_price_technicals_sr_v2)
|
|
2965
|
+
|
|
2966
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/sr)
|
|
2967
|
+
|
|
2968
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_sr)
|
|
2969
|
+
|
|
2970
|
+
## **get_security_price_technicals_sr**
|
|
2971
|
+
|
|
2972
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_sr_v2)
|
|
2973
|
+
|
|
2974
|
+
[//]: # (START_OVERVIEW)
|
|
2975
|
+
|
|
1650
2976
|
> ApiResponseSecurityStochasticOscillator get_security_price_technicals_sr(identifier, opts)
|
|
1651
2977
|
|
|
1652
|
-
Stochastic Oscillator
|
|
2978
|
+
#### Stochastic Oscillator
|
|
2979
|
+
|
|
1653
2980
|
|
|
1654
2981
|
Returns the Stochastic Oscillator values of Stock Prices for the Security with the given `identifier`
|
|
1655
2982
|
|
|
2983
|
+
[//]: # (END_OVERVIEW)
|
|
2984
|
+
|
|
1656
2985
|
### Example
|
|
2986
|
+
|
|
2987
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
2988
|
+
|
|
1657
2989
|
```ruby
|
|
1658
2990
|
# Load the gem
|
|
1659
2991
|
require 'intrinio-sdk'
|
|
1660
2992
|
|
|
1661
2993
|
# Setup authorization
|
|
1662
2994
|
Intrinio.configure do |config|
|
|
1663
|
-
config.api_key['api_key'] = '
|
|
2995
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
1664
2996
|
end
|
|
1665
2997
|
|
|
1666
2998
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -1684,37 +3016,79 @@ rescue Intrinio::ApiError => e
|
|
|
1684
3016
|
end
|
|
1685
3017
|
```
|
|
1686
3018
|
|
|
3019
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
3020
|
+
|
|
3021
|
+
[//]: # (START_DEFINITION)
|
|
3022
|
+
|
|
1687
3023
|
### Parameters
|
|
1688
3024
|
|
|
3025
|
+
[//]: # (START_PARAMETERS)
|
|
3026
|
+
|
|
3027
|
+
|
|
1689
3028
|
Name | Type | Description | Notes
|
|
1690
3029
|
------------- | ------------- | ------------- | -------------
|
|
1691
|
-
**identifier** |
|
|
1692
|
-
**period** |
|
|
1693
|
-
**signal_period** |
|
|
1694
|
-
**start_date** |
|
|
1695
|
-
**end_date** |
|
|
1696
|
-
**page_size** |
|
|
1697
|
-
**next_page** |
|
|
3030
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
3031
|
+
**period** | Integer| The number of observations, per period, to calculate %K of Stochastic Oscillator | [optional] [default to 14]
|
|
3032
|
+
**signal_period** | Integer| The number of observations, per period, to calculate the %D (the Simple Moving Average of %K) as a signal line for Stochastic Oscillator | [optional] [default to 3]
|
|
3033
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
3034
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
3035
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
3036
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
3037
|
+
<br/>
|
|
3038
|
+
|
|
3039
|
+
[//]: # (END_PARAMETERS)
|
|
1698
3040
|
|
|
1699
3041
|
### Return type
|
|
1700
3042
|
|
|
1701
3043
|
[**ApiResponseSecurityStochasticOscillator**](ApiResponseSecurityStochasticOscillator.md)
|
|
1702
3044
|
|
|
1703
|
-
#
|
|
3045
|
+
[//]: # (END_OPERATION)
|
|
3046
|
+
|
|
3047
|
+
|
|
3048
|
+
[//]: # (START_OPERATION)
|
|
3049
|
+
|
|
3050
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
3051
|
+
|
|
3052
|
+
[//]: # (METHOD:get_security_price_technicals_trix)
|
|
3053
|
+
|
|
3054
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityTripleExponentialAverage)
|
|
3055
|
+
|
|
3056
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
3057
|
+
|
|
3058
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityTripleExponentialAverage.md)
|
|
3059
|
+
|
|
3060
|
+
[//]: # (OPERATION:get_security_price_technicals_trix_v2)
|
|
3061
|
+
|
|
3062
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/trix)
|
|
3063
|
+
|
|
3064
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_trix)
|
|
3065
|
+
|
|
3066
|
+
## **get_security_price_technicals_trix**
|
|
3067
|
+
|
|
3068
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_trix_v2)
|
|
3069
|
+
|
|
3070
|
+
[//]: # (START_OVERVIEW)
|
|
3071
|
+
|
|
1704
3072
|
> ApiResponseSecurityTripleExponentialAverage get_security_price_technicals_trix(identifier, opts)
|
|
1705
3073
|
|
|
1706
|
-
Triple Exponential Average
|
|
3074
|
+
#### Triple Exponential Average
|
|
3075
|
+
|
|
1707
3076
|
|
|
1708
3077
|
Returns the Simple Moving Average values of Stock Prices for the Security with the given `identifier`
|
|
1709
3078
|
|
|
3079
|
+
[//]: # (END_OVERVIEW)
|
|
3080
|
+
|
|
1710
3081
|
### Example
|
|
3082
|
+
|
|
3083
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
3084
|
+
|
|
1711
3085
|
```ruby
|
|
1712
3086
|
# Load the gem
|
|
1713
3087
|
require 'intrinio-sdk'
|
|
1714
3088
|
|
|
1715
3089
|
# Setup authorization
|
|
1716
3090
|
Intrinio.configure do |config|
|
|
1717
|
-
config.api_key['api_key'] = '
|
|
3091
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
1718
3092
|
end
|
|
1719
3093
|
|
|
1720
3094
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -1737,36 +3111,78 @@ rescue Intrinio::ApiError => e
|
|
|
1737
3111
|
end
|
|
1738
3112
|
```
|
|
1739
3113
|
|
|
3114
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
3115
|
+
|
|
3116
|
+
[//]: # (START_DEFINITION)
|
|
3117
|
+
|
|
1740
3118
|
### Parameters
|
|
1741
3119
|
|
|
3120
|
+
[//]: # (START_PARAMETERS)
|
|
3121
|
+
|
|
3122
|
+
|
|
1742
3123
|
Name | Type | Description | Notes
|
|
1743
3124
|
------------- | ------------- | ------------- | -------------
|
|
1744
|
-
**identifier** |
|
|
1745
|
-
**period** |
|
|
1746
|
-
**start_date** |
|
|
1747
|
-
**end_date** |
|
|
1748
|
-
**page_size** |
|
|
1749
|
-
**next_page** |
|
|
3125
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
3126
|
+
**period** | Integer| The number of observations, per period, to calculate Exponential Moving Average for Triple Exponential Average | [optional] [default to 15]
|
|
3127
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
3128
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
3129
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
3130
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
3131
|
+
<br/>
|
|
3132
|
+
|
|
3133
|
+
[//]: # (END_PARAMETERS)
|
|
1750
3134
|
|
|
1751
3135
|
### Return type
|
|
1752
3136
|
|
|
1753
3137
|
[**ApiResponseSecurityTripleExponentialAverage**](ApiResponseSecurityTripleExponentialAverage.md)
|
|
1754
3138
|
|
|
1755
|
-
#
|
|
3139
|
+
[//]: # (END_OPERATION)
|
|
3140
|
+
|
|
3141
|
+
|
|
3142
|
+
[//]: # (START_OPERATION)
|
|
3143
|
+
|
|
3144
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
3145
|
+
|
|
3146
|
+
[//]: # (METHOD:get_security_price_technicals_tsi)
|
|
3147
|
+
|
|
3148
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityTrueStrengthIndex)
|
|
3149
|
+
|
|
3150
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
3151
|
+
|
|
3152
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityTrueStrengthIndex.md)
|
|
3153
|
+
|
|
3154
|
+
[//]: # (OPERATION:get_security_price_technicals_tsi_v2)
|
|
3155
|
+
|
|
3156
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/tsi)
|
|
3157
|
+
|
|
3158
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_tsi)
|
|
3159
|
+
|
|
3160
|
+
## **get_security_price_technicals_tsi**
|
|
3161
|
+
|
|
3162
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_tsi_v2)
|
|
3163
|
+
|
|
3164
|
+
[//]: # (START_OVERVIEW)
|
|
3165
|
+
|
|
1756
3166
|
> ApiResponseSecurityTrueStrengthIndex get_security_price_technicals_tsi(identifier, opts)
|
|
1757
3167
|
|
|
1758
|
-
True Strength Index
|
|
3168
|
+
#### True Strength Index
|
|
3169
|
+
|
|
1759
3170
|
|
|
1760
3171
|
Returns the True Strength Index values of Stock Prices for the Security with the given `identifier`
|
|
1761
3172
|
|
|
3173
|
+
[//]: # (END_OVERVIEW)
|
|
3174
|
+
|
|
1762
3175
|
### Example
|
|
3176
|
+
|
|
3177
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
3178
|
+
|
|
1763
3179
|
```ruby
|
|
1764
3180
|
# Load the gem
|
|
1765
3181
|
require 'intrinio-sdk'
|
|
1766
3182
|
|
|
1767
3183
|
# Setup authorization
|
|
1768
3184
|
Intrinio.configure do |config|
|
|
1769
|
-
config.api_key['api_key'] = '
|
|
3185
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
1770
3186
|
end
|
|
1771
3187
|
|
|
1772
3188
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -1791,38 +3207,80 @@ rescue Intrinio::ApiError => e
|
|
|
1791
3207
|
end
|
|
1792
3208
|
```
|
|
1793
3209
|
|
|
3210
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
3211
|
+
|
|
3212
|
+
[//]: # (START_DEFINITION)
|
|
3213
|
+
|
|
1794
3214
|
### Parameters
|
|
1795
3215
|
|
|
3216
|
+
[//]: # (START_PARAMETERS)
|
|
3217
|
+
|
|
3218
|
+
|
|
1796
3219
|
Name | Type | Description | Notes
|
|
1797
3220
|
------------- | ------------- | ------------- | -------------
|
|
1798
|
-
**identifier** |
|
|
1799
|
-
**low_period** |
|
|
1800
|
-
**high_period** |
|
|
1801
|
-
**price_key** |
|
|
1802
|
-
**start_date** |
|
|
1803
|
-
**end_date** |
|
|
1804
|
-
**page_size** |
|
|
1805
|
-
**next_page** |
|
|
3221
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
3222
|
+
**low_period** | Integer| The number of observations, per period, to calculate low period Exponential Moving Average for smoothing in True Strength Index | [optional] [default to 13]
|
|
3223
|
+
**high_period** | Integer| The number of observations, per period, to calculate high period Exponential Moving Average for smoothing in True Strength Index | [optional] [default to 25]
|
|
3224
|
+
**price_key** | String| The Stock Price field to use when calculating True Strength Index | [optional] [default to close]
|
|
3225
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
3226
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
3227
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
3228
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
3229
|
+
<br/>
|
|
3230
|
+
|
|
3231
|
+
[//]: # (END_PARAMETERS)
|
|
1806
3232
|
|
|
1807
3233
|
### Return type
|
|
1808
3234
|
|
|
1809
3235
|
[**ApiResponseSecurityTrueStrengthIndex**](ApiResponseSecurityTrueStrengthIndex.md)
|
|
1810
3236
|
|
|
1811
|
-
#
|
|
3237
|
+
[//]: # (END_OPERATION)
|
|
3238
|
+
|
|
3239
|
+
|
|
3240
|
+
[//]: # (START_OPERATION)
|
|
3241
|
+
|
|
3242
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
3243
|
+
|
|
3244
|
+
[//]: # (METHOD:get_security_price_technicals_uo)
|
|
3245
|
+
|
|
3246
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityUltimateOscillator)
|
|
3247
|
+
|
|
3248
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
3249
|
+
|
|
3250
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityUltimateOscillator.md)
|
|
3251
|
+
|
|
3252
|
+
[//]: # (OPERATION:get_security_price_technicals_uo_v2)
|
|
3253
|
+
|
|
3254
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/uo)
|
|
3255
|
+
|
|
3256
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_uo)
|
|
3257
|
+
|
|
3258
|
+
## **get_security_price_technicals_uo**
|
|
3259
|
+
|
|
3260
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_uo_v2)
|
|
3261
|
+
|
|
3262
|
+
[//]: # (START_OVERVIEW)
|
|
3263
|
+
|
|
1812
3264
|
> ApiResponseSecurityUltimateOscillator get_security_price_technicals_uo(identifier, opts)
|
|
1813
3265
|
|
|
1814
|
-
Ultimate Oscillator
|
|
3266
|
+
#### Ultimate Oscillator
|
|
3267
|
+
|
|
1815
3268
|
|
|
1816
3269
|
Returns the Ultimate Oscillator values of Stock Prices for the Security with the given `identifier`
|
|
1817
3270
|
|
|
3271
|
+
[//]: # (END_OVERVIEW)
|
|
3272
|
+
|
|
1818
3273
|
### Example
|
|
3274
|
+
|
|
3275
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
3276
|
+
|
|
1819
3277
|
```ruby
|
|
1820
3278
|
# Load the gem
|
|
1821
3279
|
require 'intrinio-sdk'
|
|
1822
3280
|
|
|
1823
3281
|
# Setup authorization
|
|
1824
3282
|
Intrinio.configure do |config|
|
|
1825
|
-
config.api_key['api_key'] = '
|
|
3283
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
1826
3284
|
end
|
|
1827
3285
|
|
|
1828
3286
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -1850,41 +3308,83 @@ rescue Intrinio::ApiError => e
|
|
|
1850
3308
|
end
|
|
1851
3309
|
```
|
|
1852
3310
|
|
|
3311
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
3312
|
+
|
|
3313
|
+
[//]: # (START_DEFINITION)
|
|
3314
|
+
|
|
1853
3315
|
### Parameters
|
|
1854
3316
|
|
|
3317
|
+
[//]: # (START_PARAMETERS)
|
|
3318
|
+
|
|
3319
|
+
|
|
1855
3320
|
Name | Type | Description | Notes
|
|
1856
3321
|
------------- | ------------- | ------------- | -------------
|
|
1857
|
-
**identifier** |
|
|
1858
|
-
**short_period** |
|
|
1859
|
-
**medium_period** |
|
|
1860
|
-
**long_period** |
|
|
1861
|
-
**short_weight** |
|
|
1862
|
-
**medium_weight** |
|
|
1863
|
-
**long_weight** |
|
|
1864
|
-
**start_date** |
|
|
1865
|
-
**end_date** |
|
|
1866
|
-
**page_size** |
|
|
1867
|
-
**next_page** |
|
|
3322
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
3323
|
+
**short_period** | Integer| The number of observations, per period, to calculate the short period for Ultimate Oscillator | [optional] [default to 7]
|
|
3324
|
+
**medium_period** | Integer| The number of observations, per period, to calculate the medium period for Ultimate Oscillator | [optional] [default to 14]
|
|
3325
|
+
**long_period** | Integer| The number of observations, per period, to calculate the long period for Ultimate Oscillator | [optional] [default to 28]
|
|
3326
|
+
**short_weight** | Float| The weight of short Buying Pressure average for Ultimate Oscillator | [optional] [default to 4.0]
|
|
3327
|
+
**medium_weight** | Float| The weight of medium Buying Pressure average for Ultimate Oscillator | [optional] [default to 2.0]
|
|
3328
|
+
**long_weight** | Float| The weight of long Buying Pressure average for Ultimate Oscillator | [optional] [default to 1.0]
|
|
3329
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
3330
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
3331
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
3332
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
3333
|
+
<br/>
|
|
3334
|
+
|
|
3335
|
+
[//]: # (END_PARAMETERS)
|
|
1868
3336
|
|
|
1869
3337
|
### Return type
|
|
1870
3338
|
|
|
1871
3339
|
[**ApiResponseSecurityUltimateOscillator**](ApiResponseSecurityUltimateOscillator.md)
|
|
1872
3340
|
|
|
1873
|
-
#
|
|
3341
|
+
[//]: # (END_OPERATION)
|
|
3342
|
+
|
|
3343
|
+
|
|
3344
|
+
[//]: # (START_OPERATION)
|
|
3345
|
+
|
|
3346
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
3347
|
+
|
|
3348
|
+
[//]: # (METHOD:get_security_price_technicals_vi)
|
|
3349
|
+
|
|
3350
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityVortexIndicator)
|
|
3351
|
+
|
|
3352
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
3353
|
+
|
|
3354
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityVortexIndicator.md)
|
|
3355
|
+
|
|
3356
|
+
[//]: # (OPERATION:get_security_price_technicals_vi_v2)
|
|
3357
|
+
|
|
3358
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/vi)
|
|
3359
|
+
|
|
3360
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_vi)
|
|
3361
|
+
|
|
3362
|
+
## **get_security_price_technicals_vi**
|
|
3363
|
+
|
|
3364
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_vi_v2)
|
|
3365
|
+
|
|
3366
|
+
[//]: # (START_OVERVIEW)
|
|
3367
|
+
|
|
1874
3368
|
> ApiResponseSecurityVortexIndicator get_security_price_technicals_vi(identifier, opts)
|
|
1875
3369
|
|
|
1876
|
-
Vortex Indicator
|
|
3370
|
+
#### Vortex Indicator
|
|
3371
|
+
|
|
1877
3372
|
|
|
1878
3373
|
Returns the Vortex Indicator values of Stock Prices for the Security with the given `identifier`
|
|
1879
3374
|
|
|
3375
|
+
[//]: # (END_OVERVIEW)
|
|
3376
|
+
|
|
1880
3377
|
### Example
|
|
3378
|
+
|
|
3379
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
3380
|
+
|
|
1881
3381
|
```ruby
|
|
1882
3382
|
# Load the gem
|
|
1883
3383
|
require 'intrinio-sdk'
|
|
1884
3384
|
|
|
1885
3385
|
# Setup authorization
|
|
1886
3386
|
Intrinio.configure do |config|
|
|
1887
|
-
config.api_key['api_key'] = '
|
|
3387
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
1888
3388
|
end
|
|
1889
3389
|
|
|
1890
3390
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -1907,36 +3407,78 @@ rescue Intrinio::ApiError => e
|
|
|
1907
3407
|
end
|
|
1908
3408
|
```
|
|
1909
3409
|
|
|
3410
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
3411
|
+
|
|
3412
|
+
[//]: # (START_DEFINITION)
|
|
3413
|
+
|
|
1910
3414
|
### Parameters
|
|
1911
3415
|
|
|
3416
|
+
[//]: # (START_PARAMETERS)
|
|
3417
|
+
|
|
3418
|
+
|
|
1912
3419
|
Name | Type | Description | Notes
|
|
1913
3420
|
------------- | ------------- | ------------- | -------------
|
|
1914
|
-
**identifier** |
|
|
1915
|
-
**period** |
|
|
1916
|
-
**start_date** |
|
|
1917
|
-
**end_date** |
|
|
1918
|
-
**page_size** |
|
|
1919
|
-
**next_page** |
|
|
3421
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
3422
|
+
**period** | Integer| The number of observations, per period, to calculate Vortex Indicator | [optional] [default to 14]
|
|
3423
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
3424
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
3425
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
3426
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
3427
|
+
<br/>
|
|
3428
|
+
|
|
3429
|
+
[//]: # (END_PARAMETERS)
|
|
1920
3430
|
|
|
1921
3431
|
### Return type
|
|
1922
3432
|
|
|
1923
3433
|
[**ApiResponseSecurityVortexIndicator**](ApiResponseSecurityVortexIndicator.md)
|
|
1924
3434
|
|
|
1925
|
-
#
|
|
3435
|
+
[//]: # (END_OPERATION)
|
|
3436
|
+
|
|
3437
|
+
|
|
3438
|
+
[//]: # (START_OPERATION)
|
|
3439
|
+
|
|
3440
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
3441
|
+
|
|
3442
|
+
[//]: # (METHOD:get_security_price_technicals_vpt)
|
|
3443
|
+
|
|
3444
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityVolumePriceTrend)
|
|
3445
|
+
|
|
3446
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
3447
|
+
|
|
3448
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityVolumePriceTrend.md)
|
|
3449
|
+
|
|
3450
|
+
[//]: # (OPERATION:get_security_price_technicals_vpt_v2)
|
|
3451
|
+
|
|
3452
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/vpt)
|
|
3453
|
+
|
|
3454
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_vpt)
|
|
3455
|
+
|
|
3456
|
+
## **get_security_price_technicals_vpt**
|
|
3457
|
+
|
|
3458
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_vpt_v2)
|
|
3459
|
+
|
|
3460
|
+
[//]: # (START_OVERVIEW)
|
|
3461
|
+
|
|
1926
3462
|
> ApiResponseSecurityVolumePriceTrend get_security_price_technicals_vpt(identifier, opts)
|
|
1927
3463
|
|
|
1928
|
-
Volume-price Trend
|
|
3464
|
+
#### Volume-price Trend
|
|
3465
|
+
|
|
1929
3466
|
|
|
1930
3467
|
Returns the Volume-price Trend values of Stock Prices for the Security with the given `identifier`
|
|
1931
3468
|
|
|
3469
|
+
[//]: # (END_OVERVIEW)
|
|
3470
|
+
|
|
1932
3471
|
### Example
|
|
3472
|
+
|
|
3473
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
3474
|
+
|
|
1933
3475
|
```ruby
|
|
1934
3476
|
# Load the gem
|
|
1935
3477
|
require 'intrinio-sdk'
|
|
1936
3478
|
|
|
1937
3479
|
# Setup authorization
|
|
1938
3480
|
Intrinio.configure do |config|
|
|
1939
|
-
config.api_key['api_key'] = '
|
|
3481
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
1940
3482
|
end
|
|
1941
3483
|
|
|
1942
3484
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -1958,35 +3500,77 @@ rescue Intrinio::ApiError => e
|
|
|
1958
3500
|
end
|
|
1959
3501
|
```
|
|
1960
3502
|
|
|
3503
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
3504
|
+
|
|
3505
|
+
[//]: # (START_DEFINITION)
|
|
3506
|
+
|
|
1961
3507
|
### Parameters
|
|
1962
3508
|
|
|
3509
|
+
[//]: # (START_PARAMETERS)
|
|
3510
|
+
|
|
3511
|
+
|
|
1963
3512
|
Name | Type | Description | Notes
|
|
1964
3513
|
------------- | ------------- | ------------- | -------------
|
|
1965
|
-
**identifier** |
|
|
1966
|
-
**start_date** |
|
|
1967
|
-
**end_date** |
|
|
1968
|
-
**page_size** |
|
|
1969
|
-
**next_page** |
|
|
3514
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
3515
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
3516
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
3517
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
3518
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
3519
|
+
<br/>
|
|
3520
|
+
|
|
3521
|
+
[//]: # (END_PARAMETERS)
|
|
1970
3522
|
|
|
1971
3523
|
### Return type
|
|
1972
3524
|
|
|
1973
3525
|
[**ApiResponseSecurityVolumePriceTrend**](ApiResponseSecurityVolumePriceTrend.md)
|
|
1974
3526
|
|
|
1975
|
-
#
|
|
3527
|
+
[//]: # (END_OPERATION)
|
|
3528
|
+
|
|
3529
|
+
|
|
3530
|
+
[//]: # (START_OPERATION)
|
|
3531
|
+
|
|
3532
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
3533
|
+
|
|
3534
|
+
[//]: # (METHOD:get_security_price_technicals_vwap)
|
|
3535
|
+
|
|
3536
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityVolumeWeightedAveragePrice)
|
|
3537
|
+
|
|
3538
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
3539
|
+
|
|
3540
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityVolumeWeightedAveragePrice.md)
|
|
3541
|
+
|
|
3542
|
+
[//]: # (OPERATION:get_security_price_technicals_vwap_v2)
|
|
3543
|
+
|
|
3544
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/vwap)
|
|
3545
|
+
|
|
3546
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_vwap)
|
|
3547
|
+
|
|
3548
|
+
## **get_security_price_technicals_vwap**
|
|
3549
|
+
|
|
3550
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_vwap_v2)
|
|
3551
|
+
|
|
3552
|
+
[//]: # (START_OVERVIEW)
|
|
3553
|
+
|
|
1976
3554
|
> ApiResponseSecurityVolumeWeightedAveragePrice get_security_price_technicals_vwap(identifier, opts)
|
|
1977
3555
|
|
|
1978
|
-
Volume Weighted Average Price
|
|
3556
|
+
#### Volume Weighted Average Price
|
|
3557
|
+
|
|
1979
3558
|
|
|
1980
3559
|
Returns the Volume Weighted Average Price values of Stock Prices for the Security with the given `identifier`
|
|
1981
3560
|
|
|
3561
|
+
[//]: # (END_OVERVIEW)
|
|
3562
|
+
|
|
1982
3563
|
### Example
|
|
3564
|
+
|
|
3565
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
3566
|
+
|
|
1983
3567
|
```ruby
|
|
1984
3568
|
# Load the gem
|
|
1985
3569
|
require 'intrinio-sdk'
|
|
1986
3570
|
|
|
1987
3571
|
# Setup authorization
|
|
1988
3572
|
Intrinio.configure do |config|
|
|
1989
|
-
config.api_key['api_key'] = '
|
|
3573
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
1990
3574
|
end
|
|
1991
3575
|
|
|
1992
3576
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -2008,35 +3592,77 @@ rescue Intrinio::ApiError => e
|
|
|
2008
3592
|
end
|
|
2009
3593
|
```
|
|
2010
3594
|
|
|
3595
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
3596
|
+
|
|
3597
|
+
[//]: # (START_DEFINITION)
|
|
3598
|
+
|
|
2011
3599
|
### Parameters
|
|
2012
3600
|
|
|
3601
|
+
[//]: # (START_PARAMETERS)
|
|
3602
|
+
|
|
3603
|
+
|
|
2013
3604
|
Name | Type | Description | Notes
|
|
2014
3605
|
------------- | ------------- | ------------- | -------------
|
|
2015
|
-
**identifier** |
|
|
2016
|
-
**start_date** |
|
|
2017
|
-
**end_date** |
|
|
2018
|
-
**page_size** |
|
|
2019
|
-
**next_page** |
|
|
3606
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
3607
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
3608
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
3609
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
3610
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
3611
|
+
<br/>
|
|
3612
|
+
|
|
3613
|
+
[//]: # (END_PARAMETERS)
|
|
2020
3614
|
|
|
2021
3615
|
### Return type
|
|
2022
3616
|
|
|
2023
3617
|
[**ApiResponseSecurityVolumeWeightedAveragePrice**](ApiResponseSecurityVolumeWeightedAveragePrice.md)
|
|
2024
3618
|
|
|
2025
|
-
#
|
|
3619
|
+
[//]: # (END_OPERATION)
|
|
3620
|
+
|
|
3621
|
+
|
|
3622
|
+
[//]: # (START_OPERATION)
|
|
3623
|
+
|
|
3624
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
3625
|
+
|
|
3626
|
+
[//]: # (METHOD:get_security_price_technicals_wr)
|
|
3627
|
+
|
|
3628
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityWilliamsR)
|
|
3629
|
+
|
|
3630
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
3631
|
+
|
|
3632
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityWilliamsR.md)
|
|
3633
|
+
|
|
3634
|
+
[//]: # (OPERATION:get_security_price_technicals_wr_v2)
|
|
3635
|
+
|
|
3636
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/wr)
|
|
3637
|
+
|
|
3638
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_price_technicals_wr)
|
|
3639
|
+
|
|
3640
|
+
## **get_security_price_technicals_wr**
|
|
3641
|
+
|
|
3642
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_wr_v2)
|
|
3643
|
+
|
|
3644
|
+
[//]: # (START_OVERVIEW)
|
|
3645
|
+
|
|
2026
3646
|
> ApiResponseSecurityWilliamsR get_security_price_technicals_wr(identifier, opts)
|
|
2027
3647
|
|
|
2028
|
-
Williams %R
|
|
3648
|
+
#### Williams %R
|
|
3649
|
+
|
|
2029
3650
|
|
|
2030
3651
|
Returns the Williams %R values of Stock Prices for the Security with the given `identifier`
|
|
2031
3652
|
|
|
3653
|
+
[//]: # (END_OVERVIEW)
|
|
3654
|
+
|
|
2032
3655
|
### Example
|
|
3656
|
+
|
|
3657
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
3658
|
+
|
|
2033
3659
|
```ruby
|
|
2034
3660
|
# Load the gem
|
|
2035
3661
|
require 'intrinio-sdk'
|
|
2036
3662
|
|
|
2037
3663
|
# Setup authorization
|
|
2038
3664
|
Intrinio.configure do |config|
|
|
2039
|
-
config.api_key['api_key'] = '
|
|
3665
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
2040
3666
|
end
|
|
2041
3667
|
|
|
2042
3668
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -2059,36 +3685,78 @@ rescue Intrinio::ApiError => e
|
|
|
2059
3685
|
end
|
|
2060
3686
|
```
|
|
2061
3687
|
|
|
3688
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
3689
|
+
|
|
3690
|
+
[//]: # (START_DEFINITION)
|
|
3691
|
+
|
|
2062
3692
|
### Parameters
|
|
2063
3693
|
|
|
3694
|
+
[//]: # (START_PARAMETERS)
|
|
3695
|
+
|
|
3696
|
+
|
|
2064
3697
|
Name | Type | Description | Notes
|
|
2065
3698
|
------------- | ------------- | ------------- | -------------
|
|
2066
|
-
**identifier** |
|
|
2067
|
-
**period** |
|
|
2068
|
-
**start_date** |
|
|
2069
|
-
**end_date** |
|
|
2070
|
-
**page_size** |
|
|
2071
|
-
**next_page** |
|
|
3699
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
3700
|
+
**period** | Integer| The number of observations, per period, to look-back when calculating Williams %R | [optional] [default to 14]
|
|
3701
|
+
**start_date** | String| Return technical indicator values on or after the date | [optional]
|
|
3702
|
+
**end_date** | String| Return technical indicator values on or before the date | [optional]
|
|
3703
|
+
**page_size** | Float| The number of results to return | [optional] [default to 100]
|
|
3704
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
3705
|
+
<br/>
|
|
3706
|
+
|
|
3707
|
+
[//]: # (END_PARAMETERS)
|
|
2072
3708
|
|
|
2073
3709
|
### Return type
|
|
2074
3710
|
|
|
2075
3711
|
[**ApiResponseSecurityWilliamsR**](ApiResponseSecurityWilliamsR.md)
|
|
2076
3712
|
|
|
2077
|
-
#
|
|
3713
|
+
[//]: # (END_OPERATION)
|
|
3714
|
+
|
|
3715
|
+
|
|
3716
|
+
[//]: # (START_OPERATION)
|
|
3717
|
+
|
|
3718
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
3719
|
+
|
|
3720
|
+
[//]: # (METHOD:get_security_realtime_price)
|
|
3721
|
+
|
|
3722
|
+
[//]: # (RETURN_TYPE:Intrinio::RealtimeStockPrice)
|
|
3723
|
+
|
|
3724
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
3725
|
+
|
|
3726
|
+
[//]: # (RETURN_TYPE_DOC:RealtimeStockPrice.md)
|
|
3727
|
+
|
|
3728
|
+
[//]: # (OPERATION:get_security_realtime_price_v2)
|
|
3729
|
+
|
|
3730
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/realtime)
|
|
3731
|
+
|
|
3732
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_realtime_price)
|
|
3733
|
+
|
|
3734
|
+
## **get_security_realtime_price**
|
|
3735
|
+
|
|
3736
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_realtime_price_v2)
|
|
3737
|
+
|
|
3738
|
+
[//]: # (START_OVERVIEW)
|
|
3739
|
+
|
|
2078
3740
|
> RealtimeStockPrice get_security_realtime_price(identifier, opts)
|
|
2079
3741
|
|
|
2080
|
-
Realtime Stock Price for Security
|
|
3742
|
+
#### Realtime Stock Price for Security
|
|
3743
|
+
|
|
2081
3744
|
|
|
2082
3745
|
Return the realtime stock price for the Security with the given `identifier`
|
|
2083
3746
|
|
|
3747
|
+
[//]: # (END_OVERVIEW)
|
|
3748
|
+
|
|
2084
3749
|
### Example
|
|
3750
|
+
|
|
3751
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
3752
|
+
|
|
2085
3753
|
```ruby
|
|
2086
3754
|
# Load the gem
|
|
2087
3755
|
require 'intrinio-sdk'
|
|
2088
3756
|
|
|
2089
3757
|
# Setup authorization
|
|
2090
3758
|
Intrinio.configure do |config|
|
|
2091
|
-
config.api_key['api_key'] = '
|
|
3759
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
2092
3760
|
end
|
|
2093
3761
|
|
|
2094
3762
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -2107,32 +3775,74 @@ rescue Intrinio::ApiError => e
|
|
|
2107
3775
|
end
|
|
2108
3776
|
```
|
|
2109
3777
|
|
|
3778
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
3779
|
+
|
|
3780
|
+
[//]: # (START_DEFINITION)
|
|
3781
|
+
|
|
2110
3782
|
### Parameters
|
|
2111
3783
|
|
|
3784
|
+
[//]: # (START_PARAMETERS)
|
|
3785
|
+
|
|
3786
|
+
|
|
2112
3787
|
Name | Type | Description | Notes
|
|
2113
3788
|
------------- | ------------- | ------------- | -------------
|
|
2114
|
-
**identifier** |
|
|
2115
|
-
**source** |
|
|
3789
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
3790
|
+
**source** | String| Return the realtime price from the specified data source | [optional]
|
|
3791
|
+
<br/>
|
|
3792
|
+
|
|
3793
|
+
[//]: # (END_PARAMETERS)
|
|
2116
3794
|
|
|
2117
3795
|
### Return type
|
|
2118
3796
|
|
|
2119
3797
|
[**RealtimeStockPrice**](RealtimeStockPrice.md)
|
|
2120
3798
|
|
|
2121
|
-
#
|
|
3799
|
+
[//]: # (END_OPERATION)
|
|
3800
|
+
|
|
3801
|
+
|
|
3802
|
+
[//]: # (START_OPERATION)
|
|
3803
|
+
|
|
3804
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
3805
|
+
|
|
3806
|
+
[//]: # (METHOD:get_security_stock_price_adjustments)
|
|
3807
|
+
|
|
3808
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityStockPriceAdjustments)
|
|
3809
|
+
|
|
3810
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
3811
|
+
|
|
3812
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityStockPriceAdjustments.md)
|
|
3813
|
+
|
|
3814
|
+
[//]: # (OPERATION:get_security_stock_price_adjustments_v2)
|
|
3815
|
+
|
|
3816
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/adjustments)
|
|
3817
|
+
|
|
3818
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_stock_price_adjustments)
|
|
3819
|
+
|
|
3820
|
+
## **get_security_stock_price_adjustments**
|
|
3821
|
+
|
|
3822
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_stock_price_adjustments_v2)
|
|
3823
|
+
|
|
3824
|
+
[//]: # (START_OVERVIEW)
|
|
3825
|
+
|
|
2122
3826
|
> ApiResponseSecurityStockPriceAdjustments get_security_stock_price_adjustments(identifier, opts)
|
|
2123
3827
|
|
|
2124
|
-
Stock Price Adjustments by Security
|
|
3828
|
+
#### Stock Price Adjustments by Security
|
|
3829
|
+
|
|
2125
3830
|
|
|
2126
3831
|
Returns stock price adjustments for the Security with the given `identifier`
|
|
2127
3832
|
|
|
3833
|
+
[//]: # (END_OVERVIEW)
|
|
3834
|
+
|
|
2128
3835
|
### Example
|
|
3836
|
+
|
|
3837
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
3838
|
+
|
|
2129
3839
|
```ruby
|
|
2130
3840
|
# Load the gem
|
|
2131
3841
|
require 'intrinio-sdk'
|
|
2132
3842
|
|
|
2133
3843
|
# Setup authorization
|
|
2134
3844
|
Intrinio.configure do |config|
|
|
2135
|
-
config.api_key['api_key'] = '
|
|
3845
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
2136
3846
|
end
|
|
2137
3847
|
|
|
2138
3848
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -2154,35 +3864,77 @@ rescue Intrinio::ApiError => e
|
|
|
2154
3864
|
end
|
|
2155
3865
|
```
|
|
2156
3866
|
|
|
3867
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
3868
|
+
|
|
3869
|
+
[//]: # (START_DEFINITION)
|
|
3870
|
+
|
|
2157
3871
|
### Parameters
|
|
2158
3872
|
|
|
3873
|
+
[//]: # (START_PARAMETERS)
|
|
3874
|
+
|
|
3875
|
+
|
|
2159
3876
|
Name | Type | Description | Notes
|
|
2160
3877
|
------------- | ------------- | ------------- | -------------
|
|
2161
|
-
**identifier** |
|
|
2162
|
-
**start_date** |
|
|
2163
|
-
**end_date** |
|
|
2164
|
-
**page_size** |
|
|
2165
|
-
**next_page** |
|
|
3878
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
3879
|
+
**start_date** | Date| Return price adjustments on or after the date | [optional]
|
|
3880
|
+
**end_date** | Date| Return price adjustments on or before the date | [optional]
|
|
3881
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
3882
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
3883
|
+
<br/>
|
|
3884
|
+
|
|
3885
|
+
[//]: # (END_PARAMETERS)
|
|
2166
3886
|
|
|
2167
3887
|
### Return type
|
|
2168
3888
|
|
|
2169
3889
|
[**ApiResponseSecurityStockPriceAdjustments**](ApiResponseSecurityStockPriceAdjustments.md)
|
|
2170
3890
|
|
|
2171
|
-
#
|
|
3891
|
+
[//]: # (END_OPERATION)
|
|
3892
|
+
|
|
3893
|
+
|
|
3894
|
+
[//]: # (START_OPERATION)
|
|
3895
|
+
|
|
3896
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
3897
|
+
|
|
3898
|
+
[//]: # (METHOD:get_security_stock_prices)
|
|
3899
|
+
|
|
3900
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityStockPrices)
|
|
3901
|
+
|
|
3902
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
3903
|
+
|
|
3904
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityStockPrices.md)
|
|
3905
|
+
|
|
3906
|
+
[//]: # (OPERATION:get_security_stock_prices_v2)
|
|
3907
|
+
|
|
3908
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices)
|
|
3909
|
+
|
|
3910
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_stock_prices)
|
|
3911
|
+
|
|
3912
|
+
## **get_security_stock_prices**
|
|
3913
|
+
|
|
3914
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_stock_prices_v2)
|
|
3915
|
+
|
|
3916
|
+
[//]: # (START_OVERVIEW)
|
|
3917
|
+
|
|
2172
3918
|
> ApiResponseSecurityStockPrices get_security_stock_prices(identifier, opts)
|
|
2173
3919
|
|
|
2174
|
-
Stock Prices by Security
|
|
3920
|
+
#### Stock Prices by Security
|
|
3921
|
+
|
|
2175
3922
|
|
|
2176
3923
|
Return end-of-day stock prices for the Security with the given `identifier`
|
|
2177
3924
|
|
|
3925
|
+
[//]: # (END_OVERVIEW)
|
|
3926
|
+
|
|
2178
3927
|
### Example
|
|
3928
|
+
|
|
3929
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
3930
|
+
|
|
2179
3931
|
```ruby
|
|
2180
3932
|
# Load the gem
|
|
2181
3933
|
require 'intrinio-sdk'
|
|
2182
3934
|
|
|
2183
3935
|
# Setup authorization
|
|
2184
3936
|
Intrinio.configure do |config|
|
|
2185
|
-
config.api_key['api_key'] = '
|
|
3937
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
2186
3938
|
end
|
|
2187
3939
|
|
|
2188
3940
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -2205,36 +3957,78 @@ rescue Intrinio::ApiError => e
|
|
|
2205
3957
|
end
|
|
2206
3958
|
```
|
|
2207
3959
|
|
|
3960
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
3961
|
+
|
|
3962
|
+
[//]: # (START_DEFINITION)
|
|
3963
|
+
|
|
2208
3964
|
### Parameters
|
|
2209
3965
|
|
|
3966
|
+
[//]: # (START_PARAMETERS)
|
|
3967
|
+
|
|
3968
|
+
|
|
2210
3969
|
Name | Type | Description | Notes
|
|
2211
3970
|
------------- | ------------- | ------------- | -------------
|
|
2212
|
-
**identifier** |
|
|
2213
|
-
**start_date** |
|
|
2214
|
-
**end_date** |
|
|
2215
|
-
**frequency** |
|
|
2216
|
-
**page_size** |
|
|
2217
|
-
**next_page** |
|
|
3971
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
3972
|
+
**start_date** | Date| Return prices on or after the date | [optional]
|
|
3973
|
+
**end_date** | Date| Return prices on or before the date | [optional]
|
|
3974
|
+
**frequency** | String| Return stock prices in the given frequency | [optional] [default to daily]
|
|
3975
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
3976
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
3977
|
+
<br/>
|
|
3978
|
+
|
|
3979
|
+
[//]: # (END_PARAMETERS)
|
|
2218
3980
|
|
|
2219
3981
|
### Return type
|
|
2220
3982
|
|
|
2221
3983
|
[**ApiResponseSecurityStockPrices**](ApiResponseSecurityStockPrices.md)
|
|
2222
3984
|
|
|
2223
|
-
#
|
|
3985
|
+
[//]: # (END_OPERATION)
|
|
3986
|
+
|
|
3987
|
+
|
|
3988
|
+
[//]: # (START_OPERATION)
|
|
3989
|
+
|
|
3990
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
3991
|
+
|
|
3992
|
+
[//]: # (METHOD:get_security_zacks_analyst_ratings)
|
|
3993
|
+
|
|
3994
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityZacksAnalystRatings)
|
|
3995
|
+
|
|
3996
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
3997
|
+
|
|
3998
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityZacksAnalystRatings.md)
|
|
3999
|
+
|
|
4000
|
+
[//]: # (OPERATION:get_security_zacks_analyst_ratings_v2)
|
|
4001
|
+
|
|
4002
|
+
[//]: # (ENDPOINT:/securities/{identifier}/zacks/analyst_ratings)
|
|
4003
|
+
|
|
4004
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_zacks_analyst_ratings)
|
|
4005
|
+
|
|
4006
|
+
## **get_security_zacks_analyst_ratings**
|
|
4007
|
+
|
|
4008
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_zacks_analyst_ratings_v2)
|
|
4009
|
+
|
|
4010
|
+
[//]: # (START_OVERVIEW)
|
|
4011
|
+
|
|
2224
4012
|
> ApiResponseSecurityZacksAnalystRatings get_security_zacks_analyst_ratings(identifier, opts)
|
|
2225
4013
|
|
|
2226
|
-
Zacks Analyst Ratings
|
|
4014
|
+
#### Zacks Analyst Ratings
|
|
4015
|
+
|
|
2227
4016
|
|
|
2228
4017
|
Returns buy, sell, and hold recommendations from analysts at brokerages for the Security with the given `identifier`. Zack’s storied research team aggregates and validates the ratings from professional analysts.
|
|
2229
4018
|
|
|
4019
|
+
[//]: # (END_OVERVIEW)
|
|
4020
|
+
|
|
2230
4021
|
### Example
|
|
4022
|
+
|
|
4023
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
4024
|
+
|
|
2231
4025
|
```ruby
|
|
2232
4026
|
# Load the gem
|
|
2233
4027
|
require 'intrinio-sdk'
|
|
2234
4028
|
|
|
2235
4029
|
# Setup authorization
|
|
2236
4030
|
Intrinio.configure do |config|
|
|
2237
|
-
config.api_key['api_key'] = '
|
|
4031
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
2238
4032
|
end
|
|
2239
4033
|
|
|
2240
4034
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -2269,48 +4063,90 @@ rescue Intrinio::ApiError => e
|
|
|
2269
4063
|
end
|
|
2270
4064
|
```
|
|
2271
4065
|
|
|
4066
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
4067
|
+
|
|
4068
|
+
[//]: # (START_DEFINITION)
|
|
4069
|
+
|
|
2272
4070
|
### Parameters
|
|
2273
4071
|
|
|
4072
|
+
[//]: # (START_PARAMETERS)
|
|
4073
|
+
|
|
4074
|
+
|
|
2274
4075
|
Name | Type | Description | Notes
|
|
2275
4076
|
------------- | ------------- | ------------- | -------------
|
|
2276
|
-
**identifier** |
|
|
2277
|
-
**start_date** |
|
|
2278
|
-
**end_date** |
|
|
2279
|
-
**mean_greater** |
|
|
2280
|
-
**mean_less** |
|
|
2281
|
-
**strong_buys_greater** |
|
|
2282
|
-
**strong_buys_less** |
|
|
2283
|
-
**buys_greater** |
|
|
2284
|
-
**buys_less** |
|
|
2285
|
-
**holds_greater** |
|
|
2286
|
-
**holds_less** |
|
|
2287
|
-
**sells_greater** |
|
|
2288
|
-
**sells_less** |
|
|
2289
|
-
**strong_sells_greater** |
|
|
2290
|
-
**strong_sells_less** |
|
|
2291
|
-
**total_greater** |
|
|
2292
|
-
**total_less** |
|
|
2293
|
-
**page_size** |
|
|
4077
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
4078
|
+
**start_date** | String| Limit ratings to those on or after this date | [optional]
|
|
4079
|
+
**end_date** | String| Limit ratings to those on or before this date | [optional]
|
|
4080
|
+
**mean_greater** | Float| Return only records with a mean (average) higher than this value | [optional]
|
|
4081
|
+
**mean_less** | Float| Return only records with a mean (average) lower than this value | [optional]
|
|
4082
|
+
**strong_buys_greater** | Integer| Return only records with more than this many Strong Buy recommendations | [optional]
|
|
4083
|
+
**strong_buys_less** | Integer| Return only records with fewer than this many Strong Buy recommendations | [optional]
|
|
4084
|
+
**buys_greater** | Integer| Return only records with more than this many Buy recommendations | [optional]
|
|
4085
|
+
**buys_less** | Integer| Return only records with fewer than this many Buy recommendations | [optional]
|
|
4086
|
+
**holds_greater** | Integer| Return only records with more than this many Hold recommendations | [optional]
|
|
4087
|
+
**holds_less** | Integer| Return only records with fewer than this many Hold recommendations | [optional]
|
|
4088
|
+
**sells_greater** | Integer| Return only records with more than this many Sell recommendations | [optional]
|
|
4089
|
+
**sells_less** | Integer| Return only records with fewer than this many Sell recommendations | [optional]
|
|
4090
|
+
**strong_sells_greater** | Integer| Return only records with more than this many Strong Sell recommendations | [optional]
|
|
4091
|
+
**strong_sells_less** | Integer| Return only records with fewer than this many Strong Sell recommendations | [optional]
|
|
4092
|
+
**total_greater** | Integer| Return only records with more than this many recommendations, regardless of type | [optional]
|
|
4093
|
+
**total_less** | Integer| Return only records with fewer than this many recommendations, regardless of type | [optional]
|
|
4094
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
4095
|
+
<br/>
|
|
4096
|
+
|
|
4097
|
+
[//]: # (END_PARAMETERS)
|
|
2294
4098
|
|
|
2295
4099
|
### Return type
|
|
2296
4100
|
|
|
2297
4101
|
[**ApiResponseSecurityZacksAnalystRatings**](ApiResponseSecurityZacksAnalystRatings.md)
|
|
2298
4102
|
|
|
2299
|
-
#
|
|
4103
|
+
[//]: # (END_OPERATION)
|
|
4104
|
+
|
|
4105
|
+
|
|
4106
|
+
[//]: # (START_OPERATION)
|
|
4107
|
+
|
|
4108
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
4109
|
+
|
|
4110
|
+
[//]: # (METHOD:get_security_zacks_analyst_ratings_snapshot)
|
|
4111
|
+
|
|
4112
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityZacksAnalystRatingsSnapshot)
|
|
4113
|
+
|
|
4114
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
4115
|
+
|
|
4116
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityZacksAnalystRatingsSnapshot.md)
|
|
4117
|
+
|
|
4118
|
+
[//]: # (OPERATION:get_security_zacks_analyst_ratings_snapshot_v2)
|
|
4119
|
+
|
|
4120
|
+
[//]: # (ENDPOINT:/securities/{identifier}/zacks/analyst_ratings/snapshot)
|
|
4121
|
+
|
|
4122
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_zacks_analyst_ratings_snapshot)
|
|
4123
|
+
|
|
4124
|
+
## **get_security_zacks_analyst_ratings_snapshot**
|
|
4125
|
+
|
|
4126
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_zacks_analyst_ratings_snapshot_v2)
|
|
4127
|
+
|
|
4128
|
+
[//]: # (START_OVERVIEW)
|
|
4129
|
+
|
|
2300
4130
|
> ApiResponseSecurityZacksAnalystRatingsSnapshot get_security_zacks_analyst_ratings_snapshot(identifier, opts)
|
|
2301
4131
|
|
|
2302
|
-
Zacks Analyst Ratings Snapshot
|
|
4132
|
+
#### Zacks Analyst Ratings Snapshot
|
|
4133
|
+
|
|
2303
4134
|
|
|
2304
4135
|
Returns a snapshot of ratings data compared with previous timeframes for the Security with the given `identifier`. Also returns mean percentiles for comparing one security to the universe of securities covered by Zacks analyst ratings, at a specific point in time.
|
|
2305
4136
|
|
|
4137
|
+
[//]: # (END_OVERVIEW)
|
|
4138
|
+
|
|
2306
4139
|
### Example
|
|
4140
|
+
|
|
4141
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
4142
|
+
|
|
2307
4143
|
```ruby
|
|
2308
4144
|
# Load the gem
|
|
2309
4145
|
require 'intrinio-sdk'
|
|
2310
4146
|
|
|
2311
4147
|
# Setup authorization
|
|
2312
4148
|
Intrinio.configure do |config|
|
|
2313
|
-
config.api_key['api_key'] = '
|
|
4149
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
2314
4150
|
end
|
|
2315
4151
|
|
|
2316
4152
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -2329,32 +4165,74 @@ rescue Intrinio::ApiError => e
|
|
|
2329
4165
|
end
|
|
2330
4166
|
```
|
|
2331
4167
|
|
|
4168
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
4169
|
+
|
|
4170
|
+
[//]: # (START_DEFINITION)
|
|
4171
|
+
|
|
2332
4172
|
### Parameters
|
|
2333
4173
|
|
|
4174
|
+
[//]: # (START_PARAMETERS)
|
|
4175
|
+
|
|
4176
|
+
|
|
2334
4177
|
Name | Type | Description | Notes
|
|
2335
4178
|
------------- | ------------- | ------------- | -------------
|
|
2336
|
-
**identifier** |
|
|
2337
|
-
**date** |
|
|
4179
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
4180
|
+
**date** | String| Lookup a historical snapshot on the given date | [optional]
|
|
4181
|
+
<br/>
|
|
4182
|
+
|
|
4183
|
+
[//]: # (END_PARAMETERS)
|
|
2338
4184
|
|
|
2339
4185
|
### Return type
|
|
2340
4186
|
|
|
2341
4187
|
[**ApiResponseSecurityZacksAnalystRatingsSnapshot**](ApiResponseSecurityZacksAnalystRatingsSnapshot.md)
|
|
2342
4188
|
|
|
2343
|
-
#
|
|
4189
|
+
[//]: # (END_OPERATION)
|
|
4190
|
+
|
|
4191
|
+
|
|
4192
|
+
[//]: # (START_OPERATION)
|
|
4193
|
+
|
|
4194
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
4195
|
+
|
|
4196
|
+
[//]: # (METHOD:get_security_zacks_eps_surprises)
|
|
4197
|
+
|
|
4198
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityZacksEPSSurprises)
|
|
4199
|
+
|
|
4200
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
4201
|
+
|
|
4202
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityZacksEPSSurprises.md)
|
|
4203
|
+
|
|
4204
|
+
[//]: # (OPERATION:get_security_zacks_eps_surprises_v2)
|
|
4205
|
+
|
|
4206
|
+
[//]: # (ENDPOINT:/securities/{identifier}/zacks/eps_surprises)
|
|
4207
|
+
|
|
4208
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_zacks_eps_surprises)
|
|
4209
|
+
|
|
4210
|
+
## **get_security_zacks_eps_surprises**
|
|
4211
|
+
|
|
4212
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_zacks_eps_surprises_v2)
|
|
4213
|
+
|
|
4214
|
+
[//]: # (START_OVERVIEW)
|
|
4215
|
+
|
|
2344
4216
|
> ApiResponseSecurityZacksEPSSurprises get_security_zacks_eps_surprises(identifier, opts)
|
|
2345
4217
|
|
|
2346
|
-
Zacks EPS Surprises for Security
|
|
4218
|
+
#### Zacks EPS Surprises for Security
|
|
4219
|
+
|
|
2347
4220
|
|
|
2348
4221
|
Return Zacks EPS surprises for the Security with the given `identifier`.
|
|
2349
4222
|
|
|
4223
|
+
[//]: # (END_OVERVIEW)
|
|
4224
|
+
|
|
2350
4225
|
### Example
|
|
4226
|
+
|
|
4227
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
4228
|
+
|
|
2351
4229
|
```ruby
|
|
2352
4230
|
# Load the gem
|
|
2353
4231
|
require 'intrinio-sdk'
|
|
2354
4232
|
|
|
2355
4233
|
# Setup authorization
|
|
2356
4234
|
Intrinio.configure do |config|
|
|
2357
|
-
config.api_key['api_key'] = '
|
|
4235
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
2358
4236
|
end
|
|
2359
4237
|
|
|
2360
4238
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -2374,33 +4252,75 @@ rescue Intrinio::ApiError => e
|
|
|
2374
4252
|
end
|
|
2375
4253
|
```
|
|
2376
4254
|
|
|
4255
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
4256
|
+
|
|
4257
|
+
[//]: # (START_DEFINITION)
|
|
4258
|
+
|
|
2377
4259
|
### Parameters
|
|
2378
4260
|
|
|
4261
|
+
[//]: # (START_PARAMETERS)
|
|
4262
|
+
|
|
4263
|
+
|
|
2379
4264
|
Name | Type | Description | Notes
|
|
2380
4265
|
------------- | ------------- | ------------- | -------------
|
|
2381
|
-
**identifier** |
|
|
2382
|
-
**page_size** |
|
|
2383
|
-
**next_page** |
|
|
4266
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
4267
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
4268
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
4269
|
+
<br/>
|
|
4270
|
+
|
|
4271
|
+
[//]: # (END_PARAMETERS)
|
|
2384
4272
|
|
|
2385
4273
|
### Return type
|
|
2386
4274
|
|
|
2387
4275
|
[**ApiResponseSecurityZacksEPSSurprises**](ApiResponseSecurityZacksEPSSurprises.md)
|
|
2388
4276
|
|
|
2389
|
-
#
|
|
4277
|
+
[//]: # (END_OPERATION)
|
|
4278
|
+
|
|
4279
|
+
|
|
4280
|
+
[//]: # (START_OPERATION)
|
|
4281
|
+
|
|
4282
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
4283
|
+
|
|
4284
|
+
[//]: # (METHOD:get_security_zacks_sales_surprises)
|
|
4285
|
+
|
|
4286
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityZacksSalesSurprises)
|
|
4287
|
+
|
|
4288
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
4289
|
+
|
|
4290
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityZacksSalesSurprises.md)
|
|
4291
|
+
|
|
4292
|
+
[//]: # (OPERATION:get_security_zacks_sales_surprises_v2)
|
|
4293
|
+
|
|
4294
|
+
[//]: # (ENDPOINT:/securities/{identifier}/zacks/sales_surprises)
|
|
4295
|
+
|
|
4296
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_zacks_sales_surprises)
|
|
4297
|
+
|
|
4298
|
+
## **get_security_zacks_sales_surprises**
|
|
4299
|
+
|
|
4300
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_zacks_sales_surprises_v2)
|
|
4301
|
+
|
|
4302
|
+
[//]: # (START_OVERVIEW)
|
|
4303
|
+
|
|
2390
4304
|
> ApiResponseSecurityZacksSalesSurprises get_security_zacks_sales_surprises(identifier, opts)
|
|
2391
4305
|
|
|
2392
|
-
Zacks Sales Surprises for Security
|
|
4306
|
+
#### Zacks Sales Surprises for Security
|
|
4307
|
+
|
|
2393
4308
|
|
|
2394
4309
|
Return Zacks sales surprises for the Security with the given `identifier`.
|
|
2395
4310
|
|
|
4311
|
+
[//]: # (END_OVERVIEW)
|
|
4312
|
+
|
|
2396
4313
|
### Example
|
|
4314
|
+
|
|
4315
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
4316
|
+
|
|
2397
4317
|
```ruby
|
|
2398
4318
|
# Load the gem
|
|
2399
4319
|
require 'intrinio-sdk'
|
|
2400
4320
|
|
|
2401
4321
|
# Setup authorization
|
|
2402
4322
|
Intrinio.configure do |config|
|
|
2403
|
-
config.api_key['api_key'] = '
|
|
4323
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
2404
4324
|
end
|
|
2405
4325
|
|
|
2406
4326
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -2420,33 +4340,75 @@ rescue Intrinio::ApiError => e
|
|
|
2420
4340
|
end
|
|
2421
4341
|
```
|
|
2422
4342
|
|
|
4343
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
4344
|
+
|
|
4345
|
+
[//]: # (START_DEFINITION)
|
|
4346
|
+
|
|
2423
4347
|
### Parameters
|
|
2424
4348
|
|
|
4349
|
+
[//]: # (START_PARAMETERS)
|
|
4350
|
+
|
|
4351
|
+
|
|
2425
4352
|
Name | Type | Description | Notes
|
|
2426
4353
|
------------- | ------------- | ------------- | -------------
|
|
2427
|
-
**identifier** |
|
|
2428
|
-
**page_size** |
|
|
2429
|
-
**next_page** |
|
|
4354
|
+
**identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
4355
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
4356
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
|
4357
|
+
<br/>
|
|
4358
|
+
|
|
4359
|
+
[//]: # (END_PARAMETERS)
|
|
2430
4360
|
|
|
2431
4361
|
### Return type
|
|
2432
4362
|
|
|
2433
4363
|
[**ApiResponseSecurityZacksSalesSurprises**](ApiResponseSecurityZacksSalesSurprises.md)
|
|
2434
4364
|
|
|
2435
|
-
#
|
|
4365
|
+
[//]: # (END_OPERATION)
|
|
4366
|
+
|
|
4367
|
+
|
|
4368
|
+
[//]: # (START_OPERATION)
|
|
4369
|
+
|
|
4370
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
4371
|
+
|
|
4372
|
+
[//]: # (METHOD:screen_securities)
|
|
4373
|
+
|
|
4374
|
+
[//]: # (RETURN_TYPE:Intrinio::Array<SecurityScreenResult>)
|
|
4375
|
+
|
|
4376
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
4377
|
+
|
|
4378
|
+
[//]: # (RETURN_TYPE_DOC:SecurityScreenResult.md)
|
|
4379
|
+
|
|
4380
|
+
[//]: # (OPERATION:screen_securities_v2)
|
|
4381
|
+
|
|
4382
|
+
[//]: # (ENDPOINT:/securities/screen)
|
|
4383
|
+
|
|
4384
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#screen_securities)
|
|
4385
|
+
|
|
4386
|
+
## **screen_securities**
|
|
4387
|
+
|
|
4388
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/screen_securities_v2)
|
|
4389
|
+
|
|
4390
|
+
[//]: # (START_OVERVIEW)
|
|
4391
|
+
|
|
2436
4392
|
> Array<SecurityScreenResult> screen_securities(opts)
|
|
2437
4393
|
|
|
2438
|
-
Screen Securities
|
|
4394
|
+
#### Screen Securities
|
|
4395
|
+
|
|
2439
4396
|
|
|
2440
4397
|
Screen Securities using complex logic
|
|
2441
4398
|
|
|
4399
|
+
[//]: # (END_OVERVIEW)
|
|
4400
|
+
|
|
2442
4401
|
### Example
|
|
4402
|
+
|
|
4403
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
4404
|
+
|
|
2443
4405
|
```ruby
|
|
2444
4406
|
# Load the gem
|
|
2445
4407
|
require 'intrinio-sdk'
|
|
2446
4408
|
|
|
2447
4409
|
# Setup authorization
|
|
2448
4410
|
Intrinio.configure do |config|
|
|
2449
|
-
config.api_key['api_key'] = '
|
|
4411
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
2450
4412
|
end
|
|
2451
4413
|
|
|
2452
4414
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -2467,35 +4429,77 @@ rescue Intrinio::ApiError => e
|
|
|
2467
4429
|
end
|
|
2468
4430
|
```
|
|
2469
4431
|
|
|
4432
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
4433
|
+
|
|
4434
|
+
[//]: # (START_DEFINITION)
|
|
4435
|
+
|
|
2470
4436
|
### Parameters
|
|
2471
4437
|
|
|
4438
|
+
[//]: # (START_PARAMETERS)
|
|
4439
|
+
|
|
4440
|
+
|
|
2472
4441
|
Name | Type | Description | Notes
|
|
2473
4442
|
------------- | ------------- | ------------- | -------------
|
|
2474
|
-
**logic** | [**SecurityScreenGroup**](SecurityScreenGroup.md)| The logic to screen with, consisting of operators, clauses, and nested groups.<br/> See <a href=\"/documentation/screener_v2\" target=\"_blank\">screener documentation</a> for details on how to construct conditions. | [optional]
|
|
2475
|
-
**order_column** |
|
|
2476
|
-
**order_direction** |
|
|
2477
|
-
**primary_only** |
|
|
2478
|
-
**page_size** |
|
|
4443
|
+
**logic** | [**SecurityScreenGroup**](SecurityScreenGroup.md)| The logic to screen with, consisting of operators, clauses, and nested groups.<br/> See <a href=\"/documentation/screener_v2\" target=\"_blank\">screener documentation</a> for details on how to construct conditions. | [optional]
|
|
4444
|
+
**order_column** | String| Results returned sorted by this column | [optional]
|
|
4445
|
+
**order_direction** | String| Sort order to use with the order_column | [optional] [default to asc]
|
|
4446
|
+
**primary_only** | BOOLEAN| Return only primary securities | [optional] [default to false]
|
|
4447
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
4448
|
+
<br/>
|
|
4449
|
+
|
|
4450
|
+
[//]: # (END_PARAMETERS)
|
|
2479
4451
|
|
|
2480
4452
|
### Return type
|
|
2481
4453
|
|
|
2482
4454
|
[**Array<SecurityScreenResult>**](SecurityScreenResult.md)
|
|
2483
4455
|
|
|
2484
|
-
#
|
|
4456
|
+
[//]: # (END_OPERATION)
|
|
4457
|
+
|
|
4458
|
+
|
|
4459
|
+
[//]: # (START_OPERATION)
|
|
4460
|
+
|
|
4461
|
+
[//]: # (CLASS:Intrinio::SecurityApi)
|
|
4462
|
+
|
|
4463
|
+
[//]: # (METHOD:search_securities)
|
|
4464
|
+
|
|
4465
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecuritiesSearch)
|
|
4466
|
+
|
|
4467
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
|
4468
|
+
|
|
4469
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseSecuritiesSearch.md)
|
|
4470
|
+
|
|
4471
|
+
[//]: # (OPERATION:search_securities_v2)
|
|
4472
|
+
|
|
4473
|
+
[//]: # (ENDPOINT:/securities/search)
|
|
4474
|
+
|
|
4475
|
+
[//]: # (DOCUMENT_LINK:SecurityApi.md#search_securities)
|
|
4476
|
+
|
|
4477
|
+
## **search_securities**
|
|
4478
|
+
|
|
4479
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/search_securities_v2)
|
|
4480
|
+
|
|
4481
|
+
[//]: # (START_OVERVIEW)
|
|
4482
|
+
|
|
2485
4483
|
> ApiResponseSecuritiesSearch search_securities(query, opts)
|
|
2486
4484
|
|
|
2487
|
-
Search Securities
|
|
4485
|
+
#### Search Securities
|
|
4486
|
+
|
|
2488
4487
|
|
|
2489
4488
|
Searches for Securities matching the text `query`
|
|
2490
4489
|
|
|
4490
|
+
[//]: # (END_OVERVIEW)
|
|
4491
|
+
|
|
2491
4492
|
### Example
|
|
4493
|
+
|
|
4494
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
4495
|
+
|
|
2492
4496
|
```ruby
|
|
2493
4497
|
# Load the gem
|
|
2494
4498
|
require 'intrinio-sdk'
|
|
2495
4499
|
|
|
2496
4500
|
# Setup authorization
|
|
2497
4501
|
Intrinio.configure do |config|
|
|
2498
|
-
config.api_key['api_key'] = '
|
|
4502
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
|
2499
4503
|
end
|
|
2500
4504
|
|
|
2501
4505
|
security_api = Intrinio::SecurityApi.new
|
|
@@ -2514,14 +4518,26 @@ rescue Intrinio::ApiError => e
|
|
|
2514
4518
|
end
|
|
2515
4519
|
```
|
|
2516
4520
|
|
|
4521
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
4522
|
+
|
|
4523
|
+
[//]: # (START_DEFINITION)
|
|
4524
|
+
|
|
2517
4525
|
### Parameters
|
|
2518
4526
|
|
|
4527
|
+
[//]: # (START_PARAMETERS)
|
|
4528
|
+
|
|
4529
|
+
|
|
2519
4530
|
Name | Type | Description | Notes
|
|
2520
4531
|
------------- | ------------- | ------------- | -------------
|
|
2521
|
-
**query** |
|
|
2522
|
-
**page_size** |
|
|
4532
|
+
**query** | String| |
|
|
4533
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
|
4534
|
+
<br/>
|
|
4535
|
+
|
|
4536
|
+
[//]: # (END_PARAMETERS)
|
|
2523
4537
|
|
|
2524
4538
|
### Return type
|
|
2525
4539
|
|
|
2526
4540
|
[**ApiResponseSecuritiesSearch**](ApiResponseSecuritiesSearch.md)
|
|
2527
4541
|
|
|
4542
|
+
[//]: # (END_OPERATION)
|
|
4543
|
+
|