chemas

AccountNumberHash{
accountNumber string
hashValue string
}
sessionstringEnum:
[ NORMAL, AM, PM, SEAMLESS ]
durationstringEnum:
[ DAY, GOOD_TILL_CANCEL, FILL_OR_KILL, IMMEDIATE_OR_CANCEL, END_OF_WEEK,
END_OF_MONTH, NEXT_END_OF_MONTH, UNKNOWN ]
orderTypestringEnum:
[ MARKET, LIMIT, STOP, STOP_LIMIT, TRAILING_STOP, CABINET, NON_MARKETABLE,
MARKET_ON_CLOSE, EXERCISE, TRAILING_STOP_LIMIT, NET_DEBIT, NET_CREDIT, NET_ZERO,
LIMIT_ON_CLOSE, UNKNOWN ]
orderTypeRequeststring
Same as orderType, but does not have UNKNOWN since this type is not allowed as an
input

Enum:
[ MARKET, LIMIT, STOP, STOP_LIMIT, TRAILING_STOP, CABINET, NON_MARKETABLE,
MARKET_ON_CLOSE, EXERCISE, TRAILING_STOP_LIMIT, NET_DEBIT, NET_CREDIT, NET_ZERO,
LIMIT_ON_CLOSE ]
complexOrderStrategyType stringEnum:
[ NONE, COVERED, VERTICAL, BACK_RATIO, CALENDAR, DIAGONAL, STRADDLE, STRANGLE,
COLLAR_SYNTHETIC, BUTTERFLY, CONDOR, IRON_CONDOR, VERTICAL_ROLL, COLLAR_WITH_STOCK,
DOUBLE_DIAGONAL, UNBALANCED_BUTTERFLY, UNBALANCED_CONDOR, UNBALANCED_IRON_CONDOR,
UNBALANCED_VERTICAL_ROLL, MUTUAL_FUND_SWAP, CUSTOM ]
requestedDestinationstringEnum:
[ INET, ECN_ARCA, CBOE, AMEX, PHLX, ISE, BOX, NYSE, NASDAQ, BATS, C2, AUTO ]
stopPriceLinkBasisstringEnum:
[ MANUAL, BASE, TRIGGER, LAST, BID, ASK, ASK_BID, MARK, AVERAGE ]
stopPriceLinkTypestringEnum:
[ VALUE, PERCENT, TICK ]
stopPriceOffsetnumber($double)
stopTypestringEnum:
[ STANDARD, BID, ASK, LAST, MARK ]
priceLinkBasisstringEnum:
[ MANUAL, BASE, TRIGGER, LAST, BID, ASK, ASK_BID, MARK, AVERAGE ]
priceLinkTypestringEnum:
[ VALUE, PERCENT, TICK ]
taxLotMethodstringEnum:
[ FIFO, LIFO, HIGH_COST, LOW_COST, AVERAGE_COST, SPECIFIC_LOT, LOSS_HARVESTER ]
specialInstructionstringEnum:
[ ALL_OR_NONE, DO_NOT_REDUCE, ALL_OR_NONE_DO_NOT_REDUCE ]
orderStrategyTypestringEnum:
[ SINGLE, CANCEL, RECALL, PAIR, FLATTEN, TWO_DAY_SWAP, BLAST_ALL, OCO, TRIGGER ]
statusstringEnum:
[ AWAITING_PARENT_ORDER, AWAITING_CONDITION, AWAITING_STOP_CONDITION,
AWAITING_MANUAL_REVIEW, ACCEPTED, AWAITING_UR_OUT, PENDING_ACTIVATION, QUEUED,
WORKING, REJECTED, PENDING_CANCEL, CANCELED, PENDING_REPLACE, REPLACED, FILLED,
EXPIRED, NEW, AWAITING_RELEASE_TIME, PENDING_ACKNOWLEDGEMENT, PENDING_RECALL,
UNKNOWN ]
amountIndicatorstringEnum:
[ DOLLARS, SHARES, ALL_SHARES, PERCENTAGE, UNKNOWN ]
settlementInstructionstringEnum:
[ REGULAR, CASH, NEXT_DAY, UNKNOWN ]
OrderStrategy{
accountNumber string
advancedOrderType stringEnum:
[ NONE, OTO, OCO, OTOCO, OT2OCO, OT3OCO, BLAST_ALL, OTA, PAIR ]
closeTime string($date-time)
enteredTime string($date-time)
orderBalance OrderBalance{
orderValue number($double)
projectedAvailableFund number($double)
projectedBuyingPower number($double)
projectedCommission number($double)
}
orderStrategyType orderStrategyTypestringEnum:
[ SINGLE, CANCEL, RECALL, PAIR, FLATTEN, TWO_DAY_SWAP, BLAST_ALL, OCO, TRI
orderVersion number
session sessionstringEnum:
[ NORMAL, AM, PM, SEAMLESS ]
status apiOrderStatusstringEnum:
[ AWAITING_PARENT_ORDER, AWAITING_CONDITION, AWAITING_STOP_CONDITION, AWAI
PENDING_ACTIVATION, QUEUED, WORKING, REJECTED, PENDING_CANCEL, CANCELED, P
AWAITING_RELEASE_TIME, PENDING_ACKNOWLEDGEMENT, PENDING_RECALL, UNKNOWN ]
allOrNone boolean
discretionary boolean
duration durationstringEnum:
[ DAY, GOOD_TILL_CANCEL, FILL_OR_KILL, IMMEDIATE_OR_CANCEL, END_OF_WEEK, E
filledQuantity number($double)
orderType orderTypestringEnum:
[ MARKET, LIMIT, STOP, STOP_LIMIT, TRAILING_STOP, CABINET, NON_MARKETABLE,
NET_CREDIT, NET_ZERO, LIMIT_ON_CLOSE, UNKNOWN ]
orderValue number($double)
price number($double)
quantity number($double)
remainingQuantity number($double)
sellNonMarginableFirs boolean
t
settlementInstruction settlementInstructionstringEnum:
[ REGULAR, CASH, NEXT_DAY, UNKNOWN ]
strategy complexOrderStrategyTypestringEnum:
[ NONE, COVERED, VERTICAL, BACK_RATIO, CALENDAR, DIAGONAL, STRADDLE, STRAN
VERTICAL_ROLL, COLLAR_WITH_STOCK, DOUBLE_DIAGONAL, UNBALANCED_BUTTERFLY, U
UNBALANCED_VERTICAL_ROLL, MUTUAL_FUND_SWAP, CUSTOM ]
amountIndicator amountIndicatorstringEnum:
[ DOLLARS, SHARES, ALL_SHARES, PERCENTAGE, UNKNOWN ]
orderLegs [
xml: OrderedMap { "name": "orderLeg", "wrapped": true }
OrderLeg{
askPrice number($double)
bidPrice number($double)
lastPrice number($double)
markPrice number($double)
projectedCommission number($double)
quantity number($double)
finalSymbol string
legId number($long)
assetType assetTypestringEnum:
[ EQUITY, MUTUAL_FUND, OPTION, FUTURE, FOREX, INDE
COLLECTIVE_INVESTMENT ]
instruction instructionstringEnum:
[ BUY, SELL, BUY_TO_COVER, SELL_SHORT, BUY_TO_OPEN
SELL_SHORT_EXEMPT ]
 }]
}
OrderLeg{
askPrice number($double)
bidPrice number($double)
lastPrice number($double)
markPrice number($double)
projectedCommission number($double)
quantity number($double)
finalSymbol string
legId number($long)
assetType assetTypestringEnum:
[ EQUITY, MUTUAL_FUND, OPTION, FUTURE, FOREX, INDEX, CASH_EQUIVALENT, FIXED_
instruction instructionstringEnum:
[ BUY, SELL, BUY_TO_COVER, SELL_SHORT, BUY_TO_OPEN, BUY_TO_CLOSE, SELL_TO_OP
}
OrderBalance{
orderValue number($double
)
projectedAvailableFun number($double
d )
projectedBuyingPower number($double
)
projectedCommission number($double
)
}
OrderValidationResult{
alerts [OrderValidationDetail{
validationRuleName string
message string
activityMessage string
originalSeverity APIRuleActionstringEnum:
[ ACCEPT, ALERT, REJECT, REVIEW, UNKNOWN ]
overrideName string
overrideSeverity APIRuleActionstringEnum:
[ ACCEPT, ALERT, REJECT, REVIEW, UNKNOWN ]
}]
accepts [OrderValidationDetail{
validationRuleName string
message string
activityMessage string
originalSeverity APIRuleActionstringEnum:
[ ACCEPT, ALERT, REJECT, REVIEW, UNKNOWN ]
overrideName string
overrideSeverity APIRuleActionstringEnum:
[ ACCEPT, ALERT, REJECT, REVIEW, UNKNOWN ]
}]
rejects [OrderValidationDetail{
validationRuleName string
message string
activityMessage string
originalSeverity APIRuleActionstringEnum:
[ ACCEPT, ALERT, REJECT, REVIEW, UNKNOWN ]
overrideName string
overrideSeverity APIRuleActionstringEnum:
[ ACCEPT, ALERT, REJECT, REVIEW, UNKNOWN ]
}]
reviews [OrderValidationDetail{
validationRuleName string
message string
 activityMessage string
originalSeverity APIRuleActionstringEnum:
[ ACCEPT, ALERT, REJECT, REVIEW, UNKNOWN ]
overrideName string
overrideSeverity APIRuleActionstringEnum:
[ ACCEPT, ALERT, REJECT, REVIEW, UNKNOWN ]
}]
warns [OrderValidationDetail{
validationRuleName string
message string
activityMessage string
originalSeverity APIRuleActionstringEnum:
[ ACCEPT, ALERT, REJECT, REVIEW, UNKNOWN ]
overrideName string
overrideSeverity APIRuleActionstringEnum:
[ ACCEPT, ALERT, REJECT, REVIEW, UNKNOWN ]
}]
}
OrderValidationDetail{
validationRuleName string
message string
activityMessage string
originalSeverity APIRuleActionstringEnum:
[ ACCEPT, ALERT, REJECT, REVIEW, UNKNOWN ]
overrideName string
overrideSeverity APIRuleActionstringEnum:
[ ACCEPT, ALERT, REJECT, REVIEW, UNKNOWN ]
}
APIRuleActionstringEnum:
[ ACCEPT, ALERT, REJECT, REVIEW, UNKNOWN ]
CommissionAndFee{
commission Commission{
commissionLegs [CommissionLeg{
commissionValues [CommissionValue{
value numb
type FeeT
[ CO
ADDI
FUTU
FUTU
LOW_
TAF_
}]
}]
}
fee Fees{
feeLegs [FeeLeg{
feeValues [FeeValue{
value numb
type FeeT
[ CO
ADDI
FUTU
FUTU
LOW_
TAF_
}]
}]
}
 trueCommission Commission{
commissionLegs [CommissionLeg{
commissionValues [CommissionValue{
value numb
type FeeT
[ CO
ADDI
FUTU
FUTU
LOW_
TAF_
}]
}]
}
}
Commission{
commissionLegs [CommissionLeg{
commissionValues [CommissionValue{
value number($double)
type FeeTypestringEnum:
[ COMMISSION, SEC_FEE, STR_F
MISCELLANEOUS_FEE, FTT, FUTU
FUTURES_GLOBEX_FEE, FUTURES_
LOW_PROCEEDS_COMMISSION, BAS
TEFRA_TAX, STATE_TAX, UNKNOW
}]
}]
}
CommissionLeg{
commissionValues [CommissionValue{
value number($double)
type FeeTypestringEnum:
[ COMMISSION, SEC_FEE, STR_FEE, R_FEE, CDSC_FEE, OPT
FUTURES_CLEARING_FEE, FUTURES_DESK_OFFICE_FEE, FUTUR
FUTURES_PIT_BROKERAGE_FEE, FUTURES_TRANSACTION_FEE,
TAF_FEE, INDEX_OPTION_FEE, TEFRA_TAX, STATE_TAX, UNK
}]
}
CommissionValue{
value number($double)
type FeeTypestringEnum:
[ COMMISSION, SEC_FEE, STR_FEE, R_FEE, CDSC_FEE, OPT_REG_FEE, ADDITIONAL_FEE
FUTURES_DESK_OFFICE_FEE, FUTURES_EXCHANGE_FEE, FUTURES_GLOBEX_FEE, FUTURES_N
LOW_PROCEEDS_COMMISSION, BASE_CHARGE, GENERAL_CHARGE, GST_FEE, TAF_FEE, INDE
}
Fees{
feeLegs [FeeLeg{
feeValues [FeeValue{
value number($double)
type FeeTypestringEnum:
[ COMMISSION, SEC_FEE, STR_F
MISCELLANEOUS_FEE, FTT, FUTU
FUTURES_GLOBEX_FEE, FUTURES_
LOW_PROCEEDS_COMMISSION, BAS
TEFRA_TAX, STATE_TAX, UNKNOW
}]
}]
}
FeeLeg{
feeValues [FeeValue{
value number($double)
type FeeTypestringEnum:
[ COMMISSION, SEC_FEE, STR_FEE, R_FEE, CDSC_FEE, OPT
FUTURES_CLEARING_FEE, FUTURES_DESK_OFFICE_FEE, FUTUR
FUTURES_PIT_BROKERAGE_FEE, FUTURES_TRANSACTION_FEE,
TAF_FEE, INDEX_OPTION_FEE, TEFRA_TAX, STATE_TAX, UNK
}]
}
FeeValue{
value number($double)
type FeeTypestringEnum:
[ COMMISSION, SEC_FEE, STR_FEE, R_FEE, CDSC_FEE, OPT_REG_FEE, ADDITIONAL_FEE
FUTURES_DESK_OFFICE_FEE, FUTURES_EXCHANGE_FEE, FUTURES_GLOBEX_FEE, FUTURES_N
LOW_PROCEEDS_COMMISSION, BASE_CHARGE, GENERAL_CHARGE, GST_FEE, TAF_FEE, INDE
}
FeeTypestringEnum:
[ COMMISSION, SEC_FEE, STR_FEE, R_FEE, CDSC_FEE, OPT_REG_FEE, ADDITIONAL_FEE,
MISCELLANEOUS_FEE, FTT, FUTURES_CLEARING_FEE, FUTURES_DESK_OFFICE_FEE,
FUTURES_EXCHANGE_FEE, FUTURES_GLOBEX_FEE, FUTURES_NFA_FEE, FUTURES_PIT_BROKERAGE_FEE,
FUTURES_TRANSACTION_FEE, LOW_PROCEEDS_COMMISSION, BASE_CHARGE, GENERAL_CHARGE,
GST_FEE, TAF_FEE, INDEX_OPTION_FEE, TEFRA_TAX, STATE_TAX, UNKNOWN ]
Account{
securitiesAccoun SecuritiesAccount{
t oneO MarginAccount{
f -> type stringEnum:
[ CASH, MARGIN ]
accountNumber string
roundTrips integer($int32)
isDayTrader boolean
default: false
isClosingOnlyRestricte boolean
d default: false
pfcbFlag boolean
default: false
positions [Position{
shortQuantity number($d
averagePrice number($d
currentDayProfitLoss number($d
currentDayProfitLossPercenta number($d
ge
longQuantity number($d
settledLongQuantity number($d
settledShortQuantity number($d
agedQuantity number($d
instrument Account
oneO
f ->
 }
marketValue number($d
maintenanceRequirement number($d
averageLongPrice number($d
averageShortPrice number($d
taxLotAverageLongPrice number($d
taxLotAverageShortPrice number($d
longOpenProfitLoss number($d
shortOpenProfitLoss number($d
previousSessionLongQuantity number($d
previousSessionShortQuantity number($d
currentDayCost number($d
}]
initialBalances MarginInitialBalance{
accruedInterest number
availableFundsNonMarginableTrade number
bondValue number
buyingPower number
cashBalance number
cashAvailableForTrading number
cashReceipts number
dayTradingBuyingPower number
dayTradingBuyingPowerCall number
dayTradingEquityCall number
equity number
equityPercentage number
liquidationValue number
longMarginValue number
longOptionMarketValue number
longStockValue number
maintenanceCall number
maintenanceRequirement number
margin number
marginEquity number
moneyMarketFund number
mutualFundValue number
regTCall number
shortMarginValue number
shortOptionMarketValue number
shortStockValue number
totalCash number
isInCall number
unsettledCash number
pendingDeposits number
marginBalance number
shortBalance number
accountValue number
}
 currentBalances MarginBalance{
availableFunds number
availableFundsNonMarginableTrade number
buyingPower number
buyingPowerNonMarginableTrade number
dayTradingBuyingPower number
dayTradingBuyingPowerCall number
equity number
equityPercentage number
longMarginValue number
maintenanceCall number
maintenanceRequirement number
marginBalance number
regTCall number
shortBalance number
shortMarginValue number
sma number
isInCall number
stockBuyingPower number
optionBuyingPower number
}
projectedBalances MarginBalance{
availableFunds number
availableFundsNonMarginableTrade number
buyingPower number
buyingPowerNonMarginableTrade number
dayTradingBuyingPower number
dayTradingBuyingPowerCall number
equity number
equityPercentage number
longMarginValue number
maintenanceCall number
maintenanceRequirement number
marginBalance number
regTCall number
shortBalance number
shortMarginValue number
sma number
isInCall number
stockBuyingPower number
optionBuyingPower number
}
}
CashAccount{
type stringEnum:
[ CASH, MARGIN ]
accountNumber string
roundTrips integer($int32)
isDayTrader boolean
default: false
isClosingOnlyRestricte boolean
d default: false
pfcbFlag boolean
default: false
positions [Position{
shortQuantity number($d
averagePrice number($d
currentDayProfitLoss number($d
currentDayProfitLossPercenta number($d
ge
longQuantity number($d
settledLongQuantity number($d
settledShortQuantity number($d
agedQuantity number($d
instrument Account
oneO
f ->
 }
marketValue number($d
maintenanceRequirement number($d
averageLongPrice number($d
averageShortPrice number($d
taxLotAverageLongPrice number($d
taxLotAverageShortPrice number($d
longOpenProfitLoss number($d
shortOpenProfitLoss number($d
previousSessionLongQuantity number($d
previousSessionShortQuantity number($d
currentDayCost number($d
}]
initialBalances CashInitialBalance{
accruedInterest number($doub
cashAvailableForTrading number($doub
cashAvailableForWithdrawal number($doub
cashBalance number($doub
bondValue number($doub
cashReceipts number($doub
liquidationValue number($doub
longOptionMarketValue number($doub
longStockValue number($doub
moneyMarketFund number($doub
mutualFundValue number($doub
shortOptionMarketValue number($doub
shortStockValue number($doub
isInCall number($doub
unsettledCash number($doub
cashDebitCallValue number($doub
pendingDeposits number($doub
accountValue number($doub
}
 currentBalances CashBalance{
cashAvailableForTrading number($do
cashAvailableForWithdrawal number($do
cashCall number($do
longNonMarginableMarketValue number($do
totalCash number($do
cashDebitCallValue number($do
unsettledCash number($do
}
projectedBalances CashBalance{
cashAvailableForTrading number($do
cashAvailableForWithdrawal number($do
cashCall number($do
longNonMarginableMarketValue number($do
totalCash number($do
cashDebitCallValue number($do
unsettledCash number($do
}
}
}
}
DateParam{
date string
Valid ISO-8601 format is :
yyyy-MM-dd'T'HH:mm:[Link]

}
Order{
session sessionstringEnum:
[ NORMAL, AM, PM, SEAMLESS ]
duration durationstringEnum:
[ DAY, GOOD_TILL_CANCEL, FILL_OR_KILL, IMMEDIATE_OR_CANCEL, END_OF_WEEK,
orderType orderTypestringEnum:
[ MARKET, LIMIT, STOP, STOP_LIMIT, TRAILING_STOP, CABINET, NON_MARKETABL
NET_CREDIT, NET_ZERO, LIMIT_ON_CLOSE, UNKNOWN ]
cancelTime string($date-time)
complexOrderStrategyTyp complexOrderStrategyTypestringEnum:
e [ NONE, COVERED, VERTICAL, BACK_RATIO, CALENDAR, DIAGONAL, STRADDLE, STR
VERTICAL_ROLL, COLLAR_WITH_STOCK, DOUBLE_DIAGONAL, UNBALANCED_BUTTERFLY,
UNBALANCED_VERTICAL_ROLL, MUTUAL_FUND_SWAP, CUSTOM ]
quantity number($double)
filledQuantity number($double)
remainingQuantity number($double)
requestedDestination requestedDestinationstringEnum:
[ INET, ECN_ARCA, CBOE, AMEX, PHLX, ISE, BOX, NYSE, NASDAQ, BATS, C2, AU
destinationLinkName string
releaseTime string($date-time)
stopPrice number($double)
stopPriceLinkBasis stopPriceLinkBasisstringEnum:
[ MANUAL, BASE, TRIGGER, LAST, BID, ASK, ASK_BID, MARK, AVERAGE ]
stopPriceLinkType stopPriceLinkTypestringEnum:
[ VALUE, PERCENT, TICK ]
stopPriceOffset number($double)
stopType stopTypestringEnum:
[ STANDARD, BID, ASK, LAST, MARK ]
priceLinkBasis priceLinkBasisstringEnum:
[ MANUAL, BASE, TRIGGER, LAST, BID, ASK, ASK_BID, MARK, AVERAGE ]
priceLinkType priceLinkTypestringEnum:
[ VALUE, PERCENT, TICK ]
price number($double)
taxLotMethod taxLotMethodstringEnum:
 [ FIFO, LIFO, HIGH_COST, LOW_COST, AVERAGE_COST, SPECIFIC_LOT, LOSS_HARV
orderLegCollection [
xml: OrderedMap { "name": "orderLegCollection", "wrapped": true }
OrderLegCollection{
orderLegType stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIV
legId integer($int64)
instrument AccountsInstrument{
oneOf -> AccountCashEquivale
assetType*

cusip
symbol
description
instrumentId
netChange
type

}
AccountEquity{
assetType*

cusip
symbol
description
instrumentId
netChange
}
AccountFixedIncome{
assetType*

cusip
symbol
description
instrumentId
netChange
maturityDate
factor
variableRate
}
AccountMutualFund{
assetType*

cusip
symbol
description
instrumentId
netChange
}
AccountOption{
assetType*

cusip
symbol
description
 instrumentId
netChange
optionDeliverables

putCall

optionMultiplier
type

underlyingSymbol
}
}
instruction instructionstringEnum:
[ BUY, SELL, BUY_TO_COVER, SELL_SHORT, BUY_TO_OP
SELL_SHORT_EXEMPT ]
positionEffect stringEnum:
[ OPENING, CLOSING, AUTOMATIC ]
quantity number($double)
quantityType stringEnum:
[ ALL_SHARES, DOLLARS, SHARES ]
divCapGains stringEnum:
[ REINVEST, PAYOUT ]
toSymbol string
}]
activationPrice number($double)
specialInstruction specialInstructionstringEnum:
[ ALL_OR_NONE, DO_NOT_REDUCE, ALL_OR_NONE_DO_NOT_REDUCE ]
orderStrategyType orderStrategyTypestringEnum:
[ SINGLE, CANCEL, RECALL, PAIR, FLATTEN, TWO_DAY_SWAP, BLAST_ALL, OCO, T
orderId integer($int64)
cancelable boolean
default: false
editable boolean
default: false
status statusstringEnum:
[ AWAITING_PARENT_ORDER, AWAITING_CONDITION, AWAITING_STOP_CONDITION, AW
PENDING_ACTIVATION, QUEUED, WORKING, REJECTED, PENDING_CANCEL, CANCELED,
AWAITING_RELEASE_TIME, PENDING_ACKNOWLEDGEMENT, PENDING_RECALL, UNKNOWN
enteredTime string($date-time)
closeTime string($date-time)
tag string
accountNumber integer($int64)
orderActivityCollection [
xml: OrderedMap { "name": "orderActivity", "wrapped": true }
OrderActivity{
activityType stringEnum:
[ EXECUTION, ORDER_ACTION ]
executionType stringEnum:
[ FILL ]
quantity number($double)
 orderRemainingQuantit number($double)
y
executionLegs [
xml: OrderedMap { "name": "executionLegs", "w
ExecutionLeg{
legId integer($int64)
price number($double)
quantity number($double)
mismarkedQuantity number($double)
instrumentId integer($int64)
time string($date-time)
}]
}]
replacingOrderCollectio [
n xml: OrderedMap { "name": "replacingOrder", "wrapped": true }
{
}]
childOrderStrategies [
xml: OrderedMap { "name": "childOrder", "wrapped": true }
{
}]
statusDescription string
}
OrderRequest{
session sessionstringEnum:
[ NORMAL, AM, PM, SEAMLESS ]
duration durationstringEnum:
[ DAY, GOOD_TILL_CANCEL, FILL_OR_KILL, IMMEDIATE_OR_CANCEL, END_OF_WEEK,
orderType orderTypeRequeststring
Same as orderType, but does not have UNKNOWN since this type is not allo

Enum:
[ MARKET, LIMIT, STOP, STOP_LIMIT, TRAILING_STOP, CABINET, NON_MARKETABL
NET_CREDIT, NET_ZERO, LIMIT_ON_CLOSE ]
cancelTime string($date-time)
complexOrderStrategyTyp complexOrderStrategyTypestringEnum:
e [ NONE, COVERED, VERTICAL, BACK_RATIO, CALENDAR, DIAGONAL, STRADDLE, STR
VERTICAL_ROLL, COLLAR_WITH_STOCK, DOUBLE_DIAGONAL, UNBALANCED_BUTTERFLY,
UNBALANCED_VERTICAL_ROLL, MUTUAL_FUND_SWAP, CUSTOM ]
quantity number($double)
filledQuantity number($double)
remainingQuantity number($double)
destinationLinkName string
releaseTime string($date-time)
stopPrice number($double)
stopPriceLinkBasis stopPriceLinkBasisstringEnum:
[ MANUAL, BASE, TRIGGER, LAST, BID, ASK, ASK_BID, MARK, AVERAGE ]
stopPriceLinkType stopPriceLinkTypestringEnum:
[ VALUE, PERCENT, TICK ]
stopPriceOffset number($double)
stopType stopTypestringEnum:
[ STANDARD, BID, ASK, LAST, MARK ]
priceLinkBasis priceLinkBasisstringEnum:
[ MANUAL, BASE, TRIGGER, LAST, BID, ASK, ASK_BID, MARK, AVERAGE ]
priceLinkType priceLinkTypestringEnum:
[ VALUE, PERCENT, TICK ]
price number($double)
taxLotMethod taxLotMethodstringEnum:
[ FIFO, LIFO, HIGH_COST, LOW_COST, AVERAGE_COST, SPECIFIC_LOT, LOSS_HARV
orderLegCollection [
xml: OrderedMap { "name": "orderLegCollection", "wrapped": true }
OrderLegCollection{
orderLegType stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIV
legId integer($int64)
instrument AccountsInstrument{
oneOf -> AccountCashEquivale
assetType*

cusip
symbol
description
instrumentId
netChange
type

}
AccountEquity{
assetType*

cusip
symbol
description
instrumentId
netChange
}
AccountFixedIncome{
assetType*

cusip
symbol
description
instrumentId
netChange
maturityDate
factor
variableRate
}
AccountMutualFund{
assetType*

cusip
symbol
description
instrumentId
netChange
}
AccountOption{
assetType*

cusip
symbol
description
instrumentId
netChange
optionDeliverables
 putCall

optionMultiplier
type

underlyingSymbol
}
}
instruction instructionstringEnum:
[ BUY, SELL, BUY_TO_COVER, SELL_SHORT, BUY_TO_OP
SELL_SHORT_EXEMPT ]
positionEffect stringEnum:
[ OPENING, CLOSING, AUTOMATIC ]
quantity number($double)
quantityType stringEnum:
[ ALL_SHARES, DOLLARS, SHARES ]
divCapGains stringEnum:
[ REINVEST, PAYOUT ]
toSymbol string
}]
activationPrice number($double)
specialInstruction specialInstructionstringEnum:
[ ALL_OR_NONE, DO_NOT_REDUCE, ALL_OR_NONE_DO_NOT_REDUCE ]
orderStrategyType orderStrategyTypestringEnum:
[ SINGLE, CANCEL, RECALL, PAIR, FLATTEN, TWO_DAY_SWAP, BLAST_ALL, OCO, T
orderId integer($int64)
cancelable boolean
default: false
editable boolean
default: false
status statusstringEnum:
[ AWAITING_PARENT_ORDER, AWAITING_CONDITION, AWAITING_STOP_CONDITION, AW
PENDING_ACTIVATION, QUEUED, WORKING, REJECTED, PENDING_CANCEL, CANCELED,
AWAITING_RELEASE_TIME, PENDING_ACKNOWLEDGEMENT, PENDING_RECALL, UNKNOWN
enteredTime string($date-time)
closeTime string($date-time)
accountNumber integer($int64)
orderActivityCollection [
xml: OrderedMap { "name": "orderActivity", "wrapped": true }
OrderActivity{
activityType stringEnum:
[ EXECUTION, ORDER_ACTION ]
executionType stringEnum:
[ FILL ]
quantity number($double)
orderRemainingQuantit number($double)
y
executionLegs [
xml: OrderedMap { "name": "executionLegs", "w
ExecutionLeg{
legId integer($int64)
 price number($double)
quantity number($double)
mismarkedQuantity number($double)
instrumentId integer($int64)
time string($date-time)
}]
}]
replacingOrderCollectio [
n xml: OrderedMap { "name": "replacingOrder", "wrapped": true }
{
}]
childOrderStrategies [
xml: OrderedMap { "name": "childOrder", "wrapped": true }
{
}]
statusDescription string
}
PreviewOrder{
orderId integer($int64)
orderStrategy OrderStrategy{
accountNumber string
advancedOrderType stringEnum:
[ NONE, OTO, OCO, OTOCO, OT2OCO, OT3OCO, BLAST_A
closeTime string($date-time)
enteredTime string($date-time)
orderBalance OrderBalance{
orderValue number($double)
projectedAvailableFund number($double)
projectedBuyingPower number($double)
projectedCommission number($double)
}
orderStrategyType orderStrategyTypestringEnum:
[ SINGLE, CANCEL, RECALL, PAIR, FLATTEN, TWO_DAY
orderVersion number
session sessionstringEnum:
[ NORMAL, AM, PM, SEAMLESS ]
status apiOrderStatusstringEnum:
[ AWAITING_PARENT_ORDER, AWAITING_CONDITION, AWA
AWAITING_UR_OUT, PENDING_ACTIVATION, QUEUED, WOR
REPLACED, FILLED, EXPIRED, NEW, AWAITING_RELEASE
allOrNone boolean
discretionary boolean
duration durationstringEnum:
[ DAY, GOOD_TILL_CANCEL, FILL_OR_KILL, IMMEDIATE
UNKNOWN ]
filledQuantity number($double)
orderType orderTypestringEnum:
[ MARKET, LIMIT, STOP, STOP_LIMIT, TRAILING_STOP
TRAILING_STOP_LIMIT, NET_DEBIT, NET_CREDIT, NET_
orderValue number($double)
price number($double)
quantity number($double)
remainingQuantity number($double)
sellNonMarginableFirs boolean
t
settlementInstruction settlementInstructionstringEnum:
[ REGULAR, CASH, NEXT_DAY, UNKNOWN ]
strategy complexOrderStrategyTypestringEnum:
[ NONE, COVERED, VERTICAL, BACK_RATIO, CALENDAR,
CONDOR, IRON_CONDOR, VERTICAL_ROLL, COLLAR_WITH_
UNBALANCED_IRON_CONDOR, UNBALANCED_VERTICAL_ROLL
amountIndicator amountIndicatorstringEnum:
 [ DOLLARS, SHARES, ALL_SHARES, PERCENTAGE, UNKNO
orderLegs [
xml: OrderedMap { "name": "orderLeg", "wrapped":
OrderLeg{
askPrice number($double)
bidPrice number($double)
lastPrice number($double)
markPrice number($double)
projectedCommission number($double)
quantity number($double)
finalSymbol string
legId number($long)
assetType assetTypestringEnum:
[ EQUITY, MUTUAL_FUND, O
PRODUCT, CURRENCY, COLLE
instruction instructionstringEnum:
[ BUY, SELL, BUY_TO_COVE
SELL_TO_CLOSE, EXCHANGE,
}]
}
orderValidationResul OrderValidationResult{
t alerts [OrderValidationDetail{
validationRuleName string
message string
activityMessage string
originalSeverity APIRuleActionstringEnum:
[ ACCEPT, ALERT, REJECT, R
overrideName string
overrideSeverity APIRuleActionstringEnum:
[ ACCEPT, ALERT, REJECT, R
}]
accepts [OrderValidationDetail{
validationRuleName string
message string
activityMessage string
originalSeverity APIRuleActionstringEnum:
[ ACCEPT, ALERT, REJECT, R
overrideName string
overrideSeverity APIRuleActionstringEnum:
[ ACCEPT, ALERT, REJECT, R
}]
rejects [OrderValidationDetail{
validationRuleName string
message string
activityMessage string
originalSeverity APIRuleActionstringEnum:
[ ACCEPT, ALERT, REJECT, R
overrideName string
overrideSeverity APIRuleActionstringEnum:
[ ACCEPT, ALERT, REJECT, R
}]
reviews [OrderValidationDetail{
validationRuleName string
message string
activityMessage string
originalSeverity APIRuleActionstringEnum:
[ ACCEPT, ALERT, REJECT, R
overrideName string
overrideSeverity APIRuleActionstringEnum:
[ ACCEPT, ALERT, REJECT, R
}]
 warns [OrderValidationDetail{
validationRuleName string
message string
activityMessage string
originalSeverity APIRuleActionstringEnum:
[ ACCEPT, ALERT, REJECT, R
overrideName string
overrideSeverity APIRuleActionstringEnum:
[ ACCEPT, ALERT, REJECT, R
}]
}
commissionAndFee CommissionAndFee{
commission Commission{
commissionLegs [CommissionLeg{
commissionValues [C

}]
}]
}
fee Fees{...}
trueCommission Commission{
commissionLegs [CommissionLeg{
commissionValues [C

}]
}]
}
}
}
OrderActivity{
activityType stringEnum:
[ EXECUTION, ORDER_ACTION ]
executionType stringEnum:
 [ FILL ]
quantity number($double)
orderRemainingQuantit number($double)
y
executionLegs [
xml: OrderedMap { "name": "executionLegs", "wrapped": true }
ExecutionLeg{
legId integer($int64)
price number($double)
quantity number($double)
mismarkedQuantity number($double)
instrumentId integer($int64)
time string($date-time)
}]
}
ExecutionLeg{
legId integer($int64)
price number($double)
quantity number($double)
mismarkedQuantity number($double)
instrumentId integer($int64)
time string($date-time)
}
Position{
shortQuantity number($double)
averagePrice number($double)
currentDayProfitLoss number($double)
currentDayProfitLossPercentag number($double)
e
longQuantity number($double)
settledLongQuantity number($double)
settledShortQuantity number($double)
agedQuantity number($double)
instrument AccountsInstrument{
oneOf -> AccountCashEquivalent{
assetType* stringEnum:
[ EQUITY, OPTION,
COLLECTIVE_INVEST
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ SWEEP_VEHICLE,
}
AccountEquity{
assetType* stringEnum:
[ EQUITY, OPTION,
COLLECTIVE_INVEST
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
}
AccountFixedIncome{
assetType* stringEnum:
[ EQUITY, OPTION,
COLLECTIVE_INVEST
 cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
maturityDate string($date-time
factor number($double)
variableRate number($double)
}
AccountMutualFund{
assetType* stringEnum:
[ EQUITY, OPTION,
COLLECTIVE_INVEST
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
}
AccountOption{
assetType* stringEnum:
[ EQUITY, OPTION,
COLLECTIVE_INVEST
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
optionDeliverables [
xml: OrderedMap {
AccountAPIOpti
symbol
deliverableUn
apiCurrencyTy

assetType

}]
putCall stringEnum:
[ PUT, CALL, UNKN
optionMultiplier integer($int32)
type stringEnum:
[ VANILLA, BINARY
underlyingSymbol string
}
}
marketValue number($double)
maintenanceRequirement number($double)
averageLongPrice number($double)
averageShortPrice number($double)
taxLotAverageLongPrice number($double)
taxLotAverageShortPrice number($double)
longOpenProfitLoss number($double)
shortOpenProfitLoss number($double)
previousSessionLongQuantity number($double)
previousSessionShortQuantity number($double)
currentDayCost number($double)
}
ServiceError{
message string
 errors [string]
}
OrderLegCollection{
orderLegType stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT, FIXED_INCOME, CURRENC
legId integer($int64)
instrument AccountsInstrument{
oneOf -> AccountCashEquivalent{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUT
COLLECTIVE_INVESTMENT ]
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ SWEEP_VEHICLE, SAVINGS, MO
}
AccountEquity{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUT
COLLECTIVE_INVESTMENT ]
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
}
AccountFixedIncome{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUT
COLLECTIVE_INVESTMENT ]
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
maturityDate string($date-time)
factor number($double)
variableRate number($double)
}
AccountMutualFund{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUT
COLLECTIVE_INVESTMENT ]
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
}
AccountOption{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUT
COLLECTIVE_INVESTMENT ]
cusip string
symbol string
description string
instrumentId integer($int64)
 netChange number($double)
optionDeliverables [
xml: OrderedMap { "name": "o
AccountAPIOptionDelivera
symbol stri
deliverableUnits numb
apiCurrencyType stri
[ US
assetType asse
[ EQ
CASH
COLL
}]
putCall stringEnum:
[ PUT, CALL, UNKNOWN ]
optionMultiplier integer($int32)
type stringEnum:
[ VANILLA, BINARY, BARRIER,
underlyingSymbol string
}
}
instruction instructionstringEnum:
[ BUY, SELL, BUY_TO_COVER, SELL_SHORT, BUY_TO_OPEN, BUY_TO_CLOSE, SELL_TO_OP
positionEffect stringEnum:
[ OPENING, CLOSING, AUTOMATIC ]
quantity number($double)
quantityType stringEnum:
[ ALL_SHARES, DOLLARS, SHARES ]
divCapGains stringEnum:
[ REINVEST, PAYOUT ]
toSymbol string
}
SecuritiesAccount{
oneOf -> MarginAccount{
type stringEnum:
[ CASH, MARGIN ]
accountNumber string
roundTrips integer($int32)
isDayTrader boolean
default: false
isClosingOnlyRestricte boolean
d default: false
pfcbFlag boolean
default: false
positions [Position{
shortQuantity number($double)
averagePrice number($double)
currentDayProfitLoss number($double)
currentDayProfitLossPercentag number($double)
e
longQuantity number($double)
settledLongQuantity number($double)
settledShortQuantity number($double)
agedQuantity number($double)
instrument AccountsInstr
oneOf -> Ac

}
 Ac
}
Ac

}
Ac
}
Ac

}
}
marketValue number($double)
maintenanceRequirement number($double)
averageLongPrice number($double)
averageShortPrice number($double)
taxLotAverageLongPrice number($double)
taxLotAverageShortPrice number($double)
longOpenProfitLoss number($double)
shortOpenProfitLoss number($double)
previousSessionLongQuantity number($double)
previousSessionShortQuantity number($double)
currentDayCost number($double)
}]
initialBalances MarginInitialBalance{
accruedInterest number($doubl
availableFundsNonMarginableTrade number($doubl
bondValue number($doubl
buyingPower number($doubl
cashBalance number($doubl
cashAvailableForTrading number($doubl
cashReceipts number($doubl
dayTradingBuyingPower number($doubl
dayTradingBuyingPowerCall number($doubl
dayTradingEquityCall number($doubl
 equity number($doubl
equityPercentage number($doubl
liquidationValue number($doubl
longMarginValue number($doubl
longOptionMarketValue number($doubl
longStockValue number($doubl
maintenanceCall number($doubl
maintenanceRequirement number($doubl
margin number($doubl
marginEquity number($doubl
moneyMarketFund number($doubl
mutualFundValue number($doubl
regTCall number($doubl
shortMarginValue number($doubl
shortOptionMarketValue number($doubl
shortStockValue number($doubl
totalCash number($doubl
isInCall number($doubl
unsettledCash number($doubl
pendingDeposits number($doubl
marginBalance number($doubl
shortBalance number($doubl
accountValue number($doubl
}
currentBalances MarginBalance{
availableFunds number($doubl
availableFundsNonMarginableTrade number($doubl
buyingPower number($doubl
buyingPowerNonMarginableTrade number($doubl
dayTradingBuyingPower number($doubl
dayTradingBuyingPowerCall number($doubl
equity number($doubl
equityPercentage number($doubl
longMarginValue number($doubl
maintenanceCall number($doubl
maintenanceRequirement number($doubl
marginBalance number($doubl
regTCall number($doubl
shortBalance number($doubl
shortMarginValue number($doubl
sma number($doubl
isInCall number($doubl
stockBuyingPower number($doubl
optionBuyingPower number($doubl
}
projectedBalances MarginBalance{
availableFunds number($doubl
availableFundsNonMarginableTrade number($doubl
buyingPower number($doubl
buyingPowerNonMarginableTrade number($doubl
dayTradingBuyingPower number($doubl
dayTradingBuyingPowerCall number($doubl
equity number($doubl
equityPercentage number($doubl
longMarginValue number($doubl
maintenanceCall number($doubl
maintenanceRequirement number($doubl
marginBalance number($doubl
regTCall number($doubl
shortBalance number($doubl
shortMarginValue number($doubl
sma number($doubl
 isInCall number($doubl
stockBuyingPower number($doubl
optionBuyingPower number($doubl
}
}
CashAccount{
type stringEnum:
[ CASH, MARGIN ]
accountNumber string
roundTrips integer($int32)
isDayTrader boolean
default: false
isClosingOnlyRestricte boolean
d default: false
pfcbFlag boolean
default: false
positions [Position{
shortQuantity number($double)
averagePrice number($double)
currentDayProfitLoss number($double)
currentDayProfitLossPercentag number($double)
e
longQuantity number($double)
settledLongQuantity number($double)
settledShortQuantity number($double)
agedQuantity number($double)
instrument AccountsInstr
oneOf -> Ac

}
Ac
}
Ac

}
Ac
}
Ac
 }
}
marketValue number($double)
maintenanceRequirement number($double)
averageLongPrice number($double)
averageShortPrice number($double)
taxLotAverageLongPrice number($double)
taxLotAverageShortPrice number($double)
longOpenProfitLoss number($double)
shortOpenProfitLoss number($double)
previousSessionLongQuantity number($double)
previousSessionShortQuantity number($double)
currentDayCost number($double)
}]
initialBalances CashInitialBalance{
accruedInterest number($double)
cashAvailableForTrading number($double)
cashAvailableForWithdrawal number($double)
cashBalance number($double)
bondValue number($double)
cashReceipts number($double)
liquidationValue number($double)
longOptionMarketValue number($double)
longStockValue number($double)
moneyMarketFund number($double)
mutualFundValue number($double)
shortOptionMarketValue number($double)
shortStockValue number($double)
isInCall number($double)
unsettledCash number($double)
cashDebitCallValue number($double)
pendingDeposits number($double)
accountValue number($double)
}
currentBalances CashBalance{
cashAvailableForTrading number($double)
cashAvailableForWithdrawal number($double)
cashCall number($double)
longNonMarginableMarketValue number($double)
totalCash number($double)
cashDebitCallValue number($double)
unsettledCash number($double)
}
projectedBalances CashBalance{
cashAvailableForTrading number($double)
cashAvailableForWithdrawal number($double)
cashCall number($double)
longNonMarginableMarketValue number($double)
totalCash number($double)
cashDebitCallValue number($double)
unsettledCash number($double)
}
}
}
SecuritiesAccountBase{
type stringEnum:
[ CASH, MARGIN ]
accountNumber string
roundTrips integer($int32)
isDayTrader boolean
default: false
isClosingOnlyRestricte boolean
d default: false
pfcbFlag boolean
default: false
positions [Position{
shortQuantity number($double)
averagePrice number($double)
currentDayProfitLoss number($double)
currentDayProfitLossPercentag number($double)
e
longQuantity number($double)
settledLongQuantity number($double)
settledShortQuantity number($double)
agedQuantity number($double)
instrument AccountsInstrument{
oneOf -> AccountCash
type

}
AccountEqui
}
AccountFixed
maturityD
factor
variableR
}
AccountMutu
}
AccountOptio
optionDel

putCall

optionMul
type

underlyin
}
}
marketValue number($double)
 maintenanceRequirement number($double)
averageLongPrice number($double)
averageShortPrice number($double)
taxLotAverageLongPrice number($double)
taxLotAverageShortPrice number($double)
longOpenProfitLoss number($double)
shortOpenProfitLoss number($double)
previousSessionLongQuantity number($double)
previousSessionShortQuantity number($double)
currentDayCost number($double)
}]
}
MarginAccount{
type stringEnum:
[ CASH, MARGIN ]
accountNumber string
roundTrips integer($int32)
isDayTrader boolean
default: false
isClosingOnlyRestricte boolean
d default: false
pfcbFlag boolean
default: false
positions [Position{
shortQuantity number($double)
averagePrice number($double)
currentDayProfitLoss number($double)
currentDayProfitLossPercentag number($double)
e
longQuantity number($double)
settledLongQuantity number($double)
settledShortQuantity number($double)
agedQuantity number($double)
instrument AccountsInstrument{
oneOf -> AccountCash
type

}
AccountEqui
}
AccountFixed
maturityD
factor
variableR
}
AccountMutu
}
AccountOptio
optionDel
 putCall

optionMul
type

underlyin
}
}
marketValue number($double)
maintenanceRequirement number($double)
averageLongPrice number($double)
averageShortPrice number($double)
taxLotAverageLongPrice number($double)
taxLotAverageShortPrice number($double)
longOpenProfitLoss number($double)
shortOpenProfitLoss number($double)
previousSessionLongQuantity number($double)
previousSessionShortQuantity number($double)
currentDayCost number($double)
}]
initialBalances MarginInitialBalance{
accruedInterest number($double)
availableFundsNonMarginableTrade number($double)
bondValue number($double)
buyingPower number($double)
cashBalance number($double)
cashAvailableForTrading number($double)
cashReceipts number($double)
dayTradingBuyingPower number($double)
dayTradingBuyingPowerCall number($double)
dayTradingEquityCall number($double)
equity number($double)
equityPercentage number($double)
liquidationValue number($double)
longMarginValue number($double)
longOptionMarketValue number($double)
longStockValue number($double)
maintenanceCall number($double)
maintenanceRequirement number($double)
margin number($double)
marginEquity number($double)
moneyMarketFund number($double)
mutualFundValue number($double)
regTCall number($double)
shortMarginValue number($double)
shortOptionMarketValue number($double)
shortStockValue number($double)
totalCash number($double)
isInCall number($double)
unsettledCash number($double)
pendingDeposits number($double)
marginBalance number($double)
shortBalance number($double)
accountValue number($double)
}
currentBalances MarginBalance{
availableFunds number($double)
availableFundsNonMarginableTrade number($double)
buyingPower number($double)
 buyingPowerNonMarginableTrade number($double)
dayTradingBuyingPower number($double)
dayTradingBuyingPowerCall number($double)
equity number($double)
equityPercentage number($double)
longMarginValue number($double)
maintenanceCall number($double)
maintenanceRequirement number($double)
marginBalance number($double)
regTCall number($double)
shortBalance number($double)
shortMarginValue number($double)
sma number($double)
isInCall number($double)
stockBuyingPower number($double)
optionBuyingPower number($double)
}
projectedBalances MarginBalance{
availableFunds number($double)
availableFundsNonMarginableTrade number($double)
buyingPower number($double)
buyingPowerNonMarginableTrade number($double)
dayTradingBuyingPower number($double)
dayTradingBuyingPowerCall number($double)
equity number($double)
equityPercentage number($double)
longMarginValue number($double)
maintenanceCall number($double)
maintenanceRequirement number($double)
marginBalance number($double)
regTCall number($double)
shortBalance number($double)
shortMarginValue number($double)
sma number($double)
isInCall number($double)
stockBuyingPower number($double)
optionBuyingPower number($double)
}
}
MarginInitialBalance{
accruedInterest number($double
)
availableFundsNonMarginableTrad number($double
e )
bondValue number($double
)
buyingPower number($double
)
cashBalance number($double
)
cashAvailableForTrading number($double
)
cashReceipts number($double
)
dayTradingBuyingPower number($double
)
dayTradingBuyingPowerCall number($double
)
dayTradingEquityCall number($double
)
equity number($double
)
 equityPercentage number($double
)
liquidationValue number($double
)
longMarginValue number($double
)
longOptionMarketValue number($double
)
longStockValue number($double
)
maintenanceCall number($double
)
maintenanceRequirement number($double
)
margin number($double
)
marginEquity number($double
)
moneyMarketFund number($double
)
mutualFundValue number($double
)
regTCall number($double
)
shortMarginValue number($double
)
shortOptionMarketValue number($double
)
shortStockValue number($double
)
totalCash number($double
)
isInCall number($double
)
unsettledCash number($double
)
pendingDeposits number($double
)
marginBalance number($double
)
shortBalance number($double
)
accountValue number($double
)
}
MarginBalance{
availableFunds number($double
)
availableFundsNonMarginableTrad number($double
e )
buyingPower number($double
)
buyingPowerNonMarginableTrade number($double
)
dayTradingBuyingPower number($double
)
dayTradingBuyingPowerCall number($double
)
equity number($double
)
equityPercentage number($double
)
longMarginValue number($double
 )
maintenanceCall number($double
)
maintenanceRequirement number($double
)
marginBalance number($double
)
regTCall number($double
)
shortBalance number($double
)
shortMarginValue number($double
)
sma number($double
)
isInCall number($double
)
stockBuyingPower number($double
)
optionBuyingPower number($double
)
}
CashAccount{
type stringEnum:
[ CASH, MARGIN ]
accountNumber string
roundTrips integer($int32)
isDayTrader boolean
default: false
isClosingOnlyRestricte boolean
d default: false
pfcbFlag boolean
default: false
positions [Position{
shortQuantity number($double)
averagePrice number($double)
currentDayProfitLoss number($double)
currentDayProfitLossPercentag number($double)
e
longQuantity number($double)
settledLongQuantity number($double)
settledShortQuantity number($double)
agedQuantity number($double)
instrument AccountsInstrument{
oneOf -> AccountCash
type

}
AccountEqui
}
AccountFixed
maturityD
factor
variableR
}
AccountMutu
}
AccountOptio
optionDel
 putCall

optionMul
type

underlyin
}
}
marketValue number($double)
maintenanceRequirement number($double)
averageLongPrice number($double)
averageShortPrice number($double)
taxLotAverageLongPrice number($double)
taxLotAverageShortPrice number($double)
longOpenProfitLoss number($double)
shortOpenProfitLoss number($double)
previousSessionLongQuantity number($double)
previousSessionShortQuantity number($double)
currentDayCost number($double)
}]
initialBalances CashInitialBalance{
accruedInterest number($double)
cashAvailableForTrading number($double)
cashAvailableForWithdrawal number($double)
cashBalance number($double)
bondValue number($double)
cashReceipts number($double)
liquidationValue number($double)
longOptionMarketValue number($double)
longStockValue number($double)
moneyMarketFund number($double)
mutualFundValue number($double)
shortOptionMarketValue number($double)
shortStockValue number($double)
isInCall number($double)
unsettledCash number($double)
cashDebitCallValue number($double)
pendingDeposits number($double)
accountValue number($double)
}
currentBalances CashBalance{
cashAvailableForTrading number($double)
cashAvailableForWithdrawal number($double)
cashCall number($double)
longNonMarginableMarketValue number($double)
totalCash number($double)
cashDebitCallValue number($double)
unsettledCash number($double)
}
 projectedBalances CashBalance{
cashAvailableForTrading number($double)
cashAvailableForWithdrawal number($double)
cashCall number($double)
longNonMarginableMarketValue number($double)
totalCash number($double)
cashDebitCallValue number($double)
unsettledCash number($double)
}
}
CashInitialBalance{
accruedInterest number($double
)
cashAvailableForTrading number($double
)
cashAvailableForWithdrawa number($double
l )
cashBalance number($double
)
bondValue number($double
)
cashReceipts number($double
)
liquidationValue number($double
)
longOptionMarketValue number($double
)
longStockValue number($double
)
moneyMarketFund number($double
)
mutualFundValue number($double
)
shortOptionMarketValue number($double
)
shortStockValue number($double
)
isInCall number($double
)
unsettledCash number($double
)
cashDebitCallValue number($double
)
pendingDeposits number($double
)
accountValue number($double
)
}
CashBalance{
cashAvailableForTrading number($double
)
cashAvailableForWithdrawal number($double
)
cashCall number($double
)
longNonMarginableMarketValu number($double
e )
totalCash number($double
)
cashDebitCallValue number($double
)
unsettledCash number($double
 )
}
TransactionBaseInstrument {
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT, FIXED_INCOME, CURRENC
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
}
AccountsBaseInstrument{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT, FIXED_INCOME, CURRENC
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
}
AccountsInstrument{
oneOf -> AccountCashEquivalent{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALEN
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ SWEEP_VEHICLE, SAVINGS, MONEY_MARKET_FUND, UNKNOWN
}
AccountEquity{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALEN
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
}
AccountFixedIncome{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALEN
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
maturityDate string($date-time)
factor number($double)
variableRate number($double)
}
AccountMutualFund{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALEN
cusip string
symbol string
description string
instrumentId integer($int64)
 netChange number($double)
}
AccountOption{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALEN
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
optionDeliverables [
xml: OrderedMap { "name": "optionDeliverables", "wra
AccountAPIOptionDeliverable{...}]
putCall stringEnum:
[ PUT, CALL, UNKNOWN ]
optionMultiplier integer($int32)
type stringEnum:
[ VANILLA, BINARY, BARRIER, UNKNOWN ]
underlyingSymbol string
}
}
TransactionInstrument{
oneOf -> TransactionCashEquivalent{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ SWEEP_VEHICLE, SAVINGS, MONEY_MARKET_FUND, UNKNOWN
}
CollectiveInvestment{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ UNIT_INVESTMENT_TRUST, EXCHANGE_TRADED_FUND, CLOSED
}
Currency{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
}
TransactionEquity{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT
cusip string
symbol string
description string
instrumentId integer($int64)
 netChange number($double)
type stringEnum:
[ COMMON_STOCK, PREFERRED_STOCK, DEPOSITORY_RECEIPT,
RIGHT, WARRANT, CONVERTIBLE_PREFERRED_STOCK, CONVERTI
}
TransactionFixedIncome{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ BOND_UNIT, CERTIFICATE_OF_DEPOSIT, CONVERTIBLE_BOND
GOVERNMENT_MORTGAGE, GNMA_BONDS, MUNICIPAL_ASSESSMENT
US_TREASURY_BOND, US_TREASURY_BILL, US_TREASURY_NOTE,
WHEN_AS_AND_IF_ISSUED_BOND, ASSET_BACKED_SECURITY, UN
maturityDate string($date-time)
factor number($double)
multiplier number($double)
variableRate number($double)
}
Forex{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ STANDARD, NBBO, UNKNOWN ]
baseCurrency Currency{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTU
COLLECTIVE_INVESTMENT ]
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
}
counterCurrency Currency{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTU
COLLECTIVE_INVESTMENT ]
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
}
}
Future{
activeContract boolean
default: false
type stringEnum:
[ STANDARD, UNKNOWN ]
expirationDate string($date-time)
lastTradingDate string($date-time)
 firstNoticeDate string($date-time)
multiplier number($double)
}
Index{...}
TransactionMutualFund{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALEN
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
fundFamilyName string
fundFamilySymbol string
fundGroup string
type stringEnum:
[ NOT_APPLICABLE, OPEN_END_NON_TAXABLE, OPEN_END_TAX
exchangeCutoffTime string($date-time)
purchaseCutoffTime string($date-time)
redemptionCutoffTime string($date-time)
}
TransactionOption{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVA
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
expirationDate string($date-time)
optionDeliverables [
xml: OrderedMap { "name": "optionDeliverables", "
TransactionAPIOptionDeliverable{
rootSymbol string
strikePercent integer($int64)
deliverableNumber integer($int64)
deliverableUnits number($double)
deliverable {
}
assetType assetTypestringEnum:
[ EQUITY, MUTUAL_FUND, OP
PRODUCT, CURRENCY, COLLEC
}]
optionPremiumMultiplie integer($int64)
r
putCall stringEnum:
[ PUT, CALL, UNKNOWN ]
strikePrice number($double)
type stringEnum:
[ VANILLA, BINARY, BARRIER, UNKNOWN ]
underlyingSymbol string
underlyingCusip string
deliverable {
}
}
Product{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT
cusip string
symbol string
description string
 instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ TBD, UNKNOWN ]
}
}
TransactionCashEquivalent {
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT, FIXED_INCOME, CURRENC
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ SWEEP_VEHICLE, SAVINGS, MONEY_MARKET_FUND, UNKNOWN ]
}
CollectiveInvestment{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT, FIXED_INCOME, CURRENC
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ UNIT_INVESTMENT_TRUST, EXCHANGE_TRADED_FUND, CLOSED_END_FUND, INDEX, UNITS
}
instructionstringEnum:
[ BUY, SELL, BUY_TO_COVER, SELL_SHORT, BUY_TO_OPEN, BUY_TO_CLOSE, SELL_TO_OPEN,
SELL_TO_CLOSE, EXCHANGE, SELL_SHORT_EXEMPT ]
assetTypestringEnum:
[ EQUITY, MUTUAL_FUND, OPTION, FUTURE, FOREX, INDEX, CASH_EQUIVALENT, FIXED_INCOME,
PRODUCT, CURRENCY, COLLECTIVE_INVESTMENT ]
Currency{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT, FIXED_INCOME, CURRENC
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
}
TransactionEquity{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT, FIXED_INCOME, CURRENC
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ COMMON_STOCK, PREFERRED_STOCK, DEPOSITORY_RECEIPT, PREFERRED_DEPOSITORY_RE
CONVERTIBLE_PREFERRED_STOCK, CONVERTIBLE_STOCK, LIMITED_PARTNERSHIP, WHEN_IS
}
TransactionFixedIncome {
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT, FIXED_INCOME, CURRENC
cusip string
symbol string
 description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ BOND_UNIT, CERTIFICATE_OF_DEPOSIT, CONVERTIBLE_BOND, COLLATERALIZED_MORTGA
MUNICIPAL_ASSESSMENT_DISTRICT, MUNICIPAL_BOND, OTHER_GOVERNMENT, SHORT_TERM_
US_TREASURY_ZERO_COUPON, AGENCY_BOND, WHEN_AS_AND_IF_ISSUED_BOND, ASSET_BACK
maturityDate string($date-time)
factor number($double)
multiplier number($double)
variableRate number($double)
}
Forex{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT, FIXED_INCOME, CURRENC
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ STANDARD, NBBO, UNKNOWN ]
baseCurrency Currency{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALEN
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
}
counterCurrency Currency{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALEN
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
}
}
Future{
activeContract boolean
default: false
type stringEnum:
[ STANDARD, UNKNOWN ]
expirationDate string($date-time)
lastTradingDate string($date-time)
firstNoticeDate string($date-time)
multiplier number($double)
oneOf -> TransactionCashEquivalent{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ SWEEP_VEHICLE, SAVINGS, MONEY_MARKET_FUND, UNKNOWN
}
CollectiveInvestment{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ UNIT_INVESTMENT_TRUST, EXCHANGE_TRADED_FUND, CLOSED
}
Currency{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
}
TransactionEquity{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ COMMON_STOCK, PREFERRED_STOCK, DEPOSITORY_RECEIPT,
RIGHT, WARRANT, CONVERTIBLE_PREFERRED_STOCK, CONVERTI
}
TransactionFixedIncome{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ BOND_UNIT, CERTIFICATE_OF_DEPOSIT, CONVERTIBLE_BOND
GOVERNMENT_MORTGAGE, GNMA_BONDS, MUNICIPAL_ASSESSMENT
US_TREASURY_BOND, US_TREASURY_BILL, US_TREASURY_NOTE,
WHEN_AS_AND_IF_ISSUED_BOND, ASSET_BACKED_SECURITY, UN
maturityDate string($date-time)
factor number($double)
multiplier number($double)
variableRate number($double)
}
Forex{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ STANDARD, NBBO, UNKNOWN ]
baseCurrency Currency{
 }
counterCurrency Currency{
}
}
{
}
Index{
activeContract boolean
default: false
type stringEnum:
[ BROAD_BASED, NARROW_BASED, UNKNOWN ]
}
TransactionMutualFund{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALEN
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
fundFamilyName string
fundFamilySymbol string
fundGroup string
type stringEnum:
[ NOT_APPLICABLE, OPEN_END_NON_TAXABLE, OPEN_END_TAX
exchangeCutoffTime string($date-time)
purchaseCutoffTime string($date-time)
redemptionCutoffTime string($date-time)
}
TransactionOption{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVA
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
expirationDate string($date-time)
optionDeliverables [
xml: OrderedMap { "name": "optionDeliverables", "
TransactionAPIOptionDeliverable{...}]
optionPremiumMultiplie integer($int64)
r
putCall stringEnum:
[ PUT, CALL, UNKNOWN ]
strikePrice number($double)
type stringEnum:
[ VANILLA, BINARY, BARRIER, UNKNOWN ]
underlyingSymbol string
underlyingCusip string
deliverable {
}
}
Product{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
 type stringEnum:
[ TBD, UNKNOWN ]
}
}
Index{
activeContract boolean
default: false
type stringEnum:
[ BROAD_BASED, NARROW_BASED, UNKNOWN ]
oneOf -> TransactionCashEquivalent{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ SWEEP_VEHICLE, SAVINGS, MONEY_MARKET_FUND, UNKNOWN
}
CollectiveInvestment{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ UNIT_INVESTMENT_TRUST, EXCHANGE_TRADED_FUND, CLOSED
}
Currency{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
}
TransactionEquity{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ COMMON_STOCK, PREFERRED_STOCK, DEPOSITORY_RECEIPT,
RIGHT, WARRANT, CONVERTIBLE_PREFERRED_STOCK, CONVERTI
}
TransactionFixedIncome{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
 [ BOND_UNIT, CERTIFICATE_OF_DEPOSIT, CONVERTIBLE_BOND
GOVERNMENT_MORTGAGE, GNMA_BONDS, MUNICIPAL_ASSESSMENT
US_TREASURY_BOND, US_TREASURY_BILL, US_TREASURY_NOTE,
WHEN_AS_AND_IF_ISSUED_BOND, ASSET_BACKED_SECURITY, UN
maturityDate string($date-time)
factor number($double)
multiplier number($double)
variableRate number($double)
}
Forex{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ STANDARD, NBBO, UNKNOWN ]
baseCurrency Currency{
}
counterCurrency Currency{
}
}
Future{
activeContract boolean
default: false
type stringEnum:
[ STANDARD, UNKNOWN ]
expirationDate string($date-time)
lastTradingDate string($date-time)
firstNoticeDate string($date-time)
multiplier number($double)
}
{
}
TransactionMutualFund{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALEN
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
fundFamilyName string
fundFamilySymbol string
fundGroup string
type stringEnum:
[ NOT_APPLICABLE, OPEN_END_NON_TAXABLE, OPEN_END_TAX
exchangeCutoffTime string($date-time)
purchaseCutoffTime string($date-time)
redemptionCutoffTime string($date-time)
}
TransactionOption{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVA
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
 expirationDate string($date-time)
optionDeliverables [
xml: OrderedMap { "name": "optionDeliverables", "
TransactionAPIOptionDeliverable{
rootSymbol string
strikePercent integer($int64)
deliverableNumber integer($int64)
deliverableUnits number($double)
deliverable {
}
assetType assetTypestringEnum:
[ EQUITY, MUTUAL_FUND, OP
PRODUCT, CURRENCY, COLLEC
}]
optionPremiumMultiplie integer($int64)
r
putCall stringEnum:
[ PUT, CALL, UNKNOWN ]
strikePrice number($double)
type stringEnum:
[ VANILLA, BINARY, BARRIER, UNKNOWN ]
underlyingSymbol string
underlyingCusip string
deliverable {
}
}
Product{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ TBD, UNKNOWN ]
}
}
TransactionMutualFund {
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT, FIXED_INCOME, CURRENC
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
fundFamilyName string
fundFamilySymbol string
fundGroup string
type stringEnum:
[ NOT_APPLICABLE, OPEN_END_NON_TAXABLE, OPEN_END_TAXABLE, NO_LOAD_NON_TAXABL
exchangeCutoffTime string($date-time)
purchaseCutoffTime string($date-time)
redemptionCutoffTime string($date-time)
}
TransactionOption{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT, FIXED_INCOME, CURR
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
expirationDate string($date-time)
optionDeliverables [
xml: OrderedMap { "name": "optionDeliverables", "wrapped": true }
TransactionAPIOptionDeliverable{
rootSymbol string
strikePercent integer($int64)
deliverableNumber integer($int64)
deliverableUnits number($double)
deliverable TransactionInstrument{
oneOf -> TransactionCashEquiv
assetType*

cusip
symbol
description
instrumentId
netChange
type

}
CollectiveInvestment{
assetType*

cusip
symbol
description
instrumentId
netChange
type

}
Currency{
assetType*

cusip
symbol
description
instrumentId
netChange
}
TransactionEquity{
assetType*

cusip
symbol
description
instrumentId
netChange
type

}
TransactionFixedIncom
assetType*

cusip
symbol
description
instrumentId
netChange
type

maturityDate
factor
multiplier
variableRate
}
Forex{
assetType*

cusip
symbol
description
instrumentId
netChange
type

baseCurrency

counterCurrency

}
Future{
activeContract

type

expirationDate
lastTradingDate
firstNoticeDate
multiplier
}
Index{
activeContract

type

}
TransactionMutualFund
assetType*

cusip
symbol
 description
instrumentId
netChange
fundFamilyName
fundFamilySymbol
fundGroup
type

exchangeCutoffTime
purchaseCutoffTime
redemptionCutoffTime
}
{
}
Product{...}
}
assetType assetTypestringEnum:
[ EQUITY, MUTUAL_FUND, OPTION, FUTURE, FOREX, IND
COLLECTIVE_INVESTMENT ]
}]
optionPremiumMultiplie integer($int64)
r
putCall stringEnum:
[ PUT, CALL, UNKNOWN ]
strikePrice number($double)
type stringEnum:
[ VANILLA, BINARY, BARRIER, UNKNOWN ]
underlyingSymbol string
underlyingCusip string
deliverable TransactionInstrument{
oneOf -> TransactionCashEquivalent{
type stringEnum:
[ SWEEP_VEHICLE, SAVINGS
}
CollectiveInvestment{
type stringEnum:
[ UNIT_INVESTMENT_TRUST,
}
Currency{
}
TransactionEquity{
type stringEnum:
[ COMMON_STOCK, PREFERRE
RESTRICTED_STOCK, COMPON
CONVERTIBLE_STOCK, LIMIT
}
TransactionFixedIncome{
type stringEnum:
[ BOND_UNIT, CERTIFICATE
CORPORATE_BOND, GOVERNME
MUNICIPAL_BOND, OTHER_GO
US_TREASURY_NOTE, US_TRE
ASSET_BACKED_SECURITY, U
maturityDate string($date-time)
factor number($double)
multiplier number($double)
variableRate number($double)
}
Forex{
 type stringEnum:
[ STANDARD, NBBO, UNKNOW
baseCurrency Currency{
}
counterCurrency Currency{
}
}
Future{
activeContract boolean
default: false
type stringEnum:
[ STANDARD, UNKNOWN ]
expirationDate string($date-time)
lastTradingDate string($date-time)
firstNoticeDate string($date-time)
multiplier number($double)
}
Index{
activeContract boolean
default: false
type stringEnum:
[ BROAD_BASED, NARROW_BA
}
TransactionMutualFund{
fundFamilyName string
fundFamilySymbol string
fundGroup string
type stringEnum:
[ NOT_APPLICABLE, OPEN_E
NO_LOAD_TAXABLE, UNKNOWN
exchangeCutoffTime string($date-time)
purchaseCutoffTime string($date-time)
redemptionCutoffTime string($date-time)
}
{
}
Product{
type stringEnum:
[ TBD, UNKNOWN ]
}
}
}
Product{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT, FIXED_INCOME, CURRENC
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ TBD, UNKNOWN ]
}
AccountCashEquivalent{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT, FIXED_INCOME, CURRENC
cusip string
symbol string
description string
instrumentId integer($int64)
 netChange number($double)
type stringEnum:
Array [ 4 ]
}
AccountEquity{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT, FIXED_INCOME, CURRENC
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
}
AccountFixedIncome{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT, FIXED_INCOME, CURRENC
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
maturityDate string($date-time)
factor number($double)
variableRate number($double)
}
AccountMutualFund{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT, FIXED_INCOME, CURRENC
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
}
AccountOption{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVALENT, FIXED_INCOME, CURRENC
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
optionDeliverables [
xml: OrderedMap { "name": "optionDeliverables", "wrapped": true }
AccountAPIOptionDeliverable{
symbol string($int64)
deliverableUnits number($double)
apiCurrencyType stringEnum:
[ USD, CAD, EUR, JPY ]
assetType assetTypestringEnum:
[ EQUITY, MUTUAL_FUND, OPTION, FUTURE, FOREX, INDEX,
COLLECTIVE_INVESTMENT ]
}]
putCall stringEnum:
Array [ 3 ]
optionMultiplier integer($int32)
type stringEnum:
[ VANILLA, BINARY, BARRIER, UNKNOWN ]
underlyingSymbol string
}
AccountAPIOptionDeliverable {
 symbol string($int64)
deliverableUnits number($double)
apiCurrencyType stringEnum:
[ USD, CAD, EUR, JPY ]
assetType assetTypestringEnum:
[ EQUITY, MUTUAL_FUND, OPTION, FUTURE, FOREX, INDEX, CASH_EQUIVALENT, FIXED_
}
TransactionAPIOptionDeliverable {
rootSymbol string
strikePercent integer($int64)
deliverableNumber integer($int64)
deliverableUnits number($double)
deliverable TransactionInstrument{
oneOf -> TransactionCashEquivalent{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTU
COLLECTIVE_INVESTMENT ]
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ SWEEP_VEHICLE, SAVINGS, MON
}
CollectiveInvestment{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTU
COLLECTIVE_INVESTMENT ]
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ UNIT_INVESTMENT_TRUST, EXCH
}
Currency{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTU
COLLECTIVE_INVESTMENT ]
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
}
TransactionEquity{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTU
COLLECTIVE_INVESTMENT ]
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ COMMON_STOCK, PREFERRED_STO
RESTRICTED_STOCK, COMPONENT_U
CONVERTIBLE_STOCK, LIMITED_PA
}
TransactionFixedIncome{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTU
COLLECTIVE_INVESTMENT ]
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ BOND_UNIT, CERTIFICATE_OF_D
CORPORATE_BOND, GOVERNMENT_MO
MUNICIPAL_BOND, OTHER_GOVERNM
US_TREASURY_NOTE, US_TREASURY
ASSET_BACKED_SECURITY, UNKNOW
maturityDate string($date-time)
factor number($double)
multiplier number($double)
variableRate number($double)
}
Forex{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTU
COLLECTIVE_INVESTMENT ]
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ STANDARD, NBBO, UNKNOWN ]
baseCurrency Currency{
}
counterCurrency Currency{
}
}
Future{
activeContract boolean
default: false
type stringEnum:
[ STANDARD, UNKNOWN ]
expirationDate string($date-time)
lastTradingDate string($date-time)
firstNoticeDate string($date-time)
multiplier number($double)
}
Index{...}
TransactionMutualFund{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUT
COLLECTIVE_INVESTMENT ]
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
fundFamilyName string
fundFamilySymbol string
fundGroup string
type stringEnum:
 [ NOT_APPLICABLE, OPEN_END_N
NO_LOAD_TAXABLE, UNKNOWN ]
exchangeCutoffTime string($date-time)
purchaseCutoffTime string($date-time)
redemptionCutoffTime string($date-time)
}
TransactionOption{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX,
COLLECTIVE_INVESTMENT ]
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
expirationDate string($date-time)
optionDeliverables [
xml: OrderedMap { "name":
{
}]
optionPremiumMultiplie integer($int64)
r
putCall stringEnum:
[ PUT, CALL, UNKNOWN ]
strikePrice number($double)
type stringEnum:
[ VANILLA, BINARY, BARRIE
underlyingSymbol string
underlyingCusip string
deliverable {
}
}
Product{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTU
COLLECTIVE_INVESTMENT ]
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ TBD, UNKNOWN ]
}
}
assetType assetTypestringEnum:
[ EQUITY, MUTUAL_FUND, OPTION, FUTURE, FOREX, INDEX, CASH_EQUIVALENT, FIXED_
}
apiOrderStatusstringEnum:
[ AWAITING_PARENT_ORDER, AWAITING_CONDITION, AWAITING_STOP_CONDITION,
AWAITING_MANUAL_REVIEW, ACCEPTED, AWAITING_UR_OUT, PENDING_ACTIVATION, QUEUED,
WORKING, REJECTED, PENDING_CANCEL, CANCELED, PENDING_REPLACE, REPLACED, FILLED,
EXPIRED, NEW, AWAITING_RELEASE_TIME, PENDING_ACKNOWLEDGEMENT, PENDING_RECALL,
UNKNOWN ]
TransactionTypestringEnum:
[ 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 ]
Transaction{
activityId integer($int64)
time string($date-time)
user UserDetails{
cdDomainId string
login string
type stringEnum:
[ ADVISOR_USER, BROKER_USER, CLIENT_USER, SYSTEM_USE
userId integer($int64)
systemUserName string
firstName string
lastName string
brokerRepCode string
}
description string
accountNumber string
type TransactionTypestringEnum:
[ TRADE, RECEIVE_AND_DELIVER, DIVIDEND_OR_INTEREST, ACH_RECEIPT, ACH_DISBURS
WIRE_OUT, WIRE_IN, JOURNAL, MEMORANDUM, MARGIN_CALL, MONEY_MARKET, SMA_ADJUS
status stringEnum:
[ VALID, INVALID, PENDING, UNKNOWN ]
subAccount stringEnum:
[ CASH, MARGIN, SHORT, DIV, INCOME, UNKNOWN ]
tradeDate string($date-time)
settlementDate string($date-time)
positionId integer($int64)
orderId integer($int64)
netAmount number($double)
activityType stringEnum:
[ ACTIVITY_CORRECTION, EXECUTION, ORDER_ACTION, TRANSFER, UNKNOWN ]
transferItems [
xml: OrderedMap { "name": "transferItems", "wrapped": true }
TransferItem{
instrument TransactionInstrument{
oneOf -> TransactionCashEquivalen
assetType* strin
[ EQU
CURRE
cusip strin
symbol strin
description strin
instrumentId integ
netChange numbe
type strin
[ SWE
}
CollectiveInvestment{
assetType* strin
[ EQU
CURRE
cusip strin
symbol strin
description strin
instrumentId integ
netChange numbe
type strin
[ UNI
INDEX
}
Currency{
assetType* strin
[ EQU
CURRE
cusip strin
 symbol strin
description strin
instrumentId integ
netChange numbe
}
TransactionEquity{
assetType* strin
[ EQU
CURRE
cusip strin
symbol strin
description strin
instrumentId integ
netChange numbe
type strin
[ COM
PREFE
RIGHT
LIMIT
}
TransactionFixedIncome{
assetType* strin
[ EQU
CURRE
cusip strin
symbol strin
description strin
instrumentId integ
netChange numbe
type strin
[ BON
COLLA
GOVER
MUNIC
US_TR
US_TR
ASSET
maturityDate strin
factor numbe
multiplier numbe
variableRate numbe
}
Forex{
assetType* strin
[ EQU
CURRE
cusip strin
symbol strin
description strin
instrumentId integ
netChange numbe
type strin
[ STA
baseCurrency Curr
}
counterCurrency Curr
}
}
Future{
activeContract boole
defau
 type strin
[ STA
expirationDate strin
lastTradingDate strin
firstNoticeDate strin
multiplier numbe
}
Index{
activeContract boole
defau
type strin
[ BRO
}
TransactionMutualFund{
assetType* stri
[ EQ
CURR
cusip stri
symbol stri
description stri
instrumentId inte
netChange numb
fundFamilyName stri
fundFamilySymbol stri
fundGroup stri
type stri
[ NO
NO_L
exchangeCutoffTime stri
purchaseCutoffTime stri
redemptionCutoffTime stri
}
TransactionOption{
assetType* s
[
F
cusip s
symbol s
description s
instrumentId i
netChange n
expirationDate s
optionDeliverables [
x
T

}
optionPremiumMultiplie i
r
putCall s
[
strikePrice n
 type s
[
underlyingSymbol s
underlyingCusip s
deliverable {
}
}
Product{
assetType* strin
[ EQU
CURRE
cusip strin
symbol strin
description strin
instrumentId integ
netChange numbe
type strin
[ TBD
}
}
amount number($double)
cost number($double)
price number($double)
feeType stringEnum:
[ COMMISSION, SEC_FEE, STR_FEE, R_FEE, CDSC_FEE, OPT
FUTURES_EXCHANGE_FEE, LOW_PROCEEDS_COMMISSION, BASE_
UNKNOWN ]
positionEffect stringEnum:
[ OPENING, CLOSING, AUTOMATIC, UNKNOWN ]
}]
}
UserDetails{
cdDomainId string
login string
type stringEnum:
[ ADVISOR_USER, BROKER_USER, CLIENT_USER, SYSTEM_USER, UNKNOWN ]
userId integer($int64)
systemUserName string
firstName string
lastName string
brokerRepCode string
}
TransferItem{
instrument TransactionInstrument{
oneO TransactionCashEquivalent{
f -> assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVAL
COLLECTIVE_INVESTMENT ]
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ SWEEP_VEHICLE, SAVINGS, MONEY_MARKET_FUND, UNKNO
}
CollectiveInvestment{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVAL
COLLECTIVE_INVESTMENT ]
cusip string
 symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ UNIT_INVESTMENT_TRUST, EXCHANGE_TRADED_FUND, CLO
}
Currency{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVAL
COLLECTIVE_INVESTMENT ]
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
}
TransactionEquity{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQ
COLLECTIVE_INVESTMENT ]
cusip
symbol
description
instrumentId
netChange
type

}TransactionFixedIncome{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVAL
COLLECTIVE_INVESTMENT ]
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ BOND_UNIT, CERTIFICATE_OF_DEPOSIT, CONVERTIBLE_B
CORPORATE_BOND, GOVERNMENT_MORTGAGE, GNMA_BONDS, M
MUNICIPAL_BOND, OTHER_GOVERNMENT, SHORT_TERM_PAPER
US_TREASURY_NOTE, US_TREASURY_ZERO_COUPON, AGENCY_
ASSET_BACKED_SECURITY, UNKNOWN ]
maturityDate string($date-time)
factor number($double)
multiplier number($double)
variableRate number($double)
}
Forex{
assetType* stringEnum:
 [ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVAL
COLLECTIVE_INVESTMENT ]
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ STANDARD, NBBO, UNKNOWN ]
baseCurrency Currency{
}
counterCurrency Currency{
}
}
Future{
activeContract boolean
default: false
type stringEnum:
[ STANDARD, UNKNOWN ]
expirationDate string($date-time)
lastTradingDate string($date-time)
firstNoticeDate string($date-time)
multiplier number($double)
}
Index{
activeContract boolean
default: false
type stringEnum:
[ BROAD_BASED, NARROW_BASED, UNKNOWN ]
}
TransactionMutualFund{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVA
COLLECTIVE_INVESTMENT ]
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
fundFamilyName string
fundFamilySymbol string
fundGroup string
type stringEnum:
[ NOT_APPLICABLE, OPEN_END_NON_TAXABLE, OPEN_END_
NO_LOAD_TAXABLE, UNKNOWN ]
exchangeCutoffTime string($date-time)
purchaseCutoffTime string($date-time)
redemptionCutoffTime string($date-time)
}
TransactionOption{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQU
COLLECTIVE_INVESTMENT ]
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
expirationDate string($date-time)
optionDeliverables [
xml: OrderedMap { "name": "optionDeliverables"
 TransactionAPIOptionDeliverable{
rootSymbol string
strikePercent integer($int64)
deliverableNumber integer($int64)
deliverableUnits number($double)
deliverable {
}
assetType assetTypestringEnum:
[ EQUITY, MUTUAL_FUND,
CASH_EQUIVALENT, FIXED
COLLECTIVE_INVESTMENT
}]
optionPremiumMultiplie integer($int64)
r
putCall stringEnum:
[ PUT, CALL, UNKNOWN ]
strikePrice number($double)
type stringEnum:
[ VANILLA, BINARY, BARRIER, UNKNOWN ]
underlyingSymbol string
underlyingCusip string
deliverable {
}
}
Product{
assetType* stringEnum:
[ EQUITY, OPTION, INDEX, MUTUAL_FUND, CASH_EQUIVAL
COLLECTIVE_INVESTMENT ]
cusip string
symbol string
description string
instrumentId integer($int64)
netChange number($double)
type stringEnum:
[ TBD, UNKNOWN ]
}
}
amount number($double)
cost number($double)
price number($double)
feeType stringEnum:
[ COMMISSION, SEC_FEE, STR_FEE, R_FEE, CDSC_FEE, OPT_REG_FEE, ADDITIONAL_FEE, MISCE
BASE_CHARGE, GENERAL_CHARGE, GST_FEE, TAF_FEE, INDEX_OPTION_FEE, UNKNOWN ]
positionEffe stringEnum:
ct [ OPENING, CLOSING, AUTOMATIC, UNKNOWN ]
}
UserPreference{
accounts [UserPreferenceAccount{
accountNumber string
primaryAccount boolean
default: false
type string
nickName string
accountColor string
Green | Blue

displayAcctId string
autoPositionEffect boolean
default: false
}]
streamerInfo [StreamerInfo{
 streamerSocketUrl string
schwabClientCustomerId string
schwabClientCorrelId string
schwabClientChannel string
schwabClientFunctionId string
}]
offers [Offer{
level2Permissions boolean
default: false
mktDataPermission string
}]
}UserPreferenceAccount {
accountNumber string
primaryAccount boolean
default: false
type string
nickName string
accountColor string
Green | Blue

displayAcctId string
autoPositionEffect boolean
default: false
}
StreamerInfo{
streamerSocketUrl strin
g
schwabClientCustomerI strin
d g
schwabClientCorrelId strin
g
schwabClientChannel strin
g
schwabClientFunctionI strin
d g
}
Offer{
level2Permissions boolean
default: false
mktDataPermission string
}