v1

latestOpenAPI 3.0.32026-07-2613529376.3 KB
Sub-Account

List of Sub-Accounts

The endpoint returns list of current user sub-accounts.

<Warning> Rate limit: 1000 requests/10 sec. </Warning> <Note> The API does not cache the response. </Note>
post/api/v4/sub-account/list

Request body

searchstring

Search term

limitinteger
offsetinteger

Example request

{
  "search": "trading",
  "limit": 30
}

Response

Successful response

offsetinteger
limitinteger

Example response

{
  "data": [
    {
      "id": "8e667b4a-0b71-4988-8af5-9474dbfaeb51",
      "alias": "trading_bot",
      "userId": "u-12345",
      "email": "s***@example.com",
      "status": "active",
      "color": "#FF5733",
      "kyc": {
        "kycStatus": "verified"
      },
      "permissions": {
        "spotEnabled": true
      }
    }
  ]
}