intrinio-sdk 5.20.0 → 5.21.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (570) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +72 -0
  3. data/README.md +12 -2
  4. data/docs/ApiResponseESGCompanies.md +24 -0
  5. data/docs/ApiResponseESGCompanyRatingHistory.md +28 -0
  6. data/docs/ApiResponseESGLatest.md +24 -0
  7. data/docs/CompanyApi.md +11 -11
  8. data/docs/ESGApi.md +262 -0
  9. data/docs/ESGCompanySummary.md +25 -0
  10. data/docs/ESGRating.md +24 -0
  11. data/docs/ESGRatingWithCompany.md +28 -0
  12. data/docs/ETFsApi.md +6 -6
  13. data/docs/FilingApi.md +10 -8
  14. data/docs/FundamentalsApi.md +103 -4
  15. data/docs/IndexApi.md +5 -3
  16. data/docs/OptionStatsRealtime.md +1 -0
  17. data/docs/OptionsApi.md +15 -13
  18. data/docs/OwnersApi.md +2 -2
  19. data/docs/SecurityApi.md +34 -34
  20. data/docs/TechnicalApi.md +31 -31
  21. data/intrinio-sdk.gemspec +1 -1
  22. data/lib/intrinio-sdk/api/bulk_downloads_api.rb +1 -1
  23. data/lib/intrinio-sdk/api/company_api.rb +23 -23
  24. data/lib/intrinio-sdk/api/data_point_api.rb +1 -1
  25. data/lib/intrinio-sdk/api/data_tag_api.rb +1 -1
  26. data/lib/intrinio-sdk/api/esg_api.rb +209 -0
  27. data/lib/intrinio-sdk/api/et_fs_api.rb +13 -13
  28. data/lib/intrinio-sdk/api/filing_api.rb +19 -23
  29. data/lib/intrinio-sdk/api/forex_api.rb +1 -1
  30. data/lib/intrinio-sdk/api/fundamentals_api.rb +95 -9
  31. data/lib/intrinio-sdk/api/historical_data_api.rb +1 -1
  32. data/lib/intrinio-sdk/api/index_api.rb +11 -11
  33. data/lib/intrinio-sdk/api/insider_transaction_filings_api.rb +1 -1
  34. data/lib/intrinio-sdk/api/municipality_api.rb +1 -1
  35. data/lib/intrinio-sdk/api/options_api.rb +28 -25
  36. data/lib/intrinio-sdk/api/owners_api.rb +3 -3
  37. data/lib/intrinio-sdk/api/security_api.rb +69 -69
  38. data/lib/intrinio-sdk/api/stock_exchange_api.rb +1 -1
  39. data/lib/intrinio-sdk/api/technical_api.rb +63 -63
  40. data/lib/intrinio-sdk/api/zacks_api.rb +1 -1
  41. data/lib/intrinio-sdk/api_client.rb +1 -1
  42. data/lib/intrinio-sdk/api_error.rb +1 -1
  43. data/lib/intrinio-sdk/configuration.rb +1 -1
  44. data/lib/intrinio-sdk/models/accumulation_distribution_index_technical_value.rb +1 -1
  45. data/lib/intrinio-sdk/models/api_response_bulk_download_links.rb +1 -1
  46. data/lib/intrinio-sdk/models/api_response_companies.rb +1 -1
  47. data/lib/intrinio-sdk/models/api_response_companies_search.rb +1 -1
  48. data/lib/intrinio-sdk/models/api_response_company_answers.rb +1 -1
  49. data/lib/intrinio-sdk/models/api_response_company_filings.rb +1 -1
  50. data/lib/intrinio-sdk/models/api_response_company_fundamentals.rb +1 -1
  51. data/lib/intrinio-sdk/models/api_response_company_historical_data.rb +1 -1
  52. data/lib/intrinio-sdk/models/api_response_company_insider_transaction_filings.rb +1 -1
  53. data/lib/intrinio-sdk/models/api_response_company_news.rb +1 -1
  54. data/lib/intrinio-sdk/models/api_response_company_recognize.rb +1 -1
  55. data/lib/intrinio-sdk/models/api_response_company_securities.rb +1 -1
  56. data/lib/intrinio-sdk/models/api_response_company_shares_outstanding.rb +1 -1
  57. data/lib/intrinio-sdk/models/api_response_data_tags.rb +1 -1
  58. data/lib/intrinio-sdk/models/api_response_data_tags_search.rb +1 -1
  59. data/lib/intrinio-sdk/models/api_response_economic_index_historical_data.rb +1 -1
  60. data/lib/intrinio-sdk/models/api_response_economic_indices.rb +1 -1
  61. data/lib/intrinio-sdk/models/api_response_economic_indices_search.rb +1 -1
  62. data/lib/intrinio-sdk/models/api_response_esg_companies.rb +200 -0
  63. data/lib/intrinio-sdk/models/api_response_esg_company_rating_history.rb +209 -0
  64. data/lib/intrinio-sdk/models/api_response_esg_latest.rb +200 -0
  65. data/lib/intrinio-sdk/models/api_response_et_fs.rb +1 -1
  66. data/lib/intrinio-sdk/models/api_response_etf_holdings.rb +1 -1
  67. data/lib/intrinio-sdk/models/api_response_filing_answers.rb +1 -1
  68. data/lib/intrinio-sdk/models/api_response_filing_fundamentals.rb +1 -1
  69. data/lib/intrinio-sdk/models/api_response_filing_notes.rb +1 -1
  70. data/lib/intrinio-sdk/models/api_response_filing_notes_search.rb +1 -1
  71. data/lib/intrinio-sdk/models/api_response_filings.rb +1 -1
  72. data/lib/intrinio-sdk/models/api_response_forex_currencies.rb +1 -1
  73. data/lib/intrinio-sdk/models/api_response_forex_pairs.rb +1 -1
  74. data/lib/intrinio-sdk/models/api_response_forex_prices.rb +1 -1
  75. data/lib/intrinio-sdk/models/api_response_historical_data.rb +1 -1
  76. data/lib/intrinio-sdk/models/api_response_initial_public_offerings.rb +1 -1
  77. data/lib/intrinio-sdk/models/api_response_insider_transaction_filings.rb +1 -1
  78. data/lib/intrinio-sdk/models/api_response_municipalities.rb +1 -1
  79. data/lib/intrinio-sdk/models/api_response_municipalitiy_financials.rb +1 -1
  80. data/lib/intrinio-sdk/models/api_response_news.rb +1 -1
  81. data/lib/intrinio-sdk/models/api_response_option_prices.rb +1 -1
  82. data/lib/intrinio-sdk/models/api_response_options.rb +1 -1
  83. data/lib/intrinio-sdk/models/api_response_options_chain.rb +1 -1
  84. data/lib/intrinio-sdk/models/api_response_options_chain_eod.rb +1 -1
  85. data/lib/intrinio-sdk/models/api_response_options_chain_realtime.rb +1 -1
  86. data/lib/intrinio-sdk/models/api_response_options_expirations.rb +1 -1
  87. data/lib/intrinio-sdk/models/api_response_options_price_realtime.rb +1 -1
  88. data/lib/intrinio-sdk/models/api_response_options_prices_batch_realtime.rb +1 -1
  89. data/lib/intrinio-sdk/models/api_response_options_prices_eod.rb +1 -1
  90. data/lib/intrinio-sdk/models/api_response_options_realtime.rb +1 -1
  91. data/lib/intrinio-sdk/models/api_response_options_stats_realtime.rb +1 -1
  92. data/lib/intrinio-sdk/models/api_response_options_tickers.rb +1 -1
  93. data/lib/intrinio-sdk/models/api_response_options_unusual_activity.rb +1 -1
  94. data/lib/intrinio-sdk/models/api_response_owner_insider_transaction_filings.rb +1 -1
  95. data/lib/intrinio-sdk/models/api_response_owner_institutional_holdings.rb +1 -1
  96. data/lib/intrinio-sdk/models/api_response_owners.rb +1 -1
  97. data/lib/intrinio-sdk/models/api_response_reported_financials.rb +1 -1
  98. data/lib/intrinio-sdk/models/api_response_securities.rb +1 -1
  99. data/lib/intrinio-sdk/models/api_response_securities_search.rb +1 -1
  100. data/lib/intrinio-sdk/models/api_response_security_accumulation_distribution_index.rb +1 -1
  101. data/lib/intrinio-sdk/models/api_response_security_average_daily_trading_volume.rb +1 -1
  102. data/lib/intrinio-sdk/models/api_response_security_average_directional_index.rb +1 -1
  103. data/lib/intrinio-sdk/models/api_response_security_average_true_range.rb +1 -1
  104. data/lib/intrinio-sdk/models/api_response_security_awesome_oscillator.rb +1 -1
  105. data/lib/intrinio-sdk/models/api_response_security_bollinger_bands.rb +1 -1
  106. data/lib/intrinio-sdk/models/api_response_security_chaikin_money_flow.rb +1 -1
  107. data/lib/intrinio-sdk/models/api_response_security_commodity_channel_index.rb +1 -1
  108. data/lib/intrinio-sdk/models/api_response_security_detrended_price_oscillator.rb +1 -1
  109. data/lib/intrinio-sdk/models/api_response_security_donchian_channel.rb +1 -1
  110. data/lib/intrinio-sdk/models/api_response_security_ease_of_movement.rb +1 -1
  111. data/lib/intrinio-sdk/models/api_response_security_force_index.rb +1 -1
  112. data/lib/intrinio-sdk/models/api_response_security_historical_data.rb +1 -1
  113. data/lib/intrinio-sdk/models/api_response_security_ichimoku_kinko_hyo.rb +1 -1
  114. data/lib/intrinio-sdk/models/api_response_security_institutional_ownership.rb +1 -1
  115. data/lib/intrinio-sdk/models/api_response_security_interval_prices.rb +1 -1
  116. data/lib/intrinio-sdk/models/api_response_security_intraday_prices.rb +1 -1
  117. data/lib/intrinio-sdk/models/api_response_security_keltner_channel.rb +1 -1
  118. data/lib/intrinio-sdk/models/api_response_security_know_sure_thing.rb +1 -1
  119. data/lib/intrinio-sdk/models/api_response_security_mass_index.rb +1 -1
  120. data/lib/intrinio-sdk/models/api_response_security_money_flow_index.rb +1 -1
  121. data/lib/intrinio-sdk/models/api_response_security_moving_average_convergence_divergence.rb +1 -1
  122. data/lib/intrinio-sdk/models/api_response_security_negative_volume_index.rb +1 -1
  123. data/lib/intrinio-sdk/models/api_response_security_on_balance_volume.rb +1 -1
  124. data/lib/intrinio-sdk/models/api_response_security_on_balance_volume_mean.rb +1 -1
  125. data/lib/intrinio-sdk/models/api_response_security_relative_strength_index.rb +1 -1
  126. data/lib/intrinio-sdk/models/api_response_security_simple_moving_average.rb +1 -1
  127. data/lib/intrinio-sdk/models/api_response_security_stochastic_oscillator.rb +1 -1
  128. data/lib/intrinio-sdk/models/api_response_security_stock_price_adjustments.rb +1 -1
  129. data/lib/intrinio-sdk/models/api_response_security_stock_prices.rb +1 -1
  130. data/lib/intrinio-sdk/models/api_response_security_triple_exponential_average.rb +1 -1
  131. data/lib/intrinio-sdk/models/api_response_security_true_strength_index.rb +1 -1
  132. data/lib/intrinio-sdk/models/api_response_security_ultimate_oscillator.rb +1 -1
  133. data/lib/intrinio-sdk/models/api_response_security_volume_price_trend.rb +1 -1
  134. data/lib/intrinio-sdk/models/api_response_security_volume_weighted_average_price.rb +1 -1
  135. data/lib/intrinio-sdk/models/api_response_security_vortex_indicator.rb +1 -1
  136. data/lib/intrinio-sdk/models/api_response_security_williams_r.rb +1 -1
  137. data/lib/intrinio-sdk/models/api_response_security_zacks_analyst_ratings.rb +1 -1
  138. data/lib/intrinio-sdk/models/api_response_security_zacks_analyst_ratings_snapshot.rb +1 -1
  139. data/lib/intrinio-sdk/models/api_response_security_zacks_eps_surprises.rb +1 -1
  140. data/lib/intrinio-sdk/models/api_response_security_zacks_sales_surprises.rb +1 -1
  141. data/lib/intrinio-sdk/models/api_response_sic_index_historical_data.rb +1 -1
  142. data/lib/intrinio-sdk/models/api_response_sic_indices.rb +1 -1
  143. data/lib/intrinio-sdk/models/api_response_sic_indices_search.rb +1 -1
  144. data/lib/intrinio-sdk/models/api_response_standardized_financials.rb +1 -1
  145. data/lib/intrinio-sdk/models/api_response_standardized_financials_dimensions.rb +1 -1
  146. data/lib/intrinio-sdk/models/api_response_stock_exchange_realtime_stock_prices.rb +1 -1
  147. data/lib/intrinio-sdk/models/api_response_stock_exchange_securities.rb +1 -1
  148. data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_price_adjustments.rb +1 -1
  149. data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_prices.rb +1 -1
  150. data/lib/intrinio-sdk/models/api_response_stock_exchanges.rb +1 -1
  151. data/lib/intrinio-sdk/models/api_response_stock_market_index_historical_data.rb +1 -1
  152. data/lib/intrinio-sdk/models/api_response_stock_market_indices.rb +1 -1
  153. data/lib/intrinio-sdk/models/api_response_stock_market_indices_search.rb +1 -1
  154. data/lib/intrinio-sdk/models/api_response_zacks_analyst_ratings.rb +1 -1
  155. data/lib/intrinio-sdk/models/api_response_zacks_eps_estimates.rb +1 -1
  156. data/lib/intrinio-sdk/models/api_response_zacks_eps_growth_rates.rb +1 -1
  157. data/lib/intrinio-sdk/models/api_response_zacks_eps_surprises.rb +1 -1
  158. data/lib/intrinio-sdk/models/api_response_zacks_etf_holdings.rb +1 -1
  159. data/lib/intrinio-sdk/models/api_response_zacks_institutional_holding_companies.rb +1 -1
  160. data/lib/intrinio-sdk/models/api_response_zacks_institutional_holding_owners.rb +1 -1
  161. data/lib/intrinio-sdk/models/api_response_zacks_institutional_holdings.rb +1 -1
  162. data/lib/intrinio-sdk/models/api_response_zacks_long_term_growth_rates.rb +1 -1
  163. data/lib/intrinio-sdk/models/api_response_zacks_sales_surprises.rb +1 -1
  164. data/lib/intrinio-sdk/models/api_response_zacks_target_price_consensuses.rb +1 -1
  165. data/lib/intrinio-sdk/models/average_daily_trading_volume_technical_value.rb +1 -1
  166. data/lib/intrinio-sdk/models/average_directional_index_technical_value.rb +1 -1
  167. data/lib/intrinio-sdk/models/average_true_range_technical_value.rb +1 -1
  168. data/lib/intrinio-sdk/models/awesome_oscillator_technical_value.rb +1 -1
  169. data/lib/intrinio-sdk/models/bollinger_bands_technical_value.rb +1 -1
  170. data/lib/intrinio-sdk/models/bulk_download_links.rb +1 -1
  171. data/lib/intrinio-sdk/models/bulk_download_summary.rb +1 -1
  172. data/lib/intrinio-sdk/models/chaikin_money_flow_technical_value.rb +1 -1
  173. data/lib/intrinio-sdk/models/commodity_channel_index_technical_value.rb +1 -1
  174. data/lib/intrinio-sdk/models/company.rb +1 -1
  175. data/lib/intrinio-sdk/models/company_filing.rb +1 -1
  176. data/lib/intrinio-sdk/models/company_initial_public_offering.rb +1 -1
  177. data/lib/intrinio-sdk/models/company_news.rb +1 -1
  178. data/lib/intrinio-sdk/models/company_news_summary.rb +1 -1
  179. data/lib/intrinio-sdk/models/company_shares_outstanding.rb +1 -1
  180. data/lib/intrinio-sdk/models/company_summary.rb +1 -1
  181. data/lib/intrinio-sdk/models/data_tag.rb +1 -1
  182. data/lib/intrinio-sdk/models/data_tag_summary.rb +1 -1
  183. data/lib/intrinio-sdk/models/detrended_price_oscillator_technical_value.rb +1 -1
  184. data/lib/intrinio-sdk/models/dividend_record.rb +1 -1
  185. data/lib/intrinio-sdk/models/donchian_channel_technical_value.rb +1 -1
  186. data/lib/intrinio-sdk/models/earnings_record.rb +1 -1
  187. data/lib/intrinio-sdk/models/ease_of_movement_technical_value.rb +1 -1
  188. data/lib/intrinio-sdk/models/economic_index.rb +1 -1
  189. data/lib/intrinio-sdk/models/economic_index_summary.rb +1 -1
  190. data/lib/intrinio-sdk/models/esg_company_summary.rb +233 -0
  191. data/lib/intrinio-sdk/models/esg_rating.rb +224 -0
  192. data/lib/intrinio-sdk/models/esg_rating_with_company.rb +233 -0
  193. data/lib/intrinio-sdk/models/etf.rb +1 -1
  194. data/lib/intrinio-sdk/models/etf_analytics.rb +1 -1
  195. data/lib/intrinio-sdk/models/etf_holding.rb +1 -1
  196. data/lib/intrinio-sdk/models/etf_stats.rb +1 -1
  197. data/lib/intrinio-sdk/models/etf_summary.rb +1 -1
  198. data/lib/intrinio-sdk/models/filing.rb +1 -1
  199. data/lib/intrinio-sdk/models/filing_note.rb +1 -1
  200. data/lib/intrinio-sdk/models/filing_note_filing.rb +1 -1
  201. data/lib/intrinio-sdk/models/filing_note_summary.rb +1 -1
  202. data/lib/intrinio-sdk/models/filing_summary.rb +1 -1
  203. data/lib/intrinio-sdk/models/force_index_technical_value.rb +1 -1
  204. data/lib/intrinio-sdk/models/forex_currency.rb +1 -1
  205. data/lib/intrinio-sdk/models/forex_pair.rb +1 -1
  206. data/lib/intrinio-sdk/models/forex_price.rb +1 -1
  207. data/lib/intrinio-sdk/models/fundamental.rb +1 -1
  208. data/lib/intrinio-sdk/models/fundamental_summary.rb +1 -1
  209. data/lib/intrinio-sdk/models/historical_data.rb +1 -1
  210. data/lib/intrinio-sdk/models/ichimoku_kinko_hyo_technical_value.rb +1 -1
  211. data/lib/intrinio-sdk/models/insider_transaction.rb +1 -1
  212. data/lib/intrinio-sdk/models/insider_transaction_filing.rb +1 -1
  213. data/lib/intrinio-sdk/models/institutional_holding.rb +1 -1
  214. data/lib/intrinio-sdk/models/institutional_ownership.rb +1 -1
  215. data/lib/intrinio-sdk/models/intraday_stock_price.rb +1 -1
  216. data/lib/intrinio-sdk/models/keltner_channel_technical_value.rb +1 -1
  217. data/lib/intrinio-sdk/models/know_sure_thing_technical_value.rb +1 -1
  218. data/lib/intrinio-sdk/models/mass_index_technical_value.rb +1 -1
  219. data/lib/intrinio-sdk/models/money_flow_index_technical_value.rb +1 -1
  220. data/lib/intrinio-sdk/models/moving_average_convergence_divergence_technical_value.rb +1 -1
  221. data/lib/intrinio-sdk/models/municipality.rb +1 -1
  222. data/lib/intrinio-sdk/models/municipality_financial.rb +1 -1
  223. data/lib/intrinio-sdk/models/negative_volume_index_technical_value.rb +1 -1
  224. data/lib/intrinio-sdk/models/on_balance_volume_mean_technical_value.rb +1 -1
  225. data/lib/intrinio-sdk/models/on_balance_volume_technical_value.rb +1 -1
  226. data/lib/intrinio-sdk/models/option.rb +1 -1
  227. data/lib/intrinio-sdk/models/option_chain.rb +1 -1
  228. data/lib/intrinio-sdk/models/option_chain_eod.rb +1 -1
  229. data/lib/intrinio-sdk/models/option_chain_realtime.rb +1 -1
  230. data/lib/intrinio-sdk/models/option_contracts_list.rb +1 -1
  231. data/lib/intrinio-sdk/models/option_eod.rb +1 -1
  232. data/lib/intrinio-sdk/models/option_factors_realtime.rb +1 -1
  233. data/lib/intrinio-sdk/models/option_price.rb +1 -1
  234. data/lib/intrinio-sdk/models/option_price_batch_realtime.rb +1 -1
  235. data/lib/intrinio-sdk/models/option_price_eod.rb +1 -1
  236. data/lib/intrinio-sdk/models/option_price_realtime.rb +1 -1
  237. data/lib/intrinio-sdk/models/option_realtime.rb +1 -1
  238. data/lib/intrinio-sdk/models/option_stats_realtime.rb +15 -5
  239. data/lib/intrinio-sdk/models/option_unusual_trade.rb +1 -1
  240. data/lib/intrinio-sdk/models/owner.rb +1 -1
  241. data/lib/intrinio-sdk/models/owner_summary.rb +1 -1
  242. data/lib/intrinio-sdk/models/realtime_stock_price.rb +1 -1
  243. data/lib/intrinio-sdk/models/realtime_stock_price_security.rb +1 -1
  244. data/lib/intrinio-sdk/models/relative_strength_index_technical_value.rb +1 -1
  245. data/lib/intrinio-sdk/models/reported_financial.rb +1 -1
  246. data/lib/intrinio-sdk/models/reported_financial_dimension.rb +1 -1
  247. data/lib/intrinio-sdk/models/reported_tag.rb +1 -1
  248. data/lib/intrinio-sdk/models/security.rb +1 -1
  249. data/lib/intrinio-sdk/models/security_screen_clause.rb +1 -1
  250. data/lib/intrinio-sdk/models/security_screen_group.rb +1 -1
  251. data/lib/intrinio-sdk/models/security_screen_result.rb +1 -1
  252. data/lib/intrinio-sdk/models/security_screen_result_data.rb +1 -1
  253. data/lib/intrinio-sdk/models/security_summary.rb +1 -1
  254. data/lib/intrinio-sdk/models/sic_index.rb +1 -1
  255. data/lib/intrinio-sdk/models/simple_moving_average_technical_value.rb +1 -1
  256. data/lib/intrinio-sdk/models/standardized_financial.rb +1 -1
  257. data/lib/intrinio-sdk/models/standardized_financials_dimension.rb +1 -1
  258. data/lib/intrinio-sdk/models/stochastic_oscillator_technical_value.rb +1 -1
  259. data/lib/intrinio-sdk/models/stock_exchange.rb +1 -1
  260. data/lib/intrinio-sdk/models/stock_market_index.rb +1 -1
  261. data/lib/intrinio-sdk/models/stock_market_index_summary.rb +1 -1
  262. data/lib/intrinio-sdk/models/stock_price.rb +1 -1
  263. data/lib/intrinio-sdk/models/stock_price_adjustment.rb +1 -1
  264. data/lib/intrinio-sdk/models/stock_price_adjustment_summary.rb +1 -1
  265. data/lib/intrinio-sdk/models/stock_price_interval.rb +1 -1
  266. data/lib/intrinio-sdk/models/stock_price_summary.rb +1 -1
  267. data/lib/intrinio-sdk/models/technical_indicator.rb +1 -1
  268. data/lib/intrinio-sdk/models/thea_entity_answer.rb +1 -1
  269. data/lib/intrinio-sdk/models/thea_source_document.rb +1 -1
  270. data/lib/intrinio-sdk/models/triple_exponential_average_technical_value.rb +1 -1
  271. data/lib/intrinio-sdk/models/true_strength_index_technical_value.rb +1 -1
  272. data/lib/intrinio-sdk/models/ultimate_oscillator_technical_value.rb +1 -1
  273. data/lib/intrinio-sdk/models/volume_price_trend_technical_value.rb +1 -1
  274. data/lib/intrinio-sdk/models/volume_weighted_average_price_value.rb +1 -1
  275. data/lib/intrinio-sdk/models/vortex_indicator_technical_value.rb +1 -1
  276. data/lib/intrinio-sdk/models/williams_r_technical_value.rb +1 -1
  277. data/lib/intrinio-sdk/models/zacks_analyst_rating.rb +1 -1
  278. data/lib/intrinio-sdk/models/zacks_analyst_rating_snapshot.rb +1 -1
  279. data/lib/intrinio-sdk/models/zacks_analyst_rating_summary.rb +1 -1
  280. data/lib/intrinio-sdk/models/zacks_eps_estimate.rb +1 -1
  281. data/lib/intrinio-sdk/models/zacks_eps_growth_rate.rb +1 -1
  282. data/lib/intrinio-sdk/models/zacks_eps_surprise.rb +1 -1
  283. data/lib/intrinio-sdk/models/zacks_eps_surprise_summary.rb +1 -1
  284. data/lib/intrinio-sdk/models/zacks_etf_holding.rb +1 -1
  285. data/lib/intrinio-sdk/models/zacks_institutional_holding.rb +1 -1
  286. data/lib/intrinio-sdk/models/zacks_institutional_holding_company_detail.rb +1 -1
  287. data/lib/intrinio-sdk/models/zacks_institutional_holding_company_summary.rb +1 -1
  288. data/lib/intrinio-sdk/models/zacks_institutional_holding_historical_summary.rb +1 -1
  289. data/lib/intrinio-sdk/models/zacks_institutional_holding_owner_detail.rb +1 -1
  290. data/lib/intrinio-sdk/models/zacks_institutional_holding_owner_summary.rb +1 -1
  291. data/lib/intrinio-sdk/models/zacks_long_term_growth_rate.rb +1 -1
  292. data/lib/intrinio-sdk/models/zacks_sales_surprise.rb +1 -1
  293. data/lib/intrinio-sdk/models/zacks_sales_surprise_summary.rb +1 -1
  294. data/lib/intrinio-sdk/models/zacks_target_price_consensus.rb +1 -1
  295. data/lib/intrinio-sdk/version.rb +2 -2
  296. data/lib/intrinio-sdk.rb +8 -1
  297. data/spec/api/bulk_downloads_api_spec.rb +1 -1
  298. data/spec/api/company_api_spec.rb +12 -12
  299. data/spec/api/data_point_api_spec.rb +1 -1
  300. data/spec/api/data_tag_api_spec.rb +1 -1
  301. data/spec/api/esg_api_spec.rb +78 -0
  302. data/spec/api/et_fs_api_spec.rb +7 -7
  303. data/spec/api/filing_api_spec.rb +8 -8
  304. data/spec/api/forex_api_spec.rb +1 -1
  305. data/spec/api/fundamentals_api_spec.rb +26 -5
  306. data/spec/api/historical_data_api_spec.rb +1 -1
  307. data/spec/api/index_api_spec.rb +6 -6
  308. data/spec/api/insider_transaction_filings_api_spec.rb +1 -1
  309. data/spec/api/municipality_api_spec.rb +1 -1
  310. data/spec/api/options_api_spec.rb +14 -13
  311. data/spec/api/owners_api_spec.rb +2 -2
  312. data/spec/api/security_api_spec.rb +35 -35
  313. data/spec/api/stock_exchange_api_spec.rb +1 -1
  314. data/spec/api/technical_api_spec.rb +32 -32
  315. data/spec/api/zacks_api_spec.rb +1 -1
  316. data/spec/api_client_spec.rb +1 -1
  317. data/spec/configuration_spec.rb +1 -1
  318. data/spec/models/accumulation_distribution_index_technical_value_spec.rb +1 -1
  319. data/spec/models/api_response_bulk_download_links_spec.rb +1 -1
  320. data/spec/models/api_response_companies_search_spec.rb +1 -1
  321. data/spec/models/api_response_companies_spec.rb +1 -1
  322. data/spec/models/api_response_company_answers_spec.rb +1 -1
  323. data/spec/models/api_response_company_filings_spec.rb +1 -1
  324. data/spec/models/api_response_company_fundamentals_spec.rb +1 -1
  325. data/spec/models/api_response_company_historical_data_spec.rb +1 -1
  326. data/spec/models/api_response_company_insider_transaction_filings_spec.rb +1 -1
  327. data/spec/models/api_response_company_news_spec.rb +1 -1
  328. data/spec/models/api_response_company_recognize_spec.rb +1 -1
  329. data/spec/models/api_response_company_securities_spec.rb +1 -1
  330. data/spec/models/api_response_company_shares_outstanding_spec.rb +1 -1
  331. data/spec/models/api_response_data_tags_search_spec.rb +1 -1
  332. data/spec/models/api_response_data_tags_spec.rb +1 -1
  333. data/spec/models/api_response_economic_index_historical_data_spec.rb +1 -1
  334. data/spec/models/api_response_economic_indices_search_spec.rb +1 -1
  335. data/spec/models/api_response_economic_indices_spec.rb +1 -1
  336. data/spec/models/api_response_esg_companies_spec.rb +48 -0
  337. data/spec/models/api_response_esg_company_rating_history_spec.rb +54 -0
  338. data/spec/models/api_response_esg_latest_spec.rb +48 -0
  339. data/spec/models/api_response_et_fs_spec.rb +1 -1
  340. data/spec/models/api_response_etf_holdings_spec.rb +1 -1
  341. data/spec/models/api_response_filing_answers_spec.rb +1 -1
  342. data/spec/models/api_response_filing_fundamentals_spec.rb +1 -1
  343. data/spec/models/api_response_filing_notes_search_spec.rb +1 -1
  344. data/spec/models/api_response_filing_notes_spec.rb +1 -1
  345. data/spec/models/api_response_filings_spec.rb +1 -1
  346. data/spec/models/api_response_forex_currencies_spec.rb +1 -1
  347. data/spec/models/api_response_forex_pairs_spec.rb +1 -1
  348. data/spec/models/api_response_forex_prices_spec.rb +1 -1
  349. data/spec/models/api_response_historical_data_spec.rb +1 -1
  350. data/spec/models/api_response_initial_public_offerings_spec.rb +1 -1
  351. data/spec/models/api_response_insider_transaction_filings_spec.rb +1 -1
  352. data/spec/models/api_response_municipalities_spec.rb +1 -1
  353. data/spec/models/api_response_municipalitiy_financials_spec.rb +1 -1
  354. data/spec/models/api_response_news_spec.rb +1 -1
  355. data/spec/models/api_response_option_prices_spec.rb +1 -1
  356. data/spec/models/api_response_options_chain_eod_spec.rb +1 -1
  357. data/spec/models/api_response_options_chain_realtime_spec.rb +1 -1
  358. data/spec/models/api_response_options_chain_spec.rb +1 -1
  359. data/spec/models/api_response_options_expirations_spec.rb +1 -1
  360. data/spec/models/api_response_options_price_realtime_spec.rb +1 -1
  361. data/spec/models/api_response_options_prices_batch_realtime_spec.rb +1 -1
  362. data/spec/models/api_response_options_prices_eod_spec.rb +1 -1
  363. data/spec/models/api_response_options_realtime_spec.rb +1 -1
  364. data/spec/models/api_response_options_spec.rb +1 -1
  365. data/spec/models/api_response_options_stats_realtime_spec.rb +1 -1
  366. data/spec/models/api_response_options_tickers_spec.rb +1 -1
  367. data/spec/models/api_response_options_unusual_activity_spec.rb +1 -1
  368. data/spec/models/api_response_owner_insider_transaction_filings_spec.rb +1 -1
  369. data/spec/models/api_response_owner_institutional_holdings_spec.rb +1 -1
  370. data/spec/models/api_response_owners_spec.rb +1 -1
  371. data/spec/models/api_response_reported_financials_spec.rb +1 -1
  372. data/spec/models/api_response_securities_search_spec.rb +1 -1
  373. data/spec/models/api_response_securities_spec.rb +1 -1
  374. data/spec/models/api_response_security_accumulation_distribution_index_spec.rb +1 -1
  375. data/spec/models/api_response_security_average_daily_trading_volume_spec.rb +1 -1
  376. data/spec/models/api_response_security_average_directional_index_spec.rb +1 -1
  377. data/spec/models/api_response_security_average_true_range_spec.rb +1 -1
  378. data/spec/models/api_response_security_awesome_oscillator_spec.rb +1 -1
  379. data/spec/models/api_response_security_bollinger_bands_spec.rb +1 -1
  380. data/spec/models/api_response_security_chaikin_money_flow_spec.rb +1 -1
  381. data/spec/models/api_response_security_commodity_channel_index_spec.rb +1 -1
  382. data/spec/models/api_response_security_detrended_price_oscillator_spec.rb +1 -1
  383. data/spec/models/api_response_security_donchian_channel_spec.rb +1 -1
  384. data/spec/models/api_response_security_ease_of_movement_spec.rb +1 -1
  385. data/spec/models/api_response_security_force_index_spec.rb +1 -1
  386. data/spec/models/api_response_security_historical_data_spec.rb +1 -1
  387. data/spec/models/api_response_security_ichimoku_kinko_hyo_spec.rb +1 -1
  388. data/spec/models/api_response_security_institutional_ownership_spec.rb +1 -1
  389. data/spec/models/api_response_security_interval_prices_spec.rb +1 -1
  390. data/spec/models/api_response_security_intraday_prices_spec.rb +1 -1
  391. data/spec/models/api_response_security_keltner_channel_spec.rb +1 -1
  392. data/spec/models/api_response_security_know_sure_thing_spec.rb +1 -1
  393. data/spec/models/api_response_security_mass_index_spec.rb +1 -1
  394. data/spec/models/api_response_security_money_flow_index_spec.rb +1 -1
  395. data/spec/models/api_response_security_moving_average_convergence_divergence_spec.rb +1 -1
  396. data/spec/models/api_response_security_negative_volume_index_spec.rb +1 -1
  397. data/spec/models/api_response_security_on_balance_volume_mean_spec.rb +1 -1
  398. data/spec/models/api_response_security_on_balance_volume_spec.rb +1 -1
  399. data/spec/models/api_response_security_relative_strength_index_spec.rb +1 -1
  400. data/spec/models/api_response_security_simple_moving_average_spec.rb +1 -1
  401. data/spec/models/api_response_security_stochastic_oscillator_spec.rb +1 -1
  402. data/spec/models/api_response_security_stock_price_adjustments_spec.rb +1 -1
  403. data/spec/models/api_response_security_stock_prices_spec.rb +1 -1
  404. data/spec/models/api_response_security_triple_exponential_average_spec.rb +1 -1
  405. data/spec/models/api_response_security_true_strength_index_spec.rb +1 -1
  406. data/spec/models/api_response_security_ultimate_oscillator_spec.rb +1 -1
  407. data/spec/models/api_response_security_volume_price_trend_spec.rb +1 -1
  408. data/spec/models/api_response_security_volume_weighted_average_price_spec.rb +1 -1
  409. data/spec/models/api_response_security_vortex_indicator_spec.rb +1 -1
  410. data/spec/models/api_response_security_williams_r_spec.rb +1 -1
  411. data/spec/models/api_response_security_zacks_analyst_ratings_snapshot_spec.rb +1 -1
  412. data/spec/models/api_response_security_zacks_analyst_ratings_spec.rb +1 -1
  413. data/spec/models/api_response_security_zacks_eps_surprises_spec.rb +1 -1
  414. data/spec/models/api_response_security_zacks_sales_surprises_spec.rb +1 -1
  415. data/spec/models/api_response_sic_index_historical_data_spec.rb +1 -1
  416. data/spec/models/api_response_sic_indices_search_spec.rb +1 -1
  417. data/spec/models/api_response_sic_indices_spec.rb +1 -1
  418. data/spec/models/api_response_standardized_financials_dimensions_spec.rb +1 -1
  419. data/spec/models/api_response_standardized_financials_spec.rb +1 -1
  420. data/spec/models/api_response_stock_exchange_realtime_stock_prices_spec.rb +1 -1
  421. data/spec/models/api_response_stock_exchange_securities_spec.rb +1 -1
  422. data/spec/models/api_response_stock_exchange_stock_price_adjustments_spec.rb +1 -1
  423. data/spec/models/api_response_stock_exchange_stock_prices_spec.rb +1 -1
  424. data/spec/models/api_response_stock_exchanges_spec.rb +1 -1
  425. data/spec/models/api_response_stock_market_index_historical_data_spec.rb +1 -1
  426. data/spec/models/api_response_stock_market_indices_search_spec.rb +1 -1
  427. data/spec/models/api_response_stock_market_indices_spec.rb +1 -1
  428. data/spec/models/api_response_zacks_analyst_ratings_spec.rb +1 -1
  429. data/spec/models/api_response_zacks_eps_estimates_spec.rb +1 -1
  430. data/spec/models/api_response_zacks_eps_growth_rates_spec.rb +1 -1
  431. data/spec/models/api_response_zacks_eps_surprises_spec.rb +1 -1
  432. data/spec/models/api_response_zacks_etf_holdings_spec.rb +1 -1
  433. data/spec/models/api_response_zacks_institutional_holding_companies_spec.rb +1 -1
  434. data/spec/models/api_response_zacks_institutional_holding_owners_spec.rb +1 -1
  435. data/spec/models/api_response_zacks_institutional_holdings_spec.rb +1 -1
  436. data/spec/models/api_response_zacks_long_term_growth_rates_spec.rb +1 -1
  437. data/spec/models/api_response_zacks_sales_surprises_spec.rb +1 -1
  438. data/spec/models/api_response_zacks_target_price_consensuses_spec.rb +1 -1
  439. data/spec/models/average_daily_trading_volume_technical_value_spec.rb +1 -1
  440. data/spec/models/average_directional_index_technical_value_spec.rb +1 -1
  441. data/spec/models/average_true_range_technical_value_spec.rb +1 -1
  442. data/spec/models/awesome_oscillator_technical_value_spec.rb +1 -1
  443. data/spec/models/bollinger_bands_technical_value_spec.rb +1 -1
  444. data/spec/models/bulk_download_links_spec.rb +1 -1
  445. data/spec/models/bulk_download_summary_spec.rb +1 -1
  446. data/spec/models/chaikin_money_flow_technical_value_spec.rb +1 -1
  447. data/spec/models/commodity_channel_index_technical_value_spec.rb +1 -1
  448. data/spec/models/company_filing_spec.rb +1 -1
  449. data/spec/models/company_initial_public_offering_spec.rb +1 -1
  450. data/spec/models/company_news_spec.rb +1 -1
  451. data/spec/models/company_news_summary_spec.rb +1 -1
  452. data/spec/models/company_shares_outstanding_spec.rb +1 -1
  453. data/spec/models/company_spec.rb +1 -1
  454. data/spec/models/company_summary_spec.rb +1 -1
  455. data/spec/models/data_tag_spec.rb +1 -1
  456. data/spec/models/data_tag_summary_spec.rb +1 -1
  457. data/spec/models/detrended_price_oscillator_technical_value_spec.rb +1 -1
  458. data/spec/models/dividend_record_spec.rb +1 -1
  459. data/spec/models/donchian_channel_technical_value_spec.rb +1 -1
  460. data/spec/models/earnings_record_spec.rb +1 -1
  461. data/spec/models/ease_of_movement_technical_value_spec.rb +1 -1
  462. data/spec/models/economic_index_spec.rb +1 -1
  463. data/spec/models/economic_index_summary_spec.rb +1 -1
  464. data/spec/models/esg_company_summary_spec.rb +72 -0
  465. data/spec/models/esg_rating_spec.rb +66 -0
  466. data/spec/models/esg_rating_with_company_spec.rb +72 -0
  467. data/spec/models/etf_analytics_spec.rb +1 -1
  468. data/spec/models/etf_holding_spec.rb +1 -1
  469. data/spec/models/etf_spec.rb +1 -1
  470. data/spec/models/etf_stats_spec.rb +1 -1
  471. data/spec/models/etf_summary_spec.rb +1 -1
  472. data/spec/models/filing_note_filing_spec.rb +1 -1
  473. data/spec/models/filing_note_spec.rb +1 -1
  474. data/spec/models/filing_note_summary_spec.rb +1 -1
  475. data/spec/models/filing_spec.rb +1 -1
  476. data/spec/models/filing_summary_spec.rb +1 -1
  477. data/spec/models/force_index_technical_value_spec.rb +1 -1
  478. data/spec/models/forex_currency_spec.rb +1 -1
  479. data/spec/models/forex_pair_spec.rb +1 -1
  480. data/spec/models/forex_price_spec.rb +1 -1
  481. data/spec/models/fundamental_spec.rb +1 -1
  482. data/spec/models/fundamental_summary_spec.rb +1 -1
  483. data/spec/models/historical_data_spec.rb +1 -1
  484. data/spec/models/ichimoku_kinko_hyo_technical_value_spec.rb +1 -1
  485. data/spec/models/insider_transaction_filing_spec.rb +1 -1
  486. data/spec/models/insider_transaction_spec.rb +1 -1
  487. data/spec/models/institutional_holding_spec.rb +1 -1
  488. data/spec/models/institutional_ownership_spec.rb +1 -1
  489. data/spec/models/intraday_stock_price_spec.rb +1 -1
  490. data/spec/models/keltner_channel_technical_value_spec.rb +1 -1
  491. data/spec/models/know_sure_thing_technical_value_spec.rb +1 -1
  492. data/spec/models/mass_index_technical_value_spec.rb +1 -1
  493. data/spec/models/money_flow_index_technical_value_spec.rb +1 -1
  494. data/spec/models/moving_average_convergence_divergence_technical_value_spec.rb +1 -1
  495. data/spec/models/municipality_financial_spec.rb +1 -1
  496. data/spec/models/municipality_spec.rb +1 -1
  497. data/spec/models/negative_volume_index_technical_value_spec.rb +1 -1
  498. data/spec/models/on_balance_volume_mean_technical_value_spec.rb +1 -1
  499. data/spec/models/on_balance_volume_technical_value_spec.rb +1 -1
  500. data/spec/models/option_chain_eod_spec.rb +1 -1
  501. data/spec/models/option_chain_realtime_spec.rb +1 -1
  502. data/spec/models/option_chain_spec.rb +1 -1
  503. data/spec/models/option_contracts_list_spec.rb +1 -1
  504. data/spec/models/option_eod_spec.rb +1 -1
  505. data/spec/models/option_factors_realtime_spec.rb +1 -1
  506. data/spec/models/option_price_batch_realtime_spec.rb +1 -1
  507. data/spec/models/option_price_eod_spec.rb +1 -1
  508. data/spec/models/option_price_realtime_spec.rb +1 -1
  509. data/spec/models/option_price_spec.rb +1 -1
  510. data/spec/models/option_realtime_spec.rb +1 -1
  511. data/spec/models/option_spec.rb +1 -1
  512. data/spec/models/option_stats_realtime_spec.rb +7 -1
  513. data/spec/models/option_unusual_trade_spec.rb +1 -1
  514. data/spec/models/owner_spec.rb +1 -1
  515. data/spec/models/owner_summary_spec.rb +1 -1
  516. data/spec/models/realtime_stock_price_security_spec.rb +1 -1
  517. data/spec/models/realtime_stock_price_spec.rb +1 -1
  518. data/spec/models/relative_strength_index_technical_value_spec.rb +1 -1
  519. data/spec/models/reported_financial_dimension_spec.rb +1 -1
  520. data/spec/models/reported_financial_spec.rb +1 -1
  521. data/spec/models/reported_tag_spec.rb +1 -1
  522. data/spec/models/security_screen_clause_spec.rb +1 -1
  523. data/spec/models/security_screen_group_spec.rb +1 -1
  524. data/spec/models/security_screen_result_data_spec.rb +1 -1
  525. data/spec/models/security_screen_result_spec.rb +1 -1
  526. data/spec/models/security_spec.rb +1 -1
  527. data/spec/models/security_summary_spec.rb +1 -1
  528. data/spec/models/sic_index_spec.rb +1 -1
  529. data/spec/models/simple_moving_average_technical_value_spec.rb +1 -1
  530. data/spec/models/standardized_financial_spec.rb +1 -1
  531. data/spec/models/standardized_financials_dimension_spec.rb +1 -1
  532. data/spec/models/stochastic_oscillator_technical_value_spec.rb +1 -1
  533. data/spec/models/stock_exchange_spec.rb +1 -1
  534. data/spec/models/stock_market_index_spec.rb +1 -1
  535. data/spec/models/stock_market_index_summary_spec.rb +1 -1
  536. data/spec/models/stock_price_adjustment_spec.rb +1 -1
  537. data/spec/models/stock_price_adjustment_summary_spec.rb +1 -1
  538. data/spec/models/stock_price_interval_spec.rb +1 -1
  539. data/spec/models/stock_price_spec.rb +1 -1
  540. data/spec/models/stock_price_summary_spec.rb +1 -1
  541. data/spec/models/technical_indicator_spec.rb +1 -1
  542. data/spec/models/thea_entity_answer_spec.rb +1 -1
  543. data/spec/models/thea_source_document_spec.rb +1 -1
  544. data/spec/models/triple_exponential_average_technical_value_spec.rb +1 -1
  545. data/spec/models/true_strength_index_technical_value_spec.rb +1 -1
  546. data/spec/models/ultimate_oscillator_technical_value_spec.rb +1 -1
  547. data/spec/models/volume_price_trend_technical_value_spec.rb +1 -1
  548. data/spec/models/volume_weighted_average_price_value_spec.rb +1 -1
  549. data/spec/models/vortex_indicator_technical_value_spec.rb +1 -1
  550. data/spec/models/williams_r_technical_value_spec.rb +1 -1
  551. data/spec/models/zacks_analyst_rating_snapshot_spec.rb +1 -1
  552. data/spec/models/zacks_analyst_rating_spec.rb +1 -1
  553. data/spec/models/zacks_analyst_rating_summary_spec.rb +1 -1
  554. data/spec/models/zacks_eps_estimate_spec.rb +1 -1
  555. data/spec/models/zacks_eps_growth_rate_spec.rb +1 -1
  556. data/spec/models/zacks_eps_surprise_spec.rb +1 -1
  557. data/spec/models/zacks_eps_surprise_summary_spec.rb +1 -1
  558. data/spec/models/zacks_etf_holding_spec.rb +1 -1
  559. data/spec/models/zacks_institutional_holding_company_detail_spec.rb +1 -1
  560. data/spec/models/zacks_institutional_holding_company_summary_spec.rb +1 -1
  561. data/spec/models/zacks_institutional_holding_historical_summary_spec.rb +1 -1
  562. data/spec/models/zacks_institutional_holding_owner_detail_spec.rb +1 -1
  563. data/spec/models/zacks_institutional_holding_owner_summary_spec.rb +1 -1
  564. data/spec/models/zacks_institutional_holding_spec.rb +1 -1
  565. data/spec/models/zacks_long_term_growth_rate_spec.rb +1 -1
  566. data/spec/models/zacks_sales_surprise_spec.rb +1 -1
  567. data/spec/models/zacks_sales_surprise_summary_spec.rb +1 -1
  568. data/spec/models/zacks_target_price_consensus_spec.rb +1 -1
  569. data/spec/spec_helper.rb +1 -1
  570. metadata +31 -2
