Class: Intrinio::TechnicalApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TechnicalApi

Returns a new instance of TechnicalApi.



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

def api_client
  @api_client
end

Instance Method Details

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



32
33
34
35
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 32

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:



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 46

def get_security_price_technicals_adi_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#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:



102
103
104
105
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 102

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:



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 117

def get_security_price_technicals_adtv_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#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:



178
179
180
181
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 178

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:



193
194
195
196
197
198
199
200
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
242
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 193

def get_security_price_technicals_adx_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#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:



255
256
257
258
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 255

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:



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
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 271

def get_security_price_technicals_ao_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#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:



333
334
335
336
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 333

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:



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
391
392
393
394
395
396
397
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 348

def get_security_price_technicals_atr_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#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:



411
412
413
414
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 411

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:



428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 428

def get_security_price_technicals_bb_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#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:



495
496
497
498
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 495

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:



511
512
513
514
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
553
554
555
556
557
558
559
560
561
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 511

def get_security_price_technicals_cci_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#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:



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

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:



588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 588

def get_security_price_technicals_cmf_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#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:



650
651
652
653
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 650

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:



666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
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
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 666

def get_security_price_technicals_dc_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#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:



732
733
734
735
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 732

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:



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

def get_security_price_technicals_dpo_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#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:



809
810
811
812
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 809

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:



824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 824

def get_security_price_technicals_eom_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#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:



884
885
886
887
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 884

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:



898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 898

def get_security_price_technicals_fi_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#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:



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

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:



973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 973

def get_security_price_technicals_ichimoku_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#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:



1040
1041
1042
1043
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 1040

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:



1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 1055

def get_security_price_technicals_kc_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#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:



1124
1125
1126
1127
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 1124

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:



1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 1147

def get_security_price_technicals_kst_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#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:



1226
1227
1228
1229
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 1226

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:



1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
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
1302
1303
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 1244

def get_security_price_technicals_macd_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#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:



1315
1316
1317
1318
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 1315

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:



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
1378
1379
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 1330

def get_security_price_technicals_mfi_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#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:



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

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:



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/technical_api.rb', line 1408

def get_security_price_technicals_mi_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#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:



1473
1474
1475
1476
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 1473

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:



1487
1488
1489
1490
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
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 1487

def get_security_price_technicals_nvi_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#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:



1542
1543
1544
1545
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 1542

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:



1612
1613
1614
1615
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 1612

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:



1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 1627

def get_security_price_technicals_obv_mean_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#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:



1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 1556

def get_security_price_technicals_obv_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#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:



1689
1690
1691
1692
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 1689

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:



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

def get_security_price_technicals_rsi_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#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:



1771
1772
1773
1774
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 1771

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:



1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 1787

def get_security_price_technicals_sma_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#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:



1853
1854
1855
1856
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 1853

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:



1869
1870
1871
1872
1873
1874
1875
1876
1877
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
1923
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 1869

def get_security_price_technicals_sr_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#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:



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

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:



1950
1951
1952
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
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 1950

def get_security_price_technicals_trix_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#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:



2013
2014
2015
2016
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 2013

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:



2030
2031
2032
2033
2034
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
2085
2086
2087
2088
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 2030

def get_security_price_technicals_tsi_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#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:



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

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:



2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 2125

def get_security_price_technicals_uo_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#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:



2191
2192
2193
2194
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 2191

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:



2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 2206

def get_security_price_technicals_vi_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#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:



2266
2267
2268
2269
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 2266

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:



2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 2280

def get_security_price_technicals_vpt_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#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:



2335
2336
2337
2338
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 2335

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:



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

def get_security_price_technicals_vwap_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#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:



2405
2406
2407
2408
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 2405

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:



2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
 
# File 'lib/intrinio-sdk/api/technical_api.rb', line 2420

def get_security_price_technicals_wr_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TechnicalApi.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 TechnicalApi.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 TechnicalApi.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 TechnicalApi.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: TechnicalApi#get_security_price_technicals_wr\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end