@orbis-systems/orbis-api-clients 1.3.2 → 1.4.1

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.
Files changed (37) hide show
  1. package/dist/aesmidas/index.d.ts +353 -166
  2. package/dist/aesmidas/index.d.ts.map +1 -1
  3. package/dist/aesmidas/index.esm.js +1 -1
  4. package/dist/aesmidas/index.esm.js.map +1 -1
  5. package/dist/aesmidas/index.js +1 -1
  6. package/dist/aesmidas/index.js.map +1 -1
  7. package/dist/bridgewise/index.d.ts +11749 -5934
  8. package/dist/bridgewise/index.d.ts.map +1 -1
  9. package/dist/bridgewise/index.esm.js +1 -1
  10. package/dist/bridgewise/index.esm.js.map +1 -1
  11. package/dist/bridgewise/index.js +1 -1
  12. package/dist/bridgewise/index.js.map +1 -1
  13. package/dist/insight/index.d.ts +131 -2
  14. package/dist/insight/index.d.ts.map +1 -1
  15. package/dist/insight/index.esm.js +1 -1
  16. package/dist/insight/index.esm.js.map +1 -1
  17. package/dist/insight/index.js +1 -1
  18. package/dist/insight/index.js.map +1 -1
  19. package/dist/middleware/index.d.ts +206 -52
  20. package/dist/middleware/index.d.ts.map +1 -1
  21. package/dist/middleware/index.esm.js +1 -1
  22. package/dist/middleware/index.esm.js.map +1 -1
  23. package/dist/middleware/index.js +1 -1
  24. package/dist/middleware/index.js.map +1 -1
  25. package/dist/orbis/index.d.ts +56 -50
  26. package/dist/orbis/index.d.ts.map +1 -1
  27. package/dist/orbis/index.esm.js +1 -1
  28. package/dist/orbis/index.esm.js.map +1 -1
  29. package/dist/orbis/index.js +1 -1
  30. package/dist/orbis/index.js.map +1 -1
  31. package/dist/uma/index.d.ts +981 -91
  32. package/dist/uma/index.d.ts.map +1 -1
  33. package/dist/uma/index.esm.js +1 -1
  34. package/dist/uma/index.esm.js.map +1 -1
  35. package/dist/uma/index.js +1 -1
  36. package/dist/uma/index.js.map +1 -1
  37. package/package.json +1 -1
@@ -125,6 +125,21 @@ export class BackgroundService<HandleError extends boolean = boolean, Format ext
125
125
  * @secure
126
126
  */
127
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>>;
128
143
  }
