Class: Intrinio::ZacksApi

Inherits:
Object
  • Object
show all
Defined in:
lib/intrinio-sdk/api/zacks_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ZacksApi

Returns a new instance of ZacksApi.



19
20
21
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_zacks_analyst_ratings(opts = {}) ⇒ ApiResponseZacksAnalystRatings

Zacks Analyst Ratings This database offers consensus analyst recommendations for over 5,000 US and Canadian listed companies.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :identifier (String) —

    A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)

  • :start_date (Date) —

    Limit ratings to those on or after this date

  • :end_date (Date) —

    Limit ratings to those on or before this date

  • :mean_greater (Float) —

    Return only records with a mean (average) higher than this value

  • :mean_less (Float) —

    Return only records with a mean (average) lower than this value

  • :strong_buys_greater (Integer) —

    Return only records with more than this many Strong Buy recommendations

  • :strong_buys_less (Integer) —

    Return only records with fewer than this many Strong Buy recommendations

  • :buys_greater (Integer) —

    Return only records with more than this many Buy recommendations

  • :buys_less (Integer) —

    Return only records with fewer than this many Buy recommendations

  • :holds_greater (Integer) —

    Return only records with more than this many Hold recommendations

  • :holds_less (Integer) —

    Return only records with fewer than this many Hold recommendations

  • :sells_greater (Integer) —

    Return only records with more than this many Sell recommendations

  • :sells_less (Integer) —

    Return only records with fewer than this many Sell recommendations

  • :strong_sells_greater (Integer) —

    Return only records with more than this many Strong Sell recommendations

  • :strong_sells_less (Integer) —

    Return only records with fewer than this many Strong Sell recommendations

  • :total_greater (Integer) —

    Return only records with more than this many recommendations, regardless of type

  • :total_less (Integer) —

    Return only records with fewer than this many recommendations, regardless of type

  • :page_size (Integer) —

    The number of results to return (default to 100)

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



46
47
48
49
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 46

def get_zacks_analyst_ratings(opts = {})
  data, _status_code, _headers = get_zacks_analyst_ratings_with_http_info(opts)
  return data
end

#get_zacks_analyst_ratings_with_http_info(opts = {}) ⇒ Array<(ApiResponseZacksAnalystRatings, Fixnum, Hash)>

Zacks Analyst Ratings This database offers consensus analyst recommendations for over 5,000 US and Canadian listed companies.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :identifier (String) —

    A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)

  • :start_date (Date) —

    Limit ratings to those on or after this date

  • :end_date (Date) —

    Limit ratings to those on or before this date

  • :mean_greater (Float) —

    Return only records with a mean (average) higher than this value

  • :mean_less (Float) —

    Return only records with a mean (average) lower than this value

  • :strong_buys_greater (Integer) —

    Return only records with more than this many Strong Buy recommendations

  • :strong_buys_less (Integer) —

    Return only records with fewer than this many Strong Buy recommendations

  • :buys_greater (Integer) —

    Return only records with more than this many Buy recommendations

  • :buys_less (Integer) —

    Return only records with fewer than this many Buy recommendations

  • :holds_greater (Integer) —

    Return only records with more than this many Hold recommendations

  • :holds_less (Integer) —

    Return only records with fewer than this many Hold recommendations

  • :sells_greater (Integer) —

    Return only records with more than this many Sell recommendations

  • :sells_less (Integer) —

    Return only records with fewer than this many Sell recommendations

  • :strong_sells_greater (Integer) —

    Return only records with more than this many Strong Sell recommendations

  • :strong_sells_less (Integer) —

    Return only records with fewer than this many Strong Sell recommendations

  • :total_greater (Integer) —

    Return only records with more than this many recommendations, regardless of type

  • :total_less (Integer) —

    Return only records with fewer than this many recommendations, regardless of type

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 74

