docs/CompanyApi.md in intrinio-sdk-3.1.0 vs docs/CompanyApi.md in intrinio-sdk-3.2.0

- old
+ new

@@ -10,10 +10,11 @@ [**get_company_data_point_number**](CompanyApi.md#get_company_data_point_number) | **GET** /companies/{identifier}/data_point/{tag}/number | Data Point (Number) for Company [**get_company_data_point_text**](CompanyApi.md#get_company_data_point_text) | **GET** /companies/{identifier}/data_point/{tag}/text | Data Point (Text) for Company [**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_securities**](CompanyApi.md#get_company_securities) | **GET** /companies/{identifier}/securities | All Securities 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 @@ -37,11 +38,11 @@ [//]: # (DOCUMENT_LINK:CompanyApi.md#get_all_companies) ## **get_all_companies** -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_all_companies_v2) +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_all_companies_v2) [//]: # (START_OVERVIEW) > ApiResponseCompanies get_all_companies(opts) @@ -57,32 +58,35 @@ [//]: # (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' end company_api = Intrinio::CompanyApi.new opts = { latest_filing_date: nil, # Date | Last filing date - sic: nil, # String | Standard Industrial Classification code - template: nil, # String | Template - sector: nil, # String | Industry sector - industry_category: nil, # String | Industry category - industry_group: nil, # String | Industry group + sic: nil, # String | Return companies with the given Standard Industrial Classification code + template: nil, # String | Return companies with the given financial statement template + sector: nil, # String | Return companies in the given industry sector + industry_category: nil, # String | Return companies in the given industry category + industry_group: nil, # String | Return companies in the given industry group + has_fundamentals: true, # BOOLEAN | Return only companies that have fundamentals when true + has_stock_prices: true, # BOOLEAN | Return only companies that have stock prices when true page_size: 100, # Integer | The number of results to return next_page: nil # String | Gets the next page of data from a previous API call } begin result = company_api.get_all_companies(opts) - p result + pp result rescue Intrinio::ApiError => e puts "Exception when calling CompanyApi->get_all_companies: #{e}" end ``` @@ -96,15 +100,17 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **latest_filing_date** | Date| Last filing date | [optional] &nbsp; - **sic** | String| Standard Industrial Classification code | [optional] &nbsp; - **template** | String| Template | [optional] &nbsp; - **sector** | String| Industry sector | [optional] &nbsp; - **industry_category** | String| Industry category | [optional] &nbsp; - **industry_group** | String| Industry group | [optional] &nbsp; + **sic** | String| Return companies with the given Standard Industrial Classification code | [optional] &nbsp; + **template** | String| Return companies with the given financial statement template | [optional] &nbsp; + **sector** | String| Return companies in the given industry sector | [optional] &nbsp; + **industry_category** | String| Return companies in the given industry category | [optional] &nbsp; + **industry_group** | String| Return companies in the given industry group | [optional] &nbsp; + **has_fundamentals** | BOOLEAN| Return only companies that have fundamentals when true | [optional] &nbsp; + **has_stock_prices** | BOOLEAN| Return only companies that have stock prices when true | [optional] &nbsp; **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; <br/> [//]: # (END_PARAMETERS) @@ -134,11 +140,11 @@ [//]: # (DOCUMENT_LINK:CompanyApi.md#get_all_company_news) ## **get_all_company_news** -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_all_company_news_v2) +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_all_company_news_v2) [//]: # (START_OVERVIEW) > ApiResponseNews get_all_company_news(opts) @@ -154,10 +160,11 @@ [//]: # (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' end @@ -169,11 +176,11 @@ next_page: nil # String | Gets the next page of data from a previous API call } begin result = company_api.get_all_company_news(opts) - p result + pp result rescue Intrinio::ApiError => e puts "Exception when calling CompanyApi->get_all_company_news: #{e}" end ``` @@ -219,11 +226,11 @@ [//]: # (DOCUMENT_LINK:CompanyApi.md#get_company) ## **get_company** -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_company_v2) +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_company_v2) [//]: # (START_OVERVIEW) > Company get_company(identifier) @@ -239,10 +246,11 @@ [//]: # (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' end @@ -252,11 +260,11 @@ identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID) begin result = company_api.get_company(identifier) - p result + pp result rescue Intrinio::ApiError => e puts "Exception when calling CompanyApi->get_company: #{e}" end ``` @@ -301,11 +309,11 @@ [//]: # (DOCUMENT_LINK:CompanyApi.md#get_company_data_point_number) ## **get_company_data_point_number** -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_company_data_point_number_v2) +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_company_data_point_number_v2) [//]: # (START_OVERVIEW) > Float get_company_data_point_number(identifier, tag) @@ -321,10 +329,11 @@ [//]: # (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' end @@ -336,11 +345,11 @@ tag = "marketcap" # String | An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) begin result = company_api.get_company_data_point_number(identifier, tag) - p result + pp result rescue Intrinio::ApiError => e puts "Exception when calling CompanyApi->get_company_data_point_number: #{e}" end ``` @@ -386,11 +395,11 @@ [//]: # (DOCUMENT_LINK:CompanyApi.md#get_company_data_point_text) ## **get_company_data_point_text** -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_company_data_point_text_v2) +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_company_data_point_text_v2) [//]: # (START_OVERVIEW) > String get_company_data_point_text(identifier, tag) @@ -406,10 +415,11 @@ [//]: # (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' end @@ -421,11 +431,11 @@ tag = "ceo" # String | An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) begin result = company_api.get_company_data_point_text(identifier, tag) - p result + pp result rescue Intrinio::ApiError => e puts "Exception when calling CompanyApi->get_company_data_point_text: #{e}" end ``` @@ -471,11 +481,11 @@ [//]: # (DOCUMENT_LINK:CompanyApi.md#get_company_filings) ## **get_company_filings** -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_company_filings_v2) +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_company_filings_v2) [//]: # (START_OVERVIEW) > ApiResponseCompanyFilings get_company_filings(identifier, opts) @@ -491,10 +501,11 @@ [//]: # (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' end @@ -511,11 +522,11 @@ next_page: nil # String | Gets the next page of data from a previous API call } begin result = company_api.get_company_filings(identifier, opts) - p result + pp result rescue Intrinio::ApiError => e puts "Exception when calling CompanyApi->get_company_filings: #{e}" end ``` @@ -565,11 +576,11 @@ [//]: # (DOCUMENT_LINK:CompanyApi.md#get_company_fundamentals) ## **get_company_fundamentals** -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_company_fundamentals_v2) +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_company_fundamentals_v2) [//]: # (START_OVERVIEW) > ApiResponseCompanyFundamentals get_company_fundamentals(identifier, opts) @@ -585,10 +596,11 @@ [//]: # (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' end @@ -610,11 +622,11 @@ next_page: nil # String | Gets the next page of data from a previous API call } begin result = company_api.get_company_fundamentals(identifier, opts) - p result + pp result rescue Intrinio::ApiError => e puts "Exception when calling CompanyApi->get_company_fundamentals: #{e}" end ``` @@ -669,11 +681,11 @@ [//]: # (DOCUMENT_LINK:CompanyApi.md#get_company_historical_data) ## **get_company_historical_data** -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_company_historical_data_v2) +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_company_historical_data_v2) [//]: # (START_OVERVIEW) > ApiResponseCompanyHistoricalData get_company_historical_data(identifier, tag, opts) @@ -689,10 +701,11 @@ [//]: # (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' end @@ -703,21 +716,21 @@ tag = "marketcap" # String | An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags'>reference</a>) opts = { frequency: "daily", # String | Return historical data in the given frequency - type: nil, # String | Filter by type, when applicable - start_date: Date.parse("2018-01-01"), # Date | Get historical data on or after this date - end_date: nil, # Date | Get historical data on or before this date + type: nil, # String | Return historical data for given fiscal period type + start_date: Date.parse("2018-01-01"), # Date | Return historical data on or after this date + end_date: nil, # Date | Return historical data on or before this date sort_order: "desc", # String | Sort by date `asc` or `desc` page_size: 100, # Integer | The number of results to return next_page: nil # String | Gets the next page of data from a previous API call } begin result = company_api.get_company_historical_data(identifier, tag, opts) - p result + pp result rescue Intrinio::ApiError => e puts "Exception when calling CompanyApi->get_company_historical_data: #{e}" end ``` @@ -733,13 +746,13 @@ Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **identifier** | String| A Company identifier (Ticker, CIK, LEI, Intrinio ID) | &nbsp; **tag** | String| An Intrinio data tag ID or code (&lt;a href&#x3D;&#39;https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a&gt;) | &nbsp; **frequency** | String| Return historical data in the given frequency | [optional] [default to daily] &nbsp; - **type** | String| Filter by type, when applicable | [optional] &nbsp; - **start_date** | Date| Get historical data on or after this date | [optional] &nbsp; - **end_date** | Date| Get historical data on or before this date | [optional] &nbsp; + **type** | String| Return historical data for given fiscal period type | [optional] &nbsp; + **start_date** | Date| Return historical data on or after this date | [optional] &nbsp; + **end_date** | Date| Return historical data on or before this date | [optional] &nbsp; **sort_order** | String| Sort by date &#x60;asc&#x60; or &#x60;desc&#x60; | [optional] [default to desc] &nbsp; **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; <br/> @@ -754,10 +767,96 @@ [//]: # (START_OPERATION) [//]: # (CLASS:Intrinio::CompanyApi) +[//]: # (METHOD:get_company_ipos) + +[//]: # (RETURN_TYPE:Intrinio::ApiResponseInitialPublicOfferings) + +[//]: # (RETURN_TYPE_KIND:object) + +[//]: # (RETURN_TYPE_DOC:ApiResponseInitialPublicOfferings.md) + +[//]: # (OPERATION:get_company_ipos_v2) + +[//]: # (ENDPOINT:/companies/ipos) + +[//]: # (DOCUMENT_LINK:CompanyApi.md#get_company_ipos) + +## **get_company_ipos** + +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_company_ipos_v2) + +[//]: # (START_OVERVIEW) + +> ApiResponseInitialPublicOfferings get_company_ipos(opts) + +#### IPOs + + +Returns initial public offerings (IPOs). An IPO is a public offering of private company stock. The act of \"going public\" is initiated by an IPO, at which point the company's stock trades on a major stock exchange (such as NYSE or NASDAQ). Intrinio covers all upcoming and recent IPOs for US exchanges. + +[//]: # (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' +end + +company_api = Intrinio::CompanyApi.new + +opts = { + page_size: 100, # Integer | The number of results to return + next_page: nil # String | Gets the next page of data from a previous API call +} + +begin + result = company_api.get_company_ipos(opts) + pp result +rescue Intrinio::ApiError => e + puts "Exception when calling CompanyApi->get_company_ipos: #{e}" +end +``` + +[//]: # (END_CODE_EXAMPLE) + +[//]: # (START_DEFINITION) + +### Parameters + +[//]: # (START_PARAMETERS) + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **page_size** | Integer| The number of results to return | [optional] [default to 100] &nbsp; + **next_page** | String| Gets the next page of data from a previous API call | [optional] &nbsp; +<br/> + +[//]: # (END_PARAMETERS) + +### Return type + +[**ApiResponseInitialPublicOfferings**](ApiResponseInitialPublicOfferings.md) + +[//]: # (END_OPERATION) + + +[//]: # (START_OPERATION) + +[//]: # (CLASS:Intrinio::CompanyApi) + [//]: # (METHOD:get_company_news) [//]: # (RETURN_TYPE:Intrinio::ApiResponseCompanyNews) [//]: # (RETURN_TYPE_KIND:object) @@ -770,11 +869,11 @@ [//]: # (DOCUMENT_LINK:CompanyApi.md#get_company_news) ## **get_company_news** -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_company_news_v2) +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_company_news_v2) [//]: # (START_OVERVIEW) > ApiResponseCompanyNews get_company_news(identifier, opts) @@ -790,10 +889,11 @@ [//]: # (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' end @@ -807,11 +907,11 @@ next_page: nil # String | Gets the next page of data from a previous API call } begin result = company_api.get_company_news(identifier, opts) - p result + pp result rescue Intrinio::ApiError => e puts "Exception when calling CompanyApi->get_company_news: #{e}" end ``` @@ -858,11 +958,11 @@ [//]: # (DOCUMENT_LINK:CompanyApi.md#get_company_securities) ## **get_company_securities** -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/get_company_securities_v2) +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/get_company_securities_v2) [//]: # (START_OVERVIEW) > ApiResponseCompanySecurities get_company_securities(identifier, opts) @@ -878,10 +978,11 @@ [//]: # (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' end @@ -894,11 +995,11 @@ next_page: nil # String | Gets the next page of data from a previous API call } begin result = company_api.get_company_securities(identifier, opts) - p result + pp result rescue Intrinio::ApiError => e puts "Exception when calling CompanyApi->get_company_securities: #{e}" end ``` @@ -944,11 +1045,11 @@ [//]: # (DOCUMENT_LINK:CompanyApi.md#lookup_company_fundamental) ## **lookup_company_fundamental** -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/lookup_company_fundamental_v2) +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/lookup_company_fundamental_v2) [//]: # (START_OVERVIEW) > Fundamental lookup_company_fundamental(identifier, statement_code, fiscal_period, fiscal_year) @@ -964,10 +1065,11 @@ [//]: # (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' end @@ -983,11 +1085,11 @@ fiscal_year = 2017 # Integer | The fiscal year begin result = company_api.lookup_company_fundamental(identifier, statement_code, fiscal_period, fiscal_year) - p result + pp result rescue Intrinio::ApiError => e puts "Exception when calling CompanyApi->lookup_company_fundamental: #{e}" end ``` @@ -1035,11 +1137,11 @@ [//]: # (DOCUMENT_LINK:CompanyApi.md#search_companies) ## **search_companies** -[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/api_v2/search_companies_v2) +[**View Intrinio API Documentation**](https://docs.intrinio.com/documentation/ruby/search_companies_v2) [//]: # (START_OVERVIEW) > ApiResponseCompaniesSearch search_companies(query, opts) @@ -1055,10 +1157,11 @@ [//]: # (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' end @@ -1071,10 +1174,10 @@ page_size: 100 # Integer | The number of results to return } begin result = company_api.search_companies(query, opts) - p result + pp result rescue Intrinio::ApiError => e puts "Exception when calling CompanyApi->search_companies: #{e}" end ```