@sudowealth/schwab-api
Version:
TypeScript client for Charles Schwab API with OAuth support, market data, trading functionality, and complete type safety
1,097 lines (1,096 loc) • 104 kB
TypeScript
import { z } from 'zod';
export declare const TransactionType: z.ZodEnum<["TRADE", "RECEIVE_AND_DELIVER", "DIVIDEND_OR_INTEREST", "ACH_RECEIPT", "ACH_DISBURSEMENT", "CASH_RECEIPT", "CASH_DISBURSEMENT", "ELECTRONIC_FUND", "WIRE_OUT", "WIRE_IN", "JOURNAL", "MEMORANDUM", "MARGIN_CALL", "MONEY_MARKET", "SMA_ADJUSTMENT"]>;
export type TransactionType = z.infer<typeof TransactionType>;
export declare const GetTransactionsPathParams: z.ZodObject<{
accountNumber: z.ZodString;
}, "strip", z.ZodTypeAny, {
accountNumber: string;
}, {
accountNumber: string;
}>;
export type GetTransactionsPathParams = z.infer<typeof GetTransactionsPathParams>;
export declare const GetTransactionsQueryParams: z.ZodObject<{
startDate: z.ZodOptional<z.ZodEffects<z.ZodString, string, unknown>>;
endDate: z.ZodOptional<z.ZodEffects<z.ZodString, string, unknown>>;
symbol: z.ZodOptional<z.ZodString>;
types: z.ZodEnum<["TRADE", "RECEIVE_AND_DELIVER", "DIVIDEND_OR_INTEREST", "ACH_RECEIPT", "ACH_DISBURSEMENT", "CASH_RECEIPT", "CASH_DISBURSEMENT", "ELECTRONIC_FUND", "WIRE_OUT", "WIRE_IN", "JOURNAL", "MEMORANDUM", "MARGIN_CALL", "MONEY_MARKET", "SMA_ADJUSTMENT"]>;
}, "strip", z.ZodTypeAny, {
types: "TRADE" | "RECEIVE_AND_DELIVER" | "DIVIDEND_OR_INTEREST" | "ACH_RECEIPT" | "ACH_DISBURSEMENT" | "CASH_RECEIPT" | "CASH_DISBURSEMENT" | "ELECTRONIC_FUND" | "WIRE_OUT" | "WIRE_IN" | "JOURNAL" | "MEMORANDUM" | "MARGIN_CALL" | "MONEY_MARKET" | "SMA_ADJUSTMENT";
symbol?: string | undefined;
startDate?: string | undefined;
endDate?: string | undefined;
}, {
types: "TRADE" | "RECEIVE_AND_DELIVER" | "DIVIDEND_OR_INTEREST" | "ACH_RECEIPT" | "ACH_DISBURSEMENT" | "CASH_RECEIPT" | "CASH_DISBURSEMENT" | "ELECTRONIC_FUND" | "WIRE_OUT" | "WIRE_IN" | "JOURNAL" | "MEMORANDUM" | "MARGIN_CALL" | "MONEY_MARKET" | "SMA_ADJUSTMENT";
symbol?: string | undefined;
startDate?: unknown;
endDate?: unknown;
}>;
export type GetTransactionsQueryParams = z.infer<typeof GetTransactionsQueryParams>;
export declare const GetTransactionsParams: z.ZodObject<{
startDate: z.ZodOptional<z.ZodEffects<z.ZodString, string, unknown>>;
endDate: z.ZodOptional<z.ZodEffects<z.ZodString, string, unknown>>;
symbol: z.ZodOptional<z.ZodString>;
types: z.ZodEnum<["TRADE", "RECEIVE_AND_DELIVER", "DIVIDEND_OR_INTEREST", "ACH_RECEIPT", "ACH_DISBURSEMENT", "CASH_RECEIPT", "CASH_DISBURSEMENT", "ELECTRONIC_FUND", "WIRE_OUT", "WIRE_IN", "JOURNAL", "MEMORANDUM", "MARGIN_CALL", "MONEY_MARKET", "SMA_ADJUSTMENT"]>;
} & {
accountNumber: z.ZodString;
}, "strip", z.ZodTypeAny, {
accountNumber: string;
types: "TRADE" | "RECEIVE_AND_DELIVER" | "DIVIDEND_OR_INTEREST" | "ACH_RECEIPT" | "ACH_DISBURSEMENT" | "CASH_RECEIPT" | "CASH_DISBURSEMENT" | "ELECTRONIC_FUND" | "WIRE_OUT" | "WIRE_IN" | "JOURNAL" | "MEMORANDUM" | "MARGIN_CALL" | "MONEY_MARKET" | "SMA_ADJUSTMENT";
symbol?: string | undefined;
startDate?: string | undefined;
endDate?: string | undefined;
}, {
accountNumber: string;
types: "TRADE" | "RECEIVE_AND_DELIVER" | "DIVIDEND_OR_INTEREST" | "ACH_RECEIPT" | "ACH_DISBURSEMENT" | "CASH_RECEIPT" | "CASH_DISBURSEMENT" | "ELECTRONIC_FUND" | "WIRE_OUT" | "WIRE_IN" | "JOURNAL" | "MEMORANDUM" | "MARGIN_CALL" | "MONEY_MARKET" | "SMA_ADJUSTMENT";
symbol?: string | undefined;
startDate?: unknown;
endDate?: unknown;
}>;
export type GetTransactionsParams = z.infer<typeof GetTransactionsParams>;
export declare const GetTransactionsResponse: z.ZodArray<z.ZodObject<{
activityId: z.ZodNumber;
time: z.ZodEffects<z.ZodString, string | number | Date | null, string>;
user: z.ZodObject<{
cdDomainId: z.ZodString;
login: z.ZodString;
type: z.ZodEnum<["ADVISOR_USER", "BROKER_USER", "CLIENT_USER", "SYSTEM_USER", "UNKNOWN"]>;
userId: z.ZodNumber;
systemUserName: z.ZodString;
firstName: z.ZodString;
lastName: z.ZodString;
brokerRepCode: z.ZodString;
}, "strip", z.ZodTypeAny, {
type: "UNKNOWN" | "ADVISOR_USER" | "BROKER_USER" | "CLIENT_USER" | "SYSTEM_USER";
cdDomainId: string;
login: string;
userId: number;
systemUserName: string;
firstName: string;
lastName: string;
brokerRepCode: string;
}, {
type: "UNKNOWN" | "ADVISOR_USER" | "BROKER_USER" | "CLIENT_USER" | "SYSTEM_USER";
cdDomainId: string;
login: string;
userId: number;
systemUserName: string;
firstName: string;
lastName: string;
brokerRepCode: string;
}>;
description: z.ZodString;
accountNumber: z.ZodString;
type: z.ZodEnum<["TRADE", "RECEIVE_AND_DELIVER", "DIVIDEND_OR_INTEREST", "ACH_RECEIPT", "ACH_DISBURSEMENT", "CASH_RECEIPT", "CASH_DISBURSEMENT", "ELECTRONIC_FUND", "WIRE_OUT", "WIRE_IN", "JOURNAL", "MEMORANDUM", "MARGIN_CALL", "MONEY_MARKET", "SMA_ADJUSTMENT"]>;
status: z.ZodEnum<["VALID", "INVALID", "PENDING", "UNKNOWN"]>;
subAccount: z.ZodEnum<["CASH", "MARGIN", "SHORT", "DIV", "INCOME", "UNKNOWN"]>;
tradeDate: z.ZodEffects<z.ZodString, string | number | Date | null, string>;
settlementDate: z.ZodEffects<z.ZodString, string | number | Date | null, string>;
positionId: z.ZodNumber;
orderId: z.ZodNumber;
netAmount: z.ZodNumber;
activityType: z.ZodEnum<["ACTIVITY_CORRECTION", "EXECUTION", "ORDER_ACTION", "TRANSFER", "UNKNOWN"]>;
transferItems: z.ZodArray<z.ZodObject<{
instrument: z.ZodDiscriminatedUnion<"assetType", [z.ZodObject<{
cusip: z.ZodString;
instrumentId: z.ZodOptional<z.ZodNumber>;
netChange: z.ZodOptional<z.ZodNumber>;
} & {
assetType: z.ZodLiteral<"CASH_EQUIVALENT">;
symbol: z.ZodString;
description: z.ZodString;
type: z.ZodEnum<["SWEEP_VEHICLE", "SAVINGS", "MONEY_MARKET_FUND", "UNKNOWN"]>;
}, "strip", z.ZodTypeAny, {
symbol: string;
type: "UNKNOWN" | "SWEEP_VEHICLE" | "SAVINGS" | "MONEY_MARKET_FUND";
description: string;
assetType: "CASH_EQUIVALENT";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
}, {
symbol: string;
type: "UNKNOWN" | "SWEEP_VEHICLE" | "SAVINGS" | "MONEY_MARKET_FUND";
description: string;
assetType: "CASH_EQUIVALENT";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
}>, z.ZodObject<{
description: z.ZodString;
netChange: z.ZodOptional<z.ZodNumber>;
} & {
assetType: z.ZodLiteral<"COLLECTIVE_INVESTMENT">;
cusip: z.ZodString;
symbol: z.ZodString;
instrumentId: z.ZodAny;
type: z.ZodAny;
}, "strip", z.ZodTypeAny, {
symbol: string;
description: string;
assetType: "COLLECTIVE_INVESTMENT";
cusip: string;
type?: any;
netChange?: number | undefined;
instrumentId?: any;
}, {
symbol: string;
description: string;
assetType: "COLLECTIVE_INVESTMENT";
cusip: string;
type?: any;
netChange?: number | undefined;
instrumentId?: any;
}>, z.ZodObject<{
cusip: z.ZodString;
description: z.ZodString;
instrumentId: z.ZodOptional<z.ZodNumber>;
netChange: z.ZodOptional<z.ZodNumber>;
} & {
assetType: z.ZodLiteral<"CURRENCY">;
symbol: z.ZodString;
}, "strip", z.ZodTypeAny, {
symbol: string;
description: string;
assetType: "CURRENCY";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
}, {
symbol: string;
description: string;
assetType: "CURRENCY";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
}>, z.ZodObject<{
description: z.ZodString;
instrumentId: z.ZodOptional<z.ZodNumber>;
netChange: z.ZodOptional<z.ZodNumber>;
} & {
assetType: z.ZodLiteral<"EQUITY">;
cusip: z.ZodString;
symbol: z.ZodString;
type: z.ZodEnum<["COMMON_STOCK", "PREFERRED_STOCK", "DEPOSITORY_RECEIPT", "PREFERRED_DEPOSITORY_RECEIPT", "RESTRICTED_STOCK", "COMPONENT_UNIT", "RIGHT", "WARRANT", "CONVERTIBLE_PREFERRED_STOCK", "CONVERTIBLE_STOCK", "LIMITED_PARTNERSHIP", "WHEN_ISSUED", "UNKNOWN"]>;
}, "strip", z.ZodTypeAny, {
symbol: string;
type: "UNKNOWN" | "COMMON_STOCK" | "PREFERRED_STOCK" | "WARRANT" | "DEPOSITORY_RECEIPT" | "PREFERRED_DEPOSITORY_RECEIPT" | "RESTRICTED_STOCK" | "COMPONENT_UNIT" | "RIGHT" | "CONVERTIBLE_PREFERRED_STOCK" | "CONVERTIBLE_STOCK" | "LIMITED_PARTNERSHIP" | "WHEN_ISSUED";
description: string;
assetType: "EQUITY";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
}, {
symbol: string;
type: "UNKNOWN" | "COMMON_STOCK" | "PREFERRED_STOCK" | "WARRANT" | "DEPOSITORY_RECEIPT" | "PREFERRED_DEPOSITORY_RECEIPT" | "RESTRICTED_STOCK" | "COMPONENT_UNIT" | "RIGHT" | "CONVERTIBLE_PREFERRED_STOCK" | "CONVERTIBLE_STOCK" | "LIMITED_PARTNERSHIP" | "WHEN_ISSUED";
description: string;
assetType: "EQUITY";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
}>, z.ZodObject<{
description: z.ZodString;
instrumentId: z.ZodOptional<z.ZodNumber>;
netChange: z.ZodOptional<z.ZodNumber>;
} & {
assetType: z.ZodLiteral<"FIXED_INCOME">;
cusip: z.ZodString;
symbol: z.ZodString;
type: z.ZodEnum<["BOND_UNIT", "CERTIFICATE_OF_DEPOSIT", "CONVERTIBLE_BOND", "COLLATERALIZED_MORTGAGE_OBLIGATION", "CORPORATE_BOND", "GOVERNMENT_MORTGAGE", "GNMA_BONDS", "MUNICIPAL_ASSESSMENT_DISTRICT", "MUNICIPAL_BOND", "OTHER_GOVERNMENT", "SHORT_TERM_PAPER", "US_TREASURY_BOND", "US_TREASURY_BILL", "US_TREASURY_NOTE", "US_TREASURY_ZERO_COUPON", "AGENCY_BOND", "WHEN_AS_AND_IF_ISSUED_BOND", "ASSET_BACKED_SECURITY", "UNKNOWN"]>;
maturityDate: z.ZodEffects<z.ZodString, string | number | Date | null, string>;
factor: z.ZodNumber;
multiplier: z.ZodNumber;
variableRate: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
symbol: string;
type: "UNKNOWN" | "BOND_UNIT" | "CERTIFICATE_OF_DEPOSIT" | "CONVERTIBLE_BOND" | "COLLATERALIZED_MORTGAGE_OBLIGATION" | "CORPORATE_BOND" | "GOVERNMENT_MORTGAGE" | "GNMA_BONDS" | "MUNICIPAL_ASSESSMENT_DISTRICT" | "MUNICIPAL_BOND" | "OTHER_GOVERNMENT" | "SHORT_TERM_PAPER" | "US_TREASURY_BOND" | "US_TREASURY_BILL" | "US_TREASURY_NOTE" | "US_TREASURY_ZERO_COUPON" | "AGENCY_BOND" | "WHEN_AS_AND_IF_ISSUED_BOND" | "ASSET_BACKED_SECURITY";
description: string;
assetType: "FIXED_INCOME";
cusip: string;
multiplier: number;
maturityDate: string | number | Date | null;
factor: number;
variableRate: number;
netChange?: number | undefined;
instrumentId?: number | undefined;
}, {
symbol: string;
type: "UNKNOWN" | "BOND_UNIT" | "CERTIFICATE_OF_DEPOSIT" | "CONVERTIBLE_BOND" | "COLLATERALIZED_MORTGAGE_OBLIGATION" | "CORPORATE_BOND" | "GOVERNMENT_MORTGAGE" | "GNMA_BONDS" | "MUNICIPAL_ASSESSMENT_DISTRICT" | "MUNICIPAL_BOND" | "OTHER_GOVERNMENT" | "SHORT_TERM_PAPER" | "US_TREASURY_BOND" | "US_TREASURY_BILL" | "US_TREASURY_NOTE" | "US_TREASURY_ZERO_COUPON" | "AGENCY_BOND" | "WHEN_AS_AND_IF_ISSUED_BOND" | "ASSET_BACKED_SECURITY";
description: string;
assetType: "FIXED_INCOME";
cusip: string;
multiplier: number;
maturityDate: string;
factor: number;
variableRate: number;
netChange?: number | undefined;
instrumentId?: number | undefined;
}>, z.ZodObject<{
cusip: z.ZodString;
description: z.ZodString;
instrumentId: z.ZodOptional<z.ZodNumber>;
netChange: z.ZodOptional<z.ZodNumber>;
} & {
assetType: z.ZodLiteral<"FOREX">;
symbol: z.ZodString;
type: z.ZodEnum<["STANDARD", "NBBO", "UNKNOWN"]>;
baseCurrency: z.ZodLazy<z.ZodObject<{
cusip: z.ZodString;
description: z.ZodString;
instrumentId: z.ZodOptional<z.ZodNumber>;
netChange: z.ZodOptional<z.ZodNumber>;
} & {
assetType: z.ZodLiteral<"CURRENCY">;
symbol: z.ZodString;
}, "strip", z.ZodTypeAny, {
symbol: string;
description: string;
assetType: "CURRENCY";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
}, {
symbol: string;
description: string;
assetType: "CURRENCY";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
}>>;
counterCurrency: z.ZodLazy<z.ZodObject<{
cusip: z.ZodString;
description: z.ZodString;
instrumentId: z.ZodOptional<z.ZodNumber>;
netChange: z.ZodOptional<z.ZodNumber>;
} & {
assetType: z.ZodLiteral<"CURRENCY">;
symbol: z.ZodString;
}, "strip", z.ZodTypeAny, {
symbol: string;
description: string;
assetType: "CURRENCY";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
}, {
symbol: string;
description: string;
assetType: "CURRENCY";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
}>>;
}, "strip", z.ZodTypeAny, {
symbol: string;
type: "UNKNOWN" | "STANDARD" | "NBBO";
description: string;
assetType: "FOREX";
cusip: string;
baseCurrency: {
symbol: string;
description: string;
assetType: "CURRENCY";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
};
counterCurrency: {
symbol: string;
description: string;
assetType: "CURRENCY";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
};
netChange?: number | undefined;
instrumentId?: number | undefined;
}, {
symbol: string;
type: "UNKNOWN" | "STANDARD" | "NBBO";
description: string;
assetType: "FOREX";
cusip: string;
baseCurrency: {
symbol: string;
description: string;
assetType: "CURRENCY";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
};
counterCurrency: {
symbol: string;
description: string;
assetType: "CURRENCY";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
};
netChange?: number | undefined;
instrumentId?: number | undefined;
}>, z.ZodObject<{
cusip: z.ZodString;
description: z.ZodString;
instrumentId: z.ZodOptional<z.ZodNumber>;
netChange: z.ZodOptional<z.ZodNumber>;
} & {
assetType: z.ZodLiteral<"FUTURE">;
symbol: z.ZodString;
activeContract: z.ZodDefault<z.ZodBoolean>;
type: z.ZodEnum<["STANDARD", "UNKNOWN"]>;
expirationDate: z.ZodEffects<z.ZodString, string | number | Date | null, string>;
lastTradingDate: z.ZodEffects<z.ZodString, string | number | Date | null, string>;
firstNoticeDate: z.ZodEffects<z.ZodString, string | number | Date | null, string>;
multiplier: z.ZodNumber;
}, "strip", z.ZodTypeAny, {
symbol: string;
type: "UNKNOWN" | "STANDARD";
description: string;
assetType: "FUTURE";
cusip: string;
expirationDate: string | number | Date | null;
multiplier: number;
activeContract: boolean;
lastTradingDate: string | number | Date | null;
firstNoticeDate: string | number | Date | null;
netChange?: number | undefined;
instrumentId?: number | undefined;
}, {
symbol: string;
type: "UNKNOWN" | "STANDARD";
description: string;
assetType: "FUTURE";
cusip: string;
expirationDate: string;
multiplier: number;
lastTradingDate: string;
firstNoticeDate: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
activeContract?: boolean | undefined;
}>, z.ZodObject<{
cusip: z.ZodString;
description: z.ZodString;
instrumentId: z.ZodOptional<z.ZodNumber>;
netChange: z.ZodOptional<z.ZodNumber>;
} & {
assetType: z.ZodLiteral<"INDEX">;
symbol: z.ZodString;
activeContract: z.ZodDefault<z.ZodBoolean>;
type: z.ZodString;
}, "strip", z.ZodTypeAny, {
symbol: string;
type: string;
description: string;
assetType: "INDEX";
cusip: string;
activeContract: boolean;
netChange?: number | undefined;
instrumentId?: number | undefined;
}, {
symbol: string;
type: string;
description: string;
assetType: "INDEX";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
activeContract?: boolean | undefined;
}>, z.ZodObject<{
description: z.ZodString;
instrumentId: z.ZodOptional<z.ZodNumber>;
netChange: z.ZodOptional<z.ZodNumber>;
} & {
assetType: z.ZodLiteral<"MUTUAL_FUND">;
cusip: z.ZodString;
symbol: z.ZodString;
fundFamilyName: z.ZodString;
fundFamilySymbol: z.ZodString;
fundGroup: z.ZodString;
type: z.ZodEnum<["NOT_APPLICABLE", "OPEN_END_NON_TAXABLE", "OPEN_END_TAXABLE", "NO_LOAD_NON_TAXABLE", "NO_LOAD_TAXABLE", "UNKNOWN"]>;
exchangeCutoffTime: z.ZodEffects<z.ZodString, string | number | Date | null, string>;
purchaseCutoffTime: z.ZodEffects<z.ZodString, string | number | Date | null, string>;
redemptionCutoffTime: z.ZodEffects<z.ZodString, string | number | Date | null, string>;
}, "strip", z.ZodTypeAny, {
symbol: string;
type: "UNKNOWN" | "NOT_APPLICABLE" | "OPEN_END_NON_TAXABLE" | "OPEN_END_TAXABLE" | "NO_LOAD_NON_TAXABLE" | "NO_LOAD_TAXABLE";
description: string;
assetType: "MUTUAL_FUND";
cusip: string;
fundFamilyName: string;
fundFamilySymbol: string;
fundGroup: string;
exchangeCutoffTime: string | number | Date | null;
purchaseCutoffTime: string | number | Date | null;
redemptionCutoffTime: string | number | Date | null;
netChange?: number | undefined;
instrumentId?: number | undefined;
}, {
symbol: string;
type: "UNKNOWN" | "NOT_APPLICABLE" | "OPEN_END_NON_TAXABLE" | "OPEN_END_TAXABLE" | "NO_LOAD_NON_TAXABLE" | "NO_LOAD_TAXABLE";
description: string;
assetType: "MUTUAL_FUND";
cusip: string;
fundFamilyName: string;
fundFamilySymbol: string;
fundGroup: string;
exchangeCutoffTime: string;
purchaseCutoffTime: string;
redemptionCutoffTime: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
}>, z.ZodObject<{} & {
assetType: z.ZodLiteral<"OPTION">;
cusip: z.ZodString;
symbol: z.ZodString;
description: z.ZodString;
instrumentId: z.ZodOptional<z.ZodNumber>;
netChange: z.ZodOptional<z.ZodNumber>;
expirationDate: z.ZodEffects<z.ZodString, string | number | Date | null, string>;
optionDeliverables: z.ZodArray<z.ZodObject<{
rootSymbol: z.ZodString;
strikePercent: z.ZodNumber;
deliverableNumber: z.ZodNumber;
deliverableUnits: z.ZodNumber;
deliverable: z.ZodAny;
assetType: z.ZodEnum<["EQUITY", "MUTUAL_FUND", "OPTION", "FUTURE", "FOREX", "INDEX", "CASH_EQUIVALENT", "FIXED_INCOME", "PRODUCT", "CURRENCY", "COLLECTIVE_INVESTMENT"]>;
}, "strip", z.ZodTypeAny, {
assetType: "EQUITY" | "FOREX" | "FUTURE" | "INDEX" | "MUTUAL_FUND" | "OPTION" | "CASH_EQUIVALENT" | "FIXED_INCOME" | "PRODUCT" | "CURRENCY" | "COLLECTIVE_INVESTMENT";
deliverableUnits: number;
rootSymbol: string;
strikePercent: number;
deliverableNumber: number;
deliverable?: any;
}, {
assetType: "EQUITY" | "FOREX" | "FUTURE" | "INDEX" | "MUTUAL_FUND" | "OPTION" | "CASH_EQUIVALENT" | "FIXED_INCOME" | "PRODUCT" | "CURRENCY" | "COLLECTIVE_INVESTMENT";
deliverableUnits: number;
rootSymbol: string;
strikePercent: number;
deliverableNumber: number;
deliverable?: any;
}>, "many">;
optionPremiumMultiplier: z.ZodNumber;
putCall: z.ZodEnum<["PUT", "CALL", "UNKNOWN"]>;
strikePrice: z.ZodNumber;
type: z.ZodEnum<["VANILLA", "BINARY", "BARRIER", "UNKNOWN"]>;
underlyingSymbol: z.ZodString;
underlyingCusip: z.ZodString;
deliverable: z.ZodAny;
}, "strip", z.ZodTypeAny, {
symbol: string;
type: "UNKNOWN" | "VANILLA" | "BINARY" | "BARRIER";
description: string;
assetType: "OPTION";
cusip: string;
putCall: "UNKNOWN" | "PUT" | "CALL";
strikePrice: number;
expirationDate: string | number | Date | null;
underlyingSymbol: string;
optionDeliverables: {
assetType: "EQUITY" | "FOREX" | "FUTURE" | "INDEX" | "MUTUAL_FUND" | "OPTION" | "CASH_EQUIVALENT" | "FIXED_INCOME" | "PRODUCT" | "CURRENCY" | "COLLECTIVE_INVESTMENT";
deliverableUnits: number;
rootSymbol: string;
strikePercent: number;
deliverableNumber: number;
deliverable?: any;
}[];
optionPremiumMultiplier: number;
underlyingCusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
deliverable?: any;
}, {
symbol: string;
type: "UNKNOWN" | "VANILLA" | "BINARY" | "BARRIER";
description: string;
assetType: "OPTION";
cusip: string;
putCall: "UNKNOWN" | "PUT" | "CALL";
strikePrice: number;
expirationDate: string;
underlyingSymbol: string;
optionDeliverables: {
assetType: "EQUITY" | "FOREX" | "FUTURE" | "INDEX" | "MUTUAL_FUND" | "OPTION" | "CASH_EQUIVALENT" | "FIXED_INCOME" | "PRODUCT" | "CURRENCY" | "COLLECTIVE_INVESTMENT";
deliverableUnits: number;
rootSymbol: string;
strikePercent: number;
deliverableNumber: number;
deliverable?: any;
}[];
optionPremiumMultiplier: number;
underlyingCusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
deliverable?: any;
}>, z.ZodObject<{
cusip: z.ZodString;
description: z.ZodString;
instrumentId: z.ZodOptional<z.ZodNumber>;
netChange: z.ZodOptional<z.ZodNumber>;
} & {
assetType: z.ZodLiteral<"PRODUCT">;
symbol: z.ZodString;
type: z.ZodEnum<["TBD", "UNKNOWN"]>;
}, "strip", z.ZodTypeAny, {
symbol: string;
type: "UNKNOWN" | "TBD";
description: string;
assetType: "PRODUCT";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
}, {
symbol: string;
type: "UNKNOWN" | "TBD";
description: string;
assetType: "PRODUCT";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
}>]>;
amount: z.ZodNumber;
cost: z.ZodNumber;
price: z.ZodNumber;
feeType: z.ZodEnum<["COMMISSION", "SEC_FEE", "STR_FEE", "R_FEE", "CDSC_FEE", "OPT_REG_FEE", "ADDITIONAL_FEE", "MISCELLANEOUS_FEE", "FUTURES_EXCHANGE_FEE", "LOW_PROCEEDS_COMMISSION", "BASE_CHARGE", "GENERAL_CHARGE", "GST_FEE", "TAF_FEE", "INDEX_OPTION_FEE", "UNKNOWN"]>;
positionEffect: z.ZodEnum<["OPENING", "CLOSING", "AUTOMATIC", "UNKNOWN"]>;
}, "strip", z.ZodTypeAny, {
instrument: {
symbol: string;
type: "UNKNOWN" | "SWEEP_VEHICLE" | "SAVINGS" | "MONEY_MARKET_FUND";
description: string;
assetType: "CASH_EQUIVALENT";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
description: string;
assetType: "COLLECTIVE_INVESTMENT";
cusip: string;
type?: any;
netChange?: number | undefined;
instrumentId?: any;
} | {
symbol: string;
description: string;
assetType: "CURRENCY";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
type: "UNKNOWN" | "COMMON_STOCK" | "PREFERRED_STOCK" | "WARRANT" | "DEPOSITORY_RECEIPT" | "PREFERRED_DEPOSITORY_RECEIPT" | "RESTRICTED_STOCK" | "COMPONENT_UNIT" | "RIGHT" | "CONVERTIBLE_PREFERRED_STOCK" | "CONVERTIBLE_STOCK" | "LIMITED_PARTNERSHIP" | "WHEN_ISSUED";
description: string;
assetType: "EQUITY";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
type: "UNKNOWN" | "BOND_UNIT" | "CERTIFICATE_OF_DEPOSIT" | "CONVERTIBLE_BOND" | "COLLATERALIZED_MORTGAGE_OBLIGATION" | "CORPORATE_BOND" | "GOVERNMENT_MORTGAGE" | "GNMA_BONDS" | "MUNICIPAL_ASSESSMENT_DISTRICT" | "MUNICIPAL_BOND" | "OTHER_GOVERNMENT" | "SHORT_TERM_PAPER" | "US_TREASURY_BOND" | "US_TREASURY_BILL" | "US_TREASURY_NOTE" | "US_TREASURY_ZERO_COUPON" | "AGENCY_BOND" | "WHEN_AS_AND_IF_ISSUED_BOND" | "ASSET_BACKED_SECURITY";
description: string;
assetType: "FIXED_INCOME";
cusip: string;
multiplier: number;
maturityDate: string | number | Date | null;
factor: number;
variableRate: number;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
type: "UNKNOWN" | "STANDARD" | "NBBO";
description: string;
assetType: "FOREX";
cusip: string;
baseCurrency: {
symbol: string;
description: string;
assetType: "CURRENCY";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
};
counterCurrency: {
symbol: string;
description: string;
assetType: "CURRENCY";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
};
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
type: "UNKNOWN" | "STANDARD";
description: string;
assetType: "FUTURE";
cusip: string;
expirationDate: string | number | Date | null;
multiplier: number;
activeContract: boolean;
lastTradingDate: string | number | Date | null;
firstNoticeDate: string | number | Date | null;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
type: string;
description: string;
assetType: "INDEX";
cusip: string;
activeContract: boolean;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
type: "UNKNOWN" | "NOT_APPLICABLE" | "OPEN_END_NON_TAXABLE" | "OPEN_END_TAXABLE" | "NO_LOAD_NON_TAXABLE" | "NO_LOAD_TAXABLE";
description: string;
assetType: "MUTUAL_FUND";
cusip: string;
fundFamilyName: string;
fundFamilySymbol: string;
fundGroup: string;
exchangeCutoffTime: string | number | Date | null;
purchaseCutoffTime: string | number | Date | null;
redemptionCutoffTime: string | number | Date | null;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
type: "UNKNOWN" | "VANILLA" | "BINARY" | "BARRIER";
description: string;
assetType: "OPTION";
cusip: string;
putCall: "UNKNOWN" | "PUT" | "CALL";
strikePrice: number;
expirationDate: string | number | Date | null;
underlyingSymbol: string;
optionDeliverables: {
assetType: "EQUITY" | "FOREX" | "FUTURE" | "INDEX" | "MUTUAL_FUND" | "OPTION" | "CASH_EQUIVALENT" | "FIXED_INCOME" | "PRODUCT" | "CURRENCY" | "COLLECTIVE_INVESTMENT";
deliverableUnits: number;
rootSymbol: string;
strikePercent: number;
deliverableNumber: number;
deliverable?: any;
}[];
optionPremiumMultiplier: number;
underlyingCusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
deliverable?: any;
} | {
symbol: string;
type: "UNKNOWN" | "TBD";
description: string;
assetType: "PRODUCT";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
};
price: number;
positionEffect: "UNKNOWN" | "OPENING" | "CLOSING" | "AUTOMATIC";
amount: number;
cost: number;
feeType: "UNKNOWN" | "COMMISSION" | "SEC_FEE" | "STR_FEE" | "R_FEE" | "CDSC_FEE" | "OPT_REG_FEE" | "ADDITIONAL_FEE" | "MISCELLANEOUS_FEE" | "FUTURES_EXCHANGE_FEE" | "LOW_PROCEEDS_COMMISSION" | "BASE_CHARGE" | "GENERAL_CHARGE" | "GST_FEE" | "TAF_FEE" | "INDEX_OPTION_FEE";
}, {
instrument: {
symbol: string;
type: "UNKNOWN" | "SWEEP_VEHICLE" | "SAVINGS" | "MONEY_MARKET_FUND";
description: string;
assetType: "CASH_EQUIVALENT";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
description: string;
assetType: "COLLECTIVE_INVESTMENT";
cusip: string;
type?: any;
netChange?: number | undefined;
instrumentId?: any;
} | {
symbol: string;
description: string;
assetType: "CURRENCY";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
type: "UNKNOWN" | "COMMON_STOCK" | "PREFERRED_STOCK" | "WARRANT" | "DEPOSITORY_RECEIPT" | "PREFERRED_DEPOSITORY_RECEIPT" | "RESTRICTED_STOCK" | "COMPONENT_UNIT" | "RIGHT" | "CONVERTIBLE_PREFERRED_STOCK" | "CONVERTIBLE_STOCK" | "LIMITED_PARTNERSHIP" | "WHEN_ISSUED";
description: string;
assetType: "EQUITY";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
type: "UNKNOWN" | "BOND_UNIT" | "CERTIFICATE_OF_DEPOSIT" | "CONVERTIBLE_BOND" | "COLLATERALIZED_MORTGAGE_OBLIGATION" | "CORPORATE_BOND" | "GOVERNMENT_MORTGAGE" | "GNMA_BONDS" | "MUNICIPAL_ASSESSMENT_DISTRICT" | "MUNICIPAL_BOND" | "OTHER_GOVERNMENT" | "SHORT_TERM_PAPER" | "US_TREASURY_BOND" | "US_TREASURY_BILL" | "US_TREASURY_NOTE" | "US_TREASURY_ZERO_COUPON" | "AGENCY_BOND" | "WHEN_AS_AND_IF_ISSUED_BOND" | "ASSET_BACKED_SECURITY";
description: string;
assetType: "FIXED_INCOME";
cusip: string;
multiplier: number;
maturityDate: string;
factor: number;
variableRate: number;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
type: "UNKNOWN" | "STANDARD" | "NBBO";
description: string;
assetType: "FOREX";
cusip: string;
baseCurrency: {
symbol: string;
description: string;
assetType: "CURRENCY";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
};
counterCurrency: {
symbol: string;
description: string;
assetType: "CURRENCY";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
};
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
type: "UNKNOWN" | "STANDARD";
description: string;
assetType: "FUTURE";
cusip: string;
expirationDate: string;
multiplier: number;
lastTradingDate: string;
firstNoticeDate: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
activeContract?: boolean | undefined;
} | {
symbol: string;
type: string;
description: string;
assetType: "INDEX";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
activeContract?: boolean | undefined;
} | {
symbol: string;
type: "UNKNOWN" | "NOT_APPLICABLE" | "OPEN_END_NON_TAXABLE" | "OPEN_END_TAXABLE" | "NO_LOAD_NON_TAXABLE" | "NO_LOAD_TAXABLE";
description: string;
assetType: "MUTUAL_FUND";
cusip: string;
fundFamilyName: string;
fundFamilySymbol: string;
fundGroup: string;
exchangeCutoffTime: string;
purchaseCutoffTime: string;
redemptionCutoffTime: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
type: "UNKNOWN" | "VANILLA" | "BINARY" | "BARRIER";
description: string;
assetType: "OPTION";
cusip: string;
putCall: "UNKNOWN" | "PUT" | "CALL";
strikePrice: number;
expirationDate: string;
underlyingSymbol: string;
optionDeliverables: {
assetType: "EQUITY" | "FOREX" | "FUTURE" | "INDEX" | "MUTUAL_FUND" | "OPTION" | "CASH_EQUIVALENT" | "FIXED_INCOME" | "PRODUCT" | "CURRENCY" | "COLLECTIVE_INVESTMENT";
deliverableUnits: number;
rootSymbol: string;
strikePercent: number;
deliverableNumber: number;
deliverable?: any;
}[];
optionPremiumMultiplier: number;
underlyingCusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
deliverable?: any;
} | {
symbol: string;
type: "UNKNOWN" | "TBD";
description: string;
assetType: "PRODUCT";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
};
price: number;
positionEffect: "UNKNOWN" | "OPENING" | "CLOSING" | "AUTOMATIC";
amount: number;
cost: number;
feeType: "UNKNOWN" | "COMMISSION" | "SEC_FEE" | "STR_FEE" | "R_FEE" | "CDSC_FEE" | "OPT_REG_FEE" | "ADDITIONAL_FEE" | "MISCELLANEOUS_FEE" | "FUTURES_EXCHANGE_FEE" | "LOW_PROCEEDS_COMMISSION" | "BASE_CHARGE" | "GENERAL_CHARGE" | "GST_FEE" | "TAF_FEE" | "INDEX_OPTION_FEE";
}>, "many">;
}, "strip", z.ZodTypeAny, {
accountNumber: string;
status: "UNKNOWN" | "VALID" | "INVALID" | "PENDING";
type: "TRADE" | "RECEIVE_AND_DELIVER" | "DIVIDEND_OR_INTEREST" | "ACH_RECEIPT" | "ACH_DISBURSEMENT" | "CASH_RECEIPT" | "CASH_DISBURSEMENT" | "ELECTRONIC_FUND" | "WIRE_OUT" | "WIRE_IN" | "JOURNAL" | "MEMORANDUM" | "MARGIN_CALL" | "MONEY_MARKET" | "SMA_ADJUSTMENT";
description: string;
tradeDate: string | number | Date | null;
time: string | number | Date | null;
activityType: "UNKNOWN" | "EXECUTION" | "ORDER_ACTION" | "ACTIVITY_CORRECTION" | "TRANSFER";
orderId: number;
activityId: number;
user: {
type: "UNKNOWN" | "ADVISOR_USER" | "BROKER_USER" | "CLIENT_USER" | "SYSTEM_USER";
cdDomainId: string;
login: string;
userId: number;
systemUserName: string;
firstName: string;
lastName: string;
brokerRepCode: string;
};
subAccount: "UNKNOWN" | "MARGIN" | "CASH" | "SHORT" | "DIV" | "INCOME";
settlementDate: string | number | Date | null;
positionId: number;
netAmount: number;
transferItems: {
instrument: {
symbol: string;
type: "UNKNOWN" | "SWEEP_VEHICLE" | "SAVINGS" | "MONEY_MARKET_FUND";
description: string;
assetType: "CASH_EQUIVALENT";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
description: string;
assetType: "COLLECTIVE_INVESTMENT";
cusip: string;
type?: any;
netChange?: number | undefined;
instrumentId?: any;
} | {
symbol: string;
description: string;
assetType: "CURRENCY";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
type: "UNKNOWN" | "COMMON_STOCK" | "PREFERRED_STOCK" | "WARRANT" | "DEPOSITORY_RECEIPT" | "PREFERRED_DEPOSITORY_RECEIPT" | "RESTRICTED_STOCK" | "COMPONENT_UNIT" | "RIGHT" | "CONVERTIBLE_PREFERRED_STOCK" | "CONVERTIBLE_STOCK" | "LIMITED_PARTNERSHIP" | "WHEN_ISSUED";
description: string;
assetType: "EQUITY";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
type: "UNKNOWN" | "BOND_UNIT" | "CERTIFICATE_OF_DEPOSIT" | "CONVERTIBLE_BOND" | "COLLATERALIZED_MORTGAGE_OBLIGATION" | "CORPORATE_BOND" | "GOVERNMENT_MORTGAGE" | "GNMA_BONDS" | "MUNICIPAL_ASSESSMENT_DISTRICT" | "MUNICIPAL_BOND" | "OTHER_GOVERNMENT" | "SHORT_TERM_PAPER" | "US_TREASURY_BOND" | "US_TREASURY_BILL" | "US_TREASURY_NOTE" | "US_TREASURY_ZERO_COUPON" | "AGENCY_BOND" | "WHEN_AS_AND_IF_ISSUED_BOND" | "ASSET_BACKED_SECURITY";
description: string;
assetType: "FIXED_INCOME";
cusip: string;
multiplier: number;
maturityDate: string | number | Date | null;
factor: number;
variableRate: number;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
type: "UNKNOWN" | "STANDARD" | "NBBO";
description: string;
assetType: "FOREX";
cusip: string;
baseCurrency: {
symbol: string;
description: string;
assetType: "CURRENCY";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
};
counterCurrency: {
symbol: string;
description: string;
assetType: "CURRENCY";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
};
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
type: "UNKNOWN" | "STANDARD";
description: string;
assetType: "FUTURE";
cusip: string;
expirationDate: string | number | Date | null;
multiplier: number;
activeContract: boolean;
lastTradingDate: string | number | Date | null;
firstNoticeDate: string | number | Date | null;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
type: string;
description: string;
assetType: "INDEX";
cusip: string;
activeContract: boolean;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
type: "UNKNOWN" | "NOT_APPLICABLE" | "OPEN_END_NON_TAXABLE" | "OPEN_END_TAXABLE" | "NO_LOAD_NON_TAXABLE" | "NO_LOAD_TAXABLE";
description: string;
assetType: "MUTUAL_FUND";
cusip: string;
fundFamilyName: string;
fundFamilySymbol: string;
fundGroup: string;
exchangeCutoffTime: string | number | Date | null;
purchaseCutoffTime: string | number | Date | null;
redemptionCutoffTime: string | number | Date | null;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
type: "UNKNOWN" | "VANILLA" | "BINARY" | "BARRIER";
description: string;
assetType: "OPTION";
cusip: string;
putCall: "UNKNOWN" | "PUT" | "CALL";
strikePrice: number;
expirationDate: string | number | Date | null;
underlyingSymbol: string;
optionDeliverables: {
assetType: "EQUITY" | "FOREX" | "FUTURE" | "INDEX" | "MUTUAL_FUND" | "OPTION" | "CASH_EQUIVALENT" | "FIXED_INCOME" | "PRODUCT" | "CURRENCY" | "COLLECTIVE_INVESTMENT";
deliverableUnits: number;
rootSymbol: string;
strikePercent: number;
deliverableNumber: number;
deliverable?: any;
}[];
optionPremiumMultiplier: number;
underlyingCusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
deliverable?: any;
} | {
symbol: string;
type: "UNKNOWN" | "TBD";
description: string;
assetType: "PRODUCT";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
};
price: number;
positionEffect: "UNKNOWN" | "OPENING" | "CLOSING" | "AUTOMATIC";
amount: number;
cost: number;
feeType: "UNKNOWN" | "COMMISSION" | "SEC_FEE" | "STR_FEE" | "R_FEE" | "CDSC_FEE" | "OPT_REG_FEE" | "ADDITIONAL_FEE" | "MISCELLANEOUS_FEE" | "FUTURES_EXCHANGE_FEE" | "LOW_PROCEEDS_COMMISSION" | "BASE_CHARGE" | "GENERAL_CHARGE" | "GST_FEE" | "TAF_FEE" | "INDEX_OPTION_FEE";
}[];
}, {
accountNumber: string;
status: "UNKNOWN" | "VALID" | "INVALID" | "PENDING";
type: "TRADE" | "RECEIVE_AND_DELIVER" | "DIVIDEND_OR_INTEREST" | "ACH_RECEIPT" | "ACH_DISBURSEMENT" | "CASH_RECEIPT" | "CASH_DISBURSEMENT" | "ELECTRONIC_FUND" | "WIRE_OUT" | "WIRE_IN" | "JOURNAL" | "MEMORANDUM" | "MARGIN_CALL" | "MONEY_MARKET" | "SMA_ADJUSTMENT";
description: string;
tradeDate: string;
time: string;
activityType: "UNKNOWN" | "EXECUTION" | "ORDER_ACTION" | "ACTIVITY_CORRECTION" | "TRANSFER";
orderId: number;
activityId: number;
user: {
type: "UNKNOWN" | "ADVISOR_USER" | "BROKER_USER" | "CLIENT_USER" | "SYSTEM_USER";
cdDomainId: string;
login: string;
userId: number;
systemUserName: string;
firstName: string;
lastName: string;
brokerRepCode: string;
};
subAccount: "UNKNOWN" | "MARGIN" | "CASH" | "SHORT" | "DIV" | "INCOME";
settlementDate: string;
positionId: number;
netAmount: number;
transferItems: {
instrument: {
symbol: string;
type: "UNKNOWN" | "SWEEP_VEHICLE" | "SAVINGS" | "MONEY_MARKET_FUND";
description: string;
assetType: "CASH_EQUIVALENT";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
description: string;
assetType: "COLLECTIVE_INVESTMENT";
cusip: string;
type?: any;
netChange?: number | undefined;
instrumentId?: any;
} | {
symbol: string;
description: string;
assetType: "CURRENCY";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
type: "UNKNOWN" | "COMMON_STOCK" | "PREFERRED_STOCK" | "WARRANT" | "DEPOSITORY_RECEIPT" | "PREFERRED_DEPOSITORY_RECEIPT" | "RESTRICTED_STOCK" | "COMPONENT_UNIT" | "RIGHT" | "CONVERTIBLE_PREFERRED_STOCK" | "CONVERTIBLE_STOCK" | "LIMITED_PARTNERSHIP" | "WHEN_ISSUED";
description: string;
assetType: "EQUITY";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
type: "UNKNOWN" | "BOND_UNIT" | "CERTIFICATE_OF_DEPOSIT" | "CONVERTIBLE_BOND" | "COLLATERALIZED_MORTGAGE_OBLIGATION" | "CORPORATE_BOND" | "GOVERNMENT_MORTGAGE" | "GNMA_BONDS" | "MUNICIPAL_ASSESSMENT_DISTRICT" | "MUNICIPAL_BOND" | "OTHER_GOVERNMENT" | "SHORT_TERM_PAPER" | "US_TREASURY_BOND" | "US_TREASURY_BILL" | "US_TREASURY_NOTE" | "US_TREASURY_ZERO_COUPON" | "AGENCY_BOND" | "WHEN_AS_AND_IF_ISSUED_BOND" | "ASSET_BACKED_SECURITY";
description: string;
assetType: "FIXED_INCOME";
cusip: string;
multiplier: number;
maturityDate: string;
factor: number;
variableRate: number;
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {
symbol: string;
type: "UNKNOWN" | "STANDARD" | "NBBO";
description: string;
assetType: "FOREX";
cusip: string;
baseCurrency: {
symbol: string;
description: string;
assetType: "CURRENCY";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
};
counterCurrency: {
symbol: string;
description: string;
assetType: "CURRENCY";
cusip: string;
netChange?: number | undefined;
instrumentId?: number | undefined;
};
netChange?: number | undefined;
instrumentId?: number | undefined;
} | {