@orbis-systems/orbis-api-clients 0.7.2 → 0.7.4
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 +223 -51
- 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 +659 -538
- 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 +1039 -1018
- 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 +107 -107
- 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 +4105 -4062
- 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 +638 -638
- 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 +811 -811
- package/dist/zerohash/index.d.ts.map +1 -1
- package/dist/zerohash/index.esm.js +1 -1
- package/dist/zerohash/index.esm.js.map +1 -1
- package/dist/zerohash/index.js +1 -1
- package/dist/zerohash/index.js.map +1 -1
- package/package.json +1 -1
|
@@ -604,6 +604,39 @@ export enum BridgeWiseCompositionTypeEnum {
|
|
|
604
604
|
Stocks = "stocks",
|
|
605
605
|
Others = "others"
|
|
606
606
|
}
|
|
607
|
+
/** ConsensusRatingsList */
|
|
608
|
+
export type BridgeWiseConsensusRatingsList = BridgeWiseConsensusRatingsResponse[];
|
|
609
|
+
/** ConsensusRatingsResponse */
|
|
610
|
+
export interface BridgeWiseConsensusRatingsResponse {
|
|
611
|
+
/**
|
|
612
|
+
* Language
|
|
613
|
+
* @default "en-US"
|
|
614
|
+
*/
|
|
615
|
+
language?: string;
|
|
616
|
+
/** Date */
|
|
617
|
+
date: string;
|
|
618
|
+
/**
|
|
619
|
+
* Updated At
|
|
620
|
+
* @format date-time
|
|
621
|
+
*/
|
|
622
|
+
updated_at: string;
|
|
623
|
+
/** Trading Item Id */
|
|
624
|
+
trading_item_id: number;
|
|
625
|
+
/** Security Id */
|
|
626
|
+
security_id: number;
|
|
627
|
+
/** Company Id */
|
|
628
|
+
company_id: number;
|
|
629
|
+
/** Analysts Consensus Name */
|
|
630
|
+
analysts_consensus_name: string;
|
|
631
|
+
/** Analysts Consensus Score Type */
|
|
632
|
+
analysts_consensus_score_type: string;
|
|
633
|
+
/** Analysts Consensus Rating Analyst Count */
|
|
634
|
+
analysts_consensus_rating_analyst_count: number;
|
|
635
|
+
/** Analysts Consensus Rating Score Group */
|
|
636
|
+
analysts_consensus_rating_score_group: number;
|
|
637
|
+
/** Analysts Consensus Rating Score Group Text */
|
|
638
|
+
analysts_consensus_rating_score_group_text: string;
|
|
639
|
+
}
|
|
607
640
|
/** FundHoldingsList */
|
|
608
641
|
export type BridgeWiseFundHoldingsList = BridgeWiseHoldingItem[];
|
|
609
642
|
/** FundsCompositionItem */
|
|
@@ -702,12 +735,6 @@ export interface BridgeWiseHoldingsStatisticsItem {
|
|
|
702
735
|
/** Fund Analysis Score Group Text */
|
|
703
736
|
fund_analysis_score_group_text: string | null;
|
|
704
737
|
}
|
|
705
|
-
/** IdentifierTypeEnum */
|
|
706
|
-
export enum BridgeWiseIdentifierTypeEnum {
|
|
707
|
-
TickerExchange = "ticker_exchange",
|
|
708
|
-
Isin = "isin",
|
|
709
|
-
Custom = "custom"
|
|
710
|
-
}
|
|
711
738
|
/** ImageExtensionEnum */
|
|
712
739
|
export enum BridgeWiseImageExtensionEnum {
|
|
713
740
|
Png = "png",
|
|
@@ -1443,6 +1470,42 @@ export enum BridgeWiseAnalysisTypeEnum {
|
|
|
1443
1470
|
}
|
|
1444
1471
|
/** CompanyTechAnalysisResponse */
|
|
1445
1472
|
export type BridgeWiseCompanyTechAnalysisResponse = BridgeWiseTechAnalysisItem;
|
|
1473
|
+
/** EsgFundsAnalysis */
|
|
1474
|
+
export interface BridgeWiseEsgFundsAnalysis {
|
|
1475
|
+
/**
|
|
1476
|
+
* Language
|
|
1477
|
+
* @default "en-US"
|
|
1478
|
+
*/
|
|
1479
|
+
language?: string;
|
|
1480
|
+
/** Updated At */
|
|
1481
|
+
updated_at: string;
|
|
1482
|
+
/** Analysis Score */
|
|
1483
|
+
analysis_score: number;
|
|
1484
|
+
/** Year */
|
|
1485
|
+
year: number;
|
|
1486
|
+
/** Month */
|
|
1487
|
+
month: number;
|
|
1488
|
+
/** Analysis Rank In Sector */
|
|
1489
|
+
analysis_rank_in_sector: number;
|
|
1490
|
+
/** Analysis Score Group Text */
|
|
1491
|
+
analysis_score_group_text: string | number;
|
|
1492
|
+
/** Analysis Score Group */
|
|
1493
|
+
analysis_score_group: string | number;
|
|
1494
|
+
/** Pct From Aum */
|
|
1495
|
+
pct_from_aum?: number | null;
|
|
1496
|
+
/** Analysis Percentile */
|
|
1497
|
+
analysis_percentile: number;
|
|
1498
|
+
/** Analysis Rank */
|
|
1499
|
+
analysis_rank: number;
|
|
1500
|
+
/** Analysis Percentile Of Sector */
|
|
1501
|
+
analysis_percentile_of_sector: number;
|
|
1502
|
+
/** Total Funds In Sector */
|
|
1503
|
+
total_funds_in_sector: number;
|
|
1504
|
+
/** Analysis Score Sector Median */
|
|
1505
|
+
analysis_score_sector_median: number;
|
|
1506
|
+
/** Analysis Score Sector Avg */
|
|
1507
|
+
analysis_score_sector_avg: number;
|
|
1508
|
+
}
|
|
1446
1509
|
/** FundamentalAnalysisResponse */
|
|
1447
1510
|
export type BridgeWiseFundamentalAnalysisResponse = BridgeWiseFundamentalAnalysisResponseItem[];
|
|
1448
1511
|
/** FundamentalAnalysisResponseItem */
|
|
@@ -2051,133 +2114,6 @@ export enum BridgeWiseStockingFloatConfigOperatorEnum {
|
|
|
2051
2114
|
Gt = "gt",
|
|
2052
2115
|
Lt = "lt"
|
|
2053
2116
|
}
|
|
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
|
-
}
|
|
2181
2117
|
export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
2182
2118
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2183
2119
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -2789,7 +2725,7 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
|
2789
2725
|
language?: BridgeWiseLanguageEnum;
|
|
2790
2726
|
/**
|
|
2791
2727
|
* Include
|
|
2792
|
-
* Comma-separated list of additional resources to include in the response. Supported values: `fundamental_analysis`, `fundamental_section`, `target_price`, `market`, `fundamental_paragraph`, `fundamental_parameter`, `esg_analysis`, `esg_parameter`, `esg_section`, `esg_paragraph`, `alert`. Access to each resource is subject to the caller's permissions. Resource-specific filtering is supported using double underscore (`__`) syntax. For example, `fundamental_section__section_type=balance_sheet` retrieves only the balance sheet section. Details about available filters can be found under the corresponding resource documentation.
|
|
2728
|
+
* Comma-separated list of additional resources to include in the response. Supported values: `fundamental_analysis`, `fundamental_section`, `target_price`, `market`, `fundamental_paragraph`, `fundamental_parameter`, `esg_analysis`, `esg_parameter`, `esg_section`, `esg_paragraph`, `alert`, `technical_analysis`. Access to each resource is subject to the caller's permissions. Resource-specific filtering is supported using double underscore (`__`) syntax. For example, `fundamental_section__section_type=balance_sheet` retrieves only the balance sheet section. Details about available filters can be found under the corresponding resource documentation.
|
|
2793
2729
|
* @pattern ^-?[a-zA-Z_]+(?:,[a-zA-Z_]+)*$
|
|
2794
2730
|
*/
|
|
2795
2731
|
include?: string;
|
|
@@ -2816,100 +2752,155 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
|
2816
2752
|
/**
|
|
2817
2753
|
* Identifier Type
|
|
2818
2754
|
* Define the type of the external identifier provided.
|
|
2819
|
-
* e.g., ISIN, ticker-exchange.
|
|
2755
|
+
* e.g., ISIN, ticker-exchange. The field accepts either a single value or multiple comma-separated values. <br>Example: ticker_exchange, isin, custom, tase</br>
|
|
2756
|
+
* @pattern ^-?[a-zA-Z_]+(?:,[a-zA-Z_]+)*$
|
|
2820
2757
|
*/
|
|
2821
|
-
identifier_type:
|
|
2758
|
+
identifier_type: string;
|
|
2822
2759
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
|
|
2823
2760
|
}
|
|
2824
|
-
export class
|
|
2761
|
+
export class Logos<HandleError extends boolean = boolean> {
|
|
2825
2762
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2826
2763
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2827
2764
|
/**
|
|
2828
|
-
* @description
|
|
2829
|
-
* @tags
|
|
2830
|
-
* @name
|
|
2831
|
-
* @summary
|
|
2832
|
-
* @request GET:/companies/
|
|
2765
|
+
* @description Supports bulk operations by allowing users to retrieve logos for multiple specified companies using a list of company identifiers.
|
|
2766
|
+
* @tags Logos
|
|
2767
|
+
* @name FetchLogos
|
|
2768
|
+
* @summary Fetch Logos
|
|
2769
|
+
* @request GET:/companies/logos
|
|
2833
2770
|
* @secure
|
|
2834
2771
|
*/
|
|
2835
|
-
|
|
2836
|
-
/**
|
|
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))*$
|
|
2841
|
-
*/
|
|
2842
|
-
languages?: string;
|
|
2843
|
-
/**
|
|
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"
|
|
2848
|
-
*/
|
|
2849
|
-
published_date__gte?: string;
|
|
2850
|
-
/**
|
|
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"
|
|
2855
|
-
*/
|
|
2856
|
-
published_date__lte?: string;
|
|
2772
|
+
fetchLogos(query?: {
|
|
2857
2773
|
/**
|
|
2858
|
-
*
|
|
2859
|
-
* Specify
|
|
2860
|
-
* @
|
|
2774
|
+
* Company Id In
|
|
2775
|
+
* Specify a list of BW identifiers for bulk queries.
|
|
2776
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
2777
|
+
* @example "74822,83343211"
|
|
2861
2778
|
*/
|
|
2862
|
-
|
|
2779
|
+
company_id__in?: string;
|
|
2863
2780
|
/**
|
|
2864
2781
|
* Size
|
|
2865
|
-
*
|
|
2866
|
-
* @
|
|
2867
|
-
* @
|
|
2782
|
+
* Page size
|
|
2783
|
+
* @min 1
|
|
2784
|
+
* @max 100
|
|
2785
|
+
* @default 50
|
|
2868
2786
|
*/
|
|
2869
2787
|
size?: number;
|
|
2870
2788
|
/**
|
|
2871
2789
|
* Page
|
|
2872
|
-
*
|
|
2790
|
+
* Page number
|
|
2791
|
+
* @min 1
|
|
2873
2792
|
* @default 1
|
|
2874
|
-
* @example 1
|
|
2875
2793
|
*/
|
|
2876
2794
|
page?: number;
|
|
2877
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
2795
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
|
|
2878
2796
|
/**
|
|
2879
|
-
* @description
|
|
2880
|
-
* @tags
|
|
2881
|
-
* @name
|
|
2882
|
-
* @summary
|
|
2883
|
-
* @request GET:/companies/{company_id}/
|
|
2797
|
+
* @description Retrieves the logo for a specified company using the provided company_id.
|
|
2798
|
+
* @tags Logos
|
|
2799
|
+
* @name FetchLogo
|
|
2800
|
+
* @summary Fetch Logo
|
|
2801
|
+
* @request GET:/companies/{company_id}/logos
|
|
2884
2802
|
* @secure
|
|
2885
2803
|
*/
|
|
2886
|
-
|
|
2887
|
-
/**
|
|
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"
|
|
2892
|
-
*/
|
|
2893
|
-
published_date__gte?: string;
|
|
2894
|
-
/**
|
|
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"
|
|
2899
|
-
*/
|
|
2900
|
-
published_date__lte?: string;
|
|
2901
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
|
|
2804
|
+
fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
|
|
2902
2805
|
}
|
|
2903
|
-
export class
|
|
2806
|
+
export class Activities<HandleError extends boolean = boolean> {
|
|
2904
2807
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2905
2808
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2906
2809
|
/**
|
|
2907
|
-
* @description Provides
|
|
2908
|
-
* @tags
|
|
2909
|
-
* @name
|
|
2910
|
-
* @summary Get Company
|
|
2911
|
-
* @request GET:/companies/{company_id}/
|
|
2912
|
-
* @secure
|
|
2810
|
+
* @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.
|
|
2811
|
+
* @tags Activities
|
|
2812
|
+
* @name GetCompanyAlerts
|
|
2813
|
+
* @summary Get Company Alerts
|
|
2814
|
+
* @request GET:/companies/{company_id}/alerts
|
|
2815
|
+
* @secure
|
|
2816
|
+
*/
|
|
2817
|
+
getCompanyAlerts(companyId: number, query?: {
|
|
2818
|
+
/**
|
|
2819
|
+
* Language
|
|
2820
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2821
|
+
* @default "en-US"
|
|
2822
|
+
*/
|
|
2823
|
+
language?: BridgeWiseLanguageEnum;
|
|
2824
|
+
/**
|
|
2825
|
+
* Alert Type
|
|
2826
|
+
* Specify the group of the alert type that will be presented (fundamental or market).
|
|
2827
|
+
*/
|
|
2828
|
+
alert_type?: BridgeWiseCompanyAlertType;
|
|
2829
|
+
/**
|
|
2830
|
+
* Sentiment
|
|
2831
|
+
* Filter alerts by their sentiment.
|
|
2832
|
+
*/
|
|
2833
|
+
sentiment?: BridgeWiseCompanyAlertSentiment;
|
|
2834
|
+
/**
|
|
2835
|
+
* Importance
|
|
2836
|
+
* 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
|
|
2837
|
+
*/
|
|
2838
|
+
importance?: string | null;
|
|
2839
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyAlert[], HandleError>>;
|
|
2840
|
+
/**
|
|
2841
|
+
* @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.
|
|
2842
|
+
* @tags Activities
|
|
2843
|
+
* @name GetCompanyForecastsKeyDevelopment
|
|
2844
|
+
* @summary Get Company Forecasts Key Development
|
|
2845
|
+
* @request GET:/companies/{company_id}/key-developments
|
|
2846
|
+
* @secure
|
|
2847
|
+
*/
|
|
2848
|
+
getCompanyForecastsKeyDevelopment(companyId: number, query?: {
|
|
2849
|
+
/**
|
|
2850
|
+
* Language
|
|
2851
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2852
|
+
* @default "en-US"
|
|
2853
|
+
*/
|
|
2854
|
+
language?: BridgeWiseLanguageEnum;
|
|
2855
|
+
/**
|
|
2856
|
+
* Importance
|
|
2857
|
+
* 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
|
|
2858
|
+
* @default "0,1"
|
|
2859
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
2860
|
+
*/
|
|
2861
|
+
importance?: string;
|
|
2862
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecast[], HandleError>>;
|
|
2863
|
+
}
|
|
2864
|
+
export class ConsensusAnalysts<HandleError extends boolean = boolean> {
|
|
2865
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2866
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2867
|
+
/**
|
|
2868
|
+
* @description Provides for a sepcific comapny and trading items the consensus scores groups as number and text for the Consensus Rating, Consensus Accuracy, and Analysts Agreement.
|
|
2869
|
+
* @tags Consensus Analysts
|
|
2870
|
+
* @name GetConsensusRatings
|
|
2871
|
+
* @summary Get Consensus Ratings
|
|
2872
|
+
* @request GET:/companies/{company_id}/consensus-ratings
|
|
2873
|
+
* @secure
|
|
2874
|
+
*/
|
|
2875
|
+
getConsensusRatings(companyId: number, query?: {
|
|
2876
|
+
/**
|
|
2877
|
+
* Trading Item Id
|
|
2878
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
2879
|
+
*/
|
|
2880
|
+
trading_item_id?: number;
|
|
2881
|
+
/**
|
|
2882
|
+
* Language
|
|
2883
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2884
|
+
* @default "en-US"
|
|
2885
|
+
*/
|
|
2886
|
+
language?: BridgeWiseLanguageEnum;
|
|
2887
|
+
/**
|
|
2888
|
+
* Date Gte
|
|
2889
|
+
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
2890
|
+
*/
|
|
2891
|
+
date__gte?: string | null;
|
|
2892
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseConsensusRatingsList, HandleError>>;
|
|
2893
|
+
}
|
|
2894
|
+
export class EarningCalls<HandleError extends boolean = boolean> {
|
|
2895
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
2896
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
2897
|
+
/**
|
|
2898
|
+
* @description Provides the Guidance text of the company for the next quarter as described and summarized from the date specified earnings call. In addition, it provides a summary to allow earnings call data integration with the Bridget product.
|
|
2899
|
+
* @tags Earning Calls
|
|
2900
|
+
* @name GetCompanyEarningsCalls
|
|
2901
|
+
* @summary Get Company Earnings Calls
|
|
2902
|
+
* @request GET:/companies/{company_id}/earnings-call
|
|
2903
|
+
* @secure
|
|
2913
2904
|
*/
|
|
2914
2905
|
getCompanyEarningsCalls(companyId: number, query?: {
|
|
2915
2906
|
/**
|
|
@@ -3262,131 +3253,18 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
3262
3253
|
date__lte?: string;
|
|
3263
3254
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTargetPriceList, HandleError>>;
|
|
3264
3255
|
}
|
|
3265
|
-
export class
|
|
3266
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3267
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3268
|
-
/**
|
|
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
|
|
3274
|
-
* @secure
|
|
3275
|
-
*/
|
|
3276
|
-
getFundAnalysis(fundId: number, query?: {
|
|
3277
|
-
/**
|
|
3278
|
-
* Language
|
|
3279
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3280
|
-
* @default "en-US"
|
|
3281
|
-
*/
|
|
3282
|
-
language?: BridgeWiseLanguageEnum;
|
|
3283
|
-
/**
|
|
3284
|
-
* Year
|
|
3285
|
-
* Specify the year for which the analysis is requested.
|
|
3286
|
-
*/
|
|
3287
|
-
year?: number;
|
|
3288
|
-
/**
|
|
3289
|
-
* Quarter
|
|
3290
|
-
* Specify the quarter for which the analysis is requested.
|
|
3291
|
-
*/
|
|
3292
|
-
quarter?: number;
|
|
3293
|
-
/**
|
|
3294
|
-
* Show All
|
|
3295
|
-
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
3296
|
-
*/
|
|
3297
|
-
show_all?: boolean;
|
|
3298
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsAnalysisItem[], HandleError>>;
|
|
3299
|
-
/**
|
|
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
|
|
3305
|
-
* @secure
|
|
3306
|
-
*/
|
|
3307
|
-
getFundsParagraphs(fundId: number, query?: {
|
|
3308
|
-
/**
|
|
3309
|
-
* Language
|
|
3310
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3311
|
-
* @default "en-US"
|
|
3312
|
-
*/
|
|
3313
|
-
language?: BridgeWiseLanguageEnum;
|
|
3314
|
-
/**
|
|
3315
|
-
* Year
|
|
3316
|
-
* Specify the year for which the analysis is requested.
|
|
3317
|
-
*/
|
|
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>>;
|
|
3325
|
-
/**
|
|
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
|
|
3331
|
-
* @secure
|
|
3332
|
-
*/
|
|
3333
|
-
getFundParameters(fundId: number, query?: {
|
|
3334
|
-
/**
|
|
3335
|
-
* Language
|
|
3336
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3337
|
-
* @default "en-US"
|
|
3338
|
-
*/
|
|
3339
|
-
language?: BridgeWiseLanguageEnum;
|
|
3340
|
-
/**
|
|
3341
|
-
* Parameter Id
|
|
3342
|
-
* ID of the parameter for analysis.
|
|
3343
|
-
*/
|
|
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?: {
|
|
3355
|
-
/**
|
|
3356
|
-
* Year
|
|
3357
|
-
* Specify the year for which the analysis is requested.
|
|
3358
|
-
*/
|
|
3359
|
-
year?: number;
|
|
3360
|
-
/**
|
|
3361
|
-
* Quarter
|
|
3362
|
-
* Specify the quarter for which the analysis is requested.
|
|
3363
|
-
*/
|
|
3364
|
-
quarter?: number;
|
|
3365
|
-
/**
|
|
3366
|
-
* Language
|
|
3367
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3368
|
-
* @default "en-US"
|
|
3369
|
-
*/
|
|
3370
|
-
language?: BridgeWiseLanguageEnum;
|
|
3371
|
-
/**
|
|
3372
|
-
* Show All
|
|
3373
|
-
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
3374
|
-
*/
|
|
3375
|
-
show_all?: boolean;
|
|
3376
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
|
|
3377
|
-
}
|
|
3378
|
-
export class FundMarketData<HandleError extends boolean = boolean> {
|
|
3256
|
+
export class CompanyMarketData<HandleError extends boolean = boolean> {
|
|
3379
3257
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3380
3258
|
constructor(apiClient: JwtClient<HandleError>);
|
|
3381
3259
|
/**
|
|
3382
|
-
* @description Offers key market data for the specified
|
|
3383
|
-
* @tags
|
|
3384
|
-
* @name
|
|
3385
|
-
* @summary Get
|
|
3386
|
-
* @request GET:/
|
|
3260
|
+
* @description Offers key market data for the specified company, including daily high, open, low, close prices, and market capitalization.
|
|
3261
|
+
* @tags Company Market Data
|
|
3262
|
+
* @name GetCompanyMarketData
|
|
3263
|
+
* @summary Get Company Market Data
|
|
3264
|
+
* @request GET:/companies/{company_id}/market
|
|
3387
3265
|
* @secure
|
|
3388
3266
|
*/
|
|
3389
|
-
|
|
3267
|
+
getCompanyMarketData(companyId: number, query?: {
|
|
3390
3268
|
/**
|
|
3391
3269
|
* Trading Item Id
|
|
3392
3270
|
* Specify a BW trading asset identifier for a targeted query.
|
|
@@ -3402,16 +3280,16 @@ export class FundMarketData<HandleError extends boolean = boolean> {
|
|
|
3402
3280
|
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
3403
3281
|
*/
|
|
3404
3282
|
date__le?: string | null;
|
|
3405
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
3283
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketDataList, HandleError>>;
|
|
3406
3284
|
/**
|
|
3407
|
-
* @description Provides detailed market statistics for the specified
|
|
3408
|
-
* @tags
|
|
3409
|
-
* @name
|
|
3410
|
-
* @summary Get
|
|
3411
|
-
* @request GET:/
|
|
3285
|
+
* @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.
|
|
3286
|
+
* @tags Company Market Data
|
|
3287
|
+
* @name GetCompanyMarketStatistics
|
|
3288
|
+
* @summary Get Company Market Statistics
|
|
3289
|
+
* @request GET:/companies/{company_id}/market-statistics
|
|
3412
3290
|
* @secure
|
|
3413
3291
|
*/
|
|
3414
|
-
|
|
3292
|
+
getCompanyMarketStatistics(companyId: number, query?: {
|
|
3415
3293
|
/**
|
|
3416
3294
|
* Trading Item Id
|
|
3417
3295
|
* Specify a BW trading asset identifier for a targeted query.
|
|
@@ -3422,31 +3300,227 @@ export class FundMarketData<HandleError extends boolean = boolean> {
|
|
|
3422
3300
|
* Specify a list of external identifiers.
|
|
3423
3301
|
*/
|
|
3424
3302
|
identifier__in?: string | null;
|
|
3425
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
3426
|
-
}
|
|
3427
|
-
export class FundMetadata<HandleError extends boolean = boolean> {
|
|
3428
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3429
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3303
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticsDataList, HandleError>>;
|
|
3430
3304
|
/**
|
|
3431
|
-
* @description
|
|
3432
|
-
* @tags
|
|
3433
|
-
* @name
|
|
3434
|
-
* @summary Get
|
|
3435
|
-
* @request GET:/
|
|
3305
|
+
* @description Returns detailed information on trading items related to the specified company, focusing exclusively on stocks.
|
|
3306
|
+
* @tags Company Market Data
|
|
3307
|
+
* @name GetTradingItems
|
|
3308
|
+
* @summary Get Trading Items
|
|
3309
|
+
* @request GET:/companies/{company_id}/trading-items
|
|
3436
3310
|
* @secure
|
|
3437
3311
|
*/
|
|
3438
|
-
|
|
3312
|
+
getTradingItems(companyId: number, query?: {
|
|
3439
3313
|
/**
|
|
3440
|
-
*
|
|
3441
|
-
*
|
|
3314
|
+
* Primary Flag
|
|
3315
|
+
* Boolean flag. Indicate if only primary trading item data is required (true/false).
|
|
3442
3316
|
*/
|
|
3443
|
-
|
|
3317
|
+
primary_flag?: BridgeWiseStringBooleanEnum;
|
|
3444
3318
|
/**
|
|
3445
|
-
*
|
|
3446
|
-
*
|
|
3319
|
+
* Security Primary Flag
|
|
3320
|
+
* Boolean flag. Indicate if only primary asset data is required (true/false).
|
|
3447
3321
|
*/
|
|
3448
|
-
|
|
3449
|
-
|
|
3322
|
+
security_primary_flag?: BridgeWiseStringBooleanEnum;
|
|
3323
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
|
|
3324
|
+
}
|
|
3325
|
+
export class CompanyNews<HandleError extends boolean = boolean> {
|
|
3326
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3327
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3328
|
+
/**
|
|
3329
|
+
* @description This endpoint provides news articles related to the specified company.
|
|
3330
|
+
* @tags Company News
|
|
3331
|
+
* @name GetCompanyNews
|
|
3332
|
+
* @summary Get Company News
|
|
3333
|
+
* @request GET:/companies/{company_id}/news
|
|
3334
|
+
* @secure
|
|
3335
|
+
*/
|
|
3336
|
+
getCompanyNews(companyId: number, query?: {
|
|
3337
|
+
/**
|
|
3338
|
+
* Languages
|
|
3339
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3340
|
+
* @default "en-US"
|
|
3341
|
+
* @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))*$
|
|
3342
|
+
*/
|
|
3343
|
+
languages?: string;
|
|
3344
|
+
/**
|
|
3345
|
+
* Published Date Gte
|
|
3346
|
+
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
3347
|
+
* @format date
|
|
3348
|
+
* @default "2025-04-09"
|
|
3349
|
+
*/
|
|
3350
|
+
published_date__gte?: string;
|
|
3351
|
+
/**
|
|
3352
|
+
* Published Date Lte
|
|
3353
|
+
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
3354
|
+
* @format date
|
|
3355
|
+
* @default "2025-04-09"
|
|
3356
|
+
*/
|
|
3357
|
+
published_date__lte?: string;
|
|
3358
|
+
/**
|
|
3359
|
+
* Sort By
|
|
3360
|
+
* Specify the field by which to sort the results.
|
|
3361
|
+
* @default "publication_date"
|
|
3362
|
+
*/
|
|
3363
|
+
sort_by?: BridgeWiseCompanyNewsSortingEnum;
|
|
3364
|
+
/**
|
|
3365
|
+
* Size
|
|
3366
|
+
* Define the number of records per page for pagination purposes.
|
|
3367
|
+
* @default 10
|
|
3368
|
+
* @example 10
|
|
3369
|
+
*/
|
|
3370
|
+
size?: number;
|
|
3371
|
+
/**
|
|
3372
|
+
* Page
|
|
3373
|
+
* Define the page number for pagination.
|
|
3374
|
+
* @default 1
|
|
3375
|
+
* @example 1
|
|
3376
|
+
*/
|
|
3377
|
+
page?: number;
|
|
3378
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseCompanyNews, HandleError>>;
|
|
3379
|
+
/**
|
|
3380
|
+
* @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.
|
|
3381
|
+
* @tags Company News
|
|
3382
|
+
* @name GetAverageCompanyNewsSentiment
|
|
3383
|
+
* @summary Get Average Company News Sentiment
|
|
3384
|
+
* @request GET:/companies/{company_id}/news-sentiment
|
|
3385
|
+
* @secure
|
|
3386
|
+
*/
|
|
3387
|
+
getAverageCompanyNewsSentiment(companyId: number, query?: {
|
|
3388
|
+
/**
|
|
3389
|
+
* Published Date Gte
|
|
3390
|
+
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
3391
|
+
* @format date
|
|
3392
|
+
* @default "2025-04-09"
|
|
3393
|
+
*/
|
|
3394
|
+
published_date__gte?: string;
|
|
3395
|
+
/**
|
|
3396
|
+
* Published Date Lte
|
|
3397
|
+
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
3398
|
+
* @format date
|
|
3399
|
+
* @default "2025-04-09"
|
|
3400
|
+
*/
|
|
3401
|
+
published_date__lte?: string;
|
|
3402
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
|
|
3403
|
+
}
|
|
3404
|
+
export class TechnicalAnalysis<HandleError extends boolean = boolean> {
|
|
3405
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3406
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3407
|
+
/**
|
|
3408
|
+
* @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.
|
|
3409
|
+
* @tags Technical Analysis
|
|
3410
|
+
* @name GetCompanyTechnicalAnalysis
|
|
3411
|
+
* @summary Get Company Technical Analysis
|
|
3412
|
+
* @request GET:/companies/{company_id}/technical-analysis
|
|
3413
|
+
* @secure
|
|
3414
|
+
*/
|
|
3415
|
+
getCompanyTechnicalAnalysis(companyId: number, query?: {
|
|
3416
|
+
/**
|
|
3417
|
+
* Language
|
|
3418
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3419
|
+
* @default "en-US"
|
|
3420
|
+
*/
|
|
3421
|
+
language?: BridgeWiseLanguageEnum;
|
|
3422
|
+
/**
|
|
3423
|
+
* Trading Item Id
|
|
3424
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
3425
|
+
*/
|
|
3426
|
+
trading_item_id?: number;
|
|
3427
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTechAnalysisItem, HandleError>>;
|
|
3428
|
+
/**
|
|
3429
|
+
* @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.
|
|
3430
|
+
* @tags Technical Analysis
|
|
3431
|
+
* @name GetCompanyTechnicalParagraphs
|
|
3432
|
+
* @summary Get Company Technical Paragraphs
|
|
3433
|
+
* @request GET:/companies/{company_id}/technical-paragraphs
|
|
3434
|
+
* @secure
|
|
3435
|
+
*/
|
|
3436
|
+
getCompanyTechnicalParagraphs(companyId: number, query?: {
|
|
3437
|
+
/**
|
|
3438
|
+
* Language
|
|
3439
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3440
|
+
* @default "en-US"
|
|
3441
|
+
*/
|
|
3442
|
+
language?: BridgeWiseLanguageEnum;
|
|
3443
|
+
/**
|
|
3444
|
+
* Trading Item Id
|
|
3445
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
3446
|
+
*/
|
|
3447
|
+
trading_item_id?: number;
|
|
3448
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechnicalParagraphList, HandleError>>;
|
|
3449
|
+
/**
|
|
3450
|
+
* @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.
|
|
3451
|
+
* @tags Technical Analysis
|
|
3452
|
+
* @name GetCompanyTechnicalParameters
|
|
3453
|
+
* @summary Get Company Technical Parameters
|
|
3454
|
+
* @request GET:/companies/{company_id}/technical-parameters
|
|
3455
|
+
* @secure
|
|
3456
|
+
*/
|
|
3457
|
+
getCompanyTechnicalParameters(companyId: number, query?: {
|
|
3458
|
+
/**
|
|
3459
|
+
* Language
|
|
3460
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3461
|
+
* @default "en-US"
|
|
3462
|
+
*/
|
|
3463
|
+
language?: BridgeWiseLanguageEnum;
|
|
3464
|
+
/**
|
|
3465
|
+
* Trading Item Id
|
|
3466
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
3467
|
+
*/
|
|
3468
|
+
trading_item_id?: number;
|
|
3469
|
+
/**
|
|
3470
|
+
* Parameter Id
|
|
3471
|
+
* Get desired parameter by ID.
|
|
3472
|
+
*/
|
|
3473
|
+
parameter_id?: number;
|
|
3474
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechParameterItemList, HandleError>>;
|
|
3475
|
+
}
|
|
3476
|
+
export class Metadata<HandleError extends boolean = boolean> {
|
|
3477
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3478
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3479
|
+
/**
|
|
3480
|
+
* @description This endpoint provides filters
|
|
3481
|
+
* @tags Metadata
|
|
3482
|
+
* @name GetCompanyFilters
|
|
3483
|
+
* @summary Get Company Filters
|
|
3484
|
+
* @request GET:/filters
|
|
3485
|
+
* @secure
|
|
3486
|
+
*/
|
|
3487
|
+
getCompanyFilters(query: {
|
|
3488
|
+
/**
|
|
3489
|
+
* Type
|
|
3490
|
+
* Desired filter type.
|
|
3491
|
+
*/
|
|
3492
|
+
type: BridgeWiseCompanyFilterType;
|
|
3493
|
+
/**
|
|
3494
|
+
* Language
|
|
3495
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3496
|
+
* @default "en-US"
|
|
3497
|
+
*/
|
|
3498
|
+
language?: BridgeWiseLanguageEnum;
|
|
3499
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyFilterResponse[], HandleError>>;
|
|
3500
|
+
}
|
|
3501
|
+
export class FundMetadata<HandleError extends boolean = boolean> {
|
|
3502
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3503
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3504
|
+
/**
|
|
3505
|
+
* @description Allows users to search and filter investment funds based on various financial and non-financial criteria. Returns a comprehensive list of funds that meet the specified filters, providing detailed information on each fund's characteristics.
|
|
3506
|
+
* @tags Fund Metadata
|
|
3507
|
+
* @name GetFunds
|
|
3508
|
+
* @summary Get Funds
|
|
3509
|
+
* @request GET:/funds
|
|
3510
|
+
* @secure
|
|
3511
|
+
*/
|
|
3512
|
+
getFunds(query?: {
|
|
3513
|
+
/**
|
|
3514
|
+
* Search
|
|
3515
|
+
* Funds search.
|
|
3516
|
+
*/
|
|
3517
|
+
search?: string;
|
|
3518
|
+
/**
|
|
3519
|
+
* Peers Of
|
|
3520
|
+
* Get peers funds of a specific fund.
|
|
3521
|
+
*/
|
|
3522
|
+
peers_of?: number;
|
|
3523
|
+
/**
|
|
3450
3524
|
* Sort By
|
|
3451
3525
|
* Comma-separated string of sorting keys with optional ascending or descending (-) indicators. <br>Example: -beta_1y,pct_of_equity_holdings</br>
|
|
3452
3526
|
*/
|
|
@@ -3815,18 +3889,18 @@ export class FundMetadata<HandleError extends boolean = boolean> {
|
|
|
3815
3889
|
language?: BridgeWiseLanguageEnum;
|
|
3816
3890
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMetadataList, HandleError>>;
|
|
3817
3891
|
}
|
|
3818
|
-
export class
|
|
3892
|
+
export class FundAnalysis<HandleError extends boolean = boolean> {
|
|
3819
3893
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3820
3894
|
constructor(apiClient: JwtClient<HandleError>);
|
|
3821
3895
|
/**
|
|
3822
|
-
* @description
|
|
3823
|
-
* @tags
|
|
3824
|
-
* @name
|
|
3825
|
-
* @summary Get
|
|
3826
|
-
* @request GET:/funds/{fund_id}/
|
|
3896
|
+
* @description Returns Bridgewise final analysis for a specified fund.
|
|
3897
|
+
* @tags Fund Analysis
|
|
3898
|
+
* @name GetFundAnalysis
|
|
3899
|
+
* @summary Get Fund Analysis
|
|
3900
|
+
* @request GET:/funds/{fund_id}/analysis
|
|
3827
3901
|
* @secure
|
|
3828
3902
|
*/
|
|
3829
|
-
|
|
3903
|
+
getFundAnalysis(fundId: number, query?: {
|
|
3830
3904
|
/**
|
|
3831
3905
|
* Language
|
|
3832
3906
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -3834,20 +3908,30 @@ export class Holdings<HandleError extends boolean = boolean> {
|
|
|
3834
3908
|
*/
|
|
3835
3909
|
language?: BridgeWiseLanguageEnum;
|
|
3836
3910
|
/**
|
|
3837
|
-
*
|
|
3838
|
-
*
|
|
3911
|
+
* Year
|
|
3912
|
+
* Specify the year for which the analysis is requested.
|
|
3839
3913
|
*/
|
|
3840
|
-
|
|
3841
|
-
|
|
3914
|
+
year?: number;
|
|
3915
|
+
/**
|
|
3916
|
+
* Quarter
|
|
3917
|
+
* Specify the quarter for which the analysis is requested.
|
|
3918
|
+
*/
|
|
3919
|
+
quarter?: number;
|
|
3920
|
+
/**
|
|
3921
|
+
* Show All
|
|
3922
|
+
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
3923
|
+
*/
|
|
3924
|
+
show_all?: boolean;
|
|
3925
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsAnalysisItem[], HandleError>>;
|
|
3842
3926
|
/**
|
|
3843
|
-
* @description
|
|
3844
|
-
* @tags
|
|
3845
|
-
* @name
|
|
3846
|
-
* @summary Get
|
|
3847
|
-
* @request GET:/funds/{fund_id}/
|
|
3927
|
+
* @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.
|
|
3928
|
+
* @tags Fund Analysis
|
|
3929
|
+
* @name GetFundsParagraphs
|
|
3930
|
+
* @summary Get Funds Paragraphs
|
|
3931
|
+
* @request GET:/funds/{fund_id}/paragraphs
|
|
3848
3932
|
* @secure
|
|
3849
3933
|
*/
|
|
3850
|
-
|
|
3934
|
+
getFundsParagraphs(fundId: number, query?: {
|
|
3851
3935
|
/**
|
|
3852
3936
|
* Language
|
|
3853
3937
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -3855,33 +3939,25 @@ export class Holdings<HandleError extends boolean = boolean> {
|
|
|
3855
3939
|
*/
|
|
3856
3940
|
language?: BridgeWiseLanguageEnum;
|
|
3857
3941
|
/**
|
|
3858
|
-
*
|
|
3859
|
-
*
|
|
3860
|
-
* @default "stocks"
|
|
3942
|
+
* Year
|
|
3943
|
+
* Specify the year for which the analysis is requested.
|
|
3861
3944
|
*/
|
|
3862
|
-
|
|
3945
|
+
year?: number | null;
|
|
3863
3946
|
/**
|
|
3864
|
-
*
|
|
3865
|
-
*
|
|
3866
|
-
* @exclusiveMin 0
|
|
3867
|
-
*/
|
|
3868
|
-
page?: number;
|
|
3869
|
-
/**
|
|
3870
|
-
* Page Size
|
|
3871
|
-
* Define the number of records per page for pagination purposes.
|
|
3872
|
-
* @exclusiveMin 0
|
|
3947
|
+
* Quarter
|
|
3948
|
+
* Specify the quarter for which the analysis is requested.
|
|
3873
3949
|
*/
|
|
3874
|
-
|
|
3875
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
3950
|
+
quarter?: number | null;
|
|
3951
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParagraph[], HandleError>>;
|
|
3876
3952
|
/**
|
|
3877
|
-
* @description
|
|
3878
|
-
* @tags
|
|
3879
|
-
* @name
|
|
3880
|
-
* @summary Get
|
|
3881
|
-
* @request GET:/funds/{fund_id}/
|
|
3953
|
+
* @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.
|
|
3954
|
+
* @tags Fund Analysis
|
|
3955
|
+
* @name GetFundParameters
|
|
3956
|
+
* @summary Get Fund Parameters
|
|
3957
|
+
* @request GET:/funds/{fund_id}/parameters
|
|
3882
3958
|
* @secure
|
|
3883
3959
|
*/
|
|
3884
|
-
|
|
3960
|
+
getFundParameters(fundId: number, query?: {
|
|
3885
3961
|
/**
|
|
3886
3962
|
* Language
|
|
3887
3963
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -3889,107 +3965,76 @@ export class Holdings<HandleError extends boolean = boolean> {
|
|
|
3889
3965
|
*/
|
|
3890
3966
|
language?: BridgeWiseLanguageEnum;
|
|
3891
3967
|
/**
|
|
3892
|
-
*
|
|
3893
|
-
*
|
|
3894
|
-
* @default "stocks"
|
|
3895
|
-
*/
|
|
3896
|
-
composition_type?: BridgeWiseCompositionTypeEnum;
|
|
3897
|
-
/**
|
|
3898
|
-
* Page
|
|
3899
|
-
* Define the page number for pagination.
|
|
3900
|
-
* @exclusiveMin 0
|
|
3901
|
-
*/
|
|
3902
|
-
page?: number;
|
|
3903
|
-
/**
|
|
3904
|
-
* Page Size
|
|
3905
|
-
* Define the number of records per page for pagination purposes.
|
|
3906
|
-
* @exclusiveMin 0
|
|
3968
|
+
* Parameter Id
|
|
3969
|
+
* ID of the parameter for analysis.
|
|
3907
3970
|
*/
|
|
3908
|
-
|
|
3909
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
3910
|
-
}
|
|
3911
|
-
export class Logos<HandleError extends boolean = boolean> {
|
|
3912
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3913
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3971
|
+
parameter_id?: number;
|
|
3972
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParametersItemList, HandleError>>;
|
|
3914
3973
|
/**
|
|
3915
|
-
* @description
|
|
3916
|
-
* @tags
|
|
3917
|
-
* @name
|
|
3918
|
-
* @summary
|
|
3919
|
-
* @request GET:/
|
|
3974
|
+
* @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.
|
|
3975
|
+
* @tags Fund Analysis
|
|
3976
|
+
* @name GetFundSections
|
|
3977
|
+
* @summary Get Fund Sections
|
|
3978
|
+
* @request GET:/funds/{fund_id}/sections
|
|
3920
3979
|
* @secure
|
|
3921
3980
|
*/
|
|
3922
|
-
|
|
3981
|
+
getFundSections(fundId: number, query?: {
|
|
3923
3982
|
/**
|
|
3924
|
-
*
|
|
3925
|
-
* Specify
|
|
3926
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
3927
|
-
* @example "74822,83343211"
|
|
3983
|
+
* Year
|
|
3984
|
+
* Specify the year for which the analysis is requested.
|
|
3928
3985
|
*/
|
|
3929
|
-
|
|
3986
|
+
year?: number;
|
|
3930
3987
|
/**
|
|
3931
|
-
*
|
|
3932
|
-
*
|
|
3933
|
-
* @min 1
|
|
3934
|
-
* @max 100
|
|
3935
|
-
* @default 50
|
|
3988
|
+
* Quarter
|
|
3989
|
+
* Specify the quarter for which the analysis is requested.
|
|
3936
3990
|
*/
|
|
3937
|
-
|
|
3991
|
+
quarter?: number;
|
|
3938
3992
|
/**
|
|
3939
|
-
*
|
|
3940
|
-
*
|
|
3941
|
-
* @
|
|
3942
|
-
* @default 1
|
|
3993
|
+
* Language
|
|
3994
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3995
|
+
* @default "en-US"
|
|
3943
3996
|
*/
|
|
3944
|
-
|
|
3945
|
-
|
|
3946
|
-
|
|
3947
|
-
|
|
3948
|
-
|
|
3949
|
-
|
|
3950
|
-
|
|
3951
|
-
* @request GET:/companies/{company_id}/logos
|
|
3952
|
-
* @secure
|
|
3953
|
-
*/
|
|
3954
|
-
fetchLogo(companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseLogo, HandleError>>;
|
|
3997
|
+
language?: BridgeWiseLanguageEnum;
|
|
3998
|
+
/**
|
|
3999
|
+
* Show All
|
|
4000
|
+
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
4001
|
+
*/
|
|
4002
|
+
show_all?: boolean;
|
|
4003
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
|
|
3955
4004
|
}
|
|
3956
|
-
export class
|
|
4005
|
+
export class Holdings<HandleError extends boolean = boolean> {
|
|
3957
4006
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3958
4007
|
constructor(apiClient: JwtClient<HandleError>);
|
|
3959
4008
|
/**
|
|
3960
|
-
* @description
|
|
3961
|
-
* @tags
|
|
3962
|
-
* @name
|
|
3963
|
-
* @summary Get
|
|
3964
|
-
* @request GET:/
|
|
4009
|
+
* @description Details the asset allocation within the specified fund, including the distribution between stocks and other asset types, offering insights into the fund's investment strategy.
|
|
4010
|
+
* @tags Holdings
|
|
4011
|
+
* @name GetCompositions
|
|
4012
|
+
* @summary Get Compositions
|
|
4013
|
+
* @request GET:/funds/{fund_id}/compositions
|
|
3965
4014
|
* @secure
|
|
3966
4015
|
*/
|
|
3967
|
-
|
|
3968
|
-
/**
|
|
3969
|
-
* Type
|
|
3970
|
-
* Desired filter type.
|
|
3971
|
-
*/
|
|
3972
|
-
type: BridgeWiseCompanyFilterType;
|
|
4016
|
+
getCompositions(fundId: number, query?: {
|
|
3973
4017
|
/**
|
|
3974
4018
|
* Language
|
|
3975
4019
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3976
4020
|
* @default "en-US"
|
|
3977
4021
|
*/
|
|
3978
4022
|
language?: BridgeWiseLanguageEnum;
|
|
3979
|
-
|
|
3980
|
-
|
|
3981
|
-
|
|
3982
|
-
|
|
3983
|
-
|
|
4023
|
+
/**
|
|
4024
|
+
* Composition Type
|
|
4025
|
+
* Filter data by specific components of the fund composition (e.g., stocks, others).
|
|
4026
|
+
*/
|
|
4027
|
+
composition_type?: BridgeWiseCompositionTypeEnum;
|
|
4028
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsCompositionList, HandleError>>;
|
|
3984
4029
|
/**
|
|
3985
|
-
* @description
|
|
3986
|
-
* @tags
|
|
3987
|
-
* @name
|
|
3988
|
-
* @summary Get
|
|
3989
|
-
* @request GET:/funds/{fund_id}/
|
|
4030
|
+
* @description Offers a distribution overview of Bridgewise recommendations for the holdings within the specified fund.
|
|
4031
|
+
* @tags Holdings
|
|
4032
|
+
* @name GetHoldingStatistics
|
|
4033
|
+
* @summary Get Holding Statistics
|
|
4034
|
+
* @request GET:/funds/{fund_id}/holding-statistics
|
|
3990
4035
|
* @secure
|
|
3991
4036
|
*/
|
|
3992
|
-
|
|
4037
|
+
getHoldingStatistics(fundId: number, query?: {
|
|
3993
4038
|
/**
|
|
3994
4039
|
* Language
|
|
3995
4040
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -3997,30 +4042,33 @@ export class Segmentations<HandleError extends boolean = boolean> {
|
|
|
3997
4042
|
*/
|
|
3998
4043
|
language?: BridgeWiseLanguageEnum;
|
|
3999
4044
|
/**
|
|
4000
|
-
*
|
|
4001
|
-
* Filter data by specific
|
|
4045
|
+
* Composition Type
|
|
4046
|
+
* Filter data by specific components of the fund composition (e.g., stocks, others).
|
|
4047
|
+
* @default "stocks"
|
|
4002
4048
|
*/
|
|
4003
|
-
|
|
4049
|
+
composition_type?: BridgeWiseCompositionTypeEnum;
|
|
4004
4050
|
/**
|
|
4005
|
-
*
|
|
4006
|
-
*
|
|
4051
|
+
* Page
|
|
4052
|
+
* Define the page number for pagination.
|
|
4053
|
+
* @exclusiveMin 0
|
|
4007
4054
|
*/
|
|
4008
|
-
|
|
4055
|
+
page?: number;
|
|
4009
4056
|
/**
|
|
4010
|
-
*
|
|
4011
|
-
*
|
|
4057
|
+
* Page Size
|
|
4058
|
+
* Define the number of records per page for pagination purposes.
|
|
4059
|
+
* @exclusiveMin 0
|
|
4012
4060
|
*/
|
|
4013
|
-
|
|
4014
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4061
|
+
page_size?: number;
|
|
4062
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseHoldingsStatisticsItem[], HandleError>>;
|
|
4015
4063
|
/**
|
|
4016
|
-
* @description
|
|
4017
|
-
* @tags
|
|
4018
|
-
* @name
|
|
4019
|
-
* @summary Get
|
|
4020
|
-
* @request GET:/funds/{fund_id}/
|
|
4064
|
+
* @description Provides a detailed list of holdings within the specified fund. Each object in the list includes pertinent information such as holding name, ticker, allocation percentage, and key financial metrics.
|
|
4065
|
+
* @tags Holdings
|
|
4066
|
+
* @name GetHoldings
|
|
4067
|
+
* @summary Get Holdings
|
|
4068
|
+
* @request GET:/funds/{fund_id}/holdings
|
|
4021
4069
|
* @secure
|
|
4022
4070
|
*/
|
|
4023
|
-
|
|
4071
|
+
getHoldings(fundId: number, query?: {
|
|
4024
4072
|
/**
|
|
4025
4073
|
* Language
|
|
4026
4074
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -4028,83 +4076,121 @@ export class Segmentations<HandleError extends boolean = boolean> {
|
|
|
4028
4076
|
*/
|
|
4029
4077
|
language?: BridgeWiseLanguageEnum;
|
|
4030
4078
|
/**
|
|
4031
|
-
*
|
|
4032
|
-
* Filter data by specific
|
|
4079
|
+
* Composition Type
|
|
4080
|
+
* Filter data by specific components of the fund composition (e.g., stocks, others).
|
|
4081
|
+
* @default "stocks"
|
|
4033
4082
|
*/
|
|
4034
|
-
|
|
4035
|
-
|
|
4083
|
+
composition_type?: BridgeWiseCompositionTypeEnum;
|
|
4084
|
+
/**
|
|
4085
|
+
* Page
|
|
4086
|
+
* Define the page number for pagination.
|
|
4087
|
+
* @exclusiveMin 0
|
|
4088
|
+
*/
|
|
4089
|
+
page?: number;
|
|
4090
|
+
/**
|
|
4091
|
+
* Page Size
|
|
4092
|
+
* Define the number of records per page for pagination purposes.
|
|
4093
|
+
* @exclusiveMin 0
|
|
4094
|
+
*/
|
|
4095
|
+
page_size?: number;
|
|
4096
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
|
|
4036
4097
|
}
|
|
4037
|
-
export class
|
|
4098
|
+
export class FundEsgAnalysis<HandleError extends boolean = boolean> {
|
|
4038
4099
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4039
4100
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4040
4101
|
/**
|
|
4041
|
-
* @description
|
|
4042
|
-
* @tags
|
|
4043
|
-
* @name
|
|
4044
|
-
* @summary Get
|
|
4045
|
-
* @request GET:/
|
|
4102
|
+
* @description Provide the user all the minimum required data for the fund ESG score.
|
|
4103
|
+
* @tags Fund ESG Analysis
|
|
4104
|
+
* @name GetFundEsgAnalysis
|
|
4105
|
+
* @summary Get Fund Esg Analysis
|
|
4106
|
+
* @request GET:/funds/{fund_id}/esg-analysis
|
|
4046
4107
|
* @secure
|
|
4047
4108
|
*/
|
|
4048
|
-
|
|
4109
|
+
getFundEsgAnalysis(fundId: number, query?: {
|
|
4110
|
+
/**
|
|
4111
|
+
* Limit
|
|
4112
|
+
* Number of historical periods to be returned (default is 1).
|
|
4113
|
+
*/
|
|
4114
|
+
limit?: number;
|
|
4049
4115
|
/**
|
|
4050
4116
|
* Language
|
|
4051
4117
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4052
4118
|
* @default "en-US"
|
|
4053
4119
|
*/
|
|
4054
4120
|
language?: BridgeWiseLanguageEnum;
|
|
4121
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEsgFundsAnalysis[], HandleError>>;
|
|
4122
|
+
}
|
|
4123
|
+
export class FundMarketData<HandleError extends boolean = boolean> {
|
|
4124
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4125
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4126
|
+
/**
|
|
4127
|
+
* @description Offers key market data for the specified fund, including daily high, open, low, close values, and market capitalization.
|
|
4128
|
+
* @tags Fund Market Data
|
|
4129
|
+
* @name GetFundsMarketData
|
|
4130
|
+
* @summary Get Funds Market Data
|
|
4131
|
+
* @request GET:/funds/{fund_id}/market
|
|
4132
|
+
* @secure
|
|
4133
|
+
*/
|
|
4134
|
+
getFundsMarketData(fundId: number, query?: {
|
|
4055
4135
|
/**
|
|
4056
4136
|
* Trading Item Id
|
|
4057
4137
|
* Specify a BW trading asset identifier for a targeted query.
|
|
4058
4138
|
*/
|
|
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?: {
|
|
4139
|
+
trading_item_id?: number | null;
|
|
4070
4140
|
/**
|
|
4071
|
-
*
|
|
4072
|
-
*
|
|
4073
|
-
* @default "en-US"
|
|
4141
|
+
* Date Ge
|
|
4142
|
+
* Specify the minimum date for data retrieval in YYYY-MM-DD format.
|
|
4074
4143
|
*/
|
|
4075
|
-
|
|
4144
|
+
date__ge?: string | null;
|
|
4076
4145
|
/**
|
|
4077
|
-
*
|
|
4078
|
-
* Specify
|
|
4146
|
+
* Date Le
|
|
4147
|
+
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
4079
4148
|
*/
|
|
4080
|
-
|
|
4081
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4149
|
+
date__le?: string | null;
|
|
4150
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
|
|
4082
4151
|
/**
|
|
4083
|
-
* @description
|
|
4084
|
-
* @tags
|
|
4085
|
-
* @name
|
|
4086
|
-
* @summary Get
|
|
4087
|
-
* @request GET:/
|
|
4152
|
+
* @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.
|
|
4153
|
+
* @tags Fund Market Data
|
|
4154
|
+
* @name GetFundsMarketStatistics
|
|
4155
|
+
* @summary Get Funds Market Statistics
|
|
4156
|
+
* @request GET:/funds/{fund_id}/market-statistics
|
|
4088
4157
|
* @secure
|
|
4089
4158
|
*/
|
|
4090
|
-
|
|
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;
|
|
4159
|
+
getFundsMarketStatistics(fundId: number, query?: {
|
|
4097
4160
|
/**
|
|
4098
4161
|
* Trading Item Id
|
|
4099
4162
|
* Specify a BW trading asset identifier for a targeted query.
|
|
4100
4163
|
*/
|
|
4101
|
-
trading_item_id?: number;
|
|
4164
|
+
trading_item_id?: number | null;
|
|
4102
4165
|
/**
|
|
4103
|
-
*
|
|
4104
|
-
*
|
|
4166
|
+
* Identifier In
|
|
4167
|
+
* Specify a list of external identifiers.
|
|
4105
4168
|
*/
|
|
4106
|
-
|
|
4107
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
4169
|
+
identifier__in?: string | null;
|
|
4170
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
|
|
4171
|
+
}
|
|
4172
|
+
export class Users<HandleError extends boolean = boolean> {
|
|
4173
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4174
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4175
|
+
/**
|
|
4176
|
+
* @tags Users
|
|
4177
|
+
* @name Authenticate
|
|
4178
|
+
* @summary Authenticate
|
|
4179
|
+
* @request POST:/users/authenticate
|
|
4180
|
+
* @secure
|
|
4181
|
+
*/
|
|
4182
|
+
authenticate(data: BridgeWiseMachineAuthRequest | BridgeWiseUserAuthRequest, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineAuthResponse | BridgeWiseUserAuthResponse, HandleError>>;
|
|
4183
|
+
/**
|
|
4184
|
+
* @tags Users
|
|
4185
|
+
* @name FetchClientDetails
|
|
4186
|
+
* @summary Fetch Client Details
|
|
4187
|
+
* @request GET:/users/machine
|
|
4188
|
+
* @secure
|
|
4189
|
+
*/
|
|
4190
|
+
fetchClientDetails(headers: {
|
|
4191
|
+
/** Authorization */
|
|
4192
|
+
authorization: string;
|
|
4193
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError>>;
|
|
4108
4194
|
}
|
|
4109
4195
|
export class Tenants<HandleError extends boolean = boolean> {
|
|
4110
4196
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -4282,28 +4368,61 @@ export class Tenants<HandleError extends boolean = boolean> {
|
|
|
4282
4368
|
*/
|
|
4283
4369
|
deleteTenantRecommendationsConfig(tenantId: string, companyId: number, config?: RequestConfig<HandleError>): Promise<ClientResponse<Record<string, string>, HandleError>>;
|
|
4284
4370
|
}
|
|
4285
|
-
export class
|
|
4371
|
+
export class Segmentations<HandleError extends boolean = boolean> {
|
|
4286
4372
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4287
4373
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4288
4374
|
/**
|
|
4289
|
-
* @
|
|
4290
|
-
* @
|
|
4291
|
-
* @
|
|
4292
|
-
* @
|
|
4375
|
+
* @description Provides key financial metrics for each segment within the specified fund, such as weighted averages of P/E ratio, P/B ratio, P/S ratio, Net Debt to EBITDA, Revenue Growth Rate, and Relative Market Value. It also includes the Weighted Average Segment Strength based on Bridgewise scores.
|
|
4376
|
+
* @tags Segmentations
|
|
4377
|
+
* @name GetSegmentParameters
|
|
4378
|
+
* @summary Get Segment Parameters
|
|
4379
|
+
* @request GET:/funds/{fund_id}/segment-parameters
|
|
4293
4380
|
* @secure
|
|
4294
4381
|
*/
|
|
4295
|
-
|
|
4382
|
+
getSegmentParameters(fundId: number, query?: {
|
|
4383
|
+
/**
|
|
4384
|
+
* Language
|
|
4385
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4386
|
+
* @default "en-US"
|
|
4387
|
+
*/
|
|
4388
|
+
language?: BridgeWiseLanguageEnum;
|
|
4389
|
+
/**
|
|
4390
|
+
* Segment
|
|
4391
|
+
* Filter data by specific segments within the fund holdings (e.g., sector, region).
|
|
4392
|
+
*/
|
|
4393
|
+
segment?: string;
|
|
4394
|
+
/**
|
|
4395
|
+
* Segment Type
|
|
4396
|
+
* Filter data by specific segment type within the fund holdings (e.g., energy, health_care).
|
|
4397
|
+
*/
|
|
4398
|
+
segment_type?: string;
|
|
4399
|
+
/**
|
|
4400
|
+
* Parameter Type
|
|
4401
|
+
* Desired segment parameter type.
|
|
4402
|
+
*/
|
|
4403
|
+
parameter_type?: BridgeWiseFundsSegmentParameterEnum;
|
|
4404
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSegmentParametersItem[], HandleError>>;
|
|
4296
4405
|
/**
|
|
4297
|
-
* @
|
|
4298
|
-
* @
|
|
4299
|
-
* @
|
|
4300
|
-
* @
|
|
4406
|
+
* @description Returns detailed weightings for different segments within the specified fund, including allocation percentages across various asset classes such as sectors, industries, regions and countries.
|
|
4407
|
+
* @tags Segmentations
|
|
4408
|
+
* @name GetSegment
|
|
4409
|
+
* @summary Get Segment
|
|
4410
|
+
* @request GET:/funds/{fund_id}/segments
|
|
4301
4411
|
* @secure
|
|
4302
4412
|
*/
|
|
4303
|
-
|
|
4304
|
-
/**
|
|
4305
|
-
|
|
4306
|
-
|
|
4413
|
+
getSegment(fundId: number, query?: {
|
|
4414
|
+
/**
|
|
4415
|
+
* Language
|
|
4416
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4417
|
+
* @default "en-US"
|
|
4418
|
+
*/
|
|
4419
|
+
language?: BridgeWiseLanguageEnum;
|
|
4420
|
+
/**
|
|
4421
|
+
* Segment
|
|
4422
|
+
* Filter data by specific segments within the fund holdings (e.g., sector, region).
|
|
4423
|
+
*/
|
|
4424
|
+
segment?: string;
|
|
4425
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
|
|
4307
4426
|
}
|
|
4308
4427
|
export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<HandleError, JwtClient<HandleError>> {
|
|
4309
4428
|
readonly config: JwtClientConfig<HandleError>;
|
|
@@ -4311,10 +4430,12 @@ export class BridgeWiseApi<HandleError extends boolean = false> extends BaseApi<
|
|
|
4311
4430
|
companyMarketData: CompanyMarketData<HandleError>;
|
|
4312
4431
|
companyMetadata: CompanyMetadata<HandleError>;
|
|
4313
4432
|
companyNews: CompanyNews<HandleError>;
|
|
4433
|
+
consensusAnalysts: ConsensusAnalysts<HandleError>;
|
|
4314
4434
|
earningCalls: EarningCalls<HandleError>;
|
|
4315
4435
|
esgAnalysis: EsgAnalysis<HandleError>;
|
|
4316
4436
|
fundamentalAnalysis: FundamentalAnalysis<HandleError>;
|
|
4317
4437
|
fundAnalysis: FundAnalysis<HandleError>;
|
|
4438
|
+
fundEsgAnalysis: FundEsgAnalysis<HandleError>;
|
|
4318
4439
|
fundMarketData: FundMarketData<HandleError>;
|
|
4319
4440
|
fundMetadata: FundMetadata<HandleError>;
|
|
4320
4441
|
holdings: Holdings<HandleError>;
|