Skip to content

Latest commit

 

History

History
1982 lines (1214 loc) · 52.1 KB

CompanyApi.md

File metadata and controls

1982 lines (1214 loc) · 52.1 KB
Raw

Intrinio::CompanyApi

All URIs are relative to https://api-v2.intrinio.com

Method HTTP request Description
get_all_companies GET /companies All Companies
get_all_companies_daily_metrics GET /companies/daily_metrics All Companies daily metrics
get_all_company_news GET /companies/news All News
get_company GET /companies/{identifier} Lookup Company
get_company_answers GET /companies/{identifier}/answers Company Answers
get_company_daily_metrics GET /companies/{identifier}/daily_metrics Company metrics by Company
get_company_data_point_number GET /companies/{identifier}/data_point/{tag}/number Data Point (Number) for Company
get_company_data_point_text GET /companies/{identifier}/data_point/{tag}/text Data Point (Text) for Company
get_company_filings GET /companies/{identifier}/filings All Filings by Company
get_company_fundamentals GET /companies/{identifier}/fundamentals All Fundamentals by Company
get_company_historical_data GET /companies/{identifier}/historical_data/{tag} Historical Data for Company
get_company_ipos GET /companies/ipos IPOs
get_company_news GET /companies/{identifier}/news All News by Company
get_company_news_body GET /companies/news/body News Article Body
get_company_public_float GET /companies/{identifier}/public_float Get Company's public float
get_company_securities GET /companies/{identifier}/securities All Securities by Company
insider_transaction_filings_by_company GET /companies/{identifier}/insider_transaction_filings Insider Transaction Filings by Company
latest_insider_transaction_filing_by_company GET /companies/{identifier}/insider_transaction_filings/latest Latest Insider Transaction Filing by Company
lookup_company_fundamental GET /companies/{identifier}/fundamentals/lookup/{statement_code}/{fiscal_year}/{fiscal_period} Lookup Fundamental by Company
recognize_company GET /companies/recognize Recognize Company
search_companies GET /companies/search Search Companies
shares_outstanding_by_company GET /companies/{identifier}/shares_outstanding Shares Outstanding by Company

get_all_companies

View Intrinio API Documentation

ApiResponseCompanies get_all_companies(opts)

All Companies

Returns all Companies. When parameters are specified, returns matching companies.

Example

# 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

opts = {
  latest_filing_date: nil,
  sic: nil,
  template: nil,
  sector: nil,
  industry_category: nil,
  industry_group: nil,
  has_fundamentals: true,
  has_stock_prices: true,
  thea_enabled: nil,
  page_size: 100,
  next_page: nil
}

result = company_api.get_all_companies(opts)
pp result

Parameters

Name Type Description Notes
latest_filing_date Date Return companies whose latest 10-Q or 10-K was filed on or after this date [optional]  
sic String Return companies with the given Standard Industrial Classification code [optional]  
template String Return companies with the given financial statement template [optional]  
sector String Return companies in the given industry sector [optional]  
industry_category String Return companies in the given industry category [optional]  
industry_group String Return companies in the given industry group [optional]  
has_fundamentals BOOLEAN Return only companies that have fundamentals when true [optional]  
has_stock_prices BOOLEAN Return only companies that have stock prices when true [optional]  
thea_enabled BOOLEAN Return companies whose have been read by our Thea NLP and are ready for our company answers endpoint [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]  

Return type

ApiResponseCompanies

get_all_companies_daily_metrics

View Intrinio API Documentation

ApiResponseCompanyDailyMetrics get_all_companies_daily_metrics(opts)

All Companies daily metrics

Returns the company metrics for a date.

Example

# 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

opts = {
  on_date: Date.parse("2013-10-20"),
  page_size: 100,
  next_page: nil,
  next_page2: nil
}

result = company_api.get_all_companies_daily_metrics(opts)
pp result

Parameters

Name Type Description Notes
on_date Date Date of the metric [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]  
next_page2 String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseCompanyDailyMetrics

