OrderDetail

data class OrderDetail(orderNumber: Int?, accountId: String?, previewTime: Instant?, placedTime: Instant?, executedTime: Instant?, orderValue: Float?, status: OrderStatus?, orderType: OrderType?, orderTerm: OrderTerm?, priceType: OrderPriceType?, priceValue: String?, limitPrice: Float?, stopPrice: Float?, stopLimitPrice: Float?, offsetType: OrderOffsetType?, offsetValue: Float?, marketSession: MarketSession?, routingDestination: RoutingDestination?, bracketedLimitPrice: Float?, initialStopPrice: Float?, trailPrice: Float?, triggerPrice: Float?, conditionPrice: Float?, conditionSymbol: String?, conditionType: ConditionType?, conditionFollowPrice: ConditionFollowPrice?, conditionSecurityType: String?, replacedByOrderId: Int?, replacesOrderId: Int?, allOrNone: Boolean?, previewId: Int?, instruments: List<Instrument>?, messages: MessagesResponse?, preClearanceCode: String?, overrideRestrictedCd: Int?, investmentAmount: Float?, positionQuantity: PositionQuantityType?, aipFlag: Boolean?, egQual: ExecutionGuaranteeType?, reInvestOption: ReinvestOptionType?, estimatedCommission: Float?, estimatedFees: Float?, estimatedTotalAmount: Float?, netPrice: Float?, netBid: Float?, netAsk: Float?, gcd: Int?, ratio: String?, mfpriceType: String?)

Order Details

Parameters

orderNumber

The numeric ID for this order in the E*TRADE system

accountId

The numeric account ID

previewTime

The time of the order preview

placedTime

The time the order was placed (UTC)

executedTime

The time the order was executed (UTC)

orderValue

Total cost or proceeds, including commission

status

OPEN, EXECUTED, CANCELLED, INDIVIDUAL_FILLS, CANCEL_REQUESTED, EXPIRED, REJECTED, PARTIAL, DO_NOT_EXERCISE, DONE_TRADE_EXECUTED

orderType

EQ, OPTN, SPREADS, BUY_WRITES, BUTTERFLY, IRON_BUTTERFLY, CONDOR, IRON_CONDOR, MF, MMF

orderTerm

GOOD_UNTIL_CANCEL, GOOD_FOR_DAY, GOOD_TILL_DATE, IMMEDIATE_OR_CANCEL, FILL_OR_KILL

priceType

MARKET, LIMIT, STOP, STOP_LIMIT, TRAILING_STOP_CNST_BY_LOWER_TRIGGER, UPPER_TRIGGER_BY_TRAILING_STOP_CNST, TRAILING_STOP_PRCT_BY_LOWER_TRIGGER, UPPER_TRIGGER_BY_TRAILING_STOP_PRCT, TRAILING_STOP_CNST, TRAILING_STOP_PRCT, HIDDEN_STOP, HIDDEN_STOP_BY_LOWER_TRIGGER, UPPER_TRIGGER_BY_HIDDEN_STOP, NET_DEBIT, NET_CREDIT, NET_EVEN, MARKET_ON_OPEN, MARKET_ON_CLOSE, LIMIT_ON_OPEN, LIMIT_ON_CLOSE

priceValue

The value of the price

limitPrice

The highest price at which to buy or the lowest price at which to sell if specified in a limit order

stopPrice

The designated boundary price for a stop order

stopLimitPrice

The designated boundary price for a stop-limit order

offsetType

TRAILING_STOP_CNST, TRAILING_STOP_PRCT

offsetValue

The stop value for trailing stop price types

marketSession

REGULAR, EXTENDED

routingDestination

The exchange where the order should be executed. Users may want to specify this if they believe they can get a better order fill at a specific exchange rather than relying on the automatic order routing system.

bracketedLimitPrice

The bracketed limit price (bracketed orders are not supported in API currently)

initialStopPrice

The initial stop price

trailPrice

The current trailing value. For trailing stop dollar orders, this is a fixed dollar amount. For trailing stop percentage orders, this is the price reflected by the percentage selected.

triggerPrice

The price that an advanced order will trigger. For example, if it is a $1 buy trailing stop, then the trigger price will be $1 above the last price.

conditionPrice

For a conditional order, the price the condition is being compared against

conditionSymbol

For a conditional order, the symbol that the condition is being compared against

conditionType

CONTINGENT_GTE, CONTINGENT_LTE

conditionFollowPrice

ASK, BID, LAST

conditionSecurityType

The condition security type

replacedByOrderId

In the event of a change order request, the order ID of the order that is replacing a prior order.

replacesOrderId

In the event of a change order request, the order ID of the order that the new order is replacing.

allOrNone

If TRUE, the transactions specified in the order must be executed all at once or not at all; default is FALSE

previewId

This parameter is required and must specify the numeric preview ID from the preview and the other parameters of this request must match the parameters of the preview.

instruments

The object for the instrument

messages

The object for the messages

preClearanceCode

The preclearance code

overrideRestrictedCd

The overrides restricted code

investmentAmount

The amount of the investment

positionQuantity

ENTIRE_POSITION, CASH, MARGIN

