Sign in
Orderbook V3

Fetch the public-only V3 denormalized orderbook for a fiat currency.

get/v3/orderbook

Query parameters

currencystring required

Fiat currency code

Example:USD
paymentPlatformstring

Optional payment platform filter

Example:venmo
sortBy'price' | 'available' | 'limits' | 'apr'

Sort field

Example:price
sortDirection'asc' | 'desc'

Optional sort direction. Defaults to asc for price and desc for available/limits/apr.

Example:asc
chainIdinteger

Destination chain ID

Example:8453
tokenstring

Destination token address

Example:0x833589fcd6edb6e08f4c7c32d4f71b54bda02913
mode'all' | 'eligible' | 'eligible_with_chargeback'

all returns every row curator could fill — rows gated by a foreign intent gating service are excluded from every mode, including this one; eligible returns rows the taker can reach via the direct route: whitelist-off deposits without dispute, plus whitelist-enabled deposits the taker is whitelisted for; eligible_with_chargeback also returns dispute-route rows (whitelist-off + dispute-on deposits are dispute-only, never public)

Example:all
takerAddressstring

Taker whose whitelist eligibility is evaluated in the eligible and eligible_with_chargeback modes. Ignored when mode=all, which does not apply the whitelist leg. Omitting it removes the taker-specific whitelist route. With a registered canonical IntentLifecycleHookV1, eligible and eligible_with_chargeback then return only open rows; protected rows require complete taker eligibility. With a registered predecessor WhitelistLifecycleHook, whitelist-disabled rows remain reachable. A verified no-hook state exposes only both-off rows; an unrecognized or unavailable lifecycle returns no rows.

Example:0x1111111111111111111111111111111111111111
limitinteger

Maximum number of orderbook rows to return

Example:200
offsetinteger nullable

Number of matching rows to skip before returning entries

amountstring

Optional requested USDC amount used to filter rows by min, max, and available limits

Example:100
showSmallOrdersboolean

When true, include rows whose available notional value is below the dust threshold

hideExtremeSpreadboolean

When true, hide rows whose absolute spread exceeds the extreme-spread threshold

Example:true
sellerAutomatedRelease'include' | 'exclude' | 'only'

Seller automated release filter. include returns all rows, exclude omits SAR rows, only returns SAR rows.

Example:exclude

Headers

x-pp-keystring

Optional env-configured Peer Pay service key

Optional env-configured Peer Pay service key

Response

Success

successboolean required
messagestring required
statusCodenumber required
errorCodestring

Example response

{
  "responseObject": {
    "generatedAt": "2026-04-09T00:00:00.000Z",
    "entries": [
      {
        "feeBps": 95,
        "sellerAutomatedReleaseEnabled": true,
        "allowedGroupIds": []
      }
    ]
  }
}

Changes