#Model Editor Functions
To make it easy to access and process financial data from the API within valuation models, we have the following functions with their respective endpoints.
Function Name | Endpoint | Description |
---|---|---|
get_income_statement | /api/income-statement/AAPL/ | Income Statement Annual |
get_income_statement_quarterly | /api/income-statement/quarterly/AAPL/ | Income Statement Quarterly |
get_income_statement_ltm | /api/income-statement/ltm/AAPL/ | Income Statement LTM |
get_balance_sheet_statement | /api/balance-sheet-statement/AAPL/ | Balance Sheet Statement Annual |
get_balance_sheet_statement_quarterly | /api/balance-sheet-statement/quarterly/AAPL/ | Balance Sheet Statement Quarterly |
get_cash_flow_statement | /api/cash-flow-statement/AAPL/ | Cash Flow Statement Annual |
get_cash_flow_statement_quarterly | /api/cash-flow-statement/quarterly/AAPL/ | Cash Flow Statement Quarterly |
get_cash_flow_statement_ltm | /api/cash-flow-statement/ltm/AAPL/ | Cash Flow Statement LTM |
get_analyst_estimates | /api/analyst-estimates/AAPL/ | Annual Analyst Estimates |
get_quote | /api/quote/AAPL/ | Stock Market Quotes |
get_profile | /api/profile/AAPL/ | Company's Profile |
get_treasury | /api/treasury/ | Latest Treasury Rates |
get_treasury_daily | /api/treasury/daily/ | Daily Treasury Rates (Full History) |
get_treasury_monthly | /api/treasury/monthly/ | Monthly Treasury Rates (Full History) |
get_treasury_annual | /api/treasury/annual/ | Annual Treasury Rates (Full History) |
get_ratios | /api/ratios/AAPL/ | Financial Ratios Annual |
get_ratios_quarterly | /api/ratios/quarterly/AAPL/ | Financial Ratios Quarterly |
get_ratios_ltm | /api/ratios/ltm/AAPL/ | Financial Ratios LTM |
get_dividends_annual | /api/dividends/AAPL/ | Annually adjusted dividends |
get_dividends_quarterly | /api/dividends/quarterly/AAPL/ | Quarterly adjusted dividends |
get_dividends_reported | /api/dividends/reported/AAPL/ | Dividends as reported |
get_prices_timestamp() | /api/prices/timestamp/1hour/AAPL/ | Available parameters: [1min, 5min, 15min, 30min, 1hour, 4hour] |
get_prices_daily | /api/prices/daily/AAPL/ | Full history of daily market prices |
get_prices_annual | /api/prices/annual/AAPL/ | Full history of market share prices for each year |
get_cpi_annual | /api/economic/annual/CPI/ | Annual CPI Data |
get_fx | /api/fx/ | FX Market Prices for all currencies |
get_risk_premium | /api/risk-premium/ | Equity Risk Premium for all countries |
#Using functions within the Code Editor
To use the API functions and retrieve financial data, simply add the desired functions to the $.when
function parameters and pass them in a Response
object as in the example below:
// (Optional) Assumptions...
$.when(
get_income_statement(),
get_income_statement_ltm(),
get_balance_sheet_statement(),
get_balance_sheet_statement_quarterly(2),
get_cash_flow_statement(),
get_cash_flow_statement_ltm(),
get_profile(),
get_treasury(),
get_fx(),
get_risk_premium(),
get_prices_annual()).done(
function($income, $income_ltm, $balance, $balance_quarterly, $flows, $flows_ltm, $profile, $treasury, $fx, $risk_premium, $prices){
try{
var response = new Response({
income: $income,
income_ltm: $income_ltm,
balance: $balance,
balance_quarterly: $balance_quarterly,
balance_ltm: 'balance_quarterly:0',
flows: $flows,
flows_ltm: $flows_ltm,
profile: $profile,
treasury: $treasury,
risk_premium: $risk_premium,
prices: $prices,
}).toOneCurrency('income', $fx).merge('_ltm');
response.balance[0]['date'] = 'LTM';
// Rest of the code...
}
catch (error) {
throwError(error);
}
});