Accounts

Retrieve Trading Details for an Account

As a broker you can view more trading details about your users.

The response is a Trading Account model.

get/v1/trading/accounts/{account_id}/account

Request

Base URL
https://broker-api.giftcity.sandbox.in.alpaca.markets
URL
https://broker-api.giftcity.sandbox.in.alpaca.markets/v1/trading/accounts/{account_id}/account
Auth
HTTP basic

Response

account_blockedboolean required

If true, the account activity by user is prohibited.

account_numberstring nullable required

The account number

accrued_feesstring decimal required

Accrued fees

balance_asofstring required

The date of the snapshot for last_* fields

buying_powerstring decimal required

Current available cash buying power. If multiplier = 2 then buying_power = max(equity-initial_margin(0) * 2). If multiplier = 1 then buying_power = cash.

cashstring decimal required

Cash balance

cash_transferablestring

Cash available for transfer (JNLC)

cash_withdrawablestring decimal

Cash available for withdrawal

clearing_brokerstring

Clearing broker

created_atstring required

Timestamp this account was created at

Designates the current status of this account

Possible Values:

INACTIVE Account not set to trade given asset.
PAPER_ONLY The account is limited to paper trading.
ONBOARDING An application is expected for this user, but has not been submitted yet.
SUBMITTED The application has been submitted and is being processed.
SUBMISSION_FAILED Used to display if failure on submission
ACTION_REQUIRED The application requires manual action.
ACCOUNT_UPDATED Used to display when Account has been modified by user
APPROVAL_PENDING Initial value. The application approval process is in progress.
APPROVED The account application has been approved, and waiting to be ACTIVE
REJECTED The account application is rejected for some reason
ACTIVE The account is fully active. Trading and funding are processed under this status.
ACCOUNT_CLOSED The account is closed.

currencystring required

Always USD

effective_buying_powerstring decimal required

Effective buying power (duplicate of buying power)

equitystring decimal required

cash + long_market_value + short_market_value

idstring uuid required

The account ID

initial_marginstring decimal required

Reg T initial margin requirement (continuously updated value)

intraday_adjustmentsstring

The intraday adjustment by non_trade_activities such as fund deposit/withdraw.

last_buying_powerstring

Value of buying_power as of previous trading day at 16:00:00 ET

last_cashstring

Value of all cash as of previous trading day at 16:00:00 ET

last_equitystring decimal required

Equity as of previous trading day at 16:00:00 ET

last_initial_marginstring

Value of Reg T margin as of previous trading day at 16:00:00 ET

last_long_market_valuestring

Value of all long positions as of previous trading day at 16:00:00 ET

last_maintenance_marginstring decimal required

Maintenance margin requirement on the previous trading day

last_options_buying_powerstring

Value of option buying power as of previous trading day at 16:00:00 ET

last_regt_buying_powerstring

Value of Reg T buying power as of previous trading day at 16:00:00 ET

last_short_market_valuestring

Value of all short positions as of previous trading day at 16:00:00 ET

long_market_valuestring decimal required

Real-time MtM value of all long positions held in the account

maintenance_marginstring decimal required

Maintenance margin requirement (continuously updated value)

memopostsstring

Outstanding memopost value

multiplierstring decimal required

"1", "2", "3", or "4"

non_marginable_buying_powerstring decimal required

Non-marginable buying power (currently used for only crypto trading)

options_approved_level0 | 1 | 2 | 3

The options trading level that was approved for this account. 0=disabled, 1=Covered Call/Cash-Secured Put, 2=Long Call/Put, 3=Spreads/Straddles.

options_buying_powerstring decimal

Your buying power for options trading

options_trading_level0 | 1 | 2 | 3

The effective options trading level of the account. This is the minimum between account options_approved_level and account configurations max_options_trading_level. 0=disabled, 1=Covered Call/Cash-Secured Put, 2=Long Call/Put, 3=Spreads/Straddles.

