import {z} from 'zod' export type GetApiV1StocksTickerOptionsTermStructureArgs = {ticker: string, maxExpirations?: number | undefined}; export type GetApiV1StocksTickerOptionsTermStructureOptions = {baseUrl?: string | undefined, ApiKey?: string | undefined, fetch?: typeof fetch | undefined}; export const optionTermStructureRowDto = z.object({expiration: z.string().optional(), daysToExpiration: z.number().int().optional(), available: z.boolean().optional(), atmImpliedVolatility: z.number().nullable().optional(), expectedMove: z.number().nullable().optional(), expectedMovePercentOfClose: z.number().nullable().optional(), putCallOpenInterestRatio: z.number().nullable().optional(), putCallVolumeRatio: z.number().nullable().optional(), volumeSession: z.string().nullable().optional(), maxPainStrike: z.number().nullable().optional()}); export const optionTermStructureResponse = z.object({ticker: z.string().nullable().optional(), companyName: z.string().nullable().optional(), underlyingClose: z.number().nullable().optional(), underlyingCloseDate: z.string().nullable().optional(), truncated: z.boolean().optional(), delayed: z.boolean().optional(), expirations: z.array(optionTermStructureRowDto).nullable().optional()}); 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 }; /** * The nearest upcoming expirations side by side, ascending: at-the-money implied volatility, the at-the-money straddle's mid as a market-implied expected move, put/call ratios and max pain for each. An expiration that could not be read stays in the list with `available: false`. Nothing here is a forecast. Pro reads real-time quotes and Plus delayed indicative quotes; the Free plan covers end-of-day data only and receives 403. US listings only. * * GET /v1/stocks/{ticker}/options/term-structure */ export const getApiV1StocksTickerOptionsTermStructure = async (args: GetApiV1StocksTickerOptionsTermStructureArgs, options?: GetApiV1StocksTickerOptionsTermStructureOptions) => { const {baseUrl = "https://api.equibles.com", fetch: fetchFn = fetch, ApiKey} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.maxExpirations != null) query.append("maxExpirations", String(args.maxExpirations)) if (ApiKey !== undefined) headers.set('authorization', `Bearer ${ApiKey}`) const url = `${baseUrl.replace(/\/+$/, '')}/v1/stocks/${encodeURIComponent(String(args.ticker))}/options/term-structure${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(optionTermStructureResponse, await res.json()) };