account: Get Account Details

In jagg19/AlpacaforR: Trade with Alpaca using R

Get Account Details

Description

The accounts API serves important information related to an account, including account status, funds available for trade, funds available for withdrawal, and various flags relevant to an account's ability to trade. See the Account Endpoint in the API v2 Docs for full details.

Usage

account(live = get_live())

Arguments

live	(logical) TRUE / FALSE if you are connecting to a live account. Default to FALSE, so it will use the paper url if nothing was provided.

Value

Account (list) An Account object list of length 26:

• id (character) Account ID

• account_number (character) Account number

• status (character) See Account Endpoint Properties for details

• currency (character) USD

• buying_power (numeric) Current available $ buying power; If multiplier = 4, this is your daytrade buying power which is calculated as (last_equity - (last) maintenance_margin) * 4; If multiplier = 2, buying_power = max(equity - initial_margin,0) * 2; If multiplier = 1, buying_power = cash

• cash (numeric) cash balance

• portfolio_value (numeric) Total value of cash + holding positions

• trading_blocked (logical) If true, the account is not allowed to place orders as a boolean.

• transfers_blocked (logical) If true, the account is not allowed to request money transfers as a boolean.

• account_blocked (logical) If true, the account activity by user is prohibited as a boolean.

• created_at (Datetime/POSIXct) Timestamp this account was created at.

See Also

Other Account: account_activities(), account_config(), account_portfolio()

Examples

account()
# With default arguments equivalent to :
account(live = FALSE)
# For access to live accounts, you must submit as live = TRUE
account(live = TRUE)

jagg19/AlpacaforR documentation built on July 3, 2023, 12:14 p.m.