Skip to content

FundamentalsApi.md

Latest commit

 

History

History
550 lines (348 loc) · 16.7 KB

FundamentalsApi.md

File metadata and controls

550 lines (348 loc) · 16.7 KB

FundamentalsApi

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

Method HTTP request Description
filterFundamental GET /fundamentals Filter Fundamental
getFundamentalById GET /fundamentals/{id} Fundamental by ID
getFundamentalReportedFinancials GET /fundamentals/{id}/reported_financials Reported Financials
getFundamentalStandardizedFinancials GET /fundamentals/{id}/standardized_financials Standardized Financials
getFundamentalStandardizedFinancialsDimensions GET /fundamentals/{id}/standardized_financials/dimensions/{tag} Standardized Financials Dimensions
lookupFundamental GET /fundamentals/lookup/{identifier}/{statement_code}/{fiscal_year}/{fiscal_period} Lookup Fundamental

filterFundamental

View Intrinio API Documentation

Fundamental filterFundamental(filedAfter, filedBefore, reportedOnly, fiscalYear, statementCode, type, fiscalPeriod, startDate, endDate, updatedAfter, updatedBefore, template, nextPage)

Filter Fundamental

Returns fundamentals that meet the set of filters specified in 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);

    FundamentalsApi fundamentalsApi = new FundamentalsApi();
    LocalDate filedAfter = LocalDate.of(2022,1,01);
    LocalDate filedBefore = LocalDate.of(2022,12,01);
    Boolean reportedOnly = false;
    Integer fiscalYear = 2017;
    String statementCode = null;
    String type = "false";
    String fiscalPeriod = "FY";
    LocalDate startDate = LocalDate.of(2022,1,01);
    LocalDate endDate = LocalDate.of(2022,12,01);
    LocalDate updatedAfter = LocalDate.of(2022,12,01);
    LocalDate updatedBefore = LocalDate.of(2022,12,01);
    String template = "indu";
    String nextPage = null;
    Fundamental result = fundamentalsApi.filterFundamental(filedAfter, filedBefore, reportedOnly, fiscalYear, statementCode, type, fiscalPeriod, startDate, endDate, updatedAfter, updatedBefore, template, nextPage);
    System.out.println(result);
  }
}

Parameters

Name Type Description Notes
filedAfter LocalDate Only include fundamentals that were filed on or after this date. [optional]  
filedBefore LocalDate Only include fundamentals that were 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]  
fiscalPeriod String The fiscal period [optional] [enum: Q1TTM, Q2TTM, Q3TTM, FY, Q1, Q2, Q3, Q4, Q2YTD, Q3YTD]  
startDate LocalDate Only include fundamentals where covered period is on or after this date. [optional]  
endDate LocalDate Only include fundamentals where covered period is on or before this 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]  
template String The financial statement template used by Intrinio to standardize the as reported data [optional] [enum: fin, indu]  
nextPage String Gets the next page of data from a previous API call [optional]  

Return type

Fundamental

getFundamentalById

View Intrinio API Documentation

Fundamental getFundamentalById(id)

Fundamental by ID

Returns a specific fundamental associated with a particular unique fundamental ID. Useful for pulling reference data for a specific fundamental.

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);

    FundamentalsApi fundamentalsApi = new FundamentalsApi();
    String id = "fun_ge9LlE";
    Fundamental result = fundamentalsApi.getFundamentalById(id);
    System.out.println(result);
  }
}

Parameters

Name Type Description Notes
id String The Intrinio ID for the Fundamental  

Return type

Fundamental

getFundamentalReportedFinancials

View Intrinio API Documentation

ApiResponseReportedFinancials getFundamentalReportedFinancials(id)

Reported Financials

Returns as-reported financial statement data for income statement, balance sheet, and cash flow statement. Data for income statement and cash flow statement is available on a FY, QTR (Q1, Q2, Q3, Q4), TTM (Q1TTM, Q2TTM, Q3TTM), and YTD (Q2YTD, Q3YTD) basis. Data for the balance sheet is available on a FY or QTR (Q1, Q2, Q3, Q4) basis only due its point-in-time nature.

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);

    FundamentalsApi fundamentalsApi = new FundamentalsApi();
    String id = "AAPL-income_statement-2018-Q1";
    ApiResponseReportedFinancials result = fundamentalsApi.getFundamentalReportedFinancials(id);
    System.out.println(result);
  }
}

Parameters

Name Type Description Notes
id String The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental  

Return type

ApiResponseReportedFinancials

getFundamentalStandardizedFinancials

View Intrinio API Documentation

ApiResponseStandardizedFinancials getFundamentalStandardizedFinancials(id)

Standardized Financials

Returns standardized financial statement data for income statement, balance sheet, cash flow statement and over 100 associated calculations for a given company. Data for income statement, cash flow statement, and calculations is available on a FY, QTR (Q1, Q2, Q3, Q4), TTM (Q1TTM, Q2TTM, Q3TTM), and YTD (Q2YTD, Q3YTD) basis. Data for the balance sheet is available on a FY or QTR (Q1, Q2, Q3, Q4) basis only due its point-in-time nature.

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);

    FundamentalsApi fundamentalsApi = new FundamentalsApi();
    String id = "AAPL-income_statement-2018-Q1";
    ApiResponseStandardizedFinancials result = fundamentalsApi.getFundamentalStandardizedFinancials(id);
    System.out.println(result);
  }
}

Parameters

Name Type Description Notes
id String The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental  

Return type

ApiResponseStandardizedFinancials

getFundamentalStandardizedFinancialsDimensions

View Intrinio API Documentation

ApiResponseStandardizedFinancialsDimensions getFundamentalStandardizedFinancialsDimensions(id, tag)

Standardized Financials Dimensions

Returns as reported dimensionality of a data tag

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);

    FundamentalsApi fundamentalsApi = new FundamentalsApi();
    String id = "AAPL-income_statement-2020-FY";
    String tag = "ceo";
    ApiResponseStandardizedFinancialsDimensions result = fundamentalsApi.getFundamentalStandardizedFinancialsDimensions(id, tag);
    System.out.println(result);
  }
}

Parameters

Name Type Description Notes
id String The Intrinio ID or lookup code (ticker-statement-year-period) for the Fundamental  
tag String An Intrinio data tag ID or code (<a href='https://data.intrinio.com/data-tags&#39;&gt;reference&lt;/a>)  

Return type

ApiResponseStandardizedFinancialsDimensions

lookupFundamental

View Intrinio API Documentation

Fundamental lookupFundamental(identifier, statementCode, fiscalYear, fiscalPeriod)

Lookup Fundamental

Returns a specific fundamental with unique fundamental ID associated with a particular company, year, period and statement. Useful for pulling the unique fundamental ID and reference data for a specific fundamental.

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);

    FundamentalsApi fundamentalsApi = new FundamentalsApi();
    String identifier = "AAPL";
    String statementCode = "income_statement";
    Integer fiscalYear = 2017;
    String fiscalPeriod = "FY";
    Fundamental result = fundamentalsApi.lookupFundamental(identifier, statementCode, fiscalYear, fiscalPeriod);
    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]  
fiscalYear Integer The fiscal year  
fiscalPeriod String The fiscal period [enum: Q1TTM, Q2TTM, Q3TTM, FY, Q1, Q2, Q3, Q4, Q2YTD, Q3YTD]  

Return type

Fundamental