Skip to content
API status
API reference

Update every instrument in a category

PATCH
/api/v1/management/servers/{serverId}/instrument-categories/{category}
curl --request PATCH \
--url https://api.koneth.com/api/v1/management/servers/6be9a699-2f28-402e-b64e-93ba6bdafe1b/instrument-categories/forex \
--header 'Authorization: <Authorization>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: account-create-client-1042' \
--data '{ "maxLeverage": 50, "requestId": "news-crypto-20260916" }'

The same body as the single-instrument route, applied to every instrument in the category that the server is entitled to. A category with nothing attached answers 404. Requires markets:write.

serverId
required
string format: uuid

UUID of a trading server owned by your organization.

Example
6be9a699-2f28-402e-b64e-93ba6bdafe1b
category
required
string
Allowed values: forex metals crypto indices commodities stocks synthetic

Instrument category.

Idempotency-Key
required
string
>= 1 characters <= 100 characters

Unique key for this logical mutation. Reuse it only when retrying the same operation. Maximum 100 characters.

Example
account-create-client-1042
Media typeapplication/json
object
maxLeverage

The instrument’s leverage ceiling. The effective leverage is the lower of the account’s and this, so it applies to every account, not only unlimited ones. Null removes it.

integer
nullable >= 1
spreadMode
string
Allowed values: fixed floating
spreadPoints

The whole spread when fixed; a markup over the provider’s when floating.

integer
<= 100000
minSpreadPoints

Floating only: a floor under the provider’s spread. Ignored when fixed, because a fixed spread is already exact.

integer
<= 100000
tradingEnabled

Whether the instrument trades. Disabling it does not close open positions.

boolean
requestId
required
string
>= 1 characters <= 100 characters
Example
{
"maxLeverage": 50,
"requestId": "news-crypto-20260916"
}

Terms applied and the market configuration republished.

Media typeapplication/json
object
serverId
required
string
instruments
required
Array<string>
applied
required
object
key
additional properties
any
marketConfigurationRepublished
boolean
Examplegenerated
{
"serverId": "example",
"instruments": [
"example"
],
"applied": {},
"marketConfigurationRepublished": true
}

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

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

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