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.
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.
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).
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.
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.
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.
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.
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.
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.
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.
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
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.
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.
All use of the XBRL API and Database of Public Filings is subject to these Terms of Use.
XBRL US Membership improves data access (see below). Sole Practitioners and Organizational Members also enjoy publishing rights and commercial use of data returned from our Database of Public Filings.
Membership TypeRecords per queryRecord offset limit
Comment
You must be logged in to post a comment.