Skip to content

Latest commit

 

History

History
2088 lines (1358 loc) · 63.9 KB

CompanyApi.md

File metadata and controls

2088 lines (1358 loc) · 63.9 KB

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(latestFilingDate, sic, template, sector, industryCategory, industryGroup, hasFundamentals, hasStockPrices, theaEnabled, pageSize, nextPage)

All Companies

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

Example

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    CompanyApi companyApi = new CompanyApi();
    LocalDate latestFilingDate = null;
    String sic = null;
    String template = null;
    String sector = null;
    String industryCategory = null;
    String industryGroup = null;
    Boolean hasFundamentals = true;
    Boolean hasStockPrices = true;
    Boolean theaEnabled = null;
    Integer pageSize = 100;
    String nextPage = null;
    ApiResponseCompanies result = companyApi.getAllCompanies(latestFilingDate, sic, template, sector, industryCategory, industryGroup, hasFundamentals, hasStockPrices, theaEnabled, pageSize, nextPage);
    System.out.println(result);
  }
}

Parameters

Name Type Description Notes
latestFilingDate LocalDate 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] [enum: indu, fin]  
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 Integer 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(onDate, pageSize, nextPage, nextPage2)

All Companies daily metrics

Returns the company metrics for a date.

Example

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    CompanyApi companyApi = new CompanyApi();
    LocalDate onDate = LocalDate.of();
    Integer pageSize = 100;
    String nextPage = null;
    String nextPage2 = null;
    ApiResponseCompanyDailyMetrics result = companyApi.getAllCompaniesDailyMetrics(onDate, pageSize, nextPage, nextPage2);
    System.out.println(result);
  }
}

Parameters

Name Type Description Notes
onDate LocalDate Date of the metric [optional]  
pageSize Integer 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(specificSource, pageSize, sentiment, topic, company, security, startDate, endDate, language, wordCountGreaterThan, wordCountLessThan, isSpam, businessRelevanceGreaterThan, businessRelevanceLessThan, nextPage)

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

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    CompanyApi companyApi = new CompanyApi();
    String specificSource = null;
    Integer pageSize = 100;
    String sentiment = null;
    String topic = null;
    String company = "AAPL";
    String security = "AAPL";
    LocalDate startDate = null;
    LocalDate endDate = null;
    String language = null;
    Integer wordCountGreaterThan = null;
    Integer wordCountLessThan = null;
    Boolean isSpam = null;
    BigDecimal businessRelevanceGreaterThan = null;
    BigDecimal businessRelevanceLessThan = null;
    String nextPage = null;
    ApiResponseNews result = companyApi.getAllCompanyNews(specificSource, pageSize, sentiment, topic, company, security, startDate, endDate, language, wordCountGreaterThan, wordCountLessThan, isSpam, businessRelevanceGreaterThan, businessRelevanceLessThan, nextPage);
    System.out.println(result);
  }
}

Parameters

Name Type Description Notes
specificSource String Only news from this source. Defaults to highest available if not present. [optional] [enum: yahoo, moody, moody_us_news, moody_us_press_releases]  
pageSize Integer The maximum number of results to return. [optional] [default to 100]  
sentiment String Filter by sentiment. Unsupported for yahoo source. [optional] [enum: positive, neutral, negative]  
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 LocalDate Limit news stories to those on or after this date. Defaults to yesterday if unspecified. [optional]  
endDate LocalDate Limit news stories to those on or before this date. [optional]  
language String Filter by language. Unsupported for yahoo source. [optional]  
wordCountGreaterThan Integer News stories will have a word count greater than this value. Unsupported for yahoo source. [optional]  
wordCountLessThan Integer 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 BigDecimal News stories will have a business relevance score more than this value. Unsupported for yahoo source. [optional]  
businessRelevanceLessThan BigDecimal 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

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    CompanyApi companyApi = new CompanyApi();
    String identifier = "AAPL";
    Company result = companyApi.getCompany(identifier);
    System.out.println(result);
  }
}

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

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    CompanyApi companyApi = new CompanyApi();
    String identifier = "AAPL";
    String query = "What do they believe in?";
    ApiResponseCompanyAnswers result = companyApi.getCompanyAnswers(identifier, query);
    System.out.println(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

getCompanyDailyMetrics

View Intrinio API Documentation

ApiResponseCompanyDailyMetrics getCompanyDailyMetrics(identifier, onDate, pageSize, nextPage, nextPage2)

Company metrics by Company

Returns the latest company metrics.

Example

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    CompanyApi companyApi = new CompanyApi();
    String identifier = "AAPL";
    LocalDate onDate = LocalDate.of();
    Integer pageSize = 100;
    String nextPage = null;
    String nextPage2 = null;
    ApiResponseCompanyDailyMetrics result = companyApi.getCompanyDailyMetrics(identifier, onDate, pageSize, nextPage, nextPage2);
    System.out.println(result);
  }
}

