Home › Forums › The XBRL API › Arhitecture and other stuff
- This topic has 4 replies, 3 voices, and was last updated 7 years ago by David Tauriello.
-
AuthorPosts
-
-
Thursday, November 1, 2018 at 1:30 PM #114856Peter GuldbergParticipant
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 #115686David TaurielloKeymaster
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 #115938Peter GuldbergParticipant
Sounds good David. That was pretty much exactly what I was hoping to hear 🙂
-
Friday, December 14, 2018 at 9:06 AM #118607Ashutosh PandeyParticipant
Can these APIs be used on the XBRL data shredded on MongoDB?
-
Monday, December 24, 2018 at 7:49 AM #119123David TaurielloKeymaster
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 (info@xbrl.us).
-
-
-
AuthorPosts
- You must be logged in to reply to this topic.
Search Forums
Recent Topics
- Income Statement data for a company by David Tauriello
- Normalized data presentation by David Tauriello
- Extract Director RSUs/Options Form 14A by Priyanka Goonetilleke
- Using the offset parameter by David Tauriello
- Spreadsheet Commands: Query Worksheet and Query Workbook Query Workbook by Liam Noailles
Recent Replies
-
Income Statement data for a company 6 months ago
-
Income Statement data for a company 6 months ago
-
Using the offset parameter 10 months, 1 week ago
-
Using the offset parameter 10 months, 1 week ago
-
Using the offset parameter 10 months, 1 week ago
Documentation & Discussion
- Get started with Google Sheets OR
- Get started with Microsoft Excel OR
- Get access to as-filed data from us for other tools or your own app
- XBRL API Interactive Documentation
- Ten Tips & Techniques
- The XBRL API
- XBRL Data Community
- 2024 US GAAP Taxonomy Viewer
- Live support - Monday, 3:30 - 4:30 PM ET
Who's using this free data?
API Use 2024 || API Use 2023 || API Use 2022 || API Use 2021 || API Use 2020 || API Use 2019 || API Use 2018
Join XBRL US
- Individual Options - Basic, Power User & Sole Practitioner
- For Your Team - Startup, Non-Profit, Academic & Corporate options
- Member Benefits Comparison Table
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.
To use the XBRL API outside of Google Sheets, your account needs to be provisioned for OAuth2 access.





