Documentation

Get an account's balances

Get balances information for a specific user account.

Endpoint

Method
GET
URL
/v1/accounts/{account_id}/balances

Headers

Accept
application/xml, application/json, application/javascript
Default: application/xml
Required: false
Authorization
Bearer {access token}
Required: true

Path Parameters

account_id
An account number

Response

Field Description
account_number Account Number
account_type Account Type (margin, cash, pdt)
cash_available The amount of cash that could be withdrawn or invested in new investments, cash that is not required to support existing positions
close_pl The Profit & Loss of the current trading day’s closed positions.
current_requirement The option requirement of current account positions.
day_trade_buying_power The total amount of funds available for the purchase of fully marginable stock during that trading day, a portion of these funds cannot be held overnight.
dividend_balance Dividend Balance
equity Equity Value
fed_call The amount that the account is in deficit for trades that have occurred but not been paid for.
long_liquid_value Long Liquid Value
long_market_value Long Market Value
maintenance_call The amount that the account is under the minimum equity required in the account to support the current holdings.
market_value Market Value
net_value Net Value
open_pl The Profit & Loss of current account positions.
option_buying_power The amount of funds available to purchase non-marginable securities.
option_long_value The value of long options held in the account.
option_requirement Option Requirement
option_short_value The value of short options held in the account.
pending_cash The amount of cash that is being held for open orders.
pending_orders_count The amount of open orders.
sweep Sweep
short_liquid_value Short Liquid Value
short_market_value Short Market Value
stock_buying_power The amount of funds available to purchase fully marginable securities.
stock_long_value The value of long stocks held in the account.
stock_short_value The value of short stocks held in the account.
uncleared_funds The amount of funds that are not currently available for trading.
unsettled_funds Cash that is in the account from recent stock or option sales, but has not yet settled; cash from stock sales occurring during the last 3 trading days or from option sales occurring during the previous trading day.
total_cash The total amount of cash in the account.
total_equity The total account value.

Example

Command

$ curl -H "Authorization: Bearer {accesstoken}" https://api.tradier.com/v1/accounts/12345678/balances

Request

GET /v1/accounts/12345678/balances HTTP/1.1
Host: api.tradier.com
Accept: application/xml
Authorization: Bearer 098f6bcd4621d373cade4e832627b4f6
Content-Type: application/x-www-form-urlencoded
User-Agent: curl/7.24.0 (x86_64-apple-darwin12.0) libcurl/7.24.0 OpenSSL/0.9.8r zlib/1.2.5

Response

HTTP/1.1 200 OK
Content-Type: application/xml;charset=utf-8
X-Ratelimit-Allowed: 120
X-Ratelimit-Used: 1
X-Ratelimit-Available: 119
X-Ratelimit-Expiry: 1369164360001

<balances>

  <!-- Displayed for all account types -->
  <account_number>12345678</account_number>
  <account_type>margin</account_type>
  <close_pl>0.000000</close_pl>
  <current_requirement>0.000000</current_requirement>
  <equity>2014.590000</equity>
  <long_market_value>0.000000</long_market_value>
  <market_value>0.000000</market_value>
  <open_pl>0.000000</open_pl>
  <option_long_value>0.000000</option_long_value>
  <option_requirement>0.000000</option_requirement>
  <option_short_value>0</option_short_value>
  <pending_orders_count>1</pending_orders_count>
  <short_market_value>0.000000</short_market_value>
  <stock_long_value>0.000000</stock_long_value>
  <total_cash>2014.590000</total_cash>
  <total_equity>2014.59000</total_equity>
  <uncleared_funds>0</uncleared_funds>

  <!-- only returned for margin accounts -->
  <margin>
    <fed_call>0</fed_call>
    <maintenance_call>0</maintenance_call>
    <option_buying_power>1986.10000</option_buying_power>
    <stock_buying_power>3972.2</stock_buying_power>
    <stock_short_value>0</stock_short_value>
    <sweep>0</sweep>
  </margin>

  <!-- only returned for cash accounts -->
  <cash>
    <cash_available>204.690000</cash_available>
    <sweep>0</sweep>
    <unsettled_funds>0.000000</unsettled_funds>
  </cash>

  <!-- only returned for PDT accounts -->
  <pdt>
    <day_trade_buying_power>581604.00000</day_trade_buying_power>
    <fed_call>0</fed_call>
    <maintenance_call>0</maintenance_call>
    <option_buying_power>111080.6500000000000</option_buying_power>
    <stock_buying_power>222161.30000000</stock_buying_power>
    <stock_short_value>0</stock_short_value>
  </pdt>
</balances>

Tradier Inc. and its corresponding technology services (including API services) are distinct and separate from the services provided by Tradier Brokerage Inc. For more information regarding the services of Tradier, Inc., please contact techsupport@tradier.com. For more information regarding the services of Tradier Brokerage, Inc. please contact service@tradierbrokerage.com. Tradier Brokerage Inc. Member FINRA/SIPC

© 2017 Tradier Inc.
  • 11016 Rushmore Drive, Suite 350
  • Charlotte, NC 28277

All materials contained on this site and specifically the API documentation pages are protected by United States copyright law and may not be copied, reproduced, distributed, transmitted, displayed, published or broadcast without the prior written permission of Tradier Inc. The Structure, Format, Layout, Examples and Design of the pages are owned by Tradier Inc, and any efforts to willfully or accidently duplicate a whole or part of the pages on this site is a violation of United States copyright law.