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
@@ -9,7 +9,17 @@ Method | HTTP request | Description
9
9
  [**get_forex_prices**](ForexApi.md#get_forex_prices) | **GET** /forex/prices/{pair}/{timeframe} | Forex Currency Prices
10
10
 
11
11
 
12
+
13
+ [//]: # (START_OPERTATION)
14
+
15
+ [//]: # (ENDPOINT:/forex/currencies)
16
+
17
+ [//]: # (DOC_LINK:ForexApi.md#get_forex_currencies)
18
+
12
19
  # **get_forex_currencies**
20
+
21
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_forex_currencies_v2)
22
+
13
23
  > ApiResponseForexCurrencies get_forex_currencies
14
24
 
15
25
  Forex Currencies
@@ -17,6 +27,9 @@ Forex Currencies
17
27
  Returns a list of forex currencies for which prices are available.
18
28
 
19
29
  ### Example
30
+
31
+ [//]: # (START_CODE_EXAMPLE)
32
+
20
33
  ```ruby
21
34
  # Load the gem
22
35
  require 'intrinio-sdk'
@@ -36,6 +49,8 @@ rescue Intrinio::ApiError => e
36
49
  end
37
50
  ```
38
51
 
52
+ [//]: # (END_CODE_EXAMPLE)
53
+
39
54
  ### Parameters
40
55
  This endpoint does not need any parameter.
41
56
 
@@ -43,7 +58,19 @@ This endpoint does not need any parameter.
43
58
 
44
59
  [**ApiResponseForexCurrencies**](ApiResponseForexCurrencies.md)
45
60
 
61
+ [//]: # (END_OPERATION)
62
+
63
+
64
+ [//]: # (START_OPERTATION)
65
+
66
+ [//]: # (ENDPOINT:/forex/pairs)
67
+
68
+ [//]: # (DOC_LINK:ForexApi.md#get_forex_pairs)
69
+
46
70
  # **get_forex_pairs**
71
+
72
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_forex_pairs_v2)
73
+
47
74
  > ApiResponseForexPairs get_forex_pairs
48
75
 
49
76
  Forex Currency Pairs
@@ -51,6 +78,9 @@ Forex Currency Pairs
51
78
  Returns a list of currency pairs used to request foreign exchange (forex) market price data. The currency that is used as the reference is called quote currency and the currency that is quoted in relation is called the base currency. For example, in the pair code “EURGBP” with a price of 0.88, one Euro (base currency) can be exchanged for 0.88 British Pounds (quote currency).
52
79
 
53
80
  ### Example
81
+
82
+ [//]: # (START_CODE_EXAMPLE)
83
+
54
84
  ```ruby
55
85
  # Load the gem
56
86
  require 'intrinio-sdk'
@@ -70,6 +100,8 @@ rescue Intrinio::ApiError => e
70
100
  end
71
101
  ```
72
102
 
103
+ [//]: # (END_CODE_EXAMPLE)
104
+
73
105
  ### Parameters
74
106
  This endpoint does not need any parameter.
75
107
 
@@ -77,7 +109,19 @@ This endpoint does not need any parameter.
77
109
 
78
110
  [**ApiResponseForexPairs**](ApiResponseForexPairs.md)
79
111
 
112
+ [//]: # (END_OPERATION)
113
+
114
+
115
+ [//]: # (START_OPERTATION)
116
+
117
+ [//]: # (ENDPOINT:/forex/prices/{pair}/{timeframe})
118
+
119
+ [//]: # (DOC_LINK:ForexApi.md#get_forex_prices)
120
+
80
121
  # **get_forex_prices**
122
+
123
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_forex_prices_v2)
124
+
81
125
  > ApiResponseForexPrices get_forex_prices(pair, timeframe, opts)
82
126
 
83
127
  Forex Currency Prices
@@ -85,6 +129,9 @@ Forex Currency Prices
85
129
  Provides a list of forex price quotes for a given forex currency pair and timeframe.
86
130
 
87
131
  ### Example
132
+
133
+ [//]: # (START_CODE_EXAMPLE)
134
+
88
135
  ```ruby
89
136
  # Load the gem
90
137
  require 'intrinio-sdk'
@@ -102,10 +149,10 @@ timeframe = "D1" # String | The time interval for the quotes
102
149
 
103
150
  opts = {
104
151
  timezone: "UTC", # String | Returns trading times in this timezone
105
- start_date: "2018-01-01", # String | Return Forex Prices on or after this date
106
- start_time: "14:20:00", # String | Return Forex Prices at or after this time (24-hour)
107
- end_date: "2019-01-01", # String | Return Forex Prices on or before this date
108
- end_time: "21:01:21", # String | Return Forex Prices at or before this time (24-hour)
152
+ start_date: nil, # Date | Return Forex Prices on or after this date
153
+ start_time: nil, # String | Return Forex Prices at or after this time (24-hour)
154
+ end_date: nil, # Date | Return Forex Prices on or before this date
155
+ end_time: nil, # String | Return Forex Prices at or before this time (24-hour)
109
156
  page_size: 100, # Integer | The number of results to return
110
157
  next_page: nil # String | Gets the next page of data from a previous API call
111
158
  }
@@ -118,6 +165,8 @@ rescue Intrinio::ApiError => e
118
165
  end
119
166
  ```
120
167
 
168
+ [//]: # (END_CODE_EXAMPLE)
169
+
121
170
  ### Parameters
122
171
 
123
172
  Name | Type | Description | Notes
@@ -125,9 +174,9 @@ Name | Type | Description | Notes
125
174
  **pair** | **String**| The Forex Currency Pair code |
126
175
  **timeframe** | **String**| The time interval for the quotes |
127
176
  **timezone** | **String**| Returns trading times in this timezone | [optional] [default to UTC]
128
- **start_date** | **String**| Return Forex Prices on or after this date | [optional]
177
+ **start_date** | **Date**| Return Forex Prices on or after this date | [optional]
129
178
  **start_time** | **String**| Return Forex Prices at or after this time (24-hour) | [optional]
130
- **end_date** | **String**| Return Forex Prices on or before this date | [optional]
179
+ **end_date** | **Date**| Return Forex Prices on or before this date | [optional]
131
180
  **end_time** | **String**| Return Forex Prices at or before this time (24-hour) | [optional]
132
181
  **page_size** | **Integer**| The number of results to return | [optional] [default to 100]
133
182
  **next_page** | **String**| Gets the next page of data from a previous API call | [optional]
@@ -136,3 +185,5 @@ Name | Type | Description | Notes
136
185
 
137
186
  [**ApiResponseForexPrices**](ApiResponseForexPrices.md)
138
187
 
188
+ [//]: # (END_OPERATION)
189
+
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
10
10
  **type** | **String** | The type of Fundamental | [optional]
11
11
  **start_date** | **Date** | The period start date | [optional]
12
12
  **end_date** | **Date** | The period start date | [optional]
13
- **filing_date** | **Date** | The date and time when the Fundamental was filed with the SEC | [optional]
13
+ **filing_date** | **DateTime** | The date and time when the Fundamental was filed with the SEC | [optional]
14
14
  **company** | [**CompanySummary**](CompanySummary.md) | The Company that the Fundamental was belongs to | [optional]
15
15
 
16
16
 
@@ -10,7 +10,17 @@ Method | HTTP request | Description
10
10
  [**lookup_fundamental**](FundamentalsApi.md#lookup_fundamental) | **GET** /fundamentals/lookup/{identifier}/{statement_code}/{fiscal_year}/{fiscal_period} | Lookup Fundamental
11
11
 
12
12
 
13
+
14
+ [//]: # (START_OPERTATION)
15
+
16
+ [//]: # (ENDPOINT:/fundamentals/{id})
17
+
18
+ [//]: # (DOC_LINK:FundamentalsApi.md#get_fundamental_by_id)
19
+
13
20
  # **get_fundamental_by_id**
21
+
22
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_fundamental_by_id_v2)
23
+
14
24
  > Fundamental get_fundamental_by_id(id)
15
25
 
16
26
  Fundamental by ID
@@ -18,6 +28,9 @@ Fundamental by ID
18
28
  Returns detailed fundamental data for the given `id`.
19
29
 
20
30
  ### Example
31
+
32
+ [//]: # (START_CODE_EXAMPLE)
33
+
21
34
  ```ruby
22
35
  # Load the gem
23
36
  require 'intrinio-sdk'
@@ -40,6 +53,8 @@ rescue Intrinio::ApiError => e
40
53
  end
41
54
  ```
42
55
 
56
+ [//]: # (END_CODE_EXAMPLE)
57
+
43
58
  ### Parameters
44
59
 
45
60
  Name | Type | Description | Notes
@@ -50,7 +65,19 @@ Name | Type | Description | Notes
50
65
 
51
66
  [**Fundamental**](Fundamental.md)
52
67
 
68
+ [//]: # (END_OPERATION)
69
+
70
+
71
+ [//]: # (START_OPERTATION)
72
+
73
+ [//]: # (ENDPOINT:/fundamentals/{id}/reported_financials)
74
+
75
+ [//]: # (DOC_LINK:FundamentalsApi.md#get_fundamental_reported_financials)
76
+
53
77
  # **get_fundamental_reported_financials**
78
+
79
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_fundamental_reported_financials_v2)
80
+
54
81
  > ApiResponseReportedFinancials get_fundamental_reported_financials(id)
55
82
 
56
83
  Reported Financials
@@ -58,6 +85,9 @@ Reported Financials
58
85
  Returns the As-Reported Financials directly from the financial statements of the XBRL filings from the company
59
86
 
60
87
  ### Example
88
+
89
+ [//]: # (START_CODE_EXAMPLE)
90
+
61
91
  ```ruby
62
92
  # Load the gem
63
93
  require 'intrinio-sdk'
@@ -80,6 +110,8 @@ rescue Intrinio::ApiError => e
80
110
  end
81
111
  ```
82
112
 
113
+ [//]: # (END_CODE_EXAMPLE)
114
+
83
115
  ### Parameters
84
116
 
85
117
  Name | Type | Description | Notes
@@ -90,7 +122,19 @@ Name | Type | Description | Notes
90
122
 
91
123
  [**ApiResponseReportedFinancials**](ApiResponseReportedFinancials.md)
92
124
 
125
+ [//]: # (END_OPERATION)
126
+
127
+
128
+ [//]: # (START_OPERTATION)
129
+
130
+ [//]: # (ENDPOINT:/fundamentals/{id}/standardized_financials)
131
+
132
+ [//]: # (DOC_LINK:FundamentalsApi.md#get_fundamental_standardized_financials)
133
+
93
134
  # **get_fundamental_standardized_financials**
135
+
136
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_fundamental_standardized_financials_v2)
137
+
94
138
  > ApiResponseStandardizedFinancials get_fundamental_standardized_financials(id)
95
139
 
96
140
  Standardized Financials
@@ -98,6 +142,9 @@ Standardized Financials
98
142
  Returns professional-grade historical financial data. This data is standardized, cleansed and verified to ensure the highest quality data sourced directly from the XBRL financial statements. The primary purpose of standardized financials are to facilitate comparability across a single company’s fundamentals and across all companies fundamentals. For example, it is possible to compare total revenues between two companies as of a certain point in time, or within a single company across multiple time periods. This is not possible using the as reported financial statements because of the inherent complexity of reporting standards.
99
143
 
100
144
  ### Example
145
+
146
+ [//]: # (START_CODE_EXAMPLE)
147
+
101
148
  ```ruby
102
149
  # Load the gem
103
150
  require 'intrinio-sdk'
@@ -120,6 +167,8 @@ rescue Intrinio::ApiError => e
120
167
  end
121
168
  ```
122
169
 
170
+ [//]: # (END_CODE_EXAMPLE)
171
+
123
172
  ### Parameters
124
173
 
125
174
  Name | Type | Description | Notes
@@ -130,7 +179,19 @@ Name | Type | Description | Notes
130
179
 
131
180
  [**ApiResponseStandardizedFinancials**](ApiResponseStandardizedFinancials.md)
132
181
 
182
+ [//]: # (END_OPERATION)
183
+
184
+
185
+ [//]: # (START_OPERTATION)
186
+
187
+ [//]: # (ENDPOINT:/fundamentals/lookup/{identifier}/{statement_code}/{fiscal_year}/{fiscal_period})
188
+
189
+ [//]: # (DOC_LINK:FundamentalsApi.md#lookup_fundamental)
190
+
133
191
  # **lookup_fundamental**
192
+
193
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/lookup_fundamental_v2)
194
+
134
195
  > Fundamental lookup_fundamental(identifier, statement_code, fiscal_year, fiscal_period)
135
196
 
136
197
  Lookup Fundamental
@@ -138,6 +199,9 @@ Lookup Fundamental
138
199
  Returns the Fundamental for the Company with the given `identifier` and with the given parameters
139
200
 
140
201
  ### Example
202
+
203
+ [//]: # (START_CODE_EXAMPLE)
204
+
141
205
  ```ruby
142
206
  # Load the gem
143
207
  require 'intrinio-sdk'
@@ -166,6 +230,8 @@ rescue Intrinio::ApiError => e
166
230
  end
167
231
  ```
168
232
 
233
+ [//]: # (END_CODE_EXAMPLE)
234
+
169
235
  ### Parameters
170
236
 
171
237
  Name | Type | Description | Notes
@@ -179,3 +245,5 @@ Name | Type | Description | Notes
179
245
 
180
246
  [**Fundamental**](Fundamental.md)
181
247
 
248
+ [//]: # (END_OPERATION)
249
+
@@ -7,14 +7,27 @@ Method | HTTP request | Description
7
7
  [**get_historical_data**](HistoricalDataApi.md#get_historical_data) | **GET** /historical_data/{identifier}/{tag} | Historical Data
8
8
 
9
9
 
10
+
11
+ [//]: # (START_OPERTATION)
12
+
13
+ [//]: # (ENDPOINT:/historical_data/{identifier}/{tag})
14
+
15
+ [//]: # (DOC_LINK:HistoricalDataApi.md#get_historical_data)
16
+
10
17
  # **get_historical_data**
18
+
19
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_historical_data_v2)
20
+
11
21
  > ApiResponseHistoricalData get_historical_data(identifier, tag, opts)
12
22
 
13
23
  Historical Data
14
24
 
15
- $$v2_historical_data_description$$
25
+ Returns historical values for the given `tag` and the entity represented by the given `identifier`
16
26
 
17
27
  ### Example
28
+
29
+ [//]: # (START_CODE_EXAMPLE)
30
+
18
31
  ```ruby
19
32
  # Load the gem
20
33
  require 'intrinio-sdk'
@@ -26,17 +39,17 @@ end
26
39
 
27
40
  historicalData_api = Intrinio::HistoricalDataApi.new
28
41
 
29
- identifier = "$$v2_historical_data_identifier_default$$" # String | $$v2_historical_data_identifier_description$$
42
+ identifier = "AAPL" # String | An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
30
43
 
31
- tag = "$$v2_historical_data_item_default$$" # String | $$v2_historical_data_item_description$$
44
+ tag = "marketcap" # String | An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>)
32
45
 
33
46
  opts = {
34
47
  frequency: "daily", # String | Return historical data in the given frequency
35
48
  type: nil, # String | Filter by type, when applicable
36
49
  start_date: Date.parse("2015-01-01"), # Date | Get historical data on or after this date
37
- end_date: Date.parse("2019-01-01"), # Date | Get historical date on or before this date
50
+ end_date: nil, # Date | Get historical date on or before this date
38
51
  sort_order: "desc", # String | Sort by date `asc` or `desc`
39
- page_size: 100, # Float | The number of results to return
52
+ page_size: 100, # Integer | The number of results to return
40
53
  next_page: nil # String | Gets the next page of data from a previous API call
41
54
  }
42
55
 
@@ -48,21 +61,25 @@ rescue Intrinio::ApiError => e
48
61
  end
49
62
  ```
50
63
 
64
+ [//]: # (END_CODE_EXAMPLE)
65
+
51
66
  ### Parameters
52
67
 
53
68
  Name | Type | Description | Notes
54
69
  ------------- | ------------- | ------------- | -------------
55
- **identifier** | **String**| $$v2_historical_data_identifier_description$$ |
56
- **tag** | **String**| $$v2_historical_data_item_description$$ |
70
+ **identifier** | **String**| An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID) |
71
+ **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;) |
57
72
  **frequency** | **String**| Return historical data in the given frequency | [optional] [default to daily]
58
73
  **type** | **String**| Filter by type, when applicable | [optional]
59
74
  **start_date** | **Date**| Get historical data on or after this date | [optional]
60
75
  **end_date** | **Date**| Get historical date on or before this date | [optional]
61
76
  **sort_order** | **String**| Sort by date &#x60;asc&#x60; or &#x60;desc&#x60; | [optional] [default to desc]
62
- **page_size** | **Float**| The number of results to return | [optional] [default to 100]
77
+ **page_size** | **Integer**| The number of results to return | [optional] [default to 100]
63
78
  **next_page** | **String**| Gets the next page of data from a previous API call | [optional]
64
79
 
65
80
  ### Return type
66
81
 
67
82
  [**ApiResponseHistoricalData**](ApiResponseHistoricalData.md)
68
83
 
84
+ [//]: # (END_OPERATION)
85
+
@@ -24,12 +24,25 @@ Method | HTTP request | Description
24
24
  [**search_stock_markets_indices**](IndexApi.md#search_stock_markets_indices) | **GET** /indices/stock_market/search | Search Stock Market Indices
25
25
 
26
26
 
27
+
28
+ [//]: # (START_OPERTATION)
29
+
30
+ [//]: # (ENDPOINT:/indices/economic)
31
+
32
+ [//]: # (DOC_LINK:IndexApi.md#get_all_economic_indices)
33
+
27
34
  # **get_all_economic_indices**
35
+
36
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_all_economic_indices_v2)
37
+
28
38
  > ApiResponseEconomicIndices get_all_economic_indices(opts)
29
39
 
30
40
  All Economic Indices
31
41
 
32
42
  ### Example
43
+
44
+ [//]: # (START_CODE_EXAMPLE)
45
+
33
46
  ```ruby
34
47
  # Load the gem
35
48
  require 'intrinio-sdk'
@@ -42,7 +55,7 @@ end
42
55
  index_api = Intrinio::IndexApi.new
43
56
 
44
57
  opts = {
45
- page_size: 100, # Float | The number of results to return
58
+ page_size: 100, # Integer | The number of results to return
46
59
  next_page: nil # String | Gets the next page of data from a previous API call
47
60
  }
48
61
 
@@ -54,23 +67,40 @@ rescue Intrinio::ApiError => e
54
67
  end
55
68
  ```
56
69
 
70
+ [//]: # (END_CODE_EXAMPLE)
71
+
57
72
  ### Parameters
58
73
 
59
74
  Name | Type | Description | Notes
60
75
  ------------- | ------------- | ------------- | -------------
61
- **page_size** | **Float**| The number of results to return | [optional] [default to 100]
76
+ **page_size** | **Integer**| The number of results to return | [optional] [default to 100]
62
77
  **next_page** | **String**| Gets the next page of data from a previous API call | [optional]
63
78
 
64
79
  ### Return type
65
80
 
66
81
  [**ApiResponseEconomicIndices**](ApiResponseEconomicIndices.md)
67
82
 
83
+ [//]: # (END_OPERATION)
84
+
85
+
86
+ [//]: # (START_OPERTATION)
87
+
88
+ [//]: # (ENDPOINT:/indices/sic)
89
+
90
+ [//]: # (DOC_LINK:IndexApi.md#get_all_sic_indices)
91
+
68
92
  # **get_all_sic_indices**
93
+
94
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_all_sic_indices_v2)
95
+
69
96
  > ApiResponseSICIndices get_all_sic_indices(opts)
70
97
 
71
98
  All SIC Indices
72
99
 
73
100
  ### Example
101
+
102
+ [//]: # (START_CODE_EXAMPLE)
103
+
74
104
  ```ruby
75
105
  # Load the gem
76
106
  require 'intrinio-sdk'
@@ -83,7 +113,7 @@ end
83
113
  index_api = Intrinio::IndexApi.new
84
114
 
85
115
  opts = {
86
- page_size: 100, # Float | The number of results to return
116
+ page_size: 100, # Integer | The number of results to return
87
117
  next_page: nil # String | Gets the next page of data from a previous API call
88
118
  }
89
119
 
@@ -95,23 +125,40 @@ rescue Intrinio::ApiError => e
95
125
  end
96
126
  ```
97
127
 
128
+ [//]: # (END_CODE_EXAMPLE)
129
+
98
130
  ### Parameters
99
131
 
100
132
  Name | Type | Description | Notes
101
133
  ------------- | ------------- | ------------- | -------------
102
- **page_size** | **Float**| The number of results to return | [optional] [default to 100]
134
+ **page_size** | **Integer**| The number of results to return | [optional] [default to 100]
103
135
  **next_page** | **String**| Gets the next page of data from a previous API call | [optional]
104
136
 
105
137
  ### Return type
106
138
 
107
139
  [**ApiResponseSICIndices**](ApiResponseSICIndices.md)
108
140
 
141
+ [//]: # (END_OPERATION)
142
+
143
+
144
+ [//]: # (START_OPERTATION)
145
+
146
+ [//]: # (ENDPOINT:/indices/stock_market)
147
+
148
+ [//]: # (DOC_LINK:IndexApi.md#get_all_stock_market_indices)
149
+
109
150
  # **get_all_stock_market_indices**
151
+
152
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_all_stock_market_indices_v2)
153
+
110
154
  > ApiResponseStockMarketIndices get_all_stock_market_indices(opts)
111
155
 
112
156
  All Stock Market Indices
113
157
 
114
158
  ### Example
159
+
160
+ [//]: # (START_CODE_EXAMPLE)
161
+
115
162
  ```ruby
116
163
  # Load the gem
117
164
  require 'intrinio-sdk'
@@ -124,7 +171,7 @@ end
124
171
  index_api = Intrinio::IndexApi.new
125
172
 
126
173
  opts = {
127
- page_size: 100, # Float | The number of results to return
174
+ page_size: 100, # Integer | The number of results to return
128
175
  next_page: nil # String | Gets the next page of data from a previous API call
129
176
  }
130
177
 
@@ -136,23 +183,40 @@ rescue Intrinio::ApiError => e
136
183
  end
137
184
  ```
138
185
 
186
+ [//]: # (END_CODE_EXAMPLE)
187
+
139
188
  ### Parameters
140
189
 
141
190
  Name | Type | Description | Notes
142
191
  ------------- | ------------- | ------------- | -------------
143
- **page_size** | **Float**| The number of results to return | [optional] [default to 100]
192
+ **page_size** | **Integer**| The number of results to return | [optional] [default to 100]
144
193
  **next_page** | **String**| Gets the next page of data from a previous API call | [optional]
145
194
 
146
195
  ### Return type
147
196
 
148
197
  [**ApiResponseStockMarketIndices**](ApiResponseStockMarketIndices.md)
149
198
 
199
+ [//]: # (END_OPERATION)
200
+
201
+
202
+ [//]: # (START_OPERTATION)
203
+
204
+ [//]: # (ENDPOINT:/indices/economic/{identifier})
205
+
206
+ [//]: # (DOC_LINK:IndexApi.md#get_economic_index_by_id)
207
+
150
208
  # **get_economic_index_by_id**
209
+
210
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_economic_index_by_id_v2)
211
+
151
212
  > EconomicIndex get_economic_index_by_id(identifier)
152
213
 
153
214
  Lookup Economic Index
154
215
 
155
216
  ### Example
217
+
218
+ [//]: # (START_CODE_EXAMPLE)
219
+
156
220
  ```ruby
157
221
  # Load the gem
158
222
  require 'intrinio-sdk'
@@ -175,6 +239,8 @@ rescue Intrinio::ApiError => e
175
239
  end
176
240
  ```
177
241
 
242
+ [//]: # (END_CODE_EXAMPLE)
243
+
178
244
  ### Parameters
179
245
 
180
246
  Name | Type | Description | Notes
@@ -185,7 +251,19 @@ Name | Type | Description | Notes
185
251
 
186
252
  [**EconomicIndex**](EconomicIndex.md)
187
253
 
254
+ [//]: # (END_OPERATION)
255
+
256
+
257
+ [//]: # (START_OPERTATION)
258
+
259
+ [//]: # (ENDPOINT:/indices/economic/{identifier}/data_point/{tag}/number)
260
+
261
+ [//]: # (DOC_LINK:IndexApi.md#get_economic_index_data_point_number)
262
+
188
263
  # **get_economic_index_data_point_number**
264
+
265
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_economic_index_data_point_number_v2)
266
+
189
267
  > Float get_economic_index_data_point_number(identifier, tag)
190
268
 
191
269
  Data Point (Number) for an Economic Index
@@ -193,6 +271,9 @@ Data Point (Number) for an Economic Index
193
271
  Returns a numeric value for the given `tag` for the Economic Index with the given `identifier`
194
272
 
195
273
  ### Example
274
+
275
+ [//]: # (START_CODE_EXAMPLE)
276
+
196
277
  ```ruby
197
278
  # Load the gem
198
279
  require 'intrinio-sdk'
@@ -206,7 +287,7 @@ index_api = Intrinio::IndexApi.new
206
287
 
207
288
  identifier = "$GDP" # String | An Index Identifier (symbol, Intrinio ID)
208
289
 
209
- tag = "level" # String | An Intrinio data tag ID or code-name
290
+ tag = "level" # String | An Intrinio data tag <a href='https://data.intrinio.com/data-tags/economic'>reference</a>
210
291
 
211
292
 
212
293
  begin
@@ -217,18 +298,32 @@ rescue Intrinio::ApiError => e
217
298
  end
218
299
  ```
219
300
 
301
+ [//]: # (END_CODE_EXAMPLE)
302
+
220
303
  ### Parameters
221
304
 
222
305
  Name | Type | Description | Notes
223
306
  ------------- | ------------- | ------------- | -------------
224
307
  **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) |
225
- **tag** | **String**| An Intrinio data tag ID or code-name |
308
+ **tag** | **String**| An Intrinio data tag &lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags/economic&#39;&gt;reference&lt;/a&gt; |
226
309
 
227
310
  ### Return type
228
311
 
229
312
  **Float**
230
313
 
314
+ [//]: # (END_OPERATION)
315
+
316
+
317
+ [//]: # (START_OPERTATION)
318
+
319
+ [//]: # (ENDPOINT:/indices/economic/{identifier}/data_point/{tag}/text)
320
+
321
+ [//]: # (DOC_LINK:IndexApi.md#get_economic_index_data_point_text)
322
+
231
323
  # **get_economic_index_data_point_text**
324
+
325
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_economic_index_data_point_text_v2)
326
+
232
327
  > String get_economic_index_data_point_text(identifier, tag)
233
328
 
234
329
  Data Point (Text) for an Economic Index
@@ -236,6 +331,9 @@ Data Point (Text) for an Economic Index
236
331
  Returns a text value for the given `tag` for the Economic Index with the given `identifier`
237
332
 
238
333
  ### Example
334
+
335
+ [//]: # (START_CODE_EXAMPLE)
336
+
239
337
  ```ruby
240
338
  # Load the gem
241
339
  require 'intrinio-sdk'
@@ -260,6 +358,8 @@ rescue Intrinio::ApiError => e
260
358
  end
261
359
  ```
262
360
 
361
+ [//]: # (END_CODE_EXAMPLE)
362
+
263
363
  ### Parameters
264
364
 
265
365
  Name | Type | Description | Notes
@@ -271,7 +371,19 @@ Name | Type | Description | Notes
271
371
 
272
372
  **String**
273
373
 
374
+ [//]: # (END_OPERATION)
375
+
376
+
377
+ [//]: # (START_OPERTATION)
378
+
379
+ [//]: # (ENDPOINT:/indices/economic/{identifier}/historical_data/{tag})
380
+
381
+ [//]: # (DOC_LINK:IndexApi.md#get_economic_index_historical_data)
382
+
274
383
  # **get_economic_index_historical_data**
384
+
385
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_economic_index_historical_data_v2)
386
+
275
387
  > ApiResponseEconomicIndexHistoricalData get_economic_index_historical_data(identifier, tag, opts)
276
388
 
277
389
  Historical Data for an Economic Index
@@ -279,6 +391,9 @@ Historical Data for an Economic Index
279
391
  Returns historical values for the given `tag` and the Economic Index with the given `identifier`
280
392
 
281
393
  ### Example
394
+
395
+ [//]: # (START_CODE_EXAMPLE)
396
+
282
397
  ```ruby
283
398
  # Load the gem
284
399
  require 'intrinio-sdk'
@@ -292,14 +407,14 @@ index_api = Intrinio::IndexApi.new
292
407
 
293
408
  identifier = "$GDP" # String | An Index Identifier (symbol, Intrinio ID)
294
409
 
295
- tag = "level" # String | An Intrinio data tag ID or code-name
410
+ tag = "level" # String | An Intrinio data tag <a href='https://data.intrinio.com/data-tags/economic'>reference</a>
296
411
 
297
412
  opts = {
298
413
  type: nil, # String | Filter by type, when applicable
299
414
  start_date: Date.parse("2018-01-01"), # Date | Get historical data on or after this date
300
- end_date: Date.parse("2019-01-01"), # Date | Get historical data on or before this date
415
+ end_date: nil, # Date | Get historical data on or before this date
301
416
  sort_order: "desc", # String | Sort by date `asc` or `desc`
302
- page_size: 100, # Float | The number of results to return
417
+ page_size: 100, # Integer | The number of results to return
303
418
  next_page: nil # String | Gets the next page of data from a previous API call
304
419
  }
305
420
 
@@ -311,29 +426,46 @@ rescue Intrinio::ApiError => e
311
426
  end
312
427
  ```
313
428
 
429
+ [//]: # (END_CODE_EXAMPLE)
430
+
314
431
  ### Parameters
315
432
 
316
433
  Name | Type | Description | Notes
317
434
  ------------- | ------------- | ------------- | -------------
318
435
  **identifier** | **String**| An Index Identifier (symbol, Intrinio ID) |
319
- **tag** | **String**| An Intrinio data tag ID or code-name |
436
+ **tag** | **String**| An Intrinio data tag &lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags/economic&#39;&gt;reference&lt;/a&gt; |
320
437
  **type** | **String**| Filter by type, when applicable | [optional]
321
438
  **start_date** | **Date**| Get historical data on or after this date | [optional]
322
439
  **end_date** | **Date**| Get historical data on or before this date | [optional]
323
440
  **sort_order** | **String**| Sort by date &#x60;asc&#x60; or &#x60;desc&#x60; | [optional] [default to desc]
324
- **page_size** | **Float**| The number of results to return | [optional] [default to 100]
441
+ **page_size** | **Integer**| The number of results to return | [optional] [default to 100]
325
442
  **next_page** | **String**| Gets the next page of data from a previous API call | [optional]
326
443
 
327
444
  ### Return type
328
445
 
329
446
  [**ApiResponseEconomicIndexHistoricalData**](ApiResponseEconomicIndexHistoricalData.md)
330
447
 
448
+ [//]: # (END_OPERATION)
449
+
450
+
451
+ [//]: # (START_OPERTATION)
452
+
453
+ [//]: # (ENDPOINT:/indices/sic/{identifier})
454
+
455
+ [//]: # (DOC_LINK:IndexApi.md#get_sic_index_by_id)
456
+
331
457
  # **get_sic_index_by_id**
458
+
459
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_sic_index_by_id_v2)
460
+
332
461
  > SICIndex get_sic_index_by_id(identifier)
333
462
 
334
463
  Lookup SIC Index
335
464
 
336
465
  ### Example
466
+
467
+ [//]: # (START_CODE_EXAMPLE)
468
+
337
469
  ```ruby
338
470
  # Load the gem
339
471
  require 'intrinio-sdk'
@@ -356,6 +488,8 @@ rescue Intrinio::ApiError => e
356
488
  end
357
489
  ```
358
490
 
491
+ [//]: # (END_CODE_EXAMPLE)
492
+
359
493
  ### Parameters
360
494
 
361
495
  Name | Type | Description | Notes
@@ -366,7 +500,19 @@ Name | Type | Description | Notes
366
500
 
367
501
  [**SICIndex**](SICIndex.md)
368
502
 
503
+ [//]: # (END_OPERATION)
504
+
505
+
506
+ [//]: # (START_OPERTATION)
507
+
508
+ [//]: # (ENDPOINT:/indices/sic/{identifier}/data_point/{tag}/number)
509
+
510
+ [//]: # (DOC_LINK:IndexApi.md#get_sic_index_data_point_number)
511
+
369
512
  # **get_sic_index_data_point_number**
513
+
514
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_sic_index_data_point_number_v2)
515
+
370
516
  > Float get_sic_index_data_point_number(identifier, tag)
371
517
 
372
518
  Data Point (Number) for an SIC Index
@@ -374,6 +520,9 @@ Data Point (Number) for an SIC Index
374
520
  Returns a numeric value for the given `tag` for the SIC Index with the given `identifier`
375
521
 
376
522
  ### Example
523
+
524
+ [//]: # (START_CODE_EXAMPLE)
525
+
377
526
  ```ruby
378
527
  # Load the gem
379
528
  require 'intrinio-sdk'
@@ -398,6 +547,8 @@ rescue Intrinio::ApiError => e
398
547
  end
399
548
  ```
400
549
 
550
+ [//]: # (END_CODE_EXAMPLE)
551
+
401
552
  ### Parameters
402
553
 
403
554
  Name | Type | Description | Notes
@@ -409,7 +560,19 @@ Name | Type | Description | Notes
409
560
 
410
561
  **Float**
411
562
 
563
+ [//]: # (END_OPERATION)
564
+
565
+
566
+ [//]: # (START_OPERTATION)
567
+
568
+ [//]: # (ENDPOINT:/indices/sic/{identifier}/data_point/{tag}/text)
569
+
570
+ [//]: # (DOC_LINK:IndexApi.md#get_sic_index_data_point_text)
571
+
412
572
  # **get_sic_index_data_point_text**
573
+
574
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_sic_index_data_point_text_v2)
575
+
413
576
  > String get_sic_index_data_point_text(identifier, tag)
414
577
 
415
578
  Data Point (Text) for an SIC Index
@@ -417,6 +580,9 @@ Data Point (Text) for an SIC Index
417
580
  Returns a text value for the given `tag` for the SIC Index with the given `identifier`
418
581
 
419
582
  ### Example
583
+
584
+ [//]: # (START_CODE_EXAMPLE)
585
+
420
586
  ```ruby
421
587
  # Load the gem
422
588
  require 'intrinio-sdk'
@@ -441,6 +607,8 @@ rescue Intrinio::ApiError => e
441
607
  end
442
608
  ```
443
609
 
610
+ [//]: # (END_CODE_EXAMPLE)
611
+
444
612
  ### Parameters
445
613
 
446
614
  Name | Type | Description | Notes
@@ -452,7 +620,19 @@ Name | Type | Description | Notes
452
620
 
453
621
  **String**
454
622
 
623
+ [//]: # (END_OPERATION)
624
+
625
+
626
+ [//]: # (START_OPERTATION)
627
+
628
+ [//]: # (ENDPOINT:/indices/sic/{identifier}/historical_data/{tag})
629
+
630
+ [//]: # (DOC_LINK:IndexApi.md#get_sic_index_historical_data)
631
+
455
632
  # **get_sic_index_historical_data**
633
+
634
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_sic_index_historical_data_v2)
635
+
456
636
  > ApiResponseSICIndexHistoricalData get_sic_index_historical_data(identifier, tag, opts)
457
637
 
458
638
  Historical Data for an SIC Index
@@ -460,6 +640,9 @@ Historical Data for an SIC Index
460
640
  Returns historical values for the given `tag` and the SIC Index with the given `identifier`
461
641
 
462
642
  ### Example
643
+
644
+ [//]: # (START_CODE_EXAMPLE)
645
+
463
646
  ```ruby
464
647
  # Load the gem
465
648
  require 'intrinio-sdk'
@@ -478,9 +661,9 @@ tag = "marketcap" # String | An Intrinio data tag ID or code-name
478
661
  opts = {
479
662
  type: nil, # String | Filter by type, when applicable
480
663
  start_date: Date.parse("2018-01-01"), # Date | Get historical data on or after this date
481
- end_date: Date.parse("2019-01-01"), # Date | Get historical data on or before this date
664
+ end_date: nil, # Date | Get historical data on or before this date
482
665
  sort_order: "desc", # String | Sort by date `asc` or `desc`
483
- page_size: 100, # Float | The number of results to return
666
+ page_size: 100, # Integer | The number of results to return
484
667
  next_page: nil # String | Gets the next page of data from a previous API call
485
668
  }
486
669
 
@@ -492,6 +675,8 @@ rescue Intrinio::ApiError => e
492
675
  end
493
676
  ```
494
677
 
678
+ [//]: # (END_CODE_EXAMPLE)
679
+
495
680
  ### Parameters
496
681
 
497
682
  Name | Type | Description | Notes
@@ -502,19 +687,34 @@ Name | Type | Description | Notes
502
687
  **start_date** | **Date**| Get historical data on or after this date | [optional]
503
688
  **end_date** | **Date**| Get historical data on or before this date | [optional]
504
689
  **sort_order** | **String**| Sort by date &#x60;asc&#x60; or &#x60;desc&#x60; | [optional] [default to desc]
505
- **page_size** | **Float**| The number of results to return | [optional] [default to 100]
690
+ **page_size** | **Integer**| The number of results to return | [optional] [default to 100]
506
691
  **next_page** | **String**| Gets the next page of data from a previous API call | [optional]
507
692
 
508
693
  ### Return type
509
694
 
510
695
  [**ApiResponseSICIndexHistoricalData**](ApiResponseSICIndexHistoricalData.md)
511
696
 
697
+ [//]: # (END_OPERATION)
698
+
699
+
700
+ [//]: # (START_OPERTATION)
701
+
702
+ [//]: # (ENDPOINT:/indices/stock_market/{identifier})
703
+
704
+ [//]: # (DOC_LINK:IndexApi.md#get_stock_market_index_by_id)
705
+
512
706
  # **get_stock_market_index_by_id**
707
+
708
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_stock_market_index_by_id_v2)
709
+
513
710
  > StockMarketIndex get_stock_market_index_by_id(identifier)
514
711
 
515
712
  Lookup Stock Market Index
516
713
 
517
714
  ### Example
715
+
716
+ [//]: # (START_CODE_EXAMPLE)
717
+
518
718
  ```ruby
519
719
  # Load the gem
520
720
  require 'intrinio-sdk'
@@ -537,6 +737,8 @@ rescue Intrinio::ApiError => e
537
737
  end
538
738
  ```
539
739
 
740
+ [//]: # (END_CODE_EXAMPLE)
741
+
540
742
  ### Parameters
541
743
 
542
744
  Name | Type | Description | Notes
@@ -547,7 +749,19 @@ Name | Type | Description | Notes
547
749
 
548
750
  [**StockMarketIndex**](StockMarketIndex.md)
549
751
 
752
+ [//]: # (END_OPERATION)
753
+
754
+
755
+ [//]: # (START_OPERTATION)
756
+
757
+ [//]: # (ENDPOINT:/indices/stock_market/{identifier}/data_point/{tag}/number)
758
+
759
+ [//]: # (DOC_LINK:IndexApi.md#get_stock_market_index_data_point_number)
760
+
550
761
  # **get_stock_market_index_data_point_number**
762
+
763
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_stock_market_index_data_point_number_v2)
764
+
551
765
  > Float get_stock_market_index_data_point_number(identifier, tag)
552
766
 
553
767
  Data Point (Number) for Stock Market Index
@@ -555,6 +769,9 @@ Data Point (Number) for Stock Market Index
555
769
  Returns a numeric value for the given `tag` for the Stock Market Index with the given `identifier`
556
770
 
557
771
  ### Example
772
+
773
+ [//]: # (START_CODE_EXAMPLE)
774
+
558
775
  ```ruby
559
776
  # Load the gem
560
777
  require 'intrinio-sdk'
@@ -579,6 +796,8 @@ rescue Intrinio::ApiError => e
579
796
  end
580
797
  ```
581
798
 
799
+ [//]: # (END_CODE_EXAMPLE)
800
+
582
801
  ### Parameters
583
802
 
584
803
  Name | Type | Description | Notes
@@ -590,7 +809,19 @@ Name | Type | Description | Notes
590
809
 
591
810
  **Float**
592
811
 
812
+ [//]: # (END_OPERATION)
813
+
814
+
815
+ [//]: # (START_OPERTATION)
816
+
817
+ [//]: # (ENDPOINT:/indices/stock_market/{identifier}/data_point/{tag}/text)
818
+
819
+ [//]: # (DOC_LINK:IndexApi.md#get_stock_market_index_data_point_text)
820
+
593
821
  # **get_stock_market_index_data_point_text**
822
+
823
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_stock_market_index_data_point_text_v2)
824
+
594
825
  > String get_stock_market_index_data_point_text(identifier, tag)
595
826
 
596
827
  Data Point (Text) for Stock Market Index
@@ -598,6 +829,9 @@ Data Point (Text) for Stock Market Index
598
829
  Returns a text value for the given `tag` for the Stock Market Index with the given `identifier`
599
830
 
600
831
  ### Example
832
+
833
+ [//]: # (START_CODE_EXAMPLE)
834
+
601
835
  ```ruby
602
836
  # Load the gem
603
837
  require 'intrinio-sdk'
@@ -622,6 +856,8 @@ rescue Intrinio::ApiError => e
622
856
  end
623
857
  ```
624
858
 
859
+ [//]: # (END_CODE_EXAMPLE)
860
+
625
861
  ### Parameters
626
862
 
627
863
  Name | Type | Description | Notes
@@ -633,7 +869,19 @@ Name | Type | Description | Notes
633
869
 
634
870
  **String**
635
871
 
872
+ [//]: # (END_OPERATION)
873
+
874
+
875
+ [//]: # (START_OPERTATION)
876
+
877
+ [//]: # (ENDPOINT:/indices/stock_market/{identifier}/historical_data/{tag})
878
+
879
+ [//]: # (DOC_LINK:IndexApi.md#get_stock_market_index_historical_data)
880
+
636
881
  # **get_stock_market_index_historical_data**
882
+
883
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_stock_market_index_historical_data_v2)
884
+
637
885
  > ApiResponseStockMarketIndexHistoricalData get_stock_market_index_historical_data(identifier, tag, opts)
638
886
 
639
887
  Historical Data for Stock Market Index
@@ -641,6 +889,9 @@ Historical Data for Stock Market Index
641
889
  Returns historical values for the given `tag` and the Stock Market Index with the given `identifier`
642
890
 
643
891
  ### Example
892
+
893
+ [//]: # (START_CODE_EXAMPLE)
894
+
644
895
  ```ruby
645
896
  # Load the gem
646
897
  require 'intrinio-sdk'
@@ -659,9 +910,9 @@ tag = "level" # String | An Intrinio data tag ID or code-name
659
910
  opts = {
660
911
  type: nil, # String | Filter by type, when applicable
661
912
  start_date: Date.parse("2018-01-01"), # Date | Get historical data on or after this date
662
- end_date: Date.parse("2019-01-01"), # Date | Get historical data on or before this date
913
+ end_date: nil, # Date | Get historical data on or before this date
663
914
  sort_order: "desc", # String | Sort by date `asc` or `desc`
664
- page_size: 100, # Float | The number of results to return
915
+ page_size: 100, # Integer | The number of results to return
665
916
  next_page: nil # String | Gets the next page of data from a previous API call
666
917
  }
667
918
 
@@ -673,6 +924,8 @@ rescue Intrinio::ApiError => e
673
924
  end
674
925
  ```
675
926
 
927
+ [//]: # (END_CODE_EXAMPLE)
928
+
676
929
  ### Parameters
677
930
 
678
931
  Name | Type | Description | Notes
@@ -683,14 +936,26 @@ Name | Type | Description | Notes
683
936
  **start_date** | **Date**| Get historical data on or after this date | [optional]
684
937
  **end_date** | **Date**| Get historical data on or before this date | [optional]
685
938
  **sort_order** | **String**| Sort by date &#x60;asc&#x60; or &#x60;desc&#x60; | [optional] [default to desc]
686
- **page_size** | **Float**| The number of results to return | [optional] [default to 100]
939
+ **page_size** | **Integer**| The number of results to return | [optional] [default to 100]
687
940
  **next_page** | **String**| Gets the next page of data from a previous API call | [optional]
688
941
 
689
942
  ### Return type
690
943
 
691
944
  [**ApiResponseStockMarketIndexHistoricalData**](ApiResponseStockMarketIndexHistoricalData.md)
692
945
 
946
+ [//]: # (END_OPERATION)
947
+
948
+
949
+ [//]: # (START_OPERTATION)
950
+
951
+ [//]: # (ENDPOINT:/indices/economic/search)
952
+
953
+ [//]: # (DOC_LINK:IndexApi.md#search_economic_indices)
954
+
693
955
  # **search_economic_indices**
956
+
957
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/search_economic_indices_v2)
958
+
694
959
  > ApiResponseEconomicIndicesSearch search_economic_indices(query, opts)
695
960
 
696
961
  Search Economic Indices
@@ -698,6 +963,9 @@ Search Economic Indices
698
963
  Searches for indices using the text in `query`
699
964
 
700
965
  ### Example
966
+
967
+ [//]: # (START_CODE_EXAMPLE)
968
+
701
969
  ```ruby
702
970
  # Load the gem
703
971
  require 'intrinio-sdk'
@@ -712,7 +980,7 @@ index_api = Intrinio::IndexApi.new
712
980
  query = "GDP" # String | Search query
713
981
 
714
982
  opts = {
715
- page_size: 100 # Float | The number of results to return
983
+ page_size: 100 # Integer | The number of results to return
716
984
  }
717
985
 
718
986
  begin
@@ -723,18 +991,32 @@ rescue Intrinio::ApiError => e
723
991
  end
724
992
  ```
725
993
 
994
+ [//]: # (END_CODE_EXAMPLE)
995
+
726
996
  ### Parameters
727
997
 
728
998
  Name | Type | Description | Notes
729
999
  ------------- | ------------- | ------------- | -------------
730
1000
  **query** | **String**| Search query |
731
- **page_size** | **Float**| The number of results to return | [optional] [default to 100]
1001
+ **page_size** | **Integer**| The number of results to return | [optional] [default to 100]
732
1002
 
733
1003
  ### Return type
734
1004
 
735
1005
  [**ApiResponseEconomicIndicesSearch**](ApiResponseEconomicIndicesSearch.md)
736
1006
 
1007
+ [//]: # (END_OPERATION)
1008
+
1009
+
1010
+ [//]: # (START_OPERTATION)
1011
+
1012
+ [//]: # (ENDPOINT:/indices/sic/search)
1013
+
1014
+ [//]: # (DOC_LINK:IndexApi.md#search_sic_indices)
1015
+
737
1016
  # **search_sic_indices**
1017
+
1018
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/search_sic_indices_v2)
1019
+
738
1020
  > ApiResponseSICIndicesSearch search_sic_indices(query, opts)
739
1021
 
740
1022
  Search SIC Indices
@@ -742,6 +1024,9 @@ Search SIC Indices
742
1024
  Searches for indices using the text in `query`
743
1025
 
744
1026
  ### Example
1027
+
1028
+ [//]: # (START_CODE_EXAMPLE)
1029
+
745
1030
  ```ruby
746
1031
  # Load the gem
747
1032
  require 'intrinio-sdk'
@@ -756,7 +1041,7 @@ index_api = Intrinio::IndexApi.new
756
1041
  query = "agriculture" # String | Search query
757
1042
 
758
1043
  opts = {
759
- page_size: 100 # Float | The number of results to return
1044
+ page_size: 100 # Integer | The number of results to return
760
1045
  }
761
1046
 
762
1047
  begin
@@ -767,18 +1052,32 @@ rescue Intrinio::ApiError => e
767
1052
  end
768
1053
  ```
769
1054
 
1055
+ [//]: # (END_CODE_EXAMPLE)
1056
+
770
1057
  ### Parameters
771
1058
 
772
1059
  Name | Type | Description | Notes
773
1060
  ------------- | ------------- | ------------- | -------------
774
1061
  **query** | **String**| Search query |
775
- **page_size** | **Float**| The number of results to return | [optional] [default to 100]
1062
+ **page_size** | **Integer**| The number of results to return | [optional] [default to 100]
776
1063
 
777
1064
  ### Return type
778
1065
 
779
1066
  [**ApiResponseSICIndicesSearch**](ApiResponseSICIndicesSearch.md)
780
1067
 
1068
+ [//]: # (END_OPERATION)
1069
+
1070
+
1071
+ [//]: # (START_OPERTATION)
1072
+
1073
+ [//]: # (ENDPOINT:/indices/stock_market/search)
1074
+
1075
+ [//]: # (DOC_LINK:IndexApi.md#search_stock_markets_indices)
1076
+
781
1077
  # **search_stock_markets_indices**
1078
+
1079
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/search_stock_markets_indices_v2)
1080
+
782
1081
  > ApiResponseStockMarketIndicesSearch search_stock_markets_indices(query, opts)
783
1082
 
784
1083
  Search Stock Market Indices
@@ -786,6 +1085,9 @@ Search Stock Market Indices
786
1085
  Searches for indices using the text in `query`
787
1086
 
788
1087
  ### Example
1088
+
1089
+ [//]: # (START_CODE_EXAMPLE)
1090
+
789
1091
  ```ruby
790
1092
  # Load the gem
791
1093
  require 'intrinio-sdk'
@@ -800,7 +1102,7 @@ index_api = Intrinio::IndexApi.new
800
1102
  query = "dow" # String | Search query
801
1103
 
802
1104
  opts = {
803
- page_size: 100 # Float | The number of results to return
1105
+ page_size: 100 # Integer | The number of results to return
804
1106
  }
805
1107
 
806
1108
  begin
@@ -811,14 +1113,18 @@ rescue Intrinio::ApiError => e
811
1113
  end
812
1114
  ```
813
1115
 
1116
+ [//]: # (END_CODE_EXAMPLE)
1117
+
814
1118
  ### Parameters
815
1119
 
816
1120
  Name | Type | Description | Notes
817
1121
  ------------- | ------------- | ------------- | -------------
818
1122
  **query** | **String**| Search query |
819
- **page_size** | **Float**| The number of results to return | [optional] [default to 100]
1123
+ **page_size** | **Integer**| The number of results to return | [optional] [default to 100]
820
1124
 
821
1125
  ### Return type
822
1126
 
823
1127
  [**ApiResponseStockMarketIndicesSearch**](ApiResponseStockMarketIndicesSearch.md)
824
1128
 
1129
+ [//]: # (END_OPERATION)
1130
+