@sudowealth/schwab-api
Version:
TypeScript client for Charles Schwab API with OAuth support, market data, trading functionality, and complete type safety
1,042 lines • 284 kB
TypeScript
import { z } from 'zod';
export declare const AccountsBaseInstrument: z.ZodObject<{
assetType: z.ZodEnum<["EQUITY", "MUTUAL_FUND", "OPTION", "FUTURE", "FOREX", "INDEX", "CASH_EQUIVALENT", "FIXED_INCOME", "PRODUCT", "CURRENCY", "COLLECTIVE_INVESTMENT"]>;
cusip: z.ZodOptional<z.ZodString>;
symbol: z.ZodString;
description: z.ZodOptional<z.ZodString>;
instrumentId: z.ZodOptional<z.ZodNumber>;
netChange: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
symbol: string;
assetType: "EQUITY" | "FOREX" | "FUTURE" | "INDEX" | "MUTUAL_FUND" | "OPTION" | "CASH_EQUIVALENT" | "FIXED_INCOME" | "PRODUCT" | "CURRENCY" | "COLLECTIVE_INVESTMENT";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
}, {
symbol: string;
assetType: "EQUITY" | "FOREX" | "FUTURE" | "INDEX" | "MUTUAL_FUND" | "OPTION" | "CASH_EQUIVALENT" | "FIXED_INCOME" | "PRODUCT" | "CURRENCY" | "COLLECTIVE_INVESTMENT";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
}>;
export declare const GetAccountsPathParams: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
export type GetAccountsPathParams = z.infer<typeof GetAccountsPathParams>;
export declare const GetAccountsQueryParams: z.ZodObject<{
fields: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
fields?: string | undefined;
}, {
fields?: string | undefined;
}>;
export type GetAccountsQueryParams = z.infer<typeof GetAccountsQueryParams>;
export declare const GetAccountsParams: z.ZodObject<{
fields: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
fields?: string | undefined;
}, {
fields?: string | undefined;
}>;
export type GetAccountsParams = z.infer<typeof GetAccountsParams>;
export declare const GetAccountsResponse: z.ZodArray<z.ZodObject<{
securitiesAccount: z.ZodDiscriminatedUnion<"type", [z.ZodObject<{
accountNumber: z.ZodString;
roundTrips: z.ZodOptional<z.ZodNumber>;
isDayTrader: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
isClosingOnlyRestricted: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
pfcbFlag: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
positions: z.ZodOptional<z.ZodDefault<z.ZodArray<z.ZodObject<{
shortQuantity: z.ZodOptional<z.ZodNumber>;
averagePrice: z.ZodOptional<z.ZodNumber>;
currentDayProfitLoss: z.ZodOptional<z.ZodNumber>;
currentDayProfitLossPercentage: z.ZodOptional<z.ZodNumber>;
longQuantity: z.ZodOptional<z.ZodNumber>;
settledLongQuantity: z.ZodOptional<z.ZodNumber>;
settledShortQuantity: z.ZodOptional<z.ZodNumber>;
agedQuantity: z.ZodOptional<z.ZodNumber>;
instrument: z.ZodLazy<z.ZodDiscriminatedUnion<"assetType", [z.ZodObject<{
cusip: z.ZodOptional<z.ZodString>;
symbol: z.ZodString;
description: z.ZodOptional<z.ZodString>;
instrumentId: z.ZodOptional<z.ZodNumber>;
netChange: z.ZodOptional<z.ZodNumber>;
} & {
assetType: z.ZodLiteral<"CASH_EQUIVALENT">;
type: z.ZodOptional<z.ZodEnum<["SWEEP_VEHICLE", "SAVINGS", "MONEY_MARKET_FUND", "UNKNOWN"]>>;
underlyingSymbol: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
symbol: string;
assetType: "CASH_EQUIVALENT";
type?: "UNKNOWN" | "SWEEP_VEHICLE" | "SAVINGS" | "MONEY_MARKET_FUND" | undefined;
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
underlyingSymbol?: string | undefined;
}, {
symbol: string;
assetType: "CASH_EQUIVALENT";
type?: "UNKNOWN" | "SWEEP_VEHICLE" | "SAVINGS" | "MONEY_MARKET_FUND" | undefined;
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
underlyingSymbol?: string | undefined;
}>, z.ZodObject<{
cusip: z.ZodOptional<z.ZodString>;
symbol: z.ZodString;
description: z.ZodOptional<z.ZodString>;
instrumentId: z.ZodOptional<z.ZodNumber>;
netChange: z.ZodOptional<z.ZodNumber>;
} & {
assetType: z.ZodLiteral<"EQUITY">;
}, "strip", z.ZodTypeAny, {
symbol: string;
assetType: "EQUITY";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
}, {
symbol: string;
assetType: "EQUITY";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
}>, z.ZodObject<{
cusip: z.ZodOptional<z.ZodString>;
symbol: z.ZodString;
description: z.ZodOptional<z.ZodString>;
instrumentId: z.ZodOptional<z.ZodNumber>;
netChange: z.ZodOptional<z.ZodNumber>;
} & {
assetType: z.ZodLiteral<"FIXED_INCOME">;
maturityDate: z.ZodOptional<z.ZodString>;
factor: z.ZodOptional<z.ZodNumber>;
variableRate: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
symbol: string;
assetType: "FIXED_INCOME";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
maturityDate?: string | undefined;
factor?: number | undefined;
variableRate?: number | undefined;
}, {
symbol: string;
assetType: "FIXED_INCOME";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
maturityDate?: string | undefined;
factor?: number | undefined;
variableRate?: number | undefined;
}>, z.ZodObject<{
cusip: z.ZodOptional<z.ZodString>;
symbol: z.ZodString;
description: z.ZodOptional<z.ZodString>;
instrumentId: z.ZodOptional<z.ZodNumber>;
netChange: z.ZodOptional<z.ZodNumber>;
} & {
assetType: z.ZodLiteral<"MUTUAL_FUND">;
}, "strip", z.ZodTypeAny, {
symbol: string;
assetType: "MUTUAL_FUND";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
}, {
symbol: string;
assetType: "MUTUAL_FUND";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
}>, z.ZodObject<{
cusip: z.ZodOptional<z.ZodString>;
symbol: z.ZodString;
description: z.ZodOptional<z.ZodString>;
instrumentId: z.ZodOptional<z.ZodNumber>;
netChange: z.ZodOptional<z.ZodNumber>;
} & {
assetType: z.ZodLiteral<"OPTION">;
optionDeliverables: z.ZodOptional<z.ZodArray<z.ZodLazy<z.ZodObject<{
symbol: z.ZodString;
deliverableUnits: z.ZodNumber;
apiCurrencyType: z.ZodEnum<["USD", "CAD", "EUR", "JPY"]>;
assetType: z.ZodEnum<["EQUITY", "MUTUAL_FUND", "OPTION", "FUTURE", "FOREX", "INDEX", "CASH_EQUIVALENT", "FIXED_INCOME", "PRODUCT", "CURRENCY", "COLLECTIVE_INVESTMENT"]>;
}, "strip", z.ZodTypeAny, {
symbol: string;
assetType: "EQUITY" | "FOREX" | "FUTURE" | "INDEX" | "MUTUAL_FUND" | "OPTION" | "CASH_EQUIVALENT" | "FIXED_INCOME" | "PRODUCT" | "CURRENCY" | "COLLECTIVE_INVESTMENT";
deliverableUnits: number;
apiCurrencyType: "USD" | "CAD" | "EUR" | "JPY";
}, {
symbol: string;
assetType: "EQUITY" | "FOREX" | "FUTURE" | "INDEX" | "MUTUAL_FUND" | "OPTION" | "CASH_EQUIVALENT" | "FIXED_INCOME" | "PRODUCT" | "CURRENCY" | "COLLECTIVE_INVESTMENT";
deliverableUnits: number;
apiCurrencyType: "USD" | "CAD" | "EUR" | "JPY";
}>>, "many">>;
putCall: z.ZodOptional<z.ZodEnum<["PUT", "CALL", "UNKNOWN"]>>;
optionMultiplier: z.ZodOptional<z.ZodNumber>;
type: z.ZodOptional<z.ZodEnum<["VANILLA", "BINARY", "BARRIER", "UNKNOWN"]>>;
underlyingSymbol: z.ZodOptional<z.ZodString>;
}, "strip", z.ZodTypeAny, {
symbol: string;
assetType: "OPTION";
type?: "UNKNOWN" | "VANILLA" | "BINARY" | "BARRIER" | undefined;
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
putCall?: "UNKNOWN" | "PUT" | "CALL" | undefined;
underlyingSymbol?: string | undefined;
optionDeliverables?: {
symbol: string;
assetType: "EQUITY" | "FOREX" | "FUTURE" | "INDEX" | "MUTUAL_FUND" | "OPTION" | "CASH_EQUIVALENT" | "FIXED_INCOME" | "PRODUCT" | "CURRENCY" | "COLLECTIVE_INVESTMENT";
deliverableUnits: number;
apiCurrencyType: "USD" | "CAD" | "EUR" | "JPY";
}[] | undefined;
optionMultiplier?: number | undefined;
}, {
symbol: string;
assetType: "OPTION";
type?: "UNKNOWN" | "VANILLA" | "BINARY" | "BARRIER" | undefined;
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
putCall?: "UNKNOWN" | "PUT" | "CALL" | undefined;
underlyingSymbol?: string | undefined;
optionDeliverables?: {
symbol: string;
assetType: "EQUITY" | "FOREX" | "FUTURE" | "INDEX" | "MUTUAL_FUND" | "OPTION" | "CASH_EQUIVALENT" | "FIXED_INCOME" | "PRODUCT" | "CURRENCY" | "COLLECTIVE_INVESTMENT";
deliverableUnits: number;
apiCurrencyType: "USD" | "CAD" | "EUR" | "JPY";
}[] | undefined;
optionMultiplier?: number | undefined;
}>, z.ZodObject<{
cusip: z.ZodOptional<z.ZodString>;
symbol: z.ZodString;
description: z.ZodOptional<z.ZodString>;
instrumentId: z.ZodOptional<z.ZodNumber>;
netChange: z.ZodOptional<z.ZodNumber>;
} & {
assetType: z.ZodLiteral<"FUTURE">;
expirationDate: z.ZodOptional<z.ZodString>;
activeContract: z.ZodOptional<z.ZodDefault<z.ZodBoolean>>;
}, "strip", z.ZodTypeAny, {
symbol: string;
assetType: "FUTURE";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
expirationDate?: string | undefined;
activeContract?: boolean | undefined;
}, {
symbol: string;
assetType: "FUTURE";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
expirationDate?: string | undefined;
activeContract?: boolean | undefined;
}>, z.ZodObject<{
cusip: z.ZodOptional<z.ZodString>;
symbol: z.ZodString;
description: z.ZodOptional<z.ZodString>;
instrumentId: z.ZodOptional<z.ZodNumber>;
netChange: z.ZodOptional<z.ZodNumber>;
} & {
assetType: z.ZodLiteral<"FOREX">;
}, "strip", z.ZodTypeAny, {
symbol: string;
assetType: "FOREX";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
}, {
symbol: string;
assetType: "FOREX";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
}>, z.ZodObject<{
cusip: z.ZodOptional<z.ZodString>;
symbol: z.ZodString;
description: z.ZodOptional<z.ZodString>;
instrumentId: z.ZodOptional<z.ZodNumber>;
netChange: z.ZodOptional<z.ZodNumber>;
} & {
assetType: z.ZodLiteral<"INDEX">;
}, "strip", z.ZodTypeAny, {
symbol: string;
assetType: "INDEX";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
}, {
symbol: string;
assetType: "INDEX";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
}>, z.ZodObject<{
cusip: z.ZodOptional<z.ZodString>;
symbol: z.ZodString;
description: z.ZodOptional<z.ZodString>;
instrumentId: z.ZodOptional<z.ZodNumber>;
netChange: z.ZodOptional<z.ZodNumber>;
} & {
assetType: z.ZodLiteral<"PRODUCT">;
}, "strip", z.ZodTypeAny, {
symbol: string;
assetType: "PRODUCT";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
}, {
symbol: string;
assetType: "PRODUCT";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
}>, z.ZodObject<{
cusip: z.ZodOptional<z.ZodString>;
symbol: z.ZodString;
description: z.ZodOptional<z.ZodString>;
instrumentId: z.ZodOptional<z.ZodNumber>;
netChange: z.ZodOptional<z.ZodNumber>;
} & {
assetType: z.ZodLiteral<"CURRENCY">;
}, "strip", z.ZodTypeAny, {
symbol: string;
assetType: "CURRENCY";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
}, {
symbol: string;
assetType: "CURRENCY";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
}>, z.ZodObject<{
cusip: z.ZodOptional<z.ZodString>;
symbol: z.ZodString;
description: z.ZodOptional<z.ZodString>;
instrumentId: z.ZodOptional<z.ZodNumber>;
netChange: z.ZodOptional<z.ZodNumber>;
} & {
assetType: z.ZodLiteral<"COLLECTIVE_INVESTMENT">;
}, "strip", z.ZodTypeAny, {
symbol: string;
assetType: "COLLECTIVE_INVESTMENT";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
}, {
symbol: string;
assetType: "COLLECTIVE_INVESTMENT";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
}>]>>;
marketValue: z.ZodOptional<z.ZodNumber>;
maintenanceRequirement: z.ZodOptional<z.ZodNumber>;
averageLongPrice: z.ZodOptional<z.ZodNumber>;
averageShortPrice: z.ZodOptional<z.ZodNumber>;
taxLotAverageLongPrice: z.ZodOptional<z.ZodNumber>;
taxLotAverageShortPrice: z.ZodOptional<z.ZodNumber>;
longOpenProfitLoss: z.ZodOptional<z.ZodNumber>;
shortOpenProfitLoss: z.ZodOptional<z.ZodNumber>;
previousSessionLongQuantity: z.ZodOptional<z.ZodNumber>;
previousSessionShortQuantity: z.ZodOptional<z.ZodNumber>;
currentDayCost: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
instrument: {
symbol: string;
assetType: "CASH_EQUIVALENT";
type?: "UNKNOWN" | "SWEEP_VEHICLE" | "SAVINGS" | "MONEY_MARKET_FUND" | undefined;
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
underlyingSymbol?: string | undefined;
} | {
symbol: string;
assetType: "EQUITY";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
assetType: "FIXED_INCOME";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
maturityDate?: string | undefined;
factor?: number | undefined;
variableRate?: number | undefined;
} | {
symbol: string;
assetType: "MUTUAL_FUND";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
assetType: "OPTION";
type?: "UNKNOWN" | "VANILLA" | "BINARY" | "BARRIER" | undefined;
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
putCall?: "UNKNOWN" | "PUT" | "CALL" | undefined;
underlyingSymbol?: string | undefined;
optionDeliverables?: {
symbol: string;
assetType: "EQUITY" | "FOREX" | "FUTURE" | "INDEX" | "MUTUAL_FUND" | "OPTION" | "CASH_EQUIVALENT" | "FIXED_INCOME" | "PRODUCT" | "CURRENCY" | "COLLECTIVE_INVESTMENT";
deliverableUnits: number;
apiCurrencyType: "USD" | "CAD" | "EUR" | "JPY";
}[] | undefined;
optionMultiplier?: number | undefined;
} | {
symbol: string;
assetType: "FUTURE";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
expirationDate?: string | undefined;
activeContract?: boolean | undefined;
} | {
symbol: string;
assetType: "FOREX";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
assetType: "INDEX";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
assetType: "PRODUCT";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
assetType: "CURRENCY";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
assetType: "COLLECTIVE_INVESTMENT";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
};
shortQuantity?: number | undefined;
averagePrice?: number | undefined;
currentDayProfitLoss?: number | undefined;
currentDayProfitLossPercentage?: number | undefined;
longQuantity?: number | undefined;
settledLongQuantity?: number | undefined;
settledShortQuantity?: number | undefined;
agedQuantity?: number | undefined;
marketValue?: number | undefined;
maintenanceRequirement?: number | undefined;
averageLongPrice?: number | undefined;
averageShortPrice?: number | undefined;
taxLotAverageLongPrice?: number | undefined;
taxLotAverageShortPrice?: number | undefined;
longOpenProfitLoss?: number | undefined;
shortOpenProfitLoss?: number | undefined;
previousSessionLongQuantity?: number | undefined;
previousSessionShortQuantity?: number | undefined;
currentDayCost?: number | undefined;
}, {
instrument: {
symbol: string;
assetType: "CASH_EQUIVALENT";
type?: "UNKNOWN" | "SWEEP_VEHICLE" | "SAVINGS" | "MONEY_MARKET_FUND" | undefined;
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
underlyingSymbol?: string | undefined;
} | {
symbol: string;
assetType: "EQUITY";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
assetType: "FIXED_INCOME";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
maturityDate?: string | undefined;
factor?: number | undefined;
variableRate?: number | undefined;
} | {
symbol: string;
assetType: "MUTUAL_FUND";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
assetType: "OPTION";
type?: "UNKNOWN" | "VANILLA" | "BINARY" | "BARRIER" | undefined;
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
putCall?: "UNKNOWN" | "PUT" | "CALL" | undefined;
underlyingSymbol?: string | undefined;
optionDeliverables?: {
symbol: string;
assetType: "EQUITY" | "FOREX" | "FUTURE" | "INDEX" | "MUTUAL_FUND" | "OPTION" | "CASH_EQUIVALENT" | "FIXED_INCOME" | "PRODUCT" | "CURRENCY" | "COLLECTIVE_INVESTMENT";
deliverableUnits: number;
apiCurrencyType: "USD" | "CAD" | "EUR" | "JPY";
}[] | undefined;
optionMultiplier?: number | undefined;
} | {
symbol: string;
assetType: "FUTURE";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
expirationDate?: string | undefined;
activeContract?: boolean | undefined;
} | {
symbol: string;
assetType: "FOREX";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
assetType: "INDEX";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
assetType: "PRODUCT";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
assetType: "CURRENCY";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
assetType: "COLLECTIVE_INVESTMENT";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
};
shortQuantity?: number | undefined;
averagePrice?: number | undefined;
currentDayProfitLoss?: number | undefined;
currentDayProfitLossPercentage?: number | undefined;
longQuantity?: number | undefined;
settledLongQuantity?: number | undefined;
settledShortQuantity?: number | undefined;
agedQuantity?: number | undefined;
marketValue?: number | undefined;
maintenanceRequirement?: number | undefined;
averageLongPrice?: number | undefined;
averageShortPrice?: number | undefined;
taxLotAverageLongPrice?: number | undefined;
taxLotAverageShortPrice?: number | undefined;
longOpenProfitLoss?: number | undefined;
shortOpenProfitLoss?: number | undefined;
previousSessionLongQuantity?: number | undefined;
previousSessionShortQuantity?: number | undefined;
currentDayCost?: number | undefined;
}>, "many">>>;
} & {
type: z.ZodLiteral<"MARGIN">;
initialBalances: z.ZodOptional<z.ZodObject<{
accruedInterest: z.ZodOptional<z.ZodNumber>;
availableFundsNonMarginableTrade: z.ZodOptional<z.ZodNumber>;
bondValue: z.ZodOptional<z.ZodNumber>;
buyingPower: z.ZodOptional<z.ZodNumber>;
cashBalance: z.ZodOptional<z.ZodNumber>;
cashAvailableForTrading: z.ZodOptional<z.ZodNumber>;
cashReceipts: z.ZodOptional<z.ZodNumber>;
dayTradingBuyingPower: z.ZodOptional<z.ZodNumber>;
dayTradingBuyingPowerCall: z.ZodOptional<z.ZodNumber>;
dayTradingEquityCall: z.ZodOptional<z.ZodNumber>;
equity: z.ZodOptional<z.ZodNumber>;
equityPercentage: z.ZodOptional<z.ZodNumber>;
liquidationValue: z.ZodOptional<z.ZodNumber>;
longMarginValue: z.ZodOptional<z.ZodNumber>;
longOptionMarketValue: z.ZodOptional<z.ZodNumber>;
longStockValue: z.ZodOptional<z.ZodNumber>;
maintenanceCall: z.ZodOptional<z.ZodNumber>;
maintenanceRequirement: z.ZodOptional<z.ZodNumber>;
margin: z.ZodOptional<z.ZodNumber>;
marginEquity: z.ZodOptional<z.ZodNumber>;
moneyMarketFund: z.ZodOptional<z.ZodNumber>;
mutualFundValue: z.ZodOptional<z.ZodNumber>;
regTCall: z.ZodOptional<z.ZodNumber>;
shortMarginValue: z.ZodOptional<z.ZodNumber>;
shortOptionMarketValue: z.ZodOptional<z.ZodNumber>;
shortStockValue: z.ZodOptional<z.ZodNumber>;
totalCash: z.ZodOptional<z.ZodNumber>;
isInCall: z.ZodOptional<z.ZodBoolean>;
unsettledCash: z.ZodOptional<z.ZodNumber>;
pendingDeposits: z.ZodOptional<z.ZodNumber>;
marginBalance: z.ZodOptional<z.ZodNumber>;
shortBalance: z.ZodOptional<z.ZodNumber>;
accountValue: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
equity?: number | undefined;
maintenanceRequirement?: number | undefined;
accruedInterest?: number | undefined;
availableFundsNonMarginableTrade?: number | undefined;
bondValue?: number | undefined;
buyingPower?: number | undefined;
cashBalance?: number | undefined;
cashAvailableForTrading?: number | undefined;
cashReceipts?: number | undefined;
dayTradingBuyingPower?: number | undefined;
dayTradingBuyingPowerCall?: number | undefined;
dayTradingEquityCall?: number | undefined;
equityPercentage?: number | undefined;
liquidationValue?: number | undefined;
longMarginValue?: number | undefined;
longOptionMarketValue?: number | undefined;
longStockValue?: number | undefined;
maintenanceCall?: number | undefined;
margin?: number | undefined;
marginEquity?: number | undefined;
moneyMarketFund?: number | undefined;
mutualFundValue?: number | undefined;
regTCall?: number | undefined;
shortMarginValue?: number | undefined;
shortOptionMarketValue?: number | undefined;
shortStockValue?: number | undefined;
totalCash?: number | undefined;
isInCall?: boolean | undefined;
unsettledCash?: number | undefined;
pendingDeposits?: number | undefined;
marginBalance?: number | undefined;
shortBalance?: number | undefined;
accountValue?: number | undefined;
}, {
equity?: number | undefined;
maintenanceRequirement?: number | undefined;
accruedInterest?: number | undefined;
availableFundsNonMarginableTrade?: number | undefined;
bondValue?: number | undefined;
buyingPower?: number | undefined;
cashBalance?: number | undefined;
cashAvailableForTrading?: number | undefined;
cashReceipts?: number | undefined;
dayTradingBuyingPower?: number | undefined;
dayTradingBuyingPowerCall?: number | undefined;
dayTradingEquityCall?: number | undefined;
equityPercentage?: number | undefined;
liquidationValue?: number | undefined;
longMarginValue?: number | undefined;
longOptionMarketValue?: number | undefined;
longStockValue?: number | undefined;
maintenanceCall?: number | undefined;
margin?: number | undefined;
marginEquity?: number | undefined;
moneyMarketFund?: number | undefined;
mutualFundValue?: number | undefined;
regTCall?: number | undefined;
shortMarginValue?: number | undefined;
shortOptionMarketValue?: number | undefined;
shortStockValue?: number | undefined;
totalCash?: number | undefined;
isInCall?: boolean | undefined;
unsettledCash?: number | undefined;
pendingDeposits?: number | undefined;
marginBalance?: number | undefined;
shortBalance?: number | undefined;
accountValue?: number | undefined;
}>>;
currentBalances: z.ZodOptional<z.ZodObject<{
availableFunds: z.ZodOptional<z.ZodNumber>;
availableFundsNonMarginableTrade: z.ZodOptional<z.ZodNumber>;
buyingPower: z.ZodOptional<z.ZodNumber>;
buyingPowerNonMarginableTrade: z.ZodOptional<z.ZodNumber>;
dayTradingBuyingPower: z.ZodOptional<z.ZodNumber>;
dayTradingBuyingPowerCall: z.ZodOptional<z.ZodNumber>;
equity: z.ZodOptional<z.ZodNumber>;
equityPercentage: z.ZodOptional<z.ZodNumber>;
longMarginValue: z.ZodOptional<z.ZodNumber>;
maintenanceCall: z.ZodOptional<z.ZodNumber>;
maintenanceRequirement: z.ZodOptional<z.ZodNumber>;
marginBalance: z.ZodOptional<z.ZodNumber>;
regTCall: z.ZodOptional<z.ZodNumber>;
shortBalance: z.ZodOptional<z.ZodNumber>;
shortMarginValue: z.ZodOptional<z.ZodNumber>;
sma: z.ZodOptional<z.ZodNumber>;
isInCall: z.ZodOptional<z.ZodBoolean>;
stockBuyingPower: z.ZodOptional<z.ZodNumber>;
optionBuyingPower: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
equity?: number | undefined;
maintenanceRequirement?: number | undefined;
availableFundsNonMarginableTrade?: number | undefined;
buyingPower?: number | undefined;
dayTradingBuyingPower?: number | undefined;
dayTradingBuyingPowerCall?: number | undefined;
equityPercentage?: number | undefined;
longMarginValue?: number | undefined;
maintenanceCall?: number | undefined;
regTCall?: number | undefined;
shortMarginValue?: number | undefined;
isInCall?: boolean | undefined;
marginBalance?: number | undefined;
shortBalance?: number | undefined;
availableFunds?: number | undefined;
buyingPowerNonMarginableTrade?: number | undefined;
sma?: number | undefined;
stockBuyingPower?: number | undefined;
optionBuyingPower?: number | undefined;
}, {
equity?: number | undefined;
maintenanceRequirement?: number | undefined;
availableFundsNonMarginableTrade?: number | undefined;
buyingPower?: number | undefined;
dayTradingBuyingPower?: number | undefined;
dayTradingBuyingPowerCall?: number | undefined;
equityPercentage?: number | undefined;
longMarginValue?: number | undefined;
maintenanceCall?: number | undefined;
regTCall?: number | undefined;
shortMarginValue?: number | undefined;
isInCall?: boolean | undefined;
marginBalance?: number | undefined;
shortBalance?: number | undefined;
availableFunds?: number | undefined;
buyingPowerNonMarginableTrade?: number | undefined;
sma?: number | undefined;
stockBuyingPower?: number | undefined;
optionBuyingPower?: number | undefined;
}>>;
projectedBalances: z.ZodOptional<z.ZodObject<{
availableFunds: z.ZodOptional<z.ZodNumber>;
availableFundsNonMarginableTrade: z.ZodOptional<z.ZodNumber>;
buyingPower: z.ZodOptional<z.ZodNumber>;
buyingPowerNonMarginableTrade: z.ZodOptional<z.ZodNumber>;
dayTradingBuyingPower: z.ZodOptional<z.ZodNumber>;
dayTradingBuyingPowerCall: z.ZodOptional<z.ZodNumber>;
equity: z.ZodOptional<z.ZodNumber>;
equityPercentage: z.ZodOptional<z.ZodNumber>;
longMarginValue: z.ZodOptional<z.ZodNumber>;
maintenanceCall: z.ZodOptional<z.ZodNumber>;
maintenanceRequirement: z.ZodOptional<z.ZodNumber>;
marginBalance: z.ZodOptional<z.ZodNumber>;
regTCall: z.ZodOptional<z.ZodNumber>;
shortBalance: z.ZodOptional<z.ZodNumber>;
shortMarginValue: z.ZodOptional<z.ZodNumber>;
sma: z.ZodOptional<z.ZodNumber>;
isInCall: z.ZodOptional<z.ZodBoolean>;
stockBuyingPower: z.ZodOptional<z.ZodNumber>;
optionBuyingPower: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
equity?: number | undefined;
maintenanceRequirement?: number | undefined;
availableFundsNonMarginableTrade?: number | undefined;
buyingPower?: number | undefined;
dayTradingBuyingPower?: number | undefined;
dayTradingBuyingPowerCall?: number | undefined;
equityPercentage?: number | undefined;
longMarginValue?: number | undefined;
maintenanceCall?: number | undefined;
regTCall?: number | undefined;
shortMarginValue?: number | undefined;
isInCall?: boolean | undefined;
marginBalance?: number | undefined;
shortBalance?: number | undefined;
availableFunds?: number | undefined;
buyingPowerNonMarginableTrade?: number | undefined;
sma?: number | undefined;
stockBuyingPower?: number | undefined;
optionBuyingPower?: number | undefined;
}, {
equity?: number | undefined;
maintenanceRequirement?: number | undefined;
availableFundsNonMarginableTrade?: number | undefined;
buyingPower?: number | undefined;
dayTradingBuyingPower?: number | undefined;
dayTradingBuyingPowerCall?: number | undefined;
equityPercentage?: number | undefined;
longMarginValue?: number | undefined;
maintenanceCall?: number | undefined;
regTCall?: number | undefined;
shortMarginValue?: number | undefined;
isInCall?: boolean | undefined;
marginBalance?: number | undefined;
shortBalance?: number | undefined;
availableFunds?: number | undefined;
buyingPowerNonMarginableTrade?: number | undefined;
sma?: number | undefined;
stockBuyingPower?: number | undefined;
optionBuyingPower?: number | undefined;
}>>;
}, "strip", z.ZodTypeAny, {
accountNumber: string;
type: "MARGIN";
roundTrips?: number | undefined;
isDayTrader?: boolean | undefined;
isClosingOnlyRestricted?: boolean | undefined;
pfcbFlag?: boolean | undefined;
positions?: {
instrument: {
symbol: string;
assetType: "CASH_EQUIVALENT";
type?: "UNKNOWN" | "SWEEP_VEHICLE" | "SAVINGS" | "MONEY_MARKET_FUND" | undefined;
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
underlyingSymbol?: string | undefined;
} | {
symbol: string;
assetType: "EQUITY";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
assetType: "FIXED_INCOME";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
maturityDate?: string | undefined;
factor?: number | undefined;
variableRate?: number | undefined;
} | {
symbol: string;
assetType: "MUTUAL_FUND";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
assetType: "OPTION";
type?: "UNKNOWN" | "VANILLA" | "BINARY" | "BARRIER" | undefined;
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
putCall?: "UNKNOWN" | "PUT" | "CALL" | undefined;
underlyingSymbol?: string | undefined;
optionDeliverables?: {
symbol: string;
assetType: "EQUITY" | "FOREX" | "FUTURE" | "INDEX" | "MUTUAL_FUND" | "OPTION" | "CASH_EQUIVALENT" | "FIXED_INCOME" | "PRODUCT" | "CURRENCY" | "COLLECTIVE_INVESTMENT";
deliverableUnits: number;
apiCurrencyType: "USD" | "CAD" | "EUR" | "JPY";
}[] | undefined;
optionMultiplier?: number | undefined;
} | {
symbol: string;
assetType: "FUTURE";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
expirationDate?: string | undefined;
activeContract?: boolean | undefined;
} | {
symbol: string;
assetType: "FOREX";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
assetType: "INDEX";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
assetType: "PRODUCT";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
assetType: "CURRENCY";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
assetType: "COLLECTIVE_INVESTMENT";
description?: string | undefined;
cusip?: string | undefined;
netChange?: number | undefined;
instrumentId?: number | undefined;
};
shortQuantity?: number | undefined;
averagePrice?: number | undefined;
currentDayProfitLoss?: number | undefined;
currentDayProfitLossPercentage?: number | undefined;
longQuantity?: number | undefined;
settledLongQuantity?: number | undefined;
settledShortQuantity?: number | undefined;
agedQuantity?: number | undefined;
marketValue?: number | undefined;
maintenanceRequirement?: number | undefined;
averageLongPrice?: number | undefined;
averageShortPrice?: number | undefined;
taxLotAverageLongPrice?: number | undefined;
taxLotAverageShortPrice?: number | undefined;
longOpenProfitLoss?: number | undefined;
shortOpenProfitLoss?: number | undefined;
previousSessionLongQuantity?: number | undefined;
previousSessionShortQuantity?: number | undefined;
currentDayCost?: number | undefined;
}[] | undefined;
initialBalances?: {
equity?: number | undefined;
maintenanceRequirement?: number | undefined;
accruedInterest?: number | undefined;
availableFundsNonMarginableTrade?: number | undefined;
bondValue?: number | undefined;
buyingPower?: number | undefined;
cashBalance?: number | undefined;
cashAvailableForTrading?: number | undefined;
cashReceipts?: number | undefined;
dayTradingBuyingPower?: number | undefined;
dayTradingBuyingPowerCall?: number | undefined;
dayTradingEquityCall?: number | undefined;
equityPercentage?: number | undefined;
liquidationValue?: number | undefined;
longMarginValue?: number | undefined;
longOptionMarketValue?: number | undefined;
longStockValue?: number | undefined;
maintenanceCall?: number | undefined;
margin?: number | undefined;
marginEquity?: number | undefined;
moneyMarketFund?: number | undefined;
mutualFundValue?: number | undefined;
regTCall?: number | undefined;
shortMarginValue?: number | undefined;
shortOptionMarketValue?: number | undefined;
shortStockValue?: number | undefined;
totalCash?: number | undefined;
isInCall?: boolean | undefined;
unsettledCash?: number | undefined;
pendingDeposits?: number | undefined;
marginBalance?: number | undefined;
shortBalance?: number | undefined;
accountValue?: number | undefined;
} | undefined;
currentBalances?: {
equity?: number | undefined;
maintenanceRequirement?: number | undefined;
availableFundsNonMarginableTrade?: number | undefined;
buyingPower?: number | undefined;
dayTradingBuyingPower?: number | undefined;
dayTradingBuyingPowerCall?: number | undefined;
equityPercentage?: number | undefined;
longMarginValue?: number | undefined;
maintenanceCall?: number | undefined;
regTCall?: number | undefined;
shortMarginValue?: number | undefined;
isInCall?: boolean | undefined;
marginBalance?: number | undefined;
shortBalance?: number | undefined;
availableFunds?: number | undefined;
buyingPowerNonMarginableTrade?: number | undefined;
sma?: number | undefined;
stockBuyingPower?: number | undefined;
optionBuyingPower?: number | undefined;
} | undefined;
projectedBalances?: {
equity?: number | undefined;
maintenanceRequirement?: number | undefined;
availableFundsNonMarginableTrade?: number | undefined;
buyingPower?: number | undefined;
dayTradingBuyingPower?: number | undefined;
dayTradingBuyingPowerCall?: number | undefined;
equityPercentage?: number | undefined;
longMarginValue?: number | undefined;
maintenanceCall?: number | undefined;
regTCall?: number | undefined;
shortMarginValue?: number | undefined;
isInCall?: boolean | undefined;
marginBalance?: number | undefined;
shortBalance?: number | undefined;
availableFunds?: number | undefined;
buyingPowerNonMarginableTrade?: number | undefined;
sma?: number | undefined;
stockBuyingPower?: number | undefined;
optionBuyingPower?: number | undefined;
} | undefined;
}, {
accountNumber: string;
type: "MARGIN";
roundTrips?: number | undefined;
isDayTrader?: boolean | undefined;
isClosingOnlyRestricted?: boolean | undefined;
pfcbFlag?: boolean | undefined;
positions?: {
instrument: {
symbol: string;
assetType: "CASH_EQUIVALENT";
type?: "U