Package com.seansoper.batil.brokers.etrade.api

Classes that map nearly 1-to-1 against the E*TRADE API.

Types

Account

data class Account(accountId: String, accountIdKey: String, accountType: AccountType, institutionType: String?, closedDateRaw: Int, mode: AccountMode?, description: String?, name: String?, status: AccountStatus?)

AccountBalance

data class AccountBalance(accountId: String?, asOfDate: Int?, dayTraderStatus: String?, accountMode: AccountMode?, accountType: AccountType?, institutionType: InstitutionType?, optionLevel: OptionLevel, quoteModeRaw: Int, description: String?, cash: AccountCash, balances: ComputedBalance)

AccountCash

data class AccountCash(fundsForOpenOrdersCash: Float?, moneyMktBalance: Float?)

AccountList

data class AccountList(accounts: List<Account>)

AccountListResponse

data class AccountListResponse(response: AccountRoot)

AccountMode

enum AccountMode : Enum<AccountMode>

AccountPortfolio

data class AccountPortfolio(accountId: String, next: String?, totalPages: Int?, nextPageNo: String?, positions: List<PortfolioPosition>)

AccountRoot

data class AccountRoot(accountRoot: AccountList)

AccountsApi

interface AccountsApi

AccountStatus

enum AccountStatus : Enum<AccountStatus>

AccountType

enum AccountType : Enum<AccountType>

Alert

data class Alert(id: Int, createTime: Instant?, subject: String, status: AlertStatus)

AlertDetails

data class AlertDetails(id: Int, createTime: Instant, subject: String, msgText: String?, readTime: Instant?, deleteTime: Instant?, symbol: String?, next: String?, prev: String?)

AlertDetailsResponse

data class AlertDetailsResponse(response: AlertDetails)

AlertsApi

interface AlertsApi

AlertsResponse

data class AlertsResponse(totalAlerts: Int, alerts: List<Alert>)

AlertsResponseEnvelope

data class AlertsResponseEnvelope(response: AlertsResponse)

BalanceResponse

data class BalanceResponse(response: AccountBalance)

CancelOrderRequest

data class CancelOrderRequest(orderId: Long)

CancelOrderRequestEnvelope

data class CancelOrderRequestEnvelope(request: CancelOrderRequest)

CancelOrderResponse

data class CancelOrderResponse(accountId: String, orderId: Long, cancelTime: Instant, messages: MessagesResponse?)

CancelOrderResponseEnvelope

data class CancelOrderResponseEnvelope(response: CancelOrderResponse)

CompleteView

data class CompleteView(priceAdjustedFlag: Boolean?, price: Float?, adjPrice: Float?, change: Float?, changePct: Float?, prevClose: Float?, adjPrevClose: Float?, volume: Float?, lastTrade: Float?, lastTradeTime: Int?, adjLastTrade: Float?, symbolDescription: String?, perform1Month: Float?, perform3Month: Float?, perform6Month: Float?, perform12Month: Float?, prevDayVolume: Int?, tenDayVolume: Int?, beta: Float?, sv10DaysAvg: Float?, sv20DaysAvg: Float?, sv1MonAvg: Float?, sv2MonAvg: Float?, sv3MonAvg: Float?, sv4MonAvg: Float?, sv6MonAvg: Float?, week52High: Float?, week52Low: Float?, week52Range: String?, marketCap: Float?, daysRange: String?, delta52WkHigh: Float?, delta52WkLow: Float?, currency: String?, exchange: String?, marginable: Boolean?, bid: Float?, ask: Float?, bidAskSpread: Float?, bidSize: Int?, askSize: Int?, open: Float?, delta: Float?, gamma: Float?, ivPct: Float?, rho: Float?, theta: Float?, vega: Float?, premium: Float?, daysToExpiration: Int?, intrinsicValue: Float?, openInterest: Float?, optionsAdjustedFlag: Boolean?, deliverablesStr: String?, optionMultiplier: Float?, baseSymbolAndPrice: String?, estEarnings: Float?, eps: Float?, peRatio: Float?, annualDividend: Float?, dividend: Float?, divYield: Float?, divPayDate: Int?, exDividendDate: Int?, cusip: String?, quoteStatus: QuoteMode?)

ComputedBalance

data class ComputedBalance(cashAvailableForInvestment: Float?, cashAvailableForWithdrawal: Float?, totalAvailableForWithdrawal: Float?, netCash: Float?, cashBalance: Float?, settledCashForInvestment: Float?, unSettledCashForInvestment: Float?, fundsWithheldFromPurchasePower: Float?, fundsWithheldFromWithdrawal: Float?, marginBuyingPower: Float?, cashBuyingPower: Float?, dtMarginBuyingPower: Float?, dtCashBuyingPower: Float?, marginBalance: Float?, shortAdjustBalance: Float?, regtEquity: Float?, regtEquityPercent: Float?, accountBalance: Float?, openCalls: OpenCalls, realTimeValues: RealTimeValues)

