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

- old
+ new

@@ -44,22 +44,39 @@ [**get_security_price_technicals_vwap**](SecurityApi.md#get_security_price_technicals_vwap) | **GET** /securities/{identifier}/prices/technicals/vwap | Volume Weighted Average Price [**get_security_price_technicals_wr**](SecurityApi.md#get_security_price_technicals_wr) | **GET** /securities/{identifier}/prices/technicals/wr | Williams %R [**get_security_realtime_price**](SecurityApi.md#get_security_realtime_price) | **GET** /securities/{identifier}/prices/realtime | Realtime Stock Price for Security [**get_security_stock_price_adjustments**](SecurityApi.md#get_security_stock_price_adjustments) | **GET** /securities/{identifier}/prices/adjustments | Stock Price Adjustments by Security [**get_security_stock_prices**](SecurityApi.md#get_security_stock_prices) | **GET** /securities/{identifier}/prices | Stock Prices by Security +[**get_security_zacks_analyst_ratings**](SecurityApi.md#get_security_zacks_analyst_ratings) | **GET** /securities/{identifier}/zacks/analyst_ratings | Zacks Analyst Ratings +[**get_security_zacks_analyst_ratings_snapshot**](SecurityApi.md#get_security_zacks_analyst_ratings_snapshot) | **GET** /securities/{identifier}/zacks/analyst_ratings/snapshot | Zacks Analyst Ratings Snapshot +[**get_security_zacks_eps_surprises**](SecurityApi.md#get_security_zacks_eps_surprises) | **GET** /securities/{identifier}/zacks/eps_surprises | Zacks EPS Surprises for Security +[**get_security_zacks_sales_surprises**](SecurityApi.md#get_security_zacks_sales_surprises) | **GET** /securities/{identifier}/zacks/sales_surprises | Zacks Sales Surprises for Security [**screen_securities**](SecurityApi.md#screen_securities) | **POST** /securities/screen | Screen Securities [**search_securities**](SecurityApi.md#search_securities) | **GET** /securities/search | Search Securities + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities) + +[//]: # (DOC_LINK:SecurityApi.md#get_all_securities) + # **get_all_securities** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_all_securities_v2) + > ApiResponseSecurities get_all_securities(opts) All Securities Returns all Securities to which you have access. ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -68,11 +85,11 @@ end security_api = Intrinio::SecurityApi.new opts = { - page_size: 100, # Float | The number of results to return + page_size: 100, # Integer | The number of results to return next_page: nil # String | Gets the next page of data from a previous API call } begin result = security_api.get_all_securities(opts) @@ -80,29 +97,46 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_all_securities: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **page_size** | **Float**| The number of results to return | [optional] [default to 100] + **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] ### Return type [**ApiResponseSecurities**](ApiResponseSecurities.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_by_id) + # **get_security_by_id** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_by_id_v2) + > Security get_security_by_id(identifier) Lookup Security Returns the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -110,39 +144,56 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) begin result = security_api.get_security_by_id(identifier) p result rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_by_id: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | ### Return type [**Security**](Security.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/data_point/{tag}/number) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_data_point_number) + # **get_security_data_point_number** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_data_point_number_v2) + > Float get_security_data_point_number(identifier, tag) Data Point (Number) for Security -$$v2_security_data_point_number_description$$ +Returns a numeric value for the given `tag` for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -150,42 +201,59 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_security_data_point_identifier_default$$" # String | $$v2_security_data_point_identifier_description$$ +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) -tag = "$$v2_security_data_point_item_number_default$$" # String | $$v2_security_data_point_item_description$$ +tag = "close_price" # String | An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) begin result = security_api.get_security_data_point_number(identifier, tag) p result rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_data_point_number: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| $$v2_security_data_point_identifier_description$$ | - **tag** | **String**| $$v2_security_data_point_item_description$$ | + **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;) | ### Return type **Float** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/data_point/{tag}/text) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_data_point_text) + # **get_security_data_point_text** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_data_point_text_v2) + > String get_security_data_point_text(identifier, tag) Data Point (Text) for Security -$$v2_security_data_point_text_description$$ +Returns a text value for the given `tag` for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -193,42 +261,59 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_security_data_point_identifier_default$$" # String | $$v2_security_data_point_identifier_description$$ +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) -tag = "$$v2_security_data_point_item_text_default$$" # String | An Intrinio data tag ID or code-name +tag = "figi" # String | An Intrinio data tag ID or code-name begin result = security_api.get_security_data_point_text(identifier, tag) p result rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_data_point_text: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| $$v2_security_data_point_identifier_description$$ | + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | **tag** | **String**| An Intrinio data tag ID or code-name | ### Return type **String** +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/historical_data/{tag}) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_historical_data) + # **get_security_historical_data** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_historical_data_v2) + > ApiResponseSecurityHistoricalData get_security_historical_data(identifier, tag, opts) Historical Data for Security -$$v2_security_historical_data_description$$ +Returns historical values for the given `tag` and the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -236,21 +321,21 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_security_historical_data_identifier_default$$" # String | $$v2_security_historical_data_identifier_description$$ +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) -tag = "$$v2_security_historical_data_item_default$$" # String | $$v2_security_data_point_item_description$$ +tag = "adj_close_price" # String | An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) opts = { frequency: "daily", # String | Return historical data in the given frequency type: nil, # String | Filter by type, when applicable start_date: Date.parse("2018-01-01"), # Date | Get historical data on or after this date - end_date: Date.parse("2019-01-01"), # Date | Get historical date on or before this date + end_date: nil, # Date | Get historical date on or before this date sort_order: "desc", # String | Sort by date `asc` or `desc` - page_size: 100, # Float | The number of results to return + page_size: 100, # Integer | The number of results to return next_page: nil # String | Gets the next page of data from a previous API call } begin result = security_api.get_security_historical_data(identifier, tag, opts) @@ -258,36 +343,53 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_historical_data: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **identifier** | **String**| $$v2_security_historical_data_identifier_description$$ | - **tag** | **String**| $$v2_security_data_point_item_description$$ | + **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** | **Float**| The number of results to return | [optional] [default to 100] + **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] ### Return type [**ApiResponseSecurityHistoricalData**](ApiResponseSecurityHistoricalData.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/intraday) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_intraday_prices) + # **get_security_intraday_prices** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_intraday_prices_v2) + > ApiResponseSecurityIntradayPrices get_security_intraday_prices(identifier, opts) Intraday Stock Prices for Security -$$v2_security_intraday_prices_description$$ +Return intraday stock prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -295,11 +397,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { source: nil, # String | Return intraday prices from the specified data source start_date: Date.parse("2018-01-01"), # Date | Return intraday prices starting at the specified date start_time: "4200", # String | Return intraday prices starting at the specified time on the `start_date` (timezone is UTC) @@ -313,10 +415,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_intraday_prices: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -328,18 +432,33 @@ ### Return type [**ApiResponseSecurityIntradayPrices**](ApiResponseSecurityIntradayPrices.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/dividends/latest) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_latest_dividend_record) + # **get_security_latest_dividend_record** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_latest_dividend_record_v2) + > DividendRecord get_security_latest_dividend_record(identifier) Lastest Dividend Record for Security Returns the latest available dividend information for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -347,39 +466,56 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) begin result = security_api.get_security_latest_dividend_record(identifier) p result rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_latest_dividend_record: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | ### Return type [**DividendRecord**](DividendRecord.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/earnings/latest) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_latest_earnings_record) + # **get_security_latest_earnings_record** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_latest_earnings_record_v2) + > EarningsRecord get_security_latest_earnings_record(identifier) Lastest Earnings Record for Security Returns latest available earnings information for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -387,39 +523,56 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) begin result = security_api.get_security_latest_earnings_record(identifier) p result rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_latest_earnings_record: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | ### Return type [**EarningsRecord**](EarningsRecord.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/adi) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_adi) + # **get_security_price_technicals_adi** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_adi_v2) + > ApiResponseSecurityAccumulationDistributionIndex get_security_price_technicals_adi(identifier, opts) Accumulation/Distribution Index Returns the Accumulation/Distribution Index values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -427,11 +580,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { start_date: "2018-01-01", # String | Return technical indicator values on or after the date end_date: "2019-01-01", # String | Return technical indicator values on or before the date page_size: 100, # Integer | The number of results to return @@ -444,10 +597,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_adi: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -458,18 +613,33 @@ ### Return type [**ApiResponseSecurityAccumulationDistributionIndex**](ApiResponseSecurityAccumulationDistributionIndex.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/adtv) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_adtv) + # **get_security_price_technicals_adtv** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_adtv_v2) + > ApiResponseSecurityAverageDailyTradingVolume get_security_price_technicals_adtv(identifier, opts) Average Daily Trading Volume Returns the Average Daily Trading Volume values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -477,11 +647,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { period: 22, # Integer | The number of observations, per period, to calculate Average Daily Trading Volume start_date: "2018-01-01", # String | Return technical indicator values on or after the date end_date: "2019-01-01", # String | Return technical indicator values on or before the date @@ -495,10 +665,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_adtv: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -510,18 +682,33 @@ ### Return type [**ApiResponseSecurityAverageDailyTradingVolume**](ApiResponseSecurityAverageDailyTradingVolume.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/adx) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_adx) + # **get_security_price_technicals_adx** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_adx_v2) + > ApiResponseSecurityAverageDirectionalIndex get_security_price_technicals_adx(identifier, opts) Average Directional Index Returns the Average Directional Index values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -529,11 +716,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { period: 14, # Integer | The number of observations, per period, to calculate Average Directional Index start_date: "2018-01-01", # String | Return technical indicator values on or after the date end_date: "2019-01-01", # String | Return technical indicator values on or before the date @@ -547,10 +734,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_adx: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -562,18 +751,33 @@ ### Return type [**ApiResponseSecurityAverageDirectionalIndex**](ApiResponseSecurityAverageDirectionalIndex.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/ao) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_ao) + # **get_security_price_technicals_ao** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_ao_v2) + > ApiResponseSecurityAwesomeOscillator get_security_price_technicals_ao(identifier, opts) Awesome Oscillator Returns the Awesome Oscillator values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -581,11 +785,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { short_period: 5, # Integer | The number of observations, per period, to calculate short period Simple Moving Average of the Awesome Oscillator long_period: 34, # Integer | The number of observations, per period, to calculate long period Simple Moving Average of the Awesome Oscillator start_date: "2018-01-01", # String | Return technical indicator values on or after the date @@ -600,10 +804,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_ao: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -616,18 +822,33 @@ ### Return type [**ApiResponseSecurityAwesomeOscillator**](ApiResponseSecurityAwesomeOscillator.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/atr) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_atr) + # **get_security_price_technicals_atr** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_atr_v2) + > ApiResponseSecurityAverageTrueRange get_security_price_technicals_atr(identifier, opts) Average True Range Returns the Average True Range values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -635,11 +856,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { period: 14, # Integer | The number of observations, per period, to calculate Average True Range start_date: "2018-01-01", # String | Return technical indicator values on or after the date end_date: "2019-01-01", # String | Return technical indicator values on or before the date @@ -653,10 +874,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_atr: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -668,18 +891,33 @@ ### Return type [**ApiResponseSecurityAverageTrueRange**](ApiResponseSecurityAverageTrueRange.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/bb) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_bb) + # **get_security_price_technicals_bb** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_bb_v2) + > ApiResponseSecurityBollingerBands get_security_price_technicals_bb(identifier, opts) Bollinger Bands Returns the Bollinger Bands values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -687,11 +925,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { period: 20, # Integer | The number of observations, per period, to calculate Bollinger Bands standard_deviations: 2.0, # Float | The number of standard deviations to calculate the upper and lower bands of the Bollinger Bands price_key: "close", # String | The Stock Price field to use when calculating Bollinger Bands @@ -707,10 +945,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_bb: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -724,18 +964,33 @@ ### Return type [**ApiResponseSecurityBollingerBands**](ApiResponseSecurityBollingerBands.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/cci) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_cci) + # **get_security_price_technicals_cci** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_cci_v2) + > ApiResponseSecurityCommodityChannelIndex get_security_price_technicals_cci(identifier, opts) Commodity Channel Index Returns the Commodity Channel Index values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -743,11 +998,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { period: 20, # Integer | The number of observations, per period, to calculate Commodity Channel Index constant: 0.015, # Float | The number of observations, per period, to calculate Commodity Channel Index start_date: "2018-01-01", # String | Return technical indicator values on or after the date @@ -762,10 +1017,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_cci: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -778,18 +1035,33 @@ ### Return type [**ApiResponseSecurityCommodityChannelIndex**](ApiResponseSecurityCommodityChannelIndex.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/cmf) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_cmf) + # **get_security_price_technicals_cmf** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_cmf_v2) + > ApiResponseSecurityChaikinMoneyFlow get_security_price_technicals_cmf(identifier, opts) Chaikin Money Flow Returns the Chaikin Money Flow values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -797,11 +1069,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { period: 20, # Integer | The number of observations, per period, to calculate Chaikin Money Flow start_date: "2018-01-01", # String | Return technical indicator values on or after the date end_date: "2019-01-01", # String | Return technical indicator values on or before the date @@ -815,10 +1087,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_cmf: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -830,18 +1104,33 @@ ### Return type [**ApiResponseSecurityChaikinMoneyFlow**](ApiResponseSecurityChaikinMoneyFlow.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/dc) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_dc) + # **get_security_price_technicals_dc** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_dc_v2) + > ApiResponseSecurityDonchianChannel get_security_price_technicals_dc(identifier, opts) Donchian Channel Returns the Donchian Channel values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -849,11 +1138,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { period: 20, # Integer | The number of observations, per period, to calculate Donchian Channel price_key: "close", # String | The Stock Price field to use when calculating Donchian Channel start_date: "2018-01-01", # String | Return technical indicator values on or after the date @@ -868,10 +1157,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_dc: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -884,18 +1175,33 @@ ### Return type [**ApiResponseSecurityDonchianChannel**](ApiResponseSecurityDonchianChannel.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/dpo) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_dpo) + # **get_security_price_technicals_dpo** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_dpo_v2) + > ApiResponseSecurityDetrendedPriceOscillator get_security_price_technicals_dpo(identifier, opts) Detrended Price Oscillator Returns the Detrended Price Oscillator values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -903,11 +1209,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { period: 20, # Integer | The number of observations, per period, to calculate Detrended Price Oscillator price_key: "close", # String | The Stock Price field to use when calculating Detrended Price Oscillator start_date: "2018-01-01", # String | Return technical indicator values on or after the date @@ -922,10 +1228,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_dpo: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -938,18 +1246,33 @@ ### Return type [**ApiResponseSecurityDetrendedPriceOscillator**](ApiResponseSecurityDetrendedPriceOscillator.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/eom) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_eom) + # **get_security_price_technicals_eom** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_eom_v2) + > ApiResponseSecurityEaseOfMovement get_security_price_technicals_eom(identifier, opts) Ease of Movement Returns the Ease of Movement values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -957,11 +1280,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { period: 20, # Integer | The number of observations, per period, to calculate Ease of Movement start_date: "2018-01-01", # String | Return technical indicator values on or after the date end_date: "2019-01-01", # String | Return technical indicator values on or before the date @@ -975,10 +1298,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_eom: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -990,18 +1315,33 @@ ### Return type [**ApiResponseSecurityEaseOfMovement**](ApiResponseSecurityEaseOfMovement.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/fi) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_fi) + # **get_security_price_technicals_fi** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_fi_v2) + > ApiResponseSecurityForceIndex get_security_price_technicals_fi(identifier, opts) Force Index Returns the Force Index values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1009,11 +1349,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { start_date: "2018-01-01", # String | Return technical indicator values on or after the date end_date: "2019-01-01", # String | Return technical indicator values on or before the date page_size: 100, # Integer | The number of results to return @@ -1026,10 +1366,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_fi: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1040,18 +1382,33 @@ ### Return type [**ApiResponseSecurityForceIndex**](ApiResponseSecurityForceIndex.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/ichimoku) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_ichimoku) + # **get_security_price_technicals_ichimoku** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_ichimoku_v2) + > ApiResponseSecurityIchimokuKinkoHyo get_security_price_technicals_ichimoku(identifier, opts) Ichimoku Kinko Hyo Returns the Ichimoku Kinko Hyo values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1059,11 +1416,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { low_period: 9, # Integer | The number of observations, per period, to calculate Tenkan Sen (Conversion Line) of Ichimoku Kinko Hyo medium_period: 26, # Integer | The number of observations, per period, to calculate Kijun Sen (Base Line), Senkou Span A (Leading Span A), and Chikou Span (Lagging Span) of Ichimoku Kinko Hyo high_period: 52, # Integer | The number of observations, per period, to calculate Senkou Span B (Leading Span B) of Ichimoku Kinko Hyo @@ -1079,10 +1436,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_ichimoku: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1096,18 +1455,33 @@ ### Return type [**ApiResponseSecurityIchimokuKinkoHyo**](ApiResponseSecurityIchimokuKinkoHyo.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/kc) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_kc) + # **get_security_price_technicals_kc** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_kc_v2) + > ApiResponseSecurityKeltnerChannel get_security_price_technicals_kc(identifier, opts) Keltner Channel Returns the Keltner Channel values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1115,11 +1489,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { period: 10, # Integer | The number of observations, per period, to calculate Kelter Channel start_date: "2018-01-01", # String | Return technical indicator values on or after the date end_date: "2019-01-01", # String | Return technical indicator values on or before the date @@ -1133,10 +1507,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_kc: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1148,18 +1524,33 @@ ### Return type [**ApiResponseSecurityKeltnerChannel**](ApiResponseSecurityKeltnerChannel.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/kst) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_kst) + # **get_security_price_technicals_kst** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_kst_v2) + > ApiResponseSecurityKnowSureThing get_security_price_technicals_kst(identifier, opts) Know Sure Thing Returns the Know Sure Thing values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1167,18 +1558,17 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { roc1: 10, # Integer | The number of observations, per period, to calculate the rate-of-change for RCMA1 roc2: 15, # Integer | The number of observations, per period, to calculate the rate-of-change for RCMA2 - roc3: 15, # Integer | The number of observations, per period, to calculate the rate-of-change for RCMA2 - roc4: 20, # Integer | The number of observations, per period, to calculate the rate-of-change for RCMA3 - roc5: 30, # Integer | The number of observations, per period, to calculate the rate-of-change for RCMA4 + roc3: 20, # Integer | The number of observations, per period, to calculate the rate-of-change for RCMA3 + roc4: 30, # Integer | The number of observations, per period, to calculate the rate-of-change for RCMA4 sma1: 10, # Integer | The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA1 sma2: 10, # Integer | The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA2 sma3: 10, # Integer | The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA3 sma4: 15, # Integer | The number of observations, per period, to calculate the Simple Moving Average of the rate-of-change for RCMA4 price_key: "close", # String | The Stock Price field to use when calculating Know Sure Thing @@ -1194,20 +1584,21 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_kst: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | **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 RCMA2 | [optional] [default to 15] - **roc4** | **Integer**| The number of observations, per period, to calculate the rate-of-change for RCMA3 | [optional] [default to 20] - **roc5** | **Integer**| The number of observations, per period, to calculate the rate-of-change for RCMA4 | [optional] [default to 30] + **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] @@ -1218,18 +1609,33 @@ ### Return type [**ApiResponseSecurityKnowSureThing**](ApiResponseSecurityKnowSureThing.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/macd) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_macd) + # **get_security_price_technicals_macd** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_macd_v2) + > ApiResponseSecurityMovingAverageConvergenceDivergence get_security_price_technicals_macd(identifier, opts) Moving Average Convergence Divergence Returns the Moving Average Convergence Divergence values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1237,11 +1643,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { fast_period: 12, # Integer | The number of observations, per period, to calculate the fast moving Exponential Moving Average for Moving Average Convergence Divergence slow_period: 26, # Integer | The number of observations, per period, to calculate the slow moving Exponential Moving Average for Moving Average Convergence Divergence signal_period: 9, # Integer | The number of observations, per period, to calculate the signal line for Moving Average Convergence Divergence @@ -1258,10 +1664,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_macd: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1276,18 +1684,33 @@ ### Return type [**ApiResponseSecurityMovingAverageConvergenceDivergence**](ApiResponseSecurityMovingAverageConvergenceDivergence.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/mfi) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_mfi) + # **get_security_price_technicals_mfi** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_mfi_v2) + > ApiResponseSecurityMoneyFlowIndex get_security_price_technicals_mfi(identifier, opts) Money Flow Index Returns the Money Flow Index values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1295,11 +1718,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { period: 14, # Integer | The number of observations, per period, to calculate Money Flow Index start_date: "2018-01-01", # String | Return technical indicator values on or after the date end_date: "2019-01-01", # String | Return technical indicator values on or before the date @@ -1313,10 +1736,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_mfi: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1328,18 +1753,33 @@ ### Return type [**ApiResponseSecurityMoneyFlowIndex**](ApiResponseSecurityMoneyFlowIndex.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/mi) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_mi) + # **get_security_price_technicals_mi** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_mi_v2) + > ApiResponseSecurityMassIndex get_security_price_technicals_mi(identifier, opts) Mass Index Returns the Mass Index values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1347,11 +1787,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { ema_period: 9, # Integer | The number of observations, per period, to calculate the single Exponential Moving Average and the Double Exponential Moving Average for Mass Index sum_period: 25, # Integer | The number of observations, per period, to calculate the sum of the Exponetinal Moving Average Ratios for Mass Index start_date: "2018-01-01", # String | Return technical indicator values on or after the date @@ -1366,10 +1806,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_mi: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1382,18 +1824,33 @@ ### Return type [**ApiResponseSecurityMassIndex**](ApiResponseSecurityMassIndex.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/nvi) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_nvi) + # **get_security_price_technicals_nvi** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_nvi_v2) + > ApiResponseSecurityNegativeVolumeIndex get_security_price_technicals_nvi(identifier, opts) Negative Volume Index Returns the Negative Volume Index values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1401,11 +1858,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { start_date: "2018-01-01", # String | Return technical indicator values on or after the date end_date: "2019-01-01", # String | Return technical indicator values on or before the date page_size: 100, # Integer | The number of results to return @@ -1418,10 +1875,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_nvi: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1432,18 +1891,33 @@ ### Return type [**ApiResponseSecurityNegativeVolumeIndex**](ApiResponseSecurityNegativeVolumeIndex.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/obv) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_obv) + # **get_security_price_technicals_obv** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_obv_v2) + > ApiResponseSecurityOnBalanceVolume get_security_price_technicals_obv(identifier, opts) On-balance Volume Returns the On-balance Volume values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1451,11 +1925,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { start_date: "2018-01-01", # String | Return technical indicator values on or after the date end_date: "2019-01-01", # String | Return technical indicator values on or before the date page_size: 100, # Integer | The number of results to return @@ -1468,10 +1942,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_obv: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1482,18 +1958,33 @@ ### Return type [**ApiResponseSecurityOnBalanceVolume**](ApiResponseSecurityOnBalanceVolume.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/obv_mean) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_obv_mean) + # **get_security_price_technicals_obv_mean** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_obv_mean_v2) + > ApiResponseSecurityOnBalanceVolumeMean get_security_price_technicals_obv_mean(identifier, opts) On-balance Volume Mean Returns the On-balance Volume Mean values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1501,11 +1992,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { period: 10, # Integer | The number of observations, per period, to calculate On-balance Volume Mean start_date: "2018-01-01", # String | Return technical indicator values on or after the date end_date: "2019-01-01", # String | Return technical indicator values on or before the date @@ -1519,10 +2010,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_obv_mean: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1534,18 +2027,33 @@ ### Return type [**ApiResponseSecurityOnBalanceVolumeMean**](ApiResponseSecurityOnBalanceVolumeMean.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/rsi) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_rsi) + # **get_security_price_technicals_rsi** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_rsi_v2) + > ApiResponseSecurityRelativeStrengthIndex get_security_price_technicals_rsi(identifier, opts) Relative Strength Index Returns the Relative Strength Index values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1553,11 +2061,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { period: 14, # Integer | The number of observations, per period, to calculate Relative Strength Index price_key: "close", # String | The Stock Price field to use when calculating Relative Strength Index start_date: "2018-01-01", # String | Return technical indicator values on or after the date @@ -1572,10 +2080,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_rsi: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1588,18 +2098,33 @@ ### Return type [**ApiResponseSecurityRelativeStrengthIndex**](ApiResponseSecurityRelativeStrengthIndex.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/sma) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_sma) + # **get_security_price_technicals_sma** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_sma_v2) + > ApiResponseSecuritySimpleMovingAverage get_security_price_technicals_sma(identifier, opts) Simple Moving Average Returns the Simple Moving Average values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1607,11 +2132,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { period: 20, # Integer | The number of observations, per period, to calculate Simple Moving Average price_key: "close", # String | The Stock Price field to use when calculating Simple Moving Average start_date: "2018-01-01", # String | Return technical indicator values on or after the date @@ -1626,10 +2151,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_sma: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1642,18 +2169,33 @@ ### Return type [**ApiResponseSecuritySimpleMovingAverage**](ApiResponseSecuritySimpleMovingAverage.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/sr) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_sr) + # **get_security_price_technicals_sr** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_sr_v2) + > ApiResponseSecurityStochasticOscillator get_security_price_technicals_sr(identifier, opts) Stochastic Oscillator Returns the Stochastic Oscillator values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1661,11 +2203,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { period: 14, # Integer | The number of observations, per period, to calculate %K of Stochastic Oscillator signal_period: 3, # Integer | The number of observations, per period, to calculate the %D (the Simple Moving Average of %K) as a signal line for Stochastic Oscillator start_date: "2018-01-01", # String | Return technical indicator values on or after the date @@ -1680,10 +2222,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_sr: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1696,18 +2240,33 @@ ### Return type [**ApiResponseSecurityStochasticOscillator**](ApiResponseSecurityStochasticOscillator.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/trix) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_trix) + # **get_security_price_technicals_trix** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_trix_v2) + > ApiResponseSecurityTripleExponentialAverage get_security_price_technicals_trix(identifier, opts) Triple Exponential Average Returns the Simple Moving Average values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1715,11 +2274,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { period: 15, # Integer | The number of observations, per period, to calculate Exponential Moving Average for Triple Exponential Average start_date: "2018-01-01", # String | Return technical indicator values on or after the date end_date: "2019-01-01", # String | Return technical indicator values on or before the date @@ -1733,10 +2292,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_trix: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1748,18 +2309,33 @@ ### Return type [**ApiResponseSecurityTripleExponentialAverage**](ApiResponseSecurityTripleExponentialAverage.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/tsi) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_tsi) + # **get_security_price_technicals_tsi** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_tsi_v2) + > ApiResponseSecurityTrueStrengthIndex get_security_price_technicals_tsi(identifier, opts) True Strength Index Returns the True Strength Index values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1767,11 +2343,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { low_period: 13, # Integer | The number of observations, per period, to calculate low period Exponential Moving Average for smoothing in True Strength Index high_period: 25, # Integer | The number of observations, per period, to calculate high period Exponential Moving Average for smoothing in True Strength Index price_key: "close", # String | The Stock Price field to use when calculating True Strength Index @@ -1787,10 +2363,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_tsi: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1804,18 +2382,33 @@ ### Return type [**ApiResponseSecurityTrueStrengthIndex**](ApiResponseSecurityTrueStrengthIndex.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/uo) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_uo) + # **get_security_price_technicals_uo** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_uo_v2) + > ApiResponseSecurityUltimateOscillator get_security_price_technicals_uo(identifier, opts) Ultimate Oscillator Returns the Ultimate Oscillator values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1823,11 +2416,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { short_period: 7, # Integer | The number of observations, per period, to calculate the short period for Ultimate Oscillator medium_period: 14, # Integer | The number of observations, per period, to calculate the medium period for Ultimate Oscillator long_period: 28, # Integer | The number of observations, per period, to calculate the long period for Ultimate Oscillator @@ -1846,10 +2439,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_uo: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1866,18 +2461,33 @@ ### Return type [**ApiResponseSecurityUltimateOscillator**](ApiResponseSecurityUltimateOscillator.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/vi) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_vi) + # **get_security_price_technicals_vi** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_vi_v2) + > ApiResponseSecurityVortexIndicator get_security_price_technicals_vi(identifier, opts) Vortex Indicator Returns the Vortex Indicator values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1885,11 +2495,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { period: 14, # Integer | The number of observations, per period, to calculate Vortex Indicator start_date: "2018-01-01", # String | Return technical indicator values on or after the date end_date: "2019-01-01", # String | Return technical indicator values on or before the date @@ -1903,10 +2513,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_vi: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1918,18 +2530,33 @@ ### Return type [**ApiResponseSecurityVortexIndicator**](ApiResponseSecurityVortexIndicator.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/vpt) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_vpt) + # **get_security_price_technicals_vpt** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_vpt_v2) + > ApiResponseSecurityVolumePriceTrend get_security_price_technicals_vpt(identifier, opts) Volume-price Trend Returns the Volume-price Trend values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1937,11 +2564,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { start_date: "2018-01-01", # String | Return technical indicator values on or after the date end_date: "2019-01-01", # String | Return technical indicator values on or before the date page_size: 100, # Integer | The number of results to return @@ -1954,10 +2581,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_vpt: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -1968,18 +2597,33 @@ ### Return type [**ApiResponseSecurityVolumePriceTrend**](ApiResponseSecurityVolumePriceTrend.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/vwap) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_vwap) + # **get_security_price_technicals_vwap** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_vwap_v2) + > ApiResponseSecurityVolumeWeightedAveragePrice get_security_price_technicals_vwap(identifier, opts) Volume Weighted Average Price Returns the Volume Weighted Average Price values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -1987,11 +2631,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { start_date: "2018-01-01", # String | Return technical indicator values on or after the date end_date: "2019-01-01", # String | Return technical indicator values on or before the date page_size: 100, # Integer | The number of results to return @@ -2004,10 +2648,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_vwap: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -2018,18 +2664,33 @@ ### Return type [**ApiResponseSecurityVolumeWeightedAveragePrice**](ApiResponseSecurityVolumeWeightedAveragePrice.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/technicals/wr) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_price_technicals_wr) + # **get_security_price_technicals_wr** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_price_technicals_wr_v2) + > ApiResponseSecurityWilliamsR get_security_price_technicals_wr(identifier, opts) Williams %R Returns the Williams %R values of Stock Prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -2037,11 +2698,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { period: 14, # Integer | The number of observations, per period, to look-back when calculating Williams %R start_date: "2018-01-01", # String | Return technical indicator values on or after the date end_date: "2019-01-01", # String | Return technical indicator values on or before the date @@ -2055,10 +2716,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_price_technicals_wr: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -2070,18 +2733,33 @@ ### Return type [**ApiResponseSecurityWilliamsR**](ApiResponseSecurityWilliamsR.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/realtime) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_realtime_price) + # **get_security_realtime_price** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_realtime_price_v2) + > RealtimeStockPrice get_security_realtime_price(identifier, opts) Realtime Stock Price for Security Return the realtime stock price for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -2089,11 +2767,11 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { source: nil # String | Return the realtime price from the specified data source } @@ -2103,10 +2781,12 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_realtime_price: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | @@ -2114,18 +2794,33 @@ ### Return type [**RealtimeStockPrice**](RealtimeStockPrice.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices/adjustments) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_stock_price_adjustments) + # **get_security_stock_price_adjustments** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_stock_price_adjustments_v2) + > ApiResponseSecurityStockPriceAdjustments get_security_stock_price_adjustments(identifier, opts) Stock Price Adjustments by Security Returns stock price adjustments for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -2133,16 +2828,16 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { start_date: Date.parse("2018-01-01"), # Date | Return price adjustments on or after the date end_date: Date.parse("2019-01-01"), # Date | Return price adjustments on or before the date - page_size: 100, # Float | The number of results to return + page_size: 100, # Integer | The number of results to return next_page: nil # String | Gets the next page of data from a previous API call } begin result = security_api.get_security_stock_price_adjustments(identifier, opts) @@ -2150,32 +2845,49 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_stock_price_adjustments: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | **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** | **Float**| The number of results to return | [optional] [default to 100] + **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] ### Return type [**ApiResponseSecurityStockPriceAdjustments**](ApiResponseSecurityStockPriceAdjustments.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/prices) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_stock_prices) + # **get_security_stock_prices** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_stock_prices_v2) + > ApiResponseSecurityStockPrices get_security_stock_prices(identifier, opts) Stock Prices by Security Return end-of-day stock prices for the Security with the given `identifier` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -2183,17 +2895,17 @@ config.api_key['api_key'] = 'YOUR API KEY' end security_api = Intrinio::SecurityApi.new -identifier = "$$v2_ticker_default$$" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) +identifier = "AAPL" # String | A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) opts = { start_date: Date.parse("2018-01-01"), # Date | Return prices on or after the date end_date: Date.parse("2019-01-01"), # Date | Return prices on or before the date frequency: "daily", # String | Return stock prices in the given frequency - page_size: 100, # Float | The number of results to return + page_size: 100, # Integer | The number of results to return next_page: nil # String | Gets the next page of data from a previous API call } begin result = security_api.get_security_stock_prices(identifier, opts) @@ -2201,33 +2913,330 @@ rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->get_security_stock_prices: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | **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** | **Float**| The number of results to return | [optional] [default to 100] + **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] ### Return type [**ApiResponseSecurityStockPrices**](ApiResponseSecurityStockPrices.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/zacks/analyst_ratings) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_zacks_analyst_ratings) + +# **get_security_zacks_analyst_ratings** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_zacks_analyst_ratings_v2) + +> ApiResponseSecurityZacksAnalystRatings get_security_zacks_analyst_ratings(identifier, opts) + +Zacks Analyst Ratings + +Returns buy, sell, and hold recommendations from analysts at brokerages for the Security with the given `identifier`. Zack’s storied research team aggregates and validates the ratings from professional analysts. + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + 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) + +opts = { + start_date: nil, # String | Limit ratings to those on or after this date + end_date: nil, # String | Limit ratings to those on or before this date + mean_greater: nil, # Float | Return only records with a mean (average) higher than this value + mean_less: nil, # Float | Return only records with a mean (average) lower than this value + strong_buys_greater: nil, # Integer | Return only records with more than this many Strong Buy recommendations + strong_buys_less: nil, # Integer | Return only records with fewer than this many Strong Buy recommendations + buys_greater: nil, # Integer | Return only records with more than this many Buy recommendations + buys_less: nil, # Integer | Return only records with fewer than this many Buy recommendations + holds_greater: nil, # Integer | Return only records with more than this many Hold recommendations + holds_less: nil, # Integer | Return only records with fewer than this many Hold recommendations + sells_greater: nil, # Integer | Return only records with more than this many Sell recommendations + sells_less: nil, # Integer | Return only records with fewer than this many Sell recommendations + strong_sells_greater: nil, # Integer | Return only records with more than this many Strong Sell recommendations + strong_sells_less: nil, # Integer | Return only records with fewer than this many Strong Sell recommendations + total_greater: nil, # Integer | Return only records with more than this many recommendations, regardless of type + total_less: nil, # Integer | Return only records with fewer than this many recommendations, regardless of type + page_size: 100 # Integer | The number of results to return +} + +begin + result = security_api.get_security_zacks_analyst_ratings(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_zacks_analyst_ratings: #{e}" +end +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **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] + +### Return type + +[**ApiResponseSecurityZacksAnalystRatings**](ApiResponseSecurityZacksAnalystRatings.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/zacks/analyst_ratings/snapshot) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_zacks_analyst_ratings_snapshot) + +# **get_security_zacks_analyst_ratings_snapshot** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_zacks_analyst_ratings_snapshot_v2) + +> ApiResponseSecurityZacksAnalystRatingsSnapshot get_security_zacks_analyst_ratings_snapshot(identifier, opts) + +Zacks Analyst Ratings Snapshot + +Returns a snapshot of ratings data compared with previous timeframes for the Security with the given `identifier`. Also returns mean percentiles for comparing one security to the universe of securities covered by Zacks analyst ratings, at a specific point in time. + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + 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) + +opts = { + date: nil # String | Lookup a historical snapshot on the given date +} + +begin + result = security_api.get_security_zacks_analyst_ratings_snapshot(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_zacks_analyst_ratings_snapshot: #{e}" +end +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **date** | **String**| Lookup a historical snapshot on the given date | [optional] + +### Return type + +[**ApiResponseSecurityZacksAnalystRatingsSnapshot**](ApiResponseSecurityZacksAnalystRatingsSnapshot.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/zacks/eps_surprises) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_zacks_eps_surprises) + +# **get_security_zacks_eps_surprises** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_zacks_eps_surprises_v2) + +> ApiResponseSecurityZacksEPSSurprises get_security_zacks_eps_surprises(identifier, opts) + +Zacks EPS Surprises for Security + +Return Zacks EPS surprises for the Security with the given `identifier`. + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + 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) + +opts = { + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_zacks_eps_surprises(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_zacks_eps_surprises: #{e}" +end +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **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] + +### Return type + +[**ApiResponseSecurityZacksEPSSurprises**](ApiResponseSecurityZacksEPSSurprises.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/{identifier}/zacks/sales_surprises) + +[//]: # (DOC_LINK:SecurityApi.md#get_security_zacks_sales_surprises) + +# **get_security_zacks_sales_surprises** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_security_zacks_sales_surprises_v2) + +> ApiResponseSecurityZacksSalesSurprises get_security_zacks_sales_surprises(identifier, opts) + +Zacks Sales Surprises for Security + +Return Zacks sales surprises for the Security with the given `identifier`. + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```ruby +# Load the gem +require 'intrinio-sdk' + +# Setup authorization +Intrinio.configure do |config| + 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) + +opts = { + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = security_api.get_security_zacks_sales_surprises(identifier, opts) + p result +rescue Intrinio::ApiError => e + puts "Exception when calling SecurityApi->get_security_zacks_sales_surprises: #{e}" +end +``` + +[//]: # (END_CODE_EXAMPLE) + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | **String**| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) | + **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] + +### Return type + +[**ApiResponseSecurityZacksSalesSurprises**](ApiResponseSecurityZacksSalesSurprises.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/screen) + +[//]: # (DOC_LINK:SecurityApi.md#screen_securities) + # **screen_securities** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/screen_securities_v2) + > Array&lt;SecurityScreenResult&gt; screen_securities(opts) Screen Securities Screen Securities using complex logic ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -2240,43 +3249,60 @@ opts = { logic: Intrinio::SecurityScreenGroup.new, # SecurityScreenGroup | The logic to screen with, consisting of operators, clauses, and nested groups.<br/> See <a href=\"/documentation/screener_v2\" target=\"_blank\">screener documentation</a> for details on how to construct conditions. order_column: "order_column_example", # String | Results returned sorted by this column order_direction: "asc", # String | Sort order to use with the order_column primary_only: false, # BOOLEAN | Return only primary securities - page_size: 100 # Float | The number of results to return + page_size: 100 # Integer | The number of results to return } begin result = security_api.screen_securities(opts) p result rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->screen_securities: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **logic** | [**SecurityScreenGroup**](SecurityScreenGroup.md)| The logic to screen with, consisting of operators, clauses, and nested groups.&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** | **Float**| The number of results to return | [optional] [default to 100] + **page_size** | **Integer**| The number of results to return | [optional] [default to 100] ### Return type [**Array&lt;SecurityScreenResult&gt;**](SecurityScreenResult.md) +[//]: # (END_OPERATION) + + +[//]: # (START_OPERTATION) + +[//]: # (ENDPOINT:/securities/search) + +[//]: # (DOC_LINK:SecurityApi.md#search_securities) + # **search_securities** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/search_securities_v2) + > ApiResponseSecuritiesSearch search_securities(query, opts) Search Securities Searches for Securities matching the text `query` ### Example + +[//]: # (START_CODE_EXAMPLE) + ```ruby # Load the gem require 'intrinio-sdk' # Setup authorization @@ -2287,27 +3313,31 @@ security_api = Intrinio::SecurityApi.new query = "Apple" # String | opts = { - page_size: 100 # Float | The number of results to return + page_size: 100 # Integer | The number of results to return } begin result = security_api.search_securities(query, opts) p result rescue Intrinio::ApiError => e puts "Exception when calling SecurityApi->search_securities: #{e}" end ``` +[//]: # (END_CODE_EXAMPLE) + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | **String**| | - **page_size** | **Float**| The number of results to return | [optional] [default to 100] + **page_size** | **Integer**| The number of results to return | [optional] [default to 100] ### Return type [**ApiResponseSecuritiesSearch**](ApiResponseSecuritiesSearch.md) + +[//]: # (END_OPERATION)