-
Notifications
You must be signed in to change notification settings - Fork 0
/
InvestingAPI.yaml
16422 lines (16408 loc) · 560 KB
/
InvestingAPI.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.2
info:
title: DriveWealth API
version: '1.0'
servers:
- url: https://bo-api.drivewealth.io/back-office
description: Sandbox server (Uses test data)
- url: https://bo-api.drivewealth.net/back-office
description: Production Server (Uses LIVE data)
tags:
- name: Funds
x-displayName: Funds
- name: Trade Allocations
x-displayName: Trade Allocations
- name: Portfolios
x-displayName: Portfolios
- name: AutoPilot
x-displayName: AutoPilot
- name: Commission Schedules
x-displayName: Commission Schedules
- name: Beneficiaries
x-displayName: Beneficiaries
- name: Virtual Bank Accounts
x-displayName: Virtual Bank Accounts
- name: Statements
x-displayName: Statements
- name: Violations
x-displayName: Violations
- name: Transactions
x-displayName: Transactions
- name: Accounts
x-displayName: Accounts
- name: Deposits
x-displayName: Deposits
- name: Withdrawals
x-displayName: Withdrawals
- name: Orders
x-displayName: Orders
- name: Positions
x-displayName: Positions
- name: Asset Transfer
x-displayName: Asset Transfer
- name: Cancel Rebill
x-displayName: Cancel Rebill
- name: Auth
x-displayName: Auth
- name: Supported Countries
x-displayName: Supported Countries
- name: Disclosures
x-displayName: Disclosures
- name: Exchanges
x-displayName: Exchanges
- name: Charts
x-displayName: Charts
- name: Instruments
x-displayName: Instruments
- name: Physical Documents
x-displayName: Physical Documents
- name: Quotes
x-displayName: Quotes
- name: Depth of Book
x-displayName: Depth of Book
- name: Settlements
x-displayName: Settlements
- name: Risk
x-displayName: Risk
- name: Subscriptions
x-displayName: Subscriptions
- name: Users
x-displayName: Users
- name: Linked Bank Accounts
x-displayName: Linked Bank Accounts
- name: Advisor Reports
x-displayName: Advisor Reports
paths:
/managed/allocations:
post:
tags:
- Trade Allocations
summary: Create Trade Allocation
description: Create a Trade Allocation.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AllocationRequest'
required: true
responses:
'200':
description: Creating a Trade Allocation was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/AllocationResponse'
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
/managed/allocations/{allocationID}:
get:
tags:
- Trade Allocations
parameters:
- in: path
name: allocationID
schema:
type: string
required: true
example: JL.allocation.SomeRIACompany.9d6def3b-14d7-4934-8a64-57d443e67ce6
description: The unique identifier returned when a Trade Allocation request is made.
summary: Retrieve Trade Allocation
description: Retrieves Trade Allocation by allocationID.
responses:
'200':
description: Retrieving Trade Allocation by allocationID was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/AllocationDetails'
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
/managed/funds:
post:
tags:
- Funds
summary: Create Fund
description: Creates a Fund.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/fundsRequest'
required: true
responses:
'200':
description: Creating a Fund was Successful
content:
application/json:
schema:
$ref: '#/components/schemas/fundsResponse'
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
/managed/funds/{fundID}:
get:
tags:
- Funds
parameters:
- in: path
name: fundID
schema:
type: string
required: true
example: fund_3d7d00d1-f08e-4f52-9cbf-893c75cf77fe
description: The unique identifier associated with the Fund.
summary: Retrieve Fund
description: Retrieves a Fund by fundID.
responses:
'200':
description: Retrieving a Fund by fundID was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/fundsResponse'
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
/managed/portfolios:
post:
tags:
- Portfolios
summary: Create Portfolio
description: Creates a Portfolio.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/portfolioReq'
required: true
responses:
'200':
description: Creating a Portfolio was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/portfolioRes'
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
/managed/portfolios/{portfolioID}:
get:
tags:
- Portfolios
summary: Retrieve Portfolio
description: Retrieves a Portfolio by portfolioID.
parameters:
- in: path
name: portfolioID
schema:
type: string
required: true
example: portfolio_4a22340a-31f8-4f0e-b5ee-24ddfbc66727
description: A unique identifier associated with a specific Portfolio.
responses:
'200':
description: Retrieving a Portfolio by portfolioID was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/portfolioRes'
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
patch:
tags:
- Portfolios
summary: Update Portfolio
description: Updates a Profolio by portfolioID.
parameters:
- in: path
name: portfolioID
schema:
type: string
required: true
example: portfolio_4a22340a-31f8-4f0e-b5ee-24ddfbc66727
description: A unique identifier associated with a specific Portfolio.
requestBody:
content:
application/json:
schema:
type: object
properties:
name:
type: string
example: Recession Proof
description: A name given to the Portfolio by the RIA.
clientPortfolioID:
$ref: '#/components/schemas/clientPortfolioID'
description:
type: string
example: A portifolio description.
description: A short description for the portfolio.
holdings:
type: array
description: An array of objects that hold the type of Funds in the Portfolio.
items:
$ref: '#/components/schemas/portfolioReqHoldings'
triggers:
$ref: '#/components/schemas/portfolioTriggers'
responses:
'200':
description: Updating a Portfolio by portfolioID was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/portfolioRes'
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
/managed/autopilot/{partnerID}:
post:
tags:
- AutoPilot
parameters:
- in: path
name: partnerID
schema:
type: string
required: true
example: 66304da9-3h6f-2234-935f-ac6b7933d706
description: This is the parentIBID or userID of the registered investment advisor.
summary: Create Autopilot Run
description: Create an Autopilot Run.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/autopilotReq'
required: true
responses:
'200':
description: Creating an Autopilot Run was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/autopilotRes'
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
/managed/autopilot/{rebalanceRunID}:
get:
tags:
- AutoPilot
parameters:
- in: path
name: rebalanceRunID
schema:
type: string
required: true
example: ria_rebalance_ebf7e878-e2d6-4b3d-a333-b8ff05b92b83
description: The unique re-balance run identifier `rebalanceRunID` associated with a specific re-balance.
summary: Retrieve Autopilot Run
description: Retrieves an Autopilot Run by rebalanceRunID.
responses:
'200':
description: Retrieving an Autopilot Run by rebalanceRunID was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/runStatusRes'
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
/accounts:
post:
tags:
- Accounts
summary: Create Account
description: Creates a trading Account.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AccountReq'
examples:
Self Directed Account:
value:
userID: cc07f91b-7ee1-4868-b8fc-823c70a1b932
accountType: LIVE
accountManagementType: SELF
tradingType: CASH
Managed Account:
value:
userID: cc07f91b-7ee1-4868-b8fc-823c70a1b932
accountType: LIVE
accountManagementType: MANAGED
tradingType: CASH
Robo Advisory Account:
value:
userID: cc07f91b-7ee1-4868-b8fc-823c70a1b932
accountType: LIVE
accountManagementType: RIA_MANAGED
tradingType: CASH
riaProductID: product_b94c0b6a-5ac8-43e4-95d1-777051c0503b
riaUserID: 80f9b672-120d-4b73-9ccv9-42fb3262c4b9
required: true
responses:
'200':
description: Creating an Account was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/AccountRes'
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
/accounts/{accountID}:
get:
tags:
- Accounts
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
summary: Retrieve Account
description: Retrieves an Account details by accountID.
responses:
'200':
description: Retrieving Account details was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/AccountDetailRes'
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
patch:
tags:
- Accounts
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
summary: Update Account
description: Updates an Account details by accountID.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAcctReq'
examples:
Add Authorized User:
value:
authorizedUsers:
- userID: f6fd0783-2fdb-4ddb-9fd5-2464d8abc267
permissions:
- MINOR_GRADUATION_TRANSFER
required: true
responses:
'200':
description: Updating an Account details by accountID was Successful.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/AccountDetailRes'
- $ref: '#/components/schemas/AccountDetailResMinorTransfer'
examples:
Account Summary:
value:
account:
id: cc07f91b-7ee1-4868-b8fc-823c70a1b932.1407775317759
accountNo: DWBG000052
accountType:
name: LIVE
description: Live Account
accountMgmtType:
name: SELF
description: Self Directed Account
status:
name: OPEN
description: Open
tradingType:
name: CASH
description: Cash Account
leverage: 1
nickname: Steve's Robo Advisor Managed Account
parentIB:
id: 80f9b672-120d-4b73-9cc9-42fb3262c4b9
name: Tendies Trading Company
taxProfile:
taxStatusCode: W-9
taxRecipientCode: INDIVIDUAL
commissionID: b3e985dd-9679-63dc-5dd5-9bd7982efecd
beneficiaries: false
userID: cc07f91b-7ee1-4868-b8fc-823c70a1b932
restricted: false
goodFaithViolations: 0
patternDayTrades: 0
freeTradeBalance: 0
gfvPdtExempt: false
buyingPowerOverride: false
bod:
moneyMarket: 0
equityValue: 0
cashAvailableForWithdrawal: 0
cashAvailableForTrading: 0
cashBalance: 0
ria:
advisorID: 66304da9-3h6f-2234-935f-ac6b7933d706
productID: product_b94c0b6a-5ac8-43e4-95d1-777051c0503b
sweepInd: true
interestFree: false
createdWhen: '2022-12-22T06:07:41.773Z'
openedWhen: '2022-12-22T06:07:41Z'
updatedWhen: '2022-12-11T22:28:21.810Z'
ignoreMarketHoursForTest: false
flaggedForACATS: false
extendedHoursEnrolled: false
accountFeatures:
fixedIncome:
enrolled: true
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
/accounts/{accountID}/commissions:
get:
tags:
- Commission Schedules
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
summary: List Commission Schedules
description: Retrieves a list of Commissions Schedules by accountID.
responses:
'200':
description: Retrieving a list of Commissions Schedules was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/CommissionsRes'
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
/accounts/{accountID}/beneficiaries:
post:
tags:
- Beneficiaries
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
summary: Create Account Beneficiaries
description: Creates an Account Beneficiary by accountID.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BeneficiaryReq'
required: true
responses:
'200':
description: Creating an Account Beneficiary was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/BeneficiaryRes'
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
get:
tags:
- Beneficiaries
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
summary: Retrieve Account Beneficiaries
description: Retrieves a list of Account Beneficiaries by accountID.
responses:
'200':
description: Retrieving a list of Account Beneficiaries was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/BeneficiaryRes'
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
delete:
tags:
- Beneficiaries
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
summary: Delete Account Beneficiaries
description: Removes all Accounts Beneficiaries by accountID.
responses:
'202':
description: Removing all Account Beneficiaries was Accepted.
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
/accounts/{accountID}/funding/deposit-instructions:
get:
tags:
- Virtual Bank Accounts
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
summary: Retrieve Account Virtual Bank Account
description: Retrieves an Account Virtual Bank Account details by accountID.
responses:
'200':
description: Retrieving Virtual Bank Account details by accountID was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/VirtualAccountRes'
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
/accounts/{accountID}/funding/deposits:
get:
tags:
- Deposits
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
summary: List Account Deposits
description: Retrieves a list of Account Deposits by accountID.
responses:
'200':
description: Retrieving a list of Account Deposits was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/depositsByUserIDObject'
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
/accounts/{accountID}/funding/redemptions:
get:
tags:
- Withdrawals
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
summary: List Account Withdrawals
description: Retrieves a list of Account Withdrawals by accountID
responses:
'200':
description: Retrieving a list of Account Withdrawals was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/Redemptions'
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
/accounts/{accountID}/summary/orders:
get:
tags:
- Orders
summary: List Account Orders
description: Retrives a list of Account Orders by accountID.
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
responses:
'200':
description: Retrieving a list of Account Orders was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/PendingOrders'
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
/accounts/{accountID}/reports/order-history:
get:
tags:
- Orders
summary: List Account Orders
description: Retrieves a list of Account Orders by accountID.
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
- in: query
name: from
schema:
type: string
required: true
example: '2022-06-16'
description: Date start time of data. Follow [ISO 8601 standard](https://en.wikipedia.org/wiki/ISO_8601)
- in: query
name: to
schema:
type: string
required: true
example: '2022-07-16'
description: Date end time of data. Follow [ISO 8601 standard](https://en.wikipedia.org/wiki/ISO_8601)
- in: query
name: limit
schema:
type: number
required: false
example: 25
description: The number of orders to be returned per page.
- in: query
name: offset
schema:
type: string
required: false
example: '2022-07-16'
description: Follow [ISO 8601 standard](https://en.wikipedia.org/wiki/ISO_8601)
- in: query
name: direction
schema:
type: string
enum:
- prev
- next
required: false
example: prev
description: The direction of pagination.
responses:
'200':
description: Retrieving a list of Account Orders was Successful
content:
application/json:
schema:
$ref: '#/components/schemas/OrderHistoryRes'
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
/accounts/{accountID}/portfolio:
get:
tags:
- AutoPilot
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
summary: Retrieve Portfolio by Account
description: Retrieve Portfolio details by accountID.
responses:
'200':
description: Fetching Portfolio details was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/PortfolioStatusRes'
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
/accounts/{accountID}/summary/money:
get:
tags:
- Accounts
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
summary: Retrieve Account Cash
description: Retrieves an Account Cash details by accountID.
responses:
'200':
description: Retrieving Money details was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/MoneyDetailsRes'
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
/accounts/{accountID}/statements:
get:
tags:
- Statements
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
summary: List Account Statements
description: Retrives a list of Account Statements by accountID.
responses:
'200':
description: Retrieving a list of Account Statements by accountID was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/StatementListRes'
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
/accounts/{accountID}/taxforms:
get:
tags:
- Statements
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
- $ref: '#/components/parameters/fromParams'
- $ref: '#/components/parameters/toParams'
summary: List Account Tax Statements
description: Retrieves a list of Account Tax Statements by accountID.
responses:
'200':
description: Retrieving a list of Account Tax Statements by accountID was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/ListTaxDocsRes'
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
/accounts/{accountID}/confirms:
get:
tags:
- Statements
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
- in: query
name: from
schema:
type: string
required: false
example: '2018-09-18'
description: Filter, the date from which to start the search.
- in: query
name: to
schema:
type: string
required: false
example: '2019-09-18'
description: Filter, the date to which to end the search.
summary: List Account Trade Confirmations
description: Retrieves a list of Account Trade Confirmations by accountID.
responses:
'200':
description: Retrieving a list of Account Trade Confirmations by accountID was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/ListTradeConfirmsRes'
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
/accounts/{accountID}/summary:
get:
tags:
- Accounts
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
summary: Retrieve Account Summary
description: Retrieves an Account Summary details by accountID.
deprecated: true
responses:
'200':
description: Retrieving Account Summary details by accountID was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/SummaryRes'
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
/accounts/{accountID}/performance:
get:
tags:
- Accounts
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
- in: query
name: period
schema:
type: string
enum:
- 1d
- '*d'
- 1w
- '*w'
- 1m
- '*m'
- 1y
- '*y'
required: false
example: 3d
description: 'Used for relative date range, accepts a number and a unit of time (E.g: 3d = 3 Days or 2w = 2 Weeks).'
- in: query
name: from
schema:
type: string
required: false
example: '2018-09-18'
description: Start date and time of requested time frame of the accounts performance.
- in: query
name: to
schema:
type: string
required: false
example: '2019-09-18'
description: End date and time of requested time frame of the accounts performance.
summary: Retrieve Account Performance
description: Retrieves realtime Account Performance details by accountID.
responses:
'200':
description: Retrieving realtime Account Performance details by accountID was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/PerformanceRes'
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
/accounts/{accountID}/summary/positions:
get:
tags:
- Positions
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
summary: List Account Positions
description: Retrives a list of Account Positions by accountID
responses:
'200':
description: Retrieving an Account's Positions by accountID was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/PositionsRes'
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
/accounts/{accountID}/summary/violations:
get:
tags:
- Violations
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
summary: Retrieve Account Violations Summary
description: Retrives Account Violations Summary details by accountID.
responses:
'200':