Delete Account List
DeleteUsersList¶
Description: Deletes multiple user accounts by their login IDs.
Delete policy for each account:
- active market positions block account deletion
- pending orders do not block account deletion
- pending orders and trade history are deleted together with the account
This method is batch-based:
- successful rows are returned in
rows - failed rows are returned in
failures - the method no longer stops on the first failed login
Request Parameters¶
| Name | Type | Required | Description |
|---|---|---|---|
| logins | array | Yes | Array of integer login IDs to delete |
Request Example¶
{
"logins": [102030, 102031, 102032]
}
Response Parameters¶
| Name | Type | Description |
|---|---|---|
| rows | array | Successfully deleted accounts |
| matched | int | Number of requested logins |
| deleted | int | Number of successfully deleted accounts |
| failed | int | Number of failed deletions |
| failures | array | Per-login failure details when partial or full failure happens |
Response Example¶
{
"rows": [
{
"login": 102030,
"deleted": true
}
],
"matched": 3,
"deleted": 1,
"failed": 2,
"failures": [
{
"login": 102031,
"error": "RET_USR_HAS_TRADES",
"message": "Account has open trades"
},
{
"login": 102032,
"error": "RET_USER_NOT_FOUND",
"message": "User not found"
}
]
}
HTTP semantics:
200if all requested accounts were deleted207if deleted partially409if no account was deleted