@orbis-systems/orbis-api-clients 0.8.7 → 0.8.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/dist/aesmidas/index.d.ts +93 -65
  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 +6009 -6009
  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 +1308 -1308
  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 +104 -104
  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 +3881 -3881
  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 +773 -773
  32. package/dist/uma/index.d.ts.map +1 -1
  33. package/dist/uma/index.esm.js +1 -1
  34. package/dist/uma/index.esm.js.map +1 -1
  35. package/dist/uma/index.js +1 -1
  36. package/dist/uma/index.js.map +1 -1
  37. package/package.json +2 -1
@@ -1595,7 +1595,7 @@ export interface InsightGetScreenerPresetsResponse {
1595
1595
  }
1596
1596
  export interface InsightGetSymbolFundamentalsAnnualResponse {
1597
1597
  balance_sheet: {
1598
- '2021': {
1598
+ "2021": {
1599
1599
  accounts_payable?: number;
1600
1600
  accounts_receivable?: number;
1601
1601
  accumulated_depreciation?: number;
@@ -1661,7 +1661,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
1661
1661
  tradeand_other_payables_non_current?: number;
1662
1662
  working_capital?: number;
1663
1663
  };
1664
- '2022': {
1664
+ "2022": {
1665
1665
  accounts_payable?: number;
1666
1666
  accounts_receivable?: number;
1667
1667
  accumulated_depreciation?: number;
@@ -1731,7 +1731,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
1731
1731
  tradeand_other_payables_non_current?: number;
1732
1732
  working_capital?: number;
1733
1733
  };
1734
- '2023': {
1734
+ "2023": {
1735
1735
  accounts_payable?: number;
1736
1736
  accounts_receivable?: number;
1737
1737
  accumulated_depreciation?: number;
@@ -1802,7 +1802,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
1802
1802
  treasury_shares_number?: number;
1803
1803
  working_capital?: number;
1804
1804
  };
1805
- '2024': {
1805
+ "2024": {
1806
1806
  accounts_payable?: number;
1807
1807
  accounts_receivable?: number;
1808
1808
  accumulated_depreciation?: number;
@@ -1870,7 +1870,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
1870
1870
  currency: string;
1871
1871
  };
1872
1872
  cash_flow: {
1873
- '2021': {
1873
+ "2021": {
1874
1874
  beginning_cash_position?: number;
1875
1875
  capital_expenditure?: number;
1876
1876
  cash_dividends_paid?: number;
@@ -1918,7 +1918,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
1918
1918
  sale_of_investment?: number;
1919
1919
  stock_based_compensation?: number;
1920
1920
  };
1921
- '2022': {
1921
+ "2022": {
1922
1922
  beginning_cash_position?: number;
1923
1923
  capital_expenditure?: number;
1924
1924
  cash_dividends_paid?: number;
@@ -1966,7 +1966,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
1966
1966
  short_term_debt_issuance?: number;
1967
1967
  stock_based_compensation?: number;
1968
1968
  };
1969
- '2023': {
1969
+ "2023": {
1970
1970
  beginning_cash_position?: number;
1971
1971
  capital_expenditure?: number;
1972
1972
  cash_dividends_paid?: number;
@@ -2008,7 +2008,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
2008
2008
  sale_of_investment?: number;
2009
2009
  stock_based_compensation?: number;
2010
2010
  };
2011
- '2024': {
2011
+ "2024": {
2012
2012
  beginning_cash_position?: number;
2013
2013
  capital_expenditure?: number;
2014
2014
  cash_dividends_paid?: number;
@@ -2053,7 +2053,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
2053
2053
  currency: string;
2054
2054
  };
2055
2055
  income_statement: {
2056
- '2021': {
2056
+ "2021": {
2057
2057
  cost_of_revenue?: number;
2058
2058
  diluted_ni_availto_com_stockholders?: number;
2059
2059
  ebit?: number;
@@ -2089,7 +2089,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
2089
2089
  total_expenses?: number;
2090
2090
  total_revenue?: number;
2091
2091
  };
2092
- '2022': {
2092
+ "2022": {
2093
2093
  cost_of_revenue?: number;
2094
2094
  diluted_ni_availto_com_stockholders?: number;
2095
2095
  ebit?: number;
@@ -2125,7 +2125,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
2125
2125
  total_expenses?: number;
2126
2126
  total_revenue?: number;
2127
2127
  };
2128
- '2023': {
2128
+ "2023": {
2129
2129
  cost_of_revenue?: number;
2130
2130
  diluted_ni_availto_com_stockholders?: number;
2131
2131
  ebit?: number;
@@ -2161,7 +2161,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
2161
2161
  total_expenses?: number;
2162
2162
  total_revenue?: number;
2163
2163
  };
2164
- '2024': {
2164
+ "2024": {
2165
2165
  cost_of_revenue?: number;
2166
2166
  diluted_ni_availto_com_stockholders?: number;
2167
2167
  ebit?: number;
@@ -2196,7 +2196,7 @@ export interface InsightGetSymbolFundamentalsAnnualResponse {
2196
2196
  }
2197
2197
  export interface InsightGetSymbolFundamentalsQuarterlyResponse {
2198
2198
  balance_sheet: {
2199
- '2024Q1': {
2199
+ "2024Q1": {
2200
2200
  accounts_payable?: number;
2201
2201
  accounts_receivable?: number;
2202
2202
  accumulated_depreciation?: number;
@@ -2254,7 +2254,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
2254
2254
  treasury_shares_number?: number;
2255
2255
  working_capital?: number;
2256
2256
  };
2257
- '2024Q2': {
2257
+ "2024Q2": {
2258
2258
  accounts_payable?: number;
2259
2259
  accounts_receivable?: number;
2260
2260
  accumulated_depreciation?: number;
@@ -2310,7 +2310,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
2310
2310
  total_non_current_liabilities_net_minority_interest?: number;
2311
2311
  working_capital?: number;
2312
2312
  };
2313
- '2024Q3': {
2313
+ "2024Q3": {
2314
2314
  accounts_payable?: number;
2315
2315
  accounts_receivable?: number;
2316
2316
  accumulated_depreciation?: number;
@@ -2366,7 +2366,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
2366
2366
  total_non_current_liabilities_net_minority_interest?: number;
2367
2367
  working_capital?: number;
2368
2368
  };
2369
- '2024Q4': {
2369
+ "2024Q4": {
2370
2370
  accounts_payable?: number;
2371
2371
  accounts_receivable?: number;
2372
2372
  accumulated_depreciation?: number;
@@ -2434,7 +2434,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
2434
2434
  currency: string;
2435
2435
  };
2436
2436
  cash_flow: {
2437
- '2024Q1': {
2437
+ "2024Q1": {
2438
2438
  beginning_cash_position?: number;
2439
2439
  capital_expenditure?: number;
2440
2440
  cash_dividends_paid?: number;
@@ -2476,7 +2476,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
2476
2476
  short_term_debt_payments?: number;
2477
2477
  stock_based_compensation?: number;
2478
2478
  };
2479
- '2024Q2': {
2479
+ "2024Q2": {
2480
2480
  beginning_cash_position?: number;
2481
2481
  capital_expenditure?: number;
2482
2482
  cash_dividends_paid?: number;
@@ -2518,7 +2518,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
2518
2518
  short_term_debt_payments?: number;
2519
2519
  stock_based_compensation?: number;
2520
2520
  };
2521
- '2024Q3': {
2521
+ "2024Q3": {
2522
2522
  beginning_cash_position?: number;
2523
2523
  capital_expenditure?: number;
2524
2524
  cash_dividends_paid?: number;
@@ -2560,7 +2560,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
2560
2560
  short_term_debt_payments?: number;
2561
2561
  stock_based_compensation?: number;
2562
2562
  };
2563
- '2024Q4': {
2563
+ "2024Q4": {
2564
2564
  beginning_cash_position?: number;
2565
2565
  capital_expenditure?: number;
2566
2566
  cash_dividends_paid?: number;
@@ -2605,7 +2605,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
2605
2605
  currency: string;
2606
2606
  };
2607
2607
  income_statement: {
2608
- '2024Q1': {
2608
+ "2024Q1": {
2609
2609
  cost_of_revenue?: number;
2610
2610
  diluted_ni_availto_com_stockholders?: number;
2611
2611
  ebit?: number;
@@ -2635,7 +2635,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
2635
2635
  total_expenses?: number;
2636
2636
  total_revenue?: number;
2637
2637
  };
2638
- '2024Q2': {
2638
+ "2024Q2": {
2639
2639
  cost_of_revenue?: number;
2640
2640
  diluted_ni_availto_com_stockholders?: number;
2641
2641
  ebit?: number;
@@ -2665,7 +2665,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
2665
2665
  total_expenses?: number;
2666
2666
  total_revenue?: number;
2667
2667
  };
2668
- '2024Q3': {
2668
+ "2024Q3": {
2669
2669
  cost_of_revenue?: number;
2670
2670
  diluted_ni_availto_com_stockholders?: number;
2671
2671
  ebit?: number;
@@ -2695,7 +2695,7 @@ export interface InsightGetSymbolFundamentalsQuarterlyResponse {
2695
2695
  total_expenses?: number;
2696
2696
  total_revenue?: number;
2697
2697
  };
2698
- '2024Q4': {
2698
+ "2024Q4": {
2699
2699
  cost_of_revenue?: number;
2700
2700
  diluted_ni_availto_com_stockholders?: number;
2701
2701
  ebit?: number;
@@ -4805,27 +4805,187 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
4805
4805
  Date = "date",
4806
4806
  Rank = "rank"
4807
4807
  }
4808
- export class AlphaTools<HandleError extends boolean = boolean> {
4808
+ export class WorldMarkets<HandleError extends boolean = boolean> {
4809
4809
  protected readonly apiClient: JwtClient<HandleError>;
4810
4810
  constructor(apiClient: JwtClient<HandleError>);
4811
4811
  /**
4812
- * @description get seasonlity data with comparison to benchmark
4813
- * @tags AlphaTools
4814
- * @name GetMomentumRatioGraph
4815
- * @summary get seasonlity data
4816
- * @request POST:/rst
4812
+ * @description Get continents
4813
+ * @tags World Markets
4814
+ * @name ContinentGet
4815
+ * @summary Get continents
4816
+ * @request GET:/continents
4817
4817
  * @secure
4818
4818
  */
4819
- getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
4819
+ continentGet(query: {
4820
+ /** Query limit */
4821
+ limit: number;
4822
+ /** Query offset */
4823
+ offset: number;
4824
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
4820
4825
  /**
4821
- * @description get seasonlity data with comparison to benchmark
4822
- * @tags AlphaTools
4823
- * @name GetSeasonality
4824
- * @summary get seasonlity data
4825
- * @request POST:/seasonality
4826
+ * @description Edit continent
4827
+ * @tags World Markets
4828
+ * @name ContinentEdit
4829
+ * @summary Edit continent
4830
+ * @request PUT:/continents
4826
4831
  * @secure
4827
4832
  */
4828
- getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
4833
+ continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4834
+ /**
4835
+ * @description Create continents
4836
+ * @tags World Markets
4837
+ * @name ContinentCreate
4838
+ * @summary Create continents
4839
+ * @request POST:/continents
4840
+ * @secure
4841
+ */
4842
+ continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
4843
+ /**
4844
+ * @description Delete continent
4845
+ * @tags World Markets
4846
+ * @name ContinentDelete
4847
+ * @summary Delete continent
4848
+ * @request DELETE:/continents
4849
+ * @secure
4850
+ */
4851
+ continentDelete(query: {
4852
+ /** continent id */
4853
+ id: string;
4854
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4855
+ /**
4856
+ * @description Get country codes
4857
+ * @tags World Markets
4858
+ * @name CountryCodeGet
4859
+ * @summary Get country codes
4860
+ * @request GET:/country-codes
4861
+ * @secure
4862
+ */
4863
+ countryCodeGet(query: {
4864
+ /** Query limit */
4865
+ limit: number;
4866
+ /** Query offset */
4867
+ offset: number;
4868
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
4869
+ /**
4870
+ * @description Edit country code
4871
+ * @tags World Markets
4872
+ * @name CountryCodeEdit
4873
+ * @summary Edit country code
4874
+ * @request PUT:/country-codes
4875
+ * @secure
4876
+ */
4877
+ countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4878
+ /**
4879
+ * @description Add country codes
4880
+ * @tags World Markets
4881
+ * @name CountryCodeAdd
4882
+ * @summary Add country codes
4883
+ * @request POST:/country-codes
4884
+ * @secure
4885
+ */
4886
+ countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
4887
+ /**
4888
+ * @description Delete country code
4889
+ * @tags World Markets
4890
+ * @name CountryCodeDelete
4891
+ * @summary Delete country code
4892
+ * @request DELETE:/country-codes
4893
+ * @secure
4894
+ */
4895
+ countryCodeDelete(query: {
4896
+ /** a3 code */
4897
+ a3code: string;
4898
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4899
+ /**
4900
+ * @description Get global indexes
4901
+ * @tags World Markets
4902
+ * @name GlobalIndexGet
4903
+ * @summary Get global indexes
4904
+ * @request GET:/global-indexes
4905
+ * @secure
4906
+ */
4907
+ globalIndexGet(query: {
4908
+ /** Query limit */
4909
+ limit: number;
4910
+ /** Query offset */
4911
+ offset: number;
4912
+ /** Continent code for filtering */
4913
+ continent?: string;
4914
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
4915
+ /**
4916
+ * @description Edit global index
4917
+ * @tags World Markets
4918
+ * @name GlobalIndexEdit
4919
+ * @summary Edit global index
4920
+ * @request PUT:/global-indexes
4921
+ * @secure
4922
+ */
4923
+ globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4924
+ /**
4925
+ * @description Add global indexes
4926
+ * @tags World Markets
4927
+ * @name GlobalIndexAdd
4928
+ * @summary Add global indexes
4929
+ * @request POST:/global-indexes
4930
+ * @secure
4931
+ */
4932
+ globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
4933
+ /**
4934
+ * @description Edit global index
4935
+ * @tags World Markets
4936
+ * @name GlobalIndexDelete
4937
+ * @summary Delete global index
4938
+ * @request DELETE:/global-indexes
4939
+ * @secure
4940
+ */
4941
+ globalIndexDelete(query: {
4942
+ /** a3 code */
4943
+ a3code: string;
4944
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4945
+ /**
4946
+ * @description Get regions
4947
+ * @tags World Markets
4948
+ * @name RegionGet
4949
+ * @summary Get regions
4950
+ * @request GET:/regions
4951
+ * @secure
4952
+ */
4953
+ regionGet(query: {
4954
+ /** Query limit */
4955
+ limit: number;
4956
+ /** Query offset */
4957
+ offset: number;
4958
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
4959
+ /**
4960
+ * @description Edit region
4961
+ * @tags World Markets
4962
+ * @name RegionEdit
4963
+ * @summary Edit region
4964
+ * @request PUT:/regions
4965
+ * @secure
4966
+ */
4967
+ regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4968
+ /**
4969
+ * @description Create regions
4970
+ * @tags World Markets
4971
+ * @name RegionCreate
4972
+ * @summary Create regions
4973
+ * @request POST:/regions
4974
+ * @secure
4975
+ */
4976
+ regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
4977
+ /**
4978
+ * @description Delete region
4979
+ * @tags World Markets
4980
+ * @name RegionDelete
4981
+ * @summary Delete region
4982
+ * @request DELETE:/regions
4983
+ * @secure
4984
+ */
4985
+ regionDelete(query: {
4986
+ /** region id */
4987
+ id: string;
4988
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
4829
4989
  }
4830
4990
  export class CompanyProfile<HandleError extends boolean = boolean> {
4831
4991
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5025,44 +5185,6 @@ export class Dashboard<HandleError extends boolean = boolean> {
5025
5185
  symbol: string;
5026
5186
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolRelatedFieldsResponse, HandleError>>;
5027
5187
  }
5028
- export class Earnings<HandleError extends boolean = boolean> {
5029
- protected readonly apiClient: JwtClient<HandleError>;
5030
- constructor(apiClient: JwtClient<HandleError>);
5031
- /**
5032
- * @description get earnings releases count per day
5033
- * @tags Earnings
5034
- * @name GetEarningsReleasesCountPerDay
5035
- * @summary get earnings releases count per day
5036
- * @request GET:/earnings-calendar
5037
- * @secure
5038
- */
5039
- getEarningsReleasesCountPerDay(query?: {
5040
- /**
5041
- * Start date in format YYYY-MM-DD
5042
- * @example ""2024-01-01""
5043
- */
5044
- start_date?: string;
5045
- /**
5046
- * End date in format YYYY-MM-DD
5047
- * @example ""2024-01-31""
5048
- */
5049
- end_date?: string;
5050
- /**
5051
- * Filter by exchanges
5052
- * @example ""NYSE,NAS""
5053
- */
5054
- exchanges?: string[];
5055
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, number>, HandleError>>;
5056
- /**
5057
- * @description get earnings release dates for symbols
5058
- * @tags Earnings
5059
- * @name GetEarningsCalendar
5060
- * @summary get earnings calendar data
5061
- * @request POST:/earnings-calendar
5062
- * @secure
5063
- */
5064
- getEarningsCalendar(filter: InsightEarningReleasesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEarningReleasesResponse, HandleError>>;
5065
- }
5066
5188
  export class FixedIncome<HandleError extends boolean = boolean> {
5067
5189
  protected readonly apiClient: JwtClient<HandleError>;
5068
5190
  constructor(apiClient: JwtClient<HandleError>);
@@ -5153,261 +5275,56 @@ export class FixedIncome<HandleError extends boolean = boolean> {
5153
5275
  */
5154
5276
  getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
5155
5277
  }
5156
- export enum InsightOrderDirectionV2 {
5157
- OrderASC = "asc",
5158
- OrderDESC = "desc"
5159
- }
5160
- export interface InsightBeforeAndAfterV2 {
5161
- after?: string;
5162
- before?: string;
5278
+ export class Fundamentals<HandleError extends boolean = boolean> {
5279
+ protected readonly apiClient: JwtClient<HandleError>;
5280
+ constructor(apiClient: JwtClient<HandleError>);
5281
+ /**
5282
+ * @description get fundamentals by symbol data
5283
+ * @tags Fundamentals
5284
+ * @name GetFundamentalsBySymbolData
5285
+ * @summary get fundamentals by symbol data
5286
+ * @request POST:/fundamentals
5287
+ * @secure
5288
+ */
5289
+ getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
5163
5290
  }
5164
- export interface InsightFixedIncomeV2 {
5165
- a144: boolean;
5166
- accrued_interest: number;
5167
- bank_qualified: boolean;
5168
- bond_warrant: boolean;
5169
- call_type: string;
5170
- callable: boolean;
5171
- close_price: number;
5172
- close_price_asof: string;
5173
- close_ytw: number;
5174
- convertible: boolean;
5175
- country: string;
5176
- country_code: string;
5177
- country_domicile: string;
5178
- country_issue: string;
5179
- coupon: number;
5180
- coupon_frequency: string;
5181
- coupon_type: string;
5182
- currency: string;
5183
- cusip: string;
5184
- dated_date: string;
5185
- daycount: string;
5186
- description: string;
5187
- description_short: string;
5188
- duration: number;
5189
- first_coupon_date: string;
5190
- insured: boolean;
5191
- isin: string;
5192
- issue_date: string;
5193
- issue_minimum_denomination: number;
5194
- issue_price: number;
5195
- issue_size: number;
5196
- issuer: string;
5197
- last_coupon_date: string;
5198
- liquidity_institutional_aggregate: number;
5199
- liquidity_institutional_buy: number;
5200
- liquidity_institutional_sell: number;
5201
- liquidity_micro_aggregate: number;
5202
- liquidity_micro_buy: number;
5203
- liquidity_micro_sell: number;
5204
- liquidity_retail_aggregate: number;
5205
- liquidity_retail_buy: number;
5206
- liquidity_retail_sell: number;
5207
- maturity_date: string;
5208
- municipal_state: string;
5209
- municipal_taxable_federal: boolean;
5210
- municipal_type: string;
5211
- next_call_date: string;
5212
- next_call_price: number;
5213
- next_coupon_date: string;
5214
- par_value: number;
5215
- perpetual: boolean;
5216
- private_placement: boolean;
5217
- purpose: string;
5218
- puttable: boolean;
5219
- reg_s: boolean;
5220
- sector: string;
5221
- seniority: string;
5222
- settlement_convention: string;
5223
- sinking_fund: boolean;
5224
- sp_creditwatch: string;
5225
- sp_creditwatch_date: string;
5226
- sp_outlook: string;
5227
- sp_outlook_date: string;
5228
- sp_rating: string;
5229
- sp_rating_date: string;
5230
- status: string;
5231
- ticker: string;
5232
- treasury_subtype: string;
5233
- type: string;
5234
- updated_at: string;
5235
- }
5236
- export interface InsightGetFixedIncomeEntriesResponseV2 {
5237
- count: number;
5238
- data: InsightFixedIncomeV2[];
5239
- }
5240
- export interface InsightGetFixedIncomeEntriesRequestV2 {
5241
- /** @example true */
5242
- bank_qualified?: boolean;
5243
- /** @example true */
5244
- callable?: boolean;
5245
- /** @example true */
5246
- convertible?: boolean;
5247
- /** @example ["USA"] */
5248
- country_codes?: string[];
5249
- coupon?: InsightLessAndMoreV2;
5250
- /** @example ["quarterly","zero"] */
5251
- coupon_frequencies?: string[];
5252
- /** @example ["655664AH3","9128286R6"] */
5253
- cusip?: string[];
5254
- /**
5255
- * @maxLength 100
5256
- * @example "Donald's"
5257
- */
5258
- description?: string;
5259
- /** @example true */
5260
- has_ticker?: boolean;
5261
- /** @example true */
5262
- insured?: boolean;
5263
- /** @example ["US655664AH33","US9128286R69"] */
5264
- isin?: string[];
5265
- issue_date?: InsightBeforeAndAfterV2;
5266
- /**
5267
- * @maxLength 100
5268
- * @example "Donald's"
5269
- */
5270
- issuer?: string;
5271
- maturity?: InsightBeforeAndAfterV2;
5272
- /** @example ["NY"] */
5273
- municipal_states?: string[];
5274
- /** @example true */
5275
- municipal_tax?: boolean;
5276
- /** @example ["general_obligation"] */
5277
- municipal_types?: string[];
5278
- pagination: InsightPaginationV2;
5279
- purposes?: string[];
5280
- /** @example ["SOVEREIGN"] */
5281
- sectors?: string[];
5282
- sorts?: InsightOrderingV2[];
5283
- /** @example ["AAA"] */
5284
- sp_ratings?: string[];
5285
- /** @example ["called","outstanding"] */
5286
- statuses?: string[];
5287
- tickers?: string[];
5288
- /** @example ["corporate"] */
5289
- types?: string[];
5290
- }
5291
- export interface InsightGetTopSymbolsRequestV2 {
5292
- exchange?: string[];
5293
- market_cap?: InsightLessAndMoreV2;
5294
- pagination?: InsightPaginationV2;
5295
- price?: InsightLessAndMoreV2;
5296
- sorts?: InsightOrderingV2[];
5297
- volume?: InsightLessAndMoreV2;
5298
- }
5299
- export interface InsightIncludeExcludeV2 {
5300
- exclude?: string[];
5301
- include?: string[];
5302
- }
5303
- export interface InsightLessAndMoreV2 {
5304
- less_than?: number;
5305
- more_than?: number;
5306
- }
5307
- export interface InsightOrderingV2 {
5308
- /**
5309
- * @default "asc"
5310
- * @example "asc"
5311
- */
5312
- direction: InsightOrderingDirectionEnumV2;
5313
- /**
5314
- * Sort direction:
5315
- * * asc - Ascending, from A to Z.
5316
- * * desc - Descending, from Z to A.
5317
- * @example "name"
5318
- */
5319
- field: string;
5320
- }
5321
- export interface InsightPaginationV2 {
5322
- /**
5323
- * @min 1
5324
- * @example 1
5325
- */
5326
- page: number;
5327
- /**
5328
- * @min 1
5329
- * @max 50
5330
- * @example 10
5331
- */
5332
- size: number;
5333
- }
5334
- export interface InsightStockScreenerQuoteV2 {
5335
- average_volume_30d: number;
5336
- company_name: string;
5337
- dividend_ex_date: string;
5338
- dividend_pay_date: string;
5339
- dividend_percent: number;
5340
- exchange: string;
5341
- exchange_name: string;
5342
- gap: number;
5343
- industry: string;
5344
- industry_code: string;
5345
- last_price: number;
5346
- market_cap: number;
5347
- pe_ratio: number;
5348
- price_change: number;
5349
- price_change_percent: number;
5350
- symbol: string;
5351
- volume: number;
5352
- }
5353
- export interface InsightStockScreenerRequestV2 {
5354
- average_volume_30d?: InsightLessAndMoreV2;
5355
- dividend_ex_date?: InsightBeforeAndAfterV2;
5356
- dividend_pay_date?: InsightBeforeAndAfterV2;
5357
- dividend_percent?: InsightLessAndMoreV2;
5358
- exchange?: InsightIncludeExcludeV2;
5359
- gap?: InsightLessAndMoreV2;
5360
- industry?: InsightIncludeExcludeV2;
5361
- market_cap?: InsightLessAndMoreV2;
5362
- pagination: InsightPaginationV2;
5363
- pe_ratio?: InsightLessAndMoreV2;
5364
- price?: InsightLessAndMoreV2;
5365
- price_change_percent?: InsightLessAndMoreV2;
5366
- sorts?: InsightOrderingV2[];
5367
- /** @example "ADR" */
5368
- stock_type?: string;
5369
- volume?: InsightLessAndMoreV2;
5370
- }
5371
- export interface InsightStockScreenerResponseV2 {
5372
- current_page: number;
5373
- data: InsightStockScreenerQuoteV2[];
5374
- page_count: number;
5375
- status: number;
5376
- total_records: number;
5377
- }
5378
- /**
5379
- * @default "asc"
5380
- * @example "asc"
5381
- */
5382
- export enum InsightOrderingDirectionEnumV2 {
5383
- Asc = "asc",
5384
- Desc = "desc"
5385
- }
5386
- export class FixedIncomeV2<HandleError extends boolean = boolean> {
5291
+ export class Earnings<HandleError extends boolean = boolean> {
5387
5292
  protected readonly apiClient: JwtClient<HandleError>;
5388
5293
  constructor(apiClient: JwtClient<HandleError>);
5389
5294
  /**
5390
- * @description get fixed income entries
5391
- * @tags FixedIncome
5392
- * @name GetFixedIncomeEntries
5393
- * @summary get fixed income entries
5394
- * @request POST:/fixed-income
5295
+ * @description get earnings releases count per day
5296
+ * @tags Earnings
5297
+ * @name GetEarningsReleasesCountPerDay
5298
+ * @summary get earnings releases count per day
5299
+ * @request GET:/earnings-calendar
5395
5300
  * @secure
5396
5301
  */
5397
- getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
5398
- }
5399
- export class Fundamentals<HandleError extends boolean = boolean> {
5400
- protected readonly apiClient: JwtClient<HandleError>;
5401
- constructor(apiClient: JwtClient<HandleError>);
5302
+ getEarningsReleasesCountPerDay(query?: {
5303
+ /**
5304
+ * Start date in format YYYY-MM-DD
5305
+ * @example ""2024-01-01""
5306
+ */
5307
+ start_date?: string;
5308
+ /**
5309
+ * End date in format YYYY-MM-DD
5310
+ * @example ""2024-01-31""
5311
+ */
5312
+ end_date?: string;
5313
+ /**
5314
+ * Filter by exchanges
5315
+ * @example ""NYSE,NAS""
5316
+ */
5317
+ exchanges?: string[];
5318
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, number>, HandleError>>;
5402
5319
  /**
5403
- * @description get fundamentals by symbol data
5404
- * @tags Fundamentals
5405
- * @name GetFundamentalsBySymbolData
5406
- * @summary get fundamentals by symbol data
5407
- * @request POST:/fundamentals
5320
+ * @description get earnings release dates for symbols
5321
+ * @tags Earnings
5322
+ * @name GetEarningsCalendar
5323
+ * @summary get earnings calendar data
5324
+ * @request POST:/earnings-calendar
5408
5325
  * @secure
5409
5326
  */
5410
- getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
5327
+ getEarningsCalendar(filter: InsightEarningReleasesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEarningReleasesResponse, HandleError>>;
5411
5328
  }
5412
5329
  export class Funds<HandleError extends boolean = boolean> {
5413
5330
  protected readonly apiClient: JwtClient<HandleError>;
@@ -5523,843 +5440,975 @@ export class Funds<HandleError extends boolean = boolean> {
5523
5440
  Authorization?: string;
5524
5441
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
5525
5442
  }
5526
- export class Intraday<HandleError extends boolean = boolean> {
5443
+ export class StockScreener<HandleError extends boolean = boolean> {
5527
5444
  protected readonly apiClient: JwtClient<HandleError>;
5528
5445
  constructor(apiClient: JwtClient<HandleError>);
5529
5446
  /**
5530
- * @description Returns an array of intraday chart data values for the given ticker.
5531
- * @tags Intraday
5532
- * @name IntradayQuotes
5533
- * @summary Get an array of intraday chart data values for the given ticker
5534
- * @request POST:/intraday/quotes
5447
+ * @description data for visual heat map
5448
+ * @tags StockScreener
5449
+ * @name StockMarketHeatmap
5450
+ * @summary data for visual heat map
5451
+ * @request GET:/heatmaps
5535
5452
  * @secure
5536
5453
  */
5537
- intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
5538
- }
5539
- export class Ipos<HandleError extends boolean = boolean> {
5540
- protected readonly apiClient: JwtClient<HandleError>;
5541
- constructor(apiClient: JwtClient<HandleError>);
5454
+ stockMarketHeatmap(query?: {
5455
+ /** Name of symbol list to fetch details for. Empty is default */
5456
+ heatmap_name?: string;
5457
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
5542
5458
  /**
5543
- * @description get recent ipos info
5544
- * @tags Ipos
5545
- * @name PostRecent
5546
- * @summary get recent ipos info
5547
- * @request POST:/ipos/recent
5459
+ * @description create or update heat map preset
5460
+ * @tags StockScreener
5461
+ * @name CreateStockMarketHeatmapPreset
5462
+ * @summary create or update heat map preset
5463
+ * @request POST:/heatmaps
5548
5464
  * @secure
5549
5465
  */
5550
- postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5466
+ createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5551
5467
  /**
5552
- * @description get upcoming ipos info
5553
- * @tags Ipos
5554
- * @name GetUpcoming
5555
- * @summary get upcoming ipos info
5556
- * @request GET:/ipos/upcoming
5468
+ * @description Sector and Industry Group performance
5469
+ * @tags StockScreener
5470
+ * @name IndustriesPerformance
5471
+ * @summary get industries performance
5472
+ * @request POST:/industries-performance
5557
5473
  * @secure
5558
5474
  */
5559
- getUpcoming(query: {
5560
- /** how many records to return. Max value is 50 */
5561
- limit: number;
5562
- /** how many records to skip */
5563
- offset: number;
5564
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5475
+ industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
5565
5476
  /**
5566
- * @description get ipo info by symbol
5567
- * @tags Ipos
5568
- * @name GetIpos
5569
- * @summary get ipo info by symbol
5570
- * @request GET:/ipos/{symbol}
5477
+ * @description filter stocks by params
5478
+ * @tags StockScreener
5479
+ * @name StockScreener
5480
+ * @summary filter stocks by params
5481
+ * @request POST:/stock-screener
5571
5482
  * @secure
5572
5483
  */
5573
- getIpos(symbol: string, query?: {
5574
- /** load quotes */
5575
- load_quotes?: boolean;
5576
- /** statuses */
5577
- statuses?: string[];
5578
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
5579
- }
5580
- export class Logos<HandleError extends boolean = boolean> {
5581
- protected readonly apiClient: JwtClient<HandleError>;
5582
- constructor(apiClient: JwtClient<HandleError>);
5484
+ stockScreener(filter: InsightStockScreenerV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
5583
5485
  /**
5584
- * @description Returns converted logo for crypto symbol
5585
- * @tags Logos
5586
- * @name LogosConvertedCryptoSymbolLogo
5587
- * @summary Get converted logo for crypto symbol
5588
- * @request POST:/logos/converted-crypto-symbol-logo
5486
+ * @description get screener presets
5487
+ * @tags StockScreener
5488
+ * @name GetScreenerPresets
5489
+ * @summary get screener presets
5490
+ * @request GET:/stock-screener/presets
5589
5491
  * @secure
5590
5492
  */
5591
- logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5493
+ getScreenerPresets(query: {
5494
+ /** how many records to return */
5495
+ limit: number;
5496
+ /** how many records to skip */
5497
+ offset: number;
5498
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
5592
5499
  /**
5593
- * @description Returns converted logo for symbol
5594
- * @tags Logos
5595
- * @name LogosConvertedSymbolLogo
5596
- * @summary Get converted logo for symbol
5597
- * @request POST:/logos/converted-symbol-logo
5500
+ * @description update screener preset
5501
+ * @tags StockScreener
5502
+ * @name UpdateScreenerPreset
5503
+ * @summary update screener preset
5504
+ * @request PUT:/stock-screener/presets
5598
5505
  * @secure
5599
5506
  */
5600
- logosConvertedSymbolLogo(filter: InsightSymbolLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5507
+ updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5601
5508
  /**
5602
- * @description Returns logo for crypto symbol
5603
- * @tags Logos
5604
- * @name LogosCryptoSymbolLogo
5605
- * @summary Get logo for crypto symbol
5606
- * @request GET:/logos/crypto-symbol-logo
5509
+ * @description create screener preset
5510
+ * @tags StockScreener
5511
+ * @name CreateOrScreenerPreset
5512
+ * @summary create screener preset
5513
+ * @request POST:/stock-screener/presets
5607
5514
  * @secure
5608
5515
  */
5609
- logosCryptoSymbolLogo(query: {
5610
- /** Company symbol */
5611
- symbol: string;
5612
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError>>;
5516
+ createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
5613
5517
  /**
5614
- * @description Returns direct logo for crypto symbol
5615
- * @tags Logos
5616
- * @name LogosDirectCryptoSymbolLogo
5617
- * @summary Get direct logo for crypto symbol
5618
- * @request GET:/logos/direct-crypto-symbol-logo
5518
+ * @description remove screener preset
5519
+ * @tags StockScreener
5520
+ * @name RemoveScreenerPreset
5521
+ * @summary remove screener preset
5522
+ * @request DELETE:/stock-screener/presets
5619
5523
  * @secure
5620
5524
  */
5621
- logosDirectCryptoSymbolLogo(query: {
5622
- /** Company symbol */
5623
- symbol: string;
5624
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5525
+ removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5625
5526
  /**
5626
- * @description Returns direct logo for symbol
5627
- * @tags Logos
5628
- * @name LogosDirectSymbolLogo
5629
- * @summary Get direct logo for symbol
5630
- * @request GET:/logos/direct-symbol-logo
5527
+ * @description get top symbols
5528
+ * @tags StockScreener
5529
+ * @name GetTopSymbols
5530
+ * @summary get top symbols
5531
+ * @request POST:/stock-screener/top
5631
5532
  * @secure
5632
5533
  */
5633
- logosDirectSymbolLogo(query: {
5634
- /** Company symbol */
5635
- symbol: string;
5636
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5534
+ getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
5535
+ }
5536
+ export class Quotes<HandleError extends boolean = boolean> {
5537
+ protected readonly apiClient: JwtClient<HandleError>;
5538
+ constructor(apiClient: JwtClient<HandleError>);
5637
5539
  /**
5638
- * @description Returns logos for multiple symbols
5639
- * @tags Logos
5640
- * @name LogosMultipleCryptoSymbolLogo
5641
- * @summary Get logos for multiple symbols
5642
- * @request POST:/logos/multiple-crypto-symbol-logo
5540
+ * @description Get single historical quote
5541
+ * @tags Quotes
5542
+ * @name GitHistoricalQuote
5543
+ * @summary Get single historical quote
5544
+ * @request GET:/historical/quote
5643
5545
  * @secure
5644
5546
  */
5645
- logosMultipleCryptoSymbolLogo(filter: InsightMultipleCryptoLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse[], HandleError>>;
5547
+ gitHistoricalQuote(query: {
5548
+ /** Symbol */
5549
+ symbol: string;
5550
+ /** Date */
5551
+ date: string;
5552
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
5646
5553
  /**
5647
- * @description Returns logos for multiple symbol
5648
- * @tags Logos
5649
- * @name LogosMultipleSymbolLogos
5650
- * @summary Get logos for multiple symbols
5651
- * @request POST:/logos/multiple-symbol-logos
5554
+ * @description get quote history by symbol
5555
+ * @tags Quotes
5556
+ * @name GitQuoteHistory
5557
+ * @summary Get quote history
5558
+ * @request POST:/quote-history
5652
5559
  * @secure
5653
5560
  */
5654
- logosMultipleSymbolLogos(filter: InsightMultipleSymbolLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse[], HandleError>>;
5561
+ gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
5655
5562
  /**
5656
- * @description Returns links of socials logos for symbol
5657
- * @tags Logos
5658
- * @name LogosSocialSymbolLogos
5659
- * @summary Get social logos for symbol
5660
- * @request GET:/logos/social-symbol-logos
5563
+ * @description Returns a list of quotes equity info for specified symbols.
5564
+ * @tags Quotes
5565
+ * @name GetQuotesEquityData
5566
+ * @summary Get Quotes Equity data
5567
+ * @request GET:/quotes/equity
5661
5568
  * @secure
5662
5569
  */
5663
- logosSocialSymbolLogos(query: {
5664
- /** Company symbol */
5665
- symbol: string;
5666
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
5570
+ getQuotesEquityData(query: {
5571
+ /** Comma separated symbols */
5572
+ symbols: string;
5573
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
5574
+ }
5575
+ export class Intraday<HandleError extends boolean = boolean> {
5576
+ protected readonly apiClient: JwtClient<HandleError>;
5577
+ constructor(apiClient: JwtClient<HandleError>);
5667
5578
  /**
5668
- * @description Returns logos for company symbol
5669
- * @tags Logos
5670
- * @name LogosSymbolLogos
5671
- * @summary Get symbol logos
5672
- * @request GET:/logos/symbol-logos
5579
+ * @description Returns an array of intraday chart data values for the given ticker.
5580
+ * @tags Intraday
5581
+ * @name IntradayQuotes
5582
+ * @summary Get an array of intraday chart data values for the given ticker
5583
+ * @request POST:/intraday/quotes
5673
5584
  * @secure
5674
5585
  */
5675
- logosSymbolLogos(query: {
5676
- /** Company symbol */
5677
- symbol: string;
5678
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
5586
+ intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
5679
5587
  }
5680
- export class MarketDates<HandleError extends boolean = boolean> {
5588
+ export class PreIpoCompanies<HandleError extends boolean = boolean> {
5681
5589
  protected readonly apiClient: JwtClient<HandleError>;
5682
5590
  constructor(apiClient: JwtClient<HandleError>);
5683
5591
  /**
5684
- * @description Create or update market date
5685
- * @tags MarketDates
5686
- * @name CreateOrUpdateMarketDate
5687
- * @summary Create or update market date
5688
- * @request POST:/market-dates
5592
+ * @description Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
5593
+ * @tags PreIPOCompanies
5594
+ * @name MonarkOghlcDataForSymbol
5595
+ * @summary Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
5596
+ * @request GET:/ipos/market-data/ohlc/{symbol}
5689
5597
  * @secure
5690
5598
  */
5691
- createOrUpdateMarketDate(market: InsightMarketDates[], config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketDate[], HandleError>>;
5599
+ monarkOghlcDataForSymbol(symbol: string, query?: {
5600
+ /** Start time for the OHLC data in ISO 8601 format YYYY-MM-DD */
5601
+ from?: string;
5602
+ /** End time for the OHLC data in ISO 8601 format YYYY-MM-DD */
5603
+ to?: string;
5604
+ /** Time interval for buckets: 1d (day), 1w (week), 1mo (month), 3mo (3 months). Default is 1d. */
5605
+ interval?: string;
5606
+ /** Limit the number of OHLC data points returned. Default is 100. */
5607
+ limit?: number;
5608
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<{
5609
+ close?: number;
5610
+ high?: number;
5611
+ low?: number;
5612
+ open?: number;
5613
+ time?: string;
5614
+ volume?: number;
5615
+ }[], HandleError>>;
5692
5616
  /**
5693
- * @description Remove market date
5694
- * @tags MarketDates
5695
- * @name RemoveMarketDate
5696
- * @summary Remove market date
5697
- * @request DELETE:/market-dates
5617
+ * @description Retrieves all symbols available in the market data
5618
+ * @tags PreIPOCompanies
5619
+ * @name MonarkAllAvailableSymbols
5620
+ * @summary Retrieves all symbols available in the market data
5621
+ * @request GET:/ipos/market-data/symbols
5698
5622
  * @secure
5699
5623
  */
5700
- removeMarketDate(input: InsightRemoveMarketDateRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5624
+ monarkAllAvailableSymbols(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5701
5625
  /**
5702
- * @description Get market dates history
5703
- * @tags MarketDates
5704
- * @name GetMarketDatesHistory
5705
- * @summary Get market dates history
5706
- * @request POST:/market-dates/history
5626
+ * @description get pre ipo companies Avaliable categories: on-demand business-video reverse-etl modern-data-stack video-api global-payroll banking-as-a-service ultrafast-delivery online-grocery website-builder fintech b2b venture-capital ecommerce creator-economy productivity real-estate private-markets-exchanges fpa vertical-saas card-issuing connected-fitness gig-marketplaces cms soc-2 analytics cap-table-management contractor-payroll social-media design online-whiteboard conversational-marketing expense-management stock-option-financing customer-onboarding crypto help-desk payroll documents databases mortgage-lending crypto-exchange marketing-automation payments operations checkout cybersecurity messaging investing marketplaces climate-tech robotics data-security online-education gaming universal-api automation biotechnology contact-center defense machine-learning logistics prefab-tech materials telehealth b2c alternative-proteins b2b-marketplaces wealth-management web3 neobank managed-marketplaces plg-crm jamstack public-safety background-checks identity-verification construction home-services sales blockchain-developer-platform space financial-data-aggregation ai writing-assistant autonomous-driving 401k-provider vector-databases ai-models devtools payroll-api internal-tools mlops bookkeeping cloud-infrastructure data-backups personal-finance ai-frameworks generative-ai cloud-gpus micromobility ai-avatars ai-chips life-sciences partnerships wearables fitness-tracking ai-search ai-medical-scribes networking quantum-computing code-editors
5627
+ * @tags PreIPOCompanies
5628
+ * @name GetPreIpoCompanies
5629
+ * @summary get pre ipo companies
5630
+ * @request GET:/ipos/pre-ipo-companies
5707
5631
  * @secure
5708
5632
  */
5709
- getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
5633
+ getPreIpoCompanies(query: {
5634
+ /** search by company name */
5635
+ name?: string;
5636
+ /** search by categories */
5637
+ categories?: string;
5638
+ /** search by listing type */
5639
+ listing_type?: string;
5640
+ /** filter by active status */
5641
+ is_active?: InsightGetPreIpoCompaniesParamsIsActiveEnum;
5642
+ /** filter by minimum last valuation */
5643
+ min_last_valuation?: number;
5644
+ /** filter by maximum last valuation */
5645
+ max_last_valuation?: number;
5646
+ /** filter by minimum total funding */
5647
+ min_total_funding?: number;
5648
+ /** filter by maximum total funding */
5649
+ max_total_funding?: number;
5650
+ /** how many records to return. Max value is 50 */
5651
+ limit: number;
5652
+ /** how many records to skip */
5653
+ offset: number;
5654
+ /** sort field */
5655
+ order_field?: InsightGetPreIpoCompaniesParamsOrderFieldEnum;
5656
+ /** sort direction */
5657
+ order_direction?: InsightGetPreIpoCompaniesParamsOrderDirectionEnum;
5658
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
5710
5659
  /**
5711
- * @description Search locode data by search string and field
5712
- * @tags MarketDates
5713
- * @name SearchLocodeData
5714
- * @summary Search locode data
5715
- * @request GET:/market-dates/locode
5660
+ * @description get pre ipo company by id
5661
+ * @tags PreIPOCompanies
5662
+ * @name GetPreIpoCompaniesById
5663
+ * @summary get pre ipo company by id
5664
+ * @request GET:/ipos/pre-ipo-companies/{id}
5665
+ * @originalName getPreIpoCompanies
5666
+ * @duplicate
5716
5667
  * @secure
5717
5668
  */
5718
- searchLocodeData(query?: {
5719
- /** Search string */
5720
- search?: string;
5721
- /** Search field */
5722
- field?: InsightSearchLocodeDataParamsFieldEnum;
5723
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSearchLocodeDataResponse, HandleError>>;
5669
+ getPreIpoCompaniesById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompany, HandleError>>;
5724
5670
  /**
5725
- * @description Get markets
5726
- * @tags MarketDates
5727
- * @name GetMarkets
5728
- * @summary Get markets
5729
- * @request GET:/market-dates/markets
5671
+ * @description get pre ipo company funding rounds
5672
+ * @tags PreIPOCompanies
5673
+ * @name GetPreIpoCompanyFundingRounds
5674
+ * @summary get pre ipo company funding rounds
5675
+ * @request GET:/ipos/pre-ipo-company-funding-rounds
5730
5676
  * @secure
5731
5677
  */
5732
- getMarkets(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketsResponse, HandleError>>;
5678
+ getPreIpoCompanyFundingRounds(query: {
5679
+ /** company id */
5680
+ pre_ipo_company_id?: string;
5681
+ /** search by round name */
5682
+ round_name?: string;
5683
+ /** how many records to return. Max value is 50 */
5684
+ limit: number;
5685
+ /** how many records to skip */
5686
+ offset: number;
5687
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyFundingRoundsResponse, HandleError>>;
5733
5688
  /**
5734
- * @description Create or update market
5735
- * @tags MarketDates
5736
- * @name CreateOrUpdateMarket
5737
- * @summary Create or update market
5738
- * @request POST:/market-dates/markets
5689
+ * @description get pre ipo company funding round by id
5690
+ * @tags PreIPOCompanies
5691
+ * @name GetPreIpoCompanyFundingRoundsById
5692
+ * @summary get pre ipo company funding round by id
5693
+ * @request GET:/ipos/pre-ipo-company-funding-rounds/{id}
5694
+ * @originalName getPreIpoCompanyFundingRounds
5695
+ * @duplicate
5739
5696
  * @secure
5740
5697
  */
5741
- createOrUpdateMarket(market: InsightCreateOrUpdateMarketRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarket, HandleError>>;
5698
+ getPreIpoCompanyFundingRoundsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyFundingRound, HandleError>>;
5742
5699
  /**
5743
- * @description Get market
5744
- * @tags MarketDates
5745
- * @name GetMarket
5746
- * @summary Get market
5747
- * @request GET:/market-dates/markets/{market}
5700
+ * @description get pre ipo company investments
5701
+ * @tags PreIPOCompanies
5702
+ * @name GetPreIpoCompanyInvestments
5703
+ * @summary get pre ipo company investments
5704
+ * @request GET:/ipos/pre-ipo-company-investments
5748
5705
  * @secure
5749
5706
  */
5750
- getMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketWithSchedule, HandleError>>;
5707
+ getPreIpoCompanyInvestments(query: {
5708
+ /** company id */
5709
+ pre_ipo_company_id?: string;
5710
+ /** company name */
5711
+ company_name?: string;
5712
+ /** how many records to return. Max value is 50 */
5713
+ limit: number;
5714
+ /** how many records to skip */
5715
+ offset: number;
5716
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyInvestmentsResponse, HandleError>>;
5751
5717
  /**
5752
- * @description Remove market
5753
- * @tags MarketDates
5754
- * @name RemoveMarket
5755
- * @summary Remove market
5756
- * @request DELETE:/market-dates/markets/{market}
5718
+ * @description get pre ipo company investment by id
5719
+ * @tags PreIPOCompanies
5720
+ * @name GetPreIpoCompanyInvestmentsById
5721
+ * @summary get pre ipo company investment by id
5722
+ * @request GET:/ipos/pre-ipo-company-investments/{id}
5723
+ * @originalName getPreIpoCompanyInvestments
5724
+ * @duplicate
5757
5725
  * @secure
5758
5726
  */
5759
- removeMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5727
+ getPreIpoCompanyInvestmentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyInvestment, HandleError>>;
5760
5728
  /**
5761
- * @description Get market schedules
5762
- * @tags MarketDates
5763
- * @name GetMarketSchedules
5764
- * @summary Get market schedules
5765
- * @request GET:/market-dates/schedule
5729
+ * @description get pre ipo company news
5730
+ * @tags PreIPOCompanies
5731
+ * @name GetPreIpoCompanyNews
5732
+ * @summary get pre ipo company news
5733
+ * @request GET:/ipos/pre-ipo-company-news
5766
5734
  * @secure
5767
5735
  */
5768
- getMarketSchedules(query?: {
5769
- /** Market codes, comma separated */
5770
- market?: string;
5771
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse[][], HandleError>>;
5736
+ getPreIpoCompanyNews(query: {
5737
+ /** company id */
5738
+ pre_ipo_company_id?: string;
5739
+ /** search by headline */
5740
+ headline?: string;
5741
+ /** how many records to return. Max value is 50 */
5742
+ limit: number;
5743
+ /** how many records to skip */
5744
+ offset: number;
5745
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyNewsResponse, HandleError>>;
5772
5746
  /**
5773
- * @description CreateOrUpdateMarketSchedule market schedule
5774
- * @tags MarketDates
5775
- * @name CreateOrUpdateMarketSchedule
5776
- * @summary CreateOrUpdateMarketSchedule market schedule
5777
- * @request POST:/market-dates/schedule
5747
+ * @description get pre ipo company news by id
5748
+ * @tags PreIPOCompanies
5749
+ * @name GetPreIpoCompanyNewsById
5750
+ * @summary get pre ipo company news by id
5751
+ * @request GET:/ipos/pre-ipo-company-news/{id}
5752
+ * @originalName getPreIpoCompanyNews
5753
+ * @duplicate
5778
5754
  * @secure
5779
5755
  */
5780
- createOrUpdateMarketSchedule(market: InsightCreateOrUpdateMarketScheduleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
5756
+ getPreIpoCompanyNewsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyNews, HandleError>>;
5781
5757
  /**
5782
- * @description Get market schedule
5783
- * @tags MarketDates
5784
- * @name GetMarketSchedule
5785
- * @summary Get market schedule
5786
- * @request GET:/market-dates/schedule/{market}
5758
+ * @description get pre ipo company research documents
5759
+ * @tags PreIPOCompanies
5760
+ * @name GetPreIpoCompanyResearchDocuments
5761
+ * @summary get pre ipo company research documents
5762
+ * @request GET:/ipos/pre-ipo-company-research-documents
5787
5763
  * @secure
5788
5764
  */
5789
- getMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
5765
+ getPreIpoCompanyResearchDocuments(query: {
5766
+ /** company id */
5767
+ pre_ipo_company_id?: string;
5768
+ /** search by title */
5769
+ title?: string;
5770
+ /** how many records to return. Max value is 50 */
5771
+ limit: number;
5772
+ /** how many records to skip */
5773
+ offset: number;
5774
+ /** search by research type */
5775
+ research_type?: InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum;
5776
+ /** search by relation */
5777
+ relation?: InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum;
5778
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError>>;
5790
5779
  /**
5791
- * @description Remove market schedule
5792
- * @tags MarketDates
5793
- * @name RemoveMarketSchedule
5794
- * @summary Remove market schedule
5795
- * @request DELETE:/market-dates/schedule/{market}
5780
+ * @description get pre ipo company research document by id
5781
+ * @tags PreIPOCompanies
5782
+ * @name GetPreIpoCompanyResearchDocumentsById
5783
+ * @summary get pre ipo company research document by id
5784
+ * @request GET:/ipos/pre-ipo-company-research-documents/{id}
5785
+ * @originalName getPreIpoCompanyResearchDocuments
5786
+ * @duplicate
5796
5787
  * @secure
5797
5788
  */
5798
- removeMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5789
+ getPreIpoCompanyResearchDocumentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyResearchDocument, HandleError>>;
5799
5790
  /**
5800
- * @description Get todays market hours
5801
- * @tags MarketDates
5802
- * @name GetTodaysMarketHours
5803
- * @summary Get todays market hours
5804
- * @request GET:/market-dates/today
5791
+ * @description get pre ipo company spvs with investor id
5792
+ * @tags PreIPOCompanies
5793
+ * @name GetInvestor
5794
+ * @summary get pre ipo company spvs with investor id
5795
+ * @request GET:/ipos/pre-ipo-company-spv/investor/{investor_id}
5805
5796
  * @secure
5806
5797
  */
5807
- getTodaysMarketHours(query: {
5808
- /** Market */
5809
- market: string;
5810
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
5811
- }
5812
- export class News<HandleError extends boolean = boolean> {
5813
- protected readonly apiClient: JwtClient<HandleError>;
5814
- constructor(apiClient: JwtClient<HandleError>);
5798
+ getInvestor(investorId: string, query: {
5799
+ /** search by monark stage */
5800
+ monark_stage?: InsightGetInvestorParamsMonarkStageEnum;
5801
+ /** Optional param to filter returned spv's based on the exemptions claimed */
5802
+ exemptions_claimed?: string[];
5803
+ /** Optional param to filter returned spv's based on the name */
5804
+ name_filter?: string;
5805
+ /** investment id */
5806
+ pre_ipo_company_id?: string;
5807
+ /** investment id */
5808
+ pre_ipo_company_investment_id?: string;
5809
+ /** page number */
5810
+ page: number;
5811
+ /** page size */
5812
+ page_size: number;
5813
+ /** sort direction */
5814
+ sort_order?: InsightGetInvestorParamsSortOrderEnum;
5815
+ /** sort field */
5816
+ sort_by?: InsightGetInvestorParamsSortByEnum;
5817
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsWithInvestorIDResponse, HandleError>>;
5815
5818
  /**
5816
- * @description Returns available authors in DB
5817
- * @tags News
5818
- * @name NewsAvailableAuthors
5819
- * @summary Get available authors in DB (for filters)
5820
- * @request POST:/news/authors
5819
+ * @description get pre ipo company spv by id with investor id
5820
+ * @tags PreIPOCompanies
5821
+ * @name GetInvestorByIdAndInvestorId
5822
+ * @summary get pre ipo company spv by id with investor id
5823
+ * @request GET:/ipos/pre-ipo-company-spv/{id}/investor/{investor_id}
5824
+ * @originalName getInvestor
5825
+ * @duplicate
5821
5826
  * @secure
5822
5827
  */
5823
- newsAvailableAuthors(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5824
- /**
5825
- * @description Returns available channels in DB
5826
- * @tags News
5827
- * @name NewsAvailableChannels
5828
- * @summary Get available channels in DB (for filters)
5829
- * @request POST:/news/channels
5830
- * @secure
5831
- */
5832
- newsAvailableChannels(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5828
+ getInvestorByIdAndInvestorId(id: string, investorId: string, query?: {
5829
+ /** default is false, if true documents will be included in the response */
5830
+ include_documents?: boolean;
5831
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetProIPOCompabySPVWithInvestorIDResponse, HandleError>>;
5833
5832
  /**
5834
- * @description Get featured articles
5835
- * @tags News
5836
- * @name GetFeaturedArticles
5837
- * @summary Get featured articles
5838
- * @request GET:/news/featured-articles
5833
+ * @description get pre ipo company spvs
5834
+ * @tags PreIPOCompanies
5835
+ * @name GetPreIpoCompanySpvs
5836
+ * @summary get pre ipo company spvs
5837
+ * @request GET:/ipos/pre-ipo-company-spvs
5839
5838
  * @secure
5840
5839
  */
5841
- getFeaturedArticles(query: {
5842
- /** Limit */
5840
+ getPreIpoCompanySpvs(query: {
5841
+ /** company id */
5842
+ pre_ipo_company_id?: string;
5843
+ /** investment id */
5844
+ investment_id?: string;
5845
+ /** search by name */
5846
+ name?: string;
5847
+ /** search by company name */
5848
+ company_name?: string;
5849
+ /** how many records to return. Max value is 50 */
5843
5850
  limit: number;
5844
- /** Offset */
5851
+ /** how many records to skip */
5845
5852
  offset: number;
5846
- /** Start date */
5847
- start_date?: string;
5848
- /** End date */
5849
- end_date?: string;
5850
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
5853
+ /** search by monark stage */
5854
+ monark_stage?: InsightGetPreIpoCompanySpvsParamsMonarkStageEnum;
5855
+ /** sort direction */
5856
+ direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
5857
+ /** sort field */
5858
+ field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
5859
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
5851
5860
  /**
5852
- * @description Update featured articles
5853
- * @tags News
5854
- * @name UpdateFeaturedArticles
5855
- * @summary Update featured articles
5856
- * @request PUT:/news/featured-articles
5861
+ * @description get pre ipo company spv by id
5862
+ * @tags PreIPOCompanies
5863
+ * @name GetPreIpoCompanySpvsById
5864
+ * @summary get pre ipo company spv by id
5865
+ * @request GET:/ipos/pre-ipo-company-spvs/{id}
5866
+ * @originalName getPreIpoCompanySpvs
5867
+ * @duplicate
5857
5868
  * @secure
5858
5869
  */
5859
- updateFeaturedArticles(input: InsightUpdateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5870
+ getPreIpoCompanySpvsById(id: string, query?: {
5871
+ /** default is false, if true documents will be included in the response */
5872
+ include_documents?: boolean;
5873
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
5874
+ }
5875
+ export class Ipos<HandleError extends boolean = boolean> {
5876
+ protected readonly apiClient: JwtClient<HandleError>;
5877
+ constructor(apiClient: JwtClient<HandleError>);
5860
5878
  /**
5861
- * @description Create featured articles
5862
- * @tags News
5863
- * @name CreateFeaturedArticles
5864
- * @summary Create featured articles
5865
- * @request POST:/news/featured-articles
5879
+ * @description get recent ipos info
5880
+ * @tags Ipos
5881
+ * @name PostRecent
5882
+ * @summary get recent ipos info
5883
+ * @request POST:/ipos/recent
5866
5884
  * @secure
5867
5885
  */
5868
- createFeaturedArticles(input: InsightCreateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5886
+ postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5869
5887
  /**
5870
- * @description Get active featured articles
5871
- * @tags News
5872
- * @name GetActiveFeaturedArticles
5873
- * @summary Get active featured articles
5874
- * @request GET:/news/featured-articles/active
5888
+ * @description get upcoming ipos info
5889
+ * @tags Ipos
5890
+ * @name GetUpcoming
5891
+ * @summary get upcoming ipos info
5892
+ * @request GET:/ipos/upcoming
5875
5893
  * @secure
5876
5894
  */
5877
- getActiveFeaturedArticles(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
5895
+ getUpcoming(query: {
5896
+ /** how many records to return. Max value is 50 */
5897
+ limit: number;
5898
+ /** how many records to skip */
5899
+ offset: number;
5900
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
5878
5901
  /**
5879
- * @description Set featured articles
5880
- * @tags News
5881
- * @name SetFeaturedArticles
5882
- * @summary Set featured articles
5883
- * @request POST:/news/featured-articles/set
5902
+ * @description get ipo info by symbol
5903
+ * @tags Ipos
5904
+ * @name GetIpos
5905
+ * @summary get ipo info by symbol
5906
+ * @request GET:/ipos/{symbol}
5884
5907
  * @secure
5885
5908
  */
5886
- setFeaturedArticles(input: InsightSetFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
5909
+ getIpos(symbol: string, query?: {
5910
+ /** load quotes */
5911
+ load_quotes?: boolean;
5912
+ /** statuses */
5913
+ statuses?: string[];
5914
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
5915
+ }
5916
+ export class Logos<HandleError extends boolean = boolean> {
5917
+ protected readonly apiClient: JwtClient<HandleError>;
5918
+ constructor(apiClient: JwtClient<HandleError>);
5887
5919
  /**
5888
- * @description Get featured article
5889
- * @tags News
5890
- * @name GetFeaturedArticle
5891
- * @summary Get featured article
5892
- * @request GET:/news/featured-articles/{id}
5920
+ * @description Returns converted logo for crypto symbol
5921
+ * @tags Logos
5922
+ * @name LogosConvertedCryptoSymbolLogo
5923
+ * @summary Get converted logo for crypto symbol
5924
+ * @request POST:/logos/converted-crypto-symbol-logo
5893
5925
  * @secure
5894
5926
  */
5895
- getFeaturedArticle(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticle, HandleError>>;
5927
+ logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5896
5928
  /**
5897
- * @description Returns news by filters
5898
- * @tags News
5899
- * @name NewsFiltered
5900
- * @summary Get filtered news
5901
- * @request POST:/news/filter
5929
+ * @description Returns converted logo for symbol
5930
+ * @tags Logos
5931
+ * @name LogosConvertedSymbolLogo
5932
+ * @summary Get converted logo for symbol
5933
+ * @request POST:/logos/converted-symbol-logo
5902
5934
  * @secure
5903
5935
  */
5904
- newsFiltered(filter: InsightNewsFilterRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsResponse, HandleError>>;
5936
+ logosConvertedSymbolLogo(filter: InsightSymbolLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5905
5937
  /**
5906
- * @description Returns news by id
5907
- * @tags News
5908
- * @name NewsById
5909
- * @summary Get news by id
5910
- * @request POST:/news/id
5938
+ * @description Returns logo for crypto symbol
5939
+ * @tags Logos
5940
+ * @name LogosCryptoSymbolLogo
5941
+ * @summary Get logo for crypto symbol
5942
+ * @request GET:/logos/crypto-symbol-logo
5911
5943
  * @secure
5912
5944
  */
5913
- newsById(filter: InsightNewsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNews, HandleError>>;
5945
+ logosCryptoSymbolLogo(query: {
5946
+ /** Company symbol */
5947
+ symbol: string;
5948
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError>>;
5914
5949
  /**
5915
- * @description Returns news previews
5916
- * @tags News
5917
- * @name NewsPreviewsFiltered
5918
- * @summary Get news previews
5919
- * @request GET:/news/previews
5950
+ * @description Returns direct logo for crypto symbol
5951
+ * @tags Logos
5952
+ * @name LogosDirectCryptoSymbolLogo
5953
+ * @summary Get direct logo for crypto symbol
5954
+ * @request GET:/logos/direct-crypto-symbol-logo
5920
5955
  * @secure
5921
5956
  */
5922
- newsPreviewsFiltered(query: {
5923
- /** Start date */
5924
- start_date?: string;
5925
- /** End date */
5926
- end_date?: string;
5927
- /** Symbol */
5928
- symbol?: string;
5929
- /** how many records to return. Max value is 50 */
5930
- limit: number;
5931
- /** how many records to skip */
5932
- offset: number;
5933
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRecentNewsPreviewsResponse, HandleError>>;
5957
+ logosDirectCryptoSymbolLogo(query: {
5958
+ /** Company symbol */
5959
+ symbol: string;
5960
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5934
5961
  /**
5935
- * @description Returns available stocks in DB
5936
- * @tags News
5937
- * @name NewsAvailableStocks
5938
- * @summary Get available stocks in DB (for filters)
5939
- * @request GET:/news/symbols
5962
+ * @description Returns direct logo for symbol
5963
+ * @tags Logos
5964
+ * @name LogosDirectSymbolLogo
5965
+ * @summary Get direct logo for symbol
5966
+ * @request GET:/logos/direct-symbol-logo
5940
5967
  * @secure
5941
5968
  */
5942
- newsAvailableStocks(query?: {
5943
- /** Limit */
5944
- limit?: number;
5945
- /** Offset */
5946
- offset?: number;
5947
- /** search query */
5948
- search_query?: string;
5949
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5969
+ logosDirectSymbolLogo(query: {
5970
+ /** Company symbol */
5971
+ symbol: string;
5972
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
5950
5973
  /**
5951
- * @description Returns available tags in DB
5952
- * @tags News
5953
- * @name NewsAvailableTags
5954
- * @summary Get available tags in DB (for filters)
5955
- * @request POST:/news/tags
5974
+ * @description Returns logos for multiple symbols
5975
+ * @tags Logos
5976
+ * @name LogosMultipleCryptoSymbolLogo
5977
+ * @summary Get logos for multiple symbols
5978
+ * @request POST:/logos/multiple-crypto-symbol-logo
5956
5979
  * @secure
5957
5980
  */
5958
- newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
5959
- }
5960
- export class OptionGreeks<HandleError extends boolean = boolean> {
5961
- protected readonly apiClient: JwtClient<HandleError>;
5962
- constructor(apiClient: JwtClient<HandleError>);
5981
+ logosMultipleCryptoSymbolLogo(filter: InsightMultipleCryptoLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse[], HandleError>>;
5963
5982
  /**
5964
- * @description Returns calculated matrix
5965
- * @tags OptionGreeks
5966
- * @name OgCalculateMatrix
5967
- * @summary Calculate matrix
5968
- * @request POST:/og/calculate-matrix
5983
+ * @description Returns logos for multiple symbol
5984
+ * @tags Logos
5985
+ * @name LogosMultipleSymbolLogos
5986
+ * @summary Get logos for multiple symbols
5987
+ * @request POST:/logos/multiple-symbol-logos
5969
5988
  * @secure
5970
5989
  */
5971
- ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
5990
+ logosMultipleSymbolLogos(filter: InsightMultipleSymbolLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse[], HandleError>>;
5972
5991
  /**
5973
- * @description Returns calculated params
5974
- * @tags OptionGreeks
5975
- * @name OgCalculateParams
5976
- * @summary Calculate params
5977
- * @request POST:/og/calculate-params
5992
+ * @description Returns links of socials logos for symbol
5993
+ * @tags Logos
5994
+ * @name LogosSocialSymbolLogos
5995
+ * @summary Get social logos for symbol
5996
+ * @request GET:/logos/social-symbol-logos
5978
5997
  * @secure
5979
5998
  */
5980
- ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
5981
- }
5982
- export class Ownerships<HandleError extends boolean = boolean> {
5983
- protected readonly apiClient: JwtClient<HandleError>;
5984
- constructor(apiClient: JwtClient<HandleError>);
5999
+ logosSocialSymbolLogos(query: {
6000
+ /** Company symbol */
6001
+ symbol: string;
6002
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
5985
6003
  /**
5986
- * @description get ownerships by id datadata
5987
- * @tags Ownerships
5988
- * @name GetOwnershipsByIdData
5989
- * @summary get ownerships by id data
5990
- * @request POST:/ownerships
5991
- * @secure
5992
- */
5993
- getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
5994
- /**
5995
- * @description get ownerships by symbol data
5996
- * @tags Ownerships
5997
- * @name GetOwnershipsBySymbolData
5998
- * @summary get ownerships by symbol data
5999
- * @request POST:/symbol-ownerships
6004
+ * @description Returns logos for company symbol
6005
+ * @tags Logos
6006
+ * @name LogosSymbolLogos
6007
+ * @summary Get symbol logos
6008
+ * @request GET:/logos/symbol-logos
6000
6009
  * @secure
6001
6010
  */
6002
- getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
6011
+ logosSymbolLogos(query: {
6012
+ /** Company symbol */
6013
+ symbol: string;
6014
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
6003
6015
  }
6004
- export class Passport<HandleError extends boolean = boolean> {
6016
+ export class MarketDates<HandleError extends boolean = boolean> {
6005
6017
  protected readonly apiClient: JwtClient<HandleError>;
6006
6018
  constructor(apiClient: JwtClient<HandleError>);
6007
6019
  /**
6008
- * @description Returns article by id
6009
- * @tags Passport
6010
- * @name PassportArticleById
6011
- * @summary Get article by id
6012
- * @request POST:/passport/article-by-id
6020
+ * @description Create or update market date
6021
+ * @tags MarketDates
6022
+ * @name CreateOrUpdateMarketDate
6023
+ * @summary Create or update market date
6024
+ * @request POST:/market-dates
6013
6025
  * @secure
6014
6026
  */
6015
- passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
6027
+ createOrUpdateMarketDate(market: InsightMarketDates[], config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketDate[], HandleError>>;
6016
6028
  /**
6017
- * @description Returns articles
6018
- * @tags Passport
6019
- * @name PassportArticles
6020
- * @summary Get articles
6021
- * @request POST:/passport/articles
6029
+ * @description Remove market date
6030
+ * @tags MarketDates
6031
+ * @name RemoveMarketDate
6032
+ * @summary Remove market date
6033
+ * @request DELETE:/market-dates
6022
6034
  * @secure
6023
6035
  */
6024
- passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
6036
+ removeMarketDate(input: InsightRemoveMarketDateRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6025
6037
  /**
6026
- * @description Returns author profile
6027
- * @tags Passport
6028
- * @name PassportAuthorProfile
6029
- * @summary Get author profile
6030
- * @request POST:/passport/author-profile
6038
+ * @description Get market dates history
6039
+ * @tags MarketDates
6040
+ * @name GetMarketDatesHistory
6041
+ * @summary Get market dates history
6042
+ * @request POST:/market-dates/history
6031
6043
  * @secure
6032
6044
  */
6033
- passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
6045
+ getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
6034
6046
  /**
6035
- * @description Returns most popular tags
6036
- * @tags Passport
6037
- * @name PassportMostPopularTags
6038
- * @summary Get most popular tags
6039
- * @request POST:/passport/most-popular-tags
6047
+ * @description Search locode data by search string and field
6048
+ * @tags MarketDates
6049
+ * @name SearchLocodeData
6050
+ * @summary Search locode data
6051
+ * @request GET:/market-dates/locode
6040
6052
  * @secure
6041
6053
  */
6042
- passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
6054
+ searchLocodeData(query?: {
6055
+ /** Search string */
6056
+ search?: string;
6057
+ /** Search field */
6058
+ field?: InsightSearchLocodeDataParamsFieldEnum;
6059
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSearchLocodeDataResponse, HandleError>>;
6043
6060
  /**
6044
- * @description Returns news feed
6045
- * @tags Passport
6046
- * @name PassportNewsFeed
6047
- * @summary Get news feed
6048
- * @request POST:/passport/newsfeed
6061
+ * @description Get markets
6062
+ * @tags MarketDates
6063
+ * @name GetMarkets
6064
+ * @summary Get markets
6065
+ * @request GET:/market-dates/markets
6049
6066
  * @secure
6050
6067
  */
6051
- passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
6068
+ getMarkets(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketsResponse, HandleError>>;
6052
6069
  /**
6053
- * @description Returns article by parameters
6054
- * @tags Passport
6055
- * @name PassportSearchArticle
6056
- * @summary Search article by parameters
6057
- * @request POST:/passport/search-article
6070
+ * @description Create or update market
6071
+ * @tags MarketDates
6072
+ * @name CreateOrUpdateMarket
6073
+ * @summary Create or update market
6074
+ * @request POST:/market-dates/markets
6058
6075
  * @secure
6059
6076
  */
6060
- passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
6061
- }
6062
- export class PreIpoCompanies<HandleError extends boolean = boolean> {
6063
- protected readonly apiClient: JwtClient<HandleError>;
6064
- constructor(apiClient: JwtClient<HandleError>);
6077
+ createOrUpdateMarket(market: InsightCreateOrUpdateMarketRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarket, HandleError>>;
6065
6078
  /**
6066
- * @description Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
6067
- * @tags PreIPOCompanies
6068
- * @name MonarkOghlcDataForSymbol
6069
- * @summary Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
6070
- * @request GET:/ipos/market-data/ohlc/{symbol}
6079
+ * @description Get market
6080
+ * @tags MarketDates
6081
+ * @name GetMarket
6082
+ * @summary Get market
6083
+ * @request GET:/market-dates/markets/{market}
6071
6084
  * @secure
6072
6085
  */
6073
- monarkOghlcDataForSymbol(symbol: string, query?: {
6074
- /** Start time for the OHLC data in ISO 8601 format YYYY-MM-DD */
6075
- from?: string;
6076
- /** End time for the OHLC data in ISO 8601 format YYYY-MM-DD */
6077
- to?: string;
6078
- /** Time interval for buckets: 1d (day), 1w (week), 1mo (month), 3mo (3 months). Default is 1d. */
6079
- interval?: string;
6080
- /** Limit the number of OHLC data points returned. Default is 100. */
6081
- limit?: number;
6082
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<{
6083
- close?: number;
6084
- high?: number;
6085
- low?: number;
6086
- open?: number;
6087
- time?: string;
6088
- volume?: number;
6089
- }[], HandleError>>;
6086
+ getMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketWithSchedule, HandleError>>;
6090
6087
  /**
6091
- * @description Retrieves all symbols available in the market data
6092
- * @tags PreIPOCompanies
6093
- * @name MonarkAllAvailableSymbols
6094
- * @summary Retrieves all symbols available in the market data
6095
- * @request GET:/ipos/market-data/symbols
6088
+ * @description Remove market
6089
+ * @tags MarketDates
6090
+ * @name RemoveMarket
6091
+ * @summary Remove market
6092
+ * @request DELETE:/market-dates/markets/{market}
6096
6093
  * @secure
6097
6094
  */
6098
- monarkAllAvailableSymbols(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
6095
+ removeMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6099
6096
  /**
6100
- * @description get pre ipo companies Avaliable categories: on-demand business-video reverse-etl modern-data-stack video-api global-payroll banking-as-a-service ultrafast-delivery online-grocery website-builder fintech b2b venture-capital ecommerce creator-economy productivity real-estate private-markets-exchanges fpa vertical-saas card-issuing connected-fitness gig-marketplaces cms soc-2 analytics cap-table-management contractor-payroll social-media design online-whiteboard conversational-marketing expense-management stock-option-financing customer-onboarding crypto help-desk payroll documents databases mortgage-lending crypto-exchange marketing-automation payments operations checkout cybersecurity messaging investing marketplaces climate-tech robotics data-security online-education gaming universal-api automation biotechnology contact-center defense machine-learning logistics prefab-tech materials telehealth b2c alternative-proteins b2b-marketplaces wealth-management web3 neobank managed-marketplaces plg-crm jamstack public-safety background-checks identity-verification construction home-services sales blockchain-developer-platform space financial-data-aggregation ai writing-assistant autonomous-driving 401k-provider vector-databases ai-models devtools payroll-api internal-tools mlops bookkeeping cloud-infrastructure data-backups personal-finance ai-frameworks generative-ai cloud-gpus micromobility ai-avatars ai-chips life-sciences partnerships wearables fitness-tracking ai-search ai-medical-scribes networking quantum-computing code-editors
6101
- * @tags PreIPOCompanies
6102
- * @name GetPreIpoCompanies
6103
- * @summary get pre ipo companies
6104
- * @request GET:/ipos/pre-ipo-companies
6097
+ * @description Get market schedules
6098
+ * @tags MarketDates
6099
+ * @name GetMarketSchedules
6100
+ * @summary Get market schedules
6101
+ * @request GET:/market-dates/schedule
6105
6102
  * @secure
6106
6103
  */
6107
- getPreIpoCompanies(query: {
6108
- /** search by company name */
6109
- name?: string;
6110
- /** search by categories */
6111
- categories?: string;
6112
- /** search by listing type */
6113
- listing_type?: string;
6114
- /** filter by active status */
6115
- is_active?: InsightGetPreIpoCompaniesParamsIsActiveEnum;
6116
- /** filter by minimum last valuation */
6117
- min_last_valuation?: number;
6118
- /** filter by maximum last valuation */
6119
- max_last_valuation?: number;
6120
- /** filter by minimum total funding */
6121
- min_total_funding?: number;
6122
- /** filter by maximum total funding */
6123
- max_total_funding?: number;
6124
- /** how many records to return. Max value is 50 */
6125
- limit: number;
6126
- /** how many records to skip */
6127
- offset: number;
6128
- /** sort field */
6129
- order_field?: InsightGetPreIpoCompaniesParamsOrderFieldEnum;
6130
- /** sort direction */
6131
- order_direction?: InsightGetPreIpoCompaniesParamsOrderDirectionEnum;
6132
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
6104
+ getMarketSchedules(query?: {
6105
+ /** Market codes, comma separated */
6106
+ market?: string;
6107
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse[][], HandleError>>;
6133
6108
  /**
6134
- * @description get pre ipo company by id
6135
- * @tags PreIPOCompanies
6136
- * @name GetPreIpoCompaniesById
6137
- * @summary get pre ipo company by id
6138
- * @request GET:/ipos/pre-ipo-companies/{id}
6139
- * @originalName getPreIpoCompanies
6140
- * @duplicate
6109
+ * @description CreateOrUpdateMarketSchedule market schedule
6110
+ * @tags MarketDates
6111
+ * @name CreateOrUpdateMarketSchedule
6112
+ * @summary CreateOrUpdateMarketSchedule market schedule
6113
+ * @request POST:/market-dates/schedule
6141
6114
  * @secure
6142
6115
  */
6143
- getPreIpoCompaniesById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompany, HandleError>>;
6116
+ createOrUpdateMarketSchedule(market: InsightCreateOrUpdateMarketScheduleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
6144
6117
  /**
6145
- * @description get pre ipo company funding rounds
6146
- * @tags PreIPOCompanies
6147
- * @name GetPreIpoCompanyFundingRounds
6148
- * @summary get pre ipo company funding rounds
6149
- * @request GET:/ipos/pre-ipo-company-funding-rounds
6118
+ * @description Get market schedule
6119
+ * @tags MarketDates
6120
+ * @name GetMarketSchedule
6121
+ * @summary Get market schedule
6122
+ * @request GET:/market-dates/schedule/{market}
6150
6123
  * @secure
6151
6124
  */
6152
- getPreIpoCompanyFundingRounds(query: {
6153
- /** company id */
6154
- pre_ipo_company_id?: string;
6155
- /** search by round name */
6156
- round_name?: string;
6157
- /** how many records to return. Max value is 50 */
6158
- limit: number;
6159
- /** how many records to skip */
6160
- offset: number;
6161
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyFundingRoundsResponse, HandleError>>;
6125
+ getMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
6162
6126
  /**
6163
- * @description get pre ipo company funding round by id
6164
- * @tags PreIPOCompanies
6165
- * @name GetPreIpoCompanyFundingRoundsById
6166
- * @summary get pre ipo company funding round by id
6167
- * @request GET:/ipos/pre-ipo-company-funding-rounds/{id}
6168
- * @originalName getPreIpoCompanyFundingRounds
6169
- * @duplicate
6127
+ * @description Remove market schedule
6128
+ * @tags MarketDates
6129
+ * @name RemoveMarketSchedule
6130
+ * @summary Remove market schedule
6131
+ * @request DELETE:/market-dates/schedule/{market}
6170
6132
  * @secure
6171
6133
  */
6172
- getPreIpoCompanyFundingRoundsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyFundingRound, HandleError>>;
6134
+ removeMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6173
6135
  /**
6174
- * @description get pre ipo company investments
6175
- * @tags PreIPOCompanies
6176
- * @name GetPreIpoCompanyInvestments
6177
- * @summary get pre ipo company investments
6178
- * @request GET:/ipos/pre-ipo-company-investments
6136
+ * @description Get todays market hours
6137
+ * @tags MarketDates
6138
+ * @name GetTodaysMarketHours
6139
+ * @summary Get todays market hours
6140
+ * @request GET:/market-dates/today
6179
6141
  * @secure
6180
6142
  */
6181
- getPreIpoCompanyInvestments(query: {
6182
- /** company id */
6183
- pre_ipo_company_id?: string;
6184
- /** company name */
6185
- company_name?: string;
6186
- /** how many records to return. Max value is 50 */
6187
- limit: number;
6188
- /** how many records to skip */
6189
- offset: number;
6190
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyInvestmentsResponse, HandleError>>;
6191
- /**
6192
- * @description get pre ipo company investment by id
6193
- * @tags PreIPOCompanies
6194
- * @name GetPreIpoCompanyInvestmentsById
6195
- * @summary get pre ipo company investment by id
6196
- * @request GET:/ipos/pre-ipo-company-investments/{id}
6197
- * @originalName getPreIpoCompanyInvestments
6198
- * @duplicate
6143
+ getTodaysMarketHours(query: {
6144
+ /** Market */
6145
+ market: string;
6146
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
6147
+ }
6148
+ export class News<HandleError extends boolean = boolean> {
6149
+ protected readonly apiClient: JwtClient<HandleError>;
6150
+ constructor(apiClient: JwtClient<HandleError>);
6151
+ /**
6152
+ * @description Returns available authors in DB
6153
+ * @tags News
6154
+ * @name NewsAvailableAuthors
6155
+ * @summary Get available authors in DB (for filters)
6156
+ * @request POST:/news/authors
6199
6157
  * @secure
6200
6158
  */
6201
- getPreIpoCompanyInvestmentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyInvestment, HandleError>>;
6159
+ newsAvailableAuthors(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
6202
6160
  /**
6203
- * @description get pre ipo company news
6204
- * @tags PreIPOCompanies
6205
- * @name GetPreIpoCompanyNews
6206
- * @summary get pre ipo company news
6207
- * @request GET:/ipos/pre-ipo-company-news
6161
+ * @description Returns available channels in DB
6162
+ * @tags News
6163
+ * @name NewsAvailableChannels
6164
+ * @summary Get available channels in DB (for filters)
6165
+ * @request POST:/news/channels
6208
6166
  * @secure
6209
6167
  */
6210
- getPreIpoCompanyNews(query: {
6211
- /** company id */
6212
- pre_ipo_company_id?: string;
6213
- /** search by headline */
6214
- headline?: string;
6215
- /** how many records to return. Max value is 50 */
6168
+ newsAvailableChannels(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
6169
+ /**
6170
+ * @description Get featured articles
6171
+ * @tags News
6172
+ * @name GetFeaturedArticles
6173
+ * @summary Get featured articles
6174
+ * @request GET:/news/featured-articles
6175
+ * @secure
6176
+ */
6177
+ getFeaturedArticles(query: {
6178
+ /** Limit */
6216
6179
  limit: number;
6217
- /** how many records to skip */
6180
+ /** Offset */
6218
6181
  offset: number;
6219
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyNewsResponse, HandleError>>;
6182
+ /** Start date */
6183
+ start_date?: string;
6184
+ /** End date */
6185
+ end_date?: string;
6186
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
6220
6187
  /**
6221
- * @description get pre ipo company news by id
6222
- * @tags PreIPOCompanies
6223
- * @name GetPreIpoCompanyNewsById
6224
- * @summary get pre ipo company news by id
6225
- * @request GET:/ipos/pre-ipo-company-news/{id}
6226
- * @originalName getPreIpoCompanyNews
6227
- * @duplicate
6188
+ * @description Update featured articles
6189
+ * @tags News
6190
+ * @name UpdateFeaturedArticles
6191
+ * @summary Update featured articles
6192
+ * @request PUT:/news/featured-articles
6228
6193
  * @secure
6229
6194
  */
6230
- getPreIpoCompanyNewsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyNews, HandleError>>;
6195
+ updateFeaturedArticles(input: InsightUpdateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6231
6196
  /**
6232
- * @description get pre ipo company research documents
6233
- * @tags PreIPOCompanies
6234
- * @name GetPreIpoCompanyResearchDocuments
6235
- * @summary get pre ipo company research documents
6236
- * @request GET:/ipos/pre-ipo-company-research-documents
6197
+ * @description Create featured articles
6198
+ * @tags News
6199
+ * @name CreateFeaturedArticles
6200
+ * @summary Create featured articles
6201
+ * @request POST:/news/featured-articles
6237
6202
  * @secure
6238
6203
  */
6239
- getPreIpoCompanyResearchDocuments(query: {
6240
- /** company id */
6241
- pre_ipo_company_id?: string;
6242
- /** search by title */
6243
- title?: string;
6244
- /** how many records to return. Max value is 50 */
6245
- limit: number;
6246
- /** how many records to skip */
6247
- offset: number;
6248
- /** search by research type */
6249
- research_type?: InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum;
6250
- /** search by relation */
6251
- relation?: InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum;
6252
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError>>;
6204
+ createFeaturedArticles(input: InsightCreateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6253
6205
  /**
6254
- * @description get pre ipo company research document by id
6255
- * @tags PreIPOCompanies
6256
- * @name GetPreIpoCompanyResearchDocumentsById
6257
- * @summary get pre ipo company research document by id
6258
- * @request GET:/ipos/pre-ipo-company-research-documents/{id}
6259
- * @originalName getPreIpoCompanyResearchDocuments
6260
- * @duplicate
6206
+ * @description Get active featured articles
6207
+ * @tags News
6208
+ * @name GetActiveFeaturedArticles
6209
+ * @summary Get active featured articles
6210
+ * @request GET:/news/featured-articles/active
6261
6211
  * @secure
6262
6212
  */
6263
- getPreIpoCompanyResearchDocumentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyResearchDocument, HandleError>>;
6213
+ getActiveFeaturedArticles(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
6264
6214
  /**
6265
- * @description get pre ipo company spvs with investor id
6266
- * @tags PreIPOCompanies
6267
- * @name GetInvestor
6268
- * @summary get pre ipo company spvs with investor id
6269
- * @request GET:/ipos/pre-ipo-company-spv/investor/{investor_id}
6215
+ * @description Set featured articles
6216
+ * @tags News
6217
+ * @name SetFeaturedArticles
6218
+ * @summary Set featured articles
6219
+ * @request POST:/news/featured-articles/set
6270
6220
  * @secure
6271
6221
  */
6272
- getInvestor(investorId: string, query: {
6273
- /** search by monark stage */
6274
- monark_stage?: InsightGetInvestorParamsMonarkStageEnum;
6275
- /** Optional param to filter returned spv's based on the exemptions claimed */
6276
- exemptions_claimed?: string[];
6277
- /** Optional param to filter returned spv's based on the name */
6278
- name_filter?: string;
6279
- /** investment id */
6280
- pre_ipo_company_id?: string;
6281
- /** investment id */
6282
- pre_ipo_company_investment_id?: string;
6283
- /** page number */
6284
- page: number;
6285
- /** page size */
6286
- page_size: number;
6287
- /** sort direction */
6288
- sort_order?: InsightGetInvestorParamsSortOrderEnum;
6289
- /** sort field */
6290
- sort_by?: InsightGetInvestorParamsSortByEnum;
6291
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsWithInvestorIDResponse, HandleError>>;
6222
+ setFeaturedArticles(input: InsightSetFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6292
6223
  /**
6293
- * @description get pre ipo company spv by id with investor id
6294
- * @tags PreIPOCompanies
6295
- * @name GetInvestorByIdAndInvestorId
6296
- * @summary get pre ipo company spv by id with investor id
6297
- * @request GET:/ipos/pre-ipo-company-spv/{id}/investor/{investor_id}
6298
- * @originalName getInvestor
6299
- * @duplicate
6224
+ * @description Get featured article
6225
+ * @tags News
6226
+ * @name GetFeaturedArticle
6227
+ * @summary Get featured article
6228
+ * @request GET:/news/featured-articles/{id}
6300
6229
  * @secure
6301
6230
  */
6302
- getInvestorByIdAndInvestorId(id: string, investorId: string, query?: {
6303
- /** default is false, if true documents will be included in the response */
6304
- include_documents?: boolean;
6305
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetProIPOCompabySPVWithInvestorIDResponse, HandleError>>;
6231
+ getFeaturedArticle(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticle, HandleError>>;
6306
6232
  /**
6307
- * @description get pre ipo company spvs
6308
- * @tags PreIPOCompanies
6309
- * @name GetPreIpoCompanySpvs
6310
- * @summary get pre ipo company spvs
6311
- * @request GET:/ipos/pre-ipo-company-spvs
6233
+ * @description Returns news by filters
6234
+ * @tags News
6235
+ * @name NewsFiltered
6236
+ * @summary Get filtered news
6237
+ * @request POST:/news/filter
6312
6238
  * @secure
6313
6239
  */
6314
- getPreIpoCompanySpvs(query: {
6315
- /** company id */
6316
- pre_ipo_company_id?: string;
6317
- /** investment id */
6318
- investment_id?: string;
6319
- /** search by name */
6320
- name?: string;
6321
- /** search by company name */
6322
- company_name?: string;
6240
+ newsFiltered(filter: InsightNewsFilterRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsResponse, HandleError>>;
6241
+ /**
6242
+ * @description Returns news by id
6243
+ * @tags News
6244
+ * @name NewsById
6245
+ * @summary Get news by id
6246
+ * @request POST:/news/id
6247
+ * @secure
6248
+ */
6249
+ newsById(filter: InsightNewsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNews, HandleError>>;
6250
+ /**
6251
+ * @description Returns news previews
6252
+ * @tags News
6253
+ * @name NewsPreviewsFiltered
6254
+ * @summary Get news previews
6255
+ * @request GET:/news/previews
6256
+ * @secure
6257
+ */
6258
+ newsPreviewsFiltered(query: {
6259
+ /** Start date */
6260
+ start_date?: string;
6261
+ /** End date */
6262
+ end_date?: string;
6263
+ /** Symbol */
6264
+ symbol?: string;
6323
6265
  /** how many records to return. Max value is 50 */
6324
6266
  limit: number;
6325
6267
  /** how many records to skip */
6326
6268
  offset: number;
6327
- /** search by monark stage */
6328
- monark_stage?: InsightGetPreIpoCompanySpvsParamsMonarkStageEnum;
6329
- /** sort direction */
6330
- direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
6331
- /** sort field */
6332
- field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
6333
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
6269
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRecentNewsPreviewsResponse, HandleError>>;
6334
6270
  /**
6335
- * @description get pre ipo company spv by id
6336
- * @tags PreIPOCompanies
6337
- * @name GetPreIpoCompanySpvsById
6338
- * @summary get pre ipo company spv by id
6339
- * @request GET:/ipos/pre-ipo-company-spvs/{id}
6340
- * @originalName getPreIpoCompanySpvs
6341
- * @duplicate
6271
+ * @description Returns available stocks in DB
6272
+ * @tags News
6273
+ * @name NewsAvailableStocks
6274
+ * @summary Get available stocks in DB (for filters)
6275
+ * @request GET:/news/symbols
6342
6276
  * @secure
6343
6277
  */
6344
- getPreIpoCompanySpvsById(id: string, query?: {
6345
- /** default is false, if true documents will be included in the response */
6346
- include_documents?: boolean;
6347
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
6278
+ newsAvailableStocks(query?: {
6279
+ /** Limit */
6280
+ limit?: number;
6281
+ /** Offset */
6282
+ offset?: number;
6283
+ /** search query */
6284
+ search_query?: string;
6285
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
6286
+ /**
6287
+ * @description Returns available tags in DB
6288
+ * @tags News
6289
+ * @name NewsAvailableTags
6290
+ * @summary Get available tags in DB (for filters)
6291
+ * @request POST:/news/tags
6292
+ * @secure
6293
+ */
6294
+ newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
6348
6295
  }
6349
- export class Public<HandleError extends boolean = boolean> {
6296
+ export class OptionGreeks<HandleError extends boolean = boolean> {
6350
6297
  protected readonly apiClient: JwtClient<HandleError>;
6351
6298
  constructor(apiClient: JwtClient<HandleError>);
6352
6299
  /**
6353
- * @description Calculate estimated returns for selected symbols. Uses split adjusted prices
6354
- * @tags Public
6355
- * @name CalculateEstimatedReturns
6356
- * @summary Calculate Estimated Returns
6357
- * @request GET:/public/estimated-returns
6300
+ * @description Returns calculated matrix
6301
+ * @tags OptionGreeks
6302
+ * @name OgCalculateMatrix
6303
+ * @summary Calculate matrix
6304
+ * @request POST:/og/calculate-matrix
6358
6305
  * @secure
6359
6306
  */
6360
- calculateEstimatedReturns(query: {
6361
- /** Single symbol */
6362
- symbol: string;
6307
+ ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
6308
+ /**
6309
+ * @description Returns calculated params
6310
+ * @tags OptionGreeks
6311
+ * @name OgCalculateParams
6312
+ * @summary Calculate params
6313
+ * @request POST:/og/calculate-params
6314
+ * @secure
6315
+ */
6316
+ ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
6317
+ }
6318
+ export class Ownerships<HandleError extends boolean = boolean> {
6319
+ protected readonly apiClient: JwtClient<HandleError>;
6320
+ constructor(apiClient: JwtClient<HandleError>);
6321
+ /**
6322
+ * @description get ownerships by id datadata
6323
+ * @tags Ownerships
6324
+ * @name GetOwnershipsByIdData
6325
+ * @summary get ownerships by id data
6326
+ * @request POST:/ownerships
6327
+ * @secure
6328
+ */
6329
+ getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
6330
+ /**
6331
+ * @description get ownerships by symbol data
6332
+ * @tags Ownerships
6333
+ * @name GetOwnershipsBySymbolData
6334
+ * @summary get ownerships by symbol data
6335
+ * @request POST:/symbol-ownerships
6336
+ * @secure
6337
+ */
6338
+ getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
6339
+ }
6340
+ export class Passport<HandleError extends boolean = boolean> {
6341
+ protected readonly apiClient: JwtClient<HandleError>;
6342
+ constructor(apiClient: JwtClient<HandleError>);
6343
+ /**
6344
+ * @description Returns article by id
6345
+ * @tags Passport
6346
+ * @name PassportArticleById
6347
+ * @summary Get article by id
6348
+ * @request POST:/passport/article-by-id
6349
+ * @secure
6350
+ */
6351
+ passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
6352
+ /**
6353
+ * @description Returns articles
6354
+ * @tags Passport
6355
+ * @name PassportArticles
6356
+ * @summary Get articles
6357
+ * @request POST:/passport/articles
6358
+ * @secure
6359
+ */
6360
+ passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
6361
+ /**
6362
+ * @description Returns author profile
6363
+ * @tags Passport
6364
+ * @name PassportAuthorProfile
6365
+ * @summary Get author profile
6366
+ * @request POST:/passport/author-profile
6367
+ * @secure
6368
+ */
6369
+ passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
6370
+ /**
6371
+ * @description Returns most popular tags
6372
+ * @tags Passport
6373
+ * @name PassportMostPopularTags
6374
+ * @summary Get most popular tags
6375
+ * @request POST:/passport/most-popular-tags
6376
+ * @secure
6377
+ */
6378
+ passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
6379
+ /**
6380
+ * @description Returns news feed
6381
+ * @tags Passport
6382
+ * @name PassportNewsFeed
6383
+ * @summary Get news feed
6384
+ * @request POST:/passport/newsfeed
6385
+ * @secure
6386
+ */
6387
+ passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
6388
+ /**
6389
+ * @description Returns article by parameters
6390
+ * @tags Passport
6391
+ * @name PassportSearchArticle
6392
+ * @summary Search article by parameters
6393
+ * @request POST:/passport/search-article
6394
+ * @secure
6395
+ */
6396
+ passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
6397
+ }
6398
+ export class Public<HandleError extends boolean = boolean> {
6399
+ protected readonly apiClient: JwtClient<HandleError>;
6400
+ constructor(apiClient: JwtClient<HandleError>);
6401
+ /**
6402
+ * @description Calculate estimated returns for selected symbols. Uses split adjusted prices
6403
+ * @tags Public
6404
+ * @name CalculateEstimatedReturns
6405
+ * @summary Calculate Estimated Returns
6406
+ * @request GET:/public/estimated-returns
6407
+ * @secure
6408
+ */
6409
+ calculateEstimatedReturns(query: {
6410
+ /** Single symbol */
6411
+ symbol: string;
6363
6412
  /**
6364
6413
  * Non-zero amount
6365
6414
  * @format float64
@@ -6475,238 +6524,106 @@ export class Public<HandleError extends boolean = boolean> {
6475
6524
  offset: number;
6476
6525
  }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
6477
6526
  }
6478
- export class Quotes<HandleError extends boolean = boolean> {
6527
+ export class AlphaTools<HandleError extends boolean = boolean> {
6479
6528
  protected readonly apiClient: JwtClient<HandleError>;
6480
6529
  constructor(apiClient: JwtClient<HandleError>);
6481
6530
  /**
6482
- * @description Get single historical quote
6483
- * @tags Quotes
6484
- * @name GitHistoricalQuote
6485
- * @summary Get single historical quote
6486
- * @request GET:/historical/quote
6487
- * @secure
6488
- */
6489
- gitHistoricalQuote(query: {
6490
- /** Symbol */
6491
- symbol: string;
6492
- /** Date */
6493
- date: string;
6494
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
6495
- /**
6496
- * @description get quote history by symbol
6497
- * @tags Quotes
6498
- * @name GitQuoteHistory
6499
- * @summary Get quote history
6500
- * @request POST:/quote-history
6531
+ * @description get seasonlity data with comparison to benchmark
6532
+ * @tags AlphaTools
6533
+ * @name GetMomentumRatioGraph
6534
+ * @summary get seasonlity data
6535
+ * @request POST:/rst
6501
6536
  * @secure
6502
6537
  */
6503
- gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
6538
+ getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
6504
6539
  /**
6505
- * @description Returns a list of quotes equity info for specified symbols.
6506
- * @tags Quotes
6507
- * @name GetQuotesEquityData
6508
- * @summary Get Quotes Equity data
6509
- * @request GET:/quotes/equity
6540
+ * @description get seasonlity data with comparison to benchmark
6541
+ * @tags AlphaTools
6542
+ * @name GetSeasonality
6543
+ * @summary get seasonlity data
6544
+ * @request POST:/seasonality
6510
6545
  * @secure
6511
6546
  */
6512
- getQuotesEquityData(query: {
6513
- /** Comma separated symbols */
6514
- symbols: string;
6515
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
6547
+ getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
6516
6548
  }
6517
- export class StockScreener<HandleError extends boolean = boolean> {
6549
+ export class TipRank<HandleError extends boolean = boolean> {
6518
6550
  protected readonly apiClient: JwtClient<HandleError>;
6519
6551
  constructor(apiClient: JwtClient<HandleError>);
6520
6552
  /**
6521
- * @description data for visual heat map
6522
- * @tags StockScreener
6523
- * @name StockMarketHeatmap
6524
- * @summary data for visual heat map
6525
- * @request GET:/heatmaps
6553
+ * @description Returns an overview of analyst ratings for a given ticker or ticker list, based on analyst ratings from the last 3 months.
6554
+ * @tags TipRank
6555
+ * @name TiprankAnalystConsensus
6556
+ * @summary Get tiprank AnalystConsensus
6557
+ * @request POST:/tipranks/analyst-consensus
6526
6558
  * @secure
6527
6559
  */
6528
- stockMarketHeatmap(query?: {
6529
- /** Name of symbol list to fetch details for. Empty is default */
6530
- heatmap_name?: string;
6531
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
6560
+ tiprankAnalystConsensus(filter: InsightAnalystConsensusRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystConsensusResponse[], HandleError>>;
6532
6561
  /**
6533
- * @description create or update heat map preset
6534
- * @tags StockScreener
6535
- * @name CreateStockMarketHeatmapPreset
6536
- * @summary create or update heat map preset
6537
- * @request POST:/heatmaps
6562
+ * @description Returns the latest analyst ratings on a given stock or multiple stocks.
6563
+ * @tags TipRank
6564
+ * @name TiprankLatestAnalystRatingsOnStock
6565
+ * @summary Get tiprank LatestAnalystRatingsOnStock
6566
+ * @request POST:/tipranks/analyst-multi
6538
6567
  * @secure
6539
6568
  */
6540
- createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6569
+ tiprankLatestAnalystRatingsOnStock(filter: InsightLatestAnalystRatingsOnStockRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLatestAnalystRatingsOnStockResponse[], HandleError>>;
6541
6570
  /**
6542
- * @description Sector and Industry Group performance
6543
- * @tags StockScreener
6544
- * @name IndustriesPerformance
6545
- * @summary get industries performance
6546
- * @request POST:/industries-performance
6571
+ * @description Returns the latest analyst portfolio items.
6572
+ * @tags TipRank
6573
+ * @name TiprankPortfolios
6574
+ * @summary Get the latest analyst portfolio items
6575
+ * @request POST:/tipranks/analyst-portfolio
6547
6576
  * @secure
6548
6577
  */
6549
- industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
6578
+ tiprankPortfolios(filter: InsightPortfoliosRequest, headers?: {
6579
+ /** Authorization */
6580
+ Authorization?: string;
6581
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPortfoliosResponse[], HandleError>>;
6550
6582
  /**
6551
- * @description filter stocks by params
6552
- * @tags StockScreener
6553
- * @name StockScreener
6554
- * @summary filter stocks by params
6555
- * @request POST:/stock-screener
6583
+ * @description Returns the analyst profile information
6584
+ * @tags TipRank
6585
+ * @name TiprankAnalystProfile
6586
+ * @summary Get tiprank AnalystProfile
6587
+ * @request GET:/tipranks/analyst-profile
6556
6588
  * @secure
6557
6589
  */
6558
- stockScreener(filter: InsightStockScreenerV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
6590
+ tiprankAnalystProfile(query: {
6591
+ /** ID of tiprank analyst profile */
6592
+ id: string;
6593
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystProfileResponse, HandleError>>;
6559
6594
  /**
6560
- * @description get screener presets
6561
- * @tags StockScreener
6562
- * @name GetScreenerPresets
6563
- * @summary get screener presets
6564
- * @request GET:/stock-screener/presets
6595
+ * @description Returns the URL prefix to the expertPictureUrl field.
6596
+ * @tags TipRank
6597
+ * @name TiprankAnalystsExpertPictureStore
6598
+ * @summary Get tiprank AnalystsExpertPictureStore
6599
+ * @request GET:/tipranks/analysts-expert-picture-store
6565
6600
  * @secure
6566
6601
  */
6567
- getScreenerPresets(query: {
6568
- /** how many records to return */
6569
- limit: number;
6570
- /** how many records to skip */
6571
- offset: number;
6572
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
6602
+ tiprankAnalystsExpertPictureStore(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystsExpertPictureStoreResponse, HandleError>>;
6573
6603
  /**
6574
- * @description update screener preset
6575
- * @tags StockScreener
6576
- * @name UpdateScreenerPreset
6577
- * @summary update screener preset
6578
- * @request PUT:/stock-screener/presets
6604
+ * @description Returns a list of top-ranked analysts.
6605
+ * @tags TipRank
6606
+ * @name TiprankBestPerformingExperts
6607
+ * @summary Get tiprank BestPerformingExperts
6608
+ * @request GET:/tipranks/best-performing-experts
6579
6609
  * @secure
6580
6610
  */
6581
- updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
6611
+ tiprankBestPerformingExperts(query?: {
6612
+ /** The number of analysts to return */
6613
+ num?: number;
6614
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightBestPerformingExpertsResponse[], HandleError>>;
6582
6615
  /**
6583
- * @description create screener preset
6584
- * @tags StockScreener
6585
- * @name CreateOrScreenerPreset
6586
- * @summary create screener preset
6587
- * @request POST:/stock-screener/presets
6616
+ * @description Returns the blogger consensus on the stock along with the blogger opinion distribution by site.
6617
+ * @tags TipRank
6618
+ * @name TiprankBloggerConsensusOnStock
6619
+ * @summary Get tiprank BloggerConsensusOnStock
6620
+ * @request GET:/tipranks/blogger-consensus-on-stock
6588
6621
  * @secure
6589
6622
  */
6590
- createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
6591
- /**
6592
- * @description remove screener preset
6593
- * @tags StockScreener
6594
- * @name RemoveScreenerPreset
6595
- * @summary remove screener preset
6596
- * @request DELETE:/stock-screener/presets
6597
- * @secure
6598
- */
6599
- removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
6600
- /**
6601
- * @description get top symbols
6602
- * @tags StockScreener
6603
- * @name GetTopSymbols
6604
- * @summary get top symbols
6605
- * @request POST:/stock-screener/top
6606
- * @secure
6607
- */
6608
- getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
6609
- }
6610
- export class StockScreenerV2<HandleError extends boolean = boolean> {
6611
- protected readonly apiClient: JwtClient<HandleError>;
6612
- constructor(apiClient: JwtClient<HandleError>);
6613
- /**
6614
- * @description filter stocks by params
6615
- * @tags StockScreener
6616
- * @name StockScreener
6617
- * @summary filter stocks by params
6618
- * @request POST:/stock-screener
6619
- * @secure
6620
- */
6621
- stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
6622
- /**
6623
- * @description get top symbols
6624
- * @tags StockScreener
6625
- * @name GetTopSymbols
6626
- * @summary get top symbols
6627
- * @request POST:/stock-screener/top
6628
- * @secure
6629
- */
6630
- getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
6631
- }
6632
- export class TipRank<HandleError extends boolean = boolean> {
6633
- protected readonly apiClient: JwtClient<HandleError>;
6634
- constructor(apiClient: JwtClient<HandleError>);
6635
- /**
6636
- * @description Returns an overview of analyst ratings for a given ticker or ticker list, based on analyst ratings from the last 3 months.
6637
- * @tags TipRank
6638
- * @name TiprankAnalystConsensus
6639
- * @summary Get tiprank AnalystConsensus
6640
- * @request POST:/tipranks/analyst-consensus
6641
- * @secure
6642
- */
6643
- tiprankAnalystConsensus(filter: InsightAnalystConsensusRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystConsensusResponse[], HandleError>>;
6644
- /**
6645
- * @description Returns the latest analyst ratings on a given stock or multiple stocks.
6646
- * @tags TipRank
6647
- * @name TiprankLatestAnalystRatingsOnStock
6648
- * @summary Get tiprank LatestAnalystRatingsOnStock
6649
- * @request POST:/tipranks/analyst-multi
6650
- * @secure
6651
- */
6652
- tiprankLatestAnalystRatingsOnStock(filter: InsightLatestAnalystRatingsOnStockRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLatestAnalystRatingsOnStockResponse[], HandleError>>;
6653
- /**
6654
- * @description Returns the latest analyst portfolio items.
6655
- * @tags TipRank
6656
- * @name TiprankPortfolios
6657
- * @summary Get the latest analyst portfolio items
6658
- * @request POST:/tipranks/analyst-portfolio
6659
- * @secure
6660
- */
6661
- tiprankPortfolios(filter: InsightPortfoliosRequest, headers?: {
6662
- /** Authorization */
6663
- Authorization?: string;
6664
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPortfoliosResponse[], HandleError>>;
6665
- /**
6666
- * @description Returns the analyst profile information
6667
- * @tags TipRank
6668
- * @name TiprankAnalystProfile
6669
- * @summary Get tiprank AnalystProfile
6670
- * @request GET:/tipranks/analyst-profile
6671
- * @secure
6672
- */
6673
- tiprankAnalystProfile(query: {
6674
- /** ID of tiprank analyst profile */
6675
- id: string;
6676
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystProfileResponse, HandleError>>;
6677
- /**
6678
- * @description Returns the URL prefix to the expertPictureUrl field.
6679
- * @tags TipRank
6680
- * @name TiprankAnalystsExpertPictureStore
6681
- * @summary Get tiprank AnalystsExpertPictureStore
6682
- * @request GET:/tipranks/analysts-expert-picture-store
6683
- * @secure
6684
- */
6685
- tiprankAnalystsExpertPictureStore(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystsExpertPictureStoreResponse, HandleError>>;
6686
- /**
6687
- * @description Returns a list of top-ranked analysts.
6688
- * @tags TipRank
6689
- * @name TiprankBestPerformingExperts
6690
- * @summary Get tiprank BestPerformingExperts
6691
- * @request GET:/tipranks/best-performing-experts
6692
- * @secure
6693
- */
6694
- tiprankBestPerformingExperts(query?: {
6695
- /** The number of analysts to return */
6696
- num?: number;
6697
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightBestPerformingExpertsResponse[], HandleError>>;
6698
- /**
6699
- * @description Returns the blogger consensus on the stock along with the blogger opinion distribution by site.
6700
- * @tags TipRank
6701
- * @name TiprankBloggerConsensusOnStock
6702
- * @summary Get tiprank BloggerConsensusOnStock
6703
- * @request GET:/tipranks/blogger-consensus-on-stock
6704
- * @secure
6705
- */
6706
- tiprankBloggerConsensusOnStock(query: {
6707
- /** The ticker of the stock */
6708
- ticker: string;
6709
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightBloggerConsensusOnStockResponse[], HandleError>>;
6623
+ tiprankBloggerConsensusOnStock(query: {
6624
+ /** The ticker of the stock */
6625
+ ticker: string;
6626
+ }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightBloggerConsensusOnStockResponse[], HandleError>>;
6710
6627
  /**
6711
6628
  * @description Returns a list of the upcoming IPOs and recent IPOs that have already been priced
6712
6629
  * @tags TipRank
@@ -7008,187 +6925,270 @@ export class UsageTracking<HandleError extends boolean = boolean> {
7008
6925
  */
7009
6926
  getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
7010
6927
  }
7011
- export class WorldMarkets<HandleError extends boolean = boolean> {
7012
- protected readonly apiClient: JwtClient<HandleError>;
7013
- constructor(apiClient: JwtClient<HandleError>);
6928
+ export enum InsightOrderDirectionV2 {
6929
+ OrderASC = "asc",
6930
+ OrderDESC = "desc"
6931
+ }
6932
+ export interface InsightBeforeAndAfterV2 {
6933
+ after?: string;
6934
+ before?: string;
6935
+ }
6936
+ export interface InsightFixedIncomeV2 {
6937
+ a144: boolean;
6938
+ accrued_interest: number;
6939
+ bank_qualified: boolean;
6940
+ bond_warrant: boolean;
6941
+ call_type: string;
6942
+ callable: boolean;
6943
+ close_price: number;
6944
+ close_price_asof: string;
6945
+ close_ytw: number;
6946
+ convertible: boolean;
6947
+ country: string;
6948
+ country_code: string;
6949
+ country_domicile: string;
6950
+ country_issue: string;
6951
+ coupon: number;
6952
+ coupon_frequency: string;
6953
+ coupon_type: string;
6954
+ currency: string;
6955
+ cusip: string;
6956
+ dated_date: string;
6957
+ daycount: string;
6958
+ description: string;
6959
+ description_short: string;
6960
+ duration: number;
6961
+ first_coupon_date: string;
6962
+ insured: boolean;
6963
+ isin: string;
6964
+ issue_date: string;
6965
+ issue_minimum_denomination: number;
6966
+ issue_price: number;
6967
+ issue_size: number;
6968
+ issuer: string;
6969
+ last_coupon_date: string;
6970
+ liquidity_institutional_aggregate: number;
6971
+ liquidity_institutional_buy: number;
6972
+ liquidity_institutional_sell: number;
6973
+ liquidity_micro_aggregate: number;
6974
+ liquidity_micro_buy: number;
6975
+ liquidity_micro_sell: number;
6976
+ liquidity_retail_aggregate: number;
6977
+ liquidity_retail_buy: number;
6978
+ liquidity_retail_sell: number;
6979
+ maturity_date: string;
6980
+ municipal_state: string;
6981
+ municipal_taxable_federal: boolean;
6982
+ municipal_type: string;
6983
+ next_call_date: string;
6984
+ next_call_price: number;
6985
+ next_coupon_date: string;
6986
+ par_value: number;
6987
+ perpetual: boolean;
6988
+ private_placement: boolean;
6989
+ purpose: string;
6990
+ puttable: boolean;
6991
+ reg_s: boolean;
6992
+ sector: string;
6993
+ seniority: string;
6994
+ settlement_convention: string;
6995
+ sinking_fund: boolean;
6996
+ sp_creditwatch: string;
6997
+ sp_creditwatch_date: string;
6998
+ sp_outlook: string;
6999
+ sp_outlook_date: string;
7000
+ sp_rating: string;
7001
+ sp_rating_date: string;
7002
+ status: string;
7003
+ ticker: string;
7004
+ treasury_subtype: string;
7005
+ type: string;
7006
+ updated_at: string;
7007
+ }
7008
+ export interface InsightGetFixedIncomeEntriesResponseV2 {
7009
+ count: number;
7010
+ data: InsightFixedIncomeV2[];
7011
+ }
7012
+ export interface InsightGetFixedIncomeEntriesRequestV2 {
7013
+ /** @example true */
7014
+ bank_qualified?: boolean;
7015
+ /** @example true */
7016
+ callable?: boolean;
7017
+ /** @example true */
7018
+ convertible?: boolean;
7019
+ /** @example ["USA"] */
7020
+ country_codes?: string[];
7021
+ coupon?: InsightLessAndMoreV2;
7022
+ /** @example ["quarterly","zero"] */
7023
+ coupon_frequencies?: string[];
7024
+ /** @example ["655664AH3","9128286R6"] */
7025
+ cusip?: string[];
7014
7026
  /**
7015
- * @description Get continents
7016
- * @tags World Markets
7017
- * @name ContinentGet
7018
- * @summary Get continents
7019
- * @request GET:/continents
7020
- * @secure
7027
+ * @maxLength 100
7028
+ * @example "Donald's"
7021
7029
  */
7022
- continentGet(query: {
7023
- /** Query limit */
7024
- limit: number;
7025
- /** Query offset */
7026
- offset: number;
7027
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
7030
+ description?: string;
7031
+ /** @example true */
7032
+ has_ticker?: boolean;
7033
+ /** @example true */
7034
+ insured?: boolean;
7035
+ /** @example ["US655664AH33","US9128286R69"] */
7036
+ isin?: string[];
7037
+ issue_date?: InsightBeforeAndAfterV2;
7028
7038
  /**
7029
- * @description Edit continent
7030
- * @tags World Markets
7031
- * @name ContinentEdit
7032
- * @summary Edit continent
7033
- * @request PUT:/continents
7034
- * @secure
7039
+ * @maxLength 100
7040
+ * @example "Donald's"
7035
7041
  */
7036
- continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
7037
- /**
7038
- * @description Create continents
7039
- * @tags World Markets
7040
- * @name ContinentCreate
7041
- * @summary Create continents
7042
- * @request POST:/continents
7043
- * @secure
7044
- */
7045
- continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
7046
- /**
7047
- * @description Delete continent
7048
- * @tags World Markets
7049
- * @name ContinentDelete
7050
- * @summary Delete continent
7051
- * @request DELETE:/continents
7052
- * @secure
7053
- */
7054
- continentDelete(query: {
7055
- /** continent id */
7056
- id: string;
7057
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
7058
- /**
7059
- * @description Get country codes
7060
- * @tags World Markets
7061
- * @name CountryCodeGet
7062
- * @summary Get country codes
7063
- * @request GET:/country-codes
7064
- * @secure
7065
- */
7066
- countryCodeGet(query: {
7067
- /** Query limit */
7068
- limit: number;
7069
- /** Query offset */
7070
- offset: number;
7071
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
7072
- /**
7073
- * @description Edit country code
7074
- * @tags World Markets
7075
- * @name CountryCodeEdit
7076
- * @summary Edit country code
7077
- * @request PUT:/country-codes
7078
- * @secure
7079
- */
7080
- countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
7081
- /**
7082
- * @description Add country codes
7083
- * @tags World Markets
7084
- * @name CountryCodeAdd
7085
- * @summary Add country codes
7086
- * @request POST:/country-codes
7087
- * @secure
7088
- */
7089
- countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
7090
- /**
7091
- * @description Delete country code
7092
- * @tags World Markets
7093
- * @name CountryCodeDelete
7094
- * @summary Delete country code
7095
- * @request DELETE:/country-codes
7096
- * @secure
7097
- */
7098
- countryCodeDelete(query: {
7099
- /** a3 code */
7100
- a3code: string;
7101
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
7102
- /**
7103
- * @description Get global indexes
7104
- * @tags World Markets
7105
- * @name GlobalIndexGet
7106
- * @summary Get global indexes
7107
- * @request GET:/global-indexes
7108
- * @secure
7109
- */
7110
- globalIndexGet(query: {
7111
- /** Query limit */
7112
- limit: number;
7113
- /** Query offset */
7114
- offset: number;
7115
- /** Continent code for filtering */
7116
- continent?: string;
7117
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
7042
+ issuer?: string;
7043
+ maturity?: InsightBeforeAndAfterV2;
7044
+ /** @example ["NY"] */
7045
+ municipal_states?: string[];
7046
+ /** @example true */
7047
+ municipal_tax?: boolean;
7048
+ /** @example ["general_obligation"] */
7049
+ municipal_types?: string[];
7050
+ pagination: InsightPaginationV2;
7051
+ purposes?: string[];
7052
+ /** @example ["SOVEREIGN"] */
7053
+ sectors?: string[];
7054
+ sorts?: InsightOrderingV2[];
7055
+ /** @example ["AAA"] */
7056
+ sp_ratings?: string[];
7057
+ /** @example ["called","outstanding"] */
7058
+ statuses?: string[];
7059
+ tickers?: string[];
7060
+ /** @example ["corporate"] */
7061
+ types?: string[];
7062
+ }
7063
+ export interface InsightGetTopSymbolsRequestV2 {
7064
+ exchange?: string[];
7065
+ market_cap?: InsightLessAndMoreV2;
7066
+ pagination?: InsightPaginationV2;
7067
+ price?: InsightLessAndMoreV2;
7068
+ sorts?: InsightOrderingV2[];
7069
+ volume?: InsightLessAndMoreV2;
7070
+ }
7071
+ export interface InsightIncludeExcludeV2 {
7072
+ exclude?: string[];
7073
+ include?: string[];
7074
+ }
7075
+ export interface InsightLessAndMoreV2 {
7076
+ less_than?: number;
7077
+ more_than?: number;
7078
+ }
7079
+ export interface InsightOrderingV2 {
7118
7080
  /**
7119
- * @description Edit global index
7120
- * @tags World Markets
7121
- * @name GlobalIndexEdit
7122
- * @summary Edit global index
7123
- * @request PUT:/global-indexes
7124
- * @secure
7081
+ * @default "asc"
7082
+ * @example "asc"
7125
7083
  */
7126
- globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
7084
+ direction: InsightOrderingDirectionEnumV2;
7127
7085
  /**
7128
- * @description Add global indexes
7129
- * @tags World Markets
7130
- * @name GlobalIndexAdd
7131
- * @summary Add global indexes
7132
- * @request POST:/global-indexes
7133
- * @secure
7086
+ * Sort direction:
7087
+ * * asc - Ascending, from A to Z.
7088
+ * * desc - Descending, from Z to A.
7089
+ * @example "name"
7134
7090
  */
7135
- globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
7091
+ field: string;
7092
+ }
7093
+ export interface InsightPaginationV2 {
7136
7094
  /**
7137
- * @description Edit global index
7138
- * @tags World Markets
7139
- * @name GlobalIndexDelete
7140
- * @summary Delete global index
7141
- * @request DELETE:/global-indexes
7142
- * @secure
7095
+ * @min 1
7096
+ * @example 1
7143
7097
  */
7144
- globalIndexDelete(query: {
7145
- /** a3 code */
7146
- a3code: string;
7147
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
7098
+ page: number;
7148
7099
  /**
7149
- * @description Get regions
7150
- * @tags World Markets
7151
- * @name RegionGet
7152
- * @summary Get regions
7153
- * @request GET:/regions
7154
- * @secure
7100
+ * @min 1
7101
+ * @max 50
7102
+ * @example 10
7155
7103
  */
7156
- regionGet(query: {
7157
- /** Query limit */
7158
- limit: number;
7159
- /** Query offset */
7160
- offset: number;
7161
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
7104
+ size: number;
7105
+ }
7106
+ export interface InsightStockScreenerQuoteV2 {
7107
+ average_volume_30d: number;
7108
+ company_name: string;
7109
+ dividend_ex_date: string;
7110
+ dividend_pay_date: string;
7111
+ dividend_percent: number;
7112
+ exchange: string;
7113
+ exchange_name: string;
7114
+ gap: number;
7115
+ industry: string;
7116
+ industry_code: string;
7117
+ last_price: number;
7118
+ market_cap: number;
7119
+ pe_ratio: number;
7120
+ price_change: number;
7121
+ price_change_percent: number;
7122
+ symbol: string;
7123
+ volume: number;
7124
+ }
7125
+ export interface InsightStockScreenerRequestV2 {
7126
+ average_volume_30d?: InsightLessAndMoreV2;
7127
+ dividend_ex_date?: InsightBeforeAndAfterV2;
7128
+ dividend_pay_date?: InsightBeforeAndAfterV2;
7129
+ dividend_percent?: InsightLessAndMoreV2;
7130
+ exchange?: InsightIncludeExcludeV2;
7131
+ gap?: InsightLessAndMoreV2;
7132
+ industry?: InsightIncludeExcludeV2;
7133
+ market_cap?: InsightLessAndMoreV2;
7134
+ pagination: InsightPaginationV2;
7135
+ pe_ratio?: InsightLessAndMoreV2;
7136
+ price?: InsightLessAndMoreV2;
7137
+ price_change_percent?: InsightLessAndMoreV2;
7138
+ sorts?: InsightOrderingV2[];
7139
+ /** @example "ADR" */
7140
+ stock_type?: string;
7141
+ volume?: InsightLessAndMoreV2;
7142
+ }
7143
+ export interface InsightStockScreenerResponseV2 {
7144
+ current_page: number;
7145
+ data: InsightStockScreenerQuoteV2[];
7146
+ page_count: number;
7147
+ status: number;
7148
+ total_records: number;
7149
+ }
7150
+ /**
7151
+ * @default "asc"
7152
+ * @example "asc"
7153
+ */
7154
+ export enum InsightOrderingDirectionEnumV2 {
7155
+ Asc = "asc",
7156
+ Desc = "desc"
7157
+ }
7158
+ export class FixedIncomeV2<HandleError extends boolean = boolean> {
7159
+ protected readonly apiClient: JwtClient<HandleError>;
7160
+ constructor(apiClient: JwtClient<HandleError>);
7162
7161
  /**
7163
- * @description Edit region
7164
- * @tags World Markets
7165
- * @name RegionEdit
7166
- * @summary Edit region
7167
- * @request PUT:/regions
7162
+ * @description get fixed income entries
7163
+ * @tags FixedIncome
7164
+ * @name GetFixedIncomeEntries
7165
+ * @summary get fixed income entries
7166
+ * @request POST:/fixed-income
7168
7167
  * @secure
7169
7168
  */
7170
- regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
7169
+ getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
7170
+ }
7171
+ export class StockScreenerV2<HandleError extends boolean = boolean> {
7172
+ protected readonly apiClient: JwtClient<HandleError>;
7173
+ constructor(apiClient: JwtClient<HandleError>);
7171
7174
  /**
7172
- * @description Create regions
7173
- * @tags World Markets
7174
- * @name RegionCreate
7175
- * @summary Create regions
7176
- * @request POST:/regions
7175
+ * @description filter stocks by params
7176
+ * @tags StockScreener
7177
+ * @name StockScreener
7178
+ * @summary filter stocks by params
7179
+ * @request POST:/stock-screener
7177
7180
  * @secure
7178
7181
  */
7179
- regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
7182
+ stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
7180
7183
  /**
7181
- * @description Delete region
7182
- * @tags World Markets
7183
- * @name RegionDelete
7184
- * @summary Delete region
7185
- * @request DELETE:/regions
7184
+ * @description get top symbols
7185
+ * @tags StockScreener
7186
+ * @name GetTopSymbols
7187
+ * @summary get top symbols
7188
+ * @request POST:/stock-screener/top
7186
7189
  * @secure
7187
7190
  */
7188
- regionDelete(query: {
7189
- /** region id */
7190
- id: string;
7191
- }, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
7191
+ getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
7192
7192
  }
7193
7193
  export class InsightApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
7194
7194
  readonly config: JwtClientConfig<HandleError>;