intrinio-sdk 2.2.0 → 2.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (548) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +116 -2
  3. data/docs/ApiResponseCryptoAccumulationDistributionIndex.md +13 -0
  4. data/docs/ApiResponseCryptoAverageDailyTradingVolume.md +13 -0
  5. data/docs/ApiResponseCryptoAverageDirectionalIndex.md +13 -0
  6. data/docs/ApiResponseCryptoAverageTrueRange.md +13 -0
  7. data/docs/ApiResponseCryptoAwesomeOscillator.md +13 -0
  8. data/docs/ApiResponseCryptoBollingerBands.md +13 -0
  9. data/docs/ApiResponseCryptoChaikinMoneyFlow.md +13 -0
  10. data/docs/ApiResponseCryptoCommodityChannelIndex.md +13 -0
  11. data/docs/ApiResponseCryptoDetrendedPriceOscillator.md +13 -0
  12. data/docs/ApiResponseCryptoDonchianChannel.md +13 -0
  13. data/docs/ApiResponseCryptoEaseOfMovement.md +13 -0
  14. data/docs/ApiResponseCryptoForceIndex.md +13 -0
  15. data/docs/ApiResponseCryptoIchimokuKinkoHyo.md +13 -0
  16. data/docs/ApiResponseCryptoKeltnerChannel.md +13 -0
  17. data/docs/ApiResponseCryptoKnowSureThing.md +13 -0
  18. data/docs/ApiResponseCryptoMassIndex.md +13 -0
  19. data/docs/ApiResponseCryptoMoneyFlowIndex.md +13 -0
  20. data/docs/ApiResponseCryptoMovingAverageConvergenceDivergence.md +13 -0
  21. data/docs/ApiResponseCryptoNegativeVolumeIndex.md +13 -0
  22. data/docs/ApiResponseCryptoOnBalanceVolume.md +13 -0
  23. data/docs/ApiResponseCryptoOnBalanceVolumeMean.md +13 -0
  24. data/docs/ApiResponseCryptoRelativeStrengthIndex.md +13 -0
  25. data/docs/ApiResponseCryptoSimpleMovingAverage.md +13 -0
  26. data/docs/ApiResponseCryptoStochasticOscillator.md +13 -0
  27. data/docs/ApiResponseCryptoTripleExponentialAverage.md +13 -0
  28. data/docs/ApiResponseCryptoTrueStrengthIndex.md +13 -0
  29. data/docs/ApiResponseCryptoUltimateOscillator.md +13 -0
  30. data/docs/ApiResponseCryptoVolumePriceTrend.md +13 -0
  31. data/docs/ApiResponseCryptoVolumeWeightedAveragePrice.md +13 -0
  32. data/docs/ApiResponseCryptoVortexIndicator.md +13 -0
  33. data/docs/ApiResponseCryptoWilliamsR.md +13 -0
  34. data/docs/ApiResponseOptionsChain.md +1 -1
  35. data/docs/ApiResponseSecurityZacksAnalystRatings.md +10 -0
  36. data/docs/ApiResponseSecurityZacksAnalystRatingsSnapshot.md +9 -0
  37. data/docs/ApiResponseSecurityZacksEPSSurprises.md +10 -0
  38. data/docs/ApiResponseSecurityZacksSalesSurprises.md +10 -0
  39. data/docs/ApiResponseZacksAnalystRatings.md +9 -0
  40. data/docs/ApiResponseZacksEPSSurprises.md +9 -0
  41. data/docs/ApiResponseZacksSalesSurprises.md +9 -0
  42. data/docs/Company.md +4 -0
  43. data/docs/CompanyApi.md +240 -36
  44. data/docs/CryptoApi.md +2769 -57
  45. data/docs/CryptoPrice.md +1 -1
  46. data/docs/DataPointApi.md +44 -10
  47. data/docs/DataTagApi.md +55 -4
  48. data/docs/FilingApi.md +128 -9
  49. data/docs/ForexApi.md +57 -6
  50. data/docs/Fundamental.md +1 -1
  51. data/docs/FundamentalsApi.md +68 -0
  52. data/docs/HistoricalDataApi.md +25 -8
  53. data/docs/IndexApi.md +331 -25
  54. data/docs/MunicipalityApi.md +51 -0
  55. data/docs/OptionsApi.md +74 -6
  56. data/docs/SecurityApi.md +1108 -78
  57. data/docs/StockExchangeApi.md +117 -15
  58. data/docs/TechnicalApi.md +3121 -37
  59. data/docs/ZacksAnalystRating.md +17 -0
  60. data/docs/ZacksAnalystRatingSnapshot.md +18 -0
  61. data/docs/ZacksAnalystRatingSummary.md +16 -0
  62. data/docs/ZacksApi.md +281 -0
  63. data/docs/ZacksEPSSurprise.md +24 -0
  64. data/docs/ZacksEPSSurpriseSummary.md +23 -0
  65. data/docs/ZacksSalesSurprise.md +24 -0
  66. data/docs/ZacksSalesSurpriseSummary.md +25 -0
  67. data/intrinio-sdk.gemspec +1 -1
  68. data/lib/intrinio-sdk.rb +47 -1
  69. data/lib/intrinio-sdk/api/company_api.rb +33 -33
  70. data/lib/intrinio-sdk/api/crypto_api.rb +3108 -8
  71. data/lib/intrinio-sdk/api/data_point_api.rb +13 -13
  72. data/lib/intrinio-sdk/api/data_tag_api.rb +5 -5
  73. data/lib/intrinio-sdk/api/filing_api.rb +9 -9
  74. data/lib/intrinio-sdk/api/forex_api.rb +7 -6
  75. data/lib/intrinio-sdk/api/fundamentals_api.rb +1 -1
  76. data/lib/intrinio-sdk/api/historical_data_api.rb +9 -9
  77. data/lib/intrinio-sdk/api/index_api.rb +23 -23
  78. data/lib/intrinio-sdk/api/municipality_api.rb +1 -1
  79. data/lib/intrinio-sdk/api/options_api.rb +7 -7
  80. data/lib/intrinio-sdk/api/security_api.rb +393 -42
  81. data/lib/intrinio-sdk/api/stock_exchange_api.rb +11 -11
  82. data/lib/intrinio-sdk/api/technical_api.rb +3108 -12
  83. data/lib/intrinio-sdk/api/zacks_api.rb +393 -0
  84. data/lib/intrinio-sdk/api_client.rb +1 -1
  85. data/lib/intrinio-sdk/api_error.rb +1 -1
  86. data/lib/intrinio-sdk/configuration.rb +1 -1
  87. data/lib/intrinio-sdk/models/accumulation_distribution_index_technical_value.rb +1 -1
  88. data/lib/intrinio-sdk/models/api_response_companies.rb +1 -1
  89. data/lib/intrinio-sdk/models/api_response_companies_search.rb +1 -1
  90. data/lib/intrinio-sdk/models/api_response_company_filings.rb +1 -1
  91. data/lib/intrinio-sdk/models/api_response_company_fundamentals.rb +1 -1
  92. data/lib/intrinio-sdk/models/api_response_company_historical_data.rb +1 -1
  93. data/lib/intrinio-sdk/models/api_response_company_news.rb +1 -1
  94. data/lib/intrinio-sdk/models/api_response_company_securities.rb +1 -1
  95. data/lib/intrinio-sdk/models/api_response_crypto_accumulation_distribution_index.rb +238 -0
  96. data/lib/intrinio-sdk/models/api_response_crypto_average_daily_trading_volume.rb +238 -0
  97. data/lib/intrinio-sdk/models/api_response_crypto_average_directional_index.rb +238 -0
  98. data/lib/intrinio-sdk/models/api_response_crypto_average_true_range.rb +238 -0
  99. data/lib/intrinio-sdk/models/api_response_crypto_awesome_oscillator.rb +238 -0
  100. data/lib/intrinio-sdk/models/api_response_crypto_bollinger_bands.rb +238 -0
  101. data/lib/intrinio-sdk/models/api_response_crypto_book.rb +1 -1
  102. data/lib/intrinio-sdk/models/api_response_crypto_book_asks.rb +1 -1
  103. data/lib/intrinio-sdk/models/api_response_crypto_book_bids.rb +1 -1
  104. data/lib/intrinio-sdk/models/api_response_crypto_chaikin_money_flow.rb +238 -0
  105. data/lib/intrinio-sdk/models/api_response_crypto_commodity_channel_index.rb +238 -0
  106. data/lib/intrinio-sdk/models/api_response_crypto_currencies.rb +1 -1
  107. data/lib/intrinio-sdk/models/api_response_crypto_detrended_price_oscillator.rb +238 -0
  108. data/lib/intrinio-sdk/models/api_response_crypto_donchian_channel.rb +238 -0
  109. data/lib/intrinio-sdk/models/api_response_crypto_ease_of_movement.rb +238 -0
  110. data/lib/intrinio-sdk/models/api_response_crypto_exchanges.rb +1 -1
  111. data/lib/intrinio-sdk/models/api_response_crypto_force_index.rb +238 -0
  112. data/lib/intrinio-sdk/models/api_response_crypto_ichimoku_kinko_hyo.rb +238 -0
  113. data/lib/intrinio-sdk/models/api_response_crypto_keltner_channel.rb +238 -0
  114. data/lib/intrinio-sdk/models/api_response_crypto_know_sure_thing.rb +238 -0
  115. data/lib/intrinio-sdk/models/api_response_crypto_mass_index.rb +238 -0
  116. data/lib/intrinio-sdk/models/api_response_crypto_money_flow_index.rb +238 -0
  117. data/lib/intrinio-sdk/models/api_response_crypto_moving_average_convergence_divergence.rb +238 -0
  118. data/lib/intrinio-sdk/models/api_response_crypto_negative_volume_index.rb +238 -0
  119. data/lib/intrinio-sdk/models/api_response_crypto_on_balance_volume.rb +238 -0
  120. data/lib/intrinio-sdk/models/api_response_crypto_on_balance_volume_mean.rb +238 -0
  121. data/lib/intrinio-sdk/models/api_response_crypto_pairs.rb +1 -1
  122. data/lib/intrinio-sdk/models/api_response_crypto_prices.rb +1 -1
  123. data/lib/intrinio-sdk/models/api_response_crypto_relative_strength_index.rb +238 -0
  124. data/lib/intrinio-sdk/models/api_response_crypto_simple_moving_average.rb +238 -0
  125. data/lib/intrinio-sdk/models/api_response_crypto_snapshot.rb +1 -1
  126. data/lib/intrinio-sdk/models/api_response_crypto_stats.rb +1 -1
  127. data/lib/intrinio-sdk/models/api_response_crypto_stochastic_oscillator.rb +238 -0
  128. data/lib/intrinio-sdk/models/api_response_crypto_triple_exponential_average.rb +238 -0
  129. data/lib/intrinio-sdk/models/api_response_crypto_true_strength_index.rb +238 -0
  130. data/lib/intrinio-sdk/models/api_response_crypto_ultimate_oscillator.rb +238 -0
  131. data/lib/intrinio-sdk/models/api_response_crypto_volume_price_trend.rb +238 -0
  132. data/lib/intrinio-sdk/models/api_response_crypto_volume_weighted_average_price.rb +238 -0
  133. data/lib/intrinio-sdk/models/api_response_crypto_vortex_indicator.rb +238 -0
  134. data/lib/intrinio-sdk/models/api_response_crypto_williams_r.rb +238 -0
  135. data/lib/intrinio-sdk/models/api_response_data_tags.rb +1 -1
  136. data/lib/intrinio-sdk/models/api_response_data_tags_search.rb +1 -1
  137. data/lib/intrinio-sdk/models/api_response_economic_index_historical_data.rb +1 -1
  138. data/lib/intrinio-sdk/models/api_response_economic_indices.rb +1 -1
  139. data/lib/intrinio-sdk/models/api_response_economic_indices_search.rb +1 -1
  140. data/lib/intrinio-sdk/models/api_response_filing_notes.rb +1 -1
  141. data/lib/intrinio-sdk/models/api_response_filing_notes_search.rb +1 -1
  142. data/lib/intrinio-sdk/models/api_response_filings.rb +1 -1
  143. data/lib/intrinio-sdk/models/api_response_forex_currencies.rb +1 -1
  144. data/lib/intrinio-sdk/models/api_response_forex_pairs.rb +1 -1
  145. data/lib/intrinio-sdk/models/api_response_forex_prices.rb +1 -1
  146. data/lib/intrinio-sdk/models/api_response_historical_data.rb +1 -1
  147. data/lib/intrinio-sdk/models/api_response_municipalities.rb +1 -1
  148. data/lib/intrinio-sdk/models/api_response_municipalitiy_financials.rb +1 -1
  149. data/lib/intrinio-sdk/models/api_response_news.rb +1 -1
  150. data/lib/intrinio-sdk/models/api_response_option_prices.rb +1 -1
  151. data/lib/intrinio-sdk/models/api_response_options.rb +1 -1
  152. data/lib/intrinio-sdk/models/api_response_options_chain.rb +9 -9
  153. data/lib/intrinio-sdk/models/api_response_options_expirations.rb +1 -1
  154. data/lib/intrinio-sdk/models/api_response_reported_financials.rb +1 -1
  155. data/lib/intrinio-sdk/models/api_response_securities.rb +1 -1
  156. data/lib/intrinio-sdk/models/api_response_securities_search.rb +1 -1
  157. data/lib/intrinio-sdk/models/api_response_security_accumulation_distribution_index.rb +1 -1
  158. data/lib/intrinio-sdk/models/api_response_security_average_daily_trading_volume.rb +1 -1
  159. data/lib/intrinio-sdk/models/api_response_security_average_directional_index.rb +1 -1
  160. data/lib/intrinio-sdk/models/api_response_security_average_true_range.rb +1 -1
  161. data/lib/intrinio-sdk/models/api_response_security_awesome_oscillator.rb +1 -1
  162. data/lib/intrinio-sdk/models/api_response_security_bollinger_bands.rb +1 -1
  163. data/lib/intrinio-sdk/models/api_response_security_chaikin_money_flow.rb +1 -1
  164. data/lib/intrinio-sdk/models/api_response_security_commodity_channel_index.rb +1 -1
  165. data/lib/intrinio-sdk/models/api_response_security_detrended_price_oscillator.rb +1 -1
  166. data/lib/intrinio-sdk/models/api_response_security_donchian_channel.rb +1 -1
  167. data/lib/intrinio-sdk/models/api_response_security_ease_of_movement.rb +1 -1
  168. data/lib/intrinio-sdk/models/api_response_security_force_index.rb +1 -1
  169. data/lib/intrinio-sdk/models/api_response_security_historical_data.rb +1 -1
  170. data/lib/intrinio-sdk/models/api_response_security_ichimoku_kinko_hyo.rb +1 -1
  171. data/lib/intrinio-sdk/models/api_response_security_intraday_prices.rb +1 -1
  172. data/lib/intrinio-sdk/models/api_response_security_keltner_channel.rb +1 -1
  173. data/lib/intrinio-sdk/models/api_response_security_know_sure_thing.rb +1 -1
  174. data/lib/intrinio-sdk/models/api_response_security_mass_index.rb +1 -1
  175. data/lib/intrinio-sdk/models/api_response_security_money_flow_index.rb +1 -1
  176. data/lib/intrinio-sdk/models/api_response_security_moving_average_convergence_divergence.rb +1 -1
  177. data/lib/intrinio-sdk/models/api_response_security_negative_volume_index.rb +1 -1
  178. data/lib/intrinio-sdk/models/api_response_security_on_balance_volume.rb +1 -1
  179. data/lib/intrinio-sdk/models/api_response_security_on_balance_volume_mean.rb +1 -1
  180. data/lib/intrinio-sdk/models/api_response_security_relative_strength_index.rb +1 -1
  181. data/lib/intrinio-sdk/models/api_response_security_simple_moving_average.rb +1 -1
  182. data/lib/intrinio-sdk/models/api_response_security_stochastic_oscillator.rb +1 -1
  183. data/lib/intrinio-sdk/models/api_response_security_stock_price_adjustments.rb +1 -1
  184. data/lib/intrinio-sdk/models/api_response_security_stock_prices.rb +1 -1
  185. data/lib/intrinio-sdk/models/api_response_security_triple_exponential_average.rb +1 -1
  186. data/lib/intrinio-sdk/models/api_response_security_true_strength_index.rb +1 -1
  187. data/lib/intrinio-sdk/models/api_response_security_ultimate_oscillator.rb +1 -1
  188. data/lib/intrinio-sdk/models/api_response_security_volume_price_trend.rb +1 -1
  189. data/lib/intrinio-sdk/models/api_response_security_volume_weighted_average_price.rb +1 -1
  190. data/lib/intrinio-sdk/models/api_response_security_vortex_indicator.rb +1 -1
  191. data/lib/intrinio-sdk/models/api_response_security_williams_r.rb +1 -1
  192. data/lib/intrinio-sdk/models/api_response_security_zacks_analyst_ratings.rb +210 -0
  193. data/lib/intrinio-sdk/models/api_response_security_zacks_analyst_ratings_snapshot.rb +200 -0
  194. data/lib/intrinio-sdk/models/api_response_security_zacks_eps_surprises.rb +210 -0
  195. data/lib/intrinio-sdk/models/api_response_security_zacks_sales_surprises.rb +210 -0
  196. data/lib/intrinio-sdk/models/api_response_sic_index_historical_data.rb +1 -1
  197. data/lib/intrinio-sdk/models/api_response_sic_indices.rb +1 -1
  198. data/lib/intrinio-sdk/models/api_response_sic_indices_search.rb +1 -1
  199. data/lib/intrinio-sdk/models/api_response_standardized_financials.rb +1 -1
  200. data/lib/intrinio-sdk/models/api_response_stock_exchange_realtime_stock_prices.rb +1 -1
  201. data/lib/intrinio-sdk/models/api_response_stock_exchange_securities.rb +1 -1
  202. data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_price_adjustments.rb +1 -1
  203. data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_prices.rb +1 -1
  204. data/lib/intrinio-sdk/models/api_response_stock_exchanges.rb +1 -1
  205. data/lib/intrinio-sdk/models/api_response_stock_market_index_historical_data.rb +1 -1
  206. data/lib/intrinio-sdk/models/api_response_stock_market_indices.rb +1 -1
  207. data/lib/intrinio-sdk/models/api_response_stock_market_indices_search.rb +1 -1
  208. data/lib/intrinio-sdk/models/api_response_zacks_analyst_ratings.rb +200 -0
  209. data/lib/intrinio-sdk/models/api_response_zacks_eps_surprises.rb +201 -0
  210. data/lib/intrinio-sdk/models/api_response_zacks_sales_surprises.rb +201 -0
  211. data/lib/intrinio-sdk/models/average_daily_trading_volume_technical_value.rb +1 -1
  212. data/lib/intrinio-sdk/models/average_directional_index_technical_value.rb +1 -1
  213. data/lib/intrinio-sdk/models/average_true_range_technical_value.rb +1 -1
  214. data/lib/intrinio-sdk/models/awesome_oscillator_technical_value.rb +1 -1
  215. data/lib/intrinio-sdk/models/bollinger_bands_technical_value.rb +1 -1
  216. data/lib/intrinio-sdk/models/chaikin_money_flow_technical_value.rb +1 -1
  217. data/lib/intrinio-sdk/models/commodity_channel_index_technical_value.rb +1 -1
  218. data/lib/intrinio-sdk/models/company.rb +45 -5
  219. data/lib/intrinio-sdk/models/company_filing.rb +1 -1
  220. data/lib/intrinio-sdk/models/company_news.rb +1 -1
  221. data/lib/intrinio-sdk/models/company_news_summary.rb +1 -1
  222. data/lib/intrinio-sdk/models/company_summary.rb +1 -1
  223. data/lib/intrinio-sdk/models/crypto_ask.rb +1 -1
  224. data/lib/intrinio-sdk/models/crypto_bid.rb +1 -1
  225. data/lib/intrinio-sdk/models/crypto_book_entry.rb +1 -1
  226. data/lib/intrinio-sdk/models/crypto_currency.rb +1 -1
  227. data/lib/intrinio-sdk/models/crypto_exchange.rb +1 -1
  228. data/lib/intrinio-sdk/models/crypto_exchange_summary.rb +1 -1
  229. data/lib/intrinio-sdk/models/crypto_pair.rb +1 -1
  230. data/lib/intrinio-sdk/models/crypto_pair_summary.rb +1 -1
  231. data/lib/intrinio-sdk/models/crypto_price.rb +2 -2
  232. data/lib/intrinio-sdk/models/crypto_snapshot.rb +1 -1
  233. data/lib/intrinio-sdk/models/crypto_stat.rb +1 -1
  234. data/lib/intrinio-sdk/models/data_tag.rb +1 -1
  235. data/lib/intrinio-sdk/models/data_tag_summary.rb +1 -1
  236. data/lib/intrinio-sdk/models/detrended_price_oscillator_technical_value.rb +1 -1
  237. data/lib/intrinio-sdk/models/dividend_record.rb +1 -1
  238. data/lib/intrinio-sdk/models/donchian_channel_technical_value.rb +1 -1
  239. data/lib/intrinio-sdk/models/earnings_record.rb +1 -1
  240. data/lib/intrinio-sdk/models/ease_of_movement_technical_value.rb +1 -1
  241. data/lib/intrinio-sdk/models/economic_index.rb +1 -1
  242. data/lib/intrinio-sdk/models/economic_index_summary.rb +1 -1
  243. data/lib/intrinio-sdk/models/filing.rb +1 -1
  244. data/lib/intrinio-sdk/models/filing_note.rb +1 -1
  245. data/lib/intrinio-sdk/models/filing_note_filing.rb +1 -1
  246. data/lib/intrinio-sdk/models/filing_note_summary.rb +1 -1
  247. data/lib/intrinio-sdk/models/filing_summary.rb +1 -1
  248. data/lib/intrinio-sdk/models/force_index_technical_value.rb +1 -1
  249. data/lib/intrinio-sdk/models/forex_currency.rb +1 -1
  250. data/lib/intrinio-sdk/models/forex_pair.rb +1 -1
  251. data/lib/intrinio-sdk/models/forex_price.rb +1 -1
  252. data/lib/intrinio-sdk/models/fundamental.rb +2 -2
  253. data/lib/intrinio-sdk/models/fundamental_summary.rb +1 -1
  254. data/lib/intrinio-sdk/models/historical_data.rb +1 -1
  255. data/lib/intrinio-sdk/models/ichimoku_kinko_hyo_technical_value.rb +1 -1
  256. data/lib/intrinio-sdk/models/intraday_stock_price.rb +1 -1
  257. data/lib/intrinio-sdk/models/keltner_channel_technical_value.rb +1 -1
  258. data/lib/intrinio-sdk/models/know_sure_thing_technical_value.rb +1 -1
  259. data/lib/intrinio-sdk/models/mass_index_technical_value.rb +1 -1
  260. data/lib/intrinio-sdk/models/money_flow_index_technical_value.rb +1 -1
  261. data/lib/intrinio-sdk/models/moving_average_convergence_divergence_technical_value.rb +1 -1
  262. data/lib/intrinio-sdk/models/municipality.rb +1 -1
  263. data/lib/intrinio-sdk/models/municipality_financial.rb +1 -1
  264. data/lib/intrinio-sdk/models/negative_volume_index_technical_value.rb +1 -1
  265. data/lib/intrinio-sdk/models/on_balance_volume_mean_technical_value.rb +1 -1
  266. data/lib/intrinio-sdk/models/on_balance_volume_technical_value.rb +1 -1
  267. data/lib/intrinio-sdk/models/option.rb +1 -1
  268. data/lib/intrinio-sdk/models/option_chain.rb +1 -1
  269. data/lib/intrinio-sdk/models/option_price.rb +1 -1
  270. data/lib/intrinio-sdk/models/realtime_stock_price.rb +1 -1
  271. data/lib/intrinio-sdk/models/realtime_stock_price_security.rb +1 -1
  272. data/lib/intrinio-sdk/models/relative_strength_index_technical_value.rb +1 -1
  273. data/lib/intrinio-sdk/models/reported_financial.rb +1 -1
  274. data/lib/intrinio-sdk/models/reported_financial_dimension.rb +1 -1
  275. data/lib/intrinio-sdk/models/reported_tag.rb +1 -1
  276. data/lib/intrinio-sdk/models/security.rb +1 -1
  277. data/lib/intrinio-sdk/models/security_screen_clause.rb +1 -1
  278. data/lib/intrinio-sdk/models/security_screen_group.rb +1 -1
  279. data/lib/intrinio-sdk/models/security_screen_result.rb +1 -1
  280. data/lib/intrinio-sdk/models/security_screen_result_data.rb +1 -1
  281. data/lib/intrinio-sdk/models/security_summary.rb +1 -1
  282. data/lib/intrinio-sdk/models/sic_index.rb +1 -1
  283. data/lib/intrinio-sdk/models/simple_moving_average_technical_value.rb +1 -1
  284. data/lib/intrinio-sdk/models/standardized_financial.rb +1 -1
  285. data/lib/intrinio-sdk/models/stochastic_oscillator_technical_value.rb +1 -1
  286. data/lib/intrinio-sdk/models/stock_exchange.rb +1 -1
  287. data/lib/intrinio-sdk/models/stock_market_index.rb +1 -1
  288. data/lib/intrinio-sdk/models/stock_market_index_summary.rb +1 -1
  289. data/lib/intrinio-sdk/models/stock_price.rb +1 -1
  290. data/lib/intrinio-sdk/models/stock_price_adjustment.rb +1 -1
  291. data/lib/intrinio-sdk/models/stock_price_adjustment_summary.rb +1 -1
  292. data/lib/intrinio-sdk/models/stock_price_summary.rb +1 -1
  293. data/lib/intrinio-sdk/models/technical_indicator.rb +1 -1
  294. data/lib/intrinio-sdk/models/triple_exponential_average_technical_value.rb +1 -1
  295. data/lib/intrinio-sdk/models/true_strength_index_technical_value.rb +1 -1
  296. data/lib/intrinio-sdk/models/ultimate_oscillator_technical_value.rb +1 -1
  297. data/lib/intrinio-sdk/models/volume_price_trend_technical_value.rb +1 -1
  298. data/lib/intrinio-sdk/models/volume_weighted_average_price_value.rb +1 -1
  299. data/lib/intrinio-sdk/models/vortex_indicator_technical_value.rb +1 -1
  300. data/lib/intrinio-sdk/models/williams_r_technical_value.rb +1 -1
  301. data/lib/intrinio-sdk/models/zacks_analyst_rating.rb +279 -0
  302. data/lib/intrinio-sdk/models/zacks_analyst_rating_snapshot.rb +289 -0
  303. data/lib/intrinio-sdk/models/zacks_analyst_rating_summary.rb +269 -0
  304. data/lib/intrinio-sdk/models/zacks_eps_surprise.rb +349 -0
  305. data/lib/intrinio-sdk/models/zacks_eps_surprise_summary.rb +339 -0
  306. data/lib/intrinio-sdk/models/zacks_sales_surprise.rb +349 -0
  307. data/lib/intrinio-sdk/models/zacks_sales_surprise_summary.rb +359 -0
  308. data/lib/intrinio-sdk/version.rb +2 -2
  309. data/spec/api/company_api_spec.rb +17 -17
  310. data/spec/api/crypto_api_spec.rb +741 -4
  311. data/spec/api/data_point_api_spec.rb +7 -7
  312. data/spec/api/data_tag_api_spec.rb +3 -3
  313. data/spec/api/filing_api_spec.rb +5 -5
  314. data/spec/api/forex_api_spec.rb +3 -3
  315. data/spec/api/fundamentals_api_spec.rb +1 -1
  316. data/spec/api/historical_data_api_spec.rb +5 -5
  317. data/spec/api/index_api_spec.rb +12 -12
  318. data/spec/api/municipality_api_spec.rb +1 -1
  319. data/spec/api/options_api_spec.rb +4 -4
  320. data/spec/api/security_api_spec.rb +88 -19
  321. data/spec/api/stock_exchange_api_spec.rb +6 -6
  322. data/spec/api/technical_api_spec.rb +740 -4
  323. data/spec/api/zacks_api_spec.rb +119 -0
  324. data/spec/api_client_spec.rb +1 -1
  325. data/spec/configuration_spec.rb +1 -1
  326. data/spec/models/accumulation_distribution_index_technical_value_spec.rb +1 -1
  327. data/spec/models/api_response_companies_search_spec.rb +1 -1
  328. data/spec/models/api_response_companies_spec.rb +1 -1
  329. data/spec/models/api_response_company_filings_spec.rb +1 -1
  330. data/spec/models/api_response_company_fundamentals_spec.rb +1 -1
  331. data/spec/models/api_response_company_historical_data_spec.rb +1 -1
  332. data/spec/models/api_response_company_news_spec.rb +1 -1
  333. data/spec/models/api_response_company_securities_spec.rb +1 -1
  334. data/spec/models/api_response_crypto_accumulation_distribution_index_spec.rb +72 -0
  335. data/spec/models/api_response_crypto_average_daily_trading_volume_spec.rb +72 -0
  336. data/spec/models/api_response_crypto_average_directional_index_spec.rb +72 -0
  337. data/spec/models/api_response_crypto_average_true_range_spec.rb +72 -0
  338. data/spec/models/api_response_crypto_awesome_oscillator_spec.rb +72 -0
  339. data/spec/models/api_response_crypto_bollinger_bands_spec.rb +72 -0
  340. data/spec/models/api_response_crypto_book_asks_spec.rb +1 -1
  341. data/spec/models/api_response_crypto_book_bids_spec.rb +1 -1
  342. data/spec/models/api_response_crypto_book_spec.rb +1 -1
  343. data/spec/models/api_response_crypto_chaikin_money_flow_spec.rb +72 -0
  344. data/spec/models/api_response_crypto_commodity_channel_index_spec.rb +72 -0
  345. data/spec/models/api_response_crypto_currencies_spec.rb +1 -1
  346. data/spec/models/api_response_crypto_detrended_price_oscillator_spec.rb +72 -0
  347. data/spec/models/api_response_crypto_donchian_channel_spec.rb +72 -0
  348. data/spec/models/api_response_crypto_ease_of_movement_spec.rb +72 -0
  349. data/spec/models/api_response_crypto_exchanges_spec.rb +1 -1
  350. data/spec/models/api_response_crypto_force_index_spec.rb +72 -0
  351. data/spec/models/api_response_crypto_ichimoku_kinko_hyo_spec.rb +72 -0
  352. data/spec/models/api_response_crypto_keltner_channel_spec.rb +72 -0
  353. data/spec/models/api_response_crypto_know_sure_thing_spec.rb +72 -0
  354. data/spec/models/api_response_crypto_mass_index_spec.rb +72 -0
  355. data/spec/models/api_response_crypto_money_flow_index_spec.rb +72 -0
  356. data/spec/models/api_response_crypto_moving_average_convergence_divergence_spec.rb +72 -0
  357. data/spec/models/api_response_crypto_negative_volume_index_spec.rb +72 -0
  358. data/spec/models/api_response_crypto_on_balance_volume_mean_spec.rb +72 -0
  359. data/spec/models/api_response_crypto_on_balance_volume_spec.rb +72 -0
  360. data/spec/models/api_response_crypto_pairs_spec.rb +1 -1
  361. data/spec/models/api_response_crypto_prices_spec.rb +1 -1
  362. data/spec/models/api_response_crypto_relative_strength_index_spec.rb +72 -0
  363. data/spec/models/api_response_crypto_simple_moving_average_spec.rb +72 -0
  364. data/spec/models/api_response_crypto_snapshot_spec.rb +1 -1
  365. data/spec/models/api_response_crypto_stats_spec.rb +1 -1
  366. data/spec/models/api_response_crypto_stochastic_oscillator_spec.rb +72 -0
  367. data/spec/models/api_response_crypto_triple_exponential_average_spec.rb +72 -0
  368. data/spec/models/api_response_crypto_true_strength_index_spec.rb +72 -0
  369. data/spec/models/api_response_crypto_ultimate_oscillator_spec.rb +72 -0
  370. data/spec/models/api_response_crypto_volume_price_trend_spec.rb +72 -0
  371. data/spec/models/api_response_crypto_volume_weighted_average_price_spec.rb +72 -0
  372. data/spec/models/api_response_crypto_vortex_indicator_spec.rb +72 -0
  373. data/spec/models/api_response_crypto_williams_r_spec.rb +72 -0
  374. data/spec/models/api_response_data_tags_search_spec.rb +1 -1
  375. data/spec/models/api_response_data_tags_spec.rb +1 -1
  376. data/spec/models/api_response_economic_index_historical_data_spec.rb +1 -1
  377. data/spec/models/api_response_economic_indices_search_spec.rb +1 -1
  378. data/spec/models/api_response_economic_indices_spec.rb +1 -1
  379. data/spec/models/api_response_filing_notes_search_spec.rb +1 -1
  380. data/spec/models/api_response_filing_notes_spec.rb +1 -1
  381. data/spec/models/api_response_filings_spec.rb +1 -1
  382. data/spec/models/api_response_forex_currencies_spec.rb +1 -1
  383. data/spec/models/api_response_forex_pairs_spec.rb +1 -1
  384. data/spec/models/api_response_forex_prices_spec.rb +1 -1
  385. data/spec/models/api_response_historical_data_spec.rb +1 -1
  386. data/spec/models/api_response_municipalities_spec.rb +1 -1
  387. data/spec/models/api_response_municipalitiy_financials_spec.rb +1 -1
  388. data/spec/models/api_response_news_spec.rb +1 -1
  389. data/spec/models/api_response_option_prices_spec.rb +1 -1
  390. data/spec/models/api_response_options_chain_spec.rb +2 -2
  391. data/spec/models/api_response_options_expirations_spec.rb +1 -1
  392. data/spec/models/api_response_options_spec.rb +1 -1
  393. data/spec/models/api_response_reported_financials_spec.rb +1 -1
  394. data/spec/models/api_response_securities_search_spec.rb +1 -1
  395. data/spec/models/api_response_securities_spec.rb +1 -1
  396. data/spec/models/api_response_security_accumulation_distribution_index_spec.rb +1 -1
  397. data/spec/models/api_response_security_average_daily_trading_volume_spec.rb +1 -1
  398. data/spec/models/api_response_security_average_directional_index_spec.rb +1 -1
  399. data/spec/models/api_response_security_average_true_range_spec.rb +1 -1
  400. data/spec/models/api_response_security_awesome_oscillator_spec.rb +1 -1
  401. data/spec/models/api_response_security_bollinger_bands_spec.rb +1 -1
  402. data/spec/models/api_response_security_chaikin_money_flow_spec.rb +1 -1
  403. data/spec/models/api_response_security_commodity_channel_index_spec.rb +1 -1
  404. data/spec/models/api_response_security_detrended_price_oscillator_spec.rb +1 -1
  405. data/spec/models/api_response_security_donchian_channel_spec.rb +1 -1
  406. data/spec/models/api_response_security_ease_of_movement_spec.rb +1 -1
  407. data/spec/models/api_response_security_force_index_spec.rb +1 -1
  408. data/spec/models/api_response_security_historical_data_spec.rb +1 -1
  409. data/spec/models/api_response_security_ichimoku_kinko_hyo_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 +48 -0
  432. data/spec/models/api_response_security_zacks_analyst_ratings_spec.rb +54 -0
  433. data/spec/models/api_response_security_zacks_eps_surprises_spec.rb +54 -0
  434. data/spec/models/api_response_security_zacks_sales_surprises_spec.rb +54 -0
  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_spec.rb +1 -1
  439. data/spec/models/api_response_stock_exchange_realtime_stock_prices_spec.rb +1 -1
  440. data/spec/models/api_response_stock_exchange_securities_spec.rb +1 -1
  441. data/spec/models/api_response_stock_exchange_stock_price_adjustments_spec.rb +1 -1
  442. data/spec/models/api_response_stock_exchange_stock_prices_spec.rb +1 -1
  443. data/spec/models/api_response_stock_exchanges_spec.rb +1 -1
  444. data/spec/models/api_response_stock_market_index_historical_data_spec.rb +1 -1
  445. data/spec/models/api_response_stock_market_indices_search_spec.rb +1 -1
  446. data/spec/models/api_response_stock_market_indices_spec.rb +1 -1
  447. data/spec/models/api_response_zacks_analyst_ratings_spec.rb +48 -0
  448. data/spec/models/api_response_zacks_eps_surprises_spec.rb +48 -0
  449. data/spec/models/api_response_zacks_sales_surprises_spec.rb +48 -0
  450. data/spec/models/average_daily_trading_volume_technical_value_spec.rb +1 -1
  451. data/spec/models/average_directional_index_technical_value_spec.rb +1 -1
  452. data/spec/models/average_true_range_technical_value_spec.rb +1 -1
  453. data/spec/models/awesome_oscillator_technical_value_spec.rb +1 -1
  454. data/spec/models/bollinger_bands_technical_value_spec.rb +1 -1
  455. data/spec/models/chaikin_money_flow_technical_value_spec.rb +1 -1
  456. data/spec/models/commodity_channel_index_technical_value_spec.rb +1 -1
  457. data/spec/models/company_filing_spec.rb +1 -1
  458. data/spec/models/company_news_spec.rb +1 -1
  459. data/spec/models/company_news_summary_spec.rb +1 -1
  460. data/spec/models/company_spec.rb +25 -1
  461. data/spec/models/company_summary_spec.rb +1 -1
  462. data/spec/models/crypto_ask_spec.rb +1 -1
  463. data/spec/models/crypto_bid_spec.rb +1 -1
  464. data/spec/models/crypto_book_entry_spec.rb +1 -1
  465. data/spec/models/crypto_currency_spec.rb +1 -1
  466. data/spec/models/crypto_exchange_spec.rb +1 -1
  467. data/spec/models/crypto_exchange_summary_spec.rb +1 -1
  468. data/spec/models/crypto_pair_spec.rb +1 -1
  469. data/spec/models/crypto_pair_summary_spec.rb +1 -1
  470. data/spec/models/crypto_price_spec.rb +1 -1
  471. data/spec/models/crypto_snapshot_spec.rb +1 -1
  472. data/spec/models/crypto_stat_spec.rb +1 -1
  473. data/spec/models/data_tag_spec.rb +1 -1
  474. data/spec/models/data_tag_summary_spec.rb +1 -1
  475. data/spec/models/detrended_price_oscillator_technical_value_spec.rb +1 -1
  476. data/spec/models/dividend_record_spec.rb +1 -1
  477. data/spec/models/donchian_channel_technical_value_spec.rb +1 -1
  478. data/spec/models/earnings_record_spec.rb +1 -1
  479. data/spec/models/ease_of_movement_technical_value_spec.rb +1 -1
  480. data/spec/models/economic_index_spec.rb +1 -1
  481. data/spec/models/economic_index_summary_spec.rb +1 -1
  482. data/spec/models/filing_note_filing_spec.rb +1 -1
  483. data/spec/models/filing_note_spec.rb +1 -1
  484. data/spec/models/filing_note_summary_spec.rb +1 -1
  485. data/spec/models/filing_spec.rb +1 -1
  486. data/spec/models/filing_summary_spec.rb +1 -1
  487. data/spec/models/force_index_technical_value_spec.rb +1 -1
  488. data/spec/models/forex_currency_spec.rb +1 -1
  489. data/spec/models/forex_pair_spec.rb +1 -1
  490. data/spec/models/forex_price_spec.rb +1 -1
  491. data/spec/models/fundamental_spec.rb +1 -1
  492. data/spec/models/fundamental_summary_spec.rb +1 -1
  493. data/spec/models/historical_data_spec.rb +1 -1
  494. data/spec/models/ichimoku_kinko_hyo_technical_value_spec.rb +1 -1
  495. data/spec/models/intraday_stock_price_spec.rb +1 -1
  496. data/spec/models/keltner_channel_technical_value_spec.rb +1 -1
  497. data/spec/models/know_sure_thing_technical_value_spec.rb +1 -1
  498. data/spec/models/mass_index_technical_value_spec.rb +1 -1
  499. data/spec/models/money_flow_index_technical_value_spec.rb +1 -1
  500. data/spec/models/moving_average_convergence_divergence_technical_value_spec.rb +1 -1
  501. data/spec/models/municipality_financial_spec.rb +1 -1
  502. data/spec/models/municipality_spec.rb +1 -1
  503. data/spec/models/negative_volume_index_technical_value_spec.rb +1 -1
  504. data/spec/models/on_balance_volume_mean_technical_value_spec.rb +1 -1
  505. data/spec/models/on_balance_volume_technical_value_spec.rb +1 -1
  506. data/spec/models/option_chain_spec.rb +1 -1
  507. data/spec/models/option_price_spec.rb +1 -1
  508. data/spec/models/option_spec.rb +1 -1
  509. data/spec/models/realtime_stock_price_security_spec.rb +1 -1
  510. data/spec/models/realtime_stock_price_spec.rb +1 -1
  511. data/spec/models/relative_strength_index_technical_value_spec.rb +1 -1
  512. data/spec/models/reported_financial_dimension_spec.rb +1 -1
  513. data/spec/models/reported_financial_spec.rb +1 -1
  514. data/spec/models/reported_tag_spec.rb +1 -1
  515. data/spec/models/security_screen_clause_spec.rb +1 -1
  516. data/spec/models/security_screen_group_spec.rb +1 -1
  517. data/spec/models/security_screen_result_data_spec.rb +1 -1
  518. data/spec/models/security_screen_result_spec.rb +1 -1
  519. data/spec/models/security_spec.rb +1 -1
  520. data/spec/models/security_summary_spec.rb +1 -1
  521. data/spec/models/sic_index_spec.rb +1 -1
  522. data/spec/models/simple_moving_average_technical_value_spec.rb +1 -1
  523. data/spec/models/standardized_financial_spec.rb +1 -1
  524. data/spec/models/stochastic_oscillator_technical_value_spec.rb +1 -1
  525. data/spec/models/stock_exchange_spec.rb +1 -1
  526. data/spec/models/stock_market_index_spec.rb +1 -1
  527. data/spec/models/stock_market_index_summary_spec.rb +1 -1
  528. data/spec/models/stock_price_adjustment_spec.rb +1 -1
  529. data/spec/models/stock_price_adjustment_summary_spec.rb +1 -1
  530. data/spec/models/stock_price_spec.rb +1 -1
  531. data/spec/models/stock_price_summary_spec.rb +1 -1
  532. data/spec/models/technical_indicator_spec.rb +1 -1
  533. data/spec/models/triple_exponential_average_technical_value_spec.rb +1 -1
  534. data/spec/models/true_strength_index_technical_value_spec.rb +1 -1
  535. data/spec/models/ultimate_oscillator_technical_value_spec.rb +1 -1
  536. data/spec/models/volume_price_trend_technical_value_spec.rb +1 -1
  537. data/spec/models/volume_weighted_average_price_value_spec.rb +1 -1
  538. data/spec/models/vortex_indicator_technical_value_spec.rb +1 -1
  539. data/spec/models/williams_r_technical_value_spec.rb +1 -1
  540. data/spec/models/zacks_analyst_rating_snapshot_spec.rb +102 -0
  541. data/spec/models/zacks_analyst_rating_spec.rb +96 -0
  542. data/spec/models/zacks_analyst_rating_summary_spec.rb +90 -0
  543. data/spec/models/zacks_eps_surprise_spec.rb +138 -0
  544. data/spec/models/zacks_eps_surprise_summary_spec.rb +132 -0
  545. data/spec/models/zacks_sales_surprise_spec.rb +138 -0
  546. data/spec/models/zacks_sales_surprise_summary_spec.rb +144 -0
  547. data/spec/spec_helper.rb +1 -1
  548. metadata +186 -2