def get_zacks_analyst_ratings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ZacksApi.get_zacks_analyst_ratings ..."
  end
  if @api_client.config.client_side_validation && !opts[:'mean_greater'].nil? && opts[:'mean_greater'] > 5
    fail ArgumentError, 'invalid value for "opts[:"mean_greater"]" when calling ZacksApi.get_zacks_analyst_ratings, must be smaller than or equal to 5.'
  end

  if @api_client.config.client_side_validation && !opts[:'mean_greater'].nil? && opts[:'mean_greater'] < 1
    fail ArgumentError, 'invalid value for "opts[:"mean_greater"]" when calling ZacksApi.get_zacks_analyst_ratings, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'mean_less'].nil? && opts[:'mean_less'] > 5
    fail ArgumentError, 'invalid value for "opts[:"mean_less"]" when calling ZacksApi.get_zacks_analyst_ratings, must be smaller than or equal to 5.'
  end

  if @api_client.config.client_side_validation && !opts[:'mean_less'].nil? && opts[:'mean_less'] < 1
    fail ArgumentError, 'invalid value for "opts[:"mean_less"]" when calling ZacksApi.get_zacks_analyst_ratings, must be greater than or equal to 1.'
  end

  if @api_client.config.client_side_validation && !opts[:'strong_buys_greater'].nil? && opts[:'strong_buys_greater'] < 0
    fail ArgumentError, 'invalid value for "opts[:"strong_buys_greater"]" when calling ZacksApi.get_zacks_analyst_ratings, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'strong_buys_less'].nil? && opts[:'strong_buys_less'] < 0
    fail ArgumentError, 'invalid value for "opts[:"strong_buys_less"]" when calling ZacksApi.get_zacks_analyst_ratings, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'buys_greater'].nil? && opts[:'buys_greater'] < 0
    fail ArgumentError, 'invalid value for "opts[:"buys_greater"]" when calling ZacksApi.get_zacks_analyst_ratings, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'buys_less'].nil? && opts[:'buys_less'] < 0
    fail ArgumentError, 'invalid value for "opts[:"buys_less"]" when calling ZacksApi.get_zacks_analyst_ratings, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'holds_greater'].nil? && opts[:'holds_greater'] < 0
    fail ArgumentError, 'invalid value for "opts[:"holds_greater"]" when calling ZacksApi.get_zacks_analyst_ratings, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'holds_less'].nil? && opts[:'holds_less'] < 0
    fail ArgumentError, 'invalid value for "opts[:"holds_less"]" when calling ZacksApi.get_zacks_analyst_ratings, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'sells_greater'].nil? && opts[:'sells_greater'] < 0
    fail ArgumentError, 'invalid value for "opts[:"sells_greater"]" when calling ZacksApi.get_zacks_analyst_ratings, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'sells_less'].nil? && opts[:'sells_less'] < 0
    fail ArgumentError, 'invalid value for "opts[:"sells_less"]" when calling ZacksApi.get_zacks_analyst_ratings, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'strong_sells_greater'].nil? && opts[:'strong_sells_greater'] < 0
    fail ArgumentError, 'invalid value for "opts[:"strong_sells_greater"]" when calling ZacksApi.get_zacks_analyst_ratings, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'strong_sells_less'].nil? && opts[:'strong_sells_less'] < 0
    fail ArgumentError, 'invalid value for "opts[:"strong_sells_less"]" when calling ZacksApi.get_zacks_analyst_ratings, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'total_greater'].nil? && opts[:'total_greater'] < 0
    fail ArgumentError, 'invalid value for "opts[:"total_greater"]" when calling ZacksApi.get_zacks_analyst_ratings, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'total_less'].nil? && opts[:'total_less'] < 0
    fail ArgumentError, 'invalid value for "opts[:"total_less"]" when calling ZacksApi.get_zacks_analyst_ratings, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ZacksApi.get_zacks_analyst_ratings, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/zacks/analyst_ratings"

  # query parameters
  query_params = {}
  query_params[:'identifier'] = opts[:'identifier'] if !opts[:'identifier'].nil?
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'mean_greater'] = opts[:'mean_greater'] if !opts[:'mean_greater'].nil?
  query_params[:'mean_less'] = opts[:'mean_less'] if !opts[:'mean_less'].nil?
  query_params[:'strong_buys_greater'] = opts[:'strong_buys_greater'] if !opts[:'strong_buys_greater'].nil?
  query_params[:'strong_buys_less'] = opts[:'strong_buys_less'] if !opts[:'strong_buys_less'].nil?
  query_params[:'buys_greater'] = opts[:'buys_greater'] if !opts[:'buys_greater'].nil?
  query_params[:'buys_less'] = opts[:'buys_less'] if !opts[:'buys_less'].nil?
  query_params[:'holds_greater'] = opts[:'holds_greater'] if !opts[:'holds_greater'].nil?
  query_params[:'holds_less'] = opts[:'holds_less'] if !opts[:'holds_less'].nil?
  query_params[:'sells_greater'] = opts[:'sells_greater'] if !opts[:'sells_greater'].nil?
  query_params[:'sells_less'] = opts[:'sells_less'] if !opts[:'sells_less'].nil?
  query_params[:'strong_sells_greater'] = opts[:'strong_sells_greater'] if !opts[:'strong_sells_greater'].nil?
  query_params[:'strong_sells_less'] = opts[:'strong_sells_less'] if !opts[:'strong_sells_less'].nil?
  query_params[:'total_greater'] = opts[:'total_greater'] if !opts[:'total_greater'].nil?
  query_params[:'total_less'] = opts[:'total_less'] if !opts[:'total_less'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiResponseZacksAnalystRatings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZacksApi#get_zacks_analyst_ratings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_zacks_ebitda_consensus(opts = {}) ⇒ ApiResponseZacksEBITDAConsensus

Zacks EBITDA Consensus This database offers consensus EBITDA-related estimates for over 4,000 US and Canadian listed companies.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :identifier (String) —

    A Company identifier (Ticker, CIK, LEI, Intrinio ID)

  • :type (String) —

    Limit EBITDA estimates to this type

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



202
203
204
205
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 202

def get_zacks_ebitda_consensus(opts = {})
  data, _status_code, _headers = get_zacks_ebitda_consensus_with_http_info(opts)
  return data
end

#get_zacks_ebitda_consensus_with_http_info(opts = {}) ⇒ Array<(ApiResponseZacksEBITDAConsensus, Fixnum, Hash)>

Zacks EBITDA Consensus This database offers consensus EBITDA-related estimates for over 4,000 US and Canadian listed companies.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :identifier (String) —

    A Company identifier (Ticker, CIK, LEI, Intrinio ID)

  • :type (String) —

    Limit EBITDA estimates to this type

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 214

def get_zacks_ebitda_consensus_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ZacksApi.get_zacks_ebitda_consensus ..."
  end
  # resource path
  local_var_path = "/zacks/ebitda_consensus"

  # query parameters
  query_params = {}
  query_params[:'identifier'] = opts[:'identifier'] if !opts[:'identifier'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiResponseZacksEBITDAConsensus')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZacksApi#get_zacks_ebitda_consensus\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_zacks_eps_estimates(opts = {}) ⇒ ApiResponseZacksEPSEstimates

Zacks EPS Estimates This database offers consensus earnings estimates for over 5,000 US and Canadian listed companies.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :identifier (String) —

    A Company identifier (Ticker, CIK, LEI, Intrinio ID)

  • :start_date (Date) —

    Limit EPS estimates to those on or after this date

  • :end_date (Date) —

    Limit EPS estimates to those on or before this date

  • :fiscal_year (Integer) —

    Only for the given fiscal year

  • :fiscal_period (String) —

    The fiscal period

  • :calendar_year (Integer) —

    Only for the given calendar year

  • :calendar_period (String) —

    The calendar period

  • :page_size (Integer) —

    The number of results to return (default to 100)

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



264
265
266
267
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 264

def get_zacks_eps_estimates(opts = {})
  data, _status_code, _headers = get_zacks_eps_estimates_with_http_info(opts)
  return data
end

#get_zacks_eps_estimates_with_http_info(opts = {}) ⇒ Array<(ApiResponseZacksEPSEstimates, Fixnum, Hash)>

Zacks EPS Estimates This database offers consensus earnings estimates for over 5,000 US and Canadian listed companies.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :identifier (String) —

    A Company identifier (Ticker, CIK, LEI, Intrinio ID)

  • :start_date (Date) —

    Limit EPS estimates to those on or after this date

  • :end_date (Date) —

    Limit EPS estimates to those on or before this date

  • :fiscal_year (Integer) —

    Only for the given fiscal year

  • :fiscal_period (String) —

    The fiscal period

  • :calendar_year (Integer) —

    Only for the given calendar year

  • :calendar_period (String) —

    The calendar period

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 282

def get_zacks_eps_estimates_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ZacksApi.get_zacks_eps_estimates ..."
  end
  if @api_client.config.client_side_validation && opts[:'fiscal_period'] && !['Q1TTM', 'Q2TTM', 'Q3TTM', 'FY', 'Q1', 'Q2', 'Q3', 'Q4', 'Q2YTD', 'Q3YTD'].include?(opts[:'fiscal_period'])
    fail ArgumentError, 'invalid value for "fiscal_period", must be one of Q1TTM, Q2TTM, Q3TTM, FY, Q1, Q2, Q3, Q4, Q2YTD, Q3YTD'
  end
  if @api_client.config.client_side_validation && opts[:'calendar_period'] && !['Q1TTM', 'Q2TTM', 'Q3TTM', 'FY', 'Q1', 'Q2', 'Q3', 'Q4', 'Q2YTD', 'Q3YTD'].include?(opts[:'calendar_period'])
    fail ArgumentError, 'invalid value for "calendar_period", must be one of Q1TTM, Q2TTM, Q3TTM, FY, Q1, Q2, Q3, Q4, Q2YTD, Q3YTD'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ZacksApi.get_zacks_eps_estimates, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/zacks/eps_estimates"

  # query parameters
  query_params = {}
  query_params[:'identifier'] = opts[:'identifier'] if !opts[:'identifier'].nil?
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'fiscal_year'] = opts[:'fiscal_year'] if !opts[:'fiscal_year'].nil?
  query_params[:'fiscal_period'] = opts[:'fiscal_period'] if !opts[:'fiscal_period'].nil?
  query_params[:'calendar_year'] = opts[:'calendar_year'] if !opts[:'calendar_year'].nil?
  query_params[:'calendar_period'] = opts[:'calendar_period'] if !opts[:'calendar_period'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiResponseZacksEPSEstimates')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZacksApi#get_zacks_eps_estimates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_zacks_eps_growth_rates(opts = {}) ⇒ ApiResponseZacksEPSGrowthRates

Zacks EPS Growth Rates This database offers consensus EPS growth rate estimates, comparing company estimates to historical company estimates, industry estimates, and S&P 500 index estimates.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :company (String) —

    Filings for the given &#x60;company&#x60; identifier (ticker, CIK, LEI, Intrinio ID)

  • :industry_group_name (String) —

    Return only growth rates for companies in the given Zacks industry group name

  • :industry_group_number (String) —

    Return only growth rates for companies in the given Zacks industry group number

  • :page_size (Integer) —

    The number of results to return (default to 100)

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



344
345
346
347
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 344

def get_zacks_eps_growth_rates(opts = {})
  data, _status_code, _headers = get_zacks_eps_growth_rates_with_http_info(opts)
  return data
end

#get_zacks_eps_growth_rates_with_http_info(opts = {}) ⇒ Array<(ApiResponseZacksEPSGrowthRates, Fixnum, Hash)>

Zacks EPS Growth Rates This database offers consensus EPS growth rate estimates, comparing company estimates to historical company estimates, industry estimates, and S&amp;P 500 index estimates.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :company (String) —

    Filings for the given &#x60;company&#x60; identifier (ticker, CIK, LEI, Intrinio ID)

  • :industry_group_name (String) —

    Return only growth rates for companies in the given Zacks industry group name

  • :industry_group_number (String) —

    Return only growth rates for companies in the given Zacks industry group number

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 358

def get_zacks_eps_growth_rates_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ZacksApi.get_zacks_eps_growth_rates ..."
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ZacksApi.get_zacks_eps_growth_rates, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/zacks/eps_growth_rates"

  # query parameters
  query_params = {}
  query_params[:'company'] = opts[:'company'] if !opts[:'company'].nil?
  query_params[:'industry_group_name'] = opts[:'industry_group_name'] if !opts[:'industry_group_name'].nil?
  query_params[:'industry_group_number'] = opts[:'industry_group_number'] if !opts[:'industry_group_number'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiResponseZacksEPSGrowthRates')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZacksApi#get_zacks_eps_growth_rates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_zacks_eps_surprises(opts = {}) ⇒ ApiResponseZacksEPSSurprises

Zacks EPS Surprises This database returns historical estimated and actual earnings, guidance, and announcement dates for 17,000+ US and Canadian listed companies.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :start_date (Date) —

    Limit EPS surprises to those on or after this date

  • :end_date (Date) —

    Limit EPS surprises to those on or before this date

  • :eps_actual_greater (Float) —

    Return only records with an actual EPS higher than this value

  • :eps_actual_less (Float) —

    Return only records with an actual EPS lower than this value

  • :eps_mean_estimate_greater (Float) —

    Return only records with an EPS mean estimate greater than this value

  • :eps_mean_estimate_less (Float) —

    Return only records with an EPS mean estimate lower than this value

  • :eps_amount_diff_greater (Float) —

    Return only records with an EPS amount difference greater than this value

  • :eps_amount_diff_less (Float) —

    Return only records with an EPS amount difference less than this value

  • :eps_percent_diff_greater (Float) —

    Return only records with an EPS percent difference greater than this value

  • :eps_percent_diff_less (Float) —

    Return only records with an EPS percent difference less than this value

  • :eps_count_estimate_greater (Float) —

    Return only records with an EPS count estimate greater than this value

  • :eps_count_estimate_less (Float) —

    Return only records with an EPS count estimate less than this value

  • :eps_std_dev_estimate_greater (Float) —

    Return only records with an EPS standard deviation greater than this value

  • :eps_std_dev_estimate_less (Float) —

    Return only records with an EPS standard deviation less than this value

  • :page_size (Integer) —

    The number of results to return (default to 100)

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



421
422
423
424
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 421

def get_zacks_eps_surprises(opts = {})
  data, _status_code, _headers = get_zacks_eps_surprises_with_http_info(opts)
  return data
end

#get_zacks_eps_surprises_with_http_info(opts = {}) ⇒ Array<(ApiResponseZacksEPSSurprises, Fixnum, Hash)>

Zacks EPS Surprises This database returns historical estimated and actual earnings, guidance, and announcement dates for 17,000+ US and Canadian listed companies.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :start_date (Date) —

    Limit EPS surprises to those on or after this date

  • :end_date (Date) —

    Limit EPS surprises to those on or before this date

  • :eps_actual_greater (Float) —

    Return only records with an actual EPS higher than this value

  • :eps_actual_less (Float) —

    Return only records with an actual EPS lower than this value

  • :eps_mean_estimate_greater (Float) —

    Return only records with an EPS mean estimate greater than this value

  • :eps_mean_estimate_less (Float) —

    Return only records with an EPS mean estimate lower than this value

  • :eps_amount_diff_greater (Float) —

    Return only records with an EPS amount difference greater than this value

  • :eps_amount_diff_less (Float) —

    Return only records with an EPS amount difference less than this value

  • :eps_percent_diff_greater (Float) —

    Return only records with an EPS percent difference greater than this value

  • :eps_percent_diff_less (Float) —

    Return only records with an EPS percent difference less than this value

  • :eps_count_estimate_greater (Float) —

    Return only records with an EPS count estimate greater than this value

  • :eps_count_estimate_less (Float) —

    Return only records with an EPS count estimate less than this value

  • :eps_std_dev_estimate_greater (Float) —

    Return only records with an EPS standard deviation greater than this value

  • :eps_std_dev_estimate_less (Float) —

    Return only records with an EPS standard deviation less than this value

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 446

def get_zacks_eps_surprises_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ZacksApi.get_zacks_eps_surprises ..."
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ZacksApi.get_zacks_eps_surprises, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/zacks/eps_surprises"

  # query parameters
  query_params = {}
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'eps_actual_greater'] = opts[:'eps_actual_greater'] if !opts[:'eps_actual_greater'].nil?
  query_params[:'eps_actual_less'] = opts[:'eps_actual_less'] if !opts[:'eps_actual_less'].nil?
  query_params[:'eps_mean_estimate_greater'] = opts[:'eps_mean_estimate_greater'] if !opts[:'eps_mean_estimate_greater'].nil?
  query_params[:'eps_mean_estimate_less'] = opts[:'eps_mean_estimate_less'] if !opts[:'eps_mean_estimate_less'].nil?
  query_params[:'eps_amount_diff_greater'] = opts[:'eps_amount_diff_greater'] if !opts[:'eps_amount_diff_greater'].nil?
  query_params[:'eps_amount_diff_less'] = opts[:'eps_amount_diff_less'] if !opts[:'eps_amount_diff_less'].nil?
  query_params[:'eps_percent_diff_greater'] = opts[:'eps_percent_diff_greater'] if !opts[:'eps_percent_diff_greater'].nil?
  query_params[:'eps_percent_diff_less'] = opts[:'eps_percent_diff_less'] if !opts[:'eps_percent_diff_less'].nil?
  query_params[:'eps_count_estimate_greater'] = opts[:'eps_count_estimate_greater'] if !opts[:'eps_count_estimate_greater'].nil?
  query_params[:'eps_count_estimate_less'] = opts[:'eps_count_estimate_less'] if !opts[:'eps_count_estimate_less'].nil?
  query_params[:'eps_std_dev_estimate_greater'] = opts[:'eps_std_dev_estimate_greater'] if !opts[:'eps_std_dev_estimate_greater'].nil?
  query_params[:'eps_std_dev_estimate_less'] = opts[:'eps_std_dev_estimate_less'] if !opts[:'eps_std_dev_estimate_less'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiResponseZacksEPSSurprises')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZacksApi#get_zacks_eps_surprises\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_zacks_etf_holdings(opts = {}) ⇒ ApiResponseZacksETFHoldings

Zacks ETF Holdings Returns Zacks ETF holdings data

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :etf_ticker (String) —

    Return holdings of the ETF with the given ticker

  • :holding_symbol (String) —

    Return holdings where the instrument being held has the given trading symbol

  • :weight_greater (Float) —

    Return on the holdings with a weight greater than

  • :weight_less (Float) —

    Return on the holdings with a weight less than

  • :page_size (Integer) —

    The number of results to return (default to 100)

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



510
511
512
513
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 510

def get_zacks_etf_holdings(opts = {})
  data, _status_code, _headers = get_zacks_etf_holdings_with_http_info(opts)
  return data
end

#get_zacks_etf_holdings_with_http_info(opts = {}) ⇒ Array<(ApiResponseZacksETFHoldings, Fixnum, Hash)>

Zacks ETF Holdings Returns Zacks ETF holdings data

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :etf_ticker (String) —

    Return holdings of the ETF with the given ticker

  • :holding_symbol (String) —

    Return holdings where the instrument being held has the given trading symbol

  • :weight_greater (Float) —

    Return on the holdings with a weight greater than

  • :weight_less (Float) —

    Return on the holdings with a weight less than

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 525

def get_zacks_etf_holdings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ZacksApi.get_zacks_etf_holdings ..."
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ZacksApi.get_zacks_etf_holdings, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/zacks/etf_holdings"

  # query parameters
  query_params = {}
  query_params[:'etf_ticker'] = opts[:'etf_ticker'] if !opts[:'etf_ticker'].nil?
  query_params[:'holding_symbol'] = opts[:'holding_symbol'] if !opts[:'holding_symbol'].nil?
  query_params[:'weight_greater'] = opts[:'weight_greater'] if !opts[:'weight_greater'].nil?
  query_params[:'weight_less'] = opts[:'weight_less'] if !opts[:'weight_less'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiResponseZacksETFHoldings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZacksApi#get_zacks_etf_holdings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_zacks_forward_pe(opts = {}) ⇒ ApiResponseZacksForwardPEs

Zacks Forward PE Estimates This database offers price-to-earning ratio estimates for over 4,000 US and Canadian listed companies.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



574
575
576
577
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 574

def get_zacks_forward_pe(opts = {})
  data, _status_code, _headers = get_zacks_forward_pe_with_http_info(opts)
  return data
end

#get_zacks_forward_pe_by_identifier(identifier, opts = {}) ⇒ ZacksForwardPE

Zacks Forward PE by identifer Returns the forward PE estimates for the identifier

Parameters:

  • identifier —

    An Intrinio ID or ticker for a Security

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



624
625
626
627
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 624

def get_zacks_forward_pe_by_identifier(identifier, opts = {})
  data, _status_code, _headers = get_zacks_forward_pe_by_identifier_with_http_info(identifier, opts)
  return data
end

#get_zacks_forward_pe_by_identifier_with_http_info(identifier, opts = {}) ⇒ Array<(ZacksForwardPE, Fixnum, Hash)>

Zacks Forward PE by identifer Returns the forward PE estimates for the identifier

Parameters:

  • identifier —

    An Intrinio ID or ticker for a Security

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ZacksForwardPE, Fixnum, Hash)>) —

    ZacksForwardPE data, response status code and response headers



634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 634

def get_zacks_forward_pe_by_identifier_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ZacksApi.get_zacks_forward_pe_by_identifier ..."
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling ZacksApi.get_zacks_forward_pe_by_identifier"
  end
  # resource path
  local_var_path = "/zacks/forward_pe/{identifier}".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ZacksForwardPE')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZacksApi#get_zacks_forward_pe_by_identifier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_zacks_forward_pe_with_http_info(opts = {}) ⇒ Array<(ApiResponseZacksForwardPEs, Fixnum, Hash)>

Zacks Forward PE Estimates This database offers price-to-earning ratio estimates for over 4,000 US and Canadian listed companies.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:

  • (Array<(ApiResponseZacksForwardPEs, Fixnum, Hash)>) —

    ApiResponseZacksForwardPEs data, response status code and response headers



584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 584

def get_zacks_forward_pe_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ZacksApi.get_zacks_forward_pe ..."
  end
  # resource path
  local_var_path = "/zacks/forward_pe"

  # query parameters
  query_params = {}
  query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiResponseZacksForwardPEs')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZacksApi#get_zacks_forward_pe\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_zacks_institutional_holding_companies(opts = {}) ⇒ ApiResponseZacksInstitutionalHoldingCompanies

Zacks Institutional Holding Companies Returns Zacks institutional holding companies data

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :ticker (String) —

    Return companies with the given ticker

  • :page_size (Integer) —

    The number of results to return (default to 100)

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



679
680
681
682
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 679

def get_zacks_institutional_holding_companies(opts = {})
  data, _status_code, _headers = get_zacks_institutional_holding_companies_with_http_info(opts)
  return data
end

#get_zacks_institutional_holding_companies_with_http_info(opts = {}) ⇒ Array<(ApiResponseZacksInstitutionalHoldingCompanies, Fixnum, Hash)>

Zacks Institutional Holding Companies Returns Zacks institutional holding companies data

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :ticker (String) —

    Return companies with the given ticker

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 691

def get_zacks_institutional_holding_companies_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ZacksApi.get_zacks_institutional_holding_companies ..."
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ZacksApi.get_zacks_institutional_holding_companies, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/zacks/institutional_holdings/companies"

  # query parameters
  query_params = {}
  query_params[:'ticker'] = opts[:'ticker'] if !opts[:'ticker'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiResponseZacksInstitutionalHoldingCompanies')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZacksApi#get_zacks_institutional_holding_companies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_zacks_institutional_holding_owners(opts = {}) ⇒ ApiResponseZacksInstitutionalHoldingOwners

Zacks Institutional Holding Owners Returns Zacks institutional holding owners data

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cik (String) —

    Return owners with the given Central Index Key (CIK)

  • :page_size (Integer) —

    The number of results to return (default to 100)

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



739
740
741
742
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 739

def get_zacks_institutional_holding_owners(opts = {})
  data, _status_code, _headers = get_zacks_institutional_holding_owners_with_http_info(opts)
  return data
end

#get_zacks_institutional_holding_owners_with_http_info(opts = {}) ⇒ Array<(ApiResponseZacksInstitutionalHoldingOwners, Fixnum, Hash)>

Zacks Institutional Holding Owners Returns Zacks institutional holding owners data

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :cik (String) —

    Return owners with the given Central Index Key (CIK)

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 751

def get_zacks_institutional_holding_owners_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ZacksApi.get_zacks_institutional_holding_owners ..."
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ZacksApi.get_zacks_institutional_holding_owners, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/zacks/institutional_holdings/owners"

  # query parameters
  query_params = {}
  query_params[:'cik'] = opts[:'cik'] if !opts[:'cik'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiResponseZacksInstitutionalHoldingOwners')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZacksApi#get_zacks_institutional_holding_owners\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_zacks_institutional_holdings(opts = {}) ⇒ ApiResponseZacksInstitutionalHoldings

Zacks Institutional Holdings Returns Zacks institutional holdings data

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :ticker (String) —

    Return holdings where the company being held has the given ticker

  • :owner_cik (String) —

    Return holdings where the owner/holder has the given Central Index Key (CIK)

  • :page_size (Integer) —

    The number of results to return (default to 100)

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



800
801
802
803
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 800

def get_zacks_institutional_holdings(opts = {})
  data, _status_code, _headers = get_zacks_institutional_holdings_with_http_info(opts)
  return data
end

#get_zacks_institutional_holdings_with_http_info(opts = {}) ⇒ Array<(ApiResponseZacksInstitutionalHoldings, Fixnum, Hash)>

Zacks Institutional Holdings Returns Zacks institutional holdings data

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :ticker (String) —

    Return holdings where the company being held has the given ticker

  • :owner_cik (String) —

    Return holdings where the owner/holder has the given Central Index Key (CIK)

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 813

def get_zacks_institutional_holdings_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ZacksApi.get_zacks_institutional_holdings ..."
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ZacksApi.get_zacks_institutional_holdings, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/zacks/institutional_holdings"

  # query parameters
  query_params = {}
  query_params[:'ticker'] = opts[:'ticker'] if !opts[:'ticker'].nil?
  query_params[:'owner_cik'] = opts[:'owner_cik'] if !opts[:'owner_cik'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiResponseZacksInstitutionalHoldings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZacksApi#get_zacks_institutional_holdings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_zacks_long_term_growth_rates(opts = {}) ⇒ ApiResponseZacksLongTermGrowthRates

Zacks Long Term Growth Rates This database offers consensus long term growth rate estimates, including insight into changes in estimates and revisions over time.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :identifier (String) —

    A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)

  • :page_size (Integer) —

    The number of results to return (default to 100)

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



862
863
864
865
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 862

def get_zacks_long_term_growth_rates(opts = {})
  data, _status_code, _headers = get_zacks_long_term_growth_rates_with_http_info(opts)
  return data
end

#get_zacks_long_term_growth_rates_with_http_info(opts = {}) ⇒ Array<(ApiResponseZacksLongTermGrowthRates, Fixnum, Hash)>

Zacks Long Term Growth Rates This database offers consensus long term growth rate estimates, including insight into changes in estimates and revisions over time.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :identifier (String) —

    A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID)

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 874

def get_zacks_long_term_growth_rates_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ZacksApi.get_zacks_long_term_growth_rates ..."
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ZacksApi.get_zacks_long_term_growth_rates, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/zacks/long_term_growth_rates"

  # query parameters
  query_params = {}
  query_params[:'identifier'] = opts[:'identifier'] if !opts[:'identifier'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiResponseZacksLongTermGrowthRates')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZacksApi#get_zacks_long_term_growth_rates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_zacks_sales_estimates(opts = {}) ⇒ ApiResponseZacksSalesEstimates

Zacks Sales Estimates This database offers consensus sales estimates for over 5,000 US and Canadian listed companies.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :identifier (String) —

    A Company identifier (Ticker, CIK, LEI, Intrinio ID)

  • :start_date (Date) —

    Limit Sales estimates to those on or after this date

  • :end_date (Date) —

    Limit Sales estimates to those on or before this date

  • :fiscal_year (Integer) —

    Only for the given fiscal year

  • :fiscal_period (String) —

    The fiscal period

  • :calendar_year (Integer) —

    Only for the given calendar year

  • :calendar_period (String) —

    The calendar period

  • :next_page (String) —

    Gets the next page of data from a previous API call

  • :page_size (Integer) —

    The number of results to return (default to 100)

  • :next_page2 (String) —

    Gets the next page of data from a previous API call

Returns:



929
930
931
932
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 929

def get_zacks_sales_estimates(opts = {})
  data, _status_code, _headers = get_zacks_sales_estimates_with_http_info(opts)
  return data
end

#get_zacks_sales_estimates_with_http_info(opts = {}) ⇒ Array<(ApiResponseZacksSalesEstimates, Fixnum, Hash)>

Zacks Sales Estimates This database offers consensus sales estimates for over 5,000 US and Canadian listed companies.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :identifier (String) —

    A Company identifier (Ticker, CIK, LEI, Intrinio ID)

  • :start_date (Date) —

    Limit Sales estimates to those on or after this date

  • :end_date (Date) —

    Limit Sales estimates to those on or before this date

  • :fiscal_year (Integer) —

    Only for the given fiscal year

  • :fiscal_period (String) —

    The fiscal period

  • :calendar_year (Integer) —

    Only for the given calendar year

  • :calendar_period (String) —

    The calendar period

  • :next_page (String) —

    Gets the next page of data from a previous API call

  • :page_size (Integer) —

    The number of results to return

  • :next_page2 (String) —

    Gets the next page of data from a previous API call

Returns:



948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 948

def get_zacks_sales_estimates_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ZacksApi.get_zacks_sales_estimates ..."
  end
  if @api_client.config.client_side_validation && opts[:'fiscal_period'] && !['Q1TTM', 'Q2TTM', 'Q3TTM', 'FY', 'Q1', 'Q2', 'Q3', 'Q4', 'Q2YTD', 'Q3YTD'].include?(opts[:'fiscal_period'])
    fail ArgumentError, 'invalid value for "fiscal_period", must be one of Q1TTM, Q2TTM, Q3TTM, FY, Q1, Q2, Q3, Q4, Q2YTD, Q3YTD'
  end
  if @api_client.config.client_side_validation && opts[:'calendar_period'] && !['Q1TTM', 'Q2TTM', 'Q3TTM', 'FY', 'Q1', 'Q2', 'Q3', 'Q4', 'Q2YTD', 'Q3YTD'].include?(opts[:'calendar_period'])
    fail ArgumentError, 'invalid value for "calendar_period", must be one of Q1TTM, Q2TTM, Q3TTM, FY, Q1, Q2, Q3, Q4, Q2YTD, Q3YTD'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ZacksApi.get_zacks_sales_estimates, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/zacks/sales_estimates"

  # query parameters
  query_params = {}
  query_params[:'identifier'] = opts[:'identifier'] if !opts[:'identifier'].nil?
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'fiscal_year'] = opts[:'fiscal_year'] if !opts[:'fiscal_year'].nil?
  query_params[:'fiscal_period'] = opts[:'fiscal_period'] if !opts[:'fiscal_period'].nil?
  query_params[:'calendar_year'] = opts[:'calendar_year'] if !opts[:'calendar_year'].nil?
  query_params[:'calendar_period'] = opts[:'calendar_period'] if !opts[:'calendar_period'].nil?
  query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'next_page'] = opts[:'next_page2'] if !opts[:'next_page2'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiResponseZacksSalesEstimates')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZacksApi#get_zacks_sales_estimates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_zacks_sales_surprises(opts = {}) ⇒ ApiResponseZacksSalesSurprises

Zacks Sales Surprises This database returns historical estimated and actual sales, guidance, and announcement dates for 17,000+ US and Canadian listed companies.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :start_date (Date) —

    Limit sales surprises to those on or after this date

  • :end_date (Date) —

    Limit sales surprises to those on or before this date

  • :sales_actual_greater (Float) —

    Return only records with an actual sales higher than this value

  • :sales_actual_less (Float) —

    Return only records with an actual sales lower than this value

  • :sales_mean_estimate_greater (Float) —

    Return only records with a sales mean estimate greater than this value

  • :sales_mean_estimate_less (Float) —

    Return only records with a sales mean estimate lower than this value

  • :sales_amount_diff_greater (Float) —

    Return only records with a sales amount difference greater than this value

  • :sales_amount_diff_less (Float) —

    Return only records with a sales amount difference less than this value

  • :sales_percent_diff_greater (Float) —

    Return only records with a sales percent difference greater than this value

  • :sales_percent_diff_less (Float) —

    Return only records with a sales percent difference less than this value

  • :sales_count_estimate_greater (Float) —

    Return only records with a sales count estimate greater than this value

  • :sales_count_estimate_less (Float) —

    Return only records with a sales count estimate less than this value

  • :sales_std_dev_estimate_greater (Float) —

    Return only records with a sales standard deviation greater than this value

  • :sales_std_dev_estimate_less (Float) —

    Return only records with a sales standard deviation less than this value

  • :page_size (Integer) —

    The number of results to return (default to 100)

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



1022
1023
1024
1025
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 1022

def get_zacks_sales_surprises(opts = {})
  data, _status_code, _headers = get_zacks_sales_surprises_with_http_info(opts)
  return data
end

#get_zacks_sales_surprises_with_http_info(opts = {}) ⇒ Array<(ApiResponseZacksSalesSurprises, Fixnum, Hash)>

Zacks Sales Surprises This database returns historical estimated and actual sales, guidance, and announcement dates for 17,000+ US and Canadian listed companies.

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :start_date (Date) —

    Limit sales surprises to those on or after this date

  • :end_date (Date) —

    Limit sales surprises to those on or before this date

  • :sales_actual_greater (Float) —

    Return only records with an actual sales higher than this value

  • :sales_actual_less (Float) —

    Return only records with an actual sales lower than this value

  • :sales_mean_estimate_greater (Float) —

    Return only records with a sales mean estimate greater than this value

  • :sales_mean_estimate_less (Float) —

    Return only records with a sales mean estimate lower than this value

  • :sales_amount_diff_greater (Float) —

    Return only records with a sales amount difference greater than this value

  • :sales_amount_diff_less (Float) —

    Return only records with a sales amount difference less than this value

  • :sales_percent_diff_greater (Float) —

    Return only records with a sales percent difference greater than this value

  • :sales_percent_diff_less (Float) —

    Return only records with a sales percent difference less than this value

  • :sales_count_estimate_greater (Float) —

    Return only records with a sales count estimate greater than this value

  • :sales_count_estimate_less (Float) —

    Return only records with a sales count estimate less than this value

  • :sales_std_dev_estimate_greater (Float) —

    Return only records with a sales standard deviation greater than this value

  • :sales_std_dev_estimate_less (Float) —

    Return only records with a sales standard deviation less than this value

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 1047

def get_zacks_sales_surprises_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ZacksApi.get_zacks_sales_surprises ..."
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ZacksApi.get_zacks_sales_surprises, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/zacks/sales_surprises"

  # query parameters
  query_params = {}
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'sales_actual_greater'] = opts[:'sales_actual_greater'] if !opts[:'sales_actual_greater'].nil?
  query_params[:'sales_actual_less'] = opts[:'sales_actual_less'] if !opts[:'sales_actual_less'].nil?
  query_params[:'sales_mean_estimate_greater'] = opts[:'sales_mean_estimate_greater'] if !opts[:'sales_mean_estimate_greater'].nil?
  query_params[:'sales_mean_estimate_less'] = opts[:'sales_mean_estimate_less'] if !opts[:'sales_mean_estimate_less'].nil?
  query_params[:'sales_amount_diff_greater'] = opts[:'sales_amount_diff_greater'] if !opts[:'sales_amount_diff_greater'].nil?
  query_params[:'sales_amount_diff_less'] = opts[:'sales_amount_diff_less'] if !opts[:'sales_amount_diff_less'].nil?
  query_params[:'sales_percent_diff_greater'] = opts[:'sales_percent_diff_greater'] if !opts[:'sales_percent_diff_greater'].nil?
  query_params[:'sales_percent_diff_less'] = opts[:'sales_percent_diff_less'] if !opts[:'sales_percent_diff_less'].nil?
  query_params[:'sales_count_estimate_greater'] = opts[:'sales_count_estimate_greater'] if !opts[:'sales_count_estimate_greater'].nil?
  query_params[:'sales_count_estimate_less'] = opts[:'sales_count_estimate_less'] if !opts[:'sales_count_estimate_less'].nil?
  query_params[:'sales_std_dev_estimate_greater'] = opts[:'sales_std_dev_estimate_greater'] if !opts[:'sales_std_dev_estimate_greater'].nil?
  query_params[:'sales_std_dev_estimate_less'] = opts[:'sales_std_dev_estimate_less'] if !opts[:'sales_std_dev_estimate_less'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiResponseZacksSalesSurprises')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZacksApi#get_zacks_sales_surprises\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_zacks_target_price_consensuses(opts = {}) ⇒ ApiResponseZacksTargetPriceConsensuses

Zacks Target Price Consensuses Returns the latest Zacks target price consensus data

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :identifier (String) —

    Filings for the given &#x60;company&#x60; identifier (ticker, CIK, LEI, Intrinio ID)

  • :industry_group_number (String) —

    Return only growth rates for companies in the given Zacks industry group number

  • :page_size (Integer) —

    The number of results to return (default to 100)

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



1109
1110
1111
1112
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 1109

def get_zacks_target_price_consensuses(opts = {})
  data, _status_code, _headers = get_zacks_target_price_consensuses_with_http_info(opts)
  return data
end

#get_zacks_target_price_consensuses_with_http_info(opts = {}) ⇒ Array<(ApiResponseZacksTargetPriceConsensuses, Fixnum, Hash)>

Zacks Target Price Consensuses Returns the latest Zacks target price consensus data

Parameters:

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :identifier (String) —

    Filings for the given &#x60;company&#x60; identifier (ticker, CIK, LEI, Intrinio ID)

  • :industry_group_number (String) —

    Return only growth rates for companies in the given Zacks industry group number

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 1122

def get_zacks_target_price_consensuses_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: ZacksApi.get_zacks_target_price_consensuses ..."
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 10000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling ZacksApi.get_zacks_target_price_consensuses, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/zacks/target_price_consensuses"

  # query parameters
  query_params = {}
  query_params[:'identifier'] = opts[:'identifier'] if !opts[:'identifier'].nil?
  query_params[:'industry_group_number'] = opts[:'industry_group_number'] if !opts[:'industry_group_number'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'next_page'] = opts[:'next_page'] if !opts[:'next_page'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ApiResponseZacksTargetPriceConsensuses')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ZacksApi#get_zacks_target_price_consensuses\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end