Guides

Calculate approximate rate for operations with exchange [Private]

Find out the approximate exchange rate for a future operation.

Suggest Edits
Method name:/v2/rate/calculate
Request type:POST

📘

To call private endpoints, you need to get a JWT token or an API key for authentication.

Here you can learn in detail how to successfully authenticate.

This endpoint functions in the same way as the Freeze rate for operations, but it can only be used for approximate calculations that account for all markups (for example, to display to an unauthorized user). The endpoint can’t be used as a replacement for the Freeze rate, as it does not generate the corresponding records in the database that can later be used to create exchange operations.#

Data dictionary

NameTypeParameter typeRequiredRangeDescription
sourceAssetstringBODYYES-Source or base Asset code.
targetAssetstringBODYYES-Target or quote Asset code.
sourceAmountintBODYNO-Amount for sourceAsset.
targetAmountintBODYNO-Amount for targetAsset.
operationTypestringBODYYESDepositWithExchange, WithdrawWithExchange, CryptoExchange, BuyToSendCryptoThe type of operation for which you are requesting a pre-request.
depositPaymentCodestringBODYNO-Deposit payment code (only for DepostWithExchange and BuyToSendCrypto operations). You can get it via a pre-request.
withdrawPaymentCodestringBODYNO-Withdrawal payment code (only for WithdrawWithExchange and BuyToSendCrypto operations). You can get it via a pre-request.
withInternalFiatbooleanBODYNOtrue, falseShow if operation processing with merchant fiat funds (only for DepositWithExchange, WithdrawWithExchange, BuyToSendCrypto).

Exemplary request

const url = BASE_URL;
const path = "/v2/rate/calculate";

const body = {
    operationType: "DepositWithExchange",
    withInternalFiat: false,
    sourceAsset: "EUR",
    targetAsset: "USDT",
    sourceAmount: "50",
    depositPaymentCode: "payment_card_eur_hpp_europe"
  };

const options = {
  method: "POST",
  headers: {
    accept: "application/json",
    "Content-Type": "application/json",
    "Authorization": `Bearer ${data.accessToken}` // data.accessToken - generated a JWT token via /v2/auth/login.
  },
  body: JSON.stringify(body),
};

fetch(url + path, options)
  .then((response) => response.json())
  .then((showResponse) => console.log(showResponse.data));

import requests

url = BASE_URL
path = "/v2/rate/calculate"
headers = {
    "accept": "application/json",
    "Content-Type": "application/json",
    "Authorization": "Bearer " + data.accessToken # data.accessToken - generated a JWT token via /v2/auth/login.
}
body = {
  "operationType": "DepositWithExchange",
  "withInternalFiat": False,
  "sourceAsset": "EUR",
  "targetAsset": "USDT",
  "sourceAmount": "50",
  "depositPaymentCode": "payment_card_eur_hpp_europe"
}

request = requests.post(url + path, headers=headers, json=body)
print(request.json())

How to call private endpoints here

Swagger here

Response

{
  "data": {
    "feeDeposit": "0.5",                // Deposit fee.
    "feeDepositAsset": "EUR",           // Asset of the deposit fee.
    "feeTrade": "0",                    // Trade fee.
    "feeTradeAsset": "USDT",            // Asset of the rade fee.
    "feeWithdraw": "0",                 // Withdrawal fee.
    "feeWithdrawAsset": "USDT",         // Asset of the withdrawal fee.
    "rate": "0.899986",                 // Exchange rate.
    "sourceAmount": "50",               // Amount spent.
    "sourceAsset": "EUR",               // Asset of the amount spent.
    "targetAmount": "44.549307",        // Amount received.
    "targetAsset": "USDT",              // Asset of the amount received.
    "totalFeeSourceAsset": "0.5",       // Total fees of the base (Source) asset.
    "totalFeeTargetAsset": "0.449993"   // Total fees of the quote (Target) asset.
  }
}

Updated about 2 months ago