API

Rate

Current and historical exchange rates.

Operations

Every route this entity exposes. Each route links to its own reference on this page.

Method Route SDK operation Returns
GET /rates list List of exchange rate values which meet your query criteria

Examples

One example per SDK, generated from the API model. The argument names are the parameters and fields of this entity, and the values are placeholders. The examples are not compiled or executed.

Golang

Construct client as shown in the Golang setup, then call the operations:

rates, err := client.Rate(nil).List(nil, nil)
if err != nil {
    panic(err)
}
fmt.Println(rates)

Lua

Construct client as shown in the Lua setup, then call the operations:

local rates, err = client:Rate():list()

PHP

Construct client as shown in the PHP setup, then call the operations:

$rates = $client->Rate()->list();

Python

Construct client as shown in the Python setup, then call the operations:

rates = client.Rate().list()

Ruby

Construct client as shown in the Ruby setup, then call the operations:

rates = client.Rate.list()

TypeScript

Construct client as shown in the TypeScript setup, then call the operations:

const rates = await client.Rate().list()

Fields

Field Type Required Description
rate number Yes Exchange rate value.
source string Yes Source (send) currency code.
target string Yes Target (receive) currency code.
time string Yes Timestamp for exchange rate.

list

GET /rates

Operation ID: rateGet.

Authentication: bearer token (UserToken) or bearer token (PersonalToken).

Parameters

Parameter In Type Required Description
source query string No Source (send) currency code.
target query string No Target (receive) currency code.
time query string No Timestamp to get historic exchange rate. Supports only Timestamp (combined date and time). Timezone offset is supported but optional. Supported examples: 2019-03-13T14:53:01 or 2019-03-13T14:53:01+0100.
from query string No Period start date/time to get exchange rate history. Supports Timestamp (combined date and time) or Date (date only). Supported examples: 2019-03-13T14:53:01 or 2019-03-13.
to query string No Period end date/time to get exchange rate history. Supports Timestamp (combined date and time) or Date (date only). Timezone offset is supported but optional. Supported examples: 2019-03-13T14:53:01+0100 or 2019-03-13+0100.
group query enum: day, hour, minute No Interval for history grouping.
X-External-Correlation-Id header string (uuid) No Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Responses

200: List of exchange rate values which meet your query criteria

application/json

Property Type Required Description
[].rate number (double) Yes Exchange rate value.
[].source string Yes Source (send) currency code.
[].target string Yes Target (receive) currency code.
[].time string Yes Timestamp for exchange rate.
400: Invalid request

application/json

429: Rate limit exceeded. Retry after the number of seconds specified in the Retry-After header

application/json

The response is object.