docs/CompanyApi.md in intrinio-sdk-6.26.1 vs docs/CompanyApi.md in intrinio-sdk-6.26.2

- old
+ new

@@ -13,10 +13,11 @@ [**get_company_filings**](CompanyApi.md#get_company_filings) | **GET** /companies/{identifier}/filings | All Filings by Company [**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_public_float**](CompanyApi.md#get_company_public_float) | **GET** /companies/{identifier}/public_float | Get Company's public float [**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 [**recognize_company**](CompanyApi.md#recognize_company) | **GET** /companies/recognize | Recognize Company @@ -981,9 +982,97 @@ [//]: # (END_PARAMETERS) ### Return type [**ApiResponseCompanyNews**](ApiResponseCompanyNews.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::CompanyApi) + +[//]: # (METHOD:get_company_public_float) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseCompanyPublicFloatResult) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseCompanyPublicFloatResult.md) + +[//]: # (OPERATION:get_company_public_float_v2) + +[//]: # (ENDPOINT:/companies/{identifier}/public_float) + +[//]: # (DOCUMENT_LINK:CompanyApi.md#get_company_public_float) + +## **get_company_public_float** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_company_public_float_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseCompanyPublicFloatResult get_company_public_float(identifier, opts) + +#### Get Company's public float + + +Returns a list of public float data tied to a given company 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 + +company_api = Intrinio::CompanyApi.new +identifier = "AAPL" + +opts = { + float_date_greater_than: nil, + float_date_less_than: nil, + next_page: nil, + next_page2: nil +} + +result = company_api.get_company_public_float(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) |   + **float_date_greater_than** | Date| The lower-bound date for the data being requested. | [optional]   + **float_date_less_than** | Date| The upper-bound date for the data being requested. | [optional]   + **next_page** | String| Gets the next page of data from a previous API call | [optional]   + **next_page2** | String| Gets the next page of data from a previous API call | [optional]   + +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseCompanyPublicFloatResult**](ApiResponseCompanyPublicFloatResult.md) [//]: # (END_OPERATION) [//]: # (START_OPERATION)