docs/SecurityApi.md in intrinio-sdk-5.21.0 vs docs/SecurityApi.md in intrinio-sdk-6.21.0

- old
+ new

@@ -44,10 +44,11 @@ [**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_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_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 @@ -3841,9 +3842,89 @@ [//]: # (END_PARAMETERS) ### Return type [**RealtimeStockPrice**](RealtimeStockPrice.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_snapshots) + +[//]: # (RETURN_TYPE:Intrinio::SecuritySnapshotsResult) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:SecuritySnapshotsResult.md) + +[//]: # (OPERATION:get_security_snapshots_v2) + +[//]: # (ENDPOINT:/securities/snapshots) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_snapshots) + +## **get_security_snapshots** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_snapshots_v2) + +[//]: # (START_OVERVIEW) + +> SecuritySnapshotsResult get_security_snapshots(opts) + +#### Realtime Stock Prices Snapshot + + +Returns all security snapshots for the queried interval with links to download. + +[//]: # (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 + +opts = { + at_datetime: DateTime.parse(nil) +} + +result = security_api.get_security_snapshots(opts) +pp result +``` + +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **at_datetime** | DateTime| The UTC date and time (with url-encoded spaces) the snapshot will cover. | [optional]   + +[//]: # (END_PARAMETERS) + +### Return type + +[**SecuritySnapshotsResult**](SecuritySnapshotsResult.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION)