/convert

Convert any money value from one currency to another at the latest API rates using the /convert API endpoint.

This feature works differently to other endpoints in our API, using a REST-based approach and an alternate response format.

Currency conversion requests are currently available for clients on the Unlimited plan.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Unlimited Plan Feature

Currency conversion requests are currently available for clients on the Unlimited plan.

Your query is returned in the request object parameter for validation.

The rate and timestamp used to perform the conversion are given in the meta object parameter.

The converted value is given in the response parameter.

Important note about Currency Conversion queries:

The /convert API is offered to save time in integration, but does not imply any difference in accuracy, validity or fitness for purpose from the data that can be obtained with any other API request.

Returned values are used at your own risk, so we strongly recommend validating any returned values before employing them in any system or interface where transactions are processed.

Errors

Please see API Error Messages for a list of possible errors not specified above.

Path Params
int32
required
Defaults to null

The value to be converted

string
required
Defaults to Required

The base ('from') currency (3-letter code)

string
required
Defaults to Required

The target ('to') currency (3-letter code)

Query Params
string
Defaults to Required

Your unique App ID (required)

boolean
Defaults to false

Human-readable response for debugging

Responses

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json