Skip to main content
POST
/
api
/
v4
/
sub-account
/
list
List of Sub-Accounts
curl --request POST \
  --url https://whitebit.com/api/v4/sub-account/list \
  --header 'Content-Type: application/json' \
  --header 'X-TXC-APIKEY: <api-key>' \
  --data '
{
  "search": "trading",
  "limit": 30,
  "offset": 0
}
'
{
  "offset": 123,
  "limit": 123,
  "data": [
    {
      "id": "8e667b4a-0b71-4988-8af5-9474dbfaeb51",
      "alias": "trading_bot",
      "userId": "u-12345",
      "email": "s***@example.com",
      "status": "active",
      "color": "#FF5733",
      "kyc": {
        "shareKyc": false,
        "kycStatus": "verified"
      },
      "permissions": {
        "spotEnabled": true,
        "collateralEnabled": false
      }
    }
  ]
}

Authorizations

​
X-TXC-APIKEY
string
header
required

API key authentication using signed requests

Body

application/json
​
search
string

Search term

Example:

"trading"

​
limit
integer
default:30
Required range: 1 <= x <= 100
Example:

30

​
offset
integer
default:0
Required range: 0 <= x <= 10000
Example:

0

Response

Successful response

​
offset
integer
​
limit
integer
​
data
object[]