com.ampro.robinhood

Class RobinhoodApi

java.lang.Object

com.ampro.robinhood.RobinhoodApi

public class RobinhoodApi
extends java.lang.Object

A RobinhoodApi instance is used as an intermediary between the Robinhood servers and your java/kotlin/whatever application.

Configuration

Each API instance contains it's own Configuration which contains information about account tokens and urls (if the API has been logged in).

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.logging.Logger	log The Logger object used for the custom error handling

Constructor Summary

Constructors

Constructor and Description
RobinhoodApi() Constructor which creates all of the access points to use the API.
RobinhoodApi(java.lang.String username, java.lang.String password) Constructor which creates all of the access points to use the API.

Method Summary

Modifier and Type	Method and Description
<E extends ApiElement> java.lang.Iterable<E>	buildIterable(ApiElementList<E> elementList) Build an Iterable based off a PaginatedIterator.
SecurityOrder	cancelOrder(SecurityOrder order) Deprecated.
Account	getAccountData() Method returning a Account using the currently logged in user
AccountHolderAffiliation	getAccountHolderAffiliation() Method returning a AccountHolderAffiliation for the currently logged in user
AccountHolderEmployment	getAccountHolderEmployment() Method returning a AccountHolderEmployment for the currently logged in user
BasicAccountHolderInfo	getAccountHolderInfo() Method returning a BasicAccountHolderInfo for the currently logged in user
AccountHolderInvestmentProfile	getAccountInvestmentProfile() Method returning a AccountHolderInvestmentProfile for the currently logged in user
java.util.List<Position>	getAccountPositions() Method which gets all of the account positions a user actually has shares in.
java.util.List<Position>	getAccountWatchlist() Returns a list of Position for each entry on the account's watchlist.
java.util.List<Instrument>	getAllInstruments() Get's every Instrument tracked by Robinhood.
BasicUserInfo	getBasicUserInfo() Method returning a BasicUserInfo for the currently logged in user
InstrumentCollectionList	getCollectionData(java.lang.String collectionName) Gets the collection data from Robinhood based on the given Collection Name.
Configuration	getConfig()
TickerFundamental	getFundamental(java.lang.String ticker) Method returning a TickerFundamental for the supplied ticker name
java.util.List<TickerFundamental>	getFundamentalList(java.util.Collection<java.lang.String> tickers) Get a List of TickerFundamental.
Instrument	getInstrumentByTicker(java.lang.String ticker)
java.util.List<Instrument>	getInstrumentsByKeyword(java.lang.String keyword) Gets a list of instruments by searching with the given keyword.
java.util.List<Option>	getOptions() TODO DOCS
java.util.List<SecurityOrder>	getOrders()
TickerQuote	getQuoteByTicker(java.lang.String ticker) Method returning a TickerQuote for the supplied ticker.
java.util.List<TickerQuote>	getQuoteListByTickers(java.util.Collection<java.lang.String> tickers) Get a list of security quotes by their tickers.
RatingList	getRatingsByInstrumentIds(java.lang.String... ids) Gets the ratings by instrument ids.
RatingList	getRatingsByTickers(java.lang.String... tickers) Gets the ratings by tickers.
boolean	isLoggedIn()
AuthorizationData	loadAuthData(java.lang.String email, java.lang.String password) Request AuthorizationData from Robinhood and adds it to the Configuration.
LoginStatus	login(java.lang.String email, java.lang.String password) Method which logs a user in given a email and password.
LoginStatus	login(java.lang.String email, java.lang.String password, boolean clean) Method which logs a user in given a email and password.
LoginStatus	loginMfa(java.lang.String email, java.lang.String password, java.lang.String code) Login with a Multifactor/Two-factor authorization code.
LoginStatus	logUserOut() Method which forces the authorization token to expire, logging the user out if the user is currently logged in.
SecurityOrder	makeLimitOrder(java.lang.String ticker, TimeInForce timeInForce, float limitPrice, int quantity, OrderTransactionType orderType) Method which returns a SecurityOrder after running a LIMIT order given the supplied parameters.
SecurityOrder	makeLimitStopOrder(java.lang.String ticker, TimeInForce timeInForce, float limitPrice, int quantity, OrderTransactionType orderType, float stopPrice)
SecurityOrder	makeMarketOrder(java.lang.String ticker, int quantity, OrderTransactionType orderType, TimeInForce time)
SecurityOrder	makeMarketStopOrder(java.lang.String ticker, int quantity, OrderTransactionType orderType, TimeInForce time, float stopPrice)
void	setAuthToken(java.lang.String token) Deprecated.