@@ -0,0 +1,13 @@
1
+ # Intrinio::ApiResponseCryptoMovingAverageConvergenceDivergence
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **technicals** | [**Array<MovingAverageConvergenceDivergenceTechnicalValue>**](MovingAverageConvergenceDivergenceTechnicalValue.md) | | [optional]
7
+ **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator | [optional]
8
+ **pair** | [**CryptoPairSummary**](CryptoPairSummary.md) | | [optional]
9
+ **exchange** | [**CryptoExchangeSummary**](CryptoExchangeSummary.md) | | [optional]
10
+ **timeframe** | **String** | The time interval for the crypto currency prices | [optional]
11
+ **next_page** | **String** | The token required to request the next page of the data | [optional]
12
+
13
+
@@ -0,0 +1,13 @@
1
+ # Intrinio::ApiResponseCryptoNegativeVolumeIndex
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **technicals** | [**Array<NegativeVolumeIndexTechnicalValue>**](NegativeVolumeIndexTechnicalValue.md) | | [optional]
7
+ **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator | [optional]
8
+ **pair** | [**CryptoPairSummary**](CryptoPairSummary.md) | | [optional]
9
+ **exchange** | [**CryptoExchangeSummary**](CryptoExchangeSummary.md) | | [optional]
10
+ **timeframe** | **String** | The time interval for the crypto currency prices | [optional]
11
+ **next_page** | **String** | The token required to request the next page of the data | [optional]
12
+
13
+
@@ -0,0 +1,13 @@
1
+ # Intrinio::ApiResponseCryptoOnBalanceVolume
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **technicals** | [**Array<OnBalanceVolumeTechnicalValue>**](OnBalanceVolumeTechnicalValue.md) | | [optional]
7
+ **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator | [optional]
8
+ **pair** | [**CryptoPairSummary**](CryptoPairSummary.md) | | [optional]
9
+ **exchange** | [**CryptoExchangeSummary**](CryptoExchangeSummary.md) | | [optional]
10
+ **timeframe** | **String** | The time interval for the crypto currency prices | [optional]
11
+ **next_page** | **String** | The token required to request the next page of the data | [optional]
12
+
13
+
@@ -0,0 +1,13 @@
1
+ # Intrinio::ApiResponseCryptoOnBalanceVolumeMean
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **technicals** | [**Array<OnBalanceVolumeMeanTechnicalValue>**](OnBalanceVolumeMeanTechnicalValue.md) | | [optional]
7
+ **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator | [optional]
8
+ **pair** | [**CryptoPairSummary**](CryptoPairSummary.md) | | [optional]
9
+ **exchange** | [**CryptoExchangeSummary**](CryptoExchangeSummary.md) | | [optional]
10
+ **timeframe** | **String** | The time interval for the crypto currency prices | [optional]
11
+ **next_page** | **String** | The token required to request the next page of the data | [optional]
12
+
13
+
@@ -0,0 +1,13 @@
1
+ # Intrinio::ApiResponseCryptoRelativeStrengthIndex
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **technicals** | [**Array<RelativeStrengthIndexTechnicalValue>**](RelativeStrengthIndexTechnicalValue.md) | | [optional]
7
+ **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator | [optional]
8
+ **pair** | [**CryptoPairSummary**](CryptoPairSummary.md) | | [optional]
9
+ **exchange** | [**CryptoExchangeSummary**](CryptoExchangeSummary.md) | | [optional]
10
+ **timeframe** | **String** | The time interval for the crypto currency prices | [optional]
11
+ **next_page** | **String** | The token required to request the next page of the data | [optional]
12
+
13
+
@@ -0,0 +1,13 @@
1
+ # Intrinio::ApiResponseCryptoSimpleMovingAverage
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **technicals** | [**Array<SimpleMovingAverageTechnicalValue>**](SimpleMovingAverageTechnicalValue.md) | | [optional]
7
+ **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator | [optional]
8
+ **pair** | [**CryptoPairSummary**](CryptoPairSummary.md) | | [optional]
9
+ **exchange** | [**CryptoExchangeSummary**](CryptoExchangeSummary.md) | | [optional]
10
+ **timeframe** | **String** | The time interval for the crypto currency prices | [optional]
11
+ **next_page** | **String** | The token required to request the next page of the data | [optional]
12
+
13
+
@@ -0,0 +1,13 @@
1
+ # Intrinio::ApiResponseCryptoStochasticOscillator
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **technicals** | [**Array<StochasticOscillatorTechnicalValue>**](StochasticOscillatorTechnicalValue.md) | | [optional]
7
+ **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator | [optional]
8
+ **pair** | [**CryptoPairSummary**](CryptoPairSummary.md) | | [optional]
9
+ **exchange** | [**CryptoExchangeSummary**](CryptoExchangeSummary.md) | | [optional]
10
+ **timeframe** | **String** | The time interval for the crypto currency prices | [optional]
11
+ **next_page** | **String** | The token required to request the next page of the data | [optional]
12
+
13
+
@@ -0,0 +1,13 @@
1
+ # Intrinio::ApiResponseCryptoTripleExponentialAverage
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **technicals** | [**Array<TripleExponentialAverageTechnicalValue>**](TripleExponentialAverageTechnicalValue.md) | | [optional]
7
+ **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator | [optional]
8
+ **pair** | [**CryptoPairSummary**](CryptoPairSummary.md) | | [optional]
9
+ **exchange** | [**CryptoExchangeSummary**](CryptoExchangeSummary.md) | | [optional]
10
+ **timeframe** | **String** | The time interval for the crypto currency prices | [optional]
11
+ **next_page** | **String** | The token required to request the next page of the data | [optional]
12
+
13
+
@@ -0,0 +1,13 @@
1
+ # Intrinio::ApiResponseCryptoTrueStrengthIndex
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **technicals** | [**Array<TrueStrengthIndexTechnicalValue>**](TrueStrengthIndexTechnicalValue.md) | | [optional]
7
+ **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator | [optional]
8
+ **pair** | [**CryptoPairSummary**](CryptoPairSummary.md) | | [optional]
9
+ **exchange** | [**CryptoExchangeSummary**](CryptoExchangeSummary.md) | | [optional]
10
+ **timeframe** | **String** | The time interval for the crypto currency prices | [optional]
11
+ **next_page** | **String** | The token required to request the next page of the data | [optional]
12
+
13
+
@@ -0,0 +1,13 @@
1
+ # Intrinio::ApiResponseCryptoUltimateOscillator
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **technicals** | [**Array<UltimateOscillatorTechnicalValue>**](UltimateOscillatorTechnicalValue.md) | | [optional]
7
+ **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator | [optional]
8
+ **pair** | [**CryptoPairSummary**](CryptoPairSummary.md) | | [optional]
9
+ **exchange** | [**CryptoExchangeSummary**](CryptoExchangeSummary.md) | | [optional]
10
+ **timeframe** | **String** | The time interval for the crypto currency prices | [optional]
11
+ **next_page** | **String** | The token required to request the next page of the data | [optional]
12
+
13
+
@@ -0,0 +1,13 @@
1
+ # Intrinio::ApiResponseCryptoVolumePriceTrend
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **technicals** | [**Array<VolumePriceTrendTechnicalValue>**](VolumePriceTrendTechnicalValue.md) | | [optional]
7
+ **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator | [optional]
8
+ **pair** | [**CryptoPairSummary**](CryptoPairSummary.md) | | [optional]
9
+ **exchange** | [**CryptoExchangeSummary**](CryptoExchangeSummary.md) | | [optional]
10
+ **timeframe** | **String** | The time interval for the crypto currency prices | [optional]
11
+ **next_page** | **String** | The token required to request the next page of the data | [optional]
12
+
13
+
@@ -0,0 +1,13 @@
1
+ # Intrinio::ApiResponseCryptoVolumeWeightedAveragePrice
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **technicals** | [**Array<VolumeWeightedAveragePriceValue>**](VolumeWeightedAveragePriceValue.md) | | [optional]
7
+ **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator | [optional]
8
+ **pair** | [**CryptoPairSummary**](CryptoPairSummary.md) | | [optional]
9
+ **exchange** | [**CryptoExchangeSummary**](CryptoExchangeSummary.md) | | [optional]
10
+ **timeframe** | **String** | The time interval for the crypto currency prices | [optional]
11
+ **next_page** | **String** | The token required to request the next page of the data | [optional]
12
+
13
+
@@ -0,0 +1,13 @@
1
+ # Intrinio::ApiResponseCryptoVortexIndicator
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **technicals** | [**Array<VortexIndicatorTechnicalValue>**](VortexIndicatorTechnicalValue.md) | | [optional]
7
+ **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator | [optional]
8
+ **pair** | [**CryptoPairSummary**](CryptoPairSummary.md) | | [optional]
9
+ **exchange** | [**CryptoExchangeSummary**](CryptoExchangeSummary.md) | | [optional]
10
+ **timeframe** | **String** | The time interval for the crypto currency prices | [optional]
11
+ **next_page** | **String** | The token required to request the next page of the data | [optional]
12
+
13
+
@@ -0,0 +1,13 @@
1
+ # Intrinio::ApiResponseCryptoWilliamsR
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **technicals** | [**Array<WilliamsRTechnicalValue>**](WilliamsRTechnicalValue.md) | | [optional]
7
+ **indicator** | [**TechnicalIndicator**](TechnicalIndicator.md) | The name and symbol of the technical indicator | [optional]
8
+ **pair** | [**CryptoPairSummary**](CryptoPairSummary.md) | | [optional]
9
+ **exchange** | [**CryptoExchangeSummary**](CryptoExchangeSummary.md) | | [optional]
10
+ **timeframe** | **String** | The time interval for the crypto currency prices | [optional]
11
+ **next_page** | **String** | The token required to request the next page of the data | [optional]
12
+
13
+
@@ -3,6 +3,6 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **chains** | [**Array<OptionChain>**](OptionChain.md) | A list of options for the provided expiration date their respective option prices. | [optional]
6
+ **chain** | [**Array<OptionChain>**](OptionChain.md) | A list of options for the provided expiration date their respective option prices. | [optional]
7
7
 
