XBRLAnalyst Web API

Description

XBRLAnalyst Web API is provided to users of all subscription types of XBRLAnalyst. The API allows to retrieve fundamental and stock market financial information of all public companies that file XBRL reports with the Securities and Exchange Commission (SEC) in the US. All information is provided in the following formats: JSON(default) and XML (you can specify it with “format” parameter).

Financial information can be retrieved about companies, their individual filings to SEC, the statements and disclosures contained within those filings, and any XBRL facts reported within the report or normalized financial metrics computed by FinDynamics. A separate set of calls is provided for retrieving Stock Market Price/Volume for any of the listed companies as well as statistics such as averages over a selected period of time, e.g. 52-week average.

For Preview purposes, we provide unregistered visitors with open access to the API for companies listed in the S&P100 Index.

Authentication

The XBRLAnalyst Web API uses HTTP Basic Authentication to authenticate users. Your username and password will be the same as your FinDynamics login credentials.

Response Format

Be sure to use the “Accept” header set to “application/json” to ensure JSON results. The API is also capable of returning XML.

Common Parameter Groups

Many endpoints use the same set of parameters for querying reports and companies. To keep things clear, these parameters are documented here, and only referenced in the endpoints that use them.

Company Parameters

Name	Type	Notes
companyId	string[]	The internal ID of a company.
cik	string[]	The SEC’s Central Index Key.
ticker	string[]	The company’s trading symbol.
clist	string[]	A named list of companies.

Report Parameters

Name	Type	Notes
reportId	string[]	The internal ID of a report.
accessionNumber	string[]	The SEC’s accession number.
focusYear	integer[]	The focus fiscal year of the report.
focusPeriod	string[]	The focus fiscal period of the report (cf. Periods).
docType	string[]	The document type of the report (e.g., “10-Q”).

Periods

The API accepts the following values as fiscal, calendar, and focus periods:

• “Q1”, “Q2”, “Q3”, and “Q4” for quarters;
• “Q1”, “H1”, “Q3CUM”, and “FY” for cumulative periods;
• “Q1LTM”, “Q2LTM”, “Q3LTM”, and “FY” for Last-Twelve-Months periods.

For calendar periods and focus periods, only quarters and “FY” are supported.

Using the POST Method

Since queries can grow quite large, it is possible to use the POST method for making requests. To do this, the body of the request must be a JSON object with keys that match the parameter names of the endpoint. The “X-HTTP-Method-Override” header must be set to “GET”, and the “Content-Type” header must be “application/json”.

Error Reporting

The API uses HTTP status codes to indicate errors. Often, the error will accompanied by a message in the response body. For example, without authentication, the following request yields the following result with status code 401 “Unauthorized”.

Request

https://xbrlanalyst.findynamics.com/api/v2/facts?ticker=FLWS&concept=tid:GrossProfit

Response

{
“message”: “Requested company is not in the preview list. Unauthorized users only have access to a limited list of companies. Add \”clist=preview\” to limit queries to this list.”
}

Calls