129
144
  export interface AesMidasActionLog {
130
145
  id?: string | null;
@@ -170,6 +185,8 @@ export interface AesMidasApplicationUser {
170
185
  firm_id?: string | null;
171
186
  source?: string | null;
172
187
  user_type?: string | null;
188
+ region?: string | null;
189
+ uma_uuid?: string | null;
173
190
  }
174
191
  export interface AesMidasBestQuote {
175
192
  symbol?: string | null;
@@ -241,7 +258,7 @@ export interface AesMidasBond {
241
258
  next_call_date?: string | null;
242
259
  /** @format double */
243
260
  next_call_price?: number | null;
244
- convertible?: string | null;
261
+ convertible?: boolean | null;
245
262
  insured?: boolean | null;
246
263
  status?: string | null;
247
264
  municipal_state?: string | null;
@@ -252,9 +269,9 @@ export interface AesMidasBond {
252
269
  treasury_subtype?: string | null;
253
270
  ticker?: string | null;
254
271
  sinking_fund?: boolean | null;
255
- a144?: string | null;
256
- reg_s?: string | null;
257
- private_placement?: string | null;
272
+ a144?: boolean | null;
273
+ reg_s?: boolean | null;
274
+ private_placement?: boolean | null;
258
275
  country_issue?: string | null;
259
276
  country_domicile?: string | null;
260
277
  day_count?: string | null;
@@ -267,7 +284,8 @@ export interface AesMidasBond {
267
284
  /** @format double */
268
285
  close_price?: number | null;
269
286
  close_price_asof?: string | null;
270
- close_ytw?: string | null;
287
+ /** @format double */
288
+ close_ytw?: number | null;
271
289
  /** @format double */
272
290
  issue_minimum_denomination?: number | null;
273
291
  puttable?: boolean | null;
@@ -313,8 +331,8 @@ export interface AesMidasBondSearchBody {
313
331
  /** @format date */
314
332
  maturity_end?: string | null;
315
333
  municipal_states?: string[] | null;
316
- municial_tax?: boolean | null;
317
- municial_types?: string[] | null;
334
+ municipal_tax?: boolean | null;
335
+ municipal_types?: string[] | null;
318
336
  purposes?: string[] | null;
319
337
  sectors?: string[] | null;
320
338
  sp_ratings?: string[] | null;
@@ -492,7 +510,7 @@ export interface AesMidasBondReformat {
492
510
  next_call_date?: string | null;
493
511
  /** @format double */
494
512
  next_call_price?: number | null;
495
- convertible?: string | null;
513
+ convertible?: boolean | null;
496
514
  insured?: boolean | null;
497
515
  status?: string | null;
498
516
  municipal_state?: string | null;
@@ -503,9 +521,9 @@ export interface AesMidasBondReformat {
503
521
  treasury_subtype?: string | null;
504
522
  ticker?: string | null;
505
523
  sinking_fund?: boolean | null;
506
- a144?: string | null;
507
- reg_s?: string | null;
508
- private_placement?: string | null;
524
+ a144?: boolean | null;
525
+ reg_s?: boolean | null;
526
+ private_placement?: boolean | null;
509
527
  country_issue?: string | null;
510
528
  country_domicile?: string | null;
511
529
  day_count?: string | null;
@@ -517,7 +535,8 @@ export interface AesMidasBondReformat {
517
535
  /** @format double */
518
536
  close_price?: number | null;
519
537
  close_price_asof?: string | null;
520
- close_ytw?: string | null;
538
+ /** @format double */
539
+ close_ytw?: number | null;
521
540
  /** @format double */
522
541
  issue_minimum_denomination?: number | null;
523
542
  puttable?: boolean | null;
@@ -573,6 +592,23 @@ export interface AesMidasContractRecordsResponsewithPagination {
573
592
  page_size?: number;
574
593
  data?: AesMidasContractRecords[] | null;
575
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
+ }
576
612
  export interface AesMidasDataSource {
577
613
  /** @minLength 1 */
578
614
  name: string;
@@ -729,12 +765,79 @@ export interface AesMidasExchanges {
729
765
  type?: string | null;
730
766
  description?: string | null;
731
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
+ }
732
833
  export interface AesMidasFirm {
733
834
  firm_id?: string | null;
734
835
  full_name?: string | null;
735
836
  /** @format int32 */
736
837
  status?: number;
737
838
  source?: string | null;
839
+ region?: string | null;
840
+ uma_uuid?: string | null;
738
841
  /** @format int32 */
739
842
  us_equity?: number;
740
843
  nbbo_snapshot?: boolean;
@@ -1046,6 +1149,92 @@ export interface AesMidasFundWebQuote {
1046
1149
  one_year_change_percent?: number;
1047
1150
  cusip?: string | null;
1048
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
+ }
1049
1238
  export interface AesMidasHistoricalBondChartApex {
1050
1239
  /** @format date-time */
1051
1240
  timestamp?: string;
@@ -1308,6 +1497,11 @@ export interface AesMidasIsinInfo {
1308
1497
  name_addr?: string | null;
1309
1498
  primary_name?: string | null;
1310
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;
1311
1505
  tickers_info?: Record<string, string | null>;
1312
1506
  }
1313
1507
  export interface AesMidasLevel1 {
@@ -1650,6 +1844,7 @@ export interface AesMidasMutualFund {
1650
1844
  week52_low_date?: string | null;
1651
1845
  trade_time?: string | null;
1652
1846
  update_time?: string | null;
1847
+ currency?: string | null;
1653
1848
  }
1654
1849
  export interface AesMidasNightSession {
1655
1850
  symbol?: string | null;
@@ -1895,10 +2090,14 @@ export interface AesMidasOptionL1WithGreeks {
1895
2090
  option_greek?: AesMidasOptionGreek;
1896
2091
  }
1897
2092
  export interface AesMidasPagination {
1898
- /** @format int32 */
2093
+ /**
2094
+ * 1-based page number; values below 1 are treated as 1.
2095
+ * @format int32
2096
+ */
1899
2097
  page_number?: number;
1900
2098
  /** @format int32 */
1901
2099
  page_size?: number;
2100
+ [key: string]: any;
1902
2101
  }
1903
2102
  export interface AesMidasPermission {
1904
2103
  /** @minLength 1 */
@@ -2261,6 +2460,7 @@ export interface AesMidasSnapshotReportResponsewithPagination {
2261
2460
  export interface AesMidasSort {
2262
2461
  sort_by?: string | null;
2263
2462
  sort_order?: string | null;
2463
+ [key: string]: any;
2264
2464
  }
2265
2465
  export interface AesMidasSymbolSearchBody {
2266
2466
  symbol_include?: string[] | null;
@@ -2428,40 +2628,25 @@ export interface AesMidasTop20 {
2428
2628
  data_source?: string | null;
2429
2629
  }
2430
2630
  export interface AesMidasUMAB2BUser {
2431
- allow_feedback?: boolean;
2432
- created_at?: string | null;
2433
- do_not_ask_mfa_again?: boolean;
2434
- email?: string | null;
2435
- email_verified?: boolean;
2436
2631
  /** @format int32 */
2437
2632
  id?: number;
2438
- /** @format int32 */
2439
- initiator_id?: number | null;
2633
+ username?: string | null;
2634
+ email?: string | null;
2635
+ email_verified?: boolean;
2636
+ phone?: string | null;
2637
+ phone_verified?: boolean;
2440
2638
  first_name?: string | null;
2441
2639
  last_name?: string | null;
2442
- locale?: AesMidasUMALocale;
2443
- /** @format int32 */
2444
- locale_id?: number | null;
2445
2640
  mfa_enabled?: boolean;
2446
- phone?: string | null;
2447
- phone_verified?: boolean;
2448
- rep_code?: string | null;
2449
- should_reset_password?: boolean;
2450
- updated_at?: string | null;
2451
- 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;
2452
2646
  status?: string | null;
2453
2647
  firms?: AesMidasUMAUserFirm[] | null;
2454
- big_avatar_url?: string | null;
2455
- branches?: AesMidasUMABranch[] | null;
2456
- has_access_to_all_firm_branches?: boolean;
2457
- microservices?: AesMidasUMAUserMicroservice[] | null;
2458
- mode?: string | null;
2459
2648
  permissions?: AesMidasUMAPermission[] | null;
2460
- /** @format int32 */
2461
- primary_firm_id?: number;
2462
2649
  roles?: AesMidasUMARole[] | null;
2463
- small_avatar_url?: string | null;
2464
- theme?: string | null;
2465
2650
  }
2466
2651
  export interface AesMidasUMAB2BUserResponsewithPagination {
2467
2652
  /** @format int32 */
@@ -2475,31 +2660,23 @@ export interface AesMidasUMAB2BUserResponsewithPagination {
2475
2660
  data?: AesMidasUMAB2BUser[] | null;
2476
2661
  }
2477
2662
  export interface AesMidasUMAB2CUser {
2478
- allow_feedback?: boolean;
2479
- created_at?: string | null;
2480
- do_not_ask_mfa_again?: boolean;
2481
- email?: string | null;
2482
- email_verified?: boolean;
2483
2663
  /** @format int32 */
2484
2664
  id?: number;
2485
- /** @format int32 */
2486
- initiator_id?: number | null;
2665
+ username?: string | null;
2666
+ email?: string | null;
2667
+ email_verified?: boolean;
2668
+ phone?: string | null;
2669
+ phone_verified?: boolean;
2487
2670
  first_name?: string | null;
2488
2671
  last_name?: string | null;
2489
- locale?: AesMidasUMALocale;
2490
- /** @format int32 */
2491
- locale_id?: number | null;
2492
2672
  mfa_enabled?: boolean;
2493
- phone?: string | null;
2494
- phone_verified?: boolean;
2495
- rep_code?: string | null;
2496
- should_reset_password?: boolean;
2497
- updated_at?: string | null;
2498
- 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;
2499
2678
  status?: string | null;
2500
2679
  firms?: AesMidasUMAUserFirm[] | null;
2501
- branches?: AesMidasUMABranch[] | null;
2502
- microservices?: AesMidasUMAUserMicroservice[] | null;
2503
2680
  permissions?: AesMidasUMAPermission[] | null;
2504
2681
  roles?: AesMidasUMARole[] | null;
2505
2682
  }
@@ -2514,36 +2691,13 @@ export interface AesMidasUMAB2CUserResponsewithPagination {
2514
2691
  page_size?: number;
2515
2692
  data?: AesMidasUMAB2CUser[] | null;
2516
2693
  }
2517
- export interface AesMidasUMABranch {
2518
- code?: string | null;
2519
- /** @format int32 */
2520
- firm_id?: number;
2521
- /** @format int32 */
2522
- id?: number;
2523
- name?: string | null;
2524
- slug?: string | null;
2525
- }
2526
- export interface AesMidasUMADomain {
2527
- internal_domain?: string | null;
2528
- internal_protocol?: string | null;
2529
- public_path_prefix?: string | null;
2530
- }
2531
2694
  export interface AesMidasUMAFirm {
2532
- /** @format int32 */
2533
- admins_count?: number;
2534
- allow_b2c_email_notifications?: boolean;
2535
- branches?: AesMidasUMABranch[] | null;
2536
- /** @format int32 */
2537
- branches_count?: number;
2538
- created_at?: string | null;
2539
2695
  /** @format int32 */
2540
2696
  id?: number;
2541
- last_status_change_at?: string | null;
2542
2697
  name?: string | null;
2543
- slug?: string | null;
2544
2698
  status?: string | null;
2545
- updated_at?: string | null;
2546
- twilio_creds?: AesMidasUMATwilioCreds;
2699
+ region?: string | null;
2700
+ uuid?: string | null;
2547
2701
  }
2548
2702
  export interface AesMidasUMAFirmResponsewithPagination {
2549
2703
  /** @format int32 */
@@ -2557,102 +2711,31 @@ export interface AesMidasUMAFirmResponsewithPagination {
2557
2711
  data?: AesMidasUMAFirm[] | null;
2558
2712
  }
2559
2713
  export interface AesMidasUMAFirmBasic {
2560
- /** @format int32 */
2561
- admins_count?: number;
2562
- allow_b2c_email_notifications?: boolean;
2563
- branches?: AesMidasUMABranch[] | null;
2564
- /** @format int32 */
2565
- branches_count?: number;
2566
- created_at?: string | null;
2567
2714
  /** @format int32 */
2568
2715
  id?: number;
2569
- last_status_change_at?: string | null;
2570
2716
  name?: string | null;
2571
- slug?: string | null;
2572
2717
  status?: string | null;
2573
- updated_at?: string | null;
2574
- }
2575
- export interface AesMidasUMALocale {
2576
- /** @format int32 */
2577
- id?: number;
2578
- locale?: string | null;
2579
- name?: string | null;
2580
- }
2581
- export interface AesMidasUMAMetadata {
2582
- entities?: Record<string, any>;
2583
- is_microservice_global?: boolean;
2718
+ region?: string | null;
2719
+ uuid?: string | null;
2584
2720
  }
2585
2721
  export interface AesMidasUMAPermission {
2586
- assignment_group?: string | null;
2587
- created_at?: string | null;
2588
- /** @format int32 */
2589
- id?: number;
2590
- metadata?: AesMidasUMAMetadata;
2591
- microservice?: AesMidasUMAUserMicroservice;
2592
- /** @format int32 */
2593
- microservice_id?: number | null;
2594
2722
  permission?: string | null;
2595
- updated_at?: string | null;
2596
2723
  }
2597
2724
  export interface AesMidasUMARole {
2598
- created_at?: string | null;
2599
- firm?: AesMidasUMAFirmBasic;
2600
- /** @format int32 */
2601
- firm_id?: number | null;
2602
- /** @format int32 */
2603
- id?: number;
2604
- microservice?: AesMidasUMAUserMicroservice;
2605
- /** @format int32 */
2606
- microservice_id?: number | null;
2607
2725
  name?: string | null;
2726
+ microservice?: AesMidasUMARoleMicroservice;
2608
2727
  permissions?: AesMidasUMAPermission[] | null;
2609
- type?: AesMidasUMARoleType;
2610
- /** @format int32 */
2611
- type_id?: number;
2612
- updated_at?: string | null;
2613
2728
  }
2614
- export interface AesMidasUMARoleType {
2615
- color?: string | null;
2616
- created_at?: string | null;
2617
- /** @format int32 */
2618
- id?: number;
2619
- type?: string | null;
2620
- updated_at?: string | null;
2621
- }
2622
- export interface AesMidasUMATwilioCreds {
2623
- account_sid?: string | null;
2624
- auth_token?: string | null;
2625
- phone_number?: string | null;
2626
- subaccount_sid?: string | null;
2729
+ export interface AesMidasUMARoleMicroservice {
2730
+ slug?: string | null;
2627
2731
  }
2628
2732
  export interface AesMidasUMAUserFirm {
2629
- /** @format int32 */
2630
- admins_count?: number;
2631
- allow_b2c_email_notifications?: boolean;
2632
- branches?: AesMidasUMABranch[] | null;
2633
- /** @format int32 */
2634
- branches_count?: number;
2635
- created_at?: string | null;
2636
2733
  /** @format int32 */
2637
2734
  id?: number;
2638
- last_status_change_at?: string | null;
2639
2735
  name?: string | null;
2640
- slug?: string | null;
2641
2736
  status?: string | null;
2642
- updated_at?: string | null;
2643
- have_access_to_all_firm_branches?: boolean;
2644
- }
2645
- export interface AesMidasUMAUserMicroservice {
2646
- /** @format int32 */
2647
- id?: number;
2648
- is_active?: boolean;
2649
- is_visible_on_admin_sidebar?: boolean;
2650
- logo_url?: string | null;
2651
- name?: string | null;
2652
- slug?: string | null;
2653
- created_at?: string | null;
2654
- domains?: AesMidasUMADomain[] | null;
2655
- updated_at?: string | null;
2737
+ region?: string | null;
2738
+ uuid?: string | null;
2656
2739
  }
2657
2740
  export interface AesMidasUserDataConfig {
2658
2741
  /** @minLength 1 */
@@ -3586,6 +3669,31 @@ export class Quote<HandleError extends boolean = boolean, Format extends CaseFor
3586
3669
  /** @default "" */
3587
3670
  platform?: string;
3588
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>>;
3589
3697
  /**
3590
3698
  * @tags Quote
3591
3699
  * @name GetSymbolList
@@ -4136,7 +4244,7 @@ export class Quote<HandleError extends boolean = boolean, Format extends CaseFor
4136
4244
  /** search string */
4137
4245
  criteria: string;
4138
4246
  /**
4139
- * how many records that need to return, 20 is maximum
4247
+ * how many records that need to return, 1 to 100; any other value uses 100
4140
4248
  * @format int32
4141
4249
  * @default 20
4142
4250
  */
@@ -4173,7 +4281,7 @@ export class Quote<HandleError extends boolean = boolean, Format extends CaseFor
4173
4281
  */
4174
4282
  getBondScreenerFieldValues(config?: RequestConfig<HandleError>): Promise<ClientResponse<AesMidasBondFieldValues, HandleError, Format>>;
4175
4283
  /**
4176
- * @description For fields possible value, please query in endpoint 'bonds-screener-field-values"
4284
+ * @description For fields possible value, please query in endpoint 'bond-screener-field-values'
4177
4285
  * @tags Quote
4178
4286
  * @name PostBondsScreener
4179
4287
  * @summary Bond screener - All users
@@ -4565,6 +4673,24 @@ export class Quote<HandleError extends boolean = boolean, Format extends CaseFor
4565
4673
  /** @default "" */
4566
4674
  platform?: string;
4567
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>>;
4568
4694
  /**
4569
4695
  * @tags Quote
4570
4696
  * @name GetPolygonMinuteChart
@@ -4629,14 +4755,54 @@ export class Quote<HandleError extends boolean = boolean, Format extends CaseFor
4629
4755
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError, Format>>;
4630
4756
  /**
4631
4757
  * @tags Quote
4632
- * @name GetEquityUsEod
4633
- * @summary Fetch US equity EOD file (.parquet format)
4634
- * @request GET:/api/quote/equity-us-eod
4758
+ * @name GetEquityEod
4759
+ * @summary Fetch equity EOD file (.parquet format)
4760
+ * @request GET:/api/quote/equity-eod
4635
4761
  * @secure
4636
4762
  */
4637
- getEquityUsEod(query?: {
4763
+ getEquityEod(query?: {
4764
+ /** Optional. yyyy-MM-dd. If omitted, returns the most recent available file (looks back up to 30 days). */
4638
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;
4639
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
+ */
4640
4806
  user_name?: string;
4641
4807
  /** @default "" */
4642
4808
  platform?: string;
@@ -4763,7 +4929,23 @@ export class QuotesReformat<HandleError extends boolean = boolean, Format extend
4763
4929
  * @default false
4764
4930
  */
4765
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;
4766
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>>;
4767
4949
  /**
4768
4950
  * @tags QuotesReformat
4769
4951
  * @name GetSearchRedis
@@ -4817,6 +4999,11 @@ export class QuotesReformat<HandleError extends boolean = boolean, Format extend
4817
4999
  * @default false
4818
5000
  */
4819
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;
4820
5007
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
4821
5008
  /**
4822
5009
  * @tags QuotesReformat
@@ -4927,7 +5114,7 @@ export class QuotesReformat<HandleError extends boolean = boolean, Format extend
4927
5114
  /** search string */
4928
5115
  criteria: string;
4929
5116
  /**
4930
- * how many records that need to return, 20 is maximum
5117
+ * how many records that need to return, 1 to 100; any other value uses 100
4931
5118
  * @format int32
4932
5119
  * @default 20
4933
5120
  */