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
alexread730 committed Aug 4, 2021
1 parent c13ee47 commit 51c74ef
Show file tree
Hide file tree
Showing 532 changed files with 2,144 additions and 1,133 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@ intrinio-sdk - the Ruby gem for the Intrinio API

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://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.
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.

This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 2.23.0
- Package version: 5.13.2
- API version: 2.25.0
- Package version: 5.14.0


## Installation
Expand Down Expand Up @@ -93,6 +93,7 @@ Class | Method | HTTP request | Description
*Intrinio::ETFsApi* | [**search_etfs**](docs/ETFsApi.md#search_etfs) | **GET** /etfs/search | Search ETFs
*Intrinio::FilingApi* | [**get_all_filings**](docs/FilingApi.md#get_all_filings) | **GET** /filings | All Filings
*Intrinio::FilingApi* | [**get_all_notes**](docs/FilingApi.md#get_all_notes) | **GET** /filings/notes | All Filing Notes
*Intrinio::FilingApi* | [**get_filing_answers**](docs/FilingApi.md#get_filing_answers) | **GET** /filings/{identifier}/answers | Filing Answers
*Intrinio::FilingApi* | [**get_filing_by_id**](docs/FilingApi.md#get_filing_by_id) | **GET** /filings/{id} | Lookup Filing
*Intrinio::FilingApi* | [**get_filing_fundamentals**](docs/FilingApi.md#get_filing_fundamentals) | **GET** /filings/{identifier}/fundamentals | All Fundamentals by Filing
*Intrinio::FilingApi* | [**get_filing_html**](docs/FilingApi.md#get_filing_html) | **GET** /filings/{identifier}/html | Filing Html
Expand Down Expand Up @@ -142,6 +143,7 @@ Class | Method | HTTP request | Description
*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::OptionsApi* | [**get_unusual_activity**](docs/OptionsApi.md#get_unusual_activity) | **GET** /options/unusual_activity/{symbol} | Options Unusual Activity
*Intrinio::OwnersApi* | [**get_all_owners**](docs/OwnersApi.md#get_all_owners) | **GET** /owners | All Owners
*Intrinio::OwnersApi* | [**get_owner_by_id**](docs/OwnersApi.md#get_owner_by_id) | **GET** /owners/{identifier} | Owner by ID
*Intrinio::OwnersApi* | [**insider_transaction_filings_by_owner**](docs/OwnersApi.md#insider_transaction_filings_by_owner) | **GET** /owners/{identifier}/insider_transaction_filings | Insider Transaction Filings by Owner
Expand Down Expand Up @@ -269,6 +271,7 @@ Class | Method | HTTP request | Description
- [Intrinio::ApiResponseEconomicIndexHistoricalData](docs/ApiResponseEconomicIndexHistoricalData.md)
- [Intrinio::ApiResponseEconomicIndices](docs/ApiResponseEconomicIndices.md)
- [Intrinio::ApiResponseEconomicIndicesSearch](docs/ApiResponseEconomicIndicesSearch.md)
- [Intrinio::ApiResponseFilingAnswers](docs/ApiResponseFilingAnswers.md)
- [Intrinio::ApiResponseFilingFundamentals](docs/ApiResponseFilingFundamentals.md)
- [Intrinio::ApiResponseFilingNotes](docs/ApiResponseFilingNotes.md)
- [Intrinio::ApiResponseFilingNotesSearch](docs/ApiResponseFilingNotesSearch.md)
Expand All @@ -292,6 +295,7 @@ Class | Method | HTTP request | Description
- [Intrinio::ApiResponseOptionsRealtime](docs/ApiResponseOptionsRealtime.md)
- [Intrinio::ApiResponseOptionsStatsRealtime](docs/ApiResponseOptionsStatsRealtime.md)
- [Intrinio::ApiResponseOptionsTickers](docs/ApiResponseOptionsTickers.md)
- [Intrinio::ApiResponseOptionsUnusualActivity](docs/ApiResponseOptionsUnusualActivity.md)
- [Intrinio::ApiResponseOwnerInsiderTransactionFilings](docs/ApiResponseOwnerInsiderTransactionFilings.md)
- [Intrinio::ApiResponseOwnerInstitutionalHoldings](docs/ApiResponseOwnerInstitutionalHoldings.md)
- [Intrinio::ApiResponseOwners](docs/ApiResponseOwners.md)
Expand Down Expand Up @@ -430,6 +434,7 @@ Class | Method | HTTP request | Description
- [Intrinio::OptionPriceRealtime](docs/OptionPriceRealtime.md)
- [Intrinio::OptionRealtime](docs/OptionRealtime.md)
- [Intrinio::OptionStatsRealtime](docs/OptionStatsRealtime.md)
- [Intrinio::OptionUnusualTrade](docs/OptionUnusualTrade.md)
- [Intrinio::Owner](docs/Owner.md)
- [Intrinio::OwnerSummary](docs/OwnerSummary.md)
- [Intrinio::RealtimeStockPrice](docs/RealtimeStockPrice.md)
Expand Down Expand Up @@ -459,7 +464,6 @@ Class | Method | HTTP request | Description
- [Intrinio::TechnicalIndicator](docs/TechnicalIndicator.md)
- [Intrinio::TheaEntityAnswer](docs/TheaEntityAnswer.md)
- [Intrinio::TheaSourceDocument](docs/TheaSourceDocument.md)
- [Intrinio::TheaSourceDocumentTags](docs/TheaSourceDocumentTags.md)
- [Intrinio::TripleExponentialAverageTechnicalValue](docs/TripleExponentialAverageTechnicalValue.md)
- [Intrinio::TrueStrengthIndexTechnicalValue](docs/TrueStrengthIndexTechnicalValue.md)
- [Intrinio::UltimateOscillatorTechnicalValue](docs/UltimateOscillatorTechnicalValue.md)
Expand Down
29 changes: 29 additions & 0 deletions docs/ApiResponseFilingAnswers.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@


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

[//]: # (KIND:object)

### Intrinio::ApiResponseFilingAnswers

#### Properties

[//]: # (START_DEFINITION)

Name | Type | Description
------------ | ------------- | -------------
**source** | String | The organziation the answer data was sourced from  
**query** | String | The query posed to the Thea API  
**answers** | [**Array<TheaEntityAnswer>**](TheaEntityAnswer.md) |  
**companies** | [**Array<Filing>**](Filing.md) |  

[//]: # (END_DEFINITION)


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


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



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


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

[//]: # (KIND:object)

### Intrinio::ApiResponseOptionsUnusualActivity

#### Properties

[//]: # (START_DEFINITION)

Name | Type | Description
------------ | ------------- | -------------
**trades** | [**Array<OptionUnusualTrade>**](OptionUnusualTrade.md) | A list of unusual trades for a given company identifier  

[//]: # (END_DEFINITION)


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



2 changes: 2 additions & 0 deletions docs/CompanyApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -574,6 +574,7 @@ opts = {
report_type: nil,
start_date: Date.parse("2015-01-01"),
end_date: nil,
thea_enabled: nil,
page_size: 100,
next_page: nil
}
Expand All @@ -597,6 +598,7 @@ Name | Type | Description | Notes
**report_type** | String| Filter by <a href=\"https://docs.intrinio.com/documentation/sec_filing_report_types\" target=\"_blank\">report type</a>. Separate values with commas to return multiple report types. | [optional]  
**start_date** | Date| Filed on or after the given date | [optional]  
**end_date** | Date| Filed before or after the given date | [optional]  
**thea_enabled** | BOOLEAN| Return filings that have been read by our Thea NLP and are ready for our answers endpoint | [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]  

Expand Down
81 changes: 81 additions & 0 deletions docs/FilingApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Method | HTTP request | Description
------------- | ------------- | -------------
[**get_all_filings**](FilingApi.md#get_all_filings) | **GET** /filings | All Filings
[**get_all_notes**](FilingApi.md#get_all_notes) | **GET** /filings/notes | All Filing Notes
[**get_filing_answers**](FilingApi.md#get_filing_answers) | **GET** /filings/{identifier}/answers | Filing Answers
[**get_filing_by_id**](FilingApi.md#get_filing_by_id) | **GET** /filings/{id} | Lookup Filing
[**get_filing_fundamentals**](FilingApi.md#get_filing_fundamentals) | **GET** /filings/{identifier}/fundamentals | All Fundamentals by Filing
[**get_filing_html**](FilingApi.md#get_filing_html) | **GET** /filings/{identifier}/html | Filing Html
Expand Down Expand Up @@ -74,6 +75,7 @@ opts = {
end_date: nil,
industry_category: nil,
industry_group: nil,
thea_enabled: nil,
page_size: 100,
next_page: nil
}
Expand All @@ -99,6 +101,7 @@ Name | Type | Description | Notes
**end_date** | Date| Filed before or after the given date | [optional]  
**industry_category** | String| Return companies in the given industry category | [optional]  
**industry_group** | String| Return companies in the given industry group | [optional]  
**thea_enabled** | BOOLEAN| Return filings that have been read by our Thea NLP and are ready for our answers endpoint | [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]  

Expand Down Expand Up @@ -205,6 +208,84 @@ Name | Type | Description | Notes
[//]: # (END_OPERATION)


[//]: # (START_OPERATION)

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

[//]: # (METHOD:get_filing_answers)

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

[//]: # (RETURN_TYPE_KIND:object)

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

[//]: # (OPERATION:get_filing_answers_v2)

[//]: # (ENDPOINT:/filings/{identifier}/answers)

[//]: # (DOCUMENT_LINK:FilingApi.md#get_filing_answers)

## **get_filing_answers**

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

[//]: # (START_OVERVIEW)

> ApiResponseFilingAnswers get_filing_answers(identifier, query)
#### Filing Answers



[//]: # (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

filing_api = Intrinio::FilingApi.new
identifier = "fil_B73xBG"
query = "What do they believe in?"

result = filing_api.get_filing_answers(identifier, query)
pp result
```

[//]: # (END_CODE_EXAMPLE)

[//]: # (START_DEFINITION)

### Parameters

[//]: # (START_PARAMETERS)


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**identifier** | String| A Filing identifier |  
**query** | String| The query to ask the Thea API |  

[//]: # (END_PARAMETERS)

### Return type

[**ApiResponseFilingAnswers**](ApiResponseFilingAnswers.md)

[//]: # (END_OPERATION)


[//]: # (START_OPERATION)

[//]: # (CLASS:Intrinio::FilingApi)
Expand Down
26 changes: 26 additions & 0 deletions docs/OptionUnusualTrade.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@


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

[//]: # (KIND:object)

### Intrinio::OptionUnusualTrade

#### Properties

[//]: # (START_DEFINITION)

Name | Type | Description
------------ | ------------- | -------------
**symbol** | String | The underlying option security symbol for the trade  
**timestamp** | Date | The UTC timestamp of order placement  
**type** | String | The type of unusual trade  
**total_value** | Float | The aggregated value of all option contract premiums included in the trade  
**contract_type** | String | The type of Option (put or call)  
**contract_expiration** | Date | The expiration date for the options contract  
**contract_strike** | Float | The strike price of the option contract  

[//]: # (END_DEFINITION)



83 changes: 83 additions & 0 deletions docs/OptionsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ Method | HTTP request | Description
[**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
[**get_unusual_activity**](OptionsApi.md#get_unusual_activity) | **GET** /options/unusual_activity/{symbol} | Options Unusual Activity



Expand Down Expand Up @@ -991,3 +992,85 @@ Name | Type | Description | Notes

[//]: # (END_OPERATION)


[//]: # (START_OPERATION)

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

[//]: # (METHOD:get_unusual_activity)

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

[//]: # (RETURN_TYPE_KIND:object)

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

[//]: # (OPERATION:get_unusual_activity_v2)

[//]: # (ENDPOINT:/options/unusual_activity/{symbol})

[//]: # (DOCUMENT_LINK:OptionsApi.md#get_unusual_activity)

## **get_unusual_activity**

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

[//]: # (START_OVERVIEW)

> ApiResponseOptionsUnusualActivity get_unusual_activity(symbol, opts)
#### Options Unusual Activity


Returns unusual trades for a 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

options_api = Intrinio::OptionsApi.new
symbol = "AAPL"

opts = {
source: nil
}

result = options_api.get_unusual_activity(symbol, opts)
pp result
```

[//]: # (END_CODE_EXAMPLE)

[//]: # (START_DEFINITION)

### Parameters

[//]: # (START_PARAMETERS)


Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**symbol** | String| The option symbol, corresponding to the underlying security. |  
**source** | String| Realtime or 15-minute delayed contracts. | [optional]  

[//]: # (END_PARAMETERS)

### Return type

[**ApiResponseOptionsUnusualActivity**](ApiResponseOptionsUnusualActivity.md)

[//]: # (END_OPERATION)

2 changes: 1 addition & 1 deletion docs/TheaEntityAnswer.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Name | Type | Description
------------ | ------------- | -------------
**answer** | String | The summarized answer returned from Thea  
**content** | String | The underlying content the answer was sourced from  
**source_documents** | [**Array<TheaSourceDocument>**](TheaSourceDocument.md) |  
**source_documents** | [**Array<TheaSourceDocument>**](TheaSourceDocument.md) | The documents from which Thea answer data is sourced  

[//]: # (END_DEFINITION)

Expand Down
5 changes: 1 addition & 4 deletions docs/TheaSourceDocument.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,9 @@
Name | Type | Description
------------ | ------------- | -------------
**id** | String | The unique id for the Thea source document  
**tags** | [**Array<TheaSourceDocumentTags>**](TheaSourceDocumentTags.md) | Entity identifying tags associated with the source document  
**tags** | Array<Object> | Entity identifying tags associated with the source document  

[//]: # (END_DEFINITION)


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



Loading

0 comments on commit 51c74ef

Please sign in to comment.