latestOpenAPI 3.0.12026-08-16171142480.4 KB

ff1699330afa

Trading API

Get account information

get/rest/api/v1/accounts/{accountId}/information

Path parameters

accountIdstring uuid required

Response

OK

accountDuplicationInProjectDetectedboolean

Indicates whether an account duplication has been detected in this project

accountMode'NETTING' | 'HEDGING' | 'EXCHANGE'

Account margin mode: HEDGING, NETTING, or EXCHANGE

avgDrawdownnumber

Average drawdown percentage during trading period (%)

balancenumber
brokeTimeOffsetToUtcinteger
connectedboolean
creditnumber

Only for MT4/MT5

currencystring
drawdownnumber

The drawdown percentage of the account

environment'LIVE' | 'DEMO'

Indicates the account environment: LIVE or DEMO. Testnet/sim/paper environments are reported as DEMO. Null if detection is not supported for this broker type

equitynumber
fallbackModeboolean

The fallback mode is active (This means something is not working properly, and the system switches to the fallback mode)

freeMarginnumber
historyDeactivatedboolean

Indicates if history fetching has been deactivated for this account

isHyperactiveboolean

Indicates if the account is performing excessive trading activity. When true, history fetching may be disabled to reduce broker load

isInvestorPasswordboolean
isNativeboolean

Indicates if the account is using native mode

latencyInMsinteger

Latency to the broker's access server

leverageinteger
maxDrawdownnumber

Maximum drawdown percentage - worst peak-to-trough decline (%)

openPositionsboolean

True if there is an open position (buy or sell)

openPositionsCountinteger

Number of open positions (buy or sell)

pendingOrdersboolean

True if there is a pending order (buy limit, sell limit, etc

pendingOrdersCountinteger

Number of pending orders (buy limit, sell limit, etc)

positionMismatchboolean

Indicates that the open positions between the master and slave accounts are not synchronized due to failed open or close operations

profitThisMonthnumber
profitThisWeeknumber
profitTodaynumber
statusstring
unrealizedProfitnumber
usedMarginnumber
wrongCredentialsboolean