get_all_company_news

View Intrinio API Documentation

ApiResponseNews get_all_company_news(opts)

All News

Returns the latest news article links, headlines and summaries for all US traded companies allowing you to keep a pulse on companies and their business operations.

Example

# 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

opts = {
  specific_source: nil,
  page_size: 100,
  sentiment: nil,
  topic: nil,
  company: "AAPL",
  security: "AAPL",
  start_date: nil,
  end_date: nil,
  language: nil,
  word_count_greater_than: nil,
  word_count_less_than: nil,
  is_spam: nil,
  business_relevance_greater_than: nil,
  business_relevance_less_than: nil,
  next_page: nil
}

result = company_api.get_all_company_news(opts)
pp result

Parameters

Name Type Description Notes
specific_source String Only news from this source. Defaults to highest available if not present. [optional]  
page_size Integer The maximum number of results to return. [optional] [default to 100]  
sentiment String Filter by sentiment. Unsupported for yahoo source. [optional]  
topic String Filter by topic. Unsupported for yahoo source. [optional]  
company String Filter by `company` identifier (ticker, CIK, LEI, Intrinio ID) [optional]  
security String Filter by `security` identifier (ticker, figi, isin, cusip, Intrinio ID). Unsupported for yahoo source. [optional]  
start_date Date Limit news stories to those on or after this date. Defaults to yesterday if unspecified. [optional]  
end_date Date Limit news stories to those on or before this date. [optional]  
language String Filter by language. Unsupported for yahoo source. [optional]  
word_count_greater_than Integer News stories will have a word count greater than this value. Unsupported for yahoo source. [optional]  
word_count_less_than Integer News stories will have a word count less than this value. Unsupported for yahoo source. [optional]  
is_spam BOOLEAN Filter whether it is marked as spam or not. Unsupported for yahoo source. [optional]  
business_relevance_greater_than Float News stories will have a business relevance score more than this value. Unsupported for yahoo source. [optional]  
business_relevance_less_than Float News stories will have a business relevance score less than this value. Unsupported for yahoo source. [optional]  
next_page String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseNews

get_company

View Intrinio API Documentation

Company get_company(identifier)

Lookup Company

Returns company reference and metadata such as tickers, CIK, and a unique company identifier, as well as company metadata such as business description, employee count, and company URL.

Example

# 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"

result = company_api.get_company(identifier)
pp result

Parameters

Name Type Description Notes
identifier String A Company identifier (Ticker, CIK, LEI, Intrinio ID)  

Return type

Company

get_company_answers

View Intrinio API Documentation

ApiResponseCompanyAnswers get_company_answers(identifier, query)

Company Answers

Returns answers for a question about the Company with the given identifier

Example

# 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"
query = "What do they believe in?"

result = company_api.get_company_answers(identifier, query)
pp result

Parameters

Name Type Description Notes
identifier String A Company identifier (Ticker, CIK, LEI, Intrinio ID)  
query String The query to ask the Thea API  

Return type

ApiResponseCompanyAnswers

get_company_daily_metrics

View Intrinio API Documentation

ApiResponseCompanyDailyMetrics get_company_daily_metrics(identifier, opts)

Company metrics by Company

Returns the latest company metrics.

Example

# 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 = {
  on_date: Date.parse("2013-10-20"),
  page_size: 100,
  next_page: nil,
  next_page2: nil
}

result = company_api.get_company_daily_metrics(identifier, opts)
pp result

Parameters

Name Type Description Notes
identifier String A Company identifier (Ticker, CIK, LEI, Intrinio ID)  
on_date Date Date of the metric [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]  
next_page2 String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseCompanyDailyMetrics

get_company_data_point_number

View Intrinio API Documentation

Float get_company_data_point_number(identifier, tag)

Data Point (Number) for Company

Returns latest value for calculations, metrics, and financial data points for a company.

Example

# 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"
tag = "marketcap"

