/opensea/collections

POST /api/opensea/collections

Price: 1 credit

Get an OpenSea NFT collection by its slug

How to use it

Get the full profile of an OpenSea NFT collection by its slug (e.g. 'boredapeyachtclub'). Returns the name, description, image and banner, category, blockchain and contract address, token standard, social links (external url, twitter, instagram, discord), verification status, owner, creation date, current floor price and top offer (in native, token and USD), and rolling stats (owner count, total supply, listed count, and volume/sales/floor-price change across the 1h, 1d, 7d and 30d windows). Use the 'collections/search' endpoint to discover collection slugs.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• slug string required — Collection slug (its human-readable alias from the collection URL) (examples: "boredapeyachtclub", "pudgypenguins", "azuki"; minLength: 1)

Response

• @type string (default: "OpenseaCollection")
• slug string required
• name string nullable
• description string nullable
• image string nullable
• banner string nullable
• category string nullable
• chain string nullable
• address string nullable
• standard string nullable
• external_url string nullable
• twitter string nullable
• instagram string nullable
• discord string nullable
• is_verified boolean (default: false)
• is_offers_enabled boolean (default: false)
• is_rarity_disabled boolean (default: false)
• owner string nullable
• owner_name string nullable
• created_at string nullable
• floor_price object nullable
  • @type string (default: "OpenseaPrice")
  • usd number nullable
  • amount number nullable
  • symbol string nullable
  • native number nullable
• top_offer object nullable
  • @type string (default: "OpenseaPrice")
  • usd number nullable
  • amount number nullable
  • symbol string nullable
  • native number nullable
• stats object nullable
  • @type string (default: "OpenseaCollectionStats")
  • owner_count integer nullable
  • sales integer nullable
  • total_supply integer nullable
  • unique_item_count integer nullable
  • listed_item_count integer nullable
  • volume_usd number nullable
  • volume_native number nullable
  • one_hour object nullable
    • @type string (default: "OpenseaWindowStats")
    • volume_usd number nullable
    • volume_native number nullable
    • sales integer nullable
    • floor_price_change number nullable
  • one_day object nullable
    • @type string (default: "OpenseaWindowStats")
    • volume_usd number nullable
    • volume_native number nullable
    • sales integer nullable
    • floor_price_change number nullable
  • seven_days object nullable
    • @type string (default: "OpenseaWindowStats")
    • volume_usd number nullable
    • volume_native number nullable
    • sales integer nullable
    • floor_price_change number nullable
  • thirty_days object nullable
    • @type string (default: "OpenseaWindowStats")
    • volume_usd number nullable
    • volume_native number nullable
    • sales integer nullable
    • floor_price_change number 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.