Skip to content
Longport WhaleLongport Whale
Assets

Batch Estimate Exchange Amounts

Estimates, in batch, the exchange amount on one side from the source/target currencies and the amount on the other side, and returns the reference exchange rate (including markup). Used to display the reference exchange rate on the currency exchange page and to estimate the other amount in real time while the user enters the source or target amount.

POSThttps://api.lbkrs.com/v1/atm/calc/multi/estimate/exchange/amount

Request body application/json

paramsarray<object>required

List of estimate request items; each item is a currency pair with an amount

Child attributes
from_currencystringrequired

Source currency

to_currencystringrequired

Target currency

from_amountstring

Source amount. Provide either this field or to_amount (pass an empty string for the other one, or omit it). Broker App always passes "1" when querying the reference exchange rate

to_amountstring

Target amount. Provide either this field or from_amount

keystring

Record identifier defined by Broker App. The server returns it unchanged so that each batch result can be matched to its request item

ratestring

Specified exchange rate. Broker App omits it or passes an empty string, and the server calculates with the current reference exchange rate

Responses

HTTP 200The request succeeded. The response body contains the result of the “Batch estimate exchange amounts” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
resultarray<object>

List of estimate results, one for each item in the request params; match them by key

Child attributes
from_currencystring

Source currency

to_currencystring

Target currency

from_amountstring

Source amount (the estimated source amount when estimating from the target amount)

to_amountstring

Target amount (the estimated target amount when estimating from the source amount)

keystring

Record identifier passed in the request, returned unchanged

ratestring

Reference exchange rate (including markup)

no_bp_ratestring

Reference exchange rate without markup

bpstring

Markup value

modestring

Markup method, such as VALUE

Whale Docs