Tuesday, April 7, 2020 at 11:06 AM #174500
I have correctly setup my api to retrieve the access token and I can hit the xbrl api.
I am hoping someone can point me in the right direction of how to obtain specific data – what the api endpoint should look like and what ids I need to provide.
I want to get Financial analysis data (Standardized and Reported Financials) for a given company. Is there a specific endpoint where you can provide a company id (or ticker code) and retrieve all the filings financial information, or most recent etc?
The docs here are great: https://xbrlus.github.io/xbrl-api/#/ But they don’t help those like me who are completely new to xbrl.
Example data I hope to retrieve:
– Operating income
– Other income/(expense)
– Net Income
– Earnings Before Interest and Taxes (EBIT)
– Current Assets
– Liabilities and Shareholders’ Equity
Is there an API call which provides all these?
Wednesday, April 8, 2020 at 3:09 PM #174633
Hi Steven – thanks for writing. Much of your approach to getting information will depend on what details you need to return.
The /report endpoint can be used to return details about filings for an entity.
Using dts.id information returned from this query, you could then use the /fact endpoint query to get financial details for the report:
concept.local-nameto filter the fact results to the reported values you’re looking for and you’re on your way!
I encourage you to look at the XBRL Spreadsheet and others linked at right. You’ll need to install our XBRL API Access add-on to use the template – there are queries you can explore (and modify for your own purposes). We’ve also posted some of the queries we use on pages of our site (and elsewhere) on this page.
Thursday, April 9, 2020 at 6:12 AM #174683
Thanks for this – this is very helpful.
Is there an easy way to get cik codes to use. My database already has a tonne of companies listed by name.
So the flow would be:
1. search for company (by name or some other useful field)
2. Retrieve cik from above query
3. Get a list of reports using cik
4. Get data from specific report using dts.id from report
I will have a look at the spreadsheets too.
Monday, April 13, 2020 at 3:28 PM #175113
Steven – you can return ticker detail as part of a
Tuesday, April 14, 2020 at 7:33 AM #175174
Thanks for the continued help and support.
I am learning more about XBRL and I see that there seems to be parent sections and children of that section.
So there might be a parent:
Assets AssetsCurrent Cash accountsreceivable othercurrentassets AssetsNonCurrent prepaidexpenses accountsreceivable
Is there a way to pull in all Parent and children values? For example all these and their children elements:
"AssetsCurrent", "AssetsNoncurrent", "Assets", "LiabilitiesCurrent", "LiabilitiesNoncurrent", "Liabilities", "StockholdersEquity", "MinorityInterest", "StockholdersEquityIncludingPortionAttributableToNoncontrollingInterest", "LiabilitiesAndStockholdersEquity"
This url doesn’t seem to:
- This reply was modified 1 month, 2 weeks ago by Steven Rankin.
Saturday, April 18, 2020 at 8:33 AM #175691
The Statement and Disclosure Explorer google sheet template uses the
/relationshipendpoint to query parent-child detail from the DTS and includes an attribute called
While it’s not possible to nest the
/factendpoints (taxonomy and instance), you can do two queries and “associate” the data (
See hidden columns A-E on the FinancialsExplorer tab and the FEfacts tab of https://xbrl.us/xbrl-api-explorer for queries that may help you. NOTE: depending on XBRL US Membership, data returned on this template may be limited.
You must be logged in to reply to this topic.
Extraction and Interpretation of Operating Lease Data 1 day, 1 hour ago
Getting started with the XBRL Google Sheet and add-on 1 day, 9 hours ago
Specifying reports for results 2 days, 2 hours ago
Getting started with the XBRL Google Sheet and add-on 2 days, 3 hours ago
Entity's industry 2 days, 3 hours ago
XBRL API Resources
- The XBRL API
- XBRL Data Community
- XBRL API Interactive Documentation
- XBRL API Documentation (PDF)
- Getting Started with Google Sheets
- Sample API Queries (works with Insomina) or Excel Power Query Template
these options require 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 email@example.com 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