intrinio-sdk 5.6.1 → 5.9.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (540) hide show
  1. checksums.yaml +5 -5
  2. data/Gemfile +2 -0
  3. data/README.md +51 -12
  4. data/docs/ApiResponseCompanyInsiderTransactionFilings.md +28 -0
  5. data/docs/ApiResponseInsiderTransactionFilings.md +32 -0
  6. data/docs/ApiResponseOptionsChainRealtime.md +23 -0
  7. data/docs/ApiResponseOptionsPriceRealtime.md +31 -0
  8. data/docs/ApiResponseOptionsStatsRealtime.md +31 -0
  9. data/docs/ApiResponseOwnerInsiderTransactionFilings.md +28 -0
  10. data/docs/ApiResponseOwnerInstitutionalHoldings.md +21 -0
  11. data/docs/ApiResponseOwners.md +24 -0
  12. data/docs/ApiResponseSecurityInstitutionalOwnership.md +24 -0
  13. data/docs/ApiResponseSecurityIntervalPrices.md +29 -0
  14. data/docs/BulkDownloadsApi.md +3 -7
  15. data/docs/CompanyApi.md +296 -171
  16. data/docs/DataPointApi.md +10 -22
  17. data/docs/DataTagApi.md +21 -33
  18. data/docs/ETFsApi.md +30 -57
  19. data/docs/FilingApi.md +72 -116
  20. data/docs/ForexApi.md +22 -35
  21. data/docs/FundamentalsApi.md +19 -42
  22. data/docs/HistoricalDataApi.md +14 -19
  23. data/docs/IndexApi.md +117 -204
  24. data/docs/InsiderTransaction.md +44 -0
  25. data/docs/InsiderTransactionFiling.md +32 -0
  26. data/docs/InsiderTransactionFilingsApi.md +95 -0
  27. data/docs/InstitutionalHolding.md +34 -0
  28. data/docs/InstitutionalOwnership.md +29 -0
  29. data/docs/MunicipalityApi.md +28 -39
  30. data/docs/OptionChainRealtime.md +31 -0
  31. data/docs/OptionFactorsRealtime.md +25 -0
  32. data/docs/OptionPriceRealtime.md +31 -0
  33. data/docs/OptionRealtime.md +24 -0
  34. data/docs/OptionStatsRealtime.md +24 -0
  35. data/docs/OptionsApi.md +314 -62
  36. data/docs/Owner.md +32 -0
  37. data/docs/OwnerSummary.md +21 -0
  38. data/docs/OwnersApi.md +434 -0
  39. data/docs/RealtimeStockPrice.md +2 -0
  40. data/docs/SecurityApi.md +715 -721
  41. data/docs/SecuritySummary.md +1 -0
  42. data/docs/StockExchangeApi.md +43 -67
  43. data/docs/StockPrice.md +7 -0
  44. data/docs/StockPriceInterval.md +25 -0
  45. data/docs/TechnicalApi.md +359 -483
  46. data/docs/ZacksApi.md +132 -165
  47. data/intrinio-sdk.gemspec +3 -2
  48. data/lib/intrinio-sdk.rb +25 -1
  49. data/lib/intrinio-sdk/api/bulk_downloads_api.rb +1 -1
  50. data/lib/intrinio-sdk/api/company_api.rb +148 -1
  51. data/lib/intrinio-sdk/api/data_point_api.rb +1 -1
  52. data/lib/intrinio-sdk/api/data_tag_api.rb +1 -1
  53. data/lib/intrinio-sdk/api/et_fs_api.rb +1 -1
  54. data/lib/intrinio-sdk/api/filing_api.rb +1 -1
  55. data/lib/intrinio-sdk/api/forex_api.rb +5 -5
  56. data/lib/intrinio-sdk/api/fundamentals_api.rb +1 -1
  57. data/lib/intrinio-sdk/api/historical_data_api.rb +1 -1
  58. data/lib/intrinio-sdk/api/index_api.rb +1 -1
  59. data/lib/intrinio-sdk/api/insider_transaction_filings_api.rb +86 -0
  60. data/lib/intrinio-sdk/api/municipality_api.rb +3 -3
  61. data/lib/intrinio-sdk/api/options_api.rb +217 -1
  62. data/lib/intrinio-sdk/api/owners_api.rb +338 -0
  63. data/lib/intrinio-sdk/api/security_api.rb +157 -15
  64. data/lib/intrinio-sdk/api/stock_exchange_api.rb +3 -3
  65. data/lib/intrinio-sdk/api/technical_api.rb +1 -1
  66. data/lib/intrinio-sdk/api/zacks_api.rb +1 -1
  67. data/lib/intrinio-sdk/api_client.rb +56 -24
  68. data/lib/intrinio-sdk/api_error.rb +1 -1
  69. data/lib/intrinio-sdk/configuration.rb +4 -1
  70. data/lib/intrinio-sdk/models/accumulation_distribution_index_technical_value.rb +1 -1
  71. data/lib/intrinio-sdk/models/api_response_bulk_download_links.rb +1 -1
  72. data/lib/intrinio-sdk/models/api_response_companies.rb +1 -1
  73. data/lib/intrinio-sdk/models/api_response_companies_search.rb +1 -1
  74. data/lib/intrinio-sdk/models/api_response_company_filings.rb +1 -1
  75. data/lib/intrinio-sdk/models/api_response_company_fundamentals.rb +1 -1
  76. data/lib/intrinio-sdk/models/api_response_company_historical_data.rb +1 -1
  77. data/lib/intrinio-sdk/models/api_response_company_insider_transaction_filings.rb +210 -0
  78. data/lib/intrinio-sdk/models/api_response_company_news.rb +1 -1
  79. data/lib/intrinio-sdk/models/api_response_company_securities.rb +1 -1
  80. data/lib/intrinio-sdk/models/api_response_data_tags.rb +1 -1
  81. data/lib/intrinio-sdk/models/api_response_data_tags_search.rb +1 -1
  82. data/lib/intrinio-sdk/models/api_response_economic_index_historical_data.rb +1 -1
  83. data/lib/intrinio-sdk/models/api_response_economic_indices.rb +1 -1
  84. data/lib/intrinio-sdk/models/api_response_economic_indices_search.rb +1 -1
  85. data/lib/intrinio-sdk/models/api_response_et_fs.rb +1 -1
  86. data/lib/intrinio-sdk/models/api_response_etf_holdings.rb +1 -1
  87. data/lib/intrinio-sdk/models/api_response_filing_fundamentals.rb +1 -1
  88. data/lib/intrinio-sdk/models/api_response_filing_notes.rb +1 -1
  89. data/lib/intrinio-sdk/models/api_response_filing_notes_search.rb +1 -1
  90. data/lib/intrinio-sdk/models/api_response_filings.rb +1 -1
  91. data/lib/intrinio-sdk/models/api_response_forex_currencies.rb +1 -1
  92. data/lib/intrinio-sdk/models/api_response_forex_pairs.rb +1 -1
  93. data/lib/intrinio-sdk/models/api_response_forex_prices.rb +1 -1
  94. data/lib/intrinio-sdk/models/api_response_historical_data.rb +1 -1
  95. data/lib/intrinio-sdk/models/api_response_initial_public_offerings.rb +1 -1
  96. data/lib/intrinio-sdk/models/api_response_insider_transaction_filings.rb +220 -0
  97. data/lib/intrinio-sdk/models/api_response_municipalities.rb +1 -1
  98. data/lib/intrinio-sdk/models/api_response_municipalitiy_financials.rb +1 -1
  99. data/lib/intrinio-sdk/models/api_response_news.rb +1 -1
  100. data/lib/intrinio-sdk/models/api_response_option_prices.rb +1 -1
  101. data/lib/intrinio-sdk/models/api_response_options.rb +1 -1
  102. data/lib/intrinio-sdk/models/api_response_options_chain.rb +1 -1
  103. data/lib/intrinio-sdk/models/api_response_options_chain_realtime.rb +191 -0
  104. data/lib/intrinio-sdk/models/api_response_options_expirations.rb +1 -1
  105. data/lib/intrinio-sdk/models/api_response_options_price_realtime.rb +206 -0
  106. data/lib/intrinio-sdk/models/api_response_options_stats_realtime.rb +206 -0
  107. data/lib/intrinio-sdk/models/api_response_owner_insider_transaction_filings.rb +210 -0
  108. data/lib/intrinio-sdk/models/api_response_owner_institutional_holdings.rb +198 -0
  109. data/lib/intrinio-sdk/models/api_response_owners.rb +201 -0
  110. data/lib/intrinio-sdk/models/api_response_reported_financials.rb +1 -1
  111. data/lib/intrinio-sdk/models/api_response_securities.rb +1 -1
  112. data/lib/intrinio-sdk/models/api_response_securities_search.rb +1 -1
  113. data/lib/intrinio-sdk/models/api_response_security_accumulation_distribution_index.rb +1 -1
  114. data/lib/intrinio-sdk/models/api_response_security_average_daily_trading_volume.rb +1 -1
  115. data/lib/intrinio-sdk/models/api_response_security_average_directional_index.rb +1 -1
  116. data/lib/intrinio-sdk/models/api_response_security_average_true_range.rb +1 -1
  117. data/lib/intrinio-sdk/models/api_response_security_awesome_oscillator.rb +1 -1
  118. data/lib/intrinio-sdk/models/api_response_security_bollinger_bands.rb +1 -1
  119. data/lib/intrinio-sdk/models/api_response_security_chaikin_money_flow.rb +1 -1
  120. data/lib/intrinio-sdk/models/api_response_security_commodity_channel_index.rb +1 -1
  121. data/lib/intrinio-sdk/models/api_response_security_detrended_price_oscillator.rb +1 -1
  122. data/lib/intrinio-sdk/models/api_response_security_donchian_channel.rb +1 -1
  123. data/lib/intrinio-sdk/models/api_response_security_ease_of_movement.rb +1 -1
  124. data/lib/intrinio-sdk/models/api_response_security_force_index.rb +1 -1
  125. data/lib/intrinio-sdk/models/api_response_security_historical_data.rb +1 -1
  126. data/lib/intrinio-sdk/models/api_response_security_ichimoku_kinko_hyo.rb +1 -1
  127. data/lib/intrinio-sdk/models/api_response_security_institutional_ownership.rb +200 -0
  128. data/lib/intrinio-sdk/models/api_response_security_interval_prices.rb +254 -0
  129. data/lib/intrinio-sdk/models/api_response_security_intraday_prices.rb +1 -1
  130. data/lib/intrinio-sdk/models/api_response_security_keltner_channel.rb +1 -1
  131. data/lib/intrinio-sdk/models/api_response_security_know_sure_thing.rb +1 -1
  132. data/lib/intrinio-sdk/models/api_response_security_mass_index.rb +1 -1
  133. data/lib/intrinio-sdk/models/api_response_security_money_flow_index.rb +1 -1
  134. data/lib/intrinio-sdk/models/api_response_security_moving_average_convergence_divergence.rb +1 -1
  135. data/lib/intrinio-sdk/models/api_response_security_negative_volume_index.rb +1 -1
  136. data/lib/intrinio-sdk/models/api_response_security_on_balance_volume.rb +1 -1
  137. data/lib/intrinio-sdk/models/api_response_security_on_balance_volume_mean.rb +1 -1
  138. data/lib/intrinio-sdk/models/api_response_security_relative_strength_index.rb +1 -1
  139. data/lib/intrinio-sdk/models/api_response_security_simple_moving_average.rb +1 -1
  140. data/lib/intrinio-sdk/models/api_response_security_stochastic_oscillator.rb +1 -1
  141. data/lib/intrinio-sdk/models/api_response_security_stock_price_adjustments.rb +1 -1
  142. data/lib/intrinio-sdk/models/api_response_security_stock_prices.rb +1 -1
  143. data/lib/intrinio-sdk/models/api_response_security_triple_exponential_average.rb +1 -1
  144. data/lib/intrinio-sdk/models/api_response_security_true_strength_index.rb +1 -1
  145. data/lib/intrinio-sdk/models/api_response_security_ultimate_oscillator.rb +1 -1
  146. data/lib/intrinio-sdk/models/api_response_security_volume_price_trend.rb +1 -1
  147. data/lib/intrinio-sdk/models/api_response_security_volume_weighted_average_price.rb +1 -1
  148. data/lib/intrinio-sdk/models/api_response_security_vortex_indicator.rb +1 -1
  149. data/lib/intrinio-sdk/models/api_response_security_williams_r.rb +1 -1
  150. data/lib/intrinio-sdk/models/api_response_security_zacks_analyst_ratings.rb +1 -1
  151. data/lib/intrinio-sdk/models/api_response_security_zacks_analyst_ratings_snapshot.rb +1 -1
  152. data/lib/intrinio-sdk/models/api_response_security_zacks_eps_surprises.rb +1 -1
  153. data/lib/intrinio-sdk/models/api_response_security_zacks_sales_surprises.rb +1 -1
  154. data/lib/intrinio-sdk/models/api_response_sic_index_historical_data.rb +1 -1
  155. data/lib/intrinio-sdk/models/api_response_sic_indices.rb +1 -1
  156. data/lib/intrinio-sdk/models/api_response_sic_indices_search.rb +1 -1
  157. data/lib/intrinio-sdk/models/api_response_standardized_financials.rb +1 -1
  158. data/lib/intrinio-sdk/models/api_response_stock_exchange_realtime_stock_prices.rb +1 -1
  159. data/lib/intrinio-sdk/models/api_response_stock_exchange_securities.rb +1 -1
  160. data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_price_adjustments.rb +1 -1
  161. data/lib/intrinio-sdk/models/api_response_stock_exchange_stock_prices.rb +1 -1
  162. data/lib/intrinio-sdk/models/api_response_stock_exchanges.rb +1 -1
  163. data/lib/intrinio-sdk/models/api_response_stock_market_index_historical_data.rb +1 -1
  164. data/lib/intrinio-sdk/models/api_response_stock_market_indices.rb +1 -1
  165. data/lib/intrinio-sdk/models/api_response_stock_market_indices_search.rb +1 -1
  166. data/lib/intrinio-sdk/models/api_response_zacks_analyst_ratings.rb +1 -1
  167. data/lib/intrinio-sdk/models/api_response_zacks_eps_estimates.rb +1 -1
  168. data/lib/intrinio-sdk/models/api_response_zacks_eps_growth_rates.rb +1 -1
  169. data/lib/intrinio-sdk/models/api_response_zacks_eps_surprises.rb +1 -1
  170. data/lib/intrinio-sdk/models/api_response_zacks_etf_holdings.rb +1 -1
  171. data/lib/intrinio-sdk/models/api_response_zacks_institutional_holding_companies.rb +1 -1
  172. data/lib/intrinio-sdk/models/api_response_zacks_institutional_holding_owners.rb +1 -1
  173. data/lib/intrinio-sdk/models/api_response_zacks_institutional_holdings.rb +1 -1
  174. data/lib/intrinio-sdk/models/api_response_zacks_long_term_growth_rates.rb +1 -1
  175. data/lib/intrinio-sdk/models/api_response_zacks_sales_surprises.rb +1 -1
  176. data/lib/intrinio-sdk/models/api_response_zacks_target_price_consensuses.rb +1 -1
  177. data/lib/intrinio-sdk/models/average_daily_trading_volume_technical_value.rb +1 -1
  178. data/lib/intrinio-sdk/models/average_directional_index_technical_value.rb +1 -1
  179. data/lib/intrinio-sdk/models/average_true_range_technical_value.rb +1 -1
  180. data/lib/intrinio-sdk/models/awesome_oscillator_technical_value.rb +1 -1
  181. data/lib/intrinio-sdk/models/bollinger_bands_technical_value.rb +1 -1
  182. data/lib/intrinio-sdk/models/bulk_download_links.rb +1 -1
  183. data/lib/intrinio-sdk/models/bulk_download_summary.rb +1 -1
  184. data/lib/intrinio-sdk/models/chaikin_money_flow_technical_value.rb +1 -1
  185. data/lib/intrinio-sdk/models/commodity_channel_index_technical_value.rb +1 -1
  186. data/lib/intrinio-sdk/models/company.rb +1 -1
  187. data/lib/intrinio-sdk/models/company_filing.rb +1 -1
  188. data/lib/intrinio-sdk/models/company_initial_public_offering.rb +1 -1
  189. data/lib/intrinio-sdk/models/company_news.rb +1 -1
  190. data/lib/intrinio-sdk/models/company_news_summary.rb +1 -1
  191. data/lib/intrinio-sdk/models/company_summary.rb +1 -1
  192. data/lib/intrinio-sdk/models/data_tag.rb +1 -1
  193. data/lib/intrinio-sdk/models/data_tag_summary.rb +1 -1
  194. data/lib/intrinio-sdk/models/detrended_price_oscillator_technical_value.rb +1 -1
  195. data/lib/intrinio-sdk/models/dividend_record.rb +1 -1
  196. data/lib/intrinio-sdk/models/donchian_channel_technical_value.rb +1 -1
  197. data/lib/intrinio-sdk/models/earnings_record.rb +1 -1
  198. data/lib/intrinio-sdk/models/ease_of_movement_technical_value.rb +1 -1
  199. data/lib/intrinio-sdk/models/economic_index.rb +1 -1
  200. data/lib/intrinio-sdk/models/economic_index_summary.rb +1 -1
  201. data/lib/intrinio-sdk/models/etf.rb +1 -1
  202. data/lib/intrinio-sdk/models/etf_analytics.rb +1 -1
  203. data/lib/intrinio-sdk/models/etf_holding.rb +1 -1
  204. data/lib/intrinio-sdk/models/etf_stats.rb +1 -1
  205. data/lib/intrinio-sdk/models/etf_summary.rb +1 -1
  206. data/lib/intrinio-sdk/models/filing.rb +1 -1
  207. data/lib/intrinio-sdk/models/filing_note.rb +1 -1
  208. data/lib/intrinio-sdk/models/filing_note_filing.rb +1 -1
  209. data/lib/intrinio-sdk/models/filing_note_summary.rb +1 -1
  210. data/lib/intrinio-sdk/models/filing_summary.rb +1 -1
  211. data/lib/intrinio-sdk/models/force_index_technical_value.rb +1 -1
  212. data/lib/intrinio-sdk/models/forex_currency.rb +1 -1
  213. data/lib/intrinio-sdk/models/forex_pair.rb +1 -1
  214. data/lib/intrinio-sdk/models/forex_price.rb +1 -1
  215. data/lib/intrinio-sdk/models/fundamental.rb +1 -1
  216. data/lib/intrinio-sdk/models/fundamental_summary.rb +1 -1
  217. data/lib/intrinio-sdk/models/historical_data.rb +1 -1
  218. data/lib/intrinio-sdk/models/ichimoku_kinko_hyo_technical_value.rb +1 -1
  219. data/lib/intrinio-sdk/models/insider_transaction.rb +369 -0
  220. data/lib/intrinio-sdk/models/insider_transaction_filing.rb +221 -0
  221. data/lib/intrinio-sdk/models/institutional_holding.rb +329 -0
  222. data/lib/intrinio-sdk/models/institutional_ownership.rb +279 -0
  223. data/lib/intrinio-sdk/models/intraday_stock_price.rb +1 -1
  224. data/lib/intrinio-sdk/models/keltner_channel_technical_value.rb +1 -1
  225. data/lib/intrinio-sdk/models/know_sure_thing_technical_value.rb +1 -1
  226. data/lib/intrinio-sdk/models/mass_index_technical_value.rb +1 -1
  227. data/lib/intrinio-sdk/models/money_flow_index_technical_value.rb +1 -1
  228. data/lib/intrinio-sdk/models/moving_average_convergence_divergence_technical_value.rb +1 -1
  229. data/lib/intrinio-sdk/models/municipality.rb +1 -1
  230. data/lib/intrinio-sdk/models/municipality_financial.rb +1 -1
  231. data/lib/intrinio-sdk/models/negative_volume_index_technical_value.rb +1 -1
  232. data/lib/intrinio-sdk/models/on_balance_volume_mean_technical_value.rb +1 -1
  233. data/lib/intrinio-sdk/models/on_balance_volume_technical_value.rb +1 -1
  234. data/lib/intrinio-sdk/models/option.rb +1 -1
  235. data/lib/intrinio-sdk/models/option_chain.rb +1 -1
  236. data/lib/intrinio-sdk/models/option_chain_realtime.rb +206 -0
  237. data/lib/intrinio-sdk/models/option_factors_realtime.rb +239 -0
  238. data/lib/intrinio-sdk/models/option_price.rb +1 -1
  239. data/lib/intrinio-sdk/models/option_price_realtime.rb +332 -0
  240. data/lib/intrinio-sdk/models/option_realtime.rb +262 -0
  241. data/lib/intrinio-sdk/models/option_stats_realtime.rb +229 -0
  242. data/lib/intrinio-sdk/models/owner.rb +309 -0
  243. data/lib/intrinio-sdk/models/owner_summary.rb +199 -0
  244. data/lib/intrinio-sdk/models/realtime_stock_price.rb +22 -2
  245. data/lib/intrinio-sdk/models/realtime_stock_price_security.rb +1 -1
  246. data/lib/intrinio-sdk/models/relative_strength_index_technical_value.rb +1 -1
  247. data/lib/intrinio-sdk/models/reported_financial.rb +1 -1
  248. data/lib/intrinio-sdk/models/reported_financial_dimension.rb +1 -1
  249. data/lib/intrinio-sdk/models/reported_tag.rb +1 -1
  250. data/lib/intrinio-sdk/models/security.rb +1 -1
  251. data/lib/intrinio-sdk/models/security_screen_clause.rb +1 -1
  252. data/lib/intrinio-sdk/models/security_screen_group.rb +1 -1
  253. data/lib/intrinio-sdk/models/security_screen_result.rb +1 -1
  254. data/lib/intrinio-sdk/models/security_screen_result_data.rb +1 -1
  255. data/lib/intrinio-sdk/models/security_summary.rb +15 -5
  256. data/lib/intrinio-sdk/models/sic_index.rb +1 -1
  257. data/lib/intrinio-sdk/models/simple_moving_average_technical_value.rb +1 -1
  258. data/lib/intrinio-sdk/models/standardized_financial.rb +1 -1
  259. data/lib/intrinio-sdk/models/stochastic_oscillator_technical_value.rb +1 -1
  260. data/lib/intrinio-sdk/models/stock_exchange.rb +1 -1
  261. data/lib/intrinio-sdk/models/stock_market_index.rb +1 -1
  262. data/lib/intrinio-sdk/models/stock_market_index_summary.rb +1 -1
  263. data/lib/intrinio-sdk/models/stock_price.rb +72 -2
  264. data/lib/intrinio-sdk/models/stock_price_adjustment.rb +1 -1
  265. data/lib/intrinio-sdk/models/stock_price_adjustment_summary.rb +1 -1
  266. data/lib/intrinio-sdk/models/stock_price_interval.rb +239 -0
  267. data/lib/intrinio-sdk/models/stock_price_summary.rb +1 -1
  268. data/lib/intrinio-sdk/models/technical_indicator.rb +1 -1
  269. data/lib/intrinio-sdk/models/triple_exponential_average_technical_value.rb +1 -1
  270. data/lib/intrinio-sdk/models/true_strength_index_technical_value.rb +1 -1
  271. data/lib/intrinio-sdk/models/ultimate_oscillator_technical_value.rb +1 -1
  272. data/lib/intrinio-sdk/models/volume_price_trend_technical_value.rb +1 -1
  273. data/lib/intrinio-sdk/models/volume_weighted_average_price_value.rb +1 -1
  274. data/lib/intrinio-sdk/models/vortex_indicator_technical_value.rb +1 -1
  275. data/lib/intrinio-sdk/models/williams_r_technical_value.rb +1 -1
  276. data/lib/intrinio-sdk/models/zacks_analyst_rating.rb +1 -1
  277. data/lib/intrinio-sdk/models/zacks_analyst_rating_snapshot.rb +1 -1
  278. data/lib/intrinio-sdk/models/zacks_analyst_rating_summary.rb +1 -1
  279. data/lib/intrinio-sdk/models/zacks_eps_estimate.rb +1 -1
  280. data/lib/intrinio-sdk/models/zacks_eps_growth_rate.rb +1 -1
  281. data/lib/intrinio-sdk/models/zacks_eps_surprise.rb +1 -1
  282. data/lib/intrinio-sdk/models/zacks_eps_surprise_summary.rb +1 -1
  283. data/lib/intrinio-sdk/models/zacks_etf_holding.rb +1 -1
  284. data/lib/intrinio-sdk/models/zacks_institutional_holding.rb +1 -1
  285. data/lib/intrinio-sdk/models/zacks_institutional_holding_company_detail.rb +1 -1
  286. data/lib/intrinio-sdk/models/zacks_institutional_holding_company_summary.rb +1 -1
  287. data/lib/intrinio-sdk/models/zacks_institutional_holding_historical_summary.rb +1 -1
  288. data/lib/intrinio-sdk/models/zacks_institutional_holding_owner_detail.rb +1 -1
  289. data/lib/intrinio-sdk/models/zacks_institutional_holding_owner_summary.rb +1 -1
  290. data/lib/intrinio-sdk/models/zacks_long_term_growth_rate.rb +1 -1
  291. data/lib/intrinio-sdk/models/zacks_sales_surprise.rb +1 -1
  292. data/lib/intrinio-sdk/models/zacks_sales_surprise_summary.rb +1 -1
  293. data/lib/intrinio-sdk/models/zacks_target_price_consensus.rb +1 -1
  294. data/lib/intrinio-sdk/version.rb +2 -2
  295. data/spec/api/bulk_downloads_api_spec.rb +1 -1
  296. data/spec/api/company_api_spec.rb +36 -1
  297. data/spec/api/data_point_api_spec.rb +1 -1
  298. data/spec/api/data_tag_api_spec.rb +1 -1
  299. data/spec/api/et_fs_api_spec.rb +1 -1
  300. data/spec/api/filing_api_spec.rb +1 -1
  301. data/spec/api/forex_api_spec.rb +3 -3
  302. data/spec/api/fundamentals_api_spec.rb +1 -1
  303. data/spec/api/historical_data_api_spec.rb +1 -1
  304. data/spec/api/index_api_spec.rb +1 -1
  305. data/spec/api/insider_transaction_filings_api_spec.rb +50 -0
  306. data/spec/api/municipality_api_spec.rb +2 -2
  307. data/spec/api/options_api_spec.rb +50 -1
  308. data/spec/api/owners_api_spec.rb +107 -0
  309. data/spec/api/security_api_spec.rb +41 -7
  310. data/spec/api/stock_exchange_api_spec.rb +1 -1
  311. data/spec/api/technical_api_spec.rb +1 -1
  312. data/spec/api/zacks_api_spec.rb +1 -1
  313. data/spec/api_client_spec.rb +1 -1
  314. data/spec/configuration_spec.rb +1 -1
  315. data/spec/models/accumulation_distribution_index_technical_value_spec.rb +1 -1
  316. data/spec/models/api_response_bulk_download_links_spec.rb +1 -1
  317. data/spec/models/api_response_companies_search_spec.rb +1 -1
  318. data/spec/models/api_response_companies_spec.rb +1 -1
  319. data/spec/models/api_response_company_filings_spec.rb +1 -1
  320. data/spec/models/api_response_company_fundamentals_spec.rb +1 -1
  321. data/spec/models/api_response_company_historical_data_spec.rb +1 -1
  322. data/spec/models/api_response_company_insider_transaction_filings_spec.rb +54 -0
  323. data/spec/models/api_response_company_news_spec.rb +1 -1
  324. data/spec/models/api_response_company_securities_spec.rb +1 -1
  325. data/spec/models/api_response_data_tags_search_spec.rb +1 -1
  326. data/spec/models/api_response_data_tags_spec.rb +1 -1
  327. data/spec/models/api_response_economic_index_historical_data_spec.rb +1 -1
  328. data/spec/models/api_response_economic_indices_search_spec.rb +1 -1
  329. data/spec/models/api_response_economic_indices_spec.rb +1 -1
  330. data/spec/models/api_response_et_fs_spec.rb +1 -1
  331. data/spec/models/api_response_etf_holdings_spec.rb +1 -1
  332. data/spec/models/api_response_filing_fundamentals_spec.rb +1 -1
  333. data/spec/models/api_response_filing_notes_search_spec.rb +1 -1
  334. data/spec/models/api_response_filing_notes_spec.rb +1 -1
  335. data/spec/models/api_response_filings_spec.rb +1 -1
  336. data/spec/models/api_response_forex_currencies_spec.rb +1 -1
  337. data/spec/models/api_response_forex_pairs_spec.rb +1 -1
  338. data/spec/models/api_response_forex_prices_spec.rb +1 -1
  339. data/spec/models/api_response_historical_data_spec.rb +1 -1
  340. data/spec/models/api_response_initial_public_offerings_spec.rb +1 -1
  341. data/spec/models/api_response_insider_transaction_filings_spec.rb +60 -0
  342. data/spec/models/api_response_municipalities_spec.rb +1 -1
  343. data/spec/models/api_response_municipalitiy_financials_spec.rb +1 -1
  344. data/spec/models/api_response_news_spec.rb +1 -1
  345. data/spec/models/api_response_option_prices_spec.rb +1 -1
  346. data/spec/models/api_response_options_chain_realtime_spec.rb +42 -0
  347. data/spec/models/api_response_options_chain_spec.rb +1 -1
  348. data/spec/models/api_response_options_expirations_spec.rb +1 -1
  349. data/spec/models/api_response_options_price_realtime_spec.rb +54 -0
  350. data/spec/models/api_response_options_spec.rb +1 -1
  351. data/spec/models/api_response_options_stats_realtime_spec.rb +54 -0
  352. data/spec/models/api_response_owner_insider_transaction_filings_spec.rb +54 -0
  353. data/spec/models/api_response_owner_institutional_holdings_spec.rb +48 -0
  354. data/spec/models/api_response_owners_spec.rb +48 -0
  355. data/spec/models/api_response_reported_financials_spec.rb +1 -1
  356. data/spec/models/api_response_securities_search_spec.rb +1 -1
  357. data/spec/models/api_response_securities_spec.rb +1 -1
  358. data/spec/models/api_response_security_accumulation_distribution_index_spec.rb +1 -1
  359. data/spec/models/api_response_security_average_daily_trading_volume_spec.rb +1 -1
  360. data/spec/models/api_response_security_average_directional_index_spec.rb +1 -1
  361. data/spec/models/api_response_security_average_true_range_spec.rb +1 -1
  362. data/spec/models/api_response_security_awesome_oscillator_spec.rb +1 -1
  363. data/spec/models/api_response_security_bollinger_bands_spec.rb +1 -1
  364. data/spec/models/api_response_security_chaikin_money_flow_spec.rb +1 -1
  365. data/spec/models/api_response_security_commodity_channel_index_spec.rb +1 -1
  366. data/spec/models/api_response_security_detrended_price_oscillator_spec.rb +1 -1
  367. data/spec/models/api_response_security_donchian_channel_spec.rb +1 -1
  368. data/spec/models/api_response_security_ease_of_movement_spec.rb +1 -1
  369. data/spec/models/api_response_security_force_index_spec.rb +1 -1
  370. data/spec/models/api_response_security_historical_data_spec.rb +1 -1
  371. data/spec/models/api_response_security_ichimoku_kinko_hyo_spec.rb +1 -1
  372. data/spec/models/api_response_security_institutional_ownership_spec.rb +48 -0
  373. data/spec/models/api_response_security_interval_prices_spec.rb +64 -0
  374. data/spec/models/api_response_security_intraday_prices_spec.rb +1 -1
  375. data/spec/models/api_response_security_keltner_channel_spec.rb +1 -1
  376. data/spec/models/api_response_security_know_sure_thing_spec.rb +1 -1
  377. data/spec/models/api_response_security_mass_index_spec.rb +1 -1
  378. data/spec/models/api_response_security_money_flow_index_spec.rb +1 -1
  379. data/spec/models/api_response_security_moving_average_convergence_divergence_spec.rb +1 -1
  380. data/spec/models/api_response_security_negative_volume_index_spec.rb +1 -1
  381. data/spec/models/api_response_security_on_balance_volume_mean_spec.rb +1 -1
  382. data/spec/models/api_response_security_on_balance_volume_spec.rb +1 -1
  383. data/spec/models/api_response_security_relative_strength_index_spec.rb +1 -1
  384. data/spec/models/api_response_security_simple_moving_average_spec.rb +1 -1
  385. data/spec/models/api_response_security_stochastic_oscillator_spec.rb +1 -1
  386. data/spec/models/api_response_security_stock_price_adjustments_spec.rb +1 -1
  387. data/spec/models/api_response_security_stock_prices_spec.rb +1 -1
  388. data/spec/models/api_response_security_triple_exponential_average_spec.rb +1 -1
  389. data/spec/models/api_response_security_true_strength_index_spec.rb +1 -1
  390. data/spec/models/api_response_security_ultimate_oscillator_spec.rb +1 -1
  391. data/spec/models/api_response_security_volume_price_trend_spec.rb +1 -1
  392. data/spec/models/api_response_security_volume_weighted_average_price_spec.rb +1 -1
  393. data/spec/models/api_response_security_vortex_indicator_spec.rb +1 -1
  394. data/spec/models/api_response_security_williams_r_spec.rb +1 -1
  395. data/spec/models/api_response_security_zacks_analyst_ratings_snapshot_spec.rb +1 -1
  396. data/spec/models/api_response_security_zacks_analyst_ratings_spec.rb +1 -1
  397. data/spec/models/api_response_security_zacks_eps_surprises_spec.rb +1 -1
  398. data/spec/models/api_response_security_zacks_sales_surprises_spec.rb +1 -1
  399. data/spec/models/api_response_sic_index_historical_data_spec.rb +1 -1
  400. data/spec/models/api_response_sic_indices_search_spec.rb +1 -1
  401. data/spec/models/api_response_sic_indices_spec.rb +1 -1
  402. data/spec/models/api_response_standardized_financials_spec.rb +1 -1
  403. data/spec/models/api_response_stock_exchange_realtime_stock_prices_spec.rb +1 -1
  404. data/spec/models/api_response_stock_exchange_securities_spec.rb +1 -1
  405. data/spec/models/api_response_stock_exchange_stock_price_adjustments_spec.rb +1 -1
  406. data/spec/models/api_response_stock_exchange_stock_prices_spec.rb +1 -1
  407. data/spec/models/api_response_stock_exchanges_spec.rb +1 -1
  408. data/spec/models/api_response_stock_market_index_historical_data_spec.rb +1 -1
  409. data/spec/models/api_response_stock_market_indices_search_spec.rb +1 -1
  410. data/spec/models/api_response_stock_market_indices_spec.rb +1 -1
  411. data/spec/models/api_response_zacks_analyst_ratings_spec.rb +1 -1
  412. data/spec/models/api_response_zacks_eps_estimates_spec.rb +1 -1
  413. data/spec/models/api_response_zacks_eps_growth_rates_spec.rb +1 -1
  414. data/spec/models/api_response_zacks_eps_surprises_spec.rb +1 -1
  415. data/spec/models/api_response_zacks_etf_holdings_spec.rb +1 -1
  416. data/spec/models/api_response_zacks_institutional_holding_companies_spec.rb +1 -1
  417. data/spec/models/api_response_zacks_institutional_holding_owners_spec.rb +1 -1
  418. data/spec/models/api_response_zacks_institutional_holdings_spec.rb +1 -1
  419. data/spec/models/api_response_zacks_long_term_growth_rates_spec.rb +1 -1
  420. data/spec/models/api_response_zacks_sales_surprises_spec.rb +1 -1
  421. data/spec/models/api_response_zacks_target_price_consensuses_spec.rb +1 -1
  422. data/spec/models/average_daily_trading_volume_technical_value_spec.rb +1 -1
  423. data/spec/models/average_directional_index_technical_value_spec.rb +1 -1
  424. data/spec/models/average_true_range_technical_value_spec.rb +1 -1
  425. data/spec/models/awesome_oscillator_technical_value_spec.rb +1 -1
  426. data/spec/models/bollinger_bands_technical_value_spec.rb +1 -1
  427. data/spec/models/bulk_download_links_spec.rb +1 -1
  428. data/spec/models/bulk_download_summary_spec.rb +1 -1
  429. data/spec/models/chaikin_money_flow_technical_value_spec.rb +1 -1
  430. data/spec/models/commodity_channel_index_technical_value_spec.rb +1 -1
  431. data/spec/models/company_filing_spec.rb +1 -1
  432. data/spec/models/company_initial_public_offering_spec.rb +1 -1
  433. data/spec/models/company_news_spec.rb +1 -1
  434. data/spec/models/company_news_summary_spec.rb +1 -1
  435. data/spec/models/company_spec.rb +1 -1
  436. data/spec/models/company_summary_spec.rb +1 -1
  437. data/spec/models/data_tag_spec.rb +1 -1
  438. data/spec/models/data_tag_summary_spec.rb +1 -1
  439. data/spec/models/detrended_price_oscillator_technical_value_spec.rb +1 -1
  440. data/spec/models/dividend_record_spec.rb +1 -1
  441. data/spec/models/donchian_channel_technical_value_spec.rb +1 -1
  442. data/spec/models/earnings_record_spec.rb +1 -1
  443. data/spec/models/ease_of_movement_technical_value_spec.rb +1 -1
  444. data/spec/models/economic_index_spec.rb +1 -1
  445. data/spec/models/economic_index_summary_spec.rb +1 -1
  446. data/spec/models/etf_analytics_spec.rb +1 -1
  447. data/spec/models/etf_holding_spec.rb +1 -1
  448. data/spec/models/etf_spec.rb +1 -1
  449. data/spec/models/etf_stats_spec.rb +1 -1
  450. data/spec/models/etf_summary_spec.rb +1 -1
  451. data/spec/models/filing_note_filing_spec.rb +1 -1
  452. data/spec/models/filing_note_spec.rb +1 -1
  453. data/spec/models/filing_note_summary_spec.rb +1 -1
  454. data/spec/models/filing_spec.rb +1 -1
  455. data/spec/models/filing_summary_spec.rb +1 -1
  456. data/spec/models/force_index_technical_value_spec.rb +1 -1
  457. data/spec/models/forex_currency_spec.rb +1 -1
  458. data/spec/models/forex_pair_spec.rb +1 -1
  459. data/spec/models/forex_price_spec.rb +1 -1
  460. data/spec/models/fundamental_spec.rb +1 -1
  461. data/spec/models/fundamental_summary_spec.rb +1 -1
  462. data/spec/models/historical_data_spec.rb +1 -1
  463. data/spec/models/ichimoku_kinko_hyo_technical_value_spec.rb +1 -1
  464. data/spec/models/insider_transaction_filing_spec.rb +60 -0
  465. data/spec/models/insider_transaction_spec.rb +150 -0
  466. data/spec/models/institutional_holding_spec.rb +126 -0
  467. data/spec/models/institutional_ownership_spec.rb +96 -0
  468. data/spec/models/intraday_stock_price_spec.rb +1 -1
  469. data/spec/models/keltner_channel_technical_value_spec.rb +1 -1
  470. data/spec/models/know_sure_thing_technical_value_spec.rb +1 -1
  471. data/spec/models/mass_index_technical_value_spec.rb +1 -1
  472. data/spec/models/money_flow_index_technical_value_spec.rb +1 -1
  473. data/spec/models/moving_average_convergence_divergence_technical_value_spec.rb +1 -1
  474. data/spec/models/municipality_financial_spec.rb +1 -1
  475. data/spec/models/municipality_spec.rb +1 -1
  476. data/spec/models/negative_volume_index_technical_value_spec.rb +1 -1
  477. data/spec/models/on_balance_volume_mean_technical_value_spec.rb +1 -1
  478. data/spec/models/on_balance_volume_technical_value_spec.rb +1 -1
  479. data/spec/models/option_chain_realtime_spec.rb +54 -0
  480. data/spec/models/option_chain_spec.rb +1 -1
  481. data/spec/models/option_factors_realtime_spec.rb +72 -0
  482. data/spec/models/option_price_realtime_spec.rb +112 -0
  483. data/spec/models/option_price_spec.rb +1 -1
  484. data/spec/models/option_realtime_spec.rb +70 -0
  485. data/spec/models/option_spec.rb +1 -1
  486. data/spec/models/option_stats_realtime_spec.rb +66 -0
  487. data/spec/models/owner_spec.rb +114 -0
  488. data/spec/models/owner_summary_spec.rb +48 -0
  489. data/spec/models/realtime_stock_price_security_spec.rb +1 -1
  490. data/spec/models/realtime_stock_price_spec.rb +13 -1
  491. data/spec/models/relative_strength_index_technical_value_spec.rb +1 -1
  492. data/spec/models/reported_financial_dimension_spec.rb +1 -1
  493. data/spec/models/reported_financial_spec.rb +1 -1
  494. data/spec/models/reported_tag_spec.rb +1 -1
  495. data/spec/models/security_screen_clause_spec.rb +1 -1
  496. data/spec/models/security_screen_group_spec.rb +1 -1
  497. data/spec/models/security_screen_result_data_spec.rb +1 -1
  498. data/spec/models/security_screen_result_spec.rb +1 -1
  499. data/spec/models/security_spec.rb +1 -1
  500. data/spec/models/security_summary_spec.rb +7 -1
  501. data/spec/models/sic_index_spec.rb +1 -1
  502. data/spec/models/simple_moving_average_technical_value_spec.rb +1 -1
  503. data/spec/models/standardized_financial_spec.rb +1 -1
  504. data/spec/models/stochastic_oscillator_technical_value_spec.rb +1 -1
  505. data/spec/models/stock_exchange_spec.rb +1 -1
  506. data/spec/models/stock_market_index_spec.rb +1 -1
  507. data/spec/models/stock_market_index_summary_spec.rb +1 -1
  508. data/spec/models/stock_price_adjustment_spec.rb +1 -1
  509. data/spec/models/stock_price_adjustment_summary_spec.rb +1 -1
  510. data/spec/models/stock_price_interval_spec.rb +72 -0
  511. data/spec/models/stock_price_spec.rb +43 -1
  512. data/spec/models/stock_price_summary_spec.rb +1 -1
  513. data/spec/models/technical_indicator_spec.rb +1 -1
  514. data/spec/models/triple_exponential_average_technical_value_spec.rb +1 -1
  515. data/spec/models/true_strength_index_technical_value_spec.rb +1 -1
  516. data/spec/models/ultimate_oscillator_technical_value_spec.rb +1 -1
  517. data/spec/models/volume_price_trend_technical_value_spec.rb +1 -1
  518. data/spec/models/volume_weighted_average_price_value_spec.rb +1 -1
  519. data/spec/models/vortex_indicator_technical_value_spec.rb +1 -1
  520. data/spec/models/williams_r_technical_value_spec.rb +1 -1
  521. data/spec/models/zacks_analyst_rating_snapshot_spec.rb +1 -1
  522. data/spec/models/zacks_analyst_rating_spec.rb +1 -1
  523. data/spec/models/zacks_analyst_rating_summary_spec.rb +1 -1
  524. data/spec/models/zacks_eps_estimate_spec.rb +1 -1
  525. data/spec/models/zacks_eps_growth_rate_spec.rb +1 -1
  526. data/spec/models/zacks_eps_surprise_spec.rb +1 -1
  527. data/spec/models/zacks_eps_surprise_summary_spec.rb +1 -1
  528. data/spec/models/zacks_etf_holding_spec.rb +1 -1
  529. data/spec/models/zacks_institutional_holding_company_detail_spec.rb +1 -1
  530. data/spec/models/zacks_institutional_holding_company_summary_spec.rb +1 -1
  531. data/spec/models/zacks_institutional_holding_historical_summary_spec.rb +1 -1
  532. data/spec/models/zacks_institutional_holding_owner_detail_spec.rb +1 -1
  533. data/spec/models/zacks_institutional_holding_owner_summary_spec.rb +1 -1
  534. data/spec/models/zacks_institutional_holding_spec.rb +1 -1
  535. data/spec/models/zacks_long_term_growth_rate_spec.rb +1 -1
  536. data/spec/models/zacks_sales_surprise_spec.rb +1 -1
  537. data/spec/models/zacks_sales_surprise_summary_spec.rb +1 -1
  538. data/spec/models/zacks_target_price_consensus_spec.rb +1 -1
  539. data/spec/spec_helper.rb +1 -1
  540. metadata +122 -7