Parameters

Name Type Description Notes
identifier String A Company identifier (Ticker, CIK, LEI, Intrinio ID)  
onDate LocalDate Date of the metric [optional]  
pageSize Integer 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

BigDecimal getCompanyDataPointNumber(identifier, tag)

Data Point (Number) for Company

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

Example

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    CompanyApi companyApi = new CompanyApi();
    String identifier = "AAPL";
    String tag = "marketcap";
    BigDecimal result = companyApi.getCompanyDataPointNumber(identifier, tag);
    System.out.println(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

BigDecimal

getCompanyDataPointText

View Intrinio API Documentation

String getCompanyDataPointText(identifier, tag)

Data Point (Text) for Company

Returns latest value for metadata items for a company.

Example

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    CompanyApi companyApi = new CompanyApi();
    String identifier = "AAPL";
    String tag = "ceo";
    String result = companyApi.getCompanyDataPointText(identifier, tag);
    System.out.println(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

getCompanyFilings

View Intrinio API Documentation

ApiResponseCompanyFilings getCompanyFilings(identifier, reportType, startDate, endDate, theaEnabled, pageSize, nextPage)

All Filings by Company

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

Example

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    CompanyApi companyApi = new CompanyApi();
    String identifier = "AAPL";
    String reportType = null;
    LocalDate startDate = LocalDate.of(2015,1,01);
    LocalDate endDate = null;
    Boolean theaEnabled = null;
    Integer pageSize = 100;
    String nextPage = null;
    ApiResponseCompanyFilings result = companyApi.getCompanyFilings(identifier, reportType, startDate, endDate, theaEnabled, pageSize, nextPage);
    System.out.println(result);
  }
}

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 LocalDate Filed on or after the given date [optional]  
endDate LocalDate 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 Integer 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, filedAfter, filedBefore, reportedOnly, fiscalYear, statementCode, type, startDate, endDate, updatedAfter, updatedBefore, pageSize, nextPage)

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

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    CompanyApi companyApi = new CompanyApi();
    String identifier = "AAPL";
    LocalDate filedAfter = null;
    LocalDate filedBefore = null;
    Boolean reportedOnly = false;
    Integer fiscalYear = null;
    String statementCode = null;
    String type = null;
    LocalDate startDate = null;
    LocalDate endDate = null;
    LocalDate updatedAfter = LocalDate.of(2022,12,01);
    LocalDate updatedBefore = LocalDate.of(2022,12,01);
    Integer pageSize = 100;
    String nextPage = null;
    ApiResponseCompanyFundamentals result = companyApi.getCompanyFundamentals(identifier, filedAfter, filedBefore, reportedOnly, fiscalYear, statementCode, type, startDate, endDate, updatedAfter, updatedBefore, pageSize, nextPage);
    System.out.println(result);
  }
}

Parameters

Name Type Description Notes
identifier String A Company identifier (Ticker, CIK, LEI, Intrinio ID)  
filedAfter LocalDate Filed on or after this date [optional]  
filedBefore LocalDate Filed on or before this date [optional]  
reportedOnly Boolean Only as-reported fundamentals [optional]  
fiscalYear Integer Only for the given fiscal year [optional]  
statementCode String Only of the given statement code [optional] [enum: income_statement, balance_sheet_statement, cash_flow_statement, calculations]  
type String Only of the given type [optional] [enum: QTR, YTD, FY, TTM]  
startDate LocalDate Only on or after the given date [optional]  
endDate LocalDate Only on or before the given date [optional]  
updatedAfter LocalDate Only include fundamentals where it was updated after this date. [optional]  
updatedBefore LocalDate Only include fundamentals where it was updated before this date. [optional]  
pageSize Integer 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, frequency, type, startDate, endDate, sortOrder, pageSize, nextPage)

Historical Data for Company

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

Example

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    CompanyApi companyApi = new CompanyApi();
    String identifier = "AAPL";
    String tag = "marketcap";
    String frequency = "daily";
    String type = null;
    LocalDate startDate = LocalDate.of(2018,1,01);
    LocalDate endDate = null;
    String sortOrder = "desc";
    Integer pageSize = 100;
    String nextPage = null;
    ApiResponseCompanyHistoricalData result = companyApi.getCompanyHistoricalData(identifier, tag, frequency, type, startDate, endDate, sortOrder, pageSize, nextPage);
    System.out.println(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] [enum: daily, weekly, monthly, quarterly, yearly]  
