This community helps developers, analysts, and business intelligence professionals connect and use the XBRL API, Public Filings Database, Google Sheet resources and other tools more effectively.

Start using as-filed data


The Google Add-on is the easiest way to get started retrieving data with the XBRL API from the Database of Public Filings. You can also request to be able to create Client ID & secret pairs for Excel or your applications.

Data Community Resources:

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

  1. Member-contributed XBRL Spreadsheet templates and tools
    Anyone is welcomed to share in the collection of customizable spreadsheets, developed by XBRL US Members that conform to the standards on this page. XBRL US Members can 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).

    Most of the resources linked below use our Google Sheets Add-on – follow these instructions to get started.

API Template

 

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.

API Template

 

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.

API Template

 

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.

API Template

 

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.

API Template

 

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

API Template

Excel Power Query Template (.zip download) contributed by Power User Jim Truscott
This template uses Microsoft’s Power Query functionality to retrieve data (Excel 2013 or later on a Windows PC). The setup requires a Client ID and secret, so use your XBRL US Web account to request provisioning in the lower-right of this page after downloading and extracting the .xlsx file from the .zip. Watch an introductory set-up video for the Excel spreadsheet from the developer.

API Tool

 

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 Client ID and secret, 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
API Tool

 

Jupyter Notebook (IPython) – from XBRL US
Use this sample open-source, web-based front-end with your own XBRL API credentials as a starting point for creating an interactive, versioned, distributable resource for your research.

API Tool

 

Sample Queries (Insomnia workspace) from XBRL US
This set of XBRL API queries is designed to be loaded from Insomnia software using your Client ID and secret.

  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 54 total)
    1 2 3 4
    Viewing 15 topics - 16 through 30 (of 54 total)
    1 2 3 4
    • You must be logged in to create new topics.

  2. Work with the API in Excel's Power Query, or with your own system or app

    Contact us at info@xbrl.us to have your existing XBRL US Web account provisioned to generate client ID/Secret pairs to work with the XBRL API in a REST client or other application, including Excel's Power Query.

    NOTE: You do not need to generate client ID/Secret pairs if you use the Google Add-on and Google Sheet exclusively to access data - the XBRL API Authentication Add-on handles this automatically.

    Your account needs to be provisioned before you can login and generate client ID/secret pairs.

    Login or register for a free account.

  3. 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.

Interested in getting deep into the data? Anyone can use the tools to get a feel for queries and results from the database with our updated API. Your XBRL US Membership unlocks greater results from the API with the resources listed at right.

Comment

Using Data

XBRL API Resources