@orbis-systems/orbis-api-clients 0.8.10 → 1.1.0
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 +833 -794
- 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 +3385 -9823
- 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.d.ts +41 -21
- package/dist/index.d.ts.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 +1613 -1294
- 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 +273 -220
- 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 +4076 -4021
- 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 +958 -879
- 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 +157 -155
package/dist/insight/index.d.ts
CHANGED
|
@@ -1,8 +1,23 @@
|
|
|
1
1
|
import { AxiosError, AxiosInstance, AxiosRequestConfig, HttpStatusCode } from "axios";
|
|
2
|
-
|
|
2
|
+
enum CaseFormat {
|
|
3
|
+
Camel = "camel",
|
|
4
|
+
Snake = "snake",
|
|
5
|
+
Original = "original"
|
|
6
|
+
}
|
|
7
|
+
type CamelCase<S extends string> = S extends `${infer T}_${infer U}` ? `${Lowercase<T>}${Capitalize<CamelCase<U>>}` : S extends Uppercase<S> ? Lowercase<S> : S;
|
|
8
|
+
type SnakeCase<S extends string> = S extends `${infer T}${infer U}` ? T extends Uppercase<T> ? T extends Lowercase<T> ? `${T}${SnakeCase<U>}` : `_${Lowercase<T>}${SnakeCase<U>}` : `${T}${SnakeCase<U>}` : S;
|
|
9
|
+
type CamelCaseKeys<T> = T extends Array<infer U> ? Array<CamelCaseKeys<U>> : T extends object ? {
|
|
10
|
+
[K in keyof T as CamelCase<K & string>]: CamelCaseKeys<T[K]>;
|
|
11
|
+
} : T;
|
|
12
|
+
type SnakeCaseKeys<T> = T extends Array<infer U> ? Array<SnakeCaseKeys<U>> : T extends object ? {
|
|
13
|
+
[K in keyof T as SnakeCase<K & string>]: SnakeCaseKeys<T[K]>;
|
|
14
|
+
} : T;
|
|
15
|
+
type TransformData<T, F extends CaseFormat | undefined> = CaseFormat.Original | undefined extends F ? T : F extends CaseFormat.Camel ? CamelCaseKeys<T> : F extends CaseFormat.Snake ? SnakeCaseKeys<T> : T;
|
|
16
|
+
interface BaseClientConfig<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
3
17
|
debug?: boolean;
|
|
4
18
|
baseUrl: string;
|
|
5
19
|
handleError?: HandleError;
|
|
20
|
+
caseFormat?: Format;
|
|
6
21
|
storage?: Storage;
|
|
7
22
|
defaultSecure?: boolean;
|
|
8
23
|
authDataStorageKey?: string;
|
|
@@ -25,43 +40,46 @@ type ResponseStatus = {
|
|
|
25
40
|
status: HttpStatusCode | -1;
|
|
26
41
|
statusText: string;
|
|
27
42
|
};
|
|
28
|
-
type SuccessClientResponse<Data = unknown> = ResponseStatus & {
|
|
43
|
+
type SuccessClientResponse<Data = unknown, RawData = unknown> = ResponseStatus & {
|
|
29
44
|
success: true;
|
|
30
45
|
data: Data;
|
|
46
|
+
rawData: RawData;
|
|
31
47
|
};
|
|
32
48
|
type ErrorClientResponse = ResponseStatus & {
|
|
33
49
|
success: false;
|
|
34
50
|
data?: any;
|
|
51
|
+
rawData?: any;
|
|
35
52
|
error: unknown;
|
|
36
53
|
};
|
|
37
|
-
type ClientResponse<Data = unknown, HandleError extends boolean = boolean> = HandleError extends true ? SuccessClientResponse<Data> | ErrorClientResponse : SuccessClientResponse<Data>;
|
|
38
|
-
declare abstract class BaseClient<HandleError extends boolean = boolean, AuthData = unknown> {
|
|
39
|
-
protected readonly config: BaseClientConfig<HandleError>;
|
|
54
|
+
type ClientResponse<Data = unknown, HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> = HandleError extends true ? SuccessClientResponse<TransformData<Data, Format>, Data> | ErrorClientResponse : SuccessClientResponse<TransformData<Data, Format>, Data>;
|
|
55
|
+
declare abstract class BaseClient<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original, AuthData = unknown> {
|
|
56
|
+
protected readonly config: BaseClientConfig<HandleError, Format>;
|
|
40
57
|
protected readonly axiosInstance: AxiosInstance;
|
|
41
58
|
protected readonly storage: Storage;
|
|
42
|
-
constructor(config: BaseClientConfig<HandleError>);
|
|
59
|
+
constructor(config: BaseClientConfig<HandleError, Format>);
|
|
60
|
+
protected transformData<T>(data: any): TransformData<T, Format>;
|
|
43
61
|
protected stringifyFormItem(formItem: unknown): string;
|
|
44
62
|
protected createFormData(input: Record<string, unknown>): FormData;
|
|
45
|
-
request<Data = unknown, Error = unknown, Body = unknown>(requestConfig: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
|
|
46
|
-
get<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
|
|
47
|
-
delete<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
|
|
48
|
-
head<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
|
|
49
|
-
options<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
|
|
50
|
-
post<Data = unknown, Error = unknown, Body = unknown>(url: string, data?: Body, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
|
|
51
|
-
put<Data = unknown, Error = unknown, Body = unknown>(url: string, data?: Body, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
|
|
52
|
-
patch<Data = unknown, Error = unknown, Body = unknown>(url: string, data?: Body, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
|
|
63
|
+
request<Data = unknown, Error = unknown, Body = unknown>(requestConfig: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError, Format>>;
|
|
64
|
+
get<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError, Format>>;
|
|
65
|
+
delete<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError, Format>>;
|
|
66
|
+
head<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError, Format>>;
|
|
67
|
+
options<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError, Format>>;
|
|
68
|
+
post<Data = unknown, Error = unknown, Body = unknown>(url: string, data?: Body, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError, Format>>;
|
|
69
|
+
put<Data = unknown, Error = unknown, Body = unknown>(url: string, data?: Body, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError, Format>>;
|
|
70
|
+
patch<Data = unknown, Error = unknown, Body = unknown>(url: string, data?: Body, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError, Format>>;
|
|
53
71
|
getAxios(): AxiosInstance;
|
|
54
72
|
setAuthData(data: AuthData | null): void;
|
|
55
73
|
getAuthData(): AuthData | null;
|
|
56
|
-
getConfig(): BaseClientConfig<HandleError>;
|
|
74
|
+
getConfig(): BaseClientConfig<HandleError, Format>;
|
|
57
75
|
protected abstract prepareAuthRequestConfig(): Promise<Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>>;
|
|
58
76
|
}
|
|
59
|
-
declare class BaseApi<HandleError extends boolean = boolean, ApiClient extends BaseClient<HandleError> = BaseClient<HandleError>> {
|
|
77
|
+
declare abstract class BaseApi<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original, ApiClient extends BaseClient<HandleError, Format, unknown> = BaseClient<HandleError, Format>> {
|
|
60
78
|
protected readonly apiClient: ApiClient;
|
|
61
79
|
constructor(apiClient: ApiClient);
|
|
62
80
|
getApiClient(): ApiClient;
|
|
63
81
|
}
|
|
64
|
-
interface JwtClientConfig<HandleError extends boolean = boolean, AuthData extends JwtAuthData = JwtAuthData> extends BaseClientConfig<HandleError> {
|
|
82
|
+
interface JwtClientConfig<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original, AuthData extends JwtAuthData = JwtAuthData> extends BaseClientConfig<HandleError, Format> {
|
|
65
83
|
authSchema?: string;
|
|
66
84
|
autoRenewToken?: boolean;
|
|
67
85
|
onRenewTokens?: () => Promise<AuthData>;
|
|
@@ -70,10 +88,10 @@ interface JwtAuthData {
|
|
|
70
88
|
accessToken: string;
|
|
71
89
|
refreshToken?: string;
|
|
72
90
|
}
|
|
73
|
-
declare class JwtClient<HandleError extends boolean = boolean, AuthData extends JwtAuthData = JwtAuthData> extends BaseClient<HandleError, AuthData> {
|
|
74
|
-
protected readonly config: JwtClientConfig<HandleError, AuthData>;
|
|
75
|
-
constructor(config: JwtClientConfig<HandleError, AuthData>);
|
|
76
|
-
getConfig(): JwtClientConfig<HandleError>;
|
|
91
|
+
declare class JwtClient<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original, AuthData extends JwtAuthData = JwtAuthData> extends BaseClient<HandleError, Format, AuthData> {
|
|
92
|
+
protected readonly config: JwtClientConfig<HandleError, Format, AuthData>;
|
|
93
|
+
constructor(config: JwtClientConfig<HandleError, Format, AuthData>);
|
|
94
|
+
getConfig(): JwtClientConfig<HandleError, Format, AuthData>;
|
|
77
95
|
setRenewTokensCallback(renewTokensCallback: () => Promise<AuthData>): void;
|
|
78
96
|
protected prepareAuthRequestConfig(): Promise<Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>>;
|
|
79
97
|
protected renewTokens(): Promise<AuthData>;
|
|
@@ -373,6 +391,12 @@ export interface InsightAuthorProfileResponse {
|
|
|
373
391
|
articles: InsightArticle[];
|
|
374
392
|
author: InsightAuthorInfo;
|
|
375
393
|
}
|
|
394
|
+
export interface InsightBasicSecurityProfile {
|
|
395
|
+
mic: string;
|
|
396
|
+
share_class_description: string;
|
|
397
|
+
share_class_status: string;
|
|
398
|
+
symbol: string;
|
|
399
|
+
}
|
|
376
400
|
export interface InsightBeforeAndAfter {
|
|
377
401
|
after?: string;
|
|
378
402
|
before?: string;
|
|
@@ -530,6 +554,7 @@ export interface InsightCombinedProfileResponse {
|
|
|
530
554
|
/** @example "CA" */
|
|
531
555
|
province: string;
|
|
532
556
|
sector: InsightSymbolIndustries;
|
|
557
|
+
securities: InsightBasicSecurityProfile[];
|
|
533
558
|
/** @example "Apple" */
|
|
534
559
|
short_company_name: string;
|
|
535
560
|
/** @example "Manufactures mobile communication and media device" */
|
|
@@ -571,6 +596,7 @@ export interface InsightCompanyProfile {
|
|
|
571
596
|
market_cap: number;
|
|
572
597
|
phone: string;
|
|
573
598
|
sector: InsightSymbolIndustries;
|
|
599
|
+
securities: InsightBasicSecurityProfile[];
|
|
574
600
|
short_company_name: string;
|
|
575
601
|
short_description: string;
|
|
576
602
|
symbol: string;
|
|
@@ -633,6 +659,19 @@ export interface InsightCreateCustomIndexRequest {
|
|
|
633
659
|
*/
|
|
634
660
|
private_name: string;
|
|
635
661
|
}
|
|
662
|
+
export interface InsightCreateFeaturedArticleConfigRequest {
|
|
663
|
+
/** @example ["web","mobile"] */
|
|
664
|
+
channels?: string[];
|
|
665
|
+
/** @example true */
|
|
666
|
+
enabled?: boolean;
|
|
667
|
+
/** @example ["politics","sports"] */
|
|
668
|
+
excluded_tags?: string[];
|
|
669
|
+
/** @example ["high","medium","low"] */
|
|
670
|
+
importance?: string[];
|
|
671
|
+
/** @example ["finance","technology"] */
|
|
672
|
+
required_tags?: string[];
|
|
673
|
+
schedule?: InsightFeaturedArticleSchedule;
|
|
674
|
+
}
|
|
636
675
|
export interface InsightCreateFeaturedArticlesRequest {
|
|
637
676
|
/** @example "https://example.com/image.jpg" */
|
|
638
677
|
image: string;
|
|
@@ -901,6 +940,17 @@ export interface InsightFeaturedArticle {
|
|
|
901
940
|
title: string;
|
|
902
941
|
updated: string;
|
|
903
942
|
}
|
|
943
|
+
export interface InsightFeaturedArticleConfig {
|
|
944
|
+
created: string;
|
|
945
|
+
payload: Record<string, any>;
|
|
946
|
+
updated: string;
|
|
947
|
+
}
|
|
948
|
+
export interface InsightFeaturedArticleSchedule {
|
|
949
|
+
/** @example "1h" */
|
|
950
|
+
recurrence: string;
|
|
951
|
+
/** @example "2024-01-01T00:00:00Z" */
|
|
952
|
+
start_time: string;
|
|
953
|
+
}
|
|
904
954
|
export interface InsightFilterCustomIndexesRequest {
|
|
905
955
|
paging: InsightPaging;
|
|
906
956
|
symbols?: string[];
|
|
@@ -989,6 +1039,74 @@ export interface InsightFixedIncome {
|
|
|
989
1039
|
type: string;
|
|
990
1040
|
updated_at: string;
|
|
991
1041
|
}
|
|
1042
|
+
export interface InsightFund {
|
|
1043
|
+
actively_managed: boolean;
|
|
1044
|
+
as_of_date: string;
|
|
1045
|
+
asset: string;
|
|
1046
|
+
average_calendar_month_daily_volume: number;
|
|
1047
|
+
category: string;
|
|
1048
|
+
currency: string;
|
|
1049
|
+
cusip: string;
|
|
1050
|
+
expense_ratio: number;
|
|
1051
|
+
fund_net_assets: number;
|
|
1052
|
+
fund_type: string;
|
|
1053
|
+
inception_date: string;
|
|
1054
|
+
indexing_approach: {
|
|
1055
|
+
census_replication: boolean;
|
|
1056
|
+
derivative_based: boolean;
|
|
1057
|
+
not_applicable: boolean;
|
|
1058
|
+
physical_full: boolean;
|
|
1059
|
+
physical_sample: boolean;
|
|
1060
|
+
stratified_sampling: boolean;
|
|
1061
|
+
structured: boolean;
|
|
1062
|
+
synthetic_replication: boolean;
|
|
1063
|
+
};
|
|
1064
|
+
inverse: boolean;
|
|
1065
|
+
isin: string;
|
|
1066
|
+
leverage: boolean;
|
|
1067
|
+
leverage_ratio: number;
|
|
1068
|
+
month_end_nav: number;
|
|
1069
|
+
name: string;
|
|
1070
|
+
number_of_bond_holding_long: number;
|
|
1071
|
+
number_of_bond_holding_net: number;
|
|
1072
|
+
number_of_holding_long: number;
|
|
1073
|
+
number_of_holding_net: number;
|
|
1074
|
+
number_of_stock_holding_long: number;
|
|
1075
|
+
number_of_stock_holding_net: number;
|
|
1076
|
+
performance: {
|
|
1077
|
+
inception_nav: number;
|
|
1078
|
+
trailing_return_y1: number;
|
|
1079
|
+
trailing_return_y10: number;
|
|
1080
|
+
trailing_return_y3: number;
|
|
1081
|
+
trailing_return_y5: number;
|
|
1082
|
+
trailing_return_ytd: number;
|
|
1083
|
+
};
|
|
1084
|
+
premium_discount: {
|
|
1085
|
+
as_of_date: string;
|
|
1086
|
+
m1_average: number;
|
|
1087
|
+
since_inception_average: number;
|
|
1088
|
+
since_inception_high: number;
|
|
1089
|
+
since_inception_low: number;
|
|
1090
|
+
y1_average: number;
|
|
1091
|
+
y1_high: number;
|
|
1092
|
+
y1_low: number;
|
|
1093
|
+
};
|
|
1094
|
+
primary_benchmark: string;
|
|
1095
|
+
primary_exchange_mic: string;
|
|
1096
|
+
primary_exchange_name: string;
|
|
1097
|
+
prospective_dividend_yield_long: number;
|
|
1098
|
+
provider_company: string;
|
|
1099
|
+
rating_overall: number;
|
|
1100
|
+
risk: {
|
|
1101
|
+
primary_index_beta_y1: number;
|
|
1102
|
+
risk_rating_overall: number;
|
|
1103
|
+
risk_score_overall: number;
|
|
1104
|
+
sharpe_ratio_y3: number;
|
|
1105
|
+
standard_deviation_y3: number;
|
|
1106
|
+
};
|
|
1107
|
+
symbol: string;
|
|
1108
|
+
total_market_value_long: number;
|
|
1109
|
+
}
|
|
992
1110
|
export interface InsightFundFilterAsset {
|
|
993
1111
|
asset_id?: string;
|
|
994
1112
|
asset_name?: string;
|
|
@@ -1073,6 +1191,82 @@ export interface InsightFundSectorScreenerRequest {
|
|
|
1073
1191
|
sector_code?: string;
|
|
1074
1192
|
sponsors?: string[];
|
|
1075
1193
|
}
|
|
1194
|
+
export interface InsightFundWithDetails {
|
|
1195
|
+
actively_managed: boolean;
|
|
1196
|
+
as_of_date: string;
|
|
1197
|
+
asset: string;
|
|
1198
|
+
asset_allocations: InsightAssetAllocationBreakdown[];
|
|
1199
|
+
average_calendar_month_daily_volume: number;
|
|
1200
|
+
category: string;
|
|
1201
|
+
continents: InsightContinentBreakdown[];
|
|
1202
|
+
countries: InsightCountryBreakdown[];
|
|
1203
|
+
coupon_breakdown: InsightCouponBreakdown[];
|
|
1204
|
+
currency: string;
|
|
1205
|
+
cusip: string;
|
|
1206
|
+
expense_ratio: number;
|
|
1207
|
+
fund_net_assets: number;
|
|
1208
|
+
fund_type: string;
|
|
1209
|
+
holdings: InsightHoldingBreakdown[];
|
|
1210
|
+
inception_date: string;
|
|
1211
|
+
indexing_approach: {
|
|
1212
|
+
census_replication: boolean;
|
|
1213
|
+
derivative_based: boolean;
|
|
1214
|
+
not_applicable: boolean;
|
|
1215
|
+
physical_full: boolean;
|
|
1216
|
+
physical_sample: boolean;
|
|
1217
|
+
stratified_sampling: boolean;
|
|
1218
|
+
structured: boolean;
|
|
1219
|
+
synthetic_replication: boolean;
|
|
1220
|
+
};
|
|
1221
|
+
inverse: boolean;
|
|
1222
|
+
isin: string;
|
|
1223
|
+
leverage: boolean;
|
|
1224
|
+
leverage_ratio: number;
|
|
1225
|
+
market_caps: InsightMarketCapBreakdown[];
|
|
1226
|
+
maturities: InsightMaturityBreakdown[];
|
|
1227
|
+
month_end_nav: number;
|
|
1228
|
+
name: string;
|
|
1229
|
+
number_of_bond_holding_long: number;
|
|
1230
|
+
number_of_bond_holding_net: number;
|
|
1231
|
+
number_of_holding_long: number;
|
|
1232
|
+
number_of_holding_net: number;
|
|
1233
|
+
number_of_stock_holding_long: number;
|
|
1234
|
+
number_of_stock_holding_net: number;
|
|
1235
|
+
performance: {
|
|
1236
|
+
inception_nav: number;
|
|
1237
|
+
trailing_return_y1: number;
|
|
1238
|
+
trailing_return_y10: number;
|
|
1239
|
+
trailing_return_y3: number;
|
|
1240
|
+
trailing_return_y5: number;
|
|
1241
|
+
trailing_return_ytd: number;
|
|
1242
|
+
};
|
|
1243
|
+
premium_discount: {
|
|
1244
|
+
as_of_date: string;
|
|
1245
|
+
m1_average: number;
|
|
1246
|
+
since_inception_average: number;
|
|
1247
|
+
since_inception_high: number;
|
|
1248
|
+
since_inception_low: number;
|
|
1249
|
+
y1_average: number;
|
|
1250
|
+
y1_high: number;
|
|
1251
|
+
y1_low: number;
|
|
1252
|
+
};
|
|
1253
|
+
primary_benchmark: string;
|
|
1254
|
+
primary_exchange_mic: string;
|
|
1255
|
+
primary_exchange_name: string;
|
|
1256
|
+
prospective_dividend_yield_long: number;
|
|
1257
|
+
provider_company: string;
|
|
1258
|
+
rating_overall: number;
|
|
1259
|
+
risk: {
|
|
1260
|
+
primary_index_beta_y1: number;
|
|
1261
|
+
risk_rating_overall: number;
|
|
1262
|
+
risk_score_overall: number;
|
|
1263
|
+
sharpe_ratio_y3: number;
|
|
1264
|
+
standard_deviation_y3: number;
|
|
1265
|
+
};
|
|
1266
|
+
sectors: InsightSectorBreakdown[];
|
|
1267
|
+
symbol: string;
|
|
1268
|
+
total_market_value_long: number;
|
|
1269
|
+
}
|
|
1076
1270
|
export interface InsightFutureIPO {
|
|
1077
1271
|
currency: string;
|
|
1078
1272
|
market: string;
|
|
@@ -1371,7 +1565,7 @@ export interface InsightGetOwnershipsBySymbolAsDashboardFieldsResponse {
|
|
|
1371
1565
|
}
|
|
1372
1566
|
export interface InsightGetOwnershipsBySymbolRequest {
|
|
1373
1567
|
order?: InsightOrdering;
|
|
1374
|
-
/** @example "
|
|
1568
|
+
/** @example "INSTITUTIONAL" */
|
|
1375
1569
|
owner_type: InsightGetOwnershipsBySymbolRequestOwnerTypeEnum;
|
|
1376
1570
|
paging: InsightPaging;
|
|
1377
1571
|
/** @example "Apple Inc" */
|
|
@@ -1385,7 +1579,7 @@ export interface InsightGetOwnershipsBySymbolResponse {
|
|
|
1385
1579
|
}
|
|
1386
1580
|
export interface InsightGetOwnershipsBySymbolWithoutSearchQueryRequest {
|
|
1387
1581
|
order?: InsightOrdering;
|
|
1388
|
-
/** @example "
|
|
1582
|
+
/** @example "INSTITUTIONAL" */
|
|
1389
1583
|
owner_type: InsightGetOwnershipsBySymbolWithoutSearchQueryRequestOwnerTypeEnum;
|
|
1390
1584
|
paging: InsightPaging;
|
|
1391
1585
|
/** @example ["AAPL","GOOGL"] */
|
|
@@ -1595,7 +1789,7 @@ export interface InsightGetScreenerPresetsResponse {
|
|
|
1595
1789
|
}
|
|
1596
1790
|
export interface InsightGetSymbolFundamentalsAnnualResponse {
|
|
1597
1791
|
balance_sheet: {
|
|
1598
|
-
|
|
1792
|
+
'2021': {
|
|
1599
1793
|
accounts_payable?: number;
|
|
1600
1794
|
accounts_receivable?: number;
|
|
1601
1795
|
accumulated_depreciation?: number;
|
|
@@ -1661,7 +1855,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
|
|
|
1661
1855
|
tradeand_other_payables_non_current?: number;
|
|
1662
1856
|
working_capital?: number;
|
|
1663
1857
|
};
|
|
1664
|
-
|
|
1858
|
+
'2022': {
|
|
1665
1859
|
accounts_payable?: number;
|
|
1666
1860
|
accounts_receivable?: number;
|
|
1667
1861
|
accumulated_depreciation?: number;
|
|
@@ -1731,7 +1925,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
|
|
|
1731
1925
|
tradeand_other_payables_non_current?: number;
|
|
1732
1926
|
working_capital?: number;
|
|
1733
1927
|
};
|
|
1734
|
-
|
|
1928
|
+
'2023': {
|
|
1735
1929
|
accounts_payable?: number;
|
|
1736
1930
|
accounts_receivable?: number;
|
|
1737
1931
|
accumulated_depreciation?: number;
|
|
@@ -1802,7 +1996,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
|
|
|
1802
1996
|
treasury_shares_number?: number;
|
|
1803
1997
|
working_capital?: number;
|
|
1804
1998
|
};
|
|
1805
|
-
|
|
1999
|
+
'2024': {
|
|
1806
2000
|
accounts_payable?: number;
|
|
1807
2001
|
accounts_receivable?: number;
|
|
1808
2002
|
accumulated_depreciation?: number;
|
|
@@ -1870,7 +2064,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
|
|
|
1870
2064
|
currency: string;
|
|
1871
2065
|
};
|
|
1872
2066
|
cash_flow: {
|
|
1873
|
-
|
|
2067
|
+
'2021': {
|
|
1874
2068
|
beginning_cash_position?: number;
|
|
1875
2069
|
capital_expenditure?: number;
|
|
1876
2070
|
cash_dividends_paid?: number;
|
|
@@ -1918,7 +2112,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
|
|
|
1918
2112
|
sale_of_investment?: number;
|
|
1919
2113
|
stock_based_compensation?: number;
|
|
1920
2114
|
};
|
|
1921
|
-
|
|
2115
|
+
'2022': {
|
|
1922
2116
|
beginning_cash_position?: number;
|
|
1923
2117
|
capital_expenditure?: number;
|
|
1924
2118
|
cash_dividends_paid?: number;
|
|
@@ -1966,7 +2160,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
|
|
|
1966
2160
|
short_term_debt_issuance?: number;
|
|
1967
2161
|
stock_based_compensation?: number;
|
|
1968
2162
|
};
|
|
1969
|
-
|
|
2163
|
+
'2023': {
|
|
1970
2164
|
beginning_cash_position?: number;
|
|
1971
2165
|
capital_expenditure?: number;
|
|
1972
2166
|
cash_dividends_paid?: number;
|
|
@@ -2008,7 +2202,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
|
|
|
2008
2202
|
sale_of_investment?: number;
|
|
2009
2203
|
stock_based_compensation?: number;
|
|
2010
2204
|
};
|
|
2011
|
-
|
|
2205
|
+
'2024': {
|
|
2012
2206
|
beginning_cash_position?: number;
|
|
2013
2207
|
capital_expenditure?: number;
|
|
2014
2208
|
cash_dividends_paid?: number;
|
|
@@ -2053,7 +2247,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
|
|
|
2053
2247
|
currency: string;
|
|
2054
2248
|
};
|
|
2055
2249
|
income_statement: {
|
|
2056
|
-
|
|
2250
|
+
'2021': {
|
|
2057
2251
|
cost_of_revenue?: number;
|
|
2058
2252
|
diluted_ni_availto_com_stockholders?: number;
|
|
2059
2253
|
ebit?: number;
|
|
@@ -2089,7 +2283,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
|
|
|
2089
2283
|
total_expenses?: number;
|
|
2090
2284
|
total_revenue?: number;
|
|
2091
2285
|
};
|
|
2092
|
-
|
|
2286
|
+
'2022': {
|
|
2093
2287
|
cost_of_revenue?: number;
|
|
2094
2288
|
diluted_ni_availto_com_stockholders?: number;
|
|
2095
2289
|
ebit?: number;
|
|
@@ -2125,7 +2319,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
|
|
|
2125
2319
|
total_expenses?: number;
|
|
2126
2320
|
total_revenue?: number;
|
|
2127
2321
|
};
|
|
2128
|
-
|
|
2322
|
+
'2023': {
|
|
2129
2323
|
cost_of_revenue?: number;
|
|
2130
2324
|
diluted_ni_availto_com_stockholders?: number;
|
|
2131
2325
|
ebit?: number;
|
|
@@ -2161,7 +2355,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
|
|
|
2161
2355
|
total_expenses?: number;
|
|
2162
2356
|
total_revenue?: number;
|
|
2163
2357
|
};
|
|
2164
|
-
|
|
2358
|
+
'2024': {
|
|
2165
2359
|
cost_of_revenue?: number;
|
|
2166
2360
|
diluted_ni_availto_com_stockholders?: number;
|
|
2167
2361
|
ebit?: number;
|
|
@@ -2196,7 +2390,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
|
|
|
2196
2390
|
}
|
|
2197
2391
|
export interface InsightGetSymbolFundamentalsQuarterlyResponse {
|
|
2198
2392
|
balance_sheet: {
|
|
2199
|
-
|
|
2393
|
+
'2024Q1': {
|
|
2200
2394
|
accounts_payable?: number;
|
|
2201
2395
|
accounts_receivable?: number;
|
|
2202
2396
|
accumulated_depreciation?: number;
|
|
@@ -2254,7 +2448,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
|
|
|
2254
2448
|
treasury_shares_number?: number;
|
|
2255
2449
|
working_capital?: number;
|
|
2256
2450
|
};
|
|
2257
|
-
|
|
2451
|
+
'2024Q2': {
|
|
2258
2452
|
accounts_payable?: number;
|
|
2259
2453
|
accounts_receivable?: number;
|
|
2260
2454
|
accumulated_depreciation?: number;
|
|
@@ -2310,7 +2504,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
|
|
|
2310
2504
|
total_non_current_liabilities_net_minority_interest?: number;
|
|
2311
2505
|
working_capital?: number;
|
|
2312
2506
|
};
|
|
2313
|
-
|
|
2507
|
+
'2024Q3': {
|
|
2314
2508
|
accounts_payable?: number;
|
|
2315
2509
|
accounts_receivable?: number;
|
|
2316
2510
|
accumulated_depreciation?: number;
|
|
@@ -2366,7 +2560,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
|
|
|
2366
2560
|
total_non_current_liabilities_net_minority_interest?: number;
|
|
2367
2561
|
working_capital?: number;
|
|
2368
2562
|
};
|
|
2369
|
-
|
|
2563
|
+
'2024Q4': {
|
|
2370
2564
|
accounts_payable?: number;
|
|
2371
2565
|
accounts_receivable?: number;
|
|
2372
2566
|
accumulated_depreciation?: number;
|
|
@@ -2434,7 +2628,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
|
|
|
2434
2628
|
currency: string;
|
|
2435
2629
|
};
|
|
2436
2630
|
cash_flow: {
|
|
2437
|
-
|
|
2631
|
+
'2024Q1': {
|
|
2438
2632
|
beginning_cash_position?: number;
|
|
2439
2633
|
capital_expenditure?: number;
|
|
2440
2634
|
cash_dividends_paid?: number;
|
|
@@ -2476,7 +2670,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
|
|
|
2476
2670
|
short_term_debt_payments?: number;
|
|
2477
2671
|
stock_based_compensation?: number;
|
|
2478
2672
|
};
|
|
2479
|
-
|
|
2673
|
+
'2024Q2': {
|
|
2480
2674
|
beginning_cash_position?: number;
|
|
2481
2675
|
capital_expenditure?: number;
|
|
2482
2676
|
cash_dividends_paid?: number;
|
|
@@ -2518,7 +2712,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
|
|
|
2518
2712
|
short_term_debt_payments?: number;
|
|
2519
2713
|
stock_based_compensation?: number;
|
|
2520
2714
|
};
|
|
2521
|
-
|
|
2715
|
+
'2024Q3': {
|
|
2522
2716
|
beginning_cash_position?: number;
|
|
2523
2717
|
capital_expenditure?: number;
|
|
2524
2718
|
cash_dividends_paid?: number;
|
|
@@ -2560,7 +2754,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
|
|
|
2560
2754
|
short_term_debt_payments?: number;
|
|
2561
2755
|
stock_based_compensation?: number;
|
|
2562
2756
|
};
|
|
2563
|
-
|
|
2757
|
+
'2024Q4': {
|
|
2564
2758
|
beginning_cash_position?: number;
|
|
2565
2759
|
capital_expenditure?: number;
|
|
2566
2760
|
cash_dividends_paid?: number;
|
|
@@ -2605,7 +2799,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
|
|
|
2605
2799
|
currency: string;
|
|
2606
2800
|
};
|
|
2607
2801
|
income_statement: {
|
|
2608
|
-
|
|
2802
|
+
'2024Q1': {
|
|
2609
2803
|
cost_of_revenue?: number;
|
|
2610
2804
|
diluted_ni_availto_com_stockholders?: number;
|
|
2611
2805
|
ebit?: number;
|
|
@@ -2635,7 +2829,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
|
|
|
2635
2829
|
total_expenses?: number;
|
|
2636
2830
|
total_revenue?: number;
|
|
2637
2831
|
};
|
|
2638
|
-
|
|
2832
|
+
'2024Q2': {
|
|
2639
2833
|
cost_of_revenue?: number;
|
|
2640
2834
|
diluted_ni_availto_com_stockholders?: number;
|
|
2641
2835
|
ebit?: number;
|
|
@@ -2665,7 +2859,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
|
|
|
2665
2859
|
total_expenses?: number;
|
|
2666
2860
|
total_revenue?: number;
|
|
2667
2861
|
};
|
|
2668
|
-
|
|
2862
|
+
'2024Q3': {
|
|
2669
2863
|
cost_of_revenue?: number;
|
|
2670
2864
|
diluted_ni_availto_com_stockholders?: number;
|
|
2671
2865
|
ebit?: number;
|
|
@@ -2695,7 +2889,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
|
|
|
2695
2889
|
total_expenses?: number;
|
|
2696
2890
|
total_revenue?: number;
|
|
2697
2891
|
};
|
|
2698
|
-
|
|
2892
|
+
'2024Q4': {
|
|
2699
2893
|
cost_of_revenue?: number;
|
|
2700
2894
|
diluted_ni_availto_com_stockholders?: number;
|
|
2701
2895
|
ebit?: number;
|
|
@@ -3166,6 +3360,10 @@ export interface InsightLiquidity {
|
|
|
3166
3360
|
current_ratio: number;
|
|
3167
3361
|
quick_ratio: number;
|
|
3168
3362
|
}
|
|
3363
|
+
export interface InsightListFundsResponse {
|
|
3364
|
+
count: number;
|
|
3365
|
+
data: InsightFund[];
|
|
3366
|
+
}
|
|
3169
3367
|
export interface InsightLiveFeedRequest {
|
|
3170
3368
|
/** Get analyst ratings from the past X months */
|
|
3171
3369
|
bookmark_id?: number;
|
|
@@ -4598,14 +4796,14 @@ export enum InsightGetFundsForHoldingRequestLeverageEnum {
|
|
|
4598
4796
|
LEVERAGE_III = "LEVERAGE_III",
|
|
4599
4797
|
LEVERAGE_II_AND_III = "LEVERAGE_II_AND_III"
|
|
4600
4798
|
}
|
|
4601
|
-
/** @example "
|
|
4799
|
+
/** @example "INSTITUTIONAL" */
|
|
4602
4800
|
export enum InsightGetOwnershipsBySymbolRequestOwnerTypeEnum {
|
|
4603
4801
|
All = "all",
|
|
4604
4802
|
Institutional = "institutional",
|
|
4605
4803
|
Fund = "fund",
|
|
4606
4804
|
Insider = "insider"
|
|
4607
4805
|
}
|
|
4608
|
-
/** @example "
|
|
4806
|
+
/** @example "INSTITUTIONAL" */
|
|
4609
4807
|
export enum InsightGetOwnershipsBySymbolWithoutSearchQueryRequestOwnerTypeEnum {
|
|
4610
4808
|
All = "all",
|
|
4611
4809
|
Institutional = "institutional",
|
|
@@ -4805,191 +5003,31 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
|
|
|
4805
5003
|
Date = "date",
|
|
4806
5004
|
Rank = "rank"
|
|
4807
5005
|
}
|
|
4808
|
-
export class
|
|
4809
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4810
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4811
|
-
/**
|
|
4812
|
-
* @description Get continents
|
|
4813
|
-
* @tags World Markets
|
|
4814
|
-
* @name ContinentGet
|
|
4815
|
-
* @summary Get continents
|
|
4816
|
-
* @request GET:/continents
|
|
4817
|
-
* @secure
|
|
4818
|
-
*/
|
|
4819
|
-
continentGet(query: {
|
|
4820
|
-
/** Query limit */
|
|
4821
|
-
limit: number;
|
|
4822
|
-
/** Query offset */
|
|
4823
|
-
offset: number;
|
|
4824
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
4825
|
-
/**
|
|
4826
|
-
* @description Edit continent
|
|
4827
|
-
* @tags World Markets
|
|
4828
|
-
* @name ContinentEdit
|
|
4829
|
-
* @summary Edit continent
|
|
4830
|
-
* @request PUT:/continents
|
|
4831
|
-
* @secure
|
|
4832
|
-
*/
|
|
4833
|
-
continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4834
|
-
/**
|
|
4835
|
-
* @description Create continents
|
|
4836
|
-
* @tags World Markets
|
|
4837
|
-
* @name ContinentCreate
|
|
4838
|
-
* @summary Create continents
|
|
4839
|
-
* @request POST:/continents
|
|
4840
|
-
* @secure
|
|
4841
|
-
*/
|
|
4842
|
-
continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
4843
|
-
/**
|
|
4844
|
-
* @description Delete continent
|
|
4845
|
-
* @tags World Markets
|
|
4846
|
-
* @name ContinentDelete
|
|
4847
|
-
* @summary Delete continent
|
|
4848
|
-
* @request DELETE:/continents
|
|
4849
|
-
* @secure
|
|
4850
|
-
*/
|
|
4851
|
-
continentDelete(query: {
|
|
4852
|
-
/** continent id */
|
|
4853
|
-
id: string;
|
|
4854
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4855
|
-
/**
|
|
4856
|
-
* @description Get country codes
|
|
4857
|
-
* @tags World Markets
|
|
4858
|
-
* @name CountryCodeGet
|
|
4859
|
-
* @summary Get country codes
|
|
4860
|
-
* @request GET:/country-codes
|
|
4861
|
-
* @secure
|
|
4862
|
-
*/
|
|
4863
|
-
countryCodeGet(query: {
|
|
4864
|
-
/** Query limit */
|
|
4865
|
-
limit: number;
|
|
4866
|
-
/** Query offset */
|
|
4867
|
-
offset: number;
|
|
4868
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
4869
|
-
/**
|
|
4870
|
-
* @description Edit country code
|
|
4871
|
-
* @tags World Markets
|
|
4872
|
-
* @name CountryCodeEdit
|
|
4873
|
-
* @summary Edit country code
|
|
4874
|
-
* @request PUT:/country-codes
|
|
4875
|
-
* @secure
|
|
4876
|
-
*/
|
|
4877
|
-
countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4878
|
-
/**
|
|
4879
|
-
* @description Add country codes
|
|
4880
|
-
* @tags World Markets
|
|
4881
|
-
* @name CountryCodeAdd
|
|
4882
|
-
* @summary Add country codes
|
|
4883
|
-
* @request POST:/country-codes
|
|
4884
|
-
* @secure
|
|
4885
|
-
*/
|
|
4886
|
-
countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
5006
|
+
export class AlphaTools<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
5007
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
5008
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
4887
5009
|
/**
|
|
4888
|
-
* @description
|
|
4889
|
-
* @tags
|
|
4890
|
-
* @name
|
|
4891
|
-
* @summary
|
|
4892
|
-
* @request
|
|
4893
|
-
* @secure
|
|
4894
|
-
*/
|
|
4895
|
-
countryCodeDelete(query: {
|
|
4896
|
-
/** a3 code */
|
|
4897
|
-
a3code: string;
|
|
4898
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4899
|
-
/**
|
|
4900
|
-
* @description Get global indexes
|
|
4901
|
-
* @tags World Markets
|
|
4902
|
-
* @name GlobalIndexGet
|
|
4903
|
-
* @summary Get global indexes
|
|
4904
|
-
* @request GET:/global-indexes
|
|
4905
|
-
* @secure
|
|
4906
|
-
*/
|
|
4907
|
-
globalIndexGet(query: {
|
|
4908
|
-
/** Query limit */
|
|
4909
|
-
limit: number;
|
|
4910
|
-
/** Query offset */
|
|
4911
|
-
offset: number;
|
|
4912
|
-
/** Continent code for filtering */
|
|
4913
|
-
continent?: string;
|
|
4914
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
4915
|
-
/**
|
|
4916
|
-
* @description Edit global index
|
|
4917
|
-
* @tags World Markets
|
|
4918
|
-
* @name GlobalIndexEdit
|
|
4919
|
-
* @summary Edit global index
|
|
4920
|
-
* @request PUT:/global-indexes
|
|
4921
|
-
* @secure
|
|
4922
|
-
*/
|
|
4923
|
-
globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4924
|
-
/**
|
|
4925
|
-
* @description Add global indexes
|
|
4926
|
-
* @tags World Markets
|
|
4927
|
-
* @name GlobalIndexAdd
|
|
4928
|
-
* @summary Add global indexes
|
|
4929
|
-
* @request POST:/global-indexes
|
|
4930
|
-
* @secure
|
|
4931
|
-
*/
|
|
4932
|
-
globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
4933
|
-
/**
|
|
4934
|
-
* @description Edit global index
|
|
4935
|
-
* @tags World Markets
|
|
4936
|
-
* @name GlobalIndexDelete
|
|
4937
|
-
* @summary Delete global index
|
|
4938
|
-
* @request DELETE:/global-indexes
|
|
4939
|
-
* @secure
|
|
4940
|
-
*/
|
|
4941
|
-
globalIndexDelete(query: {
|
|
4942
|
-
/** a3 code */
|
|
4943
|
-
a3code: string;
|
|
4944
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4945
|
-
/**
|
|
4946
|
-
* @description Get regions
|
|
4947
|
-
* @tags World Markets
|
|
4948
|
-
* @name RegionGet
|
|
4949
|
-
* @summary Get regions
|
|
4950
|
-
* @request GET:/regions
|
|
4951
|
-
* @secure
|
|
4952
|
-
*/
|
|
4953
|
-
regionGet(query: {
|
|
4954
|
-
/** Query limit */
|
|
4955
|
-
limit: number;
|
|
4956
|
-
/** Query offset */
|
|
4957
|
-
offset: number;
|
|
4958
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
4959
|
-
/**
|
|
4960
|
-
* @description Edit region
|
|
4961
|
-
* @tags World Markets
|
|
4962
|
-
* @name RegionEdit
|
|
4963
|
-
* @summary Edit region
|
|
4964
|
-
* @request PUT:/regions
|
|
4965
|
-
* @secure
|
|
4966
|
-
*/
|
|
4967
|
-
regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4968
|
-
/**
|
|
4969
|
-
* @description Create regions
|
|
4970
|
-
* @tags World Markets
|
|
4971
|
-
* @name RegionCreate
|
|
4972
|
-
* @summary Create regions
|
|
4973
|
-
* @request POST:/regions
|
|
5010
|
+
* @description get seasonlity data with comparison to benchmark
|
|
5011
|
+
* @tags AlphaTools
|
|
5012
|
+
* @name GetMomentumRatioGraph
|
|
5013
|
+
* @summary get seasonlity data
|
|
5014
|
+
* @request POST:/rst
|
|
4974
5015
|
* @secure
|
|
4975
5016
|
*/
|
|
4976
|
-
|
|
5017
|
+
getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError, Format>>;
|
|
4977
5018
|
/**
|
|
4978
|
-
* @description
|
|
4979
|
-
* @tags
|
|
4980
|
-
* @name
|
|
4981
|
-
* @summary
|
|
4982
|
-
* @request
|
|
5019
|
+
* @description get seasonlity data with comparison to benchmark
|
|
5020
|
+
* @tags AlphaTools
|
|
5021
|
+
* @name GetSeasonality
|
|
5022
|
+
* @summary get seasonlity data
|
|
5023
|
+
* @request POST:/seasonality
|
|
4983
5024
|
* @secure
|
|
4984
5025
|
*/
|
|
4985
|
-
|
|
4986
|
-
/** region id */
|
|
4987
|
-
id: string;
|
|
4988
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5026
|
+
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError, Format>>;
|
|
4989
5027
|
}
|
|
4990
|
-
export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
4991
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4992
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5028
|
+
export class CompanyProfile<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
5029
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
5030
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
4993
5031
|
/**
|
|
4994
5032
|
* @description get company profile, industries classification and closest earning release
|
|
4995
5033
|
* @tags CompanyProfile
|
|
@@ -5001,7 +5039,7 @@ export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
|
5001
5039
|
getCompanyProfile(query: {
|
|
5002
5040
|
/** Company symbol */
|
|
5003
5041
|
symbol: string;
|
|
5004
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError>>;
|
|
5042
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError, Format>>;
|
|
5005
5043
|
/**
|
|
5006
5044
|
* @description get combined profile, equities and funds
|
|
5007
5045
|
* @tags CompanyProfile
|
|
@@ -5015,7 +5053,7 @@ export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
|
5015
5053
|
symbol: string;
|
|
5016
5054
|
/** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
|
|
5017
5055
|
symbol_type?: InsightGetCombinedProfileParamsSymbolTypeEnum;
|
|
5018
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError>>;
|
|
5056
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError, Format>>;
|
|
5019
5057
|
/**
|
|
5020
5058
|
* @description sort input array of symbols by type
|
|
5021
5059
|
* @tags CompanyProfile
|
|
@@ -5024,11 +5062,11 @@ export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
|
5024
5062
|
* @request POST:/symbols-per-type
|
|
5025
5063
|
* @secure
|
|
5026
5064
|
*/
|
|
5027
|
-
getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
|
|
5065
|
+
getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError, Format>>;
|
|
5028
5066
|
}
|
|
5029
|
-
export class CustomLists<HandleError extends boolean = boolean> {
|
|
5030
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5031
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5067
|
+
export class CustomLists<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
5068
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
5069
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
5032
5070
|
/**
|
|
5033
5071
|
* @description get custom lists
|
|
5034
5072
|
* @tags Custom Lists
|
|
@@ -5042,7 +5080,7 @@ export class CustomLists<HandleError extends boolean = boolean> {
|
|
|
5042
5080
|
limit: number;
|
|
5043
5081
|
/** how many records to skip */
|
|
5044
5082
|
offset: number;
|
|
5045
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
5083
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError, Format>>;
|
|
5046
5084
|
/**
|
|
5047
5085
|
* @description update custom list
|
|
5048
5086
|
* @tags Custom Lists
|
|
@@ -5051,7 +5089,7 @@ export class CustomLists<HandleError extends boolean = boolean> {
|
|
|
5051
5089
|
* @request PUT:/custom-lists
|
|
5052
5090
|
* @secure
|
|
5053
5091
|
*/
|
|
5054
|
-
updateCustomList(filter: InsightUpdateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
|
|
5092
|
+
updateCustomList(filter: InsightUpdateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError, Format>>;
|
|
5055
5093
|
/**
|
|
5056
5094
|
* @description create custom list
|
|
5057
5095
|
* @tags Custom Lists
|
|
@@ -5060,7 +5098,7 @@ export class CustomLists<HandleError extends boolean = boolean> {
|
|
|
5060
5098
|
* @request POST:/custom-lists
|
|
5061
5099
|
* @secure
|
|
5062
5100
|
*/
|
|
5063
|
-
createCustomList(filter: InsightCreateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
|
|
5101
|
+
createCustomList(filter: InsightCreateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError, Format>>;
|
|
5064
5102
|
/**
|
|
5065
5103
|
* @description remove custom list
|
|
5066
5104
|
* @tags Custom Lists
|
|
@@ -5069,7 +5107,7 @@ export class CustomLists<HandleError extends boolean = boolean> {
|
|
|
5069
5107
|
* @request DELETE:/custom-lists
|
|
5070
5108
|
* @secure
|
|
5071
5109
|
*/
|
|
5072
|
-
removeCustomList(filter: InsightRemoveCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5110
|
+
removeCustomList(filter: InsightRemoveCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
5073
5111
|
/**
|
|
5074
5112
|
* @description filter custom lists
|
|
5075
5113
|
* @tags Custom Lists
|
|
@@ -5078,7 +5116,7 @@ export class CustomLists<HandleError extends boolean = boolean> {
|
|
|
5078
5116
|
* @request POST:/custom-lists/filter
|
|
5079
5117
|
* @secure
|
|
5080
5118
|
*/
|
|
5081
|
-
filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
5119
|
+
filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError, Format>>;
|
|
5082
5120
|
/**
|
|
5083
5121
|
* @description get custom list with quotes
|
|
5084
5122
|
* @tags Custom Lists
|
|
@@ -5096,7 +5134,7 @@ export class CustomLists<HandleError extends boolean = boolean> {
|
|
|
5096
5134
|
limit: number;
|
|
5097
5135
|
/** how many equities records to skip */
|
|
5098
5136
|
offset: number;
|
|
5099
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
5137
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError, Format>>;
|
|
5100
5138
|
/**
|
|
5101
5139
|
* @description filter custom list
|
|
5102
5140
|
* @tags Custom Lists
|
|
@@ -5108,11 +5146,11 @@ export class CustomLists<HandleError extends boolean = boolean> {
|
|
|
5108
5146
|
filterCustomList(idOrSlug: string, query?: {
|
|
5109
5147
|
/** symbols to check inclusion */
|
|
5110
5148
|
symbols?: string[];
|
|
5111
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFilteredCustomIndexResponse, HandleError>>;
|
|
5149
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFilteredCustomIndexResponse, HandleError, Format>>;
|
|
5112
5150
|
}
|
|
5113
|
-
export class Dashboard<HandleError extends boolean = boolean> {
|
|
5114
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5115
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5151
|
+
export class Dashboard<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
5152
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
5153
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
5116
5154
|
/**
|
|
5117
5155
|
* @description get ownerships by symbol
|
|
5118
5156
|
* @tags Dashboard
|
|
@@ -5121,7 +5159,7 @@ export class Dashboard<HandleError extends boolean = boolean> {
|
|
|
5121
5159
|
* @request POST:/dashboard/ownerships
|
|
5122
5160
|
* @secure
|
|
5123
5161
|
*/
|
|
5124
|
-
dashboardGetOwnershipsBySymbol(filter: InsightGetOwnershipsBySymbolRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolAsDashboardFieldsResponse, HandleError>>;
|
|
5162
|
+
dashboardGetOwnershipsBySymbol(filter: InsightGetOwnershipsBySymbolRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolAsDashboardFieldsResponse, HandleError, Format>>;
|
|
5125
5163
|
/**
|
|
5126
5164
|
* @description rewrite field value
|
|
5127
5165
|
* @tags Dashboard
|
|
@@ -5130,7 +5168,7 @@ export class Dashboard<HandleError extends boolean = boolean> {
|
|
|
5130
5168
|
* @request POST:/rewrite-field
|
|
5131
5169
|
* @secure
|
|
5132
5170
|
*/
|
|
5133
|
-
rewriteFieldValue(input: InsightRewriteFieldValueRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5171
|
+
rewriteFieldValue(input: InsightRewriteFieldValueRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
5134
5172
|
/**
|
|
5135
5173
|
* @description remove rewritten value
|
|
5136
5174
|
* @tags Dashboard
|
|
@@ -5139,7 +5177,7 @@ export class Dashboard<HandleError extends boolean = boolean> {
|
|
|
5139
5177
|
* @request DELETE:/rewrite-field
|
|
5140
5178
|
* @secure
|
|
5141
5179
|
*/
|
|
5142
|
-
createRewriteField(input: InsightRemoveRewrittenFieldValueRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5180
|
+
createRewriteField(input: InsightRemoveRewrittenFieldValueRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
5143
5181
|
/**
|
|
5144
5182
|
* @description Get rewritten field action log
|
|
5145
5183
|
* @tags Dashboard
|
|
@@ -5157,7 +5195,7 @@ export class Dashboard<HandleError extends boolean = boolean> {
|
|
|
5157
5195
|
limit: number;
|
|
5158
5196
|
/** how many records to skip */
|
|
5159
5197
|
offset: number;
|
|
5160
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5198
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
5161
5199
|
/**
|
|
5162
5200
|
* @description Get rewritten values
|
|
5163
5201
|
* @tags Dashboard
|
|
@@ -5171,7 +5209,7 @@ export class Dashboard<HandleError extends boolean = boolean> {
|
|
|
5171
5209
|
limit: number;
|
|
5172
5210
|
/** how many records to skip */
|
|
5173
5211
|
offset: number;
|
|
5174
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5212
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
5175
5213
|
/**
|
|
5176
5214
|
* @description get symbol-related fields
|
|
5177
5215
|
* @tags Dashboard
|
|
@@ -5183,11 +5221,11 @@ export class Dashboard<HandleError extends boolean = boolean> {
|
|
|
5183
5221
|
getSymbolRelatedFields(query: {
|
|
5184
5222
|
/** Symbol */
|
|
5185
5223
|
symbol: string;
|
|
5186
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolRelatedFieldsResponse, HandleError>>;
|
|
5224
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolRelatedFieldsResponse, HandleError, Format>>;
|
|
5187
5225
|
}
|
|
5188
|
-
export class Earnings<HandleError extends boolean = boolean> {
|
|
5189
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5190
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5226
|
+
export class Earnings<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
5227
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
5228
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
5191
5229
|
/**
|
|
5192
5230
|
* @description get earnings releases count per day
|
|
5193
5231
|
* @tags Earnings
|
|
@@ -5212,7 +5250,7 @@ export class Earnings<HandleError extends boolean = boolean> {
|
|
|
5212
5250
|
* @example ""NYSE,NAS""
|
|
5213
5251
|
*/
|
|
5214
5252
|
exchanges?: string[];
|
|
5215
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, number>, HandleError>>;
|
|
5253
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, number>, HandleError, Format>>;
|
|
5216
5254
|
/**
|
|
5217
5255
|
* @description get earnings release dates for symbols
|
|
5218
5256
|
* @tags Earnings
|
|
@@ -5221,24 +5259,11 @@ export class Earnings<HandleError extends boolean = boolean> {
|
|
|
5221
5259
|
* @request POST:/earnings-calendar
|
|
5222
5260
|
* @secure
|
|
5223
5261
|
*/
|
|
5224
|
-
getEarningsCalendar(filter: InsightEarningReleasesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEarningReleasesResponse, HandleError>>;
|
|
5225
|
-
}
|
|
5226
|
-
export class Fundamentals<HandleError extends boolean = boolean> {
|
|
5227
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5228
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5229
|
-
/**
|
|
5230
|
-
* @description get fundamentals by symbol data
|
|
5231
|
-
* @tags Fundamentals
|
|
5232
|
-
* @name GetFundamentalsBySymbolData
|
|
5233
|
-
* @summary get fundamentals by symbol data
|
|
5234
|
-
* @request POST:/fundamentals
|
|
5235
|
-
* @secure
|
|
5236
|
-
*/
|
|
5237
|
-
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
5262
|
+
getEarningsCalendar(filter: InsightEarningReleasesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEarningReleasesResponse, HandleError, Format>>;
|
|
5238
5263
|
}
|
|
5239
|
-
export class FixedIncome<HandleError extends boolean = boolean> {
|
|
5240
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5241
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5264
|
+
export class FixedIncome<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
5265
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
5266
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
5242
5267
|
/**
|
|
5243
5268
|
* @description get fixed income entries
|
|
5244
5269
|
* @tags FixedIncome
|
|
@@ -5247,7 +5272,7 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
5247
5272
|
* @request POST:/fixed-income
|
|
5248
5273
|
* @secure
|
|
5249
5274
|
*/
|
|
5250
|
-
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponse, HandleError>>;
|
|
5275
|
+
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponse, HandleError, Format>>;
|
|
5251
5276
|
/**
|
|
5252
5277
|
* @description Returns historical fixed income
|
|
5253
5278
|
* @tags FixedIncome
|
|
@@ -5256,7 +5281,7 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
5256
5281
|
* @request POST:/fixed-income/historical
|
|
5257
5282
|
* @secure
|
|
5258
5283
|
*/
|
|
5259
|
-
fixedIncomeHistorical(filter: InsightGetFixedIncomeHistoricalRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeHistoricalResponse, HandleError>>;
|
|
5284
|
+
fixedIncomeHistorical(filter: InsightGetFixedIncomeHistoricalRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeHistoricalResponse, HandleError, Format>>;
|
|
5260
5285
|
/**
|
|
5261
5286
|
* @description get fixed-income presets
|
|
5262
5287
|
* @tags FixedIncome
|
|
@@ -5270,7 +5295,7 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
5270
5295
|
limit: number;
|
|
5271
5296
|
/** how many records to skip */
|
|
5272
5297
|
offset: number;
|
|
5273
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
5298
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError, Format>>;
|
|
5274
5299
|
/**
|
|
5275
5300
|
* @description update fixed-income preset
|
|
5276
5301
|
* @tags FixedIncome
|
|
@@ -5279,7 +5304,7 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
5279
5304
|
* @request PUT:/fixed-income/presets
|
|
5280
5305
|
* @secure
|
|
5281
5306
|
*/
|
|
5282
|
-
updateFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5307
|
+
updateFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError, Format>>;
|
|
5283
5308
|
/**
|
|
5284
5309
|
* @description create fixed-income preset
|
|
5285
5310
|
* @tags FixedIncome
|
|
@@ -5288,7 +5313,7 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
5288
5313
|
* @request POST:/fixed-income/presets
|
|
5289
5314
|
* @secure
|
|
5290
5315
|
*/
|
|
5291
|
-
createFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5316
|
+
createFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError, Format>>;
|
|
5292
5317
|
/**
|
|
5293
5318
|
* @description remove fixed-income preset
|
|
5294
5319
|
* @tags FixedIncome
|
|
@@ -5297,7 +5322,7 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
5297
5322
|
* @request DELETE:/fixed-income/presets
|
|
5298
5323
|
* @secure
|
|
5299
5324
|
*/
|
|
5300
|
-
removeFixedIncomePreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5325
|
+
removeFixedIncomePreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
5301
5326
|
/**
|
|
5302
5327
|
* @description search fixed income values
|
|
5303
5328
|
* @tags FixedIncome
|
|
@@ -5315,7 +5340,7 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
5315
5340
|
limit?: number;
|
|
5316
5341
|
/** how many records to skip */
|
|
5317
5342
|
offset?: number;
|
|
5318
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSearchFixedIncomeValuesResponse, HandleError>>;
|
|
5343
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSearchFixedIncomeValuesResponse, HandleError, Format>>;
|
|
5319
5344
|
/**
|
|
5320
5345
|
* @description get single fixed income entry
|
|
5321
5346
|
* @tags FixedIncome
|
|
@@ -5324,557 +5349,540 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
5324
5349
|
* @request GET:/fixed-income/{id}
|
|
5325
5350
|
* @secure
|
|
5326
5351
|
*/
|
|
5327
|
-
getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
|
|
5352
|
+
getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError, Format>>;
|
|
5328
5353
|
}
|
|
5329
|
-
export
|
|
5330
|
-
|
|
5331
|
-
|
|
5332
|
-
/**
|
|
5333
|
-
* @description get fund details
|
|
5334
|
-
* @tags Funds
|
|
5335
|
-
* @name GetFundDetails
|
|
5336
|
-
* @summary get fund details
|
|
5337
|
-
* @request GET:/funds/details
|
|
5338
|
-
* @secure
|
|
5339
|
-
*/
|
|
5340
|
-
getFundDetails(query: {
|
|
5341
|
-
/** Fund symbol */
|
|
5342
|
-
symbol: string;
|
|
5343
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundDetailsResponse, HandleError>>;
|
|
5344
|
-
/**
|
|
5345
|
-
* @description get funds for holding
|
|
5346
|
-
* @tags Funds
|
|
5347
|
-
* @name GetFundsForHolding
|
|
5348
|
-
* @summary get funds for holding
|
|
5349
|
-
* @request POST:/funds/funds-for-holding
|
|
5350
|
-
* @secure
|
|
5351
|
-
*/
|
|
5352
|
-
getFundsForHolding(filter: InsightGetFundsForHoldingRequest, headers?: {
|
|
5353
|
-
/** Authorization */
|
|
5354
|
-
Authorization?: string;
|
|
5355
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundsForHoldingResponse, HandleError>>;
|
|
5356
|
-
/**
|
|
5357
|
-
* @description filter funds by params
|
|
5358
|
-
* @tags Funds
|
|
5359
|
-
* @name FundScreener
|
|
5360
|
-
* @summary filter funds by params
|
|
5361
|
-
* @request POST:/funds/screener
|
|
5362
|
-
* @secure
|
|
5363
|
-
*/
|
|
5364
|
-
fundScreener(filter: InsightFundScreenerRequest, headers?: {
|
|
5365
|
-
/** Authorization */
|
|
5366
|
-
Authorization?: string;
|
|
5367
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
|
|
5368
|
-
/**
|
|
5369
|
-
* @description get fund screener filters
|
|
5370
|
-
* @tags Funds
|
|
5371
|
-
* @name GetScreenerFilters
|
|
5372
|
-
* @summary get fund screener filters
|
|
5373
|
-
* @request GET:/funds/screener/filters
|
|
5374
|
-
* @secure
|
|
5375
|
-
*/
|
|
5376
|
-
getScreenerFilters(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundScreenerFiltersResponse, HandleError>>;
|
|
5377
|
-
/**
|
|
5378
|
-
* @description get fund screener presets
|
|
5379
|
-
* @tags Funds
|
|
5380
|
-
* @name GetFundScreenerPresets
|
|
5381
|
-
* @summary get fund screener presets
|
|
5382
|
-
* @request GET:/funds/screener/presets
|
|
5383
|
-
* @secure
|
|
5384
|
-
*/
|
|
5385
|
-
getFundScreenerPresets(query: {
|
|
5386
|
-
/** how many records to return */
|
|
5387
|
-
limit: number;
|
|
5388
|
-
/** how many records to skip */
|
|
5389
|
-
offset: number;
|
|
5390
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
5391
|
-
/**
|
|
5392
|
-
* @description update fund screener preset
|
|
5393
|
-
* @tags Funds
|
|
5394
|
-
* @name UpdateFundScreenerPreset
|
|
5395
|
-
* @summary update fund screener preset
|
|
5396
|
-
* @request PUT:/funds/screener/presets
|
|
5397
|
-
* @secure
|
|
5398
|
-
*/
|
|
5399
|
-
updateFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5400
|
-
/**
|
|
5401
|
-
* @description create fund screener preset
|
|
5402
|
-
* @tags Funds
|
|
5403
|
-
* @name CreateFundScreenerPreset
|
|
5404
|
-
* @summary create fund screener preset
|
|
5405
|
-
* @request POST:/funds/screener/presets
|
|
5406
|
-
* @secure
|
|
5407
|
-
*/
|
|
5408
|
-
createFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5409
|
-
/**
|
|
5410
|
-
* @description remove fund screener preset
|
|
5411
|
-
* @tags Funds
|
|
5412
|
-
* @name RemoveFundScreenerPreset
|
|
5413
|
-
* @summary remove fund screener preset
|
|
5414
|
-
* @request DELETE:/funds/screener/presets
|
|
5415
|
-
* @secure
|
|
5416
|
-
*/
|
|
5417
|
-
removeFundScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5418
|
-
/**
|
|
5419
|
-
* @description filter funds by params
|
|
5420
|
-
* @tags Funds
|
|
5421
|
-
* @name FundSectorScreener
|
|
5422
|
-
* @summary filter funds by params
|
|
5423
|
-
* @request POST:/funds/sector-screener
|
|
5424
|
-
* @secure
|
|
5425
|
-
*/
|
|
5426
|
-
fundSectorScreener(filter: InsightFundSectorScreenerRequest, headers?: {
|
|
5427
|
-
/** Authorization */
|
|
5428
|
-
Authorization?: string;
|
|
5429
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
|
|
5430
|
-
/**
|
|
5431
|
-
* @description get top funds
|
|
5432
|
-
* @tags Funds
|
|
5433
|
-
* @name GetTopFunds
|
|
5434
|
-
* @summary get top funds
|
|
5435
|
-
* @request POST:/funds/top
|
|
5436
|
-
* @secure
|
|
5437
|
-
*/
|
|
5438
|
-
getTopFunds(filter: InsightGetTopFundsRequest, headers?: {
|
|
5439
|
-
/** Authorization */
|
|
5440
|
-
Authorization?: string;
|
|
5441
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
|
|
5354
|
+
export enum InsightOrderDirectionV2 {
|
|
5355
|
+
OrderASC = "asc",
|
|
5356
|
+
OrderDESC = "desc"
|
|
5442
5357
|
}
|
|
5443
|
-
export
|
|
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
|
-
|
|
5358
|
+
export interface InsightBeforeAndAfterV2 {
|
|
5359
|
+
after?: string;
|
|
5360
|
+
before?: string;
|
|
5361
|
+
}
|
|
5362
|
+
export interface InsightFixedIncomeV2 {
|
|
5363
|
+
a144: boolean;
|
|
5364
|
+
accrued_interest: number;
|
|
5365
|
+
bank_qualified: boolean;
|
|
5366
|
+
bond_warrant: boolean;
|
|
5367
|
+
call_type: string;
|
|
5368
|
+
callable: boolean;
|
|
5369
|
+
close_price: number;
|
|
5370
|
+
close_price_asof: string;
|
|
5371
|
+
close_ytw: number;
|
|
5372
|
+
convertible: boolean;
|
|
5373
|
+
country: string;
|
|
5374
|
+
country_code: string;
|
|
5375
|
+
country_domicile: string;
|
|
5376
|
+
country_issue: string;
|
|
5377
|
+
coupon: number;
|
|
5378
|
+
coupon_frequency: string;
|
|
5379
|
+
coupon_type: string;
|
|
5380
|
+
currency: string;
|
|
5381
|
+
cusip: string;
|
|
5382
|
+
dated_date: string;
|
|
5383
|
+
daycount: string;
|
|
5384
|
+
description: string;
|
|
5385
|
+
description_short: string;
|
|
5386
|
+
duration: number;
|
|
5387
|
+
first_coupon_date: string;
|
|
5388
|
+
insured: boolean;
|
|
5389
|
+
isin: string;
|
|
5390
|
+
issue_date: string;
|
|
5391
|
+
issue_minimum_denomination: number;
|
|
5392
|
+
issue_price: number;
|
|
5393
|
+
issue_size: number;
|
|
5394
|
+
issuer: string;
|
|
5395
|
+
last_coupon_date: string;
|
|
5396
|
+
liquidity_institutional_aggregate: number;
|
|
5397
|
+
liquidity_institutional_buy: number;
|
|
5398
|
+
liquidity_institutional_sell: number;
|
|
5399
|
+
liquidity_micro_aggregate: number;
|
|
5400
|
+
liquidity_micro_buy: number;
|
|
5401
|
+
liquidity_micro_sell: number;
|
|
5402
|
+
liquidity_retail_aggregate: number;
|
|
5403
|
+
liquidity_retail_buy: number;
|
|
5404
|
+
liquidity_retail_sell: number;
|
|
5405
|
+
maturity_date: string;
|
|
5406
|
+
municipal_state: string;
|
|
5407
|
+
municipal_taxable_federal: boolean;
|
|
5408
|
+
municipal_type: string;
|
|
5409
|
+
next_call_date: string;
|
|
5410
|
+
next_call_price: number;
|
|
5411
|
+
next_coupon_date: string;
|
|
5412
|
+
par_value: number;
|
|
5413
|
+
perpetual: boolean;
|
|
5414
|
+
private_placement: boolean;
|
|
5415
|
+
purpose: string;
|
|
5416
|
+
puttable: boolean;
|
|
5417
|
+
reg_s: boolean;
|
|
5418
|
+
sector: string;
|
|
5419
|
+
seniority: string;
|
|
5420
|
+
settlement_convention: string;
|
|
5421
|
+
sinking_fund: boolean;
|
|
5422
|
+
sp_creditwatch: string;
|
|
5423
|
+
sp_creditwatch_date: string;
|
|
5424
|
+
sp_outlook: string;
|
|
5425
|
+
sp_outlook_date: string;
|
|
5426
|
+
sp_rating: string;
|
|
5427
|
+
sp_rating_date: string;
|
|
5428
|
+
status: string;
|
|
5429
|
+
ticker: string;
|
|
5430
|
+
treasury_subtype: string;
|
|
5431
|
+
type: string;
|
|
5432
|
+
updated_at: string;
|
|
5433
|
+
}
|
|
5434
|
+
export interface InsightGetFixedIncomeEntriesResponseV2 {
|
|
5435
|
+
count: number;
|
|
5436
|
+
data: InsightFixedIncomeV2[];
|
|
5437
|
+
}
|
|
5438
|
+
export interface InsightGetFixedIncomeEntriesRequestV2 {
|
|
5439
|
+
/** @example true */
|
|
5440
|
+
bank_qualified?: boolean;
|
|
5441
|
+
/** @example true */
|
|
5442
|
+
callable?: boolean;
|
|
5443
|
+
/** @example true */
|
|
5444
|
+
convertible?: boolean;
|
|
5445
|
+
/** @example ["USA"] */
|
|
5446
|
+
country_codes?: string[];
|
|
5447
|
+
coupon?: InsightLessAndMoreV2;
|
|
5448
|
+
/** @example ["quarterly","zero"] */
|
|
5449
|
+
coupon_frequencies?: string[];
|
|
5450
|
+
/** @example ["655664AH3","9128286R6"] */
|
|
5451
|
+
cusip?: string[];
|
|
5499
5452
|
/**
|
|
5500
|
-
* @
|
|
5501
|
-
* @
|
|
5502
|
-
* @name UpdateScreenerPreset
|
|
5503
|
-
* @summary update screener preset
|
|
5504
|
-
* @request PUT:/stock-screener/presets
|
|
5505
|
-
* @secure
|
|
5453
|
+
* @maxLength 100
|
|
5454
|
+
* @example "Donald's"
|
|
5506
5455
|
*/
|
|
5507
|
-
|
|
5456
|
+
description?: string;
|
|
5457
|
+
/** @example true */
|
|
5458
|
+
has_ticker?: boolean;
|
|
5459
|
+
/** @example true */
|
|
5460
|
+
insured?: boolean;
|
|
5461
|
+
/** @example ["US655664AH33","US9128286R69"] */
|
|
5462
|
+
isin?: string[];
|
|
5463
|
+
issue_date?: InsightBeforeAndAfterV2;
|
|
5508
5464
|
/**
|
|
5509
|
-
* @
|
|
5510
|
-
* @
|
|
5511
|
-
* @name CreateOrScreenerPreset
|
|
5512
|
-
* @summary create screener preset
|
|
5513
|
-
* @request POST:/stock-screener/presets
|
|
5514
|
-
* @secure
|
|
5465
|
+
* @maxLength 100
|
|
5466
|
+
* @example "Donald's"
|
|
5515
5467
|
*/
|
|
5516
|
-
|
|
5468
|
+
issuer?: string;
|
|
5469
|
+
maturity?: InsightBeforeAndAfterV2;
|
|
5470
|
+
/** @example ["NY"] */
|
|
5471
|
+
municipal_states?: string[];
|
|
5472
|
+
/** @example true */
|
|
5473
|
+
municipal_tax?: boolean;
|
|
5474
|
+
/** @example ["general_obligation"] */
|
|
5475
|
+
municipal_types?: string[];
|
|
5476
|
+
pagination: InsightPaginationV2;
|
|
5477
|
+
purposes?: string[];
|
|
5478
|
+
/** @example ["SOVEREIGN"] */
|
|
5479
|
+
sectors?: string[];
|
|
5480
|
+
sorts?: InsightOrderingV2[];
|
|
5481
|
+
/** @example ["AAA"] */
|
|
5482
|
+
sp_ratings?: string[];
|
|
5483
|
+
/** @example ["called","outstanding"] */
|
|
5484
|
+
statuses?: string[];
|
|
5485
|
+
tickers?: string[];
|
|
5486
|
+
/** @example ["corporate"] */
|
|
5487
|
+
types?: string[];
|
|
5488
|
+
}
|
|
5489
|
+
export interface InsightGetTopSymbolsRequestV2 {
|
|
5490
|
+
exchange?: string[];
|
|
5491
|
+
market_cap?: InsightLessAndMoreV2;
|
|
5492
|
+
pagination?: InsightPaginationV2;
|
|
5493
|
+
price?: InsightLessAndMoreV2;
|
|
5494
|
+
sorts?: InsightOrderingV2[];
|
|
5495
|
+
volume?: InsightLessAndMoreV2;
|
|
5496
|
+
}
|
|
5497
|
+
export interface InsightIncludeExcludeV2 {
|
|
5498
|
+
exclude?: string[];
|
|
5499
|
+
include?: string[];
|
|
5500
|
+
}
|
|
5501
|
+
export interface InsightLessAndMoreV2 {
|
|
5502
|
+
less_than?: number;
|
|
5503
|
+
more_than?: number;
|
|
5504
|
+
}
|
|
5505
|
+
export interface InsightOrderingV2 {
|
|
5517
5506
|
/**
|
|
5518
|
-
* @
|
|
5519
|
-
* @
|
|
5520
|
-
* @name RemoveScreenerPreset
|
|
5521
|
-
* @summary remove screener preset
|
|
5522
|
-
* @request DELETE:/stock-screener/presets
|
|
5523
|
-
* @secure
|
|
5507
|
+
* @default "asc"
|
|
5508
|
+
* @example "asc"
|
|
5524
5509
|
*/
|
|
5525
|
-
|
|
5510
|
+
direction: InsightOrderingDirectionEnumV2;
|
|
5526
5511
|
/**
|
|
5527
|
-
*
|
|
5528
|
-
*
|
|
5529
|
-
*
|
|
5530
|
-
* @
|
|
5531
|
-
* @request POST:/stock-screener/top
|
|
5532
|
-
* @secure
|
|
5512
|
+
* Sort direction:
|
|
5513
|
+
* * asc - Ascending, from A to Z.
|
|
5514
|
+
* * desc - Descending, from Z to A.
|
|
5515
|
+
* @example "name"
|
|
5533
5516
|
*/
|
|
5534
|
-
|
|
5517
|
+
field: string;
|
|
5535
5518
|
}
|
|
5536
|
-
export
|
|
5537
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5538
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5519
|
+
export interface InsightPaginationV2 {
|
|
5539
5520
|
/**
|
|
5540
|
-
* @
|
|
5541
|
-
* @
|
|
5542
|
-
* @name GitHistoricalQuote
|
|
5543
|
-
* @summary Get single historical quote
|
|
5544
|
-
* @request GET:/historical/quote
|
|
5545
|
-
* @secure
|
|
5521
|
+
* @min 1
|
|
5522
|
+
* @example 1
|
|
5546
5523
|
*/
|
|
5547
|
-
|
|
5548
|
-
/** Symbol */
|
|
5549
|
-
symbol: string;
|
|
5550
|
-
/** Date */
|
|
5551
|
-
date: string;
|
|
5552
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
|
|
5524
|
+
page: number;
|
|
5553
5525
|
/**
|
|
5554
|
-
* @
|
|
5555
|
-
* @
|
|
5556
|
-
* @
|
|
5557
|
-
* @summary Get quote history
|
|
5558
|
-
* @request POST:/quote-history
|
|
5559
|
-
* @secure
|
|
5526
|
+
* @min 1
|
|
5527
|
+
* @max 50
|
|
5528
|
+
* @example 10
|
|
5560
5529
|
*/
|
|
5561
|
-
|
|
5530
|
+
size: number;
|
|
5531
|
+
}
|
|
5532
|
+
export interface InsightStockScreenerQuoteV2 {
|
|
5533
|
+
average_volume_30d: number;
|
|
5534
|
+
company_name: string;
|
|
5535
|
+
dividend_ex_date: string;
|
|
5536
|
+
dividend_pay_date: string;
|
|
5537
|
+
dividend_percent: number;
|
|
5538
|
+
exchange: string;
|
|
5539
|
+
exchange_name: string;
|
|
5540
|
+
gap: number;
|
|
5541
|
+
industry: string;
|
|
5542
|
+
industry_code: string;
|
|
5543
|
+
last_price: number;
|
|
5544
|
+
market_cap: number;
|
|
5545
|
+
pe_ratio: number;
|
|
5546
|
+
price_change: number;
|
|
5547
|
+
price_change_percent: number;
|
|
5548
|
+
symbol: string;
|
|
5549
|
+
volume: number;
|
|
5550
|
+
}
|
|
5551
|
+
export interface InsightStockScreenerRequestV2 {
|
|
5552
|
+
average_volume_30d?: InsightLessAndMoreV2;
|
|
5553
|
+
dividend_ex_date?: InsightBeforeAndAfterV2;
|
|
5554
|
+
dividend_pay_date?: InsightBeforeAndAfterV2;
|
|
5555
|
+
dividend_percent?: InsightLessAndMoreV2;
|
|
5556
|
+
exchange?: InsightIncludeExcludeV2;
|
|
5557
|
+
gap?: InsightLessAndMoreV2;
|
|
5558
|
+
industry?: InsightIncludeExcludeV2;
|
|
5559
|
+
market_cap?: InsightLessAndMoreV2;
|
|
5560
|
+
pagination: InsightPaginationV2;
|
|
5561
|
+
pe_ratio?: InsightLessAndMoreV2;
|
|
5562
|
+
price?: InsightLessAndMoreV2;
|
|
5563
|
+
price_change_percent?: InsightLessAndMoreV2;
|
|
5564
|
+
sorts?: InsightOrderingV2[];
|
|
5565
|
+
/** @example "ADR" */
|
|
5566
|
+
stock_type?: string;
|
|
5567
|
+
volume?: InsightLessAndMoreV2;
|
|
5568
|
+
}
|
|
5569
|
+
export interface InsightStockScreenerResponseV2 {
|
|
5570
|
+
current_page: number;
|
|
5571
|
+
data: InsightStockScreenerQuoteV2[];
|
|
5572
|
+
page_count: number;
|
|
5573
|
+
status: number;
|
|
5574
|
+
total_records: number;
|
|
5575
|
+
}
|
|
5576
|
+
/**
|
|
5577
|
+
* @default "asc"
|
|
5578
|
+
* @example "asc"
|
|
5579
|
+
*/
|
|
5580
|
+
export enum InsightOrderingDirectionEnumV2 {
|
|
5581
|
+
Asc = "asc",
|
|
5582
|
+
Desc = "desc"
|
|
5583
|
+
}
|
|
5584
|
+
export class FixedIncomeV2<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
5585
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
5586
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
5562
5587
|
/**
|
|
5563
|
-
* @description
|
|
5564
|
-
* @tags
|
|
5565
|
-
* @name
|
|
5566
|
-
* @summary
|
|
5567
|
-
* @request
|
|
5588
|
+
* @description get fixed income entries
|
|
5589
|
+
* @tags FixedIncome
|
|
5590
|
+
* @name GetFixedIncomeEntries
|
|
5591
|
+
* @summary get fixed income entries
|
|
5592
|
+
* @request POST:/fixed-income
|
|
5568
5593
|
* @secure
|
|
5569
5594
|
*/
|
|
5570
|
-
|
|
5571
|
-
/** Comma separated symbols */
|
|
5572
|
-
symbols: string;
|
|
5573
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
|
|
5595
|
+
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError, Format>>;
|
|
5574
5596
|
}
|
|
5575
|
-
export class
|
|
5576
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5577
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5597
|
+
export class Fundamentals<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
5598
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
5599
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
5578
5600
|
/**
|
|
5579
|
-
* @description
|
|
5580
|
-
* @tags
|
|
5581
|
-
* @name
|
|
5582
|
-
* @summary
|
|
5583
|
-
* @request POST:/
|
|
5601
|
+
* @description get fundamentals by symbol data
|
|
5602
|
+
* @tags Fundamentals
|
|
5603
|
+
* @name GetFundamentalsBySymbolData
|
|
5604
|
+
* @summary get fundamentals by symbol data
|
|
5605
|
+
* @request POST:/fundamentals
|
|
5584
5606
|
* @secure
|
|
5585
5607
|
*/
|
|
5586
|
-
|
|
5608
|
+
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError, Format>>;
|
|
5587
5609
|
}
|
|
5588
|
-
export class
|
|
5589
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5590
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5610
|
+
export class Funds<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
5611
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
5612
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
5591
5613
|
/**
|
|
5592
|
-
* @description
|
|
5593
|
-
* @tags
|
|
5594
|
-
* @name
|
|
5595
|
-
* @summary
|
|
5596
|
-
* @request GET:/
|
|
5614
|
+
* @description get fund details
|
|
5615
|
+
* @tags Funds
|
|
5616
|
+
* @name GetFundDetails
|
|
5617
|
+
* @summary get fund details
|
|
5618
|
+
* @request GET:/funds/details
|
|
5597
5619
|
* @secure
|
|
5598
5620
|
*/
|
|
5599
|
-
|
|
5600
|
-
/**
|
|
5601
|
-
|
|
5602
|
-
|
|
5603
|
-
to?: string;
|
|
5604
|
-
/** Time interval for buckets: 1d (day), 1w (week), 1mo (month), 3mo (3 months). Default is 1d. */
|
|
5605
|
-
interval?: string;
|
|
5606
|
-
/** Limit the number of OHLC data points returned. Default is 100. */
|
|
5607
|
-
limit?: number;
|
|
5608
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<{
|
|
5609
|
-
close?: number;
|
|
5610
|
-
high?: number;
|
|
5611
|
-
low?: number;
|
|
5612
|
-
open?: number;
|
|
5613
|
-
time?: string;
|
|
5614
|
-
volume?: number;
|
|
5615
|
-
}[], HandleError>>;
|
|
5621
|
+
getFundDetails(query: {
|
|
5622
|
+
/** Fund symbol */
|
|
5623
|
+
symbol: string;
|
|
5624
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundDetailsResponse, HandleError, Format>>;
|
|
5616
5625
|
/**
|
|
5617
|
-
* @description
|
|
5618
|
-
* @tags
|
|
5619
|
-
* @name
|
|
5620
|
-
* @summary
|
|
5621
|
-
* @request GET:/
|
|
5622
|
-
* @secure
|
|
5623
|
-
*/
|
|
5624
|
-
|
|
5626
|
+
* @description get list of ETF funds
|
|
5627
|
+
* @tags Funds
|
|
5628
|
+
* @name ListOfEtfFunds
|
|
5629
|
+
* @summary get list of ETF funds
|
|
5630
|
+
* @request GET:/funds/etfs
|
|
5631
|
+
* @secure
|
|
5632
|
+
*/
|
|
5633
|
+
listOfEtfFunds(query?: {
|
|
5634
|
+
/** Asset class id */
|
|
5635
|
+
asset_class?: string;
|
|
5636
|
+
/** Leverage ratios to filter by */
|
|
5637
|
+
leverage_ratios?: number[];
|
|
5638
|
+
/** Whether to include inverse ETFs */
|
|
5639
|
+
inverse?: boolean;
|
|
5640
|
+
/** Search query to filter funds by name */
|
|
5641
|
+
search_query?: string;
|
|
5642
|
+
/** Field to search in (e.g. symbol, name, provider_company). Default is name and symbol */
|
|
5643
|
+
search_field?: string;
|
|
5644
|
+
/**
|
|
5645
|
+
* Minimum expense ratio to filter by
|
|
5646
|
+
* @format float64
|
|
5647
|
+
*/
|
|
5648
|
+
expense_ratio_min?: number;
|
|
5649
|
+
/**
|
|
5650
|
+
* Maximum expense ratio to filter by
|
|
5651
|
+
* @format float64
|
|
5652
|
+
*/
|
|
5653
|
+
expense_ratio_max?: number;
|
|
5654
|
+
/**
|
|
5655
|
+
* Minimum fund net assets to filter by
|
|
5656
|
+
* @format float64
|
|
5657
|
+
*/
|
|
5658
|
+
fund_net_assets_min?: number;
|
|
5659
|
+
/**
|
|
5660
|
+
* Maximum fund net assets to filter by
|
|
5661
|
+
* @format float64
|
|
5662
|
+
*/
|
|
5663
|
+
fund_net_assets_max?: number;
|
|
5664
|
+
/** Field to order by (e.g. fund_net_assets, expense_ratio, trailing_return_y1, average_calendar_month_daily_volume, name, inception_date) */
|
|
5665
|
+
order_field?: string;
|
|
5666
|
+
/** Order direction (asc or desc) */
|
|
5667
|
+
order_direction?: string;
|
|
5668
|
+
/** Number of records to return */
|
|
5669
|
+
limit?: number;
|
|
5670
|
+
/** Number of records to skip */
|
|
5671
|
+
offset?: number;
|
|
5672
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightListFundsResponse, HandleError, Format>>;
|
|
5625
5673
|
/**
|
|
5626
|
-
* @description get
|
|
5627
|
-
* @tags
|
|
5628
|
-
* @name
|
|
5629
|
-
* @summary get
|
|
5630
|
-
* @request GET:/
|
|
5631
|
-
* @secure
|
|
5632
|
-
*/
|
|
5633
|
-
|
|
5634
|
-
/**
|
|
5635
|
-
|
|
5636
|
-
/**
|
|
5637
|
-
|
|
5638
|
-
/**
|
|
5639
|
-
|
|
5640
|
-
/** filter by
|
|
5641
|
-
|
|
5642
|
-
/**
|
|
5643
|
-
|
|
5644
|
-
/**
|
|
5645
|
-
|
|
5646
|
-
|
|
5647
|
-
|
|
5648
|
-
|
|
5649
|
-
|
|
5650
|
-
|
|
5651
|
-
|
|
5652
|
-
|
|
5653
|
-
|
|
5654
|
-
/**
|
|
5655
|
-
|
|
5656
|
-
|
|
5657
|
-
|
|
5658
|
-
|
|
5674
|
+
* @description get list of ETN funds
|
|
5675
|
+
* @tags Funds
|
|
5676
|
+
* @name ListOfEtnFunds
|
|
5677
|
+
* @summary get list of ETN funds
|
|
5678
|
+
* @request GET:/funds/etns
|
|
5679
|
+
* @secure
|
|
5680
|
+
*/
|
|
5681
|
+
listOfEtnFunds(query?: {
|
|
5682
|
+
/** Asset class id */
|
|
5683
|
+
asset_class?: string;
|
|
5684
|
+
/** Leverage ratios to filter by */
|
|
5685
|
+
leverage_ratios?: number[];
|
|
5686
|
+
/** Whether to include inverse ETFs */
|
|
5687
|
+
inverse?: boolean;
|
|
5688
|
+
/** Search query to filter funds by name */
|
|
5689
|
+
search_query?: string;
|
|
5690
|
+
/** Field to search in (e.g. symbol, name, provider_company). Default is name and symbol */
|
|
5691
|
+
search_field?: string;
|
|
5692
|
+
/**
|
|
5693
|
+
* Minimum expense ratio to filter by
|
|
5694
|
+
* @format float64
|
|
5695
|
+
*/
|
|
5696
|
+
expense_ratio_min?: number;
|
|
5697
|
+
/**
|
|
5698
|
+
* Maximum expense ratio to filter by
|
|
5699
|
+
* @format float64
|
|
5700
|
+
*/
|
|
5701
|
+
expense_ratio_max?: number;
|
|
5702
|
+
/**
|
|
5703
|
+
* Minimum fund net assets to filter by
|
|
5704
|
+
* @format float64
|
|
5705
|
+
*/
|
|
5706
|
+
fund_net_assets_min?: number;
|
|
5707
|
+
/**
|
|
5708
|
+
* Maximum fund net assets to filter by
|
|
5709
|
+
* @format float64
|
|
5710
|
+
*/
|
|
5711
|
+
fund_net_assets_max?: number;
|
|
5712
|
+
/** Field to order by (e.g. fund_net_assets, expense_ratio, trailing_return_y1, average_calendar_month_daily_volume, name, inception_date) */
|
|
5713
|
+
order_field?: string;
|
|
5714
|
+
/** Order direction (asc or desc) */
|
|
5715
|
+
order_direction?: string;
|
|
5716
|
+
/** Number of records to return */
|
|
5717
|
+
limit?: number;
|
|
5718
|
+
/** Number of records to skip */
|
|
5719
|
+
offset?: number;
|
|
5720
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightListFundsResponse, HandleError, Format>>;
|
|
5659
5721
|
/**
|
|
5660
|
-
* @description get
|
|
5661
|
-
* @tags
|
|
5662
|
-
* @name
|
|
5663
|
-
* @summary get
|
|
5664
|
-
* @request
|
|
5665
|
-
* @originalName getPreIpoCompanies
|
|
5666
|
-
* @duplicate
|
|
5722
|
+
* @description get funds for holding
|
|
5723
|
+
* @tags Funds
|
|
5724
|
+
* @name GetFundsForHolding
|
|
5725
|
+
* @summary get funds for holding
|
|
5726
|
+
* @request POST:/funds/funds-for-holding
|
|
5667
5727
|
* @secure
|
|
5668
5728
|
*/
|
|
5669
|
-
|
|
5729
|
+
getFundsForHolding(filter: InsightGetFundsForHoldingRequest, headers?: {
|
|
5730
|
+
/** Authorization */
|
|
5731
|
+
Authorization?: string;
|
|
5732
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundsForHoldingResponse, HandleError, Format>>;
|
|
5670
5733
|
/**
|
|
5671
|
-
* @description
|
|
5672
|
-
* @tags
|
|
5673
|
-
* @name
|
|
5674
|
-
* @summary
|
|
5675
|
-
* @request
|
|
5734
|
+
* @description filter funds by params
|
|
5735
|
+
* @tags Funds
|
|
5736
|
+
* @name FundScreener
|
|
5737
|
+
* @summary filter funds by params
|
|
5738
|
+
* @request POST:/funds/screener
|
|
5676
5739
|
* @secure
|
|
5677
5740
|
*/
|
|
5678
|
-
|
|
5679
|
-
/**
|
|
5680
|
-
|
|
5681
|
-
|
|
5682
|
-
round_name?: string;
|
|
5683
|
-
/** how many records to return. Max value is 50 */
|
|
5684
|
-
limit: number;
|
|
5685
|
-
/** how many records to skip */
|
|
5686
|
-
offset: number;
|
|
5687
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyFundingRoundsResponse, HandleError>>;
|
|
5741
|
+
fundScreener(filter: InsightFundScreenerRequest, headers?: {
|
|
5742
|
+
/** Authorization */
|
|
5743
|
+
Authorization?: string;
|
|
5744
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError, Format>>;
|
|
5688
5745
|
/**
|
|
5689
|
-
* @description get
|
|
5690
|
-
* @tags
|
|
5691
|
-
* @name
|
|
5692
|
-
* @summary get
|
|
5693
|
-
* @request GET:/
|
|
5694
|
-
* @originalName getPreIpoCompanyFundingRounds
|
|
5695
|
-
* @duplicate
|
|
5746
|
+
* @description get fund screener filters
|
|
5747
|
+
* @tags Funds
|
|
5748
|
+
* @name GetScreenerFilters
|
|
5749
|
+
* @summary get fund screener filters
|
|
5750
|
+
* @request GET:/funds/screener/filters
|
|
5696
5751
|
* @secure
|
|
5697
5752
|
*/
|
|
5698
|
-
|
|
5753
|
+
getScreenerFilters(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundScreenerFiltersResponse, HandleError, Format>>;
|
|
5699
5754
|
/**
|
|
5700
|
-
* @description get
|
|
5701
|
-
* @tags
|
|
5702
|
-
* @name
|
|
5703
|
-
* @summary get
|
|
5704
|
-
* @request GET:/
|
|
5755
|
+
* @description get fund screener presets
|
|
5756
|
+
* @tags Funds
|
|
5757
|
+
* @name GetFundScreenerPresets
|
|
5758
|
+
* @summary get fund screener presets
|
|
5759
|
+
* @request GET:/funds/screener/presets
|
|
5705
5760
|
* @secure
|
|
5706
5761
|
*/
|
|
5707
|
-
|
|
5708
|
-
/**
|
|
5709
|
-
pre_ipo_company_id?: string;
|
|
5710
|
-
/** company name */
|
|
5711
|
-
company_name?: string;
|
|
5712
|
-
/** how many records to return. Max value is 50 */
|
|
5762
|
+
getFundScreenerPresets(query: {
|
|
5763
|
+
/** how many records to return */
|
|
5713
5764
|
limit: number;
|
|
5714
5765
|
/** how many records to skip */
|
|
5715
5766
|
offset: number;
|
|
5716
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5767
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError, Format>>;
|
|
5717
5768
|
/**
|
|
5718
|
-
* @description
|
|
5719
|
-
* @tags
|
|
5720
|
-
* @name
|
|
5721
|
-
* @summary
|
|
5722
|
-
* @request
|
|
5723
|
-
* @originalName getPreIpoCompanyInvestments
|
|
5724
|
-
* @duplicate
|
|
5769
|
+
* @description update fund screener preset
|
|
5770
|
+
* @tags Funds
|
|
5771
|
+
* @name UpdateFundScreenerPreset
|
|
5772
|
+
* @summary update fund screener preset
|
|
5773
|
+
* @request PUT:/funds/screener/presets
|
|
5725
5774
|
* @secure
|
|
5726
5775
|
*/
|
|
5727
|
-
|
|
5776
|
+
updateFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError, Format>>;
|
|
5728
5777
|
/**
|
|
5729
|
-
* @description
|
|
5730
|
-
* @tags
|
|
5731
|
-
* @name
|
|
5732
|
-
* @summary
|
|
5733
|
-
* @request
|
|
5778
|
+
* @description create fund screener preset
|
|
5779
|
+
* @tags Funds
|
|
5780
|
+
* @name CreateFundScreenerPreset
|
|
5781
|
+
* @summary create fund screener preset
|
|
5782
|
+
* @request POST:/funds/screener/presets
|
|
5734
5783
|
* @secure
|
|
5735
5784
|
*/
|
|
5736
|
-
|
|
5737
|
-
/** company id */
|
|
5738
|
-
pre_ipo_company_id?: string;
|
|
5739
|
-
/** search by headline */
|
|
5740
|
-
headline?: string;
|
|
5741
|
-
/** how many records to return. Max value is 50 */
|
|
5742
|
-
limit: number;
|
|
5743
|
-
/** how many records to skip */
|
|
5744
|
-
offset: number;
|
|
5745
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyNewsResponse, HandleError>>;
|
|
5785
|
+
createFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError, Format>>;
|
|
5746
5786
|
/**
|
|
5747
|
-
* @description
|
|
5748
|
-
* @tags
|
|
5749
|
-
* @name
|
|
5750
|
-
* @summary
|
|
5751
|
-
* @request
|
|
5752
|
-
* @originalName getPreIpoCompanyNews
|
|
5753
|
-
* @duplicate
|
|
5787
|
+
* @description remove fund screener preset
|
|
5788
|
+
* @tags Funds
|
|
5789
|
+
* @name RemoveFundScreenerPreset
|
|
5790
|
+
* @summary remove fund screener preset
|
|
5791
|
+
* @request DELETE:/funds/screener/presets
|
|
5754
5792
|
* @secure
|
|
5755
5793
|
*/
|
|
5756
|
-
|
|
5794
|
+
removeFundScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
5757
5795
|
/**
|
|
5758
|
-
* @description
|
|
5759
|
-
* @tags
|
|
5760
|
-
* @name
|
|
5761
|
-
* @summary
|
|
5762
|
-
* @request
|
|
5796
|
+
* @description filter funds by params
|
|
5797
|
+
* @tags Funds
|
|
5798
|
+
* @name FundSectorScreener
|
|
5799
|
+
* @summary filter funds by params
|
|
5800
|
+
* @request POST:/funds/sector-screener
|
|
5763
5801
|
* @secure
|
|
5764
5802
|
*/
|
|
5765
|
-
|
|
5766
|
-
/**
|
|
5767
|
-
|
|
5768
|
-
|
|
5769
|
-
title?: string;
|
|
5770
|
-
/** how many records to return. Max value is 50 */
|
|
5771
|
-
limit: number;
|
|
5772
|
-
/** how many records to skip */
|
|
5773
|
-
offset: number;
|
|
5774
|
-
/** search by research type */
|
|
5775
|
-
research_type?: InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum;
|
|
5776
|
-
/** search by relation */
|
|
5777
|
-
relation?: InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum;
|
|
5778
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError>>;
|
|
5803
|
+
fundSectorScreener(filter: InsightFundSectorScreenerRequest, headers?: {
|
|
5804
|
+
/** Authorization */
|
|
5805
|
+
Authorization?: string;
|
|
5806
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError, Format>>;
|
|
5779
5807
|
/**
|
|
5780
|
-
* @description get
|
|
5781
|
-
* @tags
|
|
5782
|
-
* @name
|
|
5783
|
-
* @summary get
|
|
5784
|
-
* @request
|
|
5785
|
-
* @originalName getPreIpoCompanyResearchDocuments
|
|
5786
|
-
* @duplicate
|
|
5808
|
+
* @description get top funds
|
|
5809
|
+
* @tags Funds
|
|
5810
|
+
* @name GetTopFunds
|
|
5811
|
+
* @summary get top funds
|
|
5812
|
+
* @request POST:/funds/top
|
|
5787
5813
|
* @secure
|
|
5788
5814
|
*/
|
|
5789
|
-
|
|
5815
|
+
getTopFunds(filter: InsightGetTopFundsRequest, headers?: {
|
|
5816
|
+
/** Authorization */
|
|
5817
|
+
Authorization?: string;
|
|
5818
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError, Format>>;
|
|
5790
5819
|
/**
|
|
5791
|
-
* @description get
|
|
5792
|
-
* @tags
|
|
5793
|
-
* @name
|
|
5794
|
-
* @summary get
|
|
5795
|
-
* @request GET:/
|
|
5820
|
+
* @description get fund by symbol
|
|
5821
|
+
* @tags Funds
|
|
5822
|
+
* @name GetFund
|
|
5823
|
+
* @summary get fund by symbol
|
|
5824
|
+
* @request GET:/funds/{symbol}
|
|
5796
5825
|
* @secure
|
|
5797
5826
|
*/
|
|
5798
|
-
|
|
5799
|
-
|
|
5800
|
-
|
|
5801
|
-
|
|
5802
|
-
|
|
5803
|
-
/** Optional param to filter returned spv's based on the name */
|
|
5804
|
-
name_filter?: string;
|
|
5805
|
-
/** investment id */
|
|
5806
|
-
pre_ipo_company_id?: string;
|
|
5807
|
-
/** investment id */
|
|
5808
|
-
pre_ipo_company_investment_id?: string;
|
|
5809
|
-
/** page number */
|
|
5810
|
-
page: number;
|
|
5811
|
-
/** page size */
|
|
5812
|
-
page_size: number;
|
|
5813
|
-
/** sort direction */
|
|
5814
|
-
sort_order?: InsightGetInvestorParamsSortOrderEnum;
|
|
5815
|
-
/** sort field */
|
|
5816
|
-
sort_by?: InsightGetInvestorParamsSortByEnum;
|
|
5817
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsWithInvestorIDResponse, HandleError>>;
|
|
5827
|
+
getFund(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundWithDetails, HandleError, Format>>;
|
|
5828
|
+
}
|
|
5829
|
+
export class Intraday<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
5830
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
5831
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
5818
5832
|
/**
|
|
5819
|
-
* @description
|
|
5820
|
-
* @tags
|
|
5821
|
-
* @name
|
|
5822
|
-
* @summary
|
|
5823
|
-
* @request
|
|
5824
|
-
* @originalName getInvestor
|
|
5825
|
-
* @duplicate
|
|
5833
|
+
* @description Returns an array of intraday chart data values for the given ticker.
|
|
5834
|
+
* @tags Intraday
|
|
5835
|
+
* @name IntradayQuotes
|
|
5836
|
+
* @summary Get an array of intraday chart data values for the given ticker
|
|
5837
|
+
* @request POST:/intraday/quotes
|
|
5826
5838
|
* @secure
|
|
5827
5839
|
*/
|
|
5828
|
-
|
|
5829
|
-
|
|
5830
|
-
|
|
5831
|
-
|
|
5840
|
+
intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError, Format>>;
|
|
5841
|
+
}
|
|
5842
|
+
export class Ipos<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
5843
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
5844
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
5832
5845
|
/**
|
|
5833
|
-
* @description get
|
|
5834
|
-
* @tags
|
|
5835
|
-
* @name
|
|
5836
|
-
* @summary get
|
|
5837
|
-
* @request
|
|
5846
|
+
* @description get recent ipos info
|
|
5847
|
+
* @tags Ipos
|
|
5848
|
+
* @name PostRecent
|
|
5849
|
+
* @summary get recent ipos info
|
|
5850
|
+
* @request POST:/ipos/recent
|
|
5838
5851
|
* @secure
|
|
5839
5852
|
*/
|
|
5840
|
-
|
|
5841
|
-
|
|
5842
|
-
|
|
5843
|
-
|
|
5844
|
-
|
|
5845
|
-
|
|
5846
|
-
|
|
5847
|
-
|
|
5848
|
-
|
|
5853
|
+
postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError, Format>>;
|
|
5854
|
+
/**
|
|
5855
|
+
* @description get upcoming ipos info
|
|
5856
|
+
* @tags Ipos
|
|
5857
|
+
* @name GetUpcoming
|
|
5858
|
+
* @summary get upcoming ipos info
|
|
5859
|
+
* @request GET:/ipos/upcoming
|
|
5860
|
+
* @secure
|
|
5861
|
+
*/
|
|
5862
|
+
getUpcoming(query: {
|
|
5849
5863
|
/** how many records to return. Max value is 50 */
|
|
5850
5864
|
limit: number;
|
|
5851
5865
|
/** how many records to skip */
|
|
5852
5866
|
offset: number;
|
|
5853
|
-
|
|
5854
|
-
monark_stage?: InsightGetPreIpoCompanySpvsParamsMonarkStageEnum;
|
|
5855
|
-
/** sort direction */
|
|
5856
|
-
direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
|
|
5857
|
-
/** sort field */
|
|
5858
|
-
field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
|
|
5859
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
|
|
5867
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError, Format>>;
|
|
5860
5868
|
/**
|
|
5861
|
-
* @description get
|
|
5862
|
-
* @tags
|
|
5863
|
-
* @name
|
|
5864
|
-
* @summary get
|
|
5865
|
-
* @request GET:/ipos/
|
|
5866
|
-
* @originalName getPreIpoCompanySpvs
|
|
5867
|
-
* @duplicate
|
|
5869
|
+
* @description get ipo info by symbol
|
|
5870
|
+
* @tags Ipos
|
|
5871
|
+
* @name GetIpos
|
|
5872
|
+
* @summary get ipo info by symbol
|
|
5873
|
+
* @request GET:/ipos/{symbol}
|
|
5868
5874
|
* @secure
|
|
5869
|
-
*/
|
|
5870
|
-
|
|
5871
|
-
/**
|
|
5872
|
-
|
|
5873
|
-
|
|
5875
|
+
*/
|
|
5876
|
+
getIpos(symbol: string, query?: {
|
|
5877
|
+
/** load quotes */
|
|
5878
|
+
load_quotes?: boolean;
|
|
5879
|
+
/** statuses */
|
|
5880
|
+
statuses?: string[];
|
|
5881
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError, Format>>;
|
|
5874
5882
|
}
|
|
5875
|
-
export class Logos<HandleError extends boolean = boolean> {
|
|
5876
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5877
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5883
|
+
export class Logos<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
5884
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
5885
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
5878
5886
|
/**
|
|
5879
5887
|
* @description Returns converted logo for crypto symbol
|
|
5880
5888
|
* @tags Logos
|
|
@@ -5883,7 +5891,7 @@ export class Logos<HandleError extends boolean = boolean> {
|
|
|
5883
5891
|
* @request POST:/logos/converted-crypto-symbol-logo
|
|
5884
5892
|
* @secure
|
|
5885
5893
|
*/
|
|
5886
|
-
logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5894
|
+
logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError, Format>>;
|
|
5887
5895
|
/**
|
|
5888
5896
|
* @description Returns converted logo for symbol
|
|
5889
5897
|
* @tags Logos
|
|
@@ -5892,7 +5900,7 @@ export class Logos<HandleError extends boolean = boolean> {
|
|
|
5892
5900
|
* @request POST:/logos/converted-symbol-logo
|
|
5893
5901
|
* @secure
|
|
5894
5902
|
*/
|
|
5895
|
-
logosConvertedSymbolLogo(filter: InsightSymbolLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5903
|
+
logosConvertedSymbolLogo(filter: InsightSymbolLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError, Format>>;
|
|
5896
5904
|
/**
|
|
5897
5905
|
* @description Returns logo for crypto symbol
|
|
5898
5906
|
* @tags Logos
|
|
@@ -5904,7 +5912,7 @@ export class Logos<HandleError extends boolean = boolean> {
|
|
|
5904
5912
|
logosCryptoSymbolLogo(query: {
|
|
5905
5913
|
/** Company symbol */
|
|
5906
5914
|
symbol: string;
|
|
5907
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError>>;
|
|
5915
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError, Format>>;
|
|
5908
5916
|
/**
|
|
5909
5917
|
* @description Returns direct logo for crypto symbol
|
|
5910
5918
|
* @tags Logos
|
|
@@ -5916,7 +5924,7 @@ export class Logos<HandleError extends boolean = boolean> {
|
|
|
5916
5924
|
logosDirectCryptoSymbolLogo(query: {
|
|
5917
5925
|
/** Company symbol */
|
|
5918
5926
|
symbol: string;
|
|
5919
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5927
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError, Format>>;
|
|
5920
5928
|
/**
|
|
5921
5929
|
* @description Returns direct logo for symbol
|
|
5922
5930
|
* @tags Logos
|
|
@@ -5928,7 +5936,7 @@ export class Logos<HandleError extends boolean = boolean> {
|
|
|
5928
5936
|
logosDirectSymbolLogo(query: {
|
|
5929
5937
|
/** Company symbol */
|
|
5930
5938
|
symbol: string;
|
|
5931
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5939
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError, Format>>;
|
|
5932
5940
|
/**
|
|
5933
5941
|
* @description Returns logos for multiple symbols
|
|
5934
5942
|
* @tags Logos
|
|
@@ -5937,7 +5945,7 @@ export class Logos<HandleError extends boolean = boolean> {
|
|
|
5937
5945
|
* @request POST:/logos/multiple-crypto-symbol-logo
|
|
5938
5946
|
* @secure
|
|
5939
5947
|
*/
|
|
5940
|
-
logosMultipleCryptoSymbolLogo(filter: InsightMultipleCryptoLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse[], HandleError>>;
|
|
5948
|
+
logosMultipleCryptoSymbolLogo(filter: InsightMultipleCryptoLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse[], HandleError, Format>>;
|
|
5941
5949
|
/**
|
|
5942
5950
|
* @description Returns logos for multiple symbol
|
|
5943
5951
|
* @tags Logos
|
|
@@ -5946,7 +5954,7 @@ export class Logos<HandleError extends boolean = boolean> {
|
|
|
5946
5954
|
* @request POST:/logos/multiple-symbol-logos
|
|
5947
5955
|
* @secure
|
|
5948
5956
|
*/
|
|
5949
|
-
logosMultipleSymbolLogos(filter: InsightMultipleSymbolLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse[], HandleError>>;
|
|
5957
|
+
logosMultipleSymbolLogos(filter: InsightMultipleSymbolLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse[], HandleError, Format>>;
|
|
5950
5958
|
/**
|
|
5951
5959
|
* @description Returns links of socials logos for symbol
|
|
5952
5960
|
* @tags Logos
|
|
@@ -5958,7 +5966,7 @@ export class Logos<HandleError extends boolean = boolean> {
|
|
|
5958
5966
|
logosSocialSymbolLogos(query: {
|
|
5959
5967
|
/** Company symbol */
|
|
5960
5968
|
symbol: string;
|
|
5961
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
|
|
5969
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError, Format>>;
|
|
5962
5970
|
/**
|
|
5963
5971
|
* @description Returns logos for company symbol
|
|
5964
5972
|
* @tags Logos
|
|
@@ -5970,52 +5978,11 @@ export class Logos<HandleError extends boolean = boolean> {
|
|
|
5970
5978
|
logosSymbolLogos(query: {
|
|
5971
5979
|
/** Company symbol */
|
|
5972
5980
|
symbol: string;
|
|
5973
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
|
|
5974
|
-
}
|
|
5975
|
-
export class Ipos<HandleError extends boolean = boolean> {
|
|
5976
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5977
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5978
|
-
/**
|
|
5979
|
-
* @description get recent ipos info
|
|
5980
|
-
* @tags Ipos
|
|
5981
|
-
* @name PostRecent
|
|
5982
|
-
* @summary get recent ipos info
|
|
5983
|
-
* @request POST:/ipos/recent
|
|
5984
|
-
* @secure
|
|
5985
|
-
*/
|
|
5986
|
-
postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5987
|
-
/**
|
|
5988
|
-
* @description get upcoming ipos info
|
|
5989
|
-
* @tags Ipos
|
|
5990
|
-
* @name GetUpcoming
|
|
5991
|
-
* @summary get upcoming ipos info
|
|
5992
|
-
* @request GET:/ipos/upcoming
|
|
5993
|
-
* @secure
|
|
5994
|
-
*/
|
|
5995
|
-
getUpcoming(query: {
|
|
5996
|
-
/** how many records to return. Max value is 50 */
|
|
5997
|
-
limit: number;
|
|
5998
|
-
/** how many records to skip */
|
|
5999
|
-
offset: number;
|
|
6000
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
6001
|
-
/**
|
|
6002
|
-
* @description get ipo info by symbol
|
|
6003
|
-
* @tags Ipos
|
|
6004
|
-
* @name GetIpos
|
|
6005
|
-
* @summary get ipo info by symbol
|
|
6006
|
-
* @request GET:/ipos/{symbol}
|
|
6007
|
-
* @secure
|
|
6008
|
-
*/
|
|
6009
|
-
getIpos(symbol: string, query?: {
|
|
6010
|
-
/** load quotes */
|
|
6011
|
-
load_quotes?: boolean;
|
|
6012
|
-
/** statuses */
|
|
6013
|
-
statuses?: string[];
|
|
6014
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
|
|
5981
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError, Format>>;
|
|
6015
5982
|
}
|
|
6016
|
-
export class MarketDates<HandleError extends boolean = boolean> {
|
|
6017
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6018
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5983
|
+
export class MarketDates<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
5984
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
5985
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
6019
5986
|
/**
|
|
6020
5987
|
* @description Create or update market date
|
|
6021
5988
|
* @tags MarketDates
|
|
@@ -6024,7 +5991,7 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
6024
5991
|
* @request POST:/market-dates
|
|
6025
5992
|
* @secure
|
|
6026
5993
|
*/
|
|
6027
|
-
createOrUpdateMarketDate(market: InsightMarketDates[], config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketDate[], HandleError>>;
|
|
5994
|
+
createOrUpdateMarketDate(market: InsightMarketDates[], config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketDate[], HandleError, Format>>;
|
|
6028
5995
|
/**
|
|
6029
5996
|
* @description Remove market date
|
|
6030
5997
|
* @tags MarketDates
|
|
@@ -6033,7 +6000,7 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
6033
6000
|
* @request DELETE:/market-dates
|
|
6034
6001
|
* @secure
|
|
6035
6002
|
*/
|
|
6036
|
-
removeMarketDate(input: InsightRemoveMarketDateRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6003
|
+
removeMarketDate(input: InsightRemoveMarketDateRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
6037
6004
|
/**
|
|
6038
6005
|
* @description Get market dates history
|
|
6039
6006
|
* @tags MarketDates
|
|
@@ -6042,7 +6009,7 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
6042
6009
|
* @request POST:/market-dates/history
|
|
6043
6010
|
* @secure
|
|
6044
6011
|
*/
|
|
6045
|
-
getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
|
|
6012
|
+
getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError, Format>>;
|
|
6046
6013
|
/**
|
|
6047
6014
|
* @description Search locode data by search string and field
|
|
6048
6015
|
* @tags MarketDates
|
|
@@ -6056,7 +6023,7 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
6056
6023
|
search?: string;
|
|
6057
6024
|
/** Search field */
|
|
6058
6025
|
field?: InsightSearchLocodeDataParamsFieldEnum;
|
|
6059
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSearchLocodeDataResponse, HandleError>>;
|
|
6026
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSearchLocodeDataResponse, HandleError, Format>>;
|
|
6060
6027
|
/**
|
|
6061
6028
|
* @description Get markets
|
|
6062
6029
|
* @tags MarketDates
|
|
@@ -6065,7 +6032,7 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
6065
6032
|
* @request GET:/market-dates/markets
|
|
6066
6033
|
* @secure
|
|
6067
6034
|
*/
|
|
6068
|
-
getMarkets(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketsResponse, HandleError>>;
|
|
6035
|
+
getMarkets(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketsResponse, HandleError, Format>>;
|
|
6069
6036
|
/**
|
|
6070
6037
|
* @description Create or update market
|
|
6071
6038
|
* @tags MarketDates
|
|
@@ -6074,7 +6041,7 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
6074
6041
|
* @request POST:/market-dates/markets
|
|
6075
6042
|
* @secure
|
|
6076
6043
|
*/
|
|
6077
|
-
createOrUpdateMarket(market: InsightCreateOrUpdateMarketRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarket, HandleError>>;
|
|
6044
|
+
createOrUpdateMarket(market: InsightCreateOrUpdateMarketRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarket, HandleError, Format>>;
|
|
6078
6045
|
/**
|
|
6079
6046
|
* @description Get market
|
|
6080
6047
|
* @tags MarketDates
|
|
@@ -6083,7 +6050,7 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
6083
6050
|
* @request GET:/market-dates/markets/{market}
|
|
6084
6051
|
* @secure
|
|
6085
6052
|
*/
|
|
6086
|
-
getMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketWithSchedule, HandleError>>;
|
|
6053
|
+
getMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketWithSchedule, HandleError, Format>>;
|
|
6087
6054
|
/**
|
|
6088
6055
|
* @description Remove market
|
|
6089
6056
|
* @tags MarketDates
|
|
@@ -6092,7 +6059,7 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
6092
6059
|
* @request DELETE:/market-dates/markets/{market}
|
|
6093
6060
|
* @secure
|
|
6094
6061
|
*/
|
|
6095
|
-
removeMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6062
|
+
removeMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
6096
6063
|
/**
|
|
6097
6064
|
* @description Get market schedules
|
|
6098
6065
|
* @tags MarketDates
|
|
@@ -6104,7 +6071,7 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
6104
6071
|
getMarketSchedules(query?: {
|
|
6105
6072
|
/** Market codes, comma separated */
|
|
6106
6073
|
market?: string;
|
|
6107
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse[][], HandleError>>;
|
|
6074
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse[][], HandleError, Format>>;
|
|
6108
6075
|
/**
|
|
6109
6076
|
* @description CreateOrUpdateMarketSchedule market schedule
|
|
6110
6077
|
* @tags MarketDates
|
|
@@ -6113,7 +6080,7 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
6113
6080
|
* @request POST:/market-dates/schedule
|
|
6114
6081
|
* @secure
|
|
6115
6082
|
*/
|
|
6116
|
-
createOrUpdateMarketSchedule(market: InsightCreateOrUpdateMarketScheduleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
|
|
6083
|
+
createOrUpdateMarketSchedule(market: InsightCreateOrUpdateMarketScheduleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError, Format>>;
|
|
6117
6084
|
/**
|
|
6118
6085
|
* @description Get market schedule
|
|
6119
6086
|
* @tags MarketDates
|
|
@@ -6122,7 +6089,7 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
6122
6089
|
* @request GET:/market-dates/schedule/{market}
|
|
6123
6090
|
* @secure
|
|
6124
6091
|
*/
|
|
6125
|
-
getMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
|
|
6092
|
+
getMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError, Format>>;
|
|
6126
6093
|
/**
|
|
6127
6094
|
* @description Remove market schedule
|
|
6128
6095
|
* @tags MarketDates
|
|
@@ -6131,7 +6098,7 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
6131
6098
|
* @request DELETE:/market-dates/schedule/{market}
|
|
6132
6099
|
* @secure
|
|
6133
6100
|
*/
|
|
6134
|
-
removeMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6101
|
+
removeMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
6135
6102
|
/**
|
|
6136
6103
|
* @description Get todays market hours
|
|
6137
6104
|
* @tags MarketDates
|
|
@@ -6143,11 +6110,11 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
6143
6110
|
getTodaysMarketHours(query: {
|
|
6144
6111
|
/** Market */
|
|
6145
6112
|
market: string;
|
|
6146
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
|
|
6113
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError, Format>>;
|
|
6147
6114
|
}
|
|
6148
|
-
export class News<HandleError extends boolean = boolean> {
|
|
6149
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6150
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6115
|
+
export class News<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
6116
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
6117
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
6151
6118
|
/**
|
|
6152
6119
|
* @description Returns available authors in DB
|
|
6153
6120
|
* @tags News
|
|
@@ -6156,7 +6123,7 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
6156
6123
|
* @request POST:/news/authors
|
|
6157
6124
|
* @secure
|
|
6158
6125
|
*/
|
|
6159
|
-
newsAvailableAuthors(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
6126
|
+
newsAvailableAuthors(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError, Format>>;
|
|
6160
6127
|
/**
|
|
6161
6128
|
* @description Returns available channels in DB
|
|
6162
6129
|
* @tags News
|
|
@@ -6165,7 +6132,7 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
6165
6132
|
* @request POST:/news/channels
|
|
6166
6133
|
* @secure
|
|
6167
6134
|
*/
|
|
6168
|
-
newsAvailableChannels(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
6135
|
+
newsAvailableChannels(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError, Format>>;
|
|
6169
6136
|
/**
|
|
6170
6137
|
* @description Get featured articles
|
|
6171
6138
|
* @tags News
|
|
@@ -6183,7 +6150,7 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
6183
6150
|
start_date?: string;
|
|
6184
6151
|
/** End date */
|
|
6185
6152
|
end_date?: string;
|
|
6186
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
|
|
6153
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError, Format>>;
|
|
6187
6154
|
/**
|
|
6188
6155
|
* @description Update featured articles
|
|
6189
6156
|
* @tags News
|
|
@@ -6192,7 +6159,7 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
6192
6159
|
* @request PUT:/news/featured-articles
|
|
6193
6160
|
* @secure
|
|
6194
6161
|
*/
|
|
6195
|
-
updateFeaturedArticles(input: InsightUpdateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6162
|
+
updateFeaturedArticles(input: InsightUpdateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
6196
6163
|
/**
|
|
6197
6164
|
* @description Create featured articles
|
|
6198
6165
|
* @tags News
|
|
@@ -6201,7 +6168,7 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
6201
6168
|
* @request POST:/news/featured-articles
|
|
6202
6169
|
* @secure
|
|
6203
6170
|
*/
|
|
6204
|
-
createFeaturedArticles(input: InsightCreateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6171
|
+
createFeaturedArticles(input: InsightCreateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
6205
6172
|
/**
|
|
6206
6173
|
* @description Get active featured articles
|
|
6207
6174
|
* @tags News
|
|
@@ -6210,7 +6177,23 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
6210
6177
|
* @request GET:/news/featured-articles/active
|
|
6211
6178
|
* @secure
|
|
6212
6179
|
*/
|
|
6213
|
-
getActiveFeaturedArticles(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
|
|
6180
|
+
getActiveFeaturedArticles(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError, Format>>;
|
|
6181
|
+
/**
|
|
6182
|
+
* @description Get featured article config
|
|
6183
|
+
* @tags News
|
|
6184
|
+
* @name GetFeaturedArticleConfig
|
|
6185
|
+
* @summary Get featured article config
|
|
6186
|
+
* @request GET:/news/featured-articles/configs
|
|
6187
|
+
*/
|
|
6188
|
+
getFeaturedArticleConfig(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticleConfig, HandleError, Format>>;
|
|
6189
|
+
/**
|
|
6190
|
+
* @description Create featured article config
|
|
6191
|
+
* @tags News
|
|
6192
|
+
* @name CreateFeaturedArticleConfig
|
|
6193
|
+
* @summary Create featured article config
|
|
6194
|
+
* @request POST:/news/featured-articles/configs
|
|
6195
|
+
*/
|
|
6196
|
+
createFeaturedArticleConfig(input: InsightCreateFeaturedArticleConfigRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticleConfig, HandleError, Format>>;
|
|
6214
6197
|
/**
|
|
6215
6198
|
* @description Set featured articles
|
|
6216
6199
|
* @tags News
|
|
@@ -6219,7 +6202,7 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
6219
6202
|
* @request POST:/news/featured-articles/set
|
|
6220
6203
|
* @secure
|
|
6221
6204
|
*/
|
|
6222
|
-
setFeaturedArticles(input: InsightSetFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6205
|
+
setFeaturedArticles(input: InsightSetFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
6223
6206
|
/**
|
|
6224
6207
|
* @description Get featured article
|
|
6225
6208
|
* @tags News
|
|
@@ -6228,7 +6211,7 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
6228
6211
|
* @request GET:/news/featured-articles/{id}
|
|
6229
6212
|
* @secure
|
|
6230
6213
|
*/
|
|
6231
|
-
getFeaturedArticle(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticle, HandleError>>;
|
|
6214
|
+
getFeaturedArticle(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticle, HandleError, Format>>;
|
|
6232
6215
|
/**
|
|
6233
6216
|
* @description Returns news by filters
|
|
6234
6217
|
* @tags News
|
|
@@ -6237,7 +6220,7 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
6237
6220
|
* @request POST:/news/filter
|
|
6238
6221
|
* @secure
|
|
6239
6222
|
*/
|
|
6240
|
-
newsFiltered(filter: InsightNewsFilterRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsResponse, HandleError>>;
|
|
6223
|
+
newsFiltered(filter: InsightNewsFilterRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsResponse, HandleError, Format>>;
|
|
6241
6224
|
/**
|
|
6242
6225
|
* @description Returns news by id
|
|
6243
6226
|
* @tags News
|
|
@@ -6246,7 +6229,7 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
6246
6229
|
* @request POST:/news/id
|
|
6247
6230
|
* @secure
|
|
6248
6231
|
*/
|
|
6249
|
-
newsById(filter: InsightNewsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNews, HandleError>>;
|
|
6232
|
+
newsById(filter: InsightNewsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNews, HandleError, Format>>;
|
|
6250
6233
|
/**
|
|
6251
6234
|
* @description Returns news previews
|
|
6252
6235
|
* @tags News
|
|
@@ -6266,7 +6249,7 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
6266
6249
|
limit: number;
|
|
6267
6250
|
/** how many records to skip */
|
|
6268
6251
|
offset: number;
|
|
6269
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRecentNewsPreviewsResponse, HandleError>>;
|
|
6252
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRecentNewsPreviewsResponse, HandleError, Format>>;
|
|
6270
6253
|
/**
|
|
6271
6254
|
* @description Returns available stocks in DB
|
|
6272
6255
|
* @tags News
|
|
@@ -6282,7 +6265,7 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
6282
6265
|
offset?: number;
|
|
6283
6266
|
/** search query */
|
|
6284
6267
|
search_query?: string;
|
|
6285
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
6268
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError, Format>>;
|
|
6286
6269
|
/**
|
|
6287
6270
|
* @description Returns available tags in DB
|
|
6288
6271
|
* @tags News
|
|
@@ -6291,11 +6274,11 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
6291
6274
|
* @request POST:/news/tags
|
|
6292
6275
|
* @secure
|
|
6293
6276
|
*/
|
|
6294
|
-
newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
6277
|
+
newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError, Format>>;
|
|
6295
6278
|
}
|
|
6296
|
-
export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
6297
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6298
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6279
|
+
export class OptionGreeks<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
6280
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
6281
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
6299
6282
|
/**
|
|
6300
6283
|
* @description Returns calculated matrix
|
|
6301
6284
|
* @tags OptionGreeks
|
|
@@ -6304,78 +6287,387 @@ export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
|
6304
6287
|
* @request POST:/og/calculate-matrix
|
|
6305
6288
|
* @secure
|
|
6306
6289
|
*/
|
|
6307
|
-
ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
|
|
6290
|
+
ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError, Format>>;
|
|
6291
|
+
/**
|
|
6292
|
+
* @description Returns calculated params
|
|
6293
|
+
* @tags OptionGreeks
|
|
6294
|
+
* @name OgCalculateParams
|
|
6295
|
+
* @summary Calculate params
|
|
6296
|
+
* @request POST:/og/calculate-params
|
|
6297
|
+
* @secure
|
|
6298
|
+
*/
|
|
6299
|
+
ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError, Format>>;
|
|
6300
|
+
}
|
|
6301
|
+
export class Ownerships<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
6302
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
6303
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
6304
|
+
/**
|
|
6305
|
+
* @description get ownerships by id datadata
|
|
6306
|
+
* @tags Ownerships
|
|
6307
|
+
* @name GetOwnershipsByIdData
|
|
6308
|
+
* @summary get ownerships by id data
|
|
6309
|
+
* @request POST:/ownerships
|
|
6310
|
+
* @secure
|
|
6311
|
+
*/
|
|
6312
|
+
getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError, Format>>;
|
|
6313
|
+
/**
|
|
6314
|
+
* @description get ownerships by symbol data
|
|
6315
|
+
* @tags Ownerships
|
|
6316
|
+
* @name GetOwnershipsBySymbolData
|
|
6317
|
+
* @summary get ownerships by symbol data
|
|
6318
|
+
* @request POST:/symbol-ownerships
|
|
6319
|
+
* @secure
|
|
6320
|
+
*/
|
|
6321
|
+
getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError, Format>>;
|
|
6322
|
+
}
|
|
6323
|
+
export class Passport<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
6324
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
6325
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
6326
|
+
/**
|
|
6327
|
+
* @description Returns article by id
|
|
6328
|
+
* @tags Passport
|
|
6329
|
+
* @name PassportArticleById
|
|
6330
|
+
* @summary Get article by id
|
|
6331
|
+
* @request POST:/passport/article-by-id
|
|
6332
|
+
* @secure
|
|
6333
|
+
*/
|
|
6334
|
+
passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError, Format>>;
|
|
6335
|
+
/**
|
|
6336
|
+
* @description Returns articles
|
|
6337
|
+
* @tags Passport
|
|
6338
|
+
* @name PassportArticles
|
|
6339
|
+
* @summary Get articles
|
|
6340
|
+
* @request POST:/passport/articles
|
|
6341
|
+
* @secure
|
|
6342
|
+
*/
|
|
6343
|
+
passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError, Format>>;
|
|
6344
|
+
/**
|
|
6345
|
+
* @description Returns author profile
|
|
6346
|
+
* @tags Passport
|
|
6347
|
+
* @name PassportAuthorProfile
|
|
6348
|
+
* @summary Get author profile
|
|
6349
|
+
* @request POST:/passport/author-profile
|
|
6350
|
+
* @secure
|
|
6351
|
+
*/
|
|
6352
|
+
passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError, Format>>;
|
|
6353
|
+
/**
|
|
6354
|
+
* @description Returns most popular tags
|
|
6355
|
+
* @tags Passport
|
|
6356
|
+
* @name PassportMostPopularTags
|
|
6357
|
+
* @summary Get most popular tags
|
|
6358
|
+
* @request POST:/passport/most-popular-tags
|
|
6359
|
+
* @secure
|
|
6360
|
+
*/
|
|
6361
|
+
passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError, Format>>;
|
|
6362
|
+
/**
|
|
6363
|
+
* @description Returns news feed
|
|
6364
|
+
* @tags Passport
|
|
6365
|
+
* @name PassportNewsFeed
|
|
6366
|
+
* @summary Get news feed
|
|
6367
|
+
* @request POST:/passport/newsfeed
|
|
6368
|
+
* @secure
|
|
6369
|
+
*/
|
|
6370
|
+
passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError, Format>>;
|
|
6371
|
+
/**
|
|
6372
|
+
* @description Returns article by parameters
|
|
6373
|
+
* @tags Passport
|
|
6374
|
+
* @name PassportSearchArticle
|
|
6375
|
+
* @summary Search article by parameters
|
|
6376
|
+
* @request POST:/passport/search-article
|
|
6377
|
+
* @secure
|
|
6378
|
+
*/
|
|
6379
|
+
passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError, Format>>;
|
|
6380
|
+
}
|
|
6381
|
+
export class PreIpoCompanies<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
6382
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
6383
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
6384
|
+
/**
|
|
6385
|
+
* @description Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
|
|
6386
|
+
* @tags PreIPOCompanies
|
|
6387
|
+
* @name MonarkOghlcDataForSymbol
|
|
6388
|
+
* @summary Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
|
|
6389
|
+
* @request GET:/ipos/market-data/ohlc/{symbol}
|
|
6390
|
+
* @secure
|
|
6391
|
+
*/
|
|
6392
|
+
monarkOghlcDataForSymbol(symbol: string, query?: {
|
|
6393
|
+
/** Start time for the OHLC data in ISO 8601 format YYYY-MM-DD */
|
|
6394
|
+
from?: string;
|
|
6395
|
+
/** End time for the OHLC data in ISO 8601 format YYYY-MM-DD */
|
|
6396
|
+
to?: string;
|
|
6397
|
+
/** Time interval for buckets: 1d (day), 1w (week), 1mo (month), 3mo (3 months). Default is 1d. */
|
|
6398
|
+
interval?: string;
|
|
6399
|
+
/** Limit the number of OHLC data points returned. Default is 100. */
|
|
6400
|
+
limit?: number;
|
|
6401
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<{
|
|
6402
|
+
close?: number;
|
|
6403
|
+
high?: number;
|
|
6404
|
+
low?: number;
|
|
6405
|
+
open?: number;
|
|
6406
|
+
time?: string;
|
|
6407
|
+
volume?: number;
|
|
6408
|
+
}[], HandleError, Format>>;
|
|
6409
|
+
/**
|
|
6410
|
+
* @description Retrieves all symbols available in the market data
|
|
6411
|
+
* @tags PreIPOCompanies
|
|
6412
|
+
* @name MonarkAllAvailableSymbols
|
|
6413
|
+
* @summary Retrieves all symbols available in the market data
|
|
6414
|
+
* @request GET:/ipos/market-data/symbols
|
|
6415
|
+
* @secure
|
|
6416
|
+
*/
|
|
6417
|
+
monarkAllAvailableSymbols(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError, Format>>;
|
|
6418
|
+
/**
|
|
6419
|
+
* @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
|
|
6420
|
+
* @tags PreIPOCompanies
|
|
6421
|
+
* @name GetPreIpoCompanies
|
|
6422
|
+
* @summary get pre ipo companies
|
|
6423
|
+
* @request GET:/ipos/pre-ipo-companies
|
|
6424
|
+
* @secure
|
|
6425
|
+
*/
|
|
6426
|
+
getPreIpoCompanies(query: {
|
|
6427
|
+
/** search by company name */
|
|
6428
|
+
name?: string;
|
|
6429
|
+
/** search by categories */
|
|
6430
|
+
categories?: string;
|
|
6431
|
+
/** search by listing type */
|
|
6432
|
+
listing_type?: string;
|
|
6433
|
+
/** filter by active status */
|
|
6434
|
+
is_active?: InsightGetPreIpoCompaniesParamsIsActiveEnum;
|
|
6435
|
+
/** filter by minimum last valuation */
|
|
6436
|
+
min_last_valuation?: number;
|
|
6437
|
+
/** filter by maximum last valuation */
|
|
6438
|
+
max_last_valuation?: number;
|
|
6439
|
+
/** filter by minimum total funding */
|
|
6440
|
+
min_total_funding?: number;
|
|
6441
|
+
/** filter by maximum total funding */
|
|
6442
|
+
max_total_funding?: number;
|
|
6443
|
+
/** how many records to return. Max value is 50 */
|
|
6444
|
+
limit: number;
|
|
6445
|
+
/** how many records to skip */
|
|
6446
|
+
offset: number;
|
|
6447
|
+
/** sort field */
|
|
6448
|
+
order_field?: InsightGetPreIpoCompaniesParamsOrderFieldEnum;
|
|
6449
|
+
/** sort direction */
|
|
6450
|
+
order_direction?: InsightGetPreIpoCompaniesParamsOrderDirectionEnum;
|
|
6451
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError, Format>>;
|
|
6452
|
+
/**
|
|
6453
|
+
* @description get pre ipo company by id
|
|
6454
|
+
* @tags PreIPOCompanies
|
|
6455
|
+
* @name GetPreIpoCompaniesById
|
|
6456
|
+
* @summary get pre ipo company by id
|
|
6457
|
+
* @request GET:/ipos/pre-ipo-companies/{id}
|
|
6458
|
+
* @originalName getPreIpoCompanies
|
|
6459
|
+
* @duplicate
|
|
6460
|
+
* @secure
|
|
6461
|
+
*/
|
|
6462
|
+
getPreIpoCompaniesById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompany, HandleError, Format>>;
|
|
6463
|
+
/**
|
|
6464
|
+
* @description get pre ipo company funding rounds
|
|
6465
|
+
* @tags PreIPOCompanies
|
|
6466
|
+
* @name GetPreIpoCompanyFundingRounds
|
|
6467
|
+
* @summary get pre ipo company funding rounds
|
|
6468
|
+
* @request GET:/ipos/pre-ipo-company-funding-rounds
|
|
6469
|
+
* @secure
|
|
6470
|
+
*/
|
|
6471
|
+
getPreIpoCompanyFundingRounds(query: {
|
|
6472
|
+
/** company id */
|
|
6473
|
+
pre_ipo_company_id?: string;
|
|
6474
|
+
/** search by round name */
|
|
6475
|
+
round_name?: string;
|
|
6476
|
+
/** how many records to return. Max value is 50 */
|
|
6477
|
+
limit: number;
|
|
6478
|
+
/** how many records to skip */
|
|
6479
|
+
offset: number;
|
|
6480
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyFundingRoundsResponse, HandleError, Format>>;
|
|
6481
|
+
/**
|
|
6482
|
+
* @description get pre ipo company funding round by id
|
|
6483
|
+
* @tags PreIPOCompanies
|
|
6484
|
+
* @name GetPreIpoCompanyFundingRoundsById
|
|
6485
|
+
* @summary get pre ipo company funding round by id
|
|
6486
|
+
* @request GET:/ipos/pre-ipo-company-funding-rounds/{id}
|
|
6487
|
+
* @originalName getPreIpoCompanyFundingRounds
|
|
6488
|
+
* @duplicate
|
|
6489
|
+
* @secure
|
|
6490
|
+
*/
|
|
6491
|
+
getPreIpoCompanyFundingRoundsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyFundingRound, HandleError, Format>>;
|
|
6492
|
+
/**
|
|
6493
|
+
* @description get pre ipo company investments
|
|
6494
|
+
* @tags PreIPOCompanies
|
|
6495
|
+
* @name GetPreIpoCompanyInvestments
|
|
6496
|
+
* @summary get pre ipo company investments
|
|
6497
|
+
* @request GET:/ipos/pre-ipo-company-investments
|
|
6498
|
+
* @secure
|
|
6499
|
+
*/
|
|
6500
|
+
getPreIpoCompanyInvestments(query: {
|
|
6501
|
+
/** company id */
|
|
6502
|
+
pre_ipo_company_id?: string;
|
|
6503
|
+
/** company name */
|
|
6504
|
+
company_name?: string;
|
|
6505
|
+
/** how many records to return. Max value is 50 */
|
|
6506
|
+
limit: number;
|
|
6507
|
+
/** how many records to skip */
|
|
6508
|
+
offset: number;
|
|
6509
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyInvestmentsResponse, HandleError, Format>>;
|
|
6510
|
+
/**
|
|
6511
|
+
* @description get pre ipo company investment by id
|
|
6512
|
+
* @tags PreIPOCompanies
|
|
6513
|
+
* @name GetPreIpoCompanyInvestmentsById
|
|
6514
|
+
* @summary get pre ipo company investment by id
|
|
6515
|
+
* @request GET:/ipos/pre-ipo-company-investments/{id}
|
|
6516
|
+
* @originalName getPreIpoCompanyInvestments
|
|
6517
|
+
* @duplicate
|
|
6518
|
+
* @secure
|
|
6519
|
+
*/
|
|
6520
|
+
getPreIpoCompanyInvestmentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyInvestment, HandleError, Format>>;
|
|
6521
|
+
/**
|
|
6522
|
+
* @description get pre ipo company news
|
|
6523
|
+
* @tags PreIPOCompanies
|
|
6524
|
+
* @name GetPreIpoCompanyNews
|
|
6525
|
+
* @summary get pre ipo company news
|
|
6526
|
+
* @request GET:/ipos/pre-ipo-company-news
|
|
6527
|
+
* @secure
|
|
6528
|
+
*/
|
|
6529
|
+
getPreIpoCompanyNews(query: {
|
|
6530
|
+
/** company id */
|
|
6531
|
+
pre_ipo_company_id?: string;
|
|
6532
|
+
/** search by headline */
|
|
6533
|
+
headline?: string;
|
|
6534
|
+
/** how many records to return. Max value is 50 */
|
|
6535
|
+
limit: number;
|
|
6536
|
+
/** how many records to skip */
|
|
6537
|
+
offset: number;
|
|
6538
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyNewsResponse, HandleError, Format>>;
|
|
6308
6539
|
/**
|
|
6309
|
-
* @description
|
|
6310
|
-
* @tags
|
|
6311
|
-
* @name
|
|
6312
|
-
* @summary
|
|
6313
|
-
* @request
|
|
6540
|
+
* @description get pre ipo company news by id
|
|
6541
|
+
* @tags PreIPOCompanies
|
|
6542
|
+
* @name GetPreIpoCompanyNewsById
|
|
6543
|
+
* @summary get pre ipo company news by id
|
|
6544
|
+
* @request GET:/ipos/pre-ipo-company-news/{id}
|
|
6545
|
+
* @originalName getPreIpoCompanyNews
|
|
6546
|
+
* @duplicate
|
|
6314
6547
|
* @secure
|
|
6315
6548
|
*/
|
|
6316
|
-
|
|
6317
|
-
}
|
|
6318
|
-
export class Passport<HandleError extends boolean = boolean> {
|
|
6319
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6320
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6549
|
+
getPreIpoCompanyNewsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyNews, HandleError, Format>>;
|
|
6321
6550
|
/**
|
|
6322
|
-
* @description
|
|
6323
|
-
* @tags
|
|
6324
|
-
* @name
|
|
6325
|
-
* @summary
|
|
6326
|
-
* @request
|
|
6551
|
+
* @description get pre ipo company research documents
|
|
6552
|
+
* @tags PreIPOCompanies
|
|
6553
|
+
* @name GetPreIpoCompanyResearchDocuments
|
|
6554
|
+
* @summary get pre ipo company research documents
|
|
6555
|
+
* @request GET:/ipos/pre-ipo-company-research-documents
|
|
6327
6556
|
* @secure
|
|
6328
6557
|
*/
|
|
6329
|
-
|
|
6558
|
+
getPreIpoCompanyResearchDocuments(query: {
|
|
6559
|
+
/** company id */
|
|
6560
|
+
pre_ipo_company_id?: string;
|
|
6561
|
+
/** search by title */
|
|
6562
|
+
title?: string;
|
|
6563
|
+
/** how many records to return. Max value is 50 */
|
|
6564
|
+
limit: number;
|
|
6565
|
+
/** how many records to skip */
|
|
6566
|
+
offset: number;
|
|
6567
|
+
/** search by research type */
|
|
6568
|
+
research_type?: InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum;
|
|
6569
|
+
/** search by relation */
|
|
6570
|
+
relation?: InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum;
|
|
6571
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError, Format>>;
|
|
6330
6572
|
/**
|
|
6331
|
-
* @description
|
|
6332
|
-
* @tags
|
|
6333
|
-
* @name
|
|
6334
|
-
* @summary
|
|
6335
|
-
* @request
|
|
6573
|
+
* @description get pre ipo company research document by id
|
|
6574
|
+
* @tags PreIPOCompanies
|
|
6575
|
+
* @name GetPreIpoCompanyResearchDocumentsById
|
|
6576
|
+
* @summary get pre ipo company research document by id
|
|
6577
|
+
* @request GET:/ipos/pre-ipo-company-research-documents/{id}
|
|
6578
|
+
* @originalName getPreIpoCompanyResearchDocuments
|
|
6579
|
+
* @duplicate
|
|
6336
6580
|
* @secure
|
|
6337
6581
|
*/
|
|
6338
|
-
|
|
6582
|
+
getPreIpoCompanyResearchDocumentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyResearchDocument, HandleError, Format>>;
|
|
6339
6583
|
/**
|
|
6340
|
-
* @description
|
|
6341
|
-
* @tags
|
|
6342
|
-
* @name
|
|
6343
|
-
* @summary
|
|
6344
|
-
* @request
|
|
6584
|
+
* @description get pre ipo company spvs with investor id
|
|
6585
|
+
* @tags PreIPOCompanies
|
|
6586
|
+
* @name GetInvestor
|
|
6587
|
+
* @summary get pre ipo company spvs with investor id
|
|
6588
|
+
* @request GET:/ipos/pre-ipo-company-spv/investor/{investor_id}
|
|
6345
6589
|
* @secure
|
|
6346
6590
|
*/
|
|
6347
|
-
|
|
6591
|
+
getInvestor(investorId: string, query: {
|
|
6592
|
+
/** search by monark stage */
|
|
6593
|
+
monark_stage?: InsightGetInvestorParamsMonarkStageEnum;
|
|
6594
|
+
/** Optional param to filter returned spv's based on the exemptions claimed */
|
|
6595
|
+
exemptions_claimed?: string[];
|
|
6596
|
+
/** Optional param to filter returned spv's based on the name */
|
|
6597
|
+
name_filter?: string;
|
|
6598
|
+
/** investment id */
|
|
6599
|
+
pre_ipo_company_id?: string;
|
|
6600
|
+
/** investment id */
|
|
6601
|
+
pre_ipo_company_investment_id?: string;
|
|
6602
|
+
/** page number */
|
|
6603
|
+
page: number;
|
|
6604
|
+
/** page size */
|
|
6605
|
+
page_size: number;
|
|
6606
|
+
/** sort direction */
|
|
6607
|
+
sort_order?: InsightGetInvestorParamsSortOrderEnum;
|
|
6608
|
+
/** sort field */
|
|
6609
|
+
sort_by?: InsightGetInvestorParamsSortByEnum;
|
|
6610
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsWithInvestorIDResponse, HandleError, Format>>;
|
|
6348
6611
|
/**
|
|
6349
|
-
* @description
|
|
6350
|
-
* @tags
|
|
6351
|
-
* @name
|
|
6352
|
-
* @summary
|
|
6353
|
-
* @request
|
|
6612
|
+
* @description get pre ipo company spv by id with investor id
|
|
6613
|
+
* @tags PreIPOCompanies
|
|
6614
|
+
* @name GetInvestorByIdAndInvestorId
|
|
6615
|
+
* @summary get pre ipo company spv by id with investor id
|
|
6616
|
+
* @request GET:/ipos/pre-ipo-company-spv/{id}/investor/{investor_id}
|
|
6617
|
+
* @originalName getInvestor
|
|
6618
|
+
* @duplicate
|
|
6354
6619
|
* @secure
|
|
6355
6620
|
*/
|
|
6356
|
-
|
|
6621
|
+
getInvestorByIdAndInvestorId(id: string, investorId: string, query?: {
|
|
6622
|
+
/** default is false, if true documents will be included in the response */
|
|
6623
|
+
include_documents?: boolean;
|
|
6624
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetProIPOCompabySPVWithInvestorIDResponse, HandleError, Format>>;
|
|
6357
6625
|
/**
|
|
6358
|
-
* @description
|
|
6359
|
-
* @tags
|
|
6360
|
-
* @name
|
|
6361
|
-
* @summary
|
|
6362
|
-
* @request
|
|
6626
|
+
* @description get pre ipo company spvs
|
|
6627
|
+
* @tags PreIPOCompanies
|
|
6628
|
+
* @name GetPreIpoCompanySpvs
|
|
6629
|
+
* @summary get pre ipo company spvs
|
|
6630
|
+
* @request GET:/ipos/pre-ipo-company-spvs
|
|
6363
6631
|
* @secure
|
|
6364
6632
|
*/
|
|
6365
|
-
|
|
6633
|
+
getPreIpoCompanySpvs(query: {
|
|
6634
|
+
/** company id */
|
|
6635
|
+
pre_ipo_company_id?: string;
|
|
6636
|
+
/** investment id */
|
|
6637
|
+
investment_id?: string;
|
|
6638
|
+
/** search by name */
|
|
6639
|
+
name?: string;
|
|
6640
|
+
/** search by company name */
|
|
6641
|
+
company_name?: string;
|
|
6642
|
+
/** how many records to return. Max value is 50 */
|
|
6643
|
+
limit: number;
|
|
6644
|
+
/** how many records to skip */
|
|
6645
|
+
offset: number;
|
|
6646
|
+
/** search by monark stage */
|
|
6647
|
+
monark_stage?: InsightGetPreIpoCompanySpvsParamsMonarkStageEnum;
|
|
6648
|
+
/** sort direction */
|
|
6649
|
+
direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
|
|
6650
|
+
/** sort field */
|
|
6651
|
+
field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
|
|
6652
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError, Format>>;
|
|
6366
6653
|
/**
|
|
6367
|
-
* @description
|
|
6368
|
-
* @tags
|
|
6369
|
-
* @name
|
|
6370
|
-
* @summary
|
|
6371
|
-
* @request
|
|
6654
|
+
* @description get pre ipo company spv by id
|
|
6655
|
+
* @tags PreIPOCompanies
|
|
6656
|
+
* @name GetPreIpoCompanySpvsById
|
|
6657
|
+
* @summary get pre ipo company spv by id
|
|
6658
|
+
* @request GET:/ipos/pre-ipo-company-spvs/{id}
|
|
6659
|
+
* @originalName getPreIpoCompanySpvs
|
|
6660
|
+
* @duplicate
|
|
6372
6661
|
* @secure
|
|
6373
6662
|
*/
|
|
6374
|
-
|
|
6663
|
+
getPreIpoCompanySpvsById(id: string, query?: {
|
|
6664
|
+
/** default is false, if true documents will be included in the response */
|
|
6665
|
+
include_documents?: boolean;
|
|
6666
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError, Format>>;
|
|
6375
6667
|
}
|
|
6376
|
-
export class Public<HandleError extends boolean = boolean> {
|
|
6377
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6378
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6668
|
+
export class Public<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
6669
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
6670
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
6379
6671
|
/**
|
|
6380
6672
|
* @description Calculate estimated returns for selected symbols. Uses split adjusted prices
|
|
6381
6673
|
* @tags Public
|
|
@@ -6396,7 +6688,7 @@ export class Public<HandleError extends boolean = boolean> {
|
|
|
6396
6688
|
start_date: string;
|
|
6397
6689
|
/** End date for calculations */
|
|
6398
6690
|
end_date: string;
|
|
6399
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
|
|
6691
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError, Format>>;
|
|
6400
6692
|
/**
|
|
6401
6693
|
* @description Returns an expert forecast
|
|
6402
6694
|
* @tags Public
|
|
@@ -6408,7 +6700,7 @@ export class Public<HandleError extends boolean = boolean> {
|
|
|
6408
6700
|
expertForecast(query: {
|
|
6409
6701
|
/** Comma separated symbols */
|
|
6410
6702
|
symbols: string;
|
|
6411
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
|
|
6703
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError, Format>>;
|
|
6412
6704
|
/**
|
|
6413
6705
|
* @description get fundamentals by symbol data
|
|
6414
6706
|
* @tags Public
|
|
@@ -6420,7 +6712,7 @@ export class Public<HandleError extends boolean = boolean> {
|
|
|
6420
6712
|
getPublicFundamentalsBySymbolData(symbol: string, query: {
|
|
6421
6713
|
/** Annual or quarterly */
|
|
6422
6714
|
mode: string;
|
|
6423
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
6715
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError, Format>>;
|
|
6424
6716
|
/**
|
|
6425
6717
|
* @description Daily price history
|
|
6426
6718
|
* @tags Public
|
|
@@ -6429,139 +6721,236 @@ export class Public<HandleError extends boolean = boolean> {
|
|
|
6429
6721
|
* @request GET:/public/price-history/daily
|
|
6430
6722
|
* @secure
|
|
6431
6723
|
*/
|
|
6432
|
-
dailyPriceHistory(query: {
|
|
6433
|
-
/** Single symbol */
|
|
6434
|
-
symbol: string;
|
|
6435
|
-
/** Target date */
|
|
6436
|
-
date: string;
|
|
6437
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
|
|
6724
|
+
dailyPriceHistory(query: {
|
|
6725
|
+
/** Single symbol */
|
|
6726
|
+
symbol: string;
|
|
6727
|
+
/** Target date */
|
|
6728
|
+
date: string;
|
|
6729
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError, Format>>;
|
|
6730
|
+
/**
|
|
6731
|
+
* @description Public quote profile
|
|
6732
|
+
* @tags Public
|
|
6733
|
+
* @name PublicQuoteProfile
|
|
6734
|
+
* @summary Public quote profile
|
|
6735
|
+
* @request GET:/public/quote-profile/{symbol}
|
|
6736
|
+
* @secure
|
|
6737
|
+
*/
|
|
6738
|
+
publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError, Format>>;
|
|
6739
|
+
/**
|
|
6740
|
+
* @description get ratios by symbol data
|
|
6741
|
+
* @tags Public
|
|
6742
|
+
* @name GetPublicRatiosBySymbolData
|
|
6743
|
+
* @summary get ratios by symbol data
|
|
6744
|
+
* @request GET:/public/ratios/{symbol}
|
|
6745
|
+
* @secure
|
|
6746
|
+
*/
|
|
6747
|
+
getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError, Format>>;
|
|
6748
|
+
/**
|
|
6749
|
+
* @description find a symbol by name or description
|
|
6750
|
+
* @tags Public
|
|
6751
|
+
* @name QuoteFundamentalsSearch
|
|
6752
|
+
* @summary find a symbol by name or description
|
|
6753
|
+
* @request GET:/public/symbol-search
|
|
6754
|
+
* @secure
|
|
6755
|
+
*/
|
|
6756
|
+
quoteFundamentalsSearch(query: {
|
|
6757
|
+
/** Search query */
|
|
6758
|
+
search_query: string;
|
|
6759
|
+
/** how many records to return. Max value is 50 */
|
|
6760
|
+
limit: number;
|
|
6761
|
+
/** how many records to skip */
|
|
6762
|
+
offset: number;
|
|
6763
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError, Format>>;
|
|
6764
|
+
/**
|
|
6765
|
+
* @description Get top gainers
|
|
6766
|
+
* @tags Public
|
|
6767
|
+
* @name TopGainers
|
|
6768
|
+
* @summary Top Gainers
|
|
6769
|
+
* @request GET:/public/top-gainers
|
|
6770
|
+
* @secure
|
|
6771
|
+
*/
|
|
6772
|
+
topGainers(query: {
|
|
6773
|
+
/** sort direction - asc or desc */
|
|
6774
|
+
order_direction?: string;
|
|
6775
|
+
/** how many records to return. Max value is 50 */
|
|
6776
|
+
limit: number;
|
|
6777
|
+
/** how many records to skip */
|
|
6778
|
+
offset: number;
|
|
6779
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError, Format>>;
|
|
6780
|
+
/**
|
|
6781
|
+
* @description Get top stocks
|
|
6782
|
+
* @tags Public
|
|
6783
|
+
* @name TopStocks
|
|
6784
|
+
* @summary Top Stocks
|
|
6785
|
+
* @request GET:/public/top-stocks
|
|
6786
|
+
* @secure
|
|
6787
|
+
*/
|
|
6788
|
+
topStocks(query: {
|
|
6789
|
+
/** EQUITY|ETF|CRYPTO */
|
|
6790
|
+
stock_type: InsightTopStocksParamsStockTypeEnum;
|
|
6791
|
+
/** how many records to return. Max value is 50 */
|
|
6792
|
+
limit: number;
|
|
6793
|
+
/** how many records to skip */
|
|
6794
|
+
offset: number;
|
|
6795
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError, Format>>;
|
|
6796
|
+
}
|
|
6797
|
+
export class Quotes<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
6798
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
6799
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
6800
|
+
/**
|
|
6801
|
+
* @description Get single historical quote
|
|
6802
|
+
* @tags Quotes
|
|
6803
|
+
* @name GitHistoricalQuote
|
|
6804
|
+
* @summary Get single historical quote
|
|
6805
|
+
* @request GET:/historical/quote
|
|
6806
|
+
* @secure
|
|
6807
|
+
*/
|
|
6808
|
+
gitHistoricalQuote(query: {
|
|
6809
|
+
/** Symbol */
|
|
6810
|
+
symbol: string;
|
|
6811
|
+
/** Date */
|
|
6812
|
+
date: string;
|
|
6813
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError, Format>>;
|
|
6814
|
+
/**
|
|
6815
|
+
* @description get quote history by symbol
|
|
6816
|
+
* @tags Quotes
|
|
6817
|
+
* @name GitQuoteHistory
|
|
6818
|
+
* @summary Get quote history
|
|
6819
|
+
* @request POST:/quote-history
|
|
6820
|
+
* @secure
|
|
6821
|
+
*/
|
|
6822
|
+
gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError, Format>>;
|
|
6823
|
+
/**
|
|
6824
|
+
* @description Returns a list of quotes equity info for specified symbols.
|
|
6825
|
+
* @tags Quotes
|
|
6826
|
+
* @name GetQuotesEquityData
|
|
6827
|
+
* @summary Get Quotes Equity data
|
|
6828
|
+
* @request GET:/quotes/equity
|
|
6829
|
+
* @secure
|
|
6830
|
+
*/
|
|
6831
|
+
getQuotesEquityData(query: {
|
|
6832
|
+
/** Comma separated symbols */
|
|
6833
|
+
symbols: string;
|
|
6834
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError, Format>>;
|
|
6835
|
+
}
|
|
6836
|
+
export class StockScreener<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
6837
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
6838
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
6839
|
+
/**
|
|
6840
|
+
* @description data for visual heat map
|
|
6841
|
+
* @tags StockScreener
|
|
6842
|
+
* @name StockMarketHeatmap
|
|
6843
|
+
* @summary data for visual heat map
|
|
6844
|
+
* @request GET:/heatmaps
|
|
6845
|
+
* @secure
|
|
6846
|
+
*/
|
|
6847
|
+
stockMarketHeatmap(query?: {
|
|
6848
|
+
/** Name of symbol list to fetch details for. Empty is default */
|
|
6849
|
+
heatmap_name?: string;
|
|
6850
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError, Format>>;
|
|
6438
6851
|
/**
|
|
6439
|
-
* @description
|
|
6440
|
-
* @tags
|
|
6441
|
-
* @name
|
|
6442
|
-
* @summary
|
|
6443
|
-
* @request
|
|
6852
|
+
* @description create or update heat map preset
|
|
6853
|
+
* @tags StockScreener
|
|
6854
|
+
* @name CreateStockMarketHeatmapPreset
|
|
6855
|
+
* @summary create or update heat map preset
|
|
6856
|
+
* @request POST:/heatmaps
|
|
6444
6857
|
* @secure
|
|
6445
6858
|
*/
|
|
6446
|
-
|
|
6859
|
+
createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
6447
6860
|
/**
|
|
6448
|
-
* @description
|
|
6449
|
-
* @tags
|
|
6450
|
-
* @name
|
|
6451
|
-
* @summary get
|
|
6452
|
-
* @request
|
|
6861
|
+
* @description Sector and Industry Group performance
|
|
6862
|
+
* @tags StockScreener
|
|
6863
|
+
* @name IndustriesPerformance
|
|
6864
|
+
* @summary get industries performance
|
|
6865
|
+
* @request POST:/industries-performance
|
|
6453
6866
|
* @secure
|
|
6454
6867
|
*/
|
|
6455
|
-
|
|
6868
|
+
industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError, Format>>;
|
|
6456
6869
|
/**
|
|
6457
|
-
* @description
|
|
6458
|
-
* @tags
|
|
6459
|
-
* @name
|
|
6460
|
-
* @summary
|
|
6461
|
-
* @request
|
|
6870
|
+
* @description filter stocks by params
|
|
6871
|
+
* @tags StockScreener
|
|
6872
|
+
* @name StockScreener
|
|
6873
|
+
* @summary filter stocks by params
|
|
6874
|
+
* @request POST:/stock-screener
|
|
6462
6875
|
* @secure
|
|
6463
6876
|
*/
|
|
6464
|
-
|
|
6465
|
-
/** Search query */
|
|
6466
|
-
search_query: string;
|
|
6467
|
-
/** how many records to return. Max value is 50 */
|
|
6468
|
-
limit: number;
|
|
6469
|
-
/** how many records to skip */
|
|
6470
|
-
offset: number;
|
|
6471
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
|
|
6877
|
+
stockScreener(filter: InsightStockScreenerV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError, Format>>;
|
|
6472
6878
|
/**
|
|
6473
|
-
* @description
|
|
6474
|
-
* @tags
|
|
6475
|
-
* @name
|
|
6476
|
-
* @summary
|
|
6477
|
-
* @request GET:/
|
|
6879
|
+
* @description get screener presets
|
|
6880
|
+
* @tags StockScreener
|
|
6881
|
+
* @name GetScreenerPresets
|
|
6882
|
+
* @summary get screener presets
|
|
6883
|
+
* @request GET:/stock-screener/presets
|
|
6478
6884
|
* @secure
|
|
6479
6885
|
*/
|
|
6480
|
-
|
|
6481
|
-
/**
|
|
6482
|
-
order_direction?: string;
|
|
6483
|
-
/** how many records to return. Max value is 50 */
|
|
6886
|
+
getScreenerPresets(query: {
|
|
6887
|
+
/** how many records to return */
|
|
6484
6888
|
limit: number;
|
|
6485
6889
|
/** how many records to skip */
|
|
6486
6890
|
offset: number;
|
|
6487
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
6891
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError, Format>>;
|
|
6488
6892
|
/**
|
|
6489
|
-
* @description
|
|
6490
|
-
* @tags
|
|
6491
|
-
* @name
|
|
6492
|
-
* @summary
|
|
6493
|
-
* @request
|
|
6893
|
+
* @description update screener preset
|
|
6894
|
+
* @tags StockScreener
|
|
6895
|
+
* @name UpdateScreenerPreset
|
|
6896
|
+
* @summary update screener preset
|
|
6897
|
+
* @request PUT:/stock-screener/presets
|
|
6494
6898
|
* @secure
|
|
6495
6899
|
*/
|
|
6496
|
-
|
|
6497
|
-
/** EQUITY|ETF|CRYPTO */
|
|
6498
|
-
stock_type: InsightTopStocksParamsStockTypeEnum;
|
|
6499
|
-
/** how many records to return. Max value is 50 */
|
|
6500
|
-
limit: number;
|
|
6501
|
-
/** how many records to skip */
|
|
6502
|
-
offset: number;
|
|
6503
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6504
|
-
}
|
|
6505
|
-
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
6506
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6507
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6900
|
+
updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError, Format>>;
|
|
6508
6901
|
/**
|
|
6509
|
-
* @description
|
|
6510
|
-
* @tags
|
|
6511
|
-
* @name
|
|
6512
|
-
* @summary
|
|
6513
|
-
* @request POST:/
|
|
6902
|
+
* @description create screener preset
|
|
6903
|
+
* @tags StockScreener
|
|
6904
|
+
* @name CreateOrScreenerPreset
|
|
6905
|
+
* @summary create screener preset
|
|
6906
|
+
* @request POST:/stock-screener/presets
|
|
6514
6907
|
* @secure
|
|
6515
6908
|
*/
|
|
6516
|
-
|
|
6909
|
+
createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError, Format>>;
|
|
6517
6910
|
/**
|
|
6518
|
-
* @description
|
|
6519
|
-
* @tags
|
|
6520
|
-
* @name
|
|
6521
|
-
* @summary
|
|
6522
|
-
* @request
|
|
6911
|
+
* @description remove screener preset
|
|
6912
|
+
* @tags StockScreener
|
|
6913
|
+
* @name RemoveScreenerPreset
|
|
6914
|
+
* @summary remove screener preset
|
|
6915
|
+
* @request DELETE:/stock-screener/presets
|
|
6523
6916
|
* @secure
|
|
6524
6917
|
*/
|
|
6525
|
-
|
|
6526
|
-
}
|
|
6527
|
-
export class UsageTracking<HandleError extends boolean = boolean> {
|
|
6528
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6529
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6918
|
+
removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
6530
6919
|
/**
|
|
6531
|
-
* @description get
|
|
6532
|
-
* @tags
|
|
6533
|
-
* @name
|
|
6534
|
-
* @summary get
|
|
6535
|
-
* @request POST:/
|
|
6920
|
+
* @description get top symbols
|
|
6921
|
+
* @tags StockScreener
|
|
6922
|
+
* @name GetTopSymbols
|
|
6923
|
+
* @summary get top symbols
|
|
6924
|
+
* @request POST:/stock-screener/top
|
|
6536
6925
|
* @secure
|
|
6537
6926
|
*/
|
|
6538
|
-
|
|
6927
|
+
getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError, Format>>;
|
|
6539
6928
|
}
|
|
6540
|
-
export class
|
|
6541
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6542
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6929
|
+
export class StockScreenerV2<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
6930
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
6931
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
6543
6932
|
/**
|
|
6544
|
-
* @description
|
|
6545
|
-
* @tags
|
|
6546
|
-
* @name
|
|
6547
|
-
* @summary
|
|
6548
|
-
* @request POST:/
|
|
6933
|
+
* @description filter stocks by params
|
|
6934
|
+
* @tags StockScreener
|
|
6935
|
+
* @name StockScreener
|
|
6936
|
+
* @summary filter stocks by params
|
|
6937
|
+
* @request POST:/stock-screener
|
|
6549
6938
|
* @secure
|
|
6550
6939
|
*/
|
|
6551
|
-
|
|
6940
|
+
stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError, Format>>;
|
|
6552
6941
|
/**
|
|
6553
|
-
* @description get
|
|
6554
|
-
* @tags
|
|
6555
|
-
* @name
|
|
6556
|
-
* @summary get
|
|
6557
|
-
* @request POST:/
|
|
6942
|
+
* @description get top symbols
|
|
6943
|
+
* @tags StockScreener
|
|
6944
|
+
* @name GetTopSymbols
|
|
6945
|
+
* @summary get top symbols
|
|
6946
|
+
* @request POST:/stock-screener/top
|
|
6558
6947
|
* @secure
|
|
6559
6948
|
*/
|
|
6560
|
-
|
|
6949
|
+
getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError, Format>>;
|
|
6561
6950
|
}
|
|
6562
|
-
export class TipRank<HandleError extends boolean = boolean> {
|
|
6563
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6564
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6951
|
+
export class TipRank<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
6952
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
6953
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
6565
6954
|
/**
|
|
6566
6955
|
* @description Returns an overview of analyst ratings for a given ticker or ticker list, based on analyst ratings from the last 3 months.
|
|
6567
6956
|
* @tags TipRank
|
|
@@ -6570,7 +6959,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6570
6959
|
* @request POST:/tipranks/analyst-consensus
|
|
6571
6960
|
* @secure
|
|
6572
6961
|
*/
|
|
6573
|
-
tiprankAnalystConsensus(filter: InsightAnalystConsensusRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystConsensusResponse[], HandleError>>;
|
|
6962
|
+
tiprankAnalystConsensus(filter: InsightAnalystConsensusRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystConsensusResponse[], HandleError, Format>>;
|
|
6574
6963
|
/**
|
|
6575
6964
|
* @description Returns the latest analyst ratings on a given stock or multiple stocks.
|
|
6576
6965
|
* @tags TipRank
|
|
@@ -6579,7 +6968,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6579
6968
|
* @request POST:/tipranks/analyst-multi
|
|
6580
6969
|
* @secure
|
|
6581
6970
|
*/
|
|
6582
|
-
tiprankLatestAnalystRatingsOnStock(filter: InsightLatestAnalystRatingsOnStockRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLatestAnalystRatingsOnStockResponse[], HandleError>>;
|
|
6971
|
+
tiprankLatestAnalystRatingsOnStock(filter: InsightLatestAnalystRatingsOnStockRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLatestAnalystRatingsOnStockResponse[], HandleError, Format>>;
|
|
6583
6972
|
/**
|
|
6584
6973
|
* @description Returns the latest analyst portfolio items.
|
|
6585
6974
|
* @tags TipRank
|
|
@@ -6591,7 +6980,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6591
6980
|
tiprankPortfolios(filter: InsightPortfoliosRequest, headers?: {
|
|
6592
6981
|
/** Authorization */
|
|
6593
6982
|
Authorization?: string;
|
|
6594
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPortfoliosResponse[], HandleError>>;
|
|
6983
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPortfoliosResponse[], HandleError, Format>>;
|
|
6595
6984
|
/**
|
|
6596
6985
|
* @description Returns the analyst profile information
|
|
6597
6986
|
* @tags TipRank
|
|
@@ -6603,7 +6992,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6603
6992
|
tiprankAnalystProfile(query: {
|
|
6604
6993
|
/** ID of tiprank analyst profile */
|
|
6605
6994
|
id: string;
|
|
6606
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystProfileResponse, HandleError>>;
|
|
6995
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystProfileResponse, HandleError, Format>>;
|
|
6607
6996
|
/**
|
|
6608
6997
|
* @description Returns the URL prefix to the expertPictureUrl field.
|
|
6609
6998
|
* @tags TipRank
|
|
@@ -6612,7 +7001,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6612
7001
|
* @request GET:/tipranks/analysts-expert-picture-store
|
|
6613
7002
|
* @secure
|
|
6614
7003
|
*/
|
|
6615
|
-
tiprankAnalystsExpertPictureStore(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystsExpertPictureStoreResponse, HandleError>>;
|
|
7004
|
+
tiprankAnalystsExpertPictureStore(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystsExpertPictureStoreResponse, HandleError, Format>>;
|
|
6616
7005
|
/**
|
|
6617
7006
|
* @description Returns a list of top-ranked analysts.
|
|
6618
7007
|
* @tags TipRank
|
|
@@ -6624,7 +7013,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6624
7013
|
tiprankBestPerformingExperts(query?: {
|
|
6625
7014
|
/** The number of analysts to return */
|
|
6626
7015
|
num?: number;
|
|
6627
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightBestPerformingExpertsResponse[], HandleError>>;
|
|
7016
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightBestPerformingExpertsResponse[], HandleError, Format>>;
|
|
6628
7017
|
/**
|
|
6629
7018
|
* @description Returns the blogger consensus on the stock along with the blogger opinion distribution by site.
|
|
6630
7019
|
* @tags TipRank
|
|
@@ -6636,7 +7025,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6636
7025
|
tiprankBloggerConsensusOnStock(query: {
|
|
6637
7026
|
/** The ticker of the stock */
|
|
6638
7027
|
ticker: string;
|
|
6639
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightBloggerConsensusOnStockResponse[], HandleError>>;
|
|
7028
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightBloggerConsensusOnStockResponse[], HandleError, Format>>;
|
|
6640
7029
|
/**
|
|
6641
7030
|
* @description Returns a list of the upcoming IPOs and recent IPOs that have already been priced
|
|
6642
7031
|
* @tags TipRank
|
|
@@ -6645,7 +7034,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6645
7034
|
* @request GET:/tipranks/calendars-ipos
|
|
6646
7035
|
* @secure
|
|
6647
7036
|
*/
|
|
6648
|
-
tiprankCalendarsIpos(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalendarsIPOSResponse[], HandleError>>;
|
|
7037
|
+
tiprankCalendarsIpos(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalendarsIPOSResponse[], HandleError, Format>>;
|
|
6649
7038
|
/**
|
|
6650
7039
|
* @description Returns all stocks that have been updated since a specified UTC time.
|
|
6651
7040
|
* @tags TipRank
|
|
@@ -6659,7 +7048,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6659
7048
|
utc_time?: string;
|
|
6660
7049
|
/** Level of detail on updated stocks */
|
|
6661
7050
|
details?: InsightTiprankGeneralStockUpdatesParamsDetailsEnum;
|
|
6662
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGeneralStockUpdatesResponse, HandleError>>;
|
|
7051
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGeneralStockUpdatesResponse, HandleError, Format>>;
|
|
6663
7052
|
/**
|
|
6664
7053
|
* @description Returns all hedge funds that have a position on a given stock along with the hedge fund activity trends and consensus.
|
|
6665
7054
|
* @tags TipRank
|
|
@@ -6671,7 +7060,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6671
7060
|
tiprankHedgefunds(query: {
|
|
6672
7061
|
/** The ticker of the stock */
|
|
6673
7062
|
ticker: string;
|
|
6674
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsResponse[], HandleError>>;
|
|
7063
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsResponse[], HandleError, Format>>;
|
|
6675
7064
|
/**
|
|
6676
7065
|
* @description Returns a list of top-ranked hedge fund managers.
|
|
6677
7066
|
* @tags TipRank
|
|
@@ -6683,7 +7072,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6683
7072
|
tiprankHedgefundsBestPerformingExperts(query?: {
|
|
6684
7073
|
/** The number of hedge fund managers to return */
|
|
6685
7074
|
num?: number;
|
|
6686
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsBestPerformingExpertsResponse[], HandleError>>;
|
|
7075
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsBestPerformingExpertsResponse[], HandleError, Format>>;
|
|
6687
7076
|
/**
|
|
6688
7077
|
* @description Returns the biggest 200 hedge fund transactions from the last quarter filtered based on minStars. Returns at most 50 transactions, sorted by size (biggest on top).
|
|
6689
7078
|
* @tags TipRank
|
|
@@ -6697,7 +7086,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6697
7086
|
min_stars?: number;
|
|
6698
7087
|
/** The order of the latest insider transactions */
|
|
6699
7088
|
sort?: InsightTiprankHedgefundsRecentTransactionsParamsSortEnum;
|
|
6700
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsRecentTransactionsResponse[], HandleError>>;
|
|
7089
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsRecentTransactionsResponse[], HandleError, Format>>;
|
|
6701
7090
|
/**
|
|
6702
7091
|
* @description Returns the latest insider transactions and an overall sentiment on a given stock.
|
|
6703
7092
|
* @tags TipRank
|
|
@@ -6709,7 +7098,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6709
7098
|
tiprankInsiders(query: {
|
|
6710
7099
|
/** The ticker of the stock */
|
|
6711
7100
|
ticker: string;
|
|
6712
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersResponse[], HandleError>>;
|
|
7101
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersResponse[], HandleError, Format>>;
|
|
6713
7102
|
/**
|
|
6714
7103
|
* @description Returns a list of top ranked insiders.
|
|
6715
7104
|
* @tags TipRank
|
|
@@ -6721,7 +7110,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6721
7110
|
tiprankInsidersBestPerformingExperts(query?: {
|
|
6722
7111
|
/** The number of insiders to return */
|
|
6723
7112
|
num?: number;
|
|
6724
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersBestPerformingExpertsResponse[], HandleError>>;
|
|
7113
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersBestPerformingExpertsResponse[], HandleError, Format>>;
|
|
6725
7114
|
/**
|
|
6726
7115
|
* @description Returns all the information required to build TipRanks Insider Hot Stocks.
|
|
6727
7116
|
* @tags TipRank
|
|
@@ -6730,7 +7119,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6730
7119
|
* @request GET:/tipranks/insiders-hotstocks
|
|
6731
7120
|
* @secure
|
|
6732
7121
|
*/
|
|
6733
|
-
tiprankInsidersHotstocks(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersHotstocksResponse[], HandleError>>;
|
|
7122
|
+
tiprankInsidersHotstocks(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersHotstocksResponse[], HandleError, Format>>;
|
|
6734
7123
|
/**
|
|
6735
7124
|
* @description Returns a feed of the latest insider transactions reported to the SEC.
|
|
6736
7125
|
* @tags TipRank
|
|
@@ -6744,7 +7133,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6744
7133
|
num?: number;
|
|
6745
7134
|
/** The order of the latest insider transactions */
|
|
6746
7135
|
sort?: InsightTiprankInsidersLiveFeedParamsSortEnum;
|
|
6747
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersLiveFeedResponse[], HandleError>>;
|
|
7136
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersLiveFeedResponse[], HandleError, Format>>;
|
|
6748
7137
|
/**
|
|
6749
7138
|
* @description Returns the insider profile information.
|
|
6750
7139
|
* @tags TipRank
|
|
@@ -6756,7 +7145,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6756
7145
|
tiprankInsidersOverview(query?: {
|
|
6757
7146
|
/** The UID of the expert */
|
|
6758
7147
|
expert_uid?: string;
|
|
6759
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersOverviewResponse, HandleError>>;
|
|
7148
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersOverviewResponse, HandleError, Format>>;
|
|
6760
7149
|
/**
|
|
6761
7150
|
* @description Returns the sentiment of TipRanks users on the stock.
|
|
6762
7151
|
* @tags TipRank
|
|
@@ -6768,7 +7157,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6768
7157
|
tiprankInvestorSentiment(query: {
|
|
6769
7158
|
/** The ticker of the stock */
|
|
6770
7159
|
ticker: string;
|
|
6771
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInvestorSentimentResponse, HandleError>>;
|
|
7160
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInvestorSentimentResponse, HandleError, Format>>;
|
|
6772
7161
|
/**
|
|
6773
7162
|
* @description Returns the latest analyst ratings.
|
|
6774
7163
|
* @tags TipRank
|
|
@@ -6780,7 +7169,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6780
7169
|
tiprankLiveFeed(filter: InsightLiveFeedRequest, headers?: {
|
|
6781
7170
|
/** Authorization */
|
|
6782
7171
|
Authorization?: string;
|
|
6783
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLiveFeedResponse[], HandleError>>;
|
|
7172
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLiveFeedResponse[], HandleError, Format>>;
|
|
6784
7173
|
/**
|
|
6785
7174
|
* @description Returns the latest news articles on the stock and their sentiment (bullish / neutral or bearish).
|
|
6786
7175
|
* @tags TipRank
|
|
@@ -6794,7 +7183,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6794
7183
|
ticker: string;
|
|
6795
7184
|
/** Limit to number of articles 1-200 */
|
|
6796
7185
|
num?: number;
|
|
6797
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsArticlesResponse[], HandleError>>;
|
|
7186
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsArticlesResponse[], HandleError, Format>>;
|
|
6798
7187
|
/**
|
|
6799
7188
|
* @description Returns the overall sentiment, buzz score and word cloud for the stock.
|
|
6800
7189
|
* @tags TipRank
|
|
@@ -6806,7 +7195,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6806
7195
|
tiprankNewsSentiment(query: {
|
|
6807
7196
|
/** The ticker of the stock */
|
|
6808
7197
|
ticker: string;
|
|
6809
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsSentimentResponse, HandleError>>;
|
|
7198
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsSentimentResponse, HandleError, Format>>;
|
|
6810
7199
|
/**
|
|
6811
7200
|
* @description Returns the list of sectors and for each sector the distribution of stocks by analyst consensus (Strong Buy / Moderate Buy / Neutral / Moderate Sell / Strong Sell).
|
|
6812
7201
|
* @tags TipRank
|
|
@@ -6815,7 +7204,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6815
7204
|
* @request GET:/tipranks/sector-consensus
|
|
6816
7205
|
* @secure
|
|
6817
7206
|
*/
|
|
6818
|
-
tiprankSectorConsensus(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSectorConsensusResponse, HandleError>>;
|
|
7207
|
+
tiprankSectorConsensus(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSectorConsensusResponse, HandleError, Format>>;
|
|
6819
7208
|
/**
|
|
6820
7209
|
* @description Returns the stock analysis overview: which is derived from 8 unique data sets including Analyst recommendations, Crowd Wisdom, Hedge Fund Activity, Media Sentiment, Blogger Opinions, Insider Transactions, Technical and Fundamental stock factors.
|
|
6821
7210
|
* @tags TipRank
|
|
@@ -6824,7 +7213,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6824
7213
|
* @request POST:/tipranks/smart-score
|
|
6825
7214
|
* @secure
|
|
6826
7215
|
*/
|
|
6827
|
-
tiprankSmartScore(filter: InsightSmartScoreRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScoreResponse[], HandleError>>;
|
|
7216
|
+
tiprankSmartScore(filter: InsightSmartScoreRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScoreResponse[], HandleError, Format>>;
|
|
6828
7217
|
/**
|
|
6829
7218
|
* @description Returns the historical daily and yearly performance of a portfolio that contains all the top smart score stocks (rebalanced daily) and the historical performance of S&P-500 (SPY) for benchmarking purposes.
|
|
6830
7219
|
* @tags TipRank
|
|
@@ -6833,7 +7222,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6833
7222
|
* @request GET:/tipranks/smart-score-performance
|
|
6834
7223
|
* @secure
|
|
6835
7224
|
*/
|
|
6836
|
-
tiprankSmartScorePerformance(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScorePerformanceResponse, HandleError>>;
|
|
7225
|
+
tiprankSmartScorePerformance(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScorePerformanceResponse, HandleError, Format>>;
|
|
6837
7226
|
/**
|
|
6838
7227
|
* @description Returns a list of stocks with the top Smart Score of 10.
|
|
6839
7228
|
* @tags TipRank
|
|
@@ -6842,7 +7231,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6842
7231
|
* @request POST:/tipranks/smart-score-top-stocks
|
|
6843
7232
|
* @secure
|
|
6844
7233
|
*/
|
|
6845
|
-
tiprankSmartScoreTopStocks(filter: InsightSmartScoreTopStocksRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScoreResponse[], HandleError>>;
|
|
7234
|
+
tiprankSmartScoreTopStocks(filter: InsightSmartScoreTopStocksRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScoreResponse[], HandleError, Format>>;
|
|
6846
7235
|
/**
|
|
6847
7236
|
* @description Returns a list of top-ranked analysts.
|
|
6848
7237
|
* @tags TipRank
|
|
@@ -6851,7 +7240,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6851
7240
|
* @request POST:/tipranks/stocks-consensus-over-time
|
|
6852
7241
|
* @secure
|
|
6853
7242
|
*/
|
|
6854
|
-
tiprankStocksConsensusOverTime(filter: InsightStocksConsensusOverTimeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksConsensusOverTimeResponse[], HandleError>>;
|
|
7243
|
+
tiprankStocksConsensusOverTime(filter: InsightStocksConsensusOverTimeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksConsensusOverTimeResponse[], HandleError, Format>>;
|
|
6855
7244
|
/**
|
|
6856
7245
|
* @description Returns the latest events per a specific stock, these include sell side analyst ratings, blogger opinions and corporate insider transactions
|
|
6857
7246
|
* @tags TipRank
|
|
@@ -6860,7 +7249,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6860
7249
|
* @request POST:/tipranks/stocks-events
|
|
6861
7250
|
* @secure
|
|
6862
7251
|
*/
|
|
6863
|
-
tiprankStocksEvents(filter: InsightStocksEventsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksEventsResponse[], HandleError>>;
|
|
7252
|
+
tiprankStocksEvents(filter: InsightStocksEventsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksEventsResponse[], HandleError, Format>>;
|
|
6864
7253
|
/**
|
|
6865
7254
|
* @description Returns a list of stocks similar to the given ticker.
|
|
6866
7255
|
* @tags TipRank
|
|
@@ -6872,7 +7261,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6872
7261
|
tiprankStocksSimilarStocks(query: {
|
|
6873
7262
|
/** The ticker of the stock */
|
|
6874
7263
|
ticker: string;
|
|
6875
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
7264
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError, Format>>;
|
|
6876
7265
|
/**
|
|
6877
7266
|
* @description Returns the stocks with the highest share price increase / decrease and volume. Note that the API call only returns the list of stocks that make it to the top movers list, the real time price action for these stocks should be pulled by the web page to provide the most up to date values.
|
|
6878
7267
|
* @tags TipRank
|
|
@@ -6881,7 +7270,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6881
7270
|
* @request GET:/tipranks/stocks-top-movers
|
|
6882
7271
|
* @secure
|
|
6883
7272
|
*/
|
|
6884
|
-
tiprankStocksTopMovers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksTopMoversResponse[], HandleError>>;
|
|
7273
|
+
tiprankStocksTopMovers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksTopMoversResponse[], HandleError, Format>>;
|
|
6885
7274
|
/**
|
|
6886
7275
|
* @description Returns the stock symbols covered by TipRanks.
|
|
6887
7276
|
* @tags TipRank
|
|
@@ -6890,7 +7279,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6890
7279
|
* @request GET:/tipranks/supported-tickers
|
|
6891
7280
|
* @secure
|
|
6892
7281
|
*/
|
|
6893
|
-
tiprankSupportedTickers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSupportedTickersResponse, HandleError>>;
|
|
7282
|
+
tiprankSupportedTickers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSupportedTickersResponse, HandleError, Format>>;
|
|
6894
7283
|
/**
|
|
6895
7284
|
* @description Returns a list of stocks that have the strongest consensus ratings (Strong Buy or Strong Sell) amongst top-ranked analysts (ranked 3.5 stars or higher).
|
|
6896
7285
|
* @tags TipRank
|
|
@@ -6902,7 +7291,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6902
7291
|
tiprankTopRateStocks(query?: {
|
|
6903
7292
|
/** Return the most trending X stocks */
|
|
6904
7293
|
num?: number;
|
|
6905
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopRateStocksResponse, HandleError>>;
|
|
7294
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopRateStocksResponse, HandleError, Format>>;
|
|
6906
7295
|
/**
|
|
6907
7296
|
* @description Returns the top-rated stocks by the sector of the given ticker. The API call returns top stocks by analysts, bloggers, insiders, hedge funds, news sentiment and individual investor sentiment.
|
|
6908
7297
|
* @tags TipRank
|
|
@@ -6911,7 +7300,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6911
7300
|
* @request POST:/tipranks/top-stocks-by-sectors
|
|
6912
7301
|
* @secure
|
|
6913
7302
|
*/
|
|
6914
|
-
tiprankTopStocksBySectors(filter: InsightTopStocksBySectorsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksBySectorsResponse, HandleError>>;
|
|
7303
|
+
tiprankTopStocksBySectors(filter: InsightTopStocksBySectorsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksBySectorsResponse, HandleError, Format>>;
|
|
6915
7304
|
/**
|
|
6916
7305
|
* @description Returns a list of stocks with the highest number of analyst ratings in the last 7 days.
|
|
6917
7306
|
* @tags TipRank
|
|
@@ -6923,303 +7312,233 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6923
7312
|
tiprankTrendingStocks(filter: InsightTrendingStocksRequest, headers?: {
|
|
6924
7313
|
/** Authorization */
|
|
6925
7314
|
Authorization?: string;
|
|
6926
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
|
|
6927
|
-
}
|
|
6928
|
-
export enum InsightOrderDirectionV2 {
|
|
6929
|
-
OrderASC = "asc",
|
|
6930
|
-
OrderDESC = "desc"
|
|
6931
|
-
}
|
|
6932
|
-
export interface InsightBeforeAndAfterV2 {
|
|
6933
|
-
after?: string;
|
|
6934
|
-
before?: string;
|
|
6935
|
-
}
|
|
6936
|
-
export interface InsightFixedIncomeV2 {
|
|
6937
|
-
a144: boolean;
|
|
6938
|
-
accrued_interest: number;
|
|
6939
|
-
bank_qualified: boolean;
|
|
6940
|
-
bond_warrant: boolean;
|
|
6941
|
-
call_type: string;
|
|
6942
|
-
callable: boolean;
|
|
6943
|
-
close_price: number;
|
|
6944
|
-
close_price_asof: string;
|
|
6945
|
-
close_ytw: number;
|
|
6946
|
-
convertible: boolean;
|
|
6947
|
-
country: string;
|
|
6948
|
-
country_code: string;
|
|
6949
|
-
country_domicile: string;
|
|
6950
|
-
country_issue: string;
|
|
6951
|
-
coupon: number;
|
|
6952
|
-
coupon_frequency: string;
|
|
6953
|
-
coupon_type: string;
|
|
6954
|
-
currency: string;
|
|
6955
|
-
cusip: string;
|
|
6956
|
-
dated_date: string;
|
|
6957
|
-
daycount: string;
|
|
6958
|
-
description: string;
|
|
6959
|
-
description_short: string;
|
|
6960
|
-
duration: number;
|
|
6961
|
-
first_coupon_date: string;
|
|
6962
|
-
insured: boolean;
|
|
6963
|
-
isin: string;
|
|
6964
|
-
issue_date: string;
|
|
6965
|
-
issue_minimum_denomination: number;
|
|
6966
|
-
issue_price: number;
|
|
6967
|
-
issue_size: number;
|
|
6968
|
-
issuer: string;
|
|
6969
|
-
last_coupon_date: string;
|
|
6970
|
-
liquidity_institutional_aggregate: number;
|
|
6971
|
-
liquidity_institutional_buy: number;
|
|
6972
|
-
liquidity_institutional_sell: number;
|
|
6973
|
-
liquidity_micro_aggregate: number;
|
|
6974
|
-
liquidity_micro_buy: number;
|
|
6975
|
-
liquidity_micro_sell: number;
|
|
6976
|
-
liquidity_retail_aggregate: number;
|
|
6977
|
-
liquidity_retail_buy: number;
|
|
6978
|
-
liquidity_retail_sell: number;
|
|
6979
|
-
maturity_date: string;
|
|
6980
|
-
municipal_state: string;
|
|
6981
|
-
municipal_taxable_federal: boolean;
|
|
6982
|
-
municipal_type: string;
|
|
6983
|
-
next_call_date: string;
|
|
6984
|
-
next_call_price: number;
|
|
6985
|
-
next_coupon_date: string;
|
|
6986
|
-
par_value: number;
|
|
6987
|
-
perpetual: boolean;
|
|
6988
|
-
private_placement: boolean;
|
|
6989
|
-
purpose: string;
|
|
6990
|
-
puttable: boolean;
|
|
6991
|
-
reg_s: boolean;
|
|
6992
|
-
sector: string;
|
|
6993
|
-
seniority: string;
|
|
6994
|
-
settlement_convention: string;
|
|
6995
|
-
sinking_fund: boolean;
|
|
6996
|
-
sp_creditwatch: string;
|
|
6997
|
-
sp_creditwatch_date: string;
|
|
6998
|
-
sp_outlook: string;
|
|
6999
|
-
sp_outlook_date: string;
|
|
7000
|
-
sp_rating: string;
|
|
7001
|
-
sp_rating_date: string;
|
|
7002
|
-
status: string;
|
|
7003
|
-
ticker: string;
|
|
7004
|
-
treasury_subtype: string;
|
|
7005
|
-
type: string;
|
|
7006
|
-
updated_at: string;
|
|
7315
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError, Format>>;
|
|
7007
7316
|
}
|
|
7008
|
-
export
|
|
7009
|
-
|
|
7010
|
-
|
|
7317
|
+
export class UsageTracking<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
7318
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
7319
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
7320
|
+
/**
|
|
7321
|
+
* @description get usage date per branch for a period
|
|
7322
|
+
* @tags UsageTracking
|
|
7323
|
+
* @name GetUsageData
|
|
7324
|
+
* @summary get insight usage data
|
|
7325
|
+
* @request POST:/tracking/usage
|
|
7326
|
+
* @secure
|
|
7327
|
+
*/
|
|
7328
|
+
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError, Format>>;
|
|
7011
7329
|
}
|
|
7012
|
-
export
|
|
7013
|
-
|
|
7014
|
-
|
|
7015
|
-
/**
|
|
7016
|
-
|
|
7017
|
-
|
|
7018
|
-
|
|
7019
|
-
|
|
7020
|
-
|
|
7021
|
-
|
|
7022
|
-
|
|
7023
|
-
|
|
7024
|
-
|
|
7025
|
-
|
|
7330
|
+
export class WorldMarkets<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
7331
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
7332
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
7333
|
+
/**
|
|
7334
|
+
* @description Get continents
|
|
7335
|
+
* @tags World Markets
|
|
7336
|
+
* @name ContinentGet
|
|
7337
|
+
* @summary Get continents
|
|
7338
|
+
* @request GET:/continents
|
|
7339
|
+
* @secure
|
|
7340
|
+
*/
|
|
7341
|
+
continentGet(query: {
|
|
7342
|
+
/** Query limit */
|
|
7343
|
+
limit: number;
|
|
7344
|
+
/** Query offset */
|
|
7345
|
+
offset: number;
|
|
7346
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError, Format>>;
|
|
7347
|
+
/**
|
|
7348
|
+
* @description Edit continent
|
|
7349
|
+
* @tags World Markets
|
|
7350
|
+
* @name ContinentEdit
|
|
7351
|
+
* @summary Edit continent
|
|
7352
|
+
* @request PUT:/continents
|
|
7353
|
+
* @secure
|
|
7354
|
+
*/
|
|
7355
|
+
continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
7026
7356
|
/**
|
|
7027
|
-
* @
|
|
7028
|
-
* @
|
|
7357
|
+
* @description Create continents
|
|
7358
|
+
* @tags World Markets
|
|
7359
|
+
* @name ContinentCreate
|
|
7360
|
+
* @summary Create continents
|
|
7361
|
+
* @request POST:/continents
|
|
7362
|
+
* @secure
|
|
7029
7363
|
*/
|
|
7030
|
-
|
|
7031
|
-
/** @example true */
|
|
7032
|
-
has_ticker?: boolean;
|
|
7033
|
-
/** @example true */
|
|
7034
|
-
insured?: boolean;
|
|
7035
|
-
/** @example ["US655664AH33","US9128286R69"] */
|
|
7036
|
-
isin?: string[];
|
|
7037
|
-
issue_date?: InsightBeforeAndAfterV2;
|
|
7364
|
+
continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError, Format>>;
|
|
7038
7365
|
/**
|
|
7039
|
-
* @
|
|
7040
|
-
* @
|
|
7366
|
+
* @description Delete continent
|
|
7367
|
+
* @tags World Markets
|
|
7368
|
+
* @name ContinentDelete
|
|
7369
|
+
* @summary Delete continent
|
|
7370
|
+
* @request DELETE:/continents
|
|
7371
|
+
* @secure
|
|
7041
7372
|
*/
|
|
7042
|
-
|
|
7043
|
-
|
|
7044
|
-
|
|
7045
|
-
|
|
7046
|
-
/** @example true */
|
|
7047
|
-
municipal_tax?: boolean;
|
|
7048
|
-
/** @example ["general_obligation"] */
|
|
7049
|
-
municipal_types?: string[];
|
|
7050
|
-
pagination: InsightPaginationV2;
|
|
7051
|
-
purposes?: string[];
|
|
7052
|
-
/** @example ["SOVEREIGN"] */
|
|
7053
|
-
sectors?: string[];
|
|
7054
|
-
sorts?: InsightOrderingV2[];
|
|
7055
|
-
/** @example ["AAA"] */
|
|
7056
|
-
sp_ratings?: string[];
|
|
7057
|
-
/** @example ["called","outstanding"] */
|
|
7058
|
-
statuses?: string[];
|
|
7059
|
-
tickers?: string[];
|
|
7060
|
-
/** @example ["corporate"] */
|
|
7061
|
-
types?: string[];
|
|
7062
|
-
}
|
|
7063
|
-
export interface InsightGetTopSymbolsRequestV2 {
|
|
7064
|
-
exchange?: string[];
|
|
7065
|
-
market_cap?: InsightLessAndMoreV2;
|
|
7066
|
-
pagination?: InsightPaginationV2;
|
|
7067
|
-
price?: InsightLessAndMoreV2;
|
|
7068
|
-
sorts?: InsightOrderingV2[];
|
|
7069
|
-
volume?: InsightLessAndMoreV2;
|
|
7070
|
-
}
|
|
7071
|
-
export interface InsightIncludeExcludeV2 {
|
|
7072
|
-
exclude?: string[];
|
|
7073
|
-
include?: string[];
|
|
7074
|
-
}
|
|
7075
|
-
export interface InsightLessAndMoreV2 {
|
|
7076
|
-
less_than?: number;
|
|
7077
|
-
more_than?: number;
|
|
7078
|
-
}
|
|
7079
|
-
export interface InsightOrderingV2 {
|
|
7373
|
+
continentDelete(query: {
|
|
7374
|
+
/** continent id */
|
|
7375
|
+
id: string;
|
|
7376
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
7080
7377
|
/**
|
|
7081
|
-
* @
|
|
7082
|
-
* @
|
|
7378
|
+
* @description Get country codes
|
|
7379
|
+
* @tags World Markets
|
|
7380
|
+
* @name CountryCodeGet
|
|
7381
|
+
* @summary Get country codes
|
|
7382
|
+
* @request GET:/country-codes
|
|
7383
|
+
* @secure
|
|
7083
7384
|
*/
|
|
7084
|
-
|
|
7385
|
+
countryCodeGet(query: {
|
|
7386
|
+
/** Query limit */
|
|
7387
|
+
limit: number;
|
|
7388
|
+
/** Query offset */
|
|
7389
|
+
offset: number;
|
|
7390
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError, Format>>;
|
|
7085
7391
|
/**
|
|
7086
|
-
*
|
|
7087
|
-
*
|
|
7088
|
-
*
|
|
7089
|
-
* @
|
|
7392
|
+
* @description Edit country code
|
|
7393
|
+
* @tags World Markets
|
|
7394
|
+
* @name CountryCodeEdit
|
|
7395
|
+
* @summary Edit country code
|
|
7396
|
+
* @request PUT:/country-codes
|
|
7397
|
+
* @secure
|
|
7090
7398
|
*/
|
|
7091
|
-
|
|
7092
|
-
}
|
|
7093
|
-
export interface InsightPaginationV2 {
|
|
7399
|
+
countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
7094
7400
|
/**
|
|
7095
|
-
* @
|
|
7096
|
-
* @
|
|
7401
|
+
* @description Add country codes
|
|
7402
|
+
* @tags World Markets
|
|
7403
|
+
* @name CountryCodeAdd
|
|
7404
|
+
* @summary Add country codes
|
|
7405
|
+
* @request POST:/country-codes
|
|
7406
|
+
* @secure
|
|
7097
7407
|
*/
|
|
7098
|
-
|
|
7408
|
+
countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError, Format>>;
|
|
7099
7409
|
/**
|
|
7100
|
-
* @
|
|
7101
|
-
* @
|
|
7102
|
-
* @
|
|
7410
|
+
* @description Delete country code
|
|
7411
|
+
* @tags World Markets
|
|
7412
|
+
* @name CountryCodeDelete
|
|
7413
|
+
* @summary Delete country code
|
|
7414
|
+
* @request DELETE:/country-codes
|
|
7415
|
+
* @secure
|
|
7103
7416
|
*/
|
|
7104
|
-
|
|
7105
|
-
|
|
7106
|
-
|
|
7107
|
-
|
|
7108
|
-
company_name: string;
|
|
7109
|
-
dividend_ex_date: string;
|
|
7110
|
-
dividend_pay_date: string;
|
|
7111
|
-
dividend_percent: number;
|
|
7112
|
-
exchange: string;
|
|
7113
|
-
exchange_name: string;
|
|
7114
|
-
gap: number;
|
|
7115
|
-
industry: string;
|
|
7116
|
-
industry_code: string;
|
|
7117
|
-
last_price: number;
|
|
7118
|
-
market_cap: number;
|
|
7119
|
-
pe_ratio: number;
|
|
7120
|
-
price_change: number;
|
|
7121
|
-
price_change_percent: number;
|
|
7122
|
-
symbol: string;
|
|
7123
|
-
volume: number;
|
|
7124
|
-
}
|
|
7125
|
-
export interface InsightStockScreenerRequestV2 {
|
|
7126
|
-
average_volume_30d?: InsightLessAndMoreV2;
|
|
7127
|
-
dividend_ex_date?: InsightBeforeAndAfterV2;
|
|
7128
|
-
dividend_pay_date?: InsightBeforeAndAfterV2;
|
|
7129
|
-
dividend_percent?: InsightLessAndMoreV2;
|
|
7130
|
-
exchange?: InsightIncludeExcludeV2;
|
|
7131
|
-
gap?: InsightLessAndMoreV2;
|
|
7132
|
-
industry?: InsightIncludeExcludeV2;
|
|
7133
|
-
market_cap?: InsightLessAndMoreV2;
|
|
7134
|
-
pagination: InsightPaginationV2;
|
|
7135
|
-
pe_ratio?: InsightLessAndMoreV2;
|
|
7136
|
-
price?: InsightLessAndMoreV2;
|
|
7137
|
-
price_change_percent?: 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>);
|
|
7417
|
+
countryCodeDelete(query: {
|
|
7418
|
+
/** a3 code */
|
|
7419
|
+
a3code: string;
|
|
7420
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
7161
7421
|
/**
|
|
7162
|
-
* @description
|
|
7163
|
-
* @tags
|
|
7164
|
-
* @name
|
|
7165
|
-
* @summary
|
|
7166
|
-
* @request
|
|
7422
|
+
* @description Get global indexes
|
|
7423
|
+
* @tags World Markets
|
|
7424
|
+
* @name GlobalIndexGet
|
|
7425
|
+
* @summary Get global indexes
|
|
7426
|
+
* @request GET:/global-indexes
|
|
7167
7427
|
* @secure
|
|
7168
7428
|
*/
|
|
7169
|
-
|
|
7170
|
-
|
|
7171
|
-
|
|
7172
|
-
|
|
7173
|
-
|
|
7429
|
+
globalIndexGet(query: {
|
|
7430
|
+
/** Query limit */
|
|
7431
|
+
limit: number;
|
|
7432
|
+
/** Query offset */
|
|
7433
|
+
offset: number;
|
|
7434
|
+
/** Continent code for filtering */
|
|
7435
|
+
continent?: string;
|
|
7436
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError, Format>>;
|
|
7174
7437
|
/**
|
|
7175
|
-
* @description
|
|
7176
|
-
* @tags
|
|
7177
|
-
* @name
|
|
7178
|
-
* @summary
|
|
7179
|
-
* @request
|
|
7438
|
+
* @description Edit global index
|
|
7439
|
+
* @tags World Markets
|
|
7440
|
+
* @name GlobalIndexEdit
|
|
7441
|
+
* @summary Edit global index
|
|
7442
|
+
* @request PUT:/global-indexes
|
|
7180
7443
|
* @secure
|
|
7181
7444
|
*/
|
|
7182
|
-
|
|
7445
|
+
globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
7183
7446
|
/**
|
|
7184
|
-
* @description
|
|
7185
|
-
* @tags
|
|
7186
|
-
* @name
|
|
7187
|
-
* @summary
|
|
7188
|
-
* @request POST:/
|
|
7447
|
+
* @description Add global indexes
|
|
7448
|
+
* @tags World Markets
|
|
7449
|
+
* @name GlobalIndexAdd
|
|
7450
|
+
* @summary Add global indexes
|
|
7451
|
+
* @request POST:/global-indexes
|
|
7452
|
+
* @secure
|
|
7453
|
+
*/
|
|
7454
|
+
globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError, Format>>;
|
|
7455
|
+
/**
|
|
7456
|
+
* @description Edit global index
|
|
7457
|
+
* @tags World Markets
|
|
7458
|
+
* @name GlobalIndexDelete
|
|
7459
|
+
* @summary Delete global index
|
|
7460
|
+
* @request DELETE:/global-indexes
|
|
7461
|
+
* @secure
|
|
7462
|
+
*/
|
|
7463
|
+
globalIndexDelete(query: {
|
|
7464
|
+
/** a3 code */
|
|
7465
|
+
a3code: string;
|
|
7466
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
7467
|
+
/**
|
|
7468
|
+
* @description Get regions
|
|
7469
|
+
* @tags World Markets
|
|
7470
|
+
* @name RegionGet
|
|
7471
|
+
* @summary Get regions
|
|
7472
|
+
* @request GET:/regions
|
|
7189
7473
|
* @secure
|
|
7190
7474
|
*/
|
|
7191
|
-
|
|
7192
|
-
|
|
7193
|
-
|
|
7194
|
-
|
|
7195
|
-
|
|
7196
|
-
|
|
7197
|
-
|
|
7198
|
-
|
|
7199
|
-
|
|
7200
|
-
|
|
7201
|
-
|
|
7202
|
-
|
|
7203
|
-
|
|
7204
|
-
|
|
7205
|
-
|
|
7206
|
-
|
|
7207
|
-
|
|
7208
|
-
|
|
7209
|
-
|
|
7210
|
-
|
|
7211
|
-
|
|
7212
|
-
|
|
7213
|
-
|
|
7214
|
-
|
|
7215
|
-
|
|
7216
|
-
|
|
7217
|
-
|
|
7475
|
+
regionGet(query: {
|
|
7476
|
+
/** Query limit */
|
|
7477
|
+
limit: number;
|
|
7478
|
+
/** Query offset */
|
|
7479
|
+
offset: number;
|
|
7480
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError, Format>>;
|
|
7481
|
+
/**
|
|
7482
|
+
* @description Edit region
|
|
7483
|
+
* @tags World Markets
|
|
7484
|
+
* @name RegionEdit
|
|
7485
|
+
* @summary Edit region
|
|
7486
|
+
* @request PUT:/regions
|
|
7487
|
+
* @secure
|
|
7488
|
+
*/
|
|
7489
|
+
regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
7490
|
+
/**
|
|
7491
|
+
* @description Create regions
|
|
7492
|
+
* @tags World Markets
|
|
7493
|
+
* @name RegionCreate
|
|
7494
|
+
* @summary Create regions
|
|
7495
|
+
* @request POST:/regions
|
|
7496
|
+
* @secure
|
|
7497
|
+
*/
|
|
7498
|
+
regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError, Format>>;
|
|
7499
|
+
/**
|
|
7500
|
+
* @description Delete region
|
|
7501
|
+
* @tags World Markets
|
|
7502
|
+
* @name RegionDelete
|
|
7503
|
+
* @summary Delete region
|
|
7504
|
+
* @request DELETE:/regions
|
|
7505
|
+
* @secure
|
|
7506
|
+
*/
|
|
7507
|
+
regionDelete(query: {
|
|
7508
|
+
/** region id */
|
|
7509
|
+
id: string;
|
|
7510
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
7511
|
+
}
|
|
7512
|
+
export class InsightApi<HandleError extends boolean = false, Format extends CaseFormat = CaseFormat.Original> extends BaseApi<HandleError, Format, JwtClient<HandleError, Format>> {
|
|
7513
|
+
readonly config: JwtClientConfig<HandleError, Format>;
|
|
7514
|
+
alphaTools: AlphaTools<HandleError, Format>;
|
|
7515
|
+
companyProfile: CompanyProfile<HandleError, Format>;
|
|
7516
|
+
customList: CustomLists<HandleError, Format>;
|
|
7517
|
+
dashboard: Dashboard<HandleError, Format>;
|
|
7518
|
+
earning: Earnings<HandleError, Format>;
|
|
7519
|
+
fixedIncome: FixedIncome<HandleError, Format>;
|
|
7520
|
+
fund: Funds<HandleError, Format>;
|
|
7521
|
+
fundamentals: Fundamentals<HandleError, Format>;
|
|
7522
|
+
intraday: Intraday<HandleError, Format>;
|
|
7523
|
+
ipos: Ipos<HandleError, Format>;
|
|
7524
|
+
logos: Logos<HandleError, Format>;
|
|
7525
|
+
marketDates: MarketDates<HandleError, Format>;
|
|
7526
|
+
news: News<HandleError, Format>;
|
|
7527
|
+
optionGreeks: OptionGreeks<HandleError, Format>;
|
|
7528
|
+
ownerships: Ownerships<HandleError, Format>;
|
|
7529
|
+
passport: Passport<HandleError, Format>;
|
|
7530
|
+
preIpoCompanies: PreIpoCompanies<HandleError, Format>;
|
|
7531
|
+
public: Public<HandleError, Format>;
|
|
7532
|
+
quotes: Quotes<HandleError, Format>;
|
|
7533
|
+
stockScreener: StockScreener<HandleError, Format>;
|
|
7534
|
+
tiprank: TipRank<HandleError, Format>;
|
|
7535
|
+
usageTracking: UsageTracking<HandleError, Format>;
|
|
7536
|
+
worldMarkets: WorldMarkets<HandleError, Format>;
|
|
7218
7537
|
v2: {
|
|
7219
|
-
fixedIncome: FixedIncomeV2<HandleError>;
|
|
7220
|
-
stockScreener: StockScreenerV2<HandleError>;
|
|
7538
|
+
fixedIncome: FixedIncomeV2<HandleError, Format>;
|
|
7539
|
+
stockScreener: StockScreenerV2<HandleError, Format>;
|
|
7221
7540
|
};
|
|
7222
|
-
constructor(config: JwtClientConfig<HandleError>);
|
|
7541
|
+
constructor(config: JwtClientConfig<HandleError, Format>);
|
|
7223
7542
|
}
|
|
7224
7543
|
|
|
7225
7544
|
//# sourceMappingURL=index.d.ts.map
|