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'

• Production
• Local development

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

Authorizations

• managementKey

Parameters

Path Parameters

serverId

required

string format: uuid

UUID of a trading server owned by your organization.

Example

6be9a699-2f28-402e-b64e-93ba6bdafe1b

Header Parameters

X-Request-Id

string

Optional correlation ID used for API request billing and logs.

Example

onboarding-client-1042

Responses

200

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

Koneth Main’s view of the account, which is not the same vocabulary the trading server uses. pending means provisioning, failed means the last command against the account failed, and active means trading.

disabled is a pause: the account still exists and its trader can still read it, but the server refuses its trades with ACCOUNT_READ_ONLY until it is enabled. archived is the end: the trader can no longer sign in. The server calls the paused state read_only; Main keeps calling it disabled because that is the operation an operator asked for.

string

Allowed values: pending active disabled archived failed

lastCommandId

One of:

string

string format: uuid

null

null

currency

string

currencySymbol

string

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

key

additional properties

any

Example

{
  "accounts": [
    {
      "status": "pending"
    }
  ]
}

400

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

Example^generated

{
  "error": "example",
  "issues": [
    {}
  ]
}

401

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"
}

402

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"
}

403

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"
}

500

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"
}