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.
Files changed (570) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +72 -0
  3. data/README.md +12 -2
  4. data/docs/ApiResponseESGCompanies.md +24 -0
  5. data/docs/ApiResponseESGCompanyRatingHistory.md +28 -0
  6. data/docs/ApiResponseESGLatest.md +24 -0
  7. data/docs/CompanyApi.md +11 -11
  8. data/docs/ESGApi.md +262 -0
  9. data/docs/ESGCompanySummary.md +25 -0
  10. data/docs/ESGRating.md +24 -0
  11. data/docs/ESGRatingWithCompany.md +28 -0
  12. data/docs/ETFsApi.md +6 -6
  13. data/docs/FilingApi.md +10 -8
  14. data/docs/FundamentalsApi.md +103 -4
  15. data/docs/IndexApi.md +5 -3
  16. data/docs/OptionStatsRealtime.md +1 -0
  17. data/docs/OptionsApi.md +15 -13
  18. data/docs/OwnersApi.md +2 -2
  19. data/docs/SecurityApi.md +34 -34
  20. data/docs/TechnicalApi.md +31 -31
  21. data/intrinio-sdk.gemspec +1 -1
  22. data/lib/intrinio-sdk/api/bulk_downloads_api.rb +1 -1
  23. data/lib/intrinio-sdk/api/company_api.rb +23 -23
  24. data/lib/intrinio-sdk/api/data_point_api.rb +1 -1
  25. data/lib/intrinio-sdk/api/data_tag_api.rb +1 -1
  26. data/lib/intrinio-sdk/api/esg_api.rb +209 -0
  27. data/lib/intrinio-sdk/api/et_fs_api.rb +13 -13
  28. data/lib/intrinio-sdk/api/filing_api.rb +19 -23
  29. data/lib/intrinio-sdk/api/forex_api.rb +1 -1
  30. data/lib/intrinio-sdk/api/fundamentals_api.rb +95 -9
  31. data/lib/intrinio-sdk/api/historical_data_api.rb +1 -1
  32. data/lib/intrinio-sdk/api/index_api.rb +11 -11
  33. data/lib/intrinio-sdk/api/insider_transaction_filings_api.rb +1 -1
  34. data/lib/intrinio-sdk/api/municipality_api.rb +1 -1
  35. data/lib/intrinio-sdk/api/options_api.rb +28 -25
  36. data/lib/intrinio-sdk/api/owners_api.rb +3 -3
  37. data/lib/intrinio-sdk/api/security_api.rb +69 -69
  38. data/lib/intrinio-sdk/api/stock_exchange_api.rb +1 -1
  39. data/lib/intrinio-sdk/api/technical_api.rb +63 -63
  40. data/lib/intrinio-sdk/api/zacks_api.rb +1 -1
  41. data/lib/intrinio-sdk/api_client.rb +1 -1
  42. data/lib/intrinio-sdk/api_error.rb +1 -1
  43. data/lib/intrinio-sdk/configuration.rb +1 -1
  44. data/lib/intrinio-sdk/models/accumulation_distribution_index_technical_value.rb +1 -1
  45. data/lib/intrinio-sdk/models/api_response_bulk_download_links.rb +1 -1
  46. data/lib/intrinio-sdk/models/api_response_companies.rb +1 -1
  47. data/lib/intrinio-sdk/models/api_response_companies_search.rb +1 -1
  48. data/lib/intrinio-sdk/models/api_response_company_answers.rb +1 -1
  49. data/lib/intrinio-sdk/models/api_response_company_filings.rb +1 -1
  50. data/lib/intrinio-sdk/models/api_response_company_fundamentals.rb +1 -1
  51. data/lib/intrinio-sdk/models/api_response_company_historical_data.rb +1 -1
  52. data/lib/intrinio-sdk/models/api_response_company_insider_transaction_filings.rb +1 -1
  53. data/lib/intrinio-sdk/models/api_response_company_news.rb +1 -1
  54. data/lib/intrinio-sdk/models/api_response_company_recognize.rb +1 -1
  55. data/lib/intrinio-sdk/models/api_response_company_securities.rb +1 -1
  56. data/lib/intrinio-sdk/models/api_response_company_shares_outstanding.rb +1 -1
  57. data/lib/intrinio-sdk/models/api_response_data_tags.rb +1 -1
  58. data/lib/intrinio-sdk/models/api_response_data_tags_search.rb +1 -1
  59. data/lib/intrinio-sdk/models/api_response_economic_index_historical_data.rb +1 -1
  60. data/lib/intrinio-sdk/models/api_response_economic_indices.rb +1 -1
  61. data/lib/intrinio-sdk/models/api_response_economic_indices_search.rb +1 -1
  62. data/lib/intrinio-sdk/models/api_response_esg_companies.rb +200 -0
  63. data/lib/intrinio-sdk/models/api_response_esg_company_rating_history.rb +209 -0
  64. data/lib/intrinio-sdk/models/api_response_esg_latest.rb +200 -0
  65. data/lib/intrinio-sdk/models/api_response_et_fs.rb +1 -1
  66. data/lib/intrinio-sdk/models/api_response_etf_holdings.rb +1 -1
  67. data/lib/intrinio-sdk/models/api_response_filing_answers.rb +1 -1
  68. data/lib/intrinio-sdk/models/api_response_filing_fundamentals.rb +1 -1
  69. data/lib/intrinio-sdk/models/api_response_filing_notes.rb +1 -1
  70. data/lib/intrinio-sdk/models/api_response_filing_notes_search.rb +1 -1
  71. data/lib/intrinio-sdk/models/api_response_filings.rb +1 -1
  72. data/lib/intrinio-sdk/models/api_response_forex_currencies.rb +1 -1
  73. data/lib/intrinio-sdk/models/api_response_forex_pairs.rb +1 -1
  74. data/lib/intrinio-sdk/models/api_response_forex_prices.rb +1 -1
  75. data/lib/intrinio-sdk/models/api_response_historical_data.rb +1 -1
  76. data/lib/intrinio-sdk/models/api_response_initial_public_offerings.rb +1 -1
  77. data/lib/intrinio-sdk/models/api_response_insider_transaction_filings.rb +1 -1
  78. data/lib/intrinio-sdk/models/api_response_municipalities.rb +1 -1
  79. data/lib/intrinio-sdk/models/api_response_municipalitiy_financials.rb +1 -1
  80. data/lib/intrinio-sdk/models/api_response_news.rb +1 -1
  81. data/lib/intrinio-sdk/models/api_response_option_prices.rb +1 -1
  82. data/lib/intrinio-sdk/models/api_response_options.rb +1 -1
  83. data/lib/intrinio-sdk/models/api_response_options_chain.rb +1 -1
  84. data/lib/intrinio-sdk/models/api_response_options_chain_eod.rb +1 -1
  85. data/lib/intrinio-sdk/models/api_response_options_chain_realtime.rb +1 -1
  86. data/lib/intrinio-sdk/models/api_response_options_expirations.rb +1 -1
  87. data/lib/intrinio-sdk/models/api_response_options_price_realtime.rb +1 -1
  88. data/lib/intrinio-sdk/models/api_response_options_prices_batch_realtime.rb +1 -1
  89. data/lib/intrinio-sdk/models/api_response_options_prices_eod.rb +1 -1
  90. data/lib/intrinio-sdk/models/api_response_options_realtime.rb +1 -1
  91. data/lib/intrinio-sdk/models/api_response_options_stats_realtime.rb +1 -1
  92. data/lib/intrinio-sdk/models/api_response_options_tickers.rb +1 -1
  93. data/lib/intrinio-sdk/models/api_response_options_unusual_activity.rb +1 -1
  94. data/lib/intrinio-sdk/models/api_response_owner_insider_transaction_filings.rb +1 -1
  95. data/lib/intrinio-sdk/models/api_response_owner_institutional_holdings.rb +1 -1
  96. data/lib/intrinio-sdk/models/api_response_owners.rb +1 -1
  97. data/lib/intrinio-sdk/models/api_response_reported_financials.rb +1 -1
  98. data/lib/intrinio-sdk/models/api_response_securities.rb +1 -1
  99. data/lib/intrinio-sdk/models/api_response_securities_search.rb +1 -1
  100. data/lib/intrinio-sdk/models/api_response_security_accumulation_distribution_index.rb +1 -1
  101. data/lib/intrinio-sdk/models/api_response_security_average_daily_trading_volume.rb +1 -1
  102. data/lib/intrinio-sdk/models/api_response_security_average_directional_index.rb +1 -1
  103. data/lib/intrinio-sdk/models/api_response_security_average_true_range.rb +1 -1
  104. data/lib/intrinio-sdk/models/api_response_security_awesome_oscillator.rb +1 -1
  105. data/lib/intrinio-sdk/models/api_response_security_bollinger_bands.rb +1 -1
  106. data/lib/intrinio-sdk/models/api_response_security_chaikin_money_flow.rb +1 -1
  107. data/lib/intrinio-sdk/models/api_response_security_commodity_channel_index.rb +1 -1
  108. data/lib/intrinio-sdk/models/api_response_security_detrended_price_oscillator.rb +1 -1
  109. data/lib/intrinio-sdk/models/api_response_security_donchian_channel.rb +1 -1
  110. data/lib/intrinio-sdk/models/api_response_security_ease_of_movement.rb +1 -1
  111. data/lib/intrinio-sdk/models/api_response_security_force_index.rb +1 -1
  112. data/lib/intrinio-sdk/models/api_response_security_historical_data.rb +1 -1
  113. data/lib/intrinio-sdk/models/api_response_security_ichimoku_kinko_hyo.rb +1 -1
  114. data/lib/intrinio-sdk/models/api_response_security_institutional_ownership.rb +1 -1
  115. data/lib/intrinio-sdk/models/api_response_security_interval_prices.rb +1 -1
  116. data/lib/intrinio-sdk/models/api_response_security_intraday_prices.rb +1 -1
  117. data/lib/intrinio-sdk/models/api_response_security_keltner_channel.rb +1 -1
  118. data/lib/intrinio-sdk/models/api_response_security_know_sure_thing.rb +1 -1
  119. data/lib/intrinio-sdk/models/api_response_security_mass_index.rb +1 -1
  120. data/lib/intrinio-sdk/models/api_response_security_money_flow_index.rb +1 -1
  121. data/lib/intrinio-sdk/models/api_response_security_moving_average_convergence_divergence.rb +1 -1
  122. data/lib/intrinio-sdk/models/api_response_security_negative_volume_index.rb +1 -1
  123. data/lib/intrinio-sdk/models/api_response_security_on_balance_volume.rb +1 -1
  124. data/lib/intrinio-sdk/models/api_response_security_on_balance_volume_mean.rb +1 -1
  125. data/lib/intrinio-sdk/models/api_response_security_relative_strength_index.rb +1 -1
  126. data/lib/intrinio-sdk/models/api_response_security_simple_moving_average.rb +1 -1
  127. data/lib/intrinio-sdk/models/api_response_security_stochastic_oscillator.rb +1 -1
  128. data/lib/intrinio-sdk/models/api_response_security_stock_price_adjustments.rb +1 -1
  129. data/lib/intrinio-sdk/models/api_response_security_stock_prices.rb +1 -1
  130. data/lib/intrinio-sdk/models/api_response_security_triple_exponential_average.rb +1 -1
  131. data/lib/intrinio-sdk/models/api_response_security_true_strength_index.rb +1 -1
  132. data/lib/intrinio-sdk/models/api_response_security_ultimate_oscillator.rb +1 -1
  133. data/lib/intrinio-sdk/models/api_response_security_volume_price_trend.rb +1 -1
  134. data/lib/intrinio-sdk/models/api_response_security_volume_weighted_average_price.rb +1 -1
  135. data/lib/intrinio-sdk/models/api_response_security_vortex_indicator.rb +1 -1
  136. data/lib/intrinio-sdk/models/api_response_security_williams_r.rb +1 -1
  137. data/lib/intrinio-sdk/models/api_response_security_zacks_analyst_ratings.rb +1 -1
  138. data/lib/intrinio-sdk/models/api_response_security_zacks_analyst_ratings_snapshot.rb +1 -1
  139. data/lib/intrinio-sdk/models/api_response_security_zacks_eps_surprises.rb +1 -1
  140. data/lib/intrinio-sdk/models/api_response_security_zacks_sales_surprises.rb +1 -1
  141. data/lib/intrinio-sdk/models/api_response_sic_index_historical_data.rb +1 -1
  142. data/lib/intrinio-sdk/models/api_response_sic_indices.rb +1 -1
  143. data/lib/intrinio-sdk/models/api_response_sic_indices_search.rb +1 -1
  144. data/lib/intrinio-sdk/models/api_response_standardized_financials.rb +1 -1
  145. data/lib/intrinio-sdk/models/api_response_standardized_financials_dimensions.rb +1 -1
  146. data/lib/intrinio-sdk/models/api_response_stock_exchange_realtime_stock_prices.rb +1 -1
  147. data/lib/intrinio-sdk/models/api_response_stock_exchange_securities.rb +1 -1
  148. data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_price_adjustments.rb +1 -1
  149. data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_prices.rb +1 -1
  150. data/lib/intrinio-sdk/models/api_response_stock_exchanges.rb +1 -1
  151. data/lib/intrinio-sdk/models/api_response_stock_market_index_historical_data.rb +1 -1
  152. data/lib/intrinio-sdk/models/api_response_stock_market_indices.rb +1 -1
  153. data/lib/intrinio-sdk/models/api_response_stock_market_indices_search.rb +1 -1
  154. data/lib/intrinio-sdk/models/api_response_zacks_analyst_ratings.rb +1 -1
  155. data/lib/intrinio-sdk/models/api_response_zacks_eps_estimates.rb +1 -1
  156. data/lib/intrinio-sdk/models/api_response_zacks_eps_growth_rates.rb +1 -1
  157. data/lib/intrinio-sdk/models/api_response_zacks_eps_surprises.rb +1 -1
  158. data/lib/intrinio-sdk/models/api_response_zacks_etf_holdings.rb +1 -1
  159. data/lib/intrinio-sdk/models/api_response_zacks_institutional_holding_companies.rb +1 -1
  160. data/lib/intrinio-sdk/models/api_response_zacks_institutional_holding_owners.rb +1 -1
  161. data/lib/intrinio-sdk/models/api_response_zacks_institutional_holdings.rb +1 -1
  162. data/lib/intrinio-sdk/models/api_response_zacks_long_term_growth_rates.rb +1 -1
  163. data/lib/intrinio-sdk/models/api_response_zacks_sales_surprises.rb +1 -1
  164. data/lib/intrinio-sdk/models/api_response_zacks_target_price_consensuses.rb +1 -1
  165. data/lib/intrinio-sdk/models/average_daily_trading_volume_technical_value.rb +1 -1
  166. data/lib/intrinio-sdk/models/average_directional_index_technical_value.rb +1 -1
  167. data/lib/intrinio-sdk/models/average_true_range_technical_value.rb +1 -1
  168. data/lib/intrinio-sdk/models/awesome_oscillator_technical_value.rb +1 -1
  169. data/lib/intrinio-sdk/models/bollinger_bands_technical_value.rb +1 -1
  170. data/lib/intrinio-sdk/models/bulk_download_links.rb +1 -1
  171. data/lib/intrinio-sdk/models/bulk_download_summary.rb +1 -1
  172. data/lib/intrinio-sdk/models/chaikin_money_flow_technical_value.rb +1 -1
  173. data/lib/intrinio-sdk/models/commodity_channel_index_technical_value.rb +1 -1
  174. data/lib/intrinio-sdk/models/company.rb +1 -1
  175. data/lib/intrinio-sdk/models/company_filing.rb +1 -1
  176. data/lib/intrinio-sdk/models/company_initial_public_offering.rb +1 -1
  177. data/lib/intrinio-sdk/models/company_news.rb +1 -1
  178. data/lib/intrinio-sdk/models/company_news_summary.rb +1 -1
  179. data/lib/intrinio-sdk/models/company_shares_outstanding.rb +1 -1
  180. data/lib/intrinio-sdk/models/company_summary.rb +1 -1
  181. data/lib/intrinio-sdk/models/data_tag.rb +1 -1
  182. data/lib/intrinio-sdk/models/data_tag_summary.rb +1 -1
  183. data/lib/intrinio-sdk/models/detrended_price_oscillator_technical_value.rb +1 -1
  184. data/lib/intrinio-sdk/models/dividend_record.rb +1 -1
  185. data/lib/intrinio-sdk/models/donchian_channel_technical_value.rb +1 -1
  186. data/lib/intrinio-sdk/models/earnings_record.rb +1 -1
  187. data/lib/intrinio-sdk/models/ease_of_movement_technical_value.rb +1 -1
  188. data/lib/intrinio-sdk/models/economic_index.rb +1 -1
  189. data/lib/intrinio-sdk/models/economic_index_summary.rb +1 -1
  190. data/lib/intrinio-sdk/models/esg_company_summary.rb +233 -0
  191. data/lib/intrinio-sdk/models/esg_rating.rb +224 -0
  192. data/lib/intrinio-sdk/models/esg_rating_with_company.rb +233 -0
  193. data/lib/intrinio-sdk/models/etf.rb +1 -1
  194. data/lib/intrinio-sdk/models/etf_analytics.rb +1 -1
  195. data/lib/intrinio-sdk/models/etf_holding.rb +1 -1
  196. data/lib/intrinio-sdk/models/etf_stats.rb +1 -1
  197. data/lib/intrinio-sdk/models/etf_summary.rb +1 -1
  198. data/lib/intrinio-sdk/models/filing.rb +1 -1
  199. data/lib/intrinio-sdk/models/filing_note.rb +1 -1
  200. data/lib/intrinio-sdk/models/filing_note_filing.rb +1 -1
  201. data/lib/intrinio-sdk/models/filing_note_summary.rb +1 -1
  202. data/lib/intrinio-sdk/models/filing_summary.rb +1 -1
  203. data/lib/intrinio-sdk/models/force_index_technical_value.rb +1 -1
  204. data/lib/intrinio-sdk/models/forex_currency.rb +1 -1
  205. data/lib/intrinio-sdk/models/forex_pair.rb +1 -1
  206. data/lib/intrinio-sdk/models/forex_price.rb +1 -1
  207. data/lib/intrinio-sdk/models/fundamental.rb +1 -1
  208. data/lib/intrinio-sdk/models/fundamental_summary.rb +1 -1
  209. data/lib/intrinio-sdk/models/historical_data.rb +1 -1
  210. data/lib/intrinio-sdk/models/ichimoku_kinko_hyo_technical_value.rb +1 -1
  211. data/lib/intrinio-sdk/models/insider_transaction.rb +1 -1
  212. data/lib/intrinio-sdk/models/insider_transaction_filing.rb +1 -1
  213. data/lib/intrinio-sdk/models/institutional_holding.rb +1 -1
  214. data/lib/intrinio-sdk/models/institutional_ownership.rb +1 -1
  215. data/lib/intrinio-sdk/models/intraday_stock_price.rb +1 -1
  216. data/lib/intrinio-sdk/models/keltner_channel_technical_value.rb +1 -1
  217. data/lib/intrinio-sdk/models/know_sure_thing_technical_value.rb +1 -1
  218. data/lib/intrinio-sdk/models/mass_index_technical_value.rb +1 -1
  219. data/lib/intrinio-sdk/models/money_flow_index_technical_value.rb +1 -1
  220. data/lib/intrinio-sdk/models/moving_average_convergence_divergence_technical_value.rb +1 -1
  221. data/lib/intrinio-sdk/models/municipality.rb +1 -1
  222. data/lib/intrinio-sdk/models/municipality_financial.rb +1 -1
  223. data/lib/intrinio-sdk/models/negative_volume_index_technical_value.rb +1 -1
  224. data/lib/intrinio-sdk/models/on_balance_volume_mean_technical_value.rb +1 -1
  225. data/lib/intrinio-sdk/models/on_balance_volume_technical_value.rb +1 -1
  226. data/lib/intrinio-sdk/models/option.rb +1 -1
  227. data/lib/intrinio-sdk/models/option_chain.rb +1 -1
  228. data/lib/intrinio-sdk/models/option_chain_eod.rb +1 -1
  229. data/lib/intrinio-sdk/models/option_chain_realtime.rb +1 -1
  230. data/lib/intrinio-sdk/models/option_contracts_list.rb +1 -1
  231. data/lib/intrinio-sdk/models/option_eod.rb +1 -1
  232. data/lib/intrinio-sdk/models/option_factors_realtime.rb +1 -1
  233. data/lib/intrinio-sdk/models/option_price.rb +1 -1
  234. data/lib/intrinio-sdk/models/option_price_batch_realtime.rb +1 -1
  235. data/lib/intrinio-sdk/models/option_price_eod.rb +1 -1
  236. data/lib/intrinio-sdk/models/option_price_realtime.rb +1 -1
  237. data/lib/intrinio-sdk/models/option_realtime.rb +1 -1
  238. data/lib/intrinio-sdk/models/option_stats_realtime.rb +15 -5
  239. data/lib/intrinio-sdk/models/option_unusual_trade.rb +1 -1
  240. data/lib/intrinio-sdk/models/owner.rb +1 -1
  241. data/lib/intrinio-sdk/models/owner_summary.rb +1 -1
  242. data/lib/intrinio-sdk/models/realtime_stock_price.rb +1 -1
  243. data/lib/intrinio-sdk/models/realtime_stock_price_security.rb +1 -1
  244. data/lib/intrinio-sdk/models/relative_strength_index_technical_value.rb +1 -1
  245. data/lib/intrinio-sdk/models/reported_financial.rb +1 -1
  246. data/lib/intrinio-sdk/models/reported_financial_dimension.rb +1 -1
  247. data/lib/intrinio-sdk/models/reported_tag.rb +1 -1
  248. data/lib/intrinio-sdk/models/security.rb +1 -1
  249. data/lib/intrinio-sdk/models/security_screen_clause.rb +1 -1
  250. data/lib/intrinio-sdk/models/security_screen_group.rb +1 -1
  251. data/lib/intrinio-sdk/models/security_screen_result.rb +1 -1
  252. data/lib/intrinio-sdk/models/security_screen_result_data.rb +1 -1
  253. data/lib/intrinio-sdk/models/security_summary.rb +1 -1
  254. data/lib/intrinio-sdk/models/sic_index.rb +1 -1
  255. data/lib/intrinio-sdk/models/simple_moving_average_technical_value.rb +1 -1
  256. data/lib/intrinio-sdk/models/standardized_financial.rb +1 -1
  257. data/lib/intrinio-sdk/models/standardized_financials_dimension.rb +1 -1
  258. data/lib/intrinio-sdk/models/stochastic_oscillator_technical_value.rb +1 -1
  259. data/lib/intrinio-sdk/models/stock_exchange.rb +1 -1
  260. data/lib/intrinio-sdk/models/stock_market_index.rb +1 -1
  261. data/lib/intrinio-sdk/models/stock_market_index_summary.rb +1 -1
  262. data/lib/intrinio-sdk/models/stock_price.rb +1 -1
  263. data/lib/intrinio-sdk/models/stock_price_adjustment.rb +1 -1
  264. data/lib/intrinio-sdk/models/stock_price_adjustment_summary.rb +1 -1
  265. data/lib/intrinio-sdk/models/stock_price_interval.rb +1 -1
  266. data/lib/intrinio-sdk/models/stock_price_summary.rb +1 -1
  267. data/lib/intrinio-sdk/models/technical_indicator.rb +1 -1
  268. data/lib/intrinio-sdk/models/thea_entity_answer.rb +1 -1
  269. data/lib/intrinio-sdk/models/thea_source_document.rb +1 -1
  270. data/lib/intrinio-sdk/models/triple_exponential_average_technical_value.rb +1 -1
  271. data/lib/intrinio-sdk/models/true_strength_index_technical_value.rb +1 -1
  272. data/lib/intrinio-sdk/models/ultimate_oscillator_technical_value.rb +1 -1
  273. data/lib/intrinio-sdk/models/volume_price_trend_technical_value.rb +1 -1
  274. data/lib/intrinio-sdk/models/volume_weighted_average_price_value.rb +1 -1
  275. data/lib/intrinio-sdk/models/vortex_indicator_technical_value.rb +1 -1
  276. data/lib/intrinio-sdk/models/williams_r_technical_value.rb +1 -1
  277. data/lib/intrinio-sdk/models/zacks_analyst_rating.rb +1 -1
  278. data/lib/intrinio-sdk/models/zacks_analyst_rating_snapshot.rb +1 -1
  279. data/lib/intrinio-sdk/models/zacks_analyst_rating_summary.rb +1 -1
  280. data/lib/intrinio-sdk/models/zacks_eps_estimate.rb +1 -1
  281. data/lib/intrinio-sdk/models/zacks_eps_growth_rate.rb +1 -1
  282. data/lib/intrinio-sdk/models/zacks_eps_surprise.rb +1 -1
  283. data/lib/intrinio-sdk/models/zacks_eps_surprise_summary.rb +1 -1
  284. data/lib/intrinio-sdk/models/zacks_etf_holding.rb +1 -1
  285. data/lib/intrinio-sdk/models/zacks_institutional_holding.rb +1 -1
  286. data/lib/intrinio-sdk/models/zacks_institutional_holding_company_detail.rb +1 -1
  287. data/lib/intrinio-sdk/models/zacks_institutional_holding_company_summary.rb +1 -1
  288. data/lib/intrinio-sdk/models/zacks_institutional_holding_historical_summary.rb +1 -1
  289. data/lib/intrinio-sdk/models/zacks_institutional_holding_owner_detail.rb +1 -1
  290. data/lib/intrinio-sdk/models/zacks_institutional_holding_owner_summary.rb +1 -1
  291. data/lib/intrinio-sdk/models/zacks_long_term_growth_rate.rb +1 -1
  292. data/lib/intrinio-sdk/models/zacks_sales_surprise.rb +1 -1
  293. data/lib/intrinio-sdk/models/zacks_sales_surprise_summary.rb +1 -1
  294. data/lib/intrinio-sdk/models/zacks_target_price_consensus.rb +1 -1
  295. data/lib/intrinio-sdk/version.rb +2 -2
  296. data/lib/intrinio-sdk.rb +8 -1
  297. data/spec/api/bulk_downloads_api_spec.rb +1 -1
  298. data/spec/api/company_api_spec.rb +12 -12
  299. data/spec/api/data_point_api_spec.rb +1 -1
  300. data/spec/api/data_tag_api_spec.rb +1 -1
  301. data/spec/api/esg_api_spec.rb +78 -0
  302. data/spec/api/et_fs_api_spec.rb +7 -7
  303. data/spec/api/filing_api_spec.rb +8 -8
  304. data/spec/api/forex_api_spec.rb +1 -1
  305. data/spec/api/fundamentals_api_spec.rb +26 -5
  306. data/spec/api/historical_data_api_spec.rb +1 -1
  307. data/spec/api/index_api_spec.rb +6 -6
  308. data/spec/api/insider_transaction_filings_api_spec.rb +1 -1
  309. data/spec/api/municipality_api_spec.rb +1 -1
  310. data/spec/api/options_api_spec.rb +14 -13
  311. data/spec/api/owners_api_spec.rb +2 -2
  312. data/spec/api/security_api_spec.rb +35 -35
  313. data/spec/api/stock_exchange_api_spec.rb +1 -1
  314. data/spec/api/technical_api_spec.rb +32 -32
  315. data/spec/api/zacks_api_spec.rb +1 -1
  316. data/spec/api_client_spec.rb +1 -1
  317. data/spec/configuration_spec.rb +1 -1
  318. data/spec/models/accumulation_distribution_index_technical_value_spec.rb +1 -1
  319. data/spec/models/api_response_bulk_download_links_spec.rb +1 -1
  320. data/spec/models/api_response_companies_search_spec.rb +1 -1
  321. data/spec/models/api_response_companies_spec.rb +1 -1
  322. data/spec/models/api_response_company_answers_spec.rb +1 -1
  323. data/spec/models/api_response_company_filings_spec.rb +1 -1
  324. data/spec/models/api_response_company_fundamentals_spec.rb +1 -1
  325. data/spec/models/api_response_company_historical_data_spec.rb +1 -1
  326. data/spec/models/api_response_company_insider_transaction_filings_spec.rb +1 -1
  327. data/spec/models/api_response_company_news_spec.rb +1 -1
  328. data/spec/models/api_response_company_recognize_spec.rb +1 -1
  329. data/spec/models/api_response_company_securities_spec.rb +1 -1
  330. data/spec/models/api_response_company_shares_outstanding_spec.rb +1 -1
  331. data/spec/models/api_response_data_tags_search_spec.rb +1 -1
  332. data/spec/models/api_response_data_tags_spec.rb +1 -1
  333. data/spec/models/api_response_economic_index_historical_data_spec.rb +1 -1
  334. data/spec/models/api_response_economic_indices_search_spec.rb +1 -1
  335. data/spec/models/api_response_economic_indices_spec.rb +1 -1
  336. data/spec/models/api_response_esg_companies_spec.rb +48 -0
  337. data/spec/models/api_response_esg_company_rating_history_spec.rb +54 -0
  338. data/spec/models/api_response_esg_latest_spec.rb +48 -0
  339. data/spec/models/api_response_et_fs_spec.rb +1 -1
  340. data/spec/models/api_response_etf_holdings_spec.rb +1 -1
  341. data/spec/models/api_response_filing_answers_spec.rb +1 -1
  342. data/spec/models/api_response_filing_fundamentals_spec.rb +1 -1
  343. data/spec/models/api_response_filing_notes_search_spec.rb +1 -1
  344. data/spec/models/api_response_filing_notes_spec.rb +1 -1
  345. data/spec/models/api_response_filings_spec.rb +1 -1
  346. data/spec/models/api_response_forex_currencies_spec.rb +1 -1
  347. data/spec/models/api_response_forex_pairs_spec.rb +1 -1
  348. data/spec/models/api_response_forex_prices_spec.rb +1 -1
  349. data/spec/models/api_response_historical_data_spec.rb +1 -1
  350. data/spec/models/api_response_initial_public_offerings_spec.rb +1 -1
  351. data/spec/models/api_response_insider_transaction_filings_spec.rb +1 -1
  352. data/spec/models/api_response_municipalities_spec.rb +1 -1
  353. data/spec/models/api_response_municipalitiy_financials_spec.rb +1 -1
  354. data/spec/models/api_response_news_spec.rb +1 -1
  355. data/spec/models/api_response_option_prices_spec.rb +1 -1
  356. data/spec/models/api_response_options_chain_eod_spec.rb +1 -1
  357. data/spec/models/api_response_options_chain_realtime_spec.rb +1 -1
  358. data/spec/models/api_response_options_chain_spec.rb +1 -1
  359. data/spec/models/api_response_options_expirations_spec.rb +1 -1
  360. data/spec/models/api_response_options_price_realtime_spec.rb +1 -1
  361. data/spec/models/api_response_options_prices_batch_realtime_spec.rb +1 -1
  362. data/spec/models/api_response_options_prices_eod_spec.rb +1 -1
  363. data/spec/models/api_response_options_realtime_spec.rb +1 -1
  364. data/spec/models/api_response_options_spec.rb +1 -1
  365. data/spec/models/api_response_options_stats_realtime_spec.rb +1 -1
  366. data/spec/models/api_response_options_tickers_spec.rb +1 -1
  367. data/spec/models/api_response_options_unusual_activity_spec.rb +1 -1
  368. data/spec/models/api_response_owner_insider_transaction_filings_spec.rb +1 -1
  369. data/spec/models/api_response_owner_institutional_holdings_spec.rb +1 -1
  370. data/spec/models/api_response_owners_spec.rb +1 -1
  371. data/spec/models/api_response_reported_financials_spec.rb +1 -1
  372. data/spec/models/api_response_securities_search_spec.rb +1 -1
  373. data/spec/models/api_response_securities_spec.rb +1 -1
  374. data/spec/models/api_response_security_accumulation_distribution_index_spec.rb +1 -1
  375. data/spec/models/api_response_security_average_daily_trading_volume_spec.rb +1 -1
  376. data/spec/models/api_response_security_average_directional_index_spec.rb +1 -1
  377. data/spec/models/api_response_security_average_true_range_spec.rb +1 -1
  378. data/spec/models/api_response_security_awesome_oscillator_spec.rb +1 -1
  379. data/spec/models/api_response_security_bollinger_bands_spec.rb +1 -1
  380. data/spec/models/api_response_security_chaikin_money_flow_spec.rb +1 -1
  381. data/spec/models/api_response_security_commodity_channel_index_spec.rb +1 -1
  382. data/spec/models/api_response_security_detrended_price_oscillator_spec.rb +1 -1
  383. data/spec/models/api_response_security_donchian_channel_spec.rb +1 -1
  384. data/spec/models/api_response_security_ease_of_movement_spec.rb +1 -1
  385. data/spec/models/api_response_security_force_index_spec.rb +1 -1
  386. data/spec/models/api_response_security_historical_data_spec.rb +1 -1
  387. data/spec/models/api_response_security_ichimoku_kinko_hyo_spec.rb +1 -1
  388. data/spec/models/api_response_security_institutional_ownership_spec.rb +1 -1
  389. data/spec/models/api_response_security_interval_prices_spec.rb +1 -1
  390. data/spec/models/api_response_security_intraday_prices_spec.rb +1 -1
  391. data/spec/models/api_response_security_keltner_channel_spec.rb +1 -1
  392. data/spec/models/api_response_security_know_sure_thing_spec.rb +1 -1
  393. data/spec/models/api_response_security_mass_index_spec.rb +1 -1
  394. data/spec/models/api_response_security_money_flow_index_spec.rb +1 -1
  395. data/spec/models/api_response_security_moving_average_convergence_divergence_spec.rb +1 -1
  396. data/spec/models/api_response_security_negative_volume_index_spec.rb +1 -1
  397. data/spec/models/api_response_security_on_balance_volume_mean_spec.rb +1 -1
  398. data/spec/models/api_response_security_on_balance_volume_spec.rb +1 -1
  399. data/spec/models/api_response_security_relative_strength_index_spec.rb +1 -1
  400. data/spec/models/api_response_security_simple_moving_average_spec.rb +1 -1
  401. data/spec/models/api_response_security_stochastic_oscillator_spec.rb +1 -1
  402. data/spec/models/api_response_security_stock_price_adjustments_spec.rb +1 -1
  403. data/spec/models/api_response_security_stock_prices_spec.rb +1 -1
  404. data/spec/models/api_response_security_triple_exponential_average_spec.rb +1 -1
  405. data/spec/models/api_response_security_true_strength_index_spec.rb +1 -1
  406. data/spec/models/api_response_security_ultimate_oscillator_spec.rb +1 -1
  407. data/spec/models/api_response_security_volume_price_trend_spec.rb +1 -1
  408. data/spec/models/api_response_security_volume_weighted_average_price_spec.rb +1 -1
  409. data/spec/models/api_response_security_vortex_indicator_spec.rb +1 -1
  410. data/spec/models/api_response_security_williams_r_spec.rb +1 -1
  411. data/spec/models/api_response_security_zacks_analyst_ratings_snapshot_spec.rb +1 -1
  412. data/spec/models/api_response_security_zacks_analyst_ratings_spec.rb +1 -1
  413. data/spec/models/api_response_security_zacks_eps_surprises_spec.rb +1 -1
  414. data/spec/models/api_response_security_zacks_sales_surprises_spec.rb +1 -1
  415. data/spec/models/api_response_sic_index_historical_data_spec.rb +1 -1
  416. data/spec/models/api_response_sic_indices_search_spec.rb +1 -1
  417. data/spec/models/api_response_sic_indices_spec.rb +1 -1
  418. data/spec/models/api_response_standardized_financials_dimensions_spec.rb +1 -1
  419. data/spec/models/api_response_standardized_financials_spec.rb +1 -1
  420. data/spec/models/api_response_stock_exchange_realtime_stock_prices_spec.rb +1 -1
  421. data/spec/models/api_response_stock_exchange_securities_spec.rb +1 -1
  422. data/spec/models/api_response_stock_exchange_stock_price_adjustments_spec.rb +1 -1
  423. data/spec/models/api_response_stock_exchange_stock_prices_spec.rb +1 -1
  424. data/spec/models/api_response_stock_exchanges_spec.rb +1 -1
  425. data/spec/models/api_response_stock_market_index_historical_data_spec.rb +1 -1
  426. data/spec/models/api_response_stock_market_indices_search_spec.rb +1 -1
  427. data/spec/models/api_response_stock_market_indices_spec.rb +1 -1
  428. data/spec/models/api_response_zacks_analyst_ratings_spec.rb +1 -1
  429. data/spec/models/api_response_zacks_eps_estimates_spec.rb +1 -1
  430. data/spec/models/api_response_zacks_eps_growth_rates_spec.rb +1 -1
  431. data/spec/models/api_response_zacks_eps_surprises_spec.rb +1 -1
  432. data/spec/models/api_response_zacks_etf_holdings_spec.rb +1 -1
  433. data/spec/models/api_response_zacks_institutional_holding_companies_spec.rb +1 -1
  434. data/spec/models/api_response_zacks_institutional_holding_owners_spec.rb +1 -1
  435. data/spec/models/api_response_zacks_institutional_holdings_spec.rb +1 -1
  436. data/spec/models/api_response_zacks_long_term_growth_rates_spec.rb +1 -1
  437. data/spec/models/api_response_zacks_sales_surprises_spec.rb +1 -1
  438. data/spec/models/api_response_zacks_target_price_consensuses_spec.rb +1 -1
  439. data/spec/models/average_daily_trading_volume_technical_value_spec.rb +1 -1
  440. data/spec/models/average_directional_index_technical_value_spec.rb +1 -1
  441. data/spec/models/average_true_range_technical_value_spec.rb +1 -1
  442. data/spec/models/awesome_oscillator_technical_value_spec.rb +1 -1
  443. data/spec/models/bollinger_bands_technical_value_spec.rb +1 -1
  444. data/spec/models/bulk_download_links_spec.rb +1 -1
  445. data/spec/models/bulk_download_summary_spec.rb +1 -1
  446. data/spec/models/chaikin_money_flow_technical_value_spec.rb +1 -1
  447. data/spec/models/commodity_channel_index_technical_value_spec.rb +1 -1
  448. data/spec/models/company_filing_spec.rb +1 -1
  449. data/spec/models/company_initial_public_offering_spec.rb +1 -1
  450. data/spec/models/company_news_spec.rb +1 -1
  451. data/spec/models/company_news_summary_spec.rb +1 -1
  452. data/spec/models/company_shares_outstanding_spec.rb +1 -1
  453. data/spec/models/company_spec.rb +1 -1
  454. data/spec/models/company_summary_spec.rb +1 -1
  455. data/spec/models/data_tag_spec.rb +1 -1
  456. data/spec/models/data_tag_summary_spec.rb +1 -1
  457. data/spec/models/detrended_price_oscillator_technical_value_spec.rb +1 -1
  458. data/spec/models/dividend_record_spec.rb +1 -1
  459. data/spec/models/donchian_channel_technical_value_spec.rb +1 -1
  460. data/spec/models/earnings_record_spec.rb +1 -1
  461. data/spec/models/ease_of_movement_technical_value_spec.rb +1 -1
  462. data/spec/models/economic_index_spec.rb +1 -1
  463. data/spec/models/economic_index_summary_spec.rb +1 -1
  464. data/spec/models/esg_company_summary_spec.rb +72 -0
  465. data/spec/models/esg_rating_spec.rb +66 -0
  466. data/spec/models/esg_rating_with_company_spec.rb +72 -0
  467. data/spec/models/etf_analytics_spec.rb +1 -1
  468. data/spec/models/etf_holding_spec.rb +1 -1
  469. data/spec/models/etf_spec.rb +1 -1
  470. data/spec/models/etf_stats_spec.rb +1 -1
  471. data/spec/models/etf_summary_spec.rb +1 -1
  472. data/spec/models/filing_note_filing_spec.rb +1 -1
  473. data/spec/models/filing_note_spec.rb +1 -1
  474. data/spec/models/filing_note_summary_spec.rb +1 -1
  475. data/spec/models/filing_spec.rb +1 -1
  476. data/spec/models/filing_summary_spec.rb +1 -1
  477. data/spec/models/force_index_technical_value_spec.rb +1 -1
  478. data/spec/models/forex_currency_spec.rb +1 -1
  479. data/spec/models/forex_pair_spec.rb +1 -1
  480. data/spec/models/forex_price_spec.rb +1 -1
  481. data/spec/models/fundamental_spec.rb +1 -1
  482. data/spec/models/fundamental_summary_spec.rb +1 -1
  483. data/spec/models/historical_data_spec.rb +1 -1
  484. data/spec/models/ichimoku_kinko_hyo_technical_value_spec.rb +1 -1
  485. data/spec/models/insider_transaction_filing_spec.rb +1 -1
  486. data/spec/models/insider_transaction_spec.rb +1 -1
  487. data/spec/models/institutional_holding_spec.rb +1 -1
  488. data/spec/models/institutional_ownership_spec.rb +1 -1
  489. data/spec/models/intraday_stock_price_spec.rb +1 -1
  490. data/spec/models/keltner_channel_technical_value_spec.rb +1 -1
  491. data/spec/models/know_sure_thing_technical_value_spec.rb +1 -1
  492. data/spec/models/mass_index_technical_value_spec.rb +1 -1
  493. data/spec/models/money_flow_index_technical_value_spec.rb +1 -1
  494. data/spec/models/moving_average_convergence_divergence_technical_value_spec.rb +1 -1
  495. data/spec/models/municipality_financial_spec.rb +1 -1
  496. data/spec/models/municipality_spec.rb +1 -1
  497. data/spec/models/negative_volume_index_technical_value_spec.rb +1 -1
  498. data/spec/models/on_balance_volume_mean_technical_value_spec.rb +1 -1
  499. data/spec/models/on_balance_volume_technical_value_spec.rb +1 -1
  500. data/spec/models/option_chain_eod_spec.rb +1 -1
  501. data/spec/models/option_chain_realtime_spec.rb +1 -1
  502. data/spec/models/option_chain_spec.rb +1 -1
  503. data/spec/models/option_contracts_list_spec.rb +1 -1
  504. data/spec/models/option_eod_spec.rb +1 -1
  505. data/spec/models/option_factors_realtime_spec.rb +1 -1
  506. data/spec/models/option_price_batch_realtime_spec.rb +1 -1
  507. data/spec/models/option_price_eod_spec.rb +1 -1
  508. data/spec/models/option_price_realtime_spec.rb +1 -1
  509. data/spec/models/option_price_spec.rb +1 -1
  510. data/spec/models/option_realtime_spec.rb +1 -1
  511. data/spec/models/option_spec.rb +1 -1
  512. data/spec/models/option_stats_realtime_spec.rb +7 -1
  513. data/spec/models/option_unusual_trade_spec.rb +1 -1
  514. data/spec/models/owner_spec.rb +1 -1
  515. data/spec/models/owner_summary_spec.rb +1 -1
  516. data/spec/models/realtime_stock_price_security_spec.rb +1 -1
  517. data/spec/models/realtime_stock_price_spec.rb +1 -1
  518. data/spec/models/relative_strength_index_technical_value_spec.rb +1 -1
  519. data/spec/models/reported_financial_dimension_spec.rb +1 -1
  520. data/spec/models/reported_financial_spec.rb +1 -1
  521. data/spec/models/reported_tag_spec.rb +1 -1
  522. data/spec/models/security_screen_clause_spec.rb +1 -1
  523. data/spec/models/security_screen_group_spec.rb +1 -1
  524. data/spec/models/security_screen_result_data_spec.rb +1 -1
  525. data/spec/models/security_screen_result_spec.rb +1 -1
  526. data/spec/models/security_spec.rb +1 -1
  527. data/spec/models/security_summary_spec.rb +1 -1
  528. data/spec/models/sic_index_spec.rb +1 -1
  529. data/spec/models/simple_moving_average_technical_value_spec.rb +1 -1
  530. data/spec/models/standardized_financial_spec.rb +1 -1
  531. data/spec/models/standardized_financials_dimension_spec.rb +1 -1
  532. data/spec/models/stochastic_oscillator_technical_value_spec.rb +1 -1
  533. data/spec/models/stock_exchange_spec.rb +1 -1
  534. data/spec/models/stock_market_index_spec.rb +1 -1
  535. data/spec/models/stock_market_index_summary_spec.rb +1 -1
  536. data/spec/models/stock_price_adjustment_spec.rb +1 -1
  537. data/spec/models/stock_price_adjustment_summary_spec.rb +1 -1
  538. data/spec/models/stock_price_interval_spec.rb +1 -1
  539. data/spec/models/stock_price_spec.rb +1 -1
  540. data/spec/models/stock_price_summary_spec.rb +1 -1
  541. data/spec/models/technical_indicator_spec.rb +1 -1
  542. data/spec/models/thea_entity_answer_spec.rb +1 -1
  543. data/spec/models/thea_source_document_spec.rb +1 -1
  544. data/spec/models/triple_exponential_average_technical_value_spec.rb +1 -1
  545. data/spec/models/true_strength_index_technical_value_spec.rb +1 -1
  546. data/spec/models/ultimate_oscillator_technical_value_spec.rb +1 -1
  547. data/spec/models/volume_price_trend_technical_value_spec.rb +1 -1
  548. data/spec/models/volume_weighted_average_price_value_spec.rb +1 -1
  549. data/spec/models/vortex_indicator_technical_value_spec.rb +1 -1
  550. data/spec/models/williams_r_technical_value_spec.rb +1 -1
  551. data/spec/models/zacks_analyst_rating_snapshot_spec.rb +1 -1
  552. data/spec/models/zacks_analyst_rating_spec.rb +1 -1
  553. data/spec/models/zacks_analyst_rating_summary_spec.rb +1 -1
  554. data/spec/models/zacks_eps_estimate_spec.rb +1 -1
  555. data/spec/models/zacks_eps_growth_rate_spec.rb +1 -1
  556. data/spec/models/zacks_eps_surprise_spec.rb +1 -1
  557. data/spec/models/zacks_eps_surprise_summary_spec.rb +1 -1
  558. data/spec/models/zacks_etf_holding_spec.rb +1 -1
  559. data/spec/models/zacks_institutional_holding_company_detail_spec.rb +1 -1
  560. data/spec/models/zacks_institutional_holding_company_summary_spec.rb +1 -1
  561. data/spec/models/zacks_institutional_holding_historical_summary_spec.rb +1 -1
  562. data/spec/models/zacks_institutional_holding_owner_detail_spec.rb +1 -1
  563. data/spec/models/zacks_institutional_holding_owner_summary_spec.rb +1 -1
  564. data/spec/models/zacks_institutional_holding_spec.rb +1 -1
  565. data/spec/models/zacks_long_term_growth_rate_spec.rb +1 -1
  566. data/spec/models/zacks_sales_surprise_spec.rb +1 -1
  567. data/spec/models/zacks_sales_surprise_summary_spec.rb +1 -1
  568. data/spec/models/zacks_target_price_consensus_spec.rb +1 -1
  569. data/spec/spec_helper.rb +1 -1
  570. 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.27.5
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
@@ -108,7 +108,7 @@ module Intrinio
108
108
  end
109
109
 
110
110
  # All News
111
- # Returns all News for all Companies
111
+ # Returns the latest news article links, headlines and summaries for all US traded companies allowing you to keep a pulse on companies and their business operations.
112
112
  # @param [Hash] opts the optional parameters
113
113
  # @option opts [Integer] :page_size The number of results to return (default to 100)
114
114
  # @option opts [String] :next_page Gets the next page of data from a previous API call
@@ -119,7 +119,7 @@ module Intrinio
119
119
  end
120
120
 
121
121
  # All News
122
- # Returns all News for all Companies
122
+ # Returns the latest news article links, headlines and summaries for all US traded companies allowing you to keep a pulse on companies and their business operations.
123
123
  # @param [Hash] opts the optional parameters
124
124
  # @option opts [Integer] :page_size The number of results to return
125
125
  # @option opts [String] :next_page Gets the next page of data from a previous API call
@@ -165,7 +165,7 @@ module Intrinio
165
165
  end
166
166
 
167
167
  # Lookup Company
168
- # Returns the Company with the given `identifier`
168
+ # Returns company reference and metadata such as tickers, CIK, and a unique company identifier, as well as company metadata such as business description, employee count, and company URL.
169
169
  # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
170
170
  # @param [Hash] opts the optional parameters
171
171
  # @return [Company]
