@orbis-systems/orbis-api-clients 1.3.0 → 1.3.2
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 +3 -1
- 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 +57 -6
- 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/index.d.ts +3 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.esm.js +1 -1
- package/dist/index.esm.js.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/insight/index.d.ts +3 -1
- 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 +3 -1
- 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 +3 -1
- 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 +3 -1
- package/dist/uma/index.d.ts.map +1 -1
- package/dist/uma/index.esm.js +1 -1
- package/dist/uma/index.esm.js.map +1 -1
- package/dist/uma/index.js +1 -1
- package/dist/uma/index.js.map +1 -1
- package/package.json +157 -157
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { AxiosError, AxiosInstance, AxiosRequestConfig, HttpStatusCode } from "axios";
|
|
1
|
+
import { AxiosError, AxiosInstance, AxiosRequestConfig, AxiosResponseHeaders, HttpStatusCode } from "axios";
|
|
2
2
|
import { BridgeWiseTechAnalysisItem as _BridgeWiseTechAnalysisItem1 } from "apis/bridgewise";
|
|
3
3
|
enum CaseFormat {
|
|
4
4
|
Camel = "camel",
|
|
@@ -45,12 +45,14 @@ type SuccessClientResponse<Data = unknown, RawData = unknown> = ResponseStatus &
|
|
|
45
45
|
success: true;
|
|
46
46
|
data: Data;
|
|
47
47
|
rawData: RawData;
|
|
48
|
+
headers: AxiosResponseHeaders;
|
|
48
49
|
};
|
|
49
50
|
type ErrorClientResponse = ResponseStatus & {
|
|
50
51
|
success: false;
|
|
51
52
|
data?: any;
|
|
52
53
|
rawData?: any;
|
|
53
54
|
error: unknown;
|
|
55
|
+
headers?: AxiosResponseHeaders;
|
|
54
56
|
};
|
|
55
57
|
type ClientResponse<Data = unknown, HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> = HandleError extends true ? SuccessClientResponse<TransformData<Data, Format>, Data> | ErrorClientResponse : SuccessClientResponse<TransformData<Data, Format>, Data>;
|
|
56
58
|
declare abstract class BaseClient<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original, AuthData = unknown> {
|
|
@@ -1469,6 +1471,8 @@ export interface BridgeWiseSubmitQuestion {
|
|
|
1469
1471
|
custom_data?: Record<string, any>;
|
|
1470
1472
|
/** Language code like 'en-US', 'he-IL', 'ja-JP' */
|
|
1471
1473
|
language?: string;
|
|
1474
|
+
/** User's country name (e.g. 'United States'), used to resolve a default trading country. */
|
|
1475
|
+
country_name?: string | null;
|
|
1472
1476
|
/**
|
|
1473
1477
|
* Question to ask, for example: 'What are the latest news about Nvidia'?
|
|
1474
1478
|
* @maxLength 2000
|
|
@@ -6437,6 +6441,11 @@ export class Companies<HandleError extends boolean = boolean, Format extends Cas
|
|
|
6437
6441
|
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
6438
6442
|
*/
|
|
6439
6443
|
theme_id?: string;
|
|
6444
|
+
/**
|
|
6445
|
+
* Tags
|
|
6446
|
+
* Comma-separated list of unique tags. <br>Example: tenant:111,tenant:222</br>
|
|
6447
|
+
*/
|
|
6448
|
+
tags?: string;
|
|
6440
6449
|
/**
|
|
6441
6450
|
* Implied Market Cap Gte
|
|
6442
6451
|
* Companies with market cap greater than or equal to.
|
|
@@ -7027,6 +7036,11 @@ export class Companies<HandleError extends boolean = boolean, Format extends Cas
|
|
|
7027
7036
|
* Target price to last close less than or equal to.
|
|
7028
7037
|
*/
|
|
7029
7038
|
target_price_to_last_close__lte?: number;
|
|
7039
|
+
/**
|
|
7040
|
+
* Price Target Note
|
|
7041
|
+
* Filter by analyst-vs-target-price contradiction signal.
|
|
7042
|
+
*/
|
|
7043
|
+
price_target_note?: boolean | null;
|
|
7030
7044
|
/**
|
|
7031
7045
|
* Fund Id
|
|
7032
7046
|
* Comma-separated fund ids to filter stocks within the funds.
|
|
@@ -7160,7 +7174,6 @@ export class Companies<HandleError extends boolean = boolean, Format extends Cas
|
|
|
7160
7174
|
* Company Id
|
|
7161
7175
|
* Comma-separated list of BridgeWise company IDs. Returns funds holding ALL of the specified companies (intersection / AND logic).
|
|
7162
7176
|
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
7163
|
-
* @example "123,456,789"
|
|
7164
7177
|
*/
|
|
7165
7178
|
company_id: string;
|
|
7166
7179
|
/**
|
|
@@ -7207,7 +7220,7 @@ export class Companies<HandleError extends boolean = boolean, Format extends Cas
|
|
|
7207
7220
|
getStock(companyId: string, query?: {
|
|
7208
7221
|
/**
|
|
7209
7222
|
* Returns
|
|
7210
|
-
* Comma-separated list of fields to return. <br>Available fields: analysis_esg_score, analysis_esg_score_group, analysis_fundamental_score, analysis_fundamental_score_group, analysis_fundamental_score_group_text, analysis_technical_score, analysis_technical_score_group, analysis_technical_short_score, analysis_technical_short_score_group, analysis_technical_long_score, analysis_technical_long_score_group, assets_turnover, average_revenue_per_subscriber, beta_1_year, close_price, company_name, company_name_short, consensus_analyst_count, consensus_score_group, csa_industry_id, csa_industry_name, currency_market_id, current_ratio, daily_return, dividend_yield_percentage, domicile_country_id, domicile_country_name, ebit_by_interest_expense, ebitda_margin_percent, exchange_id, exchange_symbol, filling_date, free_cash_flow_per_share, fund_id, gics_industry_group_id, gics_industry_group_name, gics_industry_id, gics_industry_name, gics_sector_id, gics_sector_name, gross_profit_margin_percent, implied_market_cap, incorporation_country_id, incorporation_country_name, internal_coverage, policy_threshold, ipo_date, is_red_flagged, last_close_market_cap_usd, last_close_tev_divided_by_ebitda, long_term_debt_by_total_capital, net_debt_divided_by_ebitda, net_eps_basic, net_eps_diluted, net_income_margin_percent, news_sentiment_score, news_sentiment_group, news_sentiment_group_text, operating_cash_flow_by_current_liabilities, payout_ratio, pe_ratio, peers_of, period_last_price_divided_book_value, price_currency_iso3, primary_currency_financials_iso3, primary_currency_market, primary_currency_market_id, primary_exchange_symbol, primary_security_id, primary_security_name, primary_ticker_symbol, quick_ratio, region_id, region_name, return_1d, return_1m, return_1y, return_2y, return_5d, return_5y, return_6m, return_on_assets, return_on_equity_percent, return_on_total_capital, return_ytd, revenue_per_employee_in_thousands, section_balance_sheet_score, section_balance_sheet_score_group, section_environmental_score, section_environmental_score_group, section_cash_flow_score, section_cash_flow_score_group, section_governance_score, section_governance_score_group, section_income_statement_score, section_income_statement_score_group, section_social_score, section_social_score_group, sector_score, sector_score_group, segment_strength_score, target_price, target_price_to_last_close, theme_ids, ticker_symbol, total_debt_to_equity, total_debt_to_capital_percent, total_revenues, total_revenues_one_year_growth_percentage, updated_at, website, trading_item_id</br>
|
|
7223
|
+
* Comma-separated list of fields to return. <br>Available fields: analysis_esg_score, analysis_esg_score_group, analysis_fundamental_score, analysis_fundamental_score_group, analysis_fundamental_score_group_text, analysis_technical_score, analysis_technical_score_group, analysis_technical_short_score, analysis_technical_short_score_group, analysis_technical_long_score, analysis_technical_long_score_group, assets_turnover, average_revenue_per_subscriber, beta_1_year, close_price, company_name, company_name_short, consensus_analyst_count, consensus_score_group, csa_industry_id, csa_industry_name, currency_market_id, current_ratio, daily_return, dividend_yield_percentage, domicile_country_id, domicile_country_name, ebit_by_interest_expense, ebitda_margin_percent, exchange_id, exchange_symbol, filling_date, free_cash_flow_per_share, fund_id, gics_industry_group_id, gics_industry_group_name, gics_industry_id, gics_industry_name, gics_sector_id, gics_sector_name, gross_profit_margin_percent, implied_market_cap, incorporation_country_id, incorporation_country_name, internal_coverage, policy_threshold, ipo_date, is_red_flagged, last_close_market_cap_usd, last_close_tev_divided_by_ebitda, long_term_debt_by_total_capital, net_debt_divided_by_ebitda, net_eps_basic, net_eps_diluted, net_income_margin_percent, news_sentiment_score, news_sentiment_group, news_sentiment_group_text, operating_cash_flow_by_current_liabilities, payout_ratio, pe_ratio, peers_of, period_last_price_divided_book_value, price_currency_iso3, primary_currency_financials_iso3, primary_currency_market, primary_currency_market_id, primary_exchange_symbol, primary_security_id, primary_security_name, primary_ticker_symbol, quick_ratio, region_id, region_name, return_1d, return_1m, return_1y, return_2y, return_5d, return_5y, return_6m, return_on_assets, return_on_equity_percent, return_on_total_capital, return_ytd, revenue_per_employee_in_thousands, section_balance_sheet_score, section_balance_sheet_score_group, section_environmental_score, section_environmental_score_group, section_cash_flow_score, section_cash_flow_score_group, section_governance_score, section_governance_score_group, section_income_statement_score, section_income_statement_score_group, section_social_score, section_social_score_group, sector_score, sector_score_group, segment_strength_score, tags, target_price, target_price_to_last_close, price_target_note, theme_ids, ticker_symbol, total_debt_to_equity, total_debt_to_capital_percent, total_revenues, total_revenues_one_year_growth_percentage, updated_at, website, trading_item_id</br>
|
|
7211
7224
|
*/
|
|
7212
7225
|
returns?: string;
|
|
7213
7226
|
/**
|
|
@@ -8180,6 +8193,11 @@ export class Funds<HandleError extends boolean = boolean, Format extends CaseFor
|
|
|
8180
8193
|
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
8181
8194
|
*/
|
|
8182
8195
|
theme_id?: string;
|
|
8196
|
+
/**
|
|
8197
|
+
* Tags
|
|
8198
|
+
* Comma-separated list of unique tags. <br>Example: tenant:111,tenant:222</br>
|
|
8199
|
+
*/
|
|
8200
|
+
tags?: string;
|
|
8183
8201
|
/**
|
|
8184
8202
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
8185
8203
|
* @default "en-US"
|
|
@@ -8648,7 +8666,7 @@ export class Funds<HandleError extends boolean = boolean, Format extends CaseFor
|
|
|
8648
8666
|
getFund(fundId: string, query?: {
|
|
8649
8667
|
/**
|
|
8650
8668
|
* Returns
|
|
8651
|
-
* Comma-separated list of fields to return. <br>Available fields: alpha_1y, alpha_1y_group, analysis_fundamental_score, analysis_fundamental_score_group, analysis_fundamental_score_group_text, analysis_technical_short_score, analysis_technical_short_score_group, analysis_technical_long_score, analysis_technical_long_score_group, analysis_technical_score_group, analysis_technical_score, aum_usd, avg_trading_volume_3m, avg_trading_volume_3m_group, market_benchmark_id, benchmark_name, benchmark_name_short, beta_1y, beta_1y_group, cash_flow_factor, cash_flow_factor_group, close_price, max_concentration, company_name, company_name_short, currency_market_id, daily_return, dividend_policy, dividend_yield, dividend_yield_group, domicile_country_id, domicile_country_iso2, domicile_country_name, equity_under_management_usd, exchange_id, exchange_symbol, expense_ratio, expense_ratio_group, exposure_id, exposure, source_id, source, index_tracked, index_tracked_id, growth_factor_group, last_close_market_cap_usd, filling_date, fund_id, fund_name, fund_name_short, fund_type_id, fund_type_name, underlying_asset_type_id, underlying_asset_type, geographic_country_mandate, geographic_emphasis, geographic_region_mandate, geography_emphasis_id, growth_factor, has_score, inception_date, is_company, is_fund, is_primary, largest_holding, leverage, management_style, management_style_id, market_capitalization_emphasis, market_cap_emphasis_id, news_sentiment_score, news_sentiment_group, news_sentiment_group_text, number_of_holdings, pct_of_equity_holdings, peers_of, portfolio_strategy, primary_currency_market, primary_currency_market_id, primary_exchange_name, primary_exchange_symbol, primary_market_currency_iso3, primary_security_id, primary_security_name, primary_ticker_symbol, primary_trading_item, region_id, region_name, return_1d, return_1m, return_1y, return_2y, return_5d, return_5y, return_6m, annual_return, return_ytd, section_holdings_group, section_mgmt_metric_group, section_performance_score, section_performance_score_group, section_portfolio_score, section_portfolio_score_group, section_risk_factors_group, section_risk_score, section_risk_score_group, sector_emphasis, sector_emphasis_id, sector_score, segment_strength_score, sharpe_ratio_1y, sharpe_ratio_1y_group, sponsor_aum_usd, sponsor_id, sponsor_name, sponsor_name_short, target_price, theme_ids, trading_item_id, ticker_symbol, tracking_error_1y, trading_volume_ratio, updated_at, value_factor, value_factor_group, vehicle_type, weight_method</br>
|
|
8669
|
+
* Comma-separated list of fields to return. <br>Available fields: alpha_1y, alpha_1y_group, analysis_fundamental_score, analysis_fundamental_score_group, analysis_fundamental_score_group_text, analysis_technical_short_score, analysis_technical_short_score_group, analysis_technical_long_score, analysis_technical_long_score_group, analysis_technical_score_group, analysis_technical_score, aum_usd, avg_trading_volume_3m, avg_trading_volume_3m_group, market_benchmark_id, benchmark_name, benchmark_name_short, beta_1y, beta_1y_group, cash_flow_factor, cash_flow_factor_group, close_price, max_concentration, company_name, company_name_short, currency_market_id, daily_return, dividend_policy, dividend_yield, dividend_yield_group, domicile_country_id, domicile_country_iso2, domicile_country_name, equity_under_management_usd, exchange_id, exchange_symbol, expense_ratio, expense_ratio_group, exposure_id, exposure, source_id, source, index_tracked, index_tracked_id, growth_factor_group, last_close_market_cap_usd, filling_date, fund_id, fund_name, fund_name_short, fund_type_id, fund_type_name, underlying_asset_type_id, underlying_asset_type, geographic_country_mandate, geographic_emphasis, geographic_region_mandate, geography_emphasis_id, growth_factor, has_score, inception_date, is_company, is_fund, is_primary, largest_holding, leverage, management_style, management_style_id, market_capitalization_emphasis, market_cap_emphasis_id, news_sentiment_score, news_sentiment_group, news_sentiment_group_text, number_of_holdings, pct_of_equity_holdings, peers_of, portfolio_strategy, primary_currency_market, primary_currency_market_id, primary_exchange_name, primary_exchange_symbol, primary_market_currency_iso3, primary_security_id, primary_security_name, primary_ticker_symbol, primary_trading_item, region_id, region_name, return_1d, return_1m, return_1y, return_2y, return_5d, return_5y, return_6m, annual_return, return_ytd, section_holdings_group, section_mgmt_metric_group, section_performance_score, section_performance_score_group, section_portfolio_score, section_portfolio_score_group, section_risk_factors_group, section_risk_score, section_risk_score_group, sector_emphasis, sector_emphasis_id, sector_score, segment_strength_score, sharpe_ratio_1y, sharpe_ratio_1y_group, sponsor_aum_usd, sponsor_id, sponsor_name, sponsor_name_short, tags, target_price, theme_ids, trading_item_id, ticker_symbol, tracking_error_1y, trading_volume_ratio, updated_at, value_factor, value_factor_group, vehicle_type, weight_method</br>
|
|
8652
8670
|
*/
|
|
8653
8671
|
returns?: string;
|
|
8654
8672
|
/**
|
|
@@ -9252,6 +9270,11 @@ export class Screener<HandleError extends boolean = boolean, Format extends Case
|
|
|
9252
9270
|
* Filter by quote currency. <br>Example: USD,GBP</br>
|
|
9253
9271
|
*/
|
|
9254
9272
|
primary_market_currency_iso3?: string | null;
|
|
9273
|
+
/**
|
|
9274
|
+
* Tags
|
|
9275
|
+
* Comma-separated list of unique tags. <br>Example: tenant:111,tenant:222</br>
|
|
9276
|
+
*/
|
|
9277
|
+
tags?: string | null;
|
|
9255
9278
|
/**
|
|
9256
9279
|
* Daily Return Gte
|
|
9257
9280
|
* Filter by daily return (greater than or equal).
|
|
@@ -9969,7 +9992,7 @@ export class Screener<HandleError extends boolean = boolean, Format extends Case
|
|
|
9969
9992
|
ids?: string;
|
|
9970
9993
|
/**
|
|
9971
9994
|
* Returns
|
|
9972
|
-
* Comma-separated list of fields to return. <br>Available fields: alpha_1y, alpha_1y_group, analysis_fundamental_score, analysis_fundamental_score_group, analysis_fundamental_score_group_text, analysis_technical_short_score, analysis_technical_short_score_group, analysis_technical_long_score, analysis_technical_long_score_group, analysis_technical_score_group, analysis_technical_score, aum_usd, avg_trading_volume_3m, avg_trading_volume_3m_group, market_benchmark_id, benchmark_name, benchmark_name_short, beta_1y, beta_1y_group, cash_flow_factor, cash_flow_factor_group, close_price, max_concentration, company_name, company_name_short, currency_market_id, daily_return, dividend_policy, dividend_yield, dividend_yield_group, domicile_country_id, domicile_country_iso2, domicile_country_name, equity_under_management_usd, exchange_id, exchange_symbol, expense_ratio, expense_ratio_group, exposure_id, exposure, source_id, source, index_tracked, index_tracked_id, growth_factor_group, last_close_market_cap_usd, filling_date, fund_id, fund_name, fund_name_short, fund_type_id, fund_type_name, underlying_asset_type_id, underlying_asset_type, geographic_country_mandate, geographic_emphasis, geographic_region_mandate, geography_emphasis_id, growth_factor, has_score, inception_date, is_company, is_fund, is_primary, largest_holding, leverage, management_style, management_style_id, market_capitalization_emphasis, market_cap_emphasis_id, news_sentiment_score, news_sentiment_group, news_sentiment_group_text, number_of_holdings, pct_of_equity_holdings, peers_of, portfolio_strategy, primary_currency_market, primary_currency_market_id, primary_exchange_name, primary_exchange_symbol, primary_market_currency_iso3, primary_security_id, primary_security_name, primary_ticker_symbol, primary_trading_item, region_id, region_name, return_1d, return_1m, return_1y, return_2y, return_5d, return_5y, return_6m, annual_return, return_ytd, section_holdings_group, section_mgmt_metric_group, section_performance_score, section_performance_score_group, section_portfolio_score, section_portfolio_score_group, section_risk_factors_group, section_risk_score, section_risk_score_group, sector_emphasis, sector_emphasis_id, sector_score, segment_strength_score, sharpe_ratio_1y, sharpe_ratio_1y_group, sponsor_aum_usd, sponsor_id, sponsor_name, sponsor_name_short, target_price, theme_ids, trading_item_id, ticker_symbol, tracking_error_1y, trading_volume_ratio, updated_at, value_factor, value_factor_group, vehicle_type, weight_method</br>
|
|
9995
|
+
* Comma-separated list of fields to return. <br>Available fields: alpha_1y, alpha_1y_group, analysis_fundamental_score, analysis_fundamental_score_group, analysis_fundamental_score_group_text, analysis_technical_short_score, analysis_technical_short_score_group, analysis_technical_long_score, analysis_technical_long_score_group, analysis_technical_score_group, analysis_technical_score, aum_usd, avg_trading_volume_3m, avg_trading_volume_3m_group, market_benchmark_id, benchmark_name, benchmark_name_short, beta_1y, beta_1y_group, cash_flow_factor, cash_flow_factor_group, close_price, max_concentration, company_name, company_name_short, currency_market_id, daily_return, dividend_policy, dividend_yield, dividend_yield_group, domicile_country_id, domicile_country_iso2, domicile_country_name, equity_under_management_usd, exchange_id, exchange_symbol, expense_ratio, expense_ratio_group, exposure_id, exposure, source_id, source, index_tracked, index_tracked_id, growth_factor_group, last_close_market_cap_usd, filling_date, fund_id, fund_name, fund_name_short, fund_type_id, fund_type_name, underlying_asset_type_id, underlying_asset_type, geographic_country_mandate, geographic_emphasis, geographic_region_mandate, geography_emphasis_id, growth_factor, has_score, inception_date, is_company, is_fund, is_primary, largest_holding, leverage, management_style, management_style_id, market_capitalization_emphasis, market_cap_emphasis_id, news_sentiment_score, news_sentiment_group, news_sentiment_group_text, number_of_holdings, pct_of_equity_holdings, peers_of, portfolio_strategy, primary_currency_market, primary_currency_market_id, primary_exchange_name, primary_exchange_symbol, primary_market_currency_iso3, primary_security_id, primary_security_name, primary_ticker_symbol, primary_trading_item, region_id, region_name, return_1d, return_1m, return_1y, return_2y, return_5d, return_5y, return_6m, annual_return, return_ytd, section_holdings_group, section_mgmt_metric_group, section_performance_score, section_performance_score_group, section_portfolio_score, section_portfolio_score_group, section_risk_factors_group, section_risk_score, section_risk_score_group, sector_emphasis, sector_emphasis_id, sector_score, segment_strength_score, sharpe_ratio_1y, sharpe_ratio_1y_group, sponsor_aum_usd, sponsor_id, sponsor_name, sponsor_name_short, tags, target_price, theme_ids, trading_item_id, ticker_symbol, tracking_error_1y, trading_volume_ratio, updated_at, value_factor, value_factor_group, vehicle_type, weight_method</br>
|
|
9973
9996
|
*/
|
|
9974
9997
|
returns?: string;
|
|
9975
9998
|
/**
|
|
@@ -10029,6 +10052,11 @@ export class Screener<HandleError extends boolean = boolean, Format extends Case
|
|
|
10029
10052
|
* @default true
|
|
10030
10053
|
*/
|
|
10031
10054
|
has_score?: boolean;
|
|
10055
|
+
/**
|
|
10056
|
+
* Tags
|
|
10057
|
+
* Comma-separated list of unique tags. <br>Example: tenant:111,tenant:222</br>
|
|
10058
|
+
*/
|
|
10059
|
+
tags?: string;
|
|
10032
10060
|
/**
|
|
10033
10061
|
* Define the language code (e.g., `'en-US'` for English) for the textual data output.
|
|
10034
10062
|
* @default "en-US"
|
|
@@ -10722,7 +10750,7 @@ export class Screener<HandleError extends boolean = boolean, Format extends Case
|
|
|
10722
10750
|
ids?: string;
|
|
10723
10751
|
/**
|
|
10724
10752
|
* Returns
|
|
10725
|
-
* Comma-separated list of fields to return. <br>Available fields: analysis_esg_score, analysis_esg_score_group, analysis_fundamental_score, analysis_fundamental_score_group, analysis_fundamental_score_group_text, analysis_technical_score, analysis_technical_score_group, analysis_technical_short_score, analysis_technical_short_score_group, analysis_technical_long_score, analysis_technical_long_score_group, assets_turnover, average_revenue_per_subscriber, beta_1_year, close_price, company_name, company_name_short, consensus_analyst_count, consensus_score_group, csa_industry_id, csa_industry_name, currency_market_id, current_ratio, daily_return, dividend_yield_percentage, domicile_country_id, domicile_country_name, ebit_by_interest_expense, ebitda_margin_percent, exchange_id, exchange_symbol, filling_date, free_cash_flow_per_share, fund_id, gics_industry_group_id, gics_industry_group_name, gics_industry_id, gics_industry_name, gics_sector_id, gics_sector_name, gross_profit_margin_percent, implied_market_cap, incorporation_country_id, incorporation_country_name, internal_coverage, policy_threshold, ipo_date, is_red_flagged, last_close_market_cap_usd, last_close_tev_divided_by_ebitda, long_term_debt_by_total_capital, net_debt_divided_by_ebitda, net_eps_basic, net_eps_diluted, net_income_margin_percent, news_sentiment_score, news_sentiment_group, news_sentiment_group_text, operating_cash_flow_by_current_liabilities, payout_ratio, pe_ratio, peers_of, period_last_price_divided_book_value, price_currency_iso3, primary_currency_financials_iso3, primary_currency_market, primary_currency_market_id, primary_exchange_symbol, primary_security_id, primary_security_name, primary_ticker_symbol, quick_ratio, region_id, region_name, return_1d, return_1m, return_1y, return_2y, return_5d, return_5y, return_6m, return_on_assets, return_on_equity_percent, return_on_total_capital, return_ytd, revenue_per_employee_in_thousands, section_balance_sheet_score, section_balance_sheet_score_group, section_environmental_score, section_environmental_score_group, section_cash_flow_score, section_cash_flow_score_group, section_governance_score, section_governance_score_group, section_income_statement_score, section_income_statement_score_group, section_social_score, section_social_score_group, sector_score, sector_score_group, segment_strength_score, target_price, target_price_to_last_close, theme_ids, ticker_symbol, total_debt_to_equity, total_debt_to_capital_percent, total_revenues, total_revenues_one_year_growth_percentage, updated_at, website, trading_item_id</br>
|
|
10753
|
+
* Comma-separated list of fields to return. <br>Available fields: analysis_esg_score, analysis_esg_score_group, analysis_fundamental_score, analysis_fundamental_score_group, analysis_fundamental_score_group_text, analysis_technical_score, analysis_technical_score_group, analysis_technical_short_score, analysis_technical_short_score_group, analysis_technical_long_score, analysis_technical_long_score_group, assets_turnover, average_revenue_per_subscriber, beta_1_year, close_price, company_name, company_name_short, consensus_analyst_count, consensus_score_group, csa_industry_id, csa_industry_name, currency_market_id, current_ratio, daily_return, dividend_yield_percentage, domicile_country_id, domicile_country_name, ebit_by_interest_expense, ebitda_margin_percent, exchange_id, exchange_symbol, filling_date, free_cash_flow_per_share, fund_id, gics_industry_group_id, gics_industry_group_name, gics_industry_id, gics_industry_name, gics_sector_id, gics_sector_name, gross_profit_margin_percent, implied_market_cap, incorporation_country_id, incorporation_country_name, internal_coverage, policy_threshold, ipo_date, is_red_flagged, last_close_market_cap_usd, last_close_tev_divided_by_ebitda, long_term_debt_by_total_capital, net_debt_divided_by_ebitda, net_eps_basic, net_eps_diluted, net_income_margin_percent, news_sentiment_score, news_sentiment_group, news_sentiment_group_text, operating_cash_flow_by_current_liabilities, payout_ratio, pe_ratio, peers_of, period_last_price_divided_book_value, price_currency_iso3, primary_currency_financials_iso3, primary_currency_market, primary_currency_market_id, primary_exchange_symbol, primary_security_id, primary_security_name, primary_ticker_symbol, quick_ratio, region_id, region_name, return_1d, return_1m, return_1y, return_2y, return_5d, return_5y, return_6m, return_on_assets, return_on_equity_percent, return_on_total_capital, return_ytd, revenue_per_employee_in_thousands, section_balance_sheet_score, section_balance_sheet_score_group, section_environmental_score, section_environmental_score_group, section_cash_flow_score, section_cash_flow_score_group, section_governance_score, section_governance_score_group, section_income_statement_score, section_income_statement_score_group, section_social_score, section_social_score_group, sector_score, sector_score_group, segment_strength_score, tags, target_price, target_price_to_last_close, price_target_note, theme_ids, ticker_symbol, total_debt_to_equity, total_debt_to_capital_percent, total_revenues, total_revenues_one_year_growth_percentage, updated_at, website, trading_item_id</br>
|
|
10726
10754
|
*/
|
|
10727
10755
|
returns?: string;
|
|
10728
10756
|
/**
|
|
@@ -10806,6 +10834,11 @@ export class Screener<HandleError extends boolean = boolean, Format extends Case
|
|
|
10806
10834
|
* @pattern ^-?[0-9]+(?:,-?[0-9]+)*$
|
|
10807
10835
|
*/
|
|
10808
10836
|
csa_industry_id?: string;
|
|
10837
|
+
/**
|
|
10838
|
+
* Tags
|
|
10839
|
+
* Comma-separated list of unique tags. <br>Example: tenant:111,tenant:222</br>
|
|
10840
|
+
*/
|
|
10841
|
+
tags?: string;
|
|
10809
10842
|
/**
|
|
10810
10843
|
* Implied Market Cap Gte
|
|
10811
10844
|
* Companies with market cap greater than or equal to.
|
|
@@ -11396,6 +11429,11 @@ export class Screener<HandleError extends boolean = boolean, Format extends Case
|
|
|
11396
11429
|
* Target price to last close less than or equal to.
|
|
11397
11430
|
*/
|
|
11398
11431
|
target_price_to_last_close__lte?: number;
|
|
11432
|
+
/**
|
|
11433
|
+
* Price Target Note
|
|
11434
|
+
* Filter by analyst-vs-target-price contradiction signal.
|
|
11435
|
+
*/
|
|
11436
|
+
price_target_note?: boolean | null;
|
|
11399
11437
|
/**
|
|
11400
11438
|
* Fund Id
|
|
11401
11439
|
* Comma-separated fund ids to filter stocks within the funds.
|
|
@@ -12363,6 +12401,18 @@ export class Users<HandleError extends boolean = boolean, Format extends CaseFor
|
|
|
12363
12401
|
authorization: string;
|
|
12364
12402
|
}, config?: RequestConfig<HandleError>): Promise<ClientResponse<BridgeWiseMachineDetailsResponse, HandleError, Format>>;
|
|
12365
12403
|
}
|
|
12404
|
+
export class VtMarkets<HandleError extends boolean = boolean, Format extends CaseFormat = CaseFormat.Original> {
|
|
12405
|
+
protected readonly apiClient: JwtClient<HandleError, Format>;
|
|
12406
|
+
constructor(apiClient: JwtClient<HandleError, Format>);
|
|
12407
|
+
/**
|
|
12408
|
+
* @tags vt-markets
|
|
12409
|
+
* @name ReceiveAlerts
|
|
12410
|
+
* @summary Receive Alerts
|
|
12411
|
+
* @request POST:/vt-markets/alerts
|
|
12412
|
+
* @secure
|
|
12413
|
+
*/
|
|
12414
|
+
receiveAlerts(data: any, config?: RequestConfig<HandleError>): Promise<ClientResponse<any, HandleError, Format>>;
|
|
12415
|
+
}
|
|
12366
12416
|
export class BridgeWiseApi<HandleError extends boolean = false, Format extends CaseFormat = CaseFormat.Original> extends BaseApi<HandleError, Format, JwtClient<HandleError, Format>> {
|
|
12367
12417
|
readonly config: JwtClientConfig<HandleError, Format>;
|
|
12368
12418
|
activities: Activities<HandleError, Format>;
|
|
@@ -12404,6 +12454,7 @@ export class BridgeWiseApi<HandleError extends boolean = false, Format extends C
|
|
|
12404
12454
|
tenants: Tenants<HandleError, Format>;
|
|
12405
12455
|
themes: Themes<HandleError, Format>;
|
|
12406
12456
|
users: Users<HandleError, Format>;
|
|
12457
|
+
vtMarkets: VtMarkets<HandleError, Format>;
|
|
12407
12458
|
constructor(config: JwtClientConfig<HandleError, Format>);
|
|
12408
12459
|
}
|
|
12409
12460
|
|