Instrument

data class Instrument(product: Product?, symbolDescription: String?, orderAction: OrderActionType?, quantityType: QuantityType?, quantity: Float?, cancelQuantity: Float?, orderedQuantity: Float?, filledQuantity: Float?, averageExecutionPrice: Float?, estimatedCommission: Float?, estimatedFees: Float?, bid: Float?, ask: Float?, lastprice: Float?, currency: String?, lots: LotsResponse?, mfQuantity: MutualFundQuantity?, osiKey: String?, mfTransaction: String?, reserveOrder: Boolean?, reserveQuantity: Float?)
Content copied to clipboard

Instrument

Parameters

product

The product details for the security

symbolDescription

The text description of the security being bought or sold

orderAction

BUY, SELL, BUY_TO_COVER, SELL_SHORT, BUY_OPEN, BUY_CLOSE, SELL_OPEN, SELL_CLOSE, EXCHANGE

quantityType

QUANTITY, DOLLAR, ALL_I_OWN

quantity

The number of shares to buy or sell

cancelQuantity

The number of shares to cancel ordering

orderedQuantity

The number of shares ordered

filledQuantity

The number of shares filled

averageExecutionPrice

The average execution price

estimatedCommission

The cost billed to the user to perform the requested action

estimatedFees

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

bid

The bid price

ask

The ask price

lastprice

The last price

currency

USD, EUR, GBP, HKD, JPY, CAD

lots

The object for the position lot

mfQuantity

The object for the mutual fund quantity

osiKey

The Options Symbology Initiative (OSI) key containing the option root symbol, expiration date, call/put indicator, and strike price

mfTransaction

BUY, SELL

reserveOrder

If TRUE, this is a reserve order meaning that only a limited number of shares will be publicly displayed instead of the entire order; this is done to avoid influencing other traders

reserveQuantity

The number of shares to be publicly displayed if this is a reserve order

Constructors

Instrument
Link copied to clipboard
fun Instrument(product: Product?, symbolDescription: String?, orderAction: OrderActionType?, quantityType: QuantityType?, quantity: Float?, cancelQuantity: Float?, orderedQuantity: Float?, filledQuantity: Float?, averageExecutionPrice: Float?, estimatedCommission: Float?, estimatedFees: Float?, bid: Float?, ask: Float?, lastprice: Float?, currency: String?, lots: LotsResponse?, mfQuantity: MutualFundQuantity?, osiKey: String?, mfTransaction: String?, reserveOrder: Boolean?, reserveQuantity: Float?)
Content copied to clipboard
The product details for the security

Properties

ask
Link copied to clipboard
val ask: Float?
Content copied to clipboard
The ask price
averageExecutionPrice
Link copied to clipboard
val averageExecutionPrice: Float?
Content copied to clipboard
The average execution price
bid
Link copied to clipboard
val bid: Float?
Content copied to clipboard
The bid price
cancelQuantity
Link copied to clipboard
val cancelQuantity: Float?
Content copied to clipboard
The number of shares to cancel ordering
currency
Link copied to clipboard
val currency: String?
Content copied to clipboard
USD, EUR, GBP, HKD, JPY, CAD
estimatedCommission
Link copied to clipboard
val estimatedCommission: Float?
Content copied to clipboard
The cost billed to the user to perform the requested action
estimatedFees
Link copied to clipboard
val estimatedFees: Float?
Content copied to clipboard
The cost or proceeds, including broker commission, resulting from the requested action
filledQuantity
Link copied to clipboard
val filledQuantity: Float?
Content copied to clipboard
The number of shares filled
lastprice
Link copied to clipboard
val lastprice: Float?
Content copied to clipboard
The last price
lots
Link copied to clipboard
val lots: LotsResponse?
Content copied to clipboard
The object for the position lot
mfQuantity
Link copied to clipboard
val mfQuantity: MutualFundQuantity?
Content copied to clipboard
The object for the mutual fund quantity
mfTransaction
Link copied to clipboard
val mfTransaction: String?
Content copied to clipboard
BUY, SELL
orderAction
Link copied to clipboard
val orderAction: OrderActionType?
Content copied to clipboard
BUY, SELL, BUY_TO_COVER, SELL_SHORT, BUY_OPEN, BUY_CLOSE, SELL_OPEN, SELL_CLOSE, EXCHANGE
orderedQuantity
Link copied to clipboard
val orderedQuantity: Float?
Content copied to clipboard
The number of shares ordered
osiKey
Link copied to clipboard
val osiKey: String?
Content copied to clipboard
The Options Symbology Initiative (OSI) key containing the option root symbol, expiration date, call/put indicator, and strike price
product
Link copied to clipboard
val product: Product?
Content copied to clipboard
The product details for the security
quantity
Link copied to clipboard
val quantity: Float?
Content copied to clipboard
The number of shares to buy or sell
quantityType
Link copied to clipboard
val quantityType: QuantityType?
Content copied to clipboard
QUANTITY, DOLLAR, ALL_I_OWN
reserveOrder
Link copied to clipboard
val reserveOrder: Boolean?
Content copied to clipboard
If TRUE, this is a reserve order meaning that only a limited number of shares will be publicly displayed instead of the entire order; this is done to avoid influencing other traders
reserveQuantity
Link copied to clipboard
val reserveQuantity: Float?
Content copied to clipboard
The number of shares to be publicly displayed if this is a reserve order
symbolDescription
Link copied to clipboard
val symbolDescription: String?
Content copied to clipboard
The text description of the security being bought or sold

Sources

jvm source
Link copied to clipboard