import {z} from 'zod' export type GetApiV1ContractSymbolRvolArgs = {symbol: string, interval?: string | undefined, bucket?: ('1min' | '5min' | '10min' | '15min' | '30min' | '1d' | '1w') | undefined, avg_period?: string | undefined, date?: string | undefined, order_by?: ('rvol' | 'volume' | 'premium' | 'time') | undefined, order?: ('asc' | 'desc') | undefined, limit?: number | undefined, format?: ('full' | 'summary') | undefined}; export type GetApiV1ContractSymbolRvolOptions = {baseUrl?: string | undefined, bearerApiKey?: string | undefined, fetch?: typeof fetch | undefined}; export const contractRvolBar = z.object({timestamp: z.string(), timestampEnd: z.string(), volume: z.number().int().gte(0), premium: z.number(), avgVolume: z.number().nullable().optional(), avgPremium: z.number().nullable().optional(), avgDaysCount: z.number().int().nullable().optional()}); export const rvolStats = z.object({todayVolume: z.number().int().gte(0), todayPremium: z.number(), avgVolume: z.number(), avgPremium: z.number(), rvolVolume: z.number(), rvolPremium: z.number(), avgDaysCount: z.number().int().gte(0)}); export const contractRvolResponse = z.object({bars: z.array(contractRvolBar), stats: rvolStats}); export const meta = z.object({timestamp: z.string(), requestId: z.string()}); export const contractRvolSuccess = z.object({data: contractRvolResponse, meta: meta}); 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 }; /** * Relative-volume bars for a contract * * GET /v1/contract/{symbol}/rvol */ export const getApiV1ContractSymbolRvol = async (args: GetApiV1ContractSymbolRvolArgs, options?: GetApiV1ContractSymbolRvolOptions) => { const {baseUrl = "https://flow-api.skylit.ai", fetch: fetchFn = fetch, bearerApiKey} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.interval != null) query.append("interval", String(args.interval)) if (args.bucket != null) query.append("bucket", String(args.bucket)) if (args.avg_period != null) query.append("avg_period", String(args.avg_period)) if (args.date != null) query.append("date", String(args.date)) if (args.order_by != null) query.append("order_by", String(args.order_by)) if (args.order != null) query.append("order", String(args.order)) if (args.limit != null) query.append("limit", String(args.limit)) if (args.format != null) query.append("format", String(args.format)) if (bearerApiKey !== undefined) headers.set('authorization', `Bearer ${bearerApiKey}`) const url = `${baseUrl.replace(/\/+$/, '')}/v1/contract/${encodeURIComponent(String(args.symbol))}/rvol${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(contractRvolSuccess, await res.json()) };