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.

Rate limit: 1000 requests/10 sec.

The API does not cache the response.

POST /api/v4/sub-account/api-key/list

List Sub-Account API Keys

cURL

curl --request POST \
  --url https://whitebit.com/api/v4/sub-account/api-key/list \
  --header 'Content-Type: application/json' \
  --header 'X-TXC-APIKEY: <api-key>' \
  --data '
{
  "subAccountId": "8e667b4a-0b71-4988-8af5-9474dbfaeb51",
  "limit": 30,
  "offset": 0
}
'

import requests

url = "https://whitebit.com/api/v4/sub-account/api-key/list"

payload = {
    "subAccountId": "8e667b4a-0b71-4988-8af5-9474dbfaeb51",
    "limit": 30,
    "offset": 0
}
headers = {
    "X-TXC-APIKEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-TXC-APIKEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({subAccountId: '8e667b4a-0b71-4988-8af5-9474dbfaeb51', limit: 30, offset: 0})
};

fetch('https://whitebit.com/api/v4/sub-account/api-key/list', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://whitebit.com/api/v4/sub-account/api-key/list",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'subAccountId' => '8e667b4a-0b71-4988-8af5-9474dbfaeb51',
    'limit' => 30,
    'offset' => 0
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-TXC-APIKEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://whitebit.com/api/v4/sub-account/api-key/list"

	payload := strings.NewReader("{\n  \"subAccountId\": \"8e667b4a-0b71-4988-8af5-9474dbfaeb51\",\n  \"limit\": 30,\n  \"offset\": 0\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-TXC-APIKEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://whitebit.com/api/v4/sub-account/api-key/list")
  .header("X-TXC-APIKEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"subAccountId\": \"8e667b4a-0b71-4988-8af5-9474dbfaeb51\",\n  \"limit\": 30,\n  \"offset\": 0\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://whitebit.com/api/v4/sub-account/api-key/list")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-TXC-APIKEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"subAccountId\": \"8e667b4a-0b71-4988-8af5-9474dbfaeb51\",\n  \"limit\": 30,\n  \"offset\": 0\n}"

response = http.request(request)
puts response.read_body

200

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

{
  "code": 123,
  "message": "<string>",
  "errors": {}
}

For security reasons, the apiSecret field returns an empty string in the response. The API secret is only displayed once during the initial API key creation.

Authorizations

X-TXC-APIKEY · string · header · required

API key authentication using signed requests

Body

application/json

subAccountId · string

ID of the sub-account to list API keys for

Example:

"8e667b4a-0b71-4988-8af5-9474dbfaeb51"

limit · integer · default: 30

Required range: 1 <= x <= 100

Example:

30

offset · integer · default: 0

Required range: 0 <= x <= 10000

Example:

0

Response

200

application/json

Successful response

limit · integer

offset · integer

data · object[]

Show child attributes