intrinio-sdk 5.19.0 → 6.21.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (597) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +16 -16
  3. data/README.md +26 -2
  4. data/docs/ApiResponseESGCompanies.md +24 -0
  5. data/docs/ApiResponseESGCompanyComprehensiveRatingHistory.md +28 -0
  6. data/docs/ApiResponseESGCompanyRatingHistory.md +28 -0
  7. data/docs/ApiResponseESGLatest.md +24 -0
  8. data/docs/ApiResponseESGLatestComprehensive.md +24 -0
  9. data/docs/CompanyApi.md +17 -15
  10. data/docs/ESGApi.md +432 -0
  11. data/docs/ESGCompanySummary.md +25 -0
  12. data/docs/ESGComprehensiveRating.md +58 -0
  13. data/docs/ESGComprehensiveRatingWithCompany.md +62 -0
  14. data/docs/ESGRating.md +24 -0
  15. data/docs/ESGRatingWithCompany.md +28 -0
  16. data/docs/ETFsApi.md +6 -6
  17. data/docs/FilingApi.md +10 -8
  18. data/docs/FundamentalsApi.md +103 -4
  19. data/docs/IndexApi.md +5 -3
  20. data/docs/InsiderTransactionFiling.md +3 -0
  21. data/docs/OptionChainEod.md +1 -1
  22. data/docs/OptionSnapshotGroup.md +21 -0
  23. data/docs/OptionSnapshotsResult.md +23 -0
  24. data/docs/OptionStatsRealtime.md +1 -0
  25. data/docs/OptionsApi.md +290 -13
  26. data/docs/OwnersApi.md +2 -2
  27. data/docs/SecurityApi.md +115 -34
  28. data/docs/SecuritySnapshotGroup.md +21 -0
  29. data/docs/SecuritySnapshotsResult.md +23 -0
  30. data/docs/TechnicalApi.md +31 -31
  31. data/intrinio-sdk.gemspec +1 -1
  32. data/lib/intrinio-sdk/api/bulk_downloads_api.rb +1 -1
  33. data/lib/intrinio-sdk/api/company_api.rb +36 -30
  34. data/lib/intrinio-sdk/api/data_point_api.rb +1 -1
  35. data/lib/intrinio-sdk/api/data_tag_api.rb +1 -1
  36. data/lib/intrinio-sdk/api/esg_api.rb +335 -0
  37. data/lib/intrinio-sdk/api/et_fs_api.rb +13 -13
  38. data/lib/intrinio-sdk/api/filing_api.rb +19 -23
  39. data/lib/intrinio-sdk/api/forex_api.rb +1 -1
  40. data/lib/intrinio-sdk/api/fundamentals_api.rb +95 -9
  41. data/lib/intrinio-sdk/api/historical_data_api.rb +1 -1
  42. data/lib/intrinio-sdk/api/index_api.rb +11 -11
  43. data/lib/intrinio-sdk/api/insider_transaction_filings_api.rb +1 -1
  44. data/lib/intrinio-sdk/api/municipality_api.rb +1 -1
  45. data/lib/intrinio-sdk/api/options_api.rb +252 -25
  46. data/lib/intrinio-sdk/api/owners_api.rb +3 -3
  47. data/lib/intrinio-sdk/api/security_api.rb +119 -69
  48. data/lib/intrinio-sdk/api/stock_exchange_api.rb +1 -1
  49. data/lib/intrinio-sdk/api/technical_api.rb +63 -63
  50. data/lib/intrinio-sdk/api/zacks_api.rb +1 -1
  51. data/lib/intrinio-sdk/api_client.rb +1 -1
  52. data/lib/intrinio-sdk/api_error.rb +1 -1
  53. data/lib/intrinio-sdk/configuration.rb +1 -1
  54. data/lib/intrinio-sdk/models/accumulation_distribution_index_technical_value.rb +1 -1
  55. data/lib/intrinio-sdk/models/api_response_bulk_download_links.rb +1 -1
  56. data/lib/intrinio-sdk/models/api_response_companies.rb +1 -1
  57. data/lib/intrinio-sdk/models/api_response_companies_search.rb +1 -1
  58. data/lib/intrinio-sdk/models/api_response_company_answers.rb +1 -1
  59. data/lib/intrinio-sdk/models/api_response_company_filings.rb +1 -1
  60. data/lib/intrinio-sdk/models/api_response_company_fundamentals.rb +1 -1
  61. data/lib/intrinio-sdk/models/api_response_company_historical_data.rb +1 -1
  62. data/lib/intrinio-sdk/models/api_response_company_insider_transaction_filings.rb +1 -1
  63. data/lib/intrinio-sdk/models/api_response_company_news.rb +1 -1
  64. data/lib/intrinio-sdk/models/api_response_company_recognize.rb +1 -1
  65. data/lib/intrinio-sdk/models/api_response_company_securities.rb +1 -1
  66. data/lib/intrinio-sdk/models/api_response_company_shares_outstanding.rb +1 -1
  67. data/lib/intrinio-sdk/models/api_response_data_tags.rb +1 -1
  68. data/lib/intrinio-sdk/models/api_response_data_tags_search.rb +1 -1
  69. data/lib/intrinio-sdk/models/api_response_economic_index_historical_data.rb +1 -1
  70. data/lib/intrinio-sdk/models/api_response_economic_indices.rb +1 -1
  71. data/lib/intrinio-sdk/models/api_response_economic_indices_search.rb +1 -1
  72. data/lib/intrinio-sdk/models/api_response_esg_companies.rb +200 -0
  73. data/lib/intrinio-sdk/models/api_response_esg_company_comprehensive_rating_history.rb +209 -0
  74. data/lib/intrinio-sdk/models/api_response_esg_company_rating_history.rb +209 -0
  75. data/lib/intrinio-sdk/models/api_response_esg_latest.rb +200 -0
  76. data/lib/intrinio-sdk/models/api_response_esg_latest_comprehensive.rb +200 -0
  77. data/lib/intrinio-sdk/models/api_response_et_fs.rb +1 -1
  78. data/lib/intrinio-sdk/models/api_response_etf_holdings.rb +1 -1
  79. data/lib/intrinio-sdk/models/api_response_filing_answers.rb +1 -1
  80. data/lib/intrinio-sdk/models/api_response_filing_fundamentals.rb +1 -1
  81. data/lib/intrinio-sdk/models/api_response_filing_notes.rb +1 -1
  82. data/lib/intrinio-sdk/models/api_response_filing_notes_search.rb +1 -1
  83. data/lib/intrinio-sdk/models/api_response_filings.rb +1 -1
  84. data/lib/intrinio-sdk/models/api_response_forex_currencies.rb +1 -1
  85. data/lib/intrinio-sdk/models/api_response_forex_pairs.rb +1 -1
  86. data/lib/intrinio-sdk/models/api_response_forex_prices.rb +1 -1
  87. data/lib/intrinio-sdk/models/api_response_historical_data.rb +1 -1
  88. data/lib/intrinio-sdk/models/api_response_initial_public_offerings.rb +1 -1
  89. data/lib/intrinio-sdk/models/api_response_insider_transaction_filings.rb +1 -1
  90. data/lib/intrinio-sdk/models/api_response_municipalities.rb +1 -1
  91. data/lib/intrinio-sdk/models/api_response_municipalitiy_financials.rb +1 -1
  92. data/lib/intrinio-sdk/models/api_response_news.rb +1 -1
  93. data/lib/intrinio-sdk/models/api_response_option_prices.rb +1 -1
  94. data/lib/intrinio-sdk/models/api_response_options.rb +1 -1
  95. data/lib/intrinio-sdk/models/api_response_options_chain.rb +1 -1
  96. data/lib/intrinio-sdk/models/api_response_options_chain_eod.rb +1 -1
  97. data/lib/intrinio-sdk/models/api_response_options_chain_realtime.rb +1 -1
  98. data/lib/intrinio-sdk/models/api_response_options_expirations.rb +1 -1
  99. data/lib/intrinio-sdk/models/api_response_options_price_realtime.rb +1 -1
  100. data/lib/intrinio-sdk/models/api_response_options_prices_batch_realtime.rb +1 -1
  101. data/lib/intrinio-sdk/models/api_response_options_prices_eod.rb +1 -1
  102. data/lib/intrinio-sdk/models/api_response_options_realtime.rb +1 -1
  103. data/lib/intrinio-sdk/models/api_response_options_stats_realtime.rb +1 -1
  104. data/lib/intrinio-sdk/models/api_response_options_tickers.rb +1 -1
  105. data/lib/intrinio-sdk/models/api_response_options_unusual_activity.rb +1 -1
  106. data/lib/intrinio-sdk/models/api_response_owner_insider_transaction_filings.rb +1 -1
  107. data/lib/intrinio-sdk/models/api_response_owner_institutional_holdings.rb +1 -1
  108. data/lib/intrinio-sdk/models/api_response_owners.rb +1 -1
  109. data/lib/intrinio-sdk/models/api_response_reported_financials.rb +1 -1
  110. data/lib/intrinio-sdk/models/api_response_securities.rb +1 -1
  111. data/lib/intrinio-sdk/models/api_response_securities_search.rb +1 -1
  112. data/lib/intrinio-sdk/models/api_response_security_accumulation_distribution_index.rb +1 -1
  113. data/lib/intrinio-sdk/models/api_response_security_average_daily_trading_volume.rb +1 -1
  114. data/lib/intrinio-sdk/models/api_response_security_average_directional_index.rb +1 -1
  115. data/lib/intrinio-sdk/models/api_response_security_average_true_range.rb +1 -1
  116. data/lib/intrinio-sdk/models/api_response_security_awesome_oscillator.rb +1 -1
  117. data/lib/intrinio-sdk/models/api_response_security_bollinger_bands.rb +1 -1
  118. data/lib/intrinio-sdk/models/api_response_security_chaikin_money_flow.rb +1 -1
  119. data/lib/intrinio-sdk/models/api_response_security_commodity_channel_index.rb +1 -1
  120. data/lib/intrinio-sdk/models/api_response_security_detrended_price_oscillator.rb +1 -1
  121. data/lib/intrinio-sdk/models/api_response_security_donchian_channel.rb +1 -1
  122. data/lib/intrinio-sdk/models/api_response_security_ease_of_movement.rb +1 -1
  123. data/lib/intrinio-sdk/models/api_response_security_force_index.rb +1 -1
  124. data/lib/intrinio-sdk/models/api_response_security_historical_data.rb +1 -1
  125. data/lib/intrinio-sdk/models/api_response_security_ichimoku_kinko_hyo.rb +1 -1
  126. data/lib/intrinio-sdk/models/api_response_security_institutional_ownership.rb +1 -1
  127. data/lib/intrinio-sdk/models/api_response_security_interval_prices.rb +1 -1
  128. data/lib/intrinio-sdk/models/api_response_security_intraday_prices.rb +1 -1
  129. data/lib/intrinio-sdk/models/api_response_security_keltner_channel.rb +1 -1
  130. data/lib/intrinio-sdk/models/api_response_security_know_sure_thing.rb +1 -1
  131. data/lib/intrinio-sdk/models/api_response_security_mass_index.rb +1 -1
  132. data/lib/intrinio-sdk/models/api_response_security_money_flow_index.rb +1 -1
  133. data/lib/intrinio-sdk/models/api_response_security_moving_average_convergence_divergence.rb +1 -1
  134. data/lib/intrinio-sdk/models/api_response_security_negative_volume_index.rb +1 -1
  135. data/lib/intrinio-sdk/models/api_response_security_on_balance_volume.rb +1 -1
  136. data/lib/intrinio-sdk/models/api_response_security_on_balance_volume_mean.rb +1 -1
  137. data/lib/intrinio-sdk/models/api_response_security_relative_strength_index.rb +1 -1
  138. data/lib/intrinio-sdk/models/api_response_security_simple_moving_average.rb +1 -1
  139. data/lib/intrinio-sdk/models/api_response_security_stochastic_oscillator.rb +1 -1
  140. data/lib/intrinio-sdk/models/api_response_security_stock_price_adjustments.rb +1 -1
  141. data/lib/intrinio-sdk/models/api_response_security_stock_prices.rb +1 -1
  142. data/lib/intrinio-sdk/models/api_response_security_triple_exponential_average.rb +1 -1
  143. data/lib/intrinio-sdk/models/api_response_security_true_strength_index.rb +1 -1
  144. data/lib/intrinio-sdk/models/api_response_security_ultimate_oscillator.rb +1 -1
  145. data/lib/intrinio-sdk/models/api_response_security_volume_price_trend.rb +1 -1
  146. data/lib/intrinio-sdk/models/api_response_security_volume_weighted_average_price.rb +1 -1
  147. data/lib/intrinio-sdk/models/api_response_security_vortex_indicator.rb +1 -1
  148. data/lib/intrinio-sdk/models/api_response_security_williams_r.rb +1 -1
  149. data/lib/intrinio-sdk/models/api_response_security_zacks_analyst_ratings.rb +1 -1
  150. data/lib/intrinio-sdk/models/api_response_security_zacks_analyst_ratings_snapshot.rb +1 -1
  151. data/lib/intrinio-sdk/models/api_response_security_zacks_eps_surprises.rb +1 -1
  152. data/lib/intrinio-sdk/models/api_response_security_zacks_sales_surprises.rb +1 -1
  153. data/lib/intrinio-sdk/models/api_response_sic_index_historical_data.rb +1 -1
  154. data/lib/intrinio-sdk/models/api_response_sic_indices.rb +1 -1
  155. data/lib/intrinio-sdk/models/api_response_sic_indices_search.rb +1 -1
  156. data/lib/intrinio-sdk/models/api_response_standardized_financials.rb +1 -1
  157. data/lib/intrinio-sdk/models/api_response_standardized_financials_dimensions.rb +1 -1
  158. data/lib/intrinio-sdk/models/api_response_stock_exchange_realtime_stock_prices.rb +1 -1
  159. data/lib/intrinio-sdk/models/api_response_stock_exchange_securities.rb +1 -1
  160. data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_price_adjustments.rb +1 -1
  161. data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_prices.rb +1 -1
  162. data/lib/intrinio-sdk/models/api_response_stock_exchanges.rb +1 -1
  163. data/lib/intrinio-sdk/models/api_response_stock_market_index_historical_data.rb +1 -1
  164. data/lib/intrinio-sdk/models/api_response_stock_market_indices.rb +1 -1
  165. data/lib/intrinio-sdk/models/api_response_stock_market_indices_search.rb +1 -1
  166. data/lib/intrinio-sdk/models/api_response_zacks_analyst_ratings.rb +1 -1
  167. data/lib/intrinio-sdk/models/api_response_zacks_eps_estimates.rb +1 -1
  168. data/lib/intrinio-sdk/models/api_response_zacks_eps_growth_rates.rb +1 -1
  169. data/lib/intrinio-sdk/models/api_response_zacks_eps_surprises.rb +1 -1
  170. data/lib/intrinio-sdk/models/api_response_zacks_etf_holdings.rb +1 -1
  171. data/lib/intrinio-sdk/models/api_response_zacks_institutional_holding_companies.rb +1 -1
  172. data/lib/intrinio-sdk/models/api_response_zacks_institutional_holding_owners.rb +1 -1
  173. data/lib/intrinio-sdk/models/api_response_zacks_institutional_holdings.rb +1 -1
  174. data/lib/intrinio-sdk/models/api_response_zacks_long_term_growth_rates.rb +1 -1
  175. data/lib/intrinio-sdk/models/api_response_zacks_sales_surprises.rb +1 -1
  176. data/lib/intrinio-sdk/models/api_response_zacks_target_price_consensuses.rb +1 -1
  177. data/lib/intrinio-sdk/models/average_daily_trading_volume_technical_value.rb +1 -1
  178. data/lib/intrinio-sdk/models/average_directional_index_technical_value.rb +1 -1
  179. data/lib/intrinio-sdk/models/average_true_range_technical_value.rb +1 -1
  180. data/lib/intrinio-sdk/models/awesome_oscillator_technical_value.rb +1 -1
  181. data/lib/intrinio-sdk/models/bollinger_bands_technical_value.rb +1 -1
  182. data/lib/intrinio-sdk/models/bulk_download_links.rb +1 -1
  183. data/lib/intrinio-sdk/models/bulk_download_summary.rb +1 -1
  184. data/lib/intrinio-sdk/models/chaikin_money_flow_technical_value.rb +1 -1
  185. data/lib/intrinio-sdk/models/commodity_channel_index_technical_value.rb +1 -1
  186. data/lib/intrinio-sdk/models/company.rb +1 -1
  187. data/lib/intrinio-sdk/models/company_filing.rb +1 -1
  188. data/lib/intrinio-sdk/models/company_initial_public_offering.rb +1 -1
  189. data/lib/intrinio-sdk/models/company_news.rb +1 -1
  190. data/lib/intrinio-sdk/models/company_news_summary.rb +1 -1
  191. data/lib/intrinio-sdk/models/company_shares_outstanding.rb +1 -1
  192. data/lib/intrinio-sdk/models/company_summary.rb +1 -1
  193. data/lib/intrinio-sdk/models/data_tag.rb +1 -1
  194. data/lib/intrinio-sdk/models/data_tag_summary.rb +1 -1
  195. data/lib/intrinio-sdk/models/detrended_price_oscillator_technical_value.rb +1 -1
  196. data/lib/intrinio-sdk/models/dividend_record.rb +1 -1
  197. data/lib/intrinio-sdk/models/donchian_channel_technical_value.rb +1 -1
  198. data/lib/intrinio-sdk/models/earnings_record.rb +1 -1
  199. data/lib/intrinio-sdk/models/ease_of_movement_technical_value.rb +1 -1
  200. data/lib/intrinio-sdk/models/economic_index.rb +1 -1
  201. data/lib/intrinio-sdk/models/economic_index_summary.rb +1 -1
  202. data/lib/intrinio-sdk/models/esg_company_summary.rb +239 -0
  203. data/lib/intrinio-sdk/models/esg_comprehensive_rating.rb +569 -0
  204. data/lib/intrinio-sdk/models/esg_comprehensive_rating_with_company.rb +578 -0
  205. data/lib/intrinio-sdk/models/esg_rating.rb +229 -0
  206. data/lib/intrinio-sdk/models/esg_rating_with_company.rb +238 -0
  207. data/lib/intrinio-sdk/models/etf.rb +1 -1
  208. data/lib/intrinio-sdk/models/etf_analytics.rb +1 -1
  209. data/lib/intrinio-sdk/models/etf_holding.rb +1 -1
  210. data/lib/intrinio-sdk/models/etf_stats.rb +1 -1
  211. data/lib/intrinio-sdk/models/etf_summary.rb +1 -1
  212. data/lib/intrinio-sdk/models/filing.rb +1 -1
  213. data/lib/intrinio-sdk/models/filing_note.rb +1 -1
  214. data/lib/intrinio-sdk/models/filing_note_filing.rb +1 -1
  215. data/lib/intrinio-sdk/models/filing_note_summary.rb +1 -1
  216. data/lib/intrinio-sdk/models/filing_summary.rb +1 -1
  217. data/lib/intrinio-sdk/models/force_index_technical_value.rb +1 -1
  218. data/lib/intrinio-sdk/models/forex_currency.rb +1 -1
  219. data/lib/intrinio-sdk/models/forex_pair.rb +1 -1
  220. data/lib/intrinio-sdk/models/forex_price.rb +1 -1
  221. data/lib/intrinio-sdk/models/fundamental.rb +1 -1
  222. data/lib/intrinio-sdk/models/fundamental_summary.rb +1 -1
  223. data/lib/intrinio-sdk/models/historical_data.rb +1 -1
  224. data/lib/intrinio-sdk/models/ichimoku_kinko_hyo_technical_value.rb +1 -1
  225. data/lib/intrinio-sdk/models/insider_transaction.rb +1 -1
  226. data/lib/intrinio-sdk/models/insider_transaction_filing.rb +32 -2
  227. data/lib/intrinio-sdk/models/institutional_holding.rb +1 -1
  228. data/lib/intrinio-sdk/models/institutional_ownership.rb +1 -1
  229. data/lib/intrinio-sdk/models/intraday_stock_price.rb +1 -1
  230. data/lib/intrinio-sdk/models/keltner_channel_technical_value.rb +1 -1
  231. data/lib/intrinio-sdk/models/know_sure_thing_technical_value.rb +1 -1
  232. data/lib/intrinio-sdk/models/mass_index_technical_value.rb +1 -1
  233. data/lib/intrinio-sdk/models/money_flow_index_technical_value.rb +1 -1
  234. data/lib/intrinio-sdk/models/moving_average_convergence_divergence_technical_value.rb +1 -1
  235. data/lib/intrinio-sdk/models/municipality.rb +1 -1
  236. data/lib/intrinio-sdk/models/municipality_financial.rb +1 -1
  237. data/lib/intrinio-sdk/models/negative_volume_index_technical_value.rb +1 -1
  238. data/lib/intrinio-sdk/models/on_balance_volume_mean_technical_value.rb +1 -1
  239. data/lib/intrinio-sdk/models/on_balance_volume_technical_value.rb +1 -1
  240. data/lib/intrinio-sdk/models/option.rb +1 -1
  241. data/lib/intrinio-sdk/models/option_chain.rb +1 -1
  242. data/lib/intrinio-sdk/models/option_chain_eod.rb +8 -8
  243. data/lib/intrinio-sdk/models/option_chain_realtime.rb +1 -1
  244. data/lib/intrinio-sdk/models/option_contracts_list.rb +1 -1
  245. data/lib/intrinio-sdk/models/option_eod.rb +1 -1
  246. data/lib/intrinio-sdk/models/option_factors_realtime.rb +1 -1
  247. data/lib/intrinio-sdk/models/option_price.rb +1 -1
  248. data/lib/intrinio-sdk/models/option_price_batch_realtime.rb +1 -1
  249. data/lib/intrinio-sdk/models/option_price_eod.rb +1 -1
  250. data/lib/intrinio-sdk/models/option_price_realtime.rb +1 -1
  251. data/lib/intrinio-sdk/models/option_realtime.rb +1 -1
  252. data/lib/intrinio-sdk/models/option_snapshot_group.rb +201 -0
  253. data/lib/intrinio-sdk/models/option_snapshots_result.rb +191 -0
  254. data/lib/intrinio-sdk/models/option_stats_realtime.rb +15 -5
  255. data/lib/intrinio-sdk/models/option_unusual_trade.rb +1 -1
  256. data/lib/intrinio-sdk/models/owner.rb +1 -1
  257. data/lib/intrinio-sdk/models/owner_summary.rb +1 -1
  258. data/lib/intrinio-sdk/models/realtime_stock_price.rb +1 -1
  259. data/lib/intrinio-sdk/models/realtime_stock_price_security.rb +1 -1
  260. data/lib/intrinio-sdk/models/relative_strength_index_technical_value.rb +1 -1
  261. data/lib/intrinio-sdk/models/reported_financial.rb +1 -1
  262. data/lib/intrinio-sdk/models/reported_financial_dimension.rb +1 -1
  263. data/lib/intrinio-sdk/models/reported_tag.rb +1 -1
  264. data/lib/intrinio-sdk/models/security.rb +1 -1
  265. data/lib/intrinio-sdk/models/security_screen_clause.rb +1 -1
  266. data/lib/intrinio-sdk/models/security_screen_group.rb +1 -1
  267. data/lib/intrinio-sdk/models/security_screen_result.rb +1 -1
  268. data/lib/intrinio-sdk/models/security_screen_result_data.rb +1 -1
  269. data/lib/intrinio-sdk/models/security_snapshot_group.rb +201 -0
  270. data/lib/intrinio-sdk/models/security_snapshots_result.rb +191 -0
  271. data/lib/intrinio-sdk/models/security_summary.rb +1 -1
  272. data/lib/intrinio-sdk/models/sic_index.rb +1 -1
  273. data/lib/intrinio-sdk/models/simple_moving_average_technical_value.rb +1 -1
  274. data/lib/intrinio-sdk/models/standardized_financial.rb +1 -1
  275. data/lib/intrinio-sdk/models/standardized_financials_dimension.rb +1 -1
  276. data/lib/intrinio-sdk/models/stochastic_oscillator_technical_value.rb +1 -1
  277. data/lib/intrinio-sdk/models/stock_exchange.rb +1 -1
  278. data/lib/intrinio-sdk/models/stock_market_index.rb +1 -1
  279. data/lib/intrinio-sdk/models/stock_market_index_summary.rb +1 -1
  280. data/lib/intrinio-sdk/models/stock_price.rb +1 -1
  281. data/lib/intrinio-sdk/models/stock_price_adjustment.rb +1 -1
  282. data/lib/intrinio-sdk/models/stock_price_adjustment_summary.rb +1 -1
  283. data/lib/intrinio-sdk/models/stock_price_interval.rb +1 -1
  284. data/lib/intrinio-sdk/models/stock_price_summary.rb +1 -1
  285. data/lib/intrinio-sdk/models/technical_indicator.rb +1 -1
  286. data/lib/intrinio-sdk/models/thea_entity_answer.rb +1 -1
  287. data/lib/intrinio-sdk/models/thea_source_document.rb +1 -1
  288. data/lib/intrinio-sdk/models/triple_exponential_average_technical_value.rb +1 -1
  289. data/lib/intrinio-sdk/models/true_strength_index_technical_value.rb +1 -1
  290. data/lib/intrinio-sdk/models/ultimate_oscillator_technical_value.rb +1 -1
  291. data/lib/intrinio-sdk/models/volume_price_trend_technical_value.rb +1 -1
  292. data/lib/intrinio-sdk/models/volume_weighted_average_price_value.rb +1 -1
  293. data/lib/intrinio-sdk/models/vortex_indicator_technical_value.rb +1 -1
  294. data/lib/intrinio-sdk/models/williams_r_technical_value.rb +1 -1
  295. data/lib/intrinio-sdk/models/zacks_analyst_rating.rb +1 -1
  296. data/lib/intrinio-sdk/models/zacks_analyst_rating_snapshot.rb +1 -1
  297. data/lib/intrinio-sdk/models/zacks_analyst_rating_summary.rb +1 -1
  298. data/lib/intrinio-sdk/models/zacks_eps_estimate.rb +1 -1
  299. data/lib/intrinio-sdk/models/zacks_eps_growth_rate.rb +1 -1
  300. data/lib/intrinio-sdk/models/zacks_eps_surprise.rb +1 -1
  301. data/lib/intrinio-sdk/models/zacks_eps_surprise_summary.rb +1 -1
  302. data/lib/intrinio-sdk/models/zacks_etf_holding.rb +1 -1
  303. data/lib/intrinio-sdk/models/zacks_institutional_holding.rb +1 -1
  304. data/lib/intrinio-sdk/models/zacks_institutional_holding_company_detail.rb +1 -1
  305. data/lib/intrinio-sdk/models/zacks_institutional_holding_company_summary.rb +1 -1
  306. data/lib/intrinio-sdk/models/zacks_institutional_holding_historical_summary.rb +1 -1
  307. data/lib/intrinio-sdk/models/zacks_institutional_holding_owner_detail.rb +1 -1
  308. data/lib/intrinio-sdk/models/zacks_institutional_holding_owner_summary.rb +1 -1
  309. data/lib/intrinio-sdk/models/zacks_long_term_growth_rate.rb +1 -1
  310. data/lib/intrinio-sdk/models/zacks_sales_surprise.rb +1 -1
  311. data/lib/intrinio-sdk/models/zacks_sales_surprise_summary.rb +1 -1
  312. data/lib/intrinio-sdk/models/zacks_target_price_consensus.rb +1 -1
  313. data/lib/intrinio-sdk/version.rb +2 -2
  314. data/lib/intrinio-sdk.rb +16 -1
  315. data/spec/api/bulk_downloads_api_spec.rb +1 -1
  316. data/spec/api/company_api_spec.rb +15 -14
  317. data/spec/api/data_point_api_spec.rb +1 -1
  318. data/spec/api/data_tag_api_spec.rb +1 -1
  319. data/spec/api/esg_api_spec.rb +107 -0
  320. data/spec/api/et_fs_api_spec.rb +7 -7
  321. data/spec/api/filing_api_spec.rb +8 -8
  322. data/spec/api/forex_api_spec.rb +1 -1
  323. data/spec/api/fundamentals_api_spec.rb +26 -5
  324. data/spec/api/historical_data_api_spec.rb +1 -1
  325. data/spec/api/index_api_spec.rb +6 -6
  326. data/spec/api/insider_transaction_filings_api_spec.rb +1 -1
  327. data/spec/api/municipality_api_spec.rb +1 -1
  328. data/spec/api/options_api_spec.rb +66 -13
  329. data/spec/api/owners_api_spec.rb +2 -2
  330. data/spec/api/security_api_spec.rb +47 -35
  331. data/spec/api/stock_exchange_api_spec.rb +1 -1
  332. data/spec/api/technical_api_spec.rb +32 -32
  333. data/spec/api/zacks_api_spec.rb +1 -1
  334. data/spec/api_client_spec.rb +1 -1
  335. data/spec/configuration_spec.rb +1 -1
  336. data/spec/models/accumulation_distribution_index_technical_value_spec.rb +1 -1
  337. data/spec/models/api_response_bulk_download_links_spec.rb +1 -1
  338. data/spec/models/api_response_companies_search_spec.rb +1 -1
  339. data/spec/models/api_response_companies_spec.rb +1 -1
  340. data/spec/models/api_response_company_answers_spec.rb +1 -1
  341. data/spec/models/api_response_company_filings_spec.rb +1 -1
  342. data/spec/models/api_response_company_fundamentals_spec.rb +1 -1
  343. data/spec/models/api_response_company_historical_data_spec.rb +1 -1
  344. data/spec/models/api_response_company_insider_transaction_filings_spec.rb +1 -1
  345. data/spec/models/api_response_company_news_spec.rb +1 -1
  346. data/spec/models/api_response_company_recognize_spec.rb +1 -1
  347. data/spec/models/api_response_company_securities_spec.rb +1 -1
  348. data/spec/models/api_response_company_shares_outstanding_spec.rb +1 -1
  349. data/spec/models/api_response_data_tags_search_spec.rb +1 -1
  350. data/spec/models/api_response_data_tags_spec.rb +1 -1
  351. data/spec/models/api_response_economic_index_historical_data_spec.rb +1 -1
  352. data/spec/models/api_response_economic_indices_search_spec.rb +1 -1
  353. data/spec/models/api_response_economic_indices_spec.rb +1 -1
  354. data/spec/models/api_response_esg_companies_spec.rb +48 -0
  355. data/spec/models/api_response_esg_company_comprehensive_rating_history_spec.rb +54 -0
  356. data/spec/models/api_response_esg_company_rating_history_spec.rb +54 -0
  357. data/spec/models/api_response_esg_latest_comprehensive_spec.rb +48 -0
  358. data/spec/models/api_response_esg_latest_spec.rb +48 -0
  359. data/spec/models/api_response_et_fs_spec.rb +1 -1
  360. data/spec/models/api_response_etf_holdings_spec.rb +1 -1
  361. data/spec/models/api_response_filing_answers_spec.rb +1 -1
  362. data/spec/models/api_response_filing_fundamentals_spec.rb +1 -1
  363. data/spec/models/api_response_filing_notes_search_spec.rb +1 -1
  364. data/spec/models/api_response_filing_notes_spec.rb +1 -1
  365. data/spec/models/api_response_filings_spec.rb +1 -1
  366. data/spec/models/api_response_forex_currencies_spec.rb +1 -1
  367. data/spec/models/api_response_forex_pairs_spec.rb +1 -1
  368. data/spec/models/api_response_forex_prices_spec.rb +1 -1
  369. data/spec/models/api_response_historical_data_spec.rb +1 -1
  370. data/spec/models/api_response_initial_public_offerings_spec.rb +1 -1
  371. data/spec/models/api_response_insider_transaction_filings_spec.rb +1 -1
  372. data/spec/models/api_response_municipalities_spec.rb +1 -1
  373. data/spec/models/api_response_municipalitiy_financials_spec.rb +1 -1
  374. data/spec/models/api_response_news_spec.rb +1 -1
  375. data/spec/models/api_response_option_prices_spec.rb +1 -1
  376. data/spec/models/api_response_options_chain_eod_spec.rb +1 -1
  377. data/spec/models/api_response_options_chain_realtime_spec.rb +1 -1
  378. data/spec/models/api_response_options_chain_spec.rb +1 -1
  379. data/spec/models/api_response_options_expirations_spec.rb +1 -1
  380. data/spec/models/api_response_options_price_realtime_spec.rb +1 -1
  381. data/spec/models/api_response_options_prices_batch_realtime_spec.rb +1 -1
  382. data/spec/models/api_response_options_prices_eod_spec.rb +1 -1
  383. data/spec/models/api_response_options_realtime_spec.rb +1 -1
  384. data/spec/models/api_response_options_spec.rb +1 -1
  385. data/spec/models/api_response_options_stats_realtime_spec.rb +1 -1
  386. data/spec/models/api_response_options_tickers_spec.rb +1 -1
  387. data/spec/models/api_response_options_unusual_activity_spec.rb +1 -1
  388. data/spec/models/api_response_owner_insider_transaction_filings_spec.rb +1 -1
  389. data/spec/models/api_response_owner_institutional_holdings_spec.rb +1 -1
  390. data/spec/models/api_response_owners_spec.rb +1 -1
  391. data/spec/models/api_response_reported_financials_spec.rb +1 -1
  392. data/spec/models/api_response_securities_search_spec.rb +1 -1
  393. data/spec/models/api_response_securities_spec.rb +1 -1
  394. data/spec/models/api_response_security_accumulation_distribution_index_spec.rb +1 -1
  395. data/spec/models/api_response_security_average_daily_trading_volume_spec.rb +1 -1
  396. data/spec/models/api_response_security_average_directional_index_spec.rb +1 -1
  397. data/spec/models/api_response_security_average_true_range_spec.rb +1 -1
  398. data/spec/models/api_response_security_awesome_oscillator_spec.rb +1 -1
  399. data/spec/models/api_response_security_bollinger_bands_spec.rb +1 -1
  400. data/spec/models/api_response_security_chaikin_money_flow_spec.rb +1 -1
  401. data/spec/models/api_response_security_commodity_channel_index_spec.rb +1 -1
  402. data/spec/models/api_response_security_detrended_price_oscillator_spec.rb +1 -1
  403. data/spec/models/api_response_security_donchian_channel_spec.rb +1 -1
  404. data/spec/models/api_response_security_ease_of_movement_spec.rb +1 -1
  405. data/spec/models/api_response_security_force_index_spec.rb +1 -1
  406. data/spec/models/api_response_security_historical_data_spec.rb +1 -1
  407. data/spec/models/api_response_security_ichimoku_kinko_hyo_spec.rb +1 -1
  408. data/spec/models/api_response_security_institutional_ownership_spec.rb +1 -1
  409. data/spec/models/api_response_security_interval_prices_spec.rb +1 -1
  410. data/spec/models/api_response_security_intraday_prices_spec.rb +1 -1
  411. data/spec/models/api_response_security_keltner_channel_spec.rb +1 -1
  412. data/spec/models/api_response_security_know_sure_thing_spec.rb +1 -1
  413. data/spec/models/api_response_security_mass_index_spec.rb +1 -1
  414. data/spec/models/api_response_security_money_flow_index_spec.rb +1 -1
  415. data/spec/models/api_response_security_moving_average_convergence_divergence_spec.rb +1 -1
  416. data/spec/models/api_response_security_negative_volume_index_spec.rb +1 -1
  417. data/spec/models/api_response_security_on_balance_volume_mean_spec.rb +1 -1
  418. data/spec/models/api_response_security_on_balance_volume_spec.rb +1 -1
  419. data/spec/models/api_response_security_relative_strength_index_spec.rb +1 -1
  420. data/spec/models/api_response_security_simple_moving_average_spec.rb +1 -1
  421. data/spec/models/api_response_security_stochastic_oscillator_spec.rb +1 -1
  422. data/spec/models/api_response_security_stock_price_adjustments_spec.rb +1 -1
  423. data/spec/models/api_response_security_stock_prices_spec.rb +1 -1
  424. data/spec/models/api_response_security_triple_exponential_average_spec.rb +1 -1
  425. data/spec/models/api_response_security_true_strength_index_spec.rb +1 -1
  426. data/spec/models/api_response_security_ultimate_oscillator_spec.rb +1 -1
  427. data/spec/models/api_response_security_volume_price_trend_spec.rb +1 -1
  428. data/spec/models/api_response_security_volume_weighted_average_price_spec.rb +1 -1
  429. data/spec/models/api_response_security_vortex_indicator_spec.rb +1 -1
  430. data/spec/models/api_response_security_williams_r_spec.rb +1 -1
  431. data/spec/models/api_response_security_zacks_analyst_ratings_snapshot_spec.rb +1 -1
  432. data/spec/models/api_response_security_zacks_analyst_ratings_spec.rb +1 -1
  433. data/spec/models/api_response_security_zacks_eps_surprises_spec.rb +1 -1
  434. data/spec/models/api_response_security_zacks_sales_surprises_spec.rb +1 -1
  435. data/spec/models/api_response_sic_index_historical_data_spec.rb +1 -1
  436. data/spec/models/api_response_sic_indices_search_spec.rb +1 -1
  437. data/spec/models/api_response_sic_indices_spec.rb +1 -1
  438. data/spec/models/api_response_standardized_financials_dimensions_spec.rb +1 -1
  439. data/spec/models/api_response_standardized_financials_spec.rb +1 -1
  440. data/spec/models/api_response_stock_exchange_realtime_stock_prices_spec.rb +1 -1
  441. data/spec/models/api_response_stock_exchange_securities_spec.rb +1 -1
  442. data/spec/models/api_response_stock_exchange_stock_price_adjustments_spec.rb +1 -1
  443. data/spec/models/api_response_stock_exchange_stock_prices_spec.rb +1 -1
  444. data/spec/models/api_response_stock_exchanges_spec.rb +1 -1
  445. data/spec/models/api_response_stock_market_index_historical_data_spec.rb +1 -1
  446. data/spec/models/api_response_stock_market_indices_search_spec.rb +1 -1
  447. data/spec/models/api_response_stock_market_indices_spec.rb +1 -1
  448. data/spec/models/api_response_zacks_analyst_ratings_spec.rb +1 -1
  449. data/spec/models/api_response_zacks_eps_estimates_spec.rb +1 -1
  450. data/spec/models/api_response_zacks_eps_growth_rates_spec.rb +1 -1
  451. data/spec/models/api_response_zacks_eps_surprises_spec.rb +1 -1
  452. data/spec/models/api_response_zacks_etf_holdings_spec.rb +1 -1
  453. data/spec/models/api_response_zacks_institutional_holding_companies_spec.rb +1 -1
  454. data/spec/models/api_response_zacks_institutional_holding_owners_spec.rb +1 -1
  455. data/spec/models/api_response_zacks_institutional_holdings_spec.rb +1 -1
  456. data/spec/models/api_response_zacks_long_term_growth_rates_spec.rb +1 -1
  457. data/spec/models/api_response_zacks_sales_surprises_spec.rb +1 -1
  458. data/spec/models/api_response_zacks_target_price_consensuses_spec.rb +1 -1
  459. data/spec/models/average_daily_trading_volume_technical_value_spec.rb +1 -1
  460. data/spec/models/average_directional_index_technical_value_spec.rb +1 -1
  461. data/spec/models/average_true_range_technical_value_spec.rb +1 -1
  462. data/spec/models/awesome_oscillator_technical_value_spec.rb +1 -1
  463. data/spec/models/bollinger_bands_technical_value_spec.rb +1 -1
  464. data/spec/models/bulk_download_links_spec.rb +1 -1
  465. data/spec/models/bulk_download_summary_spec.rb +1 -1
  466. data/spec/models/chaikin_money_flow_technical_value_spec.rb +1 -1
  467. data/spec/models/commodity_channel_index_technical_value_spec.rb +1 -1
  468. data/spec/models/company_filing_spec.rb +1 -1
  469. data/spec/models/company_initial_public_offering_spec.rb +1 -1
  470. data/spec/models/company_news_spec.rb +1 -1
  471. data/spec/models/company_news_summary_spec.rb +1 -1
  472. data/spec/models/company_shares_outstanding_spec.rb +1 -1
  473. data/spec/models/company_spec.rb +1 -1
  474. data/spec/models/company_summary_spec.rb +1 -1
  475. data/spec/models/data_tag_spec.rb +1 -1
  476. data/spec/models/data_tag_summary_spec.rb +1 -1
  477. data/spec/models/detrended_price_oscillator_technical_value_spec.rb +1 -1
  478. data/spec/models/dividend_record_spec.rb +1 -1
  479. data/spec/models/donchian_channel_technical_value_spec.rb +1 -1
  480. data/spec/models/earnings_record_spec.rb +1 -1
  481. data/spec/models/ease_of_movement_technical_value_spec.rb +1 -1
  482. data/spec/models/economic_index_spec.rb +1 -1
  483. data/spec/models/economic_index_summary_spec.rb +1 -1
  484. data/spec/models/esg_company_summary_spec.rb +72 -0
  485. data/spec/models/esg_comprehensive_rating_spec.rb +270 -0
  486. data/spec/models/esg_comprehensive_rating_with_company_spec.rb +276 -0
  487. data/spec/models/esg_rating_spec.rb +66 -0
  488. data/spec/models/esg_rating_with_company_spec.rb +72 -0
  489. data/spec/models/etf_analytics_spec.rb +1 -1
  490. data/spec/models/etf_holding_spec.rb +1 -1
  491. data/spec/models/etf_spec.rb +1 -1
  492. data/spec/models/etf_stats_spec.rb +1 -1
  493. data/spec/models/etf_summary_spec.rb +1 -1
  494. data/spec/models/filing_note_filing_spec.rb +1 -1
  495. data/spec/models/filing_note_spec.rb +1 -1
  496. data/spec/models/filing_note_summary_spec.rb +1 -1
  497. data/spec/models/filing_spec.rb +1 -1
  498. data/spec/models/filing_summary_spec.rb +1 -1
  499. data/spec/models/force_index_technical_value_spec.rb +1 -1
  500. data/spec/models/forex_currency_spec.rb +1 -1
  501. data/spec/models/forex_pair_spec.rb +1 -1
  502. data/spec/models/forex_price_spec.rb +1 -1
  503. data/spec/models/fundamental_spec.rb +1 -1
  504. data/spec/models/fundamental_summary_spec.rb +1 -1
  505. data/spec/models/historical_data_spec.rb +1 -1
  506. data/spec/models/ichimoku_kinko_hyo_technical_value_spec.rb +1 -1
  507. data/spec/models/insider_transaction_filing_spec.rb +19 -1
  508. data/spec/models/insider_transaction_spec.rb +1 -1
  509. data/spec/models/institutional_holding_spec.rb +1 -1
  510. data/spec/models/institutional_ownership_spec.rb +1 -1
  511. data/spec/models/intraday_stock_price_spec.rb +1 -1
  512. data/spec/models/keltner_channel_technical_value_spec.rb +1 -1
  513. data/spec/models/know_sure_thing_technical_value_spec.rb +1 -1
  514. data/spec/models/mass_index_technical_value_spec.rb +1 -1
  515. data/spec/models/money_flow_index_technical_value_spec.rb +1 -1
  516. data/spec/models/moving_average_convergence_divergence_technical_value_spec.rb +1 -1
  517. data/spec/models/municipality_financial_spec.rb +1 -1
  518. data/spec/models/municipality_spec.rb +1 -1
  519. data/spec/models/negative_volume_index_technical_value_spec.rb +1 -1
  520. data/spec/models/on_balance_volume_mean_technical_value_spec.rb +1 -1
  521. data/spec/models/on_balance_volume_technical_value_spec.rb +1 -1
  522. data/spec/models/option_chain_eod_spec.rb +2 -2
  523. data/spec/models/option_chain_realtime_spec.rb +1 -1
  524. data/spec/models/option_chain_spec.rb +1 -1
  525. data/spec/models/option_contracts_list_spec.rb +1 -1
  526. data/spec/models/option_eod_spec.rb +1 -1
  527. data/spec/models/option_factors_realtime_spec.rb +1 -1
  528. data/spec/models/option_price_batch_realtime_spec.rb +1 -1
  529. data/spec/models/option_price_eod_spec.rb +1 -1
  530. data/spec/models/option_price_realtime_spec.rb +1 -1
  531. data/spec/models/option_price_spec.rb +1 -1
  532. data/spec/models/option_realtime_spec.rb +1 -1
  533. data/spec/models/option_snapshot_group_spec.rb +48 -0
  534. data/spec/models/option_snapshots_result_spec.rb +42 -0
  535. data/spec/models/option_spec.rb +1 -1
  536. data/spec/models/option_stats_realtime_spec.rb +7 -1
  537. data/spec/models/option_unusual_trade_spec.rb +1 -1
  538. data/spec/models/owner_spec.rb +1 -1
  539. data/spec/models/owner_summary_spec.rb +1 -1
  540. data/spec/models/realtime_stock_price_security_spec.rb +1 -1
  541. data/spec/models/realtime_stock_price_spec.rb +1 -1
  542. data/spec/models/relative_strength_index_technical_value_spec.rb +1 -1
  543. data/spec/models/reported_financial_dimension_spec.rb +1 -1
  544. data/spec/models/reported_financial_spec.rb +1 -1
  545. data/spec/models/reported_tag_spec.rb +1 -1
  546. data/spec/models/security_screen_clause_spec.rb +1 -1
  547. data/spec/models/security_screen_group_spec.rb +1 -1
  548. data/spec/models/security_screen_result_data_spec.rb +1 -1
  549. data/spec/models/security_screen_result_spec.rb +1 -1
  550. data/spec/models/security_snapshot_group_spec.rb +48 -0
  551. data/spec/models/security_snapshots_result_spec.rb +42 -0
  552. data/spec/models/security_spec.rb +1 -1
  553. data/spec/models/security_summary_spec.rb +1 -1
  554. data/spec/models/sic_index_spec.rb +1 -1
  555. data/spec/models/simple_moving_average_technical_value_spec.rb +1 -1
  556. data/spec/models/standardized_financial_spec.rb +1 -1
  557. data/spec/models/standardized_financials_dimension_spec.rb +1 -1
  558. data/spec/models/stochastic_oscillator_technical_value_spec.rb +1 -1
  559. data/spec/models/stock_exchange_spec.rb +1 -1
  560. data/spec/models/stock_market_index_spec.rb +1 -1
  561. data/spec/models/stock_market_index_summary_spec.rb +1 -1
  562. data/spec/models/stock_price_adjustment_spec.rb +1 -1
  563. data/spec/models/stock_price_adjustment_summary_spec.rb +1 -1
  564. data/spec/models/stock_price_interval_spec.rb +1 -1
  565. data/spec/models/stock_price_spec.rb +1 -1
  566. data/spec/models/stock_price_summary_spec.rb +1 -1
  567. data/spec/models/technical_indicator_spec.rb +1 -1
  568. data/spec/models/thea_entity_answer_spec.rb +1 -1
  569. data/spec/models/thea_source_document_spec.rb +1 -1
  570. data/spec/models/triple_exponential_average_technical_value_spec.rb +1 -1
  571. data/spec/models/true_strength_index_technical_value_spec.rb +1 -1
  572. data/spec/models/ultimate_oscillator_technical_value_spec.rb +1 -1
  573. data/spec/models/volume_price_trend_technical_value_spec.rb +1 -1
  574. data/spec/models/volume_weighted_average_price_value_spec.rb +1 -1
  575. data/spec/models/vortex_indicator_technical_value_spec.rb +1 -1
  576. data/spec/models/williams_r_technical_value_spec.rb +1 -1
  577. data/spec/models/zacks_analyst_rating_snapshot_spec.rb +1 -1
  578. data/spec/models/zacks_analyst_rating_spec.rb +1 -1
  579. data/spec/models/zacks_analyst_rating_summary_spec.rb +1 -1
  580. data/spec/models/zacks_eps_estimate_spec.rb +1 -1
  581. data/spec/models/zacks_eps_growth_rate_spec.rb +1 -1
  582. data/spec/models/zacks_eps_surprise_spec.rb +1 -1
  583. data/spec/models/zacks_eps_surprise_summary_spec.rb +1 -1
  584. data/spec/models/zacks_etf_holding_spec.rb +1 -1
  585. data/spec/models/zacks_institutional_holding_company_detail_spec.rb +1 -1
  586. data/spec/models/zacks_institutional_holding_company_summary_spec.rb +1 -1
  587. data/spec/models/zacks_institutional_holding_historical_summary_spec.rb +1 -1
  588. data/spec/models/zacks_institutional_holding_owner_detail_spec.rb +1 -1
  589. data/spec/models/zacks_institutional_holding_owner_summary_spec.rb +1 -1
  590. data/spec/models/zacks_institutional_holding_spec.rb +1 -1
  591. data/spec/models/zacks_long_term_growth_rate_spec.rb +1 -1
  592. data/spec/models/zacks_sales_surprise_spec.rb +1 -1
  593. data/spec/models/zacks_sales_surprise_summary_spec.rb +1 -1
  594. data/spec/models/zacks_target_price_consensus_spec.rb +1 -1
  595. data/spec/spec_helper.rb +1 -1
  596. metadata +62 -3
  597. data/lib/.DS_Store +0 -0
