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

- old
+ new

@@ -7,10 +7,11 @@ [**get_all_securities**](SecurityApi.md#get_all_securities) | **GET** /securities | All Securities [**get_security_by_id**](SecurityApi.md#get_security_by_id) | **GET** /securities/{identifier} | Lookup Security [**get_security_data_point_number**](SecurityApi.md#get_security_data_point_number) | **GET** /securities/{identifier}/data_point/{tag}/number | Data Point (Number) for Security [**get_security_data_point_text**](SecurityApi.md#get_security_data_point_text) | **GET** /securities/{identifier}/data_point/{tag}/text | Data Point (Text) for Security [**get_security_historical_data**](SecurityApi.md#get_security_historical_data) | **GET** /securities/{identifier}/historical_data/{tag} | Historical Data for Security +[**get_security_insider_ownership**](SecurityApi.md#get_security_insider_ownership) | **GET** /securities/{identifier}/institutional_ownership | Institutional Ownership by Security [**get_security_interval_prices**](SecurityApi.md#get_security_interval_prices) | **GET** /securities/{identifier}/prices/intervals | Interval Stock Prices for Security [**get_security_intraday_prices**](SecurityApi.md#get_security_intraday_prices) | **GET** /securities/{identifier}/prices/intraday | Intraday Stock Prices for Security [**get_security_latest_dividend_record**](SecurityApi.md#get_security_latest_dividend_record) | **GET** /securities/{identifier}/dividends/latest | Latest Dividend Record for Security [**get_security_latest_earnings_record**](SecurityApi.md#get_security_latest_earnings_record) | **GET** /securities/{identifier}/earnings/latest | Latest Earnings Record for Security [**get_security_price_technicals_adi**](SecurityApi.md#get_security_price_technicals_adi) | **GET** /securities/{identifier}/prices/technicals/adi | Accumulation/Distribution Index @@ -497,9 +498,86 @@ [//]: # (END_PARAMETERS) ### Return type [**ApiResponseSecurityHistoricalData**](ApiResponseSecurityHistoricalData.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::SecurityApi) + +[//]: # (METHOD:get_security_insider_ownership) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseSecurityInstitutionalOwnership) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseSecurityInstitutionalOwnership.md) + +[//]: # (OPERATION:get_security_insider_ownership_v2) + +[//]: # (ENDPOINT:/securities/{identifier}/institutional_ownership) + +[//]: # (DOCUMENT_LINK:SecurityApi.md#get_security_insider_ownership) + +## **get_security_insider_ownership** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_security_insider_ownership_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseSecurityInstitutionalOwnership get_security_insider_ownership(identifier) + +#### Institutional Ownership by Security + + +Returns a list of all institutional owners of a given security. + +[//]: # (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 + +security_api = Intrinio::SecurityApi.new +identifier = "AAPL" + +result = security_api.get_security_insider_ownership(identifier) +pp result +``` + +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **identifier** | String| A Security identifier (Ticker, FIGI, ISIN, CUSIP, Intrinio ID) |   + +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseSecurityInstitutionalOwnership**](ApiResponseSecurityInstitutionalOwnership.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION)