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 a list of all securities available. Delisted securities included.

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. Returns both if omitted.

  • :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 a list of all securities available. Delisted securities included.

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. Returns both if omitted.

  • :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 security reference data such as ticker, FIGI, primary exchange, CIK, and a unique security 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 security reference data such as ticker, FIGI, primary exchange, CIK, and a unique security identifier.

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_history_by_identifier(identifier, opts = {}) ⇒ SecurityHistoryListResult

Security History By Identifier Lists the tickers a company has used over time.

Parameters:

  • identifier —

    A Security identifier (FIGI, COMPOSITE FIGI, SHARE CLASS FIGI, ISIN, CUSIP, Intrinio ID)

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

    the optional parameters

Returns:



397
398
399
400
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 397

def get_security_history_by_identifier(identifier, opts = {})
  data, _status_code, _headers = get_security_history_by_identifier_with_http_info(identifier, opts)
  return data
end

#get_security_history_by_identifier_with_http_info(identifier, opts = {}) ⇒ Array<(SecurityHistoryListResult, Fixnum, Hash)>

Security History By Identifier Lists the tickers a company has used over time.

Parameters:

  • identifier —

    A Security identifier (FIGI, COMPOSITE FIGI, SHARE CLASS FIGI, ISIN, CUSIP, Intrinio ID)

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

    the optional parameters

Returns:

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

    SecurityHistoryListResult data, response status code and response headers



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 407

def get_security_history_by_identifier_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_history_by_identifier ..."
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling SecurityApi.get_security_history_by_identifier"
  end
  # resource path
  local_var_path = "/securities/history-by-identifier/{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 => 'SecurityHistoryListResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_history_by_identifier\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_history_by_ticker(ticker, opts = {}) ⇒ SecurityHistoryListResult

Security History By Ticker Lists the tickers a company has used over time.

Parameters:

  • ticker —

    A Security ticker symbol

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

    the optional parameters

Returns:



450
451
452
453
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 450

def get_security_history_by_ticker(ticker, opts = {})
  data, _status_code, _headers = get_security_history_by_ticker_with_http_info(ticker, opts)
  return data
end

#get_security_history_by_ticker_with_http_info(ticker, opts = {}) ⇒ Array<(SecurityHistoryListResult, Fixnum, Hash)>

Security History By Ticker Lists the tickers a company has used over time.

Parameters:

  • ticker —

    A Security ticker symbol

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

    the optional parameters

Returns:

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

    SecurityHistoryListResult data, response status code and response headers



460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 460