ConditionFollowPrice

enum ConditionFollowPrice : Enum<ConditionFollowPrice>

ConditionType

enum ConditionType : Enum<ConditionType>

DeleteAlertsEnvelope

data class DeleteAlertsEnvelope(response: DeleteAlertsResponse)

DeleteAlertsResponse

data class DeleteAlertsResponse(result: String, alerts: FailedAlerts?)

Event

data class Event(name: OrderEventType?, dateTime: Int?, orderNumber: Int?, instrument: Instrument)

Event

EventsResponse

data class EventsResponse(event: List<Event>)

ExecutionGuaranteeType

enum ExecutionGuaranteeType : Enum<ExecutionGuaranteeType>

FailedAlerts

data class FailedAlerts(alertId: List<Int>)

FundamentalView

data class FundamentalView(lastTrade: Float?, lastTradeTime: Instant?, change: Float?, changePct: Float?, peRatio: Float?, eps: Float?, dividend: Float?, divYield: Float?, marketCap: Float?, week52Range: String?, quoteStatus: QuoteMode?)

InstitutionType

enum InstitutionType : Enum<InstitutionType>

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?)

Instrument

LookupData

data class LookupData(data: List<LookupResult>)

LookupDataResponse

data class LookupDataResponse(response: LookupData)

LookupResult

data class LookupResult(symbol: String?, description: String?, type: String?)

Lot

data class Lot(id: Int, size: Float?)

Lot

LotsResponse

data class LotsResponse(lot: List<Lot>)

Margin

data class Margin(nonMarginable: MarginBalances?, marginable: MarginBalances?)

MarginBalances

data class MarginBalances(currentBuyingPower: Float, currentOpenOrderReserve: Float?, currentNetBuyingPower: Float?, currentOrderImpact: Float?, netBuyingPower: Float?)

MarginLevel

enum MarginLevel : Enum<MarginLevel>

MarketApi

interface MarketApi

Message

data class Message(description: String, code: Int, type: MessageType)

MessagesResponse

data class MessagesResponse(messages: List<Message>)

MessageType

enum MessageType : Enum<MessageType>

MutualFundQuantity

data class MutualFundQuantity(cash: Float?, margin: Float?, cusip: String?)

Mutual Fund Quantity

OpenCalls

data class OpenCalls(minEquityCall: Float?, fedCall: Float?, cashCall: Float?, houseCall: Float?)

OptionCategory

enum OptionCategory : Enum<OptionCategory>

OptionChainResponse

data class OptionChainResponse(timeStamp: Instant, quoteType: QuoteStatus, nearPrice: Float, pairs: List<OptionPair>)

OptionChainRoot

data class OptionChainRoot(response: OptionChainResponse)

OptionDetails

data class OptionDetails(optionCategory: OptionCategory?, optionRootSymbol: String?, timeStamp: Instant?, adjustedFlag: Boolean?, displaySymbol: String?, optionType: OptionType?, strikePrice: Float?, symbol: String?, bid: Float?, ask: Float?, bidSize: Int?, askSize: Int?, inTheMoney: Boolean?, volume: Int?, openInterest: Int?, netChange: Float?, lastPrice: Float?, quoteDetail: String?, osiKey: String?, greeks: OptionGreeks)

OptionExpirationDate

data class OptionExpirationDate(year: Int, month: Int, day: Int, expiryType: OptionExpirationType)

OptionExpirationType

enum OptionExpirationType : Enum<OptionExpirationType>

OptionExpireDateResponse

data class OptionExpireDateResponse(dates: List<OptionExpirationDate>)

OptionExpireDateResponseEnvelope

data class OptionExpireDateResponseEnvelope(response: OptionExpireDateResponse)

OptionGreeks

data class OptionGreeks(rho: Float?, vega: Float?, theta: Float?, delta: Float?, gamma: Float?, iv: Float?, currentValue: Boolean)

OptionLevel

enum OptionLevel : Enum<OptionLevel>

OptionPair

data class OptionPair(call: OptionDetails, put: OptionDetails)

OptionsWatchView

data class OptionsWatchView(baseSymbolAndPrice: String?, premium: Float?, lastTrade: Float?, bid: Float?, ask: Float?, quoteStatus: QuoteMode?, lastTradeTime: Instant?)

OptionType

