@orbis-systems/orbis-api-clients 1.3.1 → 1.4.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 +356 -167
- 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 +11752 -5935
- 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 +3 -1
- 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 +134 -3
- 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 +197 -51
- 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 +59 -51
- 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 +923 -90
- package/dist/uma/index.d.ts.map +1 -1
- package/dist/uma/index.esm.js +1 -1
- package/dist/uma/index.esm.js.map +1 -1
- package/dist/uma/index.js +1 -1
- package/dist/uma/index.js.map +1 -1
- package/package.json +157 -157
package/dist/aesmidas/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { AxiosError, AxiosInstance, AxiosRequestConfig, HttpStatusCode } from "axios";
|
|
1
|
+
import { AxiosError, AxiosInstance, AxiosRequestConfig, AxiosResponseHeaders, HttpStatusCode } from "axios";
|
|
2
2
|
enum CaseFormat {
|
|
3
3
|
Camel = "camel",
|
|
4
4
|
Snake = "snake",
|
|
@@ -44,12 +44,14 @@ type SuccessClientResponse<Data = unknown, RawData = unknown> = ResponseStatus &
|
|
|
44
44
|
success: true;
|
|
45
45
|
data: Data;
|
|
46
46
|
rawData: RawData;
|
|
47
|
+
headers: AxiosResponseHeaders;
|
|
47
48
|
};
|
|
48
49
|
type ErrorClientResponse = ResponseStatus & {
|
|
49
50
|
success: false;
|
|
50
51
|
data?: any;
|
|
51
52
|
rawData?: any;
|
|
52
53
|
error: unknown;
|
|
54
|
+
headers?: AxiosResponseHeaders;
|
|
53
55
|
};
|
|
54
56
|
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
57
|
declare abstract class BaseClient<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original, AuthData = unknown> {
|
|
@@ -123,6 +125,21 @@ export class BackgroundService<HandleError extends boolean = boolean, Format ext
|
|
|
123
125
|
* @secure
|
|
124
126
|
*/
|
|
125
127
|
getStatus(config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
128
|
+
/**
|
|
129
|
+
* @tags BackgroundService
|
|
130
|
+
* @name GetWsConnections
|
|
131
|
+
* @summary Get the current number of active WebSocket connection slots held by a user for a given endpoint/queryType, as tracked in Redis by WebSocketConnectionTracker.
|
|
132
|
+
* @request GET:/api/background-service/ws-connections
|
|
133
|
+
* @secure
|
|
134
|
+
*/
|
|
135
|
+
getWsConnections(query?: {
|
|
136
|
+
/** The WebSocketLimits endpoint key, e.g. "wsevent" or "wssub". */
|
|
137
|
+
wsEndpoint?: string;
|
|
138
|
+
/** The user id, matching UmaJwtPayload.UserId (e.g. "b2b_123"). */
|
|
139
|
+
userId?: string;
|
|
140
|
+
/** The subscription type, e.g. "quote". */
|
|
141
|
+
queryType?: string;
|
|
142
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
126
143
|
}
|
|
127
144
|
export interface AesMidasActionLog {
|
|
128
145
|
id?: string | null;
|
|
@@ -168,6 +185,8 @@ export interface AesMidasApplicationUser {
|
|
|
168
185
|
firm_id?: string | null;
|
|
169
186
|
source?: string | null;
|
|
170
187
|
user_type?: string | null;
|
|
188
|
+
region?: string | null;
|
|
189
|
+
uma_uuid?: string | null;
|
|
171
190
|
}
|
|
172
191
|
export interface AesMidasBestQuote {
|
|
173
192
|
symbol?: string | null;
|
|
@@ -239,7 +258,7 @@ export interface AesMidasBond {
|
|
|
239
258
|
next_call_date?: string | null;
|
|
240
259
|
/** @format double */
|
|
241
260
|
next_call_price?: number | null;
|
|
242
|
-
convertible?:
|
|
261
|
+
convertible?: boolean | null;
|
|
243
262
|
insured?: boolean | null;
|
|
244
263
|
status?: string | null;
|
|
245
264
|
municipal_state?: string | null;
|
|
@@ -250,9 +269,9 @@ export interface AesMidasBond {
|
|
|
250
269
|
treasury_subtype?: string | null;
|
|
251
270
|
ticker?: string | null;
|
|
252
271
|
sinking_fund?: boolean | null;
|
|
253
|
-
a144?:
|
|
254
|
-
reg_s?:
|
|
255
|
-
private_placement?:
|
|
272
|
+
a144?: boolean | null;
|
|
273
|
+
reg_s?: boolean | null;
|
|
274
|
+
private_placement?: boolean | null;
|
|
256
275
|
country_issue?: string | null;
|
|
257
276
|
country_domicile?: string | null;
|
|
258
277
|
day_count?: string | null;
|
|
@@ -265,7 +284,8 @@ export interface AesMidasBond {
|
|
|
265
284
|
/** @format double */
|
|
266
285
|
close_price?: number | null;
|
|
267
286
|
close_price_asof?: string | null;
|
|
268
|
-
|
|
287
|
+
/** @format double */
|
|
288
|
+
close_ytw?: number | null;
|
|
269
289
|
/** @format double */
|
|
270
290
|
issue_minimum_denomination?: number | null;
|
|
271
291
|
puttable?: boolean | null;
|
|
@@ -311,8 +331,8 @@ export interface AesMidasBondSearchBody {
|
|
|
311
331
|
/** @format date */
|
|
312
332
|
maturity_end?: string | null;
|
|
313
333
|
municipal_states?: string[] | null;
|
|
314
|
-
|
|
315
|
-
|
|
334
|
+
municipal_tax?: boolean | null;
|
|
335
|
+
municipal_types?: string[] | null;
|
|
316
336
|
purposes?: string[] | null;
|
|
317
337
|
sectors?: string[] | null;
|
|
318
338
|
sp_ratings?: string[] | null;
|
|
@@ -490,7 +510,7 @@ export interface AesMidasBondReformat {
|
|
|
490
510
|
next_call_date?: string | null;
|
|
491
511
|
/** @format double */
|
|
492
512
|
next_call_price?: number | null;
|
|
493
|
-
convertible?:
|
|
513
|
+
convertible?: boolean | null;
|
|
494
514
|
insured?: boolean | null;
|
|
495
515
|
status?: string | null;
|
|
496
516
|
municipal_state?: string | null;
|
|
@@ -501,9 +521,9 @@ export interface AesMidasBondReformat {
|
|
|
501
521
|
treasury_subtype?: string | null;
|
|
502
522
|
ticker?: string | null;
|
|
503
523
|
sinking_fund?: boolean | null;
|
|
504
|
-
a144?:
|
|
505
|
-
reg_s?:
|
|
506
|
-
private_placement?:
|
|
524
|
+
a144?: boolean | null;
|
|
525
|
+
reg_s?: boolean | null;
|
|
526
|
+
private_placement?: boolean | null;
|
|
507
527
|
country_issue?: string | null;
|
|
508
528
|
country_domicile?: string | null;
|
|
509
529
|
day_count?: string | null;
|
|
@@ -515,7 +535,8 @@ export interface AesMidasBondReformat {
|
|
|
515
535
|
/** @format double */
|
|
516
536
|
close_price?: number | null;
|
|
517
537
|
close_price_asof?: string | null;
|
|
518
|
-
|
|
538
|
+
/** @format double */
|
|
539
|
+
close_ytw?: number | null;
|
|
519
540
|
/** @format double */
|
|
520
541
|
issue_minimum_denomination?: number | null;
|
|
521
542
|
puttable?: boolean | null;
|
|
@@ -571,6 +592,23 @@ export interface AesMidasContractRecordsResponsewithPagination {
|
|
|
571
592
|
page_size?: number;
|
|
572
593
|
data?: AesMidasContractRecords[] | null;
|
|
573
594
|
}
|
|
595
|
+
export interface AesMidasCustomResponseGlobalSymbolScreener {
|
|
596
|
+
message?: string | null;
|
|
597
|
+
country?: string | null;
|
|
598
|
+
source?: string | null;
|
|
599
|
+
/**
|
|
600
|
+
* Total number of symbols matching the filters, across all pages.
|
|
601
|
+
* @format int32
|
|
602
|
+
*/
|
|
603
|
+
total_count?: number;
|
|
604
|
+
/** @format int32 */
|
|
605
|
+
total_pages?: number;
|
|
606
|
+
/** @format int32 */
|
|
607
|
+
current_page?: number;
|
|
608
|
+
/** @format int32 */
|
|
609
|
+
page_size?: number;
|
|
610
|
+
data?: AesMidasGlobalSymbolScreenerRecord[] | null;
|
|
611
|
+
}
|
|
574
612
|
export interface AesMidasDataSource {
|
|
575
613
|
/** @minLength 1 */
|
|
576
614
|
name: string;
|
|
@@ -727,12 +765,79 @@ export interface AesMidasExchanges {
|
|
|
727
765
|
type?: string | null;
|
|
728
766
|
description?: string | null;
|
|
729
767
|
}
|
|
768
|
+
export interface AesMidasFinnhubPrice {
|
|
769
|
+
symbol?: string | null;
|
|
770
|
+
/** @format double */
|
|
771
|
+
last_price?: number;
|
|
772
|
+
update_time?: string | null;
|
|
773
|
+
primary_exchange?: string | null;
|
|
774
|
+
exchange?: string | null;
|
|
775
|
+
currency?: string | null;
|
|
776
|
+
country?: string | null;
|
|
777
|
+
company_name?: string | null;
|
|
778
|
+
status?: string | null;
|
|
779
|
+
info_time?: string | null;
|
|
780
|
+
/** @format double */
|
|
781
|
+
change?: number | null;
|
|
782
|
+
/** @format double */
|
|
783
|
+
change_percent?: number | null;
|
|
784
|
+
/** @format int64 */
|
|
785
|
+
volume?: number | null;
|
|
786
|
+
/** @format int64 */
|
|
787
|
+
market_cap?: number | null;
|
|
788
|
+
dividend_ex_date?: string | null;
|
|
789
|
+
dividend_payment_date?: string | null;
|
|
790
|
+
/** @format double */
|
|
791
|
+
price_earning_ratio?: number | null;
|
|
792
|
+
/** @format double */
|
|
793
|
+
yesterday_close?: number | null;
|
|
794
|
+
/** @format int64 */
|
|
795
|
+
average_volume30?: number | null;
|
|
796
|
+
/** @format double */
|
|
797
|
+
day_high?: number | null;
|
|
798
|
+
/** @format double */
|
|
799
|
+
day_low?: number | null;
|
|
800
|
+
/** @format double */
|
|
801
|
+
high52week?: number | null;
|
|
802
|
+
/** @format double */
|
|
803
|
+
low52week?: number | null;
|
|
804
|
+
/** @format double */
|
|
805
|
+
opening_price?: number | null;
|
|
806
|
+
/** @format double */
|
|
807
|
+
closing_price?: number | null;
|
|
808
|
+
/** @format double */
|
|
809
|
+
dividend_amount?: number | null;
|
|
810
|
+
/** @format double */
|
|
811
|
+
dividend_yield?: number | null;
|
|
812
|
+
/** @format double */
|
|
813
|
+
week_change?: number | null;
|
|
814
|
+
/** @format double */
|
|
815
|
+
week_change_percent?: number | null;
|
|
816
|
+
/** @format double */
|
|
817
|
+
month_change?: number | null;
|
|
818
|
+
/** @format double */
|
|
819
|
+
month_change_percent?: number | null;
|
|
820
|
+
/** @format double */
|
|
821
|
+
year_change?: number | null;
|
|
822
|
+
/** @format double */
|
|
823
|
+
year_change_percent?: number | null;
|
|
824
|
+
/** @format double */
|
|
825
|
+
earnings_per_share?: number | null;
|
|
826
|
+
isin?: string | null;
|
|
827
|
+
figi?: string | null;
|
|
828
|
+
type?: string | null;
|
|
829
|
+
not_found?: boolean;
|
|
830
|
+
/** @format double */
|
|
831
|
+
volume_fr?: number | null;
|
|
832
|
+
}
|
|
730
833
|
export interface AesMidasFirm {
|
|
731
834
|
firm_id?: string | null;
|
|
732
835
|
full_name?: string | null;
|
|
733
836
|
/** @format int32 */
|
|
734
837
|
status?: number;
|
|
735
838
|
source?: string | null;
|
|
839
|
+
region?: string | null;
|
|
840
|
+
uma_uuid?: string | null;
|
|
736
841
|
/** @format int32 */
|
|
737
842
|
us_equity?: number;
|
|
738
843
|
nbbo_snapshot?: boolean;
|
|
@@ -1044,6 +1149,92 @@ export interface AesMidasFundWebQuote {
|
|
|
1044
1149
|
one_year_change_percent?: number;
|
|
1045
1150
|
cusip?: string | null;
|
|
1046
1151
|
}
|
|
1152
|
+
/**
|
|
1153
|
+
* Request body for POST /api/quote/global-symbol-screener. The caller defines the screen directly with
|
|
1154
|
+
* filters and sorts (like symbol-search). Only country is required; all filters are optional and inclusive
|
|
1155
|
+
* (>= low, <= high). See the endpoint description for every field's allowed values.
|
|
1156
|
+
*/
|
|
1157
|
+
export interface AesMidasGlobalSymbolScreenerBody {
|
|
1158
|
+
/** Required. Country code (e.g. "US", "DE", "JP") - determines which screener table is queried. */
|
|
1159
|
+
country?: string | null;
|
|
1160
|
+
/** Optional. Stock, ETF or UCITS (from fundamental.etf / fundamental.ucits). Omit for all asset types. */
|
|
1161
|
+
asset_type?: string | null;
|
|
1162
|
+
/**
|
|
1163
|
+
* Optional. Minimum market cap in USD (FX-converted), inclusive.
|
|
1164
|
+
* @format double
|
|
1165
|
+
*/
|
|
1166
|
+
market_cap_usd_low?: number | null;
|
|
1167
|
+
/**
|
|
1168
|
+
* Optional. Minimum last price in USD (FX-converted), inclusive.
|
|
1169
|
+
* @format double
|
|
1170
|
+
*/
|
|
1171
|
+
last_price_usd_low?: number | null;
|
|
1172
|
+
/**
|
|
1173
|
+
* Optional. Minimum current-session volume, inclusive.
|
|
1174
|
+
* @format int64
|
|
1175
|
+
*/
|
|
1176
|
+
volume_low?: number | null;
|
|
1177
|
+
/**
|
|
1178
|
+
* Optional. Minimum daily change in percent (2.5 = +2.5%), inclusive.
|
|
1179
|
+
* @format double
|
|
1180
|
+
*/
|
|
1181
|
+
change_percent_low?: number | null;
|
|
1182
|
+
/**
|
|
1183
|
+
* Optional. Maximum daily change in percent (-2.5 = -2.5%), inclusive.
|
|
1184
|
+
* @format double
|
|
1185
|
+
*/
|
|
1186
|
+
change_percent_high?: number | null;
|
|
1187
|
+
/**
|
|
1188
|
+
* Optional. sort_by one of market_cap_usd, last_price_usd, volume, change_percent, symbol;
|
|
1189
|
+
* default market_cap_usd desc. symbol asc is always appended as the final tie-breaker.
|
|
1190
|
+
*/
|
|
1191
|
+
sorts?: AesMidasSort[] | null;
|
|
1192
|
+
pagination?: AesMidasPagination;
|
|
1193
|
+
[key: string]: any;
|
|
1194
|
+
}
|
|
1195
|
+
/**
|
|
1196
|
+
* One row of a global symbol screener result. Market cap/price are both reported in their
|
|
1197
|
+
* original listing currency and normalized to USD (live FX conversion via Redis FX:RATE:*)
|
|
1198
|
+
* since USD is what eligibility/ranking thresholds are evaluated against per the PRD.
|
|
1199
|
+
*/
|
|
1200
|
+
export interface AesMidasGlobalSymbolScreenerRecord {
|
|
1201
|
+
symbol?: string | null;
|
|
1202
|
+
company_name?: string | null;
|
|
1203
|
+
country_code?: string | null;
|
|
1204
|
+
currency?: string | null;
|
|
1205
|
+
primary_exchange?: string | null;
|
|
1206
|
+
mic?: string | null;
|
|
1207
|
+
/** @format double */
|
|
1208
|
+
last_price?: number | null;
|
|
1209
|
+
/** @format double */
|
|
1210
|
+
last_price_usd?: number | null;
|
|
1211
|
+
/** @format double */
|
|
1212
|
+
open_px?: number | null;
|
|
1213
|
+
/** @format double */
|
|
1214
|
+
high_px?: number | null;
|
|
1215
|
+
/** @format double */
|
|
1216
|
+
low_px?: number | null;
|
|
1217
|
+
/** @format double */
|
|
1218
|
+
closing_px?: number | null;
|
|
1219
|
+
/** @format double */
|
|
1220
|
+
prev_close?: number | null;
|
|
1221
|
+
/** @format double */
|
|
1222
|
+
price_change?: number | null;
|
|
1223
|
+
/** @format double */
|
|
1224
|
+
change_percent?: number | null;
|
|
1225
|
+
/** @format int64 */
|
|
1226
|
+
volume?: number | null;
|
|
1227
|
+
/** @format int64 */
|
|
1228
|
+
avg_vol30d?: number | null;
|
|
1229
|
+
/** @format double */
|
|
1230
|
+
market_cap?: number | null;
|
|
1231
|
+
/** @format double */
|
|
1232
|
+
market_cap_usd?: number | null;
|
|
1233
|
+
status?: string | null;
|
|
1234
|
+
/** Stock, ETF, or UCITS - derived from fundamental.etf / fundamental.ucits. */
|
|
1235
|
+
asset_type?: string | null;
|
|
1236
|
+
isin?: string | null;
|
|
1237
|
+
}
|
|
1047
1238
|
export interface AesMidasHistoricalBondChartApex {
|
|
1048
1239
|
/** @format date-time */
|
|
1049
1240
|
timestamp?: string;
|
|
@@ -1306,6 +1497,11 @@ export interface AesMidasIsinInfo {
|
|
|
1306
1497
|
name_addr?: string | null;
|
|
1307
1498
|
primary_name?: string | null;
|
|
1308
1499
|
currency?: string | null;
|
|
1500
|
+
status?: string | null;
|
|
1501
|
+
security_type?: string | null;
|
|
1502
|
+
ucits?: boolean | null;
|
|
1503
|
+
etf?: boolean | null;
|
|
1504
|
+
update_time?: string | null;
|
|
1309
1505
|
tickers_info?: Record<string, string | null>;
|
|
1310
1506
|
}
|
|
1311
1507
|
export interface AesMidasLevel1 {
|
|
@@ -1648,6 +1844,7 @@ export interface AesMidasMutualFund {
|
|
|
1648
1844
|
week52_low_date?: string | null;
|
|
1649
1845
|
trade_time?: string | null;
|
|
1650
1846
|
update_time?: string | null;
|
|
1847
|
+
currency?: string | null;
|
|
1651
1848
|
}
|
|
1652
1849
|
export interface AesMidasNightSession {
|
|
1653
1850
|
symbol?: string | null;
|
|
@@ -1893,10 +2090,14 @@ export interface AesMidasOptionL1WithGreeks {
|
|
|
1893
2090
|
option_greek?: AesMidasOptionGreek;
|
|
1894
2091
|
}
|
|
1895
2092
|
export interface AesMidasPagination {
|
|
1896
|
-
/**
|
|
2093
|
+
/**
|
|
2094
|
+
* 1-based page number; values below 1 are treated as 1.
|
|
2095
|
+
* @format int32
|
|
2096
|
+
*/
|
|
1897
2097
|
page_number?: number;
|
|
1898
2098
|
/** @format int32 */
|
|
1899
2099
|
page_size?: number;
|
|
2100
|
+
[key: string]: any;
|
|
1900
2101
|
}
|
|
1901
2102
|
export interface AesMidasPermission {
|
|
1902
2103
|
/** @minLength 1 */
|
|
@@ -2259,6 +2460,7 @@ export interface AesMidasSnapshotReportResponsewithPagination {
|
|
|
2259
2460
|
export interface AesMidasSort {
|
|
2260
2461
|
sort_by?: string | null;
|
|
2261
2462
|
sort_order?: string | null;
|
|
2463
|
+
[key: string]: any;
|
|
2262
2464
|
}
|
|
2263
2465
|
export interface AesMidasSymbolSearchBody {
|
|
2264
2466
|
symbol_include?: string[] | null;
|
|
@@ -2426,40 +2628,25 @@ export interface AesMidasTop20 {
|
|
|
2426
2628
|
data_source?: string | null;
|
|
2427
2629
|
}
|
|
2428
2630
|
export interface AesMidasUMAB2BUser {
|
|
2429
|
-
allow_feedback?: boolean;
|
|
2430
|
-
created_at?: string | null;
|
|
2431
|
-
do_not_ask_mfa_again?: boolean;
|
|
2432
|
-
email?: string | null;
|
|
2433
|
-
email_verified?: boolean;
|
|
2434
2631
|
/** @format int32 */
|
|
2435
2632
|
id?: number;
|
|
2436
|
-
|
|
2437
|
-
|
|
2633
|
+
username?: string | null;
|
|
2634
|
+
email?: string | null;
|
|
2635
|
+
email_verified?: boolean;
|
|
2636
|
+
phone?: string | null;
|
|
2637
|
+
phone_verified?: boolean;
|
|
2438
2638
|
first_name?: string | null;
|
|
2439
2639
|
last_name?: string | null;
|
|
2440
|
-
locale?: AesMidasUMALocale;
|
|
2441
|
-
/** @format int32 */
|
|
2442
|
-
locale_id?: number | null;
|
|
2443
2640
|
mfa_enabled?: boolean;
|
|
2444
|
-
|
|
2445
|
-
|
|
2446
|
-
|
|
2447
|
-
|
|
2448
|
-
|
|
2449
|
-
username?: string | null;
|
|
2641
|
+
/** @format int32 */
|
|
2642
|
+
primary_firm_id?: number;
|
|
2643
|
+
primary_firm_uuid?: string | null;
|
|
2644
|
+
region?: string | null;
|
|
2645
|
+
uuid?: string | null;
|
|
2450
2646
|
status?: string | null;
|
|
2451
2647
|
firms?: AesMidasUMAUserFirm[] | null;
|
|
2452
|
-
big_avatar_url?: string | null;
|
|
2453
|
-
branches?: AesMidasUMABranch[] | null;
|
|
2454
|
-
has_access_to_all_firm_branches?: boolean;
|
|
2455
|
-
microservices?: AesMidasUMAUserMicroservice[] | null;
|
|
2456
|
-
mode?: string | null;
|
|
2457
2648
|
permissions?: AesMidasUMAPermission[] | null;
|
|
2458
|
-
/** @format int32 */
|
|
2459
|
-
primary_firm_id?: number;
|
|
2460
2649
|
roles?: AesMidasUMARole[] | null;
|
|
2461
|
-
small_avatar_url?: string | null;
|
|
2462
|
-
theme?: string | null;
|
|
2463
2650
|
}
|
|
2464
2651
|
export interface AesMidasUMAB2BUserResponsewithPagination {
|
|
2465
2652
|
/** @format int32 */
|
|
@@ -2473,31 +2660,23 @@ export interface AesMidasUMAB2BUserResponsewithPagination {
|
|
|
2473
2660
|
data?: AesMidasUMAB2BUser[] | null;
|
|
2474
2661
|
}
|
|
2475
2662
|
export interface AesMidasUMAB2CUser {
|
|
2476
|
-
allow_feedback?: boolean;
|
|
2477
|
-
created_at?: string | null;
|
|
2478
|
-
do_not_ask_mfa_again?: boolean;
|
|
2479
|
-
email?: string | null;
|
|
2480
|
-
email_verified?: boolean;
|
|
2481
2663
|
/** @format int32 */
|
|
2482
2664
|
id?: number;
|
|
2483
|
-
|
|
2484
|
-
|
|
2665
|
+
username?: string | null;
|
|
2666
|
+
email?: string | null;
|
|
2667
|
+
email_verified?: boolean;
|
|
2668
|
+
phone?: string | null;
|
|
2669
|
+
phone_verified?: boolean;
|
|
2485
2670
|
first_name?: string | null;
|
|
2486
2671
|
last_name?: string | null;
|
|
2487
|
-
locale?: AesMidasUMALocale;
|
|
2488
|
-
/** @format int32 */
|
|
2489
|
-
locale_id?: number | null;
|
|
2490
2672
|
mfa_enabled?: boolean;
|
|
2491
|
-
|
|
2492
|
-
|
|
2493
|
-
|
|
2494
|
-
|
|
2495
|
-
|
|
2496
|
-
username?: string | null;
|
|
2673
|
+
/** @format int32 */
|
|
2674
|
+
primary_firm_id?: number;
|
|
2675
|
+
primary_firm_uuid?: string | null;
|
|
2676
|
+
region?: string | null;
|
|
2677
|
+
uuid?: string | null;
|
|
2497
2678
|
status?: string | null;
|
|
2498
2679
|
firms?: AesMidasUMAUserFirm[] | null;
|
|
2499
|
-
branches?: AesMidasUMABranch[] | null;
|
|
2500
|
-
microservices?: AesMidasUMAUserMicroservice[] | null;
|
|
2501
2680
|
permissions?: AesMidasUMAPermission[] | null;
|
|
2502
2681
|
roles?: AesMidasUMARole[] | null;
|
|
2503
2682
|
}
|
|
@@ -2512,36 +2691,13 @@ export interface AesMidasUMAB2CUserResponsewithPagination {
|
|
|
2512
2691
|
page_size?: number;
|
|
2513
2692
|
data?: AesMidasUMAB2CUser[] | null;
|
|
2514
2693
|
}
|
|
2515
|
-
export interface AesMidasUMABranch {
|
|
2516
|
-
code?: string | null;
|
|
2517
|
-
/** @format int32 */
|
|
2518
|
-
firm_id?: number;
|
|
2519
|
-
/** @format int32 */
|
|
2520
|
-
id?: number;
|
|
2521
|
-
name?: string | null;
|
|
2522
|
-
slug?: string | null;
|
|
2523
|
-
}
|
|
2524
|
-
export interface AesMidasUMADomain {
|
|
2525
|
-
internal_domain?: string | null;
|
|
2526
|
-
internal_protocol?: string | null;
|
|
2527
|
-
public_path_prefix?: string | null;
|
|
2528
|
-
}
|
|
2529
2694
|
export interface AesMidasUMAFirm {
|
|
2530
|
-
/** @format int32 */
|
|
2531
|
-
admins_count?: number;
|
|
2532
|
-
allow_b2c_email_notifications?: boolean;
|
|
2533
|
-
branches?: AesMidasUMABranch[] | null;
|
|
2534
|
-
/** @format int32 */
|
|
2535
|
-
branches_count?: number;
|
|
2536
|
-
created_at?: string | null;
|
|
2537
2695
|
/** @format int32 */
|
|
2538
2696
|
id?: number;
|
|
2539
|
-
last_status_change_at?: string | null;
|
|
2540
2697
|
name?: string | null;
|
|
2541
|
-
slug?: string | null;
|
|
2542
2698
|
status?: string | null;
|
|
2543
|
-
|
|
2544
|
-
|
|
2699
|
+
region?: string | null;
|
|
2700
|
+
uuid?: string | null;
|
|
2545
2701
|
}
|
|
2546
2702
|
export interface AesMidasUMAFirmResponsewithPagination {
|
|
2547
2703
|
/** @format int32 */
|
|
@@ -2555,102 +2711,31 @@ export interface AesMidasUMAFirmResponsewithPagination {
|
|
|
2555
2711
|
data?: AesMidasUMAFirm[] | null;
|
|
2556
2712
|
}
|
|
2557
2713
|
export interface AesMidasUMAFirmBasic {
|
|
2558
|
-
/** @format int32 */
|
|
2559
|
-
admins_count?: number;
|
|
2560
|
-
allow_b2c_email_notifications?: boolean;
|
|
2561
|
-
branches?: AesMidasUMABranch[] | null;
|
|
2562
|
-
/** @format int32 */
|
|
2563
|
-
branches_count?: number;
|
|
2564
|
-
created_at?: string | null;
|
|
2565
2714
|
/** @format int32 */
|
|
2566
2715
|
id?: number;
|
|
2567
|
-
last_status_change_at?: string | null;
|
|
2568
2716
|
name?: string | null;
|
|
2569
|
-
slug?: string | null;
|
|
2570
2717
|
status?: string | null;
|
|
2571
|
-
|
|
2572
|
-
|
|
2573
|
-
export interface AesMidasUMALocale {
|
|
2574
|
-
/** @format int32 */
|
|
2575
|
-
id?: number;
|
|
2576
|
-
locale?: string | null;
|
|
2577
|
-
name?: string | null;
|
|
2578
|
-
}
|
|
2579
|
-
export interface AesMidasUMAMetadata {
|
|
2580
|
-
entities?: Record<string, any>;
|
|
2581
|
-
is_microservice_global?: boolean;
|
|
2718
|
+
region?: string | null;
|
|
2719
|
+
uuid?: string | null;
|
|
2582
2720
|
}
|
|
2583
2721
|
export interface AesMidasUMAPermission {
|
|
2584
|
-
assignment_group?: string | null;
|
|
2585
|
-
created_at?: string | null;
|
|
2586
|
-
/** @format int32 */
|
|
2587
|
-
id?: number;
|
|
2588
|
-
metadata?: AesMidasUMAMetadata;
|
|
2589
|
-
microservice?: AesMidasUMAUserMicroservice;
|
|
2590
|
-
/** @format int32 */
|
|
2591
|
-
microservice_id?: number | null;
|
|
2592
2722
|
permission?: string | null;
|
|
2593
|
-
updated_at?: string | null;
|
|
2594
2723
|
}
|
|
2595
2724
|
export interface AesMidasUMARole {
|
|
2596
|
-
created_at?: string | null;
|
|
2597
|
-
firm?: AesMidasUMAFirmBasic;
|
|
2598
|
-
/** @format int32 */
|
|
2599
|
-
firm_id?: number | null;
|
|
2600
|
-
/** @format int32 */
|
|
2601
|
-
id?: number;
|
|
2602
|
-
microservice?: AesMidasUMAUserMicroservice;
|
|
2603
|
-
/** @format int32 */
|
|
2604
|
-
microservice_id?: number | null;
|
|
2605
2725
|
name?: string | null;
|
|
2726
|
+
microservice?: AesMidasUMARoleMicroservice;
|
|
2606
2727
|
permissions?: AesMidasUMAPermission[] | null;
|
|
2607
|
-
type?: AesMidasUMARoleType;
|
|
2608
|
-
/** @format int32 */
|
|
2609
|
-
type_id?: number;
|
|
2610
|
-
updated_at?: string | null;
|
|
2611
2728
|
}
|
|
2612
|
-
export interface
|
|
2613
|
-
|
|
2614
|
-
created_at?: string | null;
|
|
2615
|
-
/** @format int32 */
|
|
2616
|
-
id?: number;
|
|
2617
|
-
type?: string | null;
|
|
2618
|
-
updated_at?: string | null;
|
|
2619
|
-
}
|
|
2620
|
-
export interface AesMidasUMATwilioCreds {
|
|
2621
|
-
account_sid?: string | null;
|
|
2622
|
-
auth_token?: string | null;
|
|
2623
|
-
phone_number?: string | null;
|
|
2624
|
-
subaccount_sid?: string | null;
|
|
2729
|
+
export interface AesMidasUMARoleMicroservice {
|
|
2730
|
+
slug?: string | null;
|
|
2625
2731
|
}
|
|
2626
2732
|
export interface AesMidasUMAUserFirm {
|
|
2627
|
-
/** @format int32 */
|
|
2628
|
-
admins_count?: number;
|
|
2629
|
-
allow_b2c_email_notifications?: boolean;
|
|
2630
|
-
branches?: AesMidasUMABranch[] | null;
|
|
2631
|
-
/** @format int32 */
|
|
2632
|
-
branches_count?: number;
|
|
2633
|
-
created_at?: string | null;
|
|
2634
2733
|
/** @format int32 */
|
|
2635
2734
|
id?: number;
|
|
2636
|
-
last_status_change_at?: string | null;
|
|
2637
2735
|
name?: string | null;
|
|
2638
|
-
slug?: string | null;
|
|
2639
2736
|
status?: string | null;
|
|
2640
|
-
|
|
2641
|
-
|
|
2642
|
-
}
|
|
2643
|
-
export interface AesMidasUMAUserMicroservice {
|
|
2644
|
-
/** @format int32 */
|
|
2645
|
-
id?: number;
|
|
2646
|
-
is_active?: boolean;
|
|
2647
|
-
is_visible_on_admin_sidebar?: boolean;
|
|
2648
|
-
logo_url?: string | null;
|
|
2649
|
-
name?: string | null;
|
|
2650
|
-
slug?: string | null;
|
|
2651
|
-
created_at?: string | null;
|
|
2652
|
-
domains?: AesMidasUMADomain[] | null;
|
|
2653
|
-
updated_at?: string | null;
|
|
2737
|
+
region?: string | null;
|
|
2738
|
+
uuid?: string | null;
|
|
2654
2739
|
}
|
|
2655
2740
|
export interface AesMidasUserDataConfig {
|
|
2656
2741
|
/** @minLength 1 */
|
|
@@ -3584,6 +3669,31 @@ export class Quote<HandleError extends boolean = boolean, Format extends CaseFor
|
|
|
3584
3669
|
/** @default "" */
|
|
3585
3670
|
platform?: string;
|
|
3586
3671
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasSymbolSearchRecordResponsewithPagination, HandleError, Format>>;
|
|
3672
|
+
/**
|
|
3673
|
+
* @description Screens one country's active symbols with caller-supplied filters and sorts. A symbol must be active ('A' or 'T') in both the source data and the fundamental data; symbols without a fundamental record are excluded. **Request body** | Field | Required | Type | Allowed values / usage | |---|---|---|---| | `country` | **Required** | string | Case-insensitive. Determines the data source: `US` (Polygon); `AT`, `BE`, `CH`, `DE`, `DK`, `ES`, `FI`, `FR`, `IE`, `IT`, `L` (UK), `NL`, `NO`, `SE` (Finnhub); `AU`, `CA`, `HK`, `ID`, `IL`, `JP`, `NZ`, `PT`, `SG`, `TH`, `TW` (Quodd EOD). Any other value returns 400. | | `asset_type` | Optional | string | Case-insensitive. `Stock`, `ETF` or `UCITS`. Omit to include all asset types. | | `market_cap_usd_low` | Optional | number | Minimum market cap in USD (FX-converted), inclusive. Symbols with no market cap are excluded when set. e.g. `100000000` = USD 100M. | | `last_price_usd_low` | Optional | number | Minimum last price in USD (FX-converted), inclusive. Symbols with no price are excluded when set. e.g. `5` = USD 5. | | `volume_low` | Optional | integer | Minimum current-session volume (shares), inclusive. Symbols with no volume are excluded when set. | | `change_percent_low` | Optional | number | Minimum daily change in percent, inclusive (e.g. `2.5` = +2.5%). Use a small positive value such as `0.0001` to keep only rising symbols. | | `change_percent_high` | Optional | number | Maximum daily change in percent, inclusive (e.g. `-2.5` = -2.5%). Use `-0.0001` to keep only falling symbols. Must be >= `change_percent_low` when both are set. | | `sorts` | Optional | array of `{ sort_by, sort_order }` | Applied in order. `sort_by`: `market_cap_usd`, `last_price_usd`, `volume`, `change_percent`, `symbol`. `sort_order`: `asc` (default) or `desc`. Default when omitted: `market_cap_usd` desc. A symbol with no value for the **first** sort field is excluded (it cannot be ranked). `symbol` asc is always added as the final tie-breaker. | | `pagination` | Optional | `{ page_number, page_size }` | `page_number`: default 1 (values below 1 are treated as 1). `page_size`: default 20, maximum 30 (larger values are capped at 30). | Any other key in the body, in `pagination` or in a `sorts` item is rejected with 400, so a misspelled filter is never silently ignored. **Default (only `country` sent)**, e.g. `{"country":"DE"}`: every active symbol of that country across all asset types (Stock, ETF, UCITS), with no market cap / price / volume / change floors, sorted by `market_cap_usd` desc then `symbol` asc, first page of 20. Because `market_cap_usd` is the default first sort field, symbols without a USD market cap are excluded - those with no market cap in the source (often ETFs / UCITS) or whose currency has no FX rate available - so in practice the default result is mostly stocks, largest first. **Response**: `total_count` is the number of matches across all pages; `total_pages`, `current_page` and `page_size` describe the returned page; `data` holds the page's symbols. `last_price_usd` / `market_cap_usd` are the FX-converted values (null when no FX rate is available); `last_price` / `market_cap` are in the listing currency. **Example bodies for the Discovery screeners** : | Screener | Body | |---|---| | Popular stocks | `{"country":"DE","asset_type":"Stock","market_cap_usd_low":100000000,"sorts":[{"sort_by":"market_cap_usd","sort_order":"desc"},{"sort_by":"volume","sort_order":"desc"}]}` | | Trending stocks | `{"country":"DE","asset_type":"Stock","last_price_usd_low":5,"sorts":[{"sort_by":"volume","sort_order":"desc"},{"sort_by":"change_percent","sort_order":"desc"},{"sort_by":"market_cap_usd","sort_order":"desc"}]}` | | Stock gainers | `{"country":"DE","asset_type":"Stock","last_price_usd_low":5,"change_percent_low":0.0001,"sorts":[{"sort_by":"change_percent","sort_order":"desc"},{"sort_by":"volume","sort_order":"desc"},{"sort_by":"market_cap_usd","sort_order":"desc"}]}` | | Stock losers | `{"country":"DE","asset_type":"Stock","last_price_usd_low":5,"change_percent_high":-0.0001,"sorts":[{"sort_by":"change_percent","sort_order":"asc"},{"sort_by":"volume","sort_order":"desc"},{"sort_by":"market_cap_usd","sort_order":"desc"}]}` | | Trending ETFs | `{"country":"US","asset_type":"ETF","last_price_usd_low":5,"sorts":[{"sort_by":"volume","sort_order":"desc"},{"sort_by":"change_percent","sort_order":"desc"}]}` | | ETF gainers | `{"country":"US","asset_type":"ETF","last_price_usd_low":5,"change_percent_low":0.0001,"sorts":[{"sort_by":"change_percent","sort_order":"desc"},{"sort_by":"volume","sort_order":"desc"}]}` | | ETF losers | `{"country":"US","asset_type":"ETF","last_price_usd_low":5,"change_percent_high":-0.0001,"sorts":[{"sort_by":"change_percent","sort_order":"asc"},{"sort_by":"volume","sort_order":"desc"}]}` | | Trending UCITS | `{"country":"DE","asset_type":"UCITS","last_price_usd_low":5,"sorts":[{"sort_by":"volume","sort_order":"desc"},{"sort_by":"change_percent","sort_order":"desc"}]}` | | UCITS gainers | `{"country":"DE","asset_type":"UCITS","last_price_usd_low":5,"change_percent_low":0.0001,"sorts":[{"sort_by":"change_percent","sort_order":"desc"},{"sort_by":"volume","sort_order":"desc"}]}` | | UCITS losers | `{"country":"DE","asset_type":"UCITS","last_price_usd_low":5,"change_percent_high":-0.0001,"sorts":[{"sort_by":"change_percent","sort_order":"asc"},{"sort_by":"volume","sort_order":"desc"}]}` | Popular ETFs / Popular UCITS rank by AUM, which has no data source yet, so they have no example. Add `"pagination":{"page_number":1,"page_size":30}` to any of these to get the top 30.
|
|
3674
|
+
* @tags Quote
|
|
3675
|
+
* @name PostGlobalSymbolScreener
|
|
3676
|
+
* @summary Global Symbol Screener (Discovery)
|
|
3677
|
+
* @request POST:/api/quote/global-symbol-screener
|
|
3678
|
+
* @secure
|
|
3679
|
+
*/
|
|
3680
|
+
postGlobalSymbolScreener(data: AesMidasGlobalSymbolScreenerBody, query?: {
|
|
3681
|
+
/**
|
|
3682
|
+
* true/false, response will be in camel case if true
|
|
3683
|
+
* @default false
|
|
3684
|
+
*/
|
|
3685
|
+
response_camel_case?: boolean;
|
|
3686
|
+
/**
|
|
3687
|
+
* optional, for enterprise client to send end user info
|
|
3688
|
+
* @default ""
|
|
3689
|
+
*/
|
|
3690
|
+
user_name?: string;
|
|
3691
|
+
/**
|
|
3692
|
+
* optional, user can send query platform
|
|
3693
|
+
* @default ""
|
|
3694
|
+
*/
|
|
3695
|
+
platform?: string;
|
|
3696
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasCustomResponseGlobalSymbolScreener, HandleError, Format>>;
|
|
3587
3697
|
/**
|
|
3588
3698
|
* @tags Quote
|
|
3589
3699
|
* @name GetSymbolList
|
|
@@ -4134,7 +4244,7 @@ export class Quote<HandleError extends boolean = boolean, Format extends CaseFor
|
|
|
4134
4244
|
/** search string */
|
|
4135
4245
|
criteria: string;
|
|
4136
4246
|
/**
|
|
4137
|
-
* how many records that need to return,
|
|
4247
|
+
* how many records that need to return, 1 to 100; any other value uses 100
|
|
4138
4248
|
* @format int32
|
|
4139
4249
|
* @default 20
|
|
4140
4250
|
*/
|
|
@@ -4171,7 +4281,7 @@ export class Quote<HandleError extends boolean = boolean, Format extends CaseFor
|
|
|
4171
4281
|
*/
|
|
4172
4282
|
getBondScreenerFieldValues(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasBondFieldValues, HandleError, Format>>;
|
|
4173
4283
|
/**
|
|
4174
|
-
* @description For fields possible value, please query in endpoint '
|
|
4284
|
+
* @description For fields possible value, please query in endpoint 'bond-screener-field-values'
|
|
4175
4285
|
* @tags Quote
|
|
4176
4286
|
* @name PostBondsScreener
|
|
4177
4287
|
* @summary Bond screener - All users
|
|
@@ -4563,6 +4673,24 @@ export class Quote<HandleError extends boolean = boolean, Format extends CaseFor
|
|
|
4563
4673
|
/** @default "" */
|
|
4564
4674
|
platform?: string;
|
|
4565
4675
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasPolygonFMV[], HandleError, Format>>;
|
|
4676
|
+
/**
|
|
4677
|
+
* @tags Quote
|
|
4678
|
+
* @name GetFinnhubPrice
|
|
4679
|
+
* @summary Query Finnhub price data - All users - available in Microservice
|
|
4680
|
+
* @request GET:/api/quote/finnhub/price
|
|
4681
|
+
* @secure
|
|
4682
|
+
*/
|
|
4683
|
+
getFinnhubPrice(query: {
|
|
4684
|
+
/** Allow multiple symbols, separated by ',' */
|
|
4685
|
+
symbols: string;
|
|
4686
|
+
/**
|
|
4687
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
4688
|
+
* @default ""
|
|
4689
|
+
*/
|
|
4690
|
+
user_name?: string;
|
|
4691
|
+
/** @default "" */
|
|
4692
|
+
platform?: string;
|
|
4693
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasFinnhubPrice[], HandleError, Format>>;
|
|
4566
4694
|
/**
|
|
4567
4695
|
* @tags Quote
|
|
4568
4696
|
* @name GetPolygonMinuteChart
|
|
@@ -4627,14 +4755,54 @@ export class Quote<HandleError extends boolean = boolean, Format extends CaseFor
|
|
|
4627
4755
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
4628
4756
|
/**
|
|
4629
4757
|
* @tags Quote
|
|
4630
|
-
* @name
|
|
4631
|
-
* @summary Fetch
|
|
4632
|
-
* @request GET:/api/quote/equity-
|
|
4758
|
+
* @name GetEquityEod
|
|
4759
|
+
* @summary Fetch equity EOD file (.parquet format)
|
|
4760
|
+
* @request GET:/api/quote/equity-eod
|
|
4633
4761
|
* @secure
|
|
4634
4762
|
*/
|
|
4635
|
-
|
|
4763
|
+
getEquityEod(query?: {
|
|
4764
|
+
/** Optional. yyyy-MM-dd. If omitted, returns the most recent available file (looks back up to 30 days). */
|
|
4636
4765
|
date?: string;
|
|
4766
|
+
/**
|
|
4767
|
+
* Optional. One of 'ice' (default), 'ice_eod', 'quodd_eod'.
|
|
4768
|
+
* @default "ice"
|
|
4769
|
+
*/
|
|
4770
|
+
source?: string;
|
|
4771
|
+
/**
|
|
4772
|
+
* Optional. Country short code, default 'US' (e.g. AT, BE, CH, DE, DK, ES, FI, FR, HK, ID, IE, IL, IT, JP, KR, GB(For .L symbols), MY, NL, NO, PT, SE, SG, TH, TW, CA(include .CA, .TO, .V), AU, NZ, US).
|
|
4773
|
+
* @default "US"
|
|
4774
|
+
*/
|
|
4775
|
+
country?: string;
|
|
4776
|
+
/**
|
|
4777
|
+
* Optional, default false. false returns the basic file ({yyyyMMdd}_basic.parquet); true returns the full file ({yyyyMMdd}.parquet).
|
|
4778
|
+
* @default false
|
|
4779
|
+
*/
|
|
4780
|
+
fullVersion?: boolean;
|
|
4781
|
+
/**
|
|
4782
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
4783
|
+
* @default ""
|
|
4784
|
+
*/
|
|
4785
|
+
user_name?: string;
|
|
4637
4786
|
/** @default "" */
|
|
4787
|
+
platform?: string;
|
|
4788
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
|
|
4789
|
+
/**
|
|
4790
|
+
* @description Files are stored as fx/quodd_fx/{yyyyMMdd}/{HHmmss}.parquet; a day can have more than one file. No date/time: returns the most recent available file (looks back up to 30 days). date only: returns the latest file on that day. date and time: returns that exact file, or 404 if it does not exist.
|
|
4791
|
+
* @tags Quote
|
|
4792
|
+
* @name GetForexFile
|
|
4793
|
+
* @summary Fetch forex file (.parquet format)
|
|
4794
|
+
* @request GET:/api/quote/forex-file
|
|
4795
|
+
* @secure
|
|
4796
|
+
*/
|
|
4797
|
+
getForexFile(query?: {
|
|
4798
|
+
/** Optional. yyyy-MM-dd. */
|
|
4799
|
+
date?: string;
|
|
4800
|
+
/** Optional, requires date. HHmmss or HH:mm:ss, matching the file name (e.g. 231243). */
|
|
4801
|
+
time?: string;
|
|
4802
|
+
/**
|
|
4803
|
+
* Optional. Must input if enterprise user query on behave of their clients
|
|
4804
|
+
* @default ""
|
|
4805
|
+
*/
|
|
4638
4806
|
user_name?: string;
|
|
4639
4807
|
/** @default "" */
|
|
4640
4808
|
platform?: string;
|
|
@@ -4761,7 +4929,23 @@ export class QuotesReformat<HandleError extends boolean = boolean, Format extend
|
|
|
4761
4929
|
* @default false
|
|
4762
4930
|
*/
|
|
4763
4931
|
useInBlocklist?: boolean;
|
|
4932
|
+
/**
|
|
4933
|
+
* Optional. Letters among S/E/U (case-insensitive) to filter by symbol type: S=Stock (not ETF or UCITS), E=ETF, U=UCITS.
|
|
4934
|
+
* e.g. "S" for stocks only, "EU" for ETF or UCITS. If not provided, no type filter is applied.
|
|
4935
|
+
*/
|
|
4936
|
+
symbolTypes?: string;
|
|
4764
4937
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
|
|
4938
|
+
/**
|
|
4939
|
+
* @tags QuotesReformat
|
|
4940
|
+
* @name PostBlocklist
|
|
4941
|
+
* @summary Uploads the full contents of a named symbol block list, replacing any existing contents. Stored as a Redis Set in the User Cache Redis, read back by the symbol search endpoints.
|
|
4942
|
+
* @request POST:/api/quotes/blocklist
|
|
4943
|
+
* @secure
|
|
4944
|
+
*/
|
|
4945
|
+
postBlocklist(query: {
|
|
4946
|
+
/** Block list name. Only recognized values are accepted (currently: IndiaBlockList). */
|
|
4947
|
+
listName: string;
|
|
4948
|
+
}, data: string[], config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
|
|
4765
4949
|
/**
|
|
4766
4950
|
* @tags QuotesReformat
|
|
4767
4951
|
* @name GetSearchRedis
|
|
@@ -4815,6 +4999,11 @@ export class QuotesReformat<HandleError extends boolean = boolean, Format extend
|
|
|
4815
4999
|
* @default false
|
|
4816
5000
|
*/
|
|
4817
5001
|
useInBlocklist?: boolean;
|
|
5002
|
+
/**
|
|
5003
|
+
* Optional. Letters among S/E/U (case-insensitive) to filter by symbol type: S=Stock (not ETF or UCITS), E=ETF, U=UCITS.
|
|
5004
|
+
* e.g. "S" for stocks only, "EU" for ETF or UCITS. If not provided, no type filter is applied.
|
|
5005
|
+
*/
|
|
5006
|
+
symbolTypes?: string;
|
|
4818
5007
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
|
|
4819
5008
|
/**
|
|
4820
5009
|
* @tags QuotesReformat
|
|
@@ -4925,7 +5114,7 @@ export class QuotesReformat<HandleError extends boolean = boolean, Format extend
|
|
|
4925
5114
|
/** search string */
|
|
4926
5115
|
criteria: string;
|
|
4927
5116
|
/**
|
|
4928
|
-
* how many records that need to return,
|
|
5117
|
+
* how many records that need to return, 1 to 100; any other value uses 100
|
|
4929
5118
|
* @format int32
|
|
4930
5119
|
* @default 20
|
|
4931
5120
|
*/
|