Skip to main content

NFTS by Contract

Provide us with a contract address/ENS address (for EVMs) or a collection address (for Solana) and receive information related to that contract. We will return metadata and transfer related information from both on-chain and off-chain data sources where available.

Query Parameters
  • chain string

    filter for a particular chain

  • cursor string

    cursor for pagination purposes

  • limit integer

    number of items to return, maximum 100, default 100.

  • includeLastTransfer boolean
  • contractAddress string required

    contractAddress/ENS address to query

    Example (bayc):
    0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d
    Example (cryptoPunks):
    0xb47e3cd837ddf8e4c57f05d70ab865de6e193bbb
    Example (okaybears):
    3saAedkM9o5g1u5DCqsuMZuC4GRqPB4TuMkvSsSVvGQ3
  • traits string[]

    traits to filter for, format: type-value. Can be multiple tokens, comma separated (max 100). If this field is defined but empty, an empty result will be returned

  • excludedTraits string[]

    traits to filter for, format: type-value. Can be multiple tokens, comma separated (max 100). If this field is defined but empty, an empty result will be returned

  • sortBy string

    sort order: [<blank>|lowestAsk|highestAsk|tokenId[-asc|-desc]|rarity]. blank is most recent transaction first, lowestAsk is lowest ask first, highestAsk is ascending order of the highest ask by token. tokenId[-asc|-desc] is by tokenId ascending or descending. rarity is by rarity descending. If sortBy is either lowestAsk or highestAsk, pagination is only supported up to 10,000 items. Items with no asks will be sorted behind all items with asks

  • priceFilter string[]

    Filter items returned by lowest ask. Use comma separated values of the form <currency>,<min>,<max>. Not case-sensitive. Must always have 2 commas

    Example (both):
    ETH,10,15
    Example (minOnly):
    ETH,5,
    Example (maxOnly):
    DAI,,20
  • marketplaces string[]

    marketplaces to filter for. Can be multiple marketplaces, comma separated, non-case-sensitive. If this field is defined but empty, an empty result will be returned

Responses

Schema
  • data object[] required

    a list of NFTs

    • contractAddress string

      contract the NFT was deployed to. case insensitive

    • contractStandard string

      contract standard

    • tokenId string required

      the tokenId representing the NFT. The contractAddress and tokenId together uniquely identify an NFT on a chain

    • uri string

      URL of the NFT

    • metadata object

      Metadata of the NFT

      allOf
      • name string

        Name of the NFT

      • description string

        Description of the NFT

      • imageMediaType string

        Type of media that the NFT points to. Will be in MIME type. e.g. image/jpeg, image/svg. Possible types: image

      • imageUrl string

        Original image URL of the NFT

      • imageCacheUrl string

        Gomu cached version of image media at original size

      • imageCachePreviewUrl string

        Gomu cached version of image media at preview (250x250) size

      • imageCacheThumbnailUrl string

        Gomu cached version of image media at thumbnail (128x128) size

      • mediaType string

        Type of animation media that the NFT points to. Will be in MIME type. e.g. image/gif, video/mp4. Possible types: image, video, music

      • mediaUrl string

        Original animation URL of the NFT

      • traits object[]

        List of traits

        • traitType string

          key of the trait

        • traitValue object

          value of the trait

        • traitRarity number

          rarity score of the trait

        • traitFrequency number

          frequency of the trait

        • traitPercentFrequency number

          population percent frequency of the trait

    • owners object[]

      Current owners of the NFT

      • address string required

        owner address

      • amount string required

        the number of tokens owned

      • enteredAtBlock number

        block number when this owner first owns the token

      • enteredAt number

        unix epoch time when this owner first owns the token

      • updatedAtBlock number

        block number when this owner last interacts with the token

      • updatedAt number

        unix epoch time when this owner last interacts with the token

    • minter string

      Minter of the NFT; this is the minting transaction's fromAddress

    • lastTransfer object

      lastTransfer event of the NFT

      allOf
      • contractAddress string

        contract address of an NFT contract deployed e.g. 0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d for Bored Ape Yacht Club (BAYC)

      • tokenId string required

        tokenId of a specific NFT

      • chain string required

        identifier of chain indexed. e.g. 'ethereum' for mainnet

      • blockNumber integer required

        blockNumber of the transfer

      • transactionHash string required

        transactionHash of the transfer

      • fromAddress string

        previous owner address of the NFT in this transaction

      • toAddress string

        current owner address of the NFT in this transaction

      • value string

        native-token value of the transaction if any (e.g. on mainnet, Ethereum, denoted in wei). in the case of a batch transfer, they will share the same value

      • nftValue object

        inferred value for transferred NFT in token amount

        • tokenAddress string required
        • tokenName string
        • amount string required
      • swaps object[] required

        A P2P transaction or we are not able to infer the NFT value

        • contractAddress string required
        • tokenId string
        • fromAddress string required
        • toAddress string required
        • amount string required
        • market string
      • usdValue number

        USD value from inferred NFT value

      • ethValue number

        ETH value from inferred NFT value

      • isCommercial boolean

        whether the transfer happens on commercial markets

      • amount string required

        amount of the token. Relevant for ERC1155 which may have a non-1 amount of tokens

      • timestamp integer required

        unix timestamp in seconds

      • markets string[] required

        classified markets for the transaction (e.g. opensea if it interacts with opensea)

      • native
      • transferType string

        transferType: can be [mint, transfer, sale, swap, burn]

      • imageCacheUrl string

        imageUrl of the token

    • markets string[]

      A list of markets that this NFT was transferred on e.g. ['opensea','0x']

    • rarity number

      rarity score of the NFT

    • orderbook string[]

      Orderbook details

    • native
    • rank number

      rank

  • nextCursor string

    pass into cursor variable to return next-page of responses, if any