@orbis-systems/orbis-api-clients 0.8.10 → 1.0.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 +6313 -6056
- 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 +1601 -1290
- 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 +250 -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 +4118 -4085
- 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 +863 -839
- 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 +146 -146
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>;
|
|
@@ -633,6 +651,19 @@ export interface InsightCreateCustomIndexRequest {
|
|
|
633
651
|
*/
|
|
634
652
|
private_name: string;
|
|
635
653
|
}
|
|
654
|
+
export interface InsightCreateFeaturedArticleConfigRequest {
|
|
655
|
+
/** @example ["web","mobile"] */
|
|
656
|
+
channels?: string[];
|
|
657
|
+
/** @example true */
|
|
658
|
+
enabled?: boolean;
|
|
659
|
+
/** @example ["politics","sports"] */
|
|
660
|
+
excluded_tags?: string[];
|
|
661
|
+
/** @example ["high","medium","low"] */
|
|
662
|
+
importance?: string[];
|
|
663
|
+
/** @example ["finance","technology"] */
|
|
664
|
+
required_tags?: string[];
|
|
665
|
+
schedule?: InsightFeaturedArticleSchedule;
|
|
666
|
+
}
|
|
636
667
|
export interface InsightCreateFeaturedArticlesRequest {
|
|
637
668
|
/** @example "https://example.com/image.jpg" */
|
|
638
669
|
image: string;
|
|
@@ -901,6 +932,17 @@ export interface InsightFeaturedArticle {
|
|
|
901
932
|
title: string;
|
|
902
933
|
updated: string;
|
|
903
934
|
}
|
|
935
|
+
export interface InsightFeaturedArticleConfig {
|
|
936
|
+
created: string;
|
|
937
|
+
payload: Record<string, any>;
|
|
938
|
+
updated: string;
|
|
939
|
+
}
|
|
940
|
+
export interface InsightFeaturedArticleSchedule {
|
|
941
|
+
/** @example "1h" */
|
|
942
|
+
recurrence: string;
|
|
943
|
+
/** @example "2024-01-01T00:00:00Z" */
|
|
944
|
+
start_time: string;
|
|
945
|
+
}
|
|
904
946
|
export interface InsightFilterCustomIndexesRequest {
|
|
905
947
|
paging: InsightPaging;
|
|
906
948
|
symbols?: string[];
|
|
@@ -989,6 +1031,74 @@ export interface InsightFixedIncome {
|
|
|
989
1031
|
type: string;
|
|
990
1032
|
updated_at: string;
|
|
991
1033
|
}
|
|
1034
|
+
export interface InsightFund {
|
|
1035
|
+
actively_managed: boolean;
|
|
1036
|
+
as_of_date: string;
|
|
1037
|
+
asset: string;
|
|
1038
|
+
average_calendar_month_daily_volume: number;
|
|
1039
|
+
category: string;
|
|
1040
|
+
currency: string;
|
|
1041
|
+
cusip: string;
|
|
1042
|
+
expense_ratio: number;
|
|
1043
|
+
fund_net_assets: number;
|
|
1044
|
+
fund_type: string;
|
|
1045
|
+
inception_date: string;
|
|
1046
|
+
indexing_approach: {
|
|
1047
|
+
census_replication: boolean;
|
|
1048
|
+
derivative_based: boolean;
|
|
1049
|
+
not_applicable: boolean;
|
|
1050
|
+
physical_full: boolean;
|
|
1051
|
+
physical_sample: boolean;
|
|
1052
|
+
stratified_sampling: boolean;
|
|
1053
|
+
structured: boolean;
|
|
1054
|
+
synthetic_replication: boolean;
|
|
1055
|
+
};
|
|
1056
|
+
inverse: boolean;
|
|
1057
|
+
isin: string;
|
|
1058
|
+
leverage: boolean;
|
|
1059
|
+
leverage_ratio: number;
|
|
1060
|
+
month_end_nav: number;
|
|
1061
|
+
name: string;
|
|
1062
|
+
number_of_bond_holding_long: number;
|
|
1063
|
+
number_of_bond_holding_net: number;
|
|
1064
|
+
number_of_holding_long: number;
|
|
1065
|
+
number_of_holding_net: number;
|
|
1066
|
+
number_of_stock_holding_long: number;
|
|
1067
|
+
number_of_stock_holding_net: number;
|
|
1068
|
+
performance: {
|
|
1069
|
+
inception_nav: number;
|
|
1070
|
+
trailing_return_y1: number;
|
|
1071
|
+
trailing_return_y10: number;
|
|
1072
|
+
trailing_return_y3: number;
|
|
1073
|
+
trailing_return_y5: number;
|
|
1074
|
+
trailing_return_ytd: number;
|
|
1075
|
+
};
|
|
1076
|
+
premium_discount: {
|
|
1077
|
+
as_of_date: string;
|
|
1078
|
+
m1_average: number;
|
|
1079
|
+
since_inception_average: number;
|
|
1080
|
+
since_inception_high: number;
|
|
1081
|
+
since_inception_low: number;
|
|
1082
|
+
y1_average: number;
|
|
1083
|
+
y1_high: number;
|
|
1084
|
+
y1_low: number;
|
|
1085
|
+
};
|
|
1086
|
+
primary_benchmark: string;
|
|
1087
|
+
primary_exchange_mic: string;
|
|
1088
|
+
primary_exchange_name: string;
|
|
1089
|
+
prospective_dividend_yield_long: number;
|
|
1090
|
+
provider_company: string;
|
|
1091
|
+
rating_overall: number;
|
|
1092
|
+
risk: {
|
|
1093
|
+
primary_index_beta_y1: number;
|
|
1094
|
+
risk_rating_overall: number;
|
|
1095
|
+
risk_score_overall: number;
|
|
1096
|
+
sharpe_ratio_y3: number;
|
|
1097
|
+
standard_deviation_y3: number;
|
|
1098
|
+
};
|
|
1099
|
+
symbol: string;
|
|
1100
|
+
total_market_value_long: number;
|
|
1101
|
+
}
|
|
992
1102
|
export interface InsightFundFilterAsset {
|
|
993
1103
|
asset_id?: string;
|
|
994
1104
|
asset_name?: string;
|
|
@@ -1073,6 +1183,82 @@ export interface InsightFundSectorScreenerRequest {
|
|
|
1073
1183
|
sector_code?: string;
|
|
1074
1184
|
sponsors?: string[];
|
|
1075
1185
|
}
|
|
1186
|
+
export interface InsightFundWithDetails {
|
|
1187
|
+
actively_managed: boolean;
|
|
1188
|
+
as_of_date: string;
|
|
1189
|
+
asset: string;
|
|
1190
|
+
asset_allocations: InsightAssetAllocationBreakdown[];
|
|
1191
|
+
average_calendar_month_daily_volume: number;
|
|
1192
|
+
category: string;
|
|
1193
|
+
continents: InsightContinentBreakdown[];
|
|
1194
|
+
countries: InsightCountryBreakdown[];
|
|
1195
|
+
coupon_breakdown: InsightCouponBreakdown[];
|
|
1196
|
+
currency: string;
|
|
1197
|
+
cusip: string;
|
|
1198
|
+
expense_ratio: number;
|
|
1199
|
+
fund_net_assets: number;
|
|
1200
|
+
fund_type: string;
|
|
1201
|
+
holdings: InsightHoldingBreakdown[];
|
|
1202
|
+
inception_date: string;
|
|
1203
|
+
indexing_approach: {
|
|
1204
|
+
census_replication: boolean;
|
|
1205
|
+
derivative_based: boolean;
|
|
1206
|
+
not_applicable: boolean;
|
|
1207
|
+
physical_full: boolean;
|
|
1208
|
+
physical_sample: boolean;
|
|
1209
|
+
stratified_sampling: boolean;
|
|
1210
|
+
structured: boolean;
|
|
1211
|
+
synthetic_replication: boolean;
|
|
1212
|
+
};
|
|
1213
|
+
inverse: boolean;
|
|
1214
|
+
isin: string;
|
|
1215
|
+
leverage: boolean;
|
|
1216
|
+
leverage_ratio: number;
|
|
1217
|
+
market_caps: InsightMarketCapBreakdown[];
|
|
1218
|
+
maturities: InsightMaturityBreakdown[];
|
|
1219
|
+
month_end_nav: number;
|
|
1220
|
+
name: string;
|
|
1221
|
+
number_of_bond_holding_long: number;
|
|
1222
|
+
number_of_bond_holding_net: number;
|
|
1223
|
+
number_of_holding_long: number;
|
|
1224
|
+
number_of_holding_net: number;
|
|
1225
|
+
number_of_stock_holding_long: number;
|
|
1226
|
+
number_of_stock_holding_net: number;
|
|
1227
|
+
performance: {
|
|
1228
|
+
inception_nav: number;
|
|
1229
|
+
trailing_return_y1: number;
|
|
1230
|
+
trailing_return_y10: number;
|
|
1231
|
+
trailing_return_y3: number;
|
|
1232
|
+
trailing_return_y5: number;
|
|
1233
|
+
trailing_return_ytd: number;
|
|
1234
|
+
};
|
|
1235
|
+
premium_discount: {
|
|
1236
|
+
as_of_date: string;
|
|
1237
|
+
m1_average: number;
|
|
1238
|
+
since_inception_average: number;
|
|
1239
|
+
since_inception_high: number;
|
|
1240
|
+
since_inception_low: number;
|
|
1241
|
+
y1_average: number;
|
|
1242
|
+
y1_high: number;
|
|
1243
|
+
y1_low: number;
|
|
1244
|
+
};
|
|
1245
|
+
primary_benchmark: string;
|
|
1246
|
+
primary_exchange_mic: string;
|
|
1247
|
+
primary_exchange_name: string;
|
|
1248
|
+
prospective_dividend_yield_long: number;
|
|
1249
|
+
provider_company: string;
|
|
1250
|
+
rating_overall: number;
|
|
1251
|
+
risk: {
|
|
1252
|
+
primary_index_beta_y1: number;
|
|
1253
|
+
risk_rating_overall: number;
|
|
1254
|
+
risk_score_overall: number;
|
|
1255
|
+
sharpe_ratio_y3: number;
|
|
1256
|
+
standard_deviation_y3: number;
|
|
1257
|
+
};
|
|
1258
|
+
sectors: InsightSectorBreakdown[];
|
|
1259
|
+
symbol: string;
|
|
1260
|
+
total_market_value_long: number;
|
|
1261
|
+
}
|
|
1076
1262
|
export interface InsightFutureIPO {
|
|
1077
1263
|
currency: string;
|
|
1078
1264
|
market: string;
|
|
@@ -1595,7 +1781,7 @@ export interface InsightGetScreenerPresetsResponse {
|
|
|
1595
1781
|
}
|
|
1596
1782
|
export interface InsightGetSymbolFundamentalsAnnualResponse {
|
|
1597
1783
|
balance_sheet: {
|
|
1598
|
-
|
|
1784
|
+
'2021': {
|
|
1599
1785
|
accounts_payable?: number;
|
|
1600
1786
|
accounts_receivable?: number;
|
|
1601
1787
|
accumulated_depreciation?: number;
|
|
@@ -1661,7 +1847,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
|
|
|
1661
1847
|
tradeand_other_payables_non_current?: number;
|
|
1662
1848
|
working_capital?: number;
|
|
1663
1849
|
};
|
|
1664
|
-
|
|
1850
|
+
'2022': {
|
|
1665
1851
|
accounts_payable?: number;
|
|
1666
1852
|
accounts_receivable?: number;
|
|
1667
1853
|
accumulated_depreciation?: number;
|
|
@@ -1731,7 +1917,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
|
|
|
1731
1917
|
tradeand_other_payables_non_current?: number;
|
|
1732
1918
|
working_capital?: number;
|
|
1733
1919
|
};
|
|
1734
|
-
|
|
1920
|
+
'2023': {
|
|
1735
1921
|
accounts_payable?: number;
|
|
1736
1922
|
accounts_receivable?: number;
|
|
1737
1923
|
accumulated_depreciation?: number;
|
|
@@ -1802,7 +1988,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
|
|
|
1802
1988
|
treasury_shares_number?: number;
|
|
1803
1989
|
working_capital?: number;
|
|
1804
1990
|
};
|
|
1805
|
-
|
|
1991
|
+
'2024': {
|
|
1806
1992
|
accounts_payable?: number;
|
|
1807
1993
|
accounts_receivable?: number;
|
|
1808
1994
|
accumulated_depreciation?: number;
|
|
@@ -1870,7 +2056,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
|
|
|
1870
2056
|
currency: string;
|
|
1871
2057
|
};
|
|
1872
2058
|
cash_flow: {
|
|
1873
|
-
|
|
2059
|
+
'2021': {
|
|
1874
2060
|
beginning_cash_position?: number;
|
|
1875
2061
|
capital_expenditure?: number;
|
|
1876
2062
|
cash_dividends_paid?: number;
|
|
@@ -1918,7 +2104,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
|
|
|
1918
2104
|
sale_of_investment?: number;
|
|
1919
2105
|
stock_based_compensation?: number;
|
|
1920
2106
|
};
|
|
1921
|
-
|
|
2107
|
+
'2022': {
|
|
1922
2108
|
beginning_cash_position?: number;
|
|
1923
2109
|
capital_expenditure?: number;
|
|
1924
2110
|
cash_dividends_paid?: number;
|
|
@@ -1966,7 +2152,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
|
|
|
1966
2152
|
short_term_debt_issuance?: number;
|
|
1967
2153
|
stock_based_compensation?: number;
|
|
1968
2154
|
};
|
|
1969
|
-
|
|
2155
|
+
'2023': {
|
|
1970
2156
|
beginning_cash_position?: number;
|
|
1971
2157
|
capital_expenditure?: number;
|
|
1972
2158
|
cash_dividends_paid?: number;
|
|
@@ -2008,7 +2194,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
|
|
|
2008
2194
|
sale_of_investment?: number;
|
|
2009
2195
|
stock_based_compensation?: number;
|
|
2010
2196
|
};
|
|
2011
|
-
|
|
2197
|
+
'2024': {
|
|
2012
2198
|
beginning_cash_position?: number;
|
|
2013
2199
|
capital_expenditure?: number;
|
|
2014
2200
|
cash_dividends_paid?: number;
|
|
@@ -2053,7 +2239,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
|
|
|
2053
2239
|
currency: string;
|
|
2054
2240
|
};
|
|
2055
2241
|
income_statement: {
|
|
2056
|
-
|
|
2242
|
+
'2021': {
|
|
2057
2243
|
cost_of_revenue?: number;
|
|
2058
2244
|
diluted_ni_availto_com_stockholders?: number;
|
|
2059
2245
|
ebit?: number;
|
|
@@ -2089,7 +2275,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
|
|
|
2089
2275
|
total_expenses?: number;
|
|
2090
2276
|
total_revenue?: number;
|
|
2091
2277
|
};
|
|
2092
|
-
|
|
2278
|
+
'2022': {
|
|
2093
2279
|
cost_of_revenue?: number;
|
|
2094
2280
|
diluted_ni_availto_com_stockholders?: number;
|
|
2095
2281
|
ebit?: number;
|
|
@@ -2125,7 +2311,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
|
|
|
2125
2311
|
total_expenses?: number;
|
|
2126
2312
|
total_revenue?: number;
|
|
2127
2313
|
};
|
|
2128
|
-
|
|
2314
|
+
'2023': {
|
|
2129
2315
|
cost_of_revenue?: number;
|
|
2130
2316
|
diluted_ni_availto_com_stockholders?: number;
|
|
2131
2317
|
ebit?: number;
|
|
@@ -2161,7 +2347,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
|
|
|
2161
2347
|
total_expenses?: number;
|
|
2162
2348
|
total_revenue?: number;
|
|
2163
2349
|
};
|
|
2164
|
-
|
|
2350
|
+
'2024': {
|
|
2165
2351
|
cost_of_revenue?: number;
|
|
2166
2352
|
diluted_ni_availto_com_stockholders?: number;
|
|
2167
2353
|
ebit?: number;
|
|
@@ -2196,7 +2382,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
|
|
|
2196
2382
|
}
|
|
2197
2383
|
export interface InsightGetSymbolFundamentalsQuarterlyResponse {
|
|
2198
2384
|
balance_sheet: {
|
|
2199
|
-
|
|
2385
|
+
'2024Q1': {
|
|
2200
2386
|
accounts_payable?: number;
|
|
2201
2387
|
accounts_receivable?: number;
|
|
2202
2388
|
accumulated_depreciation?: number;
|
|
@@ -2254,7 +2440,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
|
|
|
2254
2440
|
treasury_shares_number?: number;
|
|
2255
2441
|
working_capital?: number;
|
|
2256
2442
|
};
|
|
2257
|
-
|
|
2443
|
+
'2024Q2': {
|
|
2258
2444
|
accounts_payable?: number;
|
|
2259
2445
|
accounts_receivable?: number;
|
|
2260
2446
|
accumulated_depreciation?: number;
|
|
@@ -2310,7 +2496,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
|
|
|
2310
2496
|
total_non_current_liabilities_net_minority_interest?: number;
|
|
2311
2497
|
working_capital?: number;
|
|
2312
2498
|
};
|
|
2313
|
-
|
|
2499
|
+
'2024Q3': {
|
|
2314
2500
|
accounts_payable?: number;
|
|
2315
2501
|
accounts_receivable?: number;
|
|
2316
2502
|
accumulated_depreciation?: number;
|
|
@@ -2366,7 +2552,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
|
|
|
2366
2552
|
total_non_current_liabilities_net_minority_interest?: number;
|
|
2367
2553
|
working_capital?: number;
|
|
2368
2554
|
};
|
|
2369
|
-
|
|
2555
|
+
'2024Q4': {
|
|
2370
2556
|
accounts_payable?: number;
|
|
2371
2557
|
accounts_receivable?: number;
|
|
2372
2558
|
accumulated_depreciation?: number;
|
|
@@ -2434,7 +2620,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
|
|
|
2434
2620
|
currency: string;
|
|
2435
2621
|
};
|
|
2436
2622
|
cash_flow: {
|
|
2437
|
-
|
|
2623
|
+
'2024Q1': {
|
|
2438
2624
|
beginning_cash_position?: number;
|
|
2439
2625
|
capital_expenditure?: number;
|
|
2440
2626
|
cash_dividends_paid?: number;
|
|
@@ -2476,7 +2662,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
|
|
|
2476
2662
|
short_term_debt_payments?: number;
|
|
2477
2663
|
stock_based_compensation?: number;
|
|
2478
2664
|
};
|
|
2479
|
-
|
|
2665
|
+
'2024Q2': {
|
|
2480
2666
|
beginning_cash_position?: number;
|
|
2481
2667
|
capital_expenditure?: number;
|
|
2482
2668
|
cash_dividends_paid?: number;
|
|
@@ -2518,7 +2704,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
|
|
|
2518
2704
|
short_term_debt_payments?: number;
|
|
2519
2705
|
stock_based_compensation?: number;
|
|
2520
2706
|
};
|
|
2521
|
-
|
|
2707
|
+
'2024Q3': {
|
|
2522
2708
|
beginning_cash_position?: number;
|
|
2523
2709
|
capital_expenditure?: number;
|
|
2524
2710
|
cash_dividends_paid?: number;
|
|
@@ -2560,7 +2746,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
|
|
|
2560
2746
|
short_term_debt_payments?: number;
|
|
2561
2747
|
stock_based_compensation?: number;
|
|
2562
2748
|
};
|
|
2563
|
-
|
|
2749
|
+
'2024Q4': {
|
|
2564
2750
|
beginning_cash_position?: number;
|
|
2565
2751
|
capital_expenditure?: number;
|
|
2566
2752
|
cash_dividends_paid?: number;
|
|
@@ -2605,7 +2791,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
|
|
|
2605
2791
|
currency: string;
|
|
2606
2792
|
};
|
|
2607
2793
|
income_statement: {
|
|
2608
|
-
|
|
2794
|
+
'2024Q1': {
|
|
2609
2795
|
cost_of_revenue?: number;
|
|
2610
2796
|
diluted_ni_availto_com_stockholders?: number;
|
|
2611
2797
|
ebit?: number;
|
|
@@ -2635,7 +2821,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
|
|
|
2635
2821
|
total_expenses?: number;
|
|
2636
2822
|
total_revenue?: number;
|
|
2637
2823
|
};
|
|
2638
|
-
|
|
2824
|
+
'2024Q2': {
|
|
2639
2825
|
cost_of_revenue?: number;
|
|
2640
2826
|
diluted_ni_availto_com_stockholders?: number;
|
|
2641
2827
|
ebit?: number;
|
|
@@ -2665,7 +2851,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
|
|
|
2665
2851
|
total_expenses?: number;
|
|
2666
2852
|
total_revenue?: number;
|
|
2667
2853
|
};
|
|
2668
|
-
|
|
2854
|
+
'2024Q3': {
|
|
2669
2855
|
cost_of_revenue?: number;
|
|
2670
2856
|
diluted_ni_availto_com_stockholders?: number;
|
|
2671
2857
|
ebit?: number;
|
|
@@ -2695,7 +2881,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
|
|
|
2695
2881
|
total_expenses?: number;
|
|
2696
2882
|
total_revenue?: number;
|
|
2697
2883
|
};
|
|
2698
|
-
|
|
2884
|
+
'2024Q4': {
|
|
2699
2885
|
cost_of_revenue?: number;
|
|
2700
2886
|
diluted_ni_availto_com_stockholders?: number;
|
|
2701
2887
|
ebit?: number;
|
|
@@ -3166,6 +3352,10 @@ export interface InsightLiquidity {
|
|
|
3166
3352
|
current_ratio: number;
|
|
3167
3353
|
quick_ratio: number;
|
|
3168
3354
|
}
|
|
3355
|
+
export interface InsightListFundsResponse {
|
|
3356
|
+
count: number;
|
|
3357
|
+
data: InsightFund[];
|
|
3358
|
+
}
|
|
3169
3359
|
export interface InsightLiveFeedRequest {
|
|
3170
3360
|
/** Get analyst ratings from the past X months */
|
|
3171
3361
|
bookmark_id?: number;
|
|
@@ -4805,191 +4995,31 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
|
|
|
4805
4995
|
Date = "date",
|
|
4806
4996
|
Rank = "rank"
|
|
4807
4997
|
}
|
|
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>>;
|
|
4887
|
-
/**
|
|
4888
|
-
* @description Delete country code
|
|
4889
|
-
* @tags World Markets
|
|
4890
|
-
* @name CountryCodeDelete
|
|
4891
|
-
* @summary Delete country code
|
|
4892
|
-
* @request DELETE:/country-codes
|
|
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>>;
|
|
4998
|
+
export class AlphaTools<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
4999
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
5000
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
4968
5001
|
/**
|
|
4969
|
-
* @description
|
|
4970
|
-
* @tags
|
|
4971
|
-
* @name
|
|
4972
|
-
* @summary
|
|
4973
|
-
* @request POST:/
|
|
5002
|
+
* @description get seasonlity data with comparison to benchmark
|
|
5003
|
+
* @tags AlphaTools
|
|
5004
|
+
* @name GetMomentumRatioGraph
|
|
5005
|
+
* @summary get seasonlity data
|
|
5006
|
+
* @request POST:/rst
|
|
4974
5007
|
* @secure
|
|
4975
5008
|
*/
|
|
4976
|
-
|
|
5009
|
+
getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError, Format>>;
|
|
4977
5010
|
/**
|
|
4978
|
-
* @description
|
|
4979
|
-
* @tags
|
|
4980
|
-
* @name
|
|
4981
|
-
* @summary
|
|
4982
|
-
* @request
|
|
5011
|
+
* @description get seasonlity data with comparison to benchmark
|
|
5012
|
+
* @tags AlphaTools
|
|
5013
|
+
* @name GetSeasonality
|
|
5014
|
+
* @summary get seasonlity data
|
|
5015
|
+
* @request POST:/seasonality
|
|
4983
5016
|
* @secure
|
|
4984
5017
|
*/
|
|
4985
|
-
|
|
4986
|
-
/** region id */
|
|
4987
|
-
id: string;
|
|
4988
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5018
|
+
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError, Format>>;
|
|
4989
5019
|
}
|
|
4990
|
-
export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
4991
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4992
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5020
|
+
export class CompanyProfile<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
5021
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
5022
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
4993
5023
|
/**
|
|
4994
5024
|
* @description get company profile, industries classification and closest earning release
|
|
4995
5025
|
* @tags CompanyProfile
|
|
@@ -5001,7 +5031,7 @@ export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
|
5001
5031
|
getCompanyProfile(query: {
|
|
5002
5032
|
/** Company symbol */
|
|
5003
5033
|
symbol: string;
|
|
5004
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError>>;
|
|
5034
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError, Format>>;
|
|
5005
5035
|
/**
|
|
5006
5036
|
* @description get combined profile, equities and funds
|
|
5007
5037
|
* @tags CompanyProfile
|
|
@@ -5015,7 +5045,7 @@ export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
|
5015
5045
|
symbol: string;
|
|
5016
5046
|
/** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
|
|
5017
5047
|
symbol_type?: InsightGetCombinedProfileParamsSymbolTypeEnum;
|
|
5018
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError>>;
|
|
5048
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError, Format>>;
|
|
5019
5049
|
/**
|
|
5020
5050
|
* @description sort input array of symbols by type
|
|
5021
5051
|
* @tags CompanyProfile
|
|
@@ -5024,11 +5054,11 @@ export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
|
5024
5054
|
* @request POST:/symbols-per-type
|
|
5025
5055
|
* @secure
|
|
5026
5056
|
*/
|
|
5027
|
-
getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
|
|
5057
|
+
getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError, Format>>;
|
|
5028
5058
|
}
|
|
5029
|
-
export class CustomLists<HandleError extends boolean = boolean> {
|
|
5030
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5031
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5059
|
+
export class CustomLists<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
5060
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
5061
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
5032
5062
|
/**
|
|
5033
5063
|
* @description get custom lists
|
|
5034
5064
|
* @tags Custom Lists
|
|
@@ -5042,7 +5072,7 @@ export class CustomLists<HandleError extends boolean = boolean> {
|
|
|
5042
5072
|
limit: number;
|
|
5043
5073
|
/** how many records to skip */
|
|
5044
5074
|
offset: number;
|
|
5045
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
5075
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError, Format>>;
|
|
5046
5076
|
/**
|
|
5047
5077
|
* @description update custom list
|
|
5048
5078
|
* @tags Custom Lists
|
|
@@ -5051,7 +5081,7 @@ export class CustomLists<HandleError extends boolean = boolean> {
|
|
|
5051
5081
|
* @request PUT:/custom-lists
|
|
5052
5082
|
* @secure
|
|
5053
5083
|
*/
|
|
5054
|
-
updateCustomList(filter: InsightUpdateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
|
|
5084
|
+
updateCustomList(filter: InsightUpdateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError, Format>>;
|
|
5055
5085
|
/**
|
|
5056
5086
|
* @description create custom list
|
|
5057
5087
|
* @tags Custom Lists
|
|
@@ -5060,7 +5090,7 @@ export class CustomLists<HandleError extends boolean = boolean> {
|
|
|
5060
5090
|
* @request POST:/custom-lists
|
|
5061
5091
|
* @secure
|
|
5062
5092
|
*/
|
|
5063
|
-
createCustomList(filter: InsightCreateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
|
|
5093
|
+
createCustomList(filter: InsightCreateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError, Format>>;
|
|
5064
5094
|
/**
|
|
5065
5095
|
* @description remove custom list
|
|
5066
5096
|
* @tags Custom Lists
|
|
@@ -5069,7 +5099,7 @@ export class CustomLists<HandleError extends boolean = boolean> {
|
|
|
5069
5099
|
* @request DELETE:/custom-lists
|
|
5070
5100
|
* @secure
|
|
5071
5101
|
*/
|
|
5072
|
-
removeCustomList(filter: InsightRemoveCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5102
|
+
removeCustomList(filter: InsightRemoveCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
5073
5103
|
/**
|
|
5074
5104
|
* @description filter custom lists
|
|
5075
5105
|
* @tags Custom Lists
|
|
@@ -5078,7 +5108,7 @@ export class CustomLists<HandleError extends boolean = boolean> {
|
|
|
5078
5108
|
* @request POST:/custom-lists/filter
|
|
5079
5109
|
* @secure
|
|
5080
5110
|
*/
|
|
5081
|
-
filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
5111
|
+
filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError, Format>>;
|
|
5082
5112
|
/**
|
|
5083
5113
|
* @description get custom list with quotes
|
|
5084
5114
|
* @tags Custom Lists
|
|
@@ -5096,7 +5126,7 @@ export class CustomLists<HandleError extends boolean = boolean> {
|
|
|
5096
5126
|
limit: number;
|
|
5097
5127
|
/** how many equities records to skip */
|
|
5098
5128
|
offset: number;
|
|
5099
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
|
|
5129
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError, Format>>;
|
|
5100
5130
|
/**
|
|
5101
5131
|
* @description filter custom list
|
|
5102
5132
|
* @tags Custom Lists
|
|
@@ -5108,11 +5138,11 @@ export class CustomLists<HandleError extends boolean = boolean> {
|
|
|
5108
5138
|
filterCustomList(idOrSlug: string, query?: {
|
|
5109
5139
|
/** symbols to check inclusion */
|
|
5110
5140
|
symbols?: string[];
|
|
5111
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFilteredCustomIndexResponse, HandleError>>;
|
|
5141
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFilteredCustomIndexResponse, HandleError, Format>>;
|
|
5112
5142
|
}
|
|
5113
|
-
export class Dashboard<HandleError extends boolean = boolean> {
|
|
5114
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5115
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5143
|
+
export class Dashboard<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
5144
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
5145
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
5116
5146
|
/**
|
|
5117
5147
|
* @description get ownerships by symbol
|
|
5118
5148
|
* @tags Dashboard
|
|
@@ -5121,7 +5151,7 @@ export class Dashboard<HandleError extends boolean = boolean> {
|
|
|
5121
5151
|
* @request POST:/dashboard/ownerships
|
|
5122
5152
|
* @secure
|
|
5123
5153
|
*/
|
|
5124
|
-
dashboardGetOwnershipsBySymbol(filter: InsightGetOwnershipsBySymbolRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolAsDashboardFieldsResponse, HandleError>>;
|
|
5154
|
+
dashboardGetOwnershipsBySymbol(filter: InsightGetOwnershipsBySymbolRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolAsDashboardFieldsResponse, HandleError, Format>>;
|
|
5125
5155
|
/**
|
|
5126
5156
|
* @description rewrite field value
|
|
5127
5157
|
* @tags Dashboard
|
|
@@ -5130,7 +5160,7 @@ export class Dashboard<HandleError extends boolean = boolean> {
|
|
|
5130
5160
|
* @request POST:/rewrite-field
|
|
5131
5161
|
* @secure
|
|
5132
5162
|
*/
|
|
5133
|
-
rewriteFieldValue(input: InsightRewriteFieldValueRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5163
|
+
rewriteFieldValue(input: InsightRewriteFieldValueRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
5134
5164
|
/**
|
|
5135
5165
|
* @description remove rewritten value
|
|
5136
5166
|
* @tags Dashboard
|
|
@@ -5139,7 +5169,7 @@ export class Dashboard<HandleError extends boolean = boolean> {
|
|
|
5139
5169
|
* @request DELETE:/rewrite-field
|
|
5140
5170
|
* @secure
|
|
5141
5171
|
*/
|
|
5142
|
-
createRewriteField(input: InsightRemoveRewrittenFieldValueRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5172
|
+
createRewriteField(input: InsightRemoveRewrittenFieldValueRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
5143
5173
|
/**
|
|
5144
5174
|
* @description Get rewritten field action log
|
|
5145
5175
|
* @tags Dashboard
|
|
@@ -5157,7 +5187,7 @@ export class Dashboard<HandleError extends boolean = boolean> {
|
|
|
5157
5187
|
limit: number;
|
|
5158
5188
|
/** how many records to skip */
|
|
5159
5189
|
offset: number;
|
|
5160
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5190
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
5161
5191
|
/**
|
|
5162
5192
|
* @description Get rewritten values
|
|
5163
5193
|
* @tags Dashboard
|
|
@@ -5171,7 +5201,7 @@ export class Dashboard<HandleError extends boolean = boolean> {
|
|
|
5171
5201
|
limit: number;
|
|
5172
5202
|
/** how many records to skip */
|
|
5173
5203
|
offset: number;
|
|
5174
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5204
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
5175
5205
|
/**
|
|
5176
5206
|
* @description get symbol-related fields
|
|
5177
5207
|
* @tags Dashboard
|
|
@@ -5183,11 +5213,11 @@ export class Dashboard<HandleError extends boolean = boolean> {
|
|
|
5183
5213
|
getSymbolRelatedFields(query: {
|
|
5184
5214
|
/** Symbol */
|
|
5185
5215
|
symbol: string;
|
|
5186
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolRelatedFieldsResponse, HandleError>>;
|
|
5216
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolRelatedFieldsResponse, HandleError, Format>>;
|
|
5187
5217
|
}
|
|
5188
|
-
export class Earnings<HandleError extends boolean = boolean> {
|
|
5189
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5190
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5218
|
+
export class Earnings<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
5219
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
5220
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
5191
5221
|
/**
|
|
5192
5222
|
* @description get earnings releases count per day
|
|
5193
5223
|
* @tags Earnings
|
|
@@ -5212,7 +5242,7 @@ export class Earnings<HandleError extends boolean = boolean> {
|
|
|
5212
5242
|
* @example ""NYSE,NAS""
|
|
5213
5243
|
*/
|
|
5214
5244
|
exchanges?: string[];
|
|
5215
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, number>, HandleError>>;
|
|
5245
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, number>, HandleError, Format>>;
|
|
5216
5246
|
/**
|
|
5217
5247
|
* @description get earnings release dates for symbols
|
|
5218
5248
|
* @tags Earnings
|
|
@@ -5221,24 +5251,11 @@ export class Earnings<HandleError extends boolean = boolean> {
|
|
|
5221
5251
|
* @request POST:/earnings-calendar
|
|
5222
5252
|
* @secure
|
|
5223
5253
|
*/
|
|
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>>;
|
|
5254
|
+
getEarningsCalendar(filter: InsightEarningReleasesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEarningReleasesResponse, HandleError, Format>>;
|
|
5238
5255
|
}
|
|
5239
|
-
export class FixedIncome<HandleError extends boolean = boolean> {
|
|
5240
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5241
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5256
|
+
export class FixedIncome<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
5257
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
5258
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
5242
5259
|
/**
|
|
5243
5260
|
* @description get fixed income entries
|
|
5244
5261
|
* @tags FixedIncome
|
|
@@ -5247,7 +5264,7 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
5247
5264
|
* @request POST:/fixed-income
|
|
5248
5265
|
* @secure
|
|
5249
5266
|
*/
|
|
5250
|
-
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponse, HandleError>>;
|
|
5267
|
+
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponse, HandleError, Format>>;
|
|
5251
5268
|
/**
|
|
5252
5269
|
* @description Returns historical fixed income
|
|
5253
5270
|
* @tags FixedIncome
|
|
@@ -5256,7 +5273,7 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
5256
5273
|
* @request POST:/fixed-income/historical
|
|
5257
5274
|
* @secure
|
|
5258
5275
|
*/
|
|
5259
|
-
fixedIncomeHistorical(filter: InsightGetFixedIncomeHistoricalRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeHistoricalResponse, HandleError>>;
|
|
5276
|
+
fixedIncomeHistorical(filter: InsightGetFixedIncomeHistoricalRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeHistoricalResponse, HandleError, Format>>;
|
|
5260
5277
|
/**
|
|
5261
5278
|
* @description get fixed-income presets
|
|
5262
5279
|
* @tags FixedIncome
|
|
@@ -5270,7 +5287,7 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
5270
5287
|
limit: number;
|
|
5271
5288
|
/** how many records to skip */
|
|
5272
5289
|
offset: number;
|
|
5273
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
5290
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError, Format>>;
|
|
5274
5291
|
/**
|
|
5275
5292
|
* @description update fixed-income preset
|
|
5276
5293
|
* @tags FixedIncome
|
|
@@ -5279,7 +5296,7 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
5279
5296
|
* @request PUT:/fixed-income/presets
|
|
5280
5297
|
* @secure
|
|
5281
5298
|
*/
|
|
5282
|
-
updateFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5299
|
+
updateFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError, Format>>;
|
|
5283
5300
|
/**
|
|
5284
5301
|
* @description create fixed-income preset
|
|
5285
5302
|
* @tags FixedIncome
|
|
@@ -5288,7 +5305,7 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
5288
5305
|
* @request POST:/fixed-income/presets
|
|
5289
5306
|
* @secure
|
|
5290
5307
|
*/
|
|
5291
|
-
createFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5308
|
+
createFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError, Format>>;
|
|
5292
5309
|
/**
|
|
5293
5310
|
* @description remove fixed-income preset
|
|
5294
5311
|
* @tags FixedIncome
|
|
@@ -5297,7 +5314,7 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
5297
5314
|
* @request DELETE:/fixed-income/presets
|
|
5298
5315
|
* @secure
|
|
5299
5316
|
*/
|
|
5300
|
-
removeFixedIncomePreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5317
|
+
removeFixedIncomePreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
5301
5318
|
/**
|
|
5302
5319
|
* @description search fixed income values
|
|
5303
5320
|
* @tags FixedIncome
|
|
@@ -5315,7 +5332,7 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
5315
5332
|
limit?: number;
|
|
5316
5333
|
/** how many records to skip */
|
|
5317
5334
|
offset?: number;
|
|
5318
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSearchFixedIncomeValuesResponse, HandleError>>;
|
|
5335
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSearchFixedIncomeValuesResponse, HandleError, Format>>;
|
|
5319
5336
|
/**
|
|
5320
5337
|
* @description get single fixed income entry
|
|
5321
5338
|
* @tags FixedIncome
|
|
@@ -5324,557 +5341,540 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
5324
5341
|
* @request GET:/fixed-income/{id}
|
|
5325
5342
|
* @secure
|
|
5326
5343
|
*/
|
|
5327
|
-
getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
|
|
5344
|
+
getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError, Format>>;
|
|
5328
5345
|
}
|
|
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>>;
|
|
5346
|
+
export enum InsightOrderDirectionV2 {
|
|
5347
|
+
OrderASC = "asc",
|
|
5348
|
+
OrderDESC = "desc"
|
|
5442
5349
|
}
|
|
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
|
-
|
|
5350
|
+
export interface InsightBeforeAndAfterV2 {
|
|
5351
|
+
after?: string;
|
|
5352
|
+
before?: string;
|
|
5353
|
+
}
|
|
5354
|
+
export interface InsightFixedIncomeV2 {
|
|
5355
|
+
a144: boolean;
|
|
5356
|
+
accrued_interest: number;
|
|
5357
|
+
bank_qualified: boolean;
|
|
5358
|
+
bond_warrant: boolean;
|
|
5359
|
+
call_type: string;
|
|
5360
|
+
callable: boolean;
|
|
5361
|
+
close_price: number;
|
|
5362
|
+
close_price_asof: string;
|
|
5363
|
+
close_ytw: number;
|
|
5364
|
+
convertible: boolean;
|
|
5365
|
+
country: string;
|
|
5366
|
+
country_code: string;
|
|
5367
|
+
country_domicile: string;
|
|
5368
|
+
country_issue: string;
|
|
5369
|
+
coupon: number;
|
|
5370
|
+
coupon_frequency: string;
|
|
5371
|
+
coupon_type: string;
|
|
5372
|
+
currency: string;
|
|
5373
|
+
cusip: string;
|
|
5374
|
+
dated_date: string;
|
|
5375
|
+
daycount: string;
|
|
5376
|
+
description: string;
|
|
5377
|
+
description_short: string;
|
|
5378
|
+
duration: number;
|
|
5379
|
+
first_coupon_date: string;
|
|
5380
|
+
insured: boolean;
|
|
5381
|
+
isin: string;
|
|
5382
|
+
issue_date: string;
|
|
5383
|
+
issue_minimum_denomination: number;
|
|
5384
|
+
issue_price: number;
|
|
5385
|
+
issue_size: number;
|
|
5386
|
+
issuer: string;
|
|
5387
|
+
last_coupon_date: string;
|
|
5388
|
+
liquidity_institutional_aggregate: number;
|
|
5389
|
+
liquidity_institutional_buy: number;
|
|
5390
|
+
liquidity_institutional_sell: number;
|
|
5391
|
+
liquidity_micro_aggregate: number;
|
|
5392
|
+
liquidity_micro_buy: number;
|
|
5393
|
+
liquidity_micro_sell: number;
|
|
5394
|
+
liquidity_retail_aggregate: number;
|
|
5395
|
+
liquidity_retail_buy: number;
|
|
5396
|
+
liquidity_retail_sell: number;
|
|
5397
|
+
maturity_date: string;
|
|
5398
|
+
municipal_state: string;
|
|
5399
|
+
municipal_taxable_federal: boolean;
|
|
5400
|
+
municipal_type: string;
|
|
5401
|
+
next_call_date: string;
|
|
5402
|
+
next_call_price: number;
|
|
5403
|
+
next_coupon_date: string;
|
|
5404
|
+
par_value: number;
|
|
5405
|
+
perpetual: boolean;
|
|
5406
|
+
private_placement: boolean;
|
|
5407
|
+
purpose: string;
|
|
5408
|
+
puttable: boolean;
|
|
5409
|
+
reg_s: boolean;
|
|
5410
|
+
sector: string;
|
|
5411
|
+
seniority: string;
|
|
5412
|
+
settlement_convention: string;
|
|
5413
|
+
sinking_fund: boolean;
|
|
5414
|
+
sp_creditwatch: string;
|
|
5415
|
+
sp_creditwatch_date: string;
|
|
5416
|
+
sp_outlook: string;
|
|
5417
|
+
sp_outlook_date: string;
|
|
5418
|
+
sp_rating: string;
|
|
5419
|
+
sp_rating_date: string;
|
|
5420
|
+
status: string;
|
|
5421
|
+
ticker: string;
|
|
5422
|
+
treasury_subtype: string;
|
|
5423
|
+
type: string;
|
|
5424
|
+
updated_at: string;
|
|
5425
|
+
}
|
|
5426
|
+
export interface InsightGetFixedIncomeEntriesResponseV2 {
|
|
5427
|
+
count: number;
|
|
5428
|
+
data: InsightFixedIncomeV2[];
|
|
5429
|
+
}
|
|
5430
|
+
export interface InsightGetFixedIncomeEntriesRequestV2 {
|
|
5431
|
+
/** @example true */
|
|
5432
|
+
bank_qualified?: boolean;
|
|
5433
|
+
/** @example true */
|
|
5434
|
+
callable?: boolean;
|
|
5435
|
+
/** @example true */
|
|
5436
|
+
convertible?: boolean;
|
|
5437
|
+
/** @example ["USA"] */
|
|
5438
|
+
country_codes?: string[];
|
|
5439
|
+
coupon?: InsightLessAndMoreV2;
|
|
5440
|
+
/** @example ["quarterly","zero"] */
|
|
5441
|
+
coupon_frequencies?: string[];
|
|
5442
|
+
/** @example ["655664AH3","9128286R6"] */
|
|
5443
|
+
cusip?: string[];
|
|
5499
5444
|
/**
|
|
5500
|
-
* @
|
|
5501
|
-
* @
|
|
5502
|
-
* @name UpdateScreenerPreset
|
|
5503
|
-
* @summary update screener preset
|
|
5504
|
-
* @request PUT:/stock-screener/presets
|
|
5505
|
-
* @secure
|
|
5445
|
+
* @maxLength 100
|
|
5446
|
+
* @example "Donald's"
|
|
5506
5447
|
*/
|
|
5507
|
-
|
|
5448
|
+
description?: string;
|
|
5449
|
+
/** @example true */
|
|
5450
|
+
has_ticker?: boolean;
|
|
5451
|
+
/** @example true */
|
|
5452
|
+
insured?: boolean;
|
|
5453
|
+
/** @example ["US655664AH33","US9128286R69"] */
|
|
5454
|
+
isin?: string[];
|
|
5455
|
+
issue_date?: InsightBeforeAndAfterV2;
|
|
5508
5456
|
/**
|
|
5509
|
-
* @
|
|
5510
|
-
* @
|
|
5511
|
-
* @name CreateOrScreenerPreset
|
|
5512
|
-
* @summary create screener preset
|
|
5513
|
-
* @request POST:/stock-screener/presets
|
|
5514
|
-
* @secure
|
|
5457
|
+
* @maxLength 100
|
|
5458
|
+
* @example "Donald's"
|
|
5515
5459
|
*/
|
|
5516
|
-
|
|
5460
|
+
issuer?: string;
|
|
5461
|
+
maturity?: InsightBeforeAndAfterV2;
|
|
5462
|
+
/** @example ["NY"] */
|
|
5463
|
+
municipal_states?: string[];
|
|
5464
|
+
/** @example true */
|
|
5465
|
+
municipal_tax?: boolean;
|
|
5466
|
+
/** @example ["general_obligation"] */
|
|
5467
|
+
municipal_types?: string[];
|
|
5468
|
+
pagination: InsightPaginationV2;
|
|
5469
|
+
purposes?: string[];
|
|
5470
|
+
/** @example ["SOVEREIGN"] */
|
|
5471
|
+
sectors?: string[];
|
|
5472
|
+
sorts?: InsightOrderingV2[];
|
|
5473
|
+
/** @example ["AAA"] */
|
|
5474
|
+
sp_ratings?: string[];
|
|
5475
|
+
/** @example ["called","outstanding"] */
|
|
5476
|
+
statuses?: string[];
|
|
5477
|
+
tickers?: string[];
|
|
5478
|
+
/** @example ["corporate"] */
|
|
5479
|
+
types?: string[];
|
|
5480
|
+
}
|
|
5481
|
+
export interface InsightGetTopSymbolsRequestV2 {
|
|
5482
|
+
exchange?: string[];
|
|
5483
|
+
market_cap?: InsightLessAndMoreV2;
|
|
5484
|
+
pagination?: InsightPaginationV2;
|
|
5485
|
+
price?: InsightLessAndMoreV2;
|
|
5486
|
+
sorts?: InsightOrderingV2[];
|
|
5487
|
+
volume?: InsightLessAndMoreV2;
|
|
5488
|
+
}
|
|
5489
|
+
export interface InsightIncludeExcludeV2 {
|
|
5490
|
+
exclude?: string[];
|
|
5491
|
+
include?: string[];
|
|
5492
|
+
}
|
|
5493
|
+
export interface InsightLessAndMoreV2 {
|
|
5494
|
+
less_than?: number;
|
|
5495
|
+
more_than?: number;
|
|
5496
|
+
}
|
|
5497
|
+
export interface InsightOrderingV2 {
|
|
5517
5498
|
/**
|
|
5518
|
-
* @
|
|
5519
|
-
* @
|
|
5520
|
-
* @name RemoveScreenerPreset
|
|
5521
|
-
* @summary remove screener preset
|
|
5522
|
-
* @request DELETE:/stock-screener/presets
|
|
5523
|
-
* @secure
|
|
5499
|
+
* @default "asc"
|
|
5500
|
+
* @example "asc"
|
|
5524
5501
|
*/
|
|
5525
|
-
|
|
5502
|
+
direction: InsightOrderingDirectionEnumV2;
|
|
5526
5503
|
/**
|
|
5527
|
-
*
|
|
5528
|
-
*
|
|
5529
|
-
*
|
|
5530
|
-
* @
|
|
5531
|
-
* @request POST:/stock-screener/top
|
|
5532
|
-
* @secure
|
|
5504
|
+
* Sort direction:
|
|
5505
|
+
* * asc - Ascending, from A to Z.
|
|
5506
|
+
* * desc - Descending, from Z to A.
|
|
5507
|
+
* @example "name"
|
|
5533
5508
|
*/
|
|
5534
|
-
|
|
5509
|
+
field: string;
|
|
5535
5510
|
}
|
|
5536
|
-
export
|
|
5537
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5538
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5511
|
+
export interface InsightPaginationV2 {
|
|
5539
5512
|
/**
|
|
5540
|
-
* @
|
|
5541
|
-
* @
|
|
5542
|
-
* @name GitHistoricalQuote
|
|
5543
|
-
* @summary Get single historical quote
|
|
5544
|
-
* @request GET:/historical/quote
|
|
5545
|
-
* @secure
|
|
5513
|
+
* @min 1
|
|
5514
|
+
* @example 1
|
|
5546
5515
|
*/
|
|
5547
|
-
|
|
5548
|
-
/** Symbol */
|
|
5549
|
-
symbol: string;
|
|
5550
|
-
/** Date */
|
|
5551
|
-
date: string;
|
|
5552
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
|
|
5516
|
+
page: number;
|
|
5553
5517
|
/**
|
|
5554
|
-
* @
|
|
5555
|
-
* @
|
|
5556
|
-
* @
|
|
5557
|
-
* @summary Get quote history
|
|
5558
|
-
* @request POST:/quote-history
|
|
5559
|
-
* @secure
|
|
5518
|
+
* @min 1
|
|
5519
|
+
* @max 50
|
|
5520
|
+
* @example 10
|
|
5560
5521
|
*/
|
|
5561
|
-
|
|
5522
|
+
size: number;
|
|
5523
|
+
}
|
|
5524
|
+
export interface InsightStockScreenerQuoteV2 {
|
|
5525
|
+
average_volume_30d: number;
|
|
5526
|
+
company_name: string;
|
|
5527
|
+
dividend_ex_date: string;
|
|
5528
|
+
dividend_pay_date: string;
|
|
5529
|
+
dividend_percent: number;
|
|
5530
|
+
exchange: string;
|
|
5531
|
+
exchange_name: string;
|
|
5532
|
+
gap: number;
|
|
5533
|
+
industry: string;
|
|
5534
|
+
industry_code: string;
|
|
5535
|
+
last_price: number;
|
|
5536
|
+
market_cap: number;
|
|
5537
|
+
pe_ratio: number;
|
|
5538
|
+
price_change: number;
|
|
5539
|
+
price_change_percent: number;
|
|
5540
|
+
symbol: string;
|
|
5541
|
+
volume: number;
|
|
5542
|
+
}
|
|
5543
|
+
export interface InsightStockScreenerRequestV2 {
|
|
5544
|
+
average_volume_30d?: InsightLessAndMoreV2;
|
|
5545
|
+
dividend_ex_date?: InsightBeforeAndAfterV2;
|
|
5546
|
+
dividend_pay_date?: InsightBeforeAndAfterV2;
|
|
5547
|
+
dividend_percent?: InsightLessAndMoreV2;
|
|
5548
|
+
exchange?: InsightIncludeExcludeV2;
|
|
5549
|
+
gap?: InsightLessAndMoreV2;
|
|
5550
|
+
industry?: InsightIncludeExcludeV2;
|
|
5551
|
+
market_cap?: InsightLessAndMoreV2;
|
|
5552
|
+
pagination: InsightPaginationV2;
|
|
5553
|
+
pe_ratio?: InsightLessAndMoreV2;
|
|
5554
|
+
price?: InsightLessAndMoreV2;
|
|
5555
|
+
price_change_percent?: InsightLessAndMoreV2;
|
|
5556
|
+
sorts?: InsightOrderingV2[];
|
|
5557
|
+
/** @example "ADR" */
|
|
5558
|
+
stock_type?: string;
|
|
5559
|
+
volume?: InsightLessAndMoreV2;
|
|
5560
|
+
}
|
|
5561
|
+
export interface InsightStockScreenerResponseV2 {
|
|
5562
|
+
current_page: number;
|
|
5563
|
+
data: InsightStockScreenerQuoteV2[];
|
|
5564
|
+
page_count: number;
|
|
5565
|
+
status: number;
|
|
5566
|
+
total_records: number;
|
|
5567
|
+
}
|
|
5568
|
+
/**
|
|
5569
|
+
* @default "asc"
|
|
5570
|
+
* @example "asc"
|
|
5571
|
+
*/
|
|
5572
|
+
export enum InsightOrderingDirectionEnumV2 {
|
|
5573
|
+
Asc = "asc",
|
|
5574
|
+
Desc = "desc"
|
|
5575
|
+
}
|
|
5576
|
+
export class FixedIncomeV2<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
5577
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
5578
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
5562
5579
|
/**
|
|
5563
|
-
* @description
|
|
5564
|
-
* @tags
|
|
5565
|
-
* @name
|
|
5566
|
-
* @summary
|
|
5567
|
-
* @request
|
|
5580
|
+
* @description get fixed income entries
|
|
5581
|
+
* @tags FixedIncome
|
|
5582
|
+
* @name GetFixedIncomeEntries
|
|
5583
|
+
* @summary get fixed income entries
|
|
5584
|
+
* @request POST:/fixed-income
|
|
5568
5585
|
* @secure
|
|
5569
5586
|
*/
|
|
5570
|
-
|
|
5571
|
-
/** Comma separated symbols */
|
|
5572
|
-
symbols: string;
|
|
5573
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
|
|
5587
|
+
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError, Format>>;
|
|
5574
5588
|
}
|
|
5575
|
-
export class
|
|
5576
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5577
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5589
|
+
export class Fundamentals<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
5590
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
5591
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
5578
5592
|
/**
|
|
5579
|
-
* @description
|
|
5580
|
-
* @tags
|
|
5581
|
-
* @name
|
|
5582
|
-
* @summary
|
|
5583
|
-
* @request POST:/
|
|
5593
|
+
* @description get fundamentals by symbol data
|
|
5594
|
+
* @tags Fundamentals
|
|
5595
|
+
* @name GetFundamentalsBySymbolData
|
|
5596
|
+
* @summary get fundamentals by symbol data
|
|
5597
|
+
* @request POST:/fundamentals
|
|
5584
5598
|
* @secure
|
|
5585
5599
|
*/
|
|
5586
|
-
|
|
5600
|
+
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError, Format>>;
|
|
5587
5601
|
}
|
|
5588
|
-
export class
|
|
5589
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5590
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5602
|
+
export class Funds<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
5603
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
5604
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
5591
5605
|
/**
|
|
5592
|
-
* @description
|
|
5593
|
-
* @tags
|
|
5594
|
-
* @name
|
|
5595
|
-
* @summary
|
|
5596
|
-
* @request GET:/
|
|
5606
|
+
* @description get fund details
|
|
5607
|
+
* @tags Funds
|
|
5608
|
+
* @name GetFundDetails
|
|
5609
|
+
* @summary get fund details
|
|
5610
|
+
* @request GET:/funds/details
|
|
5597
5611
|
* @secure
|
|
5598
5612
|
*/
|
|
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>>;
|
|
5613
|
+
getFundDetails(query: {
|
|
5614
|
+
/** Fund symbol */
|
|
5615
|
+
symbol: string;
|
|
5616
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundDetailsResponse, HandleError, Format>>;
|
|
5616
5617
|
/**
|
|
5617
|
-
* @description
|
|
5618
|
-
* @tags
|
|
5619
|
-
* @name
|
|
5620
|
-
* @summary
|
|
5621
|
-
* @request GET:/
|
|
5622
|
-
* @secure
|
|
5623
|
-
*/
|
|
5624
|
-
|
|
5618
|
+
* @description get list of ETF funds
|
|
5619
|
+
* @tags Funds
|
|
5620
|
+
* @name ListOfEtfFunds
|
|
5621
|
+
* @summary get list of ETF funds
|
|
5622
|
+
* @request GET:/funds/etfs
|
|
5623
|
+
* @secure
|
|
5624
|
+
*/
|
|
5625
|
+
listOfEtfFunds(query?: {
|
|
5626
|
+
/** Asset class id */
|
|
5627
|
+
asset_class?: string;
|
|
5628
|
+
/** Leverage ratios to filter by */
|
|
5629
|
+
leverage_ratios?: number[];
|
|
5630
|
+
/** Whether to include inverse ETFs */
|
|
5631
|
+
inverse?: boolean;
|
|
5632
|
+
/** Search query to filter funds by name */
|
|
5633
|
+
search_query?: string;
|
|
5634
|
+
/** Field to search in (e.g. symbol, name, provider_company). Default is name and symbol */
|
|
5635
|
+
search_field?: string;
|
|
5636
|
+
/**
|
|
5637
|
+
* Minimum expense ratio to filter by
|
|
5638
|
+
* @format float64
|
|
5639
|
+
*/
|
|
5640
|
+
expense_ratio_min?: number;
|
|
5641
|
+
/**
|
|
5642
|
+
* Maximum expense ratio to filter by
|
|
5643
|
+
* @format float64
|
|
5644
|
+
*/
|
|
5645
|
+
expense_ratio_max?: number;
|
|
5646
|
+
/**
|
|
5647
|
+
* Minimum fund net assets to filter by
|
|
5648
|
+
* @format float64
|
|
5649
|
+
*/
|
|
5650
|
+
fund_net_assets_min?: number;
|
|
5651
|
+
/**
|
|
5652
|
+
* Maximum fund net assets to filter by
|
|
5653
|
+
* @format float64
|
|
5654
|
+
*/
|
|
5655
|
+
fund_net_assets_max?: number;
|
|
5656
|
+
/** Field to order by (e.g. fund_net_assets, expense_ratio, trailing_return_y1, average_calendar_month_daily_volume, name, inception_date) */
|
|
5657
|
+
order_field?: string;
|
|
5658
|
+
/** Order direction (asc or desc) */
|
|
5659
|
+
order_direction?: string;
|
|
5660
|
+
/** Number of records to return */
|
|
5661
|
+
limit?: number;
|
|
5662
|
+
/** Number of records to skip */
|
|
5663
|
+
offset?: number;
|
|
5664
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightListFundsResponse, HandleError, Format>>;
|
|
5625
5665
|
/**
|
|
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
|
-
|
|
5666
|
+
* @description get list of ETN funds
|
|
5667
|
+
* @tags Funds
|
|
5668
|
+
* @name ListOfEtnFunds
|
|
5669
|
+
* @summary get list of ETN funds
|
|
5670
|
+
* @request GET:/funds/etns
|
|
5671
|
+
* @secure
|
|
5672
|
+
*/
|
|
5673
|
+
listOfEtnFunds(query?: {
|
|
5674
|
+
/** Asset class id */
|
|
5675
|
+
asset_class?: string;
|
|
5676
|
+
/** Leverage ratios to filter by */
|
|
5677
|
+
leverage_ratios?: number[];
|
|
5678
|
+
/** Whether to include inverse ETFs */
|
|
5679
|
+
inverse?: boolean;
|
|
5680
|
+
/** Search query to filter funds by name */
|
|
5681
|
+
search_query?: string;
|
|
5682
|
+
/** Field to search in (e.g. symbol, name, provider_company). Default is name and symbol */
|
|
5683
|
+
search_field?: string;
|
|
5684
|
+
/**
|
|
5685
|
+
* Minimum expense ratio to filter by
|
|
5686
|
+
* @format float64
|
|
5687
|
+
*/
|
|
5688
|
+
expense_ratio_min?: number;
|
|
5689
|
+
/**
|
|
5690
|
+
* Maximum expense ratio to filter by
|
|
5691
|
+
* @format float64
|
|
5692
|
+
*/
|
|
5693
|
+
expense_ratio_max?: number;
|
|
5694
|
+
/**
|
|
5695
|
+
* Minimum fund net assets to filter by
|
|
5696
|
+
* @format float64
|
|
5697
|
+
*/
|
|
5698
|
+
fund_net_assets_min?: number;
|
|
5699
|
+
/**
|
|
5700
|
+
* Maximum fund net assets to filter by
|
|
5701
|
+
* @format float64
|
|
5702
|
+
*/
|
|
5703
|
+
fund_net_assets_max?: number;
|
|
5704
|
+
/** Field to order by (e.g. fund_net_assets, expense_ratio, trailing_return_y1, average_calendar_month_daily_volume, name, inception_date) */
|
|
5705
|
+
order_field?: string;
|
|
5706
|
+
/** Order direction (asc or desc) */
|
|
5707
|
+
order_direction?: string;
|
|
5708
|
+
/** Number of records to return */
|
|
5709
|
+
limit?: number;
|
|
5710
|
+
/** Number of records to skip */
|
|
5711
|
+
offset?: number;
|
|
5712
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightListFundsResponse, HandleError, Format>>;
|
|
5659
5713
|
/**
|
|
5660
|
-
* @description get
|
|
5661
|
-
* @tags
|
|
5662
|
-
* @name
|
|
5663
|
-
* @summary get
|
|
5664
|
-
* @request
|
|
5665
|
-
* @originalName getPreIpoCompanies
|
|
5666
|
-
* @duplicate
|
|
5714
|
+
* @description get funds for holding
|
|
5715
|
+
* @tags Funds
|
|
5716
|
+
* @name GetFundsForHolding
|
|
5717
|
+
* @summary get funds for holding
|
|
5718
|
+
* @request POST:/funds/funds-for-holding
|
|
5667
5719
|
* @secure
|
|
5668
5720
|
*/
|
|
5669
|
-
|
|
5721
|
+
getFundsForHolding(filter: InsightGetFundsForHoldingRequest, headers?: {
|
|
5722
|
+
/** Authorization */
|
|
5723
|
+
Authorization?: string;
|
|
5724
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundsForHoldingResponse, HandleError, Format>>;
|
|
5670
5725
|
/**
|
|
5671
|
-
* @description
|
|
5672
|
-
* @tags
|
|
5673
|
-
* @name
|
|
5674
|
-
* @summary
|
|
5675
|
-
* @request
|
|
5726
|
+
* @description filter funds by params
|
|
5727
|
+
* @tags Funds
|
|
5728
|
+
* @name FundScreener
|
|
5729
|
+
* @summary filter funds by params
|
|
5730
|
+
* @request POST:/funds/screener
|
|
5676
5731
|
* @secure
|
|
5677
5732
|
*/
|
|
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>>;
|
|
5733
|
+
fundScreener(filter: InsightFundScreenerRequest, headers?: {
|
|
5734
|
+
/** Authorization */
|
|
5735
|
+
Authorization?: string;
|
|
5736
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError, Format>>;
|
|
5688
5737
|
/**
|
|
5689
|
-
* @description get
|
|
5690
|
-
* @tags
|
|
5691
|
-
* @name
|
|
5692
|
-
* @summary get
|
|
5693
|
-
* @request GET:/
|
|
5694
|
-
* @originalName getPreIpoCompanyFundingRounds
|
|
5695
|
-
* @duplicate
|
|
5738
|
+
* @description get fund screener filters
|
|
5739
|
+
* @tags Funds
|
|
5740
|
+
* @name GetScreenerFilters
|
|
5741
|
+
* @summary get fund screener filters
|
|
5742
|
+
* @request GET:/funds/screener/filters
|
|
5696
5743
|
* @secure
|
|
5697
5744
|
*/
|
|
5698
|
-
|
|
5745
|
+
getScreenerFilters(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundScreenerFiltersResponse, HandleError, Format>>;
|
|
5699
5746
|
/**
|
|
5700
|
-
* @description get
|
|
5701
|
-
* @tags
|
|
5702
|
-
* @name
|
|
5703
|
-
* @summary get
|
|
5704
|
-
* @request GET:/
|
|
5747
|
+
* @description get fund screener presets
|
|
5748
|
+
* @tags Funds
|
|
5749
|
+
* @name GetFundScreenerPresets
|
|
5750
|
+
* @summary get fund screener presets
|
|
5751
|
+
* @request GET:/funds/screener/presets
|
|
5705
5752
|
* @secure
|
|
5706
5753
|
*/
|
|
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 */
|
|
5754
|
+
getFundScreenerPresets(query: {
|
|
5755
|
+
/** how many records to return */
|
|
5713
5756
|
limit: number;
|
|
5714
5757
|
/** how many records to skip */
|
|
5715
5758
|
offset: number;
|
|
5716
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5759
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError, Format>>;
|
|
5717
5760
|
/**
|
|
5718
|
-
* @description
|
|
5719
|
-
* @tags
|
|
5720
|
-
* @name
|
|
5721
|
-
* @summary
|
|
5722
|
-
* @request
|
|
5723
|
-
* @originalName getPreIpoCompanyInvestments
|
|
5724
|
-
* @duplicate
|
|
5761
|
+
* @description update fund screener preset
|
|
5762
|
+
* @tags Funds
|
|
5763
|
+
* @name UpdateFundScreenerPreset
|
|
5764
|
+
* @summary update fund screener preset
|
|
5765
|
+
* @request PUT:/funds/screener/presets
|
|
5725
5766
|
* @secure
|
|
5726
5767
|
*/
|
|
5727
|
-
|
|
5768
|
+
updateFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError, Format>>;
|
|
5728
5769
|
/**
|
|
5729
|
-
* @description
|
|
5730
|
-
* @tags
|
|
5731
|
-
* @name
|
|
5732
|
-
* @summary
|
|
5733
|
-
* @request
|
|
5770
|
+
* @description create fund screener preset
|
|
5771
|
+
* @tags Funds
|
|
5772
|
+
* @name CreateFundScreenerPreset
|
|
5773
|
+
* @summary create fund screener preset
|
|
5774
|
+
* @request POST:/funds/screener/presets
|
|
5734
5775
|
* @secure
|
|
5735
5776
|
*/
|
|
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>>;
|
|
5777
|
+
createFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError, Format>>;
|
|
5746
5778
|
/**
|
|
5747
|
-
* @description
|
|
5748
|
-
* @tags
|
|
5749
|
-
* @name
|
|
5750
|
-
* @summary
|
|
5751
|
-
* @request
|
|
5752
|
-
* @originalName getPreIpoCompanyNews
|
|
5753
|
-
* @duplicate
|
|
5779
|
+
* @description remove fund screener preset
|
|
5780
|
+
* @tags Funds
|
|
5781
|
+
* @name RemoveFundScreenerPreset
|
|
5782
|
+
* @summary remove fund screener preset
|
|
5783
|
+
* @request DELETE:/funds/screener/presets
|
|
5754
5784
|
* @secure
|
|
5755
5785
|
*/
|
|
5756
|
-
|
|
5786
|
+
removeFundScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
5757
5787
|
/**
|
|
5758
|
-
* @description
|
|
5759
|
-
* @tags
|
|
5760
|
-
* @name
|
|
5761
|
-
* @summary
|
|
5762
|
-
* @request
|
|
5788
|
+
* @description filter funds by params
|
|
5789
|
+
* @tags Funds
|
|
5790
|
+
* @name FundSectorScreener
|
|
5791
|
+
* @summary filter funds by params
|
|
5792
|
+
* @request POST:/funds/sector-screener
|
|
5763
5793
|
* @secure
|
|
5764
5794
|
*/
|
|
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>>;
|
|
5795
|
+
fundSectorScreener(filter: InsightFundSectorScreenerRequest, headers?: {
|
|
5796
|
+
/** Authorization */
|
|
5797
|
+
Authorization?: string;
|
|
5798
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError, Format>>;
|
|
5779
5799
|
/**
|
|
5780
|
-
* @description get
|
|
5781
|
-
* @tags
|
|
5782
|
-
* @name
|
|
5783
|
-
* @summary get
|
|
5784
|
-
* @request
|
|
5785
|
-
* @originalName getPreIpoCompanyResearchDocuments
|
|
5786
|
-
* @duplicate
|
|
5800
|
+
* @description get top funds
|
|
5801
|
+
* @tags Funds
|
|
5802
|
+
* @name GetTopFunds
|
|
5803
|
+
* @summary get top funds
|
|
5804
|
+
* @request POST:/funds/top
|
|
5787
5805
|
* @secure
|
|
5788
5806
|
*/
|
|
5789
|
-
|
|
5807
|
+
getTopFunds(filter: InsightGetTopFundsRequest, headers?: {
|
|
5808
|
+
/** Authorization */
|
|
5809
|
+
Authorization?: string;
|
|
5810
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError, Format>>;
|
|
5790
5811
|
/**
|
|
5791
|
-
* @description get
|
|
5792
|
-
* @tags
|
|
5793
|
-
* @name
|
|
5794
|
-
* @summary get
|
|
5795
|
-
* @request GET:/
|
|
5812
|
+
* @description get fund by symbol
|
|
5813
|
+
* @tags Funds
|
|
5814
|
+
* @name GetFund
|
|
5815
|
+
* @summary get fund by symbol
|
|
5816
|
+
* @request GET:/funds/{symbol}
|
|
5796
5817
|
* @secure
|
|
5797
5818
|
*/
|
|
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>>;
|
|
5819
|
+
getFund(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundWithDetails, HandleError, Format>>;
|
|
5820
|
+
}
|
|
5821
|
+
export class Intraday<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
5822
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
5823
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
5818
5824
|
/**
|
|
5819
|
-
* @description
|
|
5820
|
-
* @tags
|
|
5821
|
-
* @name
|
|
5822
|
-
* @summary
|
|
5823
|
-
* @request
|
|
5824
|
-
* @originalName getInvestor
|
|
5825
|
-
* @duplicate
|
|
5825
|
+
* @description Returns an array of intraday chart data values for the given ticker.
|
|
5826
|
+
* @tags Intraday
|
|
5827
|
+
* @name IntradayQuotes
|
|
5828
|
+
* @summary Get an array of intraday chart data values for the given ticker
|
|
5829
|
+
* @request POST:/intraday/quotes
|
|
5826
5830
|
* @secure
|
|
5827
5831
|
*/
|
|
5828
|
-
|
|
5829
|
-
|
|
5830
|
-
|
|
5831
|
-
|
|
5832
|
+
intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError, Format>>;
|
|
5833
|
+
}
|
|
5834
|
+
export class Ipos<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
5835
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
5836
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
5832
5837
|
/**
|
|
5833
|
-
* @description get
|
|
5834
|
-
* @tags
|
|
5835
|
-
* @name
|
|
5836
|
-
* @summary get
|
|
5837
|
-
* @request
|
|
5838
|
+
* @description get recent ipos info
|
|
5839
|
+
* @tags Ipos
|
|
5840
|
+
* @name PostRecent
|
|
5841
|
+
* @summary get recent ipos info
|
|
5842
|
+
* @request POST:/ipos/recent
|
|
5838
5843
|
* @secure
|
|
5839
5844
|
*/
|
|
5840
|
-
|
|
5841
|
-
|
|
5842
|
-
|
|
5843
|
-
|
|
5844
|
-
|
|
5845
|
-
|
|
5846
|
-
|
|
5847
|
-
|
|
5848
|
-
|
|
5845
|
+
postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError, Format>>;
|
|
5846
|
+
/**
|
|
5847
|
+
* @description get upcoming ipos info
|
|
5848
|
+
* @tags Ipos
|
|
5849
|
+
* @name GetUpcoming
|
|
5850
|
+
* @summary get upcoming ipos info
|
|
5851
|
+
* @request GET:/ipos/upcoming
|
|
5852
|
+
* @secure
|
|
5853
|
+
*/
|
|
5854
|
+
getUpcoming(query: {
|
|
5849
5855
|
/** how many records to return. Max value is 50 */
|
|
5850
5856
|
limit: number;
|
|
5851
5857
|
/** how many records to skip */
|
|
5852
5858
|
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>>;
|
|
5859
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError, Format>>;
|
|
5860
5860
|
/**
|
|
5861
|
-
* @description get
|
|
5862
|
-
* @tags
|
|
5863
|
-
* @name
|
|
5864
|
-
* @summary get
|
|
5865
|
-
* @request GET:/ipos/
|
|
5866
|
-
* @originalName getPreIpoCompanySpvs
|
|
5867
|
-
* @duplicate
|
|
5861
|
+
* @description get ipo info by symbol
|
|
5862
|
+
* @tags Ipos
|
|
5863
|
+
* @name GetIpos
|
|
5864
|
+
* @summary get ipo info by symbol
|
|
5865
|
+
* @request GET:/ipos/{symbol}
|
|
5868
5866
|
* @secure
|
|
5869
|
-
*/
|
|
5870
|
-
|
|
5871
|
-
/**
|
|
5872
|
-
|
|
5873
|
-
|
|
5867
|
+
*/
|
|
5868
|
+
getIpos(symbol: string, query?: {
|
|
5869
|
+
/** load quotes */
|
|
5870
|
+
load_quotes?: boolean;
|
|
5871
|
+
/** statuses */
|
|
5872
|
+
statuses?: string[];
|
|
5873
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError, Format>>;
|
|
5874
5874
|
}
|
|
5875
|
-
export class Logos<HandleError extends boolean = boolean> {
|
|
5876
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5877
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5875
|
+
export class Logos<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
5876
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
5877
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
5878
5878
|
/**
|
|
5879
5879
|
* @description Returns converted logo for crypto symbol
|
|
5880
5880
|
* @tags Logos
|
|
@@ -5883,7 +5883,7 @@ export class Logos<HandleError extends boolean = boolean> {
|
|
|
5883
5883
|
* @request POST:/logos/converted-crypto-symbol-logo
|
|
5884
5884
|
* @secure
|
|
5885
5885
|
*/
|
|
5886
|
-
logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5886
|
+
logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError, Format>>;
|
|
5887
5887
|
/**
|
|
5888
5888
|
* @description Returns converted logo for symbol
|
|
5889
5889
|
* @tags Logos
|
|
@@ -5892,7 +5892,7 @@ export class Logos<HandleError extends boolean = boolean> {
|
|
|
5892
5892
|
* @request POST:/logos/converted-symbol-logo
|
|
5893
5893
|
* @secure
|
|
5894
5894
|
*/
|
|
5895
|
-
logosConvertedSymbolLogo(filter: InsightSymbolLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5895
|
+
logosConvertedSymbolLogo(filter: InsightSymbolLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError, Format>>;
|
|
5896
5896
|
/**
|
|
5897
5897
|
* @description Returns logo for crypto symbol
|
|
5898
5898
|
* @tags Logos
|
|
@@ -5904,7 +5904,7 @@ export class Logos<HandleError extends boolean = boolean> {
|
|
|
5904
5904
|
logosCryptoSymbolLogo(query: {
|
|
5905
5905
|
/** Company symbol */
|
|
5906
5906
|
symbol: string;
|
|
5907
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError>>;
|
|
5907
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError, Format>>;
|
|
5908
5908
|
/**
|
|
5909
5909
|
* @description Returns direct logo for crypto symbol
|
|
5910
5910
|
* @tags Logos
|
|
@@ -5916,7 +5916,7 @@ export class Logos<HandleError extends boolean = boolean> {
|
|
|
5916
5916
|
logosDirectCryptoSymbolLogo(query: {
|
|
5917
5917
|
/** Company symbol */
|
|
5918
5918
|
symbol: string;
|
|
5919
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5919
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError, Format>>;
|
|
5920
5920
|
/**
|
|
5921
5921
|
* @description Returns direct logo for symbol
|
|
5922
5922
|
* @tags Logos
|
|
@@ -5928,7 +5928,7 @@ export class Logos<HandleError extends boolean = boolean> {
|
|
|
5928
5928
|
logosDirectSymbolLogo(query: {
|
|
5929
5929
|
/** Company symbol */
|
|
5930
5930
|
symbol: string;
|
|
5931
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5931
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError, Format>>;
|
|
5932
5932
|
/**
|
|
5933
5933
|
* @description Returns logos for multiple symbols
|
|
5934
5934
|
* @tags Logos
|
|
@@ -5937,7 +5937,7 @@ export class Logos<HandleError extends boolean = boolean> {
|
|
|
5937
5937
|
* @request POST:/logos/multiple-crypto-symbol-logo
|
|
5938
5938
|
* @secure
|
|
5939
5939
|
*/
|
|
5940
|
-
logosMultipleCryptoSymbolLogo(filter: InsightMultipleCryptoLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse[], HandleError>>;
|
|
5940
|
+
logosMultipleCryptoSymbolLogo(filter: InsightMultipleCryptoLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse[], HandleError, Format>>;
|
|
5941
5941
|
/**
|
|
5942
5942
|
* @description Returns logos for multiple symbol
|
|
5943
5943
|
* @tags Logos
|
|
@@ -5946,7 +5946,7 @@ export class Logos<HandleError extends boolean = boolean> {
|
|
|
5946
5946
|
* @request POST:/logos/multiple-symbol-logos
|
|
5947
5947
|
* @secure
|
|
5948
5948
|
*/
|
|
5949
|
-
logosMultipleSymbolLogos(filter: InsightMultipleSymbolLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse[], HandleError>>;
|
|
5949
|
+
logosMultipleSymbolLogos(filter: InsightMultipleSymbolLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse[], HandleError, Format>>;
|
|
5950
5950
|
/**
|
|
5951
5951
|
* @description Returns links of socials logos for symbol
|
|
5952
5952
|
* @tags Logos
|
|
@@ -5958,7 +5958,7 @@ export class Logos<HandleError extends boolean = boolean> {
|
|
|
5958
5958
|
logosSocialSymbolLogos(query: {
|
|
5959
5959
|
/** Company symbol */
|
|
5960
5960
|
symbol: string;
|
|
5961
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
|
|
5961
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError, Format>>;
|
|
5962
5962
|
/**
|
|
5963
5963
|
* @description Returns logos for company symbol
|
|
5964
5964
|
* @tags Logos
|
|
@@ -5970,52 +5970,11 @@ export class Logos<HandleError extends boolean = boolean> {
|
|
|
5970
5970
|
logosSymbolLogos(query: {
|
|
5971
5971
|
/** Company symbol */
|
|
5972
5972
|
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>>;
|
|
5973
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError, Format>>;
|
|
6015
5974
|
}
|
|
6016
|
-
export class MarketDates<HandleError extends boolean = boolean> {
|
|
6017
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6018
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5975
|
+
export class MarketDates<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
5976
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
5977
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
6019
5978
|
/**
|
|
6020
5979
|
* @description Create or update market date
|
|
6021
5980
|
* @tags MarketDates
|
|
@@ -6024,7 +5983,7 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
6024
5983
|
* @request POST:/market-dates
|
|
6025
5984
|
* @secure
|
|
6026
5985
|
*/
|
|
6027
|
-
createOrUpdateMarketDate(market: InsightMarketDates[], config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketDate[], HandleError>>;
|
|
5986
|
+
createOrUpdateMarketDate(market: InsightMarketDates[], config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketDate[], HandleError, Format>>;
|
|
6028
5987
|
/**
|
|
6029
5988
|
* @description Remove market date
|
|
6030
5989
|
* @tags MarketDates
|
|
@@ -6033,7 +5992,7 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
6033
5992
|
* @request DELETE:/market-dates
|
|
6034
5993
|
* @secure
|
|
6035
5994
|
*/
|
|
6036
|
-
removeMarketDate(input: InsightRemoveMarketDateRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5995
|
+
removeMarketDate(input: InsightRemoveMarketDateRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
6037
5996
|
/**
|
|
6038
5997
|
* @description Get market dates history
|
|
6039
5998
|
* @tags MarketDates
|
|
@@ -6042,7 +6001,7 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
6042
6001
|
* @request POST:/market-dates/history
|
|
6043
6002
|
* @secure
|
|
6044
6003
|
*/
|
|
6045
|
-
getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
|
|
6004
|
+
getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError, Format>>;
|
|
6046
6005
|
/**
|
|
6047
6006
|
* @description Search locode data by search string and field
|
|
6048
6007
|
* @tags MarketDates
|
|
@@ -6056,7 +6015,7 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
6056
6015
|
search?: string;
|
|
6057
6016
|
/** Search field */
|
|
6058
6017
|
field?: InsightSearchLocodeDataParamsFieldEnum;
|
|
6059
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSearchLocodeDataResponse, HandleError>>;
|
|
6018
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSearchLocodeDataResponse, HandleError, Format>>;
|
|
6060
6019
|
/**
|
|
6061
6020
|
* @description Get markets
|
|
6062
6021
|
* @tags MarketDates
|
|
@@ -6065,7 +6024,7 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
6065
6024
|
* @request GET:/market-dates/markets
|
|
6066
6025
|
* @secure
|
|
6067
6026
|
*/
|
|
6068
|
-
getMarkets(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketsResponse, HandleError>>;
|
|
6027
|
+
getMarkets(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketsResponse, HandleError, Format>>;
|
|
6069
6028
|
/**
|
|
6070
6029
|
* @description Create or update market
|
|
6071
6030
|
* @tags MarketDates
|
|
@@ -6074,7 +6033,7 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
6074
6033
|
* @request POST:/market-dates/markets
|
|
6075
6034
|
* @secure
|
|
6076
6035
|
*/
|
|
6077
|
-
createOrUpdateMarket(market: InsightCreateOrUpdateMarketRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarket, HandleError>>;
|
|
6036
|
+
createOrUpdateMarket(market: InsightCreateOrUpdateMarketRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarket, HandleError, Format>>;
|
|
6078
6037
|
/**
|
|
6079
6038
|
* @description Get market
|
|
6080
6039
|
* @tags MarketDates
|
|
@@ -6083,7 +6042,7 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
6083
6042
|
* @request GET:/market-dates/markets/{market}
|
|
6084
6043
|
* @secure
|
|
6085
6044
|
*/
|
|
6086
|
-
getMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketWithSchedule, HandleError>>;
|
|
6045
|
+
getMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketWithSchedule, HandleError, Format>>;
|
|
6087
6046
|
/**
|
|
6088
6047
|
* @description Remove market
|
|
6089
6048
|
* @tags MarketDates
|
|
@@ -6092,7 +6051,7 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
6092
6051
|
* @request DELETE:/market-dates/markets/{market}
|
|
6093
6052
|
* @secure
|
|
6094
6053
|
*/
|
|
6095
|
-
removeMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6054
|
+
removeMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
6096
6055
|
/**
|
|
6097
6056
|
* @description Get market schedules
|
|
6098
6057
|
* @tags MarketDates
|
|
@@ -6104,7 +6063,7 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
6104
6063
|
getMarketSchedules(query?: {
|
|
6105
6064
|
/** Market codes, comma separated */
|
|
6106
6065
|
market?: string;
|
|
6107
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse[][], HandleError>>;
|
|
6066
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse[][], HandleError, Format>>;
|
|
6108
6067
|
/**
|
|
6109
6068
|
* @description CreateOrUpdateMarketSchedule market schedule
|
|
6110
6069
|
* @tags MarketDates
|
|
@@ -6113,7 +6072,7 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
6113
6072
|
* @request POST:/market-dates/schedule
|
|
6114
6073
|
* @secure
|
|
6115
6074
|
*/
|
|
6116
|
-
createOrUpdateMarketSchedule(market: InsightCreateOrUpdateMarketScheduleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
|
|
6075
|
+
createOrUpdateMarketSchedule(market: InsightCreateOrUpdateMarketScheduleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError, Format>>;
|
|
6117
6076
|
/**
|
|
6118
6077
|
* @description Get market schedule
|
|
6119
6078
|
* @tags MarketDates
|
|
@@ -6122,7 +6081,7 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
6122
6081
|
* @request GET:/market-dates/schedule/{market}
|
|
6123
6082
|
* @secure
|
|
6124
6083
|
*/
|
|
6125
|
-
getMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
|
|
6084
|
+
getMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError, Format>>;
|
|
6126
6085
|
/**
|
|
6127
6086
|
* @description Remove market schedule
|
|
6128
6087
|
* @tags MarketDates
|
|
@@ -6131,7 +6090,7 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
6131
6090
|
* @request DELETE:/market-dates/schedule/{market}
|
|
6132
6091
|
* @secure
|
|
6133
6092
|
*/
|
|
6134
|
-
removeMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6093
|
+
removeMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
6135
6094
|
/**
|
|
6136
6095
|
* @description Get todays market hours
|
|
6137
6096
|
* @tags MarketDates
|
|
@@ -6143,11 +6102,11 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
6143
6102
|
getTodaysMarketHours(query: {
|
|
6144
6103
|
/** Market */
|
|
6145
6104
|
market: string;
|
|
6146
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
|
|
6105
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError, Format>>;
|
|
6147
6106
|
}
|
|
6148
|
-
export class News<HandleError extends boolean = boolean> {
|
|
6149
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6150
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6107
|
+
export class News<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
6108
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
6109
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
6151
6110
|
/**
|
|
6152
6111
|
* @description Returns available authors in DB
|
|
6153
6112
|
* @tags News
|
|
@@ -6156,7 +6115,7 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
6156
6115
|
* @request POST:/news/authors
|
|
6157
6116
|
* @secure
|
|
6158
6117
|
*/
|
|
6159
|
-
newsAvailableAuthors(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
6118
|
+
newsAvailableAuthors(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError, Format>>;
|
|
6160
6119
|
/**
|
|
6161
6120
|
* @description Returns available channels in DB
|
|
6162
6121
|
* @tags News
|
|
@@ -6165,7 +6124,7 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
6165
6124
|
* @request POST:/news/channels
|
|
6166
6125
|
* @secure
|
|
6167
6126
|
*/
|
|
6168
|
-
newsAvailableChannels(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
6127
|
+
newsAvailableChannels(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError, Format>>;
|
|
6169
6128
|
/**
|
|
6170
6129
|
* @description Get featured articles
|
|
6171
6130
|
* @tags News
|
|
@@ -6183,7 +6142,7 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
6183
6142
|
start_date?: string;
|
|
6184
6143
|
/** End date */
|
|
6185
6144
|
end_date?: string;
|
|
6186
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
|
|
6145
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError, Format>>;
|
|
6187
6146
|
/**
|
|
6188
6147
|
* @description Update featured articles
|
|
6189
6148
|
* @tags News
|
|
@@ -6192,7 +6151,7 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
6192
6151
|
* @request PUT:/news/featured-articles
|
|
6193
6152
|
* @secure
|
|
6194
6153
|
*/
|
|
6195
|
-
updateFeaturedArticles(input: InsightUpdateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6154
|
+
updateFeaturedArticles(input: InsightUpdateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
6196
6155
|
/**
|
|
6197
6156
|
* @description Create featured articles
|
|
6198
6157
|
* @tags News
|
|
@@ -6201,7 +6160,7 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
6201
6160
|
* @request POST:/news/featured-articles
|
|
6202
6161
|
* @secure
|
|
6203
6162
|
*/
|
|
6204
|
-
createFeaturedArticles(input: InsightCreateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6163
|
+
createFeaturedArticles(input: InsightCreateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
6205
6164
|
/**
|
|
6206
6165
|
* @description Get active featured articles
|
|
6207
6166
|
* @tags News
|
|
@@ -6210,7 +6169,23 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
6210
6169
|
* @request GET:/news/featured-articles/active
|
|
6211
6170
|
* @secure
|
|
6212
6171
|
*/
|
|
6213
|
-
getActiveFeaturedArticles(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
|
|
6172
|
+
getActiveFeaturedArticles(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError, Format>>;
|
|
6173
|
+
/**
|
|
6174
|
+
* @description Get featured article config
|
|
6175
|
+
* @tags News
|
|
6176
|
+
* @name GetFeaturedArticleConfig
|
|
6177
|
+
* @summary Get featured article config
|
|
6178
|
+
* @request GET:/news/featured-articles/configs
|
|
6179
|
+
*/
|
|
6180
|
+
getFeaturedArticleConfig(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticleConfig, HandleError, Format>>;
|
|
6181
|
+
/**
|
|
6182
|
+
* @description Create featured article config
|
|
6183
|
+
* @tags News
|
|
6184
|
+
* @name CreateFeaturedArticleConfig
|
|
6185
|
+
* @summary Create featured article config
|
|
6186
|
+
* @request POST:/news/featured-articles/configs
|
|
6187
|
+
*/
|
|
6188
|
+
createFeaturedArticleConfig(input: InsightCreateFeaturedArticleConfigRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticleConfig, HandleError, Format>>;
|
|
6214
6189
|
/**
|
|
6215
6190
|
* @description Set featured articles
|
|
6216
6191
|
* @tags News
|
|
@@ -6219,7 +6194,7 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
6219
6194
|
* @request POST:/news/featured-articles/set
|
|
6220
6195
|
* @secure
|
|
6221
6196
|
*/
|
|
6222
|
-
setFeaturedArticles(input: InsightSetFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6197
|
+
setFeaturedArticles(input: InsightSetFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
6223
6198
|
/**
|
|
6224
6199
|
* @description Get featured article
|
|
6225
6200
|
* @tags News
|
|
@@ -6228,7 +6203,7 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
6228
6203
|
* @request GET:/news/featured-articles/{id}
|
|
6229
6204
|
* @secure
|
|
6230
6205
|
*/
|
|
6231
|
-
getFeaturedArticle(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticle, HandleError>>;
|
|
6206
|
+
getFeaturedArticle(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticle, HandleError, Format>>;
|
|
6232
6207
|
/**
|
|
6233
6208
|
* @description Returns news by filters
|
|
6234
6209
|
* @tags News
|
|
@@ -6237,7 +6212,7 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
6237
6212
|
* @request POST:/news/filter
|
|
6238
6213
|
* @secure
|
|
6239
6214
|
*/
|
|
6240
|
-
newsFiltered(filter: InsightNewsFilterRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsResponse, HandleError>>;
|
|
6215
|
+
newsFiltered(filter: InsightNewsFilterRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsResponse, HandleError, Format>>;
|
|
6241
6216
|
/**
|
|
6242
6217
|
* @description Returns news by id
|
|
6243
6218
|
* @tags News
|
|
@@ -6246,7 +6221,7 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
6246
6221
|
* @request POST:/news/id
|
|
6247
6222
|
* @secure
|
|
6248
6223
|
*/
|
|
6249
|
-
newsById(filter: InsightNewsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNews, HandleError>>;
|
|
6224
|
+
newsById(filter: InsightNewsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNews, HandleError, Format>>;
|
|
6250
6225
|
/**
|
|
6251
6226
|
* @description Returns news previews
|
|
6252
6227
|
* @tags News
|
|
@@ -6266,7 +6241,7 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
6266
6241
|
limit: number;
|
|
6267
6242
|
/** how many records to skip */
|
|
6268
6243
|
offset: number;
|
|
6269
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRecentNewsPreviewsResponse, HandleError>>;
|
|
6244
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRecentNewsPreviewsResponse, HandleError, Format>>;
|
|
6270
6245
|
/**
|
|
6271
6246
|
* @description Returns available stocks in DB
|
|
6272
6247
|
* @tags News
|
|
@@ -6282,7 +6257,7 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
6282
6257
|
offset?: number;
|
|
6283
6258
|
/** search query */
|
|
6284
6259
|
search_query?: string;
|
|
6285
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
6260
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError, Format>>;
|
|
6286
6261
|
/**
|
|
6287
6262
|
* @description Returns available tags in DB
|
|
6288
6263
|
* @tags News
|
|
@@ -6291,11 +6266,11 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
6291
6266
|
* @request POST:/news/tags
|
|
6292
6267
|
* @secure
|
|
6293
6268
|
*/
|
|
6294
|
-
newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
6269
|
+
newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError, Format>>;
|
|
6295
6270
|
}
|
|
6296
|
-
export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
6297
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6298
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6271
|
+
export class OptionGreeks<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
6272
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
6273
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
6299
6274
|
/**
|
|
6300
6275
|
* @description Returns calculated matrix
|
|
6301
6276
|
* @tags OptionGreeks
|
|
@@ -6304,78 +6279,387 @@ export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
|
6304
6279
|
* @request POST:/og/calculate-matrix
|
|
6305
6280
|
* @secure
|
|
6306
6281
|
*/
|
|
6307
|
-
ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
|
|
6282
|
+
ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError, Format>>;
|
|
6283
|
+
/**
|
|
6284
|
+
* @description Returns calculated params
|
|
6285
|
+
* @tags OptionGreeks
|
|
6286
|
+
* @name OgCalculateParams
|
|
6287
|
+
* @summary Calculate params
|
|
6288
|
+
* @request POST:/og/calculate-params
|
|
6289
|
+
* @secure
|
|
6290
|
+
*/
|
|
6291
|
+
ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError, Format>>;
|
|
6292
|
+
}
|
|
6293
|
+
export class Ownerships<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
6294
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
6295
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
6296
|
+
/**
|
|
6297
|
+
* @description get ownerships by id datadata
|
|
6298
|
+
* @tags Ownerships
|
|
6299
|
+
* @name GetOwnershipsByIdData
|
|
6300
|
+
* @summary get ownerships by id data
|
|
6301
|
+
* @request POST:/ownerships
|
|
6302
|
+
* @secure
|
|
6303
|
+
*/
|
|
6304
|
+
getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError, Format>>;
|
|
6305
|
+
/**
|
|
6306
|
+
* @description get ownerships by symbol data
|
|
6307
|
+
* @tags Ownerships
|
|
6308
|
+
* @name GetOwnershipsBySymbolData
|
|
6309
|
+
* @summary get ownerships by symbol data
|
|
6310
|
+
* @request POST:/symbol-ownerships
|
|
6311
|
+
* @secure
|
|
6312
|
+
*/
|
|
6313
|
+
getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError, Format>>;
|
|
6314
|
+
}
|
|
6315
|
+
export class Passport<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
6316
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
6317
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
6318
|
+
/**
|
|
6319
|
+
* @description Returns article by id
|
|
6320
|
+
* @tags Passport
|
|
6321
|
+
* @name PassportArticleById
|
|
6322
|
+
* @summary Get article by id
|
|
6323
|
+
* @request POST:/passport/article-by-id
|
|
6324
|
+
* @secure
|
|
6325
|
+
*/
|
|
6326
|
+
passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError, Format>>;
|
|
6327
|
+
/**
|
|
6328
|
+
* @description Returns articles
|
|
6329
|
+
* @tags Passport
|
|
6330
|
+
* @name PassportArticles
|
|
6331
|
+
* @summary Get articles
|
|
6332
|
+
* @request POST:/passport/articles
|
|
6333
|
+
* @secure
|
|
6334
|
+
*/
|
|
6335
|
+
passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError, Format>>;
|
|
6336
|
+
/**
|
|
6337
|
+
* @description Returns author profile
|
|
6338
|
+
* @tags Passport
|
|
6339
|
+
* @name PassportAuthorProfile
|
|
6340
|
+
* @summary Get author profile
|
|
6341
|
+
* @request POST:/passport/author-profile
|
|
6342
|
+
* @secure
|
|
6343
|
+
*/
|
|
6344
|
+
passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError, Format>>;
|
|
6345
|
+
/**
|
|
6346
|
+
* @description Returns most popular tags
|
|
6347
|
+
* @tags Passport
|
|
6348
|
+
* @name PassportMostPopularTags
|
|
6349
|
+
* @summary Get most popular tags
|
|
6350
|
+
* @request POST:/passport/most-popular-tags
|
|
6351
|
+
* @secure
|
|
6352
|
+
*/
|
|
6353
|
+
passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError, Format>>;
|
|
6354
|
+
/**
|
|
6355
|
+
* @description Returns news feed
|
|
6356
|
+
* @tags Passport
|
|
6357
|
+
* @name PassportNewsFeed
|
|
6358
|
+
* @summary Get news feed
|
|
6359
|
+
* @request POST:/passport/newsfeed
|
|
6360
|
+
* @secure
|
|
6361
|
+
*/
|
|
6362
|
+
passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError, Format>>;
|
|
6363
|
+
/**
|
|
6364
|
+
* @description Returns article by parameters
|
|
6365
|
+
* @tags Passport
|
|
6366
|
+
* @name PassportSearchArticle
|
|
6367
|
+
* @summary Search article by parameters
|
|
6368
|
+
* @request POST:/passport/search-article
|
|
6369
|
+
* @secure
|
|
6370
|
+
*/
|
|
6371
|
+
passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError, Format>>;
|
|
6372
|
+
}
|
|
6373
|
+
export class PreIpoCompanies<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
6374
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
6375
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
6376
|
+
/**
|
|
6377
|
+
* @description Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
|
|
6378
|
+
* @tags PreIPOCompanies
|
|
6379
|
+
* @name MonarkOghlcDataForSymbol
|
|
6380
|
+
* @summary Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
|
|
6381
|
+
* @request GET:/ipos/market-data/ohlc/{symbol}
|
|
6382
|
+
* @secure
|
|
6383
|
+
*/
|
|
6384
|
+
monarkOghlcDataForSymbol(symbol: string, query?: {
|
|
6385
|
+
/** Start time for the OHLC data in ISO 8601 format YYYY-MM-DD */
|
|
6386
|
+
from?: string;
|
|
6387
|
+
/** End time for the OHLC data in ISO 8601 format YYYY-MM-DD */
|
|
6388
|
+
to?: string;
|
|
6389
|
+
/** Time interval for buckets: 1d (day), 1w (week), 1mo (month), 3mo (3 months). Default is 1d. */
|
|
6390
|
+
interval?: string;
|
|
6391
|
+
/** Limit the number of OHLC data points returned. Default is 100. */
|
|
6392
|
+
limit?: number;
|
|
6393
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<{
|
|
6394
|
+
close?: number;
|
|
6395
|
+
high?: number;
|
|
6396
|
+
low?: number;
|
|
6397
|
+
open?: number;
|
|
6398
|
+
time?: string;
|
|
6399
|
+
volume?: number;
|
|
6400
|
+
}[], HandleError, Format>>;
|
|
6401
|
+
/**
|
|
6402
|
+
* @description Retrieves all symbols available in the market data
|
|
6403
|
+
* @tags PreIPOCompanies
|
|
6404
|
+
* @name MonarkAllAvailableSymbols
|
|
6405
|
+
* @summary Retrieves all symbols available in the market data
|
|
6406
|
+
* @request GET:/ipos/market-data/symbols
|
|
6407
|
+
* @secure
|
|
6408
|
+
*/
|
|
6409
|
+
monarkAllAvailableSymbols(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError, Format>>;
|
|
6410
|
+
/**
|
|
6411
|
+
* @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
|
|
6412
|
+
* @tags PreIPOCompanies
|
|
6413
|
+
* @name GetPreIpoCompanies
|
|
6414
|
+
* @summary get pre ipo companies
|
|
6415
|
+
* @request GET:/ipos/pre-ipo-companies
|
|
6416
|
+
* @secure
|
|
6417
|
+
*/
|
|
6418
|
+
getPreIpoCompanies(query: {
|
|
6419
|
+
/** search by company name */
|
|
6420
|
+
name?: string;
|
|
6421
|
+
/** search by categories */
|
|
6422
|
+
categories?: string;
|
|
6423
|
+
/** search by listing type */
|
|
6424
|
+
listing_type?: string;
|
|
6425
|
+
/** filter by active status */
|
|
6426
|
+
is_active?: InsightGetPreIpoCompaniesParamsIsActiveEnum;
|
|
6427
|
+
/** filter by minimum last valuation */
|
|
6428
|
+
min_last_valuation?: number;
|
|
6429
|
+
/** filter by maximum last valuation */
|
|
6430
|
+
max_last_valuation?: number;
|
|
6431
|
+
/** filter by minimum total funding */
|
|
6432
|
+
min_total_funding?: number;
|
|
6433
|
+
/** filter by maximum total funding */
|
|
6434
|
+
max_total_funding?: number;
|
|
6435
|
+
/** how many records to return. Max value is 50 */
|
|
6436
|
+
limit: number;
|
|
6437
|
+
/** how many records to skip */
|
|
6438
|
+
offset: number;
|
|
6439
|
+
/** sort field */
|
|
6440
|
+
order_field?: InsightGetPreIpoCompaniesParamsOrderFieldEnum;
|
|
6441
|
+
/** sort direction */
|
|
6442
|
+
order_direction?: InsightGetPreIpoCompaniesParamsOrderDirectionEnum;
|
|
6443
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError, Format>>;
|
|
6444
|
+
/**
|
|
6445
|
+
* @description get pre ipo company by id
|
|
6446
|
+
* @tags PreIPOCompanies
|
|
6447
|
+
* @name GetPreIpoCompaniesById
|
|
6448
|
+
* @summary get pre ipo company by id
|
|
6449
|
+
* @request GET:/ipos/pre-ipo-companies/{id}
|
|
6450
|
+
* @originalName getPreIpoCompanies
|
|
6451
|
+
* @duplicate
|
|
6452
|
+
* @secure
|
|
6453
|
+
*/
|
|
6454
|
+
getPreIpoCompaniesById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompany, HandleError, Format>>;
|
|
6455
|
+
/**
|
|
6456
|
+
* @description get pre ipo company funding rounds
|
|
6457
|
+
* @tags PreIPOCompanies
|
|
6458
|
+
* @name GetPreIpoCompanyFundingRounds
|
|
6459
|
+
* @summary get pre ipo company funding rounds
|
|
6460
|
+
* @request GET:/ipos/pre-ipo-company-funding-rounds
|
|
6461
|
+
* @secure
|
|
6462
|
+
*/
|
|
6463
|
+
getPreIpoCompanyFundingRounds(query: {
|
|
6464
|
+
/** company id */
|
|
6465
|
+
pre_ipo_company_id?: string;
|
|
6466
|
+
/** search by round name */
|
|
6467
|
+
round_name?: string;
|
|
6468
|
+
/** how many records to return. Max value is 50 */
|
|
6469
|
+
limit: number;
|
|
6470
|
+
/** how many records to skip */
|
|
6471
|
+
offset: number;
|
|
6472
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyFundingRoundsResponse, HandleError, Format>>;
|
|
6473
|
+
/**
|
|
6474
|
+
* @description get pre ipo company funding round by id
|
|
6475
|
+
* @tags PreIPOCompanies
|
|
6476
|
+
* @name GetPreIpoCompanyFundingRoundsById
|
|
6477
|
+
* @summary get pre ipo company funding round by id
|
|
6478
|
+
* @request GET:/ipos/pre-ipo-company-funding-rounds/{id}
|
|
6479
|
+
* @originalName getPreIpoCompanyFundingRounds
|
|
6480
|
+
* @duplicate
|
|
6481
|
+
* @secure
|
|
6482
|
+
*/
|
|
6483
|
+
getPreIpoCompanyFundingRoundsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyFundingRound, HandleError, Format>>;
|
|
6484
|
+
/**
|
|
6485
|
+
* @description get pre ipo company investments
|
|
6486
|
+
* @tags PreIPOCompanies
|
|
6487
|
+
* @name GetPreIpoCompanyInvestments
|
|
6488
|
+
* @summary get pre ipo company investments
|
|
6489
|
+
* @request GET:/ipos/pre-ipo-company-investments
|
|
6490
|
+
* @secure
|
|
6491
|
+
*/
|
|
6492
|
+
getPreIpoCompanyInvestments(query: {
|
|
6493
|
+
/** company id */
|
|
6494
|
+
pre_ipo_company_id?: string;
|
|
6495
|
+
/** company name */
|
|
6496
|
+
company_name?: string;
|
|
6497
|
+
/** how many records to return. Max value is 50 */
|
|
6498
|
+
limit: number;
|
|
6499
|
+
/** how many records to skip */
|
|
6500
|
+
offset: number;
|
|
6501
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyInvestmentsResponse, HandleError, Format>>;
|
|
6502
|
+
/**
|
|
6503
|
+
* @description get pre ipo company investment by id
|
|
6504
|
+
* @tags PreIPOCompanies
|
|
6505
|
+
* @name GetPreIpoCompanyInvestmentsById
|
|
6506
|
+
* @summary get pre ipo company investment by id
|
|
6507
|
+
* @request GET:/ipos/pre-ipo-company-investments/{id}
|
|
6508
|
+
* @originalName getPreIpoCompanyInvestments
|
|
6509
|
+
* @duplicate
|
|
6510
|
+
* @secure
|
|
6511
|
+
*/
|
|
6512
|
+
getPreIpoCompanyInvestmentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyInvestment, HandleError, Format>>;
|
|
6513
|
+
/**
|
|
6514
|
+
* @description get pre ipo company news
|
|
6515
|
+
* @tags PreIPOCompanies
|
|
6516
|
+
* @name GetPreIpoCompanyNews
|
|
6517
|
+
* @summary get pre ipo company news
|
|
6518
|
+
* @request GET:/ipos/pre-ipo-company-news
|
|
6519
|
+
* @secure
|
|
6520
|
+
*/
|
|
6521
|
+
getPreIpoCompanyNews(query: {
|
|
6522
|
+
/** company id */
|
|
6523
|
+
pre_ipo_company_id?: string;
|
|
6524
|
+
/** search by headline */
|
|
6525
|
+
headline?: string;
|
|
6526
|
+
/** how many records to return. Max value is 50 */
|
|
6527
|
+
limit: number;
|
|
6528
|
+
/** how many records to skip */
|
|
6529
|
+
offset: number;
|
|
6530
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyNewsResponse, HandleError, Format>>;
|
|
6308
6531
|
/**
|
|
6309
|
-
* @description
|
|
6310
|
-
* @tags
|
|
6311
|
-
* @name
|
|
6312
|
-
* @summary
|
|
6313
|
-
* @request
|
|
6532
|
+
* @description get pre ipo company news by id
|
|
6533
|
+
* @tags PreIPOCompanies
|
|
6534
|
+
* @name GetPreIpoCompanyNewsById
|
|
6535
|
+
* @summary get pre ipo company news by id
|
|
6536
|
+
* @request GET:/ipos/pre-ipo-company-news/{id}
|
|
6537
|
+
* @originalName getPreIpoCompanyNews
|
|
6538
|
+
* @duplicate
|
|
6314
6539
|
* @secure
|
|
6315
6540
|
*/
|
|
6316
|
-
|
|
6317
|
-
}
|
|
6318
|
-
export class Passport<HandleError extends boolean = boolean> {
|
|
6319
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6320
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6541
|
+
getPreIpoCompanyNewsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyNews, HandleError, Format>>;
|
|
6321
6542
|
/**
|
|
6322
|
-
* @description
|
|
6323
|
-
* @tags
|
|
6324
|
-
* @name
|
|
6325
|
-
* @summary
|
|
6326
|
-
* @request
|
|
6543
|
+
* @description get pre ipo company research documents
|
|
6544
|
+
* @tags PreIPOCompanies
|
|
6545
|
+
* @name GetPreIpoCompanyResearchDocuments
|
|
6546
|
+
* @summary get pre ipo company research documents
|
|
6547
|
+
* @request GET:/ipos/pre-ipo-company-research-documents
|
|
6327
6548
|
* @secure
|
|
6328
6549
|
*/
|
|
6329
|
-
|
|
6550
|
+
getPreIpoCompanyResearchDocuments(query: {
|
|
6551
|
+
/** company id */
|
|
6552
|
+
pre_ipo_company_id?: string;
|
|
6553
|
+
/** search by title */
|
|
6554
|
+
title?: string;
|
|
6555
|
+
/** how many records to return. Max value is 50 */
|
|
6556
|
+
limit: number;
|
|
6557
|
+
/** how many records to skip */
|
|
6558
|
+
offset: number;
|
|
6559
|
+
/** search by research type */
|
|
6560
|
+
research_type?: InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum;
|
|
6561
|
+
/** search by relation */
|
|
6562
|
+
relation?: InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum;
|
|
6563
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError, Format>>;
|
|
6330
6564
|
/**
|
|
6331
|
-
* @description
|
|
6332
|
-
* @tags
|
|
6333
|
-
* @name
|
|
6334
|
-
* @summary
|
|
6335
|
-
* @request
|
|
6565
|
+
* @description get pre ipo company research document by id
|
|
6566
|
+
* @tags PreIPOCompanies
|
|
6567
|
+
* @name GetPreIpoCompanyResearchDocumentsById
|
|
6568
|
+
* @summary get pre ipo company research document by id
|
|
6569
|
+
* @request GET:/ipos/pre-ipo-company-research-documents/{id}
|
|
6570
|
+
* @originalName getPreIpoCompanyResearchDocuments
|
|
6571
|
+
* @duplicate
|
|
6336
6572
|
* @secure
|
|
6337
6573
|
*/
|
|
6338
|
-
|
|
6574
|
+
getPreIpoCompanyResearchDocumentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyResearchDocument, HandleError, Format>>;
|
|
6339
6575
|
/**
|
|
6340
|
-
* @description
|
|
6341
|
-
* @tags
|
|
6342
|
-
* @name
|
|
6343
|
-
* @summary
|
|
6344
|
-
* @request
|
|
6576
|
+
* @description get pre ipo company spvs with investor id
|
|
6577
|
+
* @tags PreIPOCompanies
|
|
6578
|
+
* @name GetInvestor
|
|
6579
|
+
* @summary get pre ipo company spvs with investor id
|
|
6580
|
+
* @request GET:/ipos/pre-ipo-company-spv/investor/{investor_id}
|
|
6345
6581
|
* @secure
|
|
6346
6582
|
*/
|
|
6347
|
-
|
|
6583
|
+
getInvestor(investorId: string, query: {
|
|
6584
|
+
/** search by monark stage */
|
|
6585
|
+
monark_stage?: InsightGetInvestorParamsMonarkStageEnum;
|
|
6586
|
+
/** Optional param to filter returned spv's based on the exemptions claimed */
|
|
6587
|
+
exemptions_claimed?: string[];
|
|
6588
|
+
/** Optional param to filter returned spv's based on the name */
|
|
6589
|
+
name_filter?: string;
|
|
6590
|
+
/** investment id */
|
|
6591
|
+
pre_ipo_company_id?: string;
|
|
6592
|
+
/** investment id */
|
|
6593
|
+
pre_ipo_company_investment_id?: string;
|
|
6594
|
+
/** page number */
|
|
6595
|
+
page: number;
|
|
6596
|
+
/** page size */
|
|
6597
|
+
page_size: number;
|
|
6598
|
+
/** sort direction */
|
|
6599
|
+
sort_order?: InsightGetInvestorParamsSortOrderEnum;
|
|
6600
|
+
/** sort field */
|
|
6601
|
+
sort_by?: InsightGetInvestorParamsSortByEnum;
|
|
6602
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsWithInvestorIDResponse, HandleError, Format>>;
|
|
6348
6603
|
/**
|
|
6349
|
-
* @description
|
|
6350
|
-
* @tags
|
|
6351
|
-
* @name
|
|
6352
|
-
* @summary
|
|
6353
|
-
* @request
|
|
6604
|
+
* @description get pre ipo company spv by id with investor id
|
|
6605
|
+
* @tags PreIPOCompanies
|
|
6606
|
+
* @name GetInvestorByIdAndInvestorId
|
|
6607
|
+
* @summary get pre ipo company spv by id with investor id
|
|
6608
|
+
* @request GET:/ipos/pre-ipo-company-spv/{id}/investor/{investor_id}
|
|
6609
|
+
* @originalName getInvestor
|
|
6610
|
+
* @duplicate
|
|
6354
6611
|
* @secure
|
|
6355
6612
|
*/
|
|
6356
|
-
|
|
6613
|
+
getInvestorByIdAndInvestorId(id: string, investorId: string, query?: {
|
|
6614
|
+
/** default is false, if true documents will be included in the response */
|
|
6615
|
+
include_documents?: boolean;
|
|
6616
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetProIPOCompabySPVWithInvestorIDResponse, HandleError, Format>>;
|
|
6357
6617
|
/**
|
|
6358
|
-
* @description
|
|
6359
|
-
* @tags
|
|
6360
|
-
* @name
|
|
6361
|
-
* @summary
|
|
6362
|
-
* @request
|
|
6618
|
+
* @description get pre ipo company spvs
|
|
6619
|
+
* @tags PreIPOCompanies
|
|
6620
|
+
* @name GetPreIpoCompanySpvs
|
|
6621
|
+
* @summary get pre ipo company spvs
|
|
6622
|
+
* @request GET:/ipos/pre-ipo-company-spvs
|
|
6363
6623
|
* @secure
|
|
6364
6624
|
*/
|
|
6365
|
-
|
|
6625
|
+
getPreIpoCompanySpvs(query: {
|
|
6626
|
+
/** company id */
|
|
6627
|
+
pre_ipo_company_id?: string;
|
|
6628
|
+
/** investment id */
|
|
6629
|
+
investment_id?: string;
|
|
6630
|
+
/** search by name */
|
|
6631
|
+
name?: string;
|
|
6632
|
+
/** search by company name */
|
|
6633
|
+
company_name?: string;
|
|
6634
|
+
/** how many records to return. Max value is 50 */
|
|
6635
|
+
limit: number;
|
|
6636
|
+
/** how many records to skip */
|
|
6637
|
+
offset: number;
|
|
6638
|
+
/** search by monark stage */
|
|
6639
|
+
monark_stage?: InsightGetPreIpoCompanySpvsParamsMonarkStageEnum;
|
|
6640
|
+
/** sort direction */
|
|
6641
|
+
direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
|
|
6642
|
+
/** sort field */
|
|
6643
|
+
field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
|
|
6644
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError, Format>>;
|
|
6366
6645
|
/**
|
|
6367
|
-
* @description
|
|
6368
|
-
* @tags
|
|
6369
|
-
* @name
|
|
6370
|
-
* @summary
|
|
6371
|
-
* @request
|
|
6646
|
+
* @description get pre ipo company spv by id
|
|
6647
|
+
* @tags PreIPOCompanies
|
|
6648
|
+
* @name GetPreIpoCompanySpvsById
|
|
6649
|
+
* @summary get pre ipo company spv by id
|
|
6650
|
+
* @request GET:/ipos/pre-ipo-company-spvs/{id}
|
|
6651
|
+
* @originalName getPreIpoCompanySpvs
|
|
6652
|
+
* @duplicate
|
|
6372
6653
|
* @secure
|
|
6373
6654
|
*/
|
|
6374
|
-
|
|
6655
|
+
getPreIpoCompanySpvsById(id: string, query?: {
|
|
6656
|
+
/** default is false, if true documents will be included in the response */
|
|
6657
|
+
include_documents?: boolean;
|
|
6658
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError, Format>>;
|
|
6375
6659
|
}
|
|
6376
|
-
export class Public<HandleError extends boolean = boolean> {
|
|
6377
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6378
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6660
|
+
export class Public<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
6661
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
6662
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
6379
6663
|
/**
|
|
6380
6664
|
* @description Calculate estimated returns for selected symbols. Uses split adjusted prices
|
|
6381
6665
|
* @tags Public
|
|
@@ -6396,7 +6680,7 @@ export class Public<HandleError extends boolean = boolean> {
|
|
|
6396
6680
|
start_date: string;
|
|
6397
6681
|
/** End date for calculations */
|
|
6398
6682
|
end_date: string;
|
|
6399
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
|
|
6683
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError, Format>>;
|
|
6400
6684
|
/**
|
|
6401
6685
|
* @description Returns an expert forecast
|
|
6402
6686
|
* @tags Public
|
|
@@ -6408,7 +6692,7 @@ export class Public<HandleError extends boolean = boolean> {
|
|
|
6408
6692
|
expertForecast(query: {
|
|
6409
6693
|
/** Comma separated symbols */
|
|
6410
6694
|
symbols: string;
|
|
6411
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
|
|
6695
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError, Format>>;
|
|
6412
6696
|
/**
|
|
6413
6697
|
* @description get fundamentals by symbol data
|
|
6414
6698
|
* @tags Public
|
|
@@ -6420,7 +6704,7 @@ export class Public<HandleError extends boolean = boolean> {
|
|
|
6420
6704
|
getPublicFundamentalsBySymbolData(symbol: string, query: {
|
|
6421
6705
|
/** Annual or quarterly */
|
|
6422
6706
|
mode: string;
|
|
6423
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
6707
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError, Format>>;
|
|
6424
6708
|
/**
|
|
6425
6709
|
* @description Daily price history
|
|
6426
6710
|
* @tags Public
|
|
@@ -6429,139 +6713,236 @@ export class Public<HandleError extends boolean = boolean> {
|
|
|
6429
6713
|
* @request GET:/public/price-history/daily
|
|
6430
6714
|
* @secure
|
|
6431
6715
|
*/
|
|
6432
|
-
dailyPriceHistory(query: {
|
|
6433
|
-
/** Single symbol */
|
|
6434
|
-
symbol: string;
|
|
6435
|
-
/** Target date */
|
|
6436
|
-
date: string;
|
|
6437
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
|
|
6716
|
+
dailyPriceHistory(query: {
|
|
6717
|
+
/** Single symbol */
|
|
6718
|
+
symbol: string;
|
|
6719
|
+
/** Target date */
|
|
6720
|
+
date: string;
|
|
6721
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError, Format>>;
|
|
6722
|
+
/**
|
|
6723
|
+
* @description Public quote profile
|
|
6724
|
+
* @tags Public
|
|
6725
|
+
* @name PublicQuoteProfile
|
|
6726
|
+
* @summary Public quote profile
|
|
6727
|
+
* @request GET:/public/quote-profile/{symbol}
|
|
6728
|
+
* @secure
|
|
6729
|
+
*/
|
|
6730
|
+
publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError, Format>>;
|
|
6731
|
+
/**
|
|
6732
|
+
* @description get ratios by symbol data
|
|
6733
|
+
* @tags Public
|
|
6734
|
+
* @name GetPublicRatiosBySymbolData
|
|
6735
|
+
* @summary get ratios by symbol data
|
|
6736
|
+
* @request GET:/public/ratios/{symbol}
|
|
6737
|
+
* @secure
|
|
6738
|
+
*/
|
|
6739
|
+
getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError, Format>>;
|
|
6740
|
+
/**
|
|
6741
|
+
* @description find a symbol by name or description
|
|
6742
|
+
* @tags Public
|
|
6743
|
+
* @name QuoteFundamentalsSearch
|
|
6744
|
+
* @summary find a symbol by name or description
|
|
6745
|
+
* @request GET:/public/symbol-search
|
|
6746
|
+
* @secure
|
|
6747
|
+
*/
|
|
6748
|
+
quoteFundamentalsSearch(query: {
|
|
6749
|
+
/** Search query */
|
|
6750
|
+
search_query: string;
|
|
6751
|
+
/** how many records to return. Max value is 50 */
|
|
6752
|
+
limit: number;
|
|
6753
|
+
/** how many records to skip */
|
|
6754
|
+
offset: number;
|
|
6755
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError, Format>>;
|
|
6756
|
+
/**
|
|
6757
|
+
* @description Get top gainers
|
|
6758
|
+
* @tags Public
|
|
6759
|
+
* @name TopGainers
|
|
6760
|
+
* @summary Top Gainers
|
|
6761
|
+
* @request GET:/public/top-gainers
|
|
6762
|
+
* @secure
|
|
6763
|
+
*/
|
|
6764
|
+
topGainers(query: {
|
|
6765
|
+
/** sort direction - asc or desc */
|
|
6766
|
+
order_direction?: string;
|
|
6767
|
+
/** how many records to return. Max value is 50 */
|
|
6768
|
+
limit: number;
|
|
6769
|
+
/** how many records to skip */
|
|
6770
|
+
offset: number;
|
|
6771
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError, Format>>;
|
|
6772
|
+
/**
|
|
6773
|
+
* @description Get top stocks
|
|
6774
|
+
* @tags Public
|
|
6775
|
+
* @name TopStocks
|
|
6776
|
+
* @summary Top Stocks
|
|
6777
|
+
* @request GET:/public/top-stocks
|
|
6778
|
+
* @secure
|
|
6779
|
+
*/
|
|
6780
|
+
topStocks(query: {
|
|
6781
|
+
/** EQUITY|ETF|CRYPTO */
|
|
6782
|
+
stock_type: InsightTopStocksParamsStockTypeEnum;
|
|
6783
|
+
/** how many records to return. Max value is 50 */
|
|
6784
|
+
limit: number;
|
|
6785
|
+
/** how many records to skip */
|
|
6786
|
+
offset: number;
|
|
6787
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError, Format>>;
|
|
6788
|
+
}
|
|
6789
|
+
export class Quotes<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
6790
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
6791
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
6792
|
+
/**
|
|
6793
|
+
* @description Get single historical quote
|
|
6794
|
+
* @tags Quotes
|
|
6795
|
+
* @name GitHistoricalQuote
|
|
6796
|
+
* @summary Get single historical quote
|
|
6797
|
+
* @request GET:/historical/quote
|
|
6798
|
+
* @secure
|
|
6799
|
+
*/
|
|
6800
|
+
gitHistoricalQuote(query: {
|
|
6801
|
+
/** Symbol */
|
|
6802
|
+
symbol: string;
|
|
6803
|
+
/** Date */
|
|
6804
|
+
date: string;
|
|
6805
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError, Format>>;
|
|
6806
|
+
/**
|
|
6807
|
+
* @description get quote history by symbol
|
|
6808
|
+
* @tags Quotes
|
|
6809
|
+
* @name GitQuoteHistory
|
|
6810
|
+
* @summary Get quote history
|
|
6811
|
+
* @request POST:/quote-history
|
|
6812
|
+
* @secure
|
|
6813
|
+
*/
|
|
6814
|
+
gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError, Format>>;
|
|
6815
|
+
/**
|
|
6816
|
+
* @description Returns a list of quotes equity info for specified symbols.
|
|
6817
|
+
* @tags Quotes
|
|
6818
|
+
* @name GetQuotesEquityData
|
|
6819
|
+
* @summary Get Quotes Equity data
|
|
6820
|
+
* @request GET:/quotes/equity
|
|
6821
|
+
* @secure
|
|
6822
|
+
*/
|
|
6823
|
+
getQuotesEquityData(query: {
|
|
6824
|
+
/** Comma separated symbols */
|
|
6825
|
+
symbols: string;
|
|
6826
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError, Format>>;
|
|
6827
|
+
}
|
|
6828
|
+
export class StockScreener<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
6829
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
6830
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
6831
|
+
/**
|
|
6832
|
+
* @description data for visual heat map
|
|
6833
|
+
* @tags StockScreener
|
|
6834
|
+
* @name StockMarketHeatmap
|
|
6835
|
+
* @summary data for visual heat map
|
|
6836
|
+
* @request GET:/heatmaps
|
|
6837
|
+
* @secure
|
|
6838
|
+
*/
|
|
6839
|
+
stockMarketHeatmap(query?: {
|
|
6840
|
+
/** Name of symbol list to fetch details for. Empty is default */
|
|
6841
|
+
heatmap_name?: string;
|
|
6842
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError, Format>>;
|
|
6438
6843
|
/**
|
|
6439
|
-
* @description
|
|
6440
|
-
* @tags
|
|
6441
|
-
* @name
|
|
6442
|
-
* @summary
|
|
6443
|
-
* @request
|
|
6844
|
+
* @description create or update heat map preset
|
|
6845
|
+
* @tags StockScreener
|
|
6846
|
+
* @name CreateStockMarketHeatmapPreset
|
|
6847
|
+
* @summary create or update heat map preset
|
|
6848
|
+
* @request POST:/heatmaps
|
|
6444
6849
|
* @secure
|
|
6445
6850
|
*/
|
|
6446
|
-
|
|
6851
|
+
createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
6447
6852
|
/**
|
|
6448
|
-
* @description
|
|
6449
|
-
* @tags
|
|
6450
|
-
* @name
|
|
6451
|
-
* @summary get
|
|
6452
|
-
* @request
|
|
6853
|
+
* @description Sector and Industry Group performance
|
|
6854
|
+
* @tags StockScreener
|
|
6855
|
+
* @name IndustriesPerformance
|
|
6856
|
+
* @summary get industries performance
|
|
6857
|
+
* @request POST:/industries-performance
|
|
6453
6858
|
* @secure
|
|
6454
6859
|
*/
|
|
6455
|
-
|
|
6860
|
+
industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError, Format>>;
|
|
6456
6861
|
/**
|
|
6457
|
-
* @description
|
|
6458
|
-
* @tags
|
|
6459
|
-
* @name
|
|
6460
|
-
* @summary
|
|
6461
|
-
* @request
|
|
6862
|
+
* @description filter stocks by params
|
|
6863
|
+
* @tags StockScreener
|
|
6864
|
+
* @name StockScreener
|
|
6865
|
+
* @summary filter stocks by params
|
|
6866
|
+
* @request POST:/stock-screener
|
|
6462
6867
|
* @secure
|
|
6463
6868
|
*/
|
|
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>>;
|
|
6869
|
+
stockScreener(filter: InsightStockScreenerV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError, Format>>;
|
|
6472
6870
|
/**
|
|
6473
|
-
* @description
|
|
6474
|
-
* @tags
|
|
6475
|
-
* @name
|
|
6476
|
-
* @summary
|
|
6477
|
-
* @request GET:/
|
|
6871
|
+
* @description get screener presets
|
|
6872
|
+
* @tags StockScreener
|
|
6873
|
+
* @name GetScreenerPresets
|
|
6874
|
+
* @summary get screener presets
|
|
6875
|
+
* @request GET:/stock-screener/presets
|
|
6478
6876
|
* @secure
|
|
6479
6877
|
*/
|
|
6480
|
-
|
|
6481
|
-
/**
|
|
6482
|
-
order_direction?: string;
|
|
6483
|
-
/** how many records to return. Max value is 50 */
|
|
6878
|
+
getScreenerPresets(query: {
|
|
6879
|
+
/** how many records to return */
|
|
6484
6880
|
limit: number;
|
|
6485
6881
|
/** how many records to skip */
|
|
6486
6882
|
offset: number;
|
|
6487
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
6883
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError, Format>>;
|
|
6488
6884
|
/**
|
|
6489
|
-
* @description
|
|
6490
|
-
* @tags
|
|
6491
|
-
* @name
|
|
6492
|
-
* @summary
|
|
6493
|
-
* @request
|
|
6885
|
+
* @description update screener preset
|
|
6886
|
+
* @tags StockScreener
|
|
6887
|
+
* @name UpdateScreenerPreset
|
|
6888
|
+
* @summary update screener preset
|
|
6889
|
+
* @request PUT:/stock-screener/presets
|
|
6494
6890
|
* @secure
|
|
6495
6891
|
*/
|
|
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>);
|
|
6892
|
+
updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError, Format>>;
|
|
6508
6893
|
/**
|
|
6509
|
-
* @description
|
|
6510
|
-
* @tags
|
|
6511
|
-
* @name
|
|
6512
|
-
* @summary
|
|
6513
|
-
* @request POST:/
|
|
6894
|
+
* @description create screener preset
|
|
6895
|
+
* @tags StockScreener
|
|
6896
|
+
* @name CreateOrScreenerPreset
|
|
6897
|
+
* @summary create screener preset
|
|
6898
|
+
* @request POST:/stock-screener/presets
|
|
6514
6899
|
* @secure
|
|
6515
6900
|
*/
|
|
6516
|
-
|
|
6901
|
+
createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError, Format>>;
|
|
6517
6902
|
/**
|
|
6518
|
-
* @description
|
|
6519
|
-
* @tags
|
|
6520
|
-
* @name
|
|
6521
|
-
* @summary
|
|
6522
|
-
* @request
|
|
6903
|
+
* @description remove screener preset
|
|
6904
|
+
* @tags StockScreener
|
|
6905
|
+
* @name RemoveScreenerPreset
|
|
6906
|
+
* @summary remove screener preset
|
|
6907
|
+
* @request DELETE:/stock-screener/presets
|
|
6523
6908
|
* @secure
|
|
6524
6909
|
*/
|
|
6525
|
-
|
|
6526
|
-
}
|
|
6527
|
-
export class UsageTracking<HandleError extends boolean = boolean> {
|
|
6528
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6529
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6910
|
+
removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
6530
6911
|
/**
|
|
6531
|
-
* @description get
|
|
6532
|
-
* @tags
|
|
6533
|
-
* @name
|
|
6534
|
-
* @summary get
|
|
6535
|
-
* @request POST:/
|
|
6912
|
+
* @description get top symbols
|
|
6913
|
+
* @tags StockScreener
|
|
6914
|
+
* @name GetTopSymbols
|
|
6915
|
+
* @summary get top symbols
|
|
6916
|
+
* @request POST:/stock-screener/top
|
|
6536
6917
|
* @secure
|
|
6537
6918
|
*/
|
|
6538
|
-
|
|
6919
|
+
getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError, Format>>;
|
|
6539
6920
|
}
|
|
6540
|
-
export class
|
|
6541
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6542
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6921
|
+
export class StockScreenerV2<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
6922
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
6923
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
6543
6924
|
/**
|
|
6544
|
-
* @description
|
|
6545
|
-
* @tags
|
|
6546
|
-
* @name
|
|
6547
|
-
* @summary
|
|
6548
|
-
* @request POST:/
|
|
6925
|
+
* @description filter stocks by params
|
|
6926
|
+
* @tags StockScreener
|
|
6927
|
+
* @name StockScreener
|
|
6928
|
+
* @summary filter stocks by params
|
|
6929
|
+
* @request POST:/stock-screener
|
|
6549
6930
|
* @secure
|
|
6550
6931
|
*/
|
|
6551
|
-
|
|
6932
|
+
stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError, Format>>;
|
|
6552
6933
|
/**
|
|
6553
|
-
* @description get
|
|
6554
|
-
* @tags
|
|
6555
|
-
* @name
|
|
6556
|
-
* @summary get
|
|
6557
|
-
* @request POST:/
|
|
6934
|
+
* @description get top symbols
|
|
6935
|
+
* @tags StockScreener
|
|
6936
|
+
* @name GetTopSymbols
|
|
6937
|
+
* @summary get top symbols
|
|
6938
|
+
* @request POST:/stock-screener/top
|
|
6558
6939
|
* @secure
|
|
6559
6940
|
*/
|
|
6560
|
-
|
|
6941
|
+
getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError, Format>>;
|
|
6561
6942
|
}
|
|
6562
|
-
export class TipRank<HandleError extends boolean = boolean> {
|
|
6563
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6564
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6943
|
+
export class TipRank<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
6944
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
6945
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
6565
6946
|
/**
|
|
6566
6947
|
* @description Returns an overview of analyst ratings for a given ticker or ticker list, based on analyst ratings from the last 3 months.
|
|
6567
6948
|
* @tags TipRank
|
|
@@ -6570,7 +6951,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6570
6951
|
* @request POST:/tipranks/analyst-consensus
|
|
6571
6952
|
* @secure
|
|
6572
6953
|
*/
|
|
6573
|
-
tiprankAnalystConsensus(filter: InsightAnalystConsensusRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystConsensusResponse[], HandleError>>;
|
|
6954
|
+
tiprankAnalystConsensus(filter: InsightAnalystConsensusRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystConsensusResponse[], HandleError, Format>>;
|
|
6574
6955
|
/**
|
|
6575
6956
|
* @description Returns the latest analyst ratings on a given stock or multiple stocks.
|
|
6576
6957
|
* @tags TipRank
|
|
@@ -6579,7 +6960,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6579
6960
|
* @request POST:/tipranks/analyst-multi
|
|
6580
6961
|
* @secure
|
|
6581
6962
|
*/
|
|
6582
|
-
tiprankLatestAnalystRatingsOnStock(filter: InsightLatestAnalystRatingsOnStockRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLatestAnalystRatingsOnStockResponse[], HandleError>>;
|
|
6963
|
+
tiprankLatestAnalystRatingsOnStock(filter: InsightLatestAnalystRatingsOnStockRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLatestAnalystRatingsOnStockResponse[], HandleError, Format>>;
|
|
6583
6964
|
/**
|
|
6584
6965
|
* @description Returns the latest analyst portfolio items.
|
|
6585
6966
|
* @tags TipRank
|
|
@@ -6591,7 +6972,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6591
6972
|
tiprankPortfolios(filter: InsightPortfoliosRequest, headers?: {
|
|
6592
6973
|
/** Authorization */
|
|
6593
6974
|
Authorization?: string;
|
|
6594
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPortfoliosResponse[], HandleError>>;
|
|
6975
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPortfoliosResponse[], HandleError, Format>>;
|
|
6595
6976
|
/**
|
|
6596
6977
|
* @description Returns the analyst profile information
|
|
6597
6978
|
* @tags TipRank
|
|
@@ -6603,7 +6984,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6603
6984
|
tiprankAnalystProfile(query: {
|
|
6604
6985
|
/** ID of tiprank analyst profile */
|
|
6605
6986
|
id: string;
|
|
6606
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystProfileResponse, HandleError>>;
|
|
6987
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystProfileResponse, HandleError, Format>>;
|
|
6607
6988
|
/**
|
|
6608
6989
|
* @description Returns the URL prefix to the expertPictureUrl field.
|
|
6609
6990
|
* @tags TipRank
|
|
@@ -6612,7 +6993,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6612
6993
|
* @request GET:/tipranks/analysts-expert-picture-store
|
|
6613
6994
|
* @secure
|
|
6614
6995
|
*/
|
|
6615
|
-
tiprankAnalystsExpertPictureStore(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystsExpertPictureStoreResponse, HandleError>>;
|
|
6996
|
+
tiprankAnalystsExpertPictureStore(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystsExpertPictureStoreResponse, HandleError, Format>>;
|
|
6616
6997
|
/**
|
|
6617
6998
|
* @description Returns a list of top-ranked analysts.
|
|
6618
6999
|
* @tags TipRank
|
|
@@ -6624,7 +7005,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6624
7005
|
tiprankBestPerformingExperts(query?: {
|
|
6625
7006
|
/** The number of analysts to return */
|
|
6626
7007
|
num?: number;
|
|
6627
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightBestPerformingExpertsResponse[], HandleError>>;
|
|
7008
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightBestPerformingExpertsResponse[], HandleError, Format>>;
|
|
6628
7009
|
/**
|
|
6629
7010
|
* @description Returns the blogger consensus on the stock along with the blogger opinion distribution by site.
|
|
6630
7011
|
* @tags TipRank
|
|
@@ -6636,7 +7017,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6636
7017
|
tiprankBloggerConsensusOnStock(query: {
|
|
6637
7018
|
/** The ticker of the stock */
|
|
6638
7019
|
ticker: string;
|
|
6639
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightBloggerConsensusOnStockResponse[], HandleError>>;
|
|
7020
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightBloggerConsensusOnStockResponse[], HandleError, Format>>;
|
|
6640
7021
|
/**
|
|
6641
7022
|
* @description Returns a list of the upcoming IPOs and recent IPOs that have already been priced
|
|
6642
7023
|
* @tags TipRank
|
|
@@ -6645,7 +7026,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6645
7026
|
* @request GET:/tipranks/calendars-ipos
|
|
6646
7027
|
* @secure
|
|
6647
7028
|
*/
|
|
6648
|
-
tiprankCalendarsIpos(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalendarsIPOSResponse[], HandleError>>;
|
|
7029
|
+
tiprankCalendarsIpos(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalendarsIPOSResponse[], HandleError, Format>>;
|
|
6649
7030
|
/**
|
|
6650
7031
|
* @description Returns all stocks that have been updated since a specified UTC time.
|
|
6651
7032
|
* @tags TipRank
|
|
@@ -6659,7 +7040,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6659
7040
|
utc_time?: string;
|
|
6660
7041
|
/** Level of detail on updated stocks */
|
|
6661
7042
|
details?: InsightTiprankGeneralStockUpdatesParamsDetailsEnum;
|
|
6662
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGeneralStockUpdatesResponse, HandleError>>;
|
|
7043
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGeneralStockUpdatesResponse, HandleError, Format>>;
|
|
6663
7044
|
/**
|
|
6664
7045
|
* @description Returns all hedge funds that have a position on a given stock along with the hedge fund activity trends and consensus.
|
|
6665
7046
|
* @tags TipRank
|
|
@@ -6671,7 +7052,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6671
7052
|
tiprankHedgefunds(query: {
|
|
6672
7053
|
/** The ticker of the stock */
|
|
6673
7054
|
ticker: string;
|
|
6674
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsResponse[], HandleError>>;
|
|
7055
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsResponse[], HandleError, Format>>;
|
|
6675
7056
|
/**
|
|
6676
7057
|
* @description Returns a list of top-ranked hedge fund managers.
|
|
6677
7058
|
* @tags TipRank
|
|
@@ -6683,7 +7064,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6683
7064
|
tiprankHedgefundsBestPerformingExperts(query?: {
|
|
6684
7065
|
/** The number of hedge fund managers to return */
|
|
6685
7066
|
num?: number;
|
|
6686
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsBestPerformingExpertsResponse[], HandleError>>;
|
|
7067
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsBestPerformingExpertsResponse[], HandleError, Format>>;
|
|
6687
7068
|
/**
|
|
6688
7069
|
* @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
7070
|
* @tags TipRank
|
|
@@ -6697,7 +7078,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6697
7078
|
min_stars?: number;
|
|
6698
7079
|
/** The order of the latest insider transactions */
|
|
6699
7080
|
sort?: InsightTiprankHedgefundsRecentTransactionsParamsSortEnum;
|
|
6700
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsRecentTransactionsResponse[], HandleError>>;
|
|
7081
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsRecentTransactionsResponse[], HandleError, Format>>;
|
|
6701
7082
|
/**
|
|
6702
7083
|
* @description Returns the latest insider transactions and an overall sentiment on a given stock.
|
|
6703
7084
|
* @tags TipRank
|
|
@@ -6709,7 +7090,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6709
7090
|
tiprankInsiders(query: {
|
|
6710
7091
|
/** The ticker of the stock */
|
|
6711
7092
|
ticker: string;
|
|
6712
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersResponse[], HandleError>>;
|
|
7093
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersResponse[], HandleError, Format>>;
|
|
6713
7094
|
/**
|
|
6714
7095
|
* @description Returns a list of top ranked insiders.
|
|
6715
7096
|
* @tags TipRank
|
|
@@ -6721,7 +7102,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6721
7102
|
tiprankInsidersBestPerformingExperts(query?: {
|
|
6722
7103
|
/** The number of insiders to return */
|
|
6723
7104
|
num?: number;
|
|
6724
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersBestPerformingExpertsResponse[], HandleError>>;
|
|
7105
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersBestPerformingExpertsResponse[], HandleError, Format>>;
|
|
6725
7106
|
/**
|
|
6726
7107
|
* @description Returns all the information required to build TipRanks Insider Hot Stocks.
|
|
6727
7108
|
* @tags TipRank
|
|
@@ -6730,7 +7111,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6730
7111
|
* @request GET:/tipranks/insiders-hotstocks
|
|
6731
7112
|
* @secure
|
|
6732
7113
|
*/
|
|
6733
|
-
tiprankInsidersHotstocks(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersHotstocksResponse[], HandleError>>;
|
|
7114
|
+
tiprankInsidersHotstocks(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersHotstocksResponse[], HandleError, Format>>;
|
|
6734
7115
|
/**
|
|
6735
7116
|
* @description Returns a feed of the latest insider transactions reported to the SEC.
|
|
6736
7117
|
* @tags TipRank
|
|
@@ -6744,7 +7125,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6744
7125
|
num?: number;
|
|
6745
7126
|
/** The order of the latest insider transactions */
|
|
6746
7127
|
sort?: InsightTiprankInsidersLiveFeedParamsSortEnum;
|
|
6747
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersLiveFeedResponse[], HandleError>>;
|
|
7128
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersLiveFeedResponse[], HandleError, Format>>;
|
|
6748
7129
|
/**
|
|
6749
7130
|
* @description Returns the insider profile information.
|
|
6750
7131
|
* @tags TipRank
|
|
@@ -6756,7 +7137,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6756
7137
|
tiprankInsidersOverview(query?: {
|
|
6757
7138
|
/** The UID of the expert */
|
|
6758
7139
|
expert_uid?: string;
|
|
6759
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersOverviewResponse, HandleError>>;
|
|
7140
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersOverviewResponse, HandleError, Format>>;
|
|
6760
7141
|
/**
|
|
6761
7142
|
* @description Returns the sentiment of TipRanks users on the stock.
|
|
6762
7143
|
* @tags TipRank
|
|
@@ -6768,7 +7149,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6768
7149
|
tiprankInvestorSentiment(query: {
|
|
6769
7150
|
/** The ticker of the stock */
|
|
6770
7151
|
ticker: string;
|
|
6771
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInvestorSentimentResponse, HandleError>>;
|
|
7152
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInvestorSentimentResponse, HandleError, Format>>;
|
|
6772
7153
|
/**
|
|
6773
7154
|
* @description Returns the latest analyst ratings.
|
|
6774
7155
|
* @tags TipRank
|
|
@@ -6780,7 +7161,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6780
7161
|
tiprankLiveFeed(filter: InsightLiveFeedRequest, headers?: {
|
|
6781
7162
|
/** Authorization */
|
|
6782
7163
|
Authorization?: string;
|
|
6783
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLiveFeedResponse[], HandleError>>;
|
|
7164
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLiveFeedResponse[], HandleError, Format>>;
|
|
6784
7165
|
/**
|
|
6785
7166
|
* @description Returns the latest news articles on the stock and their sentiment (bullish / neutral or bearish).
|
|
6786
7167
|
* @tags TipRank
|
|
@@ -6794,7 +7175,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6794
7175
|
ticker: string;
|
|
6795
7176
|
/** Limit to number of articles 1-200 */
|
|
6796
7177
|
num?: number;
|
|
6797
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsArticlesResponse[], HandleError>>;
|
|
7178
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsArticlesResponse[], HandleError, Format>>;
|
|
6798
7179
|
/**
|
|
6799
7180
|
* @description Returns the overall sentiment, buzz score and word cloud for the stock.
|
|
6800
7181
|
* @tags TipRank
|
|
@@ -6806,7 +7187,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6806
7187
|
tiprankNewsSentiment(query: {
|
|
6807
7188
|
/** The ticker of the stock */
|
|
6808
7189
|
ticker: string;
|
|
6809
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsSentimentResponse, HandleError>>;
|
|
7190
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsSentimentResponse, HandleError, Format>>;
|
|
6810
7191
|
/**
|
|
6811
7192
|
* @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
7193
|
* @tags TipRank
|
|
@@ -6815,7 +7196,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6815
7196
|
* @request GET:/tipranks/sector-consensus
|
|
6816
7197
|
* @secure
|
|
6817
7198
|
*/
|
|
6818
|
-
tiprankSectorConsensus(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSectorConsensusResponse, HandleError>>;
|
|
7199
|
+
tiprankSectorConsensus(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSectorConsensusResponse, HandleError, Format>>;
|
|
6819
7200
|
/**
|
|
6820
7201
|
* @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
7202
|
* @tags TipRank
|
|
@@ -6824,7 +7205,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6824
7205
|
* @request POST:/tipranks/smart-score
|
|
6825
7206
|
* @secure
|
|
6826
7207
|
*/
|
|
6827
|
-
tiprankSmartScore(filter: InsightSmartScoreRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScoreResponse[], HandleError>>;
|
|
7208
|
+
tiprankSmartScore(filter: InsightSmartScoreRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScoreResponse[], HandleError, Format>>;
|
|
6828
7209
|
/**
|
|
6829
7210
|
* @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
7211
|
* @tags TipRank
|
|
@@ -6833,7 +7214,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6833
7214
|
* @request GET:/tipranks/smart-score-performance
|
|
6834
7215
|
* @secure
|
|
6835
7216
|
*/
|
|
6836
|
-
tiprankSmartScorePerformance(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScorePerformanceResponse, HandleError>>;
|
|
7217
|
+
tiprankSmartScorePerformance(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScorePerformanceResponse, HandleError, Format>>;
|
|
6837
7218
|
/**
|
|
6838
7219
|
* @description Returns a list of stocks with the top Smart Score of 10.
|
|
6839
7220
|
* @tags TipRank
|
|
@@ -6842,7 +7223,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6842
7223
|
* @request POST:/tipranks/smart-score-top-stocks
|
|
6843
7224
|
* @secure
|
|
6844
7225
|
*/
|
|
6845
|
-
tiprankSmartScoreTopStocks(filter: InsightSmartScoreTopStocksRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScoreResponse[], HandleError>>;
|
|
7226
|
+
tiprankSmartScoreTopStocks(filter: InsightSmartScoreTopStocksRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScoreResponse[], HandleError, Format>>;
|
|
6846
7227
|
/**
|
|
6847
7228
|
* @description Returns a list of top-ranked analysts.
|
|
6848
7229
|
* @tags TipRank
|
|
@@ -6851,7 +7232,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6851
7232
|
* @request POST:/tipranks/stocks-consensus-over-time
|
|
6852
7233
|
* @secure
|
|
6853
7234
|
*/
|
|
6854
|
-
tiprankStocksConsensusOverTime(filter: InsightStocksConsensusOverTimeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksConsensusOverTimeResponse[], HandleError>>;
|
|
7235
|
+
tiprankStocksConsensusOverTime(filter: InsightStocksConsensusOverTimeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksConsensusOverTimeResponse[], HandleError, Format>>;
|
|
6855
7236
|
/**
|
|
6856
7237
|
* @description Returns the latest events per a specific stock, these include sell side analyst ratings, blogger opinions and corporate insider transactions
|
|
6857
7238
|
* @tags TipRank
|
|
@@ -6860,7 +7241,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6860
7241
|
* @request POST:/tipranks/stocks-events
|
|
6861
7242
|
* @secure
|
|
6862
7243
|
*/
|
|
6863
|
-
tiprankStocksEvents(filter: InsightStocksEventsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksEventsResponse[], HandleError>>;
|
|
7244
|
+
tiprankStocksEvents(filter: InsightStocksEventsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksEventsResponse[], HandleError, Format>>;
|
|
6864
7245
|
/**
|
|
6865
7246
|
* @description Returns a list of stocks similar to the given ticker.
|
|
6866
7247
|
* @tags TipRank
|
|
@@ -6872,7 +7253,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6872
7253
|
tiprankStocksSimilarStocks(query: {
|
|
6873
7254
|
/** The ticker of the stock */
|
|
6874
7255
|
ticker: string;
|
|
6875
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
7256
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError, Format>>;
|
|
6876
7257
|
/**
|
|
6877
7258
|
* @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
7259
|
* @tags TipRank
|
|
@@ -6881,7 +7262,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6881
7262
|
* @request GET:/tipranks/stocks-top-movers
|
|
6882
7263
|
* @secure
|
|
6883
7264
|
*/
|
|
6884
|
-
tiprankStocksTopMovers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksTopMoversResponse[], HandleError>>;
|
|
7265
|
+
tiprankStocksTopMovers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksTopMoversResponse[], HandleError, Format>>;
|
|
6885
7266
|
/**
|
|
6886
7267
|
* @description Returns the stock symbols covered by TipRanks.
|
|
6887
7268
|
* @tags TipRank
|
|
@@ -6890,7 +7271,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6890
7271
|
* @request GET:/tipranks/supported-tickers
|
|
6891
7272
|
* @secure
|
|
6892
7273
|
*/
|
|
6893
|
-
tiprankSupportedTickers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSupportedTickersResponse, HandleError>>;
|
|
7274
|
+
tiprankSupportedTickers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSupportedTickersResponse, HandleError, Format>>;
|
|
6894
7275
|
/**
|
|
6895
7276
|
* @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
7277
|
* @tags TipRank
|
|
@@ -6902,7 +7283,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6902
7283
|
tiprankTopRateStocks(query?: {
|
|
6903
7284
|
/** Return the most trending X stocks */
|
|
6904
7285
|
num?: number;
|
|
6905
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopRateStocksResponse, HandleError>>;
|
|
7286
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopRateStocksResponse, HandleError, Format>>;
|
|
6906
7287
|
/**
|
|
6907
7288
|
* @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
7289
|
* @tags TipRank
|
|
@@ -6911,7 +7292,7 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6911
7292
|
* @request POST:/tipranks/top-stocks-by-sectors
|
|
6912
7293
|
* @secure
|
|
6913
7294
|
*/
|
|
6914
|
-
tiprankTopStocksBySectors(filter: InsightTopStocksBySectorsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksBySectorsResponse, HandleError>>;
|
|
7295
|
+
tiprankTopStocksBySectors(filter: InsightTopStocksBySectorsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksBySectorsResponse, HandleError, Format>>;
|
|
6915
7296
|
/**
|
|
6916
7297
|
* @description Returns a list of stocks with the highest number of analyst ratings in the last 7 days.
|
|
6917
7298
|
* @tags TipRank
|
|
@@ -6923,303 +7304,233 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6923
7304
|
tiprankTrendingStocks(filter: InsightTrendingStocksRequest, headers?: {
|
|
6924
7305
|
/** Authorization */
|
|
6925
7306
|
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;
|
|
7307
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError, Format>>;
|
|
7007
7308
|
}
|
|
7008
|
-
export
|
|
7009
|
-
|
|
7010
|
-
|
|
7309
|
+
export class UsageTracking<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
7310
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
7311
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
7312
|
+
/**
|
|
7313
|
+
* @description get usage date per branch for a period
|
|
7314
|
+
* @tags UsageTracking
|
|
7315
|
+
* @name GetUsageData
|
|
7316
|
+
* @summary get insight usage data
|
|
7317
|
+
* @request POST:/tracking/usage
|
|
7318
|
+
* @secure
|
|
7319
|
+
*/
|
|
7320
|
+
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError, Format>>;
|
|
7011
7321
|
}
|
|
7012
|
-
export
|
|
7013
|
-
|
|
7014
|
-
|
|
7015
|
-
/**
|
|
7016
|
-
|
|
7017
|
-
|
|
7018
|
-
|
|
7019
|
-
|
|
7020
|
-
|
|
7021
|
-
|
|
7022
|
-
|
|
7023
|
-
|
|
7024
|
-
|
|
7025
|
-
|
|
7322
|
+
export class WorldMarkets<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
7323
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
7324
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
7325
|
+
/**
|
|
7326
|
+
* @description Get continents
|
|
7327
|
+
* @tags World Markets
|
|
7328
|
+
* @name ContinentGet
|
|
7329
|
+
* @summary Get continents
|
|
7330
|
+
* @request GET:/continents
|
|
7331
|
+
* @secure
|
|
7332
|
+
*/
|
|
7333
|
+
continentGet(query: {
|
|
7334
|
+
/** Query limit */
|
|
7335
|
+
limit: number;
|
|
7336
|
+
/** Query offset */
|
|
7337
|
+
offset: number;
|
|
7338
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError, Format>>;
|
|
7339
|
+
/**
|
|
7340
|
+
* @description Edit continent
|
|
7341
|
+
* @tags World Markets
|
|
7342
|
+
* @name ContinentEdit
|
|
7343
|
+
* @summary Edit continent
|
|
7344
|
+
* @request PUT:/continents
|
|
7345
|
+
* @secure
|
|
7346
|
+
*/
|
|
7347
|
+
continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
7026
7348
|
/**
|
|
7027
|
-
* @
|
|
7028
|
-
* @
|
|
7349
|
+
* @description Create continents
|
|
7350
|
+
* @tags World Markets
|
|
7351
|
+
* @name ContinentCreate
|
|
7352
|
+
* @summary Create continents
|
|
7353
|
+
* @request POST:/continents
|
|
7354
|
+
* @secure
|
|
7029
7355
|
*/
|
|
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;
|
|
7356
|
+
continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError, Format>>;
|
|
7038
7357
|
/**
|
|
7039
|
-
* @
|
|
7040
|
-
* @
|
|
7358
|
+
* @description Delete continent
|
|
7359
|
+
* @tags World Markets
|
|
7360
|
+
* @name ContinentDelete
|
|
7361
|
+
* @summary Delete continent
|
|
7362
|
+
* @request DELETE:/continents
|
|
7363
|
+
* @secure
|
|
7041
7364
|
*/
|
|
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 {
|
|
7365
|
+
continentDelete(query: {
|
|
7366
|
+
/** continent id */
|
|
7367
|
+
id: string;
|
|
7368
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
7080
7369
|
/**
|
|
7081
|
-
* @
|
|
7082
|
-
* @
|
|
7370
|
+
* @description Get country codes
|
|
7371
|
+
* @tags World Markets
|
|
7372
|
+
* @name CountryCodeGet
|
|
7373
|
+
* @summary Get country codes
|
|
7374
|
+
* @request GET:/country-codes
|
|
7375
|
+
* @secure
|
|
7083
7376
|
*/
|
|
7084
|
-
|
|
7377
|
+
countryCodeGet(query: {
|
|
7378
|
+
/** Query limit */
|
|
7379
|
+
limit: number;
|
|
7380
|
+
/** Query offset */
|
|
7381
|
+
offset: number;
|
|
7382
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError, Format>>;
|
|
7085
7383
|
/**
|
|
7086
|
-
*
|
|
7087
|
-
*
|
|
7088
|
-
*
|
|
7089
|
-
* @
|
|
7384
|
+
* @description Edit country code
|
|
7385
|
+
* @tags World Markets
|
|
7386
|
+
* @name CountryCodeEdit
|
|
7387
|
+
* @summary Edit country code
|
|
7388
|
+
* @request PUT:/country-codes
|
|
7389
|
+
* @secure
|
|
7090
7390
|
*/
|
|
7091
|
-
|
|
7092
|
-
}
|
|
7093
|
-
export interface InsightPaginationV2 {
|
|
7391
|
+
countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
7094
7392
|
/**
|
|
7095
|
-
* @
|
|
7096
|
-
* @
|
|
7393
|
+
* @description Add country codes
|
|
7394
|
+
* @tags World Markets
|
|
7395
|
+
* @name CountryCodeAdd
|
|
7396
|
+
* @summary Add country codes
|
|
7397
|
+
* @request POST:/country-codes
|
|
7398
|
+
* @secure
|
|
7097
7399
|
*/
|
|
7098
|
-
|
|
7400
|
+
countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError, Format>>;
|
|
7099
7401
|
/**
|
|
7100
|
-
* @
|
|
7101
|
-
* @
|
|
7102
|
-
* @
|
|
7402
|
+
* @description Delete country code
|
|
7403
|
+
* @tags World Markets
|
|
7404
|
+
* @name CountryCodeDelete
|
|
7405
|
+
* @summary Delete country code
|
|
7406
|
+
* @request DELETE:/country-codes
|
|
7407
|
+
* @secure
|
|
7103
7408
|
*/
|
|
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>);
|
|
7409
|
+
countryCodeDelete(query: {
|
|
7410
|
+
/** a3 code */
|
|
7411
|
+
a3code: string;
|
|
7412
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
7161
7413
|
/**
|
|
7162
|
-
* @description
|
|
7163
|
-
* @tags
|
|
7164
|
-
* @name
|
|
7165
|
-
* @summary
|
|
7166
|
-
* @request
|
|
7414
|
+
* @description Get global indexes
|
|
7415
|
+
* @tags World Markets
|
|
7416
|
+
* @name GlobalIndexGet
|
|
7417
|
+
* @summary Get global indexes
|
|
7418
|
+
* @request GET:/global-indexes
|
|
7167
7419
|
* @secure
|
|
7168
7420
|
*/
|
|
7169
|
-
|
|
7170
|
-
|
|
7171
|
-
|
|
7172
|
-
|
|
7173
|
-
|
|
7421
|
+
globalIndexGet(query: {
|
|
7422
|
+
/** Query limit */
|
|
7423
|
+
limit: number;
|
|
7424
|
+
/** Query offset */
|
|
7425
|
+
offset: number;
|
|
7426
|
+
/** Continent code for filtering */
|
|
7427
|
+
continent?: string;
|
|
7428
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError, Format>>;
|
|
7174
7429
|
/**
|
|
7175
|
-
* @description
|
|
7176
|
-
* @tags
|
|
7177
|
-
* @name
|
|
7178
|
-
* @summary
|
|
7179
|
-
* @request
|
|
7430
|
+
* @description Edit global index
|
|
7431
|
+
* @tags World Markets
|
|
7432
|
+
* @name GlobalIndexEdit
|
|
7433
|
+
* @summary Edit global index
|
|
7434
|
+
* @request PUT:/global-indexes
|
|
7180
7435
|
* @secure
|
|
7181
7436
|
*/
|
|
7182
|
-
|
|
7437
|
+
globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
7183
7438
|
/**
|
|
7184
|
-
* @description
|
|
7185
|
-
* @tags
|
|
7186
|
-
* @name
|
|
7187
|
-
* @summary
|
|
7188
|
-
* @request POST:/
|
|
7439
|
+
* @description Add global indexes
|
|
7440
|
+
* @tags World Markets
|
|
7441
|
+
* @name GlobalIndexAdd
|
|
7442
|
+
* @summary Add global indexes
|
|
7443
|
+
* @request POST:/global-indexes
|
|
7444
|
+
* @secure
|
|
7445
|
+
*/
|
|
7446
|
+
globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError, Format>>;
|
|
7447
|
+
/**
|
|
7448
|
+
* @description Edit global index
|
|
7449
|
+
* @tags World Markets
|
|
7450
|
+
* @name GlobalIndexDelete
|
|
7451
|
+
* @summary Delete global index
|
|
7452
|
+
* @request DELETE:/global-indexes
|
|
7453
|
+
* @secure
|
|
7454
|
+
*/
|
|
7455
|
+
globalIndexDelete(query: {
|
|
7456
|
+
/** a3 code */
|
|
7457
|
+
a3code: string;
|
|
7458
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
7459
|
+
/**
|
|
7460
|
+
* @description Get regions
|
|
7461
|
+
* @tags World Markets
|
|
7462
|
+
* @name RegionGet
|
|
7463
|
+
* @summary Get regions
|
|
7464
|
+
* @request GET:/regions
|
|
7189
7465
|
* @secure
|
|
7190
7466
|
*/
|
|
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
|
-
|
|
7467
|
+
regionGet(query: {
|
|
7468
|
+
/** Query limit */
|
|
7469
|
+
limit: number;
|
|
7470
|
+
/** Query offset */
|
|
7471
|
+
offset: number;
|
|
7472
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError, Format>>;
|
|
7473
|
+
/**
|
|
7474
|
+
* @description Edit region
|
|
7475
|
+
* @tags World Markets
|
|
7476
|
+
* @name RegionEdit
|
|
7477
|
+
* @summary Edit region
|
|
7478
|
+
* @request PUT:/regions
|
|
7479
|
+
* @secure
|
|
7480
|
+
*/
|
|
7481
|
+
regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
7482
|
+
/**
|
|
7483
|
+
* @description Create regions
|
|
7484
|
+
* @tags World Markets
|
|
7485
|
+
* @name RegionCreate
|
|
7486
|
+
* @summary Create regions
|
|
7487
|
+
* @request POST:/regions
|
|
7488
|
+
* @secure
|
|
7489
|
+
*/
|
|
7490
|
+
regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError, Format>>;
|
|
7491
|
+
/**
|
|
7492
|
+
* @description Delete region
|
|
7493
|
+
* @tags World Markets
|
|
7494
|
+
* @name RegionDelete
|
|
7495
|
+
* @summary Delete region
|
|
7496
|
+
* @request DELETE:/regions
|
|
7497
|
+
* @secure
|
|
7498
|
+
*/
|
|
7499
|
+
regionDelete(query: {
|
|
7500
|
+
/** region id */
|
|
7501
|
+
id: string;
|
|
7502
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
7503
|
+
}
|
|
7504
|
+
export class InsightApi<HandleError extends boolean = false, Format extends CaseFormat = CaseFormat.Original> extends BaseApi<HandleError, Format, JwtClient<HandleError, Format>> {
|
|
7505
|
+
readonly config: JwtClientConfig<HandleError, Format>;
|
|
7506
|
+
alphaTools: AlphaTools<HandleError, Format>;
|
|
7507
|
+
companyProfile: CompanyProfile<HandleError, Format>;
|
|
7508
|
+
customList: CustomLists<HandleError, Format>;
|
|
7509
|
+
dashboard: Dashboard<HandleError, Format>;
|
|
7510
|
+
earning: Earnings<HandleError, Format>;
|
|
7511
|
+
fixedIncome: FixedIncome<HandleError, Format>;
|
|
7512
|
+
fund: Funds<HandleError, Format>;
|
|
7513
|
+
fundamentals: Fundamentals<HandleError, Format>;
|
|
7514
|
+
intraday: Intraday<HandleError, Format>;
|
|
7515
|
+
ipos: Ipos<HandleError, Format>;
|
|
7516
|
+
logos: Logos<HandleError, Format>;
|
|
7517
|
+
marketDates: MarketDates<HandleError, Format>;
|
|
7518
|
+
news: News<HandleError, Format>;
|
|
7519
|
+
optionGreeks: OptionGreeks<HandleError, Format>;
|
|
7520
|
+
ownerships: Ownerships<HandleError, Format>;
|
|
7521
|
+
passport: Passport<HandleError, Format>;
|
|
7522
|
+
preIpoCompanies: PreIpoCompanies<HandleError, Format>;
|
|
7523
|
+
public: Public<HandleError, Format>;
|
|
7524
|
+
quotes: Quotes<HandleError, Format>;
|
|
7525
|
+
stockScreener: StockScreener<HandleError, Format>;
|
|
7526
|
+
tiprank: TipRank<HandleError, Format>;
|
|
7527
|
+
usageTracking: UsageTracking<HandleError, Format>;
|
|
7528
|
+
worldMarkets: WorldMarkets<HandleError, Format>;
|
|
7218
7529
|
v2: {
|
|
7219
|
-
fixedIncome: FixedIncomeV2<HandleError>;
|
|
7220
|
-
stockScreener: StockScreenerV2<HandleError>;
|
|
7530
|
+
fixedIncome: FixedIncomeV2<HandleError, Format>;
|
|
7531
|
+
stockScreener: StockScreenerV2<HandleError, Format>;
|
|
7221
7532
|
};
|
|
7222
|
-
constructor(config: JwtClientConfig<HandleError>);
|
|
7533
|
+
constructor(config: JwtClientConfig<HandleError, Format>);
|
|
7223
7534
|
}
|
|
7224
7535
|
|
|
7225
7536
|
//# sourceMappingURL=index.d.ts.map
|