@orbis-systems/orbis-api-clients 0.6.11 → 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 +96 -72
- 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 +485 -484
- 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 +943 -943
- package/dist/insight/index.d.ts.map +1 -1
- package/dist/insight/index.esm.js +1 -1
- package/dist/insight/index.esm.js.map +1 -1
- package/dist/insight/index.js +1 -1
- package/dist/insight/index.js.map +1 -1
- package/dist/middleware/index.d.ts +73 -73
- package/dist/middleware/index.d.ts.map +1 -1
- package/dist/middleware/index.esm.js +1 -1
- package/dist/middleware/index.esm.js.map +1 -1
- package/dist/middleware/index.js +1 -1
- package/dist/middleware/index.js.map +1 -1
- package/dist/orbis/index.d.ts +4024 -4024
- package/dist/orbis/index.d.ts.map +1 -1
- package/dist/orbis/index.esm.js +1 -1
- package/dist/orbis/index.esm.js.map +1 -1
- package/dist/orbis/index.js +1 -1
- package/dist/orbis/index.js.map +1 -1
- package/dist/uma/index.d.ts +618 -612
- 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 {
|
|
@@ -2050,6 +2051,133 @@ export enum BridgeWiseStockingFloatConfigOperatorEnum {
|
|
|
2050
2051
|
Gt = "gt",
|
|
2051
2052
|
Lt = "lt"
|
|
2052
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
|
+
}
|
|
2053
2181
|
export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
2054
2182
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2055
2183
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -2693,63 +2821,97 @@ export class CompanyMetadata<HandleError extends boolean = boolean> {
|
|
|
2693
2821
|
identifier_type: BridgeWiseIdentifierTypeEnum;
|
|
2694
2822
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
|
|
2695
2823
|
}
|
|
2696
|
-
export class
|
|
2824
|
+
export class CompanyNews<HandleError extends boolean = boolean> {
|
|
2697
2825
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2698
2826
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2699
2827
|
/**
|
|
2700
|
-
* @description
|
|
2701
|
-
* @tags
|
|
2702
|
-
* @name
|
|
2703
|
-
* @summary
|
|
2704
|
-
* @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
|
|
2705
2833
|
* @secure
|
|
2706
2834
|
*/
|
|
2707
|
-
|
|
2835
|
+
getCompanyNews(companyId: number, query?: {
|
|
2708
2836
|
/**
|
|
2709
|
-
*
|
|
2710
|
-
*
|
|
2711
|
-
* @
|
|
2712
|
-
* @
|
|
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))*$
|
|
2713
2841
|
*/
|
|
2714
|
-
|
|
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;
|
|
2857
|
+
/**
|
|
2858
|
+
* Sort By
|
|
2859
|
+
* Specify the field by which to sort the results.
|
|
2860
|
+
* @default "publication_date"
|
|
2861
|
+
*/
|
|
2862
|
+
sort_by?: BridgeWiseCompanyNewsSortingEnum;
|
|
2715
2863
|
/**
|
|
2716
2864
|
* Size
|
|
2717
|
-
*
|
|
2718
|
-
* @
|
|
2719
|
-
* @
|
|
2720
|
-
* @default 50
|
|
2865
|
+
* Define the number of records per page for pagination purposes.
|
|
2866
|
+
* @default 10
|
|
2867
|
+
* @example 10
|
|
2721
2868
|
*/
|
|
2722
2869
|
size?: number;
|
|
2723
2870
|
/**
|
|
2724
2871
|
* Page
|
|
2725
|
-
*
|
|
2726
|
-
* @min 1
|
|
2872
|
+
* Define the page number for pagination.
|
|
2727
2873
|
* @default 1
|
|
2874
|
+
* @example 1
|
|
2728
2875
|
*/
|
|
2729
2876
|
page?: number;
|
|
2730
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
2877
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseCompanyNews, HandleError>>;
|
|
2731
2878
|
/**
|
|
2732
|
-
* @description
|
|
2733
|
-
* @tags
|
|
2734
|
-
* @name
|
|
2735
|
-
* @summary
|
|
2736
|
-
* @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
|
|
2737
2884
|
* @secure
|
|
2738
2885
|
*/
|
|
2739
|
-
|
|
2886
|
+
getAverageCompanyNewsSentiment(companyId: number, query?: {
|
|
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>>;
|
|
2740
2902
|
}
|
|
2741
|
-
export class
|
|
2903
|
+
export class EarningCalls<HandleError extends boolean = boolean> {
|
|
2742
2904
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
2743
2905
|
constructor(apiClient: JwtClient<HandleError>);
|
|
2744
2906
|
/**
|
|
2745
|
-
* @description Provides
|
|
2746
|
-
* @tags
|
|
2747
|
-
* @name
|
|
2748
|
-
* @summary Get Company
|
|
2749
|
-
* @request GET:/companies/{company_id}/
|
|
2907
|
+
* @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.
|
|
2908
|
+
* @tags Earning Calls
|
|
2909
|
+
* @name GetCompanyEarningsCalls
|
|
2910
|
+
* @summary Get Company Earnings Calls
|
|
2911
|
+
* @request GET:/companies/{company_id}/earnings-call
|
|
2750
2912
|
* @secure
|
|
2751
2913
|
*/
|
|
2752
|
-
|
|
2914
|
+
getCompanyEarningsCalls(companyId: number, query?: {
|
|
2753
2915
|
/**
|
|
2754
2916
|
* Language
|
|
2755
2917
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
@@ -2757,80 +2919,22 @@ export class Activities<HandleError extends boolean = boolean> {
|
|
|
2757
2919
|
*/
|
|
2758
2920
|
language?: BridgeWiseLanguageEnum;
|
|
2759
2921
|
/**
|
|
2760
|
-
*
|
|
2761
|
-
* Specify the
|
|
2762
|
-
*/
|
|
2763
|
-
alert_type?: BridgeWiseCompanyAlertType;
|
|
2764
|
-
/**
|
|
2765
|
-
* Sentiment
|
|
2766
|
-
* Filter alerts by their sentiment.
|
|
2922
|
+
* Year
|
|
2923
|
+
* Specify the year for which the analysis is requested.
|
|
2767
2924
|
*/
|
|
2768
|
-
|
|
2925
|
+
year?: number | null;
|
|
2769
2926
|
/**
|
|
2770
|
-
*
|
|
2771
|
-
*
|
|
2927
|
+
* Quarter
|
|
2928
|
+
* Specify the quarter for which the analysis is requested.
|
|
2772
2929
|
*/
|
|
2773
|
-
|
|
2774
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
2930
|
+
quarter?: number | null;
|
|
2931
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEarningsCallResponse[], HandleError>>;
|
|
2775
2932
|
/**
|
|
2776
|
-
* @description Provides
|
|
2777
|
-
* @tags
|
|
2778
|
-
* @name
|
|
2779
|
-
* @summary Get
|
|
2780
|
-
* @request GET:/companies/{company_id}/
|
|
2781
|
-
* @secure
|
|
2782
|
-
*/
|
|
2783
|
-
getCompanyForecastsKeyDevelopment(companyId: number, query?: {
|
|
2784
|
-
/**
|
|
2785
|
-
* Language
|
|
2786
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2787
|
-
* @default "en-US"
|
|
2788
|
-
*/
|
|
2789
|
-
language?: BridgeWiseLanguageEnum;
|
|
2790
|
-
/**
|
|
2791
|
-
* Importance
|
|
2792
|
-
* 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
|
|
2793
|
-
* @default "0,1"
|
|
2794
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
2795
|
-
*/
|
|
2796
|
-
importance?: string;
|
|
2797
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseForecast[], HandleError>>;
|
|
2798
|
-
}
|
|
2799
|
-
export class EarningCalls<HandleError extends boolean = boolean> {
|
|
2800
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
2801
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
2802
|
-
/**
|
|
2803
|
-
* @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.
|
|
2804
|
-
* @tags Earning Calls
|
|
2805
|
-
* @name GetCompanyEarningsCalls
|
|
2806
|
-
* @summary Get Company Earnings Calls
|
|
2807
|
-
* @request GET:/companies/{company_id}/earnings-call
|
|
2808
|
-
* @secure
|
|
2809
|
-
*/
|
|
2810
|
-
getCompanyEarningsCalls(companyId: number, query?: {
|
|
2811
|
-
/**
|
|
2812
|
-
* Language
|
|
2813
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
2814
|
-
* @default "en-US"
|
|
2815
|
-
*/
|
|
2816
|
-
language?: BridgeWiseLanguageEnum;
|
|
2817
|
-
/**
|
|
2818
|
-
* Year
|
|
2819
|
-
* Specify the year for which the analysis is requested.
|
|
2820
|
-
*/
|
|
2821
|
-
year?: number | null;
|
|
2822
|
-
/**
|
|
2823
|
-
* Quarter
|
|
2824
|
-
* Specify the quarter for which the analysis is requested.
|
|
2825
|
-
*/
|
|
2826
|
-
quarter?: number | null;
|
|
2827
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseEarningsCallResponse[], HandleError>>;
|
|
2828
|
-
/**
|
|
2829
|
-
* @description Provides the highlights and lowlights of the company summarized from the earning call date specified.
|
|
2830
|
-
* @tags Earning Calls
|
|
2831
|
-
* @name GetEarningsCallsRecaps
|
|
2832
|
-
* @summary Get Earnings Calls Recaps
|
|
2833
|
-
* @request GET:/companies/{company_id}/earnings-call/{year_quarter}/recaps
|
|
2933
|
+
* @description Provides the highlights and lowlights of the company summarized from the earning call date specified.
|
|
2934
|
+
* @tags Earning Calls
|
|
2935
|
+
* @name GetEarningsCallsRecaps
|
|
2936
|
+
* @summary Get Earnings Calls Recaps
|
|
2937
|
+
* @request GET:/companies/{company_id}/earnings-call/{year_quarter}/recaps
|
|
2834
2938
|
* @secure
|
|
2835
2939
|
*/
|
|
2836
2940
|
getEarningsCallsRecaps(yearQuarter: string, companyId: number, query?: {
|
|
@@ -3158,18 +3262,131 @@ export class FundamentalAnalysis<HandleError extends boolean = boolean> {
|
|
|
3158
3262
|
date__lte?: string;
|
|
3159
3263
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTargetPriceList, HandleError>>;
|
|
3160
3264
|
}
|
|
3161
|
-
export class
|
|
3265
|
+
export class FundAnalysis<HandleError extends boolean = boolean> {
|
|
3162
3266
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3163
3267
|
constructor(apiClient: JwtClient<HandleError>);
|
|
3164
3268
|
/**
|
|
3165
|
-
* @description
|
|
3166
|
-
* @tags
|
|
3167
|
-
* @name
|
|
3168
|
-
* @summary Get
|
|
3169
|
-
* @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
|
|
3170
3274
|
* @secure
|
|
3171
3275
|
*/
|
|
3172
|
-
|
|
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> {
|
|
3379
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3380
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3381
|
+
/**
|
|
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
|
|
3387
|
+
* @secure
|
|
3388
|
+
*/
|
|
3389
|
+
getFundsMarketData(fundId: number, query?: {
|
|
3173
3390
|
/**
|
|
3174
3391
|
* Trading Item Id
|
|
3175
3392
|
* Specify a BW trading asset identifier for a targeted query.
|
|
@@ -3185,16 +3402,16 @@ export class CompanyMarketData<HandleError extends boolean = boolean> {
|
|
|
3185
3402
|
* Specify the maximum date for data retrieval in YYYY-MM-DD format.
|
|
3186
3403
|
*/
|
|
3187
3404
|
date__le?: string | null;
|
|
3188
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
3405
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketList, HandleError>>;
|
|
3189
3406
|
/**
|
|
3190
|
-
* @description Provides detailed market statistics for the specified
|
|
3191
|
-
* @tags
|
|
3192
|
-
* @name
|
|
3193
|
-
* @summary Get
|
|
3194
|
-
* @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
|
|
3195
3412
|
* @secure
|
|
3196
3413
|
*/
|
|
3197
|
-
|
|
3414
|
+
getFundsMarketStatistics(fundId: number, query?: {
|
|
3198
3415
|
/**
|
|
3199
3416
|
* Trading Item Id
|
|
3200
3417
|
* Specify a BW trading asset identifier for a targeted query.
|
|
@@ -3205,243 +3422,47 @@ export class CompanyMarketData<HandleError extends boolean = boolean> {
|
|
|
3205
3422
|
* Specify a list of external identifiers.
|
|
3206
3423
|
*/
|
|
3207
3424
|
identifier__in?: string | null;
|
|
3208
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
3425
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMarketStatisticDataList, HandleError>>;
|
|
3426
|
+
}
|
|
3427
|
+
export class FundMetadata<HandleError extends boolean = boolean> {
|
|
3428
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
3429
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
3209
3430
|
/**
|
|
3210
|
-
* @description
|
|
3211
|
-
* @tags
|
|
3212
|
-
* @name
|
|
3213
|
-
* @summary Get
|
|
3214
|
-
* @request GET:/
|
|
3431
|
+
* @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.
|
|
3432
|
+
* @tags Fund Metadata
|
|
3433
|
+
* @name GetFunds
|
|
3434
|
+
* @summary Get Funds
|
|
3435
|
+
* @request GET:/funds
|
|
3215
3436
|
* @secure
|
|
3216
3437
|
*/
|
|
3217
|
-
|
|
3438
|
+
getFunds(query?: {
|
|
3218
3439
|
/**
|
|
3219
|
-
*
|
|
3220
|
-
*
|
|
3440
|
+
* Search
|
|
3441
|
+
* Funds search.
|
|
3221
3442
|
*/
|
|
3222
|
-
|
|
3443
|
+
search?: string;
|
|
3223
3444
|
/**
|
|
3224
|
-
*
|
|
3225
|
-
*
|
|
3445
|
+
* Peers Of
|
|
3446
|
+
* Get peers funds of a specific fund.
|
|
3226
3447
|
*/
|
|
3227
|
-
|
|
3228
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTradingItemsList, HandleError>>;
|
|
3229
|
-
}
|
|
3230
|
-
export class CompanyNews<HandleError extends boolean = boolean> {
|
|
3231
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3232
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3233
|
-
/**
|
|
3234
|
-
* @description This endpoint provides news articles related to the specified company.
|
|
3235
|
-
* @tags Company News
|
|
3236
|
-
* @name GetCompanyNews
|
|
3237
|
-
* @summary Get Company News
|
|
3238
|
-
* @request GET:/companies/{company_id}/news
|
|
3239
|
-
* @secure
|
|
3240
|
-
*/
|
|
3241
|
-
getCompanyNews(companyId: number, query?: {
|
|
3448
|
+
peers_of?: number;
|
|
3242
3449
|
/**
|
|
3243
|
-
*
|
|
3450
|
+
* Sort By
|
|
3451
|
+
* Comma-separated string of sorting keys with optional ascending or descending (-) indicators. <br>Example: -beta_1y,pct_of_equity_holdings</br>
|
|
3452
|
+
*/
|
|
3453
|
+
sort_by?: string;
|
|
3454
|
+
/**
|
|
3455
|
+
* Language
|
|
3244
3456
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3245
3457
|
* @default "en-US"
|
|
3246
|
-
* @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))*$
|
|
3247
3458
|
*/
|
|
3248
|
-
|
|
3459
|
+
language?: BridgeWiseLanguageEnum;
|
|
3249
3460
|
/**
|
|
3250
|
-
*
|
|
3251
|
-
*
|
|
3252
|
-
* @
|
|
3253
|
-
* @default "2025-04-09"
|
|
3461
|
+
* Sponsor Id
|
|
3462
|
+
* Comma-separated unique sponsor identifiers. <br>Example: 58101467,316442135</br>
|
|
3463
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
3254
3464
|
*/
|
|
3255
|
-
|
|
3256
|
-
/**
|
|
3257
|
-
* Published Date Lte
|
|
3258
|
-
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
3259
|
-
* @format date
|
|
3260
|
-
* @default "2025-04-09"
|
|
3261
|
-
*/
|
|
3262
|
-
published_date__lte?: string;
|
|
3263
|
-
/**
|
|
3264
|
-
* Sort By
|
|
3265
|
-
* Specify the field by which to sort the results.
|
|
3266
|
-
* @default "publication_date"
|
|
3267
|
-
*/
|
|
3268
|
-
sort_by?: BridgeWiseCompanyNewsSortingEnum;
|
|
3269
|
-
/**
|
|
3270
|
-
* Size
|
|
3271
|
-
* Define the number of records per page for pagination purposes.
|
|
3272
|
-
* @default 10
|
|
3273
|
-
* @example 10
|
|
3274
|
-
*/
|
|
3275
|
-
size?: number;
|
|
3276
|
-
/**
|
|
3277
|
-
* Page
|
|
3278
|
-
* Define the page number for pagination.
|
|
3279
|
-
* @default 1
|
|
3280
|
-
* @example 1
|
|
3281
|
-
*/
|
|
3282
|
-
page?: number;
|
|
3283
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePaginatedResponseCompanyNews, HandleError>>;
|
|
3284
|
-
/**
|
|
3285
|
-
* @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.
|
|
3286
|
-
* @tags Company News
|
|
3287
|
-
* @name GetAverageCompanyNewsSentiment
|
|
3288
|
-
* @summary Get Average Company News Sentiment
|
|
3289
|
-
* @request GET:/companies/{company_id}/news-sentiment
|
|
3290
|
-
* @secure
|
|
3291
|
-
*/
|
|
3292
|
-
getAverageCompanyNewsSentiment(companyId: number, query?: {
|
|
3293
|
-
/**
|
|
3294
|
-
* Published Date Gte
|
|
3295
|
-
* Date string in the format `YYYY-MM-DD`. Specify the start date for the data retrieval.
|
|
3296
|
-
* @format date
|
|
3297
|
-
* @default "2025-04-09"
|
|
3298
|
-
*/
|
|
3299
|
-
published_date__gte?: string;
|
|
3300
|
-
/**
|
|
3301
|
-
* Published Date Lte
|
|
3302
|
-
* Date string in the format `YYYY-MM-DD`. Specify the end date for the data retrieval.
|
|
3303
|
-
* @format date
|
|
3304
|
-
* @default "2025-04-09"
|
|
3305
|
-
*/
|
|
3306
|
-
published_date__lte?: string;
|
|
3307
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyNewsAverageSentiment, HandleError>>;
|
|
3308
|
-
}
|
|
3309
|
-
export class TechnicalAnalysis<HandleError extends boolean = boolean> {
|
|
3310
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3311
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3312
|
-
/**
|
|
3313
|
-
* @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.
|
|
3314
|
-
* @tags Technical Analysis
|
|
3315
|
-
* @name GetCompanyTechnicalAnalysis
|
|
3316
|
-
* @summary Get Company Technical Analysis
|
|
3317
|
-
* @request GET:/companies/{company_id}/technical-analysis
|
|
3318
|
-
* @secure
|
|
3319
|
-
*/
|
|
3320
|
-
getCompanyTechnicalAnalysis(companyId: number, query?: {
|
|
3321
|
-
/**
|
|
3322
|
-
* Language
|
|
3323
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3324
|
-
* @default "en-US"
|
|
3325
|
-
*/
|
|
3326
|
-
language?: BridgeWiseLanguageEnum;
|
|
3327
|
-
/**
|
|
3328
|
-
* Trading Item Id
|
|
3329
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
3330
|
-
*/
|
|
3331
|
-
trading_item_id?: number;
|
|
3332
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseTechAnalysisItem, HandleError>>;
|
|
3333
|
-
/**
|
|
3334
|
-
* @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.
|
|
3335
|
-
* @tags Technical Analysis
|
|
3336
|
-
* @name GetCompanyTechnicalParagraphs
|
|
3337
|
-
* @summary Get Company Technical Paragraphs
|
|
3338
|
-
* @request GET:/companies/{company_id}/technical-paragraphs
|
|
3339
|
-
* @secure
|
|
3340
|
-
*/
|
|
3341
|
-
getCompanyTechnicalParagraphs(companyId: number, query?: {
|
|
3342
|
-
/**
|
|
3343
|
-
* Language
|
|
3344
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3345
|
-
* @default "en-US"
|
|
3346
|
-
*/
|
|
3347
|
-
language?: BridgeWiseLanguageEnum;
|
|
3348
|
-
/**
|
|
3349
|
-
* Trading Item Id
|
|
3350
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
3351
|
-
*/
|
|
3352
|
-
trading_item_id?: number;
|
|
3353
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechnicalParagraphList, HandleError>>;
|
|
3354
|
-
/**
|
|
3355
|
-
* @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.
|
|
3356
|
-
* @tags Technical Analysis
|
|
3357
|
-
* @name GetCompanyTechnicalParameters
|
|
3358
|
-
* @summary Get Company Technical Parameters
|
|
3359
|
-
* @request GET:/companies/{company_id}/technical-parameters
|
|
3360
|
-
* @secure
|
|
3361
|
-
*/
|
|
3362
|
-
getCompanyTechnicalParameters(companyId: number, query?: {
|
|
3363
|
-
/**
|
|
3364
|
-
* Language
|
|
3365
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3366
|
-
* @default "en-US"
|
|
3367
|
-
*/
|
|
3368
|
-
language?: BridgeWiseLanguageEnum;
|
|
3369
|
-
/**
|
|
3370
|
-
* Trading Item Id
|
|
3371
|
-
* Specify a BW trading asset identifier for a targeted query.
|
|
3372
|
-
*/
|
|
3373
|
-
trading_item_id?: number;
|
|
3374
|
-
/**
|
|
3375
|
-
* Parameter Id
|
|
3376
|
-
* Get desired parameter by ID.
|
|
3377
|
-
*/
|
|
3378
|
-
parameter_id?: number;
|
|
3379
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechParameterItemList, HandleError>>;
|
|
3380
|
-
}
|
|
3381
|
-
export class Metadata<HandleError extends boolean = boolean> {
|
|
3382
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3383
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3384
|
-
/**
|
|
3385
|
-
* @description This endpoint provides filters
|
|
3386
|
-
* @tags Metadata
|
|
3387
|
-
* @name GetCompanyFilters
|
|
3388
|
-
* @summary Get Company Filters
|
|
3389
|
-
* @request GET:/filters
|
|
3390
|
-
* @secure
|
|
3391
|
-
*/
|
|
3392
|
-
getCompanyFilters(query: {
|
|
3393
|
-
/**
|
|
3394
|
-
* Type
|
|
3395
|
-
* Desired filter type.
|
|
3396
|
-
*/
|
|
3397
|
-
type: BridgeWiseCompanyFilterType;
|
|
3398
|
-
/**
|
|
3399
|
-
* Language
|
|
3400
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3401
|
-
* @default "en-US"
|
|
3402
|
-
*/
|
|
3403
|
-
language?: BridgeWiseLanguageEnum;
|
|
3404
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyFilterResponse[], HandleError>>;
|
|
3405
|
-
}
|
|
3406
|
-
export class FundMetadata<HandleError extends boolean = boolean> {
|
|
3407
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3408
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3409
|
-
/**
|
|
3410
|
-
* @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.
|
|
3411
|
-
* @tags Fund Metadata
|
|
3412
|
-
* @name GetFunds
|
|
3413
|
-
* @summary Get Funds
|
|
3414
|
-
* @request GET:/funds
|
|
3415
|
-
* @secure
|
|
3416
|
-
*/
|
|
3417
|
-
getFunds(query?: {
|
|
3418
|
-
/**
|
|
3419
|
-
* Search
|
|
3420
|
-
* Funds search.
|
|
3421
|
-
*/
|
|
3422
|
-
search?: string;
|
|
3423
|
-
/**
|
|
3424
|
-
* Peers Of
|
|
3425
|
-
* Get peers funds of a specific fund.
|
|
3426
|
-
*/
|
|
3427
|
-
peers_of?: number;
|
|
3428
|
-
/**
|
|
3429
|
-
* Sort By
|
|
3430
|
-
* Comma-separated string of sorting keys with optional ascending or descending (-) indicators. <br>Example: -beta_1y,pct_of_equity_holdings</br>
|
|
3431
|
-
*/
|
|
3432
|
-
sort_by?: string;
|
|
3433
|
-
/**
|
|
3434
|
-
* Language
|
|
3435
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3436
|
-
* @default "en-US"
|
|
3437
|
-
*/
|
|
3438
|
-
language?: BridgeWiseLanguageEnum;
|
|
3439
|
-
/**
|
|
3440
|
-
* Sponsor Id
|
|
3441
|
-
* Comma-separated unique sponsor identifiers. <br>Example: 58101467,316442135</br>
|
|
3442
|
-
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
3443
|
-
*/
|
|
3444
|
-
sponsor_id?: string;
|
|
3465
|
+
sponsor_id?: string;
|
|
3445
3466
|
/**
|
|
3446
3467
|
* Vehicle Type
|
|
3447
3468
|
* Desired vehicle type for the fund.
|
|
@@ -3794,119 +3815,6 @@ export class FundMetadata<HandleError extends boolean = boolean> {
|
|
|
3794
3815
|
language?: BridgeWiseLanguageEnum;
|
|
3795
3816
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMetadataList, HandleError>>;
|
|
3796
3817
|
}
|
|
3797
|
-
export class FundAnalysis<HandleError extends boolean = boolean> {
|
|
3798
|
-
protected readonly apiClient: JwtClient<HandleError>;
|
|
3799
|
-
constructor(apiClient: JwtClient<HandleError>);
|
|
3800
|
-
/**
|
|
3801
|
-
* @description Returns Bridgewise final analysis for a specified fund.
|
|
3802
|
-
* @tags Fund Analysis
|
|
3803
|
-
* @name GetFundAnalysis
|
|
3804
|
-
* @summary Get Fund Analysis
|
|
3805
|
-
* @request GET:/funds/{fund_id}/analysis
|
|
3806
|
-
* @secure
|
|
3807
|
-
*/
|
|
3808
|
-
getFundAnalysis(fundId: number, query?: {
|
|
3809
|
-
/**
|
|
3810
|
-
* Language
|
|
3811
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3812
|
-
* @default "en-US"
|
|
3813
|
-
*/
|
|
3814
|
-
language?: BridgeWiseLanguageEnum;
|
|
3815
|
-
/**
|
|
3816
|
-
* Year
|
|
3817
|
-
* Specify the year for which the analysis is requested.
|
|
3818
|
-
*/
|
|
3819
|
-
year?: number;
|
|
3820
|
-
/**
|
|
3821
|
-
* Quarter
|
|
3822
|
-
* Specify the quarter for which the analysis is requested.
|
|
3823
|
-
*/
|
|
3824
|
-
quarter?: number;
|
|
3825
|
-
/**
|
|
3826
|
-
* Show All
|
|
3827
|
-
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
3828
|
-
*/
|
|
3829
|
-
show_all?: boolean;
|
|
3830
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsAnalysisItem[], HandleError>>;
|
|
3831
|
-
/**
|
|
3832
|
-
* @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.
|
|
3833
|
-
* @tags Fund Analysis
|
|
3834
|
-
* @name GetFundsParagraphs
|
|
3835
|
-
* @summary Get Funds Paragraphs
|
|
3836
|
-
* @request GET:/funds/{fund_id}/paragraphs
|
|
3837
|
-
* @secure
|
|
3838
|
-
*/
|
|
3839
|
-
getFundsParagraphs(fundId: number, query?: {
|
|
3840
|
-
/**
|
|
3841
|
-
* Language
|
|
3842
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3843
|
-
* @default "en-US"
|
|
3844
|
-
*/
|
|
3845
|
-
language?: BridgeWiseLanguageEnum;
|
|
3846
|
-
/**
|
|
3847
|
-
* Year
|
|
3848
|
-
* Specify the year for which the analysis is requested.
|
|
3849
|
-
*/
|
|
3850
|
-
year?: number | null;
|
|
3851
|
-
/**
|
|
3852
|
-
* Quarter
|
|
3853
|
-
* Specify the quarter for which the analysis is requested.
|
|
3854
|
-
*/
|
|
3855
|
-
quarter?: number | null;
|
|
3856
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParagraph[], HandleError>>;
|
|
3857
|
-
/**
|
|
3858
|
-
* @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.
|
|
3859
|
-
* @tags Fund Analysis
|
|
3860
|
-
* @name GetFundParameters
|
|
3861
|
-
* @summary Get Fund Parameters
|
|
3862
|
-
* @request GET:/funds/{fund_id}/parameters
|
|
3863
|
-
* @secure
|
|
3864
|
-
*/
|
|
3865
|
-
getFundParameters(fundId: number, query?: {
|
|
3866
|
-
/**
|
|
3867
|
-
* Language
|
|
3868
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3869
|
-
* @default "en-US"
|
|
3870
|
-
*/
|
|
3871
|
-
language?: BridgeWiseLanguageEnum;
|
|
3872
|
-
/**
|
|
3873
|
-
* Parameter Id
|
|
3874
|
-
* ID of the parameter for analysis.
|
|
3875
|
-
*/
|
|
3876
|
-
parameter_id?: number;
|
|
3877
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundParametersItemList, HandleError>>;
|
|
3878
|
-
/**
|
|
3879
|
-
* @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.
|
|
3880
|
-
* @tags Fund Analysis
|
|
3881
|
-
* @name GetFundSections
|
|
3882
|
-
* @summary Get Fund Sections
|
|
3883
|
-
* @request GET:/funds/{fund_id}/sections
|
|
3884
|
-
* @secure
|
|
3885
|
-
*/
|
|
3886
|
-
getFundSections(fundId: number, query?: {
|
|
3887
|
-
/**
|
|
3888
|
-
* Year
|
|
3889
|
-
* Specify the year for which the analysis is requested.
|
|
3890
|
-
*/
|
|
3891
|
-
year?: number;
|
|
3892
|
-
/**
|
|
3893
|
-
* Quarter
|
|
3894
|
-
* Specify the quarter for which the analysis is requested.
|
|
3895
|
-
*/
|
|
3896
|
-
quarter?: number;
|
|
3897
|
-
/**
|
|
3898
|
-
* Language
|
|
3899
|
-
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3900
|
-
* @default "en-US"
|
|
3901
|
-
*/
|
|
3902
|
-
language?: BridgeWiseLanguageEnum;
|
|
3903
|
-
/**
|
|
3904
|
-
* Show All
|
|
3905
|
-
* Boolean flag. Indicate whether to return historical data (`true/false`).
|
|
3906
|
-
*/
|
|
3907
|
-
show_all?: boolean;
|
|
3908
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundsSectionsItem[], HandleError>>;
|
|
3909
|
-
}
|
|
3910
3818
|
export class Holdings<HandleError extends boolean = boolean> {
|
|
3911
3819
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
3912
3820
|
constructor(apiClient: JwtClient<HandleError>);
|
|
@@ -4000,54 +3908,75 @@ export class Holdings<HandleError extends boolean = boolean> {
|
|
|
4000
3908
|
page_size?: number;
|
|
4001
3909
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundHoldingsList, HandleError>>;
|
|
4002
3910
|
}
|
|
4003
|
-
export class
|
|
3911
|
+
export class Logos<HandleError extends boolean = boolean> {
|
|
4004
3912
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4005
3913
|
constructor(apiClient: JwtClient<HandleError>);
|
|
4006
3914
|
/**
|
|
4007
|
-
* @description
|
|
4008
|
-
* @tags
|
|
4009
|
-
* @name
|
|
4010
|
-
* @summary
|
|
4011
|
-
* @request GET:/
|
|
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
|
|
4012
3920
|
* @secure
|
|
4013
3921
|
*/
|
|
4014
|
-
|
|
3922
|
+
fetchLogos(query?: {
|
|
4015
3923
|
/**
|
|
4016
|
-
*
|
|
4017
|
-
* Specify a
|
|
3924
|
+
* Company Id In
|
|
3925
|
+
* Specify a list of BW identifiers for bulk queries.
|
|
3926
|
+
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
3927
|
+
* @example "74822,83343211"
|
|
4018
3928
|
*/
|
|
4019
|
-
|
|
3929
|
+
company_id__in?: string;
|
|
4020
3930
|
/**
|
|
4021
|
-
*
|
|
4022
|
-
*
|
|
3931
|
+
* Size
|
|
3932
|
+
* Page size
|
|
3933
|
+
* @min 1
|
|
3934
|
+
* @max 100
|
|
3935
|
+
* @default 50
|
|
4023
3936
|
*/
|
|
4024
|
-
|
|
3937
|
+
size?: number;
|
|
4025
3938
|
/**
|
|
4026
|
-
*
|
|
4027
|
-
*
|
|
3939
|
+
* Page
|
|
3940
|
+
* Page number
|
|
3941
|
+
* @min 1
|
|
3942
|
+
* @default 1
|
|
4028
3943
|
*/
|
|
4029
|
-
|
|
4030
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
3944
|
+
page?: number;
|
|
3945
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWisePageLogo, HandleError>>;
|
|
4031
3946
|
/**
|
|
4032
|
-
* @description
|
|
4033
|
-
* @tags
|
|
4034
|
-
* @name
|
|
4035
|
-
* @summary
|
|
4036
|
-
* @request GET:/
|
|
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
|
|
4037
3952
|
* @secure
|
|
4038
3953
|
*/
|
|
4039
|
-
|
|
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: {
|
|
4040
3968
|
/**
|
|
4041
|
-
*
|
|
4042
|
-
*
|
|
3969
|
+
* Type
|
|
3970
|
+
* Desired filter type.
|
|
4043
3971
|
*/
|
|
4044
|
-
|
|
3972
|
+
type: BridgeWiseCompanyFilterType;
|
|
4045
3973
|
/**
|
|
4046
|
-
*
|
|
4047
|
-
*
|
|
3974
|
+
* Language
|
|
3975
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
3976
|
+
* @default "en-US"
|
|
4048
3977
|
*/
|
|
4049
|
-
|
|
4050
|
-
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<
|
|
3978
|
+
language?: BridgeWiseLanguageEnum;
|
|
3979
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyFilterResponse[], HandleError>>;
|
|
4051
3980
|
}
|
|
4052
3981
|
export class Segmentations<HandleError extends boolean = boolean> {
|
|
4053
3982
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
@@ -4105,6 +4034,78 @@ export class Segmentations<HandleError extends boolean = boolean> {
|
|
|
4105
4034
|
segment?: string;
|
|
4106
4035
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseFundSegmentsList, HandleError>>;
|
|
4107
4036
|
}
|
|
4037
|
+
export class TechnicalAnalysis<HandleError extends boolean = boolean> {
|
|
4038
|
+
protected readonly apiClient: JwtClient<HandleError>;
|
|
4039
|
+
constructor(apiClient: JwtClient<HandleError>);
|
|
4040
|
+
/**
|
|
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
|
|
4046
|
+
* @secure
|
|
4047
|
+
*/
|
|
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;
|
|
4055
|
+
/**
|
|
4056
|
+
* Trading Item Id
|
|
4057
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
4058
|
+
*/
|
|
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?: {
|
|
4070
|
+
/**
|
|
4071
|
+
* Language
|
|
4072
|
+
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
4073
|
+
* @default "en-US"
|
|
4074
|
+
*/
|
|
4075
|
+
language?: BridgeWiseLanguageEnum;
|
|
4076
|
+
/**
|
|
4077
|
+
* Trading Item Id
|
|
4078
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
4079
|
+
*/
|
|
4080
|
+
trading_item_id?: number;
|
|
4081
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechnicalParagraphList, HandleError>>;
|
|
4082
|
+
/**
|
|
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
|
|
4088
|
+
* @secure
|
|
4089
|
+
*/
|
|
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;
|
|
4097
|
+
/**
|
|
4098
|
+
* Trading Item Id
|
|
4099
|
+
* Specify a BW trading asset identifier for a targeted query.
|
|
4100
|
+
*/
|
|
4101
|
+
trading_item_id?: number;
|
|
4102
|
+
/**
|
|
4103
|
+
* Parameter Id
|
|
4104
|
+
* Get desired parameter by ID.
|
|
4105
|
+
*/
|
|
4106
|
+
parameter_id?: number;
|
|
4107
|
+
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseCompanyTechParameterItemList, HandleError>>;
|
|
4108
|
+
}
|
|
4108
4109
|
export class Tenants<HandleError extends boolean = boolean> {
|
|
4109
4110
|
protected readonly apiClient: JwtClient<HandleError>;
|
|
4110
4111
|
constructor(apiClient: JwtClient<HandleError>);
|