@orbis-systems/orbis-api-clients 0.7.12 → 0.7.13
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/aesmidas/index.d.ts +28 -28
- package/dist/aesmidas/index.d.ts.map +1 -1
- package/dist/aesmidas/index.esm.js +1 -1
- package/dist/aesmidas/index.esm.js.map +1 -1
- package/dist/aesmidas/index.js +1 -1
- package/dist/aesmidas/index.js.map +1 -1
- package/dist/bridgewise/index.d.ts +652 -652
- package/dist/bridgewise/index.d.ts.map +1 -1
- package/dist/bridgewise/index.esm.js +1 -1
- package/dist/bridgewise/index.esm.js.map +1 -1
- package/dist/bridgewise/index.js +1 -1
- package/dist/bridgewise/index.js.map +1 -1
- package/dist/insight/index.d.ts +1112 -1112
- package/dist/insight/index.d.ts.map +1 -1
- package/dist/insight/index.esm.js +1 -1
- package/dist/insight/index.esm.js.map +1 -1
- package/dist/insight/index.js +1 -1
- package/dist/insight/index.js.map +1 -1
- package/dist/middleware/index.d.ts +73 -73
- package/dist/middleware/index.d.ts.map +1 -1
- package/dist/middleware/index.esm.js +1 -1
- package/dist/middleware/index.esm.js.map +1 -1
- package/dist/middleware/index.js +1 -1
- package/dist/middleware/index.js.map +1 -1
- package/dist/orbis/index.d.ts +3871 -3871
- package/dist/orbis/index.d.ts.map +1 -1
- package/dist/orbis/index.esm.js +1 -1
- package/dist/orbis/index.esm.js.map +1 -1
- package/dist/orbis/index.js +1 -1
- package/dist/orbis/index.js.map +1 -1
- package/dist/uma/index.d.ts +686 -686
- package/dist/uma/index.d.ts.map +1 -1
- package/dist/uma/index.esm.js +1 -1
- package/dist/uma/index.esm.js.map +1 -1
- package/dist/uma/index.js +1 -1
- package/dist/uma/index.js.map +1 -1
- package/dist/zerohash/index.d.ts +273 -273
- package/dist/zerohash/index.d.ts.map +1 -1
- package/dist/zerohash/index.esm.js +1 -1
- package/dist/zerohash/index.esm.js.map +1 -1
- package/dist/zerohash/index.js +1 -1
- package/dist/zerohash/index.js.map +1 -1
- package/package.json +1 -1
package/dist/insight/index.d.ts
CHANGED
|
@@ -4549,6 +4549,28 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
|
|
|
4549
4549
|
Date = "date",
|
|
4550
4550
|
Rank = "rank"
|
|
4551
4551
|
}
|
|
4552
|
+
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
4553
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4554
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4555
|
+
/**
|
|
4556
|
+
* @description get seasonlity data with comparison to benchmark
|
|
4557
|
+
* @tags AlphaTools
|
|
4558
|
+
* @name GetMomentumRatioGraph
|
|
4559
|
+
* @summary get seasonlity data
|
|
4560
|
+
* @request POST:/rst
|
|
4561
|
+
* @secure
|
|
4562
|
+
*/
|
|
4563
|
+
getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
|
|
4564
|
+
/**
|
|
4565
|
+
* @description get seasonlity data with comparison to benchmark
|
|
4566
|
+
* @tags AlphaTools
|
|
4567
|
+
* @name GetSeasonality
|
|
4568
|
+
* @summary get seasonlity data
|
|
4569
|
+
* @request POST:/seasonality
|
|
4570
|
+
* @secure
|
|
4571
|
+
*/
|
|
4572
|
+
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
|
|
4573
|
+
}
|
|
4552
4574
|
export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
4553
4575
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4554
4576
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4588,188 +4610,6 @@ export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
|
4588
4610
|
*/
|
|
4589
4611
|
getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
|
|
4590
4612
|
}
|
|
4591
|
-
export class WorldMarkets<HandleError extends boolean = boolean> {
|
|
4592
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4593
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4594
|
-
/**
|
|
4595
|
-
* @description Get continents
|
|
4596
|
-
* @tags World Markets
|
|
4597
|
-
* @name ContinentGet
|
|
4598
|
-
* @summary Get continents
|
|
4599
|
-
* @request GET:/continents
|
|
4600
|
-
* @secure
|
|
4601
|
-
*/
|
|
4602
|
-
continentGet(query: {
|
|
4603
|
-
/** Query limit */
|
|
4604
|
-
limit: number;
|
|
4605
|
-
/** Query offset */
|
|
4606
|
-
offset: number;
|
|
4607
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
4608
|
-
/**
|
|
4609
|
-
* @description Edit continent
|
|
4610
|
-
* @tags World Markets
|
|
4611
|
-
* @name ContinentEdit
|
|
4612
|
-
* @summary Edit continent
|
|
4613
|
-
* @request PUT:/continents
|
|
4614
|
-
* @secure
|
|
4615
|
-
*/
|
|
4616
|
-
continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4617
|
-
/**
|
|
4618
|
-
* @description Create continents
|
|
4619
|
-
* @tags World Markets
|
|
4620
|
-
* @name ContinentCreate
|
|
4621
|
-
* @summary Create continents
|
|
4622
|
-
* @request POST:/continents
|
|
4623
|
-
* @secure
|
|
4624
|
-
*/
|
|
4625
|
-
continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
4626
|
-
/**
|
|
4627
|
-
* @description Delete continent
|
|
4628
|
-
* @tags World Markets
|
|
4629
|
-
* @name ContinentDelete
|
|
4630
|
-
* @summary Delete continent
|
|
4631
|
-
* @request DELETE:/continents
|
|
4632
|
-
* @secure
|
|
4633
|
-
*/
|
|
4634
|
-
continentDelete(query: {
|
|
4635
|
-
/** continent id */
|
|
4636
|
-
id: string;
|
|
4637
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4638
|
-
/**
|
|
4639
|
-
* @description Get country codes
|
|
4640
|
-
* @tags World Markets
|
|
4641
|
-
* @name CountryCodeGet
|
|
4642
|
-
* @summary Get country codes
|
|
4643
|
-
* @request GET:/country-codes
|
|
4644
|
-
* @secure
|
|
4645
|
-
*/
|
|
4646
|
-
countryCodeGet(query: {
|
|
4647
|
-
/** Query limit */
|
|
4648
|
-
limit: number;
|
|
4649
|
-
/** Query offset */
|
|
4650
|
-
offset: number;
|
|
4651
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
4652
|
-
/**
|
|
4653
|
-
* @description Edit country code
|
|
4654
|
-
* @tags World Markets
|
|
4655
|
-
* @name CountryCodeEdit
|
|
4656
|
-
* @summary Edit country code
|
|
4657
|
-
* @request PUT:/country-codes
|
|
4658
|
-
* @secure
|
|
4659
|
-
*/
|
|
4660
|
-
countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4661
|
-
/**
|
|
4662
|
-
* @description Add country codes
|
|
4663
|
-
* @tags World Markets
|
|
4664
|
-
* @name CountryCodeAdd
|
|
4665
|
-
* @summary Add country codes
|
|
4666
|
-
* @request POST:/country-codes
|
|
4667
|
-
* @secure
|
|
4668
|
-
*/
|
|
4669
|
-
countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
4670
|
-
/**
|
|
4671
|
-
* @description Delete country code
|
|
4672
|
-
* @tags World Markets
|
|
4673
|
-
* @name CountryCodeDelete
|
|
4674
|
-
* @summary Delete country code
|
|
4675
|
-
* @request DELETE:/country-codes
|
|
4676
|
-
* @secure
|
|
4677
|
-
*/
|
|
4678
|
-
countryCodeDelete(query: {
|
|
4679
|
-
/** a3 code */
|
|
4680
|
-
a3code: string;
|
|
4681
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4682
|
-
/**
|
|
4683
|
-
* @description Get global indexes
|
|
4684
|
-
* @tags World Markets
|
|
4685
|
-
* @name GlobalIndexGet
|
|
4686
|
-
* @summary Get global indexes
|
|
4687
|
-
* @request GET:/global-indexes
|
|
4688
|
-
* @secure
|
|
4689
|
-
*/
|
|
4690
|
-
globalIndexGet(query: {
|
|
4691
|
-
/** Query limit */
|
|
4692
|
-
limit: number;
|
|
4693
|
-
/** Query offset */
|
|
4694
|
-
offset: number;
|
|
4695
|
-
/** Continent code for filtering */
|
|
4696
|
-
continent?: string;
|
|
4697
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
4698
|
-
/**
|
|
4699
|
-
* @description Edit global index
|
|
4700
|
-
* @tags World Markets
|
|
4701
|
-
* @name GlobalIndexEdit
|
|
4702
|
-
* @summary Edit global index
|
|
4703
|
-
* @request PUT:/global-indexes
|
|
4704
|
-
* @secure
|
|
4705
|
-
*/
|
|
4706
|
-
globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4707
|
-
/**
|
|
4708
|
-
* @description Add global indexes
|
|
4709
|
-
* @tags World Markets
|
|
4710
|
-
* @name GlobalIndexAdd
|
|
4711
|
-
* @summary Add global indexes
|
|
4712
|
-
* @request POST:/global-indexes
|
|
4713
|
-
* @secure
|
|
4714
|
-
*/
|
|
4715
|
-
globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
4716
|
-
/**
|
|
4717
|
-
* @description Edit global index
|
|
4718
|
-
* @tags World Markets
|
|
4719
|
-
* @name GlobalIndexDelete
|
|
4720
|
-
* @summary Delete global index
|
|
4721
|
-
* @request DELETE:/global-indexes
|
|
4722
|
-
* @secure
|
|
4723
|
-
*/
|
|
4724
|
-
globalIndexDelete(query: {
|
|
4725
|
-
/** a3 code */
|
|
4726
|
-
a3code: string;
|
|
4727
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4728
|
-
/**
|
|
4729
|
-
* @description Get regions
|
|
4730
|
-
* @tags World Markets
|
|
4731
|
-
* @name RegionGet
|
|
4732
|
-
* @summary Get regions
|
|
4733
|
-
* @request GET:/regions
|
|
4734
|
-
* @secure
|
|
4735
|
-
*/
|
|
4736
|
-
regionGet(query: {
|
|
4737
|
-
/** Query limit */
|
|
4738
|
-
limit: number;
|
|
4739
|
-
/** Query offset */
|
|
4740
|
-
offset: number;
|
|
4741
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
4742
|
-
/**
|
|
4743
|
-
* @description Edit region
|
|
4744
|
-
* @tags World Markets
|
|
4745
|
-
* @name RegionEdit
|
|
4746
|
-
* @summary Edit region
|
|
4747
|
-
* @request PUT:/regions
|
|
4748
|
-
* @secure
|
|
4749
|
-
*/
|
|
4750
|
-
regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4751
|
-
/**
|
|
4752
|
-
* @description Create regions
|
|
4753
|
-
* @tags World Markets
|
|
4754
|
-
* @name RegionCreate
|
|
4755
|
-
* @summary Create regions
|
|
4756
|
-
* @request POST:/regions
|
|
4757
|
-
* @secure
|
|
4758
|
-
*/
|
|
4759
|
-
regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
4760
|
-
/**
|
|
4761
|
-
* @description Delete region
|
|
4762
|
-
* @tags World Markets
|
|
4763
|
-
* @name RegionDelete
|
|
4764
|
-
* @summary Delete region
|
|
4765
|
-
* @request DELETE:/regions
|
|
4766
|
-
* @secure
|
|
4767
|
-
*/
|
|
4768
|
-
regionDelete(query: {
|
|
4769
|
-
/** region id */
|
|
4770
|
-
id: string;
|
|
4771
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4772
|
-
}
|
|
4773
4613
|
export class CustomLists<HandleError extends boolean = boolean> {
|
|
4774
4614
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4775
4615
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5014,555 +4854,383 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
5014
4854
|
*/
|
|
5015
4855
|
getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
|
|
5016
4856
|
}
|
|
5017
|
-
export
|
|
5018
|
-
|
|
5019
|
-
|
|
5020
|
-
/**
|
|
5021
|
-
* @description get fundamentals by symbol data
|
|
5022
|
-
* @tags Fundamentals
|
|
5023
|
-
* @name GetFundamentalsBySymbolData
|
|
5024
|
-
* @summary get fundamentals by symbol data
|
|
5025
|
-
* @request POST:/fundamentals
|
|
5026
|
-
* @secure
|
|
5027
|
-
*/
|
|
5028
|
-
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
4857
|
+
export interface InsightBeforeAndAfterV2 {
|
|
4858
|
+
after?: string;
|
|
4859
|
+
before?: string;
|
|
5029
4860
|
}
|
|
5030
|
-
export
|
|
5031
|
-
|
|
5032
|
-
|
|
5033
|
-
|
|
5034
|
-
|
|
5035
|
-
|
|
5036
|
-
|
|
5037
|
-
|
|
5038
|
-
|
|
5039
|
-
|
|
5040
|
-
|
|
5041
|
-
|
|
5042
|
-
|
|
5043
|
-
|
|
5044
|
-
|
|
5045
|
-
|
|
5046
|
-
|
|
5047
|
-
|
|
5048
|
-
|
|
5049
|
-
|
|
5050
|
-
|
|
5051
|
-
|
|
5052
|
-
|
|
5053
|
-
|
|
5054
|
-
|
|
5055
|
-
|
|
5056
|
-
|
|
5057
|
-
|
|
5058
|
-
|
|
5059
|
-
|
|
5060
|
-
|
|
5061
|
-
|
|
5062
|
-
|
|
5063
|
-
|
|
5064
|
-
|
|
5065
|
-
|
|
5066
|
-
|
|
5067
|
-
|
|
5068
|
-
|
|
5069
|
-
|
|
5070
|
-
|
|
5071
|
-
|
|
5072
|
-
|
|
5073
|
-
|
|
5074
|
-
|
|
5075
|
-
|
|
5076
|
-
|
|
5077
|
-
|
|
5078
|
-
|
|
5079
|
-
|
|
5080
|
-
|
|
5081
|
-
|
|
5082
|
-
|
|
5083
|
-
|
|
5084
|
-
|
|
5085
|
-
|
|
5086
|
-
|
|
5087
|
-
|
|
5088
|
-
|
|
5089
|
-
|
|
5090
|
-
|
|
5091
|
-
|
|
5092
|
-
|
|
5093
|
-
|
|
5094
|
-
|
|
5095
|
-
|
|
5096
|
-
|
|
5097
|
-
|
|
5098
|
-
|
|
5099
|
-
|
|
5100
|
-
|
|
5101
|
-
/**
|
|
5102
|
-
* @description create fund screener preset
|
|
5103
|
-
* @tags Funds
|
|
5104
|
-
* @name CreateFundScreenerPreset
|
|
5105
|
-
* @summary create fund screener preset
|
|
5106
|
-
* @request POST:/funds/screener/presets
|
|
5107
|
-
* @secure
|
|
5108
|
-
*/
|
|
5109
|
-
createFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5110
|
-
/**
|
|
5111
|
-
* @description remove fund screener preset
|
|
5112
|
-
* @tags Funds
|
|
5113
|
-
* @name RemoveFundScreenerPreset
|
|
5114
|
-
* @summary remove fund screener preset
|
|
5115
|
-
* @request DELETE:/funds/screener/presets
|
|
5116
|
-
* @secure
|
|
5117
|
-
*/
|
|
5118
|
-
removeFundScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5119
|
-
/**
|
|
5120
|
-
* @description filter funds by params
|
|
5121
|
-
* @tags Funds
|
|
5122
|
-
* @name FundSectorScreener
|
|
5123
|
-
* @summary filter funds by params
|
|
5124
|
-
* @request POST:/funds/sector-screener
|
|
5125
|
-
* @secure
|
|
5126
|
-
*/
|
|
5127
|
-
fundSectorScreener(filter: InsightFundSectorScreenerRequest, headers?: {
|
|
5128
|
-
/** Authorization */
|
|
5129
|
-
Authorization?: string;
|
|
5130
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
|
|
5131
|
-
/**
|
|
5132
|
-
* @description get top funds
|
|
5133
|
-
* @tags Funds
|
|
5134
|
-
* @name GetTopFunds
|
|
5135
|
-
* @summary get top funds
|
|
5136
|
-
* @request POST:/funds/top
|
|
5137
|
-
* @secure
|
|
5138
|
-
*/
|
|
5139
|
-
getTopFunds(filter: InsightGetTopFundsRequest, headers?: {
|
|
5140
|
-
/** Authorization */
|
|
5141
|
-
Authorization?: string;
|
|
5142
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
|
|
4861
|
+
export interface InsightFixedIncomeV2 {
|
|
4862
|
+
a144: boolean;
|
|
4863
|
+
accrued_interest: number;
|
|
4864
|
+
bank_qualified: boolean;
|
|
4865
|
+
bond_warrant: boolean;
|
|
4866
|
+
call_type: string;
|
|
4867
|
+
callable: boolean;
|
|
4868
|
+
close_price: number;
|
|
4869
|
+
close_price_asof: string;
|
|
4870
|
+
close_ytw: number;
|
|
4871
|
+
convertible: boolean;
|
|
4872
|
+
country: string;
|
|
4873
|
+
country_code: string;
|
|
4874
|
+
country_domicile: string;
|
|
4875
|
+
country_issue: string;
|
|
4876
|
+
coupon: number;
|
|
4877
|
+
coupon_frequency: string;
|
|
4878
|
+
coupon_type: string;
|
|
4879
|
+
currency: string;
|
|
4880
|
+
cusip: string;
|
|
4881
|
+
dated_date: string;
|
|
4882
|
+
daycount: string;
|
|
4883
|
+
description: string;
|
|
4884
|
+
description_short: string;
|
|
4885
|
+
duration: number;
|
|
4886
|
+
first_coupon_date: string;
|
|
4887
|
+
insured: boolean;
|
|
4888
|
+
isin: string;
|
|
4889
|
+
issue_date: string;
|
|
4890
|
+
issue_minimum_denomination: number;
|
|
4891
|
+
issue_price: number;
|
|
4892
|
+
issue_size: number;
|
|
4893
|
+
issuer: string;
|
|
4894
|
+
last_coupon_date: string;
|
|
4895
|
+
liquidity_institutional_aggregate: number;
|
|
4896
|
+
liquidity_institutional_buy: number;
|
|
4897
|
+
liquidity_institutional_sell: number;
|
|
4898
|
+
liquidity_micro_aggregate: number;
|
|
4899
|
+
liquidity_micro_buy: number;
|
|
4900
|
+
liquidity_micro_sell: number;
|
|
4901
|
+
liquidity_retail_aggregate: number;
|
|
4902
|
+
liquidity_retail_buy: number;
|
|
4903
|
+
liquidity_retail_sell: number;
|
|
4904
|
+
maturity_date: string;
|
|
4905
|
+
municipal_state: string;
|
|
4906
|
+
municipal_taxable_federal: boolean;
|
|
4907
|
+
municipal_type: string;
|
|
4908
|
+
next_call_date: string;
|
|
4909
|
+
next_call_price: number;
|
|
4910
|
+
next_coupon_date: string;
|
|
4911
|
+
par_value: number;
|
|
4912
|
+
perpetual: boolean;
|
|
4913
|
+
private_placement: boolean;
|
|
4914
|
+
purpose: string;
|
|
4915
|
+
puttable: boolean;
|
|
4916
|
+
reg_s: boolean;
|
|
4917
|
+
sector: string;
|
|
4918
|
+
seniority: string;
|
|
4919
|
+
settlement_convention: string;
|
|
4920
|
+
sinking_fund: boolean;
|
|
4921
|
+
sp_creditwatch: string;
|
|
4922
|
+
sp_creditwatch_date: string;
|
|
4923
|
+
sp_outlook: string;
|
|
4924
|
+
sp_outlook_date: string;
|
|
4925
|
+
sp_rating: string;
|
|
4926
|
+
sp_rating_date: string;
|
|
4927
|
+
status: string;
|
|
4928
|
+
ticker: string;
|
|
4929
|
+
treasury_subtype: string;
|
|
4930
|
+
type: string;
|
|
4931
|
+
updated_at: string;
|
|
5143
4932
|
}
|
|
5144
|
-
export
|
|
5145
|
-
|
|
5146
|
-
|
|
5147
|
-
|
|
5148
|
-
|
|
5149
|
-
|
|
5150
|
-
|
|
5151
|
-
|
|
5152
|
-
|
|
5153
|
-
|
|
5154
|
-
|
|
5155
|
-
|
|
5156
|
-
|
|
5157
|
-
|
|
5158
|
-
|
|
5159
|
-
|
|
5160
|
-
|
|
5161
|
-
|
|
5162
|
-
* @name CreateStockMarketHeatmapPreset
|
|
5163
|
-
* @summary create or update heat map preset
|
|
5164
|
-
* @request POST:/heatmaps
|
|
5165
|
-
* @secure
|
|
5166
|
-
*/
|
|
5167
|
-
createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5168
|
-
/**
|
|
5169
|
-
* @description Sector and Industry Group performance
|
|
5170
|
-
* @tags StockScreener
|
|
5171
|
-
* @name IndustriesPerformance
|
|
5172
|
-
* @summary get industries performance
|
|
5173
|
-
* @request POST:/industries-performance
|
|
5174
|
-
* @secure
|
|
5175
|
-
*/
|
|
5176
|
-
industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
|
|
5177
|
-
/**
|
|
5178
|
-
* @description filter stocks by params
|
|
5179
|
-
* @tags StockScreener
|
|
5180
|
-
* @name StockScreener
|
|
5181
|
-
* @summary filter stocks by params
|
|
5182
|
-
* @request POST:/stock-screener
|
|
5183
|
-
* @secure
|
|
5184
|
-
*/
|
|
5185
|
-
stockScreener(filter: InsightStockScreenerV1Request, headers?: {
|
|
5186
|
-
/** Authorization */
|
|
5187
|
-
Authorization?: string;
|
|
5188
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
5189
|
-
/**
|
|
5190
|
-
* @description get screener presets
|
|
5191
|
-
* @tags StockScreener
|
|
5192
|
-
* @name GetScreenerPresets
|
|
5193
|
-
* @summary get screener presets
|
|
5194
|
-
* @request GET:/stock-screener/presets
|
|
5195
|
-
* @secure
|
|
5196
|
-
*/
|
|
5197
|
-
getScreenerPresets(query: {
|
|
5198
|
-
/** how many records to return */
|
|
5199
|
-
limit: number;
|
|
5200
|
-
/** how many records to skip */
|
|
5201
|
-
offset: number;
|
|
5202
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
4933
|
+
export interface InsightGetFixedIncomeEntriesResponseV2 {
|
|
4934
|
+
count: number;
|
|
4935
|
+
data: InsightFixedIncomeV2[];
|
|
4936
|
+
}
|
|
4937
|
+
export interface InsightGetFixedIncomeEntriesRequestV2 {
|
|
4938
|
+
/** @example true */
|
|
4939
|
+
bank_qualified?: boolean;
|
|
4940
|
+
/** @example true */
|
|
4941
|
+
callable?: boolean;
|
|
4942
|
+
/** @example true */
|
|
4943
|
+
convertible?: boolean;
|
|
4944
|
+
/** @example ["USA"] */
|
|
4945
|
+
country_codes?: string[];
|
|
4946
|
+
coupon?: InsightLessAndMoreV2;
|
|
4947
|
+
/** @example ["quarterly","zero"] */
|
|
4948
|
+
coupon_frequencies?: string[];
|
|
4949
|
+
/** @example ["655664AH3","9128286R6"] */
|
|
4950
|
+
cusip?: string[];
|
|
5203
4951
|
/**
|
|
5204
|
-
* @
|
|
5205
|
-
* @
|
|
5206
|
-
* @name UpdateScreenerPreset
|
|
5207
|
-
* @summary update screener preset
|
|
5208
|
-
* @request PUT:/stock-screener/presets
|
|
5209
|
-
* @secure
|
|
4952
|
+
* @maxLength 100
|
|
4953
|
+
* @example "Donald's"
|
|
5210
4954
|
*/
|
|
5211
|
-
|
|
4955
|
+
description?: string;
|
|
4956
|
+
/** @example true */
|
|
4957
|
+
has_ticker?: boolean;
|
|
4958
|
+
/** @example true */
|
|
4959
|
+
insured?: boolean;
|
|
4960
|
+
/** @example ["US655664AH33","US9128286R69"] */
|
|
4961
|
+
isin?: string[];
|
|
4962
|
+
issue_date?: InsightBeforeAndAfterV2;
|
|
5212
4963
|
/**
|
|
5213
|
-
* @
|
|
5214
|
-
* @
|
|
5215
|
-
* @name CreateOrScreenerPreset
|
|
5216
|
-
* @summary create screener preset
|
|
5217
|
-
* @request POST:/stock-screener/presets
|
|
5218
|
-
* @secure
|
|
4964
|
+
* @maxLength 100
|
|
4965
|
+
* @example "Donald's"
|
|
5219
4966
|
*/
|
|
5220
|
-
|
|
4967
|
+
issuer?: string;
|
|
4968
|
+
maturity?: InsightBeforeAndAfterV2;
|
|
4969
|
+
/** @example ["NY"] */
|
|
4970
|
+
municipal_states?: string[];
|
|
4971
|
+
/** @example true */
|
|
4972
|
+
municipal_tax?: boolean;
|
|
4973
|
+
/** @example ["general_obligation"] */
|
|
4974
|
+
municipal_types?: string[];
|
|
4975
|
+
pagination: InsightPaginationV2;
|
|
4976
|
+
purposes?: string[];
|
|
4977
|
+
/** @example ["SOVEREIGN"] */
|
|
4978
|
+
sectors?: string[];
|
|
4979
|
+
sorts?: InsightOrderingV2[];
|
|
4980
|
+
/** @example ["AAA"] */
|
|
4981
|
+
sp_ratings?: string[];
|
|
4982
|
+
/** @example ["called","outstanding"] */
|
|
4983
|
+
statuses?: string[];
|
|
4984
|
+
tickers?: string[];
|
|
4985
|
+
/** @example ["corporate"] */
|
|
4986
|
+
types?: string[];
|
|
4987
|
+
}
|
|
4988
|
+
export interface InsightGetTopSymbolsRequestV2 {
|
|
4989
|
+
exchange?: string[];
|
|
4990
|
+
market_cap?: InsightLessAndMoreV2;
|
|
4991
|
+
pagination?: InsightPaginationV2;
|
|
4992
|
+
price?: InsightLessAndMoreV2;
|
|
4993
|
+
sorts?: InsightOrderingV2[];
|
|
4994
|
+
volume?: InsightLessAndMoreV2;
|
|
4995
|
+
}
|
|
4996
|
+
export interface InsightIncludeExcludeV2 {
|
|
4997
|
+
exclude?: string[];
|
|
4998
|
+
include?: string[];
|
|
4999
|
+
}
|
|
5000
|
+
export interface InsightLessAndMoreV2 {
|
|
5001
|
+
less_than?: number;
|
|
5002
|
+
more_than?: number;
|
|
5003
|
+
}
|
|
5004
|
+
export interface InsightOrderingV2 {
|
|
5221
5005
|
/**
|
|
5222
|
-
* @
|
|
5223
|
-
* @
|
|
5224
|
-
* @name RemoveScreenerPreset
|
|
5225
|
-
* @summary remove screener preset
|
|
5226
|
-
* @request DELETE:/stock-screener/presets
|
|
5227
|
-
* @secure
|
|
5006
|
+
* @default "asc"
|
|
5007
|
+
* @example "asc"
|
|
5228
5008
|
*/
|
|
5229
|
-
|
|
5009
|
+
direction: InsightOrderingDirectionEnumV2;
|
|
5230
5010
|
/**
|
|
5231
|
-
*
|
|
5232
|
-
*
|
|
5233
|
-
*
|
|
5234
|
-
* @
|
|
5235
|
-
* @request POST:/stock-screener/top
|
|
5236
|
-
* @secure
|
|
5011
|
+
* Sort direction:
|
|
5012
|
+
* * asc - Ascending, from A to Z.
|
|
5013
|
+
* * desc - Descending, from Z to A.
|
|
5014
|
+
* @example "name"
|
|
5237
5015
|
*/
|
|
5238
|
-
|
|
5016
|
+
field: string;
|
|
5239
5017
|
}
|
|
5240
|
-
export
|
|
5241
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5242
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5243
|
-
/**
|
|
5244
|
-
* @description Get single historical quote
|
|
5245
|
-
* @tags Quotes
|
|
5246
|
-
* @name GitHistoricalQuote
|
|
5247
|
-
* @summary Get single historical quote
|
|
5248
|
-
* @request GET:/historical/quote
|
|
5249
|
-
* @secure
|
|
5250
|
-
*/
|
|
5251
|
-
gitHistoricalQuote(query: {
|
|
5252
|
-
/** Symbol */
|
|
5253
|
-
symbol: string;
|
|
5254
|
-
/** Date */
|
|
5255
|
-
date: string;
|
|
5256
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
|
|
5018
|
+
export interface InsightPaginationV2 {
|
|
5257
5019
|
/**
|
|
5258
|
-
* @
|
|
5259
|
-
* @
|
|
5260
|
-
* @name GitQuoteHistory
|
|
5261
|
-
* @summary Get quote history
|
|
5262
|
-
* @request POST:/quote-history
|
|
5263
|
-
* @secure
|
|
5020
|
+
* @min 1
|
|
5021
|
+
* @example 1
|
|
5264
5022
|
*/
|
|
5265
|
-
|
|
5023
|
+
page: number;
|
|
5266
5024
|
/**
|
|
5267
|
-
* @
|
|
5268
|
-
* @
|
|
5269
|
-
* @
|
|
5270
|
-
* @summary Get Quotes Equity data
|
|
5271
|
-
* @request GET:/quotes/equity
|
|
5272
|
-
* @secure
|
|
5025
|
+
* @min 1
|
|
5026
|
+
* @max 50
|
|
5027
|
+
* @example 10
|
|
5273
5028
|
*/
|
|
5274
|
-
|
|
5275
|
-
/** Comma separated symbols */
|
|
5276
|
-
symbols: string;
|
|
5277
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
|
|
5029
|
+
size: number;
|
|
5278
5030
|
}
|
|
5279
|
-
export
|
|
5280
|
-
|
|
5281
|
-
|
|
5282
|
-
|
|
5283
|
-
|
|
5284
|
-
|
|
5285
|
-
|
|
5286
|
-
|
|
5287
|
-
|
|
5288
|
-
|
|
5289
|
-
|
|
5290
|
-
|
|
5031
|
+
export interface InsightStockScreenerQuoteV2 {
|
|
5032
|
+
average_volume_30d: number;
|
|
5033
|
+
company_name: string;
|
|
5034
|
+
dividend_ex_date: string;
|
|
5035
|
+
dividend_pay_date: string;
|
|
5036
|
+
dividend_percent: number;
|
|
5037
|
+
exchange: string;
|
|
5038
|
+
exchange_name: string;
|
|
5039
|
+
gap: number;
|
|
5040
|
+
industry: string;
|
|
5041
|
+
industry_code: string;
|
|
5042
|
+
last_price: number;
|
|
5043
|
+
market_cap: number;
|
|
5044
|
+
pe_ratio: number;
|
|
5045
|
+
price_change: number;
|
|
5046
|
+
price_change_percent: number;
|
|
5047
|
+
symbol: string;
|
|
5048
|
+
volume: number;
|
|
5291
5049
|
}
|
|
5292
|
-
export
|
|
5293
|
-
|
|
5294
|
-
|
|
5295
|
-
|
|
5296
|
-
|
|
5297
|
-
|
|
5298
|
-
|
|
5299
|
-
|
|
5300
|
-
|
|
5301
|
-
|
|
5302
|
-
|
|
5303
|
-
|
|
5304
|
-
|
|
5305
|
-
|
|
5306
|
-
|
|
5307
|
-
|
|
5308
|
-
|
|
5309
|
-
|
|
5310
|
-
|
|
5311
|
-
|
|
5312
|
-
|
|
5313
|
-
|
|
5314
|
-
|
|
5315
|
-
|
|
5316
|
-
|
|
5317
|
-
|
|
5318
|
-
|
|
5319
|
-
|
|
5320
|
-
|
|
5321
|
-
|
|
5322
|
-
|
|
5323
|
-
|
|
5324
|
-
|
|
5325
|
-
|
|
5326
|
-
|
|
5327
|
-
*/
|
|
5328
|
-
monarkAllAvailableSymbols(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5050
|
+
export interface InsightStockScreenerRequestV2 {
|
|
5051
|
+
average_volume_30d?: InsightLessAndMoreV2;
|
|
5052
|
+
dividend_ex_date?: InsightBeforeAndAfterV2;
|
|
5053
|
+
dividend_pay_date?: InsightBeforeAndAfterV2;
|
|
5054
|
+
dividend_percent?: InsightLessAndMoreV2;
|
|
5055
|
+
exchange?: InsightIncludeExcludeV2;
|
|
5056
|
+
gap?: InsightLessAndMoreV2;
|
|
5057
|
+
industry?: InsightIncludeExcludeV2;
|
|
5058
|
+
market_cap?: InsightLessAndMoreV2;
|
|
5059
|
+
pagination: InsightPaginationV2;
|
|
5060
|
+
pe_ratio?: InsightLessAndMoreV2;
|
|
5061
|
+
price?: InsightLessAndMoreV2;
|
|
5062
|
+
sorts?: InsightOrderingV2[];
|
|
5063
|
+
/** @example "ADR" */
|
|
5064
|
+
stock_type?: string;
|
|
5065
|
+
volume?: InsightLessAndMoreV2;
|
|
5066
|
+
}
|
|
5067
|
+
export interface InsightStockScreenerResponseV2 {
|
|
5068
|
+
current_page: number;
|
|
5069
|
+
data: InsightStockScreenerQuoteV2[];
|
|
5070
|
+
page_count: number;
|
|
5071
|
+
status: number;
|
|
5072
|
+
total_records: number;
|
|
5073
|
+
}
|
|
5074
|
+
/**
|
|
5075
|
+
* @default "asc"
|
|
5076
|
+
* @example "asc"
|
|
5077
|
+
*/
|
|
5078
|
+
export enum InsightOrderingDirectionEnumV2 {
|
|
5079
|
+
Asc = "asc",
|
|
5080
|
+
Desc = "desc"
|
|
5081
|
+
}
|
|
5082
|
+
export class FixedIncomeV2<HandleError extends boolean = boolean> {
|
|
5083
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5084
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5329
5085
|
/**
|
|
5330
|
-
* @description get
|
|
5331
|
-
* @tags
|
|
5332
|
-
* @name
|
|
5333
|
-
* @summary get
|
|
5334
|
-
* @request
|
|
5086
|
+
* @description get fixed income entries
|
|
5087
|
+
* @tags FixedIncome
|
|
5088
|
+
* @name GetFixedIncomeEntries
|
|
5089
|
+
* @summary get fixed income entries
|
|
5090
|
+
* @request POST:/fixed-income
|
|
5335
5091
|
* @secure
|
|
5336
5092
|
*/
|
|
5337
|
-
|
|
5338
|
-
|
|
5339
|
-
|
|
5340
|
-
|
|
5341
|
-
|
|
5342
|
-
/** how many records to return. Max value is 50 */
|
|
5343
|
-
limit: number;
|
|
5344
|
-
/** how many records to skip */
|
|
5345
|
-
offset: number;
|
|
5346
|
-
/** sort field */
|
|
5347
|
-
order_field?: InsightGetPreIpoCompaniesParamsOrderFieldEnum;
|
|
5348
|
-
/** sort direction */
|
|
5349
|
-
order_direction?: InsightGetPreIpoCompaniesParamsOrderDirectionEnum;
|
|
5350
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
|
|
5093
|
+
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
|
|
5094
|
+
}
|
|
5095
|
+
export class Fundamentals<HandleError extends boolean = boolean> {
|
|
5096
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5097
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5351
5098
|
/**
|
|
5352
|
-
* @description get
|
|
5353
|
-
* @tags
|
|
5354
|
-
* @name
|
|
5355
|
-
* @summary get
|
|
5356
|
-
* @request
|
|
5357
|
-
* @originalName getPreIpoCompanies
|
|
5358
|
-
* @duplicate
|
|
5099
|
+
* @description get fundamentals by symbol data
|
|
5100
|
+
* @tags Fundamentals
|
|
5101
|
+
* @name GetFundamentalsBySymbolData
|
|
5102
|
+
* @summary get fundamentals by symbol data
|
|
5103
|
+
* @request POST:/fundamentals
|
|
5359
5104
|
* @secure
|
|
5360
5105
|
*/
|
|
5361
|
-
|
|
5106
|
+
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
5107
|
+
}
|
|
5108
|
+
export class Funds<HandleError extends boolean = boolean> {
|
|
5109
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5110
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5362
5111
|
/**
|
|
5363
|
-
* @description get
|
|
5364
|
-
* @tags
|
|
5365
|
-
* @name
|
|
5366
|
-
* @summary get
|
|
5367
|
-
* @request GET:/
|
|
5112
|
+
* @description get fund details
|
|
5113
|
+
* @tags Funds
|
|
5114
|
+
* @name GetFundDetails
|
|
5115
|
+
* @summary get fund details
|
|
5116
|
+
* @request GET:/funds/details
|
|
5368
5117
|
* @secure
|
|
5369
5118
|
*/
|
|
5370
|
-
|
|
5371
|
-
/**
|
|
5372
|
-
|
|
5373
|
-
|
|
5374
|
-
round_name?: string;
|
|
5375
|
-
/** how many records to return. Max value is 50 */
|
|
5376
|
-
limit: number;
|
|
5377
|
-
/** how many records to skip */
|
|
5378
|
-
offset: number;
|
|
5379
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyFundingRoundsResponse, HandleError>>;
|
|
5119
|
+
getFundDetails(query: {
|
|
5120
|
+
/** Fund symbol */
|
|
5121
|
+
symbol: string;
|
|
5122
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundDetailsResponse, HandleError>>;
|
|
5380
5123
|
/**
|
|
5381
|
-
* @description get
|
|
5382
|
-
* @tags
|
|
5383
|
-
* @name
|
|
5384
|
-
* @summary get
|
|
5385
|
-
* @request
|
|
5386
|
-
* @originalName getPreIpoCompanyFundingRounds
|
|
5387
|
-
* @duplicate
|
|
5124
|
+
* @description get funds for holding
|
|
5125
|
+
* @tags Funds
|
|
5126
|
+
* @name GetFundsForHolding
|
|
5127
|
+
* @summary get funds for holding
|
|
5128
|
+
* @request POST:/funds/funds-for-holding
|
|
5388
5129
|
* @secure
|
|
5389
5130
|
*/
|
|
5390
|
-
|
|
5131
|
+
getFundsForHolding(filter: InsightGetFundsForHoldingRequest, headers?: {
|
|
5132
|
+
/** Authorization */
|
|
5133
|
+
Authorization?: string;
|
|
5134
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundsForHoldingResponse, HandleError>>;
|
|
5391
5135
|
/**
|
|
5392
|
-
* @description
|
|
5393
|
-
* @tags
|
|
5394
|
-
* @name
|
|
5395
|
-
* @summary
|
|
5396
|
-
* @request
|
|
5136
|
+
* @description filter funds by params
|
|
5137
|
+
* @tags Funds
|
|
5138
|
+
* @name FundScreener
|
|
5139
|
+
* @summary filter funds by params
|
|
5140
|
+
* @request POST:/funds/screener
|
|
5397
5141
|
* @secure
|
|
5398
5142
|
*/
|
|
5399
|
-
|
|
5400
|
-
/**
|
|
5401
|
-
|
|
5402
|
-
|
|
5403
|
-
company_name?: string;
|
|
5404
|
-
/** how many records to return. Max value is 50 */
|
|
5405
|
-
limit: number;
|
|
5406
|
-
/** how many records to skip */
|
|
5407
|
-
offset: number;
|
|
5408
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyInvestmentsResponse, HandleError>>;
|
|
5143
|
+
fundScreener(filter: InsightFundScreenerRequest, headers?: {
|
|
5144
|
+
/** Authorization */
|
|
5145
|
+
Authorization?: string;
|
|
5146
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
|
|
5409
5147
|
/**
|
|
5410
|
-
* @description get
|
|
5411
|
-
* @tags
|
|
5412
|
-
* @name
|
|
5413
|
-
* @summary get
|
|
5414
|
-
* @request GET:/
|
|
5415
|
-
* @originalName getPreIpoCompanyInvestments
|
|
5416
|
-
* @duplicate
|
|
5148
|
+
* @description get fund screener filters
|
|
5149
|
+
* @tags Funds
|
|
5150
|
+
* @name GetScreenerFilters
|
|
5151
|
+
* @summary get fund screener filters
|
|
5152
|
+
* @request GET:/funds/screener/filters
|
|
5417
5153
|
* @secure
|
|
5418
5154
|
*/
|
|
5419
|
-
|
|
5155
|
+
getScreenerFilters(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundScreenerFiltersResponse, HandleError>>;
|
|
5420
5156
|
/**
|
|
5421
|
-
* @description get
|
|
5422
|
-
* @tags
|
|
5423
|
-
* @name
|
|
5424
|
-
* @summary get
|
|
5425
|
-
* @request GET:/
|
|
5157
|
+
* @description get fund screener presets
|
|
5158
|
+
* @tags Funds
|
|
5159
|
+
* @name GetFundScreenerPresets
|
|
5160
|
+
* @summary get fund screener presets
|
|
5161
|
+
* @request GET:/funds/screener/presets
|
|
5426
5162
|
* @secure
|
|
5427
5163
|
*/
|
|
5428
|
-
|
|
5429
|
-
/**
|
|
5430
|
-
pre_ipo_company_id?: string;
|
|
5431
|
-
/** search by headline */
|
|
5432
|
-
headline?: string;
|
|
5433
|
-
/** how many records to return. Max value is 50 */
|
|
5164
|
+
getFundScreenerPresets(query: {
|
|
5165
|
+
/** how many records to return */
|
|
5434
5166
|
limit: number;
|
|
5435
5167
|
/** how many records to skip */
|
|
5436
5168
|
offset: number;
|
|
5437
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5438
|
-
/**
|
|
5439
|
-
* @description get pre ipo company news by id
|
|
5440
|
-
* @tags PreIPOCompanies
|
|
5441
|
-
* @name GetPreIpoCompanyNewsById
|
|
5442
|
-
* @summary get pre ipo company news by id
|
|
5443
|
-
* @request GET:/ipos/pre-ipo-company-news/{id}
|
|
5444
|
-
* @originalName getPreIpoCompanyNews
|
|
5445
|
-
* @duplicate
|
|
5446
|
-
* @secure
|
|
5447
|
-
*/
|
|
5448
|
-
getPreIpoCompanyNewsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyNews, HandleError>>;
|
|
5169
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
5449
5170
|
/**
|
|
5450
|
-
* @description
|
|
5451
|
-
* @tags
|
|
5452
|
-
* @name
|
|
5453
|
-
* @summary
|
|
5454
|
-
* @request
|
|
5171
|
+
* @description update fund screener preset
|
|
5172
|
+
* @tags Funds
|
|
5173
|
+
* @name UpdateFundScreenerPreset
|
|
5174
|
+
* @summary update fund screener preset
|
|
5175
|
+
* @request PUT:/funds/screener/presets
|
|
5455
5176
|
* @secure
|
|
5456
5177
|
*/
|
|
5457
|
-
|
|
5458
|
-
/** company id */
|
|
5459
|
-
pre_ipo_company_id?: string;
|
|
5460
|
-
/** search by title */
|
|
5461
|
-
title?: string;
|
|
5462
|
-
/** how many records to return. Max value is 50 */
|
|
5463
|
-
limit: number;
|
|
5464
|
-
/** how many records to skip */
|
|
5465
|
-
offset: number;
|
|
5466
|
-
/** search by research type */
|
|
5467
|
-
research_type?: InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum;
|
|
5468
|
-
/** search by relation */
|
|
5469
|
-
relation?: InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum;
|
|
5470
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError>>;
|
|
5178
|
+
updateFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5471
5179
|
/**
|
|
5472
|
-
* @description
|
|
5473
|
-
* @tags
|
|
5474
|
-
* @name
|
|
5475
|
-
* @summary
|
|
5476
|
-
* @request
|
|
5477
|
-
* @originalName getPreIpoCompanyResearchDocuments
|
|
5478
|
-
* @duplicate
|
|
5180
|
+
* @description create fund screener preset
|
|
5181
|
+
* @tags Funds
|
|
5182
|
+
* @name CreateFundScreenerPreset
|
|
5183
|
+
* @summary create fund screener preset
|
|
5184
|
+
* @request POST:/funds/screener/presets
|
|
5479
5185
|
* @secure
|
|
5480
5186
|
*/
|
|
5481
|
-
|
|
5187
|
+
createFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5482
5188
|
/**
|
|
5483
|
-
* @description
|
|
5484
|
-
* @tags
|
|
5485
|
-
* @name
|
|
5486
|
-
* @summary
|
|
5487
|
-
* @request
|
|
5189
|
+
* @description remove fund screener preset
|
|
5190
|
+
* @tags Funds
|
|
5191
|
+
* @name RemoveFundScreenerPreset
|
|
5192
|
+
* @summary remove fund screener preset
|
|
5193
|
+
* @request DELETE:/funds/screener/presets
|
|
5488
5194
|
* @secure
|
|
5489
5195
|
*/
|
|
5490
|
-
|
|
5491
|
-
/** search by monark stage */
|
|
5492
|
-
monark_stage?: InsightGetInvestorParamsMonarkStageEnum;
|
|
5493
|
-
/** Optional param to filter returned spv's based on the exemptions claimed */
|
|
5494
|
-
exemptions_claimed?: string[];
|
|
5495
|
-
/** Optional param to filter returned spv's based on the name */
|
|
5496
|
-
name_filter?: string;
|
|
5497
|
-
/** investment id */
|
|
5498
|
-
pre_ipo_company_id?: string;
|
|
5499
|
-
/** investment id */
|
|
5500
|
-
pre_ipo_company_investment_id?: string;
|
|
5501
|
-
/** page number */
|
|
5502
|
-
page: number;
|
|
5503
|
-
/** page size */
|
|
5504
|
-
page_size: number;
|
|
5505
|
-
/** sort direction */
|
|
5506
|
-
sort_order?: InsightGetInvestorParamsSortOrderEnum;
|
|
5507
|
-
/** sort field */
|
|
5508
|
-
sort_by?: InsightGetInvestorParamsSortByEnum;
|
|
5509
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsWithInvestorIDResponse, HandleError>>;
|
|
5196
|
+
removeFundScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5510
5197
|
/**
|
|
5511
|
-
* @description
|
|
5512
|
-
* @tags
|
|
5513
|
-
* @name
|
|
5514
|
-
* @summary
|
|
5515
|
-
* @request
|
|
5516
|
-
* @originalName getInvestor
|
|
5517
|
-
* @duplicate
|
|
5198
|
+
* @description filter funds by params
|
|
5199
|
+
* @tags Funds
|
|
5200
|
+
* @name FundSectorScreener
|
|
5201
|
+
* @summary filter funds by params
|
|
5202
|
+
* @request POST:/funds/sector-screener
|
|
5518
5203
|
* @secure
|
|
5519
5204
|
*/
|
|
5520
|
-
|
|
5521
|
-
/**
|
|
5522
|
-
|
|
5523
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5205
|
+
fundSectorScreener(filter: InsightFundSectorScreenerRequest, headers?: {
|
|
5206
|
+
/** Authorization */
|
|
5207
|
+
Authorization?: string;
|
|
5208
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
|
|
5524
5209
|
/**
|
|
5525
|
-
* @description get
|
|
5526
|
-
* @tags
|
|
5527
|
-
* @name
|
|
5528
|
-
* @summary get
|
|
5529
|
-
* @request
|
|
5210
|
+
* @description get top funds
|
|
5211
|
+
* @tags Funds
|
|
5212
|
+
* @name GetTopFunds
|
|
5213
|
+
* @summary get top funds
|
|
5214
|
+
* @request POST:/funds/top
|
|
5530
5215
|
* @secure
|
|
5531
5216
|
*/
|
|
5532
|
-
|
|
5533
|
-
/**
|
|
5534
|
-
|
|
5535
|
-
|
|
5536
|
-
|
|
5537
|
-
|
|
5538
|
-
|
|
5539
|
-
|
|
5540
|
-
company_name?: string;
|
|
5541
|
-
/** how many records to return. Max value is 50 */
|
|
5542
|
-
limit: number;
|
|
5543
|
-
/** how many records to skip */
|
|
5544
|
-
offset: number;
|
|
5545
|
-
/** search by monark stage */
|
|
5546
|
-
monark_stage?: InsightGetPreIpoCompanySpvsParamsMonarkStageEnum;
|
|
5547
|
-
/** sort direction */
|
|
5548
|
-
direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
|
|
5549
|
-
/** sort field */
|
|
5550
|
-
field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
|
|
5551
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
|
|
5217
|
+
getTopFunds(filter: InsightGetTopFundsRequest, headers?: {
|
|
5218
|
+
/** Authorization */
|
|
5219
|
+
Authorization?: string;
|
|
5220
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
|
|
5221
|
+
}
|
|
5222
|
+
export class Intraday<HandleError extends boolean = boolean> {
|
|
5223
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5224
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5552
5225
|
/**
|
|
5553
|
-
* @description
|
|
5554
|
-
* @tags
|
|
5555
|
-
* @name
|
|
5556
|
-
* @summary
|
|
5557
|
-
* @request
|
|
5558
|
-
* @originalName getPreIpoCompanySpvs
|
|
5559
|
-
* @duplicate
|
|
5226
|
+
* @description Returns an array of intraday chart data values for the given ticker.
|
|
5227
|
+
* @tags Intraday
|
|
5228
|
+
* @name IntradayQuotes
|
|
5229
|
+
* @summary Get an array of intraday chart data values for the given ticker
|
|
5230
|
+
* @request POST:/intraday/quotes
|
|
5560
5231
|
* @secure
|
|
5561
5232
|
*/
|
|
5562
|
-
|
|
5563
|
-
/** default is false, if true documents will be included in the response */
|
|
5564
|
-
include_documents?: boolean;
|
|
5565
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
|
|
5233
|
+
intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
|
|
5566
5234
|
}
|
|
5567
5235
|
export class Ipos<HandleError extends boolean = boolean> {
|
|
5568
5236
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5730,28 +5398,6 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
5730
5398
|
market: string;
|
|
5731
5399
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
|
|
5732
5400
|
}
|
|
5733
|
-
export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
5734
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5735
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5736
|
-
/**
|
|
5737
|
-
* @description Returns calculated matrix
|
|
5738
|
-
* @tags OptionGreeks
|
|
5739
|
-
* @name OgCalculateMatrix
|
|
5740
|
-
* @summary Calculate matrix
|
|
5741
|
-
* @request POST:/og/calculate-matrix
|
|
5742
|
-
* @secure
|
|
5743
|
-
*/
|
|
5744
|
-
ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
|
|
5745
|
-
/**
|
|
5746
|
-
* @description Returns calculated params
|
|
5747
|
-
* @tags OptionGreeks
|
|
5748
|
-
* @name OgCalculateParams
|
|
5749
|
-
* @summary Calculate params
|
|
5750
|
-
* @request POST:/og/calculate-params
|
|
5751
|
-
* @secure
|
|
5752
|
-
*/
|
|
5753
|
-
ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
|
|
5754
|
-
}
|
|
5755
5401
|
export class News<HandleError extends boolean = boolean> {
|
|
5756
5402
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5757
5403
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5844,174 +5490,436 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
5844
5490
|
* @request POST:/news/filter
|
|
5845
5491
|
* @secure
|
|
5846
5492
|
*/
|
|
5847
|
-
newsFiltered(filter: InsightNewsFilterRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsResponse, HandleError>>;
|
|
5493
|
+
newsFiltered(filter: InsightNewsFilterRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsResponse, HandleError>>;
|
|
5494
|
+
/**
|
|
5495
|
+
* @description Returns news by id
|
|
5496
|
+
* @tags News
|
|
5497
|
+
* @name NewsById
|
|
5498
|
+
* @summary Get news by id
|
|
5499
|
+
* @request POST:/news/id
|
|
5500
|
+
* @secure
|
|
5501
|
+
*/
|
|
5502
|
+
newsById(filter: InsightNewsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNews, HandleError>>;
|
|
5503
|
+
/**
|
|
5504
|
+
* @description Returns news previews
|
|
5505
|
+
* @tags News
|
|
5506
|
+
* @name NewsPreviewsFiltered
|
|
5507
|
+
* @summary Get news previews
|
|
5508
|
+
* @request GET:/news/previews
|
|
5509
|
+
* @secure
|
|
5510
|
+
*/
|
|
5511
|
+
newsPreviewsFiltered(query: {
|
|
5512
|
+
/** Start date */
|
|
5513
|
+
start_date?: string;
|
|
5514
|
+
/** End date */
|
|
5515
|
+
end_date?: string;
|
|
5516
|
+
/** Symbol */
|
|
5517
|
+
symbol?: string;
|
|
5518
|
+
/** how many records to return. Max value is 50 */
|
|
5519
|
+
limit: number;
|
|
5520
|
+
/** how many records to skip */
|
|
5521
|
+
offset: number;
|
|
5522
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRecentNewsPreviewsResponse, HandleError>>;
|
|
5523
|
+
/**
|
|
5524
|
+
* @description Returns available stocks in DB
|
|
5525
|
+
* @tags News
|
|
5526
|
+
* @name NewsAvailableStocks
|
|
5527
|
+
* @summary Get available stocks in DB (for filters)
|
|
5528
|
+
* @request GET:/news/symbols
|
|
5529
|
+
* @secure
|
|
5530
|
+
*/
|
|
5531
|
+
newsAvailableStocks(query?: {
|
|
5532
|
+
/** Limit */
|
|
5533
|
+
limit?: number;
|
|
5534
|
+
/** Offset */
|
|
5535
|
+
offset?: number;
|
|
5536
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5537
|
+
/**
|
|
5538
|
+
* @description Returns available tags in DB
|
|
5539
|
+
* @tags News
|
|
5540
|
+
* @name NewsAvailableTags
|
|
5541
|
+
* @summary Get available tags in DB (for filters)
|
|
5542
|
+
* @request POST:/news/tags
|
|
5543
|
+
* @secure
|
|
5544
|
+
*/
|
|
5545
|
+
newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5546
|
+
}
|
|
5547
|
+
export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
5548
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5549
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5550
|
+
/**
|
|
5551
|
+
* @description Returns calculated matrix
|
|
5552
|
+
* @tags OptionGreeks
|
|
5553
|
+
* @name OgCalculateMatrix
|
|
5554
|
+
* @summary Calculate matrix
|
|
5555
|
+
* @request POST:/og/calculate-matrix
|
|
5556
|
+
* @secure
|
|
5557
|
+
*/
|
|
5558
|
+
ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
|
|
5559
|
+
/**
|
|
5560
|
+
* @description Returns calculated params
|
|
5561
|
+
* @tags OptionGreeks
|
|
5562
|
+
* @name OgCalculateParams
|
|
5563
|
+
* @summary Calculate params
|
|
5564
|
+
* @request POST:/og/calculate-params
|
|
5565
|
+
* @secure
|
|
5566
|
+
*/
|
|
5567
|
+
ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
|
|
5568
|
+
}
|
|
5569
|
+
export class Ownerships<HandleError extends boolean = boolean> {
|
|
5570
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5571
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5572
|
+
/**
|
|
5573
|
+
* @description get ownerships by id datadata
|
|
5574
|
+
* @tags Ownerships
|
|
5575
|
+
* @name GetOwnershipsByIdData
|
|
5576
|
+
* @summary get ownerships by id data
|
|
5577
|
+
* @request POST:/ownerships
|
|
5578
|
+
* @secure
|
|
5579
|
+
*/
|
|
5580
|
+
getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
5581
|
+
/**
|
|
5582
|
+
* @description get ownerships by symbol data
|
|
5583
|
+
* @tags Ownerships
|
|
5584
|
+
* @name GetOwnershipsBySymbolData
|
|
5585
|
+
* @summary get ownerships by symbol data
|
|
5586
|
+
* @request POST:/symbol-ownerships
|
|
5587
|
+
* @secure
|
|
5588
|
+
*/
|
|
5589
|
+
getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
5590
|
+
}
|
|
5591
|
+
export class Passport<HandleError extends boolean = boolean> {
|
|
5592
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5593
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5594
|
+
/**
|
|
5595
|
+
* @description Returns article by id
|
|
5596
|
+
* @tags Passport
|
|
5597
|
+
* @name PassportArticleById
|
|
5598
|
+
* @summary Get article by id
|
|
5599
|
+
* @request POST:/passport/article-by-id
|
|
5600
|
+
* @secure
|
|
5601
|
+
*/
|
|
5602
|
+
passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
|
|
5603
|
+
/**
|
|
5604
|
+
* @description Returns articles
|
|
5605
|
+
* @tags Passport
|
|
5606
|
+
* @name PassportArticles
|
|
5607
|
+
* @summary Get articles
|
|
5608
|
+
* @request POST:/passport/articles
|
|
5609
|
+
* @secure
|
|
5610
|
+
*/
|
|
5611
|
+
passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
5612
|
+
/**
|
|
5613
|
+
* @description Returns author profile
|
|
5614
|
+
* @tags Passport
|
|
5615
|
+
* @name PassportAuthorProfile
|
|
5616
|
+
* @summary Get author profile
|
|
5617
|
+
* @request POST:/passport/author-profile
|
|
5618
|
+
* @secure
|
|
5619
|
+
*/
|
|
5620
|
+
passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
|
|
5621
|
+
/**
|
|
5622
|
+
* @description Returns most popular tags
|
|
5623
|
+
* @tags Passport
|
|
5624
|
+
* @name PassportMostPopularTags
|
|
5625
|
+
* @summary Get most popular tags
|
|
5626
|
+
* @request POST:/passport/most-popular-tags
|
|
5627
|
+
* @secure
|
|
5628
|
+
*/
|
|
5629
|
+
passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
|
|
5630
|
+
/**
|
|
5631
|
+
* @description Returns news feed
|
|
5632
|
+
* @tags Passport
|
|
5633
|
+
* @name PassportNewsFeed
|
|
5634
|
+
* @summary Get news feed
|
|
5635
|
+
* @request POST:/passport/newsfeed
|
|
5636
|
+
* @secure
|
|
5637
|
+
*/
|
|
5638
|
+
passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
|
|
5639
|
+
/**
|
|
5640
|
+
* @description Returns article by parameters
|
|
5641
|
+
* @tags Passport
|
|
5642
|
+
* @name PassportSearchArticle
|
|
5643
|
+
* @summary Search article by parameters
|
|
5644
|
+
* @request POST:/passport/search-article
|
|
5645
|
+
* @secure
|
|
5646
|
+
*/
|
|
5647
|
+
passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
5648
|
+
}
|
|
5649
|
+
export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
5650
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5651
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5652
|
+
/**
|
|
5653
|
+
* @description Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
|
|
5654
|
+
* @tags PreIPOCompanies
|
|
5655
|
+
* @name MonarkOghlcDataForSymbol
|
|
5656
|
+
* @summary Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
|
|
5657
|
+
* @request GET:/ipos/market-data/ohlc/{symbol}
|
|
5658
|
+
* @secure
|
|
5659
|
+
*/
|
|
5660
|
+
monarkOghlcDataForSymbol(symbol: string, query?: {
|
|
5661
|
+
/** Start time for the OHLC data in ISO 8601 format YYYY-MM-DD */
|
|
5662
|
+
from?: string;
|
|
5663
|
+
/** End time for the OHLC data in ISO 8601 format YYYY-MM-DD */
|
|
5664
|
+
to?: string;
|
|
5665
|
+
/** Time interval for buckets: 1d (day), 1w (week), 1mo (month), 3mo (3 months). Default is 1d. */
|
|
5666
|
+
interval?: string;
|
|
5667
|
+
/** Limit the number of OHLC data points returned. Default is 100. */
|
|
5668
|
+
limit?: number;
|
|
5669
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<{
|
|
5670
|
+
close?: number;
|
|
5671
|
+
high?: number;
|
|
5672
|
+
low?: number;
|
|
5673
|
+
open?: number;
|
|
5674
|
+
time?: string;
|
|
5675
|
+
volume?: number;
|
|
5676
|
+
}[], HandleError>>;
|
|
5848
5677
|
/**
|
|
5849
|
-
* @description
|
|
5850
|
-
* @tags
|
|
5851
|
-
* @name
|
|
5852
|
-
* @summary
|
|
5853
|
-
* @request
|
|
5678
|
+
* @description Retrieves all symbols available in the market data
|
|
5679
|
+
* @tags PreIPOCompanies
|
|
5680
|
+
* @name MonarkAllAvailableSymbols
|
|
5681
|
+
* @summary Retrieves all symbols available in the market data
|
|
5682
|
+
* @request GET:/ipos/market-data/symbols
|
|
5854
5683
|
* @secure
|
|
5855
5684
|
*/
|
|
5856
|
-
|
|
5685
|
+
monarkAllAvailableSymbols(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5857
5686
|
/**
|
|
5858
|
-
* @description
|
|
5859
|
-
* @tags
|
|
5860
|
-
* @name
|
|
5861
|
-
* @summary
|
|
5862
|
-
* @request GET:/
|
|
5687
|
+
* @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
|
|
5688
|
+
* @tags PreIPOCompanies
|
|
5689
|
+
* @name GetPreIpoCompanies
|
|
5690
|
+
* @summary get pre ipo companies
|
|
5691
|
+
* @request GET:/ipos/pre-ipo-companies
|
|
5863
5692
|
* @secure
|
|
5864
5693
|
*/
|
|
5865
|
-
|
|
5866
|
-
/**
|
|
5867
|
-
|
|
5868
|
-
/**
|
|
5869
|
-
|
|
5870
|
-
/** Symbol */
|
|
5871
|
-
symbol?: string;
|
|
5694
|
+
getPreIpoCompanies(query: {
|
|
5695
|
+
/** search by company name */
|
|
5696
|
+
name?: string;
|
|
5697
|
+
/** search by categories */
|
|
5698
|
+
categories?: string;
|
|
5872
5699
|
/** how many records to return. Max value is 50 */
|
|
5873
5700
|
limit: number;
|
|
5874
5701
|
/** how many records to skip */
|
|
5875
5702
|
offset: number;
|
|
5876
|
-
|
|
5703
|
+
/** sort field */
|
|
5704
|
+
order_field?: InsightGetPreIpoCompaniesParamsOrderFieldEnum;
|
|
5705
|
+
/** sort direction */
|
|
5706
|
+
order_direction?: InsightGetPreIpoCompaniesParamsOrderDirectionEnum;
|
|
5707
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
|
|
5877
5708
|
/**
|
|
5878
|
-
* @description
|
|
5879
|
-
* @tags
|
|
5880
|
-
* @name
|
|
5881
|
-
* @summary
|
|
5882
|
-
* @request GET:/
|
|
5709
|
+
* @description get pre ipo company by id
|
|
5710
|
+
* @tags PreIPOCompanies
|
|
5711
|
+
* @name GetPreIpoCompaniesById
|
|
5712
|
+
* @summary get pre ipo company by id
|
|
5713
|
+
* @request GET:/ipos/pre-ipo-companies/{id}
|
|
5714
|
+
* @originalName getPreIpoCompanies
|
|
5715
|
+
* @duplicate
|
|
5883
5716
|
* @secure
|
|
5884
5717
|
*/
|
|
5885
|
-
|
|
5886
|
-
/** Limit */
|
|
5887
|
-
limit?: number;
|
|
5888
|
-
/** Offset */
|
|
5889
|
-
offset?: number;
|
|
5890
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5718
|
+
getPreIpoCompaniesById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompany, HandleError>>;
|
|
5891
5719
|
/**
|
|
5892
|
-
* @description
|
|
5893
|
-
* @tags
|
|
5894
|
-
* @name
|
|
5895
|
-
* @summary
|
|
5896
|
-
* @request
|
|
5720
|
+
* @description get pre ipo company funding rounds
|
|
5721
|
+
* @tags PreIPOCompanies
|
|
5722
|
+
* @name GetPreIpoCompanyFundingRounds
|
|
5723
|
+
* @summary get pre ipo company funding rounds
|
|
5724
|
+
* @request GET:/ipos/pre-ipo-company-funding-rounds
|
|
5897
5725
|
* @secure
|
|
5898
5726
|
*/
|
|
5899
|
-
|
|
5900
|
-
|
|
5901
|
-
|
|
5902
|
-
|
|
5903
|
-
|
|
5727
|
+
getPreIpoCompanyFundingRounds(query: {
|
|
5728
|
+
/** company id */
|
|
5729
|
+
pre_ipo_company_id?: string;
|
|
5730
|
+
/** search by round name */
|
|
5731
|
+
round_name?: string;
|
|
5732
|
+
/** how many records to return. Max value is 50 */
|
|
5733
|
+
limit: number;
|
|
5734
|
+
/** how many records to skip */
|
|
5735
|
+
offset: number;
|
|
5736
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyFundingRoundsResponse, HandleError>>;
|
|
5904
5737
|
/**
|
|
5905
|
-
* @description get
|
|
5906
|
-
* @tags
|
|
5907
|
-
* @name
|
|
5908
|
-
* @summary get
|
|
5909
|
-
* @request
|
|
5738
|
+
* @description get pre ipo company funding round by id
|
|
5739
|
+
* @tags PreIPOCompanies
|
|
5740
|
+
* @name GetPreIpoCompanyFundingRoundsById
|
|
5741
|
+
* @summary get pre ipo company funding round by id
|
|
5742
|
+
* @request GET:/ipos/pre-ipo-company-funding-rounds/{id}
|
|
5743
|
+
* @originalName getPreIpoCompanyFundingRounds
|
|
5744
|
+
* @duplicate
|
|
5910
5745
|
* @secure
|
|
5911
5746
|
*/
|
|
5912
|
-
|
|
5747
|
+
getPreIpoCompanyFundingRoundsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyFundingRound, HandleError>>;
|
|
5913
5748
|
/**
|
|
5914
|
-
* @description get
|
|
5915
|
-
* @tags
|
|
5916
|
-
* @name
|
|
5917
|
-
* @summary get
|
|
5918
|
-
* @request
|
|
5749
|
+
* @description get pre ipo company investments
|
|
5750
|
+
* @tags PreIPOCompanies
|
|
5751
|
+
* @name GetPreIpoCompanyInvestments
|
|
5752
|
+
* @summary get pre ipo company investments
|
|
5753
|
+
* @request GET:/ipos/pre-ipo-company-investments
|
|
5919
5754
|
* @secure
|
|
5920
5755
|
*/
|
|
5921
|
-
|
|
5922
|
-
|
|
5923
|
-
|
|
5924
|
-
|
|
5925
|
-
|
|
5756
|
+
getPreIpoCompanyInvestments(query: {
|
|
5757
|
+
/** company id */
|
|
5758
|
+
pre_ipo_company_id?: string;
|
|
5759
|
+
/** company name */
|
|
5760
|
+
company_name?: string;
|
|
5761
|
+
/** how many records to return. Max value is 50 */
|
|
5762
|
+
limit: number;
|
|
5763
|
+
/** how many records to skip */
|
|
5764
|
+
offset: number;
|
|
5765
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyInvestmentsResponse, HandleError>>;
|
|
5926
5766
|
/**
|
|
5927
|
-
* @description get
|
|
5928
|
-
* @tags
|
|
5929
|
-
* @name
|
|
5930
|
-
* @summary get
|
|
5931
|
-
* @request
|
|
5767
|
+
* @description get pre ipo company investment by id
|
|
5768
|
+
* @tags PreIPOCompanies
|
|
5769
|
+
* @name GetPreIpoCompanyInvestmentsById
|
|
5770
|
+
* @summary get pre ipo company investment by id
|
|
5771
|
+
* @request GET:/ipos/pre-ipo-company-investments/{id}
|
|
5772
|
+
* @originalName getPreIpoCompanyInvestments
|
|
5773
|
+
* @duplicate
|
|
5932
5774
|
* @secure
|
|
5933
5775
|
*/
|
|
5934
|
-
|
|
5776
|
+
getPreIpoCompanyInvestmentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyInvestment, HandleError>>;
|
|
5935
5777
|
/**
|
|
5936
|
-
* @description get
|
|
5937
|
-
* @tags
|
|
5938
|
-
* @name
|
|
5939
|
-
* @summary get
|
|
5940
|
-
* @request
|
|
5778
|
+
* @description get pre ipo company news
|
|
5779
|
+
* @tags PreIPOCompanies
|
|
5780
|
+
* @name GetPreIpoCompanyNews
|
|
5781
|
+
* @summary get pre ipo company news
|
|
5782
|
+
* @request GET:/ipos/pre-ipo-company-news
|
|
5941
5783
|
* @secure
|
|
5942
5784
|
*/
|
|
5943
|
-
|
|
5944
|
-
|
|
5945
|
-
|
|
5946
|
-
|
|
5947
|
-
|
|
5785
|
+
getPreIpoCompanyNews(query: {
|
|
5786
|
+
/** company id */
|
|
5787
|
+
pre_ipo_company_id?: string;
|
|
5788
|
+
/** search by headline */
|
|
5789
|
+
headline?: string;
|
|
5790
|
+
/** how many records to return. Max value is 50 */
|
|
5791
|
+
limit: number;
|
|
5792
|
+
/** how many records to skip */
|
|
5793
|
+
offset: number;
|
|
5794
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyNewsResponse, HandleError>>;
|
|
5948
5795
|
/**
|
|
5949
|
-
* @description get
|
|
5950
|
-
* @tags
|
|
5951
|
-
* @name
|
|
5952
|
-
* @summary get
|
|
5953
|
-
* @request
|
|
5796
|
+
* @description get pre ipo company news by id
|
|
5797
|
+
* @tags PreIPOCompanies
|
|
5798
|
+
* @name GetPreIpoCompanyNewsById
|
|
5799
|
+
* @summary get pre ipo company news by id
|
|
5800
|
+
* @request GET:/ipos/pre-ipo-company-news/{id}
|
|
5801
|
+
* @originalName getPreIpoCompanyNews
|
|
5802
|
+
* @duplicate
|
|
5954
5803
|
* @secure
|
|
5955
5804
|
*/
|
|
5956
|
-
|
|
5957
|
-
}
|
|
5958
|
-
export class Passport<HandleError extends boolean = boolean> {
|
|
5959
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5960
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5805
|
+
getPreIpoCompanyNewsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyNews, HandleError>>;
|
|
5961
5806
|
/**
|
|
5962
|
-
* @description
|
|
5963
|
-
* @tags
|
|
5964
|
-
* @name
|
|
5965
|
-
* @summary
|
|
5966
|
-
* @request
|
|
5807
|
+
* @description get pre ipo company research documents
|
|
5808
|
+
* @tags PreIPOCompanies
|
|
5809
|
+
* @name GetPreIpoCompanyResearchDocuments
|
|
5810
|
+
* @summary get pre ipo company research documents
|
|
5811
|
+
* @request GET:/ipos/pre-ipo-company-research-documents
|
|
5967
5812
|
* @secure
|
|
5968
5813
|
*/
|
|
5969
|
-
|
|
5814
|
+
getPreIpoCompanyResearchDocuments(query: {
|
|
5815
|
+
/** company id */
|
|
5816
|
+
pre_ipo_company_id?: string;
|
|
5817
|
+
/** search by title */
|
|
5818
|
+
title?: string;
|
|
5819
|
+
/** how many records to return. Max value is 50 */
|
|
5820
|
+
limit: number;
|
|
5821
|
+
/** how many records to skip */
|
|
5822
|
+
offset: number;
|
|
5823
|
+
/** search by research type */
|
|
5824
|
+
research_type?: InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum;
|
|
5825
|
+
/** search by relation */
|
|
5826
|
+
relation?: InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum;
|
|
5827
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError>>;
|
|
5970
5828
|
/**
|
|
5971
|
-
* @description
|
|
5972
|
-
* @tags
|
|
5973
|
-
* @name
|
|
5974
|
-
* @summary
|
|
5975
|
-
* @request
|
|
5829
|
+
* @description get pre ipo company research document by id
|
|
5830
|
+
* @tags PreIPOCompanies
|
|
5831
|
+
* @name GetPreIpoCompanyResearchDocumentsById
|
|
5832
|
+
* @summary get pre ipo company research document by id
|
|
5833
|
+
* @request GET:/ipos/pre-ipo-company-research-documents/{id}
|
|
5834
|
+
* @originalName getPreIpoCompanyResearchDocuments
|
|
5835
|
+
* @duplicate
|
|
5976
5836
|
* @secure
|
|
5977
5837
|
*/
|
|
5978
|
-
|
|
5838
|
+
getPreIpoCompanyResearchDocumentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyResearchDocument, HandleError>>;
|
|
5979
5839
|
/**
|
|
5980
|
-
* @description
|
|
5981
|
-
* @tags
|
|
5982
|
-
* @name
|
|
5983
|
-
* @summary
|
|
5984
|
-
* @request
|
|
5840
|
+
* @description get pre ipo company spvs
|
|
5841
|
+
* @tags PreIPOCompanies
|
|
5842
|
+
* @name GetInvestor
|
|
5843
|
+
* @summary get pre ipo company spvs
|
|
5844
|
+
* @request GET:/ipos/pre-ipo-company-spv/investor/{investor_id}
|
|
5985
5845
|
* @secure
|
|
5986
5846
|
*/
|
|
5987
|
-
|
|
5847
|
+
getInvestor(investorId: string, query: {
|
|
5848
|
+
/** search by monark stage */
|
|
5849
|
+
monark_stage?: InsightGetInvestorParamsMonarkStageEnum;
|
|
5850
|
+
/** Optional param to filter returned spv's based on the exemptions claimed */
|
|
5851
|
+
exemptions_claimed?: string[];
|
|
5852
|
+
/** Optional param to filter returned spv's based on the name */
|
|
5853
|
+
name_filter?: string;
|
|
5854
|
+
/** investment id */
|
|
5855
|
+
pre_ipo_company_id?: string;
|
|
5856
|
+
/** investment id */
|
|
5857
|
+
pre_ipo_company_investment_id?: string;
|
|
5858
|
+
/** page number */
|
|
5859
|
+
page: number;
|
|
5860
|
+
/** page size */
|
|
5861
|
+
page_size: number;
|
|
5862
|
+
/** sort direction */
|
|
5863
|
+
sort_order?: InsightGetInvestorParamsSortOrderEnum;
|
|
5864
|
+
/** sort field */
|
|
5865
|
+
sort_by?: InsightGetInvestorParamsSortByEnum;
|
|
5866
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsWithInvestorIDResponse, HandleError>>;
|
|
5988
5867
|
/**
|
|
5989
|
-
* @description
|
|
5990
|
-
* @tags
|
|
5991
|
-
* @name
|
|
5992
|
-
* @summary
|
|
5993
|
-
* @request
|
|
5868
|
+
* @description get pre ipo company spv by id
|
|
5869
|
+
* @tags PreIPOCompanies
|
|
5870
|
+
* @name GetInvestorByIdAndInvestorId
|
|
5871
|
+
* @summary get pre ipo company spv by id
|
|
5872
|
+
* @request GET:/ipos/pre-ipo-company-spv/{id}/investor/{investor_id}
|
|
5873
|
+
* @originalName getInvestor
|
|
5874
|
+
* @duplicate
|
|
5994
5875
|
* @secure
|
|
5995
5876
|
*/
|
|
5996
|
-
|
|
5877
|
+
getInvestorByIdAndInvestorId(id: string, investorId: string, query?: {
|
|
5878
|
+
/** default is false, if true documents will be included in the response */
|
|
5879
|
+
include_documents?: boolean;
|
|
5880
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetProIPOCompabySPVWithInvestorIDResponse, HandleError>>;
|
|
5997
5881
|
/**
|
|
5998
|
-
* @description
|
|
5999
|
-
* @tags
|
|
6000
|
-
* @name
|
|
6001
|
-
* @summary
|
|
6002
|
-
* @request
|
|
5882
|
+
* @description get pre ipo company spvs
|
|
5883
|
+
* @tags PreIPOCompanies
|
|
5884
|
+
* @name GetPreIpoCompanySpvs
|
|
5885
|
+
* @summary get pre ipo company spvs
|
|
5886
|
+
* @request GET:/ipos/pre-ipo-company-spvs
|
|
6003
5887
|
* @secure
|
|
6004
5888
|
*/
|
|
6005
|
-
|
|
5889
|
+
getPreIpoCompanySpvs(query: {
|
|
5890
|
+
/** company id */
|
|
5891
|
+
pre_ipo_company_id?: string;
|
|
5892
|
+
/** investment id */
|
|
5893
|
+
investment_id?: string;
|
|
5894
|
+
/** search by name */
|
|
5895
|
+
name?: string;
|
|
5896
|
+
/** search by company name */
|
|
5897
|
+
company_name?: string;
|
|
5898
|
+
/** how many records to return. Max value is 50 */
|
|
5899
|
+
limit: number;
|
|
5900
|
+
/** how many records to skip */
|
|
5901
|
+
offset: number;
|
|
5902
|
+
/** search by monark stage */
|
|
5903
|
+
monark_stage?: InsightGetPreIpoCompanySpvsParamsMonarkStageEnum;
|
|
5904
|
+
/** sort direction */
|
|
5905
|
+
direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
|
|
5906
|
+
/** sort field */
|
|
5907
|
+
field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
|
|
5908
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
|
|
6006
5909
|
/**
|
|
6007
|
-
* @description
|
|
6008
|
-
* @tags
|
|
6009
|
-
* @name
|
|
6010
|
-
* @summary
|
|
6011
|
-
* @request
|
|
5910
|
+
* @description get pre ipo company spv by id
|
|
5911
|
+
* @tags PreIPOCompanies
|
|
5912
|
+
* @name GetPreIpoCompanySpvsById
|
|
5913
|
+
* @summary get pre ipo company spv by id
|
|
5914
|
+
* @request GET:/ipos/pre-ipo-company-spvs/{id}
|
|
5915
|
+
* @originalName getPreIpoCompanySpvs
|
|
5916
|
+
* @duplicate
|
|
6012
5917
|
* @secure
|
|
6013
5918
|
*/
|
|
6014
|
-
|
|
5919
|
+
getPreIpoCompanySpvsById(id: string, query?: {
|
|
5920
|
+
/** default is false, if true documents will be included in the response */
|
|
5921
|
+
include_documents?: boolean;
|
|
5922
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
|
|
6015
5923
|
}
|
|
6016
5924
|
export class Public<HandleError extends boolean = boolean> {
|
|
6017
5925
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -6059,85 +5967,242 @@ export class Public<HandleError extends boolean = boolean> {
|
|
|
6059
5967
|
mode: string;
|
|
6060
5968
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
6061
5969
|
/**
|
|
6062
|
-
* @description Daily price history
|
|
6063
|
-
* @tags Public
|
|
6064
|
-
* @name DailyPriceHistory
|
|
6065
|
-
* @summary Daily price history
|
|
6066
|
-
* @request GET:/public/price-history/daily
|
|
5970
|
+
* @description Daily price history
|
|
5971
|
+
* @tags Public
|
|
5972
|
+
* @name DailyPriceHistory
|
|
5973
|
+
* @summary Daily price history
|
|
5974
|
+
* @request GET:/public/price-history/daily
|
|
5975
|
+
* @secure
|
|
5976
|
+
*/
|
|
5977
|
+
dailyPriceHistory(query: {
|
|
5978
|
+
/** Single symbol */
|
|
5979
|
+
symbol: string;
|
|
5980
|
+
/** Target date */
|
|
5981
|
+
date: string;
|
|
5982
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
|
|
5983
|
+
/**
|
|
5984
|
+
* @description Public quote profile
|
|
5985
|
+
* @tags Public
|
|
5986
|
+
* @name PublicQuoteProfile
|
|
5987
|
+
* @summary Public quote profile
|
|
5988
|
+
* @request GET:/public/quote-profile/{symbol}
|
|
5989
|
+
* @secure
|
|
5990
|
+
*/
|
|
5991
|
+
publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
|
|
5992
|
+
/**
|
|
5993
|
+
* @description get ratios by symbol data
|
|
5994
|
+
* @tags Public
|
|
5995
|
+
* @name GetPublicRatiosBySymbolData
|
|
5996
|
+
* @summary get ratios by symbol data
|
|
5997
|
+
* @request GET:/public/ratios/{symbol}
|
|
5998
|
+
* @secure
|
|
5999
|
+
*/
|
|
6000
|
+
getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
|
|
6001
|
+
/**
|
|
6002
|
+
* @description find a symbol by name or description
|
|
6003
|
+
* @tags Public
|
|
6004
|
+
* @name QuoteFundamentalsSearch
|
|
6005
|
+
* @summary find a symbol by name or description
|
|
6006
|
+
* @request GET:/public/symbol-search
|
|
6007
|
+
* @secure
|
|
6008
|
+
*/
|
|
6009
|
+
quoteFundamentalsSearch(query: {
|
|
6010
|
+
/** Search query */
|
|
6011
|
+
search_query: string;
|
|
6012
|
+
/** how many records to return. Max value is 50 */
|
|
6013
|
+
limit: number;
|
|
6014
|
+
/** how many records to skip */
|
|
6015
|
+
offset: number;
|
|
6016
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
|
|
6017
|
+
/**
|
|
6018
|
+
* @description Get top gainers
|
|
6019
|
+
* @tags Public
|
|
6020
|
+
* @name TopGainers
|
|
6021
|
+
* @summary Top Gainers
|
|
6022
|
+
* @request GET:/public/top-gainers
|
|
6023
|
+
* @secure
|
|
6024
|
+
*/
|
|
6025
|
+
topGainers(query: {
|
|
6026
|
+
/** sort direction - asc or desc */
|
|
6027
|
+
order_direction?: string;
|
|
6028
|
+
/** how many records to return. Max value is 50 */
|
|
6029
|
+
limit: number;
|
|
6030
|
+
/** how many records to skip */
|
|
6031
|
+
offset: number;
|
|
6032
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6033
|
+
/**
|
|
6034
|
+
* @description Get top stocks
|
|
6035
|
+
* @tags Public
|
|
6036
|
+
* @name TopStocks
|
|
6037
|
+
* @summary Top Stocks
|
|
6038
|
+
* @request GET:/public/top-stocks
|
|
6039
|
+
* @secure
|
|
6040
|
+
*/
|
|
6041
|
+
topStocks(query: {
|
|
6042
|
+
/** EQUITY|ETF|CRYPTO */
|
|
6043
|
+
stock_type: InsightTopStocksParamsStockTypeEnum;
|
|
6044
|
+
/** how many records to return. Max value is 50 */
|
|
6045
|
+
limit: number;
|
|
6046
|
+
/** how many records to skip */
|
|
6047
|
+
offset: number;
|
|
6048
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6049
|
+
}
|
|
6050
|
+
export class Quotes<HandleError extends boolean = boolean> {
|
|
6051
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6052
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6053
|
+
/**
|
|
6054
|
+
* @description Get single historical quote
|
|
6055
|
+
* @tags Quotes
|
|
6056
|
+
* @name GitHistoricalQuote
|
|
6057
|
+
* @summary Get single historical quote
|
|
6058
|
+
* @request GET:/historical/quote
|
|
6059
|
+
* @secure
|
|
6060
|
+
*/
|
|
6061
|
+
gitHistoricalQuote(query: {
|
|
6062
|
+
/** Symbol */
|
|
6063
|
+
symbol: string;
|
|
6064
|
+
/** Date */
|
|
6065
|
+
date: string;
|
|
6066
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
|
|
6067
|
+
/**
|
|
6068
|
+
* @description get quote history by symbol
|
|
6069
|
+
* @tags Quotes
|
|
6070
|
+
* @name GitQuoteHistory
|
|
6071
|
+
* @summary Get quote history
|
|
6072
|
+
* @request POST:/quote-history
|
|
6073
|
+
* @secure
|
|
6074
|
+
*/
|
|
6075
|
+
gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
|
|
6076
|
+
/**
|
|
6077
|
+
* @description Returns a list of quotes equity info for specified symbols.
|
|
6078
|
+
* @tags Quotes
|
|
6079
|
+
* @name GetQuotesEquityData
|
|
6080
|
+
* @summary Get Quotes Equity data
|
|
6081
|
+
* @request GET:/quotes/equity
|
|
6082
|
+
* @secure
|
|
6083
|
+
*/
|
|
6084
|
+
getQuotesEquityData(query: {
|
|
6085
|
+
/** Comma separated symbols */
|
|
6086
|
+
symbols: string;
|
|
6087
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
|
|
6088
|
+
}
|
|
6089
|
+
export class StockScreener<HandleError extends boolean = boolean> {
|
|
6090
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6091
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6092
|
+
/**
|
|
6093
|
+
* @description data for visual heat map
|
|
6094
|
+
* @tags StockScreener
|
|
6095
|
+
* @name StockMarketHeatmap
|
|
6096
|
+
* @summary data for visual heat map
|
|
6097
|
+
* @request GET:/heatmaps
|
|
6098
|
+
* @secure
|
|
6099
|
+
*/
|
|
6100
|
+
stockMarketHeatmap(query?: {
|
|
6101
|
+
/** Name of symbol list to fetch details for. Empty is default */
|
|
6102
|
+
heatmap_name?: string;
|
|
6103
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
|
|
6104
|
+
/**
|
|
6105
|
+
* @description create or update heat map preset
|
|
6106
|
+
* @tags StockScreener
|
|
6107
|
+
* @name CreateStockMarketHeatmapPreset
|
|
6108
|
+
* @summary create or update heat map preset
|
|
6109
|
+
* @request POST:/heatmaps
|
|
6110
|
+
* @secure
|
|
6111
|
+
*/
|
|
6112
|
+
createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6113
|
+
/**
|
|
6114
|
+
* @description Sector and Industry Group performance
|
|
6115
|
+
* @tags StockScreener
|
|
6116
|
+
* @name IndustriesPerformance
|
|
6117
|
+
* @summary get industries performance
|
|
6118
|
+
* @request POST:/industries-performance
|
|
6119
|
+
* @secure
|
|
6120
|
+
*/
|
|
6121
|
+
industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
|
|
6122
|
+
/**
|
|
6123
|
+
* @description filter stocks by params
|
|
6124
|
+
* @tags StockScreener
|
|
6125
|
+
* @name StockScreener
|
|
6126
|
+
* @summary filter stocks by params
|
|
6127
|
+
* @request POST:/stock-screener
|
|
6128
|
+
* @secure
|
|
6129
|
+
*/
|
|
6130
|
+
stockScreener(filter: InsightStockScreenerV1Request, headers?: {
|
|
6131
|
+
/** Authorization */
|
|
6132
|
+
Authorization?: string;
|
|
6133
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
6134
|
+
/**
|
|
6135
|
+
* @description get screener presets
|
|
6136
|
+
* @tags StockScreener
|
|
6137
|
+
* @name GetScreenerPresets
|
|
6138
|
+
* @summary get screener presets
|
|
6139
|
+
* @request GET:/stock-screener/presets
|
|
6140
|
+
* @secure
|
|
6141
|
+
*/
|
|
6142
|
+
getScreenerPresets(query: {
|
|
6143
|
+
/** how many records to return */
|
|
6144
|
+
limit: number;
|
|
6145
|
+
/** how many records to skip */
|
|
6146
|
+
offset: number;
|
|
6147
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
6148
|
+
/**
|
|
6149
|
+
* @description update screener preset
|
|
6150
|
+
* @tags StockScreener
|
|
6151
|
+
* @name UpdateScreenerPreset
|
|
6152
|
+
* @summary update screener preset
|
|
6153
|
+
* @request PUT:/stock-screener/presets
|
|
6067
6154
|
* @secure
|
|
6068
6155
|
*/
|
|
6069
|
-
|
|
6070
|
-
/** Single symbol */
|
|
6071
|
-
symbol: string;
|
|
6072
|
-
/** Target date */
|
|
6073
|
-
date: string;
|
|
6074
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
|
|
6156
|
+
updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
6075
6157
|
/**
|
|
6076
|
-
* @description
|
|
6077
|
-
* @tags
|
|
6078
|
-
* @name
|
|
6079
|
-
* @summary
|
|
6080
|
-
* @request
|
|
6158
|
+
* @description create screener preset
|
|
6159
|
+
* @tags StockScreener
|
|
6160
|
+
* @name CreateOrScreenerPreset
|
|
6161
|
+
* @summary create screener preset
|
|
6162
|
+
* @request POST:/stock-screener/presets
|
|
6081
6163
|
* @secure
|
|
6082
6164
|
*/
|
|
6083
|
-
|
|
6165
|
+
createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
6084
6166
|
/**
|
|
6085
|
-
* @description
|
|
6086
|
-
* @tags
|
|
6087
|
-
* @name
|
|
6088
|
-
* @summary
|
|
6089
|
-
* @request
|
|
6167
|
+
* @description remove screener preset
|
|
6168
|
+
* @tags StockScreener
|
|
6169
|
+
* @name RemoveScreenerPreset
|
|
6170
|
+
* @summary remove screener preset
|
|
6171
|
+
* @request DELETE:/stock-screener/presets
|
|
6090
6172
|
* @secure
|
|
6091
6173
|
*/
|
|
6092
|
-
|
|
6174
|
+
removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6093
6175
|
/**
|
|
6094
|
-
* @description
|
|
6095
|
-
* @tags
|
|
6096
|
-
* @name
|
|
6097
|
-
* @summary
|
|
6098
|
-
* @request
|
|
6176
|
+
* @description get top symbols
|
|
6177
|
+
* @tags StockScreener
|
|
6178
|
+
* @name GetTopSymbols
|
|
6179
|
+
* @summary get top symbols
|
|
6180
|
+
* @request POST:/stock-screener/top
|
|
6099
6181
|
* @secure
|
|
6100
6182
|
*/
|
|
6101
|
-
|
|
6102
|
-
|
|
6103
|
-
|
|
6104
|
-
|
|
6105
|
-
|
|
6106
|
-
/** how many records to skip */
|
|
6107
|
-
offset: number;
|
|
6108
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
|
|
6183
|
+
getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
6184
|
+
}
|
|
6185
|
+
export class StockScreenerV2<HandleError extends boolean = boolean> {
|
|
6186
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6187
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6109
6188
|
/**
|
|
6110
|
-
* @description
|
|
6111
|
-
* @tags
|
|
6112
|
-
* @name
|
|
6113
|
-
* @summary
|
|
6114
|
-
* @request
|
|
6189
|
+
* @description filter stocks by params
|
|
6190
|
+
* @tags StockScreener
|
|
6191
|
+
* @name StockScreener
|
|
6192
|
+
* @summary filter stocks by params
|
|
6193
|
+
* @request POST:/stock-screener
|
|
6115
6194
|
* @secure
|
|
6116
6195
|
*/
|
|
6117
|
-
|
|
6118
|
-
/** sort direction - asc or desc */
|
|
6119
|
-
order_direction?: string;
|
|
6120
|
-
/** how many records to return. Max value is 50 */
|
|
6121
|
-
limit: number;
|
|
6122
|
-
/** how many records to skip */
|
|
6123
|
-
offset: number;
|
|
6124
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6196
|
+
stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
6125
6197
|
/**
|
|
6126
|
-
* @description
|
|
6127
|
-
* @tags
|
|
6128
|
-
* @name
|
|
6129
|
-
* @summary
|
|
6130
|
-
* @request
|
|
6198
|
+
* @description get top symbols
|
|
6199
|
+
* @tags StockScreener
|
|
6200
|
+
* @name GetTopSymbols
|
|
6201
|
+
* @summary get top symbols
|
|
6202
|
+
* @request POST:/stock-screener/top
|
|
6131
6203
|
* @secure
|
|
6132
6204
|
*/
|
|
6133
|
-
|
|
6134
|
-
/** EQUITY|ETF|CRYPTO */
|
|
6135
|
-
stock_type: InsightTopStocksParamsStockTypeEnum;
|
|
6136
|
-
/** how many records to return. Max value is 50 */
|
|
6137
|
-
limit: number;
|
|
6138
|
-
/** how many records to skip */
|
|
6139
|
-
offset: number;
|
|
6140
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6205
|
+
getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
6141
6206
|
}
|
|
6142
6207
|
export class TipRank<HandleError extends boolean = boolean> {
|
|
6143
6208
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -6505,265 +6570,200 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6505
6570
|
Authorization?: string;
|
|
6506
6571
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
|
|
6507
6572
|
}
|
|
6508
|
-
export
|
|
6509
|
-
|
|
6510
|
-
|
|
6511
|
-
|
|
6512
|
-
|
|
6513
|
-
|
|
6514
|
-
|
|
6515
|
-
|
|
6516
|
-
|
|
6517
|
-
|
|
6518
|
-
|
|
6519
|
-
|
|
6520
|
-
close_price_asof: string;
|
|
6521
|
-
close_ytw: number;
|
|
6522
|
-
convertible: boolean;
|
|
6523
|
-
country: string;
|
|
6524
|
-
country_code: string;
|
|
6525
|
-
country_domicile: string;
|
|
6526
|
-
country_issue: string;
|
|
6527
|
-
coupon: number;
|
|
6528
|
-
coupon_frequency: string;
|
|
6529
|
-
coupon_type: string;
|
|
6530
|
-
currency: string;
|
|
6531
|
-
cusip: string;
|
|
6532
|
-
dated_date: string;
|
|
6533
|
-
daycount: string;
|
|
6534
|
-
description: string;
|
|
6535
|
-
description_short: string;
|
|
6536
|
-
duration: number;
|
|
6537
|
-
first_coupon_date: string;
|
|
6538
|
-
insured: boolean;
|
|
6539
|
-
isin: string;
|
|
6540
|
-
issue_date: string;
|
|
6541
|
-
issue_minimum_denomination: number;
|
|
6542
|
-
issue_price: number;
|
|
6543
|
-
issue_size: number;
|
|
6544
|
-
issuer: string;
|
|
6545
|
-
last_coupon_date: string;
|
|
6546
|
-
liquidity_institutional_aggregate: number;
|
|
6547
|
-
liquidity_institutional_buy: number;
|
|
6548
|
-
liquidity_institutional_sell: number;
|
|
6549
|
-
liquidity_micro_aggregate: number;
|
|
6550
|
-
liquidity_micro_buy: number;
|
|
6551
|
-
liquidity_micro_sell: number;
|
|
6552
|
-
liquidity_retail_aggregate: number;
|
|
6553
|
-
liquidity_retail_buy: number;
|
|
6554
|
-
liquidity_retail_sell: number;
|
|
6555
|
-
maturity_date: string;
|
|
6556
|
-
municipal_state: string;
|
|
6557
|
-
municipal_taxable_federal: boolean;
|
|
6558
|
-
municipal_type: string;
|
|
6559
|
-
next_call_date: string;
|
|
6560
|
-
next_call_price: number;
|
|
6561
|
-
next_coupon_date: string;
|
|
6562
|
-
par_value: number;
|
|
6563
|
-
perpetual: boolean;
|
|
6564
|
-
private_placement: boolean;
|
|
6565
|
-
purpose: string;
|
|
6566
|
-
puttable: boolean;
|
|
6567
|
-
reg_s: boolean;
|
|
6568
|
-
sector: string;
|
|
6569
|
-
seniority: string;
|
|
6570
|
-
settlement_convention: string;
|
|
6571
|
-
sinking_fund: boolean;
|
|
6572
|
-
sp_creditwatch: string;
|
|
6573
|
-
sp_creditwatch_date: string;
|
|
6574
|
-
sp_outlook: string;
|
|
6575
|
-
sp_outlook_date: string;
|
|
6576
|
-
sp_rating: string;
|
|
6577
|
-
sp_rating_date: string;
|
|
6578
|
-
status: string;
|
|
6579
|
-
ticker: string;
|
|
6580
|
-
treasury_subtype: string;
|
|
6581
|
-
type: string;
|
|
6582
|
-
updated_at: string;
|
|
6583
|
-
}
|
|
6584
|
-
export interface InsightGetFixedIncomeEntriesResponseV2 {
|
|
6585
|
-
count: number;
|
|
6586
|
-
data: InsightFixedIncomeV2[];
|
|
6573
|
+
export class UsageTracking<HandleError extends boolean = boolean> {
|
|
6574
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6575
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6576
|
+
/**
|
|
6577
|
+
* @description get usage date per branch for a period
|
|
6578
|
+
* @tags UsageTracking
|
|
6579
|
+
* @name GetUsageData
|
|
6580
|
+
* @summary get insight usage data
|
|
6581
|
+
* @request POST:/tracking/usage
|
|
6582
|
+
* @secure
|
|
6583
|
+
*/
|
|
6584
|
+
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
|
|
6587
6585
|
}
|
|
6588
|
-
export
|
|
6589
|
-
|
|
6590
|
-
|
|
6591
|
-
/**
|
|
6592
|
-
|
|
6593
|
-
|
|
6594
|
-
|
|
6595
|
-
|
|
6596
|
-
|
|
6597
|
-
|
|
6598
|
-
|
|
6599
|
-
|
|
6600
|
-
|
|
6601
|
-
|
|
6586
|
+
export class WorldMarkets<HandleError extends boolean = boolean> {
|
|
6587
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6588
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6589
|
+
/**
|
|
6590
|
+
* @description Get continents
|
|
6591
|
+
* @tags World Markets
|
|
6592
|
+
* @name ContinentGet
|
|
6593
|
+
* @summary Get continents
|
|
6594
|
+
* @request GET:/continents
|
|
6595
|
+
* @secure
|
|
6596
|
+
*/
|
|
6597
|
+
continentGet(query: {
|
|
6598
|
+
/** Query limit */
|
|
6599
|
+
limit: number;
|
|
6600
|
+
/** Query offset */
|
|
6601
|
+
offset: number;
|
|
6602
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
6603
|
+
/**
|
|
6604
|
+
* @description Edit continent
|
|
6605
|
+
* @tags World Markets
|
|
6606
|
+
* @name ContinentEdit
|
|
6607
|
+
* @summary Edit continent
|
|
6608
|
+
* @request PUT:/continents
|
|
6609
|
+
* @secure
|
|
6610
|
+
*/
|
|
6611
|
+
continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6612
|
+
/**
|
|
6613
|
+
* @description Create continents
|
|
6614
|
+
* @tags World Markets
|
|
6615
|
+
* @name ContinentCreate
|
|
6616
|
+
* @summary Create continents
|
|
6617
|
+
* @request POST:/continents
|
|
6618
|
+
* @secure
|
|
6619
|
+
*/
|
|
6620
|
+
continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
6621
|
+
/**
|
|
6622
|
+
* @description Delete continent
|
|
6623
|
+
* @tags World Markets
|
|
6624
|
+
* @name ContinentDelete
|
|
6625
|
+
* @summary Delete continent
|
|
6626
|
+
* @request DELETE:/continents
|
|
6627
|
+
* @secure
|
|
6628
|
+
*/
|
|
6629
|
+
continentDelete(query: {
|
|
6630
|
+
/** continent id */
|
|
6631
|
+
id: string;
|
|
6632
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6633
|
+
/**
|
|
6634
|
+
* @description Get country codes
|
|
6635
|
+
* @tags World Markets
|
|
6636
|
+
* @name CountryCodeGet
|
|
6637
|
+
* @summary Get country codes
|
|
6638
|
+
* @request GET:/country-codes
|
|
6639
|
+
* @secure
|
|
6640
|
+
*/
|
|
6641
|
+
countryCodeGet(query: {
|
|
6642
|
+
/** Query limit */
|
|
6643
|
+
limit: number;
|
|
6644
|
+
/** Query offset */
|
|
6645
|
+
offset: number;
|
|
6646
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
6602
6647
|
/**
|
|
6603
|
-
* @
|
|
6604
|
-
* @
|
|
6648
|
+
* @description Edit country code
|
|
6649
|
+
* @tags World Markets
|
|
6650
|
+
* @name CountryCodeEdit
|
|
6651
|
+
* @summary Edit country code
|
|
6652
|
+
* @request PUT:/country-codes
|
|
6653
|
+
* @secure
|
|
6605
6654
|
*/
|
|
6606
|
-
|
|
6607
|
-
/** @example true */
|
|
6608
|
-
has_ticker?: boolean;
|
|
6609
|
-
/** @example true */
|
|
6610
|
-
insured?: boolean;
|
|
6611
|
-
/** @example ["US655664AH33","US9128286R69"] */
|
|
6612
|
-
isin?: string[];
|
|
6613
|
-
issue_date?: InsightBeforeAndAfterV2;
|
|
6655
|
+
countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6614
6656
|
/**
|
|
6615
|
-
* @
|
|
6616
|
-
* @
|
|
6657
|
+
* @description Add country codes
|
|
6658
|
+
* @tags World Markets
|
|
6659
|
+
* @name CountryCodeAdd
|
|
6660
|
+
* @summary Add country codes
|
|
6661
|
+
* @request POST:/country-codes
|
|
6662
|
+
* @secure
|
|
6617
6663
|
*/
|
|
6618
|
-
|
|
6619
|
-
maturity?: InsightBeforeAndAfterV2;
|
|
6620
|
-
/** @example ["NY"] */
|
|
6621
|
-
municipal_states?: string[];
|
|
6622
|
-
/** @example true */
|
|
6623
|
-
municipal_tax?: boolean;
|
|
6624
|
-
/** @example ["general_obligation"] */
|
|
6625
|
-
municipal_types?: string[];
|
|
6626
|
-
pagination: InsightPaginationV2;
|
|
6627
|
-
purposes?: string[];
|
|
6628
|
-
/** @example ["SOVEREIGN"] */
|
|
6629
|
-
sectors?: string[];
|
|
6630
|
-
sorts?: InsightOrderingV2[];
|
|
6631
|
-
/** @example ["AAA"] */
|
|
6632
|
-
sp_ratings?: string[];
|
|
6633
|
-
/** @example ["called","outstanding"] */
|
|
6634
|
-
statuses?: string[];
|
|
6635
|
-
tickers?: string[];
|
|
6636
|
-
/** @example ["corporate"] */
|
|
6637
|
-
types?: string[];
|
|
6638
|
-
}
|
|
6639
|
-
export interface InsightGetTopSymbolsRequestV2 {
|
|
6640
|
-
exchange?: string[];
|
|
6641
|
-
market_cap?: InsightLessAndMoreV2;
|
|
6642
|
-
pagination?: InsightPaginationV2;
|
|
6643
|
-
price?: InsightLessAndMoreV2;
|
|
6644
|
-
sorts?: InsightOrderingV2[];
|
|
6645
|
-
volume?: InsightLessAndMoreV2;
|
|
6646
|
-
}
|
|
6647
|
-
export interface InsightIncludeExcludeV2 {
|
|
6648
|
-
exclude?: string[];
|
|
6649
|
-
include?: string[];
|
|
6650
|
-
}
|
|
6651
|
-
export interface InsightLessAndMoreV2 {
|
|
6652
|
-
less_than?: number;
|
|
6653
|
-
more_than?: number;
|
|
6654
|
-
}
|
|
6655
|
-
export interface InsightOrderingV2 {
|
|
6664
|
+
countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
6656
6665
|
/**
|
|
6657
|
-
* @
|
|
6658
|
-
* @
|
|
6666
|
+
* @description Delete country code
|
|
6667
|
+
* @tags World Markets
|
|
6668
|
+
* @name CountryCodeDelete
|
|
6669
|
+
* @summary Delete country code
|
|
6670
|
+
* @request DELETE:/country-codes
|
|
6671
|
+
* @secure
|
|
6659
6672
|
*/
|
|
6660
|
-
|
|
6673
|
+
countryCodeDelete(query: {
|
|
6674
|
+
/** a3 code */
|
|
6675
|
+
a3code: string;
|
|
6676
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6661
6677
|
/**
|
|
6662
|
-
*
|
|
6663
|
-
*
|
|
6664
|
-
*
|
|
6665
|
-
* @
|
|
6678
|
+
* @description Get global indexes
|
|
6679
|
+
* @tags World Markets
|
|
6680
|
+
* @name GlobalIndexGet
|
|
6681
|
+
* @summary Get global indexes
|
|
6682
|
+
* @request GET:/global-indexes
|
|
6683
|
+
* @secure
|
|
6666
6684
|
*/
|
|
6667
|
-
|
|
6668
|
-
|
|
6669
|
-
|
|
6685
|
+
globalIndexGet(query: {
|
|
6686
|
+
/** Query limit */
|
|
6687
|
+
limit: number;
|
|
6688
|
+
/** Query offset */
|
|
6689
|
+
offset: number;
|
|
6690
|
+
/** Continent code for filtering */
|
|
6691
|
+
continent?: string;
|
|
6692
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
6670
6693
|
/**
|
|
6671
|
-
* @
|
|
6672
|
-
* @
|
|
6694
|
+
* @description Edit global index
|
|
6695
|
+
* @tags World Markets
|
|
6696
|
+
* @name GlobalIndexEdit
|
|
6697
|
+
* @summary Edit global index
|
|
6698
|
+
* @request PUT:/global-indexes
|
|
6699
|
+
* @secure
|
|
6673
6700
|
*/
|
|
6674
|
-
|
|
6701
|
+
globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6675
6702
|
/**
|
|
6676
|
-
* @
|
|
6677
|
-
* @
|
|
6678
|
-
* @
|
|
6703
|
+
* @description Add global indexes
|
|
6704
|
+
* @tags World Markets
|
|
6705
|
+
* @name GlobalIndexAdd
|
|
6706
|
+
* @summary Add global indexes
|
|
6707
|
+
* @request POST:/global-indexes
|
|
6708
|
+
* @secure
|
|
6679
6709
|
*/
|
|
6680
|
-
|
|
6681
|
-
}
|
|
6682
|
-
export interface InsightStockScreenerQuoteV2 {
|
|
6683
|
-
average_volume_30d: number;
|
|
6684
|
-
company_name: string;
|
|
6685
|
-
dividend_ex_date: string;
|
|
6686
|
-
dividend_pay_date: string;
|
|
6687
|
-
dividend_percent: number;
|
|
6688
|
-
exchange: string;
|
|
6689
|
-
exchange_name: string;
|
|
6690
|
-
gap: number;
|
|
6691
|
-
industry: string;
|
|
6692
|
-
industry_code: string;
|
|
6693
|
-
last_price: number;
|
|
6694
|
-
market_cap: number;
|
|
6695
|
-
pe_ratio: number;
|
|
6696
|
-
price_change: number;
|
|
6697
|
-
price_change_percent: number;
|
|
6698
|
-
symbol: string;
|
|
6699
|
-
volume: number;
|
|
6700
|
-
}
|
|
6701
|
-
export interface InsightStockScreenerRequestV2 {
|
|
6702
|
-
average_volume_30d?: InsightLessAndMoreV2;
|
|
6703
|
-
dividend_ex_date?: InsightBeforeAndAfterV2;
|
|
6704
|
-
dividend_pay_date?: InsightBeforeAndAfterV2;
|
|
6705
|
-
dividend_percent?: InsightLessAndMoreV2;
|
|
6706
|
-
exchange?: InsightIncludeExcludeV2;
|
|
6707
|
-
gap?: InsightLessAndMoreV2;
|
|
6708
|
-
industry?: InsightIncludeExcludeV2;
|
|
6709
|
-
market_cap?: InsightLessAndMoreV2;
|
|
6710
|
-
pagination: InsightPaginationV2;
|
|
6711
|
-
pe_ratio?: InsightLessAndMoreV2;
|
|
6712
|
-
price?: InsightLessAndMoreV2;
|
|
6713
|
-
sorts?: InsightOrderingV2[];
|
|
6714
|
-
/** @example "ADR" */
|
|
6715
|
-
stock_type?: string;
|
|
6716
|
-
volume?: InsightLessAndMoreV2;
|
|
6717
|
-
}
|
|
6718
|
-
export interface InsightStockScreenerResponseV2 {
|
|
6719
|
-
current_page: number;
|
|
6720
|
-
data: InsightStockScreenerQuoteV2[];
|
|
6721
|
-
page_count: number;
|
|
6722
|
-
status: number;
|
|
6723
|
-
total_records: number;
|
|
6724
|
-
}
|
|
6725
|
-
/**
|
|
6726
|
-
* @default "asc"
|
|
6727
|
-
* @example "asc"
|
|
6728
|
-
*/
|
|
6729
|
-
export enum InsightOrderingDirectionEnumV2 {
|
|
6730
|
-
Asc = "asc",
|
|
6731
|
-
Desc = "desc"
|
|
6732
|
-
}
|
|
6733
|
-
export class FixedIncomeV2<HandleError extends boolean = boolean> {
|
|
6734
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6735
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6710
|
+
globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
6736
6711
|
/**
|
|
6737
|
-
* @description
|
|
6738
|
-
* @tags
|
|
6739
|
-
* @name
|
|
6740
|
-
* @summary
|
|
6741
|
-
* @request
|
|
6712
|
+
* @description Edit global index
|
|
6713
|
+
* @tags World Markets
|
|
6714
|
+
* @name GlobalIndexDelete
|
|
6715
|
+
* @summary Delete global index
|
|
6716
|
+
* @request DELETE:/global-indexes
|
|
6742
6717
|
* @secure
|
|
6743
6718
|
*/
|
|
6744
|
-
|
|
6745
|
-
|
|
6746
|
-
|
|
6747
|
-
|
|
6748
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6719
|
+
globalIndexDelete(query: {
|
|
6720
|
+
/** a3 code */
|
|
6721
|
+
a3code: string;
|
|
6722
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6749
6723
|
/**
|
|
6750
|
-
* @description
|
|
6751
|
-
* @tags
|
|
6752
|
-
* @name
|
|
6753
|
-
* @summary
|
|
6754
|
-
* @request
|
|
6724
|
+
* @description Get regions
|
|
6725
|
+
* @tags World Markets
|
|
6726
|
+
* @name RegionGet
|
|
6727
|
+
* @summary Get regions
|
|
6728
|
+
* @request GET:/regions
|
|
6755
6729
|
* @secure
|
|
6756
6730
|
*/
|
|
6757
|
-
|
|
6731
|
+
regionGet(query: {
|
|
6732
|
+
/** Query limit */
|
|
6733
|
+
limit: number;
|
|
6734
|
+
/** Query offset */
|
|
6735
|
+
offset: number;
|
|
6736
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
6758
6737
|
/**
|
|
6759
|
-
* @description
|
|
6760
|
-
* @tags
|
|
6761
|
-
* @name
|
|
6762
|
-
* @summary
|
|
6763
|
-
* @request
|
|
6738
|
+
* @description Edit region
|
|
6739
|
+
* @tags World Markets
|
|
6740
|
+
* @name RegionEdit
|
|
6741
|
+
* @summary Edit region
|
|
6742
|
+
* @request PUT:/regions
|
|
6764
6743
|
* @secure
|
|
6765
6744
|
*/
|
|
6766
|
-
|
|
6745
|
+
regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6746
|
+
/**
|
|
6747
|
+
* @description Create regions
|
|
6748
|
+
* @tags World Markets
|
|
6749
|
+
* @name RegionCreate
|
|
6750
|
+
* @summary Create regions
|
|
6751
|
+
* @request POST:/regions
|
|
6752
|
+
* @secure
|
|
6753
|
+
*/
|
|
6754
|
+
regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
6755
|
+
/**
|
|
6756
|
+
* @description Delete region
|
|
6757
|
+
* @tags World Markets
|
|
6758
|
+
* @name RegionDelete
|
|
6759
|
+
* @summary Delete region
|
|
6760
|
+
* @request DELETE:/regions
|
|
6761
|
+
* @secure
|
|
6762
|
+
*/
|
|
6763
|
+
regionDelete(query: {
|
|
6764
|
+
/** region id */
|
|
6765
|
+
id: string;
|
|
6766
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6767
6767
|
}
|
|
6768
6768
|
export class InsightApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
6769
6769
|
readonly config: JwtClientConfig<HandleError>;
|