snaptrade-typescript-sdk 5.0.0 → 6.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.konfig/generate-id.txt +1 -1
- package/README.md +2 -2
- package/api/account-information-api.ts +136 -120
- package/api/api-disclaimer-api.ts +14 -19
- package/api/authentication-api.ts +37 -43
- package/api/connections-api.ts +46 -40
- package/api/error-logs-api.ts +12 -10
- package/api/options-api.ts +104 -108
- package/api/portfolio-management-api.ts +259 -253
- package/api/reference-data-api.ts +49 -53
- package/api/trading-api.ts +172 -185
- package/api/transactions-and-reporting-api.ts +64 -60
- package/client.ts +2 -0
- package/configuration.ts +1 -1
- package/dist/api/account-information-api.d.ts +112 -112
- package/dist/api/api-disclaimer-api.d.ts +10 -16
- package/dist/api/api-disclaimer-api.js +1 -1
- package/dist/api/authentication-api.d.ts +27 -40
- package/dist/api/authentication-api.js +2 -2
- package/dist/api/connections-api.d.ts +38 -38
- package/dist/api/error-logs-api.d.ts +10 -10
- package/dist/api/options-api.d.ts +82 -94
- package/dist/api/options-api.js +2 -2
- package/dist/api/portfolio-management-api.d.ts +214 -256
- package/dist/api/portfolio-management-api.js +7 -7
- package/dist/api/reference-data-api.d.ts +37 -50
- package/dist/api/reference-data-api.js +2 -2
- package/dist/api/trading-api.d.ts +131 -160
- package/dist/api/trading-api.js +10 -10
- package/dist/api/transactions-and-reporting-api.d.ts +52 -52
- package/dist/configuration.js +1 -1
- package/dist/models/index.d.ts +1 -0
- package/dist/models/index.js +1 -0
- package/dist/models/target-asset.d.ts +4 -2
- package/dist/models/trading-cancel-user-account-order-request.d.ts +24 -0
- package/dist/models/trading-cancel-user-account-order-request.js +15 -0
- package/docs/AccountInformationApi.md +72 -88
- package/docs/ApiDisclaimerApi.md +8 -12
- package/docs/ApiStatusApi.md +6 -7
- package/docs/AuthenticationApi.md +34 -48
- package/docs/ConnectionsApi.md +26 -32
- package/docs/ErrorLogsApi.md +8 -10
- package/docs/OptionsApi.md +55 -62
- package/docs/PortfolioManagementApi.md +229 -309
- package/docs/ReferenceDataApi.md +66 -93
- package/docs/TradingApi.md +88 -117
- package/docs/TransactionsAndReportingApi.md +26 -28
- package/index.test.ts +2 -4
- package/models/index.ts +1 -0
- package/models/target-asset.ts +2 -2
- package/models/trading-cancel-user-account-order-request.ts +29 -0
- package/package.json +1 -1
|
@@ -40,7 +40,8 @@ Method | HTTP request | Description
|
|
|
40
40
|
|
|
41
41
|
|
|
42
42
|
# **addPortfolioExcludedAsset**
|
|
43
|
-
|
|
43
|
+
|
|
44
|
+
#### **POST** /portfolioGroups/{portfolioGroupId}/excludedassets
|
|
44
45
|
|
|
45
46
|
|
|
46
47
|
### Example
|
|
@@ -56,16 +57,15 @@ const snaptrade = new Snaptrade({
|
|
|
56
57
|
clientId: "YOUR_CLIENT_ID",
|
|
57
58
|
})
|
|
58
59
|
|
|
59
|
-
const
|
|
60
|
-
|
|
61
|
-
'requestBody': {
|
|
60
|
+
const addPortfolioExcludedAssetResponse = await snaptrade.portfolioManagement.addPortfolioExcludedAsset({
|
|
61
|
+
"portfolioGroupId": "portfolioGroupId_example",
|
|
62
62
|
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
|
|
63
63
|
"symbol": "VAB.TO",
|
|
64
64
|
"raw_symbol": "VAB",
|
|
65
65
|
"description": "VANGUARD CDN AGGREGATE BOND INDEX ETF",
|
|
66
|
-
}
|
|
67
|
-
|
|
68
|
-
console.log(
|
|
66
|
+
})
|
|
67
|
+
|
|
68
|
+
console.log(addPortfolioExcludedAssetResponse)
|
|
69
69
|
|
|
70
70
|
```
|
|
71
71
|
|
|
@@ -82,10 +82,6 @@ Name | Type | Description | Notes
|
|
|
82
82
|
|
|
83
83
|
**ExcludedAsset**
|
|
84
84
|
|
|
85
|
-
### Authorization
|
|
86
|
-
|
|
87
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
88
|
-
|
|
89
85
|
### HTTP request headers
|
|
90
86
|
|
|
91
87
|
- **Content-Type**: application/json
|
|
@@ -100,7 +96,8 @@ Name | Type | Description | Notes
|
|
|
100
96
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
101
97
|
|
|
102
98
|
# **create**
|
|
103
|
-
|
|
99
|
+
|
|
100
|
+
#### **POST** /portfolioGroups
|
|
104
101
|
|
|
105
102
|
|
|
106
103
|
### Example
|
|
@@ -116,15 +113,14 @@ const snaptrade = new Snaptrade({
|
|
|
116
113
|
clientId: "YOUR_CLIENT_ID",
|
|
117
114
|
})
|
|
118
115
|
|
|
119
|
-
const
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
'requestBody': {
|
|
116
|
+
const createResponse = await snaptrade.portfolioManagement.create({
|
|
117
|
+
"userId": "John.doe@snaptrade.com",
|
|
118
|
+
"userSecret": "USERSECRET123",
|
|
123
119
|
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
|
|
124
120
|
"name": "Combined Retirement Portfolio",
|
|
125
|
-
}
|
|
126
|
-
|
|
127
|
-
console.log(
|
|
121
|
+
})
|
|
122
|
+
|
|
123
|
+
console.log(createResponse)
|
|
128
124
|
|
|
129
125
|
```
|
|
130
126
|
|
|
@@ -142,10 +138,6 @@ Name | Type | Description | Notes
|
|
|
142
138
|
|
|
143
139
|
**Array<PortfolioGroup>**
|
|
144
140
|
|
|
145
|
-
### Authorization
|
|
146
|
-
|
|
147
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
148
|
-
|
|
149
141
|
### HTTP request headers
|
|
150
142
|
|
|
151
143
|
- **Content-Type**: application/json
|
|
@@ -162,7 +154,8 @@ Name | Type | Description | Notes
|
|
|
162
154
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
163
155
|
|
|
164
156
|
# **createAssetClass**
|
|
165
|
-
|
|
157
|
+
|
|
158
|
+
#### **POST** /modelAssetClass
|
|
166
159
|
|
|
167
160
|
|
|
168
161
|
### Example
|
|
@@ -178,8 +171,9 @@ const snaptrade = new Snaptrade({
|
|
|
178
171
|
clientId: "YOUR_CLIENT_ID",
|
|
179
172
|
})
|
|
180
173
|
|
|
181
|
-
const
|
|
182
|
-
|
|
174
|
+
const createAssetClassResponse = await snaptrade.portfolioManagement.createAssetClass()
|
|
175
|
+
|
|
176
|
+
console.log(createAssetClassResponse)
|
|
183
177
|
|
|
184
178
|
```
|
|
185
179
|
|
|
@@ -192,10 +186,6 @@ This endpoint does not need any parameter.
|
|
|
192
186
|
|
|
193
187
|
**ModelAssetClassDetails**
|
|
194
188
|
|
|
195
|
-
### Authorization
|
|
196
|
-
|
|
197
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
198
|
-
|
|
199
189
|
### HTTP request headers
|
|
200
190
|
|
|
201
191
|
- **Content-Type**: Not defined
|
|
@@ -210,7 +200,8 @@ This endpoint does not need any parameter.
|
|
|
210
200
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
211
201
|
|
|
212
202
|
# **createModelPortfolio**
|
|
213
|
-
|
|
203
|
+
|
|
204
|
+
#### **POST** /modelPortfolio
|
|
214
205
|
|
|
215
206
|
|
|
216
207
|
### Example
|
|
@@ -226,8 +217,9 @@ const snaptrade = new Snaptrade({
|
|
|
226
217
|
clientId: "YOUR_CLIENT_ID",
|
|
227
218
|
})
|
|
228
219
|
|
|
229
|
-
const
|
|
230
|
-
|
|
220
|
+
const createModelPortfolioResponse = await snaptrade.portfolioManagement.createModelPortfolio()
|
|
221
|
+
|
|
222
|
+
console.log(createModelPortfolioResponse)
|
|
231
223
|
|
|
232
224
|
```
|
|
233
225
|
|
|
@@ -240,10 +232,6 @@ This endpoint does not need any parameter.
|
|
|
240
232
|
|
|
241
233
|
**ModelPortfolioDetails**
|
|
242
234
|
|
|
243
|
-
### Authorization
|
|
244
|
-
|
|
245
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
246
|
-
|
|
247
235
|
### HTTP request headers
|
|
248
236
|
|
|
249
237
|
- **Content-Type**: Not defined
|
|
@@ -258,7 +246,8 @@ This endpoint does not need any parameter.
|
|
|
258
246
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
259
247
|
|
|
260
248
|
# **deleteAssetClass**
|
|
261
|
-
|
|
249
|
+
|
|
250
|
+
#### **DELETE** /modelAssetClass/{modelAssetClassId}
|
|
262
251
|
|
|
263
252
|
|
|
264
253
|
### Example
|
|
@@ -274,10 +263,11 @@ const snaptrade = new Snaptrade({
|
|
|
274
263
|
clientId: "YOUR_CLIENT_ID",
|
|
275
264
|
})
|
|
276
265
|
|
|
277
|
-
const
|
|
278
|
-
|
|
279
|
-
})
|
|
280
|
-
|
|
266
|
+
const deleteAssetClassResponse = await snaptrade.portfolioManagement.deleteAssetClass({
|
|
267
|
+
"modelAssetClassId": "2bcd7cc3-e922-4976-bce1-9858296801c3",
|
|
268
|
+
})
|
|
269
|
+
|
|
270
|
+
console.log(deleteAssetClassResponse)
|
|
281
271
|
|
|
282
272
|
```
|
|
283
273
|
|
|
@@ -293,10 +283,6 @@ Name | Type | Description | Notes
|
|
|
293
283
|
|
|
294
284
|
void (empty response body)
|
|
295
285
|
|
|
296
|
-
### Authorization
|
|
297
|
-
|
|
298
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
299
|
-
|
|
300
286
|
### HTTP request headers
|
|
301
287
|
|
|
302
288
|
- **Content-Type**: Not defined
|
|
@@ -311,7 +297,8 @@ void (empty response body)
|
|
|
311
297
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
312
298
|
|
|
313
299
|
# **deleteExcludedAsset**
|
|
314
|
-
|
|
300
|
+
|
|
301
|
+
#### **DELETE** /portfolioGroups/{portfolioGroupId}/excludedassets/{symbolId}
|
|
315
302
|
|
|
316
303
|
|
|
317
304
|
### Example
|
|
@@ -327,11 +314,12 @@ const snaptrade = new Snaptrade({
|
|
|
327
314
|
clientId: "YOUR_CLIENT_ID",
|
|
328
315
|
})
|
|
329
316
|
|
|
330
|
-
const
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
})
|
|
334
|
-
|
|
317
|
+
const deleteExcludedAssetResponse = await snaptrade.portfolioManagement.deleteExcludedAsset({
|
|
318
|
+
"portfolioGroupId": "portfolioGroupId_example",
|
|
319
|
+
"symbolId": "symbolId_example",
|
|
320
|
+
})
|
|
321
|
+
|
|
322
|
+
console.log(deleteExcludedAssetResponse)
|
|
335
323
|
|
|
336
324
|
```
|
|
337
325
|
|
|
@@ -348,10 +336,6 @@ Name | Type | Description | Notes
|
|
|
348
336
|
|
|
349
337
|
void (empty response body)
|
|
350
338
|
|
|
351
|
-
### Authorization
|
|
352
|
-
|
|
353
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
354
|
-
|
|
355
339
|
### HTTP request headers
|
|
356
340
|
|
|
357
341
|
- **Content-Type**: Not defined
|
|
@@ -366,7 +350,8 @@ void (empty response body)
|
|
|
366
350
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
367
351
|
|
|
368
352
|
# **deleteModelPortfolioById**
|
|
369
|
-
|
|
353
|
+
|
|
354
|
+
#### **DELETE** /modelPortfolio/{modelPortfolioId}
|
|
370
355
|
|
|
371
356
|
|
|
372
357
|
### Example
|
|
@@ -382,10 +367,11 @@ const snaptrade = new Snaptrade({
|
|
|
382
367
|
clientId: "YOUR_CLIENT_ID",
|
|
383
368
|
})
|
|
384
369
|
|
|
385
|
-
const
|
|
386
|
-
|
|
387
|
-
})
|
|
388
|
-
|
|
370
|
+
const deleteModelPortfolioByIdResponse = await snaptrade.portfolioManagement.deleteModelPortfolioById({
|
|
371
|
+
"modelPortfolioId": "2bcd7cc3-e922-4976-bce1-9858296801c3",
|
|
372
|
+
})
|
|
373
|
+
|
|
374
|
+
console.log(deleteModelPortfolioByIdResponse)
|
|
389
375
|
|
|
390
376
|
```
|
|
391
377
|
|
|
@@ -401,10 +387,6 @@ Name | Type | Description | Notes
|
|
|
401
387
|
|
|
402
388
|
void (empty response body)
|
|
403
389
|
|
|
404
|
-
### Authorization
|
|
405
|
-
|
|
406
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
407
|
-
|
|
408
390
|
### HTTP request headers
|
|
409
391
|
|
|
410
392
|
- **Content-Type**: Not defined
|
|
@@ -419,7 +401,8 @@ void (empty response body)
|
|
|
419
401
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
420
402
|
|
|
421
403
|
# **deletePortfoli**
|
|
422
|
-
|
|
404
|
+
|
|
405
|
+
#### **DELETE** /portfolioGroups/{portfolioGroupId}
|
|
423
406
|
|
|
424
407
|
|
|
425
408
|
### Example
|
|
@@ -435,10 +418,11 @@ const snaptrade = new Snaptrade({
|
|
|
435
418
|
clientId: "YOUR_CLIENT_ID",
|
|
436
419
|
})
|
|
437
420
|
|
|
438
|
-
const
|
|
439
|
-
|
|
440
|
-
})
|
|
441
|
-
|
|
421
|
+
const deletePortfoliResponse = await snaptrade.portfolioManagement.deletePortfoli({
|
|
422
|
+
"portfolioGroupId": "portfolioGroupId_example",
|
|
423
|
+
})
|
|
424
|
+
|
|
425
|
+
console.log(deletePortfoliResponse)
|
|
442
426
|
|
|
443
427
|
```
|
|
444
428
|
|
|
@@ -454,10 +438,6 @@ Name | Type | Description | Notes
|
|
|
454
438
|
|
|
455
439
|
**PortfolioGroup**
|
|
456
440
|
|
|
457
|
-
### Authorization
|
|
458
|
-
|
|
459
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
460
|
-
|
|
461
441
|
### HTTP request headers
|
|
462
442
|
|
|
463
443
|
- **Content-Type**: Not defined
|
|
@@ -475,7 +455,8 @@ Name | Type | Description | Notes
|
|
|
475
455
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
476
456
|
|
|
477
457
|
# **deletePortfolioTargetById**
|
|
478
|
-
|
|
458
|
+
|
|
459
|
+
#### **DELETE** /portfolioGroups/{portfolioGroupId}/targets/{targetAssetId}
|
|
479
460
|
|
|
480
461
|
|
|
481
462
|
### Example
|
|
@@ -491,11 +472,12 @@ const snaptrade = new Snaptrade({
|
|
|
491
472
|
clientId: "YOUR_CLIENT_ID",
|
|
492
473
|
})
|
|
493
474
|
|
|
494
|
-
const
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
})
|
|
498
|
-
|
|
475
|
+
const deletePortfolioTargetByIdResponse = await snaptrade.portfolioManagement.deletePortfolioTargetById({
|
|
476
|
+
"portfolioGroupId": "portfolioGroupId_example",
|
|
477
|
+
"targetAssetId": "targetAssetId_example",
|
|
478
|
+
})
|
|
479
|
+
|
|
480
|
+
console.log(deletePortfolioTargetByIdResponse)
|
|
499
481
|
|
|
500
482
|
```
|
|
501
483
|
|
|
@@ -512,10 +494,6 @@ Name | Type | Description | Notes
|
|
|
512
494
|
|
|
513
495
|
**TargetAsset**
|
|
514
496
|
|
|
515
|
-
### Authorization
|
|
516
|
-
|
|
517
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
518
|
-
|
|
519
497
|
### HTTP request headers
|
|
520
498
|
|
|
521
499
|
- **Content-Type**: Not defined
|
|
@@ -533,7 +511,8 @@ Name | Type | Description | Notes
|
|
|
533
511
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
534
512
|
|
|
535
513
|
# **detailAssetClass**
|
|
536
|
-
|
|
514
|
+
|
|
515
|
+
#### **GET** /modelAssetClass/{modelAssetClassId}
|
|
537
516
|
|
|
538
517
|
|
|
539
518
|
### Example
|
|
@@ -549,10 +528,11 @@ const snaptrade = new Snaptrade({
|
|
|
549
528
|
clientId: "YOUR_CLIENT_ID",
|
|
550
529
|
})
|
|
551
530
|
|
|
552
|
-
const
|
|
553
|
-
|
|
554
|
-
})
|
|
555
|
-
|
|
531
|
+
const detailAssetClassResponse = await snaptrade.portfolioManagement.detailAssetClass({
|
|
532
|
+
"modelAssetClassId": "2bcd7cc3-e922-4976-bce1-9858296801c3",
|
|
533
|
+
})
|
|
534
|
+
|
|
535
|
+
console.log(detailAssetClassResponse)
|
|
556
536
|
|
|
557
537
|
```
|
|
558
538
|
|
|
@@ -568,10 +548,6 @@ Name | Type | Description | Notes
|
|
|
568
548
|
|
|
569
549
|
**ModelAssetClassDetails**
|
|
570
550
|
|
|
571
|
-
### Authorization
|
|
572
|
-
|
|
573
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
574
|
-
|
|
575
551
|
### HTTP request headers
|
|
576
552
|
|
|
577
553
|
- **Content-Type**: Not defined
|
|
@@ -586,7 +562,8 @@ Name | Type | Description | Notes
|
|
|
586
562
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
587
563
|
|
|
588
564
|
# **getCalculatedTradeById**
|
|
589
|
-
|
|
565
|
+
|
|
566
|
+
#### **GET** /portfolioGroups/{portfolioGroupId}/calculatedtrades/{calculatedTradeId}/{TradeId}
|
|
590
567
|
|
|
591
568
|
|
|
592
569
|
### Example
|
|
@@ -602,12 +579,13 @@ const snaptrade = new Snaptrade({
|
|
|
602
579
|
clientId: "YOUR_CLIENT_ID",
|
|
603
580
|
})
|
|
604
581
|
|
|
605
|
-
const
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
})
|
|
610
|
-
|
|
582
|
+
const getCalculatedTradeByIdResponse = await snaptrade.portfolioManagement.getCalculatedTradeById({
|
|
583
|
+
"portfolioGroupId": "portfolioGroupId_example",
|
|
584
|
+
"calculatedTradeId": "calculatedTradeId_example",
|
|
585
|
+
"tradeId": "tradeId_example",
|
|
586
|
+
})
|
|
587
|
+
|
|
588
|
+
console.log(getCalculatedTradeByIdResponse)
|
|
611
589
|
|
|
612
590
|
```
|
|
613
591
|
|
|
@@ -625,10 +603,6 @@ Name | Type | Description | Notes
|
|
|
625
603
|
|
|
626
604
|
**Array<Trade>**
|
|
627
605
|
|
|
628
|
-
### Authorization
|
|
629
|
-
|
|
630
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
631
|
-
|
|
632
606
|
### HTTP request headers
|
|
633
607
|
|
|
634
608
|
- **Content-Type**: Not defined
|
|
@@ -643,7 +617,8 @@ Name | Type | Description | Notes
|
|
|
643
617
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
644
618
|
|
|
645
619
|
# **getModelDetailsById**
|
|
646
|
-
|
|
620
|
+
|
|
621
|
+
#### **GET** /modelPortfolio/{modelPortfolioId}
|
|
647
622
|
|
|
648
623
|
|
|
649
624
|
### Example
|
|
@@ -659,10 +634,11 @@ const snaptrade = new Snaptrade({
|
|
|
659
634
|
clientId: "YOUR_CLIENT_ID",
|
|
660
635
|
})
|
|
661
636
|
|
|
662
|
-
const
|
|
663
|
-
|
|
664
|
-
})
|
|
665
|
-
|
|
637
|
+
const getModelDetailsByIdResponse = await snaptrade.portfolioManagement.getModelDetailsById({
|
|
638
|
+
"modelPortfolioId": "2bcd7cc3-e922-4976-bce1-9858296801c3",
|
|
639
|
+
})
|
|
640
|
+
|
|
641
|
+
console.log(getModelDetailsByIdResponse)
|
|
666
642
|
|
|
667
643
|
```
|
|
668
644
|
|
|
@@ -678,10 +654,6 @@ Name | Type | Description | Notes
|
|
|
678
654
|
|
|
679
655
|
**ModelPortfolioDetails**
|
|
680
656
|
|
|
681
|
-
### Authorization
|
|
682
|
-
|
|
683
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
684
|
-
|
|
685
657
|
### HTTP request headers
|
|
686
658
|
|
|
687
659
|
- **Content-Type**: Not defined
|
|
@@ -696,7 +668,8 @@ Name | Type | Description | Notes
|
|
|
696
668
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
697
669
|
|
|
698
670
|
# **getPortfolioBalances**
|
|
699
|
-
|
|
671
|
+
|
|
672
|
+
#### **GET** /portfolioGroups/{portfolioGroupId}/balances
|
|
700
673
|
|
|
701
674
|
|
|
702
675
|
### Example
|
|
@@ -712,10 +685,11 @@ const snaptrade = new Snaptrade({
|
|
|
712
685
|
clientId: "YOUR_CLIENT_ID",
|
|
713
686
|
})
|
|
714
687
|
|
|
715
|
-
const
|
|
716
|
-
|
|
717
|
-
})
|
|
718
|
-
|
|
688
|
+
const getPortfolioBalancesResponse = await snaptrade.portfolioManagement.getPortfolioBalances({
|
|
689
|
+
"portfolioGroupId": "portfolioGroupId_example",
|
|
690
|
+
})
|
|
691
|
+
|
|
692
|
+
console.log(getPortfolioBalancesResponse)
|
|
719
693
|
|
|
720
694
|
```
|
|
721
695
|
|
|
@@ -731,10 +705,6 @@ Name | Type | Description | Notes
|
|
|
731
705
|
|
|
732
706
|
**Array<Balance>**
|
|
733
707
|
|
|
734
|
-
### Authorization
|
|
735
|
-
|
|
736
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
737
|
-
|
|
738
708
|
### HTTP request headers
|
|
739
709
|
|
|
740
710
|
- **Content-Type**: Not defined
|
|
@@ -752,7 +722,8 @@ Name | Type | Description | Notes
|
|
|
752
722
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
753
723
|
|
|
754
724
|
# **getPortfolioDetailsById**
|
|
755
|
-
|
|
725
|
+
|
|
726
|
+
#### **GET** /portfolioGroups/{portfolioGroupId}
|
|
756
727
|
|
|
757
728
|
|
|
758
729
|
### Example
|
|
@@ -768,10 +739,11 @@ const snaptrade = new Snaptrade({
|
|
|
768
739
|
clientId: "YOUR_CLIENT_ID",
|
|
769
740
|
})
|
|
770
741
|
|
|
771
|
-
const
|
|
772
|
-
|
|
773
|
-
})
|
|
774
|
-
|
|
742
|
+
const getPortfolioDetailsByIdResponse = await snaptrade.portfolioManagement.getPortfolioDetailsById({
|
|
743
|
+
"portfolioGroupId": "portfolioGroupId_example",
|
|
744
|
+
})
|
|
745
|
+
|
|
746
|
+
console.log(getPortfolioDetailsByIdResponse)
|
|
775
747
|
|
|
776
748
|
```
|
|
777
749
|
|
|
@@ -787,10 +759,6 @@ Name | Type | Description | Notes
|
|
|
787
759
|
|
|
788
760
|
**PortfolioGroup**
|
|
789
761
|
|
|
790
|
-
### Authorization
|
|
791
|
-
|
|
792
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
793
|
-
|
|
794
762
|
### HTTP request headers
|
|
795
763
|
|
|
796
764
|
- **Content-Type**: Not defined
|
|
@@ -806,7 +774,8 @@ Name | Type | Description | Notes
|
|
|
806
774
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
807
775
|
|
|
808
776
|
# **getPortfolioInfo**
|
|
809
|
-
|
|
777
|
+
|
|
778
|
+
#### **GET** /portfolioGroups/{portfolioGroupId}/info
|
|
810
779
|
|
|
811
780
|
|
|
812
781
|
### Example
|
|
@@ -822,10 +791,11 @@ const snaptrade = new Snaptrade({
|
|
|
822
791
|
clientId: "YOUR_CLIENT_ID",
|
|
823
792
|
})
|
|
824
793
|
|
|
825
|
-
const
|
|
826
|
-
|
|
827
|
-
})
|
|
828
|
-
|
|
794
|
+
const getPortfolioInfoResponse = await snaptrade.portfolioManagement.getPortfolioInfo({
|
|
795
|
+
"portfolioGroupId": "portfolioGroupId_example",
|
|
796
|
+
})
|
|
797
|
+
|
|
798
|
+
console.log(getPortfolioInfoResponse)
|
|
829
799
|
|
|
830
800
|
```
|
|
831
801
|
|
|
@@ -841,10 +811,6 @@ Name | Type | Description | Notes
|
|
|
841
811
|
|
|
842
812
|
**PortfolioGroupInfo**
|
|
843
813
|
|
|
844
|
-
### Authorization
|
|
845
|
-
|
|
846
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
847
|
-
|
|
848
814
|
### HTTP request headers
|
|
849
815
|
|
|
850
816
|
- **Content-Type**: Not defined
|
|
@@ -860,7 +826,8 @@ Name | Type | Description | Notes
|
|
|
860
826
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
861
827
|
|
|
862
828
|
# **getPortfolioPositions**
|
|
863
|
-
|
|
829
|
+
|
|
830
|
+
#### **GET** /portfolioGroups/{portfolioGroupId}/positions
|
|
864
831
|
|
|
865
832
|
|
|
866
833
|
### Example
|
|
@@ -876,10 +843,11 @@ const snaptrade = new Snaptrade({
|
|
|
876
843
|
clientId: "YOUR_CLIENT_ID",
|
|
877
844
|
})
|
|
878
845
|
|
|
879
|
-
const
|
|
880
|
-
|
|
881
|
-
})
|
|
882
|
-
|
|
846
|
+
const getPortfolioPositionsResponse = await snaptrade.portfolioManagement.getPortfolioPositions({
|
|
847
|
+
"portfolioGroupId": "portfolioGroupId_example",
|
|
848
|
+
})
|
|
849
|
+
|
|
850
|
+
console.log(getPortfolioPositionsResponse)
|
|
883
851
|
|
|
884
852
|
```
|
|
885
853
|
|
|
@@ -895,10 +863,6 @@ Name | Type | Description | Notes
|
|
|
895
863
|
|
|
896
864
|
**Array<PortfolioGroupPosition>**
|
|
897
865
|
|
|
898
|
-
### Authorization
|
|
899
|
-
|
|
900
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
901
|
-
|
|
902
866
|
### HTTP request headers
|
|
903
867
|
|
|
904
868
|
- **Content-Type**: Not defined
|
|
@@ -916,7 +880,8 @@ Name | Type | Description | Notes
|
|
|
916
880
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
917
881
|
|
|
918
882
|
# **getPortfolioSettings**
|
|
919
|
-
|
|
883
|
+
|
|
884
|
+
#### **GET** /portfolioGroups/{portfolioGroupId}/settings
|
|
920
885
|
|
|
921
886
|
|
|
922
887
|
### Example
|
|
@@ -932,10 +897,11 @@ const snaptrade = new Snaptrade({
|
|
|
932
897
|
clientId: "YOUR_CLIENT_ID",
|
|
933
898
|
})
|
|
934
899
|
|
|
935
|
-
const
|
|
936
|
-
|
|
937
|
-
})
|
|
938
|
-
|
|
900
|
+
const getPortfolioSettingsResponse = await snaptrade.portfolioManagement.getPortfolioSettings({
|
|
901
|
+
"portfolioGroupId": "portfolioGroupId_example",
|
|
902
|
+
})
|
|
903
|
+
|
|
904
|
+
console.log(getPortfolioSettingsResponse)
|
|
939
905
|
|
|
940
906
|
```
|
|
941
907
|
|
|
@@ -951,10 +917,6 @@ Name | Type | Description | Notes
|
|
|
951
917
|
|
|
952
918
|
**PortfolioGroupSettings**
|
|
953
919
|
|
|
954
|
-
### Authorization
|
|
955
|
-
|
|
956
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
957
|
-
|
|
958
920
|
### HTTP request headers
|
|
959
921
|
|
|
960
922
|
- **Content-Type**: Not defined
|
|
@@ -970,7 +932,8 @@ Name | Type | Description | Notes
|
|
|
970
932
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
971
933
|
|
|
972
934
|
# **getPortfolioTargetById**
|
|
973
|
-
|
|
935
|
+
|
|
936
|
+
#### **GET** /portfolioGroups/{portfolioGroupId}/targets/{targetAssetId}
|
|
974
937
|
|
|
975
938
|
|
|
976
939
|
### Example
|
|
@@ -986,11 +949,12 @@ const snaptrade = new Snaptrade({
|
|
|
986
949
|
clientId: "YOUR_CLIENT_ID",
|
|
987
950
|
})
|
|
988
951
|
|
|
989
|
-
const
|
|
990
|
-
|
|
991
|
-
|
|
992
|
-
})
|
|
993
|
-
|
|
952
|
+
const getPortfolioTargetByIdResponse = await snaptrade.portfolioManagement.getPortfolioTargetById({
|
|
953
|
+
"portfolioGroupId": "portfolioGroupId_example",
|
|
954
|
+
"targetAssetId": "targetAssetId_example",
|
|
955
|
+
})
|
|
956
|
+
|
|
957
|
+
console.log(getPortfolioTargetByIdResponse)
|
|
994
958
|
|
|
995
959
|
```
|
|
996
960
|
|
|
@@ -1007,10 +971,6 @@ Name | Type | Description | Notes
|
|
|
1007
971
|
|
|
1008
972
|
**TargetAsset**
|
|
1009
973
|
|
|
1010
|
-
### Authorization
|
|
1011
|
-
|
|
1012
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
1013
|
-
|
|
1014
974
|
### HTTP request headers
|
|
1015
975
|
|
|
1016
976
|
- **Content-Type**: Not defined
|
|
@@ -1026,7 +986,8 @@ Name | Type | Description | Notes
|
|
|
1026
986
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1027
987
|
|
|
1028
988
|
# **getPortfolioTargets**
|
|
1029
|
-
|
|
989
|
+
|
|
990
|
+
#### **GET** /portfolioGroups/{portfolioGroupId}/targets
|
|
1030
991
|
|
|
1031
992
|
|
|
1032
993
|
### Example
|
|
@@ -1042,10 +1003,11 @@ const snaptrade = new Snaptrade({
|
|
|
1042
1003
|
clientId: "YOUR_CLIENT_ID",
|
|
1043
1004
|
})
|
|
1044
1005
|
|
|
1045
|
-
const
|
|
1046
|
-
|
|
1047
|
-
})
|
|
1048
|
-
|
|
1006
|
+
const getPortfolioTargetsResponse = await snaptrade.portfolioManagement.getPortfolioTargets({
|
|
1007
|
+
"portfolioGroupId": "portfolioGroupId_example",
|
|
1008
|
+
})
|
|
1009
|
+
|
|
1010
|
+
console.log(getPortfolioTargetsResponse)
|
|
1049
1011
|
|
|
1050
1012
|
```
|
|
1051
1013
|
|
|
@@ -1061,10 +1023,6 @@ Name | Type | Description | Notes
|
|
|
1061
1023
|
|
|
1062
1024
|
**Array<TargetAsset>**
|
|
1063
1025
|
|
|
1064
|
-
### Authorization
|
|
1065
|
-
|
|
1066
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
1067
|
-
|
|
1068
1026
|
### HTTP request headers
|
|
1069
1027
|
|
|
1070
1028
|
- **Content-Type**: Not defined
|
|
@@ -1082,7 +1040,8 @@ Name | Type | Description | Notes
|
|
|
1082
1040
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1083
1041
|
|
|
1084
1042
|
# **getPortoflioExcludedAssets**
|
|
1085
|
-
|
|
1043
|
+
|
|
1044
|
+
#### **GET** /portfolioGroups/{portfolioGroupId}/excludedassets
|
|
1086
1045
|
|
|
1087
1046
|
|
|
1088
1047
|
### Example
|
|
@@ -1098,10 +1057,11 @@ const snaptrade = new Snaptrade({
|
|
|
1098
1057
|
clientId: "YOUR_CLIENT_ID",
|
|
1099
1058
|
})
|
|
1100
1059
|
|
|
1101
|
-
const
|
|
1102
|
-
|
|
1103
|
-
})
|
|
1104
|
-
|
|
1060
|
+
const getPortoflioExcludedAssetsResponse = await snaptrade.portfolioManagement.getPortoflioExcludedAssets({
|
|
1061
|
+
"portfolioGroupId": "portfolioGroupId_example",
|
|
1062
|
+
})
|
|
1063
|
+
|
|
1064
|
+
console.log(getPortoflioExcludedAssetsResponse)
|
|
1105
1065
|
|
|
1106
1066
|
```
|
|
1107
1067
|
|
|
@@ -1117,10 +1077,6 @@ Name | Type | Description | Notes
|
|
|
1117
1077
|
|
|
1118
1078
|
**Array<ExcludedAsset>**
|
|
1119
1079
|
|
|
1120
|
-
### Authorization
|
|
1121
|
-
|
|
1122
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
1123
|
-
|
|
1124
1080
|
### HTTP request headers
|
|
1125
1081
|
|
|
1126
1082
|
- **Content-Type**: Not defined
|
|
@@ -1136,7 +1092,8 @@ Name | Type | Description | Notes
|
|
|
1136
1092
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1137
1093
|
|
|
1138
1094
|
# **importModelPortfolio**
|
|
1139
|
-
|
|
1095
|
+
|
|
1096
|
+
#### **POST** /portfolioGroups/{portfolioGroupId}/import
|
|
1140
1097
|
|
|
1141
1098
|
|
|
1142
1099
|
### Example
|
|
@@ -1152,10 +1109,11 @@ const snaptrade = new Snaptrade({
|
|
|
1152
1109
|
clientId: "YOUR_CLIENT_ID",
|
|
1153
1110
|
})
|
|
1154
1111
|
|
|
1155
|
-
const
|
|
1156
|
-
|
|
1157
|
-
})
|
|
1158
|
-
|
|
1112
|
+
const importModelPortfolioResponse = await snaptrade.portfolioManagement.importModelPortfolio({
|
|
1113
|
+
"portfolioGroupId": "portfolioGroupId_example",
|
|
1114
|
+
})
|
|
1115
|
+
|
|
1116
|
+
console.log(importModelPortfolioResponse)
|
|
1159
1117
|
|
|
1160
1118
|
```
|
|
1161
1119
|
|
|
@@ -1171,10 +1129,6 @@ Name | Type | Description | Notes
|
|
|
1171
1129
|
|
|
1172
1130
|
**Array<TargetAsset>**
|
|
1173
1131
|
|
|
1174
|
-
### Authorization
|
|
1175
|
-
|
|
1176
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
1177
|
-
|
|
1178
1132
|
### HTTP request headers
|
|
1179
1133
|
|
|
1180
1134
|
- **Content-Type**: Not defined
|
|
@@ -1190,7 +1144,8 @@ Name | Type | Description | Notes
|
|
|
1190
1144
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1191
1145
|
|
|
1192
1146
|
# **list**
|
|
1193
|
-
|
|
1147
|
+
|
|
1148
|
+
#### **GET** /portfolioGroups
|
|
1194
1149
|
|
|
1195
1150
|
|
|
1196
1151
|
### Example
|
|
@@ -1206,11 +1161,12 @@ const snaptrade = new Snaptrade({
|
|
|
1206
1161
|
clientId: "YOUR_CLIENT_ID",
|
|
1207
1162
|
})
|
|
1208
1163
|
|
|
1209
|
-
const
|
|
1210
|
-
|
|
1211
|
-
|
|
1212
|
-
})
|
|
1213
|
-
|
|
1164
|
+
const listResponse = await snaptrade.portfolioManagement.list({
|
|
1165
|
+
"userId": "John.doe@snaptrade.com",
|
|
1166
|
+
"userSecret": "USERSECRET123",
|
|
1167
|
+
})
|
|
1168
|
+
|
|
1169
|
+
console.log(listResponse)
|
|
1214
1170
|
|
|
1215
1171
|
```
|
|
1216
1172
|
|
|
@@ -1227,10 +1183,6 @@ Name | Type | Description | Notes
|
|
|
1227
1183
|
|
|
1228
1184
|
**Array<PortfolioGroup>**
|
|
1229
1185
|
|
|
1230
|
-
### Authorization
|
|
1231
|
-
|
|
1232
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
1233
|
-
|
|
1234
1186
|
### HTTP request headers
|
|
1235
1187
|
|
|
1236
1188
|
- **Content-Type**: Not defined
|
|
@@ -1246,7 +1198,8 @@ Name | Type | Description | Notes
|
|
|
1246
1198
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1247
1199
|
|
|
1248
1200
|
# **listAssetClasses**
|
|
1249
|
-
|
|
1201
|
+
|
|
1202
|
+
#### **GET** /modelAssetClass
|
|
1250
1203
|
|
|
1251
1204
|
|
|
1252
1205
|
### Example
|
|
@@ -1262,8 +1215,9 @@ const snaptrade = new Snaptrade({
|
|
|
1262
1215
|
clientId: "YOUR_CLIENT_ID",
|
|
1263
1216
|
})
|
|
1264
1217
|
|
|
1265
|
-
const
|
|
1266
|
-
|
|
1218
|
+
const listAssetClassesResponse = await snaptrade.portfolioManagement.listAssetClasses()
|
|
1219
|
+
|
|
1220
|
+
console.log(listAssetClassesResponse)
|
|
1267
1221
|
|
|
1268
1222
|
```
|
|
1269
1223
|
|
|
@@ -1276,10 +1230,6 @@ This endpoint does not need any parameter.
|
|
|
1276
1230
|
|
|
1277
1231
|
**Array<ModelAssetClassDetails>**
|
|
1278
1232
|
|
|
1279
|
-
### Authorization
|
|
1280
|
-
|
|
1281
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
1282
|
-
|
|
1283
1233
|
### HTTP request headers
|
|
1284
1234
|
|
|
1285
1235
|
- **Content-Type**: Not defined
|
|
@@ -1294,7 +1244,8 @@ This endpoint does not need any parameter.
|
|
|
1294
1244
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1295
1245
|
|
|
1296
1246
|
# **listCalculatedTrades**
|
|
1297
|
-
|
|
1247
|
+
|
|
1248
|
+
#### **GET** /portfolioGroups/{portfolioGroupId}/calculatedtrades
|
|
1298
1249
|
|
|
1299
1250
|
|
|
1300
1251
|
### Example
|
|
@@ -1310,10 +1261,11 @@ const snaptrade = new Snaptrade({
|
|
|
1310
1261
|
clientId: "YOUR_CLIENT_ID",
|
|
1311
1262
|
})
|
|
1312
1263
|
|
|
1313
|
-
const
|
|
1314
|
-
|
|
1315
|
-
})
|
|
1316
|
-
|
|
1264
|
+
const listCalculatedTradesResponse = await snaptrade.portfolioManagement.listCalculatedTrades({
|
|
1265
|
+
"portfolioGroupId": "portfolioGroupId_example",
|
|
1266
|
+
})
|
|
1267
|
+
|
|
1268
|
+
console.log(listCalculatedTradesResponse)
|
|
1317
1269
|
|
|
1318
1270
|
```
|
|
1319
1271
|
|
|
@@ -1329,10 +1281,6 @@ Name | Type | Description | Notes
|
|
|
1329
1281
|
|
|
1330
1282
|
**CalculatedTrade**
|
|
1331
1283
|
|
|
1332
|
-
### Authorization
|
|
1333
|
-
|
|
1334
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
1335
|
-
|
|
1336
1284
|
### HTTP request headers
|
|
1337
1285
|
|
|
1338
1286
|
- **Content-Type**: Not defined
|
|
@@ -1347,7 +1295,8 @@ Name | Type | Description | Notes
|
|
|
1347
1295
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1348
1296
|
|
|
1349
1297
|
# **listModelPortfolio**
|
|
1350
|
-
|
|
1298
|
+
|
|
1299
|
+
#### **GET** /modelPortfolio
|
|
1351
1300
|
|
|
1352
1301
|
|
|
1353
1302
|
### Example
|
|
@@ -1363,8 +1312,9 @@ const snaptrade = new Snaptrade({
|
|
|
1363
1312
|
clientId: "YOUR_CLIENT_ID",
|
|
1364
1313
|
})
|
|
1365
1314
|
|
|
1366
|
-
const
|
|
1367
|
-
|
|
1315
|
+
const listModelPortfolioResponse = await snaptrade.portfolioManagement.listModelPortfolio()
|
|
1316
|
+
|
|
1317
|
+
console.log(listModelPortfolioResponse)
|
|
1368
1318
|
|
|
1369
1319
|
```
|
|
1370
1320
|
|
|
@@ -1377,10 +1327,6 @@ This endpoint does not need any parameter.
|
|
|
1377
1327
|
|
|
1378
1328
|
**Array<ModelPortfolioDetails>**
|
|
1379
1329
|
|
|
1380
|
-
### Authorization
|
|
1381
|
-
|
|
1382
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
1383
|
-
|
|
1384
1330
|
### HTTP request headers
|
|
1385
1331
|
|
|
1386
1332
|
- **Content-Type**: Not defined
|
|
@@ -1395,7 +1341,8 @@ This endpoint does not need any parameter.
|
|
|
1395
1341
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1396
1342
|
|
|
1397
1343
|
# **listPortfolioAccounts**
|
|
1398
|
-
|
|
1344
|
+
|
|
1345
|
+
#### **GET** /portfolioGroups/{portfolioGroupId}/accounts
|
|
1399
1346
|
|
|
1400
1347
|
|
|
1401
1348
|
### Example
|
|
@@ -1411,10 +1358,11 @@ const snaptrade = new Snaptrade({
|
|
|
1411
1358
|
clientId: "YOUR_CLIENT_ID",
|
|
1412
1359
|
})
|
|
1413
1360
|
|
|
1414
|
-
const
|
|
1415
|
-
|
|
1416
|
-
})
|
|
1417
|
-
|
|
1361
|
+
const listPortfolioAccountsResponse = await snaptrade.portfolioManagement.listPortfolioAccounts({
|
|
1362
|
+
"portfolioGroupId": "portfolioGroupId_example",
|
|
1363
|
+
})
|
|
1364
|
+
|
|
1365
|
+
console.log(listPortfolioAccountsResponse)
|
|
1418
1366
|
|
|
1419
1367
|
```
|
|
1420
1368
|
|
|
@@ -1430,10 +1378,6 @@ Name | Type | Description | Notes
|
|
|
1430
1378
|
|
|
1431
1379
|
**Array<Account>**
|
|
1432
1380
|
|
|
1433
|
-
### Authorization
|
|
1434
|
-
|
|
1435
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
1436
|
-
|
|
1437
1381
|
### HTTP request headers
|
|
1438
1382
|
|
|
1439
1383
|
- **Content-Type**: Not defined
|
|
@@ -1449,7 +1393,8 @@ Name | Type | Description | Notes
|
|
|
1449
1393
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1450
1394
|
|
|
1451
1395
|
# **modifyModelPortfolioById**
|
|
1452
|
-
|
|
1396
|
+
|
|
1397
|
+
#### **POST** /modelPortfolio/{modelPortfolioId}
|
|
1453
1398
|
|
|
1454
1399
|
|
|
1455
1400
|
### Example
|
|
@@ -1465,12 +1410,11 @@ const snaptrade = new Snaptrade({
|
|
|
1465
1410
|
clientId: "YOUR_CLIENT_ID",
|
|
1466
1411
|
})
|
|
1467
1412
|
|
|
1468
|
-
const
|
|
1469
|
-
|
|
1470
|
-
|
|
1471
|
-
|
|
1472
|
-
|
|
1473
|
-
console.log(response)
|
|
1413
|
+
const modifyModelPortfolioByIdResponse = await snaptrade.portfolioManagement.modifyModelPortfolioById({
|
|
1414
|
+
"modelPortfolioId": "2bcd7cc3-e922-4976-bce1-9858296801c3",
|
|
1415
|
+
})
|
|
1416
|
+
|
|
1417
|
+
console.log(modifyModelPortfolioByIdResponse)
|
|
1474
1418
|
|
|
1475
1419
|
```
|
|
1476
1420
|
|
|
@@ -1487,10 +1431,6 @@ Name | Type | Description | Notes
|
|
|
1487
1431
|
|
|
1488
1432
|
void (empty response body)
|
|
1489
1433
|
|
|
1490
|
-
### Authorization
|
|
1491
|
-
|
|
1492
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
1493
|
-
|
|
1494
1434
|
### HTTP request headers
|
|
1495
1435
|
|
|
1496
1436
|
- **Content-Type**: application/json
|
|
@@ -1505,7 +1445,8 @@ void (empty response body)
|
|
|
1505
1445
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1506
1446
|
|
|
1507
1447
|
# **savePortfolio**
|
|
1508
|
-
|
|
1448
|
+
|
|
1449
|
+
#### **PATCH** /portfolioGroups/{portfolioGroupId}
|
|
1509
1450
|
|
|
1510
1451
|
|
|
1511
1452
|
### Example
|
|
@@ -1521,14 +1462,13 @@ const snaptrade = new Snaptrade({
|
|
|
1521
1462
|
clientId: "YOUR_CLIENT_ID",
|
|
1522
1463
|
})
|
|
1523
1464
|
|
|
1524
|
-
const
|
|
1525
|
-
|
|
1526
|
-
'requestBody': {
|
|
1465
|
+
const savePortfolioResponse = await snaptrade.portfolioManagement.savePortfolio({
|
|
1466
|
+
"portfolioGroupId": "portfolioGroupId_example",
|
|
1527
1467
|
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
|
|
1528
1468
|
"name": "Combined Retirement Portfolio",
|
|
1529
|
-
}
|
|
1530
|
-
|
|
1531
|
-
console.log(
|
|
1469
|
+
})
|
|
1470
|
+
|
|
1471
|
+
console.log(savePortfolioResponse)
|
|
1532
1472
|
|
|
1533
1473
|
```
|
|
1534
1474
|
|
|
@@ -1545,10 +1485,6 @@ Name | Type | Description | Notes
|
|
|
1545
1485
|
|
|
1546
1486
|
**PortfolioGroup**
|
|
1547
1487
|
|
|
1548
|
-
### Authorization
|
|
1549
|
-
|
|
1550
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
1551
|
-
|
|
1552
1488
|
### HTTP request headers
|
|
1553
1489
|
|
|
1554
1490
|
- **Content-Type**: application/json
|
|
@@ -1566,7 +1502,8 @@ Name | Type | Description | Notes
|
|
|
1566
1502
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1567
1503
|
|
|
1568
1504
|
# **searchPortfolioSymbols**
|
|
1569
|
-
|
|
1505
|
+
|
|
1506
|
+
#### **POST** /portfolioGroups/{portfolioGroupId}/symbols
|
|
1570
1507
|
|
|
1571
1508
|
|
|
1572
1509
|
### Example
|
|
@@ -1582,13 +1519,12 @@ const snaptrade = new Snaptrade({
|
|
|
1582
1519
|
clientId: "YOUR_CLIENT_ID",
|
|
1583
1520
|
})
|
|
1584
1521
|
|
|
1585
|
-
const
|
|
1586
|
-
|
|
1587
|
-
'requestBody': {
|
|
1522
|
+
const searchPortfolioSymbolsResponse = await snaptrade.portfolioManagement.searchPortfolioSymbols({
|
|
1523
|
+
"portfolioGroupId": "portfolioGroupId_example",
|
|
1588
1524
|
"substring": "apple",
|
|
1589
|
-
}
|
|
1590
|
-
|
|
1591
|
-
console.log(
|
|
1525
|
+
})
|
|
1526
|
+
|
|
1527
|
+
console.log(searchPortfolioSymbolsResponse)
|
|
1592
1528
|
|
|
1593
1529
|
```
|
|
1594
1530
|
|
|
@@ -1605,10 +1541,6 @@ Name | Type | Description | Notes
|
|
|
1605
1541
|
|
|
1606
1542
|
**Array<UniversalSymbol>**
|
|
1607
1543
|
|
|
1608
|
-
### Authorization
|
|
1609
|
-
|
|
1610
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
1611
|
-
|
|
1612
1544
|
### HTTP request headers
|
|
1613
1545
|
|
|
1614
1546
|
- **Content-Type**: application/json
|
|
@@ -1624,7 +1556,8 @@ Name | Type | Description | Notes
|
|
|
1624
1556
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1625
1557
|
|
|
1626
1558
|
# **setPortfolioTargets**
|
|
1627
|
-
|
|
1559
|
+
|
|
1560
|
+
#### **POST** /portfolioGroups/{portfolioGroupId}/targets
|
|
1628
1561
|
|
|
1629
1562
|
|
|
1630
1563
|
### Example
|
|
@@ -1640,7 +1573,7 @@ const snaptrade = new Snaptrade({
|
|
|
1640
1573
|
clientId: "YOUR_CLIENT_ID",
|
|
1641
1574
|
})
|
|
1642
1575
|
|
|
1643
|
-
const
|
|
1576
|
+
const setPortfolioTargetsResponse = await snaptrade.portfolioManagement.setPortfolioTargets({
|
|
1644
1577
|
'portfolioGroupId': "portfolioGroupId_example",
|
|
1645
1578
|
'requestBody': [
|
|
1646
1579
|
{
|
|
@@ -1651,7 +1584,8 @@ const response = await snaptrade.portfolioManagement.setPortfolioTargets({
|
|
|
1651
1584
|
}
|
|
1652
1585
|
],
|
|
1653
1586
|
})
|
|
1654
|
-
|
|
1587
|
+
|
|
1588
|
+
console.log(setPortfolioTargetsResponse)
|
|
1655
1589
|
|
|
1656
1590
|
```
|
|
1657
1591
|
|
|
@@ -1668,10 +1602,6 @@ Name | Type | Description | Notes
|
|
|
1668
1602
|
|
|
1669
1603
|
**Array<TargetAsset>**
|
|
1670
1604
|
|
|
1671
|
-
### Authorization
|
|
1672
|
-
|
|
1673
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
1674
|
-
|
|
1675
1605
|
### HTTP request headers
|
|
1676
1606
|
|
|
1677
1607
|
- **Content-Type**: application/json
|
|
@@ -1689,7 +1619,8 @@ Name | Type | Description | Notes
|
|
|
1689
1619
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1690
1620
|
|
|
1691
1621
|
# **updateAssetClass**
|
|
1692
|
-
|
|
1622
|
+
|
|
1623
|
+
#### **POST** /modelAssetClass/{modelAssetClassId}
|
|
1693
1624
|
|
|
1694
1625
|
|
|
1695
1626
|
### Example
|
|
@@ -1705,12 +1636,11 @@ const snaptrade = new Snaptrade({
|
|
|
1705
1636
|
clientId: "YOUR_CLIENT_ID",
|
|
1706
1637
|
})
|
|
1707
1638
|
|
|
1708
|
-
const
|
|
1709
|
-
|
|
1710
|
-
|
|
1711
|
-
|
|
1712
|
-
|
|
1713
|
-
console.log(response)
|
|
1639
|
+
const updateAssetClassResponse = await snaptrade.portfolioManagement.updateAssetClass({
|
|
1640
|
+
"modelAssetClassId": "2bcd7cc3-e922-4976-bce1-9858296801c3",
|
|
1641
|
+
})
|
|
1642
|
+
|
|
1643
|
+
console.log(updateAssetClassResponse)
|
|
1714
1644
|
|
|
1715
1645
|
```
|
|
1716
1646
|
|
|
@@ -1727,10 +1657,6 @@ Name | Type | Description | Notes
|
|
|
1727
1657
|
|
|
1728
1658
|
void (empty response body)
|
|
1729
1659
|
|
|
1730
|
-
### Authorization
|
|
1731
|
-
|
|
1732
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
1733
|
-
|
|
1734
1660
|
### HTTP request headers
|
|
1735
1661
|
|
|
1736
1662
|
- **Content-Type**: application/json
|
|
@@ -1745,7 +1671,8 @@ void (empty response body)
|
|
|
1745
1671
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1746
1672
|
|
|
1747
1673
|
# **updatePortfolioSettings**
|
|
1748
|
-
|
|
1674
|
+
|
|
1675
|
+
#### **PATCH** /portfolioGroups/{portfolioGroupId}/settings
|
|
1749
1676
|
|
|
1750
1677
|
|
|
1751
1678
|
### Example
|
|
@@ -1761,10 +1688,11 @@ const snaptrade = new Snaptrade({
|
|
|
1761
1688
|
clientId: "YOUR_CLIENT_ID",
|
|
1762
1689
|
})
|
|
1763
1690
|
|
|
1764
|
-
const
|
|
1765
|
-
|
|
1766
|
-
})
|
|
1767
|
-
|
|
1691
|
+
const updatePortfolioSettingsResponse = await snaptrade.portfolioManagement.updatePortfolioSettings({
|
|
1692
|
+
"portfolioGroupId": "portfolioGroupId_example",
|
|
1693
|
+
})
|
|
1694
|
+
|
|
1695
|
+
console.log(updatePortfolioSettingsResponse)
|
|
1768
1696
|
|
|
1769
1697
|
```
|
|
1770
1698
|
|
|
@@ -1780,10 +1708,6 @@ Name | Type | Description | Notes
|
|
|
1780
1708
|
|
|
1781
1709
|
**PortfolioGroupSettings**
|
|
1782
1710
|
|
|
1783
|
-
### Authorization
|
|
1784
|
-
|
|
1785
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
1786
|
-
|
|
1787
1711
|
### HTTP request headers
|
|
1788
1712
|
|
|
1789
1713
|
- **Content-Type**: Not defined
|
|
@@ -1799,7 +1723,8 @@ Name | Type | Description | Notes
|
|
|
1799
1723
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
1800
1724
|
|
|
1801
1725
|
# **updatePortfolioTargetById**
|
|
1802
|
-
|
|
1726
|
+
|
|
1727
|
+
#### **PATCH** /portfolioGroups/{portfolioGroupId}/targets/{targetAssetId}
|
|
1803
1728
|
|
|
1804
1729
|
|
|
1805
1730
|
### Example
|
|
@@ -1815,17 +1740,16 @@ const snaptrade = new Snaptrade({
|
|
|
1815
1740
|
clientId: "YOUR_CLIENT_ID",
|
|
1816
1741
|
})
|
|
1817
1742
|
|
|
1818
|
-
const
|
|
1819
|
-
|
|
1820
|
-
|
|
1821
|
-
'requestBody': {
|
|
1743
|
+
const updatePortfolioTargetByIdResponse = await snaptrade.portfolioManagement.updatePortfolioTargetById({
|
|
1744
|
+
"portfolioGroupId": "portfolioGroupId_example",
|
|
1745
|
+
"targetAssetId": "targetAssetId_example",
|
|
1822
1746
|
"id": "2bcd7cc3-e922-4976-bce1-9858296801c3",
|
|
1823
1747
|
"percent": 90,
|
|
1824
1748
|
"is_supported": true,
|
|
1825
1749
|
"is_excluded": true,
|
|
1826
|
-
}
|
|
1827
|
-
|
|
1828
|
-
console.log(
|
|
1750
|
+
})
|
|
1751
|
+
|
|
1752
|
+
console.log(updatePortfolioTargetByIdResponse)
|
|
1829
1753
|
|
|
1830
1754
|
```
|
|
1831
1755
|
|
|
@@ -1843,10 +1767,6 @@ Name | Type | Description | Notes
|
|
|
1843
1767
|
|
|
1844
1768
|
**TargetAsset**
|
|
1845
1769
|
|
|
1846
|
-
### Authorization
|
|
1847
|
-
|
|
1848
|
-
[PartnerClientId](README.md#PartnerClientId), [PartnerSignature](README.md#PartnerSignature), [PartnerTimestamp](README.md#PartnerTimestamp)
|
|
1849
|
-
|
|
1850
1770
|
### HTTP request headers
|
|
1851
1771
|
|
|
1852
1772
|
- **Content-Type**: application/json
|