enum OptionType : Enum<OptionType>

Order

data class Order(orderId: Int, details: String?, orderType: OrderType?, totalOrderValue: Float?, totalCommission: Float?, orderDetail: List<OrderDetail>?, events: EventsResponse?)

Order

OrderActionType

enum OrderActionType : Enum<OrderActionType>

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

OrderEventType

enum OrderEventType : Enum<OrderEventType>

OrderId

data class OrderId(orderId: Long, cashMargin: String?)

OrderOffsetType

enum OrderOffsetType : Enum<OrderOffsetType>

OrderPriceType

enum OrderPriceType : Enum<OrderPriceType>

OrdersApi

interface OrdersApi

OrdersResponse

data class OrdersResponse(marker: String?, next: String?, orders: List<Order>?, messages: MessagesResponse?)

Wraps response for an Order

OrdersResponseEnvelope

data class OrdersResponseEnvelope(response: OrdersResponse)

OrderTerm

enum OrderTerm : Enum<OrderTerm>

OrderType

enum OrderType : Enum<OrderType>

Order types available

PerformanceView

data class PerformanceView(change: Float?, changePct: Float?, lastTrade: Float?, daysGain: Float?, totalGain: Float?, totalGainPct: Float?, marketValue: Float?, quoteStatus: QuoteMode?, lastTradeTime: Instant?)

PlaceOrderRequest

data class PlaceOrderRequest(orderType: OrderType, clientOrderId: String, orders: List<PreviewOrder>, previewIds: List<PreviewId>)

PlaceOrderRequestEnvelope

data class PlaceOrderRequestEnvelope(request: PlaceOrderRequest)

PlaceOrderResponse

data class PlaceOrderResponse(orderType: OrderType, orderIds: List<OrderId>, orders: List<OrderDetail>, dstFlag: Boolean, placedTime: Instant, accountId: String, marginLevel: MarginLevel?, optionLevel: OptionLevel?)

PlaceOrderResponseEnvelope

data class PlaceOrderResponseEnvelope(response: PlaceOrderResponse)

Portfolio

data class Portfolio(totals: PortfolioTotals?, accountPortfolio: List<AccountPortfolio>)

PortfolioMargin

data class PortfolioMargin(houseExcessEquityNew: Float?, pmEligible: Boolean?, houseExcessEquityCurr: Float?, houseExcessEquityChange: Float?)

PortfolioPosition

data class PortfolioPosition(positionId: Long, accountId: String?, product: Product?, osiKey: String?, symbolDescription: String?, dateAcquired: Instant?, pricePaid: Float?, price: Float?, commissions: Float?, otherFees: Float?, quantity: Float?, positionIndicator: PositionIndicatorType?, positionType: String?, change: Float?, changePct: Float?, daysGain: Float?, daysGainPct: Float?, marketValue: Float?, totalCost: Float?, totalGain: Float?, totalGainPct: Float?, pctOfPortfolio: Float?, costPerShare: Float?, todayCommissions: Float?, todayFees: Float?, todayPricePaid: Float?, todayQuantity: Float?, quotestatus: String?, dateTimeUTC: Int?, adjPrevClose: Float?, performance: PerformanceView?, fundamental: FundamentalView?, optionsWatch: OptionsWatchView?, quick: QuickView?, complete: CompleteView?, lotsDetails: String?, quoteDetails: String?, positionLot: List<PositionLot>?)

PortfolioResponse

data class PortfolioResponse(response: Portfolio)

PortfolioTotals

data class PortfolioTotals(todaysGainLoss: Float?, todaysGainLossPct: Float?, totalMarketValue: Float?, totalGainLoss: Float?, totalGainLossPct: Float?, totalPricePaid: Float?)

PositionIndicatorType

enum PositionIndicatorType : Enum<PositionIndicatorType>

PositionLot

data class PositionLot(positionId: Int?, positionLotId: Int?, price: Float?, termCode: Int?, daysGain: Float?, daysGainPct: Float?, marketValue: Float?, totalCost: Float?, totalCostForGainPct: Float?, totalGain: Float?, lotSourceCode: Int?, originalQty: Float?, remainingQty: Float?, availableQty: Float?, orderNo: Int?, legNo: Int?, acquiredDate: Int?, locationCode: Int?, exchangeRate: Float?, settlementCurrency: String?, paymentCurrency: String?, adjPrice: Float?, commPerShare: Float?, feesPerShare: Float?, premiumAdj: Float?, shortType: Int?)

PositionQuantityType

enum PositionQuantityType : Enum<PositionQuantityType>

PreviewId

data class PreviewId(previewId: String)

PreviewOrderResponse

