@orbis-systems/orbis-api-clients 0.7.16 → 0.7.18
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 +68 -68
- 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 +884 -884
- 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 +1287 -1227
- 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 +99 -99
- 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 +3864 -3864
- 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 +618 -618
- 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/package.json +4 -13
- package/dist/zerohash/index.d.ts +0 -15498
- package/dist/zerohash/index.d.ts.map +0 -1
- package/dist/zerohash/index.esm.js +0 -2
- package/dist/zerohash/index.esm.js.map +0 -1
- package/dist/zerohash/index.js +0 -2
- package/dist/zerohash/index.js.map +0 -1
package/dist/insight/index.d.ts
CHANGED
|
@@ -3214,6 +3214,7 @@ export interface InsightMarketScheduleEntry {
|
|
|
3214
3214
|
}
|
|
3215
3215
|
export interface InsightMarketWithSchedule {
|
|
3216
3216
|
market: InsightMarket;
|
|
3217
|
+
open_right_now: boolean;
|
|
3217
3218
|
schedule: InsightWeeklyMarketSchedule;
|
|
3218
3219
|
}
|
|
3219
3220
|
export interface InsightMatrixData {
|
|
@@ -3869,6 +3870,11 @@ export interface InsightSearchArticleRequest {
|
|
|
3869
3870
|
/** @example "all" */
|
|
3870
3871
|
type: InsightArticleSearchType;
|
|
3871
3872
|
}
|
|
3873
|
+
export interface InsightSearchLocodeDataResponse {
|
|
3874
|
+
countries: InsightCountryEntry[];
|
|
3875
|
+
currencies: InsightCurrencyEntry[];
|
|
3876
|
+
timezones: InsightTimezoneEntry[];
|
|
3877
|
+
}
|
|
3872
3878
|
export interface InsightSeasonalityEntry {
|
|
3873
3879
|
april: InsightTickerSeasonality;
|
|
3874
3880
|
august: InsightTickerSeasonality;
|
|
@@ -4141,6 +4147,7 @@ export interface InsightTagShortInfo {
|
|
|
4141
4147
|
}
|
|
4142
4148
|
export interface InsightTickerData {
|
|
4143
4149
|
historic_volatility: number;
|
|
4150
|
+
risk_free_rate: number;
|
|
4144
4151
|
ticker: string;
|
|
4145
4152
|
}
|
|
4146
4153
|
export interface InsightTickerSeasonality {
|
|
@@ -4405,6 +4412,22 @@ export interface InsightYearlyPerformance {
|
|
|
4405
4412
|
performance: number;
|
|
4406
4413
|
year: number;
|
|
4407
4414
|
}
|
|
4415
|
+
export interface InsightCountryEntry {
|
|
4416
|
+
a2code: string;
|
|
4417
|
+
a3code: string;
|
|
4418
|
+
country: string;
|
|
4419
|
+
}
|
|
4420
|
+
export interface InsightCurrencyEntry {
|
|
4421
|
+
code: string;
|
|
4422
|
+
country: string;
|
|
4423
|
+
currency: string;
|
|
4424
|
+
}
|
|
4425
|
+
export interface InsightTimezoneEntry {
|
|
4426
|
+
label: string;
|
|
4427
|
+
name: string;
|
|
4428
|
+
tz_code: string;
|
|
4429
|
+
utc: string;
|
|
4430
|
+
}
|
|
4408
4431
|
export interface InsightEquityDataResponse {
|
|
4409
4432
|
ask_px: number;
|
|
4410
4433
|
ask_sz: number;
|
|
@@ -4607,6 +4630,11 @@ export enum InsightSymbolLogoConvertedRequestConversionEnum {
|
|
|
4607
4630
|
SquareStrictOrNormal = "square_strict_or_normal",
|
|
4608
4631
|
BestMatch = "best_match"
|
|
4609
4632
|
}
|
|
4633
|
+
/** filter by active status */
|
|
4634
|
+
export enum InsightGetPreIpoCompaniesParamsIsActiveEnum {
|
|
4635
|
+
True = "true",
|
|
4636
|
+
False = "false"
|
|
4637
|
+
}
|
|
4610
4638
|
/** sort field */
|
|
4611
4639
|
export enum InsightGetPreIpoCompaniesParamsOrderFieldEnum {
|
|
4612
4640
|
Id = "id",
|
|
@@ -4700,6 +4728,12 @@ export enum InsightGetPreIpoCompanySpvsParamsFieldEnum {
|
|
|
4700
4728
|
Valuation = "valuation",
|
|
4701
4729
|
MinCommitmentAmount = "min_commitment_amount"
|
|
4702
4730
|
}
|
|
4731
|
+
/** Search field */
|
|
4732
|
+
export enum InsightSearchLocodeDataParamsFieldEnum {
|
|
4733
|
+
CountryName = "country.name",
|
|
4734
|
+
CurrencyCountry = "currency.country",
|
|
4735
|
+
TimezoneLabel = "timezone.label"
|
|
4736
|
+
}
|
|
4703
4737
|
/** EQUITY|ETF|CRYPTO */
|
|
4704
4738
|
export enum InsightTopStocksParamsStockTypeEnum {
|
|
4705
4739
|
EQUITY = "EQUITY",
|
|
@@ -4728,6 +4762,28 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
|
|
|
4728
4762
|
Date = "date",
|
|
4729
4763
|
Rank = "rank"
|
|
4730
4764
|
}
|
|
4765
|
+
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
4766
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4767
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4768
|
+
/**
|
|
4769
|
+
* @description get seasonlity data with comparison to benchmark
|
|
4770
|
+
* @tags AlphaTools
|
|
4771
|
+
* @name GetMomentumRatioGraph
|
|
4772
|
+
* @summary get seasonlity data
|
|
4773
|
+
* @request POST:/rst
|
|
4774
|
+
* @secure
|
|
4775
|
+
*/
|
|
4776
|
+
getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
|
|
4777
|
+
/**
|
|
4778
|
+
* @description get seasonlity data with comparison to benchmark
|
|
4779
|
+
* @tags AlphaTools
|
|
4780
|
+
* @name GetSeasonality
|
|
4781
|
+
* @summary get seasonlity data
|
|
4782
|
+
* @request POST:/seasonality
|
|
4783
|
+
* @secure
|
|
4784
|
+
*/
|
|
4785
|
+
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
|
|
4786
|
+
}
|
|
4731
4787
|
export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
4732
4788
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4733
4789
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4767,188 +4823,6 @@ export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
|
4767
4823
|
*/
|
|
4768
4824
|
getSymbolsPerSymbolType(input: InsightGetSymbolsPerTypeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolsPerTypeResponse, HandleError>>;
|
|
4769
4825
|
}
|
|
4770
|
-
export class WorldMarkets<HandleError extends boolean = boolean> {
|
|
4771
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
4772
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
4773
|
-
/**
|
|
4774
|
-
* @description Get continents
|
|
4775
|
-
* @tags World Markets
|
|
4776
|
-
* @name ContinentGet
|
|
4777
|
-
* @summary Get continents
|
|
4778
|
-
* @request GET:/continents
|
|
4779
|
-
* @secure
|
|
4780
|
-
*/
|
|
4781
|
-
continentGet(query: {
|
|
4782
|
-
/** Query limit */
|
|
4783
|
-
limit: number;
|
|
4784
|
-
/** Query offset */
|
|
4785
|
-
offset: number;
|
|
4786
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
4787
|
-
/**
|
|
4788
|
-
* @description Edit continent
|
|
4789
|
-
* @tags World Markets
|
|
4790
|
-
* @name ContinentEdit
|
|
4791
|
-
* @summary Edit continent
|
|
4792
|
-
* @request PUT:/continents
|
|
4793
|
-
* @secure
|
|
4794
|
-
*/
|
|
4795
|
-
continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4796
|
-
/**
|
|
4797
|
-
* @description Create continents
|
|
4798
|
-
* @tags World Markets
|
|
4799
|
-
* @name ContinentCreate
|
|
4800
|
-
* @summary Create continents
|
|
4801
|
-
* @request POST:/continents
|
|
4802
|
-
* @secure
|
|
4803
|
-
*/
|
|
4804
|
-
continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
4805
|
-
/**
|
|
4806
|
-
* @description Delete continent
|
|
4807
|
-
* @tags World Markets
|
|
4808
|
-
* @name ContinentDelete
|
|
4809
|
-
* @summary Delete continent
|
|
4810
|
-
* @request DELETE:/continents
|
|
4811
|
-
* @secure
|
|
4812
|
-
*/
|
|
4813
|
-
continentDelete(query: {
|
|
4814
|
-
/** continent id */
|
|
4815
|
-
id: string;
|
|
4816
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4817
|
-
/**
|
|
4818
|
-
* @description Get country codes
|
|
4819
|
-
* @tags World Markets
|
|
4820
|
-
* @name CountryCodeGet
|
|
4821
|
-
* @summary Get country codes
|
|
4822
|
-
* @request GET:/country-codes
|
|
4823
|
-
* @secure
|
|
4824
|
-
*/
|
|
4825
|
-
countryCodeGet(query: {
|
|
4826
|
-
/** Query limit */
|
|
4827
|
-
limit: number;
|
|
4828
|
-
/** Query offset */
|
|
4829
|
-
offset: number;
|
|
4830
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
4831
|
-
/**
|
|
4832
|
-
* @description Edit country code
|
|
4833
|
-
* @tags World Markets
|
|
4834
|
-
* @name CountryCodeEdit
|
|
4835
|
-
* @summary Edit country code
|
|
4836
|
-
* @request PUT:/country-codes
|
|
4837
|
-
* @secure
|
|
4838
|
-
*/
|
|
4839
|
-
countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4840
|
-
/**
|
|
4841
|
-
* @description Add country codes
|
|
4842
|
-
* @tags World Markets
|
|
4843
|
-
* @name CountryCodeAdd
|
|
4844
|
-
* @summary Add country codes
|
|
4845
|
-
* @request POST:/country-codes
|
|
4846
|
-
* @secure
|
|
4847
|
-
*/
|
|
4848
|
-
countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
4849
|
-
/**
|
|
4850
|
-
* @description Delete country code
|
|
4851
|
-
* @tags World Markets
|
|
4852
|
-
* @name CountryCodeDelete
|
|
4853
|
-
* @summary Delete country code
|
|
4854
|
-
* @request DELETE:/country-codes
|
|
4855
|
-
* @secure
|
|
4856
|
-
*/
|
|
4857
|
-
countryCodeDelete(query: {
|
|
4858
|
-
/** a3 code */
|
|
4859
|
-
a3code: string;
|
|
4860
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4861
|
-
/**
|
|
4862
|
-
* @description Get global indexes
|
|
4863
|
-
* @tags World Markets
|
|
4864
|
-
* @name GlobalIndexGet
|
|
4865
|
-
* @summary Get global indexes
|
|
4866
|
-
* @request GET:/global-indexes
|
|
4867
|
-
* @secure
|
|
4868
|
-
*/
|
|
4869
|
-
globalIndexGet(query: {
|
|
4870
|
-
/** Query limit */
|
|
4871
|
-
limit: number;
|
|
4872
|
-
/** Query offset */
|
|
4873
|
-
offset: number;
|
|
4874
|
-
/** Continent code for filtering */
|
|
4875
|
-
continent?: string;
|
|
4876
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
4877
|
-
/**
|
|
4878
|
-
* @description Edit global index
|
|
4879
|
-
* @tags World Markets
|
|
4880
|
-
* @name GlobalIndexEdit
|
|
4881
|
-
* @summary Edit global index
|
|
4882
|
-
* @request PUT:/global-indexes
|
|
4883
|
-
* @secure
|
|
4884
|
-
*/
|
|
4885
|
-
globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4886
|
-
/**
|
|
4887
|
-
* @description Add global indexes
|
|
4888
|
-
* @tags World Markets
|
|
4889
|
-
* @name GlobalIndexAdd
|
|
4890
|
-
* @summary Add global indexes
|
|
4891
|
-
* @request POST:/global-indexes
|
|
4892
|
-
* @secure
|
|
4893
|
-
*/
|
|
4894
|
-
globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
4895
|
-
/**
|
|
4896
|
-
* @description Edit global index
|
|
4897
|
-
* @tags World Markets
|
|
4898
|
-
* @name GlobalIndexDelete
|
|
4899
|
-
* @summary Delete global index
|
|
4900
|
-
* @request DELETE:/global-indexes
|
|
4901
|
-
* @secure
|
|
4902
|
-
*/
|
|
4903
|
-
globalIndexDelete(query: {
|
|
4904
|
-
/** a3 code */
|
|
4905
|
-
a3code: string;
|
|
4906
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4907
|
-
/**
|
|
4908
|
-
* @description Get regions
|
|
4909
|
-
* @tags World Markets
|
|
4910
|
-
* @name RegionGet
|
|
4911
|
-
* @summary Get regions
|
|
4912
|
-
* @request GET:/regions
|
|
4913
|
-
* @secure
|
|
4914
|
-
*/
|
|
4915
|
-
regionGet(query: {
|
|
4916
|
-
/** Query limit */
|
|
4917
|
-
limit: number;
|
|
4918
|
-
/** Query offset */
|
|
4919
|
-
offset: number;
|
|
4920
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
4921
|
-
/**
|
|
4922
|
-
* @description Edit region
|
|
4923
|
-
* @tags World Markets
|
|
4924
|
-
* @name RegionEdit
|
|
4925
|
-
* @summary Edit region
|
|
4926
|
-
* @request PUT:/regions
|
|
4927
|
-
* @secure
|
|
4928
|
-
*/
|
|
4929
|
-
regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4930
|
-
/**
|
|
4931
|
-
* @description Create regions
|
|
4932
|
-
* @tags World Markets
|
|
4933
|
-
* @name RegionCreate
|
|
4934
|
-
* @summary Create regions
|
|
4935
|
-
* @request POST:/regions
|
|
4936
|
-
* @secure
|
|
4937
|
-
*/
|
|
4938
|
-
regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
4939
|
-
/**
|
|
4940
|
-
* @description Delete region
|
|
4941
|
-
* @tags World Markets
|
|
4942
|
-
* @name RegionDelete
|
|
4943
|
-
* @summary Delete region
|
|
4944
|
-
* @request DELETE:/regions
|
|
4945
|
-
* @secure
|
|
4946
|
-
*/
|
|
4947
|
-
regionDelete(query: {
|
|
4948
|
-
/** region id */
|
|
4949
|
-
id: string;
|
|
4950
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4951
|
-
}
|
|
4952
4826
|
export class CustomLists<HandleError extends boolean = boolean> {
|
|
4953
4827
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4954
4828
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -5193,280 +5067,908 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
5193
5067
|
*/
|
|
5194
5068
|
getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
|
|
5195
5069
|
}
|
|
5196
|
-
export
|
|
5197
|
-
|
|
5198
|
-
|
|
5199
|
-
/**
|
|
5200
|
-
* @description get fundamentals by symbol data
|
|
5201
|
-
* @tags Fundamentals
|
|
5202
|
-
* @name GetFundamentalsBySymbolData
|
|
5203
|
-
* @summary get fundamentals by symbol data
|
|
5204
|
-
* @request POST:/fundamentals
|
|
5205
|
-
* @secure
|
|
5206
|
-
*/
|
|
5207
|
-
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
5070
|
+
export interface InsightBeforeAndAfterV2 {
|
|
5071
|
+
after?: string;
|
|
5072
|
+
before?: string;
|
|
5208
5073
|
}
|
|
5209
|
-
export
|
|
5210
|
-
|
|
5211
|
-
|
|
5212
|
-
|
|
5213
|
-
|
|
5214
|
-
|
|
5215
|
-
|
|
5216
|
-
|
|
5217
|
-
|
|
5218
|
-
|
|
5219
|
-
|
|
5220
|
-
|
|
5221
|
-
|
|
5222
|
-
|
|
5223
|
-
|
|
5224
|
-
|
|
5225
|
-
|
|
5226
|
-
|
|
5227
|
-
|
|
5228
|
-
|
|
5229
|
-
|
|
5230
|
-
|
|
5231
|
-
|
|
5232
|
-
|
|
5233
|
-
|
|
5074
|
+
export interface InsightFixedIncomeV2 {
|
|
5075
|
+
a144: boolean;
|
|
5076
|
+
accrued_interest: number;
|
|
5077
|
+
bank_qualified: boolean;
|
|
5078
|
+
bond_warrant: boolean;
|
|
5079
|
+
call_type: string;
|
|
5080
|
+
callable: boolean;
|
|
5081
|
+
close_price: number;
|
|
5082
|
+
close_price_asof: string;
|
|
5083
|
+
close_ytw: number;
|
|
5084
|
+
convertible: boolean;
|
|
5085
|
+
country: string;
|
|
5086
|
+
country_code: string;
|
|
5087
|
+
country_domicile: string;
|
|
5088
|
+
country_issue: string;
|
|
5089
|
+
coupon: number;
|
|
5090
|
+
coupon_frequency: string;
|
|
5091
|
+
coupon_type: string;
|
|
5092
|
+
currency: string;
|
|
5093
|
+
cusip: string;
|
|
5094
|
+
dated_date: string;
|
|
5095
|
+
daycount: string;
|
|
5096
|
+
description: string;
|
|
5097
|
+
description_short: string;
|
|
5098
|
+
duration: number;
|
|
5099
|
+
first_coupon_date: string;
|
|
5100
|
+
insured: boolean;
|
|
5101
|
+
isin: string;
|
|
5102
|
+
issue_date: string;
|
|
5103
|
+
issue_minimum_denomination: number;
|
|
5104
|
+
issue_price: number;
|
|
5105
|
+
issue_size: number;
|
|
5106
|
+
issuer: string;
|
|
5107
|
+
last_coupon_date: string;
|
|
5108
|
+
liquidity_institutional_aggregate: number;
|
|
5109
|
+
liquidity_institutional_buy: number;
|
|
5110
|
+
liquidity_institutional_sell: number;
|
|
5111
|
+
liquidity_micro_aggregate: number;
|
|
5112
|
+
liquidity_micro_buy: number;
|
|
5113
|
+
liquidity_micro_sell: number;
|
|
5114
|
+
liquidity_retail_aggregate: number;
|
|
5115
|
+
liquidity_retail_buy: number;
|
|
5116
|
+
liquidity_retail_sell: number;
|
|
5117
|
+
maturity_date: string;
|
|
5118
|
+
municipal_state: string;
|
|
5119
|
+
municipal_taxable_federal: boolean;
|
|
5120
|
+
municipal_type: string;
|
|
5121
|
+
next_call_date: string;
|
|
5122
|
+
next_call_price: number;
|
|
5123
|
+
next_coupon_date: string;
|
|
5124
|
+
par_value: number;
|
|
5125
|
+
perpetual: boolean;
|
|
5126
|
+
private_placement: boolean;
|
|
5127
|
+
purpose: string;
|
|
5128
|
+
puttable: boolean;
|
|
5129
|
+
reg_s: boolean;
|
|
5130
|
+
sector: string;
|
|
5131
|
+
seniority: string;
|
|
5132
|
+
settlement_convention: string;
|
|
5133
|
+
sinking_fund: boolean;
|
|
5134
|
+
sp_creditwatch: string;
|
|
5135
|
+
sp_creditwatch_date: string;
|
|
5136
|
+
sp_outlook: string;
|
|
5137
|
+
sp_outlook_date: string;
|
|
5138
|
+
sp_rating: string;
|
|
5139
|
+
sp_rating_date: string;
|
|
5140
|
+
status: string;
|
|
5141
|
+
ticker: string;
|
|
5142
|
+
treasury_subtype: string;
|
|
5143
|
+
type: string;
|
|
5144
|
+
updated_at: string;
|
|
5145
|
+
}
|
|
5146
|
+
export interface InsightGetFixedIncomeEntriesResponseV2 {
|
|
5147
|
+
count: number;
|
|
5148
|
+
data: InsightFixedIncomeV2[];
|
|
5149
|
+
}
|
|
5150
|
+
export interface InsightGetFixedIncomeEntriesRequestV2 {
|
|
5151
|
+
/** @example true */
|
|
5152
|
+
bank_qualified?: boolean;
|
|
5153
|
+
/** @example true */
|
|
5154
|
+
callable?: boolean;
|
|
5155
|
+
/** @example true */
|
|
5156
|
+
convertible?: boolean;
|
|
5157
|
+
/** @example ["USA"] */
|
|
5158
|
+
country_codes?: string[];
|
|
5159
|
+
coupon?: InsightLessAndMoreV2;
|
|
5160
|
+
/** @example ["quarterly","zero"] */
|
|
5161
|
+
coupon_frequencies?: string[];
|
|
5162
|
+
/** @example ["655664AH3","9128286R6"] */
|
|
5163
|
+
cusip?: string[];
|
|
5164
|
+
/**
|
|
5165
|
+
* @maxLength 100
|
|
5166
|
+
* @example "Donald's"
|
|
5167
|
+
*/
|
|
5168
|
+
description?: string;
|
|
5169
|
+
/** @example true */
|
|
5170
|
+
has_ticker?: boolean;
|
|
5171
|
+
/** @example true */
|
|
5172
|
+
insured?: boolean;
|
|
5173
|
+
/** @example ["US655664AH33","US9128286R69"] */
|
|
5174
|
+
isin?: string[];
|
|
5175
|
+
issue_date?: InsightBeforeAndAfterV2;
|
|
5176
|
+
/**
|
|
5177
|
+
* @maxLength 100
|
|
5178
|
+
* @example "Donald's"
|
|
5179
|
+
*/
|
|
5180
|
+
issuer?: string;
|
|
5181
|
+
maturity?: InsightBeforeAndAfterV2;
|
|
5182
|
+
/** @example ["NY"] */
|
|
5183
|
+
municipal_states?: string[];
|
|
5184
|
+
/** @example true */
|
|
5185
|
+
municipal_tax?: boolean;
|
|
5186
|
+
/** @example ["general_obligation"] */
|
|
5187
|
+
municipal_types?: string[];
|
|
5188
|
+
pagination: InsightPaginationV2;
|
|
5189
|
+
purposes?: string[];
|
|
5190
|
+
/** @example ["SOVEREIGN"] */
|
|
5191
|
+
sectors?: string[];
|
|
5192
|
+
sorts?: InsightOrderingV2[];
|
|
5193
|
+
/** @example ["AAA"] */
|
|
5194
|
+
sp_ratings?: string[];
|
|
5195
|
+
/** @example ["called","outstanding"] */
|
|
5196
|
+
statuses?: string[];
|
|
5197
|
+
tickers?: string[];
|
|
5198
|
+
/** @example ["corporate"] */
|
|
5199
|
+
types?: string[];
|
|
5200
|
+
}
|
|
5201
|
+
export interface InsightGetTopSymbolsRequestV2 {
|
|
5202
|
+
exchange?: string[];
|
|
5203
|
+
market_cap?: InsightLessAndMoreV2;
|
|
5204
|
+
pagination?: InsightPaginationV2;
|
|
5205
|
+
price?: InsightLessAndMoreV2;
|
|
5206
|
+
sorts?: InsightOrderingV2[];
|
|
5207
|
+
volume?: InsightLessAndMoreV2;
|
|
5208
|
+
}
|
|
5209
|
+
export interface InsightIncludeExcludeV2 {
|
|
5210
|
+
exclude?: string[];
|
|
5211
|
+
include?: string[];
|
|
5212
|
+
}
|
|
5213
|
+
export interface InsightLessAndMoreV2 {
|
|
5214
|
+
less_than?: number;
|
|
5215
|
+
more_than?: number;
|
|
5216
|
+
}
|
|
5217
|
+
export enum InsightOrderDirectionV2 {
|
|
5218
|
+
OrderASC = "asc",
|
|
5219
|
+
OrderDESC = "desc"
|
|
5220
|
+
}
|
|
5221
|
+
export interface InsightOrderingV2 {
|
|
5222
|
+
/**
|
|
5223
|
+
* @default "asc"
|
|
5224
|
+
* @example "asc"
|
|
5225
|
+
*/
|
|
5226
|
+
direction: InsightOrderingDirectionEnumV2;
|
|
5227
|
+
/**
|
|
5228
|
+
* Sort direction:
|
|
5229
|
+
* * asc - Ascending, from A to Z.
|
|
5230
|
+
* * desc - Descending, from Z to A.
|
|
5231
|
+
* @example "name"
|
|
5232
|
+
*/
|
|
5233
|
+
field: string;
|
|
5234
|
+
}
|
|
5235
|
+
export interface InsightPaginationV2 {
|
|
5236
|
+
/**
|
|
5237
|
+
* @min 1
|
|
5238
|
+
* @example 1
|
|
5239
|
+
*/
|
|
5240
|
+
page: number;
|
|
5241
|
+
/**
|
|
5242
|
+
* @min 1
|
|
5243
|
+
* @max 50
|
|
5244
|
+
* @example 10
|
|
5245
|
+
*/
|
|
5246
|
+
size: number;
|
|
5247
|
+
}
|
|
5248
|
+
export interface InsightStockScreenerQuoteV2 {
|
|
5249
|
+
average_volume_30d: number;
|
|
5250
|
+
company_name: string;
|
|
5251
|
+
dividend_ex_date: string;
|
|
5252
|
+
dividend_pay_date: string;
|
|
5253
|
+
dividend_percent: number;
|
|
5254
|
+
exchange: string;
|
|
5255
|
+
exchange_name: string;
|
|
5256
|
+
gap: number;
|
|
5257
|
+
industry: string;
|
|
5258
|
+
industry_code: string;
|
|
5259
|
+
last_price: number;
|
|
5260
|
+
market_cap: number;
|
|
5261
|
+
pe_ratio: number;
|
|
5262
|
+
price_change: number;
|
|
5263
|
+
price_change_percent: number;
|
|
5264
|
+
symbol: string;
|
|
5265
|
+
volume: number;
|
|
5266
|
+
}
|
|
5267
|
+
export interface InsightStockScreenerRequestV2 {
|
|
5268
|
+
average_volume_30d?: InsightLessAndMoreV2;
|
|
5269
|
+
dividend_ex_date?: InsightBeforeAndAfterV2;
|
|
5270
|
+
dividend_pay_date?: InsightBeforeAndAfterV2;
|
|
5271
|
+
dividend_percent?: InsightLessAndMoreV2;
|
|
5272
|
+
exchange?: InsightIncludeExcludeV2;
|
|
5273
|
+
gap?: InsightLessAndMoreV2;
|
|
5274
|
+
industry?: InsightIncludeExcludeV2;
|
|
5275
|
+
market_cap?: InsightLessAndMoreV2;
|
|
5276
|
+
pagination: InsightPaginationV2;
|
|
5277
|
+
pe_ratio?: InsightLessAndMoreV2;
|
|
5278
|
+
price?: InsightLessAndMoreV2;
|
|
5279
|
+
sorts?: InsightOrderingV2[];
|
|
5280
|
+
/** @example "ADR" */
|
|
5281
|
+
stock_type?: string;
|
|
5282
|
+
volume?: InsightLessAndMoreV2;
|
|
5283
|
+
}
|
|
5284
|
+
export interface InsightStockScreenerResponseV2 {
|
|
5285
|
+
current_page: number;
|
|
5286
|
+
data: InsightStockScreenerQuoteV2[];
|
|
5287
|
+
page_count: number;
|
|
5288
|
+
status: number;
|
|
5289
|
+
total_records: number;
|
|
5290
|
+
}
|
|
5291
|
+
/**
|
|
5292
|
+
* @default "asc"
|
|
5293
|
+
* @example "asc"
|
|
5294
|
+
*/
|
|
5295
|
+
export enum InsightOrderingDirectionEnumV2 {
|
|
5296
|
+
Asc = "asc",
|
|
5297
|
+
Desc = "desc"
|
|
5298
|
+
}
|
|
5299
|
+
export class FixedIncomeV2<HandleError extends boolean = boolean> {
|
|
5300
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5301
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5302
|
+
/**
|
|
5303
|
+
* @description get fixed income entries
|
|
5304
|
+
* @tags FixedIncome
|
|
5305
|
+
* @name GetFixedIncomeEntries
|
|
5306
|
+
* @summary get fixed income entries
|
|
5307
|
+
* @request POST:/fixed-income
|
|
5308
|
+
* @secure
|
|
5309
|
+
*/
|
|
5310
|
+
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
|
|
5311
|
+
}
|
|
5312
|
+
export class Fundamentals<HandleError extends boolean = boolean> {
|
|
5313
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5314
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5315
|
+
/**
|
|
5316
|
+
* @description get fundamentals by symbol data
|
|
5317
|
+
* @tags Fundamentals
|
|
5318
|
+
* @name GetFundamentalsBySymbolData
|
|
5319
|
+
* @summary get fundamentals by symbol data
|
|
5320
|
+
* @request POST:/fundamentals
|
|
5321
|
+
* @secure
|
|
5322
|
+
*/
|
|
5323
|
+
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
5324
|
+
}
|
|
5325
|
+
export class Funds<HandleError extends boolean = boolean> {
|
|
5326
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5327
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5328
|
+
/**
|
|
5329
|
+
* @description get fund details
|
|
5330
|
+
* @tags Funds
|
|
5331
|
+
* @name GetFundDetails
|
|
5332
|
+
* @summary get fund details
|
|
5333
|
+
* @request GET:/funds/details
|
|
5334
|
+
* @secure
|
|
5335
|
+
*/
|
|
5336
|
+
getFundDetails(query: {
|
|
5337
|
+
/** Fund symbol */
|
|
5338
|
+
symbol: string;
|
|
5339
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundDetailsResponse, HandleError>>;
|
|
5340
|
+
/**
|
|
5341
|
+
* @description get funds for holding
|
|
5342
|
+
* @tags Funds
|
|
5343
|
+
* @name GetFundsForHolding
|
|
5344
|
+
* @summary get funds for holding
|
|
5345
|
+
* @request POST:/funds/funds-for-holding
|
|
5346
|
+
* @secure
|
|
5347
|
+
*/
|
|
5348
|
+
getFundsForHolding(filter: InsightGetFundsForHoldingRequest, headers?: {
|
|
5349
|
+
/** Authorization */
|
|
5234
5350
|
Authorization?: string;
|
|
5235
5351
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundsForHoldingResponse, HandleError>>;
|
|
5236
5352
|
/**
|
|
5237
|
-
* @description filter funds by params
|
|
5238
|
-
* @tags Funds
|
|
5239
|
-
* @name FundScreener
|
|
5240
|
-
* @summary filter funds by params
|
|
5241
|
-
* @request POST:/funds/screener
|
|
5353
|
+
* @description filter funds by params
|
|
5354
|
+
* @tags Funds
|
|
5355
|
+
* @name FundScreener
|
|
5356
|
+
* @summary filter funds by params
|
|
5357
|
+
* @request POST:/funds/screener
|
|
5358
|
+
* @secure
|
|
5359
|
+
*/
|
|
5360
|
+
fundScreener(filter: InsightFundScreenerRequest, headers?: {
|
|
5361
|
+
/** Authorization */
|
|
5362
|
+
Authorization?: string;
|
|
5363
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
|
|
5364
|
+
/**
|
|
5365
|
+
* @description get fund screener filters
|
|
5366
|
+
* @tags Funds
|
|
5367
|
+
* @name GetScreenerFilters
|
|
5368
|
+
* @summary get fund screener filters
|
|
5369
|
+
* @request GET:/funds/screener/filters
|
|
5370
|
+
* @secure
|
|
5371
|
+
*/
|
|
5372
|
+
getScreenerFilters(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundScreenerFiltersResponse, HandleError>>;
|
|
5373
|
+
/**
|
|
5374
|
+
* @description get fund screener presets
|
|
5375
|
+
* @tags Funds
|
|
5376
|
+
* @name GetFundScreenerPresets
|
|
5377
|
+
* @summary get fund screener presets
|
|
5378
|
+
* @request GET:/funds/screener/presets
|
|
5379
|
+
* @secure
|
|
5380
|
+
*/
|
|
5381
|
+
getFundScreenerPresets(query: {
|
|
5382
|
+
/** how many records to return */
|
|
5383
|
+
limit: number;
|
|
5384
|
+
/** how many records to skip */
|
|
5385
|
+
offset: number;
|
|
5386
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
5387
|
+
/**
|
|
5388
|
+
* @description update fund screener preset
|
|
5389
|
+
* @tags Funds
|
|
5390
|
+
* @name UpdateFundScreenerPreset
|
|
5391
|
+
* @summary update fund screener preset
|
|
5392
|
+
* @request PUT:/funds/screener/presets
|
|
5393
|
+
* @secure
|
|
5394
|
+
*/
|
|
5395
|
+
updateFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5396
|
+
/**
|
|
5397
|
+
* @description create fund screener preset
|
|
5398
|
+
* @tags Funds
|
|
5399
|
+
* @name CreateFundScreenerPreset
|
|
5400
|
+
* @summary create fund screener preset
|
|
5401
|
+
* @request POST:/funds/screener/presets
|
|
5402
|
+
* @secure
|
|
5403
|
+
*/
|
|
5404
|
+
createFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5405
|
+
/**
|
|
5406
|
+
* @description remove fund screener preset
|
|
5407
|
+
* @tags Funds
|
|
5408
|
+
* @name RemoveFundScreenerPreset
|
|
5409
|
+
* @summary remove fund screener preset
|
|
5410
|
+
* @request DELETE:/funds/screener/presets
|
|
5411
|
+
* @secure
|
|
5412
|
+
*/
|
|
5413
|
+
removeFundScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5414
|
+
/**
|
|
5415
|
+
* @description filter funds by params
|
|
5416
|
+
* @tags Funds
|
|
5417
|
+
* @name FundSectorScreener
|
|
5418
|
+
* @summary filter funds by params
|
|
5419
|
+
* @request POST:/funds/sector-screener
|
|
5420
|
+
* @secure
|
|
5421
|
+
*/
|
|
5422
|
+
fundSectorScreener(filter: InsightFundSectorScreenerRequest, headers?: {
|
|
5423
|
+
/** Authorization */
|
|
5424
|
+
Authorization?: string;
|
|
5425
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
|
|
5426
|
+
/**
|
|
5427
|
+
* @description get top funds
|
|
5428
|
+
* @tags Funds
|
|
5429
|
+
* @name GetTopFunds
|
|
5430
|
+
* @summary get top funds
|
|
5431
|
+
* @request POST:/funds/top
|
|
5432
|
+
* @secure
|
|
5433
|
+
*/
|
|
5434
|
+
getTopFunds(filter: InsightGetTopFundsRequest, headers?: {
|
|
5435
|
+
/** Authorization */
|
|
5436
|
+
Authorization?: string;
|
|
5437
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
|
|
5438
|
+
}
|
|
5439
|
+
export class Intraday<HandleError extends boolean = boolean> {
|
|
5440
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5441
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5442
|
+
/**
|
|
5443
|
+
* @description Returns an array of intraday chart data values for the given ticker.
|
|
5444
|
+
* @tags Intraday
|
|
5445
|
+
* @name IntradayQuotes
|
|
5446
|
+
* @summary Get an array of intraday chart data values for the given ticker
|
|
5447
|
+
* @request POST:/intraday/quotes
|
|
5448
|
+
* @secure
|
|
5449
|
+
*/
|
|
5450
|
+
intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
|
|
5451
|
+
}
|
|
5452
|
+
export class Ipos<HandleError extends boolean = boolean> {
|
|
5453
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5454
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5455
|
+
/**
|
|
5456
|
+
* @description get recent ipos info
|
|
5457
|
+
* @tags Ipos
|
|
5458
|
+
* @name PostRecent
|
|
5459
|
+
* @summary get recent ipos info
|
|
5460
|
+
* @request POST:/ipos/recent
|
|
5461
|
+
* @secure
|
|
5462
|
+
*/
|
|
5463
|
+
postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5464
|
+
/**
|
|
5465
|
+
* @description get upcoming ipos info
|
|
5466
|
+
* @tags Ipos
|
|
5467
|
+
* @name GetUpcoming
|
|
5468
|
+
* @summary get upcoming ipos info
|
|
5469
|
+
* @request GET:/ipos/upcoming
|
|
5470
|
+
* @secure
|
|
5471
|
+
*/
|
|
5472
|
+
getUpcoming(query: {
|
|
5473
|
+
/** how many records to return. Max value is 50 */
|
|
5474
|
+
limit: number;
|
|
5475
|
+
/** how many records to skip */
|
|
5476
|
+
offset: number;
|
|
5477
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5478
|
+
/**
|
|
5479
|
+
* @description get ipo info by symbol
|
|
5480
|
+
* @tags Ipos
|
|
5481
|
+
* @name GetIpos
|
|
5482
|
+
* @summary get ipo info by symbol
|
|
5483
|
+
* @request GET:/ipos/{symbol}
|
|
5484
|
+
* @secure
|
|
5485
|
+
*/
|
|
5486
|
+
getIpos(symbol: string, query?: {
|
|
5487
|
+
/** load quotes */
|
|
5488
|
+
load_quotes?: boolean;
|
|
5489
|
+
/** statuses */
|
|
5490
|
+
statuses?: string[];
|
|
5491
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
|
|
5492
|
+
}
|
|
5493
|
+
export class Logos<HandleError extends boolean = boolean> {
|
|
5494
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5495
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5496
|
+
/**
|
|
5497
|
+
* @description Returns converted logo for crypto symbol
|
|
5498
|
+
* @tags Logos
|
|
5499
|
+
* @name LogosConvertedCryptoSymbolLogo
|
|
5500
|
+
* @summary Get converted logo for crypto symbol
|
|
5501
|
+
* @request POST:/logos/converted-crypto-symbol-logo
|
|
5502
|
+
* @secure
|
|
5503
|
+
*/
|
|
5504
|
+
logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5505
|
+
/**
|
|
5506
|
+
* @description Returns converted logo for symbol
|
|
5507
|
+
* @tags Logos
|
|
5508
|
+
* @name LogosConvertedSymbolLogo
|
|
5509
|
+
* @summary Get converted logo for symbol
|
|
5510
|
+
* @request POST:/logos/converted-symbol-logo
|
|
5242
5511
|
* @secure
|
|
5243
5512
|
*/
|
|
5244
|
-
|
|
5245
|
-
/** Authorization */
|
|
5246
|
-
Authorization?: string;
|
|
5247
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
|
|
5513
|
+
logosConvertedSymbolLogo(filter: InsightSymbolLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5248
5514
|
/**
|
|
5249
|
-
* @description
|
|
5250
|
-
* @tags
|
|
5251
|
-
* @name
|
|
5252
|
-
* @summary
|
|
5253
|
-
* @request GET:/
|
|
5515
|
+
* @description Returns logo for crypto symbol
|
|
5516
|
+
* @tags Logos
|
|
5517
|
+
* @name LogosCryptoSymbolLogo
|
|
5518
|
+
* @summary Get logo for crypto symbol
|
|
5519
|
+
* @request GET:/logos/crypto-symbol-logo
|
|
5254
5520
|
* @secure
|
|
5255
5521
|
*/
|
|
5256
|
-
|
|
5522
|
+
logosCryptoSymbolLogo(query: {
|
|
5523
|
+
/** Company symbol */
|
|
5524
|
+
symbol: string;
|
|
5525
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError>>;
|
|
5257
5526
|
/**
|
|
5258
|
-
* @description
|
|
5259
|
-
* @tags
|
|
5260
|
-
* @name
|
|
5261
|
-
* @summary
|
|
5262
|
-
* @request GET:/
|
|
5527
|
+
* @description Returns direct logo for crypto symbol
|
|
5528
|
+
* @tags Logos
|
|
5529
|
+
* @name LogosDirectCryptoSymbolLogo
|
|
5530
|
+
* @summary Get direct logo for crypto symbol
|
|
5531
|
+
* @request GET:/logos/direct-crypto-symbol-logo
|
|
5532
|
+
* @secure
|
|
5533
|
+
*/
|
|
5534
|
+
logosDirectCryptoSymbolLogo(query: {
|
|
5535
|
+
/** Company symbol */
|
|
5536
|
+
symbol: string;
|
|
5537
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5538
|
+
/**
|
|
5539
|
+
* @description Returns direct logo for symbol
|
|
5540
|
+
* @tags Logos
|
|
5541
|
+
* @name LogosDirectSymbolLogo
|
|
5542
|
+
* @summary Get direct logo for symbol
|
|
5543
|
+
* @request GET:/logos/direct-symbol-logo
|
|
5544
|
+
* @secure
|
|
5545
|
+
*/
|
|
5546
|
+
logosDirectSymbolLogo(query: {
|
|
5547
|
+
/** Company symbol */
|
|
5548
|
+
symbol: string;
|
|
5549
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5550
|
+
/**
|
|
5551
|
+
* @description Returns logos for multiple symbols
|
|
5552
|
+
* @tags Logos
|
|
5553
|
+
* @name LogosMultipleCryptoSymbolLogo
|
|
5554
|
+
* @summary Get logos for multiple symbols
|
|
5555
|
+
* @request POST:/logos/multiple-crypto-symbol-logo
|
|
5556
|
+
* @secure
|
|
5557
|
+
*/
|
|
5558
|
+
logosMultipleCryptoSymbolLogo(filter: InsightMultipleCryptoLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse[], HandleError>>;
|
|
5559
|
+
/**
|
|
5560
|
+
* @description Returns logos for multiple symbol
|
|
5561
|
+
* @tags Logos
|
|
5562
|
+
* @name LogosMultipleSymbolLogos
|
|
5563
|
+
* @summary Get logos for multiple symbols
|
|
5564
|
+
* @request POST:/logos/multiple-symbol-logos
|
|
5565
|
+
* @secure
|
|
5566
|
+
*/
|
|
5567
|
+
logosMultipleSymbolLogos(filter: InsightMultipleSymbolLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse[], HandleError>>;
|
|
5568
|
+
/**
|
|
5569
|
+
* @description Returns links of socials logos for symbol
|
|
5570
|
+
* @tags Logos
|
|
5571
|
+
* @name LogosSocialSymbolLogos
|
|
5572
|
+
* @summary Get social logos for symbol
|
|
5573
|
+
* @request GET:/logos/social-symbol-logos
|
|
5574
|
+
* @secure
|
|
5575
|
+
*/
|
|
5576
|
+
logosSocialSymbolLogos(query: {
|
|
5577
|
+
/** Company symbol */
|
|
5578
|
+
symbol: string;
|
|
5579
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
|
|
5580
|
+
/**
|
|
5581
|
+
* @description Returns logos for company symbol
|
|
5582
|
+
* @tags Logos
|
|
5583
|
+
* @name LogosSymbolLogos
|
|
5584
|
+
* @summary Get symbol logos
|
|
5585
|
+
* @request GET:/logos/symbol-logos
|
|
5586
|
+
* @secure
|
|
5587
|
+
*/
|
|
5588
|
+
logosSymbolLogos(query: {
|
|
5589
|
+
/** Company symbol */
|
|
5590
|
+
symbol: string;
|
|
5591
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
|
|
5592
|
+
}
|
|
5593
|
+
export class MarketDates<HandleError extends boolean = boolean> {
|
|
5594
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5595
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5596
|
+
/**
|
|
5597
|
+
* @description Create or update market date
|
|
5598
|
+
* @tags MarketDates
|
|
5599
|
+
* @name CreateOrUpdateMarketDate
|
|
5600
|
+
* @summary Create or update market date
|
|
5601
|
+
* @request POST:/market-dates
|
|
5602
|
+
* @secure
|
|
5603
|
+
*/
|
|
5604
|
+
createOrUpdateMarketDate(market: InsightMarketDates[], config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketDate[], HandleError>>;
|
|
5605
|
+
/**
|
|
5606
|
+
* @description Remove market date
|
|
5607
|
+
* @tags MarketDates
|
|
5608
|
+
* @name RemoveMarketDate
|
|
5609
|
+
* @summary Remove market date
|
|
5610
|
+
* @request DELETE:/market-dates
|
|
5611
|
+
* @secure
|
|
5612
|
+
*/
|
|
5613
|
+
removeMarketDate(market: InsightRemoveMarketDateRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5614
|
+
/**
|
|
5615
|
+
* @description Get market dates history
|
|
5616
|
+
* @tags MarketDates
|
|
5617
|
+
* @name GetMarketDatesHistory
|
|
5618
|
+
* @summary Get market dates history
|
|
5619
|
+
* @request POST:/market-dates/history
|
|
5620
|
+
* @secure
|
|
5621
|
+
*/
|
|
5622
|
+
getMarketDatesHistory(filter: InsightGetMarketDatesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketDatesResponse, HandleError>>;
|
|
5623
|
+
/**
|
|
5624
|
+
* @description Search locode data by search string and field
|
|
5625
|
+
* @tags MarketDates
|
|
5626
|
+
* @name SearchLocodeData
|
|
5627
|
+
* @summary Search locode data
|
|
5628
|
+
* @request GET:/market-dates/locode
|
|
5629
|
+
* @secure
|
|
5630
|
+
*/
|
|
5631
|
+
searchLocodeData(query?: {
|
|
5632
|
+
/** Search string */
|
|
5633
|
+
search?: string;
|
|
5634
|
+
/** Search field */
|
|
5635
|
+
field?: InsightSearchLocodeDataParamsFieldEnum;
|
|
5636
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSearchLocodeDataResponse, HandleError>>;
|
|
5637
|
+
/**
|
|
5638
|
+
* @description Get markets
|
|
5639
|
+
* @tags MarketDates
|
|
5640
|
+
* @name GetMarkets
|
|
5641
|
+
* @summary Get markets
|
|
5642
|
+
* @request GET:/market-dates/markets
|
|
5643
|
+
* @secure
|
|
5644
|
+
*/
|
|
5645
|
+
getMarkets(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketsResponse, HandleError>>;
|
|
5646
|
+
/**
|
|
5647
|
+
* @description Create or update market
|
|
5648
|
+
* @tags MarketDates
|
|
5649
|
+
* @name CreateOrUpdateMarket
|
|
5650
|
+
* @summary Create or update market
|
|
5651
|
+
* @request POST:/market-dates/markets
|
|
5652
|
+
* @secure
|
|
5653
|
+
*/
|
|
5654
|
+
createOrUpdateMarket(market: InsightCreateOrUpdateMarketRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarket, HandleError>>;
|
|
5655
|
+
/**
|
|
5656
|
+
* @description Get market
|
|
5657
|
+
* @tags MarketDates
|
|
5658
|
+
* @name GetMarket
|
|
5659
|
+
* @summary Get market
|
|
5660
|
+
* @request GET:/market-dates/markets/{market}
|
|
5661
|
+
* @secure
|
|
5662
|
+
*/
|
|
5663
|
+
getMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarket, HandleError>>;
|
|
5664
|
+
/**
|
|
5665
|
+
* @description Remove market
|
|
5666
|
+
* @tags MarketDates
|
|
5667
|
+
* @name RemoveMarket
|
|
5668
|
+
* @summary Remove market
|
|
5669
|
+
* @request DELETE:/market-dates/markets/{market}
|
|
5670
|
+
* @secure
|
|
5671
|
+
*/
|
|
5672
|
+
removeMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5673
|
+
/**
|
|
5674
|
+
* @description CreateOrUpdateMarketSchedule market schedule
|
|
5675
|
+
* @tags MarketDates
|
|
5676
|
+
* @name CreateOrUpdateMarketSchedule
|
|
5677
|
+
* @summary CreateOrUpdateMarketSchedule market schedule
|
|
5678
|
+
* @request POST:/market-dates/schedule
|
|
5679
|
+
* @secure
|
|
5680
|
+
*/
|
|
5681
|
+
createOrUpdateMarketSchedule(market: InsightCreateOrUpdateMarketScheduleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
|
|
5682
|
+
/**
|
|
5683
|
+
* @description Get market schedule
|
|
5684
|
+
* @tags MarketDates
|
|
5685
|
+
* @name GetMarketSchedule
|
|
5686
|
+
* @summary Get market schedule
|
|
5687
|
+
* @request GET:/market-dates/schedule/{market}
|
|
5688
|
+
* @secure
|
|
5689
|
+
*/
|
|
5690
|
+
getMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse, HandleError>>;
|
|
5691
|
+
/**
|
|
5692
|
+
* @description Remove market schedule
|
|
5693
|
+
* @tags MarketDates
|
|
5694
|
+
* @name RemoveMarketSchedule
|
|
5695
|
+
* @summary Remove market schedule
|
|
5696
|
+
* @request DELETE:/market-dates/schedule/{market}
|
|
5697
|
+
* @secure
|
|
5698
|
+
*/
|
|
5699
|
+
removeMarketSchedule(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5700
|
+
/**
|
|
5701
|
+
* @description Get market schedules
|
|
5702
|
+
* @tags MarketDates
|
|
5703
|
+
* @name GetMarketSchedules
|
|
5704
|
+
* @summary Get market schedules
|
|
5705
|
+
* @request GET:/market-dates/schedules
|
|
5706
|
+
* @secure
|
|
5707
|
+
*/
|
|
5708
|
+
getMarketSchedules(query?: {
|
|
5709
|
+
/** Market codes, comma separated */
|
|
5710
|
+
market?: string;
|
|
5711
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse[][], HandleError>>;
|
|
5712
|
+
/**
|
|
5713
|
+
* @description Get todays market hours
|
|
5714
|
+
* @tags MarketDates
|
|
5715
|
+
* @name GetTodaysMarketHours
|
|
5716
|
+
* @summary Get todays market hours
|
|
5717
|
+
* @request GET:/market-dates/today
|
|
5718
|
+
* @secure
|
|
5719
|
+
*/
|
|
5720
|
+
getTodaysMarketHours(query: {
|
|
5721
|
+
/** Market */
|
|
5722
|
+
market: string;
|
|
5723
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
|
|
5724
|
+
}
|
|
5725
|
+
export class News<HandleError extends boolean = boolean> {
|
|
5726
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5727
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5728
|
+
/**
|
|
5729
|
+
* @description Returns available authors in DB
|
|
5730
|
+
* @tags News
|
|
5731
|
+
* @name NewsAvailableAuthors
|
|
5732
|
+
* @summary Get available authors in DB (for filters)
|
|
5733
|
+
* @request POST:/news/authors
|
|
5734
|
+
* @secure
|
|
5735
|
+
*/
|
|
5736
|
+
newsAvailableAuthors(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5737
|
+
/**
|
|
5738
|
+
* @description Returns available channels in DB
|
|
5739
|
+
* @tags News
|
|
5740
|
+
* @name NewsAvailableChannels
|
|
5741
|
+
* @summary Get available channels in DB (for filters)
|
|
5742
|
+
* @request POST:/news/channels
|
|
5743
|
+
* @secure
|
|
5744
|
+
*/
|
|
5745
|
+
newsAvailableChannels(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5746
|
+
/**
|
|
5747
|
+
* @description Get featured articles
|
|
5748
|
+
* @tags News
|
|
5749
|
+
* @name GetFeaturedArticles
|
|
5750
|
+
* @summary Get featured articles
|
|
5751
|
+
* @request GET:/news/featured-articles
|
|
5263
5752
|
* @secure
|
|
5264
5753
|
*/
|
|
5265
|
-
|
|
5266
|
-
/**
|
|
5754
|
+
getFeaturedArticles(query: {
|
|
5755
|
+
/** Limit */
|
|
5267
5756
|
limit: number;
|
|
5268
|
-
/**
|
|
5757
|
+
/** Offset */
|
|
5269
5758
|
offset: number;
|
|
5270
|
-
|
|
5759
|
+
/** Start date */
|
|
5760
|
+
start_date?: string;
|
|
5761
|
+
/** End date */
|
|
5762
|
+
end_date?: string;
|
|
5763
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
|
|
5271
5764
|
/**
|
|
5272
|
-
* @description
|
|
5273
|
-
* @tags
|
|
5274
|
-
* @name
|
|
5275
|
-
* @summary
|
|
5276
|
-
* @request PUT:/
|
|
5765
|
+
* @description Update featured articles
|
|
5766
|
+
* @tags News
|
|
5767
|
+
* @name UpdateFeaturedArticles
|
|
5768
|
+
* @summary Update featured articles
|
|
5769
|
+
* @request PUT:/news/featured-articles
|
|
5277
5770
|
* @secure
|
|
5278
5771
|
*/
|
|
5279
|
-
|
|
5772
|
+
updateFeaturedArticles(input: InsightUpdateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5280
5773
|
/**
|
|
5281
|
-
* @description
|
|
5282
|
-
* @tags
|
|
5283
|
-
* @name
|
|
5284
|
-
* @summary
|
|
5285
|
-
* @request POST:/
|
|
5774
|
+
* @description Create featured articles
|
|
5775
|
+
* @tags News
|
|
5776
|
+
* @name CreateFeaturedArticles
|
|
5777
|
+
* @summary Create featured articles
|
|
5778
|
+
* @request POST:/news/featured-articles
|
|
5286
5779
|
* @secure
|
|
5287
5780
|
*/
|
|
5288
|
-
|
|
5781
|
+
createFeaturedArticles(input: InsightCreateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5289
5782
|
/**
|
|
5290
|
-
* @description
|
|
5291
|
-
* @tags
|
|
5292
|
-
* @name
|
|
5293
|
-
* @summary
|
|
5294
|
-
* @request
|
|
5783
|
+
* @description Get active featured articles
|
|
5784
|
+
* @tags News
|
|
5785
|
+
* @name GetActiveFeaturedArticles
|
|
5786
|
+
* @summary Get active featured articles
|
|
5787
|
+
* @request GET:/news/featured-articles/active
|
|
5295
5788
|
* @secure
|
|
5296
5789
|
*/
|
|
5297
|
-
|
|
5790
|
+
getActiveFeaturedArticles(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
|
|
5298
5791
|
/**
|
|
5299
|
-
* @description
|
|
5300
|
-
* @tags
|
|
5301
|
-
* @name
|
|
5302
|
-
* @summary
|
|
5303
|
-
* @request POST:/
|
|
5792
|
+
* @description Set featured articles
|
|
5793
|
+
* @tags News
|
|
5794
|
+
* @name SetFeaturedArticles
|
|
5795
|
+
* @summary Set featured articles
|
|
5796
|
+
* @request POST:/news/featured-articles/set
|
|
5304
5797
|
* @secure
|
|
5305
5798
|
*/
|
|
5306
|
-
|
|
5307
|
-
/** Authorization */
|
|
5308
|
-
Authorization?: string;
|
|
5309
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
|
|
5799
|
+
setFeaturedArticles(input: InsightSetFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5310
5800
|
/**
|
|
5311
|
-
* @description
|
|
5312
|
-
* @tags
|
|
5313
|
-
* @name
|
|
5314
|
-
* @summary
|
|
5315
|
-
* @request
|
|
5801
|
+
* @description Get featured article
|
|
5802
|
+
* @tags News
|
|
5803
|
+
* @name GetFeaturedArticle
|
|
5804
|
+
* @summary Get featured article
|
|
5805
|
+
* @request GET:/news/featured-articles/{id}
|
|
5316
5806
|
* @secure
|
|
5317
5807
|
*/
|
|
5318
|
-
|
|
5319
|
-
/** Authorization */
|
|
5320
|
-
Authorization?: string;
|
|
5321
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
|
|
5322
|
-
}
|
|
5323
|
-
export class StockScreener<HandleError extends boolean = boolean> {
|
|
5324
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5325
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5808
|
+
getFeaturedArticle(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFeaturedArticle, HandleError>>;
|
|
5326
5809
|
/**
|
|
5327
|
-
* @description
|
|
5328
|
-
* @tags
|
|
5329
|
-
* @name
|
|
5330
|
-
* @summary
|
|
5331
|
-
* @request
|
|
5810
|
+
* @description Returns news by filters
|
|
5811
|
+
* @tags News
|
|
5812
|
+
* @name NewsFiltered
|
|
5813
|
+
* @summary Get filtered news
|
|
5814
|
+
* @request POST:/news/filter
|
|
5332
5815
|
* @secure
|
|
5333
5816
|
*/
|
|
5334
|
-
|
|
5335
|
-
/** Name of symbol list to fetch details for. Empty is default */
|
|
5336
|
-
heatmap_name?: string;
|
|
5337
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
|
|
5817
|
+
newsFiltered(filter: InsightNewsFilterRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsResponse, HandleError>>;
|
|
5338
5818
|
/**
|
|
5339
|
-
* @description
|
|
5340
|
-
* @tags
|
|
5341
|
-
* @name
|
|
5342
|
-
* @summary
|
|
5343
|
-
* @request POST:/
|
|
5819
|
+
* @description Returns news by id
|
|
5820
|
+
* @tags News
|
|
5821
|
+
* @name NewsById
|
|
5822
|
+
* @summary Get news by id
|
|
5823
|
+
* @request POST:/news/id
|
|
5344
5824
|
* @secure
|
|
5345
5825
|
*/
|
|
5346
|
-
|
|
5826
|
+
newsById(filter: InsightNewsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNews, HandleError>>;
|
|
5347
5827
|
/**
|
|
5348
|
-
* @description
|
|
5349
|
-
* @tags
|
|
5350
|
-
* @name
|
|
5351
|
-
* @summary
|
|
5352
|
-
* @request
|
|
5828
|
+
* @description Returns news previews
|
|
5829
|
+
* @tags News
|
|
5830
|
+
* @name NewsPreviewsFiltered
|
|
5831
|
+
* @summary Get news previews
|
|
5832
|
+
* @request GET:/news/previews
|
|
5353
5833
|
* @secure
|
|
5354
5834
|
*/
|
|
5355
|
-
|
|
5835
|
+
newsPreviewsFiltered(query: {
|
|
5836
|
+
/** Start date */
|
|
5837
|
+
start_date?: string;
|
|
5838
|
+
/** End date */
|
|
5839
|
+
end_date?: string;
|
|
5840
|
+
/** Symbol */
|
|
5841
|
+
symbol?: string;
|
|
5842
|
+
/** how many records to return. Max value is 50 */
|
|
5843
|
+
limit: number;
|
|
5844
|
+
/** how many records to skip */
|
|
5845
|
+
offset: number;
|
|
5846
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRecentNewsPreviewsResponse, HandleError>>;
|
|
5356
5847
|
/**
|
|
5357
|
-
* @description
|
|
5358
|
-
* @tags
|
|
5359
|
-
* @name
|
|
5360
|
-
* @summary
|
|
5361
|
-
* @request
|
|
5848
|
+
* @description Returns available stocks in DB
|
|
5849
|
+
* @tags News
|
|
5850
|
+
* @name NewsAvailableStocks
|
|
5851
|
+
* @summary Get available stocks in DB (for filters)
|
|
5852
|
+
* @request GET:/news/symbols
|
|
5362
5853
|
* @secure
|
|
5363
5854
|
*/
|
|
5364
|
-
|
|
5365
|
-
/**
|
|
5366
|
-
|
|
5367
|
-
|
|
5855
|
+
newsAvailableStocks(query?: {
|
|
5856
|
+
/** Limit */
|
|
5857
|
+
limit?: number;
|
|
5858
|
+
/** Offset */
|
|
5859
|
+
offset?: number;
|
|
5860
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5368
5861
|
/**
|
|
5369
|
-
* @description
|
|
5370
|
-
* @tags
|
|
5371
|
-
* @name
|
|
5372
|
-
* @summary
|
|
5373
|
-
* @request
|
|
5862
|
+
* @description Returns available tags in DB
|
|
5863
|
+
* @tags News
|
|
5864
|
+
* @name NewsAvailableTags
|
|
5865
|
+
* @summary Get available tags in DB (for filters)
|
|
5866
|
+
* @request POST:/news/tags
|
|
5374
5867
|
* @secure
|
|
5375
5868
|
*/
|
|
5376
|
-
|
|
5377
|
-
|
|
5378
|
-
|
|
5379
|
-
|
|
5380
|
-
|
|
5381
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
5869
|
+
newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5870
|
+
}
|
|
5871
|
+
export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
5872
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5873
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5382
5874
|
/**
|
|
5383
|
-
* @description
|
|
5384
|
-
* @tags
|
|
5385
|
-
* @name
|
|
5386
|
-
* @summary
|
|
5387
|
-
* @request
|
|
5875
|
+
* @description Returns calculated matrix
|
|
5876
|
+
* @tags OptionGreeks
|
|
5877
|
+
* @name OgCalculateMatrix
|
|
5878
|
+
* @summary Calculate matrix
|
|
5879
|
+
* @request POST:/og/calculate-matrix
|
|
5388
5880
|
* @secure
|
|
5389
5881
|
*/
|
|
5390
|
-
|
|
5882
|
+
ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
|
|
5391
5883
|
/**
|
|
5392
|
-
* @description
|
|
5393
|
-
* @tags
|
|
5394
|
-
* @name
|
|
5395
|
-
* @summary
|
|
5396
|
-
* @request POST:/
|
|
5884
|
+
* @description Returns calculated params
|
|
5885
|
+
* @tags OptionGreeks
|
|
5886
|
+
* @name OgCalculateParams
|
|
5887
|
+
* @summary Calculate params
|
|
5888
|
+
* @request POST:/og/calculate-params
|
|
5397
5889
|
* @secure
|
|
5398
5890
|
*/
|
|
5399
|
-
|
|
5891
|
+
ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
|
|
5892
|
+
}
|
|
5893
|
+
export class Ownerships<HandleError extends boolean = boolean> {
|
|
5894
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5895
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5400
5896
|
/**
|
|
5401
|
-
* @description
|
|
5402
|
-
* @tags
|
|
5403
|
-
* @name
|
|
5404
|
-
* @summary
|
|
5405
|
-
* @request
|
|
5897
|
+
* @description get ownerships by id datadata
|
|
5898
|
+
* @tags Ownerships
|
|
5899
|
+
* @name GetOwnershipsByIdData
|
|
5900
|
+
* @summary get ownerships by id data
|
|
5901
|
+
* @request POST:/ownerships
|
|
5406
5902
|
* @secure
|
|
5407
5903
|
*/
|
|
5408
|
-
|
|
5904
|
+
getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
5409
5905
|
/**
|
|
5410
|
-
* @description get
|
|
5411
|
-
* @tags
|
|
5412
|
-
* @name
|
|
5413
|
-
* @summary get
|
|
5414
|
-
* @request POST:/
|
|
5906
|
+
* @description get ownerships by symbol data
|
|
5907
|
+
* @tags Ownerships
|
|
5908
|
+
* @name GetOwnershipsBySymbolData
|
|
5909
|
+
* @summary get ownerships by symbol data
|
|
5910
|
+
* @request POST:/symbol-ownerships
|
|
5415
5911
|
* @secure
|
|
5416
5912
|
*/
|
|
5417
|
-
|
|
5913
|
+
getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
5418
5914
|
}
|
|
5419
|
-
export class
|
|
5915
|
+
export class Passport<HandleError extends boolean = boolean> {
|
|
5420
5916
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5421
5917
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5422
5918
|
/**
|
|
5423
|
-
* @description Returns
|
|
5424
|
-
* @tags
|
|
5425
|
-
* @name
|
|
5426
|
-
* @summary Get
|
|
5427
|
-
* @request POST:/
|
|
5919
|
+
* @description Returns article by id
|
|
5920
|
+
* @tags Passport
|
|
5921
|
+
* @name PassportArticleById
|
|
5922
|
+
* @summary Get article by id
|
|
5923
|
+
* @request POST:/passport/article-by-id
|
|
5924
|
+
* @secure
|
|
5925
|
+
*/
|
|
5926
|
+
passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
|
|
5927
|
+
/**
|
|
5928
|
+
* @description Returns articles
|
|
5929
|
+
* @tags Passport
|
|
5930
|
+
* @name PassportArticles
|
|
5931
|
+
* @summary Get articles
|
|
5932
|
+
* @request POST:/passport/articles
|
|
5933
|
+
* @secure
|
|
5934
|
+
*/
|
|
5935
|
+
passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
5936
|
+
/**
|
|
5937
|
+
* @description Returns author profile
|
|
5938
|
+
* @tags Passport
|
|
5939
|
+
* @name PassportAuthorProfile
|
|
5940
|
+
* @summary Get author profile
|
|
5941
|
+
* @request POST:/passport/author-profile
|
|
5428
5942
|
* @secure
|
|
5429
5943
|
*/
|
|
5430
|
-
|
|
5431
|
-
}
|
|
5432
|
-
export class Quotes<HandleError extends boolean = boolean> {
|
|
5433
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5434
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5944
|
+
passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
|
|
5435
5945
|
/**
|
|
5436
|
-
* @description
|
|
5437
|
-
* @tags
|
|
5438
|
-
* @name
|
|
5439
|
-
* @summary Get
|
|
5440
|
-
* @request
|
|
5946
|
+
* @description Returns most popular tags
|
|
5947
|
+
* @tags Passport
|
|
5948
|
+
* @name PassportMostPopularTags
|
|
5949
|
+
* @summary Get most popular tags
|
|
5950
|
+
* @request POST:/passport/most-popular-tags
|
|
5441
5951
|
* @secure
|
|
5442
5952
|
*/
|
|
5443
|
-
|
|
5444
|
-
/** Symbol */
|
|
5445
|
-
symbol: string;
|
|
5446
|
-
/** Date */
|
|
5447
|
-
date: string;
|
|
5448
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
|
|
5953
|
+
passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
|
|
5449
5954
|
/**
|
|
5450
|
-
* @description
|
|
5451
|
-
* @tags
|
|
5452
|
-
* @name
|
|
5453
|
-
* @summary Get
|
|
5454
|
-
* @request POST:/
|
|
5955
|
+
* @description Returns news feed
|
|
5956
|
+
* @tags Passport
|
|
5957
|
+
* @name PassportNewsFeed
|
|
5958
|
+
* @summary Get news feed
|
|
5959
|
+
* @request POST:/passport/newsfeed
|
|
5455
5960
|
* @secure
|
|
5456
5961
|
*/
|
|
5457
|
-
|
|
5962
|
+
passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
|
|
5458
5963
|
/**
|
|
5459
|
-
* @description Returns
|
|
5460
|
-
* @tags
|
|
5461
|
-
* @name
|
|
5462
|
-
* @summary
|
|
5463
|
-
* @request
|
|
5964
|
+
* @description Returns article by parameters
|
|
5965
|
+
* @tags Passport
|
|
5966
|
+
* @name PassportSearchArticle
|
|
5967
|
+
* @summary Search article by parameters
|
|
5968
|
+
* @request POST:/passport/search-article
|
|
5464
5969
|
* @secure
|
|
5465
5970
|
*/
|
|
5466
|
-
|
|
5467
|
-
/** Comma separated symbols */
|
|
5468
|
-
symbols: string;
|
|
5469
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
|
|
5971
|
+
passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
5470
5972
|
}
|
|
5471
5973
|
export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
5472
5974
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5518,6 +6020,18 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
|
5518
6020
|
name?: string;
|
|
5519
6021
|
/** search by categories */
|
|
5520
6022
|
categories?: string;
|
|
6023
|
+
/** search by listing type */
|
|
6024
|
+
listing_type?: string;
|
|
6025
|
+
/** filter by active status */
|
|
6026
|
+
is_active?: InsightGetPreIpoCompaniesParamsIsActiveEnum;
|
|
6027
|
+
/** filter by minimum last valuation */
|
|
6028
|
+
min_last_valuation?: number;
|
|
6029
|
+
/** filter by maximum last valuation */
|
|
6030
|
+
max_last_valuation?: number;
|
|
6031
|
+
/** filter by minimum total funding */
|
|
6032
|
+
min_total_funding?: number;
|
|
6033
|
+
/** filter by maximum total funding */
|
|
6034
|
+
max_total_funding?: number;
|
|
5521
6035
|
/** how many records to return. Max value is 50 */
|
|
5522
6036
|
limit: number;
|
|
5523
6037
|
/** how many records to skip */
|
|
@@ -5743,454 +6257,291 @@ export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
|
5743
6257
|
include_documents?: boolean;
|
|
5744
6258
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
|
|
5745
6259
|
}
|
|
5746
|
-
export class
|
|
5747
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5748
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5749
|
-
/**
|
|
5750
|
-
* @description get recent ipos info
|
|
5751
|
-
* @tags Ipos
|
|
5752
|
-
* @name PostRecent
|
|
5753
|
-
* @summary get recent ipos info
|
|
5754
|
-
* @request POST:/ipos/recent
|
|
5755
|
-
* @secure
|
|
5756
|
-
*/
|
|
5757
|
-
postRecent(recentIPODto: InsightRecentIPOListRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5758
|
-
/**
|
|
5759
|
-
* @description get upcoming ipos info
|
|
5760
|
-
* @tags Ipos
|
|
5761
|
-
* @name GetUpcoming
|
|
5762
|
-
* @summary get upcoming ipos info
|
|
5763
|
-
* @request GET:/ipos/upcoming
|
|
5764
|
-
* @secure
|
|
5765
|
-
*/
|
|
5766
|
-
getUpcoming(query: {
|
|
5767
|
-
/** how many records to return. Max value is 50 */
|
|
5768
|
-
limit: number;
|
|
5769
|
-
/** how many records to skip */
|
|
5770
|
-
offset: number;
|
|
5771
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOListResponse, HandleError>>;
|
|
5772
|
-
/**
|
|
5773
|
-
* @description get ipo info by symbol
|
|
5774
|
-
* @tags Ipos
|
|
5775
|
-
* @name GetIpos
|
|
5776
|
-
* @summary get ipo info by symbol
|
|
5777
|
-
* @request GET:/ipos/{symbol}
|
|
5778
|
-
* @secure
|
|
5779
|
-
*/
|
|
5780
|
-
getIpos(symbol: string, query?: {
|
|
5781
|
-
/** load quotes */
|
|
5782
|
-
load_quotes?: boolean;
|
|
5783
|
-
/** statuses */
|
|
5784
|
-
statuses?: string[];
|
|
5785
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
|
|
5786
|
-
}
|
|
5787
|
-
export class Logos<HandleError extends boolean = boolean> {
|
|
6260
|
+
export class Public<HandleError extends boolean = boolean> {
|
|
5788
6261
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5789
6262
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5790
6263
|
/**
|
|
5791
|
-
* @description
|
|
5792
|
-
* @tags
|
|
5793
|
-
* @name
|
|
5794
|
-
* @summary
|
|
5795
|
-
* @request
|
|
5796
|
-
* @secure
|
|
5797
|
-
*/
|
|
5798
|
-
logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5799
|
-
/**
|
|
5800
|
-
* @description Returns converted logo for symbol
|
|
5801
|
-
* @tags Logos
|
|
5802
|
-
* @name LogosConvertedSymbolLogo
|
|
5803
|
-
* @summary Get converted logo for symbol
|
|
5804
|
-
* @request POST:/logos/converted-symbol-logo
|
|
5805
|
-
* @secure
|
|
5806
|
-
*/
|
|
5807
|
-
logosConvertedSymbolLogo(filter: InsightSymbolLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5808
|
-
/**
|
|
5809
|
-
* @description Returns logo for crypto symbol
|
|
5810
|
-
* @tags Logos
|
|
5811
|
-
* @name LogosCryptoSymbolLogo
|
|
5812
|
-
* @summary Get logo for crypto symbol
|
|
5813
|
-
* @request GET:/logos/crypto-symbol-logo
|
|
5814
|
-
* @secure
|
|
5815
|
-
*/
|
|
5816
|
-
logosCryptoSymbolLogo(query: {
|
|
5817
|
-
/** Company symbol */
|
|
5818
|
-
symbol: string;
|
|
5819
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError>>;
|
|
5820
|
-
/**
|
|
5821
|
-
* @description Returns direct logo for crypto symbol
|
|
5822
|
-
* @tags Logos
|
|
5823
|
-
* @name LogosDirectCryptoSymbolLogo
|
|
5824
|
-
* @summary Get direct logo for crypto symbol
|
|
5825
|
-
* @request GET:/logos/direct-crypto-symbol-logo
|
|
5826
|
-
* @secure
|
|
5827
|
-
*/
|
|
5828
|
-
logosDirectCryptoSymbolLogo(query: {
|
|
5829
|
-
/** Company symbol */
|
|
5830
|
-
symbol: string;
|
|
5831
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5832
|
-
/**
|
|
5833
|
-
* @description Returns direct logo for symbol
|
|
5834
|
-
* @tags Logos
|
|
5835
|
-
* @name LogosDirectSymbolLogo
|
|
5836
|
-
* @summary Get direct logo for symbol
|
|
5837
|
-
* @request GET:/logos/direct-symbol-logo
|
|
5838
|
-
* @secure
|
|
5839
|
-
*/
|
|
5840
|
-
logosDirectSymbolLogo(query: {
|
|
5841
|
-
/** Company symbol */
|
|
5842
|
-
symbol: string;
|
|
5843
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5844
|
-
/**
|
|
5845
|
-
* @description Returns logos for multiple symbols
|
|
5846
|
-
* @tags Logos
|
|
5847
|
-
* @name LogosMultipleCryptoSymbolLogo
|
|
5848
|
-
* @summary Get logos for multiple symbols
|
|
5849
|
-
* @request POST:/logos/multiple-crypto-symbol-logo
|
|
5850
|
-
* @secure
|
|
5851
|
-
*/
|
|
5852
|
-
logosMultipleCryptoSymbolLogo(filter: InsightMultipleCryptoLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse[], HandleError>>;
|
|
5853
|
-
/**
|
|
5854
|
-
* @description Returns logos for multiple symbol
|
|
5855
|
-
* @tags Logos
|
|
5856
|
-
* @name LogosMultipleSymbolLogos
|
|
5857
|
-
* @summary Get logos for multiple symbols
|
|
5858
|
-
* @request POST:/logos/multiple-symbol-logos
|
|
5859
|
-
* @secure
|
|
5860
|
-
*/
|
|
5861
|
-
logosMultipleSymbolLogos(filter: InsightMultipleSymbolLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse[], HandleError>>;
|
|
5862
|
-
/**
|
|
5863
|
-
* @description Returns links of socials logos for symbol
|
|
5864
|
-
* @tags Logos
|
|
5865
|
-
* @name LogosSocialSymbolLogos
|
|
5866
|
-
* @summary Get social logos for symbol
|
|
5867
|
-
* @request GET:/logos/social-symbol-logos
|
|
5868
|
-
* @secure
|
|
5869
|
-
*/
|
|
5870
|
-
logosSocialSymbolLogos(query: {
|
|
5871
|
-
/** Company symbol */
|
|
5872
|
-
symbol: string;
|
|
5873
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
|
|
5874
|
-
/**
|
|
5875
|
-
* @description Returns logos for company symbol
|
|
5876
|
-
* @tags Logos
|
|
5877
|
-
* @name LogosSymbolLogos
|
|
5878
|
-
* @summary Get symbol logos
|
|
5879
|
-
* @request GET:/logos/symbol-logos
|
|
6264
|
+
* @description Calculate estimated returns for selected symbols. Uses split adjusted prices
|
|
6265
|
+
* @tags Public
|
|
6266
|
+
* @name CalculateEstimatedReturns
|
|
6267
|
+
* @summary Calculate Estimated Returns
|
|
6268
|
+
* @request GET:/public/estimated-returns
|
|
5880
6269
|
* @secure
|
|
5881
6270
|
*/
|
|
5882
|
-
|
|
5883
|
-
/**
|
|
6271
|
+
calculateEstimatedReturns(query: {
|
|
6272
|
+
/** Single symbol */
|
|
5884
6273
|
symbol: string;
|
|
5885
|
-
|
|
5886
|
-
|
|
5887
|
-
|
|
5888
|
-
|
|
5889
|
-
|
|
5890
|
-
|
|
5891
|
-
|
|
5892
|
-
|
|
5893
|
-
|
|
5894
|
-
|
|
5895
|
-
* @request POST:/news/authors
|
|
5896
|
-
* @secure
|
|
5897
|
-
*/
|
|
5898
|
-
newsAvailableAuthors(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5899
|
-
/**
|
|
5900
|
-
* @description Returns available channels in DB
|
|
5901
|
-
* @tags News
|
|
5902
|
-
* @name NewsAvailableChannels
|
|
5903
|
-
* @summary Get available channels in DB (for filters)
|
|
5904
|
-
* @request POST:/news/channels
|
|
5905
|
-
* @secure
|
|
5906
|
-
*/
|
|
5907
|
-
newsAvailableChannels(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5908
|
-
/**
|
|
5909
|
-
* @description Get featured articles
|
|
5910
|
-
* @tags News
|
|
5911
|
-
* @name GetFeaturedArticles
|
|
5912
|
-
* @summary Get featured articles
|
|
5913
|
-
* @request GET:/news/featured-articles
|
|
5914
|
-
* @secure
|
|
5915
|
-
*/
|
|
5916
|
-
getFeaturedArticles(query: {
|
|
5917
|
-
/** Limit */
|
|
5918
|
-
limit: number;
|
|
5919
|
-
/** Offset */
|
|
5920
|
-
offset: number;
|
|
5921
|
-
/** Start date */
|
|
5922
|
-
start_date?: string;
|
|
5923
|
-
/** End date */
|
|
5924
|
-
end_date?: string;
|
|
5925
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFeaturedArticlesResponse, HandleError>>;
|
|
5926
|
-
/**
|
|
5927
|
-
* @description Update featured articles
|
|
5928
|
-
* @tags News
|
|
5929
|
-
* @name UpdateFeaturedArticles
|
|
5930
|
-
* @summary Update featured articles
|
|
5931
|
-
* @request PUT:/news/featured-articles
|
|
5932
|
-
* @secure
|
|
5933
|
-
*/
|
|
5934
|
-
updateFeaturedArticles(input: InsightUpdateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5935
|
-
/**
|
|
5936
|
-
* @description Create featured articles
|
|
5937
|
-
* @tags News
|
|
5938
|
-
* @name CreateFeaturedArticles
|
|
5939
|
-
* @summary Create featured articles
|
|
5940
|
-
* @request POST:/news/featured-articles
|
|
5941
|
-
* @secure
|
|
5942
|
-
*/
|
|
5943
|
-
createFeaturedArticles(input: InsightCreateFeaturedArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6274
|
+
/**
|
|
6275
|
+
* Non-zero amount
|
|
6276
|
+
* @format float64
|
|
6277
|
+
*/
|
|
6278
|
+
amount: number;
|
|
6279
|
+
/** Start date for calculations */
|
|
6280
|
+
start_date: string;
|
|
6281
|
+
/** End date for calculations */
|
|
6282
|
+
end_date: string;
|
|
6283
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
|
|
5944
6284
|
/**
|
|
5945
|
-
* @description
|
|
5946
|
-
* @tags
|
|
5947
|
-
* @name
|
|
5948
|
-
* @summary
|
|
5949
|
-
* @request GET:/
|
|
6285
|
+
* @description Returns an expert forecast
|
|
6286
|
+
* @tags Public
|
|
6287
|
+
* @name ExpertForecast
|
|
6288
|
+
* @summary Expert forecast
|
|
6289
|
+
* @request GET:/public/expert-forecast
|
|
5950
6290
|
* @secure
|
|
5951
6291
|
*/
|
|
5952
|
-
|
|
6292
|
+
expertForecast(query: {
|
|
6293
|
+
/** Comma separated symbols */
|
|
6294
|
+
symbols: string;
|
|
6295
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
|
|
5953
6296
|
/**
|
|
5954
|
-
* @description
|
|
5955
|
-
* @tags
|
|
5956
|
-
* @name
|
|
5957
|
-
* @summary
|
|
5958
|
-
* @request
|
|
6297
|
+
* @description get fundamentals by symbol data
|
|
6298
|
+
* @tags Public
|
|
6299
|
+
* @name GetPublicFundamentalsBySymbolData
|
|
6300
|
+
* @summary get fundamentals by symbol data
|
|
6301
|
+
* @request GET:/public/fundamentals/{symbol}
|
|
5959
6302
|
* @secure
|
|
5960
6303
|
*/
|
|
5961
|
-
|
|
6304
|
+
getPublicFundamentalsBySymbolData(symbol: string, query: {
|
|
6305
|
+
/** Annual or quarterly */
|
|
6306
|
+
mode: string;
|
|
6307
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
5962
6308
|
/**
|
|
5963
|
-
* @description
|
|
5964
|
-
* @tags
|
|
5965
|
-
* @name
|
|
5966
|
-
* @summary
|
|
5967
|
-
* @request GET:/
|
|
6309
|
+
* @description Daily price history
|
|
6310
|
+
* @tags Public
|
|
6311
|
+
* @name DailyPriceHistory
|
|
6312
|
+
* @summary Daily price history
|
|
6313
|
+
* @request GET:/public/price-history/daily
|
|
5968
6314
|
* @secure
|
|
5969
6315
|
*/
|
|
5970
|
-
|
|
6316
|
+
dailyPriceHistory(query: {
|
|
6317
|
+
/** Single symbol */
|
|
6318
|
+
symbol: string;
|
|
6319
|
+
/** Target date */
|
|
6320
|
+
date: string;
|
|
6321
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
|
|
5971
6322
|
/**
|
|
5972
|
-
* @description
|
|
5973
|
-
* @tags
|
|
5974
|
-
* @name
|
|
5975
|
-
* @summary
|
|
5976
|
-
* @request
|
|
6323
|
+
* @description Public quote profile
|
|
6324
|
+
* @tags Public
|
|
6325
|
+
* @name PublicQuoteProfile
|
|
6326
|
+
* @summary Public quote profile
|
|
6327
|
+
* @request GET:/public/quote-profile/{symbol}
|
|
5977
6328
|
* @secure
|
|
5978
6329
|
*/
|
|
5979
|
-
|
|
6330
|
+
publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
|
|
5980
6331
|
/**
|
|
5981
|
-
* @description
|
|
5982
|
-
* @tags
|
|
5983
|
-
* @name
|
|
5984
|
-
* @summary
|
|
5985
|
-
* @request
|
|
6332
|
+
* @description get ratios by symbol data
|
|
6333
|
+
* @tags Public
|
|
6334
|
+
* @name GetPublicRatiosBySymbolData
|
|
6335
|
+
* @summary get ratios by symbol data
|
|
6336
|
+
* @request GET:/public/ratios/{symbol}
|
|
5986
6337
|
* @secure
|
|
5987
6338
|
*/
|
|
5988
|
-
|
|
6339
|
+
getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
|
|
5989
6340
|
/**
|
|
5990
|
-
* @description
|
|
5991
|
-
* @tags
|
|
5992
|
-
* @name
|
|
5993
|
-
* @summary
|
|
5994
|
-
* @request GET:/
|
|
6341
|
+
* @description find a symbol by name or description
|
|
6342
|
+
* @tags Public
|
|
6343
|
+
* @name QuoteFundamentalsSearch
|
|
6344
|
+
* @summary find a symbol by name or description
|
|
6345
|
+
* @request GET:/public/symbol-search
|
|
5995
6346
|
* @secure
|
|
5996
6347
|
*/
|
|
5997
|
-
|
|
5998
|
-
/**
|
|
5999
|
-
|
|
6000
|
-
/** End date */
|
|
6001
|
-
end_date?: string;
|
|
6002
|
-
/** Symbol */
|
|
6003
|
-
symbol?: string;
|
|
6348
|
+
quoteFundamentalsSearch(query: {
|
|
6349
|
+
/** Search query */
|
|
6350
|
+
search_query: string;
|
|
6004
6351
|
/** how many records to return. Max value is 50 */
|
|
6005
6352
|
limit: number;
|
|
6006
6353
|
/** how many records to skip */
|
|
6007
6354
|
offset: number;
|
|
6008
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
6009
|
-
/**
|
|
6010
|
-
* @description Returns available stocks in DB
|
|
6011
|
-
* @tags News
|
|
6012
|
-
* @name NewsAvailableStocks
|
|
6013
|
-
* @summary Get available stocks in DB (for filters)
|
|
6014
|
-
* @request GET:/news/symbols
|
|
6015
|
-
* @secure
|
|
6016
|
-
*/
|
|
6017
|
-
newsAvailableStocks(query?: {
|
|
6018
|
-
/** Limit */
|
|
6019
|
-
limit?: number;
|
|
6020
|
-
/** Offset */
|
|
6021
|
-
offset?: number;
|
|
6022
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
6023
|
-
/**
|
|
6024
|
-
* @description Returns available tags in DB
|
|
6025
|
-
* @tags News
|
|
6026
|
-
* @name NewsAvailableTags
|
|
6027
|
-
* @summary Get available tags in DB (for filters)
|
|
6028
|
-
* @request POST:/news/tags
|
|
6029
|
-
* @secure
|
|
6030
|
-
*/
|
|
6031
|
-
newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
6032
|
-
}
|
|
6033
|
-
export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
6034
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6035
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6355
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
|
|
6036
6356
|
/**
|
|
6037
|
-
* @description
|
|
6038
|
-
* @tags
|
|
6039
|
-
* @name
|
|
6040
|
-
* @summary
|
|
6041
|
-
* @request
|
|
6357
|
+
* @description Get top gainers
|
|
6358
|
+
* @tags Public
|
|
6359
|
+
* @name TopGainers
|
|
6360
|
+
* @summary Top Gainers
|
|
6361
|
+
* @request GET:/public/top-gainers
|
|
6042
6362
|
* @secure
|
|
6043
6363
|
*/
|
|
6044
|
-
|
|
6364
|
+
topGainers(query: {
|
|
6365
|
+
/** sort direction - asc or desc */
|
|
6366
|
+
order_direction?: string;
|
|
6367
|
+
/** how many records to return. Max value is 50 */
|
|
6368
|
+
limit: number;
|
|
6369
|
+
/** how many records to skip */
|
|
6370
|
+
offset: number;
|
|
6371
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6045
6372
|
/**
|
|
6046
|
-
* @description
|
|
6047
|
-
* @tags
|
|
6048
|
-
* @name
|
|
6049
|
-
* @summary
|
|
6050
|
-
* @request
|
|
6373
|
+
* @description Get top stocks
|
|
6374
|
+
* @tags Public
|
|
6375
|
+
* @name TopStocks
|
|
6376
|
+
* @summary Top Stocks
|
|
6377
|
+
* @request GET:/public/top-stocks
|
|
6051
6378
|
* @secure
|
|
6052
6379
|
*/
|
|
6053
|
-
|
|
6380
|
+
topStocks(query: {
|
|
6381
|
+
/** EQUITY|ETF|CRYPTO */
|
|
6382
|
+
stock_type: InsightTopStocksParamsStockTypeEnum;
|
|
6383
|
+
/** how many records to return. Max value is 50 */
|
|
6384
|
+
limit: number;
|
|
6385
|
+
/** how many records to skip */
|
|
6386
|
+
offset: number;
|
|
6387
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6054
6388
|
}
|
|
6055
|
-
export class
|
|
6389
|
+
export class Quotes<HandleError extends boolean = boolean> {
|
|
6056
6390
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6057
6391
|
constructor(apiClient: JwtClient<HandleError>);
|
|
6058
6392
|
/**
|
|
6059
|
-
* @description
|
|
6060
|
-
* @tags
|
|
6061
|
-
* @name
|
|
6062
|
-
* @summary
|
|
6063
|
-
* @request
|
|
6393
|
+
* @description Get single historical quote
|
|
6394
|
+
* @tags Quotes
|
|
6395
|
+
* @name GitHistoricalQuote
|
|
6396
|
+
* @summary Get single historical quote
|
|
6397
|
+
* @request GET:/historical/quote
|
|
6064
6398
|
* @secure
|
|
6065
6399
|
*/
|
|
6066
|
-
|
|
6400
|
+
gitHistoricalQuote(query: {
|
|
6401
|
+
/** Symbol */
|
|
6402
|
+
symbol: string;
|
|
6403
|
+
/** Date */
|
|
6404
|
+
date: string;
|
|
6405
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
|
|
6067
6406
|
/**
|
|
6068
|
-
* @description
|
|
6069
|
-
* @tags
|
|
6070
|
-
* @name
|
|
6071
|
-
* @summary
|
|
6072
|
-
* @request
|
|
6407
|
+
* @description get quote history by symbol
|
|
6408
|
+
* @tags Quotes
|
|
6409
|
+
* @name GitQuoteHistory
|
|
6410
|
+
* @summary Get quote history
|
|
6411
|
+
* @request POST:/quote-history
|
|
6073
6412
|
* @secure
|
|
6074
6413
|
*/
|
|
6075
|
-
|
|
6414
|
+
gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
|
|
6076
6415
|
/**
|
|
6077
|
-
* @description
|
|
6078
|
-
* @tags
|
|
6079
|
-
* @name
|
|
6080
|
-
* @summary Get
|
|
6081
|
-
* @request
|
|
6416
|
+
* @description Returns a list of quotes equity info for specified symbols.
|
|
6417
|
+
* @tags Quotes
|
|
6418
|
+
* @name GetQuotesEquityData
|
|
6419
|
+
* @summary Get Quotes Equity data
|
|
6420
|
+
* @request GET:/quotes/equity
|
|
6082
6421
|
* @secure
|
|
6083
6422
|
*/
|
|
6084
|
-
|
|
6423
|
+
getQuotesEquityData(query: {
|
|
6424
|
+
/** Comma separated symbols */
|
|
6425
|
+
symbols: string;
|
|
6426
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
|
|
6427
|
+
}
|
|
6428
|
+
export class StockScreener<HandleError extends boolean = boolean> {
|
|
6429
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6430
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6085
6431
|
/**
|
|
6086
|
-
* @description
|
|
6087
|
-
* @tags
|
|
6088
|
-
* @name
|
|
6089
|
-
* @summary
|
|
6090
|
-
* @request GET:/
|
|
6432
|
+
* @description data for visual heat map
|
|
6433
|
+
* @tags StockScreener
|
|
6434
|
+
* @name StockMarketHeatmap
|
|
6435
|
+
* @summary data for visual heat map
|
|
6436
|
+
* @request GET:/heatmaps
|
|
6091
6437
|
* @secure
|
|
6092
6438
|
*/
|
|
6093
|
-
|
|
6439
|
+
stockMarketHeatmap(query?: {
|
|
6440
|
+
/** Name of symbol list to fetch details for. Empty is default */
|
|
6441
|
+
heatmap_name?: string;
|
|
6442
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
|
|
6094
6443
|
/**
|
|
6095
|
-
* @description
|
|
6096
|
-
* @tags
|
|
6097
|
-
* @name
|
|
6098
|
-
* @summary
|
|
6099
|
-
* @request POST:/
|
|
6444
|
+
* @description create or update heat map preset
|
|
6445
|
+
* @tags StockScreener
|
|
6446
|
+
* @name CreateStockMarketHeatmapPreset
|
|
6447
|
+
* @summary create or update heat map preset
|
|
6448
|
+
* @request POST:/heatmaps
|
|
6100
6449
|
* @secure
|
|
6101
6450
|
*/
|
|
6102
|
-
|
|
6451
|
+
createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6103
6452
|
/**
|
|
6104
|
-
* @description
|
|
6105
|
-
* @tags
|
|
6106
|
-
* @name
|
|
6107
|
-
* @summary
|
|
6108
|
-
* @request
|
|
6453
|
+
* @description Sector and Industry Group performance
|
|
6454
|
+
* @tags StockScreener
|
|
6455
|
+
* @name IndustriesPerformance
|
|
6456
|
+
* @summary get industries performance
|
|
6457
|
+
* @request POST:/industries-performance
|
|
6109
6458
|
* @secure
|
|
6110
6459
|
*/
|
|
6111
|
-
|
|
6460
|
+
industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
|
|
6112
6461
|
/**
|
|
6113
|
-
* @description
|
|
6114
|
-
* @tags
|
|
6115
|
-
* @name
|
|
6116
|
-
* @summary
|
|
6117
|
-
* @request
|
|
6462
|
+
* @description filter stocks by params
|
|
6463
|
+
* @tags StockScreener
|
|
6464
|
+
* @name StockScreener
|
|
6465
|
+
* @summary filter stocks by params
|
|
6466
|
+
* @request POST:/stock-screener
|
|
6118
6467
|
* @secure
|
|
6119
6468
|
*/
|
|
6120
|
-
|
|
6469
|
+
stockScreener(filter: InsightStockScreenerV1Request, headers?: {
|
|
6470
|
+
/** Authorization */
|
|
6471
|
+
Authorization?: string;
|
|
6472
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
6121
6473
|
/**
|
|
6122
|
-
* @description
|
|
6123
|
-
* @tags
|
|
6124
|
-
* @name
|
|
6125
|
-
* @summary
|
|
6126
|
-
* @request
|
|
6474
|
+
* @description get screener presets
|
|
6475
|
+
* @tags StockScreener
|
|
6476
|
+
* @name GetScreenerPresets
|
|
6477
|
+
* @summary get screener presets
|
|
6478
|
+
* @request GET:/stock-screener/presets
|
|
6127
6479
|
* @secure
|
|
6128
6480
|
*/
|
|
6129
|
-
|
|
6481
|
+
getScreenerPresets(query: {
|
|
6482
|
+
/** how many records to return */
|
|
6483
|
+
limit: number;
|
|
6484
|
+
/** how many records to skip */
|
|
6485
|
+
offset: number;
|
|
6486
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
6130
6487
|
/**
|
|
6131
|
-
* @description
|
|
6132
|
-
* @tags
|
|
6133
|
-
* @name
|
|
6134
|
-
* @summary
|
|
6135
|
-
* @request
|
|
6488
|
+
* @description update screener preset
|
|
6489
|
+
* @tags StockScreener
|
|
6490
|
+
* @name UpdateScreenerPreset
|
|
6491
|
+
* @summary update screener preset
|
|
6492
|
+
* @request PUT:/stock-screener/presets
|
|
6136
6493
|
* @secure
|
|
6137
6494
|
*/
|
|
6138
|
-
|
|
6495
|
+
updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
6139
6496
|
/**
|
|
6140
|
-
* @description
|
|
6141
|
-
* @tags
|
|
6142
|
-
* @name
|
|
6143
|
-
* @summary
|
|
6144
|
-
* @request
|
|
6497
|
+
* @description create screener preset
|
|
6498
|
+
* @tags StockScreener
|
|
6499
|
+
* @name CreateOrScreenerPreset
|
|
6500
|
+
* @summary create screener preset
|
|
6501
|
+
* @request POST:/stock-screener/presets
|
|
6145
6502
|
* @secure
|
|
6146
6503
|
*/
|
|
6147
|
-
|
|
6504
|
+
createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
6148
6505
|
/**
|
|
6149
|
-
* @description
|
|
6150
|
-
* @tags
|
|
6151
|
-
* @name
|
|
6152
|
-
* @summary
|
|
6153
|
-
* @request
|
|
6506
|
+
* @description remove screener preset
|
|
6507
|
+
* @tags StockScreener
|
|
6508
|
+
* @name RemoveScreenerPreset
|
|
6509
|
+
* @summary remove screener preset
|
|
6510
|
+
* @request DELETE:/stock-screener/presets
|
|
6154
6511
|
* @secure
|
|
6155
6512
|
*/
|
|
6156
|
-
|
|
6157
|
-
/** Market codes, comma separated */
|
|
6158
|
-
market?: string;
|
|
6159
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse[][], HandleError>>;
|
|
6513
|
+
removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6160
6514
|
/**
|
|
6161
|
-
* @description
|
|
6162
|
-
* @tags
|
|
6163
|
-
* @name
|
|
6164
|
-
* @summary
|
|
6165
|
-
* @request
|
|
6515
|
+
* @description get top symbols
|
|
6516
|
+
* @tags StockScreener
|
|
6517
|
+
* @name GetTopSymbols
|
|
6518
|
+
* @summary get top symbols
|
|
6519
|
+
* @request POST:/stock-screener/top
|
|
6166
6520
|
* @secure
|
|
6167
6521
|
*/
|
|
6168
|
-
|
|
6169
|
-
/** Market */
|
|
6170
|
-
market: string;
|
|
6171
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketHoursResponse, HandleError>>;
|
|
6522
|
+
getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
6172
6523
|
}
|
|
6173
|
-
export class
|
|
6524
|
+
export class StockScreenerV2<HandleError extends boolean = boolean> {
|
|
6174
6525
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6175
6526
|
constructor(apiClient: JwtClient<HandleError>);
|
|
6176
6527
|
/**
|
|
6177
|
-
* @description
|
|
6178
|
-
* @tags
|
|
6179
|
-
* @name
|
|
6180
|
-
* @summary
|
|
6181
|
-
* @request POST:/
|
|
6528
|
+
* @description filter stocks by params
|
|
6529
|
+
* @tags StockScreener
|
|
6530
|
+
* @name StockScreener
|
|
6531
|
+
* @summary filter stocks by params
|
|
6532
|
+
* @request POST:/stock-screener
|
|
6182
6533
|
* @secure
|
|
6183
6534
|
*/
|
|
6184
|
-
|
|
6535
|
+
stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
6185
6536
|
/**
|
|
6186
|
-
* @description get
|
|
6187
|
-
* @tags
|
|
6188
|
-
* @name
|
|
6189
|
-
* @summary get
|
|
6190
|
-
* @request POST:/
|
|
6537
|
+
* @description get top symbols
|
|
6538
|
+
* @tags StockScreener
|
|
6539
|
+
* @name GetTopSymbols
|
|
6540
|
+
* @summary get top symbols
|
|
6541
|
+
* @request POST:/stock-screener/top
|
|
6191
6542
|
* @secure
|
|
6192
6543
|
*/
|
|
6193
|
-
|
|
6544
|
+
getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
6194
6545
|
}
|
|
6195
6546
|
export class TipRank<HandleError extends boolean = boolean> {
|
|
6196
6547
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -6516,533 +6867,242 @@ export class TipRank<HandleError extends boolean = boolean> {
|
|
|
6516
6867
|
*/
|
|
6517
6868
|
tiprankStocksTopMovers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksTopMoversResponse[], HandleError>>;
|
|
6518
6869
|
/**
|
|
6519
|
-
* @description Returns the stock symbols covered by TipRanks.
|
|
6520
|
-
* @tags TipRank
|
|
6521
|
-
* @name TiprankSupportedTickers
|
|
6522
|
-
* @summary Get tiprank SupportedTickers
|
|
6523
|
-
* @request GET:/tipranks/supported-tickers
|
|
6524
|
-
* @secure
|
|
6525
|
-
*/
|
|
6526
|
-
tiprankSupportedTickers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSupportedTickersResponse, HandleError>>;
|
|
6527
|
-
/**
|
|
6528
|
-
* @description Returns a list of stocks that have the strongest consensus ratings (Strong Buy or Strong Sell) amongst top-ranked analysts (ranked 3.5 stars or higher).
|
|
6529
|
-
* @tags TipRank
|
|
6530
|
-
* @name TiprankTopRateStocks
|
|
6531
|
-
* @summary Get tiprank TopRateStocks
|
|
6532
|
-
* @request GET:/tipranks/top-rate-stocks
|
|
6533
|
-
* @secure
|
|
6534
|
-
*/
|
|
6535
|
-
tiprankTopRateStocks(query?: {
|
|
6536
|
-
/** Return the most trending X stocks */
|
|
6537
|
-
num?: number;
|
|
6538
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopRateStocksResponse, HandleError>>;
|
|
6539
|
-
/**
|
|
6540
|
-
* @description Returns the top-rated stocks by the sector of the given ticker. The API call returns top stocks by analysts, bloggers, insiders, hedge funds, news sentiment and individual investor sentiment.
|
|
6541
|
-
* @tags TipRank
|
|
6542
|
-
* @name TiprankTopStocksBySectors
|
|
6543
|
-
* @summary Get tiprank TopStocksBySectors
|
|
6544
|
-
* @request POST:/tipranks/top-stocks-by-sectors
|
|
6545
|
-
* @secure
|
|
6546
|
-
*/
|
|
6547
|
-
tiprankTopStocksBySectors(filter: InsightTopStocksBySectorsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksBySectorsResponse, HandleError>>;
|
|
6548
|
-
/**
|
|
6549
|
-
* @description Returns a list of stocks with the highest number of analyst ratings in the last 7 days.
|
|
6550
|
-
* @tags TipRank
|
|
6551
|
-
* @name TiprankTrendingStocks
|
|
6552
|
-
* @summary Get tiprank TrendingStocks
|
|
6553
|
-
* @request POST:/tipranks/trending-stocks
|
|
6554
|
-
* @secure
|
|
6555
|
-
*/
|
|
6556
|
-
tiprankTrendingStocks(filter: InsightTrendingStocksRequest, headers?: {
|
|
6557
|
-
/** Authorization */
|
|
6558
|
-
Authorization?: string;
|
|
6559
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
|
|
6560
|
-
}
|
|
6561
|
-
export class UsageTracking<HandleError extends boolean = boolean> {
|
|
6562
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6563
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6564
|
-
/**
|
|
6565
|
-
* @description get usage date per branch for a period
|
|
6566
|
-
* @tags UsageTracking
|
|
6567
|
-
* @name GetUsageData
|
|
6568
|
-
* @summary get insight usage data
|
|
6569
|
-
* @request POST:/tracking/usage
|
|
6570
|
-
* @secure
|
|
6571
|
-
*/
|
|
6572
|
-
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
|
|
6573
|
-
}
|
|
6574
|
-
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
6575
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6576
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6577
|
-
/**
|
|
6578
|
-
* @description get seasonlity data with comparison to benchmark
|
|
6579
|
-
* @tags AlphaTools
|
|
6580
|
-
* @name GetMomentumRatioGraph
|
|
6581
|
-
* @summary get seasonlity data
|
|
6582
|
-
* @request POST:/rst
|
|
6583
|
-
* @secure
|
|
6584
|
-
*/
|
|
6585
|
-
getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
|
|
6586
|
-
/**
|
|
6587
|
-
* @description get seasonlity data with comparison to benchmark
|
|
6588
|
-
* @tags AlphaTools
|
|
6589
|
-
* @name GetSeasonality
|
|
6590
|
-
* @summary get seasonlity data
|
|
6591
|
-
* @request POST:/seasonality
|
|
6592
|
-
* @secure
|
|
6593
|
-
*/
|
|
6594
|
-
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
|
|
6595
|
-
}
|
|
6596
|
-
export class Public<HandleError extends boolean = boolean> {
|
|
6597
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6598
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6599
|
-
/**
|
|
6600
|
-
* @description Calculate estimated returns for selected symbols. Uses split adjusted prices
|
|
6601
|
-
* @tags Public
|
|
6602
|
-
* @name CalculateEstimatedReturns
|
|
6603
|
-
* @summary Calculate Estimated Returns
|
|
6604
|
-
* @request GET:/public/estimated-returns
|
|
6605
|
-
* @secure
|
|
6606
|
-
*/
|
|
6607
|
-
calculateEstimatedReturns(query: {
|
|
6608
|
-
/** Single symbol */
|
|
6609
|
-
symbol: string;
|
|
6610
|
-
/**
|
|
6611
|
-
* Non-zero amount
|
|
6612
|
-
* @format float64
|
|
6613
|
-
*/
|
|
6614
|
-
amount: number;
|
|
6615
|
-
/** Start date for calculations */
|
|
6616
|
-
start_date: string;
|
|
6617
|
-
/** End date for calculations */
|
|
6618
|
-
end_date: string;
|
|
6619
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
|
|
6620
|
-
/**
|
|
6621
|
-
* @description Returns an expert forecast
|
|
6622
|
-
* @tags Public
|
|
6623
|
-
* @name ExpertForecast
|
|
6624
|
-
* @summary Expert forecast
|
|
6625
|
-
* @request GET:/public/expert-forecast
|
|
6626
|
-
* @secure
|
|
6627
|
-
*/
|
|
6628
|
-
expertForecast(query: {
|
|
6629
|
-
/** Comma separated symbols */
|
|
6630
|
-
symbols: string;
|
|
6631
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
|
|
6632
|
-
/**
|
|
6633
|
-
* @description get fundamentals by symbol data
|
|
6634
|
-
* @tags Public
|
|
6635
|
-
* @name GetPublicFundamentalsBySymbolData
|
|
6636
|
-
* @summary get fundamentals by symbol data
|
|
6637
|
-
* @request GET:/public/fundamentals/{symbol}
|
|
6638
|
-
* @secure
|
|
6639
|
-
*/
|
|
6640
|
-
getPublicFundamentalsBySymbolData(symbol: string, query: {
|
|
6641
|
-
/** Annual or quarterly */
|
|
6642
|
-
mode: string;
|
|
6643
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
6644
|
-
/**
|
|
6645
|
-
* @description Daily price history
|
|
6646
|
-
* @tags Public
|
|
6647
|
-
* @name DailyPriceHistory
|
|
6648
|
-
* @summary Daily price history
|
|
6649
|
-
* @request GET:/public/price-history/daily
|
|
6650
|
-
* @secure
|
|
6651
|
-
*/
|
|
6652
|
-
dailyPriceHistory(query: {
|
|
6653
|
-
/** Single symbol */
|
|
6654
|
-
symbol: string;
|
|
6655
|
-
/** Target date */
|
|
6656
|
-
date: string;
|
|
6657
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
|
|
6658
|
-
/**
|
|
6659
|
-
* @description Public quote profile
|
|
6660
|
-
* @tags Public
|
|
6661
|
-
* @name PublicQuoteProfile
|
|
6662
|
-
* @summary Public quote profile
|
|
6663
|
-
* @request GET:/public/quote-profile/{symbol}
|
|
6664
|
-
* @secure
|
|
6665
|
-
*/
|
|
6666
|
-
publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
|
|
6667
|
-
/**
|
|
6668
|
-
* @description get ratios by symbol data
|
|
6669
|
-
* @tags Public
|
|
6670
|
-
* @name GetPublicRatiosBySymbolData
|
|
6671
|
-
* @summary get ratios by symbol data
|
|
6672
|
-
* @request GET:/public/ratios/{symbol}
|
|
6870
|
+
* @description Returns the stock symbols covered by TipRanks.
|
|
6871
|
+
* @tags TipRank
|
|
6872
|
+
* @name TiprankSupportedTickers
|
|
6873
|
+
* @summary Get tiprank SupportedTickers
|
|
6874
|
+
* @request GET:/tipranks/supported-tickers
|
|
6673
6875
|
* @secure
|
|
6674
6876
|
*/
|
|
6675
|
-
|
|
6877
|
+
tiprankSupportedTickers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSupportedTickersResponse, HandleError>>;
|
|
6676
6878
|
/**
|
|
6677
|
-
* @description
|
|
6678
|
-
* @tags
|
|
6679
|
-
* @name
|
|
6680
|
-
* @summary
|
|
6681
|
-
* @request GET:/
|
|
6879
|
+
* @description Returns a list of stocks that have the strongest consensus ratings (Strong Buy or Strong Sell) amongst top-ranked analysts (ranked 3.5 stars or higher).
|
|
6880
|
+
* @tags TipRank
|
|
6881
|
+
* @name TiprankTopRateStocks
|
|
6882
|
+
* @summary Get tiprank TopRateStocks
|
|
6883
|
+
* @request GET:/tipranks/top-rate-stocks
|
|
6682
6884
|
* @secure
|
|
6683
6885
|
*/
|
|
6684
|
-
|
|
6685
|
-
/**
|
|
6686
|
-
|
|
6687
|
-
|
|
6688
|
-
limit: number;
|
|
6689
|
-
/** how many records to skip */
|
|
6690
|
-
offset: number;
|
|
6691
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
|
|
6886
|
+
tiprankTopRateStocks(query?: {
|
|
6887
|
+
/** Return the most trending X stocks */
|
|
6888
|
+
num?: number;
|
|
6889
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopRateStocksResponse, HandleError>>;
|
|
6692
6890
|
/**
|
|
6693
|
-
* @description
|
|
6694
|
-
* @tags
|
|
6695
|
-
* @name
|
|
6696
|
-
* @summary
|
|
6697
|
-
* @request
|
|
6891
|
+
* @description Returns the top-rated stocks by the sector of the given ticker. The API call returns top stocks by analysts, bloggers, insiders, hedge funds, news sentiment and individual investor sentiment.
|
|
6892
|
+
* @tags TipRank
|
|
6893
|
+
* @name TiprankTopStocksBySectors
|
|
6894
|
+
* @summary Get tiprank TopStocksBySectors
|
|
6895
|
+
* @request POST:/tipranks/top-stocks-by-sectors
|
|
6698
6896
|
* @secure
|
|
6699
6897
|
*/
|
|
6700
|
-
|
|
6701
|
-
/** sort direction - asc or desc */
|
|
6702
|
-
order_direction?: string;
|
|
6703
|
-
/** how many records to return. Max value is 50 */
|
|
6704
|
-
limit: number;
|
|
6705
|
-
/** how many records to skip */
|
|
6706
|
-
offset: number;
|
|
6707
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6898
|
+
tiprankTopStocksBySectors(filter: InsightTopStocksBySectorsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksBySectorsResponse, HandleError>>;
|
|
6708
6899
|
/**
|
|
6709
|
-
* @description
|
|
6710
|
-
* @tags
|
|
6711
|
-
* @name
|
|
6712
|
-
* @summary
|
|
6713
|
-
* @request
|
|
6900
|
+
* @description Returns a list of stocks with the highest number of analyst ratings in the last 7 days.
|
|
6901
|
+
* @tags TipRank
|
|
6902
|
+
* @name TiprankTrendingStocks
|
|
6903
|
+
* @summary Get tiprank TrendingStocks
|
|
6904
|
+
* @request POST:/tipranks/trending-stocks
|
|
6714
6905
|
* @secure
|
|
6715
6906
|
*/
|
|
6716
|
-
|
|
6717
|
-
/**
|
|
6718
|
-
|
|
6719
|
-
|
|
6720
|
-
limit: number;
|
|
6721
|
-
/** how many records to skip */
|
|
6722
|
-
offset: number;
|
|
6723
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6907
|
+
tiprankTrendingStocks(filter: InsightTrendingStocksRequest, headers?: {
|
|
6908
|
+
/** Authorization */
|
|
6909
|
+
Authorization?: string;
|
|
6910
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
|
|
6724
6911
|
}
|
|
6725
|
-
export class
|
|
6912
|
+
export class UsageTracking<HandleError extends boolean = boolean> {
|
|
6726
6913
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6727
6914
|
constructor(apiClient: JwtClient<HandleError>);
|
|
6728
6915
|
/**
|
|
6729
|
-
* @description
|
|
6730
|
-
* @tags
|
|
6731
|
-
* @name
|
|
6732
|
-
* @summary
|
|
6733
|
-
* @request POST:/
|
|
6916
|
+
* @description get usage date per branch for a period
|
|
6917
|
+
* @tags UsageTracking
|
|
6918
|
+
* @name GetUsageData
|
|
6919
|
+
* @summary get insight usage data
|
|
6920
|
+
* @request POST:/tracking/usage
|
|
6734
6921
|
* @secure
|
|
6735
6922
|
*/
|
|
6736
|
-
|
|
6923
|
+
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
|
|
6924
|
+
}
|
|
6925
|
+
export class WorldMarkets<HandleError extends boolean = boolean> {
|
|
6926
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6927
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6737
6928
|
/**
|
|
6738
|
-
* @description
|
|
6739
|
-
* @tags
|
|
6740
|
-
* @name
|
|
6741
|
-
* @summary Get
|
|
6742
|
-
* @request
|
|
6929
|
+
* @description Get continents
|
|
6930
|
+
* @tags World Markets
|
|
6931
|
+
* @name ContinentGet
|
|
6932
|
+
* @summary Get continents
|
|
6933
|
+
* @request GET:/continents
|
|
6743
6934
|
* @secure
|
|
6744
6935
|
*/
|
|
6745
|
-
|
|
6936
|
+
continentGet(query: {
|
|
6937
|
+
/** Query limit */
|
|
6938
|
+
limit: number;
|
|
6939
|
+
/** Query offset */
|
|
6940
|
+
offset: number;
|
|
6941
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
6746
6942
|
/**
|
|
6747
|
-
* @description
|
|
6748
|
-
* @tags
|
|
6749
|
-
* @name
|
|
6750
|
-
* @summary
|
|
6751
|
-
* @request
|
|
6943
|
+
* @description Edit continent
|
|
6944
|
+
* @tags World Markets
|
|
6945
|
+
* @name ContinentEdit
|
|
6946
|
+
* @summary Edit continent
|
|
6947
|
+
* @request PUT:/continents
|
|
6752
6948
|
* @secure
|
|
6753
6949
|
*/
|
|
6754
|
-
|
|
6950
|
+
continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6755
6951
|
/**
|
|
6756
|
-
* @description
|
|
6757
|
-
* @tags
|
|
6758
|
-
* @name
|
|
6759
|
-
* @summary
|
|
6760
|
-
* @request POST:/
|
|
6952
|
+
* @description Create continents
|
|
6953
|
+
* @tags World Markets
|
|
6954
|
+
* @name ContinentCreate
|
|
6955
|
+
* @summary Create continents
|
|
6956
|
+
* @request POST:/continents
|
|
6761
6957
|
* @secure
|
|
6762
6958
|
*/
|
|
6763
|
-
|
|
6959
|
+
continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
6764
6960
|
/**
|
|
6765
|
-
* @description
|
|
6766
|
-
* @tags
|
|
6767
|
-
* @name
|
|
6768
|
-
* @summary
|
|
6769
|
-
* @request
|
|
6961
|
+
* @description Delete continent
|
|
6962
|
+
* @tags World Markets
|
|
6963
|
+
* @name ContinentDelete
|
|
6964
|
+
* @summary Delete continent
|
|
6965
|
+
* @request DELETE:/continents
|
|
6770
6966
|
* @secure
|
|
6771
6967
|
*/
|
|
6772
|
-
|
|
6968
|
+
continentDelete(query: {
|
|
6969
|
+
/** continent id */
|
|
6970
|
+
id: string;
|
|
6971
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6773
6972
|
/**
|
|
6774
|
-
* @description
|
|
6775
|
-
* @tags
|
|
6776
|
-
* @name
|
|
6777
|
-
* @summary
|
|
6778
|
-
* @request
|
|
6779
|
-
* @secure
|
|
6780
|
-
*/
|
|
6781
|
-
|
|
6782
|
-
|
|
6783
|
-
|
|
6784
|
-
|
|
6785
|
-
|
|
6786
|
-
}
|
|
6787
|
-
export interface InsightFixedIncomeV2 {
|
|
6788
|
-
a144: boolean;
|
|
6789
|
-
accrued_interest: number;
|
|
6790
|
-
bank_qualified: boolean;
|
|
6791
|
-
bond_warrant: boolean;
|
|
6792
|
-
call_type: string;
|
|
6793
|
-
callable: boolean;
|
|
6794
|
-
close_price: number;
|
|
6795
|
-
close_price_asof: string;
|
|
6796
|
-
close_ytw: number;
|
|
6797
|
-
convertible: boolean;
|
|
6798
|
-
country: string;
|
|
6799
|
-
country_code: string;
|
|
6800
|
-
country_domicile: string;
|
|
6801
|
-
country_issue: string;
|
|
6802
|
-
coupon: number;
|
|
6803
|
-
coupon_frequency: string;
|
|
6804
|
-
coupon_type: string;
|
|
6805
|
-
currency: string;
|
|
6806
|
-
cusip: string;
|
|
6807
|
-
dated_date: string;
|
|
6808
|
-
daycount: string;
|
|
6809
|
-
description: string;
|
|
6810
|
-
description_short: string;
|
|
6811
|
-
duration: number;
|
|
6812
|
-
first_coupon_date: string;
|
|
6813
|
-
insured: boolean;
|
|
6814
|
-
isin: string;
|
|
6815
|
-
issue_date: string;
|
|
6816
|
-
issue_minimum_denomination: number;
|
|
6817
|
-
issue_price: number;
|
|
6818
|
-
issue_size: number;
|
|
6819
|
-
issuer: string;
|
|
6820
|
-
last_coupon_date: string;
|
|
6821
|
-
liquidity_institutional_aggregate: number;
|
|
6822
|
-
liquidity_institutional_buy: number;
|
|
6823
|
-
liquidity_institutional_sell: number;
|
|
6824
|
-
liquidity_micro_aggregate: number;
|
|
6825
|
-
liquidity_micro_buy: number;
|
|
6826
|
-
liquidity_micro_sell: number;
|
|
6827
|
-
liquidity_retail_aggregate: number;
|
|
6828
|
-
liquidity_retail_buy: number;
|
|
6829
|
-
liquidity_retail_sell: number;
|
|
6830
|
-
maturity_date: string;
|
|
6831
|
-
municipal_state: string;
|
|
6832
|
-
municipal_taxable_federal: boolean;
|
|
6833
|
-
municipal_type: string;
|
|
6834
|
-
next_call_date: string;
|
|
6835
|
-
next_call_price: number;
|
|
6836
|
-
next_coupon_date: string;
|
|
6837
|
-
par_value: number;
|
|
6838
|
-
perpetual: boolean;
|
|
6839
|
-
private_placement: boolean;
|
|
6840
|
-
purpose: string;
|
|
6841
|
-
puttable: boolean;
|
|
6842
|
-
reg_s: boolean;
|
|
6843
|
-
sector: string;
|
|
6844
|
-
seniority: string;
|
|
6845
|
-
settlement_convention: string;
|
|
6846
|
-
sinking_fund: boolean;
|
|
6847
|
-
sp_creditwatch: string;
|
|
6848
|
-
sp_creditwatch_date: string;
|
|
6849
|
-
sp_outlook: string;
|
|
6850
|
-
sp_outlook_date: string;
|
|
6851
|
-
sp_rating: string;
|
|
6852
|
-
sp_rating_date: string;
|
|
6853
|
-
status: string;
|
|
6854
|
-
ticker: string;
|
|
6855
|
-
treasury_subtype: string;
|
|
6856
|
-
type: string;
|
|
6857
|
-
updated_at: string;
|
|
6858
|
-
}
|
|
6859
|
-
export interface InsightGetFixedIncomeEntriesResponseV2 {
|
|
6860
|
-
count: number;
|
|
6861
|
-
data: InsightFixedIncomeV2[];
|
|
6862
|
-
}
|
|
6863
|
-
export interface InsightGetFixedIncomeEntriesRequestV2 {
|
|
6864
|
-
/** @example true */
|
|
6865
|
-
bank_qualified?: boolean;
|
|
6866
|
-
/** @example true */
|
|
6867
|
-
callable?: boolean;
|
|
6868
|
-
/** @example true */
|
|
6869
|
-
convertible?: boolean;
|
|
6870
|
-
/** @example ["USA"] */
|
|
6871
|
-
country_codes?: string[];
|
|
6872
|
-
coupon?: InsightLessAndMoreV2;
|
|
6873
|
-
/** @example ["quarterly","zero"] */
|
|
6874
|
-
coupon_frequencies?: string[];
|
|
6875
|
-
/** @example ["655664AH3","9128286R6"] */
|
|
6876
|
-
cusip?: string[];
|
|
6973
|
+
* @description Get country codes
|
|
6974
|
+
* @tags World Markets
|
|
6975
|
+
* @name CountryCodeGet
|
|
6976
|
+
* @summary Get country codes
|
|
6977
|
+
* @request GET:/country-codes
|
|
6978
|
+
* @secure
|
|
6979
|
+
*/
|
|
6980
|
+
countryCodeGet(query: {
|
|
6981
|
+
/** Query limit */
|
|
6982
|
+
limit: number;
|
|
6983
|
+
/** Query offset */
|
|
6984
|
+
offset: number;
|
|
6985
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
6877
6986
|
/**
|
|
6878
|
-
* @
|
|
6879
|
-
* @
|
|
6987
|
+
* @description Edit country code
|
|
6988
|
+
* @tags World Markets
|
|
6989
|
+
* @name CountryCodeEdit
|
|
6990
|
+
* @summary Edit country code
|
|
6991
|
+
* @request PUT:/country-codes
|
|
6992
|
+
* @secure
|
|
6880
6993
|
*/
|
|
6881
|
-
|
|
6882
|
-
/** @example true */
|
|
6883
|
-
has_ticker?: boolean;
|
|
6884
|
-
/** @example true */
|
|
6885
|
-
insured?: boolean;
|
|
6886
|
-
/** @example ["US655664AH33","US9128286R69"] */
|
|
6887
|
-
isin?: string[];
|
|
6888
|
-
issue_date?: InsightBeforeAndAfterV2;
|
|
6994
|
+
countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6889
6995
|
/**
|
|
6890
|
-
* @
|
|
6891
|
-
* @
|
|
6996
|
+
* @description Add country codes
|
|
6997
|
+
* @tags World Markets
|
|
6998
|
+
* @name CountryCodeAdd
|
|
6999
|
+
* @summary Add country codes
|
|
7000
|
+
* @request POST:/country-codes
|
|
7001
|
+
* @secure
|
|
6892
7002
|
*/
|
|
6893
|
-
|
|
6894
|
-
maturity?: InsightBeforeAndAfterV2;
|
|
6895
|
-
/** @example ["NY"] */
|
|
6896
|
-
municipal_states?: string[];
|
|
6897
|
-
/** @example true */
|
|
6898
|
-
municipal_tax?: boolean;
|
|
6899
|
-
/** @example ["general_obligation"] */
|
|
6900
|
-
municipal_types?: string[];
|
|
6901
|
-
pagination: InsightPaginationV2;
|
|
6902
|
-
purposes?: string[];
|
|
6903
|
-
/** @example ["SOVEREIGN"] */
|
|
6904
|
-
sectors?: string[];
|
|
6905
|
-
sorts?: InsightOrderingV2[];
|
|
6906
|
-
/** @example ["AAA"] */
|
|
6907
|
-
sp_ratings?: string[];
|
|
6908
|
-
/** @example ["called","outstanding"] */
|
|
6909
|
-
statuses?: string[];
|
|
6910
|
-
tickers?: string[];
|
|
6911
|
-
/** @example ["corporate"] */
|
|
6912
|
-
types?: string[];
|
|
6913
|
-
}
|
|
6914
|
-
export interface InsightGetTopSymbolsRequestV2 {
|
|
6915
|
-
exchange?: string[];
|
|
6916
|
-
market_cap?: InsightLessAndMoreV2;
|
|
6917
|
-
pagination?: InsightPaginationV2;
|
|
6918
|
-
price?: InsightLessAndMoreV2;
|
|
6919
|
-
sorts?: InsightOrderingV2[];
|
|
6920
|
-
volume?: InsightLessAndMoreV2;
|
|
6921
|
-
}
|
|
6922
|
-
export interface InsightIncludeExcludeV2 {
|
|
6923
|
-
exclude?: string[];
|
|
6924
|
-
include?: string[];
|
|
6925
|
-
}
|
|
6926
|
-
export interface InsightLessAndMoreV2 {
|
|
6927
|
-
less_than?: number;
|
|
6928
|
-
more_than?: number;
|
|
6929
|
-
}
|
|
6930
|
-
export enum InsightOrderDirectionV2 {
|
|
6931
|
-
OrderASC = "asc",
|
|
6932
|
-
OrderDESC = "desc"
|
|
6933
|
-
}
|
|
6934
|
-
export interface InsightOrderingV2 {
|
|
7003
|
+
countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
6935
7004
|
/**
|
|
6936
|
-
* @
|
|
6937
|
-
* @
|
|
7005
|
+
* @description Delete country code
|
|
7006
|
+
* @tags World Markets
|
|
7007
|
+
* @name CountryCodeDelete
|
|
7008
|
+
* @summary Delete country code
|
|
7009
|
+
* @request DELETE:/country-codes
|
|
7010
|
+
* @secure
|
|
6938
7011
|
*/
|
|
6939
|
-
|
|
7012
|
+
countryCodeDelete(query: {
|
|
7013
|
+
/** a3 code */
|
|
7014
|
+
a3code: string;
|
|
7015
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6940
7016
|
/**
|
|
6941
|
-
*
|
|
6942
|
-
*
|
|
6943
|
-
*
|
|
6944
|
-
* @
|
|
7017
|
+
* @description Get global indexes
|
|
7018
|
+
* @tags World Markets
|
|
7019
|
+
* @name GlobalIndexGet
|
|
7020
|
+
* @summary Get global indexes
|
|
7021
|
+
* @request GET:/global-indexes
|
|
7022
|
+
* @secure
|
|
6945
7023
|
*/
|
|
6946
|
-
|
|
6947
|
-
|
|
6948
|
-
|
|
7024
|
+
globalIndexGet(query: {
|
|
7025
|
+
/** Query limit */
|
|
7026
|
+
limit: number;
|
|
7027
|
+
/** Query offset */
|
|
7028
|
+
offset: number;
|
|
7029
|
+
/** Continent code for filtering */
|
|
7030
|
+
continent?: string;
|
|
7031
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
6949
7032
|
/**
|
|
6950
|
-
* @
|
|
6951
|
-
* @
|
|
7033
|
+
* @description Edit global index
|
|
7034
|
+
* @tags World Markets
|
|
7035
|
+
* @name GlobalIndexEdit
|
|
7036
|
+
* @summary Edit global index
|
|
7037
|
+
* @request PUT:/global-indexes
|
|
7038
|
+
* @secure
|
|
6952
7039
|
*/
|
|
6953
|
-
|
|
7040
|
+
globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6954
7041
|
/**
|
|
6955
|
-
* @
|
|
6956
|
-
* @
|
|
6957
|
-
* @
|
|
7042
|
+
* @description Add global indexes
|
|
7043
|
+
* @tags World Markets
|
|
7044
|
+
* @name GlobalIndexAdd
|
|
7045
|
+
* @summary Add global indexes
|
|
7046
|
+
* @request POST:/global-indexes
|
|
7047
|
+
* @secure
|
|
6958
7048
|
*/
|
|
6959
|
-
|
|
6960
|
-
}
|
|
6961
|
-
export interface InsightStockScreenerQuoteV2 {
|
|
6962
|
-
average_volume_30d: number;
|
|
6963
|
-
company_name: string;
|
|
6964
|
-
dividend_ex_date: string;
|
|
6965
|
-
dividend_pay_date: string;
|
|
6966
|
-
dividend_percent: number;
|
|
6967
|
-
exchange: string;
|
|
6968
|
-
exchange_name: string;
|
|
6969
|
-
gap: number;
|
|
6970
|
-
industry: string;
|
|
6971
|
-
industry_code: string;
|
|
6972
|
-
last_price: number;
|
|
6973
|
-
market_cap: number;
|
|
6974
|
-
pe_ratio: number;
|
|
6975
|
-
price_change: number;
|
|
6976
|
-
price_change_percent: number;
|
|
6977
|
-
symbol: string;
|
|
6978
|
-
volume: number;
|
|
6979
|
-
}
|
|
6980
|
-
export interface InsightStockScreenerRequestV2 {
|
|
6981
|
-
average_volume_30d?: InsightLessAndMoreV2;
|
|
6982
|
-
dividend_ex_date?: InsightBeforeAndAfterV2;
|
|
6983
|
-
dividend_pay_date?: InsightBeforeAndAfterV2;
|
|
6984
|
-
dividend_percent?: InsightLessAndMoreV2;
|
|
6985
|
-
exchange?: InsightIncludeExcludeV2;
|
|
6986
|
-
gap?: InsightLessAndMoreV2;
|
|
6987
|
-
industry?: InsightIncludeExcludeV2;
|
|
6988
|
-
market_cap?: InsightLessAndMoreV2;
|
|
6989
|
-
pagination: InsightPaginationV2;
|
|
6990
|
-
pe_ratio?: InsightLessAndMoreV2;
|
|
6991
|
-
price?: InsightLessAndMoreV2;
|
|
6992
|
-
sorts?: InsightOrderingV2[];
|
|
6993
|
-
/** @example "ADR" */
|
|
6994
|
-
stock_type?: string;
|
|
6995
|
-
volume?: InsightLessAndMoreV2;
|
|
6996
|
-
}
|
|
6997
|
-
export interface InsightStockScreenerResponseV2 {
|
|
6998
|
-
current_page: number;
|
|
6999
|
-
data: InsightStockScreenerQuoteV2[];
|
|
7000
|
-
page_count: number;
|
|
7001
|
-
status: number;
|
|
7002
|
-
total_records: number;
|
|
7003
|
-
}
|
|
7004
|
-
/**
|
|
7005
|
-
* @default "asc"
|
|
7006
|
-
* @example "asc"
|
|
7007
|
-
*/
|
|
7008
|
-
export enum InsightOrderingDirectionEnumV2 {
|
|
7009
|
-
Asc = "asc",
|
|
7010
|
-
Desc = "desc"
|
|
7011
|
-
}
|
|
7012
|
-
export class FixedIncomeV2<HandleError extends boolean = boolean> {
|
|
7013
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
7014
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
7049
|
+
globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
7015
7050
|
/**
|
|
7016
|
-
* @description
|
|
7017
|
-
* @tags
|
|
7018
|
-
* @name
|
|
7019
|
-
* @summary
|
|
7020
|
-
* @request
|
|
7051
|
+
* @description Edit global index
|
|
7052
|
+
* @tags World Markets
|
|
7053
|
+
* @name GlobalIndexDelete
|
|
7054
|
+
* @summary Delete global index
|
|
7055
|
+
* @request DELETE:/global-indexes
|
|
7021
7056
|
* @secure
|
|
7022
7057
|
*/
|
|
7023
|
-
|
|
7024
|
-
|
|
7025
|
-
|
|
7026
|
-
|
|
7027
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
7058
|
+
globalIndexDelete(query: {
|
|
7059
|
+
/** a3 code */
|
|
7060
|
+
a3code: string;
|
|
7061
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
7028
7062
|
/**
|
|
7029
|
-
* @description
|
|
7030
|
-
* @tags
|
|
7031
|
-
* @name
|
|
7032
|
-
* @summary
|
|
7033
|
-
* @request
|
|
7063
|
+
* @description Get regions
|
|
7064
|
+
* @tags World Markets
|
|
7065
|
+
* @name RegionGet
|
|
7066
|
+
* @summary Get regions
|
|
7067
|
+
* @request GET:/regions
|
|
7034
7068
|
* @secure
|
|
7035
7069
|
*/
|
|
7036
|
-
|
|
7070
|
+
regionGet(query: {
|
|
7071
|
+
/** Query limit */
|
|
7072
|
+
limit: number;
|
|
7073
|
+
/** Query offset */
|
|
7074
|
+
offset: number;
|
|
7075
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
7037
7076
|
/**
|
|
7038
|
-
* @description
|
|
7039
|
-
* @tags
|
|
7040
|
-
* @name
|
|
7041
|
-
* @summary
|
|
7042
|
-
* @request
|
|
7077
|
+
* @description Edit region
|
|
7078
|
+
* @tags World Markets
|
|
7079
|
+
* @name RegionEdit
|
|
7080
|
+
* @summary Edit region
|
|
7081
|
+
* @request PUT:/regions
|
|
7043
7082
|
* @secure
|
|
7044
7083
|
*/
|
|
7045
|
-
|
|
7084
|
+
regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
7085
|
+
/**
|
|
7086
|
+
* @description Create regions
|
|
7087
|
+
* @tags World Markets
|
|
7088
|
+
* @name RegionCreate
|
|
7089
|
+
* @summary Create regions
|
|
7090
|
+
* @request POST:/regions
|
|
7091
|
+
* @secure
|
|
7092
|
+
*/
|
|
7093
|
+
regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
7094
|
+
/**
|
|
7095
|
+
* @description Delete region
|
|
7096
|
+
* @tags World Markets
|
|
7097
|
+
* @name RegionDelete
|
|
7098
|
+
* @summary Delete region
|
|
7099
|
+
* @request DELETE:/regions
|
|
7100
|
+
* @secure
|
|
7101
|
+
*/
|
|
7102
|
+
regionDelete(query: {
|
|
7103
|
+
/** region id */
|
|
7104
|
+
id: string;
|
|
7105
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
7046
7106
|
}
|
|
7047
7107
|
export class InsightApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
7048
7108
|
readonly config: JwtClientConfig<HandleError>;
|