Skip to main content
POST
/
currencies
/
exchange-rates
/
fetch-live
Preview live or historical exchange rates from the external provider
curl --request POST \
  --url https://api.royalti.io/currencies/exchange-rates/fetch-live \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "baseCurrency": "EUR",
  "quotedCurrencies": [
    "USD",
    "GBP",
    "NGN"
  ],
  "date": "2023-12-25"
}
'
import requests

url = "https://api.royalti.io/currencies/exchange-rates/fetch-live"

payload = {
    "baseCurrency": "EUR",
    "quotedCurrencies": ["USD", "GBP", "NGN"],
    "date": "2023-12-25"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    baseCurrency: 'EUR',
    quotedCurrencies: ['USD', 'GBP', 'NGN'],
    date: '2023-12-25'
  })
};

fetch('https://api.royalti.io/currencies/exchange-rates/fetch-live', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.royalti.io/currencies/exchange-rates/fetch-live",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'baseCurrency' => 'EUR',
    'quotedCurrencies' => [
        'USD',
        'GBP',
        'NGN'
    ],
    'date' => '2023-12-25'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.royalti.io/currencies/exchange-rates/fetch-live"

	payload := strings.NewReader("{\n  \"baseCurrency\": \"EUR\",\n  \"quotedCurrencies\": [\n    \"USD\",\n    \"GBP\",\n    \"NGN\"\n  ],\n  \"date\": \"2023-12-25\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.royalti.io/currencies/exchange-rates/fetch-live")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"baseCurrency\": \"EUR\",\n  \"quotedCurrencies\": [\n    \"USD\",\n    \"GBP\",\n    \"NGN\"\n  ],\n  \"date\": \"2023-12-25\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.royalti.io/currencies/exchange-rates/fetch-live")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"baseCurrency\": \"EUR\",\n  \"quotedCurrencies\": [\n    \"USD\",\n    \"GBP\",\n    \"NGN\"\n  ],\n  \"date\": \"2023-12-25\"\n}"

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "data": [
    {
      "base": "<string>",
      "quoted": "<string>",
      "rate": 123,
      "source": "api",
      "period": "202607",
      "effectiveDate": "<string>",
      "isDefault": false
    }
  ],
  "meta": {
    "provider": "fawazahmed0/exchange-api",
    "fetchedAt": "2023-11-07T05:31:56Z",
    "period": "<string>",
    "date": "<string>",
    "isHistorical": true
  }
}
{
  "status": "error",
  "message": "<string>",
  "code": "<string>",
  "details": {}
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

Description

POST /currencies/exchange-rates/fetch-live Preview-only — fetches rates from the external rates provider (fawazahmed0/exchange-api) and returns them without persisting anything; call POST /currencies/exchange-rates or the /bulk endpoint separately to save. Pass date (YYYY-MM-DD) for a historical lookup, or omit it for the latest rates. Rate-limited to one fetch per tenant per 60 seconds. Authorization: admin or higher (requireAdmin).

Code Examples

const response = await fetch('https://api.royalti.io/currencies/exchange-rates/fetch-live', {
  method: 'POST',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "baseCurrency": "EUR",
    "quotedCurrencies": [
      "USD",
      "GBP",
      "NGN"
    ],
    "date": "2024-01-21"
  })
});

const data = await response.json();
console.log(data);
import requests

response = requests.post(
  'https://api.royalti.io/currencies/exchange-rates/fetch-live',
  headers={
    'Authorization': f'Bearer {token}'
  },
  json={"baseCurrency":"EUR","quotedCurrencies":["USD","GBP","NGN"],"date":"2024-01-21"}
)

data = response.json()
print(data)
curl -X POST https://api.royalti.io/currencies/exchange-rates/fetch-live \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"baseCurrency":"EUR","quotedCurrencies":["USD","GBP","NGN"],"date":"2024-01-21"}'

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Body

application/json
baseCurrency
string
required
Example:

"EUR"

quotedCurrencies
string[]
required
Minimum array length: 1
Example:
["USD", "GBP", "NGN"]
date
string<date>

YYYY-MM-DD. Omit for the latest live rates.

Response

Rates fetched (not persisted)

status
string
Example:

"success"

data
object[]
meta
object