forked from xbrlus/xbrl-api
-
Notifications
You must be signed in to change notification settings - Fork 0
/
xbrlapi.yaml
4798 lines (4526 loc) · 182 KB
/
xbrlapi.yaml
1
2
3
4
5
6
7
8
9
10
11
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
# XBRL US API
servers:
- description: Running this application XBRL US server
url: 'https://api.xbrl.us/'
# - description: Running this application using the XBRL US test server
# url: 'https://testapi.xbrl.us/'
info:
version: "V1"
title: XBRL US API
description: |
This API defines the XBRL US API.
## Authorization Flow
We use [OAuth2 JWT](https://jwt.io/) flows to secure interactions.
## Example Interactions
In this section, we will provide __CURL__ examples for typical __XBRL US API__ flows. Because XBRL US API is sessionless, each "session" will always begin with the [OAuth2 JWT Access Token Flow](https://jwt.io/introduction).
### Access Token Flow
This flow shows the steps required to interact with the API
1. Send an HTTP `POST` request to the tokenUrl: `/oauth2/token`:
```http
POST /oauth2/token HTTP/1.1
Host: <api.xbrl.us>
Content-Type: application/x-www-form-urlencoded
Body: {
"grant_type": password,
"client_id": "XBRL US Client",
"client_secret": "client secret",
"username": "username",
"password": "password",
"platform": pc
}
```
2. Upon a successful authorization grant, the server will respond with an `access_token`:
```http
HTTP/1.1 200 OK
Request URL: <example.com>/oauth2/token
Date: <EEE, dd MMM yyyy HH:mm:ss z>
Content-Length: 500
Body: {
"platform": "pc",
"access_token": "eyJ...124nOvc",
"refresh_token": "eyJ...124nOvc",
"expires_in" : 3600,
"refresh_token_expires_in": 10800,
"token_type": "bearer"
}
```
3. Add a new `Authorization` header with type `Bearer` and the contents of the above `access_token`
```http
GET </some/route> HTTP/1.1
Host: <api.xbrl.us>
Authorization: Bearer yJ...124nOvc
Content-Type: application/json; charset=utf-8
Body: <...>
```
Once an `access_token` has been acquired, use it until it returns a `401`. If this occurs, simply request a new token using the credentials from before.
contact:
name: xbrl.us
email: [email protected]
tags:
- name: oauth2
description: Operations to request authorization, receive tokens, and check tokens
- name: Facts
description: Used to request XBRL Facts
- name: Reports
description: Used to get information on XBRL reports
- name: Entity
description: Used to get information about entities making XBRL filings
- name: Assertions
description: Used to get information on errors in XBRL reports
- name: DTS
description: Used to get information about taxonomies.
- name: Concepts
description: Used to information about XBRL concepts in a taxonomy
- name: Labels
description: Used to request label information associated with a concept and a dts identifier.
- name: Networks
description: Used to request label information associated with a concept and a dts identifier.
- name: Relationships
description: Used to request relationship information associated with a network and/or dts identifier.
- name: Documents
description: Used to request document information associated with a DTS or report.
security:
- oauth2: [ROLE_CLIENT, ROLE_USER]
paths:
/oauth2/token:
summary: Aquire an access token by fulfilling a client_credentials grant, or a password grant
post:
operationId: tokenUrl
tags: [oauth2]
security: []
description: >
Assuming a valid login exists, this route allows a trusted client to aquire an access token for itself, or to request an access token for a specific user. You may send both `client_credentials` grants and `password` grants via the following:
* __application/x-www-form-urlencoded__
__[Read more](https://oauth.net/2/grant-types/)__
requestBody:
content:
# application/json:
# schema:
# $ref: '#/components/schemas/authorization_grant'
# example:
# grant_type: password
# client_id: 1223
# client_secret: xhOEnAX2M...gaIYLXOvCe25Q
# username: [email protected]
# password: someSecurePassword
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/authorization_grant'
# multipart/form-data:
# schema:
# $ref: '#/components/schemas/authorization_grant'
responses:
'200':
description: >
The authorization grant has been validated, and an access token is granted. __[Read more](https://jwt.io/introduction/)__
content:
application/json:
schema:
type: object
properties:
platform :
type: string
example: pc
access_token:
type: string
format: byte
example: eyJ...124nOvc
description: A JWT access token. __[Read more](https://jwt.io/)__
refresh_token:
type: string
format: byte
example: eyJ...124nOvc
description: A JWT access token. __[Read more](https://jwt.io/)__
expires_in:
type: integer
example: 3600
refresh_token_expires_in:
type: integer
example: 3600
token_type:
type: string
example: bearer
description: >
The token_type will always be bearer. The access_token is considered a bearer token, and thus should be placed in all subqequent requests to the resource endpoints by using the following header:
* Authorization: Bearer [token]
# -----------------------------------------------------
# Links
# -----------------------------------------------------
links:
bearerAuth: # <---- arbitrary name for the link
operationId: tokenUrl
parameters:
bearerAuth: '$response.body#access_token'
description: >
The `access_token` value returned in the response can be used as
the `bearer token`.
# -----------------------------------------------------
'400':
$ref: '#/components/responses/bad_request'
'401':
$ref: '#/components/responses/unauthorized'
'405':
$ref: '#/components/responses/method_not_allowed'
'500':
$ref: '#/components/responses/internal_server_error'
/api/v1/fact/search:
summary: Request facts from XBRL filings based on search parameters.
get:
operationId: getFactDetails
tags: [Facts]
security:
- OAuth2: []
- bearerAuth: []
description: |
Allows searching for _XBRL facts_ based on the attributes of the fact, the report it was in or the source of the data.
## Examples
### _-Get all the facts in a document_
The following call will get all facts in the report with an id of `226471`. It also limits the records returned to `1010` facts, sorts by the concept name and will return the following values:
* entity.name
* dimensions.count
* dimensions
* entity.cik
* period.fiscal-period
* period.end
* period.instant
* period.year
* concept.local-name.sort(ASC)
* fact.numerical-value,fact.limit(1010)
* fact.value,report.source-id
* footnote.text
* footnote.role
https://api.xbrl.us/api/v1/fact/search?report.id=226471&fields=entity.name,dimensions.count,dimensions,entity.cik,period.fiscal-period,period.end,period.instant,period.year,concept.local-name.sort(ASC),fact.numerical-value,fact.limit(1010),fact.value,report.source-id,footnote.text,footnote.role
### _-Get Operating Cash used by Pharma for the 2017 year_
The following call will get all facts reported for the 2017 year using the concept `NetCashProvidedByUsedInOperatingActivities` reported for the sic code `3841` which have no dimensions. It also limits the records returned to `100` facts and will return the following values:
* fact.numerical-value
* period.fiscal-year
* period.fiscal-period
https://api.xbrl.us/api/v1/fact/search?period.fiscal-period=Y&fact.ultimus=true&report.sic-code=3841&concept.local-name=NetCashProvidedByUsedInOperatingActivities&period.fiscal-year=2017&dimensions.count=0&fields=fact.numerical-value,period.fiscal-year,period.fiscal-period,fact.limit(100)
parameters:
- $ref: '#/components/parameters/concept.id_Param'
- $ref: '#/components/parameters/concept.is-base_Param'
- $ref: '#/components/parameters/concept.is-monetary_Param'
- $ref: '#/components/parameters/concept.local-name_Param'
- $ref: '#/components/parameters/concept.namespace_Param'
- $ref: '#/components/parameters/dimension.is-base_Param'
- $ref: '#/components/parameters/dimension.local-name_Param'
- $ref: '#/components/parameters/dimension.namespace_Param'
- $ref: '#/components/parameters/dimensions.count_Param'
- $ref: '#/components/parameters/dimensions.id_Param'
- $ref: '#/components/parameters/dts.entry-point_Param'
- $ref: '#/components/parameters/dts.id_Param'
- $ref: '#/components/parameters/dts.target-namespace_Param'
- $ref: '#/components/parameters/entity.cik_Param'
- $ref: '#/components/parameters/entity.id_Param'
- $ref: '#/components/parameters/fact.has-dimensions_Param'
- $ref: '#/components/parameters/fact.hash_Param'
- $ref: '#/components/parameters/fact.id_Param'
- $ref: '#/components/parameters/fact.is-extended_Param'
- $ref: '#/components/parameters/fact.ultimus_Param'
- $ref: '#/components/parameters/fact.ultimus-index_Param'
- $ref: '#/components/parameters/fact.value_Param'
- $ref: '#/components/parameters/member.is-base_Param'
- $ref: '#/components/parameters/member.local-name_Param'
- $ref: '#/components/parameters/member.namespace_Param'
- $ref: '#/components/parameters/period.calendar-period_Param'
- $ref: '#/components/parameters/period.fiscal-id_Param'
- $ref: '#/components/parameters/period.fiscal-period_Param'
- $ref: '#/components/parameters/period.fiscal-year_Param'
- $ref: '#/components/parameters/period.id_Param'
- $ref: '#/components/parameters/period.year_Param'
- $ref: '#/components/parameters/report.accession_Param'
- $ref: '#/components/parameters/report.creation-software_Param'
- $ref: '#/components/parameters/report.entry-url_Param'
- $ref: '#/components/parameters/report.id_Param'
- $ref: '#/components/parameters/report.restated_Param'
- $ref: '#/components/parameters/report.restated-index_Param'
- $ref: '#/components/parameters/report.sec-url_Param'
- $ref: '#/components/parameters/report.sic-code_Param'
- $ref: '#/components/parameters/report.source-id_Param'
- $ref: '#/components/parameters/report.source-name_Param'
- $ref: '#/components/parameters/unit_Param'
- in: query
name: fields
required: true
style: form
explode: false
allowEmptyValue : false
schema:
$ref: '#/components/schemas/fact_fields'
description: List of concepts to return.
# - in: query
# name: aspect
# # Wrap 'schema' into 'content.<media-type>'
# content:
# application/json: # <---- media type indicates how to serialize / deserialize the parameter content
# schema:
# type: object
# properties:
# dimension:
# type: string
# member:
# type: string
responses:
'200':
description: __fact details__ successfully accepted
content:
application/json:
schema:
type: object
properties:
paging:
$ref: '#/components/schemas/paging'
data:
type: array
items:
$ref: '#/components/schemas/fact_details'
# -----------------------------------------------------
# Links
# -----------------------------------------------------
links:
GetfactId: # <---- arbitrary name for the link
operationId: getFactBasedOnFactID
parameters:
fact.id: '$response.body#/data/fact.id'
description: >
The `fact.id` value returned in the response can be used as
the `factId` parameter in `/api/v1/fact/{fact.id}`.
# -----------------------------------------------------
'400':
$ref: '#/components/responses/bad_request'
'401':
$ref: '#/components/responses/bad_token'
'405':
$ref: '#/components/responses/method_not_allowed'
'500':
$ref: '#/components/responses/internal_server_error'
/api/v1/fact/{fact.id}:
summary: Request fact from XBRL filings based on its unique fact identifier.
get:
operationId: getFactBasedOnFactID
tags: [Facts]
security:
- OAuth2: []
- bearerAuth: []
description: >
Allows searching for _XBRL facts_ based on the fact ID attribute of the fact.
parameters:
- name: fact.id
in: path
description: Id of the fact defined by the API.
required: true
schema:
type: integer
- in: query
name: fields
required: true
style: form
explode: false
schema:
$ref: '#/components/schemas/fact_fields'
description: List of fact components that can be searched on.
responses:
'200':
description: __fact details__ successfully accepted
content:
application/json:
schema:
type: object
properties:
paging:
$ref: '#/components/schemas/paging'
data:
type: array
items:
$ref: '#/components/schemas/fact_details'
'400':
$ref: '#/components/responses/bad_request'
'401':
$ref: '#/components/responses/bad_token'
'405':
$ref: '#/components/responses/method_not_allowed'
'500':
$ref: '#/components/responses/internal_server_error'
/api/v1/fact/oim/search:
summary: Request facts from XBRL filings based on search parameters.
get:
operationId: getFactDetailsInOIMFormat
tags: [Facts]
security:
- bearerAuth: []
description: >
Returns fact details in the OIM JSON format
parameters:
- $ref: '#/components/parameters/concept.id_Param'
- $ref: '#/components/parameters/concept.is-base_Param'
- $ref: '#/components/parameters/concept.is-monetary_Param'
- $ref: '#/components/parameters/concept.local-name_Param'
- $ref: '#/components/parameters/concept.namespace_Param'
- $ref: '#/components/parameters/dimension.is-base_Param'
- $ref: '#/components/parameters/dimension.local-name_Param'
- $ref: '#/components/parameters/dimension.namespace_Param'
- $ref: '#/components/parameters/dimensions.count_Param'
- $ref: '#/components/parameters/dimensions.id_Param'
- $ref: '#/components/parameters/dts.entry-point_Param'
- $ref: '#/components/parameters/dts.id_Param'
- $ref: '#/components/parameters/dts.target-namespace_Param'
- $ref: '#/components/parameters/entity.cik_Param'
- $ref: '#/components/parameters/entity.id_Param'
- $ref: '#/components/parameters/fact.has-dimensions_Param'
- $ref: '#/components/parameters/fact.hash_Param'
- $ref: '#/components/parameters/fact.id_Param'
- $ref: '#/components/parameters/fact.is-extended_Param'
- $ref: '#/components/parameters/fact.ultimus_Param'
- $ref: '#/components/parameters/fact.ultimus-index_Param'
- $ref: '#/components/parameters/fact.value_Param'
- $ref: '#/components/parameters/member.is-base_Param'
- $ref: '#/components/parameters/member.local-name_Param'
- $ref: '#/components/parameters/member.namespace_Param'
- $ref: '#/components/parameters/period.calendar-period_Param'
- $ref: '#/components/parameters/period.fiscal-id_Param'
- $ref: '#/components/parameters/period.fiscal-period_Param'
- $ref: '#/components/parameters/period.fiscal-year_Param'
- $ref: '#/components/parameters/period.id_Param'
- $ref: '#/components/parameters/period.year_Param'
- $ref: '#/components/parameters/report.accession_Param'
- $ref: '#/components/parameters/report.creation-software_Param'
- $ref: '#/components/parameters/report.entry-url_Param'
- $ref: '#/components/parameters/report.id_Param'
- $ref: '#/components/parameters/report.restated_Param'
- $ref: '#/components/parameters/report.restated-index_Param'
- $ref: '#/components/parameters/report.sec-url_Param'
- $ref: '#/components/parameters/report.sic-code_Param'
- $ref: '#/components/parameters/report.source-id_Param'
- $ref: '#/components/parameters/report.source-name_Param'
- $ref: '#/components/parameters/unit_Param'
responses:
'200':
description: __fact details__ successfully accepted
content:
application/json:
schema:
type: object
properties:
documentInfo:
$ref: '#/components/schemas/documentInfo_oim_json'
facts:
$ref: '#/components/schemas/facts_oim_json'
'400':
$ref: '#/components/responses/bad_request'
'401':
$ref: '#/components/responses/bad_token'
'405':
$ref: '#/components/responses/method_not_allowed'
'500':
$ref: '#/components/responses/internal_server_error'
/api/v1/report/search:
summary: Request facts from XBRL filings based on search parameters.
get:
operationId: getReportDetails
tags: [Reports]
security:
- OAuth2: []
- bearerAuth: []
description: >
Allows searching for _XBRL reports_ based on the attributes of the report.
parameters:
- $ref: '#/components/parameters/dts.id_Param'
- $ref: '#/components/parameters/entity.cik_Param'
- $ref: '#/components/parameters/entity.id_Param'
- $ref: '#/components/parameters/entity.ticker_Param'
- $ref: '#/components/parameters/report.accession_Param'
- $ref: '#/components/parameters/report.document-type_Param'
- $ref: '#/components/parameters/report.entity-name_Param'
- $ref: '#/components/parameters/report.entry-type_Param'
- $ref: '#/components/parameters/report.entry-url_Param'
- $ref: '#/components/parameters/report.filer-category_Param'
- $ref: '#/components/parameters/report.id_Param'
- $ref: '#/components/parameters/report.is-most-current_Param'
- $ref: '#/components/parameters/report.period-index_Param'
- $ref: '#/components/parameters/report.restated_Param'
- $ref: '#/components/parameters/report.restated-index_Param'
- $ref: '#/components/parameters/report.sec-url_Param'
- $ref: '#/components/parameters/report.sic-code_Param'
- $ref: '#/components/parameters/report.source-id_Param'
- $ref: '#/components/parameters/report.source-name_Param'
- in: query
name: fields
required: true
style: form
explode: false
allowEmptyValue : false
schema:
$ref: '#/components/schemas/report_fields'
description: List of concepts to return.
responses:
'200':
description: __report details__ successfully accepted
content:
application/json:
schema:
type: object
properties:
paging:
$ref: '#/components/schemas/paging'
data:
type: array
items:
$ref: '#/components/schemas/report_details'
'400':
$ref: '#/components/responses/bad_request'
'401':
$ref: '#/components/responses/bad_token'
'405':
$ref: '#/components/responses/method_not_allowed'
'500':
$ref: '#/components/responses/internal_server_error'
/api/v1/report/{report.id}:
summary: Request report from XBRL filings based on report id parameters.
get:
operationId: getReportDetailsById
tags: [Reports]
security:
- OAuth2: []
- bearerAuth: []
description: >
Allows searching for _XBRL reports_ based on the report id attribute of the report.
parameters:
- name: report.id
in: path
description: Id of the report defined by the API.
required: true
schema:
type: integer
- in: query
name: fields
required: true
style: form
explode: false
allowEmptyValue : false
schema:
$ref: '#/components/schemas/report_fields'
description: List of concepts to return.
responses:
'200':
description: __report details__ successfully accepted
content:
application/json:
schema:
type: object
properties:
paging:
$ref: '#/components/schemas/paging'
data:
type: array
items:
$ref: '#/components/schemas/report_details'
'400':
$ref: '#/components/responses/bad_request'
'401':
$ref: '#/components/responses/bad_token'
'405':
$ref: '#/components/responses/method_not_allowed'
'500':
$ref: '#/components/responses/internal_server_error'
/api/v1/report/{report.id}/fact/search:
summary: Request report from XBRL filings based on report id parameters.
get:
operationId: getReportFactDetailsById
tags: [Reports]
security:
- bearerAuth: []
description: >
Allows searching for _XBRL reports_ based on the report id attribute of the report and to return certain facts associated with that report. The attributes of those facts can be used as search parameters.
parameters:
- name: report.id
in: path
description: Id of the report defined by the API.
required: true
schema:
type: integer
- $ref: '#/components/parameters/concept.id_Param'
- $ref: '#/components/parameters/concept.is-base_Param'
- $ref: '#/components/parameters/concept.is-monetary_Param'
- $ref: '#/components/parameters/concept.local-name_Param'
- $ref: '#/components/parameters/concept.namespace_Param'
- $ref: '#/components/parameters/dimension.is-base_Param'
- $ref: '#/components/parameters/dimension.local-name_Param'
- $ref: '#/components/parameters/dimension.namespace_Param'
- $ref: '#/components/parameters/dimensions.count_Param'
- $ref: '#/components/parameters/dimensions.id_Param'
- $ref: '#/components/parameters/dts.entry-point_Param'
- $ref: '#/components/parameters/dts.id_Param'
- $ref: '#/components/parameters/dts.target-namespace_Param'
- $ref: '#/components/parameters/entity.cik_Param'
- $ref: '#/components/parameters/entity.id_Param'
- $ref: '#/components/parameters/fact.has-dimensions_Param'
- $ref: '#/components/parameters/fact.hash_Param'
- $ref: '#/components/parameters/fact.id_Param'
- $ref: '#/components/parameters/fact.is-extended_Param'
- $ref: '#/components/parameters/fact.ultimus_Param'
- $ref: '#/components/parameters/fact.ultimus-index_Param'
- $ref: '#/components/parameters/fact.value_Param'
- $ref: '#/components/parameters/member.is-base_Param'
- $ref: '#/components/parameters/member.local-name_Param'
- $ref: '#/components/parameters/member.namespace_Param'
- $ref: '#/components/parameters/period.calendar-period_Param'
- $ref: '#/components/parameters/period.fiscal-id_Param'
- $ref: '#/components/parameters/period.fiscal-period_Param'
- $ref: '#/components/parameters/period.fiscal-year_Param'
- $ref: '#/components/parameters/period.id_Param'
- $ref: '#/components/parameters/period.year_Param'
- $ref: '#/components/parameters/report.accession_Param'
- $ref: '#/components/parameters/report.creation-software_Param'
- $ref: '#/components/parameters/report.entry-url_Param'
- $ref: '#/components/parameters/report.id_Param'
- $ref: '#/components/parameters/report.restated_Param'
- $ref: '#/components/parameters/report.restated-index_Param'
- $ref: '#/components/parameters/report.sec-url_Param'
- $ref: '#/components/parameters/report.sic-code_Param'
- $ref: '#/components/parameters/report.source-id_Param'
- $ref: '#/components/parameters/report.source-name_Param'
- $ref: '#/components/parameters/unit_Param'
- in: query
name: fields
required: true
style: form
explode: false
allowEmptyValue : false
schema:
$ref: '#/components/schemas/report_and_fact_fields'
description: List of concepts to return.
responses:
'200':
description: __report details__ successfully accepted
content:
application/json:
schema:
type: object
properties:
paging:
$ref: '#/components/schemas/paging'
data:
type: array
items:
$ref: '#/components/schemas/report_details_with_facts'
'400':
$ref: '#/components/responses/bad_request'
'401':
$ref: '#/components/responses/bad_token'
'405':
$ref: '#/components/responses/method_not_allowed'
'500':
$ref: '#/components/responses/internal_server_error'
/api/v1/report/fact/search:
summary: Request report from XBRL filings based on report id parameters.
get:
operationId: getReportFactDetailsBySearch
tags: [Reports]
security:
- OAuth2: []
- bearerAuth: []
description: >
Allows searching for _XBRL reports_ based on any report search attributes of the report and to return certain facts associated with that report. The attributes of those facts can be used as search parameters.
parameters:
- $ref: '#/components/parameters/concept.id_Param'
- $ref: '#/components/parameters/concept.is-base_Param'
- $ref: '#/components/parameters/concept.is-monetary_Param'
- $ref: '#/components/parameters/concept.local-name_Param'
- $ref: '#/components/parameters/concept.namespace_Param'
- $ref: '#/components/parameters/dimension.is-base_Param'
- $ref: '#/components/parameters/dimension.local-name_Param'
- $ref: '#/components/parameters/dimension.namespace_Param'
- $ref: '#/components/parameters/dimensions.id_Param'
- $ref: '#/components/parameters/dts.entry-point_Param'
- $ref: '#/components/parameters/dts.id_Param'
- $ref: '#/components/parameters/dts.target-namespace_Param'
- $ref: '#/components/parameters/entity.cik_Param'
- $ref: '#/components/parameters/entity.id_Param'
- $ref: '#/components/parameters/entity.ticker_Param'
- $ref: '#/components/parameters/fact.has-dimensions_Param'
- $ref: '#/components/parameters/fact.hash_Param'
- $ref: '#/components/parameters/fact.id_Param'
- $ref: '#/components/parameters/fact.is-extended_Param'
- $ref: '#/components/parameters/fact.ultimus-index_Param'
- $ref: '#/components/parameters/fact.ultimus_Param'
- $ref: '#/components/parameters/fact.value_Param'
- $ref: '#/components/parameters/member.is-base_Param'
- $ref: '#/components/parameters/member.local-name_Param'
- $ref: '#/components/parameters/member.namespace_Param'
- $ref: '#/components/parameters/period.calendar-period_Param'
- $ref: '#/components/parameters/period.fiscal-id_Param'
- $ref: '#/components/parameters/period.fiscal-period_Param'
- $ref: '#/components/parameters/period.fiscal-year_Param'
- $ref: '#/components/parameters/period.id_Param'
- $ref: '#/components/parameters/period.year_Param'
- $ref: '#/components/parameters/report.accession_Param'
- $ref: '#/components/parameters/report.creation-software_Param'
- $ref: '#/components/parameters/report.document-type_Param'
- $ref: '#/components/parameters/report.entity-name_Param'
- $ref: '#/components/parameters/report.entry-type_Param'
- $ref: '#/components/parameters/report.entry-url_Param'
- $ref: '#/components/parameters/report.filer-category_Param'
- $ref: '#/components/parameters/report.id_Param'
- $ref: '#/components/parameters/report.is-most-current_Param'
- $ref: '#/components/parameters/report.period-index_Param'
- $ref: '#/components/parameters/report.restated-index_Param'
- $ref: '#/components/parameters/report.restated_Param'
- $ref: '#/components/parameters/report.sec-url_Param'
- $ref: '#/components/parameters/report.sic-code_Param'
- $ref: '#/components/parameters/report.source-id_Param'
- $ref: '#/components/parameters/report.source-name_Param'
- $ref: '#/components/parameters/unit_Param'
- in: query
name: fields
required: true
style: form
explode: false
allowEmptyValue : false
schema:
$ref: '#/components/schemas/report_details_with_facts'
description: List of concepts to return.
responses:
'200':
description: __report details__ successfully accepted
content:
application/json:
schema:
type: object
properties:
paging:
$ref: '#/components/schemas/paging'
data:
type: array
items:
$ref: '#/components/schemas/report_details_with_facts'
'400':
$ref: '#/components/responses/bad_request'
'401':
$ref: '#/components/responses/bad_token'
'405':
$ref: '#/components/responses/method_not_allowed'
'500':
$ref: '#/components/responses/internal_server_error'
/api/v1/report/{report.id}/delete:
delete:
operationId: deleteReportDetailsById
tags: [Reports]
security:
- OAuth2: []
- bearerAuth: []
description: >
Deletes an xbrl report.
parameters:
- name: report.id
in: path
description: Id of the report defined by the API.
required: true
schema:
type: integer
responses:
'200':
description: __report details__ successfully deleted
content:
application/json:
schema:
type: object
properties:
paging:
$ref: '#/components/schemas/paging'
data:
type: array
items:
$ref: '#/components/schemas/report_details'
'400':
$ref: '#/components/responses/bad_request'
'401':
$ref: '#/components/responses/bad_token'
'405':
$ref: '#/components/responses/method_not_allowed'
'500':
$ref: '#/components/responses/internal_server_error'
/api/v1/entity/{entity.id}/report/search:
summary: Request entity information based on the entity identifier. The entity ID is an internal id used by the API.
get:
operationId: getEntityReportDetailsBasedOnID
tags: [Entity]
security:
- bearerAuth: []
description: >
Allows searching for _Entities_ based on the entity identifier associated with the reporting entity. Use this to get entity and report information for the known entity.
parameters:
- name: entity.id
in: path
description: Id of the entity defined by the API.
required: true
schema:
type: integer
- $ref: '#/components/parameters/report.source-id_Param'
- $ref: '#/components/parameters/report.source-name_Param'
- $ref: '#/components/parameters/report.accession_Param'
- $ref: '#/components/parameters/report.id_Param'
- $ref: '#/components/parameters/report.document-type_Param'
- $ref: '#/components/parameters/report.entry-type_Param'
- $ref: '#/components/parameters/report.entry-url_Param'
- $ref: '#/components/parameters/report.filer-category_Param'
- $ref: '#/components/parameters/report.is-most-current_Param'
- $ref: '#/components/parameters/report.period-index_Param'
- $ref: '#/components/parameters/report.restated_Param'
- $ref: '#/components/parameters/report.restated-index_Param'
- $ref: '#/components/parameters/report.sec-url_Param'
- $ref: '#/components/parameters/report.sic-code_Param'
- in: query
name: fields
required: true
style: form
explode: false
allowEmptyValue : false
schema:
$ref: '#/components/schemas/entity_fields'
description: List of fields to return.
responses:
'200':
description: __entity report details__ successfully accepted
content:
application/json:
schema:
type: object
properties:
paging:
$ref: '#/components/schemas/paging'
data:
type: array
items:
$ref: '#/components/schemas/entity_details'
'400':
$ref: '#/components/responses/bad_request'
'401':
$ref: '#/components/responses/bad_token'
'405':
$ref: '#/components/responses/method_not_allowed'
'500':
$ref: '#/components/responses/internal_server_error'
/api/v1/entity/report/search:
summary: Request facts from XBRL filings based on search parameters.
get:
operationId: getEntityReportDetails
tags: [Entity]
security:
- OAuth2: []
- bearerAuth: []
description: >
Allows searching for _XBRL reports_ grouped by the entity that filed the report. The API allows searching on the attributes of the entity and the report.
parameters:
- $ref: '#/components/parameters/entity.cik_Param'
- $ref: '#/components/parameters/entity.id_Param'
- $ref: '#/components/parameters/report.entity-name_Param'
- $ref: '#/components/parameters/entity.ticker_Param'
- $ref: '#/components/parameters/report.source-id_Param'
- $ref: '#/components/parameters/report.source-name_Param'
- $ref: '#/components/parameters/report.accession_Param'
- $ref: '#/components/parameters/report.id_Param'
- $ref: '#/components/parameters/report.document-type_Param'
- $ref: '#/components/parameters/report.entry-type_Param'
- $ref: '#/components/parameters/report.entry-url_Param'
- $ref: '#/components/parameters/report.filer-category_Param'
- $ref: '#/components/parameters/report.is-most-current_Param'
- $ref: '#/components/parameters/report.period-index_Param'
- $ref: '#/components/parameters/report.restated_Param'
- $ref: '#/components/parameters/report.restated-index_Param'
- $ref: '#/components/parameters/report.sec-url_Param'
- $ref: '#/components/parameters/report.sic-code_Param'
- in: query
name: fields
required: true
style: form
explode: false
allowEmptyValue : false
schema:
$ref: '#/components/schemas/entity_fields'
description: List of fields to return.
responses:
'200':
description: __entity report details__ successfully accepted
content:
application/json:
schema:
type: object
properties:
paging:
$ref: '#/components/schemas/paging'
data:
type: array
items:
$ref: '#/components/schemas/entity_details'
'400':
$ref: '#/components/responses/bad_request'
'401':
$ref: '#/components/responses/bad_token'
'405':
$ref: '#/components/responses/method_not_allowed'
'500':
$ref: '#/components/responses/internal_server_error'
/api/v1/entity/{entity.id}:
summary: Request entity information based on the entity identifier. The entity ID is an internal id used by the API.
get:
operationId: getEntityDetailsBasedOnID
tags: [Entity]
security:
- OAuth2: []
- bearerAuth: []
description: >
Allows searching for _Entities_ based on the entity identifier associated with the reporting entity. Use this to get ticker or CIK information quickly with a known entity id.
parameters:
- name: entity.id
in: path
description: Id of the entity defined by the API.
required: true
schema:
type: integer
- in: query
name: fields
required: true
style: form
explode: false
allowEmptyValue : false
schema:
$ref: '#/components/schemas/entity_only_fields'
description: List of fields to return.
responses:
'200':
description: __entity report details__ successfully accepted
content:
application/json:
schema:
type: object
properties:
paging:
$ref: '#/components/schemas/paging'
data:
type: array
items:
$ref: '#/components/schemas/entity_details'
'400':
$ref: '#/components/responses/bad_request'
'401':
$ref: '#/components/responses/bad_token'
'405':
$ref: '#/components/responses/method_not_allowed'
'500':
$ref: '#/components/responses/internal_server_error'
/api/v1/assertion/search:
summary: Request errors from XBRL filings based on search parameters.
get:
operationId: getAssertionDetails
tags: [Assertions]
security:
- OAuth2: []
- bearerAuth: []
description: >
Allows searching for errors in _XBRL reports_ based on validation frameworks used by regulators and Data Quality Committees. The API allows searching for errors by report, by error code, sverity of the error etc. .
parameters:
- $ref: '#/components/parameters/assertion.code_Param'
- $ref: '#/components/parameters/assertion.severity_Param'
- $ref: '#/components/parameters/assertion.source_Param'
- $ref: '#/components/parameters/assertion.type_Param'
- $ref: '#/components/parameters/entity.name_Param'
- $ref: '#/components/parameters/report.accession_Param'
- $ref: '#/components/parameters/report.creation-software_Param'
- $ref: '#/components/parameters/report.document-type_Param'
- $ref: '#/components/parameters/report.entry-url_Param'
- $ref: '#/components/parameters/report.filing-year_Param'
- $ref: '#/components/parameters/report.id_Param'
- $ref: '#/components/parameters/report.sec-url_Param'
- $ref: '#/components/parameters/report.sic-code_Param'
- in: query
name: fields
required: true
style: form
explode: false
allowEmptyValue : false
schema:
$ref: '#/components/schemas/assertion_fields'
description: List of fields to return.
responses:
'200':
description: __report details__ successfully accepted
content:
application/json: