intrinio-sdk 2.1.0 → 2.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +168 -2
- data/docs/AccumulationDistributionIndexTechnicalValue.md +9 -0
- data/docs/ApiResponseCryptoBook.md +12 -0
- data/docs/ApiResponseCryptoBookAsks.md +11 -0
- data/docs/ApiResponseCryptoBookBids.md +11 -0
- data/docs/ApiResponseCryptoCurrencies.md +8 -0
- data/docs/ApiResponseCryptoExchanges.md +8 -0
- data/docs/ApiResponseCryptoPairs.md +9 -0
- data/docs/ApiResponseCryptoPrices.md +12 -0
- data/docs/ApiResponseCryptoSnapshot.md +10 -0
- data/docs/ApiResponseCryptoStats.md +8 -0
- data/docs/ApiResponseOptionPrices.md +10 -0
- data/docs/ApiResponseOptions.md +9 -0
- data/docs/ApiResponseOptionsChain.md +8 -0
- data/docs/ApiResponseOptionsExpirations.md +8 -0
- data/docs/ApiResponseSecurityAccumulationDistributionIndex.md +11 -0
- data/docs/ApiResponseSecurityAverageDailyTradingVolume.md +11 -0
- data/docs/ApiResponseSecurityAverageDirectionalIndex.md +11 -0
- data/docs/ApiResponseSecurityAverageTrueRange.md +11 -0
- data/docs/ApiResponseSecurityAwesomeOscillator.md +11 -0
- data/docs/ApiResponseSecurityBollingerBands.md +11 -0
- data/docs/ApiResponseSecurityChaikinMoneyFlow.md +11 -0
- data/docs/ApiResponseSecurityCommodityChannelIndex.md +11 -0
- data/docs/ApiResponseSecurityDetrendedPriceOscillator.md +11 -0
- data/docs/ApiResponseSecurityDonchianChannel.md +11 -0
- data/docs/ApiResponseSecurityEaseOfMovement.md +11 -0
- data/docs/ApiResponseSecurityForceIndex.md +11 -0
- data/docs/ApiResponseSecurityIchimokuKinkoHyo.md +11 -0
- data/docs/ApiResponseSecurityKeltnerChannel.md +11 -0
- data/docs/ApiResponseSecurityKnowSureThing.md +11 -0
- data/docs/ApiResponseSecurityMassIndex.md +11 -0
- data/docs/ApiResponseSecurityMoneyFlowIndex.md +11 -0
- data/docs/ApiResponseSecurityMovingAverageConvergenceDivergence.md +11 -0
- data/docs/ApiResponseSecurityNegativeVolumeIndex.md +11 -0
- data/docs/ApiResponseSecurityOnBalanceVolume.md +11 -0
- data/docs/ApiResponseSecurityOnBalanceVolumeMean.md +11 -0
- data/docs/ApiResponseSecurityRelativeStrengthIndex.md +11 -0
- data/docs/ApiResponseSecuritySimpleMovingAverage.md +11 -0
- data/docs/ApiResponseSecurityStochasticOscillator.md +11 -0
- data/docs/ApiResponseSecurityTripleExponentialAverage.md +11 -0
- data/docs/ApiResponseSecurityTrueStrengthIndex.md +11 -0
- data/docs/ApiResponseSecurityUltimateOscillator.md +11 -0
- data/docs/ApiResponseSecurityVolumePriceTrend.md +11 -0
- data/docs/ApiResponseSecurityVolumeWeightedAveragePrice.md +11 -0
- data/docs/ApiResponseSecurityVortexIndicator.md +11 -0
- data/docs/ApiResponseSecurityWilliamsR.md +11 -0
- data/docs/AverageDailyTradingVolumeTechnicalValue.md +9 -0
- data/docs/AverageDirectionalIndexTechnicalValue.md +11 -0
- data/docs/AverageTrueRangeTechnicalValue.md +9 -0
- data/docs/AwesomeOscillatorTechnicalValue.md +9 -0
- data/docs/BollingerBandsTechnicalValue.md +11 -0
- data/docs/ChaikinMoneyFlowTechnicalValue.md +9 -0
- data/docs/CommodityChannelIndexTechnicalValue.md +9 -0
- data/docs/CompanyApi.md +15 -15
- data/docs/CryptoApi.md +433 -0
- data/docs/CryptoAsk.md +9 -0
- data/docs/CryptoBid.md +9 -0
- data/docs/CryptoBookEntry.md +9 -0
- data/docs/CryptoCurrency.md +12 -0
- data/docs/CryptoExchange.md +13 -0
- data/docs/CryptoExchangeSummary.md +9 -0
- data/docs/CryptoPair.md +15 -0
- data/docs/CryptoPairSummary.md +9 -0
- data/docs/CryptoPrice.md +13 -0
- data/docs/CryptoSnapshot.md +22 -0
- data/docs/CryptoStat.md +15 -0
- data/docs/DataPointApi.md +10 -10
- data/docs/DetrendedPriceOscillatorTechnicalValue.md +9 -0
- data/docs/DonchianChannelTechnicalValue.md +10 -0
- data/docs/EaseOfMovementTechnicalValue.md +9 -0
- data/docs/ForceIndexTechnicalValue.md +9 -0
- data/docs/FundamentalsApi.md +4 -4
- data/docs/HistoricalDataApi.md +7 -5
- data/docs/IchimokuKinkoHyoTechnicalValue.md +13 -0
- data/docs/KeltnerChannelTechnicalValue.md +11 -0
- data/docs/KnowSureThingTechnicalValue.md +9 -0
- data/docs/MassIndexTechnicalValue.md +9 -0
- data/docs/MoneyFlowIndexTechnicalValue.md +9 -0
- data/docs/MovingAverageConvergenceDivergenceTechnicalValue.md +11 -0
- data/docs/NegativeVolumeIndexTechnicalValue.md +9 -0
- data/docs/OnBalanceVolumeMeanTechnicalValue.md +9 -0
- data/docs/OnBalanceVolumeTechnicalValue.md +9 -0
- data/docs/Option.md +13 -0
- data/docs/OptionChain.md +9 -0
- data/docs/OptionPrice.md +21 -0
- data/docs/OptionsApi.md +225 -0
- data/docs/RelativeStrengthIndexTechnicalValue.md +9 -0
- data/docs/ReportedFinancial.md +1 -0
- data/docs/ReportedFinancialDimension.md +9 -0
- data/docs/Security.md +1 -0
- data/docs/SecurityApi.md +1717 -22
- data/docs/SimpleMovingAverageTechnicalValue.md +9 -0
- data/docs/StochasticOscillatorTechnicalValue.md +10 -0
- data/docs/StockExchangeApi.md +6 -6
- data/docs/TechnicalApi.md +1701 -0
- data/docs/TechnicalIndicator.md +9 -0
- data/docs/TripleExponentialAverageTechnicalValue.md +9 -0
- data/docs/TrueStrengthIndexTechnicalValue.md +9 -0
- data/docs/UltimateOscillatorTechnicalValue.md +9 -0
- data/docs/VolumePriceTrendTechnicalValue.md +9 -0
- data/docs/VolumeWeightedAveragePriceValue.md +9 -0
- data/docs/VortexIndicatorTechnicalValue.md +10 -0
- data/docs/WilliamsRTechnicalValue.md +9 -0
- data/intrinio-sdk.gemspec +1 -1
- data/lib/intrinio-sdk.rb +95 -1
- data/lib/intrinio-sdk/api/company_api.rb +19 -19
- data/lib/intrinio-sdk/api/crypto_api.rb +560 -0
- data/lib/intrinio-sdk/api/data_point_api.rb +13 -13
- data/lib/intrinio-sdk/api/data_tag_api.rb +1 -1
- data/lib/intrinio-sdk/api/filing_api.rb +1 -1
- data/lib/intrinio-sdk/api/forex_api.rb +1 -1
- data/lib/intrinio-sdk/api/fundamentals_api.rb +5 -5
- data/lib/intrinio-sdk/api/historical_data_api.rb +13 -7
- data/lib/intrinio-sdk/api/index_api.rb +1 -1
- data/lib/intrinio-sdk/api/municipality_api.rb +1 -1
- data/lib/intrinio-sdk/api/options_api.rb +325 -0
- data/lib/intrinio-sdk/api/security_api.rb +2472 -21
- data/lib/intrinio-sdk/api/stock_exchange_api.rb +3 -3
- data/lib/intrinio-sdk/api/technical_api.rb +2474 -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 +199 -0
- 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_book.rb +231 -0
- data/lib/intrinio-sdk/models/api_response_crypto_book_asks.rb +219 -0
- data/lib/intrinio-sdk/models/api_response_crypto_book_bids.rb +219 -0
- data/lib/intrinio-sdk/models/api_response_crypto_currencies.rb +191 -0
- data/lib/intrinio-sdk/models/api_response_crypto_exchanges.rb +191 -0
- data/lib/intrinio-sdk/models/api_response_crypto_pairs.rb +201 -0
- data/lib/intrinio-sdk/models/api_response_crypto_prices.rb +229 -0
- data/lib/intrinio-sdk/models/api_response_crypto_snapshot.rb +206 -0
- data/lib/intrinio-sdk/models/api_response_crypto_stats.rb +191 -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 +210 -0
- data/lib/intrinio-sdk/models/api_response_options.rb +201 -0
- data/lib/intrinio-sdk/models/api_response_options_chain.rb +191 -0
- data/lib/intrinio-sdk/models/api_response_options_expirations.rb +191 -0
- 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 +220 -0
- data/lib/intrinio-sdk/models/api_response_security_average_daily_trading_volume.rb +220 -0
- data/lib/intrinio-sdk/models/api_response_security_average_directional_index.rb +220 -0
- data/lib/intrinio-sdk/models/api_response_security_average_true_range.rb +220 -0
- data/lib/intrinio-sdk/models/api_response_security_awesome_oscillator.rb +220 -0
- data/lib/intrinio-sdk/models/api_response_security_bollinger_bands.rb +220 -0
- data/lib/intrinio-sdk/models/api_response_security_chaikin_money_flow.rb +220 -0
- data/lib/intrinio-sdk/models/api_response_security_commodity_channel_index.rb +220 -0
- data/lib/intrinio-sdk/models/api_response_security_detrended_price_oscillator.rb +220 -0
- data/lib/intrinio-sdk/models/api_response_security_donchian_channel.rb +220 -0
- data/lib/intrinio-sdk/models/api_response_security_ease_of_movement.rb +220 -0
- data/lib/intrinio-sdk/models/api_response_security_force_index.rb +220 -0
- 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 +220 -0
- data/lib/intrinio-sdk/models/api_response_security_intraday_prices.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_keltner_channel.rb +220 -0
- data/lib/intrinio-sdk/models/api_response_security_know_sure_thing.rb +220 -0
- data/lib/intrinio-sdk/models/api_response_security_mass_index.rb +220 -0
- data/lib/intrinio-sdk/models/api_response_security_money_flow_index.rb +220 -0
- data/lib/intrinio-sdk/models/api_response_security_moving_average_convergence_divergence.rb +220 -0
- data/lib/intrinio-sdk/models/api_response_security_negative_volume_index.rb +220 -0
- data/lib/intrinio-sdk/models/api_response_security_on_balance_volume.rb +220 -0
- data/lib/intrinio-sdk/models/api_response_security_on_balance_volume_mean.rb +220 -0
- data/lib/intrinio-sdk/models/api_response_security_relative_strength_index.rb +220 -0
- data/lib/intrinio-sdk/models/api_response_security_simple_moving_average.rb +220 -0
- data/lib/intrinio-sdk/models/api_response_security_stochastic_oscillator.rb +220 -0
- 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 +220 -0
- data/lib/intrinio-sdk/models/api_response_security_true_strength_index.rb +220 -0
- data/lib/intrinio-sdk/models/api_response_security_ultimate_oscillator.rb +220 -0
- data/lib/intrinio-sdk/models/api_response_security_volume_price_trend.rb +220 -0
- data/lib/intrinio-sdk/models/api_response_security_volume_weighted_average_price.rb +220 -0
- data/lib/intrinio-sdk/models/api_response_security_vortex_indicator.rb +220 -0
- data/lib/intrinio-sdk/models/api_response_security_williams_r.rb +220 -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/average_daily_trading_volume_technical_value.rb +199 -0
- data/lib/intrinio-sdk/models/average_directional_index_technical_value.rb +219 -0
- data/lib/intrinio-sdk/models/average_true_range_technical_value.rb +199 -0
- data/lib/intrinio-sdk/models/awesome_oscillator_technical_value.rb +199 -0
- data/lib/intrinio-sdk/models/bollinger_bands_technical_value.rb +219 -0
- data/lib/intrinio-sdk/models/chaikin_money_flow_technical_value.rb +199 -0
- data/lib/intrinio-sdk/models/commodity_channel_index_technical_value.rb +199 -0
- data/lib/intrinio-sdk/models/company.rb +1 -1
- 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 +199 -0
- data/lib/intrinio-sdk/models/crypto_bid.rb +199 -0
- data/lib/intrinio-sdk/models/crypto_book_entry.rb +199 -0
- data/lib/intrinio-sdk/models/crypto_currency.rb +229 -0
- data/lib/intrinio-sdk/models/crypto_exchange.rb +239 -0
- data/lib/intrinio-sdk/models/crypto_exchange_summary.rb +199 -0
- data/lib/intrinio-sdk/models/crypto_pair.rb +259 -0
- data/lib/intrinio-sdk/models/crypto_pair_summary.rb +199 -0
- data/lib/intrinio-sdk/models/crypto_price.rb +239 -0
- data/lib/intrinio-sdk/models/crypto_snapshot.rb +329 -0
- data/lib/intrinio-sdk/models/crypto_stat.rb +259 -0
- 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 +199 -0
- data/lib/intrinio-sdk/models/dividend_record.rb +1 -1
- data/lib/intrinio-sdk/models/donchian_channel_technical_value.rb +209 -0
- data/lib/intrinio-sdk/models/earnings_record.rb +1 -1
- data/lib/intrinio-sdk/models/ease_of_movement_technical_value.rb +199 -0
- 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 +199 -0
- data/lib/intrinio-sdk/models/forex_currency.rb +1 -1
- data/lib/intrinio-sdk/models/forex_pair.rb +1 -1
- data/lib/intrinio-sdk/models/forex_price.rb +1 -1
- data/lib/intrinio-sdk/models/fundamental.rb +1 -1
- data/lib/intrinio-sdk/models/fundamental_summary.rb +1 -1
- data/lib/intrinio-sdk/models/historical_data.rb +1 -1
- data/lib/intrinio-sdk/models/ichimoku_kinko_hyo_technical_value.rb +239 -0
- data/lib/intrinio-sdk/models/intraday_stock_price.rb +1 -1
- data/lib/intrinio-sdk/models/keltner_channel_technical_value.rb +219 -0
- data/lib/intrinio-sdk/models/know_sure_thing_technical_value.rb +199 -0
- data/lib/intrinio-sdk/models/mass_index_technical_value.rb +199 -0
- data/lib/intrinio-sdk/models/money_flow_index_technical_value.rb +199 -0
- data/lib/intrinio-sdk/models/moving_average_convergence_divergence_technical_value.rb +219 -0
- 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 +199 -0
- data/lib/intrinio-sdk/models/on_balance_volume_mean_technical_value.rb +199 -0
- data/lib/intrinio-sdk/models/on_balance_volume_technical_value.rb +199 -0
- data/lib/intrinio-sdk/models/option.rb +239 -0
- data/lib/intrinio-sdk/models/option_chain.rb +197 -0
- data/lib/intrinio-sdk/models/option_price.rb +319 -0
- 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 +199 -0
- data/lib/intrinio-sdk/models/reported_financial.rb +18 -6
- data/lib/intrinio-sdk/models/reported_financial_dimension.rb +199 -0
- data/lib/intrinio-sdk/models/reported_tag.rb +1 -1
- data/lib/intrinio-sdk/models/security.rb +15 -5
- 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 +199 -0
- data/lib/intrinio-sdk/models/standardized_financial.rb +1 -1
- data/lib/intrinio-sdk/models/stochastic_oscillator_technical_value.rb +209 -0
- 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 +199 -0
- data/lib/intrinio-sdk/models/triple_exponential_average_technical_value.rb +199 -0
- data/lib/intrinio-sdk/models/true_strength_index_technical_value.rb +199 -0
- data/lib/intrinio-sdk/models/ultimate_oscillator_technical_value.rb +199 -0
- data/lib/intrinio-sdk/models/volume_price_trend_technical_value.rb +199 -0
- data/lib/intrinio-sdk/models/volume_weighted_average_price_value.rb +199 -0
- data/lib/intrinio-sdk/models/vortex_indicator_technical_value.rb +209 -0
- data/lib/intrinio-sdk/models/williams_r_technical_value.rb +199 -0
- data/lib/intrinio-sdk/version.rb +2 -2
- data/spec/api/company_api_spec.rb +9 -9
- data/spec/api/crypto_api_spec.rb +166 -0
- data/spec/api/data_point_api_spec.rb +6 -6
- data/spec/api/fundamentals_api_spec.rb +2 -2
- data/spec/api/historical_data_api_spec.rb +4 -3
- data/spec/api/options_api_spec.rb +105 -0
- data/spec/api/security_api_spec.rb +562 -10
- data/spec/api/stock_exchange_api_spec.rb +1 -1
- data/spec/api/technical_api_spec.rb +587 -0
- data/spec/models/accumulation_distribution_index_technical_value_spec.rb +48 -0
- data/spec/models/api_response_crypto_book_asks_spec.rb +60 -0
- data/spec/models/api_response_crypto_book_bids_spec.rb +60 -0
- data/spec/models/api_response_crypto_book_spec.rb +66 -0
- data/spec/models/api_response_crypto_currencies_spec.rb +42 -0
- data/spec/models/api_response_crypto_exchanges_spec.rb +42 -0
- data/spec/models/api_response_crypto_pairs_spec.rb +48 -0
- data/spec/models/api_response_crypto_prices_spec.rb +66 -0
- data/spec/models/api_response_crypto_snapshot_spec.rb +54 -0
- data/spec/models/api_response_crypto_stats_spec.rb +42 -0
- data/spec/models/api_response_option_prices_spec.rb +54 -0
- data/spec/models/api_response_options_chain_spec.rb +42 -0
- data/spec/models/api_response_options_expirations_spec.rb +42 -0
- data/spec/models/api_response_options_spec.rb +48 -0
- data/spec/models/api_response_security_accumulation_distribution_index_spec.rb +60 -0
- data/spec/models/api_response_security_average_daily_trading_volume_spec.rb +60 -0
- data/spec/models/api_response_security_average_directional_index_spec.rb +60 -0
- data/spec/models/api_response_security_average_true_range_spec.rb +60 -0
- data/spec/models/api_response_security_awesome_oscillator_spec.rb +60 -0
- data/spec/models/api_response_security_bollinger_bands_spec.rb +60 -0
- data/spec/models/api_response_security_chaikin_money_flow_spec.rb +60 -0
- data/spec/models/api_response_security_commodity_channel_index_spec.rb +60 -0
- data/spec/models/api_response_security_detrended_price_oscillator_spec.rb +60 -0
- data/spec/models/api_response_security_donchian_channel_spec.rb +60 -0
- data/spec/models/api_response_security_ease_of_movement_spec.rb +60 -0
- data/spec/models/api_response_security_force_index_spec.rb +60 -0
- data/spec/models/api_response_security_ichimoku_kinko_hyo_spec.rb +60 -0
- data/spec/models/api_response_security_keltner_channel_spec.rb +60 -0
- data/spec/models/api_response_security_know_sure_thing_spec.rb +60 -0
- data/spec/models/api_response_security_mass_index_spec.rb +60 -0
- data/spec/models/api_response_security_money_flow_index_spec.rb +60 -0
- data/spec/models/api_response_security_moving_average_convergence_divergence_spec.rb +60 -0
- data/spec/models/api_response_security_negative_volume_index_spec.rb +60 -0
- data/spec/models/api_response_security_on_balance_volume_mean_spec.rb +60 -0
- data/spec/models/api_response_security_on_balance_volume_spec.rb +60 -0
- data/spec/models/api_response_security_relative_strength_index_spec.rb +60 -0
- data/spec/models/api_response_security_simple_moving_average_spec.rb +60 -0
- data/spec/models/api_response_security_stochastic_oscillator_spec.rb +60 -0
- data/spec/models/api_response_security_triple_exponential_average_spec.rb +60 -0
- data/spec/models/api_response_security_true_strength_index_spec.rb +60 -0
- data/spec/models/api_response_security_ultimate_oscillator_spec.rb +60 -0
- data/spec/models/api_response_security_volume_price_trend_spec.rb +60 -0
- data/spec/models/api_response_security_volume_weighted_average_price_spec.rb +60 -0
- data/spec/models/api_response_security_vortex_indicator_spec.rb +60 -0
- data/spec/models/api_response_security_williams_r_spec.rb +60 -0
- data/spec/models/average_daily_trading_volume_technical_value_spec.rb +48 -0
- data/spec/models/average_directional_index_technical_value_spec.rb +60 -0
- data/spec/models/average_true_range_technical_value_spec.rb +48 -0
- data/spec/models/awesome_oscillator_technical_value_spec.rb +48 -0
- data/spec/models/bollinger_bands_technical_value_spec.rb +60 -0
- data/spec/models/chaikin_money_flow_technical_value_spec.rb +48 -0
- data/spec/models/commodity_channel_index_technical_value_spec.rb +48 -0
- data/spec/models/crypto_ask_spec.rb +48 -0
- data/spec/models/crypto_bid_spec.rb +48 -0
- data/spec/models/crypto_book_entry_spec.rb +48 -0
- data/spec/models/crypto_currency_spec.rb +66 -0
- data/spec/models/crypto_exchange_spec.rb +72 -0
- data/spec/models/crypto_exchange_summary_spec.rb +48 -0
- data/spec/models/crypto_pair_spec.rb +84 -0
- data/spec/models/crypto_pair_summary_spec.rb +48 -0
- data/spec/models/crypto_price_spec.rb +72 -0
- data/spec/models/crypto_snapshot_spec.rb +126 -0
- data/spec/models/crypto_stat_spec.rb +84 -0
- data/spec/models/detrended_price_oscillator_technical_value_spec.rb +48 -0
- data/spec/models/donchian_channel_technical_value_spec.rb +54 -0
- data/spec/models/ease_of_movement_technical_value_spec.rb +48 -0
- data/spec/models/force_index_technical_value_spec.rb +48 -0
- data/spec/models/ichimoku_kinko_hyo_technical_value_spec.rb +72 -0
- data/spec/models/keltner_channel_technical_value_spec.rb +60 -0
- data/spec/models/know_sure_thing_technical_value_spec.rb +48 -0
- data/spec/models/mass_index_technical_value_spec.rb +48 -0
- data/spec/models/money_flow_index_technical_value_spec.rb +48 -0
- data/spec/models/moving_average_convergence_divergence_technical_value_spec.rb +60 -0
- data/spec/models/negative_volume_index_technical_value_spec.rb +48 -0
- data/spec/models/on_balance_volume_mean_technical_value_spec.rb +48 -0
- data/spec/models/on_balance_volume_technical_value_spec.rb +48 -0
- data/spec/models/option_chain_spec.rb +48 -0
- data/spec/models/option_price_spec.rb +120 -0
- data/spec/models/option_spec.rb +72 -0
- data/spec/models/relative_strength_index_technical_value_spec.rb +48 -0
- data/spec/models/reported_financial_dimension_spec.rb +48 -0
- data/spec/models/reported_financial_spec.rb +6 -0
- data/spec/models/security_spec.rb +6 -0
- data/spec/models/simple_moving_average_technical_value_spec.rb +48 -0
- data/spec/models/stochastic_oscillator_technical_value_spec.rb +54 -0
- data/spec/models/technical_indicator_spec.rb +48 -0
- data/spec/models/triple_exponential_average_technical_value_spec.rb +48 -0
- data/spec/models/true_strength_index_technical_value_spec.rb +48 -0
- data/spec/models/ultimate_oscillator_technical_value_spec.rb +48 -0
- data/spec/models/volume_price_trend_technical_value_spec.rb +48 -0
- data/spec/models/volume_weighted_average_price_value_spec.rb +48 -0
- data/spec/models/vortex_indicator_technical_value_spec.rb +54 -0
- data/spec/models/williams_r_technical_value_spec.rb +48 -0
- metadata +378 -2
data/docs/OptionChain.md
ADDED
data/docs/OptionPrice.md
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
# Intrinio::OptionPrice
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**date** | **String** | The date of the price, in the format YYYY-MM-DD | [optional]
|
7
|
+
**close** | **Float** | The closing price of the options contract. | [optional]
|
8
|
+
**close_bid** | **Float** | The closing bid price of the options contract. | [optional]
|
9
|
+
**close_ask** | **Float** | The closing ask price of the options contract. | [optional]
|
10
|
+
**volume** | **Integer** | The cumulative volume of this options contract that traded that day. | [optional]
|
11
|
+
**volume_bid** | **Integer** | The cumulative volume of this options contract that traded on the bid price that day. | [optional]
|
12
|
+
**volume_ask** | **Integer** | The cumulative volume of this options contract that traded on the ask price that day. | [optional]
|
13
|
+
**trades** | **Integer** | The number of trades executed that for this options contract on that day. | [optional]
|
14
|
+
**open_interest** | **Integer** | The total number of this options contract that are still open. | [optional]
|
15
|
+
**open_interest_change** | **Integer** | The change in the total number of this options contract that are still open from the previous day. | [optional]
|
16
|
+
**next_day_open_interest** | **Integer** | The total number of this options contract that are still open at the start of the next day. | [optional]
|
17
|
+
**implied_volatility** | **Float** | The estimated volatility of the Security's price. Volatility is a statistical measure of dispersion of returns for the Security. Standard deviation of a Security's returns and a market index is an example of a measurement of volatility. Implied volatility approximates the future value of an option, and the option's current value takes this into consideration. | [optional]
|
18
|
+
**implied_volatility_change** | **Float** | The change in implied volatility for that day. | [optional]
|
19
|
+
**delta** | **Float** | Delta measures the degree to which an options contract is exposed to shifts in the price of the underlying Security. Values of delta range from 0.0 to 1.0 for call options and -1.0 to 0.0 for put options. For example, if a put option has a delta of -0.50, if the price of the underlying Security increases by $1, the price of the put option will decrease by $0.50. | [optional]
|
20
|
+
|
21
|
+
|
data/docs/OptionsApi.md
ADDED
@@ -0,0 +1,225 @@
|
|
1
|
+
# Intrinio::OptionsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api-v2.intrinio.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**get_options**](OptionsApi.md#get_options) | **GET** /options/{symbol} | Options
|
8
|
+
[**get_options_chain**](OptionsApi.md#get_options_chain) | **GET** /options/chain/{symbol}/{expiration} | Options Chain
|
9
|
+
[**get_options_expirations**](OptionsApi.md#get_options_expirations) | **GET** /options/expirations/{symbol} | Options Expirations
|
10
|
+
[**get_options_prices**](OptionsApi.md#get_options_prices) | **GET** /options/prices/{identifier} | Option Prices
|
11
|
+
|
12
|
+
|
13
|
+
# **get_options**
|
14
|
+
> ApiResponseOptions get_options(symbol, opts)
|
15
|
+
|
16
|
+
Options
|
17
|
+
|
18
|
+
Returns the master list of option contracts for a given symbol.
|
19
|
+
|
20
|
+
### Example
|
21
|
+
```ruby
|
22
|
+
# Load the gem
|
23
|
+
require 'intrinio-sdk'
|
24
|
+
|
25
|
+
# Setup authorization
|
26
|
+
Intrinio.configure do |config|
|
27
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
28
|
+
end
|
29
|
+
|
30
|
+
options_api = Intrinio::OptionsApi.new
|
31
|
+
|
32
|
+
symbol = "MSFT" # String | The option symbol, corresponding to the underlying security.
|
33
|
+
|
34
|
+
opts = {
|
35
|
+
type: "put", # String | The option contract type.
|
36
|
+
strike: 170.0, # Float | The strike price of the option contract. This will return options contracts with strike price equal to this price.
|
37
|
+
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.
|
38
|
+
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.
|
39
|
+
expiration: "2019-03-01", # String | The expiration date of the option contract. This will return options contracts with expiration dates on this date.
|
40
|
+
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
|
+
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, # Float | The number of results to return
|
43
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
44
|
+
}
|
45
|
+
|
46
|
+
begin
|
47
|
+
result = options_api.get_options(symbol, opts)
|
48
|
+
p result
|
49
|
+
rescue Intrinio::ApiError => e
|
50
|
+
puts "Exception when calling OptionsApi->get_options: #{e}"
|
51
|
+
end
|
52
|
+
```
|
53
|
+
|
54
|
+
### Parameters
|
55
|
+
|
56
|
+
Name | Type | Description | Notes
|
57
|
+
------------- | ------------- | ------------- | -------------
|
58
|
+
**symbol** | **String**| The option symbol, corresponding to the underlying security. |
|
59
|
+
**type** | **String**| The option contract type. | [optional]
|
60
|
+
**strike** | **Float**| The strike price of the option contract. This will return options contracts with strike price equal to this price. | [optional]
|
61
|
+
**strike_greater_than** | **Float**| The strike price of the option contract. This will return options contracts with strike prices greater than this price. | [optional]
|
62
|
+
**strike_less_than** | **Float**| The strike price of the option contract. This will return options contracts with strike prices less than this price. | [optional]
|
63
|
+
**expiration** | **String**| The expiration date of the option contract. This will return options contracts with expiration dates on this date. | [optional]
|
64
|
+
**expiration_after** | **String**| The expiration date of the option contract. This will return options contracts with expiration dates after this date. | [optional]
|
65
|
+
**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** | **Float**| The number of results to return | [optional] [default to 100]
|
67
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
68
|
+
|
69
|
+
### Return type
|
70
|
+
|
71
|
+
[**ApiResponseOptions**](ApiResponseOptions.md)
|
72
|
+
|
73
|
+
# **get_options_chain**
|
74
|
+
> ApiResponseOptionsChain get_options_chain(symbol, expiration, opts)
|
75
|
+
|
76
|
+
Options Chain
|
77
|
+
|
78
|
+
Returns all options contracts and their prices for the given symbol and expiration date.
|
79
|
+
|
80
|
+
### Example
|
81
|
+
```ruby
|
82
|
+
# Load the gem
|
83
|
+
require 'intrinio-sdk'
|
84
|
+
|
85
|
+
# Setup authorization
|
86
|
+
Intrinio.configure do |config|
|
87
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
88
|
+
end
|
89
|
+
|
90
|
+
options_api = Intrinio::OptionsApi.new
|
91
|
+
|
92
|
+
symbol = "MSFT" # String | The option symbol, corresponding to the underlying security.
|
93
|
+
|
94
|
+
expiration = "2019-03-06" # String | The expiration date of the options contract
|
95
|
+
|
96
|
+
opts = {
|
97
|
+
type: "put", # String | The option contract type.
|
98
|
+
strike: 170.0, # Float | The strike price of the option contract. This will return options contracts with strike price equal to this price.
|
99
|
+
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
|
+
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
|
+
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 # Float | The number of results to return
|
103
|
+
}
|
104
|
+
|
105
|
+
begin
|
106
|
+
result = options_api.get_options_chain(symbol, expiration, opts)
|
107
|
+
p result
|
108
|
+
rescue Intrinio::ApiError => e
|
109
|
+
puts "Exception when calling OptionsApi->get_options_chain: #{e}"
|
110
|
+
end
|
111
|
+
```
|
112
|
+
|
113
|
+
### Parameters
|
114
|
+
|
115
|
+
Name | Type | Description | Notes
|
116
|
+
------------- | ------------- | ------------- | -------------
|
117
|
+
**symbol** | **String**| The option symbol, corresponding to the underlying security. |
|
118
|
+
**expiration** | **String**| The expiration date of the options contract |
|
119
|
+
**type** | **String**| The option contract type. | [optional]
|
120
|
+
**strike** | **Float**| The strike price of the option contract. This will return options contracts with strike price equal to this price. | [optional]
|
121
|
+
**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
|
+
**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
|
+
**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** | **Float**| The number of results to return | [optional] [default to 100]
|
125
|
+
|
126
|
+
### Return type
|
127
|
+
|
128
|
+
[**ApiResponseOptionsChain**](ApiResponseOptionsChain.md)
|
129
|
+
|
130
|
+
# **get_options_expirations**
|
131
|
+
> ApiResponseOptionsExpirations get_options_expirations(symbol, opts)
|
132
|
+
|
133
|
+
Options Expirations
|
134
|
+
|
135
|
+
Returns all option contract expiration dates for a given symbol.
|
136
|
+
|
137
|
+
### Example
|
138
|
+
```ruby
|
139
|
+
# Load the gem
|
140
|
+
require 'intrinio-sdk'
|
141
|
+
|
142
|
+
# Setup authorization
|
143
|
+
Intrinio.configure do |config|
|
144
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
145
|
+
end
|
146
|
+
|
147
|
+
options_api = Intrinio::OptionsApi.new
|
148
|
+
|
149
|
+
symbol = "MSFT" # String | The option symbol, corresponding to the underlying security.
|
150
|
+
|
151
|
+
opts = {
|
152
|
+
after: "2019-01-01", # String | Return option contract expiration dates after this date.
|
153
|
+
before: "2019-12-31" # String | Return option contract expiration dates before this date.
|
154
|
+
}
|
155
|
+
|
156
|
+
begin
|
157
|
+
result = options_api.get_options_expirations(symbol, opts)
|
158
|
+
p result
|
159
|
+
rescue Intrinio::ApiError => e
|
160
|
+
puts "Exception when calling OptionsApi->get_options_expirations: #{e}"
|
161
|
+
end
|
162
|
+
```
|
163
|
+
|
164
|
+
### Parameters
|
165
|
+
|
166
|
+
Name | Type | Description | Notes
|
167
|
+
------------- | ------------- | ------------- | -------------
|
168
|
+
**symbol** | **String**| The option symbol, corresponding to the underlying security. |
|
169
|
+
**after** | **String**| Return option contract expiration dates after this date. | [optional]
|
170
|
+
**before** | **String**| Return option contract expiration dates before this date. | [optional]
|
171
|
+
|
172
|
+
### Return type
|
173
|
+
|
174
|
+
[**ApiResponseOptionsExpirations**](ApiResponseOptionsExpirations.md)
|
175
|
+
|
176
|
+
# **get_options_prices**
|
177
|
+
> ApiResponseOptionPrices get_options_prices(identifier, opts)
|
178
|
+
|
179
|
+
Option Prices
|
180
|
+
|
181
|
+
Returns all option prices for a given option contract identifier.
|
182
|
+
|
183
|
+
### Example
|
184
|
+
```ruby
|
185
|
+
# Load the gem
|
186
|
+
require 'intrinio-sdk'
|
187
|
+
|
188
|
+
# Setup authorization
|
189
|
+
Intrinio.configure do |config|
|
190
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
191
|
+
end
|
192
|
+
|
193
|
+
options_api = Intrinio::OptionsApi.new
|
194
|
+
|
195
|
+
identifier = "null" # String | The Intrinio ID or code of the options contract to request prices for.
|
196
|
+
|
197
|
+
opts = {
|
198
|
+
start_date: "2019-01-01", # String | Return option contract prices on or after this date.
|
199
|
+
end_date: "2019-12-31", # String | Return option contract prices on or before this date.
|
200
|
+
page_size: 100, # Float | The number of results to return
|
201
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
202
|
+
}
|
203
|
+
|
204
|
+
begin
|
205
|
+
result = options_api.get_options_prices(identifier, opts)
|
206
|
+
p result
|
207
|
+
rescue Intrinio::ApiError => e
|
208
|
+
puts "Exception when calling OptionsApi->get_options_prices: #{e}"
|
209
|
+
end
|
210
|
+
```
|
211
|
+
|
212
|
+
### Parameters
|
213
|
+
|
214
|
+
Name | Type | Description | Notes
|
215
|
+
------------- | ------------- | ------------- | -------------
|
216
|
+
**identifier** | **String**| The Intrinio ID or code of the options contract to request prices for. |
|
217
|
+
**start_date** | **String**| Return option contract prices on or after this date. | [optional]
|
218
|
+
**end_date** | **String**| Return option contract prices on or before this date. | [optional]
|
219
|
+
**page_size** | **Float**| The number of results to return | [optional] [default to 100]
|
220
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
221
|
+
|
222
|
+
### Return type
|
223
|
+
|
224
|
+
[**ApiResponseOptionPrices**](ApiResponseOptionPrices.md)
|
225
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# Intrinio::RelativeStrengthIndexTechnicalValue
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**date_time** | **DateTime** | The date_time of the observation | [optional]
|
7
|
+
**rsi** | **Float** | The Relative Strength Index calculation value | [optional]
|
8
|
+
|
9
|
+
|
data/docs/ReportedFinancial.md
CHANGED
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**xbrl_tag** | [**ReportedTag**](ReportedTag.md) | | [optional]
|
7
7
|
**value** | **Float** | The value reported for the XBRL Tag within the scope of the Fundamental | [optional]
|
8
|
+
**dimensions** | [**Array<ReportedFinancialDimension>**](ReportedFinancialDimension.md) | The combination of XBRL axis and members that defines the dimensionalization of this fact (if any) | [optional]
|
8
9
|
|
9
10
|
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# Intrinio::ReportedFinancialDimension
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**axis** | **String** | The axis of the dimension | [optional]
|
7
|
+
**member** | **String** | The member of the axis | [optional]
|
8
|
+
|
9
|
+
|
data/docs/Security.md
CHANGED
@@ -30,5 +30,6 @@ Name | Type | Description | Notes
|
|
30
30
|
**last_stock_price_adjustment** | **Date** | The date of the last stock price adjustment (dividend, split, etc) | [optional]
|
31
31
|
**last_corporate_action** | **Date** | The date of the last corporate action | [optional]
|
32
32
|
**previous_tickers** | **Array<String>** | Previous tickers used by this security | [optional]
|
33
|
+
**listing_exchange_mic** | **String** | The MIC code of the exchange on which this security primarily trades | [optional]
|
33
34
|
|
34
35
|
|
data/docs/SecurityApi.md
CHANGED
@@ -12,6 +12,37 @@ Method | HTTP request | Description
|
|
12
12
|
[**get_security_intraday_prices**](SecurityApi.md#get_security_intraday_prices) | **GET** /securities/{identifier}/prices/intraday | Intraday Stock Prices for Security
|
13
13
|
[**get_security_latest_dividend_record**](SecurityApi.md#get_security_latest_dividend_record) | **GET** /securities/{identifier}/dividends/latest | Lastest Dividend Record for Security
|
14
14
|
[**get_security_latest_earnings_record**](SecurityApi.md#get_security_latest_earnings_record) | **GET** /securities/{identifier}/earnings/latest | Lastest Earnings Record for Security
|
15
|
+
[**get_security_price_technicals_adi**](SecurityApi.md#get_security_price_technicals_adi) | **GET** /securities/{identifier}/prices/technicals/adi | Accumulation/Distribution Index
|
16
|
+
[**get_security_price_technicals_adtv**](SecurityApi.md#get_security_price_technicals_adtv) | **GET** /securities/{identifier}/prices/technicals/adtv | Average Daily Trading Volume
|
17
|
+
[**get_security_price_technicals_adx**](SecurityApi.md#get_security_price_technicals_adx) | **GET** /securities/{identifier}/prices/technicals/adx | Average Directional Index
|
18
|
+
[**get_security_price_technicals_ao**](SecurityApi.md#get_security_price_technicals_ao) | **GET** /securities/{identifier}/prices/technicals/ao | Awesome Oscillator
|
19
|
+
[**get_security_price_technicals_atr**](SecurityApi.md#get_security_price_technicals_atr) | **GET** /securities/{identifier}/prices/technicals/atr | Average True Range
|
20
|
+
[**get_security_price_technicals_bb**](SecurityApi.md#get_security_price_technicals_bb) | **GET** /securities/{identifier}/prices/technicals/bb | Bollinger Bands
|
21
|
+
[**get_security_price_technicals_cci**](SecurityApi.md#get_security_price_technicals_cci) | **GET** /securities/{identifier}/prices/technicals/cci | Commodity Channel Index
|
22
|
+
[**get_security_price_technicals_cmf**](SecurityApi.md#get_security_price_technicals_cmf) | **GET** /securities/{identifier}/prices/technicals/cmf | Chaikin Money Flow
|
23
|
+
[**get_security_price_technicals_dc**](SecurityApi.md#get_security_price_technicals_dc) | **GET** /securities/{identifier}/prices/technicals/dc | Donchian Channel
|
24
|
+
[**get_security_price_technicals_dpo**](SecurityApi.md#get_security_price_technicals_dpo) | **GET** /securities/{identifier}/prices/technicals/dpo | Detrended Price Oscillator
|
25
|
+
[**get_security_price_technicals_eom**](SecurityApi.md#get_security_price_technicals_eom) | **GET** /securities/{identifier}/prices/technicals/eom | Ease of Movement
|
26
|
+
[**get_security_price_technicals_fi**](SecurityApi.md#get_security_price_technicals_fi) | **GET** /securities/{identifier}/prices/technicals/fi | Force Index
|
27
|
+
[**get_security_price_technicals_ichimoku**](SecurityApi.md#get_security_price_technicals_ichimoku) | **GET** /securities/{identifier}/prices/technicals/ichimoku | Ichimoku Kinko Hyo
|
28
|
+
[**get_security_price_technicals_kc**](SecurityApi.md#get_security_price_technicals_kc) | **GET** /securities/{identifier}/prices/technicals/kc | Keltner Channel
|
29
|
+
[**get_security_price_technicals_kst**](SecurityApi.md#get_security_price_technicals_kst) | **GET** /securities/{identifier}/prices/technicals/kst | Know Sure Thing
|
30
|
+
[**get_security_price_technicals_macd**](SecurityApi.md#get_security_price_technicals_macd) | **GET** /securities/{identifier}/prices/technicals/macd | Moving Average Convergence Divergence
|
31
|
+
[**get_security_price_technicals_mfi**](SecurityApi.md#get_security_price_technicals_mfi) | **GET** /securities/{identifier}/prices/technicals/mfi | Money Flow Index
|
32
|
+
[**get_security_price_technicals_mi**](SecurityApi.md#get_security_price_technicals_mi) | **GET** /securities/{identifier}/prices/technicals/mi | Mass Index
|
33
|
+
[**get_security_price_technicals_nvi**](SecurityApi.md#get_security_price_technicals_nvi) | **GET** /securities/{identifier}/prices/technicals/nvi | Negative Volume Index
|
34
|
+
[**get_security_price_technicals_obv**](SecurityApi.md#get_security_price_technicals_obv) | **GET** /securities/{identifier}/prices/technicals/obv | On-balance Volume
|
35
|
+
[**get_security_price_technicals_obv_mean**](SecurityApi.md#get_security_price_technicals_obv_mean) | **GET** /securities/{identifier}/prices/technicals/obv_mean | On-balance Volume Mean
|
36
|
+
[**get_security_price_technicals_rsi**](SecurityApi.md#get_security_price_technicals_rsi) | **GET** /securities/{identifier}/prices/technicals/rsi | Relative Strength Index
|
37
|
+
[**get_security_price_technicals_sma**](SecurityApi.md#get_security_price_technicals_sma) | **GET** /securities/{identifier}/prices/technicals/sma | Simple Moving Average
|
38
|
+
[**get_security_price_technicals_sr**](SecurityApi.md#get_security_price_technicals_sr) | **GET** /securities/{identifier}/prices/technicals/sr | Stochastic Oscillator
|
39
|
+
[**get_security_price_technicals_trix**](SecurityApi.md#get_security_price_technicals_trix) | **GET** /securities/{identifier}/prices/technicals/trix | Triple Exponential Average
|
40
|
+
[**get_security_price_technicals_tsi**](SecurityApi.md#get_security_price_technicals_tsi) | **GET** /securities/{identifier}/prices/technicals/tsi | True Strength Index
|
41
|
+
[**get_security_price_technicals_uo**](SecurityApi.md#get_security_price_technicals_uo) | **GET** /securities/{identifier}/prices/technicals/uo | Ultimate Oscillator
|
42
|
+
[**get_security_price_technicals_vi**](SecurityApi.md#get_security_price_technicals_vi) | **GET** /securities/{identifier}/prices/technicals/vi | Vortex Indicator
|
43
|
+
[**get_security_price_technicals_vpt**](SecurityApi.md#get_security_price_technicals_vpt) | **GET** /securities/{identifier}/prices/technicals/vpt | Volume-price Trend
|
44
|
+
[**get_security_price_technicals_vwap**](SecurityApi.md#get_security_price_technicals_vwap) | **GET** /securities/{identifier}/prices/technicals/vwap | Volume Weighted Average Price
|
45
|
+
[**get_security_price_technicals_wr**](SecurityApi.md#get_security_price_technicals_wr) | **GET** /securities/{identifier}/prices/technicals/wr | Williams %R
|
15
46
|
[**get_security_realtime_price**](SecurityApi.md#get_security_realtime_price) | **GET** /securities/{identifier}/prices/realtime | Realtime Stock Price for Security
|
16
47
|
[**get_security_stock_price_adjustments**](SecurityApi.md#get_security_stock_price_adjustments) | **GET** /securities/{identifier}/prices/adjustments | Stock Price Adjustments by Security
|
17
48
|
[**get_security_stock_prices**](SecurityApi.md#get_security_stock_prices) | **GET** /securities/{identifier}/prices | Stock Prices by Security
|
@@ -24,6 +55,8 @@ Method | HTTP request | Description
|
|
24
55
|
|
25
56
|
All Securities
|
26
57
|
|
58
|
+
Returns all Securities to which you have access.
|
59
|
+
|
27
60
|
### Example
|
28
61
|
```ruby
|
29
62
|
# Load the gem
|
@@ -79,7 +112,7 @@ end
|
|
79
112
|
|
80
113
|
security_api = Intrinio::SecurityApi.new
|
81
114
|
|
82
|
-
identifier = "
|
115
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
83
116
|
|
84
117
|
|
85
118
|
begin
|
@@ -105,7 +138,7 @@ Name | Type | Description | Notes
|
|
105
138
|
|
106
139
|
Data Point (Number) for Security
|
107
140
|
|
108
|
-
|
141
|
+
$$v2_security_data_point_number_description$$
|
109
142
|
|
110
143
|
### Example
|
111
144
|
```ruby
|
@@ -119,9 +152,9 @@ end
|
|
119
152
|
|
120
153
|
security_api = Intrinio::SecurityApi.new
|
121
154
|
|
122
|
-
identifier = "
|
155
|
+
identifier = "$$v2_security_data_point_identifier_default$$" # String | $$v2_security_data_point_identifier_description$$
|
123
156
|
|
124
|
-
tag = "
|
157
|
+
tag = "$$v2_security_data_point_item_number_default$$" # String | $$v2_security_data_point_item_description$$
|
125
158
|
|
126
159
|
|
127
160
|
begin
|
@@ -136,8 +169,8 @@ end
|
|
136
169
|
|
137
170
|
Name | Type | Description | Notes
|
138
171
|
------------- | ------------- | ------------- | -------------
|
139
|
-
**identifier** | **String**|
|
140
|
-
**tag** | **String**|
|
172
|
+
**identifier** | **String**| $$v2_security_data_point_identifier_description$$ |
|
173
|
+
**tag** | **String**| $$v2_security_data_point_item_description$$ |
|
141
174
|
|
142
175
|
### Return type
|
143
176
|
|
@@ -148,7 +181,7 @@ Name | Type | Description | Notes
|
|
148
181
|
|
149
182
|
Data Point (Text) for Security
|
150
183
|
|
151
|
-
|
184
|
+
$$v2_security_data_point_text_description$$
|
152
185
|
|
153
186
|
### Example
|
154
187
|
```ruby
|
@@ -162,9 +195,9 @@ end
|
|
162
195
|
|
163
196
|
security_api = Intrinio::SecurityApi.new
|
164
197
|
|
165
|
-
identifier = "
|
198
|
+
identifier = "$$v2_security_data_point_identifier_default$$" # String | $$v2_security_data_point_identifier_description$$
|
166
199
|
|
167
|
-
tag = "
|
200
|
+
tag = "$$v2_security_data_point_item_text_default$$" # String | An Intrinio data tag ID or code-name
|
168
201
|
|
169
202
|
|
170
203
|
begin
|
@@ -179,7 +212,7 @@ end
|
|
179
212
|
|
180
213
|
Name | Type | Description | Notes
|
181
214
|
------------- | ------------- | ------------- | -------------
|
182
|
-
**identifier** | **String**|
|
215
|
+
**identifier** | **String**| $$v2_security_data_point_identifier_description$$ |
|
183
216
|
**tag** | **String**| An Intrinio data tag ID or code-name |
|
184
217
|
|
185
218
|
### Return type
|
@@ -191,7 +224,7 @@ Name | Type | Description | Notes
|
|
191
224
|
|
192
225
|
Historical Data for Security
|
193
226
|
|
194
|
-
|
227
|
+
$$v2_security_historical_data_description$$
|
195
228
|
|
196
229
|
### Example
|
197
230
|
```ruby
|
@@ -205,9 +238,9 @@ end
|
|
205
238
|
|
206
239
|
security_api = Intrinio::SecurityApi.new
|
207
240
|
|
208
|
-
identifier = "
|
241
|
+
identifier = "$$v2_security_historical_data_identifier_default$$" # String | $$v2_security_historical_data_identifier_description$$
|
209
242
|
|
210
|
-
tag = "
|
243
|
+
tag = "$$v2_security_historical_data_item_default$$" # String | $$v2_security_data_point_item_description$$
|
211
244
|
|
212
245
|
opts = {
|
213
246
|
frequency: "daily", # String | Return historical data in the given frequency
|
@@ -231,8 +264,8 @@ end
|
|
231
264
|
|
232
265
|
Name | Type | Description | Notes
|
233
266
|
------------- | ------------- | ------------- | -------------
|
234
|
-
**identifier** | **String**|
|
235
|
-
**tag** | **String**|
|
267
|
+
**identifier** | **String**| $$v2_security_historical_data_identifier_description$$ |
|
268
|
+
**tag** | **String**| $$v2_security_data_point_item_description$$ |
|
236
269
|
**frequency** | **String**| Return historical data in the given frequency | [optional] [default to daily]
|
237
270
|
**type** | **String**| Filter by type, when applicable | [optional]
|
238
271
|
**start_date** | **Date**| Get historical data on or after this date | [optional]
|
@@ -250,7 +283,7 @@ Name | Type | Description | Notes
|
|
250
283
|
|
251
284
|
Intraday Stock Prices for Security
|
252
285
|
|
253
|
-
|
286
|
+
$$v2_security_intraday_prices_description$$
|
254
287
|
|
255
288
|
### Example
|
256
289
|
```ruby
|
@@ -264,7 +297,7 @@ end
|
|
264
297
|
|
265
298
|
security_api = Intrinio::SecurityApi.new
|
266
299
|
|
267
|
-
identifier = "
|
300
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
268
301
|
|
269
302
|
opts = {
|
270
303
|
source: nil, # String | Return intraday prices from the specified data source
|
@@ -316,7 +349,7 @@ end
|
|
316
349
|
|
317
350
|
security_api = Intrinio::SecurityApi.new
|
318
351
|
|
319
|
-
identifier = "
|
352
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
320
353
|
|
321
354
|
|
322
355
|
begin
|
@@ -356,7 +389,7 @@ end
|
|
356
389
|
|
357
390
|
security_api = Intrinio::SecurityApi.new
|
358
391
|
|
359
|
-
identifier = "
|
392
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
360
393
|
|
361
394
|
|
362
395
|
begin
|
@@ -377,6 +410,1668 @@ Name | Type | Description | Notes
|
|
377
410
|
|
378
411
|
[**EarningsRecord**](EarningsRecord.md)
|
379
412
|
|
413
|
+
# **get_security_price_technicals_adi**
|
414
|
+
> ApiResponseSecurityAccumulationDistributionIndex get_security_price_technicals_adi(identifier, opts)
|
415
|
+
|
416
|
+
Accumulation/Distribution Index
|
417
|
+
|
418
|
+
Returns the Accumulation/Distribution Index values of Stock Prices for the Security with the given `identifier`
|
419
|
+
|
420
|
+
### Example
|
421
|
+
```ruby
|
422
|
+
# Load the gem
|
423
|
+
require 'intrinio-sdk'
|
424
|
+
|
425
|
+
# Setup authorization
|
426
|
+
Intrinio.configure do |config|
|
427
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
428
|
+
end
|
429
|
+
|
430
|
+
security_api = Intrinio::SecurityApi.new
|
431
|
+
|
432
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
433
|
+
|
434
|
+
opts = {
|
435
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
436
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
437
|
+
page_size: 100, # Integer | The number of results to return
|
438
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
439
|
+
}
|
440
|
+
|
441
|
+
begin
|
442
|
+
result = security_api.get_security_price_technicals_adi(identifier, opts)
|
443
|
+
p result
|
444
|
+
rescue Intrinio::ApiError => e
|
445
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_adi: #{e}"
|
446
|
+
end
|
447
|
+
```
|
448
|
+
|
449
|
+
### Parameters
|
450
|
+
|
451
|
+
Name | Type | Description | Notes
|
452
|
+
------------- | ------------- | ------------- | -------------
|
453
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
454
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
455
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
456
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
457
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
458
|
+
|
459
|
+
### Return type
|
460
|
+
|
461
|
+
[**ApiResponseSecurityAccumulationDistributionIndex**](ApiResponseSecurityAccumulationDistributionIndex.md)
|
462
|
+
|
463
|
+
# **get_security_price_technicals_adtv**
|
464
|
+
> ApiResponseSecurityAverageDailyTradingVolume get_security_price_technicals_adtv(identifier, opts)
|
465
|
+
|
466
|
+
Average Daily Trading Volume
|
467
|
+
|
468
|
+
Returns the Average Daily Trading Volume values of Stock Prices for the Security with the given `identifier`
|
469
|
+
|
470
|
+
### Example
|
471
|
+
```ruby
|
472
|
+
# Load the gem
|
473
|
+
require 'intrinio-sdk'
|
474
|
+
|
475
|
+
# Setup authorization
|
476
|
+
Intrinio.configure do |config|
|
477
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
478
|
+
end
|
479
|
+
|
480
|
+
security_api = Intrinio::SecurityApi.new
|
481
|
+
|
482
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
483
|
+
|
484
|
+
opts = {
|
485
|
+
period: 22, # Integer | The number of observations, per period, to calculate Average Daily Trading Volume
|
486
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
487
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
488
|
+
page_size: 100, # Integer | The number of results to return
|
489
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
490
|
+
}
|
491
|
+
|
492
|
+
begin
|
493
|
+
result = security_api.get_security_price_technicals_adtv(identifier, opts)
|
494
|
+
p result
|
495
|
+
rescue Intrinio::ApiError => e
|
496
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_adtv: #{e}"
|
497
|
+
end
|
498
|
+
```
|
499
|
+
|
500
|
+
### Parameters
|
501
|
+
|
502
|
+
Name | Type | Description | Notes
|
503
|
+
------------- | ------------- | ------------- | -------------
|
504
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
505
|
+
**period** | **Integer**| The number of observations, per period, to calculate Average Daily Trading Volume | [optional] [default to 22]
|
506
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
507
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
508
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
509
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
510
|
+
|
511
|
+
### Return type
|
512
|
+
|
513
|
+
[**ApiResponseSecurityAverageDailyTradingVolume**](ApiResponseSecurityAverageDailyTradingVolume.md)
|
514
|
+
|
515
|
+
# **get_security_price_technicals_adx**
|
516
|
+
> ApiResponseSecurityAverageDirectionalIndex get_security_price_technicals_adx(identifier, opts)
|
517
|
+
|
518
|
+
Average Directional Index
|
519
|
+
|
520
|
+
Returns the Average Directional Index values of Stock Prices for the Security with the given `identifier`
|
521
|
+
|
522
|
+
### Example
|
523
|
+
```ruby
|
524
|
+
# Load the gem
|
525
|
+
require 'intrinio-sdk'
|
526
|
+
|
527
|
+
# Setup authorization
|
528
|
+
Intrinio.configure do |config|
|
529
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
530
|
+
end
|
531
|
+
|
532
|
+
security_api = Intrinio::SecurityApi.new
|
533
|
+
|
534
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
535
|
+
|
536
|
+
opts = {
|
537
|
+
period: 14, # Integer | The number of observations, per period, to calculate Average Directional Index
|
538
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
539
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
540
|
+
page_size: 100, # Integer | The number of results to return
|
541
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
542
|
+
}
|
543
|
+
|
544
|
+
begin
|
545
|
+
result = security_api.get_security_price_technicals_adx(identifier, opts)
|
546
|
+
p result
|
547
|
+
rescue Intrinio::ApiError => e
|
548
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_adx: #{e}"
|
549
|
+
end
|
550
|
+
```
|
551
|
+
|
552
|
+
### Parameters
|
553
|
+
|
554
|
+
Name | Type | Description | Notes
|
555
|
+
------------- | ------------- | ------------- | -------------
|
556
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
557
|
+
**period** | **Integer**| The number of observations, per period, to calculate Average Directional Index | [optional] [default to 14]
|
558
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
559
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
560
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
561
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
562
|
+
|
563
|
+
### Return type
|
564
|
+
|
565
|
+
[**ApiResponseSecurityAverageDirectionalIndex**](ApiResponseSecurityAverageDirectionalIndex.md)
|
566
|
+
|
567
|
+
# **get_security_price_technicals_ao**
|
568
|
+
> ApiResponseSecurityAwesomeOscillator get_security_price_technicals_ao(identifier, opts)
|
569
|
+
|
570
|
+
Awesome Oscillator
|
571
|
+
|
572
|
+
Returns the Awesome Oscillator values of Stock Prices for the Security with the given `identifier`
|
573
|
+
|
574
|
+
### Example
|
575
|
+
```ruby
|
576
|
+
# Load the gem
|
577
|
+
require 'intrinio-sdk'
|
578
|
+
|
579
|
+
# Setup authorization
|
580
|
+
Intrinio.configure do |config|
|
581
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
582
|
+
end
|
583
|
+
|
584
|
+
security_api = Intrinio::SecurityApi.new
|
585
|
+
|
586
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
587
|
+
|
588
|
+
opts = {
|
589
|
+
short_period: 5, # Integer | The number of observations, per period, to calculate short period Simple Moving Average of the Awesome Oscillator
|
590
|
+
long_period: 34, # Integer | The number of observations, per period, to calculate long period Simple Moving Average of the Awesome Oscillator
|
591
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
592
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
593
|
+
page_size: 100, # Integer | The number of results to return
|
594
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
595
|
+
}
|
596
|
+
|
597
|
+
begin
|
598
|
+
result = security_api.get_security_price_technicals_ao(identifier, opts)
|
599
|
+
p result
|
600
|
+
rescue Intrinio::ApiError => e
|
601
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_ao: #{e}"
|
602
|
+
end
|
603
|
+
```
|
604
|
+
|
605
|
+
### Parameters
|
606
|
+
|
607
|
+
Name | Type | Description | Notes
|
608
|
+
------------- | ------------- | ------------- | -------------
|
609
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
610
|
+
**short_period** | **Integer**| The number of observations, per period, to calculate short period Simple Moving Average of the Awesome Oscillator | [optional] [default to 5]
|
611
|
+
**long_period** | **Integer**| The number of observations, per period, to calculate long period Simple Moving Average of the Awesome Oscillator | [optional] [default to 34]
|
612
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
613
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
614
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
615
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
616
|
+
|
617
|
+
### Return type
|
618
|
+
|
619
|
+
[**ApiResponseSecurityAwesomeOscillator**](ApiResponseSecurityAwesomeOscillator.md)
|
620
|
+
|
621
|
+
# **get_security_price_technicals_atr**
|
622
|
+
> ApiResponseSecurityAverageTrueRange get_security_price_technicals_atr(identifier, opts)
|
623
|
+
|
624
|
+
Average True Range
|
625
|
+
|
626
|
+
Returns the Average True Range values of Stock Prices for the Security with the given `identifier`
|
627
|
+
|
628
|
+
### Example
|
629
|
+
```ruby
|
630
|
+
# Load the gem
|
631
|
+
require 'intrinio-sdk'
|
632
|
+
|
633
|
+
# Setup authorization
|
634
|
+
Intrinio.configure do |config|
|
635
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
636
|
+
end
|
637
|
+
|
638
|
+
security_api = Intrinio::SecurityApi.new
|
639
|
+
|
640
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
641
|
+
|
642
|
+
opts = {
|
643
|
+
period: 14, # Integer | The number of observations, per period, to calculate Average True Range
|
644
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
645
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
646
|
+
page_size: 100, # Integer | The number of results to return
|
647
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
648
|
+
}
|
649
|
+
|
650
|
+
begin
|
651
|
+
result = security_api.get_security_price_technicals_atr(identifier, opts)
|
652
|
+
p result
|
653
|
+
rescue Intrinio::ApiError => e
|
654
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_atr: #{e}"
|
655
|
+
end
|
656
|
+
```
|
657
|
+
|
658
|
+
### Parameters
|
659
|
+
|
660
|
+
Name | Type | Description | Notes
|
661
|
+
------------- | ------------- | ------------- | -------------
|
662
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
663
|
+
**period** | **Integer**| The number of observations, per period, to calculate Average True Range | [optional] [default to 14]
|
664
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
665
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
666
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
667
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
668
|
+
|
669
|
+
### Return type
|
670
|
+
|
671
|
+
[**ApiResponseSecurityAverageTrueRange**](ApiResponseSecurityAverageTrueRange.md)
|
672
|
+
|
673
|
+
# **get_security_price_technicals_bb**
|
674
|
+
> ApiResponseSecurityBollingerBands get_security_price_technicals_bb(identifier, opts)
|
675
|
+
|
676
|
+
Bollinger Bands
|
677
|
+
|
678
|
+
Returns the Bollinger Bands values of Stock Prices for the Security with the given `identifier`
|
679
|
+
|
680
|
+
### Example
|
681
|
+
```ruby
|
682
|
+
# Load the gem
|
683
|
+
require 'intrinio-sdk'
|
684
|
+
|
685
|
+
# Setup authorization
|
686
|
+
Intrinio.configure do |config|
|
687
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
688
|
+
end
|
689
|
+
|
690
|
+
security_api = Intrinio::SecurityApi.new
|
691
|
+
|
692
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
693
|
+
|
694
|
+
opts = {
|
695
|
+
period: 20, # Integer | The number of observations, per period, to calculate Bollinger Bands
|
696
|
+
standard_deviations: 2.0, # Float | The number of standard deviations to calculate the upper and lower bands of the Bollinger Bands
|
697
|
+
price_key: "close", # String | The Stock Price field to use when calculating Bollinger Bands
|
698
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
699
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
700
|
+
page_size: 100, # Integer | The number of results to return
|
701
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
702
|
+
}
|
703
|
+
|
704
|
+
begin
|
705
|
+
result = security_api.get_security_price_technicals_bb(identifier, opts)
|
706
|
+
p result
|
707
|
+
rescue Intrinio::ApiError => e
|
708
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_bb: #{e}"
|
709
|
+
end
|
710
|
+
```
|
711
|
+
|
712
|
+
### Parameters
|
713
|
+
|
714
|
+
Name | Type | Description | Notes
|
715
|
+
------------- | ------------- | ------------- | -------------
|
716
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
717
|
+
**period** | **Integer**| The number of observations, per period, to calculate Bollinger Bands | [optional] [default to 20]
|
718
|
+
**standard_deviations** | **Float**| The number of standard deviations to calculate the upper and lower bands of the Bollinger Bands | [optional] [default to 2.0]
|
719
|
+
**price_key** | **String**| The Stock Price field to use when calculating Bollinger Bands | [optional] [default to close]
|
720
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
721
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
722
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
723
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
724
|
+
|
725
|
+
### Return type
|
726
|
+
|
727
|
+
[**ApiResponseSecurityBollingerBands**](ApiResponseSecurityBollingerBands.md)
|
728
|
+
|
729
|
+
# **get_security_price_technicals_cci**
|
730
|
+
> ApiResponseSecurityCommodityChannelIndex get_security_price_technicals_cci(identifier, opts)
|
731
|
+
|
732
|
+
Commodity Channel Index
|
733
|
+
|
734
|
+
Returns the Commodity Channel Index values of Stock Prices for the Security with the given `identifier`
|
735
|
+
|
736
|
+
### Example
|
737
|
+
```ruby
|
738
|
+
# Load the gem
|
739
|
+
require 'intrinio-sdk'
|
740
|
+
|
741
|
+
# Setup authorization
|
742
|
+
Intrinio.configure do |config|
|
743
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
744
|
+
end
|
745
|
+
|
746
|
+
security_api = Intrinio::SecurityApi.new
|
747
|
+
|
748
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
749
|
+
|
750
|
+
opts = {
|
751
|
+
period: 20, # Integer | The number of observations, per period, to calculate Commodity Channel Index
|
752
|
+
constant: 0.015, # Float | The number of observations, per period, to calculate Commodity Channel Index
|
753
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
754
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
755
|
+
page_size: 100, # Integer | The number of results to return
|
756
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
757
|
+
}
|
758
|
+
|
759
|
+
begin
|
760
|
+
result = security_api.get_security_price_technicals_cci(identifier, opts)
|
761
|
+
p result
|
762
|
+
rescue Intrinio::ApiError => e
|
763
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_cci: #{e}"
|
764
|
+
end
|
765
|
+
```
|
766
|
+
|
767
|
+
### Parameters
|
768
|
+
|
769
|
+
Name | Type | Description | Notes
|
770
|
+
------------- | ------------- | ------------- | -------------
|
771
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
772
|
+
**period** | **Integer**| The number of observations, per period, to calculate Commodity Channel Index | [optional] [default to 20]
|
773
|
+
**constant** | **Float**| The number of observations, per period, to calculate Commodity Channel Index | [optional] [default to 0.015]
|
774
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
775
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
776
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
777
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
778
|
+
|
779
|
+
### Return type
|
780
|
+
|
781
|
+
[**ApiResponseSecurityCommodityChannelIndex**](ApiResponseSecurityCommodityChannelIndex.md)
|
782
|
+
|
783
|
+
# **get_security_price_technicals_cmf**
|
784
|
+
> ApiResponseSecurityChaikinMoneyFlow get_security_price_technicals_cmf(identifier, opts)
|
785
|
+
|
786
|
+
Chaikin Money Flow
|
787
|
+
|
788
|
+
Returns the Chaikin Money Flow values of Stock Prices for the Security with the given `identifier`
|
789
|
+
|
790
|
+
### Example
|
791
|
+
```ruby
|
792
|
+
# Load the gem
|
793
|
+
require 'intrinio-sdk'
|
794
|
+
|
795
|
+
# Setup authorization
|
796
|
+
Intrinio.configure do |config|
|
797
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
798
|
+
end
|
799
|
+
|
800
|
+
security_api = Intrinio::SecurityApi.new
|
801
|
+
|
802
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
803
|
+
|
804
|
+
opts = {
|
805
|
+
period: 20, # Integer | The number of observations, per period, to calculate Chaikin Money Flow
|
806
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
807
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
808
|
+
page_size: 100, # Integer | The number of results to return
|
809
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
810
|
+
}
|
811
|
+
|
812
|
+
begin
|
813
|
+
result = security_api.get_security_price_technicals_cmf(identifier, opts)
|
814
|
+
p result
|
815
|
+
rescue Intrinio::ApiError => e
|
816
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_cmf: #{e}"
|
817
|
+
end
|
818
|
+
```
|
819
|
+
|
820
|
+
### Parameters
|
821
|
+
|
822
|
+
Name | Type | Description | Notes
|
823
|
+
------------- | ------------- | ------------- | -------------
|
824
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
825
|
+
**period** | **Integer**| The number of observations, per period, to calculate Chaikin Money Flow | [optional] [default to 20]
|
826
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
827
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
828
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
829
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
830
|
+
|
831
|
+
### Return type
|
832
|
+
|
833
|
+
[**ApiResponseSecurityChaikinMoneyFlow**](ApiResponseSecurityChaikinMoneyFlow.md)
|
834
|
+
|
835
|
+
# **get_security_price_technicals_dc**
|
836
|
+
> ApiResponseSecurityDonchianChannel get_security_price_technicals_dc(identifier, opts)
|
837
|
+
|
838
|
+
Donchian Channel
|
839
|
+
|
840
|
+
Returns the Donchian Channel values of Stock Prices for the Security with the given `identifier`
|
841
|
+
|
842
|
+
### Example
|
843
|
+
```ruby
|
844
|
+
# Load the gem
|
845
|
+
require 'intrinio-sdk'
|
846
|
+
|
847
|
+
# Setup authorization
|
848
|
+
Intrinio.configure do |config|
|
849
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
850
|
+
end
|
851
|
+
|
852
|
+
security_api = Intrinio::SecurityApi.new
|
853
|
+
|
854
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
855
|
+
|
856
|
+
opts = {
|
857
|
+
period: 20, # Integer | The number of observations, per period, to calculate Donchian Channel
|
858
|
+
price_key: "close", # String | The Stock Price field to use when calculating Donchian Channel
|
859
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
860
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
861
|
+
page_size: 100, # Integer | The number of results to return
|
862
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
863
|
+
}
|
864
|
+
|
865
|
+
begin
|
866
|
+
result = security_api.get_security_price_technicals_dc(identifier, opts)
|
867
|
+
p result
|
868
|
+
rescue Intrinio::ApiError => e
|
869
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_dc: #{e}"
|
870
|
+
end
|
871
|
+
```
|
872
|
+
|
873
|
+
### Parameters
|
874
|
+
|
875
|
+
Name | Type | Description | Notes
|
876
|
+
------------- | ------------- | ------------- | -------------
|
877
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
878
|
+
**period** | **Integer**| The number of observations, per period, to calculate Donchian Channel | [optional] [default to 20]
|
879
|
+
**price_key** | **String**| The Stock Price field to use when calculating Donchian Channel | [optional] [default to close]
|
880
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
881
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
882
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
883
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
884
|
+
|
885
|
+
### Return type
|
886
|
+
|
887
|
+
[**ApiResponseSecurityDonchianChannel**](ApiResponseSecurityDonchianChannel.md)
|
888
|
+
|
889
|
+
# **get_security_price_technicals_dpo**
|
890
|
+
> ApiResponseSecurityDetrendedPriceOscillator get_security_price_technicals_dpo(identifier, opts)
|
891
|
+
|
892
|
+
Detrended Price Oscillator
|
893
|
+
|
894
|
+
Returns the Detrended Price Oscillator values of Stock Prices for the Security with the given `identifier`
|
895
|
+
|
896
|
+
### Example
|
897
|
+
```ruby
|
898
|
+
# Load the gem
|
899
|
+
require 'intrinio-sdk'
|
900
|
+
|
901
|
+
# Setup authorization
|
902
|
+
Intrinio.configure do |config|
|
903
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
904
|
+
end
|
905
|
+
|
906
|
+
security_api = Intrinio::SecurityApi.new
|
907
|
+
|
908
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
909
|
+
|
910
|
+
opts = {
|
911
|
+
period: 20, # Integer | The number of observations, per period, to calculate Detrended Price Oscillator
|
912
|
+
price_key: "close", # String | The Stock Price field to use when calculating Detrended Price Oscillator
|
913
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
914
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
915
|
+
page_size: 100, # Integer | The number of results to return
|
916
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
917
|
+
}
|
918
|
+
|
919
|
+
begin
|
920
|
+
result = security_api.get_security_price_technicals_dpo(identifier, opts)
|
921
|
+
p result
|
922
|
+
rescue Intrinio::ApiError => e
|
923
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_dpo: #{e}"
|
924
|
+
end
|
925
|
+
```
|
926
|
+
|
927
|
+
### Parameters
|
928
|
+
|
929
|
+
Name | Type | Description | Notes
|
930
|
+
------------- | ------------- | ------------- | -------------
|
931
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
932
|
+
**period** | **Integer**| The number of observations, per period, to calculate Detrended Price Oscillator | [optional] [default to 20]
|
933
|
+
**price_key** | **String**| The Stock Price field to use when calculating Detrended Price Oscillator | [optional] [default to close]
|
934
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
935
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
936
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
937
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
938
|
+
|
939
|
+
### Return type
|
940
|
+
|
941
|
+
[**ApiResponseSecurityDetrendedPriceOscillator**](ApiResponseSecurityDetrendedPriceOscillator.md)
|
942
|
+
|
943
|
+
# **get_security_price_technicals_eom**
|
944
|
+
> ApiResponseSecurityEaseOfMovement get_security_price_technicals_eom(identifier, opts)
|
945
|
+
|
946
|
+
Ease of Movement
|
947
|
+
|
948
|
+
Returns the Ease of Movement values of Stock Prices for the Security with the given `identifier`
|
949
|
+
|
950
|
+
### Example
|
951
|
+
```ruby
|
952
|
+
# Load the gem
|
953
|
+
require 'intrinio-sdk'
|
954
|
+
|
955
|
+
# Setup authorization
|
956
|
+
Intrinio.configure do |config|
|
957
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
958
|
+
end
|
959
|
+
|
960
|
+
security_api = Intrinio::SecurityApi.new
|
961
|
+
|
962
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
963
|
+
|
964
|
+
opts = {
|
965
|
+
period: 20, # Integer | The number of observations, per period, to calculate Ease of Movement
|
966
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
967
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
968
|
+
page_size: 100, # Integer | The number of results to return
|
969
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
970
|
+
}
|
971
|
+
|
972
|
+
begin
|
973
|
+
result = security_api.get_security_price_technicals_eom(identifier, opts)
|
974
|
+
p result
|
975
|
+
rescue Intrinio::ApiError => e
|
976
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_eom: #{e}"
|
977
|
+
end
|
978
|
+
```
|
979
|
+
|
980
|
+
### Parameters
|
981
|
+
|
982
|
+
Name | Type | Description | Notes
|
983
|
+
------------- | ------------- | ------------- | -------------
|
984
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
985
|
+
**period** | **Integer**| The number of observations, per period, to calculate Ease of Movement | [optional] [default to 20]
|
986
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
987
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
988
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
989
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
990
|
+
|
991
|
+
### Return type
|
992
|
+
|
993
|
+
[**ApiResponseSecurityEaseOfMovement**](ApiResponseSecurityEaseOfMovement.md)
|
994
|
+
|
995
|
+
# **get_security_price_technicals_fi**
|
996
|
+
> ApiResponseSecurityForceIndex get_security_price_technicals_fi(identifier, opts)
|
997
|
+
|
998
|
+
Force Index
|
999
|
+
|
1000
|
+
Returns the Force Index values of Stock Prices for the Security with the given `identifier`
|
1001
|
+
|
1002
|
+
### Example
|
1003
|
+
```ruby
|
1004
|
+
# Load the gem
|
1005
|
+
require 'intrinio-sdk'
|
1006
|
+
|
1007
|
+
# Setup authorization
|
1008
|
+
Intrinio.configure do |config|
|
1009
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
1010
|
+
end
|
1011
|
+
|
1012
|
+
security_api = Intrinio::SecurityApi.new
|
1013
|
+
|
1014
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
1015
|
+
|
1016
|
+
opts = {
|
1017
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
1018
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
1019
|
+
page_size: 100, # Integer | The number of results to return
|
1020
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
1021
|
+
}
|
1022
|
+
|
1023
|
+
begin
|
1024
|
+
result = security_api.get_security_price_technicals_fi(identifier, opts)
|
1025
|
+
p result
|
1026
|
+
rescue Intrinio::ApiError => e
|
1027
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_fi: #{e}"
|
1028
|
+
end
|
1029
|
+
```
|
1030
|
+
|
1031
|
+
### Parameters
|
1032
|
+
|
1033
|
+
Name | Type | Description | Notes
|
1034
|
+
------------- | ------------- | ------------- | -------------
|
1035
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
1036
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
1037
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
1038
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
1039
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
1040
|
+
|
1041
|
+
### Return type
|
1042
|
+
|
1043
|
+
[**ApiResponseSecurityForceIndex**](ApiResponseSecurityForceIndex.md)
|
1044
|
+
|
1045
|
+
# **get_security_price_technicals_ichimoku**
|
1046
|
+
> ApiResponseSecurityIchimokuKinkoHyo get_security_price_technicals_ichimoku(identifier, opts)
|
1047
|
+
|
1048
|
+
Ichimoku Kinko Hyo
|
1049
|
+
|
1050
|
+
Returns the Ichimoku Kinko Hyo values of Stock Prices for the Security with the given `identifier`
|
1051
|
+
|
1052
|
+
### Example
|
1053
|
+
```ruby
|
1054
|
+
# Load the gem
|
1055
|
+
require 'intrinio-sdk'
|
1056
|
+
|
1057
|
+
# Setup authorization
|
1058
|
+
Intrinio.configure do |config|
|
1059
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
1060
|
+
end
|
1061
|
+
|
1062
|
+
security_api = Intrinio::SecurityApi.new
|
1063
|
+
|
1064
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
1065
|
+
|
1066
|
+
opts = {
|
1067
|
+
low_period: 9, # Integer | The number of observations, per period, to calculate Tenkan Sen (Conversion Line) of Ichimoku Kinko Hyo
|
1068
|
+
medium_period: 26, # Integer | The number of observations, per period, to calculate Kijun Sen (Base Line), Senkou Span A (Leading Span A), and Chikou Span (Lagging Span) of Ichimoku Kinko Hyo
|
1069
|
+
high_period: 52, # Integer | The number of observations, per period, to calculate Senkou Span B (Leading Span B) of Ichimoku Kinko Hyo
|
1070
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
1071
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
1072
|
+
page_size: 100, # Integer | The number of results to return
|
1073
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
1074
|
+
}
|
1075
|
+
|
1076
|
+
begin
|
1077
|
+
result = security_api.get_security_price_technicals_ichimoku(identifier, opts)
|
1078
|
+
p result
|
1079
|
+
rescue Intrinio::ApiError => e
|
1080
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_ichimoku: #{e}"
|
1081
|
+
end
|
1082
|
+
```
|
1083
|
+
|
1084
|
+
### Parameters
|
1085
|
+
|
1086
|
+
Name | Type | Description | Notes
|
1087
|
+
------------- | ------------- | ------------- | -------------
|
1088
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
1089
|
+
**low_period** | **Integer**| The number of observations, per period, to calculate Tenkan Sen (Conversion Line) of Ichimoku Kinko Hyo | [optional] [default to 9]
|
1090
|
+
**medium_period** | **Integer**| The number of observations, per period, to calculate Kijun Sen (Base Line), Senkou Span A (Leading Span A), and Chikou Span (Lagging Span) of Ichimoku Kinko Hyo | [optional] [default to 26]
|
1091
|
+
**high_period** | **Integer**| The number of observations, per period, to calculate Senkou Span B (Leading Span B) of Ichimoku Kinko Hyo | [optional] [default to 52]
|
1092
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
1093
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
1094
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
1095
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
1096
|
+
|
1097
|
+
### Return type
|
1098
|
+
|
1099
|
+
[**ApiResponseSecurityIchimokuKinkoHyo**](ApiResponseSecurityIchimokuKinkoHyo.md)
|
1100
|
+
|
1101
|
+
# **get_security_price_technicals_kc**
|
1102
|
+
> ApiResponseSecurityKeltnerChannel get_security_price_technicals_kc(identifier, opts)
|
1103
|
+
|
1104
|
+
Keltner Channel
|
1105
|
+
|
1106
|
+
Returns the Keltner Channel values of Stock Prices for the Security with the given `identifier`
|
1107
|
+
|
1108
|
+
### Example
|
1109
|
+
```ruby
|
1110
|
+
# Load the gem
|
1111
|
+
require 'intrinio-sdk'
|
1112
|
+
|
1113
|
+
# Setup authorization
|
1114
|
+
Intrinio.configure do |config|
|
1115
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
1116
|
+
end
|
1117
|
+
|
1118
|
+
security_api = Intrinio::SecurityApi.new
|
1119
|
+
|
1120
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
1121
|
+
|
1122
|
+
opts = {
|
1123
|
+
period: 10, # Integer | The number of observations, per period, to calculate Kelter Channel
|
1124
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
1125
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
1126
|
+
page_size: 100, # Integer | The number of results to return
|
1127
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
1128
|
+
}
|
1129
|
+
|
1130
|
+
begin
|
1131
|
+
result = security_api.get_security_price_technicals_kc(identifier, opts)
|
1132
|
+
p result
|
1133
|
+
rescue Intrinio::ApiError => e
|
1134
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_kc: #{e}"
|
1135
|
+
end
|
1136
|
+
```
|
1137
|
+
|
1138
|
+
### Parameters
|
1139
|
+
|
1140
|
+
Name | Type | Description | Notes
|
1141
|
+
------------- | ------------- | ------------- | -------------
|
1142
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
1143
|
+
**period** | **Integer**| The number of observations, per period, to calculate Kelter Channel | [optional] [default to 10]
|
1144
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
1145
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
1146
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
1147
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
1148
|
+
|
1149
|
+
### Return type
|
1150
|
+
|
1151
|
+
[**ApiResponseSecurityKeltnerChannel**](ApiResponseSecurityKeltnerChannel.md)
|
1152
|
+
|
1153
|
+
# **get_security_price_technicals_kst**
|
1154
|
+
> ApiResponseSecurityKnowSureThing get_security_price_technicals_kst(identifier, opts)
|
1155
|
+
|
1156
|
+
Know Sure Thing
|
1157
|
+
|
1158
|
+
Returns the Know Sure Thing values of Stock Prices for the Security with the given `identifier`
|
1159
|
+
|
1160
|
+
### Example
|
1161
|
+
```ruby
|
1162
|
+
# Load the gem
|
1163
|
+
require 'intrinio-sdk'
|
1164
|
+
|
1165
|
+
# Setup authorization
|
1166
|
+
Intrinio.configure do |config|
|
1167
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
1168
|
+
end
|
1169
|
+
|
1170
|
+
security_api = Intrinio::SecurityApi.new
|
1171
|
+
|
1172
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
1173
|
+
|
1174
|
+
opts = {
|
1175
|
+
roc1: 10, # Integer | The number of observations, per period, to calculate the rate-of-change for RCMA1
|
1176
|
+
roc2: 15, # Integer | The number of observations, per period, to calculate the rate-of-change for RCMA2
|
1177
|
+
roc3: 15, # Integer | The number of observations, per period, to calculate the rate-of-change for RCMA2
|
1178
|
+
roc4: 20, # Integer | The number of observations, per period, to calculate the rate-of-change for RCMA3
|
1179
|
+
roc5: 30, # Integer | The number of observations, per period, to calculate the rate-of-change for RCMA4
|
1180
|
+
sma1: 10, # Integer | The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA1
|
1181
|
+
sma2: 10, # Integer | The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA2
|
1182
|
+
sma3: 10, # Integer | The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA3
|
1183
|
+
sma4: 15, # Integer | The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA4
|
1184
|
+
price_key: "close", # String | The Stock Price field to use when calculating Know Sure Thing
|
1185
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
1186
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
1187
|
+
page_size: 100, # Integer | The number of results to return
|
1188
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
1189
|
+
}
|
1190
|
+
|
1191
|
+
begin
|
1192
|
+
result = security_api.get_security_price_technicals_kst(identifier, opts)
|
1193
|
+
p result
|
1194
|
+
rescue Intrinio::ApiError => e
|
1195
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_kst: #{e}"
|
1196
|
+
end
|
1197
|
+
```
|
1198
|
+
|
1199
|
+
### Parameters
|
1200
|
+
|
1201
|
+
Name | Type | Description | Notes
|
1202
|
+
------------- | ------------- | ------------- | -------------
|
1203
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
1204
|
+
**roc1** | **Integer**| The number of observations, per period, to calculate the rate-of-change for RCMA1 | [optional] [default to 10]
|
1205
|
+
**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 RCMA2 | [optional] [default to 15]
|
1207
|
+
**roc4** | **Integer**| The number of observations, per period, to calculate the rate-of-change for RCMA3 | [optional] [default to 20]
|
1208
|
+
**roc5** | **Integer**| The number of observations, per period, to calculate the rate-of-change for RCMA4 | [optional] [default to 30]
|
1209
|
+
**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
|
+
**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
|
+
**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]
|
1212
|
+
**sma4** | **Integer**| The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA4 | [optional] [default to 15]
|
1213
|
+
**price_key** | **String**| The Stock Price field to use when calculating Know Sure Thing | [optional] [default to close]
|
1214
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
1215
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
1216
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
1217
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
1218
|
+
|
1219
|
+
### Return type
|
1220
|
+
|
1221
|
+
[**ApiResponseSecurityKnowSureThing**](ApiResponseSecurityKnowSureThing.md)
|
1222
|
+
|
1223
|
+
# **get_security_price_technicals_macd**
|
1224
|
+
> ApiResponseSecurityMovingAverageConvergenceDivergence get_security_price_technicals_macd(identifier, opts)
|
1225
|
+
|
1226
|
+
Moving Average Convergence Divergence
|
1227
|
+
|
1228
|
+
Returns the Moving Average Convergence Divergence values of Stock Prices for the Security with the given `identifier`
|
1229
|
+
|
1230
|
+
### Example
|
1231
|
+
```ruby
|
1232
|
+
# Load the gem
|
1233
|
+
require 'intrinio-sdk'
|
1234
|
+
|
1235
|
+
# Setup authorization
|
1236
|
+
Intrinio.configure do |config|
|
1237
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
1238
|
+
end
|
1239
|
+
|
1240
|
+
security_api = Intrinio::SecurityApi.new
|
1241
|
+
|
1242
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
1243
|
+
|
1244
|
+
opts = {
|
1245
|
+
fast_period: 12, # Integer | The number of observations, per period, to calculate the fast moving Exponential Moving Average for Moving Average Convergence Divergence
|
1246
|
+
slow_period: 26, # Integer | The number of observations, per period, to calculate the slow moving Exponential Moving Average for Moving Average Convergence Divergence
|
1247
|
+
signal_period: 9, # Integer | The number of observations, per period, to calculate the signal line for Moving Average Convergence Divergence
|
1248
|
+
price_key: "close", # String | The Stock Price field to use when calculating Moving Average Convergence Divergence
|
1249
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
1250
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
1251
|
+
page_size: 100, # Integer | The number of results to return
|
1252
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
1253
|
+
}
|
1254
|
+
|
1255
|
+
begin
|
1256
|
+
result = security_api.get_security_price_technicals_macd(identifier, opts)
|
1257
|
+
p result
|
1258
|
+
rescue Intrinio::ApiError => e
|
1259
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_macd: #{e}"
|
1260
|
+
end
|
1261
|
+
```
|
1262
|
+
|
1263
|
+
### Parameters
|
1264
|
+
|
1265
|
+
Name | Type | Description | Notes
|
1266
|
+
------------- | ------------- | ------------- | -------------
|
1267
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
1268
|
+
**fast_period** | **Integer**| The number of observations, per period, to calculate the fast moving Exponential Moving Average for Moving Average Convergence Divergence | [optional] [default to 12]
|
1269
|
+
**slow_period** | **Integer**| The number of observations, per period, to calculate the slow moving Exponential Moving Average for Moving Average Convergence Divergence | [optional] [default to 26]
|
1270
|
+
**signal_period** | **Integer**| The number of observations, per period, to calculate the signal line for Moving Average Convergence Divergence | [optional] [default to 9]
|
1271
|
+
**price_key** | **String**| The Stock Price field to use when calculating Moving Average Convergence Divergence | [optional] [default to close]
|
1272
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
1273
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
1274
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
1275
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
1276
|
+
|
1277
|
+
### Return type
|
1278
|
+
|
1279
|
+
[**ApiResponseSecurityMovingAverageConvergenceDivergence**](ApiResponseSecurityMovingAverageConvergenceDivergence.md)
|
1280
|
+
|
1281
|
+
# **get_security_price_technicals_mfi**
|
1282
|
+
> ApiResponseSecurityMoneyFlowIndex get_security_price_technicals_mfi(identifier, opts)
|
1283
|
+
|
1284
|
+
Money Flow Index
|
1285
|
+
|
1286
|
+
Returns the Money Flow Index values of Stock Prices for the Security with the given `identifier`
|
1287
|
+
|
1288
|
+
### Example
|
1289
|
+
```ruby
|
1290
|
+
# Load the gem
|
1291
|
+
require 'intrinio-sdk'
|
1292
|
+
|
1293
|
+
# Setup authorization
|
1294
|
+
Intrinio.configure do |config|
|
1295
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
1296
|
+
end
|
1297
|
+
|
1298
|
+
security_api = Intrinio::SecurityApi.new
|
1299
|
+
|
1300
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
1301
|
+
|
1302
|
+
opts = {
|
1303
|
+
period: 14, # Integer | The number of observations, per period, to calculate Money Flow Index
|
1304
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
1305
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
1306
|
+
page_size: 100, # Integer | The number of results to return
|
1307
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
1308
|
+
}
|
1309
|
+
|
1310
|
+
begin
|
1311
|
+
result = security_api.get_security_price_technicals_mfi(identifier, opts)
|
1312
|
+
p result
|
1313
|
+
rescue Intrinio::ApiError => e
|
1314
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_mfi: #{e}"
|
1315
|
+
end
|
1316
|
+
```
|
1317
|
+
|
1318
|
+
### Parameters
|
1319
|
+
|
1320
|
+
Name | Type | Description | Notes
|
1321
|
+
------------- | ------------- | ------------- | -------------
|
1322
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
1323
|
+
**period** | **Integer**| The number of observations, per period, to calculate Money Flow Index | [optional] [default to 14]
|
1324
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
1325
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
1326
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
1327
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
1328
|
+
|
1329
|
+
### Return type
|
1330
|
+
|
1331
|
+
[**ApiResponseSecurityMoneyFlowIndex**](ApiResponseSecurityMoneyFlowIndex.md)
|
1332
|
+
|
1333
|
+
# **get_security_price_technicals_mi**
|
1334
|
+
> ApiResponseSecurityMassIndex get_security_price_technicals_mi(identifier, opts)
|
1335
|
+
|
1336
|
+
Mass Index
|
1337
|
+
|
1338
|
+
Returns the Mass Index values of Stock Prices for the Security with the given `identifier`
|
1339
|
+
|
1340
|
+
### Example
|
1341
|
+
```ruby
|
1342
|
+
# Load the gem
|
1343
|
+
require 'intrinio-sdk'
|
1344
|
+
|
1345
|
+
# Setup authorization
|
1346
|
+
Intrinio.configure do |config|
|
1347
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
1348
|
+
end
|
1349
|
+
|
1350
|
+
security_api = Intrinio::SecurityApi.new
|
1351
|
+
|
1352
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
1353
|
+
|
1354
|
+
opts = {
|
1355
|
+
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
|
1356
|
+
sum_period: 25, # Integer | The number of observations, per period, to calculate the sum of the Exponetinal Moving Average Ratios for Mass Index
|
1357
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
1358
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
1359
|
+
page_size: 100, # Integer | The number of results to return
|
1360
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
1361
|
+
}
|
1362
|
+
|
1363
|
+
begin
|
1364
|
+
result = security_api.get_security_price_technicals_mi(identifier, opts)
|
1365
|
+
p result
|
1366
|
+
rescue Intrinio::ApiError => e
|
1367
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_mi: #{e}"
|
1368
|
+
end
|
1369
|
+
```
|
1370
|
+
|
1371
|
+
### Parameters
|
1372
|
+
|
1373
|
+
Name | Type | Description | Notes
|
1374
|
+
------------- | ------------- | ------------- | -------------
|
1375
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
1376
|
+
**ema_period** | **Integer**| The number of observations, per period, to calculate the single Exponential Moving Average and the Double Exponential Moving Average for Mass Index | [optional] [default to 9]
|
1377
|
+
**sum_period** | **Integer**| The number of observations, per period, to calculate the sum of the Exponetinal Moving Average Ratios for Mass Index | [optional] [default to 25]
|
1378
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
1379
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
1380
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
1381
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
1382
|
+
|
1383
|
+
### Return type
|
1384
|
+
|
1385
|
+
[**ApiResponseSecurityMassIndex**](ApiResponseSecurityMassIndex.md)
|
1386
|
+
|
1387
|
+
# **get_security_price_technicals_nvi**
|
1388
|
+
> ApiResponseSecurityNegativeVolumeIndex get_security_price_technicals_nvi(identifier, opts)
|
1389
|
+
|
1390
|
+
Negative Volume Index
|
1391
|
+
|
1392
|
+
Returns the Negative Volume Index values of Stock Prices for the Security with the given `identifier`
|
1393
|
+
|
1394
|
+
### Example
|
1395
|
+
```ruby
|
1396
|
+
# Load the gem
|
1397
|
+
require 'intrinio-sdk'
|
1398
|
+
|
1399
|
+
# Setup authorization
|
1400
|
+
Intrinio.configure do |config|
|
1401
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
1402
|
+
end
|
1403
|
+
|
1404
|
+
security_api = Intrinio::SecurityApi.new
|
1405
|
+
|
1406
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
1407
|
+
|
1408
|
+
opts = {
|
1409
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
1410
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
1411
|
+
page_size: 100, # Integer | The number of results to return
|
1412
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
1413
|
+
}
|
1414
|
+
|
1415
|
+
begin
|
1416
|
+
result = security_api.get_security_price_technicals_nvi(identifier, opts)
|
1417
|
+
p result
|
1418
|
+
rescue Intrinio::ApiError => e
|
1419
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_nvi: #{e}"
|
1420
|
+
end
|
1421
|
+
```
|
1422
|
+
|
1423
|
+
### Parameters
|
1424
|
+
|
1425
|
+
Name | Type | Description | Notes
|
1426
|
+
------------- | ------------- | ------------- | -------------
|
1427
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
1428
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
1429
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
1430
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
1431
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
1432
|
+
|
1433
|
+
### Return type
|
1434
|
+
|
1435
|
+
[**ApiResponseSecurityNegativeVolumeIndex**](ApiResponseSecurityNegativeVolumeIndex.md)
|
1436
|
+
|
1437
|
+
# **get_security_price_technicals_obv**
|
1438
|
+
> ApiResponseSecurityOnBalanceVolume get_security_price_technicals_obv(identifier, opts)
|
1439
|
+
|
1440
|
+
On-balance Volume
|
1441
|
+
|
1442
|
+
Returns the On-balance Volume values of Stock Prices for the Security with the given `identifier`
|
1443
|
+
|
1444
|
+
### Example
|
1445
|
+
```ruby
|
1446
|
+
# Load the gem
|
1447
|
+
require 'intrinio-sdk'
|
1448
|
+
|
1449
|
+
# Setup authorization
|
1450
|
+
Intrinio.configure do |config|
|
1451
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
1452
|
+
end
|
1453
|
+
|
1454
|
+
security_api = Intrinio::SecurityApi.new
|
1455
|
+
|
1456
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
1457
|
+
|
1458
|
+
opts = {
|
1459
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
1460
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
1461
|
+
page_size: 100, # Integer | The number of results to return
|
1462
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
1463
|
+
}
|
1464
|
+
|
1465
|
+
begin
|
1466
|
+
result = security_api.get_security_price_technicals_obv(identifier, opts)
|
1467
|
+
p result
|
1468
|
+
rescue Intrinio::ApiError => e
|
1469
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_obv: #{e}"
|
1470
|
+
end
|
1471
|
+
```
|
1472
|
+
|
1473
|
+
### Parameters
|
1474
|
+
|
1475
|
+
Name | Type | Description | Notes
|
1476
|
+
------------- | ------------- | ------------- | -------------
|
1477
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
1478
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
1479
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
1480
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
1481
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
1482
|
+
|
1483
|
+
### Return type
|
1484
|
+
|
1485
|
+
[**ApiResponseSecurityOnBalanceVolume**](ApiResponseSecurityOnBalanceVolume.md)
|
1486
|
+
|
1487
|
+
# **get_security_price_technicals_obv_mean**
|
1488
|
+
> ApiResponseSecurityOnBalanceVolumeMean get_security_price_technicals_obv_mean(identifier, opts)
|
1489
|
+
|
1490
|
+
On-balance Volume Mean
|
1491
|
+
|
1492
|
+
Returns the On-balance Volume Mean values of Stock Prices for the Security with the given `identifier`
|
1493
|
+
|
1494
|
+
### Example
|
1495
|
+
```ruby
|
1496
|
+
# Load the gem
|
1497
|
+
require 'intrinio-sdk'
|
1498
|
+
|
1499
|
+
# Setup authorization
|
1500
|
+
Intrinio.configure do |config|
|
1501
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
1502
|
+
end
|
1503
|
+
|
1504
|
+
security_api = Intrinio::SecurityApi.new
|
1505
|
+
|
1506
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
1507
|
+
|
1508
|
+
opts = {
|
1509
|
+
period: 10, # Integer | The number of observations, per period, to calculate On-balance Volume Mean
|
1510
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
1511
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
1512
|
+
page_size: 100, # Integer | The number of results to return
|
1513
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
1514
|
+
}
|
1515
|
+
|
1516
|
+
begin
|
1517
|
+
result = security_api.get_security_price_technicals_obv_mean(identifier, opts)
|
1518
|
+
p result
|
1519
|
+
rescue Intrinio::ApiError => e
|
1520
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_obv_mean: #{e}"
|
1521
|
+
end
|
1522
|
+
```
|
1523
|
+
|
1524
|
+
### Parameters
|
1525
|
+
|
1526
|
+
Name | Type | Description | Notes
|
1527
|
+
------------- | ------------- | ------------- | -------------
|
1528
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
1529
|
+
**period** | **Integer**| The number of observations, per period, to calculate On-balance Volume Mean | [optional] [default to 10]
|
1530
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
1531
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
1532
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
1533
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
1534
|
+
|
1535
|
+
### Return type
|
1536
|
+
|
1537
|
+
[**ApiResponseSecurityOnBalanceVolumeMean**](ApiResponseSecurityOnBalanceVolumeMean.md)
|
1538
|
+
|
1539
|
+
# **get_security_price_technicals_rsi**
|
1540
|
+
> ApiResponseSecurityRelativeStrengthIndex get_security_price_technicals_rsi(identifier, opts)
|
1541
|
+
|
1542
|
+
Relative Strength Index
|
1543
|
+
|
1544
|
+
Returns the Relative Strength Index values of Stock Prices for the Security with the given `identifier`
|
1545
|
+
|
1546
|
+
### Example
|
1547
|
+
```ruby
|
1548
|
+
# Load the gem
|
1549
|
+
require 'intrinio-sdk'
|
1550
|
+
|
1551
|
+
# Setup authorization
|
1552
|
+
Intrinio.configure do |config|
|
1553
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
1554
|
+
end
|
1555
|
+
|
1556
|
+
security_api = Intrinio::SecurityApi.new
|
1557
|
+
|
1558
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
1559
|
+
|
1560
|
+
opts = {
|
1561
|
+
period: 14, # Integer | The number of observations, per period, to calculate Relative Strength Index
|
1562
|
+
price_key: "close", # String | The Stock Price field to use when calculating Relative Strength Index
|
1563
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
1564
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
1565
|
+
page_size: 100, # Integer | The number of results to return
|
1566
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
1567
|
+
}
|
1568
|
+
|
1569
|
+
begin
|
1570
|
+
result = security_api.get_security_price_technicals_rsi(identifier, opts)
|
1571
|
+
p result
|
1572
|
+
rescue Intrinio::ApiError => e
|
1573
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_rsi: #{e}"
|
1574
|
+
end
|
1575
|
+
```
|
1576
|
+
|
1577
|
+
### Parameters
|
1578
|
+
|
1579
|
+
Name | Type | Description | Notes
|
1580
|
+
------------- | ------------- | ------------- | -------------
|
1581
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
1582
|
+
**period** | **Integer**| The number of observations, per period, to calculate Relative Strength Index | [optional] [default to 14]
|
1583
|
+
**price_key** | **String**| The Stock Price field to use when calculating Relative Strength Index | [optional] [default to close]
|
1584
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
1585
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
1586
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
1587
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
1588
|
+
|
1589
|
+
### Return type
|
1590
|
+
|
1591
|
+
[**ApiResponseSecurityRelativeStrengthIndex**](ApiResponseSecurityRelativeStrengthIndex.md)
|
1592
|
+
|
1593
|
+
# **get_security_price_technicals_sma**
|
1594
|
+
> ApiResponseSecuritySimpleMovingAverage get_security_price_technicals_sma(identifier, opts)
|
1595
|
+
|
1596
|
+
Simple Moving Average
|
1597
|
+
|
1598
|
+
Returns the Simple Moving Average values of Stock Prices for the Security with the given `identifier`
|
1599
|
+
|
1600
|
+
### Example
|
1601
|
+
```ruby
|
1602
|
+
# Load the gem
|
1603
|
+
require 'intrinio-sdk'
|
1604
|
+
|
1605
|
+
# Setup authorization
|
1606
|
+
Intrinio.configure do |config|
|
1607
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
1608
|
+
end
|
1609
|
+
|
1610
|
+
security_api = Intrinio::SecurityApi.new
|
1611
|
+
|
1612
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
1613
|
+
|
1614
|
+
opts = {
|
1615
|
+
period: 20, # Integer | The number of observations, per period, to calculate Simple Moving Average
|
1616
|
+
price_key: "close", # String | The Stock Price field to use when calculating Simple Moving Average
|
1617
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
1618
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
1619
|
+
page_size: 100, # Integer | The number of results to return
|
1620
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
1621
|
+
}
|
1622
|
+
|
1623
|
+
begin
|
1624
|
+
result = security_api.get_security_price_technicals_sma(identifier, opts)
|
1625
|
+
p result
|
1626
|
+
rescue Intrinio::ApiError => e
|
1627
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_sma: #{e}"
|
1628
|
+
end
|
1629
|
+
```
|
1630
|
+
|
1631
|
+
### Parameters
|
1632
|
+
|
1633
|
+
Name | Type | Description | Notes
|
1634
|
+
------------- | ------------- | ------------- | -------------
|
1635
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
1636
|
+
**period** | **Integer**| The number of observations, per period, to calculate Simple Moving Average | [optional] [default to 20]
|
1637
|
+
**price_key** | **String**| The Stock Price field to use when calculating Simple Moving Average | [optional] [default to close]
|
1638
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
1639
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
1640
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
1641
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
1642
|
+
|
1643
|
+
### Return type
|
1644
|
+
|
1645
|
+
[**ApiResponseSecuritySimpleMovingAverage**](ApiResponseSecuritySimpleMovingAverage.md)
|
1646
|
+
|
1647
|
+
# **get_security_price_technicals_sr**
|
1648
|
+
> ApiResponseSecurityStochasticOscillator get_security_price_technicals_sr(identifier, opts)
|
1649
|
+
|
1650
|
+
Stochastic Oscillator
|
1651
|
+
|
1652
|
+
Returns the Stochastic Oscillator values of Stock Prices for the Security with the given `identifier`
|
1653
|
+
|
1654
|
+
### Example
|
1655
|
+
```ruby
|
1656
|
+
# Load the gem
|
1657
|
+
require 'intrinio-sdk'
|
1658
|
+
|
1659
|
+
# Setup authorization
|
1660
|
+
Intrinio.configure do |config|
|
1661
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
1662
|
+
end
|
1663
|
+
|
1664
|
+
security_api = Intrinio::SecurityApi.new
|
1665
|
+
|
1666
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
1667
|
+
|
1668
|
+
opts = {
|
1669
|
+
period: 14, # Integer | The number of observations, per period, to calculate %K of Stochastic Oscillator
|
1670
|
+
signal_period: 3, # Integer | The number of observations, per period, to calculate the %D (the Simple Moving Average of %K) as a signal line for Stochastic Oscillator
|
1671
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
1672
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
1673
|
+
page_size: 100, # Integer | The number of results to return
|
1674
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
1675
|
+
}
|
1676
|
+
|
1677
|
+
begin
|
1678
|
+
result = security_api.get_security_price_technicals_sr(identifier, opts)
|
1679
|
+
p result
|
1680
|
+
rescue Intrinio::ApiError => e
|
1681
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_sr: #{e}"
|
1682
|
+
end
|
1683
|
+
```
|
1684
|
+
|
1685
|
+
### Parameters
|
1686
|
+
|
1687
|
+
Name | Type | Description | Notes
|
1688
|
+
------------- | ------------- | ------------- | -------------
|
1689
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
1690
|
+
**period** | **Integer**| The number of observations, per period, to calculate %K of Stochastic Oscillator | [optional] [default to 14]
|
1691
|
+
**signal_period** | **Integer**| The number of observations, per period, to calculate the %D (the Simple Moving Average of %K) as a signal line for Stochastic Oscillator | [optional] [default to 3]
|
1692
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
1693
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
1694
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
1695
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
1696
|
+
|
1697
|
+
### Return type
|
1698
|
+
|
1699
|
+
[**ApiResponseSecurityStochasticOscillator**](ApiResponseSecurityStochasticOscillator.md)
|
1700
|
+
|
1701
|
+
# **get_security_price_technicals_trix**
|
1702
|
+
> ApiResponseSecurityTripleExponentialAverage get_security_price_technicals_trix(identifier, opts)
|
1703
|
+
|
1704
|
+
Triple Exponential Average
|
1705
|
+
|
1706
|
+
Returns the Simple Moving Average values of Stock Prices for the Security with the given `identifier`
|
1707
|
+
|
1708
|
+
### Example
|
1709
|
+
```ruby
|
1710
|
+
# Load the gem
|
1711
|
+
require 'intrinio-sdk'
|
1712
|
+
|
1713
|
+
# Setup authorization
|
1714
|
+
Intrinio.configure do |config|
|
1715
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
1716
|
+
end
|
1717
|
+
|
1718
|
+
security_api = Intrinio::SecurityApi.new
|
1719
|
+
|
1720
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
1721
|
+
|
1722
|
+
opts = {
|
1723
|
+
period: 15, # Integer | The number of observations, per period, to calculate Exponential Moving Average for Triple Exponential Average
|
1724
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
1725
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
1726
|
+
page_size: 100, # Integer | The number of results to return
|
1727
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
1728
|
+
}
|
1729
|
+
|
1730
|
+
begin
|
1731
|
+
result = security_api.get_security_price_technicals_trix(identifier, opts)
|
1732
|
+
p result
|
1733
|
+
rescue Intrinio::ApiError => e
|
1734
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_trix: #{e}"
|
1735
|
+
end
|
1736
|
+
```
|
1737
|
+
|
1738
|
+
### Parameters
|
1739
|
+
|
1740
|
+
Name | Type | Description | Notes
|
1741
|
+
------------- | ------------- | ------------- | -------------
|
1742
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
1743
|
+
**period** | **Integer**| The number of observations, per period, to calculate Exponential Moving Average for Triple Exponential Average | [optional] [default to 15]
|
1744
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
1745
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
1746
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
1747
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
1748
|
+
|
1749
|
+
### Return type
|
1750
|
+
|
1751
|
+
[**ApiResponseSecurityTripleExponentialAverage**](ApiResponseSecurityTripleExponentialAverage.md)
|
1752
|
+
|
1753
|
+
# **get_security_price_technicals_tsi**
|
1754
|
+
> ApiResponseSecurityTrueStrengthIndex get_security_price_technicals_tsi(identifier, opts)
|
1755
|
+
|
1756
|
+
True Strength Index
|
1757
|
+
|
1758
|
+
Returns the True Strength Index values of Stock Prices for the Security with the given `identifier`
|
1759
|
+
|
1760
|
+
### Example
|
1761
|
+
```ruby
|
1762
|
+
# Load the gem
|
1763
|
+
require 'intrinio-sdk'
|
1764
|
+
|
1765
|
+
# Setup authorization
|
1766
|
+
Intrinio.configure do |config|
|
1767
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
1768
|
+
end
|
1769
|
+
|
1770
|
+
security_api = Intrinio::SecurityApi.new
|
1771
|
+
|
1772
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
1773
|
+
|
1774
|
+
opts = {
|
1775
|
+
low_period: 13, # Integer | The number of observations, per period, to calculate low period Exponential Moving Average for smoothing in True Strength Index
|
1776
|
+
high_period: 25, # Integer | The number of observations, per period, to calculate high period Exponential Moving Average for smoothing in True Strength Index
|
1777
|
+
price_key: "close", # String | The Stock Price field to use when calculating True Strength Index
|
1778
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
1779
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
1780
|
+
page_size: 100, # Integer | The number of results to return
|
1781
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
1782
|
+
}
|
1783
|
+
|
1784
|
+
begin
|
1785
|
+
result = security_api.get_security_price_technicals_tsi(identifier, opts)
|
1786
|
+
p result
|
1787
|
+
rescue Intrinio::ApiError => e
|
1788
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_tsi: #{e}"
|
1789
|
+
end
|
1790
|
+
```
|
1791
|
+
|
1792
|
+
### Parameters
|
1793
|
+
|
1794
|
+
Name | Type | Description | Notes
|
1795
|
+
------------- | ------------- | ------------- | -------------
|
1796
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
1797
|
+
**low_period** | **Integer**| The number of observations, per period, to calculate low period Exponential Moving Average for smoothing in True Strength Index | [optional] [default to 13]
|
1798
|
+
**high_period** | **Integer**| The number of observations, per period, to calculate high period Exponential Moving Average for smoothing in True Strength Index | [optional] [default to 25]
|
1799
|
+
**price_key** | **String**| The Stock Price field to use when calculating True Strength Index | [optional] [default to close]
|
1800
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
1801
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
1802
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
1803
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
1804
|
+
|
1805
|
+
### Return type
|
1806
|
+
|
1807
|
+
[**ApiResponseSecurityTrueStrengthIndex**](ApiResponseSecurityTrueStrengthIndex.md)
|
1808
|
+
|
1809
|
+
# **get_security_price_technicals_uo**
|
1810
|
+
> ApiResponseSecurityUltimateOscillator get_security_price_technicals_uo(identifier, opts)
|
1811
|
+
|
1812
|
+
Ultimate Oscillator
|
1813
|
+
|
1814
|
+
Returns the Ultimate Oscillator values of Stock Prices for the Security with the given `identifier`
|
1815
|
+
|
1816
|
+
### Example
|
1817
|
+
```ruby
|
1818
|
+
# Load the gem
|
1819
|
+
require 'intrinio-sdk'
|
1820
|
+
|
1821
|
+
# Setup authorization
|
1822
|
+
Intrinio.configure do |config|
|
1823
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
1824
|
+
end
|
1825
|
+
|
1826
|
+
security_api = Intrinio::SecurityApi.new
|
1827
|
+
|
1828
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
1829
|
+
|
1830
|
+
opts = {
|
1831
|
+
short_period: 7, # Integer | The number of observations, per period, to calculate the short period for Ultimate Oscillator
|
1832
|
+
medium_period: 14, # Integer | The number of observations, per period, to calculate the medium period for Ultimate Oscillator
|
1833
|
+
long_period: 28, # Integer | The number of observations, per period, to calculate the long period for Ultimate Oscillator
|
1834
|
+
short_weight: 4.0, # Float | The weight of short Buying Pressure average for Ultimate Oscillator
|
1835
|
+
medium_weight: 2.0, # Float | The weight of medium Buying Pressure average for Ultimate Oscillator
|
1836
|
+
long_weight: 1.0, # Float | The weight of long Buying Pressure average for Ultimate Oscillator
|
1837
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
1838
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
1839
|
+
page_size: 100, # Integer | The number of results to return
|
1840
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
1841
|
+
}
|
1842
|
+
|
1843
|
+
begin
|
1844
|
+
result = security_api.get_security_price_technicals_uo(identifier, opts)
|
1845
|
+
p result
|
1846
|
+
rescue Intrinio::ApiError => e
|
1847
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_uo: #{e}"
|
1848
|
+
end
|
1849
|
+
```
|
1850
|
+
|
1851
|
+
### Parameters
|
1852
|
+
|
1853
|
+
Name | Type | Description | Notes
|
1854
|
+
------------- | ------------- | ------------- | -------------
|
1855
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
1856
|
+
**short_period** | **Integer**| The number of observations, per period, to calculate the short period for Ultimate Oscillator | [optional] [default to 7]
|
1857
|
+
**medium_period** | **Integer**| The number of observations, per period, to calculate the medium period for Ultimate Oscillator | [optional] [default to 14]
|
1858
|
+
**long_period** | **Integer**| The number of observations, per period, to calculate the long period for Ultimate Oscillator | [optional] [default to 28]
|
1859
|
+
**short_weight** | **Float**| The weight of short Buying Pressure average for Ultimate Oscillator | [optional] [default to 4.0]
|
1860
|
+
**medium_weight** | **Float**| The weight of medium Buying Pressure average for Ultimate Oscillator | [optional] [default to 2.0]
|
1861
|
+
**long_weight** | **Float**| The weight of long Buying Pressure average for Ultimate Oscillator | [optional] [default to 1.0]
|
1862
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
1863
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
1864
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
1865
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
1866
|
+
|
1867
|
+
### Return type
|
1868
|
+
|
1869
|
+
[**ApiResponseSecurityUltimateOscillator**](ApiResponseSecurityUltimateOscillator.md)
|
1870
|
+
|
1871
|
+
# **get_security_price_technicals_vi**
|
1872
|
+
> ApiResponseSecurityVortexIndicator get_security_price_technicals_vi(identifier, opts)
|
1873
|
+
|
1874
|
+
Vortex Indicator
|
1875
|
+
|
1876
|
+
Returns the Vortex Indicator values of Stock Prices for the Security with the given `identifier`
|
1877
|
+
|
1878
|
+
### Example
|
1879
|
+
```ruby
|
1880
|
+
# Load the gem
|
1881
|
+
require 'intrinio-sdk'
|
1882
|
+
|
1883
|
+
# Setup authorization
|
1884
|
+
Intrinio.configure do |config|
|
1885
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
1886
|
+
end
|
1887
|
+
|
1888
|
+
security_api = Intrinio::SecurityApi.new
|
1889
|
+
|
1890
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
1891
|
+
|
1892
|
+
opts = {
|
1893
|
+
period: 14, # Integer | The number of observations, per period, to calculate Vortex Indicator
|
1894
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
1895
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
1896
|
+
page_size: 100, # Integer | The number of results to return
|
1897
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
1898
|
+
}
|
1899
|
+
|
1900
|
+
begin
|
1901
|
+
result = security_api.get_security_price_technicals_vi(identifier, opts)
|
1902
|
+
p result
|
1903
|
+
rescue Intrinio::ApiError => e
|
1904
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_vi: #{e}"
|
1905
|
+
end
|
1906
|
+
```
|
1907
|
+
|
1908
|
+
### Parameters
|
1909
|
+
|
1910
|
+
Name | Type | Description | Notes
|
1911
|
+
------------- | ------------- | ------------- | -------------
|
1912
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
1913
|
+
**period** | **Integer**| The number of observations, per period, to calculate Vortex Indicator | [optional] [default to 14]
|
1914
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
1915
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
1916
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
1917
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
1918
|
+
|
1919
|
+
### Return type
|
1920
|
+
|
1921
|
+
[**ApiResponseSecurityVortexIndicator**](ApiResponseSecurityVortexIndicator.md)
|
1922
|
+
|
1923
|
+
# **get_security_price_technicals_vpt**
|
1924
|
+
> ApiResponseSecurityVolumePriceTrend get_security_price_technicals_vpt(identifier, opts)
|
1925
|
+
|
1926
|
+
Volume-price Trend
|
1927
|
+
|
1928
|
+
Returns the Volume-price Trend values of Stock Prices for the Security with the given `identifier`
|
1929
|
+
|
1930
|
+
### Example
|
1931
|
+
```ruby
|
1932
|
+
# Load the gem
|
1933
|
+
require 'intrinio-sdk'
|
1934
|
+
|
1935
|
+
# Setup authorization
|
1936
|
+
Intrinio.configure do |config|
|
1937
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
1938
|
+
end
|
1939
|
+
|
1940
|
+
security_api = Intrinio::SecurityApi.new
|
1941
|
+
|
1942
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
1943
|
+
|
1944
|
+
opts = {
|
1945
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
1946
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
1947
|
+
page_size: 100, # Integer | The number of results to return
|
1948
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
1949
|
+
}
|
1950
|
+
|
1951
|
+
begin
|
1952
|
+
result = security_api.get_security_price_technicals_vpt(identifier, opts)
|
1953
|
+
p result
|
1954
|
+
rescue Intrinio::ApiError => e
|
1955
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_vpt: #{e}"
|
1956
|
+
end
|
1957
|
+
```
|
1958
|
+
|
1959
|
+
### Parameters
|
1960
|
+
|
1961
|
+
Name | Type | Description | Notes
|
1962
|
+
------------- | ------------- | ------------- | -------------
|
1963
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
1964
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
1965
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
1966
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
1967
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
1968
|
+
|
1969
|
+
### Return type
|
1970
|
+
|
1971
|
+
[**ApiResponseSecurityVolumePriceTrend**](ApiResponseSecurityVolumePriceTrend.md)
|
1972
|
+
|
1973
|
+
# **get_security_price_technicals_vwap**
|
1974
|
+
> ApiResponseSecurityVolumeWeightedAveragePrice get_security_price_technicals_vwap(identifier, opts)
|
1975
|
+
|
1976
|
+
Volume Weighted Average Price
|
1977
|
+
|
1978
|
+
Returns the Volume Weighted Average Price values of Stock Prices for the Security with the given `identifier`
|
1979
|
+
|
1980
|
+
### Example
|
1981
|
+
```ruby
|
1982
|
+
# Load the gem
|
1983
|
+
require 'intrinio-sdk'
|
1984
|
+
|
1985
|
+
# Setup authorization
|
1986
|
+
Intrinio.configure do |config|
|
1987
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
1988
|
+
end
|
1989
|
+
|
1990
|
+
security_api = Intrinio::SecurityApi.new
|
1991
|
+
|
1992
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
1993
|
+
|
1994
|
+
opts = {
|
1995
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
1996
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
1997
|
+
page_size: 100, # Integer | The number of results to return
|
1998
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
1999
|
+
}
|
2000
|
+
|
2001
|
+
begin
|
2002
|
+
result = security_api.get_security_price_technicals_vwap(identifier, opts)
|
2003
|
+
p result
|
2004
|
+
rescue Intrinio::ApiError => e
|
2005
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_vwap: #{e}"
|
2006
|
+
end
|
2007
|
+
```
|
2008
|
+
|
2009
|
+
### Parameters
|
2010
|
+
|
2011
|
+
Name | Type | Description | Notes
|
2012
|
+
------------- | ------------- | ------------- | -------------
|
2013
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
2014
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
2015
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
2016
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
2017
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
2018
|
+
|
2019
|
+
### Return type
|
2020
|
+
|
2021
|
+
[**ApiResponseSecurityVolumeWeightedAveragePrice**](ApiResponseSecurityVolumeWeightedAveragePrice.md)
|
2022
|
+
|
2023
|
+
# **get_security_price_technicals_wr**
|
2024
|
+
> ApiResponseSecurityWilliamsR get_security_price_technicals_wr(identifier, opts)
|
2025
|
+
|
2026
|
+
Williams %R
|
2027
|
+
|
2028
|
+
Returns the Williams %R values of Stock Prices for the Security with the given `identifier`
|
2029
|
+
|
2030
|
+
### Example
|
2031
|
+
```ruby
|
2032
|
+
# Load the gem
|
2033
|
+
require 'intrinio-sdk'
|
2034
|
+
|
2035
|
+
# Setup authorization
|
2036
|
+
Intrinio.configure do |config|
|
2037
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
2038
|
+
end
|
2039
|
+
|
2040
|
+
security_api = Intrinio::SecurityApi.new
|
2041
|
+
|
2042
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
2043
|
+
|
2044
|
+
opts = {
|
2045
|
+
period: 14, # Integer | The number of observations, per period, to look-back when calculating Williams %R
|
2046
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
2047
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
2048
|
+
page_size: 100, # Float | The number of results to return
|
2049
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
2050
|
+
}
|
2051
|
+
|
2052
|
+
begin
|
2053
|
+
result = security_api.get_security_price_technicals_wr(identifier, opts)
|
2054
|
+
p result
|
2055
|
+
rescue Intrinio::ApiError => e
|
2056
|
+
puts "Exception when calling SecurityApi->get_security_price_technicals_wr: #{e}"
|
2057
|
+
end
|
2058
|
+
```
|
2059
|
+
|
2060
|
+
### Parameters
|
2061
|
+
|
2062
|
+
Name | Type | Description | Notes
|
2063
|
+
------------- | ------------- | ------------- | -------------
|
2064
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
2065
|
+
**period** | **Integer**| The number of observations, per period, to look-back when calculating Williams %R | [optional] [default to 14]
|
2066
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
2067
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
2068
|
+
**page_size** | **Float**| The number of results to return | [optional] [default to 100]
|
2069
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
2070
|
+
|
2071
|
+
### Return type
|
2072
|
+
|
2073
|
+
[**ApiResponseSecurityWilliamsR**](ApiResponseSecurityWilliamsR.md)
|
2074
|
+
|
380
2075
|
# **get_security_realtime_price**
|
381
2076
|
> RealtimeStockPrice get_security_realtime_price(identifier, opts)
|
382
2077
|
|
@@ -396,7 +2091,7 @@ end
|
|
396
2091
|
|
397
2092
|
security_api = Intrinio::SecurityApi.new
|
398
2093
|
|
399
|
-
identifier = "
|
2094
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
400
2095
|
|
401
2096
|
opts = {
|
402
2097
|
source: nil # String | Return the realtime price from the specified data source
|
@@ -440,7 +2135,7 @@ end
|
|
440
2135
|
|
441
2136
|
security_api = Intrinio::SecurityApi.new
|
442
2137
|
|
443
|
-
identifier = "
|
2138
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
444
2139
|
|
445
2140
|
opts = {
|
446
2141
|
start_date: Date.parse("2018-01-01"), # Date | Return price adjustments on or after the date
|
@@ -490,7 +2185,7 @@ end
|
|
490
2185
|
|
491
2186
|
security_api = Intrinio::SecurityApi.new
|
492
2187
|
|
493
|
-
identifier = "
|
2188
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
494
2189
|
|
495
2190
|
opts = {
|
496
2191
|
start_date: Date.parse("2018-01-01"), # Date | Return prices on or after the date
|