intrinio-sdk 2.1.0 → 2.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (403) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +168 -2
  3. data/docs/AccumulationDistributionIndexTechnicalValue.md +9 -0
  4. data/docs/ApiResponseCryptoBook.md +12 -0
  5. data/docs/ApiResponseCryptoBookAsks.md +11 -0
  6. data/docs/ApiResponseCryptoBookBids.md +11 -0
  7. data/docs/ApiResponseCryptoCurrencies.md +8 -0
  8. data/docs/ApiResponseCryptoExchanges.md +8 -0
  9. data/docs/ApiResponseCryptoPairs.md +9 -0
  10. data/docs/ApiResponseCryptoPrices.md +12 -0
  11. data/docs/ApiResponseCryptoSnapshot.md +10 -0
  12. data/docs/ApiResponseCryptoStats.md +8 -0
  13. data/docs/ApiResponseOptionPrices.md +10 -0
  14. data/docs/ApiResponseOptions.md +9 -0
  15. data/docs/ApiResponseOptionsChain.md +8 -0
  16. data/docs/ApiResponseOptionsExpirations.md +8 -0
  17. data/docs/ApiResponseSecurityAccumulationDistributionIndex.md +11 -0
  18. data/docs/ApiResponseSecurityAverageDailyTradingVolume.md +11 -0
  19. data/docs/ApiResponseSecurityAverageDirectionalIndex.md +11 -0
  20. data/docs/ApiResponseSecurityAverageTrueRange.md +11 -0
  21. data/docs/ApiResponseSecurityAwesomeOscillator.md +11 -0
  22. data/docs/ApiResponseSecurityBollingerBands.md +11 -0
  23. data/docs/ApiResponseSecurityChaikinMoneyFlow.md +11 -0
  24. data/docs/ApiResponseSecurityCommodityChannelIndex.md +11 -0
  25. data/docs/ApiResponseSecurityDetrendedPriceOscillator.md +11 -0
  26. data/docs/ApiResponseSecurityDonchianChannel.md +11 -0
  27. data/docs/ApiResponseSecurityEaseOfMovement.md +11 -0
  28. data/docs/ApiResponseSecurityForceIndex.md +11 -0
  29. data/docs/ApiResponseSecurityIchimokuKinkoHyo.md +11 -0
  30. data/docs/ApiResponseSecurityKeltnerChannel.md +11 -0
  31. data/docs/ApiResponseSecurityKnowSureThing.md +11 -0
  32. data/docs/ApiResponseSecurityMassIndex.md +11 -0
  33. data/docs/ApiResponseSecurityMoneyFlowIndex.md +11 -0
  34. data/docs/ApiResponseSecurityMovingAverageConvergenceDivergence.md +11 -0
  35. data/docs/ApiResponseSecurityNegativeVolumeIndex.md +11 -0
  36. data/docs/ApiResponseSecurityOnBalanceVolume.md +11 -0
  37. data/docs/ApiResponseSecurityOnBalanceVolumeMean.md +11 -0
  38. data/docs/ApiResponseSecurityRelativeStrengthIndex.md +11 -0
  39. data/docs/ApiResponseSecuritySimpleMovingAverage.md +11 -0
  40. data/docs/ApiResponseSecurityStochasticOscillator.md +11 -0
  41. data/docs/ApiResponseSecurityTripleExponentialAverage.md +11 -0
  42. data/docs/ApiResponseSecurityTrueStrengthIndex.md +11 -0
  43. data/docs/ApiResponseSecurityUltimateOscillator.md +11 -0
  44. data/docs/ApiResponseSecurityVolumePriceTrend.md +11 -0
  45. data/docs/ApiResponseSecurityVolumeWeightedAveragePrice.md +11 -0
  46. data/docs/ApiResponseSecurityVortexIndicator.md +11 -0
  47. data/docs/ApiResponseSecurityWilliamsR.md +11 -0
  48. data/docs/AverageDailyTradingVolumeTechnicalValue.md +9 -0
  49. data/docs/AverageDirectionalIndexTechnicalValue.md +11 -0
  50. data/docs/AverageTrueRangeTechnicalValue.md +9 -0
  51. data/docs/AwesomeOscillatorTechnicalValue.md +9 -0
  52. data/docs/BollingerBandsTechnicalValue.md +11 -0
  53. data/docs/ChaikinMoneyFlowTechnicalValue.md +9 -0
  54. data/docs/CommodityChannelIndexTechnicalValue.md +9 -0
  55. data/docs/CompanyApi.md +15 -15
  56. data/docs/CryptoApi.md +433 -0
  57. data/docs/CryptoAsk.md +9 -0
  58. data/docs/CryptoBid.md +9 -0
  59. data/docs/CryptoBookEntry.md +9 -0
  60. data/docs/CryptoCurrency.md +12 -0
  61. data/docs/CryptoExchange.md +13 -0
  62. data/docs/CryptoExchangeSummary.md +9 -0
  63. data/docs/CryptoPair.md +15 -0
  64. data/docs/CryptoPairSummary.md +9 -0
  65. data/docs/CryptoPrice.md +13 -0
  66. data/docs/CryptoSnapshot.md +22 -0
  67. data/docs/CryptoStat.md +15 -0
  68. data/docs/DataPointApi.md +10 -10
  69. data/docs/DetrendedPriceOscillatorTechnicalValue.md +9 -0
  70. data/docs/DonchianChannelTechnicalValue.md +10 -0
  71. data/docs/EaseOfMovementTechnicalValue.md +9 -0
  72. data/docs/ForceIndexTechnicalValue.md +9 -0
  73. data/docs/FundamentalsApi.md +4 -4
  74. data/docs/HistoricalDataApi.md +7 -5
  75. data/docs/IchimokuKinkoHyoTechnicalValue.md +13 -0
  76. data/docs/KeltnerChannelTechnicalValue.md +11 -0
  77. data/docs/KnowSureThingTechnicalValue.md +9 -0
  78. data/docs/MassIndexTechnicalValue.md +9 -0
  79. data/docs/MoneyFlowIndexTechnicalValue.md +9 -0
  80. data/docs/MovingAverageConvergenceDivergenceTechnicalValue.md +11 -0
  81. data/docs/NegativeVolumeIndexTechnicalValue.md +9 -0
  82. data/docs/OnBalanceVolumeMeanTechnicalValue.md +9 -0
  83. data/docs/OnBalanceVolumeTechnicalValue.md +9 -0
  84. data/docs/Option.md +13 -0
  85. data/docs/OptionChain.md +9 -0
  86. data/docs/OptionPrice.md +21 -0
  87. data/docs/OptionsApi.md +225 -0
  88. data/docs/RelativeStrengthIndexTechnicalValue.md +9 -0
  89. data/docs/ReportedFinancial.md +1 -0
  90. data/docs/ReportedFinancialDimension.md +9 -0
  91. data/docs/Security.md +1 -0
  92. data/docs/SecurityApi.md +1717 -22
  93. data/docs/SimpleMovingAverageTechnicalValue.md +9 -0
  94. data/docs/StochasticOscillatorTechnicalValue.md +10 -0
  95. data/docs/StockExchangeApi.md +6 -6
  96. data/docs/TechnicalApi.md +1701 -0
  97. data/docs/TechnicalIndicator.md +9 -0
  98. data/docs/TripleExponentialAverageTechnicalValue.md +9 -0
  99. data/docs/TrueStrengthIndexTechnicalValue.md +9 -0
  100. data/docs/UltimateOscillatorTechnicalValue.md +9 -0
  101. data/docs/VolumePriceTrendTechnicalValue.md +9 -0
  102. data/docs/VolumeWeightedAveragePriceValue.md +9 -0
  103. data/docs/VortexIndicatorTechnicalValue.md +10 -0
  104. data/docs/WilliamsRTechnicalValue.md +9 -0
  105. data/intrinio-sdk.gemspec +1 -1
  106. data/lib/intrinio-sdk.rb +95 -1
  107. data/lib/intrinio-sdk/api/company_api.rb +19 -19
  108. data/lib/intrinio-sdk/api/crypto_api.rb +560 -0
  109. data/lib/intrinio-sdk/api/data_point_api.rb +13 -13
  110. data/lib/intrinio-sdk/api/data_tag_api.rb +1 -1
  111. data/lib/intrinio-sdk/api/filing_api.rb +1 -1
  112. data/lib/intrinio-sdk/api/forex_api.rb +1 -1
  113. data/lib/intrinio-sdk/api/fundamentals_api.rb +5 -5
  114. data/lib/intrinio-sdk/api/historical_data_api.rb +13 -7
  115. data/lib/intrinio-sdk/api/index_api.rb +1 -1
  116. data/lib/intrinio-sdk/api/municipality_api.rb +1 -1
  117. data/lib/intrinio-sdk/api/options_api.rb +325 -0
  118. data/lib/intrinio-sdk/api/security_api.rb +2472 -21
  119. data/lib/intrinio-sdk/api/stock_exchange_api.rb +3 -3
  120. data/lib/intrinio-sdk/api/technical_api.rb +2474 -0
  121. data/lib/intrinio-sdk/api_client.rb +1 -1
  122. data/lib/intrinio-sdk/api_error.rb +1 -1
  123. data/lib/intrinio-sdk/configuration.rb +1 -1
  124. data/lib/intrinio-sdk/models/accumulation_distribution_index_technical_value.rb +199 -0
  125. data/lib/intrinio-sdk/models/api_response_companies.rb +1 -1
  126. data/lib/intrinio-sdk/models/api_response_companies_search.rb +1 -1
  127. data/lib/intrinio-sdk/models/api_response_company_filings.rb +1 -1
  128. data/lib/intrinio-sdk/models/api_response_company_fundamentals.rb +1 -1
  129. data/lib/intrinio-sdk/models/api_response_company_historical_data.rb +1 -1
  130. data/lib/intrinio-sdk/models/api_response_company_news.rb +1 -1
  131. data/lib/intrinio-sdk/models/api_response_company_securities.rb +1 -1
  132. data/lib/intrinio-sdk/models/api_response_crypto_book.rb +231 -0
  133. data/lib/intrinio-sdk/models/api_response_crypto_book_asks.rb +219 -0
  134. data/lib/intrinio-sdk/models/api_response_crypto_book_bids.rb +219 -0
  135. data/lib/intrinio-sdk/models/api_response_crypto_currencies.rb +191 -0
  136. data/lib/intrinio-sdk/models/api_response_crypto_exchanges.rb +191 -0
  137. data/lib/intrinio-sdk/models/api_response_crypto_pairs.rb +201 -0
  138. data/lib/intrinio-sdk/models/api_response_crypto_prices.rb +229 -0
  139. data/lib/intrinio-sdk/models/api_response_crypto_snapshot.rb +206 -0
  140. data/lib/intrinio-sdk/models/api_response_crypto_stats.rb +191 -0
  141. data/lib/intrinio-sdk/models/api_response_data_tags.rb +1 -1
  142. data/lib/intrinio-sdk/models/api_response_data_tags_search.rb +1 -1
  143. data/lib/intrinio-sdk/models/api_response_economic_index_historical_data.rb +1 -1
  144. data/lib/intrinio-sdk/models/api_response_economic_indices.rb +1 -1
  145. data/lib/intrinio-sdk/models/api_response_economic_indices_search.rb +1 -1
  146. data/lib/intrinio-sdk/models/api_response_filing_notes.rb +1 -1
  147. data/lib/intrinio-sdk/models/api_response_filing_notes_search.rb +1 -1
  148. data/lib/intrinio-sdk/models/api_response_filings.rb +1 -1
  149. data/lib/intrinio-sdk/models/api_response_forex_currencies.rb +1 -1
  150. data/lib/intrinio-sdk/models/api_response_forex_pairs.rb +1 -1
  151. data/lib/intrinio-sdk/models/api_response_forex_prices.rb +1 -1
  152. data/lib/intrinio-sdk/models/api_response_historical_data.rb +1 -1
  153. data/lib/intrinio-sdk/models/api_response_municipalities.rb +1 -1
  154. data/lib/intrinio-sdk/models/api_response_municipalitiy_financials.rb +1 -1
  155. data/lib/intrinio-sdk/models/api_response_news.rb +1 -1
  156. data/lib/intrinio-sdk/models/api_response_option_prices.rb +210 -0
  157. data/lib/intrinio-sdk/models/api_response_options.rb +201 -0
  158. data/lib/intrinio-sdk/models/api_response_options_chain.rb +191 -0
  159. data/lib/intrinio-sdk/models/api_response_options_expirations.rb +191 -0
  160. data/lib/intrinio-sdk/models/api_response_reported_financials.rb +1 -1
  161. data/lib/intrinio-sdk/models/api_response_securities.rb +1 -1
  162. data/lib/intrinio-sdk/models/api_response_securities_search.rb +1 -1
  163. data/lib/intrinio-sdk/models/api_response_security_accumulation_distribution_index.rb +220 -0
  164. data/lib/intrinio-sdk/models/api_response_security_average_daily_trading_volume.rb +220 -0
  165. data/lib/intrinio-sdk/models/api_response_security_average_directional_index.rb +220 -0
  166. data/lib/intrinio-sdk/models/api_response_security_average_true_range.rb +220 -0
  167. data/lib/intrinio-sdk/models/api_response_security_awesome_oscillator.rb +220 -0
  168. data/lib/intrinio-sdk/models/api_response_security_bollinger_bands.rb +220 -0
  169. data/lib/intrinio-sdk/models/api_response_security_chaikin_money_flow.rb +220 -0
  170. data/lib/intrinio-sdk/models/api_response_security_commodity_channel_index.rb +220 -0
  171. data/lib/intrinio-sdk/models/api_response_security_detrended_price_oscillator.rb +220 -0
  172. data/lib/intrinio-sdk/models/api_response_security_donchian_channel.rb +220 -0
  173. data/lib/intrinio-sdk/models/api_response_security_ease_of_movement.rb +220 -0
  174. data/lib/intrinio-sdk/models/api_response_security_force_index.rb +220 -0
  175. data/lib/intrinio-sdk/models/api_response_security_historical_data.rb +1 -1
  176. data/lib/intrinio-sdk/models/api_response_security_ichimoku_kinko_hyo.rb +220 -0
  177. data/lib/intrinio-sdk/models/api_response_security_intraday_prices.rb +1 -1
  178. data/lib/intrinio-sdk/models/api_response_security_keltner_channel.rb +220 -0
  179. data/lib/intrinio-sdk/models/api_response_security_know_sure_thing.rb +220 -0
  180. data/lib/intrinio-sdk/models/api_response_security_mass_index.rb +220 -0
  181. data/lib/intrinio-sdk/models/api_response_security_money_flow_index.rb +220 -0
  182. data/lib/intrinio-sdk/models/api_response_security_moving_average_convergence_divergence.rb +220 -0
  183. data/lib/intrinio-sdk/models/api_response_security_negative_volume_index.rb +220 -0
  184. data/lib/intrinio-sdk/models/api_response_security_on_balance_volume.rb +220 -0
  185. data/lib/intrinio-sdk/models/api_response_security_on_balance_volume_mean.rb +220 -0
  186. data/lib/intrinio-sdk/models/api_response_security_relative_strength_index.rb +220 -0
  187. data/lib/intrinio-sdk/models/api_response_security_simple_moving_average.rb +220 -0
  188. data/lib/intrinio-sdk/models/api_response_security_stochastic_oscillator.rb +220 -0
  189. data/lib/intrinio-sdk/models/api_response_security_stock_price_adjustments.rb +1 -1
  190. data/lib/intrinio-sdk/models/api_response_security_stock_prices.rb +1 -1
  191. data/lib/intrinio-sdk/models/api_response_security_triple_exponential_average.rb +220 -0
  192. data/lib/intrinio-sdk/models/api_response_security_true_strength_index.rb +220 -0
  193. data/lib/intrinio-sdk/models/api_response_security_ultimate_oscillator.rb +220 -0
  194. data/lib/intrinio-sdk/models/api_response_security_volume_price_trend.rb +220 -0
  195. data/lib/intrinio-sdk/models/api_response_security_volume_weighted_average_price.rb +220 -0
  196. data/lib/intrinio-sdk/models/api_response_security_vortex_indicator.rb +220 -0
  197. data/lib/intrinio-sdk/models/api_response_security_williams_r.rb +220 -0
  198. data/lib/intrinio-sdk/models/api_response_sic_index_historical_data.rb +1 -1
  199. data/lib/intrinio-sdk/models/api_response_sic_indices.rb +1 -1
  200. data/lib/intrinio-sdk/models/api_response_sic_indices_search.rb +1 -1
  201. data/lib/intrinio-sdk/models/api_response_standardized_financials.rb +1 -1
  202. data/lib/intrinio-sdk/models/api_response_stock_exchange_realtime_stock_prices.rb +1 -1
  203. data/lib/intrinio-sdk/models/api_response_stock_exchange_securities.rb +1 -1
  204. data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_price_adjustments.rb +1 -1
  205. data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_prices.rb +1 -1
  206. data/lib/intrinio-sdk/models/api_response_stock_exchanges.rb +1 -1
  207. data/lib/intrinio-sdk/models/api_response_stock_market_index_historical_data.rb +1 -1
  208. data/lib/intrinio-sdk/models/api_response_stock_market_indices.rb +1 -1
  209. data/lib/intrinio-sdk/models/api_response_stock_market_indices_search.rb +1 -1
  210. data/lib/intrinio-sdk/models/average_daily_trading_volume_technical_value.rb +199 -0
  211. data/lib/intrinio-sdk/models/average_directional_index_technical_value.rb +219 -0
  212. data/lib/intrinio-sdk/models/average_true_range_technical_value.rb +199 -0
  213. data/lib/intrinio-sdk/models/awesome_oscillator_technical_value.rb +199 -0
  214. data/lib/intrinio-sdk/models/bollinger_bands_technical_value.rb +219 -0
  215. data/lib/intrinio-sdk/models/chaikin_money_flow_technical_value.rb +199 -0
  216. data/lib/intrinio-sdk/models/commodity_channel_index_technical_value.rb +199 -0
  217. data/lib/intrinio-sdk/models/company.rb +1 -1
  218. data/lib/intrinio-sdk/models/company_filing.rb +1 -1
  219. data/lib/intrinio-sdk/models/company_news.rb +1 -1
  220. data/lib/intrinio-sdk/models/company_news_summary.rb +1 -1
  221. data/lib/intrinio-sdk/models/company_summary.rb +1 -1
  222. data/lib/intrinio-sdk/models/crypto_ask.rb +199 -0
  223. data/lib/intrinio-sdk/models/crypto_bid.rb +199 -0
  224. data/lib/intrinio-sdk/models/crypto_book_entry.rb +199 -0
  225. data/lib/intrinio-sdk/models/crypto_currency.rb +229 -0
  226. data/lib/intrinio-sdk/models/crypto_exchange.rb +239 -0
  227. data/lib/intrinio-sdk/models/crypto_exchange_summary.rb +199 -0
  228. data/lib/intrinio-sdk/models/crypto_pair.rb +259 -0
  229. data/lib/intrinio-sdk/models/crypto_pair_summary.rb +199 -0
  230. data/lib/intrinio-sdk/models/crypto_price.rb +239 -0
  231. data/lib/intrinio-sdk/models/crypto_snapshot.rb +329 -0
  232. data/lib/intrinio-sdk/models/crypto_stat.rb +259 -0
  233. data/lib/intrinio-sdk/models/data_tag.rb +1 -1
  234. data/lib/intrinio-sdk/models/data_tag_summary.rb +1 -1
  235. data/lib/intrinio-sdk/models/detrended_price_oscillator_technical_value.rb +199 -0
  236. data/lib/intrinio-sdk/models/dividend_record.rb +1 -1
  237. data/lib/intrinio-sdk/models/donchian_channel_technical_value.rb +209 -0
  238. data/lib/intrinio-sdk/models/earnings_record.rb +1 -1
  239. data/lib/intrinio-sdk/models/ease_of_movement_technical_value.rb +199 -0
  240. data/lib/intrinio-sdk/models/economic_index.rb +1 -1
  241. data/lib/intrinio-sdk/models/economic_index_summary.rb +1 -1
  242. data/lib/intrinio-sdk/models/filing.rb +1 -1
  243. data/lib/intrinio-sdk/models/filing_note.rb +1 -1
  244. data/lib/intrinio-sdk/models/filing_note_filing.rb +1 -1
  245. data/lib/intrinio-sdk/models/filing_note_summary.rb +1 -1
  246. data/lib/intrinio-sdk/models/filing_summary.rb +1 -1
  247. data/lib/intrinio-sdk/models/force_index_technical_value.rb +199 -0
  248. data/lib/intrinio-sdk/models/forex_currency.rb +1 -1
  249. data/lib/intrinio-sdk/models/forex_pair.rb +1 -1
  250. data/lib/intrinio-sdk/models/forex_price.rb +1 -1
  251. data/lib/intrinio-sdk/models/fundamental.rb +1 -1
  252. data/lib/intrinio-sdk/models/fundamental_summary.rb +1 -1
  253. data/lib/intrinio-sdk/models/historical_data.rb +1 -1
  254. data/lib/intrinio-sdk/models/ichimoku_kinko_hyo_technical_value.rb +239 -0
  255. data/lib/intrinio-sdk/models/intraday_stock_price.rb +1 -1
  256. data/lib/intrinio-sdk/models/keltner_channel_technical_value.rb +219 -0
  257. data/lib/intrinio-sdk/models/know_sure_thing_technical_value.rb +199 -0
  258. data/lib/intrinio-sdk/models/mass_index_technical_value.rb +199 -0
  259. data/lib/intrinio-sdk/models/money_flow_index_technical_value.rb +199 -0
  260. data/lib/intrinio-sdk/models/moving_average_convergence_divergence_technical_value.rb +219 -0
  261. data/lib/intrinio-sdk/models/municipality.rb +1 -1
  262. data/lib/intrinio-sdk/models/municipality_financial.rb +1 -1
  263. data/lib/intrinio-sdk/models/negative_volume_index_technical_value.rb +199 -0
  264. data/lib/intrinio-sdk/models/on_balance_volume_mean_technical_value.rb +199 -0
  265. data/lib/intrinio-sdk/models/on_balance_volume_technical_value.rb +199 -0
  266. data/lib/intrinio-sdk/models/option.rb +239 -0
  267. data/lib/intrinio-sdk/models/option_chain.rb +197 -0
  268. data/lib/intrinio-sdk/models/option_price.rb +319 -0
  269. data/lib/intrinio-sdk/models/realtime_stock_price.rb +1 -1
  270. data/lib/intrinio-sdk/models/realtime_stock_price_security.rb +1 -1
  271. data/lib/intrinio-sdk/models/relative_strength_index_technical_value.rb +199 -0
  272. data/lib/intrinio-sdk/models/reported_financial.rb +18 -6
  273. data/lib/intrinio-sdk/models/reported_financial_dimension.rb +199 -0
  274. data/lib/intrinio-sdk/models/reported_tag.rb +1 -1
  275. data/lib/intrinio-sdk/models/security.rb +15 -5
  276. data/lib/intrinio-sdk/models/security_screen_clause.rb +1 -1
  277. data/lib/intrinio-sdk/models/security_screen_group.rb +1 -1
  278. data/lib/intrinio-sdk/models/security_screen_result.rb +1 -1
  279. data/lib/intrinio-sdk/models/security_screen_result_data.rb +1 -1
  280. data/lib/intrinio-sdk/models/security_summary.rb +1 -1
  281. data/lib/intrinio-sdk/models/sic_index.rb +1 -1
  282. data/lib/intrinio-sdk/models/simple_moving_average_technical_value.rb +199 -0
  283. data/lib/intrinio-sdk/models/standardized_financial.rb +1 -1
  284. data/lib/intrinio-sdk/models/stochastic_oscillator_technical_value.rb +209 -0
  285. data/lib/intrinio-sdk/models/stock_exchange.rb +1 -1
  286. data/lib/intrinio-sdk/models/stock_market_index.rb +1 -1
  287. data/lib/intrinio-sdk/models/stock_market_index_summary.rb +1 -1
  288. data/lib/intrinio-sdk/models/stock_price.rb +1 -1
  289. data/lib/intrinio-sdk/models/stock_price_adjustment.rb +1 -1
  290. data/lib/intrinio-sdk/models/stock_price_adjustment_summary.rb +1 -1
  291. data/lib/intrinio-sdk/models/stock_price_summary.rb +1 -1
  292. data/lib/intrinio-sdk/models/technical_indicator.rb +199 -0
  293. data/lib/intrinio-sdk/models/triple_exponential_average_technical_value.rb +199 -0
  294. data/lib/intrinio-sdk/models/true_strength_index_technical_value.rb +199 -0
  295. data/lib/intrinio-sdk/models/ultimate_oscillator_technical_value.rb +199 -0
  296. data/lib/intrinio-sdk/models/volume_price_trend_technical_value.rb +199 -0
  297. data/lib/intrinio-sdk/models/volume_weighted_average_price_value.rb +199 -0
  298. data/lib/intrinio-sdk/models/vortex_indicator_technical_value.rb +209 -0
  299. data/lib/intrinio-sdk/models/williams_r_technical_value.rb +199 -0
  300. data/lib/intrinio-sdk/version.rb +2 -2
  301. data/spec/api/company_api_spec.rb +9 -9
  302. data/spec/api/crypto_api_spec.rb +166 -0
  303. data/spec/api/data_point_api_spec.rb +6 -6
  304. data/spec/api/fundamentals_api_spec.rb +2 -2
  305. data/spec/api/historical_data_api_spec.rb +4 -3
  306. data/spec/api/options_api_spec.rb +105 -0
  307. data/spec/api/security_api_spec.rb +562 -10
  308. data/spec/api/stock_exchange_api_spec.rb +1 -1
  309. data/spec/api/technical_api_spec.rb +587 -0
  310. data/spec/models/accumulation_distribution_index_technical_value_spec.rb +48 -0
  311. data/spec/models/api_response_crypto_book_asks_spec.rb +60 -0
  312. data/spec/models/api_response_crypto_book_bids_spec.rb +60 -0
  313. data/spec/models/api_response_crypto_book_spec.rb +66 -0
  314. data/spec/models/api_response_crypto_currencies_spec.rb +42 -0
  315. data/spec/models/api_response_crypto_exchanges_spec.rb +42 -0
  316. data/spec/models/api_response_crypto_pairs_spec.rb +48 -0
  317. data/spec/models/api_response_crypto_prices_spec.rb +66 -0
  318. data/spec/models/api_response_crypto_snapshot_spec.rb +54 -0
  319. data/spec/models/api_response_crypto_stats_spec.rb +42 -0
  320. data/spec/models/api_response_option_prices_spec.rb +54 -0
  321. data/spec/models/api_response_options_chain_spec.rb +42 -0
  322. data/spec/models/api_response_options_expirations_spec.rb +42 -0
  323. data/spec/models/api_response_options_spec.rb +48 -0
  324. data/spec/models/api_response_security_accumulation_distribution_index_spec.rb +60 -0
  325. data/spec/models/api_response_security_average_daily_trading_volume_spec.rb +60 -0
  326. data/spec/models/api_response_security_average_directional_index_spec.rb +60 -0
  327. data/spec/models/api_response_security_average_true_range_spec.rb +60 -0
  328. data/spec/models/api_response_security_awesome_oscillator_spec.rb +60 -0
  329. data/spec/models/api_response_security_bollinger_bands_spec.rb +60 -0
  330. data/spec/models/api_response_security_chaikin_money_flow_spec.rb +60 -0
  331. data/spec/models/api_response_security_commodity_channel_index_spec.rb +60 -0
  332. data/spec/models/api_response_security_detrended_price_oscillator_spec.rb +60 -0
  333. data/spec/models/api_response_security_donchian_channel_spec.rb +60 -0
  334. data/spec/models/api_response_security_ease_of_movement_spec.rb +60 -0
  335. data/spec/models/api_response_security_force_index_spec.rb +60 -0
  336. data/spec/models/api_response_security_ichimoku_kinko_hyo_spec.rb +60 -0
  337. data/spec/models/api_response_security_keltner_channel_spec.rb +60 -0
  338. data/spec/models/api_response_security_know_sure_thing_spec.rb +60 -0
  339. data/spec/models/api_response_security_mass_index_spec.rb +60 -0
  340. data/spec/models/api_response_security_money_flow_index_spec.rb +60 -0
  341. data/spec/models/api_response_security_moving_average_convergence_divergence_spec.rb +60 -0
  342. data/spec/models/api_response_security_negative_volume_index_spec.rb +60 -0
  343. data/spec/models/api_response_security_on_balance_volume_mean_spec.rb +60 -0
  344. data/spec/models/api_response_security_on_balance_volume_spec.rb +60 -0
  345. data/spec/models/api_response_security_relative_strength_index_spec.rb +60 -0
  346. data/spec/models/api_response_security_simple_moving_average_spec.rb +60 -0
  347. data/spec/models/api_response_security_stochastic_oscillator_spec.rb +60 -0
  348. data/spec/models/api_response_security_triple_exponential_average_spec.rb +60 -0
  349. data/spec/models/api_response_security_true_strength_index_spec.rb +60 -0
  350. data/spec/models/api_response_security_ultimate_oscillator_spec.rb +60 -0
  351. data/spec/models/api_response_security_volume_price_trend_spec.rb +60 -0
  352. data/spec/models/api_response_security_volume_weighted_average_price_spec.rb +60 -0
  353. data/spec/models/api_response_security_vortex_indicator_spec.rb +60 -0
  354. data/spec/models/api_response_security_williams_r_spec.rb +60 -0
  355. data/spec/models/average_daily_trading_volume_technical_value_spec.rb +48 -0
  356. data/spec/models/average_directional_index_technical_value_spec.rb +60 -0
  357. data/spec/models/average_true_range_technical_value_spec.rb +48 -0
  358. data/spec/models/awesome_oscillator_technical_value_spec.rb +48 -0
  359. data/spec/models/bollinger_bands_technical_value_spec.rb +60 -0
  360. data/spec/models/chaikin_money_flow_technical_value_spec.rb +48 -0
  361. data/spec/models/commodity_channel_index_technical_value_spec.rb +48 -0
  362. data/spec/models/crypto_ask_spec.rb +48 -0
  363. data/spec/models/crypto_bid_spec.rb +48 -0
  364. data/spec/models/crypto_book_entry_spec.rb +48 -0
  365. data/spec/models/crypto_currency_spec.rb +66 -0
  366. data/spec/models/crypto_exchange_spec.rb +72 -0
  367. data/spec/models/crypto_exchange_summary_spec.rb +48 -0
  368. data/spec/models/crypto_pair_spec.rb +84 -0
  369. data/spec/models/crypto_pair_summary_spec.rb +48 -0
  370. data/spec/models/crypto_price_spec.rb +72 -0
  371. data/spec/models/crypto_snapshot_spec.rb +126 -0
  372. data/spec/models/crypto_stat_spec.rb +84 -0
  373. data/spec/models/detrended_price_oscillator_technical_value_spec.rb +48 -0
  374. data/spec/models/donchian_channel_technical_value_spec.rb +54 -0
  375. data/spec/models/ease_of_movement_technical_value_spec.rb +48 -0
  376. data/spec/models/force_index_technical_value_spec.rb +48 -0
  377. data/spec/models/ichimoku_kinko_hyo_technical_value_spec.rb +72 -0
  378. data/spec/models/keltner_channel_technical_value_spec.rb +60 -0
  379. data/spec/models/know_sure_thing_technical_value_spec.rb +48 -0
  380. data/spec/models/mass_index_technical_value_spec.rb +48 -0
  381. data/spec/models/money_flow_index_technical_value_spec.rb +48 -0
  382. data/spec/models/moving_average_convergence_divergence_technical_value_spec.rb +60 -0
  383. data/spec/models/negative_volume_index_technical_value_spec.rb +48 -0
  384. data/spec/models/on_balance_volume_mean_technical_value_spec.rb +48 -0
  385. data/spec/models/on_balance_volume_technical_value_spec.rb +48 -0
  386. data/spec/models/option_chain_spec.rb +48 -0
  387. data/spec/models/option_price_spec.rb +120 -0
  388. data/spec/models/option_spec.rb +72 -0
  389. data/spec/models/relative_strength_index_technical_value_spec.rb +48 -0
  390. data/spec/models/reported_financial_dimension_spec.rb +48 -0
  391. data/spec/models/reported_financial_spec.rb +6 -0
  392. data/spec/models/security_spec.rb +6 -0
  393. data/spec/models/simple_moving_average_technical_value_spec.rb +48 -0
  394. data/spec/models/stochastic_oscillator_technical_value_spec.rb +54 -0
  395. data/spec/models/technical_indicator_spec.rb +48 -0
  396. data/spec/models/triple_exponential_average_technical_value_spec.rb +48 -0
  397. data/spec/models/true_strength_index_technical_value_spec.rb +48 -0
  398. data/spec/models/ultimate_oscillator_technical_value_spec.rb +48 -0
  399. data/spec/models/volume_price_trend_technical_value_spec.rb +48 -0
  400. data/spec/models/volume_weighted_average_price_value_spec.rb +48 -0
  401. data/spec/models/vortex_indicator_technical_value_spec.rb +54 -0
  402. data/spec/models/williams_r_technical_value_spec.rb +48 -0
  403. metadata +378 -2
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
5
5
 
