import {z} from 'zod' export type GetApiMutualFundsWorldArgs = {symbol?: string | undefined, figi?: string | undefined, isin?: string | undefined, cusip?: string | undefined, country?: string | undefined, dp?: number | undefined}; export type GetApiMutualFundsWorldOptions = {baseUrl?: string | undefined, authorizationHeader?: string | undefined, fetch?: typeof fetch | undefined}; export const getApiMutualFundsWorldResponse = z.object({mutual_fund: z.object({summary: z.object({symbol: z.string().optional(), name: z.string().optional(), fund_family: z.string().optional(), fund_type: z.string().optional(), currency: z.string().optional(), share_class_inception_date: z.string().optional(), ytd_return: z.number().optional(), expense_ratio_net: z.number().optional(), yield: z.number().optional(), nav: z.number().optional(), min_investment: z.number().int().optional(), turnover_rate: z.number().optional(), net_assets: z.number().int().optional(), overview: z.string().optional(), people: z.array(z.object({name: z.string().optional(), tenure_since: z.string().optional()})).optional()}).optional(), performance: z.object({trailing_returns: z.array(z.object({period: z.string().optional(), share_class_return: z.number().optional(), category_return: z.number().optional(), rank_in_category: z.number().int().optional()})).optional(), annual_total_returns: z.array(z.object({year: z.number().int().optional(), share_class_return: z.number().optional(), category_return: z.number().optional()})).optional(), quarterly_total_returns: z.array(z.object({year: z.number().int().optional(), q1: z.number().optional(), q2: z.number().optional(), q3: z.number().optional(), q4: z.number().optional()})).optional(), load_adjusted_return: z.array(z.object({period: z.string().optional(), return: z.number().optional()})).optional()}).optional(), risk: z.object({volatility_measures: z.array(z.object({period: z.string().optional(), alpha: z.number().optional(), alpha_category: z.number().optional(), beta: z.number().optional(), beta_category: z.number().optional(), mean_annual_return: z.number().optional(), mean_annual_return_category: z.number().optional(), r_squared: z.number().optional(), r_squared_category: z.number().optional(), std: z.number().optional(), std_category: z.number().optional(), sharpe_ratio: z.number().optional(), sharpe_ratio_category: z.number().optional(), treynor_ratio: z.number().optional(), treynor_ratio_category: z.number().optional()})).optional(), valuation_metrics: z.object({price_to_earnings: z.number().optional(), price_to_earnings_category: z.number().optional(), price_to_book: z.number().optional(), price_to_book_category: z.number().optional(), price_to_sales: z.number().optional(), price_to_sales_category: z.number().optional(), price_to_cashflow: z.number().optional(), price_to_cashflow_category: z.number().optional(), median_market_capitalization: z.number().int().optional(), median_market_capitalization_category: z.number().int().optional(), "3_year_earnings_growth": z.number().optional(), "3_year_earnings_growths_category": z.number().optional()}).optional()}).optional(), ratings: z.object({performance_rating: z.number().int().optional(), risk_rating: z.number().int().optional(), return_rating: z.number().int().optional()}).optional(), composition: z.object({major_market_sectors: z.array(z.object({sector: z.string().optional(), weight: z.number().optional()})).optional(), top_holdings: z.array(z.object({symbol: z.string().optional(), name: z.string().optional(), exchange: z.string().optional(), mic_code: z.string().optional(), weight: z.number().optional()})).optional(), asset_allocation: z.object({cash: z.number().optional(), stocks: z.number().optional(), preferred_stocks: z.number().optional(), convertables: z.number().optional(), bonds: z.number().optional(), others: z.number().optional()}).optional(), bond_breakdown: z.object({average_maturity: z.object({fund: z.number().optional(), category: z.number().optional()}).optional(), average_duration: z.object({fund: z.number().optional(), category: z.number().optional()}).optional(), credit_quality: z.array(z.object({grade: z.string().optional(), weight: z.number().optional()})).optional()}).optional()}).optional(), purchase_info: z.object({expenses: z.object({expense_ratio_gross: z.number().optional(), expense_ratio_net: z.number().optional()}).optional(), minimums: z.object({initial_investment: z.number().int().optional(), additional_investment: z.number().int().optional(), initial_ira_investment: z.number().int().optional(), additional_ira_investment: z.number().int().optional()}).optional(), pricing: z.object({nav: z.number().optional(), "12_month_low": z.number().optional(), "12_month_high": z.number().optional(), last_month: z.number().optional()}).optional(), brokerages: z.array(z.string()).optional()}).optional(), sustainability: z.object({score: z.number().int().optional(), corporate_esg_pillars: z.object({environmental: z.number().optional(), social: z.number().optional(), governance: z.number().optional()}).optional(), sustainable_investment: z.boolean().optional(), corporate_aum: z.number().optional()}).optional()}), status: z.string()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * MF full data * * GET /mutual_funds/world * * Also accepts auth: queryParameter */ export const getApiMutualFundsWorld = async (args: GetApiMutualFundsWorldArgs, options?: GetApiMutualFundsWorldOptions) => { const {baseUrl = "https://api.twelvedata.com", fetch: fetchFn = fetch, authorizationHeader} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.symbol != null) query.append("symbol", String(args.symbol)) if (args.figi != null) query.append("figi", String(args.figi)) if (args.isin != null) query.append("isin", String(args.isin)) if (args.cusip != null) query.append("cusip", String(args.cusip)) if (args.country != null) query.append("country", String(args.country)) if (args.dp != null) query.append("dp", String(args.dp)) if (authorizationHeader !== undefined) headers.set("Authorization", authorizationHeader) const url = `${baseUrl.replace(/\/+$/, '')}/mutual_funds/world${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(getApiMutualFundsWorldResponse, await res.json()) };