Developer Portal
Trader APIsHTTP APISettings

SettingsGET

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.

View as Markdown
GET
/settings

Authorization

AuthorizationRequiredBearer <token>

JWT token obtained from the login endpoint

In: header

Query Parameters

keysRequiredstring

Comma-separated setting keys (pattern: ^[A-Za-z0-9_-:#]+$, max 256 chars each, max 50 keys)

curl -X GET "http://localhost:8081/api/v1/settings?keys=watchlist%3Adefault%2Cui%3Atheme" \
  -H "Authorization: Bearer <token>"

Settings retrieved successfully

{
  "settings": {
    "watchlist:default": {
      "key": "watchlist:default",
      "value": "[\"EURUSD\",\"BTCUSD\"]",
      "updated_at": "2025-01-01T12:00:00Z"
    },
    "ui:theme": {
      "key": "ui:theme",
      "value": null,
      "updated_at": null
    }
  }
}

Get Key

Returns the string value stored for the authenticated profile under the given key. 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 string; JSON-encoded objects are common but not required. Returns 400 if the key format is invalid, or 404 if the key has never been written.

Update Key

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).