@@ -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.2
6
+ OpenAPI spec version: 2.28.4
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 Securities
24
- # Returns all Securities to which you have access. When parameters are specified, returns matching Securities.
24
+ # Returns a list of all securities available. Delisted securities included.
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @option opts [BOOLEAN] :active When true, return securities that are active. When false, return securities that are not active. A security is considered active if it has traded or has had a corporate action in the past 30 days, and has not been merged into another security (such as due to ticker changes or corporate restructurings).
27
27
  # @option opts [BOOLEAN] :delisted When true, return securities that have been delisted from their exchange. Note that there may be a newer security for the same company that has been relisted on a differente exchange. When false, return securities that have not been delisted.
@@ -49,7 +49,7 @@ module Intrinio
49
49
  end
50
50
 
51
51
  # All Securities
52
- # Returns all Securities to which you have access. When parameters are specified, returns matching Securities.
52
+ # Returns a list of all securities available. Delisted securities included.
53
53
  # @param [Hash] opts the optional parameters
54
54
  # @option opts [BOOLEAN] :active When true, return securities that are active. When false, return securities that are not active. A security is considered active if it has traded or has had a corporate action in the past 30 days, and has not been merged into another security (such as due to ticker changes or corporate restructurings).
55
55
  # @option opts [BOOLEAN] :delisted When true, return securities that have been delisted from their exchange. Note that there may be a newer security for the same company that has been relisted on a differente exchange. When false, return securities that have not been delisted.
