No release notes for this build

intrinio · Jul 10, 2023 · 895331e · 895331e
1 parent 33dfa0e
commit 895331e
Show file tree

Hide file tree

Showing 302 changed files with 2,173 additions and 298 deletions.
diff --git a/README.md b/README.md
@@ -4,8 +4,8 @@ To get an API key, [sign up here](https://intrinio.com/).
 
 Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a wide selection of financial data feed APIs sourced by our own proprietary processes as well as from many data vendors. For a complete API request / response reference please view the [Intrinio API documentation](https://docs.intrinio.com/documentation/api_v2). If you need additional help in using the API, please visit the [Intrinio website](https://intrinio.com) and click on the chat icon in the lower right corner.
 
-- API version: 2.42.0
-- Package version: 6.24.0
+- API version: 2.43.6
+- Package version: 6.24.1
 
 
 ## Requirements.
@@ -250,9 +250,12 @@ Class | Method | HTTP request | Description
 *SecurityApi* | [**get_security_price_technicals_vwap**](docs/SecurityApi.md#get_security_price_technicals_vwap) | **GET** /securities/{identifier}/prices/technicals/vwap | Volume Weighted Average Price
 *SecurityApi* | [**get_security_price_technicals_wr**](docs/SecurityApi.md#get_security_price_technicals_wr) | **GET** /securities/{identifier}/prices/technicals/wr | Williams %R
 *SecurityApi* | [**get_security_realtime_price**](docs/SecurityApi.md#get_security_realtime_price) | **GET** /securities/{identifier}/prices/realtime | Realtime Stock Price for Security
+*SecurityApi* | [**get_security_replay_file**](docs/SecurityApi.md#get_security_replay_file) | **GET** /securities/replay | Security Replay File
 *SecurityApi* | [**get_security_snapshots**](docs/SecurityApi.md#get_security_snapshots) | **GET** /securities/snapshots | Realtime Stock Prices Snapshot
 *SecurityApi* | [**get_security_stock_price_adjustments**](docs/SecurityApi.md#get_security_stock_price_adjustments) | **GET** /securities/{identifier}/prices/adjustments | Stock Price Adjustments by Security
 *SecurityApi* | [**get_security_stock_prices**](docs/SecurityApi.md#get_security_stock_prices) | **GET** /securities/{identifier}/prices | Stock Prices by Security
+*SecurityApi* | [**get_security_trades**](docs/SecurityApi.md#get_security_trades) | **GET** /securities/trades | Security Trades
+*SecurityApi* | [**get_security_trades_by_symbol**](docs/SecurityApi.md#get_security_trades_by_symbol) | **GET** /securities/{identifier}/trades | Security Trades By Symbol
 *SecurityApi* | [**get_security_zacks_analyst_ratings**](docs/SecurityApi.md#get_security_zacks_analyst_ratings) | **GET** /securities/{identifier}/zacks/analyst_ratings | Zacks Analyst Ratings for Security
 *SecurityApi* | [**get_security_zacks_analyst_ratings_snapshot**](docs/SecurityApi.md#get_security_zacks_analyst_ratings_snapshot) | **GET** /securities/{identifier}/zacks/analyst_ratings/snapshot | Zacks Analyst Ratings Snapshot
 *SecurityApi* | [**get_security_zacks_eps_surprises**](docs/SecurityApi.md#get_security_zacks_eps_surprises) | **GET** /securities/{identifier}/zacks/eps_surprises | Zacks EPS Surprises for Security
@@ -529,13 +532,16 @@ Class | Method | HTTP request | Description
  - [Security](docs/Security.md)
  - [SecurityIntervalMover](docs/SecurityIntervalMover.md)
  - [SecurityIntervalsMoversResult](docs/SecurityIntervalsMoversResult.md)
+ - [SecurityReplayFileResult](docs/SecurityReplayFileResult.md)
  - [SecurityScreenClause](docs/SecurityScreenClause.md)
  - [SecurityScreenGroup](docs/SecurityScreenGroup.md)
  - [SecurityScreenResult](docs/SecurityScreenResult.md)
  - [SecurityScreenResultData](docs/SecurityScreenResultData.md)
  - [SecuritySnapshotGroup](docs/SecuritySnapshotGroup.md)
  - [SecuritySnapshotsResult](docs/SecuritySnapshotsResult.md)
  - [SecuritySummary](docs/SecuritySummary.md)
+ - [SecurityTrades](docs/SecurityTrades.md)
+ - [SecurityTradesResult](docs/SecurityTradesResult.md)
  - [SimpleMovingAverageTechnicalValue](docs/SimpleMovingAverageTechnicalValue.md)
  - [StandardizedFinancial](docs/StandardizedFinancial.md)
  - [StandardizedFinancialsDimension](docs/StandardizedFinancialsDimension.md)

diff --git a/docs/SecurityApi.md b/docs/SecurityApi.md
@@ -49,9 +49,12 @@ Method | HTTP request | Description
 [**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
@@ -3890,6 +3893,83 @@ Name | Type | Description  | Notes
 [//]: # (END_OPERATION)
 
 
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:SecurityApi)
+
+[//]: # (METHOD:get_security_replay_file)
+
+[//]: # (RETURN_TYPE: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/python/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)
+
+```python
+from __future__ import print_function
+import time
+import intrinio_sdk as intrinio
+from intrinio_sdk.rest import ApiException
+
+intrinio.ApiClient().set_api_key('YOUR_API_KEY')
+intrinio.ApiClient().allow_retries(True)
+
+subsource = ''
+date = ''
+
+response = intrinio.SecurityApi().get_security_replay_file(subsource, date)
+print(response)
+
+# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 
+```
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **subsource** | str| The specific source of the data being requested. |   &nbsp;
+ **date** | date| The date for the data being requested. |   &nbsp;
+<br/>
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**SecurityReplayFileResult**](SecurityReplayFileResult.md)
+
+[//]: # (END_OPERATION)
+
+
 [//]: # (START_OPERATION)
 
 [//]: # (CLASS:SecurityApi)
@@ -4133,6 +4213,184 @@ Name | Type | Description  | Notes
 [//]: # (END_OPERATION)
 
 
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:SecurityApi)
+
+[//]: # (METHOD:get_security_trades)
+
+[//]: # (RETURN_TYPE: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/python/get_security_trades_v2)
+
+[//]: # (START_OVERVIEW)
+
+> SecurityTradesResult get_security_trades(source, start_date=start_date, start_time=start_time, end_date=end_date, end_time=end_time, timezone=timezone, page_size=page_size, next_page=next_page)
+
+#### 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)
+
+```python
+from __future__ import print_function
+import time
+import intrinio_sdk as intrinio
+from intrinio_sdk.rest import ApiException
+
+intrinio.ApiClient().set_api_key('YOUR_API_KEY')
+intrinio.ApiClient().allow_retries(True)
+
+source = ''
+start_date = ''
+start_time = ''
+end_date = ''
+end_time = ''
+timezone = 'UTC'
+page_size = 100
+next_page = ''
+
+response = intrinio.SecurityApi().get_security_trades(source, start_date=start_date, start_time=start_time, end_date=end_date, end_time=end_time, timezone=timezone, page_size=page_size, next_page=next_page)
+print(response)
+
+# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 
+```
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **source** | str| The specific source of the data being requested. |   &nbsp;
+ **start_date** | date| The start date for the data being requested. | [optional]   &nbsp;
+ **start_time** | str| The start time for the data being requested. | [optional]   &nbsp;
+ **end_date** | date| The end date for the data being requested. | [optional]   &nbsp;
+ **end_time** | str| The end time for the data being requested. | [optional]   &nbsp;
+ **timezone** | str| The timezone the start and end date/times use. | [optional] [default to UTC]  &nbsp;
+ **page_size** | int| The maximum number of results to return per page. | [optional] [default to 100]  &nbsp;
+ **next_page** | str| Gets the next page of data from a previous API call | [optional]   &nbsp;
+<br/>
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**SecurityTradesResult**](SecurityTradesResult.md)
+
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:SecurityApi)
+
+[//]: # (METHOD:get_security_trades_by_symbol)
+
+[//]: # (RETURN_TYPE: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/python/get_security_trades_by_symbol_v2)
+
+[//]: # (START_OVERVIEW)
+
+> SecurityTradesResult get_security_trades_by_symbol(source, start_date=start_date, start_time=start_time, end_date=end_date, end_time=end_time, timezone=timezone, page_size=page_size, next_page=next_page)
+
+#### 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)
+
+```python
+from __future__ import print_function
+import time
+import intrinio_sdk as intrinio
+from intrinio_sdk.rest import ApiException
+
+intrinio.ApiClient().set_api_key('YOUR_API_KEY')
+intrinio.ApiClient().allow_retries(True)
+
+source = ''
+start_date = ''
+start_time = ''
+end_date = ''
+end_time = ''
+timezone = 'UTC'
+page_size = 100
+next_page = ''
+
+response = intrinio.SecurityApi().get_security_trades_by_symbol(source, start_date=start_date, start_time=start_time, end_date=end_date, end_time=end_time, timezone=timezone, page_size=page_size, next_page=next_page)
+print(response)
+
+# Note: For a Pandas DataFrame, import Pandas and use pd.DataFrame(response.property_name_dict) 
+```
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **source** | str| The specific source of the data being requested. |   &nbsp;
+ **start_date** | date| The start date for the data being requested. | [optional]   &nbsp;
+ **start_time** | str| The start time for the data being requested. | [optional]   &nbsp;
+ **end_date** | date| The end date for the data being requested. | [optional]   &nbsp;
+ **end_time** | str| The end time for the data being requested. | [optional]   &nbsp;
+ **timezone** | str| The timezone the start and end date/times use. | [optional] [default to UTC]  &nbsp;
+ **page_size** | int| The maximum number of results to return per page. | [optional] [default to 100]  &nbsp;
+ **next_page** | str| Gets the next page of data from a previous API call | [optional]   &nbsp;
+<br/>
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**SecurityTradesResult**](SecurityTradesResult.md)
+
+[//]: # (END_OPERATION)
+
+
 [//]: # (START_OPERATION)
 
 [//]: # (CLASS:SecurityApi)

diff --git a/docs/SecurityReplayFileResult.md b/docs/SecurityReplayFileResult.md
@@ -0,0 +1,22 @@
+
+
+[//]: # (CLASS:SecurityReplayFileResult)
+
+[//]: # (KIND:object)
+
+### SecurityReplayFileResult
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**name** | str | The name of the file. &nbsp;
+**url** | str | The url where the file may be downloaded. &nbsp;
+**size** | float | The size of the file in bytes. &nbsp;
+
+[//]: # (END_DEFINITION)
+
+
+
diff --git a/docs/SecurityTrades.md b/docs/SecurityTrades.md
@@ -0,0 +1,26 @@
+
+
+[//]: # (CLASS:SecurityTrades)
+
+[//]: # (KIND:object)
+
+### SecurityTrades
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**symbol** | str | The ticker symbol &nbsp;
+**timestamp** | datetime | The UTC timestamp at the time of the trade. &nbsp;
+**price** | float | The price of the trade. &nbsp;
+**size** | float | The size of the trade. &nbsp;
+**total_volume** | float | The total volume of the symbol for the day up to the timestamp point in time. &nbsp;
+**market_center** | str | The market center for the trade. &nbsp;
+**condition** | str | The condition of the trade. &nbsp;
+
+[//]: # (END_DEFINITION)
+
+
+
diff --git a/docs/SecurityTradesResult.md b/docs/SecurityTradesResult.md
@@ -0,0 +1,25 @@
+
+
+[//]: # (CLASS:SecurityTradesResult)
+
+[//]: # (KIND:object)
+
+### SecurityTradesResult
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**next_page** | str | The token required to request the next page of the data. If null, no further results are available. &nbsp;
+**source** | str | The source of the trades. &nbsp;
+**trades** | [**list[SecurityTrades]**](SecurityTrades.md) | Array of all the trades in this page of the result. &nbsp;
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:SecurityTrades)
+
+
+