@@ -175,7 +175,7 @@ module Intrinio
175
175
  end
176
176
 
177
177
  # Lookup Company
178
- # Returns the Company with the given `identifier`
178
+ # Returns company reference and metadata such as tickers, CIK, and a unique company identifier, as well as company metadata such as business description, employee count, and company URL.
179
179
  # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
180
180
  # @param [Hash] opts the optional parameters
181
181
  # @return [Array<(Company, Fixnum, Hash)>] Company data, response status code and response headers
@@ -278,7 +278,7 @@ module Intrinio
278
278
  end
279
279
 
280
280
  # Data Point (Number) for Company
281
- # Returns a numeric value for the given `tag` for the Company with the given `identifier`
281
+ # Returns latest value for calculations, metrics, and financial data points for a company.
282
282
  # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
283
283
  # @param tag An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;)
284
284
  # @param [Hash] opts the optional parameters
@@ -289,7 +289,7 @@ module Intrinio
289
289
  end
290
290
 
291
291
  # Data Point (Number) for Company
292
- # Returns a numeric value for the given &#x60;tag&#x60; for the Company with the given &#x60;identifier&#x60;
292
+ # Returns latest value for calculations, metrics, and financial data points for a company.
293
293
  # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
294
294
  # @param tag An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;)
295
295
  # @param [Hash] opts the optional parameters
