PEpeer
Orderbook V3

GET /v3/orderbook

Changed on

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

Request

  • Base URL
    https://api.peer.xyz
  • URL
    https://api.peer.xyz/v3/orderbook
  • Auth
    none declared

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
takerAddressstring

When present, return this taker's fillable rows and cascade flags. When absent, return the whole fillable book with tuple-level flags.

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

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

  • 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

      deleted the query request parameter mode