/ 
Finance-Robinhood-0.92_002
River stage zero No dependents
/ Finance::Robinhood::Equity::Account

NAME

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

SYNOPSIS

use Finance::Robinhood;
my $rh = Finance::Robinhood->new->login('user', 'pass');
my $account = $rh->equity_accounts->current();

CORE::say sprintf '$%0.2f of $%0.2f can be withdrawn', 
    $account->cash_available_for_withdrawal,
    $account->cash;

METHODS

account_number( )

The string used to identify this account. Used in the URL for many endpoints.

buying_power( )

The maximum amount of cash on hand and available margin you may use to buy stuff.

cash( )

The amount of settled cash on hand.

cash_available_for_withdrawal( )

The amount of settled cash on hand that has been in the account long enough to be withdrawn back to the original bank account.

cash_held_for_orders( )

Money set aside for buy orders that have not yet executed.

deactivated( )

Returns true if the account has been closed.

deposit_halted( )

Returns true if ACH deposits are disabled.

is_pinnacle_account( )

True if account is backed by Robinhood Clearing rather than Apex Clearing.

max_ach_early_access_amount( )

Maximum amount instantly available after an ACH deposit. Unless you have a Gold subscription, this will likely be Instant's standard $1000.

only_position_closing_trades( )

If your account is restricted from opening new positions, this will be true.

option_level( )

One of several options:

  • option_level_1

  • option_level_2

  • option_level_3

rhs_account_number( )

Internal account number used for official documents (tax forms, etc.)

sma( )

TODO

sma_held_for_orders( )

TODO

sweep_enabled( )

Returns true if sweep is enabled to move cash between your brokerage account to RH's crypto service.

type( )

Simple cash or margin account flag.

uncleared_deposits( )

Incoming ACH deposits that have not cleared yet.

unsettled_debit( )

Outgoing funds that are not yet settled.

unsettled_funds( )

Funds that are not yet settled but may be used thanks to Gold or Instant margin accounts.

withdrawal_halted( )

True if the account has been flagged and ACH withdrawal has been disabled.

created_at( )

Returns a Time::Moment object.

updated_at( )

Returns a Time::Moment object.

user( )

Returns the related Finance::Robinhood::Equity::Account object.

can_downgrade_to_cash( )

This method returns a true value if your account is currently eligible for downgrading from a margin account (Instant or Gold) to a cash account.

instant_eligibility( )

Returns the related Finance::Robinhood::Equity::Account::InstantEligibility object.

margin_balances( )

Returns the related Finance::Robinhood::Equity::Account::MarginBalances object.

portfolio( )

Returns the related Finance::Robinhood::Equity::Account::Portfolio object.

positions( )

my $positions = $account->equity_positions( );

Returns the related paginated list object filled with Finance::Robinhood::Equity::Position objects.

my $positions = $account->equity_positions( nonzero => \1 );

You can filter and modify the results. All options are optional.

nonzero - true or false. Default is false.
ordering - List of equity instruments

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>