Skip to content

Commit

Permalink
No release notes for this build
Browse files Browse the repository at this point in the history
  • Loading branch information
ssnyder-intrinio committed Nov 27, 2024
1 parent f79c96d commit 6044687
Show file tree
Hide file tree
Showing 672 changed files with 1,635 additions and 687 deletions.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.75.0
- Package version: 6.33.0
- API version: 2.76.3
- Package version: 6.34.0


## Installation
Expand Down Expand Up @@ -246,6 +246,7 @@ Class | Method | HTTP request | Description
*Intrinio::SecurityApi* | [**screen_securities**](docs/SecurityApi.md#screen_securities) | **POST** /securities/screen | Screen Securities
*Intrinio::SecurityApi* | [**search_securities**](docs/SecurityApi.md#search_securities) | **GET** /securities/search | Search Securities
*Intrinio::StockExchangeApi* | [**get_all_stock_exchanges**](docs/StockExchangeApi.md#get_all_stock_exchanges) | **GET** /stock_exchanges | All Stock Exchanges
*Intrinio::StockExchangeApi* | [**get_stock_exchange_betas**](docs/StockExchangeApi.md#get_stock_exchange_betas) | **GET** /stock_exchanges/{identifier}/betas | Security Betas
*Intrinio::StockExchangeApi* | [**get_stock_exchange_by_id**](docs/StockExchangeApi.md#get_stock_exchange_by_id) | **GET** /stock_exchanges/{identifier} | Lookup Stock Exchange
*Intrinio::StockExchangeApi* | [**get_stock_exchange_gainers**](docs/StockExchangeApi.md#get_stock_exchange_gainers) | **GET** /stock_exchanges/{identifier}/gainers | Top Gainers by Exchange
*Intrinio::StockExchangeApi* | [**get_stock_exchange_losers**](docs/StockExchangeApi.md#get_stock_exchange_losers) | **GET** /stock_exchanges/{identifier}/losers | Top Losers by Exchange
Expand Down Expand Up @@ -421,6 +422,7 @@ Class | Method | HTTP request | Description
- [Intrinio::ApiResponseSecurityZacksSalesSurprises](docs/ApiResponseSecurityZacksSalesSurprises.md)
- [Intrinio::ApiResponseStandardizedFinancials](docs/ApiResponseStandardizedFinancials.md)
- [Intrinio::ApiResponseStandardizedFinancialsDimensions](docs/ApiResponseStandardizedFinancialsDimensions.md)
- [Intrinio::ApiResponseStockExchangeBetas](docs/ApiResponseStockExchangeBetas.md)
- [Intrinio::ApiResponseStockExchangeMovers](docs/ApiResponseStockExchangeMovers.md)
- [Intrinio::ApiResponseStockExchangeQuote](docs/ApiResponseStockExchangeQuote.md)
- [Intrinio::ApiResponseStockExchangeRealtimeStockPrices](docs/ApiResponseStockExchangeRealtimeStockPrices.md)
Expand Down Expand Up @@ -449,6 +451,7 @@ Class | Method | HTTP request | Description
- [Intrinio::AverageDirectionalIndexTechnicalValue](docs/AverageDirectionalIndexTechnicalValue.md)
- [Intrinio::AverageTrueRangeTechnicalValue](docs/AverageTrueRangeTechnicalValue.md)
- [Intrinio::AwesomeOscillatorTechnicalValue](docs/AwesomeOscillatorTechnicalValue.md)
- [Intrinio::Beta](docs/Beta.md)
- [Intrinio::BollingerBandsTechnicalValue](docs/BollingerBandsTechnicalValue.md)
- [Intrinio::BulkDownloadLinks](docs/BulkDownloadLinks.md)
- [Intrinio::BulkDownloadSummary](docs/BulkDownloadSummary.md)
Expand Down
28 changes: 28 additions & 0 deletions docs/ApiResponseStockExchangeBetas.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@


[//]: # (CLASS:Intrinio::ApiResponseStockExchangeBetas)

[//]: # (KIND:object)

### Intrinio::ApiResponseStockExchangeBetas

#### Properties

[//]: # (START_DEFINITION)

Name | Type | Description
------------ | ------------- | -------------
**betas** | [**Array<Beta>**](Beta.md) | The mover security.  
**stock_exchange** | [**StockExchange**](StockExchange.md) | The Stock Exchange resolved from the given identifier  
**next_page** | String | The token required to request the next page of the data. If null, no further results are available.  

[//]: # (END_DEFINITION)


[//]: # (CONTAINED_CLASS:Intrinio::Beta)


[//]: # (CONTAINED_CLASS:Intrinio::StockExchange)



29 changes: 29 additions & 0 deletions docs/Beta.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@


[//]: # (CLASS:Intrinio::Beta)

[//]: # (KIND:object)

### Intrinio::Beta

#### Properties

[//]: # (START_DEFINITION)

Name | Type | Description
------------ | ------------- | -------------
**period_type** | String | Type of period for this beta value.  
**one_year_beta** | Float | The one year beta value for this security.  
**three_year_beta** | Float | The three year beta value for this security.  
**five_year_beta** | Float | The five year beta value for this security.  
**seven_year_beta** | Float | The seven year beta value for this security.  
**ten_year_beta** | Float | The ten year beta value for this security.  
**security** | [**SecuritySummary**](SecuritySummary.md) | The Security.  

[//]: # (END_DEFINITION)


[//]: # (CONTAINED_CLASS:Intrinio::SecuritySummary)



3 changes: 2 additions & 1 deletion docs/OptionInterval.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@ Name | Type | Description
**high** | Float | The highest traded contract price in this interval.  
**low** | Float | The lowest traded contract price in this interval.  
**close** | Float | The last traded contract price in this interval.  
**volume** | Float | The volume of contract trades in this interval.  
**volume** | Float | The volume of contracts traded in this interval.  
**average** | Float | The volume weighted average price of contract trades in this interval.  
**change** | Float | The ratio of Close minus Open to Open.  
**trade_count** | Float | The number of qualified trades executed during the period  

[//]: # (END_DEFINITION)

Expand Down
3 changes: 2 additions & 1 deletion docs/OptionIntervalMover.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,9 @@ Name | Type | Description
**high** | Float | The highest traded contract price in this interval.  
**low** | Float | The lowest traded contract price in this interval.  
**close** | Float | The last traded contract price in this interval.  
**volume** | Float | The volume of contract trades in this interval.  
**volume** | Float | The volume of contracts traded in this interval.  
**average** | Float | The volume weighted average price of contract trades in this interval.  
**trade_count** | Float | The number of contract trades executed in this interval  

[//]: # (END_DEFINITION)

Expand Down
14 changes: 11 additions & 3 deletions docs/OptionsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Method | HTTP request | Description

[//]: # (START_OVERVIEW)

> ApiResponseOptionsTickers get_all_options_tickers
> ApiResponseOptionsTickers get_all_options_tickers(opts)
#### Options Tickers

Expand All @@ -85,7 +85,12 @@ Intrinio.configure do |config|
end

options_api = Intrinio::OptionsApi.new
result = options_api.get_all_options_tickers

opts = {
use_underlying_symbols: false
}

result = options_api.get_all_options_tickers(opts)
pp result
```

Expand All @@ -97,7 +102,10 @@ pp result

[//]: # (START_PARAMETERS)

This endpoint does not need any parameter.

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**use_underlying_symbols** | BOOLEAN| Use underlying symbol vs contract symbol | [optional] [default to false]  

[//]: # (END_PARAMETERS)

Expand Down
3 changes: 2 additions & 1 deletion docs/SecurityIntervalMover.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,9 @@ Name | Type | Description
**high** | Float | The highest traded price in this interval.  
**low** | Float | The lowest traded price in this interval.  
**close** | Float | The last traded price in this interval.  
**volume** | Float | The volume of trades in this interval.  
**volume** | Float | The volume of shares in this interval.  
**average** | Float | The volume weighted average price of trades in this interval.  
**trade_count** | Float | The of trades in this interval.  

[//]: # (END_DEFINITION)

Expand Down
89 changes: 89 additions & 0 deletions docs/StockExchangeApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ All URIs are relative to *https://api-v2.intrinio.com*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get_all_stock_exchanges**](StockExchangeApi.md#get_all_stock_exchanges) | **GET** /stock_exchanges | All Stock Exchanges
[**get_stock_exchange_betas**](StockExchangeApi.md#get_stock_exchange_betas) | **GET** /stock_exchanges/{identifier}/betas | Security Betas
[**get_stock_exchange_by_id**](StockExchangeApi.md#get_stock_exchange_by_id) | **GET** /stock_exchanges/{identifier} | Lookup Stock Exchange
[**get_stock_exchange_gainers**](StockExchangeApi.md#get_stock_exchange_gainers) | **GET** /stock_exchanges/{identifier}/gainers | Top Gainers by Exchange
[**get_stock_exchange_losers**](StockExchangeApi.md#get_stock_exchange_losers) | **GET** /stock_exchanges/{identifier}/losers | Top Losers by Exchange
Expand Down Expand Up @@ -102,6 +103,94 @@ Name | Type | Description | Notes
[//]: # (END_OPERATION)


[//]: # (START_OPERATION)

[//]: # (CLASS:Intrinio::StockExchangeApi)

[//]: # (METHOD:get_stock_exchange_betas)

[//]: # (RETURN_TYPE:Intrinio::ApiResponseStockExchangeBetas)

[//]: # (RETURN_TYPE_KIND:object)

[//]: # (RETURN_TYPE_DOC:ApiResponseStockExchangeBetas.md)

[//]: # (OPERATION:get_stock_exchange_betas_v2)

[//]: # (ENDPOINT:/stock_exchanges/{identifier}/betas)

[//]: # (DOCUMENT_LINK:StockExchangeApi.md#get_stock_exchange_betas)

## **get_stock_exchange_betas**

[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_stock_exchange_betas_v2)

[//]: # (START_OVERVIEW)

> ApiResponseStockExchangeBetas get_stock_exchange_betas(identifier, opts)
#### Security Betas


Returns security beta data in the Stock Exchange 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

stockExchange_api = Intrinio::StockExchangeApi.new
identifier = "USCOMP"

opts = {
type: "weekly",
date: "2024-04-24",
page_size: 100,
next_page: nil
}

result = stockExchange_api.get_stock_exchange_betas(identifier, opts)
pp result
```

[//]: # (END_CODE_EXAMPLE)

[//]: # (START_DEFINITION)

### Parameters

[//]: # (START_PARAMETERS)


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**identifier** | String| A Stock Exchange identifier (MIC or Intrinio ID) |  
**type** | String| Only of the given type | [optional] [default to weekly]  
**date** | [**Object**](.md)| Return data for this period end date. | [optional]  
**page_size** | Integer| The number of results to return | [optional] [default to 100]  
**next_page** | String| Gets the next page of data from a previous API call | [optional]  

[//]: # (END_PARAMETERS)

### Return type

[**ApiResponseStockExchangeBetas**](ApiResponseStockExchangeBetas.md)

[//]: # (END_OPERATION)


[//]: # (START_OPERATION)

[//]: # (CLASS:Intrinio::StockExchangeApi)
Expand Down
1 change: 1 addition & 0 deletions docs/StockPriceInterval.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ Name | Type | Description
**ask_first_time** | DateTime | The timestamp that represents the first ask time from the interval span.  
**ask_last_time** | DateTime | The timestamp that represents the last ask time from the interval span.  
**ask_change_percent** | Float | The ratio of the close to open ask difference, in percent.  
**trade_count** | Float | The number of qualified trades executed during the period  

[//]: # (END_DEFINITION)

Expand Down
2 changes: 1 addition & 1 deletion intrinio-sdk.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -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://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
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: unset
Expand Down
4 changes: 3 additions & 1 deletion lib/intrinio-sdk.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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://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
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: unset
Expand Down Expand Up @@ -134,6 +134,7 @@
require 'intrinio-sdk/models/api_response_security_zacks_sales_surprises'
require 'intrinio-sdk/models/api_response_standardized_financials'
require 'intrinio-sdk/models/api_response_standardized_financials_dimensions'
require 'intrinio-sdk/models/api_response_stock_exchange_betas'
require 'intrinio-sdk/models/api_response_stock_exchange_movers'
require 'intrinio-sdk/models/api_response_stock_exchange_quote'
require 'intrinio-sdk/models/api_response_stock_exchange_realtime_stock_prices'
Expand Down Expand Up @@ -162,6 +163,7 @@
require 'intrinio-sdk/models/average_directional_index_technical_value'
require 'intrinio-sdk/models/average_true_range_technical_value'
require 'intrinio-sdk/models/awesome_oscillator_technical_value'
require 'intrinio-sdk/models/beta'
require 'intrinio-sdk/models/bollinger_bands_technical_value'
require 'intrinio-sdk/models/bulk_download_links'
require 'intrinio-sdk/models/bulk_download_summary'
Expand Down
2 changes: 1 addition & 1 deletion lib/intrinio-sdk/api/bulk_downloads_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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://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
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: unset
Expand Down
2 changes: 1 addition & 1 deletion lib/intrinio-sdk/api/company_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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://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
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: unset
Expand Down
2 changes: 1 addition & 1 deletion lib/intrinio-sdk/api/data_point_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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://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
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: unset
Expand Down
2 changes: 1 addition & 1 deletion lib/intrinio-sdk/api/data_tag_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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://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
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: unset
Expand Down
2 changes: 1 addition & 1 deletion lib/intrinio-sdk/api/esg_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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://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
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: unset
Expand Down
2 changes: 1 addition & 1 deletion lib/intrinio-sdk/api/et_fs_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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://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
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: unset
Expand Down
2 changes: 1 addition & 1 deletion lib/intrinio-sdk/api/filing_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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://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
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: unset
Expand Down
2 changes: 1 addition & 1 deletion lib/intrinio-sdk/api/forex_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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://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
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: unset
Expand Down
2 changes: 1 addition & 1 deletion lib/intrinio-sdk/api/fundamentals_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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://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
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: unset
Expand Down
2 changes: 1 addition & 1 deletion lib/intrinio-sdk/api/historical_data_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -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://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
Generated by: https://github.com/swagger-api/swagger-codegen.git
Swagger Codegen version: unset
Expand Down
Loading

0 comments on commit 6044687

Please sign in to comment.