intrinio-sdk 5.10.0 → 5.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d477676f747436f154f5f2e63ecbbfcee3aa658faa68a080bd1fd147bf42263
-  data.tar.gz: 6557e9d6227dcbbf5b59d42693054bd990efb67221e8e99c647be9deba2f5ac6
+  metadata.gz: ad3cd75c4cbde811850e60a0a02897b2869524380d8780e74697429a3ad1eda2
+  data.tar.gz: 782dc4fa857df99c61d6245e66fcf04bbcaf913b3e453db16c5823af04408289
 SHA512:
-  metadata.gz: 1693d6e2c507ad8d49d0bc5b175556d05e9fa89c61e29850dee06308c364bca3250d4f5cd6de6fcc9f4a520e258b04ee53b1226ecc7a054a07bade72a3150456
-  data.tar.gz: b133208e89e0e65a238ac9c16a7ddfe14f43f4edad9850204c2f2cb9979b3893658c924c9357c476b19697f2eaaa9a9a931383c4acd3fdf4e09df0209eb0e196
+  metadata.gz: 1928433440fb3c336e58c0a828a115a219c46003b97a2dfbcfaa2d50193a7602540dcbf5c1b819206369647c47ea8b5c6da397f46049f2482d23353c13582d5a
+  data.tar.gz: 171dab1b938425722811693eddb3d87b00f88ffc51c0efd59f66b039d961aa490a42df40dd1e8ace7539880762a5b37cba1602804b7da6eefea10f286496fd4e

data/README.md

@@ -8,8 +8,8 @@ Welcome to the Intrinio API! Through our Financial Data Marketplace, we offer a
 
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
-- API version: 2.20.0
-- Package version: 5.10.0
+- API version: 2.21.1
+- Package version: 5.11.0
 
 
 ## Installation