@@ -129,7 +129,7 @@ module Intrinio
129
129
  end
130
130
 
131
131
  # Lookup Security
132
- # Returns the Security with the given `identifier`
132
+ # Returns security reference data such as ticker, FIGI, primary exchange, CIK, and a unique security identifier.
133
133
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
134
134
  # @param [Hash] opts the optional parameters
135
135
  # @return [Security]
@@ -139,7 +139,7 @@ module Intrinio
139
139
  end
140
140
 
141
141
  # Lookup Security
142
- # Returns the Security with the given `identifier`
142
+ # Returns security reference data such as ticker, FIGI, primary exchange, CIK, and a unique security identifier.
143
143
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
144
144
  # @param [Hash] opts the optional parameters
145
145
  # @return [Array<(Security, Fixnum, Hash)>] Security data, response status code and response headers
@@ -716,7 +716,7 @@ module Intrinio
716
716
  end
717
717
 
718
718
  # Accumulation/Distribution Index
719
- # Returns the Accumulation/Distribution Index values of Stock Prices for the Security with the given `identifier`
719
+ # The Accumulation / Distribution Indicator is a volume-based technical indicator which uses the relationship between the stock`s price and volume flow to determine the underlying trend of a stock, up, down, or sideways trend of a stock.
720
720
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
721
721
  # @param [Hash] opts the optional parameters