6
- OpenAPI spec version: 2.2.0
6
+ OpenAPI spec version: 2.5.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.0-SNAPSHOT
@@ -21,9 +21,9 @@ module Intrinio
21
21
  end
22
22
 
23
23
  # Data Point (Number)
24
- # Returns a numeric value for the given `tag` and the entity with the given `identifier`
25
- # @param identifier An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
26
- # @param tag An Intrinio data tag ID or code-name
24
+ # $$v2_data_point_number_description$$
25
+ # @param identifier $$v2_data_point_identifier_description$$
26
+ # @param tag $$v2_data_point_item_description$$
27
27
  # @param [Hash] opts the optional parameters
28
28
  # @return [Float]
29
29
  def get_data_point_number(identifier, tag, opts = {})
@@ -32,9 +32,9 @@ module Intrinio
32
32
  end
33
33
 
34
34
  # Data Point (Number)
35
- # Returns a numeric value for the given `tag` and the entity with the given `identifier`
36
- # @param identifier An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
37
- # @param tag An Intrinio data tag ID or code-name
35
+ # $$v2_data_point_number_description$$
36
+ # @param identifier $$v2_data_point_identifier_description$$
37
+ # @param tag $$v2_data_point_item_description$$
38
38
  # @param [Hash] opts the optional parameters