@@ -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.14.0
6
+ OpenAPI spec version: 2.19.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: unset
@@ -21,7 +21,7 @@ module Intrinio
21
21
  end
22
22
 
23
23
  # All Municipalities
24
- #
24
+ # Returns all Municipalities. When parameters are specified, returns matching municipalities.
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @option opts [BOOLEAN] :has_financials Return municipalities with financials
27
27
  # @option opts [String] :government_name Return municipalities with a government name matching the given query
@@ -43,7 +43,7 @@ module Intrinio
43
43
  end
44
44
 
45
45
  # All Municipalities
46
- #
46
+ # Returns all Municipalities. When parameters are specified, returns matching municipalities.
47
47
  # @param [Hash] opts the optional parameters
48
48
  # @option opts [BOOLEAN] :has_financials Return municipalities with financials
49
49
  # @option opts [String] :government_name Return municipalities with a government name matching the given query
@@ -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.14.0
6
+ OpenAPI spec version: 2.19.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: unset
@@ -197,6 +197,104 @@ module Intrinio
197
197
  return data, status_code, headers
198
198
  end
199
199
 
200
+ # Options Chain Realtime
201
+ # Returns all realtime options contracts and their prices for the given symbol and expiration date.
202
+ # @param symbol The option symbol, corresponding to the underlying security.
203
+ # @param expiration The expiration date of the options contract
204
+ # @param [Hash] opts the optional parameters
205
+ # @option opts [String] :source Realtime or 15-minute delayed contracts.
206
+ # @option opts [String] :type The option contract type.
207
+ # @option opts [Float] :strike The strike price of the option contract. This will return options contracts with strike price equal to this price.
208
+ # @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.
209
+ # @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.
210
+ # @option opts [Float] :volume_greater_than The volume of the option contract. This will return options contracts with volumes greater than this amount.
211
+ # @option opts [Float] :volume_less_than The volume of the option contract. This will return options contracts with volumes less than this amout.
212
+ # @option opts [Float] :open_interest_greater_than The open interest of the option contract. This will return options contracts with open interest greater than this amount.
213
+ # @option opts [Float] :open_interest_less_than The open interest of the option contract. This will return options contracts with open interest less than this amount.
214
+ # @option opts [String] :moneyness 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.
215
+ # @return [ApiResponseOptionsChainRealtime]
216
+ def get_options_chain_realtime(symbol, expiration, opts = {})
217
+ data, _status_code, _headers = get_options_chain_realtime_with_http_info(symbol, expiration, opts)
218
+ return data
219
+ end
220
+
221
+ # Options Chain Realtime
222
+ # Returns all realtime options contracts and their prices for the given symbol and expiration date.
223
+ # @param symbol The option symbol, corresponding to the underlying security.
224
+ # @param expiration The expiration date of the options contract
225
+ # @param [Hash] opts the optional parameters
226
+ # @option opts [String] :source Realtime or 15-minute delayed contracts.
227
+ # @option opts [String] :type The option contract type.
228
+ # @option opts [Float] :strike The strike price of the option contract. This will return options contracts with strike price equal to this price.
229
+ # @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.
230
+ # @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.
231
+ # @option opts [Float] :volume_greater_than The volume of the option contract. This will return options contracts with volumes greater than this amount.
232
+ # @option opts [Float] :volume_less_than The volume of the option contract. This will return options contracts with volumes less than this amout.
233
+ # @option opts [Float] :open_interest_greater_than The open interest of the option contract. This will return options contracts with open interest greater than this amount.
234
+ # @option opts [Float] :open_interest_less_than The open interest of the option contract. This will return options contracts with open interest less than this amount.
235
+ # @option opts [String] :moneyness 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.
236
+ # @return [Array<(ApiResponseOptionsChainRealtime, Fixnum, Hash)>] ApiResponseOptionsChainRealtime data, response status code and response headers
237
+ def get_options_chain_realtime_with_http_info(symbol, expiration, opts = {})
238
+ if @api_client.config.debugging
239
+ @api_client.config.logger.debug "Calling API: OptionsApi.get_options_chain_realtime ..."
240
+ end
241
+ # verify the required parameter 'symbol' is set
242
+ if @api_client.config.client_side_validation && symbol.nil?
243
+ fail ArgumentError, "Missing the required parameter 'symbol' when calling OptionsApi.get_options_chain_realtime"
244
+ end
245
+ # verify the required parameter 'expiration' is set
246
+ if @api_client.config.client_side_validation && expiration.nil?
247
+ fail ArgumentError, "Missing the required parameter 'expiration' when calling OptionsApi.get_options_chain_realtime"
248
+ end
249
+ if @api_client.config.client_side_validation && opts[:'source'] && !['realtime', 'delayed'].include?(opts[:'source'])
250
+ fail ArgumentError, 'invalid value for "source", must be one of realtime, delayed'
251
+ end
252
+ if @api_client.config.client_side_validation && opts[:'type'] && !['call', 'put'].include?(opts[:'type'])
253
+ fail ArgumentError, 'invalid value for "type", must be one of call, put'
254
+ end
255
+ if @api_client.config.client_side_validation && opts[:'moneyness'] && !['all', 'in_the_money', 'out_of_the_money', 'near_the_money'].include?(opts[:'moneyness'])
256
+ fail ArgumentError, 'invalid value for "moneyness", must be one of all, in_the_money, out_of_the_money, near_the_money'
257
+ end
258
+ # resource path
259
+ local_var_path = "/options/chain/{symbol}/{expiration}/realtime".sub('{' + 'symbol' + '}', symbol.to_s).sub('{' + 'expiration' + '}', expiration.to_s)
260
+
261
+ # query parameters
262
+ query_params = {}
263
+ query_params[:'source'] = opts[:'source'] if !opts[:'source'].nil?
264
+ query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
265
+ query_params[:'strike'] = opts[:'strike'] if !opts[:'strike'].nil?
266
+ query_params[:'strike_greater_than'] = opts[:'strike_greater_than'] if !opts[:'strike_greater_than'].nil?
267
+ query_params[:'strike_less_than'] = opts[:'strike_less_than'] if !opts[:'strike_less_than'].nil?
268
+ query_params[:'volume_greater_than'] = opts[:'volume_greater_than'] if !opts[:'volume_greater_than'].nil?
269
+ query_params[:'volume_less_than'] = opts[:'volume_less_than'] if !opts[:'volume_less_than'].nil?
270
+ query_params[:'open_interest_greater_than'] = opts[:'open_interest_greater_than'] if !opts[:'open_interest_greater_than'].nil?
271
+ query_params[:'open_interest_less_than'] = opts[:'open_interest_less_than'] if !opts[:'open_interest_less_than'].nil?
272
+ query_params[:'moneyness'] = opts[:'moneyness'] if !opts[:'moneyness'].nil?
273
+
274
+ # header parameters
275
+ header_params = {}
276
+ # HTTP header 'Accept' (if needed)
277
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
278
+
279
+ # form parameters
280
+ form_params = {}
281
+
282
+ # http body (model)
283
+ post_body = nil
284
+ auth_names = ['ApiKeyAuth']
285
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
286
+ :header_params => header_params,
287
+ :query_params => query_params,
288
+ :form_params => form_params,
289
+ :body => post_body,
290
+ :auth_names => auth_names,
291
+ :return_type => 'ApiResponseOptionsChainRealtime')
292
+ if @api_client.config.debugging
293
+ @api_client.config.logger.debug "API called: OptionsApi#get_options_chain_realtime\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
294
+ end
295
+ return data, status_code, headers
296
+ end
297
+
200
298
  # Options Expirations
