import {z} from 'zod' export type GetApiApiFinancialsScoresArgs = {symbol?: string | undefined, cik?: number | undefined, cusip?: string | undefined, composite_figi?: string | undefined, share_class_figi?: string | undefined}; export type GetApiApiFinancialsScoresOptions = {baseUrl?: string | undefined, bearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const fiscalPeriod = z.enum(["FY", "Q1", "Q2", "Q3", "Q4", "TTM"]); export const altmanZone = z.enum(["safe", "grey", "distress"]); export const getApiApiFinancialsScoresResponse = z.object({period: z.string().optional(), fiscalYear: z.number().int().optional(), fiscalPeriod: fiscalPeriod.optional(), piotroskiFScore: z.number().int().gte(0).lte(9).optional(), piotroskiDetails: z.object({positiveNetIncome: z.boolean().optional(), positiveOperatingCashFlow: z.boolean().optional(), risingRoa: z.boolean().optional(), cashFlowExceedsNetIncome: z.boolean().optional(), decliningLeverage: z.boolean().optional(), risingCurrentRatio: z.boolean().optional(), noShareDilution: z.boolean().optional(), risingGrossMargin: z.boolean().optional(), risingAssetTurnover: z.boolean().optional()}).optional(), altmanZScore: z.number().nullable().optional(), altmanZone: altmanZone.nullable().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 }; /** * Financial health scores * * GET /api/financials/scores */ export const getApiApiFinancialsScores = async (args: GetApiApiFinancialsScoresArgs, options?: GetApiApiFinancialsScoresOptions) => { const {baseUrl = "https://api.stockfit.io/v1", fetch: fetchFn = fetch, bearerAuth} = 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.cik != null) query.append("cik", String(args.cik)) if (args.cusip != null) query.append("cusip", String(args.cusip)) if (args.composite_figi != null) query.append("composite_figi", String(args.composite_figi)) if (args.share_class_figi != null) query.append("share_class_figi", String(args.share_class_figi)) if (bearerAuth !== undefined) headers.set('authorization', `Bearer ${bearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/api/financials/scores${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(getApiApiFinancialsScoresResponse, await res.json()) };