39
39
  # @return [Array<(Float, Fixnum, Hash)>] Float data, response status code and response headers
40
40
  def get_data_point_number_with_http_info(identifier, tag, opts = {})
@@ -80,9 +80,9 @@ module Intrinio
80
80
  end
81
81
 
82
82
  # Data Point (Text)
83
- # Returns a text value for the given `tag` and the entity with the given `identifier`
84
- # @param identifier An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
85
- # @param tag An Intrinio data tag ID or code-name
83
+ # $$v2_data_point_text_description$$
84
+ # @param identifier $$v2_data_point_identifier_description$$
85
+ # @param tag $$v2_data_point_item_description$$
86
86
  # @param [Hash] opts the optional parameters
87
87
  # @return [String]
88
88
  def get_data_point_text(identifier, tag, opts = {})
@@ -91,9 +91,9 @@ module Intrinio
91
91
  end
92
92
 
93
93
  # Data Point (Text)
94
- # Returns a text value for the given &#x60;tag&#x60; and the entity with the given &#x60;identifier&#x60;
95
- # @param identifier An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
96
- # @param tag An Intrinio data tag ID or code-name
94
+ # $$v2_data_point_text_description$$
95
+ # @param identifier $$v2_data_point_identifier_description$$
96
+ # @param tag $$v2_data_point_item_description$$
97
97
  # @param [Hash] opts the optional parameters
