@orbis-systems/orbis-api-clients 0.6.10 → 0.7.0
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 +642 -721
- 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 +543 -381
- 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 +1043 -1026
- 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 +95 -95
- 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 +4123 -4103
- 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 +640 -598
- package/dist/uma/index.d.ts.map +1 -1
- package/dist/uma/index.esm.js +1 -1
- package/dist/uma/index.esm.js.map +1 -1
- package/dist/uma/index.js +1 -1
- package/dist/uma/index.js.map +1 -1
- package/dist/zerohash/index.d.ts +15480 -0
- package/dist/zerohash/index.d.ts.map +1 -0
- package/dist/zerohash/index.esm.js +2 -0
- package/dist/zerohash/index.esm.js.map +1 -0
- package/dist/zerohash/index.js +2 -0
- package/dist/zerohash/index.js.map +1 -0
- package/package.json +5 -3
|
@@ -705,7 +705,8 @@ export interface BridgeWiseHoldingsStatisticsItem {
|
|
|
705
705
|
/** IdentifierTypeEnum */
|
|
706
706
|
export enum BridgeWiseIdentifierTypeEnum {
|
|
707
707
|
TickerExchange = "ticker_exchange",
|
|
708
|
-
Isin = "isin"
|
|
708
|
+
Isin = "isin",
|
|
709
|
+
Custom = "custom"
|
|
709
710
|
}
|
|
710
711
|
/** ImageExtensionEnum */
|
|
711
712
|
export enum BridgeWiseImageExtensionEnum {
|
|
@@ -878,6 +879,10 @@ export interface BridgeWiseTradingItems {
|
|
|
878
879
|
exchange_importance_level: number | null;
|
|
879
880
|
/** Currency Iso3 */
|
|
880
881
|
currency_iso3: string | null;
|
|
882
|
+
/** Asset Type */
|
|
883
|
+
asset_type: string | null;
|
|
884
|
+
/** Has Score */
|
|
885
|
+
has_score: boolean | null;
|
|
881
886
|
}
|
|
882
887
|
/** TradingItemsList */
|
|
883
888
|
export type BridgeWiseTradingItemsList = BridgeWiseTradingItems[];
|
|
@@ -928,6 +933,26 @@ export enum BridgeWiseCompanyNewsSortingEnum {
|
|
|
928
933
|
RelevancyScore = "relevancy_score",
|
|
929
934
|
SocialShares = "social_shares"
|
|
930
935
|
}
|
|
936
|
+
/** CompanyTechnicalParagraphList */
|
|
937
|
+
export type BridgeWiseCompanyTechnicalParagraphList = BridgeWiseCompanyTechnicalParagraphResponse[];
|
|
938
|
+
/** CompanyTechnicalParagraphResponse */
|
|
939
|
+
export interface BridgeWiseCompanyTechnicalParagraphResponse {
|
|
940
|
+
/** Analysis Type */
|
|
941
|
+
analysis_type: string;
|
|
942
|
+
/** Section Type */
|
|
943
|
+
section_type: string;
|
|
944
|
+
/** Paragraph Type */
|
|
945
|
+
paragraph_type: string;
|
|
946
|
+
/** Paragraph */
|
|
947
|
+
paragraph: string;
|
|
948
|
+
/**
|
|
949
|
+
* Language
|
|
950
|
+
* @default "en-US"
|
|
951
|
+
*/
|
|
952
|
+
language?: string;
|
|
953
|
+
/** Updated At */
|
|
954
|
+
updated_at: string;
|
|
955
|
+
}
|
|
931
956
|
/** ESGSectionTypeEnum */
|
|
932
957
|
export enum BridgeWiseESGSectionTypeEnum {
|
|
933
958
|
Social = "social",
|
|
@@ -1127,6 +1152,50 @@ export interface BridgeWiseCompanyParameter {
|
|
|
1127
1152
|
}
|
|
1128
1153
|
/** CompanyParametersItemList */
|
|
1129
1154
|
export type BridgeWiseCompanyParametersItemList = BridgeWiseCompanyParameter[];
|
|
1155
|
+
/** CompanyTechParameter */
|
|
1156
|
+
export interface BridgeWiseCompanyTechParameter {
|
|
1157
|
+
/**
|
|
1158
|
+
* Language
|
|
1159
|
+
* @default "en-US"
|
|
1160
|
+
*/
|
|
1161
|
+
language?: string;
|
|
1162
|
+
/**
|
|
1163
|
+
* Updated At
|
|
1164
|
+
* @format date
|
|
1165
|
+
*/
|
|
1166
|
+
updated_at: string;
|
|
1167
|
+
/**
|
|
1168
|
+
* Analysis Type
|
|
1169
|
+
* @default "technical"
|
|
1170
|
+
*/
|
|
1171
|
+
analysis_type?: string;
|
|
1172
|
+
/**
|
|
1173
|
+
* Analysis Type Name
|
|
1174
|
+
* @default "technical"
|
|
1175
|
+
*/
|
|
1176
|
+
analysis_type_name?: string;
|
|
1177
|
+
/** Parameter Id */
|
|
1178
|
+
parameter_id: number;
|
|
1179
|
+
/** Parameter Name */
|
|
1180
|
+
parameter_name: number | string;
|
|
1181
|
+
/** Parameter Description */
|
|
1182
|
+
parameter_description: number | string;
|
|
1183
|
+
/** Parameter Value */
|
|
1184
|
+
parameter_value: number | null;
|
|
1185
|
+
/** Parameter Sentiment */
|
|
1186
|
+
parameter_sentiment: string | number | null;
|
|
1187
|
+
/** Parameter Currency Iso3 */
|
|
1188
|
+
parameter_currency_iso3: string | null;
|
|
1189
|
+
/**
|
|
1190
|
+
* Parameter Type
|
|
1191
|
+
* @default "unit"
|
|
1192
|
+
*/
|
|
1193
|
+
parameter_type?: string | null;
|
|
1194
|
+
/** Parameter Exchange Rate To Usd */
|
|
1195
|
+
parameter_exchange_rate_to_usd: number | null;
|
|
1196
|
+
}
|
|
1197
|
+
/** CompanyTechParameterItemList */
|
|
1198
|
+
export type BridgeWiseCompanyTechParameterItemList = BridgeWiseCompanyTechParameter[];
|
|
1130
1199
|
/** ESGParameterListV2 */
|
|
1131
1200
|
export type BridgeWiseESGParameterListV2 = BridgeWiseESGParameterV2[];
|
|
1132
1201
|
/**
|
|
@@ -1372,6 +1441,8 @@ export enum BridgeWiseAnalysisTypeEnum {
|
|
|
1372
1441
|
PriceTarget = "price_target",
|
|
1373
1442
|
Technical = "technical"
|
|
1374
1443
|
}
|
|
1444
|
+
/** CompanyTechAnalysisResponse */
|
|
1445
|
+
export type BridgeWiseCompanyTechAnalysisResponse = BridgeWiseTechAnalysisItem;
|
|
1375
1446
|
/** FundamentalAnalysisResponse */
|
|
1376
1447
|
export type BridgeWiseFundamentalAnalysisResponse = BridgeWiseFundamentalAnalysisResponseItem[];
|
|
1377
1448
|
/** FundamentalAnalysisResponseItem */
|
|
@@ -1608,13 +1679,45 @@ export interface BridgeWiseTargetPriceResponse {
|
|
|
1608
1679
|
/** Currency Iso3 */
|
|
1609
1680
|
currency_iso3: string;
|
|
1610
1681
|
}
|
|
1682
|
+
/** TechAnalysisItem */
|
|
1683
|
+
export interface BridgeWiseTechAnalysisItem {
|
|
1684
|
+
/** Language */
|
|
1685
|
+
language: string;
|
|
1686
|
+
/** Updated At */
|
|
1687
|
+
updated_at: string | null;
|
|
1688
|
+
/** Analysis Type */
|
|
1689
|
+
analysis_type: string | null;
|
|
1690
|
+
/** Analysis Type Name */
|
|
1691
|
+
analysis_type_name: string | null;
|
|
1692
|
+
/** Analysis Score */
|
|
1693
|
+
analysis_score: number | null;
|
|
1694
|
+
/** Analysis Score Group */
|
|
1695
|
+
analysis_score_group: number | null;
|
|
1696
|
+
/** Analysis Score Group Text */
|
|
1697
|
+
analysis_score_group_text: number | string | null;
|
|
1698
|
+
/** Analysis Score Universe Median */
|
|
1699
|
+
analysis_score_universe_median: number | null;
|
|
1700
|
+
/** Analysis Score Universe Avg */
|
|
1701
|
+
analysis_score_universe_avg: number | null;
|
|
1702
|
+
/** Analysis Rank */
|
|
1703
|
+
analysis_rank: number | null;
|
|
1704
|
+
/** Analysis Rank Change */
|
|
1705
|
+
analysis_rank_change: number | null;
|
|
1706
|
+
/** Analysis Rank Percentile */
|
|
1707
|
+
analysis_rank_percentile: number | null;
|
|
1708
|
+
/**
|
|
1709
|
+
* Total Entities In Universe
|
|
1710
|
+
* @default 1
|
|
1711
|
+
*/
|
|
1712
|
+
total_entities_in_universe?: number | null;
|
|
1713
|
+
}
|
|
1611
1714
|
/** CreateTenantApp */
|
|
1612
1715
|
export interface BridgeWiseCreateTenantApp {
|
|
1613
1716
|
/** Client Name */
|
|
1614
1717
|
client_name: string;
|
|
1615
1718
|
/**
|
|
1616
1719
|
* Access Token Expiration
|
|
1617
|
-
* @default
|
|
1720
|
+
* @default 24
|
|
1618
1721
|
*/
|
|
1619
1722
|
access_token_expiration?: number;
|
|
1620
1723
|
/**
|
|
@@ -1817,6 +1920,13 @@ export interface BridgeWiseTenantResponse {
|
|
|
1817
1920
|
id: string | number;
|
|
1818
1921
|
/** Name */
|
|
1819
1922
|
name: string;
|
|
1923
|
+
/** @default "en-US" */
|
|
1924
|
+
default_language?: BridgeWiseLanguageEnum | null;
|
|
1925
|
+
/**
|
|
1926
|
+
* Clarity Analytic
|
|
1927
|
+
* @default false
|
|
1928
|
+
*/
|
|
1929
|
+
clarity_analytic?: boolean | null;
|
|
1820
1930
|
/** Slug */
|
|
1821
1931
|
slug: string;
|
|
1822
1932
|
/**
|
|
@@ -1941,6 +2051,133 @@ export enum BridgeWiseStockingFloatConfigOperatorEnum {
|
|
|
1941
2051
|
Gt = "gt",
|
|
1942
2052
|
Lt = "lt"
|
|
1943
2053
|
}
|
|
2054
|
+
export class Activities<HandleError extends boolean = boolean> {
|
|
2055
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2056
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2057
|
+
/**
|
|
2058
|
+
* @description Provides for a specific company access to a comprehensive set of key alerts highlighting significant Fundamental and Market data points and ratios that may influence a company's stock performance. Bridgewise enhances this information by categorizing each alert, offering a concise explanation of its significance, and providing sentiment analysis to indicate the likely positive or negative impact on the stock.
|
|
2059
|
+
* @tags Activities
|
|
2060
|
+
* @name GetCompanyAlerts
|
|
2061
|
+
* @summary Get Company Alerts
|
|
2062
|
+
* @request GET:/companies/{company_id}/alerts
|
|
2063
|
+
* @secure
|
|
2064
|
+
*/
|
|
2065
|
+
getCompanyAlerts(companyId: number, query?: {
|
|
2066
|
+
/**
|
|
2067
|
+
* Language
|
|
2068
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2069
|
+
* @default "en-US"
|
|
2070
|
+
*/
|
|
2071
|
+
language?: BridgeWiseLanguageEnum;
|
|
2072
|
+
/**
|
|
2073
|
+
* Alert Type
|
|
2074
|
+
* Specify the group of the alert type that will be presented (fundamental or market).
|
|
2075
|
+
*/
|
|
2076
|
+
alert_type?: BridgeWiseCompanyAlertType;
|
|
2077
|
+
/**
|
|
2078
|
+
* Sentiment
|
|
2079
|
+
* Filter alerts by their sentiment.
|
|
2080
|
+
*/
|
|
2081
|
+
sentiment?: BridgeWiseCompanyAlertSentiment;
|
|
2082
|
+
/**
|
|
2083
|
+
* Importance
|
|
2084
|
+
* Filter the type of alert that will be shown (importance = 0 is not to show).comma-separated list of numeric values. e.g, 0,1,2
|
|
2085
|
+
*/
|
|
2086
|
+
importance?: string | null;
|
|
2087
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyAlert[], HandleError>>;
|
|
2088
|
+
/**
|
|
2089
|
+
* @description Provides for a specifc company access to a collection of external events, including news articles, corporate announcements, and other relevant occurrences, that may impact a company's stock performance. Bridgewise enhances this information by categorizing each event, providing a concise explanation, and offering sentiment analysis to indicate its likely positive or negative impact on the stock.
|
|
2090
|
+
* @tags Activities
|
|
2091
|
+
* @name GetCompanyForecastsKeyDevelopment
|
|
2092
|
+
* @summary Get Company Forecasts Key Development
|
|
2093
|
+
* @request GET:/companies/{company_id}/key-developments
|
|
2094
|
+
* @secure
|
|
2095
|
+
*/
|
|
2096
|
+
getCompanyForecastsKeyDevelopment(companyId: number, query?: {
|
|
2097
|
+
/**
|
|
2098
|
+
* Language
|
|
2099
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2100
|
+
* @default "en-US"
|
|
2101
|
+
*/
|
|
2102
|
+
language?: BridgeWiseLanguageEnum;
|
|
2103
|
+
/**
|
|
2104
|
+
* Importance
|
|
2105
|
+
* Filter the type of alert that will be shown (importance = 0 is not to show).comma-separated list of numeric values. e.g, 0,1,2
|
|
2106
|
+
* @default "0,1"
|
|
2107
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
2108
|
+
*/
|
|
2109
|
+
importance?: string;
|
|
2110
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecast[], HandleError>>;
|
|
2111
|
+
}
|
|
2112
|
+
export class CompanyMarketData<HandleError extends boolean = boolean> {
|
|
2113
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2114
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2115
|
+
/**
|
|
2116
|
+
* @description Offers key market data for the specified company, including daily high, open, low, close prices, and market capitalization.
|
|
2117
|
+
* @tags Company Market Data
|
|
2118
|
+
* @name GetCompanyMarketData
|
|
2119
|
+
* @summary Get Company Market Data
|
|
2120
|
+
* @request GET:/companies/{company_id}/market
|
|
2121
|
+
* @secure
|
|
2122
|
+
*/
|
|
2123
|
+
getCompanyMarketData(companyId: number, query?: {
|
|
2124
|
+
/**
|
|
2125
|
+
* Trading Item Id
|
|
2126
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
2127
|
+
*/
|
|
2128
|
+
trading_item_id?: number | null;
|
|
2129
|
+
/**
|
|
2130
|
+
* Date Ge
|
|
2131
|
+
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
2132
|
+
*/
|
|
2133
|
+
date__ge?: string | null;
|
|
2134
|
+
/**
|
|
2135
|
+
* Date Le
|
|
2136
|
+
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
2137
|
+
*/
|
|
2138
|
+
date__le?: string | null;
|
|
2139
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketDataList, HandleError>>;
|
|
2140
|
+
/**
|
|
2141
|
+
* @description Provides detailed market statistics for the specified company, including returns over various periods: 1 week, 1 month, 6 months, 1 year, YTD, and 5 years.
|
|
2142
|
+
* @tags Company Market Data
|
|
2143
|
+
* @name GetCompanyMarketStatistics
|
|
2144
|
+
* @summary Get Company Market Statistics
|
|
2145
|
+
* @request GET:/companies/{company_id}/market-statistics
|
|
2146
|
+
* @secure
|
|
2147
|
+
*/
|
|
2148
|
+
getCompanyMarketStatistics(companyId: number, query?: {
|
|
2149
|
+
/**
|
|
2150
|
+
* Trading Item Id
|
|
2151
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
2152
|
+
*/
|
|
2153
|
+
trading_item_id?: number | null;
|
|
2154
|
+
/**
|
|
2155
|
+
* Identifier In
|
|
2156
|
+
* Specify a list of external identifiers.
|
|
2157
|
+
*/
|
|
2158
|
+
identifier__in?: string | null;
|
|
2159
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticsDataList, HandleError>>;
|
|
2160
|
+
/**
|
|
2161
|
+
* @description Returns detailed information on trading items related to the specified company, focusing exclusively on stocks.
|
|
2162
|
+
* @tags Company Market Data
|
|
2163
|
+
* @name GetTradingItems
|
|
2164
|
+
* @summary Get Trading Items
|
|
2165
|
+
* @request GET:/companies/{company_id}/trading-items
|
|
2166
|
+
* @secure
|
|
2167
|
+
*/
|
|
2168
|
+
getTradingItems(companyId: number, query?: {
|
|
2169
|
+
/**
|
|
2170
|
+
* Primary Flag
|
|
2171
|
+
* Boolean flag. Indicate if only primary trading item data is required (true/false).
|
|
2172
|
+
*/
|
|
2173
|
+
primary_flag?: BridgeWiseStringBooleanEnum;
|
|
2174
|
+
/**
|
|
2175
|
+
* Security Primary Flag
|
|
2176
|
+
* Boolean flag. Indicate if only primary asset data is required (true/false).
|
|
2177
|
+
*/
|
|
2178
|
+
security_primary_flag?: BridgeWiseStringBooleanEnum;
|
|
2179
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
|
|
2180
|
+
}
|
|
1944
2181
|
export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
1945
2182
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
1946
2183
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -2584,108 +2821,84 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
|
2584
2821
|
identifier_type: BridgeWiseIdentifierTypeEnum;
|
|
2585
2822
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
|
|
2586
2823
|
}
|
|
2587
|
-
export class
|
|
2824
|
+
export class CompanyNews<HandleError extends boolean = boolean> {
|
|
2588
2825
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2589
2826
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2590
2827
|
/**
|
|
2591
|
-
* @description
|
|
2592
|
-
* @tags
|
|
2593
|
-
* @name
|
|
2594
|
-
* @summary
|
|
2595
|
-
* @request GET:/companies/
|
|
2828
|
+
* @description This endpoint provides news articles related to the specified company.
|
|
2829
|
+
* @tags Company News
|
|
2830
|
+
* @name GetCompanyNews
|
|
2831
|
+
* @summary Get Company News
|
|
2832
|
+
* @request GET:/companies/{company_id}/news
|
|
2596
2833
|
* @secure
|
|
2597
2834
|
*/
|
|
2598
|
-
|
|
2835
|
+
getCompanyNews(companyId: number, query?: {
|
|
2599
2836
|
/**
|
|
2600
|
-
*
|
|
2601
|
-
*
|
|
2602
|
-
* @
|
|
2603
|
-
* @
|
|
2837
|
+
* Languages
|
|
2838
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2839
|
+
* @default "en-US"
|
|
2840
|
+
* @pattern ^(ar-SA|de-DE|en-US|es-ES|fr-FR|he-IL|nl-NL|pt-BR|tr-TR|zh-CN|ja-JP|ko-KR|th-TH|zh-HK)(,(ar-SA|de-DE|en-US|es-ES|fr-FR|he-IL|nl-NL|pt-BR|tr-TR|zh-CN|ja-JP|ko-KR|th-TH|zh-HK))*$
|
|
2604
2841
|
*/
|
|
2605
|
-
|
|
2842
|
+
languages?: string;
|
|
2606
2843
|
/**
|
|
2607
|
-
*
|
|
2608
|
-
*
|
|
2609
|
-
* @
|
|
2610
|
-
* @
|
|
2611
|
-
* @default 50
|
|
2844
|
+
* Published Date Gte
|
|
2845
|
+
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
2846
|
+
* @format date
|
|
2847
|
+
* @default "2025-04-09"
|
|
2612
2848
|
*/
|
|
2613
|
-
|
|
2849
|
+
published_date__gte?: string;
|
|
2614
2850
|
/**
|
|
2615
|
-
*
|
|
2616
|
-
*
|
|
2617
|
-
* @
|
|
2618
|
-
* @default
|
|
2851
|
+
* Published Date Lte
|
|
2852
|
+
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
2853
|
+
* @format date
|
|
2854
|
+
* @default "2025-04-09"
|
|
2619
2855
|
*/
|
|
2620
|
-
|
|
2621
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
|
|
2622
|
-
/**
|
|
2623
|
-
* @description Retrieves the logo for a specified company using the provided company_id.
|
|
2624
|
-
* @tags Logos
|
|
2625
|
-
* @name FetchLogo
|
|
2626
|
-
* @summary Fetch Logo
|
|
2627
|
-
* @request GET:/companies/{company_id}/logos
|
|
2628
|
-
* @secure
|
|
2629
|
-
*/
|
|
2630
|
-
fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
|
|
2631
|
-
}
|
|
2632
|
-
export class Activities<HandleError extends boolean = boolean> {
|
|
2633
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2634
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2635
|
-
/**
|
|
2636
|
-
* @description Provides for a specific company access to a comprehensive set of key alerts highlighting significant Fundamental and Market data points and ratios that may influence a company's stock performance. Bridgewise enhances this information by categorizing each alert, offering a concise explanation of its significance, and providing sentiment analysis to indicate the likely positive or negative impact on the stock.
|
|
2637
|
-
* @tags Activities
|
|
2638
|
-
* @name GetCompanyAlerts
|
|
2639
|
-
* @summary Get Company Alerts
|
|
2640
|
-
* @request GET:/companies/{company_id}/alerts
|
|
2641
|
-
* @secure
|
|
2642
|
-
*/
|
|
2643
|
-
getCompanyAlerts(companyId: number, query?: {
|
|
2644
|
-
/**
|
|
2645
|
-
* Language
|
|
2646
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2647
|
-
* @default "en-US"
|
|
2648
|
-
*/
|
|
2649
|
-
language?: BridgeWiseLanguageEnum;
|
|
2856
|
+
published_date__lte?: string;
|
|
2650
2857
|
/**
|
|
2651
|
-
*
|
|
2652
|
-
* Specify the
|
|
2858
|
+
* Sort By
|
|
2859
|
+
* Specify the field by which to sort the results.
|
|
2860
|
+
* @default "publication_date"
|
|
2653
2861
|
*/
|
|
2654
|
-
|
|
2862
|
+
sort_by?: BridgeWiseCompanyNewsSortingEnum;
|
|
2655
2863
|
/**
|
|
2656
|
-
*
|
|
2657
|
-
*
|
|
2864
|
+
* Size
|
|
2865
|
+
* Define the number of records per page for pagination purposes.
|
|
2866
|
+
* @default 10
|
|
2867
|
+
* @example 10
|
|
2658
2868
|
*/
|
|
2659
|
-
|
|
2869
|
+
size?: number;
|
|
2660
2870
|
/**
|
|
2661
|
-
*
|
|
2662
|
-
*
|
|
2871
|
+
* Page
|
|
2872
|
+
* Define the page number for pagination.
|
|
2873
|
+
* @default 1
|
|
2874
|
+
* @example 1
|
|
2663
2875
|
*/
|
|
2664
|
-
|
|
2665
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
2876
|
+
page?: number;
|
|
2877
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseCompanyNews, HandleError>>;
|
|
2666
2878
|
/**
|
|
2667
|
-
* @description
|
|
2668
|
-
* @tags
|
|
2669
|
-
* @name
|
|
2670
|
-
* @summary Get Company
|
|
2671
|
-
* @request GET:/companies/{company_id}/
|
|
2879
|
+
* @description This endpoint provides the average sentiment score of the news articles related to the specified company for the specified date range. Average sentiment scores are calculated based on the sentiment analysis of the news articles in english.
|
|
2880
|
+
* @tags Company News
|
|
2881
|
+
* @name GetAverageCompanyNewsSentiment
|
|
2882
|
+
* @summary Get Average Company News Sentiment
|
|
2883
|
+
* @request GET:/companies/{company_id}/news-sentiment
|
|
2672
2884
|
* @secure
|
|
2673
2885
|
*/
|
|
2674
|
-
|
|
2886
|
+
getAverageCompanyNewsSentiment(companyId: number, query?: {
|
|
2675
2887
|
/**
|
|
2676
|
-
*
|
|
2677
|
-
*
|
|
2678
|
-
* @
|
|
2888
|
+
* Published Date Gte
|
|
2889
|
+
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
2890
|
+
* @format date
|
|
2891
|
+
* @default "2025-04-09"
|
|
2679
2892
|
*/
|
|
2680
|
-
|
|
2893
|
+
published_date__gte?: string;
|
|
2681
2894
|
/**
|
|
2682
|
-
*
|
|
2683
|
-
*
|
|
2684
|
-
* @
|
|
2685
|
-
* @
|
|
2895
|
+
* Published Date Lte
|
|
2896
|
+
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
2897
|
+
* @format date
|
|
2898
|
+
* @default "2025-04-09"
|
|
2686
2899
|
*/
|
|
2687
|
-
|
|
2688
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
2900
|
+
published_date__lte?: string;
|
|
2901
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
|
|
2689
2902
|
}
|
|
2690
2903
|
export class EarningCalls<HandleError extends boolean = boolean> {
|
|
2691
2904
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -3049,198 +3262,167 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
3049
3262
|
date__lte?: string;
|
|
3050
3263
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTargetPriceList, HandleError>>;
|
|
3051
3264
|
}
|
|
3052
|
-
export class
|
|
3265
|
+
export class FundAnalysis<HandleError extends boolean = boolean> {
|
|
3053
3266
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3054
3267
|
constructor(apiClient: JwtClient<HandleError>);
|
|
3055
3268
|
/**
|
|
3056
|
-
* @description
|
|
3057
|
-
* @tags
|
|
3058
|
-
* @name
|
|
3059
|
-
* @summary Get
|
|
3060
|
-
* @request GET:/
|
|
3269
|
+
* @description Returns Bridgewise final analysis for a specified fund.
|
|
3270
|
+
* @tags Fund Analysis
|
|
3271
|
+
* @name GetFundAnalysis
|
|
3272
|
+
* @summary Get Fund Analysis
|
|
3273
|
+
* @request GET:/funds/{fund_id}/analysis
|
|
3061
3274
|
* @secure
|
|
3062
3275
|
*/
|
|
3063
|
-
|
|
3064
|
-
/**
|
|
3065
|
-
* Trading Item Id
|
|
3066
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
3067
|
-
*/
|
|
3068
|
-
trading_item_id?: number | null;
|
|
3276
|
+
getFundAnalysis(fundId: number, query?: {
|
|
3069
3277
|
/**
|
|
3070
|
-
*
|
|
3071
|
-
*
|
|
3278
|
+
* Language
|
|
3279
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3280
|
+
* @default "en-US"
|
|
3072
3281
|
*/
|
|
3073
|
-
|
|
3282
|
+
language?: BridgeWiseLanguageEnum;
|
|
3074
3283
|
/**
|
|
3075
|
-
*
|
|
3076
|
-
* Specify the
|
|
3284
|
+
* Year
|
|
3285
|
+
* Specify the year for which the analysis is requested.
|
|
3077
3286
|
*/
|
|
3078
|
-
|
|
3079
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketDataList, HandleError>>;
|
|
3080
|
-
/**
|
|
3081
|
-
* @description Provides detailed market statistics for the specified company, including returns over various periods: 1 week, 1 month, 6 months, 1 year, YTD, and 5 years.
|
|
3082
|
-
* @tags Company Market Data
|
|
3083
|
-
* @name GetCompanyMarketStatistics
|
|
3084
|
-
* @summary Get Company Market Statistics
|
|
3085
|
-
* @request GET:/companies/{company_id}/market-statistics
|
|
3086
|
-
* @secure
|
|
3087
|
-
*/
|
|
3088
|
-
getCompanyMarketStatistics(companyId: number, query?: {
|
|
3287
|
+
year?: number;
|
|
3089
3288
|
/**
|
|
3090
|
-
*
|
|
3091
|
-
* Specify
|
|
3289
|
+
* Quarter
|
|
3290
|
+
* Specify the quarter for which the analysis is requested.
|
|
3092
3291
|
*/
|
|
3093
|
-
|
|
3292
|
+
quarter?: number;
|
|
3094
3293
|
/**
|
|
3095
|
-
*
|
|
3096
|
-
*
|
|
3294
|
+
* Show All
|
|
3295
|
+
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
3097
3296
|
*/
|
|
3098
|
-
|
|
3099
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
3297
|
+
show_all?: boolean;
|
|
3298
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsAnalysisItem[], HandleError>>;
|
|
3100
3299
|
/**
|
|
3101
|
-
* @description Returns
|
|
3102
|
-
* @tags
|
|
3103
|
-
* @name
|
|
3104
|
-
* @summary Get
|
|
3105
|
-
* @request GET:/
|
|
3300
|
+
* @description Returns a series of textual paragraphs related to the specified fund. Each paragraph provides detailed insights into different aspects of the fund's strategy, holdings, performance, and risk management.
|
|
3301
|
+
* @tags Fund Analysis
|
|
3302
|
+
* @name GetFundsParagraphs
|
|
3303
|
+
* @summary Get Funds Paragraphs
|
|
3304
|
+
* @request GET:/funds/{fund_id}/paragraphs
|
|
3106
3305
|
* @secure
|
|
3107
3306
|
*/
|
|
3108
|
-
|
|
3307
|
+
getFundsParagraphs(fundId: number, query?: {
|
|
3109
3308
|
/**
|
|
3110
|
-
*
|
|
3111
|
-
*
|
|
3309
|
+
* Language
|
|
3310
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3311
|
+
* @default "en-US"
|
|
3112
3312
|
*/
|
|
3113
|
-
|
|
3313
|
+
language?: BridgeWiseLanguageEnum;
|
|
3114
3314
|
/**
|
|
3115
|
-
*
|
|
3116
|
-
*
|
|
3315
|
+
* Year
|
|
3316
|
+
* Specify the year for which the analysis is requested.
|
|
3117
3317
|
*/
|
|
3118
|
-
|
|
3119
|
-
|
|
3120
|
-
|
|
3121
|
-
|
|
3122
|
-
|
|
3123
|
-
|
|
3318
|
+
year?: number | null;
|
|
3319
|
+
/**
|
|
3320
|
+
* Quarter
|
|
3321
|
+
* Specify the quarter for which the analysis is requested.
|
|
3322
|
+
*/
|
|
3323
|
+
quarter?: number | null;
|
|
3324
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParagraph[], HandleError>>;
|
|
3124
3325
|
/**
|
|
3125
|
-
* @description
|
|
3126
|
-
* @tags
|
|
3127
|
-
* @name
|
|
3128
|
-
* @summary Get
|
|
3129
|
-
* @request GET:/
|
|
3326
|
+
* @description Returns a categorized list of parameter objects for a specified fund, organized into the following topics: holdings analysis, risk factors, and management metrics. These parameters offer detailed insights into various aspects of the fund's performance.
|
|
3327
|
+
* @tags Fund Analysis
|
|
3328
|
+
* @name GetFundParameters
|
|
3329
|
+
* @summary Get Fund Parameters
|
|
3330
|
+
* @request GET:/funds/{fund_id}/parameters
|
|
3130
3331
|
* @secure
|
|
3131
3332
|
*/
|
|
3132
|
-
|
|
3333
|
+
getFundParameters(fundId: number, query?: {
|
|
3133
3334
|
/**
|
|
3134
|
-
*
|
|
3335
|
+
* Language
|
|
3135
3336
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3136
3337
|
* @default "en-US"
|
|
3137
|
-
* @pattern ^(ar-SA|de-DE|en-US|es-ES|fr-FR|he-IL|nl-NL|pt-BR|tr-TR|zh-CN|ja-JP|ko-KR|th-TH|zh-HK)(,(ar-SA|de-DE|en-US|es-ES|fr-FR|he-IL|nl-NL|pt-BR|tr-TR|zh-CN|ja-JP|ko-KR|th-TH|zh-HK))*$
|
|
3138
3338
|
*/
|
|
3139
|
-
|
|
3339
|
+
language?: BridgeWiseLanguageEnum;
|
|
3140
3340
|
/**
|
|
3141
|
-
*
|
|
3142
|
-
*
|
|
3143
|
-
* @format date
|
|
3144
|
-
* @default "2025-03-20"
|
|
3341
|
+
* Parameter Id
|
|
3342
|
+
* ID of the parameter for analysis.
|
|
3145
3343
|
*/
|
|
3146
|
-
|
|
3344
|
+
parameter_id?: number;
|
|
3345
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParametersItemList, HandleError>>;
|
|
3346
|
+
/**
|
|
3347
|
+
* @description Returns Bridgewise scores for each section of the analysis for a specified fund. This includes scores for multiple sections such as holdings analysis, risk factors, and management metrics.
|
|
3348
|
+
* @tags Fund Analysis
|
|
3349
|
+
* @name GetFundSections
|
|
3350
|
+
* @summary Get Fund Sections
|
|
3351
|
+
* @request GET:/funds/{fund_id}/sections
|
|
3352
|
+
* @secure
|
|
3353
|
+
*/
|
|
3354
|
+
getFundSections(fundId: number, query?: {
|
|
3147
3355
|
/**
|
|
3148
|
-
*
|
|
3149
|
-
*
|
|
3150
|
-
* @format date
|
|
3151
|
-
* @default "2025-03-20"
|
|
3356
|
+
* Year
|
|
3357
|
+
* Specify the year for which the analysis is requested.
|
|
3152
3358
|
*/
|
|
3153
|
-
|
|
3359
|
+
year?: number;
|
|
3154
3360
|
/**
|
|
3155
|
-
*
|
|
3156
|
-
* Specify the
|
|
3157
|
-
* @default "publication_date"
|
|
3361
|
+
* Quarter
|
|
3362
|
+
* Specify the quarter for which the analysis is requested.
|
|
3158
3363
|
*/
|
|
3159
|
-
|
|
3364
|
+
quarter?: number;
|
|
3160
3365
|
/**
|
|
3161
|
-
*
|
|
3162
|
-
* Define the
|
|
3163
|
-
* @default
|
|
3164
|
-
* @example 10
|
|
3366
|
+
* Language
|
|
3367
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3368
|
+
* @default "en-US"
|
|
3165
3369
|
*/
|
|
3166
|
-
|
|
3370
|
+
language?: BridgeWiseLanguageEnum;
|
|
3167
3371
|
/**
|
|
3168
|
-
*
|
|
3169
|
-
*
|
|
3170
|
-
* @default 1
|
|
3171
|
-
* @example 1
|
|
3372
|
+
* Show All
|
|
3373
|
+
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
3172
3374
|
*/
|
|
3173
|
-
|
|
3174
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
3375
|
+
show_all?: boolean;
|
|
3376
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
|
|
3377
|
+
}
|
|
3378
|
+
export class FundMarketData<HandleError extends boolean = boolean> {
|
|
3379
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3380
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3175
3381
|
/**
|
|
3176
|
-
* @description
|
|
3177
|
-
* @tags
|
|
3178
|
-
* @name
|
|
3179
|
-
* @summary Get
|
|
3180
|
-
* @request GET:/
|
|
3382
|
+
* @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
|
|
3383
|
+
* @tags Fund Market Data
|
|
3384
|
+
* @name GetFundsMarketData
|
|
3385
|
+
* @summary Get Funds Market Data
|
|
3386
|
+
* @request GET:/funds/{fund_id}/market
|
|
3181
3387
|
* @secure
|
|
3182
3388
|
*/
|
|
3183
|
-
|
|
3389
|
+
getFundsMarketData(fundId: number, query?: {
|
|
3184
3390
|
/**
|
|
3185
|
-
*
|
|
3186
|
-
*
|
|
3187
|
-
* @format date
|
|
3188
|
-
* @default "2025-03-20"
|
|
3391
|
+
* Trading Item Id
|
|
3392
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
3189
3393
|
*/
|
|
3190
|
-
|
|
3394
|
+
trading_item_id?: number | null;
|
|
3191
3395
|
/**
|
|
3192
|
-
*
|
|
3193
|
-
*
|
|
3194
|
-
* @format date
|
|
3195
|
-
* @default "2025-03-20"
|
|
3396
|
+
* Date Ge
|
|
3397
|
+
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
3196
3398
|
*/
|
|
3197
|
-
|
|
3198
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
|
|
3199
|
-
}
|
|
3200
|
-
export class TechnicalAnalysis<HandleError extends boolean = boolean> {
|
|
3201
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3202
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3203
|
-
/**
|
|
3204
|
-
* @description This endpoint offers technical analysis of a company's stock price movements and trends.
|
|
3205
|
-
* @tags Technical Analysis
|
|
3206
|
-
* @name GetCompanyTechnicalParagraphs
|
|
3207
|
-
* @summary Get Company Technical Paragraphs
|
|
3208
|
-
* @request GET:/companies/{company_id}/technical-paragraphs
|
|
3209
|
-
* @secure
|
|
3210
|
-
*/
|
|
3211
|
-
getCompanyTechnicalParagraphs(companyId: number, query?: {
|
|
3399
|
+
date__ge?: string | null;
|
|
3212
3400
|
/**
|
|
3213
|
-
*
|
|
3214
|
-
*
|
|
3215
|
-
* @default "en-US"
|
|
3401
|
+
* Date Le
|
|
3402
|
+
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
3216
3403
|
*/
|
|
3217
|
-
|
|
3218
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
3219
|
-
}
|
|
3220
|
-
export class Metadata<HandleError extends boolean = boolean> {
|
|
3221
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3222
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3404
|
+
date__le?: string | null;
|
|
3405
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
|
|
3223
3406
|
/**
|
|
3224
|
-
* @description
|
|
3225
|
-
* @tags
|
|
3226
|
-
* @name
|
|
3227
|
-
* @summary Get
|
|
3228
|
-
* @request GET:/
|
|
3407
|
+
* @description Provides detailed market statistics for the specified fund, including returns over various periods: 1 week, 1 month, 6 months, 1 year, YTD, and 5 years.
|
|
3408
|
+
* @tags Fund Market Data
|
|
3409
|
+
* @name GetFundsMarketStatistics
|
|
3410
|
+
* @summary Get Funds Market Statistics
|
|
3411
|
+
* @request GET:/funds/{fund_id}/market-statistics
|
|
3229
3412
|
* @secure
|
|
3230
3413
|
*/
|
|
3231
|
-
|
|
3414
|
+
getFundsMarketStatistics(fundId: number, query?: {
|
|
3232
3415
|
/**
|
|
3233
|
-
*
|
|
3234
|
-
*
|
|
3416
|
+
* Trading Item Id
|
|
3417
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
3235
3418
|
*/
|
|
3236
|
-
|
|
3419
|
+
trading_item_id?: number | null;
|
|
3237
3420
|
/**
|
|
3238
|
-
*
|
|
3239
|
-
*
|
|
3240
|
-
* @default "en-US"
|
|
3421
|
+
* Identifier In
|
|
3422
|
+
* Specify a list of external identifiers.
|
|
3241
3423
|
*/
|
|
3242
|
-
|
|
3243
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
3424
|
+
identifier__in?: string | null;
|
|
3425
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
|
|
3244
3426
|
}
|
|
3245
3427
|
export class FundMetadata<HandleError extends boolean = boolean> {
|
|
3246
3428
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -3633,119 +3815,6 @@ export class FundMetadata<HandleError extends boolean = boolean> {
|
|
|
3633
3815
|
language?: BridgeWiseLanguageEnum;
|
|
3634
3816
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMetadataList, HandleError>>;
|
|
3635
3817
|
}
|
|
3636
|
-
export class FundAnalysis<HandleError extends boolean = boolean> {
|
|
3637
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3638
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3639
|
-
/**
|
|
3640
|
-
* @description Returns Bridgewise final analysis for a specified fund.
|
|
3641
|
-
* @tags Fund Analysis
|
|
3642
|
-
* @name GetFundAnalysis
|
|
3643
|
-
* @summary Get Fund Analysis
|
|
3644
|
-
* @request GET:/funds/{fund_id}/analysis
|
|
3645
|
-
* @secure
|
|
3646
|
-
*/
|
|
3647
|
-
getFundAnalysis(fundId: number, query?: {
|
|
3648
|
-
/**
|
|
3649
|
-
* Language
|
|
3650
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3651
|
-
* @default "en-US"
|
|
3652
|
-
*/
|
|
3653
|
-
language?: BridgeWiseLanguageEnum;
|
|
3654
|
-
/**
|
|
3655
|
-
* Year
|
|
3656
|
-
* Specify the year for which the analysis is requested.
|
|
3657
|
-
*/
|
|
3658
|
-
year?: number;
|
|
3659
|
-
/**
|
|
3660
|
-
* Quarter
|
|
3661
|
-
* Specify the quarter for which the analysis is requested.
|
|
3662
|
-
*/
|
|
3663
|
-
quarter?: number;
|
|
3664
|
-
/**
|
|
3665
|
-
* Show All
|
|
3666
|
-
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
3667
|
-
*/
|
|
3668
|
-
show_all?: boolean;
|
|
3669
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsAnalysisItem[], HandleError>>;
|
|
3670
|
-
/**
|
|
3671
|
-
* @description Returns a series of textual paragraphs related to the specified fund. Each paragraph provides detailed insights into different aspects of the fund's strategy, holdings, performance, and risk management.
|
|
3672
|
-
* @tags Fund Analysis
|
|
3673
|
-
* @name GetFundsParagraphs
|
|
3674
|
-
* @summary Get Funds Paragraphs
|
|
3675
|
-
* @request GET:/funds/{fund_id}/paragraphs
|
|
3676
|
-
* @secure
|
|
3677
|
-
*/
|
|
3678
|
-
getFundsParagraphs(fundId: number, query?: {
|
|
3679
|
-
/**
|
|
3680
|
-
* Language
|
|
3681
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3682
|
-
* @default "en-US"
|
|
3683
|
-
*/
|
|
3684
|
-
language?: BridgeWiseLanguageEnum;
|
|
3685
|
-
/**
|
|
3686
|
-
* Year
|
|
3687
|
-
* Specify the year for which the analysis is requested.
|
|
3688
|
-
*/
|
|
3689
|
-
year?: number | null;
|
|
3690
|
-
/**
|
|
3691
|
-
* Quarter
|
|
3692
|
-
* Specify the quarter for which the analysis is requested.
|
|
3693
|
-
*/
|
|
3694
|
-
quarter?: number | null;
|
|
3695
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParagraph[], HandleError>>;
|
|
3696
|
-
/**
|
|
3697
|
-
* @description Returns a categorized list of parameter objects for a specified fund, organized into the following topics: holdings analysis, risk factors, and management metrics. These parameters offer detailed insights into various aspects of the fund's performance.
|
|
3698
|
-
* @tags Fund Analysis
|
|
3699
|
-
* @name GetFundParameters
|
|
3700
|
-
* @summary Get Fund Parameters
|
|
3701
|
-
* @request GET:/funds/{fund_id}/parameters
|
|
3702
|
-
* @secure
|
|
3703
|
-
*/
|
|
3704
|
-
getFundParameters(fundId: number, query?: {
|
|
3705
|
-
/**
|
|
3706
|
-
* Language
|
|
3707
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3708
|
-
* @default "en-US"
|
|
3709
|
-
*/
|
|
3710
|
-
language?: BridgeWiseLanguageEnum;
|
|
3711
|
-
/**
|
|
3712
|
-
* Parameter Id
|
|
3713
|
-
* ID of the parameter for analysis.
|
|
3714
|
-
*/
|
|
3715
|
-
parameter_id?: number;
|
|
3716
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParametersItemList, HandleError>>;
|
|
3717
|
-
/**
|
|
3718
|
-
* @description Returns Bridgewise scores for each section of the analysis for a specified fund. This includes scores for multiple sections such as holdings analysis, risk factors, and management metrics.
|
|
3719
|
-
* @tags Fund Analysis
|
|
3720
|
-
* @name GetFundSections
|
|
3721
|
-
* @summary Get Fund Sections
|
|
3722
|
-
* @request GET:/funds/{fund_id}/sections
|
|
3723
|
-
* @secure
|
|
3724
|
-
*/
|
|
3725
|
-
getFundSections(fundId: number, query?: {
|
|
3726
|
-
/**
|
|
3727
|
-
* Year
|
|
3728
|
-
* Specify the year for which the analysis is requested.
|
|
3729
|
-
*/
|
|
3730
|
-
year?: number;
|
|
3731
|
-
/**
|
|
3732
|
-
* Quarter
|
|
3733
|
-
* Specify the quarter for which the analysis is requested.
|
|
3734
|
-
*/
|
|
3735
|
-
quarter?: number;
|
|
3736
|
-
/**
|
|
3737
|
-
* Language
|
|
3738
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3739
|
-
* @default "en-US"
|
|
3740
|
-
*/
|
|
3741
|
-
language?: BridgeWiseLanguageEnum;
|
|
3742
|
-
/**
|
|
3743
|
-
* Show All
|
|
3744
|
-
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
3745
|
-
*/
|
|
3746
|
-
show_all?: boolean;
|
|
3747
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
|
|
3748
|
-
}
|
|
3749
3818
|
export class Holdings<HandleError extends boolean = boolean> {
|
|
3750
3819
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3751
3820
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -3839,6 +3908,76 @@ export class Holdings<HandleError extends boolean = boolean> {
|
|
|
3839
3908
|
page_size?: number;
|
|
3840
3909
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
|
|
3841
3910
|
}
|
|
3911
|
+
export class Logos<HandleError extends boolean = boolean> {
|
|
3912
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3913
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3914
|
+
/**
|
|
3915
|
+
* @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
|
|
3916
|
+
* @tags Logos
|
|
3917
|
+
* @name FetchLogos
|
|
3918
|
+
* @summary Fetch Logos
|
|
3919
|
+
* @request GET:/companies/logos
|
|
3920
|
+
* @secure
|
|
3921
|
+
*/
|
|
3922
|
+
fetchLogos(query?: {
|
|
3923
|
+
/**
|
|
3924
|
+
* Company Id In
|
|
3925
|
+
* Specify a list of BW identifiers for bulk queries.
|
|
3926
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
3927
|
+
* @example "74822,83343211"
|
|
3928
|
+
*/
|
|
3929
|
+
company_id__in?: string;
|
|
3930
|
+
/**
|
|
3931
|
+
* Size
|
|
3932
|
+
* Page size
|
|
3933
|
+
* @min 1
|
|
3934
|
+
* @max 100
|
|
3935
|
+
* @default 50
|
|
3936
|
+
*/
|
|
3937
|
+
size?: number;
|
|
3938
|
+
/**
|
|
3939
|
+
* Page
|
|
3940
|
+
* Page number
|
|
3941
|
+
* @min 1
|
|
3942
|
+
* @default 1
|
|
3943
|
+
*/
|
|
3944
|
+
page?: number;
|
|
3945
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
|
|
3946
|
+
/**
|
|
3947
|
+
* @description Retrieves the logo for a specified company using the provided company_id.
|
|
3948
|
+
* @tags Logos
|
|
3949
|
+
* @name FetchLogo
|
|
3950
|
+
* @summary Fetch Logo
|
|
3951
|
+
* @request GET:/companies/{company_id}/logos
|
|
3952
|
+
* @secure
|
|
3953
|
+
*/
|
|
3954
|
+
fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
|
|
3955
|
+
}
|
|
3956
|
+
export class Metadata<HandleError extends boolean = boolean> {
|
|
3957
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3958
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3959
|
+
/**
|
|
3960
|
+
* @description This endpoint provides filters
|
|
3961
|
+
* @tags Metadata
|
|
3962
|
+
* @name GetCompanyFilters
|
|
3963
|
+
* @summary Get Company Filters
|
|
3964
|
+
* @request GET:/filters
|
|
3965
|
+
* @secure
|
|
3966
|
+
*/
|
|
3967
|
+
getCompanyFilters(query: {
|
|
3968
|
+
/**
|
|
3969
|
+
* Type
|
|
3970
|
+
* Desired filter type.
|
|
3971
|
+
*/
|
|
3972
|
+
type: BridgeWiseCompanyFilterType;
|
|
3973
|
+
/**
|
|
3974
|
+
* Language
|
|
3975
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3976
|
+
* @default "en-US"
|
|
3977
|
+
*/
|
|
3978
|
+
language?: BridgeWiseLanguageEnum;
|
|
3979
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyFilterResponse[], HandleError>>;
|
|
3980
|
+
}
|
|
3842
3981
|
export class Segmentations<HandleError extends boolean = boolean> {
|
|
3843
3982
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3844
3983
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -3895,77 +4034,77 @@ export class Segmentations<HandleError extends boolean = boolean> {
|
|
|
3895
4034
|
segment?: string;
|
|
3896
4035
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
|
|
3897
4036
|
}
|
|
3898
|
-
export class
|
|
4037
|
+
export class TechnicalAnalysis<HandleError extends boolean = boolean> {
|
|
3899
4038
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3900
4039
|
constructor(apiClient: JwtClient<HandleError>);
|
|
3901
4040
|
/**
|
|
3902
|
-
* @description
|
|
3903
|
-
* @tags
|
|
3904
|
-
* @name
|
|
3905
|
-
* @summary Get
|
|
3906
|
-
* @request GET:/
|
|
4041
|
+
* @description This endpoint provides the `cumulative technical analysis score` for a stock, calculated based on multiple technical indicators. It also includes the stock’s `ranking within its universe`, percentile placement, and whether it falls into a `Bullish`, `Neutral`, or `Bearish` category.
|
|
4042
|
+
* @tags Technical Analysis
|
|
4043
|
+
* @name GetCompanyTechnicalAnalysis
|
|
4044
|
+
* @summary Get Company Technical Analysis
|
|
4045
|
+
* @request GET:/companies/{company_id}/technical-analysis
|
|
3907
4046
|
* @secure
|
|
3908
4047
|
*/
|
|
3909
|
-
|
|
4048
|
+
getCompanyTechnicalAnalysis(companyId: number, query?: {
|
|
4049
|
+
/**
|
|
4050
|
+
* Language
|
|
4051
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4052
|
+
* @default "en-US"
|
|
4053
|
+
*/
|
|
4054
|
+
language?: BridgeWiseLanguageEnum;
|
|
3910
4055
|
/**
|
|
3911
4056
|
* Trading Item Id
|
|
3912
4057
|
* Specify a BW trading asset identifier for a targeted query.
|
|
3913
4058
|
*/
|
|
3914
|
-
trading_item_id?: number
|
|
4059
|
+
trading_item_id?: number;
|
|
4060
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTechAnalysisItem, HandleError>>;
|
|
4061
|
+
/**
|
|
4062
|
+
* @description This endpoint generates a natural language explanation of the technical analysis results, providing users with actionable insights about the stock’s momentum, trends, and key levels. The narrative is dynamically generated based on the latest indicator values.
|
|
4063
|
+
* @tags Technical Analysis
|
|
4064
|
+
* @name GetCompanyTechnicalParagraphs
|
|
4065
|
+
* @summary Get Company Technical Paragraphs
|
|
4066
|
+
* @request GET:/companies/{company_id}/technical-paragraphs
|
|
4067
|
+
* @secure
|
|
4068
|
+
*/
|
|
4069
|
+
getCompanyTechnicalParagraphs(companyId: number, query?: {
|
|
3915
4070
|
/**
|
|
3916
|
-
*
|
|
3917
|
-
*
|
|
4071
|
+
* Language
|
|
4072
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4073
|
+
* @default "en-US"
|
|
3918
4074
|
*/
|
|
3919
|
-
|
|
4075
|
+
language?: BridgeWiseLanguageEnum;
|
|
3920
4076
|
/**
|
|
3921
|
-
*
|
|
3922
|
-
* Specify
|
|
4077
|
+
* Trading Item Id
|
|
4078
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
3923
4079
|
*/
|
|
3924
|
-
|
|
3925
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4080
|
+
trading_item_id?: number;
|
|
4081
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechnicalParagraphList, HandleError>>;
|
|
3926
4082
|
/**
|
|
3927
|
-
* @description
|
|
3928
|
-
* @tags
|
|
3929
|
-
* @name
|
|
3930
|
-
* @summary Get
|
|
3931
|
-
* @request GET:/
|
|
4083
|
+
* @description This endpoint retrieves detailed technical indicator values such as `5DMA`, `50DMA`, `200DMA`, `MACD`, `RSI`, `STOCH`, `resistance`, `support`, `low`, and `high` stock price. Each parameter is accompanied by a sentiment classification (`Positive`, `Neutral`, or `Negative`) and a description of its significance.
|
|
4084
|
+
* @tags Technical Analysis
|
|
4085
|
+
* @name GetCompanyTechnicalParameters
|
|
4086
|
+
* @summary Get Company Technical Parameters
|
|
4087
|
+
* @request GET:/companies/{company_id}/technical-parameters
|
|
3932
4088
|
* @secure
|
|
3933
4089
|
*/
|
|
3934
|
-
|
|
4090
|
+
getCompanyTechnicalParameters(companyId: number, query?: {
|
|
4091
|
+
/**
|
|
4092
|
+
* Language
|
|
4093
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4094
|
+
* @default "en-US"
|
|
4095
|
+
*/
|
|
4096
|
+
language?: BridgeWiseLanguageEnum;
|
|
3935
4097
|
/**
|
|
3936
4098
|
* Trading Item Id
|
|
3937
4099
|
* Specify a BW trading asset identifier for a targeted query.
|
|
3938
4100
|
*/
|
|
3939
|
-
trading_item_id?: number
|
|
4101
|
+
trading_item_id?: number;
|
|
3940
4102
|
/**
|
|
3941
|
-
*
|
|
3942
|
-
*
|
|
4103
|
+
* Parameter Id
|
|
4104
|
+
* Get desired parameter by ID.
|
|
3943
4105
|
*/
|
|
3944
|
-
|
|
3945
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
3946
|
-
}
|
|
3947
|
-
export class Users<HandleError extends boolean = boolean> {
|
|
3948
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3949
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3950
|
-
/**
|
|
3951
|
-
* @tags Users
|
|
3952
|
-
* @name Authenticate
|
|
3953
|
-
* @summary Authenticate
|
|
3954
|
-
* @request POST:/users/authenticate
|
|
3955
|
-
* @secure
|
|
3956
|
-
*/
|
|
3957
|
-
authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
|
|
3958
|
-
/**
|
|
3959
|
-
* @tags Users
|
|
3960
|
-
* @name FetchClientDetails
|
|
3961
|
-
* @summary Fetch Client Details
|
|
3962
|
-
* @request GET:/users/machine
|
|
3963
|
-
* @secure
|
|
3964
|
-
*/
|
|
3965
|
-
fetchClientDetails(headers: {
|
|
3966
|
-
/** Authorization */
|
|
3967
|
-
authorization: string;
|
|
3968
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
|
|
4106
|
+
parameter_id?: number;
|
|
4107
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechParameterItemList, HandleError>>;
|
|
3969
4108
|
}
|
|
3970
4109
|
export class Tenants<HandleError extends boolean = boolean> {
|
|
3971
4110
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -4143,6 +4282,29 @@ export class Tenants<HandleError extends boolean = boolean> {
|
|
|
4143
4282
|
*/
|
|
4144
4283
|
deleteTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
4145
4284
|
}
|
|
4285
|
+
export class Users<HandleError extends boolean = boolean> {
|
|
4286
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4287
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4288
|
+
/**
|
|
4289
|
+
* @tags Users
|
|
4290
|
+
* @name Authenticate
|
|
4291
|
+
* @summary Authenticate
|
|
4292
|
+
* @request POST:/users/authenticate
|
|
4293
|
+
* @secure
|
|
4294
|
+
*/
|
|
4295
|
+
authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
|
|
4296
|
+
/**
|
|
4297
|
+
* @tags Users
|
|
4298
|
+
* @name FetchClientDetails
|
|
4299
|
+
* @summary Fetch Client Details
|
|
4300
|
+
* @request GET:/users/machine
|
|
4301
|
+
* @secure
|
|
4302
|
+
*/
|
|
4303
|
+
fetchClientDetails(headers: {
|
|
4304
|
+
/** Authorization */
|
|
4305
|
+
authorization: string;
|
|
4306
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
|
|
4307
|
+
}
|
|
4146
4308
|
export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
4147
4309
|
readonly config: JwtClientConfig<HandleError>;
|
|
4148
4310
|
activities: Activities<HandleError>;
|