intrinio-sdk 5.8.0 → 5.9.0

data/docs/InsiderTransaction.md

@@ -0,0 +1,44 @@
+
+
+[//]: # (CLASS:Intrinio::InsiderTransaction)
+
+[//]: # (KIND:object)
+
+### Intrinio::InsiderTransaction
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**director** | BOOLEAN | (true/false) A boolean indicating whether or not the owner is a director in the company  
+**officer** | BOOLEAN | (true/false) A boolean indicating whether or not the owner is a officer in the company  
+**ten_percent_owner** | BOOLEAN | (true/false) A boolean indicating whether or not the owner has a ten percent or greater interest in the company  
+**other_relation** | BOOLEAN | (true/false) A boolean indicating whether or not the owner has another relationship with the company beside, direct, officer, or significant owner in the company  
+**officer_title** | String | The officer title of the owner in the company  
+**derivative_transaction** | BOOLEAN | (true) A boolean indicating the transaction is a derivative transaction, which may or may not become common stock due to various possible exercise or conversion requirements  
+**ticker** | String | The ticker symbol for the company’s common stock  
+**security_title** | String | The name of the derivative security transacted  
+**conversion_exercise_price** | Float | The conversion or exercise price of the derivative security transacted  
+**transaction_type_code** | String | A symbol representing the transaction type; P = Purchase | S = Sale | A  = Award | M = Conversion to Common | C = Conversion | X = Exercise of Derivative More Transaction Codes  
+**acquisition_disposition_code** | String | A symbol representing whether or not the derivative securities are Acquired or Disposed; A = Acquisition | D = Disposition  
+**amount_of_shares** | Float | The number of derivative securities involved in the subject transaction  
+**underlying_security_title** | String | The name of the underlying non-derivative security related to this derivative transaction  
+**underlying_shares** | Float | The number of non-derivative shares involved in the subject transaction  
+**transaction_price** | Float | The price of the derivative securities  
+**total_shares_owned** | Float | The total number of derivative securities owned following the subject transaction  
+**ownership_type_code** | String | A symbol representing the ownership of the securities transacted; D = Direct Ownership | I = Indirect Ownership  
+**company** | [**CompanySummary**](CompanySummary.md) | The company associated with the filing  
+**owner** | [**OwnerSummary**](OwnerSummary.md) | The owner associated with the filing  
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::CompanySummary)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::OwnerSummary)
+
+
+

data/docs/InsiderTransactionFiling.md

