Skip to main content

Contract Overview

Provide us with a contract address/ENS address and receive an overview on the contract.

Query Parameters
  • contractAddress string required

    contractAddress/ENS address to query

  • chain string

    filter for a particular chain

Responses

Schema
  • data object

    a list of NFTs

    allOf
    • chain string required

      the blockchain it is deployed to

    • address string required

      Address contract was deployed to

    • standard string required

      what standard of NFT it is; e.g. ERC721 or ERC1155

    • name string

      Name of the contract

    • symbol string

      Symbol of the contract

    • description string

      Description of the contract

    • type string

      Type of contract (e.g. non-fungible)

    • totalSupply string

      Maximum amount of supply (denominator)

    • tokensCount string

      Current amount of supply (numerator)

    • ownersCount string

      Number of owners

    • verified boolean

      Gomu verified status (aggregated)

    • discordUrl string

      URL of Discord server

    • telegramUrl string

      URL of Telegram channel

    • twitterUsername string

      Twitter username

    • instagramUsername string

      Instagram username

    • externalLink string

      The website of the contract

    • markets object[]

      Markets traded on

      • market string required

        Name of the market

      • slug string

        Opensea slug

      • name string

        Name of the contract on the market

      • profileImageUrl string

        Main profile picture URL

      • bannerImageUrl string

        Banner picture URL

      • payoutAddress string

        Payout address when interacting with Wyvern

      • oneDayStats object

        1-day change

        • volume number required

          volume in native protocol token (e.g. ETH/WETH)

        • change number required

          change in native protocol token (e.g. ETH/WETH)

        • sales number required

          sales in absolute number

        • averagePrice number required

          average price in native protocol token (e.g. ETH/WETH)

      • sevenDayStats object

        7-day change

        • volume number required

          volume in native protocol token (e.g. ETH/WETH)

        • change number required

          change in native protocol token (e.g. ETH/WETH)

        • sales number required

          sales in absolute number

        • averagePrice number required

          average price in native protocol token (e.g. ETH/WETH)

      • thirtyDayStats object

        30-day change

        • volume number required

          volume in native protocol token (e.g. ETH/WETH)

        • change number required

          change in native protocol token (e.g. ETH/WETH)

        • sales number required

          sales in absolute number

        • averagePrice number required

          average price in native protocol token (e.g. ETH/WETH)

      • totalVolume number

        Total volume in native protocol token (e.g. ETH/WETH)

      • totalSales number

        Total sales in absolute number

      • floorPrice number

        Current floor price in native protocol token (e.g. ETH/WETH)

      • averagePrice number

        Average price in native protocol token (e.g. ETH/WETH)

      • marketCap number

        Market capitalization in native protocol token (e.g. ETH/WETH)

    • contract object required

      contract with marketplace data

      • chain string required

        the blockchain it is deployed to

      • address string required

        Address contract was deployed to

      • standard string required

        what standard of NFT it is; e.g. ERC721 or ERC1155

      • name string

        Name of the contract

      • symbol string

        Symbol of the contract

      • description string

        Description of the contract

      • type string

        Type of contract (e.g. non-fungible)

      • totalSupply string

        Maximum amount of supply (denominator)

      • tokensCount string

        Current amount of supply (numerator)

      • ownersCount string

        Number of owners

      • verified boolean

        Gomu verified status (aggregated)

      • discordUrl string

        URL of Discord server

      • telegramUrl string

        URL of Telegram channel

      • twitterUsername string

        Twitter username

      • instagramUsername string

        Instagram username

      • externalLink string

        The website of the contract

      • markets object[]

        Markets traded on

        • market string required

          Name of the market

        • slug string

          Opensea slug

        • name string

          Name of the contract on the market

        • profileImageUrl string

          Main profile picture URL

        • bannerImageUrl string

          Banner picture URL

        • payoutAddress string

          Payout address when interacting with Wyvern

        • oneDayStats object

          1-day change

          • volume number required

            volume in native protocol token (e.g. ETH/WETH)

          • change number required

            change in native protocol token (e.g. ETH/WETH)

          • sales number required

            sales in absolute number

          • averagePrice number required

            average price in native protocol token (e.g. ETH/WETH)

        • sevenDayStats object

          7-day change

          • volume number required

            volume in native protocol token (e.g. ETH/WETH)

          • change number required

            change in native protocol token (e.g. ETH/WETH)

          • sales number required

            sales in absolute number

          • averagePrice number required

            average price in native protocol token (e.g. ETH/WETH)

        • thirtyDayStats object

          30-day change

          • volume number required

            volume in native protocol token (e.g. ETH/WETH)

          • change number required

            change in native protocol token (e.g. ETH/WETH)

          • sales number required

            sales in absolute number

          • averagePrice number required

            average price in native protocol token (e.g. ETH/WETH)

        • totalVolume number

          Total volume in native protocol token (e.g. ETH/WETH)

        • totalSales number

          Total sales in absolute number

        • floorPrice number

          Current floor price in native protocol token (e.g. ETH/WETH)

        • averagePrice number

          Average price in native protocol token (e.g. ETH/WETH)

        • marketCap number

          Market capitalization in native protocol token (e.g. ETH/WETH)

    • nftDistributionByTraitVector object required

      distribution by trait vector

      • headers string[] required

        The headers of the columns in data

      • data string[] required

        A list of trait type and [trait value, count] pairs