@@ -77,6 +77,7 @@ Class | Method | HTTP request | Description
 *Intrinio::CompanyApi* | [**latest_insider_transaction_filing_by_company**](docs/CompanyApi.md#latest_insider_transaction_filing_by_company) | **GET** /companies/{identifier}/insider_transaction_filings/latest | Latest Insider Transaction Filing by Company
 *Intrinio::CompanyApi* | [**lookup_company_fundamental**](docs/CompanyApi.md#lookup_company_fundamental) | **GET** /companies/{identifier}/fundamentals/lookup/{statement_code}/{fiscal_year}/{fiscal_period} | Lookup Fundamental by Company
 *Intrinio::CompanyApi* | [**search_companies**](docs/CompanyApi.md#search_companies) | **GET** /companies/search | Search Companies
+*Intrinio::CompanyApi* | [**shares_outstanding_by_company**](docs/CompanyApi.md#shares_outstanding_by_company) | **GET** /companies/{identifier}/shares_outstanding | Shares Outstanding by Company
 *Intrinio::DataPointApi* | [**get_data_point_number**](docs/DataPointApi.md#get_data_point_number) | **GET** /data_point/{identifier}/{tag}/number | Data Point (Number)
 *Intrinio::DataPointApi* | [**get_data_point_text**](docs/DataPointApi.md#get_data_point_text) | **GET** /data_point/{identifier}/{tag}/text | Data Point (Text)
 *Intrinio::DataTagApi* | [**get_all_data_tags**](docs/DataTagApi.md#get_all_data_tags) | **GET** /data_tags | All Data Tags
@@ -135,6 +136,7 @@ Class | Method | HTTP request | Description
 *Intrinio::OptionsApi* | [**get_options_chain_realtime**](docs/OptionsApi.md#get_options_chain_realtime) | **GET** /options/chain/{symbol}/{expiration}/realtime | Options Chain Realtime
 *Intrinio::OptionsApi* | [**get_options_expirations**](docs/OptionsApi.md#get_options_expirations) | **GET** /options/expirations/{symbol} | Options Expirations
 *Intrinio::OptionsApi* | [**get_options_prices**](docs/OptionsApi.md#get_options_prices) | **GET** /options/prices/{identifier} | Option Prices
+*Intrinio::OptionsApi* | [**get_options_prices_batch_realtime**](docs/OptionsApi.md#get_options_prices_batch_realtime) | **POST** /options/prices/realtime/batch | Option Prices Batch Realtime
 *Intrinio::OptionsApi* | [**get_options_prices_realtime**](docs/OptionsApi.md#get_options_prices_realtime) | **GET** /options/prices/{identifier}/realtime | Option Prices Realtime
 *Intrinio::OptionsApi* | [**get_options_stats_realtime**](docs/OptionsApi.md#get_options_stats_realtime) | **GET** /options/prices/{identifier}/realtime/stats | Option Stats Realtime
 *Intrinio::OwnersApi* | [**get_all_owners**](docs/OwnersApi.md#get_all_owners) | **GET** /owners | All Owners
@@ -254,6 +256,7 @@ Class | Method | HTTP request | Description
  - [Intrinio::ApiResponseCompanyInsiderTransactionFilings](docs/ApiResponseCompanyInsiderTransactionFilings.md)
  - [Intrinio::ApiResponseCompanyNews](docs/ApiResponseCompanyNews.md)
  - [Intrinio::ApiResponseCompanySecurities](docs/ApiResponseCompanySecurities.md)
+ - [Intrinio::ApiResponseCompanySharesOutstanding](docs/ApiResponseCompanySharesOutstanding.md)
  - [Intrinio::ApiResponseDataTags](docs/ApiResponseDataTags.md)
  - [Intrinio::ApiResponseDataTagsSearch](docs/ApiResponseDataTagsSearch.md)
  - [Intrinio::ApiResponseETFHoldings](docs/ApiResponseETFHoldings.md)
@@ -280,6 +283,7 @@ Class | Method | HTTP request | Description
  - [Intrinio::ApiResponseOptionsChainRealtime](docs/ApiResponseOptionsChainRealtime.md)
  - [Intrinio::ApiResponseOptionsExpirations](docs/ApiResponseOptionsExpirations.md)
  - [Intrinio::ApiResponseOptionsPriceRealtime](docs/ApiResponseOptionsPriceRealtime.md)
+ - [Intrinio::ApiResponseOptionsPricesBatchRealtime](docs/ApiResponseOptionsPricesBatchRealtime.md)
  - [Intrinio::ApiResponseOptionsRealtime](docs/ApiResponseOptionsRealtime.md)
  - [Intrinio::ApiResponseOptionsStatsRealtime](docs/ApiResponseOptionsStatsRealtime.md)
  - [Intrinio::ApiResponseOwnerInsiderTransactionFilings](docs/ApiResponseOwnerInsiderTransactionFilings.md)
@@ -366,6 +370,7 @@ Class | Method | HTTP request | Description
  - [Intrinio::CompanyInitialPublicOffering](docs/CompanyInitialPublicOffering.md)
  - [Intrinio::CompanyNews](docs/CompanyNews.md)
  - [Intrinio::CompanyNewsSummary](docs/CompanyNewsSummary.md)
+ - [Intrinio::CompanySharesOutstanding](docs/CompanySharesOutstanding.md)
  - [Intrinio::CompanySummary](docs/CompanySummary.md)
  - [Intrinio::DataTag](docs/DataTag.md)
  - [Intrinio::DataTagSummary](docs/DataTagSummary.md)
@@ -412,8 +417,10 @@ Class | Method | HTTP request | Description
  - [Intrinio::Option](docs/Option.md)
  - [Intrinio::OptionChain](docs/OptionChain.md)
  - [Intrinio::OptionChainRealtime](docs/OptionChainRealtime.md)
+ - [Intrinio::OptionContractsList](docs/OptionContractsList.md)
  - [Intrinio::OptionFactorsRealtime](docs/OptionFactorsRealtime.md)
  - [Intrinio::OptionPrice](docs/OptionPrice.md)
+ - [Intrinio::OptionPriceBatchRealtime](docs/OptionPriceBatchRealtime.md)
  - [Intrinio::OptionPriceRealtime](docs/OptionPriceRealtime.md)
  - [Intrinio::OptionRealtime](docs/OptionRealtime.md)
  - [Intrinio::OptionStatsRealtime](docs/OptionStatsRealtime.md)

data/docs/ApiResponseCompanySharesOutstanding.md

@@ -0,0 +1,27 @@
+
+
+[//]: # (CLASS:Intrinio::ApiResponseCompanySharesOutstanding)
+
+[//]: # (KIND:object)
+
+### Intrinio::ApiResponseCompanySharesOutstanding
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**shares_outstanding** | [**Array<CompanySharesOutstanding>**](CompanySharesOutstanding.md) |   
+**company** | [**CompanySummary**](CompanySummary.md) |   
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::CompanySharesOutstanding)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::CompanySummary)
+
+
+

data/docs/ApiResponseOptionsPricesBatchRealtime.md

@@ -0,0 +1,23 @@
+
+
+[//]: # (CLASS:Intrinio::ApiResponseOptionsPricesBatchRealtime)
+
+[//]: # (KIND:object)
+
+### Intrinio::ApiResponseOptionsPricesBatchRealtime
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**contracts** | [**Array<OptionPriceBatchRealtime>**](OptionPriceBatchRealtime.md) |   
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::OptionPriceBatchRealtime)
+
+
+

data/docs/CompanyApi.md

@@ -19,6 +19,7 @@ Method | HTTP request | Description
 [**latest_insider_transaction_filing_by_company**](CompanyApi.md#latest_insider_transaction_filing_by_company) | **GET** /companies/{identifier}/insider_transaction_filings/latest | Latest Insider Transaction Filing by Company
 [**lookup_company_fundamental**](CompanyApi.md#lookup_company_fundamental) | **GET** /companies/{identifier}/fundamentals/lookup/{statement_code}/{fiscal_year}/{fiscal_period} | Lookup Fundamental by Company
 [**search_companies**](CompanyApi.md#search_companies) | **GET** /companies/search | Search Companies
+[**shares_outstanding_by_company**](CompanyApi.md#shares_outstanding_by_company) | **GET** /companies/{identifier}/shares_outstanding | Shares Outstanding by Company
 
 
 
@@ -1321,3 +1322,80 @@ Name | Type | Description  | Notes
 
 [//]: # (END_OPERATION)
 
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::CompanyApi)
+
+[//]: # (METHOD:shares_outstanding_by_company)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseCompanySharesOutstanding)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseCompanySharesOutstanding.md)
+
+[//]: # (OPERATION:shares_outstanding_by_company_v2)
+
+[//]: # (ENDPOINT:/companies/{identifier}/shares_outstanding)
+
+[//]: # (DOCUMENT_LINK:CompanyApi.md#shares_outstanding_by_company)
+
+## **shares_outstanding_by_company**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/shares_outstanding_by_company_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseCompanySharesOutstanding shares_outstanding_by_company(identifier)
+
+#### Shares Outstanding by Company
+
+
+Returns shares outstanding for the Company with the given `identifier`
+
+[//]: # (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
+
+company_api = Intrinio::CompanyApi.new
+identifier = "AAPL"
+
+result = company_api.shares_outstanding_by_company(identifier)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseCompanySharesOutstanding**](ApiResponseCompanySharesOutstanding.md)
+
+[//]: # (END_OPERATION)
+

data/docs/CompanySharesOutstanding.md

@@ -0,0 +1,25 @@
+
+
+[//]: # (CLASS:Intrinio::CompanySharesOutstanding)
+
+[//]: # (KIND:object)
+
+### Intrinio::CompanySharesOutstanding
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**xbrl_axis** | String | The xbrl concept axis member reported to the SEC.  
+**xbrl_member** | String | Provides information about the class of stock as reported in XBRL  
+**title_of_security** | String | The description of the security type  
+**trading_symbol** | String | The symbol under which the security is traded in the exchange  
+**security_exchange_name** | String | The name of the secuirty exchange  
+**shares_outstanding** | Float | The amount of stock currently held by all shareholders  
+
+[//]: # (END_DEFINITION)
+
+
+

data/docs/OptionContractsList.md

@@ -0,0 +1,20 @@
+
+
+[//]: # (CLASS:Intrinio::OptionContractsList)
+
+[//]: # (KIND:object)
+
+### Intrinio::OptionContractsList
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**contracts** | Array<String> |   
+
+[//]: # (END_DEFINITION)
+
+
+

data/docs/OptionPriceBatchRealtime.md

@@ -0,0 +1,27 @@
+
+
+[//]: # (CLASS:Intrinio::OptionPriceBatchRealtime)
+
+[//]: # (KIND:object)
+
+### Intrinio::OptionPriceBatchRealtime
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**option** | [**OptionRealtime**](OptionRealtime.md) |   
+**price** | [**OptionPriceRealtime**](OptionPriceRealtime.md) |   
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::OptionRealtime)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::OptionPriceRealtime)
+
+
+

data/docs/OptionsApi.md

@@ -11,6 +11,7 @@ Method | HTTP request | Description
 [**get_options_chain_realtime**](OptionsApi.md#get_options_chain_realtime) | **GET** /options/chain/{symbol}/{expiration}/realtime | Options Chain Realtime
 [**get_options_expirations**](OptionsApi.md#get_options_expirations) | **GET** /options/expirations/{symbol} | Options Expirations
 [**get_options_prices**](OptionsApi.md#get_options_prices) | **GET** /options/prices/{identifier} | Option Prices
+[**get_options_prices_batch_realtime**](OptionsApi.md#get_options_prices_batch_realtime) | **POST** /options/prices/realtime/batch | Option Prices Batch Realtime
 [**get_options_prices_realtime**](OptionsApi.md#get_options_prices_realtime) | **GET** /options/prices/{identifier}/realtime | Option Prices Realtime
 [**get_options_stats_realtime**](OptionsApi.md#get_options_stats_realtime) | **GET** /options/prices/{identifier}/realtime/stats | Option Stats Realtime
 
@@ -666,6 +667,94 @@ Name | Type | Description  | Notes
 [//]: # (END_OPERATION)
 
 
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::OptionsApi)
+
+[//]: # (METHOD:get_options_prices_batch_realtime)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseOptionsPricesBatchRealtime)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseOptionsPricesBatchRealtime.md)
+
+[//]: # (OPERATION:get_options_prices_batch_realtime_v2)
+
+[//]: # (ENDPOINT:/options/prices/realtime/batch)
+
+[//]: # (DOCUMENT_LINK:OptionsApi.md#get_options_prices_batch_realtime)
+
+## **get_options_prices_batch_realtime**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_options_prices_batch_realtime_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseOptionsPricesBatchRealtime get_options_prices_batch_realtime(body, opts)
+
+#### Option Prices Batch Realtime
+
+
+Returns options prices for a supplied list of option symbols.
+
+[//]: # (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
+
+options_api = Intrinio::OptionsApi.new
+body = {
+  contracts: [
+    "A220121P00055000",
+    "A220121P00057500",
+    "A220121P00060000"
+  ]
+}
+
+opts = {
+  source: nil
+}
+
+result = options_api.get_options_prices_batch_realtime(body, opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**OptionContractsList**](OptionContractsList.md)| The contract symbols for which to return options prices for. |   
+ **source** | String| Realtime or 15-minute delayed contracts. | [optional]   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseOptionsPricesBatchRealtime**](ApiResponseOptionsPricesBatchRealtime.md)
+
+[//]: # (END_OPERATION)
+
+
 [//]: # (START_OPERATION)
 
 [//]: # (CLASS:Intrinio::OptionsApi)

data/docs/RealtimeStockPrice.md

@@ -20,7 +20,7 @@ Name | Type | Description
 **ask_price** | Float | The price of the top ask order.  
 **ask_size** | Float | The size of the top ask order.  
 **open_price** | Float | The price at the open of the trading day.  
-**close_price** | Float | The price at the close of the trading day.  
+**close_price** | Float | The price at the close of the trading day. (IEX only)  
 **high_price** | Float | The high price for the trading day.  
 **low_price** | Float | The low price for the trading day.  
 **exchange_volume** | Float | The number of shares exchanged during the trading day on the exchange.  

data/intrinio-sdk.gemspec

@@ -5,7 +5,7 @@
 
 #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://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.20.0
+OpenAPI spec version: 2.21.1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset

data/lib/intrinio-sdk.rb

@@ -3,7 +3,7 @@
 
 #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://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.20.0
+OpenAPI spec version: 2.21.1
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 Swagger Codegen version: unset
@@ -27,6 +27,7 @@ require 'intrinio-sdk/models/api_response_company_historical_data'
 require 'intrinio-sdk/models/api_response_company_insider_transaction_filings'
 require 'intrinio-sdk/models/api_response_company_news'
 require 'intrinio-sdk/models/api_response_company_securities'
+require 'intrinio-sdk/models/api_response_company_shares_outstanding'
 require 'intrinio-sdk/models/api_response_data_tags'
 require 'intrinio-sdk/models/api_response_data_tags_search'
 require 'intrinio-sdk/models/api_response_etf_holdings'
@@ -53,6 +54,7 @@ require 'intrinio-sdk/models/api_response_options_chain'
 require 'intrinio-sdk/models/api_response_options_chain_realtime'
 require 'intrinio-sdk/models/api_response_options_expirations'
 require 'intrinio-sdk/models/api_response_options_price_realtime'
+require 'intrinio-sdk/models/api_response_options_prices_batch_realtime'
 require 'intrinio-sdk/models/api_response_options_realtime'
 require 'intrinio-sdk/models/api_response_options_stats_realtime'
 require 'intrinio-sdk/models/api_response_owner_insider_transaction_filings'
@@ -139,6 +141,7 @@ require 'intrinio-sdk/models/company_filing'
 require 'intrinio-sdk/models/company_initial_public_offering'
 require 'intrinio-sdk/models/company_news'
 require 'intrinio-sdk/models/company_news_summary'
+require 'intrinio-sdk/models/company_shares_outstanding'
 require 'intrinio-sdk/models/company_summary'
 require 'intrinio-sdk/models/data_tag'
 require 'intrinio-sdk/models/data_tag_summary'
@@ -185,8 +188,10 @@ require 'intrinio-sdk/models/on_balance_volume_technical_value'
 require 'intrinio-sdk/models/option'
 require 'intrinio-sdk/models/option_chain'
 require 'intrinio-sdk/models/option_chain_realtime'
+require 'intrinio-sdk/models/option_contracts_list'
 require 'intrinio-sdk/models/option_factors_realtime'
 require 'intrinio-sdk/models/option_price'
+require 'intrinio-sdk/models/option_price_batch_realtime'
 require 'intrinio-sdk/models/option_price_realtime'
 require 'intrinio-sdk/models/option_realtime'
 require 'intrinio-sdk/models/option_stats_realtime'