AutoShares API
  • What is AutoShares?
  • API Documentation
    • Quick Start Guide
    • API Overview
    • Authentication
      • Authenticate with AutoShares SSO/Auth0
      • Triggering authentication with /login
      • For logout scenario
    • Onboarding Users
      • Account Setup
        • Syntax
        • Add Account To User
        • Add Account To User By Username
        • Get All Accounts Of A User
        • Get All Users Of An Account
        • Get Account Info
        • Update Alias Account For Current User
        • Remove Account From User
        • Get User's Trading Settings
        • Get User's Exchanges
      • Access Agreements
    • Account Balances and Buying Power
      • Get Balance Information For A User
      • Get Account's Balance Info
      • Get Historical Account Value
    • Order Processing and Trading
      • Place Order
        • Syntax
      • Verify Order Placement
        • Syntax
      • Verify Order Replacement
        • Syntax
      • Replace Order
        • Syntax
      • Cancel an Order
        • Syntax
      • Get Order's Info
        • Syntax
      • Get Filtered Orders
        • Syntax
      • Validate Order by ID
      • Positions
        • Get User's Positions
          • Syntax
        • Get User's Positions in a Security
          • Syntax
        • Get Market Value of all Security Groups
      • Managing Transactions
        • Get Transactions
          • Syntax
    • Streaming Data and Quotes
      • Streaming API Endpoints
        • Get Streamers' Info
        • Recover a Streamer Session
      • Quotes
      • Orders
      • Positions
      • Watchlists
      • Account Balances
      • User Balance
      • Securities
        • Get Equity Info by Internal ID
          • Syntax
        • Get Equity Info by Ticker
          • Syntax
        • Get Equity Info by Mask
          • Syntax
        • Get Filtered Equities
          • Syntax
        • Get Option Info by Internal ID
          • Syntax
        • Get Option Info by Ticker
          • Syntax
        • Get Options Expiration Dates
          • Syntax
        • Get an Option Chain
        • Get Filtered Options
          • Syntax
        • Get Company Logo By Symbol
    • Historical Chart Data
      • Get Comparison Chart Data
        • Syntax
      • Get Candles and Indicators for a Security
        • Syntax
      • Get Chart Data in the Excel Format
        • Syntax
    • Price Alerts
      • Create Price Alert
        • Syntax
      • Delete Price Alert
        • Syntax
      • Get Specific Alert
        • Syntax
      • Get User's Price Alerts
        • Syntax
      • Modify Price Alert
        • Syntax
    • Watchlists
      • Add Security to Watchlist by ID
        • Syntax
      • Add Security to Watchlist by Ticker
        • Syntax
      • Create New Watchlist
        • Syntax
      • Delete Watchlist
        • Syntax
      • Get Specific Watchlist
        • Syntax
      • Get User's Watchlists
        • Syntax
      • Remove Security From Watchlist by ID
        • Syntax
      • Remove Security from Watchlist by Ticker
        • Syntax
      • Rename Watchlist
        • Syntax
      • News
        • Get News for a Security
        • Get Corporate Actions for a Security
    • [Webhooks and SDKs]
    • Wires, ACH, and Account Transfers
      • ACH Setup
        • Create A New ACH Relationship
        • Get an ACH Relationship
        • Modify an ACH Relationship
      • Deposit / Withdraw Funds
        • Deposit / Withdraw Funds via ACH
      • Get a Transfer's Info
        • Get an ACH Transfer's Info
        • Get All Transfers
    • Terms and Definitions
      • Part I
      • Part II
      • Part III
Powered by GitBook
On this page
  • Subscription Parameters
  • Unsubscription Parameters
  • Message
  1. API Documentation
  2. Streaming Data and Quotes

Account Balances

Subscribe to changes in traders' account balances

Subscription Parameters

Parameter
Value

Cmd

Subscribe.txt

SessionId

Session ID from the authentication request

Keys

The ID of the trading account whose account balances you would like to retrieve

EntityType

AccountBalance

HttpClientType

WebSocket

Example: {"Cmd":"Subscribe.txt", "SessionId":"7e83072e-09e7-43ed-91d5-f2b747bf162e", "Keys":"140","EntityType":"AccountBalance","HttpClientType":"WebSocket"}

If you need to stream account balances for multiple trading accounts, simply send multiple subscription commands and AutoShares will start outputting individual messages for each trading account.

Unsubscription Parameters

Parameter
Value

Cmd

Unsubscribe.txt

SessionId

Session ID from the authentication request

Keys

The ID of the trading account whose account balances you would like to unsubscribe from

EntityType

AccountBalance

HttpClientType

WebSocket

Example: { "Cmd":"Unsubscribe.txt", "SessionId":"7e83072e-09e7-43ed-91d5-f2b747bf162e", "Keys":"140","EntityType":"Position","HttpClientType":"WebSocket"}

Message

In response to this request, you will receive all account-related information in the JSON format.

Example:

{
    "EntityType": "AccountBalance",
    "AccountId": "140",
    "CashBalance": "0",
    "PendingCash": "0",
    "PendingOrdersCount": "0",
    "Items": "[{\"Name\":\"cash\",\"Value\":1084543.57000000},{\"Name\":\"netCash\",\"Value\":1084543.57000000},{\"Name\":\"excess\",\"Value\":1084543.57000000},{\"Name\":\"changeAbsolute\",\"Value\":-1214.31400000000000000000},{\"Name\":\"changePercent\",\"Value\":-0.1031318408562315568923557400},{\"Name\":\"equityTotal\",\"Value\":1176224.18600000000000000000},{\"Name\":\"pendingOrdersCount\",\"Value\":0},{\"Name\":\"netLiquidity\",\"Value\":91680.61600000000000000000},{\"Name\":\"stockLongMarketValue\",\"Value\":135293.16600000000000000000},{\"Name\":\"stockShortMarketValue\",\"Value\":-43612.550000000000000000},{\"Name\":\"optionLongMarketValue\",\"Value\":0},{\"Name\":\"optionShortMarketValue\",\"Value\":0},{\"Name\":\"forexLongMarketValue\",\"Value\":0},{\"Name\":\"forexShortMarketValue\",\"Value\":0},{\"Name\":\"dayTrades\",\"Value\":0},{\"Name\":\"stockBuyingPower\",\"Value\":1084543.57},{\"Name\":\"optionBuyingPower\",\"Value\":1084543.57000000},{\"Name\":\"forexBuyingPower\",\"Value\":1084543.57},{\"Name\":\"dayTradingBuyingPower\",\"Value\":4338174.28000000},{\"Name\":\"pendingCash\",\"Value\":0},{\"Name\":\"maintenanceMargin\",\"Value\":0},{\"Name\":\"optionMaintenanceMargin\",\"Value\":0},{\"Name\":\"openPL\",\"Value\":40344.455996740000000000000000},{\"Name\":\"openPLDay\",\"Value\":-1214.31400000000000000000},{\"Name\":\"openPLPercent\",\"Value\":78.588768607114373461918599730},{\"Name\":\"closePL\",\"Value\":0.00000000},{\"Name\":\"marketValue\",\"Value\":91680.61600000000000000000},{\"Name\":\"totalPL\",\"Value\":40344.455996740000000000000000}]"
}
PreviousWatchlistsNextUser Balance

Last updated 1 year ago