@orbis-systems/orbis-api-clients 0.7.14 → 0.7.15
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 +295 -261
- 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 +603 -451
- 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 +394 -124
- 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 +123 -54
- 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 +699 -855
- 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 +449 -753
- 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 +168 -150
- 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/insight/index.d.ts
CHANGED
|
@@ -267,6 +267,12 @@ export interface InsightArticleFeaturedImageInfo {
|
|
|
267
267
|
url: string;
|
|
268
268
|
width: number;
|
|
269
269
|
}
|
|
270
|
+
export enum InsightArticleSearchType {
|
|
271
|
+
ArticleSearchTypeAll = "all",
|
|
272
|
+
ArticleSearchTypeTag = "tag",
|
|
273
|
+
ArticleSearchTypePrimary = "primary",
|
|
274
|
+
ArticleSearchTypeSymbol = "symbol"
|
|
275
|
+
}
|
|
270
276
|
export interface InsightArticlesRequest {
|
|
271
277
|
/** @example 10 */
|
|
272
278
|
count?: number;
|
|
@@ -283,7 +289,11 @@ export interface InsightArticlesRequest {
|
|
|
283
289
|
/** @example "group1" */
|
|
284
290
|
tag_group?: string;
|
|
285
291
|
/** @example "education" */
|
|
286
|
-
type?:
|
|
292
|
+
type?: InsightArticlesRequestType;
|
|
293
|
+
}
|
|
294
|
+
export enum InsightArticlesRequestType {
|
|
295
|
+
ArticlesRequestTypeEducation = "education",
|
|
296
|
+
ArticlesRequestTypeNonEducation = "non-education"
|
|
287
297
|
}
|
|
288
298
|
export interface InsightAssetAllocationBreakdown {
|
|
289
299
|
breakdown: string;
|
|
@@ -359,6 +369,8 @@ export interface InsightCalculateEstimatedReturnsResponse {
|
|
|
359
369
|
}
|
|
360
370
|
export interface InsightCalculateMatrixParamsRequest {
|
|
361
371
|
expiry_date?: InsightDate;
|
|
372
|
+
/** @example "2023-12-31" */
|
|
373
|
+
formatted_expiry_date?: string;
|
|
362
374
|
/** @example 10 */
|
|
363
375
|
max_intervals?: number;
|
|
364
376
|
/** @example "c" */
|
|
@@ -378,6 +390,8 @@ export interface InsightCalculateMatrixResponse {
|
|
|
378
390
|
}
|
|
379
391
|
export interface InsightCalculateParamsRequest {
|
|
380
392
|
expiry_date?: InsightDate;
|
|
393
|
+
/** @example "2023-12-31" */
|
|
394
|
+
formatted_expiry_date?: string;
|
|
381
395
|
/** @example "c" */
|
|
382
396
|
option_type?: InsightCalculateParamsRequestOptionTypeEnum;
|
|
383
397
|
/** @example 150.25 */
|
|
@@ -510,9 +524,15 @@ export interface InsightCompanyProfile {
|
|
|
510
524
|
}
|
|
511
525
|
export interface InsightConfidenceSignal {
|
|
512
526
|
score: string;
|
|
527
|
+
/** @format float32 */
|
|
513
528
|
sectorScore: number;
|
|
529
|
+
/** @format float32 */
|
|
514
530
|
stockScore: number;
|
|
515
531
|
}
|
|
532
|
+
export enum InsightConsensusInterval {
|
|
533
|
+
ConsensusIntervalWeek = "week",
|
|
534
|
+
ConsensusIntervalMonth = "month"
|
|
535
|
+
}
|
|
516
536
|
export interface InsightContinent {
|
|
517
537
|
id: string;
|
|
518
538
|
name: string;
|
|
@@ -522,6 +542,16 @@ export interface InsightContinentBreakdown {
|
|
|
522
542
|
code: string;
|
|
523
543
|
percentage: number;
|
|
524
544
|
}
|
|
545
|
+
export enum InsightConversion {
|
|
546
|
+
ConversionOriginal = "original",
|
|
547
|
+
ConversionDefault = "default",
|
|
548
|
+
ConversionNormal = "normal",
|
|
549
|
+
ConversionThumbnail = "thumbnail",
|
|
550
|
+
ConversionSquare = "square",
|
|
551
|
+
ConversionSquareStrict = "square_strict",
|
|
552
|
+
ConversionSquareStrictOrNormal = "square_strict_or_normal",
|
|
553
|
+
ConversionBestMatch = "best_match"
|
|
554
|
+
}
|
|
525
555
|
export interface InsightCountryBreakdown {
|
|
526
556
|
breakdown: string;
|
|
527
557
|
percentage: number;
|
|
@@ -607,6 +637,43 @@ export interface InsightCreateOrUpdateFundScreenerPresetRequest {
|
|
|
607
637
|
preset_description?: string;
|
|
608
638
|
preset_name: string;
|
|
609
639
|
}
|
|
640
|
+
export interface InsightCreateOrUpdateMarketDateRequest {
|
|
641
|
+
/** @example "16:00" */
|
|
642
|
+
close_time: string;
|
|
643
|
+
/** @example false */
|
|
644
|
+
holiday?: boolean;
|
|
645
|
+
/** @example "U" */
|
|
646
|
+
market_code: string;
|
|
647
|
+
/** @example "2023-01-01" */
|
|
648
|
+
open_date: string;
|
|
649
|
+
/** @example "09:30" */
|
|
650
|
+
open_time: string;
|
|
651
|
+
/** @example "America/New_York" */
|
|
652
|
+
timezone: string;
|
|
653
|
+
}
|
|
654
|
+
export interface InsightCreateOrUpdateMarketRequest {
|
|
655
|
+
/** @example "US" */
|
|
656
|
+
country_code: string;
|
|
657
|
+
/** @example "USD" */
|
|
658
|
+
currency_code: string;
|
|
659
|
+
/** @example "U" */
|
|
660
|
+
market_code: string;
|
|
661
|
+
/** @example "United States" */
|
|
662
|
+
market_name: string;
|
|
663
|
+
/** @example true */
|
|
664
|
+
primary_market?: boolean;
|
|
665
|
+
}
|
|
666
|
+
export interface InsightCreateOrUpdateMarketScheduleRequest {
|
|
667
|
+
friday?: InsightMarketSchedule;
|
|
668
|
+
/** @example "U" */
|
|
669
|
+
market_code: string;
|
|
670
|
+
monday?: InsightMarketSchedule;
|
|
671
|
+
saturday?: InsightMarketSchedule;
|
|
672
|
+
sunday?: InsightMarketSchedule;
|
|
673
|
+
thursday?: InsightMarketSchedule;
|
|
674
|
+
tuesday?: InsightMarketSchedule;
|
|
675
|
+
wednesday?: InsightMarketSchedule;
|
|
676
|
+
}
|
|
610
677
|
export interface InsightCreateOrUpdateScreenerPresetRequest {
|
|
611
678
|
id?: string;
|
|
612
679
|
preset?: InsightStockScreenerRequest;
|
|
@@ -784,17 +851,6 @@ export interface InsightExtendedFundData {
|
|
|
784
851
|
symbol: string;
|
|
785
852
|
url: string;
|
|
786
853
|
}
|
|
787
|
-
export interface InsightExtendedMarketDate {
|
|
788
|
-
close_time: string;
|
|
789
|
-
country_code: string;
|
|
790
|
-
currency_code: string;
|
|
791
|
-
market_code: string;
|
|
792
|
-
market_name: string;
|
|
793
|
-
open_date: string;
|
|
794
|
-
open_time: string;
|
|
795
|
-
primary_market: boolean;
|
|
796
|
-
timezone: string;
|
|
797
|
-
}
|
|
798
854
|
export interface InsightExtremum {
|
|
799
855
|
max_value: number;
|
|
800
856
|
max_value_date: string;
|
|
@@ -816,6 +872,10 @@ export interface InsightFilterCustomIndexesRequest {
|
|
|
816
872
|
paging: InsightPaging;
|
|
817
873
|
symbols?: string[];
|
|
818
874
|
}
|
|
875
|
+
export enum InsightFilterType {
|
|
876
|
+
FilterAnalysts = "analysts",
|
|
877
|
+
FilterBloggers = "bloggers"
|
|
878
|
+
}
|
|
819
879
|
export interface InsightFilteredCustomIndexResponse {
|
|
820
880
|
created_at?: string;
|
|
821
881
|
description?: string;
|
|
@@ -1179,6 +1239,8 @@ export interface InsightGetFundScreenerFiltersResponse {
|
|
|
1179
1239
|
sponsors?: InsightFundFilterSponsor[];
|
|
1180
1240
|
}
|
|
1181
1241
|
export interface InsightGetFundsForHoldingRequest {
|
|
1242
|
+
/** @example "ANY" */
|
|
1243
|
+
inverse: InsightGetFundsForHoldingRequestInverseEnum;
|
|
1182
1244
|
/** @example "LEVERAGE_I" */
|
|
1183
1245
|
leverage: InsightGetFundsForHoldingRequestLeverageEnum;
|
|
1184
1246
|
order?: InsightOrdering;
|
|
@@ -1219,6 +1281,8 @@ export interface InsightGetIndustriesPerformanceResponse {
|
|
|
1219
1281
|
worst_performing_quotes: InsightStockScreenerQuote[];
|
|
1220
1282
|
}
|
|
1221
1283
|
export interface InsightGetMarketDatesRequest {
|
|
1284
|
+
/** @example ["working_day","holiday"] */
|
|
1285
|
+
date_types?: string[];
|
|
1222
1286
|
/** @example "2023-12-31" */
|
|
1223
1287
|
end_date: string;
|
|
1224
1288
|
/** @example ["U","AU"] */
|
|
@@ -1229,16 +1293,36 @@ export interface InsightGetMarketDatesRequest {
|
|
|
1229
1293
|
}
|
|
1230
1294
|
export interface InsightGetMarketDatesResponse {
|
|
1231
1295
|
count: number;
|
|
1232
|
-
data:
|
|
1296
|
+
data: InsightMarketDate[];
|
|
1297
|
+
schedules: InsightGetMarketScheduleResponse[];
|
|
1233
1298
|
}
|
|
1234
1299
|
export interface InsightGetMarketHoursResponse {
|
|
1235
1300
|
close_time: string;
|
|
1236
|
-
next_market_day:
|
|
1301
|
+
next_market_day: InsightMarketDate;
|
|
1237
1302
|
open_right_now: boolean;
|
|
1238
1303
|
open_time: string;
|
|
1239
1304
|
open_today: boolean;
|
|
1305
|
+
schedule: InsightGetMarketScheduleResponse;
|
|
1240
1306
|
time_zone: string;
|
|
1241
1307
|
}
|
|
1308
|
+
export interface InsightGetMarketScheduleResponse {
|
|
1309
|
+
/** @example "2023-01-01T00:00:00Z" */
|
|
1310
|
+
created_at: string;
|
|
1311
|
+
friday: InsightMarketSchedule;
|
|
1312
|
+
market: InsightMarket;
|
|
1313
|
+
monday: InsightMarketSchedule;
|
|
1314
|
+
saturday: InsightMarketSchedule;
|
|
1315
|
+
sunday: InsightMarketSchedule;
|
|
1316
|
+
thursday: InsightMarketSchedule;
|
|
1317
|
+
tuesday: InsightMarketSchedule;
|
|
1318
|
+
/** @example "2023-01-01T00:00:00Z" */
|
|
1319
|
+
updated_at: string;
|
|
1320
|
+
wednesday: InsightMarketSchedule;
|
|
1321
|
+
}
|
|
1322
|
+
export interface InsightGetMarketsResponse {
|
|
1323
|
+
count: number;
|
|
1324
|
+
data: InsightMarket[];
|
|
1325
|
+
}
|
|
1242
1326
|
export interface InsightGetOwnershipsByIDRequest {
|
|
1243
1327
|
/** @example "123e4567-e89b-12d3-a456-426614174000" */
|
|
1244
1328
|
owner_id: string;
|
|
@@ -2815,7 +2899,7 @@ export interface InsightIPOResponse {
|
|
|
2815
2899
|
sector: InsightClassificationResponse;
|
|
2816
2900
|
shares_outstanding: number;
|
|
2817
2901
|
shares_over_alloted: number;
|
|
2818
|
-
status:
|
|
2902
|
+
status: InsightIpoStatus;
|
|
2819
2903
|
sub_industry: InsightClassificationResponse;
|
|
2820
2904
|
symbol: string;
|
|
2821
2905
|
total_expenses: number;
|
|
@@ -2988,13 +3072,19 @@ export interface InsightInvestorsAlsoBought {
|
|
|
2988
3072
|
sentiment: string;
|
|
2989
3073
|
ticker: string;
|
|
2990
3074
|
}
|
|
3075
|
+
export enum InsightIpoStatus {
|
|
3076
|
+
PricedIpoStatus = "Priced",
|
|
3077
|
+
FiledIpoStatus = "Filed",
|
|
3078
|
+
WithdrawnIpoStatus = "Withdrawn",
|
|
3079
|
+
PostponedIpoStatus = "Postponed"
|
|
3080
|
+
}
|
|
2991
3081
|
export interface InsightLatestAnalystRatingsOnStockRequest {
|
|
2992
3082
|
/** Get analyst ratings from the past X months (OPTIONAL) */
|
|
2993
3083
|
months?: number;
|
|
2994
|
-
/** The number of analysts to return (OPTIONAL) */
|
|
3084
|
+
/** The number of analysts to return (OPTIONAL) Default is 3 */
|
|
2995
3085
|
num?: number;
|
|
2996
3086
|
/** Sort order of the analyst ratings Enums(date, rank) (OPTIONAL) */
|
|
2997
|
-
sort?:
|
|
3087
|
+
sort?: InsightLatestAnalystRatingsOnStockSort;
|
|
2998
3088
|
/** Comma-separated tickers */
|
|
2999
3089
|
tickers?: string[];
|
|
3000
3090
|
}
|
|
@@ -3031,6 +3121,10 @@ export interface InsightLatestAnalystRatingsOnStockResponse {
|
|
|
3031
3121
|
total_recommendations: number;
|
|
3032
3122
|
url: string;
|
|
3033
3123
|
}
|
|
3124
|
+
export enum InsightLatestAnalystRatingsOnStockSort {
|
|
3125
|
+
LatestAnalystRatingsOnStockSortDate = "date",
|
|
3126
|
+
LatestAnalystRatingsOnStockSortRank = "rank"
|
|
3127
|
+
}
|
|
3034
3128
|
export interface InsightLessAndMore {
|
|
3035
3129
|
less_than?: number;
|
|
3036
3130
|
more_than?: number;
|
|
@@ -3086,10 +3180,46 @@ export interface InsightLiveFeedResponse {
|
|
|
3086
3180
|
unique_operation_id: string;
|
|
3087
3181
|
url: string;
|
|
3088
3182
|
}
|
|
3183
|
+
export interface InsightMarket {
|
|
3184
|
+
/** @example "USA" */
|
|
3185
|
+
country_code: string;
|
|
3186
|
+
/** @example "2023-01-01T00:00:00Z" */
|
|
3187
|
+
created_at: string;
|
|
3188
|
+
/** @example "USD" */
|
|
3189
|
+
currency_code: string;
|
|
3190
|
+
/** @example "U" */
|
|
3191
|
+
market_code: string;
|
|
3192
|
+
/** @example "United States" */
|
|
3193
|
+
market_name: string;
|
|
3194
|
+
/** @example true */
|
|
3195
|
+
primary_market: boolean;
|
|
3196
|
+
/** @example "2023-01-01T00:00:00Z" */
|
|
3197
|
+
updated_at: string;
|
|
3198
|
+
}
|
|
3089
3199
|
export interface InsightMarketCapBreakdown {
|
|
3090
3200
|
breakdown: string;
|
|
3091
3201
|
percentage: number;
|
|
3092
3202
|
}
|
|
3203
|
+
export interface InsightMarketDate {
|
|
3204
|
+
close_time: string;
|
|
3205
|
+
country_code: string;
|
|
3206
|
+
currency_code: string;
|
|
3207
|
+
holiday: boolean;
|
|
3208
|
+
market_code: string;
|
|
3209
|
+
market_name: string;
|
|
3210
|
+
open_date: string;
|
|
3211
|
+
open_time: string;
|
|
3212
|
+
primary_market: boolean;
|
|
3213
|
+
timezone: string;
|
|
3214
|
+
}
|
|
3215
|
+
export interface InsightMarketSchedule {
|
|
3216
|
+
/** @example "16:00" */
|
|
3217
|
+
close_time: string;
|
|
3218
|
+
/** @example "09:30" */
|
|
3219
|
+
open_time: string;
|
|
3220
|
+
/** @example "America/New_York" */
|
|
3221
|
+
timezone: string;
|
|
3222
|
+
}
|
|
3093
3223
|
export interface InsightMatrixData {
|
|
3094
3224
|
date: InsightDate;
|
|
3095
3225
|
option_data: InsightOptionData[];
|
|
@@ -3124,9 +3254,19 @@ export interface InsightMostPopularTagsRequest {
|
|
|
3124
3254
|
/** @example "eng" */
|
|
3125
3255
|
language: string;
|
|
3126
3256
|
/** @example "week" */
|
|
3127
|
-
time:
|
|
3257
|
+
time: InsightMostPopularTagsTimeType;
|
|
3128
3258
|
/** @example "symbol" */
|
|
3129
|
-
type:
|
|
3259
|
+
type: InsightMostPopularTagsTypesType;
|
|
3260
|
+
}
|
|
3261
|
+
export enum InsightMostPopularTagsTimeType {
|
|
3262
|
+
MostPopularTagsTimeTypeWeek = "week",
|
|
3263
|
+
MostPopularTagsTimeTypeMonth = "month",
|
|
3264
|
+
MostPopularTagsTimeTypeYear = "year"
|
|
3265
|
+
}
|
|
3266
|
+
export enum InsightMostPopularTagsTypesType {
|
|
3267
|
+
MostPopularTagsTypesTypeSymbol = "symbol",
|
|
3268
|
+
MostPopularTagsTypesTypePrimary = "primary",
|
|
3269
|
+
MostPopularTagsTypesTypeTags = "tags"
|
|
3130
3270
|
}
|
|
3131
3271
|
export interface InsightMover {
|
|
3132
3272
|
company_name: string;
|
|
@@ -3283,12 +3423,13 @@ export interface InsightNewsfeedRequest {
|
|
|
3283
3423
|
/** @example "technology" */
|
|
3284
3424
|
tag?: string;
|
|
3285
3425
|
/** @example "education" */
|
|
3286
|
-
type?:
|
|
3426
|
+
type?: InsightArticlesRequestType;
|
|
3287
3427
|
/** @example "group1" */
|
|
3288
3428
|
with_tag_group?: string;
|
|
3289
3429
|
}
|
|
3290
3430
|
export interface InsightOptionData {
|
|
3291
3431
|
expiry_date: InsightDate;
|
|
3432
|
+
formatted_expiry_date: string;
|
|
3292
3433
|
greeks: InsightOptionGreeks;
|
|
3293
3434
|
implied_volatility: number;
|
|
3294
3435
|
strike_price: number;
|
|
@@ -3308,6 +3449,10 @@ export interface InsightOptionValues {
|
|
|
3308
3449
|
option_value: number;
|
|
3309
3450
|
time_value: number;
|
|
3310
3451
|
}
|
|
3452
|
+
export enum InsightOrderDirection {
|
|
3453
|
+
OrderASC = "asc",
|
|
3454
|
+
OrderDESC = "desc"
|
|
3455
|
+
}
|
|
3311
3456
|
export interface InsightOrdering {
|
|
3312
3457
|
/**
|
|
3313
3458
|
* @default "asc"
|
|
@@ -3383,6 +3528,12 @@ export interface InsightPeriodFilter {
|
|
|
3383
3528
|
*/
|
|
3384
3529
|
value: number;
|
|
3385
3530
|
}
|
|
3531
|
+
export enum InsightPeriodType {
|
|
3532
|
+
PeriodDay = "day",
|
|
3533
|
+
PeriodWeek = "week",
|
|
3534
|
+
PeriodMonth = "month",
|
|
3535
|
+
PeriodYear = "year"
|
|
3536
|
+
}
|
|
3386
3537
|
export interface InsightPortfoliosRequest {
|
|
3387
3538
|
/** (REQUIRED) */
|
|
3388
3539
|
expert_uid?: string;
|
|
@@ -3414,6 +3565,7 @@ export interface InsightPreIPOCompany {
|
|
|
3414
3565
|
facebook: string;
|
|
3415
3566
|
founder: string;
|
|
3416
3567
|
id: string;
|
|
3568
|
+
is_active: boolean;
|
|
3417
3569
|
last_funding_date: string;
|
|
3418
3570
|
last_funding_series: string;
|
|
3419
3571
|
last_funding_total: number;
|
|
@@ -3421,6 +3573,7 @@ export interface InsightPreIPOCompany {
|
|
|
3421
3573
|
last_share_price: number;
|
|
3422
3574
|
last_valuation: number;
|
|
3423
3575
|
linkedin: string;
|
|
3576
|
+
listing_type: string;
|
|
3424
3577
|
logo_url: string;
|
|
3425
3578
|
name: string;
|
|
3426
3579
|
notable_investors_logos: string[];
|
|
@@ -3673,6 +3826,12 @@ export interface InsightRegion {
|
|
|
3673
3826
|
export interface InsightRemoveCustomIndexRequest {
|
|
3674
3827
|
id?: string;
|
|
3675
3828
|
}
|
|
3829
|
+
export interface InsightRemoveMarketDateRequest {
|
|
3830
|
+
/** @example "U" */
|
|
3831
|
+
market_code: string;
|
|
3832
|
+
/** @example "2023-01-01" */
|
|
3833
|
+
open_date: string;
|
|
3834
|
+
}
|
|
3676
3835
|
export interface InsightRemoveRewrittenFieldValueRequest {
|
|
3677
3836
|
/** @example "Removed" */
|
|
3678
3837
|
comment?: string;
|
|
@@ -3712,7 +3871,7 @@ export interface InsightSearchArticleRequest {
|
|
|
3712
3871
|
/** @example "search term" */
|
|
3713
3872
|
s: string;
|
|
3714
3873
|
/** @example "all" */
|
|
3715
|
-
type:
|
|
3874
|
+
type: InsightArticleSearchType;
|
|
3716
3875
|
}
|
|
3717
3876
|
export interface InsightSeasonalityEntry {
|
|
3718
3877
|
april: InsightTickerSeasonality;
|
|
@@ -3895,7 +4054,7 @@ export interface InsightStockScreenerV1Request {
|
|
|
3895
4054
|
}
|
|
3896
4055
|
export interface InsightStocksConsensusOverTimeRequest {
|
|
3897
4056
|
/** "The intervals over which the consensus is given" */
|
|
3898
|
-
interval?:
|
|
4057
|
+
interval?: InsightConsensusInterval;
|
|
3899
4058
|
/** "The ticker of the stock" (REQUIRE) */
|
|
3900
4059
|
ticker?: string;
|
|
3901
4060
|
}
|
|
@@ -4114,7 +4273,7 @@ export interface InsightTransaction {
|
|
|
4114
4273
|
}
|
|
4115
4274
|
export interface InsightTrendingStocksRequest {
|
|
4116
4275
|
/** "Include ratings of analysts and/or bloggers" Enums(analysts, bloggers) */
|
|
4117
|
-
filter?:
|
|
4276
|
+
filter?: InsightFilterType;
|
|
4118
4277
|
/** "Return the most trending X stocks" */
|
|
4119
4278
|
num?: number;
|
|
4120
4279
|
/** "Trending over the last X days" Enums(3, 7, 30, 90) */
|
|
@@ -4122,7 +4281,7 @@ export interface InsightTrendingStocksRequest {
|
|
|
4122
4281
|
/** Type of quote to load Enums(nbbo, delayed, cboe, bats, realtime, realtime_snapshot) (REQUIRED) */
|
|
4123
4282
|
quote_access_type?: string;
|
|
4124
4283
|
/** "Trend Type" Enums(most-rated, best-rated, worst-rated) */
|
|
4125
|
-
trending_type?:
|
|
4284
|
+
trending_type?: InsightTrendingType;
|
|
4126
4285
|
}
|
|
4127
4286
|
export interface InsightTrendingStocksResponse {
|
|
4128
4287
|
average_price_target: number;
|
|
@@ -4138,6 +4297,11 @@ export interface InsightTrendingStocksResponse {
|
|
|
4138
4297
|
sentiment: number;
|
|
4139
4298
|
ticker: string;
|
|
4140
4299
|
}
|
|
4300
|
+
export enum InsightTrendingType {
|
|
4301
|
+
TrendingTypeMostRated = "most-rated",
|
|
4302
|
+
TrendingTypeBestRated = "best-rated",
|
|
4303
|
+
TrendingTypeWorstRated = "worst-rated"
|
|
4304
|
+
}
|
|
4141
4305
|
export interface InsightUnderwriteResponse {
|
|
4142
4306
|
company_name: string;
|
|
4143
4307
|
id: number;
|
|
@@ -4345,6 +4509,12 @@ export enum InsightFundSectorScreenerRequestLeverageEnum {
|
|
|
4345
4509
|
LEVERAGE_III = "LEVERAGE_III",
|
|
4346
4510
|
LEVERAGE_II_AND_III = "LEVERAGE_II_AND_III"
|
|
4347
4511
|
}
|
|
4512
|
+
/** @example "ANY" */
|
|
4513
|
+
export enum InsightGetFundsForHoldingRequestInverseEnum {
|
|
4514
|
+
ANY = "ANY",
|
|
4515
|
+
SHORT = "SHORT",
|
|
4516
|
+
LONG = "LONG"
|
|
4517
|
+
}
|
|
4348
4518
|
/** @example "LEVERAGE_I" */
|
|
4349
4519
|
export enum InsightGetFundsForHoldingRequestLeverageEnum {
|
|
4350
4520
|
ANY = "ANY",
|
|
@@ -5237,19 +5407,6 @@ export class StockScreener<HandleError extends boolean = boolean> {
|
|
|
5237
5407
|
*/
|
|
5238
5408
|
getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
5239
5409
|
}
|
|
5240
|
-
export class Intraday<HandleError extends boolean = boolean> {
|
|
5241
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5242
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5243
|
-
/**
|
|
5244
|
-
* @description Returns an array of intraday chart data values for the given ticker.
|
|
5245
|
-
* @tags Intraday
|
|
5246
|
-
* @name IntradayQuotes
|
|
5247
|
-
* @summary Get an array of intraday chart data values for the given ticker
|
|
5248
|
-
* @request POST:/intraday/quotes
|
|
5249
|
-
* @secure
|
|
5250
|
-
*/
|
|
5251
|
-
intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
|
|
5252
|
-
}
|
|
5253
5410
|
export class Quotes<HandleError extends boolean = boolean> {
|
|
5254
5411
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5255
5412
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5289,6 +5446,19 @@ export class Quotes<HandleError extends boolean = boolean> {
|
|
|
5289
5446
|
symbols: string;
|
|
5290
5447
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
|
|
5291
5448
|
}
|
|
5449
|
+
export class Intraday<HandleError extends boolean = boolean> {
|
|
5450
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5451
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5452
|
+
/**
|
|
5453
|
+
* @description Returns an array of intraday chart data values for the given ticker.
|
|
5454
|
+
* @tags Intraday
|
|
5455
|
+
* @name IntradayQuotes
|
|
5456
|
+
* @summary Get an array of intraday chart data values for the given ticker
|
|
5457
|
+
* @request POST:/intraday/quotes
|
|
5458
|
+
* @secure
|
|
5459
|
+
*/
|
|
5460
|
+
intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
|
|
5461
|
+
}
|
|
5292
5462
|
export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
5293
5463
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5294
5464
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5480,10 +5650,10 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
|
5480
5650
|
*/
|
|
5481
5651
|
getPreIpoCompanyResearchDocumentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyResearchDocument, HandleError>>;
|
|
5482
5652
|
/**
|
|
5483
|
-
* @description get pre ipo company spvs
|
|
5653
|
+
* @description get pre ipo company spvs with investor id
|
|
5484
5654
|
* @tags PreIPOCompanies
|
|
5485
5655
|
* @name GetInvestor
|
|
5486
|
-
* @summary get pre ipo company spvs
|
|
5656
|
+
* @summary get pre ipo company spvs with investor id
|
|
5487
5657
|
* @request GET:/ipos/pre-ipo-company-spv/investor/{investor_id}
|
|
5488
5658
|
* @secure
|
|
5489
5659
|
*/
|
|
@@ -5508,10 +5678,10 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
|
5508
5678
|
sort_by?: InsightGetInvestorParamsSortByEnum;
|
|
5509
5679
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsWithInvestorIDResponse, HandleError>>;
|
|
5510
5680
|
/**
|
|
5511
|
-
* @description get pre ipo company spv by id
|
|
5681
|
+
* @description get pre ipo company spv by id with investor id
|
|
5512
5682
|
* @tags PreIPOCompanies
|
|
5513
5683
|
* @name GetInvestorByIdAndInvestorId
|
|
5514
|
-
* @summary get pre ipo company spv by id
|
|
5684
|
+
* @summary get pre ipo company spv by id with investor id
|
|
5515
5685
|
* @request GET:/ipos/pre-ipo-company-spv/{id}/investor/{investor_id}
|
|
5516
5686
|
* @originalName getInvestor
|
|
5517
5687
|
* @duplicate
|
|
@@ -5605,31 +5775,6 @@ export class Ipos<HandleError extends boolean = boolean> {
|
|
|
5605
5775
|
statuses?: string[];
|
|
5606
5776
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
|
|
5607
5777
|
}
|
|
5608
|
-
export class MarketDates<HandleError extends boolean = boolean> {
|
|
5609
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5610
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5611
|
-
/**
|
|
5612
|
-
* @description get market dates history
|
|
5613
|
-
* @tags MarketDates
|
|
5614
|
-
* @name GetMarketDatesHistory
|
|
5615
|
-
* @summary get market dates history
|
|
5616
|
-
* @request POST:/market-dates/history
|
|
5617
|
-
* @secure
|
|
5618
|
-
*/
|
|
5619
|
-
getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
|
|
5620
|
-
/**
|
|
5621
|
-
* @description get todays market hours
|
|
5622
|
-
* @tags MarketDates
|
|
5623
|
-
* @name GetTodaysMarketHours
|
|
5624
|
-
* @summary get todays market hours
|
|
5625
|
-
* @request GET:/market-dates/today
|
|
5626
|
-
* @secure
|
|
5627
|
-
*/
|
|
5628
|
-
getTodaysMarketHours(query: {
|
|
5629
|
-
/** Market */
|
|
5630
|
-
market: string;
|
|
5631
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
|
|
5632
|
-
}
|
|
5633
5778
|
export class Logos<HandleError extends boolean = boolean> {
|
|
5634
5779
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5635
5780
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5730,6 +5875,124 @@ export class Logos<HandleError extends boolean = boolean> {
|
|
|
5730
5875
|
symbol: string;
|
|
5731
5876
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
|
|
5732
5877
|
}
|
|
5878
|
+
export class MarketDates<HandleError extends boolean = boolean> {
|
|
5879
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5880
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5881
|
+
/**
|
|
5882
|
+
* @description Create or update market date
|
|
5883
|
+
* @tags MarketDates
|
|
5884
|
+
* @name CreateOrUpdateMarketDate
|
|
5885
|
+
* @summary Create or update market date
|
|
5886
|
+
* @request POST:/market-dates
|
|
5887
|
+
* @secure
|
|
5888
|
+
*/
|
|
5889
|
+
createOrUpdateMarketDate(market: InsightCreateOrUpdateMarketDateRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketDate, HandleError>>;
|
|
5890
|
+
/**
|
|
5891
|
+
* @description Remove market date
|
|
5892
|
+
* @tags MarketDates
|
|
5893
|
+
* @name RemoveMarketDate
|
|
5894
|
+
* @summary Remove market date
|
|
5895
|
+
* @request DELETE:/market-dates
|
|
5896
|
+
* @secure
|
|
5897
|
+
*/
|
|
5898
|
+
removeMarketDate(market: InsightRemoveMarketDateRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5899
|
+
/**
|
|
5900
|
+
* @description Get market dates history
|
|
5901
|
+
* @tags MarketDates
|
|
5902
|
+
* @name GetMarketDatesHistory
|
|
5903
|
+
* @summary Get market dates history
|
|
5904
|
+
* @request POST:/market-dates/history
|
|
5905
|
+
* @secure
|
|
5906
|
+
*/
|
|
5907
|
+
getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
|
|
5908
|
+
/**
|
|
5909
|
+
* @description Get markets
|
|
5910
|
+
* @tags MarketDates
|
|
5911
|
+
* @name GetMarkets
|
|
5912
|
+
* @summary Get markets
|
|
5913
|
+
* @request GET:/market-dates/markets
|
|
5914
|
+
* @secure
|
|
5915
|
+
*/
|
|
5916
|
+
getMarkets(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketsResponse, HandleError>>;
|
|
5917
|
+
/**
|
|
5918
|
+
* @description Create or update market
|
|
5919
|
+
* @tags MarketDates
|
|
5920
|
+
* @name CreateOrUpdateMarket
|
|
5921
|
+
* @summary Create or update market
|
|
5922
|
+
* @request POST:/market-dates/markets
|
|
5923
|
+
* @secure
|
|
5924
|
+
*/
|
|
5925
|
+
createOrUpdateMarket(market: InsightCreateOrUpdateMarketRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarket, HandleError>>;
|
|
5926
|
+
/**
|
|
5927
|
+
* @description Get market
|
|
5928
|
+
* @tags MarketDates
|
|
5929
|
+
* @name GetMarket
|
|
5930
|
+
* @summary Get market
|
|
5931
|
+
* @request GET:/market-dates/markets/{market}
|
|
5932
|
+
* @secure
|
|
5933
|
+
*/
|
|
5934
|
+
getMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarket, HandleError>>;
|
|
5935
|
+
/**
|
|
5936
|
+
* @description Remove market
|
|
5937
|
+
* @tags MarketDates
|
|
5938
|
+
* @name RemoveMarket
|
|
5939
|
+
* @summary Remove market
|
|
5940
|
+
* @request DELETE:/market-dates/markets/{market}
|
|
5941
|
+
* @secure
|
|
5942
|
+
*/
|
|
5943
|
+
removeMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5944
|
+
/**
|
|
5945
|
+
* @description CreateOrUpdateMarketSchedule market schedule
|
|
5946
|
+
* @tags MarketDates
|
|
5947
|
+
* @name CreateOrUpdateMarketSchedule
|
|
5948
|
+
* @summary CreateOrUpdateMarketSchedule market schedule
|
|
5949
|
+
* @request POST:/market-dates/schedule
|
|
5950
|
+
* @secure
|
|
5951
|
+
*/
|
|
5952
|
+
createOrUpdateMarketSchedule(market: InsightCreateOrUpdateMarketScheduleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
|
|
5953
|
+
/**
|
|
5954
|
+
* @description Get market schedule
|
|
5955
|
+
* @tags MarketDates
|
|
5956
|
+
* @name GetMarketSchedule
|
|
5957
|
+
* @summary Get market schedule
|
|
5958
|
+
* @request GET:/market-dates/schedule/{market}
|
|
5959
|
+
* @secure
|
|
5960
|
+
*/
|
|
5961
|
+
getMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
|
|
5962
|
+
/**
|
|
5963
|
+
* @description Remove market schedule
|
|
5964
|
+
* @tags MarketDates
|
|
5965
|
+
* @name RemoveMarketSchedule
|
|
5966
|
+
* @summary Remove market schedule
|
|
5967
|
+
* @request DELETE:/market-dates/schedule/{market}
|
|
5968
|
+
* @secure
|
|
5969
|
+
*/
|
|
5970
|
+
removeMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5971
|
+
/**
|
|
5972
|
+
* @description Get market schedules
|
|
5973
|
+
* @tags MarketDates
|
|
5974
|
+
* @name GetMarketSchedules
|
|
5975
|
+
* @summary Get market schedules
|
|
5976
|
+
* @request GET:/market-dates/schedules
|
|
5977
|
+
* @secure
|
|
5978
|
+
*/
|
|
5979
|
+
getMarketSchedules(query?: {
|
|
5980
|
+
/** Market codes, comma separated */
|
|
5981
|
+
market?: string;
|
|
5982
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse[][], HandleError>>;
|
|
5983
|
+
/**
|
|
5984
|
+
* @description Get todays market hours
|
|
5985
|
+
* @tags MarketDates
|
|
5986
|
+
* @name GetTodaysMarketHours
|
|
5987
|
+
* @summary Get todays market hours
|
|
5988
|
+
* @request GET:/market-dates/today
|
|
5989
|
+
* @secure
|
|
5990
|
+
*/
|
|
5991
|
+
getTodaysMarketHours(query: {
|
|
5992
|
+
/** Market */
|
|
5993
|
+
market: string;
|
|
5994
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
|
|
5995
|
+
}
|
|
5733
5996
|
export class News<HandleError extends boolean = boolean> {
|
|
5734
5997
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5735
5998
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5876,6 +6139,50 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
5876
6139
|
*/
|
|
5877
6140
|
newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5878
6141
|
}
|
|
6142
|
+
export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
6143
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6144
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6145
|
+
/**
|
|
6146
|
+
* @description Returns calculated matrix
|
|
6147
|
+
* @tags OptionGreeks
|
|
6148
|
+
* @name OgCalculateMatrix
|
|
6149
|
+
* @summary Calculate matrix
|
|
6150
|
+
* @request POST:/og/calculate-matrix
|
|
6151
|
+
* @secure
|
|
6152
|
+
*/
|
|
6153
|
+
ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
|
|
6154
|
+
/**
|
|
6155
|
+
* @description Returns calculated params
|
|
6156
|
+
* @tags OptionGreeks
|
|
6157
|
+
* @name OgCalculateParams
|
|
6158
|
+
* @summary Calculate params
|
|
6159
|
+
* @request POST:/og/calculate-params
|
|
6160
|
+
* @secure
|
|
6161
|
+
*/
|
|
6162
|
+
ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
|
|
6163
|
+
}
|
|
6164
|
+
export class Ownerships<HandleError extends boolean = boolean> {
|
|
6165
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6166
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6167
|
+
/**
|
|
6168
|
+
* @description get ownerships by id datadata
|
|
6169
|
+
* @tags Ownerships
|
|
6170
|
+
* @name GetOwnershipsByIdData
|
|
6171
|
+
* @summary get ownerships by id data
|
|
6172
|
+
* @request POST:/ownerships
|
|
6173
|
+
* @secure
|
|
6174
|
+
*/
|
|
6175
|
+
getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
6176
|
+
/**
|
|
6177
|
+
* @description get ownerships by symbol data
|
|
6178
|
+
* @tags Ownerships
|
|
6179
|
+
* @name GetOwnershipsBySymbolData
|
|
6180
|
+
* @summary get ownerships by symbol data
|
|
6181
|
+
* @request POST:/symbol-ownerships
|
|
6182
|
+
* @secure
|
|
6183
|
+
*/
|
|
6184
|
+
getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
6185
|
+
}
|
|
5879
6186
|
export class Passport<HandleError extends boolean = boolean> {
|
|
5880
6187
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5881
6188
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5934,28 +6241,6 @@ export class Passport<HandleError extends boolean = boolean> {
|
|
|
5934
6241
|
*/
|
|
5935
6242
|
passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
5936
6243
|
}
|
|
5937
|
-
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
5938
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5939
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5940
|
-
/**
|
|
5941
|
-
* @description get seasonlity data with comparison to benchmark
|
|
5942
|
-
* @tags AlphaTools
|
|
5943
|
-
* @name GetMomentumRatioGraph
|
|
5944
|
-
* @summary get seasonlity data
|
|
5945
|
-
* @request POST:/rst
|
|
5946
|
-
* @secure
|
|
5947
|
-
*/
|
|
5948
|
-
getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
|
|
5949
|
-
/**
|
|
5950
|
-
* @description get seasonlity data with comparison to benchmark
|
|
5951
|
-
* @tags AlphaTools
|
|
5952
|
-
* @name GetSeasonality
|
|
5953
|
-
* @summary get seasonlity data
|
|
5954
|
-
* @request POST:/seasonality
|
|
5955
|
-
* @secure
|
|
5956
|
-
*/
|
|
5957
|
-
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
|
|
5958
|
-
}
|
|
5959
6244
|
export class TipRank<HandleError extends boolean = boolean> {
|
|
5960
6245
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5961
6246
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -6335,27 +6620,27 @@ export class UsageTracking<HandleError extends boolean = boolean> {
|
|
|
6335
6620
|
*/
|
|
6336
6621
|
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
|
|
6337
6622
|
}
|
|
6338
|
-
export class
|
|
6623
|
+
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
6339
6624
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6340
6625
|
constructor(apiClient: JwtClient<HandleError>);
|
|
6341
6626
|
/**
|
|
6342
|
-
* @description
|
|
6343
|
-
* @tags
|
|
6344
|
-
* @name
|
|
6345
|
-
* @summary
|
|
6346
|
-
* @request POST:/
|
|
6627
|
+
* @description get seasonlity data with comparison to benchmark
|
|
6628
|
+
* @tags AlphaTools
|
|
6629
|
+
* @name GetMomentumRatioGraph
|
|
6630
|
+
* @summary get seasonlity data
|
|
6631
|
+
* @request POST:/rst
|
|
6347
6632
|
* @secure
|
|
6348
6633
|
*/
|
|
6349
|
-
|
|
6634
|
+
getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
|
|
6350
6635
|
/**
|
|
6351
|
-
* @description
|
|
6352
|
-
* @tags
|
|
6353
|
-
* @name
|
|
6354
|
-
* @summary
|
|
6355
|
-
* @request POST:/
|
|
6636
|
+
* @description get seasonlity data with comparison to benchmark
|
|
6637
|
+
* @tags AlphaTools
|
|
6638
|
+
* @name GetSeasonality
|
|
6639
|
+
* @summary get seasonlity data
|
|
6640
|
+
* @request POST:/seasonality
|
|
6356
6641
|
* @secure
|
|
6357
6642
|
*/
|
|
6358
|
-
|
|
6643
|
+
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
|
|
6359
6644
|
}
|
|
6360
6645
|
export class Public<HandleError extends boolean = boolean> {
|
|
6361
6646
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -6371,7 +6656,10 @@ export class Public<HandleError extends boolean = boolean> {
|
|
|
6371
6656
|
calculateEstimatedReturns(query: {
|
|
6372
6657
|
/** Single symbol */
|
|
6373
6658
|
symbol: string;
|
|
6374
|
-
/**
|
|
6659
|
+
/**
|
|
6660
|
+
* Non-zero amount
|
|
6661
|
+
* @format float64
|
|
6662
|
+
*/
|
|
6375
6663
|
amount: number;
|
|
6376
6664
|
/** Start date for calculations */
|
|
6377
6665
|
start_date: string;
|
|
@@ -6483,28 +6771,6 @@ export class Public<HandleError extends boolean = boolean> {
|
|
|
6483
6771
|
offset: number;
|
|
6484
6772
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6485
6773
|
}
|
|
6486
|
-
export class Ownerships<HandleError extends boolean = boolean> {
|
|
6487
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6488
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6489
|
-
/**
|
|
6490
|
-
* @description get ownerships by id datadata
|
|
6491
|
-
* @tags Ownerships
|
|
6492
|
-
* @name GetOwnershipsByIdData
|
|
6493
|
-
* @summary get ownerships by id data
|
|
6494
|
-
* @request POST:/ownerships
|
|
6495
|
-
* @secure
|
|
6496
|
-
*/
|
|
6497
|
-
getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
6498
|
-
/**
|
|
6499
|
-
* @description get ownerships by symbol data
|
|
6500
|
-
* @tags Ownerships
|
|
6501
|
-
* @name GetOwnershipsBySymbolData
|
|
6502
|
-
* @summary get ownerships by symbol data
|
|
6503
|
-
* @request POST:/symbol-ownerships
|
|
6504
|
-
* @secure
|
|
6505
|
-
*/
|
|
6506
|
-
getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
6507
|
-
}
|
|
6508
6774
|
export interface InsightBeforeAndAfterV2 {
|
|
6509
6775
|
after?: string;
|
|
6510
6776
|
before?: string;
|
|
@@ -6652,6 +6918,10 @@ export interface InsightLessAndMoreV2 {
|
|
|
6652
6918
|
less_than?: number;
|
|
6653
6919
|
more_than?: number;
|
|
6654
6920
|
}
|
|
6921
|
+
export enum InsightOrderDirectionV2 {
|
|
6922
|
+
OrderASC = "asc",
|
|
6923
|
+
OrderDESC = "desc"
|
|
6924
|
+
}
|
|
6655
6925
|
export interface InsightOrderingV2 {
|
|
6656
6926
|
/**
|
|
6657
6927
|
* @default "asc"
|