Account Configurations #
The account configuration API provides custom configurations about your trading account settings. These configurations control various allow you to modify settings to suit your trading needs.
For DTMC protection, see Day Trade Margin Call Protection
Get the account configurations
GET /v2/account/configurations
Returns the current account configuration values
Response
AccountConfigurations objectUpdate the account configurations
PATCH /v2/account/configurations
Returns the current account configuration values
Response
AccountConfigurations objectErrors
400 Bad request
One of the new values is unacceptable.
AccountConfigurations Entity #
Example #
{
"dtbp_check": "entry",
"no_shorting": false,
"suspend_trade": false,
"fractional_trading": true,
"max_margin_multiplier": "4",
"pdt_check": "entry",
"trade_confirm_email": "all",
"ptp_no_exception_entry": false,
}
Properties #
Attribute | Type | Description |
---|---|---|
dtbp_check |
string | both , entry , or exit . Controls Day Trading Margin Call (DTMC) checks. |
trade_confirm_email |
string | all or none . If none , emails for order fills are not sent. Other non-trade emails are unaffected. |
suspend_trade |
bool | If true, new orders are blocked. |
no_shorting |
bool | If true, account becomes long-only mode. |
fractional_trading |
bool | If true, account is able to place fractional trades |
max_margin_multiplier |
string<number> | 1 or 2 . If 1 , account is limited to no margin (limited margin only). A value of 2 provides 2x RegT margin and allows 4x Day intraday margin, if applicable. |
pdt_check |
string | both , entry , or exit . Controls [Pattern Day Trading (PDT)]{#pattern-day-trader-pdt-protection-at-alpaca} checks. If entry orders will be rejected on entering a position if it could result in PDT being set for the account. exit will reject exiting orders if they would result in PDT being set. |
ptp_no_exception_entry |
boolean | If set to true then Alpaca will accept orders for PTP symbols with no exception. Default is false. |