Skip to navigation

Risk Category List

View as Markdown

List your organization’s risk categories.

Available to: Organization administrators (own organization’s risk categories)

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Retrieve every risk category in your organization. A risk category holds the position limits and risk parameters that apply to the accounts assigned to it. Use the id values to call switchRiskCategory or setDemoHalt.

Common Failure Scenarios

  • Risk categories you can’t access are left out of the response array. The call doesn’t return an error for them.
  • The caller’s user type, or the API key’s permissions, can’t read risk categories. This returns HTTP 401 with "Access is denied".

Error Messages

MessageResponseTrigger
"Access is denied"401The caller’s user type, or the API key’s permissions, can’t read risk categories.

Related Endpoints

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

RiskCategory
namestring<=64 characters
idlongOptional
riskCreditdoubleOptional
organizationIdlongOptional