Class: Intrinio::SecurityApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SecurityApi

Returns a new instance of SecurityApi.



19
20
21
 
# File 'lib/intrinio-sdk/api/security_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/security_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_all_securities(opts = {}) ⇒ ApiResponseSecurities

All Securities Returns all Securities to which you have access. When parameters are specified, returns matching Securities.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :active (BOOLEAN) —

    When true, return securities that are active. When false, return securities that are not active. A security is considered active if it has traded or has had a corporate action in the past 30 days, and has not been merged into another security (such as due to ticker changes or corporate restructurings).

  • :delisted (BOOLEAN) —

    When true, return securities that have been delisted from their exchange. Note that there may be a newer security for the same company that has been relisted on a differente exchange. When false, return securities that have not been delisted.

  • :code (String) —

    Return securities classified with the given code (<a href="docs.intrinio.com/documentation/security_codes" target="_blank">reference</a>).

  • :currency (String) —

    Return securities traded in the given 3-digit ISO 4217 currency code (<a href="en.wikipedia.org/wiki/ISO_4217" target="_blank">reference</a>).

  • :ticker (String) —

    Return securities traded with the given ticker. Note that securities across the world (and through time) may trade with the same ticker but represent different companies. Use this in conjuction with other parameters for more specificity.

  • :name (String) —

    Return securities with the given text in their name (not case sensitive).

  • :composite_mic (String) —

    Return securities classified under the composite exchange with the given Market Identification Code (MIC). A composite exchange may or may not be a real exchange. For example, the USCOMP exchange (our only composite exchange to date) is a combination of exchanges with the following MICs: ARCX, XASE, XPOR, FINR, XCIS, XNAS, XNYS, BATS. This composite grouping is done for user convenience. At this time, all US securities are classified under the composite exchange with MIC USCOMP. To query for specific US exchanges, use the exchange_mic parameter below.

  • :exchange_mic (String) —

    The MIC code of the exchange where the security is actually traded.

  • :stock_prices_after (Date) —

    Return securities with end-of-day stock prices on or after this date.

  • :stock_prices_before (Date) —

    Return securities with end-of-day stock prices on or before this date.

  • :cik (String) —

    Return securities belonging to the company with the given Central Index Key (CIK).

  • :figi (String) —

    Return securities with the given Exchange Level FIGI (<a href="www.openfigi.com/about" target="_blank">reference</a>).

  • :composite_figi (String) —

    Return securities with the given Country Composite FIGI (<a href="www.openfigi.com/about" target="_blank">reference</a>).

  • :share_class_figi (String) —

    Return securities with the given Global Share Class FIGI (<a href="www.openfigi.com/about" target="_blank">reference</a>).

  • :figi_unique_id (String) —

    Return securities with the given FIGI Unique ID (<a href="www.openfigi.com/about" target="_blank">reference</a>).

  • :include_non_figi (BOOLEAN) —

    When true, include securities that do not have a FIGI. By default, this is false. If this parameter is not specified, only securities with a FIGI are returned. (default to false)

  • :page_size (Integer) —

    The number of results to return (default to 100)

  • :primary_listing (BOOLEAN) —

    If true, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



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

def get_all_securities(opts = {})
  data, _status_code, _headers = get_all_securities_with_http_info(opts)
  return data
end

#get_all_securities_with_http_info(opts = {}) ⇒ Array<(ApiResponseSecurities, Fixnum, Hash)>

