com.ampro.robinhood.endpoint.option.data

Class Option

java.lang.Object

com.ampro.robinhood.endpoint.option.data.Option

All Implemented Interfaces:

ApiElement

public class Option
extends java.lang.Object
implements ApiElement

Abstraction representing a single Robinhood investment option. This option mirrors the options domain object returned from the /options/... Robinhood Representational State Transfer (REST) endpoints. Note that this option representation includes support for multi-leg options.

For further domain knowledge on options, see the OptionList Investopedia article.

Since:

0.8.2

Constructor Summary

Constructors

Constructor and Description
Option()

Method Summary

Modifier and Type	Method and Description
SimpleOption	asSimpleOption() Convert this Option to a SimpleOption
java.math.BigDecimal	getAverageOpenPrice()
java.lang.String	getChainUrl()
java.time.ZonedDateTime	getCreatedAt()
java.lang.String	getDirection()
java.lang.String	getId()
java.math.BigDecimal	getIntradayAverageOpenPrice()
java.lang.String	getIntradayDirection()
java.math.BigDecimal	getIntradayQuantity()
java.util.List<Leg>	getLegs()
java.math.BigDecimal	getQuantity()
java.lang.String	getStrategy()
java.lang.String	getSymbol()
java.math.BigDecimal	getTradeValueMultiplier()
java.time.ZonedDateTime	getUpdatedAt()
boolean	isSimpleOption()
boolean	requiresAuth()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Option

public Option()

Method Detail

requiresAuth

public boolean requiresAuth()

Specified by:

requiresAuth in interface ApiElement

Returns:

If the element requires an authorized API (i.e. Is user-specific data)

getId

public java.lang.String getId()

getAverageOpenPrice

public java.math.BigDecimal getAverageOpenPrice()

getChainUrl

public java.lang.String getChainUrl()

getCreatedAt

public java.time.ZonedDateTime getCreatedAt()

getDirection

public java.lang.String getDirection()

getIntradayAverageOpenPrice

public java.math.BigDecimal getIntradayAverageOpenPrice()

getIntradayDirection

public java.lang.String getIntradayDirection()

getIntradayQuantity

public java.math.BigDecimal getIntradayQuantity()

getLegs

public java.util.List<Leg> getLegs()

getQuantity

public java.math.BigDecimal getQuantity()

getStrategy

public java.lang.String getStrategy()

getSymbol

public java.lang.String getSymbol()

getTradeValueMultiplier

public java.math.BigDecimal getTradeValueMultiplier()

getUpdatedAt

public java.time.ZonedDateTime getUpdatedAt()

isSimpleOption

public boolean isSimpleOption()

asSimpleOption

public SimpleOption asSimpleOption()
                            throws NonSimpleOptionException

Convert this Option to a SimpleOption

Returns:

a SimpleOption copied from this Option

Throws:

NonSimpleOptionException - If the option cannot be converted