Developer Portal
Trader APIsHTTP APISettings

Update KeyPUT

Stores a string value under the given key for the authenticated profile (upsert). This is a general-purpose key-value store used for per-profile data such as watchlists, UI preferences, notes, or account-level configuration. Callers may store any text; JSON-encoded objects are common but not required. Max body size: 128 KB. Keys must match ^[A-Za-z0-9_\-:#]+$ (max 256 chars).

View as Markdown
PUT
/settings/{key}

Authorization

AuthorizationRequiredBearer <token>

JWT token obtained from the login endpoint

In: header

Request Body

application/jsonRequired
valueRequiredstring

The string value to store. Any text is accepted; callers typically JSON-encode structured data. Max ~128 KB (enforced by body size limit).

Path Parameters

keyRequiredstring

Setting key (pattern: ^[A-Za-z0-9_-:#]+$, max 256 chars)

Maximum length: 256Pattern: "^[A-Za-z0-9_\\-:#]+$"
curl -X PUT "http://localhost:8081/api/v1/settings/<string>" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "value": "string"
  }'

Setting updated successfully (no body)

Settings

Returns the stored values for one or more keys belonging to the authenticated profile. Pass a single key or a comma-separated list of keys via the `keys` query parameter. Keys that have never been written are included in the response with a null value. Returns 400 if any key fails the format validation (^[A-Za-z0-9_\-:#]+$, max 256 chars each). Max 50 keys per request.

Amend Order

Amends an existing trading order for the authenticated user's account, including support for multi-level take profit and stop loss