Skip to main content
Create Sub-Account API Key

Authorizations

X-TXC-APIKEY
string
header
required

The public WhiteBIT API key.

X-TXC-PAYLOAD
string
header
required

Base64-encoded JSON request body.

X-TXC-SIGNATURE
string
header
required

HMAC-SHA512 signature of the payload, hex-encoded. Computed as hex(HMAC-SHA512(payload, api_secret)).

Body

application/json
type
enum<integer>
required

Type of API key (1 - info and trading; 2 - info, trading, deposits, withdraws)

Available options:
1,
2
Example:

1

subAccountId
string
required

ID of the sub-account to create the API key for

Example:

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

title
string

Custom title/name for the API key

Example:

"Trading Bot Key"

Response

API key created successfully

subAccountId
string

Sub-account identifier

Example:

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

id
string

API key identifier

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

title
string

API key title/name

Example:

"Trading Bot Key"

isEnabled
boolean

Whether the API key is enabled

Example:

true

apiKey
string

API key

Example:

"pub-key-abc123"

apiSecret
string

API secret

Example:

"secret-xyz789"

type
integer

API key type (1 - info and trading, 2 - info, trading, deposit and withdraw)

Example:

1

lastActivity
integer

Last activity timestamp

Example:

1641081600

restrictAccess
boolean

Whether access is restricted

Example:

false

accessEndpoints
object[]

List of allowed endpoints