Skip to main content
GET
/
provider
/
rates
/
{token}
/
{fiat}
Get market rate
curl --request GET \
  --url https://api.paycrest.io/v2/provider/rates/{token}/{fiat} \
  --header 'API-Key: <api-key>'
{
  "status": "success",
  "message": "Operation successful",
  "data": {
    "buy": {
      "marketRate": "<string>",
      "minimumRate": "<string>",
      "maximumRate": "<string>",
      "position": {
        "bestPublicRate": "<string>",
        "yourEffectiveRate": "<string>",
        "deltaVsBest": "<string>"
      }
    },
    "sell": {
      "marketRate": "<string>",
      "minimumRate": "<string>",
      "maximumRate": "<string>",
      "position": {
        "bestPublicRate": "<string>",
        "yourEffectiveRate": "<string>",
        "deltaVsBest": "<string>"
      }
    }
  }
}
Returns buy and sell market rate bands (reference rate plus min/max tolerance) for a token/fiat pair. Use this to validate whether a sender-provided rate on order creation is within allowed bounds.

​
Response shape (data)

FieldTypeDescription
buyobject (optional)Buy-side band — see fields below
sellobject (optional)Sell-side band — see fields below
Each side object:
FieldTypeDescription
marketRatestringReference market rate for this side (fiat per crypto)
minimumRatestringMinimum allowed rate for this side
maximumRatestringMaximum allowed rate for this side
positionobject (optional)Rate benchmark vs. best public peer — see below
Numeric values are returned as strings (decimal). Either side may be omitted depending on corridor configuration.

​
position object

When qualifying public offers exist for this corridor, each side includes a position object so you can see how your effective rate compares to the best public peer:
FieldTypeDescription
bestPublicRatestringBest rate among enabled non-testnet public peers (highest for sell; lowest for buy)
yourEffectiveRatestringYour own effective rate for this corridor and side
deltaVsBeststringyourEffectiveRate − bestPublicRate
Interpreting deltaVsBest:
  • Sell (offramp): a positive delta means your rate is higher than the best peer — you are more competitive.
  • Buy (onramp): a negative delta means your rate is lower than the best peer — you are more competitive.
position is omitted when:
  • No qualifying public offers exist for the corridor, or
  • You have no effective rate configured for this corridor.
The reference fields marketRate, minimumRate, and maximumRate are unchanged — position is purely additive (backward compatible). The benchmark pool uses all enabled, non-testnet networks; it is not filtered by the {token}/{fiat} path parameters’ network.

​
Example

{
  "status": "success",
  "message": "Rate fetched successfully",
  "data": {
    "sell": {
      "marketRate": "1605.00",
      "minimumRate": "1580.00",
      "maximumRate": "1630.00",
      "position": {
        "bestPublicRate": "1608.00",
        "yourEffectiveRate": "1605.00",
        "deltaVsBest": "-3.00"
      }
    },
    "buy": {
      "marketRate": "1598.00",
      "minimumRate": "1575.00",
      "maximumRate": "1620.00",
      "position": {
        "bestPublicRate": "1595.00",
        "yourEffectiveRate": "1598.00",
        "deltaVsBest": "3.00"
      }
    }
  }
}
Example when position is omitted (no public benchmark available): 
{
  "status": "success",
  "message": "Rate fetched successfully",
  "data": {
    "sell": {
      "marketRate": "1605.00",
      "minimumRate": "1580.00",
      "maximumRate": "1630.00"
    }
  }
}
GET /v1/provider/rates/{token}/{fiat} uses the same response shape as this v2 route, including the position field. See Get Market Rate (v1).

Authorizations

​
API-Key
string
header
required

Path Parameters

​
token
string
required
​
fiat
string
required

Response

Market rate

​
status
string
Example:

"success"

​
message
string
Example:

"Operation successful"

​
data
object

Market rate bounds split by side. Either or both of buy and sell may be present depending on corridor configuration.