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

- old
+ new

@@ -52,25 +52,55 @@ [**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 -# **get_all_securities** + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_all_securities) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurities) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurities.md) + +[//]: # (OPERATION:get_all_securities_v2) + +[//]: # (ENDPOINT:/securities) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#get_all_securities) + +## **get_all_securities** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_all_securities_v2) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurities get_all_securities(opts) -All Securities +#### All Securities + Returns all Securities to which you have access. +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new opts = { @@ -84,36 +114,78 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_all_securities: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurities**](ApiResponseSecurities.md) -# **get_security_by_id** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_by_id) + +[//]: # (RETURN_TYPE:Intrinio::Security) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:Security.md) + +[//]: # (OPERATION:get_security_by_id_v2) + +[//]: # (ENDPOINT:/securities/{identifier}) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > Security get_security_by_id(identifier) -Lookup Security +#### Lookup Security + Returns the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -125,35 +197,77 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_by_id: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**Security**](Security.md) -# **get_security_data_point_number** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_data_point_number) + +[//]: # (RETURN_TYPE:Float) + +[//]: # (RETURN_TYPE_KIND:primitive) + +[//]: # (RETURN_TYPE_DOC:) + +[//]: # (OPERATION:get_security_data_point_number_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/data_point/{tag}/number) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > Float get_security_data_point_number(identifier, tag) -Data Point (Number) for Security +#### Data Point (Number) for Security + Returns a numeric value for the given `tag` for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -167,36 +281,78 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_data_point_number: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **tag** | **String**| An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;) | + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **tag** | String| An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;) | &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type **Float** -# **get_security_data_point_text** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_data_point_text) + +[//]: # (RETURN_TYPE:String) + +[//]: # (RETURN_TYPE_KIND:primitive) + +[//]: # (RETURN_TYPE_DOC:) + +[//]: # (OPERATION:get_security_data_point_text_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/data_point/{tag}/text) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > String get_security_data_point_text(identifier, tag) -Data Point (Text) for Security +#### Data Point (Text) for Security + Returns a text value for the given `tag` for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -210,36 +366,78 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_data_point_text: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **tag** | **String**| An Intrinio data tag ID or code-name | + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **tag** | String| An Intrinio data tag ID or code-name | &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type **String** -# **get_security_historical_data** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_historical_data) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityHistoricalData) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityHistoricalData.md) + +[//]: # (OPERATION:get_security_historical_data_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/historical_data/{tag}) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityHistoricalData get_security_historical_data(identifier, tag, opts) -Historical Data for Security +#### Historical Data for Security + Returns historical values for the given `tag` and the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -262,43 +460,85 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_historical_data: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **tag** | **String**| An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;) | - **frequency** | **String**| Return historical data in the given frequency | [optional] [default to daily] - **type** | **String**| Filter by type, when applicable | [optional] - **start_date** | **Date**| Get historical data on or after this date | [optional] - **end_date** | **Date**| Get historical date on or before this date | [optional] - **sort_order** | **String**| Sort by date &#x60;asc&#x60; or &#x60;desc&#x60; | [optional] [default to desc] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **tag** | String| An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;) | &nbsp; + **frequency** | String| Return historical data in the given frequency | [optional] [default to daily] &nbsp; + **type** | String| Filter by type, when applicable | [optional] &nbsp; + **start_date** | Date| Get historical data on or after this date | [optional] &nbsp; + **end_date** | Date| Get historical date on or before this date | [optional] &nbsp; + **sort_order** | String| Sort by date &#x60;asc&#x60; or &#x60;desc&#x60; | [optional] [default to desc] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityHistoricalData**](ApiResponseSecurityHistoricalData.md) -# **get_security_intraday_prices** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_intraday_prices) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityIntradayPrices) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityIntradayPrices.md) + +[//]: # (OPERATION:get_security_intraday_prices_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/intraday) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityIntradayPrices get_security_intraday_prices(identifier, opts) -Intraday Stock Prices for Security +#### Intraday Stock Prices for Security + Return intraday stock prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -317,40 +557,82 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_intraday_prices: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **source** | **String**| Return intraday prices from the specified data source | [optional] - **start_date** | **Date**| Return intraday prices starting at the specified date | [optional] - **start_time** | **String**| Return intraday prices starting at the specified time on the &#x60;start_date&#x60; (timezone is UTC) | [optional] - **end_date** | **Date**| Return intraday prices stopping at the specified date | [optional] - **end_time** | **String**| Return intraday prices stopping at the specified time on the &#x60;end_date&#x60; (timezone is UTC) | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **source** | String| Return intraday prices from the specified data source | [optional] &nbsp; + **start_date** | Date| Return intraday prices starting at the specified date | [optional] &nbsp; + **start_time** | String| Return intraday prices starting at the specified time on the &#x60;start_date&#x60; (timezone is UTC) | [optional] &nbsp; + **end_date** | Date| Return intraday prices stopping at the specified date | [optional] &nbsp; + **end_time** | String| Return intraday prices stopping at the specified time on the &#x60;end_date&#x60; (timezone is UTC) | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityIntradayPrices**](ApiResponseSecurityIntradayPrices.md) -# **get_security_latest_dividend_record** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_latest_dividend_record) + +[//]: # (RETURN_TYPE:Intrinio::DividendRecord) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:DividendRecord.md) + +[//]: # (OPERATION:get_security_latest_dividend_record_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/dividends/latest) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > DividendRecord get_security_latest_dividend_record(identifier) -Lastest Dividend Record for Security +#### Lastest Dividend Record for Security + Returns the latest available dividend information for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -362,35 +644,77 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_latest_dividend_record: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**DividendRecord**](DividendRecord.md) -# **get_security_latest_earnings_record** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_latest_earnings_record) + +[//]: # (RETURN_TYPE:Intrinio::EarningsRecord) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:EarningsRecord.md) + +[//]: # (OPERATION:get_security_latest_earnings_record_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/earnings/latest) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > EarningsRecord get_security_latest_earnings_record(identifier) -Lastest Earnings Record for Security +#### Lastest Earnings Record for Security + Returns latest available earnings information for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -402,35 +726,77 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_latest_earnings_record: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**EarningsRecord**](EarningsRecord.md) -# **get_security_price_technicals_adi** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_adi) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityAccumulationDistributionIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityAccumulationDistributionIndex.md) + +[//]: # (OPERATION:get_security_price_technicals_adi_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/adi) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityAccumulationDistributionIndex get_security_price_technicals_adi(identifier, opts) -Accumulation/Distribution Index +#### Accumulation/Distribution Index + Returns the Accumulation/Distribution Index values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -448,39 +814,81 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_adi: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityAccumulationDistributionIndex**](ApiResponseSecurityAccumulationDistributionIndex.md) -# **get_security_price_technicals_adtv** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_adtv) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityAverageDailyTradingVolume) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityAverageDailyTradingVolume.md) + +[//]: # (OPERATION:get_security_price_technicals_adtv_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/adtv) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityAverageDailyTradingVolume get_security_price_technicals_adtv(identifier, opts) -Average Daily Trading Volume +#### Average Daily Trading Volume + Returns the Average Daily Trading Volume values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -499,40 +907,82 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_adtv: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **period** | **Integer**| The number of observations, per period, to calculate Average Daily Trading Volume | [optional] [default to 22] - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **period** | Integer| The number of observations, per period, to calculate Average Daily Trading Volume | [optional] [default to 22] &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityAverageDailyTradingVolume**](ApiResponseSecurityAverageDailyTradingVolume.md) -# **get_security_price_technicals_adx** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_adx) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityAverageDirectionalIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityAverageDirectionalIndex.md) + +[//]: # (OPERATION:get_security_price_technicals_adx_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/adx) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityAverageDirectionalIndex get_security_price_technicals_adx(identifier, opts) -Average Directional Index +#### Average Directional Index + Returns the Average Directional Index values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -551,40 +1001,82 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_adx: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **period** | **Integer**| The number of observations, per period, to calculate Average Directional Index | [optional] [default to 14] - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **period** | Integer| The number of observations, per period, to calculate Average Directional Index | [optional] [default to 14] &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityAverageDirectionalIndex**](ApiResponseSecurityAverageDirectionalIndex.md) -# **get_security_price_technicals_ao** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_ao) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityAwesomeOscillator) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityAwesomeOscillator.md) + +[//]: # (OPERATION:get_security_price_technicals_ao_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/ao) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityAwesomeOscillator get_security_price_technicals_ao(identifier, opts) -Awesome Oscillator +#### Awesome Oscillator + Returns the Awesome Oscillator values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -604,41 +1096,83 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_ao: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **short_period** | **Integer**| The number of observations, per period, to calculate short period Simple Moving Average of the Awesome Oscillator | [optional] [default to 5] - **long_period** | **Integer**| The number of observations, per period, to calculate long period Simple Moving Average of the Awesome Oscillator | [optional] [default to 34] - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **short_period** | Integer| The number of observations, per period, to calculate short period Simple Moving Average of the Awesome Oscillator | [optional] [default to 5] &nbsp; + **long_period** | Integer| The number of observations, per period, to calculate long period Simple Moving Average of the Awesome Oscillator | [optional] [default to 34] &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityAwesomeOscillator**](ApiResponseSecurityAwesomeOscillator.md) -# **get_security_price_technicals_atr** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_atr) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityAverageTrueRange) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityAverageTrueRange.md) + +[//]: # (OPERATION:get_security_price_technicals_atr_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/atr) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityAverageTrueRange get_security_price_technicals_atr(identifier, opts) -Average True Range +#### Average True Range + Returns the Average True Range values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -657,40 +1191,82 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_atr: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **period** | **Integer**| The number of observations, per period, to calculate Average True Range | [optional] [default to 14] - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **period** | Integer| The number of observations, per period, to calculate Average True Range | [optional] [default to 14] &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityAverageTrueRange**](ApiResponseSecurityAverageTrueRange.md) -# **get_security_price_technicals_bb** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_bb) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityBollingerBands) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityBollingerBands.md) + +[//]: # (OPERATION:get_security_price_technicals_bb_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/bb) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityBollingerBands get_security_price_technicals_bb(identifier, opts) -Bollinger Bands +#### Bollinger Bands + Returns the Bollinger Bands values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -711,42 +1287,84 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_bb: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **period** | **Integer**| The number of observations, per period, to calculate Bollinger Bands | [optional] [default to 20] - **standard_deviations** | **Float**| The number of standard deviations to calculate the upper and lower bands of the Bollinger Bands | [optional] [default to 2.0] - **price_key** | **String**| The Stock Price field to use when calculating Bollinger Bands | [optional] [default to close] - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **period** | Integer| The number of observations, per period, to calculate Bollinger Bands | [optional] [default to 20] &nbsp; + **standard_deviations** | Float| The number of standard deviations to calculate the upper and lower bands of the Bollinger Bands | [optional] [default to 2.0] &nbsp; + **price_key** | String| The Stock Price field to use when calculating Bollinger Bands | [optional] [default to close] &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityBollingerBands**](ApiResponseSecurityBollingerBands.md) -# **get_security_price_technicals_cci** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_cci) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityCommodityChannelIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityCommodityChannelIndex.md) + +[//]: # (OPERATION:get_security_price_technicals_cci_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/cci) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityCommodityChannelIndex get_security_price_technicals_cci(identifier, opts) -Commodity Channel Index +#### Commodity Channel Index + Returns the Commodity Channel Index values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -766,41 +1384,83 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_cci: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **period** | **Integer**| The number of observations, per period, to calculate Commodity Channel Index | [optional] [default to 20] - **constant** | **Float**| The number of observations, per period, to calculate Commodity Channel Index | [optional] [default to 0.015] - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **period** | Integer| The number of observations, per period, to calculate Commodity Channel Index | [optional] [default to 20] &nbsp; + **constant** | Float| The number of observations, per period, to calculate Commodity Channel Index | [optional] [default to 0.015] &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityCommodityChannelIndex**](ApiResponseSecurityCommodityChannelIndex.md) -# **get_security_price_technicals_cmf** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_cmf) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityChaikinMoneyFlow) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityChaikinMoneyFlow.md) + +[//]: # (OPERATION:get_security_price_technicals_cmf_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/cmf) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityChaikinMoneyFlow get_security_price_technicals_cmf(identifier, opts) -Chaikin Money Flow +#### Chaikin Money Flow + Returns the Chaikin Money Flow values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -819,40 +1479,82 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_cmf: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **period** | **Integer**| The number of observations, per period, to calculate Chaikin Money Flow | [optional] [default to 20] - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **period** | Integer| The number of observations, per period, to calculate Chaikin Money Flow | [optional] [default to 20] &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityChaikinMoneyFlow**](ApiResponseSecurityChaikinMoneyFlow.md) -# **get_security_price_technicals_dc** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_dc) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityDonchianChannel) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityDonchianChannel.md) + +[//]: # (OPERATION:get_security_price_technicals_dc_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/dc) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityDonchianChannel get_security_price_technicals_dc(identifier, opts) -Donchian Channel +#### Donchian Channel + Returns the Donchian Channel values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -872,41 +1574,83 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_dc: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **period** | **Integer**| The number of observations, per period, to calculate Donchian Channel | [optional] [default to 20] - **price_key** | **String**| The Stock Price field to use when calculating Donchian Channel | [optional] [default to close] - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **period** | Integer| The number of observations, per period, to calculate Donchian Channel | [optional] [default to 20] &nbsp; + **price_key** | String| The Stock Price field to use when calculating Donchian Channel | [optional] [default to close] &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityDonchianChannel**](ApiResponseSecurityDonchianChannel.md) -# **get_security_price_technicals_dpo** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_dpo) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityDetrendedPriceOscillator) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityDetrendedPriceOscillator.md) + +[//]: # (OPERATION:get_security_price_technicals_dpo_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/dpo) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityDetrendedPriceOscillator get_security_price_technicals_dpo(identifier, opts) -Detrended Price Oscillator +#### Detrended Price Oscillator + Returns the Detrended Price Oscillator values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -926,41 +1670,83 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_dpo: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **period** | **Integer**| The number of observations, per period, to calculate Detrended Price Oscillator | [optional] [default to 20] - **price_key** | **String**| The Stock Price field to use when calculating Detrended Price Oscillator | [optional] [default to close] - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **period** | Integer| The number of observations, per period, to calculate Detrended Price Oscillator | [optional] [default to 20] &nbsp; + **price_key** | String| The Stock Price field to use when calculating Detrended Price Oscillator | [optional] [default to close] &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityDetrendedPriceOscillator**](ApiResponseSecurityDetrendedPriceOscillator.md) -# **get_security_price_technicals_eom** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_eom) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityEaseOfMovement) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityEaseOfMovement.md) + +[//]: # (OPERATION:get_security_price_technicals_eom_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/eom) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityEaseOfMovement get_security_price_technicals_eom(identifier, opts) -Ease of Movement +#### Ease of Movement + Returns the Ease of Movement values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -979,40 +1765,82 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_eom: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **period** | **Integer**| The number of observations, per period, to calculate Ease of Movement | [optional] [default to 20] - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **period** | Integer| The number of observations, per period, to calculate Ease of Movement | [optional] [default to 20] &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityEaseOfMovement**](ApiResponseSecurityEaseOfMovement.md) -# **get_security_price_technicals_fi** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_fi) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityForceIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityForceIndex.md) + +[//]: # (OPERATION:get_security_price_technicals_fi_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/fi) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityForceIndex get_security_price_technicals_fi(identifier, opts) -Force Index +#### Force Index + Returns the Force Index values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -1030,39 +1858,81 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_fi: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityForceIndex**](ApiResponseSecurityForceIndex.md) -# **get_security_price_technicals_ichimoku** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_ichimoku) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityIchimokuKinkoHyo) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityIchimokuKinkoHyo.md) + +[//]: # (OPERATION:get_security_price_technicals_ichimoku_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/ichimoku) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityIchimokuKinkoHyo get_security_price_technicals_ichimoku(identifier, opts) -Ichimoku Kinko Hyo +#### Ichimoku Kinko Hyo + Returns the Ichimoku Kinko Hyo values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -1083,42 +1953,84 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_ichimoku: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **low_period** | **Integer**| The number of observations, per period, to calculate Tenkan Sen (Conversion Line) of Ichimoku Kinko Hyo | [optional] [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 | [optional] [default to 26] - **high_period** | **Integer**| The number of observations, per period, to calculate Senkou Span B (Leading Span B) of Ichimoku Kinko Hyo | [optional] [default to 52] - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **low_period** | Integer| The number of observations, per period, to calculate Tenkan Sen (Conversion Line) of Ichimoku Kinko Hyo | [optional] [default to 9] &nbsp; + **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 | [optional] [default to 26] &nbsp; + **high_period** | Integer| The number of observations, per period, to calculate Senkou Span B (Leading Span B) of Ichimoku Kinko Hyo | [optional] [default to 52] &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityIchimokuKinkoHyo**](ApiResponseSecurityIchimokuKinkoHyo.md) -# **get_security_price_technicals_kc** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_kc) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityKeltnerChannel) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityKeltnerChannel.md) + +[//]: # (OPERATION:get_security_price_technicals_kc_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/kc) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityKeltnerChannel get_security_price_technicals_kc(identifier, opts) -Keltner Channel +#### Keltner Channel + Returns the Keltner Channel values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -1137,40 +2049,82 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_kc: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **period** | **Integer**| The number of observations, per period, to calculate Kelter Channel | [optional] [default to 10] - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **period** | Integer| The number of observations, per period, to calculate Kelter Channel | [optional] [default to 10] &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityKeltnerChannel**](ApiResponseSecurityKeltnerChannel.md) -# **get_security_price_technicals_kst** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_kst) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityKnowSureThing) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityKnowSureThing.md) + +[//]: # (OPERATION:get_security_price_technicals_kst_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/kst) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityKnowSureThing get_security_price_technicals_kst(identifier, opts) -Know Sure Thing +#### Know Sure Thing + Returns the Know Sure Thing values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -1197,48 +2151,90 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_kst: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **roc1** | **Integer**| The number of observations, per period, to calculate the rate-of-change for RCMA1 | [optional] [default to 10] - **roc2** | **Integer**| The number of observations, per period, to calculate the rate-of-change for RCMA2 | [optional] [default to 15] - **roc3** | **Integer**| The number of observations, per period, to calculate the rate-of-change for RCMA3 | [optional] [default to 20] - **roc4** | **Integer**| The number of observations, per period, to calculate the rate-of-change for RCMA4 | [optional] [default to 30] - **sma1** | **Integer**| The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA1 | [optional] [default to 10] - **sma2** | **Integer**| The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA2 | [optional] [default to 10] - **sma3** | **Integer**| The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA3 | [optional] [default to 10] - **sma4** | **Integer**| The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA4 | [optional] [default to 15] - **price_key** | **String**| The Stock Price field to use when calculating Know Sure Thing | [optional] [default to close] - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **roc1** | Integer| The number of observations, per period, to calculate the rate-of-change for RCMA1 | [optional] [default to 10] &nbsp; + **roc2** | Integer| The number of observations, per period, to calculate the rate-of-change for RCMA2 | [optional] [default to 15] &nbsp; + **roc3** | Integer| The number of observations, per period, to calculate the rate-of-change for RCMA3 | [optional] [default to 20] &nbsp; + **roc4** | Integer| The number of observations, per period, to calculate the rate-of-change for RCMA4 | [optional] [default to 30] &nbsp; + **sma1** | Integer| The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA1 | [optional] [default to 10] &nbsp; + **sma2** | Integer| The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA2 | [optional] [default to 10] &nbsp; + **sma3** | Integer| The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA3 | [optional] [default to 10] &nbsp; + **sma4** | Integer| The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA4 | [optional] [default to 15] &nbsp; + **price_key** | String| The Stock Price field to use when calculating Know Sure Thing | [optional] [default to close] &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityKnowSureThing**](ApiResponseSecurityKnowSureThing.md) -# **get_security_price_technicals_macd** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_macd) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityMovingAverageConvergenceDivergence) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityMovingAverageConvergenceDivergence.md) + +[//]: # (OPERATION:get_security_price_technicals_macd_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/macd) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityMovingAverageConvergenceDivergence get_security_price_technicals_macd(identifier, opts) -Moving Average Convergence Divergence +#### Moving Average Convergence Divergence + Returns the Moving Average Convergence Divergence values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -1260,43 +2256,85 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_macd: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **fast_period** | **Integer**| The number of observations, per period, to calculate the fast moving Exponential Moving Average for Moving Average Convergence Divergence | [optional] [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 | [optional] [default to 26] - **signal_period** | **Integer**| The number of observations, per period, to calculate the signal line for Moving Average Convergence Divergence | [optional] [default to 9] - **price_key** | **String**| The Stock Price field to use when calculating Moving Average Convergence Divergence | [optional] [default to close] - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **fast_period** | Integer| The number of observations, per period, to calculate the fast moving Exponential Moving Average for Moving Average Convergence Divergence | [optional] [default to 12] &nbsp; + **slow_period** | Integer| The number of observations, per period, to calculate the slow moving Exponential Moving Average for Moving Average Convergence Divergence | [optional] [default to 26] &nbsp; + **signal_period** | Integer| The number of observations, per period, to calculate the signal line for Moving Average Convergence Divergence | [optional] [default to 9] &nbsp; + **price_key** | String| The Stock Price field to use when calculating Moving Average Convergence Divergence | [optional] [default to close] &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityMovingAverageConvergenceDivergence**](ApiResponseSecurityMovingAverageConvergenceDivergence.md) -# **get_security_price_technicals_mfi** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_mfi) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityMoneyFlowIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityMoneyFlowIndex.md) + +[//]: # (OPERATION:get_security_price_technicals_mfi_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/mfi) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityMoneyFlowIndex get_security_price_technicals_mfi(identifier, opts) -Money Flow Index +#### Money Flow Index + Returns the Money Flow Index values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -1315,40 +2353,82 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_mfi: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **period** | **Integer**| The number of observations, per period, to calculate Money Flow Index | [optional] [default to 14] - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **period** | Integer| The number of observations, per period, to calculate Money Flow Index | [optional] [default to 14] &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityMoneyFlowIndex**](ApiResponseSecurityMoneyFlowIndex.md) -# **get_security_price_technicals_mi** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_mi) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityMassIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityMassIndex.md) + +[//]: # (OPERATION:get_security_price_technicals_mi_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/mi) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityMassIndex get_security_price_technicals_mi(identifier, opts) -Mass Index +#### Mass Index + Returns the Mass Index values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -1368,41 +2448,83 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_mi: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **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 | [optional] [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 | [optional] [default to 25] - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **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 | [optional] [default to 9] &nbsp; + **sum_period** | Integer| The number of observations, per period, to calculate the sum of the Exponetinal Moving Average Ratios for Mass Index | [optional] [default to 25] &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityMassIndex**](ApiResponseSecurityMassIndex.md) -# **get_security_price_technicals_nvi** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_nvi) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityNegativeVolumeIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityNegativeVolumeIndex.md) + +[//]: # (OPERATION:get_security_price_technicals_nvi_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/nvi) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityNegativeVolumeIndex get_security_price_technicals_nvi(identifier, opts) -Negative Volume Index +#### Negative Volume Index + Returns the Negative Volume Index values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -1420,39 +2542,81 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_nvi: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityNegativeVolumeIndex**](ApiResponseSecurityNegativeVolumeIndex.md) -# **get_security_price_technicals_obv** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_obv) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityOnBalanceVolume) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityOnBalanceVolume.md) + +[//]: # (OPERATION:get_security_price_technicals_obv_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/obv) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityOnBalanceVolume get_security_price_technicals_obv(identifier, opts) -On-balance Volume +#### On-balance Volume + Returns the On-balance Volume values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -1470,39 +2634,81 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_obv: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityOnBalanceVolume**](ApiResponseSecurityOnBalanceVolume.md) -# **get_security_price_technicals_obv_mean** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_obv_mean) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityOnBalanceVolumeMean) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityOnBalanceVolumeMean.md) + +[//]: # (OPERATION:get_security_price_technicals_obv_mean_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/obv_mean) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityOnBalanceVolumeMean get_security_price_technicals_obv_mean(identifier, opts) -On-balance Volume Mean +#### On-balance Volume Mean + Returns the On-balance Volume Mean values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -1521,40 +2727,82 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_obv_mean: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **period** | **Integer**| The number of observations, per period, to calculate On-balance Volume Mean | [optional] [default to 10] - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **period** | Integer| The number of observations, per period, to calculate On-balance Volume Mean | [optional] [default to 10] &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityOnBalanceVolumeMean**](ApiResponseSecurityOnBalanceVolumeMean.md) -# **get_security_price_technicals_rsi** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_rsi) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityRelativeStrengthIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityRelativeStrengthIndex.md) + +[//]: # (OPERATION:get_security_price_technicals_rsi_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/rsi) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityRelativeStrengthIndex get_security_price_technicals_rsi(identifier, opts) -Relative Strength Index +#### Relative Strength Index + Returns the Relative Strength Index values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -1574,41 +2822,83 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_rsi: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **period** | **Integer**| The number of observations, per period, to calculate Relative Strength Index | [optional] [default to 14] - **price_key** | **String**| The Stock Price field to use when calculating Relative Strength Index | [optional] [default to close] - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **period** | Integer| The number of observations, per period, to calculate Relative Strength Index | [optional] [default to 14] &nbsp; + **price_key** | String| The Stock Price field to use when calculating Relative Strength Index | [optional] [default to close] &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityRelativeStrengthIndex**](ApiResponseSecurityRelativeStrengthIndex.md) -# **get_security_price_technicals_sma** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_sma) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecuritySimpleMovingAverage) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecuritySimpleMovingAverage.md) + +[//]: # (OPERATION:get_security_price_technicals_sma_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/sma) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecuritySimpleMovingAverage get_security_price_technicals_sma(identifier, opts) -Simple Moving Average +#### Simple Moving Average + Returns the Simple Moving Average values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -1628,41 +2918,83 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_sma: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **period** | **Integer**| The number of observations, per period, to calculate Simple Moving Average | [optional] [default to 20] - **price_key** | **String**| The Stock Price field to use when calculating Simple Moving Average | [optional] [default to close] - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **period** | Integer| The number of observations, per period, to calculate Simple Moving Average | [optional] [default to 20] &nbsp; + **price_key** | String| The Stock Price field to use when calculating Simple Moving Average | [optional] [default to close] &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecuritySimpleMovingAverage**](ApiResponseSecuritySimpleMovingAverage.md) -# **get_security_price_technicals_sr** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_sr) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityStochasticOscillator) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityStochasticOscillator.md) + +[//]: # (OPERATION:get_security_price_technicals_sr_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/sr) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityStochasticOscillator get_security_price_technicals_sr(identifier, opts) -Stochastic Oscillator +#### Stochastic Oscillator + Returns the Stochastic Oscillator values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -1682,41 +3014,83 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_sr: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **period** | **Integer**| The number of observations, per period, to calculate %K of Stochastic Oscillator | [optional] [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 | [optional] [default to 3] - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **period** | Integer| The number of observations, per period, to calculate %K of Stochastic Oscillator | [optional] [default to 14] &nbsp; + **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 | [optional] [default to 3] &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityStochasticOscillator**](ApiResponseSecurityStochasticOscillator.md) -# **get_security_price_technicals_trix** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_trix) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityTripleExponentialAverage) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityTripleExponentialAverage.md) + +[//]: # (OPERATION:get_security_price_technicals_trix_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/trix) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityTripleExponentialAverage get_security_price_technicals_trix(identifier, opts) -Triple Exponential Average +#### Triple Exponential Average + Returns the Simple Moving Average values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -1735,40 +3109,82 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_trix: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **period** | **Integer**| The number of observations, per period, to calculate Exponential Moving Average for Triple Exponential Average | [optional] [default to 15] - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **period** | Integer| The number of observations, per period, to calculate Exponential Moving Average for Triple Exponential Average | [optional] [default to 15] &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityTripleExponentialAverage**](ApiResponseSecurityTripleExponentialAverage.md) -# **get_security_price_technicals_tsi** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_tsi) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityTrueStrengthIndex) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityTrueStrengthIndex.md) + +[//]: # (OPERATION:get_security_price_technicals_tsi_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/tsi) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityTrueStrengthIndex get_security_price_technicals_tsi(identifier, opts) -True Strength Index +#### True Strength Index + Returns the True Strength Index values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -1789,42 +3205,84 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_tsi: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **low_period** | **Integer**| The number of observations, per period, to calculate low period Exponential Moving Average for smoothing in True Strength Index | [optional] [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 | [optional] [default to 25] - **price_key** | **String**| The Stock Price field to use when calculating True Strength Index | [optional] [default to close] - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **low_period** | Integer| The number of observations, per period, to calculate low period Exponential Moving Average for smoothing in True Strength Index | [optional] [default to 13] &nbsp; + **high_period** | Integer| The number of observations, per period, to calculate high period Exponential Moving Average for smoothing in True Strength Index | [optional] [default to 25] &nbsp; + **price_key** | String| The Stock Price field to use when calculating True Strength Index | [optional] [default to close] &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityTrueStrengthIndex**](ApiResponseSecurityTrueStrengthIndex.md) -# **get_security_price_technicals_uo** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_uo) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityUltimateOscillator) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityUltimateOscillator.md) + +[//]: # (OPERATION:get_security_price_technicals_uo_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/uo) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityUltimateOscillator get_security_price_technicals_uo(identifier, opts) -Ultimate Oscillator +#### Ultimate Oscillator + Returns the Ultimate Oscillator values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -1848,45 +3306,87 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_uo: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **short_period** | **Integer**| The number of observations, per period, to calculate the short period for Ultimate Oscillator | [optional] [default to 7] - **medium_period** | **Integer**| The number of observations, per period, to calculate the medium period for Ultimate Oscillator | [optional] [default to 14] - **long_period** | **Integer**| The number of observations, per period, to calculate the long period for Ultimate Oscillator | [optional] [default to 28] - **short_weight** | **Float**| The weight of short Buying Pressure average for Ultimate Oscillator | [optional] [default to 4.0] - **medium_weight** | **Float**| The weight of medium Buying Pressure average for Ultimate Oscillator | [optional] [default to 2.0] - **long_weight** | **Float**| The weight of long Buying Pressure average for Ultimate Oscillator | [optional] [default to 1.0] - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **short_period** | Integer| The number of observations, per period, to calculate the short period for Ultimate Oscillator | [optional] [default to 7] &nbsp; + **medium_period** | Integer| The number of observations, per period, to calculate the medium period for Ultimate Oscillator | [optional] [default to 14] &nbsp; + **long_period** | Integer| The number of observations, per period, to calculate the long period for Ultimate Oscillator | [optional] [default to 28] &nbsp; + **short_weight** | Float| The weight of short Buying Pressure average for Ultimate Oscillator | [optional] [default to 4.0] &nbsp; + **medium_weight** | Float| The weight of medium Buying Pressure average for Ultimate Oscillator | [optional] [default to 2.0] &nbsp; + **long_weight** | Float| The weight of long Buying Pressure average for Ultimate Oscillator | [optional] [default to 1.0] &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityUltimateOscillator**](ApiResponseSecurityUltimateOscillator.md) -# **get_security_price_technicals_vi** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_vi) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityVortexIndicator) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityVortexIndicator.md) + +[//]: # (OPERATION:get_security_price_technicals_vi_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/vi) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityVortexIndicator get_security_price_technicals_vi(identifier, opts) -Vortex Indicator +#### Vortex Indicator + Returns the Vortex Indicator values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -1905,40 +3405,82 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_vi: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **period** | **Integer**| The number of observations, per period, to calculate Vortex Indicator | [optional] [default to 14] - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **period** | Integer| The number of observations, per period, to calculate Vortex Indicator | [optional] [default to 14] &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityVortexIndicator**](ApiResponseSecurityVortexIndicator.md) -# **get_security_price_technicals_vpt** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_vpt) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityVolumePriceTrend) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityVolumePriceTrend.md) + +[//]: # (OPERATION:get_security_price_technicals_vpt_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/vpt) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityVolumePriceTrend get_security_price_technicals_vpt(identifier, opts) -Volume-price Trend +#### Volume-price Trend + Returns the Volume-price Trend values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -1956,39 +3498,81 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_vpt: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityVolumePriceTrend**](ApiResponseSecurityVolumePriceTrend.md) -# **get_security_price_technicals_vwap** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_vwap) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityVolumeWeightedAveragePrice) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityVolumeWeightedAveragePrice.md) + +[//]: # (OPERATION:get_security_price_technicals_vwap_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/vwap) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityVolumeWeightedAveragePrice get_security_price_technicals_vwap(identifier, opts) -Volume Weighted Average Price +#### Volume Weighted Average Price + Returns the Volume Weighted Average Price values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -2006,39 +3590,81 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_vwap: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityVolumeWeightedAveragePrice**](ApiResponseSecurityVolumeWeightedAveragePrice.md) -# **get_security_price_technicals_wr** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_price_technicals_wr) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityWilliamsR) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityWilliamsR.md) + +[//]: # (OPERATION:get_security_price_technicals_wr_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/wr) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityWilliamsR get_security_price_technicals_wr(identifier, opts) -Williams %R +#### Williams %R + Returns the Williams %R values of Stock Prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -2057,40 +3683,82 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_wr: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **period** | **Integer**| The number of observations, per period, to look-back when calculating Williams %R | [optional] [default to 14] - **start_date** | **String**| Return technical indicator values on or after the date | [optional] - **end_date** | **String**| Return technical indicator values on or before the date | [optional] - **page_size** | **Float**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **period** | Integer| The number of observations, per period, to look-back when calculating Williams %R | [optional] [default to 14] &nbsp; + **start_date** | String| Return technical indicator values on or after the date | [optional] &nbsp; + **end_date** | String| Return technical indicator values on or before the date | [optional] &nbsp; + **page_size** | Float| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityWilliamsR**](ApiResponseSecurityWilliamsR.md) -# **get_security_realtime_price** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_realtime_price) + +[//]: # (RETURN_TYPE:Intrinio::RealtimeStockPrice) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:RealtimeStockPrice.md) + +[//]: # (OPERATION:get_security_realtime_price_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/realtime) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > RealtimeStockPrice get_security_realtime_price(identifier, opts) -Realtime Stock Price for Security +#### Realtime Stock Price for Security + Return the realtime stock price for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -2105,36 +3773,78 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_realtime_price: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **source** | **String**| Return the realtime price from the specified data source | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **source** | String| Return the realtime price from the specified data source | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**RealtimeStockPrice**](RealtimeStockPrice.md) -# **get_security_stock_price_adjustments** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_stock_price_adjustments) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityStockPriceAdjustments) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityStockPriceAdjustments.md) + +[//]: # (OPERATION:get_security_stock_price_adjustments_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/adjustments) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityStockPriceAdjustments get_security_stock_price_adjustments(identifier, opts) -Stock Price Adjustments by Security +#### Stock Price Adjustments by Security + Returns stock price adjustments for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -2152,39 +3862,81 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_stock_price_adjustments: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **start_date** | **Date**| Return price adjustments on or after the date | [optional] - **end_date** | **Date**| Return price adjustments on or before the date | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **start_date** | Date| Return price adjustments on or after the date | [optional] &nbsp; + **end_date** | Date| Return price adjustments on or before the date | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityStockPriceAdjustments**](ApiResponseSecurityStockPriceAdjustments.md) -# **get_security_stock_prices** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_stock_prices) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityStockPrices) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityStockPrices.md) + +[//]: # (OPERATION:get_security_stock_prices_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/prices) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityStockPrices get_security_stock_prices(identifier, opts) -Stock Prices by Security +#### Stock Prices by Security + Return end-of-day stock prices for the Security with the given `identifier` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -2203,40 +3955,82 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_stock_prices: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **start_date** | **Date**| Return prices on or after the date | [optional] - **end_date** | **Date**| Return prices on or before the date | [optional] - **frequency** | **String**| Return stock prices in the given frequency | [optional] [default to daily] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **start_date** | Date| Return prices on or after the date | [optional] &nbsp; + **end_date** | Date| Return prices on or before the date | [optional] &nbsp; + **frequency** | String| Return stock prices in the given frequency | [optional] [default to daily] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityStockPrices**](ApiResponseSecurityStockPrices.md) -# **get_security_zacks_analyst_ratings** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_zacks_analyst_ratings) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityZacksAnalystRatings) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityZacksAnalystRatings.md) + +[//]: # (OPERATION:get_security_zacks_analyst_ratings_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/zacks/analyst_ratings) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityZacksAnalystRatings get_security_zacks_analyst_ratings(identifier, opts) -Zacks Analyst Ratings +#### 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. +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -2267,52 +4061,94 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_zacks_analyst_ratings: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **start_date** | **String**| Limit ratings to those on or after this date | [optional] - **end_date** | **String**| Limit ratings to those on or before this date | [optional] - **mean_greater** | **Float**| Return only records with a mean (average) higher than this value | [optional] - **mean_less** | **Float**| Return only records with a mean (average) lower than this value | [optional] - **strong_buys_greater** | **Integer**| Return only records with more than this many Strong Buy recommendations | [optional] - **strong_buys_less** | **Integer**| Return only records with fewer than this many Strong Buy recommendations | [optional] - **buys_greater** | **Integer**| Return only records with more than this many Buy recommendations | [optional] - **buys_less** | **Integer**| Return only records with fewer than this many Buy recommendations | [optional] - **holds_greater** | **Integer**| Return only records with more than this many Hold recommendations | [optional] - **holds_less** | **Integer**| Return only records with fewer than this many Hold recommendations | [optional] - **sells_greater** | **Integer**| Return only records with more than this many Sell recommendations | [optional] - **sells_less** | **Integer**| Return only records with fewer than this many Sell recommendations | [optional] - **strong_sells_greater** | **Integer**| Return only records with more than this many Strong Sell recommendations | [optional] - **strong_sells_less** | **Integer**| Return only records with fewer than this many Strong Sell recommendations | [optional] - **total_greater** | **Integer**| Return only records with more than this many recommendations, regardless of type | [optional] - **total_less** | **Integer**| Return only records with fewer than this many recommendations, regardless of type | [optional] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **start_date** | String| Limit ratings to those on or after this date | [optional] &nbsp; + **end_date** | String| Limit ratings to those on or before this date | [optional] &nbsp; + **mean_greater** | Float| Return only records with a mean (average) higher than this value | [optional] &nbsp; + **mean_less** | Float| Return only records with a mean (average) lower than this value | [optional] &nbsp; + **strong_buys_greater** | Integer| Return only records with more than this many Strong Buy recommendations | [optional] &nbsp; + **strong_buys_less** | Integer| Return only records with fewer than this many Strong Buy recommendations | [optional] &nbsp; + **buys_greater** | Integer| Return only records with more than this many Buy recommendations | [optional] &nbsp; + **buys_less** | Integer| Return only records with fewer than this many Buy recommendations | [optional] &nbsp; + **holds_greater** | Integer| Return only records with more than this many Hold recommendations | [optional] &nbsp; + **holds_less** | Integer| Return only records with fewer than this many Hold recommendations | [optional] &nbsp; + **sells_greater** | Integer| Return only records with more than this many Sell recommendations | [optional] &nbsp; + **sells_less** | Integer| Return only records with fewer than this many Sell recommendations | [optional] &nbsp; + **strong_sells_greater** | Integer| Return only records with more than this many Strong Sell recommendations | [optional] &nbsp; + **strong_sells_less** | Integer| Return only records with fewer than this many Strong Sell recommendations | [optional] &nbsp; + **total_greater** | Integer| Return only records with more than this many recommendations, regardless of type | [optional] &nbsp; + **total_less** | Integer| Return only records with fewer than this many recommendations, regardless of type | [optional] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityZacksAnalystRatings**](ApiResponseSecurityZacksAnalystRatings.md) -# **get_security_zacks_analyst_ratings_snapshot** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_zacks_analyst_ratings_snapshot) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityZacksAnalystRatingsSnapshot) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityZacksAnalystRatingsSnapshot.md) + +[//]: # (OPERATION:get_security_zacks_analyst_ratings_snapshot_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/zacks/analyst_ratings/snapshot) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityZacksAnalystRatingsSnapshot get_security_zacks_analyst_ratings_snapshot(identifier, opts) -Zacks Analyst Ratings Snapshot +#### 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. +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -2327,36 +4163,78 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_zacks_analyst_ratings_snapshot: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **date** | **String**| Lookup a historical snapshot on the given date | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **date** | String| Lookup a historical snapshot on the given date | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityZacksAnalystRatingsSnapshot**](ApiResponseSecurityZacksAnalystRatingsSnapshot.md) -# **get_security_zacks_eps_surprises** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_zacks_eps_surprises) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityZacksEPSSurprises) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityZacksEPSSurprises.md) + +[//]: # (OPERATION:get_security_zacks_eps_surprises_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/zacks/eps_surprises) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityZacksEPSSurprises get_security_zacks_eps_surprises(identifier, opts) -Zacks EPS Surprises for Security +#### Zacks EPS Surprises for Security + Return Zacks EPS surprises for the Security with the given `identifier`. +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -2372,37 +4250,79 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_zacks_eps_surprises: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityZacksEPSSurprises**](ApiResponseSecurityZacksEPSSurprises.md) -# **get_security_zacks_sales_surprises** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_zacks_sales_surprises) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityZacksSalesSurprises) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityZacksSalesSurprises.md) + +[//]: # (OPERATION:get_security_zacks_sales_surprises_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/zacks/sales_surprises) + +[//]: # (DOCUMENT_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) + +[//]: # (START_OVERVIEW) + > ApiResponseSecurityZacksSalesSurprises get_security_zacks_sales_surprises(identifier, opts) -Zacks Sales Surprises for Security +#### Zacks Sales Surprises for Security + Return Zacks sales surprises for the Security with the given `identifier`. +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) @@ -2418,37 +4338,79 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_zacks_sales_surprises: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] - **next_page** | **String**| Gets the next page of data from a previous API call | [optional] + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecurityZacksSalesSurprises**](ApiResponseSecurityZacksSalesSurprises.md) -# **screen_securities** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:screen_securities) + +[//]: # (RETURN_TYPE:Intrinio::Array<SecurityScreenResult>) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:SecurityScreenResult.md) + +[//]: # (OPERATION:screen_securities_v2) + +[//]: # (ENDPOINT:/securities/screen) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#screen_securities) + +## **screen_securities** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/screen_securities_v2) + +[//]: # (START_OVERVIEW) + > Array&lt;SecurityScreenResult&gt; screen_securities(opts) -Screen Securities +#### Screen Securities + Screen Securities using complex logic +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new opts = { @@ -2465,39 +4427,81 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->screen_securities: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **logic** | [**SecurityScreenGroup**](SecurityScreenGroup.md)| The logic to screen with, consisting of operators, clauses, and nested groups.&lt;br/&gt; See &lt;a href&#x3D;\&quot;/documentation/screener_v2\&quot; target&#x3D;\&quot;_blank\&quot;&gt;screener documentation&lt;/a&gt; for details on how to construct conditions. | [optional] - **order_column** | **String**| Results returned sorted by this column | [optional] - **order_direction** | **String**| Sort order to use with the order_column | [optional] [default to asc] - **primary_only** | **BOOLEAN**| Return only primary securities | [optional] [default to false] - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] + **logic** | [**SecurityScreenGroup**](SecurityScreenGroup.md)| The logic to screen with, consisting of operators, clauses, and nested groups.&lt;br/&gt; See &lt;a href&#x3D;\&quot;/documentation/screener_v2\&quot; target&#x3D;\&quot;_blank\&quot;&gt;screener documentation&lt;/a&gt; for details on how to construct conditions. | [optional] &nbsp; + **order_column** | String| Results returned sorted by this column | [optional] &nbsp; + **order_direction** | String| Sort order to use with the order_column | [optional] [default to asc] &nbsp; + **primary_only** | BOOLEAN| Return only primary securities | [optional] [default to false] &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**Array&lt;SecurityScreenResult&gt;**](SecurityScreenResult.md) -# **search_securities** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:search_securities) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecuritiesSearch) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecuritiesSearch.md) + +[//]: # (OPERATION:search_securities_v2) + +[//]: # (ENDPOINT:/securities/search) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#search_securities) + +## **search_securities** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/search_securities_v2) + +[//]: # (START_OVERVIEW) + > ApiResponseSecuritiesSearch search_securities(query, opts) -Search Securities +#### Search Securities + Searches for Securities matching the text `query` +[//]: # (END_OVERVIEW) + ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization Intrinio.configure do |config| - config.api_key['api_key'] = 'YOUR API KEY' + config.api_key['api_key'] = 'YOUR_API_KEY' end security_api = Intrinio::SecurityApi.new query = "Apple" # String | @@ -2512,16 +4516,28 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->search_securities: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + ### Parameters +[//]: # (START_PARAMETERS) + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **query** | **String**| | - **page_size** | **Integer**| The number of results to return | [optional] [default to 100] + **query** | String| | &nbsp; + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; +<br/> +[//]: # (END_PARAMETERS) + ### Return type [**ApiResponseSecuritiesSearch**](ApiResponseSecuritiesSearch.md) + +[//]: # (END_OPERATION)