import {z} from 'zod' export type RankingPeriod = 'CurrMonth' | 'OneMonthAgo' | 'TwoMonthsAgo' | 'CurrQuarter' | 'ThreeMonthsAgo' | 'SixMonthsAgo' | 'CurrYear' | 'OneYearAgo' | 'LastYear' | 'LastTwoYears'; export type GetApiApiV2PortfoliosUsernameRankingsArgs = {'x-request-id': string, 'x-api-key': string, 'x-user-key': string, username: string, period: RankingPeriod}; export type GetApiApiV2PortfoliosUsernameRankingsOptions = {baseUrl?: string | undefined, oauth2?: string | undefined, fetch?: typeof fetch | undefined}; export const rankItem = z.object({cid: z.number().int().optional(), username: z.string().optional(), fullName: z.string().nullable().optional(), avatarUrl: z.string().nullable().optional(), type: z.enum(["trader", "smart-portfolio"]).optional(), subType: z.enum(["pi-cadet", "pi-rising-star", "pi-champion", "pi-elite", "pi-elite-pro", "pi-certified", "top-traders", "partners", "market"]).nullable().optional(), tags: z.array(z.string()).optional(), gain: z.number().optional(), dailyGain: z.number().optional(), thisWeekGain: z.number().optional(), fiveYearGain: z.number().optional(), tenYearGain: z.number().optional(), annualizedReturn: z.number().optional(), riskScore: z.number().int().optional(), maxDailyRiskScore: z.number().int().optional(), maxMonthlyRiskScore: z.number().int().optional(), copiers: z.number().int().optional(), copiedTrades: z.number().int().optional(), copyTradesPct: z.number().optional(), copyInvestmentPct: z.number().optional(), baseLineCopiers: z.number().int().optional(), copiersGain: z.number().optional(), aumTier: z.number().int().optional(), aumTierDesc: z.string().nullable().optional(), aumValue: z.number().optional(), virtualCopiers: z.number().int().optional(), dailyDD: z.number().optional(), weeklyDD: z.number().optional(), profitableWeeksPct: z.number().optional(), profitableMonthsPct: z.number().optional(), peakToValley: z.number().optional(), peakToValleyStart: z.string().nullable().optional(), peakToValleyEnd: z.string().nullable().optional(), trades: z.number().int().optional(), winRatio: z.number().optional(), velocity: z.number().optional(), exposure: z.number().optional(), avgPosSize: z.number().optional(), optimalCopyPosSize: z.number().optional(), highLeveragePct: z.number().optional(), mediumLeveragePct: z.number().optional(), lowLeveragePct: z.number().optional(), longPosPct: z.number().optional(), topTradedInstrumentId: z.number().int().optional(), topTradedAssetClassId: z.number().int().optional(), topTradedInstrumentPct: z.number().optional(), totalTradedInstruments: z.number().int().optional(), activeWeeks: z.number().int().optional(), firstActivity: z.string().optional(), lastActivity: z.string().optional(), activeWeeksPct: z.number().optional(), weeksSinceRegistration: z.number().int().optional(), country: z.string().nullable().optional()}); export const customerRankingResponse = z.object({data: rankItem.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 }; /** * Get ranking row for a single investor * * GET /api/v2/portfolios/{username}/rankings */ export const getApiApiV2PortfoliosUsernameRankings = async (args: GetApiApiV2PortfoliosUsernameRankingsArgs, options?: GetApiApiV2PortfoliosUsernameRankingsOptions) => { const {baseUrl = "https://public-api.etoro.com", fetch: fetchFn = fetch, oauth2} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args['x-request-id'] != null) headers.set("x-request-id", String(args['x-request-id'])) if (args['x-api-key'] != null) headers.set("x-api-key", String(args['x-api-key'])) if (args['x-user-key'] != null) headers.set("x-user-key", String(args['x-user-key'])) if (args.period != null) query.append("period", String(args.period)) if (oauth2 !== undefined) headers.set('authorization', `Bearer ${oauth2}`) const url = `${baseUrl.replace(/\/+$/, '')}/api/v2/portfolios/${encodeURIComponent(String(args.username))}/rankings${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(customerRankingResponse, await res.json()) };