Thursday, May 27, 2021 at 12:28 PM #190781Bruno LererParticipant
In order to try out the API (using this interface (although I don’t think it makes a difference), I randomly picked a company (Carnival Corporation), a form (10-K), two reporting periods (2019,2020) and one concept (local name “LiabilitiesCurrent”). In an ideal world, only two hits should be returned (“8,686” for 2020 and “9,127” for 2019, in each case using “fact.inline-display-value”).
However, this search
returns 4 hits. The correct value for 2020 is returned once in the 2020 filing. That filing, however, also returns the 2019 value which is included as comparison in the 2020 financials. Hence the first question: is it possible to exclude items related to periods other than the period for which the specific filing is filed?
The 2019 filing returns the 2019 value twice: once, correctly, as it appears in the balance sheet, but once again since it appears in one of the notes to the financials. Hence question two: is it possible to limit hits to only those concepts included, in this case, in the balance sheet?
Thursday, May 27, 2021 at 12:30 PM #191801David TaurielloKeymaster
Hi Bruno – apologies for the delay in getting to your questions.
On the first question – to restrict values to a single year, remove the other year from the query.
If you want to use both the 2019 and 2020 values from the 2020 report, you should first get the dts.id or report.id from the /report endpoint.
Use either dts.id or report.id to return facts from the report for the years required.
We’re working on a filter parameter that will prevent ‘duplicate’ values like you note for Carnival in 2019, and we’ll update the community when it’s available.
Let me know if I’ve misunderstood your questions.
- You must be logged in to reply to this topic.
Documentation & Discussion
- The XBRL API
- XBRL Data Community
- XBRL API Interactive Documentation
- 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
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.