/opensea/collections/activity

POST /api/opensea/collections/activity

Price: 5 credits

List on-chain marketplace activity (sales, listings, offers, transfers, mints) for a collection

How to use it

List recent marketplace activity for an OpenSea NFT collection by its slug (e.g. 'boredapeyachtclub'), optionally restricted to specific event types (sale, listing, offer, transfer, mint). Each event returns the event type, timestamp, transaction hash, from and to addresses, price (in native, token and USD), sale type and marketplace, whether a mint was an airdrop, quantity, the involved item (token id, name, image, contract) and its collection.

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"; minLength: 1)
• count integer required — Number of activity events to return (min: 1)
• event_types array nullable — Restrict to these event types (defaults to all types) (one of: "sale", "listing", "offer", "transfer", "mint")

Response

• @type string (default: "OpenseaActivity")
• id string required
• event_type string nullable
• event_at string nullable
• transaction_hash string nullable
• from_address string nullable
• to_address string nullable
• price object nullable
  • @type string (default: "OpenseaPrice")
  • usd number nullable
  • amount number nullable
  • symbol string nullable
  • native number nullable
• sale_type string nullable
• marketplace string nullable
• is_airdrop boolean nullable
• quantity number nullable
• chain string nullable
• contract_address string nullable
• token_id string nullable
• item_name string nullable
• item_image string nullable
• collection_slug string nullable
• collection_name string nullable
• collection_image string nullable
• collection_is_verified boolean 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 — The entity was not found, or a precondition failed 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.