import {z} from 'zod' export type GetApiV1FndStocksTickerFinancialsConceptArgs = {'Accept-Encoding': 'gzip', ticker: string, concept: string, taxonomy?: string | undefined}; export type GetApiV1FndStocksTickerFinancialsConceptOptions = {baseUrl?: string | undefined, ApiKeyHeader?: string | undefined, fetch?: typeof fetch | undefined}; export const metricValue = z.object({value: z.number().optional(), unit: z.string().optional(), period_start: z.string().optional(), period_end: z.string().optional(), fiscal_year: z.number().int().optional(), fiscal_period: z.string().optional(), form: z.string().optional(), accession: z.string().optional(), filed_at: z.string().optional()}); export const financialConcept = z.object({ticker: z.string().optional(), cik: z.string().optional(), taxonomy: z.string().optional(), concept: z.string().optional(), label: z.string().optional(), description: z.string().optional(), series: z.array(metricValue).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 }; /** * One XBRL concept (gzip required) * * GET /v1/fnd/stocks/{ticker}/financials/{concept} * * Also accepts auth: ApiKeyQuery */ export const getApiV1FndStocksTickerFinancialsConcept = async (args: GetApiV1FndStocksTickerFinancialsConceptArgs, options?: GetApiV1FndStocksTickerFinancialsConceptOptions) => { const {baseUrl = "https://api.sifting.io", fetch: fetchFn = fetch, ApiKeyHeader} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args['Accept-Encoding'] != null) headers.set("Accept-Encoding", String(args['Accept-Encoding'])) if (args.taxonomy != null) query.append("taxonomy", String(args.taxonomy)) if (ApiKeyHeader !== undefined) headers.set("X-API-Key", ApiKeyHeader) const url = `${baseUrl.replace(/\/+$/, '')}/v1/fnd/stocks/${encodeURIComponent(String(args.ticker))}/financials/${encodeURIComponent(String(args.concept))}${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(financialConcept, await res.json()) };