PEpeer
Quotes V3

POST /v3/quote/best-by-platform

Changed on

Best quote per payment platform for an exact fiat amount.

Request

  • Base URL
    https://api.peer.xyz
  • URL
    https://api.peer.xyz/v3/quote/best-by-platform
  • Auth
    none declared

Headers

x-pp-keystring

Optional env-configured Peer Pay service key

Request body

fiatCurrencystring required

Fiat currency code (e.g., 'USD', 'EUR')

exactFiatAmountstring required

Exact fiat amount in token units (e.g., '100000000' = $100)

userstring required

User's Ethereum address (excluded from quotes)

recipientstring required

Recipient Ethereum address

destinationChainIdinteger required

Destination chain ID

destinationTokenstring required

Token address (e.g., USDC on Base)

referrerstring

Optional referrer address

escrowAddressesstring[] required

List of escrow contract addresses to search

minDepositSuccessRateBpsinteger

Minimum maker success rate in basis points (0-10000)

supportBusinessAccountsboolean

Include business accounts in quotes (default: false)

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

Response

Success

successboolean required
messagestring required
statusCodenumber required
errorCodestring

Changes

  • 98e1547fef3bRevision changes
    • 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

    • warning

      removed the request property