@@ -337,7 +337,7 @@ module Intrinio
337
337
  end
338
338
 
339
339
  # Data Point (Text) for Company
340
- # Returns a text value for the given `tag` for the Company with the given `identifier`
340
+ # Returns latest value for metadata items for a company.
341
341
  # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
342
342
  # @param tag An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;)
343
343
  # @param [Hash] opts the optional parameters
@@ -348,7 +348,7 @@ module Intrinio
348
348
  end
349
349
 
350
350
  # Data Point (Text) for Company
351
- # Returns a text value for the given &#x60;tag&#x60; for the Company with the given &#x60;identifier&#x60;
351
+ # Returns latest value for metadata items for a company.
352
352
  # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
353
353
  # @param tag An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;)
354
354
  # @param [Hash] opts the optional parameters
@@ -471,7 +471,7 @@ module Intrinio
471
471
  end
472
472
 
473
473
  # All Fundamentals by Company
474
- # Returns all Fundamentals for the Company with the given `identifier`. Returns Fundamentals matching parameters when supplied.
474
+ # Returns a list of fundamentals with unique fundamental IDs associated with a particular company. Useful to obtain all historical and/or latest fundamental IDs for a given company to then use to loop through and pull all fundamental data available.
475
475
  # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
476
476
  # @param [Hash] opts the optional parameters