def get_security_history_by_ticker_with_http_info(ticker, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_history_by_ticker ..."
  end
  # verify the required parameter 'ticker' is set
  if @api_client.config.client_side_validation && ticker.nil?
    fail ArgumentError, "Missing the required parameter 'ticker' when calling SecurityApi.get_security_history_by_ticker"
  end
  # resource path
  local_var_path = "/securities/history-by-ticker/{ticker}".sub('{' + 'ticker' + '}', ticker.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 => 'SecurityHistoryListResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_history_by_ticker\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_security_insider_ownership(identifier, opts = {}) ⇒ ApiResponseSecurityInstitutionalOwnership

Institutional Ownership by Security Returns a list of all institutional owners of a given security.

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



504
505
506
507
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 504

def get_security_insider_ownership(identifier, opts = {})
  data, _status_code, _headers = get_security_insider_ownership_with_http_info(identifier, opts)
  return data
end

#get_security_insider_ownership_with_http_info(identifier, opts = {}) ⇒ Array<(ApiResponseSecurityInstitutionalOwnership, Fixnum, Hash)>

Institutional Ownership by Security Returns a list of all institutional owners of a given security.

Parameters:

  • identifier —

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

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

    the optional parameters

Options Hash (opts):

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 515

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

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

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

  # form parameters
  form_params = {}

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

#get_security_interval_movers(opts = {}) ⇒ SecurityIntervalsMoversResult

Security Intervals Movers Returns a list of intervals for the biggest movers over the last hour interval.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :source (String) —

    Realtime or 15-minute delayed contracts.

  • :open_time (DateTime) —

    The inclusive UTC date and time the interval opens at.

Returns:



560
561
562
563
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 560

def get_security_interval_movers(opts = {})
  data, _status_code, _headers = get_security_interval_movers_with_http_info(opts)
  return data
end

#get_security_interval_movers_change(opts = {}) ⇒ SecurityIntervalsMoversResult

Security Intervals Movers By Change Returns a list of intervals for the biggest movers by change over the last hour interval.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :source (String) —

    Realtime or 15-minute delayed contracts.

  • :open_time (DateTime) —

    The inclusive UTC date and time the interval opens at.

Returns:



616
617
618
619
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 616

def get_security_interval_movers_change(opts = {})
  data, _status_code, _headers = get_security_interval_movers_change_with_http_info(opts)
  return data
end

#get_security_interval_movers_change_with_http_info(opts = {}) ⇒ Array<(SecurityIntervalsMoversResult, Fixnum, Hash)>

Security Intervals Movers By Change Returns a list of intervals for the biggest movers by change over the last hour interval.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :source (String) —

    Realtime or 15-minute delayed contracts.

  • :open_time (DateTime) —

    The inclusive UTC date and time the interval opens at.

Returns:



627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 627

def get_security_interval_movers_change_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_interval_movers_change ..."
  end
  if @api_client.config.client_side_validation && opts[:'source'] && !['realtime', 'delayed'].include?(opts[:'source'])
    fail ArgumentError, 'invalid value for "source", must be one of realtime, delayed'
  end
  # resource path
  local_var_path = "/securities/market_movers/change"

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

#get_security_interval_movers_volume(opts = {}) ⇒ SecurityIntervalsMoversResult

Security Intervals Movers By Volume Returns a list of intervals for the biggest movers by volume over the last hour interval.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :source (String) —

    Realtime or 15-minute delayed contracts.

  • :open_time (DateTime) —

    The inclusive UTC date and time the interval opens at.

Returns:



672
673
674
675
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 672

def get_security_interval_movers_volume(opts = {})
  data, _status_code, _headers = get_security_interval_movers_volume_with_http_info(opts)
  return data
end

#get_security_interval_movers_volume_with_http_info(opts = {}) ⇒ Array<(SecurityIntervalsMoversResult, Fixnum, Hash)>

Security Intervals Movers By Volume Returns a list of intervals for the biggest movers by volume over the last hour interval.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :source (String) —

    Realtime or 15-minute delayed contracts.

  • :open_time (DateTime) —

    The inclusive UTC date and time the interval opens at.

Returns:



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

def get_security_interval_movers_volume_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_interval_movers_volume ..."
  end
  if @api_client.config.client_side_validation && opts[:'source'] && !['realtime', 'delayed'].include?(opts[:'source'])
    fail ArgumentError, 'invalid value for "source", must be one of realtime, delayed'
  end
  # resource path
  local_var_path = "/securities/market_movers/volume"

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

#get_security_interval_movers_with_http_info(opts = {}) ⇒ Array<(SecurityIntervalsMoversResult, Fixnum, Hash)>

Security Intervals Movers Returns a list of intervals for the biggest movers over the last hour interval.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :source (String) —

    Realtime or 15-minute delayed contracts.

  • :open_time (DateTime) —

    The inclusive UTC date and time the interval opens at.

Returns:



571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 571

def get_security_interval_movers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_interval_movers ..."
  end
  if @api_client.config.client_side_validation && opts[:'source'] && !['realtime', 'delayed'].include?(opts[:'source'])
    fail ArgumentError, 'invalid value for "source", must be one of realtime, delayed'
  end
  # resource path
  local_var_path = "/securities/market_movers"

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

#get_security_interval_prices(identifier, interval_size, opts = {}) ⇒ ApiResponseSecurityIntervalPrices

Interval Stock Prices for Security Return open, close, high, low, volume, average price, and change ratio for a particular interval for the Security with the given ‘identifier`

Parameters:

  • identifier —

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

  • interval_size —

    The interval for which to return stock prices

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

    the optional parameters

Options Hash (opts):

  • :source (String) —

    Return intervals from the specified data source

  • :start_date (Date) —

    Return intervals starting at the specified date

  • :start_time (String) —

    Return intervals starting at the specified time on the &#x60;start_date&#x60; (24-hour in &#39;hh:mm:ss&#39; format)

  • :end_date (Date) —

    Return intervals stopping at the specified date

  • :end_time (String) —

    Return intervals stopping at the specified time on the &#x60;end_date&#x60; (24-hour in &#39;hh:mm:ss&#39; format)

  • :timezone (String) —

    Returns trading times in this timezone (default to UTC)

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



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

def get_security_interval_prices(identifier, interval_size, opts = {})
  data, _status_code, _headers = get_security_interval_prices_with_http_info(identifier, interval_size, opts)
  return data
end

#get_security_interval_prices_with_http_info(identifier, interval_size, opts = {}) ⇒ Array<(ApiResponseSecurityIntervalPrices, Fixnum, Hash)>

Interval Stock Prices for Security Return open, close, high, low, volume, average price, and change ratio for a particular interval for the Security with the given &#x60;identifier&#x60;

Parameters:

  • identifier —

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

  • interval_size —

    The interval for which to return stock prices

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

    the optional parameters

Options Hash (opts):

  • :source (String) —

    Return intervals from the specified data source

  • :start_date (Date) —

    Return intervals starting at the specified date

  • :start_time (String) —

    Return intervals starting at the specified time on the &#x60;start_date&#x60; (24-hour in &#39;hh:mm:ss&#39; format)

  • :end_date (Date) —

    Return intervals stopping at the specified date

  • :end_time (String) —

    Return intervals stopping at the specified time on the &#x60;end_date&#x60; (24-hour in &#39;hh:mm:ss&#39; format)

  • :timezone (String) —

    Returns trading times in this 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:



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
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 755

def get_security_interval_prices_with_http_info(identifier, interval_size, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_interval_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_interval_prices"
  end
  # verify the required parameter 'interval_size' is set
  if @api_client.config.client_side_validation && interval_size.nil?
    fail ArgumentError, "Missing the required parameter 'interval_size' when calling SecurityApi.get_security_interval_prices"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['1m', '5m', '10m', '15m', '30m', '60m', '1h'].include?(interval_size)
    fail ArgumentError, "invalid value for 'interval_size', must be one of 1m, 5m, 10m, 15m, 30m, 60m, 1h"
  end
  if @api_client.config.client_side_validation && opts[:'source'] && !['realtime', 'delayed', 'nasdaq_basic'].include?(opts[:'source'])
    fail ArgumentError, 'invalid value for "source", must be one of realtime, delayed, nasdaq_basic'
  end
  if @api_client.config.client_side_validation && opts[:'timezone'] && !['Africa/Algiers', 'Africa/Cairo', 'Africa/Casablanca', 'Africa/Harare', 'Africa/Johannesburg', 'Africa/Monrovia', 'Africa/Nairobi', 'America/Argentina/Buenos_Aires', 'America/Bogota', 'America/Caracas', 'America/Chicago', 'America/Chihuahua', 'America/Denver', 'America/Godthab', 'America/Guatemala', 'America/Guyana', 'America/Halifax', 'America/Indiana/Indianapolis', 'America/Juneau', 'America/La_Paz', 'America/Lima', 'America/Lima', 'America/Los_Angeles', 'America/Mazatlan', 'America/Mexico_City', 'America/Mexico_City', 'America/Monterrey', 'America/Montevideo', 'America/New_York', 'America/Phoenix', 'America/Regina', 'America/Santiago', 'America/Sao_Paulo', 'America/St_Johns', 'America/Tijuana', 'Asia/Almaty', 'Asia/Baghdad', 'Asia/Baku', 'Asia/Bangkok', 'Asia/Bangkok', 'Asia/Chongqing', 'Asia/Colombo', 'Asia/Dhaka', 'Asia/Dhaka', 'Asia/Hong_Kong', 'Asia/Irkutsk', 'Asia/Jakarta', 'Asia/Jerusalem', 'Asia/Kabul', 'Asia/Kamchatka', 'Asia/Karachi', 'Asia/Karachi', 'Asia/Kathmandu', 'Asia/Kolkata', 'Asia/Kolkata', 'Asia/Kolkata', 'Asia/Kolkata', 'Asia/Krasnoyarsk', 'Asia/Kuala_Lumpur', 'Asia/Kuwait', 'Asia/Magadan', 'Asia/Muscat', 'Asia/Muscat', 'Asia/Novosibirsk', 'Asia/Rangoon', 'Asia/Riyadh', 'Asia/Seoul', 'Asia/Shanghai', 'Asia/Singapore', 'Asia/Srednekolymsk', 'Asia/Taipei', 'Asia/Tashkent', 'Asia/Tbilisi', 'Asia/Tehran', 'Asia/Tokyo', 'Asia/Tokyo', 'Asia/Tokyo', 'Asia/Ulaanbaatar', 'Asia/Urumqi', 'Asia/Vladivostok', 'Asia/Yakutsk', 'Asia/Yekaterinburg', 'Asia/Yerevan', 'Atlantic/Azores', 'Atlantic/Cape_Verde', 'Atlantic/South_Georgia', 'Australia/Adelaide', 'Australia/Brisbane', 'Australia/Darwin', 'Australia/Hobart', 'Australia/Melbourne', 'Australia/Melbourne', 'Australia/Perth', 'Australia/Sydney', 'Etc/UTC', 'UTC', 'Europe/Amsterdam', 'Europe/Athens', 'Europe/Belgrade', 'Europe/Berlin', 'Europe/Berlin', 'Europe/Bratislava', 'Europe/Brussels', 'Europe/Bucharest', 'Europe/Budapest', 'Europe/Copenhagen', 'Europe/Dublin', 'Europe/Helsinki', 'Europe/Istanbul', 'Europe/Kaliningrad', 'Europe/Kiev', 'Europe/Lisbon', 'Europe/Ljubljana', 'Europe/London', 'Europe/London', 'Europe/Madrid', 'Europe/Minsk', 'Europe/Moscow', 'Europe/Moscow', 'Europe/Paris', 'Europe/Prague', 'Europe/Riga', 'Europe/Rome', 'Europe/Samara', 'Europe/Sarajevo', 'Europe/Skopje', 'Europe/Sofia', 'Europe/Stockholm', 'Europe/Tallinn', 'Europe/Vienna', 'Europe/Vilnius', 'Europe/Volgograd', 'Europe/Warsaw', 'Europe/Zagreb', 'Pacific/Apia', 'Pacific/Auckland', 'Pacific/Auckland', 'Pacific/Chatham', 'Pacific/Fakaofo', 'Pacific/Fiji', 'Pacific/Guadalcanal', 'Pacific/Guam', 'Pacific/Honolulu', 'Pacific/Majuro', 'Pacific/Midway', 'Pacific/Midway', 'Pacific/Noumea', 'Pacific/Pago_Pago', 'Pacific/Port_Moresby', 'Pacific/Tongatapu'].include?(opts[:'timezone'])
    fail ArgumentError, 'invalid value for "timezone", must be one of Africa/Algiers, Africa/Cairo, Africa/Casablanca, Africa/Harare, Africa/Johannesburg, Africa/Monrovia, Africa/Nairobi, America/Argentina/Buenos_Aires, America/Bogota, America/Caracas, America/Chicago, America/Chihuahua, America/Denver, America/Godthab, America/Guatemala, America/Guyana, America/Halifax, America/Indiana/Indianapolis, America/Juneau, America/La_Paz, America/Lima, America/Lima, America/Los_Angeles, America/Mazatlan, America/Mexico_City, America/Mexico_City, America/Monterrey, America/Montevideo, America/New_York, America/Phoenix, America/Regina, America/Santiago, America/Sao_Paulo, America/St_Johns, America/Tijuana, Asia/Almaty, Asia/Baghdad, Asia/Baku, Asia/Bangkok, Asia/Bangkok, Asia/Chongqing, Asia/Colombo, Asia/Dhaka, Asia/Dhaka, Asia/Hong_Kong, Asia/Irkutsk, Asia/Jakarta, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Karachi, Asia/Kathmandu, Asia/Kolkata, Asia/Kolkata, Asia/Kolkata, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuwait, Asia/Magadan, Asia/Muscat, Asia/Muscat, Asia/Novosibirsk, Asia/Rangoon, Asia/Riyadh, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Tokyo, Asia/Tokyo, Asia/Tokyo, Asia/Ulaanbaatar, Asia/Urumqi, Asia/Vladivostok, Asia/Yakutsk, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Cape_Verde, Atlantic/South_Georgia, Australia/Adelaide, Australia/Brisbane, Australia/Darwin, Australia/Hobart, Australia/Melbourne, Australia/Melbourne, Australia/Perth, Australia/Sydney, Etc/UTC, UTC, Europe/Amsterdam, Europe/Athens, Europe/Belgrade, Europe/Berlin, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Copenhagen, Europe/Dublin, Europe/Helsinki, Europe/Istanbul, Europe/Kaliningrad, Europe/Kiev, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/London, Europe/Madrid, Europe/Minsk, Europe/Moscow, Europe/Moscow, Europe/Paris, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/Sarajevo, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Pacific/Apia, Pacific/Auckland, Pacific/Auckland, Pacific/Chatham, Pacific/Fakaofo, Pacific/Fiji, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Majuro, Pacific/Midway, Pacific/Midway, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Port_Moresby, Pacific/Tongatapu'
  end
  # resource path
  local_var_path = "/securities/{identifier}/prices/intervals".sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'interval_size'] = interval_size
  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[:'timezone'] = opts[:'timezone'] if !opts[:'timezone'].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 => 'ApiResponseSecurityIntervalPrices')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_interval_prices\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:



828
829
830
831
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 828

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:



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
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 845

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:



902
903
904
905
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 902

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



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

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:



955
956
957
958
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 955

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



965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 965

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 The Accumulation / Distribution Indicator is a volume-based technical indicator which uses the relationship between the stock`s price and volume flow to determine the underlying trend of a stock, up, down, or sideways trend of a stock.

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:



1012
1013
1014
1015
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1012

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 The Accumulation / Distribution Indicator is a volume-based technical indicator which uses the relationship between the stock&#x60;s price and volume flow to determine the underlying trend of a stock, up, down, or sideways trend of a stock.

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:



1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1026

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 Average Daily Trading Volume is the average number of shares traded over a given period, usually between 20 to 30 trading days.

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:



1082
1083
1084
1085
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1082

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 Average Daily Trading Volume is the average number of shares traded over a given period, usually between 20 to 30 trading days.

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:



1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1097

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 The Average Directional Index indicator is often used to identify decreasing or increasing price momentum for an underlying security, it is composed of a total of three indicators, the current trendline (adx), a positive directional indicator (di_pos), and a negative directional indicator (di_neg).

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:



1158
1159
1160
1161
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1158

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 The Average Directional Index indicator is often used to identify decreasing or increasing price momentum for an underlying security, it is composed of a total of three indicators, the current trendline (adx), a positive directional indicator (di_pos), and a negative directional indicator (di_neg).

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:



1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1173

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 The Awesome Oscillator (ao) is a momentum indicator and is calculated by taking the difference between the latest 5 period simple moving average and the 34 period simple moving average. Rather than using the closing price like other indicators, the Awesome Oscillator uses the latest period`s midpoint value (period_high - period_low / 2). The Awesome Oscillator is useful in identifying and trading, zero-line crossovers, twin-peaks trading, and bullish/bearish saucers - Awesome Oscillator is often aggregated with additional technical indicators.

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:



1235
1236
1237
1238
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1235

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 The Awesome Oscillator (ao) is a momentum indicator and is calculated by taking the difference between the latest 5 period simple moving average and the 34 period simple moving average. Rather than using the closing price like other indicators, the Awesome Oscillator uses the latest period&#x60;s midpoint value (period_high - period_low / 2). The Awesome Oscillator is useful in identifying and trading, zero-line crossovers, twin-peaks trading, and bullish/bearish saucers - Awesome Oscillator is often aggregated with additional technical indicators.

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:



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
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1251

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 The Average True Range (ATR) is a non-directional market volatility indicator often used to generate stop-out or entry indications. An increasing or expanding ATR typically indicates higher volatility, and a decreasing ATR indicates sideways price action and lower volatility.

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:



1313
1314
1315
1316
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1313

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 The Average True Range (ATR) is a non-directional market volatility indicator often used to generate stop-out or entry indications. An increasing or expanding ATR typically indicates higher volatility, and a decreasing ATR indicates sideways price action and lower volatility.

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:



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
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1328

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 Bollinger Bands can be a useful technical analysis tool for generating oversold or overbought indicators. Bollinger Bands are composed of three lines, a simple moving average (middle band) and an upper and lower band – the upper and lower bands are typically 2 standard deviations +/- from a 20-day simple moving average, but can be modified. Traders typically consider an underlying security to be overbought as the underlying`s price moves towards the upper band and oversold as the underlying price moves towards the lower band.

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:



1391
1392
1393
1394
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1391

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 Bollinger Bands can be a useful technical analysis tool for generating oversold or overbought indicators. Bollinger Bands are composed of three lines, a simple moving average (middle band) and an upper and lower band – the upper and lower bands are typically 2 standard deviations +/- from a 20-day simple moving average, but can be modified. Traders typically consider an underlying security to be overbought as the underlying&#x60;s price moves towards the upper band and oversold as the underlying price moves towards the lower band.

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:



1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1408

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 The Commodity Channel Index (CCI) is a technical indicator used to generate buy and sell signals by indicating periods of strength and weakness in the market. CCI signals that fall below -100 are often perceived as weakness in the underlying price movement and CCI signals that rise above 100 indicate strength behind the underlying price movement.

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:



1475
1476
1477
1478
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1475

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 The Commodity Channel Index (CCI) is a technical indicator used to generate buy and sell signals by indicating periods of strength and weakness in the market. CCI signals that fall below -100 are often perceived as weakness in the underlying price movement and CCI signals that rise above 100 indicate strength behind the underlying price movement.

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:



1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1491

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 The Chaikin Money Flow (CMF) utilizes exponential moving averages as an indicator to monitor the flow of money and momentum. The CMF indicator oscillates around a midrange 0-line and ranges between 100 and -100.

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:



1553
1554
1555
1556
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1553

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 The Chaikin Money Flow (CMF) utilizes exponential moving averages as an indicator to monitor the flow of money and momentum. The CMF indicator oscillates around a midrange 0-line and ranges between 100 and -100.

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:



1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1568

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 The Donchian Channel consists of an Upper Bound (upper_bound) and Lower Bound (lower_bound) that track the recent highs and lows and is often used to signal entry and exit points for a position. As the price of the underlying symbol increases the Upper Bound raises, if the price becomes range bound the Upper Bound will remain flat and if the price begins to decrease, the Upper Bound will fall (and vice-versa for the Lower Bound).

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:



1630
1631
1632
1633
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1630

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 The Donchian Channel consists of an Upper Bound (upper_bound) and Lower Bound (lower_bound) that track the recent highs and lows and is often used to signal entry and exit points for a position. As the price of the underlying symbol increases the Upper Bound raises, if the price becomes range bound the Upper Bound will remain flat and if the price begins to decrease, the Upper Bound will fall (and vice-versa for the Lower Bound).

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:



1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1646

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 The Detrended Price Oscillator (DPO) signals the peaks and troughs of the underlying symbol’s price for a set period of time and is often used by traders to estimate future peaks and troughs using this as guidance to enter or exit a position.

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:



1712
1713
1714
1715
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1712

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 The Detrended Price Oscillator (DPO) signals the peaks and troughs of the underlying symbol’s price for a set period of time and is often used by traders to estimate future peaks and troughs using this as guidance to enter or exit a position.

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:



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
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1728

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 The Ease of Movement (EOM) is a volume based oscillator that fluctuates around a midrange 0-line into positive and negative values. Positive values indicate that the underlying symbol`s price is rising with relative ease and negative value indicates the underlying symbol`s price is failing with relative ease.

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:



1789
1790
1791
1792
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1789

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 The Ease of Movement (EOM) is a volume based oscillator that fluctuates around a midrange 0-line into positive and negative values. Positive values indicate that the underlying symbol&#x60;s price is rising with relative ease and negative value indicates the underlying symbol&#x60;s price is failing with relative ease.

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:



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

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 The Force Index (FI) is an oscillator that takes into account the intensity of an underlying symbol`s price movement and its corresponding volume. It is used to confirm price breakouts and signal underlying trends.

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:



1864
1865
1866
1867
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1864

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 The Force Index (FI) is an oscillator that takes into account the intensity of an underlying symbol&#x60;s price movement and its corresponding volume. It is used to confirm price breakouts and signal underlying trends.

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:



1878
1879
1880
1881
1882
1883
1884
1885
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
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1878

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 The Ichimoku Kinko Hyo was designed to be an all-in-one trading indicator that could help traders determine momentum, support, and resistance.

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:



1936
1937
1938
1939
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1936

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 The Ichimoku Kinko Hyo was designed to be an all-in-one trading indicator that could help traders determine momentum, support, and resistance.

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:



1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
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
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 1953

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 The Keltner Channel is a volatility based signal, with upper, middle, and lower bands. It is often used at market open, when the largest moves tend to occur. In general, traders tend to buy if the price breaks up above the upper band or sell short if the price drops below the lower band.

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:



2020
2021
2022
2023
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2020

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 The Keltner Channel is a volatility based signal, with upper, middle, and lower bands. It is often used at market open, when the largest moves tend to occur. In general, traders tend to buy if the price breaks up above the upper band or sell short if the price drops below the lower band.

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:



2035
2036
2037
2038
2039
2040
2041
2042
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
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2035

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 The Know Sure Thing indicator (KST) is a momentum based oscillator that is calculated by measuring the momentum of four separate price cycles. KST fluctuates above and below a zero line and is used to identify overbought and oversold conditions, and is often used with additional indicators to boost signal strength.

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:



2104
2105
2106
2107
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2104

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 The Know Sure Thing indicator (KST) is a momentum based oscillator that is calculated by measuring the momentum of four separate price cycles. KST fluctuates above and below a zero line and is used to identify overbought and oversold conditions, and is often used with additional indicators to boost signal strength.

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:



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
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2127

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 Moving average convergence divergence (MACD) is a trend-following momentum oscillator that consists of three indicators: (1) a 12 period short-term exponential moving average (EMA) a 26 period long-term EMA and a 9 period EMA signal line. Traders using MACD often look for signal line crossovers, centerline crossovers, and EMA divergences to indicate the momentum and underlying trend of a security`s price.

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:



2206
2207
2208
2209
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2206

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 Moving average convergence divergence (MACD) is a trend-following momentum oscillator that consists of three indicators: (1) a 12 period short-term exponential moving average (EMA) a 26 period long-term EMA and a 9 period EMA signal line. Traders using MACD often look for signal line crossovers, centerline crossovers, and EMA divergences to indicate the momentum and underlying trend of a security&#x60;s price.

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:



2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2224

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 The Money Flow Index (MFI) is a technical oscillator that incorporates both price and volume, moving between 0 and 100. Traders often consider a MFI above 80 as overbought conditions and below 20 as oversold conditions.

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:



2295
2296
2297
2298
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2295

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 The Money Flow Index (MFI) is a technical oscillator that incorporates both price and volume, moving between 0 and 100. Traders often consider a MFI above 80 as overbought conditions and below 20 as oversold conditions.

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:



2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2310

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 The mass index (MI) is a technical indicator used by traders to predict trend reversals. A trend reversal signal is said to occur when the 25-day MI reaches 27.0 and then falls below 26.0.

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:



2372
2373
2374
2375
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2372

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 The mass index (MI) is a technical indicator used by traders to predict trend reversals. A trend reversal signal is said to occur when the 25-day MI reaches 27.0 and then falls below 26.0.

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:



2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2388

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 The negative volume index (NVI) is often referred to as the ‘smart money indicator.` It works by the assumption that smart money (institutional money) is at work when volume decreases and vice versa when volume increases. NVI starts at 1000 and increases in regard to the percentage price change when volume decreases over a 255-day EMA period. Traders often use this technical indicator when researching broder markets and indices.

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:



2453
2454
2455
2456
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2453

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 The negative volume index (NVI) is often referred to as the &#x60;smart money indicator.&#x60; It works by the assumption that smart money (institutional money) is at work when volume decreases and vice versa when volume increases. NVI starts at 1000 and increases in regard to the percentage price change when volume decreases over a 255-day EMA period. Traders often use this technical indicator when researching broder markets and indices.

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:



2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2467

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 On-balance volume (OBV) is a leading momentum indicator that uses the increase/decrease flow in volume to predict upcoming stock price changes. When both OBV and a security`s price are making higher highs, it is presumed the upward trend is likely to continue and vice versa.

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:



2522
2523
2524
2525
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2522

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 On-balance volume mean (OBVM) is a leading momentum indicator that uses the increase/decrease flow in volume to predict upcoming stock price changes. The difference between OBV and OBVM is that OBVM takes the mean average of a provided period. When both OBVM and a security`s price are making higher highs, it is presumed the upward trend is likely to continue and vice versa.

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:



2592
2593
2594
2595
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2592

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 On-balance volume mean (OBVM) is a leading momentum indicator that uses the increase/decrease flow in volume to predict upcoming stock price changes. The difference between OBV and OBVM is that OBVM takes the mean average of a provided period. When both OBVM and a security&#x60;s price are making higher highs, it is presumed the upward trend is likely to continue and vice versa.

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:



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
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2607

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 On-balance volume (OBV) is a leading momentum indicator that uses the increase/decrease flow in volume to predict upcoming stock price changes. When both OBV and a security&#x60;s price are making higher highs, it is presumed the upward trend is likely to continue and vice versa.

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:



2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2536

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 Relative strength index (RSI) is a momentum oscillator that ranges between 0 and 100. Traders believe that an RSI value over 70 indicates that a security is overbought and an RSI under 30 indicates that a security is oversold.

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:



2669
2670
2671
2672
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2669

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 Relative strength index (RSI) is a momentum oscillator that ranges between 0 and 100. Traders believe that an RSI value over 70 indicates that a security is overbought and an RSI under 30 indicates that a security is oversold.

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:



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

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 A simple moving average (SMA) adds recent prices for a specified period and divides the total by that same number of periods. SMA is typically used to indicate whether a security is in an uptrend or downtrend and can also be combined with a long-term moving average to improve the signal`s abilities.

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:



2751
2752
2753
2754
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2751

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 A simple moving average (SMA) adds recent prices for a specified period and divides the total by that same number of periods. SMA is typically used to indicate whether a security is in an uptrend or downtrend and can also be combined with a long-term moving average to improve the signal&#x60;s abilities.

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:



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
2812
2813
2814
2815
2816
2817
2818
2819
2820
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2767

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 The Stochastic Oscillator (SO) is a range-bound momentum indicator that ranges from 0 to 100 and follows the velocity of the momentum itself, not the underlying price or volume. When SO is above 80 it indicates that a security is trading at the high end of its period`s high-low range and vice versa if the reading is below 20.

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:



2833
2834
2835
2836
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2833

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 The Stochastic Oscillator (SO) is a range-bound momentum indicator that ranges from 0 to 100 and follows the velocity of the momentum itself, not the underlying price or volume. When SO is above 80 it indicates that a security is trading at the high end of its period&#x60;s high-low range and vice versa if the reading is below 20.

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:



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
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2849

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 The Triple Exponential Average (TEA) is a momentum indicator used to identify when a security is oversold and overbought. By exponentially smoothing out the underlying security`s moving average, the TEA filters out insignificant price movements. A positive TEA is often believed to indicate momentum is increasing and a negative TEA indicates that momentum is decreasing.

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:



2915
2916
2917
2918
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2915

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 The Triple Exponential Average (TEA) is a momentum indicator used to identify when a security is oversold and overbought. By exponentially smoothing out the underlying security&#x60;s moving average, the TEA filters out insignificant price movements. A positive TEA is often believed to indicate momentum is increasing and a negative TEA indicates that momentum is decreasing.

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:



2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2930

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 The True Strength Index (TSI) is a momentum oscillator used to identify building trends and trend reversals, typically by signalling overbought and oversold conditions. TSI fluctuates between positive and negative values, and traders typically combine its signal with other momentum oscillators to increase its strength. When TSI crosses the signal line into positive territory it is presumed to be an entrance opportunity and vice versa when the TSI crosses into negative territory.

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:



2993
2994
2995
2996
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 2993

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 The True Strength Index (TSI) is a momentum oscillator used to identify building trends and trend reversals, typically by signalling overbought and oversold conditions. TSI fluctuates between positive and negative values, and traders typically combine its signal with other momentum oscillators to increase its strength. When TSI crosses the signal line into positive territory it is presumed to be an entrance opportunity and vice versa when the TSI crosses into negative territory.

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:



3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
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
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3010

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 The Ultimate Oscillator (UO) is a range bound technical indicator that moves between 0 and 100 and is calculated with 3 timeframes, typically 7, 14, and 28 day periods. When UO`s value is above 70 a security is categorized as overbought and when UO`s value is below 30 a security is categorized as oversold.

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:



3085
3086
3087
3088
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3085

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 The Ultimate Oscillator (UO) is a range bound technical indicator that moves between 0 and 100 and is calculated with 3 timeframes, typically 7, 14, and 28 day periods. When UO&#x60;s value is above 70 a security is categorized as overbought and when UO&#x60;s value is below 30 a security is categorized as oversold.

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:



3105
3106
3107
3108
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
3154
3155
3156
3157
3158
3159
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3105

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 The Vortex Indicator (VI) is composed of an uptrend line (VI+) and a downtrend line (VI-). When VI+ crosses VI- from below it typically indicates an entry into a given security. When VI- crosses VI+ from below it typically triggers an exit and that the current trend is reversing course.

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:



3171
3172
3173
3174
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3171

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 The Vortex Indicator (VI) is composed of an uptrend line (VI+) and a downtrend line (VI-). When VI+ crosses VI- from below it typically indicates an entry into a given security. When VI- crosses VI+ from below it typically triggers an exit and that the current trend is reversing course.

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:



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
3229
3230
3231
3232
3233
3234
3235
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3186

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 The volume price trend (VPT) is a technical indicator that uses price & volume to determine whether a trend is established. Typically, when a security is trending upwards, there is more volume on positive days than negative ones, and as a result VPT should be increasing on these days as well. However, if VPT fails to increase past its previous high during an outbreak, this is suggested to indicate the rally is losing strength.

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:



3246
3247
3248
3249
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3246

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 The volume price trend (VPT) is a technical indicator that uses price &amp; volume to determine whether a trend is established. Typically, when a security is trending upwards, there is more volume on positive days than negative ones, and as a result VPT should be increasing on these days as well. However, if VPT fails to increase past its previous high during an outbreak, this is suggested to indicate the rally is losing strength.

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:



3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
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
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3260

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 Volume Weighted Average Price (VWAP) is a lagging technical indicator that is used in combination with a security`s price. When the underlying price rises above its VWAP, it is often interpreted as a bullish signal, and vice versa in the opposite direction.

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:



3315
3316
3317
3318
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3315

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 Volume Weighted Average Price (VWAP) is a lagging technical indicator that is used in combination with a security&#x60;s price. When the underlying price rises above its VWAP, it is often interpreted as a bullish signal, and vice versa in the opposite direction.

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:



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

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 Williams %R is a momentum indicator used to determine overbought and oversold environments for a security and fluctuates between 0 and -100. When Williams %R is above -20 the security is considered to be overbought and when Williams %R is under -80 the security is considered to be oversold.

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:



3385
3386
3387
3388
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3385

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 Williams %R is a momentum indicator used to determine overbought and oversold environments for a security and fluctuates between 0 and -100. When Williams %R is above -20 the security is considered to be overbought and when Williams %R is under -80 the security is considered to be oversold.

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:



3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
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
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3400

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:



3457
3458
3459
3460
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3457

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



3468
3469
3470
3471
3472
3473
3474
3475
3476
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
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3468

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', 'utp_delayed', 'cta_a_delayed', 'cta_b_delayed', 'intrinio_mx', 'intrinio_mx_plus', 'delayed_sip'].include?(opts[:'source'])
    fail ArgumentError, 'invalid value for "source", must be one of iex, bats, bats_delayed, utp_delayed, cta_a_delayed, cta_b_delayed, intrinio_mx, intrinio_mx_plus, delayed_sip'
  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_replay_file(subsource, date, opts = {}) ⇒ SecurityReplayFileResult

Security Replay File Returns a url where the requested replay file may be downloaded from.

Parameters:

  • subsource —

    The specific source of the data being requested.

  • date —

    The date for the data being requested.

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

    the optional parameters

Returns:



3516
3517
3518
3519
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3516

def get_security_replay_file(subsource, date, opts = {})
  data, _status_code, _headers = get_security_replay_file_with_http_info(subsource, date, opts)
  return data
end

#get_security_replay_file_with_http_info(subsource, date, opts = {}) ⇒ Array<(SecurityReplayFileResult, Fixnum, Hash)>

Security Replay File Returns a url where the requested replay file may be downloaded from.

Parameters:

  • subsource —

    The specific source of the data being requested.

  • date —

    The date for the data being requested.

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

    the optional parameters

Returns:

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

    SecurityReplayFileResult data, response status code and response headers



3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
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
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3527

def get_security_replay_file_with_http_info(subsource, date, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_replay_file ..."
  end
  # verify the required parameter 'subsource' is set
  if @api_client.config.client_side_validation && subsource.nil?
    fail ArgumentError, "Missing the required parameter 'subsource' when calling SecurityApi.get_security_replay_file"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['iex', 'utp_delayed', 'cta_a_delayed', 'cta_b_delayed', 'otc_delayed', 'nasdaq_basic'].include?(subsource)
    fail ArgumentError, "invalid value for 'subsource', must be one of iex, utp_delayed, cta_a_delayed, cta_b_delayed, otc_delayed, nasdaq_basic"
  end
  # verify the required parameter 'date' is set
  if @api_client.config.client_side_validation && date.nil?
    fail ArgumentError, "Missing the required parameter 'date' when calling SecurityApi.get_security_replay_file"
  end
  # resource path
  local_var_path = "/securities/replay"

  # query parameters
  query_params = {}
  query_params[:'subsource'] = subsource
  query_params[:'date'] = date

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

#get_security_snapshots(opts = {}) ⇒ SecuritySnapshotsResult

Realtime Stock Prices Snapshot Returns all security snapshots for the queried interval with links to download.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :at_datetime (DateTime) —

    The UTC date and time (with url-encoded spaces) the snapshot will cover.

Returns:



3580
3581
3582
3583
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3580

def get_security_snapshots(opts = {})
  data, _status_code, _headers = get_security_snapshots_with_http_info(opts)
  return data
end

#get_security_snapshots_with_http_info(opts = {}) ⇒ Array<(SecuritySnapshotsResult, Fixnum, Hash)>

Realtime Stock Prices Snapshot Returns all security snapshots for the queried interval with links to download.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :at_datetime (DateTime) —

    The UTC date and time (with url-encoded spaces) the snapshot will cover.

Returns:

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

    SecuritySnapshotsResult data, response status code and response headers



3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3590

def get_security_snapshots_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_snapshots ..."
  end
  # resource path
  local_var_path = "/securities/snapshots"

  # query parameters
  query_params = {}
  query_params[:'at_datetime'] = opts[:'at_datetime'] if !opts[:'at_datetime'].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 => 'SecuritySnapshotsResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_snapshots\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:



3634
3635
3636
3637
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3634

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:



3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3648

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:



3704
3705
3706
3707
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3704

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:



3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3719

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_trades(source, opts = {}) ⇒ SecurityTradesResult

Security Trades Returns all trades between start time and end time, up to seven days ago for the specified source.

Parameters:

  • source —

    The specific source of the data being requested.

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

    the optional parameters

Options Hash (opts):

  • :start_date (Date) —

    The start date for the data being requested.

  • :start_time (String) —

    The start time for the data being requested.

  • :end_date (Date) —

    The end date for the data being requested.

  • :end_time (String) —

    The end time for the data being requested.

  • :timezone (String) —

    The timezone the start and end date/times use. (default to UTC)

  • :page_size (Integer) —

    The maximum number of results to return per page. (default to 100)

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



3781
3782
3783
3784
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3781

def get_security_trades(source, opts = {})
  data, _status_code, _headers = get_security_trades_with_http_info(source, opts)
  return data
end

#get_security_trades_by_symbol(identifier, source, opts = {}) ⇒ SecurityTradesResult

Security Trades By Symbol Returns all trades for a symbol between start time and end time, up to seven days ago for the specified source.

Parameters:

  • identifier —

    The ticker symbol for which trades are being requested.

  • source —

    The specific source of the data being requested. Specifying delayed sip will result in the system automatically determining which delayed sip source (cta_delayed, cta_b_delayed, utp_delayed) to use.

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

    the optional parameters

Options Hash (opts):

  • :start_date (Date) —

    The start date for the data being requested.

  • :start_time (String) —

    The start time for the data being requested.

  • :end_date (Date) —

    The end date for the data being requested.

  • :end_time (String) —

    The end time for the data being requested.

  • :timezone (String) —

    The timezone the start and end date/times use. (default to UTC)

  • :darkpool_only (BOOLEAN) —

    Set to true to show only darkpool trades (default to false)

  • :page_size (Integer) —

    The maximum number of results to return per page. (default to 100)

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:



3869
3870
3871
3872
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3869

def get_security_trades_by_symbol(identifier, source, opts = {})
  data, _status_code, _headers = get_security_trades_by_symbol_with_http_info(identifier, source, opts)
  return data
end

#get_security_trades_by_symbol_with_http_info(identifier, source, opts = {}) ⇒ Array<(SecurityTradesResult, Fixnum, Hash)>

Security Trades By Symbol Returns all trades for a symbol between start time and end time, up to seven days ago for the specified source.

Parameters:

  • identifier —

    The ticker symbol for which trades are being requested.

  • source —

    The specific source of the data being requested. Specifying delayed sip will result in the system automatically determining which delayed sip source (cta_delayed, cta_b_delayed, utp_delayed) to use.

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

    the optional parameters

Options Hash (opts):

  • :start_date (Date) —

    The start date for the data being requested.

  • :start_time (String) —

    The start time for the data being requested.

  • :end_date (Date) —

    The end date for the data being requested.

  • :end_time (String) —

    The end time for the data being requested.

  • :timezone (String) —

    The timezone the start and end date/times use.

  • :darkpool_only (BOOLEAN) —

    Set to true to show only darkpool trades

  • :page_size (Integer) —

    The maximum number of results to return per page.

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:

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

    SecurityTradesResult data, response status code and response headers



3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3888

def get_security_trades_by_symbol_with_http_info(identifier, source, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_trades_by_symbol ..."
  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_trades_by_symbol"
  end
  # verify the required parameter 'source' is set
  if @api_client.config.client_side_validation && source.nil?
    fail ArgumentError, "Missing the required parameter 'source' when calling SecurityApi.get_security_trades_by_symbol"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['nasdaq_basic', 'delayed_sip', 'iex', 'cta_a_delayed', 'cta_b_delayed', 'utp_delayed'].include?(source)
    fail ArgumentError, "invalid value for 'source', must be one of nasdaq_basic, delayed_sip, iex, cta_a_delayed, cta_b_delayed, utp_delayed"
  end
  if @api_client.config.client_side_validation && opts[:'timezone'] && !['Africa/Algiers', 'Africa/Cairo', 'Africa/Casablanca', 'Africa/Harare', 'Africa/Johannesburg', 'Africa/Monrovia', 'Africa/Nairobi', 'America/Argentina/Buenos_Aires', 'America/Bogota', 'America/Caracas', 'America/Chicago', 'America/Chihuahua', 'America/Denver', 'America/Godthab', 'America/Guatemala', 'America/Guyana', 'America/Halifax', 'America/Indiana/Indianapolis', 'America/Juneau', 'America/La_Paz', 'America/Lima', 'America/Lima', 'America/Los_Angeles', 'America/Mazatlan', 'America/Mexico_City', 'America/Mexico_City', 'America/Monterrey', 'America/Montevideo', 'America/New_York', 'America/Phoenix', 'America/Regina', 'America/Santiago', 'America/Sao_Paulo', 'America/St_Johns', 'America/Tijuana', 'Asia/Almaty', 'Asia/Baghdad', 'Asia/Baku', 'Asia/Bangkok', 'Asia/Bangkok', 'Asia/Chongqing', 'Asia/Colombo', 'Asia/Dhaka', 'Asia/Dhaka', 'Asia/Hong_Kong', 'Asia/Irkutsk', 'Asia/Jakarta', 'Asia/Jerusalem', 'Asia/Kabul', 'Asia/Kamchatka', 'Asia/Karachi', 'Asia/Karachi', 'Asia/Kathmandu', 'Asia/Kolkata', 'Asia/Kolkata', 'Asia/Kolkata', 'Asia/Kolkata', 'Asia/Krasnoyarsk', 'Asia/Kuala_Lumpur', 'Asia/Kuwait', 'Asia/Magadan', 'Asia/Muscat', 'Asia/Muscat', 'Asia/Novosibirsk', 'Asia/Rangoon', 'Asia/Riyadh', 'Asia/Seoul', 'Asia/Shanghai', 'Asia/Singapore', 'Asia/Srednekolymsk', 'Asia/Taipei', 'Asia/Tashkent', 'Asia/Tbilisi', 'Asia/Tehran', 'Asia/Tokyo', 'Asia/Tokyo', 'Asia/Tokyo', 'Asia/Ulaanbaatar', 'Asia/Urumqi', 'Asia/Vladivostok', 'Asia/Yakutsk', 'Asia/Yekaterinburg', 'Asia/Yerevan', 'Atlantic/Azores', 'Atlantic/Cape_Verde', 'Atlantic/South_Georgia', 'Australia/Adelaide', 'Australia/Brisbane', 'Australia/Darwin', 'Australia/Hobart', 'Australia/Melbourne', 'Australia/Melbourne', 'Australia/Perth', 'Australia/Sydney', 'Etc/UTC', 'UTC', 'Europe/Amsterdam', 'Europe/Athens', 'Europe/Belgrade', 'Europe/Berlin', 'Europe/Berlin', 'Europe/Bratislava', 'Europe/Brussels', 'Europe/Bucharest', 'Europe/Budapest', 'Europe/Copenhagen', 'Europe/Dublin', 'Europe/Helsinki', 'Europe/Istanbul', 'Europe/Kaliningrad', 'Europe/Kiev', 'Europe/Lisbon', 'Europe/Ljubljana', 'Europe/London', 'Europe/London', 'Europe/Madrid', 'Europe/Minsk', 'Europe/Moscow', 'Europe/Moscow', 'Europe/Paris', 'Europe/Prague', 'Europe/Riga', 'Europe/Rome', 'Europe/Samara', 'Europe/Sarajevo', 'Europe/Skopje', 'Europe/Sofia', 'Europe/Stockholm', 'Europe/Tallinn', 'Europe/Vienna', 'Europe/Vilnius', 'Europe/Volgograd', 'Europe/Warsaw', 'Europe/Zagreb', 'Pacific/Apia', 'Pacific/Auckland', 'Pacific/Auckland', 'Pacific/Chatham', 'Pacific/Fakaofo', 'Pacific/Fiji', 'Pacific/Guadalcanal', 'Pacific/Guam', 'Pacific/Honolulu', 'Pacific/Majuro', 'Pacific/Midway', 'Pacific/Midway', 'Pacific/Noumea', 'Pacific/Pago_Pago', 'Pacific/Port_Moresby', 'Pacific/Tongatapu'].include?(opts[:'timezone'])
    fail ArgumentError, 'invalid value for "timezone", must be one of Africa/Algiers, Africa/Cairo, Africa/Casablanca, Africa/Harare, Africa/Johannesburg, Africa/Monrovia, Africa/Nairobi, America/Argentina/Buenos_Aires, America/Bogota, America/Caracas, America/Chicago, America/Chihuahua, America/Denver, America/Godthab, America/Guatemala, America/Guyana, America/Halifax, America/Indiana/Indianapolis, America/Juneau, America/La_Paz, America/Lima, America/Lima, America/Los_Angeles, America/Mazatlan, America/Mexico_City, America/Mexico_City, America/Monterrey, America/Montevideo, America/New_York, America/Phoenix, America/Regina, America/Santiago, America/Sao_Paulo, America/St_Johns, America/Tijuana, Asia/Almaty, Asia/Baghdad, Asia/Baku, Asia/Bangkok, Asia/Bangkok, Asia/Chongqing, Asia/Colombo, Asia/Dhaka, Asia/Dhaka, Asia/Hong_Kong, Asia/Irkutsk, Asia/Jakarta, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Karachi, Asia/Kathmandu, Asia/Kolkata, Asia/Kolkata, Asia/Kolkata, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuwait, Asia/Magadan, Asia/Muscat, Asia/Muscat, Asia/Novosibirsk, Asia/Rangoon, Asia/Riyadh, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Tokyo, Asia/Tokyo, Asia/Tokyo, Asia/Ulaanbaatar, Asia/Urumqi, Asia/Vladivostok, Asia/Yakutsk, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Cape_Verde, Atlantic/South_Georgia, Australia/Adelaide, Australia/Brisbane, Australia/Darwin, Australia/Hobart, Australia/Melbourne, Australia/Melbourne, Australia/Perth, Australia/Sydney, Etc/UTC, UTC, Europe/Amsterdam, Europe/Athens, Europe/Belgrade, Europe/Berlin, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Copenhagen, Europe/Dublin, Europe/Helsinki, Europe/Istanbul, Europe/Kaliningrad, Europe/Kiev, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/London, Europe/Madrid, Europe/Minsk, Europe/Moscow, Europe/Moscow, Europe/Paris, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/Sarajevo, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Pacific/Apia, Pacific/Auckland, Pacific/Auckland, Pacific/Chatham, Pacific/Fakaofo, Pacific/Fiji, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Majuro, Pacific/Midway, Pacific/Midway, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Port_Moresby, Pacific/Tongatapu'
  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_trades_by_symbol, must be smaller than or equal to 10000.'
  end

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

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

#get_security_trades_with_http_info(source, opts = {}) ⇒ Array<(SecurityTradesResult, Fixnum, Hash)>

Security Trades Returns all trades between start time and end time, up to seven days ago for the specified source.

Parameters:

  • source —

    The specific source of the data being requested.

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

    the optional parameters

Options Hash (opts):

  • :start_date (Date) —

    The start date for the data being requested.

  • :start_time (String) —

    The start time for the data being requested.

  • :end_date (Date) —

    The end date for the data being requested.

  • :end_time (String) —

    The end time for the data being requested.

  • :timezone (String) —

    The timezone the start and end date/times use.

  • :page_size (Integer) —

    The maximum number of results to return per page.

  • :next_page (String) —

    Gets the next page of data from a previous API call

Returns:

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

    SecurityTradesResult data, response status code and response headers



3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3798

def get_security_trades_with_http_info(source, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SecurityApi.get_security_trades ..."
  end
  # verify the required parameter 'source' is set
  if @api_client.config.client_side_validation && source.nil?
    fail ArgumentError, "Missing the required parameter 'source' when calling SecurityApi.get_security_trades"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['nasdaq_basic', 'iex', 'cta_a_delayed', 'cta_b_delayed', 'utp_delayed'].include?(source)
    fail ArgumentError, "invalid value for 'source', must be one of nasdaq_basic, iex, cta_a_delayed, cta_b_delayed, utp_delayed"
  end
  if @api_client.config.client_side_validation && opts[:'timezone'] && !['Africa/Algiers', 'Africa/Cairo', 'Africa/Casablanca', 'Africa/Harare', 'Africa/Johannesburg', 'Africa/Monrovia', 'Africa/Nairobi', 'America/Argentina/Buenos_Aires', 'America/Bogota', 'America/Caracas', 'America/Chicago', 'America/Chihuahua', 'America/Denver', 'America/Godthab', 'America/Guatemala', 'America/Guyana', 'America/Halifax', 'America/Indiana/Indianapolis', 'America/Juneau', 'America/La_Paz', 'America/Lima', 'America/Lima', 'America/Los_Angeles', 'America/Mazatlan', 'America/Mexico_City', 'America/Mexico_City', 'America/Monterrey', 'America/Montevideo', 'America/New_York', 'America/Phoenix', 'America/Regina', 'America/Santiago', 'America/Sao_Paulo', 'America/St_Johns', 'America/Tijuana', 'Asia/Almaty', 'Asia/Baghdad', 'Asia/Baku', 'Asia/Bangkok', 'Asia/Bangkok', 'Asia/Chongqing', 'Asia/Colombo', 'Asia/Dhaka', 'Asia/Dhaka', 'Asia/Hong_Kong', 'Asia/Irkutsk', 'Asia/Jakarta', 'Asia/Jerusalem', 'Asia/Kabul', 'Asia/Kamchatka', 'Asia/Karachi', 'Asia/Karachi', 'Asia/Kathmandu', 'Asia/Kolkata', 'Asia/Kolkata', 'Asia/Kolkata', 'Asia/Kolkata', 'Asia/Krasnoyarsk', 'Asia/Kuala_Lumpur', 'Asia/Kuwait', 'Asia/Magadan', 'Asia/Muscat', 'Asia/Muscat', 'Asia/Novosibirsk', 'Asia/Rangoon', 'Asia/Riyadh', 'Asia/Seoul', 'Asia/Shanghai', 'Asia/Singapore', 'Asia/Srednekolymsk', 'Asia/Taipei', 'Asia/Tashkent', 'Asia/Tbilisi', 'Asia/Tehran', 'Asia/Tokyo', 'Asia/Tokyo', 'Asia/Tokyo', 'Asia/Ulaanbaatar', 'Asia/Urumqi', 'Asia/Vladivostok', 'Asia/Yakutsk', 'Asia/Yekaterinburg', 'Asia/Yerevan', 'Atlantic/Azores', 'Atlantic/Cape_Verde', 'Atlantic/South_Georgia', 'Australia/Adelaide', 'Australia/Brisbane', 'Australia/Darwin', 'Australia/Hobart', 'Australia/Melbourne', 'Australia/Melbourne', 'Australia/Perth', 'Australia/Sydney', 'Etc/UTC', 'UTC', 'Europe/Amsterdam', 'Europe/Athens', 'Europe/Belgrade', 'Europe/Berlin', 'Europe/Berlin', 'Europe/Bratislava', 'Europe/Brussels', 'Europe/Bucharest', 'Europe/Budapest', 'Europe/Copenhagen', 'Europe/Dublin', 'Europe/Helsinki', 'Europe/Istanbul', 'Europe/Kaliningrad', 'Europe/Kiev', 'Europe/Lisbon', 'Europe/Ljubljana', 'Europe/London', 'Europe/London', 'Europe/Madrid', 'Europe/Minsk', 'Europe/Moscow', 'Europe/Moscow', 'Europe/Paris', 'Europe/Prague', 'Europe/Riga', 'Europe/Rome', 'Europe/Samara', 'Europe/Sarajevo', 'Europe/Skopje', 'Europe/Sofia', 'Europe/Stockholm', 'Europe/Tallinn', 'Europe/Vienna', 'Europe/Vilnius', 'Europe/Volgograd', 'Europe/Warsaw', 'Europe/Zagreb', 'Pacific/Apia', 'Pacific/Auckland', 'Pacific/Auckland', 'Pacific/Chatham', 'Pacific/Fakaofo', 'Pacific/Fiji', 'Pacific/Guadalcanal', 'Pacific/Guam', 'Pacific/Honolulu', 'Pacific/Majuro', 'Pacific/Midway', 'Pacific/Midway', 'Pacific/Noumea', 'Pacific/Pago_Pago', 'Pacific/Port_Moresby', 'Pacific/Tongatapu'].include?(opts[:'timezone'])
    fail ArgumentError, 'invalid value for "timezone", must be one of Africa/Algiers, Africa/Cairo, Africa/Casablanca, Africa/Harare, Africa/Johannesburg, Africa/Monrovia, Africa/Nairobi, America/Argentina/Buenos_Aires, America/Bogota, America/Caracas, America/Chicago, America/Chihuahua, America/Denver, America/Godthab, America/Guatemala, America/Guyana, America/Halifax, America/Indiana/Indianapolis, America/Juneau, America/La_Paz, America/Lima, America/Lima, America/Los_Angeles, America/Mazatlan, America/Mexico_City, America/Mexico_City, America/Monterrey, America/Montevideo, America/New_York, America/Phoenix, America/Regina, America/Santiago, America/Sao_Paulo, America/St_Johns, America/Tijuana, Asia/Almaty, Asia/Baghdad, Asia/Baku, Asia/Bangkok, Asia/Bangkok, Asia/Chongqing, Asia/Colombo, Asia/Dhaka, Asia/Dhaka, Asia/Hong_Kong, Asia/Irkutsk, Asia/Jakarta, Asia/Jerusalem, Asia/Kabul, Asia/Kamchatka, Asia/Karachi, Asia/Karachi, Asia/Kathmandu, Asia/Kolkata, Asia/Kolkata, Asia/Kolkata, Asia/Kolkata, Asia/Krasnoyarsk, Asia/Kuala_Lumpur, Asia/Kuwait, Asia/Magadan, Asia/Muscat, Asia/Muscat, Asia/Novosibirsk, Asia/Rangoon, Asia/Riyadh, Asia/Seoul, Asia/Shanghai, Asia/Singapore, Asia/Srednekolymsk, Asia/Taipei, Asia/Tashkent, Asia/Tbilisi, Asia/Tehran, Asia/Tokyo, Asia/Tokyo, Asia/Tokyo, Asia/Ulaanbaatar, Asia/Urumqi, Asia/Vladivostok, Asia/Yakutsk, Asia/Yekaterinburg, Asia/Yerevan, Atlantic/Azores, Atlantic/Cape_Verde, Atlantic/South_Georgia, Australia/Adelaide, Australia/Brisbane, Australia/Darwin, Australia/Hobart, Australia/Melbourne, Australia/Melbourne, Australia/Perth, Australia/Sydney, Etc/UTC, UTC, Europe/Amsterdam, Europe/Athens, Europe/Belgrade, Europe/Berlin, Europe/Berlin, Europe/Bratislava, Europe/Brussels, Europe/Bucharest, Europe/Budapest, Europe/Copenhagen, Europe/Dublin, Europe/Helsinki, Europe/Istanbul, Europe/Kaliningrad, Europe/Kiev, Europe/Lisbon, Europe/Ljubljana, Europe/London, Europe/London, Europe/Madrid, Europe/Minsk, Europe/Moscow, Europe/Moscow, Europe/Paris, Europe/Prague, Europe/Riga, Europe/Rome, Europe/Samara, Europe/Sarajevo, Europe/Skopje, Europe/Sofia, Europe/Stockholm, Europe/Tallinn, Europe/Vienna, Europe/Vilnius, Europe/Volgograd, Europe/Warsaw, Europe/Zagreb, Pacific/Apia, Pacific/Auckland, Pacific/Auckland, Pacific/Chatham, Pacific/Fakaofo, Pacific/Fiji, Pacific/Guadalcanal, Pacific/Guam, Pacific/Honolulu, Pacific/Majuro, Pacific/Midway, Pacific/Midway, Pacific/Noumea, Pacific/Pago_Pago, Pacific/Port_Moresby, Pacific/Tongatapu'
  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_trades, must be smaller than or equal to 10000.'
  end

  # resource path
  local_var_path = "/securities/trades"

  # query parameters
  query_params = {}
  query_params[:'source'] = source
  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[:'timezone'] = opts[:'timezone'] if !opts[:'timezone'].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 => 'SecurityTradesResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SecurityApi#get_security_trades\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 for Security This database offers consensus analyst recommendations for over 5,000 US and Canadian listed companies.

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:



3972
3973
3974
3975
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3972

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 This database offers current and historical consensus analyst recommendation snapshots for over 5,000 US and Canadian listed companies.

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:



4128
4129
4130
4131
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 4128

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 This database offers current and historical consensus analyst recommendation snapshots for over 5,000 US and Canadian listed companies.

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:



4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 4139

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 for Security This database offers consensus analyst recommendations for over 5,000 US and Canadian listed companies.

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:



3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 3999

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 Returns historical estimated and actual earnings, guidance, and announcement dates for a specified symbol.

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:



4185
4186
4187
4188
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 4185

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 Returns historical estimated and actual earnings, guidance, and announcement dates for a specified symbol.

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:



4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 4197

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 This database returns historical estimated and actual sales, guidance, and announcement dates for a specified US or Canadian company.

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:



4248
4249
4250
4251
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 4248

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 This database returns historical estimated and actual sales, guidance, and announcement dates for a specified US or Canadian company.

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:



4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 4260

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:



4313
4314
4315
4316
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 4313

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



4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 4327

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 Search the securities database and return a list of securities matching the text query parameter passed through. Query parameter searches across the security ticker and name.

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:



4380
4381
4382
4383
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 4380

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 Search the securities database and return a list of securities matching the text query parameter passed through. Query parameter searches across the security ticker and name.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page_size (Integer) —

    The number of results to return

Returns:



4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
 
# File 'lib/intrinio-sdk/api/security_api.rb', line 4391

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