201
299
  # Returns all option contract expiration dates for a given symbol.
202
300
  # @param symbol The option symbol, corresponding to the underlying security.
@@ -324,5 +422,123 @@ module Intrinio
324
422
  end
325
423
  return data, status_code, headers
326
424
  end
425
+
426
+ # Option Prices Realtime
427
+ # Returns all option prices for a given option contract identifier.
428
+ # @param identifier The Intrinio ID or code of the options contract to request prices for.
429
+ # @param [Hash] opts the optional parameters
430
+ # @option opts [String] :source Realtime or 15-minute delayed contracts.
431
+ # @return [ApiResponseOptionsPriceRealtime]
432
+ def get_options_prices_realtime(identifier, opts = {})
433
+ data, _status_code, _headers = get_options_prices_realtime_with_http_info(identifier, opts)
434
+ return data
435
+ end
436
+
437
+ # Option Prices Realtime
438
+ # Returns all option prices for a given option contract identifier.
439
+ # @param identifier The Intrinio ID or code of the options contract to request prices for.
440
+ # @param [Hash] opts the optional parameters
441
+ # @option opts [String] :source Realtime or 15-minute delayed contracts.
442
+ # @return [Array<(ApiResponseOptionsPriceRealtime, Fixnum, Hash)>] ApiResponseOptionsPriceRealtime data, response status code and response headers
443
+ def get_options_prices_realtime_with_http_info(identifier, opts = {})
444
+ if @api_client.config.debugging
445
+ @api_client.config.logger.debug "Calling API: OptionsApi.get_options_prices_realtime ..."
446
+ end
447
+ # verify the required parameter 'identifier' is set
448
+ if @api_client.config.client_side_validation && identifier.nil?
449
+ fail ArgumentError, "Missing the required parameter 'identifier' when calling OptionsApi.get_options_prices_realtime"
450
+ end
451
+ if @api_client.config.client_side_validation && opts[:'source'] && !['realtime', 'delayed'].include?(opts[:'source'])
452
+ fail ArgumentError, 'invalid value for "source", must be one of realtime, delayed'
453
+ end
454
+ # resource path
455
+ local_var_path = "/options/prices/{identifier}/realtime".sub('{' + 'identifier' + '}', identifier.to_s)
456
+
457
+ # query parameters
458
+ query_params = {}
459
+ query_params[:'source'] = opts[:'source'] if !opts[:'source'].nil?
460
+
461
+ # header parameters
462
+ header_params = {}
463
+ # HTTP header 'Accept' (if needed)
464
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
465
+
466
+ # form parameters
467
+ form_params = {}
468
+
469
+ # http body (model)
470
+ post_body = nil
471
+ auth_names = ['ApiKeyAuth']
472
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
473
+ :header_params => header_params,
474
+ :query_params => query_params,
475
+ :form_params => form_params,
476
+ :body => post_body,
477
+ :auth_names => auth_names,
478
+ :return_type => 'ApiResponseOptionsPriceRealtime')
479
+ if @api_client.config.debugging
480
+ @api_client.config.logger.debug "API called: OptionsApi#get_options_prices_realtime\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
481
+ end
482
+ return data, status_code, headers
483
+ end
484
+
485
+ # Option Stats Realtime
486
+ # Returns all option stats (greeks and implied volatility) and factors used to calculate them, for a given option contract identifier.
487
+ # @param identifier The Intrinio ID or code of the options contract to request prices for.
488
+ # @param [Hash] opts the optional parameters
489
+ # @option opts [String] :source Realtime or 15-minute delayed contracts.
490
+ # @return [ApiResponseOptionsStatsRealtime]
491
+ def get_options_stats_realtime(identifier, opts = {})
492
+ data, _status_code, _headers = get_options_stats_realtime_with_http_info(identifier, opts)
493
+ return data
494
+ end
495
+
496
+ # Option Stats Realtime
497
+ # Returns all option stats (greeks and implied volatility) and factors used to calculate them, for a given option contract identifier.
498
+ # @param identifier The Intrinio ID or code of the options contract to request prices for.
499
+ # @param [Hash] opts the optional parameters
500
+ # @option opts [String] :source Realtime or 15-minute delayed contracts.
501
+ # @return [Array<(ApiResponseOptionsStatsRealtime, Fixnum, Hash)>] ApiResponseOptionsStatsRealtime data, response status code and response headers
502
+ def get_options_stats_realtime_with_http_info(identifier, opts = {})
503
+ if @api_client.config.debugging
504
+ @api_client.config.logger.debug "Calling API: OptionsApi.get_options_stats_realtime ..."
505
+ end
506
+ # verify the required parameter 'identifier' is set
507
+ if @api_client.config.client_side_validation && identifier.nil?
508
+ fail ArgumentError, "Missing the required parameter 'identifier' when calling OptionsApi.get_options_stats_realtime"
509
+ end
510
+ if @api_client.config.client_side_validation && opts[:'source'] && !['realtime', 'delayed'].include?(opts[:'source'])
511
+ fail ArgumentError, 'invalid value for "source", must be one of realtime, delayed'
512
+ end
513
+ # resource path
514
+ local_var_path = "/options/prices/{identifier}/realtime/stats".sub('{' + 'identifier' + '}', identifier.to_s)
515
+
516
+ # query parameters
517
+ query_params = {}
518
+ query_params[:'source'] = opts[:'source'] if !opts[:'source'].nil?
519
+
520
+ # header parameters
521
+ header_params = {}
522
+ # HTTP header 'Accept' (if needed)
523
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
524
+
525
+ # form parameters
526
+ form_params = {}
527
+
528
+ # http body (model)
529
+ post_body = nil
530
+ auth_names = ['ApiKeyAuth']
531
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
532
+ :header_params => header_params,
533
+ :query_params => query_params,
534
+ :form_params => form_params,
535
+ :body => post_body,
536
+ :auth_names => auth_names,
537
+ :return_type => 'ApiResponseOptionsStatsRealtime')
538
+ if @api_client.config.debugging
539
+ @api_client.config.logger.debug "API called: OptionsApi#get_options_stats_realtime\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
540
+ end
541
+ return data, status_code, headers
542
+ end
327
543
  end