result = company_api.get_company_data_point_number(identifier, tag)
pp result

Parameters

Name Type Description Notes
identifier String A Company identifier (Ticker, CIK, LEI, Intrinio ID)  
tag String An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a>)  

Return type

Float

get_company_data_point_text

View Intrinio API Documentation

String get_company_data_point_text(identifier, tag)

Data Point (Text) for Company

Returns latest value for metadata items for a company.

Example

# 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"
tag = "ceo"

result = company_api.get_company_data_point_text(identifier, tag)
pp result

Parameters

Name Type Description Notes
identifier String A Company identifier (Ticker, CIK, LEI, Intrinio ID)  
tag String An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a>)  

Return type

String

get_company_filings

View Intrinio API Documentation

ApiResponseCompanyFilings get_company_filings(identifier, opts)

All Filings by Company

Returns a complete list of SEC filings for the Company with the given identifier

Example

# 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 = {
  report_type: nil,
  start_date: Date.parse("2015-01-01"),
  end_date: nil,
  thea_enabled: nil,
  page_size: 100,
  next_page: nil
}

result = company_api.get_company_filings(identifier, opts)
pp result

Parameters

Name Type Description Notes
identifier String A Company identifier (Ticker, CIK, LEI, Intrinio ID)  
report_type String Filter by <a href=&quot;https://docs.intrinio.com/documentation/sec_filing_report_types\" target=&quot;_blank&quot;>report type</a>. Separate values with commas to return multiple report types. [optional]  
start_date Date Filed on or after the given date [optional]  
end_date Date Filed before or after the given date [optional]  
thea_enabled BOOLEAN Return filings that have been read by our Thea NLP and are ready for our answers endpoint [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]  

Return type

ApiResponseCompanyFilings

get_company_fundamentals

View Intrinio API Documentation

ApiResponseCompanyFundamentals get_company_fundamentals(identifier, opts)

All Fundamentals by Company

Returns a list of fundamentals with unique fundamental IDs associated with a particular company. Useful to obtain all historical and/or latest fundamental IDs for a given company to then use to loop through and pull all fundamental data available.

Example

# 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 = {
  filed_after: nil,
  filed_before: nil,
  reported_only: false,
  fiscal_year: nil,
  statement_code: nil,
  type: nil,
  start_date: nil,
  end_date: nil,
  updated_after: Date.parse("2022-12-01"),
  updated_before: Date.parse("2022-12-01"),
  page_size: 100,
  next_page: nil
}

result = company_api.get_company_fundamentals(identifier, opts)
pp result

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]  
updated_after Date Only include fundamentals where it was updated after this date. [optional]  
updated_before Date Only include fundamentals where it was updated before this date. [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]  

Return type

ApiResponseCompanyFundamentals

get_company_historical_data

View Intrinio API Documentation

ApiResponseCompanyHistoricalData get_company_historical_data(identifier, tag, opts)

Historical Data for Company

Returns historical values for the given tag and the Company with the given identifier

Example

# 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"
tag = "marketcap"

opts = {
  frequency: "daily",
  type: nil,
  start_date: Date.parse("2018-01-01"),
  end_date: nil,
  sort_order: "desc",
  page_size: 100,
  next_page: nil
}

result = company_api.get_company_historical_data(identifier, tag, opts)
pp result

Parameters

Name Type Description Notes
identifier String A Company identifier (Ticker, CIK, LEI, Intrinio ID)  
tag String An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a>)  
frequency String Return historical data in the given frequency [optional] [default to daily]  
type String Return historical data for given fiscal period type [optional]  
start_date Date Return historical data on or after this date [optional]  
end_date Date Return historical data on or before this date [optional]  
sort_order String Sort by date `asc` or `desc` [optional] [default to desc]  
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]  

Return type

ApiResponseCompanyHistoricalData

get_company_ipos

View Intrinio API Documentation

ApiResponseInitialPublicOfferings get_company_ipos(opts)

IPOs

