Thursday, November 1, 2018 at 1:30 PM #114856
So – I need to check if I am thinking about this correctly… The XBRL API connects to the XBRL US database which we as members have access to, but we should not rely on it as a long term solution for commercial use.
What are our options if we want to implement a local (to us) solution? Are we allowed to/can we copy the database and maintain it locally? – how do we get a hold of the API to connect it to our own database?
If we wanted to just store the zipped filings locally as described in Altova’s video, how would we be able to connect to that? The API would not work for connecting to those, right? Is that essentially what Raptor XML is for?
Tuesday, November 6, 2018 at 5:03 PM #115686
We’ve exposed the XBRL US Database of Public Filings via the XBRL API so anyone – regardless of their affiliation with XBRL US – can see and learn about how to use standardized financial data for their own private, non-commercial research and development.
We believe in the integrity of our ‘as-filed’ database and are working to incorporate XBRL data from sources other than the SEC, but we’re not set up to be a ‘data provider’. Several XBRL US Members already do a great job of providing enterprise-level support for XBRL data.
We can provide any any member organization (company or institution) a snapshot of our database and are working on making the XBRL API available, as well (we’re still configuring it around the edges). We can also make documentation available for the database and our load process, if needed.
I think the video you’re referencing is this one https://youtu.be/2Oe9ZqXVGME from a webinar a couple of years ago. The .zip files are in the SEC’s EDGAR database, so I’m not sure you’d be able to connect via the XBRL API. FWIW, we ‘listen’ to the RSS the SEC provides for the database, and programmatically expand these .zips into our database as part of our load process. I’m not completely sure whether the latest version of Raptor reads the .zips or extracts them (I think it’s the latter).
Wednesday, November 7, 2018 at 6:00 PM #115938
Sounds good David. That was pretty much exactly what I was hoping to hear 🙂
Friday, December 14, 2018 at 9:06 AM #118607
Can these APIs be used on the XBRL data shredded on MongoDB?
Monday, December 24, 2018 at 7:49 AM #119123
The XBRL API is designed to work with any database containing data that conforms to the 2.1 XBRL Specification.
Please note: We don’t support using the XBRL API and our Database of Public Filings to siphon/feed another database – this will strain our resource and may result in termination of access.
Organizational members should contact us for more information (email@example.com).
You must be logged in to reply to this topic.
CIK and Ticker 1 week, 6 days ago
Extracting Data From A Particular Financial Statement 2 weeks, 3 days ago
Missing years 1 month ago
Period details for facts 1 month, 3 weeks ago
Extracting Data From A Particular Financial Statement 1 month, 3 weeks ago
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 firstname.lastname@example.org 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