intrinio-sdk 5.6.3 → 5.9.1

data/docs/CompanyApi.md

@@ -15,6 +15,8 @@ Method | HTTP request | Description
 [**get_company_ipos**](CompanyApi.md#get_company_ipos) | **GET** /companies/ipos | IPOs
 [**get_company_news**](CompanyApi.md#get_company_news) | **GET** /companies/{identifier}/news | All News by Company
 [**get_company_securities**](CompanyApi.md#get_company_securities) | **GET** /companies/{identifier}/securities | All Securities by Company
+[**insider_transaction_filings_by_company**](CompanyApi.md#insider_transaction_filings_by_company) | **GET** /companies/{identifier}/insider_transaction_filings | Insider Transaction Filings by Company
+[**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
 
@@ -981,6 +983,186 @@ Name | Type | Description  | Notes
 [//]: # (END_OPERATION)
 
 
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::CompanyApi)
+
+[//]: # (METHOD:insider_transaction_filings_by_company)
+
+[//]: # (RETURN_TYPE:Intrinio::ApiResponseInsiderTransactionFilings)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:ApiResponseInsiderTransactionFilings.md)
+
+[//]: # (OPERATION:insider_transaction_filings_by_company_v2)
+
+[//]: # (ENDPOINT:/companies/{identifier}/insider_transaction_filings)
+
+[//]: # (DOCUMENT_LINK:CompanyApi.md#insider_transaction_filings_by_company)
+
+## **insider_transaction_filings_by_company**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/insider_transaction_filings_by_company_v2)
+
+[//]: # (START_OVERVIEW)
+
+> ApiResponseInsiderTransactionFilings insider_transaction_filings_by_company(identifier, opts)
+
+#### Insider Transaction Filings by Company
+
+
+Returns a list of all insider transaction filings in a company. 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
+
+company_api = Intrinio::CompanyApi.new
+identifier = "AAPL"
+
+opts = {
+  start_date: Date.parse("2018-01-01"),
+  end_date: Date.parse("2019-01-01"),
+  ownership_type: "D",
+  page_size: 100,
+  next_page: nil
+}
+
+result = company_api.insider_transaction_filings_by_company(identifier, opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |   
+ **start_date** | Date| Return Company's insider transaction filings on or after this date | [optional]   
+ **end_date** | Date| Return Company's insider transaction filings on or before this date | [optional]   
+ **ownership_type** | String| The type of ownership to return transaction filings for. 'D' is for direct transactions. 'I' is for indirect transactions. Omit for both types. | [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
+
+[**ApiResponseInsiderTransactionFilings**](ApiResponseInsiderTransactionFilings.md)
+
+[//]: # (END_OPERATION)
+
+
+[//]: # (START_OPERATION)
+
+[//]: # (CLASS:Intrinio::CompanyApi)
+
+[//]: # (METHOD:latest_insider_transaction_filing_by_company)
+
+[//]: # (RETURN_TYPE:Intrinio::InsiderTransactionFiling)
+
+[//]: # (RETURN_TYPE_KIND:object)
+
+[//]: # (RETURN_TYPE_DOC:InsiderTransactionFiling.md)
+
+[//]: # (OPERATION:latest_insider_transaction_filing_by_company_v2)
+
+[//]: # (ENDPOINT:/companies/{identifier}/insider_transaction_filings/latest)
+
+[//]: # (DOCUMENT_LINK:CompanyApi.md#latest_insider_transaction_filing_by_company)
+
+## **latest_insider_transaction_filing_by_company**
+
+[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/latest_insider_transaction_filing_by_company_v2)
+
+[//]: # (START_OVERVIEW)
+
+> InsiderTransactionFiling latest_insider_transaction_filing_by_company(identifier, opts)
+
+#### Latest Insider Transaction Filing by Company
+
+
+Returns the latest insider transaction filing for a company.
+
+[//]: # (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"
+
+opts = {
+  start_date: Date.parse("2018-01-01"),
+  end_date: Date.parse("2019-01-01"),
+  ownership_type: "D",
+  page_size: 100,
+  next_page: nil
+}
+
+result = company_api.latest_insider_transaction_filing_by_company(identifier, opts)
+pp result
+```
+
+[//]: # (END_CODE_EXAMPLE)
+
+[//]: # (START_DEFINITION)
+
+### Parameters
+
+[//]: # (START_PARAMETERS)
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) |   
+ **start_date** | Date| Return Company's insider transaction filings on or after this date | [optional]   
+ **end_date** | Date| Return Company's insider transaction filings on or before this date | [optional]   
+ **ownership_type** | String| The type of ownership to return transaction filings for. 'D' is for direct transactions. 'I' is for indirect transactions. Omit for both types. | [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
+
+[**InsiderTransactionFiling**](InsiderTransactionFiling.md)
+
+[//]: # (END_OPERATION)
+
+
 [//]: # (START_OPERATION)
 
 [//]: # (CLASS:Intrinio::CompanyApi)
@@ -1116,6 +1298,7 @@ company_api = Intrinio::CompanyApi.new
 query = "Apple"
 
 opts = {
+  active: true,
   page_size: 100
 }
 
@@ -1135,6 +1318,7 @@ pp result
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **query** | String| Search parameters |   
+ **active** | BOOLEAN| When true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded. | [optional]   
  **page_size** | Integer| The number of results to return | [optional] [default to 100]  
 
 [//]: # (END_PARAMETERS)

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)
+
+
+