intrinio-sdk 1.0.0

data/docs/ApiResponseStockExchangeStockPrices.md

@@ -0,0 +1,10 @@
+# Intrinio::ApiResponseStockExchangeStockPrices
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**stock_prices** | [**Array<StockPrice>**](StockPrice.md) | The stock prices for all Securities traded on the Stock Exchange on the given date | [optional] 
+**stock_exchange** | [**StockExchange**](StockExchange.md) | The Stock Exchange resolved from the given identifier | [optional] 
+**next_page** | **String** | The token required to request the next page of the data | [optional] 
+
+

data/docs/ApiResponseStockExchanges.md

@@ -0,0 +1,9 @@
+# Intrinio::ApiResponseStockExchanges
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**stock_exchanges** | [**Array<StockExchange>**](StockExchange.md) |  | [optional] 
+**next_page** | **String** | The token required to request the next page of the data | [optional] 
+
+

data/docs/ApiResponseStockMarketIndexHistoricalData.md

@@ -0,0 +1,10 @@
+# Intrinio::ApiResponseStockMarketIndexHistoricalData
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**historical_data** | [**Array<HistoricalData>**](HistoricalData.md) |  | [optional] 
+**index** | [**StockMarketIndexSummary**](StockMarketIndexSummary.md) |  | [optional] 
+**next_page** | **String** | The token required to request the next page of the data | [optional] 
+
+

data/docs/ApiResponseStockMarketIndices.md

@@ -0,0 +1,9 @@
+# Intrinio::ApiResponseStockMarketIndices
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**indices** | [**Array<StockMarketIndexSummary>**](StockMarketIndexSummary.md) |  | [optional] 
+**next_page** | **String** | The token required to request the next page of the data | [optional] 
+
+

data/docs/Company.md

@@ -0,0 +1,39 @@
+# Intrinio::Company
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | The Intrinio ID of the company | [optional] 
+**ticker** | **String** | The stock market ticker symbol associated with the company's common stock securities | [optional] 
+**name** | **String** | The company's common name | [optional] 
+**lei** | **String** | The Legal Entity Identifier (LEI) assigned to the company | [optional] 
+**legal_name** | **String** | The company's official legal name | [optional] 
+**stock_exchange** | **String** | The Stock Exchange where the company's common stock is primarily traded | [optional] 
+**sic** | **String** | The Standard Industrial Classification (SIC) determined by the company and filed with the SEC | [optional] 
+**short_description** | **String** | A one or two sentence description of the company's operations | [optional] 
+**long_description** | **String** | A one paragraph description of the company's operations and other corporate actions | [optional] 
+**ceo** | **String** | The Chief Executive Officer of the company | [optional] 
+**company_url** | **String** | The URL of the company's primary corporate website or primary internet property | [optional] 
+**business_address** | **String** | The company's business address | [optional] 
+**mailing_address** | **String** | The mailing address reported by the company | [optional] 
+**business_phone_no** | **String** | The phone number reported by the company | [optional] 
+**hq_address1** | **String** | The company's headquarters address - line 1 | [optional] 
+**hq_address2** | **String** | The company's headquarters address - line 2 | [optional] 
+**hq_address_city** | **String** | The company's headquarters city | [optional] 
+**hq_address_postal_code** | **String** | The company's headquarters postal code | [optional] 
+**entity_legal_form** | **String** | The company's legal organization form | [optional] 
+**cik** | **String** | The Central Index Key (CIK) assigned to the company by the SEC as a unique identifier, used in SEC filings | [optional] 
+**latest_filing_date** | **Date** | The date of the company's last filing with the SEC | [optional] 
+**hq_state** | **String** | The state (US & Canada Only) where the company headquarters are located | [optional] 
+**hq_country** | **String** | The country where the company headquarters are located | [optional] 
+**inc_state** | **String** | The state (US & Canada Only) where the company is incorporated | [optional] 
+**inc_country** | **String** | The country where the company is incorporated | [optional] 
+**employees** | **Integer** | The number of employees working for the company | [optional] 
+**entity_status** | **String** |  | [optional] 
+**sector** | **String** | The company's operating sector | [optional] 
+**industry_category** | **String** | The company's operating industry category | [optional] 
+**industry_group** | **String** | The company's operating industry group | [optional] 
+**template** | **String** | The financial statement template used by Intrinio to standardize the as reported data | [optional] 
+**standardized_active** | **BOOLEAN** | If true, the company has standardized and as reported fundamental data via the Intrinio API; if false, the company has as-reported data only | [optional] 
+
+

