Skip to main content
Get plans
These endpoints are available only for B2B partner services. Fill the form at https://whitebit.com/institutional-services/b2b to request access.
The id field in each returned plan object is the planId value required by the investment creation endpoint (POST /api/v4/main-account/smart/investment). Only plans returned by this endpoint can be used to create new investments — plans with inactive status or disabled API access are excluded automatically.

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
request
string
required

Request signature

Example:

"{{request}}"

nonce
integer
required

Unique request identifier

Example:

1594297865000

ticker
string

Invest plan source currency's ticker. Example: BTC

Example:

"USDT"

Response

Successful response

id
string

Invest plan identifier

Example:

"1"

ticker
string

Source currency ticker

Example:

"BTC"

status
integer

Status (1 - active, 2 - no coins left, 3 - inactive, 4 - pause)

Example:

1

percent
string

Interest percent

Example:

"0.01"

duration
integer

Investment duration (in minutes)

Example:

40320

interestTicker
string

Target currency ticker

Example:

"BTC"

interestRatio
string

Target currency to source currency ratio

Example:

"1"

minInvestment
string

Minimum investment amount

Example:

"100"

maxInvestment
string

Maximum investment amount

Example:

"10000"

maxPossibleInvestment
string

Maximum investment amount due to current invest plan state

Example:

"3000"