pending_reg_taf_feesstring

Pending regulatory fees for the account.

pending_transfer_outstring

Cash pending transfer out

portfolio_valuestring decimal required

Total value of cash + holding positions. (This field is deprecated. It is equivalent to the equity field.)

position_market_valuestring decimal required

Real-time MtM value of all the positions held in the account

previous_closestring

Previous sessions close time

regt_buying_powerstring decimal required

User's buying power under Regulation T (excess equity - (equity - margin value) - * margin multiplier)

short_market_valuestring decimal required

Real-time MtM value of all short positions held in the account

shorting_enabledboolean required

Flag to denote whether or not the account is permitted to short

smastring decimal required

Value of Special Memorandum Account (will be used at a later date to provide additional buying_power)

Designates the current status of this account

Possible Values:

INACTIVE Account not set to trade given asset.
PAPER_ONLY The account is limited to paper trading.
ONBOARDING An application is expected for this user, but has not been submitted yet.
SUBMITTED The application has been submitted and is being processed.
SUBMISSION_FAILED Used to display if failure on submission
ACTION_REQUIRED The application requires manual action.
ACCOUNT_UPDATED Used to display when Account has been modified by user
APPROVAL_PENDING Initial value. The application approval process is in progress.
APPROVED The account application has been approved, and waiting to be ACTIVE
REJECTED The account application is rejected for some reason
ACTIVE The account is fully active. Trading and funding are processed under this status.
ACCOUNT_CLOSED The account is closed.

trade_suspended_by_userboolean required

If true, the account is not allowed to place orders.

trading_blockedboolean required

If true, the account is not allowed to place orders.

transfers_blockedboolean required

If true, the account is not allowed to request money transfers.

Example response

{
  "account_blocked": false,
  "account_number": "927584925",
  "accrued_fees": "0",
  "admin_configurations": {},
  "balance_asof": "2021-04-01",
  "buying_power": "103556.8572572922",
  "cash": "24861.91",
  "cash_transferable": "24861.91",
  "cash_withdrawable": "17861.91",
  "clearing_broker": "VELOX",
  "created_at": "2021-03-01T13:28:49.270232Z",
  "crypto_status": "ACTIVE",
  "currency": "USD",
  "effective_buying_power": "103556.8572572922",
  "equity": "28059.3882330664",
  "id": "c8f1ef5d-edc0-4f23-9ee4-378f19cb92a4",
  "initial_margin": "1598.7391165332",
  "intraday_adjustments": "0",
  "last_buying_power": "104433.9158860662",
  "last_cash": "23861.91",
  "last_equity": "26977.323677655",
  "last_initial_margin": "1557.7068388275",
  "last_long_market_value": "3115.413677655",
  "last_maintenance_margin": "934.6241032965",
  "last_options_buying_power": "25419.62",
  "last_regt_buying_power": "50839.233677655",
  "last_short_market_value": "0",
  "long_market_value": "3197.4782330664",
  "maintenance_margin": "959.24346991992",
  "multiplier": "2",
  "non_marginable_buying_power": "24861.91",
  "options_approved_level": 0,
  "options_buying_power": "26460.65",
  "options_trading_level": 0,
  "pending_reg_taf_fees": "0",
  "pending_transfer_out": "0",
  "portfolio_value": "28059.3882330664",
  "position_market_value": "3197.4782330664",
  "previous_close": "2021-04-01T19:00:00-04:00",
  "regt_buying_power": "52921.2982330664",
  "short_market_value": "0",
  "shorting_enabled": true,
  "sma": "26758.0590204615",
  "status": "ACTIVE",
  "trade_suspended_by_user": false,
  "trading_blocked": false,
  "transfers_blocked": false
}

Changes

No recorded changes to this operation across all 1 revision of this API.

Retrieve Trading Details for an Account

Request

Response 200OK

Example response

Changes

Response