type String Return historical data for given fiscal period type [optional] [enum: FY, QTR, TTM]  
startDate LocalDate Return historical data on or after this date [optional]  
endDate LocalDate Return historical data on or before this date [optional]  
sortOrder String Sort by date `asc` or `desc` [optional] [default to desc] [enum: asc, desc]  
pageSize Integer 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(ticker, status, startDate, endDate, offerAmountGreaterThan, offerAmountLessThan, pageSize, nextPage)

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

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    CompanyApi companyApi = new CompanyApi();
    String ticker = "UBER";
    String status = null;
    LocalDate startDate = null;
    LocalDate endDate = null;
    Integer offerAmountGreaterThan = null;
    Integer offerAmountLessThan = null;
    Integer pageSize = 100;
    String nextPage = null;
    ApiResponseInitialPublicOfferings result = companyApi.getCompanyIpos(ticker, status, startDate, endDate, offerAmountGreaterThan, offerAmountLessThan, pageSize, nextPage);
    System.out.println(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] [enum: upcoming, priced, withdrawn]  
startDate LocalDate Return IPOs on or after the given date [optional]  
endDate LocalDate Return IPOs on or before the given date [optional]  
offerAmountGreaterThan Integer Return IPOs with an offer dollar amount greater than the given amount [optional]  
offerAmountLessThan Integer Return IPOs with an offer dollar amount less than the given amount [optional]  
pageSize Integer 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, specificSource, pageSize, sentiment, topic, security, startDate, endDate, language, wordCountGreaterThan, wordCountLessThan, isSpam, businessRelevanceGreaterThan, businessRelevanceLessThan, nextPage)

All News by Company

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

Example

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    CompanyApi companyApi = new CompanyApi();
    String identifier = "AAPL";
    String specificSource = null;
    Integer pageSize = 100;
    String sentiment = null;
    String topic = null;
    String security = "AAPL";
    LocalDate startDate = null;
    LocalDate endDate = null;
    String language = null;
    Integer wordCountGreaterThan = null;
    Integer wordCountLessThan = null;
    Boolean isSpam = null;
    BigDecimal businessRelevanceGreaterThan = null;
    BigDecimal businessRelevanceLessThan = null;
    String nextPage = null;
    ApiResponseCompanyNews result = companyApi.getCompanyNews(identifier, specificSource, pageSize, sentiment, topic, security, startDate, endDate, language, wordCountGreaterThan, wordCountLessThan, isSpam, businessRelevanceGreaterThan, businessRelevanceLessThan, nextPage);
    System.out.println(result);
  }
}

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] [enum: yahoo, moody, moody_us_news, moody_us_press_releases]  
pageSize Integer The maximum number of results to return [optional] [default to 100]  
sentiment String Filter by sentiment. Unsupported for yahoo source. [optional] [enum: positive, neutral, negative]  
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 LocalDate Limit news stories to those on or after this date. Defaults to yesterday if unspecified. [optional]  
endDate LocalDate Limit news stories to those on or before this date [optional]  
language String Filter by language. Unsupported for yahoo source. [optional]  
wordCountGreaterThan Integer News stories will have a word count greater than this value. Unsupported for yahoo source. [optional]  
wordCountLessThan Integer 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 BigDecimal News stories will have a business relevance score more than this value. Unsupported for yahoo source. [optional]  
businessRelevanceLessThan BigDecimal 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, specificSource, nextPage)

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

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    CompanyApi companyApi = new CompanyApi();
    String newsStoryId = "new_aBcDef";
    OffsetDateTime publicationDate = OffsetDateTime.now();
    String specificSource = null;
    String nextPage = null;
    ApiResponseCompanyNewsBody result = companyApi.getCompanyNewsBody(newsStoryId, publicationDate, specificSource, nextPage);
    System.out.println(result);
  }
}

Parameters

Name Type Description Notes
newsStoryId String The identifier of the news story.  
publicationDate OffsetDateTime The DateTime of the story.  
specificSource String Only news from this source. Defaults to highest available if not present. [optional] [enum: yahoo, moody, moody_us_news, moody_us_press_releases]  
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, floatDateGreaterThan, floatDateLessThan, nextPage, nextPage2)

Get Company's public float

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

Example

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    CompanyApi companyApi = new CompanyApi();
    String identifier = "AAPL";
    LocalDate floatDateGreaterThan = null;
    LocalDate floatDateLessThan = null;
    String nextPage = null;
    String nextPage2 = null;
    ApiResponseCompanyPublicFloatResult result = companyApi.getCompanyPublicFloat(identifier, floatDateGreaterThan, floatDateLessThan, nextPage, nextPage2);
    System.out.println(result);
  }
}

Parameters

