curl --request POST \
--url https://whitebit.com/api/v4/sub-account/api-key/create \
--header 'Content-Type: application/json' \
--header 'X-TXC-APIKEY: <api-key>' \
--header 'X-TXC-PAYLOAD: <api-key>' \
--header 'X-TXC-SIGNATURE: <api-key>' \
--data '
{
"type": 1,
"subAccountId": "8e667b4a-0b71-4988-8af5-9474dbfaeb51",
"title": "Trading Bot Key"
}
'import requests
url = "https://whitebit.com/api/v4/sub-account/api-key/create"
payload = {
"type": 1,
"subAccountId": "8e667b4a-0b71-4988-8af5-9474dbfaeb51",
"title": "Trading Bot Key"
}
headers = {
"X-TXC-APIKEY": "<api-key>",
"X-TXC-PAYLOAD": "<api-key>",
"X-TXC-SIGNATURE": "<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>',
'X-TXC-PAYLOAD': '<api-key>',
'X-TXC-SIGNATURE': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
type: 1,
subAccountId: '8e667b4a-0b71-4988-8af5-9474dbfaeb51',
title: 'Trading Bot Key'
})
};
fetch('https://whitebit.com/api/v4/sub-account/api-key/create', 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/create",
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([
'type' => 1,
'subAccountId' => '8e667b4a-0b71-4988-8af5-9474dbfaeb51',
'title' => 'Trading Bot Key'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-TXC-APIKEY: <api-key>",
"X-TXC-PAYLOAD: <api-key>",
"X-TXC-SIGNATURE: <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/create"
payload := strings.NewReader("{\n \"type\": 1,\n \"subAccountId\": \"8e667b4a-0b71-4988-8af5-9474dbfaeb51\",\n \"title\": \"Trading Bot Key\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-TXC-APIKEY", "<api-key>")
req.Header.Add("X-TXC-PAYLOAD", "<api-key>")
req.Header.Add("X-TXC-SIGNATURE", "<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/create")
.header("X-TXC-APIKEY", "<api-key>")
.header("X-TXC-PAYLOAD", "<api-key>")
.header("X-TXC-SIGNATURE", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": 1,\n \"subAccountId\": \"8e667b4a-0b71-4988-8af5-9474dbfaeb51\",\n \"title\": \"Trading Bot Key\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://whitebit.com/api/v4/sub-account/api-key/create")
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["X-TXC-PAYLOAD"] = '<api-key>'
request["X-TXC-SIGNATURE"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": 1,\n \"subAccountId\": \"8e667b4a-0b71-4988-8af5-9474dbfaeb51\",\n \"title\": \"Trading Bot Key\"\n}"
response = http.request(request)
puts response.read_bodyCreate Sub-Account API Key
The endpoint creates a new API key for a sub-account. Each sub-account supports up to 50 API keys, independent from the main account and from other sub-accounts.
Create the key once List of Sub-Accounts shows the sub-account’s status as active. A sub-account created with email becomes active when the end user opens the WhiteBIT invitation email and sets a password; a sub-account created with shareKyc: true and no email is active at creation. Key creation does not depend on the end user’s KYC.
The 14-day deactivation of unused keys applies to sub-account keys too: an
unused key is disabled, not deleted, and its isEnabled field turns false. The notice email goes to the sub-account,
not to the main account, so read isEnabled with List Sub-Account API Keys
and switch a disabled key back on with Reset Sub-Account API Key.
Every URL group on a new key starts with its URLs set to enable: false, including the deposit, withdrawal,
convert (/api/v4/convert/estimate, /api/v4/convert/confirm), and balance transfer (/api/v4/main-account/transfer)
groups. Enable the URLs the key uses with
Edit Sub-Account API Key before the first call; until then
/api/v4/main-account/withdraw, for example, returns 401 with {"code":4,"message":"This API Key is not authorized to perform this action."}.
Deposit and withdrawal URLs can be enabled only on a type: 2 key.
Crypto deposits additionally require sub-account deposits to be enabled for the account (disabled by
default); to enable sub-account deposits, contact the assigned account manager.
The sub-account also needs its own deposit permission, depositsEnabled; see
Create Sub-Account.
Rate limit: 1000 requests/10 sec.
The API does not cache the response.
curl --request POST \
--url https://whitebit.com/api/v4/sub-account/api-key/create \
--header 'Content-Type: application/json' \
--header 'X-TXC-APIKEY: <api-key>' \
--header 'X-TXC-PAYLOAD: <api-key>' \
--header 'X-TXC-SIGNATURE: <api-key>' \
--data '
{
"type": 1,
"subAccountId": "8e667b4a-0b71-4988-8af5-9474dbfaeb51",
"title": "Trading Bot Key"
}
'import requests
url = "https://whitebit.com/api/v4/sub-account/api-key/create"
payload = {
"type": 1,
"subAccountId": "8e667b4a-0b71-4988-8af5-9474dbfaeb51",
"title": "Trading Bot Key"
}
headers = {
"X-TXC-APIKEY": "<api-key>",
"X-TXC-PAYLOAD": "<api-key>",
"X-TXC-SIGNATURE": "<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>',
'X-TXC-PAYLOAD': '<api-key>',
'X-TXC-SIGNATURE': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
type: 1,
subAccountId: '8e667b4a-0b71-4988-8af5-9474dbfaeb51',
title: 'Trading Bot Key'
})
};
fetch('https://whitebit.com/api/v4/sub-account/api-key/create', 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/create",
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([
'type' => 1,
'subAccountId' => '8e667b4a-0b71-4988-8af5-9474dbfaeb51',
'title' => 'Trading Bot Key'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-TXC-APIKEY: <api-key>",
"X-TXC-PAYLOAD: <api-key>",
"X-TXC-SIGNATURE: <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/create"
payload := strings.NewReader("{\n \"type\": 1,\n \"subAccountId\": \"8e667b4a-0b71-4988-8af5-9474dbfaeb51\",\n \"title\": \"Trading Bot Key\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-TXC-APIKEY", "<api-key>")
req.Header.Add("X-TXC-PAYLOAD", "<api-key>")
req.Header.Add("X-TXC-SIGNATURE", "<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/create")
.header("X-TXC-APIKEY", "<api-key>")
.header("X-TXC-PAYLOAD", "<api-key>")
.header("X-TXC-SIGNATURE", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"type\": 1,\n \"subAccountId\": \"8e667b4a-0b71-4988-8af5-9474dbfaeb51\",\n \"title\": \"Trading Bot Key\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://whitebit.com/api/v4/sub-account/api-key/create")
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["X-TXC-PAYLOAD"] = '<api-key>'
request["X-TXC-SIGNATURE"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"type\": 1,\n \"subAccountId\": \"8e667b4a-0b71-4988-8af5-9474dbfaeb51\",\n \"title\": \"Trading Bot Key\"\n}"
response = http.request(request)
puts response.read_bodyUsed in these guides
- Embedded Trading sub-account integration — managed sub-accounts, fee-share, and partner onboarding.
- Wallet-as-a-Service integration — sub-accounts as end-user wallets: deposits, payouts, and per-user API keys.
- Yield-as-a-Service integration — Crypto Lending run in a sub-account per end user.
Authorizations
Body
Response
API key created successfully
Whether the API key is enabled. Turns false after 14 days without requests; Reset Sub-Account API Key sets it back to true.
true
Permission groups for the key. Each group lists its individual endpoint URLs and whether
each is enabled. On a newly created key every URL defaults to enable: false; enable the
required URLs with Edit Sub-Account API Key
before calling them (for example /api/v4/main-account/withdraw).
Show child attributes
Show child attributes
Was this page helpful?