Skip to content
API status
API reference

List trading accounts

GET
/api/v1/management/servers/{serverId}/accounts
curl --request GET \
--url https://api.koneth.com/api/v1/management/servers/6be9a699-2f28-402e-b64e-93ba6bdafe1b/accounts \
--header 'Authorization: <Authorization>' \
--header 'X-Request-Id: onboarding-client-1042'

Returns trading accounts managed on a server. Requires accounts:read.

serverId
required
string format: uuid

UUID of a trading server owned by your organization.

Example
6be9a699-2f28-402e-b64e-93ba6bdafe1b
X-Request-Id
string

Optional correlation ID used for API request billing and logs.

Example
onboarding-client-1042

Accounts returned.

Media typeapplication/json
object
accounts
required
Array<object>

Known management and live fields for a trading account.

object
id
required
string format: uuid
organizationId
string format: uuid
serverId
required
string format: uuid
accountNumber
required
string
accountName
required
string
initialBalance
number
balance
number
leverage
required
integer
status
required
string
Allowed values: pending active disabled archived failed
lastCommandId
One of:
string format: uuid
currency
string
currencySymbol
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
key
additional properties
any
Example
{
"accounts": [
{
"status": "pending"
}
]
}

Invalid request.

Media typeapplication/json
object
error
required
string
issues

Validation issue details when the request fails schema validation.

Array<object>
object
key
additional properties
any
Examplegenerated
{
"error": "example",
"issues": [
{}
]
}

Management API authentication is missing or invalid.

Media typeapplication/json
object
error
required
string
issues

Validation issue details when the request fails schema validation.

Array<object>
object
key
additional properties
any
Example
{
"error": "Management API authentication required"
}

The organization cannot cover the active API request price.

Media typeapplication/json
object
error
required
string
issues

Validation issue details when the request fails schema validation.

Array<object>
object
key
additional properties
any
Example
{
"error": "Insufficient API credits"
}

The key lacks the required scope or server access.

Media typeapplication/json
object
error
required
string
issues

Validation issue details when the request fails schema validation.

Array<object>
object
key
additional properties
any
Example
{
"error": "Missing API scope: accounts:read"
}

Unexpected server error.

Media typeapplication/json
object
error
required
string
issues

Validation issue details when the request fails schema validation.

Array<object>
object
key
additional properties
any
Example
{
"error": "Internal server error"
}