XBRL API Sheet
 Share
The version of the browser you are using is no longer supported. Please upgrade to a supported browser.Dismiss

View only
 
 
ABCDEFGHIJKLMNOPQRSTUVWXYZAAABACADAEAFAGAHAIAJAK
1
Use the File menu to 'Make a copy...' in your Google account, then authorize the XBRL API Access Add-on and change the B2 dropdown to return data.
2
Select Query from Dropdown
Inline filings"This file is a starting point for using the XBRL API with the XBRL US Public Database of Filings. After installing the XBRL API Access add-on (https://xbrl.us/xbrl-api-addon) to your Google Account, use the file menu to "Make a copy..." of this XBRL API Sheet file in your account, then follow the prompts to sign in and initialize the add-on under the Add-ons menu.

The 'Config' tab has preloaded queries that can be called by changing the dropdown menu in cell B1 of this 'Main Sheet' tab. Results appear on row 10 and below, using the function =showData(url). By default, the 'Display' is set to return queried data.

Main Sheet Options - Field Tree and Specific Field Name: Change cell B2 on this sheet to "Field Tree" to get a list of fields returned by the query. Use "Specific Field" with forward slashes to return data/details for "Specific Field Name" defined in cell B3. For example, select the query 'Selected US-GAAP 2018 concepts' to get 10 concepts (offset is explained below), then change the display to Field Tree to see what fields are returned. Type label/label.text in the Specific Field Name cell B3 (corresponding to the 'tree' location of the last returned data point for queried records) and change the Display to Specific Field to return only the label.text values for the query.

The 'BSCompare' tab on this file shows data returned and formatted into a very basic Balance Sheet for US GAAP filers.

Not getting all the results you expect? Use ENDPOINT.offset(INTEGER) in the fields parameter to return additional records that may exist for your query. For example, select the query 'AssetsCurrent for all filers (2015 - 2017)' from the dropdown and fact.offset(900) returns records starting with 900; change the parameter to 0 to see the first results returned (see documentation Section 7. Handling Paging for details).

The API documentation (https://xbrl.us/xbrl-api-documentation) outlines parameters and switches that can be used to update preloaded queries or create your own. Visit https://xbrl.us/benefits to learn about XBRL US Membership options to return more/all data for your queries.

Got questions or ideas? Post to the XBRL Data Community Discussion Forum - https://xbrl.us/xbrl-api-community
3
DisplayQuery Results
4
Specific Field Namereport.id
5
Display full query?
6
Full Queryhttps://api.xbrl.us/api/v1/report/search?report.entry-type=inline&fields=report.base-taxonomy,report.entity-name,report.filing-date,report.accession
7
8
9
10
Query Response
11
#ERROR!
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
Loading...
Main menu