data/docs/CompanyApi.md

@@ -0,0 +1,659 @@
+# Intrinio::CompanyApi
+
+All URIs are relative to *https://api-v2.intrinio.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**filter_companies**](CompanyApi.md#filter_companies) | **GET** /companies/filter | Filter Companies
+[**filter_company_fundamentals**](CompanyApi.md#filter_company_fundamentals) | **GET** /companies/{identifier}/fundamentals/filter | Filter Fundamentals for a Company
+[**get_all_companies**](CompanyApi.md#get_all_companies) | **GET** /companies | Get All Companies
+[**get_all_company_news**](CompanyApi.md#get_all_company_news) | **GET** /companies/news | Get All Company News
+[**get_company**](CompanyApi.md#get_company) | **GET** /companies/{identifier} | Get a Company by ID
+[**get_company_data_point_number**](CompanyApi.md#get_company_data_point_number) | **GET** /companies/{identifier}/data_point/{tag}/number | Get Company Data Point (Number)
+[**get_company_data_point_text**](CompanyApi.md#get_company_data_point_text) | **GET** /companies/{identifier}/data_point/{tag}/text | Get Company Data Point (Text)
+[**get_company_filings**](CompanyApi.md#get_company_filings) | **GET** /companies/{identifier}/filings | Get Filings for a Company
+[**get_company_fundamentals**](CompanyApi.md#get_company_fundamentals) | **GET** /companies/{identifier}/fundamentals | Get All Fundamentals for a Company
+[**get_company_historical_data**](CompanyApi.md#get_company_historical_data) | **GET** /companies/{identifier}/historical_data/{tag} | Get Company Historical Data
+[**get_company_news**](CompanyApi.md#get_company_news) | **GET** /companies/{identifier}/news | Get News for a Company
+[**get_company_securities**](CompanyApi.md#get_company_securities) | **GET** /companies/{identifier}/securities | Get Securities by Company
+[**lookup_company_fundamental**](CompanyApi.md#lookup_company_fundamental) | **GET** /companies/{identifier}/fundamentals/lookup/{statement_code}/{fiscal_year}/{fiscal_period} | Lookup a Fundamental for a Company
+[**search_companies**](CompanyApi.md#search_companies) | **GET** /companies/search | Search Companies
+
+
+# **filter_companies**
+> ApiResponseCompanies filter_companies(opts)
+
+Filter Companies
+
+Returns Companies matching the specified filters
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+company_api = Intrinio::CompanyApi.new
+
+opts = { 
+  last_filing_date: nil, # Date | Last filing date
+  sic: "3350", # String | Standard Industrial Classification code
+  template: "industrial", # String | Template
+  sector: "Basic Materials", # String | Industry sector
+  industry_category: "Metals & Mining", # String | Industry category
+  industry_group: "Aluminum", # String | Industry group
+  next_page: nil # String | Gets the next page of data from a previous API call
+}
+
+begin
+  result = company_api.filter_companies(opts)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling CompanyApi->filter_companies: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **last_filing_date** | **Date**| Last filing date | [optional] 
+ **sic** | **String**| Standard Industrial Classification code | [optional] 
+ **template** | **String**| Template | [optional] 
+ **sector** | **String**| Industry sector | [optional] 
+ **industry_category** | **String**| Industry category | [optional] 
+ **industry_group** | **String**| Industry group | [optional] 
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseCompanies**](ApiResponseCompanies.md)
+
+# **filter_company_fundamentals**
+> ApiResponseCompanyFundamentals filter_company_fundamentals(identifier, opts)
+
+Filter Fundamentals for a Company
+
+Returns Fundamentals for the Company with the given `identifier` and matching the specified filters
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+company_api = Intrinio::CompanyApi.new
+
+identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
+
+opts = { 
+  filed_after: nil, # Date | Filed on or after this date
+  filed_before: nil, # Date | Filed on or before this date
+  reported_only: false, # BOOLEAN | Only as-reported fundamentals
+  fiscal_year: 2017, # Integer | Only for the given fiscal year
+  statement_code: nil, # String | Only of the given statement code
+  type: nil, # String | Only of the given type
+  start_date: nil, # Date | Only on or after the given date
+  end_date: nil, # Date | Only on or before the given date
+  next_page: nil # String | Gets the next page of data from a previous API call
+}
+
+begin
+  result = company_api.filter_company_fundamentals(identifier, opts)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling CompanyApi->filter_company_fundamentals: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| A Company identifier (Ticker, CIK, LEI, Intrinio ID) | 
+ **filed_after** | **Date**| Filed on or after this date | [optional] 
+ **filed_before** | **Date**| Filed on or before this date | [optional] 
+ **reported_only** | **BOOLEAN**| Only as-reported fundamentals | [optional] 
+ **fiscal_year** | **Integer**| Only for the given fiscal year | [optional] 
+ **statement_code** | **String**| Only of the given statement code | [optional] 
+ **type** | **String**| Only of the given type | [optional] 
+ **start_date** | **Date**| Only on or after the given date | [optional] 
+ **end_date** | **Date**| Only on or before the given date | [optional] 
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseCompanyFundamentals**](ApiResponseCompanyFundamentals.md)
+
+# **get_all_companies**
+> ApiResponseCompanies get_all_companies(opts)
+
+Get All Companies
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+company_api = Intrinio::CompanyApi.new
+
+opts = { 
+  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
+rescue Intrinio::ApiError => e
+  puts "Exception when calling CompanyApi->get_all_companies: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseCompanies**](ApiResponseCompanies.md)
+
+# **get_all_company_news**
+> ApiResponseNews get_all_company_news(opts)
+
+Get All Company News
+
+Returns all news for all companies
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+company_api = Intrinio::CompanyApi.new
+
+opts = { 
+  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
+rescue Intrinio::ApiError => e
+  puts "Exception when calling CompanyApi->get_all_company_news: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseNews**](ApiResponseNews.md)
+
+# **get_company**
+> Company get_company(identifier)
+
+Get a Company by ID
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+company_api = Intrinio::CompanyApi.new
+
+identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
+
+
+begin
+  result = company_api.get_company(identifier)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling CompanyApi->get_company: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| A Company identifier (Ticker, CIK, LEI, Intrinio ID) | 
+
+### Return type
+
+[**Company**](Company.md)
+
+# **get_company_data_point_number**
+> Float get_company_data_point_number(identifier, tag)
+
+Get Company Data Point (Number)
+
+Returns a numeric value for the given `tag` for the Company with the given `identifier`
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+company_api = Intrinio::CompanyApi.new
+
+identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
+
+tag = "marketcap" # String | An Intrinio data tag
+
+
+begin
+  result = company_api.get_company_data_point_number(identifier, tag)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling CompanyApi->get_company_data_point_number: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| A Company identifier (Ticker, CIK, LEI, Intrinio ID) | 
+ **tag** | **String**| An Intrinio data tag | 
+
+### Return type
+
+**Float**
+
+# **get_company_data_point_text**
+> String get_company_data_point_text(identifier, tag)
+
+Get Company Data Point (Text)
+
+Returns a text value for the given `tag` for the Company with the given `identifier`
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+company_api = Intrinio::CompanyApi.new
+
+identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
+
+tag = "marketcap" # String | An Intrinio data tag
+
+
+begin
+  result = company_api.get_company_data_point_text(identifier, tag)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling CompanyApi->get_company_data_point_text: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| A Company identifier (Ticker, CIK, LEI, Intrinio ID) | 
+ **tag** | **String**| An Intrinio data tag | 
+
+### Return type
+
+**String**
+
+# **get_company_filings**
+> ApiResponseCompanyFilings get_company_filings(identifier, opts)
+
+Get Filings for a Company
+
+Returns a complete list of SEC filings for the Company with the given `identifier`
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+company_api = Intrinio::CompanyApi.new
+
+identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
+
+opts = { 
+  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
+rescue Intrinio::ApiError => e
+  puts "Exception when calling CompanyApi->get_company_filings: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| A Company identifier (Ticker, CIK, LEI, Intrinio ID) | 
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseCompanyFilings**](ApiResponseCompanyFilings.md)
+
+# **get_company_fundamentals**
+> ApiResponseCompanyFundamentals get_company_fundamentals(identifier, opts)
+
+Get All Fundamentals for a Company
+
+Returns all Fundamentals for the Company with the given `identifier`
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+company_api = Intrinio::CompanyApi.new
+
+identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
+
+opts = { 
+  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
+rescue Intrinio::ApiError => e
+  puts "Exception when calling CompanyApi->get_company_fundamentals: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| A Company identifier (Ticker, CIK, LEI, Intrinio ID) | 
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseCompanyFundamentals**](ApiResponseCompanyFundamentals.md)
+
+# **get_company_historical_data**
+> ApiResponseCompanyHistoricalData get_company_historical_data(identifier, tag, opts)
+
+Get Company Historical Data
+
+Returns historical values for the given `tag` and the Company with the given `identifier`
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+company_api = Intrinio::CompanyApi.new
+
+identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
+
+tag = "marketcap" # String | Item
+
+opts = { 
+  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: Date.parse("2019-01-01"), # Date | Get historical data on or before this date
+  sort_order: "desc", # String | Sort by date `asc` or `desc`
+  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
+rescue Intrinio::ApiError => e
+  puts "Exception when calling CompanyApi->get_company_historical_data: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| A Company identifier (Ticker, CIK, LEI, Intrinio ID) | 
+ **tag** | **String**| Item | 
+ **type** | **String**| Filter by type, when applicable | [optional] 
+ **start_date** | **Date**| Get historical data on or after this date | [optional] 
+ **end_date** | **Date**| Get historical data on or before this date | [optional] 
+ **sort_order** | **String**| Sort by date `asc` or `desc` | [optional] [default to desc]
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseCompanyHistoricalData**](ApiResponseCompanyHistoricalData.md)
+
+# **get_company_news**
+> ApiResponseCompanyNews get_company_news(identifier, opts)
+
+Get News for a Company
+
+Returns news for the Company with the given `identifier`
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+company_api = Intrinio::CompanyApi.new
+
+identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
+
+opts = { 
+  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
+rescue Intrinio::ApiError => e
+  puts "Exception when calling CompanyApi->get_company_news: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| A Company identifier (Ticker, CIK, LEI, Intrinio ID) | 
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseCompanyNews**](ApiResponseCompanyNews.md)
+
+# **get_company_securities**
+> ApiResponseCompanySecurities get_company_securities(identifier, opts)
+
+Get Securities by Company
+
+Return Securities for the Company with `identifier`
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+company_api = Intrinio::CompanyApi.new
+
+identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
+
+opts = { 
+  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
+rescue Intrinio::ApiError => e
+  puts "Exception when calling CompanyApi->get_company_securities: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| A Company identifier (Ticker, CIK, LEI, Intrinio ID) | 
+ **next_page** | **String**| Gets the next page of data from a previous API call | [optional] 
+
+### Return type
+
+[**ApiResponseCompanySecurities**](ApiResponseCompanySecurities.md)
+
+# **lookup_company_fundamental**
+> Fundamental lookup_company_fundamental(identifier, statement_code, fiscal_period, fiscal_year)
+
+Lookup a Fundamental for a Company
+
+Returns the Fundamental for the Company with the given `identifier` and with the given parameters
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+company_api = Intrinio::CompanyApi.new
+
+identifier = "AAPL" # String | A Company identifier (Ticker, CIK, LEI, Intrinio ID)
+
+statement_code = "income_statement" # String | The statement code
+
+fiscal_period = "FY" # String | The fiscal period
+
+fiscal_year = 2017 # Integer | The fiscal year
+
+
+begin
+  result = company_api.lookup_company_fundamental(identifier, statement_code, fiscal_period, fiscal_year)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling CompanyApi->lookup_company_fundamental: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **identifier** | **String**| A Company identifier (Ticker, CIK, LEI, Intrinio ID) | 
+ **statement_code** | **String**| The statement code | 
+ **fiscal_period** | **String**| The fiscal period | 
+ **fiscal_year** | **Integer**| The fiscal year | 
+
+### Return type
+
+[**Fundamental**](Fundamental.md)
+
+# **search_companies**
+> ApiResponseCompanies search_companies(query)
+
+Search Companies
+
+Searches for Companies matching the text `query`
+
+### Example
+```ruby
+# Load the gem
+require 'intrinio-sdk'
+
+# Setup authorization
+Intrinio.configure do |config|
+  config.api_key['api_key'] = 'YOUR API KEY'
+end
+
+company_api = Intrinio::CompanyApi.new
+
+query = "Apple" # String | Search parameters
+
+
+begin
+  result = company_api.search_companies(query)
+  p result
+rescue Intrinio::ApiError => e
+  puts "Exception when calling CompanyApi->search_companies: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **query** | **String**| Search parameters | 
+
+### Return type
+
+[**ApiResponseCompanies**](ApiResponseCompanies.md)
+