Collection model

collection_id

Unique identifier for a specific collection. This is distinct from contract address, since a contract may contain multiple collections

string / null

name

Name of the collection

string / null

description

Description of the collection

string / null

image_url

URL link to the collection logo / main image on the SimpleHash CDN, where available

string / null

banner_image_url

URL link to the collection banner image on the SimpleHash CDN, where available

string / null

category

Collection category if available, currently one of: art, domain-names, gaming, memberships, music, pfps, photography, sports-collectibles, virtual-worlds

This list may grow over time.

string / null

is_nsfw

Collection flagged as NSFW

boolean / null

external_url

URL link to the external website or resource associated with the collection

string / null

twitter_username

Twitter handle of the account associated with the collection, where available

string / null

discord_url

Discord server associated with the collection, where available

string / null

instagram_url

Instagram URL for the collection if available

string / null

medium_username

Medium.com username for the collection if available

string / null

telegram_url

Telegram URL for the collection if available

string / null

marketplace_pages

Array of 0 or more objects referencing the the collection's page(s) on a given marketplace. marketplace_collection_id is typically a case-sensitive slug (e.g., azuki for OpenSea) and sometimes an address (on marketplaces such as Quixotic and Stratos)

[{
marketplace_id: string, marketplace_name:string,
marketplace_collection_id:string,
nft_url:string / null,
collection_url:string,
verified:boolean / null
}]

metaplex_mint

Unique metaplex mint ID, populated only for Solana NFTs where there is a verified metaplex collection

string / null

metaplex_candy_machine

When a verified metaplex collection is not available, the candy machine address (if applicable) may be used to group the NFTs

string / null

metaplex_first_verified_creator

When other grouping methods are not available, this identifier may be used to group NFTs by the first verified creator address

string / null

spam_score

Spam rating of the NFT collection (for Enterprise plans), 0-100 range, (100 being most likely spam)

int / null

floor_prices

Array of 0 or more floor prices for the collection, one for each marketplace

[Floor price model

top_bids

Array of 0 or more top bids for the collection, one for each marketplace

[Top bid model]

distinct_owner_count

Distinct number of owners for NFTs in this collection. This and the following numbers may briefly be null for new collections

int / null

distinct_nft_count

Distinct number of unburned NFT IDs

int / null

total_quantity

Total copies of unburned NFTs in this collection. For semi-fungibles, there may be more than one copy per NFT, so this value could exceed distinct_nft_count

int / null

chains

Array of 1 or more chains in the collection. This is usually just 1, but OpenSea allows for multi-chain collections like this one spanning Polygon and BSC.

[chain:string]

top_contracts

On chains with NFT smart contracts (EVM & Flow), array of 1 or more contracts associated with this collection, capped at a maximum of 20. This will be an empty array for Bitcoin and Solana.

[contract_id:string]

collection_royalties

Array of 0 or more royalty details, at the collection level, by source. Different marketplaces allow for different royalty amounts, so we show a list of the available information. When there are multiple sources, we list them from highest to lowest total_creator_fee_basis_points.

Current sources are: opensea

The list of recipients can have 0 or more wallets, as applicable. Amounts are shown in both basis_points (adding up to total_creator_fee_basis_points) and percentage, which is the share of this wallet's fees compared to other recipients.

[{
source: string,
total_creator_fee_basis_points: int,
recipients: [{
address: string,
percentage: float,
basis_points: int
}][{
`address: string, \percentage: float, \basis_points: int`
}]
}]