The Perl Toolchain Summit needs more sponsors. If your company depends on Perl, please support this very important event.
 / 
Finance-Robinhood-0.19
River stage zero No dependents
3 ++
/ Finance::Robinhood::Watchlist

NAME

Finance::Robinhood::Watchlist - Persistent List of Financial Instruments

SYNOPSIS

    use Finance::Robinhood::Instrument;

    #...

    my $watchlist = $rh->create_watchlist( 'Tech' );

    $watchlist->add_instrument( $rh->instrument('AAPL') );

DESCRIPTION

Robinhood allows persistent, categorized lists of financial instruments in 'watchlists'. Watchlists are tied to a user rather than a single account.

If you intend to create your own watchlists, please use the create_watchlist( ... ) method of Finance::Robinhood.

METHODS

Watchlists are rather simple in themselves but can be very powerful for organization. Let's say you have a really short list of stocks you'd really like to keep an eye on, you could add just those securities to a watchlist. Or You could add a watchlist for securities in a certain field.

name( )

Returns the name given to this watchlist. The official apps use a watchlist named 'Default'.

instruments( )

Returns a paginated list of Finance::Robinhood::Instrument objects being kept track of in this watchlist.

delete_instrument( ... )

    $watchlist->delete_instrument( $instrument );

Removes a financial instrument from the watchlist.

add_instrument( ... )

    $watchlist->add_instrument( $instrument );

Adds a financial instrument to the watchlist. Attempts to add an instrument a second time will fail.

bulk_add_symbols( ... )

    $watchlist->bulk_add_symbols(qw[MSFT FB GOOGL]);

Add multiple instruments in a single API call and by their symbols with this. The return value is a list of new Finance::Robinhood::Instrument objects.

...this is easier than gathering ::Instrument objects and calling add_instrument( ... ) for each individual security, right?

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. Neither this software nor its author are affiliated with Robinhood Financial LLC in any way.

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

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>