722
722
  # @option opts [String] :start_date Return technical indicator values on or after the date
@@ -730,7 +730,7 @@ module Intrinio
730
730
  end
731
731
 
732
732
  # Accumulation/Distribution Index
733
- # Returns the Accumulation/Distribution Index values of Stock Prices for the Security with the given &#x60;identifier&#x60;
733
+ # The Accumulation / Distribution Indicator is a volume-based technical indicator which uses the relationship between the stock&#x60;s price and volume flow to determine the underlying trend of a stock, up, down, or sideways trend of a stock.
734
734
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
735
735
  # @param [Hash] opts the optional parameters
736
736
  # @option opts [String] :start_date Return technical indicator values on or after the date
@@ -785,7 +785,7 @@ module Intrinio
785
785
  end
786
786
 
787
787
  # Average Daily Trading Volume
788
- # Returns the Average Daily Trading Volume values of Stock Prices for the Security with the given `identifier`
788
+ # Average Daily Trading Volume is the average number of shares traded over a given period, usually between 20 to 30 trading days.
789
789
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
790
790
  # @param [Hash] opts the optional parameters
791
791
  # @option opts [Integer] :period The number of observations, per period, to calculate Average Daily Trading Volume (default to 22)
@@ -800,7 +800,7 @@ module Intrinio
800
800
  end
