import {z} from 'zod' export type ResponseFormat = 'json' | 'csv' | 'csv_gzip'; export type GetApiV1DataUsEquityOptRefOccEqSpecSettlArgs = {sort?: (string | null) | undefined, columns?: (string | null) | undefined, offset?: number | undefined, limit?: number | undefined, response_format?: ResponseFormat | undefined}; export type GetApiV1DataUsEquityOptRefOccEqSpecSettlOptions = {baseUrl?: string | undefined, APIKeyAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const oCCEquitiesSpecialSettlementsDataDetailsOut = z.object({ProcessDate: z.string().nullable().optional(), SettlementDate: z.string().nullable().optional(), OptionTicker: z.string().nullable().optional(), UnderTicker: z.string().nullable().optional(), UnderType: z.string().nullable().optional(), StrikeCurrency: z.string().nullable().optional(), TotalDelivComponents: z.number().int().nullable().optional(), DeliveryComponents: z.number().int().nullable().optional(), SettlementMethod: z.string().nullable().optional(), StrikePercent: z.number().int().nullable().optional(), DeliverableUnits: z.number().int().nullable().optional(), CashAmount: z.number().nullable().optional()}); export const paginationDetailsOut = z.object({offset: z.number().int().optional(), limit: z.number().int(), next_offset: z.number().int().nullable().optional()}); export const oCCEquitiesSpecialSettlementsDataOut = z.object({data: z.array(oCCEquitiesSpecialSettlementsDataDetailsOut), pagination: paginationDetailsOut}); 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 }; /** * OCC Equities Special Settlements * * GET /v1/data/us-equity-opt-ref/occ-eq-spec-settl */ export const getApiV1DataUsEquityOptRefOccEqSpecSettl = async (args: GetApiV1DataUsEquityOptRefOccEqSpecSettlArgs, options?: GetApiV1DataUsEquityOptRefOccEqSpecSettlOptions) => { const {baseUrl = "https://api.algoseek.com", fetch: fetchFn = fetch, APIKeyAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.sort != null) query.append("sort", String(args.sort)) if (args.columns != null) query.append("columns", String(args.columns)) if (args.offset != null) query.append("offset", String(args.offset)) if (args.limit != null) query.append("limit", String(args.limit)) if (args.response_format != null) query.append("response_format", String(args.response_format)) if (APIKeyAuth !== undefined) headers.set("X-API-KEY", APIKeyAuth) const url = `${baseUrl.replace(/\/+$/, '')}/v1/data/us-equity-opt-ref/occ-eq-spec-settl${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(oCCEquitiesSpecialSettlementsDataOut, await res.json()) };