Skip to navigation

Risk Time Period Item

View as Markdown

Retrieve a risk time period by ID.

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

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Resolve a single riskTimePeriodId to its risk time period record. 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

  • No risk time period matches the id, or the id is for a risk time period you can’t access. Both return HTTP 404 with an empty body, not HTTP 401.
  • The id parameter is missing or repeated (HTTP 404), or isn’t a whole number (HTTP 400).
  • 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.
(no message text)404No risk time period matches the id, or the caller can’t see that risk time period. A risk time period the caller can’t see returns 404, not 401.
(no message text)404The id parameter is missing or repeated.
"Bad Request"400id isn’t a whole number.

Related Endpoints

Authentication

AuthorizationBearer

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

Query parameters

idlongRequired

Response

RiskTimePeriod
namestring<=64 characters
startTimeobject
stopTimeobject
idlongOptional
organizationIdlongOptional