801
801
 
802
802
  # Average Daily Trading Volume
803
- # Returns the Average Daily Trading Volume values of Stock Prices for the Security with the given &#x60;identifier&#x60;
803
+ # Average Daily Trading Volume is the average number of shares traded over a given period, usually between 20 to 30 trading days.
804
804
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
805
805
  # @param [Hash] opts the optional parameters
806
806
  # @option opts [Integer] :period The number of observations, per period, to calculate Average Daily Trading Volume
@@ -861,7 +861,7 @@ module Intrinio
861
861
  end
862
862
 
863
863
  # Average Directional Index
864
- # Returns the Average Directional Index values of Stock Prices for the Security with the given `identifier`
864
+ # The Average Directional Index indicator is often used to identify decreasing or increasing price momentum for an underlying security, it is composed of a total of three indicators, the current trendline (adx), a positive directional indicator (di_pos), and a negative directional indicator (di_neg).
865
865
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
866
866
  # @param [Hash] opts the optional parameters
867
867
  # @option opts [Integer] :period The number of observations, per period, to calculate Average Directional Index (default to 14)
@@ -876,7 +876,7 @@ module Intrinio
876
876
  end
877
877
 
878
878
  # Average Directional Index
879
- # Returns the Average Directional Index values of Stock Prices for the Security with the given &#x60;identifier&#x60;
879
+ # The Average Directional Index indicator is often used to identify decreasing or increasing price momentum for an underlying security, it is composed of a total of three indicators, the current trendline (adx), a positive directional indicator (di_pos), and a negative directional indicator (di_neg).
880
880
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
881
881
  # @param [Hash] opts the optional parameters
882
882
  # @option opts [Integer] :period The number of observations, per period, to calculate Average Directional Index
@@ -937,7 +937,7 @@ module Intrinio
937
937
  end
938
938
 
939
939
  # Awesome Oscillator
940
- # Returns the Awesome Oscillator values of Stock Prices for the Security with the given `identifier`
940
+ # The Awesome Oscillator (ao) is a momentum indicator and is calculated by taking the difference between the latest 5 period simple moving average and the 34 period simple moving average. Rather than using the closing price like other indicators, the Awesome Oscillator uses the latest period`s midpoint value (period_high - period_low / 2). The Awesome Oscillator is useful in identifying and trading, zero-line crossovers, twin-peaks trading, and bullish/bearish saucers - Awesome Oscillator is often aggregated with additional technical indicators.
941
941
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
942
942
  # @param [Hash] opts the optional parameters
943
943
  # @option opts [Integer] :short_period The number of observations, per period, to calculate short period Simple Moving Average of the Awesome Oscillator (default to 5)
@@ -953,7 +953,7 @@ module Intrinio
953
953
  end
954
954
 
955
955
  # Awesome Oscillator
956
- # Returns the Awesome Oscillator values of Stock Prices for the Security with the given &#x60;identifier&#x60;
956
+ # The Awesome Oscillator (ao) is a momentum indicator and is calculated by taking the difference between the latest 5 period simple moving average and the 34 period simple moving average. Rather than using the closing price like other indicators, the Awesome Oscillator uses the latest period&#x60;s midpoint value (period_high - period_low / 2). The Awesome Oscillator is useful in identifying and trading, zero-line crossovers, twin-peaks trading, and bullish/bearish saucers - Awesome Oscillator is often aggregated with additional technical indicators.
957
957
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
958
958
  # @param [Hash] opts the optional parameters
959
959
  # @option opts [Integer] :short_period The number of observations, per period, to calculate short period Simple Moving Average of the Awesome Oscillator
@@ -1016,7 +1016,7 @@ module Intrinio
1016
1016
  end
1017
1017
 
1018
1018
  # Average True Range
1019
- # Returns the Average True Range values of Stock Prices for the Security with the given `identifier`
1019
+ # The Average True Range (ATR) is a non-directional market volatility indicator often used to generate stop-out or entry indications. An increasing or expanding ATR typically indicates higher volatility, and a decreasing ATR indicates sideways price action and lower volatility.
1020
1020
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
1021
1021
  # @param [Hash] opts the optional parameters
1022
1022
  # @option opts [Integer] :period The number of observations, per period, to calculate Average True Range (default to 14)
@@ -1031,7 +1031,7 @@ module Intrinio
1031
1031
  end
1032
1032
 
1033
1033
  # Average True Range
1034
- # Returns the Average True Range values of Stock Prices for the Security with the given &#x60;identifier&#x60;
1034
+ # The Average True Range (ATR) is a non-directional market volatility indicator often used to generate stop-out or entry indications. An increasing or expanding ATR typically indicates higher volatility, and a decreasing ATR indicates sideways price action and lower volatility.
1035
1035
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
1036
1036
  # @param [Hash] opts the optional parameters
1037
1037
  # @option opts [Integer] :period The number of observations, per period, to calculate Average True Range
@@ -1092,7 +1092,7 @@ module Intrinio
1092
1092
  end
1093
1093
 
1094
1094
  # Bollinger Bands
1095
- # Returns the Bollinger Bands values of Stock Prices for the Security with the given `identifier`
1095
+ # Bollinger Bands can be a useful technical analysis tool for generating oversold or overbought indicators. Bollinger Bands are composed of three lines, a simple moving average (middle band) and an upper and lower band – the upper and lower bands are typically 2 standard deviations +/- from a 20-day simple moving average, but can be modified. Traders typically consider an underlying security to be overbought as the underlying`s price moves towards the upper band and oversold as the underlying price moves towards the lower band.
1096
1096
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
1097
1097
  # @param [Hash] opts the optional parameters
1098
1098
  # @option opts [Integer] :period The number of observations, per period, to calculate Bollinger Bands (default to 20)
@@ -1109,7 +1109,7 @@ module Intrinio
1109
1109
  end
1110
1110
 
1111
1111
  # Bollinger Bands
1112
- # Returns the Bollinger Bands values of Stock Prices for the Security with the given &#x60;identifier&#x60;
1112
+ # Bollinger Bands can be a useful technical analysis tool for generating oversold or overbought indicators. Bollinger Bands are composed of three lines, a simple moving average (middle band) and an upper and lower band – the upper and lower bands are typically 2 standard deviations +/- from a 20-day simple moving average, but can be modified. Traders typically consider an underlying security to be overbought as the underlying&#x60;s price moves towards the upper band and oversold as the underlying price moves towards the lower band.
1113
1113
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
1114
1114
  # @param [Hash] opts the optional parameters
1115
1115
  # @option opts [Integer] :period The number of observations, per period, to calculate Bollinger Bands
@@ -1177,7 +1177,7 @@ module Intrinio
1177
1177
  end
1178
1178
 
1179
1179
  # Commodity Channel Index
1180
- # Returns the Commodity Channel Index values of Stock Prices for the Security with the given `identifier`
1180
+ # The Commodity Channel Index (CCI) is a technical indicator used to generate buy and sell signals by indicating periods of strength and weakness in the market. CCI signals that fall below -100 are often perceived as weakness in the underlying price movement and CCI signals that rise above 100 indicate strength behind the underlying price movement.
1181
1181
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
1182
1182
  # @param [Hash] opts the optional parameters
1183
1183
  # @option opts [Integer] :period The number of observations, per period, to calculate Commodity Channel Index (default to 20)
@@ -1193,7 +1193,7 @@ module Intrinio
1193
1193
  end
1194
1194
 
1195
1195
  # Commodity Channel Index
1196
- # Returns the Commodity Channel Index values of Stock Prices for the Security with the given &#x60;identifier&#x60;
1196
+ # The Commodity Channel Index (CCI) is a technical indicator used to generate buy and sell signals by indicating periods of strength and weakness in the market. CCI signals that fall below -100 are often perceived as weakness in the underlying price movement and CCI signals that rise above 100 indicate strength behind the underlying price movement.
1197
1197
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
1198
1198
  # @param [Hash] opts the optional parameters
1199
1199
  # @option opts [Integer] :period The number of observations, per period, to calculate Commodity Channel Index
@@ -1256,7 +1256,7 @@ module Intrinio
1256
1256
  end
1257
1257
 
1258
1258
  # Chaikin Money Flow
