import {z} from 'zod' export type GetApiV1UnderlyingTickerByStrikeStrikeExpirationsArgs = {ticker: string, strike: string, interval?: ('1D' | '1W' | '7D') | undefined, dte_filter?: ('all' | '0-7' | '8-30' | '31-90' | '90+') | undefined, date?: string | undefined}; export type GetApiV1UnderlyingTickerByStrikeStrikeExpirationsOptions = {baseUrl?: string | undefined, bearerApiKey?: string | undefined, fetch?: typeof fetch | undefined}; export const expirationDistributionBar = z.object({expiration: z.string(), dte: z.number().int(), callVolume: z.number().int().gte(0), putVolume: z.number().int().gte(0), callPremium: z.number(), putPremium: z.number()}); export const expirationDistributionResponse = z.object({ticker: z.string(), strike: z.number(), interval: z.enum(["1D", "1W", "7D"]), totalCallPremium: z.number(), totalPutPremium: z.number(), topExpiration: z.string(), expirationCount: z.number().int().gte(0), bars: z.array(expirationDistributionBar)}); export const meta = z.object({timestamp: z.string(), requestId: z.string()}); export const expirationDistributionSuccess = z.object({data: expirationDistributionResponse, 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 }; /** * Premium / volume by expiration for a strike * * GET /v1/underlying/{ticker}/by-strike/{strike}/expirations */ export const getApiV1UnderlyingTickerByStrikeStrikeExpirations = async (args: GetApiV1UnderlyingTickerByStrikeStrikeExpirationsArgs, options?: GetApiV1UnderlyingTickerByStrikeStrikeExpirationsOptions) => { 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.dte_filter != null) query.append("dte_filter", String(args.dte_filter)) if (args.date != null) query.append("date", String(args.date)) if (bearerApiKey !== undefined) headers.set('authorization', `Bearer ${bearerApiKey}`) const url = `${baseUrl.replace(/\/+$/, '')}/v1/underlying/${encodeURIComponent(String(args.ticker))}/by-strike/${encodeURIComponent(String(args.strike))}/expirations${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(expirationDistributionSuccess, await res.json()) };