Risk Time Period Item
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 theidis for a risk time period you can’t access. Both returnHTTP 404with an empty body, notHTTP 401. - The
idparameter 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 401with"Access is denied".
Error Messages
Related Endpoints
- Use
riskTimePeriodItemsto resolve several IDs in one call. - Use
riskTimePeriodListto retrieve every risk time period in your organization.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Query parameters
id
Response
RiskTimePeriod
name
startTime
stopTime
id
organizationId