Methods inherited from class java.lang.Object

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

Field Detail

log

public static final java.util.logging.Logger log

The Logger object used for the custom error handling

Constructor Detail

RobinhoodApi

public RobinhoodApi()

Constructor which creates all of the access points to use the API. This constructor does not require the Username and Password, thus giving limited access to the API. See Robinhood Unofficial Documentation at following link to see what can and cannot be used if you do not authorize a user

RobinhoodApi

public RobinhoodApi(java.lang.String username,
                    java.lang.String password)
             throws RobinhoodApiException

Constructor which creates all of the access points to use the API. This constructor requires both a Username and Password and attempts to authorize the user. On success, the AuthorizationData will be stored in the Configuration instance to be retrieved elsewhere. On failure, an error will be thrown.
NOTE: This cannot be used with multifactor authorization.

Parameters:

username - The user's email (that they use with robinhood)

password - The user's password

Throws:

RobinhoodApiException - If the login failed

Method Detail

loadAuthData

public AuthorizationData loadAuthData(java.lang.String email,
                                      java.lang.String password)

Request AuthorizationData from Robinhood and adds it to the Configuration. If MFA is not required, this will save the Token and account number into the config (just like login(String, String)).

Parameters:

email - The email to login with

password - The password

Returns:

The AuthorizationData returned or null if failed. This will wither contain a token or multifactor details.

login

public LoginStatus login(java.lang.String email,
                         java.lang.String password)

Method which logs a user in given a email and password. This method automatically stores the authorization token in with the instance, allowing any method which requires the token to have immediate access to it. This method is ran if you created the RobinhoodApi class using the constructor with both a email and password, but is available if you wish to get the authorization token again.

Parameters:

email - The user's email

password - The user's password

Returns:

LoginStatus.FAILURE if the user could not be logged in. LoginStatus.SUCCESS otherwise

login

public LoginStatus login(java.lang.String email,
                         java.lang.String password,
                         boolean clean)

Method which logs a user in given a email and password. This method automatically stores the authorization token in with the instance, allowing any method which requires the token to have immediate access to it.

Parameters:

email - The email

password - The password

clean - Whether to re-load the previous AuthorizationData

Returns:

LoginStatus.FAILURE if the user could not be logged in. LoginStatus.SUCCESS otherwise

loginMfa

public LoginStatus loginMfa(java.lang.String email,
                            java.lang.String password,
                            java.lang.String code)

Login with a Multifactor/Two-factor authorization code. This requires the Configuration's AuthorizationData to be set with loadAuthData(String, String)

Parameters:

email - The user's email

password - The user's password

code - The mfa code

Returns:

LoginStatus.FAILURE if the user could not be logged in. LoginStatus.SUCCESS otherwise

logUserOut

public LoginStatus logUserOut()

Method which forces the authorization token to expire, logging the user out if the user is currently logged in.

Returns:

an enum containing either "SUCCESS"or "NOT_LOGGED_IN"

getAccountData

public Account getAccountData()

Method returning a Account using the currently logged in user

Returns:

The requested Account

Throws:

NotLoggedInException - if the user is not logged in

getBasicUserInfo

public BasicUserInfo getBasicUserInfo()

Method returning a BasicUserInfo for the currently logged in user

Returns:

Basic information about the user

Throws:

NotLoggedInException - if the user is not logged in

getAccountHolderInfo

public BasicAccountHolderInfo getAccountHolderInfo()

Method returning a BasicAccountHolderInfo for the currently logged in user

Returns:

BasicAccountHolderInfo

Throws:

NotLoggedInException - if the user is not logged in

getAccountHolderAffiliation

public AccountHolderAffiliation getAccountHolderAffiliation()

Method returning a AccountHolderAffiliation for the currently logged in user

Returns:

AccountHolderAffiliation

Throws:

NotLoggedInException - if the user is not logged in

getAccountHolderEmployment

public AccountHolderEmployment getAccountHolderEmployment()

Method returning a AccountHolderEmployment for the currently logged in user

Returns:

AccountHolderEmployment