477
477
  # @option opts [Date] :filed_after Filed on or after this date
@@ -491,7 +491,7 @@ module Intrinio
491
491
  end
492
492
 
493
493
  # All Fundamentals by Company
494
- # Returns all Fundamentals for the Company with the given &#x60;identifier&#x60;. Returns Fundamentals matching parameters when supplied.
494
+ # Returns a list of fundamentals with unique fundamental IDs associated with a particular company. Useful to obtain all historical and/or latest fundamental IDs for a given company to then use to loop through and pull all fundamental data available.
495
495
  # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
496
496
  # @param [Hash] opts the optional parameters
497
497
  # @option opts [Date] :filed_after Filed on or after this date
@@ -657,10 +657,10 @@ module Intrinio
657
657
  end
658
658
 
659
659
  # IPOs
660
- # Returns initial public offerings (IPOs). An IPO is a public offering of private company stock. The act of \"going public\" is initiated by an IPO, at which point the company's stock trades on a major stock exchange (such as NYSE or NASDAQ). Intrinio covers all upcoming and recent IPOs for US exchanges.
660
+ # Returns a list of historical, current, and upcoming initial public offerings (IPOs) across the major US Exchanges. Includes relevant information such as the IPO status, the offer amount, the total share count and target share price.
661
661
  # @param [Hash] opts the optional parameters
