Developer Portal
Trader APIsHTTP APISettings

Get KeyGET

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.

View as Markdown
GET
/settings/{key}

Authorization

AuthorizationRequiredBearer <token>

JWT token obtained from the login endpoint

In: header

Path Parameters

keyRequiredstring

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

Maximum length: 256Pattern: "^[A-Za-z0-9_\\-:#]+$"
curl -X GET "http://localhost:8081/api/v1/settings/<string>" \
  -H "Authorization: Bearer <token>"

Setting retrieved successfully

{
  "key": "string",
  "value": "string",
  "updated_at": "2019-08-24T14:15:22Z"
}

Health

Health checks use the non-historical rate limit.

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.