Name Type Description Notes
identifier String A Company identifier (Ticker, CIK, LEI, Intrinio ID)  
floatDateGreaterThan LocalDate The lower-bound date for the data being requested. [optional]  
floatDateLessThan LocalDate 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, nextPage)

All Securities by Company

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

Example

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    CompanyApi companyApi = new CompanyApi();
    String identifier = "AAPL";
    String nextPage = null;
    ApiResponseCompanySecurities result = companyApi.getCompanySecurities(identifier, nextPage);
    System.out.println(result);
  }
}

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, startDate, endDate, ownershipType, nextPage, pageSize, sortBy, nextPage2)

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

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    CompanyApi companyApi = new CompanyApi();
    String identifier = "AAPL";
    LocalDate startDate = LocalDate.of(2018,1,01);
    LocalDate endDate = LocalDate.of(2019,1,01);
    String ownershipType = "D";
    String nextPage = null;
    Integer pageSize = 1000;
    String sortBy = "updated_on";
    String nextPage2 = null;
    ApiResponseInsiderTransactionFilings result = companyApi.insiderTransactionFilingsByCompany(identifier, startDate, endDate, ownershipType, nextPage, pageSize, sortBy, nextPage2);
    System.out.println(result);
  }
}

Parameters

Name Type Description Notes
identifier String A Company identifier (Ticker, CIK, LEI, Intrinio ID)  
startDate LocalDate Return Company's insider transaction filings on or after this date [optional]  
endDate LocalDate 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 Integer The number of results to return [optional] [default to 1000]  
sortBy String The field to sort by. Default is 'filing_date'. [optional] [enum: filing_date, updated_on]  
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, nextPage)

Latest Insider Transaction Filing by Company

Returns the latest insider transaction filing for a company.

Example

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    CompanyApi companyApi = new CompanyApi();
    String identifier = "AAPL";
    String nextPage = null;
    InsiderTransactionFiling result = companyApi.latestInsiderTransactionFilingByCompany(identifier, nextPage);
    System.out.println(result);
  }
}

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

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    CompanyApi companyApi = new CompanyApi();
    String identifier = "AAPL";
    String statementCode = "income_statement";
    String fiscalPeriod = "FY";
    Integer fiscalYear = 2017;
    Fundamental result = companyApi.lookupCompanyFundamental(identifier, statementCode, fiscalPeriod, fiscalYear);
    System.out.println(result);
  }
}

Parameters

Name Type Description Notes
identifier String A Company identifier (Ticker, CIK, LEI, Intrinio ID)  
statementCode String The statement code [enum: income_statement, balance_sheet_statement, cash_flow_statement, calculations]  
fiscalPeriod String The fiscal period [enum: Q1TTM, Q2TTM, Q3TTM, FY, Q1, Q2, Q3, Q4, Q2YTD, Q3YTD]  
fiscalYear Integer 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

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    CompanyApi companyApi = new CompanyApi();
    String text = "Apple";
    ApiResponseCompanyRecognize result = companyApi.recognizeCompany(text);
    System.out.println(result);
  }
}

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, active, mode, pageSize)

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

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    CompanyApi companyApi = new CompanyApi();
    String query = "Apple";
    Boolean active = true;
    String mode = null;
    Integer pageSize = 100;
    ApiResponseCompaniesSearch result = companyApi.searchCompanies(query, active, mode, pageSize);
    System.out.println(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] [enum: starts_with]  
pageSize Integer The number of results to return [optional] [default to 100]  

Return type

ApiResponseCompaniesSearch

sharesOutstandingByCompany

View Intrinio API Documentation

ApiResponseCompanySharesOutstanding sharesOutstandingByCompany(identifier, endDateGreaterThan, endDateLessThan)

Shares Outstanding by Company

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

Example

import com.intrinio.api.*;
import com.intrinio.models.*;
import com.intrinio.invoker.*;
import com.intrinio.invoker.auth.*;
import org.threeten.bp.*;
import java.math.BigDecimal;
import java.util.*;

public class Main {
  public static void main(String[] args) throws Exception {

    ApiClient defaultClient = Configuration.getDefaultApiClient();
    ApiKeyAuth auth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
    auth.setApiKey("YOUR_API_KEY");
    defaultClient.setAllowRetries(true);

    CompanyApi companyApi = new CompanyApi();
    String identifier = "AAPL";
    LocalDate endDateGreaterThan = null;
    LocalDate endDateLessThan = null;
    ApiResponseCompanySharesOutstanding result = companyApi.sharesOutstandingByCompany(identifier, endDateGreaterThan, endDateLessThan);
    System.out.println(result);
  }
}

Parameters

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

Return type

ApiResponseCompanySharesOutstanding