662
662
  # @option opts [String] :ticker Return IPOs with the given ticker (typically the IPO for the company)
663
- # @option opts [String] :status Return IPOs with the given status. Upcoming IPOs are scheduled to occur in the future. Priced IPOs have occured and the company should be trading publicly. Withdrawn IPOs were planned to occurr but were withdrawn beforehand
663
+ # @option opts [String] :status Return IPOs with the given status. Upcoming IPOs are scheduled to occur in the future. Priced IPOs have occurred and the company should be trading publicly. Withdrawn IPOs were planned to occurr but were withdrawn beforehand
664
664
  # @option opts [Date] :start_date Return IPOs on or after the given date
665
665
  # @option opts [Date] :end_date Return IPOs on or before the given date
666
666
  # @option opts [Integer] :offer_amount_greater_than Return IPOs with an offer dollar amount greater than the given amount
@@ -674,10 +674,10 @@ module Intrinio
674
674
  end
675
675
 
676
676
  # IPOs
677
- # Returns initial public offerings (IPOs). An IPO is a public offering of private company stock. The act of \&quot;going public\&quot; is initiated by an IPO, at which point the company&#39;s stock trades on a major stock exchange (such as NYSE or NASDAQ). Intrinio covers all upcoming and recent IPOs for US exchanges.
677
+ # Returns a list of historical, current, and upcoming initial public offerings (IPOs) across the major US Exchanges. Includes relevant information such as the IPO status, the offer amount, the total share count and target share price.
678
678
  # @param [Hash] opts the optional parameters