Returns a list of historical, current, and upcoming initial public offerings (IPOs) across the major US Exchanges. Includes relevant information such as the IPO status, the offer amount, the total share count and target share price.

Example

# 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

opts = {
  ticker: "UBER",
  status: nil,
  start_date: nil,
  end_date: nil,
  offer_amount_greater_than: nil,
  offer_amount_less_than: nil,
  page_size: 100,
  next_page: nil
}

result = company_api.get_company_ipos(opts)
pp result

Parameters

Name Type Description Notes
ticker String Return IPOs with the given ticker (typically the IPO for the company) [optional]  
status String Return IPOs with the given status. Upcoming IPOs are scheduled to occur in the future. Priced IPOs have occurred and the company should be trading publicly. Withdrawn IPOs were planned to occurr but were withdrawn beforehand [optional]  
start_date Date Return IPOs on or after the given date [optional]  
end_date Date Return IPOs on or before the given date [optional]  
offer_amount_greater_than Integer Return IPOs with an offer dollar amount greater than the given amount [optional]  
offer_amount_less_than Integer Return IPOs with an offer dollar amount less than the given amount [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]  

Return type

ApiResponseInitialPublicOfferings

get_company_news

View Intrinio API Documentation

ApiResponseCompanyNews get_company_news(identifier, opts)

All News by Company

Returns the latest and historical news article links, headlines and summaries for a specified US traded company.

Example

# 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 = {
  specific_source: nil,
  page_size: 100,
  sentiment: nil,
  topic: nil,
  security: "AAPL",
  start_date: nil,
  end_date: nil,
  language: nil,
  word_count_greater_than: nil,
  word_count_less_than: nil,
  is_spam: nil,
  business_relevance_greater_than: nil,
  business_relevance_less_than: nil,
  next_page: nil
}

result = company_api.get_company_news(identifier, opts)
pp result

Parameters

Name Type Description Notes
identifier String A Company identifier (Ticker, CIK, LEI, Intrinio ID)  
specific_source String Only news from this source. Defaults to highest available if not present. [optional]  
page_size Integer The maximum number of results to return [optional] [default to 100]  
sentiment String Filter by sentiment. Unsupported for yahoo source. [optional]  
topic String Filter by topic. Unsupported for yahoo source. [optional]  
security String Filter by `security` identifier (ticker, figi, isin, cusip, Intrinio ID). Unsupported for yahoo source. [optional]  
start_date Date Limit news stories to those on or after this date. Defaults to yesterday if unspecified. [optional]  
end_date Date Limit news stories to those on or before this date [optional]  
language String Filter by language. Unsupported for yahoo source. [optional]  
word_count_greater_than Integer News stories will have a word count greater than this value. Unsupported for yahoo source. [optional]  
word_count_less_than Integer News stories will have a word count less than this value. Unsupported for yahoo source. [optional]  
is_spam BOOLEAN Filter whether it is marked as spam or not. Unsupported for yahoo source. [optional]  
business_relevance_greater_than Float News stories will have a business relevance score more than this value. Unsupported for yahoo source. [optional]  
business_relevance_less_than Float News stories will have a business relevance score less than this value. Unsupported for yahoo source. [optional]  
next_page String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseCompanyNews

get_company_news_body

View Intrinio API Documentation

ApiResponseCompanyNewsBody get_company_news_body(news_story_id, publication_date, opts)

News Article Body

Returns the body of a news article. This endpoint requires additional authorization beyond basic news access. Please see a representative for details.

Example

# 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
news_story_id = "new_aBcDef"
publication_date = DateTime.parse(nil)

opts = {
  specific_source: nil,
  next_page: nil
}

result = company_api.get_company_news_body(news_story_id, publication_date, opts)
pp result

Parameters

Name Type Description Notes
news_story_id String The identifier of the news story.  
publication_date DateTime The DateTime of the story.  
specific_source String Only news from this source. Defaults to highest available if not present. [optional]  
next_page String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseCompanyNewsBody

get_company_public_float

View Intrinio API Documentation

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.

Example

# 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

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]  

Return type

ApiResponseCompanyPublicFloatResult

get_company_securities

View Intrinio API Documentation

ApiResponseCompanySecurities get_company_securities(identifier, opts)

All Securities by Company

Returns a list of underlying securities with associated reference data tied to a given company identifier.

Example

# 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 = {
  next_page: nil
}

result = company_api.get_company_securities(identifier, opts)
pp result

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

insider_transaction_filings_by_company

View Intrinio API Documentation

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.

Example

# 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",
  next_page: nil,
  page_size: 1000,
  sort_by: "updated_on",
  next_page2: nil
}

result = company_api.insider_transaction_filings_by_company(identifier, opts)
pp result

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]  
next_page String Gets the next page of data from a previous API call [optional]  
page_size Integer The number of results to return [optional] [default to 1000]  
sort_by String The field to sort by. Default is 'filing_date'. [optional]  
next_page2 String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseInsiderTransactionFilings

latest_insider_transaction_filing_by_company

View Intrinio API Documentation

InsiderTransactionFiling latest_insider_transaction_filing_by_company(identifier, opts)

Latest Insider Transaction Filing by Company

Returns the latest insider transaction filing for a company.

Example

# 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 = {
  next_page: nil
}

result = company_api.latest_insider_transaction_filing_by_company(identifier, opts)
pp result

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

InsiderTransactionFiling

lookup_company_fundamental

View Intrinio API Documentation

Fundamental lookup_company_fundamental(identifier, statement_code, fiscal_period, fiscal_year)

Lookup Fundamental by Company

Returns the Fundamental for the Company with the given identifier and with the given parameters

Example

# 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"
statement_code = "income_statement"
fiscal_period = "FY"
fiscal_year = 2017

result = company_api.lookup_company_fundamental(identifier, statement_code, fiscal_period, fiscal_year)
pp result

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

recognize_company

View Intrinio API Documentation

ApiResponseCompanyRecognize recognize_company(text)

Recognize Company

Returns a list of companies recognized by the Thea API in the given text query string parameter.

Example

# 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
text = "Apple"

result = company_api.recognize_company(text)
pp result

Parameters

Name Type Description Notes
text String The text sent to the Thea API to analyze  

Return type

ApiResponseCompanyRecognize

search_companies

View Intrinio API Documentation

ApiResponseCompaniesSearch search_companies(query, opts)

Search Companies

Search the companies database and return a list of companies matching the text query parameter passed through. Query parameter searches across the company ticker and name.

Example

# 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
query = "Apple"

opts = {
  active: true,
  mode: nil,
  page_size: 100
}

result = company_api.search_companies(query, opts)
pp result

Parameters

Name Type Description Notes
query String Search parameters  
active BOOLEAN When true, return companies that are actively traded (having stock prices within the past 14 days). When false, return companies that are not actively traded or never have been traded. Not setting this value returns all. Not used when mode is set. [optional]  
mode String When set, changes search mode to the specified mode. [optional]  
page_size Integer The number of results to return [optional] [default to 100]  

Return type

ApiResponseCompaniesSearch

shares_outstanding_by_company

View Intrinio API Documentation

ApiResponseCompanySharesOutstanding shares_outstanding_by_company(identifier, opts)

Shares Outstanding by Company

Returns the shares outstanding reported on the front cover of the SEC 10-K and 10-Q filings.

Example

# 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 = {
  end_date_greater_than: nil,
  end_date_less_than: nil
}

result = company_api.shares_outstanding_by_company(identifier, opts)
pp result

Parameters

Name Type Description Notes
identifier String A Company identifier (Ticker, CIK, LEI, Intrinio ID)  
end_date_greater_than Date Returns shares outstanding after this date. [optional]  
end_date_less_than Date Returns shares outstanding before this date. [optional]  

Return type

ApiResponseCompanySharesOutstanding