import {z} from 'zod' export type GetApiV1OptionsChainUnderlyingArgs = {format?: ('csv' | 'json') | undefined, underlying: string, date?: string | undefined, expiration?: string | undefined, from?: string | undefined, to?: string | undefined, month?: number | undefined, year?: number | undefined, weekly?: boolean | undefined, monthly?: boolean | undefined, quarterly?: boolean | undefined, dte?: string | undefined, side?: ('call' | 'put') | undefined, range?: ('all' | 'itm' | 'otm') | undefined, strike?: string | undefined, minOpenInterest?: number | undefined, minVolume?: number | undefined, maxBidAskSpread?: number | undefined, maxBidAskSpreadPct?: number | undefined, nonstandard?: boolean | undefined, delta?: string | undefined, strikeLimit?: number | undefined, minBid?: number | undefined, maxBid?: number | undefined, minAsk?: number | undefined, maxAsk?: number | undefined, am?: boolean | undefined, pm?: boolean | undefined, dateformat?: ('spreadsheet' | 'timestamp' | 'unix') | undefined, limit?: number | undefined, offset?: number | undefined, headers?: boolean | undefined, columns?: string | undefined, human?: boolean | undefined}; export type GetApiV1OptionsChainUnderlyingOptions = {baseUrl: string, ApiAuthentication?: string | undefined, fetch?: typeof fetch | undefined}; export const getApiV1OptionsChainUnderlyingResponse = z.record(z.string(), z.unknown()); 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 }; /** * Get a current or historical end of day options chain for an underlying ticker symbol. * * GET /v1/options/chain/{underlying}/ * * Also accepts auth: JWT Authentication */ export const getApiV1OptionsChainUnderlying = async (args: GetApiV1OptionsChainUnderlyingArgs, options: GetApiV1OptionsChainUnderlyingOptions) => { const {baseUrl, fetch: fetchFn = fetch, ApiAuthentication} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.format != null) query.append("format", String(args.format)) if (args.date != null) query.append("date", String(args.date)) if (args.expiration != null) query.append("expiration", String(args.expiration)) if (args.from != null) query.append("from", String(args.from)) if (args.to != null) query.append("to", String(args.to)) if (args.month != null) query.append("month", String(args.month)) if (args.year != null) query.append("year", String(args.year)) if (args.weekly != null) query.append("weekly", String(args.weekly)) if (args.monthly != null) query.append("monthly", String(args.monthly)) if (args.quarterly != null) query.append("quarterly", String(args.quarterly)) if (args.dte != null) query.append("dte", String(args.dte)) if (args.side != null) query.append("side", String(args.side)) if (args.range != null) query.append("range", String(args.range)) if (args.strike != null) query.append("strike", String(args.strike)) if (args.minOpenInterest != null) query.append("minOpenInterest", String(args.minOpenInterest)) if (args.minVolume != null) query.append("minVolume", String(args.minVolume)) if (args.maxBidAskSpread != null) query.append("maxBidAskSpread", String(args.maxBidAskSpread)) if (args.maxBidAskSpreadPct != null) query.append("maxBidAskSpreadPct", String(args.maxBidAskSpreadPct)) if (args.nonstandard != null) query.append("nonstandard", String(args.nonstandard)) if (args.delta != null) query.append("delta", String(args.delta)) if (args.strikeLimit != null) query.append("strikeLimit", String(args.strikeLimit)) if (args.minBid != null) query.append("minBid", String(args.minBid)) if (args.maxBid != null) query.append("maxBid", String(args.maxBid)) if (args.minAsk != null) query.append("minAsk", String(args.minAsk)) if (args.maxAsk != null) query.append("maxAsk", String(args.maxAsk)) if (args.am != null) query.append("am", String(args.am)) if (args.pm != null) query.append("pm", String(args.pm)) if (args.dateformat != null) query.append("dateformat", String(args.dateformat)) if (args.limit != null) query.append("limit", String(args.limit)) if (args.offset != null) query.append("offset", String(args.offset)) if (args.headers != null) query.append("headers", String(args.headers)) if (args.columns != null) query.append("columns", String(args.columns)) if (args.human != null) query.append("human", String(args.human)) if (ApiAuthentication !== undefined) query.set("token", ApiAuthentication) const url = `${baseUrl.replace(/\/+$/, '')}/v1/options/chain/${encodeURIComponent(String(args.underlying))}/${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(getApiV1OptionsChainUnderlyingResponse, await res.json()) };