/opensea/items/search

POST /api/opensea/items/search

Price: 10 credits

Search and list the NFTs in an OpenSea collection, with status, trait and sort filters

How to use it

Search and list the NFTs inside an OpenSea collection by its slug (e.g. 'boredapeyachtclub'). Filter by listing status (all, listed or not listed) and by traits (a mapping of trait type to accepted values), and sort by price (low to high / high to low) or rarity (most / least rare). Each item returns its chain, contract address and token id, name and image, rarity rank, last sale, best listing and best offer (in native, token and USD), owner, parent collection and traits.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• collection_slug string required — Collection slug to search within (its human-readable alias from the collection URL) (examples: "boredapeyachtclub", "pudgypenguins"; minLength: 1)
• count integer required — Number of items to return (min: 1)
• status string — Listing status filter (default: "all"; one of: "all", "listed", "not_listed")
• sort string — Sort order (default: "price_low_to_high"; one of: "price_low_to_high", "price_high_to_low", "most_rare", "least_rare")
• attributes object nullable — Trait filter mapping a trait type to the accepted values (e.g. {"Background": ["Army Green", "Blue"]}) (examples: {"Background":["Army Green"]})
  • * array

Response

• @type string (default: "OpenseaItem")
• chain string nullable
• contract_address string required
• token_id string required
• name string nullable
• image string nullable
• animation_url string nullable
• description string nullable
• standard string nullable
• is_fungible boolean (default: false)
• total_supply integer nullable
• rarity_rank integer nullable
• rarity_category string nullable
• image_aspect_ratio number nullable
• background_color string nullable
• token_uri string nullable
• metadata_storage string nullable
• owner string nullable
• last_sale object nullable
  • @type string (default: "OpenseaPrice")
  • usd number nullable
  • amount number nullable
  • symbol string nullable
  • native number nullable
• best_listing object nullable
  • @type string (default: "OpenseaListing")
  • price object nullable
    • @type string (default: "OpenseaPrice")
    • usd number nullable
    • amount number nullable
    • symbol string nullable
    • native number nullable
  • marketplace string nullable
  • maker string nullable
  • quantity_remaining integer nullable
  • start_time string nullable
  • end_time string nullable
• best_offer object nullable
  • @type string (default: "OpenseaPrice")
  • usd number nullable
  • amount number nullable
  • symbol string nullable
  • native number nullable
• collection object nullable
  • @type string (default: "OpenseaItemCollection")
  • slug string required
  • name string nullable
  • image string nullable
  • category string nullable
  • external_url string nullable
  • twitter string nullable
  • instagram string nullable
  • discord string nullable
  • standard string nullable
  • is_verified boolean (default: false)
  • floor_price object nullable
    • @type string (default: "OpenseaPrice")
    • usd number nullable
    • amount number nullable
    • symbol string nullable
    • native number nullable
• attributes array (default: [])
  • @type string (default: "OpenseaItemTrait")
  • trait_type string required
  • value string required
• created_at string nullable
• last_sale_at string nullable
• last_transfer_at string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Collection not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.