List User's Accounts

List all trading accounts of a particular user

Overview

This endpoint enables you to list all trading accounts associated with the user whose authorization token was provided in the request header. Note that trading accounts are distinct from the regular user accounts.

There are four required parameters that must be provided in the request:

1. Et-App-Key (header). This is the unique key of your app that identifies your app when communicating with our service. Contact your administrator to get this key.

2. Authorization (header). This is the authorization token from the very first token request.

3. Internal user ID (path). This is the numeric ID of the user whose trading accounts you'd like to list.

4. API version (path). Unless necessary, leave it at "1.0"

The user information request must be sent to the following URL:

apiURL/v1.0/users/644(userID)/accounts

To list the trading accounts of the user whose authorization token you provide in the request header, replace the internal user ID with @me

Response

As a response, you'll receive a JSON file with the trading accounts of this user:

[
    {
        "Id": 644,
        "ClearingAccount": "6303", 
        "AccessType": "Full", 
        "MarginType": "DayTrader", 
        "Enabled": true
    }
]

where:

Parameter	Description
Id	This is the internal ID of the trading account in Autoshares Trader.
ClearingAccount	This is the internal number of the trading account
AccessType	This is the access type of the account. Possible values: 0 (Full), 1 (Read Only), (Close Positions Only).
MarginType	This is the account type. Possible values: Full, Margin, DayTrader.

Common Mistakes

Here are some of the common mistakes that developers make when requesting the list of trading accounts of a particular user:

Failing to Specify the Et-App-Key Parameter

If you specify the wrong Et-App-Key parameter or fail to include it in the header altogether, you'll get the following error:

{
    "error": "Application key is not defined or does not exist"
}

Specifying the Regular User ID Instead of the Internal One

Another common mistake when making this request is specifying the regular user ID instead of the internal Autoshares Trader ID. Doing so will result in the 400 status code and the following error message:

{
    "Message": "The request is invalid."
}

In the following article we provide in-depth coverage of the syntax for this API request.