import {z} from 'zod' export type GetApiSecurityDetailsArgs = {ticker: string, include_news_and_ai_sentiment?: boolean | undefined}; export type GetApiSecurityDetailsOptions = {baseUrl?: string | undefined, fetch?: typeof fetch | undefined}; export const newsArticle = z.object({date: z.string().optional(), headline: z.string().optional(), source: z.string().optional(), url: z.string().optional(), summary: z.string().optional(), image_url: z.string().optional(), api_source: z.string().optional(), language: z.string().optional(), author: z.string().optional(), has_paywall: z.boolean().optional(), category: z.string().optional(), relevance: z.string().optional(), sentiment: z.string().optional()}); export const sectorExposure = z.object({series_name: z.string().optional(), weight: z.number().optional()}); export const countryExposure = z.object({series_name: z.string().optional(), weight: z.number().optional()}); export const holdingExposure = z.object({series_name: z.string().optional(), weight: z.number().optional()}); export const securityDetails = z.object({ticker: z.string().optional(), series_type: z.string().optional(), volatility: z.number().optional(), sharpe_ratio: z.number().optional(), beta: z.number().optional(), listed_exchange: z.string().optional(), issue_type: z.string().optional(), price: z.number().optional(), revenue_per_share: z.number().optional(), earnings_per_share: z.number().optional(), dividend_per_share: z.number().optional(), trading_volume_10_day: z.number().optional(), trading_volume_30_day: z.number().optional(), put_call_ratio: z.number().optional(), enterprise_value: z.number().optional(), revenue: z.number().optional(), revenue_per_employee: z.number().optional(), profit_margin: z.number().optional(), debt_to_equity: z.number().optional(), growth_factor: z.number().optional(), inflation_factor: z.number().optional(), liquidity_factor: z.number().optional(), commodities_factor: z.number().optional(), credit_factor: z.number().optional(), interest_rates_factor: z.number().optional(), next_earnings_date_factor: z.string().optional(), next_dividend_date: z.string().optional(), ex_dividend_date: z.string().optional(), related_securities: z.array(z.string()).optional(), news: z.array(newsArticle).optional(), ai_sentiment: z.number().optional(), description: z.string().optional(), sector: z.string().optional(), industry: z.string().optional(), website: z.string().optional(), employees: z.number().int().optional(), market_cap: z.number().optional(), investing_method: z.string().optional(), diversified: z.string().optional(), expense_ratio: z.number().optional(), asset_class: z.string().optional(), sector_exposures: z.array(sectorExposure).optional(), country_exposures: z.array(countryExposure).optional(), holding_exposures: z.array(holdingExposure).optional(), more_info: z.string().optional()}); export const securityDetailsResponse = z.object({security_details: securityDetails.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 security details for a specific ticker with up to date information from the last 24 hours * * GET /security_details */ export const getApiSecurityDetails = async (args: GetApiSecurityDetailsArgs, options?: GetApiSecurityDetailsOptions) => { const {baseUrl = "https://portfoliopilot.com/api/gpt", fetch: fetchFn = fetch} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.ticker != null) query.append("ticker", String(args.ticker)) if (args.include_news_and_ai_sentiment != null) query.append("include_news_and_ai_sentiment", String(args.include_news_and_ai_sentiment)) const url = `${baseUrl.replace(/\/+$/, '')}/security_details${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(securityDetailsResponse, await res.json()) };