1259
- # Returns the Chaikin Money Flow values of Stock Prices for the Security with the given `identifier`
1259
+ # The Chaikin Money Flow (CMF) utilizes exponential moving averages as an indicator to monitor the flow of money and momentum. The CMF indicator oscillates around a midrange 0-line and ranges between 100 and -100.
1260
1260
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
1261
1261
  # @param [Hash] opts the optional parameters
1262
1262
  # @option opts [Integer] :period The number of observations, per period, to calculate Chaikin Money Flow (default to 20)
@@ -1271,7 +1271,7 @@ module Intrinio
1271
1271
  end
1272
1272
 
1273
1273
  # Chaikin Money Flow
1274
- # Returns the Chaikin Money Flow values of Stock Prices for the Security with the given &#x60;identifier&#x60;
1274
+ # The Chaikin Money Flow (CMF) utilizes exponential moving averages as an indicator to monitor the flow of money and momentum. The CMF indicator oscillates around a midrange 0-line and ranges between 100 and -100.
1275
1275
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
1276
1276
  # @param [Hash] opts the optional parameters
1277
1277
  # @option opts [Integer] :period The number of observations, per period, to calculate Chaikin Money Flow
@@ -1332,7 +1332,7 @@ module Intrinio
1332
1332
  end
1333
1333
 
1334
1334
  # Donchian Channel
1335
- # Returns the Donchian Channel values of Stock Prices for the Security with the given `identifier`
1335
+ # The Donchian Channel consists of an Upper Bound (upper_bound) and Lower Bound (lower_bound) that track the recent highs and lows and is often used to signal entry and exit points for a position. As the price of the underlying symbol increases the Upper Bound raises, if the price becomes range bound the Upper Bound will remain flat and if the price begins to decrease, the Upper Bound will fall (and vice-versa for the Lower Bound).
1336
1336
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
1337
1337
  # @param [Hash] opts the optional parameters
1338
1338
  # @option opts [Integer] :period The number of observations, per period, to calculate Donchian Channel (default to 20)
@@ -1348,7 +1348,7 @@ module Intrinio
1348
1348
  end
1349
1349
 
1350
1350
  # Donchian Channel
1351
- # Returns the Donchian Channel values of Stock Prices for the Security with the given &#x60;identifier&#x60;
1351
+ # The Donchian Channel consists of an Upper Bound (upper_bound) and Lower Bound (lower_bound) that track the recent highs and lows and is often used to signal entry and exit points for a position. As the price of the underlying symbol increases the Upper Bound raises, if the price becomes range bound the Upper Bound will remain flat and if the price begins to decrease, the Upper Bound will fall (and vice-versa for the Lower Bound).
1352
1352
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
1353
1353
  # @param [Hash] opts the optional parameters
1354
1354
  # @option opts [Integer] :period The number of observations, per period, to calculate Donchian Channel
@@ -1414,7 +1414,7 @@ module Intrinio
1414
1414
  end
1415
1415
 
1416
1416
  # Detrended Price Oscillator
1417
- # Returns the Detrended Price Oscillator values of Stock Prices for the Security with the given `identifier`
1417
+ # The Detrended Price Oscillator (DPO) signals the peaks and troughs of the underlying symbol’s price for a set period of time and is often used by traders to estimate future peaks and troughs using this as guidance to enter or exit a position.
1418
1418
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
1419
1419
  # @param [Hash] opts the optional parameters
1420
1420
  # @option opts [Integer] :period The number of observations, per period, to calculate Detrended Price Oscillator (default to 20)
@@ -1430,7 +1430,7 @@ module Intrinio
1430
1430
  end
1431
1431
 
1432
1432
  # Detrended Price Oscillator
1433
- # Returns the Detrended Price Oscillator values of Stock Prices for the Security with the given &#x60;identifier&#x60;
1433
+ # The Detrended Price Oscillator (DPO) signals the peaks and troughs of the underlying symbol’s price for a set period of time and is often used by traders to estimate future peaks and troughs using this as guidance to enter or exit a position.
1434
1434
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
1435
1435
  # @param [Hash] opts the optional parameters
1436
1436
  # @option opts [Integer] :period The number of observations, per period, to calculate Detrended Price Oscillator
@@ -1492,7 +1492,7 @@ module Intrinio
1492
1492
  end
1493
1493
 
1494
1494
  # Ease of Movement
1495
- # Returns the Ease of Movement values of Stock Prices for the Security with the given `identifier`
1495
+ # The Ease of Movement (EOM) is a volume based oscillator that fluctuates around a midrange 0-line into positive and negative values. Positive values indicate that the underlying symbol`s price is rising with relative ease and negative value indicates the underlying symbol`s price is failing with relative ease.
1496
1496
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
1497
1497
  # @param [Hash] opts the optional parameters
1498
1498
  # @option opts [Integer] :period The number of observations, per period, to calculate Ease of Movement (default to 20)
@@ -1507,7 +1507,7 @@ module Intrinio
1507
1507
  end
1508
1508
 
1509
1509
  # Ease of Movement
1510
- # Returns the Ease of Movement values of Stock Prices for the Security with the given &#x60;identifier&#x60;
1510
+ # The Ease of Movement (EOM) is a volume based oscillator that fluctuates around a midrange 0-line into positive and negative values. Positive values indicate that the underlying symbol&#x60;s price is rising with relative ease and negative value indicates the underlying symbol&#x60;s price is failing with relative ease.
1511
1511
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
1512
1512
  # @param [Hash] opts the optional parameters
1513
1513
  # @option opts [Integer] :period The number of observations, per period, to calculate Ease of Movement
@@ -1568,7 +1568,7 @@ module Intrinio
1568
1568
  end
1569
1569
 
1570
1570
  # Force Index
1571
- # Returns the Force Index values of Stock Prices for the Security with the given `identifier`
1571
+ # The Force Index (FI) is an oscillator that takes into account the intensity of an underlying symbol`s price movement and its corresponding volume. It is used to confirm price breakouts and signal underlying trends.
1572
1572
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
1573
1573
  # @param [Hash] opts the optional parameters
1574
1574
  # @option opts [String] :start_date Return technical indicator values on or after the date
@@ -1582,7 +1582,7 @@ module Intrinio
1582
1582
  end
1583
1583
 
1584
1584
  # Force Index
1585
- # Returns the Force Index values of Stock Prices for the Security with the given &#x60;identifier&#x60;
1585
+ # The Force Index (FI) is an oscillator that takes into account the intensity of an underlying symbol&#x60;s price movement and its corresponding volume. It is used to confirm price breakouts and signal underlying trends.
1586
1586
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
1587
1587
  # @param [Hash] opts the optional parameters
1588
1588
  # @option opts [String] :start_date Return technical indicator values on or after the date
@@ -1637,7 +1637,7 @@ module Intrinio
1637
1637
  end
1638
1638
 
1639
1639
  # Ichimoku Kinko Hyo
1640
- # Returns the Ichimoku Kinko Hyo values of Stock Prices for the Security with the given `identifier`
1640
+ # The Ichimoku Kinko Hyo was designed to be an all-in-one trading indicator that could help traders determine momentum, support, and resistance.
1641
1641
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
1642
1642
  # @param [Hash] opts the optional parameters
1643
1643
  # @option opts [Integer] :low_period The number of observations, per period, to calculate Tenkan Sen (Conversion Line) of Ichimoku Kinko Hyo (default to 9)
@@ -1654,7 +1654,7 @@ module Intrinio
1654
1654
  end
1655
1655
 
1656
1656
  # Ichimoku Kinko Hyo
1657
- # Returns the Ichimoku Kinko Hyo values of Stock Prices for the Security with the given &#x60;identifier&#x60;
1657
+ # The Ichimoku Kinko Hyo was designed to be an all-in-one trading indicator that could help traders determine momentum, support, and resistance.
1658
1658
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
1659
1659
  # @param [Hash] opts the optional parameters
1660
1660
  # @option opts [Integer] :low_period The number of observations, per period, to calculate Tenkan Sen (Conversion Line) of Ichimoku Kinko Hyo
@@ -1723,7 +1723,7 @@ module Intrinio
1723
1723
  end
1724
1724
 
1725
1725
  # Keltner Channel
1726
- # Returns the Keltner Channel values of Stock Prices for the Security with the given `identifier`
1726
+ # The Keltner Channel is a volatility based signal, with upper, middle, and lower bands. It is often used at market open, when the largest moves tend to occur. In general, traders tend to buy if the price breaks up above the upper band or sell short if the price drops below the lower band.
1727
1727
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
1728
1728
  # @param [Hash] opts the optional parameters
1729
1729
  # @option opts [Integer] :period The number of observations, per period, to calculate Kelter Channel (default to 10)
@@ -1738,7 +1738,7 @@ module Intrinio
1738
1738
  end
1739
1739
 
1740
1740
  # Keltner Channel
1741
- # Returns the Keltner Channel values of Stock Prices for the Security with the given &#x60;identifier&#x60;
1741
+ # The Keltner Channel is a volatility based signal, with upper, middle, and lower bands. It is often used at market open, when the largest moves tend to occur. In general, traders tend to buy if the price breaks up above the upper band or sell short if the price drops below the lower band.
1742
1742
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
1743
1743
  # @param [Hash] opts the optional parameters
1744
1744
  # @option opts [Integer] :period The number of observations, per period, to calculate Kelter Channel
@@ -1799,7 +1799,7 @@ module Intrinio
1799
1799
  end
1800
1800
 
1801
1801
  # Know Sure Thing
1802
- # Returns the Know Sure Thing values of Stock Prices for the Security with the given `identifier`
1802
+ # The Know Sure Thing indicator (KST) is a momentum based oscillator that is calculated by measuring the momentum of four separate price cycles. KST fluctuates above and below a zero line and is used to identify overbought and oversold conditions, and is often used with additional indicators to boost signal strength.
1803
1803
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
1804
1804
  # @param [Hash] opts the optional parameters
1805
1805
  # @option opts [Integer] :roc1 The number of observations, per period, to calculate the rate-of-change for RCMA1 (default to 10)
@@ -1822,7 +1822,7 @@ module Intrinio
1822
1822
  end
1823
1823
 
1824
1824
  # Know Sure Thing
1825
- # Returns the Know Sure Thing values of Stock Prices for the Security with the given &#x60;identifier&#x60;
1825
+ # The Know Sure Thing indicator (KST) is a momentum based oscillator that is calculated by measuring the momentum of four separate price cycles. KST fluctuates above and below a zero line and is used to identify overbought and oversold conditions, and is often used with additional indicators to boost signal strength.
1826
1826
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
1827
1827
  # @param [Hash] opts the optional parameters
1828
1828
  # @option opts [Integer] :roc1 The number of observations, per period, to calculate the rate-of-change for RCMA1
@@ -1906,7 +1906,7 @@ module Intrinio
1906
1906
  end
1907
1907
 
1908
1908
  # Moving Average Convergence Divergence
1909
- # Returns the Moving Average Convergence Divergence values of Stock Prices for the Security with the given `identifier`
1909
+ # Moving average convergence divergence (MACD) is a trend-following momentum oscillator that consists of three indicators: (1) a 12 period short-term exponential moving average (EMA) a 26 period long-term EMA and a 9 period EMA signal line. Traders using MACD often look for signal line crossovers, centerline crossovers, and EMA divergences to indicate the momentum and underlying trend of a security`s price.
1910
1910
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
1911
1911
  # @param [Hash] opts the optional parameters
1912
1912
  # @option opts [Integer] :fast_period The number of observations, per period, to calculate the fast moving Exponential Moving Average for Moving Average Convergence Divergence (default to 12)
@@ -1924,7 +1924,7 @@ module Intrinio
1924
1924
  end
1925
1925
 
1926
1926
  # Moving Average Convergence Divergence
1927
- # Returns the Moving Average Convergence Divergence values of Stock Prices for the Security with the given &#x60;identifier&#x60;
1927
+ # Moving average convergence divergence (MACD) is a trend-following momentum oscillator that consists of three indicators: (1) a 12 period short-term exponential moving average (EMA) a 26 period long-term EMA and a 9 period EMA signal line. Traders using MACD often look for signal line crossovers, centerline crossovers, and EMA divergences to indicate the momentum and underlying trend of a security&#x60;s price.
1928
1928
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
1929
1929
  # @param [Hash] opts the optional parameters
1930
1930
  # @option opts [Integer] :fast_period The number of observations, per period, to calculate the fast moving Exponential Moving Average for Moving Average Convergence Divergence
