Skip to content

Latest commit

 

History

History
2018 lines (1214 loc) · 54.5 KB

CompanyApi.md

File metadata and controls

2018 lines (1214 loc) · 54.5 KB

intrinioSDK.CompanyApi

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

Method HTTP request Description
getAllCompanies GET /companies All Companies
getAllCompaniesDailyMetrics GET /companies/daily_metrics All Companies daily metrics
getAllCompanyNews GET /companies/news All News
getCompany GET /companies/{identifier} Lookup Company
getCompanyAnswers GET /companies/{identifier}/answers Company Answers
getCompanyDailyMetrics GET /companies/{identifier}/daily_metrics Company metrics by Company
getCompanyDataPointNumber GET /companies/{identifier}/data_point/{tag}/number Data Point (Number) for Company
getCompanyDataPointText GET /companies/{identifier}/data_point/{tag}/text Data Point (Text) for Company
getCompanyFilings GET /companies/{identifier}/filings All Filings by Company
getCompanyFundamentals GET /companies/{identifier}/fundamentals All Fundamentals by Company
getCompanyHistoricalData GET /companies/{identifier}/historical_data/{tag} Historical Data for Company
getCompanyIpos GET /companies/ipos IPOs
getCompanyNews GET /companies/{identifier}/news All News by Company
getCompanyNewsBody GET /companies/news/body News Article Body
getCompanyPublicFloat GET /companies/{identifier}/public_float Get Company's public float
getCompanySecurities GET /companies/{identifier}/securities All Securities by Company
insiderTransactionFilingsByCompany GET /companies/{identifier}/insider_transaction_filings Insider Transaction Filings by Company
latestInsiderTransactionFilingByCompany GET /companies/{identifier}/insider_transaction_filings/latest Latest Insider Transaction Filing by Company
lookupCompanyFundamental GET /companies/{identifier}/fundamentals/lookup/{statement_code}/{fiscal_year}/{fiscal_period} Lookup Fundamental by Company
recognizeCompany GET /companies/recognize Recognize Company
searchCompanies GET /companies/search Search Companies
sharesOutstandingByCompany GET /companies/{identifier}/shares_outstanding Shares Outstanding by Company

getAllCompanies

View Intrinio API Documentation

ApiResponseCompanies getAllCompanies(opts)

All Companies

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

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var company = new intrinioSDK.CompanyApi();

var opts = { 
  'latestFilingDate': null,
  'sic': null,
  'template': null,
  'sector': null,
  'industryCategory': null,
  'industryGroup': null,
  'hasFundamentals': true,
  'hasStockPrices': true,
  'theaEnabled': null,
  'pageSize': 100,
  'nextPage': null
};

company.getAllCompanies(opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
latestFilingDate 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]  
industryCategory String Return companies in the given industry category [optional]  
industryGroup String Return companies in the given industry group [optional]  
hasFundamentals Boolean Return only companies that have fundamentals when true [optional]  
hasStockPrices Boolean Return only companies that have stock prices when true [optional]  
theaEnabled Boolean Return companies whose have been read by our Thea NLP and are ready for our company answers endpoint [optional]  
pageSize Number The number of results to return [optional] [default to 100]  
nextPage String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseCompanies

getAllCompaniesDailyMetrics

View Intrinio API Documentation

ApiResponseCompanyDailyMetrics getAllCompaniesDailyMetrics(opts)

All Companies daily metrics

Returns the company metrics for a date.

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var company = new intrinioSDK.CompanyApi();

var opts = { 
  'onDate': new Date("2013-10-20"),
  'pageSize': 100,
  'nextPage': null,
  'nextPage2': null
};

