docs/SecurityApi.md in intrinio-sdk-2.3.0 vs docs/SecurityApi.md in intrinio-sdk-3.0.0

- old
+ new

@@ -52,31 +52,18 @@ [**get_security_zacks_sales_surprises**](SecurityApi.md#get_security_zacks_sales_surprises) | **GET** /securities/{identifier}/zacks/sales_surprises | Zacks Sales Surprises for Security [**screen_securities**](SecurityApi.md#screen_securities) | **POST** /securities/screen | Screen Securities [**search_securities**](SecurityApi.md#search_securities) | **GET** /securities/search | Search Securities - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities) - -[//]: # (DOC_LINK:SecurityApi.md#get_all_securities) - # **get_all_securities** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_all_securities_v2) - > ApiResponseSecurities get_all_securities(opts) All Securities Returns all Securities to which you have access. ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -97,12 +84,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_all_securities: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page_size** | **Integer**| The number of results to return | [optional] [default to 100] @@ -110,33 +95,18 @@ ### Return type [**ApiResponseSecurities**](ApiResponseSecurities.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_by_id) - # **get_security_by_id** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_by_id_v2) - > Security get_security_by_id(identifier) Lookup Security Returns the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -155,45 +125,28 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_by_id: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | ### Return type [**Security**](Security.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/data_point/{tag}/number) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_data_point_number) - # **get_security_data_point_number** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_data_point_number_v2) - > Float get_security_data_point_number(identifier, tag) Data Point (Number) for Security Returns a numeric value for the given `tag` for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -214,12 +167,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_data_point_number: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -227,33 +178,18 @@ ### Return type **Float** -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/data_point/{tag}/text) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_data_point_text) - # **get_security_data_point_text** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_data_point_text_v2) - > String get_security_data_point_text(identifier, tag) Data Point (Text) for Security Returns a text value for the given `tag` for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -274,12 +210,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_data_point_text: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -287,33 +221,18 @@ ### Return type **String** -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/historical_data/{tag}) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_historical_data) - # **get_security_historical_data** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_historical_data_v2) - > ApiResponseSecurityHistoricalData get_security_historical_data(identifier, tag, opts) Historical Data for Security Returns historical values for the given `tag` and the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -343,12 +262,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_historical_data: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -363,33 +280,18 @@ ### Return type [**ApiResponseSecurityHistoricalData**](ApiResponseSecurityHistoricalData.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/intraday) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_intraday_prices) - # **get_security_intraday_prices** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_intraday_prices_v2) - > ApiResponseSecurityIntradayPrices get_security_intraday_prices(identifier, opts) Intraday Stock Prices for Security Return intraday stock prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -415,12 +317,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_intraday_prices: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -432,33 +332,18 @@ ### Return type [**ApiResponseSecurityIntradayPrices**](ApiResponseSecurityIntradayPrices.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/dividends/latest) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_latest_dividend_record) - # **get_security_latest_dividend_record** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_latest_dividend_record_v2) - > DividendRecord get_security_latest_dividend_record(identifier) Lastest Dividend Record for Security Returns the latest available dividend information for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -477,45 +362,28 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_latest_dividend_record: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | ### Return type [**DividendRecord**](DividendRecord.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/earnings/latest) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_latest_earnings_record) - # **get_security_latest_earnings_record** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_latest_earnings_record_v2) - > EarningsRecord get_security_latest_earnings_record(identifier) Lastest Earnings Record for Security Returns latest available earnings information for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -534,45 +402,28 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_latest_earnings_record: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | ### Return type [**EarningsRecord**](EarningsRecord.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/adi) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_adi) - # **get_security_price_technicals_adi** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_adi_v2) - > ApiResponseSecurityAccumulationDistributionIndex get_security_price_technicals_adi(identifier, opts) Accumulation/Distribution Index Returns the Accumulation/Distribution Index values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -597,12 +448,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_adi: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -613,33 +462,18 @@ ### Return type [**ApiResponseSecurityAccumulationDistributionIndex**](ApiResponseSecurityAccumulationDistributionIndex.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/adtv) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_adtv) - # **get_security_price_technicals_adtv** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_adtv_v2) - > ApiResponseSecurityAverageDailyTradingVolume get_security_price_technicals_adtv(identifier, opts) Average Daily Trading Volume Returns the Average Daily Trading Volume values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -665,12 +499,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_adtv: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -682,33 +514,18 @@ ### Return type [**ApiResponseSecurityAverageDailyTradingVolume**](ApiResponseSecurityAverageDailyTradingVolume.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/adx) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_adx) - # **get_security_price_technicals_adx** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_adx_v2) - > ApiResponseSecurityAverageDirectionalIndex get_security_price_technicals_adx(identifier, opts) Average Directional Index Returns the Average Directional Index values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -734,12 +551,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_adx: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -751,33 +566,18 @@ ### Return type [**ApiResponseSecurityAverageDirectionalIndex**](ApiResponseSecurityAverageDirectionalIndex.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/ao) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_ao) - # **get_security_price_technicals_ao** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_ao_v2) - > ApiResponseSecurityAwesomeOscillator get_security_price_technicals_ao(identifier, opts) Awesome Oscillator Returns the Awesome Oscillator values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -804,12 +604,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_ao: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -822,33 +620,18 @@ ### Return type [**ApiResponseSecurityAwesomeOscillator**](ApiResponseSecurityAwesomeOscillator.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/atr) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_atr) - # **get_security_price_technicals_atr** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_atr_v2) - > ApiResponseSecurityAverageTrueRange get_security_price_technicals_atr(identifier, opts) Average True Range Returns the Average True Range values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -874,12 +657,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_atr: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -891,33 +672,18 @@ ### Return type [**ApiResponseSecurityAverageTrueRange**](ApiResponseSecurityAverageTrueRange.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/bb) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_bb) - # **get_security_price_technicals_bb** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_bb_v2) - > ApiResponseSecurityBollingerBands get_security_price_technicals_bb(identifier, opts) Bollinger Bands Returns the Bollinger Bands values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -945,12 +711,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_bb: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -964,33 +728,18 @@ ### Return type [**ApiResponseSecurityBollingerBands**](ApiResponseSecurityBollingerBands.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/cci) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_cci) - # **get_security_price_technicals_cci** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_cci_v2) - > ApiResponseSecurityCommodityChannelIndex get_security_price_technicals_cci(identifier, opts) Commodity Channel Index Returns the Commodity Channel Index values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1017,12 +766,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_cci: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1035,33 +782,18 @@ ### Return type [**ApiResponseSecurityCommodityChannelIndex**](ApiResponseSecurityCommodityChannelIndex.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/cmf) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_cmf) - # **get_security_price_technicals_cmf** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_cmf_v2) - > ApiResponseSecurityChaikinMoneyFlow get_security_price_technicals_cmf(identifier, opts) Chaikin Money Flow Returns the Chaikin Money Flow values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1087,12 +819,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_cmf: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1104,33 +834,18 @@ ### Return type [**ApiResponseSecurityChaikinMoneyFlow**](ApiResponseSecurityChaikinMoneyFlow.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/dc) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_dc) - # **get_security_price_technicals_dc** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_dc_v2) - > ApiResponseSecurityDonchianChannel get_security_price_technicals_dc(identifier, opts) Donchian Channel Returns the Donchian Channel values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1157,12 +872,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_dc: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1175,33 +888,18 @@ ### Return type [**ApiResponseSecurityDonchianChannel**](ApiResponseSecurityDonchianChannel.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/dpo) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_dpo) - # **get_security_price_technicals_dpo** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_dpo_v2) - > ApiResponseSecurityDetrendedPriceOscillator get_security_price_technicals_dpo(identifier, opts) Detrended Price Oscillator Returns the Detrended Price Oscillator values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1228,12 +926,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_dpo: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1246,33 +942,18 @@ ### Return type [**ApiResponseSecurityDetrendedPriceOscillator**](ApiResponseSecurityDetrendedPriceOscillator.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/eom) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_eom) - # **get_security_price_technicals_eom** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_eom_v2) - > ApiResponseSecurityEaseOfMovement get_security_price_technicals_eom(identifier, opts) Ease of Movement Returns the Ease of Movement values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1298,12 +979,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_eom: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1315,33 +994,18 @@ ### Return type [**ApiResponseSecurityEaseOfMovement**](ApiResponseSecurityEaseOfMovement.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/fi) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_fi) - # **get_security_price_technicals_fi** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_fi_v2) - > ApiResponseSecurityForceIndex get_security_price_technicals_fi(identifier, opts) Force Index Returns the Force Index values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1366,12 +1030,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_fi: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1382,33 +1044,18 @@ ### Return type [**ApiResponseSecurityForceIndex**](ApiResponseSecurityForceIndex.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/ichimoku) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_ichimoku) - # **get_security_price_technicals_ichimoku** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_ichimoku_v2) - > ApiResponseSecurityIchimokuKinkoHyo get_security_price_technicals_ichimoku(identifier, opts) Ichimoku Kinko Hyo Returns the Ichimoku Kinko Hyo values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1436,12 +1083,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_ichimoku: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1455,33 +1100,18 @@ ### Return type [**ApiResponseSecurityIchimokuKinkoHyo**](ApiResponseSecurityIchimokuKinkoHyo.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/kc) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_kc) - # **get_security_price_technicals_kc** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_kc_v2) - > ApiResponseSecurityKeltnerChannel get_security_price_technicals_kc(identifier, opts) Keltner Channel Returns the Keltner Channel values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1507,12 +1137,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_kc: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1524,33 +1152,18 @@ ### Return type [**ApiResponseSecurityKeltnerChannel**](ApiResponseSecurityKeltnerChannel.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/kst) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_kst) - # **get_security_price_technicals_kst** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_kst_v2) - > ApiResponseSecurityKnowSureThing get_security_price_technicals_kst(identifier, opts) Know Sure Thing Returns the Know Sure Thing values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1584,12 +1197,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_kst: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1609,33 +1220,18 @@ ### Return type [**ApiResponseSecurityKnowSureThing**](ApiResponseSecurityKnowSureThing.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/macd) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_macd) - # **get_security_price_technicals_macd** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_macd_v2) - > ApiResponseSecurityMovingAverageConvergenceDivergence get_security_price_technicals_macd(identifier, opts) Moving Average Convergence Divergence Returns the Moving Average Convergence Divergence values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1664,12 +1260,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_macd: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1684,33 +1278,18 @@ ### Return type [**ApiResponseSecurityMovingAverageConvergenceDivergence**](ApiResponseSecurityMovingAverageConvergenceDivergence.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/mfi) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_mfi) - # **get_security_price_technicals_mfi** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_mfi_v2) - > ApiResponseSecurityMoneyFlowIndex get_security_price_technicals_mfi(identifier, opts) Money Flow Index Returns the Money Flow Index values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1736,12 +1315,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_mfi: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1753,33 +1330,18 @@ ### Return type [**ApiResponseSecurityMoneyFlowIndex**](ApiResponseSecurityMoneyFlowIndex.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/mi) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_mi) - # **get_security_price_technicals_mi** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_mi_v2) - > ApiResponseSecurityMassIndex get_security_price_technicals_mi(identifier, opts) Mass Index Returns the Mass Index values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1806,12 +1368,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_mi: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1824,33 +1384,18 @@ ### Return type [**ApiResponseSecurityMassIndex**](ApiResponseSecurityMassIndex.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/nvi) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_nvi) - # **get_security_price_technicals_nvi** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_nvi_v2) - > ApiResponseSecurityNegativeVolumeIndex get_security_price_technicals_nvi(identifier, opts) Negative Volume Index Returns the Negative Volume Index values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1875,12 +1420,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_nvi: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1891,33 +1434,18 @@ ### Return type [**ApiResponseSecurityNegativeVolumeIndex**](ApiResponseSecurityNegativeVolumeIndex.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/obv) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_obv) - # **get_security_price_technicals_obv** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_obv_v2) - > ApiResponseSecurityOnBalanceVolume get_security_price_technicals_obv(identifier, opts) On-balance Volume Returns the On-balance Volume values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1942,12 +1470,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_obv: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1958,33 +1484,18 @@ ### Return type [**ApiResponseSecurityOnBalanceVolume**](ApiResponseSecurityOnBalanceVolume.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/obv_mean) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_obv_mean) - # **get_security_price_technicals_obv_mean** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_obv_mean_v2) - > ApiResponseSecurityOnBalanceVolumeMean get_security_price_technicals_obv_mean(identifier, opts) On-balance Volume Mean Returns the On-balance Volume Mean values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -2010,12 +1521,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_obv_mean: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -2027,33 +1536,18 @@ ### Return type [**ApiResponseSecurityOnBalanceVolumeMean**](ApiResponseSecurityOnBalanceVolumeMean.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/rsi) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_rsi) - # **get_security_price_technicals_rsi** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_rsi_v2) - > ApiResponseSecurityRelativeStrengthIndex get_security_price_technicals_rsi(identifier, opts) Relative Strength Index Returns the Relative Strength Index values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -2080,12 +1574,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_rsi: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -2098,33 +1590,18 @@ ### Return type [**ApiResponseSecurityRelativeStrengthIndex**](ApiResponseSecurityRelativeStrengthIndex.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/sma) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_sma) - # **get_security_price_technicals_sma** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_sma_v2) - > ApiResponseSecuritySimpleMovingAverage get_security_price_technicals_sma(identifier, opts) Simple Moving Average Returns the Simple Moving Average values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -2151,12 +1628,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_sma: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -2169,33 +1644,18 @@ ### Return type [**ApiResponseSecuritySimpleMovingAverage**](ApiResponseSecuritySimpleMovingAverage.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/sr) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_sr) - # **get_security_price_technicals_sr** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_sr_v2) - > ApiResponseSecurityStochasticOscillator get_security_price_technicals_sr(identifier, opts) Stochastic Oscillator Returns the Stochastic Oscillator values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -2222,12 +1682,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_sr: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -2240,33 +1698,18 @@ ### Return type [**ApiResponseSecurityStochasticOscillator**](ApiResponseSecurityStochasticOscillator.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/trix) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_trix) - # **get_security_price_technicals_trix** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_trix_v2) - > ApiResponseSecurityTripleExponentialAverage get_security_price_technicals_trix(identifier, opts) Triple Exponential Average Returns the Simple Moving Average values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -2292,12 +1735,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_trix: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -2309,33 +1750,18 @@ ### Return type [**ApiResponseSecurityTripleExponentialAverage**](ApiResponseSecurityTripleExponentialAverage.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/tsi) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_tsi) - # **get_security_price_technicals_tsi** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_tsi_v2) - > ApiResponseSecurityTrueStrengthIndex get_security_price_technicals_tsi(identifier, opts) True Strength Index Returns the True Strength Index values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -2363,12 +1789,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_tsi: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -2382,33 +1806,18 @@ ### Return type [**ApiResponseSecurityTrueStrengthIndex**](ApiResponseSecurityTrueStrengthIndex.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/uo) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_uo) - # **get_security_price_technicals_uo** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_uo_v2) - > ApiResponseSecurityUltimateOscillator get_security_price_technicals_uo(identifier, opts) Ultimate Oscillator Returns the Ultimate Oscillator values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -2439,12 +1848,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_uo: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -2461,33 +1868,18 @@ ### Return type [**ApiResponseSecurityUltimateOscillator**](ApiResponseSecurityUltimateOscillator.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/vi) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_vi) - # **get_security_price_technicals_vi** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_vi_v2) - > ApiResponseSecurityVortexIndicator get_security_price_technicals_vi(identifier, opts) Vortex Indicator Returns the Vortex Indicator values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -2513,12 +1905,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_vi: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -2530,33 +1920,18 @@ ### Return type [**ApiResponseSecurityVortexIndicator**](ApiResponseSecurityVortexIndicator.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/vpt) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_vpt) - # **get_security_price_technicals_vpt** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_vpt_v2) - > ApiResponseSecurityVolumePriceTrend get_security_price_technicals_vpt(identifier, opts) Volume-price Trend Returns the Volume-price Trend values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -2581,12 +1956,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_vpt: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -2597,33 +1970,18 @@ ### Return type [**ApiResponseSecurityVolumePriceTrend**](ApiResponseSecurityVolumePriceTrend.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/vwap) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_vwap) - # **get_security_price_technicals_vwap** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_vwap_v2) - > ApiResponseSecurityVolumeWeightedAveragePrice get_security_price_technicals_vwap(identifier, opts) Volume Weighted Average Price Returns the Volume Weighted Average Price values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -2648,12 +2006,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_vwap: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -2664,33 +2020,18 @@ ### Return type [**ApiResponseSecurityVolumeWeightedAveragePrice**](ApiResponseSecurityVolumeWeightedAveragePrice.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/wr) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_wr) - # **get_security_price_technicals_wr** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_wr_v2) - > ApiResponseSecurityWilliamsR get_security_price_technicals_wr(identifier, opts) Williams %R Returns the Williams %R values of Stock Prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -2716,12 +2057,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_wr: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -2733,33 +2072,18 @@ ### Return type [**ApiResponseSecurityWilliamsR**](ApiResponseSecurityWilliamsR.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/realtime) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_realtime_price) - # **get_security_realtime_price** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_realtime_price_v2) - > RealtimeStockPrice get_security_realtime_price(identifier, opts) Realtime Stock Price for Security Return the realtime stock price for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -2781,12 +2105,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_realtime_price: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -2794,33 +2116,18 @@ ### Return type [**RealtimeStockPrice**](RealtimeStockPrice.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices/adjustments) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_stock_price_adjustments) - # **get_security_stock_price_adjustments** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_stock_price_adjustments_v2) - > ApiResponseSecurityStockPriceAdjustments get_security_stock_price_adjustments(identifier, opts) Stock Price Adjustments by Security Returns stock price adjustments for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -2845,12 +2152,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_stock_price_adjustments: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -2861,33 +2166,18 @@ ### Return type [**ApiResponseSecurityStockPriceAdjustments**](ApiResponseSecurityStockPriceAdjustments.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/prices) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_stock_prices) - # **get_security_stock_prices** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_stock_prices_v2) - > ApiResponseSecurityStockPrices get_security_stock_prices(identifier, opts) Stock Prices by Security Return end-of-day stock prices for the Security with the given `identifier` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -2913,12 +2203,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_stock_prices: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -2930,33 +2218,18 @@ ### Return type [**ApiResponseSecurityStockPrices**](ApiResponseSecurityStockPrices.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/zacks/analyst_ratings) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_zacks_analyst_ratings) - # **get_security_zacks_analyst_ratings** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_zacks_analyst_ratings_v2) - > ApiResponseSecurityZacksAnalystRatings get_security_zacks_analyst_ratings(identifier, opts) Zacks Analyst Ratings Returns buy, sell, and hold recommendations from analysts at brokerages for the Security with the given `identifier`. Zack’s storied research team aggregates and validates the ratings from professional analysts. ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -2994,12 +2267,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_zacks_analyst_ratings: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -3023,33 +2294,18 @@ ### Return type [**ApiResponseSecurityZacksAnalystRatings**](ApiResponseSecurityZacksAnalystRatings.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/zacks/analyst_ratings/snapshot) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_zacks_analyst_ratings_snapshot) - # **get_security_zacks_analyst_ratings_snapshot** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_zacks_analyst_ratings_snapshot_v2) - > ApiResponseSecurityZacksAnalystRatingsSnapshot get_security_zacks_analyst_ratings_snapshot(identifier, opts) Zacks Analyst Ratings Snapshot Returns a snapshot of ratings data compared with previous timeframes for the Security with the given `identifier`. Also returns mean percentiles for comparing one security to the universe of securities covered by Zacks analyst ratings, at a specific point in time. ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -3071,12 +2327,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_zacks_analyst_ratings_snapshot: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -3084,33 +2338,18 @@ ### Return type [**ApiResponseSecurityZacksAnalystRatingsSnapshot**](ApiResponseSecurityZacksAnalystRatingsSnapshot.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/zacks/eps_surprises) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_zacks_eps_surprises) - # **get_security_zacks_eps_surprises** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_zacks_eps_surprises_v2) - > ApiResponseSecurityZacksEPSSurprises get_security_zacks_eps_surprises(identifier, opts) Zacks EPS Surprises for Security Return Zacks EPS surprises for the Security with the given `identifier`. ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -3133,12 +2372,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_zacks_eps_surprises: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -3147,33 +2384,18 @@ ### Return type [**ApiResponseSecurityZacksEPSSurprises**](ApiResponseSecurityZacksEPSSurprises.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/{identifier}/zacks/sales_surprises) - -[//]: # (DOC_LINK:SecurityApi.md#get_security_zacks_sales_surprises) - # **get_security_zacks_sales_surprises** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_zacks_sales_surprises_v2) - > ApiResponseSecurityZacksSalesSurprises get_security_zacks_sales_surprises(identifier, opts) Zacks Sales Surprises for Security Return Zacks sales surprises for the Security with the given `identifier`. ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -3196,12 +2418,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_zacks_sales_surprises: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -3210,33 +2430,18 @@ ### Return type [**ApiResponseSecurityZacksSalesSurprises**](ApiResponseSecurityZacksSalesSurprises.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/screen) - -[//]: # (DOC_LINK:SecurityApi.md#screen_securities) - # **screen_securities** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/screen_securities_v2) - > Array<SecurityScreenResult> screen_securities(opts) Screen Securities Screen Securities using complex logic ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -3260,12 +2465,10 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->screen_securities: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **logic** | [**SecurityScreenGroup**](SecurityScreenGroup.md)| The logic to screen with, consisting of operators, clauses, and nested groups.<br/> See <a href=\"/documentation/screener_v2\" target=\"_blank\">screener documentation</a> for details on how to construct conditions. | [optional] @@ -3276,33 +2479,18 @@ ### Return type [**Array<SecurityScreenResult>**](SecurityScreenResult.md) -[//]: # (END_OPERATION) - - -[//]: # (START_OPERTATION) - -[//]: # (ENDPOINT:/securities/search) - -[//]: # (DOC_LINK:SecurityApi.md#search_securities) - # **search_securities** - -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/search_securities_v2) - > ApiResponseSecuritiesSearch search_securities(query, opts) Search Securities Searches for Securities matching the text `query` ### Example - -[//]: # (START_CODE_EXAMPLE) - ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -3324,20 +2512,16 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->search_securities: #{e}" end ``` -[//]: # (END_CODE_EXAMPLE) - ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | **String**| | **page_size** | **Integer**| The number of results to return | [optional] [default to 100] ### Return type [**ApiResponseSecuritiesSearch**](ApiResponseSecuritiesSearch.md) - -[//]: # (END_OPERATION)