This community helps developers, analysts, and business intelligence professionals connect with and use the XBRL API, Public Filings Database, staff and community-sourced resources and tools more effectively.

Start using as-filed data


The Google Add-on is the easiest way for anyone to get started working with data from the Database of Public Filings via the XBRL API. With OAuth2 access, anyone can get data with the XBRL Filed Data Excel Add-in and templates, additional resources below or directly in applications.

Data Community Resources:

Watch an introductory webinar replay about retrieving data with the XBRL API

  1. Member-contributed API Templates and Tools
    Everyone can use these resources. XBRL US Members earn discounts for contributing to the XBRL API Template/Tools library. Got an idea? Email info@xbrl.us so we can discuss it with you (we may have helpful tips, too).

    Interested in getting access to all the data? While anyone can use these templates and tools to query the Database of Public Filings, non-members will only return a sample of what’s available – consider XBRL US Membership options for yourself or your team.

Excel Template

XBRL Excel Spreadsheet (.zip download) from XBRL US
This template uses a custom function available in the XBRL Filed Data Add-in, which requires OAuth2 access. This template is a port from Google Sheet XBRL Spreadsheet (below) – it has some basic search queries on the initial tab, and a simple balance sheet calculated from reported values for companies selected by the user.

Excel Template

XBRL Filed Data Add-in Template (.zip download) from XBRL US
This template uses a custom function available in the XBRL Filed Data Add-in, which requires OAuth2 access. This template is a port from Google Sheet Classroom Activity (below) – it has some basic search queries on the initial tab, and a short template exercise.

Google Sheet

 

Balance Sheet Compare – SEC Filers contributed by Power User Peter Guldberg
This template features a customizable Taxonomy Map that lets analysts compare financials for US GAAP and IFRS filers.

Google Sheet

 

Classroom Activity from XBRL US
Designed to introduce a group of users to the XBRL API, one tab has ‘warm up’ queries that ensure everyone is connected to the API, and the other tab is a stand-alone exercise with answer key to understand basic parameter/formula manipulation to achieve desired results. XBRL US Academic Members – contact us for help with prep and/or rollout.

Google Sheet

 

Statement & Disclosure Explorer from XBRL US
Use a simple ‘wizard’ interface to select and retrieve face financial details for any 10-K or 10-Q XBRL filing; drill into specific statements or disclosures, or override the select mechanism to get all filing details reported in XBRL.

Google Sheet

 

Margin Comparison / Time Series from XBRL US
This template queries common Revenue and Income/Loss elements for up to 10 tickers and displays pivot tables for high-level graphic comparison. The Margin Time Series focuses on the ‘default’ ticker from the Margin Comparison, with override cells that can quickly change company and/or element screen.

Google Sheet

 

XBRL Spreadsheet from XBRL US
A Google Sheet with several basic queries and a simple Balance Sheet Comparison for companies filing with US GAAP Taxonomies

Code Resource

 

XBRLUSCall for PHP (v0.1) from XBRL US
Download the .zip from GitHub and use XBRLUSCall to simplify the task of creating programatic requests in PHP to the XBRL US API. With your OAuth2 access, this class:

  • Handles requesting and managing OAuth tokens (access_token and refresh_token)
  • Handles multiple calls (pagination) to the API to obtain the full results of the data set rather than the per-request limit
  • Automatically handles potential errors
  • Certain functions can be overridden to allow token persistence between initializations
Code Resource

 

Jupyter Notebook – R – from XBRL US
Use this sample open-source, web-based front-end with your OAuth2 access as a starting point for creating an interactive, versioned, distributable resource for your research using R programming language.

Code Resource

 

Jupyter Notebook – IPython – from XBRL US
Use this sample open-source, web-based front-end with your OAuth2 access as a starting point for creating an interactive, versioned, distributable resource for your research using interactive Python programming language.

Code Resource

 

Sample Queries (Insomnia workspace) from XBRL US
This set of XBRL API queries is designed to be loaded from Insomnia software using your OAuth2 access.

  1. Discussion forum

    Home › Forums › Home › Using Data › Search

    All visitors can exchange ideas and pose questions to XBRL data users in a community forum. Browse the latest topics below or use the link or search box above to get answers on other topics.

    Home › Forums › Home › Using Data › The XBRL API

    Viewing 15 topics - 16 through 30 (of 71 total)
    1 2 3 … 5
    Viewing 15 topics - 16 through 30 (of 71 total)
    1 2 3 … 5
    • You must be logged in to create new topics.
  2. Periodic Member-only web meetings
    Engage in an open forum to learn about new functionality and techniques for using XBRL API, get questions answered, and let members preview XBRL Spreadsheets in development and other applications. The list of upcoming and prior meeting replays is at the right-side of this page.

Comment

Using Data

Documentation & Discussion

Who's using this free data?

API Use 2021 || API Use 2020
API Use 2019API Use 2018

Join XBRL US

Using the XBRL API with the Public Filings Database

Unless otherwise agreed to in writing, any and all use of the XBRL API to authenticate and retrieve data from the XBRL US Database of Public Filings implies user consent and agreement with the XBRL US API Agreement. If you are unable to agree to these terms, do not use the XBRL API.

To use the XBRL API outside of Google Sheets, your account needs to be provisioned for OAuth2 access.

XBRL Data Events