Tuesday, March 26, 2019 at 11:43 AM #130358
I hope this question isn’t out of place.
Is there a way the use API to parse a 10-K and have it return specific abstract text formally itemized in the document, such as “Item 1.”, which is “Business Description” or “Item 2.” which is “Risk Factors,” etc.?
Thursday, March 28, 2019 at 5:40 PM #130816
The XBRL API is not currently configured to query text within
fact.valueas there are several datatypes for this information (numeric, boolean, data, string, etc.). At this point, the parsing needs to be done on
fact.valueafter it’s returned to the end user. Fortunately, structured data like XBRL makes this easy at the destination.
To date, we’ve enabled text-match on the
labelendpoint so a query like this will show all of the labels in a filing that contain the string “Text Block” –
/label/search?dts.id=292503&label.text=Text Block&fields=label.*,concept.local-name.sort(ASC). Take a look at the documentation for details.
We’re continuing to explore and assess the suitability of text match on other viable endpoints like
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 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