@orbis-systems/orbis-api-clients 0.3.1 → 0.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.
@@ -0,0 +1,4255 @@
1
+ import { AxiosError, AxiosInstance, AxiosRequestConfig, HttpStatusCode } from "axios";
2
+ interface BaseClientConfig<HandleError extends boolean = boolean> {
3
+ baseUrl: string;
4
+ errorHandling?: HandleError;
5
+ storage?: Storage;
6
+ defaultHeaders?: Record<string, string>;
7
+ defaultSecure?: boolean;
8
+ authDataStorageKey?: string;
9
+ onAxiosError?: (error: AxiosError) => void;
10
+ onError?: (error: unknown) => void;
11
+ }
12
+ enum ContentType {
13
+ Json = "application/json",
14
+ FormData = "multipart/form-data",
15
+ UrlEncoded = "application/x-www-form-urlencoded",
16
+ Text = "text/plain"
17
+ }
18
+ type RequestConfig<Body = unknown> = AxiosRequestConfig<Body> & {
19
+ secure?: boolean;
20
+ contentType?: ContentType;
21
+ };
22
+ type ResponseStatus = {
23
+ status: HttpStatusCode | -1;
24
+ statusText: string;
25
+ };
26
+ type SuccessClientResponse<Data = unknown> = ResponseStatus & {
27
+ success: true;
28
+ data: Data;
29
+ };
30
+ type ErrorClientResponse = ResponseStatus & {
31
+ success: false;
32
+ data?: any;
33
+ error: unknown;
34
+ };
35
+ type ClientResponse<Data = unknown, HandleError extends boolean = boolean> = HandleError extends true ? SuccessClientResponse<Data> | ErrorClientResponse : SuccessClientResponse<Data>;
36
+ declare abstract class BaseClient<HandleError extends boolean = boolean, AuthData = unknown> {
37
+ protected readonly config: BaseClientConfig<HandleError>;
38
+ protected readonly axiosInstance: AxiosInstance;
39
+ protected readonly storage: Storage;
40
+ constructor(config: BaseClientConfig<HandleError>);
41
+ protected stringifyFormItem(formItem: unknown): string;
42
+ protected createFormData(input: Record<string, unknown>): FormData;
43
+ request<Data = unknown, Error = unknown, Body = unknown>(requestConfig: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
44
+ get<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
45
+ delete<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
46
+ head<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
47
+ options<Data = unknown, Error = unknown, Body = unknown>(url: string, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
48
+ post<Data = unknown, Error = unknown, Body = unknown>(url: string, data?: Body, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
49
+ put<Data = unknown, Error = unknown, Body = unknown>(url: string, data?: Body, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
50
+ patch<Data = unknown, Error = unknown, Body = unknown>(url: string, data?: Body, config?: RequestConfig<Body>): Promise<ClientResponse<Data, HandleError>>;
51
+ getAxios(): AxiosInstance;
52
+ setAuthData(data: AuthData | null): void;
53
+ getAuthData(): AuthData | null;
54
+ getConfig(): BaseClientConfig<HandleError>;
55
+ abstract prepareAuthRequestConfig(): Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>;
56
+ }
57
+ declare class BaseApi<HandleError extends boolean = boolean, ApiClient extends BaseClient<HandleError> = BaseClient<HandleError>> {
58
+ protected readonly apiClient: ApiClient;
59
+ constructor(apiClient: ApiClient);
60
+ getApiClient(): ApiClient;
61
+ }
62
+ interface JwtClientConfig<HandleError extends boolean = boolean> extends BaseClientConfig<HandleError> {
63
+ authSchema?: string;
64
+ }
65
+ interface JwtAuthData {
66
+ accessToken: string;
67
+ refreshToken: string;
68
+ }
69
+ declare class JwtClient<HandleError extends boolean = boolean> extends BaseClient<HandleError, JwtAuthData> {
70
+ protected readonly config: JwtClientConfig<HandleError>;
71
+ constructor(config: JwtClientConfig<HandleError>);
72
+ getConfig(): JwtClientConfig<HandleError>;
73
+ prepareAuthRequestConfig(): Pick<RequestConfig<any>, 'headers' | 'data' | 'params'>;
74
+ scheduleTokenRenewal(renewTokenCallback: () => Promise<JwtAuthData>): void;
75
+ cancelTokenRenewal(): void;
76
+ }
77
+ export interface InsightQuote {
78
+ ask_px: number;
79
+ ask_sz: number;
80
+ /** Fields that were renamed after transition to AES */
81
+ avg_vol30d: number;
82
+ avg_vol_30d: number;
83
+ bid_px: number;
84
+ bid_sz: number;
85
+ /** NOTE: Canlendar - could be a typo */
86
+ calendar_year_high: number;
87
+ calendar_year_high_date: string;
88
+ calendar_year_low: number;
89
+ calendar_year_low_date: string;
90
+ /**
91
+ * Change and ChangePercent are new additions to quote
92
+ * We used to calculate these fields ourselfs
93
+ */
94
+ change: number;
95
+ change_percent: number;
96
+ closing_px: number;
97
+ column: number;
98
+ com_shrs_out: number;
99
+ comp_desc: string;
100
+ comp_name: string;
101
+ condition: number;
102
+ cusip: string;
103
+ data_source: string;
104
+ div_amt: number;
105
+ div_date_ex: string;
106
+ div_date_ex_parsed: string;
107
+ div_yield: number;
108
+ gics: string;
109
+ high52w_px: number;
110
+ high_52w_px: number;
111
+ high_px: number;
112
+ info_time: string;
113
+ isin: string;
114
+ issue_market: string;
115
+ last_px: number;
116
+ low52w_px: number;
117
+ low_52w_px: number;
118
+ low_px: number;
119
+ mic: string;
120
+ mkt_cap: number;
121
+ open_px: number;
122
+ /** These fields have nonstandard date format */
123
+ pay_date: string;
124
+ /** Fields that require calculations or parsing */
125
+ pay_date_parsed: string;
126
+ pe_ratio: number;
127
+ post_last_px: number;
128
+ /** Additional fields - they are not guaranteed to be there */
129
+ post_trade_time: string;
130
+ price_change: number;
131
+ price_change_percent: number;
132
+ quote_time: string;
133
+ sedol: string;
134
+ status: string;
135
+ symbol: string;
136
+ trade_px: number;
137
+ trade_region: string;
138
+ trade_sz: number;
139
+ trade_time: string;
140
+ volume: number;
141
+ vwap: number;
142
+ yest_close_px: number;
143
+ yesterday_trade_volume: number;
144
+ }
145
+ export interface InsightStockMarketHeatmapEntry {
146
+ price_change_percent: number;
147
+ symbol: string;
148
+ title: string;
149
+ }
150
+ export interface InsightSymbolMomentum {
151
+ date: string;
152
+ result_momentum: number;
153
+ result_ratio: number;
154
+ }
155
+ export interface InsightAddCountryCodesRequest {
156
+ codes?: InsightCountryCode[];
157
+ }
158
+ export interface InsightAddGlobalIndexesRequest {
159
+ countries?: InsightGlobalIndex[];
160
+ }
161
+ export interface InsightAgeDistribution {
162
+ eldest: InsightAgeDistributionInfo;
163
+ min_range: InsightAgeDistributionInfo;
164
+ youngest: InsightAgeDistributionInfo;
165
+ }
166
+ export interface InsightAgeDistributionInfo {
167
+ last_30_days_change: number;
168
+ last_7_days_change: number;
169
+ percent_holders: number;
170
+ }
171
+ export interface InsightAnalystConsensusRequest {
172
+ include_analysts?: boolean;
173
+ /** Comma-separated tickers */
174
+ tickers?: string[];
175
+ }
176
+ export interface InsightAnalystConsensusResponse {
177
+ buy: number;
178
+ company_name: string;
179
+ consensus: string;
180
+ high_price_target: number;
181
+ hold: number;
182
+ low_price_target: number;
183
+ price_target: number;
184
+ price_target_currency_code: string;
185
+ price_target_upside: number;
186
+ sell: number;
187
+ ticker: string;
188
+ total_analysts: number;
189
+ }
190
+ export interface InsightAnalystProfileResponse {
191
+ analyst_name: string;
192
+ analyst_rank: number;
193
+ excess_return: number;
194
+ expert_full_picture_url: string;
195
+ expert_picture_url: string;
196
+ firm_name: string;
197
+ good_recommendations: number;
198
+ main_sector: string;
199
+ num_of_stars: number;
200
+ number_of_ranked_experts: number;
201
+ rating_distribution: InsightRatingDistribution;
202
+ success_rate: number;
203
+ total_recommendations: number;
204
+ }
205
+ export interface InsightAnalystsExpertPictureStoreResponse {
206
+ url: string;
207
+ }
208
+ export interface InsightArticle {
209
+ article_id: number;
210
+ author: InsightArticleAuthor;
211
+ available_languages: string[];
212
+ body: InsightArticleBody[];
213
+ body_raw: any;
214
+ featured_image: InsightArticleFeaturedImage;
215
+ first_paragraph: string;
216
+ language: string;
217
+ long_summary: string;
218
+ permalink: string;
219
+ release_date: string;
220
+ release_stamp: number;
221
+ summary: string;
222
+ symbols: string[];
223
+ tags: string[];
224
+ title: string;
225
+ types: string[];
226
+ updated_date: string;
227
+ url: string;
228
+ }
229
+ export interface InsightArticleAuthor {
230
+ avatar: string;
231
+ biography: string;
232
+ id: number;
233
+ name: string;
234
+ }
235
+ export interface InsightArticleBody {
236
+ body: string;
237
+ data: InsightNewsExtraData;
238
+ type: string;
239
+ }
240
+ export interface InsightArticleByIDRequest {
241
+ /** (REQUIRE) */
242
+ ID?: number;
243
+ /** (REQUIRE) */
244
+ language?: string;
245
+ }
246
+ export interface InsightArticleFeaturedImage {
247
+ copyright: string;
248
+ description: string;
249
+ id: number;
250
+ main_image: InsightArticleFeaturedImageInfo;
251
+ original_image: InsightArticleFeaturedImageInfo;
252
+ rectangle_crop: InsightArticleFeaturedImageInfo;
253
+ square_crop: InsightArticleFeaturedImageInfo;
254
+ type: string;
255
+ }
256
+ export interface InsightArticleFeaturedImageInfo {
257
+ height: number;
258
+ url: string;
259
+ width: number;
260
+ }
261
+ export interface InsightArticlesRequest {
262
+ count?: number;
263
+ /** (REQUIRE) */
264
+ language?: string;
265
+ released_after?: number;
266
+ released_before?: number;
267
+ symbols?: string;
268
+ tag?: string;
269
+ tag_group?: string;
270
+ type?: InsightArticlesRequestTypeEnum;
271
+ }
272
+ export interface InsightAssetAllocationBreakdown {
273
+ breakdown: string;
274
+ percentage: number;
275
+ }
276
+ export interface InsightAssetEfficiency {
277
+ roa: number;
278
+ roe: number;
279
+ }
280
+ export interface InsightAuthorInfo {
281
+ avatar: string;
282
+ biography: string;
283
+ id: number;
284
+ name: string;
285
+ }
286
+ export interface InsightAuthorProfileRequest {
287
+ /** (REQUIRE) */
288
+ id?: string;
289
+ /** (REQUIRE) */
290
+ language?: string;
291
+ }
292
+ export interface InsightAuthorProfileResponse {
293
+ articles: InsightArticle[];
294
+ author: InsightAuthorInfo;
295
+ }
296
+ export interface InsightBeforeAndAfter {
297
+ after?: string;
298
+ before?: string;
299
+ }
300
+ export interface InsightBestPerformingExpertsResponse {
301
+ analyst_name: string;
302
+ analyst_rank: number;
303
+ distribution: InsightPerformingExpertsDistribution;
304
+ excess_return: number;
305
+ expert_full_picture_url: string;
306
+ expert_picture_url: string;
307
+ expert_uid: string;
308
+ firm_analysts_count: number;
309
+ firm_name: string;
310
+ good_recommendations: number;
311
+ num_of_stars: number;
312
+ number_of_ranked_experts: number;
313
+ ratings: InsightPerformingExpertsRatings[];
314
+ sector: string;
315
+ success_rate: number;
316
+ total_recommendations: number;
317
+ }
318
+ export interface InsightBloggerConsensusOnStockResponse {
319
+ bearish_count: number;
320
+ bearish_ratio: number;
321
+ blogs_distribution: InsightBlogsDistribution[];
322
+ bullish_count: number;
323
+ bullish_ratio: number;
324
+ consensus: string;
325
+ num_of_bloggers: number;
326
+ sector_bull_ratio: number;
327
+ sector_name: string;
328
+ }
329
+ export interface InsightBlogsDistribution {
330
+ percentage: number;
331
+ site: string;
332
+ }
333
+ export interface InsightCalculateEstimatedReturnsResponse {
334
+ cagr: number;
335
+ end_date: string;
336
+ end_date_price: number;
337
+ estimated_returns: number;
338
+ invested_amount: number;
339
+ start_date: string;
340
+ start_date_price: number;
341
+ symbol: string;
342
+ total_value: number;
343
+ }
344
+ export interface InsightCalculateMatrixParamsRequest {
345
+ expiry_date?: InsightDate;
346
+ max_intervals?: number;
347
+ option_type?: string;
348
+ stock_price_max?: number;
349
+ stock_price_min?: number;
350
+ strike_value?: number;
351
+ ticker?: string;
352
+ }
353
+ export interface InsightCalculateMatrixResponse {
354
+ matrix_data: InsightMatrixData[];
355
+ ticker_data: InsightTickerData;
356
+ }
357
+ export interface InsightCalculateParamsRequest {
358
+ expiry_date?: InsightDate;
359
+ option_type?: string;
360
+ stock_price?: number;
361
+ strike_value?: number;
362
+ ticker?: string;
363
+ }
364
+ export interface InsightCalculateParamsResponse {
365
+ option_data: InsightOptionData;
366
+ ticker_data: InsightTickerData;
367
+ }
368
+ export interface InsightCalendarsIPOSResponse {
369
+ future_ipos: InsightFutureIPO[];
370
+ historical_ipos: InsightHistoricalIPO[];
371
+ }
372
+ export interface InsightClassificationResponse {
373
+ code: string;
374
+ id: number;
375
+ name: string;
376
+ }
377
+ export interface InsightCombainedProfileResponse {
378
+ address: string;
379
+ asset: string;
380
+ category: string;
381
+ city: string;
382
+ company_name: string;
383
+ country: string;
384
+ country_code: string;
385
+ earning_release: InsightEarningRelease;
386
+ email: string;
387
+ employees_number: number;
388
+ /** Index fields */
389
+ exchange: string;
390
+ exchange_name: string;
391
+ /** Fund fields */
392
+ expense_ratio: number;
393
+ fax: string;
394
+ fund_ownership_percent: number;
395
+ fund_type: string;
396
+ insider_ownership_percent: number;
397
+ institutional_ownership_percent: number;
398
+ inverse: boolean;
399
+ legal_company_name: string;
400
+ leverage: number;
401
+ logo: InsightSymbolLogosResponse;
402
+ long_description: string;
403
+ market_cap: number;
404
+ mic: string;
405
+ phone: string;
406
+ postal_code: string;
407
+ province: string;
408
+ sector: InsightSymbolIndustries;
409
+ short_company_name: string;
410
+ short_description: string;
411
+ structure: string;
412
+ symbol: string;
413
+ website: string;
414
+ }
415
+ export interface InsightCompaniesReview {
416
+ average_return: number;
417
+ company: string;
418
+ discretionary_transactions: number;
419
+ num_of_shares: number;
420
+ shares_percentage: string;
421
+ success_rate: number;
422
+ ticker: string;
423
+ uninformative_transactions: number;
424
+ value: number;
425
+ }
426
+ export interface InsightCompanyProfile {
427
+ address: string;
428
+ city: string;
429
+ company_name: string;
430
+ country: string;
431
+ country_code: string;
432
+ earning_release: InsightEarningRelease;
433
+ email: string;
434
+ employees_number: number;
435
+ fax: string;
436
+ fund_ownership_percent: number;
437
+ insider_ownership_percent: number;
438
+ institutional_ownership_percent: number;
439
+ legal_company_name: string;
440
+ logo: InsightSymbolLogosResponse;
441
+ long_description: string;
442
+ market_cap: number;
443
+ phone: string;
444
+ sector: InsightSymbolIndustries;
445
+ short_company_name: string;
446
+ short_description: string;
447
+ symbol: string;
448
+ website: string;
449
+ }
450
+ export interface InsightConfidenceSignal {
451
+ score: string;
452
+ sectorScore: number;
453
+ stockScore: number;
454
+ }
455
+ export interface InsightContinent {
456
+ id: string;
457
+ name: string;
458
+ }
459
+ export interface InsightContinentBreakdown {
460
+ breakdown: string;
461
+ code: string;
462
+ percentage: number;
463
+ }
464
+ export interface InsightCountryBreakdown {
465
+ breakdown: string;
466
+ percentage: number;
467
+ }
468
+ export interface InsightCountryCode {
469
+ a2_code: string;
470
+ a3_code: string;
471
+ country_name: string;
472
+ morningstar_id: string;
473
+ num_code: string;
474
+ }
475
+ export interface InsightCouponBreakdown {
476
+ breakdown: string;
477
+ percentage: number;
478
+ }
479
+ export interface InsightCreateContinentRequest {
480
+ continents?: InsightContinent[];
481
+ }
482
+ export interface InsightCreateCustomIndexRequest {
483
+ description?: string;
484
+ equities?: string[];
485
+ etfs?: string[];
486
+ name?: string;
487
+ private_name?: string;
488
+ }
489
+ export interface InsightCreateHeatmapPresetRequest {
490
+ heatmap_name?: string;
491
+ symbols?: {
492
+ symbol?: string;
493
+ title?: string;
494
+ }[];
495
+ }
496
+ export interface InsightCreateOrUpdateFixedIncomePresetRequest {
497
+ id?: string;
498
+ preset?: InsightGetFixedIncomeEntriesRequest;
499
+ preset_color?: string;
500
+ preset_description?: string;
501
+ preset_name?: string;
502
+ }
503
+ export interface InsightCreateOrUpdateScreenerPresetRequest {
504
+ id?: string;
505
+ preset?: InsightStockScreenerRequest;
506
+ preset_color?: string;
507
+ preset_description?: string;
508
+ preset_name?: string;
509
+ }
510
+ export interface InsightCreateRegionRequest {
511
+ regions?: InsightRegion[];
512
+ }
513
+ export interface InsightCryptoLogoConvertedRequest {
514
+ conversion?: InsightCryptoLogoConvertedRequestConversionEnum;
515
+ symbol?: string;
516
+ }
517
+ export interface InsightCryptoLogosResponse {
518
+ logo: string;
519
+ logo_normal: string;
520
+ logo_original: string;
521
+ logo_square: string;
522
+ logo_square_strict: string;
523
+ logo_thumbnail: string;
524
+ name: string;
525
+ symbol: string;
526
+ }
527
+ export interface InsightCustomIndex {
528
+ created_at: string;
529
+ description: string;
530
+ equities: string[];
531
+ etfs: string[];
532
+ id: string;
533
+ name: string;
534
+ private_name: string;
535
+ updated_at: string;
536
+ }
537
+ export interface InsightDailyPriceEntry {
538
+ price: number;
539
+ time: string;
540
+ }
541
+ export interface InsightDailyPriceHistoryResponse {
542
+ date: string;
543
+ details: InsightDailyPriceEntry[];
544
+ symbol: string;
545
+ }
546
+ export interface InsightDate {
547
+ day: number;
548
+ month: number;
549
+ year: number;
550
+ }
551
+ export interface InsightEarningRelease {
552
+ date: string;
553
+ exchange: string;
554
+ quarter: string;
555
+ quote: InsightQuote;
556
+ start_time: string;
557
+ status: string;
558
+ symbol: string;
559
+ time: string;
560
+ }
561
+ export interface InsightEarningReleasesRequest {
562
+ days_from_now?: number;
563
+ exchanges?: string[];
564
+ load_quotes?: boolean;
565
+ paging?: InsightPaging;
566
+ quote_access_type?: string;
567
+ symbols?: string[];
568
+ }
569
+ export interface InsightEarningReleasesResponse {
570
+ count: number;
571
+ details: InsightEarningRelease[];
572
+ }
573
+ export interface InsightEditContinentRequest {
574
+ id?: string;
575
+ name?: string;
576
+ }
577
+ export interface InsightEditCountryCodeRequest {
578
+ a2_code?: string;
579
+ a3_code?: string;
580
+ country_name?: string;
581
+ morningstar_id?: string;
582
+ num_code?: string;
583
+ }
584
+ export interface InsightEditGlobalIndexRequest {
585
+ continent_id?: string;
586
+ country?: string;
587
+ gdp?: number;
588
+ ppp?: number;
589
+ region_id?: string;
590
+ symbol?: string;
591
+ }
592
+ export interface InsightEditRegionRequest {
593
+ id?: string;
594
+ name?: string;
595
+ }
596
+ export interface InsightExchangeResponse {
597
+ code: string;
598
+ full_name: string;
599
+ id: number;
600
+ }
601
+ export interface InsightExpertForecast {
602
+ buy: number;
603
+ hold: number;
604
+ sell: number;
605
+ symbol: string;
606
+ }
607
+ export interface InsightExtendedFundData {
608
+ asset: string;
609
+ asset_id: string;
610
+ category: string;
611
+ category_id: string;
612
+ closing_price: number;
613
+ expense_ratio: number;
614
+ factsheet_url: string;
615
+ fund_type: string;
616
+ inverse: boolean;
617
+ last_price: number;
618
+ levarage: number;
619
+ name: string;
620
+ price_change: number;
621
+ price_change_percent: number;
622
+ prospectus_url: string;
623
+ quote: any;
624
+ sectors: InsightSectorBreakdown[];
625
+ sponsor: string;
626
+ sponsor_id: string;
627
+ structure: string;
628
+ structure_id: string;
629
+ symbol: string;
630
+ url: string;
631
+ }
632
+ export interface InsightExtendedMarketDate {
633
+ close_time: string;
634
+ country_code: string;
635
+ currency_code: string;
636
+ market_code: string;
637
+ market_name: string;
638
+ open_date: string;
639
+ open_time: string;
640
+ primary_market: boolean;
641
+ timezone: string;
642
+ }
643
+ export interface InsightExtremum {
644
+ max_value: number;
645
+ max_value_date: string;
646
+ min_value: number;
647
+ min_value_date: string;
648
+ }
649
+ export interface InsightFilterCustomIndexesRequest {
650
+ paging?: InsightPaging;
651
+ symbols?: string[];
652
+ }
653
+ export interface InsightFixedIncome {
654
+ a144: boolean;
655
+ accrued_interest: number;
656
+ bank_qualified: boolean;
657
+ bond_warrant: boolean;
658
+ call_type: string;
659
+ callable: boolean;
660
+ close_price: number;
661
+ close_price_asof: string;
662
+ close_ytw: number;
663
+ convertible: boolean;
664
+ country: string;
665
+ country_code: string;
666
+ country_domicile: string;
667
+ country_issue: string;
668
+ coupon: number;
669
+ coupon_frequency: string;
670
+ coupon_type: string;
671
+ currency: string;
672
+ cusip: string;
673
+ dated_date: string;
674
+ daycount: string;
675
+ description: string;
676
+ description_short: string;
677
+ duration: number;
678
+ first_coupon_date: string;
679
+ insured: boolean;
680
+ isin: string;
681
+ issue_date: string;
682
+ issue_minimum_denomination: number;
683
+ issue_price: number;
684
+ issue_size: number;
685
+ issuer: string;
686
+ last_coupon_date: string;
687
+ liquidity_institutional_aggregate: number;
688
+ liquidity_institutional_buy: number;
689
+ liquidity_institutional_sell: number;
690
+ liquidity_micro_aggregate: number;
691
+ liquidity_micro_buy: number;
692
+ liquidity_micro_sell: number;
693
+ liquidity_retail_aggregate: number;
694
+ liquidity_retail_buy: number;
695
+ liquidity_retail_sell: number;
696
+ maturity_date: string;
697
+ municipal_state: string;
698
+ municipal_taxable_federal: boolean;
699
+ municipal_type: string;
700
+ next_call_date: string;
701
+ next_call_price: number;
702
+ next_coupon_date: string;
703
+ par_value: number;
704
+ perpetual: boolean;
705
+ private_placement: boolean;
706
+ purpose: string;
707
+ puttable: boolean;
708
+ reg_s: boolean;
709
+ sector: string;
710
+ seniority: string;
711
+ settlement_convention: string;
712
+ sinking_fund: boolean;
713
+ sp_creditwatch: string;
714
+ sp_creditwatch_date: string;
715
+ sp_outlook: string;
716
+ sp_outlook_date: string;
717
+ sp_rating: string;
718
+ sp_rating_date: string;
719
+ status: string;
720
+ ticker: string;
721
+ treasury_subtype: string;
722
+ type: string;
723
+ updated_at: string;
724
+ }
725
+ export interface InsightFixedIncomePreset {
726
+ created_at: string;
727
+ id: string;
728
+ preset: Record<string, any>;
729
+ preset_color: string;
730
+ preset_description: string;
731
+ preset_name: string;
732
+ updated_at: string;
733
+ }
734
+ export interface InsightFundFilterAsset {
735
+ asset_id?: string;
736
+ asset_name?: string;
737
+ }
738
+ export interface InsightFundFilterCategory {
739
+ category_id?: string;
740
+ category_name?: string;
741
+ }
742
+ export interface InsightFundFilterSponsor {
743
+ number_of_entries?: number;
744
+ sponsor_id?: string;
745
+ sponsor_name?: string;
746
+ }
747
+ export interface InsightFundForHoldingWithQuote {
748
+ fund_type: string;
749
+ holding_percent: number;
750
+ inverse: boolean;
751
+ last_price: number;
752
+ leverage: number;
753
+ market_cap: number;
754
+ name: string;
755
+ price_change: number;
756
+ sponsor: string;
757
+ symbol: string;
758
+ volume: number;
759
+ }
760
+ export interface InsightFundScreenerQuote {
761
+ asset: string;
762
+ category: string;
763
+ dividend_amount: number;
764
+ dividend_ex_date: string;
765
+ dividend_pay_date: string;
766
+ dividend_percent: number;
767
+ expense_ratio: number;
768
+ fund_type: string;
769
+ inverse: boolean;
770
+ last_price: number;
771
+ leverage: number;
772
+ market_cap: number;
773
+ name: string;
774
+ price_change: number;
775
+ price_change_percent: number;
776
+ sectors: InsightSectorBreakdown[];
777
+ sponsor: string;
778
+ symbol: string;
779
+ /** Fill from quote when available */
780
+ volume: number;
781
+ }
782
+ export interface InsightFundScreenerRequest {
783
+ assets?: string[];
784
+ categories?: string[];
785
+ fund_type?: string;
786
+ inverse?: string;
787
+ leverage?: string;
788
+ market_cap?: InsightLessAndMore;
789
+ paging?: InsightPaging;
790
+ quote_access_type?: string;
791
+ sectors?: InsightSectorFilter[];
792
+ sponsors?: string[];
793
+ }
794
+ export interface InsightFundScreenerResponse {
795
+ count: number;
796
+ details: InsightFundScreenerQuote[];
797
+ }
798
+ export interface InsightFundSector {
799
+ sector_id: string;
800
+ sector_name: string;
801
+ }
802
+ export interface InsightFundSectorScreenerRequest {
803
+ dividend_percent?: InsightLessAndMore;
804
+ exposure?: InsightLessAndMore;
805
+ holdings?: string[];
806
+ inverse?: string;
807
+ leverage?: string;
808
+ order?: InsightOrdering;
809
+ paging?: InsightPaging;
810
+ quote_access_type?: string;
811
+ sector_code?: string;
812
+ sponsors?: string[];
813
+ }
814
+ export interface InsightFutureIPO {
815
+ currency: string;
816
+ market: string;
817
+ name: string;
818
+ price: number;
819
+ price_max: number;
820
+ price_min: number;
821
+ shares: number;
822
+ ticker: string;
823
+ week_of: string;
824
+ }
825
+ export interface InsightGeneralStockUpdates {
826
+ last_update: string;
827
+ ticker: string;
828
+ }
829
+ export interface InsightGeneralStockUpdatesResponse {
830
+ current_utc_time_stamp: string;
831
+ results_since_utc_time_stamp: string;
832
+ stocks: string[];
833
+ updates: InsightGeneralStockUpdates[];
834
+ }
835
+ export interface InsightGetCustomIndexesResponse {
836
+ count: number;
837
+ data: InsightCustomIndex[];
838
+ }
839
+ export interface InsightGetFixedIncomeEntriesRequest {
840
+ bank_qualified?: boolean;
841
+ callable?: boolean;
842
+ convertible?: boolean;
843
+ country_codes?: string[];
844
+ coupon?: InsightLessAndMore;
845
+ coupon_frequencies?: string[];
846
+ cusip?: string[];
847
+ description?: string;
848
+ has_ticker?: boolean;
849
+ insured?: boolean;
850
+ isin?: string[];
851
+ issue_date?: InsightBeforeAndAfter;
852
+ issuer?: string;
853
+ maturity?: InsightBeforeAndAfter;
854
+ municipal_states?: string[];
855
+ municipal_tax?: boolean;
856
+ municipal_types?: string[];
857
+ order?: InsightOrdering;
858
+ pagination?: InsightPagination;
859
+ paging?: InsightPaging;
860
+ purposes?: string[];
861
+ sectors?: string[];
862
+ sorts?: InsightOrdering[];
863
+ sp_ratings?: string[];
864
+ statuses?: string[];
865
+ tickers?: string[];
866
+ types?: string[];
867
+ }
868
+ export interface InsightGetFixedIncomeEntriesResponse {
869
+ count: number;
870
+ data: InsightFixedIncome[];
871
+ }
872
+ export interface InsightGetFixedIncomeHistoricalData {
873
+ price: number;
874
+ timestamp: string;
875
+ yield_to_worst: number;
876
+ }
877
+ export interface InsightGetFixedIncomeHistoricalRequest {
878
+ end?: string;
879
+ frequency?: string;
880
+ instrument_id?: string;
881
+ start?: string;
882
+ }
883
+ export interface InsightGetFixedIncomeHistoricalResponse {
884
+ data: InsightGetFixedIncomeHistoricalData[];
885
+ message: string;
886
+ status: number;
887
+ success: boolean;
888
+ timestamp: string;
889
+ }
890
+ export interface InsightGetFundDetailsResponse {
891
+ address: string;
892
+ asset: string;
893
+ asset_allocations: InsightAssetAllocationBreakdown[];
894
+ category: string;
895
+ city: string;
896
+ continents: InsightContinentBreakdown[];
897
+ countries: InsightCountryBreakdown[];
898
+ country: string;
899
+ country_code: string;
900
+ coupon_breakdown: InsightCouponBreakdown[];
901
+ email: string;
902
+ expense_ratio: number;
903
+ fax: string;
904
+ fund_net_assets: number;
905
+ fund_type: string;
906
+ holdings: InsightHoldingBreakdown[];
907
+ inverse: boolean;
908
+ leverage: number;
909
+ long_description: string;
910
+ market_caps: InsightMarketCapBreakdown[];
911
+ maturities: InsightMaturityBreakdown[];
912
+ phone: string;
913
+ sectors: InsightSectorBreakdown[];
914
+ structure: string;
915
+ symbol: string;
916
+ website: string;
917
+ }
918
+ export interface InsightGetFundScreenerFiltersResponse {
919
+ assets?: InsightFundFilterAsset[];
920
+ categories?: InsightFundFilterCategory[];
921
+ inverse?: string[];
922
+ leverage?: string[];
923
+ sectors?: InsightFundSector[];
924
+ sponsors?: InsightFundFilterSponsor[];
925
+ }
926
+ export interface InsightGetFundsForHoldingRequest {
927
+ /** ANY|LEVERAGE_I|LEVERAGE_II|LEVERAGE_III */
928
+ leverage?: string;
929
+ order?: InsightOrdering;
930
+ paging?: InsightPaging;
931
+ quote_access_type?: string;
932
+ symbol?: string;
933
+ }
934
+ export interface InsightGetFundsForHoldingResponse {
935
+ count: number;
936
+ data: InsightFundForHoldingWithQuote[];
937
+ }
938
+ export interface InsightGetIndustriesPerformanceQuoteFilter {
939
+ /** ALL OR US(NYSE/Nasdaq/Amex) */
940
+ exchanges?: string;
941
+ limit?: number;
942
+ /** last_price, price_change, volume */
943
+ order?: string;
944
+ price?: InsightLessAndMore;
945
+ }
946
+ export interface InsightGetIndustriesPerformanceRequest {
947
+ quote_access_type?: string;
948
+ quote_filters?: InsightGetIndustriesPerformanceQuoteFilter;
949
+ /** price-weighted, market-weighted */
950
+ ranking_type?: string;
951
+ }
952
+ export interface InsightGetIndustriesPerformanceResponse {
953
+ best_performing_quotes: InsightStockScreenerQuote[];
954
+ industries: InsightIndustryGroup[];
955
+ sectors: InsightSector[];
956
+ worst_performing_quotes: InsightStockScreenerQuote[];
957
+ }
958
+ export interface InsightGetMarketDatesRequest {
959
+ end_date?: string;
960
+ markets?: string[];
961
+ paging?: InsightPaging;
962
+ start_date?: string;
963
+ }
964
+ export interface InsightGetMarketDatesResponse {
965
+ count: number;
966
+ data: InsightExtendedMarketDate[];
967
+ }
968
+ export interface InsightGetMarketHoursResponse {
969
+ close_time: string;
970
+ next_market_day: InsightExtendedMarketDate;
971
+ open_right_now: boolean;
972
+ open_time: string;
973
+ open_today: boolean;
974
+ time_zone: string;
975
+ }
976
+ export interface InsightGetOwnershipsByIDRequest {
977
+ owner_id?: string;
978
+ paging?: InsightPaging;
979
+ }
980
+ export interface InsightGetOwnershipsBySymbolAsDashboardFieldsResponse {
981
+ count: number;
982
+ details: InsightSymbolRelatedField[][];
983
+ }
984
+ export interface InsightGetOwnershipsBySymbolRequest {
985
+ order?: InsightOrdering;
986
+ owner_type?: string;
987
+ paging?: InsightPaging;
988
+ search_query?: string;
989
+ symbols?: string[];
990
+ }
991
+ export interface InsightGetOwnershipsBySymbolResponse {
992
+ count: number;
993
+ details: InsightOwnershipDetails[];
994
+ }
995
+ export interface InsightGetOwnershipsBySymbolWithoutSearchQueryRequest {
996
+ order?: InsightOrdering;
997
+ owner_type?: string;
998
+ paging?: InsightPaging;
999
+ symbols?: string[];
1000
+ }
1001
+ export interface InsightGetScreenerPresetsResponse {
1002
+ count: number;
1003
+ default_presets: InsightScreenerPreset[];
1004
+ details: InsightScreenerPreset[];
1005
+ }
1006
+ export interface InsightGetSymbolFundamentalsRequest {
1007
+ mode?: string;
1008
+ symbol?: string;
1009
+ }
1010
+ export type InsightGetSymbolFundamentalsResponse = Record<string, any>;
1011
+ export interface InsightGetSymbolRelatedFieldsResponse {
1012
+ asset_allocations: InsightSymbolRelatedField[][];
1013
+ continents: InsightSymbolRelatedField[][];
1014
+ countries: InsightSymbolRelatedField[][];
1015
+ earning_release: InsightSymbolRelatedField[];
1016
+ holdings: InsightSymbolRelatedField[][];
1017
+ industries: InsightSymbolRelatedField[];
1018
+ market_caps: InsightSymbolRelatedField[][];
1019
+ maturities: InsightSymbolRelatedField[][];
1020
+ ownerships: InsightSymbolRelatedField[][];
1021
+ profile: InsightSymbolRelatedField[];
1022
+ quote: InsightSymbolRelatedField[];
1023
+ sectors: InsightSymbolRelatedField[][];
1024
+ securities: InsightSymbolRelatedField[][];
1025
+ symbol: string;
1026
+ symbol_type: string;
1027
+ }
1028
+ export interface InsightGetSymbolsPerTypeRequest {
1029
+ symbols?: string[];
1030
+ }
1031
+ export interface InsightGetSymbolsPerTypeResponse {
1032
+ EQUITY: string[];
1033
+ ETF: string[];
1034
+ INDEX: string[];
1035
+ MF: string[];
1036
+ }
1037
+ export interface InsightGetTopFundsRequest {
1038
+ fund_type?: string;
1039
+ inverse?: string;
1040
+ leverage?: string;
1041
+ order?: InsightOrdering;
1042
+ paging?: InsightPaging;
1043
+ quote_access_type?: string;
1044
+ /**
1045
+ * Ordering takes priority over ReverseOrder, ReverseOrder left for backwards compatibility
1046
+ * NOTE(@neghoda): Depricated feature - consider removing
1047
+ */
1048
+ reverse_order?: boolean;
1049
+ }
1050
+ export interface InsightGetTopFundsResponse {
1051
+ count: number;
1052
+ details: InsightExtendedFundData[];
1053
+ }
1054
+ export interface InsightGetTopSymbolsRequest {
1055
+ exchange?: string[];
1056
+ market_cap?: InsightLessAndMore;
1057
+ order?: InsightOrdering;
1058
+ pagination?: InsightPagination;
1059
+ paging?: InsightPaging;
1060
+ price?: InsightLessAndMore;
1061
+ quote_access_type?: string;
1062
+ sorts?: InsightOrdering[];
1063
+ volume?: InsightLessAndMore;
1064
+ }
1065
+ export interface InsightGetUsageDataRequest {
1066
+ branch_codes?: string[];
1067
+ end_time?: string;
1068
+ firm_ids?: number[];
1069
+ source?: string;
1070
+ start_time?: string;
1071
+ }
1072
+ export interface InsightGlobalIndex {
1073
+ continent_id: string;
1074
+ country: string;
1075
+ gdp: number;
1076
+ ppp: number;
1077
+ region_id: string;
1078
+ symbol: string;
1079
+ }
1080
+ export interface InsightGlobalIndexFull {
1081
+ company_name: string;
1082
+ continent_id: string;
1083
+ continent_name: string;
1084
+ country_id: string;
1085
+ country_name: string;
1086
+ gdp: number;
1087
+ last_price: number;
1088
+ ppp: number;
1089
+ price_change: number;
1090
+ price_change_percent: number;
1091
+ region_id: string;
1092
+ region_name: string;
1093
+ symbol: string;
1094
+ }
1095
+ export interface InsightHedgeFundsBestPerformingExpertsDistribution {
1096
+ buy: number;
1097
+ hold: number;
1098
+ sell: number;
1099
+ }
1100
+ export interface InsightHedgeFundsBestPerformingExpertsRatings {
1101
+ company_name: string;
1102
+ date: string;
1103
+ rating: string;
1104
+ ticker: string;
1105
+ }
1106
+ export interface InsightHedgeFundsBestPerformingExpertsResponse {
1107
+ distribution: InsightHedgeFundsBestPerformingExpertsDistribution;
1108
+ expert_picture_url: string;
1109
+ expert_uid: string;
1110
+ hedge_fund_name: string;
1111
+ name: string;
1112
+ num_of_stars: number;
1113
+ number_of_ranked_experts: number;
1114
+ portfolio_gain: number;
1115
+ rank: number;
1116
+ ratings: InsightHedgeFundsBestPerformingExpertsRatings[];
1117
+ three_years_annualized_return: number;
1118
+ }
1119
+ export interface InsightHedgeFundsRecentTransactionsResponse {
1120
+ action: string;
1121
+ assets_under_management: number;
1122
+ display_name: string;
1123
+ execution_time: string;
1124
+ expert_picture_url: string;
1125
+ expert_portfolio_id: number;
1126
+ hedge_fund_name: string;
1127
+ last_year_return: number;
1128
+ manager_name: string;
1129
+ price: number;
1130
+ rank: number;
1131
+ rating: string;
1132
+ shares_traded: number;
1133
+ stars: number;
1134
+ three_years_annualized_return: number;
1135
+ ticker: string;
1136
+ total_value: number;
1137
+ }
1138
+ export interface InsightHedgeFundsResponse {
1139
+ holdings: InsightHolding[];
1140
+ institutional_holdings: InsightInstitutionalHolding[];
1141
+ last_q_shares_traded: number;
1142
+ signal_data: InsightSignalData;
1143
+ total_num_hedge_funds: number;
1144
+ }
1145
+ export interface InsightHelpRequestWithSymbol {
1146
+ symbol?: string;
1147
+ }
1148
+ export interface InsightHistoricalIPO {
1149
+ currency: string;
1150
+ date: string;
1151
+ market: string;
1152
+ name: string;
1153
+ price: number;
1154
+ shares: number;
1155
+ ticker: string;
1156
+ }
1157
+ export interface InsightHistoricalPerf {
1158
+ date: string;
1159
+ performance: number;
1160
+ }
1161
+ export interface InsightHistoricalQuote {
1162
+ close: number;
1163
+ date: string;
1164
+ high: number;
1165
+ low: number;
1166
+ open: number;
1167
+ symbol: string;
1168
+ volume: number;
1169
+ }
1170
+ export interface InsightHolding {
1171
+ date: string;
1172
+ holding_amount: number;
1173
+ }
1174
+ export interface InsightHoldingBreakdown {
1175
+ company_name: string;
1176
+ percentage: number;
1177
+ rank: number;
1178
+ symbol: string;
1179
+ }
1180
+ export interface InsightIPOListResponse {
1181
+ ipo_list: InsightIPOResponse[];
1182
+ total_records: number;
1183
+ }
1184
+ export interface InsightIPOResponse {
1185
+ ceo: string;
1186
+ cik: number;
1187
+ country: string;
1188
+ day_one_return: number;
1189
+ exchange: InsightExchangeResponse;
1190
+ file_date: string;
1191
+ first_day_close: number;
1192
+ first_day_open: number;
1193
+ industry: InsightClassificationResponse;
1194
+ industry_group: InsightClassificationResponse;
1195
+ ipo_date: string;
1196
+ ipo_date_approx: number;
1197
+ ipo_return: number;
1198
+ ipo_size: number;
1199
+ lockup_expiration: string;
1200
+ lockup_period: number;
1201
+ name: string;
1202
+ offer_price: number;
1203
+ offer_price_max: number;
1204
+ offer_price_min: number;
1205
+ offer_shares: number;
1206
+ prospectus_url: string;
1207
+ quiet_period_expiration: string;
1208
+ quote: InsightQuote;
1209
+ sector: InsightClassificationResponse;
1210
+ shares_outstanding: number;
1211
+ shares_over_alloted: number;
1212
+ status: string;
1213
+ sub_industry: InsightClassificationResponse;
1214
+ symbol: string;
1215
+ total_expenses: number;
1216
+ underwrites: InsightUnderwriteResponse[];
1217
+ }
1218
+ export interface InsightIncludeExclude {
1219
+ exclude?: string[];
1220
+ include?: string[];
1221
+ }
1222
+ export interface InsightIndustryGroup {
1223
+ industry_group_code: string;
1224
+ industry_group_market_cap: number;
1225
+ industry_group_market_cap_1day: number;
1226
+ industry_group_market_cap_1month: number;
1227
+ industry_group_market_cap_1week: number;
1228
+ industry_group_market_cap_2week: number;
1229
+ industry_group_name: string;
1230
+ }
1231
+ export interface InsightInsidersBestPerformingExpertDistribution {
1232
+ buy: number;
1233
+ hold: number;
1234
+ sell: number;
1235
+ }
1236
+ export interface InsightInsidersBestPerformingExpertTransaction {
1237
+ company_name: string;
1238
+ date: string;
1239
+ ticker: string;
1240
+ transaction: string;
1241
+ }
1242
+ export interface InsightInsidersBestPerformingExpertsResponse {
1243
+ distribution: InsightInsidersBestPerformingExpertDistribution;
1244
+ excess_return: number;
1245
+ expert_picture_url: string;
1246
+ expert_uid: string;
1247
+ firm_name: string;
1248
+ good_transactions: number;
1249
+ name: string;
1250
+ num_of_stars: number;
1251
+ number_of_ranked_insiders: number;
1252
+ rank: number;
1253
+ success_rate: number;
1254
+ total_transactions: number;
1255
+ transactions: InsightInsidersBestPerformingExpertTransaction[];
1256
+ }
1257
+ export type InsightInsidersHotstocksBreakDown = object;
1258
+ export interface InsightInsidersHotstocksResponse {
1259
+ break_down: InsightInsidersHotstocksBreakDown;
1260
+ signals: InsightInsidersHotstocksSignals;
1261
+ stocks: InsightInsidersHotstocksStocks;
1262
+ }
1263
+ export type InsightInsidersHotstocksSignals = object;
1264
+ export type InsightInsidersHotstocksStocks = object;
1265
+ export interface InsightInsidersLiveFeedResponse {
1266
+ added_on_timestamp: string;
1267
+ average_return: number;
1268
+ company_name: string;
1269
+ expert_operation_id: number;
1270
+ form_4: string;
1271
+ img: string;
1272
+ insider_operation_type_id: number;
1273
+ is_director: boolean;
1274
+ is_officer: boolean;
1275
+ is_other: boolean;
1276
+ is_ten_percent_owner: boolean;
1277
+ market_cap: number;
1278
+ name: string;
1279
+ num_of_stars: number;
1280
+ officer_title: string;
1281
+ operation_added_on_timestamp: string;
1282
+ position: string;
1283
+ rank: number;
1284
+ rec_success: number;
1285
+ rec_total: number;
1286
+ sector: number;
1287
+ stock_id: number;
1288
+ stock_ticker: string;
1289
+ time_ago: string;
1290
+ trans_amount: number;
1291
+ transaction: string;
1292
+ transaction_date: string;
1293
+ transaction_id: number;
1294
+ uid: string;
1295
+ }
1296
+ export interface InsightInsidersOverviewResponse {
1297
+ average_return: number;
1298
+ companies_review: InsightCompaniesReview[];
1299
+ company_name: string;
1300
+ name: string;
1301
+ picture: string;
1302
+ position: string;
1303
+ positive_transactions: number;
1304
+ rank: number;
1305
+ stars: number;
1306
+ success_rate: number;
1307
+ ticker: string;
1308
+ total_transactions: number;
1309
+ }
1310
+ export interface InsightInsidersResponse {
1311
+ confidence_signal: InsightConfidenceSignal;
1312
+ discretionary_transactions: number;
1313
+ transactions: InsightTransaction[];
1314
+ trend: number;
1315
+ uninformative_transactions: number;
1316
+ yearly_insider_transactions: InsightYearlyInsiderTransaction[];
1317
+ }
1318
+ export interface InsightInstitutionalHolding {
1319
+ action: string;
1320
+ change: number;
1321
+ expert_uid: string;
1322
+ image_url: string;
1323
+ institution_id: number;
1324
+ institution_name: string;
1325
+ is_active: boolean;
1326
+ manager_name: string;
1327
+ percentage_of_portfolio: number;
1328
+ rank: number;
1329
+ total_ranked_institutions: number;
1330
+ value: number;
1331
+ }
1332
+ export interface InsightIntradayRequest {
1333
+ /** Format: YYYY-MM-DD (OPTIONAL) */
1334
+ from?: string;
1335
+ /** (OPTIONAL) */
1336
+ raw_volumes?: boolean;
1337
+ /** (REQUIRE) */
1338
+ rsi_span?: number;
1339
+ /** (OPTIONAL) */
1340
+ smoothing?: number;
1341
+ /** (REQUIRE) */
1342
+ symbol?: string;
1343
+ /** Format: YYYY-MM-DD (OPTIONAL) */
1344
+ to?: string;
1345
+ }
1346
+ export interface InsightIntradayResponse {
1347
+ date: string;
1348
+ day_high: number;
1349
+ day_low: number;
1350
+ ema: number;
1351
+ price: number;
1352
+ price_change: number;
1353
+ price_change_percent: number;
1354
+ rsi: number;
1355
+ sma: number;
1356
+ volume: number;
1357
+ }
1358
+ export interface InsightInvestorSentimentResponse {
1359
+ age_distribution: InsightAgeDistribution;
1360
+ investor_stats_overview: InsightInvestorStatsOverview;
1361
+ investors_also_bought: InsightInvestorsAlsoBought[];
1362
+ }
1363
+ export interface InsightInvestorStatsOverview {
1364
+ average_allocation: number;
1365
+ investor_score: number;
1366
+ number_of_portfolios: number;
1367
+ percent_over_last_30_days: number;
1368
+ percent_over_last_7_days: number;
1369
+ portfolios_holding_stock: number;
1370
+ sector_average_score: number;
1371
+ sector_average_sentiment: string;
1372
+ sentiment: string;
1373
+ }
1374
+ export interface InsightInvestorsAlsoBought {
1375
+ average_holding_size: number;
1376
+ company_name: string;
1377
+ last_seven_day_change: number;
1378
+ last_thirty_day_change: number;
1379
+ score: number;
1380
+ sector: number;
1381
+ sector_name: string;
1382
+ sentiment: string;
1383
+ ticker: string;
1384
+ }
1385
+ export interface InsightLatestAnalystRatingsOnStockRequest {
1386
+ /** Get analyst ratings from the past X months (OPTIONAL) */
1387
+ months?: number;
1388
+ /** The number of analysts to return (OPTIONAL) */
1389
+ num?: number;
1390
+ /** Sort order of the analyst ratings Enums(date, rank) (OPTIONAL) */
1391
+ sort?: string;
1392
+ /** Comma-separated tickers */
1393
+ tickers?: string[];
1394
+ }
1395
+ export interface InsightLatestAnalystRatingsOnStockResponse {
1396
+ analyst_action: string;
1397
+ analyst_name: string;
1398
+ analyst_rank: number;
1399
+ article_quote: string;
1400
+ article_site: string;
1401
+ article_title: string;
1402
+ converted_price_target: number;
1403
+ converted_price_target_currency: number;
1404
+ converted_price_target_currency_code: string;
1405
+ excess_return: number;
1406
+ expert_full_picture_url: string;
1407
+ expert_picture_url: string;
1408
+ expert_uid: string;
1409
+ firm_name: string;
1410
+ good_recommendations: number;
1411
+ num_of_stars: number;
1412
+ number_of_ranked_experts: number;
1413
+ price_target: number;
1414
+ price_target_currency: number;
1415
+ price_target_currency_code: string;
1416
+ recommendation: string;
1417
+ recommendation_date: string;
1418
+ stock_avg_return: number;
1419
+ stock_good_recommendations: number;
1420
+ stock_success_rate: number;
1421
+ stock_total_recommendations: number;
1422
+ success_rate: number;
1423
+ ticker: string;
1424
+ timestamp: string;
1425
+ total_recommendations: number;
1426
+ url: string;
1427
+ }
1428
+ export interface InsightLessAndMore {
1429
+ less_than?: number;
1430
+ more_than?: number;
1431
+ }
1432
+ export interface InsightLiabilities {
1433
+ debt_ratio: number;
1434
+ equity_to_assets_ratio: number;
1435
+ }
1436
+ export interface InsightLiquidity {
1437
+ cash_ratio: number;
1438
+ current_ratio: number;
1439
+ quick_ratio: number;
1440
+ }
1441
+ export interface InsightLiveFeedRequest {
1442
+ /** Get analyst ratings from the past X months */
1443
+ bookmark_id?: number;
1444
+ /** Return the latest X ratings */
1445
+ num?: number;
1446
+ /** Type of quote to load Enums(nbbo, delayed, cboe, bats, realtime, realtime_snapshot) (REQUIRED) */
1447
+ quote_access_type?: string;
1448
+ }
1449
+ export interface InsightLiveFeedResponse {
1450
+ action: string;
1451
+ added_on_timestamp: string;
1452
+ analyst_name: string;
1453
+ analyst_rank: number;
1454
+ article_site: string;
1455
+ article_title: string;
1456
+ company_name: string;
1457
+ converted_price_target: number;
1458
+ converted_price_target_currency: number;
1459
+ converted_price_target_currency_code: string;
1460
+ excess_return: number;
1461
+ expert_picture_url: string;
1462
+ expert_uid: string;
1463
+ firm_name: string;
1464
+ good_recommendations: number;
1465
+ market_cap: number;
1466
+ num_of_stars: number;
1467
+ number_of_ranked_experts: number;
1468
+ operation_id: number;
1469
+ price_target: number;
1470
+ quote: InsightTiprankQuote;
1471
+ quote_title: string;
1472
+ recommendation: string;
1473
+ recommendation_date: string;
1474
+ sector: string;
1475
+ stock_ticker: string;
1476
+ success_rate: number;
1477
+ time_ago: string;
1478
+ timestamp: string;
1479
+ total_recommendations: number;
1480
+ unique_operation_id: string;
1481
+ url: string;
1482
+ }
1483
+ export interface InsightMarketCapBreakdown {
1484
+ breakdown: string;
1485
+ percentage: number;
1486
+ }
1487
+ export interface InsightMatrixData {
1488
+ date: InsightDate;
1489
+ option_data: InsightOptionData[];
1490
+ }
1491
+ export interface InsightMaturityBreakdown {
1492
+ breakdown: string;
1493
+ percentage: number;
1494
+ }
1495
+ export interface InsightMomentumRatioGraphRequest {
1496
+ benchmark?: string;
1497
+ mode?: string;
1498
+ period?: number;
1499
+ range?: string;
1500
+ set_ema?: boolean;
1501
+ symbols?: string[];
1502
+ }
1503
+ export interface InsightMomentumRatioGraphResponse {
1504
+ AAPL: InsightSymbolMomentum[];
1505
+ CSCO: InsightSymbolMomentum[];
1506
+ }
1507
+ export interface InsightMostPopularTagsRequest {
1508
+ /** (REQUIRE) */
1509
+ language?: string;
1510
+ time?: InsightMostPopularTagsRequestTimeEnum;
1511
+ /** (REQUIRE) */
1512
+ type?: InsightMostPopularTagsRequestTypeEnum;
1513
+ }
1514
+ export interface InsightMover {
1515
+ company_name: string;
1516
+ ticker: string;
1517
+ }
1518
+ export interface InsightMultipleCryptoLogosRequest {
1519
+ symbols?: string[];
1520
+ }
1521
+ export interface InsightMultipleSymbolLogosRequest {
1522
+ symbols?: string[];
1523
+ }
1524
+ export interface InsightNews {
1525
+ author: string;
1526
+ body: string;
1527
+ channels: InsightNewsChannel[];
1528
+ created: string;
1529
+ data: InsightNewsExtraData;
1530
+ id: string;
1531
+ image: InsightNewsImage[];
1532
+ is_press_release: boolean;
1533
+ source_id: number;
1534
+ symbols: InsightNewsStock[];
1535
+ tags: InsightNewsTag[];
1536
+ teaser: string;
1537
+ title: string;
1538
+ updated: string;
1539
+ url: string;
1540
+ }
1541
+ export interface InsightNewsArticlesResponse {
1542
+ added_on: string;
1543
+ article_timestamp: string;
1544
+ company_name: string;
1545
+ date: string;
1546
+ publish_time_full: string;
1547
+ sentiment: string;
1548
+ site_name: string;
1549
+ stock_type: string;
1550
+ ticker: string;
1551
+ title: string;
1552
+ url: string;
1553
+ url_string: string;
1554
+ }
1555
+ export interface InsightNewsBuzz {
1556
+ this_week: number;
1557
+ weekly_average: number;
1558
+ }
1559
+ export interface InsightNewsChannel {
1560
+ name: string;
1561
+ }
1562
+ export interface InsightNewsData {
1563
+ type: string;
1564
+ value: string;
1565
+ }
1566
+ export type InsightNewsExtraData = Record<string, InsightNewsData>;
1567
+ export interface InsightNewsFilterRequest {
1568
+ author?: string;
1569
+ channels?: string[];
1570
+ end_date?: string;
1571
+ headline?: boolean;
1572
+ paging?: InsightPaging;
1573
+ press_release?: boolean;
1574
+ start_date?: string;
1575
+ symbols?: string[];
1576
+ tags?: string[];
1577
+ }
1578
+ export interface InsightNewsImage {
1579
+ size: string;
1580
+ url: string;
1581
+ }
1582
+ export interface InsightNewsPreview {
1583
+ created: string;
1584
+ id: string;
1585
+ image: InsightNewsImage[];
1586
+ is_body_empty: boolean;
1587
+ is_press_release: boolean;
1588
+ teaser: string;
1589
+ title: string;
1590
+ updated: string;
1591
+ }
1592
+ export interface InsightNewsRequest {
1593
+ id?: string;
1594
+ }
1595
+ export interface InsightNewsResponse {
1596
+ count: number;
1597
+ news: InsightNews[];
1598
+ }
1599
+ export interface InsightNewsScore {
1600
+ sector_score: number;
1601
+ stock_score: string;
1602
+ stock_score_value: number;
1603
+ }
1604
+ export interface InsightNewsSentiment {
1605
+ counts: InsightNewsSentimentCount[];
1606
+ news_buzz: InsightNewsBuzz;
1607
+ news_score: InsightNewsScore;
1608
+ sector_sentiment: InsightSentiment;
1609
+ stock_sentiment: InsightSentiment;
1610
+ word_cloud: string[];
1611
+ }
1612
+ export interface InsightNewsSentimentCount {
1613
+ all: number;
1614
+ buy: number;
1615
+ neutral: number;
1616
+ sell: number;
1617
+ week_start: string;
1618
+ }
1619
+ export interface InsightNewsSentimentResponse {
1620
+ news_sentiment: InsightNewsSentiment;
1621
+ }
1622
+ export interface InsightNewsStock {
1623
+ name: string;
1624
+ }
1625
+ export interface InsightNewsTag {
1626
+ name: string;
1627
+ }
1628
+ export interface InsightNewsfeed {
1629
+ created_at: string;
1630
+ data: InsightNewsExtraData;
1631
+ id: number;
1632
+ language_id: number;
1633
+ news_item_id: number;
1634
+ permalink: any;
1635
+ release_date: string;
1636
+ summary: string;
1637
+ symbols: string[];
1638
+ tags: string[];
1639
+ title: string;
1640
+ types: string[];
1641
+ updated_at: string;
1642
+ user_id: number;
1643
+ }
1644
+ export interface InsightNewsfeedRequest {
1645
+ count?: number;
1646
+ /** (REQUIRE) */
1647
+ language?: string;
1648
+ released_after?: number;
1649
+ released_before?: number;
1650
+ symbol?: string;
1651
+ tag?: string;
1652
+ type?: InsightNewsfeedRequestTypeEnum;
1653
+ with_tag_group?: string;
1654
+ }
1655
+ export interface InsightOptionData {
1656
+ expiry_date: InsightDate;
1657
+ greeks: InsightOptionGreeks;
1658
+ strike_price: number;
1659
+ theoretical_price: number;
1660
+ ticker: string;
1661
+ values: InsightOptionValues;
1662
+ }
1663
+ export interface InsightOptionGreeks {
1664
+ delta: number;
1665
+ gamma: number;
1666
+ rho: number;
1667
+ theta: number;
1668
+ vega: number;
1669
+ }
1670
+ export interface InsightOptionValues {
1671
+ intrinsic_value: number;
1672
+ option_value: number;
1673
+ time_value: number;
1674
+ }
1675
+ export interface InsightOrdering {
1676
+ /** @default "asc" */
1677
+ direction: InsightOrderingDirectionEnum;
1678
+ /**
1679
+ * Sort direction:
1680
+ * * asc - Ascending, from A to Z.
1681
+ * * desc - Descending, from Z to A.
1682
+ */
1683
+ field: string;
1684
+ }
1685
+ export interface InsightOwnershipDetails {
1686
+ date: string;
1687
+ number_of_shares: number;
1688
+ owner_cik: number;
1689
+ owner_name: string;
1690
+ owner_type: string;
1691
+ share_change: number;
1692
+ symbol: string;
1693
+ }
1694
+ export interface InsightPagination {
1695
+ page: number;
1696
+ size: number;
1697
+ }
1698
+ export interface InsightPaging {
1699
+ limit: number;
1700
+ offset: number;
1701
+ }
1702
+ export interface InsightPerformanceHistory {
1703
+ historical_perf: InsightHistoricalPerf[];
1704
+ name: string;
1705
+ yearly_performance: InsightYearlyPerformance[];
1706
+ }
1707
+ export interface InsightPerformingExpertsDistribution {
1708
+ buy: number;
1709
+ hold: number;
1710
+ sell: number;
1711
+ }
1712
+ export interface InsightPerformingExpertsRatings {
1713
+ company_name: string;
1714
+ date: string;
1715
+ price_target: number;
1716
+ rating: string;
1717
+ ticker: string;
1718
+ }
1719
+ export interface InsightPeriodFilter {
1720
+ type?: InsightPeriodFilterTypeEnum;
1721
+ value?: number;
1722
+ }
1723
+ export interface InsightPortfoliosRequest {
1724
+ /** (REQUIRED) */
1725
+ expert_uid?: string;
1726
+ number?: number;
1727
+ /** Type of quote to load Enums(nbbo, delayed, cboe, bats, realtime, realtime_snapshot) (REQUIRED) */
1728
+ quote_access_type?: string;
1729
+ }
1730
+ export interface InsightPortfoliosResponse {
1731
+ close_date: any;
1732
+ close_url: any;
1733
+ company_name: string;
1734
+ excess_return: number;
1735
+ open_date: string;
1736
+ open_url: any;
1737
+ operation: string;
1738
+ price_target: number;
1739
+ quote: InsightTiprankQuote;
1740
+ sector: string;
1741
+ status: string;
1742
+ stock_ticker: string;
1743
+ }
1744
+ export interface InsightPublicQuoteProfile {
1745
+ average_volume_30d: number;
1746
+ closing_price: number;
1747
+ company_description: string;
1748
+ company_name: string;
1749
+ dividend_percent: number;
1750
+ exchange: string;
1751
+ /** Description of other fields */
1752
+ exchange_name: string;
1753
+ /** Fund fields */
1754
+ expense_ratio: number;
1755
+ high_52w_price: number;
1756
+ high_price: number;
1757
+ inverse: boolean;
1758
+ /** Quote */
1759
+ last_price: number;
1760
+ leverage: number;
1761
+ low_52w_price: number;
1762
+ low_price: number;
1763
+ market_cap: number;
1764
+ naics: number;
1765
+ naics_description: string;
1766
+ open_price: number;
1767
+ price_change: number;
1768
+ price_change_percent: number;
1769
+ price_to_earnings_ratio: number;
1770
+ /** Symbol industries */
1771
+ sic: number;
1772
+ sic_description: string;
1773
+ sponsor: string;
1774
+ stock_type: string;
1775
+ structure: string;
1776
+ symbol: string;
1777
+ volume: number;
1778
+ yesterday_close_price: number;
1779
+ }
1780
+ export interface InsightQuote {
1781
+ close: number;
1782
+ date: string;
1783
+ high: number;
1784
+ low: number;
1785
+ open: number;
1786
+ price_change: number;
1787
+ price_change_percent: number;
1788
+ symbol: string;
1789
+ volume: number;
1790
+ }
1791
+ export interface InsightQuoteFundamentalsSearchEntry {
1792
+ company_name: string;
1793
+ standard_name: string;
1794
+ symbol: string;
1795
+ }
1796
+ export interface InsightQuoteFundamentalsSearchResponse {
1797
+ count: number;
1798
+ details: InsightQuoteFundamentalsSearchEntry[];
1799
+ }
1800
+ export interface InsightQuoteHistoryRequest {
1801
+ /** Use ONLY one of the next filters: TimeRange OR Period */
1802
+ filter?: InsightQuoteHistoryRequestFilter;
1803
+ order?: InsightOrdering;
1804
+ paging?: InsightPaging;
1805
+ /** Type of quote to load Enums(nbbo, delayed, cboe, bats, realtime, realtime_snapshot) (REQUIRED) */
1806
+ quote_access_type?: string;
1807
+ }
1808
+ export interface InsightQuoteHistoryRequestFilter {
1809
+ period?: InsightPeriodFilter;
1810
+ symbol?: string;
1811
+ time_range?: InsightTimeRangeFilter;
1812
+ }
1813
+ export interface InsightQuoteHistoryResponse {
1814
+ count: number;
1815
+ extremum: InsightExtremum;
1816
+ quotes: InsightQuote[];
1817
+ }
1818
+ export interface InsightRatingDistribution {
1819
+ buy_percent: number;
1820
+ countries: string[];
1821
+ hold_percent: number;
1822
+ sell_percent: number;
1823
+ }
1824
+ export interface InsightRatios {
1825
+ asset_efficiency: InsightAssetEfficiency;
1826
+ liabilities: InsightLiabilities;
1827
+ liquidity: InsightLiquidity;
1828
+ valuation: InsightValuation;
1829
+ }
1830
+ export interface InsightRecentIPOListRequest {
1831
+ load_quotes?: boolean;
1832
+ order?: InsightOrdering;
1833
+ paging?: InsightPaging;
1834
+ quote_access_type?: string;
1835
+ time?: string;
1836
+ }
1837
+ export interface InsightRecentNewsPreviewsResponse {
1838
+ news: InsightNewsPreview[];
1839
+ }
1840
+ export interface InsightRegion {
1841
+ id: string;
1842
+ name: string;
1843
+ }
1844
+ export interface InsightRemoveCustomIndexRequest {
1845
+ id?: string;
1846
+ }
1847
+ export interface InsightRemoveRewrittenFieldValueRequest {
1848
+ comment?: string;
1849
+ field_id?: string;
1850
+ internal_id?: string;
1851
+ symbol?: string;
1852
+ }
1853
+ export interface InsightRemoveScreenerPresetRequest {
1854
+ id?: string;
1855
+ }
1856
+ export interface InsightRewriteFieldValueRequest {
1857
+ comment?: string;
1858
+ field_id?: string;
1859
+ internal_id?: string;
1860
+ new_value?: any;
1861
+ symbol?: string;
1862
+ }
1863
+ export interface InsightScreenerPreset {
1864
+ created_at: string;
1865
+ id: string;
1866
+ preset: Record<string, any>;
1867
+ preset_color: string;
1868
+ preset_description: string;
1869
+ preset_name: string;
1870
+ updated_at: string;
1871
+ }
1872
+ export interface InsightSearchArticleRequest {
1873
+ /** (REQUIRE) */
1874
+ language?: string;
1875
+ /** (REQUIRE) */
1876
+ s?: string;
1877
+ type?: InsightSearchArticleRequestTypeEnum;
1878
+ }
1879
+ export interface InsightSeasonalityEntry {
1880
+ april: InsightTickerSeasonality;
1881
+ august: InsightTickerSeasonality;
1882
+ december: InsightTickerSeasonality;
1883
+ february: InsightTickerSeasonality;
1884
+ january: InsightTickerSeasonality;
1885
+ july: InsightTickerSeasonality;
1886
+ june: InsightTickerSeasonality;
1887
+ march: InsightTickerSeasonality;
1888
+ may: InsightTickerSeasonality;
1889
+ november: InsightTickerSeasonality;
1890
+ october: InsightTickerSeasonality;
1891
+ score: number;
1892
+ september: InsightTickerSeasonality;
1893
+ }
1894
+ export interface InsightSeasonalityRequest {
1895
+ benchmark?: string;
1896
+ lookahead?: number;
1897
+ symbols?: string[];
1898
+ years?: number;
1899
+ }
1900
+ export type InsightSeasonalityResponse = Record<string, InsightSeasonalityEntry>;
1901
+ export interface InsightSector {
1902
+ industry_groups: InsightIndustryGroup[];
1903
+ sector_code: string;
1904
+ sector_market_cap: number;
1905
+ sector_market_cap_1day: number;
1906
+ sector_market_cap_1month: number;
1907
+ sector_market_cap_1week: number;
1908
+ sector_market_cap_2week: number;
1909
+ sector_name: string;
1910
+ }
1911
+ export interface InsightSectorBreakdown {
1912
+ breakdown: string;
1913
+ code: string;
1914
+ percentage: number;
1915
+ }
1916
+ export interface InsightSectorConsensus {
1917
+ moderate_buy: number;
1918
+ moderate_sell: number;
1919
+ neutral: number;
1920
+ order: number;
1921
+ sector: string;
1922
+ strong_buy: number;
1923
+ strong_sell: number;
1924
+ }
1925
+ export interface InsightSectorConsensusResponse {
1926
+ sectors: InsightSectorConsensus[];
1927
+ }
1928
+ export interface InsightSectorFilter {
1929
+ min_weight?: number;
1930
+ sector_id?: string;
1931
+ }
1932
+ export interface InsightSentiment {
1933
+ negative: number;
1934
+ neutral: number;
1935
+ positive: number;
1936
+ }
1937
+ export interface InsightSignalData {
1938
+ based_on_num_hedge_funds: number;
1939
+ rating: string;
1940
+ sentiment: number;
1941
+ }
1942
+ export interface InsightSmartScorePerformanceResponse {
1943
+ performance_history: InsightPerformanceHistory[];
1944
+ }
1945
+ export interface InsightSmartScoreRequest {
1946
+ /** The tickers of the stocks */
1947
+ tickers?: string[];
1948
+ }
1949
+ export interface InsightSmartScoreResponse {
1950
+ analyst_consensus: string;
1951
+ blogger_bullish_sentiment: number;
1952
+ blogger_consensus: string;
1953
+ blogger_sector_avg: number;
1954
+ fundamentals_asset_growth: number;
1955
+ fundamentals_return_on_equity: number;
1956
+ hedge_fund_trend: string;
1957
+ hedge_fund_trend_value: number;
1958
+ insider_trend: string;
1959
+ insiders_last_3_months_sum: number;
1960
+ investor_holding_change_last_30_days: number;
1961
+ investor_holding_change_last_7_days: number;
1962
+ investor_sentiment: string;
1963
+ news_sentiment: string;
1964
+ news_sentiments_bearish_percent: number;
1965
+ news_sentiments_bullish_percent: number;
1966
+ price_target: number;
1967
+ sma: string;
1968
+ smart_score: number;
1969
+ technicals_twelve_months_momentum: number;
1970
+ ticker: string;
1971
+ }
1972
+ export interface InsightSmartScoreTopStocksRequest {
1973
+ /** "the number of results per page to return" */
1974
+ page?: number;
1975
+ /** "which page number to return" */
1976
+ page_size?: number;
1977
+ /** "If a ticker is specified, the API call returns all the top smart score stocks in the same sector as the ticker provided" */
1978
+ ticker?: string;
1979
+ }
1980
+ export interface InsightStockMarketHeatmapResponse {
1981
+ details: InsightStockMarketHeatmapEntry[];
1982
+ max_change: number;
1983
+ min_change: number;
1984
+ }
1985
+ export interface InsightStockScreenerQuote {
1986
+ average_volume_30d: number;
1987
+ company_name: string;
1988
+ dividend_ex_date: string;
1989
+ dividend_pay_date: string;
1990
+ dividend_percent: number;
1991
+ exchange: string;
1992
+ exchange_name: string;
1993
+ gap: number;
1994
+ industry: string;
1995
+ industry_code: string;
1996
+ last_price: number;
1997
+ market_cap: number;
1998
+ pe_ratio: number;
1999
+ price_change: number;
2000
+ price_change_percent: number;
2001
+ symbol: string;
2002
+ volume: number;
2003
+ }
2004
+ export interface InsightStockScreenerRequest {
2005
+ average_volume_30d?: InsightLessAndMore;
2006
+ dividend_ex_date?: InsightBeforeAndAfter;
2007
+ dividend_pay_date?: InsightBeforeAndAfter;
2008
+ dividend_percent?: InsightLessAndMore;
2009
+ exchange?: InsightIncludeExclude;
2010
+ gap?: InsightLessAndMore;
2011
+ industry?: InsightIncludeExclude;
2012
+ market_cap?: InsightLessAndMore;
2013
+ order?: InsightOrdering;
2014
+ pagination?: InsightPagination;
2015
+ paging?: InsightPaging;
2016
+ pe_ratio?: InsightLessAndMore;
2017
+ price?: InsightLessAndMore;
2018
+ quote_access_type?: string;
2019
+ sorts?: InsightOrdering[];
2020
+ stock_type?: string;
2021
+ volume?: InsightLessAndMore;
2022
+ }
2023
+ export interface InsightStockScreenerResponse {
2024
+ count: number;
2025
+ details: InsightStockScreenerQuote[];
2026
+ }
2027
+ export interface InsightStocksConsensusOverTimeRequest {
2028
+ /** "The intervals over which the consensus is given" */
2029
+ interval?: string;
2030
+ /** "The ticker of the stock" (REQUIRE) */
2031
+ ticker?: string;
2032
+ }
2033
+ export interface InsightStocksConsensusOverTimeResponse {
2034
+ buy: number;
2035
+ consensus: string;
2036
+ date: string;
2037
+ end_of_day_price: number;
2038
+ hold: number;
2039
+ sell: number;
2040
+ }
2041
+ export interface InsightStocksEventsRequest {
2042
+ /** "number of events to return" */
2043
+ num?: number;
2044
+ /** "The ticker of the stock" (REQUIRE) */
2045
+ ticker?: string;
2046
+ }
2047
+ export interface InsightStocksEventsResponse {
2048
+ action: string;
2049
+ added_on: string;
2050
+ amount: number;
2051
+ company_name: string;
2052
+ expert_name: string;
2053
+ expert_type: string;
2054
+ firm_name: string;
2055
+ rating: string;
2056
+ site_name: string;
2057
+ stars: number;
2058
+ ticker: string;
2059
+ }
2060
+ export type InsightStocksTopMoversResponse = Record<string, InsightMover[]>;
2061
+ export interface InsightSupportedTickersResponse {
2062
+ tickers: string[];
2063
+ }
2064
+ export interface InsightSymbolIndustries {
2065
+ industry: string;
2066
+ industry_group: string;
2067
+ sector: string;
2068
+ sub_industry: string;
2069
+ }
2070
+ export interface InsightSymbolLogoConvertedRequest {
2071
+ conversion?: InsightSymbolLogoConvertedRequestConversionEnum;
2072
+ symbol?: string;
2073
+ }
2074
+ export interface InsightSymbolLogosResponse {
2075
+ logo: string;
2076
+ logo_normal: string;
2077
+ logo_original: string;
2078
+ logo_square: string;
2079
+ logo_square_strict: string;
2080
+ logo_thumbnail: string;
2081
+ name: string;
2082
+ symbol: string;
2083
+ }
2084
+ export interface InsightSymbolRelatedField {
2085
+ can_be_modified: boolean;
2086
+ field_id: string;
2087
+ field_name: string;
2088
+ has_action_log: boolean;
2089
+ internal_id: any;
2090
+ morningstar_value: any;
2091
+ rewritten: boolean;
2092
+ source: string;
2093
+ updated_at: string;
2094
+ value: any;
2095
+ }
2096
+ export interface InsightSymbolSocialsResponse {
2097
+ facebook: string;
2098
+ facebook_link: string;
2099
+ instagram: string;
2100
+ instagram_link: string;
2101
+ linkedin: string;
2102
+ linkedin_link: string;
2103
+ name: string;
2104
+ symbol: string;
2105
+ twitter: string;
2106
+ twitter_link: string;
2107
+ youtube: string;
2108
+ youtube_channel: string;
2109
+ youtube_channel_link: string;
2110
+ youtube_link: string;
2111
+ }
2112
+ export interface InsightTagShortInfo {
2113
+ articles: number;
2114
+ symbol: string;
2115
+ }
2116
+ export interface InsightTickerData {
2117
+ historic_volatility: number;
2118
+ ticker: string;
2119
+ }
2120
+ export interface InsightTickerSeasonality {
2121
+ average: number;
2122
+ benchmark_average: number;
2123
+ difference: number;
2124
+ failure: number;
2125
+ score: number;
2126
+ success: number;
2127
+ total_years: number;
2128
+ yearly_data: InsightYearlyData[];
2129
+ }
2130
+ export interface InsightTimeRangeFilter {
2131
+ /** Use unix timestamp in seconds */
2132
+ end_time?: number;
2133
+ /** Use unix timestamp in seconds */
2134
+ start_time?: number;
2135
+ }
2136
+ export interface InsightTiprankQuote {
2137
+ ask_px: number;
2138
+ ask_sz: number;
2139
+ avg_vol_30d: number;
2140
+ bid_px: number;
2141
+ bid_sz: number;
2142
+ closing_px: number;
2143
+ column: number;
2144
+ com_shrs_out: number;
2145
+ comp_desc: string;
2146
+ comp_name: string;
2147
+ condition: string;
2148
+ div_amt: number;
2149
+ div_date_ex: string;
2150
+ div_yield: number;
2151
+ high52w_px: number;
2152
+ high_px: number;
2153
+ info_time: string;
2154
+ issue_market: string;
2155
+ issure_market: string;
2156
+ last_px: number;
2157
+ low_52w_px: number;
2158
+ low_px: number;
2159
+ mkt_cap: number;
2160
+ open_px: number;
2161
+ pay_date: string;
2162
+ pe_ratio: number;
2163
+ post_ask_px: number;
2164
+ post_ask_sz: number;
2165
+ post_bid_px: number;
2166
+ post_bid_sz: number;
2167
+ post_last_px: number;
2168
+ post_quote_time: string;
2169
+ post_trade_time: string;
2170
+ pre_ask_px: number;
2171
+ pre_ask_sz: number;
2172
+ pre_bid_px: number;
2173
+ pre_bid_sz: number;
2174
+ pre_last_px: number;
2175
+ pre_quote_time: string;
2176
+ pre_trade_time: string;
2177
+ price_change: number;
2178
+ price_change_percent: number;
2179
+ quote_time: string;
2180
+ symbol: string;
2181
+ trade_px: number;
2182
+ trade_region: string;
2183
+ trade_sz: number;
2184
+ trade_time: string;
2185
+ volume: number;
2186
+ yest_close_px: number;
2187
+ }
2188
+ export interface InsightTopRateStocksResponse {
2189
+ company_name: string;
2190
+ consensus: string;
2191
+ last_rating_date: string;
2192
+ price_target: number;
2193
+ sector: string;
2194
+ ticker: string;
2195
+ }
2196
+ export interface InsightTopStock {
2197
+ name: string;
2198
+ ticker: string;
2199
+ }
2200
+ export interface InsightTopStocks {
2201
+ name: string;
2202
+ stocks: InsightTopStock[];
2203
+ }
2204
+ export interface InsightTopStocksBySectorsRequest {
2205
+ /** "The ticker of the stock" Enums(3, 4, 5) */
2206
+ num?: number;
2207
+ /** "The ticker of the stock" (REQUIRE) */
2208
+ ticker?: string;
2209
+ }
2210
+ export interface InsightTopStocksBySectorsResponse {
2211
+ sector_name: string;
2212
+ top_stocks: InsightTopStocks[];
2213
+ }
2214
+ export interface InsightTopStocksEntry {
2215
+ company_name: string;
2216
+ last_price: number;
2217
+ logo: InsightSymbolLogosResponse;
2218
+ price_change: number;
2219
+ price_change_percent: number;
2220
+ standard_name: string;
2221
+ symbol: string;
2222
+ }
2223
+ export interface InsightTopStocksResponse {
2224
+ count: number;
2225
+ details: InsightTopStocksEntry[];
2226
+ }
2227
+ export interface InsightTransaction {
2228
+ amount: number;
2229
+ date: string;
2230
+ expert_picture_url: string;
2231
+ expert_uid: string;
2232
+ insider_name: string;
2233
+ number_of_shares: number;
2234
+ position: string;
2235
+ stars: string;
2236
+ transaction: string;
2237
+ }
2238
+ export interface InsightTrendingStocksRequest {
2239
+ /** "Include ratings of analysts and/or bloggers" Enums(analysts, bloggers) */
2240
+ filter?: string;
2241
+ /** "Return the most trending X stocks" */
2242
+ num?: number;
2243
+ /** "Trending over the last X days" Enums(3, 7, 30, 90) */
2244
+ period?: number;
2245
+ /** Type of quote to load Enums(nbbo, delayed, cboe, bats, realtime, realtime_snapshot) (REQUIRED) */
2246
+ quote_access_type?: string;
2247
+ /** "Trend Type" Enums(most-rated, best-rated, worst-rated) */
2248
+ trending_type?: string;
2249
+ }
2250
+ export interface InsightTrendingStocksResponse {
2251
+ average_price_target: number;
2252
+ buy: number;
2253
+ consensus: string;
2254
+ hold: number;
2255
+ last_rating_date: string;
2256
+ market_cap: number;
2257
+ popularity: number;
2258
+ quote: InsightTiprankQuote;
2259
+ sector: string;
2260
+ sell: number;
2261
+ sentiment: number;
2262
+ ticker: string;
2263
+ }
2264
+ export interface InsightUnderwriteResponse {
2265
+ company_name: string;
2266
+ id: number;
2267
+ is_lead: boolean;
2268
+ title: string;
2269
+ }
2270
+ export interface InsightUpdateCustomIndexRequest {
2271
+ description?: string;
2272
+ equities?: string[];
2273
+ etfs?: string[];
2274
+ id?: string;
2275
+ name?: string;
2276
+ private_name?: string;
2277
+ }
2278
+ export interface InsightUsageDataEntry {
2279
+ branch_code: string;
2280
+ details: Record<string, number>;
2281
+ firm_id: number;
2282
+ total_count: number;
2283
+ }
2284
+ export interface InsightValuation {
2285
+ enterprise_multiple_ratio: number;
2286
+ enterprise_value_to_revenue_ratio: number;
2287
+ forward_price_to_earnings_ratio: number;
2288
+ price_to_book_ratio: number;
2289
+ price_to_earnings_to_growth_ratio: number;
2290
+ price_to_free_cash_flow_ratio: number;
2291
+ price_to_sales_ratio: number;
2292
+ trailing_price_to_earnings_ratio: number;
2293
+ }
2294
+ export interface InsightYearlyData {
2295
+ benchmark_average: number;
2296
+ date: number;
2297
+ difference: number;
2298
+ value: number;
2299
+ year: number;
2300
+ }
2301
+ export interface InsightYearlyInsiderTransaction {
2302
+ discretionaryBuyAmount: number;
2303
+ discretionaryBuyCount: number;
2304
+ discretionarySellAmount: number;
2305
+ discretionarySellCount: number;
2306
+ month: number;
2307
+ year: number;
2308
+ }
2309
+ export interface InsightYearlyPerformance {
2310
+ performance: number;
2311
+ year: number;
2312
+ }
2313
+ export interface InsightEquityDataResponse {
2314
+ ask_px: number;
2315
+ ask_sz: number;
2316
+ avg_vol30d: number;
2317
+ bid_px: number;
2318
+ bid_sz: number;
2319
+ closing_px: number;
2320
+ column: number;
2321
+ com_shrs_out: number;
2322
+ comp_desc: string;
2323
+ comp_name: string;
2324
+ condition: number;
2325
+ div_amt: number;
2326
+ div_date_ex: string;
2327
+ div_yield: number;
2328
+ high52w_px: number;
2329
+ high_px: number;
2330
+ info_time: string;
2331
+ issue_market: string;
2332
+ issure_market: string;
2333
+ last_px: number;
2334
+ low52w_px: number;
2335
+ low_px: number;
2336
+ mkt_cap: number;
2337
+ open_px: number;
2338
+ pay_date: string;
2339
+ pe_ratio: number;
2340
+ post_ask_px: number;
2341
+ post_ask_sz: number;
2342
+ post_bid_px: number;
2343
+ post_bid_sz: number;
2344
+ post_last_px: number;
2345
+ post_quote_time: string;
2346
+ post_trade_time: string;
2347
+ pre_ask_px: number;
2348
+ pre_ask_sz: number;
2349
+ pre_bid_px: number;
2350
+ pre_bid_sz: number;
2351
+ pre_last_px: number;
2352
+ pre_quote_time: string;
2353
+ pre_trade_time: string;
2354
+ quote_time: string;
2355
+ symbol: string;
2356
+ trade_px: number;
2357
+ trade_region: string;
2358
+ trade_sz: number;
2359
+ trade_time: string;
2360
+ volume: number;
2361
+ yest_close_px: number;
2362
+ }
2363
+ export enum InsightArticlesRequestTypeEnum {
2364
+ Education = "education",
2365
+ NonEducation = "non-education"
2366
+ }
2367
+ export enum InsightCryptoLogoConvertedRequestConversionEnum {
2368
+ Original = "original",
2369
+ Default = "default",
2370
+ Normal = "normal",
2371
+ Thumbnail = "thumbnail",
2372
+ Square = "square",
2373
+ SquareStrict = "square_strict",
2374
+ SquareStrictOrNormal = "square_strict_or_normal",
2375
+ BestMatch = "best_match"
2376
+ }
2377
+ export enum InsightMostPopularTagsRequestTimeEnum {
2378
+ Week = "week",
2379
+ Month = "month",
2380
+ Year = "year"
2381
+ }
2382
+ /** (REQUIRE) */
2383
+ export enum InsightMostPopularTagsRequestTypeEnum {
2384
+ Symbol = "symbol",
2385
+ Primary = "primary",
2386
+ Tags = "tags"
2387
+ }
2388
+ export enum InsightNewsfeedRequestTypeEnum {
2389
+ Education = "education",
2390
+ NonEducation = "non-education"
2391
+ }
2392
+ /** @default "asc" */
2393
+ export enum InsightOrderingDirectionEnum {
2394
+ Asc = "asc",
2395
+ Desc = "desc"
2396
+ }
2397
+ export enum InsightPeriodFilterTypeEnum {
2398
+ Day = "day",
2399
+ Week = "week",
2400
+ Month = "month",
2401
+ Year = "year"
2402
+ }
2403
+ export enum InsightSearchArticleRequestTypeEnum {
2404
+ All = "all",
2405
+ Tag = "tag",
2406
+ Primary = "primary",
2407
+ Symbol = "symbol"
2408
+ }
2409
+ export enum InsightSymbolLogoConvertedRequestConversionEnum {
2410
+ Original = "original",
2411
+ Default = "default",
2412
+ Normal = "normal",
2413
+ Thumbnail = "thumbnail",
2414
+ Square = "square",
2415
+ SquareStrict = "square_strict",
2416
+ SquareStrictOrNormal = "square_strict_or_normal",
2417
+ BestMatch = "best_match"
2418
+ }
2419
+ /** Level of detail on updated stocks */
2420
+ export enum InsightTiprankGeneralStockUpdatesParamsDetailsEnum {
2421
+ None = "none",
2422
+ Full = "full"
2423
+ }
2424
+ /** The order of the latest insider transactions */
2425
+ export enum InsightTiprankHedgefundsRecentTransactionsParamsSortEnum {
2426
+ Value = "value",
2427
+ Rank = "rank"
2428
+ }
2429
+ /** The order of the latest insider transactions */
2430
+ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
2431
+ Date = "date",
2432
+ Rank = "rank"
2433
+ }
2434
+ export class CompanyProfile<HandleError extends boolean = boolean> {
2435
+ protected readonly apiClient: JwtClient<HandleError>;
2436
+ constructor(apiClient: JwtClient<HandleError>);
2437
+ /**
2438
+ * @description get company profile, industries classification and closest earning release
2439
+ * @tags CompanyProfile
2440
+ * @name GetCompanyProfile
2441
+ * @summary get company profile
2442
+ * @request GET:/company-profile
2443
+ * @secure
2444
+ */
2445
+ getCompanyProfile(query: {
2446
+ /** Company symbol */
2447
+ symbol: string;
2448
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError>>;
2449
+ /**
2450
+ * @description get combined profile, equities and funds
2451
+ * @tags CompanyProfile
2452
+ * @name GetCombinedProfile
2453
+ * @summary get company profile
2454
+ * @request GET:/quote-profile
2455
+ * @secure
2456
+ */
2457
+ getCombinedProfile(query: {
2458
+ /** Company symbol */
2459
+ symbol: string;
2460
+ /** Desired symbol type - [ANY,FUND,EQUITY] */
2461
+ symbol_type?: string;
2462
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombainedProfileResponse, HandleError>>;
2463
+ /**
2464
+ * @description sort input array of symbols by type
2465
+ * @tags CompanyProfile
2466
+ * @name GetSymbolsPerSymbolType
2467
+ * @summary sort input array of symbols by type
2468
+ * @request POST:/symbols-per-type
2469
+ * @secure
2470
+ */
2471
+ getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
2472
+ }
2473
+ export class WorldMarkets<HandleError extends boolean = boolean> {
2474
+ protected readonly apiClient: JwtClient<HandleError>;
2475
+ constructor(apiClient: JwtClient<HandleError>);
2476
+ /**
2477
+ * @description Get continents
2478
+ * @tags World Markets
2479
+ * @name ContinentGet
2480
+ * @summary Get continents
2481
+ * @request GET:/continents
2482
+ * @secure
2483
+ */
2484
+ continentGet(query: {
2485
+ /** Query limit */
2486
+ limit: number;
2487
+ /** Query offset */
2488
+ offset: number;
2489
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
2490
+ /**
2491
+ * @description Edit continent
2492
+ * @tags World Markets
2493
+ * @name ContinentEdit
2494
+ * @summary Edit continent
2495
+ * @request PUT:/continents
2496
+ * @secure
2497
+ */
2498
+ continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2499
+ /**
2500
+ * @description Create continents
2501
+ * @tags World Markets
2502
+ * @name ContinentCreate
2503
+ * @summary Create continents
2504
+ * @request POST:/continents
2505
+ * @secure
2506
+ */
2507
+ continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
2508
+ /**
2509
+ * @description Delete continent
2510
+ * @tags World Markets
2511
+ * @name ContinentDelete
2512
+ * @summary Delete continent
2513
+ * @request DELETE:/continents
2514
+ * @secure
2515
+ */
2516
+ continentDelete(query: {
2517
+ /** continent id */
2518
+ id: string;
2519
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2520
+ /**
2521
+ * @description Get country codes
2522
+ * @tags World Markets
2523
+ * @name CountryCodeGet
2524
+ * @summary Get country codes
2525
+ * @request GET:/country-codes
2526
+ * @secure
2527
+ */
2528
+ countryCodeGet(query: {
2529
+ /** Query limit */
2530
+ limit: number;
2531
+ /** Query offset */
2532
+ offset: number;
2533
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
2534
+ /**
2535
+ * @description Edit country code
2536
+ * @tags World Markets
2537
+ * @name CountryCodeEdit
2538
+ * @summary Edit country code
2539
+ * @request PUT:/country-codes
2540
+ * @secure
2541
+ */
2542
+ countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2543
+ /**
2544
+ * @description Add country codes
2545
+ * @tags World Markets
2546
+ * @name CountryCodeAdd
2547
+ * @summary Add country codes
2548
+ * @request POST:/country-codes
2549
+ * @secure
2550
+ */
2551
+ countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
2552
+ /**
2553
+ * @description Delete country code
2554
+ * @tags World Markets
2555
+ * @name CountryCodeDelete
2556
+ * @summary Delete country code
2557
+ * @request DELETE:/country-codes
2558
+ * @secure
2559
+ */
2560
+ countryCodeDelete(query: {
2561
+ /** a3 code */
2562
+ a3code: string;
2563
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2564
+ /**
2565
+ * @description Get global indexes
2566
+ * @tags World Markets
2567
+ * @name GlobalIndexGet
2568
+ * @summary Get global indexes
2569
+ * @request GET:/global-indexes
2570
+ * @secure
2571
+ */
2572
+ globalIndexGet(query: {
2573
+ /** Query limit */
2574
+ limit: number;
2575
+ /** Query offset */
2576
+ offset: number;
2577
+ /** Continent code for filtering */
2578
+ continent?: string;
2579
+ /** Quote type for price fetch */
2580
+ quote_access_type?: string;
2581
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
2582
+ /**
2583
+ * @description Edit global index
2584
+ * @tags World Markets
2585
+ * @name GlobalIndexEdit
2586
+ * @summary Edit global index
2587
+ * @request PUT:/global-indexes
2588
+ * @secure
2589
+ */
2590
+ globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2591
+ /**
2592
+ * @description Add global indexes
2593
+ * @tags World Markets
2594
+ * @name GlobalIndexAdd
2595
+ * @summary Add global indexes
2596
+ * @request POST:/global-indexes
2597
+ * @secure
2598
+ */
2599
+ globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
2600
+ /**
2601
+ * @description Edit global index
2602
+ * @tags World Markets
2603
+ * @name GlobalIndexDelete
2604
+ * @summary Delete global index
2605
+ * @request DELETE:/global-indexes
2606
+ * @secure
2607
+ */
2608
+ globalIndexDelete(query: {
2609
+ /** a3 code */
2610
+ a3code: string;
2611
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2612
+ /**
2613
+ * @description Get regions
2614
+ * @tags World Markets
2615
+ * @name RegionGet
2616
+ * @summary Get regions
2617
+ * @request GET:/regions
2618
+ * @secure
2619
+ */
2620
+ regionGet(query: {
2621
+ /** Query limit */
2622
+ limit: number;
2623
+ /** Query offset */
2624
+ offset: number;
2625
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
2626
+ /**
2627
+ * @description Edit region
2628
+ * @tags World Markets
2629
+ * @name RegionEdit
2630
+ * @summary Edit region
2631
+ * @request PUT:/regions
2632
+ * @secure
2633
+ */
2634
+ regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2635
+ /**
2636
+ * @description Create regions
2637
+ * @tags World Markets
2638
+ * @name RegionCreate
2639
+ * @summary Create regions
2640
+ * @request POST:/regions
2641
+ * @secure
2642
+ */
2643
+ regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
2644
+ /**
2645
+ * @description Delete region
2646
+ * @tags World Markets
2647
+ * @name RegionDelete
2648
+ * @summary Delete region
2649
+ * @request DELETE:/regions
2650
+ * @secure
2651
+ */
2652
+ regionDelete(query: {
2653
+ /** region id */
2654
+ id: string;
2655
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2656
+ }
2657
+ export class CustomLists<HandleError extends boolean = boolean> {
2658
+ protected readonly apiClient: JwtClient<HandleError>;
2659
+ constructor(apiClient: JwtClient<HandleError>);
2660
+ /**
2661
+ * @description get custom lists
2662
+ * @tags Custom Lists
2663
+ * @name GetCustomLists
2664
+ * @summary get custom lists
2665
+ * @request GET:/custom-lists
2666
+ * @secure
2667
+ */
2668
+ getCustomLists(query: {
2669
+ /** how many records to return. Max value is 50 */
2670
+ limit: number;
2671
+ /** how many records to skip */
2672
+ offset: number;
2673
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
2674
+ /**
2675
+ * @description update custom list
2676
+ * @tags Custom Lists
2677
+ * @name UpdateCustomList
2678
+ * @summary update custom list
2679
+ * @request PUT:/custom-lists
2680
+ * @secure
2681
+ */
2682
+ updateCustomList(filter: InsightUpdateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
2683
+ /**
2684
+ * @description create custom list
2685
+ * @tags Custom Lists
2686
+ * @name CreateCustomList
2687
+ * @summary create custom list
2688
+ * @request POST:/custom-lists
2689
+ * @secure
2690
+ */
2691
+ createCustomList(filter: InsightCreateCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCustomIndex, HandleError>>;
2692
+ /**
2693
+ * @description remove custom list
2694
+ * @tags Custom Lists
2695
+ * @name RemoveCustomList
2696
+ * @summary remove custom list
2697
+ * @request DELETE:/custom-lists
2698
+ * @secure
2699
+ */
2700
+ removeCustomList(filter: InsightRemoveCustomIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2701
+ /**
2702
+ * @description get custom list
2703
+ * @tags Custom Lists
2704
+ * @name GetCustomList
2705
+ * @summary get custom list
2706
+ * @request GET:/custom-lists/:id
2707
+ * @secure
2708
+ */
2709
+ getCustomList(id: string, query: {
2710
+ /** sort direction - asc or desc */
2711
+ order_direction: string;
2712
+ /** sort field - volume, symbol(alphabetical), market_cap, dividend_percent */
2713
+ order_field: string;
2714
+ /** how many equities records to return. Max value is 50 */
2715
+ limit: number;
2716
+ /** how many equities records to skip */
2717
+ offset: number;
2718
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
2719
+ }
2720
+ export class Lists<HandleError extends boolean = boolean> {
2721
+ protected readonly apiClient: JwtClient<HandleError>;
2722
+ constructor(apiClient: JwtClient<HandleError>);
2723
+ /**
2724
+ * @description filter custom lists
2725
+ * @tags lists
2726
+ * @name FilterCustomLists
2727
+ * @summary filter custom lists
2728
+ * @request POST:/custom-lists/filter
2729
+ * @secure
2730
+ */
2731
+ filterCustomLists(filter: InsightFilterCustomIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetCustomIndexesResponse, HandleError>>;
2732
+ }
2733
+ export class Dashboard<HandleError extends boolean = boolean> {
2734
+ protected readonly apiClient: JwtClient<HandleError>;
2735
+ constructor(apiClient: JwtClient<HandleError>);
2736
+ /**
2737
+ * @description get ownerships by symbol
2738
+ * @tags Dashboard
2739
+ * @name DashboardGetOwnershipsBySymbol
2740
+ * @summary get ownerships by symbol
2741
+ * @request POST:/dashboard/ownerships
2742
+ * @secure
2743
+ */
2744
+ dashboardGetOwnershipsBySymbol(filter: InsightGetOwnershipsBySymbolRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolAsDashboardFieldsResponse, HandleError>>;
2745
+ /**
2746
+ * @description rewrite field value
2747
+ * @tags Dashboard
2748
+ * @name RewriteFieldValue
2749
+ * @summary rewrite field value
2750
+ * @request POST:/rewrite-field
2751
+ * @secure
2752
+ */
2753
+ rewriteFieldValue(input: InsightRewriteFieldValueRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2754
+ /**
2755
+ * @description remove rewritten value
2756
+ * @tags Dashboard
2757
+ * @name CreateRewriteField
2758
+ * @summary remove rewritten value
2759
+ * @request DELETE:/rewrite-field
2760
+ * @secure
2761
+ */
2762
+ createRewriteField(input: InsightRemoveRewrittenFieldValueRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2763
+ /**
2764
+ * @description Get rewritten field action log
2765
+ * @tags Dashboard
2766
+ * @name GetRewrittenFieldActionLog
2767
+ * @summary get rewritten field action log
2768
+ * @request GET:/rewritten-field-action-log
2769
+ * @secure
2770
+ */
2771
+ getRewrittenFieldActionLog(query: {
2772
+ /** Internal UUID */
2773
+ internal_id: string;
2774
+ /** Field ID */
2775
+ field_id: string;
2776
+ /** how many records to return. Max value is 50 */
2777
+ limit: number;
2778
+ /** how many records to skip */
2779
+ offset: number;
2780
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2781
+ /**
2782
+ * @description Get rewritten values
2783
+ * @tags Dashboard
2784
+ * @name GetRewrittenValues
2785
+ * @summary get rewritten values
2786
+ * @request GET:/rewritten-fields
2787
+ * @secure
2788
+ */
2789
+ getRewrittenValues(query: {
2790
+ /** how many records to return. Max value is 50 */
2791
+ limit: number;
2792
+ /** how many records to skip */
2793
+ offset: number;
2794
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2795
+ /**
2796
+ * @description get symbol-related fields
2797
+ * @tags Dashboard
2798
+ * @name GetSymbolRelatedFields
2799
+ * @summary get symbol-related fields
2800
+ * @request GET:/symbol-related-fields
2801
+ * @secure
2802
+ */
2803
+ getSymbolRelatedFields(query: {
2804
+ /** Symbol */
2805
+ symbol: string;
2806
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolRelatedFieldsResponse, HandleError>>;
2807
+ }
2808
+ export class Earnings<HandleError extends boolean = boolean> {
2809
+ protected readonly apiClient: JwtClient<HandleError>;
2810
+ constructor(apiClient: JwtClient<HandleError>);
2811
+ /**
2812
+ * @description get earnings release dates for symbols
2813
+ * @tags Earnings
2814
+ * @name GetEarningsCalendar
2815
+ * @summary get earnings calendar data
2816
+ * @request POST:/earnings-calendar
2817
+ * @secure
2818
+ */
2819
+ getEarningsCalendar(filter: InsightEarningReleasesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEarningReleasesResponse, HandleError>>;
2820
+ }
2821
+ export class FixedIncome<HandleError extends boolean = boolean> {
2822
+ protected readonly apiClient: JwtClient<HandleError>;
2823
+ constructor(apiClient: JwtClient<HandleError>);
2824
+ /**
2825
+ * @description get fixed income entries
2826
+ * @tags FixedIncome
2827
+ * @name GetFixedIncomeEntries
2828
+ * @summary get fixed income entries
2829
+ * @request POST:/fixed-income
2830
+ * @secure
2831
+ */
2832
+ getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponse, HandleError>>;
2833
+ /**
2834
+ * @description Returns historical fixed income
2835
+ * @tags FixedIncome
2836
+ * @name FixedIncomeHistorical
2837
+ * @summary Get historical fixed income
2838
+ * @request POST:/fixed-income/historical
2839
+ * @secure
2840
+ */
2841
+ fixedIncomeHistorical(filter: InsightGetFixedIncomeHistoricalRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeHistoricalResponse, HandleError>>;
2842
+ /**
2843
+ * @description get fixed-income presets
2844
+ * @tags FixedIncome
2845
+ * @name GetFixedIncomePresets
2846
+ * @summary get fixed-income presets
2847
+ * @request GET:/fixed-income/presets
2848
+ * @secure
2849
+ */
2850
+ getFixedIncomePresets(query: {
2851
+ /** how many records to return */
2852
+ limit: number;
2853
+ /** how many records to skip */
2854
+ offset: number;
2855
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
2856
+ /**
2857
+ * @description update fixed-income preset
2858
+ * @tags FixedIncome
2859
+ * @name UpdateFixedIncomePreset
2860
+ * @summary update fixed-income preset
2861
+ * @request PUT:/fixed-income/presets
2862
+ * @secure
2863
+ */
2864
+ updateFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncomePreset, HandleError>>;
2865
+ /**
2866
+ * @description create fixed-income preset
2867
+ * @tags FixedIncome
2868
+ * @name CreateOrFixedIncomePreset
2869
+ * @summary create fixed-income preset
2870
+ * @request POST:/fixed-income/presets
2871
+ * @secure
2872
+ */
2873
+ createOrFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncomePreset, HandleError>>;
2874
+ /**
2875
+ * @description remove fixed-income preset
2876
+ * @tags FixedIncome
2877
+ * @name RemoveFixedIncomePreset
2878
+ * @summary remove fixed-income preset
2879
+ * @request DELETE:/fixed-income/presets
2880
+ * @secure
2881
+ */
2882
+ removeFixedIncomePreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
2883
+ /**
2884
+ * @description get single fixed income entry
2885
+ * @tags FixedIncome
2886
+ * @name GetSingleFixedIncomeEntry
2887
+ * @summary get single fixed income entry
2888
+ * @request GET:/fixed-income/{id}
2889
+ * @secure
2890
+ */
2891
+ getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
2892
+ }
2893
+ export class Fundamentals<HandleError extends boolean = boolean> {
2894
+ protected readonly apiClient: JwtClient<HandleError>;
2895
+ constructor(apiClient: JwtClient<HandleError>);
2896
+ /**
2897
+ * @description get fundamentals by symbol data
2898
+ * @tags Fundamentals
2899
+ * @name GetFundamentalsBySymbolData
2900
+ * @summary get fundamentals by symbol data
2901
+ * @request POST:/fundamentals
2902
+ * @secure
2903
+ */
2904
+ getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsResponse, HandleError>>;
2905
+ }
2906
+ export class Funds<HandleError extends boolean = boolean> {
2907
+ protected readonly apiClient: JwtClient<HandleError>;
2908
+ constructor(apiClient: JwtClient<HandleError>);
2909
+ /**
2910
+ * @description get fund details
2911
+ * @tags Funds
2912
+ * @name GetFundDetails
2913
+ * @summary get fund details
2914
+ * @request GET:/funds/details
2915
+ * @secure
2916
+ */
2917
+ getFundDetails(query: {
2918
+ /** Fund symbol */
2919
+ symbol: string;
2920
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundDetailsResponse, HandleError>>;
2921
+ /**
2922
+ * @description get funds for holding
2923
+ * @tags Funds
2924
+ * @name GetFundsForHolding
2925
+ * @summary get funds for holding
2926
+ * @request POST:/funds/funds-for-holding
2927
+ * @secure
2928
+ */
2929
+ getFundsForHolding(filter: InsightGetFundsForHoldingRequest, headers?: {
2930
+ /** Authorization */
2931
+ Authorization?: string;
2932
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundsForHoldingResponse, HandleError>>;
2933
+ /**
2934
+ * @description filter funds by params
2935
+ * @tags Funds
2936
+ * @name FundScreener
2937
+ * @summary filter funds by params
2938
+ * @request POST:/funds/screener
2939
+ * @secure
2940
+ */
2941
+ fundScreener(filter: InsightFundScreenerRequest, headers?: {
2942
+ /** Authorization */
2943
+ Authorization?: string;
2944
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
2945
+ /**
2946
+ * @description get fund screener filters
2947
+ * @tags Funds
2948
+ * @name GetScreenerFilters
2949
+ * @summary get fund screener filters
2950
+ * @request GET:/funds/screener/filters
2951
+ * @secure
2952
+ */
2953
+ getScreenerFilters(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundScreenerFiltersResponse, HandleError>>;
2954
+ /**
2955
+ * @description filter funds by params
2956
+ * @tags Funds
2957
+ * @name FundSectorScreener
2958
+ * @summary filter funds by params
2959
+ * @request POST:/funds/sector-screener
2960
+ * @secure
2961
+ */
2962
+ fundSectorScreener(filter: InsightFundSectorScreenerRequest, headers?: {
2963
+ /** Authorization */
2964
+ Authorization?: string;
2965
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
2966
+ /**
2967
+ * @description get top funds
2968
+ * @tags Funds
2969
+ * @name GetTopFunds
2970
+ * @summary get top funds
2971
+ * @request POST:/funds/top
2972
+ * @secure
2973
+ */
2974
+ getTopFunds(filter: InsightGetTopFundsRequest, headers?: {
2975
+ /** Authorization */
2976
+ Authorization?: string;
2977
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
2978
+ }
2979
+ export class StockScreener<HandleError extends boolean = boolean> {
2980
+ protected readonly apiClient: JwtClient<HandleError>;
2981
+ constructor(apiClient: JwtClient<HandleError>);
2982
+ /**
2983
+ * @description data for visual heat map
2984
+ * @tags StockScreener
2985
+ * @name StockMarketHeatmap
2986
+ * @summary data for visual heat map
2987
+ * @request GET:/heatmaps
2988
+ * @secure
2989
+ */
2990
+ stockMarketHeatmap(query: {
2991
+ /** Name of symbol list to fetch details for. Empty is default */
2992
+ heatmap_name?: string;
2993
+ /** NBBO || DELAYED || CBOE || CBOE1 || BATS || REALTIME || REALTIME_SNAPSHOT */
2994
+ quote_access_type: string;
2995
+ }, headers?: {
2996
+ /** Authorization */
2997
+ Authorization?: string;
2998
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
2999
+ /**
3000
+ * @description create or update heat map preset
3001
+ * @tags StockScreener
3002
+ * @name CreateStockMarketHeatmapPreset
3003
+ * @summary create or update heat map preset
3004
+ * @request POST:/heatmaps
3005
+ * @secure
3006
+ */
3007
+ createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3008
+ /**
3009
+ * @description Sector and Industry Group performance
3010
+ * @tags StockScreener
3011
+ * @name IndustriesPerformance
3012
+ * @summary get industries performance
3013
+ * @request POST:/industries-performance
3014
+ * @secure
3015
+ */
3016
+ industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
3017
+ /**
3018
+ * @description filter stocks by params
3019
+ * @tags StockScreener
3020
+ * @name StockScreener
3021
+ * @summary filter stocks by params
3022
+ * @request POST:/stock-screener
3023
+ * @secure
3024
+ */
3025
+ stockScreener(filter: InsightStockScreenerRequest, headers?: {
3026
+ /** Authorization */
3027
+ Authorization?: string;
3028
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
3029
+ /**
3030
+ * @description get screener presets
3031
+ * @tags StockScreener
3032
+ * @name GetScreenerPresets
3033
+ * @summary get screener presets
3034
+ * @request GET:/stock-screener/presets
3035
+ * @secure
3036
+ */
3037
+ getScreenerPresets(query: {
3038
+ /** how many records to return */
3039
+ limit: number;
3040
+ /** how many records to skip */
3041
+ offset: number;
3042
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
3043
+ /**
3044
+ * @description update screener preset
3045
+ * @tags StockScreener
3046
+ * @name UpdateScreenerPreset
3047
+ * @summary update screener preset
3048
+ * @request PUT:/stock-screener/presets
3049
+ * @secure
3050
+ */
3051
+ updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
3052
+ /**
3053
+ * @description create screener preset
3054
+ * @tags StockScreener
3055
+ * @name CreateOrScreenerPreset
3056
+ * @summary create screener preset
3057
+ * @request POST:/stock-screener/presets
3058
+ * @secure
3059
+ */
3060
+ createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
3061
+ /**
3062
+ * @description remove screener preset
3063
+ * @tags StockScreener
3064
+ * @name RemoveScreenerPreset
3065
+ * @summary remove screener preset
3066
+ * @request DELETE:/stock-screener/presets
3067
+ * @secure
3068
+ */
3069
+ removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
3070
+ /**
3071
+ * @description get top symbols
3072
+ * @tags StockScreener
3073
+ * @name GetTopSymbols
3074
+ * @summary get top symbols
3075
+ * @request POST:/stock-screener/top
3076
+ * @secure
3077
+ */
3078
+ getTopSymbols(input: InsightGetTopSymbolsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
3079
+ }
3080
+ export class Quotes<HandleError extends boolean = boolean> {
3081
+ protected readonly apiClient: JwtClient<HandleError>;
3082
+ constructor(apiClient: JwtClient<HandleError>);
3083
+ /**
3084
+ * @description Get single historical quote
3085
+ * @tags Quotes
3086
+ * @name GitHistoricalQuote
3087
+ * @summary Get single historical quote
3088
+ * @request GET:/historical/quote
3089
+ * @secure
3090
+ */
3091
+ gitHistoricalQuote(query: {
3092
+ /** Symbol */
3093
+ symbol: string;
3094
+ /** Date */
3095
+ date: string;
3096
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
3097
+ /**
3098
+ * @description get quote history by symbol
3099
+ * @tags Quotes
3100
+ * @name GitQuoteHistory
3101
+ * @summary Get quote history
3102
+ * @request POST:/quote-history
3103
+ * @secure
3104
+ */
3105
+ gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
3106
+ /**
3107
+ * @description Returns a list of quotes equity info for specified symbols.
3108
+ * @tags Quotes
3109
+ * @name GetQuotesEquityData
3110
+ * @summary Get Quotes Equity data
3111
+ * @request GET:/quotes/equity
3112
+ * @secure
3113
+ */
3114
+ getQuotesEquityData(query: {
3115
+ /** Comma separated symbols */
3116
+ symbols: string;
3117
+ /** NBBO || DELAYED || CBOE || CBOE1 || BATS || REALTIME || REALTIME_SNAPSHOT */
3118
+ quote_access_type: string;
3119
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
3120
+ }
3121
+ export class Intraday<HandleError extends boolean = boolean> {
3122
+ protected readonly apiClient: JwtClient<HandleError>;
3123
+ constructor(apiClient: JwtClient<HandleError>);
3124
+ /**
3125
+ * @description Returns an array of intraday chart data values for the given ticker.
3126
+ * @tags Intraday
3127
+ * @name IntradayQuotes
3128
+ * @summary Get an array of intraday chart data values for the given ticker
3129
+ * @request POST:/intraday/quotes
3130
+ * @secure
3131
+ */
3132
+ intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
3133
+ }
3134
+ export class Ipos<HandleError extends boolean = boolean> {
3135
+ protected readonly apiClient: JwtClient<HandleError>;
3136
+ constructor(apiClient: JwtClient<HandleError>);
3137
+ /**
3138
+ * @description get recent ipos info
3139
+ * @tags Ipos
3140
+ * @name PostRecent
3141
+ * @summary get recent ipos info
3142
+ * @request POST:/ipos/recent
3143
+ * @secure
3144
+ */
3145
+ postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
3146
+ /**
3147
+ * @description get upcoming ipos info
3148
+ * @tags Ipos
3149
+ * @name GetUpcoming
3150
+ * @summary get upcoming ipos info
3151
+ * @request GET:/ipos/upcoming
3152
+ * @secure
3153
+ */
3154
+ getUpcoming(query: {
3155
+ /** how many records to return. Max value is 50 */
3156
+ limit: number;
3157
+ /** how many records to skip */
3158
+ offset: number;
3159
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
3160
+ }
3161
+ export class Logos<HandleError extends boolean = boolean> {
3162
+ protected readonly apiClient: JwtClient<HandleError>;
3163
+ constructor(apiClient: JwtClient<HandleError>);
3164
+ /**
3165
+ * @description Returns converted logo for crypto symbol
3166
+ * @tags Logos
3167
+ * @name LogosConvertedCryptoSymbolLogo
3168
+ * @summary Get converted logo for crypto symbol
3169
+ * @request POST:/logos/converted-crypto-symbol-logo
3170
+ * @secure
3171
+ */
3172
+ logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
3173
+ /**
3174
+ * @description Returns converted logo for symbol
3175
+ * @tags Logos
3176
+ * @name LogosConvertedSymbolLogo
3177
+ * @summary Get converted logo for symbol
3178
+ * @request POST:/logos/converted-symbol-logo
3179
+ * @secure
3180
+ */
3181
+ logosConvertedSymbolLogo(filter: InsightSymbolLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
3182
+ /**
3183
+ * @description Returns logo for crypto symbol
3184
+ * @tags Logos
3185
+ * @name LogosCryptoSymbolLogo
3186
+ * @summary Get logo for crypto symbol
3187
+ * @request GET:/logos/crypto-symbol-logo
3188
+ * @secure
3189
+ */
3190
+ logosCryptoSymbolLogo(query: {
3191
+ /** Company symbol */
3192
+ symbol: string;
3193
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError>>;
3194
+ /**
3195
+ * @description Returns direct logo for crypto symbol
3196
+ * @tags Logos
3197
+ * @name LogosDirectCryptoSymbolLogo
3198
+ * @summary Get direct logo for crypto symbol
3199
+ * @request GET:/logos/direct-crypto-symbol-logo
3200
+ * @secure
3201
+ */
3202
+ logosDirectCryptoSymbolLogo(query: {
3203
+ /** Company symbol */
3204
+ symbol: string;
3205
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
3206
+ /**
3207
+ * @description Returns direct logo for symbol
3208
+ * @tags Logos
3209
+ * @name LogosDirectSymbolLogo
3210
+ * @summary Get direct logo for symbol
3211
+ * @request GET:/logos/direct-symbol-logo
3212
+ * @secure
3213
+ */
3214
+ logosDirectSymbolLogo(query: {
3215
+ /** Company symbol */
3216
+ symbol: string;
3217
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
3218
+ /**
3219
+ * @description Returns logos for multiple symbols
3220
+ * @tags Logos
3221
+ * @name LogosMultipleCryptoSymbolLogo
3222
+ * @summary Get logos for multiple symbols
3223
+ * @request POST:/logos/multiple-crypto-symbol-logo
3224
+ * @secure
3225
+ */
3226
+ logosMultipleCryptoSymbolLogo(filter: InsightMultipleCryptoLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse[], HandleError>>;
3227
+ /**
3228
+ * @description Returns logos for multiple symbol
3229
+ * @tags Logos
3230
+ * @name LogosMultipleSymbolLogos
3231
+ * @summary Get logos for multiple symbols
3232
+ * @request POST:/logos/multiple-symbol-logos
3233
+ * @secure
3234
+ */
3235
+ logosMultipleSymbolLogos(filter: InsightMultipleSymbolLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse[], HandleError>>;
3236
+ /**
3237
+ * @description Returns links of socials logos for symbol
3238
+ * @tags Logos
3239
+ * @name LogosSocialSymbolLogos
3240
+ * @summary Get social logos for symbol
3241
+ * @request GET:/logos/social-symbol-logos
3242
+ * @secure
3243
+ */
3244
+ logosSocialSymbolLogos(query: {
3245
+ /** Company symbol */
3246
+ symbol: string;
3247
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
3248
+ /**
3249
+ * @description Returns logos for company symbol
3250
+ * @tags Logos
3251
+ * @name LogosSymbolLogos
3252
+ * @summary Get symbol logos
3253
+ * @request GET:/logos/symbol-logos
3254
+ * @secure
3255
+ */
3256
+ logosSymbolLogos(query: {
3257
+ /** Company symbol */
3258
+ symbol: string;
3259
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
3260
+ }
3261
+ export class MarketDates<HandleError extends boolean = boolean> {
3262
+ protected readonly apiClient: JwtClient<HandleError>;
3263
+ constructor(apiClient: JwtClient<HandleError>);
3264
+ /**
3265
+ * @description get market dates history
3266
+ * @tags MarketDates
3267
+ * @name GetMarketDatesHistory
3268
+ * @summary get market dates history
3269
+ * @request POST:/market-dates/history
3270
+ * @secure
3271
+ */
3272
+ getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
3273
+ /**
3274
+ * @description get todays market hours
3275
+ * @tags MarketDates
3276
+ * @name GetTodaysMarketHours
3277
+ * @summary get todays market hours
3278
+ * @request GET:/market-dates/today
3279
+ * @secure
3280
+ */
3281
+ getTodaysMarketHours(query: {
3282
+ /** Market */
3283
+ market: string;
3284
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
3285
+ }
3286
+ export class News<HandleError extends boolean = boolean> {
3287
+ protected readonly apiClient: JwtClient<HandleError>;
3288
+ constructor(apiClient: JwtClient<HandleError>);
3289
+ /**
3290
+ * @description Returns available authors in DB
3291
+ * @tags News
3292
+ * @name NewsAvailableAuthors
3293
+ * @summary Get available authors in DB (for filters)
3294
+ * @request POST:/news/authors
3295
+ * @secure
3296
+ */
3297
+ newsAvailableAuthors(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
3298
+ /**
3299
+ * @description Returns available channels in DB
3300
+ * @tags News
3301
+ * @name NewsAvailableChannels
3302
+ * @summary Get available channels in DB (for filters)
3303
+ * @request POST:/news/channels
3304
+ * @secure
3305
+ */
3306
+ newsAvailableChannels(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
3307
+ /**
3308
+ * @description Returns news by filters
3309
+ * @tags News
3310
+ * @name NewsFiltered
3311
+ * @summary Get filtered news
3312
+ * @request POST:/news/filter
3313
+ * @secure
3314
+ */
3315
+ newsFiltered(filter: InsightNewsFilterRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsResponse, HandleError>>;
3316
+ /**
3317
+ * @description Returns news by id
3318
+ * @tags News
3319
+ * @name NewsById
3320
+ * @summary Get news by id
3321
+ * @request POST:/news/id
3322
+ * @secure
3323
+ */
3324
+ newsById(filter: InsightNewsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNews, HandleError>>;
3325
+ /**
3326
+ * @description Returns news previews
3327
+ * @tags News
3328
+ * @name NewsPreviewsFiltered
3329
+ * @summary Get news previews
3330
+ * @request GET:/news/previews
3331
+ * @secure
3332
+ */
3333
+ newsPreviewsFiltered(query: {
3334
+ /** Start date */
3335
+ start_date?: string;
3336
+ /** End date */
3337
+ end_date?: string;
3338
+ /** Symbol */
3339
+ symbol?: string;
3340
+ /** how many records to return. Max value is 50 */
3341
+ limit: number;
3342
+ /** how many records to skip */
3343
+ offset: number;
3344
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRecentNewsPreviewsResponse, HandleError>>;
3345
+ /**
3346
+ * @description Returns available stocks in DB
3347
+ * @tags News
3348
+ * @name NewsAvailableStocks
3349
+ * @summary Get available stocks in DB (for filters)
3350
+ * @request GET:/news/symbols
3351
+ * @secure
3352
+ */
3353
+ newsAvailableStocks(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
3354
+ /**
3355
+ * @description Returns available tags in DB
3356
+ * @tags News
3357
+ * @name NewsAvailableTags
3358
+ * @summary Get available tags in DB (for filters)
3359
+ * @request POST:/news/tags
3360
+ * @secure
3361
+ */
3362
+ newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
3363
+ }
3364
+ export class OptionGreeks<HandleError extends boolean = boolean> {
3365
+ protected readonly apiClient: JwtClient<HandleError>;
3366
+ constructor(apiClient: JwtClient<HandleError>);
3367
+ /**
3368
+ * @description Returns calculated matrix
3369
+ * @tags OptionGreeks
3370
+ * @name OgCalculateMatrix
3371
+ * @summary Calculate matrix
3372
+ * @request POST:/og/calculate-matrix
3373
+ * @secure
3374
+ */
3375
+ ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
3376
+ /**
3377
+ * @description Returns calculated params
3378
+ * @tags OptionGreeks
3379
+ * @name OgCalculateParams
3380
+ * @summary Calculate params
3381
+ * @request POST:/og/calculate-params
3382
+ * @secure
3383
+ */
3384
+ ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
3385
+ }
3386
+ export class Ownerships<HandleError extends boolean = boolean> {
3387
+ protected readonly apiClient: JwtClient<HandleError>;
3388
+ constructor(apiClient: JwtClient<HandleError>);
3389
+ /**
3390
+ * @description get ownerships by id datadata
3391
+ * @tags Ownerships
3392
+ * @name GetOwnershipsByIdData
3393
+ * @summary get ownerships by id data
3394
+ * @request POST:/ownerships
3395
+ * @secure
3396
+ */
3397
+ getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
3398
+ /**
3399
+ * @description get ownerships by symbol data
3400
+ * @tags Ownerships
3401
+ * @name GetOwnershipsBySymbolData
3402
+ * @summary get ownerships by symbol data
3403
+ * @request POST:/symbol-ownerships
3404
+ * @secure
3405
+ */
3406
+ getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
3407
+ }
3408
+ export class Passport<HandleError extends boolean = boolean> {
3409
+ protected readonly apiClient: JwtClient<HandleError>;
3410
+ constructor(apiClient: JwtClient<HandleError>);
3411
+ /**
3412
+ * @description Returns article by id
3413
+ * @tags Passport
3414
+ * @name PassportArticleById
3415
+ * @summary Get article by id
3416
+ * @request POST:/passport/article-by-id
3417
+ * @secure
3418
+ */
3419
+ passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
3420
+ /**
3421
+ * @description Returns articles
3422
+ * @tags Passport
3423
+ * @name PassportArticles
3424
+ * @summary Get articles
3425
+ * @request POST:/passport/articles
3426
+ * @secure
3427
+ */
3428
+ passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
3429
+ /**
3430
+ * @description Returns author profile
3431
+ * @tags Passport
3432
+ * @name PassportAuthorProfile
3433
+ * @summary Get author profile
3434
+ * @request POST:/passport/author-profile
3435
+ * @secure
3436
+ */
3437
+ passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
3438
+ /**
3439
+ * @description Returns most popular tags
3440
+ * @tags Passport
3441
+ * @name PassportMostPopularTags
3442
+ * @summary Get most popular tags
3443
+ * @request POST:/passport/most-popular-tags
3444
+ * @secure
3445
+ */
3446
+ passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
3447
+ /**
3448
+ * @description Returns news feed
3449
+ * @tags Passport
3450
+ * @name PassportNewsFeed
3451
+ * @summary Get news feed
3452
+ * @request POST:/passport/newsfeed
3453
+ * @secure
3454
+ */
3455
+ passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
3456
+ /**
3457
+ * @description Returns article by parameters
3458
+ * @tags Passport
3459
+ * @name PassportSearchArticle
3460
+ * @summary Search article by parameters
3461
+ * @request POST:/passport/search-article
3462
+ * @secure
3463
+ */
3464
+ passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
3465
+ }
3466
+ export class Public<HandleError extends boolean = boolean> {
3467
+ protected readonly apiClient: JwtClient<HandleError>;
3468
+ constructor(apiClient: JwtClient<HandleError>);
3469
+ /**
3470
+ * @description Calculate estimated returns for selected symbols. Uses split adjusted prices
3471
+ * @tags Public
3472
+ * @name CalculateEstimatedReturns
3473
+ * @summary Calculate Estimated Returns
3474
+ * @request GET:/public/estimated-returns
3475
+ * @secure
3476
+ */
3477
+ calculateEstimatedReturns(query: {
3478
+ /** Single symbol */
3479
+ symbol: string;
3480
+ /** Non-zero amount */
3481
+ amount: number;
3482
+ /** Start date for calculations */
3483
+ start_date: string;
3484
+ /** End date for calculations */
3485
+ end_date: string;
3486
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
3487
+ /**
3488
+ * @description Returns an expert forecast
3489
+ * @tags Public
3490
+ * @name ExpertForecast
3491
+ * @summary Expert forecast
3492
+ * @request GET:/public/expert-forecast
3493
+ * @secure
3494
+ */
3495
+ expertForecast(query: {
3496
+ /** Comma separated symbols */
3497
+ symbols: string;
3498
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
3499
+ /**
3500
+ * @description get fundamentals by symbol data
3501
+ * @tags Public
3502
+ * @name GetPublicFundamentalsBySymbolData
3503
+ * @summary get fundamentals by symbol data
3504
+ * @request GET:/public/fundamentals/:symbol
3505
+ * @secure
3506
+ */
3507
+ getPublicFundamentalsBySymbolData(symbol: string, query: {
3508
+ /** Annual or year */
3509
+ mode: string;
3510
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsResponse, HandleError>>;
3511
+ /**
3512
+ * @description Daily price history
3513
+ * @tags Public
3514
+ * @name DailyPriceHistory
3515
+ * @summary Daily price history
3516
+ * @request GET:/public/price-history/daily
3517
+ * @secure
3518
+ */
3519
+ dailyPriceHistory(query: {
3520
+ /** Single symbol */
3521
+ symbol: string;
3522
+ /** Target date */
3523
+ date: string;
3524
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
3525
+ /**
3526
+ * @description Public quote profile
3527
+ * @tags Public
3528
+ * @name PublicQuoteProfile
3529
+ * @summary Public quote profile
3530
+ * @request GET:/public/quote-profile/:symbol
3531
+ * @secure
3532
+ */
3533
+ publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
3534
+ /**
3535
+ * @description get ratios by symbol data
3536
+ * @tags Public
3537
+ * @name GetPublicRatiosBySymbolData
3538
+ * @summary get ratios by symbol data
3539
+ * @request GET:/public/ratios/:symbol
3540
+ * @secure
3541
+ */
3542
+ getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
3543
+ /**
3544
+ * @description find a symbol by name or description
3545
+ * @tags Public
3546
+ * @name QuoteFundamentalsSearch
3547
+ * @summary find a symbol by name or description
3548
+ * @request GET:/public/symbol-search
3549
+ * @secure
3550
+ */
3551
+ quoteFundamentalsSearch(query: {
3552
+ /** Search query */
3553
+ search_query: string;
3554
+ /** how many records to return. Max value is 50 */
3555
+ limit: number;
3556
+ /** how many records to skip */
3557
+ offset: number;
3558
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
3559
+ /**
3560
+ * @description Get top gainers
3561
+ * @tags Public
3562
+ * @name TopGainers
3563
+ * @summary Top Gainers
3564
+ * @request GET:/public/top-gainers
3565
+ * @secure
3566
+ */
3567
+ topGainers(query: {
3568
+ /** sort direction - asc or desc */
3569
+ order_direction?: string;
3570
+ /** how many records to return. Max value is 50 */
3571
+ limit: number;
3572
+ /** how many records to skip */
3573
+ offset: number;
3574
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
3575
+ /**
3576
+ * @description Get top stocks
3577
+ * @tags Public
3578
+ * @name TopStocks
3579
+ * @summary Top Stocks
3580
+ * @request GET:/public/top-stocks
3581
+ * @secure
3582
+ */
3583
+ topStocks(query: {
3584
+ /** EQUITY|ETF|CRYPTO */
3585
+ stock_type: string;
3586
+ /** how many records to return. Max value is 50 */
3587
+ limit: number;
3588
+ /** how many records to skip */
3589
+ offset: number;
3590
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
3591
+ }
3592
+ export class AlphaTools<HandleError extends boolean = boolean> {
3593
+ protected readonly apiClient: JwtClient<HandleError>;
3594
+ constructor(apiClient: JwtClient<HandleError>);
3595
+ /**
3596
+ * @description get seasonlity data with comparison to benchmark
3597
+ * @tags AlphaTools
3598
+ * @name GetMomentumRatioGraph
3599
+ * @summary get seasonlity data
3600
+ * @request POST:/rst
3601
+ * @secure
3602
+ */
3603
+ getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
3604
+ /**
3605
+ * @description get seasonlity data with comparison to benchmark
3606
+ * @tags AlphaTools
3607
+ * @name GetSeasonality
3608
+ * @summary get seasonlity data
3609
+ * @request POST:/seasonality
3610
+ * @secure
3611
+ */
3612
+ getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
3613
+ }
3614
+ export class TipRank<HandleError extends boolean = boolean> {
3615
+ protected readonly apiClient: JwtClient<HandleError>;
3616
+ constructor(apiClient: JwtClient<HandleError>);
3617
+ /**
3618
+ * @description Returns an overview of analyst ratings for a given ticker or ticker list, based on analyst ratings from the last 3 months.
3619
+ * @tags TipRank
3620
+ * @name TiprankAnalystConsensus
3621
+ * @summary Get tiprank AnalystConsensus
3622
+ * @request POST:/tipranks/analyst-consensus
3623
+ * @secure
3624
+ */
3625
+ tiprankAnalystConsensus(filter: InsightAnalystConsensusRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystConsensusResponse[], HandleError>>;
3626
+ /**
3627
+ * @description Returns the latest analyst ratings on a given stock or multiple stocks.
3628
+ * @tags TipRank
3629
+ * @name TiprankLatestAnalystRatingsOnStock
3630
+ * @summary Get tiprank LatestAnalystRatingsOnStock
3631
+ * @request POST:/tipranks/analyst-multi
3632
+ * @secure
3633
+ */
3634
+ tiprankLatestAnalystRatingsOnStock(filter: InsightLatestAnalystRatingsOnStockRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLatestAnalystRatingsOnStockResponse[], HandleError>>;
3635
+ /**
3636
+ * @description Returns the latest analyst portfolio items.
3637
+ * @tags TipRank
3638
+ * @name TiprankPortfolios
3639
+ * @summary Get the latest analyst portfolio items
3640
+ * @request POST:/tipranks/analyst-portfolio
3641
+ * @secure
3642
+ */
3643
+ tiprankPortfolios(filter: InsightPortfoliosRequest, headers?: {
3644
+ /** Authorization */
3645
+ Authorization?: string;
3646
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPortfoliosResponse[], HandleError>>;
3647
+ /**
3648
+ * @description Returns the analyst profile information
3649
+ * @tags TipRank
3650
+ * @name TiprankAnalystProfile
3651
+ * @summary Get tiprank AnalystProfile
3652
+ * @request GET:/tipranks/analyst-profile
3653
+ * @secure
3654
+ */
3655
+ tiprankAnalystProfile(query: {
3656
+ /** ID of tiprank analyst profile */
3657
+ id: string;
3658
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystProfileResponse, HandleError>>;
3659
+ /**
3660
+ * @description Returns the URL prefix to the expertPictureUrl field.
3661
+ * @tags TipRank
3662
+ * @name TiprankAnalystsExpertPictureStore
3663
+ * @summary Get tiprank AnalystsExpertPictureStore
3664
+ * @request GET:/tipranks/analysts-expert-picture-store
3665
+ * @secure
3666
+ */
3667
+ tiprankAnalystsExpertPictureStore(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystsExpertPictureStoreResponse, HandleError>>;
3668
+ /**
3669
+ * @description Returns a list of top-ranked analysts.
3670
+ * @tags TipRank
3671
+ * @name TiprankBestPerformingExperts
3672
+ * @summary Get tiprank BestPerformingExperts
3673
+ * @request GET:/tipranks/best-performing-experts
3674
+ * @secure
3675
+ */
3676
+ tiprankBestPerformingExperts(query?: {
3677
+ /** The number of analysts to return */
3678
+ num?: number;
3679
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightBestPerformingExpertsResponse[], HandleError>>;
3680
+ /**
3681
+ * @description Returns the blogger consensus on the stock along with the blogger opinion distribution by site.
3682
+ * @tags TipRank
3683
+ * @name TiprankBloggerConsensusOnStock
3684
+ * @summary Get tiprank BloggerConsensusOnStock
3685
+ * @request GET:/tipranks/blogger-consensus-on-stock
3686
+ * @secure
3687
+ */
3688
+ tiprankBloggerConsensusOnStock(query: {
3689
+ /** The ticker of the stock */
3690
+ ticker: string;
3691
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightBloggerConsensusOnStockResponse[], HandleError>>;
3692
+ /**
3693
+ * @description Returns a list of the upcoming IPOs and recent IPOs that have already been priced
3694
+ * @tags TipRank
3695
+ * @name TiprankCalendarsIpos
3696
+ * @summary Get tiprank CalendarsIPOS
3697
+ * @request GET:/tipranks/calendars-ipos
3698
+ * @secure
3699
+ */
3700
+ tiprankCalendarsIpos(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalendarsIPOSResponse[], HandleError>>;
3701
+ /**
3702
+ * @description Returns all stocks that have been updated since a specified UTC time.
3703
+ * @tags TipRank
3704
+ * @name TiprankGeneralStockUpdates
3705
+ * @summary Get tiprank GeneralStockUpdates
3706
+ * @request GET:/tipranks/general-stock-updates
3707
+ * @secure
3708
+ */
3709
+ tiprankGeneralStockUpdates(query?: {
3710
+ /** The specific requested time */
3711
+ utc_time?: string;
3712
+ /** Level of detail on updated stocks */
3713
+ details?: InsightTiprankGeneralStockUpdatesParamsDetailsEnum;
3714
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGeneralStockUpdatesResponse, HandleError>>;
3715
+ /**
3716
+ * @description Returns all hedge funds that have a position on a given stock along with the hedge fund activity trends and consensus.
3717
+ * @tags TipRank
3718
+ * @name TiprankHedgefunds
3719
+ * @summary Get tiprank HedgeFunds
3720
+ * @request GET:/tipranks/hedgefunds
3721
+ * @secure
3722
+ */
3723
+ tiprankHedgefunds(query: {
3724
+ /** The ticker of the stock */
3725
+ ticker: string;
3726
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsResponse[], HandleError>>;
3727
+ /**
3728
+ * @description Returns a list of top-ranked hedge fund managers.
3729
+ * @tags TipRank
3730
+ * @name TiprankHedgefundsBestPerformingExperts
3731
+ * @summary Get tiprank HedgeFundsBestPerformingExperts
3732
+ * @request GET:/tipranks/hedgefunds-best-performing-experts
3733
+ * @secure
3734
+ */
3735
+ tiprankHedgefundsBestPerformingExperts(query?: {
3736
+ /** The number of hedge fund managers to return */
3737
+ num?: number;
3738
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsBestPerformingExpertsResponse[], HandleError>>;
3739
+ /**
3740
+ * @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).
3741
+ * @tags TipRank
3742
+ * @name TiprankHedgefundsRecentTransactions
3743
+ * @summary Get tiprank HedgefundsRecentTransactions
3744
+ * @request GET:/tipranks/hedgefunds-recent-transactions
3745
+ * @secure
3746
+ */
3747
+ tiprankHedgefundsRecentTransactions(query?: {
3748
+ /** Show only managers with these number of stars or higher */
3749
+ min_stars?: number;
3750
+ /** The order of the latest insider transactions */
3751
+ sort?: InsightTiprankHedgefundsRecentTransactionsParamsSortEnum;
3752
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsRecentTransactionsResponse[], HandleError>>;
3753
+ /**
3754
+ * @description Returns the latest insider transactions and an overall sentiment on a given stock.
3755
+ * @tags TipRank
3756
+ * @name TiprankInsiders
3757
+ * @summary Get tiprank Insiders
3758
+ * @request GET:/tipranks/insiders
3759
+ * @secure
3760
+ */
3761
+ tiprankInsiders(query: {
3762
+ /** The ticker of the stock */
3763
+ ticker: string;
3764
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersResponse[], HandleError>>;
3765
+ /**
3766
+ * @description Returns a list of top ranked insiders.
3767
+ * @tags TipRank
3768
+ * @name TiprankInsidersBestPerformingExperts
3769
+ * @summary Get tiprank InsidersBestPerformingExperts
3770
+ * @request GET:/tipranks/insiders-best-performing-experts
3771
+ * @secure
3772
+ */
3773
+ tiprankInsidersBestPerformingExperts(query?: {
3774
+ /** The number of insiders to return */
3775
+ num?: number;
3776
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersBestPerformingExpertsResponse[], HandleError>>;
3777
+ /**
3778
+ * @description Returns all the information required to build TipRanks Insider Hot Stocks.
3779
+ * @tags TipRank
3780
+ * @name TiprankInsidersHotstocks
3781
+ * @summary Get tiprank InsidersHotstocks
3782
+ * @request GET:/tipranks/insiders-hotstocks
3783
+ * @secure
3784
+ */
3785
+ tiprankInsidersHotstocks(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersHotstocksResponse[], HandleError>>;
3786
+ /**
3787
+ * @description Returns a feed of the latest insider transactions reported to the SEC.
3788
+ * @tags TipRank
3789
+ * @name TiprankInsidersLiveFeed
3790
+ * @summary Get tiprank InsidersLiveFeed
3791
+ * @request GET:/tipranks/insiders-live-feed
3792
+ * @secure
3793
+ */
3794
+ tiprankInsidersLiveFeed(query?: {
3795
+ /** Return the latest X transactions */
3796
+ num?: number;
3797
+ /** The order of the latest insider transactions */
3798
+ sort?: InsightTiprankInsidersLiveFeedParamsSortEnum;
3799
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersLiveFeedResponse[], HandleError>>;
3800
+ /**
3801
+ * @description Returns the insider profile information.
3802
+ * @tags TipRank
3803
+ * @name TiprankInsidersOverview
3804
+ * @summary Get tiprank InsidersOverview
3805
+ * @request GET:/tipranks/insiders-overview
3806
+ * @secure
3807
+ */
3808
+ tiprankInsidersOverview(query?: {
3809
+ /** The UID of the expert */
3810
+ expert_uid?: string;
3811
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersOverviewResponse, HandleError>>;
3812
+ /**
3813
+ * @description Returns the sentiment of TipRanks users on the stock.
3814
+ * @tags TipRank
3815
+ * @name TiprankInvestorSentiment
3816
+ * @summary Get tiprank InvestorSentiment
3817
+ * @request GET:/tipranks/investor-sentiment
3818
+ * @secure
3819
+ */
3820
+ tiprankInvestorSentiment(query: {
3821
+ /** The ticker of the stock */
3822
+ ticker: string;
3823
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInvestorSentimentResponse, HandleError>>;
3824
+ /**
3825
+ * @description Returns the latest analyst ratings.
3826
+ * @tags TipRank
3827
+ * @name TiprankLiveFeed
3828
+ * @summary Get tiprank LiveFeed
3829
+ * @request POST:/tipranks/live-feed
3830
+ * @secure
3831
+ */
3832
+ tiprankLiveFeed(filter: InsightLiveFeedRequest, headers?: {
3833
+ /** Authorization */
3834
+ Authorization?: string;
3835
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLiveFeedResponse[], HandleError>>;
3836
+ /**
3837
+ * @description Returns the latest news articles on the stock and their sentiment (bullish / neutral or bearish).
3838
+ * @tags TipRank
3839
+ * @name TiprankNewsArticles
3840
+ * @summary Get tiprank NewsArticles
3841
+ * @request GET:/tipranks/news-articles
3842
+ * @secure
3843
+ */
3844
+ tiprankNewsArticles(query: {
3845
+ /** The ticker of the stock */
3846
+ ticker: string;
3847
+ /** Limit to number of articles 1-200 */
3848
+ num?: number;
3849
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsArticlesResponse[], HandleError>>;
3850
+ /**
3851
+ * @description Returns the overall sentiment, buzz score and word cloud for the stock.
3852
+ * @tags TipRank
3853
+ * @name TiprankNewsSentiment
3854
+ * @summary Get tiprank NewsSentiment
3855
+ * @request GET:/tipranks/news-sentiment
3856
+ * @secure
3857
+ */
3858
+ tiprankNewsSentiment(query: {
3859
+ /** The ticker of the stock */
3860
+ ticker: string;
3861
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsSentimentResponse, HandleError>>;
3862
+ /**
3863
+ * @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).
3864
+ * @tags TipRank
3865
+ * @name TiprankSectorConsensus
3866
+ * @summary Get tiprank SectorConsensus
3867
+ * @request GET:/tipranks/sector-consensus
3868
+ * @secure
3869
+ */
3870
+ tiprankSectorConsensus(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSectorConsensusResponse, HandleError>>;
3871
+ /**
3872
+ * @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.
3873
+ * @tags TipRank
3874
+ * @name TiprankSmartScore
3875
+ * @summary Get tiprank SmartScore
3876
+ * @request POST:/tipranks/smart-score
3877
+ * @secure
3878
+ */
3879
+ tiprankSmartScore(filter: InsightSmartScoreRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScoreResponse[], HandleError>>;
3880
+ /**
3881
+ * @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.
3882
+ * @tags TipRank
3883
+ * @name TiprankSmartScorePerformance
3884
+ * @summary Get tiprank SmartScorePerformance
3885
+ * @request GET:/tipranks/smart-score-performance
3886
+ * @secure
3887
+ */
3888
+ tiprankSmartScorePerformance(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScorePerformanceResponse, HandleError>>;
3889
+ /**
3890
+ * @description Returns a list of stocks with the top Smart Score of 10.
3891
+ * @tags TipRank
3892
+ * @name TiprankSmartScoreTopStocks
3893
+ * @summary Get tiprank SmartScoreTopStocks
3894
+ * @request POST:/tipranks/smart-score-top-stocks
3895
+ * @secure
3896
+ */
3897
+ tiprankSmartScoreTopStocks(filter: InsightSmartScoreTopStocksRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScoreResponse[], HandleError>>;
3898
+ /**
3899
+ * @description Returns a list of top-ranked analysts.
3900
+ * @tags TipRank
3901
+ * @name TiprankStocksConsensusOverTime
3902
+ * @summary Get tiprank StocksConsensusOverTime
3903
+ * @request POST:/tipranks/stocks-consensus-over-time
3904
+ * @secure
3905
+ */
3906
+ tiprankStocksConsensusOverTime(filter: InsightStocksConsensusOverTimeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksConsensusOverTimeResponse[], HandleError>>;
3907
+ /**
3908
+ * @description Returns the latest events per a specific stock, these include sell side analyst ratings, blogger opinions and corporate insider transactions
3909
+ * @tags TipRank
3910
+ * @name TiprankStocksEvents
3911
+ * @summary Get tiprank StocksEvents
3912
+ * @request POST:/tipranks/stocks-events
3913
+ * @secure
3914
+ */
3915
+ tiprankStocksEvents(filter: InsightStocksEventsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksEventsResponse[], HandleError>>;
3916
+ /**
3917
+ * @description Returns a list of stocks similar to the given ticker.
3918
+ * @tags TipRank
3919
+ * @name TiprankStocksSimilarStocks
3920
+ * @summary Get tiprank StocksSimilarStocks
3921
+ * @request GET:/tipranks/stocks-similar-stocks
3922
+ * @secure
3923
+ */
3924
+ tiprankStocksSimilarStocks(query: {
3925
+ /** The ticker of the stock */
3926
+ ticker: string;
3927
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
3928
+ /**
3929
+ * @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.
3930
+ * @tags TipRank
3931
+ * @name TiprankStocksTopMovers
3932
+ * @summary Get tiprank StocksTopMovers
3933
+ * @request GET:/tipranks/stocks-top-movers
3934
+ * @secure
3935
+ */
3936
+ tiprankStocksTopMovers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksTopMoversResponse[], HandleError>>;
3937
+ /**
3938
+ * @description Returns the stock symbols covered by TipRanks.
3939
+ * @tags TipRank
3940
+ * @name TiprankSupportedTickers
3941
+ * @summary Get tiprank SupportedTickers
3942
+ * @request GET:/tipranks/supported-tickers
3943
+ * @secure
3944
+ */
3945
+ tiprankSupportedTickers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSupportedTickersResponse, HandleError>>;
3946
+ /**
3947
+ * @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).
3948
+ * @tags TipRank
3949
+ * @name TiprankTopRateStocks
3950
+ * @summary Get tiprank TopRateStocks
3951
+ * @request GET:/tipranks/top-rate-stocks
3952
+ * @secure
3953
+ */
3954
+ tiprankTopRateStocks(query?: {
3955
+ /** Return the most trending X stocks */
3956
+ num?: number;
3957
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopRateStocksResponse, HandleError>>;
3958
+ /**
3959
+ * @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.
3960
+ * @tags TipRank
3961
+ * @name TiprankTopStocksBySectors
3962
+ * @summary Get tiprank TopStocksBySectors
3963
+ * @request POST:/tipranks/top-stocks-by-sectors
3964
+ * @secure
3965
+ */
3966
+ tiprankTopStocksBySectors(filter: InsightTopStocksBySectorsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksBySectorsResponse, HandleError>>;
3967
+ /**
3968
+ * @description Returns a list of stocks with the highest number of analyst ratings in the last 7 days.
3969
+ * @tags TipRank
3970
+ * @name TiprankTrendingStocks
3971
+ * @summary Get tiprank TrendingStocks
3972
+ * @request POST:/tipranks/trending-stocks
3973
+ * @secure
3974
+ */
3975
+ tiprankTrendingStocks(filter: InsightTrendingStocksRequest, headers?: {
3976
+ /** Authorization */
3977
+ Authorization?: string;
3978
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
3979
+ }
3980
+ export class UsageTracking<HandleError extends boolean = boolean> {
3981
+ protected readonly apiClient: JwtClient<HandleError>;
3982
+ constructor(apiClient: JwtClient<HandleError>);
3983
+ /**
3984
+ * @description get usage date per branch for a period
3985
+ * @tags UsageTracking
3986
+ * @name GetUsageData
3987
+ * @summary get insight usage data
3988
+ * @request POST:/tracking/usage
3989
+ * @secure
3990
+ */
3991
+ getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
3992
+ }
3993
+ export interface InsightBeforeAndAfterV2 {
3994
+ after?: string;
3995
+ before?: string;
3996
+ }
3997
+ export interface InsightFixedIncomeV2 {
3998
+ a144: boolean;
3999
+ accrued_interest: number;
4000
+ bank_qualified: boolean;
4001
+ bond_warrant: boolean;
4002
+ call_type: string;
4003
+ callable: boolean;
4004
+ close_price: number;
4005
+ close_price_asof: string;
4006
+ close_ytw: number;
4007
+ convertible: boolean;
4008
+ country: string;
4009
+ country_code: string;
4010
+ country_domicile: string;
4011
+ country_issue: string;
4012
+ coupon: number;
4013
+ coupon_frequency: string;
4014
+ coupon_type: string;
4015
+ currency: string;
4016
+ cusip: string;
4017
+ dated_date: string;
4018
+ daycount: string;
4019
+ description: string;
4020
+ description_short: string;
4021
+ duration: number;
4022
+ first_coupon_date: string;
4023
+ insured: boolean;
4024
+ isin: string;
4025
+ issue_date: string;
4026
+ issue_minimum_denomination: number;
4027
+ issue_price: number;
4028
+ issue_size: number;
4029
+ issuer: string;
4030
+ last_coupon_date: string;
4031
+ liquidity_institutional_aggregate: number;
4032
+ liquidity_institutional_buy: number;
4033
+ liquidity_institutional_sell: number;
4034
+ liquidity_micro_aggregate: number;
4035
+ liquidity_micro_buy: number;
4036
+ liquidity_micro_sell: number;
4037
+ liquidity_retail_aggregate: number;
4038
+ liquidity_retail_buy: number;
4039
+ liquidity_retail_sell: number;
4040
+ maturity_date: string;
4041
+ municipal_state: string;
4042
+ municipal_taxable_federal: boolean;
4043
+ municipal_type: string;
4044
+ next_call_date: string;
4045
+ next_call_price: number;
4046
+ next_coupon_date: string;
4047
+ par_value: number;
4048
+ perpetual: boolean;
4049
+ private_placement: boolean;
4050
+ purpose: string;
4051
+ puttable: boolean;
4052
+ reg_s: boolean;
4053
+ sector: string;
4054
+ seniority: string;
4055
+ settlement_convention: string;
4056
+ sinking_fund: boolean;
4057
+ sp_creditwatch: string;
4058
+ sp_creditwatch_date: string;
4059
+ sp_outlook: string;
4060
+ sp_outlook_date: string;
4061
+ sp_rating: string;
4062
+ sp_rating_date: string;
4063
+ status: string;
4064
+ ticker: string;
4065
+ treasury_subtype: string;
4066
+ type: string;
4067
+ updated_at: string;
4068
+ }
4069
+ export interface InsightGetFixedIncomeEntriesRequestV2 {
4070
+ bank_qualified?: boolean;
4071
+ callable?: boolean;
4072
+ convertible?: boolean;
4073
+ country_codes?: string[];
4074
+ coupon?: InsightLessAndMoreV2;
4075
+ coupon_frequencies?: string[];
4076
+ cusip?: string[];
4077
+ description?: string;
4078
+ has_ticker?: boolean;
4079
+ insured?: boolean;
4080
+ isin?: string[];
4081
+ issue_date?: InsightBeforeAndAfterV2;
4082
+ issuer?: string;
4083
+ maturity?: InsightBeforeAndAfterV2;
4084
+ municipal_states?: string[];
4085
+ municipal_tax?: boolean;
4086
+ municipal_types?: string[];
4087
+ order?: InsightOrderingV2;
4088
+ pagination?: InsightPaginationV2;
4089
+ paging?: InsightPagingV2;
4090
+ purposes?: string[];
4091
+ sectors?: string[];
4092
+ sorts?: InsightOrderingV2[];
4093
+ sp_ratings?: string[];
4094
+ statuses?: string[];
4095
+ tickers?: string[];
4096
+ types?: string[];
4097
+ }
4098
+ export interface InsightGetFixedIncomeEntriesResponseV2 {
4099
+ count: number;
4100
+ data: InsightFixedIncomeV2[];
4101
+ }
4102
+ export interface InsightGetTopSymbolsRequestV2 {
4103
+ exchange?: string[];
4104
+ market_cap?: InsightLessAndMoreV2;
4105
+ order?: InsightOrderingV2;
4106
+ pagination?: InsightPaginationV2;
4107
+ paging?: InsightPagingV2;
4108
+ price?: InsightLessAndMoreV2;
4109
+ quote_access_type?: string;
4110
+ sorts?: InsightOrderingV2[];
4111
+ volume?: InsightLessAndMoreV2;
4112
+ }
4113
+ export interface InsightIncludeExcludeV2 {
4114
+ exclude?: string[];
4115
+ include?: string[];
4116
+ }
4117
+ export interface InsightLessAndMoreV2 {
4118
+ less_than?: number;
4119
+ more_than?: number;
4120
+ }
4121
+ export interface InsightOrderingV2 {
4122
+ /** @default "asc" */
4123
+ direction: InsightOrderingDirectionEnumV2;
4124
+ /**
4125
+ * Sort direction:
4126
+ * * asc - Ascending, from A to Z.
4127
+ * * desc - Descending, from Z to A.
4128
+ */
4129
+ field: string;
4130
+ }
4131
+ export interface InsightPaginationV2 {
4132
+ page: number;
4133
+ size: number;
4134
+ }
4135
+ export interface InsightPagingV2 {
4136
+ limit: number;
4137
+ offset: number;
4138
+ }
4139
+ export interface InsightStockScreenerQuoteV2 {
4140
+ average_volume_30d: number;
4141
+ company_name: string;
4142
+ dividend_ex_date: string;
4143
+ dividend_pay_date: string;
4144
+ dividend_percent: number;
4145
+ exchange: string;
4146
+ exchange_name: string;
4147
+ gap: number;
4148
+ industry: string;
4149
+ industry_code: string;
4150
+ last_price: number;
4151
+ market_cap: number;
4152
+ pe_ratio: number;
4153
+ price_change: number;
4154
+ price_change_percent: number;
4155
+ symbol: string;
4156
+ volume: number;
4157
+ }
4158
+ export interface InsightStockScreenerRequestV2 {
4159
+ average_volume_30d?: InsightLessAndMoreV2;
4160
+ dividend_ex_date?: InsightBeforeAndAfterV2;
4161
+ dividend_pay_date?: InsightBeforeAndAfterV2;
4162
+ dividend_percent?: InsightLessAndMoreV2;
4163
+ exchange?: InsightIncludeExcludeV2;
4164
+ gap?: InsightLessAndMoreV2;
4165
+ industry?: InsightIncludeExcludeV2;
4166
+ market_cap?: InsightLessAndMoreV2;
4167
+ order?: InsightOrderingV2;
4168
+ pagination?: InsightPaginationV2;
4169
+ paging?: InsightPagingV2;
4170
+ pe_ratio?: InsightLessAndMoreV2;
4171
+ price?: InsightLessAndMoreV2;
4172
+ quote_access_type?: string;
4173
+ sorts?: InsightOrderingV2[];
4174
+ stock_type?: string;
4175
+ volume?: InsightLessAndMoreV2;
4176
+ }
4177
+ export interface InsightStockScreenerResponseV2 {
4178
+ current_page: number;
4179
+ data: InsightStockScreenerQuoteV2[];
4180
+ page_count: number;
4181
+ status: number;
4182
+ total_records: number;
4183
+ }
4184
+ /** @default "asc" */
4185
+ export enum InsightOrderingDirectionEnumV2 {
4186
+ Asc = "asc",
4187
+ Desc = "desc"
4188
+ }
4189
+ export class FixedIncomeV2<HandleError extends boolean = boolean> {
4190
+ protected readonly apiClient: JwtClient<HandleError>;
4191
+ constructor(apiClient: JwtClient<HandleError>);
4192
+ /**
4193
+ * @description get fixed income entries
4194
+ * @tags FixedIncome
4195
+ * @name GetFixedIncomeEntries
4196
+ * @summary get fixed income entries
4197
+ * @request POST:/fixed-income
4198
+ * @secure
4199
+ */
4200
+ getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
4201
+ }
4202
+ export class StockScreenerV2<HandleError extends boolean = boolean> {
4203
+ protected readonly apiClient: JwtClient<HandleError>;
4204
+ constructor(apiClient: JwtClient<HandleError>);
4205
+ /**
4206
+ * @description filter stocks by params
4207
+ * @tags StockScreener
4208
+ * @name StockScreener
4209
+ * @summary filter stocks by params
4210
+ * @request POST:/stock-screener
4211
+ * @secure
4212
+ */
4213
+ stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
4214
+ /**
4215
+ * @description get top symbols
4216
+ * @tags StockScreener
4217
+ * @name GetTopSymbols
4218
+ * @summary get top symbols
4219
+ * @request POST:/stock-screener/top
4220
+ * @secure
4221
+ */
4222
+ getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
4223
+ }
4224
+ export class InsightApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
4225
+ alphaTools: AlphaTools<HandleError>;
4226
+ companyProfile: CompanyProfile<HandleError>;
4227
+ customList: CustomLists<HandleError>;
4228
+ dashboard: Dashboard<HandleError>;
4229
+ earning: Earnings<HandleError>;
4230
+ fixedIncome: FixedIncome<HandleError>;
4231
+ fundamentals: Fundamentals<HandleError>;
4232
+ fund: Funds<HandleError>;
4233
+ intraday: Intraday<HandleError>;
4234
+ ipos: Ipos<HandleError>;
4235
+ lists: Lists<HandleError>;
4236
+ logos: Logos<HandleError>;
4237
+ marketDates: MarketDates<HandleError>;
4238
+ news: News<HandleError>;
4239
+ optionGreeks: OptionGreeks<HandleError>;
4240
+ ownerships: Ownerships<HandleError>;
4241
+ passport: Passport<HandleError>;
4242
+ public: Public<HandleError>;
4243
+ quotes: Quotes<HandleError>;
4244
+ stockScreener: StockScreener<HandleError>;
4245
+ tiprank: TipRank<HandleError>;
4246
+ usageTracking: UsageTracking<HandleError>;
4247
+ worldMarkets: WorldMarkets<HandleError>;
4248
+ v2: {
4249
+ fixedIncome: FixedIncomeV2<HandleError>;
4250
+ stockScreener: StockScreenerV2<HandleError>;
4251
+ };
4252
+ constructor(config: JwtClientConfig<HandleError>);
4253
+ }
4254
+
4255
+ //# sourceMappingURL=index.d.ts.map