aipFlag

Indicator to identify if automated investment planning is turned on or off

egQual

EG_QUAL_UNSPECIFIED, EG_QUAL_QUALIFIED, EG_QUAL_NOT_IN_FORCE, EG_QUAL_NOT_A_MARKET_ORDER, EG_QUAL_NOT_AN_ELIGIBLE_SECURITY, EG_QUAL_INVALID_ORDER_TYPE, EG_QUAL_SIZE_NOT_QUALIFIED, EG_QUAL_OUTSIDE_GUARANTEED_PERIOD, EG_QUAL_INELIGIBLE_GATEWAY, EG_QUAL_INELIGIBLE_DUE_TO_IPO, EG_QUAL_INELIGIBLE_DUE_TO_SELF_DIRECTED, EG_QUAL_INELIGIBLE_DUE_TO_CHANGEORDER

reInvestOption

REINVEST, DEPOSIT, CURRENT_HOLDING

estimatedCommission

The cost billed to the user to perform the requested action

estimatedFees

The estimated fees

estimatedTotalAmount

The cost or proceeds, including broker commission, resulting from the requested action

netPrice

The net price

netBid

The net bid

netAsk

The net ask

gcd

The GCD

ratio

The ratio

mfpriceType

The mutual fund price type

Constructors

OrderDetail
Link copied to clipboard
fun OrderDetail(orderNumber: Int?, accountId: String?, previewTime: Instant?, placedTime: Instant?, executedTime: Instant?, orderValue: Float?, status: OrderStatus?, orderType: OrderType?, orderTerm: OrderTerm?, priceType: OrderPriceType?, priceValue: String?, limitPrice: Float?, stopPrice: Float?, stopLimitPrice: Float?, offsetType: OrderOffsetType?, offsetValue: Float?, marketSession: MarketSession?, routingDestination: RoutingDestination?, bracketedLimitPrice: Float?, initialStopPrice: Float?, trailPrice: Float?, triggerPrice: Float?, conditionPrice: Float?, conditionSymbol: String?, conditionType: ConditionType?, conditionFollowPrice: ConditionFollowPrice?, conditionSecurityType: String?, replacedByOrderId: Int?, replacesOrderId: Int?, allOrNone: Boolean?, previewId: Int?, instruments: List<Instrument>?, messages: MessagesResponse?, preClearanceCode: String?, overrideRestrictedCd: Int?, investmentAmount: Float?, positionQuantity: PositionQuantityType?, aipFlag: Boolean?, egQual: ExecutionGuaranteeType?, reInvestOption: ReinvestOptionType?, estimatedCommission: Float?, estimatedFees: Float?, estimatedTotalAmount: Float?, netPrice: Float?, netBid: Float?, netAsk: Float?, gcd: Int?, ratio: String?, mfpriceType: String?)
The numeric ID for this order in the E*TRADE system

Properties

