OpenSea · Schema

SweepCollectionRequest

Request to sweep buy items from a collection

NFTMarketplaceWeb3BlockchainTradingDigital Assets

Properties

Name Type Description
collection_slug string The slug of the collection to sweep
payment object The token to pay with
max_items integer Maximum number of items to buy (1-50)
max_price_per_item string Maximum price per item in the payment token's units
buyer string Address of the buyer
recipient string Optional recipient address for the purchased items
View JSON Schema on GitHub

JSON Schema

SweepCollectionRequest.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://opensea.io/schemas/SweepCollectionRequest",
  "title": "SweepCollectionRequest",
  "type": "object",
  "description": "Request to sweep buy items from a collection",
  "properties": {
    "collection_slug": {
      "type": "string",
      "description": "The slug of the collection to sweep",
      "example": "pudgypenguins"
    },
    "payment": {
      "$ref": "#/components/schemas/CrossChainPaymentToken",
      "description": "The token to pay with"
    },
    "max_items": {
      "type": "integer",
      "format": "int32",
      "description": "Maximum number of items to buy (1-50)",
      "example": 5
    },
    "max_price_per_item": {
      "type": "string",
      "description": "Maximum price per item in the payment token's units",
      "example": 10
    },
    "buyer": {
      "type": "string",
      "description": "Address of the buyer",
      "example": "0x..."
    },
    "recipient": {
      "type": "string",
      "description": "Optional recipient address for the purchased items"
    }
  },
  "required": [
    "buyer",
    "collection_slug",
    "max_items",
    "max_price_per_item",
    "payment"
  ]
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/SweepCollectionRequest"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.