Tuesday, September 25, 2018 at 10:08 AM #111865
In late 2015, we published our first set of APIs, documentation and related resources (Google Sheets, Microsoft Excel files) as a preliminary attempt at exposing data in the XBRL US Database of Public Filings – the Data Analysis Toolkit.
Among the feedback we received about the APIs was a consistent request to make them ‘easier for non-XBRL people’ to understand and implement. The XBRL APIs do that, and more, so we’ve decided to shut down the ‘legacy’ APIs associated with the Data Analysis Toolkit in December, 2018.
With participation from the XBRL Data Community in the form of live web exchange, submitted templates and support through these discussion forums, we expect interest in standardized financial data and a standard to retrieve the data will continue to grow.
Wednesday, December 5, 2018 at 12:44 PM #118065
Where can we get new keys if we want to continue using the data via a key and direct queries to the database?
Wednesday, December 5, 2018 at 1:05 PM #118067
Thanks for your interest in using data from the XBRL US Database of Public Filings. Anyone can use the XBRL API to return up to 1,000 records per query from the repository. To use the XBRL API in your own application for private, non-commercial research and development, send a request to have your XBRL US Web Account provisioned to firstname.lastname@example.org.
Power User and Sole Practitioner Individual Members, as well as all Organizational Members, have access to all available data via the API, as well as direct queries to the Database. See the Member Benefits link under “Join XBRL US” at right to learn more and find out about the option that’s right for you and/or your team.
You must be logged in to reply to this topic.
XBRL API Resources
- The XBRL API
- XBRL Data Community
- XBRL API Documentation (PDF)
- Get Data with Google Sheets
- Sample Queries (Insomina REST client) - requires account provision
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.
Ready to work with the API in Excel's Power Query, or with your own system or app?
Contact us at email@example.com 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.
Join XBRL US
- Individual Options - Basic, Power User & Sole Practitioner
- For Your Team - Startup, Non-Profit, Academic & Corporate options
- Member Benefits Comparison Table