company.getAllCompaniesDailyMetrics(opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
onDate Date Date of the metric [optional]  
pageSize Number The number of results to return [optional] [default to 100]  
nextPage String Gets the next page of data from a previous API call [optional]  
nextPage2 String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseCompanyDailyMetrics

getAllCompanyNews

View Intrinio API Documentation

ApiResponseNews getAllCompanyNews(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

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var company = new intrinioSDK.CompanyApi();

var opts = { 
  'specificSource': null,
  'pageSize': 100,
  'sentiment': null,
  'topic': null,
  'company': "AAPL",
  'security': "AAPL",
  'startDate': null,
  'endDate': null,
  'language': null,
  'wordCountGreaterThan': null,
  'wordCountLessThan': null,
  'isSpam': null,
  'businessRelevanceGreaterThan': null,
  'businessRelevanceLessThan': null,
  'nextPage': null
};

company.getAllCompanyNews(opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
specificSource String Only news from this source. Defaults to highest available if not present. [optional]  
pageSize Number 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]  
startDate Date Limit news stories to those on or after this date. Defaults to yesterday if unspecified. [optional]  
endDate Date Limit news stories to those on or before this date. [optional]  
language String Filter by language. Unsupported for yahoo source. [optional]  
wordCountGreaterThan Number News stories will have a word count greater than this value. Unsupported for yahoo source. [optional]  
wordCountLessThan Number News stories will have a word count less than this value. Unsupported for yahoo source. [optional]  
isSpam Boolean Filter whether it is marked as spam or not. Unsupported for yahoo source. [optional]  
businessRelevanceGreaterThan Number News stories will have a business relevance score more than this value. Unsupported for yahoo source. [optional]  
businessRelevanceLessThan Number News stories will have a business relevance score less than this value. Unsupported for yahoo source. [optional]  
nextPage String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseNews

getCompany

View Intrinio API Documentation

Company getCompany(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

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var company = new intrinioSDK.CompanyApi();

var identifier = "AAPL";


company.getCompany(identifier).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

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

Return type

Company

getCompanyAnswers

View Intrinio API Documentation

ApiResponseCompanyAnswers getCompanyAnswers(identifier, query)

Company Answers

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

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var company = new intrinioSDK.CompanyApi();

var identifier = "AAPL";
var query = "What do they believe in?";


company.getCompanyAnswers(identifier, query).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

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

getCompanyDailyMetrics

View Intrinio API Documentation

ApiResponseCompanyDailyMetrics getCompanyDailyMetrics(identifier, opts)

Company metrics by Company

Returns the latest company metrics.

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var company = new intrinioSDK.CompanyApi();

var identifier = "AAPL";


var opts = { 
  'onDate': new Date("2013-10-20"),
  'pageSize': 100,
  'nextPage': null,
  'nextPage2': null
};

company.getCompanyDailyMetrics(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
identifier String A Company identifier (Ticker, CIK, LEI, Intrinio ID)  
onDate Date Date of the metric [optional]  
pageSize Number The number of results to return [optional] [default to 100]  
nextPage String Gets the next page of data from a previous API call [optional]  
nextPage2 String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseCompanyDailyMetrics

getCompanyDataPointNumber

View Intrinio API Documentation

'Number' getCompanyDataPointNumber(identifier, tag)

Data Point (Number) for Company

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

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var company = new intrinioSDK.CompanyApi();

var identifier = "AAPL";
var tag = "marketcap";


company.getCompanyDataPointNumber(identifier, tag).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

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

'Number'

getCompanyDataPointText

View Intrinio API Documentation

'String' getCompanyDataPointText(identifier, tag)

Data Point (Text) for Company

Returns latest value for metadata items for a company.

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var company = new intrinioSDK.CompanyApi();

var identifier = "AAPL";
var tag = "ceo";


company.getCompanyDataPointText(identifier, tag).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

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'

getCompanyFilings

View Intrinio API Documentation

ApiResponseCompanyFilings getCompanyFilings(identifier, opts)

All Filings by Company

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

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var company = new intrinioSDK.CompanyApi();

var identifier = "AAPL";


var opts = { 
  'reportType': null,
  'startDate': new Date("2015-01-01"),
  'endDate': null,
  'theaEnabled': null,
  'pageSize': 100,
  'nextPage': null
};

company.getCompanyFilings(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
identifier String A Company identifier (Ticker, CIK, LEI, Intrinio ID)  
reportType 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]  
startDate Date Filed on or after the given date [optional]  
endDate Date Filed before or after the given date [optional]  
theaEnabled Boolean Return filings that have been read by our Thea NLP and are ready for our answers endpoint [optional]  
pageSize Number The number of results to return [optional] [default to 100]  
nextPage String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseCompanyFilings

getCompanyFundamentals

View Intrinio API Documentation

ApiResponseCompanyFundamentals getCompanyFundamentals(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

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var company = new intrinioSDK.CompanyApi();

var identifier = "AAPL";


var opts = { 
  'filedAfter': null,
  'filedBefore': null,
  'reportedOnly': false,
  'fiscalYear': null,
  'statementCode': null,
  'type': null,
  'startDate': null,
  'endDate': null,
  'updatedAfter': new Date("2022-12-01"),
  'updatedBefore': new Date("2022-12-01"),
  'pageSize': 100,
  'nextPage': null
};

company.getCompanyFundamentals(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
identifier String A Company identifier (Ticker, CIK, LEI, Intrinio ID)  
filedAfter Date Filed on or after this date [optional]  
filedBefore Date Filed on or before this date [optional]  
reportedOnly Boolean Only as-reported fundamentals [optional]  
fiscalYear Number Only for the given fiscal year [optional]  
statementCode String Only of the given statement code [optional]  
type String Only of the given type [optional]  
startDate Date Only on or after the given date [optional]  
endDate Date Only on or before the given date [optional]  
updatedAfter Date Only include fundamentals where it was updated after this date. [optional]  
updatedBefore Date Only include fundamentals where it was updated before this date. [optional]  
pageSize Number The number of results to return [optional] [default to 100]  
nextPage String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseCompanyFundamentals

getCompanyHistoricalData

View Intrinio API Documentation

ApiResponseCompanyHistoricalData getCompanyHistoricalData(identifier, tag, opts)

Historical Data for Company

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

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var company = new intrinioSDK.CompanyApi();

var identifier = "AAPL";
var tag = "marketcap";


var opts = { 
  'frequency': "daily",
  'type': null,
  'startDate': new Date("2018-01-01"),
  'endDate': null,
  'sortOrder': "desc",
  'pageSize': 100,
  'nextPage': null
};

company.getCompanyHistoricalData(identifier, tag, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

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]  
startDate Date Return historical data on or after this date [optional]  
endDate Date Return historical data on or before this date [optional]  
sortOrder String Sort by date `asc` or `desc` [optional] [default to desc]  
pageSize Number The number of results to return [optional] [default to 100]  
nextPage String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseCompanyHistoricalData

getCompanyIpos

View Intrinio API Documentation

ApiResponseInitialPublicOfferings getCompanyIpos(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

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var company = new intrinioSDK.CompanyApi();

var opts = { 
  'ticker': "UBER",
  'status': null,
  'startDate': null,
  'endDate': null,
  'offerAmountGreaterThan': null,
  'offerAmountLessThan': null,
  'pageSize': 100,
  'nextPage': null
};

company.getCompanyIpos(opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

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]  
startDate Date Return IPOs on or after the given date [optional]  
endDate Date Return IPOs on or before the given date [optional]  
offerAmountGreaterThan Number Return IPOs with an offer dollar amount greater than the given amount [optional]  
offerAmountLessThan Number Return IPOs with an offer dollar amount less than the given amount [optional]  
pageSize Number The number of results to return [optional] [default to 100]  
nextPage String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseInitialPublicOfferings

getCompanyNews

View Intrinio API Documentation

ApiResponseCompanyNews getCompanyNews(identifier, opts)

All News by Company

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

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var company = new intrinioSDK.CompanyApi();

var identifier = "AAPL";


var opts = { 
  'specificSource': null,
  'pageSize': 100,
  'sentiment': null,
  'topic': null,
  'security': "AAPL",
  'startDate': null,
  'endDate': null,
  'language': null,
  'wordCountGreaterThan': null,
  'wordCountLessThan': null,
  'isSpam': null,
  'businessRelevanceGreaterThan': null,
  'businessRelevanceLessThan': null,
  'nextPage': null
};

company.getCompanyNews(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
identifier String A Company identifier (Ticker, CIK, LEI, Intrinio ID)  
specificSource String Only news from this source. Defaults to highest available if not present. [optional]  
pageSize Number 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]  
startDate Date Limit news stories to those on or after this date. Defaults to yesterday if unspecified. [optional]  
endDate Date Limit news stories to those on or before this date [optional]  
language String Filter by language. Unsupported for yahoo source. [optional]  
wordCountGreaterThan Number News stories will have a word count greater than this value. Unsupported for yahoo source. [optional]  
wordCountLessThan Number News stories will have a word count less than this value. Unsupported for yahoo source. [optional]  
isSpam Boolean Filter whether it is marked as spam or not. Unsupported for yahoo source. [optional]  
businessRelevanceGreaterThan Number News stories will have a business relevance score more than this value. Unsupported for yahoo source. [optional]  
businessRelevanceLessThan Number News stories will have a business relevance score less than this value. Unsupported for yahoo source. [optional]  
nextPage String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseCompanyNews

getCompanyNewsBody

View Intrinio API Documentation

ApiResponseCompanyNewsBody getCompanyNewsBody(newsStoryId, publicationDate, 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

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var company = new intrinioSDK.CompanyApi();

var newsStoryId = "new_aBcDef";
var publicationDate = null;


var opts = { 
  'specificSource': null,
  'nextPage': null
};

company.getCompanyNewsBody(newsStoryId, publicationDate, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
newsStoryId String The identifier of the news story.  
publicationDate Date The DateTime of the story.  
specificSource String Only news from this source. Defaults to highest available if not present. [optional]  
nextPage String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseCompanyNewsBody

getCompanyPublicFloat

View Intrinio API Documentation

ApiResponseCompanyPublicFloatResult getCompanyPublicFloat(identifier, opts)

Get Company's public float

Returns a list of public float data tied to a given company identifier.

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var company = new intrinioSDK.CompanyApi();

var identifier = "AAPL";


var opts = { 
  'floatDateGreaterThan': null,
  'floatDateLessThan': null,
  'nextPage': null,
  'nextPage2': null
};

company.getCompanyPublicFloat(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
identifier String A Company identifier (Ticker, CIK, LEI, Intrinio ID)  
floatDateGreaterThan Date The lower-bound date for the data being requested. [optional]  
floatDateLessThan Date The upper-bound date for the data being requested. [optional]  
nextPage String Gets the next page of data from a previous API call [optional]  
nextPage2 String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseCompanyPublicFloatResult

getCompanySecurities

View Intrinio API Documentation

ApiResponseCompanySecurities getCompanySecurities(identifier, opts)

All Securities by Company

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

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var company = new intrinioSDK.CompanyApi();

var identifier = "AAPL";


var opts = { 
  'nextPage': null
};

company.getCompanySecurities(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
identifier String A Company identifier (Ticker, CIK, LEI, Intrinio ID)  
nextPage String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseCompanySecurities

insiderTransactionFilingsByCompany

View Intrinio API Documentation

ApiResponseInsiderTransactionFilings insiderTransactionFilingsByCompany(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

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var company = new intrinioSDK.CompanyApi();

var identifier = "AAPL";


var opts = { 
  'startDate': new Date("2018-01-01"),
  'endDate': new Date("2019-01-01"),
  'ownershipType': "D",
  'nextPage': null,
  'pageSize': 1000,
  'sortBy': "updated_on",
  'nextPage2': null
};

company.insiderTransactionFilingsByCompany(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
identifier String A Company identifier (Ticker, CIK, LEI, Intrinio ID)  
startDate Date Return Company's insider transaction filings on or after this date [optional]  
endDate Date Return Company's insider transaction filings on or before this date [optional]  
ownershipType 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]  
nextPage String Gets the next page of data from a previous API call [optional]  
pageSize Number The number of results to return [optional] [default to 1000]  
sortBy String The field to sort by. Default is 'filing_date'. [optional]  
nextPage2 String Gets the next page of data from a previous API call [optional]  

Return type

ApiResponseInsiderTransactionFilings

latestInsiderTransactionFilingByCompany

View Intrinio API Documentation

InsiderTransactionFiling latestInsiderTransactionFilingByCompany(identifier, opts)

Latest Insider Transaction Filing by Company

Returns the latest insider transaction filing for a company.

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var company = new intrinioSDK.CompanyApi();

var identifier = "AAPL";


var opts = { 
  'nextPage': null
};

company.latestInsiderTransactionFilingByCompany(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
identifier String A Company identifier (Ticker, CIK, LEI, Intrinio ID)  
nextPage String Gets the next page of data from a previous API call [optional]  

Return type

InsiderTransactionFiling

lookupCompanyFundamental

View Intrinio API Documentation

Fundamental lookupCompanyFundamental(identifier, statementCode, fiscalPeriod, fiscalYear)

Lookup Fundamental by Company

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

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var company = new intrinioSDK.CompanyApi();

var identifier = "AAPL";
var statementCode = "income_statement";
var fiscalPeriod = "FY";
var fiscalYear = 2017;


company.lookupCompanyFundamental(identifier, statementCode, fiscalPeriod, fiscalYear).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
identifier String A Company identifier (Ticker, CIK, LEI, Intrinio ID)  
statementCode String The statement code  
fiscalPeriod String The fiscal period  
fiscalYear Number The fiscal year  

Return type

Fundamental

recognizeCompany

View Intrinio API Documentation

ApiResponseCompanyRecognize recognizeCompany(text)

Recognize Company

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

Example

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var company = new intrinioSDK.CompanyApi();

var text = "Apple";


company.recognizeCompany(text).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

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

Return type

ApiResponseCompanyRecognize

searchCompanies

View Intrinio API Documentation

ApiResponseCompaniesSearch searchCompanies(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

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var company = new intrinioSDK.CompanyApi();

var query = "Apple";


var opts = { 
  'active': true,
  'mode': null,
  'pageSize': 100
};

company.searchCompanies(query, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

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]  
pageSize Number The number of results to return [optional] [default to 100]  

Return type

ApiResponseCompaniesSearch

sharesOutstandingByCompany

View Intrinio API Documentation

ApiResponseCompanySharesOutstanding sharesOutstandingByCompany(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

var intrinioSDK = require('intrinio-sdk');
intrinioSDK.ApiClient.instance.authentications['ApiKeyAuth'].apiKey = "YOUR_API_KEY";
intrinioSDK.ApiClient.instance.enableRetries = true;

var company = new intrinioSDK.CompanyApi();

var identifier = "AAPL";


var opts = { 
  'endDateGreaterThan': null,
  'endDateLessThan': null
};

company.sharesOutstandingByCompany(identifier, opts).then(function(data) {
  data = JSON.stringify(data, null, 2)
  console.log(data);
}, function(error) {
  console.error(error);
});

Parameters

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

Return type

ApiResponseCompanySharesOutstanding