v1

latestOpenAPI 3.1.02026-07-24130315342.2 KB

Listing Endpoints

Sweep buy items from a collection

Buy up to N items from a collection using any payment token, including cross-chain. If a requested item becomes unavailable, the system can automatically substitute it with the next cheapest listing from the same collection (enabled by default). Returns an ordered list of transactions to execute.

post/api/v2/listings/sweep

Request body

collection_slugstring required

The slug of the collection to sweep

max_itemsinteger required

Maximum number of items to buy (1-50)

max_price_per_itemstring required

Maximum price per item in the payment token's units

buyerstring required

Address of the buyer

recipientstring

Optional recipient address for the purchased items

Example request

{
  "collection_slug": "pudgypenguins",
  "payment": {
    "chain": "base",
    "token_address": "0x0000000000000000000000000000000000000000"
  },
  "max_items": 5,
  "buyer": "0x..."
}

Response

Sweep fulfillment data retrieved successfully