import {z} from 'zod' export type GetApiFinancialsKeyMetricsSymbolArgs = {symbol: string, period?: ('annual' | 'quarter') | undefined, datatype?: ('json' | 'csv') | undefined, limit?: number | undefined}; export type GetApiFinancialsKeyMetricsSymbolOptions = {baseUrl: string, ApiKeyAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const getApiFinancialsKeyMetricsSymbolResponse = z.array(z.object({date: z.string().optional(), symbol: z.string().optional(), "calendar-year": z.string().optional(), period: z.string().optional(), "revenue-per-share": z.number().optional(), "net-income-per-share": 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(), "book-value-per-share": z.number().optional(), "tangible-book-value-per-share": z.number().optional(), "shareholders-equity-per-share": z.number().optional(), "interest-debt-per-share": z.number().optional(), "market-cap": z.number().optional(), "enterprise-value": z.number().optional(), "pe-ratio": z.number().optional(), "price-to-sales-ratio": z.number().optional(), pocfratio: z.number().optional(), "pfcf-ratio": z.number().optional(), "pb-ratio": z.number().optional(), "ptb-ratio": z.number().optional(), "ev-to-sales": z.number().optional(), "enterprise-value-over-ebitda": z.number().optional(), "ev-to-operating-cash-flow": z.number().optional(), "ev-to-free-cash-flow": z.number().optional(), "earnings-yield": z.number().optional(), "free-cash-flow-yield": z.number().optional(), "debt-to-equity": z.number().optional(), "debt-to-assets": z.number().optional(), "net-debt-to-ebitda": z.number().optional(), "current-ratio": z.number().optional(), "interest-coverage": z.number().optional(), "income-quality": z.number().optional(), "dividend-yield": z.number().optional(), "payout-ratio": z.number().optional(), "sales-general-and-administrative-to-revenue": z.number().optional(), "research-and-ddevelopement-to-revenue": z.number().optional(), "intangibles-to-total-assets": z.number().optional(), "capex-to-operating-cash-flow": z.number().optional(), "capex-to-revenue": z.number().optional(), "capex-to-depreciation": z.number().optional(), "stock-based-compensation-to-revenue": z.number().optional(), "graham-number": z.number().optional(), roic: z.number().optional(), "return-on-tangible-assets": z.number().optional(), "graham-net-net": z.number().optional(), "working-capital": z.number().optional(), "tangible-asset-value": z.number().optional(), "net-current-asset-value": z.number().optional(), "invested-capital": z.number().optional(), "average-receivables": z.number().optional(), "average-payables": z.number().optional(), "average-inventory": z.number().optional(), "days-sales-outstanding": z.number().optional(), "days-payables-outstanding": z.number().optional(), "days-of-inventory-on-hand": z.number().optional(), "receivables-turnover": z.number().optional(), "payables-turnover": z.number().optional(), "inventory-turnover": z.number().optional(), roe: z.number().optional(), "capex-per-share": 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 Key Metrics * * GET /financials/key-metrics/{symbol} */ export const getApiFinancialsKeyMetricsSymbol = async (args: GetApiFinancialsKeyMetricsSymbolArgs, options: GetApiFinancialsKeyMetricsSymbolOptions) => { 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/key-metrics/${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(getApiFinancialsKeyMetricsSymbolResponse, await res.json()) };