@orbis-systems/orbis-api-clients 0.6.7 → 0.6.8
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/dist/aesmidas/index.d.ts +1105 -1105
- package/dist/aesmidas/index.d.ts.map +1 -1
- package/dist/aesmidas/index.esm.js +895 -895
- package/dist/aesmidas/index.esm.js.map +1 -1
- package/dist/aesmidas/index.js +894 -894
- package/dist/aesmidas/index.js.map +1 -1
- package/dist/bridgewise/index.d.ts +82 -82
- package/dist/bridgewise/index.d.ts.map +1 -1
- package/dist/bridgewise/index.esm.js +91 -91
- package/dist/bridgewise/index.esm.js.map +1 -1
- package/dist/bridgewise/index.js +90 -90
- package/dist/bridgewise/index.js.map +1 -1
- package/dist/insight/index.d.ts +101 -100
- package/dist/insight/index.d.ts.map +1 -1
- package/dist/insight/index.esm.js +229 -228
- package/dist/insight/index.esm.js.map +1 -1
- package/dist/insight/index.js +228 -227
- package/dist/insight/index.js.map +1 -1
- package/dist/middleware/index.d.ts +34 -34
- package/dist/middleware/index.d.ts.map +1 -1
- package/dist/middleware/index.esm.js +84 -84
- package/dist/middleware/index.esm.js.map +1 -1
- package/dist/middleware/index.js +83 -83
- package/dist/middleware/index.js.map +1 -1
- package/dist/orbis/index.d.ts +1271 -1271
- package/dist/orbis/index.d.ts.map +1 -1
- package/dist/orbis/index.esm.js +1587 -1587
- package/dist/orbis/index.esm.js.map +1 -1
- package/dist/orbis/index.js +1586 -1586
- package/dist/orbis/index.js.map +1 -1
- package/dist/uma/index.d.ts +237 -237
- package/dist/uma/index.d.ts.map +1 -1
- package/dist/uma/index.esm.js +602 -602
- package/dist/uma/index.esm.js.map +1 -1
- package/dist/uma/index.js +601 -601
- package/dist/uma/index.js.map +1 -1
- package/package.json +1 -1
package/dist/orbis/index.d.ts
CHANGED
|
@@ -306,6 +306,84 @@ export class OrdersV2Equities<HandleError extends boolean = boolean> {
|
|
|
306
306
|
*/
|
|
307
307
|
previewSnapshot(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
308
308
|
}
|
|
309
|
+
export class OrdersV2FixedIncome<HandleError extends boolean = boolean> {
|
|
310
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
311
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
312
|
+
/**
|
|
313
|
+
* @tags Orders V2 Fixed Income
|
|
314
|
+
* @name BondPlacement
|
|
315
|
+
* @summary Bond placement
|
|
316
|
+
* @request POST:/orders/v2/bonds/place
|
|
317
|
+
* @secure
|
|
318
|
+
*/
|
|
319
|
+
bondPlacement(data: {
|
|
320
|
+
account?: {
|
|
321
|
+
/** @example 123 */
|
|
322
|
+
accountId?: number;
|
|
323
|
+
/** @example "AC00123" */
|
|
324
|
+
accountNumber?: string;
|
|
325
|
+
};
|
|
326
|
+
order?: {
|
|
327
|
+
/** @example "LIMIT" */
|
|
328
|
+
orderType?: string;
|
|
329
|
+
/** @example 100 */
|
|
330
|
+
price?: number;
|
|
331
|
+
/** @example "Percentage|Decimal" */
|
|
332
|
+
priceType?: string;
|
|
333
|
+
/** @example 1000 */
|
|
334
|
+
quantity?: number;
|
|
335
|
+
/** @example "Par|Unit" */
|
|
336
|
+
quantityType?: string;
|
|
337
|
+
quote?: {
|
|
338
|
+
/** @example "412001269" */
|
|
339
|
+
cusip?: string;
|
|
340
|
+
/** @example "CUSIP:ISIN" */
|
|
341
|
+
identType?: string;
|
|
342
|
+
/** @example "SK4120012691" */
|
|
343
|
+
isin?: string;
|
|
344
|
+
};
|
|
345
|
+
/** @example "BUY|SELL" */
|
|
346
|
+
transaction?: string;
|
|
347
|
+
};
|
|
348
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
349
|
+
/**
|
|
350
|
+
* @tags Orders V2 Fixed Income
|
|
351
|
+
* @name BondOrderPreview
|
|
352
|
+
* @summary Bond order preview
|
|
353
|
+
* @request POST:/orders/v2/bonds/preview
|
|
354
|
+
* @secure
|
|
355
|
+
*/
|
|
356
|
+
bondOrderPreview(data: {
|
|
357
|
+
account?: {
|
|
358
|
+
/** @example 123 */
|
|
359
|
+
accountId?: number;
|
|
360
|
+
/** @example "AC00123" */
|
|
361
|
+
accountNumber?: string;
|
|
362
|
+
};
|
|
363
|
+
order?: {
|
|
364
|
+
/** @example "LIMIT" */
|
|
365
|
+
orderType?: string;
|
|
366
|
+
/** @example 100 */
|
|
367
|
+
price?: number;
|
|
368
|
+
/** @example "Percentage|Decimal" */
|
|
369
|
+
priceType?: string;
|
|
370
|
+
/** @example 1000 */
|
|
371
|
+
quantity?: number;
|
|
372
|
+
/** @example "Par|Unit" */
|
|
373
|
+
quantityType?: string;
|
|
374
|
+
quote?: {
|
|
375
|
+
/** @example "412001269" */
|
|
376
|
+
cusip?: string;
|
|
377
|
+
/** @example "CUSIP:ISIN" */
|
|
378
|
+
identType?: string;
|
|
379
|
+
/** @example "SK4120012691" */
|
|
380
|
+
isin?: string;
|
|
381
|
+
};
|
|
382
|
+
/** @example "BUY|SELL" */
|
|
383
|
+
transaction?: string;
|
|
384
|
+
};
|
|
385
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
386
|
+
}
|
|
309
387
|
export class OrdersV2Options<HandleError extends boolean = boolean> {
|
|
310
388
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
311
389
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -511,81 +589,77 @@ export class OrdersV2Options<HandleError extends boolean = boolean> {
|
|
|
511
589
|
};
|
|
512
590
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
513
591
|
}
|
|
514
|
-
export class
|
|
592
|
+
export class OrdersV2Crypto<HandleError extends boolean = boolean> {
|
|
515
593
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
516
594
|
constructor(apiClient: JwtClient<HandleError>);
|
|
517
595
|
/**
|
|
518
|
-
* @tags Orders V2
|
|
519
|
-
* @name
|
|
520
|
-
* @summary
|
|
521
|
-
* @request POST:/orders/v2/
|
|
596
|
+
* @tags Orders V2 Crypto
|
|
597
|
+
* @name OrderPreview
|
|
598
|
+
* @summary Order Preview
|
|
599
|
+
* @request POST:/orders/v2/crypto/preview
|
|
522
600
|
* @secure
|
|
523
601
|
*/
|
|
524
|
-
|
|
602
|
+
orderPreview(data: {
|
|
525
603
|
account?: {
|
|
526
|
-
/** @example
|
|
527
|
-
accountId?: number;
|
|
528
|
-
/** @example "AC00123" */
|
|
604
|
+
/** @example "ABC123" */
|
|
529
605
|
accountNumber?: string;
|
|
530
606
|
};
|
|
531
607
|
order?: {
|
|
532
|
-
/** @example "LIMIT" */
|
|
533
|
-
orderType?: string;
|
|
534
608
|
/** @example 100 */
|
|
535
|
-
|
|
536
|
-
/** @example
|
|
537
|
-
|
|
538
|
-
/** @example
|
|
609
|
+
expectedValue?: number;
|
|
610
|
+
/** @example 1.123 */
|
|
611
|
+
limitPx?: number;
|
|
612
|
+
/** @example "MARKET|LIMIT|STOP|STOP_LIMIG|Notional|NotionalLimit" */
|
|
613
|
+
orderType?: string;
|
|
614
|
+
/** @example 0.0123 */
|
|
539
615
|
quantity?: number;
|
|
540
|
-
/** @example "Par|Unit" */
|
|
541
|
-
quantityType?: string;
|
|
542
616
|
quote?: {
|
|
543
|
-
/** @example "
|
|
544
|
-
|
|
545
|
-
/** @example "CUSIP:ISIN" */
|
|
546
|
-
identType?: string;
|
|
547
|
-
/** @example "SK4120012691" */
|
|
548
|
-
isin?: string;
|
|
617
|
+
/** @example "BTC/USD" */
|
|
618
|
+
symbol?: string;
|
|
549
619
|
};
|
|
620
|
+
/** @example 1.123 */
|
|
621
|
+
stopPx?: number;
|
|
550
622
|
/** @example "BUY|SELL" */
|
|
551
623
|
transaction?: string;
|
|
624
|
+
/** @example "DAY|GTC" */
|
|
625
|
+
validity?: string;
|
|
552
626
|
};
|
|
553
627
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
554
628
|
/**
|
|
555
|
-
* @tags Orders V2
|
|
556
|
-
* @name
|
|
557
|
-
* @summary
|
|
558
|
-
* @request POST:/orders/v2/
|
|
629
|
+
* @tags Orders V2 Crypto
|
|
630
|
+
* @name OrderPlace
|
|
631
|
+
* @summary Order Place
|
|
632
|
+
* @request POST:/orders/v2/crypto/place
|
|
559
633
|
* @secure
|
|
560
634
|
*/
|
|
561
|
-
|
|
635
|
+
orderPlace(data: {
|
|
562
636
|
account?: {
|
|
563
|
-
/** @example
|
|
564
|
-
accountId?: number;
|
|
565
|
-
/** @example "AC00123" */
|
|
637
|
+
/** @example "ABC123" */
|
|
566
638
|
accountNumber?: string;
|
|
567
639
|
};
|
|
568
640
|
order?: {
|
|
569
|
-
/** @example "
|
|
570
|
-
|
|
641
|
+
/** @example "{your own order reference number}" */
|
|
642
|
+
clientRef?: string;
|
|
643
|
+
/** @example "ABC" */
|
|
644
|
+
clientSourceId?: string;
|
|
571
645
|
/** @example 100 */
|
|
572
|
-
|
|
573
|
-
/** @example
|
|
574
|
-
|
|
575
|
-
/** @example
|
|
646
|
+
expectedValue?: number;
|
|
647
|
+
/** @example 1.123 */
|
|
648
|
+
limitPx?: number;
|
|
649
|
+
/** @example "MARKET|LIMIT|STOP|STOP_LIMIT|Notional|NotionalLimit" */
|
|
650
|
+
orderType?: string;
|
|
651
|
+
/** @example 0.0123 */
|
|
576
652
|
quantity?: number;
|
|
577
|
-
/** @example "Par|Unit" */
|
|
578
|
-
quantityType?: string;
|
|
579
653
|
quote?: {
|
|
580
|
-
/** @example "
|
|
581
|
-
|
|
582
|
-
/** @example "CUSIP:ISIN" */
|
|
583
|
-
identType?: string;
|
|
584
|
-
/** @example "SK4120012691" */
|
|
585
|
-
isin?: string;
|
|
654
|
+
/** @example "BTC/USD" */
|
|
655
|
+
symbol?: string;
|
|
586
656
|
};
|
|
657
|
+
/** @example 1.123 */
|
|
658
|
+
stopPx?: number;
|
|
587
659
|
/** @example "BUY|SELL" */
|
|
588
660
|
transaction?: string;
|
|
661
|
+
/** @example "DAY|GTC" */
|
|
662
|
+
validity?: string;
|
|
589
663
|
};
|
|
590
664
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
591
665
|
}
|
|
@@ -633,80 +707,6 @@ export class OrdersV2MutualFunds<HandleError extends boolean = boolean> {
|
|
|
633
707
|
*/
|
|
634
708
|
mutualFundPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
635
709
|
}
|
|
636
|
-
export class OrdersV2Crypto<HandleError extends boolean = boolean> {
|
|
637
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
638
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
639
|
-
/**
|
|
640
|
-
* @tags Orders V2 Crypto
|
|
641
|
-
* @name OrderPreview
|
|
642
|
-
* @summary Order Preview
|
|
643
|
-
* @request POST:/orders/v2/crypto/preview
|
|
644
|
-
* @secure
|
|
645
|
-
*/
|
|
646
|
-
orderPreview(data: {
|
|
647
|
-
account?: {
|
|
648
|
-
/** @example "ABC123" */
|
|
649
|
-
accountNumber?: string;
|
|
650
|
-
};
|
|
651
|
-
order?: {
|
|
652
|
-
/** @example 100 */
|
|
653
|
-
expectedValue?: number;
|
|
654
|
-
/** @example 1.123 */
|
|
655
|
-
limitPx?: number;
|
|
656
|
-
/** @example "MARKET|LIMIT|STOP|STOP_LIMIG|Notional|NotionalLimit" */
|
|
657
|
-
orderType?: string;
|
|
658
|
-
/** @example 0.0123 */
|
|
659
|
-
quantity?: number;
|
|
660
|
-
quote?: {
|
|
661
|
-
/** @example "BTC/USD" */
|
|
662
|
-
symbol?: string;
|
|
663
|
-
};
|
|
664
|
-
/** @example 1.123 */
|
|
665
|
-
stopPx?: number;
|
|
666
|
-
/** @example "BUY|SELL" */
|
|
667
|
-
transaction?: string;
|
|
668
|
-
/** @example "DAY|GTC" */
|
|
669
|
-
validity?: string;
|
|
670
|
-
};
|
|
671
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
672
|
-
/**
|
|
673
|
-
* @tags Orders V2 Crypto
|
|
674
|
-
* @name OrderPlace
|
|
675
|
-
* @summary Order Place
|
|
676
|
-
* @request POST:/orders/v2/crypto/place
|
|
677
|
-
* @secure
|
|
678
|
-
*/
|
|
679
|
-
orderPlace(data: {
|
|
680
|
-
account?: {
|
|
681
|
-
/** @example "ABC123" */
|
|
682
|
-
accountNumber?: string;
|
|
683
|
-
};
|
|
684
|
-
order?: {
|
|
685
|
-
/** @example "{your own order reference number}" */
|
|
686
|
-
clientRef?: string;
|
|
687
|
-
/** @example "ABC" */
|
|
688
|
-
clientSourceId?: string;
|
|
689
|
-
/** @example 100 */
|
|
690
|
-
expectedValue?: number;
|
|
691
|
-
/** @example 1.123 */
|
|
692
|
-
limitPx?: number;
|
|
693
|
-
/** @example "MARKET|LIMIT|STOP|STOP_LIMIT|Notional|NotionalLimit" */
|
|
694
|
-
orderType?: string;
|
|
695
|
-
/** @example 0.0123 */
|
|
696
|
-
quantity?: number;
|
|
697
|
-
quote?: {
|
|
698
|
-
/** @example "BTC/USD" */
|
|
699
|
-
symbol?: string;
|
|
700
|
-
};
|
|
701
|
-
/** @example 1.123 */
|
|
702
|
-
stopPx?: number;
|
|
703
|
-
/** @example "BUY|SELL" */
|
|
704
|
-
transaction?: string;
|
|
705
|
-
/** @example "DAY|GTC" */
|
|
706
|
-
validity?: string;
|
|
707
|
-
};
|
|
708
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
709
|
-
}
|
|
710
710
|
export class OrdersV2Offerings<HandleError extends boolean = boolean> {
|
|
711
711
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
712
712
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -1331,836 +1331,549 @@ export class ResearchTipranks<HandleError extends boolean = boolean> {
|
|
|
1331
1331
|
*/
|
|
1332
1332
|
bloggerRatings(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1333
1333
|
}
|
|
1334
|
-
export class
|
|
1334
|
+
export class ResearchEtfs<HandleError extends boolean = boolean> {
|
|
1335
1335
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
1336
1336
|
constructor(apiClient: JwtClient<HandleError>);
|
|
1337
1337
|
/**
|
|
1338
|
-
* @tags
|
|
1339
|
-
* @name
|
|
1340
|
-
* @summary
|
|
1341
|
-
* @request GET:/
|
|
1338
|
+
* @tags Research Etfs
|
|
1339
|
+
* @name InitScreener
|
|
1340
|
+
* @summary Init Screener
|
|
1341
|
+
* @request GET:/research/etf/init
|
|
1342
1342
|
* @secure
|
|
1343
1343
|
*/
|
|
1344
|
-
|
|
1345
|
-
/**
|
|
1346
|
-
* Comma separated list of symbols
|
|
1347
|
-
* @example "IBM"
|
|
1348
|
-
*/
|
|
1349
|
-
symbols?: any;
|
|
1350
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1344
|
+
initScreener(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1351
1345
|
/**
|
|
1352
|
-
* @tags
|
|
1353
|
-
* @name
|
|
1354
|
-
* @summary
|
|
1355
|
-
* @request GET:/
|
|
1346
|
+
* @tags Research Etfs
|
|
1347
|
+
* @name Screener
|
|
1348
|
+
* @summary Screener
|
|
1349
|
+
* @request GET:/research/etf/screener
|
|
1356
1350
|
* @secure
|
|
1357
1351
|
*/
|
|
1358
|
-
|
|
1352
|
+
screener(query?: {
|
|
1353
|
+
/** * see init */
|
|
1354
|
+
inverseType?: any;
|
|
1355
|
+
/** * see init */
|
|
1356
|
+
leverageType?: any;
|
|
1357
|
+
/** * see init */
|
|
1358
|
+
assetId?: any;
|
|
1359
|
+
/** * see init */
|
|
1360
|
+
categoryId?: any;
|
|
1361
|
+
/** * see init */
|
|
1362
|
+
sponsorId?: any;
|
|
1363
|
+
/** Entry to start at */
|
|
1364
|
+
start?: any;
|
|
1365
|
+
/** Entries per page */
|
|
1366
|
+
num?: any;
|
|
1367
|
+
/** Sort by: symbol, last, change, volume, marketcap, expense, asset, sponsor, category, leverage, countrypct, countinentpct, sectorpct, exposure */
|
|
1368
|
+
sort?: any;
|
|
1369
|
+
/** True/false */
|
|
1370
|
+
asc?: any;
|
|
1359
1371
|
/**
|
|
1360
|
-
*
|
|
1361
|
-
* @example "
|
|
1372
|
+
* True/false
|
|
1373
|
+
* @example "false"
|
|
1362
1374
|
*/
|
|
1363
|
-
|
|
1375
|
+
loadIndustries?: any;
|
|
1364
1376
|
/**
|
|
1365
|
-
*
|
|
1366
|
-
* @example "
|
|
1377
|
+
* True/false
|
|
1378
|
+
* @example "false"
|
|
1367
1379
|
*/
|
|
1368
|
-
|
|
1380
|
+
loadUpgrades?: any;
|
|
1369
1381
|
/**
|
|
1370
|
-
*
|
|
1382
|
+
* True/false
|
|
1371
1383
|
* @example "false"
|
|
1372
1384
|
*/
|
|
1373
|
-
|
|
1385
|
+
loadEarnings?: any;
|
|
1386
|
+
/**
|
|
1387
|
+
* Repeating set of:
|
|
1388
|
+
* * paying dividend
|
|
1389
|
+
* * 5pct - paying at least 5% dividend
|
|
1390
|
+
* * 3pct
|
|
1391
|
+
* * mcbelow2b – market cap under 2B
|
|
1392
|
+
* * mcbetween2and10b
|
|
1393
|
+
* * mcbetween10and200b
|
|
1394
|
+
* * mcabove200b
|
|
1395
|
+
*/
|
|
1396
|
+
filters?: any;
|
|
1374
1397
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1375
1398
|
/**
|
|
1376
|
-
* @tags
|
|
1377
|
-
* @name
|
|
1378
|
-
* @summary
|
|
1379
|
-
* @request GET:/
|
|
1399
|
+
* @tags Research Etfs
|
|
1400
|
+
* @name Top10
|
|
1401
|
+
* @summary Top 10
|
|
1402
|
+
* @request GET:/research/etf/top10
|
|
1380
1403
|
* @secure
|
|
1381
1404
|
*/
|
|
1382
|
-
|
|
1383
|
-
/** Comma separated list of symbols */
|
|
1384
|
-
symbols?: any;
|
|
1405
|
+
top10(query?: {
|
|
1385
1406
|
/**
|
|
1386
|
-
*
|
|
1387
|
-
* @example ""
|
|
1407
|
+
* * see Inverse Types table
|
|
1408
|
+
* @example "ALL"
|
|
1388
1409
|
*/
|
|
1389
|
-
|
|
1410
|
+
inverseType?: any;
|
|
1411
|
+
/**
|
|
1412
|
+
* * see Leverage Types table
|
|
1413
|
+
* @example "LEVERAGE"
|
|
1414
|
+
*/
|
|
1415
|
+
leverageType?: any;
|
|
1390
1416
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1391
1417
|
/**
|
|
1392
|
-
* @tags
|
|
1393
|
-
* @name
|
|
1394
|
-
* @summary
|
|
1395
|
-
* @request GET:/
|
|
1418
|
+
* @tags Research Etfs
|
|
1419
|
+
* @name Details
|
|
1420
|
+
* @summary Details
|
|
1421
|
+
* @request GET:/research/etf/details
|
|
1396
1422
|
* @secure
|
|
1397
1423
|
*/
|
|
1398
|
-
|
|
1399
|
-
/**
|
|
1400
|
-
* [optional]
|
|
1401
|
-
* @example "MSFT"
|
|
1402
|
-
*/
|
|
1403
|
-
underlying?: any;
|
|
1424
|
+
details(query?: {
|
|
1404
1425
|
/**
|
|
1405
|
-
*
|
|
1406
|
-
* @example "
|
|
1426
|
+
* ETF symbol
|
|
1427
|
+
* @example "VXF"
|
|
1407
1428
|
*/
|
|
1408
1429
|
symbol?: any;
|
|
1409
1430
|
/**
|
|
1410
|
-
*
|
|
1411
|
-
* @example "
|
|
1431
|
+
* Use true to include quotes. Defaults to false.
|
|
1432
|
+
* @example "false"
|
|
1412
1433
|
*/
|
|
1413
|
-
|
|
1434
|
+
loadQuotes?: any;
|
|
1414
1435
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1415
1436
|
/**
|
|
1416
|
-
* @tags
|
|
1417
|
-
* @name
|
|
1418
|
-
* @summary
|
|
1419
|
-
* @request GET:/
|
|
1437
|
+
* @tags Research Etfs
|
|
1438
|
+
* @name BreakdownBySector
|
|
1439
|
+
* @summary Breakdown by Sector
|
|
1440
|
+
* @request GET:/research/etf/breakdown
|
|
1420
1441
|
* @secure
|
|
1421
1442
|
*/
|
|
1422
|
-
|
|
1443
|
+
breakdownBySector(query?: {
|
|
1423
1444
|
/**
|
|
1424
|
-
*
|
|
1425
|
-
* @example "
|
|
1445
|
+
* 1d, 1w, 2w, 1m where d is day, w is week, and m is month
|
|
1446
|
+
* @example "1d"
|
|
1426
1447
|
*/
|
|
1427
|
-
|
|
1448
|
+
duration?: any;
|
|
1428
1449
|
/**
|
|
1429
|
-
*
|
|
1430
|
-
* @example "
|
|
1450
|
+
* Amount of ETFs to include per sector. Defaults to 5, max is 10
|
|
1451
|
+
* @example "5"
|
|
1431
1452
|
*/
|
|
1432
|
-
|
|
1453
|
+
displaySize?: any;
|
|
1454
|
+
/**
|
|
1455
|
+
* Exposure to specific sector. Defaults to 90
|
|
1456
|
+
* @example "90"
|
|
1457
|
+
*/
|
|
1458
|
+
exposure?: any;
|
|
1433
1459
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1460
|
+
}
|
|
1461
|
+
export class ResearchAdrs<HandleError extends boolean = boolean> {
|
|
1462
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
1463
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
1434
1464
|
/**
|
|
1435
|
-
* @tags
|
|
1436
|
-
* @name
|
|
1437
|
-
* @summary
|
|
1438
|
-
* @request GET:/
|
|
1465
|
+
* @tags Research Adrs
|
|
1466
|
+
* @name Top10
|
|
1467
|
+
* @summary Top 10
|
|
1468
|
+
* @request GET:/research/adrs/top10
|
|
1439
1469
|
* @secure
|
|
1440
1470
|
*/
|
|
1441
|
-
|
|
1442
|
-
/**
|
|
1443
|
-
|
|
1444
|
-
/**
|
|
1445
|
-
limit?: any;
|
|
1446
|
-
/** @example "false" */
|
|
1471
|
+
top10(query?: {
|
|
1472
|
+
/** See description */
|
|
1473
|
+
country?: any;
|
|
1474
|
+
/** `true` or `false` */
|
|
1447
1475
|
loadQuotes?: any;
|
|
1476
|
+
/** `true` or `false` */
|
|
1477
|
+
loadEarningReleases?: any;
|
|
1478
|
+
/** `true` or `false` */
|
|
1479
|
+
loadUpgradesDowngrades?: any;
|
|
1448
1480
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1449
1481
|
/**
|
|
1450
|
-
* @tags
|
|
1451
|
-
* @name
|
|
1452
|
-
* @summary
|
|
1453
|
-
* @request GET:/
|
|
1482
|
+
* @tags Research Adrs
|
|
1483
|
+
* @name Defaults
|
|
1484
|
+
* @summary Defaults
|
|
1485
|
+
* @request GET:/research/adrs/top10/defaults
|
|
1454
1486
|
* @secure
|
|
1455
1487
|
*/
|
|
1456
|
-
|
|
1457
|
-
/**
|
|
1458
|
-
* Ticker
|
|
1459
|
-
* @example "AAPL"
|
|
1460
|
-
*/
|
|
1461
|
-
symbol?: any;
|
|
1462
|
-
/**
|
|
1463
|
-
* Start date (mm/dd/yyyy)
|
|
1464
|
-
* @example "01/01/2017"
|
|
1465
|
-
*/
|
|
1466
|
-
start?: any;
|
|
1467
|
-
/**
|
|
1468
|
-
* End date (mm/dd/yyyy)
|
|
1469
|
-
* @example "06/01/2017"
|
|
1470
|
-
*/
|
|
1471
|
-
end?: any;
|
|
1472
|
-
/** If `start` and `end` are not specified, then range needs to be given. Format: [num][y/m] (y – year, m – months). `num` specifies number of (y/m) back from current date */
|
|
1473
|
-
range?: any;
|
|
1474
|
-
/** Set `true` to load weekly data points. Defaults to false. */
|
|
1475
|
-
setWeekly?: any;
|
|
1476
|
-
/** Include RSI data by setting a span. Value must be > 0 */
|
|
1477
|
-
rsiSpan?: any;
|
|
1478
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1488
|
+
defaults(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1479
1489
|
/**
|
|
1480
|
-
* @tags
|
|
1481
|
-
* @name
|
|
1482
|
-
* @summary
|
|
1483
|
-
* @request GET:/
|
|
1490
|
+
* @tags Research Adrs
|
|
1491
|
+
* @name Search
|
|
1492
|
+
* @summary Search
|
|
1493
|
+
* @request GET:/research/adrs
|
|
1484
1494
|
* @secure
|
|
1485
1495
|
*/
|
|
1486
|
-
|
|
1487
|
-
/**
|
|
1488
|
-
* Ticker
|
|
1489
|
-
* @example "IBM"
|
|
1490
|
-
*/
|
|
1491
|
-
symbol?: any;
|
|
1492
|
-
/** Include RSI data by setting a span. Value must be > 0 */
|
|
1493
|
-
rsiSpan?: any;
|
|
1494
|
-
/** `optional` timestamp format for multiday charts */
|
|
1495
|
-
from?: any;
|
|
1496
|
-
/** `optional` timestamp format for multiday charts */
|
|
1497
|
-
to?: any;
|
|
1496
|
+
search(query?: {
|
|
1498
1497
|
/**
|
|
1499
|
-
*
|
|
1500
|
-
* @example "
|
|
1498
|
+
* Country code such as JPN. See `Defaults` endpoint
|
|
1499
|
+
* @example "JPN"
|
|
1501
1500
|
*/
|
|
1502
|
-
|
|
1501
|
+
country?: any;
|
|
1502
|
+
/** `true` or `false` */
|
|
1503
|
+
loadQuotes?: any;
|
|
1504
|
+
/** `true` or `false` */
|
|
1505
|
+
loadEarningReleases?: any;
|
|
1506
|
+
/** `true` or `false` */
|
|
1507
|
+
loadUpgradesDowngrades?: any;
|
|
1503
1508
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1509
|
+
}
|
|
1510
|
+
export class ResearchCorporateActions<HandleError extends boolean = boolean> {
|
|
1511
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
1512
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
1504
1513
|
/**
|
|
1505
|
-
* @tags
|
|
1506
|
-
* @name
|
|
1507
|
-
* @summary
|
|
1508
|
-
* @request GET:/
|
|
1514
|
+
* @tags Research Corporate Actions
|
|
1515
|
+
* @name Types
|
|
1516
|
+
* @summary Types
|
|
1517
|
+
* @request GET:/research/actions/types
|
|
1509
1518
|
* @secure
|
|
1510
1519
|
*/
|
|
1511
|
-
|
|
1520
|
+
types(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1521
|
+
/**
|
|
1522
|
+
* @tags Research Corporate Actions
|
|
1523
|
+
* @name PaymentTypes
|
|
1524
|
+
* @summary Payment types
|
|
1525
|
+
* @request GET:/research/actions/paymentTypes
|
|
1526
|
+
* @secure
|
|
1527
|
+
*/
|
|
1528
|
+
paymentTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1529
|
+
/**
|
|
1530
|
+
* @tags Research Corporate Actions
|
|
1531
|
+
* @name Search
|
|
1532
|
+
* @summary Search
|
|
1533
|
+
* @request GET:/research/actions/search
|
|
1534
|
+
* @secure
|
|
1535
|
+
*/
|
|
1536
|
+
search(query?: {
|
|
1512
1537
|
/**
|
|
1513
|
-
*
|
|
1514
|
-
* @example "
|
|
1538
|
+
* Old or new symbol (multiple tickers separated by comma)
|
|
1539
|
+
* @example "{symbol}"
|
|
1515
1540
|
*/
|
|
1516
1541
|
symbol?: any;
|
|
1517
1542
|
/**
|
|
1518
|
-
*
|
|
1519
|
-
* @example "
|
|
1520
|
-
*/
|
|
1521
|
-
startTime?: any;
|
|
1522
|
-
/**
|
|
1523
|
-
* Timestamp for end of the data. Format: MM/DD/YYYY HH:MM or MM/DD/YYYY
|
|
1524
|
-
* @example "11/28/2016"
|
|
1543
|
+
* Defaults to today's date in America/New_York timezone.
|
|
1544
|
+
* @example "{date}"
|
|
1525
1545
|
*/
|
|
1526
|
-
|
|
1527
|
-
|
|
1528
|
-
|
|
1529
|
-
* @tags Quotes
|
|
1530
|
-
* @name Shortability
|
|
1531
|
-
* @summary Shortability
|
|
1532
|
-
* @request GET:/quotes/equity/shortability/{symbol}
|
|
1533
|
-
* @secure
|
|
1534
|
-
*/
|
|
1535
|
-
shortability(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1536
|
-
/**
|
|
1537
|
-
* @tags Quotes
|
|
1538
|
-
* @name MarginSuitability
|
|
1539
|
-
* @summary Margin Suitability
|
|
1540
|
-
* @request GET:/quotes/equity/marginability
|
|
1541
|
-
* @secure
|
|
1542
|
-
*/
|
|
1543
|
-
marginSuitability(query?: {
|
|
1546
|
+
dateFrom?: any;
|
|
1547
|
+
/** @example "{date}" */
|
|
1548
|
+
dateTo?: any;
|
|
1544
1549
|
/**
|
|
1545
|
-
*
|
|
1546
|
-
* @example "
|
|
1550
|
+
* (separate multiple types with comma)
|
|
1551
|
+
* @example "{type}"
|
|
1547
1552
|
*/
|
|
1548
|
-
|
|
1553
|
+
type?: any;
|
|
1549
1554
|
/**
|
|
1550
|
-
*
|
|
1551
|
-
* @example "
|
|
1555
|
+
* (search for Dividends using payment date instead of ex-date)
|
|
1556
|
+
* @example "false"
|
|
1552
1557
|
*/
|
|
1553
|
-
|
|
1554
|
-
accountId?: any;
|
|
1558
|
+
usePayDate?: any;
|
|
1555
1559
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1560
|
+
}
|
|
1561
|
+
export class ResearchNews<HandleError extends boolean = boolean> {
|
|
1562
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
1563
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
1556
1564
|
/**
|
|
1557
|
-
* @tags
|
|
1558
|
-
* @name
|
|
1559
|
-
* @summary
|
|
1560
|
-
* @request GET:/
|
|
1565
|
+
* @tags Research News
|
|
1566
|
+
* @name List
|
|
1567
|
+
* @summary List
|
|
1568
|
+
* @request GET:/research/news
|
|
1561
1569
|
* @secure
|
|
1562
1570
|
*/
|
|
1563
|
-
|
|
1571
|
+
list(query?: {
|
|
1572
|
+
/** @example "0" */
|
|
1573
|
+
start?: any;
|
|
1564
1574
|
/**
|
|
1565
|
-
*
|
|
1566
|
-
* @example "
|
|
1575
|
+
* Defaults to 20
|
|
1576
|
+
* @example "100"
|
|
1567
1577
|
*/
|
|
1568
|
-
|
|
1578
|
+
count?: any;
|
|
1579
|
+
/** @example "[[-](provider|aggregator):value1,valueN];" */
|
|
1580
|
+
filter?: any;
|
|
1569
1581
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1570
1582
|
/**
|
|
1571
|
-
* @tags
|
|
1572
|
-
* @name
|
|
1573
|
-
* @summary
|
|
1574
|
-
* @request GET:/
|
|
1583
|
+
* @tags Research News
|
|
1584
|
+
* @name NewsBySymbol
|
|
1585
|
+
* @summary News by Symbol
|
|
1586
|
+
* @request GET:/research/news/ticker/{symbol}
|
|
1575
1587
|
* @secure
|
|
1576
1588
|
*/
|
|
1577
|
-
|
|
1589
|
+
newsBySymbol(symbol: string, query?: {
|
|
1578
1590
|
/**
|
|
1579
|
-
*
|
|
1580
|
-
* @example "
|
|
1591
|
+
* Starting page (optional)
|
|
1592
|
+
* @example ""
|
|
1581
1593
|
*/
|
|
1582
|
-
|
|
1594
|
+
start?: any;
|
|
1595
|
+
/** Defaults to 20 (optional) */
|
|
1596
|
+
count?: any;
|
|
1583
1597
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1584
1598
|
/**
|
|
1585
|
-
* @tags
|
|
1586
|
-
* @name
|
|
1587
|
-
* @summary
|
|
1588
|
-
* @request GET:/
|
|
1599
|
+
* @tags Research News
|
|
1600
|
+
* @name Sec
|
|
1601
|
+
* @summary SEC
|
|
1602
|
+
* @request GET:/research/news/sec/{symbol}
|
|
1589
1603
|
* @secure
|
|
1590
1604
|
*/
|
|
1591
|
-
|
|
1605
|
+
sec(symbol: string, query?: {
|
|
1592
1606
|
/**
|
|
1593
|
-
*
|
|
1594
|
-
* @example "
|
|
1607
|
+
* Starting point(optional)
|
|
1608
|
+
* @example "0"
|
|
1595
1609
|
*/
|
|
1596
|
-
|
|
1597
|
-
|
|
1598
|
-
|
|
1599
|
-
|
|
1600
|
-
|
|
1601
|
-
|
|
1602
|
-
* @request GET:/quotes/crypto
|
|
1603
|
-
* @secure
|
|
1604
|
-
*/
|
|
1605
|
-
crypto(query?: {
|
|
1606
|
-
/** @example "" */
|
|
1607
|
-
symbols?: any;
|
|
1610
|
+
start?: any;
|
|
1611
|
+
/**
|
|
1612
|
+
* Defaults to 20 (optional)
|
|
1613
|
+
* @example "2"
|
|
1614
|
+
*/
|
|
1615
|
+
count?: any;
|
|
1608
1616
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1609
1617
|
/**
|
|
1610
|
-
* @tags
|
|
1611
|
-
* @name
|
|
1612
|
-
* @summary
|
|
1613
|
-
* @request GET:/
|
|
1618
|
+
* @tags Research News
|
|
1619
|
+
* @name Lookup
|
|
1620
|
+
* @summary Lookup
|
|
1621
|
+
* @request GET:/research/news/{newsId}
|
|
1614
1622
|
* @secure
|
|
1615
1623
|
*/
|
|
1616
|
-
|
|
1617
|
-
/** @example "EUR/USD,GBP/USD" */
|
|
1618
|
-
symbols?: any;
|
|
1619
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1624
|
+
lookup(newsId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1620
1625
|
}
|
|
1621
|
-
export class
|
|
1626
|
+
export class ResearchAlphaTools<HandleError extends boolean = boolean> {
|
|
1622
1627
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
1623
1628
|
constructor(apiClient: JwtClient<HandleError>);
|
|
1624
1629
|
/**
|
|
1625
|
-
* @tags Research
|
|
1626
|
-
* @name
|
|
1627
|
-
* @summary
|
|
1628
|
-
* @request GET:/
|
|
1629
|
-
* @secure
|
|
1630
|
-
*/
|
|
1631
|
-
initScreener(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1632
|
-
/**
|
|
1633
|
-
* @tags Research Etfs
|
|
1634
|
-
* @name Screener
|
|
1635
|
-
* @summary Screener
|
|
1636
|
-
* @request GET:/research/etf/screener
|
|
1630
|
+
* @tags Research Alpha Tools
|
|
1631
|
+
* @name AlphaTracker
|
|
1632
|
+
* @summary Alpha Tracker
|
|
1633
|
+
* @request GET:/quotes/rst
|
|
1637
1634
|
* @secure
|
|
1638
1635
|
*/
|
|
1639
|
-
|
|
1640
|
-
/** * see init */
|
|
1641
|
-
inverseType?: any;
|
|
1642
|
-
/** * see init */
|
|
1643
|
-
leverageType?: any;
|
|
1644
|
-
/** * see init */
|
|
1645
|
-
assetId?: any;
|
|
1646
|
-
/** * see init */
|
|
1647
|
-
categoryId?: any;
|
|
1648
|
-
/** * see init */
|
|
1649
|
-
sponsorId?: any;
|
|
1650
|
-
/** Entry to start at */
|
|
1651
|
-
start?: any;
|
|
1652
|
-
/** Entries per page */
|
|
1653
|
-
num?: any;
|
|
1654
|
-
/** Sort by: symbol, last, change, volume, marketcap, expense, asset, sponsor, category, leverage, countrypct, countinentpct, sectorpct, exposure */
|
|
1655
|
-
sort?: any;
|
|
1656
|
-
/** True/false */
|
|
1657
|
-
asc?: any;
|
|
1636
|
+
alphaTracker(query?: {
|
|
1658
1637
|
/**
|
|
1659
|
-
*
|
|
1660
|
-
* @example "
|
|
1638
|
+
* Takes one symbol for the benchmark
|
|
1639
|
+
* @example "SPY"
|
|
1661
1640
|
*/
|
|
1662
|
-
|
|
1641
|
+
benchmark?: any;
|
|
1663
1642
|
/**
|
|
1664
|
-
*
|
|
1665
|
-
* @example "
|
|
1643
|
+
* Comma seperated list of symbols
|
|
1644
|
+
* @example "AAPL,GOOG"
|
|
1666
1645
|
*/
|
|
1667
|
-
|
|
1646
|
+
symbols?: any;
|
|
1668
1647
|
/**
|
|
1669
|
-
*
|
|
1670
|
-
* @example "
|
|
1648
|
+
* Format: [num][y/m] (y – year, m – months). `num` specifies number of (y/m) back from current date. If range is not provided it defaults to 1 year.
|
|
1649
|
+
* @example "2y"
|
|
1671
1650
|
*/
|
|
1672
|
-
|
|
1651
|
+
range?: any;
|
|
1673
1652
|
/**
|
|
1674
|
-
*
|
|
1675
|
-
*
|
|
1676
|
-
* * 5pct - paying at least 5% dividend
|
|
1677
|
-
* * 3pct
|
|
1678
|
-
* * mcbelow2b – market cap under 2B
|
|
1679
|
-
* * mcbetween2and10b
|
|
1680
|
-
* * mcbetween10and200b
|
|
1681
|
-
* * mcabove200b
|
|
1653
|
+
* A number between 4-10 can be selected for the period. Defaults to 4
|
|
1654
|
+
* @example "180"
|
|
1682
1655
|
*/
|
|
1683
|
-
|
|
1656
|
+
period?: any;
|
|
1657
|
+
/**
|
|
1658
|
+
* Set `true` or `false` to enable exponential moving average. Optional. Defaults to false.
|
|
1659
|
+
* @example "true"
|
|
1660
|
+
*/
|
|
1661
|
+
setEMA?: any;
|
|
1684
1662
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1685
1663
|
/**
|
|
1686
|
-
* @tags Research
|
|
1687
|
-
* @name
|
|
1688
|
-
* @summary
|
|
1689
|
-
* @request GET:/
|
|
1664
|
+
* @tags Research Alpha Tools
|
|
1665
|
+
* @name Seasonality
|
|
1666
|
+
* @summary Seasonality
|
|
1667
|
+
* @request GET:/quotes/seasonality
|
|
1690
1668
|
* @secure
|
|
1691
1669
|
*/
|
|
1692
|
-
|
|
1670
|
+
seasonality(query?: {
|
|
1693
1671
|
/**
|
|
1694
|
-
*
|
|
1695
|
-
* @example "
|
|
1672
|
+
* Comma separated list of symbols
|
|
1673
|
+
* @example "AAPL,IBM,GOOG,TSLA"
|
|
1696
1674
|
*/
|
|
1697
|
-
|
|
1675
|
+
symbols?: any;
|
|
1698
1676
|
/**
|
|
1699
|
-
*
|
|
1700
|
-
* @example "
|
|
1677
|
+
* The benchmark to compare the list of symbols to
|
|
1678
|
+
* @example "SPY"
|
|
1701
1679
|
*/
|
|
1702
|
-
|
|
1680
|
+
benchmark?: any;
|
|
1681
|
+
/**
|
|
1682
|
+
* Defaults to 10. Cannot be less than 3.
|
|
1683
|
+
* @example "5"
|
|
1684
|
+
*/
|
|
1685
|
+
years?: any;
|
|
1703
1686
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1704
1687
|
/**
|
|
1705
|
-
* @tags Research
|
|
1706
|
-
* @name
|
|
1707
|
-
* @summary
|
|
1708
|
-
* @request GET:/
|
|
1688
|
+
* @tags Research Alpha Tools
|
|
1689
|
+
* @name WeeklySeasonality
|
|
1690
|
+
* @summary Weekly Seasonality
|
|
1691
|
+
* @request GET:/quotes/seasonality/weekly
|
|
1709
1692
|
* @secure
|
|
1710
1693
|
*/
|
|
1711
|
-
|
|
1694
|
+
weeklySeasonality(query?: {
|
|
1712
1695
|
/**
|
|
1713
|
-
*
|
|
1714
|
-
* @example "
|
|
1696
|
+
* Comma separated list of symbols
|
|
1697
|
+
* @example "AAPL,IBM,GOOG,TSLA"
|
|
1715
1698
|
*/
|
|
1716
|
-
|
|
1699
|
+
symbols?: any;
|
|
1717
1700
|
/**
|
|
1718
|
-
*
|
|
1719
|
-
* @example "
|
|
1701
|
+
* The benchmark to compare the list of symbols to
|
|
1702
|
+
* @example "SPY"
|
|
1720
1703
|
*/
|
|
1721
|
-
|
|
1722
|
-
|
|
1723
|
-
|
|
1724
|
-
|
|
1725
|
-
|
|
1726
|
-
|
|
1727
|
-
* @request GET:/research/etf/breakdown
|
|
1728
|
-
* @secure
|
|
1729
|
-
*/
|
|
1730
|
-
breakdownBySector(query?: {
|
|
1731
|
-
/**
|
|
1732
|
-
* 1d, 1w, 2w, 1m where d is day, w is week, and m is month
|
|
1733
|
-
* @example "1d"
|
|
1734
|
-
*/
|
|
1735
|
-
duration?: any;
|
|
1736
|
-
/**
|
|
1737
|
-
* Amount of ETFs to include per sector. Defaults to 5, max is 10
|
|
1738
|
-
* @example "5"
|
|
1739
|
-
*/
|
|
1740
|
-
displaySize?: any;
|
|
1741
|
-
/**
|
|
1742
|
-
* Exposure to specific sector. Defaults to 90
|
|
1743
|
-
* @example "90"
|
|
1744
|
-
*/
|
|
1745
|
-
exposure?: any;
|
|
1704
|
+
benchmark?: any;
|
|
1705
|
+
/**
|
|
1706
|
+
* Defaults to 10. Cannot be less than 3.
|
|
1707
|
+
* @example "5"
|
|
1708
|
+
*/
|
|
1709
|
+
years?: any;
|
|
1746
1710
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1747
1711
|
}
|
|
1748
|
-
export class
|
|
1712
|
+
export class ResearchIpos<HandleError extends boolean = boolean> {
|
|
1749
1713
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
1750
1714
|
constructor(apiClient: JwtClient<HandleError>);
|
|
1751
1715
|
/**
|
|
1752
|
-
* @tags Research
|
|
1753
|
-
* @name
|
|
1754
|
-
* @summary
|
|
1755
|
-
* @request GET:/research/
|
|
1716
|
+
* @tags Research Ipos
|
|
1717
|
+
* @name Recent
|
|
1718
|
+
* @summary Recent
|
|
1719
|
+
* @request GET:/research/ipo/recent
|
|
1756
1720
|
* @secure
|
|
1757
1721
|
*/
|
|
1758
|
-
|
|
1759
|
-
/**
|
|
1760
|
-
|
|
1761
|
-
|
|
1722
|
+
recent(query?: {
|
|
1723
|
+
/**
|
|
1724
|
+
* `true` or `false` to load quotes
|
|
1725
|
+
* @example ""
|
|
1726
|
+
*/
|
|
1762
1727
|
loadQuotes?: any;
|
|
1763
|
-
/**
|
|
1764
|
-
|
|
1765
|
-
/**
|
|
1766
|
-
|
|
1728
|
+
/** 1m, 3m*, 6m, 1y */
|
|
1729
|
+
time?: any;
|
|
1730
|
+
/** symbol, ipoDate, offerPx, shares, day1Ret, ipoRet, last, change, offerSz */
|
|
1731
|
+
sort?: any;
|
|
1767
1732
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1768
1733
|
/**
|
|
1769
|
-
* @tags Research
|
|
1770
|
-
* @name
|
|
1771
|
-
* @summary
|
|
1772
|
-
* @request GET:/research/
|
|
1734
|
+
* @tags Research Ipos
|
|
1735
|
+
* @name Upcoming
|
|
1736
|
+
* @summary Upcoming
|
|
1737
|
+
* @request GET:/research/ipo/upcoming
|
|
1773
1738
|
* @secure
|
|
1774
1739
|
*/
|
|
1775
|
-
|
|
1740
|
+
upcoming(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1776
1741
|
/**
|
|
1777
|
-
* @tags Research
|
|
1778
|
-
* @name
|
|
1779
|
-
* @summary
|
|
1780
|
-
* @request GET:/research/
|
|
1742
|
+
* @tags Research Ipos
|
|
1743
|
+
* @name Performance
|
|
1744
|
+
* @summary Performance
|
|
1745
|
+
* @request GET:/research/ipo/performance
|
|
1781
1746
|
* @secure
|
|
1782
1747
|
*/
|
|
1783
|
-
|
|
1748
|
+
performance(query?: {
|
|
1784
1749
|
/**
|
|
1785
|
-
*
|
|
1786
|
-
* @example "
|
|
1750
|
+
* `true` or `false` to load quotes
|
|
1751
|
+
* @example "false"
|
|
1787
1752
|
*/
|
|
1788
|
-
country?: any;
|
|
1789
|
-
/** `true` or `false` */
|
|
1790
1753
|
loadQuotes?: any;
|
|
1791
|
-
/**
|
|
1792
|
-
|
|
1793
|
-
|
|
1794
|
-
|
|
1754
|
+
/**
|
|
1755
|
+
* 1m, 3m*, 6m, 1y
|
|
1756
|
+
* @example "1m"
|
|
1757
|
+
*/
|
|
1758
|
+
time?: any;
|
|
1759
|
+
/**
|
|
1760
|
+
* shares, day1Ret, ipoRet, last, change, offerSz
|
|
1761
|
+
* @example "day1Ret"
|
|
1762
|
+
*/
|
|
1763
|
+
sort?: any;
|
|
1795
1764
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1796
1765
|
}
|
|
1797
|
-
export class
|
|
1766
|
+
export class Research<HandleError extends boolean = boolean> {
|
|
1798
1767
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
1768
|
+
tipranks: ResearchTipranks<HandleError>;
|
|
1769
|
+
etfs: ResearchEtfs<HandleError>;
|
|
1770
|
+
adrs: ResearchAdrs<HandleError>;
|
|
1771
|
+
corporateActions: ResearchCorporateActions<HandleError>;
|
|
1772
|
+
news: ResearchNews<HandleError>;
|
|
1773
|
+
alphaTools: ResearchAlphaTools<HandleError>;
|
|
1774
|
+
ipos: ResearchIpos<HandleError>;
|
|
1799
1775
|
constructor(apiClient: JwtClient<HandleError>);
|
|
1800
1776
|
/**
|
|
1801
|
-
* @tags Research
|
|
1802
|
-
* @name
|
|
1803
|
-
* @summary
|
|
1804
|
-
* @request GET:/
|
|
1805
|
-
* @secure
|
|
1806
|
-
*/
|
|
1807
|
-
types(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1808
|
-
/**
|
|
1809
|
-
* @tags Research Corporate Actions
|
|
1810
|
-
* @name PaymentTypes
|
|
1811
|
-
* @summary Payment types
|
|
1812
|
-
* @request GET:/research/actions/paymentTypes
|
|
1813
|
-
* @secure
|
|
1814
|
-
*/
|
|
1815
|
-
paymentTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1816
|
-
/**
|
|
1817
|
-
* @tags Research Corporate Actions
|
|
1818
|
-
* @name Search
|
|
1819
|
-
* @summary Search
|
|
1820
|
-
* @request GET:/research/actions/search
|
|
1777
|
+
* @tags Research
|
|
1778
|
+
* @name TopStocks
|
|
1779
|
+
* @summary Top Stocks
|
|
1780
|
+
* @request GET:/quotes/top10/{category}
|
|
1821
1781
|
* @secure
|
|
1822
1782
|
*/
|
|
1823
|
-
|
|
1824
|
-
/**
|
|
1825
|
-
* Old or new symbol (multiple tickers separated by comma)
|
|
1826
|
-
* @example "{symbol}"
|
|
1827
|
-
*/
|
|
1828
|
-
symbol?: any;
|
|
1783
|
+
topStocks(category: string, query?: {
|
|
1829
1784
|
/**
|
|
1830
|
-
*
|
|
1831
|
-
* @example "
|
|
1785
|
+
* See table above
|
|
1786
|
+
* @example "BIG3"
|
|
1832
1787
|
*/
|
|
1833
|
-
|
|
1834
|
-
/** @example "{date}" */
|
|
1835
|
-
dateTo?: any;
|
|
1788
|
+
market?: any;
|
|
1836
1789
|
/**
|
|
1837
|
-
*
|
|
1838
|
-
* @example "
|
|
1790
|
+
* See table above
|
|
1791
|
+
* @example "H"
|
|
1839
1792
|
*/
|
|
1840
|
-
|
|
1793
|
+
order?: any;
|
|
1841
1794
|
/**
|
|
1842
|
-
*
|
|
1843
|
-
* @example "
|
|
1795
|
+
* Optional. Defaults to 10
|
|
1796
|
+
* @example "10"
|
|
1844
1797
|
*/
|
|
1845
|
-
|
|
1798
|
+
count?: any;
|
|
1846
1799
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1847
|
-
}
|
|
1848
|
-
export class ResearchNews<HandleError extends boolean = boolean> {
|
|
1849
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
1850
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
1851
1800
|
/**
|
|
1852
|
-
* @tags Research
|
|
1853
|
-
* @name
|
|
1854
|
-
* @summary
|
|
1855
|
-
* @request GET:/research/
|
|
1801
|
+
* @tags Research
|
|
1802
|
+
* @name CompanyResearch
|
|
1803
|
+
* @summary Company Research
|
|
1804
|
+
* @request GET:/research/{symbol}
|
|
1856
1805
|
* @secure
|
|
1857
1806
|
*/
|
|
1858
|
-
|
|
1859
|
-
|
|
1860
|
-
|
|
1807
|
+
companyResearch(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1808
|
+
/**
|
|
1809
|
+
* @tags Research
|
|
1810
|
+
* @name OptionRatios
|
|
1811
|
+
* @summary Option Ratios
|
|
1812
|
+
* @request GET:/research/option/ratios
|
|
1813
|
+
* @secure
|
|
1814
|
+
*/
|
|
1815
|
+
optionRatios(query?: {
|
|
1861
1816
|
/**
|
|
1862
|
-
*
|
|
1863
|
-
* @example "
|
|
1817
|
+
* Comma separated list of symbols.
|
|
1818
|
+
* @example "AAPL,BABA"
|
|
1864
1819
|
*/
|
|
1865
|
-
|
|
1866
|
-
/** @example "[[-](provider|aggregator):value1,valueN];" */
|
|
1867
|
-
filter?: any;
|
|
1820
|
+
symbols?: any;
|
|
1868
1821
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1869
1822
|
/**
|
|
1870
|
-
* @tags Research
|
|
1871
|
-
* @name
|
|
1872
|
-
* @summary
|
|
1873
|
-
* @request GET:/research/
|
|
1823
|
+
* @tags Research
|
|
1824
|
+
* @name OptionRadar
|
|
1825
|
+
* @summary Option Radar
|
|
1826
|
+
* @request GET:/research/option/radar
|
|
1874
1827
|
* @secure
|
|
1875
1828
|
*/
|
|
1876
|
-
|
|
1829
|
+
optionRadar(query?: {
|
|
1877
1830
|
/**
|
|
1878
|
-
*
|
|
1831
|
+
* See table above. Leaving blank returns an overview of all of them.
|
|
1879
1832
|
* @example ""
|
|
1880
1833
|
*/
|
|
1881
|
-
|
|
1882
|
-
/** Defaults to 20 (optional) */
|
|
1883
|
-
count?: any;
|
|
1834
|
+
filter?: any;
|
|
1884
1835
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1885
1836
|
/**
|
|
1886
|
-
* @tags Research
|
|
1887
|
-
* @name
|
|
1888
|
-
* @summary
|
|
1889
|
-
* @request GET:/research/
|
|
1837
|
+
* @tags Research
|
|
1838
|
+
* @name IndexComponents
|
|
1839
|
+
* @summary Index Components
|
|
1840
|
+
* @request GET:/research/index/components/{index}
|
|
1890
1841
|
* @secure
|
|
1891
1842
|
*/
|
|
1892
|
-
|
|
1893
|
-
/**
|
|
1894
|
-
* Starting point(optional)
|
|
1895
|
-
* @example "0"
|
|
1896
|
-
*/
|
|
1897
|
-
start?: any;
|
|
1843
|
+
indexComponents(index: string, query?: {
|
|
1898
1844
|
/**
|
|
1899
|
-
*
|
|
1900
|
-
* @example "
|
|
1845
|
+
* `true` or `false` to load quotes
|
|
1846
|
+
* @example "true"
|
|
1901
1847
|
*/
|
|
1902
|
-
|
|
1848
|
+
loadQuotes?: any;
|
|
1903
1849
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1904
1850
|
/**
|
|
1905
|
-
* @tags Research
|
|
1906
|
-
* @name
|
|
1907
|
-
* @summary
|
|
1908
|
-
* @request GET:/research/
|
|
1851
|
+
* @tags Research
|
|
1852
|
+
* @name StockUpgrades
|
|
1853
|
+
* @summary Stock Upgrades
|
|
1854
|
+
* @request GET:/research/upgrades
|
|
1909
1855
|
* @secure
|
|
1910
1856
|
*/
|
|
1911
|
-
|
|
1912
|
-
|
|
1913
|
-
|
|
1914
|
-
|
|
1915
|
-
|
|
1857
|
+
stockUpgrades(query?: {
|
|
1858
|
+
/**
|
|
1859
|
+
* Comma separated list of symbols
|
|
1860
|
+
* @example "AAPL"
|
|
1861
|
+
*/
|
|
1862
|
+
symbols?: any;
|
|
1863
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1916
1864
|
/**
|
|
1917
|
-
* @tags Research
|
|
1918
|
-
* @name
|
|
1919
|
-
* @summary
|
|
1920
|
-
* @request GET:/
|
|
1865
|
+
* @tags Research
|
|
1866
|
+
* @name OwnershipDetails
|
|
1867
|
+
* @summary Ownership Details
|
|
1868
|
+
* @request GET:/research/ownerships/details
|
|
1921
1869
|
* @secure
|
|
1922
1870
|
*/
|
|
1923
|
-
|
|
1871
|
+
ownershipDetails(query?: {
|
|
1924
1872
|
/**
|
|
1925
|
-
*
|
|
1926
|
-
* @example "
|
|
1873
|
+
* Comma separated list of tickers
|
|
1874
|
+
* @example "MSFT,GOOG"
|
|
1927
1875
|
*/
|
|
1928
|
-
|
|
1929
|
-
/**
|
|
1930
|
-
* Comma seperated list of symbols
|
|
1931
|
-
* @example "AAPL,GOOG"
|
|
1932
|
-
*/
|
|
1933
|
-
symbols?: any;
|
|
1934
|
-
/**
|
|
1935
|
-
* Format: [num][y/m] (y – year, m – months). `num` specifies number of (y/m) back from current date. If range is not provided it defaults to 1 year.
|
|
1936
|
-
* @example "2y"
|
|
1937
|
-
*/
|
|
1938
|
-
range?: any;
|
|
1939
|
-
/**
|
|
1940
|
-
* A number between 4-10 can be selected for the period. Defaults to 4
|
|
1941
|
-
* @example "180"
|
|
1942
|
-
*/
|
|
1943
|
-
period?: any;
|
|
1944
|
-
/**
|
|
1945
|
-
* Set `true` or `false` to enable exponential moving average. Optional. Defaults to false.
|
|
1946
|
-
* @example "true"
|
|
1947
|
-
*/
|
|
1948
|
-
setEMA?: any;
|
|
1949
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1950
|
-
/**
|
|
1951
|
-
* @tags Research Alpha Tools
|
|
1952
|
-
* @name Seasonality
|
|
1953
|
-
* @summary Seasonality
|
|
1954
|
-
* @request GET:/quotes/seasonality
|
|
1955
|
-
* @secure
|
|
1956
|
-
*/
|
|
1957
|
-
seasonality(query?: {
|
|
1958
|
-
/**
|
|
1959
|
-
* Comma separated list of symbols
|
|
1960
|
-
* @example "AAPL,IBM,GOOG,TSLA"
|
|
1961
|
-
*/
|
|
1962
|
-
symbols?: any;
|
|
1963
|
-
/**
|
|
1964
|
-
* The benchmark to compare the list of symbols to
|
|
1965
|
-
* @example "SPY"
|
|
1966
|
-
*/
|
|
1967
|
-
benchmark?: any;
|
|
1968
|
-
/**
|
|
1969
|
-
* Defaults to 10. Cannot be less than 3.
|
|
1970
|
-
* @example "5"
|
|
1971
|
-
*/
|
|
1972
|
-
years?: any;
|
|
1973
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1974
|
-
/**
|
|
1975
|
-
* @tags Research Alpha Tools
|
|
1976
|
-
* @name WeeklySeasonality
|
|
1977
|
-
* @summary Weekly Seasonality
|
|
1978
|
-
* @request GET:/quotes/seasonality/weekly
|
|
1979
|
-
* @secure
|
|
1980
|
-
*/
|
|
1981
|
-
weeklySeasonality(query?: {
|
|
1982
|
-
/**
|
|
1983
|
-
* Comma separated list of symbols
|
|
1984
|
-
* @example "AAPL,IBM,GOOG,TSLA"
|
|
1985
|
-
*/
|
|
1986
|
-
symbols?: any;
|
|
1987
|
-
/**
|
|
1988
|
-
* The benchmark to compare the list of symbols to
|
|
1989
|
-
* @example "SPY"
|
|
1990
|
-
*/
|
|
1991
|
-
benchmark?: any;
|
|
1992
|
-
/**
|
|
1993
|
-
* Defaults to 10. Cannot be less than 3.
|
|
1994
|
-
* @example "5"
|
|
1995
|
-
*/
|
|
1996
|
-
years?: any;
|
|
1997
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1998
|
-
}
|
|
1999
|
-
export class ResearchIpos<HandleError extends boolean = boolean> {
|
|
2000
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2001
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2002
|
-
/**
|
|
2003
|
-
* @tags Research Ipos
|
|
2004
|
-
* @name Recent
|
|
2005
|
-
* @summary Recent
|
|
2006
|
-
* @request GET:/research/ipo/recent
|
|
2007
|
-
* @secure
|
|
2008
|
-
*/
|
|
2009
|
-
recent(query?: {
|
|
2010
|
-
/**
|
|
2011
|
-
* `true` or `false` to load quotes
|
|
2012
|
-
* @example ""
|
|
2013
|
-
*/
|
|
2014
|
-
loadQuotes?: any;
|
|
2015
|
-
/** 1m, 3m*, 6m, 1y */
|
|
2016
|
-
time?: any;
|
|
2017
|
-
/** symbol, ipoDate, offerPx, shares, day1Ret, ipoRet, last, change, offerSz */
|
|
2018
|
-
sort?: any;
|
|
2019
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2020
|
-
/**
|
|
2021
|
-
* @tags Research Ipos
|
|
2022
|
-
* @name Upcoming
|
|
2023
|
-
* @summary Upcoming
|
|
2024
|
-
* @request GET:/research/ipo/upcoming
|
|
2025
|
-
* @secure
|
|
2026
|
-
*/
|
|
2027
|
-
upcoming(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2028
|
-
/**
|
|
2029
|
-
* @tags Research Ipos
|
|
2030
|
-
* @name Performance
|
|
2031
|
-
* @summary Performance
|
|
2032
|
-
* @request GET:/research/ipo/performance
|
|
2033
|
-
* @secure
|
|
2034
|
-
*/
|
|
2035
|
-
performance(query?: {
|
|
2036
|
-
/**
|
|
2037
|
-
* `true` or `false` to load quotes
|
|
2038
|
-
* @example "false"
|
|
2039
|
-
*/
|
|
2040
|
-
loadQuotes?: any;
|
|
2041
|
-
/**
|
|
2042
|
-
* 1m, 3m*, 6m, 1y
|
|
2043
|
-
* @example "1m"
|
|
2044
|
-
*/
|
|
2045
|
-
time?: any;
|
|
2046
|
-
/**
|
|
2047
|
-
* shares, day1Ret, ipoRet, last, change, offerSz
|
|
2048
|
-
* @example "day1Ret"
|
|
2049
|
-
*/
|
|
2050
|
-
sort?: any;
|
|
2051
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2052
|
-
}
|
|
2053
|
-
export class Research<HandleError extends boolean = boolean> {
|
|
2054
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2055
|
-
tipranks: ResearchTipranks<HandleError>;
|
|
2056
|
-
etfs: ResearchEtfs<HandleError>;
|
|
2057
|
-
adrs: ResearchAdrs<HandleError>;
|
|
2058
|
-
corporateActions: ResearchCorporateActions<HandleError>;
|
|
2059
|
-
news: ResearchNews<HandleError>;
|
|
2060
|
-
alphaTools: ResearchAlphaTools<HandleError>;
|
|
2061
|
-
ipos: ResearchIpos<HandleError>;
|
|
2062
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2063
|
-
/**
|
|
2064
|
-
* @tags Research
|
|
2065
|
-
* @name TopStocks
|
|
2066
|
-
* @summary Top Stocks
|
|
2067
|
-
* @request GET:/quotes/top10/{category}
|
|
2068
|
-
* @secure
|
|
2069
|
-
*/
|
|
2070
|
-
topStocks(category: string, query?: {
|
|
2071
|
-
/**
|
|
2072
|
-
* See table above
|
|
2073
|
-
* @example "BIG3"
|
|
2074
|
-
*/
|
|
2075
|
-
market?: any;
|
|
2076
|
-
/**
|
|
2077
|
-
* See table above
|
|
2078
|
-
* @example "H"
|
|
2079
|
-
*/
|
|
2080
|
-
order?: any;
|
|
2081
|
-
/**
|
|
2082
|
-
* Optional. Defaults to 10
|
|
2083
|
-
* @example "10"
|
|
2084
|
-
*/
|
|
2085
|
-
count?: any;
|
|
2086
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2087
|
-
/**
|
|
2088
|
-
* @tags Research
|
|
2089
|
-
* @name CompanyResearch
|
|
2090
|
-
* @summary Company Research
|
|
2091
|
-
* @request GET:/research/{symbol}
|
|
2092
|
-
* @secure
|
|
2093
|
-
*/
|
|
2094
|
-
companyResearch(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2095
|
-
/**
|
|
2096
|
-
* @tags Research
|
|
2097
|
-
* @name OptionRatios
|
|
2098
|
-
* @summary Option Ratios
|
|
2099
|
-
* @request GET:/research/option/ratios
|
|
2100
|
-
* @secure
|
|
2101
|
-
*/
|
|
2102
|
-
optionRatios(query?: {
|
|
2103
|
-
/**
|
|
2104
|
-
* Comma separated list of symbols.
|
|
2105
|
-
* @example "AAPL,BABA"
|
|
2106
|
-
*/
|
|
2107
|
-
symbols?: any;
|
|
2108
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2109
|
-
/**
|
|
2110
|
-
* @tags Research
|
|
2111
|
-
* @name OptionRadar
|
|
2112
|
-
* @summary Option Radar
|
|
2113
|
-
* @request GET:/research/option/radar
|
|
2114
|
-
* @secure
|
|
2115
|
-
*/
|
|
2116
|
-
optionRadar(query?: {
|
|
2117
|
-
/**
|
|
2118
|
-
* See table above. Leaving blank returns an overview of all of them.
|
|
2119
|
-
* @example ""
|
|
2120
|
-
*/
|
|
2121
|
-
filter?: any;
|
|
2122
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2123
|
-
/**
|
|
2124
|
-
* @tags Research
|
|
2125
|
-
* @name IndexComponents
|
|
2126
|
-
* @summary Index Components
|
|
2127
|
-
* @request GET:/research/index/components/{index}
|
|
2128
|
-
* @secure
|
|
2129
|
-
*/
|
|
2130
|
-
indexComponents(index: string, query?: {
|
|
2131
|
-
/**
|
|
2132
|
-
* `true` or `false` to load quotes
|
|
2133
|
-
* @example "true"
|
|
2134
|
-
*/
|
|
2135
|
-
loadQuotes?: any;
|
|
2136
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2137
|
-
/**
|
|
2138
|
-
* @tags Research
|
|
2139
|
-
* @name StockUpgrades
|
|
2140
|
-
* @summary Stock Upgrades
|
|
2141
|
-
* @request GET:/research/upgrades
|
|
2142
|
-
* @secure
|
|
2143
|
-
*/
|
|
2144
|
-
stockUpgrades(query?: {
|
|
2145
|
-
/**
|
|
2146
|
-
* Comma separated list of symbols
|
|
2147
|
-
* @example "AAPL"
|
|
2148
|
-
*/
|
|
2149
|
-
symbols?: any;
|
|
2150
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2151
|
-
/**
|
|
2152
|
-
* @tags Research
|
|
2153
|
-
* @name OwnershipDetails
|
|
2154
|
-
* @summary Ownership Details
|
|
2155
|
-
* @request GET:/research/ownerships/details
|
|
2156
|
-
* @secure
|
|
2157
|
-
*/
|
|
2158
|
-
ownershipDetails(query?: {
|
|
2159
|
-
/**
|
|
2160
|
-
* Comma separated list of tickers
|
|
2161
|
-
* @example "MSFT,GOOG"
|
|
2162
|
-
*/
|
|
2163
|
-
symbols?: any;
|
|
1876
|
+
symbols?: any;
|
|
2164
1877
|
/**
|
|
2165
1878
|
* One of `ALL`, `INSTITUTIONAL`, `FUND`, `INSIDER`
|
|
2166
1879
|
* @example "ALL"
|
|
@@ -2322,140 +2035,427 @@ export class Research<HandleError extends boolean = boolean> {
|
|
|
2322
2035
|
dates?: any;
|
|
2323
2036
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2324
2037
|
}
|
|
2325
|
-
export class
|
|
2038
|
+
export class Quotes<HandleError extends boolean = boolean> {
|
|
2326
2039
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2327
2040
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2328
2041
|
/**
|
|
2329
|
-
* @tags
|
|
2330
|
-
* @name
|
|
2331
|
-
* @summary
|
|
2332
|
-
* @request GET:/
|
|
2042
|
+
* @tags Quotes
|
|
2043
|
+
* @name Equity
|
|
2044
|
+
* @summary Equity
|
|
2045
|
+
* @request GET:/quotes/equity
|
|
2333
2046
|
* @secure
|
|
2334
2047
|
*/
|
|
2335
|
-
|
|
2048
|
+
equity(query?: {
|
|
2049
|
+
/**
|
|
2050
|
+
* Comma separated list of symbols
|
|
2051
|
+
* @example "IBM"
|
|
2052
|
+
*/
|
|
2053
|
+
symbols?: any;
|
|
2054
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2336
2055
|
/**
|
|
2337
|
-
* @tags
|
|
2338
|
-
* @name
|
|
2339
|
-
* @summary
|
|
2340
|
-
* @request GET:/
|
|
2056
|
+
* @tags Quotes
|
|
2057
|
+
* @name Search
|
|
2058
|
+
* @summary Search
|
|
2059
|
+
* @request GET:/quotes/search
|
|
2341
2060
|
* @secure
|
|
2342
2061
|
*/
|
|
2343
|
-
|
|
2062
|
+
search(query?: {
|
|
2063
|
+
/**
|
|
2064
|
+
* String to search for
|
|
2065
|
+
* @example "Apple"
|
|
2066
|
+
*/
|
|
2067
|
+
criteria?: any;
|
|
2068
|
+
/**
|
|
2069
|
+
* Maximum number of results to return (default is 20)
|
|
2070
|
+
* @example "3"
|
|
2071
|
+
*/
|
|
2072
|
+
limit?: any;
|
|
2073
|
+
/**
|
|
2074
|
+
* Whether to load quotes for the results or not
|
|
2075
|
+
* @example "false"
|
|
2076
|
+
*/
|
|
2077
|
+
loadQuotes?: any;
|
|
2078
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2344
2079
|
/**
|
|
2345
|
-
* @tags
|
|
2346
|
-
* @name
|
|
2347
|
-
* @summary
|
|
2348
|
-
* @request GET:/
|
|
2080
|
+
* @tags Quotes
|
|
2081
|
+
* @name Option
|
|
2082
|
+
* @summary Option
|
|
2083
|
+
* @request GET:/quotes/option
|
|
2349
2084
|
* @secure
|
|
2350
2085
|
*/
|
|
2351
|
-
|
|
2086
|
+
option(query?: {
|
|
2087
|
+
/** Comma separated list of symbols */
|
|
2088
|
+
symbols?: any;
|
|
2089
|
+
/**
|
|
2090
|
+
* `true|false` - whether to load option greeks
|
|
2091
|
+
* @example ""
|
|
2092
|
+
*/
|
|
2093
|
+
greeks?: any;
|
|
2094
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2352
2095
|
/**
|
|
2353
|
-
* @tags
|
|
2354
|
-
* @name
|
|
2355
|
-
* @summary
|
|
2356
|
-
* @request
|
|
2096
|
+
* @tags Quotes
|
|
2097
|
+
* @name OptionPricingType
|
|
2098
|
+
* @summary Option pricing type
|
|
2099
|
+
* @request GET:/quotes/option/pricing/type
|
|
2357
2100
|
* @secure
|
|
2358
2101
|
*/
|
|
2359
|
-
|
|
2102
|
+
optionPricingType(query?: {
|
|
2103
|
+
/**
|
|
2104
|
+
* [optional]
|
|
2105
|
+
* @example "MSFT"
|
|
2106
|
+
*/
|
|
2107
|
+
underlying?: any;
|
|
2108
|
+
/**
|
|
2109
|
+
* [optional]
|
|
2110
|
+
* @example "F 130927C00014500"
|
|
2111
|
+
*/
|
|
2112
|
+
symbol?: any;
|
|
2113
|
+
/**
|
|
2114
|
+
* [optional]
|
|
2115
|
+
* @example "1.23"
|
|
2116
|
+
*/
|
|
2117
|
+
expectedPx?: any;
|
|
2118
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2360
2119
|
/**
|
|
2361
|
-
* @tags
|
|
2362
|
-
* @name
|
|
2363
|
-
* @summary
|
|
2364
|
-
* @request
|
|
2120
|
+
* @tags Quotes
|
|
2121
|
+
* @name Bonds
|
|
2122
|
+
* @summary Bonds
|
|
2123
|
+
* @request GET:/quotes/bonds
|
|
2365
2124
|
* @secure
|
|
2366
2125
|
*/
|
|
2367
|
-
|
|
2126
|
+
bonds(query?: {
|
|
2127
|
+
/**
|
|
2128
|
+
* Comma separated list of ISINs
|
|
2129
|
+
* @example "SK4120012691"
|
|
2130
|
+
*/
|
|
2131
|
+
isin?: any;
|
|
2132
|
+
/**
|
|
2133
|
+
* Comma separated list of CUSIPs
|
|
2134
|
+
* @example "412001269"
|
|
2135
|
+
*/
|
|
2136
|
+
cusip?: any;
|
|
2137
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2368
2138
|
/**
|
|
2369
|
-
* @tags
|
|
2370
|
-
* @name
|
|
2371
|
-
* @summary
|
|
2372
|
-
* @request GET:/
|
|
2139
|
+
* @tags Quotes
|
|
2140
|
+
* @name BondsSearch
|
|
2141
|
+
* @summary Bonds Search
|
|
2142
|
+
* @request GET:/quotes/bonds/search
|
|
2373
2143
|
* @secure
|
|
2374
2144
|
*/
|
|
2375
|
-
|
|
2145
|
+
bondsSearch(query?: {
|
|
2146
|
+
/** @example "SearchString" */
|
|
2147
|
+
criteria?: any;
|
|
2148
|
+
/** @example "20" */
|
|
2149
|
+
limit?: any;
|
|
2150
|
+
/** @example "false" */
|
|
2151
|
+
loadQuotes?: any;
|
|
2152
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2376
2153
|
/**
|
|
2377
|
-
* @tags
|
|
2378
|
-
* @name
|
|
2379
|
-
* @summary
|
|
2380
|
-
* @request
|
|
2154
|
+
* @tags Quotes
|
|
2155
|
+
* @name Historical
|
|
2156
|
+
* @summary Historical
|
|
2157
|
+
* @request GET:/quotes/equity/historical
|
|
2381
2158
|
* @secure
|
|
2382
2159
|
*/
|
|
2383
|
-
|
|
2384
|
-
|
|
2385
|
-
|
|
2386
|
-
|
|
2387
|
-
|
|
2160
|
+
historical(query?: {
|
|
2161
|
+
/**
|
|
2162
|
+
* Ticker
|
|
2163
|
+
* @example "AAPL"
|
|
2164
|
+
*/
|
|
2165
|
+
symbol?: any;
|
|
2166
|
+
/**
|
|
2167
|
+
* Start date (mm/dd/yyyy)
|
|
2168
|
+
* @example "01/01/2017"
|
|
2169
|
+
*/
|
|
2170
|
+
start?: any;
|
|
2171
|
+
/**
|
|
2172
|
+
* End date (mm/dd/yyyy)
|
|
2173
|
+
* @example "06/01/2017"
|
|
2174
|
+
*/
|
|
2175
|
+
end?: any;
|
|
2176
|
+
/** If `start` and `end` are not specified, then range needs to be given. Format: [num][y/m] (y – year, m – months). `num` specifies number of (y/m) back from current date */
|
|
2177
|
+
range?: any;
|
|
2178
|
+
/** Set `true` to load weekly data points. Defaults to false. */
|
|
2179
|
+
setWeekly?: any;
|
|
2180
|
+
/** Include RSI data by setting a span. Value must be > 0 */
|
|
2181
|
+
rsiSpan?: any;
|
|
2182
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2388
2183
|
/**
|
|
2389
|
-
* @tags
|
|
2390
|
-
* @name
|
|
2391
|
-
* @summary
|
|
2392
|
-
* @request
|
|
2184
|
+
* @tags Quotes
|
|
2185
|
+
* @name IntradayChartData
|
|
2186
|
+
* @summary Intraday chart data
|
|
2187
|
+
* @request GET:/quotes/equity/intraday
|
|
2393
2188
|
* @secure
|
|
2394
2189
|
*/
|
|
2395
|
-
|
|
2396
|
-
|
|
2397
|
-
|
|
2398
|
-
|
|
2399
|
-
|
|
2400
|
-
|
|
2401
|
-
|
|
2402
|
-
|
|
2403
|
-
|
|
2404
|
-
|
|
2405
|
-
|
|
2406
|
-
|
|
2407
|
-
|
|
2408
|
-
|
|
2409
|
-
|
|
2410
|
-
|
|
2411
|
-
|
|
2190
|
+
intradayChartData(query?: {
|
|
2191
|
+
/**
|
|
2192
|
+
* Ticker
|
|
2193
|
+
* @example "IBM"
|
|
2194
|
+
*/
|
|
2195
|
+
symbol?: any;
|
|
2196
|
+
/** Include RSI data by setting a span. Value must be > 0 */
|
|
2197
|
+
rsiSpan?: any;
|
|
2198
|
+
/** `optional` timestamp format for multiday charts */
|
|
2199
|
+
from?: any;
|
|
2200
|
+
/** `optional` timestamp format for multiday charts */
|
|
2201
|
+
to?: any;
|
|
2202
|
+
/**
|
|
2203
|
+
* `optional` whether to adjust volumes or not
|
|
2204
|
+
* @example "false"
|
|
2205
|
+
*/
|
|
2206
|
+
rawVolumes?: any;
|
|
2412
2207
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2413
|
-
}
|
|
2414
|
-
export class UserAttachedBanks<HandleError extends boolean = boolean> {
|
|
2415
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2416
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2417
2208
|
/**
|
|
2418
|
-
* @tags
|
|
2419
|
-
* @name
|
|
2420
|
-
* @summary
|
|
2421
|
-
* @request GET:/
|
|
2209
|
+
* @tags Quotes
|
|
2210
|
+
* @name EquityTicks
|
|
2211
|
+
* @summary Equity Ticks
|
|
2212
|
+
* @request GET:/quotes/equity/ticks
|
|
2422
2213
|
* @secure
|
|
2423
2214
|
*/
|
|
2424
|
-
|
|
2215
|
+
equityTicks(query?: {
|
|
2425
2216
|
/**
|
|
2426
|
-
*
|
|
2427
|
-
* @example "
|
|
2217
|
+
* Ticker
|
|
2218
|
+
* @example "GOOG"
|
|
2428
2219
|
*/
|
|
2429
|
-
|
|
2220
|
+
symbol?: any;
|
|
2221
|
+
/**
|
|
2222
|
+
* Timestamp for start of the data. Format: MM/DD/YYYY HH:MM or MM/DD/YYYY
|
|
2223
|
+
* @example "11/27/2016"
|
|
2224
|
+
*/
|
|
2225
|
+
startTime?: any;
|
|
2226
|
+
/**
|
|
2227
|
+
* Timestamp for end of the data. Format: MM/DD/YYYY HH:MM or MM/DD/YYYY
|
|
2228
|
+
* @example "11/28/2016"
|
|
2229
|
+
*/
|
|
2230
|
+
endTime?: any;
|
|
2430
2231
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2431
2232
|
/**
|
|
2432
|
-
* @tags
|
|
2433
|
-
* @name
|
|
2434
|
-
* @summary
|
|
2435
|
-
* @request GET:/
|
|
2233
|
+
* @tags Quotes
|
|
2234
|
+
* @name Shortability
|
|
2235
|
+
* @summary Shortability
|
|
2236
|
+
* @request GET:/quotes/equity/shortability/{symbol}
|
|
2436
2237
|
* @secure
|
|
2437
2238
|
*/
|
|
2438
|
-
|
|
2239
|
+
shortability(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2240
|
+
/**
|
|
2241
|
+
* @tags Quotes
|
|
2242
|
+
* @name MarginSuitability
|
|
2243
|
+
* @summary Margin Suitability
|
|
2244
|
+
* @request GET:/quotes/equity/marginability
|
|
2245
|
+
* @secure
|
|
2246
|
+
*/
|
|
2247
|
+
marginSuitability(query?: {
|
|
2439
2248
|
/**
|
|
2440
|
-
*
|
|
2441
|
-
* @example "
|
|
2249
|
+
* Equity ticker
|
|
2250
|
+
* @example "TSLA"
|
|
2251
|
+
*/
|
|
2252
|
+
symbol?: any;
|
|
2253
|
+
/**
|
|
2254
|
+
* Account number requesting the information
|
|
2255
|
+
* @example "AB654321"
|
|
2442
2256
|
*/
|
|
2443
2257
|
account?: any;
|
|
2258
|
+
accountId?: any;
|
|
2444
2259
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2445
|
-
}
|
|
2446
|
-
export class UserProfitLoss<HandleError extends boolean = boolean> {
|
|
2447
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2448
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2449
2260
|
/**
|
|
2450
|
-
* @tags
|
|
2451
|
-
* @name
|
|
2452
|
-
* @summary
|
|
2453
|
-
* @request
|
|
2261
|
+
* @tags Quotes
|
|
2262
|
+
* @name OptionChainDates
|
|
2263
|
+
* @summary Option chain (dates)
|
|
2264
|
+
* @request GET:/quotes/option/chain/dates/{symbol}
|
|
2454
2265
|
* @secure
|
|
2455
2266
|
*/
|
|
2456
|
-
|
|
2457
|
-
/**
|
|
2458
|
-
|
|
2267
|
+
optionChainDates(symbol: string, query?: {
|
|
2268
|
+
/**
|
|
2269
|
+
* Comma separated list of symbols
|
|
2270
|
+
* @example "AAPL"
|
|
2271
|
+
*/
|
|
2272
|
+
symbols?: any;
|
|
2273
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2274
|
+
/**
|
|
2275
|
+
* @tags Quotes
|
|
2276
|
+
* @name OptionChain
|
|
2277
|
+
* @summary Option chain
|
|
2278
|
+
* @request GET:/quotes/option/chain/{symbol}/{date}
|
|
2279
|
+
* @secure
|
|
2280
|
+
*/
|
|
2281
|
+
optionChain(symbol: string, date: string, query?: {
|
|
2282
|
+
/**
|
|
2283
|
+
* Comma separated list of symbols
|
|
2284
|
+
* @example "AAPL"
|
|
2285
|
+
*/
|
|
2286
|
+
symbols?: any;
|
|
2287
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2288
|
+
/**
|
|
2289
|
+
* @tags Quotes
|
|
2290
|
+
* @name OptionChainGreeks
|
|
2291
|
+
* @summary Option chain (greeks)
|
|
2292
|
+
* @request GET:/quotes/option/greeks/{symbol}/{date}
|
|
2293
|
+
* @secure
|
|
2294
|
+
*/
|
|
2295
|
+
optionChainGreeks(symbol: string, date: string, query?: {
|
|
2296
|
+
/**
|
|
2297
|
+
* Comma separated list of symbols
|
|
2298
|
+
* @example "AAPL"
|
|
2299
|
+
*/
|
|
2300
|
+
symbols?: any;
|
|
2301
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2302
|
+
/**
|
|
2303
|
+
* @tags Quotes
|
|
2304
|
+
* @name Crypto
|
|
2305
|
+
* @summary Crypto
|
|
2306
|
+
* @request GET:/quotes/crypto
|
|
2307
|
+
* @secure
|
|
2308
|
+
*/
|
|
2309
|
+
crypto(query?: {
|
|
2310
|
+
/** @example "" */
|
|
2311
|
+
symbols?: any;
|
|
2312
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2313
|
+
/**
|
|
2314
|
+
* @tags Quotes
|
|
2315
|
+
* @name FxRate
|
|
2316
|
+
* @summary FX rate
|
|
2317
|
+
* @request GET:/quotes/fx
|
|
2318
|
+
* @secure
|
|
2319
|
+
*/
|
|
2320
|
+
fxRate(query?: {
|
|
2321
|
+
/** @example "EUR/USD,GBP/USD" */
|
|
2322
|
+
symbols?: any;
|
|
2323
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2324
|
+
}
|
|
2325
|
+
export class UserAgreements<HandleError extends boolean = boolean> {
|
|
2326
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2327
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2328
|
+
/**
|
|
2329
|
+
* @tags User Agreements
|
|
2330
|
+
* @name Available
|
|
2331
|
+
* @summary Available
|
|
2332
|
+
* @request GET:/user/agreements/all/active
|
|
2333
|
+
* @secure
|
|
2334
|
+
*/
|
|
2335
|
+
available(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2336
|
+
/**
|
|
2337
|
+
* @tags User Agreements
|
|
2338
|
+
* @name Agreement
|
|
2339
|
+
* @summary Agreement
|
|
2340
|
+
* @request GET:/user/agreements/contents/{version}/{code}/body.html
|
|
2341
|
+
* @secure
|
|
2342
|
+
*/
|
|
2343
|
+
agreement(version: string, code: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2344
|
+
/**
|
|
2345
|
+
* @tags User Agreements
|
|
2346
|
+
* @name Unsigned
|
|
2347
|
+
* @summary Unsigned
|
|
2348
|
+
* @request GET:/user/agreements/unsigned
|
|
2349
|
+
* @secure
|
|
2350
|
+
*/
|
|
2351
|
+
unsigned(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2352
|
+
/**
|
|
2353
|
+
* @tags User Agreements
|
|
2354
|
+
* @name AttestStatus
|
|
2355
|
+
* @summary Attest status
|
|
2356
|
+
* @request POST:/user/professional/attest
|
|
2357
|
+
* @secure
|
|
2358
|
+
*/
|
|
2359
|
+
attestStatus(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2360
|
+
/**
|
|
2361
|
+
* @tags User Agreements
|
|
2362
|
+
* @name Sign
|
|
2363
|
+
* @summary Sign
|
|
2364
|
+
* @request POST:/user/agreements/sign
|
|
2365
|
+
* @secure
|
|
2366
|
+
*/
|
|
2367
|
+
sign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2368
|
+
/**
|
|
2369
|
+
* @tags User Agreements
|
|
2370
|
+
* @name CryptoAgreement
|
|
2371
|
+
* @summary Crypto Agreement
|
|
2372
|
+
* @request GET:/user/agreements/crypto/Agreement
|
|
2373
|
+
* @secure
|
|
2374
|
+
*/
|
|
2375
|
+
cryptoAgreement(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2376
|
+
/**
|
|
2377
|
+
* @tags User Agreements
|
|
2378
|
+
* @name CryptoSign
|
|
2379
|
+
* @summary Crypto Sign
|
|
2380
|
+
* @request POST:/user/agreements/crypto/sign
|
|
2381
|
+
* @secure
|
|
2382
|
+
*/
|
|
2383
|
+
cryptoSign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2384
|
+
}
|
|
2385
|
+
export class UserTradingLimitManagement<HandleError extends boolean = boolean> {
|
|
2386
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2387
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2388
|
+
/**
|
|
2389
|
+
* @tags User Trading Limit Management
|
|
2390
|
+
* @name Update
|
|
2391
|
+
* @summary Update
|
|
2392
|
+
* @request POST:/user/balance/adjust
|
|
2393
|
+
* @secure
|
|
2394
|
+
*/
|
|
2395
|
+
update(data: {
|
|
2396
|
+
account?: {
|
|
2397
|
+
/** @example "AB123456" */
|
|
2398
|
+
accountNumber?: string;
|
|
2399
|
+
};
|
|
2400
|
+
/** @example 100 */
|
|
2401
|
+
adjustment?: any;
|
|
2402
|
+
/** @example "USD" */
|
|
2403
|
+
currency?: any;
|
|
2404
|
+
/** @example "something nice" */
|
|
2405
|
+
note?: any;
|
|
2406
|
+
/** @example "tbd" */
|
|
2407
|
+
reason?: any;
|
|
2408
|
+
/** @example "" */
|
|
2409
|
+
referenceNo?: any;
|
|
2410
|
+
/** @example "Delta|Absolute" */
|
|
2411
|
+
type?: any;
|
|
2412
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2413
|
+
}
|
|
2414
|
+
export class UserAttachedBanks<HandleError extends boolean = boolean> {
|
|
2415
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2416
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2417
|
+
/**
|
|
2418
|
+
* @tags User Attached Banks
|
|
2419
|
+
* @name Accounts
|
|
2420
|
+
* @summary Accounts
|
|
2421
|
+
* @request GET:/user/bank/accounts
|
|
2422
|
+
* @secure
|
|
2423
|
+
*/
|
|
2424
|
+
accounts(query?: {
|
|
2425
|
+
/**
|
|
2426
|
+
* Brokerage account number
|
|
2427
|
+
* @example "AC123456"
|
|
2428
|
+
*/
|
|
2429
|
+
account?: any;
|
|
2430
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2431
|
+
/**
|
|
2432
|
+
* @tags User Attached Banks
|
|
2433
|
+
* @name Balances
|
|
2434
|
+
* @summary Balances
|
|
2435
|
+
* @request GET:/user/bank/balances
|
|
2436
|
+
* @secure
|
|
2437
|
+
*/
|
|
2438
|
+
balances(query?: {
|
|
2439
|
+
/**
|
|
2440
|
+
* Brokerage account number
|
|
2441
|
+
* @example "AC123456"
|
|
2442
|
+
*/
|
|
2443
|
+
account?: any;
|
|
2444
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2445
|
+
}
|
|
2446
|
+
export class UserProfitLoss<HandleError extends boolean = boolean> {
|
|
2447
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2448
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2449
|
+
/**
|
|
2450
|
+
* @tags User Profit Loss
|
|
2451
|
+
* @name ReportRequest
|
|
2452
|
+
* @summary Report Request
|
|
2453
|
+
* @request POST:/user/pal/submit
|
|
2454
|
+
* @secure
|
|
2455
|
+
*/
|
|
2456
|
+
reportRequest(data: {
|
|
2457
|
+
/** @example "{account number}" */
|
|
2458
|
+
account?: any;
|
|
2459
2459
|
/** @example "{timestamp}" */
|
|
2460
2460
|
from?: any;
|
|
2461
2461
|
/** @example "{timestamp}" */
|
|
@@ -3721,24 +3721,6 @@ export class AdvisoryAnalytics<HandleError extends boolean = boolean> {
|
|
|
3721
3721
|
threshold?: any;
|
|
3722
3722
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3723
3723
|
}
|
|
3724
|
-
export class Device<HandleError extends boolean = boolean> {
|
|
3725
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3726
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3727
|
-
/**
|
|
3728
|
-
* @tags Device
|
|
3729
|
-
* @name DeviceDeactivate
|
|
3730
|
-
* @summary /device/deactivate
|
|
3731
|
-
* @request POST:/device/deactivate
|
|
3732
|
-
* @secure
|
|
3733
|
-
*/
|
|
3734
|
-
deviceDeactivate(data: {
|
|
3735
|
-
/**
|
|
3736
|
-
* Token previously registered
|
|
3737
|
-
* @example "123456789"
|
|
3738
|
-
*/
|
|
3739
|
-
Token?: string;
|
|
3740
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3741
|
-
}
|
|
3742
3724
|
export class AdvisoryAllocations<HandleError extends boolean = boolean> {
|
|
3743
3725
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3744
3726
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -3791,6 +3773,24 @@ export class AdvisoryAllocations<HandleError extends boolean = boolean> {
|
|
|
3791
3773
|
*/
|
|
3792
3774
|
trigger(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3793
3775
|
}
|
|
3776
|
+
export class Device<HandleError extends boolean = boolean> {
|
|
3777
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3778
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3779
|
+
/**
|
|
3780
|
+
* @tags Device
|
|
3781
|
+
* @name DeviceDeactivate
|
|
3782
|
+
* @summary /device/deactivate
|
|
3783
|
+
* @request POST:/device/deactivate
|
|
3784
|
+
* @secure
|
|
3785
|
+
*/
|
|
3786
|
+
deviceDeactivate(data: {
|
|
3787
|
+
/**
|
|
3788
|
+
* Token previously registered
|
|
3789
|
+
* @example "123456789"
|
|
3790
|
+
*/
|
|
3791
|
+
Token?: string;
|
|
3792
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3793
|
+
}
|
|
3794
3794
|
export class TransfersRelationships<HandleError extends boolean = boolean> {
|
|
3795
3795
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3796
3796
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4535,284 +4535,50 @@ export class TransfersInstantCashTransfers<HandleError extends boolean = boolean
|
|
|
4535
4535
|
accountNumber?: string;
|
|
4536
4536
|
/** @example "Royal Central Bank" */
|
|
4537
4537
|
name?: string;
|
|
4538
|
-
};
|
|
4539
|
-
/** @example "Bond" */
|
|
4540
|
-
lastName?: string;
|
|
4541
|
-
};
|
|
4542
|
-
/** @example "USD" */
|
|
4543
|
-
currency?: any;
|
|
4544
|
-
/** @example "1.1.1.1" */
|
|
4545
|
-
remoteAddr?: any;
|
|
4546
|
-
/** @example "Droid Phone" */
|
|
4547
|
-
remoteDevice?: any;
|
|
4548
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4549
|
-
/**
|
|
4550
|
-
* @tags Transfers Instant Cash Transfers
|
|
4551
|
-
* @name ObtainTheReport
|
|
4552
|
-
* @summary Obtain the report
|
|
4553
|
-
* @request POST:/transfer/reports/obtain
|
|
4554
|
-
* @secure
|
|
4555
|
-
*/
|
|
4556
|
-
obtainTheReport(data: {
|
|
4557
|
-
/** @example "MM/DD/YYYY HH:MM:SS ZZZ" */
|
|
4558
|
-
date?: any;
|
|
4559
|
-
/** @example "RETAIL_BANKING" */
|
|
4560
|
-
reportType?: any;
|
|
4561
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4562
|
-
/**
|
|
4563
|
-
* @tags Transfers Instant Cash Transfers
|
|
4564
|
-
* @name ListReports
|
|
4565
|
-
* @summary List reports
|
|
4566
|
-
* @request GET:/transfer/reports
|
|
4567
|
-
* @secure
|
|
4568
|
-
*/
|
|
4569
|
-
listReports(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4570
|
-
}
|
|
4571
|
-
export class TransfersCheques<HandleError extends boolean = boolean> {
|
|
4572
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4573
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4574
|
-
/**
|
|
4575
|
-
* @tags Transfers Cheques
|
|
4576
|
-
* @name Withdrawal
|
|
4577
|
-
* @summary Withdrawal
|
|
4578
|
-
* @request POST:/transfer/check/outgoing
|
|
4579
|
-
* @secure
|
|
4580
|
-
*/
|
|
4581
|
-
withdrawal(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4582
|
-
}
|
|
4583
|
-
export class Transfers<HandleError extends boolean = boolean> {
|
|
4584
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4585
|
-
relationships: TransfersRelationships<HandleError>;
|
|
4586
|
-
instantAccountVerification: TransfersInstantAccountVerification<HandleError>;
|
|
4587
|
-
ach: TransfersAch<HandleError>;
|
|
4588
|
-
acats: TransfersAcats<HandleError>;
|
|
4589
|
-
wires: TransfersWires<HandleError>;
|
|
4590
|
-
journals: TransfersJournals<HandleError>;
|
|
4591
|
-
positions: TransfersPositions<HandleError>;
|
|
4592
|
-
bank: TransfersBank<HandleError>;
|
|
4593
|
-
instantCashTransfers: TransfersInstantCashTransfers<HandleError>;
|
|
4594
|
-
cheques: TransfersCheques<HandleError>;
|
|
4595
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4596
|
-
/**
|
|
4597
|
-
* @tags Transfers
|
|
4598
|
-
* @name TransferDetails
|
|
4599
|
-
* @summary Transfer Details
|
|
4600
|
-
* @request GET:/transfer/details/{account}/{transferId}
|
|
4601
|
-
* @secure
|
|
4602
|
-
*/
|
|
4603
|
-
transferDetails(account: string, transferId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4604
|
-
/**
|
|
4605
|
-
* @tags Transfers
|
|
4606
|
-
* @name TransferStatus
|
|
4607
|
-
* @summary Transfer Status
|
|
4608
|
-
* @request GET:/transfer/status/{account}
|
|
4609
|
-
* @secure
|
|
4610
|
-
*/
|
|
4611
|
-
transferStatus(account: string, query?: {
|
|
4612
|
-
/** INCOMING|OUTGOING */
|
|
4613
|
-
direction?: any;
|
|
4614
|
-
/** ACH|WIRE|CHECK|Bank|CustodyJournal|ALL */
|
|
4615
|
-
mechanism?: any;
|
|
4616
|
-
/** MM/DD/YYYY */
|
|
4617
|
-
dateFrom?: any;
|
|
4618
|
-
/** MM/DD/YYYY */
|
|
4619
|
-
dateTo?: any;
|
|
4620
|
-
/** Overrides `dateFrom` and `dateTo`. See description. */
|
|
4621
|
-
range?: any;
|
|
4622
|
-
start?: any;
|
|
4623
|
-
perPage?: any;
|
|
4624
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4625
|
-
/**
|
|
4626
|
-
* @tags Transfers
|
|
4627
|
-
* @name TransferStatusModel
|
|
4628
|
-
* @summary Transfer Status Model
|
|
4629
|
-
* @request GET:/transfer/status/model/{modelId}
|
|
4630
|
-
* @secure
|
|
4631
|
-
*/
|
|
4632
|
-
transferStatusModel(modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4633
|
-
/**
|
|
4634
|
-
* @tags Transfers
|
|
4635
|
-
* @name TransferStatusBranch
|
|
4636
|
-
* @summary Transfer Status Branch
|
|
4637
|
-
* @request GET:/transfer/status/branch
|
|
4638
|
-
* @secure
|
|
4639
|
-
*/
|
|
4640
|
-
transferStatusBranch(query?: {
|
|
4641
|
-
/**
|
|
4642
|
-
* INCOMING|OUTGOING|ALL
|
|
4643
|
-
* @example "ALL"
|
|
4644
|
-
*/
|
|
4645
|
-
direction?: any;
|
|
4646
|
-
/**
|
|
4647
|
-
* ACH|WIRE|CHECK|Bank|CustodyJournal
|
|
4648
|
-
* @example "ALL"
|
|
4649
|
-
*/
|
|
4650
|
-
mechanism?: any;
|
|
4651
|
-
dateFrom?: any;
|
|
4652
|
-
dateTo?: any;
|
|
4653
|
-
/** Per regex: \d+[ymdw]$ (will override `dateFrom` and `dateTo`) */
|
|
4654
|
-
range?: any;
|
|
4655
|
-
start?: any;
|
|
4656
|
-
perPage?: any;
|
|
4657
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4658
|
-
/**
|
|
4659
|
-
* @tags Transfers
|
|
4660
|
-
* @name AmountAvailable
|
|
4661
|
-
* @summary Amount Available
|
|
4662
|
-
* @request GET:/transfer/available/{account}
|
|
4663
|
-
* @secure
|
|
4664
|
-
*/
|
|
4665
|
-
amountAvailable(account: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4666
|
-
/**
|
|
4667
|
-
* @tags Transfers
|
|
4668
|
-
* @name LegalDocumentTypes
|
|
4669
|
-
* @summary Legal document types
|
|
4670
|
-
* @request GET:/transfer/legal/types
|
|
4671
|
-
* @secure
|
|
4672
|
-
*/
|
|
4673
|
-
legalDocumentTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4674
|
-
/**
|
|
4675
|
-
* @tags Transfers
|
|
4676
|
-
* @name LegalDocument
|
|
4677
|
-
* @summary Legal document
|
|
4678
|
-
* @request GET:/transfer/legal/content
|
|
4679
|
-
* @secure
|
|
4680
|
-
*/
|
|
4681
|
-
legalDocument(query?: {
|
|
4682
|
-
/** Unique ID given in the types endpoint */
|
|
4683
|
-
id?: any;
|
|
4684
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4685
|
-
/**
|
|
4686
|
-
* @tags Transfers
|
|
4687
|
-
* @name Cancel
|
|
4688
|
-
* @summary Cancel
|
|
4689
|
-
* @request POST:/transfer/ach/cancel
|
|
4690
|
-
* @secure
|
|
4691
|
-
*/
|
|
4692
|
-
cancel(data: {
|
|
4693
|
-
/** @example "5VA0XXXX" */
|
|
4694
|
-
account?: any;
|
|
4695
|
-
/** @example "0.0.0.0" */
|
|
4696
|
-
remoteAddr?: any;
|
|
4697
|
-
/** @example "ultra fast browser 1.1" */
|
|
4698
|
-
remoteDevice?: any;
|
|
4699
|
-
/** @example "CC123456" */
|
|
4700
|
-
transferId?: any;
|
|
4701
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4702
|
-
/**
|
|
4703
|
-
* @tags Transfers
|
|
4704
|
-
* @name FeesAndCredits
|
|
4705
|
-
* @summary Fees and Credits
|
|
4706
|
-
* @request POST:/transfer/fees/apply
|
|
4707
|
-
* @secure
|
|
4708
|
-
*/
|
|
4709
|
-
feesAndCredits(data: {
|
|
4710
|
-
/** @example "5VA0XXXX" */
|
|
4711
|
-
account?: any;
|
|
4712
|
-
/** @example 100 */
|
|
4713
|
-
amount?: any;
|
|
4714
|
-
/** @example "FeeReversal|Promotion|WriteOff|Rebate|Courtesy|Advisory|Management|Admin|Exchange|Tech|Platform|Inactivity|MarginInterest|Custodian|CryptoGift" */
|
|
4715
|
-
classification?: any;
|
|
4716
|
-
/** @example "" */
|
|
4717
|
-
contraNote?: any;
|
|
4718
|
-
/** @example "USD" */
|
|
4719
|
-
currency?: any;
|
|
4720
|
-
/** @example "" */
|
|
4721
|
-
note?: any;
|
|
4722
|
-
/** @example 0.01 */
|
|
4723
|
-
quantity?: any;
|
|
4724
|
-
/** @example "0.0.0.0" */
|
|
4725
|
-
remoteAddr?: any;
|
|
4726
|
-
/** @example "ultra fast browser 1.1" */
|
|
4727
|
-
remoteDevice?: any;
|
|
4728
|
-
/** @example "BTC/USD" */
|
|
4729
|
-
symbol?: any;
|
|
4730
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4731
|
-
/**
|
|
4732
|
-
* @tags Transfers
|
|
4733
|
-
* @name ListFees
|
|
4734
|
-
* @summary List fees
|
|
4735
|
-
* @request GET:/transfer/fees/classifications/fees
|
|
4736
|
-
* @secure
|
|
4737
|
-
*/
|
|
4738
|
-
listFees(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4739
|
-
/**
|
|
4740
|
-
* @tags Transfers
|
|
4741
|
-
* @name ListCredits
|
|
4742
|
-
* @summary List credits
|
|
4743
|
-
* @request GET:/transfer/fees/classifications/credits
|
|
4744
|
-
* @secure
|
|
4745
|
-
*/
|
|
4746
|
-
listCredits(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4747
|
-
/**
|
|
4748
|
-
* @tags Transfers
|
|
4749
|
-
* @name CryptoDepositAddress
|
|
4750
|
-
* @summary Crypto Deposit Address
|
|
4751
|
-
* @request GET:/transfer/crypto/deposit/wallet/address
|
|
4752
|
-
* @secure
|
|
4753
|
-
*/
|
|
4754
|
-
cryptoDepositAddress(data: {
|
|
4755
|
-
/** @example "AB123456" */
|
|
4756
|
-
account?: any;
|
|
4757
|
-
/** @example "BTC" */
|
|
4758
|
-
currency?: any;
|
|
4759
|
-
/** @example "{optional}" */
|
|
4760
|
-
network?: any;
|
|
4761
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4762
|
-
/**
|
|
4763
|
-
* @tags Transfers
|
|
4764
|
-
* @name CryptoWithdrawalEstimate
|
|
4765
|
-
* @summary Crypto Withdrawal Estimate
|
|
4766
|
-
* @request POST:/transfer/crypto/withdrawal/estimate
|
|
4767
|
-
* @secure
|
|
4768
|
-
*/
|
|
4769
|
-
cryptoWithdrawalEstimate(data: {
|
|
4770
|
-
/** @example "BTC" */
|
|
4771
|
-
currency?: any;
|
|
4772
|
-
/** @example "{optional}" */
|
|
4773
|
-
network?: any;
|
|
4774
|
-
/** @example "0.1" */
|
|
4775
|
-
quantity?: any;
|
|
4776
|
-
/** @example "{optional}" */
|
|
4777
|
-
wallet?: any;
|
|
4778
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4779
|
-
/**
|
|
4780
|
-
* @tags Transfers
|
|
4781
|
-
* @name CryptoWithdrawal
|
|
4782
|
-
* @summary Crypto Withdrawal
|
|
4783
|
-
* @request POST:/transfer/crypto/withdraw
|
|
4784
|
-
* @secure
|
|
4785
|
-
*/
|
|
4786
|
-
cryptoWithdrawal(data: {
|
|
4787
|
-
/** @example "AB123456" */
|
|
4788
|
-
account?: any;
|
|
4789
|
-
/** @example "BTC" */
|
|
4790
|
-
currency?: any;
|
|
4791
|
-
/** @example "{optional}" */
|
|
4792
|
-
estimateExtension?: any;
|
|
4793
|
-
/** @example "abc123" */
|
|
4794
|
-
estimateId?: any;
|
|
4795
|
-
/** @example "{optional}" */
|
|
4796
|
-
network?: any;
|
|
4797
|
-
/** @example 0.1 */
|
|
4798
|
-
quantity?: any;
|
|
4799
|
-
/** @example "{conditional}" */
|
|
4800
|
-
recipientFirstName?: any;
|
|
4801
|
-
/** @example "{conditional}" */
|
|
4802
|
-
recipientLastName?: any;
|
|
4803
|
-
/** @example "{optional} 1.1.1.1" */
|
|
4538
|
+
};
|
|
4539
|
+
/** @example "Bond" */
|
|
4540
|
+
lastName?: string;
|
|
4541
|
+
};
|
|
4542
|
+
/** @example "USD" */
|
|
4543
|
+
currency?: any;
|
|
4544
|
+
/** @example "1.1.1.1" */
|
|
4804
4545
|
remoteAddr?: any;
|
|
4805
|
-
/** @example "
|
|
4546
|
+
/** @example "Droid Phone" */
|
|
4806
4547
|
remoteDevice?: any;
|
|
4807
|
-
/** @example "{optional} true|false" */
|
|
4808
|
-
selfHosted?: any;
|
|
4809
|
-
/** @example "{optional}" */
|
|
4810
|
-
tag?: any;
|
|
4811
|
-
/** @example "{conditional}" */
|
|
4812
|
-
vaspName?: any;
|
|
4813
|
-
/** @example "wallet address" */
|
|
4814
|
-
wallet?: any;
|
|
4815
4548
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4549
|
+
/**
|
|
4550
|
+
* @tags Transfers Instant Cash Transfers
|
|
4551
|
+
* @name ObtainTheReport
|
|
4552
|
+
* @summary Obtain the report
|
|
4553
|
+
* @request POST:/transfer/reports/obtain
|
|
4554
|
+
* @secure
|
|
4555
|
+
*/
|
|
4556
|
+
obtainTheReport(data: {
|
|
4557
|
+
/** @example "MM/DD/YYYY HH:MM:SS ZZZ" */
|
|
4558
|
+
date?: any;
|
|
4559
|
+
/** @example "RETAIL_BANKING" */
|
|
4560
|
+
reportType?: any;
|
|
4561
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4562
|
+
/**
|
|
4563
|
+
* @tags Transfers Instant Cash Transfers
|
|
4564
|
+
* @name ListReports
|
|
4565
|
+
* @summary List reports
|
|
4566
|
+
* @request GET:/transfer/reports
|
|
4567
|
+
* @secure
|
|
4568
|
+
*/
|
|
4569
|
+
listReports(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4570
|
+
}
|
|
4571
|
+
export class TransfersCheques<HandleError extends boolean = boolean> {
|
|
4572
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4573
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4574
|
+
/**
|
|
4575
|
+
* @tags Transfers Cheques
|
|
4576
|
+
* @name Withdrawal
|
|
4577
|
+
* @summary Withdrawal
|
|
4578
|
+
* @request POST:/transfer/check/outgoing
|
|
4579
|
+
* @secure
|
|
4580
|
+
*/
|
|
4581
|
+
withdrawal(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4816
4582
|
}
|
|
4817
4583
|
export class Documents<HandleError extends boolean = boolean> {
|
|
4818
4584
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5248,100 +5014,334 @@ export class LegalDocuments<HandleError extends boolean = boolean> {
|
|
|
5248
5014
|
*/
|
|
5249
5015
|
documentClassifications(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5250
5016
|
/**
|
|
5251
|
-
* @tags Legal Documents
|
|
5252
|
-
* @name DocumentListing
|
|
5253
|
-
* @summary Document listing
|
|
5254
|
-
* @request GET:/user/legal/documents
|
|
5017
|
+
* @tags Legal Documents
|
|
5018
|
+
* @name DocumentListing
|
|
5019
|
+
* @summary Document listing
|
|
5020
|
+
* @request GET:/user/legal/documents
|
|
5021
|
+
* @secure
|
|
5022
|
+
*/
|
|
5023
|
+
documentListing(query?: {
|
|
5024
|
+
/**
|
|
5025
|
+
* {optional}
|
|
5026
|
+
* @example "TermsOfUse"
|
|
5027
|
+
*/
|
|
5028
|
+
classification?: any;
|
|
5029
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5030
|
+
/**
|
|
5031
|
+
* @tags Legal Documents
|
|
5032
|
+
* @name PolicyValues
|
|
5033
|
+
* @summary Policy values
|
|
5034
|
+
* @request GET:/user/legal/policies/listing/{type}
|
|
5035
|
+
* @secure
|
|
5036
|
+
*/
|
|
5037
|
+
policyValues(type: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5038
|
+
/**
|
|
5039
|
+
* @tags Legal Documents
|
|
5040
|
+
* @name DocumentContent
|
|
5041
|
+
* @summary Document content
|
|
5042
|
+
* @request GET:/user/legal/document/content
|
|
5043
|
+
* @secure
|
|
5044
|
+
*/
|
|
5045
|
+
documentContent(query?: {
|
|
5046
|
+
/** @example "{as provided}" */
|
|
5047
|
+
id?: any;
|
|
5048
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5049
|
+
/**
|
|
5050
|
+
* @tags Legal Documents
|
|
5051
|
+
* @name DocumentDownload
|
|
5052
|
+
* @summary Document download
|
|
5053
|
+
* @request GET:/user/legal/document/download
|
|
5054
|
+
* @secure
|
|
5055
|
+
*/
|
|
5056
|
+
documentDownload(query?: {
|
|
5057
|
+
/** @example "{as provided}" */
|
|
5058
|
+
id?: any;
|
|
5059
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5060
|
+
/**
|
|
5061
|
+
* @tags Legal Documents
|
|
5062
|
+
* @name SignTheDocument
|
|
5063
|
+
* @summary Sign the document
|
|
5064
|
+
* @request POST:/user/legal/document/sign
|
|
5065
|
+
* @secure
|
|
5066
|
+
*/
|
|
5067
|
+
signTheDocument(data: {
|
|
5068
|
+
account?: {
|
|
5069
|
+
/** @example 1234 */
|
|
5070
|
+
accountId?: number;
|
|
5071
|
+
/** @example "AC123456" */
|
|
5072
|
+
accountNumber?: string;
|
|
5073
|
+
};
|
|
5074
|
+
data?: {
|
|
5075
|
+
/** @example "{conditional}" */
|
|
5076
|
+
bankAccountNumber?: string;
|
|
5077
|
+
};
|
|
5078
|
+
/** @example "{required}" */
|
|
5079
|
+
documentId?: any;
|
|
5080
|
+
/** @example true */
|
|
5081
|
+
esigned?: any;
|
|
5082
|
+
/** @example "" */
|
|
5083
|
+
remoteAddr?: any;
|
|
5084
|
+
/** @example "{required}" */
|
|
5085
|
+
remoteDevice?: any;
|
|
5086
|
+
/** @example "{required}" */
|
|
5087
|
+
signature?: any;
|
|
5088
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5089
|
+
/**
|
|
5090
|
+
* @tags Legal Documents
|
|
5091
|
+
* @name UpdatesPolicyOnTheAccount
|
|
5092
|
+
* @summary Updates policy on the account
|
|
5093
|
+
* @request POST:/user/legal/policy/{type}
|
|
5094
|
+
* @secure
|
|
5095
|
+
*/
|
|
5096
|
+
updatesPolicyOnTheAccount(type: string, data: {
|
|
5097
|
+
account?: {
|
|
5098
|
+
/** @example 0 */
|
|
5099
|
+
accountId?: number;
|
|
5100
|
+
/** @example "{optional}" */
|
|
5101
|
+
accountNumber?: string;
|
|
5102
|
+
};
|
|
5103
|
+
/** @example true */
|
|
5104
|
+
esigned?: any;
|
|
5105
|
+
/** @example "Allow" */
|
|
5106
|
+
policy?: any;
|
|
5107
|
+
/** @example "" */
|
|
5108
|
+
remoteAddr?: any;
|
|
5109
|
+
/** @example "" */
|
|
5110
|
+
remoteDevice?: any;
|
|
5111
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5112
|
+
}
|
|
5113
|
+
export class Transfers<HandleError extends boolean = boolean> {
|
|
5114
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5115
|
+
relationships: TransfersRelationships<HandleError>;
|
|
5116
|
+
instantAccountVerification: TransfersInstantAccountVerification<HandleError>;
|
|
5117
|
+
ach: TransfersAch<HandleError>;
|
|
5118
|
+
acats: TransfersAcats<HandleError>;
|
|
5119
|
+
wires: TransfersWires<HandleError>;
|
|
5120
|
+
journals: TransfersJournals<HandleError>;
|
|
5121
|
+
positions: TransfersPositions<HandleError>;
|
|
5122
|
+
bank: TransfersBank<HandleError>;
|
|
5123
|
+
instantCashTransfers: TransfersInstantCashTransfers<HandleError>;
|
|
5124
|
+
cheques: TransfersCheques<HandleError>;
|
|
5125
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5126
|
+
/**
|
|
5127
|
+
* @tags Transfers
|
|
5128
|
+
* @name TransferDetails
|
|
5129
|
+
* @summary Transfer Details
|
|
5130
|
+
* @request GET:/transfer/details/{account}/{transferId}
|
|
5131
|
+
* @secure
|
|
5132
|
+
*/
|
|
5133
|
+
transferDetails(account: string, transferId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5134
|
+
/**
|
|
5135
|
+
* @tags Transfers
|
|
5136
|
+
* @name TransferStatus
|
|
5137
|
+
* @summary Transfer Status
|
|
5138
|
+
* @request GET:/transfer/status/{account}
|
|
5139
|
+
* @secure
|
|
5140
|
+
*/
|
|
5141
|
+
transferStatus(account: string, query?: {
|
|
5142
|
+
/** INCOMING|OUTGOING */
|
|
5143
|
+
direction?: any;
|
|
5144
|
+
/** ACH|WIRE|CHECK|Bank|CustodyJournal|ALL */
|
|
5145
|
+
mechanism?: any;
|
|
5146
|
+
/** MM/DD/YYYY */
|
|
5147
|
+
dateFrom?: any;
|
|
5148
|
+
/** MM/DD/YYYY */
|
|
5149
|
+
dateTo?: any;
|
|
5150
|
+
/** Overrides `dateFrom` and `dateTo`. See description. */
|
|
5151
|
+
range?: any;
|
|
5152
|
+
start?: any;
|
|
5153
|
+
perPage?: any;
|
|
5154
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5155
|
+
/**
|
|
5156
|
+
* @tags Transfers
|
|
5157
|
+
* @name TransferStatusModel
|
|
5158
|
+
* @summary Transfer Status Model
|
|
5159
|
+
* @request GET:/transfer/status/model/{modelId}
|
|
5160
|
+
* @secure
|
|
5161
|
+
*/
|
|
5162
|
+
transferStatusModel(modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5163
|
+
/**
|
|
5164
|
+
* @tags Transfers
|
|
5165
|
+
* @name TransferStatusBranch
|
|
5166
|
+
* @summary Transfer Status Branch
|
|
5167
|
+
* @request GET:/transfer/status/branch
|
|
5168
|
+
* @secure
|
|
5169
|
+
*/
|
|
5170
|
+
transferStatusBranch(query?: {
|
|
5171
|
+
/**
|
|
5172
|
+
* INCOMING|OUTGOING|ALL
|
|
5173
|
+
* @example "ALL"
|
|
5174
|
+
*/
|
|
5175
|
+
direction?: any;
|
|
5176
|
+
/**
|
|
5177
|
+
* ACH|WIRE|CHECK|Bank|CustodyJournal
|
|
5178
|
+
* @example "ALL"
|
|
5179
|
+
*/
|
|
5180
|
+
mechanism?: any;
|
|
5181
|
+
dateFrom?: any;
|
|
5182
|
+
dateTo?: any;
|
|
5183
|
+
/** Per regex: \d+[ymdw]$ (will override `dateFrom` and `dateTo`) */
|
|
5184
|
+
range?: any;
|
|
5185
|
+
start?: any;
|
|
5186
|
+
perPage?: any;
|
|
5187
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5188
|
+
/**
|
|
5189
|
+
* @tags Transfers
|
|
5190
|
+
* @name AmountAvailable
|
|
5191
|
+
* @summary Amount Available
|
|
5192
|
+
* @request GET:/transfer/available/{account}
|
|
5193
|
+
* @secure
|
|
5194
|
+
*/
|
|
5195
|
+
amountAvailable(account: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5196
|
+
/**
|
|
5197
|
+
* @tags Transfers
|
|
5198
|
+
* @name LegalDocumentTypes
|
|
5199
|
+
* @summary Legal document types
|
|
5200
|
+
* @request GET:/transfer/legal/types
|
|
5201
|
+
* @secure
|
|
5202
|
+
*/
|
|
5203
|
+
legalDocumentTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5204
|
+
/**
|
|
5205
|
+
* @tags Transfers
|
|
5206
|
+
* @name LegalDocument
|
|
5207
|
+
* @summary Legal document
|
|
5208
|
+
* @request GET:/transfer/legal/content
|
|
5209
|
+
* @secure
|
|
5210
|
+
*/
|
|
5211
|
+
legalDocument(query?: {
|
|
5212
|
+
/** Unique ID given in the types endpoint */
|
|
5213
|
+
id?: any;
|
|
5214
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5215
|
+
/**
|
|
5216
|
+
* @tags Transfers
|
|
5217
|
+
* @name Cancel
|
|
5218
|
+
* @summary Cancel
|
|
5219
|
+
* @request POST:/transfer/ach/cancel
|
|
5220
|
+
* @secure
|
|
5221
|
+
*/
|
|
5222
|
+
cancel(data: {
|
|
5223
|
+
/** @example "5VA0XXXX" */
|
|
5224
|
+
account?: any;
|
|
5225
|
+
/** @example "0.0.0.0" */
|
|
5226
|
+
remoteAddr?: any;
|
|
5227
|
+
/** @example "ultra fast browser 1.1" */
|
|
5228
|
+
remoteDevice?: any;
|
|
5229
|
+
/** @example "CC123456" */
|
|
5230
|
+
transferId?: any;
|
|
5231
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5232
|
+
/**
|
|
5233
|
+
* @tags Transfers
|
|
5234
|
+
* @name FeesAndCredits
|
|
5235
|
+
* @summary Fees and Credits
|
|
5236
|
+
* @request POST:/transfer/fees/apply
|
|
5255
5237
|
* @secure
|
|
5256
5238
|
*/
|
|
5257
|
-
|
|
5258
|
-
/**
|
|
5259
|
-
|
|
5260
|
-
|
|
5261
|
-
|
|
5239
|
+
feesAndCredits(data: {
|
|
5240
|
+
/** @example "5VA0XXXX" */
|
|
5241
|
+
account?: any;
|
|
5242
|
+
/** @example 100 */
|
|
5243
|
+
amount?: any;
|
|
5244
|
+
/** @example "FeeReversal|Promotion|WriteOff|Rebate|Courtesy|Advisory|Management|Admin|Exchange|Tech|Platform|Inactivity|MarginInterest|Custodian|CryptoGift" */
|
|
5262
5245
|
classification?: any;
|
|
5246
|
+
/** @example "" */
|
|
5247
|
+
contraNote?: any;
|
|
5248
|
+
/** @example "USD" */
|
|
5249
|
+
currency?: any;
|
|
5250
|
+
/** @example "" */
|
|
5251
|
+
note?: any;
|
|
5252
|
+
/** @example 0.01 */
|
|
5253
|
+
quantity?: any;
|
|
5254
|
+
/** @example "0.0.0.0" */
|
|
5255
|
+
remoteAddr?: any;
|
|
5256
|
+
/** @example "ultra fast browser 1.1" */
|
|
5257
|
+
remoteDevice?: any;
|
|
5258
|
+
/** @example "BTC/USD" */
|
|
5259
|
+
symbol?: any;
|
|
5263
5260
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5264
5261
|
/**
|
|
5265
|
-
* @tags
|
|
5266
|
-
* @name
|
|
5267
|
-
* @summary
|
|
5268
|
-
* @request GET:/
|
|
5262
|
+
* @tags Transfers
|
|
5263
|
+
* @name ListFees
|
|
5264
|
+
* @summary List fees
|
|
5265
|
+
* @request GET:/transfer/fees/classifications/fees
|
|
5269
5266
|
* @secure
|
|
5270
5267
|
*/
|
|
5271
|
-
|
|
5268
|
+
listFees(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5272
5269
|
/**
|
|
5273
|
-
* @tags
|
|
5274
|
-
* @name
|
|
5275
|
-
* @summary
|
|
5276
|
-
* @request GET:/
|
|
5270
|
+
* @tags Transfers
|
|
5271
|
+
* @name ListCredits
|
|
5272
|
+
* @summary List credits
|
|
5273
|
+
* @request GET:/transfer/fees/classifications/credits
|
|
5277
5274
|
* @secure
|
|
5278
5275
|
*/
|
|
5279
|
-
|
|
5280
|
-
/** @example "{as provided}" */
|
|
5281
|
-
id?: any;
|
|
5282
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5276
|
+
listCredits(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5283
5277
|
/**
|
|
5284
|
-
* @tags
|
|
5285
|
-
* @name
|
|
5286
|
-
* @summary
|
|
5287
|
-
* @request GET:/
|
|
5278
|
+
* @tags Transfers
|
|
5279
|
+
* @name CryptoDepositAddress
|
|
5280
|
+
* @summary Crypto Deposit Address
|
|
5281
|
+
* @request GET:/transfer/crypto/deposit/wallet/address
|
|
5288
5282
|
* @secure
|
|
5289
5283
|
*/
|
|
5290
|
-
|
|
5291
|
-
/** @example "
|
|
5292
|
-
|
|
5284
|
+
cryptoDepositAddress(data: {
|
|
5285
|
+
/** @example "AB123456" */
|
|
5286
|
+
account?: any;
|
|
5287
|
+
/** @example "BTC" */
|
|
5288
|
+
currency?: any;
|
|
5289
|
+
/** @example "{optional}" */
|
|
5290
|
+
network?: any;
|
|
5293
5291
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5294
5292
|
/**
|
|
5295
|
-
* @tags
|
|
5296
|
-
* @name
|
|
5297
|
-
* @summary
|
|
5298
|
-
* @request POST:/
|
|
5293
|
+
* @tags Transfers
|
|
5294
|
+
* @name CryptoWithdrawalEstimate
|
|
5295
|
+
* @summary Crypto Withdrawal Estimate
|
|
5296
|
+
* @request POST:/transfer/crypto/withdrawal/estimate
|
|
5299
5297
|
* @secure
|
|
5300
5298
|
*/
|
|
5301
|
-
|
|
5302
|
-
|
|
5303
|
-
|
|
5304
|
-
|
|
5305
|
-
|
|
5306
|
-
|
|
5307
|
-
|
|
5308
|
-
|
|
5309
|
-
|
|
5310
|
-
bankAccountNumber?: string;
|
|
5311
|
-
};
|
|
5312
|
-
/** @example "{required}" */
|
|
5313
|
-
documentId?: any;
|
|
5314
|
-
/** @example true */
|
|
5315
|
-
esigned?: any;
|
|
5316
|
-
/** @example "" */
|
|
5317
|
-
remoteAddr?: any;
|
|
5318
|
-
/** @example "{required}" */
|
|
5319
|
-
remoteDevice?: any;
|
|
5320
|
-
/** @example "{required}" */
|
|
5321
|
-
signature?: any;
|
|
5299
|
+
cryptoWithdrawalEstimate(data: {
|
|
5300
|
+
/** @example "BTC" */
|
|
5301
|
+
currency?: any;
|
|
5302
|
+
/** @example "{optional}" */
|
|
5303
|
+
network?: any;
|
|
5304
|
+
/** @example "0.1" */
|
|
5305
|
+
quantity?: any;
|
|
5306
|
+
/** @example "{optional}" */
|
|
5307
|
+
wallet?: any;
|
|
5322
5308
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5323
5309
|
/**
|
|
5324
|
-
* @tags
|
|
5325
|
-
* @name
|
|
5326
|
-
* @summary
|
|
5327
|
-
* @request POST:/
|
|
5310
|
+
* @tags Transfers
|
|
5311
|
+
* @name CryptoWithdrawal
|
|
5312
|
+
* @summary Crypto Withdrawal
|
|
5313
|
+
* @request POST:/transfer/crypto/withdraw
|
|
5328
5314
|
* @secure
|
|
5329
5315
|
*/
|
|
5330
|
-
|
|
5331
|
-
|
|
5332
|
-
|
|
5333
|
-
|
|
5334
|
-
|
|
5335
|
-
|
|
5336
|
-
|
|
5337
|
-
/** @example
|
|
5338
|
-
|
|
5339
|
-
/** @example "
|
|
5340
|
-
|
|
5341
|
-
/** @example
|
|
5316
|
+
cryptoWithdrawal(data: {
|
|
5317
|
+
/** @example "AB123456" */
|
|
5318
|
+
account?: any;
|
|
5319
|
+
/** @example "BTC" */
|
|
5320
|
+
currency?: any;
|
|
5321
|
+
/** @example "{optional}" */
|
|
5322
|
+
estimateExtension?: any;
|
|
5323
|
+
/** @example "abc123" */
|
|
5324
|
+
estimateId?: any;
|
|
5325
|
+
/** @example "{optional}" */
|
|
5326
|
+
network?: any;
|
|
5327
|
+
/** @example 0.1 */
|
|
5328
|
+
quantity?: any;
|
|
5329
|
+
/** @example "{conditional}" */
|
|
5330
|
+
recipientFirstName?: any;
|
|
5331
|
+
/** @example "{conditional}" */
|
|
5332
|
+
recipientLastName?: any;
|
|
5333
|
+
/** @example "{optional} 1.1.1.1" */
|
|
5342
5334
|
remoteAddr?: any;
|
|
5343
|
-
/** @example "" */
|
|
5335
|
+
/** @example "{optional} Some phone" */
|
|
5344
5336
|
remoteDevice?: any;
|
|
5337
|
+
/** @example "{optional} true|false" */
|
|
5338
|
+
selfHosted?: any;
|
|
5339
|
+
/** @example "{optional}" */
|
|
5340
|
+
tag?: any;
|
|
5341
|
+
/** @example "{conditional}" */
|
|
5342
|
+
vaspName?: any;
|
|
5343
|
+
/** @example "wallet address" */
|
|
5344
|
+
wallet?: any;
|
|
5345
5345
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5346
5346
|
}
|
|
5347
5347
|
export class BlacklistAdminBusinesses<HandleError extends boolean = boolean> {
|
|
@@ -5763,6 +5763,49 @@ export class WatchmenFfiUserAccountManagement<HandleError extends boolean = bool
|
|
|
5763
5763
|
*/
|
|
5764
5764
|
visibility(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5765
5765
|
}
|
|
5766
|
+
export class Broker<HandleError extends boolean = boolean> {
|
|
5767
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5768
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5769
|
+
/**
|
|
5770
|
+
* @tags Broker
|
|
5771
|
+
* @name Portfolio
|
|
5772
|
+
* @summary Portfolio
|
|
5773
|
+
* @request GET:/v1/broker/portfolio
|
|
5774
|
+
* @secure
|
|
5775
|
+
*/
|
|
5776
|
+
portfolio(query?: {
|
|
5777
|
+
/**
|
|
5778
|
+
* (true or false) Allows for loading of quotes for each portfolio entry. Defaults to false.
|
|
5779
|
+
* @example "false"
|
|
5780
|
+
*/
|
|
5781
|
+
loadQuotes?: any;
|
|
5782
|
+
/** @example "false" */
|
|
5783
|
+
loadIndustries?: any;
|
|
5784
|
+
/** @example "false" */
|
|
5785
|
+
loadUpgrades?: any;
|
|
5786
|
+
/** @example "false" */
|
|
5787
|
+
loadEarnings?: any;
|
|
5788
|
+
/**
|
|
5789
|
+
* Load balances for weight
|
|
5790
|
+
* @example "false"
|
|
5791
|
+
*/
|
|
5792
|
+
loadRtb?: any;
|
|
5793
|
+
/**
|
|
5794
|
+
* Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
|
|
5795
|
+
* @example "false"
|
|
5796
|
+
*/
|
|
5797
|
+
marketCapBreakdown?: any;
|
|
5798
|
+
/**
|
|
5799
|
+
* Combined portfolio for the branch
|
|
5800
|
+
* @example "false"
|
|
5801
|
+
*/
|
|
5802
|
+
combined?: any;
|
|
5803
|
+
/** @example "1" */
|
|
5804
|
+
pageNum?: any;
|
|
5805
|
+
/** @example "100" */
|
|
5806
|
+
pageSize?: any;
|
|
5807
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5808
|
+
}
|
|
5766
5809
|
export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
|
|
5767
5810
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5768
5811
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5948,49 +5991,6 @@ export class Advisory<HandleError extends boolean = boolean> {
|
|
|
5948
5991
|
allocations: AdvisoryAllocations<HandleError>;
|
|
5949
5992
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5950
5993
|
}
|
|
5951
|
-
export class Broker<HandleError extends boolean = boolean> {
|
|
5952
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5953
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5954
|
-
/**
|
|
5955
|
-
* @tags Broker
|
|
5956
|
-
* @name Portfolio
|
|
5957
|
-
* @summary Portfolio
|
|
5958
|
-
* @request GET:/v1/broker/portfolio
|
|
5959
|
-
* @secure
|
|
5960
|
-
*/
|
|
5961
|
-
portfolio(query?: {
|
|
5962
|
-
/**
|
|
5963
|
-
* (true or false) Allows for loading of quotes for each portfolio entry. Defaults to false.
|
|
5964
|
-
* @example "false"
|
|
5965
|
-
*/
|
|
5966
|
-
loadQuotes?: any;
|
|
5967
|
-
/** @example "false" */
|
|
5968
|
-
loadIndustries?: any;
|
|
5969
|
-
/** @example "false" */
|
|
5970
|
-
loadUpgrades?: any;
|
|
5971
|
-
/** @example "false" */
|
|
5972
|
-
loadEarnings?: any;
|
|
5973
|
-
/**
|
|
5974
|
-
* Load balances for weight
|
|
5975
|
-
* @example "false"
|
|
5976
|
-
*/
|
|
5977
|
-
loadRtb?: any;
|
|
5978
|
-
/**
|
|
5979
|
-
* Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
|
|
5980
|
-
* @example "false"
|
|
5981
|
-
*/
|
|
5982
|
-
marketCapBreakdown?: any;
|
|
5983
|
-
/**
|
|
5984
|
-
* Combined portfolio for the branch
|
|
5985
|
-
* @example "false"
|
|
5986
|
-
*/
|
|
5987
|
-
combined?: any;
|
|
5988
|
-
/** @example "1" */
|
|
5989
|
-
pageNum?: any;
|
|
5990
|
-
/** @example "100" */
|
|
5991
|
-
pageSize?: any;
|
|
5992
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5993
|
-
}
|
|
5994
5994
|
export class WatchmenFfi<HandleError extends boolean = boolean> {
|
|
5995
5995
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5996
5996
|
userAccountManagement: WatchmenFfiUserAccountManagement<HandleError>;
|