@@ -1998,7 +1998,7 @@ module Intrinio
1998
1998
  end
1999
1999
 
2000
2000
  # Money Flow Index
2001
- # Returns the Money Flow Index values of Stock Prices for the Security with the given `identifier`
2001
+ # The Money Flow Index (MFI) is a technical oscillator that incorporates both price and volume, moving between 0 and 100. Traders often consider a MFI above 80 as overbought conditions and below 20 as oversold conditions.
2002
2002
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
2003
2003
  # @param [Hash] opts the optional parameters
2004
2004
  # @option opts [Integer] :period The number of observations, per period, to calculate Money Flow Index (default to 14)
@@ -2013,7 +2013,7 @@ module Intrinio
2013
2013
  end
2014
2014
 
2015
2015
  # Money Flow Index
2016
- # Returns the Money Flow Index values of Stock Prices for the Security with the given &#x60;identifier&#x60;
2016
+ # The Money Flow Index (MFI) is a technical oscillator that incorporates both price and volume, moving between 0 and 100. Traders often consider a MFI above 80 as overbought conditions and below 20 as oversold conditions.
2017
2017
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
2018
2018
  # @param [Hash] opts the optional parameters
2019
2019
  # @option opts [Integer] :period The number of observations, per period, to calculate Money Flow Index
@@ -2074,7 +2074,7 @@ module Intrinio
2074
2074
  end
2075
2075
 
2076
2076
  # Mass Index
2077
- # Returns the Mass Index values of Stock Prices for the Security with the given `identifier`
2077
+ # The mass index (MI) is a technical indicator used by traders to predict trend reversals. A trend reversal signal is said to occur when the 25-day MI reaches 27.0 and then falls below 26.0.
2078
2078
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
2079
2079
  # @param [Hash] opts the optional parameters
2080
2080
  # @option opts [Integer] :ema_period The number of observations, per period, to calculate the single Exponential Moving Average and the Double Exponential Moving Average for Mass Index (default to 9)
@@ -2090,7 +2090,7 @@ module Intrinio
2090
2090
  end
2091
2091
 
2092
2092
  # Mass Index
2093
- # Returns the Mass Index values of Stock Prices for the Security with the given &#x60;identifier&#x60;
2093
+ # The mass index (MI) is a technical indicator used by traders to predict trend reversals. A trend reversal signal is said to occur when the 25-day MI reaches 27.0 and then falls below 26.0.
2094
2094
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
2095
2095
  # @param [Hash] opts the optional parameters
2096
2096
  # @option opts [Integer] :ema_period The number of observations, per period, to calculate the single Exponential Moving Average and the Double Exponential Moving Average for Mass Index
@@ -2157,7 +2157,7 @@ module Intrinio
2157
2157
  end
2158
2158
 
2159
2159
  # Negative Volume Index
2160
- # Returns the Negative Volume Index values of Stock Prices for the Security with the given `identifier`
2160
+ # The negative volume index (NVI) is often referred to as the `smart money indicator.` It works by the assumption that smart money (institutional money) is at work when volume decreases and vice versa when volume increases. NVI starts at 1000 and increases in regard to the percentage price change when volume decreases over a 255-day EMA period. Traders often use this technical indicator when researching broder markets and indices.
2161
2161
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
2162
2162
  # @param [Hash] opts the optional parameters
2163
2163
  # @option opts [String] :start_date Return technical indicator values on or after the date
@@ -2171,7 +2171,7 @@ module Intrinio
2171
2171
  end
2172
2172
 
2173
2173
  # Negative Volume Index
2174
- # Returns the Negative Volume Index values of Stock Prices for the Security with the given &#x60;identifier&#x60;
2174
+ # The negative volume index (NVI) is often referred to as the &#x60;smart money indicator.&#x60; It works by the assumption that smart money (institutional money) is at work when volume decreases and vice versa when volume increases. NVI starts at 1000 and increases in regard to the percentage price change when volume decreases over a 255-day EMA period. Traders often use this technical indicator when researching broder markets and indices.
2175
2175
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
2176
2176
  # @param [Hash] opts the optional parameters
2177
2177
  # @option opts [String] :start_date Return technical indicator values on or after the date
@@ -2226,7 +2226,7 @@ module Intrinio
2226
2226
  end
2227
2227
 
2228
2228
  # On-balance Volume
2229
- # Returns the On-balance Volume values of Stock Prices for the Security with the given `identifier`
2229
+ # On-balance volume (OBV) is a leading momentum indicator that uses the increase/decrease flow in volume to predict upcoming stock price changes. When both OBV and a security`s price are making higher highs, it is presumed the upward trend is likely to continue and vice versa.
2230
2230
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
2231
2231
  # @param [Hash] opts the optional parameters
2232
2232
  # @option opts [String] :start_date Return technical indicator values on or after the date
@@ -2240,7 +2240,7 @@ module Intrinio
2240
2240
  end
2241
2241
 
2242
2242
  # On-balance Volume
2243
- # Returns the On-balance Volume values of Stock Prices for the Security with the given &#x60;identifier&#x60;
2243
+ # On-balance volume (OBV) is a leading momentum indicator that uses the increase/decrease flow in volume to predict upcoming stock price changes. When both OBV and a security&#x60;s price are making higher highs, it is presumed the upward trend is likely to continue and vice versa.
2244
2244
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
2245
2245
  # @param [Hash] opts the optional parameters
2246
2246
  # @option opts [String] :start_date Return technical indicator values on or after the date
@@ -2295,7 +2295,7 @@ module Intrinio
2295
2295
  end
2296
2296
 
2297
2297
  # On-balance Volume Mean
2298
- # Returns the On-balance Volume Mean values of Stock Prices for the Security with the given `identifier`
2298
+ # On-balance volume mean (OBVM) is a leading momentum indicator that uses the increase/decrease flow in volume to predict upcoming stock price changes. The difference between OBV and OBVM is that OBVM takes the mean average of a provided period. When both OBVM and a security`s price are making higher highs, it is presumed the upward trend is likely to continue and vice versa.
2299
2299
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
2300
2300
  # @param [Hash] opts the optional parameters
2301
2301
  # @option opts [Integer] :period The number of observations, per period, to calculate On-balance Volume Mean (default to 10)
@@ -2310,7 +2310,7 @@ module Intrinio
2310
2310
  end
2311
2311
 
2312
2312
  # On-balance Volume Mean
2313
- # Returns the On-balance Volume Mean values of Stock Prices for the Security with the given &#x60;identifier&#x60;
2313
+ # On-balance volume mean (OBVM) is a leading momentum indicator that uses the increase/decrease flow in volume to predict upcoming stock price changes. The difference between OBV and OBVM is that OBVM takes the mean average of a provided period. When both OBVM and a security&#x60;s price are making higher highs, it is presumed the upward trend is likely to continue and vice versa.
2314
2314
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
2315
2315
  # @param [Hash] opts the optional parameters
2316
2316
  # @option opts [Integer] :period The number of observations, per period, to calculate On-balance Volume Mean
@@ -2371,7 +2371,7 @@ module Intrinio
2371
2371
  end
2372
2372
 
2373
2373
  # Relative Strength Index
2374
- # Returns the Relative Strength Index values of Stock Prices for the Security with the given `identifier`
2374
+ # Relative strength index (RSI) is a momentum oscillator that ranges between 0 and 100. Traders believe that an RSI value over 70 indicates that a security is overbought and an RSI under 30 indicates that a security is oversold.
2375
2375
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
2376
2376
  # @param [Hash] opts the optional parameters
2377
2377
  # @option opts [Integer] :period The number of observations, per period, to calculate Relative Strength Index (default to 14)
@@ -2387,7 +2387,7 @@ module Intrinio
2387
2387
  end
2388
2388
 
2389
2389
  # Relative Strength Index
2390
- # Returns the Relative Strength Index values of Stock Prices for the Security with the given &#x60;identifier&#x60;
2390
+ # Relative strength index (RSI) is a momentum oscillator that ranges between 0 and 100. Traders believe that an RSI value over 70 indicates that a security is overbought and an RSI under 30 indicates that a security is oversold.
2391
2391
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
2392
2392
  # @param [Hash] opts the optional parameters
2393
2393
  # @option opts [Integer] :period The number of observations, per period, to calculate Relative Strength Index
@@ -2453,7 +2453,7 @@ module Intrinio
2453
2453
  end
2454
2454
 
2455
2455
  # Simple Moving Average
2456
- # Returns the Simple Moving Average values of Stock Prices for the Security with the given `identifier`
2456
+ # A simple moving average (SMA) adds recent prices for a specified period and divides the total by that same number of periods. SMA is typically used to indicate whether a security is in an uptrend or downtrend and can also be combined with a long-term moving average to improve the signal`s abilities.
2457
2457
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
2458
2458
  # @param [Hash] opts the optional parameters
2459
2459
  # @option opts [Integer] :period The number of observations, per period, to calculate Simple Moving Average (default to 20)
@@ -2469,7 +2469,7 @@ module Intrinio
2469
2469
  end
2470
2470
 
2471
2471
  # Simple Moving Average
2472
- # Returns the Simple Moving Average values of Stock Prices for the Security with the given &#x60;identifier&#x60;
2472
+ # A simple moving average (SMA) adds recent prices for a specified period and divides the total by that same number of periods. SMA is typically used to indicate whether a security is in an uptrend or downtrend and can also be combined with a long-term moving average to improve the signal&#x60;s abilities.
2473
2473
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
2474
2474
  # @param [Hash] opts the optional parameters
2475
2475
  # @option opts [Integer] :period The number of observations, per period, to calculate Simple Moving Average
@@ -2535,7 +2535,7 @@ module Intrinio
2535
2535
  end
2536
2536
 
2537
2537
  # Stochastic Oscillator
2538
- # Returns the Stochastic Oscillator values of Stock Prices for the Security with the given `identifier`
2538
+ # The Stochastic Oscillator (SO) is a range-bound momentum indicator that ranges from 0 to 100 and follows the velocity of the momentum itself, not the underlying price or volume. When SO is above 80 it indicates that a security is trading at the high end of its period`s high-low range and vice versa if the reading is below 20.
2539
2539
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
2540
2540
  # @param [Hash] opts the optional parameters
2541
2541
  # @option opts [Integer] :period The number of observations, per period, to calculate %K of Stochastic Oscillator (default to 14)
@@ -2551,7 +2551,7 @@ module Intrinio
2551
2551
  end
2552
2552
 
2553
2553
  # Stochastic Oscillator
2554
- # Returns the Stochastic Oscillator values of Stock Prices for the Security with the given &#x60;identifier&#x60;
2554
+ # The Stochastic Oscillator (SO) is a range-bound momentum indicator that ranges from 0 to 100 and follows the velocity of the momentum itself, not the underlying price or volume. When SO is above 80 it indicates that a security is trading at the high end of its period&#x60;s high-low range and vice versa if the reading is below 20.
2555
2555
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
2556
2556
  # @param [Hash] opts the optional parameters
2557
2557
  # @option opts [Integer] :period The number of observations, per period, to calculate %K of Stochastic Oscillator
@@ -2618,7 +2618,7 @@ module Intrinio
2618
2618
  end
2619
2619
 
2620
2620
  # Triple Exponential Average
2621
- # Returns the Simple Moving Average values of Stock Prices for the Security with the given `identifier`
2621
+ # The Triple Exponential Average (TEA) is a momentum indicator used to identify when a security is oversold and overbought. By exponentially smoothing out the underlying security`s moving average, the TEA filters out insignificant price movements. A positive TEA is often believed to indicate momentum is increasing and a negative TEA indicates that momentum is decreasing.
2622
2622
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
2623
2623
  # @param [Hash] opts the optional parameters
2624
2624
  # @option opts [Integer] :period The number of observations, per period, to calculate Exponential Moving Average for Triple Exponential Average (default to 15)
@@ -2633,7 +2633,7 @@ module Intrinio
2633
2633
  end
2634
2634
 
2635
2635
  # Triple Exponential Average
2636
- # Returns the Simple Moving Average values of Stock Prices for the Security with the given &#x60;identifier&#x60;
2636
+ # The Triple Exponential Average (TEA) is a momentum indicator used to identify when a security is oversold and overbought. By exponentially smoothing out the underlying security&#x60;s moving average, the TEA filters out insignificant price movements. A positive TEA is often believed to indicate momentum is increasing and a negative TEA indicates that momentum is decreasing.
2637
2637
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
2638
2638
  # @param [Hash] opts the optional parameters
