intrinio-sdk 2.1.0 → 2.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +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
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# Intrinio::SimpleMovingAverageTechnicalValue
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**date_time** | **DateTime** | The date_time of the observation | [optional]
|
|
7
|
+
**sma** | **Float** | The Simple Moving Average calculation value | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Intrinio::StochasticOscillatorTechnicalValue
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**date_time** | **DateTime** | The date_time of the observation | [optional]
|
|
7
|
+
**sr** | **Float** | The Stochastic Oscillator calculation value | [optional]
|
|
8
|
+
**sr_signal** | **Float** | The Stochastic Oscillator signal line value | [optional]
|
|
9
|
+
|
|
10
|
+
|
data/docs/StockExchangeApi.md
CHANGED
|
@@ -17,7 +17,7 @@ Method | HTTP request | Description
|
|
|
17
17
|
|
|
18
18
|
All Stock Exchanges
|
|
19
19
|
|
|
20
|
-
Returns all Stock Exchanges
|
|
20
|
+
Returns all Stock Exchanges matching the specified parameters
|
|
21
21
|
|
|
22
22
|
### Example
|
|
23
23
|
```ruby
|
|
@@ -78,7 +78,7 @@ end
|
|
|
78
78
|
|
|
79
79
|
stockExchange_api = Intrinio::StockExchangeApi.new
|
|
80
80
|
|
|
81
|
-
identifier = "
|
|
81
|
+
identifier = "$$v2_mic_default$$" # String | A Stock Exchange identifier (MIC or Intrinio ID)
|
|
82
82
|
|
|
83
83
|
|
|
84
84
|
begin
|
|
@@ -118,7 +118,7 @@ end
|
|
|
118
118
|
|
|
119
119
|
stockExchange_api = Intrinio::StockExchangeApi.new
|
|
120
120
|
|
|
121
|
-
identifier = "
|
|
121
|
+
identifier = "$$v2_mic_default$$" # String | A Stock Exchange identifier (MIC or Intrinio ID)
|
|
122
122
|
|
|
123
123
|
opts = {
|
|
124
124
|
date: Date.parse("2018-08-14"), # Date | The date for which to return price adjustments
|
|
@@ -166,7 +166,7 @@ end
|
|
|
166
166
|
|
|
167
167
|
stockExchange_api = Intrinio::StockExchangeApi.new
|
|
168
168
|
|
|
169
|
-
identifier = "
|
|
169
|
+
identifier = "$$v2_mic_default$$" # String | A Stock Exchange identifier (MIC or Intrinio ID)
|
|
170
170
|
|
|
171
171
|
opts = {
|
|
172
172
|
date: Date.parse("2018-08-14"), # Date | The date for which to return prices
|
|
@@ -214,7 +214,7 @@ end
|
|
|
214
214
|
|
|
215
215
|
stockExchange_api = Intrinio::StockExchangeApi.new
|
|
216
216
|
|
|
217
|
-
identifier = "
|
|
217
|
+
identifier = "$$v2_mic_default$$" # String | A Stock Exchange identifier (MIC or Intrinio ID)
|
|
218
218
|
|
|
219
219
|
opts = {
|
|
220
220
|
source: nil, # String | Return realtime prices from the specified data source
|
|
@@ -262,7 +262,7 @@ end
|
|
|
262
262
|
|
|
263
263
|
stockExchange_api = Intrinio::StockExchangeApi.new
|
|
264
264
|
|
|
265
|
-
identifier = "
|
|
265
|
+
identifier = "$$v2_mic_default$$" # String | A Stock Exchange identifier (MIC or Intrinio ID)
|
|
266
266
|
|
|
267
267
|
opts = {
|
|
268
268
|
page_size: 100, # Float | The number of results to return
|
|
@@ -0,0 +1,1701 @@
|
|
|
1
|
+
# Intrinio::TechnicalApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api-v2.intrinio.com*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**get_security_price_technicals_adi**](TechnicalApi.md#get_security_price_technicals_adi) | **GET** /securities/{identifier}/prices/technicals/adi | Accumulation/Distribution Index
|
|
8
|
+
[**get_security_price_technicals_adtv**](TechnicalApi.md#get_security_price_technicals_adtv) | **GET** /securities/{identifier}/prices/technicals/adtv | Average Daily Trading Volume
|
|
9
|
+
[**get_security_price_technicals_adx**](TechnicalApi.md#get_security_price_technicals_adx) | **GET** /securities/{identifier}/prices/technicals/adx | Average Directional Index
|
|
10
|
+
[**get_security_price_technicals_ao**](TechnicalApi.md#get_security_price_technicals_ao) | **GET** /securities/{identifier}/prices/technicals/ao | Awesome Oscillator
|
|
11
|
+
[**get_security_price_technicals_atr**](TechnicalApi.md#get_security_price_technicals_atr) | **GET** /securities/{identifier}/prices/technicals/atr | Average True Range
|
|
12
|
+
[**get_security_price_technicals_bb**](TechnicalApi.md#get_security_price_technicals_bb) | **GET** /securities/{identifier}/prices/technicals/bb | Bollinger Bands
|
|
13
|
+
[**get_security_price_technicals_cci**](TechnicalApi.md#get_security_price_technicals_cci) | **GET** /securities/{identifier}/prices/technicals/cci | Commodity Channel Index
|
|
14
|
+
[**get_security_price_technicals_cmf**](TechnicalApi.md#get_security_price_technicals_cmf) | **GET** /securities/{identifier}/prices/technicals/cmf | Chaikin Money Flow
|
|
15
|
+
[**get_security_price_technicals_dc**](TechnicalApi.md#get_security_price_technicals_dc) | **GET** /securities/{identifier}/prices/technicals/dc | Donchian Channel
|
|
16
|
+
[**get_security_price_technicals_dpo**](TechnicalApi.md#get_security_price_technicals_dpo) | **GET** /securities/{identifier}/prices/technicals/dpo | Detrended Price Oscillator
|
|
17
|
+
[**get_security_price_technicals_eom**](TechnicalApi.md#get_security_price_technicals_eom) | **GET** /securities/{identifier}/prices/technicals/eom | Ease of Movement
|
|
18
|
+
[**get_security_price_technicals_fi**](TechnicalApi.md#get_security_price_technicals_fi) | **GET** /securities/{identifier}/prices/technicals/fi | Force Index
|
|
19
|
+
[**get_security_price_technicals_ichimoku**](TechnicalApi.md#get_security_price_technicals_ichimoku) | **GET** /securities/{identifier}/prices/technicals/ichimoku | Ichimoku Kinko Hyo
|
|
20
|
+
[**get_security_price_technicals_kc**](TechnicalApi.md#get_security_price_technicals_kc) | **GET** /securities/{identifier}/prices/technicals/kc | Keltner Channel
|
|
21
|
+
[**get_security_price_technicals_kst**](TechnicalApi.md#get_security_price_technicals_kst) | **GET** /securities/{identifier}/prices/technicals/kst | Know Sure Thing
|
|
22
|
+
[**get_security_price_technicals_macd**](TechnicalApi.md#get_security_price_technicals_macd) | **GET** /securities/{identifier}/prices/technicals/macd | Moving Average Convergence Divergence
|
|
23
|
+
[**get_security_price_technicals_mfi**](TechnicalApi.md#get_security_price_technicals_mfi) | **GET** /securities/{identifier}/prices/technicals/mfi | Money Flow Index
|
|
24
|
+
[**get_security_price_technicals_mi**](TechnicalApi.md#get_security_price_technicals_mi) | **GET** /securities/{identifier}/prices/technicals/mi | Mass Index
|
|
25
|
+
[**get_security_price_technicals_nvi**](TechnicalApi.md#get_security_price_technicals_nvi) | **GET** /securities/{identifier}/prices/technicals/nvi | Negative Volume Index
|
|
26
|
+
[**get_security_price_technicals_obv**](TechnicalApi.md#get_security_price_technicals_obv) | **GET** /securities/{identifier}/prices/technicals/obv | On-balance Volume
|
|
27
|
+
[**get_security_price_technicals_obv_mean**](TechnicalApi.md#get_security_price_technicals_obv_mean) | **GET** /securities/{identifier}/prices/technicals/obv_mean | On-balance Volume Mean
|
|
28
|
+
[**get_security_price_technicals_rsi**](TechnicalApi.md#get_security_price_technicals_rsi) | **GET** /securities/{identifier}/prices/technicals/rsi | Relative Strength Index
|
|
29
|
+
[**get_security_price_technicals_sma**](TechnicalApi.md#get_security_price_technicals_sma) | **GET** /securities/{identifier}/prices/technicals/sma | Simple Moving Average
|
|
30
|
+
[**get_security_price_technicals_sr**](TechnicalApi.md#get_security_price_technicals_sr) | **GET** /securities/{identifier}/prices/technicals/sr | Stochastic Oscillator
|
|
31
|
+
[**get_security_price_technicals_trix**](TechnicalApi.md#get_security_price_technicals_trix) | **GET** /securities/{identifier}/prices/technicals/trix | Triple Exponential Average
|
|
32
|
+
[**get_security_price_technicals_tsi**](TechnicalApi.md#get_security_price_technicals_tsi) | **GET** /securities/{identifier}/prices/technicals/tsi | True Strength Index
|
|
33
|
+
[**get_security_price_technicals_uo**](TechnicalApi.md#get_security_price_technicals_uo) | **GET** /securities/{identifier}/prices/technicals/uo | Ultimate Oscillator
|
|
34
|
+
[**get_security_price_technicals_vi**](TechnicalApi.md#get_security_price_technicals_vi) | **GET** /securities/{identifier}/prices/technicals/vi | Vortex Indicator
|
|
35
|
+
[**get_security_price_technicals_vpt**](TechnicalApi.md#get_security_price_technicals_vpt) | **GET** /securities/{identifier}/prices/technicals/vpt | Volume-price Trend
|
|
36
|
+
[**get_security_price_technicals_vwap**](TechnicalApi.md#get_security_price_technicals_vwap) | **GET** /securities/{identifier}/prices/technicals/vwap | Volume Weighted Average Price
|
|
37
|
+
[**get_security_price_technicals_wr**](TechnicalApi.md#get_security_price_technicals_wr) | **GET** /securities/{identifier}/prices/technicals/wr | Williams %R
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
# **get_security_price_technicals_adi**
|
|
41
|
+
> ApiResponseSecurityAccumulationDistributionIndex get_security_price_technicals_adi(identifier, opts)
|
|
42
|
+
|
|
43
|
+
Accumulation/Distribution Index
|
|
44
|
+
|
|
45
|
+
Returns the Accumulation/Distribution Index values of Stock Prices for the Security with the given `identifier`
|
|
46
|
+
|
|
47
|
+
### Example
|
|
48
|
+
```ruby
|
|
49
|
+
# Load the gem
|
|
50
|
+
require 'intrinio-sdk'
|
|
51
|
+
|
|
52
|
+
# Setup authorization
|
|
53
|
+
Intrinio.configure do |config|
|
|
54
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
58
|
+
|
|
59
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
60
|
+
|
|
61
|
+
opts = {
|
|
62
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
63
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
|
64
|
+
page_size: 100, # Integer | The number of results to return
|
|
65
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
begin
|
|
69
|
+
result = technical_api.get_security_price_technicals_adi(identifier, opts)
|
|
70
|
+
p result
|
|
71
|
+
rescue Intrinio::ApiError => e
|
|
72
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_adi: #{e}"
|
|
73
|
+
end
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
### Parameters
|
|
77
|
+
|
|
78
|
+
Name | Type | Description | Notes
|
|
79
|
+
------------- | ------------- | ------------- | -------------
|
|
80
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
81
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
82
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
83
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
84
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
85
|
+
|
|
86
|
+
### Return type
|
|
87
|
+
|
|
88
|
+
[**ApiResponseSecurityAccumulationDistributionIndex**](ApiResponseSecurityAccumulationDistributionIndex.md)
|
|
89
|
+
|
|
90
|
+
# **get_security_price_technicals_adtv**
|
|
91
|
+
> ApiResponseSecurityAverageDailyTradingVolume get_security_price_technicals_adtv(identifier, opts)
|
|
92
|
+
|
|
93
|
+
Average Daily Trading Volume
|
|
94
|
+
|
|
95
|
+
Returns the Average Daily Trading Volume values of Stock Prices for the Security with the given `identifier`
|
|
96
|
+
|
|
97
|
+
### Example
|
|
98
|
+
```ruby
|
|
99
|
+
# Load the gem
|
|
100
|
+
require 'intrinio-sdk'
|
|
101
|
+
|
|
102
|
+
# Setup authorization
|
|
103
|
+
Intrinio.configure do |config|
|
|
104
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
105
|
+
end
|
|
106
|
+
|
|
107
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
108
|
+
|
|
109
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
110
|
+
|
|
111
|
+
opts = {
|
|
112
|
+
period: 22, # Integer | The number of observations, per period, to calculate Average Daily Trading Volume
|
|
113
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
114
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
|
115
|
+
page_size: 100, # Integer | The number of results to return
|
|
116
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
117
|
+
}
|
|
118
|
+
|
|
119
|
+
begin
|
|
120
|
+
result = technical_api.get_security_price_technicals_adtv(identifier, opts)
|
|
121
|
+
p result
|
|
122
|
+
rescue Intrinio::ApiError => e
|
|
123
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_adtv: #{e}"
|
|
124
|
+
end
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
### Parameters
|
|
128
|
+
|
|
129
|
+
Name | Type | Description | Notes
|
|
130
|
+
------------- | ------------- | ------------- | -------------
|
|
131
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
132
|
+
**period** | **Integer**| The number of observations, per period, to calculate Average Daily Trading Volume | [optional] [default to 22]
|
|
133
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
134
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
135
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
136
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
137
|
+
|
|
138
|
+
### Return type
|
|
139
|
+
|
|
140
|
+
[**ApiResponseSecurityAverageDailyTradingVolume**](ApiResponseSecurityAverageDailyTradingVolume.md)
|
|
141
|
+
|
|
142
|
+
# **get_security_price_technicals_adx**
|
|
143
|
+
> ApiResponseSecurityAverageDirectionalIndex get_security_price_technicals_adx(identifier, opts)
|
|
144
|
+
|
|
145
|
+
Average Directional Index
|
|
146
|
+
|
|
147
|
+
Returns the Average Directional Index values of Stock Prices for the Security with the given `identifier`
|
|
148
|
+
|
|
149
|
+
### Example
|
|
150
|
+
```ruby
|
|
151
|
+
# Load the gem
|
|
152
|
+
require 'intrinio-sdk'
|
|
153
|
+
|
|
154
|
+
# Setup authorization
|
|
155
|
+
Intrinio.configure do |config|
|
|
156
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
157
|
+
end
|
|
158
|
+
|
|
159
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
160
|
+
|
|
161
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
162
|
+
|
|
163
|
+
opts = {
|
|
164
|
+
period: 14, # Integer | The number of observations, per period, to calculate Average Directional Index
|
|
165
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
166
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
|
167
|
+
page_size: 100, # Integer | The number of results to return
|
|
168
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
169
|
+
}
|
|
170
|
+
|
|
171
|
+
begin
|
|
172
|
+
result = technical_api.get_security_price_technicals_adx(identifier, opts)
|
|
173
|
+
p result
|
|
174
|
+
rescue Intrinio::ApiError => e
|
|
175
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_adx: #{e}"
|
|
176
|
+
end
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
### Parameters
|
|
180
|
+
|
|
181
|
+
Name | Type | Description | Notes
|
|
182
|
+
------------- | ------------- | ------------- | -------------
|
|
183
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
184
|
+
**period** | **Integer**| The number of observations, per period, to calculate Average Directional Index | [optional] [default to 14]
|
|
185
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
186
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
187
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
188
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
189
|
+
|
|
190
|
+
### Return type
|
|
191
|
+
|
|
192
|
+
[**ApiResponseSecurityAverageDirectionalIndex**](ApiResponseSecurityAverageDirectionalIndex.md)
|
|
193
|
+
|
|
194
|
+
# **get_security_price_technicals_ao**
|
|
195
|
+
> ApiResponseSecurityAwesomeOscillator get_security_price_technicals_ao(identifier, opts)
|
|
196
|
+
|
|
197
|
+
Awesome Oscillator
|
|
198
|
+
|
|
199
|
+
Returns the Awesome Oscillator values of Stock Prices for the Security with the given `identifier`
|
|
200
|
+
|
|
201
|
+
### Example
|
|
202
|
+
```ruby
|
|
203
|
+
# Load the gem
|
|
204
|
+
require 'intrinio-sdk'
|
|
205
|
+
|
|
206
|
+
# Setup authorization
|
|
207
|
+
Intrinio.configure do |config|
|
|
208
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
209
|
+
end
|
|
210
|
+
|
|
211
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
212
|
+
|
|
213
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
214
|
+
|
|
215
|
+
opts = {
|
|
216
|
+
short_period: 5, # Integer | The number of observations, per period, to calculate short period Simple Moving Average of the Awesome Oscillator
|
|
217
|
+
long_period: 34, # Integer | The number of observations, per period, to calculate long period Simple Moving Average of the Awesome Oscillator
|
|
218
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
219
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
|
220
|
+
page_size: 100, # Integer | The number of results to return
|
|
221
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
begin
|
|
225
|
+
result = technical_api.get_security_price_technicals_ao(identifier, opts)
|
|
226
|
+
p result
|
|
227
|
+
rescue Intrinio::ApiError => e
|
|
228
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_ao: #{e}"
|
|
229
|
+
end
|
|
230
|
+
```
|
|
231
|
+
|
|
232
|
+
### Parameters
|
|
233
|
+
|
|
234
|
+
Name | Type | Description | Notes
|
|
235
|
+
------------- | ------------- | ------------- | -------------
|
|
236
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
237
|
+
**short_period** | **Integer**| The number of observations, per period, to calculate short period Simple Moving Average of the Awesome Oscillator | [optional] [default to 5]
|
|
238
|
+
**long_period** | **Integer**| The number of observations, per period, to calculate long period Simple Moving Average of the Awesome Oscillator | [optional] [default to 34]
|
|
239
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
240
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
241
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
242
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
243
|
+
|
|
244
|
+
### Return type
|
|
245
|
+
|
|
246
|
+
[**ApiResponseSecurityAwesomeOscillator**](ApiResponseSecurityAwesomeOscillator.md)
|
|
247
|
+
|
|
248
|
+
# **get_security_price_technicals_atr**
|
|
249
|
+
> ApiResponseSecurityAverageTrueRange get_security_price_technicals_atr(identifier, opts)
|
|
250
|
+
|
|
251
|
+
Average True Range
|
|
252
|
+
|
|
253
|
+
Returns the Average True Range values of Stock Prices for the Security with the given `identifier`
|
|
254
|
+
|
|
255
|
+
### Example
|
|
256
|
+
```ruby
|
|
257
|
+
# Load the gem
|
|
258
|
+
require 'intrinio-sdk'
|
|
259
|
+
|
|
260
|
+
# Setup authorization
|
|
261
|
+
Intrinio.configure do |config|
|
|
262
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
263
|
+
end
|
|
264
|
+
|
|
265
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
266
|
+
|
|
267
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
268
|
+
|
|
269
|
+
opts = {
|
|
270
|
+
period: 14, # Integer | The number of observations, per period, to calculate Average True Range
|
|
271
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
272
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
|
273
|
+
page_size: 100, # Integer | The number of results to return
|
|
274
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
275
|
+
}
|
|
276
|
+
|
|
277
|
+
begin
|
|
278
|
+
result = technical_api.get_security_price_technicals_atr(identifier, opts)
|
|
279
|
+
p result
|
|
280
|
+
rescue Intrinio::ApiError => e
|
|
281
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_atr: #{e}"
|
|
282
|
+
end
|
|
283
|
+
```
|
|
284
|
+
|
|
285
|
+
### Parameters
|
|
286
|
+
|
|
287
|
+
Name | Type | Description | Notes
|
|
288
|
+
------------- | ------------- | ------------- | -------------
|
|
289
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
290
|
+
**period** | **Integer**| The number of observations, per period, to calculate Average True Range | [optional] [default to 14]
|
|
291
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
292
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
293
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
294
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
295
|
+
|
|
296
|
+
### Return type
|
|
297
|
+
|
|
298
|
+
[**ApiResponseSecurityAverageTrueRange**](ApiResponseSecurityAverageTrueRange.md)
|
|
299
|
+
|
|
300
|
+
# **get_security_price_technicals_bb**
|
|
301
|
+
> ApiResponseSecurityBollingerBands get_security_price_technicals_bb(identifier, opts)
|
|
302
|
+
|
|
303
|
+
Bollinger Bands
|
|
304
|
+
|
|
305
|
+
Returns the Bollinger Bands values of Stock Prices for the Security with the given `identifier`
|
|
306
|
+
|
|
307
|
+
### Example
|
|
308
|
+
```ruby
|
|
309
|
+
# Load the gem
|
|
310
|
+
require 'intrinio-sdk'
|
|
311
|
+
|
|
312
|
+
# Setup authorization
|
|
313
|
+
Intrinio.configure do |config|
|
|
314
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
315
|
+
end
|
|
316
|
+
|
|
317
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
318
|
+
|
|
319
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
320
|
+
|
|
321
|
+
opts = {
|
|
322
|
+
period: 20, # Integer | The number of observations, per period, to calculate Bollinger Bands
|
|
323
|
+
standard_deviations: 2.0, # Float | The number of standard deviations to calculate the upper and lower bands of the Bollinger Bands
|
|
324
|
+
price_key: "close", # String | The Stock Price field to use when calculating Bollinger Bands
|
|
325
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
326
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
|
327
|
+
page_size: 100, # Integer | The number of results to return
|
|
328
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
329
|
+
}
|
|
330
|
+
|
|
331
|
+
begin
|
|
332
|
+
result = technical_api.get_security_price_technicals_bb(identifier, opts)
|
|
333
|
+
p result
|
|
334
|
+
rescue Intrinio::ApiError => e
|
|
335
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_bb: #{e}"
|
|
336
|
+
end
|
|
337
|
+
```
|
|
338
|
+
|
|
339
|
+
### Parameters
|
|
340
|
+
|
|
341
|
+
Name | Type | Description | Notes
|
|
342
|
+
------------- | ------------- | ------------- | -------------
|
|
343
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
344
|
+
**period** | **Integer**| The number of observations, per period, to calculate Bollinger Bands | [optional] [default to 20]
|
|
345
|
+
**standard_deviations** | **Float**| The number of standard deviations to calculate the upper and lower bands of the Bollinger Bands | [optional] [default to 2.0]
|
|
346
|
+
**price_key** | **String**| The Stock Price field to use when calculating Bollinger Bands | [optional] [default to close]
|
|
347
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
348
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
349
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
350
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
351
|
+
|
|
352
|
+
### Return type
|
|
353
|
+
|
|
354
|
+
[**ApiResponseSecurityBollingerBands**](ApiResponseSecurityBollingerBands.md)
|
|
355
|
+
|
|
356
|
+
# **get_security_price_technicals_cci**
|
|
357
|
+
> ApiResponseSecurityCommodityChannelIndex get_security_price_technicals_cci(identifier, opts)
|
|
358
|
+
|
|
359
|
+
Commodity Channel Index
|
|
360
|
+
|
|
361
|
+
Returns the Commodity Channel Index values of Stock Prices for the Security with the given `identifier`
|
|
362
|
+
|
|
363
|
+
### Example
|
|
364
|
+
```ruby
|
|
365
|
+
# Load the gem
|
|
366
|
+
require 'intrinio-sdk'
|
|
367
|
+
|
|
368
|
+
# Setup authorization
|
|
369
|
+
Intrinio.configure do |config|
|
|
370
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
371
|
+
end
|
|
372
|
+
|
|
373
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
374
|
+
|
|
375
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
376
|
+
|
|
377
|
+
opts = {
|
|
378
|
+
period: 20, # Integer | The number of observations, per period, to calculate Commodity Channel Index
|
|
379
|
+
constant: 0.015, # Float | The number of observations, per period, to calculate Commodity Channel Index
|
|
380
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
381
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
|
382
|
+
page_size: 100, # Integer | The number of results to return
|
|
383
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
384
|
+
}
|
|
385
|
+
|
|
386
|
+
begin
|
|
387
|
+
result = technical_api.get_security_price_technicals_cci(identifier, opts)
|
|
388
|
+
p result
|
|
389
|
+
rescue Intrinio::ApiError => e
|
|
390
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_cci: #{e}"
|
|
391
|
+
end
|
|
392
|
+
```
|
|
393
|
+
|
|
394
|
+
### Parameters
|
|
395
|
+
|
|
396
|
+
Name | Type | Description | Notes
|
|
397
|
+
------------- | ------------- | ------------- | -------------
|
|
398
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
399
|
+
**period** | **Integer**| The number of observations, per period, to calculate Commodity Channel Index | [optional] [default to 20]
|
|
400
|
+
**constant** | **Float**| The number of observations, per period, to calculate Commodity Channel Index | [optional] [default to 0.015]
|
|
401
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
402
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
403
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
404
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
405
|
+
|
|
406
|
+
### Return type
|
|
407
|
+
|
|
408
|
+
[**ApiResponseSecurityCommodityChannelIndex**](ApiResponseSecurityCommodityChannelIndex.md)
|
|
409
|
+
|
|
410
|
+
# **get_security_price_technicals_cmf**
|
|
411
|
+
> ApiResponseSecurityChaikinMoneyFlow get_security_price_technicals_cmf(identifier, opts)
|
|
412
|
+
|
|
413
|
+
Chaikin Money Flow
|
|
414
|
+
|
|
415
|
+
Returns the Chaikin Money Flow values of Stock Prices for the Security with the given `identifier`
|
|
416
|
+
|
|
417
|
+
### Example
|
|
418
|
+
```ruby
|
|
419
|
+
# Load the gem
|
|
420
|
+
require 'intrinio-sdk'
|
|
421
|
+
|
|
422
|
+
# Setup authorization
|
|
423
|
+
Intrinio.configure do |config|
|
|
424
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
425
|
+
end
|
|
426
|
+
|
|
427
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
428
|
+
|
|
429
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
430
|
+
|
|
431
|
+
opts = {
|
|
432
|
+
period: 20, # Integer | The number of observations, per period, to calculate Chaikin Money Flow
|
|
433
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
434
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
|
435
|
+
page_size: 100, # Integer | The number of results to return
|
|
436
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
437
|
+
}
|
|
438
|
+
|
|
439
|
+
begin
|
|
440
|
+
result = technical_api.get_security_price_technicals_cmf(identifier, opts)
|
|
441
|
+
p result
|
|
442
|
+
rescue Intrinio::ApiError => e
|
|
443
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_cmf: #{e}"
|
|
444
|
+
end
|
|
445
|
+
```
|
|
446
|
+
|
|
447
|
+
### Parameters
|
|
448
|
+
|
|
449
|
+
Name | Type | Description | Notes
|
|
450
|
+
------------- | ------------- | ------------- | -------------
|
|
451
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
452
|
+
**period** | **Integer**| The number of observations, per period, to calculate Chaikin Money Flow | [optional] [default to 20]
|
|
453
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
454
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
455
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
456
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
457
|
+
|
|
458
|
+
### Return type
|
|
459
|
+
|
|
460
|
+
[**ApiResponseSecurityChaikinMoneyFlow**](ApiResponseSecurityChaikinMoneyFlow.md)
|
|
461
|
+
|
|
462
|
+
# **get_security_price_technicals_dc**
|
|
463
|
+
> ApiResponseSecurityDonchianChannel get_security_price_technicals_dc(identifier, opts)
|
|
464
|
+
|
|
465
|
+
Donchian Channel
|
|
466
|
+
|
|
467
|
+
Returns the Donchian Channel values of Stock Prices for the Security with the given `identifier`
|
|
468
|
+
|
|
469
|
+
### Example
|
|
470
|
+
```ruby
|
|
471
|
+
# Load the gem
|
|
472
|
+
require 'intrinio-sdk'
|
|
473
|
+
|
|
474
|
+
# Setup authorization
|
|
475
|
+
Intrinio.configure do |config|
|
|
476
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
477
|
+
end
|
|
478
|
+
|
|
479
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
480
|
+
|
|
481
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
482
|
+
|
|
483
|
+
opts = {
|
|
484
|
+
period: 20, # Integer | The number of observations, per period, to calculate Donchian Channel
|
|
485
|
+
price_key: "close", # String | The Stock Price field to use when calculating Donchian Channel
|
|
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 = technical_api.get_security_price_technicals_dc(identifier, opts)
|
|
494
|
+
p result
|
|
495
|
+
rescue Intrinio::ApiError => e
|
|
496
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_dc: #{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 Donchian Channel | [optional] [default to 20]
|
|
506
|
+
**price_key** | **String**| The Stock Price field to use when calculating Donchian Channel | [optional] [default to close]
|
|
507
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
508
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
509
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
510
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
511
|
+
|
|
512
|
+
### Return type
|
|
513
|
+
|
|
514
|
+
[**ApiResponseSecurityDonchianChannel**](ApiResponseSecurityDonchianChannel.md)
|
|
515
|
+
|
|
516
|
+
# **get_security_price_technicals_dpo**
|
|
517
|
+
> ApiResponseSecurityDetrendedPriceOscillator get_security_price_technicals_dpo(identifier, opts)
|
|
518
|
+
|
|
519
|
+
Detrended Price Oscillator
|
|
520
|
+
|
|
521
|
+
Returns the Detrended Price Oscillator values of Stock Prices for the Security with the given `identifier`
|
|
522
|
+
|
|
523
|
+
### Example
|
|
524
|
+
```ruby
|
|
525
|
+
# Load the gem
|
|
526
|
+
require 'intrinio-sdk'
|
|
527
|
+
|
|
528
|
+
# Setup authorization
|
|
529
|
+
Intrinio.configure do |config|
|
|
530
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
531
|
+
end
|
|
532
|
+
|
|
533
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
534
|
+
|
|
535
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
536
|
+
|
|
537
|
+
opts = {
|
|
538
|
+
period: 20, # Integer | The number of observations, per period, to calculate Detrended Price Oscillator
|
|
539
|
+
price_key: "close", # String | The Stock Price field to use when calculating Detrended Price Oscillator
|
|
540
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
541
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
|
542
|
+
page_size: 100, # Integer | The number of results to return
|
|
543
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
544
|
+
}
|
|
545
|
+
|
|
546
|
+
begin
|
|
547
|
+
result = technical_api.get_security_price_technicals_dpo(identifier, opts)
|
|
548
|
+
p result
|
|
549
|
+
rescue Intrinio::ApiError => e
|
|
550
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_dpo: #{e}"
|
|
551
|
+
end
|
|
552
|
+
```
|
|
553
|
+
|
|
554
|
+
### Parameters
|
|
555
|
+
|
|
556
|
+
Name | Type | Description | Notes
|
|
557
|
+
------------- | ------------- | ------------- | -------------
|
|
558
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
559
|
+
**period** | **Integer**| The number of observations, per period, to calculate Detrended Price Oscillator | [optional] [default to 20]
|
|
560
|
+
**price_key** | **String**| The Stock Price field to use when calculating Detrended Price Oscillator | [optional] [default to close]
|
|
561
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
562
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
563
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
564
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
565
|
+
|
|
566
|
+
### Return type
|
|
567
|
+
|
|
568
|
+
[**ApiResponseSecurityDetrendedPriceOscillator**](ApiResponseSecurityDetrendedPriceOscillator.md)
|
|
569
|
+
|
|
570
|
+
# **get_security_price_technicals_eom**
|
|
571
|
+
> ApiResponseSecurityEaseOfMovement get_security_price_technicals_eom(identifier, opts)
|
|
572
|
+
|
|
573
|
+
Ease of Movement
|
|
574
|
+
|
|
575
|
+
Returns the Ease of Movement values of Stock Prices for the Security with the given `identifier`
|
|
576
|
+
|
|
577
|
+
### Example
|
|
578
|
+
```ruby
|
|
579
|
+
# Load the gem
|
|
580
|
+
require 'intrinio-sdk'
|
|
581
|
+
|
|
582
|
+
# Setup authorization
|
|
583
|
+
Intrinio.configure do |config|
|
|
584
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
585
|
+
end
|
|
586
|
+
|
|
587
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
588
|
+
|
|
589
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
590
|
+
|
|
591
|
+
opts = {
|
|
592
|
+
period: 20, # Integer | The number of observations, per period, to calculate Ease of Movement
|
|
593
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
594
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
|
595
|
+
page_size: 100, # Integer | The number of results to return
|
|
596
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
597
|
+
}
|
|
598
|
+
|
|
599
|
+
begin
|
|
600
|
+
result = technical_api.get_security_price_technicals_eom(identifier, opts)
|
|
601
|
+
p result
|
|
602
|
+
rescue Intrinio::ApiError => e
|
|
603
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_eom: #{e}"
|
|
604
|
+
end
|
|
605
|
+
```
|
|
606
|
+
|
|
607
|
+
### Parameters
|
|
608
|
+
|
|
609
|
+
Name | Type | Description | Notes
|
|
610
|
+
------------- | ------------- | ------------- | -------------
|
|
611
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
612
|
+
**period** | **Integer**| The number of observations, per period, to calculate Ease of Movement | [optional] [default to 20]
|
|
613
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
614
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
615
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
616
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
617
|
+
|
|
618
|
+
### Return type
|
|
619
|
+
|
|
620
|
+
[**ApiResponseSecurityEaseOfMovement**](ApiResponseSecurityEaseOfMovement.md)
|
|
621
|
+
|
|
622
|
+
# **get_security_price_technicals_fi**
|
|
623
|
+
> ApiResponseSecurityForceIndex get_security_price_technicals_fi(identifier, opts)
|
|
624
|
+
|
|
625
|
+
Force Index
|
|
626
|
+
|
|
627
|
+
Returns the Force Index values of Stock Prices for the Security with the given `identifier`
|
|
628
|
+
|
|
629
|
+
### Example
|
|
630
|
+
```ruby
|
|
631
|
+
# Load the gem
|
|
632
|
+
require 'intrinio-sdk'
|
|
633
|
+
|
|
634
|
+
# Setup authorization
|
|
635
|
+
Intrinio.configure do |config|
|
|
636
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
637
|
+
end
|
|
638
|
+
|
|
639
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
640
|
+
|
|
641
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
642
|
+
|
|
643
|
+
opts = {
|
|
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 = technical_api.get_security_price_technicals_fi(identifier, opts)
|
|
652
|
+
p result
|
|
653
|
+
rescue Intrinio::ApiError => e
|
|
654
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_fi: #{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
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
664
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
665
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
666
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
667
|
+
|
|
668
|
+
### Return type
|
|
669
|
+
|
|
670
|
+
[**ApiResponseSecurityForceIndex**](ApiResponseSecurityForceIndex.md)
|
|
671
|
+
|
|
672
|
+
# **get_security_price_technicals_ichimoku**
|
|
673
|
+
> ApiResponseSecurityIchimokuKinkoHyo get_security_price_technicals_ichimoku(identifier, opts)
|
|
674
|
+
|
|
675
|
+
Ichimoku Kinko Hyo
|
|
676
|
+
|
|
677
|
+
Returns the Ichimoku Kinko Hyo values of Stock Prices for the Security with the given `identifier`
|
|
678
|
+
|
|
679
|
+
### Example
|
|
680
|
+
```ruby
|
|
681
|
+
# Load the gem
|
|
682
|
+
require 'intrinio-sdk'
|
|
683
|
+
|
|
684
|
+
# Setup authorization
|
|
685
|
+
Intrinio.configure do |config|
|
|
686
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
687
|
+
end
|
|
688
|
+
|
|
689
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
690
|
+
|
|
691
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
692
|
+
|
|
693
|
+
opts = {
|
|
694
|
+
low_period: 9, # Integer | The number of observations, per period, to calculate Tenkan Sen (Conversion Line) of Ichimoku Kinko Hyo
|
|
695
|
+
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
|
|
696
|
+
high_period: 52, # Integer | The number of observations, per period, to calculate Senkou Span B (Leading Span B) of Ichimoku Kinko Hyo
|
|
697
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
698
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
|
699
|
+
page_size: 100, # Integer | The number of results to return
|
|
700
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
701
|
+
}
|
|
702
|
+
|
|
703
|
+
begin
|
|
704
|
+
result = technical_api.get_security_price_technicals_ichimoku(identifier, opts)
|
|
705
|
+
p result
|
|
706
|
+
rescue Intrinio::ApiError => e
|
|
707
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_ichimoku: #{e}"
|
|
708
|
+
end
|
|
709
|
+
```
|
|
710
|
+
|
|
711
|
+
### Parameters
|
|
712
|
+
|
|
713
|
+
Name | Type | Description | Notes
|
|
714
|
+
------------- | ------------- | ------------- | -------------
|
|
715
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
716
|
+
**low_period** | **Integer**| The number of observations, per period, to calculate Tenkan Sen (Conversion Line) of Ichimoku Kinko Hyo | [optional] [default to 9]
|
|
717
|
+
**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]
|
|
718
|
+
**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]
|
|
719
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
720
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
721
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
722
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
723
|
+
|
|
724
|
+
### Return type
|
|
725
|
+
|
|
726
|
+
[**ApiResponseSecurityIchimokuKinkoHyo**](ApiResponseSecurityIchimokuKinkoHyo.md)
|
|
727
|
+
|
|
728
|
+
# **get_security_price_technicals_kc**
|
|
729
|
+
> ApiResponseSecurityKeltnerChannel get_security_price_technicals_kc(identifier, opts)
|
|
730
|
+
|
|
731
|
+
Keltner Channel
|
|
732
|
+
|
|
733
|
+
Returns the Keltner Channel values of Stock Prices for the Security with the given `identifier`
|
|
734
|
+
|
|
735
|
+
### Example
|
|
736
|
+
```ruby
|
|
737
|
+
# Load the gem
|
|
738
|
+
require 'intrinio-sdk'
|
|
739
|
+
|
|
740
|
+
# Setup authorization
|
|
741
|
+
Intrinio.configure do |config|
|
|
742
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
743
|
+
end
|
|
744
|
+
|
|
745
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
746
|
+
|
|
747
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
748
|
+
|
|
749
|
+
opts = {
|
|
750
|
+
period: 10, # Integer | The number of observations, per period, to calculate Kelter Channel
|
|
751
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
752
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
|
753
|
+
page_size: 100, # Integer | The number of results to return
|
|
754
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
755
|
+
}
|
|
756
|
+
|
|
757
|
+
begin
|
|
758
|
+
result = technical_api.get_security_price_technicals_kc(identifier, opts)
|
|
759
|
+
p result
|
|
760
|
+
rescue Intrinio::ApiError => e
|
|
761
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_kc: #{e}"
|
|
762
|
+
end
|
|
763
|
+
```
|
|
764
|
+
|
|
765
|
+
### Parameters
|
|
766
|
+
|
|
767
|
+
Name | Type | Description | Notes
|
|
768
|
+
------------- | ------------- | ------------- | -------------
|
|
769
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
770
|
+
**period** | **Integer**| The number of observations, per period, to calculate Kelter Channel | [optional] [default to 10]
|
|
771
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
772
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
773
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
774
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
775
|
+
|
|
776
|
+
### Return type
|
|
777
|
+
|
|
778
|
+
[**ApiResponseSecurityKeltnerChannel**](ApiResponseSecurityKeltnerChannel.md)
|
|
779
|
+
|
|
780
|
+
# **get_security_price_technicals_kst**
|
|
781
|
+
> ApiResponseSecurityKnowSureThing get_security_price_technicals_kst(identifier, opts)
|
|
782
|
+
|
|
783
|
+
Know Sure Thing
|
|
784
|
+
|
|
785
|
+
Returns the Know Sure Thing values of Stock Prices for the Security with the given `identifier`
|
|
786
|
+
|
|
787
|
+
### Example
|
|
788
|
+
```ruby
|
|
789
|
+
# Load the gem
|
|
790
|
+
require 'intrinio-sdk'
|
|
791
|
+
|
|
792
|
+
# Setup authorization
|
|
793
|
+
Intrinio.configure do |config|
|
|
794
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
795
|
+
end
|
|
796
|
+
|
|
797
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
798
|
+
|
|
799
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
800
|
+
|
|
801
|
+
opts = {
|
|
802
|
+
roc1: 10, # Integer | The number of observations, per period, to calculate the rate-of-change for RCMA1
|
|
803
|
+
roc2: 15, # Integer | The number of observations, per period, to calculate the rate-of-change for RCMA2
|
|
804
|
+
roc3: 15, # Integer | The number of observations, per period, to calculate the rate-of-change for RCMA2
|
|
805
|
+
roc4: 20, # Integer | The number of observations, per period, to calculate the rate-of-change for RCMA3
|
|
806
|
+
roc5: 30, # Integer | The number of observations, per period, to calculate the rate-of-change for RCMA4
|
|
807
|
+
sma1: 10, # Integer | The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA1
|
|
808
|
+
sma2: 10, # Integer | The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA2
|
|
809
|
+
sma3: 10, # Integer | The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA3
|
|
810
|
+
sma4: 15, # Integer | The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA4
|
|
811
|
+
price_key: "close", # String | The Stock Price field to use when calculating Know Sure Thing
|
|
812
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
813
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
|
814
|
+
page_size: 100, # Integer | The number of results to return
|
|
815
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
816
|
+
}
|
|
817
|
+
|
|
818
|
+
begin
|
|
819
|
+
result = technical_api.get_security_price_technicals_kst(identifier, opts)
|
|
820
|
+
p result
|
|
821
|
+
rescue Intrinio::ApiError => e
|
|
822
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_kst: #{e}"
|
|
823
|
+
end
|
|
824
|
+
```
|
|
825
|
+
|
|
826
|
+
### Parameters
|
|
827
|
+
|
|
828
|
+
Name | Type | Description | Notes
|
|
829
|
+
------------- | ------------- | ------------- | -------------
|
|
830
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
831
|
+
**roc1** | **Integer**| The number of observations, per period, to calculate the rate-of-change for RCMA1 | [optional] [default to 10]
|
|
832
|
+
**roc2** | **Integer**| The number of observations, per period, to calculate the rate-of-change for RCMA2 | [optional] [default to 15]
|
|
833
|
+
**roc3** | **Integer**| The number of observations, per period, to calculate the rate-of-change for RCMA2 | [optional] [default to 15]
|
|
834
|
+
**roc4** | **Integer**| The number of observations, per period, to calculate the rate-of-change for RCMA3 | [optional] [default to 20]
|
|
835
|
+
**roc5** | **Integer**| The number of observations, per period, to calculate the rate-of-change for RCMA4 | [optional] [default to 30]
|
|
836
|
+
**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]
|
|
837
|
+
**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]
|
|
838
|
+
**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]
|
|
839
|
+
**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]
|
|
840
|
+
**price_key** | **String**| The Stock Price field to use when calculating Know Sure Thing | [optional] [default to close]
|
|
841
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
842
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
843
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
844
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
845
|
+
|
|
846
|
+
### Return type
|
|
847
|
+
|
|
848
|
+
[**ApiResponseSecurityKnowSureThing**](ApiResponseSecurityKnowSureThing.md)
|
|
849
|
+
|
|
850
|
+
# **get_security_price_technicals_macd**
|
|
851
|
+
> ApiResponseSecurityMovingAverageConvergenceDivergence get_security_price_technicals_macd(identifier, opts)
|
|
852
|
+
|
|
853
|
+
Moving Average Convergence Divergence
|
|
854
|
+
|
|
855
|
+
Returns the Moving Average Convergence Divergence values of Stock Prices for the Security with the given `identifier`
|
|
856
|
+
|
|
857
|
+
### Example
|
|
858
|
+
```ruby
|
|
859
|
+
# Load the gem
|
|
860
|
+
require 'intrinio-sdk'
|
|
861
|
+
|
|
862
|
+
# Setup authorization
|
|
863
|
+
Intrinio.configure do |config|
|
|
864
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
865
|
+
end
|
|
866
|
+
|
|
867
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
868
|
+
|
|
869
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
870
|
+
|
|
871
|
+
opts = {
|
|
872
|
+
fast_period: 12, # Integer | The number of observations, per period, to calculate the fast moving Exponential Moving Average for Moving Average Convergence Divergence
|
|
873
|
+
slow_period: 26, # Integer | The number of observations, per period, to calculate the slow moving Exponential Moving Average for Moving Average Convergence Divergence
|
|
874
|
+
signal_period: 9, # Integer | The number of observations, per period, to calculate the signal line for Moving Average Convergence Divergence
|
|
875
|
+
price_key: "close", # String | The Stock Price field to use when calculating Moving Average Convergence Divergence
|
|
876
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
877
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
|
878
|
+
page_size: 100, # Integer | The number of results to return
|
|
879
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
880
|
+
}
|
|
881
|
+
|
|
882
|
+
begin
|
|
883
|
+
result = technical_api.get_security_price_technicals_macd(identifier, opts)
|
|
884
|
+
p result
|
|
885
|
+
rescue Intrinio::ApiError => e
|
|
886
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_macd: #{e}"
|
|
887
|
+
end
|
|
888
|
+
```
|
|
889
|
+
|
|
890
|
+
### Parameters
|
|
891
|
+
|
|
892
|
+
Name | Type | Description | Notes
|
|
893
|
+
------------- | ------------- | ------------- | -------------
|
|
894
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
895
|
+
**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]
|
|
896
|
+
**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]
|
|
897
|
+
**signal_period** | **Integer**| The number of observations, per period, to calculate the signal line for Moving Average Convergence Divergence | [optional] [default to 9]
|
|
898
|
+
**price_key** | **String**| The Stock Price field to use when calculating Moving Average Convergence Divergence | [optional] [default to close]
|
|
899
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
900
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
901
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
902
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
903
|
+
|
|
904
|
+
### Return type
|
|
905
|
+
|
|
906
|
+
[**ApiResponseSecurityMovingAverageConvergenceDivergence**](ApiResponseSecurityMovingAverageConvergenceDivergence.md)
|
|
907
|
+
|
|
908
|
+
# **get_security_price_technicals_mfi**
|
|
909
|
+
> ApiResponseSecurityMoneyFlowIndex get_security_price_technicals_mfi(identifier, opts)
|
|
910
|
+
|
|
911
|
+
Money Flow Index
|
|
912
|
+
|
|
913
|
+
Returns the Money Flow Index values of Stock Prices for the Security with the given `identifier`
|
|
914
|
+
|
|
915
|
+
### Example
|
|
916
|
+
```ruby
|
|
917
|
+
# Load the gem
|
|
918
|
+
require 'intrinio-sdk'
|
|
919
|
+
|
|
920
|
+
# Setup authorization
|
|
921
|
+
Intrinio.configure do |config|
|
|
922
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
923
|
+
end
|
|
924
|
+
|
|
925
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
926
|
+
|
|
927
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
928
|
+
|
|
929
|
+
opts = {
|
|
930
|
+
period: 14, # Integer | The number of observations, per period, to calculate Money Flow Index
|
|
931
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
932
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
|
933
|
+
page_size: 100, # Integer | The number of results to return
|
|
934
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
935
|
+
}
|
|
936
|
+
|
|
937
|
+
begin
|
|
938
|
+
result = technical_api.get_security_price_technicals_mfi(identifier, opts)
|
|
939
|
+
p result
|
|
940
|
+
rescue Intrinio::ApiError => e
|
|
941
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_mfi: #{e}"
|
|
942
|
+
end
|
|
943
|
+
```
|
|
944
|
+
|
|
945
|
+
### Parameters
|
|
946
|
+
|
|
947
|
+
Name | Type | Description | Notes
|
|
948
|
+
------------- | ------------- | ------------- | -------------
|
|
949
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
950
|
+
**period** | **Integer**| The number of observations, per period, to calculate Money Flow Index | [optional] [default to 14]
|
|
951
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
952
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
953
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
954
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
955
|
+
|
|
956
|
+
### Return type
|
|
957
|
+
|
|
958
|
+
[**ApiResponseSecurityMoneyFlowIndex**](ApiResponseSecurityMoneyFlowIndex.md)
|
|
959
|
+
|
|
960
|
+
# **get_security_price_technicals_mi**
|
|
961
|
+
> ApiResponseSecurityMassIndex get_security_price_technicals_mi(identifier, opts)
|
|
962
|
+
|
|
963
|
+
Mass Index
|
|
964
|
+
|
|
965
|
+
Returns the Mass Index values of Stock Prices for the Security with the given `identifier`
|
|
966
|
+
|
|
967
|
+
### Example
|
|
968
|
+
```ruby
|
|
969
|
+
# Load the gem
|
|
970
|
+
require 'intrinio-sdk'
|
|
971
|
+
|
|
972
|
+
# Setup authorization
|
|
973
|
+
Intrinio.configure do |config|
|
|
974
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
975
|
+
end
|
|
976
|
+
|
|
977
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
978
|
+
|
|
979
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
980
|
+
|
|
981
|
+
opts = {
|
|
982
|
+
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
|
|
983
|
+
sum_period: 25, # Integer | The number of observations, per period, to calculate the sum of the Exponetinal Moving Average Ratios for Mass Index
|
|
984
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
985
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
|
986
|
+
page_size: 100, # Integer | The number of results to return
|
|
987
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
988
|
+
}
|
|
989
|
+
|
|
990
|
+
begin
|
|
991
|
+
result = technical_api.get_security_price_technicals_mi(identifier, opts)
|
|
992
|
+
p result
|
|
993
|
+
rescue Intrinio::ApiError => e
|
|
994
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_mi: #{e}"
|
|
995
|
+
end
|
|
996
|
+
```
|
|
997
|
+
|
|
998
|
+
### Parameters
|
|
999
|
+
|
|
1000
|
+
Name | Type | Description | Notes
|
|
1001
|
+
------------- | ------------- | ------------- | -------------
|
|
1002
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
1003
|
+
**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]
|
|
1004
|
+
**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]
|
|
1005
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
1006
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
1007
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
1008
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
1009
|
+
|
|
1010
|
+
### Return type
|
|
1011
|
+
|
|
1012
|
+
[**ApiResponseSecurityMassIndex**](ApiResponseSecurityMassIndex.md)
|
|
1013
|
+
|
|
1014
|
+
# **get_security_price_technicals_nvi**
|
|
1015
|
+
> ApiResponseSecurityNegativeVolumeIndex get_security_price_technicals_nvi(identifier, opts)
|
|
1016
|
+
|
|
1017
|
+
Negative Volume Index
|
|
1018
|
+
|
|
1019
|
+
Returns the Negative Volume Index values of Stock Prices for the Security with the given `identifier`
|
|
1020
|
+
|
|
1021
|
+
### Example
|
|
1022
|
+
```ruby
|
|
1023
|
+
# Load the gem
|
|
1024
|
+
require 'intrinio-sdk'
|
|
1025
|
+
|
|
1026
|
+
# Setup authorization
|
|
1027
|
+
Intrinio.configure do |config|
|
|
1028
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
1029
|
+
end
|
|
1030
|
+
|
|
1031
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
1032
|
+
|
|
1033
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1034
|
+
|
|
1035
|
+
opts = {
|
|
1036
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
1037
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
|
1038
|
+
page_size: 100, # Integer | The number of results to return
|
|
1039
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
1040
|
+
}
|
|
1041
|
+
|
|
1042
|
+
begin
|
|
1043
|
+
result = technical_api.get_security_price_technicals_nvi(identifier, opts)
|
|
1044
|
+
p result
|
|
1045
|
+
rescue Intrinio::ApiError => e
|
|
1046
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_nvi: #{e}"
|
|
1047
|
+
end
|
|
1048
|
+
```
|
|
1049
|
+
|
|
1050
|
+
### Parameters
|
|
1051
|
+
|
|
1052
|
+
Name | Type | Description | Notes
|
|
1053
|
+
------------- | ------------- | ------------- | -------------
|
|
1054
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
1055
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
1056
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
1057
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
1058
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
1059
|
+
|
|
1060
|
+
### Return type
|
|
1061
|
+
|
|
1062
|
+
[**ApiResponseSecurityNegativeVolumeIndex**](ApiResponseSecurityNegativeVolumeIndex.md)
|
|
1063
|
+
|
|
1064
|
+
# **get_security_price_technicals_obv**
|
|
1065
|
+
> ApiResponseSecurityOnBalanceVolume get_security_price_technicals_obv(identifier, opts)
|
|
1066
|
+
|
|
1067
|
+
On-balance Volume
|
|
1068
|
+
|
|
1069
|
+
Returns the On-balance Volume values of Stock Prices for the Security with the given `identifier`
|
|
1070
|
+
|
|
1071
|
+
### Example
|
|
1072
|
+
```ruby
|
|
1073
|
+
# Load the gem
|
|
1074
|
+
require 'intrinio-sdk'
|
|
1075
|
+
|
|
1076
|
+
# Setup authorization
|
|
1077
|
+
Intrinio.configure do |config|
|
|
1078
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
1079
|
+
end
|
|
1080
|
+
|
|
1081
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
1082
|
+
|
|
1083
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1084
|
+
|
|
1085
|
+
opts = {
|
|
1086
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
1087
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
|
1088
|
+
page_size: 100, # Integer | The number of results to return
|
|
1089
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
1090
|
+
}
|
|
1091
|
+
|
|
1092
|
+
begin
|
|
1093
|
+
result = technical_api.get_security_price_technicals_obv(identifier, opts)
|
|
1094
|
+
p result
|
|
1095
|
+
rescue Intrinio::ApiError => e
|
|
1096
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_obv: #{e}"
|
|
1097
|
+
end
|
|
1098
|
+
```
|
|
1099
|
+
|
|
1100
|
+
### Parameters
|
|
1101
|
+
|
|
1102
|
+
Name | Type | Description | Notes
|
|
1103
|
+
------------- | ------------- | ------------- | -------------
|
|
1104
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
1105
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
1106
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
1107
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
1108
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
1109
|
+
|
|
1110
|
+
### Return type
|
|
1111
|
+
|
|
1112
|
+
[**ApiResponseSecurityOnBalanceVolume**](ApiResponseSecurityOnBalanceVolume.md)
|
|
1113
|
+
|
|
1114
|
+
# **get_security_price_technicals_obv_mean**
|
|
1115
|
+
> ApiResponseSecurityOnBalanceVolumeMean get_security_price_technicals_obv_mean(identifier, opts)
|
|
1116
|
+
|
|
1117
|
+
On-balance Volume Mean
|
|
1118
|
+
|
|
1119
|
+
Returns the On-balance Volume Mean values of Stock Prices for the Security with the given `identifier`
|
|
1120
|
+
|
|
1121
|
+
### Example
|
|
1122
|
+
```ruby
|
|
1123
|
+
# Load the gem
|
|
1124
|
+
require 'intrinio-sdk'
|
|
1125
|
+
|
|
1126
|
+
# Setup authorization
|
|
1127
|
+
Intrinio.configure do |config|
|
|
1128
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
1129
|
+
end
|
|
1130
|
+
|
|
1131
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
1132
|
+
|
|
1133
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1134
|
+
|
|
1135
|
+
opts = {
|
|
1136
|
+
period: 10, # Integer | The number of observations, per period, to calculate On-balance Volume Mean
|
|
1137
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
1138
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
|
1139
|
+
page_size: 100, # Integer | The number of results to return
|
|
1140
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
1141
|
+
}
|
|
1142
|
+
|
|
1143
|
+
begin
|
|
1144
|
+
result = technical_api.get_security_price_technicals_obv_mean(identifier, opts)
|
|
1145
|
+
p result
|
|
1146
|
+
rescue Intrinio::ApiError => e
|
|
1147
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_obv_mean: #{e}"
|
|
1148
|
+
end
|
|
1149
|
+
```
|
|
1150
|
+
|
|
1151
|
+
### Parameters
|
|
1152
|
+
|
|
1153
|
+
Name | Type | Description | Notes
|
|
1154
|
+
------------- | ------------- | ------------- | -------------
|
|
1155
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
1156
|
+
**period** | **Integer**| The number of observations, per period, to calculate On-balance Volume Mean | [optional] [default to 10]
|
|
1157
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
1158
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
1159
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
1160
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
1161
|
+
|
|
1162
|
+
### Return type
|
|
1163
|
+
|
|
1164
|
+
[**ApiResponseSecurityOnBalanceVolumeMean**](ApiResponseSecurityOnBalanceVolumeMean.md)
|
|
1165
|
+
|
|
1166
|
+
# **get_security_price_technicals_rsi**
|
|
1167
|
+
> ApiResponseSecurityRelativeStrengthIndex get_security_price_technicals_rsi(identifier, opts)
|
|
1168
|
+
|
|
1169
|
+
Relative Strength Index
|
|
1170
|
+
|
|
1171
|
+
Returns the Relative Strength Index values of Stock Prices for the Security with the given `identifier`
|
|
1172
|
+
|
|
1173
|
+
### Example
|
|
1174
|
+
```ruby
|
|
1175
|
+
# Load the gem
|
|
1176
|
+
require 'intrinio-sdk'
|
|
1177
|
+
|
|
1178
|
+
# Setup authorization
|
|
1179
|
+
Intrinio.configure do |config|
|
|
1180
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
1181
|
+
end
|
|
1182
|
+
|
|
1183
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
1184
|
+
|
|
1185
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1186
|
+
|
|
1187
|
+
opts = {
|
|
1188
|
+
period: 14, # Integer | The number of observations, per period, to calculate Relative Strength Index
|
|
1189
|
+
price_key: "close", # String | The Stock Price field to use when calculating Relative Strength Index
|
|
1190
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
1191
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
|
1192
|
+
page_size: 100, # Integer | The number of results to return
|
|
1193
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
1194
|
+
}
|
|
1195
|
+
|
|
1196
|
+
begin
|
|
1197
|
+
result = technical_api.get_security_price_technicals_rsi(identifier, opts)
|
|
1198
|
+
p result
|
|
1199
|
+
rescue Intrinio::ApiError => e
|
|
1200
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_rsi: #{e}"
|
|
1201
|
+
end
|
|
1202
|
+
```
|
|
1203
|
+
|
|
1204
|
+
### Parameters
|
|
1205
|
+
|
|
1206
|
+
Name | Type | Description | Notes
|
|
1207
|
+
------------- | ------------- | ------------- | -------------
|
|
1208
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
1209
|
+
**period** | **Integer**| The number of observations, per period, to calculate Relative Strength Index | [optional] [default to 14]
|
|
1210
|
+
**price_key** | **String**| The Stock Price field to use when calculating Relative Strength Index | [optional] [default to close]
|
|
1211
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
1212
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
1213
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
1214
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
1215
|
+
|
|
1216
|
+
### Return type
|
|
1217
|
+
|
|
1218
|
+
[**ApiResponseSecurityRelativeStrengthIndex**](ApiResponseSecurityRelativeStrengthIndex.md)
|
|
1219
|
+
|
|
1220
|
+
# **get_security_price_technicals_sma**
|
|
1221
|
+
> ApiResponseSecuritySimpleMovingAverage get_security_price_technicals_sma(identifier, opts)
|
|
1222
|
+
|
|
1223
|
+
Simple Moving Average
|
|
1224
|
+
|
|
1225
|
+
Returns the Simple Moving Average values of Stock Prices for the Security with the given `identifier`
|
|
1226
|
+
|
|
1227
|
+
### Example
|
|
1228
|
+
```ruby
|
|
1229
|
+
# Load the gem
|
|
1230
|
+
require 'intrinio-sdk'
|
|
1231
|
+
|
|
1232
|
+
# Setup authorization
|
|
1233
|
+
Intrinio.configure do |config|
|
|
1234
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
1235
|
+
end
|
|
1236
|
+
|
|
1237
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
1238
|
+
|
|
1239
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1240
|
+
|
|
1241
|
+
opts = {
|
|
1242
|
+
period: 20, # Integer | The number of observations, per period, to calculate Simple Moving Average
|
|
1243
|
+
price_key: "close", # String | The Stock Price field to use when calculating Simple Moving Average
|
|
1244
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
1245
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
|
1246
|
+
page_size: 100, # Integer | The number of results to return
|
|
1247
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
1248
|
+
}
|
|
1249
|
+
|
|
1250
|
+
begin
|
|
1251
|
+
result = technical_api.get_security_price_technicals_sma(identifier, opts)
|
|
1252
|
+
p result
|
|
1253
|
+
rescue Intrinio::ApiError => e
|
|
1254
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_sma: #{e}"
|
|
1255
|
+
end
|
|
1256
|
+
```
|
|
1257
|
+
|
|
1258
|
+
### Parameters
|
|
1259
|
+
|
|
1260
|
+
Name | Type | Description | Notes
|
|
1261
|
+
------------- | ------------- | ------------- | -------------
|
|
1262
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
1263
|
+
**period** | **Integer**| The number of observations, per period, to calculate Simple Moving Average | [optional] [default to 20]
|
|
1264
|
+
**price_key** | **String**| The Stock Price field to use when calculating Simple Moving Average | [optional] [default to close]
|
|
1265
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
1266
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
1267
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
1268
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
1269
|
+
|
|
1270
|
+
### Return type
|
|
1271
|
+
|
|
1272
|
+
[**ApiResponseSecuritySimpleMovingAverage**](ApiResponseSecuritySimpleMovingAverage.md)
|
|
1273
|
+
|
|
1274
|
+
# **get_security_price_technicals_sr**
|
|
1275
|
+
> ApiResponseSecurityStochasticOscillator get_security_price_technicals_sr(identifier, opts)
|
|
1276
|
+
|
|
1277
|
+
Stochastic Oscillator
|
|
1278
|
+
|
|
1279
|
+
Returns the Stochastic Oscillator values of Stock Prices for the Security with the given `identifier`
|
|
1280
|
+
|
|
1281
|
+
### Example
|
|
1282
|
+
```ruby
|
|
1283
|
+
# Load the gem
|
|
1284
|
+
require 'intrinio-sdk'
|
|
1285
|
+
|
|
1286
|
+
# Setup authorization
|
|
1287
|
+
Intrinio.configure do |config|
|
|
1288
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
1289
|
+
end
|
|
1290
|
+
|
|
1291
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
1292
|
+
|
|
1293
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1294
|
+
|
|
1295
|
+
opts = {
|
|
1296
|
+
period: 14, # Integer | The number of observations, per period, to calculate %K of Stochastic Oscillator
|
|
1297
|
+
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
|
|
1298
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
1299
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
|
1300
|
+
page_size: 100, # Integer | The number of results to return
|
|
1301
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
1302
|
+
}
|
|
1303
|
+
|
|
1304
|
+
begin
|
|
1305
|
+
result = technical_api.get_security_price_technicals_sr(identifier, opts)
|
|
1306
|
+
p result
|
|
1307
|
+
rescue Intrinio::ApiError => e
|
|
1308
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_sr: #{e}"
|
|
1309
|
+
end
|
|
1310
|
+
```
|
|
1311
|
+
|
|
1312
|
+
### Parameters
|
|
1313
|
+
|
|
1314
|
+
Name | Type | Description | Notes
|
|
1315
|
+
------------- | ------------- | ------------- | -------------
|
|
1316
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
1317
|
+
**period** | **Integer**| The number of observations, per period, to calculate %K of Stochastic Oscillator | [optional] [default to 14]
|
|
1318
|
+
**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]
|
|
1319
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
1320
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
1321
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
1322
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
1323
|
+
|
|
1324
|
+
### Return type
|
|
1325
|
+
|
|
1326
|
+
[**ApiResponseSecurityStochasticOscillator**](ApiResponseSecurityStochasticOscillator.md)
|
|
1327
|
+
|
|
1328
|
+
# **get_security_price_technicals_trix**
|
|
1329
|
+
> ApiResponseSecurityTripleExponentialAverage get_security_price_technicals_trix(identifier, opts)
|
|
1330
|
+
|
|
1331
|
+
Triple Exponential Average
|
|
1332
|
+
|
|
1333
|
+
Returns the Simple Moving Average values of Stock Prices for the Security with the given `identifier`
|
|
1334
|
+
|
|
1335
|
+
### Example
|
|
1336
|
+
```ruby
|
|
1337
|
+
# Load the gem
|
|
1338
|
+
require 'intrinio-sdk'
|
|
1339
|
+
|
|
1340
|
+
# Setup authorization
|
|
1341
|
+
Intrinio.configure do |config|
|
|
1342
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
1343
|
+
end
|
|
1344
|
+
|
|
1345
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
1346
|
+
|
|
1347
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1348
|
+
|
|
1349
|
+
opts = {
|
|
1350
|
+
period: 15, # Integer | The number of observations, per period, to calculate Exponential Moving Average for Triple Exponential Average
|
|
1351
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
1352
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
|
1353
|
+
page_size: 100, # Integer | The number of results to return
|
|
1354
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
1355
|
+
}
|
|
1356
|
+
|
|
1357
|
+
begin
|
|
1358
|
+
result = technical_api.get_security_price_technicals_trix(identifier, opts)
|
|
1359
|
+
p result
|
|
1360
|
+
rescue Intrinio::ApiError => e
|
|
1361
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_trix: #{e}"
|
|
1362
|
+
end
|
|
1363
|
+
```
|
|
1364
|
+
|
|
1365
|
+
### Parameters
|
|
1366
|
+
|
|
1367
|
+
Name | Type | Description | Notes
|
|
1368
|
+
------------- | ------------- | ------------- | -------------
|
|
1369
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
1370
|
+
**period** | **Integer**| The number of observations, per period, to calculate Exponential Moving Average for Triple Exponential Average | [optional] [default to 15]
|
|
1371
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
1372
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
1373
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
1374
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
1375
|
+
|
|
1376
|
+
### Return type
|
|
1377
|
+
|
|
1378
|
+
[**ApiResponseSecurityTripleExponentialAverage**](ApiResponseSecurityTripleExponentialAverage.md)
|
|
1379
|
+
|
|
1380
|
+
# **get_security_price_technicals_tsi**
|
|
1381
|
+
> ApiResponseSecurityTrueStrengthIndex get_security_price_technicals_tsi(identifier, opts)
|
|
1382
|
+
|
|
1383
|
+
True Strength Index
|
|
1384
|
+
|
|
1385
|
+
Returns the True Strength Index values of Stock Prices for the Security with the given `identifier`
|
|
1386
|
+
|
|
1387
|
+
### Example
|
|
1388
|
+
```ruby
|
|
1389
|
+
# Load the gem
|
|
1390
|
+
require 'intrinio-sdk'
|
|
1391
|
+
|
|
1392
|
+
# Setup authorization
|
|
1393
|
+
Intrinio.configure do |config|
|
|
1394
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
1395
|
+
end
|
|
1396
|
+
|
|
1397
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
1398
|
+
|
|
1399
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1400
|
+
|
|
1401
|
+
opts = {
|
|
1402
|
+
low_period: 13, # Integer | The number of observations, per period, to calculate low period Exponential Moving Average for smoothing in True Strength Index
|
|
1403
|
+
high_period: 25, # Integer | The number of observations, per period, to calculate high period Exponential Moving Average for smoothing in True Strength Index
|
|
1404
|
+
price_key: "close", # String | The Stock Price field to use when calculating True Strength Index
|
|
1405
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
1406
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
|
1407
|
+
page_size: 100, # Integer | The number of results to return
|
|
1408
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
1409
|
+
}
|
|
1410
|
+
|
|
1411
|
+
begin
|
|
1412
|
+
result = technical_api.get_security_price_technicals_tsi(identifier, opts)
|
|
1413
|
+
p result
|
|
1414
|
+
rescue Intrinio::ApiError => e
|
|
1415
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_tsi: #{e}"
|
|
1416
|
+
end
|
|
1417
|
+
```
|
|
1418
|
+
|
|
1419
|
+
### Parameters
|
|
1420
|
+
|
|
1421
|
+
Name | Type | Description | Notes
|
|
1422
|
+
------------- | ------------- | ------------- | -------------
|
|
1423
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
1424
|
+
**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]
|
|
1425
|
+
**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]
|
|
1426
|
+
**price_key** | **String**| The Stock Price field to use when calculating True Strength Index | [optional] [default to close]
|
|
1427
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
1428
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
1429
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
1430
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
1431
|
+
|
|
1432
|
+
### Return type
|
|
1433
|
+
|
|
1434
|
+
[**ApiResponseSecurityTrueStrengthIndex**](ApiResponseSecurityTrueStrengthIndex.md)
|
|
1435
|
+
|
|
1436
|
+
# **get_security_price_technicals_uo**
|
|
1437
|
+
> ApiResponseSecurityUltimateOscillator get_security_price_technicals_uo(identifier, opts)
|
|
1438
|
+
|
|
1439
|
+
Ultimate Oscillator
|
|
1440
|
+
|
|
1441
|
+
Returns the Ultimate Oscillator values of Stock Prices for the Security with the given `identifier`
|
|
1442
|
+
|
|
1443
|
+
### Example
|
|
1444
|
+
```ruby
|
|
1445
|
+
# Load the gem
|
|
1446
|
+
require 'intrinio-sdk'
|
|
1447
|
+
|
|
1448
|
+
# Setup authorization
|
|
1449
|
+
Intrinio.configure do |config|
|
|
1450
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
1451
|
+
end
|
|
1452
|
+
|
|
1453
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
1454
|
+
|
|
1455
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1456
|
+
|
|
1457
|
+
opts = {
|
|
1458
|
+
short_period: 7, # Integer | The number of observations, per period, to calculate the short period for Ultimate Oscillator
|
|
1459
|
+
medium_period: 14, # Integer | The number of observations, per period, to calculate the medium period for Ultimate Oscillator
|
|
1460
|
+
long_period: 28, # Integer | The number of observations, per period, to calculate the long period for Ultimate Oscillator
|
|
1461
|
+
short_weight: 4.0, # Float | The weight of short Buying Pressure average for Ultimate Oscillator
|
|
1462
|
+
medium_weight: 2.0, # Float | The weight of medium Buying Pressure average for Ultimate Oscillator
|
|
1463
|
+
long_weight: 1.0, # Float | The weight of long Buying Pressure average for Ultimate Oscillator
|
|
1464
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
1465
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
|
1466
|
+
page_size: 100, # Integer | The number of results to return
|
|
1467
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
1468
|
+
}
|
|
1469
|
+
|
|
1470
|
+
begin
|
|
1471
|
+
result = technical_api.get_security_price_technicals_uo(identifier, opts)
|
|
1472
|
+
p result
|
|
1473
|
+
rescue Intrinio::ApiError => e
|
|
1474
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_uo: #{e}"
|
|
1475
|
+
end
|
|
1476
|
+
```
|
|
1477
|
+
|
|
1478
|
+
### Parameters
|
|
1479
|
+
|
|
1480
|
+
Name | Type | Description | Notes
|
|
1481
|
+
------------- | ------------- | ------------- | -------------
|
|
1482
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
1483
|
+
**short_period** | **Integer**| The number of observations, per period, to calculate the short period for Ultimate Oscillator | [optional] [default to 7]
|
|
1484
|
+
**medium_period** | **Integer**| The number of observations, per period, to calculate the medium period for Ultimate Oscillator | [optional] [default to 14]
|
|
1485
|
+
**long_period** | **Integer**| The number of observations, per period, to calculate the long period for Ultimate Oscillator | [optional] [default to 28]
|
|
1486
|
+
**short_weight** | **Float**| The weight of short Buying Pressure average for Ultimate Oscillator | [optional] [default to 4.0]
|
|
1487
|
+
**medium_weight** | **Float**| The weight of medium Buying Pressure average for Ultimate Oscillator | [optional] [default to 2.0]
|
|
1488
|
+
**long_weight** | **Float**| The weight of long Buying Pressure average for Ultimate Oscillator | [optional] [default to 1.0]
|
|
1489
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
1490
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
1491
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
1492
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
1493
|
+
|
|
1494
|
+
### Return type
|
|
1495
|
+
|
|
1496
|
+
[**ApiResponseSecurityUltimateOscillator**](ApiResponseSecurityUltimateOscillator.md)
|
|
1497
|
+
|
|
1498
|
+
# **get_security_price_technicals_vi**
|
|
1499
|
+
> ApiResponseSecurityVortexIndicator get_security_price_technicals_vi(identifier, opts)
|
|
1500
|
+
|
|
1501
|
+
Vortex Indicator
|
|
1502
|
+
|
|
1503
|
+
Returns the Vortex Indicator values of Stock Prices for the Security with the given `identifier`
|
|
1504
|
+
|
|
1505
|
+
### Example
|
|
1506
|
+
```ruby
|
|
1507
|
+
# Load the gem
|
|
1508
|
+
require 'intrinio-sdk'
|
|
1509
|
+
|
|
1510
|
+
# Setup authorization
|
|
1511
|
+
Intrinio.configure do |config|
|
|
1512
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
1513
|
+
end
|
|
1514
|
+
|
|
1515
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
1516
|
+
|
|
1517
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1518
|
+
|
|
1519
|
+
opts = {
|
|
1520
|
+
period: 14, # Integer | The number of observations, per period, to calculate Vortex Indicator
|
|
1521
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
1522
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
|
1523
|
+
page_size: 100, # Integer | The number of results to return
|
|
1524
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
1525
|
+
}
|
|
1526
|
+
|
|
1527
|
+
begin
|
|
1528
|
+
result = technical_api.get_security_price_technicals_vi(identifier, opts)
|
|
1529
|
+
p result
|
|
1530
|
+
rescue Intrinio::ApiError => e
|
|
1531
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_vi: #{e}"
|
|
1532
|
+
end
|
|
1533
|
+
```
|
|
1534
|
+
|
|
1535
|
+
### Parameters
|
|
1536
|
+
|
|
1537
|
+
Name | Type | Description | Notes
|
|
1538
|
+
------------- | ------------- | ------------- | -------------
|
|
1539
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
1540
|
+
**period** | **Integer**| The number of observations, per period, to calculate Vortex Indicator | [optional] [default to 14]
|
|
1541
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
1542
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
1543
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
1544
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
1545
|
+
|
|
1546
|
+
### Return type
|
|
1547
|
+
|
|
1548
|
+
[**ApiResponseSecurityVortexIndicator**](ApiResponseSecurityVortexIndicator.md)
|
|
1549
|
+
|
|
1550
|
+
# **get_security_price_technicals_vpt**
|
|
1551
|
+
> ApiResponseSecurityVolumePriceTrend get_security_price_technicals_vpt(identifier, opts)
|
|
1552
|
+
|
|
1553
|
+
Volume-price Trend
|
|
1554
|
+
|
|
1555
|
+
Returns the Volume-price Trend values of Stock Prices for the Security with the given `identifier`
|
|
1556
|
+
|
|
1557
|
+
### Example
|
|
1558
|
+
```ruby
|
|
1559
|
+
# Load the gem
|
|
1560
|
+
require 'intrinio-sdk'
|
|
1561
|
+
|
|
1562
|
+
# Setup authorization
|
|
1563
|
+
Intrinio.configure do |config|
|
|
1564
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
1565
|
+
end
|
|
1566
|
+
|
|
1567
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
1568
|
+
|
|
1569
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1570
|
+
|
|
1571
|
+
opts = {
|
|
1572
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
1573
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
|
1574
|
+
page_size: 100, # Integer | The number of results to return
|
|
1575
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
1576
|
+
}
|
|
1577
|
+
|
|
1578
|
+
begin
|
|
1579
|
+
result = technical_api.get_security_price_technicals_vpt(identifier, opts)
|
|
1580
|
+
p result
|
|
1581
|
+
rescue Intrinio::ApiError => e
|
|
1582
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_vpt: #{e}"
|
|
1583
|
+
end
|
|
1584
|
+
```
|
|
1585
|
+
|
|
1586
|
+
### Parameters
|
|
1587
|
+
|
|
1588
|
+
Name | Type | Description | Notes
|
|
1589
|
+
------------- | ------------- | ------------- | -------------
|
|
1590
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
1591
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
1592
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
1593
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
1594
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
1595
|
+
|
|
1596
|
+
### Return type
|
|
1597
|
+
|
|
1598
|
+
[**ApiResponseSecurityVolumePriceTrend**](ApiResponseSecurityVolumePriceTrend.md)
|
|
1599
|
+
|
|
1600
|
+
# **get_security_price_technicals_vwap**
|
|
1601
|
+
> ApiResponseSecurityVolumeWeightedAveragePrice get_security_price_technicals_vwap(identifier, opts)
|
|
1602
|
+
|
|
1603
|
+
Volume Weighted Average Price
|
|
1604
|
+
|
|
1605
|
+
Returns the Volume Weighted Average Price values of Stock Prices for the Security with the given `identifier`
|
|
1606
|
+
|
|
1607
|
+
### Example
|
|
1608
|
+
```ruby
|
|
1609
|
+
# Load the gem
|
|
1610
|
+
require 'intrinio-sdk'
|
|
1611
|
+
|
|
1612
|
+
# Setup authorization
|
|
1613
|
+
Intrinio.configure do |config|
|
|
1614
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
1615
|
+
end
|
|
1616
|
+
|
|
1617
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
1618
|
+
|
|
1619
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1620
|
+
|
|
1621
|
+
opts = {
|
|
1622
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
1623
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
|
1624
|
+
page_size: 100, # Integer | The number of results to return
|
|
1625
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
1626
|
+
}
|
|
1627
|
+
|
|
1628
|
+
begin
|
|
1629
|
+
result = technical_api.get_security_price_technicals_vwap(identifier, opts)
|
|
1630
|
+
p result
|
|
1631
|
+
rescue Intrinio::ApiError => e
|
|
1632
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_vwap: #{e}"
|
|
1633
|
+
end
|
|
1634
|
+
```
|
|
1635
|
+
|
|
1636
|
+
### Parameters
|
|
1637
|
+
|
|
1638
|
+
Name | Type | Description | Notes
|
|
1639
|
+
------------- | ------------- | ------------- | -------------
|
|
1640
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
1641
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
1642
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
1643
|
+
**page_size** | **Integer**| The number of results to return | [optional] [default to 100]
|
|
1644
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
1645
|
+
|
|
1646
|
+
### Return type
|
|
1647
|
+
|
|
1648
|
+
[**ApiResponseSecurityVolumeWeightedAveragePrice**](ApiResponseSecurityVolumeWeightedAveragePrice.md)
|
|
1649
|
+
|
|
1650
|
+
# **get_security_price_technicals_wr**
|
|
1651
|
+
> ApiResponseSecurityWilliamsR get_security_price_technicals_wr(identifier, opts)
|
|
1652
|
+
|
|
1653
|
+
Williams %R
|
|
1654
|
+
|
|
1655
|
+
Returns the Williams %R values of Stock Prices for the Security with the given `identifier`
|
|
1656
|
+
|
|
1657
|
+
### Example
|
|
1658
|
+
```ruby
|
|
1659
|
+
# Load the gem
|
|
1660
|
+
require 'intrinio-sdk'
|
|
1661
|
+
|
|
1662
|
+
# Setup authorization
|
|
1663
|
+
Intrinio.configure do |config|
|
|
1664
|
+
config.api_key['api_key'] = 'YOUR API KEY'
|
|
1665
|
+
end
|
|
1666
|
+
|
|
1667
|
+
technical_api = Intrinio::TechnicalApi.new
|
|
1668
|
+
|
|
1669
|
+
identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
|
1670
|
+
|
|
1671
|
+
opts = {
|
|
1672
|
+
period: 14, # Integer | The number of observations, per period, to look-back when calculating Williams %R
|
|
1673
|
+
start_date: "2018-01-01", # String | Return technical indicator values on or after the date
|
|
1674
|
+
end_date: "2019-01-01", # String | Return technical indicator values on or before the date
|
|
1675
|
+
page_size: 100, # Float | The number of results to return
|
|
1676
|
+
next_page: nil # String | Gets the next page of data from a previous API call
|
|
1677
|
+
}
|
|
1678
|
+
|
|
1679
|
+
begin
|
|
1680
|
+
result = technical_api.get_security_price_technicals_wr(identifier, opts)
|
|
1681
|
+
p result
|
|
1682
|
+
rescue Intrinio::ApiError => e
|
|
1683
|
+
puts "Exception when calling TechnicalApi->get_security_price_technicals_wr: #{e}"
|
|
1684
|
+
end
|
|
1685
|
+
```
|
|
1686
|
+
|
|
1687
|
+
### Parameters
|
|
1688
|
+
|
|
1689
|
+
Name | Type | Description | Notes
|
|
1690
|
+
------------- | ------------- | ------------- | -------------
|
|
1691
|
+
**identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |
|
|
1692
|
+
**period** | **Integer**| The number of observations, per period, to look-back when calculating Williams %R | [optional] [default to 14]
|
|
1693
|
+
**start_date** | **String**| Return technical indicator values on or after the date | [optional]
|
|
1694
|
+
**end_date** | **String**| Return technical indicator values on or before the date | [optional]
|
|
1695
|
+
**page_size** | **Float**| The number of results to return | [optional] [default to 100]
|
|
1696
|
+
**next_page** | **String**| Gets the next page of data from a previous API call | [optional]
|
|
1697
|
+
|
|
1698
|
+
### Return type
|
|
1699
|
+
|
|
1700
|
+
[**ApiResponseSecurityWilliamsR**](ApiResponseSecurityWilliamsR.md)
|
|
1701
|
+
|