v1

latestOpenAPI 3.0.32026-07-2613529376.3 KB
Sub-Account API Keys

List Sub-Account API Keys

The endpoint retrieves a list of API keys for a sub-account. Note: For security reasons, the apiSecret field returns an empty string.

<Warning> Rate limit: 1000 requests/10 sec. </Warning> <Note> The API does not cache the response. </Note> <Note> Results are sorted by api-key id descending (newest key first). The response is a plain array with no `total`, `has_more`, or cursor — a returned count below `limit` marks the last page (an empty array means no further records). </Note>
post/api/v4/sub-account/api-key/list

Request body

subAccountIdstring

ID of the sub-account to list API keys for

limitinteger
offsetinteger

Example request

{
  "subAccountId": "8e667b4a-0b71-4988-8af5-9474dbfaeb51",
  "limit": 100
}

Response

Successful response

limitinteger
offsetinteger

Example response

{
  "data": [
    {
      "subAccountId": "8e667b4a-0b71-4988-8af5-9474dbfaeb51",
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "title": "Trading Bot Key",
      "isEnabled": true,
      "apiKey": "pub-key-abc123",
      "type": "1",
      "lastActivity": 1641081600,
      "accessEndpoints": [
        {
          "name": "/api/v4/main-account/balance",
          "title": "Get Balance"
        }
      ]
    }
  ]
}