@orbis-systems/orbis-api-clients 0.7.18 → 0.7.20
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 +264 -58
- 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 +9360 -2407
- 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 +1532 -1469
- 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 +157 -157
- 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 +3959 -3932
- 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 +1055 -691
- 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 +1 -1
package/dist/insight/index.d.ts
CHANGED
|
@@ -638,6 +638,8 @@ export interface InsightCreateOrUpdateFundScreenerPresetRequest {
|
|
|
638
638
|
preset_name: string;
|
|
639
639
|
}
|
|
640
640
|
export interface InsightCreateOrUpdateMarketRequest {
|
|
641
|
+
/** @example "New York" */
|
|
642
|
+
city?: string;
|
|
641
643
|
/** @example "USA" */
|
|
642
644
|
country_code: string;
|
|
643
645
|
/** @example "USD" */
|
|
@@ -757,7 +759,8 @@ export interface InsightEarningReleasesRequest {
|
|
|
757
759
|
exchanges?: string[];
|
|
758
760
|
/** @example true */
|
|
759
761
|
load_quotes?: boolean;
|
|
760
|
-
|
|
762
|
+
/** Paging is required if LoadQuotes is true */
|
|
763
|
+
paging?: InsightPaging;
|
|
761
764
|
/** @example ["AAPL","GOOGL"] */
|
|
762
765
|
symbols?: string[];
|
|
763
766
|
}
|
|
@@ -3162,12 +3165,18 @@ export interface InsightLiveFeedResponse {
|
|
|
3162
3165
|
url: string;
|
|
3163
3166
|
}
|
|
3164
3167
|
export interface InsightMarket {
|
|
3168
|
+
/** @example "New York" */
|
|
3169
|
+
city: string;
|
|
3165
3170
|
/** @example "USA" */
|
|
3166
3171
|
country_code: string;
|
|
3172
|
+
/** @example "United States" */
|
|
3173
|
+
country_name: string;
|
|
3167
3174
|
/** @example "2023-01-01T00:00:00Z" */
|
|
3168
3175
|
created_at: string;
|
|
3169
3176
|
/** @example "USD" */
|
|
3170
3177
|
currency_code: string;
|
|
3178
|
+
/** @example "2023-01-01T12:00:00" */
|
|
3179
|
+
local_time: string;
|
|
3171
3180
|
/** @example "U" */
|
|
3172
3181
|
market_code: string;
|
|
3173
3182
|
/** @example "United States" */
|
|
@@ -3176,6 +3185,8 @@ export interface InsightMarket {
|
|
|
3176
3185
|
primary_market: boolean;
|
|
3177
3186
|
/** @example "America/New_York" */
|
|
3178
3187
|
timezone: string;
|
|
3188
|
+
/** @example -300 */
|
|
3189
|
+
timezone_offset: number;
|
|
3179
3190
|
/** @example "2023-01-01T00:00:00Z" */
|
|
3180
3191
|
updated_at: string;
|
|
3181
3192
|
}
|
|
@@ -3828,6 +3839,11 @@ export interface InsightRemoveMarketDateRequest {
|
|
|
3828
3839
|
market_code: string;
|
|
3829
3840
|
/** @example "2023-01-01" */
|
|
3830
3841
|
open_date: string;
|
|
3842
|
+
/**
|
|
3843
|
+
* Optional: if provided, only the entry with this open_time will be removed
|
|
3844
|
+
* @example "09:30"
|
|
3845
|
+
*/
|
|
3846
|
+
open_time?: string;
|
|
3831
3847
|
}
|
|
3832
3848
|
export interface InsightRemoveRewrittenFieldValueRequest {
|
|
3833
3849
|
/** @example "Removed" */
|
|
@@ -3870,6 +3886,10 @@ export interface InsightSearchArticleRequest {
|
|
|
3870
3886
|
/** @example "all" */
|
|
3871
3887
|
type: InsightArticleSearchType;
|
|
3872
3888
|
}
|
|
3889
|
+
export interface InsightSearchFixedIncomeValuesResponse {
|
|
3890
|
+
count: number;
|
|
3891
|
+
data: string[];
|
|
3892
|
+
}
|
|
3873
3893
|
export interface InsightSearchLocodeDataResponse {
|
|
3874
3894
|
countries: InsightCountryEntry[];
|
|
3875
3895
|
currencies: InsightCurrencyEntry[];
|
|
@@ -4762,27 +4782,187 @@ export enum InsightTiprankInsidersLiveFeedParamsSortEnum {
|
|
|
4762
4782
|
Date = "date",
|
|
4763
4783
|
Rank = "rank"
|
|
4764
4784
|
}
|
|
4765
|
-
export class
|
|
4785
|
+
export class WorldMarkets<HandleError extends boolean = boolean> {
|
|
4766
4786
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4767
4787
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4768
4788
|
/**
|
|
4769
|
-
* @description
|
|
4770
|
-
* @tags
|
|
4771
|
-
* @name
|
|
4772
|
-
* @summary
|
|
4773
|
-
* @request
|
|
4789
|
+
* @description Get continents
|
|
4790
|
+
* @tags World Markets
|
|
4791
|
+
* @name ContinentGet
|
|
4792
|
+
* @summary Get continents
|
|
4793
|
+
* @request GET:/continents
|
|
4774
4794
|
* @secure
|
|
4775
4795
|
*/
|
|
4776
|
-
|
|
4796
|
+
continentGet(query: {
|
|
4797
|
+
/** Query limit */
|
|
4798
|
+
limit: number;
|
|
4799
|
+
/** Query offset */
|
|
4800
|
+
offset: number;
|
|
4801
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
4777
4802
|
/**
|
|
4778
|
-
* @description
|
|
4779
|
-
* @tags
|
|
4780
|
-
* @name
|
|
4781
|
-
* @summary
|
|
4782
|
-
* @request
|
|
4803
|
+
* @description Edit continent
|
|
4804
|
+
* @tags World Markets
|
|
4805
|
+
* @name ContinentEdit
|
|
4806
|
+
* @summary Edit continent
|
|
4807
|
+
* @request PUT:/continents
|
|
4783
4808
|
* @secure
|
|
4784
4809
|
*/
|
|
4785
|
-
|
|
4810
|
+
continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4811
|
+
/**
|
|
4812
|
+
* @description Create continents
|
|
4813
|
+
* @tags World Markets
|
|
4814
|
+
* @name ContinentCreate
|
|
4815
|
+
* @summary Create continents
|
|
4816
|
+
* @request POST:/continents
|
|
4817
|
+
* @secure
|
|
4818
|
+
*/
|
|
4819
|
+
continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
4820
|
+
/**
|
|
4821
|
+
* @description Delete continent
|
|
4822
|
+
* @tags World Markets
|
|
4823
|
+
* @name ContinentDelete
|
|
4824
|
+
* @summary Delete continent
|
|
4825
|
+
* @request DELETE:/continents
|
|
4826
|
+
* @secure
|
|
4827
|
+
*/
|
|
4828
|
+
continentDelete(query: {
|
|
4829
|
+
/** continent id */
|
|
4830
|
+
id: string;
|
|
4831
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4832
|
+
/**
|
|
4833
|
+
* @description Get country codes
|
|
4834
|
+
* @tags World Markets
|
|
4835
|
+
* @name CountryCodeGet
|
|
4836
|
+
* @summary Get country codes
|
|
4837
|
+
* @request GET:/country-codes
|
|
4838
|
+
* @secure
|
|
4839
|
+
*/
|
|
4840
|
+
countryCodeGet(query: {
|
|
4841
|
+
/** Query limit */
|
|
4842
|
+
limit: number;
|
|
4843
|
+
/** Query offset */
|
|
4844
|
+
offset: number;
|
|
4845
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
4846
|
+
/**
|
|
4847
|
+
* @description Edit country code
|
|
4848
|
+
* @tags World Markets
|
|
4849
|
+
* @name CountryCodeEdit
|
|
4850
|
+
* @summary Edit country code
|
|
4851
|
+
* @request PUT:/country-codes
|
|
4852
|
+
* @secure
|
|
4853
|
+
*/
|
|
4854
|
+
countryCodeEdit(filter: InsightEditCountryCodeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4855
|
+
/**
|
|
4856
|
+
* @description Add country codes
|
|
4857
|
+
* @tags World Markets
|
|
4858
|
+
* @name CountryCodeAdd
|
|
4859
|
+
* @summary Add country codes
|
|
4860
|
+
* @request POST:/country-codes
|
|
4861
|
+
* @secure
|
|
4862
|
+
*/
|
|
4863
|
+
countryCodeAdd(filter: InsightAddCountryCodesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
4864
|
+
/**
|
|
4865
|
+
* @description Delete country code
|
|
4866
|
+
* @tags World Markets
|
|
4867
|
+
* @name CountryCodeDelete
|
|
4868
|
+
* @summary Delete country code
|
|
4869
|
+
* @request DELETE:/country-codes
|
|
4870
|
+
* @secure
|
|
4871
|
+
*/
|
|
4872
|
+
countryCodeDelete(query: {
|
|
4873
|
+
/** a3 code */
|
|
4874
|
+
a3code: string;
|
|
4875
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4876
|
+
/**
|
|
4877
|
+
* @description Get global indexes
|
|
4878
|
+
* @tags World Markets
|
|
4879
|
+
* @name GlobalIndexGet
|
|
4880
|
+
* @summary Get global indexes
|
|
4881
|
+
* @request GET:/global-indexes
|
|
4882
|
+
* @secure
|
|
4883
|
+
*/
|
|
4884
|
+
globalIndexGet(query: {
|
|
4885
|
+
/** Query limit */
|
|
4886
|
+
limit: number;
|
|
4887
|
+
/** Query offset */
|
|
4888
|
+
offset: number;
|
|
4889
|
+
/** Continent code for filtering */
|
|
4890
|
+
continent?: string;
|
|
4891
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
4892
|
+
/**
|
|
4893
|
+
* @description Edit global index
|
|
4894
|
+
* @tags World Markets
|
|
4895
|
+
* @name GlobalIndexEdit
|
|
4896
|
+
* @summary Edit global index
|
|
4897
|
+
* @request PUT:/global-indexes
|
|
4898
|
+
* @secure
|
|
4899
|
+
*/
|
|
4900
|
+
globalIndexEdit(filter: InsightEditGlobalIndexRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4901
|
+
/**
|
|
4902
|
+
* @description Add global indexes
|
|
4903
|
+
* @tags World Markets
|
|
4904
|
+
* @name GlobalIndexAdd
|
|
4905
|
+
* @summary Add global indexes
|
|
4906
|
+
* @request POST:/global-indexes
|
|
4907
|
+
* @secure
|
|
4908
|
+
*/
|
|
4909
|
+
globalIndexAdd(filter: InsightAddGlobalIndexesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGlobalIndexFull[], HandleError>>;
|
|
4910
|
+
/**
|
|
4911
|
+
* @description Edit global index
|
|
4912
|
+
* @tags World Markets
|
|
4913
|
+
* @name GlobalIndexDelete
|
|
4914
|
+
* @summary Delete global index
|
|
4915
|
+
* @request DELETE:/global-indexes
|
|
4916
|
+
* @secure
|
|
4917
|
+
*/
|
|
4918
|
+
globalIndexDelete(query: {
|
|
4919
|
+
/** a3 code */
|
|
4920
|
+
a3code: string;
|
|
4921
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4922
|
+
/**
|
|
4923
|
+
* @description Get regions
|
|
4924
|
+
* @tags World Markets
|
|
4925
|
+
* @name RegionGet
|
|
4926
|
+
* @summary Get regions
|
|
4927
|
+
* @request GET:/regions
|
|
4928
|
+
* @secure
|
|
4929
|
+
*/
|
|
4930
|
+
regionGet(query: {
|
|
4931
|
+
/** Query limit */
|
|
4932
|
+
limit: number;
|
|
4933
|
+
/** Query offset */
|
|
4934
|
+
offset: number;
|
|
4935
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
4936
|
+
/**
|
|
4937
|
+
* @description Edit region
|
|
4938
|
+
* @tags World Markets
|
|
4939
|
+
* @name RegionEdit
|
|
4940
|
+
* @summary Edit region
|
|
4941
|
+
* @request PUT:/regions
|
|
4942
|
+
* @secure
|
|
4943
|
+
*/
|
|
4944
|
+
regionEdit(filter: InsightEditRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4945
|
+
/**
|
|
4946
|
+
* @description Create regions
|
|
4947
|
+
* @tags World Markets
|
|
4948
|
+
* @name RegionCreate
|
|
4949
|
+
* @summary Create regions
|
|
4950
|
+
* @request POST:/regions
|
|
4951
|
+
* @secure
|
|
4952
|
+
*/
|
|
4953
|
+
regionCreate(filter: InsightCreateRegionRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRegion[], HandleError>>;
|
|
4954
|
+
/**
|
|
4955
|
+
* @description Delete region
|
|
4956
|
+
* @tags World Markets
|
|
4957
|
+
* @name RegionDelete
|
|
4958
|
+
* @summary Delete region
|
|
4959
|
+
* @request DELETE:/regions
|
|
4960
|
+
* @secure
|
|
4961
|
+
*/
|
|
4962
|
+
regionDelete(query: {
|
|
4963
|
+
/** region id */
|
|
4964
|
+
id: string;
|
|
4965
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
4786
4966
|
}
|
|
4787
4967
|
export class CompanyProfile<HandleError extends boolean = boolean> {
|
|
4788
4968
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -4907,6 +5087,44 @@ export class CustomLists<HandleError extends boolean = boolean> {
|
|
|
4907
5087
|
symbols?: string[];
|
|
4908
5088
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFilteredCustomIndexResponse, HandleError>>;
|
|
4909
5089
|
}
|
|
5090
|
+
export class Earnings<HandleError extends boolean = boolean> {
|
|
5091
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5092
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5093
|
+
/**
|
|
5094
|
+
* @description get earnings releases count per day
|
|
5095
|
+
* @tags Earnings
|
|
5096
|
+
* @name GetEarningsReleasesCountPerDay
|
|
5097
|
+
* @summary get earnings releases count per day
|
|
5098
|
+
* @request GET:/earnings-calendar
|
|
5099
|
+
* @secure
|
|
5100
|
+
*/
|
|
5101
|
+
getEarningsReleasesCountPerDay(query?: {
|
|
5102
|
+
/**
|
|
5103
|
+
* Start date in format YYYY-MM-DD
|
|
5104
|
+
* @example ""2024-01-01""
|
|
5105
|
+
*/
|
|
5106
|
+
start_date?: string;
|
|
5107
|
+
/**
|
|
5108
|
+
* End date in format YYYY-MM-DD
|
|
5109
|
+
* @example ""2024-01-31""
|
|
5110
|
+
*/
|
|
5111
|
+
end_date?: string;
|
|
5112
|
+
/**
|
|
5113
|
+
* Filter by exchanges
|
|
5114
|
+
* @example ""NYSE,NAS""
|
|
5115
|
+
*/
|
|
5116
|
+
exchanges?: string[];
|
|
5117
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, number>, HandleError>>;
|
|
5118
|
+
/**
|
|
5119
|
+
* @description get earnings release dates for symbols
|
|
5120
|
+
* @tags Earnings
|
|
5121
|
+
* @name GetEarningsCalendar
|
|
5122
|
+
* @summary get earnings calendar data
|
|
5123
|
+
* @request POST:/earnings-calendar
|
|
5124
|
+
* @secure
|
|
5125
|
+
*/
|
|
5126
|
+
getEarningsCalendar(filter: InsightEarningReleasesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEarningReleasesResponse, HandleError>>;
|
|
5127
|
+
}
|
|
4910
5128
|
export class Dashboard<HandleError extends boolean = boolean> {
|
|
4911
5129
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4912
5130
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4982,37 +5200,151 @@ export class Dashboard<HandleError extends boolean = boolean> {
|
|
|
4982
5200
|
symbol: string;
|
|
4983
5201
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolRelatedFieldsResponse, HandleError>>;
|
|
4984
5202
|
}
|
|
4985
|
-
export class
|
|
5203
|
+
export class Fundamentals<HandleError extends boolean = boolean> {
|
|
4986
5204
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4987
5205
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4988
5206
|
/**
|
|
4989
|
-
* @description get
|
|
4990
|
-
* @tags
|
|
4991
|
-
* @name
|
|
4992
|
-
* @summary get
|
|
4993
|
-
* @request POST:/
|
|
5207
|
+
* @description get fundamentals by symbol data
|
|
5208
|
+
* @tags Fundamentals
|
|
5209
|
+
* @name GetFundamentalsBySymbolData
|
|
5210
|
+
* @summary get fundamentals by symbol data
|
|
5211
|
+
* @request POST:/fundamentals
|
|
4994
5212
|
* @secure
|
|
4995
5213
|
*/
|
|
4996
|
-
|
|
5214
|
+
getFundamentalsBySymbolData(filter: InsightGetSymbolFundamentalsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
4997
5215
|
}
|
|
4998
|
-
export class
|
|
5216
|
+
export class Funds<HandleError extends boolean = boolean> {
|
|
4999
5217
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5000
5218
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5001
5219
|
/**
|
|
5002
|
-
* @description get
|
|
5003
|
-
* @tags
|
|
5004
|
-
* @name
|
|
5005
|
-
* @summary get
|
|
5006
|
-
* @request
|
|
5220
|
+
* @description get fund details
|
|
5221
|
+
* @tags Funds
|
|
5222
|
+
* @name GetFundDetails
|
|
5223
|
+
* @summary get fund details
|
|
5224
|
+
* @request GET:/funds/details
|
|
5007
5225
|
* @secure
|
|
5008
5226
|
*/
|
|
5009
|
-
|
|
5227
|
+
getFundDetails(query: {
|
|
5228
|
+
/** Fund symbol */
|
|
5229
|
+
symbol: string;
|
|
5230
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundDetailsResponse, HandleError>>;
|
|
5010
5231
|
/**
|
|
5011
|
-
* @description
|
|
5012
|
-
* @tags
|
|
5013
|
-
* @name
|
|
5014
|
-
* @summary
|
|
5015
|
-
* @request POST:/
|
|
5232
|
+
* @description get funds for holding
|
|
5233
|
+
* @tags Funds
|
|
5234
|
+
* @name GetFundsForHolding
|
|
5235
|
+
* @summary get funds for holding
|
|
5236
|
+
* @request POST:/funds/funds-for-holding
|
|
5237
|
+
* @secure
|
|
5238
|
+
*/
|
|
5239
|
+
getFundsForHolding(filter: InsightGetFundsForHoldingRequest, headers?: {
|
|
5240
|
+
/** Authorization */
|
|
5241
|
+
Authorization?: string;
|
|
5242
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundsForHoldingResponse, HandleError>>;
|
|
5243
|
+
/**
|
|
5244
|
+
* @description filter funds by params
|
|
5245
|
+
* @tags Funds
|
|
5246
|
+
* @name FundScreener
|
|
5247
|
+
* @summary filter funds by params
|
|
5248
|
+
* @request POST:/funds/screener
|
|
5249
|
+
* @secure
|
|
5250
|
+
*/
|
|
5251
|
+
fundScreener(filter: InsightFundScreenerRequest, headers?: {
|
|
5252
|
+
/** Authorization */
|
|
5253
|
+
Authorization?: string;
|
|
5254
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
|
|
5255
|
+
/**
|
|
5256
|
+
* @description get fund screener filters
|
|
5257
|
+
* @tags Funds
|
|
5258
|
+
* @name GetScreenerFilters
|
|
5259
|
+
* @summary get fund screener filters
|
|
5260
|
+
* @request GET:/funds/screener/filters
|
|
5261
|
+
* @secure
|
|
5262
|
+
*/
|
|
5263
|
+
getScreenerFilters(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundScreenerFiltersResponse, HandleError>>;
|
|
5264
|
+
/**
|
|
5265
|
+
* @description get fund screener presets
|
|
5266
|
+
* @tags Funds
|
|
5267
|
+
* @name GetFundScreenerPresets
|
|
5268
|
+
* @summary get fund screener presets
|
|
5269
|
+
* @request GET:/funds/screener/presets
|
|
5270
|
+
* @secure
|
|
5271
|
+
*/
|
|
5272
|
+
getFundScreenerPresets(query: {
|
|
5273
|
+
/** how many records to return */
|
|
5274
|
+
limit: number;
|
|
5275
|
+
/** how many records to skip */
|
|
5276
|
+
offset: number;
|
|
5277
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
5278
|
+
/**
|
|
5279
|
+
* @description update fund screener preset
|
|
5280
|
+
* @tags Funds
|
|
5281
|
+
* @name UpdateFundScreenerPreset
|
|
5282
|
+
* @summary update fund screener preset
|
|
5283
|
+
* @request PUT:/funds/screener/presets
|
|
5284
|
+
* @secure
|
|
5285
|
+
*/
|
|
5286
|
+
updateFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5287
|
+
/**
|
|
5288
|
+
* @description create fund screener preset
|
|
5289
|
+
* @tags Funds
|
|
5290
|
+
* @name CreateFundScreenerPreset
|
|
5291
|
+
* @summary create fund screener preset
|
|
5292
|
+
* @request POST:/funds/screener/presets
|
|
5293
|
+
* @secure
|
|
5294
|
+
*/
|
|
5295
|
+
createFundScreenerPreset(input: InsightCreateOrUpdateFundScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5296
|
+
/**
|
|
5297
|
+
* @description remove fund screener preset
|
|
5298
|
+
* @tags Funds
|
|
5299
|
+
* @name RemoveFundScreenerPreset
|
|
5300
|
+
* @summary remove fund screener preset
|
|
5301
|
+
* @request DELETE:/funds/screener/presets
|
|
5302
|
+
* @secure
|
|
5303
|
+
*/
|
|
5304
|
+
removeFundScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5305
|
+
/**
|
|
5306
|
+
* @description filter funds by params
|
|
5307
|
+
* @tags Funds
|
|
5308
|
+
* @name FundSectorScreener
|
|
5309
|
+
* @summary filter funds by params
|
|
5310
|
+
* @request POST:/funds/sector-screener
|
|
5311
|
+
* @secure
|
|
5312
|
+
*/
|
|
5313
|
+
fundSectorScreener(filter: InsightFundSectorScreenerRequest, headers?: {
|
|
5314
|
+
/** Authorization */
|
|
5315
|
+
Authorization?: string;
|
|
5316
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFundScreenerResponse, HandleError>>;
|
|
5317
|
+
/**
|
|
5318
|
+
* @description get top funds
|
|
5319
|
+
* @tags Funds
|
|
5320
|
+
* @name GetTopFunds
|
|
5321
|
+
* @summary get top funds
|
|
5322
|
+
* @request POST:/funds/top
|
|
5323
|
+
* @secure
|
|
5324
|
+
*/
|
|
5325
|
+
getTopFunds(filter: InsightGetTopFundsRequest, headers?: {
|
|
5326
|
+
/** Authorization */
|
|
5327
|
+
Authorization?: string;
|
|
5328
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetTopFundsResponse, HandleError>>;
|
|
5329
|
+
}
|
|
5330
|
+
export class FixedIncome<HandleError extends boolean = boolean> {
|
|
5331
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5332
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5333
|
+
/**
|
|
5334
|
+
* @description get fixed income entries
|
|
5335
|
+
* @tags FixedIncome
|
|
5336
|
+
* @name GetFixedIncomeEntries
|
|
5337
|
+
* @summary get fixed income entries
|
|
5338
|
+
* @request POST:/fixed-income
|
|
5339
|
+
* @secure
|
|
5340
|
+
*/
|
|
5341
|
+
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponse, HandleError>>;
|
|
5342
|
+
/**
|
|
5343
|
+
* @description Returns historical fixed income
|
|
5344
|
+
* @tags FixedIncome
|
|
5345
|
+
* @name FixedIncomeHistorical
|
|
5346
|
+
* @summary Get historical fixed income
|
|
5347
|
+
* @request POST:/fixed-income/historical
|
|
5016
5348
|
* @secure
|
|
5017
5349
|
*/
|
|
5018
5350
|
fixedIncomeHistorical(filter: InsightGetFixedIncomeHistoricalRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeHistoricalResponse, HandleError>>;
|
|
@@ -5057,6 +5389,24 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
5057
5389
|
* @secure
|
|
5058
5390
|
*/
|
|
5059
5391
|
removeFixedIncomePreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5392
|
+
/**
|
|
5393
|
+
* @description search fixed income values
|
|
5394
|
+
* @tags FixedIncome
|
|
5395
|
+
* @name SearchFixedIncomeValues
|
|
5396
|
+
* @summary search fixed income values
|
|
5397
|
+
* @request GET:/fixed-income/search
|
|
5398
|
+
* @secure
|
|
5399
|
+
*/
|
|
5400
|
+
searchFixedIncomeValues(query: {
|
|
5401
|
+
/** search query */
|
|
5402
|
+
search_query: string;
|
|
5403
|
+
/** field to search in */
|
|
5404
|
+
field: string;
|
|
5405
|
+
/** how many records to return */
|
|
5406
|
+
limit?: number;
|
|
5407
|
+
/** how many records to skip */
|
|
5408
|
+
offset?: number;
|
|
5409
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSearchFixedIncomeValuesResponse, HandleError>>;
|
|
5060
5410
|
/**
|
|
5061
5411
|
* @description get single fixed income entry
|
|
5062
5412
|
* @tags FixedIncome
|
|
@@ -5067,391 +5417,157 @@ export class FixedIncome<HandleError extends boolean = boolean> {
|
|
|
5067
5417
|
*/
|
|
5068
5418
|
getSingleFixedIncomeEntry(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightFixedIncome, HandleError>>;
|
|
5069
5419
|
}
|
|
5070
|
-
export
|
|
5071
|
-
|
|
5072
|
-
|
|
5073
|
-
}
|
|
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[];
|
|
5420
|
+
export class StockScreener<HandleError extends boolean = boolean> {
|
|
5421
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5422
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5164
5423
|
/**
|
|
5165
|
-
* @
|
|
5166
|
-
* @
|
|
5424
|
+
* @description data for visual heat map
|
|
5425
|
+
* @tags StockScreener
|
|
5426
|
+
* @name StockMarketHeatmap
|
|
5427
|
+
* @summary data for visual heat map
|
|
5428
|
+
* @request GET:/heatmaps
|
|
5429
|
+
* @secure
|
|
5167
5430
|
*/
|
|
5168
|
-
|
|
5169
|
-
|
|
5170
|
-
|
|
5171
|
-
|
|
5172
|
-
insured?: boolean;
|
|
5173
|
-
/** @example ["US655664AH33","US9128286R69"] */
|
|
5174
|
-
isin?: string[];
|
|
5175
|
-
issue_date?: InsightBeforeAndAfterV2;
|
|
5431
|
+
stockMarketHeatmap(query?: {
|
|
5432
|
+
/** Name of symbol list to fetch details for. Empty is default */
|
|
5433
|
+
heatmap_name?: string;
|
|
5434
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockMarketHeatmapResponse, HandleError>>;
|
|
5176
5435
|
/**
|
|
5177
|
-
* @
|
|
5178
|
-
* @
|
|
5436
|
+
* @description create or update heat map preset
|
|
5437
|
+
* @tags StockScreener
|
|
5438
|
+
* @name CreateStockMarketHeatmapPreset
|
|
5439
|
+
* @summary create or update heat map preset
|
|
5440
|
+
* @request POST:/heatmaps
|
|
5441
|
+
* @secure
|
|
5179
5442
|
*/
|
|
5180
|
-
|
|
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 {
|
|
5443
|
+
createStockMarketHeatmapPreset(filter: InsightCreateHeatmapPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5222
5444
|
/**
|
|
5223
|
-
* @
|
|
5224
|
-
* @
|
|
5445
|
+
* @description Sector and Industry Group performance
|
|
5446
|
+
* @tags StockScreener
|
|
5447
|
+
* @name IndustriesPerformance
|
|
5448
|
+
* @summary get industries performance
|
|
5449
|
+
* @request POST:/industries-performance
|
|
5450
|
+
* @secure
|
|
5225
5451
|
*/
|
|
5226
|
-
|
|
5452
|
+
industriesPerformance(filter: InsightGetIndustriesPerformanceRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetIndustriesPerformanceResponse, HandleError>>;
|
|
5227
5453
|
/**
|
|
5228
|
-
*
|
|
5229
|
-
*
|
|
5230
|
-
*
|
|
5231
|
-
* @
|
|
5454
|
+
* @description filter stocks by params
|
|
5455
|
+
* @tags StockScreener
|
|
5456
|
+
* @name StockScreener
|
|
5457
|
+
* @summary filter stocks by params
|
|
5458
|
+
* @request POST:/stock-screener
|
|
5459
|
+
* @secure
|
|
5232
5460
|
*/
|
|
5233
|
-
|
|
5234
|
-
|
|
5235
|
-
|
|
5461
|
+
stockScreener(filter: InsightStockScreenerV1Request, headers?: {
|
|
5462
|
+
/** Authorization */
|
|
5463
|
+
Authorization?: string;
|
|
5464
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
5236
5465
|
/**
|
|
5237
|
-
* @
|
|
5238
|
-
* @
|
|
5466
|
+
* @description get screener presets
|
|
5467
|
+
* @tags StockScreener
|
|
5468
|
+
* @name GetScreenerPresets
|
|
5469
|
+
* @summary get screener presets
|
|
5470
|
+
* @request GET:/stock-screener/presets
|
|
5471
|
+
* @secure
|
|
5239
5472
|
*/
|
|
5240
|
-
|
|
5473
|
+
getScreenerPresets(query: {
|
|
5474
|
+
/** how many records to return */
|
|
5475
|
+
limit: number;
|
|
5476
|
+
/** how many records to skip */
|
|
5477
|
+
offset: number;
|
|
5478
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetScreenerPresetsResponse, HandleError>>;
|
|
5241
5479
|
/**
|
|
5242
|
-
* @
|
|
5243
|
-
* @
|
|
5244
|
-
* @
|
|
5480
|
+
* @description update screener preset
|
|
5481
|
+
* @tags StockScreener
|
|
5482
|
+
* @name UpdateScreenerPreset
|
|
5483
|
+
* @summary update screener preset
|
|
5484
|
+
* @request PUT:/stock-screener/presets
|
|
5485
|
+
* @secure
|
|
5245
5486
|
*/
|
|
5246
|
-
|
|
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>);
|
|
5487
|
+
updateScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5302
5488
|
/**
|
|
5303
|
-
* @description
|
|
5304
|
-
* @tags
|
|
5305
|
-
* @name
|
|
5306
|
-
* @summary
|
|
5307
|
-
* @request POST:/
|
|
5489
|
+
* @description create screener preset
|
|
5490
|
+
* @tags StockScreener
|
|
5491
|
+
* @name CreateOrScreenerPreset
|
|
5492
|
+
* @summary create screener preset
|
|
5493
|
+
* @request POST:/stock-screener/presets
|
|
5308
5494
|
* @secure
|
|
5309
5495
|
*/
|
|
5310
|
-
|
|
5311
|
-
}
|
|
5312
|
-
export class Fundamentals<HandleError extends boolean = boolean> {
|
|
5313
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5314
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
5496
|
+
createOrScreenerPreset(input: InsightCreateOrUpdateScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightScreenerPreset, HandleError>>;
|
|
5315
5497
|
/**
|
|
5316
|
-
* @description
|
|
5317
|
-
* @tags
|
|
5318
|
-
* @name
|
|
5319
|
-
* @summary
|
|
5320
|
-
* @request
|
|
5498
|
+
* @description remove screener preset
|
|
5499
|
+
* @tags StockScreener
|
|
5500
|
+
* @name RemoveScreenerPreset
|
|
5501
|
+
* @summary remove screener preset
|
|
5502
|
+
* @request DELETE:/stock-screener/presets
|
|
5321
5503
|
* @secure
|
|
5322
5504
|
*/
|
|
5323
|
-
|
|
5505
|
+
removeScreenerPreset(input: InsightRemoveScreenerPresetRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5506
|
+
/**
|
|
5507
|
+
* @description get top symbols
|
|
5508
|
+
* @tags StockScreener
|
|
5509
|
+
* @name GetTopSymbols
|
|
5510
|
+
* @summary get top symbols
|
|
5511
|
+
* @request POST:/stock-screener/top
|
|
5512
|
+
* @secure
|
|
5513
|
+
*/
|
|
5514
|
+
getTopSymbols(input: InsightGetTopSymbolsV1Request, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponse, HandleError>>;
|
|
5324
5515
|
}
|
|
5325
|
-
export class
|
|
5516
|
+
export class Quotes<HandleError extends boolean = boolean> {
|
|
5326
5517
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5327
5518
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5328
5519
|
/**
|
|
5329
|
-
* @description
|
|
5330
|
-
* @tags
|
|
5331
|
-
* @name
|
|
5332
|
-
* @summary
|
|
5333
|
-
* @request GET:/
|
|
5520
|
+
* @description Get single historical quote
|
|
5521
|
+
* @tags Quotes
|
|
5522
|
+
* @name GitHistoricalQuote
|
|
5523
|
+
* @summary Get single historical quote
|
|
5524
|
+
* @request GET:/historical/quote
|
|
5334
5525
|
* @secure
|
|
5335
5526
|
*/
|
|
5336
|
-
|
|
5337
|
-
/**
|
|
5527
|
+
gitHistoricalQuote(query: {
|
|
5528
|
+
/** Symbol */
|
|
5338
5529
|
symbol: string;
|
|
5339
|
-
|
|
5530
|
+
/** Date */
|
|
5531
|
+
date: string;
|
|
5532
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
|
|
5340
5533
|
/**
|
|
5341
|
-
* @description get
|
|
5342
|
-
* @tags
|
|
5343
|
-
* @name
|
|
5344
|
-
* @summary
|
|
5345
|
-
* @request POST:/
|
|
5534
|
+
* @description get quote history by symbol
|
|
5535
|
+
* @tags Quotes
|
|
5536
|
+
* @name GitQuoteHistory
|
|
5537
|
+
* @summary Get quote history
|
|
5538
|
+
* @request POST:/quote-history
|
|
5346
5539
|
* @secure
|
|
5347
5540
|
*/
|
|
5348
|
-
|
|
5349
|
-
/** Authorization */
|
|
5350
|
-
Authorization?: string;
|
|
5351
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFundsForHoldingResponse, HandleError>>;
|
|
5541
|
+
gitQuoteHistory(filter: InsightQuoteHistoryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteHistoryResponse, HandleError>>;
|
|
5352
5542
|
/**
|
|
5353
|
-
* @description
|
|
5354
|
-
* @tags
|
|
5355
|
-
* @name
|
|
5356
|
-
* @summary
|
|
5357
|
-
* @request
|
|
5543
|
+
* @description Returns a list of quotes equity info for specified symbols.
|
|
5544
|
+
* @tags Quotes
|
|
5545
|
+
* @name GetQuotesEquityData
|
|
5546
|
+
* @summary Get Quotes Equity data
|
|
5547
|
+
* @request GET:/quotes/equity
|
|
5358
5548
|
* @secure
|
|
5359
5549
|
*/
|
|
5360
|
-
|
|
5361
|
-
/**
|
|
5362
|
-
|
|
5363
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5550
|
+
getQuotesEquityData(query: {
|
|
5551
|
+
/** Comma separated symbols */
|
|
5552
|
+
symbols: string;
|
|
5553
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightEquityDataResponse[], HandleError>>;
|
|
5554
|
+
}
|
|
5555
|
+
export class Intraday<HandleError extends boolean = boolean> {
|
|
5556
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5557
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5364
5558
|
/**
|
|
5365
|
-
* @description
|
|
5366
|
-
* @tags
|
|
5367
|
-
* @name
|
|
5368
|
-
* @summary
|
|
5369
|
-
* @request
|
|
5559
|
+
* @description Returns an array of intraday chart data values for the given ticker.
|
|
5560
|
+
* @tags Intraday
|
|
5561
|
+
* @name IntradayQuotes
|
|
5562
|
+
* @summary Get an array of intraday chart data values for the given ticker
|
|
5563
|
+
* @request POST:/intraday/quotes
|
|
5370
5564
|
* @secure
|
|
5371
5565
|
*/
|
|
5372
|
-
|
|
5373
|
-
|
|
5374
|
-
|
|
5375
|
-
|
|
5376
|
-
|
|
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>);
|
|
5566
|
+
intradayQuotes(filter: InsightIntradayRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIntradayResponse[], HandleError>>;
|
|
5567
|
+
}
|
|
5568
|
+
export class Ipos<HandleError extends boolean = boolean> {
|
|
5569
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
5570
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
5455
5571
|
/**
|
|
5456
5572
|
* @description get recent ipos info
|
|
5457
5573
|
* @tags Ipos
|
|
@@ -5490,105 +5606,292 @@ export class Ipos<HandleError extends boolean = boolean> {
|
|
|
5490
5606
|
statuses?: string[];
|
|
5491
5607
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightIPOResponse, HandleError>>;
|
|
5492
5608
|
}
|
|
5493
|
-
export class
|
|
5609
|
+
export class PreIpoCompanies<HandleError extends boolean = boolean> {
|
|
5494
5610
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5495
5611
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5496
5612
|
/**
|
|
5497
|
-
* @description
|
|
5498
|
-
* @tags
|
|
5499
|
-
* @name
|
|
5500
|
-
* @summary
|
|
5501
|
-
* @request
|
|
5613
|
+
* @description Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
|
|
5614
|
+
* @tags PreIPOCompanies
|
|
5615
|
+
* @name MonarkOghlcDataForSymbol
|
|
5616
|
+
* @summary Retrieves OHLC (Open, High, Low, Close) market data for a given symbol
|
|
5617
|
+
* @request GET:/ipos/market-data/ohlc/{symbol}
|
|
5502
5618
|
* @secure
|
|
5503
5619
|
*/
|
|
5504
|
-
|
|
5620
|
+
monarkOghlcDataForSymbol(symbol: string, query?: {
|
|
5621
|
+
/** Start time for the OHLC data in ISO 8601 format YYYY-MM-DD */
|
|
5622
|
+
from?: string;
|
|
5623
|
+
/** End time for the OHLC data in ISO 8601 format YYYY-MM-DD */
|
|
5624
|
+
to?: string;
|
|
5625
|
+
/** Time interval for buckets: 1d (day), 1w (week), 1mo (month), 3mo (3 months). Default is 1d. */
|
|
5626
|
+
interval?: string;
|
|
5627
|
+
/** Limit the number of OHLC data points returned. Default is 100. */
|
|
5628
|
+
limit?: number;
|
|
5629
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<{
|
|
5630
|
+
close?: number;
|
|
5631
|
+
high?: number;
|
|
5632
|
+
low?: number;
|
|
5633
|
+
open?: number;
|
|
5634
|
+
time?: string;
|
|
5635
|
+
volume?: number;
|
|
5636
|
+
}[], HandleError>>;
|
|
5505
5637
|
/**
|
|
5506
|
-
* @description
|
|
5507
|
-
* @tags
|
|
5508
|
-
* @name
|
|
5509
|
-
* @summary
|
|
5510
|
-
* @request
|
|
5638
|
+
* @description Retrieves all symbols available in the market data
|
|
5639
|
+
* @tags PreIPOCompanies
|
|
5640
|
+
* @name MonarkAllAvailableSymbols
|
|
5641
|
+
* @summary Retrieves all symbols available in the market data
|
|
5642
|
+
* @request GET:/ipos/market-data/symbols
|
|
5511
5643
|
* @secure
|
|
5512
5644
|
*/
|
|
5513
|
-
|
|
5645
|
+
monarkAllAvailableSymbols(config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5514
5646
|
/**
|
|
5515
|
-
* @description
|
|
5516
|
-
* @tags
|
|
5517
|
-
* @name
|
|
5518
|
-
* @summary
|
|
5519
|
-
* @request GET:/
|
|
5647
|
+
* @description get pre ipo companies Avaliable categories: on-demand business-video reverse-etl modern-data-stack video-api global-payroll banking-as-a-service ultrafast-delivery online-grocery website-builder fintech b2b venture-capital ecommerce creator-economy productivity real-estate private-markets-exchanges fpa vertical-saas card-issuing connected-fitness gig-marketplaces cms soc-2 analytics cap-table-management contractor-payroll social-media design online-whiteboard conversational-marketing expense-management stock-option-financing customer-onboarding crypto help-desk payroll documents databases mortgage-lending crypto-exchange marketing-automation payments operations checkout cybersecurity messaging investing marketplaces climate-tech robotics data-security online-education gaming universal-api automation biotechnology contact-center defense machine-learning logistics prefab-tech materials telehealth b2c alternative-proteins b2b-marketplaces wealth-management web3 neobank managed-marketplaces plg-crm jamstack public-safety background-checks identity-verification construction home-services sales blockchain-developer-platform space financial-data-aggregation ai writing-assistant autonomous-driving 401k-provider vector-databases ai-models devtools payroll-api internal-tools mlops bookkeeping cloud-infrastructure data-backups personal-finance ai-frameworks generative-ai cloud-gpus micromobility ai-avatars ai-chips life-sciences partnerships wearables fitness-tracking ai-search ai-medical-scribes networking quantum-computing code-editors
|
|
5648
|
+
* @tags PreIPOCompanies
|
|
5649
|
+
* @name GetPreIpoCompanies
|
|
5650
|
+
* @summary get pre ipo companies
|
|
5651
|
+
* @request GET:/ipos/pre-ipo-companies
|
|
5520
5652
|
* @secure
|
|
5521
5653
|
*/
|
|
5522
|
-
|
|
5523
|
-
/**
|
|
5524
|
-
|
|
5525
|
-
|
|
5654
|
+
getPreIpoCompanies(query: {
|
|
5655
|
+
/** search by company name */
|
|
5656
|
+
name?: string;
|
|
5657
|
+
/** search by categories */
|
|
5658
|
+
categories?: string;
|
|
5659
|
+
/** search by listing type */
|
|
5660
|
+
listing_type?: string;
|
|
5661
|
+
/** filter by active status */
|
|
5662
|
+
is_active?: InsightGetPreIpoCompaniesParamsIsActiveEnum;
|
|
5663
|
+
/** filter by minimum last valuation */
|
|
5664
|
+
min_last_valuation?: number;
|
|
5665
|
+
/** filter by maximum last valuation */
|
|
5666
|
+
max_last_valuation?: number;
|
|
5667
|
+
/** filter by minimum total funding */
|
|
5668
|
+
min_total_funding?: number;
|
|
5669
|
+
/** filter by maximum total funding */
|
|
5670
|
+
max_total_funding?: number;
|
|
5671
|
+
/** how many records to return. Max value is 50 */
|
|
5672
|
+
limit: number;
|
|
5673
|
+
/** how many records to skip */
|
|
5674
|
+
offset: number;
|
|
5675
|
+
/** sort field */
|
|
5676
|
+
order_field?: InsightGetPreIpoCompaniesParamsOrderFieldEnum;
|
|
5677
|
+
/** sort direction */
|
|
5678
|
+
order_direction?: InsightGetPreIpoCompaniesParamsOrderDirectionEnum;
|
|
5679
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
|
|
5526
5680
|
/**
|
|
5527
|
-
* @description
|
|
5528
|
-
* @tags
|
|
5529
|
-
* @name
|
|
5530
|
-
* @summary
|
|
5531
|
-
* @request GET:/
|
|
5681
|
+
* @description get pre ipo company by id
|
|
5682
|
+
* @tags PreIPOCompanies
|
|
5683
|
+
* @name GetPreIpoCompaniesById
|
|
5684
|
+
* @summary get pre ipo company by id
|
|
5685
|
+
* @request GET:/ipos/pre-ipo-companies/{id}
|
|
5686
|
+
* @originalName getPreIpoCompanies
|
|
5687
|
+
* @duplicate
|
|
5532
5688
|
* @secure
|
|
5533
5689
|
*/
|
|
5534
|
-
|
|
5535
|
-
/** Company symbol */
|
|
5536
|
-
symbol: string;
|
|
5537
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5690
|
+
getPreIpoCompaniesById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompany, HandleError>>;
|
|
5538
5691
|
/**
|
|
5539
|
-
* @description
|
|
5540
|
-
* @tags
|
|
5541
|
-
* @name
|
|
5542
|
-
* @summary
|
|
5543
|
-
* @request GET:/
|
|
5692
|
+
* @description get pre ipo company funding rounds
|
|
5693
|
+
* @tags PreIPOCompanies
|
|
5694
|
+
* @name GetPreIpoCompanyFundingRounds
|
|
5695
|
+
* @summary get pre ipo company funding rounds
|
|
5696
|
+
* @request GET:/ipos/pre-ipo-company-funding-rounds
|
|
5544
5697
|
* @secure
|
|
5545
5698
|
*/
|
|
5546
|
-
|
|
5547
|
-
/**
|
|
5548
|
-
|
|
5549
|
-
|
|
5699
|
+
getPreIpoCompanyFundingRounds(query: {
|
|
5700
|
+
/** company id */
|
|
5701
|
+
pre_ipo_company_id?: string;
|
|
5702
|
+
/** search by round name */
|
|
5703
|
+
round_name?: string;
|
|
5704
|
+
/** how many records to return. Max value is 50 */
|
|
5705
|
+
limit: number;
|
|
5706
|
+
/** how many records to skip */
|
|
5707
|
+
offset: number;
|
|
5708
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyFundingRoundsResponse, HandleError>>;
|
|
5550
5709
|
/**
|
|
5551
|
-
* @description
|
|
5552
|
-
* @tags
|
|
5553
|
-
* @name
|
|
5554
|
-
* @summary
|
|
5555
|
-
* @request
|
|
5710
|
+
* @description get pre ipo company funding round by id
|
|
5711
|
+
* @tags PreIPOCompanies
|
|
5712
|
+
* @name GetPreIpoCompanyFundingRoundsById
|
|
5713
|
+
* @summary get pre ipo company funding round by id
|
|
5714
|
+
* @request GET:/ipos/pre-ipo-company-funding-rounds/{id}
|
|
5715
|
+
* @originalName getPreIpoCompanyFundingRounds
|
|
5716
|
+
* @duplicate
|
|
5556
5717
|
* @secure
|
|
5557
5718
|
*/
|
|
5558
|
-
|
|
5719
|
+
getPreIpoCompanyFundingRoundsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyFundingRound, HandleError>>;
|
|
5559
5720
|
/**
|
|
5560
|
-
* @description
|
|
5561
|
-
* @tags
|
|
5562
|
-
* @name
|
|
5563
|
-
* @summary
|
|
5564
|
-
* @request
|
|
5721
|
+
* @description get pre ipo company investments
|
|
5722
|
+
* @tags PreIPOCompanies
|
|
5723
|
+
* @name GetPreIpoCompanyInvestments
|
|
5724
|
+
* @summary get pre ipo company investments
|
|
5725
|
+
* @request GET:/ipos/pre-ipo-company-investments
|
|
5565
5726
|
* @secure
|
|
5566
5727
|
*/
|
|
5567
|
-
|
|
5728
|
+
getPreIpoCompanyInvestments(query: {
|
|
5729
|
+
/** company id */
|
|
5730
|
+
pre_ipo_company_id?: string;
|
|
5731
|
+
/** company name */
|
|
5732
|
+
company_name?: string;
|
|
5733
|
+
/** how many records to return. Max value is 50 */
|
|
5734
|
+
limit: number;
|
|
5735
|
+
/** how many records to skip */
|
|
5736
|
+
offset: number;
|
|
5737
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyInvestmentsResponse, HandleError>>;
|
|
5568
5738
|
/**
|
|
5569
|
-
* @description
|
|
5570
|
-
* @tags
|
|
5571
|
-
* @name
|
|
5572
|
-
* @summary
|
|
5573
|
-
* @request GET:/
|
|
5739
|
+
* @description get pre ipo company investment by id
|
|
5740
|
+
* @tags PreIPOCompanies
|
|
5741
|
+
* @name GetPreIpoCompanyInvestmentsById
|
|
5742
|
+
* @summary get pre ipo company investment by id
|
|
5743
|
+
* @request GET:/ipos/pre-ipo-company-investments/{id}
|
|
5744
|
+
* @originalName getPreIpoCompanyInvestments
|
|
5745
|
+
* @duplicate
|
|
5574
5746
|
* @secure
|
|
5575
5747
|
*/
|
|
5576
|
-
|
|
5577
|
-
/** Company symbol */
|
|
5578
|
-
symbol: string;
|
|
5579
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
|
|
5748
|
+
getPreIpoCompanyInvestmentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyInvestment, HandleError>>;
|
|
5580
5749
|
/**
|
|
5581
|
-
* @description
|
|
5582
|
-
* @tags
|
|
5583
|
-
* @name
|
|
5584
|
-
* @summary
|
|
5585
|
-
* @request GET:/
|
|
5750
|
+
* @description get pre ipo company news
|
|
5751
|
+
* @tags PreIPOCompanies
|
|
5752
|
+
* @name GetPreIpoCompanyNews
|
|
5753
|
+
* @summary get pre ipo company news
|
|
5754
|
+
* @request GET:/ipos/pre-ipo-company-news
|
|
5586
5755
|
* @secure
|
|
5587
5756
|
*/
|
|
5588
|
-
|
|
5589
|
-
/**
|
|
5590
|
-
|
|
5591
|
-
|
|
5757
|
+
getPreIpoCompanyNews(query: {
|
|
5758
|
+
/** company id */
|
|
5759
|
+
pre_ipo_company_id?: string;
|
|
5760
|
+
/** search by headline */
|
|
5761
|
+
headline?: string;
|
|
5762
|
+
/** how many records to return. Max value is 50 */
|
|
5763
|
+
limit: number;
|
|
5764
|
+
/** how many records to skip */
|
|
5765
|
+
offset: number;
|
|
5766
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyNewsResponse, HandleError>>;
|
|
5767
|
+
/**
|
|
5768
|
+
* @description get pre ipo company news by id
|
|
5769
|
+
* @tags PreIPOCompanies
|
|
5770
|
+
* @name GetPreIpoCompanyNewsById
|
|
5771
|
+
* @summary get pre ipo company news by id
|
|
5772
|
+
* @request GET:/ipos/pre-ipo-company-news/{id}
|
|
5773
|
+
* @originalName getPreIpoCompanyNews
|
|
5774
|
+
* @duplicate
|
|
5775
|
+
* @secure
|
|
5776
|
+
*/
|
|
5777
|
+
getPreIpoCompanyNewsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyNews, HandleError>>;
|
|
5778
|
+
/**
|
|
5779
|
+
* @description get pre ipo company research documents
|
|
5780
|
+
* @tags PreIPOCompanies
|
|
5781
|
+
* @name GetPreIpoCompanyResearchDocuments
|
|
5782
|
+
* @summary get pre ipo company research documents
|
|
5783
|
+
* @request GET:/ipos/pre-ipo-company-research-documents
|
|
5784
|
+
* @secure
|
|
5785
|
+
*/
|
|
5786
|
+
getPreIpoCompanyResearchDocuments(query: {
|
|
5787
|
+
/** company id */
|
|
5788
|
+
pre_ipo_company_id?: string;
|
|
5789
|
+
/** search by title */
|
|
5790
|
+
title?: string;
|
|
5791
|
+
/** how many records to return. Max value is 50 */
|
|
5792
|
+
limit: number;
|
|
5793
|
+
/** how many records to skip */
|
|
5794
|
+
offset: number;
|
|
5795
|
+
/** search by research type */
|
|
5796
|
+
research_type?: InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum;
|
|
5797
|
+
/** search by relation */
|
|
5798
|
+
relation?: InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum;
|
|
5799
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError>>;
|
|
5800
|
+
/**
|
|
5801
|
+
* @description get pre ipo company research document by id
|
|
5802
|
+
* @tags PreIPOCompanies
|
|
5803
|
+
* @name GetPreIpoCompanyResearchDocumentsById
|
|
5804
|
+
* @summary get pre ipo company research document by id
|
|
5805
|
+
* @request GET:/ipos/pre-ipo-company-research-documents/{id}
|
|
5806
|
+
* @originalName getPreIpoCompanyResearchDocuments
|
|
5807
|
+
* @duplicate
|
|
5808
|
+
* @secure
|
|
5809
|
+
*/
|
|
5810
|
+
getPreIpoCompanyResearchDocumentsById(id: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanyResearchDocument, HandleError>>;
|
|
5811
|
+
/**
|
|
5812
|
+
* @description get pre ipo company spvs with investor id
|
|
5813
|
+
* @tags PreIPOCompanies
|
|
5814
|
+
* @name GetInvestor
|
|
5815
|
+
* @summary get pre ipo company spvs with investor id
|
|
5816
|
+
* @request GET:/ipos/pre-ipo-company-spv/investor/{investor_id}
|
|
5817
|
+
* @secure
|
|
5818
|
+
*/
|
|
5819
|
+
getInvestor(investorId: string, query: {
|
|
5820
|
+
/** search by monark stage */
|
|
5821
|
+
monark_stage?: InsightGetInvestorParamsMonarkStageEnum;
|
|
5822
|
+
/** Optional param to filter returned spv's based on the exemptions claimed */
|
|
5823
|
+
exemptions_claimed?: string[];
|
|
5824
|
+
/** Optional param to filter returned spv's based on the name */
|
|
5825
|
+
name_filter?: string;
|
|
5826
|
+
/** investment id */
|
|
5827
|
+
pre_ipo_company_id?: string;
|
|
5828
|
+
/** investment id */
|
|
5829
|
+
pre_ipo_company_investment_id?: string;
|
|
5830
|
+
/** page number */
|
|
5831
|
+
page: number;
|
|
5832
|
+
/** page size */
|
|
5833
|
+
page_size: number;
|
|
5834
|
+
/** sort direction */
|
|
5835
|
+
sort_order?: InsightGetInvestorParamsSortOrderEnum;
|
|
5836
|
+
/** sort field */
|
|
5837
|
+
sort_by?: InsightGetInvestorParamsSortByEnum;
|
|
5838
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsWithInvestorIDResponse, HandleError>>;
|
|
5839
|
+
/**
|
|
5840
|
+
* @description get pre ipo company spv by id with investor id
|
|
5841
|
+
* @tags PreIPOCompanies
|
|
5842
|
+
* @name GetInvestorByIdAndInvestorId
|
|
5843
|
+
* @summary get pre ipo company spv by id with investor id
|
|
5844
|
+
* @request GET:/ipos/pre-ipo-company-spv/{id}/investor/{investor_id}
|
|
5845
|
+
* @originalName getInvestor
|
|
5846
|
+
* @duplicate
|
|
5847
|
+
* @secure
|
|
5848
|
+
*/
|
|
5849
|
+
getInvestorByIdAndInvestorId(id: string, investorId: string, query?: {
|
|
5850
|
+
/** default is false, if true documents will be included in the response */
|
|
5851
|
+
include_documents?: boolean;
|
|
5852
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetProIPOCompabySPVWithInvestorIDResponse, HandleError>>;
|
|
5853
|
+
/**
|
|
5854
|
+
* @description get pre ipo company spvs
|
|
5855
|
+
* @tags PreIPOCompanies
|
|
5856
|
+
* @name GetPreIpoCompanySpvs
|
|
5857
|
+
* @summary get pre ipo company spvs
|
|
5858
|
+
* @request GET:/ipos/pre-ipo-company-spvs
|
|
5859
|
+
* @secure
|
|
5860
|
+
*/
|
|
5861
|
+
getPreIpoCompanySpvs(query: {
|
|
5862
|
+
/** company id */
|
|
5863
|
+
pre_ipo_company_id?: string;
|
|
5864
|
+
/** investment id */
|
|
5865
|
+
investment_id?: string;
|
|
5866
|
+
/** search by name */
|
|
5867
|
+
name?: string;
|
|
5868
|
+
/** search by company name */
|
|
5869
|
+
company_name?: string;
|
|
5870
|
+
/** how many records to return. Max value is 50 */
|
|
5871
|
+
limit: number;
|
|
5872
|
+
/** how many records to skip */
|
|
5873
|
+
offset: number;
|
|
5874
|
+
/** search by monark stage */
|
|
5875
|
+
monark_stage?: InsightGetPreIpoCompanySpvsParamsMonarkStageEnum;
|
|
5876
|
+
/** sort direction */
|
|
5877
|
+
direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
|
|
5878
|
+
/** sort field */
|
|
5879
|
+
field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
|
|
5880
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
|
|
5881
|
+
/**
|
|
5882
|
+
* @description get pre ipo company spv by id
|
|
5883
|
+
* @tags PreIPOCompanies
|
|
5884
|
+
* @name GetPreIpoCompanySpvsById
|
|
5885
|
+
* @summary get pre ipo company spv by id
|
|
5886
|
+
* @request GET:/ipos/pre-ipo-company-spvs/{id}
|
|
5887
|
+
* @originalName getPreIpoCompanySpvs
|
|
5888
|
+
* @duplicate
|
|
5889
|
+
* @secure
|
|
5890
|
+
*/
|
|
5891
|
+
getPreIpoCompanySpvsById(id: string, query?: {
|
|
5892
|
+
/** default is false, if true documents will be included in the response */
|
|
5893
|
+
include_documents?: boolean;
|
|
5894
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
|
|
5592
5895
|
}
|
|
5593
5896
|
export class MarketDates<HandleError extends boolean = boolean> {
|
|
5594
5897
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -5610,7 +5913,7 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
5610
5913
|
* @request DELETE:/market-dates
|
|
5611
5914
|
* @secure
|
|
5612
5915
|
*/
|
|
5613
|
-
removeMarketDate(
|
|
5916
|
+
removeMarketDate(input: InsightRemoveMarketDateRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5614
5917
|
/**
|
|
5615
5918
|
* @description Get market dates history
|
|
5616
5919
|
* @tags MarketDates
|
|
@@ -5660,7 +5963,7 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
5660
5963
|
* @request GET:/market-dates/markets/{market}
|
|
5661
5964
|
* @secure
|
|
5662
5965
|
*/
|
|
5663
|
-
getMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
5966
|
+
getMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMarketWithSchedule, HandleError>>;
|
|
5664
5967
|
/**
|
|
5665
5968
|
* @description Remove market
|
|
5666
5969
|
* @tags MarketDates
|
|
@@ -5670,6 +5973,18 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
5670
5973
|
* @secure
|
|
5671
5974
|
*/
|
|
5672
5975
|
removeMarket(market: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
5976
|
+
/**
|
|
5977
|
+
* @description Get market schedules
|
|
5978
|
+
* @tags MarketDates
|
|
5979
|
+
* @name GetMarketSchedules
|
|
5980
|
+
* @summary Get market schedules
|
|
5981
|
+
* @request GET:/market-dates/schedule
|
|
5982
|
+
* @secure
|
|
5983
|
+
*/
|
|
5984
|
+
getMarketSchedules(query?: {
|
|
5985
|
+
/** Market codes, comma separated */
|
|
5986
|
+
market?: string;
|
|
5987
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetMarketScheduleResponse[][], HandleError>>;
|
|
5673
5988
|
/**
|
|
5674
5989
|
* @description CreateOrUpdateMarketSchedule market schedule
|
|
5675
5990
|
* @tags MarketDates
|
|
@@ -5697,18 +6012,6 @@ export class MarketDates<HandleError extends boolean = boolean> {
|
|
|
5697
6012
|
* @secure
|
|
5698
6013
|
*/
|
|
5699
6014
|
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
6015
|
/**
|
|
5713
6016
|
* @description Get todays market hours
|
|
5714
6017
|
* @tags MarketDates
|
|
@@ -5868,1241 +6171,1001 @@ export class News<HandleError extends boolean = boolean> {
|
|
|
5868
6171
|
*/
|
|
5869
6172
|
newsAvailableTags(filter: InsightHelpRequestWithSymbol, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
5870
6173
|
}
|
|
5871
|
-
export class
|
|
6174
|
+
export class Logos<HandleError extends boolean = boolean> {
|
|
5872
6175
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5873
6176
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5874
6177
|
/**
|
|
5875
|
-
* @description Returns
|
|
5876
|
-
* @tags
|
|
5877
|
-
* @name
|
|
5878
|
-
* @summary
|
|
5879
|
-
* @request POST:/
|
|
6178
|
+
* @description Returns converted logo for crypto symbol
|
|
6179
|
+
* @tags Logos
|
|
6180
|
+
* @name LogosConvertedCryptoSymbolLogo
|
|
6181
|
+
* @summary Get converted logo for crypto symbol
|
|
6182
|
+
* @request POST:/logos/converted-crypto-symbol-logo
|
|
5880
6183
|
* @secure
|
|
5881
6184
|
*/
|
|
5882
|
-
|
|
6185
|
+
logosConvertedCryptoSymbolLogo(filter: InsightCryptoLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5883
6186
|
/**
|
|
5884
|
-
* @description Returns
|
|
5885
|
-
* @tags
|
|
5886
|
-
* @name
|
|
5887
|
-
* @summary
|
|
5888
|
-
* @request POST:/
|
|
6187
|
+
* @description Returns converted logo for symbol
|
|
6188
|
+
* @tags Logos
|
|
6189
|
+
* @name LogosConvertedSymbolLogo
|
|
6190
|
+
* @summary Get converted logo for symbol
|
|
6191
|
+
* @request POST:/logos/converted-symbol-logo
|
|
5889
6192
|
* @secure
|
|
5890
6193
|
*/
|
|
5891
|
-
|
|
5892
|
-
}
|
|
5893
|
-
export class Ownerships<HandleError extends boolean = boolean> {
|
|
5894
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
5895
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6194
|
+
logosConvertedSymbolLogo(filter: InsightSymbolLogoConvertedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5896
6195
|
/**
|
|
5897
|
-
* @description
|
|
5898
|
-
* @tags
|
|
5899
|
-
* @name
|
|
5900
|
-
* @summary
|
|
5901
|
-
* @request
|
|
6196
|
+
* @description Returns logo for crypto symbol
|
|
6197
|
+
* @tags Logos
|
|
6198
|
+
* @name LogosCryptoSymbolLogo
|
|
6199
|
+
* @summary Get logo for crypto symbol
|
|
6200
|
+
* @request GET:/logos/crypto-symbol-logo
|
|
5902
6201
|
* @secure
|
|
5903
6202
|
*/
|
|
5904
|
-
|
|
6203
|
+
logosCryptoSymbolLogo(query: {
|
|
6204
|
+
/** Company symbol */
|
|
6205
|
+
symbol: string;
|
|
6206
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse, HandleError>>;
|
|
5905
6207
|
/**
|
|
5906
|
-
* @description
|
|
5907
|
-
* @tags
|
|
5908
|
-
* @name
|
|
5909
|
-
* @summary
|
|
5910
|
-
* @request
|
|
6208
|
+
* @description Returns direct logo for crypto symbol
|
|
6209
|
+
* @tags Logos
|
|
6210
|
+
* @name LogosDirectCryptoSymbolLogo
|
|
6211
|
+
* @summary Get direct logo for crypto symbol
|
|
6212
|
+
* @request GET:/logos/direct-crypto-symbol-logo
|
|
5911
6213
|
* @secure
|
|
5912
6214
|
*/
|
|
5913
|
-
|
|
5914
|
-
|
|
5915
|
-
|
|
5916
|
-
|
|
5917
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6215
|
+
logosDirectCryptoSymbolLogo(query: {
|
|
6216
|
+
/** Company symbol */
|
|
6217
|
+
symbol: string;
|
|
6218
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5918
6219
|
/**
|
|
5919
|
-
* @description Returns
|
|
5920
|
-
* @tags
|
|
5921
|
-
* @name
|
|
5922
|
-
* @summary Get
|
|
5923
|
-
* @request
|
|
6220
|
+
* @description Returns direct logo for symbol
|
|
6221
|
+
* @tags Logos
|
|
6222
|
+
* @name LogosDirectSymbolLogo
|
|
6223
|
+
* @summary Get direct logo for symbol
|
|
6224
|
+
* @request GET:/logos/direct-symbol-logo
|
|
5924
6225
|
* @secure
|
|
5925
6226
|
*/
|
|
5926
|
-
|
|
6227
|
+
logosDirectSymbolLogo(query: {
|
|
6228
|
+
/** Company symbol */
|
|
6229
|
+
symbol: string;
|
|
6230
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<number[], HandleError>>;
|
|
5927
6231
|
/**
|
|
5928
|
-
* @description Returns
|
|
5929
|
-
* @tags
|
|
5930
|
-
* @name
|
|
5931
|
-
* @summary Get
|
|
5932
|
-
* @request POST:/
|
|
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
|
|
6232
|
+
* @description Returns logos for multiple symbols
|
|
6233
|
+
* @tags Logos
|
|
6234
|
+
* @name LogosMultipleCryptoSymbolLogo
|
|
6235
|
+
* @summary Get logos for multiple symbols
|
|
6236
|
+
* @request POST:/logos/multiple-crypto-symbol-logo
|
|
5942
6237
|
* @secure
|
|
5943
6238
|
*/
|
|
5944
|
-
|
|
6239
|
+
logosMultipleCryptoSymbolLogo(filter: InsightMultipleCryptoLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCryptoLogosResponse[], HandleError>>;
|
|
5945
6240
|
/**
|
|
5946
|
-
* @description Returns
|
|
5947
|
-
* @tags
|
|
5948
|
-
* @name
|
|
5949
|
-
* @summary Get
|
|
5950
|
-
* @request POST:/
|
|
6241
|
+
* @description Returns logos for multiple symbol
|
|
6242
|
+
* @tags Logos
|
|
6243
|
+
* @name LogosMultipleSymbolLogos
|
|
6244
|
+
* @summary Get logos for multiple symbols
|
|
6245
|
+
* @request POST:/logos/multiple-symbol-logos
|
|
5951
6246
|
* @secure
|
|
5952
6247
|
*/
|
|
5953
|
-
|
|
6248
|
+
logosMultipleSymbolLogos(filter: InsightMultipleSymbolLogosRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse[], HandleError>>;
|
|
5954
6249
|
/**
|
|
5955
|
-
* @description Returns
|
|
5956
|
-
* @tags
|
|
5957
|
-
* @name
|
|
5958
|
-
* @summary Get
|
|
5959
|
-
* @request
|
|
6250
|
+
* @description Returns links of socials logos for symbol
|
|
6251
|
+
* @tags Logos
|
|
6252
|
+
* @name LogosSocialSymbolLogos
|
|
6253
|
+
* @summary Get social logos for symbol
|
|
6254
|
+
* @request GET:/logos/social-symbol-logos
|
|
5960
6255
|
* @secure
|
|
5961
6256
|
*/
|
|
5962
|
-
|
|
6257
|
+
logosSocialSymbolLogos(query: {
|
|
6258
|
+
/** Company symbol */
|
|
6259
|
+
symbol: string;
|
|
6260
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolSocialsResponse, HandleError>>;
|
|
5963
6261
|
/**
|
|
5964
|
-
* @description Returns
|
|
5965
|
-
* @tags
|
|
5966
|
-
* @name
|
|
5967
|
-
* @summary
|
|
5968
|
-
* @request
|
|
6262
|
+
* @description Returns logos for company symbol
|
|
6263
|
+
* @tags Logos
|
|
6264
|
+
* @name LogosSymbolLogos
|
|
6265
|
+
* @summary Get symbol logos
|
|
6266
|
+
* @request GET:/logos/symbol-logos
|
|
5969
6267
|
* @secure
|
|
5970
6268
|
*/
|
|
5971
|
-
|
|
6269
|
+
logosSymbolLogos(query: {
|
|
6270
|
+
/** Company symbol */
|
|
6271
|
+
symbol: string;
|
|
6272
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSymbolLogosResponse, HandleError>>;
|
|
5972
6273
|
}
|
|
5973
|
-
export class
|
|
6274
|
+
export class Public<HandleError extends boolean = boolean> {
|
|
5974
6275
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
5975
6276
|
constructor(apiClient: JwtClient<HandleError>);
|
|
5976
6277
|
/**
|
|
5977
|
-
* @description
|
|
5978
|
-
* @tags
|
|
5979
|
-
* @name
|
|
5980
|
-
* @summary
|
|
5981
|
-
* @request GET:/
|
|
6278
|
+
* @description Calculate estimated returns for selected symbols. Uses split adjusted prices
|
|
6279
|
+
* @tags Public
|
|
6280
|
+
* @name CalculateEstimatedReturns
|
|
6281
|
+
* @summary Calculate Estimated Returns
|
|
6282
|
+
* @request GET:/public/estimated-returns
|
|
5982
6283
|
* @secure
|
|
5983
6284
|
*/
|
|
5984
|
-
|
|
5985
|
-
/**
|
|
5986
|
-
|
|
5987
|
-
/**
|
|
5988
|
-
|
|
5989
|
-
|
|
5990
|
-
|
|
5991
|
-
|
|
5992
|
-
|
|
5993
|
-
|
|
5994
|
-
|
|
5995
|
-
|
|
5996
|
-
|
|
5997
|
-
open?: number;
|
|
5998
|
-
time?: string;
|
|
5999
|
-
volume?: number;
|
|
6000
|
-
}[], HandleError>>;
|
|
6285
|
+
calculateEstimatedReturns(query: {
|
|
6286
|
+
/** Single symbol */
|
|
6287
|
+
symbol: string;
|
|
6288
|
+
/**
|
|
6289
|
+
* Non-zero amount
|
|
6290
|
+
* @format float64
|
|
6291
|
+
*/
|
|
6292
|
+
amount: number;
|
|
6293
|
+
/** Start date for calculations */
|
|
6294
|
+
start_date: string;
|
|
6295
|
+
/** End date for calculations */
|
|
6296
|
+
end_date: string;
|
|
6297
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateEstimatedReturnsResponse, HandleError>>;
|
|
6001
6298
|
/**
|
|
6002
|
-
* @description
|
|
6003
|
-
* @tags
|
|
6004
|
-
* @name
|
|
6005
|
-
* @summary
|
|
6006
|
-
* @request GET:/
|
|
6299
|
+
* @description Returns an expert forecast
|
|
6300
|
+
* @tags Public
|
|
6301
|
+
* @name ExpertForecast
|
|
6302
|
+
* @summary Expert forecast
|
|
6303
|
+
* @request GET:/public/expert-forecast
|
|
6007
6304
|
* @secure
|
|
6008
6305
|
*/
|
|
6009
|
-
|
|
6306
|
+
expertForecast(query: {
|
|
6307
|
+
/** Comma separated symbols */
|
|
6308
|
+
symbols: string;
|
|
6309
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightExpertForecast[][], HandleError>>;
|
|
6010
6310
|
/**
|
|
6011
|
-
* @description get
|
|
6012
|
-
* @tags
|
|
6013
|
-
* @name
|
|
6014
|
-
* @summary get
|
|
6015
|
-
* @request GET:/
|
|
6311
|
+
* @description get fundamentals by symbol data
|
|
6312
|
+
* @tags Public
|
|
6313
|
+
* @name GetPublicFundamentalsBySymbolData
|
|
6314
|
+
* @summary get fundamentals by symbol data
|
|
6315
|
+
* @request GET:/public/fundamentals/{symbol}
|
|
6016
6316
|
* @secure
|
|
6017
6317
|
*/
|
|
6018
|
-
|
|
6019
|
-
/**
|
|
6020
|
-
|
|
6021
|
-
|
|
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;
|
|
6035
|
-
/** how many records to return. Max value is 50 */
|
|
6036
|
-
limit: number;
|
|
6037
|
-
/** how many records to skip */
|
|
6038
|
-
offset: number;
|
|
6039
|
-
/** sort field */
|
|
6040
|
-
order_field?: InsightGetPreIpoCompaniesParamsOrderFieldEnum;
|
|
6041
|
-
/** sort direction */
|
|
6042
|
-
order_direction?: InsightGetPreIpoCompaniesParamsOrderDirectionEnum;
|
|
6043
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompaniesResponse, HandleError>>;
|
|
6318
|
+
getPublicFundamentalsBySymbolData(symbol: string, query: {
|
|
6319
|
+
/** Annual or quarterly */
|
|
6320
|
+
mode: string;
|
|
6321
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
6044
6322
|
/**
|
|
6045
|
-
* @description
|
|
6046
|
-
* @tags
|
|
6047
|
-
* @name
|
|
6048
|
-
* @summary
|
|
6049
|
-
* @request GET:/
|
|
6050
|
-
* @originalName getPreIpoCompanies
|
|
6051
|
-
* @duplicate
|
|
6323
|
+
* @description Daily price history
|
|
6324
|
+
* @tags Public
|
|
6325
|
+
* @name DailyPriceHistory
|
|
6326
|
+
* @summary Daily price history
|
|
6327
|
+
* @request GET:/public/price-history/daily
|
|
6052
6328
|
* @secure
|
|
6053
6329
|
*/
|
|
6054
|
-
|
|
6330
|
+
dailyPriceHistory(query: {
|
|
6331
|
+
/** Single symbol */
|
|
6332
|
+
symbol: string;
|
|
6333
|
+
/** Target date */
|
|
6334
|
+
date: string;
|
|
6335
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightDailyPriceHistoryResponse, HandleError>>;
|
|
6055
6336
|
/**
|
|
6056
|
-
* @description
|
|
6057
|
-
* @tags
|
|
6058
|
-
* @name
|
|
6059
|
-
* @summary
|
|
6060
|
-
* @request GET:/
|
|
6337
|
+
* @description Public quote profile
|
|
6338
|
+
* @tags Public
|
|
6339
|
+
* @name PublicQuoteProfile
|
|
6340
|
+
* @summary Public quote profile
|
|
6341
|
+
* @request GET:/public/quote-profile/{symbol}
|
|
6061
6342
|
* @secure
|
|
6062
6343
|
*/
|
|
6063
|
-
|
|
6064
|
-
/** company id */
|
|
6065
|
-
pre_ipo_company_id?: string;
|
|
6066
|
-
/** search by round name */
|
|
6067
|
-
round_name?: string;
|
|
6068
|
-
/** how many records to return. Max value is 50 */
|
|
6069
|
-
limit: number;
|
|
6070
|
-
/** how many records to skip */
|
|
6071
|
-
offset: number;
|
|
6072
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyFundingRoundsResponse, HandleError>>;
|
|
6344
|
+
publicQuoteProfile(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPublicQuoteProfile, HandleError>>;
|
|
6073
6345
|
/**
|
|
6074
|
-
* @description get
|
|
6075
|
-
* @tags
|
|
6076
|
-
* @name
|
|
6077
|
-
* @summary get
|
|
6078
|
-
* @request GET:/
|
|
6079
|
-
* @originalName getPreIpoCompanyFundingRounds
|
|
6080
|
-
* @duplicate
|
|
6346
|
+
* @description get ratios by symbol data
|
|
6347
|
+
* @tags Public
|
|
6348
|
+
* @name GetPublicRatiosBySymbolData
|
|
6349
|
+
* @summary get ratios by symbol data
|
|
6350
|
+
* @request GET:/public/ratios/{symbol}
|
|
6081
6351
|
* @secure
|
|
6082
6352
|
*/
|
|
6083
|
-
|
|
6353
|
+
getPublicRatiosBySymbolData(symbol: string, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightRatios, HandleError>>;
|
|
6084
6354
|
/**
|
|
6085
|
-
* @description
|
|
6086
|
-
* @tags
|
|
6087
|
-
* @name
|
|
6088
|
-
* @summary
|
|
6089
|
-
* @request GET:/
|
|
6355
|
+
* @description find a symbol by name or description
|
|
6356
|
+
* @tags Public
|
|
6357
|
+
* @name QuoteFundamentalsSearch
|
|
6358
|
+
* @summary find a symbol by name or description
|
|
6359
|
+
* @request GET:/public/symbol-search
|
|
6090
6360
|
* @secure
|
|
6091
6361
|
*/
|
|
6092
|
-
|
|
6093
|
-
/**
|
|
6094
|
-
|
|
6095
|
-
/** company name */
|
|
6096
|
-
company_name?: string;
|
|
6362
|
+
quoteFundamentalsSearch(query: {
|
|
6363
|
+
/** Search query */
|
|
6364
|
+
search_query: string;
|
|
6097
6365
|
/** how many records to return. Max value is 50 */
|
|
6098
6366
|
limit: number;
|
|
6099
6367
|
/** how many records to skip */
|
|
6100
6368
|
offset: number;
|
|
6101
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
6369
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
|
|
6102
6370
|
/**
|
|
6103
|
-
* @description
|
|
6104
|
-
* @tags
|
|
6105
|
-
* @name
|
|
6106
|
-
* @summary
|
|
6107
|
-
* @request GET:/
|
|
6108
|
-
* @originalName getPreIpoCompanyInvestments
|
|
6109
|
-
* @duplicate
|
|
6371
|
+
* @description Get top gainers
|
|
6372
|
+
* @tags Public
|
|
6373
|
+
* @name TopGainers
|
|
6374
|
+
* @summary Top Gainers
|
|
6375
|
+
* @request GET:/public/top-gainers
|
|
6110
6376
|
* @secure
|
|
6111
6377
|
*/
|
|
6112
|
-
|
|
6378
|
+
topGainers(query: {
|
|
6379
|
+
/** sort direction - asc or desc */
|
|
6380
|
+
order_direction?: string;
|
|
6381
|
+
/** how many records to return. Max value is 50 */
|
|
6382
|
+
limit: number;
|
|
6383
|
+
/** how many records to skip */
|
|
6384
|
+
offset: number;
|
|
6385
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6113
6386
|
/**
|
|
6114
|
-
* @description
|
|
6115
|
-
* @tags
|
|
6116
|
-
* @name
|
|
6117
|
-
* @summary
|
|
6118
|
-
* @request GET:/
|
|
6387
|
+
* @description Get top stocks
|
|
6388
|
+
* @tags Public
|
|
6389
|
+
* @name TopStocks
|
|
6390
|
+
* @summary Top Stocks
|
|
6391
|
+
* @request GET:/public/top-stocks
|
|
6119
6392
|
* @secure
|
|
6120
6393
|
*/
|
|
6121
|
-
|
|
6122
|
-
/**
|
|
6123
|
-
|
|
6124
|
-
/** search by headline */
|
|
6125
|
-
headline?: string;
|
|
6394
|
+
topStocks(query: {
|
|
6395
|
+
/** EQUITY|ETF|CRYPTO */
|
|
6396
|
+
stock_type: InsightTopStocksParamsStockTypeEnum;
|
|
6126
6397
|
/** how many records to return. Max value is 50 */
|
|
6127
6398
|
limit: number;
|
|
6128
6399
|
/** how many records to skip */
|
|
6129
6400
|
offset: number;
|
|
6130
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
6401
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6402
|
+
}
|
|
6403
|
+
export class AlphaTools<HandleError extends boolean = boolean> {
|
|
6404
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6405
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6131
6406
|
/**
|
|
6132
|
-
* @description get
|
|
6133
|
-
* @tags
|
|
6134
|
-
* @name
|
|
6135
|
-
* @summary get
|
|
6136
|
-
* @request
|
|
6137
|
-
* @originalName getPreIpoCompanyNews
|
|
6138
|
-
* @duplicate
|
|
6407
|
+
* @description get seasonlity data with comparison to benchmark
|
|
6408
|
+
* @tags AlphaTools
|
|
6409
|
+
* @name GetMomentumRatioGraph
|
|
6410
|
+
* @summary get seasonlity data
|
|
6411
|
+
* @request POST:/rst
|
|
6139
6412
|
* @secure
|
|
6140
6413
|
*/
|
|
6141
|
-
|
|
6414
|
+
getMomentumRatioGraph(filter: InsightMomentumRatioGraphRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightMomentumRatioGraphResponse, HandleError>>;
|
|
6142
6415
|
/**
|
|
6143
|
-
* @description get
|
|
6144
|
-
* @tags
|
|
6145
|
-
* @name
|
|
6146
|
-
* @summary get
|
|
6147
|
-
* @request
|
|
6416
|
+
* @description get seasonlity data with comparison to benchmark
|
|
6417
|
+
* @tags AlphaTools
|
|
6418
|
+
* @name GetSeasonality
|
|
6419
|
+
* @summary get seasonlity data
|
|
6420
|
+
* @request POST:/seasonality
|
|
6148
6421
|
* @secure
|
|
6149
6422
|
*/
|
|
6150
|
-
|
|
6151
|
-
|
|
6152
|
-
|
|
6153
|
-
|
|
6154
|
-
|
|
6155
|
-
/** how many records to return. Max value is 50 */
|
|
6156
|
-
limit: number;
|
|
6157
|
-
/** how many records to skip */
|
|
6158
|
-
offset: number;
|
|
6159
|
-
/** search by research type */
|
|
6160
|
-
research_type?: InsightGetPreIpoCompanyResearchDocumentsParamsResearchTypeEnum;
|
|
6161
|
-
/** search by relation */
|
|
6162
|
-
relation?: InsightGetPreIpoCompanyResearchDocumentsParamsRelationEnum;
|
|
6163
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanyResearchDocumentsResponse, HandleError>>;
|
|
6423
|
+
getSeasonality(filter: InsightSeasonalityRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSeasonalityResponse, HandleError>>;
|
|
6424
|
+
}
|
|
6425
|
+
export class TipRank<HandleError extends boolean = boolean> {
|
|
6426
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6427
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6164
6428
|
/**
|
|
6165
|
-
* @description
|
|
6166
|
-
* @tags
|
|
6167
|
-
* @name
|
|
6168
|
-
* @summary
|
|
6169
|
-
* @request
|
|
6170
|
-
* @originalName getPreIpoCompanyResearchDocuments
|
|
6171
|
-
* @duplicate
|
|
6429
|
+
* @description Returns an overview of analyst ratings for a given ticker or ticker list, based on analyst ratings from the last 3 months.
|
|
6430
|
+
* @tags TipRank
|
|
6431
|
+
* @name TiprankAnalystConsensus
|
|
6432
|
+
* @summary Get tiprank AnalystConsensus
|
|
6433
|
+
* @request POST:/tipranks/analyst-consensus
|
|
6172
6434
|
* @secure
|
|
6173
6435
|
*/
|
|
6174
|
-
|
|
6436
|
+
tiprankAnalystConsensus(filter: InsightAnalystConsensusRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystConsensusResponse[], HandleError>>;
|
|
6175
6437
|
/**
|
|
6176
|
-
* @description
|
|
6177
|
-
* @tags
|
|
6178
|
-
* @name
|
|
6179
|
-
* @summary
|
|
6180
|
-
* @request
|
|
6438
|
+
* @description Returns the latest analyst ratings on a given stock or multiple stocks.
|
|
6439
|
+
* @tags TipRank
|
|
6440
|
+
* @name TiprankLatestAnalystRatingsOnStock
|
|
6441
|
+
* @summary Get tiprank LatestAnalystRatingsOnStock
|
|
6442
|
+
* @request POST:/tipranks/analyst-multi
|
|
6181
6443
|
* @secure
|
|
6182
6444
|
*/
|
|
6183
|
-
|
|
6184
|
-
/** search by monark stage */
|
|
6185
|
-
monark_stage?: InsightGetInvestorParamsMonarkStageEnum;
|
|
6186
|
-
/** Optional param to filter returned spv's based on the exemptions claimed */
|
|
6187
|
-
exemptions_claimed?: string[];
|
|
6188
|
-
/** Optional param to filter returned spv's based on the name */
|
|
6189
|
-
name_filter?: string;
|
|
6190
|
-
/** investment id */
|
|
6191
|
-
pre_ipo_company_id?: string;
|
|
6192
|
-
/** investment id */
|
|
6193
|
-
pre_ipo_company_investment_id?: string;
|
|
6194
|
-
/** page number */
|
|
6195
|
-
page: number;
|
|
6196
|
-
/** page size */
|
|
6197
|
-
page_size: number;
|
|
6198
|
-
/** sort direction */
|
|
6199
|
-
sort_order?: InsightGetInvestorParamsSortOrderEnum;
|
|
6200
|
-
/** sort field */
|
|
6201
|
-
sort_by?: InsightGetInvestorParamsSortByEnum;
|
|
6202
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsWithInvestorIDResponse, HandleError>>;
|
|
6445
|
+
tiprankLatestAnalystRatingsOnStock(filter: InsightLatestAnalystRatingsOnStockRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLatestAnalystRatingsOnStockResponse[], HandleError>>;
|
|
6203
6446
|
/**
|
|
6204
|
-
* @description
|
|
6205
|
-
* @tags
|
|
6206
|
-
* @name
|
|
6207
|
-
* @summary
|
|
6208
|
-
* @request
|
|
6209
|
-
* @originalName getInvestor
|
|
6210
|
-
* @duplicate
|
|
6447
|
+
* @description Returns the latest analyst portfolio items.
|
|
6448
|
+
* @tags TipRank
|
|
6449
|
+
* @name TiprankPortfolios
|
|
6450
|
+
* @summary Get the latest analyst portfolio items
|
|
6451
|
+
* @request POST:/tipranks/analyst-portfolio
|
|
6211
6452
|
* @secure
|
|
6212
6453
|
*/
|
|
6213
|
-
|
|
6214
|
-
/**
|
|
6215
|
-
|
|
6216
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
6454
|
+
tiprankPortfolios(filter: InsightPortfoliosRequest, headers?: {
|
|
6455
|
+
/** Authorization */
|
|
6456
|
+
Authorization?: string;
|
|
6457
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPortfoliosResponse[], HandleError>>;
|
|
6217
6458
|
/**
|
|
6218
|
-
* @description
|
|
6219
|
-
* @tags
|
|
6220
|
-
* @name
|
|
6221
|
-
* @summary
|
|
6222
|
-
* @request GET:/
|
|
6459
|
+
* @description Returns the analyst profile information
|
|
6460
|
+
* @tags TipRank
|
|
6461
|
+
* @name TiprankAnalystProfile
|
|
6462
|
+
* @summary Get tiprank AnalystProfile
|
|
6463
|
+
* @request GET:/tipranks/analyst-profile
|
|
6223
6464
|
* @secure
|
|
6224
6465
|
*/
|
|
6225
|
-
|
|
6226
|
-
/**
|
|
6227
|
-
|
|
6228
|
-
|
|
6229
|
-
investment_id?: string;
|
|
6230
|
-
/** search by name */
|
|
6231
|
-
name?: string;
|
|
6232
|
-
/** search by company name */
|
|
6233
|
-
company_name?: string;
|
|
6234
|
-
/** how many records to return. Max value is 50 */
|
|
6235
|
-
limit: number;
|
|
6236
|
-
/** how many records to skip */
|
|
6237
|
-
offset: number;
|
|
6238
|
-
/** search by monark stage */
|
|
6239
|
-
monark_stage?: InsightGetPreIpoCompanySpvsParamsMonarkStageEnum;
|
|
6240
|
-
/** sort direction */
|
|
6241
|
-
direction?: InsightGetPreIpoCompanySpvsParamsDirectionEnum;
|
|
6242
|
-
/** sort field */
|
|
6243
|
-
field?: InsightGetPreIpoCompanySpvsParamsFieldEnum;
|
|
6244
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetPreIPOCompanySPVsResponse, HandleError>>;
|
|
6466
|
+
tiprankAnalystProfile(query: {
|
|
6467
|
+
/** ID of tiprank analyst profile */
|
|
6468
|
+
id: string;
|
|
6469
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystProfileResponse, HandleError>>;
|
|
6245
6470
|
/**
|
|
6246
|
-
* @description
|
|
6247
|
-
* @tags
|
|
6248
|
-
* @name
|
|
6249
|
-
* @summary
|
|
6250
|
-
* @request GET:/
|
|
6251
|
-
* @originalName getPreIpoCompanySpvs
|
|
6252
|
-
* @duplicate
|
|
6471
|
+
* @description Returns the URL prefix to the expertPictureUrl field.
|
|
6472
|
+
* @tags TipRank
|
|
6473
|
+
* @name TiprankAnalystsExpertPictureStore
|
|
6474
|
+
* @summary Get tiprank AnalystsExpertPictureStore
|
|
6475
|
+
* @request GET:/tipranks/analysts-expert-picture-store
|
|
6253
6476
|
* @secure
|
|
6254
6477
|
*/
|
|
6255
|
-
|
|
6256
|
-
/** default is false, if true documents will be included in the response */
|
|
6257
|
-
include_documents?: boolean;
|
|
6258
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightPreIPOCompanySPV, HandleError>>;
|
|
6259
|
-
}
|
|
6260
|
-
export class Public<HandleError extends boolean = boolean> {
|
|
6261
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6262
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6478
|
+
tiprankAnalystsExpertPictureStore(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystsExpertPictureStoreResponse, HandleError>>;
|
|
6263
6479
|
/**
|
|
6264
|
-
* @description
|
|
6265
|
-
* @tags
|
|
6266
|
-
* @name
|
|
6267
|
-
* @summary
|
|
6268
|
-
* @request GET:/
|
|
6480
|
+
* @description Returns a list of top-ranked analysts.
|
|
6481
|
+
* @tags TipRank
|
|
6482
|
+
* @name TiprankBestPerformingExperts
|
|
6483
|
+
* @summary Get tiprank BestPerformingExperts
|
|
6484
|
+
* @request GET:/tipranks/best-performing-experts
|
|
6269
6485
|
* @secure
|
|
6270
6486
|
*/
|
|
6271
|
-
|
|
6272
|
-
/**
|
|
6273
|
-
|
|
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>>;
|
|
6487
|
+
tiprankBestPerformingExperts(query?: {
|
|
6488
|
+
/** The number of analysts to return */
|
|
6489
|
+
num?: number;
|
|
6490
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightBestPerformingExpertsResponse[], HandleError>>;
|
|
6284
6491
|
/**
|
|
6285
|
-
* @description Returns
|
|
6286
|
-
* @tags
|
|
6287
|
-
* @name
|
|
6288
|
-
* @summary
|
|
6289
|
-
* @request GET:/
|
|
6492
|
+
* @description Returns the blogger consensus on the stock along with the blogger opinion distribution by site.
|
|
6493
|
+
* @tags TipRank
|
|
6494
|
+
* @name TiprankBloggerConsensusOnStock
|
|
6495
|
+
* @summary Get tiprank BloggerConsensusOnStock
|
|
6496
|
+
* @request GET:/tipranks/blogger-consensus-on-stock
|
|
6290
6497
|
* @secure
|
|
6291
6498
|
*/
|
|
6292
|
-
|
|
6293
|
-
/**
|
|
6294
|
-
|
|
6295
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
6499
|
+
tiprankBloggerConsensusOnStock(query: {
|
|
6500
|
+
/** The ticker of the stock */
|
|
6501
|
+
ticker: string;
|
|
6502
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightBloggerConsensusOnStockResponse[], HandleError>>;
|
|
6296
6503
|
/**
|
|
6297
|
-
* @description
|
|
6298
|
-
* @tags
|
|
6299
|
-
* @name
|
|
6300
|
-
* @summary
|
|
6301
|
-
* @request GET:/
|
|
6504
|
+
* @description Returns a list of the upcoming IPOs and recent IPOs that have already been priced
|
|
6505
|
+
* @tags TipRank
|
|
6506
|
+
* @name TiprankCalendarsIpos
|
|
6507
|
+
* @summary Get tiprank CalendarsIPOS
|
|
6508
|
+
* @request GET:/tipranks/calendars-ipos
|
|
6302
6509
|
* @secure
|
|
6303
6510
|
*/
|
|
6304
|
-
|
|
6305
|
-
/** Annual or quarterly */
|
|
6306
|
-
mode: string;
|
|
6307
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetSymbolFundamentalsAnnualResponse, HandleError>>;
|
|
6511
|
+
tiprankCalendarsIpos(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalendarsIPOSResponse[], HandleError>>;
|
|
6308
6512
|
/**
|
|
6309
|
-
* @description
|
|
6310
|
-
* @tags
|
|
6311
|
-
* @name
|
|
6312
|
-
* @summary
|
|
6313
|
-
* @request GET:/
|
|
6513
|
+
* @description Returns all stocks that have been updated since a specified UTC time.
|
|
6514
|
+
* @tags TipRank
|
|
6515
|
+
* @name TiprankGeneralStockUpdates
|
|
6516
|
+
* @summary Get tiprank GeneralStockUpdates
|
|
6517
|
+
* @request GET:/tipranks/general-stock-updates
|
|
6314
6518
|
* @secure
|
|
6315
6519
|
*/
|
|
6316
|
-
|
|
6317
|
-
/**
|
|
6318
|
-
|
|
6319
|
-
/**
|
|
6320
|
-
|
|
6321
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
6520
|
+
tiprankGeneralStockUpdates(query?: {
|
|
6521
|
+
/** The specific requested time */
|
|
6522
|
+
utc_time?: string;
|
|
6523
|
+
/** Level of detail on updated stocks */
|
|
6524
|
+
details?: InsightTiprankGeneralStockUpdatesParamsDetailsEnum;
|
|
6525
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGeneralStockUpdatesResponse, HandleError>>;
|
|
6322
6526
|
/**
|
|
6323
|
-
* @description
|
|
6324
|
-
* @tags
|
|
6325
|
-
* @name
|
|
6326
|
-
* @summary
|
|
6327
|
-
* @request GET:/
|
|
6527
|
+
* @description Returns all hedge funds that have a position on a given stock along with the hedge fund activity trends and consensus.
|
|
6528
|
+
* @tags TipRank
|
|
6529
|
+
* @name TiprankHedgefunds
|
|
6530
|
+
* @summary Get tiprank HedgeFunds
|
|
6531
|
+
* @request GET:/tipranks/hedgefunds
|
|
6328
6532
|
* @secure
|
|
6329
6533
|
*/
|
|
6330
|
-
|
|
6534
|
+
tiprankHedgefunds(query: {
|
|
6535
|
+
/** The ticker of the stock */
|
|
6536
|
+
ticker: string;
|
|
6537
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsResponse[], HandleError>>;
|
|
6331
6538
|
/**
|
|
6332
|
-
* @description
|
|
6333
|
-
* @tags
|
|
6334
|
-
* @name
|
|
6335
|
-
* @summary
|
|
6336
|
-
* @request GET:/
|
|
6539
|
+
* @description Returns a list of top-ranked hedge fund managers.
|
|
6540
|
+
* @tags TipRank
|
|
6541
|
+
* @name TiprankHedgefundsBestPerformingExperts
|
|
6542
|
+
* @summary Get tiprank HedgeFundsBestPerformingExperts
|
|
6543
|
+
* @request GET:/tipranks/hedgefunds-best-performing-experts
|
|
6337
6544
|
* @secure
|
|
6338
6545
|
*/
|
|
6339
|
-
|
|
6546
|
+
tiprankHedgefundsBestPerformingExperts(query?: {
|
|
6547
|
+
/** The number of hedge fund managers to return */
|
|
6548
|
+
num?: number;
|
|
6549
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsBestPerformingExpertsResponse[], HandleError>>;
|
|
6340
6550
|
/**
|
|
6341
|
-
* @description
|
|
6342
|
-
* @tags
|
|
6343
|
-
* @name
|
|
6344
|
-
* @summary
|
|
6345
|
-
* @request GET:/
|
|
6551
|
+
* @description Returns the biggest 200 hedge fund transactions from the last quarter filtered based on minStars. Returns at most 50 transactions, sorted by size (biggest on top).
|
|
6552
|
+
* @tags TipRank
|
|
6553
|
+
* @name TiprankHedgefundsRecentTransactions
|
|
6554
|
+
* @summary Get tiprank HedgefundsRecentTransactions
|
|
6555
|
+
* @request GET:/tipranks/hedgefunds-recent-transactions
|
|
6346
6556
|
* @secure
|
|
6347
6557
|
*/
|
|
6348
|
-
|
|
6349
|
-
/**
|
|
6350
|
-
|
|
6351
|
-
/**
|
|
6352
|
-
|
|
6353
|
-
|
|
6354
|
-
offset: number;
|
|
6355
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightQuoteFundamentalsSearchResponse, HandleError>>;
|
|
6558
|
+
tiprankHedgefundsRecentTransactions(query?: {
|
|
6559
|
+
/** Show only managers with these number of stars or higher */
|
|
6560
|
+
min_stars?: number;
|
|
6561
|
+
/** The order of the latest insider transactions */
|
|
6562
|
+
sort?: InsightTiprankHedgefundsRecentTransactionsParamsSortEnum;
|
|
6563
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsRecentTransactionsResponse[], HandleError>>;
|
|
6356
6564
|
/**
|
|
6357
|
-
* @description
|
|
6358
|
-
* @tags
|
|
6359
|
-
* @name
|
|
6360
|
-
* @summary
|
|
6361
|
-
* @request GET:/
|
|
6565
|
+
* @description Returns the latest insider transactions and an overall sentiment on a given stock.
|
|
6566
|
+
* @tags TipRank
|
|
6567
|
+
* @name TiprankInsiders
|
|
6568
|
+
* @summary Get tiprank Insiders
|
|
6569
|
+
* @request GET:/tipranks/insiders
|
|
6362
6570
|
* @secure
|
|
6363
6571
|
*/
|
|
6364
|
-
|
|
6365
|
-
/**
|
|
6366
|
-
|
|
6367
|
-
|
|
6368
|
-
limit: number;
|
|
6369
|
-
/** how many records to skip */
|
|
6370
|
-
offset: number;
|
|
6371
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6572
|
+
tiprankInsiders(query: {
|
|
6573
|
+
/** The ticker of the stock */
|
|
6574
|
+
ticker: string;
|
|
6575
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersResponse[], HandleError>>;
|
|
6372
6576
|
/**
|
|
6373
|
-
* @description
|
|
6374
|
-
* @tags
|
|
6375
|
-
* @name
|
|
6376
|
-
* @summary
|
|
6377
|
-
* @request GET:/
|
|
6577
|
+
* @description Returns a list of top ranked insiders.
|
|
6578
|
+
* @tags TipRank
|
|
6579
|
+
* @name TiprankInsidersBestPerformingExperts
|
|
6580
|
+
* @summary Get tiprank InsidersBestPerformingExperts
|
|
6581
|
+
* @request GET:/tipranks/insiders-best-performing-experts
|
|
6378
6582
|
* @secure
|
|
6379
6583
|
*/
|
|
6380
|
-
|
|
6381
|
-
/**
|
|
6382
|
-
|
|
6383
|
-
|
|
6384
|
-
limit: number;
|
|
6385
|
-
/** how many records to skip */
|
|
6386
|
-
offset: number;
|
|
6387
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksResponse, HandleError>>;
|
|
6388
|
-
}
|
|
6389
|
-
export class Quotes<HandleError extends boolean = boolean> {
|
|
6390
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6391
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6584
|
+
tiprankInsidersBestPerformingExperts(query?: {
|
|
6585
|
+
/** The number of insiders to return */
|
|
6586
|
+
num?: number;
|
|
6587
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersBestPerformingExpertsResponse[], HandleError>>;
|
|
6392
6588
|
/**
|
|
6393
|
-
* @description
|
|
6394
|
-
* @tags
|
|
6395
|
-
* @name
|
|
6396
|
-
* @summary Get
|
|
6397
|
-
* @request GET:/
|
|
6589
|
+
* @description Returns all the information required to build TipRanks Insider Hot Stocks.
|
|
6590
|
+
* @tags TipRank
|
|
6591
|
+
* @name TiprankInsidersHotstocks
|
|
6592
|
+
* @summary Get tiprank InsidersHotstocks
|
|
6593
|
+
* @request GET:/tipranks/insiders-hotstocks
|
|
6398
6594
|
* @secure
|
|
6399
6595
|
*/
|
|
6400
|
-
|
|
6401
|
-
/** Symbol */
|
|
6402
|
-
symbol: string;
|
|
6403
|
-
/** Date */
|
|
6404
|
-
date: string;
|
|
6405
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHistoricalQuote, HandleError>>;
|
|
6596
|
+
tiprankInsidersHotstocks(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersHotstocksResponse[], HandleError>>;
|
|
6406
6597
|
/**
|
|
6407
|
-
* @description
|
|
6408
|
-
* @tags
|
|
6409
|
-
* @name
|
|
6410
|
-
* @summary Get
|
|
6411
|
-
* @request
|
|
6598
|
+
* @description Returns a feed of the latest insider transactions reported to the SEC.
|
|
6599
|
+
* @tags TipRank
|
|
6600
|
+
* @name TiprankInsidersLiveFeed
|
|
6601
|
+
* @summary Get tiprank InsidersLiveFeed
|
|
6602
|
+
* @request GET:/tipranks/insiders-live-feed
|
|
6412
6603
|
* @secure
|
|
6413
6604
|
*/
|
|
6414
|
-
|
|
6605
|
+
tiprankInsidersLiveFeed(query?: {
|
|
6606
|
+
/** Return the latest X transactions */
|
|
6607
|
+
num?: number;
|
|
6608
|
+
/** The order of the latest insider transactions */
|
|
6609
|
+
sort?: InsightTiprankInsidersLiveFeedParamsSortEnum;
|
|
6610
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersLiveFeedResponse[], HandleError>>;
|
|
6415
6611
|
/**
|
|
6416
|
-
* @description Returns
|
|
6417
|
-
* @tags
|
|
6418
|
-
* @name
|
|
6419
|
-
* @summary Get
|
|
6420
|
-
* @request GET:/
|
|
6612
|
+
* @description Returns the insider profile information.
|
|
6613
|
+
* @tags TipRank
|
|
6614
|
+
* @name TiprankInsidersOverview
|
|
6615
|
+
* @summary Get tiprank InsidersOverview
|
|
6616
|
+
* @request GET:/tipranks/insiders-overview
|
|
6421
6617
|
* @secure
|
|
6422
6618
|
*/
|
|
6423
|
-
|
|
6424
|
-
/**
|
|
6425
|
-
|
|
6426
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
6427
|
-
}
|
|
6428
|
-
export class StockScreener<HandleError extends boolean = boolean> {
|
|
6429
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6430
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6619
|
+
tiprankInsidersOverview(query?: {
|
|
6620
|
+
/** The UID of the expert */
|
|
6621
|
+
expert_uid?: string;
|
|
6622
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersOverviewResponse, HandleError>>;
|
|
6431
6623
|
/**
|
|
6432
|
-
* @description
|
|
6433
|
-
* @tags
|
|
6434
|
-
* @name
|
|
6435
|
-
* @summary
|
|
6436
|
-
* @request GET:/
|
|
6624
|
+
* @description Returns the sentiment of TipRanks users on the stock.
|
|
6625
|
+
* @tags TipRank
|
|
6626
|
+
* @name TiprankInvestorSentiment
|
|
6627
|
+
* @summary Get tiprank InvestorSentiment
|
|
6628
|
+
* @request GET:/tipranks/investor-sentiment
|
|
6437
6629
|
* @secure
|
|
6438
6630
|
*/
|
|
6439
|
-
|
|
6440
|
-
/**
|
|
6441
|
-
|
|
6442
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
6631
|
+
tiprankInvestorSentiment(query: {
|
|
6632
|
+
/** The ticker of the stock */
|
|
6633
|
+
ticker: string;
|
|
6634
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInvestorSentimentResponse, HandleError>>;
|
|
6443
6635
|
/**
|
|
6444
|
-
* @description
|
|
6445
|
-
* @tags
|
|
6446
|
-
* @name
|
|
6447
|
-
* @summary
|
|
6448
|
-
* @request POST:/
|
|
6636
|
+
* @description Returns the latest analyst ratings.
|
|
6637
|
+
* @tags TipRank
|
|
6638
|
+
* @name TiprankLiveFeed
|
|
6639
|
+
* @summary Get tiprank LiveFeed
|
|
6640
|
+
* @request POST:/tipranks/live-feed
|
|
6449
6641
|
* @secure
|
|
6450
6642
|
*/
|
|
6451
|
-
|
|
6643
|
+
tiprankLiveFeed(filter: InsightLiveFeedRequest, headers?: {
|
|
6644
|
+
/** Authorization */
|
|
6645
|
+
Authorization?: string;
|
|
6646
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLiveFeedResponse[], HandleError>>;
|
|
6452
6647
|
/**
|
|
6453
|
-
* @description
|
|
6454
|
-
* @tags
|
|
6455
|
-
* @name
|
|
6456
|
-
* @summary
|
|
6457
|
-
* @request
|
|
6648
|
+
* @description Returns the latest news articles on the stock and their sentiment (bullish / neutral or bearish).
|
|
6649
|
+
* @tags TipRank
|
|
6650
|
+
* @name TiprankNewsArticles
|
|
6651
|
+
* @summary Get tiprank NewsArticles
|
|
6652
|
+
* @request GET:/tipranks/news-articles
|
|
6458
6653
|
* @secure
|
|
6459
6654
|
*/
|
|
6460
|
-
|
|
6655
|
+
tiprankNewsArticles(query: {
|
|
6656
|
+
/** The ticker of the stock */
|
|
6657
|
+
ticker: string;
|
|
6658
|
+
/** Limit to number of articles 1-200 */
|
|
6659
|
+
num?: number;
|
|
6660
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsArticlesResponse[], HandleError>>;
|
|
6461
6661
|
/**
|
|
6462
|
-
* @description
|
|
6463
|
-
* @tags
|
|
6464
|
-
* @name
|
|
6465
|
-
* @summary
|
|
6466
|
-
* @request
|
|
6662
|
+
* @description Returns the overall sentiment, buzz score and word cloud for the stock.
|
|
6663
|
+
* @tags TipRank
|
|
6664
|
+
* @name TiprankNewsSentiment
|
|
6665
|
+
* @summary Get tiprank NewsSentiment
|
|
6666
|
+
* @request GET:/tipranks/news-sentiment
|
|
6467
6667
|
* @secure
|
|
6468
6668
|
*/
|
|
6469
|
-
|
|
6470
|
-
/**
|
|
6471
|
-
|
|
6472
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
6669
|
+
tiprankNewsSentiment(query: {
|
|
6670
|
+
/** The ticker of the stock */
|
|
6671
|
+
ticker: string;
|
|
6672
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsSentimentResponse, HandleError>>;
|
|
6473
6673
|
/**
|
|
6474
|
-
* @description
|
|
6475
|
-
* @tags
|
|
6476
|
-
* @name
|
|
6477
|
-
* @summary
|
|
6478
|
-
* @request GET:/
|
|
6674
|
+
* @description Returns the list of sectors and for each sector the distribution of stocks by analyst consensus (Strong Buy / Moderate Buy / Neutral / Moderate Sell / Strong Sell).
|
|
6675
|
+
* @tags TipRank
|
|
6676
|
+
* @name TiprankSectorConsensus
|
|
6677
|
+
* @summary Get tiprank SectorConsensus
|
|
6678
|
+
* @request GET:/tipranks/sector-consensus
|
|
6479
6679
|
* @secure
|
|
6480
6680
|
*/
|
|
6481
|
-
|
|
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>>;
|
|
6681
|
+
tiprankSectorConsensus(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSectorConsensusResponse, HandleError>>;
|
|
6487
6682
|
/**
|
|
6488
|
-
* @description
|
|
6489
|
-
* @tags
|
|
6490
|
-
* @name
|
|
6491
|
-
* @summary
|
|
6492
|
-
* @request
|
|
6683
|
+
* @description Returns the stock analysis overview: which is derived from 8 unique data sets including Analyst recommendations, Crowd Wisdom, Hedge Fund Activity, Media Sentiment, Blogger Opinions, Insider Transactions, Technical and Fundamental stock factors.
|
|
6684
|
+
* @tags TipRank
|
|
6685
|
+
* @name TiprankSmartScore
|
|
6686
|
+
* @summary Get tiprank SmartScore
|
|
6687
|
+
* @request POST:/tipranks/smart-score
|
|
6493
6688
|
* @secure
|
|
6494
6689
|
*/
|
|
6495
|
-
|
|
6690
|
+
tiprankSmartScore(filter: InsightSmartScoreRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScoreResponse[], HandleError>>;
|
|
6496
6691
|
/**
|
|
6497
|
-
* @description
|
|
6498
|
-
* @tags
|
|
6499
|
-
* @name
|
|
6500
|
-
* @summary
|
|
6501
|
-
* @request
|
|
6692
|
+
* @description Returns the historical daily and yearly performance of a portfolio that contains all the top smart score stocks (rebalanced daily) and the historical performance of S&P-500 (SPY) for benchmarking purposes.
|
|
6693
|
+
* @tags TipRank
|
|
6694
|
+
* @name TiprankSmartScorePerformance
|
|
6695
|
+
* @summary Get tiprank SmartScorePerformance
|
|
6696
|
+
* @request GET:/tipranks/smart-score-performance
|
|
6502
6697
|
* @secure
|
|
6503
6698
|
*/
|
|
6504
|
-
|
|
6699
|
+
tiprankSmartScorePerformance(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScorePerformanceResponse, HandleError>>;
|
|
6505
6700
|
/**
|
|
6506
|
-
* @description
|
|
6507
|
-
* @tags
|
|
6508
|
-
* @name
|
|
6509
|
-
* @summary
|
|
6510
|
-
* @request
|
|
6701
|
+
* @description Returns a list of stocks with the top Smart Score of 10.
|
|
6702
|
+
* @tags TipRank
|
|
6703
|
+
* @name TiprankSmartScoreTopStocks
|
|
6704
|
+
* @summary Get tiprank SmartScoreTopStocks
|
|
6705
|
+
* @request POST:/tipranks/smart-score-top-stocks
|
|
6511
6706
|
* @secure
|
|
6512
6707
|
*/
|
|
6513
|
-
|
|
6708
|
+
tiprankSmartScoreTopStocks(filter: InsightSmartScoreTopStocksRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScoreResponse[], HandleError>>;
|
|
6514
6709
|
/**
|
|
6515
|
-
* @description
|
|
6516
|
-
* @tags
|
|
6517
|
-
* @name
|
|
6518
|
-
* @summary
|
|
6519
|
-
* @request POST:/
|
|
6710
|
+
* @description Returns a list of top-ranked analysts.
|
|
6711
|
+
* @tags TipRank
|
|
6712
|
+
* @name TiprankStocksConsensusOverTime
|
|
6713
|
+
* @summary Get tiprank StocksConsensusOverTime
|
|
6714
|
+
* @request POST:/tipranks/stocks-consensus-over-time
|
|
6520
6715
|
* @secure
|
|
6521
6716
|
*/
|
|
6522
|
-
|
|
6523
|
-
}
|
|
6524
|
-
export class StockScreenerV2<HandleError extends boolean = boolean> {
|
|
6525
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6526
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6717
|
+
tiprankStocksConsensusOverTime(filter: InsightStocksConsensusOverTimeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksConsensusOverTimeResponse[], HandleError>>;
|
|
6527
6718
|
/**
|
|
6528
|
-
* @description
|
|
6529
|
-
* @tags
|
|
6530
|
-
* @name
|
|
6531
|
-
* @summary
|
|
6532
|
-
* @request POST:/
|
|
6719
|
+
* @description Returns the latest events per a specific stock, these include sell side analyst ratings, blogger opinions and corporate insider transactions
|
|
6720
|
+
* @tags TipRank
|
|
6721
|
+
* @name TiprankStocksEvents
|
|
6722
|
+
* @summary Get tiprank StocksEvents
|
|
6723
|
+
* @request POST:/tipranks/stocks-events
|
|
6533
6724
|
* @secure
|
|
6534
6725
|
*/
|
|
6535
|
-
|
|
6726
|
+
tiprankStocksEvents(filter: InsightStocksEventsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksEventsResponse[], HandleError>>;
|
|
6536
6727
|
/**
|
|
6537
|
-
* @description
|
|
6538
|
-
* @tags
|
|
6539
|
-
* @name
|
|
6540
|
-
* @summary
|
|
6541
|
-
* @request
|
|
6728
|
+
* @description Returns a list of stocks similar to the given ticker.
|
|
6729
|
+
* @tags TipRank
|
|
6730
|
+
* @name TiprankStocksSimilarStocks
|
|
6731
|
+
* @summary Get tiprank StocksSimilarStocks
|
|
6732
|
+
* @request GET:/tipranks/stocks-similar-stocks
|
|
6542
6733
|
* @secure
|
|
6543
6734
|
*/
|
|
6544
|
-
|
|
6545
|
-
|
|
6546
|
-
|
|
6547
|
-
|
|
6548
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6735
|
+
tiprankStocksSimilarStocks(query: {
|
|
6736
|
+
/** The ticker of the stock */
|
|
6737
|
+
ticker: string;
|
|
6738
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
6549
6739
|
/**
|
|
6550
|
-
* @description Returns
|
|
6740
|
+
* @description Returns the stocks with the highest share price increase / decrease and volume. Note that the API call only returns the list of stocks that make it to the top movers list, the real time price action for these stocks should be pulled by the web page to provide the most up to date values.
|
|
6551
6741
|
* @tags TipRank
|
|
6552
|
-
* @name
|
|
6553
|
-
* @summary Get tiprank
|
|
6554
|
-
* @request
|
|
6742
|
+
* @name TiprankStocksTopMovers
|
|
6743
|
+
* @summary Get tiprank StocksTopMovers
|
|
6744
|
+
* @request GET:/tipranks/stocks-top-movers
|
|
6555
6745
|
* @secure
|
|
6556
6746
|
*/
|
|
6557
|
-
|
|
6747
|
+
tiprankStocksTopMovers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksTopMoversResponse[], HandleError>>;
|
|
6558
6748
|
/**
|
|
6559
|
-
* @description Returns the
|
|
6749
|
+
* @description Returns the stock symbols covered by TipRanks.
|
|
6560
6750
|
* @tags TipRank
|
|
6561
|
-
* @name
|
|
6562
|
-
* @summary Get tiprank
|
|
6563
|
-
* @request
|
|
6751
|
+
* @name TiprankSupportedTickers
|
|
6752
|
+
* @summary Get tiprank SupportedTickers
|
|
6753
|
+
* @request GET:/tipranks/supported-tickers
|
|
6564
6754
|
* @secure
|
|
6565
6755
|
*/
|
|
6566
|
-
|
|
6756
|
+
tiprankSupportedTickers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSupportedTickersResponse, HandleError>>;
|
|
6567
6757
|
/**
|
|
6568
|
-
* @description Returns the
|
|
6758
|
+
* @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).
|
|
6569
6759
|
* @tags TipRank
|
|
6570
|
-
* @name
|
|
6571
|
-
* @summary Get
|
|
6572
|
-
* @request
|
|
6760
|
+
* @name TiprankTopRateStocks
|
|
6761
|
+
* @summary Get tiprank TopRateStocks
|
|
6762
|
+
* @request GET:/tipranks/top-rate-stocks
|
|
6573
6763
|
* @secure
|
|
6574
6764
|
*/
|
|
6575
|
-
|
|
6576
|
-
/**
|
|
6577
|
-
|
|
6578
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
6765
|
+
tiprankTopRateStocks(query?: {
|
|
6766
|
+
/** Return the most trending X stocks */
|
|
6767
|
+
num?: number;
|
|
6768
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopRateStocksResponse, HandleError>>;
|
|
6579
6769
|
/**
|
|
6580
|
-
* @description Returns the
|
|
6770
|
+
* @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.
|
|
6581
6771
|
* @tags TipRank
|
|
6582
|
-
* @name
|
|
6583
|
-
* @summary Get tiprank
|
|
6584
|
-
* @request
|
|
6772
|
+
* @name TiprankTopStocksBySectors
|
|
6773
|
+
* @summary Get tiprank TopStocksBySectors
|
|
6774
|
+
* @request POST:/tipranks/top-stocks-by-sectors
|
|
6585
6775
|
* @secure
|
|
6586
6776
|
*/
|
|
6587
|
-
|
|
6588
|
-
/** ID of tiprank analyst profile */
|
|
6589
|
-
id: string;
|
|
6590
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAnalystProfileResponse, HandleError>>;
|
|
6777
|
+
tiprankTopStocksBySectors(filter: InsightTopStocksBySectorsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksBySectorsResponse, HandleError>>;
|
|
6591
6778
|
/**
|
|
6592
|
-
* @description Returns the
|
|
6779
|
+
* @description Returns a list of stocks with the highest number of analyst ratings in the last 7 days.
|
|
6593
6780
|
* @tags TipRank
|
|
6594
|
-
* @name
|
|
6595
|
-
* @summary Get tiprank
|
|
6596
|
-
* @request
|
|
6781
|
+
* @name TiprankTrendingStocks
|
|
6782
|
+
* @summary Get tiprank TrendingStocks
|
|
6783
|
+
* @request POST:/tipranks/trending-stocks
|
|
6597
6784
|
* @secure
|
|
6598
6785
|
*/
|
|
6599
|
-
|
|
6786
|
+
tiprankTrendingStocks(filter: InsightTrendingStocksRequest, headers?: {
|
|
6787
|
+
/** Authorization */
|
|
6788
|
+
Authorization?: string;
|
|
6789
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
|
|
6790
|
+
}
|
|
6791
|
+
export class UsageTracking<HandleError extends boolean = boolean> {
|
|
6792
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6793
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6600
6794
|
/**
|
|
6601
|
-
* @description
|
|
6602
|
-
* @tags
|
|
6603
|
-
* @name
|
|
6604
|
-
* @summary
|
|
6605
|
-
* @request
|
|
6795
|
+
* @description get usage date per branch for a period
|
|
6796
|
+
* @tags UsageTracking
|
|
6797
|
+
* @name GetUsageData
|
|
6798
|
+
* @summary get insight usage data
|
|
6799
|
+
* @request POST:/tracking/usage
|
|
6606
6800
|
* @secure
|
|
6607
6801
|
*/
|
|
6608
|
-
|
|
6609
|
-
|
|
6610
|
-
|
|
6611
|
-
|
|
6802
|
+
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
|
|
6803
|
+
}
|
|
6804
|
+
export class Passport<HandleError extends boolean = boolean> {
|
|
6805
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6806
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6612
6807
|
/**
|
|
6613
|
-
* @description Returns
|
|
6614
|
-
* @tags
|
|
6615
|
-
* @name
|
|
6616
|
-
* @summary Get
|
|
6617
|
-
* @request
|
|
6808
|
+
* @description Returns article by id
|
|
6809
|
+
* @tags Passport
|
|
6810
|
+
* @name PassportArticleById
|
|
6811
|
+
* @summary Get article by id
|
|
6812
|
+
* @request POST:/passport/article-by-id
|
|
6618
6813
|
* @secure
|
|
6619
6814
|
*/
|
|
6620
|
-
|
|
6621
|
-
/** The ticker of the stock */
|
|
6622
|
-
ticker: string;
|
|
6623
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightBloggerConsensusOnStockResponse[], HandleError>>;
|
|
6815
|
+
passportArticleById(filter: InsightArticleByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle, HandleError>>;
|
|
6624
6816
|
/**
|
|
6625
|
-
* @description Returns
|
|
6626
|
-
* @tags
|
|
6627
|
-
* @name
|
|
6628
|
-
* @summary Get
|
|
6629
|
-
* @request
|
|
6817
|
+
* @description Returns articles
|
|
6818
|
+
* @tags Passport
|
|
6819
|
+
* @name PassportArticles
|
|
6820
|
+
* @summary Get articles
|
|
6821
|
+
* @request POST:/passport/articles
|
|
6630
6822
|
* @secure
|
|
6631
6823
|
*/
|
|
6632
|
-
|
|
6824
|
+
passportArticles(filter: InsightArticlesRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
6633
6825
|
/**
|
|
6634
|
-
* @description Returns
|
|
6635
|
-
* @tags
|
|
6636
|
-
* @name
|
|
6637
|
-
* @summary Get
|
|
6638
|
-
* @request
|
|
6826
|
+
* @description Returns author profile
|
|
6827
|
+
* @tags Passport
|
|
6828
|
+
* @name PassportAuthorProfile
|
|
6829
|
+
* @summary Get author profile
|
|
6830
|
+
* @request POST:/passport/author-profile
|
|
6639
6831
|
* @secure
|
|
6640
6832
|
*/
|
|
6641
|
-
|
|
6642
|
-
/** The specific requested time */
|
|
6643
|
-
utc_time?: string;
|
|
6644
|
-
/** Level of detail on updated stocks */
|
|
6645
|
-
details?: InsightTiprankGeneralStockUpdatesParamsDetailsEnum;
|
|
6646
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGeneralStockUpdatesResponse, HandleError>>;
|
|
6833
|
+
passportAuthorProfile(filter: InsightAuthorProfileRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightAuthorProfileResponse[], HandleError>>;
|
|
6647
6834
|
/**
|
|
6648
|
-
* @description Returns
|
|
6649
|
-
* @tags
|
|
6650
|
-
* @name
|
|
6651
|
-
* @summary Get
|
|
6652
|
-
* @request
|
|
6835
|
+
* @description Returns most popular tags
|
|
6836
|
+
* @tags Passport
|
|
6837
|
+
* @name PassportMostPopularTags
|
|
6838
|
+
* @summary Get most popular tags
|
|
6839
|
+
* @request POST:/passport/most-popular-tags
|
|
6653
6840
|
* @secure
|
|
6654
6841
|
*/
|
|
6655
|
-
|
|
6656
|
-
/** The ticker of the stock */
|
|
6657
|
-
ticker: string;
|
|
6658
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsResponse[], HandleError>>;
|
|
6842
|
+
passportMostPopularTags(filter: InsightMostPopularTagsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTagShortInfo[][], HandleError>>;
|
|
6659
6843
|
/**
|
|
6660
|
-
* @description Returns
|
|
6661
|
-
* @tags
|
|
6662
|
-
* @name
|
|
6663
|
-
* @summary Get
|
|
6664
|
-
* @request
|
|
6844
|
+
* @description Returns news feed
|
|
6845
|
+
* @tags Passport
|
|
6846
|
+
* @name PassportNewsFeed
|
|
6847
|
+
* @summary Get news feed
|
|
6848
|
+
* @request POST:/passport/newsfeed
|
|
6665
6849
|
* @secure
|
|
6666
6850
|
*/
|
|
6667
|
-
|
|
6668
|
-
/** The number of hedge fund managers to return */
|
|
6669
|
-
num?: number;
|
|
6670
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsBestPerformingExpertsResponse[], HandleError>>;
|
|
6851
|
+
passportNewsFeed(filter: InsightNewsfeedRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsfeed[][], HandleError>>;
|
|
6671
6852
|
/**
|
|
6672
|
-
* @description Returns
|
|
6673
|
-
* @tags
|
|
6674
|
-
* @name
|
|
6675
|
-
* @summary
|
|
6676
|
-
* @request
|
|
6853
|
+
* @description Returns article by parameters
|
|
6854
|
+
* @tags Passport
|
|
6855
|
+
* @name PassportSearchArticle
|
|
6856
|
+
* @summary Search article by parameters
|
|
6857
|
+
* @request POST:/passport/search-article
|
|
6677
6858
|
* @secure
|
|
6678
6859
|
*/
|
|
6679
|
-
|
|
6680
|
-
/** Show only managers with these number of stars or higher */
|
|
6681
|
-
min_stars?: number;
|
|
6682
|
-
/** The order of the latest insider transactions */
|
|
6683
|
-
sort?: InsightTiprankHedgefundsRecentTransactionsParamsSortEnum;
|
|
6684
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightHedgeFundsRecentTransactionsResponse[], HandleError>>;
|
|
6685
|
-
/**
|
|
6686
|
-
* @description Returns the latest insider transactions and an overall sentiment on a given stock.
|
|
6687
|
-
* @tags TipRank
|
|
6688
|
-
* @name TiprankInsiders
|
|
6689
|
-
* @summary Get tiprank Insiders
|
|
6690
|
-
* @request GET:/tipranks/insiders
|
|
6691
|
-
* @secure
|
|
6692
|
-
*/
|
|
6693
|
-
tiprankInsiders(query: {
|
|
6694
|
-
/** The ticker of the stock */
|
|
6695
|
-
ticker: string;
|
|
6696
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersResponse[], HandleError>>;
|
|
6697
|
-
/**
|
|
6698
|
-
* @description Returns a list of top ranked insiders.
|
|
6699
|
-
* @tags TipRank
|
|
6700
|
-
* @name TiprankInsidersBestPerformingExperts
|
|
6701
|
-
* @summary Get tiprank InsidersBestPerformingExperts
|
|
6702
|
-
* @request GET:/tipranks/insiders-best-performing-experts
|
|
6703
|
-
* @secure
|
|
6704
|
-
*/
|
|
6705
|
-
tiprankInsidersBestPerformingExperts(query?: {
|
|
6706
|
-
/** The number of insiders to return */
|
|
6707
|
-
num?: number;
|
|
6708
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersBestPerformingExpertsResponse[], HandleError>>;
|
|
6709
|
-
/**
|
|
6710
|
-
* @description Returns all the information required to build TipRanks Insider Hot Stocks.
|
|
6711
|
-
* @tags TipRank
|
|
6712
|
-
* @name TiprankInsidersHotstocks
|
|
6713
|
-
* @summary Get tiprank InsidersHotstocks
|
|
6714
|
-
* @request GET:/tipranks/insiders-hotstocks
|
|
6715
|
-
* @secure
|
|
6716
|
-
*/
|
|
6717
|
-
tiprankInsidersHotstocks(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersHotstocksResponse[], HandleError>>;
|
|
6718
|
-
/**
|
|
6719
|
-
* @description Returns a feed of the latest insider transactions reported to the SEC.
|
|
6720
|
-
* @tags TipRank
|
|
6721
|
-
* @name TiprankInsidersLiveFeed
|
|
6722
|
-
* @summary Get tiprank InsidersLiveFeed
|
|
6723
|
-
* @request GET:/tipranks/insiders-live-feed
|
|
6724
|
-
* @secure
|
|
6725
|
-
*/
|
|
6726
|
-
tiprankInsidersLiveFeed(query?: {
|
|
6727
|
-
/** Return the latest X transactions */
|
|
6728
|
-
num?: number;
|
|
6729
|
-
/** The order of the latest insider transactions */
|
|
6730
|
-
sort?: InsightTiprankInsidersLiveFeedParamsSortEnum;
|
|
6731
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersLiveFeedResponse[], HandleError>>;
|
|
6732
|
-
/**
|
|
6733
|
-
* @description Returns the insider profile information.
|
|
6734
|
-
* @tags TipRank
|
|
6735
|
-
* @name TiprankInsidersOverview
|
|
6736
|
-
* @summary Get tiprank InsidersOverview
|
|
6737
|
-
* @request GET:/tipranks/insiders-overview
|
|
6738
|
-
* @secure
|
|
6739
|
-
*/
|
|
6740
|
-
tiprankInsidersOverview(query?: {
|
|
6741
|
-
/** The UID of the expert */
|
|
6742
|
-
expert_uid?: string;
|
|
6743
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInsidersOverviewResponse, HandleError>>;
|
|
6744
|
-
/**
|
|
6745
|
-
* @description Returns the sentiment of TipRanks users on the stock.
|
|
6746
|
-
* @tags TipRank
|
|
6747
|
-
* @name TiprankInvestorSentiment
|
|
6748
|
-
* @summary Get tiprank InvestorSentiment
|
|
6749
|
-
* @request GET:/tipranks/investor-sentiment
|
|
6750
|
-
* @secure
|
|
6751
|
-
*/
|
|
6752
|
-
tiprankInvestorSentiment(query: {
|
|
6753
|
-
/** The ticker of the stock */
|
|
6754
|
-
ticker: string;
|
|
6755
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightInvestorSentimentResponse, HandleError>>;
|
|
6756
|
-
/**
|
|
6757
|
-
* @description Returns the latest analyst ratings.
|
|
6758
|
-
* @tags TipRank
|
|
6759
|
-
* @name TiprankLiveFeed
|
|
6760
|
-
* @summary Get tiprank LiveFeed
|
|
6761
|
-
* @request POST:/tipranks/live-feed
|
|
6762
|
-
* @secure
|
|
6763
|
-
*/
|
|
6764
|
-
tiprankLiveFeed(filter: InsightLiveFeedRequest, headers?: {
|
|
6765
|
-
/** Authorization */
|
|
6766
|
-
Authorization?: string;
|
|
6767
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightLiveFeedResponse[], HandleError>>;
|
|
6768
|
-
/**
|
|
6769
|
-
* @description Returns the latest news articles on the stock and their sentiment (bullish / neutral or bearish).
|
|
6770
|
-
* @tags TipRank
|
|
6771
|
-
* @name TiprankNewsArticles
|
|
6772
|
-
* @summary Get tiprank NewsArticles
|
|
6773
|
-
* @request GET:/tipranks/news-articles
|
|
6774
|
-
* @secure
|
|
6775
|
-
*/
|
|
6776
|
-
tiprankNewsArticles(query: {
|
|
6777
|
-
/** The ticker of the stock */
|
|
6778
|
-
ticker: string;
|
|
6779
|
-
/** Limit to number of articles 1-200 */
|
|
6780
|
-
num?: number;
|
|
6781
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsArticlesResponse[], HandleError>>;
|
|
6782
|
-
/**
|
|
6783
|
-
* @description Returns the overall sentiment, buzz score and word cloud for the stock.
|
|
6784
|
-
* @tags TipRank
|
|
6785
|
-
* @name TiprankNewsSentiment
|
|
6786
|
-
* @summary Get tiprank NewsSentiment
|
|
6787
|
-
* @request GET:/tipranks/news-sentiment
|
|
6788
|
-
* @secure
|
|
6789
|
-
*/
|
|
6790
|
-
tiprankNewsSentiment(query: {
|
|
6791
|
-
/** The ticker of the stock */
|
|
6792
|
-
ticker: string;
|
|
6793
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightNewsSentimentResponse, HandleError>>;
|
|
6794
|
-
/**
|
|
6795
|
-
* @description Returns the list of sectors and for each sector the distribution of stocks by analyst consensus (Strong Buy / Moderate Buy / Neutral / Moderate Sell / Strong Sell).
|
|
6796
|
-
* @tags TipRank
|
|
6797
|
-
* @name TiprankSectorConsensus
|
|
6798
|
-
* @summary Get tiprank SectorConsensus
|
|
6799
|
-
* @request GET:/tipranks/sector-consensus
|
|
6800
|
-
* @secure
|
|
6801
|
-
*/
|
|
6802
|
-
tiprankSectorConsensus(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSectorConsensusResponse, HandleError>>;
|
|
6803
|
-
/**
|
|
6804
|
-
* @description Returns the stock analysis overview: which is derived from 8 unique data sets including Analyst recommendations, Crowd Wisdom, Hedge Fund Activity, Media Sentiment, Blogger Opinions, Insider Transactions, Technical and Fundamental stock factors.
|
|
6805
|
-
* @tags TipRank
|
|
6806
|
-
* @name TiprankSmartScore
|
|
6807
|
-
* @summary Get tiprank SmartScore
|
|
6808
|
-
* @request POST:/tipranks/smart-score
|
|
6809
|
-
* @secure
|
|
6810
|
-
*/
|
|
6811
|
-
tiprankSmartScore(filter: InsightSmartScoreRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScoreResponse[], HandleError>>;
|
|
6812
|
-
/**
|
|
6813
|
-
* @description Returns the historical daily and yearly performance of a portfolio that contains all the top smart score stocks (rebalanced daily) and the historical performance of S&P-500 (SPY) for benchmarking purposes.
|
|
6814
|
-
* @tags TipRank
|
|
6815
|
-
* @name TiprankSmartScorePerformance
|
|
6816
|
-
* @summary Get tiprank SmartScorePerformance
|
|
6817
|
-
* @request GET:/tipranks/smart-score-performance
|
|
6818
|
-
* @secure
|
|
6819
|
-
*/
|
|
6820
|
-
tiprankSmartScorePerformance(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScorePerformanceResponse, HandleError>>;
|
|
6821
|
-
/**
|
|
6822
|
-
* @description Returns a list of stocks with the top Smart Score of 10.
|
|
6823
|
-
* @tags TipRank
|
|
6824
|
-
* @name TiprankSmartScoreTopStocks
|
|
6825
|
-
* @summary Get tiprank SmartScoreTopStocks
|
|
6826
|
-
* @request POST:/tipranks/smart-score-top-stocks
|
|
6827
|
-
* @secure
|
|
6828
|
-
*/
|
|
6829
|
-
tiprankSmartScoreTopStocks(filter: InsightSmartScoreTopStocksRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSmartScoreResponse[], HandleError>>;
|
|
6830
|
-
/**
|
|
6831
|
-
* @description Returns a list of top-ranked analysts.
|
|
6832
|
-
* @tags TipRank
|
|
6833
|
-
* @name TiprankStocksConsensusOverTime
|
|
6834
|
-
* @summary Get tiprank StocksConsensusOverTime
|
|
6835
|
-
* @request POST:/tipranks/stocks-consensus-over-time
|
|
6836
|
-
* @secure
|
|
6837
|
-
*/
|
|
6838
|
-
tiprankStocksConsensusOverTime(filter: InsightStocksConsensusOverTimeRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksConsensusOverTimeResponse[], HandleError>>;
|
|
6839
|
-
/**
|
|
6840
|
-
* @description Returns the latest events per a specific stock, these include sell side analyst ratings, blogger opinions and corporate insider transactions
|
|
6841
|
-
* @tags TipRank
|
|
6842
|
-
* @name TiprankStocksEvents
|
|
6843
|
-
* @summary Get tiprank StocksEvents
|
|
6844
|
-
* @request POST:/tipranks/stocks-events
|
|
6845
|
-
* @secure
|
|
6846
|
-
*/
|
|
6847
|
-
tiprankStocksEvents(filter: InsightStocksEventsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksEventsResponse[], HandleError>>;
|
|
6848
|
-
/**
|
|
6849
|
-
* @description Returns a list of stocks similar to the given ticker.
|
|
6850
|
-
* @tags TipRank
|
|
6851
|
-
* @name TiprankStocksSimilarStocks
|
|
6852
|
-
* @summary Get tiprank StocksSimilarStocks
|
|
6853
|
-
* @request GET:/tipranks/stocks-similar-stocks
|
|
6854
|
-
* @secure
|
|
6855
|
-
*/
|
|
6856
|
-
tiprankStocksSimilarStocks(query: {
|
|
6857
|
-
/** The ticker of the stock */
|
|
6858
|
-
ticker: string;
|
|
6859
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<string[], HandleError>>;
|
|
6860
|
-
/**
|
|
6861
|
-
* @description Returns the stocks with the highest share price increase / decrease and volume. Note that the API call only returns the list of stocks that make it to the top movers list, the real time price action for these stocks should be pulled by the web page to provide the most up to date values.
|
|
6862
|
-
* @tags TipRank
|
|
6863
|
-
* @name TiprankStocksTopMovers
|
|
6864
|
-
* @summary Get tiprank StocksTopMovers
|
|
6865
|
-
* @request GET:/tipranks/stocks-top-movers
|
|
6866
|
-
* @secure
|
|
6867
|
-
*/
|
|
6868
|
-
tiprankStocksTopMovers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStocksTopMoversResponse[], HandleError>>;
|
|
6869
|
-
/**
|
|
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
|
|
6875
|
-
* @secure
|
|
6876
|
-
*/
|
|
6877
|
-
tiprankSupportedTickers(config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightSupportedTickersResponse, HandleError>>;
|
|
6878
|
-
/**
|
|
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
|
|
6884
|
-
* @secure
|
|
6885
|
-
*/
|
|
6886
|
-
tiprankTopRateStocks(query?: {
|
|
6887
|
-
/** Return the most trending X stocks */
|
|
6888
|
-
num?: number;
|
|
6889
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopRateStocksResponse, HandleError>>;
|
|
6890
|
-
/**
|
|
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
|
|
6896
|
-
* @secure
|
|
6897
|
-
*/
|
|
6898
|
-
tiprankTopStocksBySectors(filter: InsightTopStocksBySectorsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTopStocksBySectorsResponse, HandleError>>;
|
|
6899
|
-
/**
|
|
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
|
|
6905
|
-
* @secure
|
|
6906
|
-
*/
|
|
6907
|
-
tiprankTrendingStocks(filter: InsightTrendingStocksRequest, headers?: {
|
|
6908
|
-
/** Authorization */
|
|
6909
|
-
Authorization?: string;
|
|
6910
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightTrendingStocksResponse[], HandleError>>;
|
|
6911
|
-
}
|
|
6912
|
-
export class UsageTracking<HandleError extends boolean = boolean> {
|
|
6913
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
6914
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
6915
|
-
/**
|
|
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
|
|
6921
|
-
* @secure
|
|
6922
|
-
*/
|
|
6923
|
-
getUsageData(filter: InsightGetUsageDataRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightUsageDataEntry[], HandleError>>;
|
|
6860
|
+
passportSearchArticle(filter: InsightSearchArticleRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightArticle[], HandleError>>;
|
|
6924
6861
|
}
|
|
6925
|
-
export class
|
|
6862
|
+
export class OptionGreeks<HandleError extends boolean = boolean> {
|
|
6926
6863
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
6927
6864
|
constructor(apiClient: JwtClient<HandleError>);
|
|
6928
6865
|
/**
|
|
6929
|
-
* @description
|
|
6930
|
-
* @tags
|
|
6931
|
-
* @name
|
|
6932
|
-
* @summary
|
|
6933
|
-
* @request
|
|
6934
|
-
* @secure
|
|
6935
|
-
*/
|
|
6936
|
-
continentGet(query: {
|
|
6937
|
-
/** Query limit */
|
|
6938
|
-
limit: number;
|
|
6939
|
-
/** Query offset */
|
|
6940
|
-
offset: number;
|
|
6941
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
6942
|
-
/**
|
|
6943
|
-
* @description Edit continent
|
|
6944
|
-
* @tags World Markets
|
|
6945
|
-
* @name ContinentEdit
|
|
6946
|
-
* @summary Edit continent
|
|
6947
|
-
* @request PUT:/continents
|
|
6948
|
-
* @secure
|
|
6949
|
-
*/
|
|
6950
|
-
continentEdit(filter: InsightEditContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6951
|
-
/**
|
|
6952
|
-
* @description Create continents
|
|
6953
|
-
* @tags World Markets
|
|
6954
|
-
* @name ContinentCreate
|
|
6955
|
-
* @summary Create continents
|
|
6956
|
-
* @request POST:/continents
|
|
6957
|
-
* @secure
|
|
6958
|
-
*/
|
|
6959
|
-
continentCreate(filter: InsightCreateContinentRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightContinent[], HandleError>>;
|
|
6960
|
-
/**
|
|
6961
|
-
* @description Delete continent
|
|
6962
|
-
* @tags World Markets
|
|
6963
|
-
* @name ContinentDelete
|
|
6964
|
-
* @summary Delete continent
|
|
6965
|
-
* @request DELETE:/continents
|
|
6866
|
+
* @description Returns calculated matrix
|
|
6867
|
+
* @tags OptionGreeks
|
|
6868
|
+
* @name OgCalculateMatrix
|
|
6869
|
+
* @summary Calculate matrix
|
|
6870
|
+
* @request POST:/og/calculate-matrix
|
|
6966
6871
|
* @secure
|
|
6967
6872
|
*/
|
|
6968
|
-
|
|
6969
|
-
/** continent id */
|
|
6970
|
-
id: string;
|
|
6971
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
6873
|
+
ogCalculateMatrix(filter: InsightCalculateMatrixParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateMatrixResponse, HandleError>>;
|
|
6972
6874
|
/**
|
|
6973
|
-
* @description
|
|
6974
|
-
* @tags
|
|
6975
|
-
* @name
|
|
6976
|
-
* @summary
|
|
6977
|
-
* @request
|
|
6875
|
+
* @description Returns calculated params
|
|
6876
|
+
* @tags OptionGreeks
|
|
6877
|
+
* @name OgCalculateParams
|
|
6878
|
+
* @summary Calculate params
|
|
6879
|
+
* @request POST:/og/calculate-params
|
|
6978
6880
|
* @secure
|
|
6979
6881
|
*/
|
|
6980
|
-
|
|
6981
|
-
|
|
6982
|
-
|
|
6983
|
-
|
|
6984
|
-
|
|
6985
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCountryCode[], HandleError>>;
|
|
6882
|
+
ogCalculateParams(filter: InsightCalculateParamsRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightCalculateParamsResponse, HandleError>>;
|
|
6883
|
+
}
|
|
6884
|
+
export class Ownerships<HandleError extends boolean = boolean> {
|
|
6885
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
6886
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
6986
6887
|
/**
|
|
6987
|
-
* @description
|
|
6988
|
-
* @tags
|
|
6989
|
-
* @name
|
|
6990
|
-
* @summary
|
|
6991
|
-
* @request
|
|
6888
|
+
* @description get ownerships by id datadata
|
|
6889
|
+
* @tags Ownerships
|
|
6890
|
+
* @name GetOwnershipsByIdData
|
|
6891
|
+
* @summary get ownerships by id data
|
|
6892
|
+
* @request POST:/ownerships
|
|
6992
6893
|
* @secure
|
|
6993
6894
|
*/
|
|
6994
|
-
|
|
6895
|
+
getOwnershipsByIdData(filter: InsightGetOwnershipsByIDRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
6995
6896
|
/**
|
|
6996
|
-
* @description
|
|
6997
|
-
* @tags
|
|
6998
|
-
* @name
|
|
6999
|
-
* @summary
|
|
7000
|
-
* @request POST:/
|
|
6897
|
+
* @description get ownerships by symbol data
|
|
6898
|
+
* @tags Ownerships
|
|
6899
|
+
* @name GetOwnershipsBySymbolData
|
|
6900
|
+
* @summary get ownerships by symbol data
|
|
6901
|
+
* @request POST:/symbol-ownerships
|
|
7001
6902
|
* @secure
|
|
7002
6903
|
*/
|
|
7003
|
-
|
|
6904
|
+
getOwnershipsBySymbolData(filter: InsightGetOwnershipsBySymbolWithoutSearchQueryRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetOwnershipsBySymbolResponse, HandleError>>;
|
|
6905
|
+
}
|
|
6906
|
+
export interface InsightBeforeAndAfterV2 {
|
|
6907
|
+
after?: string;
|
|
6908
|
+
before?: string;
|
|
6909
|
+
}
|
|
6910
|
+
export interface InsightFixedIncomeV2 {
|
|
6911
|
+
a144: boolean;
|
|
6912
|
+
accrued_interest: number;
|
|
6913
|
+
bank_qualified: boolean;
|
|
6914
|
+
bond_warrant: boolean;
|
|
6915
|
+
call_type: string;
|
|
6916
|
+
callable: boolean;
|
|
6917
|
+
close_price: number;
|
|
6918
|
+
close_price_asof: string;
|
|
6919
|
+
close_ytw: number;
|
|
6920
|
+
convertible: boolean;
|
|
6921
|
+
country: string;
|
|
6922
|
+
country_code: string;
|
|
6923
|
+
country_domicile: string;
|
|
6924
|
+
country_issue: string;
|
|
6925
|
+
coupon: number;
|
|
6926
|
+
coupon_frequency: string;
|
|
6927
|
+
coupon_type: string;
|
|
6928
|
+
currency: string;
|
|
6929
|
+
cusip: string;
|
|
6930
|
+
dated_date: string;
|
|
6931
|
+
daycount: string;
|
|
6932
|
+
description: string;
|
|
6933
|
+
description_short: string;
|
|
6934
|
+
duration: number;
|
|
6935
|
+
first_coupon_date: string;
|
|
6936
|
+
insured: boolean;
|
|
6937
|
+
isin: string;
|
|
6938
|
+
issue_date: string;
|
|
6939
|
+
issue_minimum_denomination: number;
|
|
6940
|
+
issue_price: number;
|
|
6941
|
+
issue_size: number;
|
|
6942
|
+
issuer: string;
|
|
6943
|
+
last_coupon_date: string;
|
|
6944
|
+
liquidity_institutional_aggregate: number;
|
|
6945
|
+
liquidity_institutional_buy: number;
|
|
6946
|
+
liquidity_institutional_sell: number;
|
|
6947
|
+
liquidity_micro_aggregate: number;
|
|
6948
|
+
liquidity_micro_buy: number;
|
|
6949
|
+
liquidity_micro_sell: number;
|
|
6950
|
+
liquidity_retail_aggregate: number;
|
|
6951
|
+
liquidity_retail_buy: number;
|
|
6952
|
+
liquidity_retail_sell: number;
|
|
6953
|
+
maturity_date: string;
|
|
6954
|
+
municipal_state: string;
|
|
6955
|
+
municipal_taxable_federal: boolean;
|
|
6956
|
+
municipal_type: string;
|
|
6957
|
+
next_call_date: string;
|
|
6958
|
+
next_call_price: number;
|
|
6959
|
+
next_coupon_date: string;
|
|
6960
|
+
par_value: number;
|
|
6961
|
+
perpetual: boolean;
|
|
6962
|
+
private_placement: boolean;
|
|
6963
|
+
purpose: string;
|
|
6964
|
+
puttable: boolean;
|
|
6965
|
+
reg_s: boolean;
|
|
6966
|
+
sector: string;
|
|
6967
|
+
seniority: string;
|
|
6968
|
+
settlement_convention: string;
|
|
6969
|
+
sinking_fund: boolean;
|
|
6970
|
+
sp_creditwatch: string;
|
|
6971
|
+
sp_creditwatch_date: string;
|
|
6972
|
+
sp_outlook: string;
|
|
6973
|
+
sp_outlook_date: string;
|
|
6974
|
+
sp_rating: string;
|
|
6975
|
+
sp_rating_date: string;
|
|
6976
|
+
status: string;
|
|
6977
|
+
ticker: string;
|
|
6978
|
+
treasury_subtype: string;
|
|
6979
|
+
type: string;
|
|
6980
|
+
updated_at: string;
|
|
6981
|
+
}
|
|
6982
|
+
export interface InsightGetFixedIncomeEntriesResponseV2 {
|
|
6983
|
+
count: number;
|
|
6984
|
+
data: InsightFixedIncomeV2[];
|
|
6985
|
+
}
|
|
6986
|
+
export interface InsightGetFixedIncomeEntriesRequestV2 {
|
|
6987
|
+
/** @example true */
|
|
6988
|
+
bank_qualified?: boolean;
|
|
6989
|
+
/** @example true */
|
|
6990
|
+
callable?: boolean;
|
|
6991
|
+
/** @example true */
|
|
6992
|
+
convertible?: boolean;
|
|
6993
|
+
/** @example ["USA"] */
|
|
6994
|
+
country_codes?: string[];
|
|
6995
|
+
coupon?: InsightLessAndMoreV2;
|
|
6996
|
+
/** @example ["quarterly","zero"] */
|
|
6997
|
+
coupon_frequencies?: string[];
|
|
6998
|
+
/** @example ["655664AH3","9128286R6"] */
|
|
6999
|
+
cusip?: string[];
|
|
7004
7000
|
/**
|
|
7005
|
-
* @
|
|
7006
|
-
* @
|
|
7007
|
-
* @name CountryCodeDelete
|
|
7008
|
-
* @summary Delete country code
|
|
7009
|
-
* @request DELETE:/country-codes
|
|
7010
|
-
* @secure
|
|
7001
|
+
* @maxLength 100
|
|
7002
|
+
* @example "Donald's"
|
|
7011
7003
|
*/
|
|
7012
|
-
|
|
7013
|
-
|
|
7014
|
-
|
|
7015
|
-
|
|
7004
|
+
description?: string;
|
|
7005
|
+
/** @example true */
|
|
7006
|
+
has_ticker?: boolean;
|
|
7007
|
+
/** @example true */
|
|
7008
|
+
insured?: boolean;
|
|
7009
|
+
/** @example ["US655664AH33","US9128286R69"] */
|
|
7010
|
+
isin?: string[];
|
|
7011
|
+
issue_date?: InsightBeforeAndAfterV2;
|
|
7016
7012
|
/**
|
|
7017
|
-
* @
|
|
7018
|
-
* @
|
|
7019
|
-
* @name GlobalIndexGet
|
|
7020
|
-
* @summary Get global indexes
|
|
7021
|
-
* @request GET:/global-indexes
|
|
7022
|
-
* @secure
|
|
7013
|
+
* @maxLength 100
|
|
7014
|
+
* @example "Donald's"
|
|
7023
7015
|
*/
|
|
7024
|
-
|
|
7025
|
-
|
|
7026
|
-
|
|
7027
|
-
|
|
7028
|
-
|
|
7029
|
-
|
|
7030
|
-
|
|
7031
|
-
|
|
7016
|
+
issuer?: string;
|
|
7017
|
+
maturity?: InsightBeforeAndAfterV2;
|
|
7018
|
+
/** @example ["NY"] */
|
|
7019
|
+
municipal_states?: string[];
|
|
7020
|
+
/** @example true */
|
|
7021
|
+
municipal_tax?: boolean;
|
|
7022
|
+
/** @example ["general_obligation"] */
|
|
7023
|
+
municipal_types?: string[];
|
|
7024
|
+
pagination: InsightPaginationV2;
|
|
7025
|
+
purposes?: string[];
|
|
7026
|
+
/** @example ["SOVEREIGN"] */
|
|
7027
|
+
sectors?: string[];
|
|
7028
|
+
sorts?: InsightOrderingV2[];
|
|
7029
|
+
/** @example ["AAA"] */
|
|
7030
|
+
sp_ratings?: string[];
|
|
7031
|
+
/** @example ["called","outstanding"] */
|
|
7032
|
+
statuses?: string[];
|
|
7033
|
+
tickers?: string[];
|
|
7034
|
+
/** @example ["corporate"] */
|
|
7035
|
+
types?: string[];
|
|
7036
|
+
}
|
|
7037
|
+
export interface InsightGetTopSymbolsRequestV2 {
|
|
7038
|
+
exchange?: string[];
|
|
7039
|
+
market_cap?: InsightLessAndMoreV2;
|
|
7040
|
+
pagination?: InsightPaginationV2;
|
|
7041
|
+
price?: InsightLessAndMoreV2;
|
|
7042
|
+
sorts?: InsightOrderingV2[];
|
|
7043
|
+
volume?: InsightLessAndMoreV2;
|
|
7044
|
+
}
|
|
7045
|
+
export interface InsightIncludeExcludeV2 {
|
|
7046
|
+
exclude?: string[];
|
|
7047
|
+
include?: string[];
|
|
7048
|
+
}
|
|
7049
|
+
export interface InsightLessAndMoreV2 {
|
|
7050
|
+
less_than?: number;
|
|
7051
|
+
more_than?: number;
|
|
7052
|
+
}
|
|
7053
|
+
export enum InsightOrderDirectionV2 {
|
|
7054
|
+
OrderASC = "asc",
|
|
7055
|
+
OrderDESC = "desc"
|
|
7056
|
+
}
|
|
7057
|
+
export interface InsightOrderingV2 {
|
|
7032
7058
|
/**
|
|
7033
|
-
* @
|
|
7034
|
-
* @
|
|
7035
|
-
* @name GlobalIndexEdit
|
|
7036
|
-
* @summary Edit global index
|
|
7037
|
-
* @request PUT:/global-indexes
|
|
7038
|
-
* @secure
|
|
7059
|
+
* @default "asc"
|
|
7060
|
+
* @example "asc"
|
|
7039
7061
|
*/
|
|
7040
|
-
|
|
7062
|
+
direction: InsightOrderingDirectionEnumV2;
|
|
7041
7063
|
/**
|
|
7042
|
-
*
|
|
7043
|
-
*
|
|
7044
|
-
*
|
|
7045
|
-
* @
|
|
7046
|
-
* @request POST:/global-indexes
|
|
7047
|
-
* @secure
|
|
7064
|
+
* Sort direction:
|
|
7065
|
+
* * asc - Ascending, from A to Z.
|
|
7066
|
+
* * desc - Descending, from Z to A.
|
|
7067
|
+
* @example "name"
|
|
7048
7068
|
*/
|
|
7049
|
-
|
|
7069
|
+
field: string;
|
|
7070
|
+
}
|
|
7071
|
+
export interface InsightPaginationV2 {
|
|
7050
7072
|
/**
|
|
7051
|
-
* @
|
|
7052
|
-
* @
|
|
7053
|
-
* @name GlobalIndexDelete
|
|
7054
|
-
* @summary Delete global index
|
|
7055
|
-
* @request DELETE:/global-indexes
|
|
7056
|
-
* @secure
|
|
7073
|
+
* @min 1
|
|
7074
|
+
* @example 1
|
|
7057
7075
|
*/
|
|
7058
|
-
|
|
7059
|
-
/** a3 code */
|
|
7060
|
-
a3code: string;
|
|
7061
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
7076
|
+
page: number;
|
|
7062
7077
|
/**
|
|
7063
|
-
* @
|
|
7064
|
-
* @
|
|
7065
|
-
* @
|
|
7066
|
-
* @summary Get regions
|
|
7067
|
-
* @request GET:/regions
|
|
7068
|
-
* @secure
|
|
7078
|
+
* @min 1
|
|
7079
|
+
* @max 50
|
|
7080
|
+
* @example 10
|
|
7069
7081
|
*/
|
|
7070
|
-
|
|
7071
|
-
|
|
7072
|
-
|
|
7073
|
-
|
|
7074
|
-
|
|
7075
|
-
|
|
7082
|
+
size: number;
|
|
7083
|
+
}
|
|
7084
|
+
export interface InsightStockScreenerQuoteV2 {
|
|
7085
|
+
average_volume_30d: number;
|
|
7086
|
+
company_name: string;
|
|
7087
|
+
dividend_ex_date: string;
|
|
7088
|
+
dividend_pay_date: string;
|
|
7089
|
+
dividend_percent: number;
|
|
7090
|
+
exchange: string;
|
|
7091
|
+
exchange_name: string;
|
|
7092
|
+
gap: number;
|
|
7093
|
+
industry: string;
|
|
7094
|
+
industry_code: string;
|
|
7095
|
+
last_price: number;
|
|
7096
|
+
market_cap: number;
|
|
7097
|
+
pe_ratio: number;
|
|
7098
|
+
price_change: number;
|
|
7099
|
+
price_change_percent: number;
|
|
7100
|
+
symbol: string;
|
|
7101
|
+
volume: number;
|
|
7102
|
+
}
|
|
7103
|
+
export interface InsightStockScreenerRequestV2 {
|
|
7104
|
+
average_volume_30d?: InsightLessAndMoreV2;
|
|
7105
|
+
dividend_ex_date?: InsightBeforeAndAfterV2;
|
|
7106
|
+
dividend_pay_date?: InsightBeforeAndAfterV2;
|
|
7107
|
+
dividend_percent?: InsightLessAndMoreV2;
|
|
7108
|
+
exchange?: InsightIncludeExcludeV2;
|
|
7109
|
+
gap?: InsightLessAndMoreV2;
|
|
7110
|
+
industry?: InsightIncludeExcludeV2;
|
|
7111
|
+
market_cap?: InsightLessAndMoreV2;
|
|
7112
|
+
pagination: InsightPaginationV2;
|
|
7113
|
+
pe_ratio?: InsightLessAndMoreV2;
|
|
7114
|
+
price?: InsightLessAndMoreV2;
|
|
7115
|
+
sorts?: InsightOrderingV2[];
|
|
7116
|
+
/** @example "ADR" */
|
|
7117
|
+
stock_type?: string;
|
|
7118
|
+
volume?: InsightLessAndMoreV2;
|
|
7119
|
+
}
|
|
7120
|
+
export interface InsightStockScreenerResponseV2 {
|
|
7121
|
+
current_page: number;
|
|
7122
|
+
data: InsightStockScreenerQuoteV2[];
|
|
7123
|
+
page_count: number;
|
|
7124
|
+
status: number;
|
|
7125
|
+
total_records: number;
|
|
7126
|
+
}
|
|
7127
|
+
/**
|
|
7128
|
+
* @default "asc"
|
|
7129
|
+
* @example "asc"
|
|
7130
|
+
*/
|
|
7131
|
+
export enum InsightOrderingDirectionEnumV2 {
|
|
7132
|
+
Asc = "asc",
|
|
7133
|
+
Desc = "desc"
|
|
7134
|
+
}
|
|
7135
|
+
export class FixedIncomeV2<HandleError extends boolean = boolean> {
|
|
7136
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
7137
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
7076
7138
|
/**
|
|
7077
|
-
* @description
|
|
7078
|
-
* @tags
|
|
7079
|
-
* @name
|
|
7080
|
-
* @summary
|
|
7081
|
-
* @request
|
|
7139
|
+
* @description get fixed income entries
|
|
7140
|
+
* @tags FixedIncome
|
|
7141
|
+
* @name GetFixedIncomeEntries
|
|
7142
|
+
* @summary get fixed income entries
|
|
7143
|
+
* @request POST:/fixed-income
|
|
7082
7144
|
* @secure
|
|
7083
7145
|
*/
|
|
7084
|
-
|
|
7146
|
+
getFixedIncomeEntries(filter: InsightGetFixedIncomeEntriesRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightGetFixedIncomeEntriesResponseV2, HandleError>>;
|
|
7147
|
+
}
|
|
7148
|
+
export class StockScreenerV2<HandleError extends boolean = boolean> {
|
|
7149
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
7150
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
7085
7151
|
/**
|
|
7086
|
-
* @description
|
|
7087
|
-
* @tags
|
|
7088
|
-
* @name
|
|
7089
|
-
* @summary
|
|
7090
|
-
* @request POST:/
|
|
7152
|
+
* @description filter stocks by params
|
|
7153
|
+
* @tags StockScreener
|
|
7154
|
+
* @name StockScreener
|
|
7155
|
+
* @summary filter stocks by params
|
|
7156
|
+
* @request POST:/stock-screener
|
|
7091
7157
|
* @secure
|
|
7092
7158
|
*/
|
|
7093
|
-
|
|
7159
|
+
stockScreener(filter: InsightStockScreenerRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
7094
7160
|
/**
|
|
7095
|
-
* @description
|
|
7096
|
-
* @tags
|
|
7097
|
-
* @name
|
|
7098
|
-
* @summary
|
|
7099
|
-
* @request
|
|
7161
|
+
* @description get top symbols
|
|
7162
|
+
* @tags StockScreener
|
|
7163
|
+
* @name GetTopSymbols
|
|
7164
|
+
* @summary get top symbols
|
|
7165
|
+
* @request POST:/stock-screener/top
|
|
7100
7166
|
* @secure
|
|
7101
7167
|
*/
|
|
7102
|
-
|
|
7103
|
-
/** region id */
|
|
7104
|
-
id: string;
|
|
7105
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<void, HandleError>>;
|
|
7168
|
+
getTopSymbols(input: InsightGetTopSymbolsRequestV2, config?: RequestConfig<HandleError>): Promise<ClientResponse<InsightStockScreenerResponseV2, HandleError>>;
|
|
7106
7169
|
}
|
|
7107
7170
|
export class InsightApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
7108
7171
|
readonly config: JwtClientConfig<HandleError>;
|