data/docs/SecurityApi.md CHANGED
@@ -86,7 +86,7 @@ Method | HTTP request | Description
86
86
  #### All Securities
87
87
 
88
88
 
89
- Returns all Securities to which you have access. When parameters are specified, returns matching Securities.
89
+ Returns a list of all securities available. Delisted securities included.
90
90
 
91
91
  [//]: # (END_OVERVIEW)
92
92
 
@@ -202,7 +202,7 @@ Name | Type | Description | Notes
202
202
  #### Lookup Security
203
203
 
204
204
 
205
- Returns the Security with the given `identifier`
205
+ Returns security reference data such as ticker, FIGI, primary exchange, CIK, and a unique security identifier.
206
206
 
207
207
  [//]: # (END_OVERVIEW)
208
208
 
@@ -956,7 +956,7 @@ Name | Type | Description | Notes
956
956
  #### Accumulation/Distribution Index
957
957
 
958
958
 
959
- Returns the Accumulation/Distribution Index values of Stock Prices for the Security with the given `identifier`
959
+ The Accumulation / Distribution Indicator is a volume-based technical indicator which uses the relationship between the stock`s price and volume flow to determine the underlying trend of a stock, up, down, or sideways trend of a stock.
960
960
 
961
961
  [//]: # (END_OVERVIEW)
962
962
 
@@ -1044,7 +1044,7 @@ Name | Type | Description | Notes
1044
1044
  #### Average Daily Trading Volume
1045
1045
 
1046
1046
 
1047
- Returns the Average Daily Trading Volume values of Stock Prices for the Security with the given `identifier`
1047
+ Average Daily Trading Volume is the average number of shares traded over a given period, usually between 20 to 30 trading days.
1048
1048
 
1049
1049
  [//]: # (END_OVERVIEW)
1050
1050
 
@@ -1134,7 +1134,7 @@ Name | Type | Description | Notes
1134
1134
  #### Average Directional Index
1135
1135
 
1136
1136
 
1137
- Returns the Average Directional Index values of Stock Prices for the Security with the given `identifier`
1137
+ The Average Directional Index indicator is often used to identify decreasing or increasing price momentum for an underlying security, it is composed of a total of three indicators, the current trendline (adx), a positive directional indicator (di_pos), and a negative directional indicator (di_neg).
1138
1138
 
1139
1139
  [//]: # (END_OVERVIEW)
1140
1140
 
@@ -1224,7 +1224,7 @@ Name | Type | Description | Notes
1224
1224
  #### Awesome Oscillator
1225
1225
 
1226
1226
 
1227
- Returns the Awesome Oscillator values of Stock Prices for the Security with the given `identifier`
1227
+ The Awesome Oscillator (ao) is a momentum indicator and is calculated by taking the difference between the latest 5 period simple moving average and the 34 period simple moving average. Rather than using the closing price like other indicators, the Awesome Oscillator uses the latest period`s midpoint value (period_high - period_low / 2). The Awesome Oscillator is useful in identifying and trading, zero-line crossovers, twin-peaks trading, and bullish/bearish saucers - Awesome Oscillator is often aggregated with additional technical indicators.
1228
1228
 
1229
1229
  [//]: # (END_OVERVIEW)
1230
1230
 
@@ -1316,7 +1316,7 @@ Name | Type | Description | Notes
1316
1316
  #### Average True Range
1317
1317
 
1318
1318
 
1319
- Returns the Average True Range values of Stock Prices for the Security with the given `identifier`
1319
+ The Average True Range (ATR) is a non-directional market volatility indicator often used to generate stop-out or entry indications. An increasing or expanding ATR typically indicates higher volatility, and a decreasing ATR indicates sideways price action and lower volatility.
1320
1320
 
1321
1321
  [//]: # (END_OVERVIEW)
1322
1322
 
@@ -1406,7 +1406,7 @@ Name | Type | Description | Notes
1406
1406
  #### Bollinger Bands
1407
1407
 
1408
1408
 
1409
- Returns the Bollinger Bands values of Stock Prices for the Security with the given `identifier`
1409
+ Bollinger Bands can be a useful technical analysis tool for generating oversold or overbought indicators. Bollinger Bands are composed of three lines, a simple moving average (middle band) and an upper and lower band – the upper and lower bands are typically 2 standard deviations +/- from a 20-day simple moving average, but can be modified. Traders typically consider an underlying security to be overbought as the underlying`s price moves towards the upper band and oversold as the underlying price moves towards the lower band.
1410
1410
 
1411
1411
  [//]: # (END_OVERVIEW)
1412
1412
 
@@ -1500,7 +1500,7 @@ Name | Type | Description | Notes
1500
1500
  #### Commodity Channel Index
1501
1501
 
1502
1502
 
1503
- Returns the Commodity Channel Index values of Stock Prices for the Security with the given `identifier`
1503
+ The Commodity Channel Index (CCI) is a technical indicator used to generate buy and sell signals by indicating periods of strength and weakness in the market. CCI signals that fall below -100 are often perceived as weakness in the underlying price movement and CCI signals that rise above 100 indicate strength behind the underlying price movement.
1504
1504
 
1505
1505
  [//]: # (END_OVERVIEW)
1506
1506
 
@@ -1592,7 +1592,7 @@ Name | Type | Description | Notes
1592
1592
  #### Chaikin Money Flow
1593
1593
 
1594
1594
 
1595
- Returns the Chaikin Money Flow values of Stock Prices for the Security with the given `identifier`
1595
+ The Chaikin Money Flow (CMF) utilizes exponential moving averages as an indicator to monitor the flow of money and momentum. The CMF indicator oscillates around a midrange 0-line and ranges between 100 and -100.
1596
1596
 
1597
1597
  [//]: # (END_OVERVIEW)
1598
1598
 
@@ -1682,7 +1682,7 @@ Name | Type | Description | Notes
1682
1682
  #### Donchian Channel
1683
1683
 
1684
1684
 
1685
- Returns the Donchian Channel values of Stock Prices for the Security with the given `identifier`
1685
+ The Donchian Channel consists of an Upper Bound (upper_bound) and Lower Bound (lower_bound) that track the recent highs and lows and is often used to signal entry and exit points for a position. As the price of the underlying symbol increases the Upper Bound raises, if the price becomes range bound the Upper Bound will remain flat and if the price begins to decrease, the Upper Bound will fall (and vice-versa for the Lower Bound).
1686
1686
 
1687
1687
  [//]: # (END_OVERVIEW)
1688
1688
 
@@ -1774,7 +1774,7 @@ Name | Type | Description | Notes
1774
1774
  #### Detrended Price Oscillator
1775
1775
 
1776
1776
 
1777
- Returns the Detrended Price Oscillator values of Stock Prices for the Security with the given `identifier`
1777
+ The Detrended Price Oscillator (DPO) signals the peaks and troughs of the underlying symbol’s price for a set period of time and is often used by traders to estimate future peaks and troughs using this as guidance to enter or exit a position.
1778
1778
 
1779
1779
  [//]: # (END_OVERVIEW)
1780
1780
 
@@ -1866,7 +1866,7 @@ Name | Type | Description | Notes
1866
1866
  #### Ease of Movement
1867
1867
 
1868
1868
 
1869
- Returns the Ease of Movement values of Stock Prices for the Security with the given `identifier`
1869
+ The Ease of Movement (EOM) is a volume based oscillator that fluctuates around a midrange 0-line into positive and negative values. Positive values indicate that the underlying symbol`s price is rising with relative ease and negative value indicates the underlying symbol`s price is failing with relative ease.
1870
1870
 
1871
1871
  [//]: # (END_OVERVIEW)
1872
1872
 
@@ -1956,7 +1956,7 @@ Name | Type | Description | Notes
1956
1956
  #### Force Index
1957
1957
 
1958
1958
 
1959
- Returns the Force Index values of Stock Prices for the Security with the given `identifier`
1959
+ The Force Index (FI) is an oscillator that takes into account the intensity of an underlying symbol`s price movement and its corresponding volume. It is used to confirm price breakouts and signal underlying trends.
1960
1960
 
1961
1961
  [//]: # (END_OVERVIEW)
1962
1962
 
@@ -2044,7 +2044,7 @@ Name | Type | Description | Notes
2044
2044
  #### Ichimoku Kinko Hyo
2045
2045
 
2046
2046
 
2047
- Returns the Ichimoku Kinko Hyo values of Stock Prices for the Security with the given `identifier`
2047
+ The Ichimoku Kinko Hyo was designed to be an all-in-one trading indicator that could help traders determine momentum, support, and resistance.
2048
2048
 
2049
2049
  [//]: # (END_OVERVIEW)
2050
2050
 
@@ -2138,7 +2138,7 @@ Name | Type | Description | Notes
2138
2138
  #### Keltner Channel
2139
2139
 
2140
2140
 
2141
- Returns the Keltner Channel values of Stock Prices for the Security with the given `identifier`
2141
+ The Keltner Channel is a volatility based signal, with upper, middle, and lower bands. It is often used at market open, when the largest moves tend to occur. In general, traders tend to buy if the price breaks up above the upper band or sell short if the price drops below the lower band.
2142
2142
 
2143
2143
  [//]: # (END_OVERVIEW)
2144
2144
 
@@ -2228,7 +2228,7 @@ Name | Type | Description | Notes
2228
2228
  #### Know Sure Thing
2229
2229
 
2230
2230
 
2231
- Returns the Know Sure Thing values of Stock Prices for the Security with the given `identifier`
2231
+ The Know Sure Thing indicator (KST) is a momentum based oscillator that is calculated by measuring the momentum of four separate price cycles. KST fluctuates above and below a zero line and is used to identify overbought and oversold conditions, and is often used with additional indicators to boost signal strength.
2232
2232
 
2233
2233
  [//]: # (END_OVERVIEW)
2234
2234
 
@@ -2334,7 +2334,7 @@ Name | Type | Description | Notes
2334
2334
  #### Moving Average Convergence Divergence
2335
2335
 
2336
2336
 
2337
- Returns the Moving Average Convergence Divergence values of Stock Prices for the Security with the given `identifier`
2337
+ Moving average convergence divergence (MACD) is a trend-following momentum oscillator that consists of three indicators: (1) a 12 period short-term exponential moving average (EMA) a 26 period long-term EMA and a 9 period EMA signal line. Traders using MACD often look for signal line crossovers, centerline crossovers, and EMA divergences to indicate the momentum and underlying trend of a security`s price.
2338
2338
 
2339
2339
  [//]: # (END_OVERVIEW)
2340
2340
 
@@ -2430,7 +2430,7 @@ Name | Type | Description | Notes
2430
2430
  #### Money Flow Index
2431
2431
 
2432
2432
 
2433
- Returns the Money Flow Index values of Stock Prices for the Security with the given `identifier`
2433
+ The Money Flow Index (MFI) is a technical oscillator that incorporates both price and volume, moving between 0 and 100. Traders often consider a MFI above 80 as overbought conditions and below 20 as oversold conditions.
2434
2434
 
2435
2435
  [//]: # (END_OVERVIEW)
2436
2436
 
@@ -2520,7 +2520,7 @@ Name | Type | Description | Notes
2520
2520
  #### Mass Index
2521
2521
 
2522
2522
 
2523
- Returns the Mass Index values of Stock Prices for the Security with the given `identifier`
2523
+ The mass index (MI) is a technical indicator used by traders to predict trend reversals. A trend reversal signal is said to occur when the 25-day MI reaches 27.0 and then falls below 26.0.
2524
2524
 
2525
2525
  [//]: # (END_OVERVIEW)
2526
2526
 
@@ -2612,7 +2612,7 @@ Name | Type | Description | Notes
2612
2612
  #### Negative Volume Index
2613
2613
 
2614
2614
 
2615
- Returns the Negative Volume Index values of Stock Prices for the Security with the given `identifier`
2615
+ The negative volume index (NVI) is often referred to as the `smart money indicator.` It works by the assumption that smart money (institutional money) is at work when volume decreases and vice versa when volume increases. NVI starts at 1000 and increases in regard to the percentage price change when volume decreases over a 255-day EMA period. Traders often use this technical indicator when researching broder markets and indices.
2616
2616
 
2617
2617
  [//]: # (END_OVERVIEW)
2618
2618
 
@@ -2700,7 +2700,7 @@ Name | Type | Description | Notes
2700
2700
  #### On-balance Volume
2701
2701
 
2702
2702
 
2703
- Returns the On-balance Volume values of Stock Prices for the Security with the given `identifier`
2703
+ On-balance volume (OBV) is a leading momentum indicator that uses the increase/decrease flow in volume to predict upcoming stock price changes. When both OBV and a security`s price are making higher highs, it is presumed the upward trend is likely to continue and vice versa.
2704
2704
 
2705
2705
  [//]: # (END_OVERVIEW)
2706
2706
 
@@ -2788,7 +2788,7 @@ Name | Type | Description | Notes
2788
2788
  #### On-balance Volume Mean
2789
2789
 
2790
2790
 
2791
- Returns the On-balance Volume Mean values of Stock Prices for the Security with the given `identifier`
2791
+ On-balance volume mean (OBVM) is a leading momentum indicator that uses the increase/decrease flow in volume to predict upcoming stock price changes. The difference between OBV and OBVM is that OBVM takes the mean average of a provided period. When both OBVM and a security`s price are making higher highs, it is presumed the upward trend is likely to continue and vice versa.
2792
2792
 
2793
2793
  [//]: # (END_OVERVIEW)
2794
2794
 
@@ -2878,7 +2878,7 @@ Name | Type | Description | Notes
2878
2878
  #### Relative Strength Index
2879
2879
 
2880
2880
 
2881
- Returns the Relative Strength Index values of Stock Prices for the Security with the given `identifier`
2881
+ Relative strength index (RSI) is a momentum oscillator that ranges between 0 and 100. Traders believe that an RSI value over 70 indicates that a security is overbought and an RSI under 30 indicates that a security is oversold.
2882
2882
 
2883
2883
  [//]: # (END_OVERVIEW)
2884
2884
 
@@ -2970,7 +2970,7 @@ Name | Type | Description | Notes
2970
2970
  #### Simple Moving Average
2971
2971
 
2972
2972
 
2973
- Returns the Simple Moving Average values of Stock Prices for the Security with the given `identifier`
2973
+ A simple moving average (SMA) adds recent prices for a specified period and divides the total by that same number of periods. SMA is typically used to indicate whether a security is in an uptrend or downtrend and can also be combined with a long-term moving average to improve the signal`s abilities.
2974
2974
 
2975
2975
  [//]: # (END_OVERVIEW)
2976
2976
 
@@ -3062,7 +3062,7 @@ Name | Type | Description | Notes
3062
3062
  #### Stochastic Oscillator
3063
3063
 
3064
3064
 
3065
- Returns the Stochastic Oscillator values of Stock Prices for the Security with the given `identifier`
3065
+ The Stochastic Oscillator (SO) is a range-bound momentum indicator that ranges from 0 to 100 and follows the velocity of the momentum itself, not the underlying price or volume. When SO is above 80 it indicates that a security is trading at the high end of its period`s high-low range and vice versa if the reading is below 20.
3066
3066
 
3067
3067
  [//]: # (END_OVERVIEW)
3068
3068
 
@@ -3154,7 +3154,7 @@ Name | Type | Description | Notes
3154
3154
  #### Triple Exponential Average
3155
3155
 
3156
3156
 
3157
- Returns the Simple Moving Average values of Stock Prices for the Security with the given `identifier`
3157
+ The Triple Exponential Average (TEA) is a momentum indicator used to identify when a security is oversold and overbought. By exponentially smoothing out the underlying security`s moving average, the TEA filters out insignificant price movements. A positive TEA is often believed to indicate momentum is increasing and a negative TEA indicates that momentum is decreasing.
3158
3158
 
3159
3159
  [//]: # (END_OVERVIEW)
3160
3160
 
@@ -3244,7 +3244,7 @@ Name | Type | Description | Notes
3244
3244
  #### True Strength Index
3245
3245
 
3246
3246
 
3247
- Returns the True Strength Index values of Stock Prices for the Security with the given `identifier`
3247
+ The True Strength Index (TSI) is a momentum oscillator used to identify building trends and trend reversals, typically by signalling overbought and oversold conditions. TSI fluctuates between positive and negative values, and traders typically combine its signal with other momentum oscillators to increase its strength. When TSI crosses the signal line into positive territory it is presumed to be an entrance opportunity and vice versa when the TSI crosses into negative territory.
3248
3248
 
3249
3249
  [//]: # (END_OVERVIEW)
3250
3250
 
@@ -3338,7 +3338,7 @@ Name | Type | Description | Notes
3338
3338
  #### Ultimate Oscillator
3339
3339
 
3340
3340
 
3341
- Returns the Ultimate Oscillator values of Stock Prices for the Security with the given `identifier`
3341
+ The Ultimate Oscillator (UO) is a range bound technical indicator that moves between 0 and 100 and is calculated with 3 timeframes, typically 7, 14, and 28 day periods. When UO`s value is above 70 a security is categorized as overbought and when UO`s value is below 30 a security is categorized as oversold.
3342
3342
 
3343
3343
  [//]: # (END_OVERVIEW)
3344
3344
 
@@ -3438,7 +3438,7 @@ Name | Type | Description | Notes
3438
3438
  #### Vortex Indicator
3439
3439
 
3440
3440
 
3441
- Returns the Vortex Indicator values of Stock Prices for the Security with the given `identifier`
3441
+ The Vortex Indicator (VI) is composed of an uptrend line (VI+) and a downtrend line (VI-). When VI+ crosses VI- from below it typically indicates an entry into a given security. When VI- crosses VI+ from below it typically triggers an exit and that the current trend is reversing course.
3442
3442
 
3443
3443
  [//]: # (END_OVERVIEW)
3444
3444
 
@@ -3528,7 +3528,7 @@ Name | Type | Description | Notes
3528
3528
  #### Volume-price Trend
3529
3529
 
3530
3530
 
3531
- Returns the Volume-price Trend values of Stock Prices for the Security with the given `identifier`
3531
+ The volume price trend (VPT) is a technical indicator that uses price & volume to determine whether a trend is established. Typically, when a security is trending upwards, there is more volume on positive days than negative ones, and as a result VPT should be increasing on these days as well. However, if VPT fails to increase past its previous high during an outbreak, this is suggested to indicate the rally is losing strength.
3532
3532
 
3533
3533
  [//]: # (END_OVERVIEW)
3534
3534
 
@@ -3616,7 +3616,7 @@ Name | Type | Description | Notes
3616
3616
  #### Volume Weighted Average Price
3617
3617
 
3618
3618
 
3619
- Returns the Volume Weighted Average Price values of Stock Prices for the Security with the given `identifier`
3619
+ Volume Weighted Average Price (VWAP) is a lagging technical indicator that is used in combination with a security`s price. When the underlying price rises above its VWAP, it is often interpreted as a bullish signal, and vice versa in the opposite direction.
3620
3620
 
3621
3621
  [//]: # (END_OVERVIEW)
3622
3622
 
@@ -3704,7 +3704,7 @@ Name | Type | Description | Notes
3704
3704
  #### Williams %R
3705
3705
 
3706
3706
 
3707
- Returns the Williams %R values of Stock Prices for the Security with the given `identifier`
3707
+ Williams %R is a momentum indicator used to determine overbought and oversold environments for a security and fluctuates between 0 and -100. When Williams %R is above -20 the security is considered to be overbought and when Williams %R is under -80 the security is considered to be oversold.
3708
3708
 
3709
3709
  [//]: # (END_OVERVIEW)
3710
3710
 
@@ -4519,7 +4519,7 @@ Name | Type | Description | Notes
4519
4519
  #### Search Securities
4520
4520
 
4521
4521
 
4522
- Searches for Securities matching the text `query`
4522
+ Search the securities database and return a list of securities matching the text query parameter passed through. Query parameter searches across the security ticker and name.
4523
4523
 
4524
4524
  [//]: # (END_OVERVIEW)
4525
4525
 
data/docs/TechnicalApi.md CHANGED
@@ -67,7 +67,7 @@ Method | HTTP request | Description
67
67
  #### Accumulation/Distribution Index
68
68
 
69
69
 
70
- Returns the Accumulation/Distribution Index values of Stock Prices for the Security with the given `identifier`
70
+ 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.
71
71
 
72
72
  [//]: # (END_OVERVIEW)
73
73
 
@@ -155,7 +155,7 @@ Name | Type | Description | Notes
155
155
  #### Average Daily Trading Volume
156
156
 
157
157
 
158
- Returns the Average Daily Trading Volume values of Stock Prices for the Security with the given `identifier`
158
+ Average Daily Trading Volume is the average number of shares traded over a given period, usually between 20 to 30 trading days.
159
159
 
160
160
  [//]: # (END_OVERVIEW)
161
161
 
@@ -245,7 +245,7 @@ Name | Type | Description | Notes
245
245
  #### Average Directional Index
246
246
 
247
247
 
248
- Returns the Average Directional Index values of Stock Prices for the Security with the given `identifier`
248
+ 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).
249
249
 
250
250
  [//]: # (END_OVERVIEW)
251
251
 
@@ -335,7 +335,7 @@ Name | Type | Description | Notes
335
335
  #### Awesome Oscillator
336
336
 
337
337
 
338
- Returns the Awesome Oscillator values of Stock Prices for the Security with the given `identifier`
338
+ 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.
339
339
 
340
340
  [//]: # (END_OVERVIEW)
341
341
 
@@ -427,7 +427,7 @@ Name | Type | Description | Notes
427
427
  #### Average True Range
428
428
 
429
429
 
430
- Returns the Average True Range values of Stock Prices for the Security with the given `identifier`
430
+ 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.
431
431
 
432
432
  [//]: # (END_OVERVIEW)
433
433
 
@@ -517,7 +517,7 @@ Name | Type | Description | Notes
517
517
  #### Bollinger Bands
518
518
 
519
519
 
520
- Returns the Bollinger Bands values of Stock Prices for the Security with the given `identifier`
520
+ 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.
521
521
 
522
522
  [//]: # (END_OVERVIEW)
523
523
 
@@ -611,7 +611,7 @@ Name | Type | Description | Notes
611
611
  #### Commodity Channel Index
612
612
 
613
613
 
614
- Returns the Commodity Channel Index values of Stock Prices for the Security with the given `identifier`
614
+ 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.
615
615
 
616
616
  [//]: # (END_OVERVIEW)
617
617
 
@@ -703,7 +703,7 @@ Name | Type | Description | Notes
703
703
  #### Chaikin Money Flow
704
704
 
705
705
 
706
- Returns the Chaikin Money Flow values of Stock Prices for the Security with the given `identifier`
706
+ 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.
707
707
 
708
708
  [//]: # (END_OVERVIEW)
709
709
 
@@ -793,7 +793,7 @@ Name | Type | Description | Notes
793
793
  #### Donchian Channel
794
794
 
795
795
 
796
- Returns the Donchian Channel values of Stock Prices for the Security with the given `identifier`
796
+ 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).
797
797
 
798
798
  [//]: # (END_OVERVIEW)
799
799
 
@@ -885,7 +885,7 @@ Name | Type | Description | Notes
885
885
  #### Detrended Price Oscillator
886
886
 
887
887
 
888
- Returns the Detrended Price Oscillator values of Stock Prices for the Security with the given `identifier`
888
+ 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.
889
889
 
890
890
  [//]: # (END_OVERVIEW)
891
891
 
@@ -977,7 +977,7 @@ Name | Type | Description | Notes
977
977
  #### Ease of Movement
978
978
 
979
979
 
980
- Returns the Ease of Movement values of Stock Prices for the Security with the given `identifier`
980
+ 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.
981
981
 
982
982
  [//]: # (END_OVERVIEW)
983
983
 
@@ -1067,7 +1067,7 @@ Name | Type | Description | Notes
1067
1067
  #### Force Index
1068
1068
 
1069
1069
 
1070
- Returns the Force Index values of Stock Prices for the Security with the given `identifier`
1070
+ 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.
1071
1071
 
1072
1072
  [//]: # (END_OVERVIEW)
1073
1073
 
@@ -1155,7 +1155,7 @@ Name | Type | Description | Notes
1155
1155
  #### Ichimoku Kinko Hyo
1156
1156
 
1157
1157
 
1158
- Returns the Ichimoku Kinko Hyo values of Stock Prices for the Security with the given `identifier`
1158
+ The Ichimoku Kinko Hyo was designed to be an all-in-one trading indicator that could help traders determine momentum, support, and resistance.
1159
1159
 
1160
1160
  [//]: # (END_OVERVIEW)
1161
1161
 
@@ -1249,7 +1249,7 @@ Name | Type | Description | Notes
1249
1249
  #### Keltner Channel
1250
1250
 
1251
1251
 
1252
- Returns the Keltner Channel values of Stock Prices for the Security with the given `identifier`
1252
+ 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.
1253
1253
 
1254
1254
  [//]: # (END_OVERVIEW)
1255
1255
 
@@ -1339,7 +1339,7 @@ Name | Type | Description | Notes
1339
1339
  #### Know Sure Thing
1340
1340
 
1341
1341
 
1342
- Returns the Know Sure Thing values of Stock Prices for the Security with the given `identifier`
1342
+ 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.
1343
1343
 
1344
1344
  [//]: # (END_OVERVIEW)
1345
1345
 
@@ -1445,7 +1445,7 @@ Name | Type | Description | Notes
1445
1445
  #### Moving Average Convergence Divergence
1446
1446
 
1447
1447
 
1448
- Returns the Moving Average Convergence Divergence values of Stock Prices for the Security with the given `identifier`
1448
+ 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.
1449
1449
 
1450
1450
  [//]: # (END_OVERVIEW)
1451
1451
 
@@ -1541,7 +1541,7 @@ Name | Type | Description | Notes
1541
1541
  #### Money Flow Index
1542
1542
 
1543
1543
 
1544
- Returns the Money Flow Index values of Stock Prices for the Security with the given `identifier`
1544
+ 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.
1545
1545
 
1546
1546
  [//]: # (END_OVERVIEW)
1547
1547
 
@@ -1631,7 +1631,7 @@ Name | Type | Description | Notes
1631
1631
  #### Mass Index
1632
1632
 
1633
1633
 
1634
- Returns the Mass Index values of Stock Prices for the Security with the given `identifier`
1634
+ 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.
1635
1635
 
1636
1636
  [//]: # (END_OVERVIEW)
1637
1637
 
@@ -1723,7 +1723,7 @@ Name | Type | Description | Notes
1723
1723
  #### Negative Volume Index
1724
1724
 
1725
1725
 
1726
- Returns the Negative Volume Index values of Stock Prices for the Security with the given `identifier`
1726
+ 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.
1727
1727
 
1728
1728
  [//]: # (END_OVERVIEW)
1729
1729
 
@@ -1811,7 +1811,7 @@ Name | Type | Description | Notes
1811
1811
  #### On-balance Volume
1812
1812
 
1813
1813
 
1814
- Returns the On-balance Volume values of Stock Prices for the Security with the given `identifier`
1814
+ 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.
1815
1815
 
1816
1816
  [//]: # (END_OVERVIEW)
1817
1817
 
@@ -1899,7 +1899,7 @@ Name | Type | Description | Notes
1899
1899
  #### On-balance Volume Mean
1900
1900
 
1901
1901
 
1902
- Returns the On-balance Volume Mean values of Stock Prices for the Security with the given `identifier`
1902
+ 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.
1903
1903
 
1904
1904
  [//]: # (END_OVERVIEW)
1905
1905
 
@@ -1989,7 +1989,7 @@ Name | Type | Description | Notes
1989
1989
  #### Relative Strength Index
1990
1990
 
1991
1991
 
1992
- Returns the Relative Strength Index values of Stock Prices for the Security with the given `identifier`
1992
+ 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.
1993
1993
 
1994
1994
  [//]: # (END_OVERVIEW)
1995
1995
 
@@ -2081,7 +2081,7 @@ Name | Type | Description | Notes
2081
2081
  #### Simple Moving Average
2082
2082
 
2083
2083
 
2084
- Returns the Simple Moving Average values of Stock Prices for the Security with the given `identifier`
2084
+ 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.
2085
2085
 
2086
2086
  [//]: # (END_OVERVIEW)
2087
2087
 
@@ -2173,7 +2173,7 @@ Name | Type | Description | Notes
2173
2173
  #### Stochastic Oscillator
2174
2174
 
2175
2175
 
2176
- Returns the Stochastic Oscillator values of Stock Prices for the Security with the given `identifier`
2176
+ 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.
2177
2177
 
2178
2178
  [//]: # (END_OVERVIEW)
2179
2179
 
@@ -2265,7 +2265,7 @@ Name | Type | Description | Notes
2265
2265
  #### Triple Exponential Average
2266
2266
 
2267
2267
 
2268
- Returns the Simple Moving Average values of Stock Prices for the Security with the given `identifier`
2268
+ 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.
2269
2269
 
2270
2270
  [//]: # (END_OVERVIEW)
2271
2271
 
@@ -2355,7 +2355,7 @@ Name | Type | Description | Notes
2355
2355
  #### True Strength Index
2356
2356
 
2357
2357
 
2358
- Returns the True Strength Index values of Stock Prices for the Security with the given `identifier`
2358
+ 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.
2359
2359
 
2360
2360
  [//]: # (END_OVERVIEW)
2361
2361
 
@@ -2449,7 +2449,7 @@ Name | Type | Description | Notes
2449
2449
  #### Ultimate Oscillator
2450
2450
 
2451
2451
 
2452
- Returns the Ultimate Oscillator values of Stock Prices for the Security with the given `identifier`
2452
+ 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.
2453
2453
 
2454
2454
  [//]: # (END_OVERVIEW)
2455
2455
 
@@ -2549,7 +2549,7 @@ Name | Type | Description | Notes
2549
2549
  #### Vortex Indicator
2550
2550
 
2551
2551
 
2552
- Returns the Vortex Indicator values of Stock Prices for the Security with the given `identifier`
2552
+ 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.
2553
2553
 
2554
2554
  [//]: # (END_OVERVIEW)
2555
2555
 
@@ -2639,7 +2639,7 @@ Name | Type | Description | Notes
2639
2639
  #### Volume-price Trend
2640
2640
 
2641
2641
 
2642
- Returns the Volume-price Trend values of Stock Prices for the Security with the given `identifier`
2642
+ 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.
2643
2643
 
2644
2644
  [//]: # (END_OVERVIEW)
2645
2645
 
@@ -2727,7 +2727,7 @@ Name | Type | Description | Notes
2727
2727
  #### Volume Weighted Average Price
2728
2728
 
2729
2729
 
2730
- Returns the Volume Weighted Average Price values of Stock Prices for the Security with the given `identifier`
2730
+ 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.
2731
2731
 
2732
2732
  [//]: # (END_OVERVIEW)
2733
2733
 
@@ -2815,7 +2815,7 @@ Name | Type | Description | Notes
2815
2815
  #### Williams %R
2816
2816
 
2817
2817
 
2818
- Returns the Williams %R values of Stock Prices for the Security with the given `identifier`
2818
+ 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.
2819
2819
 
2820
2820
  [//]: # (END_OVERVIEW)
2821
2821
 
data/intrinio-sdk.gemspec CHANGED
@@ -5,7 +5,7 @@
5
5
 
6
6
  #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.
7
7
 
8
- OpenAPI spec version: 2.27.5
8
+ OpenAPI spec version: 2.28.0
9
9
 
10
10
  Generated by: https://github.com/swagger-api/swagger-codegen.git
11
11
  Swagger Codegen version: unset
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://docs.intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
5
5
 
6
- OpenAPI spec version: 2.27.5
6
+ OpenAPI spec version: 2.28.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: unset