-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathInvestingAPI.yaml
16370 lines (16337 loc) · 541 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:
- description: Sandbox server (Uses test data)
url: https://bo-api.drivewealth.io/back-office
- description: Production Server (Uses LIVE data)
url: https://bo-api.drivewealth.net/back-office
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
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
description: Create an allocation of securities to a User's Account.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AllocationRequest'
required: true
responses:
'200':
description: The creation of a Trade Allocation was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/AllocationResponse'
/managed/allocations/{allocationID}:
get:
tags:
- Trade Allocations
summary: Retrieve Trade Allocation
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
description: Fetches the details of a Trade Allocation using the allocationID.
parameters:
- description: >-
The unique identifier returned when a Trade Allocation request is
made.
in: path
name: allocationID
schema:
type: string
required: true
example: JL.allocation.SomeRIACompany.9d6def3b-14d7-4934-8a64-57d443e67ce6
responses:
'200':
description: Fetch Trade Allocation details by allocationID was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/AllocationDetails'
/managed/funds:
post:
tags:
- Funds
summary: Create Fund
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
description: Create a Fund containing a collection of securities.
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'
/managed/funds/{fundID}:
get:
tags:
- Funds
summary: Get Fund details by fundID
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
description: Fetch the details of a fund using the unique fundID.
parameters:
- description: The unique identifier associated with the Fund.
in: path
name: fundID
schema:
type: string
required: true
example: fund_3d7d00d1-f08e-4f52-9cbf-893c75cf77fe
responses:
'200':
description: Fetch fund details was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/fundsResponse'
/managed/portfolios:
post:
tags:
- Portfolios
summary: Create Portfolio
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
description: Create a Portfolio to hold an allocation of funds.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/portfolioReq'
required: true
responses:
'200':
description: The creation of a Portfolio was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/portfolioRes'
/managed/portfolios/{portfolioID}:
get:
tags:
- Portfolios
summary: Retrieve Portfolio
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
description: Get the details of a specific Portfolio using the portfolioID.
parameters:
- description: A unique identifier associated with a specific Portfolio.
in: path
name: portfolioID
schema:
type: string
required: true
example: portfolio_4a22340a-31f8-4f0e-b5ee-24ddfbc66727
responses:
'200':
description: Fetch a portfolio by portfolioID was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/portfolioRes'
patch:
tags:
- Portfolios
summary: Update Portfolio
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
description: Edit the holdings of an existing portfolio using the portfolioID.
parameters:
- description: A unique identifier associated with a specific Portfolio.
in: path
name: portfolioID
schema:
type: string
required: true
example: portfolio_4a22340a-31f8-4f0e-b5ee-24ddfbc66727
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/holdingsObject'
responses:
'200':
description: Edit a portfolio by portfolioID was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/portfolioRes'
/managed/autopilot/{partnerID}:
post:
tags:
- AutoPilot
summary: Create Autopilot run
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
description: Create an Autopilot run for a users account.
parameters:
- description: >-
This is the parentIBID or userID of the registered investment
advisor.
in: path
name: partnerID
schema:
type: string
required: true
example: 66304da9-3h6f-2234-935f-ac6b7933d706
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/autopilotReq'
required: true
responses:
'200':
description: The creation of an autopilot run was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/autopilotRes'
/managed/autopilot/{rebalanceRunID}:
get:
tags:
- AutoPilot
summary: Retrieve Autopilot run
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
description: >-
Fetch the details and run status for a re-balance using the unique
rebalanceRunID.
parameters:
- description: >-
The unique re-balance run identifier `rebalanceRunID` associated
with a specific re-balance.
in: path
name: rebalanceRunID
schema:
type: string
required: true
example: ria_rebalance_ebf7e878-e2d6-4b3d-a333-b8ff05b92b83
responses:
'200':
description: Fetch autopilot run details by rebalanceRunID was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/runStatusRes'
/accounts:
post:
tags:
- Accounts
summary: Create Account
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
description: Create a new brokerage Account for a User.
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: Account creation was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/AccountRes'
/accounts/{accountID}:
get:
tags:
- Accounts
summary: Retrieve Account
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
description: Fetch Account details using the unique accountID.
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
responses:
'200':
description: Fetch account details was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/AccountDetailRes'
patch:
tags:
- Accounts
summary: Update Account
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
description: Update an Account's information by using a User's Account ID.
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateAcctReq'
required: true
responses:
'200':
description: Update account details was Successful.
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/AccountDetailRes'
- $ref: '#/components/schemas/AccountDetailResMinorTransfer'
examples:
Example1:
value:
account:
id: cc07f91b-7ee1-4868-b8fc-823c70a1b932.1407775317759
accountNo: DWBG000052
accountType:
description: Live Account
name: LIVE
accountMgmtType:
description: Self Directed Account
name: SELF
status:
description: Open
name: OPEN
tradingType:
description: Cash Account
name: CASH
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
Add Authorized User:
value:
authorizedUsers:
- userID: f6fd0783-2fdb-4ddb-9fd5-2464d8abc267
permissions:
- MINOR_GRADUATION_TRANSFER
/accounts/{accountID}/commissions:
get:
tags:
- Commission Schedules
summary: List all Commission Schedules
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
description: >-
Fetch a list of all commissions available for a customers account
associated to its parentIBID.
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
responses:
'200':
description: Fetch a list of commissions was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/CommissionsRes'
/accounts/{accountID}/beneficiaries:
post:
tags:
- Beneficiaries
summary: Create Beneficiaries
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
description: >-
Create a new set of Beneficiaries or contingent Beneficiaries on an
existing Account.
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BeneficiaryReq'
required: true
responses:
'200':
description: Beneficiary creation was successful.
content:
application/json:
schema:
$ref: '#/components/schemas/BeneficiaryRes'
get:
tags:
- Beneficiaries
summary: Retrieve Beneficiaries by Account
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
description: List all existing Beneficiaries on an Account.
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
responses:
'200':
description: Fetch list of beneficiaries was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/BeneficiaryRes'
delete:
tags:
- Beneficiaries
summary: Delete Beneficiaries
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
description: Removes all Beneficiaries from an account.
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
responses:
'202':
description: Beneficiaries has been recorded for deletion.
/accounts/{accountID}/funding/deposit-instructions:
get:
tags:
- Virtual Bank Accounts
summary: Retrieve Virtual Bank Account by Account
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
description: Fetch a customers virtual account details.
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
responses:
'200':
description: Fetch virtual account details was Successful.
content:
application/json:
schema:
$ref: '#/components/schemas/VirtualAccountRes'
/accounts/{accountID}/funding/deposits:
get:
tags:
- Deposits
summary: List Deposits by Account
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
description: Fetch all Deposits associated with a specific Account.
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
responses:
'200':
description: Fetching a list of an Account's Deposits was successful.
content:
application/json:
schema:
$ref: '#/components/schemas/depositsByUserIDObject'
/accounts/{accountID}/funding/redemptions:
get:
tags:
- Withdrawals
summary: List Withdrawals by Account
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
description: Fetch a list of Withdrawals associated to a specific Account.
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
responses:
'200':
description: Fetching a list of Account's Withdrawals was successful.
content:
application/json:
schema:
$ref: '#/components/schemas/Redemptions'
/accounts/{accountID}/summary/orders:
get:
tags:
- Orders
summary: Retrieve pending Orders by Account
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
description: Fetch a list of pending orders for a users account.
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
responses:
'200':
description: Fetching a list of pending Orders was successful.
content:
application/json:
schema:
$ref: '#/components/schemas/PendingOrders'
/accounts/{accountID}/reports/order-history:
get:
tags:
- Orders
summary: Retrieve all Orders by Account
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
description: Fetch a list of all orders for a users account.
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
- description: >-
Date start time of data. Follow [ISO 8601
standard](https://en.wikipedia.org/wiki/ISO_8601)
in: query
name: from
schema:
type: string
required: true
example: '2022-06-16'
- description: >-
Date end 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: The number of orders to be returned per page.
in: query
name: limit
schema:
type: number
required: false
example: 25
- description: Follow [ISO 8601 standard](https://en.wikipedia.org/wiki/ISO_8601)
in: query
name: offset
schema:
type: string
required: false
example: '2022-07-16'
- description: The direction of pagination.
in: query
name: direction
schema:
type: string
enum:
- prev
- next
required: false
example: prev
responses:
'200':
description: Fetching Order history was successful
content:
application/json:
schema:
$ref: '#/components/schemas/OrderHistoryRes'
/accounts/{accountID}/portfolio:
get:
tags:
- AutoPilot
summary: Retrieve portfolio status by Account
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
description: Fetch the status of a portfolio using the accountID.
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
responses:
'200':
description: Fetching portfolio status details was successful.
content:
application/json:
schema:
$ref: '#/components/schemas/PortfolioStatusRes'
/accounts/{accountID}/summary/money:
get:
tags:
- Accounts
summary: Retrieve money details by Account
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
description: Fetch a real time snapshot of cash balances of an account.
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
responses:
'200':
description: Fetching cash balance details of an Account was successful.
content:
application/json:
schema:
$ref: '#/components/schemas/MoneyDetailsRes'
/accounts/{accountID}/statements:
get:
tags:
- Statements
summary: List monthly statements by Account
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
description: List all statement files for a particular account.
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
responses:
'200':
description: Fetching a list of Statements for an Account was successful.
content:
application/json:
schema:
$ref: '#/components/schemas/StatementListRes'
/accounts/{accountID}/taxforms:
get:
tags:
- Statements
summary: List tax documents by Account
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
description: Fetch a list of all the tax documents for a particular account.
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
responses:
'200':
description: Fetching a list of tax documents for an Account was successful.
content:
application/json:
schema:
$ref: '#/components/schemas/ListTaxDocsRes'
/accounts/{accountID}/confirms:
get:
tags:
- Statements
summary: List trade confirmations by Account
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
description: List all trade confirmation files for a particular account.
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
responses:
'200':
description: Fetching a list of trade confirmations was successful.
content:
application/json:
schema:
$ref: '#/components/schemas/ListTradeConfirmsRes'
/accounts/{accountID}/summary:
get:
tags:
- Accounts
summary: Retrieve summary by Account
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
description: >-
Fetch an account summary with the balance, orders, positions, violations
and transactions of a particular Account.
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
responses:
'200':
description: Fetching account summary details was successful.
content:
application/json:
schema:
$ref: '#/components/schemas/SummaryRes'
deprecated: true
/accounts/{accountID}/performance:
get:
tags:
- Accounts
summary: Retrieve performance by Account
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
description: >-
Fetch the daily realized and unrealized profit/loss for a specific
account.
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
- 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: period
schema:
type: string
enum:
- 1d
- '*d'
- 1w
- '*w'
- 1m
- '*m'
- 1y
- '*y'
required: false
example: 3d
- description: >-
Start date and time of requested time frame of the accounts
performance.
in: query
name: from
schema:
type: string
required: false
example: '2018-09-18'
- description: >-
End date and time of requested time frame of the accounts
performance.
in: query
name: to
schema:
type: string
required: false
example: '2019-09-18'
responses:
'200':
description: Fetching account performance details was successful.
content:
application/json:
schema:
$ref: '#/components/schemas/PerformanceRes'
/accounts/{accountID}/summary/positions:
get:
tags:
- Positions
summary: List Positions by Account
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
description: Fetch a list of all the equity positions related to an account.
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
responses:
'200':
description: Fetching an Account's Positions was successful.
content:
application/json:
schema:
$ref: '#/components/schemas/PositionsRes'
/accounts/{accountID}/summary/violations:
get:
tags:
- Violations
summary: Retrieve violation summary by Account
security:
- bearerAuth: []
dwAppKey: []
- sessionToken: []
dwAppKey: []
description: Fetch the summary of all current account violations.
parameters:
- in: path
name: accountID
schema:
$ref: '#/components/schemas/accountID'
required: true
responses:
'200':
description: Fetching an Account's violation summary was Successful.
content:
application/json:
schema: