intrinio-sdk 5.18.0 → 5.21.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +72 -0
- data/README.md +14 -2
- data/docs/ApiResponseESGCompanies.md +24 -0
- data/docs/ApiResponseESGCompanyRatingHistory.md +28 -0
- data/docs/ApiResponseESGLatest.md +24 -0
- data/docs/CompanyApi.md +18 -14
- data/docs/ESGApi.md +262 -0
- data/docs/ESGCompanySummary.md +25 -0
- data/docs/ESGRating.md +24 -0
- data/docs/ESGRatingWithCompany.md +28 -0
- data/docs/ETFAnalytics.md +1 -0
- data/docs/ETFsApi.md +6 -6
- data/docs/FilingApi.md +10 -8
- data/docs/FundamentalsApi.md +103 -4
- data/docs/IndexApi.md +5 -3
- data/docs/InsiderTransactionFiling.md +3 -0
- data/docs/InsiderTransactionFilingsApi.md +2 -0
- data/docs/OptionStatsRealtime.md +1 -0
- data/docs/OptionsApi.md +207 -13
- data/docs/OwnersApi.md +2 -2
- data/docs/SecurityApi.md +34 -34
- data/docs/TechnicalApi.md +31 -31
- data/intrinio-sdk.gemspec +1 -1
- data/lib/intrinio-sdk/api/bulk_downloads_api.rb +1 -1
- data/lib/intrinio-sdk/api/company_api.rb +37 -28
- data/lib/intrinio-sdk/api/data_point_api.rb +1 -1
- data/lib/intrinio-sdk/api/data_tag_api.rb +1 -1
- data/lib/intrinio-sdk/api/esg_api.rb +209 -0
- data/lib/intrinio-sdk/api/et_fs_api.rb +13 -13
- data/lib/intrinio-sdk/api/filing_api.rb +19 -23
- data/lib/intrinio-sdk/api/forex_api.rb +1 -1
- data/lib/intrinio-sdk/api/fundamentals_api.rb +95 -9
- data/lib/intrinio-sdk/api/historical_data_api.rb +1 -1
- data/lib/intrinio-sdk/api/index_api.rb +11 -11
- data/lib/intrinio-sdk/api/insider_transaction_filings_api.rb +4 -1
- data/lib/intrinio-sdk/api/municipality_api.rb +1 -1
- data/lib/intrinio-sdk/api/options_api.rb +196 -25
- data/lib/intrinio-sdk/api/owners_api.rb +3 -3
- data/lib/intrinio-sdk/api/security_api.rb +69 -69
- data/lib/intrinio-sdk/api/stock_exchange_api.rb +1 -1
- data/lib/intrinio-sdk/api/technical_api.rb +63 -63
- data/lib/intrinio-sdk/api/zacks_api.rb +1 -1
- data/lib/intrinio-sdk/api_client.rb +1 -1
- data/lib/intrinio-sdk/api_error.rb +1 -1
- data/lib/intrinio-sdk/configuration.rb +1 -1
- data/lib/intrinio-sdk/models/accumulation_distribution_index_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_bulk_download_links.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_companies.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_companies_search.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_company_answers.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_insider_transaction_filings.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_company_news.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_company_recognize.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_company_securities.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_company_shares_outstanding.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_data_tags.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_data_tags_search.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_economic_index_historical_data.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_economic_indices.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_economic_indices_search.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_esg_companies.rb +200 -0
- data/lib/intrinio-sdk/models/api_response_esg_company_rating_history.rb +209 -0
- data/lib/intrinio-sdk/models/api_response_esg_latest.rb +200 -0
- data/lib/intrinio-sdk/models/api_response_et_fs.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_etf_holdings.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_filing_answers.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_filing_fundamentals.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_initial_public_offerings.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_insider_transaction_filings.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_municipalities.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_municipalitiy_financials.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_news.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_option_prices.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_options.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_options_chain.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_options_chain_eod.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_options_chain_realtime.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_options_expirations.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_options_price_realtime.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_options_prices_batch_realtime.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_options_prices_eod.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_options_realtime.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_options_stats_realtime.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_options_tickers.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_options_unusual_activity.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_owner_insider_transaction_filings.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_owner_institutional_holdings.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_owners.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_reported_financials.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_securities.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_securities_search.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_accumulation_distribution_index.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_average_daily_trading_volume.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_average_directional_index.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_average_true_range.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_awesome_oscillator.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_bollinger_bands.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_chaikin_money_flow.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_commodity_channel_index.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_detrended_price_oscillator.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_donchian_channel.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_ease_of_movement.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_force_index.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_historical_data.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_ichimoku_kinko_hyo.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_institutional_ownership.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_interval_prices.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_intraday_prices.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_keltner_channel.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_know_sure_thing.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_mass_index.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_money_flow_index.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_moving_average_convergence_divergence.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_negative_volume_index.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_on_balance_volume.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_on_balance_volume_mean.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_relative_strength_index.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_simple_moving_average.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_stochastic_oscillator.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_stock_price_adjustments.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_stock_prices.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_triple_exponential_average.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_true_strength_index.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_ultimate_oscillator.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_volume_price_trend.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_volume_weighted_average_price.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_vortex_indicator.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_williams_r.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_zacks_analyst_ratings.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_zacks_analyst_ratings_snapshot.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_zacks_eps_surprises.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_security_zacks_sales_surprises.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_sic_index_historical_data.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_sic_indices.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_sic_indices_search.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_standardized_financials.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_standardized_financials_dimensions.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_stock_exchange_realtime_stock_prices.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_stock_exchange_securities.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_price_adjustments.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_prices.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_stock_exchanges.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_stock_market_index_historical_data.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_stock_market_indices.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_stock_market_indices_search.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_zacks_analyst_ratings.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_zacks_eps_estimates.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_zacks_eps_growth_rates.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_zacks_eps_surprises.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_zacks_etf_holdings.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_zacks_institutional_holding_companies.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_zacks_institutional_holding_owners.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_zacks_institutional_holdings.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_zacks_long_term_growth_rates.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_zacks_sales_surprises.rb +1 -1
- data/lib/intrinio-sdk/models/api_response_zacks_target_price_consensuses.rb +1 -1
- data/lib/intrinio-sdk/models/average_daily_trading_volume_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/average_directional_index_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/average_true_range_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/awesome_oscillator_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/bollinger_bands_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/bulk_download_links.rb +1 -1
- data/lib/intrinio-sdk/models/bulk_download_summary.rb +1 -1
- data/lib/intrinio-sdk/models/chaikin_money_flow_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/commodity_channel_index_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/company.rb +1 -1
- data/lib/intrinio-sdk/models/company_filing.rb +1 -1
- data/lib/intrinio-sdk/models/company_initial_public_offering.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_shares_outstanding.rb +1 -1
- data/lib/intrinio-sdk/models/company_summary.rb +1 -1
- data/lib/intrinio-sdk/models/data_tag.rb +1 -1
- data/lib/intrinio-sdk/models/data_tag_summary.rb +1 -1
- data/lib/intrinio-sdk/models/detrended_price_oscillator_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/dividend_record.rb +1 -1
- data/lib/intrinio-sdk/models/donchian_channel_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/earnings_record.rb +1 -1
- data/lib/intrinio-sdk/models/ease_of_movement_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/economic_index.rb +1 -1
- data/lib/intrinio-sdk/models/economic_index_summary.rb +1 -1
- data/lib/intrinio-sdk/models/esg_company_summary.rb +233 -0
- data/lib/intrinio-sdk/models/esg_rating.rb +224 -0
- data/lib/intrinio-sdk/models/esg_rating_with_company.rb +233 -0
- data/lib/intrinio-sdk/models/etf.rb +1 -1
- data/lib/intrinio-sdk/models/etf_analytics.rb +12 -2
- data/lib/intrinio-sdk/models/etf_holding.rb +1 -1
- data/lib/intrinio-sdk/models/etf_stats.rb +1 -1
- data/lib/intrinio-sdk/models/etf_summary.rb +1 -1
- data/lib/intrinio-sdk/models/filing.rb +1 -1
- data/lib/intrinio-sdk/models/filing_note.rb +1 -1
- data/lib/intrinio-sdk/models/filing_note_filing.rb +1 -1
- data/lib/intrinio-sdk/models/filing_note_summary.rb +1 -1
- data/lib/intrinio-sdk/models/filing_summary.rb +1 -1
- data/lib/intrinio-sdk/models/force_index_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/forex_currency.rb +1 -1
- data/lib/intrinio-sdk/models/forex_pair.rb +1 -1
- data/lib/intrinio-sdk/models/forex_price.rb +1 -1
- data/lib/intrinio-sdk/models/fundamental.rb +1 -1
- data/lib/intrinio-sdk/models/fundamental_summary.rb +1 -1
- data/lib/intrinio-sdk/models/historical_data.rb +1 -1
- data/lib/intrinio-sdk/models/ichimoku_kinko_hyo_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/insider_transaction.rb +1 -1
- data/lib/intrinio-sdk/models/insider_transaction_filing.rb +32 -2
- data/lib/intrinio-sdk/models/institutional_holding.rb +1 -1
- data/lib/intrinio-sdk/models/institutional_ownership.rb +1 -1
- data/lib/intrinio-sdk/models/intraday_stock_price.rb +1 -1
- data/lib/intrinio-sdk/models/keltner_channel_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/know_sure_thing_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/mass_index_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/money_flow_index_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/moving_average_convergence_divergence_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/municipality.rb +1 -1
- data/lib/intrinio-sdk/models/municipality_financial.rb +1 -1
- data/lib/intrinio-sdk/models/negative_volume_index_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/on_balance_volume_mean_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/on_balance_volume_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/option.rb +1 -1
- data/lib/intrinio-sdk/models/option_chain.rb +1 -1
- data/lib/intrinio-sdk/models/option_chain_eod.rb +1 -1
- data/lib/intrinio-sdk/models/option_chain_realtime.rb +1 -1
- data/lib/intrinio-sdk/models/option_contracts_list.rb +1 -1
- data/lib/intrinio-sdk/models/option_eod.rb +1 -1
- data/lib/intrinio-sdk/models/option_factors_realtime.rb +1 -1
- data/lib/intrinio-sdk/models/option_price.rb +1 -1
- data/lib/intrinio-sdk/models/option_price_batch_realtime.rb +1 -1
- data/lib/intrinio-sdk/models/option_price_eod.rb +1 -1
- data/lib/intrinio-sdk/models/option_price_realtime.rb +1 -1
- data/lib/intrinio-sdk/models/option_realtime.rb +1 -1
- data/lib/intrinio-sdk/models/option_stats_realtime.rb +15 -5
- data/lib/intrinio-sdk/models/option_unusual_trade.rb +1 -1
- data/lib/intrinio-sdk/models/owner.rb +1 -1
- data/lib/intrinio-sdk/models/owner_summary.rb +1 -1
- data/lib/intrinio-sdk/models/realtime_stock_price.rb +1 -1
- data/lib/intrinio-sdk/models/realtime_stock_price_security.rb +1 -1
- data/lib/intrinio-sdk/models/relative_strength_index_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/reported_financial.rb +1 -1
- data/lib/intrinio-sdk/models/reported_financial_dimension.rb +1 -1
- data/lib/intrinio-sdk/models/reported_tag.rb +1 -1
- data/lib/intrinio-sdk/models/security.rb +1 -1
- data/lib/intrinio-sdk/models/security_screen_clause.rb +1 -1
- data/lib/intrinio-sdk/models/security_screen_group.rb +1 -1
- data/lib/intrinio-sdk/models/security_screen_result.rb +1 -1
- data/lib/intrinio-sdk/models/security_screen_result_data.rb +1 -1
- data/lib/intrinio-sdk/models/security_summary.rb +1 -1
- data/lib/intrinio-sdk/models/sic_index.rb +1 -1
- data/lib/intrinio-sdk/models/simple_moving_average_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/standardized_financial.rb +1 -1
- data/lib/intrinio-sdk/models/standardized_financials_dimension.rb +1 -1
- data/lib/intrinio-sdk/models/stochastic_oscillator_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/stock_exchange.rb +1 -1
- data/lib/intrinio-sdk/models/stock_market_index.rb +1 -1
- data/lib/intrinio-sdk/models/stock_market_index_summary.rb +1 -1
- data/lib/intrinio-sdk/models/stock_price.rb +1 -1
- data/lib/intrinio-sdk/models/stock_price_adjustment.rb +1 -1
- data/lib/intrinio-sdk/models/stock_price_adjustment_summary.rb +1 -1
- data/lib/intrinio-sdk/models/stock_price_interval.rb +1 -1
- data/lib/intrinio-sdk/models/stock_price_summary.rb +1 -1
- data/lib/intrinio-sdk/models/technical_indicator.rb +1 -1
- data/lib/intrinio-sdk/models/thea_entity_answer.rb +1 -1
- data/lib/intrinio-sdk/models/thea_source_document.rb +1 -1
- data/lib/intrinio-sdk/models/triple_exponential_average_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/true_strength_index_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/ultimate_oscillator_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/volume_price_trend_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/volume_weighted_average_price_value.rb +1 -1
- data/lib/intrinio-sdk/models/vortex_indicator_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/williams_r_technical_value.rb +1 -1
- data/lib/intrinio-sdk/models/zacks_analyst_rating.rb +1 -1
- data/lib/intrinio-sdk/models/zacks_analyst_rating_snapshot.rb +1 -1
- data/lib/intrinio-sdk/models/zacks_analyst_rating_summary.rb +1 -1
- data/lib/intrinio-sdk/models/zacks_eps_estimate.rb +1 -1
- data/lib/intrinio-sdk/models/zacks_eps_growth_rate.rb +1 -1
- data/lib/intrinio-sdk/models/zacks_eps_surprise.rb +1 -1
- data/lib/intrinio-sdk/models/zacks_eps_surprise_summary.rb +1 -1
- data/lib/intrinio-sdk/models/zacks_etf_holding.rb +1 -1
- data/lib/intrinio-sdk/models/zacks_institutional_holding.rb +1 -1
- data/lib/intrinio-sdk/models/zacks_institutional_holding_company_detail.rb +1 -1
- data/lib/intrinio-sdk/models/zacks_institutional_holding_company_summary.rb +1 -1
- data/lib/intrinio-sdk/models/zacks_institutional_holding_historical_summary.rb +1 -1
- data/lib/intrinio-sdk/models/zacks_institutional_holding_owner_detail.rb +1 -1
- data/lib/intrinio-sdk/models/zacks_institutional_holding_owner_summary.rb +1 -1
- data/lib/intrinio-sdk/models/zacks_long_term_growth_rate.rb +1 -1
- data/lib/intrinio-sdk/models/zacks_sales_surprise.rb +1 -1
- data/lib/intrinio-sdk/models/zacks_sales_surprise_summary.rb +1 -1
- data/lib/intrinio-sdk/models/zacks_target_price_consensus.rb +1 -1
- data/lib/intrinio-sdk/version.rb +2 -2
- data/lib/intrinio-sdk.rb +8 -1
- data/spec/api/bulk_downloads_api_spec.rb +1 -1
- data/spec/api/company_api_spec.rb +15 -13
- data/spec/api/data_point_api_spec.rb +1 -1
- data/spec/api/data_tag_api_spec.rb +1 -1
- data/spec/api/esg_api_spec.rb +78 -0
- data/spec/api/et_fs_api_spec.rb +7 -7
- data/spec/api/filing_api_spec.rb +8 -8
- data/spec/api/forex_api_spec.rb +1 -1
- data/spec/api/fundamentals_api_spec.rb +26 -5
- data/spec/api/historical_data_api_spec.rb +1 -1
- data/spec/api/index_api_spec.rb +6 -6
- data/spec/api/insider_transaction_filings_api_spec.rb +2 -1
- data/spec/api/municipality_api_spec.rb +1 -1
- data/spec/api/options_api_spec.rb +53 -13
- data/spec/api/owners_api_spec.rb +2 -2
- data/spec/api/security_api_spec.rb +35 -35
- data/spec/api/stock_exchange_api_spec.rb +1 -1
- data/spec/api/technical_api_spec.rb +32 -32
- data/spec/api/zacks_api_spec.rb +1 -1
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +1 -1
- data/spec/models/accumulation_distribution_index_technical_value_spec.rb +1 -1
- data/spec/models/api_response_bulk_download_links_spec.rb +1 -1
- data/spec/models/api_response_companies_search_spec.rb +1 -1
- data/spec/models/api_response_companies_spec.rb +1 -1
- data/spec/models/api_response_company_answers_spec.rb +1 -1
- data/spec/models/api_response_company_filings_spec.rb +1 -1
- data/spec/models/api_response_company_fundamentals_spec.rb +1 -1
- data/spec/models/api_response_company_historical_data_spec.rb +1 -1
- data/spec/models/api_response_company_insider_transaction_filings_spec.rb +1 -1
- data/spec/models/api_response_company_news_spec.rb +1 -1
- data/spec/models/api_response_company_recognize_spec.rb +1 -1
- data/spec/models/api_response_company_securities_spec.rb +1 -1
- data/spec/models/api_response_company_shares_outstanding_spec.rb +1 -1
- data/spec/models/api_response_data_tags_search_spec.rb +1 -1
- data/spec/models/api_response_data_tags_spec.rb +1 -1
- data/spec/models/api_response_economic_index_historical_data_spec.rb +1 -1
- data/spec/models/api_response_economic_indices_search_spec.rb +1 -1
- data/spec/models/api_response_economic_indices_spec.rb +1 -1
- data/spec/models/api_response_esg_companies_spec.rb +48 -0
- data/spec/models/api_response_esg_company_rating_history_spec.rb +54 -0
- data/spec/models/api_response_esg_latest_spec.rb +48 -0
- data/spec/models/api_response_et_fs_spec.rb +1 -1
- data/spec/models/api_response_etf_holdings_spec.rb +1 -1
- data/spec/models/api_response_filing_answers_spec.rb +1 -1
- data/spec/models/api_response_filing_fundamentals_spec.rb +1 -1
- data/spec/models/api_response_filing_notes_search_spec.rb +1 -1
- data/spec/models/api_response_filing_notes_spec.rb +1 -1
- data/spec/models/api_response_filings_spec.rb +1 -1
- data/spec/models/api_response_forex_currencies_spec.rb +1 -1
- data/spec/models/api_response_forex_pairs_spec.rb +1 -1
- data/spec/models/api_response_forex_prices_spec.rb +1 -1
- data/spec/models/api_response_historical_data_spec.rb +1 -1
- data/spec/models/api_response_initial_public_offerings_spec.rb +1 -1
- data/spec/models/api_response_insider_transaction_filings_spec.rb +1 -1
- data/spec/models/api_response_municipalities_spec.rb +1 -1
- data/spec/models/api_response_municipalitiy_financials_spec.rb +1 -1
- data/spec/models/api_response_news_spec.rb +1 -1
- data/spec/models/api_response_option_prices_spec.rb +1 -1
- data/spec/models/api_response_options_chain_eod_spec.rb +1 -1
- data/spec/models/api_response_options_chain_realtime_spec.rb +1 -1
- data/spec/models/api_response_options_chain_spec.rb +1 -1
- data/spec/models/api_response_options_expirations_spec.rb +1 -1
- data/spec/models/api_response_options_price_realtime_spec.rb +1 -1
- data/spec/models/api_response_options_prices_batch_realtime_spec.rb +1 -1
- data/spec/models/api_response_options_prices_eod_spec.rb +1 -1
- data/spec/models/api_response_options_realtime_spec.rb +1 -1
- data/spec/models/api_response_options_spec.rb +1 -1
- data/spec/models/api_response_options_stats_realtime_spec.rb +1 -1
- data/spec/models/api_response_options_tickers_spec.rb +1 -1
- data/spec/models/api_response_options_unusual_activity_spec.rb +1 -1
- data/spec/models/api_response_owner_insider_transaction_filings_spec.rb +1 -1
- data/spec/models/api_response_owner_institutional_holdings_spec.rb +1 -1
- data/spec/models/api_response_owners_spec.rb +1 -1
- data/spec/models/api_response_reported_financials_spec.rb +1 -1
- data/spec/models/api_response_securities_search_spec.rb +1 -1
- data/spec/models/api_response_securities_spec.rb +1 -1
- data/spec/models/api_response_security_accumulation_distribution_index_spec.rb +1 -1
- data/spec/models/api_response_security_average_daily_trading_volume_spec.rb +1 -1
- data/spec/models/api_response_security_average_directional_index_spec.rb +1 -1
- data/spec/models/api_response_security_average_true_range_spec.rb +1 -1
- data/spec/models/api_response_security_awesome_oscillator_spec.rb +1 -1
- data/spec/models/api_response_security_bollinger_bands_spec.rb +1 -1
- data/spec/models/api_response_security_chaikin_money_flow_spec.rb +1 -1
- data/spec/models/api_response_security_commodity_channel_index_spec.rb +1 -1
- data/spec/models/api_response_security_detrended_price_oscillator_spec.rb +1 -1
- data/spec/models/api_response_security_donchian_channel_spec.rb +1 -1
- data/spec/models/api_response_security_ease_of_movement_spec.rb +1 -1
- data/spec/models/api_response_security_force_index_spec.rb +1 -1
- data/spec/models/api_response_security_historical_data_spec.rb +1 -1
- data/spec/models/api_response_security_ichimoku_kinko_hyo_spec.rb +1 -1
- data/spec/models/api_response_security_institutional_ownership_spec.rb +1 -1
- data/spec/models/api_response_security_interval_prices_spec.rb +1 -1
- data/spec/models/api_response_security_intraday_prices_spec.rb +1 -1
- data/spec/models/api_response_security_keltner_channel_spec.rb +1 -1
- data/spec/models/api_response_security_know_sure_thing_spec.rb +1 -1
- data/spec/models/api_response_security_mass_index_spec.rb +1 -1
- data/spec/models/api_response_security_money_flow_index_spec.rb +1 -1
- data/spec/models/api_response_security_moving_average_convergence_divergence_spec.rb +1 -1
- data/spec/models/api_response_security_negative_volume_index_spec.rb +1 -1
- data/spec/models/api_response_security_on_balance_volume_mean_spec.rb +1 -1
- data/spec/models/api_response_security_on_balance_volume_spec.rb +1 -1
- data/spec/models/api_response_security_relative_strength_index_spec.rb +1 -1
- data/spec/models/api_response_security_simple_moving_average_spec.rb +1 -1
- data/spec/models/api_response_security_stochastic_oscillator_spec.rb +1 -1
- data/spec/models/api_response_security_stock_price_adjustments_spec.rb +1 -1
- data/spec/models/api_response_security_stock_prices_spec.rb +1 -1
- data/spec/models/api_response_security_triple_exponential_average_spec.rb +1 -1
- data/spec/models/api_response_security_true_strength_index_spec.rb +1 -1
- data/spec/models/api_response_security_ultimate_oscillator_spec.rb +1 -1
- data/spec/models/api_response_security_volume_price_trend_spec.rb +1 -1
- data/spec/models/api_response_security_volume_weighted_average_price_spec.rb +1 -1
- data/spec/models/api_response_security_vortex_indicator_spec.rb +1 -1
- data/spec/models/api_response_security_williams_r_spec.rb +1 -1
- data/spec/models/api_response_security_zacks_analyst_ratings_snapshot_spec.rb +1 -1
- data/spec/models/api_response_security_zacks_analyst_ratings_spec.rb +1 -1
- data/spec/models/api_response_security_zacks_eps_surprises_spec.rb +1 -1
- data/spec/models/api_response_security_zacks_sales_surprises_spec.rb +1 -1
- data/spec/models/api_response_sic_index_historical_data_spec.rb +1 -1
- data/spec/models/api_response_sic_indices_search_spec.rb +1 -1
- data/spec/models/api_response_sic_indices_spec.rb +1 -1
- data/spec/models/api_response_standardized_financials_dimensions_spec.rb +1 -1
- data/spec/models/api_response_standardized_financials_spec.rb +1 -1
- data/spec/models/api_response_stock_exchange_realtime_stock_prices_spec.rb +1 -1
- data/spec/models/api_response_stock_exchange_securities_spec.rb +1 -1
- data/spec/models/api_response_stock_exchange_stock_price_adjustments_spec.rb +1 -1
- data/spec/models/api_response_stock_exchange_stock_prices_spec.rb +1 -1
- data/spec/models/api_response_stock_exchanges_spec.rb +1 -1
- data/spec/models/api_response_stock_market_index_historical_data_spec.rb +1 -1
- data/spec/models/api_response_stock_market_indices_search_spec.rb +1 -1
- data/spec/models/api_response_stock_market_indices_spec.rb +1 -1
- data/spec/models/api_response_zacks_analyst_ratings_spec.rb +1 -1
- data/spec/models/api_response_zacks_eps_estimates_spec.rb +1 -1
- data/spec/models/api_response_zacks_eps_growth_rates_spec.rb +1 -1
- data/spec/models/api_response_zacks_eps_surprises_spec.rb +1 -1
- data/spec/models/api_response_zacks_etf_holdings_spec.rb +1 -1
- data/spec/models/api_response_zacks_institutional_holding_companies_spec.rb +1 -1
- data/spec/models/api_response_zacks_institutional_holding_owners_spec.rb +1 -1
- data/spec/models/api_response_zacks_institutional_holdings_spec.rb +1 -1
- data/spec/models/api_response_zacks_long_term_growth_rates_spec.rb +1 -1
- data/spec/models/api_response_zacks_sales_surprises_spec.rb +1 -1
- data/spec/models/api_response_zacks_target_price_consensuses_spec.rb +1 -1
- data/spec/models/average_daily_trading_volume_technical_value_spec.rb +1 -1
- data/spec/models/average_directional_index_technical_value_spec.rb +1 -1
- data/spec/models/average_true_range_technical_value_spec.rb +1 -1
- data/spec/models/awesome_oscillator_technical_value_spec.rb +1 -1
- data/spec/models/bollinger_bands_technical_value_spec.rb +1 -1
- data/spec/models/bulk_download_links_spec.rb +1 -1
- data/spec/models/bulk_download_summary_spec.rb +1 -1
- data/spec/models/chaikin_money_flow_technical_value_spec.rb +1 -1
- data/spec/models/commodity_channel_index_technical_value_spec.rb +1 -1
- data/spec/models/company_filing_spec.rb +1 -1
- data/spec/models/company_initial_public_offering_spec.rb +1 -1
- data/spec/models/company_news_spec.rb +1 -1
- data/spec/models/company_news_summary_spec.rb +1 -1
- data/spec/models/company_shares_outstanding_spec.rb +1 -1
- data/spec/models/company_spec.rb +1 -1
- data/spec/models/company_summary_spec.rb +1 -1
- data/spec/models/data_tag_spec.rb +1 -1
- data/spec/models/data_tag_summary_spec.rb +1 -1
- data/spec/models/detrended_price_oscillator_technical_value_spec.rb +1 -1
- data/spec/models/dividend_record_spec.rb +1 -1
- data/spec/models/donchian_channel_technical_value_spec.rb +1 -1
- data/spec/models/earnings_record_spec.rb +1 -1
- data/spec/models/ease_of_movement_technical_value_spec.rb +1 -1
- data/spec/models/economic_index_spec.rb +1 -1
- data/spec/models/economic_index_summary_spec.rb +1 -1
- data/spec/models/esg_company_summary_spec.rb +72 -0
- data/spec/models/esg_rating_spec.rb +66 -0
- data/spec/models/esg_rating_with_company_spec.rb +72 -0
- data/spec/models/etf_analytics_spec.rb +7 -1
- data/spec/models/etf_holding_spec.rb +1 -1
- data/spec/models/etf_spec.rb +1 -1
- data/spec/models/etf_stats_spec.rb +1 -1
- data/spec/models/etf_summary_spec.rb +1 -1
- data/spec/models/filing_note_filing_spec.rb +1 -1
- data/spec/models/filing_note_spec.rb +1 -1
- data/spec/models/filing_note_summary_spec.rb +1 -1
- data/spec/models/filing_spec.rb +1 -1
- data/spec/models/filing_summary_spec.rb +1 -1
- data/spec/models/force_index_technical_value_spec.rb +1 -1
- data/spec/models/forex_currency_spec.rb +1 -1
- data/spec/models/forex_pair_spec.rb +1 -1
- data/spec/models/forex_price_spec.rb +1 -1
- data/spec/models/fundamental_spec.rb +1 -1
- data/spec/models/fundamental_summary_spec.rb +1 -1
- data/spec/models/historical_data_spec.rb +1 -1
- data/spec/models/ichimoku_kinko_hyo_technical_value_spec.rb +1 -1
- data/spec/models/insider_transaction_filing_spec.rb +19 -1
- data/spec/models/insider_transaction_spec.rb +1 -1
- data/spec/models/institutional_holding_spec.rb +1 -1
- data/spec/models/institutional_ownership_spec.rb +1 -1
- data/spec/models/intraday_stock_price_spec.rb +1 -1
- data/spec/models/keltner_channel_technical_value_spec.rb +1 -1
- data/spec/models/know_sure_thing_technical_value_spec.rb +1 -1
- data/spec/models/mass_index_technical_value_spec.rb +1 -1
- data/spec/models/money_flow_index_technical_value_spec.rb +1 -1
- data/spec/models/moving_average_convergence_divergence_technical_value_spec.rb +1 -1
- data/spec/models/municipality_financial_spec.rb +1 -1
- data/spec/models/municipality_spec.rb +1 -1
- data/spec/models/negative_volume_index_technical_value_spec.rb +1 -1
- data/spec/models/on_balance_volume_mean_technical_value_spec.rb +1 -1
- data/spec/models/on_balance_volume_technical_value_spec.rb +1 -1
- data/spec/models/option_chain_eod_spec.rb +1 -1
- data/spec/models/option_chain_realtime_spec.rb +1 -1
- data/spec/models/option_chain_spec.rb +1 -1
- data/spec/models/option_contracts_list_spec.rb +1 -1
- data/spec/models/option_eod_spec.rb +1 -1
- data/spec/models/option_factors_realtime_spec.rb +1 -1
- data/spec/models/option_price_batch_realtime_spec.rb +1 -1
- data/spec/models/option_price_eod_spec.rb +1 -1
- data/spec/models/option_price_realtime_spec.rb +1 -1
- data/spec/models/option_price_spec.rb +1 -1
- data/spec/models/option_realtime_spec.rb +1 -1
- data/spec/models/option_spec.rb +1 -1
- data/spec/models/option_stats_realtime_spec.rb +7 -1
- data/spec/models/option_unusual_trade_spec.rb +1 -1
- data/spec/models/owner_spec.rb +1 -1
- data/spec/models/owner_summary_spec.rb +1 -1
- data/spec/models/realtime_stock_price_security_spec.rb +1 -1
- data/spec/models/realtime_stock_price_spec.rb +1 -1
- data/spec/models/relative_strength_index_technical_value_spec.rb +1 -1
- data/spec/models/reported_financial_dimension_spec.rb +1 -1
- data/spec/models/reported_financial_spec.rb +1 -1
- data/spec/models/reported_tag_spec.rb +1 -1
- data/spec/models/security_screen_clause_spec.rb +1 -1
- data/spec/models/security_screen_group_spec.rb +1 -1
- data/spec/models/security_screen_result_data_spec.rb +1 -1
- data/spec/models/security_screen_result_spec.rb +1 -1
- data/spec/models/security_spec.rb +1 -1
- data/spec/models/security_summary_spec.rb +1 -1
- data/spec/models/sic_index_spec.rb +1 -1
- data/spec/models/simple_moving_average_technical_value_spec.rb +1 -1
- data/spec/models/standardized_financial_spec.rb +1 -1
- data/spec/models/standardized_financials_dimension_spec.rb +1 -1
- data/spec/models/stochastic_oscillator_technical_value_spec.rb +1 -1
- data/spec/models/stock_exchange_spec.rb +1 -1
- data/spec/models/stock_market_index_spec.rb +1 -1
- data/spec/models/stock_market_index_summary_spec.rb +1 -1
- data/spec/models/stock_price_adjustment_spec.rb +1 -1
- data/spec/models/stock_price_adjustment_summary_spec.rb +1 -1
- data/spec/models/stock_price_interval_spec.rb +1 -1
- data/spec/models/stock_price_spec.rb +1 -1
- data/spec/models/stock_price_summary_spec.rb +1 -1
- data/spec/models/technical_indicator_spec.rb +1 -1
- data/spec/models/thea_entity_answer_spec.rb +1 -1
- data/spec/models/thea_source_document_spec.rb +1 -1
- data/spec/models/triple_exponential_average_technical_value_spec.rb +1 -1
- data/spec/models/true_strength_index_technical_value_spec.rb +1 -1
- data/spec/models/ultimate_oscillator_technical_value_spec.rb +1 -1
- data/spec/models/volume_price_trend_technical_value_spec.rb +1 -1
- data/spec/models/volume_weighted_average_price_value_spec.rb +1 -1
- data/spec/models/vortex_indicator_technical_value_spec.rb +1 -1
- data/spec/models/williams_r_technical_value_spec.rb +1 -1
- data/spec/models/zacks_analyst_rating_snapshot_spec.rb +1 -1
- data/spec/models/zacks_analyst_rating_spec.rb +1 -1
- data/spec/models/zacks_analyst_rating_summary_spec.rb +1 -1
- data/spec/models/zacks_eps_estimate_spec.rb +1 -1
- data/spec/models/zacks_eps_growth_rate_spec.rb +1 -1
- data/spec/models/zacks_eps_surprise_spec.rb +1 -1
- data/spec/models/zacks_eps_surprise_summary_spec.rb +1 -1
- data/spec/models/zacks_etf_holding_spec.rb +1 -1
- data/spec/models/zacks_institutional_holding_company_detail_spec.rb +1 -1
- data/spec/models/zacks_institutional_holding_company_summary_spec.rb +1 -1
- data/spec/models/zacks_institutional_holding_historical_summary_spec.rb +1 -1
- data/spec/models/zacks_institutional_holding_owner_detail_spec.rb +1 -1
- data/spec/models/zacks_institutional_holding_owner_summary_spec.rb +1 -1
- data/spec/models/zacks_institutional_holding_spec.rb +1 -1
- data/spec/models/zacks_long_term_growth_rate_spec.rb +1 -1
- data/spec/models/zacks_sales_surprise_spec.rb +1 -1
- data/spec/models/zacks_sales_surprise_summary_spec.rb +1 -1
- data/spec/models/zacks_target_price_consensus_spec.rb +1 -1
- data/spec/spec_helper.rb +1 -1
- metadata +32 -3
data/docs/OptionsApi.md
CHANGED
@@ -19,7 +19,9 @@ Method | HTTP request | Description
|
|
19
19
|
[**get_options_prices_realtime**](OptionsApi.md#get_options_prices_realtime) | **GET** /options/prices/{identifier}/realtime | Option Prices Realtime
|
20
20
|
[**get_options_stats_realtime**](OptionsApi.md#get_options_stats_realtime) | **GET** /options/prices/{identifier}/realtime/stats | Option Stats Realtime
|
21
21
|
[**get_unusual_activity**](OptionsApi.md#get_unusual_activity) | **GET** /options/unusual_activity/{symbol} | Options Unusual Activity
|
22
|
+
[**get_unusual_activity_intraday**](OptionsApi.md#get_unusual_activity_intraday) | **GET** /options/unusual_activity/{symbol}/intraday | Options Unusual Activity Intraday
|
22
23
|
[**get_unusual_activity_universal**](OptionsApi.md#get_unusual_activity_universal) | **GET** /options/unusual_activity | Options Unusual Activity Universal
|
24
|
+
[**get_unusual_activity_universal_intraday**](OptionsApi.md#get_unusual_activity_universal_intraday) | **GET** /options/unusual_activity/intraday | Options Unusual Activity Universal Intraday
|
23
25
|
|
24
26
|
|
25
27
|
|
@@ -124,7 +126,7 @@ This endpoint does not need any parameter.
|
|
124
126
|
#### Option Expirations Realtime
|
125
127
|
|
126
128
|
|
127
|
-
Returns all
|
129
|
+
Returns a list of all current and upcoming expiration dates for a particular symbol.
|
128
130
|
|
129
131
|
[//]: # (END_OVERVIEW)
|
130
132
|
|
@@ -210,7 +212,7 @@ Name | Type | Description | Notes
|
|
210
212
|
#### Option Strikes Realtime
|
211
213
|
|
212
214
|
|
213
|
-
Returns
|
215
|
+
Returns a list of the latest top of the order book size and premium (bid / ask), the latest trade size and premium as well as the greeks and implied volatility for all call/put contracts that match the strike and symbol specified.
|
214
216
|
|
215
217
|
[//]: # (END_OVERVIEW)
|
216
218
|
|
@@ -289,7 +291,7 @@ Name | Type | Description | Notes
|
|
289
291
|
#### Options
|
290
292
|
|
291
293
|
|
292
|
-
Returns
|
294
|
+
Returns a list of all securities that have options listed and are tradable on a US market exchange. Useful to retrieve the entire universe.
|
293
295
|
|
294
296
|
[//]: # (END_OVERVIEW)
|
295
297
|
|
@@ -387,7 +389,7 @@ Name | Type | Description | Notes
|
|
387
389
|
#### Options by Symbol Realtime
|
388
390
|
|
389
391
|
|
390
|
-
Returns
|
392
|
+
Returns a list of all securities that have options listed and are tradable on a US market exchange. Useful to retrieve the entire universe.
|
391
393
|
|
392
394
|
[//]: # (END_OVERVIEW)
|
393
395
|
|
@@ -483,7 +485,7 @@ Name | Type | Description | Notes
|
|
483
485
|
#### Options Chain
|
484
486
|
|
485
487
|
|
486
|
-
Returns
|
488
|
+
Returns a list of the historical end-of-day top of the order book size and premium (bid / ask), the latest trade size and premium as well as the greeks and implied volatility for all option contracts currently associated with the option chain.
|
487
489
|
|
488
490
|
[//]: # (END_OVERVIEW)
|
489
491
|
|
@@ -606,7 +608,8 @@ opts = {
|
|
606
608
|
type: nil,
|
607
609
|
strike: nil,
|
608
610
|
strike_greater_than: nil,
|
609
|
-
strike_less_than: nil
|
611
|
+
strike_less_than: nil,
|
612
|
+
date: nil
|
610
613
|
}
|
611
614
|
|
612
615
|
result = options_api.get_options_chain_eod(symbol, expiration, opts)
|
@@ -630,6 +633,7 @@ Name | Type | Description | Notes
|
|
630
633
|
**strike** | Float| The strike price of the option contract. This will return options contracts with strike price equal to this price. | [optional]
|
631
634
|
**strike_greater_than** | Float| The strike price of the option contract. This will return options contracts with strike prices greater than this price. | [optional]
|
632
635
|
**strike_less_than** | Float| The strike price of the option contract. This will return options contracts with strike prices less than this price. | [optional]
|
636
|
+
**date** | Date| The the date to retrieve prices for | [optional]
|
633
637
|
|
634
638
|
[//]: # (END_PARAMETERS)
|
635
639
|
|
@@ -669,7 +673,7 @@ Name | Type | Description | Notes
|
|
669
673
|
#### Options Chain Realtime
|
670
674
|
|
671
675
|
|
672
|
-
Returns
|
676
|
+
Returns a list of the latest National Best Bid & Offer (NBBO) top of the order book size and premium (bid / ask), the latest trade size and premium as well as the greeks and implied volatility for all option contracts currently associated with the option chain.
|
673
677
|
|
674
678
|
[//]: # (END_OVERVIEW)
|
675
679
|
|
@@ -771,7 +775,7 @@ Name | Type | Description | Notes
|
|
771
775
|
#### Options Expirations
|
772
776
|
|
773
777
|
|
774
|
-
Returns all option contract expiration dates for a
|
778
|
+
Returns a list of all current and upcoming option contract expiration dates for a particular symbol.
|
775
779
|
|
776
780
|
[//]: # (END_OVERVIEW)
|
777
781
|
|
@@ -855,7 +859,7 @@ Name | Type | Description | Notes
|
|
855
859
|
#### Option Prices
|
856
860
|
|
857
861
|
|
858
|
-
Returns all
|
862
|
+
Returns all price data from inception to expiration for a particular contract.
|
859
863
|
|
860
864
|
[//]: # (END_OVERVIEW)
|
861
865
|
|
@@ -943,7 +947,7 @@ Name | Type | Description | Notes
|
|
943
947
|
#### Option Prices Batch Realtime
|
944
948
|
|
945
949
|
|
946
|
-
Returns
|
950
|
+
Returns a list of latest price data for up to 250 option contracts per request.
|
947
951
|
|
948
952
|
[//]: # (END_OVERVIEW)
|
949
953
|
|
@@ -1190,7 +1194,7 @@ Name | Type | Description | Notes
|
|
1190
1194
|
#### Option Stats Realtime
|
1191
1195
|
|
1192
1196
|
|
1193
|
-
Returns all option stats (greeks and implied volatility)
|
1197
|
+
Returns all option stats (greeks and implied volatility) as well as the underlying factors used to calculate them, for a particular option contract.
|
1194
1198
|
|
1195
1199
|
[//]: # (END_OVERVIEW)
|
1196
1200
|
|
@@ -1272,7 +1276,7 @@ Name | Type | Description | Notes
|
|
1272
1276
|
#### Options Unusual Activity
|
1273
1277
|
|
1274
1278
|
|
1275
|
-
Returns unusual
|
1279
|
+
Returns unusual options activity for a particular company across all option chains. Unusual options activity includes large trades, sweeps, and block trades.
|
1276
1280
|
|
1277
1281
|
[//]: # (END_OVERVIEW)
|
1278
1282
|
|
@@ -1325,6 +1329,102 @@ Name | Type | Description | Notes
|
|
1325
1329
|
[//]: # (END_OPERATION)
|
1326
1330
|
|
1327
1331
|
|
1332
|
+
[//]: # (START_OPERATION)
|
1333
|
+
|
1334
|
+
[//]: # (CLASS:Intrinio::OptionsApi)
|
1335
|
+
|
1336
|
+
[//]: # (METHOD:get_unusual_activity_intraday)
|
1337
|
+
|
1338
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseOptionsUnusualActivity)
|
1339
|
+
|
1340
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
1341
|
+
|
1342
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseOptionsUnusualActivity.md)
|
1343
|
+
|
1344
|
+
[//]: # (OPERATION:get_unusual_activity_intraday_v2)
|
1345
|
+
|
1346
|
+
[//]: # (ENDPOINT:/options/unusual_activity/{symbol}/intraday)
|
1347
|
+
|
1348
|
+
[//]: # (DOCUMENT_LINK:OptionsApi.md#get_unusual_activity_intraday)
|
1349
|
+
|
1350
|
+
## **get_unusual_activity_intraday**
|
1351
|
+
|
1352
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_unusual_activity_intraday_v2)
|
1353
|
+
|
1354
|
+
[//]: # (START_OVERVIEW)
|
1355
|
+
|
1356
|
+
> ApiResponseOptionsUnusualActivity get_unusual_activity_intraday(symbol, opts)
|
1357
|
+
|
1358
|
+
#### Options Unusual Activity Intraday
|
1359
|
+
|
1360
|
+
|
1361
|
+
Returns unusual trades for a given identifier within the query parameters.
|
1362
|
+
|
1363
|
+
[//]: # (END_OVERVIEW)
|
1364
|
+
|
1365
|
+
### Example
|
1366
|
+
|
1367
|
+
[//]: # (START_CODE_EXAMPLE)
|
1368
|
+
|
1369
|
+
```ruby
|
1370
|
+
# Load the gem
|
1371
|
+
require 'intrinio-sdk'
|
1372
|
+
require 'pp'
|
1373
|
+
|
1374
|
+
# Setup authorization
|
1375
|
+
Intrinio.configure do |config|
|
1376
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
1377
|
+
config.allow_retries = true
|
1378
|
+
end
|
1379
|
+
|
1380
|
+
options_api = Intrinio::OptionsApi.new
|
1381
|
+
symbol = "AAPL"
|
1382
|
+
|
1383
|
+
opts = {
|
1384
|
+
next_page: nil,
|
1385
|
+
page_size: 1000,
|
1386
|
+
activity_type: nil,
|
1387
|
+
sentiment: nil,
|
1388
|
+
start_date: Date.parse("2022-02-01"),
|
1389
|
+
end_date: Date.parse("2022-02-03"),
|
1390
|
+
minimum_total_value: 100000.0,
|
1391
|
+
maximum_total_value: 200000.0
|
1392
|
+
}
|
1393
|
+
|
1394
|
+
result = options_api.get_unusual_activity_intraday(symbol, opts)
|
1395
|
+
pp result
|
1396
|
+
```
|
1397
|
+
|
1398
|
+
[//]: # (END_CODE_EXAMPLE)
|
1399
|
+
|
1400
|
+
[//]: # (START_DEFINITION)
|
1401
|
+
|
1402
|
+
### Parameters
|
1403
|
+
|
1404
|
+
[//]: # (START_PARAMETERS)
|
1405
|
+
|
1406
|
+
|
1407
|
+
Name | Type | Description | Notes
|
1408
|
+
------------- | ------------- | ------------- | -------------
|
1409
|
+
**symbol** | String| The option symbol, corresponding to the underlying security. |
|
1410
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
1411
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 1000]
|
1412
|
+
**activity_type** | String| The unusual activity type to query for. | [optional]
|
1413
|
+
**sentiment** | String| The sentiment type to query for. | [optional]
|
1414
|
+
**start_date** | Date| Return unusual activity on or after this date. | [optional]
|
1415
|
+
**end_date** | Date| Return unusual activity on or before this date. | [optional]
|
1416
|
+
**minimum_total_value** | [**Object**](.md)| The inclusive minimum total value for the unusual activity. | [optional]
|
1417
|
+
**maximum_total_value** | [**Object**](.md)| The inclusive maximum total value for the unusual activity. | [optional]
|
1418
|
+
|
1419
|
+
[//]: # (END_PARAMETERS)
|
1420
|
+
|
1421
|
+
### Return type
|
1422
|
+
|
1423
|
+
[**ApiResponseOptionsUnusualActivity**](ApiResponseOptionsUnusualActivity.md)
|
1424
|
+
|
1425
|
+
[//]: # (END_OPERATION)
|
1426
|
+
|
1427
|
+
|
1328
1428
|
[//]: # (START_OPERATION)
|
1329
1429
|
|
1330
1430
|
[//]: # (CLASS:Intrinio::OptionsApi)
|
@@ -1354,7 +1454,7 @@ Name | Type | Description | Notes
|
|
1354
1454
|
#### Options Unusual Activity Universal
|
1355
1455
|
|
1356
1456
|
|
1357
|
-
Returns
|
1457
|
+
Returns the latest unusual options activity across all US companies with across all option chains. Unusual options activity includes large trades, sweeps, and block trades.
|
1358
1458
|
|
1359
1459
|
[//]: # (END_OVERVIEW)
|
1360
1460
|
|
@@ -1404,3 +1504,97 @@ Name | Type | Description | Notes
|
|
1404
1504
|
|
1405
1505
|
[//]: # (END_OPERATION)
|
1406
1506
|
|
1507
|
+
|
1508
|
+
[//]: # (START_OPERATION)
|
1509
|
+
|
1510
|
+
[//]: # (CLASS:Intrinio::OptionsApi)
|
1511
|
+
|
1512
|
+
[//]: # (METHOD:get_unusual_activity_universal_intraday)
|
1513
|
+
|
1514
|
+
[//]: # (RETURN_TYPE:Intrinio::ApiResponseOptionsUnusualActivity)
|
1515
|
+
|
1516
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
1517
|
+
|
1518
|
+
[//]: # (RETURN_TYPE_DOC:ApiResponseOptionsUnusualActivity.md)
|
1519
|
+
|
1520
|
+
[//]: # (OPERATION:get_unusual_activity_universal_intraday_v2)
|
1521
|
+
|
1522
|
+
[//]: # (ENDPOINT:/options/unusual_activity/intraday)
|
1523
|
+
|
1524
|
+
[//]: # (DOCUMENT_LINK:OptionsApi.md#get_unusual_activity_universal_intraday)
|
1525
|
+
|
1526
|
+
## **get_unusual_activity_universal_intraday**
|
1527
|
+
|
1528
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_unusual_activity_universal_intraday_v2)
|
1529
|
+
|
1530
|
+
[//]: # (START_OVERVIEW)
|
1531
|
+
|
1532
|
+
> ApiResponseOptionsUnusualActivity get_unusual_activity_universal_intraday(opts)
|
1533
|
+
|
1534
|
+
#### Options Unusual Activity Universal Intraday
|
1535
|
+
|
1536
|
+
|
1537
|
+
Returns unusual trades for all underlying security symbols within the query parameters.
|
1538
|
+
|
1539
|
+
[//]: # (END_OVERVIEW)
|
1540
|
+
|
1541
|
+
### Example
|
1542
|
+
|
1543
|
+
[//]: # (START_CODE_EXAMPLE)
|
1544
|
+
|
1545
|
+
```ruby
|
1546
|
+
# Load the gem
|
1547
|
+
require 'intrinio-sdk'
|
1548
|
+
require 'pp'
|
1549
|
+
|
1550
|
+
# Setup authorization
|
1551
|
+
Intrinio.configure do |config|
|
1552
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
1553
|
+
config.allow_retries = true
|
1554
|
+
end
|
1555
|
+
|
1556
|
+
options_api = Intrinio::OptionsApi.new
|
1557
|
+
|
1558
|
+
opts = {
|
1559
|
+
next_page: nil,
|
1560
|
+
page_size: 1000,
|
1561
|
+
activity_type: nil,
|
1562
|
+
sentiment: nil,
|
1563
|
+
start_date: Date.parse("2022-02-01"),
|
1564
|
+
end_date: Date.parse("2022-02-03"),
|
1565
|
+
minimum_total_value: 100000.0,
|
1566
|
+
maximum_total_value: 200000.0
|
1567
|
+
}
|
1568
|
+
|
1569
|
+
result = options_api.get_unusual_activity_universal_intraday(opts)
|
1570
|
+
pp result
|
1571
|
+
```
|
1572
|
+
|
1573
|
+
[//]: # (END_CODE_EXAMPLE)
|
1574
|
+
|
1575
|
+
[//]: # (START_DEFINITION)
|
1576
|
+
|
1577
|
+
### Parameters
|
1578
|
+
|
1579
|
+
[//]: # (START_PARAMETERS)
|
1580
|
+
|
1581
|
+
|
1582
|
+
Name | Type | Description | Notes
|
1583
|
+
------------- | ------------- | ------------- | -------------
|
1584
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
1585
|
+
**page_size** | Integer| The number of results to return | [optional] [default to 1000]
|
1586
|
+
**activity_type** | String| The unusual activity type to query for. | [optional]
|
1587
|
+
**sentiment** | String| The sentiment type to query for. | [optional]
|
1588
|
+
**start_date** | Date| Return unusual activity on or after this date. | [optional]
|
1589
|
+
**end_date** | Date| Return unusual activity on or before this date. | [optional]
|
1590
|
+
**minimum_total_value** | [**Object**](.md)| The inclusive minimum total value for the unusual activity. | [optional]
|
1591
|
+
**maximum_total_value** | [**Object**](.md)| The inclusive maximum total value for the unusual activity. | [optional]
|
1592
|
+
|
1593
|
+
[//]: # (END_PARAMETERS)
|
1594
|
+
|
1595
|
+
### Return type
|
1596
|
+
|
1597
|
+
[**ApiResponseOptionsUnusualActivity**](ApiResponseOptionsUnusualActivity.md)
|
1598
|
+
|
1599
|
+
[//]: # (END_OPERATION)
|
1600
|
+
|
data/docs/OwnersApi.md
CHANGED
@@ -314,7 +314,7 @@ identifier = 430692
|
|
314
314
|
|
315
315
|
opts = {
|
316
316
|
page_size: 100,
|
317
|
-
as_of_date: "2021-01-05",
|
317
|
+
as_of_date: Date.parse("2021-01-05"),
|
318
318
|
next_page: nil
|
319
319
|
}
|
320
320
|
|
@@ -335,7 +335,7 @@ Name | Type | Description | Notes
|
|
335
335
|
------------- | ------------- | ------------- | -------------
|
336
336
|
**identifier** | String| The Central Index Key issued by the SEC, which is the unique identifier all owner filings are issued under. |
|
337
337
|
**page_size** | Integer| The number of results to return | [optional] [default to 100]
|
338
|
-
**as_of_date** |
|
338
|
+
**as_of_date** | Date| Return only holdings filed before this date. | [optional]
|
339
339
|
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
340
340
|
|
341
341
|
[//]: # (END_PARAMETERS)
|
data/docs/SecurityApi.md
CHANGED
@@ -86,7 +86,7 @@ Method | HTTP request | Description
|
|
86
86
|
#### All Securities
|
87
87
|
|
88
88
|
|
89
|
-
Returns
|
89
|
+
Returns a list of all securities available. Delisted securities included.
|
90
90
|
|
91
91
|
[//]: # (END_OVERVIEW)
|
92
92
|
|
@@ -202,7 +202,7 @@ Name | Type | Description | Notes
|
|
202
202
|
#### Lookup Security
|
203
203
|
|
204
204
|
|
205
|
-
Returns
|
205
|
+
Returns security reference data such as ticker, FIGI, primary exchange, CIK, and a unique security identifier.
|
206
206
|
|
207
207
|
[//]: # (END_OVERVIEW)
|
208
208
|
|
@@ -956,7 +956,7 @@ Name | Type | Description | Notes
|
|
956
956
|
#### Accumulation/Distribution Index
|
957
957
|
|
958
958
|
|
959
|
-
|
959
|
+
The Accumulation / Distribution Indicator is a volume-based technical indicator which uses the relationship between the stock`s price and volume flow to determine the underlying trend of a stock, up, down, or sideways trend of a stock.
|
960
960
|
|
961
961
|
[//]: # (END_OVERVIEW)
|
962
962
|
|
@@ -1044,7 +1044,7 @@ Name | Type | Description | Notes
|
|
1044
1044
|
#### Average Daily Trading Volume
|
1045
1045
|
|
1046
1046
|
|
1047
|
-
|
1047
|
+
Average Daily Trading Volume is the average number of shares traded over a given period, usually between 20 to 30 trading days.
|
1048
1048
|
|
1049
1049
|
[//]: # (END_OVERVIEW)
|
1050
1050
|
|
@@ -1134,7 +1134,7 @@ Name | Type | Description | Notes
|
|
1134
1134
|
#### Average Directional Index
|
1135
1135
|
|
1136
1136
|
|
1137
|
-
|
1137
|
+
The Average Directional Index indicator is often used to identify decreasing or increasing price momentum for an underlying security, it is composed of a total of three indicators, the current trendline (adx), a positive directional indicator (di_pos), and a negative directional indicator (di_neg).
|
1138
1138
|
|
1139
1139
|
[//]: # (END_OVERVIEW)
|
1140
1140
|
|
@@ -1224,7 +1224,7 @@ Name | Type | Description | Notes
|
|
1224
1224
|
#### Awesome Oscillator
|
1225
1225
|
|
1226
1226
|
|
1227
|
-
|
1227
|
+
The Awesome Oscillator (ao) is a momentum indicator and is calculated by taking the difference between the latest 5 period simple moving average and the 34 period simple moving average. Rather than using the closing price like other indicators, the Awesome Oscillator uses the latest period`s midpoint value (period_high - period_low / 2). The Awesome Oscillator is useful in identifying and trading, zero-line crossovers, twin-peaks trading, and bullish/bearish saucers - Awesome Oscillator is often aggregated with additional technical indicators.
|
1228
1228
|
|
1229
1229
|
[//]: # (END_OVERVIEW)
|
1230
1230
|
|
@@ -1316,7 +1316,7 @@ Name | Type | Description | Notes
|
|
1316
1316
|
#### Average True Range
|
1317
1317
|
|
1318
1318
|
|
1319
|
-
|
1319
|
+
The Average True Range (ATR) is a non-directional market volatility indicator often used to generate stop-out or entry indications. An increasing or expanding ATR typically indicates higher volatility, and a decreasing ATR indicates sideways price action and lower volatility.
|
1320
1320
|
|
1321
1321
|
[//]: # (END_OVERVIEW)
|
1322
1322
|
|
@@ -1406,7 +1406,7 @@ Name | Type | Description | Notes
|
|
1406
1406
|
#### Bollinger Bands
|
1407
1407
|
|
1408
1408
|
|
1409
|
-
|
1409
|
+
Bollinger Bands can be a useful technical analysis tool for generating oversold or overbought indicators. Bollinger Bands are composed of three lines, a simple moving average (middle band) and an upper and lower band – the upper and lower bands are typically 2 standard deviations +/- from a 20-day simple moving average, but can be modified. Traders typically consider an underlying security to be overbought as the underlying`s price moves towards the upper band and oversold as the underlying price moves towards the lower band.
|
1410
1410
|
|
1411
1411
|
[//]: # (END_OVERVIEW)
|
1412
1412
|
|
@@ -1500,7 +1500,7 @@ Name | Type | Description | Notes
|
|
1500
1500
|
#### Commodity Channel Index
|
1501
1501
|
|
1502
1502
|
|
1503
|
-
|
1503
|
+
The Commodity Channel Index (CCI) is a technical indicator used to generate buy and sell signals by indicating periods of strength and weakness in the market. CCI signals that fall below -100 are often perceived as weakness in the underlying price movement and CCI signals that rise above 100 indicate strength behind the underlying price movement.
|
1504
1504
|
|
1505
1505
|
[//]: # (END_OVERVIEW)
|
1506
1506
|
|
@@ -1592,7 +1592,7 @@ Name | Type | Description | Notes
|
|
1592
1592
|
#### Chaikin Money Flow
|
1593
1593
|
|
1594
1594
|
|
1595
|
-
|
1595
|
+
The Chaikin Money Flow (CMF) utilizes exponential moving averages as an indicator to monitor the flow of money and momentum. The CMF indicator oscillates around a midrange 0-line and ranges between 100 and -100.
|
1596
1596
|
|
1597
1597
|
[//]: # (END_OVERVIEW)
|
1598
1598
|
|
@@ -1682,7 +1682,7 @@ Name | Type | Description | Notes
|
|
1682
1682
|
#### Donchian Channel
|
1683
1683
|
|
1684
1684
|
|
1685
|
-
|
1685
|
+
The Donchian Channel consists of an Upper Bound (upper_bound) and Lower Bound (lower_bound) that track the recent highs and lows and is often used to signal entry and exit points for a position. As the price of the underlying symbol increases the Upper Bound raises, if the price becomes range bound the Upper Bound will remain flat and if the price begins to decrease, the Upper Bound will fall (and vice-versa for the Lower Bound).
|
1686
1686
|
|
1687
1687
|
[//]: # (END_OVERVIEW)
|
1688
1688
|
|
@@ -1774,7 +1774,7 @@ Name | Type | Description | Notes
|
|
1774
1774
|
#### Detrended Price Oscillator
|
1775
1775
|
|
1776
1776
|
|
1777
|
-
|
1777
|
+
The Detrended Price Oscillator (DPO) signals the peaks and troughs of the underlying symbol’s price for a set period of time and is often used by traders to estimate future peaks and troughs using this as guidance to enter or exit a position.
|
1778
1778
|
|
1779
1779
|
[//]: # (END_OVERVIEW)
|
1780
1780
|
|
@@ -1866,7 +1866,7 @@ Name | Type | Description | Notes
|
|
1866
1866
|
#### Ease of Movement
|
1867
1867
|
|
1868
1868
|
|
1869
|
-
|
1869
|
+
The Ease of Movement (EOM) is a volume based oscillator that fluctuates around a midrange 0-line into positive and negative values. Positive values indicate that the underlying symbol`s price is rising with relative ease and negative value indicates the underlying symbol`s price is failing with relative ease.
|
1870
1870
|
|
1871
1871
|
[//]: # (END_OVERVIEW)
|
1872
1872
|
|
@@ -1956,7 +1956,7 @@ Name | Type | Description | Notes
|
|
1956
1956
|
#### Force Index
|
1957
1957
|
|
1958
1958
|
|
1959
|
-
|
1959
|
+
The Force Index (FI) is an oscillator that takes into account the intensity of an underlying symbol`s price movement and its corresponding volume. It is used to confirm price breakouts and signal underlying trends.
|
1960
1960
|
|
1961
1961
|
[//]: # (END_OVERVIEW)
|
1962
1962
|
|
@@ -2044,7 +2044,7 @@ Name | Type | Description | Notes
|
|
2044
2044
|
#### Ichimoku Kinko Hyo
|
2045
2045
|
|
2046
2046
|
|
2047
|
-
|
2047
|
+
The Ichimoku Kinko Hyo was designed to be an all-in-one trading indicator that could help traders determine momentum, support, and resistance.
|
2048
2048
|
|
2049
2049
|
[//]: # (END_OVERVIEW)
|
2050
2050
|
|
@@ -2138,7 +2138,7 @@ Name | Type | Description | Notes
|
|
2138
2138
|
#### Keltner Channel
|
2139
2139
|
|
2140
2140
|
|
2141
|
-
|
2141
|
+
The Keltner Channel is a volatility based signal, with upper, middle, and lower bands. It is often used at market open, when the largest moves tend to occur. In general, traders tend to buy if the price breaks up above the upper band or sell short if the price drops below the lower band.
|
2142
2142
|
|
2143
2143
|
[//]: # (END_OVERVIEW)
|
2144
2144
|
|
@@ -2228,7 +2228,7 @@ Name | Type | Description | Notes
|
|
2228
2228
|
#### Know Sure Thing
|
2229
2229
|
|
2230
2230
|
|
2231
|
-
|
2231
|
+
The Know Sure Thing indicator (KST) is a momentum based oscillator that is calculated by measuring the momentum of four separate price cycles. KST fluctuates above and below a zero line and is used to identify overbought and oversold conditions, and is often used with additional indicators to boost signal strength.
|
2232
2232
|
|
2233
2233
|
[//]: # (END_OVERVIEW)
|
2234
2234
|
|
@@ -2334,7 +2334,7 @@ Name | Type | Description | Notes
|
|
2334
2334
|
#### Moving Average Convergence Divergence
|
2335
2335
|
|
2336
2336
|
|
2337
|
-
|
2337
|
+
Moving average convergence divergence (MACD) is a trend-following momentum oscillator that consists of three indicators: (1) a 12 period short-term exponential moving average (EMA) a 26 period long-term EMA and a 9 period EMA signal line. Traders using MACD often look for signal line crossovers, centerline crossovers, and EMA divergences to indicate the momentum and underlying trend of a security`s price.
|
2338
2338
|
|
2339
2339
|
[//]: # (END_OVERVIEW)
|
2340
2340
|
|
@@ -2430,7 +2430,7 @@ Name | Type | Description | Notes
|
|
2430
2430
|
#### Money Flow Index
|
2431
2431
|
|
2432
2432
|
|
2433
|
-
|
2433
|
+
The Money Flow Index (MFI) is a technical oscillator that incorporates both price and volume, moving between 0 and 100. Traders often consider a MFI above 80 as overbought conditions and below 20 as oversold conditions.
|
2434
2434
|
|
2435
2435
|
[//]: # (END_OVERVIEW)
|
2436
2436
|
|
@@ -2520,7 +2520,7 @@ Name | Type | Description | Notes
|
|
2520
2520
|
#### Mass Index
|
2521
2521
|
|
2522
2522
|
|
2523
|
-
|
2523
|
+
The mass index (MI) is a technical indicator used by traders to predict trend reversals. A trend reversal signal is said to occur when the 25-day MI reaches 27.0 and then falls below 26.0.
|
2524
2524
|
|
2525
2525
|
[//]: # (END_OVERVIEW)
|
2526
2526
|
|
@@ -2612,7 +2612,7 @@ Name | Type | Description | Notes
|
|
2612
2612
|
#### Negative Volume Index
|
2613
2613
|
|
2614
2614
|
|
2615
|
-
|
2615
|
+
The negative volume index (NVI) is often referred to as the `smart money indicator.` It works by the assumption that smart money (institutional money) is at work when volume decreases and vice versa when volume increases. NVI starts at 1000 and increases in regard to the percentage price change when volume decreases over a 255-day EMA period. Traders often use this technical indicator when researching broder markets and indices.
|
2616
2616
|
|
2617
2617
|
[//]: # (END_OVERVIEW)
|
2618
2618
|
|
@@ -2700,7 +2700,7 @@ Name | Type | Description | Notes
|
|
2700
2700
|
#### On-balance Volume
|
2701
2701
|
|
2702
2702
|
|
2703
|
-
|
2703
|
+
On-balance volume (OBV) is a leading momentum indicator that uses the increase/decrease flow in volume to predict upcoming stock price changes. When both OBV and a security`s price are making higher highs, it is presumed the upward trend is likely to continue and vice versa.
|
2704
2704
|
|
2705
2705
|
[//]: # (END_OVERVIEW)
|
2706
2706
|
|
@@ -2788,7 +2788,7 @@ Name | Type | Description | Notes
|
|
2788
2788
|
#### On-balance Volume Mean
|
2789
2789
|
|
2790
2790
|
|
2791
|
-
|
2791
|
+
On-balance volume mean (OBVM) is a leading momentum indicator that uses the increase/decrease flow in volume to predict upcoming stock price changes. The difference between OBV and OBVM is that OBVM takes the mean average of a provided period. When both OBVM and a security`s price are making higher highs, it is presumed the upward trend is likely to continue and vice versa.
|
2792
2792
|
|
2793
2793
|
[//]: # (END_OVERVIEW)
|
2794
2794
|
|
@@ -2878,7 +2878,7 @@ Name | Type | Description | Notes
|
|
2878
2878
|
#### Relative Strength Index
|
2879
2879
|
|
2880
2880
|
|
2881
|
-
|
2881
|
+
Relative strength index (RSI) is a momentum oscillator that ranges between 0 and 100. Traders believe that an RSI value over 70 indicates that a security is overbought and an RSI under 30 indicates that a security is oversold.
|
2882
2882
|
|
2883
2883
|
[//]: # (END_OVERVIEW)
|
2884
2884
|
|
@@ -2970,7 +2970,7 @@ Name | Type | Description | Notes
|
|
2970
2970
|
#### Simple Moving Average
|
2971
2971
|
|
2972
2972
|
|
2973
|
-
|
2973
|
+
A simple moving average (SMA) adds recent prices for a specified period and divides the total by that same number of periods. SMA is typically used to indicate whether a security is in an uptrend or downtrend and can also be combined with a long-term moving average to improve the signal`s abilities.
|
2974
2974
|
|
2975
2975
|
[//]: # (END_OVERVIEW)
|
2976
2976
|
|
@@ -3062,7 +3062,7 @@ Name | Type | Description | Notes
|
|
3062
3062
|
#### Stochastic Oscillator
|
3063
3063
|
|
3064
3064
|
|
3065
|
-
|
3065
|
+
The Stochastic Oscillator (SO) is a range-bound momentum indicator that ranges from 0 to 100 and follows the velocity of the momentum itself, not the underlying price or volume. When SO is above 80 it indicates that a security is trading at the high end of its period`s high-low range and vice versa if the reading is below 20.
|
3066
3066
|
|
3067
3067
|
[//]: # (END_OVERVIEW)
|
3068
3068
|
|
@@ -3154,7 +3154,7 @@ Name | Type | Description | Notes
|
|
3154
3154
|
#### Triple Exponential Average
|
3155
3155
|
|
3156
3156
|
|
3157
|
-
|
3157
|
+
The Triple Exponential Average (TEA) is a momentum indicator used to identify when a security is oversold and overbought. By exponentially smoothing out the underlying security`s moving average, the TEA filters out insignificant price movements. A positive TEA is often believed to indicate momentum is increasing and a negative TEA indicates that momentum is decreasing.
|
3158
3158
|
|
3159
3159
|
[//]: # (END_OVERVIEW)
|
3160
3160
|
|
@@ -3244,7 +3244,7 @@ Name | Type | Description | Notes
|
|
3244
3244
|
#### True Strength Index
|
3245
3245
|
|
3246
3246
|
|
3247
|
-
|
3247
|
+
The True Strength Index (TSI) is a momentum oscillator used to identify building trends and trend reversals, typically by signalling overbought and oversold conditions. TSI fluctuates between positive and negative values, and traders typically combine its signal with other momentum oscillators to increase its strength. When TSI crosses the signal line into positive territory it is presumed to be an entrance opportunity and vice versa when the TSI crosses into negative territory.
|
3248
3248
|
|
3249
3249
|
[//]: # (END_OVERVIEW)
|
3250
3250
|
|
@@ -3338,7 +3338,7 @@ Name | Type | Description | Notes
|
|
3338
3338
|
#### Ultimate Oscillator
|
3339
3339
|
|
3340
3340
|
|
3341
|
-
|
3341
|
+
The Ultimate Oscillator (UO) is a range bound technical indicator that moves between 0 and 100 and is calculated with 3 timeframes, typically 7, 14, and 28 day periods. When UO`s value is above 70 a security is categorized as overbought and when UO`s value is below 30 a security is categorized as oversold.
|
3342
3342
|
|
3343
3343
|
[//]: # (END_OVERVIEW)
|
3344
3344
|
|
@@ -3438,7 +3438,7 @@ Name | Type | Description | Notes
|
|
3438
3438
|
#### Vortex Indicator
|
3439
3439
|
|
3440
3440
|
|
3441
|
-
|
3441
|
+
The Vortex Indicator (VI) is composed of an uptrend line (VI+) and a downtrend line (VI-). When VI+ crosses VI- from below it typically indicates an entry into a given security. When VI- crosses VI+ from below it typically triggers an exit and that the current trend is reversing course.
|
3442
3442
|
|
3443
3443
|
[//]: # (END_OVERVIEW)
|
3444
3444
|
|
@@ -3528,7 +3528,7 @@ Name | Type | Description | Notes
|
|
3528
3528
|
#### Volume-price Trend
|
3529
3529
|
|
3530
3530
|
|
3531
|
-
|
3531
|
+
The volume price trend (VPT) is a technical indicator that uses price & volume to determine whether a trend is established. Typically, when a security is trending upwards, there is more volume on positive days than negative ones, and as a result VPT should be increasing on these days as well. However, if VPT fails to increase past its previous high during an outbreak, this is suggested to indicate the rally is losing strength.
|
3532
3532
|
|
3533
3533
|
[//]: # (END_OVERVIEW)
|
3534
3534
|
|
@@ -3616,7 +3616,7 @@ Name | Type | Description | Notes
|
|
3616
3616
|
#### Volume Weighted Average Price
|
3617
3617
|
|
3618
3618
|
|
3619
|
-
|
3619
|
+
Volume Weighted Average Price (VWAP) is a lagging technical indicator that is used in combination with a security`s price. When the underlying price rises above its VWAP, it is often interpreted as a bullish signal, and vice versa in the opposite direction.
|
3620
3620
|
|
3621
3621
|
[//]: # (END_OVERVIEW)
|
3622
3622
|
|
@@ -3704,7 +3704,7 @@ Name | Type | Description | Notes
|
|
3704
3704
|
#### Williams %R
|
3705
3705
|
|
3706
3706
|
|
3707
|
-
|
3707
|
+
Williams %R is a momentum indicator used to determine overbought and oversold environments for a security and fluctuates between 0 and -100. When Williams %R is above -20 the security is considered to be overbought and when Williams %R is under -80 the security is considered to be oversold.
|
3708
3708
|
|
3709
3709
|
[//]: # (END_OVERVIEW)
|
3710
3710
|
|
@@ -4519,7 +4519,7 @@ Name | Type | Description | Notes
|
|
4519
4519
|
#### Search Securities
|
4520
4520
|
|
4521
4521
|
|
4522
|
-
|
4522
|
+
Search the securities database and return a list of securities matching the text query parameter passed through. Query parameter searches across the security ticker and name.
|
4523
4523
|
|
4524
4524
|
[//]: # (END_OVERVIEW)
|
4525
4525
|
|