98
98
  # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
99
99
  def get_data_point_text_with_http_info(identifier, tag, opts = {})
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
5
5
 
6
- OpenAPI spec version: 2.2.0
6
+ OpenAPI spec version: 2.5.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.0-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
5
5
 
6
- OpenAPI spec version: 2.2.0
6
+ OpenAPI spec version: 2.5.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.0-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
5
5
 
6
- OpenAPI spec version: 2.2.0
6
+ OpenAPI spec version: 2.5.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.0-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
5
5
 
6
- OpenAPI spec version: 2.2.0
6
+ OpenAPI spec version: 2.5.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.0-SNAPSHOT
@@ -75,7 +75,7 @@ module Intrinio
75
75
 
76
76
  # Reported Financials
77
77
  # Returns the As-Reported Financials directly from the financial statements of the XBRL filings from the company
78
- # @param id The Intrinio ID for the Fundamental
78
+ # @param id The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental
79
79
  # @param [Hash] opts the optional parameters
80
80
  # @return [ApiResponseReportedFinancials]
81
81
  def get_fundamental_reported_financials(id, opts = {})
@@ -85,7 +85,7 @@ module Intrinio
85
85
 
86
86
  # Reported Financials
87
87
  # Returns the As-Reported Financials directly from the financial statements of the XBRL filings from the company
