PEpeer
Quotes V3

POST /v3/quote/exact-token

Changed on

Quote minimum fiat input for an exact token output amount.

Request

  • Base URL
    https://api.peer.xyz
  • URL
    https://api.peer.xyz/v3/quote/exact-token
  • Auth
    none declared

Headers

x-pp-keystring

Optional env-configured Peer Pay service key

Request body

paymentPlatformsstring[] required

Payment platforms

fiatCurrencystring required

Fiat currency

userstring required

User submitting transactions

recipientstring required

Final recipient address

destinationChainIdinteger required

Destination chain ID

destinationTokenstring required

Destination token address

referrerstring

Referrer

useMultihopboolean

Use multihop from a base asset

escrowAddressesstring[] required

List of escrow contract addresses to search (e.g., ['0xabc...', '0xdef...']).

supportBusinessAccountsboolean

Whether quotes may include business accounts (default: false)

minDepositSuccessRateBpsinteger

Minimum historical deposit success rate in basis points (0–10000). Defaults to 0 when omitted

amountToleranceBpsstring

Maximum shortfall in basis points of the requested amount (0-9999), rounded down to whole base units. Defaults to zero; returned amounts always reflect executable liquidity.

maxTakerConversionRatestring

Maximum acceptable taker conversion rate, scaled by 1e18. Candidates quoting above this are excluded before pool selection in exact, nearby, and best-by-platform searches. Omit for no ceiling.

quotePreference'EXCLUSIVE_SAR' | 'PREFER_SAR' | 'PREFER_BUYER_TEE' | 'EXCLUSIVE_BUYER_TEE'

Preferred quote pool and fallback behavior

excludedPayToValuesstring[]

Payee values to exclude from quote selection

exactTokenAmountstring required

Exact amount of tokens user wants to receive

includeNearbyQuotesboolean

Include nearby quote suggestions when no exact match

nearbySearchRangenumber

Max percentage deviation to search (1-100%). Unlimited if omitted

nearbyQuotesCountnumber

Max quotes per direction (default: 3, max: 10)

Response

Success

successboolean required
messagestring required
statusCodenumber required
errorCodestring

Changes

  • 98e1547fef3bRevision changes
    • breaking

      the response property ///// became optional for the status

    • breaking

      the response property ///// became optional for the status

    • breaking

      the response property /// became optional for the status

  • 3c91fa7c3c3fRevision changes
    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property ///// from the response with the status

    • breaking

      removed the required property ///// from the response with the status

    • breaking

      removed the required property /// from the response with the status

    • warning

      removed the request property