Account

Account API

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. An account maybe be blocked for just for trades (trades_blocked flag) or for both trades and transfers (account_blocked flag) if Alpaca identifies the account to engaging in any suspicious activity. Also, in accordance with FINRA’s pattern day trading rule, an account may be flagged for pattern day trading (pattern_day_trader flag), which would inhibit an account from placing any further day-trades.

[GET] Get the account

GET/v1/account
Returns the account associated with the API key.

Response

Account object

Account Entity

Example

{
  "id": "904837e3-3b76-47ec-b432-046db621571b",
  "status": "ACTIVE",
  "currency": "USD",
  "buying_power": "4000.32",
  "cash": "4000.32",
  "cash_withdrawable": "4000.32",
  "portfolio_value": "4321.98",
  "pattern_day_trader": false,
  "trading_blocked": false,
  "transfers_blocked": false,
  "account_blocked": false,
  "created_at": "2018-10-01T13:35:25Z"
}

Properties

id
string<uuid>
Account ID.
status
string<account_status>
See Account Status
currency
string
“USD”
buying_power
string<number>
Tradable buying power
cash
string<number>
Cash balance
cash_withdrawable
string<number>
Withdrawable cash amount
portfolio_value
string<number>
Total value of cash + holding positions
pattern_day_trader
boolean
Whether or not the account has been flagged as a pattern day trader
trading_blocked
boolean
If true, the account is not allowed to place orders.
transfers_blocked
boolean
If true, the account is not allowed to request money transfers.
account_blocked
boolean
If true, the account activity by user is prohibited.
created_at
string<timestamp>
Timestamap this account was created at

Account Status

The following are the possible account status values. Most likely, the account status is ACTIVE unless there is any problem. The account status may get in ACCOUNT_UPDATED when personal information is being updated from the dashboard, in which case you may not be allowed trading for a short period of time until the change is approved.

  • ONBOARDING
    The account is onboarding.
  • SUBMISSION_FAILED
    The account application submission failed for some reason.
  • SUBMITTED
    The account application has been submitted for review.
  • ACCOUNT_UPDATED
    The account information is being updated.
  • APPROVAL_PENDING
    The final account approval is pending.
  • ACTIVE
    The account is active for trading.
  • REJECTED
    The account application has been rejected.