88
- # @param id The Intrinio ID for the Fundamental
88
+ # @param id The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental
89
89
  # @param [Hash] opts the optional parameters
90
90
  # @return [Array<(ApiResponseReportedFinancials, Fixnum, Hash)>] ApiResponseReportedFinancials data, response status code and response headers
91
91
  def get_fundamental_reported_financials_with_http_info(id, opts = {})
@@ -128,7 +128,7 @@ module Intrinio
128
128
 
129
129
  # Standardized Financials
130
130
  # 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.
131
- # @param id The Intrinio ID for the Fundamental
131
+ # @param id The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental
132
132
  # @param [Hash] opts the optional parameters
133
133
  # @return [ApiResponseStandardizedFinancials]
134
134
  def get_fundamental_standardized_financials(id, opts = {})
@@ -138,7 +138,7 @@ module Intrinio
138
138
 
139
139
  # Standardized Financials
140
140
  # 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.
141
- # @param id The Intrinio ID for the Fundamental
141
+ # @param id The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental
142
142
  # @param [Hash] opts the optional parameters
143
143
  # @return [Array<(ApiResponseStandardizedFinancials, Fixnum, Hash)>] ApiResponseStandardizedFinancials data, response status code and response headers
144
144
  def get_fundamental_standardized_financials_with_http_info(id, opts = {})
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
5
5
 
