Collections are used to represent all the assets in a single (or multiple) contract addresses and help users group items from the same creator. They have one or more owners and are typically associated with important metadata such as creator earnings configurations and descriptions.
| Field Name | Description | Notes |
|---|---|---|
name | The collection name. Typically derived from the first contract imported to the collection but can be changed by the user | |
external_link | External link to the original website for the collection | |
description | Description for the model | |
slug | The collection slug that is used to link to the collection on OpenSea. This value can change by the owner but must be unique across all collection slugs in OpenSea | |
image_url | An image for the collection. Note that this is the cached URL we store on our end. The original image url is image_original_url | |
banner_image_url | Image used in the horizontal top banner for the collection | |
dev_seller_fee_basis_points | The collector's fees that get paid out to them when sales are made for their collections | deprecated - use 'fees' instead |
opensea_seller_fee_basis_points | The OpenSea fee | deprecated - use 'fees' instead |
safelist_request_status | The collection's approval status within OpenSea. Can be not_requested (brand new collections), requested (collections that requested safelisting on our site), approved (collections that are approved on our site and can be found in search results), and verified (verified collections) | |
payout_address | The payout address for the collection's creator earnings | deprecated - use 'fees' instead |
primary_asset_contracts | A list of the contracts that are associated with this collection | |
traits | A dictionary listing all the trait types available within this collection | |
payment_tokens | The payment tokens accepted for this collection | |
editors | Approved editors on this collection. | |
stats | A dictionary containing some sales statistics related to this collection, including trade volume and floor prices | |
fees | A dictionary for each of the opensea_fees and seller_fees that are vended, mapping recipient address to the basis points paid out to them | These fees are calculated based on the assumption that you are paying the creator earnings basis points specified by the collection creator. To see if seller_fees are enforced during listing/offer creation, check is_creator_fees_enforced .For details on the minimum fees required to submit a listing or offer, please see this article. |
is_creator_fees_enforced | A boolean indicating whether the creator earnings specified in fees are enforced during programmatic listing/offer creation. | For details on creator fee enforcement, please see this article. |
is_rarity_enabled | A boolean indicating whether the creator has rarity enabled for display on OpenSea. |