data class PreviewOrderResponse(orderType: OrderType, totalOrderValue: Float?, totalCommission: Float?, orders: List<OrderDetail>, previewIds: List<PreviewId>, marginLevel: MarginLevel?, optionLevel: OptionLevel?, margin: Margin?)

PreviewOrderResponseEnvelope

data class PreviewOrderResponseEnvelope(response: PreviewOrderResponse)

PreviewRequestEnvelope

data class PreviewRequestEnvelope(request: PreviewRequest)

Product

data class Product(symbol: String?, expiryYear: Int?, expiryMonth: Int?, expiryDay: Int?, expiryType: String?, callPut: OptionType?, securityType: SecurityType?, securitySubType: String?, strikePrice: Float?, productId: ProductId?)

ProductId

data class ProductId(symbol: String, type: ProductType)

ProductType

enum ProductType : Enum<ProductType>

QuantityType

enum QuantityType : Enum<QuantityType>

QuickView

data class QuickView(lastTrade: Float?, lastTradeTime: Instant?, change: Float?, changePct: Float?, volume: Int?, quoteStatus: QuoteMode?, sevenDayCurrentYield: Float?, annualTotalReturn: Float?, weightedAverageMaturity: Float?)

QuoteData

data class QuoteData(dateTime: GregorianCalendar, quoteStatus: QuoteStatus, ahFlag: Boolean, product: Product, tickerData: TickerData)

QuoteMode

enum QuoteMode : Enum<QuoteMode>

QuoteResponse

data class QuoteResponse(data: List<QuoteData>)

QuoteStatus

enum QuoteStatus : Enum<QuoteStatus>

RealTimeValues

data class RealTimeValues(totalAccountValue: Float?, netMv: Float?, netMvLong: Float?, netMvShort: Float?, totalLongValue: Float?)

ReinvestOptionType

enum ReinvestOptionType : Enum<ReinvestOptionType>

RoutingDestination

enum RoutingDestination : Enum<RoutingDestination>

SecurityType

enum SecurityType : Enum<SecurityType>

TickerData

data class TickerData(adjustedFlag: Boolean?, annualDividend: Float?, ask: Float?, askExchange: String?, askSize: Int?, askTime: String?, bid: Float?, bidExchange: String?, bidSize: Int?, bidTime: String?, changeClose: Float?, changeClosePercentage: Float?, companyName: String?, daysToExpiration: Int?, dirLast: String?, dividend: Float?, eps: Float?, estEarnings: Float?, exDividendDate: Int?, exchgLastTrade: String?, fsi: String?, high: Float?, high52: Float?, highAsk: Float?, highBid: Float?, lastTrade: Float?, low: Float?, low52: Float?, lowAsk: Float?, lowBid: Float?, numberOfTrades: Int?, open: Float?, openInterest: Int?, optionStyle: String?, optionUnderlier: String?, optionUnderlierExchange: String?, previousClose: Float?, previousDayVolume: Int?, primaryExchange: String?, symbolDescription: String?, todayClose: Float?, totalVolume: Int?, upc: Int?, volume10Day: Int?, cashDeliverable: Float?, marketCap: Float?, sharesOutstanding: Float?, nextEarningDate: String?, beta: Float?, yield: Float?, declaredDividend: Float?, dividendPayableDate: Int?, pe: Float?, marketCloseBidSize: Int?, marketCloseAskSize: Int?, marketCloseVolume: Int?, week52LowDate: Int?, week52HiDate: Int?, intrinsicValue: Float?, timePremium: Float?, optionMultiplier: Float?, contractSize: Float?, expirationDate: Int?, optionPreviousBidPrice: Float?, optionPreviousAskPrice: Float?, osiKey: String?, timeOfLastTrade: Int?, averageVolume: Int?)

TickerDataResponse

data class TickerDataResponse(response: QuoteResponse)

Transaction

data class Transaction(transactionId: TransactionId, accountId: String?, transactionDate: Instant?, postDate: Instant?, amount: Float?, description: String?, transactionType: String?, trade: TransactionTrade)

TransactionDetailsResponse

data class TransactionDetailsResponse(response: Transaction)

TransactionId

typealias TransactionId = Long

TransactionListResponse

data class TransactionListResponse(response: TransactionResponse)

TransactionResponse

data class TransactionResponse(marker: String?, moreTransactions: Boolean, transactionCount: Int, totalCount: Int, transactions: List<Transaction>)

TransactionTrade

data class TransactionTrade(quantity: Float?, price: Float?, settlementCurrency: String?, paymentCurrency: String?, fee: Float?, displaySymbol: String?, settlementDate: Instant?, product: Product)