Update one instrument's terms

PATCH

/api/v1/management/servers/{serverId}/instruments/{symbol}

curl --request PATCH \
  --url https://api.koneth.com/api/v1/management/servers/6be9a699-2f28-402e-b64e-93ba6bdafe1b/instruments/example \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: account-create-client-1042' \
  --data '{ "maxLeverage": 100, "minSpreadPoints": 25, "requestId": "news-btc-20260916" }'

• Production
• Local development

Sets the leverage ceiling, the spread, or whether the instrument trades. Only the fields sent are written; everything else keeps whatever the attachment or a previous override already said, which is what makes a one-field change before a news release safe. Requires markets:write.

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

symbol

required

string

Instrument symbol, for example BTCUSD.

Header Parameters

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

Request Body^required

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": 100,
  "minSpreadPoints": 25,
  "requestId": "news-btc-20260916"
}

Responses

200

Terms applied and the market configuration republished.

Media typeapplication/json

object

serverId

required

string

instruments

required

The instruments the change was applied to.

Array<string>

applied

required

object

key

additional properties

any

marketConfigurationRepublished

boolean

Example^generated

{
  "serverId": "example",
  "instruments": [
    "example"
  ],
  "applied": {},
  "marketConfigurationRepublished": true
}

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

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

Example^generated

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

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