v1

latestOpenAPI 3.0.32026-07-2613529376.3 KB
Crypto Lending - Fixed

Get plans

The endpoint returns investment plan configurations with active status and API access enabled, filtered by the authenticated user's region and plan visibility. Results include public plans and private plans assigned to the account.

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

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.
<Warning> Rate limit: 1000 requests/10 sec. </Warning> <Note> The API does not cache the response. </Note>
post/api/v4/main-account/smart/plans

Request body

tickerstring

Invest plan source currency's ticker. Example: BTC

requeststring required

Request signature

nonceinteger required

Unique request identifier

Example request

{
  "ticker": "USDT",
  "request": "{{request}}",
  "nonce": 1594297865000
}

Response

Successful response

idstring

Invest plan identifier

tickerstring

Source currency ticker

statusinteger

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

percentstring

Interest percent

durationinteger

Investment duration (in minutes)

interestTickerstring

Target currency ticker

interestRatiostring

Target currency to source currency ratio

minInvestmentstring

Minimum investment amount

maxInvestmentstring

Maximum investment amount

maxPossibleInvestmentstring

Maximum investment amount due to current invest plan state

Example response

[
  {
    "id": "1",
    "ticker": "BTC",
    "status": 1,
    "percent": "0.01",
    "duration": 40320,
    "interestTicker": "BTC",
    "interestRatio": "1",
    "minInvestment": "100",
    "maxInvestment": "10000",
    "maxPossibleInvestment": "3000"
  }
]