About this endpoint
What it does
Converts an amount from one of 12 major currencies to another at the latest daily reference rate. Returns the converted value, the rate, the date of the rate and notes on how fresh it is.
Request Body
| Parameter | Type | Description |
|---|---|---|
| amount | Number | Required. The amount to convert. Range: 0.000001 to 1000000000000 (1e12). |
| from | ENUM | Required. Currency to convert from, as an uppercase code. Allowed values: USD, EUR, GBP, JPY, CAD, AUD, CHF, CNY, INR, BRL, KRW, MXN. |
| to | ENUM | Required. Currency to convert to. Same allowed values as from. |
Only these three fields are accepted. Any other field, such as date, returns a 400 error.
Response
Returns a JSON object with a result object holding the conversion and details about the rate it used.
| Parameter | Type | Description |
|---|---|---|
| result.amount | Number | The amount you sent. |
| result.from | String | The currency you converted from. |
| result.to | String | The currency you converted to. |
| result.converted | Number | The converted amount. Rounded to 2 decimals, or to 6 decimals when below 0.01. |
| result.rate | Number | The rate used: 1 unit of from in to. 1 when from and to are the same. |
| result.ratesAsOf | String | Date of the rate set used, in YYYY-MM-DD format. |
| result.rateSource | String | Where the rates come from, for example Publicly available reference rates. |
| result.rateSourceId | String | Short ID of the rate source. reference-daily for the daily feed, built-in-snapshot when backup rates are used. |
| result.sourceId | String | Same value as rateSourceId. |
| result.live | Boolean | Always false: the rates are daily reference rates, not live market rates. |
| result.stale | Boolean | true when backup rates were used because the daily feed was unavailable. |
| result.fallback | Boolean | Only present when backup rates were used. Then true. |
| result.warning | String | Only present when backup rates were used. Says which rate date was used and why. |
| result.disclaimer | String | Use notice: Indicative rates, not for real transactions. |
| result.note | String | Explains that the rates are published once per working day and differ from bank or card rates. |
Notes
- Rates are published once per working day, so
ratesAsOfis usually the previous working day. - Error responses:
400withcode: amount_out_of_rangewhenamountis outside the range;400witherror: Invalid inputand adetails.fieldErrorsobject when a field is missing, has the wrong type or uses a code outside the list (lowercase codes fail too);400when an unknown field is sent.



