/ 
Finance-Robinhood-0.21
River stage zero No dependents
/ Finance::Robinhood::Portfolio

NAME

Finance::Robinhood::Portfolio - Current and Historical Financial Standing Information

SYNOPSIS

use Finance::Robinhood::Robinhood;

my $rh = Finance::Robinhood->new(token => ...);

#
my $portfolio = $rh->portfolios()->{results}[0];
print 'I may withdraw $'. $portfolio->withdrawable_amount();

DESCRIPTION

This class represents a single financial portfolio. Objects are usually created by Finance::Robinhood. If you're looking for information about your portfolio, use Finance::Robinhood->portfolios() to gather a list.

METHODS

This class has several getters and a few methods as follows...

adjusted_equity_previous_close( )

equity( )

equity_previous_close( )

excess_maintenance( )

excess_maintenance_with_uncleared_deposits( )

excess_margin( )

excess_margin_with_uncleared_deposits( )

extended_hours_equity( )

extended_hours_market_value( )

historicals( ... )

# Snapshots of basic data for every five minutes of the previous week
my $progress = $portfolio->historicals('10minute', 'week');

You may retrieve historical data with this method. The first argument is an interval of time and must be either 5minute, 10minute, day, or week.

The second argument is a span of time indicating how far into the past you would like to retrieve and may be one of the following: day, week, year, or 5year.

So, to get five years of weekly historical data, you would write...

my $iHist = $portfolio->historicals('week', '5year');

This method returns a hash which contains the following keys:

interval

The value you passed.

span

The value you passed.

total_return
equity_historicals

Which is a list of hashes which contain the following keys:

adjusted_close_equity
adjusted_open_equity
begins_at
close_equity
close_market_value
net_return
open_equity
open_market_value
session

last_core_equity( )

last_core_market_value( )

market_value( )

The total value of the portfolio.

start_date( )

The day the portfolio was initiated.

unwithdrawable_deposits( )

withdrawable_amount( )

The amount of settled cash eligible for withdraw.

id( )

Returns the string Robinhood uses to identify this portfolio.

refresh( )

Refreshes the data behind this object.

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>