Theme switcher

Get Account Summary

Header Parameters

Authorizationstring Required

Bearer token issued for your trading account.

Response

200
Object

OK

Response Attributes

balancenumber

Funds on your account: deposits, withdrawals, and the results of closed positions.

creditnumber

Credit funds added to your account.

equitynumber

Current value of your account, including the unrealized result of open positions.

marginnumber

Funds currently blocked as collateral for open positions.

freeFundsnumber

The amount still available to open new positions.

marginLevelnumber

The percentage ratio of your account equity to your used margin. Margin calls and stop-out levels are evaluated against this value.

profitnumber

Sum of profit of all open positions.

401
Object

error://trader-api/unauthorized

Response Attributes

pathstring Required

The request path with the actual identifiers filled in, without query parameters.

statusinteger Required

The HTTP status code, the same as the response status.

typestring Required

A stable identifier of the kind of error, in the form error://trader-api/{code}. Base your error handling on this field, not on title or detail.

Enum values:
error://trader-api/unauthorized
titlestring Required

A short, human-readable name of the error. Several types can share the same title.

detailstring Required

A description of this particular occurrence. The wording can change, so never parse it or base logic on it.

additionalInfoobject | null

Extra information as key-value pairs.

403
Object

error://trader-api/forbidden

Response Attributes

pathstring Required

The request path with the actual identifiers filled in, without query parameters.

statusinteger Required

The HTTP status code, the same as the response status.

typestring Required

A stable identifier of the kind of error, in the form error://trader-api/{code}. Base your error handling on this field, not on title or detail.

Enum values:
error://trader-api/forbidden
titlestring Required

A short, human-readable name of the error. Several types can share the same title.

detailstring Required

A description of this particular occurrence. The wording can change, so never parse it or base logic on it.

additionalInfoobject | null

Extra information as key-value pairs.

Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?