Throws:

NotLoggedInException - if the user is not logged in

getAccountInvestmentProfile

public AccountHolderInvestmentProfile getAccountInvestmentProfile()

Method returning a AccountHolderInvestmentProfile for the currently logged in user

Returns:

AccountHolderInvestmentProfile

Throws:

NotLoggedInException - if the user is not logged in

getAccountWatchlist

public java.util.List<Position> getAccountWatchlist()

Returns a list of Position for each entry on the account's watchlist. If the quantity of the Position is above 0, that means that you have an active position in that stock.

Returns:

A list of Position, both held and only watched entities

Throws:

NotLoggedInException - If not logged in

getAccountPositions

public java.util.List<Position> getAccountPositions()

Method which gets all of the account positions a user actually has shares in.

Returns:

List containing all of the stocks an account has shares in.

Throws:

NotLoggedInException - If not logged in

getOrders

public java.util.List<SecurityOrder> getOrders()

Returns:

Closed and open orders.

Throws:

NotLoggedInException - If not logged in

makeLimitOrder

public SecurityOrder makeLimitOrder(java.lang.String ticker,
                                    TimeInForce timeInForce,
                                    float limitPrice,
                                    int quantity,
                                    OrderTransactionType orderType)
                             throws TickerNotFoundException

Method which returns a SecurityOrder after running a LIMIT order given the supplied parameters.

Parameters:

ticker - The ticker which the buy or sell order should be performed on

timeInForce - The Enum representation for when this order should be made

limitPrice - The price you're willing to accept in a sell, or pay in a buy

quantity - The number of shares you would like to buy or sell

orderType - Which type of order is being made. A buy, or sell.

Returns:

The SecurityOrder that was made

Throws:

TickerNotFoundException - Thrown when the ticker supplied to the method is invalid.

NotLoggedInException - Thrown when this Robinhood Api instance is not logged into an account. Run the login method first.

makeLimitStopOrder

public SecurityOrder makeLimitStopOrder(java.lang.String ticker,
                                        TimeInForce timeInForce,
                                        float limitPrice,
                                        int quantity,
                                        OrderTransactionType orderType,
                                        float stopPrice)
                                 throws TickerNotFoundException

Parameters:

ticker - The ticker which the buy or sell order should be performed on

timeInForce - The Enum representation for when this order should be made

limitPrice - The price you're willing to accept in a sell, or pay in a buy

quantity - The number of shares you would like to buy or sell

orderType - Which type of order is being made. A buy, or a sell

stopPrice - The price at which the stop trigger converts the order into a market order

Returns:

The created SecurityOrder

Throws:

TickerNotFoundException - The ticker supplied is not valid.

makeMarketOrder

public SecurityOrder makeMarketOrder(java.lang.String ticker,
                                     int quantity,
                                     OrderTransactionType orderType,
                                     TimeInForce time)
                              throws TickerNotFoundException

Parameters:

ticker - What ticker you are performing this order on

quantity - How many shares should be transacted

orderType - Which type of order is being made. A buy, or a sell.

time - The Enum representation of when this order should be made.

Returns:

The SecurityOrder object with the API response.

Throws:

TickerNotFoundException - if the ticker supplied was invalid

NotLoggedInException - if instance not logged in

makeMarketStopOrder

public SecurityOrder makeMarketStopOrder(java.lang.String ticker,
                                         int quantity,
                                         OrderTransactionType orderType,
                                         TimeInForce time,
                                         float stopPrice)
                                  throws TickerNotFoundException

Parameters:

ticker - The stock ticker

quantity - The number of elements to order

orderType - OrderTransactionType.BUY or OrderTransactionType.SELL

time - The time and/or duration an order will be active.

stopPrice - The stop (activation) price

Returns:

The SecurityOrder created, this order can fail (SecurityOrder.reject_reason

Throws:

TickerNotFoundException - If the ticker is not tracked by RH

NotLoggedInException - If instance is not logged in

cancelOrder

@Deprecated
public SecurityOrder cancelOrder(SecurityOrder order)
                                       throws RobinhoodApiException

Deprecated.

Cancel an order. The order must be open and not completed.

Parameters:

order - The SecurityOrder to cancel

Returns:

The cancelled order as a SecurityOrder

Throws:

RobinhoodApiException - If the order could not be cancelled

getOptions

public java.util.List<Option> getOptions()

TODO DOCS

Returns:

Throws:

NotLoggedInException - If the instance is not logged in

getFundamental

public TickerFundamental getFundamental(java.lang.String ticker)

Method returning a TickerFundamental for the supplied ticker name

Parameters:

ticker - The Stock's ticker

Returns:

TickerFundamental

getFundamentalList

public java.util.List<TickerFundamental> getFundamentalList(java.util.Collection<java.lang.String> tickers)
                                                     throws RequestTooLargeException

Get a List of TickerFundamental.

Parameters:

tickers - A collection of stock tickers

Returns:

a List of TickerFundamental.

Throws:

RequestTooLargeException - If the Collection is longer than 10

getQuoteByTicker

public TickerQuote getQuoteByTicker(java.lang.String ticker)
                             throws TickerNotFoundException

Method returning a TickerQuote for the supplied ticker. Contains general information, such as the current asking price and the last trading price. Does not require the API to be logged on.

Parameters:

ticker - Which symbol you are retrieving a quote for

Returns:

TickerQuote

Throws:

TickerNotFoundException - If the quote is not found

getQuoteListByTickers

public java.util.List<TickerQuote> getQuoteListByTickers(java.util.Collection<java.lang.String> tickers)
                                                  throws RequestTooLargeException

Get a list of security quotes by their tickers. The result is SemiPaginated, which is why this can return a normal List

Parameters:

tickers - The tickers to get quotes of (e.g. MSFT, FIT)

Returns:

A list of TickerQuoteElements. A value in the list may be null if the ticker was not found on Robinhood.

Throws:

RequestTooLargeException - if the collection is longer than 1,630

getInstrumentByTicker

public Instrument getInstrumentByTicker(java.lang.String ticker)
                                 throws TickerNotFoundException

Parameters:

ticker - The stock ticker

Returns:

The Instrument requested

Throws:

TickerNotFoundException - If the ticker is not tracked by Robinhood

getInstrumentsByKeyword

public java.util.List<Instrument> getInstrumentsByKeyword(java.lang.String keyword)

Gets a list of instruments by searching with the given keyword. As of July 2018, it seems as this will not return a list greater than 10 elements.

Parameters:

keyword - The keyword to search with

Returns:

A List of InstrumentElements returned by Robinhood's search

getAllInstruments

public java.util.List<Instrument> getAllInstruments()

Get's every Instrument tracked by Robinhood. This method performs several calls to the Robinhood servers and is therefore rather expensive to use. Try to use it sparingly (it's not like it's going to be changing all the time)

Returns:

Every Instrument tracked by Robinhood

getCollectionData

public InstrumentCollectionList getCollectionData(java.lang.String collectionName)

Gets the collection data from Robinhood based on the given Collection Name. This method does not require a security token. Examples of collections include 'manufacturing', 'consumer-product', and '100-most-popular'

Parameters:

collectionName - the collection name

Returns:

the collection data as a list of Instrument.

getRatingsByTickers

public RatingList getRatingsByTickers(java.lang.String... tickers)
                               throws RequestTooLargeException

Gets the ratings by tickers.

Parameters:

tickers - the tickers

Returns:

the ratings by tickers

Throws:

RequestTooLargeException - if request is greater than ApiMethod.MAX_TICKERS

getRatingsByInstrumentIds

public RatingList getRatingsByInstrumentIds(java.lang.String... ids)

Gets the ratings by instrument ids.

Parameters:

ids - the tickers

Returns:

the ratings by instrument ids

buildIterable

public <E extends ApiElement> java.lang.Iterable<E> buildIterable(ApiElementList<E> elementList)

Build an Iterable based off a PaginatedIterator.

Type Parameters:

E - The ApiElement of the List

Parameters:

elementList - The ApiElementList build from

Returns:

a "Paginated" Iterable

isLoggedIn

public boolean isLoggedIn()

Returns:

true if the API has been logged in

getConfig

public Configuration getConfig()

Returns:

The API instance's Configuration

setAuthToken

@Deprecated
public void setAuthToken(java.lang.String token)

Deprecated.

Method allowing a user to input a token without logging in. It is not suggested you use this unless you have a specific reason where you need to inject a auth token into the instance, generally allowing the system to resolve this token with a username and password is more 'secure'.

Parameters:

token - The new token