6
- OpenAPI spec version: 2.2.0
6
+ OpenAPI spec version: 2.5.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.0-SNAPSHOT
@@ -21,10 +21,11 @@ module Intrinio
21
21
  end
22
22
 
23
23
  # Historical Data
24
- # Returns historical values for the given `tag` and the entity represented by the given `identifier`
25
- # @param identifier An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
26
- # @param tag An Intrinio data tag ID or code-name
24
+ # $$v2_historical_data_description$$
25
+ # @param identifier $$v2_historical_data_identifier_description$$
26
+ # @param tag $$v2_historical_data_item_description$$
27
27
  # @param [Hash] opts the optional parameters
28
+ # @option opts [String] :frequency Return historical data in the given frequency (default to daily)
28
29
  # @option opts [String] :type Filter by type, when applicable
29
30
  # @option opts [Date] :start_date Get historical data on or after this date
30
31
  # @option opts [Date] :end_date Get historical date on or before this date
@@ -38,10 +39,11 @@ module Intrinio
38
39
  end
39
40
 
40
41
  # Historical Data
41
- # Returns historical values for the given &#x60;tag&#x60; and the entity represented by the given &#x60;identifier&#x60;
42
- # @param identifier An identifier for an entity such as a Company, Security, Index, etc (Ticker, FIGI, ISIN, CUSIP, CIK, LEI, Intrinio ID)
43
- # @param tag An Intrinio data tag ID or code-name
42
+ # $$v2_historical_data_description$$
43
+ # @param identifier $$v2_historical_data_identifier_description$$
44
+ # @param tag $$v2_historical_data_item_description$$
44
45
  # @param [Hash] opts the optional parameters
46
+ # @option opts [String] :frequency Return historical data in the given frequency
45
47
  # @option opts [String] :type Filter by type, when applicable
46
48
  # @option opts [Date] :start_date Get historical data on or after this date
47
49
  # @option opts [Date] :end_date Get historical date on or before this date
@@ -61,6 +63,9 @@ module Intrinio
61
63
  if @api_client.config.client_side_validation && tag.nil?
62
64
  fail ArgumentError, "Missing the required parameter 'tag' when calling HistoricalDataApi.get_historical_data"
63
65
  end
66
+ if @api_client.config.client_side_validation && opts[:'frequency'] && !['daily', 'weekly', 'monthly', 'quarterly', 'yearly'].include?(opts[:'frequency'])
67
+ fail ArgumentError, 'invalid value for "frequency", must be one of daily, weekly, monthly, quarterly, yearly'
68
+ end
64
69
  if @api_client.config.client_side_validation && opts[:'sort_order'] && !['asc', 'desc'].include?(opts[:'sort_order'])
65
70
  fail ArgumentError, 'invalid value for "sort_order", must be one of asc, desc'
66
71
  end
@@ -73,6 +78,7 @@ module Intrinio
73
78
 
74
79
  # query parameters
75
80
  query_params = {}
81
+ query_params[:'frequency'] = opts[:'frequency'] if !opts[:'frequency'].nil?
76
82
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
77
83
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
78
84
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
5
5
 
6
- OpenAPI spec version: 2.2.0
6
+ OpenAPI spec version: 2.5.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.0-SNAPSHOT
@@ -3,7 +3,7 @@
3
3
 
4
4
  #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
5
5
 
