Skip to navigation

Account Lockout Status

View as Markdown

Return lockout status for a list of accounts.

Available to: All authenticated users (own accounts)

Environments: Demo

Rate Limit: No endpoint-specific limit

Check whether one or more of your accounts have an active trading lockout. The response includes the locked/unlocked state and the lockout expiration time for each account.

All requested account IDs appear in statuses, including unknown or non-existent accounts (which return locked: false). The errors array is reserved for internal decode failures.

All responses return HTTP 200.

Error Messages

errorTrigger
"Failed to decode account lockouts."The account’s lockout data couldn’t be read

Related Endpoints

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
accountIdslist of longsRequired

Response

AccountLockoutStatusResponse
statuseslist of objects
errorslist of objects