import {z} from 'zod' export type GetApiFinancialsRatiosSymbolArgs = {symbol: string, period?: ('annual' | 'quarter') | undefined, datatype?: ('json' | 'csv') | undefined, limit?: number | undefined}; export type GetApiFinancialsRatiosSymbolOptions = {baseUrl: string, ApiKeyAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const getApiFinancialsRatiosSymbolResponse = z.array(z.object({date: z.string().optional(), symbol: z.string().optional(), "calendar-year": z.string().optional(), period: z.string().optional(), "current-ratio": z.number().optional(), "quick-ratio": z.number().optional(), "cash-ratio": z.number().optional(), "days-of-sales-outstanding": z.number().optional(), "days-of-inventory-outstanding": z.number().optional(), "operating-cycle": z.number().optional(), "days-of-payables-outstanding": z.number().optional(), "cash-conversion-cycle": z.number().optional(), "gross-profit-margin": z.number().optional(), "operating-profit-margin": z.number().optional(), "pretax-profit-margin": z.number().optional(), "net-profit-margin": z.number().optional(), "effective-tax-rate": z.number().optional(), "return-on-assets": z.number().optional(), "return-on-equity": z.number().optional(), "return-on-capital-employed": z.number().optional(), "net-income-per-ebt": z.number().optional(), "ebt-per-ebit": z.number().optional(), "ebit-per-revenue": z.number().optional(), "debt-ratio": z.number().optional(), "debt-equity-ratio": z.number().optional(), "long-term-debt-to-capitalization": z.number().optional(), "total-debt-to-capitalization": z.number().optional(), "interest-coverage": z.number().optional(), "cash-flow-to-debt-ratio": z.number().optional(), "company-equity-multiplier": z.number().optional(), "receivables-turnover": z.number().optional(), "payables-turnover": z.number().optional(), "inventory-turnover": z.number().optional(), "fixed-asset-turnover": z.number().optional(), "asset-turnover": z.number().optional(), "operating-cash-flow-per-share": z.number().optional(), "free-cash-flow-per-share": z.number().optional(), "cash-per-share": z.number().optional(), "payout-ratio": z.number().optional(), "operating-cash-flow-sales-ratio": z.number().optional(), "free-cash-flow-operating-cash-flow-ratio": z.number().optional(), "cash-flow-coverage-ratios": z.number().optional(), "short-term-coverage-ratios": z.number().optional(), "capital-expenditure-coverage-ratio": z.number().optional(), "dividend-paid-and-capex-coverage-ratio": z.number().optional(), "dividend-payout-ratio": z.number().optional(), "price-book-value-ratio": z.number().optional(), "price-to-book-ratio": z.number().optional(), "price-to-sales-ratio": z.number().optional(), "price-earnings-ratio": z.number().optional(), "price-to-free-cash-flows-ratio": z.number().optional(), "price-to-operating-cash-flows-ratio": z.number().optional(), "price-cash-flow-ratio": z.number().optional(), "price-earnings-to-growth-ratio": z.number().optional(), "price-sales-ratio": z.number().optional(), "dividend-yield": z.number().optional(), "enterprise-value-multiple": z.number().optional(), "price-fair-value": z.number().optional()})); 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 }; /** * Get Annual Financial Ratios * * GET /financials/ratios/{symbol} */ export const getApiFinancialsRatiosSymbol = async (args: GetApiFinancialsRatiosSymbolArgs, options: GetApiFinancialsRatiosSymbolOptions) => { const {baseUrl, fetch: fetchFn = fetch, ApiKeyAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.period != null) query.append("period", String(args.period)) if (args.datatype != null) query.append("datatype", String(args.datatype)) if (args.limit != null) query.append("limit", String(args.limit)) if (ApiKeyAuth !== undefined) headers.set("X-API-KEY", ApiKeyAuth) const url = `${baseUrl.replace(/\/+$/, '')}/financials/ratios/${encodeURIComponent(String(args.symbol))}${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(getApiFinancialsRatiosSymbolResponse, await res.json()) };