328
544
  end
@@ -0,0 +1,338 @@
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.19.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: unset
10
+
11
+ =end
12
+
13
+ require "uri"
14
+
15
+ module Intrinio
16
+ class OwnersApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+
23
+ # All Owners
24
+ # Returns all owners and information for all insider and institutional owners of securities covered by Intrinio.
25
+ # @param [Hash] opts the optional parameters
26
+ # @option opts [BOOLEAN] :institutional Returns insider owners who have filed forms 3, 4, or 5 with the SEC only. Possible values are true, false, or omit for both.
27
+ # @option opts [Integer] :page_size The number of results to return (default to 100)
28
+ # @option opts [String] :next_page Gets the next page of data from a previous API call
29
+ # @return [ApiResponseOwners]
30
+ def get_all_owners(opts = {})
31
+ data, _status_code, _headers = get_all_owners_with_http_info(opts)
32
+ return data
33
+ end
34
+
35
+ # All Owners
36
+ # Returns all owners and information for all insider and institutional owners of securities covered by Intrinio.
37
+ # @param [Hash] opts the optional parameters
38
+ # @option opts [BOOLEAN] :institutional Returns insider owners who have filed forms 3, 4, or 5 with the SEC only. Possible values are true, false, or omit for both.
39
+ # @option opts [Integer] :page_size The number of results to return
40
+ # @option opts [String] :next_page Gets the next page of data from a previous API call
41
+ # @return [Array<(ApiResponseOwners, Fixnum, Hash)>] ApiResponseOwners data, response status code and response headers
42
+ def get_all_owners_with_http_info(opts = {})
43
+ if @api_client.config.debugging
44
+ @api_client.config.logger.debug "Calling API: OwnersApi.get_all_owners ..."
45
+ end
46
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
47
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling OwnersApi.get_all_owners, must be smaller than or equal to 10000.'
48
+ end
49
+
50
+ # resource path
51
+ local_var_path = "/owners"
52
+
53
+ # query parameters
54
+ query_params = {}
55
+ query_params[:'institutional'] = opts[:'institutional'] if !opts[:'institutional'].nil?
56
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
57
+ query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
58
+
59
+ # header parameters
60
+ header_params = {}
61
+ # HTTP header 'Accept' (if needed)
62
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
63
+
64
+ # form parameters
65
+ form_params = {}
66
+
67
+ # http body (model)
68
+ post_body = nil
69
+ auth_names = ['ApiKeyAuth']
70
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
71
+ :header_params => header_params,
72
+ :query_params => query_params,
73
+ :form_params => form_params,
74
+ :body => post_body,
75
+ :auth_names => auth_names,
76
+ :return_type => 'ApiResponseOwners')
77
+ if @api_client.config.debugging
78
+ @api_client.config.logger.debug "API called: OwnersApi#get_all_owners\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
79
+ end
80
+ return data, status_code, headers
81
+ end
82
+
83
+ # Owner by ID
84
+ # Returns the Owner with the given ID
85
+ # @param identifier An Intrinio ID or CIK of an Owner
86
+ # @param [Hash] opts the optional parameters
87
+ # @return [Owner]
88
+ def get_owner_by_id(identifier, opts = {})
89
+ data, _status_code, _headers = get_owner_by_id_with_http_info(identifier, opts)
90
+ return data
91
+ end
92
+
93
+ # Owner by ID
94
+ # Returns the Owner with the given ID
95
+ # @param identifier An Intrinio ID or CIK of an Owner
96
+ # @param [Hash] opts the optional parameters
97
+ # @return [Array<(Owner, Fixnum, Hash)>] Owner data, response status code and response headers
98
+ def get_owner_by_id_with_http_info(identifier, opts = {})
99
+ if @api_client.config.debugging
100
+ @api_client.config.logger.debug "Calling API: OwnersApi.get_owner_by_id ..."
101
+ end
102
+ # verify the required parameter 'identifier' is set
103
+ if @api_client.config.client_side_validation && identifier.nil?
104
+ fail ArgumentError, "Missing the required parameter 'identifier' when calling OwnersApi.get_owner_by_id"
105
+ end
106
+ # resource path
107
+ local_var_path = "/owners/{identifier}".sub('{' + 'identifier' + '}', identifier.to_s)
108
+
109
+ # query parameters
110
+ query_params = {}
111
+
112
+ # header parameters
113
+ header_params = {}
114
+ # HTTP header 'Accept' (if needed)
115
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
116
+
117
+ # form parameters
118
+ form_params = {}
119
+
120
+ # http body (model)
121
+ post_body = nil
122
+ auth_names = ['ApiKeyAuth']
123
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
124
+ :header_params => header_params,
125
+ :query_params => query_params,
126
+ :form_params => form_params,
127
+ :body => post_body,
128
+ :auth_names => auth_names,
129
+ :return_type => 'Owner')
130
+ if @api_client.config.debugging
131
+ @api_client.config.logger.debug "API called: OwnersApi#get_owner_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
132
+ end
133
+ return data, status_code, headers
134
+ end
135
+
136
+ # Insider Transaction Filings by Owner
137
+ # Returns a list of all insider transaction filings by an owner in as many companies as the owner may be considered an insider. Criteria for being an insider include being a director, officer, or 10%+ owner in the company. Transactions are detailed for both non-derivative and derivative transactions by the insider.
138
+ # @param identifier The Central Index Key issued by the SEC, which is the unique identifier all owner filings are issued under.
139
+ # @param [Hash] opts the optional parameters
140
+ # @option opts [Date] :start_date Return Owner&#39;s insider transaction filings on or after this date
141
+ # @option opts [Date] :end_date Return Owner&#39;s insider transaction filings on or before this date
142
+ # @option opts [Integer] :page_size The number of results to return (default to 100)
143
+ # @option opts [String] :next_page Gets the next page of data from a previous API call
144
+ # @return [ApiResponseOwnerInsiderTransactionFilings]
145
+ def insider_transaction_filings_by_owner(identifier, opts = {})
146
+ data, _status_code, _headers = insider_transaction_filings_by_owner_with_http_info(identifier, opts)
147
+ return data
148
+ end
149
+
150
+ # Insider Transaction Filings by Owner
151
+ # Returns a list of all insider transaction filings by an owner in as many companies as the owner may be considered an insider. Criteria for being an insider include being a director, officer, or 10%+ owner in the company. Transactions are detailed for both non-derivative and derivative transactions by the insider.
152
+ # @param identifier The Central Index Key issued by the SEC, which is the unique identifier all owner filings are issued under.
153
+ # @param [Hash] opts the optional parameters
154
+ # @option opts [Date] :start_date Return Owner&#39;s insider transaction filings on or after this date
155
+ # @option opts [Date] :end_date Return Owner&#39;s insider transaction filings on or before this date
156
+ # @option opts [Integer] :page_size The number of results to return
157
+ # @option opts [String] :next_page Gets the next page of data from a previous API call
158
+ # @return [Array<(ApiResponseOwnerInsiderTransactionFilings, Fixnum, Hash)>] ApiResponseOwnerInsiderTransactionFilings data, response status code and response headers
159
+ def insider_transaction_filings_by_owner_with_http_info(identifier, opts = {})
160
+ if @api_client.config.debugging
161
+ @api_client.config.logger.debug "Calling API: OwnersApi.insider_transaction_filings_by_owner ..."
162
+ end
163
+ # verify the required parameter 'identifier' is set
164
+ if @api_client.config.client_side_validation && identifier.nil?
165
+ fail ArgumentError, "Missing the required parameter 'identifier' when calling OwnersApi.insider_transaction_filings_by_owner"
166
+ end
167
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
168
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling OwnersApi.insider_transaction_filings_by_owner, must be smaller than or equal to 10000.'
169
+ end
170
+
171
+ # resource path
172
+ local_var_path = "/owners/{identifier}/insider_transaction_filings".sub('{' + 'identifier' + '}', identifier.to_s)
173
+
174
+ # query parameters
175
+ query_params = {}
176
+ query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
177
+ query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
178
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
179
+ query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
180
+
181
+ # header parameters
182
+ header_params = {}
183
+ # HTTP header 'Accept' (if needed)
184
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
185
+
186
+ # form parameters
187
+ form_params = {}
188
+
189
+ # http body (model)
190
+ post_body = nil
191
+ auth_names = ['ApiKeyAuth']
192
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
193
+ :header_params => header_params,
194
+ :query_params => query_params,
195
+ :form_params => form_params,
196
+ :body => post_body,
197
+ :auth_names => auth_names,
198
+ :return_type => 'ApiResponseOwnerInsiderTransactionFilings')
199
+ if @api_client.config.debugging
200
+ @api_client.config.logger.debug "API called: OwnersApi#insider_transaction_filings_by_owner\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
201
+ end
202
+ return data, status_code, headers
203
+ end
204
+
205
+ # Institutional Holdings by Owner
206
+ # Returns a list of all ownership interests and the value of their interests by a single institutional owner.
207
+ # @param identifier The Central Index Key issued by the SEC, which is the unique identifier all owner filings are issued under.
208
+ # @param [Hash] opts the optional parameters
209
+ # @option opts [Integer] :page_size The number of results to return (default to 100)
210
+ # @option opts [Object] :as_of_date Return only holdings filed before this date.
211
+ # @option opts [String] :next_page Gets the next page of data from a previous API call
212
+ # @return [ApiResponseOwnerInstitutionalHoldings]
213
+ def institutional_holdings_by_owner(identifier, opts = {})
214
+ data, _status_code, _headers = institutional_holdings_by_owner_with_http_info(identifier, opts)
215
+ return data
216
+ end
217
+
218
+ # Institutional Holdings by Owner
219
+ # Returns a list of all ownership interests and the value of their interests by a single institutional owner.
220
+ # @param identifier The Central Index Key issued by the SEC, which is the unique identifier all owner filings are issued under.
221
+ # @param [Hash] opts the optional parameters
222
+ # @option opts [Integer] :page_size The number of results to return
223
+ # @option opts [Object] :as_of_date Return only holdings filed before this date.
224
+ # @option opts [String] :next_page Gets the next page of data from a previous API call
225
+ # @return [Array<(ApiResponseOwnerInstitutionalHoldings, Fixnum, Hash)>] ApiResponseOwnerInstitutionalHoldings data, response status code and response headers
226
+ def institutional_holdings_by_owner_with_http_info(identifier, opts = {})
227
+ if @api_client.config.debugging
228
+ @api_client.config.logger.debug "Calling API: OwnersApi.institutional_holdings_by_owner ..."
229
+ end
230
+ # verify the required parameter 'identifier' is set
231
+ if @api_client.config.client_side_validation && identifier.nil?
232
+ fail ArgumentError, "Missing the required parameter 'identifier' when calling OwnersApi.institutional_holdings_by_owner"
233
+ end
234
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
235
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling OwnersApi.institutional_holdings_by_owner, must be smaller than or equal to 10000.'
236
+ end
237
+
238
+ # resource path
239
+ local_var_path = "/owners/{identifier}/institutional_holdings".sub('{' + 'identifier' + '}', identifier.to_s)
240
+
241
+ # query parameters
242
+ query_params = {}
243
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
244
+ query_params[:'as_of_date'] = opts[:'as_of_date'] if !opts[:'as_of_date'].nil?
245
+ query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
246
+
247
+ # header parameters
248
+ header_params = {}
249
+ # HTTP header 'Accept' (if needed)
250
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
251
+
252
+ # form parameters
253
+ form_params = {}
254
+
255
+ # http body (model)
256
+ post_body = nil
257
+ auth_names = ['ApiKeyAuth']
258
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
259
+ :header_params => header_params,
260
+ :query_params => query_params,
261
+ :form_params => form_params,
262
+ :body => post_body,
263
+ :auth_names => auth_names,
264
+ :return_type => 'ApiResponseOwnerInstitutionalHoldings')
265
+ if @api_client.config.debugging
266
+ @api_client.config.logger.debug "API called: OwnersApi#institutional_holdings_by_owner\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
267
+ end
268
+ return data, status_code, headers
269
+ end
270
+
271
+ # Search Owners
272
+ # Searches for Owners matching the text `query`
273
+ # @param query
274
+ # @param [Hash] opts the optional parameters
275
+ # @option opts [BOOLEAN] :institutional Returns insider owners who have filed forms 3, 4, or 5 with the SEC only. Possible values are true, false, or omit for both.
276
+ # @option opts [Integer] :page_size The number of results to return (default to 100)
277
+ # @option opts [String] :next_page Gets the next page of data from a previous API call
278
+ # @return [ApiResponseOwners]
279
+ def search_owners(query, opts = {})
280
+ data, _status_code, _headers = search_owners_with_http_info(query, opts)
281
+ return data
282
+ end
283
+
284
+ # Search Owners
285
+ # Searches for Owners matching the text &#x60;query&#x60;
286
+ # @param query
287
+ # @param [Hash] opts the optional parameters
288
+ # @option opts [BOOLEAN] :institutional Returns insider owners who have filed forms 3, 4, or 5 with the SEC only. Possible values are true, false, or omit for both.
289
+ # @option opts [Integer] :page_size The number of results to return
290
+ # @option opts [String] :next_page Gets the next page of data from a previous API call
291
+ # @return [Array<(ApiResponseOwners, Fixnum, Hash)>] ApiResponseOwners data, response status code and response headers
292
+ def search_owners_with_http_info(query, opts = {})
293
+ if @api_client.config.debugging
294
+ @api_client.config.logger.debug "Calling API: OwnersApi.search_owners ..."
295
+ end
296
+ # verify the required parameter 'query' is set
297
+ if @api_client.config.client_side_validation && query.nil?
298
+ fail ArgumentError, "Missing the required parameter 'query' when calling OwnersApi.search_owners"
299
+ end
300
+ if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
301
+ fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling OwnersApi.search_owners, must be smaller than or equal to 10000.'
302
+ end
303
+
304
+ # resource path
305
+ local_var_path = "/owners/search"
306
+
307
+ # query parameters
308
+ query_params = {}
309
+ query_params[:'query'] = query
310
+ query_params[:'institutional'] = opts[:'institutional'] if !opts[:'institutional'].nil?
311
+ query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
312
+ query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
313
+
314
+ # header parameters
315
+ header_params = {}
316
+ # HTTP header 'Accept' (if needed)
317
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
318
+
319
+ # form parameters
320
+ form_params = {}
321
+
322
+ # http body (model)
323
+ post_body = nil
324
+ auth_names = ['ApiKeyAuth']
325
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
326
+ :header_params => header_params,
327
+ :query_params => query_params,
328
+ :form_params => form_params,
329
+ :body => post_body,
330
+ :auth_names => auth_names,
331
+ :return_type => 'ApiResponseOwners')
332
+ if @api_client.config.debugging
333
+ @api_client.config.logger.debug "API called: OwnersApi#search_owners\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
334
+ end
335
+ return data, status_code, headers
336
+ end
337
+ end
338
+ end