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_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:



208
209
210
211
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 208

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:



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 226

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:



288
289
290
291
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 288

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:



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
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 302

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:



365
366
367
368
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 365

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:



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 390

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:



454
455
456
457
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 454

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:



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
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 469

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_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:



520
521
522
523
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 520

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:



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
568
569
570
571
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 532

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:



580
581
582
583
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 580

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:



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
618
619
620
621
622
623
624
625
626
627
628
629
630
631
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 592

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:



641
642
643
644
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 641

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:



654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 654

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:



703
704
705
706
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 703

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:



715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 715

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:



770
771
772
773
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 770

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:



789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
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
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 789

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:



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

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:



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
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 888

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:



950
951
952
953
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 950

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:



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
1001
1002
1003
 
# File 'lib/intrinio-sdk/api/zacks_api.rb', line 963

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