import {z} from 'zod' export type GetApiApiV1ShortInterestSymbolSymbolArgs = {symbol: string, limit?: number | undefined}; export type GetApiApiV1ShortInterestSymbolSymbolOptions = {baseUrl?: string | undefined, APIKeyHeader?: string | undefined, fetch?: typeof fetch | undefined}; export const historyRecency = z.object({proven_most_recent: z.boolean().nullable().optional(), reason: z.string().nullable().optional(), note: z.string().nullable().optional(), qualifies: z.array(z.string().nullable()).nullable().optional()}).and(z.record(z.string(), z.unknown())); export const historyCompleteness = z.object({complete: z.boolean().nullable().optional(), reason: z.string().nullable().optional(), note: z.string().nullable().optional()}).and(z.record(z.string(), z.unknown())); export const issuerAttribution = z.object({attribution: z.string().nullable().optional(), current_name: z.string().nullable().optional(), current_company_id: z.string().nullable().optional(), reassigned_on: z.string().nullable().optional(), excluded_predating: z.union([z.number().int(), z.number()]).nullable().optional(), name_mismatch: z.array(z.string().nullable()).nullable().optional(), note: z.string().nullable().optional()}).and(z.record(z.string(), z.unknown())); export const shortInterestRecord = z.object({symbol: z.string().nullable().optional(), date: z.string().nullable().optional(), short_volume: z.union([z.number().int(), z.number()]).nullable().optional(), total_volume: z.union([z.number().int(), z.number()]).nullable().optional(), short_exempt_volume: z.union([z.number().int(), z.number()]).nullable().optional(), short_pct: z.union([z.number().int(), z.number()]).nullable().optional(), market: z.string().nullable().optional(), facility: z.string().nullable().optional()}).and(z.record(z.string(), z.unknown())); export const shortInterestDailyVolumeSymbolData = z.object({symbol: z.string().nullable().optional(), recency: historyRecency.nullable().optional(), history: historyCompleteness.nullable().optional(), issuer: issuerAttribution.nullable().optional(), count: z.union([z.number().int(), z.number()]).nullable().optional(), records: z.array(shortInterestRecord).nullable().optional()}).and(z.record(z.string(), z.unknown())); export const sugraMeta = z.object({endpoint: z.string(), data_time: z.string(), response_time: z.string(), provider: z.string(), data_age_days: z.number().nullable().optional(), source: z.string().nullable().optional(), attribution: z.string().nullable().optional(), source_url: z.string().nullable().optional(), citation: z.string().nullable().optional(), fallback_used: z.boolean().nullable().optional(), fallback_chain: z.array(z.string()).nullable().optional(), cached: z.boolean().nullable().optional(), stale: z.boolean().nullable().optional(), stale_since: z.string().nullable().optional(), period: z.string().nullable().optional(), notes: z.string().nullable().optional()}); export const envelopeShortInterestDailyVolumeSymbolData = z.object({data: shortInterestDailyVolumeSymbolData, meta: sugraMeta}); 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 }; /** * Short interest history for a stock * * GET /api/v1/short-interest/symbol/{symbol} */ export const getApiApiV1ShortInterestSymbolSymbol = async (args: GetApiApiV1ShortInterestSymbolSymbolArgs, options?: GetApiApiV1ShortInterestSymbolSymbolOptions) => { const {baseUrl = "https://sugra.ai", fetch: fetchFn = fetch, APIKeyHeader} = 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 (APIKeyHeader !== undefined) headers.set("x-api-key", APIKeyHeader) const url = `${baseUrl.replace(/\/+$/, '')}/api/v1/short-interest/symbol/${encodeURIComponent(String(args.symbol))}${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(envelopeShortInterestDailyVolumeSymbolData, await res.json()) };