679
679
  # @option opts [String] :ticker Return IPOs with the given ticker (typically the IPO for the company)
680
- # @option opts [String] :status Return IPOs with the given status. Upcoming IPOs are scheduled to occur in the future. Priced IPOs have occured and the company should be trading publicly. Withdrawn IPOs were planned to occurr but were withdrawn beforehand
680
+ # @option opts [String] :status Return IPOs with the given status. Upcoming IPOs are scheduled to occur in the future. Priced IPOs have occurred and the company should be trading publicly. Withdrawn IPOs were planned to occurr but were withdrawn beforehand
681
681
  # @option opts [Date] :start_date Return IPOs on or after the given date
682
682
  # @option opts [Date] :end_date Return IPOs on or before the given date
683
683
  # @option opts [Integer] :offer_amount_greater_than Return IPOs with an offer dollar amount greater than the given amount
@@ -735,7 +735,7 @@ module Intrinio
735
735
  end
736
736
 
737
737
  # All News by Company
738
- # Returns news for the Company with the given `identifier`
738
+ # Returns the latest and historical news article links, headlines and summaries for a specified US traded company.
739
739
  # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
740
740
  # @param [Hash] opts the optional parameters
741
741
  # @option opts [Integer] :page_size The number of results to return (default to 100)
@@ -747,7 +747,7 @@ module Intrinio
747
747
  end
748
748
 
749
749
  # All News by Company
750
- # Returns news for the Company with the given &#x60;identifier&#x60;
750
+ # Returns the latest and historical news article links, headlines and summaries for a specified US traded company.
751
751
  # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
752
752
  # @param [Hash] opts the optional parameters
753
753
  # @option opts [Integer] :page_size The number of results to return
@@ -798,7 +798,7 @@ module Intrinio
798
798
  end
799
799
 
800
800
  # All Securities by Company
801
- # Returns Securities for the Company with the given `identifier`
801
+ # Returns a list of underlying securities with associated reference data tied to a given company identifier.
802
802
  # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
803
803
  # @param [Hash] opts the optional parameters
804
804
  # @option opts [String] :next_page Gets the next page of data from a previous API call
@@ -809,7 +809,7 @@ module Intrinio
809
809
  end
810
810
 
811
811
  # All Securities by Company
812
- # Returns Securities for the Company with the given &#x60;identifier&#x60;
812
+ # Returns a list of underlying securities with associated reference data tied to a given company identifier.
813
813
  # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
814
814
  # @param [Hash] opts the optional parameters
815
815
  # @option opts [String] :next_page Gets the next page of data from a previous API call
@@ -1124,7 +1124,7 @@ module Intrinio
1124
1124
  end
1125
1125
 
1126
1126
  # Search Companies
1127
- # Searches for Companies matching the text `query`
1127
+ # Search the companies database and return a list of companies matching the text query parameter passed through. Query parameter searches across the company ticker and name.
1128
1128
  # @param query Search parameters
1129
1129
  # @param [Hash] opts the optional parameters
1130
1130
  # @option opts [BOOLEAN] :active When true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded.
@@ -1136,7 +1136,7 @@ module Intrinio
1136
1136
  end
1137
1137
 
1138
1138
  # Search Companies
1139
- # Searches for Companies matching the text &#x60;query&#x60;
1139
+ # Search the companies database and return a list of companies matching the text query parameter passed through. Query parameter searches across the company ticker and name.
1140
1140
  # @param query Search parameters
1141
1141
  # @param [Hash] opts the optional parameters
1142
1142
  # @option opts [BOOLEAN] :active When true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded.
@@ -1188,7 +1188,7 @@ module Intrinio
1188
1188
  end
1189
1189
 
1190
1190
  # Shares Outstanding by Company
1191
- # Returns shares outstanding for the Company with the given `identifier`
1191
+ # Returns the shares outstanding reported on the front cover of the SEC 10-K and 10-Q filings.
1192
1192
  # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
1193
1193
  # @param [Hash] opts the optional parameters
1194
1194
  # @return [ApiResponseCompanySharesOutstanding]
@@ -1198,7 +1198,7 @@ module Intrinio
1198
1198
  end
1199
1199
 
1200
1200
  # Shares Outstanding by Company
1201
- # Returns shares outstanding for the Company with the given &#x60;identifier&#x60;
1201
+ # Returns the shares outstanding reported on the front cover of the SEC 10-K and 10-Q filings.
1202
1202
  # @param identifier A Company identifier (Ticker, CIK, LEI, Intrinio ID)
1203
1203
  # @param [Hash] opts the optional parameters
1204
1204
  # @return [Array<(ApiResponseCompanySharesOutstanding, Fixnum, Hash)>] ApiResponseCompanySharesOutstanding data, response status code and response headers
@@ -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.27.5
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
@@ -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.27.5
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
@@ -0,0 +1,209 @@
1
+ =begin
2
+ #Intrinio API
3
+
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
+
6
+ OpenAPI spec version: 2.28.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: unset
10
+
11
+ =end
12
+
13
+ require "uri"
14
+
15
+ module Intrinio
16
+ class ESGApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+
23
+ # ESG Companies
24
+ #
25
+ # @param [Hash] opts the optional parameters
26
+ # @option opts [String] :country
27
+ # @option opts [Integer] :page_size The number of results to return (default to 100)
28
+ # @option opts [String] :next_page Gets the next page of data from a previous API call
29
+ # @return [ApiResponseESGCompanies]
30
+ def get_esg_companies(opts = {})
31
+ data, _status_code, _headers = get_esg_companies_with_http_info(opts)
32
+ return data
33
+ end
34
+
35
+ # ESG Companies
36
+ #
37
+ # @param [Hash] opts the optional parameters
38
+ # @option opts [String] :country
39
+ # @option opts [Integer] :page_size The number of results to return
40
+ # @option opts [String] :next_page Gets the next page of data from a previous API call
41
+ # @return [Array<(ApiResponseESGCompanies, Fixnum, Hash)>] ApiResponseESGCompanies data, response status code and response headers
42
+ def get_esg_companies_with_http_info(opts = {})
43
+ if @api_client.config.debugging
44
+ @api_client.config.logger.debug "Calling API: ESGApi.get_esg_companies ..."
45
+ end
46
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
47
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ESGApi.get_esg_companies, must be smaller than or equal to 10000.'
48
+ end
49
+
50
+ # resource path
51
+ local_var_path = "/esg/companies"
52
+
53
+ # query parameters
54
+ query_params = {}
55
+ query_params[:'country'] = opts[:'country'] if !opts[:'country'].nil?
56
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
57
+ query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
58
+
59
+ # header parameters
60
+ header_params = {}
61
+ # HTTP header 'Accept' (if needed)
62
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
63
+
64
+ # form parameters
65
+ form_params = {}
66
+
67
+ # http body (model)
68
+ post_body = nil
69
+ auth_names = ['ApiKeyAuth']
70
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
71
+ :header_params => header_params,
72
+ :query_params => query_params,
73
+ :form_params => form_params,
74
+ :body => post_body,
75
+ :auth_names => auth_names,
76
+ :return_type => 'ApiResponseESGCompanies')
77
+ if @api_client.config.debugging
78
+ @api_client.config.logger.debug "API called: ESGApi#get_esg_companies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
79
+ end
80
+ return data, status_code, headers
81
+ end
82
+
83
+ # ESG Company Ratings History
84
+ #
85
+ # @param identifier ISIN, Intrinio ID, or Ticker
86
+ # @param [Hash] opts the optional parameters
87
+ # @option opts [Integer] :page_size The number of results to return (default to 100)
88
+ # @option opts [String] :next_page Gets the next page of data from a previous API call
89
+ # @return [ApiResponseESGCompanyRatingHistory]
90
+ def get_esg_company_ratings(identifier, opts = {})
91
+ data, _status_code, _headers = get_esg_company_ratings_with_http_info(identifier, opts)
92
+ return data
93
+ end
94
+
95
+ # ESG Company Ratings History
96
+ #
97
+ # @param identifier ISIN, Intrinio ID, or Ticker
98
+ # @param [Hash] opts the optional parameters
99
+ # @option opts [Integer] :page_size The number of results to return
100
+ # @option opts [String] :next_page Gets the next page of data from a previous API call
101
+ # @return [Array<(ApiResponseESGCompanyRatingHistory, Fixnum, Hash)>] ApiResponseESGCompanyRatingHistory data, response status code and response headers
102
+ def get_esg_company_ratings_with_http_info(identifier, opts = {})
103
+ if @api_client.config.debugging
104
+ @api_client.config.logger.debug "Calling API: ESGApi.get_esg_company_ratings ..."
105
+ end
106
+ # verify the required parameter 'identifier' is set
107
+ if @api_client.config.client_side_validation && identifier.nil?
108
+ fail ArgumentError, "Missing the required parameter 'identifier' when calling ESGApi.get_esg_company_ratings"
109
+ end
110
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
111
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ESGApi.get_esg_company_ratings, must be smaller than or equal to 10000.'
112
+ end
113
+
114
+ # resource path
115
+ local_var_path = "/esg/{identifier}".sub('{' + 'identifier' + '}', identifier.to_s)
116
+
117
+ # query parameters
118
+ query_params = {}
119
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
120
+ query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
121
+
122
+ # header parameters
123
+ header_params = {}
124
+ # HTTP header 'Accept' (if needed)
125
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
126
+
127
+ # form parameters
128
+ form_params = {}
129
+
130
+ # http body (model)
131
+ post_body = nil
132
+ auth_names = ['ApiKeyAuth']
133
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
134
+ :header_params => header_params,
135
+ :query_params => query_params,
136
+ :form_params => form_params,
137
+ :body => post_body,
138
+ :auth_names => auth_names,
139
+ :return_type => 'ApiResponseESGCompanyRatingHistory')
140
+ if @api_client.config.debugging
141
+ @api_client.config.logger.debug "API called: ESGApi#get_esg_company_ratings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
142
+ end
143
+ return data, status_code, headers
144
+ end
145
+
146
+ # ESG Latest
147
+ #
148
+ # @param [Hash] opts the optional parameters
149
+ # @option opts [String] :country
150
+ # @option opts [String] :country2
151
+ # @option opts [Integer] :page_size The number of results to return (default to 100)
152
+ # @option opts [String] :next_page Gets the next page of data from a previous API call
153
+ # @return [ApiResponseESGLatest]
154
+ def get_esg_latest(opts = {})
155
+ data, _status_code, _headers = get_esg_latest_with_http_info(opts)
156
+ return data
157
+ end
158
+
159
+ # ESG Latest
160
+ #
161
+ # @param [Hash] opts the optional parameters
162
+ # @option opts [String] :country
163
+ # @option opts [String] :country2
164
+ # @option opts [Integer] :page_size The number of results to return
165
+ # @option opts [String] :next_page Gets the next page of data from a previous API call
166
+ # @return [Array<(ApiResponseESGLatest, Fixnum, Hash)>] ApiResponseESGLatest data, response status code and response headers
167
+ def get_esg_latest_with_http_info(opts = {})
168
+ if @api_client.config.debugging
169
+ @api_client.config.logger.debug "Calling API: ESGApi.get_esg_latest ..."
170
+ end
171
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
172
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ESGApi.get_esg_latest, must be smaller than or equal to 10000.'
173
+ end
174
+
175
+ # resource path
176
+ local_var_path = "/esg"
177
+
178
+ # query parameters
179
+ query_params = {}
180
+ query_params[:'country'] = opts[:'country'] if !opts[:'country'].nil?
181
+ query_params[:'country'] = opts[:'country2'] if !opts[:'country2'].nil?
182
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
183
+ query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
184
+
185
+ # header parameters
186
+ header_params = {}
187
+ # HTTP header 'Accept' (if needed)
188
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
189
+
190
+ # form parameters
191
+ form_params = {}
192
+
193
+ # http body (model)
194
+ post_body = nil
195
+ auth_names = ['ApiKeyAuth']
196
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
197
+ :header_params => header_params,
198
+ :query_params => query_params,
199
+ :form_params => form_params,
200
+ :body => post_body,
201
+ :auth_names => auth_names,
202
+ :return_type => 'ApiResponseESGLatest')
203
+ if @api_client.config.debugging
204
+ @api_client.config.logger.debug "API called: ESGApi#get_esg_latest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
205
+ end
206
+ return data, status_code, headers
207
+ end
208
+ end
209
+ end
@@ -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.27.5
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
@@ -21,7 +21,7 @@ module Intrinio
21
21
  end