@@ -0,0 +1,32 @@
+
+
+[//]: # (CLASS:Intrinio::InsiderTransactionFiling)
+
+[//]: # (KIND:object)
+
+### Intrinio::InsiderTransactionFiling
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**filing_url** | String | The URL of the filing with the SEC  
+**transactions** | [**Array<InsiderTransaction>**](InsiderTransaction.md) | The insider transactions associated with the filing  
+**company** | [**CompanySummary**](CompanySummary.md) | The company associated with the filing  
+**owner** | [**OwnerSummary**](OwnerSummary.md) | The owner associated with the filing  
+
+[//]: # (END_DEFINITION)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::InsiderTransaction)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::CompanySummary)
+
+
+[//]: # (CONTAINED_CLASS:Intrinio::OwnerSummary)
+
+
+

data/docs/InsiderTransactionFilingsApi.md

@@ -0,0 +1,95 @@
+# Intrinio::InsiderTransactionFilingsApi
+
+All URIs are relative to *https://api-v2.intrinio.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_all_insider_transaction_filings**](InsiderTransactionFilingsApi.md#get_all_insider_transaction_filings) | **GET** /insider_transaction_filings | All Insider Transactions Filings
+
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::InsiderTransactionFilingsApi)
+
+[//]: # (METHOD:get_all_insider_transaction_filings)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseOwnerInsiderTransactionFilings)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseOwnerInsiderTransactionFilings.md)
+
+[//]: # (OPERATION:get_all_insider_transaction_filings_v2)
+
+[//]: # (ENDPOINT:/insider_transaction_filings)
+
+[//]: # (DOCUMENT_LINK:InsiderTransactionFilingsApi.md#get_all_insider_transaction_filings)
+
+## **get_all_insider_transaction_filings**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_all_insider_transaction_filings_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseOwnerInsiderTransactionFilings get_all_insider_transaction_filings(opts)
+
+#### All Insider Transactions Filings
+
+
+Returns all insider transactions filings fitting the optional supplied start and end date.
+
+[//]: # (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
+
+insiderTransactionFilings_api = Intrinio::InsiderTransactionFilingsApi.new
+
+opts = {
+  start_date: Date.parse("2015-01-01"),
+  end_date: nil,
+  page_size: 100,
+  next_page: nil
+}
+
+result = insiderTransactionFilings_api.get_all_insider_transaction_filings(opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **start_date** | Date| Filed on or after the given date | [optional]   
+ **end_date** | Date| Filed before or after the given 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
+
+[**ApiResponseOwnerInsiderTransactionFilings**](ApiResponseOwnerInsiderTransactionFilings.md)
+
+[//]: # (END_OPERATION)
+

data/docs/InstitutionalHolding.md

@@ -0,0 +1,34 @@
+
+
+[//]: # (CLASS:Intrinio::InstitutionalHolding)
+
+[//]: # (KIND:object)
+
+### Intrinio::InstitutionalHolding
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**cusip** | String | The CUSIP number for the security report by the Institutional Owner  
+**ticker** | String | The ticker symbol for the security  
+**security_name** | String | The name of the security  
+**security_type** | String | The type of the security  
+**title_of_class** | String | The class of stock held  
+**stock_exchange** | String | The stock exchange where the security is traded  
+**filing_date** | Date | The date when the filing was submitted to the SEC by the company  
+**value** | Float | The market value in amount of dollars of the holding in the listed security  
+**amount** | Float | The number of shares held in the listed security  
+**type** | String | Shares  
+**investment_discretion** | String | Segregate the holdings of securities of a class according to the nature of the investment discretion held by the Manager.  
+**other_manager** | String | A code for other managerial authority of the securities listed  
+**sole_voting_authority** | Float | The number of shares where the insitutional holder has sole voting authority  
+**shared_voting_authority** | Float | The number of shares where the insitutional holder has shared voting authority  
+**no_voting_authority** | Float | The number of shares where the insitutional holder has no voting authority  
+
+[//]: # (END_DEFINITION)
+
+
+

data/docs/InstitutionalOwnership.md

@@ -0,0 +1,29 @@
+
+
+[//]: # (CLASS:Intrinio::InstitutionalOwnership)
+
+[//]: # (KIND:object)
+
+### Intrinio::InstitutionalOwnership
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**owner_cik** | String | The Central Index Key issued by the SEC, which is the unique identifier all owner filings  
+**owner_name** | String | The name of the institutional owner  
+**value** | Float | The market value in amount of dollars of the holding in the listed security  
+**amount** | Float | The number of shares held in the listed security  
+**sole_voting_authority** | Float | The number of shares where the insitutional holder has sole voting authority  
+**shared_voting_authority** | Float | The number of shares where the insitutional holder has shared voting authority  
+**no_voting_authority** | Float | The number of shares where the insitutional holder has no voting authority  
+**previous_amount** | Float | The prior quarter number of shares held by the owner  
+**amount_change** | Float | The change in number of shares held from the prior quarter  
+**amount_percent_change** | Float | The percentage change in the number of shares held from the prior quarter  
+
+[//]: # (END_DEFINITION)
+
+
+

data/docs/Owner.md

@@ -0,0 +1,32 @@
+
+
+[//]: # (CLASS:Intrinio::Owner)
+
+[//]: # (KIND:object)
+
+### Intrinio::Owner
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**id** | String | The Intrinio ID for the Owner  
+**company_id** | String | The Intrinio ID for the company for which the Security is issued  
+**owner_cik** | String | The Central Index Key issued by the SEC, which is the unique identifier all owner filings  
+**name** | String | The name of the owner  
+**state** | String | The state in which the owner is located  
+**state_inc** | String | The state in which the owner is incorporated  
+**country_inc** | String | The country in which the owner is incorporated  
+**business_address** | String | The owner's business address  
+**business_phone_no** | String | The owner's business phone number  
+**mailing_address** | String | The owner's mailing address  
+**institutional** | BOOLEAN | A boolean to include only insider owners who have filed forms 3, 4, or 5 with the SEC  
+**updated_on** | DateTime | The date and time when the data was last updated.  
+**created_on** | DateTime | The date and time when the data was created  
+
+[//]: # (END_DEFINITION)
+
+
+

data/docs/OwnerSummary.md

@@ -0,0 +1,21 @@
+
+
+[//]: # (CLASS:Intrinio::OwnerSummary)
+
+[//]: # (KIND:object)
+
+### Intrinio::OwnerSummary
+
+#### Properties
+
+[//]: # (START_DEFINITION)
+
+Name | Type | Description
+------------ | ------------- | -------------
+**owner_cik** | String | The Central Index Key issued by the SEC, which is the unique identifier all owner filings  
+**owner_name** | String | The name of the owner  
+
+[//]: # (END_DEFINITION)
+
+
+

data/docs/OwnersApi.md

@@ -0,0 +1,434 @@
+# Intrinio::OwnersApi
+
+All URIs are relative to *https://api-v2.intrinio.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_all_owners**](OwnersApi.md#get_all_owners) | **GET** /owners | All Owners
+[**get_owner_by_id**](OwnersApi.md#get_owner_by_id) | **GET** /owners/{identifier} | Owner by ID
+[**insider_transaction_filings_by_owner**](OwnersApi.md#insider_transaction_filings_by_owner) | **GET** /owners/{identifier}/insider_transaction_filings | Insider Transaction Filings by Owner
+[**institutional_holdings_by_owner**](OwnersApi.md#institutional_holdings_by_owner) | **GET** /owners/{identifier}/institutional_holdings | Institutional Holdings by Owner
+[**search_owners**](OwnersApi.md#search_owners) | **GET** /owners/search | Search Owners
+
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::OwnersApi)
+
+[//]: # (METHOD:get_all_owners)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseOwners)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseOwners.md)
+
+[//]: # (OPERATION:get_all_owners_v2)
+
+[//]: # (ENDPOINT:/owners)
+
+[//]: # (DOCUMENT_LINK:OwnersApi.md#get_all_owners)
+
+## **get_all_owners**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_all_owners_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseOwners get_all_owners(opts)
+
+#### All Owners
+
+
+Returns all owners and information for all insider and institutional owners of securities covered by Intrinio.
+
+[//]: # (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
+
+owners_api = Intrinio::OwnersApi.new
+
+opts = {
+  institutional: nil,
+  page_size: 100,
+  next_page: nil
+}
+
+result = owners_api.get_all_owners(opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **institutional** | BOOLEAN| Returns insider owners who have filed forms 3, 4, or 5 with the SEC only. Possible values are true, false, or omit for both. | [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
+
+[**ApiResponseOwners**](ApiResponseOwners.md)
+
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::OwnersApi)
+
+[//]: # (METHOD:get_owner_by_id)
+
+[//]: # (RETURN_TYPE:Intrinio::Owner)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:Owner.md)
+
+[//]: # (OPERATION:get_owner_by_id_v2)
+
+[//]: # (ENDPOINT:/owners/{identifier})
+
+[//]: # (DOCUMENT_LINK:OwnersApi.md#get_owner_by_id)
+
+## **get_owner_by_id**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_owner_by_id_v2)
+
+[//]: # (START_OVERVIEW)
+
+> Owner get_owner_by_id(identifier)
+
+#### Owner by ID
+
+
+Returns the Owner with the given ID
+
+[//]: # (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
+
+owners_api = Intrinio::OwnersApi.new
+identifier = "0000001800"
+
+result = owners_api.get_owner_by_id(identifier)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | String| An Intrinio ID or CIK of an Owner |   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**Owner**](Owner.md)
+
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::OwnersApi)
+
+[//]: # (METHOD:insider_transaction_filings_by_owner)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseOwnerInsiderTransactionFilings)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseOwnerInsiderTransactionFilings.md)
+
+[//]: # (OPERATION:insider_transaction_filings_by_owner_v2)
+
+[//]: # (ENDPOINT:/owners/{identifier}/insider_transaction_filings)
+
+[//]: # (DOCUMENT_LINK:OwnersApi.md#insider_transaction_filings_by_owner)
+
+## **insider_transaction_filings_by_owner**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/insider_transaction_filings_by_owner_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseOwnerInsiderTransactionFilings insider_transaction_filings_by_owner(identifier, opts)
+
+#### Insider Transaction Filings by Owner
+
+
+Returns a list of all insider transaction filings by an owner in as many companies as the owner may be considered an insider. Criteria for being an insider include being a director, officer, or 10%+ owner in the company. Transactions are detailed for both non-derivative and derivative transactions by the insider.
+
+[//]: # (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
+
+owners_api = Intrinio::OwnersApi.new
+identifier = "0001494730"
+
+opts = {
+  start_date: Date.parse("2018-01-01"),
+  end_date: Date.parse("2019-01-01"),
+  page_size: 100,
+  next_page: nil
+}
+
+result = owners_api.insider_transaction_filings_by_owner(identifier, opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | String| The Central Index Key issued by the SEC, which is the unique identifier all owner filings are issued under. |   
+ **start_date** | Date| Return Owner's insider transaction filings on or after this date | [optional]   
+ **end_date** | Date| Return Owner's insider transaction filings on or before this 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
+
+[**ApiResponseOwnerInsiderTransactionFilings**](ApiResponseOwnerInsiderTransactionFilings.md)
+
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::OwnersApi)
+
+[//]: # (METHOD:institutional_holdings_by_owner)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseOwnerInstitutionalHoldings)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseOwnerInstitutionalHoldings.md)
+
+[//]: # (OPERATION:institutional_holdings_by_owner_v2)
+
+[//]: # (ENDPOINT:/owners/{identifier}/institutional_holdings)
+
+[//]: # (DOCUMENT_LINK:OwnersApi.md#institutional_holdings_by_owner)
+
+## **institutional_holdings_by_owner**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/institutional_holdings_by_owner_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseOwnerInstitutionalHoldings institutional_holdings_by_owner(identifier, opts)
+
+#### Institutional Holdings by Owner
+
+
+Returns a list of all ownership interests and the value of their interests by a single institutional owner.
+
+[//]: # (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
+
+owners_api = Intrinio::OwnersApi.new
+identifier = 430692
+
+opts = {
+  page_size: 100,
+  as_of_date: "2021-01-05",
+  next_page: nil
+}
+
+result = owners_api.institutional_holdings_by_owner(identifier, opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | String| The Central Index Key issued by the SEC, which is the unique identifier all owner filings are issued under. |   
+ **page_size** | Integer| The number of results to return | [optional] [default to 100]  
+ **as_of_date** | [**Object**](.md)| Return only holdings filed before this date. | [optional]   
+ **next_page** | String| Gets the next page of data from a previous API call | [optional]   
+
+[//]: # (END_PARAMETERS)
+
+### Return type
+
+[**ApiResponseOwnerInstitutionalHoldings**](ApiResponseOwnerInstitutionalHoldings.md)
+
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::OwnersApi)
+
+[//]: # (METHOD:search_owners)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseOwners)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseOwners.md)
+
+[//]: # (OPERATION:search_owners_v2)
+
+[//]: # (ENDPOINT:/owners/search)
+
+[//]: # (DOCUMENT_LINK:OwnersApi.md#search_owners)
+
+## **search_owners**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/search_owners_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseOwners search_owners(query, opts)
+
+#### Search Owners
+
+
+Searches for Owners matching the text `query`
+
+[//]: # (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
+
+owners_api = Intrinio::OwnersApi.new
+query = "Cook"
+
+opts = {
+  institutional: nil,
+  page_size: 100,
+  next_page: nil
+}
+
+result = owners_api.search_owners(query, opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **query** | String|  |   
+ **institutional** | BOOLEAN| Returns insider owners who have filed forms 3, 4, or 5 with the SEC only. Possible values are true, false, or omit for both. | [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
+
+[**ApiResponseOwners**](ApiResponseOwners.md)
+
+[//]: # (END_OPERATION)
+