Loading...
11 12 18
20:19 PM

Access to each data sets described below requires a user ID and password. Please login or Buy data and receive a user ID and password

Using Sage Data Service API

This page is a quick guide to using the Sage Data Service Core Fundamentals API Version 1.

Review

Below is an example of a full API request provided as reference

https://research.sagedataservice.com/api/v1/companies/income-statement/ticker/AAPL.json
?order=desc
&start_date=2014-01-01
&end_date=2015-01-01
&period=fy
&units=common_size
&auth_key=[api-token] Copy

API Key

You should include your API key in all your calls. You can generate or refresh your API key on your account settings page. Requests without an API key (anonymous requests) will not be accepted. You should add your key as "auth_key" parameter in your call like this:

/v1/companies/income-statement/ticker/AAPL.json?auth_key=[api-token] Copy

Ticker Symbol

Always provide a valid company ticker symbol to your call in order to take data for the exact company requested. The Ticker, also known as a trading symbol, is used as the identifier for a publicly traded company in the Sage database. A valid Ticker must be included in the API call.

/v1/companies/income-statement/ticker/AAPL.json Copy

Company CIK

Always provide a valid Company CIK to the call in order to take data for the exact Company requested. The CIK, also known as the Central Index Key (CIK) provided by the SEC, is used as the identifier for a public company in the Sage database. A valid CIK must be included in the API call.

/v1/companies/income-statement/cik/320193.json Copy

Statements

Financial Statement parameter is a required array in the API call. The Financial Statements types are income-statement, balance-sheet or cash-flow. In order to return data from all statements for a company you must include each statement type in the API call as shown below:

/v1/companies/income-statement | balance-sheet | cash-flow/ticker/AAPL.json Copy

Result Formats

You can get data from the SageDataService API in three different formats : JSON , XML and CSV by adding it to your call as parameter

/v1/companies/income-statement/ticker/AAPL.json | xml | csv Copy

Sort Order optional

You can order the result data by passing a ascending or descending order at the end of the call. Including this command will order the results by date with descending (desc) showing the most recent date first and ascending (asc) being ordered with oldest date first. If this option is not included, the data order will default to newest date first.To use this option, insert the order=asc|desc parameter as shown below:

/v1/companies/income-statement/ticker/AAPL.json?order=desc | asc Copy

Units Format optional

By default all data from the SageDataService API comes in unscaled monetary value as unit. The API gives you the choice to also get the values as Common-Size percent values by passing the units=common_size parameter to your call. If the units is not defined, the data will be returned in the unscaled monetary value.

/v1/companies/income-statement/ticker/AAPL.json?units=common_size Copy

Periods Filter optional

If you make a request for financial statement data without specifying the period parameter you will get results for all four quarters plus the fiscal year data of the company. If the period parameter is included, you can choose from all, which includes Q1, Q2, Q3 and Q4 or specify one of Q1, Q2, Q3, Q4, FY (Fiscal Year), CY (Calendar Year), or TTM (Trailing Twelve Months) as filters for the result. If you specify an exact period parameter, only data from that period will be returned in the result.

/v1/companies/income-statement/ticker/AAPL.json?period=all | q1 | q2 | q3 | q4 | fy | cy | ttm Copy

Date Range optional

By including the start_date and end_date parameters, you can filter and better define the results by ranging between specified dates. For financial statement data, the date range parameter is based on Report Date (as specified on the Income Statement, Balance Sheet, and Cash Flow) of the financial statements. All Report Dates within the specified range will be included in the results. Please note that the format you should enter the dates as is YYYY-MM-DD

/v1/companies/income-statement/ticker/AAPL.json?start_date=2014-01-01&end_date=2015-01-01 Copy