Skip to main content
GET
Retrieve exchange rates
OAuth2 scopes required: read:invoice. See Scopes for OAuth apps.

Authorizations

Authorization
string
header
required

Basic Authentication using API key and secrets is currently the main authentication mechanism.

Query Parameters

from_currency
string
required

ISO 4217 code of the currency to convert from. Must be a currency Sendcloud bills in, else the request returns 400.

to_currency
string
required

ISO 4217 code of the currency to convert to. Must be a currency Sendcloud bills in, else the request returns 400.

date_after
string<date>

Return rates for this day and later (inclusive). Without it, the list goes back to the first stored rate.

date_before
string<date>

Return rates for this day and earlier (inclusive). Defaults to today (UTC).

cursor
string

The cursor query string is used as the pivot value to filter results. If no value is provided, the first page of results will be returned. To get this value, you must encode the offset, reverse and position into a base64 string.

There are 3 possible parameters to encode:

  • o: Offset
  • r: Reverse
  • p: Position

For example, r=1&p=300 encoded as a base64 string would be cj0xJnA9MzAw. The query string would then be cursor=cj0xJnA9MzAw.

Example:

"cj0xJnA9MzAw"

page_size
integer
default:20

The size of the page to fetch. Defaults to 20, max 100.

Required range: 1 <= x <= 100

Response

OK

Retrieve exchange rates

data
ExchangeRate · object[]
required