Skip to main content
GET
/
partners
/
rates
Get Exchange Rate
curl --request GET \
  --url https://dev-api.hyperail.io/api/v1/partners/rates \
  --header 'Authorization: Bearer <token>'
{
  "from": "usdt",
  "to": "NGN",
  "rate": 0.0006,
  "source": "CONSENSUS",
  "timestamp": "2026-04-01T14:13:28.306083501Z",
  "chain": "ethereum",
  "ageSeconds": 0,
  "cached": false
}

Authorizations

​
Authorization
string
header
required

API key authentication using Bearer token

Query Parameters

​
from
string
required

The source currency code (e.g., NGN).

Example:

"NGN"

​
to
string
required

The target currency code (e.g., GHS).

Example:

"GHS"

​
chain
string

The blockchain network (optional - only for crypto currencies)

Example:

"ETHEREUM"

Response

Successfully retrieved the exchange rate

Represents the current exchange rate and consensus metadata between two currencies.

​
from
string
required

The source currency code.

Example:

"usdt"

​
to
string
required

The target currency code.

Example:

"NGN"

​
rate
number<double>
required

The conversion rate/multiplier.

Example:

0.0006

​
source
string
required

The mechanism used to determine the rate (e.g., CONSENSUS, ADMIN_OVERRIDE, MARKET_MAKER, SPOT).

Example:

"CONSENSUS"

​
timestamp
string<date-time>
required

The UTC timestamp of the rate generation.

Example:

"2026-04-01T14:13:28.306083501Z"

​
chain
string

The blockchain network or settlement chain.

Example:

"ethereum"

​
ageSeconds
integer

The age of the rate in seconds.

Example:

0

​
cached
boolean

Indicates if the rate was retrieved from a cache.

Example:

false