No release notes for this build

intrinio · Nov 27, 2024 · 8c3a05a · 8c3a05a
1 parent 06604be
commit 8c3a05a
Show file tree

Hide file tree

Showing 666 changed files with 1,765 additions and 1,001 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.75.0
-- Package version: 6.33.0
+- API version: 2.76.3
+- Package version: 6.34.0
 
 
 ## Installation
@@ -257,6 +257,7 @@ Class | Method | HTTP request | Description
 *intrinioSDK.SecurityApi* | [**screenSecurities**](docs/SecurityApi.md#screenSecurities) | **POST** /securities/screen | Screen Securities
 *intrinioSDK.SecurityApi* | [**searchSecurities**](docs/SecurityApi.md#searchSecurities) | **GET** /securities/search | Search Securities
 *intrinioSDK.StockExchangeApi* | [**getAllStockExchanges**](docs/StockExchangeApi.md#getAllStockExchanges) | **GET** /stock_exchanges | All Stock Exchanges
+*intrinioSDK.StockExchangeApi* | [**getStockExchangeBetas**](docs/StockExchangeApi.md#getStockExchangeBetas) | **GET** /stock_exchanges/{identifier}/betas | Security Betas
 *intrinioSDK.StockExchangeApi* | [**getStockExchangeById**](docs/StockExchangeApi.md#getStockExchangeById) | **GET** /stock_exchanges/{identifier} | Lookup Stock Exchange
 *intrinioSDK.StockExchangeApi* | [**getStockExchangeGainers**](docs/StockExchangeApi.md#getStockExchangeGainers) | **GET** /stock_exchanges/{identifier}/gainers | Top Gainers by Exchange
 *intrinioSDK.StockExchangeApi* | [**getStockExchangeLosers**](docs/StockExchangeApi.md#getStockExchangeLosers) | **GET** /stock_exchanges/{identifier}/losers | Top Losers by Exchange
@@ -432,6 +433,7 @@ Class | Method | HTTP request | Description
  - [intrinioSDK.ApiResponseSecurityZacksSalesSurprises](docs/ApiResponseSecurityZacksSalesSurprises.md)
  - [intrinioSDK.ApiResponseStandardizedFinancials](docs/ApiResponseStandardizedFinancials.md)
  - [intrinioSDK.ApiResponseStandardizedFinancialsDimensions](docs/ApiResponseStandardizedFinancialsDimensions.md)
+ - [intrinioSDK.ApiResponseStockExchangeBetas](docs/ApiResponseStockExchangeBetas.md)
  - [intrinioSDK.ApiResponseStockExchangeMovers](docs/ApiResponseStockExchangeMovers.md)
  - [intrinioSDK.ApiResponseStockExchangeQuote](docs/ApiResponseStockExchangeQuote.md)
  - [intrinioSDK.ApiResponseStockExchangeRealtimeStockPrices](docs/ApiResponseStockExchangeRealtimeStockPrices.md)
@@ -460,6 +462,7 @@ Class | Method | HTTP request | Description
  - [intrinioSDK.AverageDirectionalIndexTechnicalValue](docs/AverageDirectionalIndexTechnicalValue.md)
  - [intrinioSDK.AverageTrueRangeTechnicalValue](docs/AverageTrueRangeTechnicalValue.md)
  - [intrinioSDK.AwesomeOscillatorTechnicalValue](docs/AwesomeOscillatorTechnicalValue.md)
+ - [intrinioSDK.Beta](docs/Beta.md)
  - [intrinioSDK.BollingerBandsTechnicalValue](docs/BollingerBandsTechnicalValue.md)
  - [intrinioSDK.BulkDownloadLinks](docs/BulkDownloadLinks.md)
  - [intrinioSDK.BulkDownloadSummary](docs/BulkDownloadSummary.md)

diff --git a/docs/ApiResponseStockExchangeBetas.md b/docs/ApiResponseStockExchangeBetas.md
@@ -0,0 +1,29 @@
+
+[//]: # (CLASS:ApiResponseStockExchangeBetas)
+
+[//]: # (KIND:object)
+
+### ApiResponseStockExchangeBetas
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**betas** | [**[Beta]**](Beta.md) | The mover security. &nbsp;
+**stockExchange** | [**StockExchange**](StockExchange.md) | The Stock Exchange resolved from the given identifier &nbsp;
+**nextPage** | String | The token required to request the next page of the data. If null, no further results are available. &nbsp;
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Beta)
+
+
+[//]: # (CONTAINED_CLASS:StockExchange)
+
+
+
+
+
diff --git a/docs/Beta.md b/docs/Beta.md
@@ -0,0 +1,39 @@
+
+[//]: # (CLASS:Beta)
+
+[//]: # (KIND:object)
+
+### Beta
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**periodType** | String | Type of period for this beta value. &nbsp;
+**oneYearBeta** | Number | The one year beta value for this security. &nbsp;
+**threeYearBeta** | Number | The three year beta value for this security. &nbsp;
+**fiveYearBeta** | Number | The five year beta value for this security. &nbsp;
+**sevenYearBeta** | Number | The seven year beta value for this security. &nbsp;
+**tenYearBeta** | Number | The ten year beta value for this security. &nbsp;
+**security** | [**SecuritySummary**](SecuritySummary.md) | The Security. &nbsp;
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:SecuritySummary)
+
+
+
+<br/>
+
+#### Enum: PeriodTypeEnum**
+
+Name | Value
+---- | -----
+weekly | &quot;weekly&quot;
+monthly | &quot;monthly&quot;
+
+
+
diff --git a/docs/OptionInterval.md b/docs/OptionInterval.md
@@ -17,9 +17,10 @@ Name | Type | Description
 **high** | Number | The highest traded contract price in this interval. &nbsp;
 **low** | Number | The lowest traded contract price in this interval. &nbsp;
 **close** | Number | The last traded contract price in this interval. &nbsp;
-**volume** | Number | The volume of contract trades in this interval. &nbsp;
+**volume** | Number | The volume of contracts traded in this interval. &nbsp;
 **average** | Number | The volume weighted average price of contract trades in this interval. &nbsp;
 **change** | Number | The ratio of Close minus Open to Open. &nbsp;
+**tradeCount** | Number | The number of qualified trades executed during the period &nbsp;
 
 [//]: # (END_DEFINITION)
 

diff --git a/docs/OptionIntervalMover.md b/docs/OptionIntervalMover.md
@@ -17,8 +17,9 @@ Name | Type | Description
 **high** | Number | The highest traded contract price in this interval. &nbsp;
 **low** | Number | The lowest traded contract price in this interval. &nbsp;
 **close** | Number | The last traded contract price in this interval. &nbsp;
-**volume** | Number | The volume of contract trades in this interval. &nbsp;
+**volume** | Number | The volume of contracts traded in this interval. &nbsp;
 **average** | Number | The volume weighted average price of contract trades in this interval. &nbsp;
+**tradeCount** | Number | The number of contract trades executed in this interval &nbsp;
 
 [//]: # (END_DEFINITION)
 

diff --git a/docs/OptionsApi.md b/docs/OptionsApi.md
@@ -61,7 +61,7 @@ Method | HTTP request | Description
 
 [//]: # (START_OVERVIEW)
 
-> ApiResponseOptionsTickers getAllOptionsTickers()
+> ApiResponseOptionsTickers getAllOptionsTickers(opts)
 
 #### Options Tickers
 
@@ -81,7 +81,11 @@ intrinioSDK.ApiClient.instance.enableRetries = true;
 
 var options = new intrinioSDK.OptionsApi();
 
-options.getAllOptionsTickers().then(function(data) {
+var opts = { 
+  'useUnderlyingSymbols': false
+};
+
+options.getAllOptionsTickers(opts).then(function(data) {
   data = JSON.stringify(data, null, 2)
   console.log(data);
 }, function(error) {
@@ -95,7 +99,10 @@ options.getAllOptionsTickers().then(function(data) {
 
 [//]: # (START_PARAMETERS)
 
-This endpoint does not need any parameter.
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **useUnderlyingSymbols** | Boolean| Use underlying symbol vs contract symbol | [optional] [default to false] &nbsp;
 <br/>
 
 [//]: # (END_PARAMETERS)

diff --git a/docs/SecurityIntervalMover.md b/docs/SecurityIntervalMover.md
@@ -17,8 +17,9 @@ Name | Type | Description
 **high** | Number | The highest traded price in this interval. &nbsp;
 **low** | Number | The lowest traded price in this interval. &nbsp;
 **close** | Number | The last traded price in this interval. &nbsp;
-**volume** | Number | The volume of trades in this interval. &nbsp;
+**volume** | Number | The volume of shares in this interval. &nbsp;
 **average** | Number | The volume weighted average price of trades in this interval. &nbsp;
+**tradeCount** | Number | The of trades in this interval. &nbsp;
 
 [//]: # (END_DEFINITION)
 

diff --git a/docs/StockExchangeApi.md b/docs/StockExchangeApi.md
@@ -5,6 +5,7 @@ All URIs are relative to *https://api-v2.intrinio.com*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**getAllStockExchanges**](StockExchangeApi.md#getAllStockExchanges) | **GET** /stock_exchanges | All Stock Exchanges
+[**getStockExchangeBetas**](StockExchangeApi.md#getStockExchangeBetas) | **GET** /stock_exchanges/{identifier}/betas | Security Betas
 [**getStockExchangeById**](StockExchangeApi.md#getStockExchangeById) | **GET** /stock_exchanges/{identifier} | Lookup Stock Exchange
 [**getStockExchangeGainers**](StockExchangeApi.md#getStockExchangeGainers) | **GET** /stock_exchanges/{identifier}/gainers | Top Gainers by Exchange
 [**getStockExchangeLosers**](StockExchangeApi.md#getStockExchangeLosers) | **GET** /stock_exchanges/{identifier}/losers | Top Losers by Exchange
@@ -99,6 +100,96 @@ Name | Type | Description  | Notes
 
 
 
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:StockExchangeApi)
+
+[//]: # (METHOD:getStockExchangeBetas)
+
+[//]: # (RETURN_TYPE:ApiResponseStockExchangeBetas)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseStockExchangeBetas.md)
+
+[//]: # (OPERATION:getStockExchangeBetas_v2)
+
+[//]: # (ENDPOINT:/stock_exchanges/{identifier}/betas)
+
+[//]: # (DOCUMENT_LINK:StockExchangeApi.md#getStockExchangeBetas)
+
+<a name="getStockExchangeBetas"></a>
+## **getStockExchangeBetas**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/javascript/getStockExchangeBetas_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseStockExchangeBetas getStockExchangeBetas(identifier, opts)
+
+#### Security Betas
+
+
+Returns security beta data in the Stock Exchange with the given &#x60;identifier&#x60;
+
+[//]: # (END_OVERVIEW)
+
+### Example
+
+[//]: # (START_CODE_EXAMPLE)
+
+```javascript
+var intrinioSDK = require('intrinio-sdk');
+intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
+intrinioSDK.ApiClient.instance.enableRetries = true;
+
+var stockExchange = new intrinioSDK.StockExchangeApi();
+
+var identifier = "USCOMP";
+
+
+var opts = { 
+  'type': "weekly",
+  'date': "2024-04-24",
+  'pageSize': 100,
+  'nextPage': null
+};
+
+stockExchange.getStockExchangeBetas(identifier, opts).then(function(data) {
+  data = JSON.stringify(data, null, 2)
+  console.log(data);
+}, function(error) {
+  console.error(error);
+});
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | String| A Stock Exchange identifier (MIC or Intrinio ID) |  &nbsp;
+ **type** | String| Only of the given type | [optional] [default to weekly] &nbsp;
+ **date** | [**Object**](.md)| Return data for this period end date. | [optional]  &nbsp;
+ **pageSize** | Number| The number of results to return | [optional] [default to 100] &nbsp;
+ **nextPage** | String| Gets the next page of data from a previous API call | [optional]  &nbsp;
+<br/>
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseStockExchangeBetas**](ApiResponseStockExchangeBetas.md)
+
+
+
 [//]: # (END_OPERATION)
 
 

diff --git a/docs/StockPriceInterval.md b/docs/StockPriceInterval.md
@@ -35,6 +35,7 @@ Name | Type | Description
 **askFirstTime** | Date | The timestamp that represents the first ask time from the interval span. &nbsp;
 **askLastTime** | Date | The timestamp that represents the last ask time from the interval span. &nbsp;
 **askChangePercent** | Number | The ratio of the close to open ask difference, in percent. &nbsp;
+**tradeCount** | Number | The number of qualified trades executed during the period &nbsp;
 
 [//]: # (END_DEFINITION)
 

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "intrinio-sdk",
-  "version": "6.33.0",
+  "version": "6.34.0",
   "description": "Access the Intrinio API",
   "license": "GPLv3",
   "main": "src/index.js",

diff --git a/src/ApiClient.js b/src/ApiClient.js
@@ -2,7 +2,7 @@
  * Intrinio API
  * 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.
  *
- * OpenAPI spec version: 2.75.0
+ * OpenAPI spec version: 2.76.3
  *
  * NOTE: This class is auto generated by the swagger code generator program.
  * https://github.com/swagger-api/swagger-codegen.git
@@ -32,7 +32,7 @@
 
   /**
    * @module ApiClient
-   * @version 6.33.0
+   * @version 6.34.0
    */
 
   /**

diff --git a/src/api/BulkDownloadsApi.js b/src/api/BulkDownloadsApi.js
@@ -2,7 +2,7 @@
  * Intrinio API
  * 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.
  *
- * OpenAPI spec version: 2.75.0
+ * OpenAPI spec version: 2.76.3
  *
  * NOTE: This class is auto generated by the swagger code generator program.
  * https://github.com/swagger-api/swagger-codegen.git
@@ -33,7 +33,7 @@
   /**
    * BulkDownloads service.
    * @module api/BulkDownloadsApi
-   * @version 6.33.0
+   * @version 6.34.0
    */
 
   /**

diff --git a/src/api/CompanyApi.js b/src/api/CompanyApi.js
@@ -2,7 +2,7 @@
  * Intrinio API
  * 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.
  *
- * OpenAPI spec version: 2.75.0
+ * OpenAPI spec version: 2.76.3
  *
  * NOTE: This class is auto generated by the swagger code generator program.
  * https://github.com/swagger-api/swagger-codegen.git
@@ -33,7 +33,7 @@
   /**
    * Company service.
    * @module api/CompanyApi
-   * @version 6.33.0
+   * @version 6.34.0
    */
 
   /**

diff --git a/src/api/DataPointApi.js b/src/api/DataPointApi.js
@@ -2,7 +2,7 @@
  * Intrinio API
  * 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.
  *
- * OpenAPI spec version: 2.75.0
+ * OpenAPI spec version: 2.76.3
  *
  * NOTE: This class is auto generated by the swagger code generator program.
  * https://github.com/swagger-api/swagger-codegen.git
@@ -33,7 +33,7 @@
   /**
    * DataPoint service.
    * @module api/DataPointApi
-   * @version 6.33.0
+   * @version 6.34.0
    */
 
   /**

diff --git a/src/api/DataTagApi.js b/src/api/DataTagApi.js
@@ -2,7 +2,7 @@
  * Intrinio API
  * 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.
  *
- * OpenAPI spec version: 2.75.0
+ * OpenAPI spec version: 2.76.3
  *
  * NOTE: This class is auto generated by the swagger code generator program.
  * https://github.com/swagger-api/swagger-codegen.git
@@ -33,7 +33,7 @@
   /**
    * DataTag service.
    * @module api/DataTagApi
-   * @version 6.33.0
+   * @version 6.34.0
    */
 
   /**