6
- OpenAPI spec version: 2.2.0
6
+ OpenAPI spec version: 2.5.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.3.0-SNAPSHOT
@@ -0,0 +1,325 @@
1
+ =begin
2
+ #Intrinio API
3
+
4
+ #Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
5
+
6
+ OpenAPI spec version: 2.5.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.3.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require "uri"
14
+
15
+ module Intrinio
16
+ class OptionsApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+
23
+ # Options
24
+ # Returns the master list of option contracts for a given symbol.
25
+ # @param symbol The option symbol, corresponding to the underlying security.
26
+ # @param [Hash] opts the optional parameters
27
+ # @option opts [String] :type The option contract type.
28
+ # @option opts [Float] :strike The strike price of the option contract. This will return options contracts with strike price equal to this price.
29
+ # @option opts [Float] :strike_greater_than The strike price of the option contract. This will return options contracts with strike prices greater than this price.
30
+ # @option opts [Float] :strike_less_than The strike price of the option contract. This will return options contracts with strike prices less than this price.
31
+ # @option opts [String] :expiration The expiration date of the option contract. This will return options contracts with expiration dates on this date.
32
+ # @option opts [String] :expiration_after The expiration date of the option contract. This will return options contracts with expiration dates after this date.
33
+ # @option opts [String] :expiration_before The expiration date of the option contract. This will return options contracts with expiration dates before this date.
34
+ # @option opts [Float] :page_size The number of results to return (default to 100)
35
+ # @option opts [String] :next_page Gets the next page of data from a previous API call
36
+ # @return [ApiResponseOptions]
37
+ def get_options(symbol, opts = {})
38
+ data, _status_code, _headers = get_options_with_http_info(symbol, opts)
39
+ return data
40
+ end
41
+
42
+ # Options
43
+ # Returns the master list of option contracts for a given symbol.
44
+ # @param symbol The option symbol, corresponding to the underlying security.
45
+ # @param [Hash] opts the optional parameters
46
+ # @option opts [String] :type The option contract type.
47
+ # @option opts [Float] :strike The strike price of the option contract. This will return options contracts with strike price equal to this price.
48
+ # @option opts [Float] :strike_greater_than The strike price of the option contract. This will return options contracts with strike prices greater than this price.
49
+ # @option opts [Float] :strike_less_than The strike price of the option contract. This will return options contracts with strike prices less than this price.
50
+ # @option opts [String] :expiration The expiration date of the option contract. This will return options contracts with expiration dates on this date.
51
+ # @option opts [String] :expiration_after The expiration date of the option contract. This will return options contracts with expiration dates after this date.
52
+ # @option opts [String] :expiration_before The expiration date of the option contract. This will return options contracts with expiration dates before this date.
53
+ # @option opts [Float] :page_size The number of results to return
54
+ # @option opts [String] :next_page Gets the next page of data from a previous API call
55
+ # @return [Array<(ApiResponseOptions, Fixnum, Hash)>] ApiResponseOptions data, response status code and response headers
56
+ def get_options_with_http_info(symbol, opts = {})
57
+ if @api_client.config.debugging
58
+ @api_client.config.logger.debug "Calling API: OptionsApi.get_options ..."
59
+ end
60
+ # verify the required parameter 'symbol' is set
61
+ if @api_client.config.client_side_validation && symbol.nil?
62
+ fail ArgumentError, "Missing the required parameter 'symbol' when calling OptionsApi.get_options"
63
+ end
64
+ if @api_client.config.client_side_validation && opts[:'type'] && !['call', 'put'].include?(opts[:'type'])
65
+ fail ArgumentError, 'invalid value for "type", must be one of call, put'
66
+ end
67
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
68
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling OptionsApi.get_options, must be smaller than or equal to 10000.'
69
+ end
70
+
71
+ # resource path
72
+ local_var_path = "/options/{symbol}".sub('{' + 'symbol' + '}', symbol.to_s)
73
+
74
+ # query parameters
75
+ query_params = {}
76
+ query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
77
+ query_params[:'strike'] = opts[:'strike'] if !opts[:'strike'].nil?
78
+ query_params[:'strike_greater_than'] = opts[:'strike_greater_than'] if !opts[:'strike_greater_than'].nil?
79
+ query_params[:'strike_less_than'] = opts[:'strike_less_than'] if !opts[:'strike_less_than'].nil?
80
+ query_params[:'expiration'] = opts[:'expiration'] if !opts[:'expiration'].nil?
81
+ query_params[:'expiration_after'] = opts[:'expiration_after'] if !opts[:'expiration_after'].nil?
82
+ query_params[:'expiration_before'] = opts[:'expiration_before'] if !opts[:'expiration_before'].nil?
83
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
84
+ query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
85
+
86
+ # header parameters
87
+ header_params = {}
88
+ # HTTP header 'Accept' (if needed)
89
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
90
+
91
+ # form parameters
92
+ form_params = {}
93
+
94
+ # http body (model)
95
+ post_body = nil
96
+ auth_names = ['ApiKeyAuth']
97
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
98
+ :header_params => header_params,
99
+ :query_params => query_params,
100
+ :form_params => form_params,
101
+ :body => post_body,
102
+ :auth_names => auth_names,
103
+ :return_type => 'ApiResponseOptions')
104
+ if @api_client.config.debugging
105
+ @api_client.config.logger.debug "API called: OptionsApi#get_options\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
106
+ end
107
+ return data, status_code, headers
108
+ end
109
+
110
+ # Options Chain
111
+ # Returns all options contracts and their prices for the given symbol and expiration date.
112
+ # @param symbol The option symbol, corresponding to the underlying security.
113
+ # @param expiration The expiration date of the options contract
114
+ # @param [Hash] opts the optional parameters
115
+ # @option opts [String] :type The option contract type.
116
+ # @option opts [Float] :strike The strike price of the option contract. This will return options contracts with strike price equal to this price.
117
+ # @option opts [Float] :strike_greater_than The strike price of the option contract. This will return options contracts with strike prices greater than this price.
118
+ # @option opts [Float] :strike_less_than The strike price of the option contract. This will return options contracts with strike prices less than this price.
119
+ # @option opts [String] :moneyness The moneyness of the options contracts to return. &#39;all&#39; will return all options contracts. &#39;in_the_money&#39; 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). &#39;out_of_they_money&#39; 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). &#39;near_the_money&#39; will return options contracts that are $0.50 or less away from being in the money.
120
+ # @option opts [Float] :page_size The number of results to return (default to 100)
121
+ # @return [ApiResponseOptionsChain]
122
+ def get_options_chain(symbol, expiration, opts = {})
123
+ data, _status_code, _headers = get_options_chain_with_http_info(symbol, expiration, opts)
124
+ return data
125
+ end
126
+
127
+ # Options Chain
128
+ # Returns all options contracts and their prices for the given symbol and expiration date.
129
+ # @param symbol The option symbol, corresponding to the underlying security.
130
+ # @param expiration The expiration date of the options contract
131
+ # @param [Hash] opts the optional parameters
132
+ # @option opts [String] :type The option contract type.
133
+ # @option opts [Float] :strike The strike price of the option contract. This will return options contracts with strike price equal to this price.
134
+ # @option opts [Float] :strike_greater_than The strike price of the option contract. This will return options contracts with strike prices greater than this price.
135
+ # @option opts [Float] :strike_less_than The strike price of the option contract. This will return options contracts with strike prices less than this price.
136
+ # @option opts [String] :moneyness The moneyness of the options contracts to return. &#39;all&#39; will return all options contracts. &#39;in_the_money&#39; 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). &#39;out_of_they_money&#39; 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). &#39;near_the_money&#39; will return options contracts that are $0.50 or less away from being in the money.
137
+ # @option opts [Float] :page_size The number of results to return
138
+ # @return [Array<(ApiResponseOptionsChain, Fixnum, Hash)>] ApiResponseOptionsChain data, response status code and response headers
139
+ def get_options_chain_with_http_info(symbol, expiration, opts = {})
140
+ if @api_client.config.debugging
141
+ @api_client.config.logger.debug "Calling API: OptionsApi.get_options_chain ..."
142
+ end
143
+ # verify the required parameter 'symbol' is set
144
+ if @api_client.config.client_side_validation && symbol.nil?
145
+ fail ArgumentError, "Missing the required parameter 'symbol' when calling OptionsApi.get_options_chain"
146
+ end
147
+ # verify the required parameter 'expiration' is set
148
+ if @api_client.config.client_side_validation && expiration.nil?
149
+ fail ArgumentError, "Missing the required parameter 'expiration' when calling OptionsApi.get_options_chain"
150
+ end
151
+ if @api_client.config.client_side_validation && opts[:'type'] && !['call', 'put'].include?(opts[:'type'])
152
+ fail ArgumentError, 'invalid value for "type", must be one of call, put'
153
+ end
154
+ if @api_client.config.client_side_validation && opts[:'moneyness'] && !['all', 'in_the_money', 'out_of_the_money', 'near_the_money'].include?(opts[:'moneyness'])
155
+ fail ArgumentError, 'invalid value for "moneyness", must be one of all, in_the_money, out_of_the_money, near_the_money'
156
+ end
157
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
158
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling OptionsApi.get_options_chain, must be smaller than or equal to 10000.'
159
+ end
160
+
161
+ # resource path
162
+ local_var_path = "/options/chain/{symbol}/{expiration}".sub('{' + 'symbol' + '}', symbol.to_s).sub('{' + 'expiration' + '}', expiration.to_s)
163
+
164
+ # query parameters
165
+ query_params = {}
166
+ query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
167
+ query_params[:'strike'] = opts[:'strike'] if !opts[:'strike'].nil?
168
+ query_params[:'strike_greater_than'] = opts[:'strike_greater_than'] if !opts[:'strike_greater_than'].nil?
169
+ query_params[:'strike_less_than'] = opts[:'strike_less_than'] if !opts[:'strike_less_than'].nil?
170
+ query_params[:'moneyness'] = opts[:'moneyness'] if !opts[:'moneyness'].nil?
171
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
172
+
173
+ # header parameters
174
+ header_params = {}
175
+ # HTTP header 'Accept' (if needed)
176
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
177
+
178
+ # form parameters
179
+ form_params = {}
180
+
181
+ # http body (model)
182
+ post_body = nil
183
+ auth_names = ['ApiKeyAuth']
184
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
185
+ :header_params => header_params,
186
+ :query_params => query_params,
187
+ :form_params => form_params,
188
+ :body => post_body,
189
+ :auth_names => auth_names,
190
+ :return_type => 'ApiResponseOptionsChain')
191
+ if @api_client.config.debugging
192
+ @api_client.config.logger.debug "API called: OptionsApi#get_options_chain\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
193
+ end
194
+ return data, status_code, headers
195
+ end
196
+
197
+ # Options Expirations
198
+ # Returns all option contract expiration dates for a given symbol.
199
+ # @param symbol The option symbol, corresponding to the underlying security.
200
+ # @param [Hash] opts the optional parameters
201
+ # @option opts [String] :after Return option contract expiration dates after this date.
202
+ # @option opts [String] :before Return option contract expiration dates before this date.
203
+ # @return [ApiResponseOptionsExpirations]
204
+ def get_options_expirations(symbol, opts = {})
205
+ data, _status_code, _headers = get_options_expirations_with_http_info(symbol, opts)
206
+ return data
207
+ end
208
+
209
+ # Options Expirations
210
+ # Returns all option contract expiration dates for a given symbol.
211
+ # @param symbol The option symbol, corresponding to the underlying security.
212
+ # @param [Hash] opts the optional parameters
213
+ # @option opts [String] :after Return option contract expiration dates after this date.
214
+ # @option opts [String] :before Return option contract expiration dates before this date.
215
+ # @return [Array<(ApiResponseOptionsExpirations, Fixnum, Hash)>] ApiResponseOptionsExpirations data, response status code and response headers
216
+ def get_options_expirations_with_http_info(symbol, opts = {})
217
+ if @api_client.config.debugging
218
+ @api_client.config.logger.debug "Calling API: OptionsApi.get_options_expirations ..."
219
+ end
220
+ # verify the required parameter 'symbol' is set
221
+ if @api_client.config.client_side_validation && symbol.nil?
222
+ fail ArgumentError, "Missing the required parameter 'symbol' when calling OptionsApi.get_options_expirations"
223
+ end
224
+ # resource path
225
+ local_var_path = "/options/expirations/{symbol}".sub('{' + 'symbol' + '}', symbol.to_s)
226
+
227
+ # query parameters
228
+ query_params = {}
229
+ query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
230
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
231
+
232
+ # header parameters
233
+ header_params = {}
234
+ # HTTP header 'Accept' (if needed)
235
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
236
+
237
+ # form parameters
238
+ form_params = {}
239
+
240
+ # http body (model)
241
+ post_body = nil
242
+ auth_names = ['ApiKeyAuth']
243
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
244
+ :header_params => header_params,
245
+ :query_params => query_params,
246
+ :form_params => form_params,
247
+ :body => post_body,
248
+ :auth_names => auth_names,
249
+ :return_type => 'ApiResponseOptionsExpirations')
250
+ if @api_client.config.debugging
251
+ @api_client.config.logger.debug "API called: OptionsApi#get_options_expirations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
252
+ end
253
+ return data, status_code, headers
254
+ end
255
+
256
+ # Option Prices
257
+ # Returns all option prices for a given option contract identifier.
258
+ # @param identifier The Intrinio ID or code of the options contract to request prices for.
259
+ # @param [Hash] opts the optional parameters
260
+ # @option opts [String] :start_date Return option contract prices on or after this date.
261
+ # @option opts [String] :end_date Return option contract prices on or before this date.
262
+ # @option opts [Float] :page_size The number of results to return (default to 100)
263
+ # @option opts [String] :next_page Gets the next page of data from a previous API call
264
+ # @return [ApiResponseOptionPrices]
265
+ def get_options_prices(identifier, opts = {})
266
+ data, _status_code, _headers = get_options_prices_with_http_info(identifier, opts)
267
+ return data
268
+ end
269
+
270
+ # Option Prices
271
+ # Returns all option prices for a given option contract identifier.
272
+ # @param identifier The Intrinio ID or code of the options contract to request prices for.
273
+ # @param [Hash] opts the optional parameters
274
+ # @option opts [String] :start_date Return option contract prices on or after this date.
275
+ # @option opts [String] :end_date Return option contract prices on or before this date.
276
+ # @option opts [Float] :page_size The number of results to return
277
+ # @option opts [String] :next_page Gets the next page of data from a previous API call
278
+ # @return [Array<(ApiResponseOptionPrices, Fixnum, Hash)>] ApiResponseOptionPrices data, response status code and response headers
279
+ def get_options_prices_with_http_info(identifier, opts = {})
280
+ if @api_client.config.debugging
281
+ @api_client.config.logger.debug "Calling API: OptionsApi.get_options_prices ..."
282
+ end
283
+ # verify the required parameter 'identifier' is set
284
+ if @api_client.config.client_side_validation && identifier.nil?
285
+ fail ArgumentError, "Missing the required parameter 'identifier' when calling OptionsApi.get_options_prices"
286
+ end
287
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
288
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling OptionsApi.get_options_prices, must be smaller than or equal to 10000.'
289
+ end
290
+
291
+ # resource path
292
+ local_var_path = "/options/prices/{identifier}".sub('{' + 'identifier' + '}', identifier.to_s)
293
+
294
+ # query parameters
295
+ query_params = {}
296
+ query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
297
+ query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
298
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
299
+ query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
300
+
301
+ # header parameters
302
+ header_params = {}
303
+ # HTTP header 'Accept' (if needed)
304
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
305
+
306
+ # form parameters
307
+ form_params = {}
308
+
309
+ # http body (model)
310
+ post_body = nil
311
+ auth_names = ['ApiKeyAuth']
312
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
313
+ :header_params => header_params,
314
+ :query_params => query_params,
315
+ :form_params => form_params,
316
+ :body => post_body,
317
+ :auth_names => auth_names,
318
+ :return_type => 'ApiResponseOptionPrices')
319
+ if @api_client.config.debugging
320
+ @api_client.config.logger.debug "API called: OptionsApi#get_options_prices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
321
+ end
322
+ return data, status_code, headers
323
+ end
324
+ end
325
+ end