8
8
 
@@ -0,0 +1,10 @@
1
+ # Intrinio::ApiResponseSecurityZacksAnalystRatings
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **analyst_ratings** | [**Array<ZacksAnalystRatingSummary>**](ZacksAnalystRatingSummary.md) | | [optional]
7
+ **security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier | [optional]
8
+ **next_page** | **String** | The token required to request the next page of the data | [optional]
9
+
10
+
@@ -0,0 +1,9 @@
1
+ # Intrinio::ApiResponseSecurityZacksAnalystRatingsSnapshot
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **snapshots** | [**Array<ZacksAnalystRatingSnapshot>**](ZacksAnalystRatingSnapshot.md) | | [optional]
7
+ **security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier | [optional]
8
+
9
+
@@ -0,0 +1,10 @@
1
+ # Intrinio::ApiResponseSecurityZacksEPSSurprises
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **eps_surprises** | [**Array<ZacksEPSSurpriseSummary>**](ZacksEPSSurpriseSummary.md) | | [optional]
7
+ **security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier | [optional]
8
+ **next_page** | **String** | The token required to request the next page of the data | [optional]
9
+
10
+
@@ -0,0 +1,10 @@
1
+ # Intrinio::ApiResponseSecurityZacksSalesSurprises
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **sales_surprises** | [**Array<ZacksSalesSurpriseSummary>**](ZacksSalesSurpriseSummary.md) | | [optional]
7
+ **security** | [**SecuritySummary**](SecuritySummary.md) | The Security resolved from the given identifier | [optional]
8
+ **next_page** | **String** | The token required to request the next page of the data | [optional]
9
+
10
+
@@ -0,0 +1,9 @@
1
+ # Intrinio::ApiResponseZacksAnalystRatings
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **analyst_ratings** | [**Array<ZacksAnalystRating>**](ZacksAnalystRating.md) | | [optional]
7
+ **next_page** | **String** | The token required to request the next page of the data | [optional]
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # Intrinio::ApiResponseZacksEPSSurprises
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **eps_surprises** | [**Array<ZacksEPSSurprise>**](ZacksEPSSurprise.md) | Zacks EPS Surprise data for a Security in descending order by actual reported date | [optional]
7
+ **next_page** | **String** | The token required to request the next page of the data | [optional]
8
+
9
+
@@ -0,0 +1,9 @@
1
+ # Intrinio::ApiResponseZacksSalesSurprises
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **sales_surprises** | [**Array<ZacksSalesSurprise>**](ZacksSalesSurprise.md) | Zacks Sales Surprise data for a Security in descending order by actual reported date | [optional]
7
+ **next_page** | **String** | The token required to request the next page of the data | [optional]
8
+
9
+
@@ -35,5 +35,9 @@ Name | Type | Description | Notes
35
35
  **industry_group** | **String** | The company's operating industry group | [optional]