All Securities Returns all Securities to which you have access. When parameters are specified, returns matching Securities.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :active (BOOLEAN) —

    When true, return securities that are active. When false, return securities that are not active. A security is considered active if it has traded or has had a corporate action in the past 30 days, and has not been merged into another security (such as due to ticker changes or corporate restructurings).

  • :delisted (BOOLEAN) —

    When true, return securities that have been delisted from their exchange. Note that there may be a newer security for the same company that has been relisted on a differente exchange. When false, return securities that have not been delisted.

  • :code (String) —

    Return securities classified with the given code (&lt;a href&#x3D;&quot;docs.intrinio.com/documentation/security_codes&quot; target&#x3D;&quot;_blank&quot;&gt;reference&lt;/a&gt;).

  • :currency (String) —

    Return securities traded in the given 3-digit ISO 4217 currency code (&lt;a href&#x3D;&quot;en.wikipedia.org/wiki/ISO_4217&quot; target&#x3D;&quot;_blank&quot;&gt;reference&lt;/a&gt;).

  • :ticker (String) —

    Return securities traded with the given ticker. Note that securities across the world (and through time) may trade with the same ticker but represent different companies. Use this in conjuction with other parameters for more specificity.

  • :name (String) —

    Return securities with the given text in their name (not case sensitive).

  • :composite_mic (String) —

    Return securities classified under the composite exchange with the given Market Identification Code (MIC). A composite exchange may or may not be a real exchange. For example, the USCOMP exchange (our only composite exchange to date) is a combination of exchanges with the following MICs: ARCX, XASE, XPOR, FINR, XCIS, XNAS, XNYS, BATS. This composite grouping is done for user convenience. At this time, all US securities are classified under the composite exchange with MIC USCOMP. To query for specific US exchanges, use the exchange_mic parameter below.

  • :exchange_mic (String) —

    The MIC code of the exchange where the security is actually traded.

  • :stock_prices_after (Date) —

    Return securities with end-of-day stock prices on or after this date.

  • :stock_prices_before (Date) —

    Return securities with end-of-day stock prices on or before this date.

  • :cik (String) —

    Return securities belonging to the company with the given Central Index Key (CIK).

  • :figi (String) —

    Return securities with the given Exchange Level FIGI (&lt;a href&#x3D;&quot;www.openfigi.com/about&quot; target&#x3D;&quot;_blank&quot;&gt;reference&lt;/a&gt;).

  • :composite_figi (String) —

    Return securities with the given Country Composite FIGI (&lt;a href&#x3D;&quot;www.openfigi.com/about&quot; target&#x3D;&quot;_blank&quot;&gt;reference&lt;/a&gt;).

  • :share_class_figi (String) —

    Return securities with the given Global Share Class FIGI (&lt;a href&#x3D;&quot;www.openfigi.com/about&quot; target&#x3D;&quot;_blank&quot;&gt;reference&lt;/a&gt;).

  • :figi_unique_id (String) —

    Return securities with the given FIGI Unique ID (&lt;a href&#x3D;&quot;www.openfigi.com/about&quot; target&#x3D;&quot;_blank&quot;&gt;reference&lt;/a&gt;).

  • :include_non_figi (BOOLEAN) —

    When true, include securities that do not have a FIGI. By default, this is false. If this parameter is not specified, only securities with a FIGI are returned.

  • :page_size (Integer) —

    The number of results to return

  • :primary_listing (BOOLEAN) —

    If true, the Security is the primary issue for the company, otherwise it is a secondary issue on a secondary stock exchange

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:

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

    ApiResponseSecurities data, response status code and response headers



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
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 74

def get_all_securities_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_all_securities ..."
  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 SecurityApi.get_all_securities, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities"

  # query parameters
  query_params = {}
  query_params[:'active'] = opts[:'active'] if !opts[:'active'].nil?
  query_params[:'delisted'] = opts[:'delisted'] if !opts[:'delisted'].nil?
  query_params[:'code'] = opts[:'code'] if !opts[:'code'].nil?
  query_params[:'currency'] = opts[:'currency'] if !opts[:'currency'].nil?
  query_params[:'ticker'] = opts[:'ticker'] if !opts[:'ticker'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'composite_mic'] = opts[:'composite_mic'] if !opts[:'composite_mic'].nil?
  query_params[:'exchange_mic'] = opts[:'exchange_mic'] if !opts[:'exchange_mic'].nil?
  query_params[:'stock_prices_after'] = opts[:'stock_prices_after'] if !opts[:'stock_prices_after'].nil?
  query_params[:'stock_prices_before'] = opts[:'stock_prices_before'] if !opts[:'stock_prices_before'].nil?
  query_params[:'cik'] = opts[:'cik'] if !opts[:'cik'].nil?
  query_params[:'figi'] = opts[:'figi'] if !opts[:'figi'].nil?
  query_params[:'composite_figi'] = opts[:'composite_figi'] if !opts[:'composite_figi'].nil?
  query_params[:'share_class_figi'] = opts[:'share_class_figi'] if !opts[:'share_class_figi'].nil?
  query_params[:'figi_unique_id'] = opts[:'figi_unique_id'] if !opts[:'figi_unique_id'].nil?
  query_params[:'include_non_figi'] = opts[:'include_non_figi'] if !opts[:'include_non_figi'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'primary_listing'] = opts[:'primary_listing'] if !opts[:'primary_listing'].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 => 'ApiResponseSecurities')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_all_securities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_by_id(identifier, opts = {}) ⇒ Security

Lookup Security Returns the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Returns:



136
137
138
139
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 136

def get_security_by_id(identifier, opts = {})
  data, _status_code, _headers = get_security_by_id_with_http_info(identifier, opts)
  return data
end

#get_security_by_id_with_http_info(identifier, opts = {}) ⇒ Array<(Security, Fixnum, Hash)>

Lookup Security Returns the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Returns:

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

    Security data, response status code and response headers



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
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 146

def get_security_by_id_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_by_id ..."
  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 SecurityApi.get_security_by_id"
  end
  # resource path
  local_var_path = "/securities/{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 => 'Security')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_data_point_number(identifier, tag, opts = {}) ⇒ Float

Data Point (Number) for Security Returns a numeric value for the given ‘tag` for the Security with the given `identifier`

Parameters:

Returns:

  • (Float) 


190
191
192
193
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 190

def get_security_data_point_number(identifier, tag, opts = {})
  data, _status_code, _headers = get_security_data_point_number_with_http_info(identifier, tag, opts)
  return data
end

#get_security_data_point_number_with_http_info(identifier, tag, opts = {}) ⇒ Array<(Float, Fixnum, Hash)>

Data Point (Number) for Security Returns a numeric value for the given &#x60;tag&#x60; for the Security with the given &#x60;identifier&#x60;

Parameters:

Returns:

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

    Float data, response status code and response headers



201
202
203
204
205
206
207
208
209
210
211
212
213
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
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 201

def get_security_data_point_number_with_http_info(identifier, tag, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_data_point_number ..."
  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 SecurityApi.get_security_data_point_number"
  end
  # verify the required parameter 'tag' is set
  if @api_client.config.client_side_validation && tag.nil?
    fail ArgumentError, "Missing the required parameter 'tag' when calling SecurityApi.get_security_data_point_number"
  end
  # resource path
  local_var_path = "/securities/{identifier}/data_point/{tag}/number".sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'tag' + '}', tag.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain; charset=utf-8'])

  # 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 => 'Float')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_data_point_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_data_point_text(identifier, tag, opts = {}) ⇒ String

Data Point (Text) for Security Returns a text value for the given ‘tag` for the Security with the given `identifier`

Parameters:

  • identifier —

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

  • tag —

    An Intrinio data tag ID or code-name

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

    the optional parameters

Returns:

  • (String) 


249
250
251
252
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 249

def get_security_data_point_text(identifier, tag, opts = {})
  data, _status_code, _headers = get_security_data_point_text_with_http_info(identifier, tag, opts)
  return data
end

#get_security_data_point_text_with_http_info(identifier, tag, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Data Point (Text) for Security Returns a text value for the given &#x60;tag&#x60; for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

  • tag —

    An Intrinio data tag ID or code-name

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 260

def get_security_data_point_text_with_http_info(identifier, tag, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_data_point_text ..."
  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 SecurityApi.get_security_data_point_text"
  end
  # verify the required parameter 'tag' is set
  if @api_client.config.client_side_validation && tag.nil?
    fail ArgumentError, "Missing the required parameter 'tag' when calling SecurityApi.get_security_data_point_text"
  end
  # resource path
  local_var_path = "/securities/{identifier}/data_point/{tag}/text".sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'tag' + '}', tag.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/plain; charset=utf-8'])

  # 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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_data_point_text\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_historical_data(identifier, tag, opts = {}) ⇒ ApiResponseSecurityHistoricalData

Historical Data for Security Returns historical values for the given ‘tag` and the Security with the given `identifier`

Parameters:

Options Hash (opts):

  • :frequency (String) —

    Return historical data in the given frequency (default to daily)

  • :type (String) —

    Filter by type, when applicable

  • :start_date (Date) —

    Get historical data on or after this date

  • :end_date (Date) —

    Get historical date on or before this date

  • :sort_order (String) —

    Sort by date &#x60;asc&#x60; or &#x60;desc&#x60; (default to desc)

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



315
316
317
318
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 315

def get_security_historical_data(identifier, tag, opts = {})
  data, _status_code, _headers = get_security_historical_data_with_http_info(identifier, tag, opts)
  return data
end

#get_security_historical_data_with_http_info(identifier, tag, opts = {}) ⇒ Array<(ApiResponseSecurityHistoricalData, Fixnum, Hash)>

Historical Data for Security Returns historical values for the given &#x60;tag&#x60; and the Security with the given &#x60;identifier&#x60;

Parameters:

Options Hash (opts):

  • :frequency (String) —

    Return historical data in the given frequency

  • :type (String) —

    Filter by type, when applicable

  • :start_date (Date) —

    Get historical data on or after this date

  • :end_date (Date) —

    Get historical date on or before this date

  • :sort_order (String) —

    Sort by date &#x60;asc&#x60; or &#x60;desc&#x60;

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
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
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 333

def get_security_historical_data_with_http_info(identifier, tag, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_historical_data ..."
  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 SecurityApi.get_security_historical_data"
  end
  # verify the required parameter 'tag' is set
  if @api_client.config.client_side_validation && tag.nil?
    fail ArgumentError, "Missing the required parameter 'tag' when calling SecurityApi.get_security_historical_data"
  end
  if @api_client.config.client_side_validation && opts[:'frequency'] && !['daily', 'weekly', 'monthly', 'quarterly', 'yearly'].include?(opts[:'frequency'])
    fail ArgumentError, 'invalid value for "frequency", must be one of daily, weekly, monthly, quarterly, yearly'
  end
  if @api_client.config.client_side_validation && opts[:'sort_order'] && !['asc', 'desc'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of asc, desc'
  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 SecurityApi.get_security_historical_data, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/historical_data/{tag}".sub('{' + 'identifier' + '}', identifier.to_s).sub('{' + 'tag' + '}', tag.to_s)

  # query parameters
  query_params = {}
  query_params[:'frequency'] = opts[:'frequency'] if !opts[:'frequency'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].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[:'sort_order'] = opts[:'sort_order'] if !opts[:'sort_order'].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 => 'ApiResponseSecurityHistoricalData')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_historical_data\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_intraday_prices(identifier, opts = {}) ⇒ ApiResponseSecurityIntradayPrices

Intraday Stock Prices for Security Return intraday stock prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :source (String) —

    Return intraday prices from the specified data source

  • :start_date (Date) —

    Return intraday prices starting at the specified date

  • :start_time (String) —

    Return intraday prices starting at the specified time on the &#x60;start_date&#x60; (24-hour in &#39;hh:mm&#39; format, UTC timezone)

  • :end_date (Date) —

    Return intraday prices stopping at the specified date

  • :end_time (String) —

    Return intraday prices stopping at the specified time on the &#x60;end_date&#x60; (24-hour in &#39;hh:mm&#39; format, UTC timezone)

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



404
405
406
407
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 404

def get_security_intraday_prices(identifier, opts = {})
  data, _status_code, _headers = get_security_intraday_prices_with_http_info(identifier, opts)
  return data
end

#get_security_intraday_prices_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityIntradayPrices, Fixnum, Hash)>

Intraday Stock Prices for Security Return intraday stock prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :source (String) —

    Return intraday prices from the specified data source

  • :start_date (Date) —

    Return intraday prices starting at the specified date

  • :start_time (String) —

    Return intraday prices starting at the specified time on the &#x60;start_date&#x60; (24-hour in &#39;hh:mm&#39; format, UTC timezone)

  • :end_date (Date) —

    Return intraday prices stopping at the specified date

  • :end_time (String) —

    Return intraday prices stopping at the specified time on the &#x60;end_date&#x60; (24-hour in &#39;hh:mm&#39; format, UTC timezone)

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
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
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 421

def get_security_intraday_prices_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_intraday_prices ..."
  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 SecurityApi.get_security_intraday_prices"
  end
  if @api_client.config.client_side_validation && opts[:'source'] && !['iex', 'bats'].include?(opts[:'source'])
    fail ArgumentError, 'invalid value for "source", must be one of iex, bats'
  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 SecurityApi.get_security_intraday_prices, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/intraday".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'source'] = opts[:'source'] if !opts[:'source'].nil?
  query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
  query_params[:'start_time'] = opts[:'start_time'] if !opts[:'start_time'].nil?
  query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
  query_params[:'end_time'] = opts[:'end_time'] if !opts[:'end_time'].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 => 'ApiResponseSecurityIntradayPrices')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_intraday_prices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_latest_dividend_record(identifier, opts = {}) ⇒ DividendRecord

Latest Dividend Record for Security Returns the latest available dividend information for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Returns:



478
479
480
481
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 478

def get_security_latest_dividend_record(identifier, opts = {})
  data, _status_code, _headers = get_security_latest_dividend_record_with_http_info(identifier, opts)
  return data
end

#get_security_latest_dividend_record_with_http_info(identifier, opts = {}) ⇒ Array<(DividendRecord, Fixnum, Hash)>

Latest Dividend Record for Security Returns the latest available dividend information for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Returns:

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

    DividendRecord data, response status code and response headers



488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 488

def get_security_latest_dividend_record_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_latest_dividend_record ..."
  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 SecurityApi.get_security_latest_dividend_record"
  end
  # resource path
  local_var_path = "/securities/{identifier}/dividends/latest".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 => 'DividendRecord')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_latest_dividend_record\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_latest_earnings_record(identifier, opts = {}) ⇒ EarningsRecord

Latest Earnings Record for Security Returns latest available earnings information for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Returns:



531
532
533
534
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 531

def get_security_latest_earnings_record(identifier, opts = {})
  data, _status_code, _headers = get_security_latest_earnings_record_with_http_info(identifier, opts)
  return data
end

#get_security_latest_earnings_record_with_http_info(identifier, opts = {}) ⇒ Array<(EarningsRecord, Fixnum, Hash)>

Latest Earnings Record for Security Returns latest available earnings information for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Returns:

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

    EarningsRecord data, response status code and response headers



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
572
573
574
575
576
577
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 541

def get_security_latest_earnings_record_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_latest_earnings_record ..."
  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 SecurityApi.get_security_latest_earnings_record"
  end
  # resource path
  local_var_path = "/securities/{identifier}/earnings/latest".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 => 'EarningsRecord')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_latest_earnings_record\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_adi(identifier, opts = {}) ⇒ ApiResponseSecurityAccumulationDistributionIndex

Accumulation/Distribution Index Returns the Accumulation/Distribution Index values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

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



588
589
590
591
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 588

def get_security_price_technicals_adi(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_adi_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_adi_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityAccumulationDistributionIndex, Fixnum, Hash)>

Accumulation/Distribution Index Returns the Accumulation/Distribution Index values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



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
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 602

def get_security_price_technicals_adi_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_adi ..."
  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 SecurityApi.get_security_price_technicals_adi"
  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 SecurityApi.get_security_price_technicals_adi, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/adi".sub('{' + 'identifier' + '}', identifier.to_s)

  # 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[:'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 => 'ApiResponseSecurityAccumulationDistributionIndex')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_adi\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_adtv(identifier, opts = {}) ⇒ ApiResponseSecurityAverageDailyTradingVolume

Average Daily Trading Volume Returns the Average Daily Trading Volume values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate Average Daily Trading Volume (default to 22)

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

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



658
659
660
661
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 658

def get_security_price_technicals_adtv(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_adtv_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_adtv_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityAverageDailyTradingVolume, Fixnum, Hash)>

Average Daily Trading Volume Returns the Average Daily Trading Volume values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate Average Daily Trading Volume

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
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
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 673

def get_security_price_technicals_adtv_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_adtv ..."
  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 SecurityApi.get_security_price_technicals_adtv"
  end
  if @api_client.config.client_side_validation && !opts[:'period'].nil? && opts[:'period'] < 5
    fail ArgumentError, 'invalid value for "opts[:"period"]" when calling SecurityApi.get_security_price_technicals_adtv, must be greater than or equal to 5.'
  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 SecurityApi.get_security_price_technicals_adtv, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/adtv".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].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[:'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 => 'ApiResponseSecurityAverageDailyTradingVolume')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_adtv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_adx(identifier, opts = {}) ⇒ ApiResponseSecurityAverageDirectionalIndex

Average Directional Index Returns the Average Directional Index values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate Average Directional Index (default to 14)

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

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



734
735
736
737
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 734

def get_security_price_technicals_adx(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_adx_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_adx_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityAverageDirectionalIndex, Fixnum, Hash)>

Average Directional Index Returns the Average Directional Index values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate Average Directional Index

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



749
750
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
791
792
793
794
795
796
797
798
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 749

def get_security_price_technicals_adx_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_adx ..."
  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 SecurityApi.get_security_price_technicals_adx"
  end
  if @api_client.config.client_side_validation && !opts[:'period'].nil? && opts[:'period'] < 3
    fail ArgumentError, 'invalid value for "opts[:"period"]" when calling SecurityApi.get_security_price_technicals_adx, must be greater than or equal to 3.'
  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 SecurityApi.get_security_price_technicals_adx, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/adx".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].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[:'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 => 'ApiResponseSecurityAverageDirectionalIndex')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_adx\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_ao(identifier, opts = {}) ⇒ ApiResponseSecurityAwesomeOscillator

Awesome Oscillator Returns the Awesome Oscillator values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :short_period (Integer) —

    The number of observations, per period, to calculate short period Simple Moving Average of the Awesome Oscillator (default to 5)

  • :long_period (Integer) —

    The number of observations, per period, to calculate long period Simple Moving Average of the Awesome Oscillator (default to 34)

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

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



811
812
813
814
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 811

def get_security_price_technicals_ao(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_ao_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_ao_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityAwesomeOscillator, Fixnum, Hash)>

Awesome Oscillator Returns the Awesome Oscillator values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :short_period (Integer) —

    The number of observations, per period, to calculate short period Simple Moving Average of the Awesome Oscillator

  • :long_period (Integer) —

    The number of observations, per period, to calculate long period Simple Moving Average of the Awesome Oscillator

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



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
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 827

def get_security_price_technicals_ao_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_ao ..."
  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 SecurityApi.get_security_price_technicals_ao"
  end
  if @api_client.config.client_side_validation && !opts[:'long_period'].nil? && opts[:'long_period'] < 5
    fail ArgumentError, 'invalid value for "opts[:"long_period"]" when calling SecurityApi.get_security_price_technicals_ao, must be greater than or equal to 5.'
  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 SecurityApi.get_security_price_technicals_ao, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/ao".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'short_period'] = opts[:'short_period'] if !opts[:'short_period'].nil?
  query_params[:'long_period'] = opts[:'long_period'] if !opts[:'long_period'].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[:'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 => 'ApiResponseSecurityAwesomeOscillator')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_ao\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_atr(identifier, opts = {}) ⇒ ApiResponseSecurityAverageTrueRange

Average True Range Returns the Average True Range values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate Average True Range (default to 14)

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

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



889
890
891
892
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 889

def get_security_price_technicals_atr(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_atr_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_atr_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityAverageTrueRange, Fixnum, Hash)>

Average True Range Returns the Average True Range values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate Average True Range

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



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
941
942
943
944
945
946
947
948
949
950
951
952
953
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 904

def get_security_price_technicals_atr_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_atr ..."
  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 SecurityApi.get_security_price_technicals_atr"
  end
  if @api_client.config.client_side_validation && !opts[:'period'].nil? && opts[:'period'] < 4
    fail ArgumentError, 'invalid value for "opts[:"period"]" when calling SecurityApi.get_security_price_technicals_atr, must be greater than or equal to 4.'
  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 SecurityApi.get_security_price_technicals_atr, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/atr".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].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[:'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 => 'ApiResponseSecurityAverageTrueRange')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_atr\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_bb(identifier, opts = {}) ⇒ ApiResponseSecurityBollingerBands

Bollinger Bands Returns the Bollinger Bands values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate Bollinger Bands (default to 20)

  • :standard_deviations (Float) —

    The number of standard deviations to calculate the upper and lower bands of the Bollinger Bands (default to 2.0)

  • :price_key (String) —

    The Stock Price field to use when calculating Bollinger Bands (default to close)

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

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



967
968
969
970
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 967

def get_security_price_technicals_bb(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_bb_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_bb_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityBollingerBands, Fixnum, Hash)>

Bollinger Bands Returns the Bollinger Bands values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate Bollinger Bands

  • :standard_deviations (Float) —

    The number of standard deviations to calculate the upper and lower bands of the Bollinger Bands

  • :price_key (String) —

    The Stock Price field to use when calculating Bollinger Bands

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 984

def get_security_price_technicals_bb_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_bb ..."
  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 SecurityApi.get_security_price_technicals_bb"
  end
  if @api_client.config.client_side_validation && !opts[:'period'].nil? && opts[:'period'] < 5
    fail ArgumentError, 'invalid value for "opts[:"period"]" when calling SecurityApi.get_security_price_technicals_bb, must be greater than or equal to 5.'
  end

  if @api_client.config.client_side_validation && opts[:'price_key'] && !['open', 'high', 'low', 'close', 'volume'].include?(opts[:'price_key'])
    fail ArgumentError, 'invalid value for "price_key", must be one of open, high, low, close, volume'
  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 SecurityApi.get_security_price_technicals_bb, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/bb".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?
  query_params[:'standard_deviations'] = opts[:'standard_deviations'] if !opts[:'standard_deviations'].nil?
  query_params[:'price_key'] = opts[:'price_key'] if !opts[:'price_key'].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[:'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 => 'ApiResponseSecurityBollingerBands')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_bb\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_cci(identifier, opts = {}) ⇒ ApiResponseSecurityCommodityChannelIndex

Commodity Channel Index Returns the Commodity Channel Index values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate Commodity Channel Index (default to 20)

  • :constant (Float) —

    The number of observations, per period, to calculate Commodity Channel Index (default to 0.015)

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

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



1051
1052
1053
1054
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1051

def get_security_price_technicals_cci(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_cci_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_cci_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityCommodityChannelIndex, Fixnum, Hash)>

Commodity Channel Index Returns the Commodity Channel Index values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate Commodity Channel Index

  • :constant (Float) —

    The number of observations, per period, to calculate Commodity Channel Index

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



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
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1067

def get_security_price_technicals_cci_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_cci ..."
  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 SecurityApi.get_security_price_technicals_cci"
  end
  if @api_client.config.client_side_validation && !opts[:'period'].nil? && opts[:'period'] < 5
    fail ArgumentError, 'invalid value for "opts[:"period"]" when calling SecurityApi.get_security_price_technicals_cci, must be greater than or equal to 5.'
  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 SecurityApi.get_security_price_technicals_cci, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/cci".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?
  query_params[:'constant'] = opts[:'constant'] if !opts[:'constant'].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[:'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 => 'ApiResponseSecurityCommodityChannelIndex')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_cci\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_cmf(identifier, opts = {}) ⇒ ApiResponseSecurityChaikinMoneyFlow

Chaikin Money Flow Returns the Chaikin Money Flow values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate Chaikin Money Flow (default to 20)

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

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



1129
1130
1131
1132
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1129

def get_security_price_technicals_cmf(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_cmf_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_cmf_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityChaikinMoneyFlow, Fixnum, Hash)>

Chaikin Money Flow Returns the Chaikin Money Flow values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate Chaikin Money Flow

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1144

def get_security_price_technicals_cmf_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_cmf ..."
  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 SecurityApi.get_security_price_technicals_cmf"
  end
  if @api_client.config.client_side_validation && !opts[:'period'].nil? && opts[:'period'] < 5
    fail ArgumentError, 'invalid value for "opts[:"period"]" when calling SecurityApi.get_security_price_technicals_cmf, must be greater than or equal to 5.'
  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 SecurityApi.get_security_price_technicals_cmf, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/cmf".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].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[:'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 => 'ApiResponseSecurityChaikinMoneyFlow')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_cmf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_dc(identifier, opts = {}) ⇒ ApiResponseSecurityDonchianChannel

Donchian Channel Returns the Donchian Channel values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate Donchian Channel (default to 20)

  • :price_key (String) —

    The Stock Price field to use when calculating Donchian Channel (default to close)

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

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



1206
1207
1208
1209
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1206

def get_security_price_technicals_dc(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_dc_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_dc_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityDonchianChannel, Fixnum, Hash)>

Donchian Channel Returns the Donchian Channel values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate Donchian Channel

  • :price_key (String) —

    The Stock Price field to use when calculating Donchian Channel

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1222

def get_security_price_technicals_dc_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_dc ..."
  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 SecurityApi.get_security_price_technicals_dc"
  end
  if @api_client.config.client_side_validation && !opts[:'period'].nil? && opts[:'period'] < 5
    fail ArgumentError, 'invalid value for "opts[:"period"]" when calling SecurityApi.get_security_price_technicals_dc, must be greater than or equal to 5.'
  end

  if @api_client.config.client_side_validation && opts[:'price_key'] && !['open', 'high', 'low', 'close', 'volume'].include?(opts[:'price_key'])
    fail ArgumentError, 'invalid value for "price_key", must be one of open, high, low, close, volume'
  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 SecurityApi.get_security_price_technicals_dc, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/dc".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?
  query_params[:'price_key'] = opts[:'price_key'] if !opts[:'price_key'].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[:'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 => 'ApiResponseSecurityDonchianChannel')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_dc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_dpo(identifier, opts = {}) ⇒ ApiResponseSecurityDetrendedPriceOscillator

Detrended Price Oscillator Returns the Detrended Price Oscillator values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate Detrended Price Oscillator (default to 20)

  • :price_key (String) —

    The Stock Price field to use when calculating Detrended Price Oscillator (default to close)

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

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



1288
1289
1290
1291
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1288

def get_security_price_technicals_dpo(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_dpo_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_dpo_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityDetrendedPriceOscillator, Fixnum, Hash)>

Detrended Price Oscillator Returns the Detrended Price Oscillator values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate Detrended Price Oscillator

  • :price_key (String) —

    The Stock Price field to use when calculating Detrended Price Oscillator

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1304

def get_security_price_technicals_dpo_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_dpo ..."
  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 SecurityApi.get_security_price_technicals_dpo"
  end
  if @api_client.config.client_side_validation && opts[:'price_key'] && !['open', 'high', 'low', 'close', 'volume'].include?(opts[:'price_key'])
    fail ArgumentError, 'invalid value for "price_key", must be one of open, high, low, close, volume'
  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 SecurityApi.get_security_price_technicals_dpo, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/dpo".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?
  query_params[:'price_key'] = opts[:'price_key'] if !opts[:'price_key'].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[:'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 => 'ApiResponseSecurityDetrendedPriceOscillator')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_dpo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_eom(identifier, opts = {}) ⇒ ApiResponseSecurityEaseOfMovement

Ease of Movement Returns the Ease of Movement values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate Ease of Movement (default to 20)

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

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



1365
1366
1367
1368
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1365

def get_security_price_technicals_eom(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_eom_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_eom_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityEaseOfMovement, Fixnum, Hash)>

Ease of Movement Returns the Ease of Movement values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate Ease of Movement

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1380

def get_security_price_technicals_eom_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_eom ..."
  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 SecurityApi.get_security_price_technicals_eom"
  end
  if @api_client.config.client_side_validation && !opts[:'period'].nil? && opts[:'period'] < 4
    fail ArgumentError, 'invalid value for "opts[:"period"]" when calling SecurityApi.get_security_price_technicals_eom, must be greater than or equal to 4.'
  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 SecurityApi.get_security_price_technicals_eom, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/eom".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].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[:'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 => 'ApiResponseSecurityEaseOfMovement')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_eom\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_fi(identifier, opts = {}) ⇒ ApiResponseSecurityForceIndex

Force Index Returns the Force Index values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

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



1440
1441
1442
1443
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1440

def get_security_price_technicals_fi(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_fi_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_fi_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityForceIndex, Fixnum, Hash)>

Force Index Returns the Force Index values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1454

def get_security_price_technicals_fi_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_fi ..."
  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 SecurityApi.get_security_price_technicals_fi"
  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 SecurityApi.get_security_price_technicals_fi, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/fi".sub('{' + 'identifier' + '}', identifier.to_s)

  # 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[:'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 => 'ApiResponseSecurityForceIndex')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_fi\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_ichimoku(identifier, opts = {}) ⇒ ApiResponseSecurityIchimokuKinkoHyo

Ichimoku Kinko Hyo Returns the Ichimoku Kinko Hyo values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :low_period (Integer) —

    The number of observations, per period, to calculate Tenkan Sen (Conversion Line) of Ichimoku Kinko Hyo (default to 9)

  • :medium_period (Integer) —

    The number of observations, per period, to calculate Kijun Sen (Base Line), Senkou Span A (Leading Span A), and Chikou Span (Lagging Span) of Ichimoku Kinko Hyo (default to 26)

  • :high_period (Integer) —

    The number of observations, per period, to calculate Senkou Span B (Leading Span B) of Ichimoku Kinko Hyo (default to 52)

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

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



1512
1513
1514
1515
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1512

def get_security_price_technicals_ichimoku(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_ichimoku_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_ichimoku_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityIchimokuKinkoHyo, Fixnum, Hash)>

Ichimoku Kinko Hyo Returns the Ichimoku Kinko Hyo values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :low_period (Integer) —

    The number of observations, per period, to calculate Tenkan Sen (Conversion Line) of Ichimoku Kinko Hyo

  • :medium_period (Integer) —

    The number of observations, per period, to calculate Kijun Sen (Base Line), Senkou Span A (Leading Span A), and Chikou Span (Lagging Span) of Ichimoku Kinko Hyo

  • :high_period (Integer) —

    The number of observations, per period, to calculate Senkou Span B (Leading Span B) of Ichimoku Kinko Hyo

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1529

def get_security_price_technicals_ichimoku_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_ichimoku ..."
  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 SecurityApi.get_security_price_technicals_ichimoku"
  end
  if @api_client.config.client_side_validation && !opts[:'medium_period'].nil? && opts[:'medium_period'] < 2
    fail ArgumentError, 'invalid value for "opts[:"medium_period"]" when calling SecurityApi.get_security_price_technicals_ichimoku, must be greater than or equal to 2.'
  end

  if @api_client.config.client_side_validation && !opts[:'high_period'].nil? && opts[:'high_period'] < 4
    fail ArgumentError, 'invalid value for "opts[:"high_period"]" when calling SecurityApi.get_security_price_technicals_ichimoku, must be greater than or equal to 4.'
  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 SecurityApi.get_security_price_technicals_ichimoku, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/ichimoku".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'low_period'] = opts[:'low_period'] if !opts[:'low_period'].nil?
  query_params[:'medium_period'] = opts[:'medium_period'] if !opts[:'medium_period'].nil?
  query_params[:'high_period'] = opts[:'high_period'] if !opts[:'high_period'].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[:'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 => 'ApiResponseSecurityIchimokuKinkoHyo')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_ichimoku\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_kc(identifier, opts = {}) ⇒ ApiResponseSecurityKeltnerChannel

Keltner Channel Returns the Keltner Channel values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate Kelter Channel (default to 10)

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

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



1596
1597
1598
1599
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1596

def get_security_price_technicals_kc(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_kc_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_kc_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityKeltnerChannel, Fixnum, Hash)>

Keltner Channel Returns the Keltner Channel values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate Kelter Channel

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1611

def get_security_price_technicals_kc_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_kc ..."
  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 SecurityApi.get_security_price_technicals_kc"
  end
  if @api_client.config.client_side_validation && !opts[:'period'].nil? && opts[:'period'] < 5
    fail ArgumentError, 'invalid value for "opts[:"period"]" when calling SecurityApi.get_security_price_technicals_kc, must be greater than or equal to 5.'
  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 SecurityApi.get_security_price_technicals_kc, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/kc".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].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[:'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 => 'ApiResponseSecurityKeltnerChannel')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_kc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_kst(identifier, opts = {}) ⇒ ApiResponseSecurityKnowSureThing

Know Sure Thing Returns the Know Sure Thing values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :roc1 (Integer) —

    The number of observations, per period, to calculate the rate-of-change for RCMA1 (default to 10)

  • :roc2 (Integer) —

    The number of observations, per period, to calculate the rate-of-change for RCMA2 (default to 15)

  • :roc3 (Integer) —

    The number of observations, per period, to calculate the rate-of-change for RCMA3 (default to 20)

  • :roc4 (Integer) —

    The number of observations, per period, to calculate the rate-of-change for RCMA4 (default to 30)

  • :sma1 (Integer) —

    The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA1 (default to 10)

  • :sma2 (Integer) —

    The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA2 (default to 10)

  • :sma3 (Integer) —

    The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA3 (default to 10)

  • :sma4 (Integer) —

    The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA4 (default to 15)

  • :price_key (String) —

    The Stock Price field to use when calculating Know Sure Thing (default to close)

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

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



1680
1681
1682
1683
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1680

def get_security_price_technicals_kst(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_kst_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_kst_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityKnowSureThing, Fixnum, Hash)>

Know Sure Thing Returns the Know Sure Thing values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :roc1 (Integer) —

    The number of observations, per period, to calculate the rate-of-change for RCMA1

  • :roc2 (Integer) —

    The number of observations, per period, to calculate the rate-of-change for RCMA2

  • :roc3 (Integer) —

    The number of observations, per period, to calculate the rate-of-change for RCMA3

  • :roc4 (Integer) —

    The number of observations, per period, to calculate the rate-of-change for RCMA4

  • :sma1 (Integer) —

    The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA1

  • :sma2 (Integer) —

    The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA2

  • :sma3 (Integer) —

    The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA3

  • :sma4 (Integer) —

    The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA4

  • :price_key (String) —

    The Stock Price field to use when calculating Know Sure Thing

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1703

def get_security_price_technicals_kst_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_kst ..."
  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 SecurityApi.get_security_price_technicals_kst"
  end
  if @api_client.config.client_side_validation && !opts[:'roc4'].nil? && opts[:'roc4'] < 3
    fail ArgumentError, 'invalid value for "opts[:"roc4"]" when calling SecurityApi.get_security_price_technicals_kst, must be greater than or equal to 3.'
  end

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

  if @api_client.config.client_side_validation && opts[:'price_key'] && !['open', 'high', 'low', 'close', 'volume'].include?(opts[:'price_key'])
    fail ArgumentError, 'invalid value for "price_key", must be one of open, high, low, close, volume'
  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 SecurityApi.get_security_price_technicals_kst, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/kst".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'roc1'] = opts[:'roc1'] if !opts[:'roc1'].nil?
  query_params[:'roc2'] = opts[:'roc2'] if !opts[:'roc2'].nil?
  query_params[:'roc3'] = opts[:'roc3'] if !opts[:'roc3'].nil?
  query_params[:'roc4'] = opts[:'roc4'] if !opts[:'roc4'].nil?
  query_params[:'sma1'] = opts[:'sma1'] if !opts[:'sma1'].nil?
  query_params[:'sma2'] = opts[:'sma2'] if !opts[:'sma2'].nil?
  query_params[:'sma3'] = opts[:'sma3'] if !opts[:'sma3'].nil?
  query_params[:'sma4'] = opts[:'sma4'] if !opts[:'sma4'].nil?
  query_params[:'price_key'] = opts[:'price_key'] if !opts[:'price_key'].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[:'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 => 'ApiResponseSecurityKnowSureThing')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_kst\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_macd(identifier, opts = {}) ⇒ ApiResponseSecurityMovingAverageConvergenceDivergence

Moving Average Convergence Divergence Returns the Moving Average Convergence Divergence values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :fast_period (Integer) —

    The number of observations, per period, to calculate the fast moving Exponential Moving Average for Moving Average Convergence Divergence (default to 12)

  • :slow_period (Integer) —

    The number of observations, per period, to calculate the slow moving Exponential Moving Average for Moving Average Convergence Divergence (default to 26)

  • :signal_period (Integer) —

    The number of observations, per period, to calculate the signal line for Moving Average Convergence Divergence (default to 9)

  • :price_key (String) —

    The Stock Price field to use when calculating Moving Average Convergence Divergence (default to close)

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

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



1782
1783
1784
1785
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1782

def get_security_price_technicals_macd(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_macd_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_macd_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityMovingAverageConvergenceDivergence, Fixnum, Hash)>

Moving Average Convergence Divergence Returns the Moving Average Convergence Divergence values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :fast_period (Integer) —

    The number of observations, per period, to calculate the fast moving Exponential Moving Average for Moving Average Convergence Divergence

  • :slow_period (Integer) —

    The number of observations, per period, to calculate the slow moving Exponential Moving Average for Moving Average Convergence Divergence

  • :signal_period (Integer) —

    The number of observations, per period, to calculate the signal line for Moving Average Convergence Divergence

  • :price_key (String) —

    The Stock Price field to use when calculating Moving Average Convergence Divergence

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1800

def get_security_price_technicals_macd_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_macd ..."
  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 SecurityApi.get_security_price_technicals_macd"
  end
  if @api_client.config.client_side_validation && !opts[:'slow_period'].nil? && opts[:'slow_period'] < 3
    fail ArgumentError, 'invalid value for "opts[:"slow_period"]" when calling SecurityApi.get_security_price_technicals_macd, must be greater than or equal to 3.'
  end

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

  if @api_client.config.client_side_validation && opts[:'price_key'] && !['open', 'high', 'low', 'close', 'volume'].include?(opts[:'price_key'])
    fail ArgumentError, 'invalid value for "price_key", must be one of open, high, low, close, volume'
  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 SecurityApi.get_security_price_technicals_macd, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/macd".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'fast_period'] = opts[:'fast_period'] if !opts[:'fast_period'].nil?
  query_params[:'slow_period'] = opts[:'slow_period'] if !opts[:'slow_period'].nil?
  query_params[:'signal_period'] = opts[:'signal_period'] if !opts[:'signal_period'].nil?
  query_params[:'price_key'] = opts[:'price_key'] if !opts[:'price_key'].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[:'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 => 'ApiResponseSecurityMovingAverageConvergenceDivergence')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_macd\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_mfi(identifier, opts = {}) ⇒ ApiResponseSecurityMoneyFlowIndex

Money Flow Index Returns the Money Flow Index values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate Money Flow Index (default to 14)

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

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



1871
1872
1873
1874
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1871

def get_security_price_technicals_mfi(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_mfi_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_mfi_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityMoneyFlowIndex, Fixnum, Hash)>

Money Flow Index Returns the Money Flow Index values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate Money Flow Index

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1886

def get_security_price_technicals_mfi_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_mfi ..."
  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 SecurityApi.get_security_price_technicals_mfi"
  end
  if @api_client.config.client_side_validation && !opts[:'period'].nil? && opts[:'period'] < 4
    fail ArgumentError, 'invalid value for "opts[:"period"]" when calling SecurityApi.get_security_price_technicals_mfi, must be greater than or equal to 4.'
  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 SecurityApi.get_security_price_technicals_mfi, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/mfi".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].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[:'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 => 'ApiResponseSecurityMoneyFlowIndex')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_mfi\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_mi(identifier, opts = {}) ⇒ ApiResponseSecurityMassIndex

Mass Index Returns the Mass Index values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :ema_period (Integer) —

    The number of observations, per period, to calculate the single Exponential Moving Average and the Double Exponential Moving Average for Mass Index (default to 9)

  • :sum_period (Integer) —

    The number of observations, per period, to calculate the sum of the Exponetinal Moving Average Ratios for Mass Index (default to 25)

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

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



1948
1949
1950
1951
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1948

def get_security_price_technicals_mi(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_mi_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_mi_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityMassIndex, Fixnum, Hash)>

Mass Index Returns the Mass Index values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :ema_period (Integer) —

    The number of observations, per period, to calculate the single Exponential Moving Average and the Double Exponential Moving Average for Mass Index

  • :sum_period (Integer) —

    The number of observations, per period, to calculate the sum of the Exponetinal Moving Average Ratios for Mass Index

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1964

def get_security_price_technicals_mi_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_mi ..."
  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 SecurityApi.get_security_price_technicals_mi"
  end
  if @api_client.config.client_side_validation && !opts[:'ema_period'].nil? && opts[:'ema_period'] < 2
    fail ArgumentError, 'invalid value for "opts[:"ema_period"]" when calling SecurityApi.get_security_price_technicals_mi, must be greater than or equal to 2.'
  end

  if @api_client.config.client_side_validation && !opts[:'sum_period'].nil? && opts[:'sum_period'] < 3
    fail ArgumentError, 'invalid value for "opts[:"sum_period"]" when calling SecurityApi.get_security_price_technicals_mi, must be greater than or equal to 3.'
  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 SecurityApi.get_security_price_technicals_mi, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/mi".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'ema_period'] = opts[:'ema_period'] if !opts[:'ema_period'].nil?
  query_params[:'sum_period'] = opts[:'sum_period'] if !opts[:'sum_period'].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[:'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 => 'ApiResponseSecurityMassIndex')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_mi\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_nvi(identifier, opts = {}) ⇒ ApiResponseSecurityNegativeVolumeIndex

Negative Volume Index Returns the Negative Volume Index values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

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



2029
2030
2031
2032
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2029

def get_security_price_technicals_nvi(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_nvi_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_nvi_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityNegativeVolumeIndex, Fixnum, Hash)>

Negative Volume Index Returns the Negative Volume Index values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2043

def get_security_price_technicals_nvi_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_nvi ..."
  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 SecurityApi.get_security_price_technicals_nvi"
  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 SecurityApi.get_security_price_technicals_nvi, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/nvi".sub('{' + 'identifier' + '}', identifier.to_s)

  # 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[:'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 => 'ApiResponseSecurityNegativeVolumeIndex')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_nvi\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_obv(identifier, opts = {}) ⇒ ApiResponseSecurityOnBalanceVolume

On-balance Volume Returns the On-balance Volume values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

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



2098
2099
2100
2101
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2098

def get_security_price_technicals_obv(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_obv_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_obv_mean(identifier, opts = {}) ⇒ ApiResponseSecurityOnBalanceVolumeMean

On-balance Volume Mean Returns the On-balance Volume Mean values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate On-balance Volume Mean (default to 10)

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

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



2168
2169
2170
2171
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2168

def get_security_price_technicals_obv_mean(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_obv_mean_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_obv_mean_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityOnBalanceVolumeMean, Fixnum, Hash)>

On-balance Volume Mean Returns the On-balance Volume Mean values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate On-balance Volume Mean

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2183

def get_security_price_technicals_obv_mean_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_obv_mean ..."
  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 SecurityApi.get_security_price_technicals_obv_mean"
  end
  if @api_client.config.client_side_validation && !opts[:'period'].nil? && opts[:'period'] < 4
    fail ArgumentError, 'invalid value for "opts[:"period"]" when calling SecurityApi.get_security_price_technicals_obv_mean, must be greater than or equal to 4.'
  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 SecurityApi.get_security_price_technicals_obv_mean, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/obv_mean".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].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[:'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 => 'ApiResponseSecurityOnBalanceVolumeMean')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_obv_mean\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_obv_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityOnBalanceVolume, Fixnum, Hash)>

On-balance Volume Returns the On-balance Volume values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2112

def get_security_price_technicals_obv_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_obv ..."
  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 SecurityApi.get_security_price_technicals_obv"
  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 SecurityApi.get_security_price_technicals_obv, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/obv".sub('{' + 'identifier' + '}', identifier.to_s)

  # 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[:'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 => 'ApiResponseSecurityOnBalanceVolume')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_obv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_rsi(identifier, opts = {}) ⇒ ApiResponseSecurityRelativeStrengthIndex

Relative Strength Index Returns the Relative Strength Index values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate Relative Strength Index (default to 14)

  • :price_key (String) —

    The Stock Price field to use when calculating Relative Strength Index (default to close)

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

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



2245
2246
2247
2248
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2245

def get_security_price_technicals_rsi(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_rsi_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_rsi_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityRelativeStrengthIndex, Fixnum, Hash)>

Relative Strength Index Returns the Relative Strength Index values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate Relative Strength Index

  • :price_key (String) —

    The Stock Price field to use when calculating Relative Strength Index

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2261

def get_security_price_technicals_rsi_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_rsi ..."
  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 SecurityApi.get_security_price_technicals_rsi"
  end
  if @api_client.config.client_side_validation && !opts[:'period'].nil? && opts[:'period'] < 4
    fail ArgumentError, 'invalid value for "opts[:"period"]" when calling SecurityApi.get_security_price_technicals_rsi, must be greater than or equal to 4.'
  end

  if @api_client.config.client_side_validation && opts[:'price_key'] && !['open', 'high', 'low', 'close', 'volume'].include?(opts[:'price_key'])
    fail ArgumentError, 'invalid value for "price_key", must be one of open, high, low, close, volume'
  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 SecurityApi.get_security_price_technicals_rsi, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/rsi".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?
  query_params[:'price_key'] = opts[:'price_key'] if !opts[:'price_key'].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[:'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 => 'ApiResponseSecurityRelativeStrengthIndex')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_rsi\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_sma(identifier, opts = {}) ⇒ ApiResponseSecuritySimpleMovingAverage

Simple Moving Average Returns the Simple Moving Average values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate Simple Moving Average (default to 20)

  • :price_key (String) —

    The Stock Price field to use when calculating Simple Moving Average (default to close)

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

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



2327
2328
2329
2330
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2327

def get_security_price_technicals_sma(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_sma_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_sma_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecuritySimpleMovingAverage, Fixnum, Hash)>

Simple Moving Average Returns the Simple Moving Average values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate Simple Moving Average

  • :price_key (String) —

    The Stock Price field to use when calculating Simple Moving Average

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2343

def get_security_price_technicals_sma_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_sma ..."
  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 SecurityApi.get_security_price_technicals_sma"
  end
  if @api_client.config.client_side_validation && !opts[:'period'].nil? && opts[:'period'] < 5
    fail ArgumentError, 'invalid value for "opts[:"period"]" when calling SecurityApi.get_security_price_technicals_sma, must be greater than or equal to 5.'
  end

  if @api_client.config.client_side_validation && opts[:'price_key'] && !['open', 'high', 'low', 'close', 'volume'].include?(opts[:'price_key'])
    fail ArgumentError, 'invalid value for "price_key", must be one of open, high, low, close, volume'
  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 SecurityApi.get_security_price_technicals_sma, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/sma".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?
  query_params[:'price_key'] = opts[:'price_key'] if !opts[:'price_key'].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[:'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 => 'ApiResponseSecuritySimpleMovingAverage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_sma\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_sr(identifier, opts = {}) ⇒ ApiResponseSecurityStochasticOscillator

Stochastic Oscillator Returns the Stochastic Oscillator values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate %K of Stochastic Oscillator (default to 14)

  • :signal_period (Integer) —

    The number of observations, per period, to calculate the %D (the Simple Moving Average of %K) as a signal line for Stochastic Oscillator (default to 3)

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

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



2409
2410
2411
2412
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2409

def get_security_price_technicals_sr(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_sr_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_sr_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityStochasticOscillator, Fixnum, Hash)>

Stochastic Oscillator Returns the Stochastic Oscillator values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate %K of Stochastic Oscillator

  • :signal_period (Integer) —

    The number of observations, per period, to calculate the %D (the Simple Moving Average of %K) as a signal line for Stochastic Oscillator

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2425

def get_security_price_technicals_sr_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_sr ..."
  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 SecurityApi.get_security_price_technicals_sr"
  end
  if @api_client.config.client_side_validation && !opts[:'period'].nil? && opts[:'period'] < 3
    fail ArgumentError, 'invalid value for "opts[:"period"]" when calling SecurityApi.get_security_price_technicals_sr, must be greater than or equal to 3.'
  end

  if @api_client.config.client_side_validation && !opts[:'signal_period'].nil? && opts[:'signal_period'] < 3
    fail ArgumentError, 'invalid value for "opts[:"signal_period"]" when calling SecurityApi.get_security_price_technicals_sr, must be greater than or equal to 3.'
  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 SecurityApi.get_security_price_technicals_sr, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/sr".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].nil?
  query_params[:'signal_period'] = opts[:'signal_period'] if !opts[:'signal_period'].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[:'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 => 'ApiResponseSecurityStochasticOscillator')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_sr\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_trix(identifier, opts = {}) ⇒ ApiResponseSecurityTripleExponentialAverage

Triple Exponential Average Returns the Simple Moving Average values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate Exponential Moving Average for Triple Exponential Average (default to 15)

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

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



2491
2492
2493
2494
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2491

def get_security_price_technicals_trix(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_trix_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_trix_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityTripleExponentialAverage, Fixnum, Hash)>

Triple Exponential Average Returns the Simple Moving Average values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate Exponential Moving Average for Triple Exponential Average

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2506

def get_security_price_technicals_trix_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_trix ..."
  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 SecurityApi.get_security_price_technicals_trix"
  end
  if @api_client.config.client_side_validation && !opts[:'period'].nil? && opts[:'period'] < 2
    fail ArgumentError, 'invalid value for "opts[:"period"]" when calling SecurityApi.get_security_price_technicals_trix, must be greater than or equal to 2.'
  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 SecurityApi.get_security_price_technicals_trix, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/trix".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].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[:'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 => 'ApiResponseSecurityTripleExponentialAverage')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_trix\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_tsi(identifier, opts = {}) ⇒ ApiResponseSecurityTrueStrengthIndex

True Strength Index Returns the True Strength Index values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :low_period (Integer) —

    The number of observations, per period, to calculate low period Exponential Moving Average for smoothing in True Strength Index (default to 13)

  • :high_period (Integer) —

    The number of observations, per period, to calculate high period Exponential Moving Average for smoothing in True Strength Index (default to 25)

  • :price_key (String) —

    The Stock Price field to use when calculating True Strength Index (default to close)

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

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



2569
2570
2571
2572
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2569

def get_security_price_technicals_tsi(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_tsi_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_tsi_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityTrueStrengthIndex, Fixnum, Hash)>

True Strength Index Returns the True Strength Index values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :low_period (Integer) —

    The number of observations, per period, to calculate low period Exponential Moving Average for smoothing in True Strength Index

  • :high_period (Integer) —

    The number of observations, per period, to calculate high period Exponential Moving Average for smoothing in True Strength Index

  • :price_key (String) —

    The Stock Price field to use when calculating True Strength Index

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2586

def get_security_price_technicals_tsi_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_tsi ..."
  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 SecurityApi.get_security_price_technicals_tsi"
  end
  if @api_client.config.client_side_validation && !opts[:'low_period'].nil? && opts[:'low_period'] < 3
    fail ArgumentError, 'invalid value for "opts[:"low_period"]" when calling SecurityApi.get_security_price_technicals_tsi, must be greater than or equal to 3.'
  end

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

  if @api_client.config.client_side_validation && opts[:'price_key'] && !['open', 'high', 'low', 'close', 'volume'].include?(opts[:'price_key'])
    fail ArgumentError, 'invalid value for "price_key", must be one of open, high, low, close, volume'
  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 SecurityApi.get_security_price_technicals_tsi, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/tsi".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'low_period'] = opts[:'low_period'] if !opts[:'low_period'].nil?
  query_params[:'high_period'] = opts[:'high_period'] if !opts[:'high_period'].nil?
  query_params[:'price_key'] = opts[:'price_key'] if !opts[:'price_key'].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[:'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 => 'ApiResponseSecurityTrueStrengthIndex')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_tsi\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_uo(identifier, opts = {}) ⇒ ApiResponseSecurityUltimateOscillator

Ultimate Oscillator Returns the Ultimate Oscillator values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :short_period (Integer) —

    The number of observations, per period, to calculate the short period for Ultimate Oscillator (default to 7)

  • :medium_period (Integer) —

    The number of observations, per period, to calculate the medium period for Ultimate Oscillator (default to 14)

  • :long_period (Integer) —

    The number of observations, per period, to calculate the long period for Ultimate Oscillator (default to 28)

  • :short_weight (Float) —

    The weight of short Buying Pressure average for Ultimate Oscillator (default to 4.0)

  • :medium_weight (Float) —

    The weight of medium Buying Pressure average for Ultimate Oscillator (default to 2.0)

  • :long_weight (Float) —

    The weight of long Buying Pressure average for Ultimate Oscillator (default to 1.0)

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

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



2661
2662
2663
2664
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2661

def get_security_price_technicals_uo(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_uo_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_uo_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityUltimateOscillator, Fixnum, Hash)>

Ultimate Oscillator Returns the Ultimate Oscillator values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :short_period (Integer) —

    The number of observations, per period, to calculate the short period for Ultimate Oscillator

  • :medium_period (Integer) —

    The number of observations, per period, to calculate the medium period for Ultimate Oscillator

  • :long_period (Integer) —

    The number of observations, per period, to calculate the long period for Ultimate Oscillator

  • :short_weight (Float) —

    The weight of short Buying Pressure average for Ultimate Oscillator

  • :medium_weight (Float) —

    The weight of medium Buying Pressure average for Ultimate Oscillator

  • :long_weight (Float) —

    The weight of long Buying Pressure average for Ultimate Oscillator

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2681

def get_security_price_technicals_uo_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_uo ..."
  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 SecurityApi.get_security_price_technicals_uo"
  end
  if @api_client.config.client_side_validation && !opts[:'long_period'].nil? && opts[:'long_period'] < 4
    fail ArgumentError, 'invalid value for "opts[:"long_period"]" when calling SecurityApi.get_security_price_technicals_uo, must be greater than or equal to 4.'
  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 SecurityApi.get_security_price_technicals_uo, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/uo".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'short_period'] = opts[:'short_period'] if !opts[:'short_period'].nil?
  query_params[:'medium_period'] = opts[:'medium_period'] if !opts[:'medium_period'].nil?
  query_params[:'long_period'] = opts[:'long_period'] if !opts[:'long_period'].nil?
  query_params[:'short_weight'] = opts[:'short_weight'] if !opts[:'short_weight'].nil?
  query_params[:'medium_weight'] = opts[:'medium_weight'] if !opts[:'medium_weight'].nil?
  query_params[:'long_weight'] = opts[:'long_weight'] if !opts[:'long_weight'].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[:'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 => 'ApiResponseSecurityUltimateOscillator')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_uo\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_vi(identifier, opts = {}) ⇒ ApiResponseSecurityVortexIndicator

Vortex Indicator Returns the Vortex Indicator values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate Vortex Indicator (default to 14)

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

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



2747
2748
2749
2750
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2747

def get_security_price_technicals_vi(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_vi_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_vi_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityVortexIndicator, Fixnum, Hash)>

Vortex Indicator Returns the Vortex Indicator values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to calculate Vortex Indicator

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2762

def get_security_price_technicals_vi_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_vi ..."
  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 SecurityApi.get_security_price_technicals_vi"
  end
  if @api_client.config.client_side_validation && !opts[:'period'].nil? && opts[:'period'] < 4
    fail ArgumentError, 'invalid value for "opts[:"period"]" when calling SecurityApi.get_security_price_technicals_vi, must be greater than or equal to 4.'
  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 SecurityApi.get_security_price_technicals_vi, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/vi".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].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[:'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 => 'ApiResponseSecurityVortexIndicator')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_vi\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_vpt(identifier, opts = {}) ⇒ ApiResponseSecurityVolumePriceTrend

Volume-price Trend Returns the Volume-price Trend values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

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



2822
2823
2824
2825
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2822

def get_security_price_technicals_vpt(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_vpt_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_vpt_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityVolumePriceTrend, Fixnum, Hash)>

Volume-price Trend Returns the Volume-price Trend values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2836

def get_security_price_technicals_vpt_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_vpt ..."
  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 SecurityApi.get_security_price_technicals_vpt"
  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 SecurityApi.get_security_price_technicals_vpt, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/vpt".sub('{' + 'identifier' + '}', identifier.to_s)

  # 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[:'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 => 'ApiResponseSecurityVolumePriceTrend')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_vpt\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_vwap(identifier, opts = {}) ⇒ ApiResponseSecurityVolumeWeightedAveragePrice

Volume Weighted Average Price Returns the Volume Weighted Average Price values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

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



2891
2892
2893
2894
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2891

def get_security_price_technicals_vwap(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_vwap_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_vwap_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityVolumeWeightedAveragePrice, Fixnum, Hash)>

Volume Weighted Average Price Returns the Volume Weighted Average Price values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2905

def get_security_price_technicals_vwap_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_vwap ..."
  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 SecurityApi.get_security_price_technicals_vwap"
  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 SecurityApi.get_security_price_technicals_vwap, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/vwap".sub('{' + 'identifier' + '}', identifier.to_s)

  # 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[:'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 => 'ApiResponseSecurityVolumeWeightedAveragePrice')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_vwap\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_price_technicals_wr(identifier, opts = {}) ⇒ ApiResponseSecurityWilliamsR

Williams %R Returns the Williams %R values of Stock Prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to look-back when calculating Williams %R (default to 14)

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Float) —

    The number of results to return (default to 100)

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



2961
2962
2963
2964
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2961

def get_security_price_technicals_wr(identifier, opts = {})
  data, _status_code, _headers = get_security_price_technicals_wr_with_http_info(identifier, opts)
  return data
end

#get_security_price_technicals_wr_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityWilliamsR, Fixnum, Hash)>

Williams %R Returns the Williams %R values of Stock Prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :period (Integer) —

    The number of observations, per period, to look-back when calculating Williams %R

  • :start_date (String) —

    Return technical indicator values on or after the date

  • :end_date (String) —

    Return technical indicator values on or before the date

  • :page_size (Float) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2976

def get_security_price_technicals_wr_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_price_technicals_wr ..."
  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 SecurityApi.get_security_price_technicals_wr"
  end
  if @api_client.config.client_side_validation && !opts[:'period'].nil? && opts[:'period'] < 5
    fail ArgumentError, 'invalid value for "opts[:"period"]" when calling SecurityApi.get_security_price_technicals_wr, must be greater than or equal to 5.'
  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 SecurityApi.get_security_price_technicals_wr, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/technicals/wr".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'period'] = opts[:'period'] if !opts[:'period'].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[:'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 => 'ApiResponseSecurityWilliamsR')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_price_technicals_wr\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_realtime_price(identifier, opts = {}) ⇒ RealtimeStockPrice

Realtime Stock Price for Security Return the realtime stock price for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :source (String) —

    Return the realtime price from the specified data source. If no source is specified, the best source available is used.

Returns:



3033
3034
3035
3036
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3033

def get_security_realtime_price(identifier, opts = {})
  data, _status_code, _headers = get_security_realtime_price_with_http_info(identifier, opts)
  return data
end

#get_security_realtime_price_with_http_info(identifier, opts = {}) ⇒ Array<(RealtimeStockPrice, Fixnum, Hash)>

Realtime Stock Price for Security Return the realtime stock price for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :source (String) —

    Return the realtime price from the specified data source. If no source is specified, the best source available is used.

Returns:

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

    RealtimeStockPrice data, response status code and response headers



3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3044

def get_security_realtime_price_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_realtime_price ..."
  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 SecurityApi.get_security_realtime_price"
  end
  if @api_client.config.client_side_validation && opts[:'source'] && !['iex', 'bats', 'bats_delayed'].include?(opts[:'source'])
    fail ArgumentError, 'invalid value for "source", must be one of iex, bats, bats_delayed'
  end
  # resource path
  local_var_path = "/securities/{identifier}/prices/realtime".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'source'] = opts[:'source'] if !opts[:'source'].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 => 'RealtimeStockPrice')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_realtime_price\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_stock_price_adjustments(identifier, opts = {}) ⇒ ApiResponseSecurityStockPriceAdjustments

Stock Price Adjustments by Security Returns stock price adjustments for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :start_date (Date) —

    Return price adjustments on or after the date

  • :end_date (Date) —

    Return price adjustments on or before the date

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



3095
3096
3097
3098
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3095

def get_security_stock_price_adjustments(identifier, opts = {})
  data, _status_code, _headers = get_security_stock_price_adjustments_with_http_info(identifier, opts)
  return data
end

#get_security_stock_price_adjustments_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityStockPriceAdjustments, Fixnum, Hash)>

Stock Price Adjustments by Security Returns stock price adjustments for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :start_date (Date) —

    Return price adjustments on or after the date

  • :end_date (Date) —

    Return price adjustments on or before the date

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3109

def get_security_stock_price_adjustments_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_stock_price_adjustments ..."
  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 SecurityApi.get_security_stock_price_adjustments"
  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 SecurityApi.get_security_stock_price_adjustments, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices/adjustments".sub('{' + 'identifier' + '}', identifier.to_s)

  # 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[:'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 => 'ApiResponseSecurityStockPriceAdjustments')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_stock_price_adjustments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_stock_prices(identifier, opts = {}) ⇒ ApiResponseSecurityStockPrices

Stock Prices by Security Return end-of-day stock prices for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :start_date (Date) —

    Return prices on or after the date

  • :end_date (Date) —

    Return prices on or before the date

  • :frequency (String) —

    Return stock prices in the given frequency (default to daily)

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



3165
3166
3167
3168
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3165

def get_security_stock_prices(identifier, opts = {})
  data, _status_code, _headers = get_security_stock_prices_with_http_info(identifier, opts)
  return data
end

#get_security_stock_prices_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityStockPrices, Fixnum, Hash)>

Stock Prices by Security Return end-of-day stock prices for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :start_date (Date) —

    Return prices on or after the date

  • :end_date (Date) —

    Return prices on or before the date

  • :frequency (String) —

    Return stock prices in the given frequency

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3180

def get_security_stock_prices_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_stock_prices ..."
  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 SecurityApi.get_security_stock_prices"
  end
  if @api_client.config.client_side_validation && opts[:'frequency'] && !['daily', 'weekly', 'monthly', 'quarterly', 'yearly'].include?(opts[:'frequency'])
    fail ArgumentError, 'invalid value for "frequency", must be one of daily, weekly, monthly, quarterly, yearly'
  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 SecurityApi.get_security_stock_prices, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/prices".sub('{' + 'identifier' + '}', identifier.to_s)

  # 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[:'frequency'] = opts[:'frequency'] if !opts[:'frequency'].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 => 'ApiResponseSecurityStockPrices')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_stock_prices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_zacks_analyst_ratings(identifier, opts = {}) ⇒ ApiResponseSecurityZacksAnalystRatings

Zacks Analyst Ratings Returns buy, sell, and hold recommendations from analysts at brokerages for the Security with the given ‘identifier`. Zack’s storied research team aggregates and validates the ratings from professional analysts.

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :start_date (String) —

    Limit ratings to those on or after this date

  • :end_date (String) —

    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)

Returns:



3252
3253
3254
3255
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3252

def get_security_zacks_analyst_ratings(identifier, opts = {})
  data, _status_code, _headers = get_security_zacks_analyst_ratings_with_http_info(identifier, opts)
  return data
end

#get_security_zacks_analyst_ratings_snapshot(identifier, opts = {}) ⇒ ApiResponseSecurityZacksAnalystRatingsSnapshot

Zacks Analyst Ratings Snapshot Returns a snapshot of ratings data compared with previous timeframes for the Security with the given ‘identifier`. Also returns mean percentiles for comparing one security to the universe of securities covered by Zacks analyst ratings, at a specific point in time.

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :date (String) —

    Lookup a historical snapshot on the given date

Returns:



3408
3409
3410
3411
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3408

def get_security_zacks_analyst_ratings_snapshot(identifier, opts = {})
  data, _status_code, _headers = get_security_zacks_analyst_ratings_snapshot_with_http_info(identifier, opts)
  return data
end

#get_security_zacks_analyst_ratings_snapshot_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityZacksAnalystRatingsSnapshot, Fixnum, Hash)>

Zacks Analyst Ratings Snapshot Returns a snapshot of ratings data compared with previous timeframes for the Security with the given &#x60;identifier&#x60;. Also returns mean percentiles for comparing one security to the universe of securities covered by Zacks analyst ratings, at a specific point in time.

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :date (String) —

    Lookup a historical snapshot on the given date

Returns:



3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3419

def get_security_zacks_analyst_ratings_snapshot_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_zacks_analyst_ratings_snapshot ..."
  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 SecurityApi.get_security_zacks_analyst_ratings_snapshot"
  end
  # resource path
  local_var_path = "/securities/{identifier}/zacks/analyst_ratings/snapshot".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'date'] = opts[:'date'] if !opts[:'date'].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 => 'ApiResponseSecurityZacksAnalystRatingsSnapshot')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_zacks_analyst_ratings_snapshot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_zacks_analyst_ratings_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityZacksAnalystRatings, Fixnum, Hash)>

Zacks Analyst Ratings Returns buy, sell, and hold recommendations from analysts at brokerages for the Security with the given &#x60;identifier&#x60;. Zack’s storied research team aggregates and validates the ratings from professional analysts.

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :start_date (String) —

    Limit ratings to those on or after this date

  • :end_date (String) —

    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

Returns:



3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3279

def get_security_zacks_analyst_ratings_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_zacks_analyst_ratings ..."
  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 SecurityApi.get_security_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 SecurityApi.get_security_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 SecurityApi.get_security_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 SecurityApi.get_security_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 SecurityApi.get_security_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 SecurityApi.get_security_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 SecurityApi.get_security_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 SecurityApi.get_security_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 SecurityApi.get_security_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 SecurityApi.get_security_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 SecurityApi.get_security_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 SecurityApi.get_security_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 SecurityApi.get_security_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 SecurityApi.get_security_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 SecurityApi.get_security_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 SecurityApi.get_security_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 SecurityApi.get_security_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 SecurityApi.get_security_zacks_analyst_ratings, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/zacks/analyst_ratings".sub('{' + 'identifier' + '}', identifier.to_s)

  # 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[:'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?

  # 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 => 'ApiResponseSecurityZacksAnalystRatings')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_zacks_analyst_ratings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_zacks_eps_surprises(identifier, opts = {}) ⇒ ApiResponseSecurityZacksEPSSurprises

Zacks EPS Surprises for Security Return Zacks EPS surprises for the Security with the given ‘identifier`.

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

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



3465
3466
3467
3468
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3465

def get_security_zacks_eps_surprises(identifier, opts = {})
  data, _status_code, _headers = get_security_zacks_eps_surprises_with_http_info(identifier, opts)
  return data
end

#get_security_zacks_eps_surprises_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityZacksEPSSurprises, Fixnum, Hash)>

Zacks EPS Surprises for Security Return Zacks EPS surprises for the Security with the given &#x60;identifier&#x60;.

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3477

def get_security_zacks_eps_surprises_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_zacks_eps_surprises ..."
  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 SecurityApi.get_security_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 SecurityApi.get_security_zacks_eps_surprises, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/zacks/eps_surprises".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  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 => 'ApiResponseSecurityZacksEPSSurprises')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_zacks_eps_surprises\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_zacks_sales_surprises(identifier, opts = {}) ⇒ ApiResponseSecurityZacksSalesSurprises

Zacks Sales Surprises for Security Return Zacks sales surprises for the Security with the given ‘identifier`.

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

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



3528
3529
3530
3531
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3528

def get_security_zacks_sales_surprises(identifier, opts = {})
  data, _status_code, _headers = get_security_zacks_sales_surprises_with_http_info(identifier, opts)
  return data
end

#get_security_zacks_sales_surprises_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityZacksSalesSurprises, Fixnum, Hash)>

Zacks Sales Surprises for Security Return Zacks sales surprises for the Security with the given &#x60;identifier&#x60;.

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of results to return

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3540

def get_security_zacks_sales_surprises_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_zacks_sales_surprises ..."
  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 SecurityApi.get_security_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 SecurityApi.get_security_zacks_sales_surprises, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/{identifier}/zacks/sales_surprises".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  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 => 'ApiResponseSecurityZacksSalesSurprises')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_zacks_sales_surprises\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#screen_securities(opts = {}) ⇒ Array<SecurityScreenResult>

Screen Securities Screen Securities using complex logic. Use POST only. See <a href="docs.intrinio.com/documentation/screener_v2" target="_blank">screener documentation</a> for details on how to construct conditions.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :logic (SecurityScreenGroup) —

    The logic to screen with, consisting of operators, clauses, and nested groups. &lt;/br&gt; See &lt;a href&#x3D;&quot;docs.intrinio.com/documentation/screener_v2&quot; target&#x3D;&quot;_blank&quot;&gt;screener documentation&lt;/a&gt; for details on how to construct conditions.

  • :order_column (String) —

    Results returned sorted by this column

  • :order_direction (String) —

    Sort order to use with the order_column (default to asc)

  • :primary_only (BOOLEAN) —

    Return only primary securities (default to false)

  • :page_size (Integer) —

    The number of results to return. Maximum for this endpoint is 50000. (default to 100)

Returns:



3593
3594
3595
3596
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3593

def screen_securities(opts = {})
  data, _status_code, _headers = screen_securities_with_http_info(opts)
  return data
end

#screen_securities_with_http_info(opts = {}) ⇒ Array<(Array<SecurityScreenResult>, Fixnum, Hash)>

Screen Securities Screen Securities using complex logic. Use POST only. See &lt;a href&#x3D;&quot;docs.intrinio.com/documentation/screener_v2&quot; target&#x3D;&quot;_blank&quot;&gt;screener documentation&lt;/a&gt; for details on how to construct conditions.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :logic (SecurityScreenGroup) —

    The logic to screen with, consisting of operators, clauses, and nested groups. &lt;/br&gt; See &lt;a href&#x3D;&quot;docs.intrinio.com/documentation/screener_v2&quot; target&#x3D;&quot;_blank&quot;&gt;screener documentation&lt;/a&gt; for details on how to construct conditions.

  • :order_column (String) —

    Results returned sorted by this column

  • :order_direction (String) —

    Sort order to use with the order_column

  • :primary_only (BOOLEAN) —

    Return only primary securities

  • :page_size (Integer) —

    The number of results to return. Maximum for this endpoint is 50000.

Returns:

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

    Array<SecurityScreenResult> data, response status code and response headers



3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3607

def screen_securities_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.screen_securities ..."
  end
  if @api_client.config.client_side_validation && opts[:'order_direction'] && !['asc', 'desc'].include?(opts[:'order_direction'])
    fail ArgumentError, 'invalid value for "order_direction", must be one of asc, desc'
  end
  if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 50000
    fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling SecurityApi.screen_securities, must be smaller than or equal to 50000.'
  end

  # resource path
  local_var_path = "/securities/screen"

  # query parameters
  query_params = {}
  query_params[:'order_column'] = opts[:'order_column'] if !opts[:'order_column'].nil?
  query_params[:'order_direction'] = opts[:'order_direction'] if !opts[:'order_direction'].nil?
  query_params[:'primary_only'] = opts[:'primary_only'] if !opts[:'primary_only'].nil?
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].nil?

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'logic'])
  auth_names = ['ApiKeyAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Array<SecurityScreenResult>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#screen_securities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#search_securities(query, opts = {}) ⇒ ApiResponseSecuritiesSearch

Search Securities Searches for Securities matching the text ‘query`

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of results to return (default to 100)

Returns:



3660
3661
3662
3663
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3660

def search_securities(query, opts = {})
  data, _status_code, _headers = search_securities_with_http_info(query, opts)
  return data
end

#search_securities_with_http_info(query, opts = {}) ⇒ Array<(ApiResponseSecuritiesSearch, Fixnum, Hash)>

Search Securities Searches for Securities matching the text &#x60;query&#x60;

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of results to return

Returns:



3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3671

def search_securities_with_http_info(query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.search_securities ..."
  end
  # verify the required parameter 'query' is set
  if @api_client.config.client_side_validation && query.nil?
    fail ArgumentError, "Missing the required parameter 'query' when calling SecurityApi.search_securities"
  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 SecurityApi.search_securities, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/search"

  # query parameters
  query_params = {}
  query_params[:'query'] = query
  query_params[:'page_size'] = opts[:'page_size'] if !opts[:'page_size'].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 => 'ApiResponseSecuritiesSearch')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#search_securities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end