@orbis-systems/orbis-api-clients 0.7.13 → 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 +297 -163
- 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 +1034 -882
- 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 +1535 -1265
- 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 +141 -72
- 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 +3907 -4063
- 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 +917 -1221
- 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 +607 -589
- 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",
|
|
@@ -4549,28 +4719,6 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
|
|
|
4549
4719
|
Date = "date",
|
|
4550
4720
|
Rank = "rank"
|
|
4551
4721
|
}
|
|
4552
|
-
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
4553
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4554
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4555
|
-
/**
|
|
4556
|
-
* @description get seasonlity data with comparison to benchmark
|
|
4557
|
-
* @tags AlphaTools
|
|
4558
|
-
* @name GetMomentumRatioGraph
|
|
4559
|
-
* @summary get seasonlity data
|
|
4560
|
-
* @request POST:/rst
|
|
4561
|
-
* @secure
|
|
4562
|
-
*/
|
|
4563
|
-
getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
|
|
4564
|
-
/**
|
|
4565
|
-
* @description get seasonlity data with comparison to benchmark
|
|
4566
|
-
* @tags AlphaTools
|
|
4567
|
-
* @name GetSeasonality
|
|
4568
|
-
* @summary get seasonlity data
|
|
4569
|
-
* @request POST:/seasonality
|
|
4570
|
-
* @secure
|
|
4571
|
-
*/
|
|
4572
|
-
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
|
|
4573
|
-
}
|
|
4574
4722
|
export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
4575
4723
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4576
4724
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4610,120 +4758,302 @@ export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
|
4610
4758
|
*/
|
|
4611
4759
|
getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
|
|
4612
4760
|
}
|
|
4613
|
-
export class
|
|
4761
|
+
export class WorldMarkets<HandleError extends boolean = boolean> {
|
|
4614
4762
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4615
4763
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4616
4764
|
/**
|
|
4617
|
-
* @description
|
|
4618
|
-
* @tags
|
|
4619
|
-
* @name
|
|
4620
|
-
* @summary
|
|
4621
|
-
* @request GET:/
|
|
4765
|
+
* @description Get continents
|
|
4766
|
+
* @tags World Markets
|
|
4767
|
+
* @name ContinentGet
|
|
4768
|
+
* @summary Get continents
|
|
4769
|
+
* @request GET:/continents
|
|
4622
4770
|
* @secure
|
|
4623
4771
|
*/
|
|
4624
|
-
|
|
4625
|
-
/**
|
|
4772
|
+
continentGet(query: {
|
|
4773
|
+
/** Query limit */
|
|
4626
4774
|
limit: number;
|
|
4627
|
-
/**
|
|
4775
|
+
/** Query offset */
|
|
4628
4776
|
offset: number;
|
|
4629
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4630
|
-
/**
|
|
4631
|
-
* @description update custom list
|
|
4632
|
-
* @tags Custom Lists
|
|
4633
|
-
* @name UpdateCustomList
|
|
4634
|
-
* @summary update custom list
|
|
4635
|
-
* @request PUT:/custom-lists
|
|
4636
|
-
* @secure
|
|
4637
|
-
*/
|
|
4638
|
-
updateCustomList(filter: InsightUpdateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
|
|
4777
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
4639
4778
|
/**
|
|
4640
|
-
* @description
|
|
4641
|
-
* @tags
|
|
4642
|
-
* @name
|
|
4643
|
-
* @summary
|
|
4644
|
-
* @request
|
|
4779
|
+
* @description Edit continent
|
|
4780
|
+
* @tags World Markets
|
|
4781
|
+
* @name ContinentEdit
|
|
4782
|
+
* @summary Edit continent
|
|
4783
|
+
* @request PUT:/continents
|
|
4645
4784
|
* @secure
|
|
4646
4785
|
*/
|
|
4647
|
-
|
|
4786
|
+
continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4648
4787
|
/**
|
|
4649
|
-
* @description
|
|
4650
|
-
* @tags
|
|
4651
|
-
* @name
|
|
4652
|
-
* @summary
|
|
4653
|
-
* @request
|
|
4788
|
+
* @description Create continents
|
|
4789
|
+
* @tags World Markets
|
|
4790
|
+
* @name ContinentCreate
|
|
4791
|
+
* @summary Create continents
|
|
4792
|
+
* @request POST:/continents
|
|
4654
4793
|
* @secure
|
|
4655
4794
|
*/
|
|
4656
|
-
|
|
4795
|
+
continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
4657
4796
|
/**
|
|
4658
|
-
* @description
|
|
4659
|
-
* @tags
|
|
4660
|
-
* @name
|
|
4661
|
-
* @summary
|
|
4662
|
-
* @request
|
|
4797
|
+
* @description Delete continent
|
|
4798
|
+
* @tags World Markets
|
|
4799
|
+
* @name ContinentDelete
|
|
4800
|
+
* @summary Delete continent
|
|
4801
|
+
* @request DELETE:/continents
|
|
4663
4802
|
* @secure
|
|
4664
4803
|
*/
|
|
4665
|
-
|
|
4804
|
+
continentDelete(query: {
|
|
4805
|
+
/** continent id */
|
|
4806
|
+
id: string;
|
|
4807
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4666
4808
|
/**
|
|
4667
|
-
* @description
|
|
4668
|
-
* @tags
|
|
4669
|
-
* @name
|
|
4670
|
-
* @summary
|
|
4671
|
-
* @request GET:/
|
|
4809
|
+
* @description Get country codes
|
|
4810
|
+
* @tags World Markets
|
|
4811
|
+
* @name CountryCodeGet
|
|
4812
|
+
* @summary Get country codes
|
|
4813
|
+
* @request GET:/country-codes
|
|
4672
4814
|
* @secure
|
|
4673
4815
|
*/
|
|
4674
|
-
|
|
4675
|
-
/**
|
|
4676
|
-
order_direction: string;
|
|
4677
|
-
/** sort field - volume, symbol(alphabetical), market_cap, dividend_percent */
|
|
4678
|
-
order_field: string;
|
|
4679
|
-
/** how many equities records to return. Max value is 50 */
|
|
4816
|
+
countryCodeGet(query: {
|
|
4817
|
+
/** Query limit */
|
|
4680
4818
|
limit: number;
|
|
4681
|
-
/**
|
|
4819
|
+
/** Query offset */
|
|
4682
4820
|
offset: number;
|
|
4683
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4821
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
4684
4822
|
/**
|
|
4685
|
-
* @description
|
|
4686
|
-
* @tags
|
|
4687
|
-
* @name
|
|
4688
|
-
* @summary
|
|
4689
|
-
* @request
|
|
4823
|
+
* @description Edit country code
|
|
4824
|
+
* @tags World Markets
|
|
4825
|
+
* @name CountryCodeEdit
|
|
4826
|
+
* @summary Edit country code
|
|
4827
|
+
* @request PUT:/country-codes
|
|
4690
4828
|
* @secure
|
|
4691
4829
|
*/
|
|
4692
|
-
|
|
4693
|
-
/** symbols to check inclusion */
|
|
4694
|
-
symbols?: string[];
|
|
4695
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFilteredCustomIndexResponse, HandleError>>;
|
|
4696
|
-
}
|
|
4697
|
-
export class Dashboard<HandleError extends boolean = boolean> {
|
|
4698
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4699
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4830
|
+
countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4700
4831
|
/**
|
|
4701
|
-
* @description
|
|
4702
|
-
* @tags
|
|
4703
|
-
* @name
|
|
4704
|
-
* @summary
|
|
4705
|
-
* @request POST:/
|
|
4832
|
+
* @description Add country codes
|
|
4833
|
+
* @tags World Markets
|
|
4834
|
+
* @name CountryCodeAdd
|
|
4835
|
+
* @summary Add country codes
|
|
4836
|
+
* @request POST:/country-codes
|
|
4706
4837
|
* @secure
|
|
4707
4838
|
*/
|
|
4708
|
-
|
|
4839
|
+
countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
4709
4840
|
/**
|
|
4710
|
-
* @description
|
|
4711
|
-
* @tags
|
|
4712
|
-
* @name
|
|
4713
|
-
* @summary
|
|
4714
|
-
* @request
|
|
4841
|
+
* @description Delete country code
|
|
4842
|
+
* @tags World Markets
|
|
4843
|
+
* @name CountryCodeDelete
|
|
4844
|
+
* @summary Delete country code
|
|
4845
|
+
* @request DELETE:/country-codes
|
|
4715
4846
|
* @secure
|
|
4716
4847
|
*/
|
|
4717
|
-
|
|
4848
|
+
countryCodeDelete(query: {
|
|
4849
|
+
/** a3 code */
|
|
4850
|
+
a3code: string;
|
|
4851
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4718
4852
|
/**
|
|
4719
|
-
* @description
|
|
4720
|
-
* @tags
|
|
4721
|
-
* @name
|
|
4722
|
-
* @summary
|
|
4723
|
-
* @request
|
|
4724
|
-
* @secure
|
|
4725
|
-
*/
|
|
4726
|
-
|
|
4853
|
+
* @description Get global indexes
|
|
4854
|
+
* @tags World Markets
|
|
4855
|
+
* @name GlobalIndexGet
|
|
4856
|
+
* @summary Get global indexes
|
|
4857
|
+
* @request GET:/global-indexes
|
|
4858
|
+
* @secure
|
|
4859
|
+
*/
|
|
4860
|
+
globalIndexGet(query: {
|
|
4861
|
+
/** Query limit */
|
|
4862
|
+
limit: number;
|
|
4863
|
+
/** Query offset */
|
|
4864
|
+
offset: number;
|
|
4865
|
+
/** Continent code for filtering */
|
|
4866
|
+
continent?: string;
|
|
4867
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
4868
|
+
/**
|
|
4869
|
+
* @description Edit global index
|
|
4870
|
+
* @tags World Markets
|
|
4871
|
+
* @name GlobalIndexEdit
|
|
4872
|
+
* @summary Edit global index
|
|
4873
|
+
* @request PUT:/global-indexes
|
|
4874
|
+
* @secure
|
|
4875
|
+
*/
|
|
4876
|
+
globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4877
|
+
/**
|
|
4878
|
+
* @description Add global indexes
|
|
4879
|
+
* @tags World Markets
|
|
4880
|
+
* @name GlobalIndexAdd
|
|
4881
|
+
* @summary Add global indexes
|
|
4882
|
+
* @request POST:/global-indexes
|
|
4883
|
+
* @secure
|
|
4884
|
+
*/
|
|
4885
|
+
globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
4886
|
+
/**
|
|
4887
|
+
* @description Edit global index
|
|
4888
|
+
* @tags World Markets
|
|
4889
|
+
* @name GlobalIndexDelete
|
|
4890
|
+
* @summary Delete global index
|
|
4891
|
+
* @request DELETE:/global-indexes
|
|
4892
|
+
* @secure
|
|
4893
|
+
*/
|
|
4894
|
+
globalIndexDelete(query: {
|
|
4895
|
+
/** a3 code */
|
|
4896
|
+
a3code: string;
|
|
4897
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4898
|
+
/**
|
|
4899
|
+
* @description Get regions
|
|
4900
|
+
* @tags World Markets
|
|
4901
|
+
* @name RegionGet
|
|
4902
|
+
* @summary Get regions
|
|
4903
|
+
* @request GET:/regions
|
|
4904
|
+
* @secure
|
|
4905
|
+
*/
|
|
4906
|
+
regionGet(query: {
|
|
4907
|
+
/** Query limit */
|
|
4908
|
+
limit: number;
|
|
4909
|
+
/** Query offset */
|
|
4910
|
+
offset: number;
|
|
4911
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
4912
|
+
/**
|
|
4913
|
+
* @description Edit region
|
|
4914
|
+
* @tags World Markets
|
|
4915
|
+
* @name RegionEdit
|
|
4916
|
+
* @summary Edit region
|
|
4917
|
+
* @request PUT:/regions
|
|
4918
|
+
* @secure
|
|
4919
|
+
*/
|
|
4920
|
+
regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4921
|
+
/**
|
|
4922
|
+
* @description Create regions
|
|
4923
|
+
* @tags World Markets
|
|
4924
|
+
* @name RegionCreate
|
|
4925
|
+
* @summary Create regions
|
|
4926
|
+
* @request POST:/regions
|
|
4927
|
+
* @secure
|
|
4928
|
+
*/
|
|
4929
|
+
regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
4930
|
+
/**
|
|
4931
|
+
* @description Delete region
|
|
4932
|
+
* @tags World Markets
|
|
4933
|
+
* @name RegionDelete
|
|
4934
|
+
* @summary Delete region
|
|
4935
|
+
* @request DELETE:/regions
|
|
4936
|
+
* @secure
|
|
4937
|
+
*/
|
|
4938
|
+
regionDelete(query: {
|
|
4939
|
+
/** region id */
|
|
4940
|
+
id: string;
|
|
4941
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4942
|
+
}
|
|
4943
|
+
export class CustomLists<HandleError extends boolean = boolean> {
|
|
4944
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4945
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4946
|
+
/**
|
|
4947
|
+
* @description get custom lists
|
|
4948
|
+
* @tags Custom Lists
|
|
4949
|
+
* @name GetCustomLists
|
|
4950
|
+
* @summary get custom lists
|
|
4951
|
+
* @request GET:/custom-lists
|
|
4952
|
+
* @secure
|
|
4953
|
+
*/
|
|
4954
|
+
getCustomLists(query: {
|
|
4955
|
+
/** how many records to return. Max value is 50 */
|
|
4956
|
+
limit: number;
|
|
4957
|
+
/** how many records to skip */
|
|
4958
|
+
offset: number;
|
|
4959
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
4960
|
+
/**
|
|
4961
|
+
* @description update custom list
|
|
4962
|
+
* @tags Custom Lists
|
|
4963
|
+
* @name UpdateCustomList
|
|
4964
|
+
* @summary update custom list
|
|
4965
|
+
* @request PUT:/custom-lists
|
|
4966
|
+
* @secure
|
|
4967
|
+
*/
|
|
4968
|
+
updateCustomList(filter: InsightUpdateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
|
|
4969
|
+
/**
|
|
4970
|
+
* @description create custom list
|
|
4971
|
+
* @tags Custom Lists
|
|
4972
|
+
* @name CreateCustomList
|
|
4973
|
+
* @summary create custom list
|
|
4974
|
+
* @request POST:/custom-lists
|
|
4975
|
+
* @secure
|
|
4976
|
+
*/
|
|
4977
|
+
createCustomList(filter: InsightCreateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
|
|
4978
|
+
/**
|
|
4979
|
+
* @description remove custom list
|
|
4980
|
+
* @tags Custom Lists
|
|
4981
|
+
* @name RemoveCustomList
|
|
4982
|
+
* @summary remove custom list
|
|
4983
|
+
* @request DELETE:/custom-lists
|
|
4984
|
+
* @secure
|
|
4985
|
+
*/
|
|
4986
|
+
removeCustomList(filter: InsightRemoveCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4987
|
+
/**
|
|
4988
|
+
* @description filter custom lists
|
|
4989
|
+
* @tags Custom Lists
|
|
4990
|
+
* @name FilterCustomLists
|
|
4991
|
+
* @summary filter custom lists
|
|
4992
|
+
* @request POST:/custom-lists/filter
|
|
4993
|
+
* @secure
|
|
4994
|
+
*/
|
|
4995
|
+
filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
4996
|
+
/**
|
|
4997
|
+
* @description get custom list with quotes
|
|
4998
|
+
* @tags Custom Lists
|
|
4999
|
+
* @name GetCustomListWithQuotes
|
|
5000
|
+
* @summary get custom list with quotes
|
|
5001
|
+
* @request GET:/custom-lists/{id-or-slug}
|
|
5002
|
+
* @secure
|
|
5003
|
+
*/
|
|
5004
|
+
getCustomListWithQuotes(idOrSlug: string, query: {
|
|
5005
|
+
/** sort direction - asc or desc */
|
|
5006
|
+
order_direction: string;
|
|
5007
|
+
/** sort field - volume, symbol(alphabetical), market_cap, dividend_percent */
|
|
5008
|
+
order_field: string;
|
|
5009
|
+
/** how many equities records to return. Max value is 50 */
|
|
5010
|
+
limit: number;
|
|
5011
|
+
/** how many equities records to skip */
|
|
5012
|
+
offset: number;
|
|
5013
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
5014
|
+
/**
|
|
5015
|
+
* @description filter custom list
|
|
5016
|
+
* @tags Custom Lists
|
|
5017
|
+
* @name FilterCustomList
|
|
5018
|
+
* @summary filter custom list
|
|
5019
|
+
* @request GET:/custom-lists/{id-or-slug}/filter
|
|
5020
|
+
* @secure
|
|
5021
|
+
*/
|
|
5022
|
+
filterCustomList(idOrSlug: string, query?: {
|
|
5023
|
+
/** symbols to check inclusion */
|
|
5024
|
+
symbols?: string[];
|
|
5025
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFilteredCustomIndexResponse, HandleError>>;
|
|
5026
|
+
}
|
|
5027
|
+
export class Dashboard<HandleError extends boolean = boolean> {
|
|
5028
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5029
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5030
|
+
/**
|
|
5031
|
+
* @description get ownerships by symbol
|
|
5032
|
+
* @tags Dashboard
|
|
5033
|
+
* @name DashboardGetOwnershipsBySymbol
|
|
5034
|
+
* @summary get ownerships by symbol
|
|
5035
|
+
* @request POST:/dashboard/ownerships
|
|
5036
|
+
* @secure
|
|
5037
|
+
*/
|
|
5038
|
+
dashboardGetOwnershipsBySymbol(filter: InsightGetOwnershipsBySymbolRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolAsDashboardFieldsResponse, HandleError>>;
|
|
5039
|
+
/**
|
|
5040
|
+
* @description rewrite field value
|
|
5041
|
+
* @tags Dashboard
|
|
5042
|
+
* @name RewriteFieldValue
|
|
5043
|
+
* @summary rewrite field value
|
|
5044
|
+
* @request POST:/rewrite-field
|
|
5045
|
+
* @secure
|
|
5046
|
+
*/
|
|
5047
|
+
rewriteFieldValue(input: InsightRewriteFieldValueRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5048
|
+
/**
|
|
5049
|
+
* @description remove rewritten value
|
|
5050
|
+
* @tags Dashboard
|
|
5051
|
+
* @name CreateRewriteField
|
|
5052
|
+
* @summary remove rewritten value
|
|
5053
|
+
* @request DELETE:/rewrite-field
|
|
5054
|
+
* @secure
|
|
5055
|
+
*/
|
|
5056
|
+
createRewriteField(input: InsightRemoveRewrittenFieldValueRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4727
5057
|
/**
|
|
4728
5058
|
* @description Get rewritten field action log
|
|
4729
5059
|
* @tags Dashboard
|
|
@@ -4854,256 +5184,18 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
4854
5184
|
*/
|
|
4855
5185
|
getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
|
|
4856
5186
|
}
|
|
4857
|
-
export
|
|
4858
|
-
|
|
4859
|
-
|
|
4860
|
-
|
|
4861
|
-
|
|
4862
|
-
|
|
4863
|
-
|
|
4864
|
-
|
|
4865
|
-
|
|
4866
|
-
|
|
4867
|
-
|
|
4868
|
-
|
|
4869
|
-
close_price_asof: string;
|
|
4870
|
-
close_ytw: number;
|
|
4871
|
-
convertible: boolean;
|
|
4872
|
-
country: string;
|
|
4873
|
-
country_code: string;
|
|
4874
|
-
country_domicile: string;
|
|
4875
|
-
country_issue: string;
|
|
4876
|
-
coupon: number;
|
|
4877
|
-
coupon_frequency: string;
|
|
4878
|
-
coupon_type: string;
|
|
4879
|
-
currency: string;
|
|
4880
|
-
cusip: string;
|
|
4881
|
-
dated_date: string;
|
|
4882
|
-
daycount: string;
|
|
4883
|
-
description: string;
|
|
4884
|
-
description_short: string;
|
|
4885
|
-
duration: number;
|
|
4886
|
-
first_coupon_date: string;
|
|
4887
|
-
insured: boolean;
|
|
4888
|
-
isin: string;
|
|
4889
|
-
issue_date: string;
|
|
4890
|
-
issue_minimum_denomination: number;
|
|
4891
|
-
issue_price: number;
|
|
4892
|
-
issue_size: number;
|
|
4893
|
-
issuer: string;
|
|
4894
|
-
last_coupon_date: string;
|
|
4895
|
-
liquidity_institutional_aggregate: number;
|
|
4896
|
-
liquidity_institutional_buy: number;
|
|
4897
|
-
liquidity_institutional_sell: number;
|
|
4898
|
-
liquidity_micro_aggregate: number;
|
|
4899
|
-
liquidity_micro_buy: number;
|
|
4900
|
-
liquidity_micro_sell: number;
|
|
4901
|
-
liquidity_retail_aggregate: number;
|
|
4902
|
-
liquidity_retail_buy: number;
|
|
4903
|
-
liquidity_retail_sell: number;
|
|
4904
|
-
maturity_date: string;
|
|
4905
|
-
municipal_state: string;
|
|
4906
|
-
municipal_taxable_federal: boolean;
|
|
4907
|
-
municipal_type: string;
|
|
4908
|
-
next_call_date: string;
|
|
4909
|
-
next_call_price: number;
|
|
4910
|
-
next_coupon_date: string;
|
|
4911
|
-
par_value: number;
|
|
4912
|
-
perpetual: boolean;
|
|
4913
|
-
private_placement: boolean;
|
|
4914
|
-
purpose: string;
|
|
4915
|
-
puttable: boolean;
|
|
4916
|
-
reg_s: boolean;
|
|
4917
|
-
sector: string;
|
|
4918
|
-
seniority: string;
|
|
4919
|
-
settlement_convention: string;
|
|
4920
|
-
sinking_fund: boolean;
|
|
4921
|
-
sp_creditwatch: string;
|
|
4922
|
-
sp_creditwatch_date: string;
|
|
4923
|
-
sp_outlook: string;
|
|
4924
|
-
sp_outlook_date: string;
|
|
4925
|
-
sp_rating: string;
|
|
4926
|
-
sp_rating_date: string;
|
|
4927
|
-
status: string;
|
|
4928
|
-
ticker: string;
|
|
4929
|
-
treasury_subtype: string;
|
|
4930
|
-
type: string;
|
|
4931
|
-
updated_at: string;
|
|
4932
|
-
}
|
|
4933
|
-
export interface InsightGetFixedIncomeEntriesResponseV2 {
|
|
4934
|
-
count: number;
|
|
4935
|
-
data: InsightFixedIncomeV2[];
|
|
4936
|
-
}
|
|
4937
|
-
export interface InsightGetFixedIncomeEntriesRequestV2 {
|
|
4938
|
-
/** @example true */
|
|
4939
|
-
bank_qualified?: boolean;
|
|
4940
|
-
/** @example true */
|
|
4941
|
-
callable?: boolean;
|
|
4942
|
-
/** @example true */
|
|
4943
|
-
convertible?: boolean;
|
|
4944
|
-
/** @example ["USA"] */
|
|
4945
|
-
country_codes?: string[];
|
|
4946
|
-
coupon?: InsightLessAndMoreV2;
|
|
4947
|
-
/** @example ["quarterly","zero"] */
|
|
4948
|
-
coupon_frequencies?: string[];
|
|
4949
|
-
/** @example ["655664AH3","9128286R6"] */
|
|
4950
|
-
cusip?: string[];
|
|
4951
|
-
/**
|
|
4952
|
-
* @maxLength 100
|
|
4953
|
-
* @example "Donald's"
|
|
4954
|
-
*/
|
|
4955
|
-
description?: string;
|
|
4956
|
-
/** @example true */
|
|
4957
|
-
has_ticker?: boolean;
|
|
4958
|
-
/** @example true */
|
|
4959
|
-
insured?: boolean;
|
|
4960
|
-
/** @example ["US655664AH33","US9128286R69"] */
|
|
4961
|
-
isin?: string[];
|
|
4962
|
-
issue_date?: InsightBeforeAndAfterV2;
|
|
4963
|
-
/**
|
|
4964
|
-
* @maxLength 100
|
|
4965
|
-
* @example "Donald's"
|
|
4966
|
-
*/
|
|
4967
|
-
issuer?: string;
|
|
4968
|
-
maturity?: InsightBeforeAndAfterV2;
|
|
4969
|
-
/** @example ["NY"] */
|
|
4970
|
-
municipal_states?: string[];
|
|
4971
|
-
/** @example true */
|
|
4972
|
-
municipal_tax?: boolean;
|
|
4973
|
-
/** @example ["general_obligation"] */
|
|
4974
|
-
municipal_types?: string[];
|
|
4975
|
-
pagination: InsightPaginationV2;
|
|
4976
|
-
purposes?: string[];
|
|
4977
|
-
/** @example ["SOVEREIGN"] */
|
|
4978
|
-
sectors?: string[];
|
|
4979
|
-
sorts?: InsightOrderingV2[];
|
|
4980
|
-
/** @example ["AAA"] */
|
|
4981
|
-
sp_ratings?: string[];
|
|
4982
|
-
/** @example ["called","outstanding"] */
|
|
4983
|
-
statuses?: string[];
|
|
4984
|
-
tickers?: string[];
|
|
4985
|
-
/** @example ["corporate"] */
|
|
4986
|
-
types?: string[];
|
|
4987
|
-
}
|
|
4988
|
-
export interface InsightGetTopSymbolsRequestV2 {
|
|
4989
|
-
exchange?: string[];
|
|
4990
|
-
market_cap?: InsightLessAndMoreV2;
|
|
4991
|
-
pagination?: InsightPaginationV2;
|
|
4992
|
-
price?: InsightLessAndMoreV2;
|
|
4993
|
-
sorts?: InsightOrderingV2[];
|
|
4994
|
-
volume?: InsightLessAndMoreV2;
|
|
4995
|
-
}
|
|
4996
|
-
export interface InsightIncludeExcludeV2 {
|
|
4997
|
-
exclude?: string[];
|
|
4998
|
-
include?: string[];
|
|
4999
|
-
}
|
|
5000
|
-
export interface InsightLessAndMoreV2 {
|
|
5001
|
-
less_than?: number;
|
|
5002
|
-
more_than?: number;
|
|
5003
|
-
}
|
|
5004
|
-
export interface InsightOrderingV2 {
|
|
5005
|
-
/**
|
|
5006
|
-
* @default "asc"
|
|
5007
|
-
* @example "asc"
|
|
5008
|
-
*/
|
|
5009
|
-
direction: InsightOrderingDirectionEnumV2;
|
|
5010
|
-
/**
|
|
5011
|
-
* Sort direction:
|
|
5012
|
-
* * asc - Ascending, from A to Z.
|
|
5013
|
-
* * desc - Descending, from Z to A.
|
|
5014
|
-
* @example "name"
|
|
5015
|
-
*/
|
|
5016
|
-
field: string;
|
|
5017
|
-
}
|
|
5018
|
-
export interface InsightPaginationV2 {
|
|
5019
|
-
/**
|
|
5020
|
-
* @min 1
|
|
5021
|
-
* @example 1
|
|
5022
|
-
*/
|
|
5023
|
-
page: number;
|
|
5024
|
-
/**
|
|
5025
|
-
* @min 1
|
|
5026
|
-
* @max 50
|
|
5027
|
-
* @example 10
|
|
5028
|
-
*/
|
|
5029
|
-
size: number;
|
|
5030
|
-
}
|
|
5031
|
-
export interface InsightStockScreenerQuoteV2 {
|
|
5032
|
-
average_volume_30d: number;
|
|
5033
|
-
company_name: string;
|
|
5034
|
-
dividend_ex_date: string;
|
|
5035
|
-
dividend_pay_date: string;
|
|
5036
|
-
dividend_percent: number;
|
|
5037
|
-
exchange: string;
|
|
5038
|
-
exchange_name: string;
|
|
5039
|
-
gap: number;
|
|
5040
|
-
industry: string;
|
|
5041
|
-
industry_code: string;
|
|
5042
|
-
last_price: number;
|
|
5043
|
-
market_cap: number;
|
|
5044
|
-
pe_ratio: number;
|
|
5045
|
-
price_change: number;
|
|
5046
|
-
price_change_percent: number;
|
|
5047
|
-
symbol: string;
|
|
5048
|
-
volume: number;
|
|
5049
|
-
}
|
|
5050
|
-
export interface InsightStockScreenerRequestV2 {
|
|
5051
|
-
average_volume_30d?: InsightLessAndMoreV2;
|
|
5052
|
-
dividend_ex_date?: InsightBeforeAndAfterV2;
|
|
5053
|
-
dividend_pay_date?: InsightBeforeAndAfterV2;
|
|
5054
|
-
dividend_percent?: InsightLessAndMoreV2;
|
|
5055
|
-
exchange?: InsightIncludeExcludeV2;
|
|
5056
|
-
gap?: InsightLessAndMoreV2;
|
|
5057
|
-
industry?: InsightIncludeExcludeV2;
|
|
5058
|
-
market_cap?: InsightLessAndMoreV2;
|
|
5059
|
-
pagination: InsightPaginationV2;
|
|
5060
|
-
pe_ratio?: InsightLessAndMoreV2;
|
|
5061
|
-
price?: InsightLessAndMoreV2;
|
|
5062
|
-
sorts?: InsightOrderingV2[];
|
|
5063
|
-
/** @example "ADR" */
|
|
5064
|
-
stock_type?: string;
|
|
5065
|
-
volume?: InsightLessAndMoreV2;
|
|
5066
|
-
}
|
|
5067
|
-
export interface InsightStockScreenerResponseV2 {
|
|
5068
|
-
current_page: number;
|
|
5069
|
-
data: InsightStockScreenerQuoteV2[];
|
|
5070
|
-
page_count: number;
|
|
5071
|
-
status: number;
|
|
5072
|
-
total_records: number;
|
|
5073
|
-
}
|
|
5074
|
-
/**
|
|
5075
|
-
* @default "asc"
|
|
5076
|
-
* @example "asc"
|
|
5077
|
-
*/
|
|
5078
|
-
export enum InsightOrderingDirectionEnumV2 {
|
|
5079
|
-
Asc = "asc",
|
|
5080
|
-
Desc = "desc"
|
|
5081
|
-
}
|
|
5082
|
-
export class FixedIncomeV2<HandleError extends boolean = boolean> {
|
|
5083
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5084
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5085
|
-
/**
|
|
5086
|
-
* @description get fixed income entries
|
|
5087
|
-
* @tags FixedIncome
|
|
5088
|
-
* @name GetFixedIncomeEntries
|
|
5089
|
-
* @summary get fixed income entries
|
|
5090
|
-
* @request POST:/fixed-income
|
|
5091
|
-
* @secure
|
|
5092
|
-
*/
|
|
5093
|
-
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
|
|
5094
|
-
}
|
|
5095
|
-
export class Fundamentals<HandleError extends boolean = boolean> {
|
|
5096
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5097
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5098
|
-
/**
|
|
5099
|
-
* @description get fundamentals by symbol data
|
|
5100
|
-
* @tags Fundamentals
|
|
5101
|
-
* @name GetFundamentalsBySymbolData
|
|
5102
|
-
* @summary get fundamentals by symbol data
|
|
5103
|
-
* @request POST:/fundamentals
|
|
5104
|
-
* @secure
|
|
5105
|
-
*/
|
|
5106
|
-
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
5187
|
+
export class Fundamentals<HandleError extends boolean = boolean> {
|
|
5188
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5189
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5190
|
+
/**
|
|
5191
|
+
* @description get fundamentals by symbol data
|
|
5192
|
+
* @tags Fundamentals
|
|
5193
|
+
* @name GetFundamentalsBySymbolData
|
|
5194
|
+
* @summary get fundamentals by symbol data
|
|
5195
|
+
* @request POST:/fundamentals
|
|
5196
|
+
* @secure
|
|
5197
|
+
*/
|
|
5198
|
+
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
5107
5199
|
}
|
|
5108
5200
|
export class Funds<HandleError extends boolean = boolean> {
|
|
5109
5201
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5219,990 +5311,935 @@ export class Funds<HandleError extends boolean = boolean> {
|
|
|
5219
5311
|
Authorization?: string;
|
|
5220
5312
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
|
|
5221
5313
|
}
|
|
5222
|
-
export class
|
|
5314
|
+
export class StockScreener<HandleError extends boolean = boolean> {
|
|
5223
5315
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5224
5316
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5225
5317
|
/**
|
|
5226
|
-
* @description
|
|
5227
|
-
* @tags
|
|
5228
|
-
* @name
|
|
5229
|
-
* @summary
|
|
5230
|
-
* @request
|
|
5318
|
+
* @description data for visual heat map
|
|
5319
|
+
* @tags StockScreener
|
|
5320
|
+
* @name StockMarketHeatmap
|
|
5321
|
+
* @summary data for visual heat map
|
|
5322
|
+
* @request GET:/heatmaps
|
|
5231
5323
|
* @secure
|
|
5232
5324
|
*/
|
|
5233
|
-
|
|
5234
|
-
|
|
5235
|
-
|
|
5236
|
-
|
|
5237
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5325
|
+
stockMarketHeatmap(query?: {
|
|
5326
|
+
/** Name of symbol list to fetch details for. Empty is default */
|
|
5327
|
+
heatmap_name?: string;
|
|
5328
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
|
|
5238
5329
|
/**
|
|
5239
|
-
* @description
|
|
5240
|
-
* @tags
|
|
5241
|
-
* @name
|
|
5242
|
-
* @summary
|
|
5243
|
-
* @request POST:/
|
|
5330
|
+
* @description create or update heat map preset
|
|
5331
|
+
* @tags StockScreener
|
|
5332
|
+
* @name CreateStockMarketHeatmapPreset
|
|
5333
|
+
* @summary create or update heat map preset
|
|
5334
|
+
* @request POST:/heatmaps
|
|
5244
5335
|
* @secure
|
|
5245
5336
|
*/
|
|
5246
|
-
|
|
5337
|
+
createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5247
5338
|
/**
|
|
5248
|
-
* @description
|
|
5249
|
-
* @tags
|
|
5250
|
-
* @name
|
|
5251
|
-
* @summary get
|
|
5252
|
-
* @request
|
|
5339
|
+
* @description Sector and Industry Group performance
|
|
5340
|
+
* @tags StockScreener
|
|
5341
|
+
* @name IndustriesPerformance
|
|
5342
|
+
* @summary get industries performance
|
|
5343
|
+
* @request POST:/industries-performance
|
|
5253
5344
|
* @secure
|
|
5254
5345
|
*/
|
|
5255
|
-
|
|
5256
|
-
/** how many records to return. Max value is 50 */
|
|
5257
|
-
limit: number;
|
|
5258
|
-
/** how many records to skip */
|
|
5259
|
-
offset: number;
|
|
5260
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5261
|
-
/**
|
|
5262
|
-
* @description get ipo info by symbol
|
|
5263
|
-
* @tags Ipos
|
|
5264
|
-
* @name GetIpos
|
|
5265
|
-
* @summary get ipo info by symbol
|
|
5266
|
-
* @request GET:/ipos/{symbol}
|
|
5267
|
-
* @secure
|
|
5268
|
-
*/
|
|
5269
|
-
getIpos(symbol: string, query?: {
|
|
5270
|
-
/** load quotes */
|
|
5271
|
-
load_quotes?: boolean;
|
|
5272
|
-
/** statuses */
|
|
5273
|
-
statuses?: string[];
|
|
5274
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
|
|
5275
|
-
}
|
|
5276
|
-
export class Logos<HandleError extends boolean = boolean> {
|
|
5277
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5278
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5346
|
+
industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
|
|
5279
5347
|
/**
|
|
5280
|
-
* @description
|
|
5281
|
-
* @tags
|
|
5282
|
-
* @name
|
|
5283
|
-
* @summary
|
|
5284
|
-
* @request POST:/
|
|
5348
|
+
* @description filter stocks by params
|
|
5349
|
+
* @tags StockScreener
|
|
5350
|
+
* @name StockScreener
|
|
5351
|
+
* @summary filter stocks by params
|
|
5352
|
+
* @request POST:/stock-screener
|
|
5285
5353
|
* @secure
|
|
5286
5354
|
*/
|
|
5287
|
-
|
|
5355
|
+
stockScreener(filter: InsightStockScreenerV1Request, headers?: {
|
|
5356
|
+
/** Authorization */
|
|
5357
|
+
Authorization?: string;
|
|
5358
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
5288
5359
|
/**
|
|
5289
|
-
* @description
|
|
5290
|
-
* @tags
|
|
5291
|
-
* @name
|
|
5292
|
-
* @summary
|
|
5293
|
-
* @request
|
|
5360
|
+
* @description get screener presets
|
|
5361
|
+
* @tags StockScreener
|
|
5362
|
+
* @name GetScreenerPresets
|
|
5363
|
+
* @summary get screener presets
|
|
5364
|
+
* @request GET:/stock-screener/presets
|
|
5294
5365
|
* @secure
|
|
5295
5366
|
*/
|
|
5296
|
-
|
|
5367
|
+
getScreenerPresets(query: {
|
|
5368
|
+
/** how many records to return */
|
|
5369
|
+
limit: number;
|
|
5370
|
+
/** how many records to skip */
|
|
5371
|
+
offset: number;
|
|
5372
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
5297
5373
|
/**
|
|
5298
|
-
* @description
|
|
5299
|
-
* @tags
|
|
5300
|
-
* @name
|
|
5301
|
-
* @summary
|
|
5302
|
-
* @request
|
|
5374
|
+
* @description update screener preset
|
|
5375
|
+
* @tags StockScreener
|
|
5376
|
+
* @name UpdateScreenerPreset
|
|
5377
|
+
* @summary update screener preset
|
|
5378
|
+
* @request PUT:/stock-screener/presets
|
|
5303
5379
|
* @secure
|
|
5304
5380
|
*/
|
|
5305
|
-
|
|
5306
|
-
/** Company symbol */
|
|
5307
|
-
symbol: string;
|
|
5308
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError>>;
|
|
5381
|
+
updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5309
5382
|
/**
|
|
5310
|
-
* @description
|
|
5311
|
-
* @tags
|
|
5312
|
-
* @name
|
|
5313
|
-
* @summary
|
|
5314
|
-
* @request
|
|
5383
|
+
* @description create screener preset
|
|
5384
|
+
* @tags StockScreener
|
|
5385
|
+
* @name CreateOrScreenerPreset
|
|
5386
|
+
* @summary create screener preset
|
|
5387
|
+
* @request POST:/stock-screener/presets
|
|
5315
5388
|
* @secure
|
|
5316
5389
|
*/
|
|
5317
|
-
|
|
5318
|
-
/** Company symbol */
|
|
5319
|
-
symbol: string;
|
|
5320
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5390
|
+
createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5321
5391
|
/**
|
|
5322
|
-
* @description
|
|
5323
|
-
* @tags
|
|
5324
|
-
* @name
|
|
5325
|
-
* @summary
|
|
5326
|
-
* @request
|
|
5392
|
+
* @description remove screener preset
|
|
5393
|
+
* @tags StockScreener
|
|
5394
|
+
* @name RemoveScreenerPreset
|
|
5395
|
+
* @summary remove screener preset
|
|
5396
|
+
* @request DELETE:/stock-screener/presets
|
|
5327
5397
|
* @secure
|
|
5328
5398
|
*/
|
|
5329
|
-
|
|
5330
|
-
/** Company symbol */
|
|
5331
|
-
symbol: string;
|
|
5332
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5399
|
+
removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5333
5400
|
/**
|
|
5334
|
-
* @description
|
|
5335
|
-
* @tags
|
|
5336
|
-
* @name
|
|
5337
|
-
* @summary
|
|
5338
|
-
* @request POST:/
|
|
5401
|
+
* @description get top symbols
|
|
5402
|
+
* @tags StockScreener
|
|
5403
|
+
* @name GetTopSymbols
|
|
5404
|
+
* @summary get top symbols
|
|
5405
|
+
* @request POST:/stock-screener/top
|
|
5339
5406
|
* @secure
|
|
5340
5407
|
*/
|
|
5341
|
-
|
|
5408
|
+
getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
5409
|
+
}
|
|
5410
|
+
export class Quotes<HandleError extends boolean = boolean> {
|
|
5411
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5412
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5342
5413
|
/**
|
|
5343
|
-
* @description
|
|
5344
|
-
* @tags
|
|
5345
|
-
* @name
|
|
5346
|
-
* @summary Get
|
|
5347
|
-
* @request
|
|
5414
|
+
* @description Get single historical quote
|
|
5415
|
+
* @tags Quotes
|
|
5416
|
+
* @name GitHistoricalQuote
|
|
5417
|
+
* @summary Get single historical quote
|
|
5418
|
+
* @request GET:/historical/quote
|
|
5348
5419
|
* @secure
|
|
5349
5420
|
*/
|
|
5350
|
-
|
|
5421
|
+
gitHistoricalQuote(query: {
|
|
5422
|
+
/** Symbol */
|
|
5423
|
+
symbol: string;
|
|
5424
|
+
/** Date */
|
|
5425
|
+
date: string;
|
|
5426
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
|
|
5351
5427
|
/**
|
|
5352
|
-
* @description
|
|
5353
|
-
* @tags
|
|
5354
|
-
* @name
|
|
5355
|
-
* @summary Get
|
|
5356
|
-
* @request
|
|
5428
|
+
* @description get quote history by symbol
|
|
5429
|
+
* @tags Quotes
|
|
5430
|
+
* @name GitQuoteHistory
|
|
5431
|
+
* @summary Get quote history
|
|
5432
|
+
* @request POST:/quote-history
|
|
5357
5433
|
* @secure
|
|
5358
5434
|
*/
|
|
5359
|
-
|
|
5360
|
-
/** Company symbol */
|
|
5361
|
-
symbol: string;
|
|
5362
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
|
|
5435
|
+
gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
|
|
5363
5436
|
/**
|
|
5364
|
-
* @description Returns
|
|
5365
|
-
* @tags
|
|
5366
|
-
* @name
|
|
5367
|
-
* @summary Get
|
|
5368
|
-
* @request GET:/
|
|
5437
|
+
* @description Returns a list of quotes equity info for specified symbols.
|
|
5438
|
+
* @tags Quotes
|
|
5439
|
+
* @name GetQuotesEquityData
|
|
5440
|
+
* @summary Get Quotes Equity data
|
|
5441
|
+
* @request GET:/quotes/equity
|
|
5369
5442
|
* @secure
|
|
5370
5443
|
*/
|
|
5371
|
-
|
|
5372
|
-
/**
|
|
5373
|
-
|
|
5374
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5444
|
+
getQuotesEquityData(query: {
|
|
5445
|
+
/** Comma separated symbols */
|
|
5446
|
+
symbols: string;
|
|
5447
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
|
|
5375
5448
|
}
|
|
5376
|
-
export class
|
|
5449
|
+
export class Intraday<HandleError extends boolean = boolean> {
|
|
5377
5450
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5378
5451
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5379
5452
|
/**
|
|
5380
|
-
* @description
|
|
5381
|
-
* @tags
|
|
5382
|
-
* @name
|
|
5383
|
-
* @summary
|
|
5384
|
-
* @request POST:/
|
|
5385
|
-
* @secure
|
|
5386
|
-
*/
|
|
5387
|
-
getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
|
|
5388
|
-
/**
|
|
5389
|
-
* @description get todays market hours
|
|
5390
|
-
* @tags MarketDates
|
|
5391
|
-
* @name GetTodaysMarketHours
|
|
5392
|
-
* @summary get todays market hours
|
|
5393
|
-
* @request GET:/market-dates/today
|
|
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
|
|
5394
5458
|
* @secure
|
|
5395
5459
|
*/
|
|
5396
|
-
|
|
5397
|
-
/** Market */
|
|
5398
|
-
market: string;
|
|
5399
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
|
|
5460
|
+
intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
|
|
5400
5461
|
}
|
|
5401
|
-
export class
|
|
5462
|
+
export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
5402
5463
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5403
5464
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5404
5465
|
/**
|
|
5405
|
-
* @description
|
|
5406
|
-
* @tags
|
|
5407
|
-
* @name
|
|
5408
|
-
* @summary
|
|
5409
|
-
* @request
|
|
5466
|
+
* @description Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
|
|
5467
|
+
* @tags PreIPOCompanies
|
|
5468
|
+
* @name MonarkOghlcDataForSymbol
|
|
5469
|
+
* @summary Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
|
|
5470
|
+
* @request GET:/ipos/market-data/ohlc/{symbol}
|
|
5410
5471
|
* @secure
|
|
5411
5472
|
*/
|
|
5412
|
-
|
|
5473
|
+
monarkOghlcDataForSymbol(symbol: string, query?: {
|
|
5474
|
+
/** Start time for the OHLC data in ISO 8601 format YYYY-MM-DD */
|
|
5475
|
+
from?: string;
|
|
5476
|
+
/** End time for the OHLC data in ISO 8601 format YYYY-MM-DD */
|
|
5477
|
+
to?: string;
|
|
5478
|
+
/** Time interval for buckets: 1d (day), 1w (week), 1mo (month), 3mo (3 months). Default is 1d. */
|
|
5479
|
+
interval?: string;
|
|
5480
|
+
/** Limit the number of OHLC data points returned. Default is 100. */
|
|
5481
|
+
limit?: number;
|
|
5482
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<{
|
|
5483
|
+
close?: number;
|
|
5484
|
+
high?: number;
|
|
5485
|
+
low?: number;
|
|
5486
|
+
open?: number;
|
|
5487
|
+
time?: string;
|
|
5488
|
+
volume?: number;
|
|
5489
|
+
}[], HandleError>>;
|
|
5413
5490
|
/**
|
|
5414
|
-
* @description
|
|
5415
|
-
* @tags
|
|
5416
|
-
* @name
|
|
5417
|
-
* @summary
|
|
5418
|
-
* @request
|
|
5491
|
+
* @description Retrieves all symbols available in the market data
|
|
5492
|
+
* @tags PreIPOCompanies
|
|
5493
|
+
* @name MonarkAllAvailableSymbols
|
|
5494
|
+
* @summary Retrieves all symbols available in the market data
|
|
5495
|
+
* @request GET:/ipos/market-data/symbols
|
|
5419
5496
|
* @secure
|
|
5420
5497
|
*/
|
|
5421
|
-
|
|
5498
|
+
monarkAllAvailableSymbols(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5422
5499
|
/**
|
|
5423
|
-
* @description
|
|
5424
|
-
* @tags
|
|
5425
|
-
* @name
|
|
5426
|
-
* @summary
|
|
5427
|
-
* @request GET:/
|
|
5500
|
+
* @description get pre ipo companies Avaliable categories: on-demand business-video reverse-etl modern-data-stack video-api global-payroll banking-as-a-service ultrafast-delivery online-grocery website-builder fintech b2b venture-capital ecommerce creator-economy productivity real-estate private-markets-exchanges fpa vertical-saas card-issuing connected-fitness gig-marketplaces cms soc-2 analytics cap-table-management contractor-payroll social-media design online-whiteboard conversational-marketing expense-management stock-option-financing customer-onboarding crypto help-desk payroll documents databases mortgage-lending crypto-exchange marketing-automation payments operations checkout cybersecurity messaging investing marketplaces climate-tech robotics data-security online-education gaming universal-api automation biotechnology contact-center defense machine-learning logistics prefab-tech materials telehealth b2c alternative-proteins b2b-marketplaces wealth-management web3 neobank managed-marketplaces plg-crm jamstack public-safety background-checks identity-verification construction home-services sales blockchain-developer-platform space financial-data-aggregation ai writing-assistant autonomous-driving 401k-provider vector-databases ai-models devtools payroll-api internal-tools mlops bookkeeping cloud-infrastructure data-backups personal-finance ai-frameworks generative-ai cloud-gpus micromobility ai-avatars ai-chips life-sciences partnerships wearables fitness-tracking ai-search ai-medical-scribes networking quantum-computing code-editors
|
|
5501
|
+
* @tags PreIPOCompanies
|
|
5502
|
+
* @name GetPreIpoCompanies
|
|
5503
|
+
* @summary get pre ipo companies
|
|
5504
|
+
* @request GET:/ipos/pre-ipo-companies
|
|
5428
5505
|
* @secure
|
|
5429
5506
|
*/
|
|
5430
|
-
|
|
5431
|
-
/**
|
|
5507
|
+
getPreIpoCompanies(query: {
|
|
5508
|
+
/** search by company name */
|
|
5509
|
+
name?: string;
|
|
5510
|
+
/** search by categories */
|
|
5511
|
+
categories?: string;
|
|
5512
|
+
/** how many records to return. Max value is 50 */
|
|
5432
5513
|
limit: number;
|
|
5433
|
-
/**
|
|
5514
|
+
/** how many records to skip */
|
|
5434
5515
|
offset: number;
|
|
5435
|
-
/**
|
|
5436
|
-
|
|
5437
|
-
/**
|
|
5438
|
-
|
|
5439
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5440
|
-
/**
|
|
5441
|
-
* @description Update featured articles
|
|
5442
|
-
* @tags News
|
|
5443
|
-
* @name UpdateFeaturedArticles
|
|
5444
|
-
* @summary Update featured articles
|
|
5445
|
-
* @request PUT:/news/featured-articles
|
|
5446
|
-
* @secure
|
|
5447
|
-
*/
|
|
5448
|
-
updateFeaturedArticles(input: InsightUpdateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5449
|
-
/**
|
|
5450
|
-
* @description Create featured articles
|
|
5451
|
-
* @tags News
|
|
5452
|
-
* @name CreateFeaturedArticles
|
|
5453
|
-
* @summary Create featured articles
|
|
5454
|
-
* @request POST:/news/featured-articles
|
|
5455
|
-
* @secure
|
|
5456
|
-
*/
|
|
5457
|
-
createFeaturedArticles(input: InsightCreateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5516
|
+
/** sort field */
|
|
5517
|
+
order_field?: InsightGetPreIpoCompaniesParamsOrderFieldEnum;
|
|
5518
|
+
/** sort direction */
|
|
5519
|
+
order_direction?: InsightGetPreIpoCompaniesParamsOrderDirectionEnum;
|
|
5520
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
|
|
5458
5521
|
/**
|
|
5459
|
-
* @description
|
|
5460
|
-
* @tags
|
|
5461
|
-
* @name
|
|
5462
|
-
* @summary
|
|
5463
|
-
* @request GET:/
|
|
5522
|
+
* @description get pre ipo company by id
|
|
5523
|
+
* @tags PreIPOCompanies
|
|
5524
|
+
* @name GetPreIpoCompaniesById
|
|
5525
|
+
* @summary get pre ipo company by id
|
|
5526
|
+
* @request GET:/ipos/pre-ipo-companies/{id}
|
|
5527
|
+
* @originalName getPreIpoCompanies
|
|
5528
|
+
* @duplicate
|
|
5464
5529
|
* @secure
|
|
5465
5530
|
*/
|
|
5466
|
-
|
|
5531
|
+
getPreIpoCompaniesById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompany, HandleError>>;
|
|
5467
5532
|
/**
|
|
5468
|
-
* @description
|
|
5469
|
-
* @tags
|
|
5470
|
-
* @name
|
|
5471
|
-
* @summary
|
|
5472
|
-
* @request
|
|
5533
|
+
* @description get pre ipo company funding rounds
|
|
5534
|
+
* @tags PreIPOCompanies
|
|
5535
|
+
* @name GetPreIpoCompanyFundingRounds
|
|
5536
|
+
* @summary get pre ipo company funding rounds
|
|
5537
|
+
* @request GET:/ipos/pre-ipo-company-funding-rounds
|
|
5473
5538
|
* @secure
|
|
5474
5539
|
*/
|
|
5475
|
-
|
|
5540
|
+
getPreIpoCompanyFundingRounds(query: {
|
|
5541
|
+
/** company id */
|
|
5542
|
+
pre_ipo_company_id?: string;
|
|
5543
|
+
/** search by round name */
|
|
5544
|
+
round_name?: string;
|
|
5545
|
+
/** how many records to return. Max value is 50 */
|
|
5546
|
+
limit: number;
|
|
5547
|
+
/** how many records to skip */
|
|
5548
|
+
offset: number;
|
|
5549
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyFundingRoundsResponse, HandleError>>;
|
|
5476
5550
|
/**
|
|
5477
|
-
* @description
|
|
5478
|
-
* @tags
|
|
5479
|
-
* @name
|
|
5480
|
-
* @summary
|
|
5481
|
-
* @request GET:/
|
|
5551
|
+
* @description get pre ipo company funding round by id
|
|
5552
|
+
* @tags PreIPOCompanies
|
|
5553
|
+
* @name GetPreIpoCompanyFundingRoundsById
|
|
5554
|
+
* @summary get pre ipo company funding round by id
|
|
5555
|
+
* @request GET:/ipos/pre-ipo-company-funding-rounds/{id}
|
|
5556
|
+
* @originalName getPreIpoCompanyFundingRounds
|
|
5557
|
+
* @duplicate
|
|
5482
5558
|
* @secure
|
|
5483
5559
|
*/
|
|
5484
|
-
|
|
5560
|
+
getPreIpoCompanyFundingRoundsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyFundingRound, HandleError>>;
|
|
5485
5561
|
/**
|
|
5486
|
-
* @description
|
|
5487
|
-
* @tags
|
|
5488
|
-
* @name
|
|
5489
|
-
* @summary
|
|
5490
|
-
* @request
|
|
5562
|
+
* @description get pre ipo company investments
|
|
5563
|
+
* @tags PreIPOCompanies
|
|
5564
|
+
* @name GetPreIpoCompanyInvestments
|
|
5565
|
+
* @summary get pre ipo company investments
|
|
5566
|
+
* @request GET:/ipos/pre-ipo-company-investments
|
|
5491
5567
|
* @secure
|
|
5492
5568
|
*/
|
|
5493
|
-
|
|
5569
|
+
getPreIpoCompanyInvestments(query: {
|
|
5570
|
+
/** company id */
|
|
5571
|
+
pre_ipo_company_id?: string;
|
|
5572
|
+
/** company name */
|
|
5573
|
+
company_name?: string;
|
|
5574
|
+
/** how many records to return. Max value is 50 */
|
|
5575
|
+
limit: number;
|
|
5576
|
+
/** how many records to skip */
|
|
5577
|
+
offset: number;
|
|
5578
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyInvestmentsResponse, HandleError>>;
|
|
5494
5579
|
/**
|
|
5495
|
-
* @description
|
|
5496
|
-
* @tags
|
|
5497
|
-
* @name
|
|
5498
|
-
* @summary
|
|
5499
|
-
* @request
|
|
5580
|
+
* @description get pre ipo company investment by id
|
|
5581
|
+
* @tags PreIPOCompanies
|
|
5582
|
+
* @name GetPreIpoCompanyInvestmentsById
|
|
5583
|
+
* @summary get pre ipo company investment by id
|
|
5584
|
+
* @request GET:/ipos/pre-ipo-company-investments/{id}
|
|
5585
|
+
* @originalName getPreIpoCompanyInvestments
|
|
5586
|
+
* @duplicate
|
|
5500
5587
|
* @secure
|
|
5501
5588
|
*/
|
|
5502
|
-
|
|
5589
|
+
getPreIpoCompanyInvestmentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyInvestment, HandleError>>;
|
|
5503
5590
|
/**
|
|
5504
|
-
* @description
|
|
5505
|
-
* @tags
|
|
5506
|
-
* @name
|
|
5507
|
-
* @summary
|
|
5508
|
-
* @request GET:/news
|
|
5591
|
+
* @description get pre ipo company news
|
|
5592
|
+
* @tags PreIPOCompanies
|
|
5593
|
+
* @name GetPreIpoCompanyNews
|
|
5594
|
+
* @summary get pre ipo company news
|
|
5595
|
+
* @request GET:/ipos/pre-ipo-company-news
|
|
5509
5596
|
* @secure
|
|
5510
5597
|
*/
|
|
5511
|
-
|
|
5512
|
-
/**
|
|
5513
|
-
|
|
5514
|
-
/**
|
|
5515
|
-
|
|
5516
|
-
/** Symbol */
|
|
5517
|
-
symbol?: string;
|
|
5598
|
+
getPreIpoCompanyNews(query: {
|
|
5599
|
+
/** company id */
|
|
5600
|
+
pre_ipo_company_id?: string;
|
|
5601
|
+
/** search by headline */
|
|
5602
|
+
headline?: string;
|
|
5518
5603
|
/** how many records to return. Max value is 50 */
|
|
5519
5604
|
limit: number;
|
|
5520
5605
|
/** how many records to skip */
|
|
5521
5606
|
offset: number;
|
|
5522
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5607
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyNewsResponse, HandleError>>;
|
|
5523
5608
|
/**
|
|
5524
|
-
* @description
|
|
5525
|
-
* @tags
|
|
5526
|
-
* @name
|
|
5527
|
-
* @summary
|
|
5528
|
-
* @request GET:/news/
|
|
5609
|
+
* @description get pre ipo company news by id
|
|
5610
|
+
* @tags PreIPOCompanies
|
|
5611
|
+
* @name GetPreIpoCompanyNewsById
|
|
5612
|
+
* @summary get pre ipo company news by id
|
|
5613
|
+
* @request GET:/ipos/pre-ipo-company-news/{id}
|
|
5614
|
+
* @originalName getPreIpoCompanyNews
|
|
5615
|
+
* @duplicate
|
|
5529
5616
|
* @secure
|
|
5530
5617
|
*/
|
|
5531
|
-
|
|
5532
|
-
/** Limit */
|
|
5533
|
-
limit?: number;
|
|
5534
|
-
/** Offset */
|
|
5535
|
-
offset?: number;
|
|
5536
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5618
|
+
getPreIpoCompanyNewsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyNews, HandleError>>;
|
|
5537
5619
|
/**
|
|
5538
|
-
* @description
|
|
5539
|
-
* @tags
|
|
5540
|
-
* @name
|
|
5541
|
-
* @summary
|
|
5542
|
-
* @request
|
|
5620
|
+
* @description get pre ipo company research documents
|
|
5621
|
+
* @tags PreIPOCompanies
|
|
5622
|
+
* @name GetPreIpoCompanyResearchDocuments
|
|
5623
|
+
* @summary get pre ipo company research documents
|
|
5624
|
+
* @request GET:/ipos/pre-ipo-company-research-documents
|
|
5543
5625
|
* @secure
|
|
5544
5626
|
*/
|
|
5545
|
-
|
|
5546
|
-
|
|
5547
|
-
|
|
5548
|
-
|
|
5549
|
-
|
|
5627
|
+
getPreIpoCompanyResearchDocuments(query: {
|
|
5628
|
+
/** company id */
|
|
5629
|
+
pre_ipo_company_id?: string;
|
|
5630
|
+
/** search by title */
|
|
5631
|
+
title?: string;
|
|
5632
|
+
/** how many records to return. Max value is 50 */
|
|
5633
|
+
limit: number;
|
|
5634
|
+
/** how many records to skip */
|
|
5635
|
+
offset: number;
|
|
5636
|
+
/** search by research type */
|
|
5637
|
+
research_type?: InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum;
|
|
5638
|
+
/** search by relation */
|
|
5639
|
+
relation?: InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum;
|
|
5640
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError>>;
|
|
5550
5641
|
/**
|
|
5551
|
-
* @description
|
|
5552
|
-
* @tags
|
|
5553
|
-
* @name
|
|
5554
|
-
* @summary
|
|
5555
|
-
* @request
|
|
5642
|
+
* @description get pre ipo company research document by id
|
|
5643
|
+
* @tags PreIPOCompanies
|
|
5644
|
+
* @name GetPreIpoCompanyResearchDocumentsById
|
|
5645
|
+
* @summary get pre ipo company research document by id
|
|
5646
|
+
* @request GET:/ipos/pre-ipo-company-research-documents/{id}
|
|
5647
|
+
* @originalName getPreIpoCompanyResearchDocuments
|
|
5648
|
+
* @duplicate
|
|
5556
5649
|
* @secure
|
|
5557
5650
|
*/
|
|
5558
|
-
|
|
5651
|
+
getPreIpoCompanyResearchDocumentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyResearchDocument, HandleError>>;
|
|
5559
5652
|
/**
|
|
5560
|
-
* @description
|
|
5561
|
-
* @tags
|
|
5562
|
-
* @name
|
|
5563
|
-
* @summary
|
|
5564
|
-
* @request
|
|
5653
|
+
* @description get pre ipo company spvs with investor id
|
|
5654
|
+
* @tags PreIPOCompanies
|
|
5655
|
+
* @name GetInvestor
|
|
5656
|
+
* @summary get pre ipo company spvs with investor id
|
|
5657
|
+
* @request GET:/ipos/pre-ipo-company-spv/investor/{investor_id}
|
|
5565
5658
|
* @secure
|
|
5566
5659
|
*/
|
|
5567
|
-
|
|
5568
|
-
|
|
5569
|
-
|
|
5570
|
-
|
|
5571
|
-
|
|
5660
|
+
getInvestor(investorId: string, query: {
|
|
5661
|
+
/** search by monark stage */
|
|
5662
|
+
monark_stage?: InsightGetInvestorParamsMonarkStageEnum;
|
|
5663
|
+
/** Optional param to filter returned spv's based on the exemptions claimed */
|
|
5664
|
+
exemptions_claimed?: string[];
|
|
5665
|
+
/** Optional param to filter returned spv's based on the name */
|
|
5666
|
+
name_filter?: string;
|
|
5667
|
+
/** investment id */
|
|
5668
|
+
pre_ipo_company_id?: string;
|
|
5669
|
+
/** investment id */
|
|
5670
|
+
pre_ipo_company_investment_id?: string;
|
|
5671
|
+
/** page number */
|
|
5672
|
+
page: number;
|
|
5673
|
+
/** page size */
|
|
5674
|
+
page_size: number;
|
|
5675
|
+
/** sort direction */
|
|
5676
|
+
sort_order?: InsightGetInvestorParamsSortOrderEnum;
|
|
5677
|
+
/** sort field */
|
|
5678
|
+
sort_by?: InsightGetInvestorParamsSortByEnum;
|
|
5679
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsWithInvestorIDResponse, HandleError>>;
|
|
5572
5680
|
/**
|
|
5573
|
-
* @description get
|
|
5574
|
-
* @tags
|
|
5575
|
-
* @name
|
|
5576
|
-
* @summary get
|
|
5577
|
-
* @request
|
|
5681
|
+
* @description get pre ipo company spv by id with investor id
|
|
5682
|
+
* @tags PreIPOCompanies
|
|
5683
|
+
* @name GetInvestorByIdAndInvestorId
|
|
5684
|
+
* @summary get pre ipo company spv by id with investor id
|
|
5685
|
+
* @request GET:/ipos/pre-ipo-company-spv/{id}/investor/{investor_id}
|
|
5686
|
+
* @originalName getInvestor
|
|
5687
|
+
* @duplicate
|
|
5578
5688
|
* @secure
|
|
5579
5689
|
*/
|
|
5580
|
-
|
|
5690
|
+
getInvestorByIdAndInvestorId(id: string, investorId: string, query?: {
|
|
5691
|
+
/** default is false, if true documents will be included in the response */
|
|
5692
|
+
include_documents?: boolean;
|
|
5693
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetProIPOCompabySPVWithInvestorIDResponse, HandleError>>;
|
|
5581
5694
|
/**
|
|
5582
|
-
* @description get
|
|
5583
|
-
* @tags
|
|
5584
|
-
* @name
|
|
5585
|
-
* @summary get
|
|
5586
|
-
* @request
|
|
5695
|
+
* @description get pre ipo company spvs
|
|
5696
|
+
* @tags PreIPOCompanies
|
|
5697
|
+
* @name GetPreIpoCompanySpvs
|
|
5698
|
+
* @summary get pre ipo company spvs
|
|
5699
|
+
* @request GET:/ipos/pre-ipo-company-spvs
|
|
5587
5700
|
* @secure
|
|
5588
5701
|
*/
|
|
5589
|
-
|
|
5590
|
-
|
|
5591
|
-
|
|
5592
|
-
|
|
5593
|
-
|
|
5594
|
-
|
|
5595
|
-
|
|
5596
|
-
|
|
5597
|
-
|
|
5598
|
-
|
|
5599
|
-
|
|
5702
|
+
getPreIpoCompanySpvs(query: {
|
|
5703
|
+
/** company id */
|
|
5704
|
+
pre_ipo_company_id?: string;
|
|
5705
|
+
/** investment id */
|
|
5706
|
+
investment_id?: string;
|
|
5707
|
+
/** search by name */
|
|
5708
|
+
name?: string;
|
|
5709
|
+
/** search by company name */
|
|
5710
|
+
company_name?: string;
|
|
5711
|
+
/** how many records to return. Max value is 50 */
|
|
5712
|
+
limit: number;
|
|
5713
|
+
/** how many records to skip */
|
|
5714
|
+
offset: number;
|
|
5715
|
+
/** search by monark stage */
|
|
5716
|
+
monark_stage?: InsightGetPreIpoCompanySpvsParamsMonarkStageEnum;
|
|
5717
|
+
/** sort direction */
|
|
5718
|
+
direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
|
|
5719
|
+
/** sort field */
|
|
5720
|
+
field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
|
|
5721
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
|
|
5722
|
+
/**
|
|
5723
|
+
* @description get pre ipo company spv by id
|
|
5724
|
+
* @tags PreIPOCompanies
|
|
5725
|
+
* @name GetPreIpoCompanySpvsById
|
|
5726
|
+
* @summary get pre ipo company spv by id
|
|
5727
|
+
* @request GET:/ipos/pre-ipo-company-spvs/{id}
|
|
5728
|
+
* @originalName getPreIpoCompanySpvs
|
|
5729
|
+
* @duplicate
|
|
5600
5730
|
* @secure
|
|
5601
5731
|
*/
|
|
5602
|
-
|
|
5732
|
+
getPreIpoCompanySpvsById(id: string, query?: {
|
|
5733
|
+
/** default is false, if true documents will be included in the response */
|
|
5734
|
+
include_documents?: boolean;
|
|
5735
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
|
|
5736
|
+
}
|
|
5737
|
+
export class Ipos<HandleError extends boolean = boolean> {
|
|
5738
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5739
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5603
5740
|
/**
|
|
5604
|
-
* @description
|
|
5605
|
-
* @tags
|
|
5606
|
-
* @name
|
|
5607
|
-
* @summary
|
|
5608
|
-
* @request POST:/
|
|
5741
|
+
* @description get recent ipos info
|
|
5742
|
+
* @tags Ipos
|
|
5743
|
+
* @name PostRecent
|
|
5744
|
+
* @summary get recent ipos info
|
|
5745
|
+
* @request POST:/ipos/recent
|
|
5609
5746
|
* @secure
|
|
5610
5747
|
*/
|
|
5611
|
-
|
|
5748
|
+
postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5612
5749
|
/**
|
|
5613
|
-
* @description
|
|
5614
|
-
* @tags
|
|
5615
|
-
* @name
|
|
5616
|
-
* @summary
|
|
5617
|
-
* @request
|
|
5750
|
+
* @description get upcoming ipos info
|
|
5751
|
+
* @tags Ipos
|
|
5752
|
+
* @name GetUpcoming
|
|
5753
|
+
* @summary get upcoming ipos info
|
|
5754
|
+
* @request GET:/ipos/upcoming
|
|
5618
5755
|
* @secure
|
|
5619
5756
|
*/
|
|
5620
|
-
|
|
5757
|
+
getUpcoming(query: {
|
|
5758
|
+
/** how many records to return. Max value is 50 */
|
|
5759
|
+
limit: number;
|
|
5760
|
+
/** how many records to skip */
|
|
5761
|
+
offset: number;
|
|
5762
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5621
5763
|
/**
|
|
5622
|
-
* @description
|
|
5623
|
-
* @tags
|
|
5624
|
-
* @name
|
|
5625
|
-
* @summary
|
|
5626
|
-
* @request
|
|
5764
|
+
* @description get ipo info by symbol
|
|
5765
|
+
* @tags Ipos
|
|
5766
|
+
* @name GetIpos
|
|
5767
|
+
* @summary get ipo info by symbol
|
|
5768
|
+
* @request GET:/ipos/{symbol}
|
|
5627
5769
|
* @secure
|
|
5628
5770
|
*/
|
|
5629
|
-
|
|
5771
|
+
getIpos(symbol: string, query?: {
|
|
5772
|
+
/** load quotes */
|
|
5773
|
+
load_quotes?: boolean;
|
|
5774
|
+
/** statuses */
|
|
5775
|
+
statuses?: string[];
|
|
5776
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
|
|
5777
|
+
}
|
|
5778
|
+
export class Logos<HandleError extends boolean = boolean> {
|
|
5779
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5780
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5630
5781
|
/**
|
|
5631
|
-
* @description Returns
|
|
5632
|
-
* @tags
|
|
5633
|
-
* @name
|
|
5634
|
-
* @summary Get
|
|
5635
|
-
* @request POST:/
|
|
5782
|
+
* @description Returns converted logo for crypto symbol
|
|
5783
|
+
* @tags Logos
|
|
5784
|
+
* @name LogosConvertedCryptoSymbolLogo
|
|
5785
|
+
* @summary Get converted logo for crypto symbol
|
|
5786
|
+
* @request POST:/logos/converted-crypto-symbol-logo
|
|
5636
5787
|
* @secure
|
|
5637
5788
|
*/
|
|
5638
|
-
|
|
5789
|
+
logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5639
5790
|
/**
|
|
5640
|
-
* @description Returns
|
|
5641
|
-
* @tags
|
|
5642
|
-
* @name
|
|
5643
|
-
* @summary
|
|
5644
|
-
* @request POST:/
|
|
5791
|
+
* @description Returns converted logo for symbol
|
|
5792
|
+
* @tags Logos
|
|
5793
|
+
* @name LogosConvertedSymbolLogo
|
|
5794
|
+
* @summary Get converted logo for symbol
|
|
5795
|
+
* @request POST:/logos/converted-symbol-logo
|
|
5645
5796
|
* @secure
|
|
5646
5797
|
*/
|
|
5647
|
-
|
|
5648
|
-
}
|
|
5649
|
-
export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
5650
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5651
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5798
|
+
logosConvertedSymbolLogo(filter: InsightSymbolLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5652
5799
|
/**
|
|
5653
|
-
* @description
|
|
5654
|
-
* @tags
|
|
5655
|
-
* @name
|
|
5656
|
-
* @summary
|
|
5657
|
-
* @request GET:/
|
|
5800
|
+
* @description Returns logo for crypto symbol
|
|
5801
|
+
* @tags Logos
|
|
5802
|
+
* @name LogosCryptoSymbolLogo
|
|
5803
|
+
* @summary Get logo for crypto symbol
|
|
5804
|
+
* @request GET:/logos/crypto-symbol-logo
|
|
5658
5805
|
* @secure
|
|
5659
5806
|
*/
|
|
5660
|
-
|
|
5661
|
-
/**
|
|
5662
|
-
|
|
5663
|
-
|
|
5664
|
-
to?: string;
|
|
5665
|
-
/** Time interval for buckets: 1d (day), 1w (week), 1mo (month), 3mo (3 months). Default is 1d. */
|
|
5666
|
-
interval?: string;
|
|
5667
|
-
/** Limit the number of OHLC data points returned. Default is 100. */
|
|
5668
|
-
limit?: number;
|
|
5669
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<{
|
|
5670
|
-
close?: number;
|
|
5671
|
-
high?: number;
|
|
5672
|
-
low?: number;
|
|
5673
|
-
open?: number;
|
|
5674
|
-
time?: string;
|
|
5675
|
-
volume?: number;
|
|
5676
|
-
}[], HandleError>>;
|
|
5807
|
+
logosCryptoSymbolLogo(query: {
|
|
5808
|
+
/** Company symbol */
|
|
5809
|
+
symbol: string;
|
|
5810
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError>>;
|
|
5677
5811
|
/**
|
|
5678
|
-
* @description
|
|
5679
|
-
* @tags
|
|
5680
|
-
* @name
|
|
5681
|
-
* @summary
|
|
5682
|
-
* @request GET:/
|
|
5812
|
+
* @description Returns direct logo for crypto symbol
|
|
5813
|
+
* @tags Logos
|
|
5814
|
+
* @name LogosDirectCryptoSymbolLogo
|
|
5815
|
+
* @summary Get direct logo for crypto symbol
|
|
5816
|
+
* @request GET:/logos/direct-crypto-symbol-logo
|
|
5683
5817
|
* @secure
|
|
5684
5818
|
*/
|
|
5685
|
-
|
|
5819
|
+
logosDirectCryptoSymbolLogo(query: {
|
|
5820
|
+
/** Company symbol */
|
|
5821
|
+
symbol: string;
|
|
5822
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5686
5823
|
/**
|
|
5687
|
-
* @description
|
|
5688
|
-
* @tags
|
|
5689
|
-
* @name
|
|
5690
|
-
* @summary
|
|
5691
|
-
* @request GET:/
|
|
5824
|
+
* @description Returns direct logo for symbol
|
|
5825
|
+
* @tags Logos
|
|
5826
|
+
* @name LogosDirectSymbolLogo
|
|
5827
|
+
* @summary Get direct logo for symbol
|
|
5828
|
+
* @request GET:/logos/direct-symbol-logo
|
|
5692
5829
|
* @secure
|
|
5693
5830
|
*/
|
|
5694
|
-
|
|
5695
|
-
/**
|
|
5696
|
-
|
|
5697
|
-
|
|
5698
|
-
categories?: string;
|
|
5699
|
-
/** how many records to return. Max value is 50 */
|
|
5700
|
-
limit: number;
|
|
5701
|
-
/** how many records to skip */
|
|
5702
|
-
offset: number;
|
|
5703
|
-
/** sort field */
|
|
5704
|
-
order_field?: InsightGetPreIpoCompaniesParamsOrderFieldEnum;
|
|
5705
|
-
/** sort direction */
|
|
5706
|
-
order_direction?: InsightGetPreIpoCompaniesParamsOrderDirectionEnum;
|
|
5707
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
|
|
5831
|
+
logosDirectSymbolLogo(query: {
|
|
5832
|
+
/** Company symbol */
|
|
5833
|
+
symbol: string;
|
|
5834
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5708
5835
|
/**
|
|
5709
|
-
* @description
|
|
5710
|
-
* @tags
|
|
5711
|
-
* @name
|
|
5712
|
-
* @summary
|
|
5713
|
-
* @request
|
|
5714
|
-
* @originalName getPreIpoCompanies
|
|
5715
|
-
* @duplicate
|
|
5836
|
+
* @description Returns logos for multiple symbols
|
|
5837
|
+
* @tags Logos
|
|
5838
|
+
* @name LogosMultipleCryptoSymbolLogo
|
|
5839
|
+
* @summary Get logos for multiple symbols
|
|
5840
|
+
* @request POST:/logos/multiple-crypto-symbol-logo
|
|
5716
5841
|
* @secure
|
|
5717
5842
|
*/
|
|
5718
|
-
|
|
5843
|
+
logosMultipleCryptoSymbolLogo(filter: InsightMultipleCryptoLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse[], HandleError>>;
|
|
5719
5844
|
/**
|
|
5720
|
-
* @description
|
|
5721
|
-
* @tags
|
|
5722
|
-
* @name
|
|
5723
|
-
* @summary
|
|
5724
|
-
* @request
|
|
5845
|
+
* @description Returns logos for multiple symbol
|
|
5846
|
+
* @tags Logos
|
|
5847
|
+
* @name LogosMultipleSymbolLogos
|
|
5848
|
+
* @summary Get logos for multiple symbols
|
|
5849
|
+
* @request POST:/logos/multiple-symbol-logos
|
|
5725
5850
|
* @secure
|
|
5726
5851
|
*/
|
|
5727
|
-
|
|
5728
|
-
/** company id */
|
|
5729
|
-
pre_ipo_company_id?: string;
|
|
5730
|
-
/** search by round name */
|
|
5731
|
-
round_name?: string;
|
|
5732
|
-
/** how many records to return. Max value is 50 */
|
|
5733
|
-
limit: number;
|
|
5734
|
-
/** how many records to skip */
|
|
5735
|
-
offset: number;
|
|
5736
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyFundingRoundsResponse, HandleError>>;
|
|
5852
|
+
logosMultipleSymbolLogos(filter: InsightMultipleSymbolLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse[], HandleError>>;
|
|
5737
5853
|
/**
|
|
5738
|
-
* @description
|
|
5739
|
-
* @tags
|
|
5740
|
-
* @name
|
|
5741
|
-
* @summary
|
|
5742
|
-
* @request GET:/
|
|
5743
|
-
* @originalName getPreIpoCompanyFundingRounds
|
|
5744
|
-
* @duplicate
|
|
5854
|
+
* @description Returns links of socials logos for symbol
|
|
5855
|
+
* @tags Logos
|
|
5856
|
+
* @name LogosSocialSymbolLogos
|
|
5857
|
+
* @summary Get social logos for symbol
|
|
5858
|
+
* @request GET:/logos/social-symbol-logos
|
|
5745
5859
|
* @secure
|
|
5746
5860
|
*/
|
|
5747
|
-
|
|
5861
|
+
logosSocialSymbolLogos(query: {
|
|
5862
|
+
/** Company symbol */
|
|
5863
|
+
symbol: string;
|
|
5864
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
|
|
5748
5865
|
/**
|
|
5749
|
-
* @description
|
|
5750
|
-
* @tags
|
|
5751
|
-
* @name
|
|
5752
|
-
* @summary
|
|
5753
|
-
* @request GET:/
|
|
5866
|
+
* @description Returns logos for company symbol
|
|
5867
|
+
* @tags Logos
|
|
5868
|
+
* @name LogosSymbolLogos
|
|
5869
|
+
* @summary Get symbol logos
|
|
5870
|
+
* @request GET:/logos/symbol-logos
|
|
5754
5871
|
* @secure
|
|
5755
5872
|
*/
|
|
5756
|
-
|
|
5757
|
-
/**
|
|
5758
|
-
|
|
5759
|
-
|
|
5760
|
-
|
|
5761
|
-
|
|
5762
|
-
|
|
5763
|
-
|
|
5764
|
-
offset: number;
|
|
5765
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyInvestmentsResponse, HandleError>>;
|
|
5766
|
-
/**
|
|
5767
|
-
* @description get pre ipo company investment by id
|
|
5768
|
-
* @tags PreIPOCompanies
|
|
5769
|
-
* @name GetPreIpoCompanyInvestmentsById
|
|
5770
|
-
* @summary get pre ipo company investment by id
|
|
5771
|
-
* @request GET:/ipos/pre-ipo-company-investments/{id}
|
|
5772
|
-
* @originalName getPreIpoCompanyInvestments
|
|
5773
|
-
* @duplicate
|
|
5774
|
-
* @secure
|
|
5775
|
-
*/
|
|
5776
|
-
getPreIpoCompanyInvestmentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyInvestment, HandleError>>;
|
|
5873
|
+
logosSymbolLogos(query: {
|
|
5874
|
+
/** Company symbol */
|
|
5875
|
+
symbol: string;
|
|
5876
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
|
|
5877
|
+
}
|
|
5878
|
+
export class MarketDates<HandleError extends boolean = boolean> {
|
|
5879
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5880
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5777
5881
|
/**
|
|
5778
|
-
* @description
|
|
5779
|
-
* @tags
|
|
5780
|
-
* @name
|
|
5781
|
-
* @summary
|
|
5782
|
-
* @request
|
|
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
|
|
5783
5887
|
* @secure
|
|
5784
5888
|
*/
|
|
5785
|
-
|
|
5786
|
-
/** company id */
|
|
5787
|
-
pre_ipo_company_id?: string;
|
|
5788
|
-
/** search by headline */
|
|
5789
|
-
headline?: string;
|
|
5790
|
-
/** how many records to return. Max value is 50 */
|
|
5791
|
-
limit: number;
|
|
5792
|
-
/** how many records to skip */
|
|
5793
|
-
offset: number;
|
|
5794
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyNewsResponse, HandleError>>;
|
|
5889
|
+
createOrUpdateMarketDate(market: InsightCreateOrUpdateMarketDateRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketDate, HandleError>>;
|
|
5795
5890
|
/**
|
|
5796
|
-
* @description
|
|
5797
|
-
* @tags
|
|
5798
|
-
* @name
|
|
5799
|
-
* @summary
|
|
5800
|
-
* @request
|
|
5801
|
-
* @originalName getPreIpoCompanyNews
|
|
5802
|
-
* @duplicate
|
|
5891
|
+
* @description Remove market date
|
|
5892
|
+
* @tags MarketDates
|
|
5893
|
+
* @name RemoveMarketDate
|
|
5894
|
+
* @summary Remove market date
|
|
5895
|
+
* @request DELETE:/market-dates
|
|
5803
5896
|
* @secure
|
|
5804
5897
|
*/
|
|
5805
|
-
|
|
5898
|
+
removeMarketDate(market: InsightRemoveMarketDateRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5806
5899
|
/**
|
|
5807
|
-
* @description
|
|
5808
|
-
* @tags
|
|
5809
|
-
* @name
|
|
5810
|
-
* @summary
|
|
5811
|
-
* @request
|
|
5900
|
+
* @description Get market dates history
|
|
5901
|
+
* @tags MarketDates
|
|
5902
|
+
* @name GetMarketDatesHistory
|
|
5903
|
+
* @summary Get market dates history
|
|
5904
|
+
* @request POST:/market-dates/history
|
|
5812
5905
|
* @secure
|
|
5813
5906
|
*/
|
|
5814
|
-
|
|
5815
|
-
/** company id */
|
|
5816
|
-
pre_ipo_company_id?: string;
|
|
5817
|
-
/** search by title */
|
|
5818
|
-
title?: string;
|
|
5819
|
-
/** how many records to return. Max value is 50 */
|
|
5820
|
-
limit: number;
|
|
5821
|
-
/** how many records to skip */
|
|
5822
|
-
offset: number;
|
|
5823
|
-
/** search by research type */
|
|
5824
|
-
research_type?: InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum;
|
|
5825
|
-
/** search by relation */
|
|
5826
|
-
relation?: InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum;
|
|
5827
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError>>;
|
|
5907
|
+
getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
|
|
5828
5908
|
/**
|
|
5829
|
-
* @description
|
|
5830
|
-
* @tags
|
|
5831
|
-
* @name
|
|
5832
|
-
* @summary
|
|
5833
|
-
* @request GET:/
|
|
5834
|
-
* @originalName getPreIpoCompanyResearchDocuments
|
|
5835
|
-
* @duplicate
|
|
5909
|
+
* @description Get markets
|
|
5910
|
+
* @tags MarketDates
|
|
5911
|
+
* @name GetMarkets
|
|
5912
|
+
* @summary Get markets
|
|
5913
|
+
* @request GET:/market-dates/markets
|
|
5836
5914
|
* @secure
|
|
5837
5915
|
*/
|
|
5838
|
-
|
|
5916
|
+
getMarkets(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketsResponse, HandleError>>;
|
|
5839
5917
|
/**
|
|
5840
|
-
* @description
|
|
5841
|
-
* @tags
|
|
5842
|
-
* @name
|
|
5843
|
-
* @summary
|
|
5844
|
-
* @request
|
|
5918
|
+
* @description Create or update market
|
|
5919
|
+
* @tags MarketDates
|
|
5920
|
+
* @name CreateOrUpdateMarket
|
|
5921
|
+
* @summary Create or update market
|
|
5922
|
+
* @request POST:/market-dates/markets
|
|
5845
5923
|
* @secure
|
|
5846
5924
|
*/
|
|
5847
|
-
|
|
5848
|
-
/** search by monark stage */
|
|
5849
|
-
monark_stage?: InsightGetInvestorParamsMonarkStageEnum;
|
|
5850
|
-
/** Optional param to filter returned spv's based on the exemptions claimed */
|
|
5851
|
-
exemptions_claimed?: string[];
|
|
5852
|
-
/** Optional param to filter returned spv's based on the name */
|
|
5853
|
-
name_filter?: string;
|
|
5854
|
-
/** investment id */
|
|
5855
|
-
pre_ipo_company_id?: string;
|
|
5856
|
-
/** investment id */
|
|
5857
|
-
pre_ipo_company_investment_id?: string;
|
|
5858
|
-
/** page number */
|
|
5859
|
-
page: number;
|
|
5860
|
-
/** page size */
|
|
5861
|
-
page_size: number;
|
|
5862
|
-
/** sort direction */
|
|
5863
|
-
sort_order?: InsightGetInvestorParamsSortOrderEnum;
|
|
5864
|
-
/** sort field */
|
|
5865
|
-
sort_by?: InsightGetInvestorParamsSortByEnum;
|
|
5866
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsWithInvestorIDResponse, HandleError>>;
|
|
5925
|
+
createOrUpdateMarket(market: InsightCreateOrUpdateMarketRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarket, HandleError>>;
|
|
5867
5926
|
/**
|
|
5868
|
-
* @description
|
|
5869
|
-
* @tags
|
|
5870
|
-
* @name
|
|
5871
|
-
* @summary
|
|
5872
|
-
* @request GET:/
|
|
5873
|
-
* @originalName getInvestor
|
|
5874
|
-
* @duplicate
|
|
5927
|
+
* @description Get market
|
|
5928
|
+
* @tags MarketDates
|
|
5929
|
+
* @name GetMarket
|
|
5930
|
+
* @summary Get market
|
|
5931
|
+
* @request GET:/market-dates/markets/{market}
|
|
5875
5932
|
* @secure
|
|
5876
5933
|
*/
|
|
5877
|
-
|
|
5878
|
-
/** default is false, if true documents will be included in the response */
|
|
5879
|
-
include_documents?: boolean;
|
|
5880
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetProIPOCompabySPVWithInvestorIDResponse, HandleError>>;
|
|
5934
|
+
getMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarket, HandleError>>;
|
|
5881
5935
|
/**
|
|
5882
|
-
* @description
|
|
5883
|
-
* @tags
|
|
5884
|
-
* @name
|
|
5885
|
-
* @summary
|
|
5886
|
-
* @request
|
|
5936
|
+
* @description Remove market
|
|
5937
|
+
* @tags MarketDates
|
|
5938
|
+
* @name RemoveMarket
|
|
5939
|
+
* @summary Remove market
|
|
5940
|
+
* @request DELETE:/market-dates/markets/{market}
|
|
5887
5941
|
* @secure
|
|
5888
5942
|
*/
|
|
5889
|
-
|
|
5890
|
-
/** company id */
|
|
5891
|
-
pre_ipo_company_id?: string;
|
|
5892
|
-
/** investment id */
|
|
5893
|
-
investment_id?: string;
|
|
5894
|
-
/** search by name */
|
|
5895
|
-
name?: string;
|
|
5896
|
-
/** search by company name */
|
|
5897
|
-
company_name?: string;
|
|
5898
|
-
/** how many records to return. Max value is 50 */
|
|
5899
|
-
limit: number;
|
|
5900
|
-
/** how many records to skip */
|
|
5901
|
-
offset: number;
|
|
5902
|
-
/** search by monark stage */
|
|
5903
|
-
monark_stage?: InsightGetPreIpoCompanySpvsParamsMonarkStageEnum;
|
|
5904
|
-
/** sort direction */
|
|
5905
|
-
direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
|
|
5906
|
-
/** sort field */
|
|
5907
|
-
field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
|
|
5908
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
|
|
5943
|
+
removeMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5909
5944
|
/**
|
|
5910
|
-
* @description
|
|
5911
|
-
* @tags
|
|
5912
|
-
* @name
|
|
5913
|
-
* @summary
|
|
5914
|
-
* @request
|
|
5915
|
-
* @originalName getPreIpoCompanySpvs
|
|
5916
|
-
* @duplicate
|
|
5945
|
+
* @description CreateOrUpdateMarketSchedule market schedule
|
|
5946
|
+
* @tags MarketDates
|
|
5947
|
+
* @name CreateOrUpdateMarketSchedule
|
|
5948
|
+
* @summary CreateOrUpdateMarketSchedule market schedule
|
|
5949
|
+
* @request POST:/market-dates/schedule
|
|
5917
5950
|
* @secure
|
|
5918
5951
|
*/
|
|
5919
|
-
|
|
5920
|
-
/** default is false, if true documents will be included in the response */
|
|
5921
|
-
include_documents?: boolean;
|
|
5922
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
|
|
5923
|
-
}
|
|
5924
|
-
export class Public<HandleError extends boolean = boolean> {
|
|
5925
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5926
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5952
|
+
createOrUpdateMarketSchedule(market: InsightCreateOrUpdateMarketScheduleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
|
|
5927
5953
|
/**
|
|
5928
|
-
* @description
|
|
5929
|
-
* @tags
|
|
5930
|
-
* @name
|
|
5931
|
-
* @summary
|
|
5932
|
-
* @request GET:/
|
|
5954
|
+
* @description Get market schedule
|
|
5955
|
+
* @tags MarketDates
|
|
5956
|
+
* @name GetMarketSchedule
|
|
5957
|
+
* @summary Get market schedule
|
|
5958
|
+
* @request GET:/market-dates/schedule/{market}
|
|
5933
5959
|
* @secure
|
|
5934
5960
|
*/
|
|
5935
|
-
|
|
5936
|
-
/** Single symbol */
|
|
5937
|
-
symbol: string;
|
|
5938
|
-
/** Non-zero amount */
|
|
5939
|
-
amount: number;
|
|
5940
|
-
/** Start date for calculations */
|
|
5941
|
-
start_date: string;
|
|
5942
|
-
/** End date for calculations */
|
|
5943
|
-
end_date: string;
|
|
5944
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
|
|
5961
|
+
getMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
|
|
5945
5962
|
/**
|
|
5946
|
-
* @description
|
|
5947
|
-
* @tags
|
|
5948
|
-
* @name
|
|
5949
|
-
* @summary
|
|
5950
|
-
* @request
|
|
5963
|
+
* @description Remove market schedule
|
|
5964
|
+
* @tags MarketDates
|
|
5965
|
+
* @name RemoveMarketSchedule
|
|
5966
|
+
* @summary Remove market schedule
|
|
5967
|
+
* @request DELETE:/market-dates/schedule/{market}
|
|
5951
5968
|
* @secure
|
|
5952
5969
|
*/
|
|
5953
|
-
|
|
5954
|
-
/** Comma separated symbols */
|
|
5955
|
-
symbols: string;
|
|
5956
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
|
|
5970
|
+
removeMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5957
5971
|
/**
|
|
5958
|
-
* @description
|
|
5959
|
-
* @tags
|
|
5960
|
-
* @name
|
|
5961
|
-
* @summary
|
|
5962
|
-
* @request GET:/
|
|
5972
|
+
* @description Get market schedules
|
|
5973
|
+
* @tags MarketDates
|
|
5974
|
+
* @name GetMarketSchedules
|
|
5975
|
+
* @summary Get market schedules
|
|
5976
|
+
* @request GET:/market-dates/schedules
|
|
5963
5977
|
* @secure
|
|
5964
5978
|
*/
|
|
5965
|
-
|
|
5966
|
-
/**
|
|
5967
|
-
|
|
5968
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5979
|
+
getMarketSchedules(query?: {
|
|
5980
|
+
/** Market codes, comma separated */
|
|
5981
|
+
market?: string;
|
|
5982
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse[][], HandleError>>;
|
|
5969
5983
|
/**
|
|
5970
|
-
* @description
|
|
5971
|
-
* @tags
|
|
5972
|
-
* @name
|
|
5973
|
-
* @summary
|
|
5974
|
-
* @request GET:/
|
|
5984
|
+
* @description Get todays market hours
|
|
5985
|
+
* @tags MarketDates
|
|
5986
|
+
* @name GetTodaysMarketHours
|
|
5987
|
+
* @summary Get todays market hours
|
|
5988
|
+
* @request GET:/market-dates/today
|
|
5975
5989
|
* @secure
|
|
5976
5990
|
*/
|
|
5977
|
-
|
|
5978
|
-
/**
|
|
5979
|
-
|
|
5980
|
-
|
|
5981
|
-
|
|
5982
|
-
|
|
5991
|
+
getTodaysMarketHours(query: {
|
|
5992
|
+
/** Market */
|
|
5993
|
+
market: string;
|
|
5994
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
|
|
5995
|
+
}
|
|
5996
|
+
export class News<HandleError extends boolean = boolean> {
|
|
5997
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5998
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5983
5999
|
/**
|
|
5984
|
-
* @description
|
|
5985
|
-
* @tags
|
|
5986
|
-
* @name
|
|
5987
|
-
* @summary
|
|
5988
|
-
* @request
|
|
6000
|
+
* @description Returns available authors in DB
|
|
6001
|
+
* @tags News
|
|
6002
|
+
* @name NewsAvailableAuthors
|
|
6003
|
+
* @summary Get available authors in DB (for filters)
|
|
6004
|
+
* @request POST:/news/authors
|
|
5989
6005
|
* @secure
|
|
5990
6006
|
*/
|
|
5991
|
-
|
|
6007
|
+
newsAvailableAuthors(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5992
6008
|
/**
|
|
5993
|
-
* @description
|
|
5994
|
-
* @tags
|
|
5995
|
-
* @name
|
|
5996
|
-
* @summary
|
|
5997
|
-
* @request
|
|
6009
|
+
* @description Returns available channels in DB
|
|
6010
|
+
* @tags News
|
|
6011
|
+
* @name NewsAvailableChannels
|
|
6012
|
+
* @summary Get available channels in DB (for filters)
|
|
6013
|
+
* @request POST:/news/channels
|
|
5998
6014
|
* @secure
|
|
5999
6015
|
*/
|
|
6000
|
-
|
|
6016
|
+
newsAvailableChannels(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
6001
6017
|
/**
|
|
6002
|
-
* @description
|
|
6003
|
-
* @tags
|
|
6004
|
-
* @name
|
|
6005
|
-
* @summary
|
|
6006
|
-
* @request GET:/
|
|
6018
|
+
* @description Get featured articles
|
|
6019
|
+
* @tags News
|
|
6020
|
+
* @name GetFeaturedArticles
|
|
6021
|
+
* @summary Get featured articles
|
|
6022
|
+
* @request GET:/news/featured-articles
|
|
6007
6023
|
* @secure
|
|
6008
6024
|
*/
|
|
6009
|
-
|
|
6010
|
-
/**
|
|
6011
|
-
search_query: string;
|
|
6012
|
-
/** how many records to return. Max value is 50 */
|
|
6013
|
-
limit: number;
|
|
6014
|
-
/** how many records to skip */
|
|
6015
|
-
offset: number;
|
|
6016
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
|
|
6017
|
-
/**
|
|
6018
|
-
* @description Get top gainers
|
|
6019
|
-
* @tags Public
|
|
6020
|
-
* @name TopGainers
|
|
6021
|
-
* @summary Top Gainers
|
|
6022
|
-
* @request GET:/public/top-gainers
|
|
6023
|
-
* @secure
|
|
6024
|
-
*/
|
|
6025
|
-
topGainers(query: {
|
|
6026
|
-
/** sort direction - asc or desc */
|
|
6027
|
-
order_direction?: string;
|
|
6028
|
-
/** how many records to return. Max value is 50 */
|
|
6029
|
-
limit: number;
|
|
6030
|
-
/** how many records to skip */
|
|
6031
|
-
offset: number;
|
|
6032
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6033
|
-
/**
|
|
6034
|
-
* @description Get top stocks
|
|
6035
|
-
* @tags Public
|
|
6036
|
-
* @name TopStocks
|
|
6037
|
-
* @summary Top Stocks
|
|
6038
|
-
* @request GET:/public/top-stocks
|
|
6039
|
-
* @secure
|
|
6040
|
-
*/
|
|
6041
|
-
topStocks(query: {
|
|
6042
|
-
/** EQUITY|ETF|CRYPTO */
|
|
6043
|
-
stock_type: InsightTopStocksParamsStockTypeEnum;
|
|
6044
|
-
/** how many records to return. Max value is 50 */
|
|
6025
|
+
getFeaturedArticles(query: {
|
|
6026
|
+
/** Limit */
|
|
6045
6027
|
limit: number;
|
|
6046
|
-
/**
|
|
6028
|
+
/** Offset */
|
|
6047
6029
|
offset: number;
|
|
6048
|
-
|
|
6049
|
-
|
|
6050
|
-
|
|
6051
|
-
|
|
6052
|
-
|
|
6030
|
+
/** Start date */
|
|
6031
|
+
start_date?: string;
|
|
6032
|
+
/** End date */
|
|
6033
|
+
end_date?: string;
|
|
6034
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
|
|
6053
6035
|
/**
|
|
6054
|
-
* @description
|
|
6055
|
-
* @tags
|
|
6056
|
-
* @name
|
|
6057
|
-
* @summary
|
|
6058
|
-
* @request
|
|
6036
|
+
* @description Update featured articles
|
|
6037
|
+
* @tags News
|
|
6038
|
+
* @name UpdateFeaturedArticles
|
|
6039
|
+
* @summary Update featured articles
|
|
6040
|
+
* @request PUT:/news/featured-articles
|
|
6059
6041
|
* @secure
|
|
6060
6042
|
*/
|
|
6061
|
-
|
|
6062
|
-
/** Symbol */
|
|
6063
|
-
symbol: string;
|
|
6064
|
-
/** Date */
|
|
6065
|
-
date: string;
|
|
6066
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
|
|
6043
|
+
updateFeaturedArticles(input: InsightUpdateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6067
6044
|
/**
|
|
6068
|
-
* @description
|
|
6069
|
-
* @tags
|
|
6070
|
-
* @name
|
|
6071
|
-
* @summary
|
|
6072
|
-
* @request POST:/
|
|
6045
|
+
* @description Create featured articles
|
|
6046
|
+
* @tags News
|
|
6047
|
+
* @name CreateFeaturedArticles
|
|
6048
|
+
* @summary Create featured articles
|
|
6049
|
+
* @request POST:/news/featured-articles
|
|
6073
6050
|
* @secure
|
|
6074
6051
|
*/
|
|
6075
|
-
|
|
6052
|
+
createFeaturedArticles(input: InsightCreateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6076
6053
|
/**
|
|
6077
|
-
* @description
|
|
6078
|
-
* @tags
|
|
6079
|
-
* @name
|
|
6080
|
-
* @summary Get
|
|
6081
|
-
* @request GET:/
|
|
6054
|
+
* @description Get active featured articles
|
|
6055
|
+
* @tags News
|
|
6056
|
+
* @name GetActiveFeaturedArticles
|
|
6057
|
+
* @summary Get active featured articles
|
|
6058
|
+
* @request GET:/news/featured-articles/active
|
|
6082
6059
|
* @secure
|
|
6083
6060
|
*/
|
|
6084
|
-
|
|
6085
|
-
/** Comma separated symbols */
|
|
6086
|
-
symbols: string;
|
|
6087
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
|
|
6088
|
-
}
|
|
6089
|
-
export class StockScreener<HandleError extends boolean = boolean> {
|
|
6090
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6091
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6061
|
+
getActiveFeaturedArticles(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
|
|
6092
6062
|
/**
|
|
6093
|
-
* @description
|
|
6094
|
-
* @tags
|
|
6095
|
-
* @name
|
|
6096
|
-
* @summary
|
|
6097
|
-
* @request
|
|
6063
|
+
* @description Set featured articles
|
|
6064
|
+
* @tags News
|
|
6065
|
+
* @name SetFeaturedArticles
|
|
6066
|
+
* @summary Set featured articles
|
|
6067
|
+
* @request POST:/news/featured-articles/set
|
|
6098
6068
|
* @secure
|
|
6099
6069
|
*/
|
|
6100
|
-
|
|
6101
|
-
/** Name of symbol list to fetch details for. Empty is default */
|
|
6102
|
-
heatmap_name?: string;
|
|
6103
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
|
|
6070
|
+
setFeaturedArticles(input: InsightSetFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6104
6071
|
/**
|
|
6105
|
-
* @description
|
|
6106
|
-
* @tags
|
|
6107
|
-
* @name
|
|
6108
|
-
* @summary
|
|
6109
|
-
* @request
|
|
6072
|
+
* @description Get featured article
|
|
6073
|
+
* @tags News
|
|
6074
|
+
* @name GetFeaturedArticle
|
|
6075
|
+
* @summary Get featured article
|
|
6076
|
+
* @request GET:/news/featured-articles/{id}
|
|
6110
6077
|
* @secure
|
|
6111
6078
|
*/
|
|
6112
|
-
|
|
6079
|
+
getFeaturedArticle(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticle, HandleError>>;
|
|
6113
6080
|
/**
|
|
6114
|
-
* @description
|
|
6115
|
-
* @tags
|
|
6116
|
-
* @name
|
|
6117
|
-
* @summary
|
|
6118
|
-
* @request POST:/
|
|
6081
|
+
* @description Returns news by filters
|
|
6082
|
+
* @tags News
|
|
6083
|
+
* @name NewsFiltered
|
|
6084
|
+
* @summary Get filtered news
|
|
6085
|
+
* @request POST:/news/filter
|
|
6119
6086
|
* @secure
|
|
6120
6087
|
*/
|
|
6121
|
-
|
|
6088
|
+
newsFiltered(filter: InsightNewsFilterRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsResponse, HandleError>>;
|
|
6122
6089
|
/**
|
|
6123
|
-
* @description
|
|
6124
|
-
* @tags
|
|
6125
|
-
* @name
|
|
6126
|
-
* @summary
|
|
6127
|
-
* @request POST:/
|
|
6090
|
+
* @description Returns news by id
|
|
6091
|
+
* @tags News
|
|
6092
|
+
* @name NewsById
|
|
6093
|
+
* @summary Get news by id
|
|
6094
|
+
* @request POST:/news/id
|
|
6128
6095
|
* @secure
|
|
6129
6096
|
*/
|
|
6130
|
-
|
|
6131
|
-
/** Authorization */
|
|
6132
|
-
Authorization?: string;
|
|
6133
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
6097
|
+
newsById(filter: InsightNewsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNews, HandleError>>;
|
|
6134
6098
|
/**
|
|
6135
|
-
* @description
|
|
6136
|
-
* @tags
|
|
6137
|
-
* @name
|
|
6138
|
-
* @summary
|
|
6139
|
-
* @request GET:/
|
|
6099
|
+
* @description Returns news previews
|
|
6100
|
+
* @tags News
|
|
6101
|
+
* @name NewsPreviewsFiltered
|
|
6102
|
+
* @summary Get news previews
|
|
6103
|
+
* @request GET:/news/previews
|
|
6140
6104
|
* @secure
|
|
6141
6105
|
*/
|
|
6142
|
-
|
|
6143
|
-
/**
|
|
6106
|
+
newsPreviewsFiltered(query: {
|
|
6107
|
+
/** Start date */
|
|
6108
|
+
start_date?: string;
|
|
6109
|
+
/** End date */
|
|
6110
|
+
end_date?: string;
|
|
6111
|
+
/** Symbol */
|
|
6112
|
+
symbol?: string;
|
|
6113
|
+
/** how many records to return. Max value is 50 */
|
|
6144
6114
|
limit: number;
|
|
6145
6115
|
/** how many records to skip */
|
|
6146
6116
|
offset: number;
|
|
6147
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
6117
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRecentNewsPreviewsResponse, HandleError>>;
|
|
6148
6118
|
/**
|
|
6149
|
-
* @description
|
|
6150
|
-
* @tags
|
|
6151
|
-
* @name
|
|
6152
|
-
* @summary
|
|
6153
|
-
* @request
|
|
6119
|
+
* @description Returns available stocks in DB
|
|
6120
|
+
* @tags News
|
|
6121
|
+
* @name NewsAvailableStocks
|
|
6122
|
+
* @summary Get available stocks in DB (for filters)
|
|
6123
|
+
* @request GET:/news/symbols
|
|
6154
6124
|
* @secure
|
|
6155
6125
|
*/
|
|
6156
|
-
|
|
6126
|
+
newsAvailableStocks(query?: {
|
|
6127
|
+
/** Limit */
|
|
6128
|
+
limit?: number;
|
|
6129
|
+
/** Offset */
|
|
6130
|
+
offset?: number;
|
|
6131
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
6157
6132
|
/**
|
|
6158
|
-
* @description
|
|
6159
|
-
* @tags
|
|
6160
|
-
* @name
|
|
6161
|
-
* @summary
|
|
6162
|
-
* @request POST:/
|
|
6133
|
+
* @description Returns available tags in DB
|
|
6134
|
+
* @tags News
|
|
6135
|
+
* @name NewsAvailableTags
|
|
6136
|
+
* @summary Get available tags in DB (for filters)
|
|
6137
|
+
* @request POST:/news/tags
|
|
6163
6138
|
* @secure
|
|
6164
6139
|
*/
|
|
6165
|
-
|
|
6140
|
+
newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
6141
|
+
}
|
|
6142
|
+
export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
6143
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6144
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6166
6145
|
/**
|
|
6167
|
-
* @description
|
|
6168
|
-
* @tags
|
|
6169
|
-
* @name
|
|
6170
|
-
* @summary
|
|
6171
|
-
* @request
|
|
6146
|
+
* @description Returns calculated matrix
|
|
6147
|
+
* @tags OptionGreeks
|
|
6148
|
+
* @name OgCalculateMatrix
|
|
6149
|
+
* @summary Calculate matrix
|
|
6150
|
+
* @request POST:/og/calculate-matrix
|
|
6172
6151
|
* @secure
|
|
6173
6152
|
*/
|
|
6174
|
-
|
|
6153
|
+
ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
|
|
6175
6154
|
/**
|
|
6176
|
-
* @description
|
|
6177
|
-
* @tags
|
|
6178
|
-
* @name
|
|
6179
|
-
* @summary
|
|
6180
|
-
* @request POST:/
|
|
6155
|
+
* @description Returns calculated params
|
|
6156
|
+
* @tags OptionGreeks
|
|
6157
|
+
* @name OgCalculateParams
|
|
6158
|
+
* @summary Calculate params
|
|
6159
|
+
* @request POST:/og/calculate-params
|
|
6181
6160
|
* @secure
|
|
6182
6161
|
*/
|
|
6183
|
-
|
|
6162
|
+
ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
|
|
6184
6163
|
}
|
|
6185
|
-
export class
|
|
6164
|
+
export class Ownerships<HandleError extends boolean = boolean> {
|
|
6186
6165
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6187
6166
|
constructor(apiClient: JwtClient<HandleError>);
|
|
6188
6167
|
/**
|
|
6189
|
-
* @description
|
|
6190
|
-
* @tags
|
|
6191
|
-
* @name
|
|
6192
|
-
* @summary
|
|
6193
|
-
* @request POST:/
|
|
6168
|
+
* @description get ownerships by id datadata
|
|
6169
|
+
* @tags Ownerships
|
|
6170
|
+
* @name GetOwnershipsByIdData
|
|
6171
|
+
* @summary get ownerships by id data
|
|
6172
|
+
* @request POST:/ownerships
|
|
6194
6173
|
* @secure
|
|
6195
6174
|
*/
|
|
6196
|
-
|
|
6175
|
+
getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
6197
6176
|
/**
|
|
6198
|
-
* @description get
|
|
6199
|
-
* @tags
|
|
6200
|
-
* @name
|
|
6201
|
-
* @summary get
|
|
6202
|
-
* @request POST:/
|
|
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
|
|
6203
6182
|
* @secure
|
|
6204
6183
|
*/
|
|
6205
|
-
|
|
6184
|
+
getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
6185
|
+
}
|
|
6186
|
+
export class Passport<HandleError extends boolean = boolean> {
|
|
6187
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6188
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6189
|
+
/**
|
|
6190
|
+
* @description Returns article by id
|
|
6191
|
+
* @tags Passport
|
|
6192
|
+
* @name PassportArticleById
|
|
6193
|
+
* @summary Get article by id
|
|
6194
|
+
* @request POST:/passport/article-by-id
|
|
6195
|
+
* @secure
|
|
6196
|
+
*/
|
|
6197
|
+
passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
|
|
6198
|
+
/**
|
|
6199
|
+
* @description Returns articles
|
|
6200
|
+
* @tags Passport
|
|
6201
|
+
* @name PassportArticles
|
|
6202
|
+
* @summary Get articles
|
|
6203
|
+
* @request POST:/passport/articles
|
|
6204
|
+
* @secure
|
|
6205
|
+
*/
|
|
6206
|
+
passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
6207
|
+
/**
|
|
6208
|
+
* @description Returns author profile
|
|
6209
|
+
* @tags Passport
|
|
6210
|
+
* @name PassportAuthorProfile
|
|
6211
|
+
* @summary Get author profile
|
|
6212
|
+
* @request POST:/passport/author-profile
|
|
6213
|
+
* @secure
|
|
6214
|
+
*/
|
|
6215
|
+
passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
|
|
6216
|
+
/**
|
|
6217
|
+
* @description Returns most popular tags
|
|
6218
|
+
* @tags Passport
|
|
6219
|
+
* @name PassportMostPopularTags
|
|
6220
|
+
* @summary Get most popular tags
|
|
6221
|
+
* @request POST:/passport/most-popular-tags
|
|
6222
|
+
* @secure
|
|
6223
|
+
*/
|
|
6224
|
+
passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
|
|
6225
|
+
/**
|
|
6226
|
+
* @description Returns news feed
|
|
6227
|
+
* @tags Passport
|
|
6228
|
+
* @name PassportNewsFeed
|
|
6229
|
+
* @summary Get news feed
|
|
6230
|
+
* @request POST:/passport/newsfeed
|
|
6231
|
+
* @secure
|
|
6232
|
+
*/
|
|
6233
|
+
passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
|
|
6234
|
+
/**
|
|
6235
|
+
* @description Returns article by parameters
|
|
6236
|
+
* @tags Passport
|
|
6237
|
+
* @name PassportSearchArticle
|
|
6238
|
+
* @summary Search article by parameters
|
|
6239
|
+
* @request POST:/passport/search-article
|
|
6240
|
+
* @secure
|
|
6241
|
+
*/
|
|
6242
|
+
passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
6206
6243
|
}
|
|
6207
6244
|
export class TipRank<HandleError extends boolean = boolean> {
|
|
6208
6245
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -6583,187 +6620,420 @@ export class UsageTracking<HandleError extends boolean = boolean> {
|
|
|
6583
6620
|
*/
|
|
6584
6621
|
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
|
|
6585
6622
|
}
|
|
6586
|
-
export class
|
|
6623
|
+
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
6587
6624
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6588
6625
|
constructor(apiClient: JwtClient<HandleError>);
|
|
6589
6626
|
/**
|
|
6590
|
-
* @description
|
|
6591
|
-
* @tags
|
|
6592
|
-
* @name
|
|
6593
|
-
* @summary
|
|
6594
|
-
* @request
|
|
6627
|
+
* @description get seasonlity data with comparison to benchmark
|
|
6628
|
+
* @tags AlphaTools
|
|
6629
|
+
* @name GetMomentumRatioGraph
|
|
6630
|
+
* @summary get seasonlity data
|
|
6631
|
+
* @request POST:/rst
|
|
6595
6632
|
* @secure
|
|
6596
6633
|
*/
|
|
6597
|
-
|
|
6598
|
-
/** Query limit */
|
|
6599
|
-
limit: number;
|
|
6600
|
-
/** Query offset */
|
|
6601
|
-
offset: number;
|
|
6602
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
6634
|
+
getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
|
|
6603
6635
|
/**
|
|
6604
|
-
* @description
|
|
6605
|
-
* @tags
|
|
6606
|
-
* @name
|
|
6607
|
-
* @summary
|
|
6608
|
-
* @request
|
|
6636
|
+
* @description get seasonlity data with comparison to benchmark
|
|
6637
|
+
* @tags AlphaTools
|
|
6638
|
+
* @name GetSeasonality
|
|
6639
|
+
* @summary get seasonlity data
|
|
6640
|
+
* @request POST:/seasonality
|
|
6609
6641
|
* @secure
|
|
6610
6642
|
*/
|
|
6611
|
-
|
|
6643
|
+
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
|
|
6644
|
+
}
|
|
6645
|
+
export class Public<HandleError extends boolean = boolean> {
|
|
6646
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6647
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6612
6648
|
/**
|
|
6613
|
-
* @description
|
|
6614
|
-
* @tags
|
|
6615
|
-
* @name
|
|
6616
|
-
* @summary
|
|
6617
|
-
* @request
|
|
6649
|
+
* @description Calculate estimated returns for selected symbols. Uses split adjusted prices
|
|
6650
|
+
* @tags Public
|
|
6651
|
+
* @name CalculateEstimatedReturns
|
|
6652
|
+
* @summary Calculate Estimated Returns
|
|
6653
|
+
* @request GET:/public/estimated-returns
|
|
6618
6654
|
* @secure
|
|
6619
6655
|
*/
|
|
6620
|
-
|
|
6656
|
+
calculateEstimatedReturns(query: {
|
|
6657
|
+
/** Single symbol */
|
|
6658
|
+
symbol: string;
|
|
6659
|
+
/**
|
|
6660
|
+
* Non-zero amount
|
|
6661
|
+
* @format float64
|
|
6662
|
+
*/
|
|
6663
|
+
amount: number;
|
|
6664
|
+
/** Start date for calculations */
|
|
6665
|
+
start_date: string;
|
|
6666
|
+
/** End date for calculations */
|
|
6667
|
+
end_date: string;
|
|
6668
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
|
|
6621
6669
|
/**
|
|
6622
|
-
* @description
|
|
6623
|
-
* @tags
|
|
6624
|
-
* @name
|
|
6625
|
-
* @summary
|
|
6626
|
-
* @request
|
|
6670
|
+
* @description Returns an expert forecast
|
|
6671
|
+
* @tags Public
|
|
6672
|
+
* @name ExpertForecast
|
|
6673
|
+
* @summary Expert forecast
|
|
6674
|
+
* @request GET:/public/expert-forecast
|
|
6627
6675
|
* @secure
|
|
6628
6676
|
*/
|
|
6629
|
-
|
|
6630
|
-
/**
|
|
6631
|
-
|
|
6632
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
6677
|
+
expertForecast(query: {
|
|
6678
|
+
/** Comma separated symbols */
|
|
6679
|
+
symbols: string;
|
|
6680
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
|
|
6633
6681
|
/**
|
|
6634
|
-
* @description
|
|
6635
|
-
* @tags
|
|
6636
|
-
* @name
|
|
6637
|
-
* @summary
|
|
6638
|
-
* @request GET:/
|
|
6682
|
+
* @description get fundamentals by symbol data
|
|
6683
|
+
* @tags Public
|
|
6684
|
+
* @name GetPublicFundamentalsBySymbolData
|
|
6685
|
+
* @summary get fundamentals by symbol data
|
|
6686
|
+
* @request GET:/public/fundamentals/{symbol}
|
|
6639
6687
|
* @secure
|
|
6640
6688
|
*/
|
|
6641
|
-
|
|
6642
|
-
/**
|
|
6643
|
-
|
|
6644
|
-
|
|
6645
|
-
offset: number;
|
|
6646
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
6689
|
+
getPublicFundamentalsBySymbolData(symbol: string, query: {
|
|
6690
|
+
/** Annual or quarterly */
|
|
6691
|
+
mode: string;
|
|
6692
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
6647
6693
|
/**
|
|
6648
|
-
* @description
|
|
6649
|
-
* @tags
|
|
6650
|
-
* @name
|
|
6651
|
-
* @summary
|
|
6652
|
-
* @request
|
|
6694
|
+
* @description Daily price history
|
|
6695
|
+
* @tags Public
|
|
6696
|
+
* @name DailyPriceHistory
|
|
6697
|
+
* @summary Daily price history
|
|
6698
|
+
* @request GET:/public/price-history/daily
|
|
6653
6699
|
* @secure
|
|
6654
6700
|
*/
|
|
6655
|
-
|
|
6701
|
+
dailyPriceHistory(query: {
|
|
6702
|
+
/** Single symbol */
|
|
6703
|
+
symbol: string;
|
|
6704
|
+
/** Target date */
|
|
6705
|
+
date: string;
|
|
6706
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
|
|
6656
6707
|
/**
|
|
6657
|
-
* @description
|
|
6658
|
-
* @tags
|
|
6659
|
-
* @name
|
|
6660
|
-
* @summary
|
|
6661
|
-
* @request
|
|
6708
|
+
* @description Public quote profile
|
|
6709
|
+
* @tags Public
|
|
6710
|
+
* @name PublicQuoteProfile
|
|
6711
|
+
* @summary Public quote profile
|
|
6712
|
+
* @request GET:/public/quote-profile/{symbol}
|
|
6662
6713
|
* @secure
|
|
6663
6714
|
*/
|
|
6664
|
-
|
|
6715
|
+
publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
|
|
6665
6716
|
/**
|
|
6666
|
-
* @description
|
|
6667
|
-
* @tags
|
|
6668
|
-
* @name
|
|
6669
|
-
* @summary
|
|
6670
|
-
* @request
|
|
6717
|
+
* @description get ratios by symbol data
|
|
6718
|
+
* @tags Public
|
|
6719
|
+
* @name GetPublicRatiosBySymbolData
|
|
6720
|
+
* @summary get ratios by symbol data
|
|
6721
|
+
* @request GET:/public/ratios/{symbol}
|
|
6671
6722
|
* @secure
|
|
6672
6723
|
*/
|
|
6673
|
-
|
|
6674
|
-
/** a3 code */
|
|
6675
|
-
a3code: string;
|
|
6676
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6724
|
+
getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
|
|
6677
6725
|
/**
|
|
6678
|
-
* @description
|
|
6679
|
-
* @tags
|
|
6680
|
-
* @name
|
|
6681
|
-
* @summary
|
|
6682
|
-
* @request GET:/
|
|
6726
|
+
* @description find a symbol by name or description
|
|
6727
|
+
* @tags Public
|
|
6728
|
+
* @name QuoteFundamentalsSearch
|
|
6729
|
+
* @summary find a symbol by name or description
|
|
6730
|
+
* @request GET:/public/symbol-search
|
|
6683
6731
|
* @secure
|
|
6684
6732
|
*/
|
|
6685
|
-
|
|
6686
|
-
/**
|
|
6733
|
+
quoteFundamentalsSearch(query: {
|
|
6734
|
+
/** Search query */
|
|
6735
|
+
search_query: string;
|
|
6736
|
+
/** how many records to return. Max value is 50 */
|
|
6687
6737
|
limit: number;
|
|
6688
|
-
/**
|
|
6738
|
+
/** how many records to skip */
|
|
6689
6739
|
offset: number;
|
|
6690
|
-
|
|
6691
|
-
continent?: string;
|
|
6692
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
6693
|
-
/**
|
|
6694
|
-
* @description Edit global index
|
|
6695
|
-
* @tags World Markets
|
|
6696
|
-
* @name GlobalIndexEdit
|
|
6697
|
-
* @summary Edit global index
|
|
6698
|
-
* @request PUT:/global-indexes
|
|
6699
|
-
* @secure
|
|
6700
|
-
*/
|
|
6701
|
-
globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6740
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
|
|
6702
6741
|
/**
|
|
6703
|
-
* @description
|
|
6704
|
-
* @tags
|
|
6705
|
-
* @name
|
|
6706
|
-
* @summary
|
|
6707
|
-
* @request
|
|
6742
|
+
* @description Get top gainers
|
|
6743
|
+
* @tags Public
|
|
6744
|
+
* @name TopGainers
|
|
6745
|
+
* @summary Top Gainers
|
|
6746
|
+
* @request GET:/public/top-gainers
|
|
6708
6747
|
* @secure
|
|
6709
6748
|
*/
|
|
6710
|
-
|
|
6749
|
+
topGainers(query: {
|
|
6750
|
+
/** sort direction - asc or desc */
|
|
6751
|
+
order_direction?: string;
|
|
6752
|
+
/** how many records to return. Max value is 50 */
|
|
6753
|
+
limit: number;
|
|
6754
|
+
/** how many records to skip */
|
|
6755
|
+
offset: number;
|
|
6756
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6711
6757
|
/**
|
|
6712
|
-
* @description
|
|
6713
|
-
* @tags
|
|
6714
|
-
* @name
|
|
6715
|
-
* @summary
|
|
6716
|
-
* @request
|
|
6758
|
+
* @description Get top stocks
|
|
6759
|
+
* @tags Public
|
|
6760
|
+
* @name TopStocks
|
|
6761
|
+
* @summary Top Stocks
|
|
6762
|
+
* @request GET:/public/top-stocks
|
|
6717
6763
|
* @secure
|
|
6718
6764
|
*/
|
|
6719
|
-
|
|
6720
|
-
/**
|
|
6721
|
-
|
|
6722
|
-
|
|
6723
|
-
/**
|
|
6724
|
-
* @description Get regions
|
|
6725
|
-
* @tags World Markets
|
|
6726
|
-
* @name RegionGet
|
|
6727
|
-
* @summary Get regions
|
|
6728
|
-
* @request GET:/regions
|
|
6729
|
-
* @secure
|
|
6730
|
-
*/
|
|
6731
|
-
regionGet(query: {
|
|
6732
|
-
/** Query limit */
|
|
6765
|
+
topStocks(query: {
|
|
6766
|
+
/** EQUITY|ETF|CRYPTO */
|
|
6767
|
+
stock_type: InsightTopStocksParamsStockTypeEnum;
|
|
6768
|
+
/** how many records to return. Max value is 50 */
|
|
6733
6769
|
limit: number;
|
|
6734
|
-
/**
|
|
6770
|
+
/** how many records to skip */
|
|
6735
6771
|
offset: number;
|
|
6736
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
6772
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6773
|
+
}
|
|
6774
|
+
export interface InsightBeforeAndAfterV2 {
|
|
6775
|
+
after?: string;
|
|
6776
|
+
before?: string;
|
|
6777
|
+
}
|
|
6778
|
+
export interface InsightFixedIncomeV2 {
|
|
6779
|
+
a144: boolean;
|
|
6780
|
+
accrued_interest: number;
|
|
6781
|
+
bank_qualified: boolean;
|
|
6782
|
+
bond_warrant: boolean;
|
|
6783
|
+
call_type: string;
|
|
6784
|
+
callable: boolean;
|
|
6785
|
+
close_price: number;
|
|
6786
|
+
close_price_asof: string;
|
|
6787
|
+
close_ytw: number;
|
|
6788
|
+
convertible: boolean;
|
|
6789
|
+
country: string;
|
|
6790
|
+
country_code: string;
|
|
6791
|
+
country_domicile: string;
|
|
6792
|
+
country_issue: string;
|
|
6793
|
+
coupon: number;
|
|
6794
|
+
coupon_frequency: string;
|
|
6795
|
+
coupon_type: string;
|
|
6796
|
+
currency: string;
|
|
6797
|
+
cusip: string;
|
|
6798
|
+
dated_date: string;
|
|
6799
|
+
daycount: string;
|
|
6800
|
+
description: string;
|
|
6801
|
+
description_short: string;
|
|
6802
|
+
duration: number;
|
|
6803
|
+
first_coupon_date: string;
|
|
6804
|
+
insured: boolean;
|
|
6805
|
+
isin: string;
|
|
6806
|
+
issue_date: string;
|
|
6807
|
+
issue_minimum_denomination: number;
|
|
6808
|
+
issue_price: number;
|
|
6809
|
+
issue_size: number;
|
|
6810
|
+
issuer: string;
|
|
6811
|
+
last_coupon_date: string;
|
|
6812
|
+
liquidity_institutional_aggregate: number;
|
|
6813
|
+
liquidity_institutional_buy: number;
|
|
6814
|
+
liquidity_institutional_sell: number;
|
|
6815
|
+
liquidity_micro_aggregate: number;
|
|
6816
|
+
liquidity_micro_buy: number;
|
|
6817
|
+
liquidity_micro_sell: number;
|
|
6818
|
+
liquidity_retail_aggregate: number;
|
|
6819
|
+
liquidity_retail_buy: number;
|
|
6820
|
+
liquidity_retail_sell: number;
|
|
6821
|
+
maturity_date: string;
|
|
6822
|
+
municipal_state: string;
|
|
6823
|
+
municipal_taxable_federal: boolean;
|
|
6824
|
+
municipal_type: string;
|
|
6825
|
+
next_call_date: string;
|
|
6826
|
+
next_call_price: number;
|
|
6827
|
+
next_coupon_date: string;
|
|
6828
|
+
par_value: number;
|
|
6829
|
+
perpetual: boolean;
|
|
6830
|
+
private_placement: boolean;
|
|
6831
|
+
purpose: string;
|
|
6832
|
+
puttable: boolean;
|
|
6833
|
+
reg_s: boolean;
|
|
6834
|
+
sector: string;
|
|
6835
|
+
seniority: string;
|
|
6836
|
+
settlement_convention: string;
|
|
6837
|
+
sinking_fund: boolean;
|
|
6838
|
+
sp_creditwatch: string;
|
|
6839
|
+
sp_creditwatch_date: string;
|
|
6840
|
+
sp_outlook: string;
|
|
6841
|
+
sp_outlook_date: string;
|
|
6842
|
+
sp_rating: string;
|
|
6843
|
+
sp_rating_date: string;
|
|
6844
|
+
status: string;
|
|
6845
|
+
ticker: string;
|
|
6846
|
+
treasury_subtype: string;
|
|
6847
|
+
type: string;
|
|
6848
|
+
updated_at: string;
|
|
6849
|
+
}
|
|
6850
|
+
export interface InsightGetFixedIncomeEntriesResponseV2 {
|
|
6851
|
+
count: number;
|
|
6852
|
+
data: InsightFixedIncomeV2[];
|
|
6853
|
+
}
|
|
6854
|
+
export interface InsightGetFixedIncomeEntriesRequestV2 {
|
|
6855
|
+
/** @example true */
|
|
6856
|
+
bank_qualified?: boolean;
|
|
6857
|
+
/** @example true */
|
|
6858
|
+
callable?: boolean;
|
|
6859
|
+
/** @example true */
|
|
6860
|
+
convertible?: boolean;
|
|
6861
|
+
/** @example ["USA"] */
|
|
6862
|
+
country_codes?: string[];
|
|
6863
|
+
coupon?: InsightLessAndMoreV2;
|
|
6864
|
+
/** @example ["quarterly","zero"] */
|
|
6865
|
+
coupon_frequencies?: string[];
|
|
6866
|
+
/** @example ["655664AH3","9128286R6"] */
|
|
6867
|
+
cusip?: string[];
|
|
6737
6868
|
/**
|
|
6738
|
-
* @
|
|
6739
|
-
* @
|
|
6740
|
-
|
|
6741
|
-
|
|
6742
|
-
|
|
6869
|
+
* @maxLength 100
|
|
6870
|
+
* @example "Donald's"
|
|
6871
|
+
*/
|
|
6872
|
+
description?: string;
|
|
6873
|
+
/** @example true */
|
|
6874
|
+
has_ticker?: boolean;
|
|
6875
|
+
/** @example true */
|
|
6876
|
+
insured?: boolean;
|
|
6877
|
+
/** @example ["US655664AH33","US9128286R69"] */
|
|
6878
|
+
isin?: string[];
|
|
6879
|
+
issue_date?: InsightBeforeAndAfterV2;
|
|
6880
|
+
/**
|
|
6881
|
+
* @maxLength 100
|
|
6882
|
+
* @example "Donald's"
|
|
6883
|
+
*/
|
|
6884
|
+
issuer?: string;
|
|
6885
|
+
maturity?: InsightBeforeAndAfterV2;
|
|
6886
|
+
/** @example ["NY"] */
|
|
6887
|
+
municipal_states?: string[];
|
|
6888
|
+
/** @example true */
|
|
6889
|
+
municipal_tax?: boolean;
|
|
6890
|
+
/** @example ["general_obligation"] */
|
|
6891
|
+
municipal_types?: string[];
|
|
6892
|
+
pagination: InsightPaginationV2;
|
|
6893
|
+
purposes?: string[];
|
|
6894
|
+
/** @example ["SOVEREIGN"] */
|
|
6895
|
+
sectors?: string[];
|
|
6896
|
+
sorts?: InsightOrderingV2[];
|
|
6897
|
+
/** @example ["AAA"] */
|
|
6898
|
+
sp_ratings?: string[];
|
|
6899
|
+
/** @example ["called","outstanding"] */
|
|
6900
|
+
statuses?: string[];
|
|
6901
|
+
tickers?: string[];
|
|
6902
|
+
/** @example ["corporate"] */
|
|
6903
|
+
types?: string[];
|
|
6904
|
+
}
|
|
6905
|
+
export interface InsightGetTopSymbolsRequestV2 {
|
|
6906
|
+
exchange?: string[];
|
|
6907
|
+
market_cap?: InsightLessAndMoreV2;
|
|
6908
|
+
pagination?: InsightPaginationV2;
|
|
6909
|
+
price?: InsightLessAndMoreV2;
|
|
6910
|
+
sorts?: InsightOrderingV2[];
|
|
6911
|
+
volume?: InsightLessAndMoreV2;
|
|
6912
|
+
}
|
|
6913
|
+
export interface InsightIncludeExcludeV2 {
|
|
6914
|
+
exclude?: string[];
|
|
6915
|
+
include?: string[];
|
|
6916
|
+
}
|
|
6917
|
+
export interface InsightLessAndMoreV2 {
|
|
6918
|
+
less_than?: number;
|
|
6919
|
+
more_than?: number;
|
|
6920
|
+
}
|
|
6921
|
+
export enum InsightOrderDirectionV2 {
|
|
6922
|
+
OrderASC = "asc",
|
|
6923
|
+
OrderDESC = "desc"
|
|
6924
|
+
}
|
|
6925
|
+
export interface InsightOrderingV2 {
|
|
6926
|
+
/**
|
|
6927
|
+
* @default "asc"
|
|
6928
|
+
* @example "asc"
|
|
6929
|
+
*/
|
|
6930
|
+
direction: InsightOrderingDirectionEnumV2;
|
|
6931
|
+
/**
|
|
6932
|
+
* Sort direction:
|
|
6933
|
+
* * asc - Ascending, from A to Z.
|
|
6934
|
+
* * desc - Descending, from Z to A.
|
|
6935
|
+
* @example "name"
|
|
6936
|
+
*/
|
|
6937
|
+
field: string;
|
|
6938
|
+
}
|
|
6939
|
+
export interface InsightPaginationV2 {
|
|
6940
|
+
/**
|
|
6941
|
+
* @min 1
|
|
6942
|
+
* @example 1
|
|
6943
|
+
*/
|
|
6944
|
+
page: number;
|
|
6945
|
+
/**
|
|
6946
|
+
* @min 1
|
|
6947
|
+
* @max 50
|
|
6948
|
+
* @example 10
|
|
6949
|
+
*/
|
|
6950
|
+
size: number;
|
|
6951
|
+
}
|
|
6952
|
+
export interface InsightStockScreenerQuoteV2 {
|
|
6953
|
+
average_volume_30d: number;
|
|
6954
|
+
company_name: string;
|
|
6955
|
+
dividend_ex_date: string;
|
|
6956
|
+
dividend_pay_date: string;
|
|
6957
|
+
dividend_percent: number;
|
|
6958
|
+
exchange: string;
|
|
6959
|
+
exchange_name: string;
|
|
6960
|
+
gap: number;
|
|
6961
|
+
industry: string;
|
|
6962
|
+
industry_code: string;
|
|
6963
|
+
last_price: number;
|
|
6964
|
+
market_cap: number;
|
|
6965
|
+
pe_ratio: number;
|
|
6966
|
+
price_change: number;
|
|
6967
|
+
price_change_percent: number;
|
|
6968
|
+
symbol: string;
|
|
6969
|
+
volume: number;
|
|
6970
|
+
}
|
|
6971
|
+
export interface InsightStockScreenerRequestV2 {
|
|
6972
|
+
average_volume_30d?: InsightLessAndMoreV2;
|
|
6973
|
+
dividend_ex_date?: InsightBeforeAndAfterV2;
|
|
6974
|
+
dividend_pay_date?: InsightBeforeAndAfterV2;
|
|
6975
|
+
dividend_percent?: InsightLessAndMoreV2;
|
|
6976
|
+
exchange?: InsightIncludeExcludeV2;
|
|
6977
|
+
gap?: InsightLessAndMoreV2;
|
|
6978
|
+
industry?: InsightIncludeExcludeV2;
|
|
6979
|
+
market_cap?: InsightLessAndMoreV2;
|
|
6980
|
+
pagination: InsightPaginationV2;
|
|
6981
|
+
pe_ratio?: InsightLessAndMoreV2;
|
|
6982
|
+
price?: InsightLessAndMoreV2;
|
|
6983
|
+
sorts?: InsightOrderingV2[];
|
|
6984
|
+
/** @example "ADR" */
|
|
6985
|
+
stock_type?: string;
|
|
6986
|
+
volume?: InsightLessAndMoreV2;
|
|
6987
|
+
}
|
|
6988
|
+
export interface InsightStockScreenerResponseV2 {
|
|
6989
|
+
current_page: number;
|
|
6990
|
+
data: InsightStockScreenerQuoteV2[];
|
|
6991
|
+
page_count: number;
|
|
6992
|
+
status: number;
|
|
6993
|
+
total_records: number;
|
|
6994
|
+
}
|
|
6995
|
+
/**
|
|
6996
|
+
* @default "asc"
|
|
6997
|
+
* @example "asc"
|
|
6998
|
+
*/
|
|
6999
|
+
export enum InsightOrderingDirectionEnumV2 {
|
|
7000
|
+
Asc = "asc",
|
|
7001
|
+
Desc = "desc"
|
|
7002
|
+
}
|
|
7003
|
+
export class FixedIncomeV2<HandleError extends boolean = boolean> {
|
|
7004
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
7005
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
7006
|
+
/**
|
|
7007
|
+
* @description get fixed income entries
|
|
7008
|
+
* @tags FixedIncome
|
|
7009
|
+
* @name GetFixedIncomeEntries
|
|
7010
|
+
* @summary get fixed income entries
|
|
7011
|
+
* @request POST:/fixed-income
|
|
6743
7012
|
* @secure
|
|
6744
7013
|
*/
|
|
6745
|
-
|
|
7014
|
+
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
|
|
7015
|
+
}
|
|
7016
|
+
export class StockScreenerV2<HandleError extends boolean = boolean> {
|
|
7017
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
7018
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6746
7019
|
/**
|
|
6747
|
-
* @description
|
|
6748
|
-
* @tags
|
|
6749
|
-
* @name
|
|
6750
|
-
* @summary
|
|
6751
|
-
* @request POST:/
|
|
7020
|
+
* @description filter stocks by params
|
|
7021
|
+
* @tags StockScreener
|
|
7022
|
+
* @name StockScreener
|
|
7023
|
+
* @summary filter stocks by params
|
|
7024
|
+
* @request POST:/stock-screener
|
|
6752
7025
|
* @secure
|
|
6753
7026
|
*/
|
|
6754
|
-
|
|
7027
|
+
stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
6755
7028
|
/**
|
|
6756
|
-
* @description
|
|
6757
|
-
* @tags
|
|
6758
|
-
* @name
|
|
6759
|
-
* @summary
|
|
6760
|
-
* @request
|
|
7029
|
+
* @description get top symbols
|
|
7030
|
+
* @tags StockScreener
|
|
7031
|
+
* @name GetTopSymbols
|
|
7032
|
+
* @summary get top symbols
|
|
7033
|
+
* @request POST:/stock-screener/top
|
|
6761
7034
|
* @secure
|
|
6762
7035
|
*/
|
|
6763
|
-
|
|
6764
|
-
/** region id */
|
|
6765
|
-
id: string;
|
|
6766
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
7036
|
+
getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
6767
7037
|
}
|
|
6768
7038
|
export class InsightApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
6769
7039
|
readonly config: JwtClientConfig<HandleError>;
|