@orbis-systems/orbis-api-clients 0.8.2 → 0.8.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/aesmidas/index.d.ts +281 -261
- package/dist/aesmidas/index.d.ts.map +1 -1
- package/dist/aesmidas/index.esm.js +1 -1
- package/dist/aesmidas/index.esm.js.map +1 -1
- package/dist/aesmidas/index.js +1 -1
- package/dist/aesmidas/index.js.map +1 -1
- package/dist/bridgewise/index.d.ts +6196 -6218
- 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/index.esm.js +1 -1
- package/dist/index.esm.js.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/insight/index.d.ts +1130 -1130
- 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 +80 -80
- 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 +4034 -4034
- 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 +1092 -981
- 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/package.json +1 -1
package/dist/insight/index.d.ts
CHANGED
|
@@ -78,6 +78,69 @@ declare class JwtClient<HandleError extends boolean = boolean, AuthData extends
|
|
|
78
78
|
protected prepareAuthRequestConfig(): Promise<Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>>;
|
|
79
79
|
protected renewTokens(): Promise<AuthData>;
|
|
80
80
|
}
|
|
81
|
+
export enum InsightTrendingType {
|
|
82
|
+
TrendingTypeMostRated = "most-rated",
|
|
83
|
+
TrendingTypeBestRated = "best-rated",
|
|
84
|
+
TrendingTypeWorstRated = "worst-rated"
|
|
85
|
+
}
|
|
86
|
+
export enum InsightPeriodType {
|
|
87
|
+
PeriodDay = "day",
|
|
88
|
+
PeriodWeek = "week",
|
|
89
|
+
PeriodMonth = "month",
|
|
90
|
+
PeriodYear = "year"
|
|
91
|
+
}
|
|
92
|
+
export enum InsightOrderDirection {
|
|
93
|
+
OrderASC = "asc",
|
|
94
|
+
OrderDESC = "desc"
|
|
95
|
+
}
|
|
96
|
+
export enum InsightMostPopularTagsTypesType {
|
|
97
|
+
MostPopularTagsTypesTypeSymbol = "symbol",
|
|
98
|
+
MostPopularTagsTypesTypePrimary = "primary",
|
|
99
|
+
MostPopularTagsTypesTypeTags = "tags"
|
|
100
|
+
}
|
|
101
|
+
export enum InsightMostPopularTagsTimeType {
|
|
102
|
+
MostPopularTagsTimeTypeWeek = "week",
|
|
103
|
+
MostPopularTagsTimeTypeMonth = "month",
|
|
104
|
+
MostPopularTagsTimeTypeYear = "year"
|
|
105
|
+
}
|
|
106
|
+
export enum InsightLatestAnalystRatingsOnStockSort {
|
|
107
|
+
LatestAnalystRatingsOnStockSortDate = "date",
|
|
108
|
+
LatestAnalystRatingsOnStockSortRank = "rank"
|
|
109
|
+
}
|
|
110
|
+
export enum InsightIpoStatus {
|
|
111
|
+
PricedIpoStatus = "Priced",
|
|
112
|
+
FiledIpoStatus = "Filed",
|
|
113
|
+
WithdrawnIpoStatus = "Withdrawn",
|
|
114
|
+
PostponedIpoStatus = "Postponed"
|
|
115
|
+
}
|
|
116
|
+
export enum InsightFilterType {
|
|
117
|
+
FilterAnalysts = "analysts",
|
|
118
|
+
FilterBloggers = "bloggers"
|
|
119
|
+
}
|
|
120
|
+
export enum InsightConversion {
|
|
121
|
+
ConversionOriginal = "original",
|
|
122
|
+
ConversionDefault = "default",
|
|
123
|
+
ConversionNormal = "normal",
|
|
124
|
+
ConversionThumbnail = "thumbnail",
|
|
125
|
+
ConversionSquare = "square",
|
|
126
|
+
ConversionSquareStrict = "square_strict",
|
|
127
|
+
ConversionSquareStrictOrNormal = "square_strict_or_normal",
|
|
128
|
+
ConversionBestMatch = "best_match"
|
|
129
|
+
}
|
|
130
|
+
export enum InsightConsensusInterval {
|
|
131
|
+
ConsensusIntervalWeek = "week",
|
|
132
|
+
ConsensusIntervalMonth = "month"
|
|
133
|
+
}
|
|
134
|
+
export enum InsightArticlesRequestType {
|
|
135
|
+
ArticlesRequestTypeEducation = "education",
|
|
136
|
+
ArticlesRequestTypeNonEducation = "non-education"
|
|
137
|
+
}
|
|
138
|
+
export enum InsightArticleSearchType {
|
|
139
|
+
ArticleSearchTypeAll = "all",
|
|
140
|
+
ArticleSearchTypeTag = "tag",
|
|
141
|
+
ArticleSearchTypePrimary = "primary",
|
|
142
|
+
ArticleSearchTypeSymbol = "symbol"
|
|
143
|
+
}
|
|
81
144
|
export interface InsightQuote {
|
|
82
145
|
ask_px: number;
|
|
83
146
|
ask_sz: number;
|
|
@@ -268,12 +331,6 @@ export interface InsightArticleFeaturedImageInfo {
|
|
|
268
331
|
url: string;
|
|
269
332
|
width: number;
|
|
270
333
|
}
|
|
271
|
-
export enum InsightArticleSearchType {
|
|
272
|
-
ArticleSearchTypeAll = "all",
|
|
273
|
-
ArticleSearchTypeTag = "tag",
|
|
274
|
-
ArticleSearchTypePrimary = "primary",
|
|
275
|
-
ArticleSearchTypeSymbol = "symbol"
|
|
276
|
-
}
|
|
277
334
|
export interface InsightArticlesRequest {
|
|
278
335
|
/** @example 10 */
|
|
279
336
|
count?: number;
|
|
@@ -292,10 +349,6 @@ export interface InsightArticlesRequest {
|
|
|
292
349
|
/** @example "education" */
|
|
293
350
|
type?: InsightArticlesRequestType;
|
|
294
351
|
}
|
|
295
|
-
export enum InsightArticlesRequestType {
|
|
296
|
-
ArticlesRequestTypeEducation = "education",
|
|
297
|
-
ArticlesRequestTypeNonEducation = "non-education"
|
|
298
|
-
}
|
|
299
352
|
export interface InsightAssetAllocationBreakdown {
|
|
300
353
|
breakdown: string;
|
|
301
354
|
percentage: number;
|
|
@@ -530,10 +583,6 @@ export interface InsightConfidenceSignal {
|
|
|
530
583
|
/** @format float32 */
|
|
531
584
|
stockScore: number;
|
|
532
585
|
}
|
|
533
|
-
export enum InsightConsensusInterval {
|
|
534
|
-
ConsensusIntervalWeek = "week",
|
|
535
|
-
ConsensusIntervalMonth = "month"
|
|
536
|
-
}
|
|
537
586
|
export interface InsightContinent {
|
|
538
587
|
id: string;
|
|
539
588
|
name: string;
|
|
@@ -543,16 +592,6 @@ export interface InsightContinentBreakdown {
|
|
|
543
592
|
code: string;
|
|
544
593
|
percentage: number;
|
|
545
594
|
}
|
|
546
|
-
export enum InsightConversion {
|
|
547
|
-
ConversionOriginal = "original",
|
|
548
|
-
ConversionDefault = "default",
|
|
549
|
-
ConversionNormal = "normal",
|
|
550
|
-
ConversionThumbnail = "thumbnail",
|
|
551
|
-
ConversionSquare = "square",
|
|
552
|
-
ConversionSquareStrict = "square_strict",
|
|
553
|
-
ConversionSquareStrictOrNormal = "square_strict_or_normal",
|
|
554
|
-
ConversionBestMatch = "best_match"
|
|
555
|
-
}
|
|
556
595
|
export interface InsightCountryBreakdown {
|
|
557
596
|
breakdown: string;
|
|
558
597
|
percentage: number;
|
|
@@ -866,10 +905,6 @@ export interface InsightFilterCustomIndexesRequest {
|
|
|
866
905
|
paging: InsightPaging;
|
|
867
906
|
symbols?: string[];
|
|
868
907
|
}
|
|
869
|
-
export enum InsightFilterType {
|
|
870
|
-
FilterAnalysts = "analysts",
|
|
871
|
-
FilterBloggers = "bloggers"
|
|
872
|
-
}
|
|
873
908
|
export interface InsightFilteredCustomIndexResponse {
|
|
874
909
|
created_at?: string;
|
|
875
910
|
description?: string;
|
|
@@ -3075,12 +3110,6 @@ export interface InsightInvestorsAlsoBought {
|
|
|
3075
3110
|
sentiment: string;
|
|
3076
3111
|
ticker: string;
|
|
3077
3112
|
}
|
|
3078
|
-
export enum InsightIpoStatus {
|
|
3079
|
-
PricedIpoStatus = "Priced",
|
|
3080
|
-
FiledIpoStatus = "Filed",
|
|
3081
|
-
WithdrawnIpoStatus = "Withdrawn",
|
|
3082
|
-
PostponedIpoStatus = "Postponed"
|
|
3083
|
-
}
|
|
3084
3113
|
export interface InsightLatestAnalystRatingsOnStockRequest {
|
|
3085
3114
|
/** Get analyst ratings from the past X months (OPTIONAL) */
|
|
3086
3115
|
months?: number;
|
|
@@ -3124,10 +3153,6 @@ export interface InsightLatestAnalystRatingsOnStockResponse {
|
|
|
3124
3153
|
total_recommendations: number;
|
|
3125
3154
|
url: string;
|
|
3126
3155
|
}
|
|
3127
|
-
export enum InsightLatestAnalystRatingsOnStockSort {
|
|
3128
|
-
LatestAnalystRatingsOnStockSortDate = "date",
|
|
3129
|
-
LatestAnalystRatingsOnStockSortRank = "rank"
|
|
3130
|
-
}
|
|
3131
3156
|
export interface InsightLessAndMore {
|
|
3132
3157
|
less_than?: number;
|
|
3133
3158
|
more_than?: number;
|
|
@@ -3285,16 +3310,6 @@ export interface InsightMostPopularTagsRequest {
|
|
|
3285
3310
|
/** @example "symbol" */
|
|
3286
3311
|
type: InsightMostPopularTagsTypesType;
|
|
3287
3312
|
}
|
|
3288
|
-
export enum InsightMostPopularTagsTimeType {
|
|
3289
|
-
MostPopularTagsTimeTypeWeek = "week",
|
|
3290
|
-
MostPopularTagsTimeTypeMonth = "month",
|
|
3291
|
-
MostPopularTagsTimeTypeYear = "year"
|
|
3292
|
-
}
|
|
3293
|
-
export enum InsightMostPopularTagsTypesType {
|
|
3294
|
-
MostPopularTagsTypesTypeSymbol = "symbol",
|
|
3295
|
-
MostPopularTagsTypesTypePrimary = "primary",
|
|
3296
|
-
MostPopularTagsTypesTypeTags = "tags"
|
|
3297
|
-
}
|
|
3298
3313
|
export interface InsightMover {
|
|
3299
3314
|
company_name: string;
|
|
3300
3315
|
ticker: string;
|
|
@@ -3478,10 +3493,6 @@ export interface InsightOptionValues {
|
|
|
3478
3493
|
option_value: number;
|
|
3479
3494
|
time_value: number;
|
|
3480
3495
|
}
|
|
3481
|
-
export enum InsightOrderDirection {
|
|
3482
|
-
OrderASC = "asc",
|
|
3483
|
-
OrderDESC = "desc"
|
|
3484
|
-
}
|
|
3485
3496
|
export interface InsightOrdering {
|
|
3486
3497
|
/**
|
|
3487
3498
|
* @default "asc"
|
|
@@ -3557,12 +3568,6 @@ export interface InsightPeriodFilter {
|
|
|
3557
3568
|
*/
|
|
3558
3569
|
value: number;
|
|
3559
3570
|
}
|
|
3560
|
-
export enum InsightPeriodType {
|
|
3561
|
-
PeriodDay = "day",
|
|
3562
|
-
PeriodWeek = "week",
|
|
3563
|
-
PeriodMonth = "month",
|
|
3564
|
-
PeriodYear = "year"
|
|
3565
|
-
}
|
|
3566
3571
|
export interface InsightPortfoliosRequest {
|
|
3567
3572
|
/** (REQUIRED) */
|
|
3568
3573
|
expert_uid?: string;
|
|
@@ -4069,6 +4074,7 @@ export interface InsightStockScreenerRequest {
|
|
|
4069
4074
|
paging?: InsightPaging;
|
|
4070
4075
|
pe_ratio?: InsightLessAndMore;
|
|
4071
4076
|
price?: InsightLessAndMore;
|
|
4077
|
+
price_change_percent?: InsightLessAndMore;
|
|
4072
4078
|
sorts?: InsightOrdering[];
|
|
4073
4079
|
/** @example "ADR" */
|
|
4074
4080
|
stock_type?: string;
|
|
@@ -4091,6 +4097,7 @@ export interface InsightStockScreenerV1Request {
|
|
|
4091
4097
|
paging: InsightPaging;
|
|
4092
4098
|
pe_ratio?: InsightLessAndMore;
|
|
4093
4099
|
price?: InsightLessAndMore;
|
|
4100
|
+
price_change_percent?: InsightLessAndMore;
|
|
4094
4101
|
/** @example "ADR" */
|
|
4095
4102
|
stock_type?: string;
|
|
4096
4103
|
volume?: InsightLessAndMore;
|
|
@@ -4341,11 +4348,6 @@ export interface InsightTrendingStocksResponse {
|
|
|
4341
4348
|
sentiment: number;
|
|
4342
4349
|
ticker: string;
|
|
4343
4350
|
}
|
|
4344
|
-
export enum InsightTrendingType {
|
|
4345
|
-
TrendingTypeMostRated = "most-rated",
|
|
4346
|
-
TrendingTypeBestRated = "best-rated",
|
|
4347
|
-
TrendingTypeWorstRated = "worst-rated"
|
|
4348
|
-
}
|
|
4349
4351
|
export interface InsightUnderwriteResponse {
|
|
4350
4352
|
company_name: string;
|
|
4351
4353
|
id: number;
|
|
@@ -4803,6 +4805,28 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
|
|
|
4803
4805
|
Date = "date",
|
|
4804
4806
|
Rank = "rank"
|
|
4805
4807
|
}
|
|
4808
|
+
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
4809
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4810
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4811
|
+
/**
|
|
4812
|
+
* @description get seasonlity data with comparison to benchmark
|
|
4813
|
+
* @tags AlphaTools
|
|
4814
|
+
* @name GetMomentumRatioGraph
|
|
4815
|
+
* @summary get seasonlity data
|
|
4816
|
+
* @request POST:/rst
|
|
4817
|
+
* @secure
|
|
4818
|
+
*/
|
|
4819
|
+
getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
|
|
4820
|
+
/**
|
|
4821
|
+
* @description get seasonlity data with comparison to benchmark
|
|
4822
|
+
* @tags AlphaTools
|
|
4823
|
+
* @name GetSeasonality
|
|
4824
|
+
* @summary get seasonlity data
|
|
4825
|
+
* @request POST:/seasonality
|
|
4826
|
+
* @secure
|
|
4827
|
+
*/
|
|
4828
|
+
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
|
|
4829
|
+
}
|
|
4806
4830
|
export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
4807
4831
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4808
4832
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4842,265 +4866,83 @@ export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
|
4842
4866
|
*/
|
|
4843
4867
|
getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
|
|
4844
4868
|
}
|
|
4845
|
-
export class
|
|
4869
|
+
export class CustomLists<HandleError extends boolean = boolean> {
|
|
4846
4870
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4847
4871
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4848
4872
|
/**
|
|
4849
|
-
* @description
|
|
4850
|
-
* @tags
|
|
4851
|
-
* @name
|
|
4852
|
-
* @summary
|
|
4853
|
-
* @request GET:/
|
|
4873
|
+
* @description get custom lists
|
|
4874
|
+
* @tags Custom Lists
|
|
4875
|
+
* @name GetCustomLists
|
|
4876
|
+
* @summary get custom lists
|
|
4877
|
+
* @request GET:/custom-lists
|
|
4854
4878
|
* @secure
|
|
4855
4879
|
*/
|
|
4856
|
-
|
|
4857
|
-
/**
|
|
4880
|
+
getCustomLists(query: {
|
|
4881
|
+
/** how many records to return. Max value is 50 */
|
|
4858
4882
|
limit: number;
|
|
4859
|
-
/**
|
|
4883
|
+
/** how many records to skip */
|
|
4860
4884
|
offset: number;
|
|
4861
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4885
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
4862
4886
|
/**
|
|
4863
|
-
* @description
|
|
4864
|
-
* @tags
|
|
4865
|
-
* @name
|
|
4866
|
-
* @summary
|
|
4867
|
-
* @request PUT:/
|
|
4887
|
+
* @description update custom list
|
|
4888
|
+
* @tags Custom Lists
|
|
4889
|
+
* @name UpdateCustomList
|
|
4890
|
+
* @summary update custom list
|
|
4891
|
+
* @request PUT:/custom-lists
|
|
4868
4892
|
* @secure
|
|
4869
4893
|
*/
|
|
4870
|
-
|
|
4894
|
+
updateCustomList(filter: InsightUpdateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
|
|
4871
4895
|
/**
|
|
4872
|
-
* @description
|
|
4873
|
-
* @tags
|
|
4874
|
-
* @name
|
|
4875
|
-
* @summary
|
|
4876
|
-
* @request POST:/
|
|
4896
|
+
* @description create custom list
|
|
4897
|
+
* @tags Custom Lists
|
|
4898
|
+
* @name CreateCustomList
|
|
4899
|
+
* @summary create custom list
|
|
4900
|
+
* @request POST:/custom-lists
|
|
4877
4901
|
* @secure
|
|
4878
4902
|
*/
|
|
4879
|
-
|
|
4903
|
+
createCustomList(filter: InsightCreateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
|
|
4880
4904
|
/**
|
|
4881
|
-
* @description
|
|
4882
|
-
* @tags
|
|
4883
|
-
* @name
|
|
4884
|
-
* @summary
|
|
4885
|
-
* @request DELETE:/
|
|
4905
|
+
* @description remove custom list
|
|
4906
|
+
* @tags Custom Lists
|
|
4907
|
+
* @name RemoveCustomList
|
|
4908
|
+
* @summary remove custom list
|
|
4909
|
+
* @request DELETE:/custom-lists
|
|
4886
4910
|
* @secure
|
|
4887
4911
|
*/
|
|
4888
|
-
|
|
4889
|
-
/** continent id */
|
|
4890
|
-
id: string;
|
|
4891
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4912
|
+
removeCustomList(filter: InsightRemoveCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4892
4913
|
/**
|
|
4893
|
-
* @description
|
|
4894
|
-
* @tags
|
|
4895
|
-
* @name
|
|
4896
|
-
* @summary
|
|
4897
|
-
* @request
|
|
4914
|
+
* @description filter custom lists
|
|
4915
|
+
* @tags Custom Lists
|
|
4916
|
+
* @name FilterCustomLists
|
|
4917
|
+
* @summary filter custom lists
|
|
4918
|
+
* @request POST:/custom-lists/filter
|
|
4898
4919
|
* @secure
|
|
4899
4920
|
*/
|
|
4900
|
-
|
|
4901
|
-
/** Query limit */
|
|
4902
|
-
limit: number;
|
|
4903
|
-
/** Query offset */
|
|
4904
|
-
offset: number;
|
|
4905
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
4921
|
+
filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
4906
4922
|
/**
|
|
4907
|
-
* @description
|
|
4908
|
-
* @tags
|
|
4909
|
-
* @name
|
|
4910
|
-
* @summary
|
|
4911
|
-
* @request
|
|
4923
|
+
* @description get custom list with quotes
|
|
4924
|
+
* @tags Custom Lists
|
|
4925
|
+
* @name GetCustomListWithQuotes
|
|
4926
|
+
* @summary get custom list with quotes
|
|
4927
|
+
* @request GET:/custom-lists/{id-or-slug}
|
|
4912
4928
|
* @secure
|
|
4913
4929
|
*/
|
|
4914
|
-
|
|
4930
|
+
getCustomListWithQuotes(idOrSlug: string, query: {
|
|
4931
|
+
/** sort direction - asc or desc */
|
|
4932
|
+
order_direction: string;
|
|
4933
|
+
/** sort field - volume, symbol(alphabetical), market_cap, dividend_percent */
|
|
4934
|
+
order_field: string;
|
|
4935
|
+
/** how many equities records to return. Max value is 50 */
|
|
4936
|
+
limit: number;
|
|
4937
|
+
/** how many equities records to skip */
|
|
4938
|
+
offset: number;
|
|
4939
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
4915
4940
|
/**
|
|
4916
|
-
* @description
|
|
4917
|
-
* @tags
|
|
4918
|
-
* @name
|
|
4919
|
-
* @summary
|
|
4920
|
-
* @request
|
|
4921
|
-
* @secure
|
|
4922
|
-
*/
|
|
4923
|
-
countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
4924
|
-
/**
|
|
4925
|
-
* @description Delete country code
|
|
4926
|
-
* @tags World Markets
|
|
4927
|
-
* @name CountryCodeDelete
|
|
4928
|
-
* @summary Delete country code
|
|
4929
|
-
* @request DELETE:/country-codes
|
|
4930
|
-
* @secure
|
|
4931
|
-
*/
|
|
4932
|
-
countryCodeDelete(query: {
|
|
4933
|
-
/** a3 code */
|
|
4934
|
-
a3code: string;
|
|
4935
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4936
|
-
/**
|
|
4937
|
-
* @description Get global indexes
|
|
4938
|
-
* @tags World Markets
|
|
4939
|
-
* @name GlobalIndexGet
|
|
4940
|
-
* @summary Get global indexes
|
|
4941
|
-
* @request GET:/global-indexes
|
|
4942
|
-
* @secure
|
|
4943
|
-
*/
|
|
4944
|
-
globalIndexGet(query: {
|
|
4945
|
-
/** Query limit */
|
|
4946
|
-
limit: number;
|
|
4947
|
-
/** Query offset */
|
|
4948
|
-
offset: number;
|
|
4949
|
-
/** Continent code for filtering */
|
|
4950
|
-
continent?: string;
|
|
4951
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
4952
|
-
/**
|
|
4953
|
-
* @description Edit global index
|
|
4954
|
-
* @tags World Markets
|
|
4955
|
-
* @name GlobalIndexEdit
|
|
4956
|
-
* @summary Edit global index
|
|
4957
|
-
* @request PUT:/global-indexes
|
|
4958
|
-
* @secure
|
|
4959
|
-
*/
|
|
4960
|
-
globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4961
|
-
/**
|
|
4962
|
-
* @description Add global indexes
|
|
4963
|
-
* @tags World Markets
|
|
4964
|
-
* @name GlobalIndexAdd
|
|
4965
|
-
* @summary Add global indexes
|
|
4966
|
-
* @request POST:/global-indexes
|
|
4967
|
-
* @secure
|
|
4968
|
-
*/
|
|
4969
|
-
globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
4970
|
-
/**
|
|
4971
|
-
* @description Edit global index
|
|
4972
|
-
* @tags World Markets
|
|
4973
|
-
* @name GlobalIndexDelete
|
|
4974
|
-
* @summary Delete global index
|
|
4975
|
-
* @request DELETE:/global-indexes
|
|
4976
|
-
* @secure
|
|
4977
|
-
*/
|
|
4978
|
-
globalIndexDelete(query: {
|
|
4979
|
-
/** a3 code */
|
|
4980
|
-
a3code: string;
|
|
4981
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4982
|
-
/**
|
|
4983
|
-
* @description Get regions
|
|
4984
|
-
* @tags World Markets
|
|
4985
|
-
* @name RegionGet
|
|
4986
|
-
* @summary Get regions
|
|
4987
|
-
* @request GET:/regions
|
|
4988
|
-
* @secure
|
|
4989
|
-
*/
|
|
4990
|
-
regionGet(query: {
|
|
4991
|
-
/** Query limit */
|
|
4992
|
-
limit: number;
|
|
4993
|
-
/** Query offset */
|
|
4994
|
-
offset: number;
|
|
4995
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
4996
|
-
/**
|
|
4997
|
-
* @description Edit region
|
|
4998
|
-
* @tags World Markets
|
|
4999
|
-
* @name RegionEdit
|
|
5000
|
-
* @summary Edit region
|
|
5001
|
-
* @request PUT:/regions
|
|
5002
|
-
* @secure
|
|
5003
|
-
*/
|
|
5004
|
-
regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5005
|
-
/**
|
|
5006
|
-
* @description Create regions
|
|
5007
|
-
* @tags World Markets
|
|
5008
|
-
* @name RegionCreate
|
|
5009
|
-
* @summary Create regions
|
|
5010
|
-
* @request POST:/regions
|
|
5011
|
-
* @secure
|
|
5012
|
-
*/
|
|
5013
|
-
regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
5014
|
-
/**
|
|
5015
|
-
* @description Delete region
|
|
5016
|
-
* @tags World Markets
|
|
5017
|
-
* @name RegionDelete
|
|
5018
|
-
* @summary Delete region
|
|
5019
|
-
* @request DELETE:/regions
|
|
5020
|
-
* @secure
|
|
5021
|
-
*/
|
|
5022
|
-
regionDelete(query: {
|
|
5023
|
-
/** region id */
|
|
5024
|
-
id: string;
|
|
5025
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5026
|
-
}
|
|
5027
|
-
export class CustomLists<HandleError extends boolean = boolean> {
|
|
5028
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5029
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5030
|
-
/**
|
|
5031
|
-
* @description get custom lists
|
|
5032
|
-
* @tags Custom Lists
|
|
5033
|
-
* @name GetCustomLists
|
|
5034
|
-
* @summary get custom lists
|
|
5035
|
-
* @request GET:/custom-lists
|
|
5036
|
-
* @secure
|
|
5037
|
-
*/
|
|
5038
|
-
getCustomLists(query: {
|
|
5039
|
-
/** how many records to return. Max value is 50 */
|
|
5040
|
-
limit: number;
|
|
5041
|
-
/** how many records to skip */
|
|
5042
|
-
offset: number;
|
|
5043
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
5044
|
-
/**
|
|
5045
|
-
* @description update custom list
|
|
5046
|
-
* @tags Custom Lists
|
|
5047
|
-
* @name UpdateCustomList
|
|
5048
|
-
* @summary update custom list
|
|
5049
|
-
* @request PUT:/custom-lists
|
|
5050
|
-
* @secure
|
|
5051
|
-
*/
|
|
5052
|
-
updateCustomList(filter: InsightUpdateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
|
|
5053
|
-
/**
|
|
5054
|
-
* @description create custom list
|
|
5055
|
-
* @tags Custom Lists
|
|
5056
|
-
* @name CreateCustomList
|
|
5057
|
-
* @summary create custom list
|
|
5058
|
-
* @request POST:/custom-lists
|
|
5059
|
-
* @secure
|
|
5060
|
-
*/
|
|
5061
|
-
createCustomList(filter: InsightCreateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
|
|
5062
|
-
/**
|
|
5063
|
-
* @description remove custom list
|
|
5064
|
-
* @tags Custom Lists
|
|
5065
|
-
* @name RemoveCustomList
|
|
5066
|
-
* @summary remove custom list
|
|
5067
|
-
* @request DELETE:/custom-lists
|
|
5068
|
-
* @secure
|
|
5069
|
-
*/
|
|
5070
|
-
removeCustomList(filter: InsightRemoveCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5071
|
-
/**
|
|
5072
|
-
* @description filter custom lists
|
|
5073
|
-
* @tags Custom Lists
|
|
5074
|
-
* @name FilterCustomLists
|
|
5075
|
-
* @summary filter custom lists
|
|
5076
|
-
* @request POST:/custom-lists/filter
|
|
5077
|
-
* @secure
|
|
5078
|
-
*/
|
|
5079
|
-
filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
5080
|
-
/**
|
|
5081
|
-
* @description get custom list with quotes
|
|
5082
|
-
* @tags Custom Lists
|
|
5083
|
-
* @name GetCustomListWithQuotes
|
|
5084
|
-
* @summary get custom list with quotes
|
|
5085
|
-
* @request GET:/custom-lists/{id-or-slug}
|
|
5086
|
-
* @secure
|
|
5087
|
-
*/
|
|
5088
|
-
getCustomListWithQuotes(idOrSlug: string, query: {
|
|
5089
|
-
/** sort direction - asc or desc */
|
|
5090
|
-
order_direction: string;
|
|
5091
|
-
/** sort field - volume, symbol(alphabetical), market_cap, dividend_percent */
|
|
5092
|
-
order_field: string;
|
|
5093
|
-
/** how many equities records to return. Max value is 50 */
|
|
5094
|
-
limit: number;
|
|
5095
|
-
/** how many equities records to skip */
|
|
5096
|
-
offset: number;
|
|
5097
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
5098
|
-
/**
|
|
5099
|
-
* @description filter custom list
|
|
5100
|
-
* @tags Custom Lists
|
|
5101
|
-
* @name FilterCustomList
|
|
5102
|
-
* @summary filter custom list
|
|
5103
|
-
* @request GET:/custom-lists/{id-or-slug}/filter
|
|
4941
|
+
* @description filter custom list
|
|
4942
|
+
* @tags Custom Lists
|
|
4943
|
+
* @name FilterCustomList
|
|
4944
|
+
* @summary filter custom list
|
|
4945
|
+
* @request GET:/custom-lists/{id-or-slug}/filter
|
|
5104
4946
|
* @secure
|
|
5105
4947
|
*/
|
|
5106
4948
|
filterCustomList(idOrSlug: string, query?: {
|
|
@@ -5311,567 +5153,388 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
5311
5153
|
*/
|
|
5312
5154
|
getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
|
|
5313
5155
|
}
|
|
5314
|
-
export
|
|
5315
|
-
|
|
5316
|
-
|
|
5317
|
-
/**
|
|
5318
|
-
* @description get fundamentals by symbol data
|
|
5319
|
-
* @tags Fundamentals
|
|
5320
|
-
* @name GetFundamentalsBySymbolData
|
|
5321
|
-
* @summary get fundamentals by symbol data
|
|
5322
|
-
* @request POST:/fundamentals
|
|
5323
|
-
* @secure
|
|
5324
|
-
*/
|
|
5325
|
-
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
5156
|
+
export enum InsightOrderDirectionV2 {
|
|
5157
|
+
OrderASC = "asc",
|
|
5158
|
+
OrderDESC = "desc"
|
|
5326
5159
|
}
|
|
5327
|
-
export
|
|
5328
|
-
|
|
5329
|
-
|
|
5330
|
-
/**
|
|
5331
|
-
* @description get fund details
|
|
5332
|
-
* @tags Funds
|
|
5333
|
-
* @name GetFundDetails
|
|
5334
|
-
* @summary get fund details
|
|
5335
|
-
* @request GET:/funds/details
|
|
5336
|
-
* @secure
|
|
5337
|
-
*/
|
|
5338
|
-
getFundDetails(query: {
|
|
5339
|
-
/** Fund symbol */
|
|
5340
|
-
symbol: string;
|
|
5341
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundDetailsResponse, HandleError>>;
|
|
5342
|
-
/**
|
|
5343
|
-
* @description get funds for holding
|
|
5344
|
-
* @tags Funds
|
|
5345
|
-
* @name GetFundsForHolding
|
|
5346
|
-
* @summary get funds for holding
|
|
5347
|
-
* @request POST:/funds/funds-for-holding
|
|
5348
|
-
* @secure
|
|
5349
|
-
*/
|
|
5350
|
-
getFundsForHolding(filter: InsightGetFundsForHoldingRequest, headers?: {
|
|
5351
|
-
/** Authorization */
|
|
5352
|
-
Authorization?: string;
|
|
5353
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundsForHoldingResponse, HandleError>>;
|
|
5354
|
-
/**
|
|
5355
|
-
* @description filter funds by params
|
|
5356
|
-
* @tags Funds
|
|
5357
|
-
* @name FundScreener
|
|
5358
|
-
* @summary filter funds by params
|
|
5359
|
-
* @request POST:/funds/screener
|
|
5360
|
-
* @secure
|
|
5361
|
-
*/
|
|
5362
|
-
fundScreener(filter: InsightFundScreenerRequest, headers?: {
|
|
5363
|
-
/** Authorization */
|
|
5364
|
-
Authorization?: string;
|
|
5365
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
|
|
5366
|
-
/**
|
|
5367
|
-
* @description get fund screener filters
|
|
5368
|
-
* @tags Funds
|
|
5369
|
-
* @name GetScreenerFilters
|
|
5370
|
-
* @summary get fund screener filters
|
|
5371
|
-
* @request GET:/funds/screener/filters
|
|
5372
|
-
* @secure
|
|
5373
|
-
*/
|
|
5374
|
-
getScreenerFilters(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundScreenerFiltersResponse, HandleError>>;
|
|
5375
|
-
/**
|
|
5376
|
-
* @description get fund screener presets
|
|
5377
|
-
* @tags Funds
|
|
5378
|
-
* @name GetFundScreenerPresets
|
|
5379
|
-
* @summary get fund screener presets
|
|
5380
|
-
* @request GET:/funds/screener/presets
|
|
5381
|
-
* @secure
|
|
5382
|
-
*/
|
|
5383
|
-
getFundScreenerPresets(query: {
|
|
5384
|
-
/** how many records to return */
|
|
5385
|
-
limit: number;
|
|
5386
|
-
/** how many records to skip */
|
|
5387
|
-
offset: number;
|
|
5388
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
5389
|
-
/**
|
|
5390
|
-
* @description update fund screener preset
|
|
5391
|
-
* @tags Funds
|
|
5392
|
-
* @name UpdateFundScreenerPreset
|
|
5393
|
-
* @summary update fund screener preset
|
|
5394
|
-
* @request PUT:/funds/screener/presets
|
|
5395
|
-
* @secure
|
|
5396
|
-
*/
|
|
5397
|
-
updateFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5398
|
-
/**
|
|
5399
|
-
* @description create fund screener preset
|
|
5400
|
-
* @tags Funds
|
|
5401
|
-
* @name CreateFundScreenerPreset
|
|
5402
|
-
* @summary create fund screener preset
|
|
5403
|
-
* @request POST:/funds/screener/presets
|
|
5404
|
-
* @secure
|
|
5405
|
-
*/
|
|
5406
|
-
createFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5407
|
-
/**
|
|
5408
|
-
* @description remove fund screener preset
|
|
5409
|
-
* @tags Funds
|
|
5410
|
-
* @name RemoveFundScreenerPreset
|
|
5411
|
-
* @summary remove fund screener preset
|
|
5412
|
-
* @request DELETE:/funds/screener/presets
|
|
5413
|
-
* @secure
|
|
5414
|
-
*/
|
|
5415
|
-
removeFundScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5416
|
-
/**
|
|
5417
|
-
* @description filter funds by params
|
|
5418
|
-
* @tags Funds
|
|
5419
|
-
* @name FundSectorScreener
|
|
5420
|
-
* @summary filter funds by params
|
|
5421
|
-
* @request POST:/funds/sector-screener
|
|
5422
|
-
* @secure
|
|
5423
|
-
*/
|
|
5424
|
-
fundSectorScreener(filter: InsightFundSectorScreenerRequest, headers?: {
|
|
5425
|
-
/** Authorization */
|
|
5426
|
-
Authorization?: string;
|
|
5427
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
|
|
5428
|
-
/**
|
|
5429
|
-
* @description get top funds
|
|
5430
|
-
* @tags Funds
|
|
5431
|
-
* @name GetTopFunds
|
|
5432
|
-
* @summary get top funds
|
|
5433
|
-
* @request POST:/funds/top
|
|
5434
|
-
* @secure
|
|
5435
|
-
*/
|
|
5436
|
-
getTopFunds(filter: InsightGetTopFundsRequest, headers?: {
|
|
5437
|
-
/** Authorization */
|
|
5438
|
-
Authorization?: string;
|
|
5439
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
|
|
5160
|
+
export interface InsightBeforeAndAfterV2 {
|
|
5161
|
+
after?: string;
|
|
5162
|
+
before?: string;
|
|
5440
5163
|
}
|
|
5441
|
-
export
|
|
5442
|
-
|
|
5443
|
-
|
|
5444
|
-
|
|
5445
|
-
|
|
5446
|
-
|
|
5447
|
-
|
|
5448
|
-
|
|
5449
|
-
|
|
5450
|
-
|
|
5451
|
-
|
|
5452
|
-
|
|
5453
|
-
|
|
5454
|
-
|
|
5455
|
-
|
|
5456
|
-
|
|
5457
|
-
|
|
5458
|
-
|
|
5459
|
-
|
|
5460
|
-
|
|
5461
|
-
|
|
5462
|
-
|
|
5463
|
-
|
|
5464
|
-
|
|
5465
|
-
|
|
5466
|
-
|
|
5467
|
-
|
|
5468
|
-
|
|
5469
|
-
|
|
5470
|
-
|
|
5471
|
-
|
|
5472
|
-
|
|
5473
|
-
|
|
5474
|
-
|
|
5475
|
-
|
|
5476
|
-
|
|
5477
|
-
|
|
5478
|
-
|
|
5479
|
-
|
|
5480
|
-
|
|
5481
|
-
|
|
5482
|
-
|
|
5483
|
-
|
|
5484
|
-
|
|
5485
|
-
|
|
5486
|
-
|
|
5487
|
-
|
|
5488
|
-
|
|
5489
|
-
|
|
5490
|
-
|
|
5491
|
-
|
|
5492
|
-
|
|
5493
|
-
|
|
5494
|
-
|
|
5495
|
-
|
|
5496
|
-
|
|
5497
|
-
|
|
5498
|
-
|
|
5499
|
-
|
|
5500
|
-
|
|
5501
|
-
|
|
5502
|
-
|
|
5503
|
-
|
|
5504
|
-
|
|
5505
|
-
|
|
5506
|
-
|
|
5507
|
-
|
|
5508
|
-
|
|
5509
|
-
|
|
5510
|
-
|
|
5511
|
-
|
|
5512
|
-
* @name CreateOrScreenerPreset
|
|
5513
|
-
* @summary create screener preset
|
|
5514
|
-
* @request POST:/stock-screener/presets
|
|
5515
|
-
* @secure
|
|
5516
|
-
*/
|
|
5517
|
-
createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5518
|
-
/**
|
|
5519
|
-
* @description remove screener preset
|
|
5520
|
-
* @tags StockScreener
|
|
5521
|
-
* @name RemoveScreenerPreset
|
|
5522
|
-
* @summary remove screener preset
|
|
5523
|
-
* @request DELETE:/stock-screener/presets
|
|
5524
|
-
* @secure
|
|
5525
|
-
*/
|
|
5526
|
-
removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5527
|
-
/**
|
|
5528
|
-
* @description get top symbols
|
|
5529
|
-
* @tags StockScreener
|
|
5530
|
-
* @name GetTopSymbols
|
|
5531
|
-
* @summary get top symbols
|
|
5532
|
-
* @request POST:/stock-screener/top
|
|
5533
|
-
* @secure
|
|
5534
|
-
*/
|
|
5535
|
-
getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
5164
|
+
export interface InsightFixedIncomeV2 {
|
|
5165
|
+
a144: boolean;
|
|
5166
|
+
accrued_interest: number;
|
|
5167
|
+
bank_qualified: boolean;
|
|
5168
|
+
bond_warrant: boolean;
|
|
5169
|
+
call_type: string;
|
|
5170
|
+
callable: boolean;
|
|
5171
|
+
close_price: number;
|
|
5172
|
+
close_price_asof: string;
|
|
5173
|
+
close_ytw: number;
|
|
5174
|
+
convertible: boolean;
|
|
5175
|
+
country: string;
|
|
5176
|
+
country_code: string;
|
|
5177
|
+
country_domicile: string;
|
|
5178
|
+
country_issue: string;
|
|
5179
|
+
coupon: number;
|
|
5180
|
+
coupon_frequency: string;
|
|
5181
|
+
coupon_type: string;
|
|
5182
|
+
currency: string;
|
|
5183
|
+
cusip: string;
|
|
5184
|
+
dated_date: string;
|
|
5185
|
+
daycount: string;
|
|
5186
|
+
description: string;
|
|
5187
|
+
description_short: string;
|
|
5188
|
+
duration: number;
|
|
5189
|
+
first_coupon_date: string;
|
|
5190
|
+
insured: boolean;
|
|
5191
|
+
isin: string;
|
|
5192
|
+
issue_date: string;
|
|
5193
|
+
issue_minimum_denomination: number;
|
|
5194
|
+
issue_price: number;
|
|
5195
|
+
issue_size: number;
|
|
5196
|
+
issuer: string;
|
|
5197
|
+
last_coupon_date: string;
|
|
5198
|
+
liquidity_institutional_aggregate: number;
|
|
5199
|
+
liquidity_institutional_buy: number;
|
|
5200
|
+
liquidity_institutional_sell: number;
|
|
5201
|
+
liquidity_micro_aggregate: number;
|
|
5202
|
+
liquidity_micro_buy: number;
|
|
5203
|
+
liquidity_micro_sell: number;
|
|
5204
|
+
liquidity_retail_aggregate: number;
|
|
5205
|
+
liquidity_retail_buy: number;
|
|
5206
|
+
liquidity_retail_sell: number;
|
|
5207
|
+
maturity_date: string;
|
|
5208
|
+
municipal_state: string;
|
|
5209
|
+
municipal_taxable_federal: boolean;
|
|
5210
|
+
municipal_type: string;
|
|
5211
|
+
next_call_date: string;
|
|
5212
|
+
next_call_price: number;
|
|
5213
|
+
next_coupon_date: string;
|
|
5214
|
+
par_value: number;
|
|
5215
|
+
perpetual: boolean;
|
|
5216
|
+
private_placement: boolean;
|
|
5217
|
+
purpose: string;
|
|
5218
|
+
puttable: boolean;
|
|
5219
|
+
reg_s: boolean;
|
|
5220
|
+
sector: string;
|
|
5221
|
+
seniority: string;
|
|
5222
|
+
settlement_convention: string;
|
|
5223
|
+
sinking_fund: boolean;
|
|
5224
|
+
sp_creditwatch: string;
|
|
5225
|
+
sp_creditwatch_date: string;
|
|
5226
|
+
sp_outlook: string;
|
|
5227
|
+
sp_outlook_date: string;
|
|
5228
|
+
sp_rating: string;
|
|
5229
|
+
sp_rating_date: string;
|
|
5230
|
+
status: string;
|
|
5231
|
+
ticker: string;
|
|
5232
|
+
treasury_subtype: string;
|
|
5233
|
+
type: string;
|
|
5234
|
+
updated_at: string;
|
|
5536
5235
|
}
|
|
5537
|
-
export
|
|
5538
|
-
|
|
5539
|
-
|
|
5540
|
-
|
|
5541
|
-
|
|
5542
|
-
|
|
5543
|
-
|
|
5544
|
-
|
|
5545
|
-
|
|
5546
|
-
|
|
5547
|
-
|
|
5548
|
-
|
|
5549
|
-
|
|
5550
|
-
|
|
5551
|
-
|
|
5552
|
-
|
|
5553
|
-
|
|
5236
|
+
export interface InsightGetFixedIncomeEntriesResponseV2 {
|
|
5237
|
+
count: number;
|
|
5238
|
+
data: InsightFixedIncomeV2[];
|
|
5239
|
+
}
|
|
5240
|
+
export interface InsightGetFixedIncomeEntriesRequestV2 {
|
|
5241
|
+
/** @example true */
|
|
5242
|
+
bank_qualified?: boolean;
|
|
5243
|
+
/** @example true */
|
|
5244
|
+
callable?: boolean;
|
|
5245
|
+
/** @example true */
|
|
5246
|
+
convertible?: boolean;
|
|
5247
|
+
/** @example ["USA"] */
|
|
5248
|
+
country_codes?: string[];
|
|
5249
|
+
coupon?: InsightLessAndMoreV2;
|
|
5250
|
+
/** @example ["quarterly","zero"] */
|
|
5251
|
+
coupon_frequencies?: string[];
|
|
5252
|
+
/** @example ["655664AH3","9128286R6"] */
|
|
5253
|
+
cusip?: string[];
|
|
5554
5254
|
/**
|
|
5555
|
-
* @
|
|
5556
|
-
* @
|
|
5557
|
-
* @name GitQuoteHistory
|
|
5558
|
-
* @summary Get quote history
|
|
5559
|
-
* @request POST:/quote-history
|
|
5560
|
-
* @secure
|
|
5255
|
+
* @maxLength 100
|
|
5256
|
+
* @example "Donald's"
|
|
5561
5257
|
*/
|
|
5562
|
-
|
|
5258
|
+
description?: string;
|
|
5259
|
+
/** @example true */
|
|
5260
|
+
has_ticker?: boolean;
|
|
5261
|
+
/** @example true */
|
|
5262
|
+
insured?: boolean;
|
|
5263
|
+
/** @example ["US655664AH33","US9128286R69"] */
|
|
5264
|
+
isin?: string[];
|
|
5265
|
+
issue_date?: InsightBeforeAndAfterV2;
|
|
5563
5266
|
/**
|
|
5564
|
-
* @
|
|
5565
|
-
* @
|
|
5566
|
-
* @name GetQuotesEquityData
|
|
5567
|
-
* @summary Get Quotes Equity data
|
|
5568
|
-
* @request GET:/quotes/equity
|
|
5569
|
-
* @secure
|
|
5267
|
+
* @maxLength 100
|
|
5268
|
+
* @example "Donald's"
|
|
5570
5269
|
*/
|
|
5571
|
-
|
|
5572
|
-
|
|
5573
|
-
|
|
5574
|
-
|
|
5270
|
+
issuer?: string;
|
|
5271
|
+
maturity?: InsightBeforeAndAfterV2;
|
|
5272
|
+
/** @example ["NY"] */
|
|
5273
|
+
municipal_states?: string[];
|
|
5274
|
+
/** @example true */
|
|
5275
|
+
municipal_tax?: boolean;
|
|
5276
|
+
/** @example ["general_obligation"] */
|
|
5277
|
+
municipal_types?: string[];
|
|
5278
|
+
pagination: InsightPaginationV2;
|
|
5279
|
+
purposes?: string[];
|
|
5280
|
+
/** @example ["SOVEREIGN"] */
|
|
5281
|
+
sectors?: string[];
|
|
5282
|
+
sorts?: InsightOrderingV2[];
|
|
5283
|
+
/** @example ["AAA"] */
|
|
5284
|
+
sp_ratings?: string[];
|
|
5285
|
+
/** @example ["called","outstanding"] */
|
|
5286
|
+
statuses?: string[];
|
|
5287
|
+
tickers?: string[];
|
|
5288
|
+
/** @example ["corporate"] */
|
|
5289
|
+
types?: string[];
|
|
5575
5290
|
}
|
|
5576
|
-
export
|
|
5577
|
-
|
|
5578
|
-
|
|
5579
|
-
|
|
5580
|
-
|
|
5581
|
-
|
|
5582
|
-
|
|
5583
|
-
* @summary Get an array of intraday chart data values for the given ticker
|
|
5584
|
-
* @request POST:/intraday/quotes
|
|
5585
|
-
* @secure
|
|
5586
|
-
*/
|
|
5587
|
-
intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
|
|
5291
|
+
export interface InsightGetTopSymbolsRequestV2 {
|
|
5292
|
+
exchange?: string[];
|
|
5293
|
+
market_cap?: InsightLessAndMoreV2;
|
|
5294
|
+
pagination?: InsightPaginationV2;
|
|
5295
|
+
price?: InsightLessAndMoreV2;
|
|
5296
|
+
sorts?: InsightOrderingV2[];
|
|
5297
|
+
volume?: InsightLessAndMoreV2;
|
|
5588
5298
|
}
|
|
5589
|
-
export
|
|
5590
|
-
|
|
5591
|
-
|
|
5299
|
+
export interface InsightIncludeExcludeV2 {
|
|
5300
|
+
exclude?: string[];
|
|
5301
|
+
include?: string[];
|
|
5302
|
+
}
|
|
5303
|
+
export interface InsightLessAndMoreV2 {
|
|
5304
|
+
less_than?: number;
|
|
5305
|
+
more_than?: number;
|
|
5306
|
+
}
|
|
5307
|
+
export interface InsightOrderingV2 {
|
|
5592
5308
|
/**
|
|
5593
|
-
* @
|
|
5594
|
-
* @
|
|
5595
|
-
* @name MonarkOghlcDataForSymbol
|
|
5596
|
-
* @summary Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
|
|
5597
|
-
* @request GET:/ipos/market-data/ohlc/{symbol}
|
|
5598
|
-
* @secure
|
|
5309
|
+
* @default "asc"
|
|
5310
|
+
* @example "asc"
|
|
5599
5311
|
*/
|
|
5600
|
-
|
|
5601
|
-
/** Start time for the OHLC data in ISO 8601 format YYYY-MM-DD */
|
|
5602
|
-
from?: string;
|
|
5603
|
-
/** End time for the OHLC data in ISO 8601 format YYYY-MM-DD */
|
|
5604
|
-
to?: string;
|
|
5605
|
-
/** Time interval for buckets: 1d (day), 1w (week), 1mo (month), 3mo (3 months). Default is 1d. */
|
|
5606
|
-
interval?: string;
|
|
5607
|
-
/** Limit the number of OHLC data points returned. Default is 100. */
|
|
5608
|
-
limit?: number;
|
|
5609
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<{
|
|
5610
|
-
close?: number;
|
|
5611
|
-
high?: number;
|
|
5612
|
-
low?: number;
|
|
5613
|
-
open?: number;
|
|
5614
|
-
time?: string;
|
|
5615
|
-
volume?: number;
|
|
5616
|
-
}[], HandleError>>;
|
|
5312
|
+
direction: InsightOrderingDirectionEnumV2;
|
|
5617
5313
|
/**
|
|
5618
|
-
*
|
|
5619
|
-
*
|
|
5620
|
-
*
|
|
5621
|
-
* @
|
|
5622
|
-
* @request GET:/ipos/market-data/symbols
|
|
5623
|
-
* @secure
|
|
5314
|
+
* Sort direction:
|
|
5315
|
+
* * asc - Ascending, from A to Z.
|
|
5316
|
+
* * desc - Descending, from Z to A.
|
|
5317
|
+
* @example "name"
|
|
5624
5318
|
*/
|
|
5625
|
-
|
|
5319
|
+
field: string;
|
|
5320
|
+
}
|
|
5321
|
+
export interface InsightPaginationV2 {
|
|
5626
5322
|
/**
|
|
5627
|
-
* @
|
|
5628
|
-
* @
|
|
5629
|
-
* @name GetPreIpoCompanies
|
|
5630
|
-
* @summary get pre ipo companies
|
|
5631
|
-
* @request GET:/ipos/pre-ipo-companies
|
|
5632
|
-
* @secure
|
|
5323
|
+
* @min 1
|
|
5324
|
+
* @example 1
|
|
5633
5325
|
*/
|
|
5634
|
-
|
|
5635
|
-
/** search by company name */
|
|
5636
|
-
name?: string;
|
|
5637
|
-
/** search by categories */
|
|
5638
|
-
categories?: string;
|
|
5639
|
-
/** search by listing type */
|
|
5640
|
-
listing_type?: string;
|
|
5641
|
-
/** filter by active status */
|
|
5642
|
-
is_active?: InsightGetPreIpoCompaniesParamsIsActiveEnum;
|
|
5643
|
-
/** filter by minimum last valuation */
|
|
5644
|
-
min_last_valuation?: number;
|
|
5645
|
-
/** filter by maximum last valuation */
|
|
5646
|
-
max_last_valuation?: number;
|
|
5647
|
-
/** filter by minimum total funding */
|
|
5648
|
-
min_total_funding?: number;
|
|
5649
|
-
/** filter by maximum total funding */
|
|
5650
|
-
max_total_funding?: number;
|
|
5651
|
-
/** how many records to return. Max value is 50 */
|
|
5652
|
-
limit: number;
|
|
5653
|
-
/** how many records to skip */
|
|
5654
|
-
offset: number;
|
|
5655
|
-
/** sort field */
|
|
5656
|
-
order_field?: InsightGetPreIpoCompaniesParamsOrderFieldEnum;
|
|
5657
|
-
/** sort direction */
|
|
5658
|
-
order_direction?: InsightGetPreIpoCompaniesParamsOrderDirectionEnum;
|
|
5659
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
|
|
5326
|
+
page: number;
|
|
5660
5327
|
/**
|
|
5661
|
-
* @
|
|
5662
|
-
* @
|
|
5663
|
-
* @
|
|
5664
|
-
* @summary get pre ipo company by id
|
|
5665
|
-
* @request GET:/ipos/pre-ipo-companies/{id}
|
|
5666
|
-
* @originalName getPreIpoCompanies
|
|
5667
|
-
* @duplicate
|
|
5668
|
-
* @secure
|
|
5328
|
+
* @min 1
|
|
5329
|
+
* @max 50
|
|
5330
|
+
* @example 10
|
|
5669
5331
|
*/
|
|
5670
|
-
|
|
5332
|
+
size: number;
|
|
5333
|
+
}
|
|
5334
|
+
export interface InsightStockScreenerQuoteV2 {
|
|
5335
|
+
average_volume_30d: number;
|
|
5336
|
+
company_name: string;
|
|
5337
|
+
dividend_ex_date: string;
|
|
5338
|
+
dividend_pay_date: string;
|
|
5339
|
+
dividend_percent: number;
|
|
5340
|
+
exchange: string;
|
|
5341
|
+
exchange_name: string;
|
|
5342
|
+
gap: number;
|
|
5343
|
+
industry: string;
|
|
5344
|
+
industry_code: string;
|
|
5345
|
+
last_price: number;
|
|
5346
|
+
market_cap: number;
|
|
5347
|
+
pe_ratio: number;
|
|
5348
|
+
price_change: number;
|
|
5349
|
+
price_change_percent: number;
|
|
5350
|
+
symbol: string;
|
|
5351
|
+
volume: number;
|
|
5352
|
+
}
|
|
5353
|
+
export interface InsightStockScreenerRequestV2 {
|
|
5354
|
+
average_volume_30d?: InsightLessAndMoreV2;
|
|
5355
|
+
dividend_ex_date?: InsightBeforeAndAfterV2;
|
|
5356
|
+
dividend_pay_date?: InsightBeforeAndAfterV2;
|
|
5357
|
+
dividend_percent?: InsightLessAndMoreV2;
|
|
5358
|
+
exchange?: InsightIncludeExcludeV2;
|
|
5359
|
+
gap?: InsightLessAndMoreV2;
|
|
5360
|
+
industry?: InsightIncludeExcludeV2;
|
|
5361
|
+
market_cap?: InsightLessAndMoreV2;
|
|
5362
|
+
pagination: InsightPaginationV2;
|
|
5363
|
+
pe_ratio?: InsightLessAndMoreV2;
|
|
5364
|
+
price?: InsightLessAndMoreV2;
|
|
5365
|
+
price_change_percent?: InsightLessAndMoreV2;
|
|
5366
|
+
sorts?: InsightOrderingV2[];
|
|
5367
|
+
/** @example "ADR" */
|
|
5368
|
+
stock_type?: string;
|
|
5369
|
+
volume?: InsightLessAndMoreV2;
|
|
5370
|
+
}
|
|
5371
|
+
export interface InsightStockScreenerResponseV2 {
|
|
5372
|
+
current_page: number;
|
|
5373
|
+
data: InsightStockScreenerQuoteV2[];
|
|
5374
|
+
page_count: number;
|
|
5375
|
+
status: number;
|
|
5376
|
+
total_records: number;
|
|
5377
|
+
}
|
|
5378
|
+
/**
|
|
5379
|
+
* @default "asc"
|
|
5380
|
+
* @example "asc"
|
|
5381
|
+
*/
|
|
5382
|
+
export enum InsightOrderingDirectionEnumV2 {
|
|
5383
|
+
Asc = "asc",
|
|
5384
|
+
Desc = "desc"
|
|
5385
|
+
}
|
|
5386
|
+
export class FixedIncomeV2<HandleError extends boolean = boolean> {
|
|
5387
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5388
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5671
5389
|
/**
|
|
5672
|
-
* @description get
|
|
5673
|
-
* @tags
|
|
5674
|
-
* @name
|
|
5675
|
-
* @summary get
|
|
5676
|
-
* @request
|
|
5390
|
+
* @description get fixed income entries
|
|
5391
|
+
* @tags FixedIncome
|
|
5392
|
+
* @name GetFixedIncomeEntries
|
|
5393
|
+
* @summary get fixed income entries
|
|
5394
|
+
* @request POST:/fixed-income
|
|
5677
5395
|
* @secure
|
|
5678
5396
|
*/
|
|
5679
|
-
|
|
5680
|
-
|
|
5681
|
-
|
|
5682
|
-
|
|
5683
|
-
|
|
5684
|
-
/** how many records to return. Max value is 50 */
|
|
5685
|
-
limit: number;
|
|
5686
|
-
/** how many records to skip */
|
|
5687
|
-
offset: number;
|
|
5688
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyFundingRoundsResponse, HandleError>>;
|
|
5397
|
+
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
|
|
5398
|
+
}
|
|
5399
|
+
export class Fundamentals<HandleError extends boolean = boolean> {
|
|
5400
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5401
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5689
5402
|
/**
|
|
5690
|
-
* @description get
|
|
5691
|
-
* @tags
|
|
5692
|
-
* @name
|
|
5693
|
-
* @summary get
|
|
5694
|
-
* @request
|
|
5695
|
-
* @originalName getPreIpoCompanyFundingRounds
|
|
5696
|
-
* @duplicate
|
|
5403
|
+
* @description get fundamentals by symbol data
|
|
5404
|
+
* @tags Fundamentals
|
|
5405
|
+
* @name GetFundamentalsBySymbolData
|
|
5406
|
+
* @summary get fundamentals by symbol data
|
|
5407
|
+
* @request POST:/fundamentals
|
|
5697
5408
|
* @secure
|
|
5698
5409
|
*/
|
|
5699
|
-
|
|
5410
|
+
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
5411
|
+
}
|
|
5412
|
+
export class Funds<HandleError extends boolean = boolean> {
|
|
5413
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5414
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5700
5415
|
/**
|
|
5701
|
-
* @description get
|
|
5702
|
-
* @tags
|
|
5703
|
-
* @name
|
|
5704
|
-
* @summary get
|
|
5705
|
-
* @request GET:/
|
|
5416
|
+
* @description get fund details
|
|
5417
|
+
* @tags Funds
|
|
5418
|
+
* @name GetFundDetails
|
|
5419
|
+
* @summary get fund details
|
|
5420
|
+
* @request GET:/funds/details
|
|
5706
5421
|
* @secure
|
|
5707
5422
|
*/
|
|
5708
|
-
|
|
5709
|
-
/**
|
|
5710
|
-
|
|
5711
|
-
|
|
5712
|
-
company_name?: string;
|
|
5713
|
-
/** how many records to return. Max value is 50 */
|
|
5714
|
-
limit: number;
|
|
5715
|
-
/** how many records to skip */
|
|
5716
|
-
offset: number;
|
|
5717
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyInvestmentsResponse, HandleError>>;
|
|
5423
|
+
getFundDetails(query: {
|
|
5424
|
+
/** Fund symbol */
|
|
5425
|
+
symbol: string;
|
|
5426
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundDetailsResponse, HandleError>>;
|
|
5718
5427
|
/**
|
|
5719
|
-
* @description get
|
|
5720
|
-
* @tags
|
|
5721
|
-
* @name
|
|
5722
|
-
* @summary get
|
|
5723
|
-
* @request
|
|
5724
|
-
* @originalName getPreIpoCompanyInvestments
|
|
5725
|
-
* @duplicate
|
|
5428
|
+
* @description get funds for holding
|
|
5429
|
+
* @tags Funds
|
|
5430
|
+
* @name GetFundsForHolding
|
|
5431
|
+
* @summary get funds for holding
|
|
5432
|
+
* @request POST:/funds/funds-for-holding
|
|
5726
5433
|
* @secure
|
|
5727
5434
|
*/
|
|
5728
|
-
|
|
5435
|
+
getFundsForHolding(filter: InsightGetFundsForHoldingRequest, headers?: {
|
|
5436
|
+
/** Authorization */
|
|
5437
|
+
Authorization?: string;
|
|
5438
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundsForHoldingResponse, HandleError>>;
|
|
5729
5439
|
/**
|
|
5730
|
-
* @description
|
|
5731
|
-
* @tags
|
|
5732
|
-
* @name
|
|
5733
|
-
* @summary
|
|
5734
|
-
* @request
|
|
5440
|
+
* @description filter funds by params
|
|
5441
|
+
* @tags Funds
|
|
5442
|
+
* @name FundScreener
|
|
5443
|
+
* @summary filter funds by params
|
|
5444
|
+
* @request POST:/funds/screener
|
|
5735
5445
|
* @secure
|
|
5736
5446
|
*/
|
|
5737
|
-
|
|
5738
|
-
/**
|
|
5739
|
-
|
|
5740
|
-
|
|
5741
|
-
headline?: string;
|
|
5742
|
-
/** how many records to return. Max value is 50 */
|
|
5743
|
-
limit: number;
|
|
5744
|
-
/** how many records to skip */
|
|
5745
|
-
offset: number;
|
|
5746
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyNewsResponse, HandleError>>;
|
|
5447
|
+
fundScreener(filter: InsightFundScreenerRequest, headers?: {
|
|
5448
|
+
/** Authorization */
|
|
5449
|
+
Authorization?: string;
|
|
5450
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
|
|
5747
5451
|
/**
|
|
5748
|
-
* @description get
|
|
5749
|
-
* @tags
|
|
5750
|
-
* @name
|
|
5751
|
-
* @summary get
|
|
5752
|
-
* @request GET:/
|
|
5753
|
-
* @originalName getPreIpoCompanyNews
|
|
5754
|
-
* @duplicate
|
|
5452
|
+
* @description get fund screener filters
|
|
5453
|
+
* @tags Funds
|
|
5454
|
+
* @name GetScreenerFilters
|
|
5455
|
+
* @summary get fund screener filters
|
|
5456
|
+
* @request GET:/funds/screener/filters
|
|
5755
5457
|
* @secure
|
|
5756
5458
|
*/
|
|
5757
|
-
|
|
5459
|
+
getScreenerFilters(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundScreenerFiltersResponse, HandleError>>;
|
|
5758
5460
|
/**
|
|
5759
|
-
* @description get
|
|
5760
|
-
* @tags
|
|
5761
|
-
* @name
|
|
5762
|
-
* @summary get
|
|
5763
|
-
* @request GET:/
|
|
5461
|
+
* @description get fund screener presets
|
|
5462
|
+
* @tags Funds
|
|
5463
|
+
* @name GetFundScreenerPresets
|
|
5464
|
+
* @summary get fund screener presets
|
|
5465
|
+
* @request GET:/funds/screener/presets
|
|
5764
5466
|
* @secure
|
|
5765
5467
|
*/
|
|
5766
|
-
|
|
5767
|
-
/**
|
|
5768
|
-
pre_ipo_company_id?: string;
|
|
5769
|
-
/** search by title */
|
|
5770
|
-
title?: string;
|
|
5771
|
-
/** how many records to return. Max value is 50 */
|
|
5468
|
+
getFundScreenerPresets(query: {
|
|
5469
|
+
/** how many records to return */
|
|
5772
5470
|
limit: number;
|
|
5773
5471
|
/** how many records to skip */
|
|
5774
5472
|
offset: number;
|
|
5775
|
-
|
|
5776
|
-
research_type?: InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum;
|
|
5777
|
-
/** search by relation */
|
|
5778
|
-
relation?: InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum;
|
|
5779
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError>>;
|
|
5473
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
5780
5474
|
/**
|
|
5781
|
-
* @description
|
|
5782
|
-
* @tags
|
|
5783
|
-
* @name
|
|
5784
|
-
* @summary
|
|
5785
|
-
* @request
|
|
5786
|
-
* @originalName getPreIpoCompanyResearchDocuments
|
|
5787
|
-
* @duplicate
|
|
5475
|
+
* @description update fund screener preset
|
|
5476
|
+
* @tags Funds
|
|
5477
|
+
* @name UpdateFundScreenerPreset
|
|
5478
|
+
* @summary update fund screener preset
|
|
5479
|
+
* @request PUT:/funds/screener/presets
|
|
5788
5480
|
* @secure
|
|
5789
5481
|
*/
|
|
5790
|
-
|
|
5482
|
+
updateFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5791
5483
|
/**
|
|
5792
|
-
* @description
|
|
5793
|
-
* @tags
|
|
5794
|
-
* @name
|
|
5795
|
-
* @summary
|
|
5796
|
-
* @request
|
|
5484
|
+
* @description create fund screener preset
|
|
5485
|
+
* @tags Funds
|
|
5486
|
+
* @name CreateFundScreenerPreset
|
|
5487
|
+
* @summary create fund screener preset
|
|
5488
|
+
* @request POST:/funds/screener/presets
|
|
5797
5489
|
* @secure
|
|
5798
5490
|
*/
|
|
5799
|
-
|
|
5800
|
-
/** search by monark stage */
|
|
5801
|
-
monark_stage?: InsightGetInvestorParamsMonarkStageEnum;
|
|
5802
|
-
/** Optional param to filter returned spv's based on the exemptions claimed */
|
|
5803
|
-
exemptions_claimed?: string[];
|
|
5804
|
-
/** Optional param to filter returned spv's based on the name */
|
|
5805
|
-
name_filter?: string;
|
|
5806
|
-
/** investment id */
|
|
5807
|
-
pre_ipo_company_id?: string;
|
|
5808
|
-
/** investment id */
|
|
5809
|
-
pre_ipo_company_investment_id?: string;
|
|
5810
|
-
/** page number */
|
|
5811
|
-
page: number;
|
|
5812
|
-
/** page size */
|
|
5813
|
-
page_size: number;
|
|
5814
|
-
/** sort direction */
|
|
5815
|
-
sort_order?: InsightGetInvestorParamsSortOrderEnum;
|
|
5816
|
-
/** sort field */
|
|
5817
|
-
sort_by?: InsightGetInvestorParamsSortByEnum;
|
|
5818
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsWithInvestorIDResponse, HandleError>>;
|
|
5491
|
+
createFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5819
5492
|
/**
|
|
5820
|
-
* @description
|
|
5821
|
-
* @tags
|
|
5822
|
-
* @name
|
|
5823
|
-
* @summary
|
|
5824
|
-
* @request
|
|
5825
|
-
* @originalName getInvestor
|
|
5826
|
-
* @duplicate
|
|
5493
|
+
* @description remove fund screener preset
|
|
5494
|
+
* @tags Funds
|
|
5495
|
+
* @name RemoveFundScreenerPreset
|
|
5496
|
+
* @summary remove fund screener preset
|
|
5497
|
+
* @request DELETE:/funds/screener/presets
|
|
5827
5498
|
* @secure
|
|
5828
5499
|
*/
|
|
5829
|
-
|
|
5830
|
-
/** default is false, if true documents will be included in the response */
|
|
5831
|
-
include_documents?: boolean;
|
|
5832
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetProIPOCompabySPVWithInvestorIDResponse, HandleError>>;
|
|
5500
|
+
removeFundScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5833
5501
|
/**
|
|
5834
|
-
* @description
|
|
5835
|
-
* @tags
|
|
5836
|
-
* @name
|
|
5837
|
-
* @summary
|
|
5838
|
-
* @request
|
|
5502
|
+
* @description filter funds by params
|
|
5503
|
+
* @tags Funds
|
|
5504
|
+
* @name FundSectorScreener
|
|
5505
|
+
* @summary filter funds by params
|
|
5506
|
+
* @request POST:/funds/sector-screener
|
|
5839
5507
|
* @secure
|
|
5840
5508
|
*/
|
|
5841
|
-
|
|
5842
|
-
/**
|
|
5843
|
-
|
|
5844
|
-
|
|
5845
|
-
investment_id?: string;
|
|
5846
|
-
/** search by name */
|
|
5847
|
-
name?: string;
|
|
5848
|
-
/** search by company name */
|
|
5849
|
-
company_name?: string;
|
|
5850
|
-
/** how many records to return. Max value is 50 */
|
|
5851
|
-
limit: number;
|
|
5852
|
-
/** how many records to skip */
|
|
5853
|
-
offset: number;
|
|
5854
|
-
/** search by monark stage */
|
|
5855
|
-
monark_stage?: InsightGetPreIpoCompanySpvsParamsMonarkStageEnum;
|
|
5856
|
-
/** sort direction */
|
|
5857
|
-
direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
|
|
5858
|
-
/** sort field */
|
|
5859
|
-
field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
|
|
5860
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
|
|
5509
|
+
fundSectorScreener(filter: InsightFundSectorScreenerRequest, headers?: {
|
|
5510
|
+
/** Authorization */
|
|
5511
|
+
Authorization?: string;
|
|
5512
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
|
|
5861
5513
|
/**
|
|
5862
|
-
* @description get
|
|
5863
|
-
* @tags
|
|
5864
|
-
* @name
|
|
5865
|
-
* @summary get
|
|
5866
|
-
* @request
|
|
5867
|
-
* @originalName getPreIpoCompanySpvs
|
|
5868
|
-
* @duplicate
|
|
5514
|
+
* @description get top funds
|
|
5515
|
+
* @tags Funds
|
|
5516
|
+
* @name GetTopFunds
|
|
5517
|
+
* @summary get top funds
|
|
5518
|
+
* @request POST:/funds/top
|
|
5869
5519
|
* @secure
|
|
5870
5520
|
*/
|
|
5871
|
-
|
|
5872
|
-
/**
|
|
5873
|
-
|
|
5874
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5521
|
+
getTopFunds(filter: InsightGetTopFundsRequest, headers?: {
|
|
5522
|
+
/** Authorization */
|
|
5523
|
+
Authorization?: string;
|
|
5524
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
|
|
5525
|
+
}
|
|
5526
|
+
export class Intraday<HandleError extends boolean = boolean> {
|
|
5527
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5528
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5529
|
+
/**
|
|
5530
|
+
* @description Returns an array of intraday chart data values for the given ticker.
|
|
5531
|
+
* @tags Intraday
|
|
5532
|
+
* @name IntradayQuotes
|
|
5533
|
+
* @summary Get an array of intraday chart data values for the given ticker
|
|
5534
|
+
* @request POST:/intraday/quotes
|
|
5535
|
+
* @secure
|
|
5536
|
+
*/
|
|
5537
|
+
intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
|
|
5875
5538
|
}
|
|
5876
5539
|
export class Ipos<HandleError extends boolean = boolean> {
|
|
5877
5540
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -6349,52 +6012,339 @@ export class Passport<HandleError extends boolean = boolean> {
|
|
|
6349
6012
|
* @request POST:/passport/article-by-id
|
|
6350
6013
|
* @secure
|
|
6351
6014
|
*/
|
|
6352
|
-
passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
|
|
6015
|
+
passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
|
|
6016
|
+
/**
|
|
6017
|
+
* @description Returns articles
|
|
6018
|
+
* @tags Passport
|
|
6019
|
+
* @name PassportArticles
|
|
6020
|
+
* @summary Get articles
|
|
6021
|
+
* @request POST:/passport/articles
|
|
6022
|
+
* @secure
|
|
6023
|
+
*/
|
|
6024
|
+
passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
6025
|
+
/**
|
|
6026
|
+
* @description Returns author profile
|
|
6027
|
+
* @tags Passport
|
|
6028
|
+
* @name PassportAuthorProfile
|
|
6029
|
+
* @summary Get author profile
|
|
6030
|
+
* @request POST:/passport/author-profile
|
|
6031
|
+
* @secure
|
|
6032
|
+
*/
|
|
6033
|
+
passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
|
|
6034
|
+
/**
|
|
6035
|
+
* @description Returns most popular tags
|
|
6036
|
+
* @tags Passport
|
|
6037
|
+
* @name PassportMostPopularTags
|
|
6038
|
+
* @summary Get most popular tags
|
|
6039
|
+
* @request POST:/passport/most-popular-tags
|
|
6040
|
+
* @secure
|
|
6041
|
+
*/
|
|
6042
|
+
passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
|
|
6043
|
+
/**
|
|
6044
|
+
* @description Returns news feed
|
|
6045
|
+
* @tags Passport
|
|
6046
|
+
* @name PassportNewsFeed
|
|
6047
|
+
* @summary Get news feed
|
|
6048
|
+
* @request POST:/passport/newsfeed
|
|
6049
|
+
* @secure
|
|
6050
|
+
*/
|
|
6051
|
+
passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
|
|
6052
|
+
/**
|
|
6053
|
+
* @description Returns article by parameters
|
|
6054
|
+
* @tags Passport
|
|
6055
|
+
* @name PassportSearchArticle
|
|
6056
|
+
* @summary Search article by parameters
|
|
6057
|
+
* @request POST:/passport/search-article
|
|
6058
|
+
* @secure
|
|
6059
|
+
*/
|
|
6060
|
+
passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
6061
|
+
}
|
|
6062
|
+
export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
6063
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6064
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6065
|
+
/**
|
|
6066
|
+
* @description Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
|
|
6067
|
+
* @tags PreIPOCompanies
|
|
6068
|
+
* @name MonarkOghlcDataForSymbol
|
|
6069
|
+
* @summary Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
|
|
6070
|
+
* @request GET:/ipos/market-data/ohlc/{symbol}
|
|
6071
|
+
* @secure
|
|
6072
|
+
*/
|
|
6073
|
+
monarkOghlcDataForSymbol(symbol: string, query?: {
|
|
6074
|
+
/** Start time for the OHLC data in ISO 8601 format YYYY-MM-DD */
|
|
6075
|
+
from?: string;
|
|
6076
|
+
/** End time for the OHLC data in ISO 8601 format YYYY-MM-DD */
|
|
6077
|
+
to?: string;
|
|
6078
|
+
/** Time interval for buckets: 1d (day), 1w (week), 1mo (month), 3mo (3 months). Default is 1d. */
|
|
6079
|
+
interval?: string;
|
|
6080
|
+
/** Limit the number of OHLC data points returned. Default is 100. */
|
|
6081
|
+
limit?: number;
|
|
6082
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<{
|
|
6083
|
+
close?: number;
|
|
6084
|
+
high?: number;
|
|
6085
|
+
low?: number;
|
|
6086
|
+
open?: number;
|
|
6087
|
+
time?: string;
|
|
6088
|
+
volume?: number;
|
|
6089
|
+
}[], HandleError>>;
|
|
6090
|
+
/**
|
|
6091
|
+
* @description Retrieves all symbols available in the market data
|
|
6092
|
+
* @tags PreIPOCompanies
|
|
6093
|
+
* @name MonarkAllAvailableSymbols
|
|
6094
|
+
* @summary Retrieves all symbols available in the market data
|
|
6095
|
+
* @request GET:/ipos/market-data/symbols
|
|
6096
|
+
* @secure
|
|
6097
|
+
*/
|
|
6098
|
+
monarkAllAvailableSymbols(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
6099
|
+
/**
|
|
6100
|
+
* @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
|
|
6101
|
+
* @tags PreIPOCompanies
|
|
6102
|
+
* @name GetPreIpoCompanies
|
|
6103
|
+
* @summary get pre ipo companies
|
|
6104
|
+
* @request GET:/ipos/pre-ipo-companies
|
|
6105
|
+
* @secure
|
|
6106
|
+
*/
|
|
6107
|
+
getPreIpoCompanies(query: {
|
|
6108
|
+
/** search by company name */
|
|
6109
|
+
name?: string;
|
|
6110
|
+
/** search by categories */
|
|
6111
|
+
categories?: string;
|
|
6112
|
+
/** search by listing type */
|
|
6113
|
+
listing_type?: string;
|
|
6114
|
+
/** filter by active status */
|
|
6115
|
+
is_active?: InsightGetPreIpoCompaniesParamsIsActiveEnum;
|
|
6116
|
+
/** filter by minimum last valuation */
|
|
6117
|
+
min_last_valuation?: number;
|
|
6118
|
+
/** filter by maximum last valuation */
|
|
6119
|
+
max_last_valuation?: number;
|
|
6120
|
+
/** filter by minimum total funding */
|
|
6121
|
+
min_total_funding?: number;
|
|
6122
|
+
/** filter by maximum total funding */
|
|
6123
|
+
max_total_funding?: number;
|
|
6124
|
+
/** how many records to return. Max value is 50 */
|
|
6125
|
+
limit: number;
|
|
6126
|
+
/** how many records to skip */
|
|
6127
|
+
offset: number;
|
|
6128
|
+
/** sort field */
|
|
6129
|
+
order_field?: InsightGetPreIpoCompaniesParamsOrderFieldEnum;
|
|
6130
|
+
/** sort direction */
|
|
6131
|
+
order_direction?: InsightGetPreIpoCompaniesParamsOrderDirectionEnum;
|
|
6132
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
|
|
6133
|
+
/**
|
|
6134
|
+
* @description get pre ipo company by id
|
|
6135
|
+
* @tags PreIPOCompanies
|
|
6136
|
+
* @name GetPreIpoCompaniesById
|
|
6137
|
+
* @summary get pre ipo company by id
|
|
6138
|
+
* @request GET:/ipos/pre-ipo-companies/{id}
|
|
6139
|
+
* @originalName getPreIpoCompanies
|
|
6140
|
+
* @duplicate
|
|
6141
|
+
* @secure
|
|
6142
|
+
*/
|
|
6143
|
+
getPreIpoCompaniesById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompany, HandleError>>;
|
|
6144
|
+
/**
|
|
6145
|
+
* @description get pre ipo company funding rounds
|
|
6146
|
+
* @tags PreIPOCompanies
|
|
6147
|
+
* @name GetPreIpoCompanyFundingRounds
|
|
6148
|
+
* @summary get pre ipo company funding rounds
|
|
6149
|
+
* @request GET:/ipos/pre-ipo-company-funding-rounds
|
|
6150
|
+
* @secure
|
|
6151
|
+
*/
|
|
6152
|
+
getPreIpoCompanyFundingRounds(query: {
|
|
6153
|
+
/** company id */
|
|
6154
|
+
pre_ipo_company_id?: string;
|
|
6155
|
+
/** search by round name */
|
|
6156
|
+
round_name?: string;
|
|
6157
|
+
/** how many records to return. Max value is 50 */
|
|
6158
|
+
limit: number;
|
|
6159
|
+
/** how many records to skip */
|
|
6160
|
+
offset: number;
|
|
6161
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyFundingRoundsResponse, HandleError>>;
|
|
6162
|
+
/**
|
|
6163
|
+
* @description get pre ipo company funding round by id
|
|
6164
|
+
* @tags PreIPOCompanies
|
|
6165
|
+
* @name GetPreIpoCompanyFundingRoundsById
|
|
6166
|
+
* @summary get pre ipo company funding round by id
|
|
6167
|
+
* @request GET:/ipos/pre-ipo-company-funding-rounds/{id}
|
|
6168
|
+
* @originalName getPreIpoCompanyFundingRounds
|
|
6169
|
+
* @duplicate
|
|
6170
|
+
* @secure
|
|
6171
|
+
*/
|
|
6172
|
+
getPreIpoCompanyFundingRoundsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyFundingRound, HandleError>>;
|
|
6173
|
+
/**
|
|
6174
|
+
* @description get pre ipo company investments
|
|
6175
|
+
* @tags PreIPOCompanies
|
|
6176
|
+
* @name GetPreIpoCompanyInvestments
|
|
6177
|
+
* @summary get pre ipo company investments
|
|
6178
|
+
* @request GET:/ipos/pre-ipo-company-investments
|
|
6179
|
+
* @secure
|
|
6180
|
+
*/
|
|
6181
|
+
getPreIpoCompanyInvestments(query: {
|
|
6182
|
+
/** company id */
|
|
6183
|
+
pre_ipo_company_id?: string;
|
|
6184
|
+
/** company name */
|
|
6185
|
+
company_name?: string;
|
|
6186
|
+
/** how many records to return. Max value is 50 */
|
|
6187
|
+
limit: number;
|
|
6188
|
+
/** how many records to skip */
|
|
6189
|
+
offset: number;
|
|
6190
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyInvestmentsResponse, HandleError>>;
|
|
6191
|
+
/**
|
|
6192
|
+
* @description get pre ipo company investment by id
|
|
6193
|
+
* @tags PreIPOCompanies
|
|
6194
|
+
* @name GetPreIpoCompanyInvestmentsById
|
|
6195
|
+
* @summary get pre ipo company investment by id
|
|
6196
|
+
* @request GET:/ipos/pre-ipo-company-investments/{id}
|
|
6197
|
+
* @originalName getPreIpoCompanyInvestments
|
|
6198
|
+
* @duplicate
|
|
6199
|
+
* @secure
|
|
6200
|
+
*/
|
|
6201
|
+
getPreIpoCompanyInvestmentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyInvestment, HandleError>>;
|
|
6202
|
+
/**
|
|
6203
|
+
* @description get pre ipo company news
|
|
6204
|
+
* @tags PreIPOCompanies
|
|
6205
|
+
* @name GetPreIpoCompanyNews
|
|
6206
|
+
* @summary get pre ipo company news
|
|
6207
|
+
* @request GET:/ipos/pre-ipo-company-news
|
|
6208
|
+
* @secure
|
|
6209
|
+
*/
|
|
6210
|
+
getPreIpoCompanyNews(query: {
|
|
6211
|
+
/** company id */
|
|
6212
|
+
pre_ipo_company_id?: string;
|
|
6213
|
+
/** search by headline */
|
|
6214
|
+
headline?: string;
|
|
6215
|
+
/** how many records to return. Max value is 50 */
|
|
6216
|
+
limit: number;
|
|
6217
|
+
/** how many records to skip */
|
|
6218
|
+
offset: number;
|
|
6219
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyNewsResponse, HandleError>>;
|
|
6220
|
+
/**
|
|
6221
|
+
* @description get pre ipo company news by id
|
|
6222
|
+
* @tags PreIPOCompanies
|
|
6223
|
+
* @name GetPreIpoCompanyNewsById
|
|
6224
|
+
* @summary get pre ipo company news by id
|
|
6225
|
+
* @request GET:/ipos/pre-ipo-company-news/{id}
|
|
6226
|
+
* @originalName getPreIpoCompanyNews
|
|
6227
|
+
* @duplicate
|
|
6228
|
+
* @secure
|
|
6229
|
+
*/
|
|
6230
|
+
getPreIpoCompanyNewsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyNews, HandleError>>;
|
|
6231
|
+
/**
|
|
6232
|
+
* @description get pre ipo company research documents
|
|
6233
|
+
* @tags PreIPOCompanies
|
|
6234
|
+
* @name GetPreIpoCompanyResearchDocuments
|
|
6235
|
+
* @summary get pre ipo company research documents
|
|
6236
|
+
* @request GET:/ipos/pre-ipo-company-research-documents
|
|
6237
|
+
* @secure
|
|
6238
|
+
*/
|
|
6239
|
+
getPreIpoCompanyResearchDocuments(query: {
|
|
6240
|
+
/** company id */
|
|
6241
|
+
pre_ipo_company_id?: string;
|
|
6242
|
+
/** search by title */
|
|
6243
|
+
title?: string;
|
|
6244
|
+
/** how many records to return. Max value is 50 */
|
|
6245
|
+
limit: number;
|
|
6246
|
+
/** how many records to skip */
|
|
6247
|
+
offset: number;
|
|
6248
|
+
/** search by research type */
|
|
6249
|
+
research_type?: InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum;
|
|
6250
|
+
/** search by relation */
|
|
6251
|
+
relation?: InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum;
|
|
6252
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError>>;
|
|
6353
6253
|
/**
|
|
6354
|
-
* @description
|
|
6355
|
-
* @tags
|
|
6356
|
-
* @name
|
|
6357
|
-
* @summary
|
|
6358
|
-
* @request
|
|
6254
|
+
* @description get pre ipo company research document by id
|
|
6255
|
+
* @tags PreIPOCompanies
|
|
6256
|
+
* @name GetPreIpoCompanyResearchDocumentsById
|
|
6257
|
+
* @summary get pre ipo company research document by id
|
|
6258
|
+
* @request GET:/ipos/pre-ipo-company-research-documents/{id}
|
|
6259
|
+
* @originalName getPreIpoCompanyResearchDocuments
|
|
6260
|
+
* @duplicate
|
|
6359
6261
|
* @secure
|
|
6360
6262
|
*/
|
|
6361
|
-
|
|
6263
|
+
getPreIpoCompanyResearchDocumentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyResearchDocument, HandleError>>;
|
|
6362
6264
|
/**
|
|
6363
|
-
* @description
|
|
6364
|
-
* @tags
|
|
6365
|
-
* @name
|
|
6366
|
-
* @summary
|
|
6367
|
-
* @request
|
|
6265
|
+
* @description get pre ipo company spvs with investor id
|
|
6266
|
+
* @tags PreIPOCompanies
|
|
6267
|
+
* @name GetInvestor
|
|
6268
|
+
* @summary get pre ipo company spvs with investor id
|
|
6269
|
+
* @request GET:/ipos/pre-ipo-company-spv/investor/{investor_id}
|
|
6368
6270
|
* @secure
|
|
6369
6271
|
*/
|
|
6370
|
-
|
|
6272
|
+
getInvestor(investorId: string, query: {
|
|
6273
|
+
/** search by monark stage */
|
|
6274
|
+
monark_stage?: InsightGetInvestorParamsMonarkStageEnum;
|
|
6275
|
+
/** Optional param to filter returned spv's based on the exemptions claimed */
|
|
6276
|
+
exemptions_claimed?: string[];
|
|
6277
|
+
/** Optional param to filter returned spv's based on the name */
|
|
6278
|
+
name_filter?: string;
|
|
6279
|
+
/** investment id */
|
|
6280
|
+
pre_ipo_company_id?: string;
|
|
6281
|
+
/** investment id */
|
|
6282
|
+
pre_ipo_company_investment_id?: string;
|
|
6283
|
+
/** page number */
|
|
6284
|
+
page: number;
|
|
6285
|
+
/** page size */
|
|
6286
|
+
page_size: number;
|
|
6287
|
+
/** sort direction */
|
|
6288
|
+
sort_order?: InsightGetInvestorParamsSortOrderEnum;
|
|
6289
|
+
/** sort field */
|
|
6290
|
+
sort_by?: InsightGetInvestorParamsSortByEnum;
|
|
6291
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsWithInvestorIDResponse, HandleError>>;
|
|
6371
6292
|
/**
|
|
6372
|
-
* @description
|
|
6373
|
-
* @tags
|
|
6374
|
-
* @name
|
|
6375
|
-
* @summary
|
|
6376
|
-
* @request
|
|
6293
|
+
* @description get pre ipo company spv by id with investor id
|
|
6294
|
+
* @tags PreIPOCompanies
|
|
6295
|
+
* @name GetInvestorByIdAndInvestorId
|
|
6296
|
+
* @summary get pre ipo company spv by id with investor id
|
|
6297
|
+
* @request GET:/ipos/pre-ipo-company-spv/{id}/investor/{investor_id}
|
|
6298
|
+
* @originalName getInvestor
|
|
6299
|
+
* @duplicate
|
|
6377
6300
|
* @secure
|
|
6378
6301
|
*/
|
|
6379
|
-
|
|
6302
|
+
getInvestorByIdAndInvestorId(id: string, investorId: string, query?: {
|
|
6303
|
+
/** default is false, if true documents will be included in the response */
|
|
6304
|
+
include_documents?: boolean;
|
|
6305
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetProIPOCompabySPVWithInvestorIDResponse, HandleError>>;
|
|
6380
6306
|
/**
|
|
6381
|
-
* @description
|
|
6382
|
-
* @tags
|
|
6383
|
-
* @name
|
|
6384
|
-
* @summary
|
|
6385
|
-
* @request
|
|
6307
|
+
* @description get pre ipo company spvs
|
|
6308
|
+
* @tags PreIPOCompanies
|
|
6309
|
+
* @name GetPreIpoCompanySpvs
|
|
6310
|
+
* @summary get pre ipo company spvs
|
|
6311
|
+
* @request GET:/ipos/pre-ipo-company-spvs
|
|
6386
6312
|
* @secure
|
|
6387
6313
|
*/
|
|
6388
|
-
|
|
6314
|
+
getPreIpoCompanySpvs(query: {
|
|
6315
|
+
/** company id */
|
|
6316
|
+
pre_ipo_company_id?: string;
|
|
6317
|
+
/** investment id */
|
|
6318
|
+
investment_id?: string;
|
|
6319
|
+
/** search by name */
|
|
6320
|
+
name?: string;
|
|
6321
|
+
/** search by company name */
|
|
6322
|
+
company_name?: string;
|
|
6323
|
+
/** how many records to return. Max value is 50 */
|
|
6324
|
+
limit: number;
|
|
6325
|
+
/** how many records to skip */
|
|
6326
|
+
offset: number;
|
|
6327
|
+
/** search by monark stage */
|
|
6328
|
+
monark_stage?: InsightGetPreIpoCompanySpvsParamsMonarkStageEnum;
|
|
6329
|
+
/** sort direction */
|
|
6330
|
+
direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
|
|
6331
|
+
/** sort field */
|
|
6332
|
+
field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
|
|
6333
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
|
|
6389
6334
|
/**
|
|
6390
|
-
* @description
|
|
6391
|
-
* @tags
|
|
6392
|
-
* @name
|
|
6393
|
-
* @summary
|
|
6394
|
-
* @request
|
|
6335
|
+
* @description get pre ipo company spv by id
|
|
6336
|
+
* @tags PreIPOCompanies
|
|
6337
|
+
* @name GetPreIpoCompanySpvsById
|
|
6338
|
+
* @summary get pre ipo company spv by id
|
|
6339
|
+
* @request GET:/ipos/pre-ipo-company-spvs/{id}
|
|
6340
|
+
* @originalName getPreIpoCompanySpvs
|
|
6341
|
+
* @duplicate
|
|
6395
6342
|
* @secure
|
|
6396
6343
|
*/
|
|
6397
|
-
|
|
6344
|
+
getPreIpoCompanySpvsById(id: string, query?: {
|
|
6345
|
+
/** default is false, if true documents will be included in the response */
|
|
6346
|
+
include_documents?: boolean;
|
|
6347
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
|
|
6398
6348
|
}
|
|
6399
6349
|
export class Public<HandleError extends boolean = boolean> {
|
|
6400
6350
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -6484,81 +6434,200 @@ export class Public<HandleError extends boolean = boolean> {
|
|
|
6484
6434
|
* @request GET:/public/symbol-search
|
|
6485
6435
|
* @secure
|
|
6486
6436
|
*/
|
|
6487
|
-
quoteFundamentalsSearch(query: {
|
|
6488
|
-
/** Search query */
|
|
6489
|
-
search_query: string;
|
|
6490
|
-
/** how many records to return. Max value is 50 */
|
|
6437
|
+
quoteFundamentalsSearch(query: {
|
|
6438
|
+
/** Search query */
|
|
6439
|
+
search_query: string;
|
|
6440
|
+
/** how many records to return. Max value is 50 */
|
|
6441
|
+
limit: number;
|
|
6442
|
+
/** how many records to skip */
|
|
6443
|
+
offset: number;
|
|
6444
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
|
|
6445
|
+
/**
|
|
6446
|
+
* @description Get top gainers
|
|
6447
|
+
* @tags Public
|
|
6448
|
+
* @name TopGainers
|
|
6449
|
+
* @summary Top Gainers
|
|
6450
|
+
* @request GET:/public/top-gainers
|
|
6451
|
+
* @secure
|
|
6452
|
+
*/
|
|
6453
|
+
topGainers(query: {
|
|
6454
|
+
/** sort direction - asc or desc */
|
|
6455
|
+
order_direction?: string;
|
|
6456
|
+
/** how many records to return. Max value is 50 */
|
|
6457
|
+
limit: number;
|
|
6458
|
+
/** how many records to skip */
|
|
6459
|
+
offset: number;
|
|
6460
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6461
|
+
/**
|
|
6462
|
+
* @description Get top stocks
|
|
6463
|
+
* @tags Public
|
|
6464
|
+
* @name TopStocks
|
|
6465
|
+
* @summary Top Stocks
|
|
6466
|
+
* @request GET:/public/top-stocks
|
|
6467
|
+
* @secure
|
|
6468
|
+
*/
|
|
6469
|
+
topStocks(query: {
|
|
6470
|
+
/** EQUITY|ETF|CRYPTO */
|
|
6471
|
+
stock_type: InsightTopStocksParamsStockTypeEnum;
|
|
6472
|
+
/** how many records to return. Max value is 50 */
|
|
6473
|
+
limit: number;
|
|
6474
|
+
/** how many records to skip */
|
|
6475
|
+
offset: number;
|
|
6476
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6477
|
+
}
|
|
6478
|
+
export class Quotes<HandleError extends boolean = boolean> {
|
|
6479
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6480
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6481
|
+
/**
|
|
6482
|
+
* @description Get single historical quote
|
|
6483
|
+
* @tags Quotes
|
|
6484
|
+
* @name GitHistoricalQuote
|
|
6485
|
+
* @summary Get single historical quote
|
|
6486
|
+
* @request GET:/historical/quote
|
|
6487
|
+
* @secure
|
|
6488
|
+
*/
|
|
6489
|
+
gitHistoricalQuote(query: {
|
|
6490
|
+
/** Symbol */
|
|
6491
|
+
symbol: string;
|
|
6492
|
+
/** Date */
|
|
6493
|
+
date: string;
|
|
6494
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
|
|
6495
|
+
/**
|
|
6496
|
+
* @description get quote history by symbol
|
|
6497
|
+
* @tags Quotes
|
|
6498
|
+
* @name GitQuoteHistory
|
|
6499
|
+
* @summary Get quote history
|
|
6500
|
+
* @request POST:/quote-history
|
|
6501
|
+
* @secure
|
|
6502
|
+
*/
|
|
6503
|
+
gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
|
|
6504
|
+
/**
|
|
6505
|
+
* @description Returns a list of quotes equity info for specified symbols.
|
|
6506
|
+
* @tags Quotes
|
|
6507
|
+
* @name GetQuotesEquityData
|
|
6508
|
+
* @summary Get Quotes Equity data
|
|
6509
|
+
* @request GET:/quotes/equity
|
|
6510
|
+
* @secure
|
|
6511
|
+
*/
|
|
6512
|
+
getQuotesEquityData(query: {
|
|
6513
|
+
/** Comma separated symbols */
|
|
6514
|
+
symbols: string;
|
|
6515
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
|
|
6516
|
+
}
|
|
6517
|
+
export class StockScreener<HandleError extends boolean = boolean> {
|
|
6518
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6519
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6520
|
+
/**
|
|
6521
|
+
* @description data for visual heat map
|
|
6522
|
+
* @tags StockScreener
|
|
6523
|
+
* @name StockMarketHeatmap
|
|
6524
|
+
* @summary data for visual heat map
|
|
6525
|
+
* @request GET:/heatmaps
|
|
6526
|
+
* @secure
|
|
6527
|
+
*/
|
|
6528
|
+
stockMarketHeatmap(query?: {
|
|
6529
|
+
/** Name of symbol list to fetch details for. Empty is default */
|
|
6530
|
+
heatmap_name?: string;
|
|
6531
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
|
|
6532
|
+
/**
|
|
6533
|
+
* @description create or update heat map preset
|
|
6534
|
+
* @tags StockScreener
|
|
6535
|
+
* @name CreateStockMarketHeatmapPreset
|
|
6536
|
+
* @summary create or update heat map preset
|
|
6537
|
+
* @request POST:/heatmaps
|
|
6538
|
+
* @secure
|
|
6539
|
+
*/
|
|
6540
|
+
createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6541
|
+
/**
|
|
6542
|
+
* @description Sector and Industry Group performance
|
|
6543
|
+
* @tags StockScreener
|
|
6544
|
+
* @name IndustriesPerformance
|
|
6545
|
+
* @summary get industries performance
|
|
6546
|
+
* @request POST:/industries-performance
|
|
6547
|
+
* @secure
|
|
6548
|
+
*/
|
|
6549
|
+
industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
|
|
6550
|
+
/**
|
|
6551
|
+
* @description filter stocks by params
|
|
6552
|
+
* @tags StockScreener
|
|
6553
|
+
* @name StockScreener
|
|
6554
|
+
* @summary filter stocks by params
|
|
6555
|
+
* @request POST:/stock-screener
|
|
6556
|
+
* @secure
|
|
6557
|
+
*/
|
|
6558
|
+
stockScreener(filter: InsightStockScreenerV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
6559
|
+
/**
|
|
6560
|
+
* @description get screener presets
|
|
6561
|
+
* @tags StockScreener
|
|
6562
|
+
* @name GetScreenerPresets
|
|
6563
|
+
* @summary get screener presets
|
|
6564
|
+
* @request GET:/stock-screener/presets
|
|
6565
|
+
* @secure
|
|
6566
|
+
*/
|
|
6567
|
+
getScreenerPresets(query: {
|
|
6568
|
+
/** how many records to return */
|
|
6491
6569
|
limit: number;
|
|
6492
6570
|
/** how many records to skip */
|
|
6493
6571
|
offset: number;
|
|
6494
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
6572
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
6495
6573
|
/**
|
|
6496
|
-
* @description
|
|
6497
|
-
* @tags
|
|
6498
|
-
* @name
|
|
6499
|
-
* @summary
|
|
6500
|
-
* @request
|
|
6574
|
+
* @description update screener preset
|
|
6575
|
+
* @tags StockScreener
|
|
6576
|
+
* @name UpdateScreenerPreset
|
|
6577
|
+
* @summary update screener preset
|
|
6578
|
+
* @request PUT:/stock-screener/presets
|
|
6501
6579
|
* @secure
|
|
6502
6580
|
*/
|
|
6503
|
-
|
|
6504
|
-
/** sort direction - asc or desc */
|
|
6505
|
-
order_direction?: string;
|
|
6506
|
-
/** how many records to return. Max value is 50 */
|
|
6507
|
-
limit: number;
|
|
6508
|
-
/** how many records to skip */
|
|
6509
|
-
offset: number;
|
|
6510
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6581
|
+
updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
6511
6582
|
/**
|
|
6512
|
-
* @description
|
|
6513
|
-
* @tags
|
|
6514
|
-
* @name
|
|
6515
|
-
* @summary
|
|
6516
|
-
* @request
|
|
6583
|
+
* @description create screener preset
|
|
6584
|
+
* @tags StockScreener
|
|
6585
|
+
* @name CreateOrScreenerPreset
|
|
6586
|
+
* @summary create screener preset
|
|
6587
|
+
* @request POST:/stock-screener/presets
|
|
6517
6588
|
* @secure
|
|
6518
6589
|
*/
|
|
6519
|
-
|
|
6520
|
-
/** EQUITY|ETF|CRYPTO */
|
|
6521
|
-
stock_type: InsightTopStocksParamsStockTypeEnum;
|
|
6522
|
-
/** how many records to return. Max value is 50 */
|
|
6523
|
-
limit: number;
|
|
6524
|
-
/** how many records to skip */
|
|
6525
|
-
offset: number;
|
|
6526
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6527
|
-
}
|
|
6528
|
-
export class UsageTracking<HandleError extends boolean = boolean> {
|
|
6529
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6530
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6590
|
+
createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
6531
6591
|
/**
|
|
6532
|
-
* @description
|
|
6533
|
-
* @tags
|
|
6534
|
-
* @name
|
|
6535
|
-
* @summary
|
|
6536
|
-
* @request
|
|
6592
|
+
* @description remove screener preset
|
|
6593
|
+
* @tags StockScreener
|
|
6594
|
+
* @name RemoveScreenerPreset
|
|
6595
|
+
* @summary remove screener preset
|
|
6596
|
+
* @request DELETE:/stock-screener/presets
|
|
6537
6597
|
* @secure
|
|
6538
6598
|
*/
|
|
6539
|
-
|
|
6599
|
+
removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6600
|
+
/**
|
|
6601
|
+
* @description get top symbols
|
|
6602
|
+
* @tags StockScreener
|
|
6603
|
+
* @name GetTopSymbols
|
|
6604
|
+
* @summary get top symbols
|
|
6605
|
+
* @request POST:/stock-screener/top
|
|
6606
|
+
* @secure
|
|
6607
|
+
*/
|
|
6608
|
+
getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
6540
6609
|
}
|
|
6541
|
-
export class
|
|
6610
|
+
export class StockScreenerV2<HandleError extends boolean = boolean> {
|
|
6542
6611
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6543
6612
|
constructor(apiClient: JwtClient<HandleError>);
|
|
6544
6613
|
/**
|
|
6545
|
-
* @description
|
|
6546
|
-
* @tags
|
|
6547
|
-
* @name
|
|
6548
|
-
* @summary
|
|
6549
|
-
* @request POST:/
|
|
6614
|
+
* @description filter stocks by params
|
|
6615
|
+
* @tags StockScreener
|
|
6616
|
+
* @name StockScreener
|
|
6617
|
+
* @summary filter stocks by params
|
|
6618
|
+
* @request POST:/stock-screener
|
|
6550
6619
|
* @secure
|
|
6551
6620
|
*/
|
|
6552
|
-
|
|
6621
|
+
stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
6553
6622
|
/**
|
|
6554
|
-
* @description get
|
|
6555
|
-
* @tags
|
|
6556
|
-
* @name
|
|
6557
|
-
* @summary get
|
|
6558
|
-
* @request POST:/
|
|
6623
|
+
* @description get top symbols
|
|
6624
|
+
* @tags StockScreener
|
|
6625
|
+
* @name GetTopSymbols
|
|
6626
|
+
* @summary get top symbols
|
|
6627
|
+
* @request POST:/stock-screener/top
|
|
6559
6628
|
* @secure
|
|
6560
6629
|
*/
|
|
6561
|
-
|
|
6630
|
+
getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
6562
6631
|
}
|
|
6563
6632
|
export class TipRank<HandleError extends boolean = boolean> {
|
|
6564
6633
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -6926,269 +6995,200 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6926
6995
|
Authorization?: string;
|
|
6927
6996
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
|
|
6928
6997
|
}
|
|
6929
|
-
export
|
|
6930
|
-
|
|
6931
|
-
|
|
6932
|
-
|
|
6933
|
-
|
|
6934
|
-
|
|
6935
|
-
|
|
6936
|
-
|
|
6937
|
-
|
|
6938
|
-
|
|
6939
|
-
|
|
6940
|
-
|
|
6941
|
-
close_price_asof: string;
|
|
6942
|
-
close_ytw: number;
|
|
6943
|
-
convertible: boolean;
|
|
6944
|
-
country: string;
|
|
6945
|
-
country_code: string;
|
|
6946
|
-
country_domicile: string;
|
|
6947
|
-
country_issue: string;
|
|
6948
|
-
coupon: number;
|
|
6949
|
-
coupon_frequency: string;
|
|
6950
|
-
coupon_type: string;
|
|
6951
|
-
currency: string;
|
|
6952
|
-
cusip: string;
|
|
6953
|
-
dated_date: string;
|
|
6954
|
-
daycount: string;
|
|
6955
|
-
description: string;
|
|
6956
|
-
description_short: string;
|
|
6957
|
-
duration: number;
|
|
6958
|
-
first_coupon_date: string;
|
|
6959
|
-
insured: boolean;
|
|
6960
|
-
isin: string;
|
|
6961
|
-
issue_date: string;
|
|
6962
|
-
issue_minimum_denomination: number;
|
|
6963
|
-
issue_price: number;
|
|
6964
|
-
issue_size: number;
|
|
6965
|
-
issuer: string;
|
|
6966
|
-
last_coupon_date: string;
|
|
6967
|
-
liquidity_institutional_aggregate: number;
|
|
6968
|
-
liquidity_institutional_buy: number;
|
|
6969
|
-
liquidity_institutional_sell: number;
|
|
6970
|
-
liquidity_micro_aggregate: number;
|
|
6971
|
-
liquidity_micro_buy: number;
|
|
6972
|
-
liquidity_micro_sell: number;
|
|
6973
|
-
liquidity_retail_aggregate: number;
|
|
6974
|
-
liquidity_retail_buy: number;
|
|
6975
|
-
liquidity_retail_sell: number;
|
|
6976
|
-
maturity_date: string;
|
|
6977
|
-
municipal_state: string;
|
|
6978
|
-
municipal_taxable_federal: boolean;
|
|
6979
|
-
municipal_type: string;
|
|
6980
|
-
next_call_date: string;
|
|
6981
|
-
next_call_price: number;
|
|
6982
|
-
next_coupon_date: string;
|
|
6983
|
-
par_value: number;
|
|
6984
|
-
perpetual: boolean;
|
|
6985
|
-
private_placement: boolean;
|
|
6986
|
-
purpose: string;
|
|
6987
|
-
puttable: boolean;
|
|
6988
|
-
reg_s: boolean;
|
|
6989
|
-
sector: string;
|
|
6990
|
-
seniority: string;
|
|
6991
|
-
settlement_convention: string;
|
|
6992
|
-
sinking_fund: boolean;
|
|
6993
|
-
sp_creditwatch: string;
|
|
6994
|
-
sp_creditwatch_date: string;
|
|
6995
|
-
sp_outlook: string;
|
|
6996
|
-
sp_outlook_date: string;
|
|
6997
|
-
sp_rating: string;
|
|
6998
|
-
sp_rating_date: string;
|
|
6999
|
-
status: string;
|
|
7000
|
-
ticker: string;
|
|
7001
|
-
treasury_subtype: string;
|
|
7002
|
-
type: string;
|
|
7003
|
-
updated_at: string;
|
|
7004
|
-
}
|
|
7005
|
-
export interface InsightGetFixedIncomeEntriesResponseV2 {
|
|
7006
|
-
count: number;
|
|
7007
|
-
data: InsightFixedIncomeV2[];
|
|
6998
|
+
export class UsageTracking<HandleError extends boolean = boolean> {
|
|
6999
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
7000
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
7001
|
+
/**
|
|
7002
|
+
* @description get usage date per branch for a period
|
|
7003
|
+
* @tags UsageTracking
|
|
7004
|
+
* @name GetUsageData
|
|
7005
|
+
* @summary get insight usage data
|
|
7006
|
+
* @request POST:/tracking/usage
|
|
7007
|
+
* @secure
|
|
7008
|
+
*/
|
|
7009
|
+
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
|
|
7008
7010
|
}
|
|
7009
|
-
export
|
|
7010
|
-
|
|
7011
|
-
|
|
7012
|
-
/**
|
|
7013
|
-
|
|
7014
|
-
|
|
7015
|
-
|
|
7016
|
-
|
|
7017
|
-
|
|
7018
|
-
|
|
7019
|
-
|
|
7020
|
-
|
|
7021
|
-
|
|
7022
|
-
|
|
7011
|
+
export class WorldMarkets<HandleError extends boolean = boolean> {
|
|
7012
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
7013
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
7014
|
+
/**
|
|
7015
|
+
* @description Get continents
|
|
7016
|
+
* @tags World Markets
|
|
7017
|
+
* @name ContinentGet
|
|
7018
|
+
* @summary Get continents
|
|
7019
|
+
* @request GET:/continents
|
|
7020
|
+
* @secure
|
|
7021
|
+
*/
|
|
7022
|
+
continentGet(query: {
|
|
7023
|
+
/** Query limit */
|
|
7024
|
+
limit: number;
|
|
7025
|
+
/** Query offset */
|
|
7026
|
+
offset: number;
|
|
7027
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
7028
|
+
/**
|
|
7029
|
+
* @description Edit continent
|
|
7030
|
+
* @tags World Markets
|
|
7031
|
+
* @name ContinentEdit
|
|
7032
|
+
* @summary Edit continent
|
|
7033
|
+
* @request PUT:/continents
|
|
7034
|
+
* @secure
|
|
7035
|
+
*/
|
|
7036
|
+
continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
7037
|
+
/**
|
|
7038
|
+
* @description Create continents
|
|
7039
|
+
* @tags World Markets
|
|
7040
|
+
* @name ContinentCreate
|
|
7041
|
+
* @summary Create continents
|
|
7042
|
+
* @request POST:/continents
|
|
7043
|
+
* @secure
|
|
7044
|
+
*/
|
|
7045
|
+
continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
7046
|
+
/**
|
|
7047
|
+
* @description Delete continent
|
|
7048
|
+
* @tags World Markets
|
|
7049
|
+
* @name ContinentDelete
|
|
7050
|
+
* @summary Delete continent
|
|
7051
|
+
* @request DELETE:/continents
|
|
7052
|
+
* @secure
|
|
7053
|
+
*/
|
|
7054
|
+
continentDelete(query: {
|
|
7055
|
+
/** continent id */
|
|
7056
|
+
id: string;
|
|
7057
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
7058
|
+
/**
|
|
7059
|
+
* @description Get country codes
|
|
7060
|
+
* @tags World Markets
|
|
7061
|
+
* @name CountryCodeGet
|
|
7062
|
+
* @summary Get country codes
|
|
7063
|
+
* @request GET:/country-codes
|
|
7064
|
+
* @secure
|
|
7065
|
+
*/
|
|
7066
|
+
countryCodeGet(query: {
|
|
7067
|
+
/** Query limit */
|
|
7068
|
+
limit: number;
|
|
7069
|
+
/** Query offset */
|
|
7070
|
+
offset: number;
|
|
7071
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
7023
7072
|
/**
|
|
7024
|
-
* @
|
|
7025
|
-
* @
|
|
7073
|
+
* @description Edit country code
|
|
7074
|
+
* @tags World Markets
|
|
7075
|
+
* @name CountryCodeEdit
|
|
7076
|
+
* @summary Edit country code
|
|
7077
|
+
* @request PUT:/country-codes
|
|
7078
|
+
* @secure
|
|
7026
7079
|
*/
|
|
7027
|
-
|
|
7028
|
-
/** @example true */
|
|
7029
|
-
has_ticker?: boolean;
|
|
7030
|
-
/** @example true */
|
|
7031
|
-
insured?: boolean;
|
|
7032
|
-
/** @example ["US655664AH33","US9128286R69"] */
|
|
7033
|
-
isin?: string[];
|
|
7034
|
-
issue_date?: InsightBeforeAndAfterV2;
|
|
7080
|
+
countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
7035
7081
|
/**
|
|
7036
|
-
* @
|
|
7037
|
-
* @
|
|
7082
|
+
* @description Add country codes
|
|
7083
|
+
* @tags World Markets
|
|
7084
|
+
* @name CountryCodeAdd
|
|
7085
|
+
* @summary Add country codes
|
|
7086
|
+
* @request POST:/country-codes
|
|
7087
|
+
* @secure
|
|
7038
7088
|
*/
|
|
7039
|
-
|
|
7040
|
-
maturity?: InsightBeforeAndAfterV2;
|
|
7041
|
-
/** @example ["NY"] */
|
|
7042
|
-
municipal_states?: string[];
|
|
7043
|
-
/** @example true */
|
|
7044
|
-
municipal_tax?: boolean;
|
|
7045
|
-
/** @example ["general_obligation"] */
|
|
7046
|
-
municipal_types?: string[];
|
|
7047
|
-
pagination: InsightPaginationV2;
|
|
7048
|
-
purposes?: string[];
|
|
7049
|
-
/** @example ["SOVEREIGN"] */
|
|
7050
|
-
sectors?: string[];
|
|
7051
|
-
sorts?: InsightOrderingV2[];
|
|
7052
|
-
/** @example ["AAA"] */
|
|
7053
|
-
sp_ratings?: string[];
|
|
7054
|
-
/** @example ["called","outstanding"] */
|
|
7055
|
-
statuses?: string[];
|
|
7056
|
-
tickers?: string[];
|
|
7057
|
-
/** @example ["corporate"] */
|
|
7058
|
-
types?: string[];
|
|
7059
|
-
}
|
|
7060
|
-
export interface InsightGetTopSymbolsRequestV2 {
|
|
7061
|
-
exchange?: string[];
|
|
7062
|
-
market_cap?: InsightLessAndMoreV2;
|
|
7063
|
-
pagination?: InsightPaginationV2;
|
|
7064
|
-
price?: InsightLessAndMoreV2;
|
|
7065
|
-
sorts?: InsightOrderingV2[];
|
|
7066
|
-
volume?: InsightLessAndMoreV2;
|
|
7067
|
-
}
|
|
7068
|
-
export interface InsightIncludeExcludeV2 {
|
|
7069
|
-
exclude?: string[];
|
|
7070
|
-
include?: string[];
|
|
7071
|
-
}
|
|
7072
|
-
export interface InsightLessAndMoreV2 {
|
|
7073
|
-
less_than?: number;
|
|
7074
|
-
more_than?: number;
|
|
7075
|
-
}
|
|
7076
|
-
export enum InsightOrderDirectionV2 {
|
|
7077
|
-
OrderASC = "asc",
|
|
7078
|
-
OrderDESC = "desc"
|
|
7079
|
-
}
|
|
7080
|
-
export interface InsightOrderingV2 {
|
|
7089
|
+
countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
7081
7090
|
/**
|
|
7082
|
-
* @
|
|
7083
|
-
* @
|
|
7091
|
+
* @description Delete country code
|
|
7092
|
+
* @tags World Markets
|
|
7093
|
+
* @name CountryCodeDelete
|
|
7094
|
+
* @summary Delete country code
|
|
7095
|
+
* @request DELETE:/country-codes
|
|
7096
|
+
* @secure
|
|
7084
7097
|
*/
|
|
7085
|
-
|
|
7098
|
+
countryCodeDelete(query: {
|
|
7099
|
+
/** a3 code */
|
|
7100
|
+
a3code: string;
|
|
7101
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
7086
7102
|
/**
|
|
7087
|
-
*
|
|
7088
|
-
*
|
|
7089
|
-
*
|
|
7090
|
-
* @
|
|
7103
|
+
* @description Get global indexes
|
|
7104
|
+
* @tags World Markets
|
|
7105
|
+
* @name GlobalIndexGet
|
|
7106
|
+
* @summary Get global indexes
|
|
7107
|
+
* @request GET:/global-indexes
|
|
7108
|
+
* @secure
|
|
7091
7109
|
*/
|
|
7092
|
-
|
|
7093
|
-
|
|
7094
|
-
|
|
7110
|
+
globalIndexGet(query: {
|
|
7111
|
+
/** Query limit */
|
|
7112
|
+
limit: number;
|
|
7113
|
+
/** Query offset */
|
|
7114
|
+
offset: number;
|
|
7115
|
+
/** Continent code for filtering */
|
|
7116
|
+
continent?: string;
|
|
7117
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
7095
7118
|
/**
|
|
7096
|
-
* @
|
|
7097
|
-
* @
|
|
7119
|
+
* @description Edit global index
|
|
7120
|
+
* @tags World Markets
|
|
7121
|
+
* @name GlobalIndexEdit
|
|
7122
|
+
* @summary Edit global index
|
|
7123
|
+
* @request PUT:/global-indexes
|
|
7124
|
+
* @secure
|
|
7098
7125
|
*/
|
|
7099
|
-
|
|
7126
|
+
globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
7100
7127
|
/**
|
|
7101
|
-
* @
|
|
7102
|
-
* @
|
|
7103
|
-
* @
|
|
7128
|
+
* @description Add global indexes
|
|
7129
|
+
* @tags World Markets
|
|
7130
|
+
* @name GlobalIndexAdd
|
|
7131
|
+
* @summary Add global indexes
|
|
7132
|
+
* @request POST:/global-indexes
|
|
7133
|
+
* @secure
|
|
7104
7134
|
*/
|
|
7105
|
-
|
|
7106
|
-
}
|
|
7107
|
-
export interface InsightStockScreenerQuoteV2 {
|
|
7108
|
-
average_volume_30d: number;
|
|
7109
|
-
company_name: string;
|
|
7110
|
-
dividend_ex_date: string;
|
|
7111
|
-
dividend_pay_date: string;
|
|
7112
|
-
dividend_percent: number;
|
|
7113
|
-
exchange: string;
|
|
7114
|
-
exchange_name: string;
|
|
7115
|
-
gap: number;
|
|
7116
|
-
industry: string;
|
|
7117
|
-
industry_code: string;
|
|
7118
|
-
last_price: number;
|
|
7119
|
-
market_cap: number;
|
|
7120
|
-
pe_ratio: number;
|
|
7121
|
-
price_change: number;
|
|
7122
|
-
price_change_percent: number;
|
|
7123
|
-
symbol: string;
|
|
7124
|
-
volume: number;
|
|
7125
|
-
}
|
|
7126
|
-
export interface InsightStockScreenerRequestV2 {
|
|
7127
|
-
average_volume_30d?: InsightLessAndMoreV2;
|
|
7128
|
-
dividend_ex_date?: InsightBeforeAndAfterV2;
|
|
7129
|
-
dividend_pay_date?: InsightBeforeAndAfterV2;
|
|
7130
|
-
dividend_percent?: InsightLessAndMoreV2;
|
|
7131
|
-
exchange?: InsightIncludeExcludeV2;
|
|
7132
|
-
gap?: InsightLessAndMoreV2;
|
|
7133
|
-
industry?: InsightIncludeExcludeV2;
|
|
7134
|
-
market_cap?: InsightLessAndMoreV2;
|
|
7135
|
-
pagination: InsightPaginationV2;
|
|
7136
|
-
pe_ratio?: InsightLessAndMoreV2;
|
|
7137
|
-
price?: InsightLessAndMoreV2;
|
|
7138
|
-
sorts?: InsightOrderingV2[];
|
|
7139
|
-
/** @example "ADR" */
|
|
7140
|
-
stock_type?: string;
|
|
7141
|
-
volume?: InsightLessAndMoreV2;
|
|
7142
|
-
}
|
|
7143
|
-
export interface InsightStockScreenerResponseV2 {
|
|
7144
|
-
current_page: number;
|
|
7145
|
-
data: InsightStockScreenerQuoteV2[];
|
|
7146
|
-
page_count: number;
|
|
7147
|
-
status: number;
|
|
7148
|
-
total_records: number;
|
|
7149
|
-
}
|
|
7150
|
-
/**
|
|
7151
|
-
* @default "asc"
|
|
7152
|
-
* @example "asc"
|
|
7153
|
-
*/
|
|
7154
|
-
export enum InsightOrderingDirectionEnumV2 {
|
|
7155
|
-
Asc = "asc",
|
|
7156
|
-
Desc = "desc"
|
|
7157
|
-
}
|
|
7158
|
-
export class FixedIncomeV2<HandleError extends boolean = boolean> {
|
|
7159
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
7160
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
7135
|
+
globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
7161
7136
|
/**
|
|
7162
|
-
* @description
|
|
7163
|
-
* @tags
|
|
7164
|
-
* @name
|
|
7165
|
-
* @summary
|
|
7166
|
-
* @request
|
|
7137
|
+
* @description Edit global index
|
|
7138
|
+
* @tags World Markets
|
|
7139
|
+
* @name GlobalIndexDelete
|
|
7140
|
+
* @summary Delete global index
|
|
7141
|
+
* @request DELETE:/global-indexes
|
|
7167
7142
|
* @secure
|
|
7168
7143
|
*/
|
|
7169
|
-
|
|
7170
|
-
|
|
7171
|
-
|
|
7172
|
-
|
|
7173
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
7144
|
+
globalIndexDelete(query: {
|
|
7145
|
+
/** a3 code */
|
|
7146
|
+
a3code: string;
|
|
7147
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
7174
7148
|
/**
|
|
7175
|
-
* @description
|
|
7176
|
-
* @tags
|
|
7177
|
-
* @name
|
|
7178
|
-
* @summary
|
|
7179
|
-
* @request
|
|
7149
|
+
* @description Get regions
|
|
7150
|
+
* @tags World Markets
|
|
7151
|
+
* @name RegionGet
|
|
7152
|
+
* @summary Get regions
|
|
7153
|
+
* @request GET:/regions
|
|
7180
7154
|
* @secure
|
|
7181
7155
|
*/
|
|
7182
|
-
|
|
7156
|
+
regionGet(query: {
|
|
7157
|
+
/** Query limit */
|
|
7158
|
+
limit: number;
|
|
7159
|
+
/** Query offset */
|
|
7160
|
+
offset: number;
|
|
7161
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
7183
7162
|
/**
|
|
7184
|
-
* @description
|
|
7185
|
-
* @tags
|
|
7186
|
-
* @name
|
|
7187
|
-
* @summary
|
|
7188
|
-
* @request
|
|
7163
|
+
* @description Edit region
|
|
7164
|
+
* @tags World Markets
|
|
7165
|
+
* @name RegionEdit
|
|
7166
|
+
* @summary Edit region
|
|
7167
|
+
* @request PUT:/regions
|
|
7189
7168
|
* @secure
|
|
7190
7169
|
*/
|
|
7191
|
-
|
|
7170
|
+
regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
7171
|
+
/**
|
|
7172
|
+
* @description Create regions
|
|
7173
|
+
* @tags World Markets
|
|
7174
|
+
* @name RegionCreate
|
|
7175
|
+
* @summary Create regions
|
|
7176
|
+
* @request POST:/regions
|
|
7177
|
+
* @secure
|
|
7178
|
+
*/
|
|
7179
|
+
regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
7180
|
+
/**
|
|
7181
|
+
* @description Delete region
|
|
7182
|
+
* @tags World Markets
|
|
7183
|
+
* @name RegionDelete
|
|
7184
|
+
* @summary Delete region
|
|
7185
|
+
* @request DELETE:/regions
|
|
7186
|
+
* @secure
|
|
7187
|
+
*/
|
|
7188
|
+
regionDelete(query: {
|
|
7189
|
+
/** region id */
|
|
7190
|
+
id: string;
|
|
7191
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
7192
7192
|
}
|
|
7193
7193
|
export class InsightApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
7194
7194
|
readonly config: JwtClientConfig<HandleError>;
|