Knowledge Base
  • 👨‍🎨For creators
    • 👋Intro to creating with Highlight
    • 📜Project quick start guides
      • Launch an open edition
      • Launch a delayed reveal collection
      • Launch a 1-of-1 auction
      • Launch a generative artwork
      • Launch an open edition generative artwork
      • Launch a PFP project
      • Launch a generative, image-based PFP project
      • Launch a ranked auction
      • Launch an onchain project
      • Launch a collector's choice project
      • Ongoing drops with the same contract
    • 🎇Learn the creation flows
      • ERC-721 vs. ERC-1155 Token Standards
      • Edition flow
      • Generative flow
      • Series flow
      • The importance of testing your collections
    • 👩‍💻Use embeds to build custom mint sites
      • Case Study: How Superchain Chiblings launched a fully custom website on Highlight x Base
      • Running a collector's choice mint via embeds
    • 💸Selling your NFTs
      • Available sale methods
        • Ranked auction
        • Dutch auction
        • English auction
      • Setting up gates (allowlists)
      • Combining sale methods
      • Configuring payment currencies
        • Accepting ERC20 payments
        • Accepting credit card payments
      • Payouts, royalties & splits
      • Livestream on the mint page
    • 🛠️Managing your collections
      • Hiding a collection
      • Mint creator reserves
      • Airdropping tokens
      • Updating collection metadata
      • Getting verified
      • Sponsored mints
      • Reducing collection size
    • 🔮Generative & onchain art tools
      • Highlight Studio
      • Onchain file system
      • Storing SVGs onchain
      • Downloading token metadata
      • How onchain is Highlight?
    • 🌐Integrations & ecosystem
      • Farcaster
      • Paragraph.xyz
      • Foundation Worlds
        • Importing a collection to Worlds
        • Foundation × Highlight FAQs
      • Export generative art from Cables.gl
      • Highlight on mobile
    • 🤓Advanced
      • Reusing contracts
      • Randomization algorithm
      • Upload asset specifications
      • Fulfilling auctions for non-transferable tokens
    • ✨About Highlight
      • Artwork policies
      • Highlight fees
  • For Collectors
    • 💳Buying
      • Buying on secondary
      • Exchange currency across chains
  • 💲Selling
    • Selling on secondary
    • Instantly sell & relist NFTs
  • 🔔Notifications
  • For developers
    • Intro to the Highlight Protocol
    • NFT contracts
      • Official addresses
      • ERC721GeneralSequence
      • ERC721General
      • ERC721EditionsDFS
      • ERC721SingleEditionDFS
      • ERC721GenerativeOnchain
      • Deprecated contracts
    • Custom metadata renderers
      • Example custom renderers
    • Minting protocol
      • Mint Managers
      • Mint Mechanics
        • Dutch auction mechanic
        • Ranked auction mechanic
        • Verisart mechanic
        • Seed-based mechanic
        • Auction Manager *
      • Referral Manager
    • Management modules
      • TokenManager
      • RoyaltyManager
    • Observability
    • Onchain File Storage
    • Mint fee oracle
    • Protocol rewards
      • Creator rewards
      • Mint referral rewards
    • Crosschain burn / redeem
  • Official links
    • ✨Highlight website
    • 🟣Highlight Farcaster
    • 🐦Highlight Twitter
    • 👋About us
Powered by GitBook
On this page
  • Overview
  • Using Highlight CLI
  1. For creators
  2. Generative & onchain art tools

Downloading token metadata

PreviousStoring SVGs onchainNextHow onchain is Highlight?

Last updated 11 months ago

For detailed instructions on how to download metadata and image previews from collection on Highlight, our .

Overview

Highlight CLI is a powerful tool for creators and collectors to easily download token metadata and previews from your favorite collections

This tool currently offers two primary functions: downloading metadata and downloading images of all tokens in a collection.

Using Highlight CLI

Installing Highlight CLI

Downloading token metadata

To download all token metadata into a single CSV file, use the "download collection metadata" command. You'll need to provide three essential arguments: the address of the smart contract of your collection, the network it's on, and the path to the output CSV file. The tool will fetch the metadata and save it into a CSV, which makes it easy to inspect and analyze your collection.

The generated CSV file contains information about each token in your collection, including token ID, name, traits, images, animations, descriptions, and external URLs. You may need to expand column sizes, especially for lengthy descriptions and trait names.

Note: for larger collections, the CLI has built-in redundancy to handle potential issues during the download. It will automatically retry fetching failed tokens, ensuring a comprehensive dataset. You can also fine-tune the redundancy levels based on your preferences.

Downloading token preview images

The "download collection previews" command lets you download all token previews to a local folder. This command also requires the collection's smart contract address, network, and the destination folder name. If you've already downloaded the metadata CSV, you can specify its path to avoid redundant work.

This command is intensive and can be time-consuming, especially for larger collections. However, you can stop and resume the process at any time. The tool will skip already downloaded images, allowing you to pick up where you left off.

Once the process is complete, you'll have a local folder with all the token previews, making it convenient to view and share your collection.

Before you get started, ensure that you have Node.js, NPM, and Yarn installed on your machine. If not, install them as prerequisites. Next, clone the Highlight repository ., which should already be familiar if you've followed their generative on-chain tools tutorial.

👨‍🎨
🔮
here
Github repository
Follow the video walkthrough to learn more