22
22
 
23
23
  # All ETFs
24
- # Returns a list of Exchange Traded Funds (ETFs) sourced from FirstBridge
24
+ # 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.
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @option opts [String] :exchange
27
27
  # @option opts [Integer] :page_size The number of results to return (default to 100)
@@ -33,7 +33,7 @@ module Intrinio
33
33
  end
34
34
 
35
35
  # All ETFs
36
- # Returns a list of Exchange Traded Funds (ETFs) sourced from FirstBridge
36
+ # 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.
37
37
  # @param [Hash] opts the optional parameters
38
38
  # @option opts [String] :exchange
39
39
  # @option opts [Integer] :page_size The number of results to return
@@ -81,7 +81,7 @@ module Intrinio
81
81
  end
82
82
 
83
83
  # Lookup ETF
84
- # Returns the Exchange Traded Fund (ETF) with the given identifier
84
+ # 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.
85
85
  # @param identifier An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)
86
86
  # @param [Hash] opts the optional parameters
87
87
  # @return [ETF]
@@ -91,7 +91,7 @@ module Intrinio
91
91
  end
92
92
 
93
93
  # Lookup ETF
94
- # Returns the Exchange Traded Fund (ETF) with the given identifier
94
+ # 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.
95
95
  # @param identifier An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)
96
96
  # @param [Hash] opts the optional parameters
97
97
  # @return [Array<(ETF, Fixnum, Hash)>] ETF data, response status code and response headers
@@ -134,7 +134,7 @@ module Intrinio
134
134
  end
135
135
 
136
136
  # ETF Analytics
137
- # Returns analytics for the Exchange Traded Fund (ETF) including volume, market cap, 52 week high, and 52 week low
137
+ # Returns latest market analytics for a specified US ETF, including volume, trailing volumen, market cap, 52 week high, and 52 week low.
138
138
  # @param identifier An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)
139
139
  # @param [Hash] opts the optional parameters
140
140
  # @return [ETFAnalytics]
@@ -144,7 +144,7 @@ module Intrinio
144
144
  end
145
145
 
146
146
  # ETF Analytics
147
- # Returns analytics for the Exchange Traded Fund (ETF) including volume, market cap, 52 week high, and 52 week low
147
+ # Returns latest market analytics for a specified US ETF, including volume, trailing volumen, market cap, 52 week high, and 52 week low.
148
148
  # @param identifier An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)
149
149
  # @param [Hash] opts the optional parameters
150
150
  # @return [Array<(ETFAnalytics, Fixnum, Hash)>] ETFAnalytics data, response status code and response headers
@@ -187,7 +187,7 @@ module Intrinio
187
187
  end
188
188
 
189
189
  # ETF Holdings
190
- # Returns the holdings sorted by weight descending and the Exchange Traded Fund (ETF) summary
190
+ # 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.
191
191
  # @param identifier An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)
192
192
  # @param [Hash] opts the optional parameters
193
193
  # @option opts [Integer] :page_size The number of results to return (default to 100)
@@ -199,7 +199,7 @@ module Intrinio
199
199
  end
200
200
 
201
201
  # ETF Holdings
202
- # Returns the holdings sorted by weight descending and the Exchange Traded Fund (ETF) summary
202
+ # 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.
203
203
  # @param identifier An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)
204
204
  # @param [Hash] opts the optional parameters
205
205
  # @option opts [Integer] :page_size The number of results to return
@@ -250,7 +250,7 @@ module Intrinio
250
250
  end
251
251
 
252
252
  # Exchange Traded Fund (ETF) stats
253
- # Returns daily stats for the Exchange Traded Fund (ETF) including net asset value, beta vs spy, returns, and volatility
253
+ # Returns comprehensive key US ETF performance statistics, including prices, NAVs, flows, returns, and much more for both trailing and calendar year periods.
254
254
  # @param identifier An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)
255
255
  # @param [Hash] opts the optional parameters
256
256
  # @return [ETFStats]
@@ -260,7 +260,7 @@ module Intrinio
260
260
  end
261
261
 
262
262
  # Exchange Traded Fund (ETF) stats
263
- # Returns daily stats for the Exchange Traded Fund (ETF) including net asset value, beta vs spy, returns, and volatility
263
+ # Returns comprehensive key US ETF performance statistics, including prices, NAVs, flows, returns, and much more for both trailing and calendar year periods.
264
264
  # @param identifier An ETF identifier (Ticker, Figi Ticker, ISIN, RIC, Intrinio ID)
265
265
  # @param [Hash] opts the optional parameters
266
266
  # @return [Array<(ETFStats, Fixnum, Hash)>] ETFStats data, response status code and response headers
@@ -303,7 +303,7 @@ module Intrinio
303
303
  end
304
304
 
305
305
  # Search ETFs
306
- # Searches for Exchange Traded Funds (ETFs) matching the text `query`
306
+ # Accepts a string of keyword combinations, and searches across the ETF name and ticker and returns a list of ETFs with related keywords.
307
307
  # @param query
308
308
  # @param [Hash] opts the optional parameters
309
309
  # @return [ApiResponseETFs]
@@ -313,7 +313,7 @@ module Intrinio
313
313
  end
314
314
 
315
315
  # Search ETFs
316
- # Searches for Exchange Traded Funds (ETFs) matching the text &#x60;query&#x60;
316
+ # Accepts a string of keyword combinations, and searches across the ETF name and ticker and returns a list of ETFs with related keywords.
317
317
  # @param query
318
318
  # @param [Hash] opts the optional parameters
319
319
  # @return [Array<(ApiResponseETFs, Fixnum, Hash)>] ApiResponseETFs data, response status code and response headers