@orbis-systems/orbis-api-clients 0.7.8 → 0.7.10
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 +270 -49
- package/dist/aesmidas/index.d.ts.map +1 -1
- package/dist/aesmidas/index.esm.js +1 -1
- package/dist/aesmidas/index.esm.js.map +1 -1
- package/dist/aesmidas/index.js +1 -1
- package/dist/aesmidas/index.js.map +1 -1
- package/dist/bridgewise/index.d.ts +781 -313
- package/dist/bridgewise/index.d.ts.map +1 -1
- package/dist/bridgewise/index.esm.js +1 -1
- package/dist/bridgewise/index.esm.js.map +1 -1
- package/dist/bridgewise/index.js +1 -1
- package/dist/bridgewise/index.js.map +1 -1
- package/dist/insight/index.d.ts +324 -306
- package/dist/insight/index.d.ts.map +1 -1
- package/dist/insight/index.esm.js +1 -1
- package/dist/insight/index.esm.js.map +1 -1
- package/dist/insight/index.js +1 -1
- package/dist/insight/index.js.map +1 -1
- package/dist/middleware/index.d.ts +34 -34
- package/dist/middleware/index.d.ts.map +1 -1
- package/dist/middleware/index.esm.js +1 -1
- package/dist/middleware/index.esm.js.map +1 -1
- package/dist/middleware/index.js +1 -1
- package/dist/middleware/index.js.map +1 -1
- package/dist/orbis/index.d.ts +1135 -1135
- package/dist/orbis/index.d.ts.map +1 -1
- package/dist/orbis/index.esm.js +1 -1
- package/dist/orbis/index.esm.js.map +1 -1
- package/dist/orbis/index.js +1 -1
- package/dist/orbis/index.js.map +1 -1
- package/dist/uma/index.d.ts +354 -354
- package/dist/uma/index.d.ts.map +1 -1
- package/dist/uma/index.esm.js +1 -1
- package/dist/uma/index.esm.js.map +1 -1
- package/dist/uma/index.js +1 -1
- package/dist/uma/index.js.map +1 -1
- package/dist/zerohash/index.d.ts +79 -79
- package/dist/zerohash/index.d.ts.map +1 -1
- package/dist/zerohash/index.esm.js +1 -1
- package/dist/zerohash/index.esm.js.map +1 -1
- package/dist/zerohash/index.js +1 -1
- package/dist/zerohash/index.js.map +1 -1
- package/package.json +1 -1
package/dist/orbis/index.d.ts
CHANGED
|
@@ -229,6 +229,160 @@ declare class OrbisClient<HandleError extends boolean = boolean> extends JwtClie
|
|
|
229
229
|
protected readonly config: OrbisClientConfig<HandleError>;
|
|
230
230
|
request<Data = unknown, Body = unknown>(config: RequestConfig<Body>): Promise<OrbisClientResponse<Data, HandleError>>;
|
|
231
231
|
}
|
|
232
|
+
export class OrdersV2Equities<HandleError extends boolean = boolean> {
|
|
233
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
234
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
235
|
+
/**
|
|
236
|
+
* @tags Orders V2 Equities
|
|
237
|
+
* @name Preview
|
|
238
|
+
* @summary Preview
|
|
239
|
+
* @request POST:/orders/v2/preview/equity
|
|
240
|
+
* @secure
|
|
241
|
+
*/
|
|
242
|
+
preview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
243
|
+
/**
|
|
244
|
+
* @tags Orders V2 Equities
|
|
245
|
+
* @name Placement
|
|
246
|
+
* @summary Placement
|
|
247
|
+
* @request POST:/orders/v2/place/equity
|
|
248
|
+
* @secure
|
|
249
|
+
*/
|
|
250
|
+
placement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
251
|
+
/**
|
|
252
|
+
* @tags Orders V2 Equities
|
|
253
|
+
* @name AlgoPreview
|
|
254
|
+
* @summary Algo Preview
|
|
255
|
+
* @request POST:/orders/v2/algo/preview/equity
|
|
256
|
+
* @secure
|
|
257
|
+
*/
|
|
258
|
+
algoPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
259
|
+
/**
|
|
260
|
+
* @tags Orders V2 Equities
|
|
261
|
+
* @name AlgoPlacement
|
|
262
|
+
* @summary Algo Placement
|
|
263
|
+
* @request POST:/orders/v2/algo/place/equity
|
|
264
|
+
* @secure
|
|
265
|
+
*/
|
|
266
|
+
algoPlacement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
267
|
+
/**
|
|
268
|
+
* @tags Orders V2 Equities
|
|
269
|
+
* @name BasketPreview
|
|
270
|
+
* @summary Basket preview
|
|
271
|
+
* @request POST:/orders/v2/basket/preview/equity
|
|
272
|
+
* @secure
|
|
273
|
+
*/
|
|
274
|
+
basketPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
275
|
+
/**
|
|
276
|
+
* @tags Orders V2 Equities
|
|
277
|
+
* @name BasketPlacement
|
|
278
|
+
* @summary Basket placement
|
|
279
|
+
* @request POST:/orders/v2/basket/place/equity
|
|
280
|
+
* @secure
|
|
281
|
+
*/
|
|
282
|
+
basketPlacement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
283
|
+
/**
|
|
284
|
+
* @tags Orders V2 Equities
|
|
285
|
+
* @name AdvisoryPreview
|
|
286
|
+
* @summary Advisory preview
|
|
287
|
+
* @request POST:/orders/v2/advisory/equity/preview
|
|
288
|
+
* @secure
|
|
289
|
+
*/
|
|
290
|
+
advisoryPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
291
|
+
/**
|
|
292
|
+
* @tags Orders V2 Equities
|
|
293
|
+
* @name AdvisoryPlacement
|
|
294
|
+
* @summary Advisory placement
|
|
295
|
+
* @request POST:/orders/v2/advisory/equity/place
|
|
296
|
+
* @secure
|
|
297
|
+
*/
|
|
298
|
+
advisoryPlacement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
299
|
+
/**
|
|
300
|
+
* @tags Orders V2 Equities
|
|
301
|
+
* @name PreviewSnapshot
|
|
302
|
+
* @summary Preview Snapshot
|
|
303
|
+
* @request POST:/orders/v2/preview/equity/snapshot
|
|
304
|
+
* @secure
|
|
305
|
+
*/
|
|
306
|
+
previewSnapshot(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
307
|
+
}
|
|
308
|
+
export class OrdersV2FixedIncome<HandleError extends boolean = boolean> {
|
|
309
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
310
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
311
|
+
/**
|
|
312
|
+
* @tags Orders V2 Fixed Income
|
|
313
|
+
* @name BondPlacement
|
|
314
|
+
* @summary Bond placement
|
|
315
|
+
* @request POST:/orders/v2/bonds/place
|
|
316
|
+
* @secure
|
|
317
|
+
*/
|
|
318
|
+
bondPlacement(data: {
|
|
319
|
+
account?: {
|
|
320
|
+
/** @example 123 */
|
|
321
|
+
accountId?: number;
|
|
322
|
+
/** @example "AC00123" */
|
|
323
|
+
accountNumber?: string;
|
|
324
|
+
};
|
|
325
|
+
order?: {
|
|
326
|
+
/** @example "LIMIT" */
|
|
327
|
+
orderType?: string;
|
|
328
|
+
/** @example 100 */
|
|
329
|
+
price?: number;
|
|
330
|
+
/** @example "Percentage|Decimal" */
|
|
331
|
+
priceType?: string;
|
|
332
|
+
/** @example 1000 */
|
|
333
|
+
quantity?: number;
|
|
334
|
+
/** @example "Par|Unit" */
|
|
335
|
+
quantityType?: string;
|
|
336
|
+
quote?: {
|
|
337
|
+
/** @example "412001269" */
|
|
338
|
+
cusip?: string;
|
|
339
|
+
/** @example "CUSIP:ISIN" */
|
|
340
|
+
identType?: string;
|
|
341
|
+
/** @example "SK4120012691" */
|
|
342
|
+
isin?: string;
|
|
343
|
+
};
|
|
344
|
+
/** @example "BUY|SELL" */
|
|
345
|
+
transaction?: string;
|
|
346
|
+
};
|
|
347
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
348
|
+
/**
|
|
349
|
+
* @tags Orders V2 Fixed Income
|
|
350
|
+
* @name BondOrderPreview
|
|
351
|
+
* @summary Bond order preview
|
|
352
|
+
* @request POST:/orders/v2/bonds/preview
|
|
353
|
+
* @secure
|
|
354
|
+
*/
|
|
355
|
+
bondOrderPreview(data: {
|
|
356
|
+
account?: {
|
|
357
|
+
/** @example 123 */
|
|
358
|
+
accountId?: number;
|
|
359
|
+
/** @example "AC00123" */
|
|
360
|
+
accountNumber?: string;
|
|
361
|
+
};
|
|
362
|
+
order?: {
|
|
363
|
+
/** @example "LIMIT" */
|
|
364
|
+
orderType?: string;
|
|
365
|
+
/** @example 100 */
|
|
366
|
+
price?: number;
|
|
367
|
+
/** @example "Percentage|Decimal" */
|
|
368
|
+
priceType?: string;
|
|
369
|
+
/** @example 1000 */
|
|
370
|
+
quantity?: number;
|
|
371
|
+
/** @example "Par|Unit" */
|
|
372
|
+
quantityType?: string;
|
|
373
|
+
quote?: {
|
|
374
|
+
/** @example "412001269" */
|
|
375
|
+
cusip?: string;
|
|
376
|
+
/** @example "CUSIP:ISIN" */
|
|
377
|
+
identType?: string;
|
|
378
|
+
/** @example "SK4120012691" */
|
|
379
|
+
isin?: string;
|
|
380
|
+
};
|
|
381
|
+
/** @example "BUY|SELL" */
|
|
382
|
+
transaction?: string;
|
|
383
|
+
};
|
|
384
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
385
|
+
}
|
|
232
386
|
export class OrdersV2Options<HandleError extends boolean = boolean> {
|
|
233
387
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
234
388
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -434,206 +588,96 @@ export class OrdersV2Options<HandleError extends boolean = boolean> {
|
|
|
434
588
|
};
|
|
435
589
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
436
590
|
}
|
|
437
|
-
export class
|
|
591
|
+
export class OrdersV2MutualFunds<HandleError extends boolean = boolean> {
|
|
438
592
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
439
593
|
constructor(apiClient: JwtClient<HandleError>);
|
|
440
594
|
/**
|
|
441
|
-
* @tags Orders V2
|
|
442
|
-
* @name
|
|
443
|
-
* @summary
|
|
444
|
-
* @request
|
|
595
|
+
* @tags Orders V2 Mutual Funds
|
|
596
|
+
* @name ListMutualFunds
|
|
597
|
+
* @summary List Mutual Funds
|
|
598
|
+
* @request GET:/quotes/mf/allowed
|
|
445
599
|
* @secure
|
|
446
600
|
*/
|
|
447
|
-
|
|
601
|
+
listMutualFunds(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
602
|
+
/**
|
|
603
|
+
* @tags Orders V2 Mutual Funds
|
|
604
|
+
* @name MutualFundDetails
|
|
605
|
+
* @summary Mutual Fund Details
|
|
606
|
+
* @request GET:/quotes/mf/allowed/details/{symbol}
|
|
607
|
+
* @secure
|
|
608
|
+
*/
|
|
609
|
+
mutualFundDetails(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
610
|
+
/**
|
|
611
|
+
* @tags Orders V2 Mutual Funds
|
|
612
|
+
* @name CheckMutualFund
|
|
613
|
+
* @summary Check Mutual Fund
|
|
614
|
+
* @request GET:/quotes/mf/check/{symbol}
|
|
615
|
+
* @secure
|
|
616
|
+
*/
|
|
617
|
+
checkMutualFund(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
618
|
+
/**
|
|
619
|
+
* @tags Orders V2 Mutual Funds
|
|
620
|
+
* @name MutualFundPlacement
|
|
621
|
+
* @summary Mutual fund placement
|
|
622
|
+
* @request POST:/orders/v2/mf/place
|
|
623
|
+
* @secure
|
|
624
|
+
*/
|
|
625
|
+
mutualFundPlacement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
626
|
+
/**
|
|
627
|
+
* @tags Orders V2 Mutual Funds
|
|
628
|
+
* @name MutualFundPreview
|
|
629
|
+
* @summary Mutual fund preview
|
|
630
|
+
* @request POST:/orders/v2/mf/preview
|
|
631
|
+
* @secure
|
|
632
|
+
*/
|
|
633
|
+
mutualFundPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
634
|
+
}
|
|
635
|
+
export class OrdersV2Crypto<HandleError extends boolean = boolean> {
|
|
636
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
637
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
638
|
+
/**
|
|
639
|
+
* @tags Orders V2 Crypto
|
|
640
|
+
* @name OrderPreview
|
|
641
|
+
* @summary Order Preview
|
|
642
|
+
* @request POST:/orders/v2/crypto/preview
|
|
643
|
+
* @secure
|
|
644
|
+
*/
|
|
645
|
+
orderPreview(data: {
|
|
448
646
|
account?: {
|
|
449
|
-
/** @example
|
|
450
|
-
accountId?: number;
|
|
451
|
-
/** @example "AC00123" */
|
|
647
|
+
/** @example "ABC123" */
|
|
452
648
|
accountNumber?: string;
|
|
453
649
|
};
|
|
454
650
|
order?: {
|
|
455
|
-
/** @example "LIMIT" */
|
|
456
|
-
orderType?: string;
|
|
457
651
|
/** @example 100 */
|
|
458
|
-
|
|
459
|
-
/** @example
|
|
460
|
-
|
|
461
|
-
/** @example
|
|
652
|
+
expectedValue?: number;
|
|
653
|
+
/** @example 1.123 */
|
|
654
|
+
limitPx?: number;
|
|
655
|
+
/** @example "MARKET|LIMIT|STOP|STOP_LIMIG|Notional|NotionalLimit" */
|
|
656
|
+
orderType?: string;
|
|
657
|
+
/** @example 0.0123 */
|
|
462
658
|
quantity?: number;
|
|
463
|
-
/** @example "Par|Unit" */
|
|
464
|
-
quantityType?: string;
|
|
465
659
|
quote?: {
|
|
466
|
-
/** @example "
|
|
467
|
-
|
|
468
|
-
/** @example "CUSIP:ISIN" */
|
|
469
|
-
identType?: string;
|
|
470
|
-
/** @example "SK4120012691" */
|
|
471
|
-
isin?: string;
|
|
660
|
+
/** @example "BTC/USD" */
|
|
661
|
+
symbol?: string;
|
|
472
662
|
};
|
|
663
|
+
/** @example 1.123 */
|
|
664
|
+
stopPx?: number;
|
|
473
665
|
/** @example "BUY|SELL" */
|
|
474
666
|
transaction?: string;
|
|
667
|
+
/** @example "DAY|GTC" */
|
|
668
|
+
validity?: string;
|
|
475
669
|
};
|
|
476
670
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
477
671
|
/**
|
|
478
|
-
* @tags Orders V2
|
|
479
|
-
* @name
|
|
480
|
-
* @summary
|
|
481
|
-
* @request POST:/orders/v2/
|
|
672
|
+
* @tags Orders V2 Crypto
|
|
673
|
+
* @name OrderPlace
|
|
674
|
+
* @summary Order Place
|
|
675
|
+
* @request POST:/orders/v2/crypto/place
|
|
482
676
|
* @secure
|
|
483
677
|
*/
|
|
484
|
-
|
|
678
|
+
orderPlace(data: {
|
|
485
679
|
account?: {
|
|
486
|
-
/** @example
|
|
487
|
-
accountId?: number;
|
|
488
|
-
/** @example "AC00123" */
|
|
489
|
-
accountNumber?: string;
|
|
490
|
-
};
|
|
491
|
-
order?: {
|
|
492
|
-
/** @example "LIMIT" */
|
|
493
|
-
orderType?: string;
|
|
494
|
-
/** @example 100 */
|
|
495
|
-
price?: number;
|
|
496
|
-
/** @example "Percentage|Decimal" */
|
|
497
|
-
priceType?: string;
|
|
498
|
-
/** @example 1000 */
|
|
499
|
-
quantity?: number;
|
|
500
|
-
/** @example "Par|Unit" */
|
|
501
|
-
quantityType?: string;
|
|
502
|
-
quote?: {
|
|
503
|
-
/** @example "412001269" */
|
|
504
|
-
cusip?: string;
|
|
505
|
-
/** @example "CUSIP:ISIN" */
|
|
506
|
-
identType?: string;
|
|
507
|
-
/** @example "SK4120012691" */
|
|
508
|
-
isin?: string;
|
|
509
|
-
};
|
|
510
|
-
/** @example "BUY|SELL" */
|
|
511
|
-
transaction?: string;
|
|
512
|
-
};
|
|
513
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
514
|
-
}
|
|
515
|
-
export class OrdersV2Equities<HandleError extends boolean = boolean> {
|
|
516
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
517
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
518
|
-
/**
|
|
519
|
-
* @tags Orders V2 Equities
|
|
520
|
-
* @name Preview
|
|
521
|
-
* @summary Preview
|
|
522
|
-
* @request POST:/orders/v2/preview/equity
|
|
523
|
-
* @secure
|
|
524
|
-
*/
|
|
525
|
-
preview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
526
|
-
/**
|
|
527
|
-
* @tags Orders V2 Equities
|
|
528
|
-
* @name Placement
|
|
529
|
-
* @summary Placement
|
|
530
|
-
* @request POST:/orders/v2/place/equity
|
|
531
|
-
* @secure
|
|
532
|
-
*/
|
|
533
|
-
placement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
534
|
-
/**
|
|
535
|
-
* @tags Orders V2 Equities
|
|
536
|
-
* @name AlgoPreview
|
|
537
|
-
* @summary Algo Preview
|
|
538
|
-
* @request POST:/orders/v2/algo/preview/equity
|
|
539
|
-
* @secure
|
|
540
|
-
*/
|
|
541
|
-
algoPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
542
|
-
/**
|
|
543
|
-
* @tags Orders V2 Equities
|
|
544
|
-
* @name AlgoPlacement
|
|
545
|
-
* @summary Algo Placement
|
|
546
|
-
* @request POST:/orders/v2/algo/place/equity
|
|
547
|
-
* @secure
|
|
548
|
-
*/
|
|
549
|
-
algoPlacement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
550
|
-
/**
|
|
551
|
-
* @tags Orders V2 Equities
|
|
552
|
-
* @name BasketPreview
|
|
553
|
-
* @summary Basket preview
|
|
554
|
-
* @request POST:/orders/v2/basket/preview/equity
|
|
555
|
-
* @secure
|
|
556
|
-
*/
|
|
557
|
-
basketPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
558
|
-
/**
|
|
559
|
-
* @tags Orders V2 Equities
|
|
560
|
-
* @name BasketPlacement
|
|
561
|
-
* @summary Basket placement
|
|
562
|
-
* @request POST:/orders/v2/basket/place/equity
|
|
563
|
-
* @secure
|
|
564
|
-
*/
|
|
565
|
-
basketPlacement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
566
|
-
/**
|
|
567
|
-
* @tags Orders V2 Equities
|
|
568
|
-
* @name AdvisoryPreview
|
|
569
|
-
* @summary Advisory preview
|
|
570
|
-
* @request POST:/orders/v2/advisory/equity/preview
|
|
571
|
-
* @secure
|
|
572
|
-
*/
|
|
573
|
-
advisoryPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
574
|
-
/**
|
|
575
|
-
* @tags Orders V2 Equities
|
|
576
|
-
* @name AdvisoryPlacement
|
|
577
|
-
* @summary Advisory placement
|
|
578
|
-
* @request POST:/orders/v2/advisory/equity/place
|
|
579
|
-
* @secure
|
|
580
|
-
*/
|
|
581
|
-
advisoryPlacement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
582
|
-
/**
|
|
583
|
-
* @tags Orders V2 Equities
|
|
584
|
-
* @name PreviewSnapshot
|
|
585
|
-
* @summary Preview Snapshot
|
|
586
|
-
* @request POST:/orders/v2/preview/equity/snapshot
|
|
587
|
-
* @secure
|
|
588
|
-
*/
|
|
589
|
-
previewSnapshot(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
590
|
-
}
|
|
591
|
-
export class OrdersV2Crypto<HandleError extends boolean = boolean> {
|
|
592
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
593
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
594
|
-
/**
|
|
595
|
-
* @tags Orders V2 Crypto
|
|
596
|
-
* @name OrderPreview
|
|
597
|
-
* @summary Order Preview
|
|
598
|
-
* @request POST:/orders/v2/crypto/preview
|
|
599
|
-
* @secure
|
|
600
|
-
*/
|
|
601
|
-
orderPreview(data: {
|
|
602
|
-
account?: {
|
|
603
|
-
/** @example "ABC123" */
|
|
604
|
-
accountNumber?: string;
|
|
605
|
-
};
|
|
606
|
-
order?: {
|
|
607
|
-
/** @example 100 */
|
|
608
|
-
expectedValue?: number;
|
|
609
|
-
/** @example 1.123 */
|
|
610
|
-
limitPx?: number;
|
|
611
|
-
/** @example "MARKET|LIMIT|STOP|STOP_LIMIG|Notional|NotionalLimit" */
|
|
612
|
-
orderType?: string;
|
|
613
|
-
/** @example 0.0123 */
|
|
614
|
-
quantity?: number;
|
|
615
|
-
quote?: {
|
|
616
|
-
/** @example "BTC/USD" */
|
|
617
|
-
symbol?: string;
|
|
618
|
-
};
|
|
619
|
-
/** @example 1.123 */
|
|
620
|
-
stopPx?: number;
|
|
621
|
-
/** @example "BUY|SELL" */
|
|
622
|
-
transaction?: string;
|
|
623
|
-
/** @example "DAY|GTC" */
|
|
624
|
-
validity?: string;
|
|
625
|
-
};
|
|
626
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
627
|
-
/**
|
|
628
|
-
* @tags Orders V2 Crypto
|
|
629
|
-
* @name OrderPlace
|
|
630
|
-
* @summary Order Place
|
|
631
|
-
* @request POST:/orders/v2/crypto/place
|
|
632
|
-
* @secure
|
|
633
|
-
*/
|
|
634
|
-
orderPlace(data: {
|
|
635
|
-
account?: {
|
|
636
|
-
/** @example "ABC123" */
|
|
680
|
+
/** @example "ABC123" */
|
|
637
681
|
accountNumber?: string;
|
|
638
682
|
};
|
|
639
683
|
order?: {
|
|
@@ -662,50 +706,6 @@ export class OrdersV2Crypto<HandleError extends boolean = boolean> {
|
|
|
662
706
|
};
|
|
663
707
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
664
708
|
}
|
|
665
|
-
export class OrdersV2MutualFunds<HandleError extends boolean = boolean> {
|
|
666
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
667
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
668
|
-
/**
|
|
669
|
-
* @tags Orders V2 Mutual Funds
|
|
670
|
-
* @name ListMutualFunds
|
|
671
|
-
* @summary List Mutual Funds
|
|
672
|
-
* @request GET:/quotes/mf/allowed
|
|
673
|
-
* @secure
|
|
674
|
-
*/
|
|
675
|
-
listMutualFunds(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
676
|
-
/**
|
|
677
|
-
* @tags Orders V2 Mutual Funds
|
|
678
|
-
* @name MutualFundDetails
|
|
679
|
-
* @summary Mutual Fund Details
|
|
680
|
-
* @request GET:/quotes/mf/allowed/details/{symbol}
|
|
681
|
-
* @secure
|
|
682
|
-
*/
|
|
683
|
-
mutualFundDetails(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
684
|
-
/**
|
|
685
|
-
* @tags Orders V2 Mutual Funds
|
|
686
|
-
* @name CheckMutualFund
|
|
687
|
-
* @summary Check Mutual Fund
|
|
688
|
-
* @request GET:/quotes/mf/check/{symbol}
|
|
689
|
-
* @secure
|
|
690
|
-
*/
|
|
691
|
-
checkMutualFund(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
692
|
-
/**
|
|
693
|
-
* @tags Orders V2 Mutual Funds
|
|
694
|
-
* @name MutualFundPlacement
|
|
695
|
-
* @summary Mutual fund placement
|
|
696
|
-
* @request POST:/orders/v2/mf/place
|
|
697
|
-
* @secure
|
|
698
|
-
*/
|
|
699
|
-
mutualFundPlacement(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
700
|
-
/**
|
|
701
|
-
* @tags Orders V2 Mutual Funds
|
|
702
|
-
* @name MutualFundPreview
|
|
703
|
-
* @summary Mutual fund preview
|
|
704
|
-
* @request POST:/orders/v2/mf/preview
|
|
705
|
-
* @secure
|
|
706
|
-
*/
|
|
707
|
-
mutualFundPreview(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
708
|
-
}
|
|
709
709
|
export class OrdersV2Offerings<HandleError extends boolean = boolean> {
|
|
710
710
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
711
711
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -1866,71 +1866,6 @@ export class ResearchCorporateActions<HandleError extends boolean = boolean> {
|
|
|
1866
1866
|
usePayDate?: any;
|
|
1867
1867
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1868
1868
|
}
|
|
1869
|
-
export class ResearchNews<HandleError extends boolean = boolean> {
|
|
1870
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
1871
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
1872
|
-
/**
|
|
1873
|
-
* @tags Research News
|
|
1874
|
-
* @name List
|
|
1875
|
-
* @summary List
|
|
1876
|
-
* @request GET:/research/news
|
|
1877
|
-
* @secure
|
|
1878
|
-
*/
|
|
1879
|
-
list(query?: {
|
|
1880
|
-
/** @example "0" */
|
|
1881
|
-
start?: any;
|
|
1882
|
-
/**
|
|
1883
|
-
* Defaults to 20
|
|
1884
|
-
* @example "100"
|
|
1885
|
-
*/
|
|
1886
|
-
count?: any;
|
|
1887
|
-
/** @example "[[-](provider|aggregator):value1,valueN];" */
|
|
1888
|
-
filter?: any;
|
|
1889
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1890
|
-
/**
|
|
1891
|
-
* @tags Research News
|
|
1892
|
-
* @name NewsBySymbol
|
|
1893
|
-
* @summary News by Symbol
|
|
1894
|
-
* @request GET:/research/news/ticker/{symbol}
|
|
1895
|
-
* @secure
|
|
1896
|
-
*/
|
|
1897
|
-
newsBySymbol(symbol: string, query?: {
|
|
1898
|
-
/**
|
|
1899
|
-
* Starting page (optional)
|
|
1900
|
-
* @example ""
|
|
1901
|
-
*/
|
|
1902
|
-
start?: any;
|
|
1903
|
-
/** Defaults to 20 (optional) */
|
|
1904
|
-
count?: any;
|
|
1905
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1906
|
-
/**
|
|
1907
|
-
* @tags Research News
|
|
1908
|
-
* @name Sec
|
|
1909
|
-
* @summary SEC
|
|
1910
|
-
* @request GET:/research/news/sec/{symbol}
|
|
1911
|
-
* @secure
|
|
1912
|
-
*/
|
|
1913
|
-
sec(symbol: string, query?: {
|
|
1914
|
-
/**
|
|
1915
|
-
* Starting point(optional)
|
|
1916
|
-
* @example "0"
|
|
1917
|
-
*/
|
|
1918
|
-
start?: any;
|
|
1919
|
-
/**
|
|
1920
|
-
* Defaults to 20 (optional)
|
|
1921
|
-
* @example "2"
|
|
1922
|
-
*/
|
|
1923
|
-
count?: any;
|
|
1924
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1925
|
-
/**
|
|
1926
|
-
* @tags Research News
|
|
1927
|
-
* @name Lookup
|
|
1928
|
-
* @summary Lookup
|
|
1929
|
-
* @request GET:/research/news/{newsId}
|
|
1930
|
-
* @secure
|
|
1931
|
-
*/
|
|
1932
|
-
lookup(newsId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
1933
|
-
}
|
|
1934
1869
|
export class ResearchAlphaTools<HandleError extends boolean = boolean> {
|
|
1935
1870
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
1936
1871
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -2017,375 +1952,70 @@ export class ResearchAlphaTools<HandleError extends boolean = boolean> {
|
|
|
2017
1952
|
years?: any;
|
|
2018
1953
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2019
1954
|
}
|
|
2020
|
-
export class
|
|
2021
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2022
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2023
|
-
/**
|
|
2024
|
-
* @tags Research Ipos
|
|
2025
|
-
* @name Recent
|
|
2026
|
-
* @summary Recent
|
|
2027
|
-
* @request GET:/research/ipo/recent
|
|
2028
|
-
* @secure
|
|
2029
|
-
*/
|
|
2030
|
-
recent(query?: {
|
|
2031
|
-
/**
|
|
2032
|
-
* `true` or `false` to load quotes
|
|
2033
|
-
* @example ""
|
|
2034
|
-
*/
|
|
2035
|
-
loadQuotes?: any;
|
|
2036
|
-
/** 1m, 3m*, 6m, 1y */
|
|
2037
|
-
time?: any;
|
|
2038
|
-
/** symbol, ipoDate, offerPx, shares, day1Ret, ipoRet, last, change, offerSz */
|
|
2039
|
-
sort?: any;
|
|
2040
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2041
|
-
/**
|
|
2042
|
-
* @tags Research Ipos
|
|
2043
|
-
* @name Upcoming
|
|
2044
|
-
* @summary Upcoming
|
|
2045
|
-
* @request GET:/research/ipo/upcoming
|
|
2046
|
-
* @secure
|
|
2047
|
-
*/
|
|
2048
|
-
upcoming(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2049
|
-
/**
|
|
2050
|
-
* @tags Research Ipos
|
|
2051
|
-
* @name Performance
|
|
2052
|
-
* @summary Performance
|
|
2053
|
-
* @request GET:/research/ipo/performance
|
|
2054
|
-
* @secure
|
|
2055
|
-
*/
|
|
2056
|
-
performance(query?: {
|
|
2057
|
-
/**
|
|
2058
|
-
* `true` or `false` to load quotes
|
|
2059
|
-
* @example "false"
|
|
2060
|
-
*/
|
|
2061
|
-
loadQuotes?: any;
|
|
2062
|
-
/**
|
|
2063
|
-
* 1m, 3m*, 6m, 1y
|
|
2064
|
-
* @example "1m"
|
|
2065
|
-
*/
|
|
2066
|
-
time?: any;
|
|
2067
|
-
/**
|
|
2068
|
-
* shares, day1Ret, ipoRet, last, change, offerSz
|
|
2069
|
-
* @example "day1Ret"
|
|
2070
|
-
*/
|
|
2071
|
-
sort?: any;
|
|
2072
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2073
|
-
}
|
|
2074
|
-
export class Research<HandleError extends boolean = boolean> {
|
|
1955
|
+
export class ResearchNews<HandleError extends boolean = boolean> {
|
|
2075
1956
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2076
|
-
tipranks: ResearchTipranks<HandleError>;
|
|
2077
|
-
etfs: ResearchEtfs<HandleError>;
|
|
2078
|
-
adrs: ResearchAdrs<HandleError>;
|
|
2079
|
-
corporateActions: ResearchCorporateActions<HandleError>;
|
|
2080
|
-
news: ResearchNews<HandleError>;
|
|
2081
|
-
alphaTools: ResearchAlphaTools<HandleError>;
|
|
2082
|
-
ipos: ResearchIpos<HandleError>;
|
|
2083
1957
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2084
1958
|
/**
|
|
2085
|
-
* @tags Research
|
|
2086
|
-
* @name
|
|
2087
|
-
* @summary
|
|
2088
|
-
* @request GET:/
|
|
1959
|
+
* @tags Research News
|
|
1960
|
+
* @name List
|
|
1961
|
+
* @summary List
|
|
1962
|
+
* @request GET:/research/news
|
|
2089
1963
|
* @secure
|
|
2090
1964
|
*/
|
|
2091
|
-
|
|
2092
|
-
/**
|
|
2093
|
-
|
|
2094
|
-
* @example "BIG3"
|
|
2095
|
-
*/
|
|
2096
|
-
market?: any;
|
|
2097
|
-
/**
|
|
2098
|
-
* See table above
|
|
2099
|
-
* @example "H"
|
|
2100
|
-
*/
|
|
2101
|
-
order?: any;
|
|
1965
|
+
list(query?: {
|
|
1966
|
+
/** @example "0" */
|
|
1967
|
+
start?: any;
|
|
2102
1968
|
/**
|
|
2103
|
-
*
|
|
2104
|
-
* @example "
|
|
1969
|
+
* Defaults to 20
|
|
1970
|
+
* @example "100"
|
|
2105
1971
|
*/
|
|
2106
1972
|
count?: any;
|
|
2107
|
-
|
|
2108
|
-
/**
|
|
2109
|
-
* @tags Research
|
|
2110
|
-
* @name CompanyResearch
|
|
2111
|
-
* @summary Company Research
|
|
2112
|
-
* @request GET:/research/{symbol}
|
|
2113
|
-
* @secure
|
|
2114
|
-
*/
|
|
2115
|
-
companyResearch(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2116
|
-
/**
|
|
2117
|
-
* @tags Research
|
|
2118
|
-
* @name OptionRatios
|
|
2119
|
-
* @summary Option Ratios
|
|
2120
|
-
* @request GET:/research/option/ratios
|
|
2121
|
-
* @secure
|
|
2122
|
-
*/
|
|
2123
|
-
optionRatios(query?: {
|
|
2124
|
-
/**
|
|
2125
|
-
* Comma separated list of symbols.
|
|
2126
|
-
* @example "AAPL,BABA"
|
|
2127
|
-
*/
|
|
2128
|
-
symbols?: any;
|
|
2129
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2130
|
-
/**
|
|
2131
|
-
* @tags Research
|
|
2132
|
-
* @name OptionRadar
|
|
2133
|
-
* @summary Option Radar
|
|
2134
|
-
* @request GET:/research/option/radar
|
|
2135
|
-
* @secure
|
|
2136
|
-
*/
|
|
2137
|
-
optionRadar(query?: {
|
|
2138
|
-
/**
|
|
2139
|
-
* See table above. Leaving blank returns an overview of all of them.
|
|
2140
|
-
* @example ""
|
|
2141
|
-
*/
|
|
1973
|
+
/** @example "[[-](provider|aggregator):value1,valueN];" */
|
|
2142
1974
|
filter?: any;
|
|
2143
1975
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2144
1976
|
/**
|
|
2145
|
-
* @tags Research
|
|
2146
|
-
* @name
|
|
2147
|
-
* @summary
|
|
2148
|
-
* @request GET:/research/
|
|
2149
|
-
* @secure
|
|
2150
|
-
*/
|
|
2151
|
-
indexComponents(index: string, query?: {
|
|
2152
|
-
/**
|
|
2153
|
-
* `true` or `false` to load quotes
|
|
2154
|
-
* @example "true"
|
|
2155
|
-
*/
|
|
2156
|
-
loadQuotes?: any;
|
|
2157
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2158
|
-
/**
|
|
2159
|
-
* @tags Research
|
|
2160
|
-
* @name StockUpgrades
|
|
2161
|
-
* @summary Stock Upgrades
|
|
2162
|
-
* @request GET:/research/upgrades
|
|
2163
|
-
* @secure
|
|
2164
|
-
*/
|
|
2165
|
-
stockUpgrades(query?: {
|
|
2166
|
-
/**
|
|
2167
|
-
* Comma separated list of symbols
|
|
2168
|
-
* @example "AAPL"
|
|
2169
|
-
*/
|
|
2170
|
-
symbols?: any;
|
|
2171
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2172
|
-
/**
|
|
2173
|
-
* @tags Research
|
|
2174
|
-
* @name OwnershipDetails
|
|
2175
|
-
* @summary Ownership Details
|
|
2176
|
-
* @request GET:/research/ownerships/details
|
|
1977
|
+
* @tags Research News
|
|
1978
|
+
* @name NewsBySymbol
|
|
1979
|
+
* @summary News by Symbol
|
|
1980
|
+
* @request GET:/research/news/ticker/{symbol}
|
|
2177
1981
|
* @secure
|
|
2178
1982
|
*/
|
|
2179
|
-
|
|
2180
|
-
/**
|
|
2181
|
-
* Comma separated list of tickers
|
|
2182
|
-
* @example "MSFT,GOOG"
|
|
2183
|
-
*/
|
|
2184
|
-
symbols?: any;
|
|
2185
|
-
/**
|
|
2186
|
-
* One of `ALL`, `INSTITUTIONAL`, `FUND`, `INSIDER`
|
|
2187
|
-
* @example "ALL"
|
|
2188
|
-
*/
|
|
2189
|
-
filter?: any;
|
|
2190
|
-
/**
|
|
2191
|
-
* One of `portfolio`, `ownership`, `market`
|
|
2192
|
-
* @example "portfolio"
|
|
2193
|
-
*/
|
|
2194
|
-
sort?: any;
|
|
1983
|
+
newsBySymbol(symbol: string, query?: {
|
|
2195
1984
|
/**
|
|
2196
|
-
*
|
|
2197
|
-
* @example "
|
|
1985
|
+
* Starting page (optional)
|
|
1986
|
+
* @example ""
|
|
2198
1987
|
*/
|
|
1988
|
+
start?: any;
|
|
1989
|
+
/** Defaults to 20 (optional) */
|
|
2199
1990
|
count?: any;
|
|
2200
|
-
/**
|
|
2201
|
-
* Page num (first page is zero)
|
|
2202
|
-
* @example "0"
|
|
2203
|
-
*/
|
|
2204
|
-
page?: any;
|
|
2205
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2206
|
-
/**
|
|
2207
|
-
* @tags Research
|
|
2208
|
-
* @name OwnerDetails
|
|
2209
|
-
* @summary Owner Details
|
|
2210
|
-
* @request GET:/research/owner/details
|
|
2211
|
-
* @secure
|
|
2212
|
-
*/
|
|
2213
|
-
ownerDetails(query?: {
|
|
2214
|
-
/**
|
|
2215
|
-
* Comma separated list of owner IDs
|
|
2216
|
-
* @example "PS000000YH,PS000004TI"
|
|
2217
|
-
*/
|
|
2218
|
-
ids?: any;
|
|
2219
1991
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2220
1992
|
/**
|
|
2221
|
-
* @tags Research
|
|
2222
|
-
* @name
|
|
2223
|
-
* @summary
|
|
2224
|
-
* @request GET:/research/
|
|
1993
|
+
* @tags Research News
|
|
1994
|
+
* @name Sec
|
|
1995
|
+
* @summary SEC
|
|
1996
|
+
* @request GET:/research/news/sec/{symbol}
|
|
2225
1997
|
* @secure
|
|
2226
1998
|
*/
|
|
2227
|
-
|
|
2228
|
-
/**
|
|
2229
|
-
* (Optional) Exclude Otcs from data.
|
|
2230
|
-
* @example "true"
|
|
2231
|
-
*/
|
|
2232
|
-
excludeOtcs?: any;
|
|
2233
|
-
/**
|
|
2234
|
-
* (Optional) Number of days in the future. Default is 7.
|
|
2235
|
-
* @example "90"
|
|
2236
|
-
*/
|
|
2237
|
-
days?: any;
|
|
2238
|
-
/**
|
|
2239
|
-
* `true`|`false`
|
|
2240
|
-
* @example "false"
|
|
2241
|
-
*/
|
|
2242
|
-
loadQuotes?: any;
|
|
1999
|
+
sec(symbol: string, query?: {
|
|
2243
2000
|
/**
|
|
2244
|
-
* (
|
|
2245
|
-
* @example "
|
|
2001
|
+
* Starting point(optional)
|
|
2002
|
+
* @example "0"
|
|
2246
2003
|
*/
|
|
2247
|
-
symbols?: any;
|
|
2248
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2249
|
-
/**
|
|
2250
|
-
* @tags Research
|
|
2251
|
-
* @name Fundamentals
|
|
2252
|
-
* @summary Fundamentals
|
|
2253
|
-
* @request GET:/research/fundamentals/{type}/{symbol}
|
|
2254
|
-
* @secure
|
|
2255
|
-
*/
|
|
2256
|
-
fundamentals(type: string, symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2257
|
-
/**
|
|
2258
|
-
* @tags Research
|
|
2259
|
-
* @name FundamentalTypes
|
|
2260
|
-
* @summary Fundamental Types
|
|
2261
|
-
* @request GET:/research/fundamentals/types
|
|
2262
|
-
* @secure
|
|
2263
|
-
*/
|
|
2264
|
-
fundamentalTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2265
|
-
/**
|
|
2266
|
-
* @tags Research
|
|
2267
|
-
* @name Screener
|
|
2268
|
-
* @summary Screener
|
|
2269
|
-
* @request POST:/research/screener
|
|
2270
|
-
* @secure
|
|
2271
|
-
*/
|
|
2272
|
-
screener(data: {
|
|
2273
|
-
/** @example 2 */
|
|
2274
|
-
limit?: any;
|
|
2275
|
-
/** @example [{"comparator":"Equals","dateRange":{"lowerBound":"01-01-2020","upperBound":"10-05-2020"},"field":"Industry","value":10280010}] */
|
|
2276
|
-
queries?: any;
|
|
2277
|
-
/** @example 0 */
|
|
2278
2004
|
start?: any;
|
|
2279
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2280
|
-
/**
|
|
2281
|
-
* @tags Research
|
|
2282
|
-
* @name IndustryHeatMap
|
|
2283
|
-
* @summary Industry Heat Map
|
|
2284
|
-
* @request GET:/research/heatMap/industryRanking
|
|
2285
|
-
* @secure
|
|
2286
|
-
*/
|
|
2287
|
-
industryHeatMap(query?: {
|
|
2288
|
-
/**
|
|
2289
|
-
* Can be one of the following:
|
|
2290
|
-
* Sector| Group | Industry | SubIndustry
|
|
2291
|
-
* @example "group"
|
|
2292
|
-
*/
|
|
2293
|
-
industryType?: any;
|
|
2294
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2295
|
-
/**
|
|
2296
|
-
* @tags Research
|
|
2297
|
-
* @name IndustryList
|
|
2298
|
-
* @summary Industry List
|
|
2299
|
-
* @request GET:/
|
|
2300
|
-
* @secure
|
|
2301
|
-
*/
|
|
2302
|
-
industryList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2303
|
-
/**
|
|
2304
|
-
* @tags Research
|
|
2305
|
-
* @name SymbolHeatMap
|
|
2306
|
-
* @summary Symbol Heat Map
|
|
2307
|
-
* @request GET:/research/heatMap/symbols
|
|
2308
|
-
* @secure
|
|
2309
|
-
*/
|
|
2310
|
-
symbolHeatMap(query?: {
|
|
2311
|
-
/** filter out by last price. 0 = no filter; 1 = lastPrice < 5.0; 2 = lastPrice < 1.0; 3 = lastPrice < 1.0 or lastPrice > 5.0; 4 = lastPrice > 1.0; 5 = lastPrice > 5.0 */
|
|
2312
|
-
amountLimit?: any;
|
|
2313
|
-
/** 0 indicates no filter, 1 indicates only NYSE, NASDAQ, AMEX. */
|
|
2314
|
-
exchangeFilter?: any;
|
|
2315
|
-
/** obtain from research/heatMap/industryRanking */
|
|
2316
|
-
industryCode?: any;
|
|
2317
|
-
/** max number of symbols returned */
|
|
2318
|
-
numSymbols?: any;
|
|
2319
2005
|
/**
|
|
2320
|
-
*
|
|
2321
|
-
*
|
|
2006
|
+
* Defaults to 20 (optional)
|
|
2007
|
+
* @example "2"
|
|
2322
2008
|
*/
|
|
2323
|
-
|
|
2324
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2325
|
-
/**
|
|
2326
|
-
* @tags Research
|
|
2327
|
-
* @name IndexOverview
|
|
2328
|
-
* @summary Index Overview
|
|
2329
|
-
* @request GET:/research/marketOverview
|
|
2330
|
-
* @secure
|
|
2331
|
-
*/
|
|
2332
|
-
indexOverview(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2333
|
-
/**
|
|
2334
|
-
* @tags Research
|
|
2335
|
-
* @name HistoricalData
|
|
2336
|
-
* @summary Historical Data
|
|
2337
|
-
* @request GET:/research/historicalPrices
|
|
2338
|
-
* @secure
|
|
2339
|
-
*/
|
|
2340
|
-
historicalData(query?: {
|
|
2341
|
-
symbol?: any;
|
|
2342
|
-
/** comma saperated values. each value is started with number, following `w`, `m`, or `y`. w=week, m=month, y=year. For example, to get historical price last year and last two month, dates=1y,2m */
|
|
2343
|
-
dates?: any;
|
|
2009
|
+
count?: any;
|
|
2344
2010
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2345
|
-
}
|
|
2346
|
-
export class UserWatchlists<HandleError extends boolean = boolean> {
|
|
2347
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2348
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2349
|
-
/**
|
|
2350
|
-
* @tags User Watchlists
|
|
2351
|
-
* @name CreateWatchlist
|
|
2352
|
-
* @summary Create Watchlist
|
|
2353
|
-
* @request POST:/user/v2/watchlist/create
|
|
2354
|
-
* @secure
|
|
2355
|
-
*/
|
|
2356
|
-
createWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2357
|
-
/**
|
|
2358
|
-
* @tags User Watchlists
|
|
2359
|
-
* @name RenameWatchlist
|
|
2360
|
-
* @summary Rename Watchlist
|
|
2361
|
-
* @request POST:/user/v2/watchlist/rename
|
|
2362
|
-
* @secure
|
|
2363
|
-
*/
|
|
2364
|
-
renameWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2365
2011
|
/**
|
|
2366
|
-
* @tags
|
|
2367
|
-
* @name
|
|
2368
|
-
* @summary
|
|
2369
|
-
* @request
|
|
2370
|
-
* @secure
|
|
2371
|
-
*/
|
|
2372
|
-
deleteWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2373
|
-
/**
|
|
2374
|
-
* @tags User Watchlists
|
|
2375
|
-
* @name AddToWatchlist
|
|
2376
|
-
* @summary Add to Watchlist
|
|
2377
|
-
* @request POST:/user/v2/watchlist/addEntry
|
|
2378
|
-
* @secure
|
|
2379
|
-
*/
|
|
2380
|
-
addToWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2381
|
-
/**
|
|
2382
|
-
* @tags User Watchlists
|
|
2383
|
-
* @name RemoveFromWatchlist
|
|
2384
|
-
* @summary Remove from Watchlist
|
|
2385
|
-
* @request POST:/user/v2/watchlist/removeEntry
|
|
2012
|
+
* @tags Research News
|
|
2013
|
+
* @name Lookup
|
|
2014
|
+
* @summary Lookup
|
|
2015
|
+
* @request GET:/research/news/{newsId}
|
|
2386
2016
|
* @secure
|
|
2387
2017
|
*/
|
|
2388
|
-
|
|
2018
|
+
lookup(newsId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2389
2019
|
}
|
|
2390
2020
|
export class UserDevice<HandleError extends boolean = boolean> {
|
|
2391
2021
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -2433,6 +2063,35 @@ export class UserDevice<HandleError extends boolean = boolean> {
|
|
|
2433
2063
|
token?: any;
|
|
2434
2064
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2435
2065
|
}
|
|
2066
|
+
export class UserTradingLimitManagement<HandleError extends boolean = boolean> {
|
|
2067
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2068
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2069
|
+
/**
|
|
2070
|
+
* @tags User Trading Limit Management
|
|
2071
|
+
* @name Update
|
|
2072
|
+
* @summary Update
|
|
2073
|
+
* @request POST:/user/balance/adjust
|
|
2074
|
+
* @secure
|
|
2075
|
+
*/
|
|
2076
|
+
update(data: {
|
|
2077
|
+
account?: {
|
|
2078
|
+
/** @example "AB123456" */
|
|
2079
|
+
accountNumber?: string;
|
|
2080
|
+
};
|
|
2081
|
+
/** @example 100 */
|
|
2082
|
+
adjustment?: any;
|
|
2083
|
+
/** @example "USD" */
|
|
2084
|
+
currency?: any;
|
|
2085
|
+
/** @example "something nice" */
|
|
2086
|
+
note?: any;
|
|
2087
|
+
/** @example "tbd" */
|
|
2088
|
+
reason?: any;
|
|
2089
|
+
/** @example "" */
|
|
2090
|
+
referenceNo?: any;
|
|
2091
|
+
/** @example "Delta|Absolute" */
|
|
2092
|
+
type?: any;
|
|
2093
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2094
|
+
}
|
|
2436
2095
|
export class UserAgreements<HandleError extends boolean = boolean> {
|
|
2437
2096
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2438
2097
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -2493,66 +2152,81 @@ export class UserAgreements<HandleError extends boolean = boolean> {
|
|
|
2493
2152
|
*/
|
|
2494
2153
|
cryptoSign(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2495
2154
|
}
|
|
2496
|
-
export class
|
|
2155
|
+
export class UserAttachedBanks<HandleError extends boolean = boolean> {
|
|
2497
2156
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2498
2157
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2499
2158
|
/**
|
|
2500
|
-
* @tags User
|
|
2501
|
-
* @name
|
|
2502
|
-
* @summary
|
|
2503
|
-
* @request
|
|
2159
|
+
* @tags User Attached Banks
|
|
2160
|
+
* @name Accounts
|
|
2161
|
+
* @summary Accounts
|
|
2162
|
+
* @request GET:/user/bank/accounts
|
|
2504
2163
|
* @secure
|
|
2505
2164
|
*/
|
|
2506
|
-
|
|
2507
|
-
|
|
2508
|
-
|
|
2509
|
-
|
|
2510
|
-
|
|
2511
|
-
|
|
2512
|
-
|
|
2513
|
-
|
|
2514
|
-
|
|
2515
|
-
|
|
2516
|
-
|
|
2517
|
-
|
|
2518
|
-
|
|
2519
|
-
|
|
2520
|
-
|
|
2521
|
-
/**
|
|
2522
|
-
|
|
2165
|
+
accounts(query?: {
|
|
2166
|
+
/**
|
|
2167
|
+
* Brokerage account number
|
|
2168
|
+
* @example "AC123456"
|
|
2169
|
+
*/
|
|
2170
|
+
account?: any;
|
|
2171
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2172
|
+
/**
|
|
2173
|
+
* @tags User Attached Banks
|
|
2174
|
+
* @name Balances
|
|
2175
|
+
* @summary Balances
|
|
2176
|
+
* @request GET:/user/bank/balances
|
|
2177
|
+
* @secure
|
|
2178
|
+
*/
|
|
2179
|
+
balances(query?: {
|
|
2180
|
+
/**
|
|
2181
|
+
* Brokerage account number
|
|
2182
|
+
* @example "AC123456"
|
|
2183
|
+
*/
|
|
2184
|
+
account?: any;
|
|
2523
2185
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2524
2186
|
}
|
|
2525
|
-
export class
|
|
2187
|
+
export class UserWatchlists<HandleError extends boolean = boolean> {
|
|
2526
2188
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2527
2189
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2528
2190
|
/**
|
|
2529
|
-
* @tags User
|
|
2530
|
-
* @name
|
|
2531
|
-
* @summary
|
|
2532
|
-
* @request
|
|
2191
|
+
* @tags User Watchlists
|
|
2192
|
+
* @name CreateWatchlist
|
|
2193
|
+
* @summary Create Watchlist
|
|
2194
|
+
* @request POST:/user/v2/watchlist/create
|
|
2195
|
+
* @secure
|
|
2196
|
+
*/
|
|
2197
|
+
createWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2198
|
+
/**
|
|
2199
|
+
* @tags User Watchlists
|
|
2200
|
+
* @name RenameWatchlist
|
|
2201
|
+
* @summary Rename Watchlist
|
|
2202
|
+
* @request POST:/user/v2/watchlist/rename
|
|
2203
|
+
* @secure
|
|
2204
|
+
*/
|
|
2205
|
+
renameWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2206
|
+
/**
|
|
2207
|
+
* @tags User Watchlists
|
|
2208
|
+
* @name DeleteWatchlist
|
|
2209
|
+
* @summary Delete Watchlist
|
|
2210
|
+
* @request POST:/user/v2/watchlist/delete
|
|
2211
|
+
* @secure
|
|
2212
|
+
*/
|
|
2213
|
+
deleteWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2214
|
+
/**
|
|
2215
|
+
* @tags User Watchlists
|
|
2216
|
+
* @name AddToWatchlist
|
|
2217
|
+
* @summary Add to Watchlist
|
|
2218
|
+
* @request POST:/user/v2/watchlist/addEntry
|
|
2533
2219
|
* @secure
|
|
2534
2220
|
*/
|
|
2535
|
-
|
|
2536
|
-
/**
|
|
2537
|
-
* Brokerage account number
|
|
2538
|
-
* @example "AC123456"
|
|
2539
|
-
*/
|
|
2540
|
-
account?: any;
|
|
2541
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2221
|
+
addToWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2542
2222
|
/**
|
|
2543
|
-
* @tags User
|
|
2544
|
-
* @name
|
|
2545
|
-
* @summary
|
|
2546
|
-
* @request
|
|
2223
|
+
* @tags User Watchlists
|
|
2224
|
+
* @name RemoveFromWatchlist
|
|
2225
|
+
* @summary Remove from Watchlist
|
|
2226
|
+
* @request POST:/user/v2/watchlist/removeEntry
|
|
2547
2227
|
* @secure
|
|
2548
2228
|
*/
|
|
2549
|
-
|
|
2550
|
-
/**
|
|
2551
|
-
* Brokerage account number
|
|
2552
|
-
* @example "AC123456"
|
|
2553
|
-
*/
|
|
2554
|
-
account?: any;
|
|
2555
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2229
|
+
removeFromWatchlist(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2556
2230
|
}
|
|
2557
2231
|
export class UserProfitLoss<HandleError extends boolean = boolean> {
|
|
2558
2232
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -3283,282 +2957,608 @@ export class AdvisoryCharges<HandleError extends boolean = boolean> {
|
|
|
3283
2957
|
* @request POST:/v2/charges/cancel
|
|
3284
2958
|
* @secure
|
|
3285
2959
|
*/
|
|
3286
|
-
cancel(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3287
|
-
}
|
|
3288
|
-
export class AdvisoryModels<HandleError extends boolean = boolean> {
|
|
3289
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3290
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2960
|
+
cancel(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2961
|
+
}
|
|
2962
|
+
export class AdvisoryModels<HandleError extends boolean = boolean> {
|
|
2963
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2964
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2965
|
+
/**
|
|
2966
|
+
* @tags Advisory Models
|
|
2967
|
+
* @name Listing
|
|
2968
|
+
* @summary Listing
|
|
2969
|
+
* @request GET:/v2/advisory/models
|
|
2970
|
+
* @secure
|
|
2971
|
+
*/
|
|
2972
|
+
listing(query?: {
|
|
2973
|
+
/**
|
|
2974
|
+
* true|false
|
|
2975
|
+
* @example "false"
|
|
2976
|
+
*/
|
|
2977
|
+
loadQuotes?: any;
|
|
2978
|
+
/**
|
|
2979
|
+
* true|false
|
|
2980
|
+
* @example "false"
|
|
2981
|
+
*/
|
|
2982
|
+
loadAccounts?: any;
|
|
2983
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2984
|
+
/**
|
|
2985
|
+
* @tags Advisory Models
|
|
2986
|
+
* @name ModelsByAccount
|
|
2987
|
+
* @summary Models by account
|
|
2988
|
+
* @request GET:/v2/advisory/modelsOfAccount
|
|
2989
|
+
* @secure
|
|
2990
|
+
*/
|
|
2991
|
+
modelsByAccount(query?: {
|
|
2992
|
+
/** @example "" */
|
|
2993
|
+
accountId?: any;
|
|
2994
|
+
/** @example "" */
|
|
2995
|
+
account?: any;
|
|
2996
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
2997
|
+
/**
|
|
2998
|
+
* @tags Advisory Models
|
|
2999
|
+
* @name ComponentTags
|
|
3000
|
+
* @summary Component tags
|
|
3001
|
+
* @request GET:/v2/advisory/models/components/tags
|
|
3002
|
+
* @secure
|
|
3003
|
+
*/
|
|
3004
|
+
componentTags(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3005
|
+
/**
|
|
3006
|
+
* @tags Advisory Models
|
|
3007
|
+
* @name BuyingPower
|
|
3008
|
+
* @summary Buying power
|
|
3009
|
+
* @request GET:/v2/advisory/model/balance/{currency}/{modelId}
|
|
3010
|
+
* @secure
|
|
3011
|
+
*/
|
|
3012
|
+
buyingPower(currency: string, modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3013
|
+
/**
|
|
3014
|
+
* @tags Advisory Models
|
|
3015
|
+
* @name RealtimeBalance
|
|
3016
|
+
* @summary Realtime balance
|
|
3017
|
+
* @request GET:/v2/advisory/model/rtb/{modelId}
|
|
3018
|
+
* @secure
|
|
3019
|
+
*/
|
|
3020
|
+
realtimeBalance(modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3021
|
+
/**
|
|
3022
|
+
* @tags Advisory Models
|
|
3023
|
+
* @name RealtimeBalanceHistory
|
|
3024
|
+
* @summary Realtime balance history
|
|
3025
|
+
* @request GET:/v2/advisory/model/rtb/history/{modelId}
|
|
3026
|
+
* @secure
|
|
3027
|
+
*/
|
|
3028
|
+
realtimeBalanceHistory(modelId: string, query?: {
|
|
3029
|
+
/** First page is 0 */
|
|
3030
|
+
page?: any;
|
|
3031
|
+
/** Number of entries per page. Defaults to 1,000 */
|
|
3032
|
+
count?: any;
|
|
3033
|
+
dateFrom?: any;
|
|
3034
|
+
dateTo?: any;
|
|
3035
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3036
|
+
/**
|
|
3037
|
+
* @tags Advisory Models
|
|
3038
|
+
* @name Adjustments
|
|
3039
|
+
* @summary Adjustments
|
|
3040
|
+
* @request GET:/v2/advisory/model/adjustments/{modelId}
|
|
3041
|
+
* @secure
|
|
3042
|
+
*/
|
|
3043
|
+
adjustments(modelId: string, query?: {
|
|
3044
|
+
/**
|
|
3045
|
+
* true|false
|
|
3046
|
+
* @example "false"
|
|
3047
|
+
*/
|
|
3048
|
+
loadQuotes?: any;
|
|
3049
|
+
/** Pending, Active, Complete, Rejected, Cancelled */
|
|
3050
|
+
status?: any;
|
|
3051
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3052
|
+
/**
|
|
3053
|
+
* @tags Advisory Models
|
|
3054
|
+
* @name AdjustmentPreview
|
|
3055
|
+
* @summary Adjustment preview
|
|
3056
|
+
* @request GET:/v2/advisory/model/adjustments/preview/{adjustmentId}
|
|
3057
|
+
* @secure
|
|
3058
|
+
*/
|
|
3059
|
+
adjustmentPreview(adjustmentId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3060
|
+
/**
|
|
3061
|
+
* @tags Advisory Models
|
|
3062
|
+
* @name MemberAccounts
|
|
3063
|
+
* @summary Member accounts
|
|
3064
|
+
* @request GET:/v2/advisory/model/accounts/{modelId}
|
|
3065
|
+
* @secure
|
|
3066
|
+
*/
|
|
3067
|
+
memberAccounts(modelId: string, query?: {
|
|
3068
|
+
/**
|
|
3069
|
+
* `true`|`false` - whether or not to load account's realtime balance
|
|
3070
|
+
* @example "false"
|
|
3071
|
+
*/
|
|
3072
|
+
loadRtb?: any;
|
|
3073
|
+
/**
|
|
3074
|
+
* `true`|`false` - whether or not to load account's 3 months of balance history
|
|
3075
|
+
* @example "false"
|
|
3076
|
+
*/
|
|
3077
|
+
loadRtbHistory?: any;
|
|
3078
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3079
|
+
/**
|
|
3080
|
+
* @tags Advisory Models
|
|
3081
|
+
* @name OrphanedAccounts
|
|
3082
|
+
* @summary Orphaned accounts
|
|
3083
|
+
* @request GET:/v2/advisory/model/accounts/orphaned
|
|
3084
|
+
* @secure
|
|
3085
|
+
*/
|
|
3086
|
+
orphanedAccounts(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3087
|
+
/**
|
|
3088
|
+
* @tags Advisory Models
|
|
3089
|
+
* @name MemberAccountStatistics
|
|
3090
|
+
* @summary Member account statistics
|
|
3091
|
+
* @request GET:/v2/advisory/model/accounts/stats/{modelId}
|
|
3092
|
+
* @secure
|
|
3093
|
+
*/
|
|
3094
|
+
memberAccountStatistics(modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3095
|
+
/**
|
|
3096
|
+
* @tags Advisory Models
|
|
3097
|
+
* @name MemberRealtimeBalances
|
|
3098
|
+
* @summary Member realtime balances
|
|
3099
|
+
* @request GET:/v2/advisory/model/rtbs/{modelId}
|
|
3100
|
+
* @secure
|
|
3101
|
+
*/
|
|
3102
|
+
memberRealtimeBalances(modelId: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3103
|
+
/**
|
|
3104
|
+
* @tags Advisory Models
|
|
3105
|
+
* @name Portfolio
|
|
3106
|
+
* @summary Portfolio
|
|
3107
|
+
* @request GET:/v2/advisory/model/portfolios/{modelId}
|
|
3108
|
+
* @secure
|
|
3109
|
+
*/
|
|
3110
|
+
portfolio(modelId: string, query?: {
|
|
3111
|
+
/**
|
|
3112
|
+
* Should load quotes or not.
|
|
3113
|
+
* @example "false"
|
|
3114
|
+
*/
|
|
3115
|
+
loadQuotes?: any;
|
|
3116
|
+
/**
|
|
3117
|
+
* Whether to return combined portfolio (no accounts, with approximate prices)
|
|
3118
|
+
* @example "false"
|
|
3119
|
+
*/
|
|
3120
|
+
combined?: any;
|
|
3121
|
+
/** @example "false" */
|
|
3122
|
+
loadIndustries?: any;
|
|
3123
|
+
/** @example "false" */
|
|
3124
|
+
loadUpgrades?: any;
|
|
3125
|
+
/** @example "false" */
|
|
3126
|
+
loadEarnings?: any;
|
|
3127
|
+
/**
|
|
3128
|
+
* Whether or not to include orders comprising each position's cost
|
|
3129
|
+
* @example "false"
|
|
3130
|
+
*/
|
|
3131
|
+
loadCost?: any;
|
|
3132
|
+
/**
|
|
3133
|
+
* Analyze market caps and get `marketCapWeights`. To be used in conjuction with `loadQuotes`
|
|
3134
|
+
* @example "false"
|
|
3135
|
+
*/
|
|
3136
|
+
marketCapWeights?: any;
|
|
3137
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3138
|
+
/**
|
|
3139
|
+
* @tags Advisory Models
|
|
3140
|
+
* @name AllModelBuyingPower
|
|
3141
|
+
* @summary All model buying power
|
|
3142
|
+
* @request GET:/v2/advisory/model/balances/{currency}
|
|
3143
|
+
* @secure
|
|
3144
|
+
*/
|
|
3145
|
+
allModelBuyingPower(currency: string, query?: {
|
|
3146
|
+
/**
|
|
3147
|
+
* [optional] when omitted defaults to system's setting.
|
|
3148
|
+
* @example "USD"
|
|
3149
|
+
*/
|
|
3150
|
+
currency?: any;
|
|
3151
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3152
|
+
/**
|
|
3153
|
+
* @tags Advisory Models
|
|
3154
|
+
* @name PositionLookup
|
|
3155
|
+
* @summary Position lookup
|
|
3156
|
+
* @request GET:/v2/advisory/model/position/equity/{modelId}
|
|
3157
|
+
* @secure
|
|
3158
|
+
*/
|
|
3159
|
+
positionLookup(modelId: string, query?: {
|
|
3160
|
+
symbol?: any;
|
|
3161
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3162
|
+
/**
|
|
3163
|
+
* @tags Advisory Models
|
|
3164
|
+
* @name PositionLookupOptions
|
|
3165
|
+
* @summary Position lookup (options)
|
|
3166
|
+
* @request GET:/v2/advisory/model/position/option/{modelId}
|
|
3167
|
+
* @secure
|
|
3168
|
+
*/
|
|
3169
|
+
positionLookupOptions(modelId: string, query?: {
|
|
3170
|
+
symbol?: any;
|
|
3171
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3172
|
+
/**
|
|
3173
|
+
* @tags Advisory Models
|
|
3174
|
+
* @name AdjustmentUpdates
|
|
3175
|
+
* @summary Adjustment updates
|
|
3176
|
+
* @request POST:/v2/advisory/model/adjustments/modify/{action}
|
|
3177
|
+
* @secure
|
|
3178
|
+
*/
|
|
3179
|
+
adjustmentUpdates(action: string, data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3180
|
+
/**
|
|
3181
|
+
* @tags Advisory Models
|
|
3182
|
+
* @name Creation
|
|
3183
|
+
* @summary Creation
|
|
3184
|
+
* @request POST:/v2/advisory/model/create
|
|
3185
|
+
* @secure
|
|
3186
|
+
*/
|
|
3187
|
+
creation(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3291
3188
|
/**
|
|
3292
3189
|
* @tags Advisory Models
|
|
3293
|
-
* @name
|
|
3294
|
-
* @summary
|
|
3295
|
-
* @request
|
|
3190
|
+
* @name Update
|
|
3191
|
+
* @summary Update
|
|
3192
|
+
* @request POST:/v2/advisory/model/update
|
|
3296
3193
|
* @secure
|
|
3297
3194
|
*/
|
|
3298
|
-
|
|
3299
|
-
/**
|
|
3300
|
-
* true|false
|
|
3301
|
-
* @example "false"
|
|
3302
|
-
*/
|
|
3303
|
-
loadQuotes?: any;
|
|
3304
|
-
/**
|
|
3305
|
-
* true|false
|
|
3306
|
-
* @example "false"
|
|
3307
|
-
*/
|
|
3308
|
-
loadAccounts?: any;
|
|
3309
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3195
|
+
update(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3310
3196
|
/**
|
|
3311
3197
|
* @tags Advisory Models
|
|
3312
|
-
* @name
|
|
3313
|
-
* @summary
|
|
3314
|
-
* @request
|
|
3198
|
+
* @name Deletion
|
|
3199
|
+
* @summary Deletion
|
|
3200
|
+
* @request POST:/v2/advisory/model/delete
|
|
3315
3201
|
* @secure
|
|
3316
3202
|
*/
|
|
3317
|
-
|
|
3318
|
-
/** @example "" */
|
|
3319
|
-
accountId?: any;
|
|
3320
|
-
/** @example "" */
|
|
3321
|
-
account?: any;
|
|
3322
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3203
|
+
deletion(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3323
3204
|
/**
|
|
3324
3205
|
* @tags Advisory Models
|
|
3325
|
-
* @name
|
|
3326
|
-
* @summary Component
|
|
3327
|
-
* @request
|
|
3206
|
+
* @name ComponentUpdate
|
|
3207
|
+
* @summary Component update
|
|
3208
|
+
* @request POST:/v2/advisory/model/component/update
|
|
3328
3209
|
* @secure
|
|
3329
3210
|
*/
|
|
3330
|
-
|
|
3211
|
+
componentUpdate(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3331
3212
|
/**
|
|
3332
3213
|
* @tags Advisory Models
|
|
3333
|
-
* @name
|
|
3334
|
-
* @summary
|
|
3335
|
-
* @request
|
|
3214
|
+
* @name LinkOfMemberAccounts
|
|
3215
|
+
* @summary Link of member accounts
|
|
3216
|
+
* @request POST:/v2/advisory/model/account/link
|
|
3336
3217
|
* @secure
|
|
3337
3218
|
*/
|
|
3338
|
-
|
|
3219
|
+
linkOfMemberAccounts(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3339
3220
|
/**
|
|
3340
3221
|
* @tags Advisory Models
|
|
3341
|
-
* @name
|
|
3342
|
-
* @summary
|
|
3343
|
-
* @request
|
|
3222
|
+
* @name UnlinkMemberAccount
|
|
3223
|
+
* @summary Unlink member account
|
|
3224
|
+
* @request POST:/v2/advisory/model/account/unlink
|
|
3344
3225
|
* @secure
|
|
3345
3226
|
*/
|
|
3346
|
-
|
|
3227
|
+
unlinkMemberAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3347
3228
|
/**
|
|
3348
3229
|
* @tags Advisory Models
|
|
3349
|
-
* @name
|
|
3350
|
-
* @summary
|
|
3351
|
-
* @request
|
|
3230
|
+
* @name Allocations
|
|
3231
|
+
* @summary Allocations
|
|
3232
|
+
* @request POST:/v2/advisory/model/orders/allocate
|
|
3352
3233
|
* @secure
|
|
3353
3234
|
*/
|
|
3354
|
-
|
|
3355
|
-
|
|
3356
|
-
|
|
3357
|
-
|
|
3358
|
-
|
|
3359
|
-
dateFrom?: any;
|
|
3360
|
-
dateTo?: any;
|
|
3361
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3235
|
+
allocations(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3236
|
+
}
|
|
3237
|
+
export class ResearchIpos<HandleError extends boolean = boolean> {
|
|
3238
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3239
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3362
3240
|
/**
|
|
3363
|
-
* @tags
|
|
3364
|
-
* @name
|
|
3365
|
-
* @summary
|
|
3366
|
-
* @request GET:/
|
|
3241
|
+
* @tags Research Ipos
|
|
3242
|
+
* @name Recent
|
|
3243
|
+
* @summary Recent
|
|
3244
|
+
* @request GET:/research/ipo/recent
|
|
3367
3245
|
* @secure
|
|
3368
3246
|
*/
|
|
3369
|
-
|
|
3247
|
+
recent(query?: {
|
|
3370
3248
|
/**
|
|
3371
|
-
* true
|
|
3372
|
-
* @example "
|
|
3249
|
+
* `true` or `false` to load quotes
|
|
3250
|
+
* @example ""
|
|
3373
3251
|
*/
|
|
3374
3252
|
loadQuotes?: any;
|
|
3375
|
-
/**
|
|
3376
|
-
|
|
3253
|
+
/** 1m, 3m*, 6m, 1y */
|
|
3254
|
+
time?: any;
|
|
3255
|
+
/** symbol, ipoDate, offerPx, shares, day1Ret, ipoRet, last, change, offerSz */
|
|
3256
|
+
sort?: any;
|
|
3377
3257
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3378
3258
|
/**
|
|
3379
|
-
* @tags
|
|
3380
|
-
* @name
|
|
3381
|
-
* @summary
|
|
3382
|
-
* @request GET:/
|
|
3259
|
+
* @tags Research Ipos
|
|
3260
|
+
* @name Upcoming
|
|
3261
|
+
* @summary Upcoming
|
|
3262
|
+
* @request GET:/research/ipo/upcoming
|
|
3383
3263
|
* @secure
|
|
3384
3264
|
*/
|
|
3385
|
-
|
|
3265
|
+
upcoming(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3386
3266
|
/**
|
|
3387
|
-
* @tags
|
|
3388
|
-
* @name
|
|
3389
|
-
* @summary
|
|
3390
|
-
* @request GET:/
|
|
3267
|
+
* @tags Research Ipos
|
|
3268
|
+
* @name Performance
|
|
3269
|
+
* @summary Performance
|
|
3270
|
+
* @request GET:/research/ipo/performance
|
|
3391
3271
|
* @secure
|
|
3392
3272
|
*/
|
|
3393
|
-
|
|
3273
|
+
performance(query?: {
|
|
3394
3274
|
/**
|
|
3395
|
-
* `true
|
|
3275
|
+
* `true` or `false` to load quotes
|
|
3396
3276
|
* @example "false"
|
|
3397
3277
|
*/
|
|
3398
|
-
|
|
3278
|
+
loadQuotes?: any;
|
|
3399
3279
|
/**
|
|
3400
|
-
*
|
|
3401
|
-
* @example "
|
|
3280
|
+
* 1m, 3m*, 6m, 1y
|
|
3281
|
+
* @example "1m"
|
|
3402
3282
|
*/
|
|
3403
|
-
|
|
3283
|
+
time?: any;
|
|
3284
|
+
/**
|
|
3285
|
+
* shares, day1Ret, ipoRet, last, change, offerSz
|
|
3286
|
+
* @example "day1Ret"
|
|
3287
|
+
*/
|
|
3288
|
+
sort?: any;
|
|
3404
3289
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3290
|
+
}
|
|
3291
|
+
export class Research<HandleError extends boolean = boolean> {
|
|
3292
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3293
|
+
tipranks: ResearchTipranks<HandleError>;
|
|
3294
|
+
etfs: ResearchEtfs<HandleError>;
|
|
3295
|
+
adrs: ResearchAdrs<HandleError>;
|
|
3296
|
+
corporateActions: ResearchCorporateActions<HandleError>;
|
|
3297
|
+
news: ResearchNews<HandleError>;
|
|
3298
|
+
alphaTools: ResearchAlphaTools<HandleError>;
|
|
3299
|
+
ipos: ResearchIpos<HandleError>;
|
|
3300
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3405
3301
|
/**
|
|
3406
|
-
* @tags
|
|
3407
|
-
* @name
|
|
3408
|
-
* @summary
|
|
3409
|
-
* @request GET:/
|
|
3302
|
+
* @tags Research
|
|
3303
|
+
* @name TopStocks
|
|
3304
|
+
* @summary Top Stocks
|
|
3305
|
+
* @request GET:/quotes/top10/{category}
|
|
3410
3306
|
* @secure
|
|
3411
3307
|
*/
|
|
3412
|
-
|
|
3308
|
+
topStocks(category: string, query?: {
|
|
3309
|
+
/**
|
|
3310
|
+
* See table above
|
|
3311
|
+
* @example "BIG3"
|
|
3312
|
+
*/
|
|
3313
|
+
market?: any;
|
|
3314
|
+
/**
|
|
3315
|
+
* See table above
|
|
3316
|
+
* @example "H"
|
|
3317
|
+
*/
|
|
3318
|
+
order?: any;
|
|
3319
|
+
/**
|
|
3320
|
+
* Optional. Defaults to 10
|
|
3321
|
+
* @example "10"
|
|
3322
|
+
*/
|
|
3323
|
+
count?: any;
|
|
3324
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3413
3325
|
/**
|
|
3414
|
-
* @tags
|
|
3415
|
-
* @name
|
|
3416
|
-
* @summary
|
|
3417
|
-
* @request GET:/
|
|
3326
|
+
* @tags Research
|
|
3327
|
+
* @name CompanyResearch
|
|
3328
|
+
* @summary Company Research
|
|
3329
|
+
* @request GET:/research/{symbol}
|
|
3418
3330
|
* @secure
|
|
3419
3331
|
*/
|
|
3420
|
-
|
|
3332
|
+
companyResearch(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3421
3333
|
/**
|
|
3422
|
-
* @tags
|
|
3423
|
-
* @name
|
|
3424
|
-
* @summary
|
|
3425
|
-
* @request GET:/
|
|
3334
|
+
* @tags Research
|
|
3335
|
+
* @name OptionRatios
|
|
3336
|
+
* @summary Option Ratios
|
|
3337
|
+
* @request GET:/research/option/ratios
|
|
3426
3338
|
* @secure
|
|
3427
3339
|
*/
|
|
3428
|
-
|
|
3340
|
+
optionRatios(query?: {
|
|
3341
|
+
/**
|
|
3342
|
+
* Comma separated list of symbols.
|
|
3343
|
+
* @example "AAPL,BABA"
|
|
3344
|
+
*/
|
|
3345
|
+
symbols?: any;
|
|
3346
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3429
3347
|
/**
|
|
3430
|
-
* @tags
|
|
3431
|
-
* @name
|
|
3432
|
-
* @summary
|
|
3433
|
-
* @request GET:/
|
|
3348
|
+
* @tags Research
|
|
3349
|
+
* @name OptionRadar
|
|
3350
|
+
* @summary Option Radar
|
|
3351
|
+
* @request GET:/research/option/radar
|
|
3434
3352
|
* @secure
|
|
3435
3353
|
*/
|
|
3436
|
-
|
|
3354
|
+
optionRadar(query?: {
|
|
3355
|
+
/**
|
|
3356
|
+
* See table above. Leaving blank returns an overview of all of them.
|
|
3357
|
+
* @example ""
|
|
3358
|
+
*/
|
|
3359
|
+
filter?: any;
|
|
3360
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3361
|
+
/**
|
|
3362
|
+
* @tags Research
|
|
3363
|
+
* @name IndexComponents
|
|
3364
|
+
* @summary Index Components
|
|
3365
|
+
* @request GET:/research/index/components/{index}
|
|
3366
|
+
* @secure
|
|
3367
|
+
*/
|
|
3368
|
+
indexComponents(index: string, query?: {
|
|
3369
|
+
/**
|
|
3370
|
+
* `true` or `false` to load quotes
|
|
3371
|
+
* @example "true"
|
|
3372
|
+
*/
|
|
3373
|
+
loadQuotes?: any;
|
|
3374
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3375
|
+
/**
|
|
3376
|
+
* @tags Research
|
|
3377
|
+
* @name StockUpgrades
|
|
3378
|
+
* @summary Stock Upgrades
|
|
3379
|
+
* @request GET:/research/upgrades
|
|
3380
|
+
* @secure
|
|
3381
|
+
*/
|
|
3382
|
+
stockUpgrades(query?: {
|
|
3383
|
+
/**
|
|
3384
|
+
* Comma separated list of symbols
|
|
3385
|
+
* @example "AAPL"
|
|
3386
|
+
*/
|
|
3387
|
+
symbols?: any;
|
|
3388
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3389
|
+
/**
|
|
3390
|
+
* @tags Research
|
|
3391
|
+
* @name OwnershipDetails
|
|
3392
|
+
* @summary Ownership Details
|
|
3393
|
+
* @request GET:/research/ownerships/details
|
|
3394
|
+
* @secure
|
|
3395
|
+
*/
|
|
3396
|
+
ownershipDetails(query?: {
|
|
3397
|
+
/**
|
|
3398
|
+
* Comma separated list of tickers
|
|
3399
|
+
* @example "MSFT,GOOG"
|
|
3400
|
+
*/
|
|
3401
|
+
symbols?: any;
|
|
3437
3402
|
/**
|
|
3438
|
-
*
|
|
3439
|
-
* @example "
|
|
3403
|
+
* One of `ALL`, `INSTITUTIONAL`, `FUND`, `INSIDER`
|
|
3404
|
+
* @example "ALL"
|
|
3440
3405
|
*/
|
|
3441
|
-
|
|
3406
|
+
filter?: any;
|
|
3442
3407
|
/**
|
|
3443
|
-
*
|
|
3444
|
-
* @example "
|
|
3408
|
+
* One of `portfolio`, `ownership`, `market`
|
|
3409
|
+
* @example "portfolio"
|
|
3445
3410
|
*/
|
|
3446
|
-
|
|
3447
|
-
/** @example "false" */
|
|
3448
|
-
loadIndustries?: any;
|
|
3449
|
-
/** @example "false" */
|
|
3450
|
-
loadUpgrades?: any;
|
|
3451
|
-
/** @example "false" */
|
|
3452
|
-
loadEarnings?: any;
|
|
3411
|
+
sort?: any;
|
|
3453
3412
|
/**
|
|
3454
|
-
*
|
|
3455
|
-
* @example "
|
|
3413
|
+
* Number of items per page
|
|
3414
|
+
* @example "20"
|
|
3456
3415
|
*/
|
|
3457
|
-
|
|
3416
|
+
count?: any;
|
|
3458
3417
|
/**
|
|
3459
|
-
*
|
|
3460
|
-
* @example "
|
|
3418
|
+
* Page num (first page is zero)
|
|
3419
|
+
* @example "0"
|
|
3461
3420
|
*/
|
|
3462
|
-
|
|
3421
|
+
page?: any;
|
|
3463
3422
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3464
3423
|
/**
|
|
3465
|
-
* @tags
|
|
3466
|
-
* @name
|
|
3467
|
-
* @summary
|
|
3468
|
-
* @request GET:/
|
|
3424
|
+
* @tags Research
|
|
3425
|
+
* @name OwnerDetails
|
|
3426
|
+
* @summary Owner Details
|
|
3427
|
+
* @request GET:/research/owner/details
|
|
3469
3428
|
* @secure
|
|
3470
3429
|
*/
|
|
3471
|
-
|
|
3430
|
+
ownerDetails(query?: {
|
|
3472
3431
|
/**
|
|
3473
|
-
*
|
|
3474
|
-
* @example "
|
|
3432
|
+
* Comma separated list of owner IDs
|
|
3433
|
+
* @example "PS000000YH,PS000004TI"
|
|
3475
3434
|
*/
|
|
3476
|
-
|
|
3477
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3478
|
-
/**
|
|
3479
|
-
* @tags Advisory Models
|
|
3480
|
-
* @name PositionLookup
|
|
3481
|
-
* @summary Position lookup
|
|
3482
|
-
* @request GET:/v2/advisory/model/position/equity/{modelId}
|
|
3483
|
-
* @secure
|
|
3484
|
-
*/
|
|
3485
|
-
positionLookup(modelId: string, query?: {
|
|
3486
|
-
symbol?: any;
|
|
3435
|
+
ids?: any;
|
|
3487
3436
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3488
3437
|
/**
|
|
3489
|
-
* @tags
|
|
3490
|
-
* @name
|
|
3491
|
-
* @summary
|
|
3492
|
-
* @request GET:/
|
|
3438
|
+
* @tags Research
|
|
3439
|
+
* @name EarningsCalendar
|
|
3440
|
+
* @summary Earnings Calendar
|
|
3441
|
+
* @request GET:/research/earnings
|
|
3493
3442
|
* @secure
|
|
3494
3443
|
*/
|
|
3495
|
-
|
|
3496
|
-
|
|
3444
|
+
earningsCalendar(query?: {
|
|
3445
|
+
/**
|
|
3446
|
+
* (Optional) Exclude Otcs from data.
|
|
3447
|
+
* @example "true"
|
|
3448
|
+
*/
|
|
3449
|
+
excludeOtcs?: any;
|
|
3450
|
+
/**
|
|
3451
|
+
* (Optional) Number of days in the future. Default is 7.
|
|
3452
|
+
* @example "90"
|
|
3453
|
+
*/
|
|
3454
|
+
days?: any;
|
|
3455
|
+
/**
|
|
3456
|
+
* `true`|`false`
|
|
3457
|
+
* @example "false"
|
|
3458
|
+
*/
|
|
3459
|
+
loadQuotes?: any;
|
|
3460
|
+
/**
|
|
3461
|
+
* (Optional) Use to filter results only to selected symbols. Excluding this parameter gives all upcoming earnings.
|
|
3462
|
+
* @example "AAPL,T,GOOGL"
|
|
3463
|
+
*/
|
|
3464
|
+
symbols?: any;
|
|
3497
3465
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3498
3466
|
/**
|
|
3499
|
-
* @tags
|
|
3500
|
-
* @name
|
|
3501
|
-
* @summary
|
|
3502
|
-
* @request
|
|
3467
|
+
* @tags Research
|
|
3468
|
+
* @name Fundamentals
|
|
3469
|
+
* @summary Fundamentals
|
|
3470
|
+
* @request GET:/research/fundamentals/{type}/{symbol}
|
|
3503
3471
|
* @secure
|
|
3504
3472
|
*/
|
|
3505
|
-
|
|
3473
|
+
fundamentals(type: string, symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3506
3474
|
/**
|
|
3507
|
-
* @tags
|
|
3508
|
-
* @name
|
|
3509
|
-
* @summary
|
|
3510
|
-
* @request
|
|
3475
|
+
* @tags Research
|
|
3476
|
+
* @name FundamentalTypes
|
|
3477
|
+
* @summary Fundamental Types
|
|
3478
|
+
* @request GET:/research/fundamentals/types
|
|
3511
3479
|
* @secure
|
|
3512
3480
|
*/
|
|
3513
|
-
|
|
3481
|
+
fundamentalTypes(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3514
3482
|
/**
|
|
3515
|
-
* @tags
|
|
3516
|
-
* @name
|
|
3517
|
-
* @summary
|
|
3518
|
-
* @request POST:/
|
|
3483
|
+
* @tags Research
|
|
3484
|
+
* @name Screener
|
|
3485
|
+
* @summary Screener
|
|
3486
|
+
* @request POST:/research/screener
|
|
3519
3487
|
* @secure
|
|
3520
3488
|
*/
|
|
3521
|
-
|
|
3489
|
+
screener(data: {
|
|
3490
|
+
/** @example 2 */
|
|
3491
|
+
limit?: any;
|
|
3492
|
+
/** @example [{"comparator":"Equals","dateRange":{"lowerBound":"01-01-2020","upperBound":"10-05-2020"},"field":"Industry","value":10280010}] */
|
|
3493
|
+
queries?: any;
|
|
3494
|
+
/** @example 0 */
|
|
3495
|
+
start?: any;
|
|
3496
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3522
3497
|
/**
|
|
3523
|
-
* @tags
|
|
3524
|
-
* @name
|
|
3525
|
-
* @summary
|
|
3526
|
-
* @request
|
|
3498
|
+
* @tags Research
|
|
3499
|
+
* @name IndustryHeatMap
|
|
3500
|
+
* @summary Industry Heat Map
|
|
3501
|
+
* @request GET:/research/heatMap/industryRanking
|
|
3527
3502
|
* @secure
|
|
3528
3503
|
*/
|
|
3529
|
-
|
|
3504
|
+
industryHeatMap(query?: {
|
|
3505
|
+
/**
|
|
3506
|
+
* Can be one of the following:
|
|
3507
|
+
* Sector| Group | Industry | SubIndustry
|
|
3508
|
+
* @example "group"
|
|
3509
|
+
*/
|
|
3510
|
+
industryType?: any;
|
|
3511
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3530
3512
|
/**
|
|
3531
|
-
* @tags
|
|
3532
|
-
* @name
|
|
3533
|
-
* @summary
|
|
3534
|
-
* @request
|
|
3513
|
+
* @tags Research
|
|
3514
|
+
* @name IndustryList
|
|
3515
|
+
* @summary Industry List
|
|
3516
|
+
* @request GET:/
|
|
3535
3517
|
* @secure
|
|
3536
3518
|
*/
|
|
3537
|
-
|
|
3519
|
+
industryList(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3538
3520
|
/**
|
|
3539
|
-
* @tags
|
|
3540
|
-
* @name
|
|
3541
|
-
* @summary
|
|
3542
|
-
* @request
|
|
3521
|
+
* @tags Research
|
|
3522
|
+
* @name SymbolHeatMap
|
|
3523
|
+
* @summary Symbol Heat Map
|
|
3524
|
+
* @request GET:/research/heatMap/symbols
|
|
3543
3525
|
* @secure
|
|
3544
3526
|
*/
|
|
3545
|
-
|
|
3527
|
+
symbolHeatMap(query?: {
|
|
3528
|
+
/** filter out by last price. 0 = no filter; 1 = lastPrice < 5.0; 2 = lastPrice < 1.0; 3 = lastPrice < 1.0 or lastPrice > 5.0; 4 = lastPrice > 1.0; 5 = lastPrice > 5.0 */
|
|
3529
|
+
amountLimit?: any;
|
|
3530
|
+
/** 0 indicates no filter, 1 indicates only NYSE, NASDAQ, AMEX. */
|
|
3531
|
+
exchangeFilter?: any;
|
|
3532
|
+
/** obtain from research/heatMap/industryRanking */
|
|
3533
|
+
industryCode?: any;
|
|
3534
|
+
/** max number of symbols returned */
|
|
3535
|
+
numSymbols?: any;
|
|
3536
|
+
/**
|
|
3537
|
+
* `true` or `false`. true = top symbols change by price;
|
|
3538
|
+
* false = bottom symbols channged by price.
|
|
3539
|
+
*/
|
|
3540
|
+
top?: any;
|
|
3541
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3546
3542
|
/**
|
|
3547
|
-
* @tags
|
|
3548
|
-
* @name
|
|
3549
|
-
* @summary
|
|
3550
|
-
* @request
|
|
3543
|
+
* @tags Research
|
|
3544
|
+
* @name IndexOverview
|
|
3545
|
+
* @summary Index Overview
|
|
3546
|
+
* @request GET:/research/marketOverview
|
|
3551
3547
|
* @secure
|
|
3552
3548
|
*/
|
|
3553
|
-
|
|
3549
|
+
indexOverview(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3554
3550
|
/**
|
|
3555
|
-
* @tags
|
|
3556
|
-
* @name
|
|
3557
|
-
* @summary
|
|
3558
|
-
* @request
|
|
3551
|
+
* @tags Research
|
|
3552
|
+
* @name HistoricalData
|
|
3553
|
+
* @summary Historical Data
|
|
3554
|
+
* @request GET:/research/historicalPrices
|
|
3559
3555
|
* @secure
|
|
3560
3556
|
*/
|
|
3561
|
-
|
|
3557
|
+
historicalData(query?: {
|
|
3558
|
+
symbol?: any;
|
|
3559
|
+
/** comma saperated values. each value is started with number, following `w`, `m`, or `y`. w=week, m=month, y=year. For example, to get historical price last year and last two month, dates=1y,2m */
|
|
3560
|
+
dates?: any;
|
|
3561
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3562
3562
|
}
|
|
3563
3563
|
export class AdvisoryUserAccountManagement<HandleError extends boolean = boolean> {
|
|
3564
3564
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -3762,6 +3762,24 @@ export class AdvisoryAnalytics<HandleError extends boolean = boolean> {
|
|
|
3762
3762
|
threshold?: any;
|
|
3763
3763
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3764
3764
|
}
|
|
3765
|
+
export class Device<HandleError extends boolean = boolean> {
|
|
3766
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3767
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3768
|
+
/**
|
|
3769
|
+
* @tags Device
|
|
3770
|
+
* @name DeviceDeactivate
|
|
3771
|
+
* @summary /device/deactivate
|
|
3772
|
+
* @request POST:/device/deactivate
|
|
3773
|
+
* @secure
|
|
3774
|
+
*/
|
|
3775
|
+
deviceDeactivate(data: {
|
|
3776
|
+
/**
|
|
3777
|
+
* Token previously registered
|
|
3778
|
+
* @example "123456789"
|
|
3779
|
+
*/
|
|
3780
|
+
Token?: string;
|
|
3781
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3782
|
+
}
|
|
3765
3783
|
export class AdvisoryAllocations<HandleError extends boolean = boolean> {
|
|
3766
3784
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3767
3785
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -3814,24 +3832,6 @@ export class AdvisoryAllocations<HandleError extends boolean = boolean> {
|
|
|
3814
3832
|
*/
|
|
3815
3833
|
trigger(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3816
3834
|
}
|
|
3817
|
-
export class Device<HandleError extends boolean = boolean> {
|
|
3818
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3819
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3820
|
-
/**
|
|
3821
|
-
* @tags Device
|
|
3822
|
-
* @name DeviceDeactivate
|
|
3823
|
-
* @summary /device/deactivate
|
|
3824
|
-
* @request POST:/device/deactivate
|
|
3825
|
-
* @secure
|
|
3826
|
-
*/
|
|
3827
|
-
deviceDeactivate(data: {
|
|
3828
|
-
/**
|
|
3829
|
-
* Token previously registered
|
|
3830
|
-
* @example "123456789"
|
|
3831
|
-
*/
|
|
3832
|
-
Token?: string;
|
|
3833
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
3834
|
-
}
|
|
3835
3835
|
export class TransfersRelationships<HandleError extends boolean = boolean> {
|
|
3836
3836
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3837
3837
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4155,26 +4155,6 @@ export class TransfersInstantAccountVerification<HandleError extends boolean = b
|
|
|
4155
4155
|
remoteDevice?: any;
|
|
4156
4156
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4157
4157
|
}
|
|
4158
|
-
export class TransfersAch<HandleError extends boolean = boolean> {
|
|
4159
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4160
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4161
|
-
/**
|
|
4162
|
-
* @tags Transfers Ach
|
|
4163
|
-
* @name Deposit
|
|
4164
|
-
* @summary Deposit
|
|
4165
|
-
* @request POST:/transfer/ach/deposit
|
|
4166
|
-
* @secure
|
|
4167
|
-
*/
|
|
4168
|
-
deposit(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4169
|
-
/**
|
|
4170
|
-
* @tags Transfers Ach
|
|
4171
|
-
* @name Withdraw
|
|
4172
|
-
* @summary Withdraw
|
|
4173
|
-
* @request POST:/transfer/ach/withdraw
|
|
4174
|
-
* @secure
|
|
4175
|
-
*/
|
|
4176
|
-
withdraw(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4177
|
-
}
|
|
4178
4158
|
export class TransfersAcats<HandleError extends boolean = boolean> {
|
|
4179
4159
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4180
4160
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4308,6 +4288,26 @@ export class TransfersAcats<HandleError extends boolean = boolean> {
|
|
|
4308
4288
|
type?: string;
|
|
4309
4289
|
}[], config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4310
4290
|
}
|
|
4291
|
+
export class TransfersAch<HandleError extends boolean = boolean> {
|
|
4292
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4293
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4294
|
+
/**
|
|
4295
|
+
* @tags Transfers Ach
|
|
4296
|
+
* @name Deposit
|
|
4297
|
+
* @summary Deposit
|
|
4298
|
+
* @request POST:/transfer/ach/deposit
|
|
4299
|
+
* @secure
|
|
4300
|
+
*/
|
|
4301
|
+
deposit(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4302
|
+
/**
|
|
4303
|
+
* @tags Transfers Ach
|
|
4304
|
+
* @name Withdraw
|
|
4305
|
+
* @summary Withdraw
|
|
4306
|
+
* @request POST:/transfer/ach/withdraw
|
|
4307
|
+
* @secure
|
|
4308
|
+
*/
|
|
4309
|
+
withdraw(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
4310
|
+
}
|
|
4311
4311
|
export class TransfersWires<HandleError extends boolean = boolean> {
|
|
4312
4312
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4313
4313
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5385,111 +5385,6 @@ export class LegalDocuments<HandleError extends boolean = boolean> {
|
|
|
5385
5385
|
remoteDevice?: any;
|
|
5386
5386
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5387
5387
|
}
|
|
5388
|
-
export class BlacklistAdminBusinesses<HandleError extends boolean = boolean> {
|
|
5389
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5390
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5391
|
-
/**
|
|
5392
|
-
* @tags Blacklist Admin Businesses
|
|
5393
|
-
* @name GetBusinessesList
|
|
5394
|
-
* @summary Get Businesses list
|
|
5395
|
-
* @request GET:/v1/admin/businesses
|
|
5396
|
-
* @secure
|
|
5397
|
-
*/
|
|
5398
|
-
getBusinessesList(query?: {
|
|
5399
|
-
/**
|
|
5400
|
-
* (Required) page number
|
|
5401
|
-
* @example "5567183"
|
|
5402
|
-
*/
|
|
5403
|
-
page?: any;
|
|
5404
|
-
/**
|
|
5405
|
-
* (Required) page size in records displayed
|
|
5406
|
-
* @example "5567183"
|
|
5407
|
-
*/
|
|
5408
|
-
page_size?: any;
|
|
5409
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5410
|
-
/**
|
|
5411
|
-
* @tags Blacklist Admin Businesses
|
|
5412
|
-
* @name CreateBusiness
|
|
5413
|
-
* @summary Create Business
|
|
5414
|
-
* @request POST:/v1/admin/businesses
|
|
5415
|
-
* @secure
|
|
5416
|
-
*/
|
|
5417
|
-
createBusiness(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 GetBusinessById
|
|
5446
|
-
* @summary Get Business by ID
|
|
5447
|
-
* @request GET:/v1/admin/businesses/{id}
|
|
5448
|
-
* @secure
|
|
5449
|
-
*/
|
|
5450
|
-
getBusinessById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5451
|
-
/**
|
|
5452
|
-
* @tags Blacklist Admin Businesses
|
|
5453
|
-
* @name UpdateBusiness
|
|
5454
|
-
* @summary Update Business
|
|
5455
|
-
* @request PUT:/v1/admin/businesses/{id}
|
|
5456
|
-
* @secure
|
|
5457
|
-
*/
|
|
5458
|
-
updateBusiness(id: string, data: {
|
|
5459
|
-
/** @example "Gracia Marina" */
|
|
5460
|
-
business_name?: any;
|
|
5461
|
-
/** @example "Los Angeles" */
|
|
5462
|
-
city?: any;
|
|
5463
|
-
/** @example "US" */
|
|
5464
|
-
country?: any;
|
|
5465
|
-
/** @example "La Granja Del Camaron" */
|
|
5466
|
-
dba_name?: any;
|
|
5467
|
-
/** @example "" */
|
|
5468
|
-
incorporated?: any;
|
|
5469
|
-
/** @example "812748955" */
|
|
5470
|
-
number?: any;
|
|
5471
|
-
/** @example "EIN" */
|
|
5472
|
-
number_type?: any;
|
|
5473
|
-
/** @example "" */
|
|
5474
|
-
phone?: any;
|
|
5475
|
-
/** @example "CA" */
|
|
5476
|
-
state?: any;
|
|
5477
|
-
/** @example "1119 E 8th St Ste C" */
|
|
5478
|
-
street?: any;
|
|
5479
|
-
/** @example "304902" */
|
|
5480
|
-
tracking_number?: any;
|
|
5481
|
-
/** @example "90021" */
|
|
5482
|
-
zip?: any;
|
|
5483
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5484
|
-
/**
|
|
5485
|
-
* @tags Blacklist Admin Businesses
|
|
5486
|
-
* @name DeleteBusiness
|
|
5487
|
-
* @summary Delete Business
|
|
5488
|
-
* @request DELETE:/v1/admin/businesses/{id}
|
|
5489
|
-
* @secure
|
|
5490
|
-
*/
|
|
5491
|
-
deleteBusiness(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5492
|
-
}
|
|
5493
5388
|
export class BlacklistAdminIndividuals<HandleError extends boolean = boolean> {
|
|
5494
5389
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5495
5390
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5661,35 +5556,6 @@ export class BlacklistSearch<HandleError extends boolean = boolean> {
|
|
|
5661
5556
|
};
|
|
5662
5557
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5663
5558
|
}
|
|
5664
|
-
export class Blacklist<HandleError extends boolean = boolean> {
|
|
5665
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5666
|
-
adminBusinesses: BlacklistAdminBusinesses<HandleError>;
|
|
5667
|
-
adminIndividuals: BlacklistAdminIndividuals<HandleError>;
|
|
5668
|
-
search: BlacklistSearch<HandleError>;
|
|
5669
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5670
|
-
/**
|
|
5671
|
-
* @tags Blacklist
|
|
5672
|
-
* @name UploadBlacklistCsv
|
|
5673
|
-
* @summary Upload Blacklist CSV
|
|
5674
|
-
* @request POST:/v1/csv/upload
|
|
5675
|
-
* @secure
|
|
5676
|
-
*/
|
|
5677
|
-
uploadBlacklistCsv(data: {
|
|
5678
|
-
/**
|
|
5679
|
-
* (Required) file with info to upload
|
|
5680
|
-
* @format binary
|
|
5681
|
-
*/
|
|
5682
|
-
file_field?: File;
|
|
5683
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5684
|
-
/**
|
|
5685
|
-
* @tags Blacklist
|
|
5686
|
-
* @name GetHealth
|
|
5687
|
-
* @summary Get Health
|
|
5688
|
-
* @request GET:/v1/healthz
|
|
5689
|
-
* @secure
|
|
5690
|
-
*/
|
|
5691
|
-
getHealth(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5692
|
-
}
|
|
5693
5559
|
export class Broker<HandleError extends boolean = boolean> {
|
|
5694
5560
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5695
5561
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5733,144 +5599,139 @@ export class Broker<HandleError extends boolean = boolean> {
|
|
|
5733
5599
|
pageSize?: any;
|
|
5734
5600
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5735
5601
|
}
|
|
5736
|
-
export class
|
|
5602
|
+
export class BlacklistAdminBusinesses<HandleError extends boolean = boolean> {
|
|
5737
5603
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5738
5604
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5739
5605
|
/**
|
|
5740
|
-
* @tags
|
|
5741
|
-
* @name
|
|
5742
|
-
* @summary
|
|
5743
|
-
* @request
|
|
5606
|
+
* @tags Blacklist Admin Businesses
|
|
5607
|
+
* @name GetBusinessesList
|
|
5608
|
+
* @summary Get Businesses list
|
|
5609
|
+
* @request GET:/v1/admin/businesses
|
|
5744
5610
|
* @secure
|
|
5745
5611
|
*/
|
|
5746
|
-
|
|
5747
|
-
/**
|
|
5748
|
-
|
|
5749
|
-
|
|
5750
|
-
|
|
5751
|
-
|
|
5752
|
-
|
|
5753
|
-
|
|
5754
|
-
|
|
5755
|
-
|
|
5756
|
-
|
|
5757
|
-
/** @example "{optional} e-mail address" */
|
|
5758
|
-
email?: any;
|
|
5759
|
-
/** @example "{optional} true|false - defaults to true" */
|
|
5760
|
-
isTradingEnabled?: any;
|
|
5761
|
-
/** @example "{optional} Limit On Close - true|false - defaults to false" */
|
|
5762
|
-
loc?: any;
|
|
5763
|
-
/** @example "{optional} true|false - whether user is locked" */
|
|
5764
|
-
locked?: any;
|
|
5765
|
-
/** @example "{optional} Limit On Open - true|false - defaults to false" */
|
|
5766
|
-
loo?: any;
|
|
5767
|
-
/** @example "{optional} Market On Open - true|false - defaults to false" */
|
|
5768
|
-
moc?: any;
|
|
5769
|
-
/** @example "{optional} Market On Close - true|false - defaults to false" */
|
|
5770
|
-
moo?: any;
|
|
5771
|
-
/** @example "{optional} One Cancels Other - true|false - defaults to false" */
|
|
5772
|
-
oco?: any;
|
|
5773
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5774
|
-
optionRoll?: any;
|
|
5775
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5776
|
-
options?: any;
|
|
5777
|
-
/** @example "{optional}" */
|
|
5778
|
-
password?: any;
|
|
5779
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5780
|
-
prePostTrading?: any;
|
|
5781
|
-
/** @example "{optional} 1 - delayed, 0 - realtime, 4 - CBOE1, 3 - BATS" */
|
|
5782
|
-
quoteType?: any;
|
|
5783
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5784
|
-
spreads?: any;
|
|
5785
|
-
/** @example "A - active, S - suspended == initial user status" */
|
|
5786
|
-
status?: any;
|
|
5787
|
-
/** @example "{optional} true|false - defaults to false" */
|
|
5788
|
-
trailingStops?: any;
|
|
5789
|
-
/** @example "UNIQUE_USERNAME" */
|
|
5790
|
-
username?: any;
|
|
5612
|
+
getBusinessesList(query?: {
|
|
5613
|
+
/**
|
|
5614
|
+
* (Required) page number
|
|
5615
|
+
* @example "5567183"
|
|
5616
|
+
*/
|
|
5617
|
+
page?: any;
|
|
5618
|
+
/**
|
|
5619
|
+
* (Required) page size in records displayed
|
|
5620
|
+
* @example "5567183"
|
|
5621
|
+
*/
|
|
5622
|
+
page_size?: any;
|
|
5791
5623
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5792
5624
|
/**
|
|
5793
|
-
* @tags
|
|
5794
|
-
* @name
|
|
5795
|
-
* @summary Create
|
|
5796
|
-
* @request POST:/
|
|
5797
|
-
* @secure
|
|
5798
|
-
*/
|
|
5799
|
-
createAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5800
|
-
/**
|
|
5801
|
-
* @tags Watchmen Ffi User Account Management
|
|
5802
|
-
* @name AccountInformation
|
|
5803
|
-
* @summary Account Information
|
|
5804
|
-
* @request GET:/rest/v1/uam/account/data
|
|
5625
|
+
* @tags Blacklist Admin Businesses
|
|
5626
|
+
* @name CreateBusiness
|
|
5627
|
+
* @summary Create Business
|
|
5628
|
+
* @request POST:/v1/admin/businesses
|
|
5805
5629
|
* @secure
|
|
5806
5630
|
*/
|
|
5807
|
-
|
|
5808
|
-
/** @example "
|
|
5809
|
-
|
|
5631
|
+
createBusiness(data: {
|
|
5632
|
+
/** @example "Gracia Marina" */
|
|
5633
|
+
business_name?: any;
|
|
5634
|
+
/** @example "Los Angeles" */
|
|
5635
|
+
city?: any;
|
|
5636
|
+
/** @example "US" */
|
|
5637
|
+
country?: any;
|
|
5638
|
+
/** @example "La Granja Del Camaron" */
|
|
5639
|
+
dba_name?: any;
|
|
5640
|
+
/** @example "" */
|
|
5641
|
+
incorporated?: any;
|
|
5642
|
+
/** @example "812748955" */
|
|
5643
|
+
number?: any;
|
|
5644
|
+
/** @example "EIN" */
|
|
5645
|
+
number_type?: any;
|
|
5646
|
+
/** @example "" */
|
|
5647
|
+
phone?: any;
|
|
5648
|
+
/** @example "CA" */
|
|
5649
|
+
state?: any;
|
|
5650
|
+
/** @example "1119 E 8th St Ste C" */
|
|
5651
|
+
street?: any;
|
|
5652
|
+
/** @example "304902" */
|
|
5653
|
+
tracking_number?: any;
|
|
5654
|
+
/** @example "90021" */
|
|
5655
|
+
zip?: any;
|
|
5810
5656
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5811
5657
|
/**
|
|
5812
|
-
* @tags
|
|
5813
|
-
* @name
|
|
5814
|
-
* @summary
|
|
5815
|
-
* @request GET:/
|
|
5658
|
+
* @tags Blacklist Admin Businesses
|
|
5659
|
+
* @name GetBusinessById
|
|
5660
|
+
* @summary Get Business by ID
|
|
5661
|
+
* @request GET:/v1/admin/businesses/{id}
|
|
5816
5662
|
* @secure
|
|
5817
5663
|
*/
|
|
5818
|
-
|
|
5819
|
-
/** @example "USERNAME" */
|
|
5820
|
-
username?: any;
|
|
5821
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5664
|
+
getBusinessById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5822
5665
|
/**
|
|
5823
|
-
* @tags
|
|
5824
|
-
* @name
|
|
5825
|
-
* @summary
|
|
5826
|
-
* @request
|
|
5666
|
+
* @tags Blacklist Admin Businesses
|
|
5667
|
+
* @name UpdateBusiness
|
|
5668
|
+
* @summary Update Business
|
|
5669
|
+
* @request PUT:/v1/admin/businesses/{id}
|
|
5827
5670
|
* @secure
|
|
5828
5671
|
*/
|
|
5829
|
-
|
|
5830
|
-
/** @example "
|
|
5831
|
-
|
|
5672
|
+
updateBusiness(id: string, data: {
|
|
5673
|
+
/** @example "Gracia Marina" */
|
|
5674
|
+
business_name?: any;
|
|
5675
|
+
/** @example "Los Angeles" */
|
|
5676
|
+
city?: any;
|
|
5677
|
+
/** @example "US" */
|
|
5678
|
+
country?: any;
|
|
5679
|
+
/** @example "La Granja Del Camaron" */
|
|
5680
|
+
dba_name?: any;
|
|
5681
|
+
/** @example "" */
|
|
5682
|
+
incorporated?: any;
|
|
5683
|
+
/** @example "812748955" */
|
|
5684
|
+
number?: any;
|
|
5685
|
+
/** @example "EIN" */
|
|
5686
|
+
number_type?: any;
|
|
5687
|
+
/** @example "" */
|
|
5688
|
+
phone?: any;
|
|
5689
|
+
/** @example "CA" */
|
|
5690
|
+
state?: any;
|
|
5691
|
+
/** @example "1119 E 8th St Ste C" */
|
|
5692
|
+
street?: any;
|
|
5693
|
+
/** @example "304902" */
|
|
5694
|
+
tracking_number?: any;
|
|
5695
|
+
/** @example "90021" */
|
|
5696
|
+
zip?: any;
|
|
5832
5697
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5833
5698
|
/**
|
|
5834
|
-
* @tags
|
|
5835
|
-
* @name
|
|
5836
|
-
* @summary
|
|
5837
|
-
* @request
|
|
5699
|
+
* @tags Blacklist Admin Businesses
|
|
5700
|
+
* @name DeleteBusiness
|
|
5701
|
+
* @summary Delete Business
|
|
5702
|
+
* @request DELETE:/v1/admin/businesses/{id}
|
|
5838
5703
|
* @secure
|
|
5839
5704
|
*/
|
|
5840
|
-
|
|
5705
|
+
deleteBusiness(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5706
|
+
}
|
|
5707
|
+
export class Blacklist<HandleError extends boolean = boolean> {
|
|
5708
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5709
|
+
adminBusinesses: BlacklistAdminBusinesses<HandleError>;
|
|
5710
|
+
adminIndividuals: BlacklistAdminIndividuals<HandleError>;
|
|
5711
|
+
search: BlacklistSearch<HandleError>;
|
|
5712
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5841
5713
|
/**
|
|
5842
|
-
* @tags
|
|
5843
|
-
* @name
|
|
5844
|
-
* @summary
|
|
5845
|
-
* @request POST:/
|
|
5714
|
+
* @tags Blacklist
|
|
5715
|
+
* @name UploadBlacklistCsv
|
|
5716
|
+
* @summary Upload Blacklist CSV
|
|
5717
|
+
* @request POST:/v1/csv/upload
|
|
5846
5718
|
* @secure
|
|
5847
5719
|
*/
|
|
5848
|
-
|
|
5720
|
+
uploadBlacklistCsv(data: {
|
|
5721
|
+
/**
|
|
5722
|
+
* (Required) file with info to upload
|
|
5723
|
+
* @format binary
|
|
5724
|
+
*/
|
|
5725
|
+
file_field?: File;
|
|
5726
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5849
5727
|
/**
|
|
5850
|
-
* @tags
|
|
5851
|
-
* @name
|
|
5852
|
-
* @summary
|
|
5853
|
-
* @request
|
|
5728
|
+
* @tags Blacklist
|
|
5729
|
+
* @name GetHealth
|
|
5730
|
+
* @summary Get Health
|
|
5731
|
+
* @request GET:/v1/healthz
|
|
5854
5732
|
* @secure
|
|
5855
5733
|
*/
|
|
5856
|
-
|
|
5857
|
-
/** @example "desired account number" */
|
|
5858
|
-
accountNumber?: any;
|
|
5859
|
-
/** @example 100 */
|
|
5860
|
-
limit?: any;
|
|
5861
|
-
/** @example 0 */
|
|
5862
|
-
lockedBit?: any;
|
|
5863
|
-
/** @example "desired username" */
|
|
5864
|
-
login?: any;
|
|
5865
|
-
/** @example false */
|
|
5866
|
-
noBrokers?: any;
|
|
5867
|
-
/** @example "" */
|
|
5868
|
-
omnibus?: any;
|
|
5869
|
-
/** @example false */
|
|
5870
|
-
onlyActiveAccount?: any;
|
|
5871
|
-
/** @example false */
|
|
5872
|
-
onlyActiveUser?: any;
|
|
5873
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5734
|
+
getHealth(config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5874
5735
|
}
|
|
5875
5736
|
export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
|
|
5876
5737
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -6047,6 +5908,145 @@ export class WatchmenFfiFirmBranch<HandleError extends boolean = boolean> {
|
|
|
6047
5908
|
id?: any;
|
|
6048
5909
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
6049
5910
|
}
|
|
5911
|
+
export class WatchmenFfiUserAccountManagement<HandleError extends boolean = boolean> {
|
|
5912
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5913
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5914
|
+
/**
|
|
5915
|
+
* @tags Watchmen Ffi User Account Management
|
|
5916
|
+
* @name CreateUser
|
|
5917
|
+
* @summary Create User
|
|
5918
|
+
* @request POST:/rest/v1/uam/user/create
|
|
5919
|
+
* @secure
|
|
5920
|
+
*/
|
|
5921
|
+
createUser(data: {
|
|
5922
|
+
/** @example "{optional} enable|disable - whether or not enable user for TipRanks" */
|
|
5923
|
+
Tipranks?: any;
|
|
5924
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5925
|
+
algos?: any;
|
|
5926
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5927
|
+
allSession?: any;
|
|
5928
|
+
/** @example "{optional} Full Name" */
|
|
5929
|
+
associatedName?: any;
|
|
5930
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5931
|
+
buyWrite?: any;
|
|
5932
|
+
/** @example "{optional} e-mail address" */
|
|
5933
|
+
email?: any;
|
|
5934
|
+
/** @example "{optional} true|false - defaults to true" */
|
|
5935
|
+
isTradingEnabled?: any;
|
|
5936
|
+
/** @example "{optional} Limit On Close - true|false - defaults to false" */
|
|
5937
|
+
loc?: any;
|
|
5938
|
+
/** @example "{optional} true|false - whether user is locked" */
|
|
5939
|
+
locked?: any;
|
|
5940
|
+
/** @example "{optional} Limit On Open - true|false - defaults to false" */
|
|
5941
|
+
loo?: any;
|
|
5942
|
+
/** @example "{optional} Market On Open - true|false - defaults to false" */
|
|
5943
|
+
moc?: any;
|
|
5944
|
+
/** @example "{optional} Market On Close - true|false - defaults to false" */
|
|
5945
|
+
moo?: any;
|
|
5946
|
+
/** @example "{optional} One Cancels Other - true|false - defaults to false" */
|
|
5947
|
+
oco?: any;
|
|
5948
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5949
|
+
optionRoll?: any;
|
|
5950
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5951
|
+
options?: any;
|
|
5952
|
+
/** @example "{optional}" */
|
|
5953
|
+
password?: any;
|
|
5954
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5955
|
+
prePostTrading?: any;
|
|
5956
|
+
/** @example "{optional} 1 - delayed, 0 - realtime, 4 - CBOE1, 3 - BATS" */
|
|
5957
|
+
quoteType?: any;
|
|
5958
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5959
|
+
spreads?: any;
|
|
5960
|
+
/** @example "A - active, S - suspended == initial user status" */
|
|
5961
|
+
status?: any;
|
|
5962
|
+
/** @example "{optional} true|false - defaults to false" */
|
|
5963
|
+
trailingStops?: any;
|
|
5964
|
+
/** @example "UNIQUE_USERNAME" */
|
|
5965
|
+
username?: any;
|
|
5966
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5967
|
+
/**
|
|
5968
|
+
* @tags Watchmen Ffi User Account Management
|
|
5969
|
+
* @name CreateAccount
|
|
5970
|
+
* @summary Create Account
|
|
5971
|
+
* @request POST:/rest/v1/uam/account/create
|
|
5972
|
+
* @secure
|
|
5973
|
+
*/
|
|
5974
|
+
createAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5975
|
+
/**
|
|
5976
|
+
* @tags Watchmen Ffi User Account Management
|
|
5977
|
+
* @name AccountInformation
|
|
5978
|
+
* @summary Account Information
|
|
5979
|
+
* @request GET:/rest/v1/uam/account/data
|
|
5980
|
+
* @secure
|
|
5981
|
+
*/
|
|
5982
|
+
accountInformation(query?: {
|
|
5983
|
+
/** @example "AC123456" */
|
|
5984
|
+
accountNumber?: any;
|
|
5985
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5986
|
+
/**
|
|
5987
|
+
* @tags Watchmen Ffi User Account Management
|
|
5988
|
+
* @name UserInformation
|
|
5989
|
+
* @summary User Information
|
|
5990
|
+
* @request GET:/rest/v1/uam/user/data
|
|
5991
|
+
* @secure
|
|
5992
|
+
*/
|
|
5993
|
+
userInformation(query?: {
|
|
5994
|
+
/** @example "USERNAME" */
|
|
5995
|
+
username?: any;
|
|
5996
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
5997
|
+
/**
|
|
5998
|
+
* @tags Watchmen Ffi User Account Management
|
|
5999
|
+
* @name ListLinkedAccounts
|
|
6000
|
+
* @summary List Linked Accounts
|
|
6001
|
+
* @request GET:/rest/v1/linkedaccounts/listAccounts
|
|
6002
|
+
* @secure
|
|
6003
|
+
*/
|
|
6004
|
+
listLinkedAccounts(query?: {
|
|
6005
|
+
/** @example "TEST.USER" */
|
|
6006
|
+
username?: any;
|
|
6007
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
6008
|
+
/**
|
|
6009
|
+
* @tags Watchmen Ffi User Account Management
|
|
6010
|
+
* @name LinkUnlinkAccount
|
|
6011
|
+
* @summary Link/Unlink Account
|
|
6012
|
+
* @request POST:/rest/v1/linkedaccounts/linkUnlinkAccount
|
|
6013
|
+
* @secure
|
|
6014
|
+
*/
|
|
6015
|
+
linkUnlinkAccount(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
6016
|
+
/**
|
|
6017
|
+
* @tags Watchmen Ffi User Account Management
|
|
6018
|
+
* @name Visibility
|
|
6019
|
+
* @summary Visibility
|
|
6020
|
+
* @request POST:/rest/v1/linkedaccounts/visibility
|
|
6021
|
+
* @secure
|
|
6022
|
+
*/
|
|
6023
|
+
visibility(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
6024
|
+
/**
|
|
6025
|
+
* @tags Watchmen Ffi User Account Management
|
|
6026
|
+
* @name UserAccountSearch
|
|
6027
|
+
* @summary User/Account Search
|
|
6028
|
+
* @request POST:/rest/v1/uam/user-account-search
|
|
6029
|
+
* @secure
|
|
6030
|
+
*/
|
|
6031
|
+
userAccountSearch(data: {
|
|
6032
|
+
/** @example "desired account number" */
|
|
6033
|
+
accountNumber?: any;
|
|
6034
|
+
/** @example 100 */
|
|
6035
|
+
limit?: any;
|
|
6036
|
+
/** @example 0 */
|
|
6037
|
+
lockedBit?: any;
|
|
6038
|
+
/** @example "desired username" */
|
|
6039
|
+
login?: any;
|
|
6040
|
+
/** @example false */
|
|
6041
|
+
noBrokers?: any;
|
|
6042
|
+
/** @example "" */
|
|
6043
|
+
omnibus?: any;
|
|
6044
|
+
/** @example false */
|
|
6045
|
+
onlyActiveAccount?: any;
|
|
6046
|
+
/** @example false */
|
|
6047
|
+
onlyActiveUser?: any;
|
|
6048
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError>>;
|
|
6049
|
+
}
|
|
6050
6050
|
export class Advisory<HandleError extends boolean = boolean> {
|
|
6051
6051
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6052
6052
|
charges: AdvisoryCharges<HandleError>;
|