36
36
  **template** | **String** | The financial statement template used by Intrinio to standardize the as reported data | [optional]
37
37
  **standardized_active** | **BOOLEAN** | If true, the company has standardized and as reported fundamental data via the Intrinio API; if false, the company has as-reported data only | [optional]
38
+ **first_fundamental_date** | **Date** | The period end date of the company's first reported fundamental | [optional]
39
+ **last_fundamental_date** | **Date** | The period end date of the company's last reported fundamental | [optional]
40
+ **first_stock_price_date** | **Date** | The date of the company's first stock price, based on the company's primary security, which is typically traded on US exchages | [optional]
41
+ **last_stock_price_date** | **Date** | The date of the company's last stock price, based on the company's primary security, which is typically traded on US exchages | [optional]
38
42
 
39
43
 
@@ -18,7 +18,17 @@ Method | HTTP request | Description
18
18
  [**search_companies**](CompanyApi.md#search_companies) | **GET** /companies/search | Search Companies
19
19
 
20
20
 
21
+
22
+ [//]: # (START_OPERTATION)
23
+
24
+ [//]: # (ENDPOINT:/companies)
25
+
26
+ [//]: # (DOC_LINK:CompanyApi.md#get_all_companies)
27
+
21
28
  # **get_all_companies**
29
+
30
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_all_companies_v2)
31
+
22
32
  > ApiResponseCompanies get_all_companies(opts)
23
33
 
24
34
  All Companies
@@ -26,6 +36,9 @@ All Companies
26
36
  Returns all Companies. When parameters are specified, returns matching companies.
27
37
 
28
38
  ### Example
39
+
40
+ [//]: # (START_CODE_EXAMPLE)
41
+
29
42
  ```ruby
30
43
  # Load the gem
31
44
  require 'intrinio-sdk'
@@ -39,12 +52,12 @@ company_api = Intrinio::CompanyApi.new
39
52
 
40
53
  opts = {
41
54
  latest_filing_date: nil, # Date | Last filing date
42
- sic: "3350", # String | Standard Industrial Classification code
43
- template: "industrial", # String | Template
44
- sector: "Basic Materials", # String | Industry sector
45
- industry_category: "Metals & Mining", # String | Industry category
46
- industry_group: "Aluminum", # String | Industry group
47
- page_size: 100, # Float | The number of results to return
55
+ sic: nil, # String | Standard Industrial Classification code
56
+ template: nil, # String | Template
57
+ sector: nil, # String | Industry sector
58
+ industry_category: nil, # String | Industry category
59
+ industry_group: nil, # String | Industry group
60
+ page_size: 100, # Integer | The number of results to return
48
61
  next_page: nil # String | Gets the next page of data from a previous API call
49
62
  }
50
63
 
@@ -56,6 +69,8 @@ rescue Intrinio::ApiError => e
56
69
  end
57
70
  ```
58
71
 
72
+ [//]: # (END_CODE_EXAMPLE)
73
+
59
74
  ### Parameters
60
75
 
61
76
  Name | Type | Description | Notes
@@ -66,14 +81,26 @@ Name | Type | Description | Notes
66
81
  **sector** | **String**| Industry sector | [optional]
67
82
  **industry_category** | **String**| Industry category | [optional]
68
83
  **industry_group** | **String**| Industry group | [optional]
69
- **page_size** | **Float**| The number of results to return | [optional] [default to 100]
84
+ **page_size** | **Integer**| The number of results to return | [optional] [default to 100]
70
85
  **next_page** | **String**| Gets the next page of data from a previous API call | [optional]
71
86
 
72
87
  ### Return type
73
88
 
74
89
  [**ApiResponseCompanies**](ApiResponseCompanies.md)
75
90
 
91
+ [//]: # (END_OPERATION)
92
+
93
+
94
+ [//]: # (START_OPERTATION)
95
+
96
+ [//]: # (ENDPOINT:/companies/news)
97
+
98
+ [//]: # (DOC_LINK:CompanyApi.md#get_all_company_news)
99
+
76
100
  # **get_all_company_news**
101
+
102
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_all_company_news_v2)
103
+
77
104
  > ApiResponseNews get_all_company_news(opts)
78
105
 
79
106
  All News
@@ -81,6 +108,9 @@ All News
81
108
  Returns all News for all Companies
82
109
 
83
110
  ### Example
111
+
112
+ [//]: # (START_CODE_EXAMPLE)
113
+
84
114
  ```ruby
85
115
  # Load the gem
86
116
  require 'intrinio-sdk'
@@ -93,7 +123,7 @@ end
93
123
  company_api = Intrinio::CompanyApi.new
94
124
 
95
125
  opts = {
96
- page_size: 100, # Float | The number of results to return
126
+ page_size: 100, # Integer | The number of results to return
97
127
  next_page: nil # String | Gets the next page of data from a previous API call
98
128
  }
99
129
 
@@ -105,18 +135,32 @@ rescue Intrinio::ApiError => e
105
135
  end
106
136
  ```
107
137
 
138
+ [//]: # (END_CODE_EXAMPLE)
139
+
108
140
  ### Parameters
109
141
 
110
142
  Name | Type | Description | Notes
111
143
  ------------- | ------------- | ------------- | -------------
112
- **page_size** | **Float**| The number of results to return | [optional] [default to 100]
144
+ **page_size** | **Integer**| The number of results to return | [optional] [default to 100]
113
145
  **next_page** | **String**| Gets the next page of data from a previous API call | [optional]
114
146
 
115
147
  ### Return type
116
148
 
117
149
  [**ApiResponseNews**](ApiResponseNews.md)
118
150
 
151
+ [//]: # (END_OPERATION)
152
+
153
+
154
+ [//]: # (START_OPERTATION)
155
+
156
+ [//]: # (ENDPOINT:/companies/{identifier})
157
+
158
+ [//]: # (DOC_LINK:CompanyApi.md#get_company)
159
+
119
160
  # **get_company**
161
+
162
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_company_v2)
163
+
120
164
  > Company get_company(identifier)
121
165
 
122
166
  Lookup Company
@@ -124,6 +168,9 @@ Lookup Company
124
168
  Returns the Company with the given `identifier`
125
169
 
126
170
  ### Example
171
+
172
+ [//]: # (START_CODE_EXAMPLE)
173
+
127
174
  ```ruby
128
175
  # Load the gem
129
176
  require 'intrinio-sdk'
@@ -146,6 +193,8 @@ rescue Intrinio::ApiError => e
146
193
  end
147
194
  ```
148
195
 
196
+ [//]: # (END_CODE_EXAMPLE)
197
+
149
198
  ### Parameters
150
199
 
151
200
  Name | Type | Description | Notes
@@ -156,14 +205,29 @@ Name | Type | Description | Notes
156
205
 
157
206
  [**Company**](Company.md)
158
207
 
208
+ [//]: # (END_OPERATION)
209
+
210
+
211
+ [//]: # (START_OPERTATION)
212
+
213
+ [//]: # (ENDPOINT:/companies/{identifier}/data_point/{tag}/number)
214
+
215
+ [//]: # (DOC_LINK:CompanyApi.md#get_company_data_point_number)
216
+
159
217
  # **get_company_data_point_number**
218
+
219
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_company_data_point_number_v2)
220
+
160
221
  > Float get_company_data_point_number(identifier, tag)
161
222
 
162
223
  Data Point (Number) for Company
163
224
 
164
- $$v2_company_data_point_number_description$$
225
+ Returns a numeric value for the given `tag` for the Company with the given `identifier`
165
226
 
166
227
  ### Example
228
+
229
+ [//]: # (START_CODE_EXAMPLE)
230
+
167
231
  ```ruby
168
232
  # Load the gem
169
233
  require 'intrinio-sdk'
@@ -175,9 +239,9 @@ end
175
239
 
176
240
  company_api = Intrinio::CompanyApi.new
177
241
 
178
- identifier = "$$v2_company_data_point_identifier_default$$" # String | $$v2_company_data_point_identifier_description$$
242
+ identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
179
243
 
180
- tag = "$$v2_company_data_point_item_number_default$$" # String | $$v2_company_data_point_item_description$$
244
+ tag = "marketcap" # String | An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>)
181
245
 
182
246
 
183
247
  begin
@@ -188,25 +252,42 @@ rescue Intrinio::ApiError => e
188
252
  end
189
253
  ```
190
254
 
255
+ [//]: # (END_CODE_EXAMPLE)
256
+
191
257
  ### Parameters
192
258
 
193
259
  Name | Type | Description | Notes
194
260
  ------------- | ------------- | ------------- | -------------
195
- **identifier** | **String**| $$v2_company_data_point_identifier_description$$ |
196
- **tag** | **String**| $$v2_company_data_point_item_description$$ |
261
+ **identifier** | **String**| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |
262
+ **tag** | **String**| An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;) |
197
263
 
198
264
  ### Return type
199
265
 
200
266
  **Float**
201
267
 
268
+ [//]: # (END_OPERATION)
269
+
270
+
271
+ [//]: # (START_OPERTATION)
272
+
273
+ [//]: # (ENDPOINT:/companies/{identifier}/data_point/{tag}/text)
274
+
275
+ [//]: # (DOC_LINK:CompanyApi.md#get_company_data_point_text)
276
+
202
277
  # **get_company_data_point_text**
278
+
279
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_company_data_point_text_v2)
280
+
203
281
  > String get_company_data_point_text(identifier, tag)
204
282
 
205
283
  Data Point (Text) for Company
206
284
 
207
- $$v2_company_data_point_text_description$$
285
+ Returns a text value for the given `tag` for the Company with the given `identifier`
208
286
 
209
287
  ### Example
288
+
289
+ [//]: # (START_CODE_EXAMPLE)
290
+
210
291
  ```ruby
211
292
  # Load the gem
212
293
  require 'intrinio-sdk'
@@ -218,9 +299,9 @@ end
218
299
 
219
300
  company_api = Intrinio::CompanyApi.new
220
301
 
221
- identifier = "$$v2_company_data_point_identifier_default$$" # String | $$v2_company_data_point_identifier_description$$
302
+ identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
222
303
 
223
- tag = "$$v2_company_data_point_item_text_default$$" # String | $$v2_company_data_point_item_description$$
304
+ tag = "ceo" # String | An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>)
224
305
 
225
306
 
226
307
  begin
@@ -231,18 +312,32 @@ rescue Intrinio::ApiError => e
231
312
  end
232
313
  ```
233
314
 
315
+ [//]: # (END_CODE_EXAMPLE)
316
+
234
317
  ### Parameters
235
318
 
236
319
  Name | Type | Description | Notes
237
320
  ------------- | ------------- | ------------- | -------------
238
- **identifier** | **String**| $$v2_company_data_point_identifier_description$$ |
239
- **tag** | **String**| $$v2_company_data_point_item_description$$ |
321
+ **identifier** | **String**| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |
322
+ **tag** | **String**| An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;) |
240
323
 
241
324
  ### Return type
242
325
 
243
326
  **String**
244
327
 
328
+ [//]: # (END_OPERATION)
329
+
330
+
331
+ [//]: # (START_OPERTATION)
332
+
333
+ [//]: # (ENDPOINT:/companies/{identifier}/filings)
334
+
335
+ [//]: # (DOC_LINK:CompanyApi.md#get_company_filings)
336
+
245
337
  # **get_company_filings**
338
+
339
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_company_filings_v2)
340
+
246
341
  > ApiResponseCompanyFilings get_company_filings(identifier, opts)
247
342
 
248
343
  All Filings by Company
@@ -250,6 +345,9 @@ All Filings by Company
250
345
  Returns a complete list of SEC filings for the Company with the given `identifier`
251
346
 
252
347
  ### Example
348
+
349
+ [//]: # (START_CODE_EXAMPLE)
350
+
253
351
  ```ruby
254
352
  # Load the gem
255
353
  require 'intrinio-sdk'
@@ -264,7 +362,7 @@ company_api = Intrinio::CompanyApi.new
264
362
  identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
265
363
 
266
364
  opts = {
267
- page_size: 100, # Float | The number of results to return
365
+ page_size: 100, # Integer | The number of results to return
268
366
  next_page: nil # String | Gets the next page of data from a previous API call
269
367
  }
270
368
 
@@ -276,19 +374,33 @@ rescue Intrinio::ApiError => e
276
374
  end
277
375
  ```
278
376
 
377
+ [//]: # (END_CODE_EXAMPLE)
378
+
279
379
  ### Parameters
280
380
 
281
381
  Name | Type | Description | Notes
282
382
  ------------- | ------------- | ------------- | -------------
283
383
  **identifier** | **String**| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |
284
- **page_size** | **Float**| The number of results to return | [optional] [default to 100]
384
+ **page_size** | **Integer**| The number of results to return | [optional] [default to 100]
285
385
  **next_page** | **String**| Gets the next page of data from a previous API call | [optional]
286
386
 
287
387
  ### Return type
288
388
 
289
389
  [**ApiResponseCompanyFilings**](ApiResponseCompanyFilings.md)
290
390
 
391
+ [//]: # (END_OPERATION)
392
+
393
+
394
+ [//]: # (START_OPERTATION)
395
+
396
+ [//]: # (ENDPOINT:/companies/{identifier}/fundamentals)
397
+
398
+ [//]: # (DOC_LINK:CompanyApi.md#get_company_fundamentals)
399
+
291
400
  # **get_company_fundamentals**
401
+
402
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_company_fundamentals_v2)
403
+
292
404
  > ApiResponseCompanyFundamentals get_company_fundamentals(identifier, opts)
293
405
 
294
406
  All Fundamentals by Company
@@ -296,6 +408,9 @@ All Fundamentals by Company
296
408
  Returns all Fundamentals for the Company with the given `identifier`. Returns Fundamentals matching parameters when supplied.
297
409
 
298
410
  ### Example
411
+
412
+ [//]: # (START_CODE_EXAMPLE)
413
+
299
414
  ```ruby
300
415
  # Load the gem
301
416
  require 'intrinio-sdk'
@@ -313,12 +428,12 @@ opts = {
313
428
  filed_after: nil, # Date | Filed on or after this date
314
429
  filed_before: nil, # Date | Filed on or before this date
315
430
  reported_only: false, # BOOLEAN | Only as-reported fundamentals
316
- fiscal_year: 2017, # Integer | Only for the given fiscal year
431
+ fiscal_year: nil, # Integer | Only for the given fiscal year
317
432
  statement_code: nil, # String | Only of the given statement code
318
433
  type: nil, # String | Only of the given type
319
434
  start_date: nil, # Date | Only on or after the given date
320
435
  end_date: nil, # Date | Only on or before the given date
321
- page_size: 100, # Float | The number of results to return
436
+ page_size: 100, # Integer | The number of results to return
322
437
  next_page: nil # String | Gets the next page of data from a previous API call
323
438
  }
324
439
 
@@ -330,6 +445,8 @@ rescue Intrinio::ApiError => e
330
445
  end
331
446
  ```
332
447
 
448
+ [//]: # (END_CODE_EXAMPLE)
449
+
333
450
  ### Parameters
334
451
 
335
452
  Name | Type | Description | Notes
@@ -343,21 +460,36 @@ Name | Type | Description | Notes
343
460
  **type** | **String**| Only of the given type | [optional]
344
461
  **start_date** | **Date**| Only on or after the given date | [optional]
345
462
  **end_date** | **Date**| Only on or before the given date | [optional]
346
- **page_size** | **Float**| The number of results to return | [optional] [default to 100]
463
+ **page_size** | **Integer**| The number of results to return | [optional] [default to 100]
347
464
  **next_page** | **String**| Gets the next page of data from a previous API call | [optional]
348
465
 
349
466
  ### Return type
350
467
 
351
468
  [**ApiResponseCompanyFundamentals**](ApiResponseCompanyFundamentals.md)
352
469
 
470
+ [//]: # (END_OPERATION)
471
+
472
+
473
+ [//]: # (START_OPERTATION)
474
+
475
+ [//]: # (ENDPOINT:/companies/{identifier}/historical_data/{tag})
476
+
477
+ [//]: # (DOC_LINK:CompanyApi.md#get_company_historical_data)
478
+
353
479
  # **get_company_historical_data**
480
+
481
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_company_historical_data_v2)
482
+
354
483
  > ApiResponseCompanyHistoricalData get_company_historical_data(identifier, tag, opts)
355
484
 
356
485
  Historical Data for Company
357
486
 
358
- $$v2_company_historical_data_description$$
487
+ Returns historical values for the given `tag` and the Company with the given `identifier`
359
488
 
360
489
  ### Example
490
+
491
+ [//]: # (START_CODE_EXAMPLE)
492
+
361
493
  ```ruby
362
494
  # Load the gem
363
495
  require 'intrinio-sdk'
@@ -369,17 +501,17 @@ end
369
501
 
370
502
  company_api = Intrinio::CompanyApi.new
371
503
 
372
- identifier = "$$v2_company_historical_data_identifier_default$$" # String | $$v2_company_historical_data_identifier_description$$
504
+ identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
373
505
 
374
- tag = "$$v2_company_historical_data_item_default$$" # String | $$v2_company_historical_data_item_description$$
506
+ tag = "marketcap" # String | An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>)
375
507
 
376
508
  opts = {
377
509
  frequency: "daily", # String | Return historical data in the given frequency
378
510
  type: nil, # String | Filter by type, when applicable
379
511
  start_date: Date.parse("2018-01-01"), # Date | Get historical data on or after this date
380
- end_date: Date.parse("2019-01-01"), # Date | Get historical data on or before this date
512
+ end_date: nil, # Date | Get historical data on or before this date
381
513
  sort_order: "desc", # String | Sort by date `asc` or `desc`
382
- page_size: 100, # Float | The number of results to return
514
+ page_size: 100, # Integer | The number of results to return
383
515
  next_page: nil # String | Gets the next page of data from a previous API call
384
516
  }
385
517
 
@@ -391,25 +523,39 @@ rescue Intrinio::ApiError => e
391
523
  end
392
524
  ```
393
525
 
526
+ [//]: # (END_CODE_EXAMPLE)
527
+
394
528
  ### Parameters
395
529
 
396
530
  Name | Type | Description | Notes
397
531
  ------------- | ------------- | ------------- | -------------
398
- **identifier** | **String**| $$v2_company_historical_data_identifier_description$$ |
399
- **tag** | **String**| $$v2_company_historical_data_item_description$$ |
532
+ **identifier** | **String**| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |
533
+ **tag** | **String**| An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;) |
400
534
  **frequency** | **String**| Return historical data in the given frequency | [optional] [default to daily]
401
535
  **type** | **String**| Filter by type, when applicable | [optional]
402
536
  **start_date** | **Date**| Get historical data on or after this date | [optional]
403
537
  **end_date** | **Date**| Get historical data on or before this date | [optional]
404
538
  **sort_order** | **String**| Sort by date &#x60;asc&#x60; or &#x60;desc&#x60; | [optional] [default to desc]
405
- **page_size** | **Float**| The number of results to return | [optional] [default to 100]
539
+ **page_size** | **Integer**| The number of results to return | [optional] [default to 100]
406
540
  **next_page** | **String**| Gets the next page of data from a previous API call | [optional]
407
541
 
408
542
  ### Return type
409
543
 
410
544
  [**ApiResponseCompanyHistoricalData**](ApiResponseCompanyHistoricalData.md)
411
545
 
546
+ [//]: # (END_OPERATION)
547
+
548
+
549
+ [//]: # (START_OPERTATION)
550
+
551
+ [//]: # (ENDPOINT:/companies/{identifier}/news)
552
+
553
+ [//]: # (DOC_LINK:CompanyApi.md#get_company_news)
554
+
412
555
  # **get_company_news**
556
+
557
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_company_news_v2)
558
+
413
559
  > ApiResponseCompanyNews get_company_news(identifier, opts)
414
560
 
415
561
  All News by Company
@@ -417,6 +563,9 @@ All News by Company
417
563
  Returns news for the Company with the given `identifier`
418
564
 
419
565
  ### Example
566
+
567
+ [//]: # (START_CODE_EXAMPLE)
568
+
420
569
  ```ruby
421
570
  # Load the gem
422
571
  require 'intrinio-sdk'
@@ -431,7 +580,7 @@ company_api = Intrinio::CompanyApi.new
431
580
  identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
432
581
 
433
582
  opts = {
434
- page_size: 100, # Float | The number of results to return
583
+ page_size: 100, # Integer | The number of results to return
435
584
  next_page: nil # String | Gets the next page of data from a previous API call
436
585
  }
437
586
 
@@ -443,19 +592,33 @@ rescue Intrinio::ApiError => e
443
592
  end
444
593
  ```
445
594
 
595
+ [//]: # (END_CODE_EXAMPLE)
596
+
446
597
  ### Parameters
447
598
 
448
599
  Name | Type | Description | Notes
449
600
  ------------- | ------------- | ------------- | -------------
450
601
  **identifier** | **String**| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |
451
- **page_size** | **Float**| The number of results to return | [optional] [default to 100]
602
+ **page_size** | **Integer**| The number of results to return | [optional] [default to 100]
452
603
  **next_page** | **String**| Gets the next page of data from a previous API call | [optional]
453
604
 
454
605
  ### Return type
455
606
 
456
607
  [**ApiResponseCompanyNews**](ApiResponseCompanyNews.md)
457
608
 
609
+ [//]: # (END_OPERATION)
610
+
611
+
612
+ [//]: # (START_OPERTATION)
613
+
614
+ [//]: # (ENDPOINT:/companies/{identifier}/securities)
615
+
616
+ [//]: # (DOC_LINK:CompanyApi.md#get_company_securities)
617
+
458
618
  # **get_company_securities**
619
+
620
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_company_securities_v2)
621
+
459
622
  > ApiResponseCompanySecurities get_company_securities(identifier, opts)
460
623
 
461
624
  All Securities by Company
@@ -463,6 +626,9 @@ All Securities by Company
463
626
  Returns Securities for the Company with the given `identifier`
464
627
 
465
628
  ### Example
629
+
630
+ [//]: # (START_CODE_EXAMPLE)
631
+
466
632
  ```ruby
467
633
  # Load the gem
468
634
  require 'intrinio-sdk'
@@ -488,6 +654,8 @@ rescue Intrinio::ApiError => e
488
654
  end
489
655
  ```
490
656
 
657
+ [//]: # (END_CODE_EXAMPLE)
658
+
491
659
  ### Parameters
492
660
 
493
661
  Name | Type | Description | Notes
@@ -499,7 +667,19 @@ Name | Type | Description | Notes
499
667
 
500
668
  [**ApiResponseCompanySecurities**](ApiResponseCompanySecurities.md)
501
669
 
670
+ [//]: # (END_OPERATION)
671
+
672
+
673
+ [//]: # (START_OPERTATION)
674
+
675
+ [//]: # (ENDPOINT:/companies/{identifier}/fundamentals/lookup/{statement_code}/{fiscal_year}/{fiscal_period})
676
+
677
+ [//]: # (DOC_LINK:CompanyApi.md#lookup_company_fundamental)
678
+
502
679
  # **lookup_company_fundamental**
680
+
681
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/lookup_company_fundamental_v2)
682
+
503
683
  > Fundamental lookup_company_fundamental(identifier, statement_code, fiscal_period, fiscal_year)
504
684
 
505
685
  Lookup Fundamental by Company
@@ -507,6 +687,9 @@ Lookup Fundamental by Company
507
687
  Returns the Fundamental for the Company with the given `identifier` and with the given parameters
508
688
 
509
689
  ### Example
690
+
691
+ [//]: # (START_CODE_EXAMPLE)
692
+
510
693
  ```ruby
511
694
  # Load the gem
512
695
  require 'intrinio-sdk'
@@ -535,6 +718,8 @@ rescue Intrinio::ApiError => e
535
718
  end
536
719
  ```
537
720
 
721
+ [//]: # (END_CODE_EXAMPLE)
722
+
538
723
  ### Parameters
539
724
 
540
725
  Name | Type | Description | Notes
@@ -548,7 +733,19 @@ Name | Type | Description | Notes
548
733
 
549
734
  [**Fundamental**](Fundamental.md)
550
735
 
736
+ [//]: # (END_OPERATION)
737
+
738
+
739
+ [//]: # (START_OPERTATION)
740
+
741
+ [//]: # (ENDPOINT:/companies/search)
742
+
743
+ [//]: # (DOC_LINK:CompanyApi.md#search_companies)
744
+
551
745
  # **search_companies**
746
+
747
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/search_companies_v2)
748
+
552
749
  > ApiResponseCompaniesSearch search_companies(query, opts)
553
750
 
554
751
  Search Companies
@@ -556,6 +753,9 @@ Search Companies
556
753
  Searches for Companies matching the text `query`
557
754
 
558
755
  ### Example
756
+
757
+ [//]: # (START_CODE_EXAMPLE)
758
+
559
759
  ```ruby
560
760
  # Load the gem
561
761
  require 'intrinio-sdk'
@@ -570,7 +770,7 @@ company_api = Intrinio::CompanyApi.new
570
770
  query = "Apple" # String | Search parameters
571
771
 
572
772
  opts = {
573
- page_size: 100 # Float | The number of results to return
773
+ page_size: 100 # Integer | The number of results to return
574
774
  }
575
775
 
576
776
  begin
@@ -581,14 +781,18 @@ rescue Intrinio::ApiError => e
581
781
  end
582
782
  ```
583
783
 
784
+ [//]: # (END_CODE_EXAMPLE)
785
+
584
786
  ### Parameters
585
787
 
586
788
  Name | Type | Description | Notes
587
789
  ------------- | ------------- | ------------- | -------------
588
790
  **query** | **String**| Search parameters |
589
- **page_size** | **Float**| The number of results to return | [optional] [default to 100]
791
+ **page_size** | **Integer**| The number of results to return | [optional] [default to 100]
590
792
 
591
793
  ### Return type
592
794
 
593
795
  [**ApiResponseCompaniesSearch**](ApiResponseCompaniesSearch.md)
594
796
 
797
+ [//]: # (END_OPERATION)
798
+