OpenSea icon

OpenSea

Access NFT data using the OpenSea API v2

Actions9

Collection → Get Collection

AI-generated

Overview

This node operation fetches detailed information about a specific NFT collection from the OpenSea API using the collection slug as an identifier. It is useful for users who want to retrieve metadata and descriptive details about an NFT collection, such as its name, description, images, owner, social links, and status flags. Practical examples include displaying collection details in an NFT marketplace app or analyzing collection metadata for research or reporting.

Use Case Examples

  1. Retrieve detailed information about the 'boredapeyachtclub' collection by providing its slug.
  2. Use the node to fetch and display collection metadata on a website or dashboard.

Properties

Name Meaning
Collection Slug The unique identifier (slug) of the NFT collection to retrieve information for, e.g., 'boredapeyachtclub'.
Additional Fields Optional parameters to customize the request, such as limiting results or pagination, though not typically used for this operation.

Output

JSON

  • resource - The resource type, here always 'collection'.
  • operation - The operation performed, here 'getCollection'.
  • timestamp - The ISO timestamp when the data was fetched.
  • data
    • collection
      * collection - The collection's unique slug identifier.
      * name - The name of the collection.
      * description - Description of the collection.
      * image_url - URL to the collection's main image.
      * banner_image_url - URL to the collection's banner image.
      * owner - Owner address or identifier of the collection.
      * safelist_status - Status indicating if the collection is safelisted.
      * category - Category of the collection.
      * is_disabled - Flag indicating if the collection is disabled.
      * is_nsfw - Flag indicating if the collection is marked as not safe for work.
      * trait_offers_enabled - Flag indicating if trait offers are enabled for the collection.
      * collection_offers_enabled - Flag indicating if collection offers are enabled.
      * opensea_url - URL to the collection's page on OpenSea.
      * project_url - URL to the project's official website.
      * wiki_url - URL to the collection's wiki page.
      * discord_url - URL to the collection's Discord server.
      * telegram_url - URL to the collection's Telegram group.
      * twitter_username - Twitter username associated with the collection.
      * instagram_username - Instagram username associated with the collection.

Dependencies

  • OpenSea API (optionally with an API key credential)

Troubleshooting

  • Common issues include providing an invalid or misspelled collection slug, which results in no data or an error from the API.
  • If the API key is required and not provided or invalid, the request may fail or be rate-limited.
  • Network connectivity issues can cause request failures.
  • Error messages typically indicate invalid parameters or authentication issues; verify the collection slug and API credentials.

Links

Discussion