Get plans

This endpoint retrieves all active plans.

Note: When target currency is different from source currency, interest amount in target currency will be calculated using interestRatio value.

Examples:

• When source currency = USDT, target currency = BTC and interest ratio = 40000, it means that you will receive interest in BTC that equals interest amount in USDT divided by interest ratio (in this case 0.000025 BTC per each 1 USDT of interest amount).
• When source currency equals target currency, interest ratio equals 1.

Rate limit: 1000 requests/10 sec.

POST /api/v4/main-account/smart/plans

Get plans

cURL

curl --request POST \
  --url https://whitebit.com/api/v4/main-account/smart/plans \
  --header 'Content-Type: application/json' \
  --header 'X-TXC-APIKEY: <api-key>' \
  --data '
{
  "ticker": "USDT",
  "request": "{{request}}",
  "nonce": "{{nonce}}"
}
'

200

[
  {
    "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, you need to fill the form https://whitebit.com/institutional-services/b2b in order to get permissions to use these endpoints.

Authorizations

X-TXC-APIKEY · string · header · required

API key authentication using signed requests

Body

application/json

request · string · required

Request signature

nonce · string · required

Unique request identifier

ticker · string

Invest plan source currency's ticker.

Response

200

application/json

Successful response

id · string

Invest plan identifier

ticker · string

Source currency ticker

status · integer

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

percent · string

Interest percent

duration · integer

Investment duration (in minutes)

interestTicker · string

Target currency ticker

interestRatio · string

Target currency to source currency ratio

minInvestment · string

maxInvestment · string

maxPossibleInvestment · string