Broker API HubMenu

DXtrade API GET /users/{username}

GET/users/{username}Users and Accounts

Read the details of a user, which is how a program finds the accounts a login can use.

Risk warning: CFDs and spread bets are complex instruments and come with a high risk of losing money rapidly due to leverage. You can lose money on these products, and each provider publishes its own loss figure under FCA rules. You should consider whether you understand how they work and whether you can afford to take the high risk of losing your money. Automated and API trading can amplify losses through bugs, connectivity failures and runaway orders.

Independent and unofficialdemo.dx.tradechecked

Read on 12 Oct 2026 in the DXtrade REST API specification on DXtrade's developer portal. The portal draws its pages in the browser from Markdown files it also serves directly, and the Markdown file of this page (DXtrade-REST-API.md) is what was read, with the model files it includes. The portal writes each address after a base address it fills in from its own settings, which on this portal is https://demo.dx.trade/dxsca-web. A broker or firm that offers DXtrade hosts its own, so the path here is what follows that base. The specification says every request needs authentication unless it says otherwise, and this section says the Authorization header should be included, which is why it is recorded as required. The reply is a list of user details. An ETag header is sent only when one user is asked for. The page says a user can always read their own details and needs a permission to read another's. Each entry of the User Details model carries login, domain, username, version, fullName and accounts, the list of accounts the user owns, all marked required.

Parameters

NameInTypeDescription
usernamerequiredpathstringThe full username in the form username@domain, URL-encoded. No wildcards. The page calls the value optional: without it every user the login can see is returned.
limitqueryintegerMarked optional. The most users to return.
start-fromqueryintegerMarked optional. Index of the first user to return. Default 0.

Authentication headers

NameTypeDescription
AuthorizationrequiredstringWith token authentication, send DXAPI followed by the sessionToken from POST /login. With HMAC authentication the same header carries DXAPI with a principal, a timestamp and a hash, signed for each request as the specification describes. Placeholder only: never paste a real token into this site.

Request

Written from the method, path and parameters recorded on this page. No demo host is recorded as a plain address for this API, so the samples read the base address from an environment variable. Not executed against a live or demo account. Credentials are read from environment variables on your own machine and are never entered on this site. The request builder writes these same snippets, from the same record.

Python
# Set DXTRADE_BASE_URL, DXTRADE_SESSION_TOKEN as environment variables first. Never paste real values into code.
# DXTRADE_SESSION_TOKEN holds the Authorization header that POST /login returns.
# No demo host is recorded as a plain address for this API, so the base address is read from DXTRADE_BASE_URL.
# Replace each {placeholder}, "..." and 0 with a real value before running.
# Optional and not shown: query parameters limit, start-from.
import os
import requests

BASE_URL = os.environ["DXTRADE_BASE_URL"]
headers = {
    "Authorization": "DXAPI " + os.environ["DXTRADE_SESSION_TOKEN"],
}
resp = requests.get(BASE_URL + "/users/{username}", headers=headers, timeout=10)
resp.raise_for_status()
print(resp.json())
JavaScript
// Set DXTRADE_BASE_URL, DXTRADE_SESSION_TOKEN as environment variables first. Never paste real values into code.
// DXTRADE_SESSION_TOKEN holds the Authorization header that POST /login returns.
// No demo host is recorded as a plain address for this API, so the base address is read from DXTRADE_BASE_URL.
// Replace each {placeholder}, "..." and 0 with a real value before running.
// Optional and not shown: query parameters limit, start-from.
// Run as a module, for example a .mjs file, on a Node version that has fetch built in.
const BASE_URL = process.env.DXTRADE_BASE_URL;
const res = await fetch(BASE_URL + "/users/{username}", {
  method: "GET",
  headers: {
    "Authorization": "DXAPI " + process.env.DXTRADE_SESSION_TOKEN,
  },
});
if (!res.ok) throw new Error(`HTTP ${res.status}`);
console.log(await res.json());
curl
# Set DXTRADE_BASE_URL, DXTRADE_SESSION_TOKEN as environment variables first. Never paste real values into code.
# DXTRADE_SESSION_TOKEN holds the Authorization header that POST /login returns.
# No demo host is recorded as a plain address for this API, so the base address is read from DXTRADE_BASE_URL.
# Replace each {placeholder}, "..." and 0 with a real value before running.
# Optional and not shown: query parameters limit, start-from.
curl -X GET "$DXTRADE_BASE_URL/users/{username}" \
  -H "Authorization: DXAPI $DXTRADE_SESSION_TOKEN"

Response

No mock response is recorded for this endpoint. Where the record says why, or names the fields of the reply, it does so in the note at the top of this page. That is a statement about this record, not about what the API returns: read the shape of the reply in the official reference.

DXtrade API errors you may meet

All DXtrade API error codes, including 73 more not listed here.