intrinio-sdk 5.20.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 +12 -2
- data/docs/ApiResponseESGCompanies.md +24 -0
- data/docs/ApiResponseESGCompanyRatingHistory.md +28 -0
- data/docs/ApiResponseESGLatest.md +24 -0
- data/docs/CompanyApi.md +11 -11
- 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/ETFsApi.md +6 -6
- data/docs/FilingApi.md +10 -8
- data/docs/FundamentalsApi.md +103 -4
- data/docs/IndexApi.md +5 -3
- data/docs/OptionStatsRealtime.md +1 -0
- data/docs/OptionsApi.md +15 -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 +23 -23
- 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 +1 -1
- data/lib/intrinio-sdk/api/municipality_api.rb +1 -1
- data/lib/intrinio-sdk/api/options_api.rb +28 -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 +1 -1
- 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 +1 -1
- 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 +12 -12
- 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 +1 -1
- data/spec/api/municipality_api_spec.rb +1 -1
- data/spec/api/options_api_spec.rb +14 -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 +1 -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 +1 -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 +31 -2
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://docs.intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
|
5
5
|
|
6
|
-
OpenAPI spec version: 2.
|
6
|
+
OpenAPI spec version: 2.28.0
|
7
7
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
9
|
Swagger Codegen version: unset
|
@@ -34,7 +34,7 @@ describe 'SecurityApi' do
|
|
34
34
|
|
35
35
|
# unit tests for get_all_securities
|
36
36
|
# All Securities
|
37
|
-
# Returns
|
37
|
+
# Returns a list of all securities available. Delisted securities included.
|
38
38
|
# @param [Hash] opts the optional parameters
|
39
39
|
# @option opts [BOOLEAN] :active When true, return securities that are active. When false, return securities that are not active. A security is considered active if it has traded or has had a corporate action in the past 30 days, and has not been merged into another security (such as due to ticker changes or corporate restructurings).
|
40
40
|
# @option opts [BOOLEAN] :delisted When true, return securities that have been delisted from their exchange. Note that there may be a newer security for the same company that has been relisted on a differente exchange. When false, return securities that have not been delisted.
|
@@ -64,7 +64,7 @@ describe 'SecurityApi' do
|
|
64
64
|
|
65
65
|
# unit tests for get_security_by_id
|
66
66
|
# Lookup Security
|
67
|
-
# Returns
|
67
|
+
# Returns security reference data such as ticker, FIGI, primary exchange, CIK, and a unique security identifier.
|
68
68
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
69
69
|
# @param [Hash] opts the optional parameters
|
70
70
|
# @return [Security]
|
@@ -198,7 +198,7 @@ describe 'SecurityApi' do
|
|
198
198
|
|
199
199
|
# unit tests for get_security_price_technicals_adi
|
200
200
|
# Accumulation/Distribution Index
|
201
|
-
#
|
201
|
+
# 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.
|
202
202
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
203
203
|
# @param [Hash] opts the optional parameters
|
204
204
|
# @option opts [String] :start_date Return technical indicator values on or after the date
|
@@ -214,7 +214,7 @@ describe 'SecurityApi' do
|
|
214
214
|
|
215
215
|
# unit tests for get_security_price_technicals_adtv
|
216
216
|
# Average Daily Trading Volume
|
217
|
-
#
|
217
|
+
# Average Daily Trading Volume is the average number of shares traded over a given period, usually between 20 to 30 trading days.
|
218
218
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
219
219
|
# @param [Hash] opts the optional parameters
|
220
220
|
# @option opts [Integer] :period The number of observations, per period, to calculate Average Daily Trading Volume
|
@@ -231,7 +231,7 @@ describe 'SecurityApi' do
|
|
231
231
|
|
232
232
|
# unit tests for get_security_price_technicals_adx
|
233
233
|
# Average Directional Index
|
234
|
-
#
|
234
|
+
# 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).
|
235
235
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
236
236
|
# @param [Hash] opts the optional parameters
|
237
237
|
# @option opts [Integer] :period The number of observations, per period, to calculate Average Directional Index
|
@@ -248,7 +248,7 @@ describe 'SecurityApi' do
|
|
248
248
|
|
249
249
|
# unit tests for get_security_price_technicals_ao
|
250
250
|
# Awesome Oscillator
|
251
|
-
#
|
251
|
+
# 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.
|
252
252
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
253
253
|
# @param [Hash] opts the optional parameters
|
254
254
|
# @option opts [Integer] :short_period The number of observations, per period, to calculate short period Simple Moving Average of the Awesome Oscillator
|
@@ -266,7 +266,7 @@ describe 'SecurityApi' do
|
|
266
266
|
|
267
267
|
# unit tests for get_security_price_technicals_atr
|
268
268
|
# Average True Range
|
269
|
-
#
|
269
|
+
# 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.
|
270
270
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
271
271
|
# @param [Hash] opts the optional parameters
|
272
272
|
# @option opts [Integer] :period The number of observations, per period, to calculate Average True Range
|
@@ -283,7 +283,7 @@ describe 'SecurityApi' do
|
|
283
283
|
|
284
284
|
# unit tests for get_security_price_technicals_bb
|
285
285
|
# Bollinger Bands
|
286
|
-
#
|
286
|
+
# 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.
|
287
287
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
288
288
|
# @param [Hash] opts the optional parameters
|
289
289
|
# @option opts [Integer] :period The number of observations, per period, to calculate Bollinger Bands
|
@@ -302,7 +302,7 @@ describe 'SecurityApi' do
|
|
302
302
|
|
303
303
|
# unit tests for get_security_price_technicals_cci
|
304
304
|
# Commodity Channel Index
|
305
|
-
#
|
305
|
+
# 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.
|
306
306
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
307
307
|
# @param [Hash] opts the optional parameters
|
308
308
|
# @option opts [Integer] :period The number of observations, per period, to calculate Commodity Channel Index
|
@@ -320,7 +320,7 @@ describe 'SecurityApi' do
|
|
320
320
|
|
321
321
|
# unit tests for get_security_price_technicals_cmf
|
322
322
|
# Chaikin Money Flow
|
323
|
-
#
|
323
|
+
# 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.
|
324
324
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
325
325
|
# @param [Hash] opts the optional parameters
|
326
326
|
# @option opts [Integer] :period The number of observations, per period, to calculate Chaikin Money Flow
|
@@ -337,7 +337,7 @@ describe 'SecurityApi' do
|
|
337
337
|
|
338
338
|
# unit tests for get_security_price_technicals_dc
|
339
339
|
# Donchian Channel
|
340
|
-
#
|
340
|
+
# 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).
|
341
341
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
342
342
|
# @param [Hash] opts the optional parameters
|
343
343
|
# @option opts [Integer] :period The number of observations, per period, to calculate Donchian Channel
|
@@ -355,7 +355,7 @@ describe 'SecurityApi' do
|
|
355
355
|
|
356
356
|
# unit tests for get_security_price_technicals_dpo
|
357
357
|
# Detrended Price Oscillator
|
358
|
-
#
|
358
|
+
# 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.
|
359
359
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
360
360
|
# @param [Hash] opts the optional parameters
|
361
361
|
# @option opts [Integer] :period The number of observations, per period, to calculate Detrended Price Oscillator
|
@@ -373,7 +373,7 @@ describe 'SecurityApi' do
|
|
373
373
|
|
374
374
|
# unit tests for get_security_price_technicals_eom
|
375
375
|
# Ease of Movement
|
376
|
-
#
|
376
|
+
# 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.
|
377
377
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
378
378
|
# @param [Hash] opts the optional parameters
|
379
379
|
# @option opts [Integer] :period The number of observations, per period, to calculate Ease of Movement
|
@@ -390,7 +390,7 @@ describe 'SecurityApi' do
|
|
390
390
|
|
391
391
|
# unit tests for get_security_price_technicals_fi
|
392
392
|
# Force Index
|
393
|
-
#
|
393
|
+
# 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.
|
394
394
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
395
395
|
# @param [Hash] opts the optional parameters
|
396
396
|
# @option opts [String] :start_date Return technical indicator values on or after the date
|
@@ -406,7 +406,7 @@ describe 'SecurityApi' do
|
|
406
406
|
|
407
407
|
# unit tests for get_security_price_technicals_ichimoku
|
408
408
|
# Ichimoku Kinko Hyo
|
409
|
-
#
|
409
|
+
# The Ichimoku Kinko Hyo was designed to be an all-in-one trading indicator that could help traders determine momentum, support, and resistance.
|
410
410
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
411
411
|
# @param [Hash] opts the optional parameters
|
412
412
|
# @option opts [Integer] :low_period The number of observations, per period, to calculate Tenkan Sen (Conversion Line) of Ichimoku Kinko Hyo
|
@@ -425,7 +425,7 @@ describe 'SecurityApi' do
|
|
425
425
|
|
426
426
|
# unit tests for get_security_price_technicals_kc
|
427
427
|
# Keltner Channel
|
428
|
-
#
|
428
|
+
# 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.
|
429
429
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
430
430
|
# @param [Hash] opts the optional parameters
|
431
431
|
# @option opts [Integer] :period The number of observations, per period, to calculate Kelter Channel
|
@@ -442,7 +442,7 @@ describe 'SecurityApi' do
|
|
442
442
|
|
443
443
|
# unit tests for get_security_price_technicals_kst
|
444
444
|
# Know Sure Thing
|
445
|
-
#
|
445
|
+
# 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.
|
446
446
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
447
447
|
# @param [Hash] opts the optional parameters
|
448
448
|
# @option opts [Integer] :roc1 The number of observations, per period, to calculate the rate-of-change for RCMA1
|
@@ -467,7 +467,7 @@ describe 'SecurityApi' do
|
|
467
467
|
|
468
468
|
# unit tests for get_security_price_technicals_macd
|
469
469
|
# Moving Average Convergence Divergence
|
470
|
-
#
|
470
|
+
# 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.
|
471
471
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
472
472
|
# @param [Hash] opts the optional parameters
|
473
473
|
# @option opts [Integer] :fast_period The number of observations, per period, to calculate the fast moving Exponential Moving Average for Moving Average Convergence Divergence
|
@@ -487,7 +487,7 @@ describe 'SecurityApi' do
|
|
487
487
|
|
488
488
|
# unit tests for get_security_price_technicals_mfi
|
489
489
|
# Money Flow Index
|
490
|
-
#
|
490
|
+
# 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.
|
491
491
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
492
492
|
# @param [Hash] opts the optional parameters
|
493
493
|
# @option opts [Integer] :period The number of observations, per period, to calculate Money Flow Index
|
@@ -504,7 +504,7 @@ describe 'SecurityApi' do
|
|
504
504
|
|
505
505
|
# unit tests for get_security_price_technicals_mi
|
506
506
|
# Mass Index
|
507
|
-
#
|
507
|
+
# 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.
|
508
508
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
509
509
|
# @param [Hash] opts the optional parameters
|
510
510
|
# @option opts [Integer] :ema_period The number of observations, per period, to calculate the single Exponential Moving Average and the Double Exponential Moving Average for Mass Index
|
@@ -522,7 +522,7 @@ describe 'SecurityApi' do
|
|
522
522
|
|
523
523
|
# unit tests for get_security_price_technicals_nvi
|
524
524
|
# Negative Volume Index
|
525
|
-
#
|
525
|
+
# 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.
|
526
526
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
527
527
|
# @param [Hash] opts the optional parameters
|
528
528
|
# @option opts [String] :start_date Return technical indicator values on or after the date
|
@@ -538,7 +538,7 @@ describe 'SecurityApi' do
|
|
538
538
|
|
539
539
|
# unit tests for get_security_price_technicals_obv
|
540
540
|
# On-balance Volume
|
541
|
-
#
|
541
|
+
# 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.
|
542
542
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
543
543
|
# @param [Hash] opts the optional parameters
|
544
544
|
# @option opts [String] :start_date Return technical indicator values on or after the date
|
@@ -554,7 +554,7 @@ describe 'SecurityApi' do
|
|
554
554
|
|
555
555
|
# unit tests for get_security_price_technicals_obv_mean
|
556
556
|
# On-balance Volume Mean
|
557
|
-
#
|
557
|
+
# 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.
|
558
558
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
559
559
|
# @param [Hash] opts the optional parameters
|
560
560
|
# @option opts [Integer] :period The number of observations, per period, to calculate On-balance Volume Mean
|
@@ -571,7 +571,7 @@ describe 'SecurityApi' do
|
|
571
571
|
|
572
572
|
# unit tests for get_security_price_technicals_rsi
|
573
573
|
# Relative Strength Index
|
574
|
-
#
|
574
|
+
# 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.
|
575
575
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
576
576
|
# @param [Hash] opts the optional parameters
|
577
577
|
# @option opts [Integer] :period The number of observations, per period, to calculate Relative Strength Index
|
@@ -589,7 +589,7 @@ describe 'SecurityApi' do
|
|
589
589
|
|
590
590
|
# unit tests for get_security_price_technicals_sma
|
591
591
|
# Simple Moving Average
|
592
|
-
#
|
592
|
+
# 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.
|
593
593
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
594
594
|
# @param [Hash] opts the optional parameters
|
595
595
|
# @option opts [Integer] :period The number of observations, per period, to calculate Simple Moving Average
|
@@ -607,7 +607,7 @@ describe 'SecurityApi' do
|
|
607
607
|
|
608
608
|
# unit tests for get_security_price_technicals_sr
|
609
609
|
# Stochastic Oscillator
|
610
|
-
#
|
610
|
+
# 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.
|
611
611
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
612
612
|
# @param [Hash] opts the optional parameters
|
613
613
|
# @option opts [Integer] :period The number of observations, per period, to calculate %K of Stochastic Oscillator
|
@@ -625,7 +625,7 @@ describe 'SecurityApi' do
|
|
625
625
|
|
626
626
|
# unit tests for get_security_price_technicals_trix
|
627
627
|
# Triple Exponential Average
|
628
|
-
#
|
628
|
+
# 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.
|
629
629
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
630
630
|
# @param [Hash] opts the optional parameters
|
631
631
|
# @option opts [Integer] :period The number of observations, per period, to calculate Exponential Moving Average for Triple Exponential Average
|
@@ -642,7 +642,7 @@ describe 'SecurityApi' do
|
|
642
642
|
|
643
643
|
# unit tests for get_security_price_technicals_tsi
|
644
644
|
# True Strength Index
|
645
|
-
#
|
645
|
+
# 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.
|
646
646
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
647
647
|
# @param [Hash] opts the optional parameters
|
648
648
|
# @option opts [Integer] :low_period The number of observations, per period, to calculate low period Exponential Moving Average for smoothing in True Strength Index
|
@@ -661,7 +661,7 @@ describe 'SecurityApi' do
|
|
661
661
|
|
662
662
|
# unit tests for get_security_price_technicals_uo
|
663
663
|
# Ultimate Oscillator
|
664
|
-
#
|
664
|
+
# 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.
|
665
665
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
666
666
|
# @param [Hash] opts the optional parameters
|
667
667
|
# @option opts [Integer] :short_period The number of observations, per period, to calculate the short period for Ultimate Oscillator
|
@@ -683,7 +683,7 @@ describe 'SecurityApi' do
|
|
683
683
|
|
684
684
|
# unit tests for get_security_price_technicals_vi
|
685
685
|
# Vortex Indicator
|
686
|
-
#
|
686
|
+
# 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.
|
687
687
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
688
688
|
# @param [Hash] opts the optional parameters
|
689
689
|
# @option opts [Integer] :period The number of observations, per period, to calculate Vortex Indicator
|
@@ -700,7 +700,7 @@ describe 'SecurityApi' do
|
|
700
700
|
|
701
701
|
# unit tests for get_security_price_technicals_vpt
|
702
702
|
# Volume-price Trend
|
703
|
-
#
|
703
|
+
# 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.
|
704
704
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
705
705
|
# @param [Hash] opts the optional parameters
|
706
706
|
# @option opts [String] :start_date Return technical indicator values on or after the date
|
@@ -716,7 +716,7 @@ describe 'SecurityApi' do
|
|
716
716
|
|
717
717
|
# unit tests for get_security_price_technicals_vwap
|
718
718
|
# Volume Weighted Average Price
|
719
|
-
#
|
719
|
+
# 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.
|
720
720
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
721
721
|
# @param [Hash] opts the optional parameters
|
722
722
|
# @option opts [String] :start_date Return technical indicator values on or after the date
|
@@ -732,7 +732,7 @@ describe 'SecurityApi' do
|
|
732
732
|
|
733
733
|
# unit tests for get_security_price_technicals_wr
|
734
734
|
# Williams %R
|
735
|
-
#
|
735
|
+
# 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.
|
736
736
|
# @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
|
737
737
|
# @param [Hash] opts the optional parameters
|
738
738
|
# @option opts [Integer] :period The number of observations, per period, to look-back when calculating Williams %R
|
@@ -881,7 +881,7 @@ describe 'SecurityApi' do
|
|
881
881
|
|
882
882
|
# unit tests for search_securities
|
883
883
|
# Search Securities
|
884
|
-
#
|
884
|
+
# 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.
|
885
885
|
# @param query
|
886
886
|
# @param [Hash] opts the optional parameters
|
887
887
|
# @option opts [Integer] :page_size The number of results to return
|
@@ -3,7 +3,7 @@
|
|
3
3
|
|
4
4
|
#Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://docs.intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
|
5
5
|
|
6
|
-
OpenAPI spec version: 2.
|
6
|
+
OpenAPI spec version: 2.28.0
|
7
7
|
|
8
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
9
|
Swagger Codegen version: unset
|