@orbis-systems/orbis-api-clients 0.6.6 → 0.6.7
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 +1152 -1116
- package/dist/aesmidas/index.d.ts.map +1 -1
- package/dist/aesmidas/index.esm.js +976 -976
- package/dist/aesmidas/index.esm.js.map +1 -1
- package/dist/aesmidas/index.js +975 -975
- package/dist/aesmidas/index.js.map +1 -1
- package/dist/bridgewise/index.d.ts +209 -209
- package/dist/bridgewise/index.d.ts.map +1 -1
- package/dist/bridgewise/index.esm.js +195 -195
- package/dist/bridgewise/index.esm.js.map +1 -1
- package/dist/bridgewise/index.js +194 -194
- package/dist/bridgewise/index.js.map +1 -1
- package/dist/insight/index.d.ts +238 -238
- package/dist/insight/index.d.ts.map +1 -1
- package/dist/insight/index.esm.js +479 -479
- package/dist/insight/index.esm.js.map +1 -1
- package/dist/insight/index.js +478 -478
- package/dist/insight/index.js.map +1 -1
- package/dist/middleware/index.d.ts +98 -98
- package/dist/middleware/index.d.ts.map +1 -1
- package/dist/middleware/index.esm.js +225 -225
- package/dist/middleware/index.esm.js.map +1 -1
- package/dist/middleware/index.js +224 -224
- package/dist/middleware/index.js.map +1 -1
- package/dist/orbis/index.d.ts +1741 -1741
- package/dist/orbis/index.d.ts.map +1 -1
- package/dist/orbis/index.esm.js +1668 -1668
- package/dist/orbis/index.esm.js.map +1 -1
- package/dist/orbis/index.js +1667 -1667
- package/dist/orbis/index.js.map +1 -1
- package/dist/uma/index.d.ts +268 -268
- package/dist/uma/index.d.ts.map +1 -1
- package/dist/uma/index.esm.js +580 -580
- package/dist/uma/index.esm.js.map +1 -1
- package/dist/uma/index.js +579 -579
- package/dist/uma/index.js.map +1 -1
- package/package.json +1 -1
package/dist/orbis/index.d.ts
CHANGED
|
@@ -306,84 +306,6 @@ 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
|
-
}
|
|
387
309
|
export class OrdersV2Options<HandleError extends boolean = boolean> {
|
|
388
310
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
389
311
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -589,77 +511,81 @@ export class OrdersV2Options<HandleError extends boolean = boolean> {
|
|
|
589
511
|
};
|
|
590
512
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
591
513
|
}
|
|
592
|
-
export class
|
|
514
|
+
export class OrdersV2FixedIncome<HandleError extends boolean = boolean> {
|
|
593
515
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
594
516
|
constructor(apiClient: JwtClient<HandleError>);
|
|
595
517
|
/**
|
|
596
|
-
* @tags Orders V2
|
|
597
|
-
* @name
|
|
598
|
-
* @summary
|
|
599
|
-
* @request POST:/orders/v2/
|
|
518
|
+
* @tags Orders V2 Fixed Income
|
|
519
|
+
* @name BondPlacement
|
|
520
|
+
* @summary Bond placement
|
|
521
|
+
* @request POST:/orders/v2/bonds/place
|
|
600
522
|
* @secure
|
|
601
523
|
*/
|
|
602
|
-
|
|
524
|
+
bondPlacement(data: {
|
|
603
525
|
account?: {
|
|
604
|
-
/** @example
|
|
526
|
+
/** @example 123 */
|
|
527
|
+
accountId?: number;
|
|
528
|
+
/** @example "AC00123" */
|
|
605
529
|
accountNumber?: string;
|
|
606
530
|
};
|
|
607
531
|
order?: {
|
|
608
|
-
/** @example
|
|
609
|
-
expectedValue?: number;
|
|
610
|
-
/** @example 1.123 */
|
|
611
|
-
limitPx?: number;
|
|
612
|
-
/** @example "MARKET|LIMIT|STOP|STOP_LIMIG|Notional|NotionalLimit" */
|
|
532
|
+
/** @example "LIMIT" */
|
|
613
533
|
orderType?: string;
|
|
614
|
-
/** @example
|
|
534
|
+
/** @example 100 */
|
|
535
|
+
price?: number;
|
|
536
|
+
/** @example "Percentage|Decimal" */
|
|
537
|
+
priceType?: string;
|
|
538
|
+
/** @example 1000 */
|
|
615
539
|
quantity?: number;
|
|
540
|
+
/** @example "Par|Unit" */
|
|
541
|
+
quantityType?: string;
|
|
616
542
|
quote?: {
|
|
617
|
-
/** @example "
|
|
618
|
-
|
|
543
|
+
/** @example "412001269" */
|
|
544
|
+
cusip?: string;
|
|
545
|
+
/** @example "CUSIP:ISIN" */
|
|
546
|
+
identType?: string;
|
|
547
|
+
/** @example "SK4120012691" */
|
|
548
|
+
isin?: string;
|
|
619
549
|
};
|
|
620
|
-
/** @example 1.123 */
|
|
621
|
-
stopPx?: number;
|
|
622
550
|
/** @example "BUY|SELL" */
|
|
623
551
|
transaction?: string;
|
|
624
|
-
/** @example "DAY|GTC" */
|
|
625
|
-
validity?: string;
|
|
626
552
|
};
|
|
627
553
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
628
554
|
/**
|
|
629
|
-
* @tags Orders V2
|
|
630
|
-
* @name
|
|
631
|
-
* @summary
|
|
632
|
-
* @request POST:/orders/v2/
|
|
555
|
+
* @tags Orders V2 Fixed Income
|
|
556
|
+
* @name BondOrderPreview
|
|
557
|
+
* @summary Bond order preview
|
|
558
|
+
* @request POST:/orders/v2/bonds/preview
|
|
633
559
|
* @secure
|
|
634
560
|
*/
|
|
635
|
-
|
|
561
|
+
bondOrderPreview(data: {
|
|
636
562
|
account?: {
|
|
637
|
-
/** @example
|
|
563
|
+
/** @example 123 */
|
|
564
|
+
accountId?: number;
|
|
565
|
+
/** @example "AC00123" */
|
|
638
566
|
accountNumber?: string;
|
|
639
567
|
};
|
|
640
568
|
order?: {
|
|
641
|
-
/** @example "
|
|
642
|
-
clientRef?: string;
|
|
643
|
-
/** @example "ABC" */
|
|
644
|
-
clientSourceId?: string;
|
|
645
|
-
/** @example 100 */
|
|
646
|
-
expectedValue?: number;
|
|
647
|
-
/** @example 1.123 */
|
|
648
|
-
limitPx?: number;
|
|
649
|
-
/** @example "MARKET|LIMIT|STOP|STOP_LIMIT|Notional|NotionalLimit" */
|
|
569
|
+
/** @example "LIMIT" */
|
|
650
570
|
orderType?: string;
|
|
651
|
-
/** @example
|
|
571
|
+
/** @example 100 */
|
|
572
|
+
price?: number;
|
|
573
|
+
/** @example "Percentage|Decimal" */
|
|
574
|
+
priceType?: string;
|
|
575
|
+
/** @example 1000 */
|
|
652
576
|
quantity?: number;
|
|
577
|
+
/** @example "Par|Unit" */
|
|
578
|
+
quantityType?: string;
|
|
653
579
|
quote?: {
|
|
654
|
-
/** @example "
|
|
655
|
-
|
|
580
|
+
/** @example "412001269" */
|
|
581
|
+
cusip?: string;
|
|
582
|
+
/** @example "CUSIP:ISIN" */
|
|
583
|
+
identType?: string;
|
|
584
|
+
/** @example "SK4120012691" */
|
|
585
|
+
isin?: string;
|
|
656
586
|
};
|
|
657
|
-
/** @example 1.123 */
|
|
658
|
-
stopPx?: number;
|
|
659
587
|
/** @example "BUY|SELL" */
|
|
660
588
|
transaction?: string;
|
|
661
|
-
/** @example "DAY|GTC" */
|
|
662
|
-
validity?: string;
|
|
663
589
|
};
|
|
664
590
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
665
591
|
}
|
|
@@ -707,6 +633,80 @@ export class OrdersV2MutualFunds<HandleError extends boolean = boolean> {
|
|
|
707
633
|
*/
|
|
708
634
|
mutualFundPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
709
635
|
}
|
|
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>);
|
|
@@ -1024,21 +1024,147 @@ export class OrdersArchived<HandleError extends boolean = boolean> {
|
|
|
1024
1024
|
orderRef?: string;
|
|
1025
1025
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1026
1026
|
}
|
|
1027
|
-
export class
|
|
1027
|
+
export class Orders<HandleError extends boolean = boolean> {
|
|
1028
1028
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
1029
|
+
violationManagement: OrdersViolationManagement<HandleError>;
|
|
1030
|
+
archived: OrdersArchived<HandleError>;
|
|
1031
|
+
v2: OrdersV2<HandleError>;
|
|
1029
1032
|
constructor(apiClient: JwtClient<HandleError>);
|
|
1030
1033
|
/**
|
|
1031
|
-
* @tags
|
|
1032
|
-
* @name
|
|
1033
|
-
* @summary
|
|
1034
|
-
* @request GET:/
|
|
1034
|
+
* @tags Orders
|
|
1035
|
+
* @name Listing
|
|
1036
|
+
* @summary Listing
|
|
1037
|
+
* @request GET:/orders/{type}
|
|
1035
1038
|
* @secure
|
|
1036
1039
|
*/
|
|
1037
|
-
|
|
1040
|
+
listing(type: string, query?: {
|
|
1038
1041
|
/**
|
|
1039
|
-
*
|
|
1040
|
-
* @example "
|
|
1041
|
-
*/
|
|
1042
|
+
* `true|false` (optional)
|
|
1043
|
+
* @example "false"
|
|
1044
|
+
*/
|
|
1045
|
+
loadQuotes?: any;
|
|
1046
|
+
/** Account ID (optional) */
|
|
1047
|
+
accountId?: any;
|
|
1048
|
+
/** Account number (optional) */
|
|
1049
|
+
account?: any;
|
|
1050
|
+
/** Ticker symbol (optional) */
|
|
1051
|
+
symbol?: any;
|
|
1052
|
+
/**
|
|
1053
|
+
* Return bond pricing type in `Percentage|Decimal` (optional)
|
|
1054
|
+
* @example "Decimal"
|
|
1055
|
+
*/
|
|
1056
|
+
bondPriceType?: any;
|
|
1057
|
+
/**
|
|
1058
|
+
* Return bond quantity in `Par|Unit` (optional)
|
|
1059
|
+
* @example "Par"
|
|
1060
|
+
*/
|
|
1061
|
+
bondQuantityType?: any;
|
|
1062
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1063
|
+
/**
|
|
1064
|
+
* @tags Orders
|
|
1065
|
+
* @name ListingForModel
|
|
1066
|
+
* @summary Listing for model
|
|
1067
|
+
* @request GET:/orders/model/{modelId}/{type}
|
|
1068
|
+
* @secure
|
|
1069
|
+
*/
|
|
1070
|
+
listingForModel(modelId: string, type: string, query?: {
|
|
1071
|
+
/**
|
|
1072
|
+
* true|false
|
|
1073
|
+
* @example "false"
|
|
1074
|
+
*/
|
|
1075
|
+
loadQuotes?: any;
|
|
1076
|
+
/**
|
|
1077
|
+
* Return bond pricing type in `Percentage|Decimal` (optional)
|
|
1078
|
+
* @example "Decimal"
|
|
1079
|
+
*/
|
|
1080
|
+
bondPriceType?: any;
|
|
1081
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1082
|
+
/**
|
|
1083
|
+
* @tags Orders
|
|
1084
|
+
* @name ListingForBranch
|
|
1085
|
+
* @summary Listing for branch
|
|
1086
|
+
* @request GET:/orders/branch/{type}
|
|
1087
|
+
* @secure
|
|
1088
|
+
*/
|
|
1089
|
+
listingForBranch(type: string, query?: {
|
|
1090
|
+
/** Return bond pricing type in `Percentage|Decimal` (optional) */
|
|
1091
|
+
bondPriceType?: any;
|
|
1092
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1093
|
+
/**
|
|
1094
|
+
* @tags Orders
|
|
1095
|
+
* @name Status
|
|
1096
|
+
* @summary Status
|
|
1097
|
+
* @request GET:/orders/status/{orderRef}
|
|
1098
|
+
* @secure
|
|
1099
|
+
*/
|
|
1100
|
+
status(orderRef: string, query?: {
|
|
1101
|
+
/** [optional] `true` or `false` to load quotes */
|
|
1102
|
+
loadQuotes?: any;
|
|
1103
|
+
/** [optional] Account number order belongs to */
|
|
1104
|
+
account?: any;
|
|
1105
|
+
/** [optional] AccountId as known in the system */
|
|
1106
|
+
accountId?: any;
|
|
1107
|
+
/**
|
|
1108
|
+
* Return bond quantity in `Par|Unit` (optional)
|
|
1109
|
+
* @example "Decimal"
|
|
1110
|
+
*/
|
|
1111
|
+
bondPriceType?: any;
|
|
1112
|
+
/**
|
|
1113
|
+
* Return bond quantity in `Par|Unit` (optional)
|
|
1114
|
+
* @example "Par"
|
|
1115
|
+
*/
|
|
1116
|
+
bondQuantityType?: any;
|
|
1117
|
+
/**
|
|
1118
|
+
* [optional] Specifies market code for the order
|
|
1119
|
+
* @example "U"
|
|
1120
|
+
*/
|
|
1121
|
+
market?: any;
|
|
1122
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1123
|
+
/**
|
|
1124
|
+
* @tags Orders
|
|
1125
|
+
* @name OrderLookup
|
|
1126
|
+
* @summary Order lookup
|
|
1127
|
+
* @request GET:/orders/lookup
|
|
1128
|
+
* @secure
|
|
1129
|
+
*/
|
|
1130
|
+
orderLookup(query?: {
|
|
1131
|
+
/**
|
|
1132
|
+
* Required
|
|
1133
|
+
* @example "{your order reference}"
|
|
1134
|
+
*/
|
|
1135
|
+
clientRef?: any;
|
|
1136
|
+
/**
|
|
1137
|
+
* `true|false` (optional)
|
|
1138
|
+
* @example "false"
|
|
1139
|
+
*/
|
|
1140
|
+
loadQuotes?: any;
|
|
1141
|
+
/**
|
|
1142
|
+
* Return bond pricing type in `Percentage|Decimal` (optional)
|
|
1143
|
+
* @example "Decimal"
|
|
1144
|
+
*/
|
|
1145
|
+
bondPriceType?: any;
|
|
1146
|
+
/**
|
|
1147
|
+
* Return bond quantity in `Par|Unit` (optional)
|
|
1148
|
+
* @example "Par"
|
|
1149
|
+
*/
|
|
1150
|
+
bondQuantityType?: any;
|
|
1151
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1152
|
+
}
|
|
1153
|
+
export class ResearchTipranks<HandleError extends boolean = boolean> {
|
|
1154
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
1155
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
1156
|
+
/**
|
|
1157
|
+
* @tags Research Tipranks
|
|
1158
|
+
* @name Livefeed
|
|
1159
|
+
* @summary Livefeed
|
|
1160
|
+
* @request GET:/research/tipranks/livefeed
|
|
1161
|
+
* @secure
|
|
1162
|
+
*/
|
|
1163
|
+
livefeed(query?: {
|
|
1164
|
+
/**
|
|
1165
|
+
* Amount to include. Defaults to 20.
|
|
1166
|
+
* @example "20"
|
|
1167
|
+
*/
|
|
1042
1168
|
count?: any;
|
|
1043
1169
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1044
1170
|
/**
|
|
@@ -1205,629 +1331,916 @@ export class ResearchTipranks<HandleError extends boolean = boolean> {
|
|
|
1205
1331
|
*/
|
|
1206
1332
|
bloggerRatings(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1207
1333
|
}
|
|
1208
|
-
export class
|
|
1334
|
+
export class Quotes<HandleError extends boolean = boolean> {
|
|
1209
1335
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
1210
1336
|
constructor(apiClient: JwtClient<HandleError>);
|
|
1211
1337
|
/**
|
|
1212
|
-
* @tags
|
|
1213
|
-
* @name
|
|
1214
|
-
* @summary
|
|
1215
|
-
* @request GET:/
|
|
1338
|
+
* @tags Quotes
|
|
1339
|
+
* @name Equity
|
|
1340
|
+
* @summary Equity
|
|
1341
|
+
* @request GET:/quotes/equity
|
|
1216
1342
|
* @secure
|
|
1217
1343
|
*/
|
|
1218
|
-
|
|
1344
|
+
equity(query?: {
|
|
1345
|
+
/**
|
|
1346
|
+
* Comma separated list of symbols
|
|
1347
|
+
* @example "IBM"
|
|
1348
|
+
*/
|
|
1349
|
+
symbols?: any;
|
|
1350
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1219
1351
|
/**
|
|
1220
|
-
* @tags
|
|
1221
|
-
* @name
|
|
1222
|
-
* @summary
|
|
1223
|
-
* @request GET:/
|
|
1352
|
+
* @tags Quotes
|
|
1353
|
+
* @name Search
|
|
1354
|
+
* @summary Search
|
|
1355
|
+
* @request GET:/quotes/search
|
|
1224
1356
|
* @secure
|
|
1225
1357
|
*/
|
|
1226
|
-
|
|
1227
|
-
/** * see init */
|
|
1228
|
-
inverseType?: any;
|
|
1229
|
-
/** * see init */
|
|
1230
|
-
leverageType?: any;
|
|
1231
|
-
/** * see init */
|
|
1232
|
-
assetId?: any;
|
|
1233
|
-
/** * see init */
|
|
1234
|
-
categoryId?: any;
|
|
1235
|
-
/** * see init */
|
|
1236
|
-
sponsorId?: any;
|
|
1237
|
-
/** Entry to start at */
|
|
1238
|
-
start?: any;
|
|
1239
|
-
/** Entries per page */
|
|
1240
|
-
num?: any;
|
|
1241
|
-
/** Sort by: symbol, last, change, volume, marketcap, expense, asset, sponsor, category, leverage, countrypct, countinentpct, sectorpct, exposure */
|
|
1242
|
-
sort?: any;
|
|
1243
|
-
/** True/false */
|
|
1244
|
-
asc?: any;
|
|
1358
|
+
search(query?: {
|
|
1245
1359
|
/**
|
|
1246
|
-
*
|
|
1247
|
-
* @example "
|
|
1360
|
+
* String to search for
|
|
1361
|
+
* @example "Apple"
|
|
1248
1362
|
*/
|
|
1249
|
-
|
|
1363
|
+
criteria?: any;
|
|
1250
1364
|
/**
|
|
1251
|
-
*
|
|
1252
|
-
* @example "
|
|
1365
|
+
* Maximum number of results to return (default is 20)
|
|
1366
|
+
* @example "3"
|
|
1253
1367
|
*/
|
|
1254
|
-
|
|
1368
|
+
limit?: any;
|
|
1255
1369
|
/**
|
|
1256
|
-
*
|
|
1370
|
+
* Whether to load quotes for the results or not
|
|
1257
1371
|
* @example "false"
|
|
1258
1372
|
*/
|
|
1259
|
-
|
|
1260
|
-
/**
|
|
1261
|
-
* Repeating set of:
|
|
1262
|
-
* * paying dividend
|
|
1263
|
-
* * 5pct - paying at least 5% dividend
|
|
1264
|
-
* * 3pct
|
|
1265
|
-
* * mcbelow2b – market cap under 2B
|
|
1266
|
-
* * mcbetween2and10b
|
|
1267
|
-
* * mcbetween10and200b
|
|
1268
|
-
* * mcabove200b
|
|
1269
|
-
*/
|
|
1270
|
-
filters?: any;
|
|
1373
|
+
loadQuotes?: any;
|
|
1271
1374
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1272
1375
|
/**
|
|
1273
|
-
* @tags
|
|
1274
|
-
* @name
|
|
1275
|
-
* @summary
|
|
1276
|
-
* @request GET:/
|
|
1376
|
+
* @tags Quotes
|
|
1377
|
+
* @name Option
|
|
1378
|
+
* @summary Option
|
|
1379
|
+
* @request GET:/quotes/option
|
|
1277
1380
|
* @secure
|
|
1278
1381
|
*/
|
|
1279
|
-
|
|
1280
|
-
/**
|
|
1281
|
-
|
|
1282
|
-
* @example "ALL"
|
|
1283
|
-
*/
|
|
1284
|
-
inverseType?: any;
|
|
1382
|
+
option(query?: {
|
|
1383
|
+
/** Comma separated list of symbols */
|
|
1384
|
+
symbols?: any;
|
|
1285
1385
|
/**
|
|
1286
|
-
*
|
|
1287
|
-
* @example "
|
|
1386
|
+
* `true|false` - whether to load option greeks
|
|
1387
|
+
* @example ""
|
|
1288
1388
|
*/
|
|
1289
|
-
|
|
1389
|
+
greeks?: any;
|
|
1290
1390
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1291
1391
|
/**
|
|
1292
|
-
* @tags
|
|
1293
|
-
* @name
|
|
1294
|
-
* @summary
|
|
1295
|
-
* @request GET:/
|
|
1392
|
+
* @tags Quotes
|
|
1393
|
+
* @name OptionPricingType
|
|
1394
|
+
* @summary Option pricing type
|
|
1395
|
+
* @request GET:/quotes/option/pricing/type
|
|
1296
1396
|
* @secure
|
|
1297
1397
|
*/
|
|
1298
|
-
|
|
1398
|
+
optionPricingType(query?: {
|
|
1299
1399
|
/**
|
|
1300
|
-
*
|
|
1301
|
-
* @example "
|
|
1400
|
+
* [optional]
|
|
1401
|
+
* @example "MSFT"
|
|
1402
|
+
*/
|
|
1403
|
+
underlying?: any;
|
|
1404
|
+
/**
|
|
1405
|
+
* [optional]
|
|
1406
|
+
* @example "F 130927C00014500"
|
|
1302
1407
|
*/
|
|
1303
1408
|
symbol?: any;
|
|
1304
1409
|
/**
|
|
1305
|
-
*
|
|
1306
|
-
* @example "
|
|
1410
|
+
* [optional]
|
|
1411
|
+
* @example "1.23"
|
|
1307
1412
|
*/
|
|
1308
|
-
|
|
1413
|
+
expectedPx?: any;
|
|
1309
1414
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1310
1415
|
/**
|
|
1311
|
-
* @tags
|
|
1312
|
-
* @name
|
|
1313
|
-
* @summary
|
|
1314
|
-
* @request GET:/
|
|
1416
|
+
* @tags Quotes
|
|
1417
|
+
* @name Bonds
|
|
1418
|
+
* @summary Bonds
|
|
1419
|
+
* @request GET:/quotes/bonds
|
|
1315
1420
|
* @secure
|
|
1316
1421
|
*/
|
|
1317
|
-
|
|
1318
|
-
/**
|
|
1319
|
-
* 1d, 1w, 2w, 1m where d is day, w is week, and m is month
|
|
1320
|
-
* @example "1d"
|
|
1321
|
-
*/
|
|
1322
|
-
duration?: any;
|
|
1422
|
+
bonds(query?: {
|
|
1323
1423
|
/**
|
|
1324
|
-
*
|
|
1325
|
-
* @example "
|
|
1424
|
+
* Comma separated list of ISINs
|
|
1425
|
+
* @example "SK4120012691"
|
|
1326
1426
|
*/
|
|
1327
|
-
|
|
1427
|
+
isin?: any;
|
|
1328
1428
|
/**
|
|
1329
|
-
*
|
|
1330
|
-
* @example "
|
|
1429
|
+
* Comma separated list of CUSIPs
|
|
1430
|
+
* @example "412001269"
|
|
1331
1431
|
*/
|
|
1332
|
-
|
|
1432
|
+
cusip?: any;
|
|
1333
1433
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1334
|
-
}
|
|
1335
|
-
export class ResearchAdrs<HandleError extends boolean = boolean> {
|
|
1336
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
1337
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
1338
1434
|
/**
|
|
1339
|
-
* @tags
|
|
1340
|
-
* @name
|
|
1341
|
-
* @summary
|
|
1342
|
-
* @request GET:/
|
|
1435
|
+
* @tags Quotes
|
|
1436
|
+
* @name BondsSearch
|
|
1437
|
+
* @summary Bonds Search
|
|
1438
|
+
* @request GET:/quotes/bonds/search
|
|
1343
1439
|
* @secure
|
|
1344
1440
|
*/
|
|
1345
|
-
|
|
1346
|
-
/**
|
|
1347
|
-
|
|
1348
|
-
/**
|
|
1441
|
+
bondsSearch(query?: {
|
|
1442
|
+
/** @example "SearchString" */
|
|
1443
|
+
criteria?: any;
|
|
1444
|
+
/** @example "20" */
|
|
1445
|
+
limit?: any;
|
|
1446
|
+
/** @example "false" */
|
|
1349
1447
|
loadQuotes?: any;
|
|
1350
|
-
/** `true` or `false` */
|
|
1351
|
-
loadEarningReleases?: any;
|
|
1352
|
-
/** `true` or `false` */
|
|
1353
|
-
loadUpgradesDowngrades?: any;
|
|
1354
1448
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1355
1449
|
/**
|
|
1356
|
-
* @tags
|
|
1357
|
-
* @name
|
|
1358
|
-
* @summary
|
|
1359
|
-
* @request GET:/
|
|
1450
|
+
* @tags Quotes
|
|
1451
|
+
* @name Historical
|
|
1452
|
+
* @summary Historical
|
|
1453
|
+
* @request GET:/quotes/equity/historical
|
|
1360
1454
|
* @secure
|
|
1361
1455
|
*/
|
|
1362
|
-
|
|
1456
|
+
historical(query?: {
|
|
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>>;
|
|
1363
1479
|
/**
|
|
1364
|
-
* @tags
|
|
1365
|
-
* @name
|
|
1366
|
-
* @summary
|
|
1367
|
-
* @request GET:/
|
|
1480
|
+
* @tags Quotes
|
|
1481
|
+
* @name IntradayChartData
|
|
1482
|
+
* @summary Intraday chart data
|
|
1483
|
+
* @request GET:/quotes/equity/intraday
|
|
1368
1484
|
* @secure
|
|
1369
1485
|
*/
|
|
1370
|
-
|
|
1486
|
+
intradayChartData(query?: {
|
|
1371
1487
|
/**
|
|
1372
|
-
*
|
|
1373
|
-
* @example "
|
|
1488
|
+
* Ticker
|
|
1489
|
+
* @example "IBM"
|
|
1374
1490
|
*/
|
|
1375
|
-
|
|
1376
|
-
/**
|
|
1377
|
-
|
|
1378
|
-
/** `
|
|
1379
|
-
|
|
1380
|
-
/** `
|
|
1381
|
-
|
|
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;
|
|
1498
|
+
/**
|
|
1499
|
+
* `optional` whether to adjust volumes or not
|
|
1500
|
+
* @example "false"
|
|
1501
|
+
*/
|
|
1502
|
+
rawVolumes?: any;
|
|
1382
1503
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1383
|
-
}
|
|
1384
|
-
export class ResearchCorporateActions<HandleError extends boolean = boolean> {
|
|
1385
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
1386
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
1387
1504
|
/**
|
|
1388
|
-
* @tags
|
|
1389
|
-
* @name
|
|
1390
|
-
* @summary
|
|
1391
|
-
* @request GET:/
|
|
1505
|
+
* @tags Quotes
|
|
1506
|
+
* @name EquityTicks
|
|
1507
|
+
* @summary Equity Ticks
|
|
1508
|
+
* @request GET:/quotes/equity/ticks
|
|
1392
1509
|
* @secure
|
|
1393
1510
|
*/
|
|
1394
|
-
|
|
1511
|
+
equityTicks(query?: {
|
|
1512
|
+
/**
|
|
1513
|
+
* Ticker
|
|
1514
|
+
* @example "GOOG"
|
|
1515
|
+
*/
|
|
1516
|
+
symbol?: any;
|
|
1517
|
+
/**
|
|
1518
|
+
* Timestamp for start of the data. Format: MM/DD/YYYY HH:MM or MM/DD/YYYY
|
|
1519
|
+
* @example "11/27/2016"
|
|
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"
|
|
1525
|
+
*/
|
|
1526
|
+
endTime?: any;
|
|
1527
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1395
1528
|
/**
|
|
1396
|
-
* @tags
|
|
1397
|
-
* @name
|
|
1398
|
-
* @summary
|
|
1399
|
-
* @request GET:/
|
|
1529
|
+
* @tags Quotes
|
|
1530
|
+
* @name Shortability
|
|
1531
|
+
* @summary Shortability
|
|
1532
|
+
* @request GET:/quotes/equity/shortability/{symbol}
|
|
1400
1533
|
* @secure
|
|
1401
1534
|
*/
|
|
1402
|
-
|
|
1535
|
+
shortability(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1403
1536
|
/**
|
|
1404
|
-
* @tags
|
|
1405
|
-
* @name
|
|
1406
|
-
* @summary
|
|
1407
|
-
* @request GET:/
|
|
1537
|
+
* @tags Quotes
|
|
1538
|
+
* @name MarginSuitability
|
|
1539
|
+
* @summary Margin Suitability
|
|
1540
|
+
* @request GET:/quotes/equity/marginability
|
|
1408
1541
|
* @secure
|
|
1409
1542
|
*/
|
|
1410
|
-
|
|
1543
|
+
marginSuitability(query?: {
|
|
1411
1544
|
/**
|
|
1412
|
-
*
|
|
1413
|
-
* @example "
|
|
1545
|
+
* Equity ticker
|
|
1546
|
+
* @example "TSLA"
|
|
1414
1547
|
*/
|
|
1415
1548
|
symbol?: any;
|
|
1416
1549
|
/**
|
|
1417
|
-
*
|
|
1418
|
-
* @example "
|
|
1419
|
-
*/
|
|
1420
|
-
dateFrom?: any;
|
|
1421
|
-
/** @example "{date}" */
|
|
1422
|
-
dateTo?: any;
|
|
1423
|
-
/**
|
|
1424
|
-
* (separate multiple types with comma)
|
|
1425
|
-
* @example "{type}"
|
|
1426
|
-
*/
|
|
1427
|
-
type?: any;
|
|
1428
|
-
/**
|
|
1429
|
-
* (search for Dividends using payment date instead of ex-date)
|
|
1430
|
-
* @example "false"
|
|
1550
|
+
* Account number requesting the information
|
|
1551
|
+
* @example "AB654321"
|
|
1431
1552
|
*/
|
|
1432
|
-
|
|
1553
|
+
account?: any;
|
|
1554
|
+
accountId?: any;
|
|
1433
1555
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1434
|
-
}
|
|
1435
|
-
export class ResearchNews<HandleError extends boolean = boolean> {
|
|
1436
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
1437
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
1438
1556
|
/**
|
|
1439
|
-
* @tags
|
|
1440
|
-
* @name
|
|
1441
|
-
* @summary
|
|
1442
|
-
* @request GET:/
|
|
1557
|
+
* @tags Quotes
|
|
1558
|
+
* @name OptionChainDates
|
|
1559
|
+
* @summary Option chain (dates)
|
|
1560
|
+
* @request GET:/quotes/option/chain/dates/{symbol}
|
|
1443
1561
|
* @secure
|
|
1444
1562
|
*/
|
|
1445
|
-
|
|
1446
|
-
/** @example "0" */
|
|
1447
|
-
start?: any;
|
|
1563
|
+
optionChainDates(symbol: string, query?: {
|
|
1448
1564
|
/**
|
|
1449
|
-
*
|
|
1450
|
-
* @example "
|
|
1565
|
+
* Comma separated list of symbols
|
|
1566
|
+
* @example "AAPL"
|
|
1451
1567
|
*/
|
|
1452
|
-
|
|
1453
|
-
/** @example "[[-](provider|aggregator):value1,valueN];" */
|
|
1454
|
-
filter?: any;
|
|
1568
|
+
symbols?: any;
|
|
1455
1569
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1456
1570
|
/**
|
|
1457
|
-
* @tags
|
|
1458
|
-
* @name
|
|
1459
|
-
* @summary
|
|
1460
|
-
* @request GET:/
|
|
1571
|
+
* @tags Quotes
|
|
1572
|
+
* @name OptionChain
|
|
1573
|
+
* @summary Option chain
|
|
1574
|
+
* @request GET:/quotes/option/chain/{symbol}/{date}
|
|
1461
1575
|
* @secure
|
|
1462
1576
|
*/
|
|
1463
|
-
|
|
1577
|
+
optionChain(symbol: string, date: string, query?: {
|
|
1464
1578
|
/**
|
|
1465
|
-
*
|
|
1466
|
-
* @example ""
|
|
1579
|
+
* Comma separated list of symbols
|
|
1580
|
+
* @example "AAPL"
|
|
1467
1581
|
*/
|
|
1468
|
-
|
|
1469
|
-
/** Defaults to 20 (optional) */
|
|
1470
|
-
count?: any;
|
|
1582
|
+
symbols?: any;
|
|
1471
1583
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1472
1584
|
/**
|
|
1473
|
-
* @tags
|
|
1474
|
-
* @name
|
|
1475
|
-
* @summary
|
|
1476
|
-
* @request GET:/
|
|
1585
|
+
* @tags Quotes
|
|
1586
|
+
* @name OptionChainGreeks
|
|
1587
|
+
* @summary Option chain (greeks)
|
|
1588
|
+
* @request GET:/quotes/option/greeks/{symbol}/{date}
|
|
1477
1589
|
* @secure
|
|
1478
1590
|
*/
|
|
1479
|
-
|
|
1480
|
-
/**
|
|
1481
|
-
* Starting point(optional)
|
|
1482
|
-
* @example "0"
|
|
1483
|
-
*/
|
|
1484
|
-
start?: any;
|
|
1591
|
+
optionChainGreeks(symbol: string, date: string, query?: {
|
|
1485
1592
|
/**
|
|
1486
|
-
*
|
|
1487
|
-
* @example "
|
|
1593
|
+
* Comma separated list of symbols
|
|
1594
|
+
* @example "AAPL"
|
|
1488
1595
|
*/
|
|
1489
|
-
|
|
1596
|
+
symbols?: any;
|
|
1490
1597
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1491
1598
|
/**
|
|
1492
|
-
* @tags
|
|
1493
|
-
* @name
|
|
1494
|
-
* @summary
|
|
1495
|
-
* @request GET:/
|
|
1599
|
+
* @tags Quotes
|
|
1600
|
+
* @name Crypto
|
|
1601
|
+
* @summary Crypto
|
|
1602
|
+
* @request GET:/quotes/crypto
|
|
1496
1603
|
* @secure
|
|
1497
1604
|
*/
|
|
1498
|
-
|
|
1499
|
-
|
|
1500
|
-
|
|
1605
|
+
crypto(query?: {
|
|
1606
|
+
/** @example "" */
|
|
1607
|
+
symbols?: any;
|
|
1608
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1609
|
+
/**
|
|
1610
|
+
* @tags Quotes
|
|
1611
|
+
* @name FxRate
|
|
1612
|
+
* @summary FX rate
|
|
1613
|
+
* @request GET:/quotes/fx
|
|
1614
|
+
* @secure
|
|
1615
|
+
*/
|
|
1616
|
+
fxRate(query?: {
|
|
1617
|
+
/** @example "EUR/USD,GBP/USD" */
|
|
1618
|
+
symbols?: any;
|
|
1619
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1620
|
+
}
|
|
1621
|
+
export class ResearchEtfs<HandleError extends boolean = boolean> {
|
|
1501
1622
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
1502
1623
|
constructor(apiClient: JwtClient<HandleError>);
|
|
1503
1624
|
/**
|
|
1504
|
-
* @tags Research
|
|
1505
|
-
* @name
|
|
1506
|
-
* @summary
|
|
1507
|
-
* @request GET:/
|
|
1625
|
+
* @tags Research Etfs
|
|
1626
|
+
* @name InitScreener
|
|
1627
|
+
* @summary Init Screener
|
|
1628
|
+
* @request GET:/research/etf/init
|
|
1508
1629
|
* @secure
|
|
1509
1630
|
*/
|
|
1510
|
-
|
|
1511
|
-
|
|
1512
|
-
|
|
1513
|
-
|
|
1514
|
-
|
|
1515
|
-
|
|
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
|
|
1637
|
+
* @secure
|
|
1638
|
+
*/
|
|
1639
|
+
screener(query?: {
|
|
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;
|
|
1516
1658
|
/**
|
|
1517
|
-
*
|
|
1518
|
-
* @example "
|
|
1659
|
+
* True/false
|
|
1660
|
+
* @example "false"
|
|
1519
1661
|
*/
|
|
1520
|
-
|
|
1662
|
+
loadIndustries?: any;
|
|
1521
1663
|
/**
|
|
1522
|
-
*
|
|
1523
|
-
* @example "
|
|
1664
|
+
* True/false
|
|
1665
|
+
* @example "false"
|
|
1524
1666
|
*/
|
|
1525
|
-
|
|
1667
|
+
loadUpgrades?: any;
|
|
1526
1668
|
/**
|
|
1527
|
-
*
|
|
1528
|
-
* @example "
|
|
1669
|
+
* True/false
|
|
1670
|
+
* @example "false"
|
|
1529
1671
|
*/
|
|
1530
|
-
|
|
1672
|
+
loadEarnings?: any;
|
|
1531
1673
|
/**
|
|
1532
|
-
*
|
|
1533
|
-
*
|
|
1674
|
+
* Repeating set of:
|
|
1675
|
+
* * paying dividend
|
|
1676
|
+
* * 5pct - paying at least 5% dividend
|
|
1677
|
+
* * 3pct
|
|
1678
|
+
* * mcbelow2b – market cap under 2B
|
|
1679
|
+
* * mcbetween2and10b
|
|
1680
|
+
* * mcbetween10and200b
|
|
1681
|
+
* * mcabove200b
|
|
1534
1682
|
*/
|
|
1535
|
-
|
|
1683
|
+
filters?: any;
|
|
1536
1684
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1537
1685
|
/**
|
|
1538
|
-
* @tags Research
|
|
1539
|
-
* @name
|
|
1540
|
-
* @summary
|
|
1541
|
-
* @request GET:/
|
|
1686
|
+
* @tags Research Etfs
|
|
1687
|
+
* @name Top10
|
|
1688
|
+
* @summary Top 10
|
|
1689
|
+
* @request GET:/research/etf/top10
|
|
1542
1690
|
* @secure
|
|
1543
1691
|
*/
|
|
1544
|
-
|
|
1692
|
+
top10(query?: {
|
|
1545
1693
|
/**
|
|
1546
|
-
*
|
|
1547
|
-
* @example "
|
|
1694
|
+
* * see Inverse Types table
|
|
1695
|
+
* @example "ALL"
|
|
1548
1696
|
*/
|
|
1549
|
-
|
|
1697
|
+
inverseType?: any;
|
|
1550
1698
|
/**
|
|
1551
|
-
*
|
|
1552
|
-
* @example "
|
|
1699
|
+
* * see Leverage Types table
|
|
1700
|
+
* @example "LEVERAGE"
|
|
1553
1701
|
*/
|
|
1554
|
-
|
|
1702
|
+
leverageType?: any;
|
|
1703
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1704
|
+
/**
|
|
1705
|
+
* @tags Research Etfs
|
|
1706
|
+
* @name Details
|
|
1707
|
+
* @summary Details
|
|
1708
|
+
* @request GET:/research/etf/details
|
|
1709
|
+
* @secure
|
|
1710
|
+
*/
|
|
1711
|
+
details(query?: {
|
|
1555
1712
|
/**
|
|
1556
|
-
*
|
|
1557
|
-
* @example "
|
|
1713
|
+
* ETF symbol
|
|
1714
|
+
* @example "VXF"
|
|
1558
1715
|
*/
|
|
1559
|
-
|
|
1716
|
+
symbol?: any;
|
|
1717
|
+
/**
|
|
1718
|
+
* Use true to include quotes. Defaults to false.
|
|
1719
|
+
* @example "false"
|
|
1720
|
+
*/
|
|
1721
|
+
loadQuotes?: any;
|
|
1560
1722
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1561
1723
|
/**
|
|
1562
|
-
* @tags Research
|
|
1563
|
-
* @name
|
|
1564
|
-
* @summary
|
|
1565
|
-
* @request GET:/
|
|
1724
|
+
* @tags Research Etfs
|
|
1725
|
+
* @name BreakdownBySector
|
|
1726
|
+
* @summary Breakdown by Sector
|
|
1727
|
+
* @request GET:/research/etf/breakdown
|
|
1566
1728
|
* @secure
|
|
1567
1729
|
*/
|
|
1568
|
-
|
|
1730
|
+
breakdownBySector(query?: {
|
|
1569
1731
|
/**
|
|
1570
|
-
*
|
|
1571
|
-
* @example "
|
|
1732
|
+
* 1d, 1w, 2w, 1m where d is day, w is week, and m is month
|
|
1733
|
+
* @example "1d"
|
|
1572
1734
|
*/
|
|
1573
|
-
|
|
1735
|
+
duration?: any;
|
|
1574
1736
|
/**
|
|
1575
|
-
*
|
|
1576
|
-
* @example "
|
|
1737
|
+
* Amount of ETFs to include per sector. Defaults to 5, max is 10
|
|
1738
|
+
* @example "5"
|
|
1577
1739
|
*/
|
|
1578
|
-
|
|
1740
|
+
displaySize?: any;
|
|
1579
1741
|
/**
|
|
1580
|
-
*
|
|
1581
|
-
* @example "
|
|
1742
|
+
* Exposure to specific sector. Defaults to 90
|
|
1743
|
+
* @example "90"
|
|
1582
1744
|
*/
|
|
1583
|
-
|
|
1745
|
+
exposure?: any;
|
|
1584
1746
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1585
1747
|
}
|
|
1586
|
-
export class
|
|
1748
|
+
export class ResearchAdrs<HandleError extends boolean = boolean> {
|
|
1587
1749
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
1588
1750
|
constructor(apiClient: JwtClient<HandleError>);
|
|
1589
1751
|
/**
|
|
1590
|
-
* @tags Research
|
|
1591
|
-
* @name
|
|
1592
|
-
* @summary
|
|
1593
|
-
* @request GET:/research/
|
|
1752
|
+
* @tags Research Adrs
|
|
1753
|
+
* @name Top10
|
|
1754
|
+
* @summary Top 10
|
|
1755
|
+
* @request GET:/research/adrs/top10
|
|
1594
1756
|
* @secure
|
|
1595
1757
|
*/
|
|
1596
|
-
|
|
1597
|
-
/**
|
|
1598
|
-
|
|
1599
|
-
|
|
1600
|
-
*/
|
|
1758
|
+
top10(query?: {
|
|
1759
|
+
/** See description */
|
|
1760
|
+
country?: any;
|
|
1761
|
+
/** `true` or `false` */
|
|
1601
1762
|
loadQuotes?: any;
|
|
1602
|
-
/**
|
|
1603
|
-
|
|
1604
|
-
/**
|
|
1605
|
-
|
|
1763
|
+
/** `true` or `false` */
|
|
1764
|
+
loadEarningReleases?: any;
|
|
1765
|
+
/** `true` or `false` */
|
|
1766
|
+
loadUpgradesDowngrades?: any;
|
|
1606
1767
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1607
1768
|
/**
|
|
1608
|
-
* @tags Research
|
|
1609
|
-
* @name
|
|
1610
|
-
* @summary
|
|
1611
|
-
* @request GET:/research/
|
|
1769
|
+
* @tags Research Adrs
|
|
1770
|
+
* @name Defaults
|
|
1771
|
+
* @summary Defaults
|
|
1772
|
+
* @request GET:/research/adrs/top10/defaults
|
|
1612
1773
|
* @secure
|
|
1613
1774
|
*/
|
|
1614
|
-
|
|
1775
|
+
defaults(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1615
1776
|
/**
|
|
1616
|
-
* @tags Research
|
|
1617
|
-
* @name
|
|
1618
|
-
* @summary
|
|
1619
|
-
* @request GET:/research/
|
|
1777
|
+
* @tags Research Adrs
|
|
1778
|
+
* @name Search
|
|
1779
|
+
* @summary Search
|
|
1780
|
+
* @request GET:/research/adrs
|
|
1620
1781
|
* @secure
|
|
1621
1782
|
*/
|
|
1622
|
-
|
|
1783
|
+
search(query?: {
|
|
1623
1784
|
/**
|
|
1624
|
-
*
|
|
1625
|
-
* @example "
|
|
1785
|
+
* Country code such as JPN. See `Defaults` endpoint
|
|
1786
|
+
* @example "JPN"
|
|
1626
1787
|
*/
|
|
1788
|
+
country?: any;
|
|
1789
|
+
/** `true` or `false` */
|
|
1627
1790
|
loadQuotes?: any;
|
|
1628
|
-
/**
|
|
1629
|
-
|
|
1630
|
-
|
|
1631
|
-
|
|
1632
|
-
time?: any;
|
|
1633
|
-
/**
|
|
1634
|
-
* shares, day1Ret, ipoRet, last, change, offerSz
|
|
1635
|
-
* @example "day1Ret"
|
|
1636
|
-
*/
|
|
1637
|
-
sort?: any;
|
|
1791
|
+
/** `true` or `false` */
|
|
1792
|
+
loadEarningReleases?: any;
|
|
1793
|
+
/** `true` or `false` */
|
|
1794
|
+
loadUpgradesDowngrades?: any;
|
|
1638
1795
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1639
1796
|
}
|
|
1640
|
-
export class
|
|
1797
|
+
export class ResearchCorporateActions<HandleError extends boolean = boolean> {
|
|
1641
1798
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
1642
|
-
tipranks: ResearchTipranks<HandleError>;
|
|
1643
|
-
etfs: ResearchEtfs<HandleError>;
|
|
1644
|
-
adrs: ResearchAdrs<HandleError>;
|
|
1645
|
-
corporateActions: ResearchCorporateActions<HandleError>;
|
|
1646
|
-
news: ResearchNews<HandleError>;
|
|
1647
|
-
alphaTools: ResearchAlphaTools<HandleError>;
|
|
1648
|
-
ipos: ResearchIpos<HandleError>;
|
|
1649
1799
|
constructor(apiClient: JwtClient<HandleError>);
|
|
1650
1800
|
/**
|
|
1651
|
-
* @tags Research
|
|
1652
|
-
* @name
|
|
1653
|
-
* @summary
|
|
1654
|
-
* @request GET:/
|
|
1801
|
+
* @tags Research Corporate Actions
|
|
1802
|
+
* @name Types
|
|
1803
|
+
* @summary Types
|
|
1804
|
+
* @request GET:/research/actions/types
|
|
1655
1805
|
* @secure
|
|
1656
1806
|
*/
|
|
1657
|
-
|
|
1658
|
-
/**
|
|
1659
|
-
* See table above
|
|
1660
|
-
* @example "BIG3"
|
|
1661
|
-
*/
|
|
1662
|
-
market?: any;
|
|
1663
|
-
/**
|
|
1664
|
-
* See table above
|
|
1665
|
-
* @example "H"
|
|
1666
|
-
*/
|
|
1667
|
-
order?: any;
|
|
1668
|
-
/**
|
|
1669
|
-
* Optional. Defaults to 10
|
|
1670
|
-
* @example "10"
|
|
1671
|
-
*/
|
|
1672
|
-
count?: any;
|
|
1673
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1807
|
+
types(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1674
1808
|
/**
|
|
1675
|
-
* @tags Research
|
|
1676
|
-
* @name
|
|
1677
|
-
* @summary
|
|
1678
|
-
* @request GET:/research/
|
|
1809
|
+
* @tags Research Corporate Actions
|
|
1810
|
+
* @name PaymentTypes
|
|
1811
|
+
* @summary Payment types
|
|
1812
|
+
* @request GET:/research/actions/paymentTypes
|
|
1679
1813
|
* @secure
|
|
1680
1814
|
*/
|
|
1681
|
-
|
|
1815
|
+
paymentTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1682
1816
|
/**
|
|
1683
|
-
* @tags Research
|
|
1684
|
-
* @name
|
|
1685
|
-
* @summary
|
|
1686
|
-
* @request GET:/research/
|
|
1817
|
+
* @tags Research Corporate Actions
|
|
1818
|
+
* @name Search
|
|
1819
|
+
* @summary Search
|
|
1820
|
+
* @request GET:/research/actions/search
|
|
1687
1821
|
* @secure
|
|
1688
1822
|
*/
|
|
1689
|
-
|
|
1823
|
+
search(query?: {
|
|
1690
1824
|
/**
|
|
1691
|
-
*
|
|
1692
|
-
* @example "
|
|
1825
|
+
* Old or new symbol (multiple tickers separated by comma)
|
|
1826
|
+
* @example "{symbol}"
|
|
1693
1827
|
*/
|
|
1694
|
-
|
|
1828
|
+
symbol?: any;
|
|
1829
|
+
/**
|
|
1830
|
+
* Defaults to today's date in America/New_York timezone.
|
|
1831
|
+
* @example "{date}"
|
|
1832
|
+
*/
|
|
1833
|
+
dateFrom?: any;
|
|
1834
|
+
/** @example "{date}" */
|
|
1835
|
+
dateTo?: any;
|
|
1836
|
+
/**
|
|
1837
|
+
* (separate multiple types with comma)
|
|
1838
|
+
* @example "{type}"
|
|
1839
|
+
*/
|
|
1840
|
+
type?: any;
|
|
1841
|
+
/**
|
|
1842
|
+
* (search for Dividends using payment date instead of ex-date)
|
|
1843
|
+
* @example "false"
|
|
1844
|
+
*/
|
|
1845
|
+
usePayDate?: any;
|
|
1695
1846
|
}, 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>);
|
|
1696
1851
|
/**
|
|
1697
|
-
* @tags Research
|
|
1698
|
-
* @name
|
|
1699
|
-
* @summary
|
|
1700
|
-
* @request GET:/research/
|
|
1852
|
+
* @tags Research News
|
|
1853
|
+
* @name List
|
|
1854
|
+
* @summary List
|
|
1855
|
+
* @request GET:/research/news
|
|
1701
1856
|
* @secure
|
|
1702
1857
|
*/
|
|
1703
|
-
|
|
1858
|
+
list(query?: {
|
|
1859
|
+
/** @example "0" */
|
|
1860
|
+
start?: any;
|
|
1704
1861
|
/**
|
|
1705
|
-
*
|
|
1706
|
-
* @example ""
|
|
1862
|
+
* Defaults to 20
|
|
1863
|
+
* @example "100"
|
|
1707
1864
|
*/
|
|
1865
|
+
count?: any;
|
|
1866
|
+
/** @example "[[-](provider|aggregator):value1,valueN];" */
|
|
1708
1867
|
filter?: any;
|
|
1709
1868
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1710
1869
|
/**
|
|
1711
|
-
* @tags Research
|
|
1712
|
-
* @name
|
|
1713
|
-
* @summary
|
|
1714
|
-
* @request GET:/research/
|
|
1870
|
+
* @tags Research News
|
|
1871
|
+
* @name NewsBySymbol
|
|
1872
|
+
* @summary News by Symbol
|
|
1873
|
+
* @request GET:/research/news/ticker/{symbol}
|
|
1715
1874
|
* @secure
|
|
1716
1875
|
*/
|
|
1717
|
-
|
|
1876
|
+
newsBySymbol(symbol: string, query?: {
|
|
1718
1877
|
/**
|
|
1719
|
-
*
|
|
1720
|
-
* @example "
|
|
1878
|
+
* Starting page (optional)
|
|
1879
|
+
* @example ""
|
|
1721
1880
|
*/
|
|
1722
|
-
|
|
1881
|
+
start?: any;
|
|
1882
|
+
/** Defaults to 20 (optional) */
|
|
1883
|
+
count?: any;
|
|
1723
1884
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1724
1885
|
/**
|
|
1725
|
-
* @tags Research
|
|
1726
|
-
* @name
|
|
1727
|
-
* @summary
|
|
1728
|
-
* @request GET:/research/
|
|
1886
|
+
* @tags Research News
|
|
1887
|
+
* @name Sec
|
|
1888
|
+
* @summary SEC
|
|
1889
|
+
* @request GET:/research/news/sec/{symbol}
|
|
1729
1890
|
* @secure
|
|
1730
1891
|
*/
|
|
1731
|
-
|
|
1892
|
+
sec(symbol: string, query?: {
|
|
1732
1893
|
/**
|
|
1733
|
-
*
|
|
1734
|
-
* @example "
|
|
1894
|
+
* Starting point(optional)
|
|
1895
|
+
* @example "0"
|
|
1735
1896
|
*/
|
|
1736
|
-
|
|
1897
|
+
start?: any;
|
|
1898
|
+
/**
|
|
1899
|
+
* Defaults to 20 (optional)
|
|
1900
|
+
* @example "2"
|
|
1901
|
+
*/
|
|
1902
|
+
count?: any;
|
|
1737
1903
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1738
1904
|
/**
|
|
1739
|
-
* @tags Research
|
|
1740
|
-
* @name
|
|
1741
|
-
* @summary
|
|
1742
|
-
* @request GET:/research/
|
|
1905
|
+
* @tags Research News
|
|
1906
|
+
* @name Lookup
|
|
1907
|
+
* @summary Lookup
|
|
1908
|
+
* @request GET:/research/news/{newsId}
|
|
1743
1909
|
* @secure
|
|
1744
1910
|
*/
|
|
1745
|
-
|
|
1911
|
+
lookup(newsId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1912
|
+
}
|
|
1913
|
+
export class ResearchAlphaTools<HandleError extends boolean = boolean> {
|
|
1914
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
1915
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
1916
|
+
/**
|
|
1917
|
+
* @tags Research Alpha Tools
|
|
1918
|
+
* @name AlphaTracker
|
|
1919
|
+
* @summary Alpha Tracker
|
|
1920
|
+
* @request GET:/quotes/rst
|
|
1921
|
+
* @secure
|
|
1922
|
+
*/
|
|
1923
|
+
alphaTracker(query?: {
|
|
1746
1924
|
/**
|
|
1747
|
-
*
|
|
1748
|
-
* @example "
|
|
1925
|
+
* Takes one symbol for the benchmark
|
|
1926
|
+
* @example "SPY"
|
|
1749
1927
|
*/
|
|
1750
|
-
|
|
1928
|
+
benchmark?: any;
|
|
1751
1929
|
/**
|
|
1752
|
-
*
|
|
1753
|
-
* @example "
|
|
1930
|
+
* Comma seperated list of symbols
|
|
1931
|
+
* @example "AAPL,GOOG"
|
|
1754
1932
|
*/
|
|
1755
|
-
|
|
1933
|
+
symbols?: any;
|
|
1756
1934
|
/**
|
|
1757
|
-
*
|
|
1758
|
-
* @example "
|
|
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"
|
|
1759
1937
|
*/
|
|
1760
|
-
|
|
1938
|
+
range?: any;
|
|
1761
1939
|
/**
|
|
1762
|
-
*
|
|
1763
|
-
* @example "
|
|
1940
|
+
* A number between 4-10 can be selected for the period. Defaults to 4
|
|
1941
|
+
* @example "180"
|
|
1764
1942
|
*/
|
|
1765
|
-
|
|
1943
|
+
period?: any;
|
|
1766
1944
|
/**
|
|
1767
|
-
*
|
|
1768
|
-
* @example "
|
|
1945
|
+
* Set `true` or `false` to enable exponential moving average. Optional. Defaults to false.
|
|
1946
|
+
* @example "true"
|
|
1769
1947
|
*/
|
|
1770
|
-
|
|
1948
|
+
setEMA?: any;
|
|
1771
1949
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1772
1950
|
/**
|
|
1773
|
-
* @tags Research
|
|
1774
|
-
* @name
|
|
1775
|
-
* @summary
|
|
1776
|
-
* @request GET:/
|
|
1951
|
+
* @tags Research Alpha Tools
|
|
1952
|
+
* @name Seasonality
|
|
1953
|
+
* @summary Seasonality
|
|
1954
|
+
* @request GET:/quotes/seasonality
|
|
1777
1955
|
* @secure
|
|
1778
1956
|
*/
|
|
1779
|
-
|
|
1957
|
+
seasonality(query?: {
|
|
1780
1958
|
/**
|
|
1781
|
-
* Comma separated list of
|
|
1782
|
-
* @example "
|
|
1959
|
+
* Comma separated list of symbols
|
|
1960
|
+
* @example "AAPL,IBM,GOOG,TSLA"
|
|
1783
1961
|
*/
|
|
1784
|
-
|
|
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;
|
|
1785
1973
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1786
1974
|
/**
|
|
1787
|
-
* @tags Research
|
|
1788
|
-
* @name
|
|
1789
|
-
* @summary
|
|
1790
|
-
* @request GET:/
|
|
1975
|
+
* @tags Research Alpha Tools
|
|
1976
|
+
* @name WeeklySeasonality
|
|
1977
|
+
* @summary Weekly Seasonality
|
|
1978
|
+
* @request GET:/quotes/seasonality/weekly
|
|
1791
1979
|
* @secure
|
|
1792
1980
|
*/
|
|
1793
|
-
|
|
1981
|
+
weeklySeasonality(query?: {
|
|
1794
1982
|
/**
|
|
1795
|
-
*
|
|
1796
|
-
* @example "
|
|
1983
|
+
* Comma separated list of symbols
|
|
1984
|
+
* @example "AAPL,IBM,GOOG,TSLA"
|
|
1797
1985
|
*/
|
|
1798
|
-
|
|
1986
|
+
symbols?: any;
|
|
1799
1987
|
/**
|
|
1800
|
-
*
|
|
1801
|
-
* @example "
|
|
1988
|
+
* The benchmark to compare the list of symbols to
|
|
1989
|
+
* @example "SPY"
|
|
1802
1990
|
*/
|
|
1803
|
-
|
|
1991
|
+
benchmark?: any;
|
|
1804
1992
|
/**
|
|
1805
|
-
*
|
|
1806
|
-
* @example "
|
|
1993
|
+
* Defaults to 10. Cannot be less than 3.
|
|
1994
|
+
* @example "5"
|
|
1807
1995
|
*/
|
|
1808
|
-
|
|
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?: {
|
|
1809
2010
|
/**
|
|
1810
|
-
*
|
|
1811
|
-
* @example "
|
|
2011
|
+
* `true` or `false` to load quotes
|
|
2012
|
+
* @example ""
|
|
1812
2013
|
*/
|
|
1813
|
-
|
|
2014
|
+
loadQuotes?: any;
|
|
2015
|
+
/** 1m, 3m*, 6m, 1y */
|
|
2016
|
+
time?: any;
|
|
2017
|
+
/** symbol, ipoDate, offerPx, shares, day1Ret, ipoRet, last, change, offerSz */
|
|
2018
|
+
sort?: any;
|
|
1814
2019
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1815
2020
|
/**
|
|
1816
|
-
* @tags Research
|
|
1817
|
-
* @name
|
|
1818
|
-
* @summary
|
|
1819
|
-
* @request GET:/research/
|
|
2021
|
+
* @tags Research Ipos
|
|
2022
|
+
* @name Upcoming
|
|
2023
|
+
* @summary Upcoming
|
|
2024
|
+
* @request GET:/research/ipo/upcoming
|
|
1820
2025
|
* @secure
|
|
1821
2026
|
*/
|
|
1822
|
-
|
|
2027
|
+
upcoming(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1823
2028
|
/**
|
|
1824
|
-
* @tags Research
|
|
1825
|
-
* @name
|
|
1826
|
-
* @summary
|
|
1827
|
-
* @request GET:/research/
|
|
2029
|
+
* @tags Research Ipos
|
|
2030
|
+
* @name Performance
|
|
2031
|
+
* @summary Performance
|
|
2032
|
+
* @request GET:/research/ipo/performance
|
|
1828
2033
|
* @secure
|
|
1829
2034
|
*/
|
|
1830
|
-
|
|
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;
|
|
2164
|
+
/**
|
|
2165
|
+
* One of `ALL`, `INSTITUTIONAL`, `FUND`, `INSIDER`
|
|
2166
|
+
* @example "ALL"
|
|
2167
|
+
*/
|
|
2168
|
+
filter?: any;
|
|
2169
|
+
/**
|
|
2170
|
+
* One of `portfolio`, `ownership`, `market`
|
|
2171
|
+
* @example "portfolio"
|
|
2172
|
+
*/
|
|
2173
|
+
sort?: any;
|
|
2174
|
+
/**
|
|
2175
|
+
* Number of items per page
|
|
2176
|
+
* @example "20"
|
|
2177
|
+
*/
|
|
2178
|
+
count?: any;
|
|
2179
|
+
/**
|
|
2180
|
+
* Page num (first page is zero)
|
|
2181
|
+
* @example "0"
|
|
2182
|
+
*/
|
|
2183
|
+
page?: any;
|
|
2184
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2185
|
+
/**
|
|
2186
|
+
* @tags Research
|
|
2187
|
+
* @name OwnerDetails
|
|
2188
|
+
* @summary Owner Details
|
|
2189
|
+
* @request GET:/research/owner/details
|
|
2190
|
+
* @secure
|
|
2191
|
+
*/
|
|
2192
|
+
ownerDetails(query?: {
|
|
2193
|
+
/**
|
|
2194
|
+
* Comma separated list of owner IDs
|
|
2195
|
+
* @example "PS000000YH,PS000004TI"
|
|
2196
|
+
*/
|
|
2197
|
+
ids?: any;
|
|
2198
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2199
|
+
/**
|
|
2200
|
+
* @tags Research
|
|
2201
|
+
* @name EarningsCalendar
|
|
2202
|
+
* @summary Earnings Calendar
|
|
2203
|
+
* @request GET:/research/earnings
|
|
2204
|
+
* @secure
|
|
2205
|
+
*/
|
|
2206
|
+
earningsCalendar(query?: {
|
|
2207
|
+
/**
|
|
2208
|
+
* (Optional) Exclude Otcs from data.
|
|
2209
|
+
* @example "true"
|
|
2210
|
+
*/
|
|
2211
|
+
excludeOtcs?: any;
|
|
2212
|
+
/**
|
|
2213
|
+
* (Optional) Number of days in the future. Default is 7.
|
|
2214
|
+
* @example "90"
|
|
2215
|
+
*/
|
|
2216
|
+
days?: any;
|
|
2217
|
+
/**
|
|
2218
|
+
* `true`|`false`
|
|
2219
|
+
* @example "false"
|
|
2220
|
+
*/
|
|
2221
|
+
loadQuotes?: any;
|
|
2222
|
+
/**
|
|
2223
|
+
* (Optional) Use to filter results only to selected symbols. Excluding this parameter gives all upcoming earnings.
|
|
2224
|
+
* @example "AAPL,T,GOOGL"
|
|
2225
|
+
*/
|
|
2226
|
+
symbols?: any;
|
|
2227
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2228
|
+
/**
|
|
2229
|
+
* @tags Research
|
|
2230
|
+
* @name Fundamentals
|
|
2231
|
+
* @summary Fundamentals
|
|
2232
|
+
* @request GET:/research/fundamentals/{type}/{symbol}
|
|
2233
|
+
* @secure
|
|
2234
|
+
*/
|
|
2235
|
+
fundamentals(type: string, symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2236
|
+
/**
|
|
2237
|
+
* @tags Research
|
|
2238
|
+
* @name FundamentalTypes
|
|
2239
|
+
* @summary Fundamental Types
|
|
2240
|
+
* @request GET:/research/fundamentals/types
|
|
2241
|
+
* @secure
|
|
2242
|
+
*/
|
|
2243
|
+
fundamentalTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1831
2244
|
/**
|
|
1832
2245
|
* @tags Research
|
|
1833
2246
|
* @name Screener
|
|
@@ -1909,508 +2322,22 @@ export class Research<HandleError extends boolean = boolean> {
|
|
|
1909
2322
|
dates?: any;
|
|
1910
2323
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1911
2324
|
}
|
|
1912
|
-
export class
|
|
2325
|
+
export class UserAgreements<HandleError extends boolean = boolean> {
|
|
1913
2326
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
1914
|
-
violationManagement: OrdersViolationManagement<HandleError>;
|
|
1915
|
-
archived: OrdersArchived<HandleError>;
|
|
1916
|
-
v2: OrdersV2<HandleError>;
|
|
1917
2327
|
constructor(apiClient: JwtClient<HandleError>);
|
|
1918
2328
|
/**
|
|
1919
|
-
* @tags
|
|
1920
|
-
* @name
|
|
1921
|
-
* @summary
|
|
1922
|
-
* @request GET:/
|
|
2329
|
+
* @tags User Agreements
|
|
2330
|
+
* @name Available
|
|
2331
|
+
* @summary Available
|
|
2332
|
+
* @request GET:/user/agreements/all/active
|
|
1923
2333
|
* @secure
|
|
1924
2334
|
*/
|
|
1925
|
-
|
|
1926
|
-
/**
|
|
1927
|
-
* `true|false` (optional)
|
|
1928
|
-
* @example "false"
|
|
1929
|
-
*/
|
|
1930
|
-
loadQuotes?: any;
|
|
1931
|
-
/** Account ID (optional) */
|
|
1932
|
-
accountId?: any;
|
|
1933
|
-
/** Account number (optional) */
|
|
1934
|
-
account?: any;
|
|
1935
|
-
/** Ticker symbol (optional) */
|
|
1936
|
-
symbol?: any;
|
|
1937
|
-
/**
|
|
1938
|
-
* Return bond pricing type in `Percentage|Decimal` (optional)
|
|
1939
|
-
* @example "Decimal"
|
|
1940
|
-
*/
|
|
1941
|
-
bondPriceType?: any;
|
|
1942
|
-
/**
|
|
1943
|
-
* Return bond quantity in `Par|Unit` (optional)
|
|
1944
|
-
* @example "Par"
|
|
1945
|
-
*/
|
|
1946
|
-
bondQuantityType?: any;
|
|
1947
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2335
|
+
available(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1948
2336
|
/**
|
|
1949
|
-
* @tags
|
|
1950
|
-
* @name
|
|
1951
|
-
* @summary
|
|
1952
|
-
* @request GET:/
|
|
1953
|
-
* @secure
|
|
1954
|
-
*/
|
|
1955
|
-
listingForModel(modelId: string, type: string, query?: {
|
|
1956
|
-
/**
|
|
1957
|
-
* true|false
|
|
1958
|
-
* @example "false"
|
|
1959
|
-
*/
|
|
1960
|
-
loadQuotes?: any;
|
|
1961
|
-
/**
|
|
1962
|
-
* Return bond pricing type in `Percentage|Decimal` (optional)
|
|
1963
|
-
* @example "Decimal"
|
|
1964
|
-
*/
|
|
1965
|
-
bondPriceType?: any;
|
|
1966
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1967
|
-
/**
|
|
1968
|
-
* @tags Orders
|
|
1969
|
-
* @name ListingForBranch
|
|
1970
|
-
* @summary Listing for branch
|
|
1971
|
-
* @request GET:/orders/branch/{type}
|
|
1972
|
-
* @secure
|
|
1973
|
-
*/
|
|
1974
|
-
listingForBranch(type: string, query?: {
|
|
1975
|
-
/** Return bond pricing type in `Percentage|Decimal` (optional) */
|
|
1976
|
-
bondPriceType?: any;
|
|
1977
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1978
|
-
/**
|
|
1979
|
-
* @tags Orders
|
|
1980
|
-
* @name Status
|
|
1981
|
-
* @summary Status
|
|
1982
|
-
* @request GET:/orders/status/{orderRef}
|
|
1983
|
-
* @secure
|
|
1984
|
-
*/
|
|
1985
|
-
status(orderRef: string, query?: {
|
|
1986
|
-
/** [optional] `true` or `false` to load quotes */
|
|
1987
|
-
loadQuotes?: any;
|
|
1988
|
-
/** [optional] Account number order belongs to */
|
|
1989
|
-
account?: any;
|
|
1990
|
-
/** [optional] AccountId as known in the system */
|
|
1991
|
-
accountId?: any;
|
|
1992
|
-
/**
|
|
1993
|
-
* Return bond quantity in `Par|Unit` (optional)
|
|
1994
|
-
* @example "Decimal"
|
|
1995
|
-
*/
|
|
1996
|
-
bondPriceType?: any;
|
|
1997
|
-
/**
|
|
1998
|
-
* Return bond quantity in `Par|Unit` (optional)
|
|
1999
|
-
* @example "Par"
|
|
2000
|
-
*/
|
|
2001
|
-
bondQuantityType?: any;
|
|
2002
|
-
/**
|
|
2003
|
-
* [optional] Specifies market code for the order
|
|
2004
|
-
* @example "U"
|
|
2005
|
-
*/
|
|
2006
|
-
market?: any;
|
|
2007
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2008
|
-
/**
|
|
2009
|
-
* @tags Orders
|
|
2010
|
-
* @name OrderLookup
|
|
2011
|
-
* @summary Order lookup
|
|
2012
|
-
* @request GET:/orders/lookup
|
|
2013
|
-
* @secure
|
|
2014
|
-
*/
|
|
2015
|
-
orderLookup(query?: {
|
|
2016
|
-
/**
|
|
2017
|
-
* Required
|
|
2018
|
-
* @example "{your order reference}"
|
|
2019
|
-
*/
|
|
2020
|
-
clientRef?: any;
|
|
2021
|
-
/**
|
|
2022
|
-
* `true|false` (optional)
|
|
2023
|
-
* @example "false"
|
|
2024
|
-
*/
|
|
2025
|
-
loadQuotes?: any;
|
|
2026
|
-
/**
|
|
2027
|
-
* Return bond pricing type in `Percentage|Decimal` (optional)
|
|
2028
|
-
* @example "Decimal"
|
|
2029
|
-
*/
|
|
2030
|
-
bondPriceType?: any;
|
|
2031
|
-
/**
|
|
2032
|
-
* Return bond quantity in `Par|Unit` (optional)
|
|
2033
|
-
* @example "Par"
|
|
2034
|
-
*/
|
|
2035
|
-
bondQuantityType?: any;
|
|
2036
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2037
|
-
}
|
|
2038
|
-
export class Quotes<HandleError extends boolean = boolean> {
|
|
2039
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2040
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2041
|
-
/**
|
|
2042
|
-
* @tags Quotes
|
|
2043
|
-
* @name Equity
|
|
2044
|
-
* @summary Equity
|
|
2045
|
-
* @request GET:/quotes/equity
|
|
2046
|
-
* @secure
|
|
2047
|
-
*/
|
|
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>>;
|
|
2055
|
-
/**
|
|
2056
|
-
* @tags Quotes
|
|
2057
|
-
* @name Search
|
|
2058
|
-
* @summary Search
|
|
2059
|
-
* @request GET:/quotes/search
|
|
2060
|
-
* @secure
|
|
2061
|
-
*/
|
|
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>>;
|
|
2079
|
-
/**
|
|
2080
|
-
* @tags Quotes
|
|
2081
|
-
* @name Option
|
|
2082
|
-
* @summary Option
|
|
2083
|
-
* @request GET:/quotes/option
|
|
2084
|
-
* @secure
|
|
2085
|
-
*/
|
|
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>>;
|
|
2095
|
-
/**
|
|
2096
|
-
* @tags Quotes
|
|
2097
|
-
* @name OptionPricingType
|
|
2098
|
-
* @summary Option pricing type
|
|
2099
|
-
* @request GET:/quotes/option/pricing/type
|
|
2100
|
-
* @secure
|
|
2101
|
-
*/
|
|
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>>;
|
|
2119
|
-
/**
|
|
2120
|
-
* @tags Quotes
|
|
2121
|
-
* @name Bonds
|
|
2122
|
-
* @summary Bonds
|
|
2123
|
-
* @request GET:/quotes/bonds
|
|
2124
|
-
* @secure
|
|
2125
|
-
*/
|
|
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>>;
|
|
2138
|
-
/**
|
|
2139
|
-
* @tags Quotes
|
|
2140
|
-
* @name BondsSearch
|
|
2141
|
-
* @summary Bonds Search
|
|
2142
|
-
* @request GET:/quotes/bonds/search
|
|
2143
|
-
* @secure
|
|
2144
|
-
*/
|
|
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>>;
|
|
2153
|
-
/**
|
|
2154
|
-
* @tags Quotes
|
|
2155
|
-
* @name Historical
|
|
2156
|
-
* @summary Historical
|
|
2157
|
-
* @request GET:/quotes/equity/historical
|
|
2158
|
-
* @secure
|
|
2159
|
-
*/
|
|
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>>;
|
|
2183
|
-
/**
|
|
2184
|
-
* @tags Quotes
|
|
2185
|
-
* @name IntradayChartData
|
|
2186
|
-
* @summary Intraday chart data
|
|
2187
|
-
* @request GET:/quotes/equity/intraday
|
|
2188
|
-
* @secure
|
|
2189
|
-
*/
|
|
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;
|
|
2207
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2208
|
-
/**
|
|
2209
|
-
* @tags Quotes
|
|
2210
|
-
* @name EquityTicks
|
|
2211
|
-
* @summary Equity Ticks
|
|
2212
|
-
* @request GET:/quotes/equity/ticks
|
|
2213
|
-
* @secure
|
|
2214
|
-
*/
|
|
2215
|
-
equityTicks(query?: {
|
|
2216
|
-
/**
|
|
2217
|
-
* Ticker
|
|
2218
|
-
* @example "GOOG"
|
|
2219
|
-
*/
|
|
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;
|
|
2231
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2232
|
-
/**
|
|
2233
|
-
* @tags Quotes
|
|
2234
|
-
* @name Shortability
|
|
2235
|
-
* @summary Shortability
|
|
2236
|
-
* @request GET:/quotes/equity/shortability/{symbol}
|
|
2237
|
-
* @secure
|
|
2238
|
-
*/
|
|
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?: {
|
|
2248
|
-
/**
|
|
2249
|
-
* Equity ticker
|
|
2250
|
-
* @example "TSLA"
|
|
2251
|
-
*/
|
|
2252
|
-
symbol?: any;
|
|
2253
|
-
/**
|
|
2254
|
-
* Account number requesting the information
|
|
2255
|
-
* @example "AB654321"
|
|
2256
|
-
*/
|
|
2257
|
-
account?: any;
|
|
2258
|
-
accountId?: any;
|
|
2259
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2260
|
-
/**
|
|
2261
|
-
* @tags Quotes
|
|
2262
|
-
* @name OptionChainDates
|
|
2263
|
-
* @summary Option chain (dates)
|
|
2264
|
-
* @request GET:/quotes/option/chain/dates/{symbol}
|
|
2265
|
-
* @secure
|
|
2266
|
-
*/
|
|
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 UserWatchlists<HandleError extends boolean = boolean> {
|
|
2326
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2327
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2328
|
-
/**
|
|
2329
|
-
* @tags User Watchlists
|
|
2330
|
-
* @name CreateWatchlist
|
|
2331
|
-
* @summary Create Watchlist
|
|
2332
|
-
* @request POST:/user/v2/watchlist/create
|
|
2333
|
-
* @secure
|
|
2334
|
-
*/
|
|
2335
|
-
createWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2336
|
-
/**
|
|
2337
|
-
* @tags User Watchlists
|
|
2338
|
-
* @name RenameWatchlist
|
|
2339
|
-
* @summary Rename Watchlist
|
|
2340
|
-
* @request POST:/user/v2/watchlist/rename
|
|
2341
|
-
* @secure
|
|
2342
|
-
*/
|
|
2343
|
-
renameWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2344
|
-
/**
|
|
2345
|
-
* @tags User Watchlists
|
|
2346
|
-
* @name DeleteWatchlist
|
|
2347
|
-
* @summary Delete Watchlist
|
|
2348
|
-
* @request POST:/user/v2/watchlist/delete
|
|
2349
|
-
* @secure
|
|
2350
|
-
*/
|
|
2351
|
-
deleteWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2352
|
-
/**
|
|
2353
|
-
* @tags User Watchlists
|
|
2354
|
-
* @name AddToWatchlist
|
|
2355
|
-
* @summary Add to Watchlist
|
|
2356
|
-
* @request POST:/user/v2/watchlist/addEntry
|
|
2357
|
-
* @secure
|
|
2358
|
-
*/
|
|
2359
|
-
addToWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2360
|
-
/**
|
|
2361
|
-
* @tags User Watchlists
|
|
2362
|
-
* @name RemoveFromWatchlist
|
|
2363
|
-
* @summary Remove from Watchlist
|
|
2364
|
-
* @request POST:/user/v2/watchlist/removeEntry
|
|
2365
|
-
* @secure
|
|
2366
|
-
*/
|
|
2367
|
-
removeFromWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2368
|
-
}
|
|
2369
|
-
export class UserTradingLimitManagement<HandleError extends boolean = boolean> {
|
|
2370
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2371
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2372
|
-
/**
|
|
2373
|
-
* @tags User Trading Limit Management
|
|
2374
|
-
* @name Update
|
|
2375
|
-
* @summary Update
|
|
2376
|
-
* @request POST:/user/balance/adjust
|
|
2377
|
-
* @secure
|
|
2378
|
-
*/
|
|
2379
|
-
update(data: {
|
|
2380
|
-
account?: {
|
|
2381
|
-
/** @example "AB123456" */
|
|
2382
|
-
accountNumber?: string;
|
|
2383
|
-
};
|
|
2384
|
-
/** @example 100 */
|
|
2385
|
-
adjustment?: any;
|
|
2386
|
-
/** @example "USD" */
|
|
2387
|
-
currency?: any;
|
|
2388
|
-
/** @example "something nice" */
|
|
2389
|
-
note?: any;
|
|
2390
|
-
/** @example "tbd" */
|
|
2391
|
-
reason?: any;
|
|
2392
|
-
/** @example "" */
|
|
2393
|
-
referenceNo?: any;
|
|
2394
|
-
/** @example "Delta|Absolute" */
|
|
2395
|
-
type?: any;
|
|
2396
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2397
|
-
}
|
|
2398
|
-
export class UserAgreements<HandleError extends boolean = boolean> {
|
|
2399
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2400
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2401
|
-
/**
|
|
2402
|
-
* @tags User Agreements
|
|
2403
|
-
* @name Available
|
|
2404
|
-
* @summary Available
|
|
2405
|
-
* @request GET:/user/agreements/all/active
|
|
2406
|
-
* @secure
|
|
2407
|
-
*/
|
|
2408
|
-
available(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2409
|
-
/**
|
|
2410
|
-
* @tags User Agreements
|
|
2411
|
-
* @name Agreement
|
|
2412
|
-
* @summary Agreement
|
|
2413
|
-
* @request GET:/user/agreements/contents/{version}/{code}/body.html
|
|
2337
|
+
* @tags User Agreements
|
|
2338
|
+
* @name Agreement
|
|
2339
|
+
* @summary Agreement
|
|
2340
|
+
* @request GET:/user/agreements/contents/{version}/{code}/body.html
|
|
2414
2341
|
* @secure
|
|
2415
2342
|
*/
|
|
2416
2343
|
agreement(version: string, code: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
@@ -2455,6 +2382,35 @@ export class UserAgreements<HandleError extends boolean = boolean> {
|
|
|
2455
2382
|
*/
|
|
2456
2383
|
cryptoSign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2457
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
|
+
}
|
|
2458
2414
|
export class UserAttachedBanks<HandleError extends boolean = boolean> {
|
|
2459
2415
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2460
2416
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -2528,6 +2484,50 @@ export class UserProfitLoss<HandleError extends boolean = boolean> {
|
|
|
2528
2484
|
requestId?: any;
|
|
2529
2485
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2530
2486
|
}
|
|
2487
|
+
export class UserWatchlists<HandleError extends boolean = boolean> {
|
|
2488
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2489
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2490
|
+
/**
|
|
2491
|
+
* @tags User Watchlists
|
|
2492
|
+
* @name CreateWatchlist
|
|
2493
|
+
* @summary Create Watchlist
|
|
2494
|
+
* @request POST:/user/v2/watchlist/create
|
|
2495
|
+
* @secure
|
|
2496
|
+
*/
|
|
2497
|
+
createWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2498
|
+
/**
|
|
2499
|
+
* @tags User Watchlists
|
|
2500
|
+
* @name RenameWatchlist
|
|
2501
|
+
* @summary Rename Watchlist
|
|
2502
|
+
* @request POST:/user/v2/watchlist/rename
|
|
2503
|
+
* @secure
|
|
2504
|
+
*/
|
|
2505
|
+
renameWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2506
|
+
/**
|
|
2507
|
+
* @tags User Watchlists
|
|
2508
|
+
* @name DeleteWatchlist
|
|
2509
|
+
* @summary Delete Watchlist
|
|
2510
|
+
* @request POST:/user/v2/watchlist/delete
|
|
2511
|
+
* @secure
|
|
2512
|
+
*/
|
|
2513
|
+
deleteWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2514
|
+
/**
|
|
2515
|
+
* @tags User Watchlists
|
|
2516
|
+
* @name AddToWatchlist
|
|
2517
|
+
* @summary Add to Watchlist
|
|
2518
|
+
* @request POST:/user/v2/watchlist/addEntry
|
|
2519
|
+
* @secure
|
|
2520
|
+
*/
|
|
2521
|
+
addToWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2522
|
+
/**
|
|
2523
|
+
* @tags User Watchlists
|
|
2524
|
+
* @name RemoveFromWatchlist
|
|
2525
|
+
* @summary Remove from Watchlist
|
|
2526
|
+
* @request POST:/user/v2/watchlist/removeEntry
|
|
2527
|
+
* @secure
|
|
2528
|
+
*/
|
|
2529
|
+
removeFromWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2530
|
+
}
|
|
2531
2531
|
export class UserDevice<HandleError extends boolean = boolean> {
|
|
2532
2532
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2533
2533
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -3223,157 +3223,26 @@ export class AdvisoryCharges<HandleError extends boolean = boolean> {
|
|
|
3223
3223
|
/**
|
|
3224
3224
|
* @tags Advisory Charges
|
|
3225
3225
|
* @name Apply
|
|
3226
|
-
* @summary /apply
|
|
3227
|
-
* @request POST:/v2/charges/apply
|
|
3228
|
-
* @secure
|
|
3229
|
-
*/
|
|
3230
|
-
apply(data: {
|
|
3231
|
-
/** @example 1234 */
|
|
3232
|
-
accountId?: any;
|
|
3233
|
-
/** @example 7.11 */
|
|
3234
|
-
amount?: any;
|
|
3235
|
-
/** @example "{timestamp}" */
|
|
3236
|
-
date?: any;
|
|
3237
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3238
|
-
/**
|
|
3239
|
-
* @tags Advisory Charges
|
|
3240
|
-
* @name Cancel
|
|
3241
|
-
* @summary /cancel
|
|
3242
|
-
* @request POST:/v2/charges/cancel
|
|
3243
|
-
* @secure
|
|
3244
|
-
*/
|
|
3245
|
-
cancel(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3246
|
-
}
|
|
3247
|
-
export class AdvisoryGroups<HandleError extends boolean = boolean> {
|
|
3248
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3249
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3250
|
-
/**
|
|
3251
|
-
* @tags Advisory Groups
|
|
3252
|
-
* @name GroupsManage
|
|
3253
|
-
* @request POST:/v1/groups/manage/{action}
|
|
3254
|
-
* @secure
|
|
3255
|
-
*/
|
|
3256
|
-
groupsManage(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3257
|
-
/**
|
|
3258
|
-
* @tags Advisory Groups
|
|
3259
|
-
* @name GroupsList
|
|
3260
|
-
* @request GET:/v1/groups/list
|
|
3261
|
-
* @secure
|
|
3262
|
-
*/
|
|
3263
|
-
groupsList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3264
|
-
/**
|
|
3265
|
-
* @tags Advisory Groups
|
|
3266
|
-
* @name GroupAccountsStats
|
|
3267
|
-
* @request GET:/v2/advisory/group/accounts/stats/{groupsId}
|
|
3268
|
-
* @secure
|
|
3269
|
-
*/
|
|
3270
|
-
groupAccountsStats(groupsId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3271
|
-
/**
|
|
3272
|
-
* @tags Advisory Groups
|
|
3273
|
-
* @name GroupPortfolios
|
|
3274
|
-
* @request GET:/v2/advisory/group/portfolios/{groupId}
|
|
3275
|
-
* @secure
|
|
3276
|
-
*/
|
|
3277
|
-
groupPortfolios(groupId: string, query?: {
|
|
3278
|
-
/**
|
|
3279
|
-
* Should load quotes or not.
|
|
3280
|
-
* @example "false"
|
|
3281
|
-
*/
|
|
3282
|
-
loadQuotes?: any;
|
|
3283
|
-
/**
|
|
3284
|
-
* Whether to return combined portfolio (no accounts, with approximate prices)
|
|
3285
|
-
* @example "false"
|
|
3286
|
-
*/
|
|
3287
|
-
combined?: any;
|
|
3288
|
-
/** @example "false" */
|
|
3289
|
-
loadIndustries?: any;
|
|
3290
|
-
/** @example "false" */
|
|
3291
|
-
loadUpgrades?: any;
|
|
3292
|
-
/** @example "false" */
|
|
3293
|
-
loadEarnings?: any;
|
|
3294
|
-
/**
|
|
3295
|
-
* Whether or not to include orders comprising each position's cost
|
|
3296
|
-
* @example "false"
|
|
3297
|
-
*/
|
|
3298
|
-
loadCost?: any;
|
|
3299
|
-
/**
|
|
3300
|
-
* Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
|
|
3301
|
-
* @example "false"
|
|
3302
|
-
*/
|
|
3303
|
-
marketCapWeights?: any;
|
|
3304
|
-
/** @example "1" */
|
|
3305
|
-
pageNum?: any;
|
|
3306
|
-
/** @example "100" */
|
|
3307
|
-
pageSize?: any;
|
|
3308
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3309
|
-
/**
|
|
3310
|
-
* @tags Advisory Groups
|
|
3311
|
-
* @name GroupRtb
|
|
3312
|
-
* @request GET:/v2/advisory/group/rtb/{groupId}
|
|
3313
|
-
* @secure
|
|
3314
|
-
*/
|
|
3315
|
-
groupRtb(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3316
|
-
/**
|
|
3317
|
-
* @tags Advisory Groups
|
|
3318
|
-
* @name GroupRtbs
|
|
3319
|
-
* @request GET:/v2/advisory/group/rtbs/{groupId}
|
|
3320
|
-
* @secure
|
|
3321
|
-
*/
|
|
3322
|
-
groupRtbs(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3323
|
-
}
|
|
3324
|
-
export class AdvisoryAnalytics<HandleError extends boolean = boolean> {
|
|
3325
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3326
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3327
|
-
/**
|
|
3328
|
-
* @tags Advisory Analytics
|
|
3329
|
-
* @name OverexposureAnalysis
|
|
3330
|
-
* @summary Overexposure analysis
|
|
3331
|
-
* @request GET:/v2/advisory/analytics/overexposure/{type}/{scope}/{id}
|
|
3332
|
-
* @secure
|
|
3333
|
-
*/
|
|
3334
|
-
overexposureAnalysis(type: string, scope: string, id: string, query?: {
|
|
3335
|
-
/**
|
|
3336
|
-
* Threshold of 70% or greater
|
|
3337
|
-
* @example ".7"
|
|
3338
|
-
*/
|
|
3339
|
-
threshold?: any;
|
|
3340
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3341
|
-
/**
|
|
3342
|
-
* @tags Advisory Analytics
|
|
3343
|
-
* @name RealtimeBalanceBreakdown
|
|
3344
|
-
* @summary Realtime balance breakdown
|
|
3345
|
-
* @request GET:/v2/advisory/analytics/breakdown/rtbs/{modelId}
|
|
3346
|
-
* @secure
|
|
3347
|
-
*/
|
|
3348
|
-
realtimeBalanceBreakdown(modelId: string, query?: {
|
|
3349
|
-
/**
|
|
3350
|
-
* Bucket size
|
|
3351
|
-
* @example "10000"
|
|
3352
|
-
*/
|
|
3353
|
-
bucket?: any;
|
|
3354
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3355
|
-
/**
|
|
3356
|
-
* @tags Advisory Analytics
|
|
3357
|
-
* @name ModelPerformance
|
|
3358
|
-
* @summary Model performance
|
|
3359
|
-
* @request GET:/v2/advisory/analytics/model/performance/{modelId}/{range}
|
|
3226
|
+
* @summary /apply
|
|
3227
|
+
* @request POST:/v2/charges/apply
|
|
3360
3228
|
* @secure
|
|
3361
3229
|
*/
|
|
3362
|
-
|
|
3230
|
+
apply(data: {
|
|
3231
|
+
/** @example 1234 */
|
|
3232
|
+
accountId?: any;
|
|
3233
|
+
/** @example 7.11 */
|
|
3234
|
+
amount?: any;
|
|
3235
|
+
/** @example "{timestamp}" */
|
|
3236
|
+
date?: any;
|
|
3237
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3363
3238
|
/**
|
|
3364
|
-
* @tags Advisory
|
|
3365
|
-
* @name
|
|
3366
|
-
* @summary
|
|
3367
|
-
* @request
|
|
3239
|
+
* @tags Advisory Charges
|
|
3240
|
+
* @name Cancel
|
|
3241
|
+
* @summary /cancel
|
|
3242
|
+
* @request POST:/v2/charges/cancel
|
|
3368
3243
|
* @secure
|
|
3369
3244
|
*/
|
|
3370
|
-
|
|
3371
|
-
/**
|
|
3372
|
-
* `optional` - specifies threshold (10% default)
|
|
3373
|
-
* @example ".1"
|
|
3374
|
-
*/
|
|
3375
|
-
threshold?: any;
|
|
3376
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3245
|
+
cancel(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3377
3246
|
}
|
|
3378
3247
|
export class AdvisoryModels<HandleError extends boolean = boolean> {
|
|
3379
3248
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -3721,6 +3590,155 @@ export class AdvisoryUserAccountManagement<HandleError extends boolean = boolean
|
|
|
3721
3590
|
*/
|
|
3722
3591
|
notesPost(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3723
3592
|
}
|
|
3593
|
+
export class AdvisoryGroups<HandleError extends boolean = boolean> {
|
|
3594
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3595
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3596
|
+
/**
|
|
3597
|
+
* @tags Advisory Groups
|
|
3598
|
+
* @name GroupsManage
|
|
3599
|
+
* @request POST:/v1/groups/manage/{action}
|
|
3600
|
+
* @secure
|
|
3601
|
+
*/
|
|
3602
|
+
groupsManage(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3603
|
+
/**
|
|
3604
|
+
* @tags Advisory Groups
|
|
3605
|
+
* @name GroupsList
|
|
3606
|
+
* @request GET:/v1/groups/list
|
|
3607
|
+
* @secure
|
|
3608
|
+
*/
|
|
3609
|
+
groupsList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3610
|
+
/**
|
|
3611
|
+
* @tags Advisory Groups
|
|
3612
|
+
* @name GroupAccountsStats
|
|
3613
|
+
* @request GET:/v2/advisory/group/accounts/stats/{groupsId}
|
|
3614
|
+
* @secure
|
|
3615
|
+
*/
|
|
3616
|
+
groupAccountsStats(groupsId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3617
|
+
/**
|
|
3618
|
+
* @tags Advisory Groups
|
|
3619
|
+
* @name GroupPortfolios
|
|
3620
|
+
* @request GET:/v2/advisory/group/portfolios/{groupId}
|
|
3621
|
+
* @secure
|
|
3622
|
+
*/
|
|
3623
|
+
groupPortfolios(groupId: string, query?: {
|
|
3624
|
+
/**
|
|
3625
|
+
* Should load quotes or not.
|
|
3626
|
+
* @example "false"
|
|
3627
|
+
*/
|
|
3628
|
+
loadQuotes?: any;
|
|
3629
|
+
/**
|
|
3630
|
+
* Whether to return combined portfolio (no accounts, with approximate prices)
|
|
3631
|
+
* @example "false"
|
|
3632
|
+
*/
|
|
3633
|
+
combined?: any;
|
|
3634
|
+
/** @example "false" */
|
|
3635
|
+
loadIndustries?: any;
|
|
3636
|
+
/** @example "false" */
|
|
3637
|
+
loadUpgrades?: any;
|
|
3638
|
+
/** @example "false" */
|
|
3639
|
+
loadEarnings?: any;
|
|
3640
|
+
/**
|
|
3641
|
+
* Whether or not to include orders comprising each position's cost
|
|
3642
|
+
* @example "false"
|
|
3643
|
+
*/
|
|
3644
|
+
loadCost?: any;
|
|
3645
|
+
/**
|
|
3646
|
+
* Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
|
|
3647
|
+
* @example "false"
|
|
3648
|
+
*/
|
|
3649
|
+
marketCapWeights?: any;
|
|
3650
|
+
/** @example "1" */
|
|
3651
|
+
pageNum?: any;
|
|
3652
|
+
/** @example "100" */
|
|
3653
|
+
pageSize?: any;
|
|
3654
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3655
|
+
/**
|
|
3656
|
+
* @tags Advisory Groups
|
|
3657
|
+
* @name GroupRtb
|
|
3658
|
+
* @request GET:/v2/advisory/group/rtb/{groupId}
|
|
3659
|
+
* @secure
|
|
3660
|
+
*/
|
|
3661
|
+
groupRtb(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3662
|
+
/**
|
|
3663
|
+
* @tags Advisory Groups
|
|
3664
|
+
* @name GroupRtbs
|
|
3665
|
+
* @request GET:/v2/advisory/group/rtbs/{groupId}
|
|
3666
|
+
* @secure
|
|
3667
|
+
*/
|
|
3668
|
+
groupRtbs(groupId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3669
|
+
}
|
|
3670
|
+
export class AdvisoryAnalytics<HandleError extends boolean = boolean> {
|
|
3671
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3672
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3673
|
+
/**
|
|
3674
|
+
* @tags Advisory Analytics
|
|
3675
|
+
* @name OverexposureAnalysis
|
|
3676
|
+
* @summary Overexposure analysis
|
|
3677
|
+
* @request GET:/v2/advisory/analytics/overexposure/{type}/{scope}/{id}
|
|
3678
|
+
* @secure
|
|
3679
|
+
*/
|
|
3680
|
+
overexposureAnalysis(type: string, scope: string, id: string, query?: {
|
|
3681
|
+
/**
|
|
3682
|
+
* Threshold of 70% or greater
|
|
3683
|
+
* @example ".7"
|
|
3684
|
+
*/
|
|
3685
|
+
threshold?: any;
|
|
3686
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3687
|
+
/**
|
|
3688
|
+
* @tags Advisory Analytics
|
|
3689
|
+
* @name RealtimeBalanceBreakdown
|
|
3690
|
+
* @summary Realtime balance breakdown
|
|
3691
|
+
* @request GET:/v2/advisory/analytics/breakdown/rtbs/{modelId}
|
|
3692
|
+
* @secure
|
|
3693
|
+
*/
|
|
3694
|
+
realtimeBalanceBreakdown(modelId: string, query?: {
|
|
3695
|
+
/**
|
|
3696
|
+
* Bucket size
|
|
3697
|
+
* @example "10000"
|
|
3698
|
+
*/
|
|
3699
|
+
bucket?: any;
|
|
3700
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3701
|
+
/**
|
|
3702
|
+
* @tags Advisory Analytics
|
|
3703
|
+
* @name ModelPerformance
|
|
3704
|
+
* @summary Model performance
|
|
3705
|
+
* @request GET:/v2/advisory/analytics/model/performance/{modelId}/{range}
|
|
3706
|
+
* @secure
|
|
3707
|
+
*/
|
|
3708
|
+
modelPerformance(modelId: string, range: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3709
|
+
/**
|
|
3710
|
+
* @tags Advisory Analytics
|
|
3711
|
+
* @name ModelDriftReport
|
|
3712
|
+
* @summary Model drift report
|
|
3713
|
+
* @request GET:/v2/advisory/analytics/model/drift/{modelId}
|
|
3714
|
+
* @secure
|
|
3715
|
+
*/
|
|
3716
|
+
modelDriftReport(modelId: string, query?: {
|
|
3717
|
+
/**
|
|
3718
|
+
* `optional` - specifies threshold (10% default)
|
|
3719
|
+
* @example ".1"
|
|
3720
|
+
*/
|
|
3721
|
+
threshold?: any;
|
|
3722
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
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
|
+
}
|
|
3724
3742
|
export class AdvisoryAllocations<HandleError extends boolean = boolean> {
|
|
3725
3743
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3726
3744
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -3773,24 +3791,6 @@ export class AdvisoryAllocations<HandleError extends boolean = boolean> {
|
|
|
3773
3791
|
*/
|
|
3774
3792
|
trigger(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3775
3793
|
}
|
|
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>);
|
|
@@ -4114,6 +4114,26 @@ export class TransfersInstantAccountVerification<HandleError extends boolean = b
|
|
|
4114
4114
|
remoteDevice?: any;
|
|
4115
4115
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4116
4116
|
}
|
|
4117
|
+
export class TransfersAch<HandleError extends boolean = boolean> {
|
|
4118
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4119
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4120
|
+
/**
|
|
4121
|
+
* @tags Transfers Ach
|
|
4122
|
+
* @name Deposit
|
|
4123
|
+
* @summary Deposit
|
|
4124
|
+
* @request POST:/transfer/ach/deposit
|
|
4125
|
+
* @secure
|
|
4126
|
+
*/
|
|
4127
|
+
deposit(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4128
|
+
/**
|
|
4129
|
+
* @tags Transfers Ach
|
|
4130
|
+
* @name Withdraw
|
|
4131
|
+
* @summary Withdraw
|
|
4132
|
+
* @request POST:/transfer/ach/withdraw
|
|
4133
|
+
* @secure
|
|
4134
|
+
*/
|
|
4135
|
+
withdraw(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4136
|
+
}
|
|
4117
4137
|
export class TransfersAcats<HandleError extends boolean = boolean> {
|
|
4118
4138
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4119
4139
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4420,60 +4440,28 @@ export class TransfersPositions<HandleError extends boolean = boolean> {
|
|
|
4420
4440
|
/** @example 1000 */
|
|
4421
4441
|
quantity?: any;
|
|
4422
4442
|
quote?: {
|
|
4423
|
-
/** @example "IBM" */
|
|
4424
|
-
symbol?: string;
|
|
4425
|
-
};
|
|
4426
|
-
/** @example "" */
|
|
4427
|
-
reason?: any;
|
|
4428
|
-
/** @example "0.0.0.0" */
|
|
4429
|
-
remoteAddr?: any;
|
|
4430
|
-
/** @example "Ultra fast proxy" */
|
|
4431
|
-
remoteDevice?: any;
|
|
4432
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4433
|
-
}
|
|
4434
|
-
export class TransfersBank<HandleError extends boolean = boolean> {
|
|
4435
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4436
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4437
|
-
/**
|
|
4438
|
-
* @tags Transfers Bank
|
|
4439
|
-
* @name FundTransfer
|
|
4440
|
-
* @summary Fund transfer
|
|
4441
|
-
* @request POST:/transfer/bank/{direction}
|
|
4442
|
-
* @secure
|
|
4443
|
-
*/
|
|
4444
|
-
fundTransfer(direction: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4445
|
-
}
|
|
4446
|
-
export class TransfersAch<HandleError extends boolean = boolean> {
|
|
4447
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4448
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4449
|
-
/**
|
|
4450
|
-
* @tags Transfers Ach
|
|
4451
|
-
* @name Deposit
|
|
4452
|
-
* @summary Deposit
|
|
4453
|
-
* @request POST:/transfer/ach/deposit
|
|
4454
|
-
* @secure
|
|
4455
|
-
*/
|
|
4456
|
-
deposit(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4457
|
-
/**
|
|
4458
|
-
* @tags Transfers Ach
|
|
4459
|
-
* @name Withdraw
|
|
4460
|
-
* @summary Withdraw
|
|
4461
|
-
* @request POST:/transfer/ach/withdraw
|
|
4462
|
-
* @secure
|
|
4463
|
-
*/
|
|
4464
|
-
withdraw(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4443
|
+
/** @example "IBM" */
|
|
4444
|
+
symbol?: string;
|
|
4445
|
+
};
|
|
4446
|
+
/** @example "" */
|
|
4447
|
+
reason?: any;
|
|
4448
|
+
/** @example "0.0.0.0" */
|
|
4449
|
+
remoteAddr?: any;
|
|
4450
|
+
/** @example "Ultra fast proxy" */
|
|
4451
|
+
remoteDevice?: any;
|
|
4452
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4465
4453
|
}
|
|
4466
|
-
export class
|
|
4454
|
+
export class TransfersBank<HandleError extends boolean = boolean> {
|
|
4467
4455
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4468
4456
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4469
4457
|
/**
|
|
4470
|
-
* @tags Transfers
|
|
4471
|
-
* @name
|
|
4472
|
-
* @summary
|
|
4473
|
-
* @request POST:/transfer/
|
|
4458
|
+
* @tags Transfers Bank
|
|
4459
|
+
* @name FundTransfer
|
|
4460
|
+
* @summary Fund transfer
|
|
4461
|
+
* @request POST:/transfer/bank/{direction}
|
|
4474
4462
|
* @secure
|
|
4475
4463
|
*/
|
|
4476
|
-
|
|
4464
|
+
fundTransfer(direction: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4477
4465
|
}
|
|
4478
4466
|
export class TransfersInstantCashTransfers<HandleError extends boolean = boolean> {
|
|
4479
4467
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -4571,14 +4559,260 @@ export class TransfersInstantCashTransfers<HandleError extends boolean = boolean
|
|
|
4571
4559
|
/** @example "RETAIL_BANKING" */
|
|
4572
4560
|
reportType?: any;
|
|
4573
4561
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4574
|
-
/**
|
|
4575
|
-
* @tags Transfers Instant Cash Transfers
|
|
4576
|
-
* @name ListReports
|
|
4577
|
-
* @summary List reports
|
|
4578
|
-
* @request GET:/transfer/reports
|
|
4579
|
-
* @secure
|
|
4580
|
-
*/
|
|
4581
|
-
listReports(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" */
|
|
4804
|
+
remoteAddr?: any;
|
|
4805
|
+
/** @example "{optional} Some phone" */
|
|
4806
|
+
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
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4582
4816
|
}
|
|
4583
4817
|
export class Documents<HandleError extends boolean = boolean> {
|
|
4584
4818
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5110,6 +5344,111 @@ export class LegalDocuments<HandleError extends boolean = boolean> {
|
|
|
5110
5344
|
remoteDevice?: any;
|
|
5111
5345
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5112
5346
|
}
|
|
5347
|
+
export class BlacklistAdminBusinesses<HandleError extends boolean = boolean> {
|
|
5348
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5349
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5350
|
+
/**
|
|
5351
|
+
* @tags Blacklist Admin Businesses
|
|
5352
|
+
* @name GetBusinessesList
|
|
5353
|
+
* @summary Get Businesses list
|
|
5354
|
+
* @request GET:/v1/admin/businesses
|
|
5355
|
+
* @secure
|
|
5356
|
+
*/
|
|
5357
|
+
getBusinessesList(query?: {
|
|
5358
|
+
/**
|
|
5359
|
+
* (Required) page number
|
|
5360
|
+
* @example "5567183"
|
|
5361
|
+
*/
|
|
5362
|
+
page?: any;
|
|
5363
|
+
/**
|
|
5364
|
+
* (Required) page size in records displayed
|
|
5365
|
+
* @example "5567183"
|
|
5366
|
+
*/
|
|
5367
|
+
page_size?: any;
|
|
5368
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5369
|
+
/**
|
|
5370
|
+
* @tags Blacklist Admin Businesses
|
|
5371
|
+
* @name CreateBusiness
|
|
5372
|
+
* @summary Create Business
|
|
5373
|
+
* @request POST:/v1/admin/businesses
|
|
5374
|
+
* @secure
|
|
5375
|
+
*/
|
|
5376
|
+
createBusiness(data: {
|
|
5377
|
+
/** @example "Gracia Marina" */
|
|
5378
|
+
business_name?: any;
|
|
5379
|
+
/** @example "Los Angeles" */
|
|
5380
|
+
city?: any;
|
|
5381
|
+
/** @example "US" */
|
|
5382
|
+
country?: any;
|
|
5383
|
+
/** @example "La Granja Del Camaron" */
|
|
5384
|
+
dba_name?: any;
|
|
5385
|
+
/** @example "" */
|
|
5386
|
+
incorporated?: any;
|
|
5387
|
+
/** @example "812748955" */
|
|
5388
|
+
number?: any;
|
|
5389
|
+
/** @example "EIN" */
|
|
5390
|
+
number_type?: any;
|
|
5391
|
+
/** @example "" */
|
|
5392
|
+
phone?: any;
|
|
5393
|
+
/** @example "CA" */
|
|
5394
|
+
state?: any;
|
|
5395
|
+
/** @example "1119 E 8th St Ste C" */
|
|
5396
|
+
street?: any;
|
|
5397
|
+
/** @example "304902" */
|
|
5398
|
+
tracking_number?: any;
|
|
5399
|
+
/** @example "90021" */
|
|
5400
|
+
zip?: any;
|
|
5401
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5402
|
+
/**
|
|
5403
|
+
* @tags Blacklist Admin Businesses
|
|
5404
|
+
* @name GetBusinessById
|
|
5405
|
+
* @summary Get Business by ID
|
|
5406
|
+
* @request GET:/v1/admin/businesses/{id}
|
|
5407
|
+
* @secure
|
|
5408
|
+
*/
|
|
5409
|
+
getBusinessById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5410
|
+
/**
|
|
5411
|
+
* @tags Blacklist Admin Businesses
|
|
5412
|
+
* @name UpdateBusiness
|
|
5413
|
+
* @summary Update Business
|
|
5414
|
+
* @request PUT:/v1/admin/businesses/{id}
|
|
5415
|
+
* @secure
|
|
5416
|
+
*/
|
|
5417
|
+
updateBusiness(id: string, data: {
|
|
5418
|
+
/** @example "Gracia Marina" */
|
|
5419
|
+
business_name?: any;
|
|
5420
|
+
/** @example "Los Angeles" */
|
|
5421
|
+
city?: any;
|
|
5422
|
+
/** @example "US" */
|
|
5423
|
+
country?: any;
|
|
5424
|
+
/** @example "La Granja Del Camaron" */
|
|
5425
|
+
dba_name?: any;
|
|
5426
|
+
/** @example "" */
|
|
5427
|
+
incorporated?: any;
|
|
5428
|
+
/** @example "812748955" */
|
|
5429
|
+
number?: any;
|
|
5430
|
+
/** @example "EIN" */
|
|
5431
|
+
number_type?: any;
|
|
5432
|
+
/** @example "" */
|
|
5433
|
+
phone?: any;
|
|
5434
|
+
/** @example "CA" */
|
|
5435
|
+
state?: any;
|
|
5436
|
+
/** @example "1119 E 8th St Ste C" */
|
|
5437
|
+
street?: any;
|
|
5438
|
+
/** @example "304902" */
|
|
5439
|
+
tracking_number?: any;
|
|
5440
|
+
/** @example "90021" */
|
|
5441
|
+
zip?: any;
|
|
5442
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5443
|
+
/**
|
|
5444
|
+
* @tags Blacklist Admin Businesses
|
|
5445
|
+
* @name DeleteBusiness
|
|
5446
|
+
* @summary Delete Business
|
|
5447
|
+
* @request DELETE:/v1/admin/businesses/{id}
|
|
5448
|
+
* @secure
|
|
5449
|
+
*/
|
|
5450
|
+
deleteBusiness(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5451
|
+
}
|
|
5113
5452
|
export class BlacklistAdminIndividuals<HandleError extends boolean = boolean> {
|
|
5114
5453
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5115
5454
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5253,138 +5592,33 @@ export class BlacklistSearch<HandleError extends boolean = boolean> {
|
|
|
5253
5592
|
/** @example [{"distance":0,"name":"business_name","value":"Gracia Marina"},{"distance":2,"name":"dba_name","value":"La Granja Del Camar"}] */
|
|
5254
5593
|
filters?: any;
|
|
5255
5594
|
/** @example "AND" */
|
|
5256
|
-
match_type?: any;
|
|
5257
|
-
pagination?: {
|
|
5258
|
-
/** @example 1 */
|
|
5259
|
-
page?: number;
|
|
5260
|
-
/** @example 20 */
|
|
5261
|
-
page_size?: number;
|
|
5262
|
-
};
|
|
5263
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5264
|
-
/**
|
|
5265
|
-
* @tags Blacklist Search
|
|
5266
|
-
* @name SearchIndividual
|
|
5267
|
-
* @summary Search Individual
|
|
5268
|
-
* @request POST:/v1/individuals/search
|
|
5269
|
-
* @secure
|
|
5270
|
-
*/
|
|
5271
|
-
searchIndividual(data: {
|
|
5272
|
-
/** @example [{"distance":2,"name":"first_name","value":"Hyodan"},{"distance":0,"name":"alias_middle_name","value":"Hyodon"}] */
|
|
5273
|
-
filters?: any;
|
|
5274
|
-
/** @example "OR" */
|
|
5275
|
-
match_type?: any;
|
|
5276
|
-
pagination?: {
|
|
5277
|
-
/** @example 1 */
|
|
5278
|
-
page?: number;
|
|
5279
|
-
/** @example 20 */
|
|
5280
|
-
page_size?: number;
|
|
5281
|
-
};
|
|
5282
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5283
|
-
}
|
|
5284
|
-
export class BlacklistAdminBusinesses<HandleError extends boolean = boolean> {
|
|
5285
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5286
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5287
|
-
/**
|
|
5288
|
-
* @tags Blacklist Admin Businesses
|
|
5289
|
-
* @name GetBusinessesList
|
|
5290
|
-
* @summary Get Businesses list
|
|
5291
|
-
* @request GET:/v1/admin/businesses
|
|
5292
|
-
* @secure
|
|
5293
|
-
*/
|
|
5294
|
-
getBusinessesList(query?: {
|
|
5295
|
-
/**
|
|
5296
|
-
* (Required) page number
|
|
5297
|
-
* @example "5567183"
|
|
5298
|
-
*/
|
|
5299
|
-
page?: any;
|
|
5300
|
-
/**
|
|
5301
|
-
* (Required) page size in records displayed
|
|
5302
|
-
* @example "5567183"
|
|
5303
|
-
*/
|
|
5304
|
-
page_size?: any;
|
|
5305
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5306
|
-
/**
|
|
5307
|
-
* @tags Blacklist Admin Businesses
|
|
5308
|
-
* @name CreateBusiness
|
|
5309
|
-
* @summary Create Business
|
|
5310
|
-
* @request POST:/v1/admin/businesses
|
|
5311
|
-
* @secure
|
|
5312
|
-
*/
|
|
5313
|
-
createBusiness(data: {
|
|
5314
|
-
/** @example "Gracia Marina" */
|
|
5315
|
-
business_name?: any;
|
|
5316
|
-
/** @example "Los Angeles" */
|
|
5317
|
-
city?: any;
|
|
5318
|
-
/** @example "US" */
|
|
5319
|
-
country?: any;
|
|
5320
|
-
/** @example "La Granja Del Camaron" */
|
|
5321
|
-
dba_name?: any;
|
|
5322
|
-
/** @example "" */
|
|
5323
|
-
incorporated?: any;
|
|
5324
|
-
/** @example "812748955" */
|
|
5325
|
-
number?: any;
|
|
5326
|
-
/** @example "EIN" */
|
|
5327
|
-
number_type?: any;
|
|
5328
|
-
/** @example "" */
|
|
5329
|
-
phone?: any;
|
|
5330
|
-
/** @example "CA" */
|
|
5331
|
-
state?: any;
|
|
5332
|
-
/** @example "1119 E 8th St Ste C" */
|
|
5333
|
-
street?: any;
|
|
5334
|
-
/** @example "304902" */
|
|
5335
|
-
tracking_number?: any;
|
|
5336
|
-
/** @example "90021" */
|
|
5337
|
-
zip?: any;
|
|
5338
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5339
|
-
/**
|
|
5340
|
-
* @tags Blacklist Admin Businesses
|
|
5341
|
-
* @name GetBusinessById
|
|
5342
|
-
* @summary Get Business by ID
|
|
5343
|
-
* @request GET:/v1/admin/businesses/{id}
|
|
5344
|
-
* @secure
|
|
5345
|
-
*/
|
|
5346
|
-
getBusinessById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5347
|
-
/**
|
|
5348
|
-
* @tags Blacklist Admin Businesses
|
|
5349
|
-
* @name UpdateBusiness
|
|
5350
|
-
* @summary Update Business
|
|
5351
|
-
* @request PUT:/v1/admin/businesses/{id}
|
|
5352
|
-
* @secure
|
|
5353
|
-
*/
|
|
5354
|
-
updateBusiness(id: string, data: {
|
|
5355
|
-
/** @example "Gracia Marina" */
|
|
5356
|
-
business_name?: any;
|
|
5357
|
-
/** @example "Los Angeles" */
|
|
5358
|
-
city?: any;
|
|
5359
|
-
/** @example "US" */
|
|
5360
|
-
country?: any;
|
|
5361
|
-
/** @example "La Granja Del Camaron" */
|
|
5362
|
-
dba_name?: any;
|
|
5363
|
-
/** @example "" */
|
|
5364
|
-
incorporated?: any;
|
|
5365
|
-
/** @example "812748955" */
|
|
5366
|
-
number?: any;
|
|
5367
|
-
/** @example "EIN" */
|
|
5368
|
-
number_type?: any;
|
|
5369
|
-
/** @example "" */
|
|
5370
|
-
phone?: any;
|
|
5371
|
-
/** @example "CA" */
|
|
5372
|
-
state?: any;
|
|
5373
|
-
/** @example "1119 E 8th St Ste C" */
|
|
5374
|
-
street?: any;
|
|
5375
|
-
/** @example "304902" */
|
|
5376
|
-
tracking_number?: any;
|
|
5377
|
-
/** @example "90021" */
|
|
5378
|
-
zip?: any;
|
|
5595
|
+
match_type?: any;
|
|
5596
|
+
pagination?: {
|
|
5597
|
+
/** @example 1 */
|
|
5598
|
+
page?: number;
|
|
5599
|
+
/** @example 20 */
|
|
5600
|
+
page_size?: number;
|
|
5601
|
+
};
|
|
5379
5602
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5380
5603
|
/**
|
|
5381
|
-
* @tags Blacklist
|
|
5382
|
-
* @name
|
|
5383
|
-
* @summary
|
|
5384
|
-
* @request
|
|
5604
|
+
* @tags Blacklist Search
|
|
5605
|
+
* @name SearchIndividual
|
|
5606
|
+
* @summary Search Individual
|
|
5607
|
+
* @request POST:/v1/individuals/search
|
|
5385
5608
|
* @secure
|
|
5386
5609
|
*/
|
|
5387
|
-
|
|
5610
|
+
searchIndividual(data: {
|
|
5611
|
+
/** @example [{"distance":2,"name":"first_name","value":"Hyodan"},{"distance":0,"name":"alias_middle_name","value":"Hyodon"}] */
|
|
5612
|
+
filters?: any;
|
|
5613
|
+
/** @example "OR" */
|
|
5614
|
+
match_type?: any;
|
|
5615
|
+
pagination?: {
|
|
5616
|
+
/** @example 1 */
|
|
5617
|
+
page?: number;
|
|
5618
|
+
/** @example 20 */
|
|
5619
|
+
page_size?: number;
|
|
5620
|
+
};
|
|
5621
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5388
5622
|
}
|
|
5389
5623
|
export class Blacklist<HandleError extends boolean = boolean> {
|
|
5390
5624
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5415,282 +5649,119 @@ export class Blacklist<HandleError extends boolean = boolean> {
|
|
|
5415
5649
|
*/
|
|
5416
5650
|
getHealth(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5417
5651
|
}
|
|
5418
|
-
export class
|
|
5652
|
+
export class WatchmenFfiUserAccountManagement<HandleError extends boolean = boolean> {
|
|
5419
5653
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5420
|
-
relationships: TransfersRelationships<HandleError>;
|
|
5421
|
-
instantAccountVerification: TransfersInstantAccountVerification<HandleError>;
|
|
5422
|
-
ach: TransfersAch<HandleError>;
|
|
5423
|
-
acats: TransfersAcats<HandleError>;
|
|
5424
|
-
wires: TransfersWires<HandleError>;
|
|
5425
|
-
journals: TransfersJournals<HandleError>;
|
|
5426
|
-
positions: TransfersPositions<HandleError>;
|
|
5427
|
-
bank: TransfersBank<HandleError>;
|
|
5428
|
-
instantCashTransfers: TransfersInstantCashTransfers<HandleError>;
|
|
5429
|
-
cheques: TransfersCheques<HandleError>;
|
|
5430
5654
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5431
5655
|
/**
|
|
5432
|
-
* @tags
|
|
5433
|
-
* @name
|
|
5434
|
-
* @summary
|
|
5435
|
-
* @request
|
|
5436
|
-
* @secure
|
|
5437
|
-
*/
|
|
5438
|
-
transferDetails(account: string, transferId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5439
|
-
/**
|
|
5440
|
-
* @tags Transfers
|
|
5441
|
-
* @name TransferStatus
|
|
5442
|
-
* @summary Transfer Status
|
|
5443
|
-
* @request GET:/transfer/status/{account}
|
|
5444
|
-
* @secure
|
|
5445
|
-
*/
|
|
5446
|
-
transferStatus(account: string, query?: {
|
|
5447
|
-
/** INCOMING|OUTGOING */
|
|
5448
|
-
direction?: any;
|
|
5449
|
-
/** ACH|WIRE|CHECK|Bank|CustodyJournal|ALL */
|
|
5450
|
-
mechanism?: any;
|
|
5451
|
-
/** MM/DD/YYYY */
|
|
5452
|
-
dateFrom?: any;
|
|
5453
|
-
/** MM/DD/YYYY */
|
|
5454
|
-
dateTo?: any;
|
|
5455
|
-
/** Overrides `dateFrom` and `dateTo`. See description. */
|
|
5456
|
-
range?: any;
|
|
5457
|
-
start?: any;
|
|
5458
|
-
perPage?: any;
|
|
5459
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5460
|
-
/**
|
|
5461
|
-
* @tags Transfers
|
|
5462
|
-
* @name TransferStatusModel
|
|
5463
|
-
* @summary Transfer Status Model
|
|
5464
|
-
* @request GET:/transfer/status/model/{modelId}
|
|
5465
|
-
* @secure
|
|
5466
|
-
*/
|
|
5467
|
-
transferStatusModel(modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5468
|
-
/**
|
|
5469
|
-
* @tags Transfers
|
|
5470
|
-
* @name TransferStatusBranch
|
|
5471
|
-
* @summary Transfer Status Branch
|
|
5472
|
-
* @request GET:/transfer/status/branch
|
|
5473
|
-
* @secure
|
|
5474
|
-
*/
|
|
5475
|
-
transferStatusBranch(query?: {
|
|
5476
|
-
/**
|
|
5477
|
-
* INCOMING|OUTGOING|ALL
|
|
5478
|
-
* @example "ALL"
|
|
5479
|
-
*/
|
|
5480
|
-
direction?: any;
|
|
5481
|
-
/**
|
|
5482
|
-
* ACH|WIRE|CHECK|Bank|CustodyJournal
|
|
5483
|
-
* @example "ALL"
|
|
5484
|
-
*/
|
|
5485
|
-
mechanism?: any;
|
|
5486
|
-
dateFrom?: any;
|
|
5487
|
-
dateTo?: any;
|
|
5488
|
-
/** Per regex: \d+[ymdw]$ (will override `dateFrom` and `dateTo`) */
|
|
5489
|
-
range?: any;
|
|
5490
|
-
start?: any;
|
|
5491
|
-
perPage?: any;
|
|
5492
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5493
|
-
/**
|
|
5494
|
-
* @tags Transfers
|
|
5495
|
-
* @name AmountAvailable
|
|
5496
|
-
* @summary Amount Available
|
|
5497
|
-
* @request GET:/transfer/available/{account}
|
|
5498
|
-
* @secure
|
|
5499
|
-
*/
|
|
5500
|
-
amountAvailable(account: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5501
|
-
/**
|
|
5502
|
-
* @tags Transfers
|
|
5503
|
-
* @name LegalDocumentTypes
|
|
5504
|
-
* @summary Legal document types
|
|
5505
|
-
* @request GET:/transfer/legal/types
|
|
5506
|
-
* @secure
|
|
5507
|
-
*/
|
|
5508
|
-
legalDocumentTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5509
|
-
/**
|
|
5510
|
-
* @tags Transfers
|
|
5511
|
-
* @name LegalDocument
|
|
5512
|
-
* @summary Legal document
|
|
5513
|
-
* @request GET:/transfer/legal/content
|
|
5514
|
-
* @secure
|
|
5515
|
-
*/
|
|
5516
|
-
legalDocument(query?: {
|
|
5517
|
-
/** Unique ID given in the types endpoint */
|
|
5518
|
-
id?: any;
|
|
5519
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5520
|
-
/**
|
|
5521
|
-
* @tags Transfers
|
|
5522
|
-
* @name Cancel
|
|
5523
|
-
* @summary Cancel
|
|
5524
|
-
* @request POST:/transfer/ach/cancel
|
|
5525
|
-
* @secure
|
|
5526
|
-
*/
|
|
5527
|
-
cancel(data: {
|
|
5528
|
-
/** @example "5VA0XXXX" */
|
|
5529
|
-
account?: any;
|
|
5530
|
-
/** @example "0.0.0.0" */
|
|
5531
|
-
remoteAddr?: any;
|
|
5532
|
-
/** @example "ultra fast browser 1.1" */
|
|
5533
|
-
remoteDevice?: any;
|
|
5534
|
-
/** @example "CC123456" */
|
|
5535
|
-
transferId?: any;
|
|
5536
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5537
|
-
/**
|
|
5538
|
-
* @tags Transfers
|
|
5539
|
-
* @name FeesAndCredits
|
|
5540
|
-
* @summary Fees and Credits
|
|
5541
|
-
* @request POST:/transfer/fees/apply
|
|
5656
|
+
* @tags Watchmen Ffi User Account Management
|
|
5657
|
+
* @name CreateUser
|
|
5658
|
+
* @summary Create User
|
|
5659
|
+
* @request POST:/rest/v1/uam/user/create
|
|
5542
5660
|
* @secure
|
|
5543
5661
|
*/
|
|
5544
|
-
|
|
5545
|
-
/** @example "
|
|
5546
|
-
|
|
5547
|
-
/** @example
|
|
5548
|
-
|
|
5549
|
-
/** @example "
|
|
5550
|
-
|
|
5551
|
-
/** @example "" */
|
|
5552
|
-
|
|
5553
|
-
/** @example "
|
|
5554
|
-
|
|
5555
|
-
/** @example "" */
|
|
5556
|
-
|
|
5557
|
-
/** @example
|
|
5558
|
-
|
|
5559
|
-
/** @example "
|
|
5560
|
-
|
|
5561
|
-
/** @example "
|
|
5562
|
-
|
|
5563
|
-
/** @example "
|
|
5564
|
-
|
|
5662
|
+
createUser(data: {
|
|
5663
|
+
/** @example "{optional} enable|disable - whether or not enable user for TipRanks" */
|
|
5664
|
+
Tipranks?: any;
|
|
5665
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5666
|
+
algos?: any;
|
|
5667
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5668
|
+
allSession?: any;
|
|
5669
|
+
/** @example "{optional} Full Name" */
|
|
5670
|
+
associatedName?: any;
|
|
5671
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5672
|
+
buyWrite?: any;
|
|
5673
|
+
/** @example "{optional} e-mail address" */
|
|
5674
|
+
email?: any;
|
|
5675
|
+
/** @example "{optional} true|false - defaults to true" */
|
|
5676
|
+
isTradingEnabled?: any;
|
|
5677
|
+
/** @example "{optional} Limit On Close - true|false - defaults to false" */
|
|
5678
|
+
loc?: any;
|
|
5679
|
+
/** @example "{optional} true|false - whether user is locked" */
|
|
5680
|
+
locked?: any;
|
|
5681
|
+
/** @example "{optional} Limit On Open - true|false - defaults to false" */
|
|
5682
|
+
loo?: any;
|
|
5683
|
+
/** @example "{optional} Market On Open - true|false - defaults to false" */
|
|
5684
|
+
moc?: any;
|
|
5685
|
+
/** @example "{optional} Market On Close - true|false - defaults to false" */
|
|
5686
|
+
moo?: any;
|
|
5687
|
+
/** @example "{optional} One Cancels Other - true|false - defaults to false" */
|
|
5688
|
+
oco?: any;
|
|
5689
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5690
|
+
optionRoll?: any;
|
|
5691
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5692
|
+
options?: any;
|
|
5693
|
+
/** @example "{optional}" */
|
|
5694
|
+
password?: any;
|
|
5695
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5696
|
+
prePostTrading?: any;
|
|
5697
|
+
/** @example "{optional} 1 - delayed, 0 - realtime, 4 - CBOE1, 3 - BATS" */
|
|
5698
|
+
quoteType?: any;
|
|
5699
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5700
|
+
spreads?: any;
|
|
5701
|
+
/** @example "A - active, S - suspended == initial user status" */
|
|
5702
|
+
status?: any;
|
|
5703
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5704
|
+
trailingStops?: any;
|
|
5705
|
+
/** @example "UNIQUE_USERNAME" */
|
|
5706
|
+
username?: any;
|
|
5565
5707
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5566
5708
|
/**
|
|
5567
|
-
* @tags
|
|
5568
|
-
* @name
|
|
5569
|
-
* @summary
|
|
5570
|
-
* @request
|
|
5571
|
-
* @secure
|
|
5572
|
-
*/
|
|
5573
|
-
listFees(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5574
|
-
/**
|
|
5575
|
-
* @tags Transfers
|
|
5576
|
-
* @name ListCredits
|
|
5577
|
-
* @summary List credits
|
|
5578
|
-
* @request GET:/transfer/fees/classifications/credits
|
|
5709
|
+
* @tags Watchmen Ffi User Account Management
|
|
5710
|
+
* @name CreateAccount
|
|
5711
|
+
* @summary Create Account
|
|
5712
|
+
* @request POST:/rest/v1/uam/account/create
|
|
5579
5713
|
* @secure
|
|
5580
5714
|
*/
|
|
5581
|
-
|
|
5715
|
+
createAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5582
5716
|
/**
|
|
5583
|
-
* @tags
|
|
5584
|
-
* @name
|
|
5585
|
-
* @summary
|
|
5586
|
-
* @request GET:/
|
|
5717
|
+
* @tags Watchmen Ffi User Account Management
|
|
5718
|
+
* @name AccountInformation
|
|
5719
|
+
* @summary Account Information
|
|
5720
|
+
* @request GET:/rest/v1/uam/account/data
|
|
5587
5721
|
* @secure
|
|
5588
5722
|
*/
|
|
5589
|
-
|
|
5590
|
-
/** @example "
|
|
5591
|
-
|
|
5592
|
-
/** @example "BTC" */
|
|
5593
|
-
currency?: any;
|
|
5594
|
-
/** @example "{optional}" */
|
|
5595
|
-
network?: any;
|
|
5723
|
+
accountInformation(query?: {
|
|
5724
|
+
/** @example "AC123456" */
|
|
5725
|
+
accountNumber?: any;
|
|
5596
5726
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5597
5727
|
/**
|
|
5598
|
-
* @tags
|
|
5599
|
-
* @name
|
|
5600
|
-
* @summary
|
|
5601
|
-
* @request
|
|
5728
|
+
* @tags Watchmen Ffi User Account Management
|
|
5729
|
+
* @name UserInformation
|
|
5730
|
+
* @summary User Information
|
|
5731
|
+
* @request GET:/rest/v1/uam/user/data
|
|
5602
5732
|
* @secure
|
|
5603
5733
|
*/
|
|
5604
|
-
|
|
5605
|
-
/** @example "
|
|
5606
|
-
|
|
5607
|
-
/** @example "{optional}" */
|
|
5608
|
-
network?: any;
|
|
5609
|
-
/** @example "0.1" */
|
|
5610
|
-
quantity?: any;
|
|
5611
|
-
/** @example "{optional}" */
|
|
5612
|
-
wallet?: any;
|
|
5734
|
+
userInformation(query?: {
|
|
5735
|
+
/** @example "USERNAME" */
|
|
5736
|
+
username?: any;
|
|
5613
5737
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5614
5738
|
/**
|
|
5615
|
-
* @tags
|
|
5616
|
-
* @name
|
|
5617
|
-
* @summary
|
|
5618
|
-
* @request
|
|
5739
|
+
* @tags Watchmen Ffi User Account Management
|
|
5740
|
+
* @name ListLinkedAccounts
|
|
5741
|
+
* @summary List Linked Accounts
|
|
5742
|
+
* @request GET:/rest/v1/linkedaccounts/listAccounts
|
|
5619
5743
|
* @secure
|
|
5620
5744
|
*/
|
|
5621
|
-
|
|
5622
|
-
/** @example "
|
|
5623
|
-
|
|
5624
|
-
/** @example "BTC" */
|
|
5625
|
-
currency?: any;
|
|
5626
|
-
/** @example "{optional}" */
|
|
5627
|
-
estimateExtension?: any;
|
|
5628
|
-
/** @example "abc123" */
|
|
5629
|
-
estimateId?: any;
|
|
5630
|
-
/** @example "{optional}" */
|
|
5631
|
-
network?: any;
|
|
5632
|
-
/** @example 0.1 */
|
|
5633
|
-
quantity?: any;
|
|
5634
|
-
/** @example "{conditional}" */
|
|
5635
|
-
recipientFirstName?: any;
|
|
5636
|
-
/** @example "{conditional}" */
|
|
5637
|
-
recipientLastName?: any;
|
|
5638
|
-
/** @example "{optional} 1.1.1.1" */
|
|
5639
|
-
remoteAddr?: any;
|
|
5640
|
-
/** @example "{optional} Some phone" */
|
|
5641
|
-
remoteDevice?: any;
|
|
5642
|
-
/** @example "{optional} true|false" */
|
|
5643
|
-
selfHosted?: any;
|
|
5644
|
-
/** @example "{optional}" */
|
|
5645
|
-
tag?: any;
|
|
5646
|
-
/** @example "{conditional}" */
|
|
5647
|
-
vaspName?: any;
|
|
5648
|
-
/** @example "wallet address" */
|
|
5649
|
-
wallet?: any;
|
|
5745
|
+
listLinkedAccounts(query?: {
|
|
5746
|
+
/** @example "TEST.USER" */
|
|
5747
|
+
username?: any;
|
|
5650
5748
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5651
|
-
}
|
|
5652
|
-
export class Broker<HandleError extends boolean = boolean> {
|
|
5653
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5654
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5655
5749
|
/**
|
|
5656
|
-
* @tags
|
|
5657
|
-
* @name
|
|
5658
|
-
* @summary
|
|
5659
|
-
* @request
|
|
5750
|
+
* @tags Watchmen Ffi User Account Management
|
|
5751
|
+
* @name LinkUnlinkAccount
|
|
5752
|
+
* @summary Link/Unlink Account
|
|
5753
|
+
* @request POST:/rest/v1/linkedaccounts/linkUnlinkAccount
|
|
5660
5754
|
* @secure
|
|
5661
5755
|
*/
|
|
5662
|
-
|
|
5663
|
-
|
|
5664
|
-
|
|
5665
|
-
|
|
5666
|
-
|
|
5667
|
-
|
|
5668
|
-
|
|
5669
|
-
|
|
5670
|
-
|
|
5671
|
-
loadUpgrades?: any;
|
|
5672
|
-
/** @example "false" */
|
|
5673
|
-
loadEarnings?: any;
|
|
5674
|
-
/**
|
|
5675
|
-
* Load balances for weight
|
|
5676
|
-
* @example "false"
|
|
5677
|
-
*/
|
|
5678
|
-
loadRtb?: any;
|
|
5679
|
-
/**
|
|
5680
|
-
* Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
|
|
5681
|
-
* @example "false"
|
|
5682
|
-
*/
|
|
5683
|
-
marketCapBreakdown?: any;
|
|
5684
|
-
/**
|
|
5685
|
-
* Combined portfolio for the branch
|
|
5686
|
-
* @example "false"
|
|
5687
|
-
*/
|
|
5688
|
-
combined?: any;
|
|
5689
|
-
/** @example "1" */
|
|
5690
|
-
pageNum?: any;
|
|
5691
|
-
/** @example "100" */
|
|
5692
|
-
pageSize?: any;
|
|
5693
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5756
|
+
linkUnlinkAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5757
|
+
/**
|
|
5758
|
+
* @tags Watchmen Ffi User Account Management
|
|
5759
|
+
* @name Visibility
|
|
5760
|
+
* @summary Visibility
|
|
5761
|
+
* @request POST:/rest/v1/linkedaccounts/visibility
|
|
5762
|
+
* @secure
|
|
5763
|
+
*/
|
|
5764
|
+
visibility(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5694
5765
|
}
|
|
5695
5766
|
export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
|
|
5696
5767
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5877,119 +5948,48 @@ export class Advisory<HandleError extends boolean = boolean> {
|
|
|
5877
5948
|
allocations: AdvisoryAllocations<HandleError>;
|
|
5878
5949
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5879
5950
|
}
|
|
5880
|
-
export class
|
|
5951
|
+
export class Broker<HandleError extends boolean = boolean> {
|
|
5881
5952
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5882
5953
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5883
5954
|
/**
|
|
5884
|
-
* @tags
|
|
5885
|
-
* @name
|
|
5886
|
-
* @summary
|
|
5887
|
-
* @request
|
|
5888
|
-
* @secure
|
|
5889
|
-
*/
|
|
5890
|
-
createUser(data: {
|
|
5891
|
-
/** @example "{optional} enable|disable - whether or not enable user for TipRanks" */
|
|
5892
|
-
Tipranks?: any;
|
|
5893
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5894
|
-
algos?: any;
|
|
5895
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5896
|
-
allSession?: any;
|
|
5897
|
-
/** @example "{optional} Full Name" */
|
|
5898
|
-
associatedName?: any;
|
|
5899
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5900
|
-
buyWrite?: any;
|
|
5901
|
-
/** @example "{optional} e-mail address" */
|
|
5902
|
-
email?: any;
|
|
5903
|
-
/** @example "{optional} true|false - defaults to true" */
|
|
5904
|
-
isTradingEnabled?: any;
|
|
5905
|
-
/** @example "{optional} Limit On Close - true|false - defaults to false" */
|
|
5906
|
-
loc?: any;
|
|
5907
|
-
/** @example "{optional} true|false - whether user is locked" */
|
|
5908
|
-
locked?: any;
|
|
5909
|
-
/** @example "{optional} Limit On Open - true|false - defaults to false" */
|
|
5910
|
-
loo?: any;
|
|
5911
|
-
/** @example "{optional} Market On Open - true|false - defaults to false" */
|
|
5912
|
-
moc?: any;
|
|
5913
|
-
/** @example "{optional} Market On Close - true|false - defaults to false" */
|
|
5914
|
-
moo?: any;
|
|
5915
|
-
/** @example "{optional} One Cancels Other - true|false - defaults to false" */
|
|
5916
|
-
oco?: any;
|
|
5917
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5918
|
-
optionRoll?: any;
|
|
5919
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5920
|
-
options?: any;
|
|
5921
|
-
/** @example "{optional}" */
|
|
5922
|
-
password?: any;
|
|
5923
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5924
|
-
prePostTrading?: any;
|
|
5925
|
-
/** @example "{optional} 1 - delayed, 0 - realtime, 4 - CBOE1, 3 - BATS" */
|
|
5926
|
-
quoteType?: any;
|
|
5927
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5928
|
-
spreads?: any;
|
|
5929
|
-
/** @example "A - active, S - suspended == initial user status" */
|
|
5930
|
-
status?: any;
|
|
5931
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5932
|
-
trailingStops?: any;
|
|
5933
|
-
/** @example "UNIQUE_USERNAME" */
|
|
5934
|
-
username?: any;
|
|
5935
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5936
|
-
/**
|
|
5937
|
-
* @tags Watchmen Ffi User Account Management
|
|
5938
|
-
* @name CreateAccount
|
|
5939
|
-
* @summary Create Account
|
|
5940
|
-
* @request POST:/rest/v1/uam/account/create
|
|
5941
|
-
* @secure
|
|
5942
|
-
*/
|
|
5943
|
-
createAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5944
|
-
/**
|
|
5945
|
-
* @tags Watchmen Ffi User Account Management
|
|
5946
|
-
* @name AccountInformation
|
|
5947
|
-
* @summary Account Information
|
|
5948
|
-
* @request GET:/rest/v1/uam/account/data
|
|
5949
|
-
* @secure
|
|
5950
|
-
*/
|
|
5951
|
-
accountInformation(query?: {
|
|
5952
|
-
/** @example "AC123456" */
|
|
5953
|
-
accountNumber?: any;
|
|
5954
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5955
|
-
/**
|
|
5956
|
-
* @tags Watchmen Ffi User Account Management
|
|
5957
|
-
* @name UserInformation
|
|
5958
|
-
* @summary User Information
|
|
5959
|
-
* @request GET:/rest/v1/uam/user/data
|
|
5960
|
-
* @secure
|
|
5961
|
-
*/
|
|
5962
|
-
userInformation(query?: {
|
|
5963
|
-
/** @example "USERNAME" */
|
|
5964
|
-
username?: any;
|
|
5965
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5966
|
-
/**
|
|
5967
|
-
* @tags Watchmen Ffi User Account Management
|
|
5968
|
-
* @name ListLinkedAccounts
|
|
5969
|
-
* @summary List Linked Accounts
|
|
5970
|
-
* @request GET:/rest/v1/linkedaccounts/listAccounts
|
|
5955
|
+
* @tags Broker
|
|
5956
|
+
* @name Portfolio
|
|
5957
|
+
* @summary Portfolio
|
|
5958
|
+
* @request GET:/v1/broker/portfolio
|
|
5971
5959
|
* @secure
|
|
5972
5960
|
*/
|
|
5973
|
-
|
|
5974
|
-
/**
|
|
5975
|
-
|
|
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;
|
|
5976
5992
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5977
|
-
/**
|
|
5978
|
-
* @tags Watchmen Ffi User Account Management
|
|
5979
|
-
* @name LinkUnlinkAccount
|
|
5980
|
-
* @summary Link/Unlink Account
|
|
5981
|
-
* @request POST:/rest/v1/linkedaccounts/linkUnlinkAccount
|
|
5982
|
-
* @secure
|
|
5983
|
-
*/
|
|
5984
|
-
linkUnlinkAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5985
|
-
/**
|
|
5986
|
-
* @tags Watchmen Ffi User Account Management
|
|
5987
|
-
* @name Visibility
|
|
5988
|
-
* @summary Visibility
|
|
5989
|
-
* @request POST:/rest/v1/linkedaccounts/visibility
|
|
5990
|
-
* @secure
|
|
5991
|
-
*/
|
|
5992
|
-
visibility(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5993
5993
|
}
|
|
5994
5994
|
export class WatchmenFfi<HandleError extends boolean = boolean> {
|
|
5995
5995
|
protected readonly apiClient: JwtClient<HandleError>;
|