intrinio-sdk 5.20.0 → 6.21.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +24 -2
- data/docs/ApiResponseESGCompanies.md +24 -0
- data/docs/ApiResponseESGCompanyComprehensiveRatingHistory.md +28 -0
- data/docs/ApiResponseESGCompanyRatingHistory.md +28 -0
- data/docs/ApiResponseESGLatest.md +24 -0
- data/docs/ApiResponseESGLatestComprehensive.md +24 -0
- data/docs/CompanyApi.md +11 -11
- data/docs/ESGApi.md +432 -0
- data/docs/ESGCompanySummary.md +25 -0
- data/docs/ESGComprehensiveRating.md +58 -0
- data/docs/ESGComprehensiveRatingWithCompany.md +62 -0
- data/docs/ESGRating.md +24 -0
- data/docs/ESGRatingWithCompany.md +28 -0
- data/docs/ETFHolding.md +2 -1
- 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/OptionSnapshotGroup.md +21 -0
- data/docs/OptionSnapshotsResult.md +23 -0
- data/docs/OptionStatsRealtime.md +1 -0
- data/docs/OptionsApi.md +98 -13
- data/docs/OwnersApi.md +2 -2
- data/docs/SecurityApi.md +115 -34
- data/docs/SecuritySnapshotGroup.md +21 -0
- data/docs/SecuritySnapshotsResult.md +23 -0
- data/docs/StockExchangeApi.md +2 -0
- data/docs/TechnicalApi.md +31 -31
- data/git_push.sh +0 -0
- 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 +335 -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 +84 -25
- data/lib/intrinio-sdk/api/owners_api.rb +3 -3
- data/lib/intrinio-sdk/api/security_api.rb +119 -69
- data/lib/intrinio-sdk/api/stock_exchange_api.rb +4 -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_comprehensive_rating_history.rb +209 -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_esg_latest_comprehensive.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 +239 -0
- data/lib/intrinio-sdk/models/esg_comprehensive_rating.rb +569 -0
- data/lib/intrinio-sdk/models/esg_comprehensive_rating_with_company.rb +578 -0
- data/lib/intrinio-sdk/models/esg_rating.rb +229 -0
- data/lib/intrinio-sdk/models/esg_rating_with_company.rb +238 -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 +13 -3
- 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_snapshot_group.rb +201 -0
- data/lib/intrinio-sdk/models/option_snapshots_result.rb +191 -0
- 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_snapshot_group.rb +201 -0
- data/lib/intrinio-sdk/models/security_snapshots_result.rb +191 -0
- 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 +16 -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 +107 -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 +27 -13
- data/spec/api/owners_api_spec.rb +2 -2
- data/spec/api/security_api_spec.rb +47 -35
- data/spec/api/stock_exchange_api_spec.rb +2 -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_comprehensive_rating_history_spec.rb +54 -0
- data/spec/models/api_response_esg_company_rating_history_spec.rb +54 -0
- data/spec/models/api_response_esg_latest_comprehensive_spec.rb +48 -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_comprehensive_rating_spec.rb +270 -0
- data/spec/models/esg_comprehensive_rating_with_company_spec.rb +276 -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 +7 -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_snapshot_group_spec.rb +48 -0
- data/spec/models/option_snapshots_result_spec.rb +42 -0
- 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_snapshot_group_spec.rb +48 -0
- data/spec/models/security_snapshots_result_spec.rb +42 -0
- 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 +62 -2
data/docs/ETFsApi.md
CHANGED
@@ -42,7 +42,7 @@ Method | HTTP request | Description
|
|
42
42
|
#### All ETFs
|
43
43
|
|
44
44
|
|
45
|
-
Returns a list of
|
45
|
+
Returns a list of all currently listed ETFs, with relevant identification information including the ETF Name, Ticker, FIGI Ticker, and Exchange MIC for further usage with our ETF Metadata, Holdings, Stats, and Analytics offerings.
|
46
46
|
|
47
47
|
[//]: # (END_OVERVIEW)
|
48
48
|
|
@@ -126,7 +126,7 @@ Name | Type | Description | Notes
|
|
126
126
|
#### Lookup ETF
|
127
127
|
|
128
128
|
|
129
|
-
Returns
|
129
|
+
Returns classifications and reference data which consists of ~90 columns that give detailed information about an ETF. These granular details include asset class, expense ratio, index name, index weighting scheme, smart beta type and specific investment objectives.
|
130
130
|
|
131
131
|
[//]: # (END_OVERVIEW)
|
132
132
|
|
@@ -203,7 +203,7 @@ Name | Type | Description | Notes
|
|
203
203
|
#### ETF Analytics
|
204
204
|
|
205
205
|
|
206
|
-
Returns analytics for
|
206
|
+
Returns latest market analytics for a specified US ETF, including volume, trailing volumen, market cap, 52 week high, and 52 week low.
|
207
207
|
|
208
208
|
[//]: # (END_OVERVIEW)
|
209
209
|
|
@@ -280,7 +280,7 @@ Name | Type | Description | Notes
|
|
280
280
|
#### ETF Holdings
|
281
281
|
|
282
282
|
|
283
|
-
Returns the
|
283
|
+
Returns holdings data that details all the constituent securities in each ETF with names, identifiers, and the weights for each security providing granular level transparency.
|
284
284
|
|
285
285
|
[//]: # (END_OVERVIEW)
|
286
286
|
|
@@ -364,7 +364,7 @@ Name | Type | Description | Notes
|
|
364
364
|
#### Exchange Traded Fund (ETF) stats
|
365
365
|
|
366
366
|
|
367
|
-
Returns
|
367
|
+
Returns comprehensive key US ETF performance statistics, including prices, NAVs, flows, returns, and much more for both trailing and calendar year periods.
|
368
368
|
|
369
369
|
[//]: # (END_OVERVIEW)
|
370
370
|
|
@@ -441,7 +441,7 @@ Name | Type | Description | Notes
|
|
441
441
|
#### Search ETFs
|
442
442
|
|
443
443
|
|
444
|
-
|
444
|
+
Accepts a string of keyword combinations, and searches across the ETF name and ticker and returns a list of ETFs with related keywords.
|
445
445
|
|
446
446
|
[//]: # (END_OVERVIEW)
|
447
447
|
|
data/docs/FilingApi.md
CHANGED
@@ -42,12 +42,12 @@ Method | HTTP request | Description
|
|
42
42
|
|
43
43
|
[//]: # (START_OVERVIEW)
|
44
44
|
|
45
|
-
> ApiResponseFilings get_all_filings(
|
45
|
+
> ApiResponseFilings get_all_filings(opts)
|
46
46
|
|
47
47
|
#### All Filings
|
48
48
|
|
49
49
|
|
50
|
-
Returns all
|
50
|
+
Returns pertinent filing reference data for a specific company filing or latest filings for all companies. Useful for tracking the latest filings submitted and updating your database accordingly with the new information.
|
51
51
|
|
52
52
|
[//]: # (END_OVERVIEW)
|
53
53
|
|
@@ -67,9 +67,9 @@ Intrinio.configure do |config|
|
|
67
67
|
end
|
68
68
|
|
69
69
|
filing_api = Intrinio::FilingApi.new
|
70
|
-
company = "AAPL"
|
71
70
|
|
72
71
|
opts = {
|
72
|
+
company: "AAPL",
|
73
73
|
report_type: "10-Q",
|
74
74
|
start_date: Date.parse("2015-01-01"),
|
75
75
|
end_date: nil,
|
@@ -80,7 +80,7 @@ opts = {
|
|
80
80
|
next_page: nil
|
81
81
|
}
|
82
82
|
|
83
|
-
result = filing_api.get_all_filings(
|
83
|
+
result = filing_api.get_all_filings(opts)
|
84
84
|
pp result
|
85
85
|
```
|
86
86
|
|
@@ -95,7 +95,7 @@ pp result
|
|
95
95
|
|
96
96
|
Name | Type | Description | Notes
|
97
97
|
------------- | ------------- | ------------- | -------------
|
98
|
-
**company** | String| Filings for the given `company` identifier (ticker, CIK, LEI, Intrinio ID) |
|
98
|
+
**company** | String| Filings for the given `company` identifier (ticker, CIK, LEI, Intrinio ID) | [optional]
|
99
99
|
**report_type** | String| Filter by report type. Separate values with commas to return multiple The filing <a href=\"https://docs.intrinio.com/documentation/sec_filing_report_types\" target=\"_blank\">report types</a>. | [optional]
|
100
100
|
**start_date** | Date| Filed on or after the given date | [optional]
|
101
101
|
**end_date** | Date| Filed before or after the given date | [optional]
|
@@ -143,7 +143,7 @@ Name | Type | Description | Notes
|
|
143
143
|
#### All Filing Notes
|
144
144
|
|
145
145
|
|
146
|
-
|
146
|
+
Returns a list of the latest XBRL filing note sections from the SEC 10-K and 10-Q statements. The returned Intrinio XBRL filing note ID can then be utilized with the “Filing Note by ID” endpoint to retrieve the contents of the note in HTML or text format.
|
147
147
|
|
148
148
|
[//]: # (END_OVERVIEW)
|
149
149
|
|
@@ -392,7 +392,7 @@ Name | Type | Description | Notes
|
|
392
392
|
#### All Fundamentals by Filing
|
393
393
|
|
394
394
|
|
395
|
-
Returns
|
395
|
+
Returns a list of fundamentals with unique fundamental IDs associated with a particular `Intrinio Filing ID` (if applicable) that have been updated or created as a result of a company`s latest SEC filing. Useful to ensure your database is up to date with the latest fundamentals.
|
396
396
|
|
397
397
|
[//]: # (END_OVERVIEW)
|
398
398
|
|
@@ -486,6 +486,7 @@ Name | Type | Description | Notes
|
|
486
486
|
#### Filing Html
|
487
487
|
|
488
488
|
|
489
|
+
Returns a SEC filing in HTML Format for a specified filing ID.
|
489
490
|
|
490
491
|
[//]: # (END_OVERVIEW)
|
491
492
|
|
@@ -638,6 +639,7 @@ Name | Type | Description | Notes
|
|
638
639
|
#### Filing Note by ID
|
639
640
|
|
640
641
|
|
642
|
+
Returns the XBRL filing note contents in HTML or text format for a specified Intrinio XBRL filing note ID.
|
641
643
|
|
642
644
|
[//]: # (END_OVERVIEW)
|
643
645
|
|
@@ -871,7 +873,7 @@ Name | Type | Description | Notes
|
|
871
873
|
#### Search Filing Notes
|
872
874
|
|
873
875
|
|
874
|
-
|
876
|
+
Search the XBRL note database and return a list of XBRL note sections containing text from the text query parameter passed through.
|
875
877
|
|
876
878
|
[//]: # (END_OVERVIEW)
|
877
879
|
|
data/docs/FundamentalsApi.md
CHANGED
@@ -4,6 +4,7 @@ All URIs are relative to *https://api-v2.intrinio.com*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
+
[**filter_fundamental**](FundamentalsApi.md#filter_fundamental) | **GET** /fundamentals | Filter Fundamental
|
7
8
|
[**get_fundamental_by_id**](FundamentalsApi.md#get_fundamental_by_id) | **GET** /fundamentals/{id} | Fundamental by ID
|
8
9
|
[**get_fundamental_reported_financials**](FundamentalsApi.md#get_fundamental_reported_financials) | **GET** /fundamentals/{id}/reported_financials | Reported Financials
|
9
10
|
[**get_fundamental_standardized_financials**](FundamentalsApi.md#get_fundamental_standardized_financials) | **GET** /fundamentals/{id}/standardized_financials | Standardized Financials
|
@@ -12,6 +13,104 @@ Method | HTTP request | Description
|
|
12
13
|
|
13
14
|
|
14
15
|
|
16
|
+
[//]: # (START_OPERATION)
|
17
|
+
|
18
|
+
[//]: # (CLASS:Intrinio::FundamentalsApi)
|
19
|
+
|
20
|
+
[//]: # (METHOD:filter_fundamental)
|
21
|
+
|
22
|
+
[//]: # (RETURN_TYPE:Intrinio::Fundamental)
|
23
|
+
|
24
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
25
|
+
|
26
|
+
[//]: # (RETURN_TYPE_DOC:Fundamental.md)
|
27
|
+
|
28
|
+
[//]: # (OPERATION:filter_fundamental_v2)
|
29
|
+
|
30
|
+
[//]: # (ENDPOINT:/fundamentals)
|
31
|
+
|
32
|
+
[//]: # (DOCUMENT_LINK:FundamentalsApi.md#filter_fundamental)
|
33
|
+
|
34
|
+
## **filter_fundamental**
|
35
|
+
|
36
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/filter_fundamental_v2)
|
37
|
+
|
38
|
+
[//]: # (START_OVERVIEW)
|
39
|
+
|
40
|
+
> Fundamental filter_fundamental(opts)
|
41
|
+
|
42
|
+
#### Filter Fundamental
|
43
|
+
|
44
|
+
|
45
|
+
Returns fundamentals that meet the set of filters specified in parameters.
|
46
|
+
|
47
|
+
[//]: # (END_OVERVIEW)
|
48
|
+
|
49
|
+
### Example
|
50
|
+
|
51
|
+
[//]: # (START_CODE_EXAMPLE)
|
52
|
+
|
53
|
+
```ruby
|
54
|
+
# Load the gem
|
55
|
+
require 'intrinio-sdk'
|
56
|
+
require 'pp'
|
57
|
+
|
58
|
+
# Setup authorization
|
59
|
+
Intrinio.configure do |config|
|
60
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
61
|
+
config.allow_retries = true
|
62
|
+
end
|
63
|
+
|
64
|
+
fundamentals_api = Intrinio::FundamentalsApi.new
|
65
|
+
|
66
|
+
opts = {
|
67
|
+
filed_after: Date.parse("2022-01-01"),
|
68
|
+
filed_before: Date.parse("2022-12-01"),
|
69
|
+
reported_only: false,
|
70
|
+
fiscal_year: 2017,
|
71
|
+
statement_code: nil,
|
72
|
+
type: "false",
|
73
|
+
fiscal_period: "FY",
|
74
|
+
start_date: Date.parse("2022-01-01"),
|
75
|
+
end_date: Date.parse("2022-12-01"),
|
76
|
+
next_page: nil
|
77
|
+
}
|
78
|
+
|
79
|
+
result = fundamentals_api.filter_fundamental(opts)
|
80
|
+
pp result
|
81
|
+
```
|
82
|
+
|
83
|
+
[//]: # (END_CODE_EXAMPLE)
|
84
|
+
|
85
|
+
[//]: # (START_DEFINITION)
|
86
|
+
|
87
|
+
### Parameters
|
88
|
+
|
89
|
+
[//]: # (START_PARAMETERS)
|
90
|
+
|
91
|
+
|
92
|
+
Name | Type | Description | Notes
|
93
|
+
------------- | ------------- | ------------- | -------------
|
94
|
+
**filed_after** | Date| Only include fundamentals that were filed on or after this date. | [optional]
|
95
|
+
**filed_before** | Date| Only include fundamentals that were filed on or before this date. | [optional]
|
96
|
+
**reported_only** | BOOLEAN| Only as-reported fundamentals | [optional]
|
97
|
+
**fiscal_year** | Integer| Only for the given fiscal year | [optional]
|
98
|
+
**statement_code** | String| Only of the given statement code | [optional]
|
99
|
+
**type** | String| Only of the given type | [optional]
|
100
|
+
**fiscal_period** | String| The fiscal period | [optional]
|
101
|
+
**start_date** | Date| Only include fundamentals where covered period is on or after this date. | [optional]
|
102
|
+
**end_date** | Date| Only include fundamentals where covered period is on or before this date. | [optional]
|
103
|
+
**next_page** | String| Gets the next page of data from a previous API call | [optional]
|
104
|
+
|
105
|
+
[//]: # (END_PARAMETERS)
|
106
|
+
|
107
|
+
### Return type
|
108
|
+
|
109
|
+
[**Fundamental**](Fundamental.md)
|
110
|
+
|
111
|
+
[//]: # (END_OPERATION)
|
112
|
+
|
113
|
+
|
15
114
|
[//]: # (START_OPERATION)
|
16
115
|
|
17
116
|
[//]: # (CLASS:Intrinio::FundamentalsApi)
|
@@ -41,7 +140,7 @@ Method | HTTP request | Description
|
|
41
140
|
#### Fundamental by ID
|
42
141
|
|
43
142
|
|
44
|
-
Returns
|
143
|
+
Returns a specific fundamental associated with a particular unique fundamental ID. Useful for pulling reference data for a specific fundamental.
|
45
144
|
|
46
145
|
[//]: # (END_OVERVIEW)
|
47
146
|
|
@@ -118,7 +217,7 @@ Name | Type | Description | Notes
|
|
118
217
|
#### Reported Financials
|
119
218
|
|
120
219
|
|
121
|
-
Returns
|
220
|
+
Returns as-reported financial statement data for income statement, balance sheet, and cash flow statement. Data for income statement and cash flow statement is available on a FY, QTR (Q1, Q2, Q3, Q4), TTM (Q1TTM, Q2TTM, Q3TTM), and YTD (Q2YTD, Q3YTD) basis. Data for the balance sheet is available on a FY or QTR (Q1, Q2, Q3, Q4) basis only due its point-in-time nature.
|
122
221
|
|
123
222
|
[//]: # (END_OVERVIEW)
|
124
223
|
|
@@ -195,7 +294,7 @@ Name | Type | Description | Notes
|
|
195
294
|
#### Standardized Financials
|
196
295
|
|
197
296
|
|
198
|
-
Returns
|
297
|
+
Returns standardized financial statement data for income statement, balance sheet, cash flow statement and over 100 associated calculations for a given company. Data for income statement, cash flow statement, and calculations is available on a FY, QTR (Q1, Q2, Q3, Q4), TTM (Q1TTM, Q2TTM, Q3TTM), and YTD (Q2YTD, Q3YTD) basis. Data for the balance sheet is available on a FY or QTR (Q1, Q2, Q3, Q4) basis only due its point-in-time nature.
|
199
298
|
|
200
299
|
[//]: # (END_OVERVIEW)
|
201
300
|
|
@@ -351,7 +450,7 @@ Name | Type | Description | Notes
|
|
351
450
|
#### Lookup Fundamental
|
352
451
|
|
353
452
|
|
354
|
-
Returns
|
453
|
+
Returns a specific fundamental with unique fundamental ID associated with a particular company, year, period and statement. Useful for pulling the unique fundamental ID and reference data for a specific fundamental.
|
355
454
|
|
356
455
|
[//]: # (END_OVERVIEW)
|
357
456
|
|
data/docs/IndexApi.md
CHANGED
@@ -54,6 +54,7 @@ Method | HTTP request | Description
|
|
54
54
|
#### All Economic Indices
|
55
55
|
|
56
56
|
|
57
|
+
Returns a list of reference data on more than 200,000 economic indices from the Federal Reserve Economic Data (FRED) database.
|
57
58
|
|
58
59
|
[//]: # (END_OVERVIEW)
|
59
60
|
|
@@ -297,6 +298,7 @@ Name | Type | Description | Notes
|
|
297
298
|
#### Lookup Economic Index
|
298
299
|
|
299
300
|
|
301
|
+
Returns reference data for a specified Federal Reserve Economic Data (FRED) series ID.
|
300
302
|
|
301
303
|
[//]: # (END_OVERVIEW)
|
302
304
|
|
@@ -373,7 +375,7 @@ Name | Type | Description | Notes
|
|
373
375
|
#### Data Point (Number) for an Economic Index
|
374
376
|
|
375
377
|
|
376
|
-
Returns
|
378
|
+
Returns latest data for a specified Federal Reserve Economic Data (FRED) ID.
|
377
379
|
|
378
380
|
[//]: # (END_OVERVIEW)
|
379
381
|
|
@@ -531,7 +533,7 @@ Name | Type | Description | Notes
|
|
531
533
|
#### Historical Data for an Economic Index
|
532
534
|
|
533
535
|
|
534
|
-
Returns historical
|
536
|
+
Returns historical data for a specified Federal Reserve Economic Data (FRED) ID over a period of time.
|
535
537
|
|
536
538
|
[//]: # (END_OVERVIEW)
|
537
539
|
|
@@ -1281,7 +1283,7 @@ Name | Type | Description | Notes
|
|
1281
1283
|
#### Search Economic Indices
|
1282
1284
|
|
1283
1285
|
|
1284
|
-
|
1286
|
+
Search the Federal Reserve Economic Data (FRED) database and return a list of economic indices matching the text query parameter passed through.
|
1285
1287
|
|
1286
1288
|
[//]: # (END_OVERVIEW)
|
1287
1289
|
|
@@ -0,0 +1,21 @@
|
|
1
|
+
|
2
|
+
|
3
|
+
[//]: # (CLASS:Intrinio::OptionSnapshotGroup)
|
4
|
+
|
5
|
+
[//]: # (KIND:object)
|
6
|
+
|
7
|
+
### Intrinio::OptionSnapshotGroup
|
8
|
+
|
9
|
+
#### Properties
|
10
|
+
|
11
|
+
[//]: # (START_DEFINITION)
|
12
|
+
|
13
|
+
Name | Type | Description
|
14
|
+
------------ | ------------- | -------------
|
15
|
+
**time** | DateTime | The UTC timestamp of this snapshot group.
|
16
|
+
**files** | Array<Object> | List of all the snapshot parts of this group.
|
17
|
+
|
18
|
+
[//]: # (END_DEFINITION)
|
19
|
+
|
20
|
+
|
21
|
+
|
@@ -0,0 +1,23 @@
|
|
1
|
+
|
2
|
+
|
3
|
+
[//]: # (CLASS:Intrinio::OptionSnapshotsResult)
|
4
|
+
|
5
|
+
[//]: # (KIND:object)
|
6
|
+
|
7
|
+
### Intrinio::OptionSnapshotsResult
|
8
|
+
|
9
|
+
#### Properties
|
10
|
+
|
11
|
+
[//]: # (START_DEFINITION)
|
12
|
+
|
13
|
+
Name | Type | Description
|
14
|
+
------------ | ------------- | -------------
|
15
|
+
**snapshots** | [**Array<OptionSnapshotGroup>**](OptionSnapshotGroup.md) | List of all the snapshot groups comprising the queried result.
|
16
|
+
|
17
|
+
[//]: # (END_DEFINITION)
|
18
|
+
|
19
|
+
|
20
|
+
[//]: # (CONTAINED_CLASS:Intrinio::OptionSnapshotGroup)
|
21
|
+
|
22
|
+
|
23
|
+
|
data/docs/OptionStatsRealtime.md
CHANGED
@@ -17,6 +17,7 @@ Name | Type | Description
|
|
17
17
|
**gamma** | Float | Gamma represents the rate of change between an option's delta and the underlying asset's price.
|
18
18
|
**theta** | Float | Theta represents the rate of change between the option price and time, or time sensitivity - sometimes known as an option's time decay.
|
19
19
|
**vega** | Float | Vega represents the rate of change between an option's value and the underlying asset's implied volatility.
|
20
|
+
**underlying_price** | Float | The most recent trade price of the underlying asset.
|
20
21
|
|
21
22
|
[//]: # (END_DEFINITION)
|
22
23
|
|
data/docs/OptionsApi.md
CHANGED
@@ -17,6 +17,7 @@ Method | HTTP request | Description
|
|
17
17
|
[**get_options_prices_batch_realtime**](OptionsApi.md#get_options_prices_batch_realtime) | **POST** /options/prices/realtime/batch | Option Prices Batch Realtime
|
18
18
|
[**get_options_prices_eod**](OptionsApi.md#get_options_prices_eod) | **GET** /options/prices/{identifier}/eod | Option Prices EOD
|
19
19
|
[**get_options_prices_realtime**](OptionsApi.md#get_options_prices_realtime) | **GET** /options/prices/{identifier}/realtime | Option Prices Realtime
|
20
|
+
[**get_options_snapshots**](OptionsApi.md#get_options_snapshots) | **GET** /options/snapshots | Option Prices Realtime Snapshot
|
20
21
|
[**get_options_stats_realtime**](OptionsApi.md#get_options_stats_realtime) | **GET** /options/prices/{identifier}/realtime/stats | Option Stats Realtime
|
21
22
|
[**get_unusual_activity**](OptionsApi.md#get_unusual_activity) | **GET** /options/unusual_activity/{symbol} | Options Unusual Activity
|
22
23
|
[**get_unusual_activity_intraday**](OptionsApi.md#get_unusual_activity_intraday) | **GET** /options/unusual_activity/{symbol}/intraday | Options Unusual Activity Intraday
|
@@ -126,7 +127,7 @@ This endpoint does not need any parameter.
|
|
126
127
|
#### Option Expirations Realtime
|
127
128
|
|
128
129
|
|
129
|
-
Returns all
|
130
|
+
Returns a list of all current and upcoming expiration dates for a particular symbol.
|
130
131
|
|
131
132
|
[//]: # (END_OVERVIEW)
|
132
133
|
|
@@ -212,7 +213,7 @@ Name | Type | Description | Notes
|
|
212
213
|
#### Option Strikes Realtime
|
213
214
|
|
214
215
|
|
215
|
-
Returns
|
216
|
+
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.
|
216
217
|
|
217
218
|
[//]: # (END_OVERVIEW)
|
218
219
|
|
@@ -291,7 +292,7 @@ Name | Type | Description | Notes
|
|
291
292
|
#### Options
|
292
293
|
|
293
294
|
|
294
|
-
Returns
|
295
|
+
Returns a list of all securities that have options listed and are tradable on a US market exchange. Useful to retrieve the entire universe.
|
295
296
|
|
296
297
|
[//]: # (END_OVERVIEW)
|
297
298
|
|
@@ -389,7 +390,7 @@ Name | Type | Description | Notes
|
|
389
390
|
#### Options by Symbol Realtime
|
390
391
|
|
391
392
|
|
392
|
-
Returns
|
393
|
+
Returns a list of all securities that have options listed and are tradable on a US market exchange. Useful to retrieve the entire universe.
|
393
394
|
|
394
395
|
[//]: # (END_OVERVIEW)
|
395
396
|
|
@@ -485,7 +486,7 @@ Name | Type | Description | Notes
|
|
485
486
|
#### Options Chain
|
486
487
|
|
487
488
|
|
488
|
-
Returns
|
489
|
+
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.
|
489
490
|
|
490
491
|
[//]: # (END_OVERVIEW)
|
491
492
|
|
@@ -608,7 +609,8 @@ opts = {
|
|
608
609
|
type: nil,
|
609
610
|
strike: nil,
|
610
611
|
strike_greater_than: nil,
|
611
|
-
strike_less_than: nil
|
612
|
+
strike_less_than: nil,
|
613
|
+
date: nil
|
612
614
|
}
|
613
615
|
|
614
616
|
result = options_api.get_options_chain_eod(symbol, expiration, opts)
|
@@ -632,6 +634,7 @@ Name | Type | Description | Notes
|
|
632
634
|
**strike** | Float| The strike price of the option contract. This will return options contracts with strike price equal to this price. | [optional]
|
633
635
|
**strike_greater_than** | Float| The strike price of the option contract. This will return options contracts with strike prices greater than this price. | [optional]
|
634
636
|
**strike_less_than** | Float| The strike price of the option contract. This will return options contracts with strike prices less than this price. | [optional]
|
637
|
+
**date** | Date| The the date to retrieve prices for | [optional]
|
635
638
|
|
636
639
|
[//]: # (END_PARAMETERS)
|
637
640
|
|
@@ -671,7 +674,7 @@ Name | Type | Description | Notes
|
|
671
674
|
#### Options Chain Realtime
|
672
675
|
|
673
676
|
|
674
|
-
Returns
|
677
|
+
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.
|
675
678
|
|
676
679
|
[//]: # (END_OVERVIEW)
|
677
680
|
|
@@ -773,7 +776,7 @@ Name | Type | Description | Notes
|
|
773
776
|
#### Options Expirations
|
774
777
|
|
775
778
|
|
776
|
-
Returns all option contract expiration dates for a
|
779
|
+
Returns a list of all current and upcoming option contract expiration dates for a particular symbol.
|
777
780
|
|
778
781
|
[//]: # (END_OVERVIEW)
|
779
782
|
|
@@ -857,7 +860,7 @@ Name | Type | Description | Notes
|
|
857
860
|
#### Option Prices
|
858
861
|
|
859
862
|
|
860
|
-
Returns all
|
863
|
+
Returns all price data from inception to expiration for a particular contract.
|
861
864
|
|
862
865
|
[//]: # (END_OVERVIEW)
|
863
866
|
|
@@ -945,7 +948,7 @@ Name | Type | Description | Notes
|
|
945
948
|
#### Option Prices Batch Realtime
|
946
949
|
|
947
950
|
|
948
|
-
Returns
|
951
|
+
Returns a list of latest price data for up to 250 option contracts per request.
|
949
952
|
|
950
953
|
[//]: # (END_OVERVIEW)
|
951
954
|
|
@@ -1163,6 +1166,88 @@ Name | Type | Description | Notes
|
|
1163
1166
|
[//]: # (END_OPERATION)
|
1164
1167
|
|
1165
1168
|
|
1169
|
+
[//]: # (START_OPERATION)
|
1170
|
+
|
1171
|
+
[//]: # (CLASS:Intrinio::OptionsApi)
|
1172
|
+
|
1173
|
+
[//]: # (METHOD:get_options_snapshots)
|
1174
|
+
|
1175
|
+
[//]: # (RETURN_TYPE:Intrinio::OptionSnapshotsResult)
|
1176
|
+
|
1177
|
+
[//]: # (RETURN_TYPE_KIND:object)
|
1178
|
+
|
1179
|
+
[//]: # (RETURN_TYPE_DOC:OptionSnapshotsResult.md)
|
1180
|
+
|
1181
|
+
[//]: # (OPERATION:get_options_snapshots_v2)
|
1182
|
+
|
1183
|
+
[//]: # (ENDPOINT:/options/snapshots)
|
1184
|
+
|
1185
|
+
[//]: # (DOCUMENT_LINK:OptionsApi.md#get_options_snapshots)
|
1186
|
+
|
1187
|
+
## **get_options_snapshots**
|
1188
|
+
|
1189
|
+
[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_options_snapshots_v2)
|
1190
|
+
|
1191
|
+
[//]: # (START_OVERVIEW)
|
1192
|
+
|
1193
|
+
> OptionSnapshotsResult get_options_snapshots(opts)
|
1194
|
+
|
1195
|
+
#### Option Prices Realtime Snapshot
|
1196
|
+
|
1197
|
+
|
1198
|
+
Returns all options snapshots for the queried interval with links to download.
|
1199
|
+
|
1200
|
+
[//]: # (END_OVERVIEW)
|
1201
|
+
|
1202
|
+
### Example
|
1203
|
+
|
1204
|
+
[//]: # (START_CODE_EXAMPLE)
|
1205
|
+
|
1206
|
+
```ruby
|
1207
|
+
# Load the gem
|
1208
|
+
require 'intrinio-sdk'
|
1209
|
+
require 'pp'
|
1210
|
+
|
1211
|
+
# Setup authorization
|
1212
|
+
Intrinio.configure do |config|
|
1213
|
+
config.api_key['api_key'] = 'YOUR_API_KEY'
|
1214
|
+
config.allow_retries = true
|
1215
|
+
end
|
1216
|
+
|
1217
|
+
options_api = Intrinio::OptionsApi.new
|
1218
|
+
|
1219
|
+
opts = {
|
1220
|
+
source: nil,
|
1221
|
+
at_datetime: DateTime.parse(nil)
|
1222
|
+
}
|
1223
|
+
|
1224
|
+
result = options_api.get_options_snapshots(opts)
|
1225
|
+
pp result
|
1226
|
+
```
|
1227
|
+
|
1228
|
+
[//]: # (END_CODE_EXAMPLE)
|
1229
|
+
|
1230
|
+
[//]: # (START_DEFINITION)
|
1231
|
+
|
1232
|
+
### Parameters
|
1233
|
+
|
1234
|
+
[//]: # (START_PARAMETERS)
|
1235
|
+
|
1236
|
+
|
1237
|
+
Name | Type | Description | Notes
|
1238
|
+
------------- | ------------- | ------------- | -------------
|
1239
|
+
**source** | String| Realtime or 15-minute delayed contracts. | [optional]
|
1240
|
+
**at_datetime** | DateTime| The UTC date and time (with url-encoded spaces) the snapshot will cover. | [optional]
|
1241
|
+
|
1242
|
+
[//]: # (END_PARAMETERS)
|
1243
|
+
|
1244
|
+
### Return type
|
1245
|
+
|
1246
|
+
[**OptionSnapshotsResult**](OptionSnapshotsResult.md)
|
1247
|
+
|
1248
|
+
[//]: # (END_OPERATION)
|
1249
|
+
|
1250
|
+
|
1166
1251
|
[//]: # (START_OPERATION)
|
1167
1252
|
|
1168
1253
|
[//]: # (CLASS:Intrinio::OptionsApi)
|
@@ -1192,7 +1277,7 @@ Name | Type | Description | Notes
|
|
1192
1277
|
#### Option Stats Realtime
|
1193
1278
|
|
1194
1279
|
|
1195
|
-
Returns all option stats (greeks and implied volatility)
|
1280
|
+
Returns all option stats (greeks and implied volatility) as well as the underlying factors used to calculate them, for a particular option contract.
|
1196
1281
|
|
1197
1282
|
[//]: # (END_OVERVIEW)
|
1198
1283
|
|
@@ -1274,7 +1359,7 @@ Name | Type | Description | Notes
|
|
1274
1359
|
#### Options Unusual Activity
|
1275
1360
|
|
1276
1361
|
|
1277
|
-
Returns unusual
|
1362
|
+
Returns unusual options activity for a particular company across all option chains. Unusual options activity includes large trades, sweeps, and block trades.
|
1278
1363
|
|
1279
1364
|
[//]: # (END_OVERVIEW)
|
1280
1365
|
|
@@ -1452,7 +1537,7 @@ Name | Type | Description | Notes
|
|
1452
1537
|
#### Options Unusual Activity Universal
|
1453
1538
|
|
1454
1539
|
|
1455
|
-
Returns
|
1540
|
+
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.
|
1456
1541
|
|
1457
1542
|
[//]: # (END_OVERVIEW)
|
1458
1543
|
|
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)
|