Skip to navigation

Risk Time Period List

View as Markdown

List your organization’s risk time periods.

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

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Retrieve every risk time period in your organization. A risk time period is a daily window (startTime to stopTime, Central Time) during which the position limits and auto-liquidation rules that reference it apply.

Common Failure Scenarios

  • Risk time periods 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 time periods. 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 time periods.

Related Endpoints

Authentication

AuthorizationBearer

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

Response

RiskTimePeriod
namestring<=64 characters
startTimeobject
stopTimeobject
idlongOptional
organizationIdlongOptional