Please enable JavaScript to view this site.

Error itgendoc001X

xMsg javascript has not been loaded.

Open Exchange Rates API Data Model

Navigation: Schema: OpenExchangeRates > Tables

ConvertAmount: Open Exchange Rates Convert Amount

Contents Previous Home Next More

Catalog: OpenExchangeRates

Schema: OpenExchangeRates

Label: Convert Amount

Documentation:

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.

This is a read-only table function. The Open Exchange Rates API may not support changing the data or the Invantive SQL driver for Open Exchange Rates does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Open Exchange Rates API.

Select Open Exchange Rates API URL: convert/{value}/{from}/{to}

Insert Open Exchange Rates API URL: convert/{value}/{from}/{to}

Update Open Exchange Rates API URL: convert/{value}/{from}/{to}

Delete Open Exchange Rates API URL: convert/{value}/{from}/{to}

Field Selection Method: NotRequired

Table Function Parameters

The following parameters can be used to control the behaviour of the table function ConvertAmount. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name

Data Type

Required

Default Value

Documentation

from

string

 

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

to

string

 

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

value

string

 

The value to be converted.

 

Table Function Columns

The columns of the table function ConvertAmount are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

amount

decimal

Amount

 

from

string

From

 

query

string

Query

 

rate

decimal

Rate

 

response

decimal

Response

 

timestamp

datetime

 

 

to

string

To

 

 

12-12-2020 19:58 Version 20.1.301-BETA+3023