account_config: Get Account Configurations

In jagg19/AlpacaforR: Trade with Alpaca using R

Get Account Configurations

Description

The account configuration API serves an important role in setting the way you want. See Account Configurations for details.

Usage

account_config(
  dtbp_check,
  fractional_trading,
  max_margin_multiplier,
  no_shorting,
  pdt_check,
  suspend_trade,
  trade_confirm_email,
  live = get_live()
)

Arguments

dtbp_check	(character) both, entry, or exit. Controls Day Trading Margin Call (DTMC) checks. Default NULL (no change). Set to "default" to set all configuration options back to defaults. See Value section for defaults.
fractional_trading	(logical)
max_margin_multiplier	(numeric)
no_shorting	(logical) If true, account becomes long-only mode. Default NULL (no change).
pdt_check	(character) Not documented.
suspend_trade	(logical) If true, new orders are blocked. Default NULL (no change).
trade_confirm_email	(character) all or none. If none, emails for order fills are not sent. Default NULL (no change).
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

AccountConfigurations (list) AccountConfigurations object with the following parameters (defaults shown):

• dtbp_check = "entry"

• fractional_trading = TRUE

• max_margin_multiplier = 4

• no_shorting = FALSE

• pdt_check = "entry"

• suspend_trade = FALSE

• trade_confirm_email = "all"

See Also

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

Examples

## Not run: 
account_config(live = FALSE)
# Which is similar to:
account_config()
# For access to live accounts, you must submit as live = TRUE
account_config(live = TRUE)
account_config(dtbp_check = "both", no_shorting = TRUE)
account_config("default")

## End(Not run)

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