NAME

Finance::Robinhood::Equity::Watchlist - Represents a Single Robinhood Watchlist

SYNOPSIS

use Finance::Robinhood;
my $rh = Finance::Robinhood->new->login('user', 'pass');
my $watchlist = $rh->watchlist_by_name('Default');

# TODO

METHODS

This is a subclass of Finance::Robinhood::Utilities::Iterator. All the sweet, sugary goodness from there works here. Note that next( ), current( ), etc. return Finance::Robinhood::Equity::Watchlist::Element objects.

name( )

warn $watchlist->name;

Returns the name given to this watchlist.

populate( ... )

$watchlist->populate('MSFT', 'QQQ', 'BA');

Adds a list of equity instruments in bulk by their ticker symbol and returns a boolean.

add_instrument( ... )

$watchlist->add_instrument($msft);

Adds an equity instrument. If successful, a Finance::Robinhood::Equity::Watchlist::Element object is returned.

instruments( )

my @instruments = $watchlist->instruments();

This method makes a call to grab data for every equity instrument on the watchlist and returns them as a list.

ids( )

my @ids = $watchlist->ids();

Returns the instrument id for all equity instruments as a list.

reorder( ... )

$watchlist->reorder( @ids );

This method moves items of the watchlist around.

LEGAL

This is a simple wrapper around the API used in the official apps. The author provides no investment, legal, or tax advice and is not responsible for any damages incurred while using this software. This software is not affiliated with Robinhood Financial LLC in any way.

For Robinhood's terms and disclosures, please see their website at https://robinhood.com/legal/

LICENSE

Copyright (C) Sanko Robinson.

This library is free software; you can redistribute it and/or modify it under the terms found in the Artistic License 2. Other copyrights, terms, and conditions may apply to data transmitted through this module. Please refer to the LEGAL section.

AUTHOR

Sanko Robinson <sanko@cpan.org>

cpanm Finance::Robinhood

perl -MCPAN -e shell
install Finance::Robinhood