Get plans

The endpoint retrieves all active plans.

These endpoints are available only for B2B partner services. Fill the institutional services form to get permissions to use these endpoints.

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, interest is received in BTC and equals the USDT interest amount divided by the interest ratio (e.g. 0.000025 BTC per 1 USDT of interest).
• When source currency equals target currency, interest ratio equals 1.

Rate limit: 1000 requests/10 sec.

The API does not cache the response.

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. Fill the form at https://whitebit.com/institutional-services/b2b to request access.

Authorizations

X-TXC-APIKEY · string · header · required

API key authentication using signed requests

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

200

application/json

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"