Collection model

The SimpleHash API returns information on the collection an NFT is associated with. These are often specific to certain NFT marketplaces. The following are the fields included for the collection model (appearing inline as a field on the NFT model).

For collection model found on NFT responses and core Collection endpoints:

  <th style={{ textAlign: "left" }}>
    Description
  </th>

  <th style={{ textAlign: "left" }}>
    Type(s)
  </th>
</tr>

  <td style={{ textAlign: "left" }}>
    Unique identifier for a specific collection. This is distinct from contract address, since a contract may contain multiple collections
  </td>

  <td style={{ textAlign: "left" }}>
    `string / null`
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    name
  </td>

  <td style={{ textAlign: "left" }}>
    Name of the collection
  </td>

  <td style={{ textAlign: "left" }}>
    `string / null`
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    description
  </td>

  <td style={{ textAlign: "left" }}>
    Description of the collection
  </td>

  <td style={{ textAlign: "left" }}>
    `string / null`
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    image\_url
  </td>

  <td style={{ textAlign: "left" }}>
    URL link to the collection logo / main image on the SimpleHash CDN, where available
  </td>

  <td style={{ textAlign: "left" }}>
    `string / null`
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    banner\_image\_url
  </td>

  <td style={{ textAlign: "left" }}>
    URL link to the collection banner image on the SimpleHash CDN, where available
  </td>

  <td style={{ textAlign: "left" }}>
    `string / null`
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    category
  </td>

  <td style={{ textAlign: "left" }}>
    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.
  </td>

  <td style={{ textAlign: "left" }}>
    `string / null`
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    is\_nsfw
  </td>

  <td style={{ textAlign: "left" }}>
    Collection flagged as NSFW
  </td>

  <td style={{ textAlign: "left" }}>
    `boolean / null`
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    external\_url
  </td>

  <td style={{ textAlign: "left" }}>
    URL link to the external website or resource associated with the collection
  </td>

  <td style={{ textAlign: "left" }}>
    `string / null`
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    twitter\_username
  </td>

  <td style={{ textAlign: "left" }}>
    Twitter handle of the account associated with the collection, where available
  </td>

  <td style={{ textAlign: "left" }}>
    `string / null`
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    discord\_url
  </td>

  <td style={{ textAlign: "left" }}>
    Discord server associated with the collection, where available
  </td>

  <td style={{ textAlign: "left" }}>
    `string / null`
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    instagram\_url
  </td>

  <td style={{ textAlign: "left" }}>
    Instagram URL for the collection if available
  </td>

  <td style={{ textAlign: "left" }}>
    `string / null`
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    medium\_username
  </td>

  <td style={{ textAlign: "left" }}>
    Medium.com username for the collection if available
  </td>

  <td style={{ textAlign: "left" }}>
    `string / null`
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    telegram\_url
  </td>

  <td style={{ textAlign: "left" }}>
    Telegram URL for the collection if available
  </td>

  <td style={{ textAlign: "left" }}>
    `string / null`
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    marketplace\_pages
  </td>

  <td style={{ textAlign: "left" }}>
    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)
  </td>

  <td style={{ textAlign: "left" }}>
    \[\{\
    `marketplace_id`: `string`, `marketplace_name`:`string`,\
    `marketplace_collection_id`:`string`,\
    `nft_url`:`string / null`,\
    `collection_url`:`string`,\
    `verified`:`boolean` / `null`\
    }]
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    metaplex\_mint
  </td>

  <td style={{ textAlign: "left" }}>
    Unique metaplex mint ID, populated only for Solana NFTs where there is a verified metaplex collection
  </td>

  <td style={{ textAlign: "left" }}>
    `string / null`
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    metaplex\_candy\_machine
  </td>

  <td style={{ textAlign: "left" }}>
    When a verified metaplex collection is not available, the candy machine address (if applicable) may be used to group the NFTs
  </td>

  <td style={{ textAlign: "left" }}>
    `string / null`
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    metaplex\_first\_verified\_creator
  </td>

  <td style={{ textAlign: "left" }}>
    When other grouping methods are not available, this identifier may be used to group NFTs by the first verified creator address
  </td>

  <td style={{ textAlign: "left" }}>
    `string / null`
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    spam\_score
  </td>

  <td style={{ textAlign: "left" }}>
    Spam rating of the NFT collection (for Enterprise plans), 0-100 range, (100 being most likely spam)
  </td>

  <td style={{ textAlign: "left" }}>
    `int / null`
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    floor\_prices
  </td>

  <td style={{ textAlign: "left" }}>
    Array of 0 or more floor prices for the collection, one for each marketplace
  </td>

  <td style={{ textAlign: "left" }}>
    \[[Floor price model](https://simplehash.readme.io/reference/floor-price-model)
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    top\_bids
  </td>

  <td style={{ textAlign: "left" }}>
    Array of 0 or more top bids for the collection, one for each marketplace
  </td>

  <td style={{ textAlign: "left" }}>
    \[[Top bid model](https://simplehash.readme.io/reference/top-bid-model)]
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    distinct\_owner\_count
  </td>

  <td style={{ textAlign: "left" }}>
    Distinct number of owners for NFTs in this collection. This and the following numbers may briefly be null for new collections
  </td>

  <td style={{ textAlign: "left" }}>
    `int / null`
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    distinct\_nft\_count
  </td>

  <td style={{ textAlign: "left" }}>
    Distinct number of unburned NFT IDs
  </td>

  <td style={{ textAlign: "left" }}>
    `int / null`
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    total\_quantity
  </td>

  <td style={{ textAlign: "left" }}>
    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`
  </td>

  <td style={{ textAlign: "left" }}>
    `int / null`
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    chains
  </td>

  <td style={{ textAlign: "left" }}>
    Array of 1 or more chains in the collection. This is usually just 1, but OpenSea allows for multi-chain collections like [this one](https://opensea.io/collection/world-values-v2) spanning Polygon and BSC.
  </td>

  <td style={{ textAlign: "left" }}>
    \[`chain`:`string`]
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    top\_contracts
  </td>

  <td style={{ textAlign: "left" }}>
    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.
  </td>

  <td style={{ textAlign: "left" }}>
    \[`contract_id`:`string`]
  </td>
</tr>

<tr>
  <td style={{ textAlign: "left" }}>
    collection\_royalties
  </td>

  <td style={{ textAlign: "left" }}>
    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.
  </td>

  <td style={{ textAlign: "left" }}>
    \[\{\
    `source`: `string`,\
    `total_creator_fee_basis_points`: `int`,\
    `recipients`: [\{\
           `address`: `string`,\
           `percentage`: `float`,\
           `basis_points`: `int`\
        }][{  
           \`address`: `string`,  
           \`percentage`: `float`,  
           \`basis_points`: `int`  
        }]\
    }]
  </td>
</tr>

Field
collection\_id