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": "<string>",
  "limit": 30,
  "offset": 0
}
'
{
  "offset": 123,
  "limit": 123,
  "data": [
    {
      "id": "<string>",
      "alias": "<string>",
      "userId": "<string>",
      "email": "<string>",
      "status": "<string>",
      "color": "<string>",
      "kyc": {
        "shareKyc": true,
        "kycStatus": "<string>"
      },
      "permissions": {
        "spotEnabled": true,
        "collateralEnabled": true
      }
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://whitebit-preview.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-TXC-APIKEY
string
header
required

API key authentication using signed requests

Body

application/json
​
search
string

Search term

​
limit
integer
default:30
Required range: 1 <= x <= 100
​
offset
integer
default:0
Required range: 0 <= x <= 10000

Response

Successful response

​
offset
integer
​
limit
integer
​
data
object[]