Skip to main content
POST
/
api
/
v4
/
main-account
/
smart
/
plans
Get plans
curl --request POST \
  --url https://whitebit.com/api/v4/main-account/smart/plans \
  --header 'Content-Type: application/json' \
  --header 'X-TXC-APIKEY: <api-key>' \
  --header 'X-TXC-PAYLOAD: <api-key>' \
  --header 'X-TXC-SIGNATURE: <api-key>' \
  --data '
{
  "ticker": "USDT",
  "request": "{{request}}",
  "nonce": "{{nonce}}"
}
'
[
  {
    "id": "8e667b4a-0b71-4988-8af5-9474dbfaeb51",
    "ticker": "USDT",
    "status": 1,
    "percent": "10",
    "duration": 14400,
    "interestTicker": "USDT",
    "interestRatio": "1",
    "minInvestment": "100",
    "maxInvestment": "10000",
    "maxPossibleInvestment": "3000"
  }
]
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
string
required

Unique request identifier

Example:

"{{nonce}}"

​
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"