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.

Get a Taste.

Login and take a look at the 10 most-recently filed reports and base taxonomy information or the last 12 times the concepts Assets and Liabilities appeared in reports from any XBRL sources we monitor – currently SEC, FERC, and ESEF (new visitors might need to login twice). The browser view of these XBRL API queries is JSON format, so it might look messy – don’t worry, we’ve got some free tools, templates and code samples below that can help get more data in ways that may be a bit easier to read.

Get Started.

Using the XBRL Filed Data extension for Google Sheets or Office 365 Excel is an easy way to get started creating queries and understanding how to use the XBRL API and our Public Filings Database. Scroll down for free spreadsheet templates you can customize, as well as other resources for using the XBRL API with programming languages like PHP, Python and R.

 

Need help?
– Watch introductory videos for Google Sheets Add-on or Excel.
– Post a question or look for an answer on the Discussion Forum
– Get one-on-one support (except holidays) Monday, 3:30 – 4:30 PM ET || Schedule a time

Anyone can explore our Database with the XBRL API without cost or obligation. Most XBRL US Members enjoy unlimited access and no quotas. Consider XBRL US Membership options for yourself or your team.

Get Data and Details with Templates and Tools.

XBRL US Members can earn discounts for contributing to the collection of free resources posted below. Got an idea? Email info@xbrl.us so we can discuss it with you (we may have helpful tips, too).

Excel Template

OAuth2 access

Google Sheets

updated Feb 6, 2024

Full ESEF or SEC Report with Dimensions Pivot for Excel Office 365 (.zip download) or Google Sheets
Get report-styled facts for a single filing, with underlying queries grouped in columns to the left of the presentation. Includes a pivot table for dimensional data and a footnote list.

 

Excel Template

OAuth2 access

Google Sheets

updated Jun 17, 2023

FERC Schedule Compare and Report Template for Excel Office 365 (.zip download) or Google Sheets
Get a side-by-side comparison of FERC Schedule data – including dimensions – for multiple companies, a pivot table display of the schedule detail for improved readability, or XBRL US Members can get a full report for a public utility using the cube endpoint for the hypercube of facts and taxonomy details.

Excel Template

OAuth2 access

Google Sheets

updated Dec 9, 2021

Classroom Learning Activity for Excel Office 365 (.zip download) or Google Sheets
Use warm up queries to get students acclimated, then graduate to an exercise with answer key to learn how to build API queries (also available in Google Sheets). XBRL US Academic Memberscontact us for help with prep and/or rollout.

 

Excel Template

OAuth2 access
updated Oct 15, 2022

Multi-Company Comparison (.zip download)
Compare financial schedules, statements or disclosures for up to 3 companies. This template will let you compare reports among regulators in a single worksheet (SEC and FERC).

 

Google Sheets

updated Dec 11, 2021

Margin Comparison / Time Series
Extract margin, revenue, and income elements for up to 10 tickers in table and graphical display.

 

Google Sheets

 

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.

Code Resource

OAuth2 access
updated May 10, 2022

ITEP Case Study (Jupyter Notebook – IPython – )
Use this web-based interactive Python loop to gather data for a case study presented by Christine Cheng and Mitch Wenger from The University of Mississippi. The script can be used online or downloaded and run from a local computer, so the output can be saved as a .csv file.

 

Code Resource

updated Dec 20, 2021
OAuth2 access

Jupyter Notebook – IPython –
Use this web-based interactive Python loop to gather all available data points for a query. Run the script from a local computer and the output can be saved to a .csv file.

 

Code Resource

OAuth2 access
updated Mar 6, 2023

Full-text search Jupyter Notebook – IPython –
XBRL US Members can use this web-based interactive Python loop to use the document endpoint of the XBRL API to complete a full-text search of SEC filings from 2018 to the present. Run the script from a local computer and the output can be saved to a .csv file.

 

Code Resource

OAuth2 access
updated Oct 27, 2022

Jupyter Notebook – R –
Use this sample open-source web-based front end as a starting point to create an interactive, versioned, distributable resource for your research using R programming language.

Code Resource

OAuth2 access

XBRLUSCall for PHP (v0.1)
Download the .zip from GitHub and use XBRLUSCall to simplify the task of creating programatic requests in PHP to the XBRL US API. 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

OAuth2 access

Sample Queries (Insomnia workspace) as .json file
Right-click to save this set of XBRL API queries, designed to be loaded from Insomnia software.

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 17 topics - 1 through 15 (of 117 total)
Viewing 17 topics - 1 through 15 (of 117 total)
  • You must be logged in to create new topics.

Periodic 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