import {z} from 'zod' export type GetApiV1SecuritiesTickerBeneficialOwnershipArgs = {ticker: string, limit?: number | undefined, offset?: number | undefined}; export type GetApiV1SecuritiesTickerBeneficialOwnershipOptions = {baseUrl?: string | undefined, ApiKey?: string | undefined, fetch?: typeof fetch | undefined}; export const listingNotice = z.object({status: z.string().nullable().optional(), ticker: z.string().nullable().optional(), delistedOn: z.string().nullable().optional(), successorTicker: z.string().nullable().optional()}); export const statedPurposeCategoryDto = z.object({token: z.string().nullable().optional(), name: z.string().nullable().optional(), quote: z.string().nullable().optional()}); export const statedPurposeDto = z.object({state: z.string().nullable().optional(), summary: z.string().nullable().optional(), categories: z.array(statedPurposeCategoryDto).nullable().optional()}); export const beneficialOwnershipPersonDto = z.object({name: z.string().nullable().optional(), cik: z.string().nullable().optional(), typeCodes: z.array(z.string()).nullable().optional(), citizenshipOrOrganization: z.string().nullable().optional(), aggregateAmountOwned: z.number().int().optional(), percentOfClass: z.number().nullable().optional(), soleVotingPower: z.number().int().optional(), sharedVotingPower: z.number().int().optional(), soleDispositivePower: z.number().int().optional(), sharedDispositivePower: z.number().int().optional(), isLead: z.boolean().optional()}); export const beneficialOwnershipBlockDto = z.object({filerName: z.string().nullable().optional(), filerCik: z.string().nullable().optional(), filingType: z.string().nullable().optional(), isAmendment: z.boolean().optional(), eventDate: z.string().optional(), filingDate: z.string().optional(), accessionNumber: z.string().nullable().optional(), rules: z.array(z.string()).nullable().optional(), shares: z.number().int().optional(), filedShares: z.number().int().optional(), percentOfClass: z.number().nullable().optional(), changeShares: z.number().int().nullable().optional(), priorEventDate: z.string().nullable().optional(), splitUnresolved: z.boolean().optional(), hasCoverPage: z.boolean().optional(), status: z.string().nullable().optional(), purpose: statedPurposeDto.optional(), persons: z.array(beneficialOwnershipPersonDto).nullable().optional()}); export const pageMeta = z.object({limit: z.number().int().optional(), offset: z.number().int().optional(), count: z.number().int().optional(), hasMore: z.boolean().optional(), total: z.number().int().nullable().optional()}); export const beneficialOwnershipResponse = z.object({listingNotice: listingNotice.optional(), ticker: z.string().nullable().optional(), note: z.string().nullable().optional(), data: z.array(beneficialOwnershipBlockDto).nullable().optional(), meta: pageMeta.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 Schedule 13D and 13G record of a stock or ETF listing: each filer's latest 13D or 13G, * largest block first, with its event date, the block's shares (restated onto today's split * basis) and percent of class, the change since the filer's previous 13D or 13G, a 13D's Item 4 * purpose, and every reporting person on the cover pages with their own amount, percent and sole * or shared voting and dispositive power. Reporting persons on one filing each claim the same * block, so never add them together. A listing with no 13D or 13G returns an empty list. * * GET /v1/securities/{ticker}/beneficial-ownership */ export const getApiV1SecuritiesTickerBeneficialOwnership = async (args: GetApiV1SecuritiesTickerBeneficialOwnershipArgs, options?: GetApiV1SecuritiesTickerBeneficialOwnershipOptions) => { 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.limit != null) query.append("limit", String(args.limit)) if (args.offset != null) query.append("offset", String(args.offset)) if (ApiKey !== undefined) headers.set('authorization', `Bearer ${ApiKey}`) const url = `${baseUrl.replace(/\/+$/, '')}/v1/securities/${encodeURIComponent(String(args.ticker))}/beneficial-ownership${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(beneficialOwnershipResponse, await res.json()) };