Thursday, February 21, 2019 at 6:42 PM #124707
When I use code A below, I get the desired concept.local-names, but the call does not return the “network.role-description” (the financial statements where the concept came from)–even as I added different “relationship” items in the code.
When I use code B below, I do get the “network.role-description”, which I need.
Is there a way that I can get the “network.role-description” to work in code A above?
Saturday, March 2, 2019 at 11:19 AM #126283
I’m not clear on what you are trying to return, and as far as I know, there’s no intersection of
relationshipin the API currently. Please see the diagram on p. 20 of the documentation – https://xbrl.us/xbrl-api-documentation.
In the A query, you cannot get
relationshipdetails from the
conceptendpoint, so those parameters should be removed from the ‘fields’ portion of the query. And with B, you cannot get
conceptdetails from the
relationshipendpoint, so those shouldn’t be included as ‘fields’ to return.
Maybe you’re trying to use the
relationshipendpoint to get concepts included in a specific part of the filer’s report – ?
A query like this will return details for Apple:
If you look at
relationship.target-namein the fields returned, these are the concepts included for the disclosures listed in
Friday, May 31, 2019 at 5:50 AM #140995
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