import {z} from 'zod' export type GetApiV1ContractTopWeeklyArgs = {limit?: number | undefined, date?: string | undefined, ticker?: string | undefined, min_premium?: number | undefined, max_premium?: number | undefined, min_volume?: number | undefined, max_volume?: number | undefined, min_oi?: number | undefined, max_oi?: number | undefined, right?: ('C' | 'P') | undefined, min_dte?: number | undefined, max_dte?: number | undefined, min_strike?: number | undefined, max_strike?: number | undefined, expiration?: string | undefined, min_iv?: number | undefined, max_iv?: number | undefined, order_by?: ('premium' | 'volume' | 'oi' | 'iv') | undefined, order?: ('asc' | 'desc') | undefined, only_sweeps?: boolean | undefined, only_multi_leg?: boolean | undefined, exclude_multi_leg?: boolean | undefined}; export type GetApiV1ContractTopWeeklyOptions = {baseUrl?: string | undefined, bearerApiKey?: string | undefined, fetch?: typeof fetch | undefined}; export const topContractItem = z.object({symbol: z.string(), ticker: z.string(), expiration: z.string(), strike: z.number(), right: z.enum(["C", "P"]), dte: z.number().int(), totalPremium: z.number(), totalVolume: z.number().int().gte(0), openInterest: z.number().int().gte(0), oiChange: z.number().int(), volumeOiRatio: z.number(), bidVolume: z.number().int().gte(0), askVolume: z.number().int().gte(0), midVolume: z.number().int().gte(0), vwap: z.number(), lastPrice: z.number(), underlyingPrice: z.number(), iv: z.number(), tradeCount: z.number().int().gte(0), sweepVolume: z.number().int().gte(0), sweepPremium: z.number(), multiLegVolume: z.number().int().gte(0), multiLegPremium: z.number()}); export const meta = z.object({timestamp: z.string(), requestId: z.string()}); export const topContractListSuccess = z.object({data: z.array(topContractItem), 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 }; /** * Top contracts by trailing-5-day flow * * GET /v1/contract/top/weekly */ export const getApiV1ContractTopWeekly = async (args: GetApiV1ContractTopWeeklyArgs, options?: GetApiV1ContractTopWeeklyOptions) => { 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.limit != null) query.append("limit", String(args.limit)) if (args.date != null) query.append("date", String(args.date)) if (args.ticker != null) query.append("ticker", String(args.ticker)) if (args.min_premium != null) query.append("min_premium", String(args.min_premium)) if (args.max_premium != null) query.append("max_premium", String(args.max_premium)) if (args.min_volume != null) query.append("min_volume", String(args.min_volume)) if (args.max_volume != null) query.append("max_volume", String(args.max_volume)) if (args.min_oi != null) query.append("min_oi", String(args.min_oi)) if (args.max_oi != null) query.append("max_oi", String(args.max_oi)) if (args.right != null) query.append("right", String(args.right)) if (args.min_dte != null) query.append("min_dte", String(args.min_dte)) if (args.max_dte != null) query.append("max_dte", String(args.max_dte)) if (args.min_strike != null) query.append("min_strike", String(args.min_strike)) if (args.max_strike != null) query.append("max_strike", String(args.max_strike)) if (args.expiration != null) query.append("expiration", String(args.expiration)) if (args.min_iv != null) query.append("min_iv", String(args.min_iv)) if (args.max_iv != null) query.append("max_iv", String(args.max_iv)) 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.only_sweeps != null) query.append("only_sweeps", String(args.only_sweeps)) if (args.only_multi_leg != null) query.append("only_multi_leg", String(args.only_multi_leg)) if (args.exclude_multi_leg != null) query.append("exclude_multi_leg", String(args.exclude_multi_leg)) if (bearerApiKey !== undefined) headers.set('authorization', `Bearer ${bearerApiKey}`) const url = `${baseUrl.replace(/\/+$/, '')}/v1/contract/top/weekly${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(topContractListSuccess, await res.json()) };