docs/SecurityApi.md in intrinio-sdk-6.24.0 vs docs/SecurityApi.md in intrinio-sdk-6.24.1

- old
+ new

@@ -47,13 +47,16 @@ [**get_security_price_technicals_vi**](SecurityApi.md#get_security_price_technicals_vi) | **GET** /securities/{identifier}/prices/technicals/vi | Vortex Indicator [**get_security_price_technicals_vpt**](SecurityApi.md#get_security_price_technicals_vpt) | **GET** /securities/{identifier}/prices/technicals/vpt | Volume-price Trend [**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_replay_file**](SecurityApi.md#get_security_replay_file) | **GET** /securities/replay | Security Replay File [**get_security_snapshots**](SecurityApi.md#get_security_snapshots) | **GET** /securities/snapshots | Realtime Stock Prices Snapshot [**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_trades**](SecurityApi.md#get_security_trades) | **GET** /securities/trades | Security Trades +[**get_security_trades_by_symbol**](SecurityApi.md#get_security_trades_by_symbol) | **GET** /securities/{identifier}/trades | Security Trades By Symbol [**get_security_zacks_analyst_ratings**](SecurityApi.md#get_security_zacks_analyst_ratings) | **GET** /securities/{identifier}/zacks/analyst_ratings | Zacks Analyst Ratings for Security [**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 @@ -4099,10 +4102,89 @@ [//]: # (START_OPERATION) [//]: # (CLASS:Intrinio::SecurityApi) +[//]: # (METHOD:get_security_replay_file) + +[//]: # (RETURN_TYPE:Intrinio::SecurityReplayFileResult) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:SecurityReplayFileResult.md) + +[//]: # (OPERATION:get_security_replay_file_v2) + +[//]: # (ENDPOINT:/securities/replay) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_replay_file) + +## **get_security_replay_file** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_replay_file_v2) + +[//]: # (START_OVERVIEW) + +> SecurityReplayFileResult get_security_replay_file(subsource, date) + +#### Security Replay File + + +Returns a url where the requested replay file may be downloaded from. + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```ruby +# Load the gem +require 'intrinio-sdk' +require 'pp' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR_API_KEY' + config.allow_retries = true +end + +security_api = Intrinio::SecurityApi.new +subsource = nil +date = nil + +result = security_api.get_security_replay_file(subsource, date) +pp result +``` + +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **subsource** | String| The specific source of the data being requested. |   + **date** | Date| The date for the data being requested. |   + +[//]: # (END_PARAMETERS) + +### Return type + +[**SecurityReplayFileResult**](SecurityReplayFileResult.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + [//]: # (METHOD:get_security_snapshots) [//]: # (RETURN_TYPE:Intrinio::SecuritySnapshotsResult) [//]: # (RETURN_TYPE_KIND:object) @@ -4349,9 +4431,197 @@ [//]: # (END_PARAMETERS) ### Return type [**ApiResponseSecurityStockPrices**](ApiResponseSecurityStockPrices.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_trades) + +[//]: # (RETURN_TYPE:Intrinio::SecurityTradesResult) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:SecurityTradesResult.md) + +[//]: # (OPERATION:get_security_trades_v2) + +[//]: # (ENDPOINT:/securities/trades) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_trades) + +## **get_security_trades** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_trades_v2) + +[//]: # (START_OVERVIEW) + +> SecurityTradesResult get_security_trades(source, opts) + +#### Security Trades + + +Returns all trades between start time and end time, up to seven days ago for the specified source. + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```ruby +# Load the gem +require 'intrinio-sdk' +require 'pp' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR_API_KEY' + config.allow_retries = true +end + +security_api = Intrinio::SecurityApi.new +source = nil + +opts = { + start_date: nil, + start_time: nil, + end_date: nil, + end_time: nil, + timezone: "UTC", + page_size: 100, + next_page: nil +} + +result = security_api.get_security_trades(source, opts) +pp result +``` + +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **source** | String| The specific source of the data being requested. |   + **start_date** | Date| The start date for the data being requested. | [optional]   + **start_time** | String| The start time for the data being requested. | [optional]   + **end_date** | Date| The end date for the data being requested. | [optional]   + **end_time** | String| The end time for the data being requested. | [optional]   + **timezone** | String| The timezone the start and end date/times use. | [optional] [default to UTC]   + **page_size** | Integer| The maximum number of results to return per page. | [optional] [default to 100]   + **next_page** | String| Gets the next page of data from a previous API call | [optional]   + +[//]: # (END_PARAMETERS) + +### Return type + +[**SecurityTradesResult**](SecurityTradesResult.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_trades_by_symbol) + +[//]: # (RETURN_TYPE:Intrinio::SecurityTradesResult) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:SecurityTradesResult.md) + +[//]: # (OPERATION:get_security_trades_by_symbol_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/trades) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_trades_by_symbol) + +## **get_security_trades_by_symbol** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_trades_by_symbol_v2) + +[//]: # (START_OVERVIEW) + +> SecurityTradesResult get_security_trades_by_symbol(source, opts) + +#### Security Trades By Symbol + + +Returns all trades for a symbol between start time and end time, up to seven days ago for the specified source. + +[//]: # (END_OVERVIEW) + +### Example + +[//]: # (START_CODE_EXAMPLE) + +```ruby +# Load the gem +require 'intrinio-sdk' +require 'pp' + +# Setup authorization +Intrinio.configure do |config| + config.api_key['api_key'] = 'YOUR_API_KEY' + config.allow_retries = true +end + +security_api = Intrinio::SecurityApi.new +source = nil + +opts = { + start_date: nil, + start_time: nil, + end_date: nil, + end_time: nil, + timezone: "UTC", + page_size: 100, + next_page: nil +} + +result = security_api.get_security_trades_by_symbol(source, opts) +pp result +``` + +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **source** | String| The specific source of the data being requested. |   + **start_date** | Date| The start date for the data being requested. | [optional]   + **start_time** | String| The start time for the data being requested. | [optional]   + **end_date** | Date| The end date for the data being requested. | [optional]   + **end_time** | String| The end time for the data being requested. | [optional]   + **timezone** | String| The timezone the start and end date/times use. | [optional] [default to UTC]   + **page_size** | Integer| The maximum number of results to return per page. | [optional] [default to 100]   + **next_page** | String| Gets the next page of data from a previous API call | [optional]   + +[//]: # (END_PARAMETERS) + +### Return type + +[**SecurityTradesResult**](SecurityTradesResult.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION)