@orbis-systems/orbis-api-clients 0.7.11 → 0.7.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (43) hide show
  1. package/dist/aesmidas/index.d.ts +119 -119
  2. package/dist/aesmidas/index.d.ts.map +1 -1
  3. package/dist/aesmidas/index.esm.js +1 -1
  4. package/dist/aesmidas/index.esm.js.map +1 -1
  5. package/dist/aesmidas/index.js +1 -1
  6. package/dist/aesmidas/index.js.map +1 -1
  7. package/dist/bridgewise/index.d.ts +608 -608
  8. package/dist/bridgewise/index.d.ts.map +1 -1
  9. package/dist/bridgewise/index.esm.js +1 -1
  10. package/dist/bridgewise/index.esm.js.map +1 -1
  11. package/dist/bridgewise/index.js +1 -1
  12. package/dist/bridgewise/index.js.map +1 -1
  13. package/dist/insight/index.d.ts +1349 -1174
  14. package/dist/insight/index.d.ts.map +1 -1
  15. package/dist/insight/index.esm.js +1 -1
  16. package/dist/insight/index.esm.js.map +1 -1
  17. package/dist/insight/index.js +1 -1
  18. package/dist/insight/index.js.map +1 -1
  19. package/dist/middleware/index.d.ts +73 -73
  20. package/dist/middleware/index.d.ts.map +1 -1
  21. package/dist/middleware/index.esm.js +1 -1
  22. package/dist/middleware/index.esm.js.map +1 -1
  23. package/dist/middleware/index.js +1 -1
  24. package/dist/middleware/index.js.map +1 -1
  25. package/dist/orbis/index.d.ts +3947 -3947
  26. package/dist/orbis/index.d.ts.map +1 -1
  27. package/dist/orbis/index.esm.js +1 -1
  28. package/dist/orbis/index.esm.js.map +1 -1
  29. package/dist/orbis/index.js +1 -1
  30. package/dist/orbis/index.js.map +1 -1
  31. package/dist/uma/index.d.ts +616 -616
  32. package/dist/uma/index.d.ts.map +1 -1
  33. package/dist/uma/index.esm.js +1 -1
  34. package/dist/uma/index.esm.js.map +1 -1
  35. package/dist/uma/index.js +1 -1
  36. package/dist/uma/index.js.map +1 -1
  37. package/dist/zerohash/index.d.ts +660 -660
  38. package/dist/zerohash/index.d.ts.map +1 -1
  39. package/dist/zerohash/index.esm.js +1 -1
  40. package/dist/zerohash/index.esm.js.map +1 -1
  41. package/dist/zerohash/index.js +1 -1
  42. package/dist/zerohash/index.js.map +1 -1
  43. package/package.json +1 -1
@@ -690,6 +690,7 @@ export interface InsightEarningRelease {
690
690
  time: string;
691
691
  }
692
692
  export interface InsightEarningReleasesRequest {
693
+ date?: InsightBeforeAndAfter;
693
694
  /**
694
695
  * @min 0
695
696
  * @example 7
@@ -1293,6 +1294,179 @@ export interface InsightGetPreIPOCompanySPVsResponse {
1293
1294
  count: number;
1294
1295
  details: InsightPreIPOCompanySPV[];
1295
1296
  }
1297
+ export interface InsightGetPreIPOCompanySPVsWithInvestorIDResponse {
1298
+ items: {
1299
+ all_in_price_per_share?: number;
1300
+ close_date?: string;
1301
+ co_managers?: {
1302
+ aum?: number;
1303
+ country_code?: string;
1304
+ dba_name?: string;
1305
+ description?: string;
1306
+ executive_team?: string[];
1307
+ founding_date?: string;
1308
+ id?: string;
1309
+ legal_entity_name?: string;
1310
+ logo_url?: string;
1311
+ manager_crd?: string[];
1312
+ name?: string;
1313
+ partner_type?: string;
1314
+ registration?: string;
1315
+ secondary_location?: string;
1316
+ website?: string;
1317
+ }[];
1318
+ cusip?: string;
1319
+ description?: string;
1320
+ documents?: {
1321
+ description?: string;
1322
+ id?: string;
1323
+ investor_id?: string;
1324
+ investor_subscription_id?: string;
1325
+ name?: string;
1326
+ partner_id?: string;
1327
+ pre_ipo_company_id?: string;
1328
+ pre_ipo_company_investment_id?: string;
1329
+ pre_ipo_company_spv_id?: string;
1330
+ registered_fund_id?: string;
1331
+ tax_year?: number;
1332
+ template_document?: boolean;
1333
+ type?: string;
1334
+ url?: string;
1335
+ }[];
1336
+ exemptions_claimed?: string[];
1337
+ funding_deadline?: string;
1338
+ id?: string;
1339
+ investor_fee_per_share?: number;
1340
+ investor_price_per_share?: number;
1341
+ management_fee?: number;
1342
+ management_fee_years_payable?: number;
1343
+ manager?: {
1344
+ aum?: number;
1345
+ country_code?: string;
1346
+ dba_name?: string;
1347
+ description?: string;
1348
+ executive_team?: string[];
1349
+ founding_date?: string;
1350
+ id?: string;
1351
+ legal_entity_name?: string;
1352
+ logo_url?: string;
1353
+ manager_crd?: string[];
1354
+ name?: string;
1355
+ partner_type?: string;
1356
+ registration?: string;
1357
+ secondary_location?: string;
1358
+ website?: string;
1359
+ };
1360
+ master_llc_name?: string;
1361
+ min_commitment_amount?: number;
1362
+ monark_stage?: string;
1363
+ name?: string;
1364
+ notable_investors?: string[];
1365
+ number_of_seats_remaining?: number;
1366
+ pre_funded_inventory?: boolean;
1367
+ pre_ipo_company_id?: string;
1368
+ pre_ipo_company_investment_id?: string;
1369
+ pre_ipo_company_name?: string;
1370
+ remaining_dollar_allocation?: number;
1371
+ remaining_share_allocation?: number;
1372
+ spv_account_id?: number;
1373
+ spv_custodian?: string;
1374
+ synopsis?: string;
1375
+ total_dollar_allocation?: number;
1376
+ total_number_of_seats?: number;
1377
+ total_share_allocation?: number;
1378
+ trading_symbol?: string;
1379
+ valuation?: number;
1380
+ }[];
1381
+ pagination: {
1382
+ current_page: number;
1383
+ total_pages: number;
1384
+ total_records: number;
1385
+ };
1386
+ }
1387
+ export interface InsightGetProIPOCompabySPVWithInvestorIDResponse {
1388
+ all_in_price_per_share: number;
1389
+ close_date: string;
1390
+ co_managers: {
1391
+ aum?: number;
1392
+ country_code?: string;
1393
+ dba_name?: string;
1394
+ description?: string;
1395
+ executive_team?: string[];
1396
+ founding_date?: string;
1397
+ id?: string;
1398
+ legal_entity_name?: string;
1399
+ logo_url?: string;
1400
+ manager_crd?: string[];
1401
+ name?: string;
1402
+ partner_type?: string;
1403
+ registration?: string;
1404
+ secondary_location?: string;
1405
+ website?: string;
1406
+ }[];
1407
+ cusip: string;
1408
+ description: string;
1409
+ documents: {
1410
+ description?: string;
1411
+ id?: string;
1412
+ investor_id?: string;
1413
+ investor_subscription_id?: string;
1414
+ name?: string;
1415
+ partner_id?: string;
1416
+ pre_ipo_company_id?: string;
1417
+ pre_ipo_company_investment_id?: string;
1418
+ pre_ipo_company_spv_id?: string;
1419
+ registered_fund_id?: string;
1420
+ tax_year?: number;
1421
+ template_document?: boolean;
1422
+ type?: string;
1423
+ url?: string;
1424
+ }[];
1425
+ exemptions_claimed: string[];
1426
+ funding_deadline: string;
1427
+ id: string;
1428
+ investor_fee_per_share: number;
1429
+ investor_price_per_share: number;
1430
+ management_fee: number;
1431
+ management_fee_years_payable: number;
1432
+ manager: {
1433
+ aum: number;
1434
+ country_code: string;
1435
+ dba_name: string;
1436
+ description: string;
1437
+ executive_team: string[];
1438
+ founding_date: string;
1439
+ id: string;
1440
+ legal_entity_name: string;
1441
+ logo_url: string;
1442
+ manager_crd: string[];
1443
+ name: string;
1444
+ partner_type: string;
1445
+ registration: string;
1446
+ secondary_location: string;
1447
+ website: string;
1448
+ };
1449
+ master_llc_name: string;
1450
+ min_commitment_amount: number;
1451
+ monark_stage: string;
1452
+ name: string;
1453
+ notable_investors: string[];
1454
+ number_of_seats_remaining: number;
1455
+ pre_funded_inventory: boolean;
1456
+ pre_ipo_company_id: string;
1457
+ pre_ipo_company_investment_id: string;
1458
+ pre_ipo_company_name: string;
1459
+ remaining_dollar_allocation: number;
1460
+ remaining_share_allocation: number;
1461
+ spv_account_id: number;
1462
+ spv_custodian: string;
1463
+ synopsis: string;
1464
+ total_dollar_allocation: number;
1465
+ total_number_of_seats: number;
1466
+ total_share_allocation: number;
1467
+ trading_symbol: string;
1468
+ valuation: number;
1469
+ }
1296
1470
  export interface InsightGetScreenerPresetsResponse {
1297
1471
  count: number;
1298
1472
  default_presets: InsightScreenerPreset[];
@@ -3116,6 +3290,7 @@ export interface InsightNewsfeedRequest {
3116
3290
  export interface InsightOptionData {
3117
3291
  expiry_date: InsightDate;
3118
3292
  greeks: InsightOptionGreeks;
3293
+ implied_volatility: number;
3119
3294
  strike_price: number;
3120
3295
  theoretical_price: number;
3121
3296
  ticker: string;
@@ -4374,6 +4549,67 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
4374
4549
  Date = "date",
4375
4550
  Rank = "rank"
4376
4551
  }
4552
+ export class AlphaTools<HandleError extends boolean = boolean> {
4553
+ protected readonly apiClient: JwtClient<HandleError>;
4554
+ constructor(apiClient: JwtClient<HandleError>);
4555
+ /**
4556
+ * @description get seasonlity data with comparison to benchmark
4557
+ * @tags AlphaTools
4558
+ * @name GetMomentumRatioGraph
4559
+ * @summary get seasonlity data
4560
+ * @request POST:/rst
4561
+ * @secure
4562
+ */
4563
+ getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
4564
+ /**
4565
+ * @description get seasonlity data with comparison to benchmark
4566
+ * @tags AlphaTools
4567
+ * @name GetSeasonality
4568
+ * @summary get seasonlity data
4569
+ * @request POST:/seasonality
4570
+ * @secure
4571
+ */
4572
+ getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
4573
+ }
4574
+ export class CompanyProfile<HandleError extends boolean = boolean> {
4575
+ protected readonly apiClient: JwtClient<HandleError>;
4576
+ constructor(apiClient: JwtClient<HandleError>);
4577
+ /**
4578
+ * @description get company profile, industries classification and closest earning release
4579
+ * @tags CompanyProfile
4580
+ * @name GetCompanyProfile
4581
+ * @summary get company profile
4582
+ * @request GET:/company-profile
4583
+ * @secure
4584
+ */
4585
+ getCompanyProfile(query: {
4586
+ /** Company symbol */
4587
+ symbol: string;
4588
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError>>;
4589
+ /**
4590
+ * @description get combined profile, equities and funds
4591
+ * @tags CompanyProfile
4592
+ * @name GetCombinedProfile
4593
+ * @summary get company profile
4594
+ * @request GET:/quote-profile
4595
+ * @secure
4596
+ */
4597
+ getCombinedProfile(query: {
4598
+ /** Company symbol */
4599
+ symbol: string;
4600
+ /** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
4601
+ symbol_type?: InsightGetCombinedProfileParamsSymbolTypeEnum;
4602
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError>>;
4603
+ /**
4604
+ * @description sort input array of symbols by type
4605
+ * @tags CompanyProfile
4606
+ * @name GetSymbolsPerSymbolType
4607
+ * @summary sort input array of symbols by type
4608
+ * @request POST:/symbols-per-type
4609
+ * @secure
4610
+ */
4611
+ getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
4612
+ }
4377
4613
  export class CustomLists<HandleError extends boolean = boolean> {
4378
4614
  protected readonly apiClient: JwtClient<HandleError>;
4379
4615
  constructor(apiClient: JwtClient<HandleError>);
@@ -4458,19 +4694,6 @@ export class CustomLists<HandleError extends boolean = boolean> {
4458
4694
  symbols?: string[];
4459
4695
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFilteredCustomIndexResponse, HandleError>>;
4460
4696
  }
4461
- export class Earnings<HandleError extends boolean = boolean> {
4462
- protected readonly apiClient: JwtClient<HandleError>;
4463
- constructor(apiClient: JwtClient<HandleError>);
4464
- /**
4465
- * @description get earnings release dates for symbols
4466
- * @tags Earnings
4467
- * @name GetEarningsCalendar
4468
- * @summary get earnings calendar data
4469
- * @request POST:/earnings-calendar
4470
- * @secure
4471
- */
4472
- getEarningsCalendar(filter: InsightEarningReleasesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEarningReleasesResponse, HandleError>>;
4473
- }
4474
4697
  export class Dashboard<HandleError extends boolean = boolean> {
4475
4698
  protected readonly apiClient: JwtClient<HandleError>;
4476
4699
  constructor(apiClient: JwtClient<HandleError>);
@@ -4546,573 +4769,882 @@ export class Dashboard<HandleError extends boolean = boolean> {
4546
4769
  symbol: string;
4547
4770
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolRelatedFieldsResponse, HandleError>>;
4548
4771
  }
4549
- export class WorldMarkets<HandleError extends boolean = boolean> {
4772
+ export class Earnings<HandleError extends boolean = boolean> {
4550
4773
  protected readonly apiClient: JwtClient<HandleError>;
4551
4774
  constructor(apiClient: JwtClient<HandleError>);
4552
4775
  /**
4553
- * @description Get continents
4554
- * @tags World Markets
4555
- * @name ContinentGet
4556
- * @summary Get continents
4557
- * @request GET:/continents
4558
- * @secure
4559
- */
4560
- continentGet(query: {
4561
- /** Query limit */
4562
- limit: number;
4563
- /** Query offset */
4564
- offset: number;
4565
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
4566
- /**
4567
- * @description Edit continent
4568
- * @tags World Markets
4569
- * @name ContinentEdit
4570
- * @summary Edit continent
4571
- * @request PUT:/continents
4776
+ * @description get earnings release dates for symbols
4777
+ * @tags Earnings
4778
+ * @name GetEarningsCalendar
4779
+ * @summary get earnings calendar data
4780
+ * @request POST:/earnings-calendar
4572
4781
  * @secure
4573
4782
  */
4574
- continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4783
+ getEarningsCalendar(filter: InsightEarningReleasesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEarningReleasesResponse, HandleError>>;
4784
+ }
4785
+ export class FixedIncome<HandleError extends boolean = boolean> {
4786
+ protected readonly apiClient: JwtClient<HandleError>;
4787
+ constructor(apiClient: JwtClient<HandleError>);
4575
4788
  /**
4576
- * @description Create continents
4577
- * @tags World Markets
4578
- * @name ContinentCreate
4579
- * @summary Create continents
4580
- * @request POST:/continents
4789
+ * @description get fixed income entries
4790
+ * @tags FixedIncome
4791
+ * @name GetFixedIncomeEntries
4792
+ * @summary get fixed income entries
4793
+ * @request POST:/fixed-income
4581
4794
  * @secure
4582
4795
  */
4583
- continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
4796
+ getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponse, HandleError>>;
4584
4797
  /**
4585
- * @description Delete continent
4586
- * @tags World Markets
4587
- * @name ContinentDelete
4588
- * @summary Delete continent
4589
- * @request DELETE:/continents
4798
+ * @description Returns historical fixed income
4799
+ * @tags FixedIncome
4800
+ * @name FixedIncomeHistorical
4801
+ * @summary Get historical fixed income
4802
+ * @request POST:/fixed-income/historical
4590
4803
  * @secure
4591
4804
  */
4592
- continentDelete(query: {
4593
- /** continent id */
4594
- id: string;
4595
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4805
+ fixedIncomeHistorical(filter: InsightGetFixedIncomeHistoricalRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeHistoricalResponse, HandleError>>;
4596
4806
  /**
4597
- * @description Get country codes
4598
- * @tags World Markets
4599
- * @name CountryCodeGet
4600
- * @summary Get country codes
4601
- * @request GET:/country-codes
4807
+ * @description get fixed-income presets
4808
+ * @tags FixedIncome
4809
+ * @name GetFixedIncomePresets
4810
+ * @summary get fixed-income presets
4811
+ * @request GET:/fixed-income/presets
4602
4812
  * @secure
4603
4813
  */
4604
- countryCodeGet(query: {
4605
- /** Query limit */
4814
+ getFixedIncomePresets(query: {
4815
+ /** how many records to return */
4606
4816
  limit: number;
4607
- /** Query offset */
4817
+ /** how many records to skip */
4608
4818
  offset: number;
4609
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
4819
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
4610
4820
  /**
4611
- * @description Edit country code
4612
- * @tags World Markets
4613
- * @name CountryCodeEdit
4614
- * @summary Edit country code
4615
- * @request PUT:/country-codes
4821
+ * @description update fixed-income preset
4822
+ * @tags FixedIncome
4823
+ * @name UpdateFixedIncomePreset
4824
+ * @summary update fixed-income preset
4825
+ * @request PUT:/fixed-income/presets
4616
4826
  * @secure
4617
4827
  */
4618
- countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4828
+ updateFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
4619
4829
  /**
4620
- * @description Add country codes
4621
- * @tags World Markets
4622
- * @name CountryCodeAdd
4623
- * @summary Add country codes
4624
- * @request POST:/country-codes
4830
+ * @description create fixed-income preset
4831
+ * @tags FixedIncome
4832
+ * @name CreateFixedIncomePreset
4833
+ * @summary create fixed-income preset
4834
+ * @request POST:/fixed-income/presets
4625
4835
  * @secure
4626
4836
  */
4627
- countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
4837
+ createFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
4628
4838
  /**
4629
- * @description Delete country code
4630
- * @tags World Markets
4631
- * @name CountryCodeDelete
4632
- * @summary Delete country code
4633
- * @request DELETE:/country-codes
4839
+ * @description remove fixed-income preset
4840
+ * @tags FixedIncome
4841
+ * @name RemoveFixedIncomePreset
4842
+ * @summary remove fixed-income preset
4843
+ * @request DELETE:/fixed-income/presets
4634
4844
  * @secure
4635
4845
  */
4636
- countryCodeDelete(query: {
4637
- /** a3 code */
4638
- a3code: string;
4639
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4846
+ removeFixedIncomePreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4640
4847
  /**
4641
- * @description Get global indexes
4642
- * @tags World Markets
4643
- * @name GlobalIndexGet
4644
- * @summary Get global indexes
4645
- * @request GET:/global-indexes
4848
+ * @description get single fixed income entry
4849
+ * @tags FixedIncome
4850
+ * @name GetSingleFixedIncomeEntry
4851
+ * @summary get single fixed income entry
4852
+ * @request GET:/fixed-income/{id}
4646
4853
  * @secure
4647
4854
  */
4648
- globalIndexGet(query: {
4649
- /** Query limit */
4650
- limit: number;
4651
- /** Query offset */
4652
- offset: number;
4653
- /** Continent code for filtering */
4654
- continent?: string;
4655
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
4855
+ getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
4856
+ }
4857
+ export interface InsightBeforeAndAfterV2 {
4858
+ after?: string;
4859
+ before?: string;
4860
+ }
4861
+ export interface InsightFixedIncomeV2 {
4862
+ a144: boolean;
4863
+ accrued_interest: number;
4864
+ bank_qualified: boolean;
4865
+ bond_warrant: boolean;
4866
+ call_type: string;
4867
+ callable: boolean;
4868
+ close_price: number;
4869
+ close_price_asof: string;
4870
+ close_ytw: number;
4871
+ convertible: boolean;
4872
+ country: string;
4873
+ country_code: string;
4874
+ country_domicile: string;
4875
+ country_issue: string;
4876
+ coupon: number;
4877
+ coupon_frequency: string;
4878
+ coupon_type: string;
4879
+ currency: string;
4880
+ cusip: string;
4881
+ dated_date: string;
4882
+ daycount: string;
4883
+ description: string;
4884
+ description_short: string;
4885
+ duration: number;
4886
+ first_coupon_date: string;
4887
+ insured: boolean;
4888
+ isin: string;
4889
+ issue_date: string;
4890
+ issue_minimum_denomination: number;
4891
+ issue_price: number;
4892
+ issue_size: number;
4893
+ issuer: string;
4894
+ last_coupon_date: string;
4895
+ liquidity_institutional_aggregate: number;
4896
+ liquidity_institutional_buy: number;
4897
+ liquidity_institutional_sell: number;
4898
+ liquidity_micro_aggregate: number;
4899
+ liquidity_micro_buy: number;
4900
+ liquidity_micro_sell: number;
4901
+ liquidity_retail_aggregate: number;
4902
+ liquidity_retail_buy: number;
4903
+ liquidity_retail_sell: number;
4904
+ maturity_date: string;
4905
+ municipal_state: string;
4906
+ municipal_taxable_federal: boolean;
4907
+ municipal_type: string;
4908
+ next_call_date: string;
4909
+ next_call_price: number;
4910
+ next_coupon_date: string;
4911
+ par_value: number;
4912
+ perpetual: boolean;
4913
+ private_placement: boolean;
4914
+ purpose: string;
4915
+ puttable: boolean;
4916
+ reg_s: boolean;
4917
+ sector: string;
4918
+ seniority: string;
4919
+ settlement_convention: string;
4920
+ sinking_fund: boolean;
4921
+ sp_creditwatch: string;
4922
+ sp_creditwatch_date: string;
4923
+ sp_outlook: string;
4924
+ sp_outlook_date: string;
4925
+ sp_rating: string;
4926
+ sp_rating_date: string;
4927
+ status: string;
4928
+ ticker: string;
4929
+ treasury_subtype: string;
4930
+ type: string;
4931
+ updated_at: string;
4932
+ }
4933
+ export interface InsightGetFixedIncomeEntriesResponseV2 {
4934
+ count: number;
4935
+ data: InsightFixedIncomeV2[];
4936
+ }
4937
+ export interface InsightGetFixedIncomeEntriesRequestV2 {
4938
+ /** @example true */
4939
+ bank_qualified?: boolean;
4940
+ /** @example true */
4941
+ callable?: boolean;
4942
+ /** @example true */
4943
+ convertible?: boolean;
4944
+ /** @example ["USA"] */
4945
+ country_codes?: string[];
4946
+ coupon?: InsightLessAndMoreV2;
4947
+ /** @example ["quarterly","zero"] */
4948
+ coupon_frequencies?: string[];
4949
+ /** @example ["655664AH3","9128286R6"] */
4950
+ cusip?: string[];
4656
4951
  /**
4657
- * @description Edit global index
4658
- * @tags World Markets
4659
- * @name GlobalIndexEdit
4660
- * @summary Edit global index
4661
- * @request PUT:/global-indexes
4952
+ * @maxLength 100
4953
+ * @example "Donald's"
4954
+ */
4955
+ description?: string;
4956
+ /** @example true */
4957
+ has_ticker?: boolean;
4958
+ /** @example true */
4959
+ insured?: boolean;
4960
+ /** @example ["US655664AH33","US9128286R69"] */
4961
+ isin?: string[];
4962
+ issue_date?: InsightBeforeAndAfterV2;
4963
+ /**
4964
+ * @maxLength 100
4965
+ * @example "Donald's"
4966
+ */
4967
+ issuer?: string;
4968
+ maturity?: InsightBeforeAndAfterV2;
4969
+ /** @example ["NY"] */
4970
+ municipal_states?: string[];
4971
+ /** @example true */
4972
+ municipal_tax?: boolean;
4973
+ /** @example ["general_obligation"] */
4974
+ municipal_types?: string[];
4975
+ pagination: InsightPaginationV2;
4976
+ purposes?: string[];
4977
+ /** @example ["SOVEREIGN"] */
4978
+ sectors?: string[];
4979
+ sorts?: InsightOrderingV2[];
4980
+ /** @example ["AAA"] */
4981
+ sp_ratings?: string[];
4982
+ /** @example ["called","outstanding"] */
4983
+ statuses?: string[];
4984
+ tickers?: string[];
4985
+ /** @example ["corporate"] */
4986
+ types?: string[];
4987
+ }
4988
+ export interface InsightGetTopSymbolsRequestV2 {
4989
+ exchange?: string[];
4990
+ market_cap?: InsightLessAndMoreV2;
4991
+ pagination?: InsightPaginationV2;
4992
+ price?: InsightLessAndMoreV2;
4993
+ sorts?: InsightOrderingV2[];
4994
+ volume?: InsightLessAndMoreV2;
4995
+ }
4996
+ export interface InsightIncludeExcludeV2 {
4997
+ exclude?: string[];
4998
+ include?: string[];
4999
+ }
5000
+ export interface InsightLessAndMoreV2 {
5001
+ less_than?: number;
5002
+ more_than?: number;
5003
+ }
5004
+ export interface InsightOrderingV2 {
5005
+ /**
5006
+ * @default "asc"
5007
+ * @example "asc"
5008
+ */
5009
+ direction: InsightOrderingDirectionEnumV2;
5010
+ /**
5011
+ * Sort direction:
5012
+ * * asc - Ascending, from A to Z.
5013
+ * * desc - Descending, from Z to A.
5014
+ * @example "name"
5015
+ */
5016
+ field: string;
5017
+ }
5018
+ export interface InsightPaginationV2 {
5019
+ /**
5020
+ * @min 1
5021
+ * @example 1
5022
+ */
5023
+ page: number;
5024
+ /**
5025
+ * @min 1
5026
+ * @max 50
5027
+ * @example 10
5028
+ */
5029
+ size: number;
5030
+ }
5031
+ export interface InsightStockScreenerQuoteV2 {
5032
+ average_volume_30d: number;
5033
+ company_name: string;
5034
+ dividend_ex_date: string;
5035
+ dividend_pay_date: string;
5036
+ dividend_percent: number;
5037
+ exchange: string;
5038
+ exchange_name: string;
5039
+ gap: number;
5040
+ industry: string;
5041
+ industry_code: string;
5042
+ last_price: number;
5043
+ market_cap: number;
5044
+ pe_ratio: number;
5045
+ price_change: number;
5046
+ price_change_percent: number;
5047
+ symbol: string;
5048
+ volume: number;
5049
+ }
5050
+ export interface InsightStockScreenerRequestV2 {
5051
+ average_volume_30d?: InsightLessAndMoreV2;
5052
+ dividend_ex_date?: InsightBeforeAndAfterV2;
5053
+ dividend_pay_date?: InsightBeforeAndAfterV2;
5054
+ dividend_percent?: InsightLessAndMoreV2;
5055
+ exchange?: InsightIncludeExcludeV2;
5056
+ gap?: InsightLessAndMoreV2;
5057
+ industry?: InsightIncludeExcludeV2;
5058
+ market_cap?: InsightLessAndMoreV2;
5059
+ pagination: InsightPaginationV2;
5060
+ pe_ratio?: InsightLessAndMoreV2;
5061
+ price?: InsightLessAndMoreV2;
5062
+ sorts?: InsightOrderingV2[];
5063
+ /** @example "ADR" */
5064
+ stock_type?: string;
5065
+ volume?: InsightLessAndMoreV2;
5066
+ }
5067
+ export interface InsightStockScreenerResponseV2 {
5068
+ current_page: number;
5069
+ data: InsightStockScreenerQuoteV2[];
5070
+ page_count: number;
5071
+ status: number;
5072
+ total_records: number;
5073
+ }
5074
+ /**
5075
+ * @default "asc"
5076
+ * @example "asc"
5077
+ */
5078
+ export enum InsightOrderingDirectionEnumV2 {
5079
+ Asc = "asc",
5080
+ Desc = "desc"
5081
+ }
5082
+ export class FixedIncomeV2<HandleError extends boolean = boolean> {
5083
+ protected readonly apiClient: JwtClient<HandleError>;
5084
+ constructor(apiClient: JwtClient<HandleError>);
5085
+ /**
5086
+ * @description get fixed income entries
5087
+ * @tags FixedIncome
5088
+ * @name GetFixedIncomeEntries
5089
+ * @summary get fixed income entries
5090
+ * @request POST:/fixed-income
4662
5091
  * @secure
4663
5092
  */
4664
- globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5093
+ getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
5094
+ }
5095
+ export class Fundamentals<HandleError extends boolean = boolean> {
5096
+ protected readonly apiClient: JwtClient<HandleError>;
5097
+ constructor(apiClient: JwtClient<HandleError>);
4665
5098
  /**
4666
- * @description Add global indexes
4667
- * @tags World Markets
4668
- * @name GlobalIndexAdd
4669
- * @summary Add global indexes
4670
- * @request POST:/global-indexes
5099
+ * @description get fundamentals by symbol data
5100
+ * @tags Fundamentals
5101
+ * @name GetFundamentalsBySymbolData
5102
+ * @summary get fundamentals by symbol data
5103
+ * @request POST:/fundamentals
4671
5104
  * @secure
4672
5105
  */
4673
- globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
5106
+ getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
5107
+ }
5108
+ export class Funds<HandleError extends boolean = boolean> {
5109
+ protected readonly apiClient: JwtClient<HandleError>;
5110
+ constructor(apiClient: JwtClient<HandleError>);
4674
5111
  /**
4675
- * @description Edit global index
4676
- * @tags World Markets
4677
- * @name GlobalIndexDelete
4678
- * @summary Delete global index
4679
- * @request DELETE:/global-indexes
5112
+ * @description get fund details
5113
+ * @tags Funds
5114
+ * @name GetFundDetails
5115
+ * @summary get fund details
5116
+ * @request GET:/funds/details
4680
5117
  * @secure
4681
5118
  */
4682
- globalIndexDelete(query: {
4683
- /** a3 code */
4684
- a3code: string;
4685
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5119
+ getFundDetails(query: {
5120
+ /** Fund symbol */
5121
+ symbol: string;
5122
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundDetailsResponse, HandleError>>;
4686
5123
  /**
4687
- * @description Get regions
4688
- * @tags World Markets
4689
- * @name RegionGet
4690
- * @summary Get regions
4691
- * @request GET:/regions
5124
+ * @description get funds for holding
5125
+ * @tags Funds
5126
+ * @name GetFundsForHolding
5127
+ * @summary get funds for holding
5128
+ * @request POST:/funds/funds-for-holding
5129
+ * @secure
5130
+ */
5131
+ getFundsForHolding(filter: InsightGetFundsForHoldingRequest, headers?: {
5132
+ /** Authorization */
5133
+ Authorization?: string;
5134
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundsForHoldingResponse, HandleError>>;
5135
+ /**
5136
+ * @description filter funds by params
5137
+ * @tags Funds
5138
+ * @name FundScreener
5139
+ * @summary filter funds by params
5140
+ * @request POST:/funds/screener
5141
+ * @secure
5142
+ */
5143
+ fundScreener(filter: InsightFundScreenerRequest, headers?: {
5144
+ /** Authorization */
5145
+ Authorization?: string;
5146
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
5147
+ /**
5148
+ * @description get fund screener filters
5149
+ * @tags Funds
5150
+ * @name GetScreenerFilters
5151
+ * @summary get fund screener filters
5152
+ * @request GET:/funds/screener/filters
5153
+ * @secure
5154
+ */
5155
+ getScreenerFilters(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundScreenerFiltersResponse, HandleError>>;
5156
+ /**
5157
+ * @description get fund screener presets
5158
+ * @tags Funds
5159
+ * @name GetFundScreenerPresets
5160
+ * @summary get fund screener presets
5161
+ * @request GET:/funds/screener/presets
5162
+ * @secure
5163
+ */
5164
+ getFundScreenerPresets(query: {
5165
+ /** how many records to return */
5166
+ limit: number;
5167
+ /** how many records to skip */
5168
+ offset: number;
5169
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
5170
+ /**
5171
+ * @description update fund screener preset
5172
+ * @tags Funds
5173
+ * @name UpdateFundScreenerPreset
5174
+ * @summary update fund screener preset
5175
+ * @request PUT:/funds/screener/presets
5176
+ * @secure
5177
+ */
5178
+ updateFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5179
+ /**
5180
+ * @description create fund screener preset
5181
+ * @tags Funds
5182
+ * @name CreateFundScreenerPreset
5183
+ * @summary create fund screener preset
5184
+ * @request POST:/funds/screener/presets
4692
5185
  * @secure
4693
5186
  */
4694
- regionGet(query: {
4695
- /** Query limit */
4696
- limit: number;
4697
- /** Query offset */
4698
- offset: number;
4699
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
5187
+ createFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
4700
5188
  /**
4701
- * @description Edit region
4702
- * @tags World Markets
4703
- * @name RegionEdit
4704
- * @summary Edit region
4705
- * @request PUT:/regions
5189
+ * @description remove fund screener preset
5190
+ * @tags Funds
5191
+ * @name RemoveFundScreenerPreset
5192
+ * @summary remove fund screener preset
5193
+ * @request DELETE:/funds/screener/presets
4706
5194
  * @secure
4707
5195
  */
4708
- regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5196
+ removeFundScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4709
5197
  /**
4710
- * @description Create regions
4711
- * @tags World Markets
4712
- * @name RegionCreate
4713
- * @summary Create regions
4714
- * @request POST:/regions
5198
+ * @description filter funds by params
5199
+ * @tags Funds
5200
+ * @name FundSectorScreener
5201
+ * @summary filter funds by params
5202
+ * @request POST:/funds/sector-screener
4715
5203
  * @secure
4716
5204
  */
4717
- regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
5205
+ fundSectorScreener(filter: InsightFundSectorScreenerRequest, headers?: {
5206
+ /** Authorization */
5207
+ Authorization?: string;
5208
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
4718
5209
  /**
4719
- * @description Delete region
4720
- * @tags World Markets
4721
- * @name RegionDelete
4722
- * @summary Delete region
4723
- * @request DELETE:/regions
5210
+ * @description get top funds
5211
+ * @tags Funds
5212
+ * @name GetTopFunds
5213
+ * @summary get top funds
5214
+ * @request POST:/funds/top
4724
5215
  * @secure
4725
5216
  */
4726
- regionDelete(query: {
4727
- /** region id */
4728
- id: string;
4729
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5217
+ getTopFunds(filter: InsightGetTopFundsRequest, headers?: {
5218
+ /** Authorization */
5219
+ Authorization?: string;
5220
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
4730
5221
  }
4731
- export class FixedIncome<HandleError extends boolean = boolean> {
5222
+ export class Intraday<HandleError extends boolean = boolean> {
4732
5223
  protected readonly apiClient: JwtClient<HandleError>;
4733
5224
  constructor(apiClient: JwtClient<HandleError>);
4734
5225
  /**
4735
- * @description get fixed income entries
4736
- * @tags FixedIncome
4737
- * @name GetFixedIncomeEntries
4738
- * @summary get fixed income entries
4739
- * @request POST:/fixed-income
5226
+ * @description Returns an array of intraday chart data values for the given ticker.
5227
+ * @tags Intraday
5228
+ * @name IntradayQuotes
5229
+ * @summary Get an array of intraday chart data values for the given ticker
5230
+ * @request POST:/intraday/quotes
4740
5231
  * @secure
4741
5232
  */
4742
- getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponse, HandleError>>;
5233
+ intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
5234
+ }
5235
+ export class Ipos<HandleError extends boolean = boolean> {
5236
+ protected readonly apiClient: JwtClient<HandleError>;
5237
+ constructor(apiClient: JwtClient<HandleError>);
4743
5238
  /**
4744
- * @description Returns historical fixed income
4745
- * @tags FixedIncome
4746
- * @name FixedIncomeHistorical
4747
- * @summary Get historical fixed income
4748
- * @request POST:/fixed-income/historical
5239
+ * @description get recent ipos info
5240
+ * @tags Ipos
5241
+ * @name PostRecent
5242
+ * @summary get recent ipos info
5243
+ * @request POST:/ipos/recent
4749
5244
  * @secure
4750
5245
  */
4751
- fixedIncomeHistorical(filter: InsightGetFixedIncomeHistoricalRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeHistoricalResponse, HandleError>>;
5246
+ postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
4752
5247
  /**
4753
- * @description get fixed-income presets
4754
- * @tags FixedIncome
4755
- * @name GetFixedIncomePresets
4756
- * @summary get fixed-income presets
4757
- * @request GET:/fixed-income/presets
5248
+ * @description get upcoming ipos info
5249
+ * @tags Ipos
5250
+ * @name GetUpcoming
5251
+ * @summary get upcoming ipos info
5252
+ * @request GET:/ipos/upcoming
4758
5253
  * @secure
4759
5254
  */
4760
- getFixedIncomePresets(query: {
4761
- /** how many records to return */
5255
+ getUpcoming(query: {
5256
+ /** how many records to return. Max value is 50 */
4762
5257
  limit: number;
4763
5258
  /** how many records to skip */
4764
5259
  offset: number;
4765
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
5260
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
4766
5261
  /**
4767
- * @description update fixed-income preset
4768
- * @tags FixedIncome
4769
- * @name UpdateFixedIncomePreset
4770
- * @summary update fixed-income preset
4771
- * @request PUT:/fixed-income/presets
5262
+ * @description get ipo info by symbol
5263
+ * @tags Ipos
5264
+ * @name GetIpos
5265
+ * @summary get ipo info by symbol
5266
+ * @request GET:/ipos/{symbol}
4772
5267
  * @secure
4773
5268
  */
4774
- updateFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5269
+ getIpos(symbol: string, query?: {
5270
+ /** load quotes */
5271
+ load_quotes?: boolean;
5272
+ /** statuses */
5273
+ statuses?: string[];
5274
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
5275
+ }
5276
+ export class Logos<HandleError extends boolean = boolean> {
5277
+ protected readonly apiClient: JwtClient<HandleError>;
5278
+ constructor(apiClient: JwtClient<HandleError>);
4775
5279
  /**
4776
- * @description create fixed-income preset
4777
- * @tags FixedIncome
4778
- * @name CreateFixedIncomePreset
4779
- * @summary create fixed-income preset
4780
- * @request POST:/fixed-income/presets
5280
+ * @description Returns converted logo for crypto symbol
5281
+ * @tags Logos
5282
+ * @name LogosConvertedCryptoSymbolLogo
5283
+ * @summary Get converted logo for crypto symbol
5284
+ * @request POST:/logos/converted-crypto-symbol-logo
4781
5285
  * @secure
4782
5286
  */
4783
- createFixedIncomePreset(input: InsightCreateOrUpdateFixedIncomePresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5287
+ logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
4784
5288
  /**
4785
- * @description remove fixed-income preset
4786
- * @tags FixedIncome
4787
- * @name RemoveFixedIncomePreset
4788
- * @summary remove fixed-income preset
4789
- * @request DELETE:/fixed-income/presets
5289
+ * @description Returns converted logo for symbol
5290
+ * @tags Logos
5291
+ * @name LogosConvertedSymbolLogo
5292
+ * @summary Get converted logo for symbol
5293
+ * @request POST:/logos/converted-symbol-logo
4790
5294
  * @secure
4791
5295
  */
4792
- removeFixedIncomePreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5296
+ logosConvertedSymbolLogo(filter: InsightSymbolLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
4793
5297
  /**
4794
- * @description get single fixed income entry
4795
- * @tags FixedIncome
4796
- * @name GetSingleFixedIncomeEntry
4797
- * @summary get single fixed income entry
4798
- * @request GET:/fixed-income/{id}
5298
+ * @description Returns logo for crypto symbol
5299
+ * @tags Logos
5300
+ * @name LogosCryptoSymbolLogo
5301
+ * @summary Get logo for crypto symbol
5302
+ * @request GET:/logos/crypto-symbol-logo
4799
5303
  * @secure
4800
5304
  */
4801
- getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
4802
- }
4803
- export class CompanyProfile<HandleError extends boolean = boolean> {
4804
- protected readonly apiClient: JwtClient<HandleError>;
4805
- constructor(apiClient: JwtClient<HandleError>);
5305
+ logosCryptoSymbolLogo(query: {
5306
+ /** Company symbol */
5307
+ symbol: string;
5308
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError>>;
4806
5309
  /**
4807
- * @description get company profile, industries classification and closest earning release
4808
- * @tags CompanyProfile
4809
- * @name GetCompanyProfile
4810
- * @summary get company profile
4811
- * @request GET:/company-profile
5310
+ * @description Returns direct logo for crypto symbol
5311
+ * @tags Logos
5312
+ * @name LogosDirectCryptoSymbolLogo
5313
+ * @summary Get direct logo for crypto symbol
5314
+ * @request GET:/logos/direct-crypto-symbol-logo
4812
5315
  * @secure
4813
5316
  */
4814
- getCompanyProfile(query: {
5317
+ logosDirectCryptoSymbolLogo(query: {
4815
5318
  /** Company symbol */
4816
5319
  symbol: string;
4817
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCompanyProfile, HandleError>>;
5320
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
4818
5321
  /**
4819
- * @description get combined profile, equities and funds
4820
- * @tags CompanyProfile
4821
- * @name GetCombinedProfile
4822
- * @summary get company profile
4823
- * @request GET:/quote-profile
5322
+ * @description Returns direct logo for symbol
5323
+ * @tags Logos
5324
+ * @name LogosDirectSymbolLogo
5325
+ * @summary Get direct logo for symbol
5326
+ * @request GET:/logos/direct-symbol-logo
4824
5327
  * @secure
4825
5328
  */
4826
- getCombinedProfile(query: {
5329
+ logosDirectSymbolLogo(query: {
4827
5330
  /** Company symbol */
4828
5331
  symbol: string;
4829
- /** Desired symbol type - [ANY,FUND,EQUITY,INDEX] */
4830
- symbol_type?: InsightGetCombinedProfileParamsSymbolTypeEnum;
4831
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCombinedProfileResponse, HandleError>>;
5332
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
4832
5333
  /**
4833
- * @description sort input array of symbols by type
4834
- * @tags CompanyProfile
4835
- * @name GetSymbolsPerSymbolType
4836
- * @summary sort input array of symbols by type
4837
- * @request POST:/symbols-per-type
5334
+ * @description Returns logos for multiple symbols
5335
+ * @tags Logos
5336
+ * @name LogosMultipleCryptoSymbolLogo
5337
+ * @summary Get logos for multiple symbols
5338
+ * @request POST:/logos/multiple-crypto-symbol-logo
4838
5339
  * @secure
4839
5340
  */
4840
- getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
5341
+ logosMultipleCryptoSymbolLogo(filter: InsightMultipleCryptoLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse[], HandleError>>;
5342
+ /**
5343
+ * @description Returns logos for multiple symbol
5344
+ * @tags Logos
5345
+ * @name LogosMultipleSymbolLogos
5346
+ * @summary Get logos for multiple symbols
5347
+ * @request POST:/logos/multiple-symbol-logos
5348
+ * @secure
5349
+ */
5350
+ logosMultipleSymbolLogos(filter: InsightMultipleSymbolLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse[], HandleError>>;
5351
+ /**
5352
+ * @description Returns links of socials logos for symbol
5353
+ * @tags Logos
5354
+ * @name LogosSocialSymbolLogos
5355
+ * @summary Get social logos for symbol
5356
+ * @request GET:/logos/social-symbol-logos
5357
+ * @secure
5358
+ */
5359
+ logosSocialSymbolLogos(query: {
5360
+ /** Company symbol */
5361
+ symbol: string;
5362
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
5363
+ /**
5364
+ * @description Returns logos for company symbol
5365
+ * @tags Logos
5366
+ * @name LogosSymbolLogos
5367
+ * @summary Get symbol logos
5368
+ * @request GET:/logos/symbol-logos
5369
+ * @secure
5370
+ */
5371
+ logosSymbolLogos(query: {
5372
+ /** Company symbol */
5373
+ symbol: string;
5374
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
4841
5375
  }
4842
- export class Fundamentals<HandleError extends boolean = boolean> {
5376
+ export class MarketDates<HandleError extends boolean = boolean> {
4843
5377
  protected readonly apiClient: JwtClient<HandleError>;
4844
5378
  constructor(apiClient: JwtClient<HandleError>);
4845
5379
  /**
4846
- * @description get fundamentals by symbol data
4847
- * @tags Fundamentals
4848
- * @name GetFundamentalsBySymbolData
4849
- * @summary get fundamentals by symbol data
4850
- * @request POST:/fundamentals
5380
+ * @description get market dates history
5381
+ * @tags MarketDates
5382
+ * @name GetMarketDatesHistory
5383
+ * @summary get market dates history
5384
+ * @request POST:/market-dates/history
5385
+ * @secure
5386
+ */
5387
+ getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
5388
+ /**
5389
+ * @description get todays market hours
5390
+ * @tags MarketDates
5391
+ * @name GetTodaysMarketHours
5392
+ * @summary get todays market hours
5393
+ * @request GET:/market-dates/today
4851
5394
  * @secure
4852
5395
  */
4853
- getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
5396
+ getTodaysMarketHours(query: {
5397
+ /** Market */
5398
+ market: string;
5399
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
4854
5400
  }
4855
- export class Funds<HandleError extends boolean = boolean> {
5401
+ export class News<HandleError extends boolean = boolean> {
4856
5402
  protected readonly apiClient: JwtClient<HandleError>;
4857
5403
  constructor(apiClient: JwtClient<HandleError>);
4858
5404
  /**
4859
- * @description get fund details
4860
- * @tags Funds
4861
- * @name GetFundDetails
4862
- * @summary get fund details
4863
- * @request GET:/funds/details
5405
+ * @description Returns available authors in DB
5406
+ * @tags News
5407
+ * @name NewsAvailableAuthors
5408
+ * @summary Get available authors in DB (for filters)
5409
+ * @request POST:/news/authors
4864
5410
  * @secure
4865
5411
  */
4866
- getFundDetails(query: {
4867
- /** Fund symbol */
4868
- symbol: string;
4869
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundDetailsResponse, HandleError>>;
5412
+ newsAvailableAuthors(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
4870
5413
  /**
4871
- * @description get funds for holding
4872
- * @tags Funds
4873
- * @name GetFundsForHolding
4874
- * @summary get funds for holding
4875
- * @request POST:/funds/funds-for-holding
5414
+ * @description Returns available channels in DB
5415
+ * @tags News
5416
+ * @name NewsAvailableChannels
5417
+ * @summary Get available channels in DB (for filters)
5418
+ * @request POST:/news/channels
4876
5419
  * @secure
4877
5420
  */
4878
- getFundsForHolding(filter: InsightGetFundsForHoldingRequest, headers?: {
4879
- /** Authorization */
4880
- Authorization?: string;
4881
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundsForHoldingResponse, HandleError>>;
5421
+ newsAvailableChannels(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
4882
5422
  /**
4883
- * @description filter funds by params
4884
- * @tags Funds
4885
- * @name FundScreener
4886
- * @summary filter funds by params
4887
- * @request POST:/funds/screener
5423
+ * @description Get featured articles
5424
+ * @tags News
5425
+ * @name GetFeaturedArticles
5426
+ * @summary Get featured articles
5427
+ * @request GET:/news/featured-articles
4888
5428
  * @secure
4889
5429
  */
4890
- fundScreener(filter: InsightFundScreenerRequest, headers?: {
4891
- /** Authorization */
4892
- Authorization?: string;
4893
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
5430
+ getFeaturedArticles(query: {
5431
+ /** Limit */
5432
+ limit: number;
5433
+ /** Offset */
5434
+ offset: number;
5435
+ /** Start date */
5436
+ start_date?: string;
5437
+ /** End date */
5438
+ end_date?: string;
5439
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
4894
5440
  /**
4895
- * @description get fund screener filters
4896
- * @tags Funds
4897
- * @name GetScreenerFilters
4898
- * @summary get fund screener filters
4899
- * @request GET:/funds/screener/filters
5441
+ * @description Update featured articles
5442
+ * @tags News
5443
+ * @name UpdateFeaturedArticles
5444
+ * @summary Update featured articles
5445
+ * @request PUT:/news/featured-articles
4900
5446
  * @secure
4901
5447
  */
4902
- getScreenerFilters(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundScreenerFiltersResponse, HandleError>>;
5448
+ updateFeaturedArticles(input: InsightUpdateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4903
5449
  /**
4904
- * @description get fund screener presets
4905
- * @tags Funds
4906
- * @name GetFundScreenerPresets
4907
- * @summary get fund screener presets
4908
- * @request GET:/funds/screener/presets
5450
+ * @description Create featured articles
5451
+ * @tags News
5452
+ * @name CreateFeaturedArticles
5453
+ * @summary Create featured articles
5454
+ * @request POST:/news/featured-articles
4909
5455
  * @secure
4910
5456
  */
4911
- getFundScreenerPresets(query: {
4912
- /** how many records to return */
4913
- limit: number;
4914
- /** how many records to skip */
4915
- offset: number;
4916
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
5457
+ createFeaturedArticles(input: InsightCreateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4917
5458
  /**
4918
- * @description update fund screener preset
4919
- * @tags Funds
4920
- * @name UpdateFundScreenerPreset
4921
- * @summary update fund screener preset
4922
- * @request PUT:/funds/screener/presets
5459
+ * @description Get active featured articles
5460
+ * @tags News
5461
+ * @name GetActiveFeaturedArticles
5462
+ * @summary Get active featured articles
5463
+ * @request GET:/news/featured-articles/active
4923
5464
  * @secure
4924
5465
  */
4925
- updateFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5466
+ getActiveFeaturedArticles(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
4926
5467
  /**
4927
- * @description create fund screener preset
4928
- * @tags Funds
4929
- * @name CreateFundScreenerPreset
4930
- * @summary create fund screener preset
4931
- * @request POST:/funds/screener/presets
5468
+ * @description Set featured articles
5469
+ * @tags News
5470
+ * @name SetFeaturedArticles
5471
+ * @summary Set featured articles
5472
+ * @request POST:/news/featured-articles/set
4932
5473
  * @secure
4933
5474
  */
4934
- createFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5475
+ setFeaturedArticles(input: InsightSetFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4935
5476
  /**
4936
- * @description remove fund screener preset
4937
- * @tags Funds
4938
- * @name RemoveFundScreenerPreset
4939
- * @summary remove fund screener preset
4940
- * @request DELETE:/funds/screener/presets
5477
+ * @description Get featured article
5478
+ * @tags News
5479
+ * @name GetFeaturedArticle
5480
+ * @summary Get featured article
5481
+ * @request GET:/news/featured-articles/{id}
4941
5482
  * @secure
4942
5483
  */
4943
- removeFundScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5484
+ getFeaturedArticle(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticle, HandleError>>;
4944
5485
  /**
4945
- * @description filter funds by params
4946
- * @tags Funds
4947
- * @name FundSectorScreener
4948
- * @summary filter funds by params
4949
- * @request POST:/funds/sector-screener
5486
+ * @description Returns news by filters
5487
+ * @tags News
5488
+ * @name NewsFiltered
5489
+ * @summary Get filtered news
5490
+ * @request POST:/news/filter
4950
5491
  * @secure
4951
5492
  */
4952
- fundSectorScreener(filter: InsightFundSectorScreenerRequest, headers?: {
4953
- /** Authorization */
4954
- Authorization?: string;
4955
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
5493
+ newsFiltered(filter: InsightNewsFilterRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsResponse, HandleError>>;
4956
5494
  /**
4957
- * @description get top funds
4958
- * @tags Funds
4959
- * @name GetTopFunds
4960
- * @summary get top funds
4961
- * @request POST:/funds/top
5495
+ * @description Returns news by id
5496
+ * @tags News
5497
+ * @name NewsById
5498
+ * @summary Get news by id
5499
+ * @request POST:/news/id
4962
5500
  * @secure
4963
5501
  */
4964
- getTopFunds(filter: InsightGetTopFundsRequest, headers?: {
4965
- /** Authorization */
4966
- Authorization?: string;
4967
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
4968
- }
4969
- export class StockScreener<HandleError extends boolean = boolean> {
4970
- protected readonly apiClient: JwtClient<HandleError>;
4971
- constructor(apiClient: JwtClient<HandleError>);
5502
+ newsById(filter: InsightNewsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNews, HandleError>>;
4972
5503
  /**
4973
- * @description data for visual heat map
4974
- * @tags StockScreener
4975
- * @name StockMarketHeatmap
4976
- * @summary data for visual heat map
4977
- * @request GET:/heatmaps
5504
+ * @description Returns news previews
5505
+ * @tags News
5506
+ * @name NewsPreviewsFiltered
5507
+ * @summary Get news previews
5508
+ * @request GET:/news/previews
4978
5509
  * @secure
4979
5510
  */
4980
- stockMarketHeatmap(query?: {
4981
- /** Name of symbol list to fetch details for. Empty is default */
4982
- heatmap_name?: string;
4983
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
5511
+ newsPreviewsFiltered(query: {
5512
+ /** Start date */
5513
+ start_date?: string;
5514
+ /** End date */
5515
+ end_date?: string;
5516
+ /** Symbol */
5517
+ symbol?: string;
5518
+ /** how many records to return. Max value is 50 */
5519
+ limit: number;
5520
+ /** how many records to skip */
5521
+ offset: number;
5522
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRecentNewsPreviewsResponse, HandleError>>;
4984
5523
  /**
4985
- * @description create or update heat map preset
4986
- * @tags StockScreener
4987
- * @name CreateStockMarketHeatmapPreset
4988
- * @summary create or update heat map preset
4989
- * @request POST:/heatmaps
5524
+ * @description Returns available stocks in DB
5525
+ * @tags News
5526
+ * @name NewsAvailableStocks
5527
+ * @summary Get available stocks in DB (for filters)
5528
+ * @request GET:/news/symbols
4990
5529
  * @secure
4991
5530
  */
4992
- createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5531
+ newsAvailableStocks(query?: {
5532
+ /** Limit */
5533
+ limit?: number;
5534
+ /** Offset */
5535
+ offset?: number;
5536
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
4993
5537
  /**
4994
- * @description Sector and Industry Group performance
4995
- * @tags StockScreener
4996
- * @name IndustriesPerformance
4997
- * @summary get industries performance
4998
- * @request POST:/industries-performance
5538
+ * @description Returns available tags in DB
5539
+ * @tags News
5540
+ * @name NewsAvailableTags
5541
+ * @summary Get available tags in DB (for filters)
5542
+ * @request POST:/news/tags
4999
5543
  * @secure
5000
5544
  */
5001
- industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
5545
+ newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5546
+ }
5547
+ export class OptionGreeks<HandleError extends boolean = boolean> {
5548
+ protected readonly apiClient: JwtClient<HandleError>;
5549
+ constructor(apiClient: JwtClient<HandleError>);
5002
5550
  /**
5003
- * @description filter stocks by params
5004
- * @tags StockScreener
5005
- * @name StockScreener
5006
- * @summary filter stocks by params
5007
- * @request POST:/stock-screener
5551
+ * @description Returns calculated matrix
5552
+ * @tags OptionGreeks
5553
+ * @name OgCalculateMatrix
5554
+ * @summary Calculate matrix
5555
+ * @request POST:/og/calculate-matrix
5008
5556
  * @secure
5009
5557
  */
5010
- stockScreener(filter: InsightStockScreenerV1Request, headers?: {
5011
- /** Authorization */
5012
- Authorization?: string;
5013
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
5558
+ ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
5014
5559
  /**
5015
- * @description get screener presets
5016
- * @tags StockScreener
5017
- * @name GetScreenerPresets
5018
- * @summary get screener presets
5019
- * @request GET:/stock-screener/presets
5560
+ * @description Returns calculated params
5561
+ * @tags OptionGreeks
5562
+ * @name OgCalculateParams
5563
+ * @summary Calculate params
5564
+ * @request POST:/og/calculate-params
5020
5565
  * @secure
5021
5566
  */
5022
- getScreenerPresets(query: {
5023
- /** how many records to return */
5024
- limit: number;
5025
- /** how many records to skip */
5026
- offset: number;
5027
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
5567
+ ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
5568
+ }
5569
+ export class Ownerships<HandleError extends boolean = boolean> {
5570
+ protected readonly apiClient: JwtClient<HandleError>;
5571
+ constructor(apiClient: JwtClient<HandleError>);
5028
5572
  /**
5029
- * @description update screener preset
5030
- * @tags StockScreener
5031
- * @name UpdateScreenerPreset
5032
- * @summary update screener preset
5033
- * @request PUT:/stock-screener/presets
5573
+ * @description get ownerships by id datadata
5574
+ * @tags Ownerships
5575
+ * @name GetOwnershipsByIdData
5576
+ * @summary get ownerships by id data
5577
+ * @request POST:/ownerships
5034
5578
  * @secure
5035
5579
  */
5036
- updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5580
+ getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
5037
5581
  /**
5038
- * @description create screener preset
5039
- * @tags StockScreener
5040
- * @name CreateOrScreenerPreset
5041
- * @summary create screener preset
5042
- * @request POST:/stock-screener/presets
5582
+ * @description get ownerships by symbol data
5583
+ * @tags Ownerships
5584
+ * @name GetOwnershipsBySymbolData
5585
+ * @summary get ownerships by symbol data
5586
+ * @request POST:/symbol-ownerships
5043
5587
  * @secure
5044
5588
  */
5045
- createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5589
+ getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
5590
+ }
5591
+ export class Passport<HandleError extends boolean = boolean> {
5592
+ protected readonly apiClient: JwtClient<HandleError>;
5593
+ constructor(apiClient: JwtClient<HandleError>);
5046
5594
  /**
5047
- * @description remove screener preset
5048
- * @tags StockScreener
5049
- * @name RemoveScreenerPreset
5050
- * @summary remove screener preset
5051
- * @request DELETE:/stock-screener/presets
5595
+ * @description Returns article by id
5596
+ * @tags Passport
5597
+ * @name PassportArticleById
5598
+ * @summary Get article by id
5599
+ * @request POST:/passport/article-by-id
5052
5600
  * @secure
5053
5601
  */
5054
- removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5602
+ passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
5055
5603
  /**
5056
- * @description get top symbols
5057
- * @tags StockScreener
5058
- * @name GetTopSymbols
5059
- * @summary get top symbols
5060
- * @request POST:/stock-screener/top
5604
+ * @description Returns articles
5605
+ * @tags Passport
5606
+ * @name PassportArticles
5607
+ * @summary Get articles
5608
+ * @request POST:/passport/articles
5061
5609
  * @secure
5062
5610
  */
5063
- getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
5064
- }
5065
- export class Quotes<HandleError extends boolean = boolean> {
5066
- protected readonly apiClient: JwtClient<HandleError>;
5067
- constructor(apiClient: JwtClient<HandleError>);
5611
+ passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
5068
5612
  /**
5069
- * @description Get single historical quote
5070
- * @tags Quotes
5071
- * @name GitHistoricalQuote
5072
- * @summary Get single historical quote
5073
- * @request GET:/historical/quote
5613
+ * @description Returns author profile
5614
+ * @tags Passport
5615
+ * @name PassportAuthorProfile
5616
+ * @summary Get author profile
5617
+ * @request POST:/passport/author-profile
5074
5618
  * @secure
5075
5619
  */
5076
- gitHistoricalQuote(query: {
5077
- /** Symbol */
5078
- symbol: string;
5079
- /** Date */
5080
- date: string;
5081
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
5620
+ passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
5082
5621
  /**
5083
- * @description get quote history by symbol
5084
- * @tags Quotes
5085
- * @name GitQuoteHistory
5086
- * @summary Get quote history
5087
- * @request POST:/quote-history
5622
+ * @description Returns most popular tags
5623
+ * @tags Passport
5624
+ * @name PassportMostPopularTags
5625
+ * @summary Get most popular tags
5626
+ * @request POST:/passport/most-popular-tags
5088
5627
  * @secure
5089
5628
  */
5090
- gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
5629
+ passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
5091
5630
  /**
5092
- * @description Returns a list of quotes equity info for specified symbols.
5093
- * @tags Quotes
5094
- * @name GetQuotesEquityData
5095
- * @summary Get Quotes Equity data
5096
- * @request GET:/quotes/equity
5631
+ * @description Returns news feed
5632
+ * @tags Passport
5633
+ * @name PassportNewsFeed
5634
+ * @summary Get news feed
5635
+ * @request POST:/passport/newsfeed
5097
5636
  * @secure
5098
5637
  */
5099
- getQuotesEquityData(query: {
5100
- /** Comma separated symbols */
5101
- symbols: string;
5102
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
5103
- }
5104
- export class Intraday<HandleError extends boolean = boolean> {
5105
- protected readonly apiClient: JwtClient<HandleError>;
5106
- constructor(apiClient: JwtClient<HandleError>);
5638
+ passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
5107
5639
  /**
5108
- * @description Returns an array of intraday chart data values for the given ticker.
5109
- * @tags Intraday
5110
- * @name IntradayQuotes
5111
- * @summary Get an array of intraday chart data values for the given ticker
5112
- * @request POST:/intraday/quotes
5640
+ * @description Returns article by parameters
5641
+ * @tags Passport
5642
+ * @name PassportSearchArticle
5643
+ * @summary Search article by parameters
5644
+ * @request POST:/passport/search-article
5113
5645
  * @secure
5114
5646
  */
5115
- intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
5647
+ passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
5116
5648
  }
5117
5649
  export class PreIpoCompanies<HandleError extends boolean = boolean> {
5118
5650
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5331,7 +5863,7 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
5331
5863
  sort_order?: InsightGetInvestorParamsSortOrderEnum;
5332
5864
  /** sort field */
5333
5865
  sort_by?: InsightGetInvestorParamsSortByEnum;
5334
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
5866
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsWithInvestorIDResponse, HandleError>>;
5335
5867
  /**
5336
5868
  * @description get pre ipo company spv by id
5337
5869
  * @tags PreIPOCompanies
@@ -5345,7 +5877,7 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
5345
5877
  getInvestorByIdAndInvestorId(id: string, investorId: string, query?: {
5346
5878
  /** default is false, if true documents will be included in the response */
5347
5879
  include_documents?: boolean;
5348
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
5880
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetProIPOCompabySPVWithInvestorIDResponse, HandleError>>;
5349
5881
  /**
5350
5882
  * @description get pre ipo company spvs
5351
5883
  * @tags PreIPOCompanies
@@ -5389,361 +5921,288 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
5389
5921
  include_documents?: boolean;
5390
5922
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
5391
5923
  }
5392
- export class Logos<HandleError extends boolean = boolean> {
5924
+ export class Public<HandleError extends boolean = boolean> {
5393
5925
  protected readonly apiClient: JwtClient<HandleError>;
5394
5926
  constructor(apiClient: JwtClient<HandleError>);
5395
5927
  /**
5396
- * @description Returns converted logo for crypto symbol
5397
- * @tags Logos
5398
- * @name LogosConvertedCryptoSymbolLogo
5399
- * @summary Get converted logo for crypto symbol
5400
- * @request POST:/logos/converted-crypto-symbol-logo
5401
- * @secure
5402
- */
5403
- logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5404
- /**
5405
- * @description Returns converted logo for symbol
5406
- * @tags Logos
5407
- * @name LogosConvertedSymbolLogo
5408
- * @summary Get converted logo for symbol
5409
- * @request POST:/logos/converted-symbol-logo
5410
- * @secure
5411
- */
5412
- logosConvertedSymbolLogo(filter: InsightSymbolLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5413
- /**
5414
- * @description Returns logo for crypto symbol
5415
- * @tags Logos
5416
- * @name LogosCryptoSymbolLogo
5417
- * @summary Get logo for crypto symbol
5418
- * @request GET:/logos/crypto-symbol-logo
5419
- * @secure
5420
- */
5421
- logosCryptoSymbolLogo(query: {
5422
- /** Company symbol */
5423
- symbol: string;
5424
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError>>;
5425
- /**
5426
- * @description Returns direct logo for crypto symbol
5427
- * @tags Logos
5428
- * @name LogosDirectCryptoSymbolLogo
5429
- * @summary Get direct logo for crypto symbol
5430
- * @request GET:/logos/direct-crypto-symbol-logo
5431
- * @secure
5432
- */
5433
- logosDirectCryptoSymbolLogo(query: {
5434
- /** Company symbol */
5435
- symbol: string;
5436
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5437
- /**
5438
- * @description Returns direct logo for symbol
5439
- * @tags Logos
5440
- * @name LogosDirectSymbolLogo
5441
- * @summary Get direct logo for symbol
5442
- * @request GET:/logos/direct-symbol-logo
5443
- * @secure
5444
- */
5445
- logosDirectSymbolLogo(query: {
5446
- /** Company symbol */
5447
- symbol: string;
5448
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5449
- /**
5450
- * @description Returns logos for multiple symbols
5451
- * @tags Logos
5452
- * @name LogosMultipleCryptoSymbolLogo
5453
- * @summary Get logos for multiple symbols
5454
- * @request POST:/logos/multiple-crypto-symbol-logo
5455
- * @secure
5456
- */
5457
- logosMultipleCryptoSymbolLogo(filter: InsightMultipleCryptoLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse[], HandleError>>;
5458
- /**
5459
- * @description Returns logos for multiple symbol
5460
- * @tags Logos
5461
- * @name LogosMultipleSymbolLogos
5462
- * @summary Get logos for multiple symbols
5463
- * @request POST:/logos/multiple-symbol-logos
5464
- * @secure
5465
- */
5466
- logosMultipleSymbolLogos(filter: InsightMultipleSymbolLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse[], HandleError>>;
5467
- /**
5468
- * @description Returns links of socials logos for symbol
5469
- * @tags Logos
5470
- * @name LogosSocialSymbolLogos
5471
- * @summary Get social logos for symbol
5472
- * @request GET:/logos/social-symbol-logos
5473
- * @secure
5474
- */
5475
- logosSocialSymbolLogos(query: {
5476
- /** Company symbol */
5477
- symbol: string;
5478
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
5479
- /**
5480
- * @description Returns logos for company symbol
5481
- * @tags Logos
5482
- * @name LogosSymbolLogos
5483
- * @summary Get symbol logos
5484
- * @request GET:/logos/symbol-logos
5928
+ * @description Calculate estimated returns for selected symbols. Uses split adjusted prices
5929
+ * @tags Public
5930
+ * @name CalculateEstimatedReturns
5931
+ * @summary Calculate Estimated Returns
5932
+ * @request GET:/public/estimated-returns
5485
5933
  * @secure
5486
5934
  */
5487
- logosSymbolLogos(query: {
5488
- /** Company symbol */
5935
+ calculateEstimatedReturns(query: {
5936
+ /** Single symbol */
5489
5937
  symbol: string;
5490
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
5491
- }
5492
- export class Ipos<HandleError extends boolean = boolean> {
5493
- protected readonly apiClient: JwtClient<HandleError>;
5494
- constructor(apiClient: JwtClient<HandleError>);
5495
- /**
5496
- * @description get recent ipos info
5497
- * @tags Ipos
5498
- * @name PostRecent
5499
- * @summary get recent ipos info
5500
- * @request POST:/ipos/recent
5501
- * @secure
5502
- */
5503
- postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5938
+ /** Non-zero amount */
5939
+ amount: number;
5940
+ /** Start date for calculations */
5941
+ start_date: string;
5942
+ /** End date for calculations */
5943
+ end_date: string;
5944
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
5504
5945
  /**
5505
- * @description get upcoming ipos info
5506
- * @tags Ipos
5507
- * @name GetUpcoming
5508
- * @summary get upcoming ipos info
5509
- * @request GET:/ipos/upcoming
5510
- * @secure
5511
- */
5512
- getUpcoming(query: {
5513
- /** how many records to return. Max value is 50 */
5514
- limit: number;
5515
- /** how many records to skip */
5516
- offset: number;
5517
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5946
+ * @description Returns an expert forecast
5947
+ * @tags Public
5948
+ * @name ExpertForecast
5949
+ * @summary Expert forecast
5950
+ * @request GET:/public/expert-forecast
5951
+ * @secure
5952
+ */
5953
+ expertForecast(query: {
5954
+ /** Comma separated symbols */
5955
+ symbols: string;
5956
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
5518
5957
  /**
5519
- * @description get ipo info by symbol
5520
- * @tags Ipos
5521
- * @name GetIpos
5522
- * @summary get ipo info by symbol
5523
- * @request GET:/ipos/{symbol}
5958
+ * @description get fundamentals by symbol data
5959
+ * @tags Public
5960
+ * @name GetPublicFundamentalsBySymbolData
5961
+ * @summary get fundamentals by symbol data
5962
+ * @request GET:/public/fundamentals/{symbol}
5524
5963
  * @secure
5525
5964
  */
5526
- getIpos(symbol: string, query?: {
5527
- /** load quotes */
5528
- load_quotes?: boolean;
5529
- /** statuses */
5530
- statuses?: string[];
5531
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
5532
- }
5533
- export class MarketDates<HandleError extends boolean = boolean> {
5534
- protected readonly apiClient: JwtClient<HandleError>;
5535
- constructor(apiClient: JwtClient<HandleError>);
5965
+ getPublicFundamentalsBySymbolData(symbol: string, query: {
5966
+ /** Annual or quarterly */
5967
+ mode: string;
5968
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
5536
5969
  /**
5537
- * @description get market dates history
5538
- * @tags MarketDates
5539
- * @name GetMarketDatesHistory
5540
- * @summary get market dates history
5541
- * @request POST:/market-dates/history
5970
+ * @description Daily price history
5971
+ * @tags Public
5972
+ * @name DailyPriceHistory
5973
+ * @summary Daily price history
5974
+ * @request GET:/public/price-history/daily
5542
5975
  * @secure
5543
5976
  */
5544
- getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
5977
+ dailyPriceHistory(query: {
5978
+ /** Single symbol */
5979
+ symbol: string;
5980
+ /** Target date */
5981
+ date: string;
5982
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
5545
5983
  /**
5546
- * @description get todays market hours
5547
- * @tags MarketDates
5548
- * @name GetTodaysMarketHours
5549
- * @summary get todays market hours
5550
- * @request GET:/market-dates/today
5984
+ * @description Public quote profile
5985
+ * @tags Public
5986
+ * @name PublicQuoteProfile
5987
+ * @summary Public quote profile
5988
+ * @request GET:/public/quote-profile/{symbol}
5551
5989
  * @secure
5552
5990
  */
5553
- getTodaysMarketHours(query: {
5554
- /** Market */
5555
- market: string;
5556
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
5557
- }
5558
- export class News<HandleError extends boolean = boolean> {
5559
- protected readonly apiClient: JwtClient<HandleError>;
5560
- constructor(apiClient: JwtClient<HandleError>);
5991
+ publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
5561
5992
  /**
5562
- * @description Returns available authors in DB
5563
- * @tags News
5564
- * @name NewsAvailableAuthors
5565
- * @summary Get available authors in DB (for filters)
5566
- * @request POST:/news/authors
5993
+ * @description get ratios by symbol data
5994
+ * @tags Public
5995
+ * @name GetPublicRatiosBySymbolData
5996
+ * @summary get ratios by symbol data
5997
+ * @request GET:/public/ratios/{symbol}
5567
5998
  * @secure
5568
5999
  */
5569
- newsAvailableAuthors(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
6000
+ getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
5570
6001
  /**
5571
- * @description Returns available channels in DB
5572
- * @tags News
5573
- * @name NewsAvailableChannels
5574
- * @summary Get available channels in DB (for filters)
5575
- * @request POST:/news/channels
6002
+ * @description find a symbol by name or description
6003
+ * @tags Public
6004
+ * @name QuoteFundamentalsSearch
6005
+ * @summary find a symbol by name or description
6006
+ * @request GET:/public/symbol-search
5576
6007
  * @secure
5577
6008
  */
5578
- newsAvailableChannels(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
6009
+ quoteFundamentalsSearch(query: {
6010
+ /** Search query */
6011
+ search_query: string;
6012
+ /** how many records to return. Max value is 50 */
6013
+ limit: number;
6014
+ /** how many records to skip */
6015
+ offset: number;
6016
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
5579
6017
  /**
5580
- * @description Get featured articles
5581
- * @tags News
5582
- * @name GetFeaturedArticles
5583
- * @summary Get featured articles
5584
- * @request GET:/news/featured-articles
6018
+ * @description Get top gainers
6019
+ * @tags Public
6020
+ * @name TopGainers
6021
+ * @summary Top Gainers
6022
+ * @request GET:/public/top-gainers
5585
6023
  * @secure
5586
6024
  */
5587
- getFeaturedArticles(query: {
5588
- /** Limit */
6025
+ topGainers(query: {
6026
+ /** sort direction - asc or desc */
6027
+ order_direction?: string;
6028
+ /** how many records to return. Max value is 50 */
5589
6029
  limit: number;
5590
- /** Offset */
6030
+ /** how many records to skip */
5591
6031
  offset: number;
5592
- /** Start date */
5593
- start_date?: string;
5594
- /** End date */
5595
- end_date?: string;
5596
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
6032
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
5597
6033
  /**
5598
- * @description Update featured articles
5599
- * @tags News
5600
- * @name UpdateFeaturedArticles
5601
- * @summary Update featured articles
5602
- * @request PUT:/news/featured-articles
6034
+ * @description Get top stocks
6035
+ * @tags Public
6036
+ * @name TopStocks
6037
+ * @summary Top Stocks
6038
+ * @request GET:/public/top-stocks
5603
6039
  * @secure
5604
6040
  */
5605
- updateFeaturedArticles(input: InsightUpdateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6041
+ topStocks(query: {
6042
+ /** EQUITY|ETF|CRYPTO */
6043
+ stock_type: InsightTopStocksParamsStockTypeEnum;
6044
+ /** how many records to return. Max value is 50 */
6045
+ limit: number;
6046
+ /** how many records to skip */
6047
+ offset: number;
6048
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
6049
+ }
6050
+ export class Quotes<HandleError extends boolean = boolean> {
6051
+ protected readonly apiClient: JwtClient<HandleError>;
6052
+ constructor(apiClient: JwtClient<HandleError>);
5606
6053
  /**
5607
- * @description Create featured articles
5608
- * @tags News
5609
- * @name CreateFeaturedArticles
5610
- * @summary Create featured articles
5611
- * @request POST:/news/featured-articles
6054
+ * @description Get single historical quote
6055
+ * @tags Quotes
6056
+ * @name GitHistoricalQuote
6057
+ * @summary Get single historical quote
6058
+ * @request GET:/historical/quote
5612
6059
  * @secure
5613
6060
  */
5614
- createFeaturedArticles(input: InsightCreateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6061
+ gitHistoricalQuote(query: {
6062
+ /** Symbol */
6063
+ symbol: string;
6064
+ /** Date */
6065
+ date: string;
6066
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
5615
6067
  /**
5616
- * @description Get active featured articles
5617
- * @tags News
5618
- * @name GetActiveFeaturedArticles
5619
- * @summary Get active featured articles
5620
- * @request GET:/news/featured-articles/active
6068
+ * @description get quote history by symbol
6069
+ * @tags Quotes
6070
+ * @name GitQuoteHistory
6071
+ * @summary Get quote history
6072
+ * @request POST:/quote-history
5621
6073
  * @secure
5622
6074
  */
5623
- getActiveFeaturedArticles(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
6075
+ gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
5624
6076
  /**
5625
- * @description Set featured articles
5626
- * @tags News
5627
- * @name SetFeaturedArticles
5628
- * @summary Set featured articles
5629
- * @request POST:/news/featured-articles/set
6077
+ * @description Returns a list of quotes equity info for specified symbols.
6078
+ * @tags Quotes
6079
+ * @name GetQuotesEquityData
6080
+ * @summary Get Quotes Equity data
6081
+ * @request GET:/quotes/equity
5630
6082
  * @secure
5631
6083
  */
5632
- setFeaturedArticles(input: InsightSetFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6084
+ getQuotesEquityData(query: {
6085
+ /** Comma separated symbols */
6086
+ symbols: string;
6087
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
6088
+ }
6089
+ export class StockScreener<HandleError extends boolean = boolean> {
6090
+ protected readonly apiClient: JwtClient<HandleError>;
6091
+ constructor(apiClient: JwtClient<HandleError>);
5633
6092
  /**
5634
- * @description Get featured article
5635
- * @tags News
5636
- * @name GetFeaturedArticle
5637
- * @summary Get featured article
5638
- * @request GET:/news/featured-articles/{id}
6093
+ * @description data for visual heat map
6094
+ * @tags StockScreener
6095
+ * @name StockMarketHeatmap
6096
+ * @summary data for visual heat map
6097
+ * @request GET:/heatmaps
5639
6098
  * @secure
5640
6099
  */
5641
- getFeaturedArticle(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticle, HandleError>>;
6100
+ stockMarketHeatmap(query?: {
6101
+ /** Name of symbol list to fetch details for. Empty is default */
6102
+ heatmap_name?: string;
6103
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
5642
6104
  /**
5643
- * @description Returns news by filters
5644
- * @tags News
5645
- * @name NewsFiltered
5646
- * @summary Get filtered news
5647
- * @request POST:/news/filter
6105
+ * @description create or update heat map preset
6106
+ * @tags StockScreener
6107
+ * @name CreateStockMarketHeatmapPreset
6108
+ * @summary create or update heat map preset
6109
+ * @request POST:/heatmaps
5648
6110
  * @secure
5649
6111
  */
5650
- newsFiltered(filter: InsightNewsFilterRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsResponse, HandleError>>;
6112
+ createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5651
6113
  /**
5652
- * @description Returns news by id
5653
- * @tags News
5654
- * @name NewsById
5655
- * @summary Get news by id
5656
- * @request POST:/news/id
6114
+ * @description Sector and Industry Group performance
6115
+ * @tags StockScreener
6116
+ * @name IndustriesPerformance
6117
+ * @summary get industries performance
6118
+ * @request POST:/industries-performance
5657
6119
  * @secure
5658
6120
  */
5659
- newsById(filter: InsightNewsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNews, HandleError>>;
6121
+ industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
5660
6122
  /**
5661
- * @description Returns news previews
5662
- * @tags News
5663
- * @name NewsPreviewsFiltered
5664
- * @summary Get news previews
5665
- * @request GET:/news/previews
6123
+ * @description filter stocks by params
6124
+ * @tags StockScreener
6125
+ * @name StockScreener
6126
+ * @summary filter stocks by params
6127
+ * @request POST:/stock-screener
5666
6128
  * @secure
5667
6129
  */
5668
- newsPreviewsFiltered(query: {
5669
- /** Start date */
5670
- start_date?: string;
5671
- /** End date */
5672
- end_date?: string;
5673
- /** Symbol */
5674
- symbol?: string;
5675
- /** how many records to return. Max value is 50 */
6130
+ stockScreener(filter: InsightStockScreenerV1Request, headers?: {
6131
+ /** Authorization */
6132
+ Authorization?: string;
6133
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
6134
+ /**
6135
+ * @description get screener presets
6136
+ * @tags StockScreener
6137
+ * @name GetScreenerPresets
6138
+ * @summary get screener presets
6139
+ * @request GET:/stock-screener/presets
6140
+ * @secure
6141
+ */
6142
+ getScreenerPresets(query: {
6143
+ /** how many records to return */
5676
6144
  limit: number;
5677
6145
  /** how many records to skip */
5678
6146
  offset: number;
5679
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRecentNewsPreviewsResponse, HandleError>>;
6147
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
5680
6148
  /**
5681
- * @description Returns available stocks in DB
5682
- * @tags News
5683
- * @name NewsAvailableStocks
5684
- * @summary Get available stocks in DB (for filters)
5685
- * @request GET:/news/symbols
6149
+ * @description update screener preset
6150
+ * @tags StockScreener
6151
+ * @name UpdateScreenerPreset
6152
+ * @summary update screener preset
6153
+ * @request PUT:/stock-screener/presets
5686
6154
  * @secure
5687
6155
  */
5688
- newsAvailableStocks(query?: {
5689
- /** Limit */
5690
- limit?: number;
5691
- /** Offset */
5692
- offset?: number;
5693
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
6156
+ updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5694
6157
  /**
5695
- * @description Returns available tags in DB
5696
- * @tags News
5697
- * @name NewsAvailableTags
5698
- * @summary Get available tags in DB (for filters)
5699
- * @request POST:/news/tags
6158
+ * @description create screener preset
6159
+ * @tags StockScreener
6160
+ * @name CreateOrScreenerPreset
6161
+ * @summary create screener preset
6162
+ * @request POST:/stock-screener/presets
5700
6163
  * @secure
5701
6164
  */
5702
- newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5703
- }
5704
- export class Ownerships<HandleError extends boolean = boolean> {
5705
- protected readonly apiClient: JwtClient<HandleError>;
5706
- constructor(apiClient: JwtClient<HandleError>);
6165
+ createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5707
6166
  /**
5708
- * @description get ownerships by id datadata
5709
- * @tags Ownerships
5710
- * @name GetOwnershipsByIdData
5711
- * @summary get ownerships by id data
5712
- * @request POST:/ownerships
6167
+ * @description remove screener preset
6168
+ * @tags StockScreener
6169
+ * @name RemoveScreenerPreset
6170
+ * @summary remove screener preset
6171
+ * @request DELETE:/stock-screener/presets
5713
6172
  * @secure
5714
6173
  */
5715
- getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
6174
+ removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5716
6175
  /**
5717
- * @description get ownerships by symbol data
5718
- * @tags Ownerships
5719
- * @name GetOwnershipsBySymbolData
5720
- * @summary get ownerships by symbol data
5721
- * @request POST:/symbol-ownerships
6176
+ * @description get top symbols
6177
+ * @tags StockScreener
6178
+ * @name GetTopSymbols
6179
+ * @summary get top symbols
6180
+ * @request POST:/stock-screener/top
5722
6181
  * @secure
5723
6182
  */
5724
- getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
6183
+ getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
5725
6184
  }
5726
- export class AlphaTools<HandleError extends boolean = boolean> {
6185
+ export class StockScreenerV2<HandleError extends boolean = boolean> {
5727
6186
  protected readonly apiClient: JwtClient<HandleError>;
5728
6187
  constructor(apiClient: JwtClient<HandleError>);
5729
6188
  /**
5730
- * @description get seasonlity data with comparison to benchmark
5731
- * @tags AlphaTools
5732
- * @name GetMomentumRatioGraph
5733
- * @summary get seasonlity data
5734
- * @request POST:/rst
6189
+ * @description filter stocks by params
6190
+ * @tags StockScreener
6191
+ * @name StockScreener
6192
+ * @summary filter stocks by params
6193
+ * @request POST:/stock-screener
5735
6194
  * @secure
5736
6195
  */
5737
- getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
6196
+ stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
5738
6197
  /**
5739
- * @description get seasonlity data with comparison to benchmark
5740
- * @tags AlphaTools
5741
- * @name GetSeasonality
5742
- * @summary get seasonlity data
5743
- * @request POST:/seasonality
6198
+ * @description get top symbols
6199
+ * @tags StockScreener
6200
+ * @name GetTopSymbols
6201
+ * @summary get top symbols
6202
+ * @request POST:/stock-screener/top
5744
6203
  * @secure
5745
6204
  */
5746
- getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
6205
+ getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
5747
6206
  }
5748
6207
  export class TipRank<HandleError extends boolean = boolean> {
5749
6208
  protected readonly apiClient: JwtClient<HandleError>;
@@ -6063,532 +6522,248 @@ export class TipRank<HandleError extends boolean = boolean> {
6063
6522
  * @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.
6064
6523
  * @tags TipRank
6065
6524
  * @name TiprankStocksTopMovers
6066
- * @summary Get tiprank StocksTopMovers
6067
- * @request GET:/tipranks/stocks-top-movers
6068
- * @secure
6069
- */
6070
- tiprankStocksTopMovers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksTopMoversResponse[], HandleError>>;
6071
- /**
6072
- * @description Returns the stock symbols covered by TipRanks.
6073
- * @tags TipRank
6074
- * @name TiprankSupportedTickers
6075
- * @summary Get tiprank SupportedTickers
6076
- * @request GET:/tipranks/supported-tickers
6077
- * @secure
6078
- */
6079
- tiprankSupportedTickers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSupportedTickersResponse, HandleError>>;
6080
- /**
6081
- * @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).
6082
- * @tags TipRank
6083
- * @name TiprankTopRateStocks
6084
- * @summary Get tiprank TopRateStocks
6085
- * @request GET:/tipranks/top-rate-stocks
6086
- * @secure
6087
- */
6088
- tiprankTopRateStocks(query?: {
6089
- /** Return the most trending X stocks */
6090
- num?: number;
6091
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopRateStocksResponse, HandleError>>;
6092
- /**
6093
- * @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.
6094
- * @tags TipRank
6095
- * @name TiprankTopStocksBySectors
6096
- * @summary Get tiprank TopStocksBySectors
6097
- * @request POST:/tipranks/top-stocks-by-sectors
6098
- * @secure
6099
- */
6100
- tiprankTopStocksBySectors(filter: InsightTopStocksBySectorsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksBySectorsResponse, HandleError>>;
6101
- /**
6102
- * @description Returns a list of stocks with the highest number of analyst ratings in the last 7 days.
6103
- * @tags TipRank
6104
- * @name TiprankTrendingStocks
6105
- * @summary Get tiprank TrendingStocks
6106
- * @request POST:/tipranks/trending-stocks
6107
- * @secure
6108
- */
6109
- tiprankTrendingStocks(filter: InsightTrendingStocksRequest, headers?: {
6110
- /** Authorization */
6111
- Authorization?: string;
6112
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
6113
- }
6114
- export class UsageTracking<HandleError extends boolean = boolean> {
6115
- protected readonly apiClient: JwtClient<HandleError>;
6116
- constructor(apiClient: JwtClient<HandleError>);
6117
- /**
6118
- * @description get usage date per branch for a period
6119
- * @tags UsageTracking
6120
- * @name GetUsageData
6121
- * @summary get insight usage data
6122
- * @request POST:/tracking/usage
6123
- * @secure
6124
- */
6125
- getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
6126
- }
6127
- export class Passport<HandleError extends boolean = boolean> {
6128
- protected readonly apiClient: JwtClient<HandleError>;
6129
- constructor(apiClient: JwtClient<HandleError>);
6130
- /**
6131
- * @description Returns article by id
6132
- * @tags Passport
6133
- * @name PassportArticleById
6134
- * @summary Get article by id
6135
- * @request POST:/passport/article-by-id
6136
- * @secure
6137
- */
6138
- passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
6139
- /**
6140
- * @description Returns articles
6141
- * @tags Passport
6142
- * @name PassportArticles
6143
- * @summary Get articles
6144
- * @request POST:/passport/articles
6145
- * @secure
6146
- */
6147
- passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
6148
- /**
6149
- * @description Returns author profile
6150
- * @tags Passport
6151
- * @name PassportAuthorProfile
6152
- * @summary Get author profile
6153
- * @request POST:/passport/author-profile
6154
- * @secure
6155
- */
6156
- passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
6157
- /**
6158
- * @description Returns most popular tags
6159
- * @tags Passport
6160
- * @name PassportMostPopularTags
6161
- * @summary Get most popular tags
6162
- * @request POST:/passport/most-popular-tags
6163
- * @secure
6164
- */
6165
- passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
6166
- /**
6167
- * @description Returns news feed
6168
- * @tags Passport
6169
- * @name PassportNewsFeed
6170
- * @summary Get news feed
6171
- * @request POST:/passport/newsfeed
6172
- * @secure
6173
- */
6174
- passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
6175
- /**
6176
- * @description Returns article by parameters
6177
- * @tags Passport
6178
- * @name PassportSearchArticle
6179
- * @summary Search article by parameters
6180
- * @request POST:/passport/search-article
6181
- * @secure
6182
- */
6183
- passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
6184
- }
6185
- export class OptionGreeks<HandleError extends boolean = boolean> {
6186
- protected readonly apiClient: JwtClient<HandleError>;
6187
- constructor(apiClient: JwtClient<HandleError>);
6188
- /**
6189
- * @description Returns calculated matrix
6190
- * @tags OptionGreeks
6191
- * @name OgCalculateMatrix
6192
- * @summary Calculate matrix
6193
- * @request POST:/og/calculate-matrix
6194
- * @secure
6195
- */
6196
- ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
6197
- /**
6198
- * @description Returns calculated params
6199
- * @tags OptionGreeks
6200
- * @name OgCalculateParams
6201
- * @summary Calculate params
6202
- * @request POST:/og/calculate-params
6203
- * @secure
6204
- */
6205
- ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
6206
- }
6207
- export class Public<HandleError extends boolean = boolean> {
6208
- protected readonly apiClient: JwtClient<HandleError>;
6209
- constructor(apiClient: JwtClient<HandleError>);
6210
- /**
6211
- * @description Calculate estimated returns for selected symbols. Uses split adjusted prices
6212
- * @tags Public
6213
- * @name CalculateEstimatedReturns
6214
- * @summary Calculate Estimated Returns
6215
- * @request GET:/public/estimated-returns
6216
- * @secure
6217
- */
6218
- calculateEstimatedReturns(query: {
6219
- /** Single symbol */
6220
- symbol: string;
6221
- /** Non-zero amount */
6222
- amount: number;
6223
- /** Start date for calculations */
6224
- start_date: string;
6225
- /** End date for calculations */
6226
- end_date: string;
6227
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
6525
+ * @summary Get tiprank StocksTopMovers
6526
+ * @request GET:/tipranks/stocks-top-movers
6527
+ * @secure
6528
+ */
6529
+ tiprankStocksTopMovers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksTopMoversResponse[], HandleError>>;
6228
6530
  /**
6229
- * @description Returns an expert forecast
6230
- * @tags Public
6231
- * @name ExpertForecast
6232
- * @summary Expert forecast
6233
- * @request GET:/public/expert-forecast
6531
+ * @description Returns the stock symbols covered by TipRanks.
6532
+ * @tags TipRank
6533
+ * @name TiprankSupportedTickers
6534
+ * @summary Get tiprank SupportedTickers
6535
+ * @request GET:/tipranks/supported-tickers
6234
6536
  * @secure
6235
6537
  */
6236
- expertForecast(query: {
6237
- /** Comma separated symbols */
6238
- symbols: string;
6239
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
6538
+ tiprankSupportedTickers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSupportedTickersResponse, HandleError>>;
6240
6539
  /**
6241
- * @description get fundamentals by symbol data
6242
- * @tags Public
6243
- * @name GetPublicFundamentalsBySymbolData
6244
- * @summary get fundamentals by symbol data
6245
- * @request GET:/public/fundamentals/{symbol}
6540
+ * @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).
6541
+ * @tags TipRank
6542
+ * @name TiprankTopRateStocks
6543
+ * @summary Get tiprank TopRateStocks
6544
+ * @request GET:/tipranks/top-rate-stocks
6246
6545
  * @secure
6247
6546
  */
6248
- getPublicFundamentalsBySymbolData(symbol: string, query: {
6249
- /** Annual or quarterly */
6250
- mode: string;
6251
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
6547
+ tiprankTopRateStocks(query?: {
6548
+ /** Return the most trending X stocks */
6549
+ num?: number;
6550
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopRateStocksResponse, HandleError>>;
6252
6551
  /**
6253
- * @description Daily price history
6254
- * @tags Public
6255
- * @name DailyPriceHistory
6256
- * @summary Daily price history
6257
- * @request GET:/public/price-history/daily
6552
+ * @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.
6553
+ * @tags TipRank
6554
+ * @name TiprankTopStocksBySectors
6555
+ * @summary Get tiprank TopStocksBySectors
6556
+ * @request POST:/tipranks/top-stocks-by-sectors
6258
6557
  * @secure
6259
6558
  */
6260
- dailyPriceHistory(query: {
6261
- /** Single symbol */
6262
- symbol: string;
6263
- /** Target date */
6264
- date: string;
6265
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
6559
+ tiprankTopStocksBySectors(filter: InsightTopStocksBySectorsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksBySectorsResponse, HandleError>>;
6266
6560
  /**
6267
- * @description Public quote profile
6268
- * @tags Public
6269
- * @name PublicQuoteProfile
6270
- * @summary Public quote profile
6271
- * @request GET:/public/quote-profile/{symbol}
6561
+ * @description Returns a list of stocks with the highest number of analyst ratings in the last 7 days.
6562
+ * @tags TipRank
6563
+ * @name TiprankTrendingStocks
6564
+ * @summary Get tiprank TrendingStocks
6565
+ * @request POST:/tipranks/trending-stocks
6272
6566
  * @secure
6273
6567
  */
6274
- publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
6568
+ tiprankTrendingStocks(filter: InsightTrendingStocksRequest, headers?: {
6569
+ /** Authorization */
6570
+ Authorization?: string;
6571
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
6572
+ }
6573
+ export class UsageTracking<HandleError extends boolean = boolean> {
6574
+ protected readonly apiClient: JwtClient<HandleError>;
6575
+ constructor(apiClient: JwtClient<HandleError>);
6275
6576
  /**
6276
- * @description get ratios by symbol data
6277
- * @tags Public
6278
- * @name GetPublicRatiosBySymbolData
6279
- * @summary get ratios by symbol data
6280
- * @request GET:/public/ratios/{symbol}
6577
+ * @description get usage date per branch for a period
6578
+ * @tags UsageTracking
6579
+ * @name GetUsageData
6580
+ * @summary get insight usage data
6581
+ * @request POST:/tracking/usage
6281
6582
  * @secure
6282
6583
  */
6283
- getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
6584
+ getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
6585
+ }
6586
+ export class WorldMarkets<HandleError extends boolean = boolean> {
6587
+ protected readonly apiClient: JwtClient<HandleError>;
6588
+ constructor(apiClient: JwtClient<HandleError>);
6284
6589
  /**
6285
- * @description find a symbol by name or description
6286
- * @tags Public
6287
- * @name QuoteFundamentalsSearch
6288
- * @summary find a symbol by name or description
6289
- * @request GET:/public/symbol-search
6590
+ * @description Get continents
6591
+ * @tags World Markets
6592
+ * @name ContinentGet
6593
+ * @summary Get continents
6594
+ * @request GET:/continents
6290
6595
  * @secure
6291
6596
  */
6292
- quoteFundamentalsSearch(query: {
6293
- /** Search query */
6294
- search_query: string;
6295
- /** how many records to return. Max value is 50 */
6597
+ continentGet(query: {
6598
+ /** Query limit */
6296
6599
  limit: number;
6297
- /** how many records to skip */
6600
+ /** Query offset */
6298
6601
  offset: number;
6299
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
6602
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
6300
6603
  /**
6301
- * @description Get top gainers
6302
- * @tags Public
6303
- * @name TopGainers
6304
- * @summary Top Gainers
6305
- * @request GET:/public/top-gainers
6604
+ * @description Edit continent
6605
+ * @tags World Markets
6606
+ * @name ContinentEdit
6607
+ * @summary Edit continent
6608
+ * @request PUT:/continents
6306
6609
  * @secure
6307
6610
  */
6308
- topGainers(query: {
6309
- /** sort direction - asc or desc */
6310
- order_direction?: string;
6311
- /** how many records to return. Max value is 50 */
6312
- limit: number;
6313
- /** how many records to skip */
6314
- offset: number;
6315
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
6611
+ continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6316
6612
  /**
6317
- * @description Get top stocks
6318
- * @tags Public
6319
- * @name TopStocks
6320
- * @summary Top Stocks
6321
- * @request GET:/public/top-stocks
6613
+ * @description Create continents
6614
+ * @tags World Markets
6615
+ * @name ContinentCreate
6616
+ * @summary Create continents
6617
+ * @request POST:/continents
6322
6618
  * @secure
6323
6619
  */
6324
- topStocks(query: {
6325
- /** EQUITY|ETF|CRYPTO */
6326
- stock_type: InsightTopStocksParamsStockTypeEnum;
6327
- /** how many records to return. Max value is 50 */
6328
- limit: number;
6329
- /** how many records to skip */
6330
- offset: number;
6331
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
6332
- }
6333
- export interface InsightBeforeAndAfterV2 {
6334
- after?: string;
6335
- before?: string;
6336
- }
6337
- export interface InsightFixedIncomeV2 {
6338
- a144: boolean;
6339
- accrued_interest: number;
6340
- bank_qualified: boolean;
6341
- bond_warrant: boolean;
6342
- call_type: string;
6343
- callable: boolean;
6344
- close_price: number;
6345
- close_price_asof: string;
6346
- close_ytw: number;
6347
- convertible: boolean;
6348
- country: string;
6349
- country_code: string;
6350
- country_domicile: string;
6351
- country_issue: string;
6352
- coupon: number;
6353
- coupon_frequency: string;
6354
- coupon_type: string;
6355
- currency: string;
6356
- cusip: string;
6357
- dated_date: string;
6358
- daycount: string;
6359
- description: string;
6360
- description_short: string;
6361
- duration: number;
6362
- first_coupon_date: string;
6363
- insured: boolean;
6364
- isin: string;
6365
- issue_date: string;
6366
- issue_minimum_denomination: number;
6367
- issue_price: number;
6368
- issue_size: number;
6369
- issuer: string;
6370
- last_coupon_date: string;
6371
- liquidity_institutional_aggregate: number;
6372
- liquidity_institutional_buy: number;
6373
- liquidity_institutional_sell: number;
6374
- liquidity_micro_aggregate: number;
6375
- liquidity_micro_buy: number;
6376
- liquidity_micro_sell: number;
6377
- liquidity_retail_aggregate: number;
6378
- liquidity_retail_buy: number;
6379
- liquidity_retail_sell: number;
6380
- maturity_date: string;
6381
- municipal_state: string;
6382
- municipal_taxable_federal: boolean;
6383
- municipal_type: string;
6384
- next_call_date: string;
6385
- next_call_price: number;
6386
- next_coupon_date: string;
6387
- par_value: number;
6388
- perpetual: boolean;
6389
- private_placement: boolean;
6390
- purpose: string;
6391
- puttable: boolean;
6392
- reg_s: boolean;
6393
- sector: string;
6394
- seniority: string;
6395
- settlement_convention: string;
6396
- sinking_fund: boolean;
6397
- sp_creditwatch: string;
6398
- sp_creditwatch_date: string;
6399
- sp_outlook: string;
6400
- sp_outlook_date: string;
6401
- sp_rating: string;
6402
- sp_rating_date: string;
6403
- status: string;
6404
- ticker: string;
6405
- treasury_subtype: string;
6406
- type: string;
6407
- updated_at: string;
6408
- }
6409
- export interface InsightGetFixedIncomeEntriesResponseV2 {
6410
- count: number;
6411
- data: InsightFixedIncomeV2[];
6412
- }
6413
- export interface InsightGetFixedIncomeEntriesRequestV2 {
6414
- /** @example true */
6415
- bank_qualified?: boolean;
6416
- /** @example true */
6417
- callable?: boolean;
6418
- /** @example true */
6419
- convertible?: boolean;
6420
- /** @example ["USA"] */
6421
- country_codes?: string[];
6422
- coupon?: InsightLessAndMoreV2;
6423
- /** @example ["quarterly","zero"] */
6424
- coupon_frequencies?: string[];
6425
- /** @example ["655664AH3","9128286R6"] */
6426
- cusip?: string[];
6620
+ continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
6621
+ /**
6622
+ * @description Delete continent
6623
+ * @tags World Markets
6624
+ * @name ContinentDelete
6625
+ * @summary Delete continent
6626
+ * @request DELETE:/continents
6627
+ * @secure
6628
+ */
6629
+ continentDelete(query: {
6630
+ /** continent id */
6631
+ id: string;
6632
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6633
+ /**
6634
+ * @description Get country codes
6635
+ * @tags World Markets
6636
+ * @name CountryCodeGet
6637
+ * @summary Get country codes
6638
+ * @request GET:/country-codes
6639
+ * @secure
6640
+ */
6641
+ countryCodeGet(query: {
6642
+ /** Query limit */
6643
+ limit: number;
6644
+ /** Query offset */
6645
+ offset: number;
6646
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
6427
6647
  /**
6428
- * @maxLength 100
6429
- * @example "Donald's"
6648
+ * @description Edit country code
6649
+ * @tags World Markets
6650
+ * @name CountryCodeEdit
6651
+ * @summary Edit country code
6652
+ * @request PUT:/country-codes
6653
+ * @secure
6430
6654
  */
6431
- description?: string;
6432
- /** @example true */
6433
- has_ticker?: boolean;
6434
- /** @example true */
6435
- insured?: boolean;
6436
- /** @example ["US655664AH33","US9128286R69"] */
6437
- isin?: string[];
6438
- issue_date?: InsightBeforeAndAfterV2;
6655
+ countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6439
6656
  /**
6440
- * @maxLength 100
6441
- * @example "Donald's"
6657
+ * @description Add country codes
6658
+ * @tags World Markets
6659
+ * @name CountryCodeAdd
6660
+ * @summary Add country codes
6661
+ * @request POST:/country-codes
6662
+ * @secure
6442
6663
  */
6443
- issuer?: string;
6444
- maturity?: InsightBeforeAndAfterV2;
6445
- /** @example ["NY"] */
6446
- municipal_states?: string[];
6447
- /** @example true */
6448
- municipal_tax?: boolean;
6449
- /** @example ["general_obligation"] */
6450
- municipal_types?: string[];
6451
- pagination: InsightPaginationV2;
6452
- purposes?: string[];
6453
- /** @example ["SOVEREIGN"] */
6454
- sectors?: string[];
6455
- sorts?: InsightOrderingV2[];
6456
- /** @example ["AAA"] */
6457
- sp_ratings?: string[];
6458
- /** @example ["called","outstanding"] */
6459
- statuses?: string[];
6460
- tickers?: string[];
6461
- /** @example ["corporate"] */
6462
- types?: string[];
6463
- }
6464
- export interface InsightGetTopSymbolsRequestV2 {
6465
- exchange?: string[];
6466
- market_cap?: InsightLessAndMoreV2;
6467
- pagination?: InsightPaginationV2;
6468
- price?: InsightLessAndMoreV2;
6469
- sorts?: InsightOrderingV2[];
6470
- volume?: InsightLessAndMoreV2;
6471
- }
6472
- export interface InsightIncludeExcludeV2 {
6473
- exclude?: string[];
6474
- include?: string[];
6475
- }
6476
- export interface InsightLessAndMoreV2 {
6477
- less_than?: number;
6478
- more_than?: number;
6479
- }
6480
- export interface InsightOrderingV2 {
6664
+ countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
6481
6665
  /**
6482
- * @default "asc"
6483
- * @example "asc"
6666
+ * @description Delete country code
6667
+ * @tags World Markets
6668
+ * @name CountryCodeDelete
6669
+ * @summary Delete country code
6670
+ * @request DELETE:/country-codes
6671
+ * @secure
6484
6672
  */
6485
- direction: InsightOrderingDirectionEnumV2;
6673
+ countryCodeDelete(query: {
6674
+ /** a3 code */
6675
+ a3code: string;
6676
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6486
6677
  /**
6487
- * Sort direction:
6488
- * * asc - Ascending, from A to Z.
6489
- * * desc - Descending, from Z to A.
6490
- * @example "name"
6678
+ * @description Get global indexes
6679
+ * @tags World Markets
6680
+ * @name GlobalIndexGet
6681
+ * @summary Get global indexes
6682
+ * @request GET:/global-indexes
6683
+ * @secure
6491
6684
  */
6492
- field: string;
6493
- }
6494
- export interface InsightPaginationV2 {
6685
+ globalIndexGet(query: {
6686
+ /** Query limit */
6687
+ limit: number;
6688
+ /** Query offset */
6689
+ offset: number;
6690
+ /** Continent code for filtering */
6691
+ continent?: string;
6692
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
6495
6693
  /**
6496
- * @min 1
6497
- * @example 1
6694
+ * @description Edit global index
6695
+ * @tags World Markets
6696
+ * @name GlobalIndexEdit
6697
+ * @summary Edit global index
6698
+ * @request PUT:/global-indexes
6699
+ * @secure
6498
6700
  */
6499
- page: number;
6701
+ globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6500
6702
  /**
6501
- * @min 1
6502
- * @max 50
6503
- * @example 10
6703
+ * @description Add global indexes
6704
+ * @tags World Markets
6705
+ * @name GlobalIndexAdd
6706
+ * @summary Add global indexes
6707
+ * @request POST:/global-indexes
6708
+ * @secure
6504
6709
  */
6505
- size: number;
6506
- }
6507
- export interface InsightStockScreenerQuoteV2 {
6508
- average_volume_30d: number;
6509
- company_name: string;
6510
- dividend_ex_date: string;
6511
- dividend_pay_date: string;
6512
- dividend_percent: number;
6513
- exchange: string;
6514
- exchange_name: string;
6515
- gap: number;
6516
- industry: string;
6517
- industry_code: string;
6518
- last_price: number;
6519
- market_cap: number;
6520
- pe_ratio: number;
6521
- price_change: number;
6522
- price_change_percent: number;
6523
- symbol: string;
6524
- volume: number;
6525
- }
6526
- export interface InsightStockScreenerRequestV2 {
6527
- average_volume_30d?: InsightLessAndMoreV2;
6528
- dividend_ex_date?: InsightBeforeAndAfterV2;
6529
- dividend_pay_date?: InsightBeforeAndAfterV2;
6530
- dividend_percent?: InsightLessAndMoreV2;
6531
- exchange?: InsightIncludeExcludeV2;
6532
- gap?: InsightLessAndMoreV2;
6533
- industry?: InsightIncludeExcludeV2;
6534
- market_cap?: InsightLessAndMoreV2;
6535
- pagination: InsightPaginationV2;
6536
- pe_ratio?: InsightLessAndMoreV2;
6537
- price?: InsightLessAndMoreV2;
6538
- sorts?: InsightOrderingV2[];
6539
- /** @example "ADR" */
6540
- stock_type?: string;
6541
- volume?: InsightLessAndMoreV2;
6542
- }
6543
- export interface InsightStockScreenerResponseV2 {
6544
- current_page: number;
6545
- data: InsightStockScreenerQuoteV2[];
6546
- page_count: number;
6547
- status: number;
6548
- total_records: number;
6549
- }
6550
- /**
6551
- * @default "asc"
6552
- * @example "asc"
6553
- */
6554
- export enum InsightOrderingDirectionEnumV2 {
6555
- Asc = "asc",
6556
- Desc = "desc"
6557
- }
6558
- export class StockScreenerV2<HandleError extends boolean = boolean> {
6559
- protected readonly apiClient: JwtClient<HandleError>;
6560
- constructor(apiClient: JwtClient<HandleError>);
6710
+ globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
6561
6711
  /**
6562
- * @description filter stocks by params
6563
- * @tags StockScreener
6564
- * @name StockScreener
6565
- * @summary filter stocks by params
6566
- * @request POST:/stock-screener
6712
+ * @description Edit global index
6713
+ * @tags World Markets
6714
+ * @name GlobalIndexDelete
6715
+ * @summary Delete global index
6716
+ * @request DELETE:/global-indexes
6567
6717
  * @secure
6568
6718
  */
6569
- stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
6719
+ globalIndexDelete(query: {
6720
+ /** a3 code */
6721
+ a3code: string;
6722
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6570
6723
  /**
6571
- * @description get top symbols
6572
- * @tags StockScreener
6573
- * @name GetTopSymbols
6574
- * @summary get top symbols
6575
- * @request POST:/stock-screener/top
6724
+ * @description Get regions
6725
+ * @tags World Markets
6726
+ * @name RegionGet
6727
+ * @summary Get regions
6728
+ * @request GET:/regions
6576
6729
  * @secure
6577
6730
  */
6578
- getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
6579
- }
6580
- export class FixedIncomeV2<HandleError extends boolean = boolean> {
6581
- protected readonly apiClient: JwtClient<HandleError>;
6582
- constructor(apiClient: JwtClient<HandleError>);
6731
+ regionGet(query: {
6732
+ /** Query limit */
6733
+ limit: number;
6734
+ /** Query offset */
6735
+ offset: number;
6736
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
6583
6737
  /**
6584
- * @description get fixed income entries
6585
- * @tags FixedIncome
6586
- * @name GetFixedIncomeEntries
6587
- * @summary get fixed income entries
6588
- * @request POST:/fixed-income
6738
+ * @description Edit region
6739
+ * @tags World Markets
6740
+ * @name RegionEdit
6741
+ * @summary Edit region
6742
+ * @request PUT:/regions
6589
6743
  * @secure
6590
6744
  */
6591
- getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
6745
+ regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6746
+ /**
6747
+ * @description Create regions
6748
+ * @tags World Markets
6749
+ * @name RegionCreate
6750
+ * @summary Create regions
6751
+ * @request POST:/regions
6752
+ * @secure
6753
+ */
6754
+ regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
6755
+ /**
6756
+ * @description Delete region
6757
+ * @tags World Markets
6758
+ * @name RegionDelete
6759
+ * @summary Delete region
6760
+ * @request DELETE:/regions
6761
+ * @secure
6762
+ */
6763
+ regionDelete(query: {
6764
+ /** region id */
6765
+ id: string;
6766
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6592
6767
  }
6593
6768
  export class InsightApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
6594
6769
  readonly config: JwtClientConfig<HandleError>;