intrinio-sdk 2.2.0 → 2.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +116 -2
- data/docs/ApiResponseCryptoAccumulationDistributionIndex.md +13 -0
- data/docs/ApiResponseCryptoAverageDailyTradingVolume.md +13 -0
- data/docs/ApiResponseCryptoAverageDirectionalIndex.md +13 -0
- data/docs/ApiResponseCryptoAverageTrueRange.md +13 -0
- data/docs/ApiResponseCryptoAwesomeOscillator.md +13 -0
- data/docs/ApiResponseCryptoBollingerBands.md +13 -0
- data/docs/ApiResponseCryptoChaikinMoneyFlow.md +13 -0
- data/docs/ApiResponseCryptoCommodityChannelIndex.md +13 -0
- data/docs/ApiResponseCryptoDetrendedPriceOscillator.md +13 -0
- data/docs/ApiResponseCryptoDonchianChannel.md +13 -0
- data/docs/ApiResponseCryptoEaseOfMovement.md +13 -0
- data/docs/ApiResponseCryptoForceIndex.md +13 -0
- data/docs/ApiResponseCryptoIchimokuKinkoHyo.md +13 -0
- data/docs/ApiResponseCryptoKeltnerChannel.md +13 -0
- data/docs/ApiResponseCryptoKnowSureThing.md +13 -0
- data/docs/ApiResponseCryptoMassIndex.md +13 -0
- data/docs/ApiResponseCryptoMoneyFlowIndex.md +13 -0
- data/docs/ApiResponseCryptoMovingAverageConvergenceDivergence.md +13 -0
- data/docs/ApiResponseCryptoNegativeVolumeIndex.md +13 -0
- data/docs/ApiResponseCryptoOnBalanceVolume.md +13 -0
- data/docs/ApiResponseCryptoOnBalanceVolumeMean.md +13 -0
- data/docs/ApiResponseCryptoRelativeStrengthIndex.md +13 -0
- data/docs/ApiResponseCryptoSimpleMovingAverage.md +13 -0
- data/docs/ApiResponseCryptoStochasticOscillator.md +13 -0
- data/docs/ApiResponseCryptoTripleExponentialAverage.md +13 -0
- data/docs/ApiResponseCryptoTrueStrengthIndex.md +13 -0
- data/docs/ApiResponseCryptoUltimateOscillator.md +13 -0
- data/docs/ApiResponseCryptoVolumePriceTrend.md +13 -0
- data/docs/ApiResponseCryptoVolumeWeightedAveragePrice.md +13 -0
- data/docs/ApiResponseCryptoVortexIndicator.md +13 -0
- data/docs/ApiResponseCryptoWilliamsR.md +13 -0
- data/docs/ApiResponseOptionsChain.md +1 -1
- data/docs/ApiResponseSecurityZacksAnalystRatings.md +10 -0
- data/docs/ApiResponseSecurityZacksAnalystRatingsSnapshot.md +9 -0
- data/docs/ApiResponseSecurityZacksEPSSurprises.md +10 -0
- data/docs/ApiResponseSecurityZacksSalesSurprises.md +10 -0
- data/docs/ApiResponseZacksAnalystRatings.md +9 -0
- data/docs/ApiResponseZacksEPSSurprises.md +9 -0
- data/docs/ApiResponseZacksSalesSurprises.md +9 -0
- data/docs/Company.md +4 -0
- data/docs/CompanyApi.md +240 -36
- data/docs/CryptoApi.md +2769 -57
- data/docs/CryptoPrice.md +1 -1
- data/docs/DataPointApi.md +44 -10
- data/docs/DataTagApi.md +55 -4
- data/docs/FilingApi.md +128 -9
- data/docs/ForexApi.md +57 -6
- data/docs/Fundamental.md +1 -1
- data/docs/FundamentalsApi.md +68 -0
- data/docs/HistoricalDataApi.md +25 -8
- data/docs/IndexApi.md +331 -25
- data/docs/MunicipalityApi.md +51 -0
- data/docs/OptionsApi.md +74 -6
- data/docs/SecurityApi.md +1108 -78
- data/docs/StockExchangeApi.md +117 -15
- data/docs/TechnicalApi.md +3121 -37
- data/docs/ZacksAnalystRating.md +17 -0
- data/docs/ZacksAnalystRatingSnapshot.md +18 -0
- data/docs/ZacksAnalystRatingSummary.md +16 -0
- data/docs/ZacksApi.md +281 -0
- data/docs/ZacksEPSSurprise.md +24 -0
- data/docs/ZacksEPSSurpriseSummary.md +23 -0
- data/docs/ZacksSalesSurprise.md +24 -0
- data/docs/ZacksSalesSurpriseSummary.md +25 -0
- data/intrinio-sdk.gemspec +1 -1
- data/lib/intrinio-sdk.rb +47 -1
- data/lib/intrinio-sdk/api/company_api.rb +33 -33
- data/lib/intrinio-sdk/api/crypto_api.rb +3108 -8
- data/lib/intrinio-sdk/api/data_point_api.rb +13 -13
- data/lib/intrinio-sdk/api/data_tag_api.rb +5 -5
- data/lib/intrinio-sdk/api/filing_api.rb +9 -9
- data/lib/intrinio-sdk/api/forex_api.rb +7 -6
- data/lib/intrinio-sdk/api/fundamentals_api.rb +1 -1
- data/lib/intrinio-sdk/api/historical_data_api.rb +9 -9
- data/lib/intrinio-sdk/api/index_api.rb +23 -23
- data/lib/intrinio-sdk/api/municipality_api.rb +1 -1
- data/lib/intrinio-sdk/api/options_api.rb +7 -7
- data/lib/intrinio-sdk/api/security_api.rb +393 -42
- data/lib/intrinio-sdk/api/stock_exchange_api.rb +11 -11
- data/lib/intrinio-sdk/api/technical_api.rb +3108 -12
- data/lib/intrinio-sdk/api/zacks_api.rb +393 -0
- 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 +238 -0
- data/lib/intrinio-sdk/models/api_response_crypto_average_daily_trading_volume.rb +238 -0
- data/lib/intrinio-sdk/models/api_response_crypto_average_directional_index.rb +238 -0
- data/lib/intrinio-sdk/models/api_response_crypto_average_true_range.rb +238 -0
- data/lib/intrinio-sdk/models/api_response_crypto_awesome_oscillator.rb +238 -0
- data/lib/intrinio-sdk/models/api_response_crypto_bollinger_bands.rb +238 -0
- 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 +238 -0
- data/lib/intrinio-sdk/models/api_response_crypto_commodity_channel_index.rb +238 -0
- data/lib/intrinio-sdk/models/api_response_crypto_currencies.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_detrended_price_oscillator.rb +238 -0
- data/lib/intrinio-sdk/models/api_response_crypto_donchian_channel.rb +238 -0
- data/lib/intrinio-sdk/models/api_response_crypto_ease_of_movement.rb +238 -0
- data/lib/intrinio-sdk/models/api_response_crypto_exchanges.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_crypto_force_index.rb +238 -0
- data/lib/intrinio-sdk/models/api_response_crypto_ichimoku_kinko_hyo.rb +238 -0
- data/lib/intrinio-sdk/models/api_response_crypto_keltner_channel.rb +238 -0
- data/lib/intrinio-sdk/models/api_response_crypto_know_sure_thing.rb +238 -0
- data/lib/intrinio-sdk/models/api_response_crypto_mass_index.rb +238 -0
- data/lib/intrinio-sdk/models/api_response_crypto_money_flow_index.rb +238 -0
- data/lib/intrinio-sdk/models/api_response_crypto_moving_average_convergence_divergence.rb +238 -0
- data/lib/intrinio-sdk/models/api_response_crypto_negative_volume_index.rb +238 -0
- data/lib/intrinio-sdk/models/api_response_crypto_on_balance_volume.rb +238 -0
- data/lib/intrinio-sdk/models/api_response_crypto_on_balance_volume_mean.rb +238 -0
- 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 +238 -0
- data/lib/intrinio-sdk/models/api_response_crypto_simple_moving_average.rb +238 -0
- 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 +238 -0
- data/lib/intrinio-sdk/models/api_response_crypto_triple_exponential_average.rb +238 -0
- data/lib/intrinio-sdk/models/api_response_crypto_true_strength_index.rb +238 -0
- data/lib/intrinio-sdk/models/api_response_crypto_ultimate_oscillator.rb +238 -0
- data/lib/intrinio-sdk/models/api_response_crypto_volume_price_trend.rb +238 -0
- data/lib/intrinio-sdk/models/api_response_crypto_volume_weighted_average_price.rb +238 -0
- data/lib/intrinio-sdk/models/api_response_crypto_vortex_indicator.rb +238 -0
- data/lib/intrinio-sdk/models/api_response_crypto_williams_r.rb +238 -0
- 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_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 +9 -9
- 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 +210 -0
- data/lib/intrinio-sdk/models/api_response_security_zacks_analyst_ratings_snapshot.rb +200 -0
- data/lib/intrinio-sdk/models/api_response_security_zacks_eps_surprises.rb +210 -0
- data/lib/intrinio-sdk/models/api_response_security_zacks_sales_surprises.rb +210 -0
- 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 +200 -0
- data/lib/intrinio-sdk/models/api_response_zacks_eps_surprises.rb +201 -0
- data/lib/intrinio-sdk/models/api_response_zacks_sales_surprises.rb +201 -0
- 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 +45 -5
- data/lib/intrinio-sdk/models/company_filing.rb +1 -1
- 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 +2 -2
- 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 +1 -1
- data/lib/intrinio-sdk/models/filing_note.rb +1 -1
- data/lib/intrinio-sdk/models/filing_note_filing.rb +1 -1
- data/lib/intrinio-sdk/models/filing_note_summary.rb +1 -1
- data/lib/intrinio-sdk/models/filing_summary.rb +1 -1
- 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 +2 -2
- 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 +1 -1
- 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 +1 -1
- 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 +279 -0
- data/lib/intrinio-sdk/models/zacks_analyst_rating_snapshot.rb +289 -0
- data/lib/intrinio-sdk/models/zacks_analyst_rating_summary.rb +269 -0
- data/lib/intrinio-sdk/models/zacks_eps_surprise.rb +349 -0
- data/lib/intrinio-sdk/models/zacks_eps_surprise_summary.rb +339 -0
- data/lib/intrinio-sdk/models/zacks_sales_surprise.rb +349 -0
- data/lib/intrinio-sdk/models/zacks_sales_surprise_summary.rb +359 -0
- data/lib/intrinio-sdk/version.rb +2 -2
- data/spec/api/company_api_spec.rb +17 -17
- data/spec/api/crypto_api_spec.rb +741 -4
- data/spec/api/data_point_api_spec.rb +7 -7
- data/spec/api/data_tag_api_spec.rb +3 -3
- data/spec/api/filing_api_spec.rb +5 -5
- data/spec/api/forex_api_spec.rb +3 -3
- data/spec/api/fundamentals_api_spec.rb +1 -1
- data/spec/api/historical_data_api_spec.rb +5 -5
- data/spec/api/index_api_spec.rb +12 -12
- data/spec/api/municipality_api_spec.rb +1 -1
- data/spec/api/options_api_spec.rb +4 -4
- data/spec/api/security_api_spec.rb +88 -19
- data/spec/api/stock_exchange_api_spec.rb +6 -6
- data/spec/api/technical_api_spec.rb +740 -4
- data/spec/api/zacks_api_spec.rb +119 -0
- 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 +72 -0
- data/spec/models/api_response_crypto_average_daily_trading_volume_spec.rb +72 -0
- data/spec/models/api_response_crypto_average_directional_index_spec.rb +72 -0
- data/spec/models/api_response_crypto_average_true_range_spec.rb +72 -0
- data/spec/models/api_response_crypto_awesome_oscillator_spec.rb +72 -0
- data/spec/models/api_response_crypto_bollinger_bands_spec.rb +72 -0
- 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 +72 -0
- data/spec/models/api_response_crypto_commodity_channel_index_spec.rb +72 -0
- data/spec/models/api_response_crypto_currencies_spec.rb +1 -1
- data/spec/models/api_response_crypto_detrended_price_oscillator_spec.rb +72 -0
- data/spec/models/api_response_crypto_donchian_channel_spec.rb +72 -0
- data/spec/models/api_response_crypto_ease_of_movement_spec.rb +72 -0
- data/spec/models/api_response_crypto_exchanges_spec.rb +1 -1
- data/spec/models/api_response_crypto_force_index_spec.rb +72 -0
- data/spec/models/api_response_crypto_ichimoku_kinko_hyo_spec.rb +72 -0
- data/spec/models/api_response_crypto_keltner_channel_spec.rb +72 -0
- data/spec/models/api_response_crypto_know_sure_thing_spec.rb +72 -0
- data/spec/models/api_response_crypto_mass_index_spec.rb +72 -0
- data/spec/models/api_response_crypto_money_flow_index_spec.rb +72 -0
- data/spec/models/api_response_crypto_moving_average_convergence_divergence_spec.rb +72 -0
- data/spec/models/api_response_crypto_negative_volume_index_spec.rb +72 -0
- data/spec/models/api_response_crypto_on_balance_volume_mean_spec.rb +72 -0
- data/spec/models/api_response_crypto_on_balance_volume_spec.rb +72 -0
- 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 +72 -0
- data/spec/models/api_response_crypto_simple_moving_average_spec.rb +72 -0
- 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 +72 -0
- data/spec/models/api_response_crypto_triple_exponential_average_spec.rb +72 -0
- data/spec/models/api_response_crypto_true_strength_index_spec.rb +72 -0
- data/spec/models/api_response_crypto_ultimate_oscillator_spec.rb +72 -0
- data/spec/models/api_response_crypto_volume_price_trend_spec.rb +72 -0
- data/spec/models/api_response_crypto_volume_weighted_average_price_spec.rb +72 -0
- data/spec/models/api_response_crypto_vortex_indicator_spec.rb +72 -0
- data/spec/models/api_response_crypto_williams_r_spec.rb +72 -0
- 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_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 +2 -2
- 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 +48 -0
- data/spec/models/api_response_security_zacks_analyst_ratings_spec.rb +54 -0
- data/spec/models/api_response_security_zacks_eps_surprises_spec.rb +54 -0
- data/spec/models/api_response_security_zacks_sales_surprises_spec.rb +54 -0
- 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 +48 -0
- data/spec/models/api_response_zacks_eps_surprises_spec.rb +48 -0
- data/spec/models/api_response_zacks_sales_surprises_spec.rb +48 -0
- 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 +25 -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 +102 -0
- data/spec/models/zacks_analyst_rating_spec.rb +96 -0
- data/spec/models/zacks_analyst_rating_summary_spec.rb +90 -0
- data/spec/models/zacks_eps_surprise_spec.rb +138 -0
- data/spec/models/zacks_eps_surprise_summary_spec.rb +132 -0
- data/spec/models/zacks_sales_surprise_spec.rb +138 -0
- data/spec/models/zacks_sales_surprise_summary_spec.rb +144 -0
- data/spec/spec_helper.rb +1 -1
- metadata +186 -2
data/docs/MunicipalityApi.md
CHANGED
|
@@ -9,12 +9,25 @@ Method | HTTP request | Description
|
|
|
9
9
|
[**get_municipality_financials**](MunicipalityApi.md#get_municipality_financials) | **GET** /municipalities/{id}/financials | Financials for a Municipality
|
|
10
10
|
|
|
11
11
|
|
|
12
|
+
|
|
13
|
+
[//]: # (START_OPERTATION)
|
|
14
|
+
|
|
15
|
+
[//]: # (ENDPOINT:/municipalities)
|
|
16
|
+
|
|
17
|
+
[//]: # (DOC_LINK:MunicipalityApi.md#get_all_municipalities)
|
|
18
|
+
|
|
12
19
|
# **get_all_municipalities**
|
|
20
|
+
|
|
21
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_all_municipalities_v2)
|
|
22
|
+
|
|
13
23
|
> ApiResponseMunicipalities get_all_municipalities(opts)
|
|
14
24
|
|
|
15
25
|
All Municipalities
|
|
16
26
|
|
|
17
27
|
### Example
|
|
28
|
+
|
|
29
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
30
|
+
|
|
18
31
|
```ruby
|
|
19
32
|
# Load the gem
|
|
20
33
|
require 'intrinio-sdk'
|
|
@@ -50,6 +63,8 @@ rescue Intrinio::ApiError => e
|
|
|
50
63
|
end
|
|
51
64
|
```
|
|
52
65
|
|
|
66
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
67
|
+
|
|
53
68
|
### Parameters
|
|
54
69
|
|
|
55
70
|
Name | Type | Description | Notes
|
|
@@ -72,7 +87,19 @@ Name | Type | Description | Notes
|
|
|
72
87
|
|
|
73
88
|
[**ApiResponseMunicipalities**](ApiResponseMunicipalities.md)
|
|
74
89
|
|
|
90
|
+
[//]: # (END_OPERATION)
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
[//]: # (START_OPERTATION)
|
|
94
|
+
|
|
95
|
+
[//]: # (ENDPOINT:/municipalities/{id})
|
|
96
|
+
|
|
97
|
+
[//]: # (DOC_LINK:MunicipalityApi.md#get_municipality_by_id)
|
|
98
|
+
|
|
75
99
|
# **get_municipality_by_id**
|
|
100
|
+
|
|
101
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_municipality_by_id_v2)
|
|
102
|
+
|
|
76
103
|
> Municipality get_municipality_by_id(id)
|
|
77
104
|
|
|
78
105
|
Municipality by ID
|
|
@@ -80,6 +107,9 @@ Municipality by ID
|
|
|
80
107
|
Returns the Municipality with the given ID
|
|
81
108
|
|
|
82
109
|
### Example
|
|
110
|
+
|
|
111
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
112
|
+
|
|
83
113
|
```ruby
|
|
84
114
|
# Load the gem
|
|
85
115
|
require 'intrinio-sdk'
|
|
@@ -102,6 +132,8 @@ rescue Intrinio::ApiError => e
|
|
|
102
132
|
end
|
|
103
133
|
```
|
|
104
134
|
|
|
135
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
136
|
+
|
|
105
137
|
### Parameters
|
|
106
138
|
|
|
107
139
|
Name | Type | Description | Notes
|
|
@@ -112,7 +144,19 @@ Name | Type | Description | Notes
|
|
|
112
144
|
|
|
113
145
|
[**Municipality**](Municipality.md)
|
|
114
146
|
|
|
147
|
+
[//]: # (END_OPERATION)
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
[//]: # (START_OPERTATION)
|
|
151
|
+
|
|
152
|
+
[//]: # (ENDPOINT:/municipalities/{id}/financials)
|
|
153
|
+
|
|
154
|
+
[//]: # (DOC_LINK:MunicipalityApi.md#get_municipality_financials)
|
|
155
|
+
|
|
115
156
|
# **get_municipality_financials**
|
|
157
|
+
|
|
158
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_municipality_financials_v2)
|
|
159
|
+
|
|
116
160
|
> ApiResponseMunicipalitiyFinancials get_municipality_financials(id, opts)
|
|
117
161
|
|
|
118
162
|
Financials for a Municipality
|
|
@@ -120,6 +164,9 @@ Financials for a Municipality
|
|
|
120
164
|
Returns financial statement data for the Municipality with the given ID
|
|
121
165
|
|
|
122
166
|
### Example
|
|
167
|
+
|
|
168
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
169
|
+
|
|
123
170
|
```ruby
|
|
124
171
|
# Load the gem
|
|
125
172
|
require 'intrinio-sdk'
|
|
@@ -145,6 +192,8 @@ rescue Intrinio::ApiError => e
|
|
|
145
192
|
end
|
|
146
193
|
```
|
|
147
194
|
|
|
195
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
196
|
+
|
|
148
197
|
### Parameters
|
|
149
198
|
|
|
150
199
|
Name | Type | Description | Notes
|
|
@@ -156,3 +205,5 @@ Name | Type | Description | Notes
|
|
|
156
205
|
|
|
157
206
|
[**ApiResponseMunicipalitiyFinancials**](ApiResponseMunicipalitiyFinancials.md)
|
|
158
207
|
|
|
208
|
+
[//]: # (END_OPERATION)
|
|
209
|
+
|
data/docs/OptionsApi.md
CHANGED
|
@@ -10,7 +10,17 @@ Method | HTTP request | Description
|
|
|
10
10
|
[**get_options_prices**](OptionsApi.md#get_options_prices) | **GET** /options/prices/{identifier} | Option Prices
|
|
11
11
|
|
|
12
12
|
|
|
13
|
+
|
|
14
|
+
[//]: # (START_OPERTATION)
|
|
15
|
+
|
|
16
|
+
[//]: # (ENDPOINT:/options/{symbol})
|
|
17
|
+
|
|
18
|
+
[//]: # (DOC_LINK:OptionsApi.md#get_options)
|
|
19
|
+
|
|
13
20
|
# **get_options**
|
|
21
|
+
|
|
22
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_options_v2)
|
|
23
|
+
|
|
14
24
|
> ApiResponseOptions get_options(symbol, opts)
|
|
15
25
|
|
|
16
26
|
Options
|
|
@@ -18,6 +28,9 @@ Options
|
|
|
18
28
|
Returns the master list of option contracts for a given symbol.
|
|
19
29
|
|
|
20
30
|
### Example
|
|
31
|
+
|
|
32
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
33
|
+
|
|
21
34
|
```ruby
|
|
22
35
|
# Load the gem
|
|
23
36
|
require 'intrinio-sdk'
|
|
@@ -39,7 +52,7 @@ opts = {
|
|
|
39
52
|
expiration: "2019-03-01", # String | The expiration date of the option contract. This will return options contracts with expiration dates on this date.
|
|
40
53
|
expiration_after: "2019-01-01", # String | The expiration date of the option contract. This will return options contracts with expiration dates after this date.
|
|
41
54
|
expiration_before: "2019-12-31", # String | The expiration date of the option contract. This will return options contracts with expiration dates before this date.
|
|
42
|
-
page_size: 100, #
|
|
55
|
+
page_size: 100, # Integer | The number of results to return
|
|
43
56
|
next_page: nil # String | Gets the next page of data from a previous API call
|
|
44
57
|
}
|
|
45
58
|
|
|
@@ -51,6 +64,8 @@ rescue Intrinio::ApiError => e
|
|
|
51
64
|
end
|
|
52
65
|
```
|
|
53
66
|
|
|
67
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
68
|
+
|
|
54
69
|
### Parameters
|
|
55
70
|
|
|
56
71
|
Name | Type | Description | Notes
|
|
@@ -63,14 +78,26 @@ Name | Type | Description | Notes
|
|
|
63
78
|
**expiration** | **String**| The expiration date of the option contract. This will return options contracts with expiration dates on this date. | [optional]
|
|
64
79
|
**expiration_after** | **String**| The expiration date of the option contract. This will return options contracts with expiration dates after this date. | [optional]
|
|
65
80
|
**expiration_before** | **String**| The expiration date of the option contract. This will return options contracts with expiration dates before this date. | [optional]
|
|
66
|
-
**page_size** | **
|
|
81
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
67
82
|
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
68
83
|
|
|
69
84
|
### Return type
|
|
70
85
|
|
|
71
86
|
[**ApiResponseOptions**](ApiResponseOptions.md)
|
|
72
87
|
|
|
88
|
+
[//]: # (END_OPERATION)
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
[//]: # (START_OPERTATION)
|
|
92
|
+
|
|
93
|
+
[//]: # (ENDPOINT:/options/chain/{symbol}/{expiration})
|
|
94
|
+
|
|
95
|
+
[//]: # (DOC_LINK:OptionsApi.md#get_options_chain)
|
|
96
|
+
|
|
73
97
|
# **get_options_chain**
|
|
98
|
+
|
|
99
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_options_chain_v2)
|
|
100
|
+
|
|
74
101
|
> ApiResponseOptionsChain get_options_chain(symbol, expiration, opts)
|
|
75
102
|
|
|
76
103
|
Options Chain
|
|
@@ -78,6 +105,9 @@ Options Chain
|
|
|
78
105
|
Returns all options contracts and their prices for the given symbol and expiration date.
|
|
79
106
|
|
|
80
107
|
### Example
|
|
108
|
+
|
|
109
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
110
|
+
|
|
81
111
|
```ruby
|
|
82
112
|
# Load the gem
|
|
83
113
|
require 'intrinio-sdk'
|
|
@@ -99,7 +129,7 @@ opts = {
|
|
|
99
129
|
strike_greater_than: 190.0, # Float | The strike price of the option contract. This will return options contracts with strike prices greater than this price.
|
|
100
130
|
strike_less_than: 150.0, # Float | The strike price of the option contract. This will return options contracts with strike prices less than this price.
|
|
101
131
|
moneyness: "in_the_money", # String | The moneyness of the options contracts to return. 'all' will return all options contracts. 'in_the_money' will return options contracts that are in the money (call options with strike prices below the current price, put options with strike prices above the current price). 'out_of_they_money' will return options contracts that are out of the money (call options with strike prices above the current price, put options with strike prices below the current price). 'near_the_money' will return options contracts that are $0.50 or less away from being in the money.
|
|
102
|
-
page_size: 100 #
|
|
132
|
+
page_size: 100 # Integer | The number of results to return
|
|
103
133
|
}
|
|
104
134
|
|
|
105
135
|
begin
|
|
@@ -110,6 +140,8 @@ rescue Intrinio::ApiError => e
|
|
|
110
140
|
end
|
|
111
141
|
```
|
|
112
142
|
|
|
143
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
144
|
+
|
|
113
145
|
### Parameters
|
|
114
146
|
|
|
115
147
|
Name | Type | Description | Notes
|
|
@@ -121,13 +153,25 @@ Name | Type | Description | Notes
|
|
|
121
153
|
**strike_greater_than** | **Float**| The strike price of the option contract. This will return options contracts with strike prices greater than this price. | [optional]
|
|
122
154
|
**strike_less_than** | **Float**| The strike price of the option contract. This will return options contracts with strike prices less than this price. | [optional]
|
|
123
155
|
**moneyness** | **String**| The moneyness of the options contracts to return. 'all' will return all options contracts. 'in_the_money' will return options contracts that are in the money (call options with strike prices below the current price, put options with strike prices above the current price). 'out_of_they_money' will return options contracts that are out of the money (call options with strike prices above the current price, put options with strike prices below the current price). 'near_the_money' will return options contracts that are $0.50 or less away from being in the money. | [optional]
|
|
124
|
-
**page_size** | **
|
|
156
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
125
157
|
|
|
126
158
|
### Return type
|
|
127
159
|
|
|
128
160
|
[**ApiResponseOptionsChain**](ApiResponseOptionsChain.md)
|
|
129
161
|
|
|
162
|
+
[//]: # (END_OPERATION)
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
[//]: # (START_OPERTATION)
|
|
166
|
+
|
|
167
|
+
[//]: # (ENDPOINT:/options/expirations/{symbol})
|
|
168
|
+
|
|
169
|
+
[//]: # (DOC_LINK:OptionsApi.md#get_options_expirations)
|
|
170
|
+
|
|
130
171
|
# **get_options_expirations**
|
|
172
|
+
|
|
173
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_options_expirations_v2)
|
|
174
|
+
|
|
131
175
|
> ApiResponseOptionsExpirations get_options_expirations(symbol, opts)
|
|
132
176
|
|
|
133
177
|
Options Expirations
|
|
@@ -135,6 +179,9 @@ Options Expirations
|
|
|
135
179
|
Returns all option contract expiration dates for a given symbol.
|
|
136
180
|
|
|
137
181
|
### Example
|
|
182
|
+
|
|
183
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
184
|
+
|
|
138
185
|
```ruby
|
|
139
186
|
# Load the gem
|
|
140
187
|
require 'intrinio-sdk'
|
|
@@ -161,6 +208,8 @@ rescue Intrinio::ApiError => e
|
|
|
161
208
|
end
|
|
162
209
|
```
|
|
163
210
|
|
|
211
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
212
|
+
|
|
164
213
|
### Parameters
|
|
165
214
|
|
|
166
215
|
Name | Type | Description | Notes
|
|
@@ -173,7 +222,19 @@ Name | Type | Description | Notes
|
|
|
173
222
|
|
|
174
223
|
[**ApiResponseOptionsExpirations**](ApiResponseOptionsExpirations.md)
|
|
175
224
|
|
|
225
|
+
[//]: # (END_OPERATION)
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
[//]: # (START_OPERTATION)
|
|
229
|
+
|
|
230
|
+
[//]: # (ENDPOINT:/options/prices/{identifier})
|
|
231
|
+
|
|
232
|
+
[//]: # (DOC_LINK:OptionsApi.md#get_options_prices)
|
|
233
|
+
|
|
176
234
|
# **get_options_prices**
|
|
235
|
+
|
|
236
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_options_prices_v2)
|
|
237
|
+
|
|
177
238
|
> ApiResponseOptionPrices get_options_prices(identifier, opts)
|
|
178
239
|
|
|
179
240
|
Option Prices
|
|
@@ -181,6 +242,9 @@ Option Prices
|
|
|
181
242
|
Returns all option prices for a given option contract identifier.
|
|
182
243
|
|
|
183
244
|
### Example
|
|
245
|
+
|
|
246
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
247
|
+
|
|
184
248
|
```ruby
|
|
185
249
|
# Load the gem
|
|
186
250
|
require 'intrinio-sdk'
|
|
@@ -197,7 +261,7 @@ identifier = "null" # String | The Intrinio ID or code of the options contract t
|
|
|
197
261
|
opts = {
|
|
198
262
|
start_date: "2019-01-01", # String | Return option contract prices on or after this date.
|
|
199
263
|
end_date: "2019-12-31", # String | Return option contract prices on or before this date.
|
|
200
|
-
page_size: 100, #
|
|
264
|
+
page_size: 100, # Integer | The number of results to return
|
|
201
265
|
next_page: nil # String | Gets the next page of data from a previous API call
|
|
202
266
|
}
|
|
203
267
|
|
|
@@ -209,6 +273,8 @@ rescue Intrinio::ApiError => e
|
|
|
209
273
|
end
|
|
210
274
|
```
|
|
211
275
|
|
|
276
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
277
|
+
|
|
212
278
|
### Parameters
|
|
213
279
|
|
|
214
280
|
Name | Type | Description | Notes
|
|
@@ -216,10 +282,12 @@ Name | Type | Description | Notes
|
|
|
216
282
|
**identifier** | **String**| The Intrinio ID or code of the options contract to request prices for. |
|
|
217
283
|
**start_date** | **String**| Return option contract prices on or after this date. | [optional]
|
|
218
284
|
**end_date** | **String**| Return option contract prices on or before this date. | [optional]
|
|
219
|
-
**page_size** | **
|
|
285
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
220
286
|
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
221
287
|
|
|
222
288
|
### Return type
|
|
223
289
|
|
|
224
290
|
[**ApiResponseOptionPrices**](ApiResponseOptionPrices.md)
|
|
225
291
|
|
|
292
|
+
[//]: # (END_OPERATION)
|
|
293
|
+
|
data/docs/SecurityApi.md
CHANGED
|
@@ -46,11 +46,25 @@ Method | HTTP request | Description
|
|
|
46
46
|
[**get_security_realtime_price**](SecurityApi.md#get_security_realtime_price) | **GET** /securities/{identifier}/prices/realtime | Realtime Stock Price for Security
|
|
47
47
|
[**get_security_stock_price_adjustments**](SecurityApi.md#get_security_stock_price_adjustments) | **GET** /securities/{identifier}/prices/adjustments | Stock Price Adjustments by Security
|
|
48
48
|
[**get_security_stock_prices**](SecurityApi.md#get_security_stock_prices) | **GET** /securities/{identifier}/prices | Stock Prices by Security
|
|
49
|
+
[**get_security_zacks_analyst_ratings**](SecurityApi.md#get_security_zacks_analyst_ratings) | **GET** /securities/{identifier}/zacks/analyst_ratings | Zacks Analyst Ratings
|
|
50
|
+
[**get_security_zacks_analyst_ratings_snapshot**](SecurityApi.md#get_security_zacks_analyst_ratings_snapshot) | **GET** /securities/{identifier}/zacks/analyst_ratings/snapshot | Zacks Analyst Ratings Snapshot
|
|
51
|
+
[**get_security_zacks_eps_surprises**](SecurityApi.md#get_security_zacks_eps_surprises) | **GET** /securities/{identifier}/zacks/eps_surprises | Zacks EPS Surprises for Security
|
|
52
|
+
[**get_security_zacks_sales_surprises**](SecurityApi.md#get_security_zacks_sales_surprises) | **GET** /securities/{identifier}/zacks/sales_surprises | Zacks Sales Surprises for Security
|
|
49
53
|
[**screen_securities**](SecurityApi.md#screen_securities) | **POST** /securities/screen | Screen Securities
|
|
50
54
|
[**search_securities**](SecurityApi.md#search_securities) | **GET** /securities/search | Search Securities
|
|
51
55
|
|
|
52
56
|
|
|
57
|
+
|
|
58
|
+
[//]: # (START_OPERTATION)
|
|
59
|
+
|
|
60
|
+
[//]: # (ENDPOINT:/securities)
|
|
61
|
+
|
|
62
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_all_securities)
|
|
63
|
+
|
|
53
64
|
# **get_all_securities**
|
|
65
|
+
|
|
66
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_all_securities_v2)
|
|
67
|
+
|
|
54
68
|
> ApiResponseSecurities get_all_securities(opts)
|
|
55
69
|
|
|
56
70
|
All Securities
|
|
@@ -58,6 +72,9 @@ All Securities
|
|
|
58
72
|
Returns all Securities to which you have access.
|
|
59
73
|
|
|
60
74
|
### Example
|
|
75
|
+
|
|
76
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
77
|
+
|
|
61
78
|
```ruby
|
|
62
79
|
# Load the gem
|
|
63
80
|
require 'intrinio-sdk'
|
|
@@ -70,7 +87,7 @@ end
|
|
|
70
87
|
security_api = Intrinio::SecurityApi.new
|
|
71
88
|
|
|
72
89
|
opts = {
|
|
73
|
-
page_size: 100, #
|
|
90
|
+
page_size: 100, # Integer | The number of results to return
|
|
74
91
|
next_page: nil # String | Gets the next page of data from a previous API call
|
|
75
92
|
}
|
|
76
93
|
|
|
@@ -82,18 +99,32 @@ rescue Intrinio::ApiError => e
|
|
|
82
99
|
end
|
|
83
100
|
```
|
|
84
101
|
|
|
102
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
103
|
+
|
|
85
104
|
### Parameters
|
|
86
105
|
|
|
87
106
|
Name | Type | Description | Notes
|
|
88
107
|
------------- | ------------- | ------------- | -------------
|
|
89
|
-
**page_size** | **
|
|
108
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
90
109
|
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
91
110
|
|
|
92
111
|
### Return type
|
|
93
112
|
|
|
94
113
|
[**ApiResponseSecurities**](ApiResponseSecurities.md)
|
|
95
114
|
|
|
115
|
+
[//]: # (END_OPERATION)
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
[//]: # (START_OPERTATION)
|
|
119
|
+
|
|
120
|
+
[//]: # (ENDPOINT:/securities/{identifier})
|
|
121
|
+
|
|
122
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_by_id)
|
|
123
|
+
|
|
96
124
|
# **get_security_by_id**
|
|
125
|
+
|
|
126
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_by_id_v2)
|
|
127
|
+
|
|
97
128
|
> Security get_security_by_id(identifier)
|
|
98
129
|
|
|
99
130
|
Lookup Security
|
|
@@ -101,6 +132,9 @@ Lookup Security
|
|
|
101
132
|
Returns the Security with the given `identifier`
|
|
102
133
|
|
|
103
134
|
### Example
|
|
135
|
+
|
|
136
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
137
|
+
|
|
104
138
|
```ruby
|
|
105
139
|
# Load the gem
|
|
106
140
|
require 'intrinio-sdk'
|
|
@@ -112,7 +146,7 @@ end
|
|
|
112
146
|
|
|
113
147
|
security_api = Intrinio::SecurityApi.new
|
|
114
148
|
|
|
115
|
-
identifier = "
|
|
149
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
116
150
|
|
|
117
151
|
|
|
118
152
|
begin
|
|
@@ -123,6 +157,8 @@ rescue Intrinio::ApiError => e
|
|
|
123
157
|
end
|
|
124
158
|
```
|
|
125
159
|
|
|
160
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
161
|
+
|
|
126
162
|
### Parameters
|
|
127
163
|
|
|
128
164
|
Name | Type | Description | Notes
|
|
@@ -133,14 +169,29 @@ Name | Type | Description | Notes
|
|
|
133
169
|
|
|
134
170
|
[**Security**](Security.md)
|
|
135
171
|
|
|
172
|
+
[//]: # (END_OPERATION)
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
[//]: # (START_OPERTATION)
|
|
176
|
+
|
|
177
|
+
[//]: # (ENDPOINT:/securities/{identifier}/data_point/{tag}/number)
|
|
178
|
+
|
|
179
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_data_point_number)
|
|
180
|
+
|
|
136
181
|
# **get_security_data_point_number**
|
|
182
|
+
|
|
183
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_data_point_number_v2)
|
|
184
|
+
|
|
137
185
|
> Float get_security_data_point_number(identifier, tag)
|
|
138
186
|
|
|
139
187
|
Data Point (Number) for Security
|
|
140
188
|
|
|
141
|
-
|
|
189
|
+
Returns a numeric value for the given `tag` for the Security with the given `identifier`
|
|
142
190
|
|
|
143
191
|
### Example
|
|
192
|
+
|
|
193
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
194
|
+
|
|
144
195
|
```ruby
|
|
145
196
|
# Load the gem
|
|
146
197
|
require 'intrinio-sdk'
|
|
@@ -152,9 +203,9 @@ end
|
|
|
152
203
|
|
|
153
204
|
security_api = Intrinio::SecurityApi.new
|
|
154
205
|
|
|
155
|
-
identifier = "
|
|
206
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
156
207
|
|
|
157
|
-
tag = "
|
|
208
|
+
tag = "close_price" # String | An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>)
|
|
158
209
|
|
|
159
210
|
|
|
160
211
|
begin
|
|
@@ -165,25 +216,42 @@ rescue Intrinio::ApiError => e
|
|
|
165
216
|
end
|
|
166
217
|
```
|
|
167
218
|
|
|
219
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
220
|
+
|
|
168
221
|
### Parameters
|
|
169
222
|
|
|
170
223
|
Name | Type | Description | Notes
|
|
171
224
|
------------- | ------------- | ------------- | -------------
|
|
172
|
-
**identifier** | **String**|
|
|
173
|
-
**tag** | **String**|
|
|
225
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
226
|
+
**tag** | **String**| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |
|
|
174
227
|
|
|
175
228
|
### Return type
|
|
176
229
|
|
|
177
230
|
**Float**
|
|
178
231
|
|
|
232
|
+
[//]: # (END_OPERATION)
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
[//]: # (START_OPERTATION)
|
|
236
|
+
|
|
237
|
+
[//]: # (ENDPOINT:/securities/{identifier}/data_point/{tag}/text)
|
|
238
|
+
|
|
239
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_data_point_text)
|
|
240
|
+
|
|
179
241
|
# **get_security_data_point_text**
|
|
242
|
+
|
|
243
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_data_point_text_v2)
|
|
244
|
+
|
|
180
245
|
> String get_security_data_point_text(identifier, tag)
|
|
181
246
|
|
|
182
247
|
Data Point (Text) for Security
|
|
183
248
|
|
|
184
|
-
|
|
249
|
+
Returns a text value for the given `tag` for the Security with the given `identifier`
|
|
185
250
|
|
|
186
251
|
### Example
|
|
252
|
+
|
|
253
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
254
|
+
|
|
187
255
|
```ruby
|
|
188
256
|
# Load the gem
|
|
189
257
|
require 'intrinio-sdk'
|
|
@@ -195,9 +263,9 @@ end
|
|
|
195
263
|
|
|
196
264
|
security_api = Intrinio::SecurityApi.new
|
|
197
265
|
|
|
198
|
-
identifier = "
|
|
266
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
199
267
|
|
|
200
|
-
tag = "
|
|
268
|
+
tag = "figi" # String | An Intrinio data tag ID or code-name
|
|
201
269
|
|
|
202
270
|
|
|
203
271
|
begin
|
|
@@ -208,25 +276,42 @@ rescue Intrinio::ApiError => e
|
|
|
208
276
|
end
|
|
209
277
|
```
|
|
210
278
|
|
|
279
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
280
|
+
|
|
211
281
|
### Parameters
|
|
212
282
|
|
|
213
283
|
Name | Type | Description | Notes
|
|
214
284
|
------------- | ------------- | ------------- | -------------
|
|
215
|
-
**identifier** | **String**|
|
|
285
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
216
286
|
**tag** | **String**| An Intrinio data tag ID or code-name |
|
|
217
287
|
|
|
218
288
|
### Return type
|
|
219
289
|
|
|
220
290
|
**String**
|
|
221
291
|
|
|
292
|
+
[//]: # (END_OPERATION)
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
[//]: # (START_OPERTATION)
|
|
296
|
+
|
|
297
|
+
[//]: # (ENDPOINT:/securities/{identifier}/historical_data/{tag})
|
|
298
|
+
|
|
299
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_historical_data)
|
|
300
|
+
|
|
222
301
|
# **get_security_historical_data**
|
|
302
|
+
|
|
303
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_historical_data_v2)
|
|
304
|
+
|
|
223
305
|
> ApiResponseSecurityHistoricalData get_security_historical_data(identifier, tag, opts)
|
|
224
306
|
|
|
225
307
|
Historical Data for Security
|
|
226
308
|
|
|
227
|
-
|
|
309
|
+
Returns historical values for the given `tag` and the Security with the given `identifier`
|
|
228
310
|
|
|
229
311
|
### Example
|
|
312
|
+
|
|
313
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
314
|
+
|
|
230
315
|
```ruby
|
|
231
316
|
# Load the gem
|
|
232
317
|
require 'intrinio-sdk'
|
|
@@ -238,17 +323,17 @@ end
|
|
|
238
323
|
|
|
239
324
|
security_api = Intrinio::SecurityApi.new
|
|
240
325
|
|
|
241
|
-
identifier = "
|
|
326
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
242
327
|
|
|
243
|
-
tag = "
|
|
328
|
+
tag = "adj_close_price" # String | An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>)
|
|
244
329
|
|
|
245
330
|
opts = {
|
|
246
331
|
frequency: "daily", # String | Return historical data in the given frequency
|
|
247
332
|
type: nil, # String | Filter by type, when applicable
|
|
248
333
|
start_date: Date.parse("2018-01-01"), # Date | Get historical data on or after this date
|
|
249
|
-
end_date:
|
|
334
|
+
end_date: nil, # Date | Get historical date on or before this date
|
|
250
335
|
sort_order: "desc", # String | Sort by date `asc` or `desc`
|
|
251
|
-
page_size: 100, #
|
|
336
|
+
page_size: 100, # Integer | The number of results to return
|
|
252
337
|
next_page: nil # String | Gets the next page of data from a previous API call
|
|
253
338
|
}
|
|
254
339
|
|
|
@@ -260,32 +345,49 @@ rescue Intrinio::ApiError => e
|
|
|
260
345
|
end
|
|
261
346
|
```
|
|
262
347
|
|
|
348
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
349
|
+
|
|
263
350
|
### Parameters
|
|
264
351
|
|
|
265
352
|
Name | Type | Description | Notes
|
|
266
353
|
------------- | ------------- | ------------- | -------------
|
|
267
|
-
**identifier** | **String**|
|
|
268
|
-
**tag** | **String**|
|
|
354
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
355
|
+
**tag** | **String**| An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) |
|
|
269
356
|
**frequency** | **String**| Return historical data in the given frequency | [optional] [default to daily]
|
|
270
357
|
**type** | **String**| Filter by type, when applicable | [optional]
|
|
271
358
|
**start_date** | **Date**| Get historical data on or after this date | [optional]
|
|
272
359
|
**end_date** | **Date**| Get historical date on or before this date | [optional]
|
|
273
360
|
**sort_order** | **String**| Sort by date `asc` or `desc` | [optional] [default to desc]
|
|
274
|
-
**page_size** | **
|
|
361
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
275
362
|
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
276
363
|
|
|
277
364
|
### Return type
|
|
278
365
|
|
|
279
366
|
[**ApiResponseSecurityHistoricalData**](ApiResponseSecurityHistoricalData.md)
|
|
280
367
|
|
|
368
|
+
[//]: # (END_OPERATION)
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
[//]: # (START_OPERTATION)
|
|
372
|
+
|
|
373
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/intraday)
|
|
374
|
+
|
|
375
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_intraday_prices)
|
|
376
|
+
|
|
281
377
|
# **get_security_intraday_prices**
|
|
378
|
+
|
|
379
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_intraday_prices_v2)
|
|
380
|
+
|
|
282
381
|
> ApiResponseSecurityIntradayPrices get_security_intraday_prices(identifier, opts)
|
|
283
382
|
|
|
284
383
|
Intraday Stock Prices for Security
|
|
285
384
|
|
|
286
|
-
|
|
385
|
+
Return intraday stock prices for the Security with the given `identifier`
|
|
287
386
|
|
|
288
387
|
### Example
|
|
388
|
+
|
|
389
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
390
|
+
|
|
289
391
|
```ruby
|
|
290
392
|
# Load the gem
|
|
291
393
|
require 'intrinio-sdk'
|
|
@@ -297,7 +399,7 @@ end
|
|
|
297
399
|
|
|
298
400
|
security_api = Intrinio::SecurityApi.new
|
|
299
401
|
|
|
300
|
-
identifier = "
|
|
402
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
301
403
|
|
|
302
404
|
opts = {
|
|
303
405
|
source: nil, # String | Return intraday prices from the specified data source
|
|
@@ -315,6 +417,8 @@ rescue Intrinio::ApiError => e
|
|
|
315
417
|
end
|
|
316
418
|
```
|
|
317
419
|
|
|
420
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
421
|
+
|
|
318
422
|
### Parameters
|
|
319
423
|
|
|
320
424
|
Name | Type | Description | Notes
|
|
@@ -330,7 +434,19 @@ Name | Type | Description | Notes
|
|
|
330
434
|
|
|
331
435
|
[**ApiResponseSecurityIntradayPrices**](ApiResponseSecurityIntradayPrices.md)
|
|
332
436
|
|
|
437
|
+
[//]: # (END_OPERATION)
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
[//]: # (START_OPERTATION)
|
|
441
|
+
|
|
442
|
+
[//]: # (ENDPOINT:/securities/{identifier}/dividends/latest)
|
|
443
|
+
|
|
444
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_latest_dividend_record)
|
|
445
|
+
|
|
333
446
|
# **get_security_latest_dividend_record**
|
|
447
|
+
|
|
448
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_latest_dividend_record_v2)
|
|
449
|
+
|
|
334
450
|
> DividendRecord get_security_latest_dividend_record(identifier)
|
|
335
451
|
|
|
336
452
|
Lastest Dividend Record for Security
|
|
@@ -338,6 +454,9 @@ Lastest Dividend Record for Security
|
|
|
338
454
|
Returns the latest available dividend information for the Security with the given `identifier`
|
|
339
455
|
|
|
340
456
|
### Example
|
|
457
|
+
|
|
458
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
459
|
+
|
|
341
460
|
```ruby
|
|
342
461
|
# Load the gem
|
|
343
462
|
require 'intrinio-sdk'
|
|
@@ -349,7 +468,7 @@ end
|
|
|
349
468
|
|
|
350
469
|
security_api = Intrinio::SecurityApi.new
|
|
351
470
|
|
|
352
|
-
identifier = "
|
|
471
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
353
472
|
|
|
354
473
|
|
|
355
474
|
begin
|
|
@@ -360,6 +479,8 @@ rescue Intrinio::ApiError => e
|
|
|
360
479
|
end
|
|
361
480
|
```
|
|
362
481
|
|
|
482
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
483
|
+
|
|
363
484
|
### Parameters
|
|
364
485
|
|
|
365
486
|
Name | Type | Description | Notes
|
|
@@ -370,7 +491,19 @@ Name | Type | Description | Notes
|
|
|
370
491
|
|
|
371
492
|
[**DividendRecord**](DividendRecord.md)
|
|
372
493
|
|
|
494
|
+
[//]: # (END_OPERATION)
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
[//]: # (START_OPERTATION)
|
|
498
|
+
|
|
499
|
+
[//]: # (ENDPOINT:/securities/{identifier}/earnings/latest)
|
|
500
|
+
|
|
501
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_latest_earnings_record)
|
|
502
|
+
|
|
373
503
|
# **get_security_latest_earnings_record**
|
|
504
|
+
|
|
505
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_latest_earnings_record_v2)
|
|
506
|
+
|
|
374
507
|
> EarningsRecord get_security_latest_earnings_record(identifier)
|
|
375
508
|
|
|
376
509
|
Lastest Earnings Record for Security
|
|
@@ -378,6 +511,9 @@ Lastest Earnings Record for Security
|
|
|
378
511
|
Returns latest available earnings information for the Security with the given `identifier`
|
|
379
512
|
|
|
380
513
|
### Example
|
|
514
|
+
|
|
515
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
516
|
+
|
|
381
517
|
```ruby
|
|
382
518
|
# Load the gem
|
|
383
519
|
require 'intrinio-sdk'
|
|
@@ -389,7 +525,7 @@ end
|
|
|
389
525
|
|
|
390
526
|
security_api = Intrinio::SecurityApi.new
|
|
391
527
|
|
|
392
|
-
identifier = "
|
|
528
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
393
529
|
|
|
394
530
|
|
|
395
531
|
begin
|
|
@@ -400,6 +536,8 @@ rescue Intrinio::ApiError => e
|
|
|
400
536
|
end
|
|
401
537
|
```
|
|
402
538
|
|
|
539
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
540
|
+
|
|
403
541
|
### Parameters
|
|
404
542
|
|
|
405
543
|
Name | Type | Description | Notes
|
|
@@ -410,7 +548,19 @@ Name | Type | Description | Notes
|
|
|
410
548
|
|
|
411
549
|
[**EarningsRecord**](EarningsRecord.md)
|
|
412
550
|
|
|
551
|
+
[//]: # (END_OPERATION)
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
[//]: # (START_OPERTATION)
|
|
555
|
+
|
|
556
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/adi)
|
|
557
|
+
|
|
558
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_adi)
|
|
559
|
+
|
|
413
560
|
# **get_security_price_technicals_adi**
|
|
561
|
+
|
|
562
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_adi_v2)
|
|
563
|
+
|
|
414
564
|
> ApiResponseSecurityAccumulationDistributionIndex get_security_price_technicals_adi(identifier, opts)
|
|
415
565
|
|
|
416
566
|
Accumulation/Distribution Index
|
|
@@ -418,6 +568,9 @@ Accumulation/Distribution Index
|
|
|
418
568
|
Returns the Accumulation/Distribution Index values of Stock Prices for the Security with the given `identifier`
|
|
419
569
|
|
|
420
570
|
### Example
|
|
571
|
+
|
|
572
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
573
|
+
|
|
421
574
|
```ruby
|
|
422
575
|
# Load the gem
|
|
423
576
|
require 'intrinio-sdk'
|
|
@@ -429,7 +582,7 @@ end
|
|
|
429
582
|
|
|
430
583
|
security_api = Intrinio::SecurityApi.new
|
|
431
584
|
|
|
432
|
-
identifier = "
|
|
585
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
433
586
|
|
|
434
587
|
opts = {
|
|
435
588
|
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
@@ -446,6 +599,8 @@ rescue Intrinio::ApiError => e
|
|
|
446
599
|
end
|
|
447
600
|
```
|
|
448
601
|
|
|
602
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
603
|
+
|
|
449
604
|
### Parameters
|
|
450
605
|
|
|
451
606
|
Name | Type | Description | Notes
|
|
@@ -460,7 +615,19 @@ Name | Type | Description | Notes
|
|
|
460
615
|
|
|
461
616
|
[**ApiResponseSecurityAccumulationDistributionIndex**](ApiResponseSecurityAccumulationDistributionIndex.md)
|
|
462
617
|
|
|
618
|
+
[//]: # (END_OPERATION)
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
[//]: # (START_OPERTATION)
|
|
622
|
+
|
|
623
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/adtv)
|
|
624
|
+
|
|
625
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_adtv)
|
|
626
|
+
|
|
463
627
|
# **get_security_price_technicals_adtv**
|
|
628
|
+
|
|
629
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_adtv_v2)
|
|
630
|
+
|
|
464
631
|
> ApiResponseSecurityAverageDailyTradingVolume get_security_price_technicals_adtv(identifier, opts)
|
|
465
632
|
|
|
466
633
|
Average Daily Trading Volume
|
|
@@ -468,6 +635,9 @@ Average Daily Trading Volume
|
|
|
468
635
|
Returns the Average Daily Trading Volume values of Stock Prices for the Security with the given `identifier`
|
|
469
636
|
|
|
470
637
|
### Example
|
|
638
|
+
|
|
639
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
640
|
+
|
|
471
641
|
```ruby
|
|
472
642
|
# Load the gem
|
|
473
643
|
require 'intrinio-sdk'
|
|
@@ -479,7 +649,7 @@ end
|
|
|
479
649
|
|
|
480
650
|
security_api = Intrinio::SecurityApi.new
|
|
481
651
|
|
|
482
|
-
identifier = "
|
|
652
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
483
653
|
|
|
484
654
|
opts = {
|
|
485
655
|
period: 22, # Integer | The number of observations, per period, to calculate Average Daily Trading Volume
|
|
@@ -497,6 +667,8 @@ rescue Intrinio::ApiError => e
|
|
|
497
667
|
end
|
|
498
668
|
```
|
|
499
669
|
|
|
670
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
671
|
+
|
|
500
672
|
### Parameters
|
|
501
673
|
|
|
502
674
|
Name | Type | Description | Notes
|
|
@@ -512,7 +684,19 @@ Name | Type | Description | Notes
|
|
|
512
684
|
|
|
513
685
|
[**ApiResponseSecurityAverageDailyTradingVolume**](ApiResponseSecurityAverageDailyTradingVolume.md)
|
|
514
686
|
|
|
687
|
+
[//]: # (END_OPERATION)
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
[//]: # (START_OPERTATION)
|
|
691
|
+
|
|
692
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/adx)
|
|
693
|
+
|
|
694
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_adx)
|
|
695
|
+
|
|
515
696
|
# **get_security_price_technicals_adx**
|
|
697
|
+
|
|
698
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_adx_v2)
|
|
699
|
+
|
|
516
700
|
> ApiResponseSecurityAverageDirectionalIndex get_security_price_technicals_adx(identifier, opts)
|
|
517
701
|
|
|
518
702
|
Average Directional Index
|
|
@@ -520,6 +704,9 @@ Average Directional Index
|
|
|
520
704
|
Returns the Average Directional Index values of Stock Prices for the Security with the given `identifier`
|
|
521
705
|
|
|
522
706
|
### Example
|
|
707
|
+
|
|
708
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
709
|
+
|
|
523
710
|
```ruby
|
|
524
711
|
# Load the gem
|
|
525
712
|
require 'intrinio-sdk'
|
|
@@ -531,7 +718,7 @@ end
|
|
|
531
718
|
|
|
532
719
|
security_api = Intrinio::SecurityApi.new
|
|
533
720
|
|
|
534
|
-
identifier = "
|
|
721
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
535
722
|
|
|
536
723
|
opts = {
|
|
537
724
|
period: 14, # Integer | The number of observations, per period, to calculate Average Directional Index
|
|
@@ -549,6 +736,8 @@ rescue Intrinio::ApiError => e
|
|
|
549
736
|
end
|
|
550
737
|
```
|
|
551
738
|
|
|
739
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
740
|
+
|
|
552
741
|
### Parameters
|
|
553
742
|
|
|
554
743
|
Name | Type | Description | Notes
|
|
@@ -564,7 +753,19 @@ Name | Type | Description | Notes
|
|
|
564
753
|
|
|
565
754
|
[**ApiResponseSecurityAverageDirectionalIndex**](ApiResponseSecurityAverageDirectionalIndex.md)
|
|
566
755
|
|
|
756
|
+
[//]: # (END_OPERATION)
|
|
757
|
+
|
|
758
|
+
|
|
759
|
+
[//]: # (START_OPERTATION)
|
|
760
|
+
|
|
761
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/ao)
|
|
762
|
+
|
|
763
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_ao)
|
|
764
|
+
|
|
567
765
|
# **get_security_price_technicals_ao**
|
|
766
|
+
|
|
767
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_ao_v2)
|
|
768
|
+
|
|
568
769
|
> ApiResponseSecurityAwesomeOscillator get_security_price_technicals_ao(identifier, opts)
|
|
569
770
|
|
|
570
771
|
Awesome Oscillator
|
|
@@ -572,6 +773,9 @@ Awesome Oscillator
|
|
|
572
773
|
Returns the Awesome Oscillator values of Stock Prices for the Security with the given `identifier`
|
|
573
774
|
|
|
574
775
|
### Example
|
|
776
|
+
|
|
777
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
778
|
+
|
|
575
779
|
```ruby
|
|
576
780
|
# Load the gem
|
|
577
781
|
require 'intrinio-sdk'
|
|
@@ -583,7 +787,7 @@ end
|
|
|
583
787
|
|
|
584
788
|
security_api = Intrinio::SecurityApi.new
|
|
585
789
|
|
|
586
|
-
identifier = "
|
|
790
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
587
791
|
|
|
588
792
|
opts = {
|
|
589
793
|
short_period: 5, # Integer | The number of observations, per period, to calculate short period Simple Moving Average of the Awesome Oscillator
|
|
@@ -602,6 +806,8 @@ rescue Intrinio::ApiError => e
|
|
|
602
806
|
end
|
|
603
807
|
```
|
|
604
808
|
|
|
809
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
810
|
+
|
|
605
811
|
### Parameters
|
|
606
812
|
|
|
607
813
|
Name | Type | Description | Notes
|
|
@@ -618,7 +824,19 @@ Name | Type | Description | Notes
|
|
|
618
824
|
|
|
619
825
|
[**ApiResponseSecurityAwesomeOscillator**](ApiResponseSecurityAwesomeOscillator.md)
|
|
620
826
|
|
|
827
|
+
[//]: # (END_OPERATION)
|
|
828
|
+
|
|
829
|
+
|
|
830
|
+
[//]: # (START_OPERTATION)
|
|
831
|
+
|
|
832
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/atr)
|
|
833
|
+
|
|
834
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_atr)
|
|
835
|
+
|
|
621
836
|
# **get_security_price_technicals_atr**
|
|
837
|
+
|
|
838
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_atr_v2)
|
|
839
|
+
|
|
622
840
|
> ApiResponseSecurityAverageTrueRange get_security_price_technicals_atr(identifier, opts)
|
|
623
841
|
|
|
624
842
|
Average True Range
|
|
@@ -626,6 +844,9 @@ Average True Range
|
|
|
626
844
|
Returns the Average True Range values of Stock Prices for the Security with the given `identifier`
|
|
627
845
|
|
|
628
846
|
### Example
|
|
847
|
+
|
|
848
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
849
|
+
|
|
629
850
|
```ruby
|
|
630
851
|
# Load the gem
|
|
631
852
|
require 'intrinio-sdk'
|
|
@@ -637,7 +858,7 @@ end
|
|
|
637
858
|
|
|
638
859
|
security_api = Intrinio::SecurityApi.new
|
|
639
860
|
|
|
640
|
-
identifier = "
|
|
861
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
641
862
|
|
|
642
863
|
opts = {
|
|
643
864
|
period: 14, # Integer | The number of observations, per period, to calculate Average True Range
|
|
@@ -655,6 +876,8 @@ rescue Intrinio::ApiError => e
|
|
|
655
876
|
end
|
|
656
877
|
```
|
|
657
878
|
|
|
879
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
880
|
+
|
|
658
881
|
### Parameters
|
|
659
882
|
|
|
660
883
|
Name | Type | Description | Notes
|
|
@@ -670,7 +893,19 @@ Name | Type | Description | Notes
|
|
|
670
893
|
|
|
671
894
|
[**ApiResponseSecurityAverageTrueRange**](ApiResponseSecurityAverageTrueRange.md)
|
|
672
895
|
|
|
896
|
+
[//]: # (END_OPERATION)
|
|
897
|
+
|
|
898
|
+
|
|
899
|
+
[//]: # (START_OPERTATION)
|
|
900
|
+
|
|
901
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/bb)
|
|
902
|
+
|
|
903
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_bb)
|
|
904
|
+
|
|
673
905
|
# **get_security_price_technicals_bb**
|
|
906
|
+
|
|
907
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_bb_v2)
|
|
908
|
+
|
|
674
909
|
> ApiResponseSecurityBollingerBands get_security_price_technicals_bb(identifier, opts)
|
|
675
910
|
|
|
676
911
|
Bollinger Bands
|
|
@@ -678,6 +913,9 @@ Bollinger Bands
|
|
|
678
913
|
Returns the Bollinger Bands values of Stock Prices for the Security with the given `identifier`
|
|
679
914
|
|
|
680
915
|
### Example
|
|
916
|
+
|
|
917
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
918
|
+
|
|
681
919
|
```ruby
|
|
682
920
|
# Load the gem
|
|
683
921
|
require 'intrinio-sdk'
|
|
@@ -689,7 +927,7 @@ end
|
|
|
689
927
|
|
|
690
928
|
security_api = Intrinio::SecurityApi.new
|
|
691
929
|
|
|
692
|
-
identifier = "
|
|
930
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
693
931
|
|
|
694
932
|
opts = {
|
|
695
933
|
period: 20, # Integer | The number of observations, per period, to calculate Bollinger Bands
|
|
@@ -709,6 +947,8 @@ rescue Intrinio::ApiError => e
|
|
|
709
947
|
end
|
|
710
948
|
```
|
|
711
949
|
|
|
950
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
951
|
+
|
|
712
952
|
### Parameters
|
|
713
953
|
|
|
714
954
|
Name | Type | Description | Notes
|
|
@@ -726,7 +966,19 @@ Name | Type | Description | Notes
|
|
|
726
966
|
|
|
727
967
|
[**ApiResponseSecurityBollingerBands**](ApiResponseSecurityBollingerBands.md)
|
|
728
968
|
|
|
969
|
+
[//]: # (END_OPERATION)
|
|
970
|
+
|
|
971
|
+
|
|
972
|
+
[//]: # (START_OPERTATION)
|
|
973
|
+
|
|
974
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/cci)
|
|
975
|
+
|
|
976
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_cci)
|
|
977
|
+
|
|
729
978
|
# **get_security_price_technicals_cci**
|
|
979
|
+
|
|
980
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_cci_v2)
|
|
981
|
+
|
|
730
982
|
> ApiResponseSecurityCommodityChannelIndex get_security_price_technicals_cci(identifier, opts)
|
|
731
983
|
|
|
732
984
|
Commodity Channel Index
|
|
@@ -734,6 +986,9 @@ Commodity Channel Index
|
|
|
734
986
|
Returns the Commodity Channel Index values of Stock Prices for the Security with the given `identifier`
|
|
735
987
|
|
|
736
988
|
### Example
|
|
989
|
+
|
|
990
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
991
|
+
|
|
737
992
|
```ruby
|
|
738
993
|
# Load the gem
|
|
739
994
|
require 'intrinio-sdk'
|
|
@@ -745,7 +1000,7 @@ end
|
|
|
745
1000
|
|
|
746
1001
|
security_api = Intrinio::SecurityApi.new
|
|
747
1002
|
|
|
748
|
-
identifier = "
|
|
1003
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
749
1004
|
|
|
750
1005
|
opts = {
|
|
751
1006
|
period: 20, # Integer | The number of observations, per period, to calculate Commodity Channel Index
|
|
@@ -764,6 +1019,8 @@ rescue Intrinio::ApiError => e
|
|
|
764
1019
|
end
|
|
765
1020
|
```
|
|
766
1021
|
|
|
1022
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
1023
|
+
|
|
767
1024
|
### Parameters
|
|
768
1025
|
|
|
769
1026
|
Name | Type | Description | Notes
|
|
@@ -780,7 +1037,19 @@ Name | Type | Description | Notes
|
|
|
780
1037
|
|
|
781
1038
|
[**ApiResponseSecurityCommodityChannelIndex**](ApiResponseSecurityCommodityChannelIndex.md)
|
|
782
1039
|
|
|
1040
|
+
[//]: # (END_OPERATION)
|
|
1041
|
+
|
|
1042
|
+
|
|
1043
|
+
[//]: # (START_OPERTATION)
|
|
1044
|
+
|
|
1045
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/cmf)
|
|
1046
|
+
|
|
1047
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_cmf)
|
|
1048
|
+
|
|
783
1049
|
# **get_security_price_technicals_cmf**
|
|
1050
|
+
|
|
1051
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_cmf_v2)
|
|
1052
|
+
|
|
784
1053
|
> ApiResponseSecurityChaikinMoneyFlow get_security_price_technicals_cmf(identifier, opts)
|
|
785
1054
|
|
|
786
1055
|
Chaikin Money Flow
|
|
@@ -788,6 +1057,9 @@ Chaikin Money Flow
|
|
|
788
1057
|
Returns the Chaikin Money Flow values of Stock Prices for the Security with the given `identifier`
|
|
789
1058
|
|
|
790
1059
|
### Example
|
|
1060
|
+
|
|
1061
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
1062
|
+
|
|
791
1063
|
```ruby
|
|
792
1064
|
# Load the gem
|
|
793
1065
|
require 'intrinio-sdk'
|
|
@@ -799,7 +1071,7 @@ end
|
|
|
799
1071
|
|
|
800
1072
|
security_api = Intrinio::SecurityApi.new
|
|
801
1073
|
|
|
802
|
-
identifier = "
|
|
1074
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
803
1075
|
|
|
804
1076
|
opts = {
|
|
805
1077
|
period: 20, # Integer | The number of observations, per period, to calculate Chaikin Money Flow
|
|
@@ -817,6 +1089,8 @@ rescue Intrinio::ApiError => e
|
|
|
817
1089
|
end
|
|
818
1090
|
```
|
|
819
1091
|
|
|
1092
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
1093
|
+
|
|
820
1094
|
### Parameters
|
|
821
1095
|
|
|
822
1096
|
Name | Type | Description | Notes
|
|
@@ -832,7 +1106,19 @@ Name | Type | Description | Notes
|
|
|
832
1106
|
|
|
833
1107
|
[**ApiResponseSecurityChaikinMoneyFlow**](ApiResponseSecurityChaikinMoneyFlow.md)
|
|
834
1108
|
|
|
1109
|
+
[//]: # (END_OPERATION)
|
|
1110
|
+
|
|
1111
|
+
|
|
1112
|
+
[//]: # (START_OPERTATION)
|
|
1113
|
+
|
|
1114
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/dc)
|
|
1115
|
+
|
|
1116
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_dc)
|
|
1117
|
+
|
|
835
1118
|
# **get_security_price_technicals_dc**
|
|
1119
|
+
|
|
1120
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_dc_v2)
|
|
1121
|
+
|
|
836
1122
|
> ApiResponseSecurityDonchianChannel get_security_price_technicals_dc(identifier, opts)
|
|
837
1123
|
|
|
838
1124
|
Donchian Channel
|
|
@@ -840,6 +1126,9 @@ Donchian Channel
|
|
|
840
1126
|
Returns the Donchian Channel values of Stock Prices for the Security with the given `identifier`
|
|
841
1127
|
|
|
842
1128
|
### Example
|
|
1129
|
+
|
|
1130
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
1131
|
+
|
|
843
1132
|
```ruby
|
|
844
1133
|
# Load the gem
|
|
845
1134
|
require 'intrinio-sdk'
|
|
@@ -851,7 +1140,7 @@ end
|
|
|
851
1140
|
|
|
852
1141
|
security_api = Intrinio::SecurityApi.new
|
|
853
1142
|
|
|
854
|
-
identifier = "
|
|
1143
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
855
1144
|
|
|
856
1145
|
opts = {
|
|
857
1146
|
period: 20, # Integer | The number of observations, per period, to calculate Donchian Channel
|
|
@@ -870,6 +1159,8 @@ rescue Intrinio::ApiError => e
|
|
|
870
1159
|
end
|
|
871
1160
|
```
|
|
872
1161
|
|
|
1162
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
1163
|
+
|
|
873
1164
|
### Parameters
|
|
874
1165
|
|
|
875
1166
|
Name | Type | Description | Notes
|
|
@@ -886,7 +1177,19 @@ Name | Type | Description | Notes
|
|
|
886
1177
|
|
|
887
1178
|
[**ApiResponseSecurityDonchianChannel**](ApiResponseSecurityDonchianChannel.md)
|
|
888
1179
|
|
|
1180
|
+
[//]: # (END_OPERATION)
|
|
1181
|
+
|
|
1182
|
+
|
|
1183
|
+
[//]: # (START_OPERTATION)
|
|
1184
|
+
|
|
1185
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/dpo)
|
|
1186
|
+
|
|
1187
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_dpo)
|
|
1188
|
+
|
|
889
1189
|
# **get_security_price_technicals_dpo**
|
|
1190
|
+
|
|
1191
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_dpo_v2)
|
|
1192
|
+
|
|
890
1193
|
> ApiResponseSecurityDetrendedPriceOscillator get_security_price_technicals_dpo(identifier, opts)
|
|
891
1194
|
|
|
892
1195
|
Detrended Price Oscillator
|
|
@@ -894,6 +1197,9 @@ Detrended Price Oscillator
|
|
|
894
1197
|
Returns the Detrended Price Oscillator values of Stock Prices for the Security with the given `identifier`
|
|
895
1198
|
|
|
896
1199
|
### Example
|
|
1200
|
+
|
|
1201
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
1202
|
+
|
|
897
1203
|
```ruby
|
|
898
1204
|
# Load the gem
|
|
899
1205
|
require 'intrinio-sdk'
|
|
@@ -905,7 +1211,7 @@ end
|
|
|
905
1211
|
|
|
906
1212
|
security_api = Intrinio::SecurityApi.new
|
|
907
1213
|
|
|
908
|
-
identifier = "
|
|
1214
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
909
1215
|
|
|
910
1216
|
opts = {
|
|
911
1217
|
period: 20, # Integer | The number of observations, per period, to calculate Detrended Price Oscillator
|
|
@@ -924,6 +1230,8 @@ rescue Intrinio::ApiError => e
|
|
|
924
1230
|
end
|
|
925
1231
|
```
|
|
926
1232
|
|
|
1233
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
1234
|
+
|
|
927
1235
|
### Parameters
|
|
928
1236
|
|
|
929
1237
|
Name | Type | Description | Notes
|
|
@@ -940,7 +1248,19 @@ Name | Type | Description | Notes
|
|
|
940
1248
|
|
|
941
1249
|
[**ApiResponseSecurityDetrendedPriceOscillator**](ApiResponseSecurityDetrendedPriceOscillator.md)
|
|
942
1250
|
|
|
1251
|
+
[//]: # (END_OPERATION)
|
|
1252
|
+
|
|
1253
|
+
|
|
1254
|
+
[//]: # (START_OPERTATION)
|
|
1255
|
+
|
|
1256
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/eom)
|
|
1257
|
+
|
|
1258
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_eom)
|
|
1259
|
+
|
|
943
1260
|
# **get_security_price_technicals_eom**
|
|
1261
|
+
|
|
1262
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_eom_v2)
|
|
1263
|
+
|
|
944
1264
|
> ApiResponseSecurityEaseOfMovement get_security_price_technicals_eom(identifier, opts)
|
|
945
1265
|
|
|
946
1266
|
Ease of Movement
|
|
@@ -948,6 +1268,9 @@ Ease of Movement
|
|
|
948
1268
|
Returns the Ease of Movement values of Stock Prices for the Security with the given `identifier`
|
|
949
1269
|
|
|
950
1270
|
### Example
|
|
1271
|
+
|
|
1272
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
1273
|
+
|
|
951
1274
|
```ruby
|
|
952
1275
|
# Load the gem
|
|
953
1276
|
require 'intrinio-sdk'
|
|
@@ -959,7 +1282,7 @@ end
|
|
|
959
1282
|
|
|
960
1283
|
security_api = Intrinio::SecurityApi.new
|
|
961
1284
|
|
|
962
|
-
identifier = "
|
|
1285
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
963
1286
|
|
|
964
1287
|
opts = {
|
|
965
1288
|
period: 20, # Integer | The number of observations, per period, to calculate Ease of Movement
|
|
@@ -977,6 +1300,8 @@ rescue Intrinio::ApiError => e
|
|
|
977
1300
|
end
|
|
978
1301
|
```
|
|
979
1302
|
|
|
1303
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
1304
|
+
|
|
980
1305
|
### Parameters
|
|
981
1306
|
|
|
982
1307
|
Name | Type | Description | Notes
|
|
@@ -992,7 +1317,19 @@ Name | Type | Description | Notes
|
|
|
992
1317
|
|
|
993
1318
|
[**ApiResponseSecurityEaseOfMovement**](ApiResponseSecurityEaseOfMovement.md)
|
|
994
1319
|
|
|
1320
|
+
[//]: # (END_OPERATION)
|
|
1321
|
+
|
|
1322
|
+
|
|
1323
|
+
[//]: # (START_OPERTATION)
|
|
1324
|
+
|
|
1325
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/fi)
|
|
1326
|
+
|
|
1327
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_fi)
|
|
1328
|
+
|
|
995
1329
|
# **get_security_price_technicals_fi**
|
|
1330
|
+
|
|
1331
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_fi_v2)
|
|
1332
|
+
|
|
996
1333
|
> ApiResponseSecurityForceIndex get_security_price_technicals_fi(identifier, opts)
|
|
997
1334
|
|
|
998
1335
|
Force Index
|
|
@@ -1000,6 +1337,9 @@ Force Index
|
|
|
1000
1337
|
Returns the Force Index values of Stock Prices for the Security with the given `identifier`
|
|
1001
1338
|
|
|
1002
1339
|
### Example
|
|
1340
|
+
|
|
1341
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
1342
|
+
|
|
1003
1343
|
```ruby
|
|
1004
1344
|
# Load the gem
|
|
1005
1345
|
require 'intrinio-sdk'
|
|
@@ -1011,7 +1351,7 @@ end
|
|
|
1011
1351
|
|
|
1012
1352
|
security_api = Intrinio::SecurityApi.new
|
|
1013
1353
|
|
|
1014
|
-
identifier = "
|
|
1354
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1015
1355
|
|
|
1016
1356
|
opts = {
|
|
1017
1357
|
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
@@ -1028,6 +1368,8 @@ rescue Intrinio::ApiError => e
|
|
|
1028
1368
|
end
|
|
1029
1369
|
```
|
|
1030
1370
|
|
|
1371
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
1372
|
+
|
|
1031
1373
|
### Parameters
|
|
1032
1374
|
|
|
1033
1375
|
Name | Type | Description | Notes
|
|
@@ -1042,7 +1384,19 @@ Name | Type | Description | Notes
|
|
|
1042
1384
|
|
|
1043
1385
|
[**ApiResponseSecurityForceIndex**](ApiResponseSecurityForceIndex.md)
|
|
1044
1386
|
|
|
1387
|
+
[//]: # (END_OPERATION)
|
|
1388
|
+
|
|
1389
|
+
|
|
1390
|
+
[//]: # (START_OPERTATION)
|
|
1391
|
+
|
|
1392
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/ichimoku)
|
|
1393
|
+
|
|
1394
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_ichimoku)
|
|
1395
|
+
|
|
1045
1396
|
# **get_security_price_technicals_ichimoku**
|
|
1397
|
+
|
|
1398
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_ichimoku_v2)
|
|
1399
|
+
|
|
1046
1400
|
> ApiResponseSecurityIchimokuKinkoHyo get_security_price_technicals_ichimoku(identifier, opts)
|
|
1047
1401
|
|
|
1048
1402
|
Ichimoku Kinko Hyo
|
|
@@ -1050,6 +1404,9 @@ Ichimoku Kinko Hyo
|
|
|
1050
1404
|
Returns the Ichimoku Kinko Hyo values of Stock Prices for the Security with the given `identifier`
|
|
1051
1405
|
|
|
1052
1406
|
### Example
|
|
1407
|
+
|
|
1408
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
1409
|
+
|
|
1053
1410
|
```ruby
|
|
1054
1411
|
# Load the gem
|
|
1055
1412
|
require 'intrinio-sdk'
|
|
@@ -1061,7 +1418,7 @@ end
|
|
|
1061
1418
|
|
|
1062
1419
|
security_api = Intrinio::SecurityApi.new
|
|
1063
1420
|
|
|
1064
|
-
identifier = "
|
|
1421
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1065
1422
|
|
|
1066
1423
|
opts = {
|
|
1067
1424
|
low_period: 9, # Integer | The number of observations, per period, to calculate Tenkan Sen (Conversion Line) of Ichimoku Kinko Hyo
|
|
@@ -1081,6 +1438,8 @@ rescue Intrinio::ApiError => e
|
|
|
1081
1438
|
end
|
|
1082
1439
|
```
|
|
1083
1440
|
|
|
1441
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
1442
|
+
|
|
1084
1443
|
### Parameters
|
|
1085
1444
|
|
|
1086
1445
|
Name | Type | Description | Notes
|
|
@@ -1098,7 +1457,19 @@ Name | Type | Description | Notes
|
|
|
1098
1457
|
|
|
1099
1458
|
[**ApiResponseSecurityIchimokuKinkoHyo**](ApiResponseSecurityIchimokuKinkoHyo.md)
|
|
1100
1459
|
|
|
1460
|
+
[//]: # (END_OPERATION)
|
|
1461
|
+
|
|
1462
|
+
|
|
1463
|
+
[//]: # (START_OPERTATION)
|
|
1464
|
+
|
|
1465
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/kc)
|
|
1466
|
+
|
|
1467
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_kc)
|
|
1468
|
+
|
|
1101
1469
|
# **get_security_price_technicals_kc**
|
|
1470
|
+
|
|
1471
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_kc_v2)
|
|
1472
|
+
|
|
1102
1473
|
> ApiResponseSecurityKeltnerChannel get_security_price_technicals_kc(identifier, opts)
|
|
1103
1474
|
|
|
1104
1475
|
Keltner Channel
|
|
@@ -1106,6 +1477,9 @@ Keltner Channel
|
|
|
1106
1477
|
Returns the Keltner Channel values of Stock Prices for the Security with the given `identifier`
|
|
1107
1478
|
|
|
1108
1479
|
### Example
|
|
1480
|
+
|
|
1481
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
1482
|
+
|
|
1109
1483
|
```ruby
|
|
1110
1484
|
# Load the gem
|
|
1111
1485
|
require 'intrinio-sdk'
|
|
@@ -1117,7 +1491,7 @@ end
|
|
|
1117
1491
|
|
|
1118
1492
|
security_api = Intrinio::SecurityApi.new
|
|
1119
1493
|
|
|
1120
|
-
identifier = "
|
|
1494
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1121
1495
|
|
|
1122
1496
|
opts = {
|
|
1123
1497
|
period: 10, # Integer | The number of observations, per period, to calculate Kelter Channel
|
|
@@ -1135,6 +1509,8 @@ rescue Intrinio::ApiError => e
|
|
|
1135
1509
|
end
|
|
1136
1510
|
```
|
|
1137
1511
|
|
|
1512
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
1513
|
+
|
|
1138
1514
|
### Parameters
|
|
1139
1515
|
|
|
1140
1516
|
Name | Type | Description | Notes
|
|
@@ -1150,7 +1526,19 @@ Name | Type | Description | Notes
|
|
|
1150
1526
|
|
|
1151
1527
|
[**ApiResponseSecurityKeltnerChannel**](ApiResponseSecurityKeltnerChannel.md)
|
|
1152
1528
|
|
|
1529
|
+
[//]: # (END_OPERATION)
|
|
1530
|
+
|
|
1531
|
+
|
|
1532
|
+
[//]: # (START_OPERTATION)
|
|
1533
|
+
|
|
1534
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/kst)
|
|
1535
|
+
|
|
1536
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_kst)
|
|
1537
|
+
|
|
1153
1538
|
# **get_security_price_technicals_kst**
|
|
1539
|
+
|
|
1540
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_kst_v2)
|
|
1541
|
+
|
|
1154
1542
|
> ApiResponseSecurityKnowSureThing get_security_price_technicals_kst(identifier, opts)
|
|
1155
1543
|
|
|
1156
1544
|
Know Sure Thing
|
|
@@ -1158,6 +1546,9 @@ Know Sure Thing
|
|
|
1158
1546
|
Returns the Know Sure Thing values of Stock Prices for the Security with the given `identifier`
|
|
1159
1547
|
|
|
1160
1548
|
### Example
|
|
1549
|
+
|
|
1550
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
1551
|
+
|
|
1161
1552
|
```ruby
|
|
1162
1553
|
# Load the gem
|
|
1163
1554
|
require 'intrinio-sdk'
|
|
@@ -1169,14 +1560,13 @@ end
|
|
|
1169
1560
|
|
|
1170
1561
|
security_api = Intrinio::SecurityApi.new
|
|
1171
1562
|
|
|
1172
|
-
identifier = "
|
|
1563
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1173
1564
|
|
|
1174
1565
|
opts = {
|
|
1175
1566
|
roc1: 10, # Integer | The number of observations, per period, to calculate the rate-of-change for RCMA1
|
|
1176
1567
|
roc2: 15, # Integer | The number of observations, per period, to calculate the rate-of-change for RCMA2
|
|
1177
|
-
roc3:
|
|
1178
|
-
roc4:
|
|
1179
|
-
roc5: 30, # Integer | The number of observations, per period, to calculate the rate-of-change for RCMA4
|
|
1568
|
+
roc3: 20, # Integer | The number of observations, per period, to calculate the rate-of-change for RCMA3
|
|
1569
|
+
roc4: 30, # Integer | The number of observations, per period, to calculate the rate-of-change for RCMA4
|
|
1180
1570
|
sma1: 10, # Integer | The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA1
|
|
1181
1571
|
sma2: 10, # Integer | The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA2
|
|
1182
1572
|
sma3: 10, # Integer | The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA3
|
|
@@ -1196,6 +1586,8 @@ rescue Intrinio::ApiError => e
|
|
|
1196
1586
|
end
|
|
1197
1587
|
```
|
|
1198
1588
|
|
|
1589
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
1590
|
+
|
|
1199
1591
|
### Parameters
|
|
1200
1592
|
|
|
1201
1593
|
Name | Type | Description | Notes
|
|
@@ -1203,9 +1595,8 @@ Name | Type | Description | Notes
|
|
|
1203
1595
|
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
1204
1596
|
**roc1** | **Integer**| The number of observations, per period, to calculate the rate-of-change for RCMA1 | [optional] [default to 10]
|
|
1205
1597
|
**roc2** | **Integer**| The number of observations, per period, to calculate the rate-of-change for RCMA2 | [optional] [default to 15]
|
|
1206
|
-
**roc3** | **Integer**| The number of observations, per period, to calculate the rate-of-change for
|
|
1207
|
-
**roc4** | **Integer**| The number of observations, per period, to calculate the rate-of-change for
|
|
1208
|
-
**roc5** | **Integer**| The number of observations, per period, to calculate the rate-of-change for RCMA4 | [optional] [default to 30]
|
|
1598
|
+
**roc3** | **Integer**| The number of observations, per period, to calculate the rate-of-change for RCMA3 | [optional] [default to 20]
|
|
1599
|
+
**roc4** | **Integer**| The number of observations, per period, to calculate the rate-of-change for RCMA4 | [optional] [default to 30]
|
|
1209
1600
|
**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]
|
|
1210
1601
|
**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]
|
|
1211
1602
|
**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]
|
|
@@ -1220,7 +1611,19 @@ Name | Type | Description | Notes
|
|
|
1220
1611
|
|
|
1221
1612
|
[**ApiResponseSecurityKnowSureThing**](ApiResponseSecurityKnowSureThing.md)
|
|
1222
1613
|
|
|
1614
|
+
[//]: # (END_OPERATION)
|
|
1615
|
+
|
|
1616
|
+
|
|
1617
|
+
[//]: # (START_OPERTATION)
|
|
1618
|
+
|
|
1619
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/macd)
|
|
1620
|
+
|
|
1621
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_macd)
|
|
1622
|
+
|
|
1223
1623
|
# **get_security_price_technicals_macd**
|
|
1624
|
+
|
|
1625
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_macd_v2)
|
|
1626
|
+
|
|
1224
1627
|
> ApiResponseSecurityMovingAverageConvergenceDivergence get_security_price_technicals_macd(identifier, opts)
|
|
1225
1628
|
|
|
1226
1629
|
Moving Average Convergence Divergence
|
|
@@ -1228,6 +1631,9 @@ Moving Average Convergence Divergence
|
|
|
1228
1631
|
Returns the Moving Average Convergence Divergence values of Stock Prices for the Security with the given `identifier`
|
|
1229
1632
|
|
|
1230
1633
|
### Example
|
|
1634
|
+
|
|
1635
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
1636
|
+
|
|
1231
1637
|
```ruby
|
|
1232
1638
|
# Load the gem
|
|
1233
1639
|
require 'intrinio-sdk'
|
|
@@ -1239,7 +1645,7 @@ end
|
|
|
1239
1645
|
|
|
1240
1646
|
security_api = Intrinio::SecurityApi.new
|
|
1241
1647
|
|
|
1242
|
-
identifier = "
|
|
1648
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1243
1649
|
|
|
1244
1650
|
opts = {
|
|
1245
1651
|
fast_period: 12, # Integer | The number of observations, per period, to calculate the fast moving Exponential Moving Average for Moving Average Convergence Divergence
|
|
@@ -1260,6 +1666,8 @@ rescue Intrinio::ApiError => e
|
|
|
1260
1666
|
end
|
|
1261
1667
|
```
|
|
1262
1668
|
|
|
1669
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
1670
|
+
|
|
1263
1671
|
### Parameters
|
|
1264
1672
|
|
|
1265
1673
|
Name | Type | Description | Notes
|
|
@@ -1278,15 +1686,30 @@ Name | Type | Description | Notes
|
|
|
1278
1686
|
|
|
1279
1687
|
[**ApiResponseSecurityMovingAverageConvergenceDivergence**](ApiResponseSecurityMovingAverageConvergenceDivergence.md)
|
|
1280
1688
|
|
|
1281
|
-
#
|
|
1282
|
-
> ApiResponseSecurityMoneyFlowIndex get_security_price_technicals_mfi(identifier, opts)
|
|
1689
|
+
[//]: # (END_OPERATION)
|
|
1283
1690
|
|
|
1284
|
-
Money Flow Index
|
|
1285
1691
|
|
|
1286
|
-
|
|
1692
|
+
[//]: # (START_OPERTATION)
|
|
1287
1693
|
|
|
1288
|
-
|
|
1289
|
-
|
|
1694
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/mfi)
|
|
1695
|
+
|
|
1696
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_mfi)
|
|
1697
|
+
|
|
1698
|
+
# **get_security_price_technicals_mfi**
|
|
1699
|
+
|
|
1700
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_mfi_v2)
|
|
1701
|
+
|
|
1702
|
+
> ApiResponseSecurityMoneyFlowIndex get_security_price_technicals_mfi(identifier, opts)
|
|
1703
|
+
|
|
1704
|
+
Money Flow Index
|
|
1705
|
+
|
|
1706
|
+
Returns the Money Flow Index values of Stock Prices for the Security with the given `identifier`
|
|
1707
|
+
|
|
1708
|
+
### Example
|
|
1709
|
+
|
|
1710
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
1711
|
+
|
|
1712
|
+
```ruby
|
|
1290
1713
|
# Load the gem
|
|
1291
1714
|
require 'intrinio-sdk'
|
|
1292
1715
|
|
|
@@ -1297,7 +1720,7 @@ end
|
|
|
1297
1720
|
|
|
1298
1721
|
security_api = Intrinio::SecurityApi.new
|
|
1299
1722
|
|
|
1300
|
-
identifier = "
|
|
1723
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1301
1724
|
|
|
1302
1725
|
opts = {
|
|
1303
1726
|
period: 14, # Integer | The number of observations, per period, to calculate Money Flow Index
|
|
@@ -1315,6 +1738,8 @@ rescue Intrinio::ApiError => e
|
|
|
1315
1738
|
end
|
|
1316
1739
|
```
|
|
1317
1740
|
|
|
1741
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
1742
|
+
|
|
1318
1743
|
### Parameters
|
|
1319
1744
|
|
|
1320
1745
|
Name | Type | Description | Notes
|
|
@@ -1330,7 +1755,19 @@ Name | Type | Description | Notes
|
|
|
1330
1755
|
|
|
1331
1756
|
[**ApiResponseSecurityMoneyFlowIndex**](ApiResponseSecurityMoneyFlowIndex.md)
|
|
1332
1757
|
|
|
1758
|
+
[//]: # (END_OPERATION)
|
|
1759
|
+
|
|
1760
|
+
|
|
1761
|
+
[//]: # (START_OPERTATION)
|
|
1762
|
+
|
|
1763
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/mi)
|
|
1764
|
+
|
|
1765
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_mi)
|
|
1766
|
+
|
|
1333
1767
|
# **get_security_price_technicals_mi**
|
|
1768
|
+
|
|
1769
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_mi_v2)
|
|
1770
|
+
|
|
1334
1771
|
> ApiResponseSecurityMassIndex get_security_price_technicals_mi(identifier, opts)
|
|
1335
1772
|
|
|
1336
1773
|
Mass Index
|
|
@@ -1338,6 +1775,9 @@ Mass Index
|
|
|
1338
1775
|
Returns the Mass Index values of Stock Prices for the Security with the given `identifier`
|
|
1339
1776
|
|
|
1340
1777
|
### Example
|
|
1778
|
+
|
|
1779
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
1780
|
+
|
|
1341
1781
|
```ruby
|
|
1342
1782
|
# Load the gem
|
|
1343
1783
|
require 'intrinio-sdk'
|
|
@@ -1349,7 +1789,7 @@ end
|
|
|
1349
1789
|
|
|
1350
1790
|
security_api = Intrinio::SecurityApi.new
|
|
1351
1791
|
|
|
1352
|
-
identifier = "
|
|
1792
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1353
1793
|
|
|
1354
1794
|
opts = {
|
|
1355
1795
|
ema_period: 9, # Integer | The number of observations, per period, to calculate the single Exponential Moving Average and the Double Exponential Moving Average for Mass Index
|
|
@@ -1368,6 +1808,8 @@ rescue Intrinio::ApiError => e
|
|
|
1368
1808
|
end
|
|
1369
1809
|
```
|
|
1370
1810
|
|
|
1811
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
1812
|
+
|
|
1371
1813
|
### Parameters
|
|
1372
1814
|
|
|
1373
1815
|
Name | Type | Description | Notes
|
|
@@ -1384,7 +1826,19 @@ Name | Type | Description | Notes
|
|
|
1384
1826
|
|
|
1385
1827
|
[**ApiResponseSecurityMassIndex**](ApiResponseSecurityMassIndex.md)
|
|
1386
1828
|
|
|
1829
|
+
[//]: # (END_OPERATION)
|
|
1830
|
+
|
|
1831
|
+
|
|
1832
|
+
[//]: # (START_OPERTATION)
|
|
1833
|
+
|
|
1834
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/nvi)
|
|
1835
|
+
|
|
1836
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_nvi)
|
|
1837
|
+
|
|
1387
1838
|
# **get_security_price_technicals_nvi**
|
|
1839
|
+
|
|
1840
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_nvi_v2)
|
|
1841
|
+
|
|
1388
1842
|
> ApiResponseSecurityNegativeVolumeIndex get_security_price_technicals_nvi(identifier, opts)
|
|
1389
1843
|
|
|
1390
1844
|
Negative Volume Index
|
|
@@ -1392,6 +1846,9 @@ Negative Volume Index
|
|
|
1392
1846
|
Returns the Negative Volume Index values of Stock Prices for the Security with the given `identifier`
|
|
1393
1847
|
|
|
1394
1848
|
### Example
|
|
1849
|
+
|
|
1850
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
1851
|
+
|
|
1395
1852
|
```ruby
|
|
1396
1853
|
# Load the gem
|
|
1397
1854
|
require 'intrinio-sdk'
|
|
@@ -1403,7 +1860,7 @@ end
|
|
|
1403
1860
|
|
|
1404
1861
|
security_api = Intrinio::SecurityApi.new
|
|
1405
1862
|
|
|
1406
|
-
identifier = "
|
|
1863
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1407
1864
|
|
|
1408
1865
|
opts = {
|
|
1409
1866
|
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
@@ -1420,6 +1877,8 @@ rescue Intrinio::ApiError => e
|
|
|
1420
1877
|
end
|
|
1421
1878
|
```
|
|
1422
1879
|
|
|
1880
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
1881
|
+
|
|
1423
1882
|
### Parameters
|
|
1424
1883
|
|
|
1425
1884
|
Name | Type | Description | Notes
|
|
@@ -1434,7 +1893,19 @@ Name | Type | Description | Notes
|
|
|
1434
1893
|
|
|
1435
1894
|
[**ApiResponseSecurityNegativeVolumeIndex**](ApiResponseSecurityNegativeVolumeIndex.md)
|
|
1436
1895
|
|
|
1896
|
+
[//]: # (END_OPERATION)
|
|
1897
|
+
|
|
1898
|
+
|
|
1899
|
+
[//]: # (START_OPERTATION)
|
|
1900
|
+
|
|
1901
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/obv)
|
|
1902
|
+
|
|
1903
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_obv)
|
|
1904
|
+
|
|
1437
1905
|
# **get_security_price_technicals_obv**
|
|
1906
|
+
|
|
1907
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_obv_v2)
|
|
1908
|
+
|
|
1438
1909
|
> ApiResponseSecurityOnBalanceVolume get_security_price_technicals_obv(identifier, opts)
|
|
1439
1910
|
|
|
1440
1911
|
On-balance Volume
|
|
@@ -1442,6 +1913,9 @@ On-balance Volume
|
|
|
1442
1913
|
Returns the On-balance Volume values of Stock Prices for the Security with the given `identifier`
|
|
1443
1914
|
|
|
1444
1915
|
### Example
|
|
1916
|
+
|
|
1917
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
1918
|
+
|
|
1445
1919
|
```ruby
|
|
1446
1920
|
# Load the gem
|
|
1447
1921
|
require 'intrinio-sdk'
|
|
@@ -1453,7 +1927,7 @@ end
|
|
|
1453
1927
|
|
|
1454
1928
|
security_api = Intrinio::SecurityApi.new
|
|
1455
1929
|
|
|
1456
|
-
identifier = "
|
|
1930
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1457
1931
|
|
|
1458
1932
|
opts = {
|
|
1459
1933
|
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
@@ -1470,6 +1944,8 @@ rescue Intrinio::ApiError => e
|
|
|
1470
1944
|
end
|
|
1471
1945
|
```
|
|
1472
1946
|
|
|
1947
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
1948
|
+
|
|
1473
1949
|
### Parameters
|
|
1474
1950
|
|
|
1475
1951
|
Name | Type | Description | Notes
|
|
@@ -1484,7 +1960,19 @@ Name | Type | Description | Notes
|
|
|
1484
1960
|
|
|
1485
1961
|
[**ApiResponseSecurityOnBalanceVolume**](ApiResponseSecurityOnBalanceVolume.md)
|
|
1486
1962
|
|
|
1963
|
+
[//]: # (END_OPERATION)
|
|
1964
|
+
|
|
1965
|
+
|
|
1966
|
+
[//]: # (START_OPERTATION)
|
|
1967
|
+
|
|
1968
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/obv_mean)
|
|
1969
|
+
|
|
1970
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_obv_mean)
|
|
1971
|
+
|
|
1487
1972
|
# **get_security_price_technicals_obv_mean**
|
|
1973
|
+
|
|
1974
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_obv_mean_v2)
|
|
1975
|
+
|
|
1488
1976
|
> ApiResponseSecurityOnBalanceVolumeMean get_security_price_technicals_obv_mean(identifier, opts)
|
|
1489
1977
|
|
|
1490
1978
|
On-balance Volume Mean
|
|
@@ -1492,6 +1980,9 @@ On-balance Volume Mean
|
|
|
1492
1980
|
Returns the On-balance Volume Mean values of Stock Prices for the Security with the given `identifier`
|
|
1493
1981
|
|
|
1494
1982
|
### Example
|
|
1983
|
+
|
|
1984
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
1985
|
+
|
|
1495
1986
|
```ruby
|
|
1496
1987
|
# Load the gem
|
|
1497
1988
|
require 'intrinio-sdk'
|
|
@@ -1503,7 +1994,7 @@ end
|
|
|
1503
1994
|
|
|
1504
1995
|
security_api = Intrinio::SecurityApi.new
|
|
1505
1996
|
|
|
1506
|
-
identifier = "
|
|
1997
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1507
1998
|
|
|
1508
1999
|
opts = {
|
|
1509
2000
|
period: 10, # Integer | The number of observations, per period, to calculate On-balance Volume Mean
|
|
@@ -1521,6 +2012,8 @@ rescue Intrinio::ApiError => e
|
|
|
1521
2012
|
end
|
|
1522
2013
|
```
|
|
1523
2014
|
|
|
2015
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
2016
|
+
|
|
1524
2017
|
### Parameters
|
|
1525
2018
|
|
|
1526
2019
|
Name | Type | Description | Notes
|
|
@@ -1536,7 +2029,19 @@ Name | Type | Description | Notes
|
|
|
1536
2029
|
|
|
1537
2030
|
[**ApiResponseSecurityOnBalanceVolumeMean**](ApiResponseSecurityOnBalanceVolumeMean.md)
|
|
1538
2031
|
|
|
2032
|
+
[//]: # (END_OPERATION)
|
|
2033
|
+
|
|
2034
|
+
|
|
2035
|
+
[//]: # (START_OPERTATION)
|
|
2036
|
+
|
|
2037
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/rsi)
|
|
2038
|
+
|
|
2039
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_rsi)
|
|
2040
|
+
|
|
1539
2041
|
# **get_security_price_technicals_rsi**
|
|
2042
|
+
|
|
2043
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_rsi_v2)
|
|
2044
|
+
|
|
1540
2045
|
> ApiResponseSecurityRelativeStrengthIndex get_security_price_technicals_rsi(identifier, opts)
|
|
1541
2046
|
|
|
1542
2047
|
Relative Strength Index
|
|
@@ -1544,6 +2049,9 @@ Relative Strength Index
|
|
|
1544
2049
|
Returns the Relative Strength Index values of Stock Prices for the Security with the given `identifier`
|
|
1545
2050
|
|
|
1546
2051
|
### Example
|
|
2052
|
+
|
|
2053
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
2054
|
+
|
|
1547
2055
|
```ruby
|
|
1548
2056
|
# Load the gem
|
|
1549
2057
|
require 'intrinio-sdk'
|
|
@@ -1555,7 +2063,7 @@ end
|
|
|
1555
2063
|
|
|
1556
2064
|
security_api = Intrinio::SecurityApi.new
|
|
1557
2065
|
|
|
1558
|
-
identifier = "
|
|
2066
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1559
2067
|
|
|
1560
2068
|
opts = {
|
|
1561
2069
|
period: 14, # Integer | The number of observations, per period, to calculate Relative Strength Index
|
|
@@ -1574,6 +2082,8 @@ rescue Intrinio::ApiError => e
|
|
|
1574
2082
|
end
|
|
1575
2083
|
```
|
|
1576
2084
|
|
|
2085
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
2086
|
+
|
|
1577
2087
|
### Parameters
|
|
1578
2088
|
|
|
1579
2089
|
Name | Type | Description | Notes
|
|
@@ -1590,7 +2100,19 @@ Name | Type | Description | Notes
|
|
|
1590
2100
|
|
|
1591
2101
|
[**ApiResponseSecurityRelativeStrengthIndex**](ApiResponseSecurityRelativeStrengthIndex.md)
|
|
1592
2102
|
|
|
2103
|
+
[//]: # (END_OPERATION)
|
|
2104
|
+
|
|
2105
|
+
|
|
2106
|
+
[//]: # (START_OPERTATION)
|
|
2107
|
+
|
|
2108
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/sma)
|
|
2109
|
+
|
|
2110
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_sma)
|
|
2111
|
+
|
|
1593
2112
|
# **get_security_price_technicals_sma**
|
|
2113
|
+
|
|
2114
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_sma_v2)
|
|
2115
|
+
|
|
1594
2116
|
> ApiResponseSecuritySimpleMovingAverage get_security_price_technicals_sma(identifier, opts)
|
|
1595
2117
|
|
|
1596
2118
|
Simple Moving Average
|
|
@@ -1598,6 +2120,9 @@ Simple Moving Average
|
|
|
1598
2120
|
Returns the Simple Moving Average values of Stock Prices for the Security with the given `identifier`
|
|
1599
2121
|
|
|
1600
2122
|
### Example
|
|
2123
|
+
|
|
2124
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
2125
|
+
|
|
1601
2126
|
```ruby
|
|
1602
2127
|
# Load the gem
|
|
1603
2128
|
require 'intrinio-sdk'
|
|
@@ -1609,7 +2134,7 @@ end
|
|
|
1609
2134
|
|
|
1610
2135
|
security_api = Intrinio::SecurityApi.new
|
|
1611
2136
|
|
|
1612
|
-
identifier = "
|
|
2137
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1613
2138
|
|
|
1614
2139
|
opts = {
|
|
1615
2140
|
period: 20, # Integer | The number of observations, per period, to calculate Simple Moving Average
|
|
@@ -1628,6 +2153,8 @@ rescue Intrinio::ApiError => e
|
|
|
1628
2153
|
end
|
|
1629
2154
|
```
|
|
1630
2155
|
|
|
2156
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
2157
|
+
|
|
1631
2158
|
### Parameters
|
|
1632
2159
|
|
|
1633
2160
|
Name | Type | Description | Notes
|
|
@@ -1644,7 +2171,19 @@ Name | Type | Description | Notes
|
|
|
1644
2171
|
|
|
1645
2172
|
[**ApiResponseSecuritySimpleMovingAverage**](ApiResponseSecuritySimpleMovingAverage.md)
|
|
1646
2173
|
|
|
2174
|
+
[//]: # (END_OPERATION)
|
|
2175
|
+
|
|
2176
|
+
|
|
2177
|
+
[//]: # (START_OPERTATION)
|
|
2178
|
+
|
|
2179
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/sr)
|
|
2180
|
+
|
|
2181
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_sr)
|
|
2182
|
+
|
|
1647
2183
|
# **get_security_price_technicals_sr**
|
|
2184
|
+
|
|
2185
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_sr_v2)
|
|
2186
|
+
|
|
1648
2187
|
> ApiResponseSecurityStochasticOscillator get_security_price_technicals_sr(identifier, opts)
|
|
1649
2188
|
|
|
1650
2189
|
Stochastic Oscillator
|
|
@@ -1652,6 +2191,9 @@ Stochastic Oscillator
|
|
|
1652
2191
|
Returns the Stochastic Oscillator values of Stock Prices for the Security with the given `identifier`
|
|
1653
2192
|
|
|
1654
2193
|
### Example
|
|
2194
|
+
|
|
2195
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
2196
|
+
|
|
1655
2197
|
```ruby
|
|
1656
2198
|
# Load the gem
|
|
1657
2199
|
require 'intrinio-sdk'
|
|
@@ -1663,7 +2205,7 @@ end
|
|
|
1663
2205
|
|
|
1664
2206
|
security_api = Intrinio::SecurityApi.new
|
|
1665
2207
|
|
|
1666
|
-
identifier = "
|
|
2208
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1667
2209
|
|
|
1668
2210
|
opts = {
|
|
1669
2211
|
period: 14, # Integer | The number of observations, per period, to calculate %K of Stochastic Oscillator
|
|
@@ -1682,6 +2224,8 @@ rescue Intrinio::ApiError => e
|
|
|
1682
2224
|
end
|
|
1683
2225
|
```
|
|
1684
2226
|
|
|
2227
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
2228
|
+
|
|
1685
2229
|
### Parameters
|
|
1686
2230
|
|
|
1687
2231
|
Name | Type | Description | Notes
|
|
@@ -1698,7 +2242,19 @@ Name | Type | Description | Notes
|
|
|
1698
2242
|
|
|
1699
2243
|
[**ApiResponseSecurityStochasticOscillator**](ApiResponseSecurityStochasticOscillator.md)
|
|
1700
2244
|
|
|
2245
|
+
[//]: # (END_OPERATION)
|
|
2246
|
+
|
|
2247
|
+
|
|
2248
|
+
[//]: # (START_OPERTATION)
|
|
2249
|
+
|
|
2250
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/trix)
|
|
2251
|
+
|
|
2252
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_trix)
|
|
2253
|
+
|
|
1701
2254
|
# **get_security_price_technicals_trix**
|
|
2255
|
+
|
|
2256
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_trix_v2)
|
|
2257
|
+
|
|
1702
2258
|
> ApiResponseSecurityTripleExponentialAverage get_security_price_technicals_trix(identifier, opts)
|
|
1703
2259
|
|
|
1704
2260
|
Triple Exponential Average
|
|
@@ -1706,6 +2262,9 @@ Triple Exponential Average
|
|
|
1706
2262
|
Returns the Simple Moving Average values of Stock Prices for the Security with the given `identifier`
|
|
1707
2263
|
|
|
1708
2264
|
### Example
|
|
2265
|
+
|
|
2266
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
2267
|
+
|
|
1709
2268
|
```ruby
|
|
1710
2269
|
# Load the gem
|
|
1711
2270
|
require 'intrinio-sdk'
|
|
@@ -1717,7 +2276,7 @@ end
|
|
|
1717
2276
|
|
|
1718
2277
|
security_api = Intrinio::SecurityApi.new
|
|
1719
2278
|
|
|
1720
|
-
identifier = "
|
|
2279
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1721
2280
|
|
|
1722
2281
|
opts = {
|
|
1723
2282
|
period: 15, # Integer | The number of observations, per period, to calculate Exponential Moving Average for Triple Exponential Average
|
|
@@ -1735,6 +2294,8 @@ rescue Intrinio::ApiError => e
|
|
|
1735
2294
|
end
|
|
1736
2295
|
```
|
|
1737
2296
|
|
|
2297
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
2298
|
+
|
|
1738
2299
|
### Parameters
|
|
1739
2300
|
|
|
1740
2301
|
Name | Type | Description | Notes
|
|
@@ -1750,7 +2311,19 @@ Name | Type | Description | Notes
|
|
|
1750
2311
|
|
|
1751
2312
|
[**ApiResponseSecurityTripleExponentialAverage**](ApiResponseSecurityTripleExponentialAverage.md)
|
|
1752
2313
|
|
|
2314
|
+
[//]: # (END_OPERATION)
|
|
2315
|
+
|
|
2316
|
+
|
|
2317
|
+
[//]: # (START_OPERTATION)
|
|
2318
|
+
|
|
2319
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/tsi)
|
|
2320
|
+
|
|
2321
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_tsi)
|
|
2322
|
+
|
|
1753
2323
|
# **get_security_price_technicals_tsi**
|
|
2324
|
+
|
|
2325
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_tsi_v2)
|
|
2326
|
+
|
|
1754
2327
|
> ApiResponseSecurityTrueStrengthIndex get_security_price_technicals_tsi(identifier, opts)
|
|
1755
2328
|
|
|
1756
2329
|
True Strength Index
|
|
@@ -1758,6 +2331,9 @@ True Strength Index
|
|
|
1758
2331
|
Returns the True Strength Index values of Stock Prices for the Security with the given `identifier`
|
|
1759
2332
|
|
|
1760
2333
|
### Example
|
|
2334
|
+
|
|
2335
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
2336
|
+
|
|
1761
2337
|
```ruby
|
|
1762
2338
|
# Load the gem
|
|
1763
2339
|
require 'intrinio-sdk'
|
|
@@ -1769,7 +2345,7 @@ end
|
|
|
1769
2345
|
|
|
1770
2346
|
security_api = Intrinio::SecurityApi.new
|
|
1771
2347
|
|
|
1772
|
-
identifier = "
|
|
2348
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1773
2349
|
|
|
1774
2350
|
opts = {
|
|
1775
2351
|
low_period: 13, # Integer | The number of observations, per period, to calculate low period Exponential Moving Average for smoothing in True Strength Index
|
|
@@ -1789,6 +2365,8 @@ rescue Intrinio::ApiError => e
|
|
|
1789
2365
|
end
|
|
1790
2366
|
```
|
|
1791
2367
|
|
|
2368
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
2369
|
+
|
|
1792
2370
|
### Parameters
|
|
1793
2371
|
|
|
1794
2372
|
Name | Type | Description | Notes
|
|
@@ -1806,7 +2384,19 @@ Name | Type | Description | Notes
|
|
|
1806
2384
|
|
|
1807
2385
|
[**ApiResponseSecurityTrueStrengthIndex**](ApiResponseSecurityTrueStrengthIndex.md)
|
|
1808
2386
|
|
|
2387
|
+
[//]: # (END_OPERATION)
|
|
2388
|
+
|
|
2389
|
+
|
|
2390
|
+
[//]: # (START_OPERTATION)
|
|
2391
|
+
|
|
2392
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/uo)
|
|
2393
|
+
|
|
2394
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_uo)
|
|
2395
|
+
|
|
1809
2396
|
# **get_security_price_technicals_uo**
|
|
2397
|
+
|
|
2398
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_uo_v2)
|
|
2399
|
+
|
|
1810
2400
|
> ApiResponseSecurityUltimateOscillator get_security_price_technicals_uo(identifier, opts)
|
|
1811
2401
|
|
|
1812
2402
|
Ultimate Oscillator
|
|
@@ -1814,6 +2404,9 @@ Ultimate Oscillator
|
|
|
1814
2404
|
Returns the Ultimate Oscillator values of Stock Prices for the Security with the given `identifier`
|
|
1815
2405
|
|
|
1816
2406
|
### Example
|
|
2407
|
+
|
|
2408
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
2409
|
+
|
|
1817
2410
|
```ruby
|
|
1818
2411
|
# Load the gem
|
|
1819
2412
|
require 'intrinio-sdk'
|
|
@@ -1825,7 +2418,7 @@ end
|
|
|
1825
2418
|
|
|
1826
2419
|
security_api = Intrinio::SecurityApi.new
|
|
1827
2420
|
|
|
1828
|
-
identifier = "
|
|
2421
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1829
2422
|
|
|
1830
2423
|
opts = {
|
|
1831
2424
|
short_period: 7, # Integer | The number of observations, per period, to calculate the short period for Ultimate Oscillator
|
|
@@ -1848,6 +2441,8 @@ rescue Intrinio::ApiError => e
|
|
|
1848
2441
|
end
|
|
1849
2442
|
```
|
|
1850
2443
|
|
|
2444
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
2445
|
+
|
|
1851
2446
|
### Parameters
|
|
1852
2447
|
|
|
1853
2448
|
Name | Type | Description | Notes
|
|
@@ -1868,7 +2463,19 @@ Name | Type | Description | Notes
|
|
|
1868
2463
|
|
|
1869
2464
|
[**ApiResponseSecurityUltimateOscillator**](ApiResponseSecurityUltimateOscillator.md)
|
|
1870
2465
|
|
|
2466
|
+
[//]: # (END_OPERATION)
|
|
2467
|
+
|
|
2468
|
+
|
|
2469
|
+
[//]: # (START_OPERTATION)
|
|
2470
|
+
|
|
2471
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/vi)
|
|
2472
|
+
|
|
2473
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_vi)
|
|
2474
|
+
|
|
1871
2475
|
# **get_security_price_technicals_vi**
|
|
2476
|
+
|
|
2477
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_vi_v2)
|
|
2478
|
+
|
|
1872
2479
|
> ApiResponseSecurityVortexIndicator get_security_price_technicals_vi(identifier, opts)
|
|
1873
2480
|
|
|
1874
2481
|
Vortex Indicator
|
|
@@ -1876,6 +2483,9 @@ Vortex Indicator
|
|
|
1876
2483
|
Returns the Vortex Indicator values of Stock Prices for the Security with the given `identifier`
|
|
1877
2484
|
|
|
1878
2485
|
### Example
|
|
2486
|
+
|
|
2487
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
2488
|
+
|
|
1879
2489
|
```ruby
|
|
1880
2490
|
# Load the gem
|
|
1881
2491
|
require 'intrinio-sdk'
|
|
@@ -1887,7 +2497,7 @@ end
|
|
|
1887
2497
|
|
|
1888
2498
|
security_api = Intrinio::SecurityApi.new
|
|
1889
2499
|
|
|
1890
|
-
identifier = "
|
|
2500
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1891
2501
|
|
|
1892
2502
|
opts = {
|
|
1893
2503
|
period: 14, # Integer | The number of observations, per period, to calculate Vortex Indicator
|
|
@@ -1905,6 +2515,8 @@ rescue Intrinio::ApiError => e
|
|
|
1905
2515
|
end
|
|
1906
2516
|
```
|
|
1907
2517
|
|
|
2518
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
2519
|
+
|
|
1908
2520
|
### Parameters
|
|
1909
2521
|
|
|
1910
2522
|
Name | Type | Description | Notes
|
|
@@ -1920,7 +2532,19 @@ Name | Type | Description | Notes
|
|
|
1920
2532
|
|
|
1921
2533
|
[**ApiResponseSecurityVortexIndicator**](ApiResponseSecurityVortexIndicator.md)
|
|
1922
2534
|
|
|
2535
|
+
[//]: # (END_OPERATION)
|
|
2536
|
+
|
|
2537
|
+
|
|
2538
|
+
[//]: # (START_OPERTATION)
|
|
2539
|
+
|
|
2540
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/vpt)
|
|
2541
|
+
|
|
2542
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_vpt)
|
|
2543
|
+
|
|
1923
2544
|
# **get_security_price_technicals_vpt**
|
|
2545
|
+
|
|
2546
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_vpt_v2)
|
|
2547
|
+
|
|
1924
2548
|
> ApiResponseSecurityVolumePriceTrend get_security_price_technicals_vpt(identifier, opts)
|
|
1925
2549
|
|
|
1926
2550
|
Volume-price Trend
|
|
@@ -1928,6 +2552,9 @@ Volume-price Trend
|
|
|
1928
2552
|
Returns the Volume-price Trend values of Stock Prices for the Security with the given `identifier`
|
|
1929
2553
|
|
|
1930
2554
|
### Example
|
|
2555
|
+
|
|
2556
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
2557
|
+
|
|
1931
2558
|
```ruby
|
|
1932
2559
|
# Load the gem
|
|
1933
2560
|
require 'intrinio-sdk'
|
|
@@ -1939,7 +2566,7 @@ end
|
|
|
1939
2566
|
|
|
1940
2567
|
security_api = Intrinio::SecurityApi.new
|
|
1941
2568
|
|
|
1942
|
-
identifier = "
|
|
2569
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1943
2570
|
|
|
1944
2571
|
opts = {
|
|
1945
2572
|
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
@@ -1956,6 +2583,8 @@ rescue Intrinio::ApiError => e
|
|
|
1956
2583
|
end
|
|
1957
2584
|
```
|
|
1958
2585
|
|
|
2586
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
2587
|
+
|
|
1959
2588
|
### Parameters
|
|
1960
2589
|
|
|
1961
2590
|
Name | Type | Description | Notes
|
|
@@ -1970,7 +2599,19 @@ Name | Type | Description | Notes
|
|
|
1970
2599
|
|
|
1971
2600
|
[**ApiResponseSecurityVolumePriceTrend**](ApiResponseSecurityVolumePriceTrend.md)
|
|
1972
2601
|
|
|
2602
|
+
[//]: # (END_OPERATION)
|
|
2603
|
+
|
|
2604
|
+
|
|
2605
|
+
[//]: # (START_OPERTATION)
|
|
2606
|
+
|
|
2607
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/vwap)
|
|
2608
|
+
|
|
2609
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_vwap)
|
|
2610
|
+
|
|
1973
2611
|
# **get_security_price_technicals_vwap**
|
|
2612
|
+
|
|
2613
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_vwap_v2)
|
|
2614
|
+
|
|
1974
2615
|
> ApiResponseSecurityVolumeWeightedAveragePrice get_security_price_technicals_vwap(identifier, opts)
|
|
1975
2616
|
|
|
1976
2617
|
Volume Weighted Average Price
|
|
@@ -1978,6 +2619,9 @@ Volume Weighted Average Price
|
|
|
1978
2619
|
Returns the Volume Weighted Average Price values of Stock Prices for the Security with the given `identifier`
|
|
1979
2620
|
|
|
1980
2621
|
### Example
|
|
2622
|
+
|
|
2623
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
2624
|
+
|
|
1981
2625
|
```ruby
|
|
1982
2626
|
# Load the gem
|
|
1983
2627
|
require 'intrinio-sdk'
|
|
@@ -1989,7 +2633,7 @@ end
|
|
|
1989
2633
|
|
|
1990
2634
|
security_api = Intrinio::SecurityApi.new
|
|
1991
2635
|
|
|
1992
|
-
identifier = "
|
|
2636
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1993
2637
|
|
|
1994
2638
|
opts = {
|
|
1995
2639
|
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
@@ -2006,6 +2650,8 @@ rescue Intrinio::ApiError => e
|
|
|
2006
2650
|
end
|
|
2007
2651
|
```
|
|
2008
2652
|
|
|
2653
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
2654
|
+
|
|
2009
2655
|
### Parameters
|
|
2010
2656
|
|
|
2011
2657
|
Name | Type | Description | Notes
|
|
@@ -2020,7 +2666,19 @@ Name | Type | Description | Notes
|
|
|
2020
2666
|
|
|
2021
2667
|
[**ApiResponseSecurityVolumeWeightedAveragePrice**](ApiResponseSecurityVolumeWeightedAveragePrice.md)
|
|
2022
2668
|
|
|
2669
|
+
[//]: # (END_OPERATION)
|
|
2670
|
+
|
|
2671
|
+
|
|
2672
|
+
[//]: # (START_OPERTATION)
|
|
2673
|
+
|
|
2674
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/wr)
|
|
2675
|
+
|
|
2676
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_wr)
|
|
2677
|
+
|
|
2023
2678
|
# **get_security_price_technicals_wr**
|
|
2679
|
+
|
|
2680
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_wr_v2)
|
|
2681
|
+
|
|
2024
2682
|
> ApiResponseSecurityWilliamsR get_security_price_technicals_wr(identifier, opts)
|
|
2025
2683
|
|
|
2026
2684
|
Williams %R
|
|
@@ -2028,6 +2686,9 @@ Williams %R
|
|
|
2028
2686
|
Returns the Williams %R values of Stock Prices for the Security with the given `identifier`
|
|
2029
2687
|
|
|
2030
2688
|
### Example
|
|
2689
|
+
|
|
2690
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
2691
|
+
|
|
2031
2692
|
```ruby
|
|
2032
2693
|
# Load the gem
|
|
2033
2694
|
require 'intrinio-sdk'
|
|
@@ -2039,7 +2700,7 @@ end
|
|
|
2039
2700
|
|
|
2040
2701
|
security_api = Intrinio::SecurityApi.new
|
|
2041
2702
|
|
|
2042
|
-
identifier = "
|
|
2703
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
2043
2704
|
|
|
2044
2705
|
opts = {
|
|
2045
2706
|
period: 14, # Integer | The number of observations, per period, to look-back when calculating Williams %R
|
|
@@ -2057,6 +2718,8 @@ rescue Intrinio::ApiError => e
|
|
|
2057
2718
|
end
|
|
2058
2719
|
```
|
|
2059
2720
|
|
|
2721
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
2722
|
+
|
|
2060
2723
|
### Parameters
|
|
2061
2724
|
|
|
2062
2725
|
Name | Type | Description | Notes
|
|
@@ -2072,7 +2735,19 @@ Name | Type | Description | Notes
|
|
|
2072
2735
|
|
|
2073
2736
|
[**ApiResponseSecurityWilliamsR**](ApiResponseSecurityWilliamsR.md)
|
|
2074
2737
|
|
|
2738
|
+
[//]: # (END_OPERATION)
|
|
2739
|
+
|
|
2740
|
+
|
|
2741
|
+
[//]: # (START_OPERTATION)
|
|
2742
|
+
|
|
2743
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/realtime)
|
|
2744
|
+
|
|
2745
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_realtime_price)
|
|
2746
|
+
|
|
2075
2747
|
# **get_security_realtime_price**
|
|
2748
|
+
|
|
2749
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_realtime_price_v2)
|
|
2750
|
+
|
|
2076
2751
|
> RealtimeStockPrice get_security_realtime_price(identifier, opts)
|
|
2077
2752
|
|
|
2078
2753
|
Realtime Stock Price for Security
|
|
@@ -2080,6 +2755,9 @@ Realtime Stock Price for Security
|
|
|
2080
2755
|
Return the realtime stock price for the Security with the given `identifier`
|
|
2081
2756
|
|
|
2082
2757
|
### Example
|
|
2758
|
+
|
|
2759
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
2760
|
+
|
|
2083
2761
|
```ruby
|
|
2084
2762
|
# Load the gem
|
|
2085
2763
|
require 'intrinio-sdk'
|
|
@@ -2091,7 +2769,7 @@ end
|
|
|
2091
2769
|
|
|
2092
2770
|
security_api = Intrinio::SecurityApi.new
|
|
2093
2771
|
|
|
2094
|
-
identifier = "
|
|
2772
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
2095
2773
|
|
|
2096
2774
|
opts = {
|
|
2097
2775
|
source: nil # String | Return the realtime price from the specified data source
|
|
@@ -2105,6 +2783,8 @@ rescue Intrinio::ApiError => e
|
|
|
2105
2783
|
end
|
|
2106
2784
|
```
|
|
2107
2785
|
|
|
2786
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
2787
|
+
|
|
2108
2788
|
### Parameters
|
|
2109
2789
|
|
|
2110
2790
|
Name | Type | Description | Notes
|
|
@@ -2116,7 +2796,19 @@ Name | Type | Description | Notes
|
|
|
2116
2796
|
|
|
2117
2797
|
[**RealtimeStockPrice**](RealtimeStockPrice.md)
|
|
2118
2798
|
|
|
2799
|
+
[//]: # (END_OPERATION)
|
|
2800
|
+
|
|
2801
|
+
|
|
2802
|
+
[//]: # (START_OPERTATION)
|
|
2803
|
+
|
|
2804
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices/adjustments)
|
|
2805
|
+
|
|
2806
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_stock_price_adjustments)
|
|
2807
|
+
|
|
2119
2808
|
# **get_security_stock_price_adjustments**
|
|
2809
|
+
|
|
2810
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_stock_price_adjustments_v2)
|
|
2811
|
+
|
|
2120
2812
|
> ApiResponseSecurityStockPriceAdjustments get_security_stock_price_adjustments(identifier, opts)
|
|
2121
2813
|
|
|
2122
2814
|
Stock Price Adjustments by Security
|
|
@@ -2124,6 +2816,9 @@ Stock Price Adjustments by Security
|
|
|
2124
2816
|
Returns stock price adjustments for the Security with the given `identifier`
|
|
2125
2817
|
|
|
2126
2818
|
### Example
|
|
2819
|
+
|
|
2820
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
2821
|
+
|
|
2127
2822
|
```ruby
|
|
2128
2823
|
# Load the gem
|
|
2129
2824
|
require 'intrinio-sdk'
|
|
@@ -2135,12 +2830,12 @@ end
|
|
|
2135
2830
|
|
|
2136
2831
|
security_api = Intrinio::SecurityApi.new
|
|
2137
2832
|
|
|
2138
|
-
identifier = "
|
|
2833
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
2139
2834
|
|
|
2140
2835
|
opts = {
|
|
2141
2836
|
start_date: Date.parse("2018-01-01"), # Date | Return price adjustments on or after the date
|
|
2142
2837
|
end_date: Date.parse("2019-01-01"), # Date | Return price adjustments on or before the date
|
|
2143
|
-
page_size: 100, #
|
|
2838
|
+
page_size: 100, # Integer | The number of results to return
|
|
2144
2839
|
next_page: nil # String | Gets the next page of data from a previous API call
|
|
2145
2840
|
}
|
|
2146
2841
|
|
|
@@ -2152,6 +2847,8 @@ rescue Intrinio::ApiError => e
|
|
|
2152
2847
|
end
|
|
2153
2848
|
```
|
|
2154
2849
|
|
|
2850
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
2851
|
+
|
|
2155
2852
|
### Parameters
|
|
2156
2853
|
|
|
2157
2854
|
Name | Type | Description | Notes
|
|
@@ -2159,14 +2856,26 @@ Name | Type | Description | Notes
|
|
|
2159
2856
|
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
2160
2857
|
**start_date** | **Date**| Return price adjustments on or after the date | [optional]
|
|
2161
2858
|
**end_date** | **Date**| Return price adjustments on or before the date | [optional]
|
|
2162
|
-
**page_size** | **
|
|
2859
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
2163
2860
|
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
2164
2861
|
|
|
2165
2862
|
### Return type
|
|
2166
2863
|
|
|
2167
2864
|
[**ApiResponseSecurityStockPriceAdjustments**](ApiResponseSecurityStockPriceAdjustments.md)
|
|
2168
2865
|
|
|
2866
|
+
[//]: # (END_OPERATION)
|
|
2867
|
+
|
|
2868
|
+
|
|
2869
|
+
[//]: # (START_OPERTATION)
|
|
2870
|
+
|
|
2871
|
+
[//]: # (ENDPOINT:/securities/{identifier}/prices)
|
|
2872
|
+
|
|
2873
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_stock_prices)
|
|
2874
|
+
|
|
2169
2875
|
# **get_security_stock_prices**
|
|
2876
|
+
|
|
2877
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_stock_prices_v2)
|
|
2878
|
+
|
|
2170
2879
|
> ApiResponseSecurityStockPrices get_security_stock_prices(identifier, opts)
|
|
2171
2880
|
|
|
2172
2881
|
Stock Prices by Security
|
|
@@ -2174,6 +2883,9 @@ Stock Prices by Security
|
|
|
2174
2883
|
Return end-of-day stock prices for the Security with the given `identifier`
|
|
2175
2884
|
|
|
2176
2885
|
### Example
|
|
2886
|
+
|
|
2887
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
2888
|
+
|
|
2177
2889
|
```ruby
|
|
2178
2890
|
# Load the gem
|
|
2179
2891
|
require 'intrinio-sdk'
|
|
@@ -2185,13 +2897,13 @@ end
|
|
|
2185
2897
|
|
|
2186
2898
|
security_api = Intrinio::SecurityApi.new
|
|
2187
2899
|
|
|
2188
|
-
identifier = "
|
|
2900
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
2189
2901
|
|
|
2190
2902
|
opts = {
|
|
2191
2903
|
start_date: Date.parse("2018-01-01"), # Date | Return prices on or after the date
|
|
2192
2904
|
end_date: Date.parse("2019-01-01"), # Date | Return prices on or before the date
|
|
2193
2905
|
frequency: "daily", # String | Return stock prices in the given frequency
|
|
2194
|
-
page_size: 100, #
|
|
2906
|
+
page_size: 100, # Integer | The number of results to return
|
|
2195
2907
|
next_page: nil # String | Gets the next page of data from a previous API call
|
|
2196
2908
|
}
|
|
2197
2909
|
|
|
@@ -2203,6 +2915,8 @@ rescue Intrinio::ApiError => e
|
|
|
2203
2915
|
end
|
|
2204
2916
|
```
|
|
2205
2917
|
|
|
2918
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
2919
|
+
|
|
2206
2920
|
### Parameters
|
|
2207
2921
|
|
|
2208
2922
|
Name | Type | Description | Notes
|
|
@@ -2211,14 +2925,306 @@ Name | Type | Description | Notes
|
|
|
2211
2925
|
**start_date** | **Date**| Return prices on or after the date | [optional]
|
|
2212
2926
|
**end_date** | **Date**| Return prices on or before the date | [optional]
|
|
2213
2927
|
**frequency** | **String**| Return stock prices in the given frequency | [optional] [default to daily]
|
|
2214
|
-
**page_size** | **
|
|
2928
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
2215
2929
|
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
2216
2930
|
|
|
2217
2931
|
### Return type
|
|
2218
2932
|
|
|
2219
2933
|
[**ApiResponseSecurityStockPrices**](ApiResponseSecurityStockPrices.md)
|
|
2220
2934
|
|
|
2935
|
+
[//]: # (END_OPERATION)
|
|
2936
|
+
|
|
2937
|
+
|
|
2938
|
+
[//]: # (START_OPERTATION)
|
|
2939
|
+
|
|
2940
|
+
[//]: # (ENDPOINT:/securities/{identifier}/zacks/analyst_ratings)
|
|
2941
|
+
|
|
2942
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_zacks_analyst_ratings)
|
|
2943
|
+
|
|
2944
|
+
# **get_security_zacks_analyst_ratings**
|
|
2945
|
+
|
|
2946
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_zacks_analyst_ratings_v2)
|
|
2947
|
+
|
|
2948
|
+
> ApiResponseSecurityZacksAnalystRatings get_security_zacks_analyst_ratings(identifier, opts)
|
|
2949
|
+
|
|
2950
|
+
Zacks Analyst Ratings
|
|
2951
|
+
|
|
2952
|
+
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.
|
|
2953
|
+
|
|
2954
|
+
### Example
|
|
2955
|
+
|
|
2956
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
2957
|
+
|
|
2958
|
+
```ruby
|
|
2959
|
+
# Load the gem
|
|
2960
|
+
require 'intrinio-sdk'
|
|
2961
|
+
|
|
2962
|
+
# Setup authorization
|
|
2963
|
+
Intrinio.configure do |config|
|
|
2964
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
2965
|
+
end
|
|
2966
|
+
|
|
2967
|
+
security_api = Intrinio::SecurityApi.new
|
|
2968
|
+
|
|
2969
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
2970
|
+
|
|
2971
|
+
opts = {
|
|
2972
|
+
start_date: nil, # String | Limit ratings to those on or after this date
|
|
2973
|
+
end_date: nil, # String | Limit ratings to those on or before this date
|
|
2974
|
+
mean_greater: nil, # Float | Return only records with a mean (average) higher than this value
|
|
2975
|
+
mean_less: nil, # Float | Return only records with a mean (average) lower than this value
|
|
2976
|
+
strong_buys_greater: nil, # Integer | Return only records with more than this many Strong Buy recommendations
|
|
2977
|
+
strong_buys_less: nil, # Integer | Return only records with fewer than this many Strong Buy recommendations
|
|
2978
|
+
buys_greater: nil, # Integer | Return only records with more than this many Buy recommendations
|
|
2979
|
+
buys_less: nil, # Integer | Return only records with fewer than this many Buy recommendations
|
|
2980
|
+
holds_greater: nil, # Integer | Return only records with more than this many Hold recommendations
|
|
2981
|
+
holds_less: nil, # Integer | Return only records with fewer than this many Hold recommendations
|
|
2982
|
+
sells_greater: nil, # Integer | Return only records with more than this many Sell recommendations
|
|
2983
|
+
sells_less: nil, # Integer | Return only records with fewer than this many Sell recommendations
|
|
2984
|
+
strong_sells_greater: nil, # Integer | Return only records with more than this many Strong Sell recommendations
|
|
2985
|
+
strong_sells_less: nil, # Integer | Return only records with fewer than this many Strong Sell recommendations
|
|
2986
|
+
total_greater: nil, # Integer | Return only records with more than this many recommendations, regardless of type
|
|
2987
|
+
total_less: nil, # Integer | Return only records with fewer than this many recommendations, regardless of type
|
|
2988
|
+
page_size: 100 # Integer | The number of results to return
|
|
2989
|
+
}
|
|
2990
|
+
|
|
2991
|
+
begin
|
|
2992
|
+
result = security_api.get_security_zacks_analyst_ratings(identifier, opts)
|
|
2993
|
+
p result
|
|
2994
|
+
rescue Intrinio::ApiError => e
|
|
2995
|
+
puts "Exception when calling SecurityApi->get_security_zacks_analyst_ratings: #{e}"
|
|
2996
|
+
end
|
|
2997
|
+
```
|
|
2998
|
+
|
|
2999
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
3000
|
+
|
|
3001
|
+
### Parameters
|
|
3002
|
+
|
|
3003
|
+
Name | Type | Description | Notes
|
|
3004
|
+
------------- | ------------- | ------------- | -------------
|
|
3005
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
3006
|
+
**start_date** | **String**| Limit ratings to those on or after this date | [optional]
|
|
3007
|
+
**end_date** | **String**| Limit ratings to those on or before this date | [optional]
|
|
3008
|
+
**mean_greater** | **Float**| Return only records with a mean (average) higher than this value | [optional]
|
|
3009
|
+
**mean_less** | **Float**| Return only records with a mean (average) lower than this value | [optional]
|
|
3010
|
+
**strong_buys_greater** | **Integer**| Return only records with more than this many Strong Buy recommendations | [optional]
|
|
3011
|
+
**strong_buys_less** | **Integer**| Return only records with fewer than this many Strong Buy recommendations | [optional]
|
|
3012
|
+
**buys_greater** | **Integer**| Return only records with more than this many Buy recommendations | [optional]
|
|
3013
|
+
**buys_less** | **Integer**| Return only records with fewer than this many Buy recommendations | [optional]
|
|
3014
|
+
**holds_greater** | **Integer**| Return only records with more than this many Hold recommendations | [optional]
|
|
3015
|
+
**holds_less** | **Integer**| Return only records with fewer than this many Hold recommendations | [optional]
|
|
3016
|
+
**sells_greater** | **Integer**| Return only records with more than this many Sell recommendations | [optional]
|
|
3017
|
+
**sells_less** | **Integer**| Return only records with fewer than this many Sell recommendations | [optional]
|
|
3018
|
+
**strong_sells_greater** | **Integer**| Return only records with more than this many Strong Sell recommendations | [optional]
|
|
3019
|
+
**strong_sells_less** | **Integer**| Return only records with fewer than this many Strong Sell recommendations | [optional]
|
|
3020
|
+
**total_greater** | **Integer**| Return only records with more than this many recommendations, regardless of type | [optional]
|
|
3021
|
+
**total_less** | **Integer**| Return only records with fewer than this many recommendations, regardless of type | [optional]
|
|
3022
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
3023
|
+
|
|
3024
|
+
### Return type
|
|
3025
|
+
|
|
3026
|
+
[**ApiResponseSecurityZacksAnalystRatings**](ApiResponseSecurityZacksAnalystRatings.md)
|
|
3027
|
+
|
|
3028
|
+
[//]: # (END_OPERATION)
|
|
3029
|
+
|
|
3030
|
+
|
|
3031
|
+
[//]: # (START_OPERTATION)
|
|
3032
|
+
|
|
3033
|
+
[//]: # (ENDPOINT:/securities/{identifier}/zacks/analyst_ratings/snapshot)
|
|
3034
|
+
|
|
3035
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_zacks_analyst_ratings_snapshot)
|
|
3036
|
+
|
|
3037
|
+
# **get_security_zacks_analyst_ratings_snapshot**
|
|
3038
|
+
|
|
3039
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_zacks_analyst_ratings_snapshot_v2)
|
|
3040
|
+
|
|
3041
|
+
> ApiResponseSecurityZacksAnalystRatingsSnapshot get_security_zacks_analyst_ratings_snapshot(identifier, opts)
|
|
3042
|
+
|
|
3043
|
+
Zacks Analyst Ratings Snapshot
|
|
3044
|
+
|
|
3045
|
+
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.
|
|
3046
|
+
|
|
3047
|
+
### Example
|
|
3048
|
+
|
|
3049
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
3050
|
+
|
|
3051
|
+
```ruby
|
|
3052
|
+
# Load the gem
|
|
3053
|
+
require 'intrinio-sdk'
|
|
3054
|
+
|
|
3055
|
+
# Setup authorization
|
|
3056
|
+
Intrinio.configure do |config|
|
|
3057
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
3058
|
+
end
|
|
3059
|
+
|
|
3060
|
+
security_api = Intrinio::SecurityApi.new
|
|
3061
|
+
|
|
3062
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
3063
|
+
|
|
3064
|
+
opts = {
|
|
3065
|
+
date: nil # String | Lookup a historical snapshot on the given date
|
|
3066
|
+
}
|
|
3067
|
+
|
|
3068
|
+
begin
|
|
3069
|
+
result = security_api.get_security_zacks_analyst_ratings_snapshot(identifier, opts)
|
|
3070
|
+
p result
|
|
3071
|
+
rescue Intrinio::ApiError => e
|
|
3072
|
+
puts "Exception when calling SecurityApi->get_security_zacks_analyst_ratings_snapshot: #{e}"
|
|
3073
|
+
end
|
|
3074
|
+
```
|
|
3075
|
+
|
|
3076
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
3077
|
+
|
|
3078
|
+
### Parameters
|
|
3079
|
+
|
|
3080
|
+
Name | Type | Description | Notes
|
|
3081
|
+
------------- | ------------- | ------------- | -------------
|
|
3082
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
3083
|
+
**date** | **String**| Lookup a historical snapshot on the given date | [optional]
|
|
3084
|
+
|
|
3085
|
+
### Return type
|
|
3086
|
+
|
|
3087
|
+
[**ApiResponseSecurityZacksAnalystRatingsSnapshot**](ApiResponseSecurityZacksAnalystRatingsSnapshot.md)
|
|
3088
|
+
|
|
3089
|
+
[//]: # (END_OPERATION)
|
|
3090
|
+
|
|
3091
|
+
|
|
3092
|
+
[//]: # (START_OPERTATION)
|
|
3093
|
+
|
|
3094
|
+
[//]: # (ENDPOINT:/securities/{identifier}/zacks/eps_surprises)
|
|
3095
|
+
|
|
3096
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_zacks_eps_surprises)
|
|
3097
|
+
|
|
3098
|
+
# **get_security_zacks_eps_surprises**
|
|
3099
|
+
|
|
3100
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_zacks_eps_surprises_v2)
|
|
3101
|
+
|
|
3102
|
+
> ApiResponseSecurityZacksEPSSurprises get_security_zacks_eps_surprises(identifier, opts)
|
|
3103
|
+
|
|
3104
|
+
Zacks EPS Surprises for Security
|
|
3105
|
+
|
|
3106
|
+
Return Zacks EPS surprises for the Security with the given `identifier`.
|
|
3107
|
+
|
|
3108
|
+
### Example
|
|
3109
|
+
|
|
3110
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
3111
|
+
|
|
3112
|
+
```ruby
|
|
3113
|
+
# Load the gem
|
|
3114
|
+
require 'intrinio-sdk'
|
|
3115
|
+
|
|
3116
|
+
# Setup authorization
|
|
3117
|
+
Intrinio.configure do |config|
|
|
3118
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
3119
|
+
end
|
|
3120
|
+
|
|
3121
|
+
security_api = Intrinio::SecurityApi.new
|
|
3122
|
+
|
|
3123
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
3124
|
+
|
|
3125
|
+
opts = {
|
|
3126
|
+
page_size: 100, # Integer | The number of results to return
|
|
3127
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
3128
|
+
}
|
|
3129
|
+
|
|
3130
|
+
begin
|
|
3131
|
+
result = security_api.get_security_zacks_eps_surprises(identifier, opts)
|
|
3132
|
+
p result
|
|
3133
|
+
rescue Intrinio::ApiError => e
|
|
3134
|
+
puts "Exception when calling SecurityApi->get_security_zacks_eps_surprises: #{e}"
|
|
3135
|
+
end
|
|
3136
|
+
```
|
|
3137
|
+
|
|
3138
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
3139
|
+
|
|
3140
|
+
### Parameters
|
|
3141
|
+
|
|
3142
|
+
Name | Type | Description | Notes
|
|
3143
|
+
------------- | ------------- | ------------- | -------------
|
|
3144
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
3145
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
3146
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
3147
|
+
|
|
3148
|
+
### Return type
|
|
3149
|
+
|
|
3150
|
+
[**ApiResponseSecurityZacksEPSSurprises**](ApiResponseSecurityZacksEPSSurprises.md)
|
|
3151
|
+
|
|
3152
|
+
[//]: # (END_OPERATION)
|
|
3153
|
+
|
|
3154
|
+
|
|
3155
|
+
[//]: # (START_OPERTATION)
|
|
3156
|
+
|
|
3157
|
+
[//]: # (ENDPOINT:/securities/{identifier}/zacks/sales_surprises)
|
|
3158
|
+
|
|
3159
|
+
[//]: # (DOC_LINK:SecurityApi.md#get_security_zacks_sales_surprises)
|
|
3160
|
+
|
|
3161
|
+
# **get_security_zacks_sales_surprises**
|
|
3162
|
+
|
|
3163
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_zacks_sales_surprises_v2)
|
|
3164
|
+
|
|
3165
|
+
> ApiResponseSecurityZacksSalesSurprises get_security_zacks_sales_surprises(identifier, opts)
|
|
3166
|
+
|
|
3167
|
+
Zacks Sales Surprises for Security
|
|
3168
|
+
|
|
3169
|
+
Return Zacks sales surprises for the Security with the given `identifier`.
|
|
3170
|
+
|
|
3171
|
+
### Example
|
|
3172
|
+
|
|
3173
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
3174
|
+
|
|
3175
|
+
```ruby
|
|
3176
|
+
# Load the gem
|
|
3177
|
+
require 'intrinio-sdk'
|
|
3178
|
+
|
|
3179
|
+
# Setup authorization
|
|
3180
|
+
Intrinio.configure do |config|
|
|
3181
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
3182
|
+
end
|
|
3183
|
+
|
|
3184
|
+
security_api = Intrinio::SecurityApi.new
|
|
3185
|
+
|
|
3186
|
+
identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
3187
|
+
|
|
3188
|
+
opts = {
|
|
3189
|
+
page_size: 100, # Integer | The number of results to return
|
|
3190
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
3191
|
+
}
|
|
3192
|
+
|
|
3193
|
+
begin
|
|
3194
|
+
result = security_api.get_security_zacks_sales_surprises(identifier, opts)
|
|
3195
|
+
p result
|
|
3196
|
+
rescue Intrinio::ApiError => e
|
|
3197
|
+
puts "Exception when calling SecurityApi->get_security_zacks_sales_surprises: #{e}"
|
|
3198
|
+
end
|
|
3199
|
+
```
|
|
3200
|
+
|
|
3201
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
3202
|
+
|
|
3203
|
+
### Parameters
|
|
3204
|
+
|
|
3205
|
+
Name | Type | Description | Notes
|
|
3206
|
+
------------- | ------------- | ------------- | -------------
|
|
3207
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
3208
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
3209
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
3210
|
+
|
|
3211
|
+
### Return type
|
|
3212
|
+
|
|
3213
|
+
[**ApiResponseSecurityZacksSalesSurprises**](ApiResponseSecurityZacksSalesSurprises.md)
|
|
3214
|
+
|
|
3215
|
+
[//]: # (END_OPERATION)
|
|
3216
|
+
|
|
3217
|
+
|
|
3218
|
+
[//]: # (START_OPERTATION)
|
|
3219
|
+
|
|
3220
|
+
[//]: # (ENDPOINT:/securities/screen)
|
|
3221
|
+
|
|
3222
|
+
[//]: # (DOC_LINK:SecurityApi.md#screen_securities)
|
|
3223
|
+
|
|
2221
3224
|
# **screen_securities**
|
|
3225
|
+
|
|
3226
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/screen_securities_v2)
|
|
3227
|
+
|
|
2222
3228
|
> Array<SecurityScreenResult> screen_securities(opts)
|
|
2223
3229
|
|
|
2224
3230
|
Screen Securities
|
|
@@ -2226,6 +3232,9 @@ Screen Securities
|
|
|
2226
3232
|
Screen Securities using complex logic
|
|
2227
3233
|
|
|
2228
3234
|
### Example
|
|
3235
|
+
|
|
3236
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
3237
|
+
|
|
2229
3238
|
```ruby
|
|
2230
3239
|
# Load the gem
|
|
2231
3240
|
require 'intrinio-sdk'
|
|
@@ -2242,7 +3251,7 @@ opts = {
|
|
|
2242
3251
|
order_column: "order_column_example", # String | Results returned sorted by this column
|
|
2243
3252
|
order_direction: "asc", # String | Sort order to use with the order_column
|
|
2244
3253
|
primary_only: false, # BOOLEAN | Return only primary securities
|
|
2245
|
-
page_size: 100 #
|
|
3254
|
+
page_size: 100 # Integer | The number of results to return
|
|
2246
3255
|
}
|
|
2247
3256
|
|
|
2248
3257
|
begin
|
|
@@ -2253,6 +3262,8 @@ rescue Intrinio::ApiError => e
|
|
|
2253
3262
|
end
|
|
2254
3263
|
```
|
|
2255
3264
|
|
|
3265
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
3266
|
+
|
|
2256
3267
|
### Parameters
|
|
2257
3268
|
|
|
2258
3269
|
Name | Type | Description | Notes
|
|
@@ -2261,13 +3272,25 @@ Name | Type | Description | Notes
|
|
|
2261
3272
|
**order_column** | **String**| Results returned sorted by this column | [optional]
|
|
2262
3273
|
**order_direction** | **String**| Sort order to use with the order_column | [optional] [default to asc]
|
|
2263
3274
|
**primary_only** | **BOOLEAN**| Return only primary securities | [optional] [default to false]
|
|
2264
|
-
**page_size** | **
|
|
3275
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
2265
3276
|
|
|
2266
3277
|
### Return type
|
|
2267
3278
|
|
|
2268
3279
|
[**Array<SecurityScreenResult>**](SecurityScreenResult.md)
|
|
2269
3280
|
|
|
3281
|
+
[//]: # (END_OPERATION)
|
|
3282
|
+
|
|
3283
|
+
|
|
3284
|
+
[//]: # (START_OPERTATION)
|
|
3285
|
+
|
|
3286
|
+
[//]: # (ENDPOINT:/securities/search)
|
|
3287
|
+
|
|
3288
|
+
[//]: # (DOC_LINK:SecurityApi.md#search_securities)
|
|
3289
|
+
|
|
2270
3290
|
# **search_securities**
|
|
3291
|
+
|
|
3292
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/search_securities_v2)
|
|
3293
|
+
|
|
2271
3294
|
> ApiResponseSecuritiesSearch search_securities(query, opts)
|
|
2272
3295
|
|
|
2273
3296
|
Search Securities
|
|
@@ -2275,6 +3298,9 @@ Search Securities
|
|
|
2275
3298
|
Searches for Securities matching the text `query`
|
|
2276
3299
|
|
|
2277
3300
|
### Example
|
|
3301
|
+
|
|
3302
|
+
[//]: # (START_CODE_EXAMPLE)
|
|
3303
|
+
|
|
2278
3304
|
```ruby
|
|
2279
3305
|
# Load the gem
|
|
2280
3306
|
require 'intrinio-sdk'
|
|
@@ -2289,7 +3315,7 @@ security_api = Intrinio::SecurityApi.new
|
|
|
2289
3315
|
query = "Apple" # String |
|
|
2290
3316
|
|
|
2291
3317
|
opts = {
|
|
2292
|
-
page_size: 100 #
|
|
3318
|
+
page_size: 100 # Integer | The number of results to return
|
|
2293
3319
|
}
|
|
2294
3320
|
|
|
2295
3321
|
begin
|
|
@@ -2300,14 +3326,18 @@ rescue Intrinio::ApiError => e
|
|
|
2300
3326
|
end
|
|
2301
3327
|
```
|
|
2302
3328
|
|
|
3329
|
+
[//]: # (END_CODE_EXAMPLE)
|
|
3330
|
+
|
|
2303
3331
|
### Parameters
|
|
2304
3332
|
|
|
2305
3333
|
Name | Type | Description | Notes
|
|
2306
3334
|
------------- | ------------- | ------------- | -------------
|
|
2307
3335
|
**query** | **String**| |
|
|
2308
|
-
**page_size** | **
|
|
3336
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
2309
3337
|
|
|
2310
3338
|
### Return type
|
|
2311
3339
|
|
|
2312
3340
|
[**ApiResponseSecuritiesSearch**](ApiResponseSecuritiesSearch.md)
|
|
2313
3341
|
|
|
3342
|
+
[//]: # (END_OPERATION)
|
|
3343
|
+
|