accountId
Link copied to clipboard
val accountId: String?
The numeric account ID
aipFlag
Link copied to clipboard
val aipFlag: Boolean?
Indicator to identify if automated investment planning is turned on or off
allOrNone
Link copied to clipboard
val allOrNone: Boolean?
If TRUE, the transactions specified in the order must be executed all at once or not at all; default is FALSE
bracketedLimitPrice
Link copied to clipboard
val bracketedLimitPrice: Float?
The bracketed limit price (bracketed orders are not supported in API currently)
conditionFollowPrice
Link copied to clipboard
val conditionFollowPrice: ConditionFollowPrice?
ASK, BID, LAST
conditionPrice
Link copied to clipboard
val conditionPrice: Float?
For a conditional order, the price the condition is being compared against
conditionSecurityType
Link copied to clipboard
val conditionSecurityType: String?
The condition security type
conditionSymbol
Link copied to clipboard
val conditionSymbol: String?
For a conditional order, the symbol that the condition is being compared against
conditionType
Link copied to clipboard
val conditionType: ConditionType?
CONTINGENT_GTE, CONTINGENT_LTE
egQual
Link copied to clipboard
val egQual: ExecutionGuaranteeType?
EG_QUAL_UNSPECIFIED, EG_QUAL_QUALIFIED, EG_QUAL_NOT_IN_FORCE, EG_QUAL_NOT_A_MARKET_ORDER, EG_QUAL_NOT_AN_ELIGIBLE_SECURITY, EG_QUAL_INVALID_ORDER_TYPE, EG_QUAL_SIZE_NOT_QUALIFIED, EG_QUAL_OUTSIDE_GUARANTEED_PERIOD, EG_QUAL_INELIGIBLE_GATEWAY, EG_QUAL_INELIGIBLE_DUE_TO_IPO, EG_QUAL_INELIGIBLE_DUE_TO_SELF_DIRECTED, EG_QUAL_INELIGIBLE_DUE_TO_CHANGEORDER
estimatedCommission
Link copied to clipboard
val estimatedCommission: Float?
The cost billed to the user to perform the requested action
estimatedFees
Link copied to clipboard
val estimatedFees: Float?
The estimated fees
estimatedTotalAmount
Link copied to clipboard
val estimatedTotalAmount: Float?
The cost or proceeds, including broker commission, resulting from the requested action
executedTime
Link copied to clipboard
val executedTime: Instant?
The time the order was executed (UTC)
gcd
Link copied to clipboard
val gcd: Int?
The GCD
initialStopPrice
Link copied to clipboard
val initialStopPrice: Float?
The initial stop price
instruments
Link copied to clipboard
val instruments: List<Instrument>?
The object for the instrument
investmentAmount
Link copied to clipboard
val investmentAmount: Float?
The amount of the investment
limitPrice
Link copied to clipboard
val limitPrice: Float?
The highest price at which to buy or the lowest price at which to sell if specified in a limit order
marketSession
Link copied to clipboard
val marketSession: MarketSession?
REGULAR, EXTENDED
messages
Link copied to clipboard
val messages: MessagesResponse?
The object for the messages
mfpriceType
Link copied to clipboard
val mfpriceType: String?
The mutual fund price type
netAsk
Link copied to clipboard
val netAsk: Float?
The net ask
netBid
Link copied to clipboard
val netBid: Float?
The net bid
netPrice
Link copied to clipboard
val netPrice: Float?
The net price
offsetType
Link copied to clipboard
val offsetType: OrderOffsetType?
TRAILING_STOP_CNST, TRAILING_STOP_PRCT
offsetValue
Link copied to clipboard
val offsetValue: Float?
The stop value for trailing stop price types
orderNumber
Link copied to clipboard
val orderNumber: Int?
The numeric ID for this order in the E*TRADE system
orderTerm
Link copied to clipboard
val orderTerm: OrderTerm?
GOOD_UNTIL_CANCEL, GOOD_FOR_DAY, GOOD_TILL_DATE, IMMEDIATE_OR_CANCEL, FILL_OR_KILL
orderType
Link copied to clipboard
val orderType: OrderType?
EQ, OPTN, SPREADS, BUY_WRITES, BUTTERFLY, IRON_BUTTERFLY, CONDOR, IRON_CONDOR, MF, MMF
orderValue
Link copied to clipboard
val orderValue: Float?
Total cost or proceeds, including commission
overrideRestrictedCd
Link copied to clipboard
val overrideRestrictedCd: Int?
The overrides restricted code
placedTime
Link copied to clipboard
val placedTime: Instant?
The time the order was placed (UTC)
positionQuantity
Link copied to clipboard
val positionQuantity: PositionQuantityType?
ENTIRE_POSITION, CASH, MARGIN
preClearanceCode
Link copied to clipboard
val preClearanceCode: String?
The preclearance code
previewId
Link copied to clipboard
val previewId: Int?
This parameter is required and must specify the numeric preview ID from the preview and the other parameters of this request must match the parameters of the preview.
previewTime
Link copied to clipboard
val previewTime: Instant?
The time of the order preview
priceType
Link copied to clipboard
val priceType: OrderPriceType?
MARKET, LIMIT, STOP, STOP_LIMIT, TRAILING_STOP_CNST_BY_LOWER_TRIGGER, UPPER_TRIGGER_BY_TRAILING_STOP_CNST, TRAILING_STOP_PRCT_BY_LOWER_TRIGGER, UPPER_TRIGGER_BY_TRAILING_STOP_PRCT, TRAILING_STOP_CNST, TRAILING_STOP_PRCT, HIDDEN_STOP, HIDDEN_STOP_BY_LOWER_TRIGGER, UPPER_TRIGGER_BY_HIDDEN_STOP, NET_DEBIT, NET_CREDIT, NET_EVEN, MARKET_ON_OPEN, MARKET_ON_CLOSE, LIMIT_ON_OPEN, LIMIT_ON_CLOSE
priceValue
Link copied to clipboard
val priceValue: String?
The value of the price
ratio
Link copied to clipboard
val ratio: String?
The ratio
reInvestOption
Link copied to clipboard
val reInvestOption: ReinvestOptionType?
REINVEST, DEPOSIT, CURRENT_HOLDING
replacedByOrderId
Link copied to clipboard
val replacedByOrderId: Int?
In the event of a change order request, the order ID of the order that is replacing a prior order.
replacesOrderId
Link copied to clipboard
val replacesOrderId: Int?
In the event of a change order request, the order ID of the order that the new order is replacing.
routingDestination
Link copied to clipboard
val routingDestination: RoutingDestination?
The exchange where the order should be executed.
status
Link copied to clipboard
val status: OrderStatus?
OPEN, EXECUTED, CANCELLED, INDIVIDUAL_FILLS, CANCEL_REQUESTED, EXPIRED, REJECTED, PARTIAL, DO_NOT_EXERCISE, DONE_TRADE_EXECUTED
stopLimitPrice
Link copied to clipboard
val stopLimitPrice: Float?
The designated boundary price for a stop-limit order
stopPrice
Link copied to clipboard
val stopPrice: Float?
The designated boundary price for a stop order
trailPrice
Link copied to clipboard
val trailPrice: Float?
The current trailing value.
triggerPrice
Link copied to clipboard
val triggerPrice: Float?
The price that an advanced order will trigger.

Sources

jvm source
Link copied to clipboard