2639
2639
  # @option opts [Integer] :period The number of observations, per period, to calculate Exponential Moving Average for Triple Exponential Average
@@ -2694,7 +2694,7 @@ module Intrinio
2694
2694
  end
2695
2695
 
2696
2696
  # True Strength Index
2697
- # Returns the True Strength Index values of Stock Prices for the Security with the given `identifier`
2697
+ # The True Strength Index (TSI) is a momentum oscillator used to identify building trends and trend reversals, typically by signalling overbought and oversold conditions. TSI fluctuates between positive and negative values, and traders typically combine its signal with other momentum oscillators to increase its strength. When TSI crosses the signal line into positive territory it is presumed to be an entrance opportunity and vice versa when the TSI crosses into negative territory.
2698
2698
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
2699
2699
  # @param [Hash] opts the optional parameters
2700
2700
  # @option opts [Integer] :low_period The number of observations, per period, to calculate low period Exponential Moving Average for smoothing in True Strength Index (default to 13)
@@ -2711,7 +2711,7 @@ module Intrinio
2711
2711
  end
2712
2712
 
2713
2713
  # True Strength Index
2714
- # Returns the True Strength Index values of Stock Prices for the Security with the given &#x60;identifier&#x60;
2714
+ # The True Strength Index (TSI) is a momentum oscillator used to identify building trends and trend reversals, typically by signalling overbought and oversold conditions. TSI fluctuates between positive and negative values, and traders typically combine its signal with other momentum oscillators to increase its strength. When TSI crosses the signal line into positive territory it is presumed to be an entrance opportunity and vice versa when the TSI crosses into negative territory.
2715
2715
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
2716
2716
  # @param [Hash] opts the optional parameters
2717
2717
  # @option opts [Integer] :low_period The number of observations, per period, to calculate low period Exponential Moving Average for smoothing in True Strength Index
@@ -2783,7 +2783,7 @@ module Intrinio
2783
2783
  end
2784
2784
 
2785
2785
  # Ultimate Oscillator
2786
- # Returns the Ultimate Oscillator values of Stock Prices for the Security with the given `identifier`
2786
+ # The Ultimate Oscillator (UO) is a range bound technical indicator that moves between 0 and 100 and is calculated with 3 timeframes, typically 7, 14, and 28 day periods. When UO`s value is above 70 a security is categorized as overbought and when UO`s value is below 30 a security is categorized as oversold.
2787
2787
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
2788
2788
  # @param [Hash] opts the optional parameters
2789
2789
  # @option opts [Integer] :short_period The number of observations, per period, to calculate the short period for Ultimate Oscillator (default to 7)
@@ -2803,7 +2803,7 @@ module Intrinio
2803
2803
  end
2804
2804
 
2805
2805
  # Ultimate Oscillator
2806
- # Returns the Ultimate Oscillator values of Stock Prices for the Security with the given &#x60;identifier&#x60;
2806
+ # The Ultimate Oscillator (UO) is a range bound technical indicator that moves between 0 and 100 and is calculated with 3 timeframes, typically 7, 14, and 28 day periods. When UO&#x60;s value is above 70 a security is categorized as overbought and when UO&#x60;s value is below 30 a security is categorized as oversold.
2807
2807
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
2808
2808
  # @param [Hash] opts the optional parameters
2809
2809
  # @option opts [Integer] :short_period The number of observations, per period, to calculate the short period for Ultimate Oscillator
@@ -2874,7 +2874,7 @@ module Intrinio
2874
2874
  end
2875
2875
 
2876
2876
  # Vortex Indicator
2877
- # Returns the Vortex Indicator values of Stock Prices for the Security with the given `identifier`
2877
+ # The Vortex Indicator (VI) is composed of an uptrend line (VI+) and a downtrend line (VI-). When VI+ crosses VI- from below it typically indicates an entry into a given security. When VI- crosses VI+ from below it typically triggers an exit and that the current trend is reversing course.
2878
2878
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
2879
2879
  # @param [Hash] opts the optional parameters
2880
2880
  # @option opts [Integer] :period The number of observations, per period, to calculate Vortex Indicator (default to 14)
@@ -2889,7 +2889,7 @@ module Intrinio
2889
2889
  end
2890
2890
 
2891
2891
  # Vortex Indicator
2892
- # Returns the Vortex Indicator values of Stock Prices for the Security with the given &#x60;identifier&#x60;
2892
+ # The Vortex Indicator (VI) is composed of an uptrend line (VI+) and a downtrend line (VI-). When VI+ crosses VI- from below it typically indicates an entry into a given security. When VI- crosses VI+ from below it typically triggers an exit and that the current trend is reversing course.
2893
2893
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
2894
2894
  # @param [Hash] opts the optional parameters
2895
2895
  # @option opts [Integer] :period The number of observations, per period, to calculate Vortex Indicator
@@ -2950,7 +2950,7 @@ module Intrinio
2950
2950
  end
2951
2951
 
2952
2952
  # Volume-price Trend
2953
- # Returns the Volume-price Trend values of Stock Prices for the Security with the given `identifier`
2953
+ # The volume price trend (VPT) is a technical indicator that uses price & volume to determine whether a trend is established. Typically, when a security is trending upwards, there is more volume on positive days than negative ones, and as a result VPT should be increasing on these days as well. However, if VPT fails to increase past its previous high during an outbreak, this is suggested to indicate the rally is losing strength.
2954
2954
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
2955
2955
  # @param [Hash] opts the optional parameters
2956
2956
  # @option opts [String] :start_date Return technical indicator values on or after the date
@@ -2964,7 +2964,7 @@ module Intrinio
2964
2964
  end
2965
2965
 
2966
2966
  # Volume-price Trend
2967
- # Returns the Volume-price Trend values of Stock Prices for the Security with the given &#x60;identifier&#x60;
2967
+ # The volume price trend (VPT) is a technical indicator that uses price &amp; volume to determine whether a trend is established. Typically, when a security is trending upwards, there is more volume on positive days than negative ones, and as a result VPT should be increasing on these days as well. However, if VPT fails to increase past its previous high during an outbreak, this is suggested to indicate the rally is losing strength.
2968
2968
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
2969
2969
  # @param [Hash] opts the optional parameters
2970
2970
  # @option opts [String] :start_date Return technical indicator values on or after the date
@@ -3019,7 +3019,7 @@ module Intrinio
3019
3019
  end
3020
3020
 
3021
3021
  # Volume Weighted Average Price
3022
- # Returns the Volume Weighted Average Price values of Stock Prices for the Security with the given `identifier`
3022
+ # Volume Weighted Average Price (VWAP) is a lagging technical indicator that is used in combination with a security`s price. When the underlying price rises above its VWAP, it is often interpreted as a bullish signal, and vice versa in the opposite direction.
3023
3023
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
3024
3024
  # @param [Hash] opts the optional parameters
3025
3025
  # @option opts [String] :start_date Return technical indicator values on or after the date
@@ -3033,7 +3033,7 @@ module Intrinio
3033
3033
  end
3034
3034
 
3035
3035
  # Volume Weighted Average Price
3036
- # Returns the Volume Weighted Average Price values of Stock Prices for the Security with the given &#x60;identifier&#x60;
3036
+ # Volume Weighted Average Price (VWAP) is a lagging technical indicator that is used in combination with a security&#x60;s price. When the underlying price rises above its VWAP, it is often interpreted as a bullish signal, and vice versa in the opposite direction.
3037
3037
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
3038
3038
  # @param [Hash] opts the optional parameters
3039
3039
  # @option opts [String] :start_date Return technical indicator values on or after the date
@@ -3088,7 +3088,7 @@ module Intrinio
3088
3088
  end
3089
3089
 
3090
3090
  # Williams %R
3091
- # Returns the Williams %R values of Stock Prices for the Security with the given `identifier`
3091
+ # Williams %R is a momentum indicator used to determine overbought and oversold environments for a security and fluctuates between 0 and -100. When Williams %R is above -20 the security is considered to be overbought and when Williams %R is under -80 the security is considered to be oversold.
3092
3092
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
3093
3093
  # @param [Hash] opts the optional parameters
3094
3094
  # @option opts [Integer] :period The number of observations, per period, to look-back when calculating Williams %R (default to 14)
@@ -3103,7 +3103,7 @@ module Intrinio
3103
3103
  end
3104
3104
 
3105
3105
  # Williams %R
3106
- # Returns the Williams %R values of Stock Prices for the Security with the given &#x60;identifier&#x60;
3106
+ # Williams %R is a momentum indicator used to determine overbought and oversold environments for a security and fluctuates between 0 and -100. When Williams %R is above -20 the security is considered to be overbought and when Williams %R is under -80 the security is considered to be oversold.
3107
3107
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
3108
3108
  # @param [Hash] opts the optional parameters
3109
3109
  # @option opts [Integer] :period The number of observations, per period, to look-back when calculating Williams %R
@@ -3222,6 +3222,56 @@ module Intrinio
3222
3222
  return data, status_code, headers
3223
3223
  end
3224
3224
 
3225
+ # Realtime Stock Prices Snapshot
3226
+ # Returns all security snapshots for the queried interval with links to download.
3227
+ # @param [Hash] opts the optional parameters
3228
+ # @option opts [DateTime] :at_datetime The UTC date and time (with url-encoded spaces) the snapshot will cover.
3229
+ # @return [SecuritySnapshotsResult]
3230
+ def get_security_snapshots(opts = {})
3231
+ data, _status_code, _headers = get_security_snapshots_with_http_info(opts)
3232
+ return data
3233
+ end
3234
+
3235
+ # Realtime Stock Prices Snapshot
3236
+ # Returns all security snapshots for the queried interval with links to download.
3237
+ # @param [Hash] opts the optional parameters
3238
+ # @option opts [DateTime] :at_datetime The UTC date and time (with url-encoded spaces) the snapshot will cover.
3239
+ # @return [Array<(SecuritySnapshotsResult, Fixnum, Hash)>] SecuritySnapshotsResult data, response status code and response headers
3240
+ def get_security_snapshots_with_http_info(opts = {})
3241
+ if @api_client.config.debugging
3242
+ @api_client.config.logger.debug "Calling API: SecurityApi.get_security_snapshots ..."
3243
+ end
3244
+ # resource path
3245
+ local_var_path = "/securities/snapshots"
3246
+
3247
+ # query parameters
3248
+ query_params = {}
3249
+ query_params[:'at_datetime'] = opts[:'at_datetime'] if !opts[:'at_datetime'].nil?
3250
+
3251
+ # header parameters
3252
+ header_params = {}
3253
+ # HTTP header 'Accept' (if needed)
3254
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3255
+
3256
+ # form parameters
3257
+ form_params = {}
3258
+
3259
+ # http body (model)
3260
+ post_body = nil
3261
+ auth_names = ['ApiKeyAuth']
3262
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
3263
+ :header_params => header_params,
3264
+ :query_params => query_params,
3265
+ :form_params => form_params,
3266
+ :body => post_body,
3267
+ :auth_names => auth_names,
3268
+ :return_type => 'SecuritySnapshotsResult')
3269
+ if @api_client.config.debugging
3270
+ @api_client.config.logger.debug "API called: SecurityApi#get_security_snapshots\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3271
+ end
3272
+ return data, status_code, headers
3273
+ end
3274
+
3225
3275
  # Stock Price Adjustments by Security
3226
3276
  # Returns stock price adjustments for the Security with the given `identifier`
3227
3277
  # @param identifier A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)
@@ -3791,7 +3841,7 @@ module Intrinio
3791
3841
  end
3792
3842
 
3793
3843
  # Search Securities
3794
- # Searches for Securities matching the text `query`
3844
+ # Search the securities database and return a list of securities matching the text query parameter passed through. Query parameter searches across the security ticker and name.
3795
3845
  # @param query
3796
3846
  # @param [Hash] opts the optional parameters
3797
3847
  # @option opts [Integer] :page_size The number of results to return (default to 100)
@@ -3802,7 +3852,7 @@ module Intrinio
3802
3852
  end
3803
3853
 
3804
3854
  # Search Securities
3805
- # Searches for Securities matching the text &#x60;query&#x60;
3855
+ # Search the securities database and return a list of securities matching the text query parameter passed through. Query parameter searches across the security ticker and name.
3806
3856
  # @param query
3807
3857
  # @param [Hash] opts the optional parameters
3808
3858
  # @option opts [Integer] :page_size The number of results to return