Skip to content
API status
API reference

Get a trading account

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

Returns account details and credentials. Requires accounts:read. Transactions, orders, positions, and deals use their separate paginated endpoints so this response remains bounded. Protect the credentials object and do not forward this response directly to a webhook or client application.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
serverId
required
string format: uuid

UUID of a trading server owned by your organization.

Example
6be9a699-2f28-402e-b64e-93ba6bdafe1b
accountNumber
required
string
>= 4 characters <= 32 characters /^[A-Za-z0-9_-]+$/

Trading account number.

Example
7001042

Header Parameters

Section titled “Header Parameters”
X-Request-Id
string

Optional correlation ID used for API request billing and logs.

Example
onboarding-client-1042

Responses

Section titled “Responses”

200

Section titled “200”

Account details returned.

Media typeapplication/json

Account details and credentials. Historical records use separate paginated endpoints.

object
account
required

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 format: uuid
currency
string
currencySymbol
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
key
additional properties
any
credentials
required
object
tradingPassword
required
One of:
string
investorPassword
required
One of:
string
Example
{
  "account": {
    "status": "pending"
  }
}

400

Section titled “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
Examplegenerated
{
  "error": "example",
  "issues": [
    {}
  ]
}

401

Section titled “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

Section titled “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

Section titled “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"
}

404

Section titled “404”

The requested resource was not found.

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": [
    {}
  ]
}

500

Section titled “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"
}