docs/CompanyApi.md in intrinio-sdk-5.8.0 vs docs/CompanyApi.md in intrinio-sdk-5.9.0

- old
+ new

@@ -13,10 +13,12 @@ [**get_company_fundamentals**](CompanyApi.md#get_company_fundamentals) | **GET** /companies/{identifier}/fundamentals | All Fundamentals by Company [**get_company_historical_data**](CompanyApi.md#get_company_historical_data) | **GET** /companies/{identifier}/historical_data/{tag} | Historical Data for Company [**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 @@ -975,9 +977,189 @@ [//]: # (END_PARAMETERS) ### Return type [**ApiResponseCompanySecurities**](ApiResponseCompanySecurities.md) + +[//]: # (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)