intrinio-sdk 5.6.0 → 5.8.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (498) hide show
  1. checksums.yaml +5 -5
  2. data/Gemfile +2 -0
  3. data/README.md +30 -12
  4. data/docs/ApiResponseOptionsChainRealtime.md +23 -0
  5. data/docs/ApiResponseOptionsPriceRealtime.md +31 -0
  6. data/docs/ApiResponseOptionsStatsRealtime.md +31 -0
  7. data/docs/ApiResponseSecurityIntervalPrices.md +29 -0
  8. data/docs/BulkDownloadsApi.md +3 -7
  9. data/docs/CompanyApi.md +124 -181
  10. data/docs/DataPointApi.md +16 -28
  11. data/docs/DataTagApi.md +21 -33
  12. data/docs/ETFsApi.md +30 -57
  13. data/docs/FilingApi.md +72 -116
  14. data/docs/ForexApi.md +22 -35
  15. data/docs/FundamentalsApi.md +19 -42
  16. data/docs/HistoricalDataApi.md +17 -22
  17. data/docs/IndexApi.md +117 -204
  18. data/docs/MunicipalityApi.md +28 -39
  19. data/docs/OptionChainRealtime.md +31 -0
  20. data/docs/OptionFactorsRealtime.md +25 -0
  21. data/docs/OptionPriceRealtime.md +31 -0
  22. data/docs/OptionRealtime.md +24 -0
  23. data/docs/OptionStatsRealtime.md +24 -0
  24. data/docs/OptionsApi.md +314 -62
  25. data/docs/RealtimeStockPrice.md +2 -0
  26. data/docs/SecurityApi.md +646 -730
  27. data/docs/SecuritySummary.md +1 -0
  28. data/docs/StockExchangeApi.md +43 -67
  29. data/docs/StockPrice.md +7 -0
  30. data/docs/StockPriceInterval.md +25 -0
  31. data/docs/TechnicalApi.md +359 -483
  32. data/docs/ZacksApi.md +132 -165
  33. data/intrinio-sdk.gemspec +3 -2
  34. data/lib/intrinio-sdk.rb +11 -1
  35. data/lib/intrinio-sdk/api/bulk_downloads_api.rb +1 -1
  36. data/lib/intrinio-sdk/api/company_api.rb +22 -19
  37. data/lib/intrinio-sdk/api/data_point_api.rb +13 -13
  38. data/lib/intrinio-sdk/api/data_tag_api.rb +1 -1
  39. data/lib/intrinio-sdk/api/et_fs_api.rb +1 -1
  40. data/lib/intrinio-sdk/api/filing_api.rb +1 -1
  41. data/lib/intrinio-sdk/api/forex_api.rb +5 -5
  42. data/lib/intrinio-sdk/api/fundamentals_api.rb +1 -1
  43. data/lib/intrinio-sdk/api/historical_data_api.rb +7 -7
  44. data/lib/intrinio-sdk/api/index_api.rb +1 -1
  45. data/lib/intrinio-sdk/api/municipality_api.rb +3 -3
  46. data/lib/intrinio-sdk/api/options_api.rb +217 -1
  47. data/lib/intrinio-sdk/api/security_api.rb +124 -35
  48. data/lib/intrinio-sdk/api/stock_exchange_api.rb +3 -3
  49. data/lib/intrinio-sdk/api/technical_api.rb +1 -1
  50. data/lib/intrinio-sdk/api/zacks_api.rb +1 -1
  51. data/lib/intrinio-sdk/api_client.rb +56 -24
  52. data/lib/intrinio-sdk/api_error.rb +1 -1
  53. data/lib/intrinio-sdk/configuration.rb +4 -1
  54. data/lib/intrinio-sdk/models/accumulation_distribution_index_technical_value.rb +1 -1
  55. data/lib/intrinio-sdk/models/api_response_bulk_download_links.rb +1 -1
  56. data/lib/intrinio-sdk/models/api_response_companies.rb +1 -1
  57. data/lib/intrinio-sdk/models/api_response_companies_search.rb +1 -1
  58. data/lib/intrinio-sdk/models/api_response_company_filings.rb +1 -1
  59. data/lib/intrinio-sdk/models/api_response_company_fundamentals.rb +1 -1
  60. data/lib/intrinio-sdk/models/api_response_company_historical_data.rb +1 -1
  61. data/lib/intrinio-sdk/models/api_response_company_news.rb +1 -1
  62. data/lib/intrinio-sdk/models/api_response_company_securities.rb +1 -1
  63. data/lib/intrinio-sdk/models/api_response_data_tags.rb +1 -1
  64. data/lib/intrinio-sdk/models/api_response_data_tags_search.rb +1 -1
  65. data/lib/intrinio-sdk/models/api_response_economic_index_historical_data.rb +1 -1
  66. data/lib/intrinio-sdk/models/api_response_economic_indices.rb +1 -1
  67. data/lib/intrinio-sdk/models/api_response_economic_indices_search.rb +1 -1
  68. data/lib/intrinio-sdk/models/api_response_et_fs.rb +1 -1
  69. data/lib/intrinio-sdk/models/api_response_etf_holdings.rb +1 -1
  70. data/lib/intrinio-sdk/models/api_response_filing_fundamentals.rb +1 -1
  71. data/lib/intrinio-sdk/models/api_response_filing_notes.rb +1 -1
  72. data/lib/intrinio-sdk/models/api_response_filing_notes_search.rb +1 -1
  73. data/lib/intrinio-sdk/models/api_response_filings.rb +1 -1
  74. data/lib/intrinio-sdk/models/api_response_forex_currencies.rb +1 -1
  75. data/lib/intrinio-sdk/models/api_response_forex_pairs.rb +1 -1
  76. data/lib/intrinio-sdk/models/api_response_forex_prices.rb +1 -1
  77. data/lib/intrinio-sdk/models/api_response_historical_data.rb +1 -1
  78. data/lib/intrinio-sdk/models/api_response_initial_public_offerings.rb +1 -1
  79. data/lib/intrinio-sdk/models/api_response_municipalities.rb +1 -1
  80. data/lib/intrinio-sdk/models/api_response_municipalitiy_financials.rb +1 -1
  81. data/lib/intrinio-sdk/models/api_response_news.rb +1 -1
  82. data/lib/intrinio-sdk/models/api_response_option_prices.rb +1 -1
  83. data/lib/intrinio-sdk/models/api_response_options.rb +1 -1
  84. data/lib/intrinio-sdk/models/api_response_options_chain.rb +1 -1
  85. data/lib/intrinio-sdk/models/api_response_options_chain_realtime.rb +191 -0
  86. data/lib/intrinio-sdk/models/api_response_options_expirations.rb +1 -1
  87. data/lib/intrinio-sdk/models/api_response_options_price_realtime.rb +206 -0
  88. data/lib/intrinio-sdk/models/api_response_options_stats_realtime.rb +206 -0
  89. data/lib/intrinio-sdk/models/api_response_reported_financials.rb +1 -1
  90. data/lib/intrinio-sdk/models/api_response_securities.rb +1 -1
  91. data/lib/intrinio-sdk/models/api_response_securities_search.rb +1 -1
  92. data/lib/intrinio-sdk/models/api_response_security_accumulation_distribution_index.rb +1 -1
  93. data/lib/intrinio-sdk/models/api_response_security_average_daily_trading_volume.rb +1 -1
  94. data/lib/intrinio-sdk/models/api_response_security_average_directional_index.rb +1 -1
  95. data/lib/intrinio-sdk/models/api_response_security_average_true_range.rb +1 -1
  96. data/lib/intrinio-sdk/models/api_response_security_awesome_oscillator.rb +1 -1
  97. data/lib/intrinio-sdk/models/api_response_security_bollinger_bands.rb +1 -1
  98. data/lib/intrinio-sdk/models/api_response_security_chaikin_money_flow.rb +1 -1
  99. data/lib/intrinio-sdk/models/api_response_security_commodity_channel_index.rb +1 -1
  100. data/lib/intrinio-sdk/models/api_response_security_detrended_price_oscillator.rb +1 -1
  101. data/lib/intrinio-sdk/models/api_response_security_donchian_channel.rb +1 -1
  102. data/lib/intrinio-sdk/models/api_response_security_ease_of_movement.rb +1 -1
  103. data/lib/intrinio-sdk/models/api_response_security_force_index.rb +1 -1
  104. data/lib/intrinio-sdk/models/api_response_security_historical_data.rb +1 -1
  105. data/lib/intrinio-sdk/models/api_response_security_ichimoku_kinko_hyo.rb +1 -1
  106. data/lib/intrinio-sdk/models/api_response_security_interval_prices.rb +254 -0
  107. data/lib/intrinio-sdk/models/api_response_security_intraday_prices.rb +3 -3
  108. data/lib/intrinio-sdk/models/api_response_security_keltner_channel.rb +1 -1
  109. data/lib/intrinio-sdk/models/api_response_security_know_sure_thing.rb +1 -1
  110. data/lib/intrinio-sdk/models/api_response_security_mass_index.rb +1 -1
  111. data/lib/intrinio-sdk/models/api_response_security_money_flow_index.rb +1 -1
  112. data/lib/intrinio-sdk/models/api_response_security_moving_average_convergence_divergence.rb +1 -1
  113. data/lib/intrinio-sdk/models/api_response_security_negative_volume_index.rb +1 -1
  114. data/lib/intrinio-sdk/models/api_response_security_on_balance_volume.rb +1 -1
  115. data/lib/intrinio-sdk/models/api_response_security_on_balance_volume_mean.rb +1 -1
  116. data/lib/intrinio-sdk/models/api_response_security_relative_strength_index.rb +1 -1
  117. data/lib/intrinio-sdk/models/api_response_security_simple_moving_average.rb +1 -1
  118. data/lib/intrinio-sdk/models/api_response_security_stochastic_oscillator.rb +1 -1
  119. data/lib/intrinio-sdk/models/api_response_security_stock_price_adjustments.rb +1 -1
  120. data/lib/intrinio-sdk/models/api_response_security_stock_prices.rb +1 -1
  121. data/lib/intrinio-sdk/models/api_response_security_triple_exponential_average.rb +1 -1
  122. data/lib/intrinio-sdk/models/api_response_security_true_strength_index.rb +1 -1
  123. data/lib/intrinio-sdk/models/api_response_security_ultimate_oscillator.rb +1 -1
  124. data/lib/intrinio-sdk/models/api_response_security_volume_price_trend.rb +1 -1
  125. data/lib/intrinio-sdk/models/api_response_security_volume_weighted_average_price.rb +1 -1
  126. data/lib/intrinio-sdk/models/api_response_security_vortex_indicator.rb +1 -1
  127. data/lib/intrinio-sdk/models/api_response_security_williams_r.rb +1 -1
  128. data/lib/intrinio-sdk/models/api_response_security_zacks_analyst_ratings.rb +1 -1
  129. data/lib/intrinio-sdk/models/api_response_security_zacks_analyst_ratings_snapshot.rb +1 -1
  130. data/lib/intrinio-sdk/models/api_response_security_zacks_eps_surprises.rb +1 -1
  131. data/lib/intrinio-sdk/models/api_response_security_zacks_sales_surprises.rb +1 -1
  132. data/lib/intrinio-sdk/models/api_response_sic_index_historical_data.rb +1 -1
  133. data/lib/intrinio-sdk/models/api_response_sic_indices.rb +1 -1
  134. data/lib/intrinio-sdk/models/api_response_sic_indices_search.rb +1 -1
  135. data/lib/intrinio-sdk/models/api_response_standardized_financials.rb +1 -1
  136. data/lib/intrinio-sdk/models/api_response_stock_exchange_realtime_stock_prices.rb +1 -1
  137. data/lib/intrinio-sdk/models/api_response_stock_exchange_securities.rb +1 -1
  138. data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_price_adjustments.rb +1 -1
  139. data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_prices.rb +1 -1
  140. data/lib/intrinio-sdk/models/api_response_stock_exchanges.rb +1 -1
  141. data/lib/intrinio-sdk/models/api_response_stock_market_index_historical_data.rb +1 -1
  142. data/lib/intrinio-sdk/models/api_response_stock_market_indices.rb +1 -1
  143. data/lib/intrinio-sdk/models/api_response_stock_market_indices_search.rb +1 -1
  144. data/lib/intrinio-sdk/models/api_response_zacks_analyst_ratings.rb +1 -1
  145. data/lib/intrinio-sdk/models/api_response_zacks_eps_estimates.rb +1 -1
  146. data/lib/intrinio-sdk/models/api_response_zacks_eps_growth_rates.rb +1 -1
  147. data/lib/intrinio-sdk/models/api_response_zacks_eps_surprises.rb +1 -1
  148. data/lib/intrinio-sdk/models/api_response_zacks_etf_holdings.rb +1 -1
  149. data/lib/intrinio-sdk/models/api_response_zacks_institutional_holding_companies.rb +1 -1
  150. data/lib/intrinio-sdk/models/api_response_zacks_institutional_holding_owners.rb +1 -1
  151. data/lib/intrinio-sdk/models/api_response_zacks_institutional_holdings.rb +1 -1
  152. data/lib/intrinio-sdk/models/api_response_zacks_long_term_growth_rates.rb +1 -1
  153. data/lib/intrinio-sdk/models/api_response_zacks_sales_surprises.rb +1 -1
  154. data/lib/intrinio-sdk/models/api_response_zacks_target_price_consensuses.rb +1 -1
  155. data/lib/intrinio-sdk/models/average_daily_trading_volume_technical_value.rb +1 -1
  156. data/lib/intrinio-sdk/models/average_directional_index_technical_value.rb +1 -1
  157. data/lib/intrinio-sdk/models/average_true_range_technical_value.rb +1 -1
  158. data/lib/intrinio-sdk/models/awesome_oscillator_technical_value.rb +1 -1
  159. data/lib/intrinio-sdk/models/bollinger_bands_technical_value.rb +1 -1
  160. data/lib/intrinio-sdk/models/bulk_download_links.rb +1 -1
  161. data/lib/intrinio-sdk/models/bulk_download_summary.rb +1 -1
  162. data/lib/intrinio-sdk/models/chaikin_money_flow_technical_value.rb +1 -1
  163. data/lib/intrinio-sdk/models/commodity_channel_index_technical_value.rb +1 -1
  164. data/lib/intrinio-sdk/models/company.rb +1 -1
  165. data/lib/intrinio-sdk/models/company_filing.rb +1 -1
  166. data/lib/intrinio-sdk/models/company_initial_public_offering.rb +1 -1
  167. data/lib/intrinio-sdk/models/company_news.rb +1 -1
  168. data/lib/intrinio-sdk/models/company_news_summary.rb +1 -1
  169. data/lib/intrinio-sdk/models/company_summary.rb +1 -1
  170. data/lib/intrinio-sdk/models/data_tag.rb +1 -1
  171. data/lib/intrinio-sdk/models/data_tag_summary.rb +1 -1
  172. data/lib/intrinio-sdk/models/detrended_price_oscillator_technical_value.rb +1 -1
  173. data/lib/intrinio-sdk/models/dividend_record.rb +1 -1
  174. data/lib/intrinio-sdk/models/donchian_channel_technical_value.rb +1 -1
  175. data/lib/intrinio-sdk/models/earnings_record.rb +1 -1
  176. data/lib/intrinio-sdk/models/ease_of_movement_technical_value.rb +1 -1
  177. data/lib/intrinio-sdk/models/economic_index.rb +1 -1
  178. data/lib/intrinio-sdk/models/economic_index_summary.rb +1 -1
  179. data/lib/intrinio-sdk/models/etf.rb +1 -1
  180. data/lib/intrinio-sdk/models/etf_analytics.rb +1 -1
  181. data/lib/intrinio-sdk/models/etf_holding.rb +1 -1
  182. data/lib/intrinio-sdk/models/etf_stats.rb +1 -1
  183. data/lib/intrinio-sdk/models/etf_summary.rb +1 -1
  184. data/lib/intrinio-sdk/models/filing.rb +1 -1
  185. data/lib/intrinio-sdk/models/filing_note.rb +1 -1
  186. data/lib/intrinio-sdk/models/filing_note_filing.rb +1 -1
  187. data/lib/intrinio-sdk/models/filing_note_summary.rb +1 -1
  188. data/lib/intrinio-sdk/models/filing_summary.rb +1 -1
  189. data/lib/intrinio-sdk/models/force_index_technical_value.rb +1 -1
  190. data/lib/intrinio-sdk/models/forex_currency.rb +1 -1
  191. data/lib/intrinio-sdk/models/forex_pair.rb +1 -1
  192. data/lib/intrinio-sdk/models/forex_price.rb +1 -1
  193. data/lib/intrinio-sdk/models/fundamental.rb +1 -1
  194. data/lib/intrinio-sdk/models/fundamental_summary.rb +1 -1
  195. data/lib/intrinio-sdk/models/historical_data.rb +1 -1
  196. data/lib/intrinio-sdk/models/ichimoku_kinko_hyo_technical_value.rb +1 -1
  197. data/lib/intrinio-sdk/models/intraday_stock_price.rb +1 -1
  198. data/lib/intrinio-sdk/models/keltner_channel_technical_value.rb +1 -1
  199. data/lib/intrinio-sdk/models/know_sure_thing_technical_value.rb +1 -1
  200. data/lib/intrinio-sdk/models/mass_index_technical_value.rb +1 -1
  201. data/lib/intrinio-sdk/models/money_flow_index_technical_value.rb +1 -1
  202. data/lib/intrinio-sdk/models/moving_average_convergence_divergence_technical_value.rb +1 -1
  203. data/lib/intrinio-sdk/models/municipality.rb +1 -1
  204. data/lib/intrinio-sdk/models/municipality_financial.rb +1 -1
  205. data/lib/intrinio-sdk/models/negative_volume_index_technical_value.rb +1 -1
  206. data/lib/intrinio-sdk/models/on_balance_volume_mean_technical_value.rb +1 -1
  207. data/lib/intrinio-sdk/models/on_balance_volume_technical_value.rb +1 -1
  208. data/lib/intrinio-sdk/models/option.rb +1 -1
  209. data/lib/intrinio-sdk/models/option_chain.rb +1 -1
  210. data/lib/intrinio-sdk/models/option_chain_realtime.rb +206 -0
  211. data/lib/intrinio-sdk/models/option_factors_realtime.rb +239 -0
  212. data/lib/intrinio-sdk/models/option_price.rb +1 -1
  213. data/lib/intrinio-sdk/models/option_price_realtime.rb +332 -0
  214. data/lib/intrinio-sdk/models/option_realtime.rb +262 -0
  215. data/lib/intrinio-sdk/models/option_stats_realtime.rb +229 -0
  216. data/lib/intrinio-sdk/models/realtime_stock_price.rb +22 -2
  217. data/lib/intrinio-sdk/models/realtime_stock_price_security.rb +1 -1
  218. data/lib/intrinio-sdk/models/relative_strength_index_technical_value.rb +1 -1
  219. data/lib/intrinio-sdk/models/reported_financial.rb +1 -1
  220. data/lib/intrinio-sdk/models/reported_financial_dimension.rb +1 -1
  221. data/lib/intrinio-sdk/models/reported_tag.rb +1 -1
  222. data/lib/intrinio-sdk/models/security.rb +1 -1
  223. data/lib/intrinio-sdk/models/security_screen_clause.rb +1 -1
  224. data/lib/intrinio-sdk/models/security_screen_group.rb +1 -1
  225. data/lib/intrinio-sdk/models/security_screen_result.rb +1 -1
  226. data/lib/intrinio-sdk/models/security_screen_result_data.rb +1 -1
  227. data/lib/intrinio-sdk/models/security_summary.rb +15 -5
  228. data/lib/intrinio-sdk/models/sic_index.rb +1 -1
  229. data/lib/intrinio-sdk/models/simple_moving_average_technical_value.rb +1 -1
  230. data/lib/intrinio-sdk/models/standardized_financial.rb +1 -1
  231. data/lib/intrinio-sdk/models/stochastic_oscillator_technical_value.rb +1 -1
  232. data/lib/intrinio-sdk/models/stock_exchange.rb +1 -1
  233. data/lib/intrinio-sdk/models/stock_market_index.rb +1 -1
  234. data/lib/intrinio-sdk/models/stock_market_index_summary.rb +1 -1
  235. data/lib/intrinio-sdk/models/stock_price.rb +72 -2
  236. data/lib/intrinio-sdk/models/stock_price_adjustment.rb +1 -1
  237. data/lib/intrinio-sdk/models/stock_price_adjustment_summary.rb +1 -1
  238. data/lib/intrinio-sdk/models/stock_price_interval.rb +239 -0
  239. data/lib/intrinio-sdk/models/stock_price_summary.rb +1 -1
  240. data/lib/intrinio-sdk/models/technical_indicator.rb +1 -1
  241. data/lib/intrinio-sdk/models/triple_exponential_average_technical_value.rb +1 -1
  242. data/lib/intrinio-sdk/models/true_strength_index_technical_value.rb +1 -1
  243. data/lib/intrinio-sdk/models/ultimate_oscillator_technical_value.rb +1 -1
  244. data/lib/intrinio-sdk/models/volume_price_trend_technical_value.rb +1 -1
  245. data/lib/intrinio-sdk/models/volume_weighted_average_price_value.rb +1 -1
  246. data/lib/intrinio-sdk/models/vortex_indicator_technical_value.rb +1 -1
  247. data/lib/intrinio-sdk/models/williams_r_technical_value.rb +1 -1
  248. data/lib/intrinio-sdk/models/zacks_analyst_rating.rb +1 -1
  249. data/lib/intrinio-sdk/models/zacks_analyst_rating_snapshot.rb +1 -1
  250. data/lib/intrinio-sdk/models/zacks_analyst_rating_summary.rb +1 -1
  251. data/lib/intrinio-sdk/models/zacks_eps_estimate.rb +1 -1
  252. data/lib/intrinio-sdk/models/zacks_eps_growth_rate.rb +1 -1
  253. data/lib/intrinio-sdk/models/zacks_eps_surprise.rb +1 -1
  254. data/lib/intrinio-sdk/models/zacks_eps_surprise_summary.rb +1 -1
  255. data/lib/intrinio-sdk/models/zacks_etf_holding.rb +1 -1
  256. data/lib/intrinio-sdk/models/zacks_institutional_holding.rb +1 -1
  257. data/lib/intrinio-sdk/models/zacks_institutional_holding_company_detail.rb +1 -1
  258. data/lib/intrinio-sdk/models/zacks_institutional_holding_company_summary.rb +1 -1
  259. data/lib/intrinio-sdk/models/zacks_institutional_holding_historical_summary.rb +1 -1
  260. data/lib/intrinio-sdk/models/zacks_institutional_holding_owner_detail.rb +1 -1
  261. data/lib/intrinio-sdk/models/zacks_institutional_holding_owner_summary.rb +1 -1
  262. data/lib/intrinio-sdk/models/zacks_long_term_growth_rate.rb +1 -1
  263. data/lib/intrinio-sdk/models/zacks_sales_surprise.rb +1 -1
  264. data/lib/intrinio-sdk/models/zacks_sales_surprise_summary.rb +1 -1
  265. data/lib/intrinio-sdk/models/zacks_target_price_consensus.rb +1 -1
  266. data/lib/intrinio-sdk/version.rb +2 -2
  267. data/spec/api/bulk_downloads_api_spec.rb +1 -1
  268. data/spec/api/company_api_spec.rb +11 -10
  269. data/spec/api/data_point_api_spec.rb +7 -7
  270. data/spec/api/data_tag_api_spec.rb +1 -1
  271. data/spec/api/et_fs_api_spec.rb +1 -1
  272. data/spec/api/filing_api_spec.rb +1 -1
  273. data/spec/api/forex_api_spec.rb +3 -3
  274. data/spec/api/fundamentals_api_spec.rb +1 -1
  275. data/spec/api/historical_data_api_spec.rb +4 -4
  276. data/spec/api/index_api_spec.rb +1 -1
  277. data/spec/api/municipality_api_spec.rb +2 -2
  278. data/spec/api/options_api_spec.rb +50 -1
  279. data/spec/api/security_api_spec.rb +38 -16
  280. data/spec/api/stock_exchange_api_spec.rb +1 -1
  281. data/spec/api/technical_api_spec.rb +1 -1
  282. data/spec/api/zacks_api_spec.rb +1 -1
  283. data/spec/api_client_spec.rb +1 -1
  284. data/spec/configuration_spec.rb +1 -1
  285. data/spec/models/accumulation_distribution_index_technical_value_spec.rb +1 -1
  286. data/spec/models/api_response_bulk_download_links_spec.rb +1 -1
  287. data/spec/models/api_response_companies_search_spec.rb +1 -1
  288. data/spec/models/api_response_companies_spec.rb +1 -1
  289. data/spec/models/api_response_company_filings_spec.rb +1 -1
  290. data/spec/models/api_response_company_fundamentals_spec.rb +1 -1
  291. data/spec/models/api_response_company_historical_data_spec.rb +1 -1
  292. data/spec/models/api_response_company_news_spec.rb +1 -1
  293. data/spec/models/api_response_company_securities_spec.rb +1 -1
  294. data/spec/models/api_response_data_tags_search_spec.rb +1 -1
  295. data/spec/models/api_response_data_tags_spec.rb +1 -1
  296. data/spec/models/api_response_economic_index_historical_data_spec.rb +1 -1
  297. data/spec/models/api_response_economic_indices_search_spec.rb +1 -1
  298. data/spec/models/api_response_economic_indices_spec.rb +1 -1
  299. data/spec/models/api_response_et_fs_spec.rb +1 -1
  300. data/spec/models/api_response_etf_holdings_spec.rb +1 -1
  301. data/spec/models/api_response_filing_fundamentals_spec.rb +1 -1
  302. data/spec/models/api_response_filing_notes_search_spec.rb +1 -1
  303. data/spec/models/api_response_filing_notes_spec.rb +1 -1
  304. data/spec/models/api_response_filings_spec.rb +1 -1
  305. data/spec/models/api_response_forex_currencies_spec.rb +1 -1
  306. data/spec/models/api_response_forex_pairs_spec.rb +1 -1
  307. data/spec/models/api_response_forex_prices_spec.rb +1 -1
  308. data/spec/models/api_response_historical_data_spec.rb +1 -1
  309. data/spec/models/api_response_initial_public_offerings_spec.rb +1 -1
  310. data/spec/models/api_response_municipalities_spec.rb +1 -1
  311. data/spec/models/api_response_municipalitiy_financials_spec.rb +1 -1
  312. data/spec/models/api_response_news_spec.rb +1 -1
  313. data/spec/models/api_response_option_prices_spec.rb +1 -1
  314. data/spec/models/api_response_options_chain_realtime_spec.rb +42 -0
  315. data/spec/models/api_response_options_chain_spec.rb +1 -1
  316. data/spec/models/api_response_options_expirations_spec.rb +1 -1
  317. data/spec/models/api_response_options_price_realtime_spec.rb +54 -0
  318. data/spec/models/api_response_options_spec.rb +1 -1
  319. data/spec/models/api_response_options_stats_realtime_spec.rb +54 -0
  320. data/spec/models/api_response_reported_financials_spec.rb +1 -1
  321. data/spec/models/api_response_securities_search_spec.rb +1 -1
  322. data/spec/models/api_response_securities_spec.rb +1 -1
  323. data/spec/models/api_response_security_accumulation_distribution_index_spec.rb +1 -1
  324. data/spec/models/api_response_security_average_daily_trading_volume_spec.rb +1 -1
  325. data/spec/models/api_response_security_average_directional_index_spec.rb +1 -1
  326. data/spec/models/api_response_security_average_true_range_spec.rb +1 -1
  327. data/spec/models/api_response_security_awesome_oscillator_spec.rb +1 -1
  328. data/spec/models/api_response_security_bollinger_bands_spec.rb +1 -1
  329. data/spec/models/api_response_security_chaikin_money_flow_spec.rb +1 -1
  330. data/spec/models/api_response_security_commodity_channel_index_spec.rb +1 -1
  331. data/spec/models/api_response_security_detrended_price_oscillator_spec.rb +1 -1
  332. data/spec/models/api_response_security_donchian_channel_spec.rb +1 -1
  333. data/spec/models/api_response_security_ease_of_movement_spec.rb +1 -1
  334. data/spec/models/api_response_security_force_index_spec.rb +1 -1
  335. data/spec/models/api_response_security_historical_data_spec.rb +1 -1
  336. data/spec/models/api_response_security_ichimoku_kinko_hyo_spec.rb +1 -1
  337. data/spec/models/api_response_security_interval_prices_spec.rb +64 -0
  338. data/spec/models/api_response_security_intraday_prices_spec.rb +2 -2
  339. data/spec/models/api_response_security_keltner_channel_spec.rb +1 -1
  340. data/spec/models/api_response_security_know_sure_thing_spec.rb +1 -1
  341. data/spec/models/api_response_security_mass_index_spec.rb +1 -1
  342. data/spec/models/api_response_security_money_flow_index_spec.rb +1 -1
  343. data/spec/models/api_response_security_moving_average_convergence_divergence_spec.rb +1 -1
  344. data/spec/models/api_response_security_negative_volume_index_spec.rb +1 -1
  345. data/spec/models/api_response_security_on_balance_volume_mean_spec.rb +1 -1
  346. data/spec/models/api_response_security_on_balance_volume_spec.rb +1 -1
  347. data/spec/models/api_response_security_relative_strength_index_spec.rb +1 -1
  348. data/spec/models/api_response_security_simple_moving_average_spec.rb +1 -1
  349. data/spec/models/api_response_security_stochastic_oscillator_spec.rb +1 -1
  350. data/spec/models/api_response_security_stock_price_adjustments_spec.rb +1 -1
  351. data/spec/models/api_response_security_stock_prices_spec.rb +1 -1
  352. data/spec/models/api_response_security_triple_exponential_average_spec.rb +1 -1
  353. data/spec/models/api_response_security_true_strength_index_spec.rb +1 -1
  354. data/spec/models/api_response_security_ultimate_oscillator_spec.rb +1 -1
  355. data/spec/models/api_response_security_volume_price_trend_spec.rb +1 -1
  356. data/spec/models/api_response_security_volume_weighted_average_price_spec.rb +1 -1
  357. data/spec/models/api_response_security_vortex_indicator_spec.rb +1 -1
  358. data/spec/models/api_response_security_williams_r_spec.rb +1 -1
  359. data/spec/models/api_response_security_zacks_analyst_ratings_snapshot_spec.rb +1 -1
  360. data/spec/models/api_response_security_zacks_analyst_ratings_spec.rb +1 -1
  361. data/spec/models/api_response_security_zacks_eps_surprises_spec.rb +1 -1
  362. data/spec/models/api_response_security_zacks_sales_surprises_spec.rb +1 -1
  363. data/spec/models/api_response_sic_index_historical_data_spec.rb +1 -1
  364. data/spec/models/api_response_sic_indices_search_spec.rb +1 -1
  365. data/spec/models/api_response_sic_indices_spec.rb +1 -1
  366. data/spec/models/api_response_standardized_financials_spec.rb +1 -1
  367. data/spec/models/api_response_stock_exchange_realtime_stock_prices_spec.rb +1 -1
  368. data/spec/models/api_response_stock_exchange_securities_spec.rb +1 -1
  369. data/spec/models/api_response_stock_exchange_stock_price_adjustments_spec.rb +1 -1
  370. data/spec/models/api_response_stock_exchange_stock_prices_spec.rb +1 -1
  371. data/spec/models/api_response_stock_exchanges_spec.rb +1 -1
  372. data/spec/models/api_response_stock_market_index_historical_data_spec.rb +1 -1
  373. data/spec/models/api_response_stock_market_indices_search_spec.rb +1 -1
  374. data/spec/models/api_response_stock_market_indices_spec.rb +1 -1
  375. data/spec/models/api_response_zacks_analyst_ratings_spec.rb +1 -1
  376. data/spec/models/api_response_zacks_eps_estimates_spec.rb +1 -1
  377. data/spec/models/api_response_zacks_eps_growth_rates_spec.rb +1 -1
  378. data/spec/models/api_response_zacks_eps_surprises_spec.rb +1 -1
  379. data/spec/models/api_response_zacks_etf_holdings_spec.rb +1 -1
  380. data/spec/models/api_response_zacks_institutional_holding_companies_spec.rb +1 -1
  381. data/spec/models/api_response_zacks_institutional_holding_owners_spec.rb +1 -1
  382. data/spec/models/api_response_zacks_institutional_holdings_spec.rb +1 -1
  383. data/spec/models/api_response_zacks_long_term_growth_rates_spec.rb +1 -1
  384. data/spec/models/api_response_zacks_sales_surprises_spec.rb +1 -1
  385. data/spec/models/api_response_zacks_target_price_consensuses_spec.rb +1 -1
  386. data/spec/models/average_daily_trading_volume_technical_value_spec.rb +1 -1
  387. data/spec/models/average_directional_index_technical_value_spec.rb +1 -1
  388. data/spec/models/average_true_range_technical_value_spec.rb +1 -1
  389. data/spec/models/awesome_oscillator_technical_value_spec.rb +1 -1
  390. data/spec/models/bollinger_bands_technical_value_spec.rb +1 -1
  391. data/spec/models/bulk_download_links_spec.rb +1 -1
  392. data/spec/models/bulk_download_summary_spec.rb +1 -1
  393. data/spec/models/chaikin_money_flow_technical_value_spec.rb +1 -1
  394. data/spec/models/commodity_channel_index_technical_value_spec.rb +1 -1
  395. data/spec/models/company_filing_spec.rb +1 -1
  396. data/spec/models/company_initial_public_offering_spec.rb +1 -1
  397. data/spec/models/company_news_spec.rb +1 -1
  398. data/spec/models/company_news_summary_spec.rb +1 -1
  399. data/spec/models/company_spec.rb +1 -1
  400. data/spec/models/company_summary_spec.rb +1 -1
  401. data/spec/models/data_tag_spec.rb +1 -1
  402. data/spec/models/data_tag_summary_spec.rb +1 -1
  403. data/spec/models/detrended_price_oscillator_technical_value_spec.rb +1 -1
  404. data/spec/models/dividend_record_spec.rb +1 -1
  405. data/spec/models/donchian_channel_technical_value_spec.rb +1 -1
  406. data/spec/models/earnings_record_spec.rb +1 -1
  407. data/spec/models/ease_of_movement_technical_value_spec.rb +1 -1
  408. data/spec/models/economic_index_spec.rb +1 -1
  409. data/spec/models/economic_index_summary_spec.rb +1 -1
  410. data/spec/models/etf_analytics_spec.rb +1 -1
  411. data/spec/models/etf_holding_spec.rb +1 -1
  412. data/spec/models/etf_spec.rb +1 -1
  413. data/spec/models/etf_stats_spec.rb +1 -1
  414. data/spec/models/etf_summary_spec.rb +1 -1
  415. data/spec/models/filing_note_filing_spec.rb +1 -1
  416. data/spec/models/filing_note_spec.rb +1 -1
  417. data/spec/models/filing_note_summary_spec.rb +1 -1
  418. data/spec/models/filing_spec.rb +1 -1
  419. data/spec/models/filing_summary_spec.rb +1 -1
  420. data/spec/models/force_index_technical_value_spec.rb +1 -1
  421. data/spec/models/forex_currency_spec.rb +1 -1
  422. data/spec/models/forex_pair_spec.rb +1 -1
  423. data/spec/models/forex_price_spec.rb +1 -1
  424. data/spec/models/fundamental_spec.rb +1 -1
  425. data/spec/models/fundamental_summary_spec.rb +1 -1
  426. data/spec/models/historical_data_spec.rb +1 -1
  427. data/spec/models/ichimoku_kinko_hyo_technical_value_spec.rb +1 -1
  428. data/spec/models/intraday_stock_price_spec.rb +1 -1
  429. data/spec/models/keltner_channel_technical_value_spec.rb +1 -1
  430. data/spec/models/know_sure_thing_technical_value_spec.rb +1 -1
  431. data/spec/models/mass_index_technical_value_spec.rb +1 -1
  432. data/spec/models/money_flow_index_technical_value_spec.rb +1 -1
  433. data/spec/models/moving_average_convergence_divergence_technical_value_spec.rb +1 -1
  434. data/spec/models/municipality_financial_spec.rb +1 -1
  435. data/spec/models/municipality_spec.rb +1 -1
  436. data/spec/models/negative_volume_index_technical_value_spec.rb +1 -1
  437. data/spec/models/on_balance_volume_mean_technical_value_spec.rb +1 -1
  438. data/spec/models/on_balance_volume_technical_value_spec.rb +1 -1
  439. data/spec/models/option_chain_realtime_spec.rb +54 -0
  440. data/spec/models/option_chain_spec.rb +1 -1
  441. data/spec/models/option_factors_realtime_spec.rb +72 -0
  442. data/spec/models/option_price_realtime_spec.rb +112 -0
  443. data/spec/models/option_price_spec.rb +1 -1
  444. data/spec/models/option_realtime_spec.rb +70 -0
  445. data/spec/models/option_spec.rb +1 -1
  446. data/spec/models/option_stats_realtime_spec.rb +66 -0
  447. data/spec/models/realtime_stock_price_security_spec.rb +1 -1
  448. data/spec/models/realtime_stock_price_spec.rb +13 -1
  449. data/spec/models/relative_strength_index_technical_value_spec.rb +1 -1
  450. data/spec/models/reported_financial_dimension_spec.rb +1 -1
  451. data/spec/models/reported_financial_spec.rb +1 -1
  452. data/spec/models/reported_tag_spec.rb +1 -1
  453. data/spec/models/security_screen_clause_spec.rb +1 -1
  454. data/spec/models/security_screen_group_spec.rb +1 -1
  455. data/spec/models/security_screen_result_data_spec.rb +1 -1
  456. data/spec/models/security_screen_result_spec.rb +1 -1
  457. data/spec/models/security_spec.rb +1 -1
  458. data/spec/models/security_summary_spec.rb +7 -1
  459. data/spec/models/sic_index_spec.rb +1 -1
  460. data/spec/models/simple_moving_average_technical_value_spec.rb +1 -1
  461. data/spec/models/standardized_financial_spec.rb +1 -1
  462. data/spec/models/stochastic_oscillator_technical_value_spec.rb +1 -1
  463. data/spec/models/stock_exchange_spec.rb +1 -1
  464. data/spec/models/stock_market_index_spec.rb +1 -1
  465. data/spec/models/stock_market_index_summary_spec.rb +1 -1
  466. data/spec/models/stock_price_adjustment_spec.rb +1 -1
  467. data/spec/models/stock_price_adjustment_summary_spec.rb +1 -1
  468. data/spec/models/stock_price_interval_spec.rb +72 -0
  469. data/spec/models/stock_price_spec.rb +43 -1
  470. data/spec/models/stock_price_summary_spec.rb +1 -1
  471. data/spec/models/technical_indicator_spec.rb +1 -1
  472. data/spec/models/triple_exponential_average_technical_value_spec.rb +1 -1
  473. data/spec/models/true_strength_index_technical_value_spec.rb +1 -1
  474. data/spec/models/ultimate_oscillator_technical_value_spec.rb +1 -1
  475. data/spec/models/volume_price_trend_technical_value_spec.rb +1 -1
  476. data/spec/models/volume_weighted_average_price_value_spec.rb +1 -1
  477. data/spec/models/vortex_indicator_technical_value_spec.rb +1 -1
  478. data/spec/models/williams_r_technical_value_spec.rb +1 -1
  479. data/spec/models/zacks_analyst_rating_snapshot_spec.rb +1 -1
  480. data/spec/models/zacks_analyst_rating_spec.rb +1 -1
  481. data/spec/models/zacks_analyst_rating_summary_spec.rb +1 -1
  482. data/spec/models/zacks_eps_estimate_spec.rb +1 -1
  483. data/spec/models/zacks_eps_growth_rate_spec.rb +1 -1
  484. data/spec/models/zacks_eps_surprise_spec.rb +1 -1
  485. data/spec/models/zacks_eps_surprise_summary_spec.rb +1 -1
  486. data/spec/models/zacks_etf_holding_spec.rb +1 -1
  487. data/spec/models/zacks_institutional_holding_company_detail_spec.rb +1 -1
  488. data/spec/models/zacks_institutional_holding_company_summary_spec.rb +1 -1
  489. data/spec/models/zacks_institutional_holding_historical_summary_spec.rb +1 -1
  490. data/spec/models/zacks_institutional_holding_owner_detail_spec.rb +1 -1
  491. data/spec/models/zacks_institutional_holding_owner_summary_spec.rb +1 -1
  492. data/spec/models/zacks_institutional_holding_spec.rb +1 -1
  493. data/spec/models/zacks_long_term_growth_rate_spec.rb +1 -1
  494. data/spec/models/zacks_sales_surprise_spec.rb +1 -1
  495. data/spec/models/zacks_sales_surprise_summary_spec.rb +1 -1
  496. data/spec/models/zacks_target_price_consensus_spec.rb +1 -1
  497. data/spec/spec_helper.rb +1 -1
  498. metadata +66 -7
@@ -39,6 +39,7 @@ Method | HTTP request | Description
39
39
  #### All Municipalities
40
40
 
41
41
 
42
+ Returns all Municipalities. When parameters are specified, returns matching municipalities.
42
43
 
43
44
  [//]: # (END_OVERVIEW)
44
45
 
@@ -54,32 +55,29 @@ require 'pp'
54
55
  # Setup authorization
55
56
  Intrinio.configure do |config|
56
57
  config.api_key['api_key'] = 'YOUR_API_KEY'
58
+ config.allow_retries = true
57
59
  end
58
60
 
59
61
  municipality_api = Intrinio::MunicipalityApi.new
60
62
 
61
- opts = {
62
- has_financials: true, # BOOLEAN | Return municipalities with financials
63
- government_name: nil, # String | Return municipalities with a government name matching the given query
64
- government_type: nil, # String | Return municipalities with the given government type
65
- area_name: nil, # String | Return municipalities with an area name matching the given query
66
- area_type: nil, # String | Return municipalities with the given area type
67
- city: nil, # String | Return municipalities in the given city
68
- state: nil, # String | Return municipalities in the given state
69
- zipcode: nil, # Float | Return municipalities in the given zipcode
70
- population_greater_than: nil, # Float | Return municipalities with a population greater than the given number
71
- population_less_than: nil, # Float | Return municipalities with a population less than the given number
72
- enrollment_greater_than: nil, # Float | Return municipalities with an enrollment greater than the given number
73
- enrollment_less_than: nil, # Float | Return municipalities with an enrollment less than the given number
74
- next_page: nil # String | Gets the next page of data from a previous API call
63
+ opts = {
64
+ has_financials: nil,
65
+ government_name: nil,
66
+ government_type: nil,
67
+ area_name: nil,
68
+ area_type: nil,
69
+ city: nil,
70
+ state: nil,
71
+ zipcode: nil,
72
+ population_greater_than: nil,
73
+ population_less_than: nil,
74
+ enrollment_greater_than: nil,
75
+ enrollment_less_than: nil,
76
+ next_page: nil
75
77
  }
76
78
 
77
- begin
78
- result = municipality_api.get_all_municipalities(opts)
79
- pp result
80
- rescue Intrinio::ApiError => e
81
- puts "Exception when calling MunicipalityApi->get_all_municipalities: #{e}"
82
- end
79
+ result = municipality_api.get_all_municipalities(opts)
80
+ pp result
83
81
  ```
84
82
 
85
83
  [//]: # (END_CODE_EXAMPLE)
@@ -161,19 +159,14 @@ require 'pp'
161
159
  # Setup authorization
162
160
  Intrinio.configure do |config|
163
161
  config.api_key['api_key'] = 'YOUR_API_KEY'
162
+ config.allow_retries = true
164
163
  end
165
164
 
166
165
  municipality_api = Intrinio::MunicipalityApi.new
166
+ id = "mun_Xn7x4z"
167
167
 
168
- id = "mun_Xn7x4z" # String | An Intrinio ID of a Municipality
169
-
170
-
171
- begin
172
- result = municipality_api.get_municipality_by_id(id)
173
- pp result
174
- rescue Intrinio::ApiError => e
175
- puts "Exception when calling MunicipalityApi->get_municipality_by_id: #{e}"
176
- end
168
+ result = municipality_api.get_municipality_by_id(id)
169
+ pp result
177
170
  ```
178
171
 
179
172
  [//]: # (END_CODE_EXAMPLE)
@@ -243,22 +236,18 @@ require 'pp'
243
236
  # Setup authorization
244
237
  Intrinio.configure do |config|
245
238
  config.api_key['api_key'] = 'YOUR_API_KEY'
239
+ config.allow_retries = true
246
240
  end
247
241
 
248
242
  municipality_api = Intrinio::MunicipalityApi.new
243
+ id = "mun_Xn7x4z"
249
244
 
250
- id = "mun_Xn7x4z" # String | An Intrinio ID of a Municipality
251
-
252
- opts = {
253
- fiscal_year: 2017 # Float | Return financials for the given fiscal year
245
+ opts = {
246
+ fiscal_year: 2017
254
247
  }
255
248
 
256
- begin
257
- result = municipality_api.get_municipality_financials(id, opts)
258
- pp result
259
- rescue Intrinio::ApiError => e
260
- puts "Exception when calling MunicipalityApi->get_municipality_financials: #{e}"
261
- end
249
+ result = municipality_api.get_municipality_financials(id, opts)
250
+ pp result
262
251
  ```
263
252
 
264
253
  [//]: # (END_CODE_EXAMPLE)
@@ -0,0 +1,31 @@
1
+
2
+
3
+ [//]: # (CLASS:Intrinio::OptionChainRealtime)
4
+
5
+ [//]: # (KIND:object)
6
+
7
+ ### Intrinio::OptionChainRealtime
8
+
9
+ #### Properties
10
+
11
+ [//]: # (START_DEFINITION)
12
+
13
+ Name | Type | Description
14
+ ------------ | ------------- | -------------
15
+ **option** | [**OptionRealtime**](OptionRealtime.md) |  
16
+ **price** | [**OptionPriceRealtime**](OptionPriceRealtime.md) |  
17
+ **stats** | [**OptionStatsRealtime**](OptionStatsRealtime.md) |  
18
+
19
+ [//]: # (END_DEFINITION)
20
+
21
+
22
+ [//]: # (CONTAINED_CLASS:Intrinio::OptionRealtime)
23
+
24
+
25
+ [//]: # (CONTAINED_CLASS:Intrinio::OptionPriceRealtime)
26
+
27
+
28
+ [//]: # (CONTAINED_CLASS:Intrinio::OptionStatsRealtime)
29
+
30
+
31
+
@@ -0,0 +1,25 @@
1
+
2
+
3
+ [//]: # (CLASS:Intrinio::OptionFactorsRealtime)
4
+
5
+ [//]: # (KIND:object)
6
+
7
+ ### Intrinio::OptionFactorsRealtime
8
+
9
+ #### Properties
10
+
11
+ [//]: # (START_DEFINITION)
12
+
13
+ Name | Type | Description
14
+ ------------ | ------------- | -------------
15
+ **market_price** | Float | The market price of the options contract  
16
+ **underlying_price** | Float | The market price of the underlying asset  
17
+ **strike_price** | Float | The strike price of the options contract  
18
+ **days_to_expiration** | Float | The number of days to expiration  
19
+ **risk_free_interest_rate** | Float | The current risk-free interest rate, as measured by the 3-month Treasury Bill rate  
20
+ **dividend_yield** | Float | The divident yield of the underlying asset (if applicable)  
21
+
22
+ [//]: # (END_DEFINITION)
23
+
24
+
25
+
@@ -0,0 +1,31 @@
1
+
2
+
3
+ [//]: # (CLASS:Intrinio::OptionPriceRealtime)
4
+
5
+ [//]: # (KIND:object)
6
+
7
+ ### Intrinio::OptionPriceRealtime
8
+
9
+ #### Properties
10
+
11
+ [//]: # (START_DEFINITION)
12
+
13
+ Name | Type | Description
14
+ ------------ | ------------- | -------------
15
+ **last** | Float | The price of the last trade  
16
+ **last_size** | Integer | The size of the last trade  
17
+ **last_timestamp** | DateTime | The time of the last trade  
18
+ **volume** | Integer | The cumulative volume of this options contract that traded that day.  
19
+ **ask** | Float | The price of the top ask order  
20
+ **ask_size** | Integer | The size of the top ask order  
21
+ **ask_timestamp** | DateTime | The timestamp of the top ask order  
22
+ **bid** | Float | The price of the top bid order  
23
+ **bid_size** | Integer | The size of the top bid order  
24
+ **bid_timestamp** | DateTime | The time of the top bid order  
25
+ **open_interest** | Integer | The total number of this options contract that are still open.  
26
+ **exercise_style** | String | The exercise style of the option. (\"A\" = \"American\", \"E\" = \"European\")  
27
+
28
+ [//]: # (END_DEFINITION)
29
+
30
+
31
+
@@ -0,0 +1,24 @@
1
+
2
+
3
+ [//]: # (CLASS:Intrinio::OptionRealtime)
4
+
5
+ [//]: # (KIND:object)
6
+
7
+ ### Intrinio::OptionRealtime
8
+
9
+ #### Properties
10
+
11
+ [//]: # (START_DEFINITION)
12
+
13
+ Name | Type | Description
14
+ ------------ | ------------- | -------------
15
+ **code** | String | The Intrinio Code for the Option.  
16
+ **ticker** | String | The ticker symbol of the Security for the Option.  
17
+ **expiration** | Date | The date on which the Option expires. The Option becomes invalid after this date and cannot be exercised.  
18
+ **strike** | Float | The strike price is the fixed price at which a derivative can be exercised, and refers to the price of the derivative’s underlying asset. In a call option, the strike price is the price at which the option holder can purchase the underlying security. For a put option, the strike price is the price at which the option holder can sell the underlying security.  
19
+ **type** | String | The type of Option (put or call).  
20
+
21
+ [//]: # (END_DEFINITION)
22
+
23
+
24
+
@@ -0,0 +1,24 @@
1
+
2
+
3
+ [//]: # (CLASS:Intrinio::OptionStatsRealtime)
4
+
5
+ [//]: # (KIND:object)
6
+
7
+ ### Intrinio::OptionStatsRealtime
8
+
9
+ #### Properties
10
+
11
+ [//]: # (START_DEFINITION)
12
+
13
+ Name | Type | Description
14
+ ------------ | ------------- | -------------
15
+ **implied_volatility** | Float | The implied volatility of the contract calculated using the Black-Scholes Model.  
16
+ **delta** | Float | Delta represents the rate of change between the option's price and a $1 change in the underlying asset's price.  
17
+ **gamma** | Float | Gamma represents the rate of change between an option's delta and the underlying asset's price.  
18
+ **theta** | Float | Theta represents the rate of change between the option price and time, or time sensitivity - sometimes known as an option's time decay.  
19
+ **vega** | Float | Vega represents the rate of change between an option's value and the underlying asset's implied volatility.  
20
+
21
+ [//]: # (END_DEFINITION)
22
+
23
+
24
+
@@ -6,8 +6,11 @@ Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**get_options**](OptionsApi.md#get_options) | **GET** /options/{symbol} | Options
8
8
  [**get_options_chain**](OptionsApi.md#get_options_chain) | **GET** /options/chain/{symbol}/{expiration} | Options Chain
9
+ [**get_options_chain_realtime**](OptionsApi.md#get_options_chain_realtime) | **GET** /options/chain/{symbol}/{expiration}/realtime | Options Chain Realtime
9
10
  [**get_options_expirations**](OptionsApi.md#get_options_expirations) | **GET** /options/expirations/{symbol} | Options Expirations
10
11
  [**get_options_prices**](OptionsApi.md#get_options_prices) | **GET** /options/prices/{identifier} | Option Prices
12
+ [**get_options_prices_realtime**](OptionsApi.md#get_options_prices_realtime) | **GET** /options/prices/{identifier}/realtime | Option Prices Realtime
13
+ [**get_options_stats_realtime**](OptionsApi.md#get_options_stats_realtime) | **GET** /options/prices/{identifier}/realtime/stats | Option Stats Realtime
11
14
 
12
15
 
13
16
 
@@ -56,30 +59,26 @@ require 'pp'
56
59
  # Setup authorization
57
60
  Intrinio.configure do |config|
58
61
  config.api_key['api_key'] = 'YOUR_API_KEY'
62
+ config.allow_retries = true
59
63
  end
60
64
 
61
65
  options_api = Intrinio::OptionsApi.new
62
-
63
- symbol = "MSFT" # String | The option symbol, corresponding to the underlying security.
64
-
65
- opts = {
66
- type: "put", # String | The option contract type.
67
- strike: 170.0, # Float | The strike price of the option contract. This will return options contracts with strike price equal to this price.
68
- strike_greater_than: 190.0, # Float | The strike price of the option contract. This will return options contracts with strike prices greater than this price.
69
- strike_less_than: 150.0, # Float | The strike price of the option contract. This will return options contracts with strike prices less than this price.
70
- expiration: "2019-03-01", # String | The expiration date of the option contract. This will return options contracts with expiration dates on this date.
71
- expiration_after: "2019-01-01", # String | The expiration date of the option contract. This will return options contracts with expiration dates after this date.
72
- expiration_before: "2019-12-31", # String | The expiration date of the option contract. This will return options contracts with expiration dates before this date.
73
- page_size: 100, # Integer | The number of results to return
74
- next_page: nil # String | Gets the next page of data from a previous API call
66
+ symbol = "AAPL"
67
+
68
+ opts = {
69
+ type: "put",
70
+ strike: 170,
71
+ strike_greater_than: 150,
72
+ strike_less_than: 190,
73
+ expiration: "2019-03-01",
74
+ expiration_after: "2019-01-01",
75
+ expiration_before: "2019-12-31",
76
+ page_size: 100,
77
+ next_page: nil
75
78
  }
76
79
 
77
- begin
78
- result = options_api.get_options(symbol, opts)
79
- pp result
80
- rescue Intrinio::ApiError => e
81
- puts "Exception when calling OptionsApi->get_options: #{e}"
82
- end
80
+ result = options_api.get_options(symbol, opts)
81
+ pp result
83
82
  ```
84
83
 
85
84
  [//]: # (END_CODE_EXAMPLE)
@@ -158,30 +157,25 @@ require 'pp'
158
157
  # Setup authorization
159
158
  Intrinio.configure do |config|
160
159
  config.api_key['api_key'] = 'YOUR_API_KEY'
160
+ config.allow_retries = true
161
161
  end
162
162
 
163
163
  options_api = Intrinio::OptionsApi.new
164
-
165
- symbol = "MSFT" # String | The option symbol, corresponding to the underlying security.
166
-
167
- expiration = "2019-04-05" # String | The expiration date of the options contract
168
-
169
- opts = {
170
- date: Date.parse("2019-04-05"), # Date | The date of the option price. Returns option prices on this date.
171
- type: "put", # String | The option contract type.
172
- strike: 170.0, # Float | The strike price of the option contract. This will return options contracts with strike price equal to this price.
173
- strike_greater_than: 190.0, # Float | The strike price of the option contract. This will return options contracts with strike prices greater than this price.
174
- strike_less_than: 150.0, # Float | The strike price of the option contract. This will return options contracts with strike prices less than this price.
175
- moneyness: "in_the_money", # String | The moneyness of the options contracts to return. 'all' will return all options contracts. 'in_the_money' will return options contracts that are in the money (call options with strike prices below the current price, put options with strike prices above the current price). 'out_of_they_money' will return options contracts that are out of the money (call options with strike prices above the current price, put options with strike prices below the current price). 'near_the_money' will return options contracts that are $0.50 or less away from being in the money.
176
- page_size: 100 # Integer | The number of results to return
164
+ symbol = "MSFT"
165
+ expiration = "2019-04-05"
166
+
167
+ opts = {
168
+ date: nil,
169
+ type: nil,
170
+ strike: nil,
171
+ strike_greater_than: nil,
172
+ strike_less_than: nil,
173
+ moneyness: nil,
174
+ page_size: 100
177
175
  }
178
176
 
179
- begin
180
- result = options_api.get_options_chain(symbol, expiration, opts)
181
- pp result
182
- rescue Intrinio::ApiError => e
183
- puts "Exception when calling OptionsApi->get_options_chain: #{e}"
184
- end
177
+ result = options_api.get_options_chain(symbol, expiration, opts)
178
+ pp result
185
179
  ```
186
180
 
187
181
  [//]: # (END_CODE_EXAMPLE)
@@ -214,6 +208,108 @@ Name | Type | Description | Notes
214
208
  [//]: # (END_OPERATION)
215
209
 
216
210
 
211
+ [//]: # (START_OPERATION)
212
+
213
+ [//]: # (CLASS:Intrinio::OptionsApi)
214
+
215
+ [//]: # (METHOD:get_options_chain_realtime)
216
+
217
+ [//]: # (RETURN_TYPE:Intrinio::ApiResponseOptionsChainRealtime)
218
+
219
+ [//]: # (RETURN_TYPE_KIND:object)
220
+
221
+ [//]: # (RETURN_TYPE_DOC:ApiResponseOptionsChainRealtime.md)
222
+
223
+ [//]: # (OPERATION:get_options_chain_realtime_v2)
224
+
225
+ [//]: # (ENDPOINT:/options/chain/{symbol}/{expiration}/realtime)
226
+
227
+ [//]: # (DOCUMENT_LINK:OptionsApi.md#get_options_chain_realtime)
228
+
229
+ ## **get_options_chain_realtime**
230
+
231
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_options_chain_realtime_v2)
232
+
233
+ [//]: # (START_OVERVIEW)
234
+
235
+ > ApiResponseOptionsChainRealtime get_options_chain_realtime(symbol, expiration, opts)
236
+
237
+ #### Options Chain Realtime
238
+
239
+
240
+ Returns all realtime options contracts and their prices for the given symbol and expiration date.
241
+
242
+ [//]: # (END_OVERVIEW)
243
+
244
+ ### Example
245
+
246
+ [//]: # (START_CODE_EXAMPLE)
247
+
248
+ ```ruby
249
+ # Load the gem
250
+ require 'intrinio-sdk'
251
+ require 'pp'
252
+
253
+ # Setup authorization
254
+ Intrinio.configure do |config|
255
+ config.api_key['api_key'] = 'YOUR_API_KEY'
256
+ config.allow_retries = true
257
+ end
258
+
259
+ options_api = Intrinio::OptionsApi.new
260
+ symbol = "MSFT"
261
+ expiration = "2023-01-20"
262
+
263
+ opts = {
264
+ source: nil,
265
+ type: nil,
266
+ strike: nil,
267
+ strike_greater_than: nil,
268
+ strike_less_than: nil,
269
+ volume_greater_than: nil,
270
+ volume_less_than: nil,
271
+ open_interest_greater_than: nil,
272
+ open_interest_less_than: nil,
273
+ moneyness: nil
274
+ }
275
+
276
+ result = options_api.get_options_chain_realtime(symbol, expiration, opts)
277
+ pp result
278
+ ```
279
+
280
+ [//]: # (END_CODE_EXAMPLE)
281
+
282
+ [//]: # (START_DEFINITION)
283
+
284
+ ### Parameters
285
+
286
+ [//]: # (START_PARAMETERS)
287
+
288
+
289
+ Name | Type | Description | Notes
290
+ ------------- | ------------- | ------------- | -------------
291
+ **symbol** | String| The option symbol, corresponding to the underlying security. |  
292
+ **expiration** | String| The expiration date of the options contract |  
293
+ **source** | String| Realtime or 15-minute delayed contracts. | [optional]  
294
+ **type** | String| The option contract type. | [optional]  
295
+ **strike** | Float| The strike price of the option contract. This will return options contracts with strike price equal to this price. | [optional]  
296
+ **strike_greater_than** | Float| The strike price of the option contract. This will return options contracts with strike prices greater than this price. | [optional]  
297
+ **strike_less_than** | Float| The strike price of the option contract. This will return options contracts with strike prices less than this price. | [optional]  
298
+ **volume_greater_than** | Float| The volume of the option contract. This will return options contracts with volumes greater than this amount. | [optional]  
299
+ **volume_less_than** | Float| The volume of the option contract. This will return options contracts with volumes less than this amout. | [optional]  
300
+ **open_interest_greater_than** | Float| The open interest of the option contract. This will return options contracts with open interest greater than this amount. | [optional]  
301
+ **open_interest_less_than** | Float| The open interest of the option contract. This will return options contracts with open interest less than this amount. | [optional]  
302
+ **moneyness** | String| The moneyness of the options contracts to return. 'all' will return all options contracts. 'in_the_money' will return options contracts that are in the money (call options with strike prices below the current price, put options with strike prices above the current price). 'out_of_they_money' will return options contracts that are out of the money (call options with strike prices above the current price, put options with strike prices below the current price). 'near_the_money' will return options contracts that are $0.50 or less away from being in the money. Requires subscription to realtime stock price data. | [optional]  
303
+
304
+ [//]: # (END_PARAMETERS)
305
+
306
+ ### Return type
307
+
308
+ [**ApiResponseOptionsChainRealtime**](ApiResponseOptionsChainRealtime.md)
309
+
310
+ [//]: # (END_OPERATION)
311
+
312
+
217
313
  [//]: # (START_OPERATION)
218
314
 
219
315
  [//]: # (CLASS:Intrinio::OptionsApi)
@@ -259,23 +355,19 @@ require 'pp'
259
355
  # Setup authorization
260
356
  Intrinio.configure do |config|
261
357
  config.api_key['api_key'] = 'YOUR_API_KEY'
358
+ config.allow_retries = true
262
359
  end
263
360
 
264
361
  options_api = Intrinio::OptionsApi.new
362
+ symbol = "MSFT"
265
363
 
266
- symbol = "MSFT" # String | The option symbol, corresponding to the underlying security.
267
-
268
- opts = {
269
- after: "2019-01-01", # String | Return option contract expiration dates after this date.
270
- before: "2019-12-31" # String | Return option contract expiration dates before this date.
364
+ opts = {
365
+ after: "2019-01-01",
366
+ before: "2019-12-31"
271
367
  }
272
368
 
273
- begin
274
- result = options_api.get_options_expirations(symbol, opts)
275
- pp result
276
- rescue Intrinio::ApiError => e
277
- puts "Exception when calling OptionsApi->get_options_expirations: #{e}"
278
- end
369
+ result = options_api.get_options_expirations(symbol, opts)
370
+ pp result
279
371
  ```
280
372
 
281
373
  [//]: # (END_CODE_EXAMPLE)
@@ -347,25 +439,21 @@ require 'pp'
347
439
  # Setup authorization
348
440
  Intrinio.configure do |config|
349
441
  config.api_key['api_key'] = 'YOUR_API_KEY'
442
+ config.allow_retries = true
350
443
  end
351
444
 
352
445
  options_api = Intrinio::OptionsApi.new
446
+ identifier = "MSFT190405C00118000"
353
447
 
354
- identifier = "identifier_example" # String | The Intrinio ID or code of the options contract to request prices for.
355
-
356
- opts = {
357
- start_date: "2019-01-01", # String | Return option contract prices on or after this date.
358
- end_date: "2019-12-31", # String | Return option contract prices on or before this date.
359
- page_size: 100, # Integer | The number of results to return
360
- next_page: nil # String | Gets the next page of data from a previous API call
448
+ opts = {
449
+ start_date: "2019-01-01",
450
+ end_date: "2019-12-31",
451
+ page_size: 100,
452
+ next_page: nil
361
453
  }
362
454
 
363
- begin
364
- result = options_api.get_options_prices(identifier, opts)
365
- pp result
366
- rescue Intrinio::ApiError => e
367
- puts "Exception when calling OptionsApi->get_options_prices: #{e}"
368
- end
455
+ result = options_api.get_options_prices(identifier, opts)
456
+ pp result
369
457
  ```
370
458
 
371
459
  [//]: # (END_CODE_EXAMPLE)
@@ -393,3 +481,167 @@ Name | Type | Description | Notes
393
481
 
394
482
  [//]: # (END_OPERATION)
395
483
 
484
+
485
+ [//]: # (START_OPERATION)
486
+
487
+ [//]: # (CLASS:Intrinio::OptionsApi)
488
+
489
+ [//]: # (METHOD:get_options_prices_realtime)
490
+
491
+ [//]: # (RETURN_TYPE:Intrinio::ApiResponseOptionsPriceRealtime)
492
+
493
+ [//]: # (RETURN_TYPE_KIND:object)
494
+
495
+ [//]: # (RETURN_TYPE_DOC:ApiResponseOptionsPriceRealtime.md)
496
+
497
+ [//]: # (OPERATION:get_options_prices_realtime_v2)
498
+
499
+ [//]: # (ENDPOINT:/options/prices/{identifier}/realtime)
500
+
501
+ [//]: # (DOCUMENT_LINK:OptionsApi.md#get_options_prices_realtime)
502
+
503
+ ## **get_options_prices_realtime**
504
+
505
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_options_prices_realtime_v2)
506
+
507
+ [//]: # (START_OVERVIEW)
508
+
509
+ > ApiResponseOptionsPriceRealtime get_options_prices_realtime(identifier, opts)
510
+
511
+ #### Option Prices Realtime
512
+
513
+
514
+ Returns all option prices for a given option contract identifier.
515
+
516
+ [//]: # (END_OVERVIEW)
517
+
518
+ ### Example
519
+
520
+ [//]: # (START_CODE_EXAMPLE)
521
+
522
+ ```ruby
523
+ # Load the gem
524
+ require 'intrinio-sdk'
525
+ require 'pp'
526
+
527
+ # Setup authorization
528
+ Intrinio.configure do |config|
529
+ config.api_key['api_key'] = 'YOUR_API_KEY'
530
+ config.allow_retries = true
531
+ end
532
+
533
+ options_api = Intrinio::OptionsApi.new
534
+ identifier = "AAPL230120C00090000"
535
+
536
+ opts = {
537
+ source: nil
538
+ }
539
+
540
+ result = options_api.get_options_prices_realtime(identifier, opts)
541
+ pp result
542
+ ```
543
+
544
+ [//]: # (END_CODE_EXAMPLE)
545
+
546
+ [//]: # (START_DEFINITION)
547
+
548
+ ### Parameters
549
+
550
+ [//]: # (START_PARAMETERS)
551
+
552
+
553
+ Name | Type | Description | Notes
554
+ ------------- | ------------- | ------------- | -------------
555
+ **identifier** | String| The Intrinio ID or code of the options contract to request prices for. |  
556
+ **source** | String| Realtime or 15-minute delayed contracts. | [optional]  
557
+
558
+ [//]: # (END_PARAMETERS)
559
+
560
+ ### Return type
561
+
562
+ [**ApiResponseOptionsPriceRealtime**](ApiResponseOptionsPriceRealtime.md)
563
+
564
+ [//]: # (END_OPERATION)
565
+
566
+
567
+ [//]: # (START_OPERATION)
568
+
569
+ [//]: # (CLASS:Intrinio::OptionsApi)
570
+
571
+ [//]: # (METHOD:get_options_stats_realtime)
572
+
573
+ [//]: # (RETURN_TYPE:Intrinio::ApiResponseOptionsStatsRealtime)
574
+
575
+ [//]: # (RETURN_TYPE_KIND:object)
576
+
577
+ [//]: # (RETURN_TYPE_DOC:ApiResponseOptionsStatsRealtime.md)
578
+
579
+ [//]: # (OPERATION:get_options_stats_realtime_v2)
580
+
581
+ [//]: # (ENDPOINT:/options/prices/{identifier}/realtime/stats)
582
+
583
+ [//]: # (DOCUMENT_LINK:OptionsApi.md#get_options_stats_realtime)
584
+
585
+ ## **get_options_stats_realtime**
586
+
587
+ [**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_options_stats_realtime_v2)
588
+
589
+ [//]: # (START_OVERVIEW)
590
+
591
+ > ApiResponseOptionsStatsRealtime get_options_stats_realtime(identifier, opts)
592
+
593
+ #### Option Stats Realtime
594
+
595
+
596
+ Returns all option stats (greeks and implied volatility) and factors used to calculate them, for a given option contract identifier.
597
+
598
+ [//]: # (END_OVERVIEW)
599
+
600
+ ### Example
601
+
602
+ [//]: # (START_CODE_EXAMPLE)
603
+
604
+ ```ruby
605
+ # Load the gem
606
+ require 'intrinio-sdk'
607
+ require 'pp'
608
+
609
+ # Setup authorization
610
+ Intrinio.configure do |config|
611
+ config.api_key['api_key'] = 'YOUR_API_KEY'
612
+ config.allow_retries = true
613
+ end
614
+
615
+ options_api = Intrinio::OptionsApi.new
616
+ identifier = "AAPL230120C00090000"
617
+
618
+ opts = {
619
+ source: nil
620
+ }
621
+
622
+ result = options_api.get_options_stats_realtime(identifier, opts)
623
+ pp result
624
+ ```
625
+
626
+ [//]: # (END_CODE_EXAMPLE)
627
+
628
+ [//]: # (START_DEFINITION)
629
+
630
+ ### Parameters
631
+
632
+ [//]: # (START_PARAMETERS)
633
+
634
+
635
+ Name | Type | Description | Notes
636
+ ------------- | ------------- | ------------- | -------------
637
+ **identifier** | String| The Intrinio ID or code of the options contract to request prices for. |  
638
+ **source** | String| Realtime or 15-minute delayed contracts. | [optional]  
639
+
640
+ [//]: # (END_PARAMETERS)
641
+
642
+ ### Return type
643
+
644
+ [**ApiResponseOptionsStatsRealtime**](ApiResponseOptionsStatsRealtime.md)
645
+
646
+ [//]: # (END_OPERATION)
647
+