import {z} from 'zod' export type GetApiV1SecuritiesTickerOwnershipSummaryArgs = {ticker: string, view?: string | undefined}; export type GetApiV1SecuritiesTickerOwnershipSummaryOptions = {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 ownershipSummaryLineDto = z.object({label: z.string().nullable().optional(), holders: z.number().int().optional(), shares: z.number().int().optional(), percentOutstanding: z.number().nullable().optional(), summed: z.boolean().optional()}); export const ownershipBreakdownLineDto = z.object({token: z.string().nullable().optional(), label: z.string().nullable().optional(), holders: z.number().int().optional(), shares: z.number().int().optional(), percentOutstanding: z.number().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 stockHolderDto: z.ZodType = z.object({name: z.string().nullable().optional(), source: z.string().nullable().optional(), idType: z.string().nullable().optional(), id: z.string().nullable().optional(), cik: z.string().nullable().optional(), seriesId: z.string().nullable().optional(), detail: z.string().nullable().optional(), holderType: z.string().nullable().optional(), style: z.string().nullable().optional(), country: z.string().nullable().optional(), shares: z.number().int().optional(), filedShares: z.number().optional(), value: z.number().int().nullable().optional(), changeShares: z.number().int().nullable().optional(), priorAsOf: z.string().nullable().optional(), percentOutstanding: z.number().nullable().optional(), filedPercentOfClass: z.number().nullable().optional(), votingRightsPercent: z.number().nullable().optional(), portfolioWeight: z.number().nullable().optional(), asOf: z.string().optional(), filingDate: z.string().nullable().optional(), accession: z.string().nullable().optional(), carried: z.boolean().optional(), stale: z.boolean().optional(), unconfirmed: z.boolean().optional(), splitUnresolved: z.boolean().optional(), issuerWide: z.boolean().optional(), notSummed: z.boolean().optional(), ultimateParentCik: z.string().nullable().optional(), ultimateParentLink: z.string().nullable().optional(), purpose: statedPurposeDto.optional(), childCount: z.number().int().optional(), children: z.array(z.lazy(() => stockHolderDto)).nullable().optional()}); export const ultimateHolderGroupDto = z.object({ultimateParentCik: z.string().nullable().optional(), name: z.string().nullable().optional(), shares: z.number().int().optional(), form13FShares: z.number().int().optional(), percentOutstanding: z.number().nullable().optional(), members: z.array(stockHolderDto).nullable().optional()}); export const ownershipSummaryResponse = z.object({listingNotice: listingNotice.optional(), ticker: z.string().nullable().optional(), exactListing: z.boolean().optional(), reportDate: z.string().nullable().optional(), carriedFrom: z.string().nullable().optional(), sharesOutstanding: z.number().int().nullable().optional(), percentUnavailableReason: z.string().nullable().optional(), institutional: ownershipSummaryLineDto.optional(), insiders: ownershipSummaryLineDto.optional(), insidersNotSummedReason: z.string().nullable().optional(), schedule13DGOnly: ownershipSummaryLineDto.optional(), funds: ownershipSummaryLineDto.optional(), remaining: ownershipSummaryLineDto.optional(), remainingNegative: z.boolean().optional(), splitUnresolvedRows: z.number().int().optional(), byHolderType: z.array(ownershipBreakdownLineDto).nullable().optional(), byStyle: z.array(ownershipBreakdownLineDto).nullable().optional(), styleAsOf: z.string().nullable().optional(), byLocation: z.array(ownershipBreakdownLineDto).nullable().optional(), ultimateParents: z.array(ultimateHolderGroupDto).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 }; /** * Who owns a stock, as shares and % of shares outstanding: 13F institutions, insiders (Forms * 3, 4 and 5, single-class issuers only), 13D and 13G blocks no 13F report already holds, and * the remainder, flagged rather than clipped when negative. Registered funds are shown but never * summed, since their shares sit inside their advisers' 13F reports. Each holder counts once: * insiders who file 13Fs, holders a 13F filer reports, and the filers and persons of any 13D or * 13G that names a 13F filer, directly or through filings naming one another, are left out of * the other lines, by CIK and SEC reporting links, never by name. A foreign private issuer's * count is in ordinary shares, a different unit, so it gets no percentages or remainder. The * 13F shares are also split by holder type, style and location. * * GET /v1/securities/{ticker}/ownership-summary */ export const getApiV1SecuritiesTickerOwnershipSummary = async (args: GetApiV1SecuritiesTickerOwnershipSummaryArgs, options?: GetApiV1SecuritiesTickerOwnershipSummaryOptions) => { 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.view != null) query.append("view", String(args.view)) if (ApiKey !== undefined) headers.set('authorization', `Bearer ${ApiKey}`) const url = `${baseUrl.replace(/\/+$/, '')}/v1/securities/${encodeURIComponent(String(args.ticker))}/ownership-summary${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(ownershipSummaryResponse, await res.json()) };