import {z} from 'zod' export type GetApiApiV1CboePutCallRatioHistoryArgs = {family: string, start?: (string | null) | undefined, end?: (string | null) | undefined, limit?: (number | null) | undefined}; export type GetApiApiV1CboePutCallRatioHistoryOptions = {baseUrl?: string | undefined, APIKeyHeader?: string | undefined, fetch?: typeof fetch | undefined}; export const putCallDefinitionChangeV1 = z.object({date: z.string(), note: z.string()}); export const putCallCoverageV1 = z.object({dataset_end: z.string().nullable().optional(), gap_from: z.string().nullable().optional(), gap_to: z.string().nullable().optional(), tail_error: z.boolean().optional()}); export const putCallHistoryRowV1 = z.object({date: z.string(), ratio: z.number().nullable().optional(), call_volume: z.number().int().nullable().optional(), put_volume: z.number().int().nullable().optional(), total_volume: z.number().int().nullable().optional(), call_open_interest: z.number().int().nullable().optional(), put_open_interest: z.number().int().nullable().optional(), total_open_interest: z.number().int().nullable().optional()}); export const putCallHistoryData = z.object({family: z.string(), available_from: z.string().nullable().optional(), dataset_end: z.string().nullable().optional(), definition_changes: z.array(putCallDefinitionChangeV1).optional(), coverage: putCallCoverageV1.nullable().optional(), truncated: z.boolean().optional(), count: z.number().int(), rows: z.array(putCallHistoryRowV1).optional()}); export const sugraMeta = z.object({endpoint: z.string(), data_time: z.string(), response_time: z.string(), provider: z.string(), data_age_days: z.number().nullable().optional(), source: z.string().nullable().optional(), attribution: z.string().nullable().optional(), source_url: z.string().nullable().optional(), citation: z.string().nullable().optional(), fallback_used: z.boolean().nullable().optional(), fallback_chain: z.array(z.string()).nullable().optional(), cached: z.boolean().nullable().optional(), stale: z.boolean().nullable().optional(), stale_since: z.string().nullable().optional(), period: z.string().nullable().optional(), notes: z.string().nullable().optional()}); export const envelopePutCallHistoryData = z.object({data: putCallHistoryData, meta: sugraMeta}); 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 }; /** * Put/call ratio history (20-year stitched series) * * GET /api/v1/cboe/put-call-ratio/history */ export const getApiApiV1CboePutCallRatioHistory = async (args: GetApiApiV1CboePutCallRatioHistoryArgs, options?: GetApiApiV1CboePutCallRatioHistoryOptions) => { const {baseUrl = "https://sugra.ai", fetch: fetchFn = fetch, APIKeyHeader} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.family != null) query.append("family", String(args.family)) if (args.start != null) query.append("start", String(args.start)) if (args.end != null) query.append("end", String(args.end)) if (args.limit != null) query.append("limit", String(args.limit)) if (APIKeyHeader !== undefined) headers.set("x-api-key", APIKeyHeader) const url = `${baseUrl.replace(/\/+$/, '')}/api/v1/cboe/put-call-ratio/history${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(envelopePutCallHistoryData, await res.json()) };