nft-service-api

GraphQL API Reference

GraphQl endpoints for nft-service!

API Endpoints

# devel:
https://nft-service.devel.original.works/graphql
# staging:
https://nft-service.stage.original.works/graphql
# prod:
https://nft-service.original.works/graphql

Queries

balanceOf

Description

🔓 Public

Returns token balance of user

Response

Returns a String!

Arguments

Name	Description
collectionContract - String!
tokenId - String!
userId - String!
network - NetworkName!

Example

Query

query BalanceOf(
  $collectionContract: String!,
  $tokenId: String!,
  $userId: String!,
  $network: NetworkName!
) {
  balanceOf(
    collectionContract: $collectionContract,
    tokenId: $tokenId,
    userId: $userId,
    network: $network
  )
}

Variables

{
  "collectionContract": "xyz789",
  "tokenId": "abc123",
  "userId": "abc123",
  "network": "ropsten"
}

Response

{"data": {"balanceOf": "xyz789"}}

Queries

collection

Description

🔓 Public

Returns single collection

Response

Returns a Collection

Arguments

Name	Description
network - NetworkName!
id - String!

Example

Query

query Collection(
  $network: NetworkName!,
  $id: String!
) {
  collection(
    network: $network,
    id: $id
  ) {
    id
    owner
    tokens {
      id
      tokenId
      collectionContract {
        ...CollectionFragment
      }
      minter
      enterprise {
        ...CollectionEntityFragment
      }
      artist {
        ...CollectionEntityFragment
      }
      amount
      royaltyRecipient
      royaltyNumerator
      owners {
        ...TokenOwnerFragment
      }
      ownersWithMetadata {
        ...OwnerWithMetadataFragment
      }
      listing {
        ...ListingFragment
      }
      purchases {
        ...PurchaseFragment
      }
      tokenURI
      metadata {
        ...NftMetadataDTOFragment
      }
      nftUrl
      coverUrl
      networkName
      createdAt
      updatedAt
    }
    address
    contractURI
    networkName
    metadata {
      id
      userSub
      name
      symbol
      description
      coverImageS3Key
      coverImageS3Url
      coverImageIpfsUrl
      coverImageIpfsHash
      bannerImageS3Key
      bannerImageS3Url
      bannerImageIpfsHash
      bannerImageIpfsUrl
      externalLink
      defaultRoyalties
      defaultRoyaltyRecipient
      metadataIpfsHash
      metadataIpfsUrl
      networkName
      status
    }
    createdAt
    updatedAt
  }
}

Variables

{"network": "ropsten", "id": "xyz789"}

Response

{
  "data": {
    "collection": {
      "id": "xyz789",
      "owner": "abc123",
      "tokens": [Token],
      "address": "xyz789",
      "contractURI": "xyz789",
      "networkName": "ropsten",
      "metadata": CollectionMetadataDto,
      "createdAt": "abc123",
      "updatedAt": "abc123"
    }
  }
}

Queries

collectionMetadata

Description

🔒 JWT Token

Retrieve collection metadata by id

Response

Returns a CollectionMetadataDto!

Arguments

Name	Description
id - Float!

Example

Query

query CollectionMetadata($id: Float!) {
  collectionMetadata(id: $id) {
    id
    userSub
    name
    symbol
    description
    coverImageS3Key
    coverImageS3Url
    coverImageIpfsUrl
    coverImageIpfsHash
    bannerImageS3Key
    bannerImageS3Url
    bannerImageIpfsHash
    bannerImageIpfsUrl
    externalLink
    defaultRoyalties
    defaultRoyaltyRecipient
    metadataIpfsHash
    metadataIpfsUrl
    networkName
    status
  }
}

Variables

{"id": 987.65}

Response

{
  "data": {
    "collectionMetadata": {
      "id": 123,
      "userSub": "xyz789",
      "name": "abc123",
      "symbol": "xyz789",
      "description": "xyz789",
      "coverImageS3Key": "xyz789",
      "coverImageS3Url": "xyz789",
      "coverImageIpfsUrl": "abc123",
      "coverImageIpfsHash": "abc123",
      "bannerImageS3Key": "xyz789",
      "bannerImageS3Url": "abc123",
      "bannerImageIpfsHash": "abc123",
      "bannerImageIpfsUrl": "abc123",
      "externalLink": "abc123",
      "defaultRoyalties": "xyz789",
      "defaultRoyaltyRecipient": "abc123",
      "metadataIpfsHash": "abc123",
      "metadataIpfsUrl": "xyz789",
      "networkName": "ropsten",
      "status": "PENDING_UPLOAD"
    }
  }
}

Queries

collections

Description

🔓 Public

Returns collections

Response

Returns [Collection!]!

Arguments

Name	Description
input - CollectionsInput!

Example

Query

query Collections($input: CollectionsInput!) {
  collections(input: $input) {
    id
    owner
    tokens {
      id
      tokenId
      collectionContract {
        ...CollectionFragment
      }
      minter
      enterprise {
        ...CollectionEntityFragment
      }
      artist {
        ...CollectionEntityFragment
      }
      amount
      royaltyRecipient
      royaltyNumerator
      owners {
        ...TokenOwnerFragment
      }
      ownersWithMetadata {
        ...OwnerWithMetadataFragment
      }
      listing {
        ...ListingFragment
      }
      purchases {
        ...PurchaseFragment
      }
      tokenURI
      metadata {
        ...NftMetadataDTOFragment
      }
      nftUrl
      coverUrl
      networkName
      createdAt
      updatedAt
    }
    address
    contractURI
    networkName
    metadata {
      id
      userSub
      name
      symbol
      description
      coverImageS3Key
      coverImageS3Url
      coverImageIpfsUrl
      coverImageIpfsHash
      bannerImageS3Key
      bannerImageS3Url
      bannerImageIpfsHash
      bannerImageIpfsUrl
      externalLink
      defaultRoyalties
      defaultRoyaltyRecipient
      metadataIpfsHash
      metadataIpfsUrl
      networkName
      status
    }
    createdAt
    updatedAt
  }
}

Variables

{"input": CollectionsInput}

Response

{
  "data": {
    "collections": [
      {
        "id": "xyz789",
        "owner": "xyz789",
        "tokens": [Token],
        "address": "xyz789",
        "contractURI": "abc123",
        "networkName": "ropsten",
        "metadata": CollectionMetadataDto,
        "createdAt": "xyz789",
        "updatedAt": "abc123"
      }
    ]
  }
}

Queries

currentPerson

Description

🔒 JWT Token

Returns person from the context

Response

Returns a PersonDto!

Example

Query

query CurrentPerson {
  currentPerson {
    id
    walletAddress
    smartWalletAddress
    username
    avatarS3Key
    avatarUrl
  }
}

Response

{
  "data": {
    "currentPerson": {
      "id": "abc123",
      "walletAddress": "abc123",
      "smartWalletAddress": "xyz789",
      "username": "abc123",
      "avatarS3Key": "abc123",
      "avatarUrl": "xyz789"
    }
  }
}

Queries

fees

Description

🔓 Public

Returns market fees

Response

Returns a Fees!

Arguments

Name	Description
network - NetworkName!

Example

Query

query Fees($network: NetworkName!) {
  fees(network: $network) {
    mintingFee
    sellingFee
  }
}

Variables

{"network": "ropsten"}

Response

{
  "data": {
    "fees": {
      "mintingFee": "xyz789",
      "sellingFee": "xyz789"
    }
  }
}

Queries

listCollectionMetadata

Description

🔒 JWT Token

Returns list of collection metadata

Response

Returns a CollectionMetadataListResDTO!

Arguments

Name	Description
pagination - PaginationParams!

Example

Query

query ListCollectionMetadata($pagination: PaginationParams!) {
  listCollectionMetadata(pagination: $pagination) {
    items {
      id
      userSub
      name
      symbol
      description
      coverImageS3Key
      coverImageS3Url
      coverImageIpfsUrl
      coverImageIpfsHash
      bannerImageS3Key
      bannerImageS3Url
      bannerImageIpfsHash
      bannerImageIpfsUrl
      externalLink
      defaultRoyalties
      defaultRoyaltyRecipient
      metadataIpfsHash
      metadataIpfsUrl
      networkName
      status
    }
    count
  }
}

Variables

{"pagination": PaginationParams}

Response

{
  "data": {
    "listCollectionMetadata": {
      "items": [CollectionMetadataDto],
      "count": 123.45
    }
  }
}

Queries

listMetadata

Description

🔒 JWT Token

Returns list of NFT metadata

Response

Returns a NftMetadataListResDTO!

Arguments

Name	Description
pagination - PaginationParams!

Example

Query

query ListMetadata($pagination: PaginationParams!) {
  listMetadata(pagination: $pagination) {
    items {
      id
      fileName
      title
      description
      artistId
      fileType
      networkName
      backgroundColor
      externalUrl
      youtubeUrl
      attributes {
        ...NftMetadataAttributeObjectFragment
      }
    }
    count
  }
}

Variables

{"pagination": PaginationParams}

Response

{
  "data": {
    "listMetadata": {
      "items": [NftMetadataDraftResDTO],
      "count": 123.45
    }
  }
}

Queries

metadata

Description

🔒 JWT Token

Retrieve metadata by id

Response

Returns a NftMetadataDTO!

Arguments

Name	Description
id - Float!

Example

Query

query Metadata($id: Float!) {
  metadata(id: $id) {
    id
    userSub
    title
    description
    artistId
    fileType
    networkName
    s3Key
    s3CoverKey
    ipfsNftUrl
    ipfsCoverUrl
    ipfsMetadataUrl
    ipfsNftHash
    ipfsCoverHash
    licenceS3Key
    ipfsLicenceHash
    nftLicence {
      revelatorTermsAndConditions
      nftTitle
      label
      royaltyRate
      personalUses {
        ...NftUseDTOFragment
      }
      commercialUses {
        ...NftUseDTOFragment
      }
    }
    ipfsMetadataHash
    status
    backgroundColor
    externalUrl
    youtubeUrl
    attributes {
      value
      traitType
      displayType
    }
    ipfsNftPublicUrl
    ipfsCoverPublicUrl
    ipfsMetadataPublicUrl
    ipfsLicencePublicUrl
  }
}

Variables

{"id": 123.45}

Response

{
  "data": {
    "metadata": {
      "id": 987,
      "userSub": "xyz789",
      "title": "abc123",
      "description": "abc123",
      "artistId": "abc123",
      "fileType": "IMAGE",
      "networkName": "ropsten",
      "s3Key": "xyz789",
      "s3CoverKey": "abc123",
      "ipfsNftUrl": "xyz789",
      "ipfsCoverUrl": "xyz789",
      "ipfsMetadataUrl": "abc123",
      "ipfsNftHash": "xyz789",
      "ipfsCoverHash": "xyz789",
      "licenceS3Key": "xyz789",
      "ipfsLicenceHash": "xyz789",
      "nftLicence": NftLicenceDto,
      "ipfsMetadataHash": "abc123",
      "status": "PENDING_UPLOAD",
      "backgroundColor": "abc123",
      "externalUrl": "xyz789",
      "youtubeUrl": "xyz789",
      "attributes": [NftMetadataAttributeObject],
      "ipfsNftPublicUrl": "xyz789",
      "ipfsCoverPublicUrl": "abc123",
      "ipfsMetadataPublicUrl": "xyz789",
      "ipfsLicencePublicUrl": "abc123"
    }
  }
}

Queries

nftUses

Description

🔒 JWT Token

Licensed nft buyer rights

Response

Returns a NftUsesDTO!

Example

Query

query NftUses {
  nftUses {
    list {
      id
      name
      description
      position
      nftUseType
    }
  }
}

Response

{"data": {"nftUses": {"list": [NftUseDTO]}}}

Queries

person

Description

🔓 Public

Returns single person

Response

Returns a PersonDto

Arguments

Name	Description
identifier - PersonIdentifier!

Example

Query

query Person($identifier: PersonIdentifier!) {
  person(identifier: $identifier) {
    id
    walletAddress
    smartWalletAddress
    username
    avatarS3Key
    avatarUrl
  }
}

Variables

{"identifier": PersonIdentifier}

Response

{
  "data": {
    "person": {
      "id": "abc123",
      "walletAddress": "abc123",
      "smartWalletAddress": "abc123",
      "username": "xyz789",
      "avatarS3Key": "abc123",
      "avatarUrl": "abc123"
    }
  }
}

Queries

persons

Description

🔓 Public

Returns persons

Response

Returns a Persons!

Arguments

Name	Description
pagination - PaginationParams!

Example

Query

query Persons($pagination: PaginationParams!) {
  persons(pagination: $pagination) {
    items {
      id
      walletAddress
      smartWalletAddress
      username
      avatarS3Key
      avatarUrl
    }
    count
  }
}

Variables

{"pagination": PaginationParams}

Response

{
  "data": {
    "persons": {"items": [PersonDto], "count": 987.65}
  }
}

Queries

token

Description

🔓 Public

Returns single token

Response

Returns a Token

Arguments

Name	Description
network - NetworkName!
id - String!

Example

Query

query Token(
  $network: NetworkName!,
  $id: String!
) {
  token(
    network: $network,
    id: $id
  ) {
    id
    tokenId
    collectionContract {
      id
      owner
      tokens {
        ...TokenFragment
      }
      address
      contractURI
      networkName
      metadata {
        ...CollectionMetadataDtoFragment
      }
      createdAt
      updatedAt
    }
    minter
    enterprise {
      id
      type
      entityUri
      name
      description
      avatarUrl
      bannerUrl
      createdAt
      updatedAt
    }
    artist {
      id
      type
      entityUri
      name
      description
      avatarUrl
      bannerUrl
      createdAt
      updatedAt
    }
    amount
    royaltyRecipient
    royaltyNumerator
    owners {
      id
      owner {
        ...OwnerFragment
      }
      amountOwned
      amountDeposited
    }
    ownersWithMetadata {
      amountOwned
      amountDeposited
      id
      walletAddress
      smartWalletAddress
      username
      avatarS3Key
      avatarUrl
    }
    listing {
      id
      onSale
      seller {
        ...OwnerFragment
      }
      salePrice
      amountListed
      amountRemaining
      createdAt
      updatedAt
    }
    purchases {
      id
      amount
      salePrice
      value
      buyer {
        ...OwnerFragment
      }
      createdAt
    }
    tokenURI
    metadata {
      id
      userSub
      title
      description
      artistId
      fileType
      networkName
      s3Key
      s3CoverKey
      ipfsNftUrl
      ipfsCoverUrl
      ipfsMetadataUrl
      ipfsNftHash
      ipfsCoverHash
      licenceS3Key
      ipfsLicenceHash
      nftLicence {
        ...NftLicenceDtoFragment
      }
      ipfsMetadataHash
      status
      backgroundColor
      externalUrl
      youtubeUrl
      attributes {
        ...NftMetadataAttributeObjectFragment
      }
      ipfsNftPublicUrl
      ipfsCoverPublicUrl
      ipfsMetadataPublicUrl
      ipfsLicencePublicUrl
    }
    nftUrl
    coverUrl
    networkName
    createdAt
    updatedAt
  }
}

Variables

{"network": "ropsten", "id": "xyz789"}

Response

{
  "data": {
    "token": {
      "id": "abc123",
      "tokenId": "abc123",
      "collectionContract": Collection,
      "minter": "xyz789",
      "enterprise": CollectionEntity,
      "artist": CollectionEntity,
      "amount": "xyz789",
      "royaltyRecipient": "xyz789",
      "royaltyNumerator": "xyz789",
      "owners": [TokenOwner],
      "ownersWithMetadata": [OwnerWithMetadata],
      "listing": Listing,
      "purchases": [Purchase],
      "tokenURI": "abc123",
      "metadata": NftMetadataDTO,
      "nftUrl": "xyz789",
      "coverUrl": "abc123",
      "networkName": "ropsten",
      "createdAt": "abc123",
      "updatedAt": "abc123"
    }
  }
}

Queries

tokens

Description

🔓 Public

Returns tokens

Response

Returns [Token!]!

Arguments

Name	Description
input - tokensInput!

Example

Query

query Tokens($input: tokensInput!) {
  tokens(input: $input) {
    id
    tokenId
    collectionContract {
      id
      owner
      tokens {
        ...TokenFragment
      }
      address
      contractURI
      networkName
      metadata {
        ...CollectionMetadataDtoFragment
      }
      createdAt
      updatedAt
    }
    minter
    enterprise {
      id
      type
      entityUri
      name
      description
      avatarUrl
      bannerUrl
      createdAt
      updatedAt
    }
    artist {
      id
      type
      entityUri
      name
      description
      avatarUrl
      bannerUrl
      createdAt
      updatedAt
    }
    amount
    royaltyRecipient
    royaltyNumerator
    owners {
      id
      owner {
        ...OwnerFragment
      }
      amountOwned
      amountDeposited
    }
    ownersWithMetadata {
      amountOwned
      amountDeposited
      id
      walletAddress
      smartWalletAddress
      username
      avatarS3Key
      avatarUrl
    }
    listing {
      id
      onSale
      seller {
        ...OwnerFragment
      }
      salePrice
      amountListed
      amountRemaining
      createdAt
      updatedAt
    }
    purchases {
      id
      amount
      salePrice
      value
      buyer {
        ...OwnerFragment
      }
      createdAt
    }
    tokenURI
    metadata {
      id
      userSub
      title
      description
      artistId
      fileType
      networkName
      s3Key
      s3CoverKey
      ipfsNftUrl
      ipfsCoverUrl
      ipfsMetadataUrl
      ipfsNftHash
      ipfsCoverHash
      licenceS3Key
      ipfsLicenceHash
      nftLicence {
        ...NftLicenceDtoFragment
      }
      ipfsMetadataHash
      status
      backgroundColor
      externalUrl
      youtubeUrl
      attributes {
        ...NftMetadataAttributeObjectFragment
      }
      ipfsNftPublicUrl
      ipfsCoverPublicUrl
      ipfsMetadataPublicUrl
      ipfsLicencePublicUrl
    }
    nftUrl
    coverUrl
    networkName
    createdAt
    updatedAt
  }
}

Variables

{"input": tokensInput}

Response

{
  "data": {
    "tokens": [
      {
        "id": "xyz789",
        "tokenId": "xyz789",
        "collectionContract": Collection,
        "minter": "abc123",
        "enterprise": CollectionEntity,
        "artist": CollectionEntity,
        "amount": "abc123",
        "royaltyRecipient": "abc123",
        "royaltyNumerator": "abc123",
        "owners": [TokenOwner],
        "ownersWithMetadata": [OwnerWithMetadata],
        "listing": Listing,
        "purchases": [Purchase],
        "tokenURI": "abc123",
        "metadata": NftMetadataDTO,
        "nftUrl": "abc123",
        "coverUrl": "xyz789",
        "networkName": "ropsten",
        "createdAt": "xyz789",
        "updatedAt": "abc123"
      }
    ]
  }
}

Mutations

createAvatarUrl

Description

🔒 JWT Token

Creates Avatar URL

Response

Returns an AvatarLinkResDTO!

Arguments

Name	Description
avatarLink - AvatarLinkReqDTO!

Example

Query

mutation CreateAvatarUrl($avatarLink: AvatarLinkReqDTO!) {
  createAvatarUrl(avatarLink: $avatarLink) {
    avatarUploadUrl
  }
}

Variables

{"avatarLink": AvatarLinkReqDTO}

Response

{
  "data": {
    "createAvatarUrl": {
      "avatarUploadUrl": "abc123"
    }
  }
}

Mutations

createCollectionAssetsUploadUrl

Description

🔒 JWT Token

Creates Metadata URL

Response

Returns a CollectionMetadataLinkResDTO!

Arguments

Name	Description
collectionMetadataLink - CollectionMetadataLinkReqDTO!
id - Float!	id of the collection-metadata draft

Example

Query

mutation CreateCollectionAssetsUploadUrl(
  $collectionMetadataLink: CollectionMetadataLinkReqDTO!,
  $id: Float!
) {
  createCollectionAssetsUploadUrl(
    collectionMetadataLink: $collectionMetadataLink,
    id: $id
  ) {
    coverUploadUrl
    bannerUploadUrl
  }
}

Variables

{
  "collectionMetadataLink": CollectionMetadataLinkReqDTO,
  "id": 123.45
}

Response

{
  "data": {
    "createCollectionAssetsUploadUrl": {
      "coverUploadUrl": "xyz789",
      "bannerUploadUrl": "xyz789"
    }
  }
}

Mutations

createUrl

Description

🔒 JWT Token

Creates Metadata URL

Response

Returns a NftMetadataLinkResDTO!

Arguments

Name	Description
nftMetadataLink - NftMetadataLinkReqDTO!
id - Float!	id of the nft-metadata draft

Example

Query

mutation CreateUrl(
  $nftMetadataLink: NftMetadataLinkReqDTO!,
  $id: Float!
) {
  createUrl(
    nftMetadataLink: $nftMetadataLink,
    id: $id
  ) {
    uploadUrl
    coverUploadUrl
  }
}

Variables

{"nftMetadataLink": NftMetadataLinkReqDTO, "id": 123.45}

Response

{
  "data": {
    "createUrl": {
      "uploadUrl": "xyz789",
      "coverUploadUrl": "xyz789"
    }
  }
}

Mutations

saveCollectionDraft

Description

🔒 JWT Token

Save collection metadata as a draft. Does not deploy an NFT contract. You can edit the data.

Response

Returns a CollectionMetadataDto!

Arguments

Name	Description
collectionMetadataDraft - CollectionMetadataDraftReqDTO!

Example

Query

mutation SaveCollectionDraft($collectionMetadataDraft: CollectionMetadataDraftReqDTO!) {
  saveCollectionDraft(collectionMetadataDraft: $collectionMetadataDraft) {
    id
    userSub
    name
    symbol
    description
    coverImageS3Key
    coverImageS3Url
    coverImageIpfsUrl
    coverImageIpfsHash
    bannerImageS3Key
    bannerImageS3Url
    bannerImageIpfsHash
    bannerImageIpfsUrl
    externalLink
    defaultRoyalties
    defaultRoyaltyRecipient
    metadataIpfsHash
    metadataIpfsUrl
    networkName
    status
  }
}

Variables

{"collectionMetadataDraft": CollectionMetadataDraftReqDTO}

Response

{
  "data": {
    "saveCollectionDraft": {
      "id": 987,
      "userSub": "xyz789",
      "name": "abc123",
      "symbol": "abc123",
      "description": "abc123",
      "coverImageS3Key": "xyz789",
      "coverImageS3Url": "xyz789",
      "coverImageIpfsUrl": "abc123",
      "coverImageIpfsHash": "xyz789",
      "bannerImageS3Key": "xyz789",
      "bannerImageS3Url": "xyz789",
      "bannerImageIpfsHash": "xyz789",
      "bannerImageIpfsUrl": "abc123",
      "externalLink": "xyz789",
      "defaultRoyalties": "xyz789",
      "defaultRoyaltyRecipient": "abc123",
      "metadataIpfsHash": "xyz789",
      "metadataIpfsUrl": "abc123",
      "networkName": "ropsten",
      "status": "PENDING_UPLOAD"
    }
  }
}

Mutations

saveDraft

Description

🔒 JWT Token

Save nft metadata as a draft. Does not create a token. You can edit the data.

Response

Returns a NftMetadataDraftResDTO!

Arguments

Name	Description
nftMetadataDraft - NftMetadataDraftReqDTO!

Example

Query

mutation SaveDraft($nftMetadataDraft: NftMetadataDraftReqDTO!) {
  saveDraft(nftMetadataDraft: $nftMetadataDraft) {
    id
    fileName
    title
    description
    artistId
    fileType
    networkName
    backgroundColor
    externalUrl
    youtubeUrl
    attributes {
      value
      traitType
      displayType
    }
  }
}

Variables

{"nftMetadataDraft": NftMetadataDraftReqDTO}

Response

{
  "data": {
    "saveDraft": {
      "id": 123.45,
      "fileName": "xyz789",
      "title": "xyz789",
      "description": "xyz789",
      "artistId": "abc123",
      "fileType": "IMAGE",
      "networkName": "ropsten",
      "backgroundColor": "abc123",
      "externalUrl": "abc123",
      "youtubeUrl": "xyz789",
      "attributes": [NftMetadataAttributeObject]
    }
  }
}

Mutations

updateCollectionDraft

Description

🔒 JWT Token

Updates collection metadata draft

Response

Returns a CollectionMetadataDto!

Arguments

Name	Description
collectionMetadataDraft - CollectionMetadataDraftReqDTO!
id - Float!

Example

Query

mutation UpdateCollectionDraft(
  $collectionMetadataDraft: CollectionMetadataDraftReqDTO!,
  $id: Float!
) {
  updateCollectionDraft(
    collectionMetadataDraft: $collectionMetadataDraft,
    id: $id
  ) {
    id
    userSub
    name
    symbol
    description
    coverImageS3Key
    coverImageS3Url
    coverImageIpfsUrl
    coverImageIpfsHash
    bannerImageS3Key
    bannerImageS3Url
    bannerImageIpfsHash
    bannerImageIpfsUrl
    externalLink
    defaultRoyalties
    defaultRoyaltyRecipient
    metadataIpfsHash
    metadataIpfsUrl
    networkName
    status
  }
}

Variables

{
  "collectionMetadataDraft": CollectionMetadataDraftReqDTO,
  "id": 123.45
}

Response

{
  "data": {
    "updateCollectionDraft": {
      "id": 987,
      "userSub": "xyz789",
      "name": "xyz789",
      "symbol": "xyz789",
      "description": "abc123",
      "coverImageS3Key": "xyz789",
      "coverImageS3Url": "abc123",
      "coverImageIpfsUrl": "abc123",
      "coverImageIpfsHash": "abc123",
      "bannerImageS3Key": "xyz789",
      "bannerImageS3Url": "abc123",
      "bannerImageIpfsHash": "abc123",
      "bannerImageIpfsUrl": "abc123",
      "externalLink": "abc123",
      "defaultRoyalties": "xyz789",
      "defaultRoyaltyRecipient": "xyz789",
      "metadataIpfsHash": "abc123",
      "metadataIpfsUrl": "xyz789",
      "networkName": "ropsten",
      "status": "PENDING_UPLOAD"
    }
  }
}

Mutations

updateDraft

Description

🔒 JWT Token

Updates nft metadata draft

Response

Returns a NftMetadataDraftResDTO!

Arguments

Name	Description
updateNFTMetadataDraft - NftMetadataDraftReqDTO!
id - Float!

Example

Query

mutation UpdateDraft(
  $updateNFTMetadataDraft: NftMetadataDraftReqDTO!,
  $id: Float!
) {
  updateDraft(
    updateNFTMetadataDraft: $updateNFTMetadataDraft,
    id: $id
  ) {
    id
    fileName
    title
    description
    artistId
    fileType
    networkName
    backgroundColor
    externalUrl
    youtubeUrl
    attributes {
      value
      traitType
      displayType
    }
  }
}

Variables

{
  "updateNFTMetadataDraft": NftMetadataDraftReqDTO,
  "id": 987.65
}

Response

{
  "data": {
    "updateDraft": {
      "id": 987.65,
      "fileName": "xyz789",
      "title": "xyz789",
      "description": "abc123",
      "artistId": "abc123",
      "fileType": "IMAGE",
      "networkName": "ropsten",
      "backgroundColor": "xyz789",
      "externalUrl": "abc123",
      "youtubeUrl": "abc123",
      "attributes": [NftMetadataAttributeObject]
    }
  }
}

Mutations

updatePerson

Description

🔒 JWT Token

Updates person

Response

Returns a PersonDto!

Arguments

Name	Description
updatePerson - UpdatePerson!

Example

Query

mutation UpdatePerson($updatePerson: UpdatePerson!) {
  updatePerson(updatePerson: $updatePerson) {
    id
    walletAddress
    smartWalletAddress
    username
    avatarS3Key
    avatarUrl
  }
}

Variables

{"updatePerson": UpdatePerson}

Response

{
  "data": {
    "updatePerson": {
      "id": "xyz789",
      "walletAddress": "xyz789",
      "smartWalletAddress": "xyz789",
      "username": "xyz789",
      "avatarS3Key": "abc123",
      "avatarUrl": "abc123"
    }
  }
}

Types

AddressResolverType

Values

Enum Value	Description
PERSON_ID
OWNER_URI

Example

"PERSON_ID"

Types

AvatarLinkReqDTO

Fields

Input Field	Description
fileName - String!	the file name must contain its extension -> [name].jpg
contentType - String!	mime type of the avatar file -> image/jpeg

Example

{
  "fileName": "xyz789",
  "contentType": "xyz789"
}

Types

AvatarLinkResDTO

Fields

Field Name	Description
avatarUploadUrl - String!

Example

{"avatarUploadUrl": "xyz789"}

Types

BigInt

Example

{}

Types

BlockChangedFilter

Fields

Input Field	Description
number_gte - Int!

Example

{"number_gte": 987}

Types

Block_height

Fields

Input Field	Description
hash - Bytes
number - Int
number_gte - Int

Example

{"hash": Bytes, "number": 987, "number_gte": 987}

Types

Boolean

Description

The Boolean scalar type represents true or false.

Types

Bytes

Example

Bytes

Types

Collection

Fields

Field Name	Description
id - String!
owner - String!
tokens - [Token!]
address - String!
contractURI - String!
networkName - NetworkName!
metadata - CollectionMetadataDto
createdAt - String!
updatedAt - String!

Example

{
  "id": "abc123",
  "owner": "xyz789",
  "tokens": [Token],
  "address": "xyz789",
  "contractURI": "xyz789",
  "networkName": "ropsten",
  "metadata": CollectionMetadataDto,
  "createdAt": "abc123",
  "updatedAt": "abc123"
}

Types

CollectionContract_filter

Fields

Input Field	Description
_change_block - BlockChangedFilter	Filter for the block changed event.
address - Bytes
address_contains - Bytes
address_gt - Bytes
address_gte - Bytes
address_in - [Bytes!]
address_lt - Bytes
address_lte - Bytes
address_not - Bytes
address_not_contains - Bytes
address_not_in - [Bytes!]
and - [CollectionContract_filter]
contractURI - String
contractURI_contains - String
contractURI_contains_nocase - String
contractURI_ends_with - String
contractURI_ends_with_nocase - String
contractURI_gt - String
contractURI_gte - String
contractURI_in - [String!]
contractURI_lt - String
contractURI_lte - String
contractURI_not - String
contractURI_not_contains - String
contractURI_not_contains_nocase - String
contractURI_not_ends_with - String
contractURI_not_ends_with_nocase - String
contractURI_not_in - [String!]
contractURI_not_starts_with - String
contractURI_not_starts_with_nocase - String
contractURI_starts_with - String
contractURI_starts_with_nocase - String
createdAt - String
createdAt_contains - String
createdAt_contains_nocase - String
createdAt_ends_with - String
createdAt_ends_with_nocase - String
createdAt_gt - String
createdAt_gte - String
createdAt_in - [String!]
createdAt_lt - String
createdAt_lte - String
createdAt_not - String
createdAt_not_contains - String
createdAt_not_contains_nocase - String
createdAt_not_ends_with - String
createdAt_not_ends_with_nocase - String
createdAt_not_in - [String!]
createdAt_not_starts_with - String
createdAt_not_starts_with_nocase - String
createdAt_starts_with - String
createdAt_starts_with_nocase - String
id - ID
id_gt - ID
id_gte - ID
id_in - [ID!]
id_lt - ID
id_lte - ID
id_not - ID
id_not_in - [ID!]
or - [CollectionContract_filter]
owner - Bytes
owner_contains - Bytes
owner_gt - Bytes
owner_gte - Bytes
owner_in - [Bytes!]
owner_lt - Bytes
owner_lte - Bytes
owner_not - Bytes
owner_not_contains - Bytes
owner_not_in - [Bytes!]
tokens_ - Token_filter
updatedAt - String
updatedAt_contains - String
updatedAt_contains_nocase - String
updatedAt_ends_with - String
updatedAt_ends_with_nocase - String
updatedAt_gt - String
updatedAt_gte - String
updatedAt_in - [String!]
updatedAt_lt - String
updatedAt_lte - String
updatedAt_not - String
updatedAt_not_contains - String
updatedAt_not_contains_nocase - String
updatedAt_not_ends_with - String
updatedAt_not_ends_with_nocase - String
updatedAt_not_in - [String!]
updatedAt_not_starts_with - String
updatedAt_not_starts_with_nocase - String
updatedAt_starts_with - String
updatedAt_starts_with_nocase - String

Example

{
  "_change_block": BlockChangedFilter,
  "address": Bytes,
  "address_contains": Bytes,
  "address_gt": Bytes,
  "address_gte": Bytes,
  "address_in": [Bytes],
  "address_lt": Bytes,
  "address_lte": Bytes,
  "address_not": Bytes,
  "address_not_contains": Bytes,
  "address_not_in": [Bytes],
  "and": [CollectionContract_filter],
  "contractURI": "abc123",
  "contractURI_contains": "abc123",
  "contractURI_contains_nocase": "xyz789",
  "contractURI_ends_with": "xyz789",
  "contractURI_ends_with_nocase": "xyz789",
  "contractURI_gt": "abc123",
  "contractURI_gte": "abc123",
  "contractURI_in": ["xyz789"],
  "contractURI_lt": "abc123",
  "contractURI_lte": "abc123",
  "contractURI_not": "xyz789",
  "contractURI_not_contains": "xyz789",
  "contractURI_not_contains_nocase": "abc123",
  "contractURI_not_ends_with": "xyz789",
  "contractURI_not_ends_with_nocase": "abc123",
  "contractURI_not_in": ["abc123"],
  "contractURI_not_starts_with": "xyz789",
  "contractURI_not_starts_with_nocase": "xyz789",
  "contractURI_starts_with": "xyz789",
  "contractURI_starts_with_nocase": "abc123",
  "createdAt": "abc123",
  "createdAt_contains": "abc123",
  "createdAt_contains_nocase": "abc123",
  "createdAt_ends_with": "xyz789",
  "createdAt_ends_with_nocase": "abc123",
  "createdAt_gt": "xyz789",
  "createdAt_gte": "abc123",
  "createdAt_in": ["xyz789"],
  "createdAt_lt": "xyz789",
  "createdAt_lte": "xyz789",
  "createdAt_not": "abc123",
  "createdAt_not_contains": "abc123",
  "createdAt_not_contains_nocase": "xyz789",
  "createdAt_not_ends_with": "abc123",
  "createdAt_not_ends_with_nocase": "abc123",
  "createdAt_not_in": ["xyz789"],
  "createdAt_not_starts_with": "xyz789",
  "createdAt_not_starts_with_nocase": "abc123",
  "createdAt_starts_with": "abc123",
  "createdAt_starts_with_nocase": "abc123",
  "id": 4,
  "id_gt": 4,
  "id_gte": "4",
  "id_in": ["4"],
  "id_lt": 4,
  "id_lte": "4",
  "id_not": "4",
  "id_not_in": ["4"],
  "or": [CollectionContract_filter],
  "owner": Bytes,
  "owner_contains": Bytes,
  "owner_gt": Bytes,
  "owner_gte": Bytes,
  "owner_in": [Bytes],
  "owner_lt": Bytes,
  "owner_lte": Bytes,
  "owner_not": Bytes,
  "owner_not_contains": Bytes,
  "owner_not_in": [Bytes],
  "tokens_": Token_filter,
  "updatedAt": "abc123",
  "updatedAt_contains": "abc123",
  "updatedAt_contains_nocase": "abc123",
  "updatedAt_ends_with": "xyz789",
  "updatedAt_ends_with_nocase": "xyz789",
  "updatedAt_gt": "abc123",
  "updatedAt_gte": "xyz789",
  "updatedAt_in": ["xyz789"],
  "updatedAt_lt": "xyz789",
  "updatedAt_lte": "abc123",
  "updatedAt_not": "abc123",
  "updatedAt_not_contains": "xyz789",
  "updatedAt_not_contains_nocase": "xyz789",
  "updatedAt_not_ends_with": "abc123",
  "updatedAt_not_ends_with_nocase": "abc123",
  "updatedAt_not_in": ["abc123"],
  "updatedAt_not_starts_with": "xyz789",
  "updatedAt_not_starts_with_nocase": "abc123",
  "updatedAt_starts_with": "abc123",
  "updatedAt_starts_with_nocase": "abc123"
}

Types

CollectionContract_orderBy

Values

Enum Value	Description
address
contractURI
createdAt
id
owner
tokens
updatedAt

Example

"address"

Types

CollectionEntity

Description

represents an element of the hierarchy within the enterprise.

Fields

Field Name	Description
id - ID!	Auto-incrementing identifier.
type - CollectionEntityType!	Specifies the type of entry. Represents the hierarchy level within the enterprise.
entityUri - String	Tenant ID to which artists, enterprise and labels belong.
name - String!	Entity name.
description - String	Entity description.
avatarUrl - String	avatar url, displayed on the storefront.
bannerUrl - String	banner url, displayed on the storefront.
createdAt - String!	Time at which the object was created.
updatedAt - String!	Time at which the object was last updated.

Example

{
  "id": "4",
  "type": "ENTERPRISE",
  "entityUri": "xyz789",
  "name": "abc123",
  "description": "abc123",
  "avatarUrl": "abc123",
  "bannerUrl": "abc123",
  "createdAt": "abc123",
  "updatedAt": "xyz789"
}

Types

CollectionEntityType

Values

Enum Value	Description
ENTERPRISE
ARTIST
LABEL

Example

"ENTERPRISE"

Types

CollectionMetadataDraftReqDTO

Fields

Input Field	Description
name - String!
symbol - String
description - String
externalLink - String
defaultRoyalties - String
defaultRoyaltyRecipient - String
networkName - NetworkName!

Example

{
  "name": "xyz789",
  "symbol": "xyz789",
  "description": "xyz789",
  "externalLink": "abc123",
  "defaultRoyalties": "abc123",
  "defaultRoyaltyRecipient": "abc123",
  "networkName": "ropsten"
}

Types

CollectionMetadataDto

Fields

Field Name	Description
id - Int	id of the collection
userSub - String	sub of the user
name - String	name of the collection
symbol - String	symbol of the collection
description - String	description of the collection
coverImageS3Key - String	s3 key of the cover image
coverImageS3Url - String	s3 link of the cover image
coverImageIpfsUrl - String	ipfs link of the cover image
coverImageIpfsHash - String	ipfs hash of the cover image
bannerImageS3Key - String	s3 key of the banner image
bannerImageS3Url - String	s3 link of the banner image
bannerImageIpfsHash - String	ipfs hash of the banner image
bannerImageIpfsUrl - String	ipfs link of the banner image
externalLink - String	external link of the collection
defaultRoyalties - String	default royalty basis point
defaultRoyaltyRecipient - String	default royalty recipient
metadataIpfsHash - String	ipfs link of contract level metadata
metadataIpfsUrl - String	ipfs link of contract level metadata
networkName - NetworkName	name of the network
status - FileStatus	status of the uploading files

Example

{
  "id": 123,
  "userSub": "xyz789",
  "name": "xyz789",
  "symbol": "abc123",
  "description": "abc123",
  "coverImageS3Key": "abc123",
  "coverImageS3Url": "abc123",
  "coverImageIpfsUrl": "abc123",
  "coverImageIpfsHash": "abc123",
  "bannerImageS3Key": "xyz789",
  "bannerImageS3Url": "abc123",
  "bannerImageIpfsHash": "abc123",
  "bannerImageIpfsUrl": "xyz789",
  "externalLink": "abc123",
  "defaultRoyalties": "xyz789",
  "defaultRoyaltyRecipient": "xyz789",
  "metadataIpfsHash": "abc123",
  "metadataIpfsUrl": "abc123",
  "networkName": "ropsten",
  "status": "PENDING_UPLOAD"
}

Types

CollectionMetadataLinkReqDTO

Fields

Input Field	Description
coverFileName - String!	the cover of the collection | the cover name must contain its extension -> [name].jpg
coverFileMimeType - String!	mime type of the collection cover file -> image/jpeg
bannerFileName - String	the banner of the collection | the banner name must contain its extension -> [name].jpg
bannerFileMimeType - String	mime type of the collection banner file -> image/jpeg

Example

{
  "coverFileName": "abc123",
  "coverFileMimeType": "abc123",
  "bannerFileName": "xyz789",
  "bannerFileMimeType": "xyz789"
}

Types

CollectionMetadataLinkResDTO

Fields

Field Name	Description
coverUploadUrl - String
bannerUploadUrl - String

Example

{
  "coverUploadUrl": "xyz789",
  "bannerUploadUrl": "abc123"
}

Types

CollectionMetadataListResDTO

Fields

Field Name	Description
items - [CollectionMetadataDto!]!
count - Float

Example

{"items": [CollectionMetadataDto], "count": 123.45}

Types

CollectionsInput

Fields

Input Field	Description
network - NetworkName!	Name of the blockchain network on which the transaction occurs
ownedBy - OwnedBy	Parameters filtering collections by owner. One collection can have only one owner.
queryParams - collectionContractsQueryArgs	Parameters filtering collections from subgraph.

Example

{
  "network": "ropsten",
  "ownedBy": OwnedBy,
  "queryParams": collectionContractsQueryArgs
}

Types

DisplayType

Values

Enum Value	Description
DATE
NUMBER
BOOST_NUMBER
BOOST_PERCENTAGE

Example

"DATE"

Types

Fees

Fields

Field Name	Description
mintingFee - String!
sellingFee - String!

Example

{
  "mintingFee": "abc123",
  "sellingFee": "abc123"
}

Types

FileStatus

Values

Enum Value	Description
PENDING_UPLOAD
UPLOADED
DRAFT

Example

"PENDING_UPLOAD"

Types

FileType

Values

Enum Value	Description
IMAGE
MEDIA

Example

"IMAGE"

Types

Float

Description

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Example

123.45

Types

ID

Description

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

Example

"4"

Types

Int

Description

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Example

987

Types

Listing

Fields

Field Name	Description
id - String!
onSale - Boolean!
seller - Owner!
salePrice - String!
amountListed - String!
amountRemaining - String!
createdAt - String!
updatedAt - String!

Example

{
  "id": "xyz789",
  "onSale": true,
  "seller": Owner,
  "salePrice": "xyz789",
  "amountListed": "abc123",
  "amountRemaining": "abc123",
  "createdAt": "abc123",
  "updatedAt": "xyz789"
}

Types

Listing_filter

Fields

Input Field	Description
_change_block - BlockChangedFilter	Filter for the block changed event.
amountListed - BigInt
amountListed_gt - BigInt
amountListed_gte - BigInt
amountListed_in - [BigInt!]
amountListed_lt - BigInt
amountListed_lte - BigInt
amountListed_not - BigInt
amountListed_not_in - [BigInt!]
amountRemaining - BigInt
amountRemaining_gt - BigInt
amountRemaining_gte - BigInt
amountRemaining_in - [BigInt!]
amountRemaining_lt - BigInt
amountRemaining_lte - BigInt
amountRemaining_not - BigInt
amountRemaining_not_in - [BigInt!]
and - [Listing_filter]
createdAt - String
createdAt_contains - String
createdAt_contains_nocase - String
createdAt_ends_with - String
createdAt_ends_with_nocase - String
createdAt_gt - String
createdAt_gte - String
createdAt_in - [String!]
createdAt_lt - String
createdAt_lte - String
createdAt_not - String
createdAt_not_contains - String
createdAt_not_contains_nocase - String
createdAt_not_ends_with - String
createdAt_not_ends_with_nocase - String
createdAt_not_in - [String!]
createdAt_not_starts_with - String
createdAt_not_starts_with_nocase - String
createdAt_starts_with - String
createdAt_starts_with_nocase - String
id - ID
id_gt - ID
id_gte - ID
id_in - [ID!]
id_lt - ID
id_lte - ID
id_not - ID
id_not_in - [ID!]
onSale - Boolean
onSale_in - [Boolean!]
onSale_not - Boolean
onSale_not_in - [Boolean!]
or - [Listing_filter]
salePrice - BigInt
salePrice_gt - BigInt
salePrice_gte - BigInt
salePrice_in - [BigInt!]
salePrice_lt - BigInt
salePrice_lte - BigInt
salePrice_not - BigInt
salePrice_not_in - [BigInt!]
seller - String
seller_ - Owner_filter
seller_contains - String
seller_contains_nocase - String
seller_ends_with - String
seller_ends_with_nocase - String
seller_gt - String
seller_gte - String
seller_in - [String!]
seller_lt - String
seller_lte - String
seller_not - String
seller_not_contains - String
seller_not_contains_nocase - String
seller_not_ends_with - String
seller_not_ends_with_nocase - String
seller_not_in - [String!]
seller_not_starts_with - String
seller_not_starts_with_nocase - String
seller_starts_with - String
seller_starts_with_nocase - String
token - String
token_ - Token_filter
token_contains - String
token_contains_nocase - String
token_ends_with - String
token_ends_with_nocase - String
token_gt - String
token_gte - String
token_in - [String!]
token_lt - String
token_lte - String
token_not - String
token_not_contains - String
token_not_contains_nocase - String
token_not_ends_with - String
token_not_ends_with_nocase - String
token_not_in - [String!]
token_not_starts_with - String
token_not_starts_with_nocase - String
token_starts_with - String
token_starts_with_nocase - String
updatedAt - String
updatedAt_contains - String
updatedAt_contains_nocase - String
updatedAt_ends_with - String
updatedAt_ends_with_nocase - String
updatedAt_gt - String
updatedAt_gte - String
updatedAt_in - [String!]
updatedAt_lt - String
updatedAt_lte - String
updatedAt_not - String
updatedAt_not_contains - String
updatedAt_not_contains_nocase - String
updatedAt_not_ends_with - String
updatedAt_not_ends_with_nocase - String
updatedAt_not_in - [String!]
updatedAt_not_starts_with - String
updatedAt_not_starts_with_nocase - String
updatedAt_starts_with - String
updatedAt_starts_with_nocase - String

Example

{
  "_change_block": BlockChangedFilter,
  "amountListed": {},
  "amountListed_gt": {},
  "amountListed_gte": {},
  "amountListed_in": [{}],
  "amountListed_lt": {},
  "amountListed_lte": {},
  "amountListed_not": {},
  "amountListed_not_in": [{}],
  "amountRemaining": {},
  "amountRemaining_gt": {},
  "amountRemaining_gte": {},
  "amountRemaining_in": [{}],
  "amountRemaining_lt": {},
  "amountRemaining_lte": {},
  "amountRemaining_not": {},
  "amountRemaining_not_in": [{}],
  "and": [Listing_filter],
  "createdAt": "xyz789",
  "createdAt_contains": "abc123",
  "createdAt_contains_nocase": "abc123",
  "createdAt_ends_with": "abc123",
  "createdAt_ends_with_nocase": "abc123",
  "createdAt_gt": "xyz789",
  "createdAt_gte": "abc123",
  "createdAt_in": ["abc123"],
  "createdAt_lt": "abc123",
  "createdAt_lte": "xyz789",
  "createdAt_not": "abc123",
  "createdAt_not_contains": "abc123",
  "createdAt_not_contains_nocase": "xyz789",
  "createdAt_not_ends_with": "abc123",
  "createdAt_not_ends_with_nocase": "abc123",
  "createdAt_not_in": ["abc123"],
  "createdAt_not_starts_with": "abc123",
  "createdAt_not_starts_with_nocase": "xyz789",
  "createdAt_starts_with": "abc123",
  "createdAt_starts_with_nocase": "abc123",
  "id": 4,
  "id_gt": "4",
  "id_gte": "4",
  "id_in": [4],
  "id_lt": 4,
  "id_lte": 4,
  "id_not": "4",
  "id_not_in": [4],
  "onSale": false,
  "onSale_in": [true],
  "onSale_not": false,
  "onSale_not_in": [false],
  "or": [Listing_filter],
  "salePrice": {},
  "salePrice_gt": {},
  "salePrice_gte": {},
  "salePrice_in": [{}],
  "salePrice_lt": {},
  "salePrice_lte": {},
  "salePrice_not": {},
  "salePrice_not_in": [{}],
  "seller": "abc123",
  "seller_": Owner_filter,
  "seller_contains": "abc123",
  "seller_contains_nocase": "abc123",
  "seller_ends_with": "abc123",
  "seller_ends_with_nocase": "xyz789",
  "seller_gt": "abc123",
  "seller_gte": "xyz789",
  "seller_in": ["xyz789"],
  "seller_lt": "xyz789",
  "seller_lte": "xyz789",
  "seller_not": "xyz789",
  "seller_not_contains": "xyz789",
  "seller_not_contains_nocase": "xyz789",
  "seller_not_ends_with": "abc123",
  "seller_not_ends_with_nocase": "xyz789",
  "seller_not_in": ["xyz789"],
  "seller_not_starts_with": "xyz789",
  "seller_not_starts_with_nocase": "xyz789",
  "seller_starts_with": "xyz789",
  "seller_starts_with_nocase": "xyz789",
  "token": "abc123",
  "token_": Token_filter,
  "token_contains": "xyz789",
  "token_contains_nocase": "xyz789",
  "token_ends_with": "xyz789",
  "token_ends_with_nocase": "abc123",
  "token_gt": "abc123",
  "token_gte": "abc123",
  "token_in": ["xyz789"],
  "token_lt": "abc123",
  "token_lte": "xyz789",
  "token_not": "abc123",
  "token_not_contains": "xyz789",
  "token_not_contains_nocase": "abc123",
  "token_not_ends_with": "xyz789",
  "token_not_ends_with_nocase": "xyz789",
  "token_not_in": ["xyz789"],
  "token_not_starts_with": "abc123",
  "token_not_starts_with_nocase": "xyz789",
  "token_starts_with": "abc123",
  "token_starts_with_nocase": "xyz789",
  "updatedAt": "xyz789",
  "updatedAt_contains": "xyz789",
  "updatedAt_contains_nocase": "abc123",
  "updatedAt_ends_with": "xyz789",
  "updatedAt_ends_with_nocase": "xyz789",
  "updatedAt_gt": "abc123",
  "updatedAt_gte": "abc123",
  "updatedAt_in": ["xyz789"],
  "updatedAt_lt": "xyz789",
  "updatedAt_lte": "abc123",
  "updatedAt_not": "abc123",
  "updatedAt_not_contains": "abc123",
  "updatedAt_not_contains_nocase": "xyz789",
  "updatedAt_not_ends_with": "xyz789",
  "updatedAt_not_ends_with_nocase": "abc123",
  "updatedAt_not_in": ["xyz789"],
  "updatedAt_not_starts_with": "xyz789",
  "updatedAt_not_starts_with_nocase": "abc123",
  "updatedAt_starts_with": "xyz789",
  "updatedAt_starts_with_nocase": "xyz789"
}

Types

MintedBy

Fields

Input Field	Description
type - AddressResolverType	The value type by which the tokens/collections are filtered. PERSON_ID - Person model identifier, OWNER_URI - Model identifier from the revelator database. ID scheme: [tenantName]|[entityType]|[number] (Revelator|enterprise|4)
value - String	The value by which the tokens/collections are filtered.

Example

{"type": "PERSON_ID", "value": "abc123"}

Types

NetworkName

Values

Enum Value	Description
ropsten
kovan
ownet
mainnet
binance
bnbtest
sepolia
local
test
polygon
goerli
mumbai
ethereum
shibuya
amoy
base
baseSepolia

Example

"ropsten"

Types

NftLicenceDto

Fields

Field Name	Description
revelatorTermsAndConditions - Boolean
nftTitle - String
label - String
royaltyRate - String
personalUses - [NftUseDTO!]
commercialUses - [NftUseDTO!]

Example

{
  "revelatorTermsAndConditions": true,
  "nftTitle": "abc123",
  "label": "abc123",
  "royaltyRate": "abc123",
  "personalUses": [NftUseDTO],
  "commercialUses": [NftUseDTO]
}

Types

NftMetadataAttributeInput

Fields

Input Field	Description
value - String!
traitType - String
displayType - DisplayType

Example

{
  "value": "xyz789",
  "traitType": "abc123",
  "displayType": "DATE"
}

Types

NftMetadataAttributeObject

Fields

Field Name	Description
value - String
traitType - String
displayType - DisplayType

Example

{
  "value": "xyz789",
  "traitType": "abc123",
  "displayType": "DATE"
}

Types

NftMetadataDTO

Fields

Field Name	Description
id - Int
userSub - String
title - String
description - String
artistId - String
fileType - FileType
networkName - NetworkName
s3Key - String
s3CoverKey - String
ipfsNftUrl - String
ipfsCoverUrl - String
ipfsMetadataUrl - String
ipfsNftHash - String
ipfsCoverHash - String
licenceS3Key - String
ipfsLicenceHash - String
nftLicence - NftLicenceDto
ipfsMetadataHash - String
status - FileStatus
backgroundColor - String
externalUrl - String
youtubeUrl - String
attributes - [NftMetadataAttributeObject!]
ipfsNftPublicUrl - String
ipfsCoverPublicUrl - String
ipfsMetadataPublicUrl - String
ipfsLicencePublicUrl - String

Example

{
  "id": 987,
  "userSub": "abc123",
  "title": "xyz789",
  "description": "xyz789",
  "artistId": "abc123",
  "fileType": "IMAGE",
  "networkName": "ropsten",
  "s3Key": "abc123",
  "s3CoverKey": "abc123",
  "ipfsNftUrl": "xyz789",
  "ipfsCoverUrl": "xyz789",
  "ipfsMetadataUrl": "abc123",
  "ipfsNftHash": "abc123",
  "ipfsCoverHash": "xyz789",
  "licenceS3Key": "abc123",
  "ipfsLicenceHash": "xyz789",
  "nftLicence": NftLicenceDto,
  "ipfsMetadataHash": "xyz789",
  "status": "PENDING_UPLOAD",
  "backgroundColor": "abc123",
  "externalUrl": "abc123",
  "youtubeUrl": "abc123",
  "attributes": [NftMetadataAttributeObject],
  "ipfsNftPublicUrl": "xyz789",
  "ipfsCoverPublicUrl": "xyz789",
  "ipfsMetadataPublicUrl": "xyz789",
  "ipfsLicencePublicUrl": "abc123"
}

Types

NftMetadataDraftReqDTO

Fields

Input Field	Description
backgroundColor - String
externalUrl - String
youtubeUrl - String
attributes - [NftMetadataAttributeInput!]
title - String!
description - String
artistId - String
fileType - FileType!
networkName - NetworkName!
revelatorTermsAndConditions - Boolean
personalUses - [Int!]
commercialUses - [Int!]

Example

{
  "backgroundColor": "abc123",
  "externalUrl": "xyz789",
  "youtubeUrl": "abc123",
  "attributes": [NftMetadataAttributeInput],
  "title": "abc123",
  "description": "xyz789",
  "artistId": "xyz789",
  "fileType": "IMAGE",
  "networkName": "ropsten",
  "revelatorTermsAndConditions": false,
  "personalUses": [123],
  "commercialUses": [987]
}

Types

NftMetadataDraftResDTO

Fields

Field Name	Description
id - Float
fileName - String
title - String
description - String
artistId - String
fileType - FileType
networkName - NetworkName
backgroundColor - String
externalUrl - String
youtubeUrl - String
attributes - [NftMetadataAttributeObject!]

Example

{
  "id": 987.65,
  "fileName": "xyz789",
  "title": "xyz789",
  "description": "abc123",
  "artistId": "xyz789",
  "fileType": "IMAGE",
  "networkName": "ropsten",
  "backgroundColor": "xyz789",
  "externalUrl": "xyz789",
  "youtubeUrl": "abc123",
  "attributes": [NftMetadataAttributeObject]
}

Types

NftMetadataLinkReqDTO

Fields

Input Field	Description
fileName - String!	the file name must contain its extension -> [name].jpg
fileMime - String!	mime type of the nft file -> image/jpeg
coverFileName - String	the file name must contain its extension -> [name].jpg
coverMime - String	mime type of the cover image file -> image/jpeg

Example

{
  "fileName": "abc123",
  "fileMime": "abc123",
  "coverFileName": "abc123",
  "coverMime": "abc123"
}

Types

NftMetadataLinkResDTO

Fields

Field Name	Description
uploadUrl - String!
coverUploadUrl - String

Example

{
  "uploadUrl": "xyz789",
  "coverUploadUrl": "xyz789"
}

Types

NftMetadataListResDTO

Fields

Field Name	Description
items - [NftMetadataDraftResDTO!]!
count - Float

Example

{"items": [NftMetadataDraftResDTO], "count": 123.45}

Types

NftUseDTO

Fields

Field Name	Description
id - Int
name - String
description - String
position - Float
nftUseType - NftUseType

Example

{
  "id": 987,
  "name": "abc123",
  "description": "xyz789",
  "position": 987.65,
  "nftUseType": "personal"
}

Types

NftUseType

Values

Enum Value	Description
personal
commercial

Example

"personal"

Types

NftUsesDTO

Fields

Field Name	Description
list - [NftUseDTO!]!

Example

{"list": [NftUseDTO]}

Types

OrderDirection

Description

Defines the order direction, either ascending or descending

Values

Enum Value	Description
asc
desc

Example

"asc"

Types

OwnedBy

Fields

Input Field	Description
type - AddressResolverType	The value type by which the tokens/collections are filtered. PERSON_ID - Person model identifier, OWNER_URI - Model identifier from the revelator database. ID scheme: [tenantName]|[entityType]|[number] (Revelator|enterprise|4)
value - String	The value by which the tokens/collections are filtered.

Example

{"type": "PERSON_ID", "value": "xyz789"}

Types

Owner

Fields

Field Name	Description
address - String!

Example

{"address": "abc123"}

Types

OwnerWithMetadata

Fields

Field Name	Description
amountOwned - String!
amountDeposited - String!
id - String
walletAddress - String
smartWalletAddress - String
username - String
avatarS3Key - String
avatarUrl - String

Example

{
  "amountOwned": "abc123",
  "amountDeposited": "abc123",
  "id": "abc123",
  "walletAddress": "abc123",
  "smartWalletAddress": "abc123",
  "username": "xyz789",
  "avatarS3Key": "xyz789",
  "avatarUrl": "xyz789"
}

Types

Owner_filter

Fields

Input Field	Description
_change_block - BlockChangedFilter	Filter for the block changed event.
address - Bytes
address_contains - Bytes
address_gt - Bytes
address_gte - Bytes
address_in - [Bytes!]
address_lt - Bytes
address_lte - Bytes
address_not - Bytes
address_not_contains - Bytes
address_not_in - [Bytes!]
and - [Owner_filter]
id - ID
id_gt - ID
id_gte - ID
id_in - [ID!]
id_lt - ID
id_lte - ID
id_not - ID
id_not_in - [ID!]
listings_ - Listing_filter
or - [Owner_filter]
purchases_ - Purchase_filter
tokens_ - TokenOwner_filter

Example

{
  "_change_block": BlockChangedFilter,
  "address": Bytes,
  "address_contains": Bytes,
  "address_gt": Bytes,
  "address_gte": Bytes,
  "address_in": [Bytes],
  "address_lt": Bytes,
  "address_lte": Bytes,
  "address_not": Bytes,
  "address_not_contains": Bytes,
  "address_not_in": [Bytes],
  "and": [Owner_filter],
  "id": "4",
  "id_gt": 4,
  "id_gte": "4",
  "id_in": [4],
  "id_lt": "4",
  "id_lte": "4",
  "id_not": 4,
  "id_not_in": ["4"],
  "listings_": Listing_filter,
  "or": [Owner_filter],
  "purchases_": Purchase_filter,
  "tokens_": TokenOwner_filter
}

Types

PaginationParams

Fields

Input Field	Description
startId - Float
limit - Float

Example

{"startId": 123.45, "limit": 987.65}

Types

PersonDto

Fields

Field Name	Description
id - String
walletAddress - String
smartWalletAddress - String
username - String
avatarS3Key - String
avatarUrl - String

Example

{
  "id": "xyz789",
  "walletAddress": "xyz789",
  "smartWalletAddress": "abc123",
  "username": "xyz789",
  "avatarS3Key": "xyz789",
  "avatarUrl": "xyz789"
}

Types

PersonIdentifier

Fields

Input Field	Description
id - String
walletAddress - String

Example

{
  "id": "xyz789",
  "walletAddress": "xyz789"
}

Types

Persons

Fields

Field Name	Description
items - [PersonDto!]
count - Float

Example

{"items": [PersonDto], "count": 123.45}

Types

Purchase

Fields

Field Name	Description
id - String!
amount - String!
salePrice - String!
value - String!
buyer - Owner!
createdAt - String!

Example

{
  "id": "abc123",
  "amount": "xyz789",
  "salePrice": "xyz789",
  "value": "xyz789",
  "buyer": Owner,
  "createdAt": "abc123"
}

Types

Purchase_filter

Fields

Input Field	Description
_change_block - BlockChangedFilter	Filter for the block changed event.
amount - BigInt
amount_gt - BigInt
amount_gte - BigInt
amount_in - [BigInt!]
amount_lt - BigInt
amount_lte - BigInt
amount_not - BigInt
amount_not_in - [BigInt!]
and - [Purchase_filter]
buyer - String
buyer_ - Owner_filter
buyer_contains - String
buyer_contains_nocase - String
buyer_ends_with - String
buyer_ends_with_nocase - String
buyer_gt - String
buyer_gte - String
buyer_in - [String!]
buyer_lt - String
buyer_lte - String
buyer_not - String
buyer_not_contains - String
buyer_not_contains_nocase - String
buyer_not_ends_with - String
buyer_not_ends_with_nocase - String
buyer_not_in - [String!]
buyer_not_starts_with - String
buyer_not_starts_with_nocase - String
buyer_starts_with - String
buyer_starts_with_nocase - String
createdAt - String
createdAt_contains - String
createdAt_contains_nocase - String
createdAt_ends_with - String
createdAt_ends_with_nocase - String
createdAt_gt - String
createdAt_gte - String
createdAt_in - [String!]
createdAt_lt - String
createdAt_lte - String
createdAt_not - String
createdAt_not_contains - String
createdAt_not_contains_nocase - String
createdAt_not_ends_with - String
createdAt_not_ends_with_nocase - String
createdAt_not_in - [String!]
createdAt_not_starts_with - String
createdAt_not_starts_with_nocase - String
createdAt_starts_with - String
createdAt_starts_with_nocase - String
id - ID
id_gt - ID
id_gte - ID
id_in - [ID!]
id_lt - ID
id_lte - ID
id_not - ID
id_not_in - [ID!]
or - [Purchase_filter]
salePrice - BigInt
salePrice_gt - BigInt
salePrice_gte - BigInt
salePrice_in - [BigInt!]
salePrice_lt - BigInt
salePrice_lte - BigInt
salePrice_not - BigInt
salePrice_not_in - [BigInt!]
token - String
token_ - Token_filter
token_contains - String
token_contains_nocase - String
token_ends_with - String
token_ends_with_nocase - String
token_gt - String
token_gte - String
token_in - [String!]
token_lt - String
token_lte - String
token_not - String
token_not_contains - String
token_not_contains_nocase - String
token_not_ends_with - String
token_not_ends_with_nocase - String
token_not_in - [String!]
token_not_starts_with - String
token_not_starts_with_nocase - String
token_starts_with - String
token_starts_with_nocase - String
value - BigInt
value_gt - BigInt
value_gte - BigInt
value_in - [BigInt!]
value_lt - BigInt
value_lte - BigInt
value_not - BigInt
value_not_in - [BigInt!]

Example

{
  "_change_block": BlockChangedFilter,
  "amount": {},
  "amount_gt": {},
  "amount_gte": {},
  "amount_in": [{}],
  "amount_lt": {},
  "amount_lte": {},
  "amount_not": {},
  "amount_not_in": [{}],
  "and": [Purchase_filter],
  "buyer": "abc123",
  "buyer_": Owner_filter,
  "buyer_contains": "abc123",
  "buyer_contains_nocase": "abc123",
  "buyer_ends_with": "xyz789",
  "buyer_ends_with_nocase": "xyz789",
  "buyer_gt": "xyz789",
  "buyer_gte": "abc123",
  "buyer_in": ["abc123"],
  "buyer_lt": "abc123",
  "buyer_lte": "abc123",
  "buyer_not": "xyz789",
  "buyer_not_contains": "xyz789",
  "buyer_not_contains_nocase": "abc123",
  "buyer_not_ends_with": "abc123",
  "buyer_not_ends_with_nocase": "abc123",
  "buyer_not_in": ["xyz789"],
  "buyer_not_starts_with": "xyz789",
  "buyer_not_starts_with_nocase": "abc123",
  "buyer_starts_with": "xyz789",
  "buyer_starts_with_nocase": "abc123",
  "createdAt": "xyz789",
  "createdAt_contains": "abc123",
  "createdAt_contains_nocase": "abc123",
  "createdAt_ends_with": "xyz789",
  "createdAt_ends_with_nocase": "abc123",
  "createdAt_gt": "xyz789",
  "createdAt_gte": "xyz789",
  "createdAt_in": ["xyz789"],
  "createdAt_lt": "xyz789",
  "createdAt_lte": "abc123",
  "createdAt_not": "xyz789",
  "createdAt_not_contains": "abc123",
  "createdAt_not_contains_nocase": "abc123",
  "createdAt_not_ends_with": "abc123",
  "createdAt_not_ends_with_nocase": "abc123",
  "createdAt_not_in": ["abc123"],
  "createdAt_not_starts_with": "xyz789",
  "createdAt_not_starts_with_nocase": "abc123",
  "createdAt_starts_with": "abc123",
  "createdAt_starts_with_nocase": "abc123",
  "id": 4,
  "id_gt": 4,
  "id_gte": "4",
  "id_in": [4],
  "id_lt": 4,
  "id_lte": 4,
  "id_not": 4,
  "id_not_in": ["4"],
  "or": [Purchase_filter],
  "salePrice": {},
  "salePrice_gt": {},
  "salePrice_gte": {},
  "salePrice_in": [{}],
  "salePrice_lt": {},
  "salePrice_lte": {},
  "salePrice_not": {},
  "salePrice_not_in": [{}],
  "token": "abc123",
  "token_": Token_filter,
  "token_contains": "xyz789",
  "token_contains_nocase": "abc123",
  "token_ends_with": "abc123",
  "token_ends_with_nocase": "xyz789",
  "token_gt": "abc123",
  "token_gte": "abc123",
  "token_in": ["abc123"],
  "token_lt": "abc123",
  "token_lte": "xyz789",
  "token_not": "xyz789",
  "token_not_contains": "abc123",
  "token_not_contains_nocase": "abc123",
  "token_not_ends_with": "xyz789",
  "token_not_ends_with_nocase": "abc123",
  "token_not_in": ["abc123"],
  "token_not_starts_with": "xyz789",
  "token_not_starts_with_nocase": "abc123",
  "token_starts_with": "xyz789",
  "token_starts_with_nocase": "xyz789",
  "value": {},
  "value_gt": {},
  "value_gte": {},
  "value_in": [{}],
  "value_lt": {},
  "value_lte": {},
  "value_not": {},
  "value_not_in": [{}]
}

Types

String

Description

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Example

"abc123"

Types

Token

Fields

Field Name	Description
id - String!
tokenId - String!
collectionContract - Collection
minter - String!
enterprise - CollectionEntity
artist - CollectionEntity
amount - String!
royaltyRecipient - String
royaltyNumerator - String
owners - [TokenOwner!]!
ownersWithMetadata - [OwnerWithMetadata!]
listing - Listing!
purchases - [Purchase!]!
tokenURI - String!
metadata - NftMetadataDTO
nftUrl - String
coverUrl - String
networkName - NetworkName!
createdAt - String!
updatedAt - String!

Example

{
  "id": "xyz789",
  "tokenId": "xyz789",
  "collectionContract": Collection,
  "minter": "xyz789",
  "enterprise": CollectionEntity,
  "artist": CollectionEntity,
  "amount": "xyz789",
  "royaltyRecipient": "abc123",
  "royaltyNumerator": "xyz789",
  "owners": [TokenOwner],
  "ownersWithMetadata": [OwnerWithMetadata],
  "listing": Listing,
  "purchases": [Purchase],
  "tokenURI": "xyz789",
  "metadata": NftMetadataDTO,
  "nftUrl": "abc123",
  "coverUrl": "abc123",
  "networkName": "ropsten",
  "createdAt": "abc123",
  "updatedAt": "abc123"
}

Types

TokenOwner

Fields

Field Name	Description
id - String!
owner - Owner!
amountOwned - String!
amountDeposited - String!

Example

{
  "id": "abc123",
  "owner": Owner,
  "amountOwned": "abc123",
  "amountDeposited": "abc123"
}

Types

TokenOwner_filter

Fields

Input Field	Description
_change_block - BlockChangedFilter	Filter for the block changed event.
amountDeposited - BigInt
amountDeposited_gt - BigInt
amountDeposited_gte - BigInt
amountDeposited_in - [BigInt!]
amountDeposited_lt - BigInt
amountDeposited_lte - BigInt
amountDeposited_not - BigInt
amountDeposited_not_in - [BigInt!]
amountOwned - BigInt
amountOwned_gt - BigInt
amountOwned_gte - BigInt
amountOwned_in - [BigInt!]
amountOwned_lt - BigInt
amountOwned_lte - BigInt
amountOwned_not - BigInt
amountOwned_not_in - [BigInt!]
and - [TokenOwner_filter]
id - ID
id_gt - ID
id_gte - ID
id_in - [ID!]
id_lt - ID
id_lte - ID
id_not - ID
id_not_in - [ID!]
or - [TokenOwner_filter]
owner - String
owner_ - Owner_filter
owner_contains - String
owner_contains_nocase - String
owner_ends_with - String
owner_ends_with_nocase - String
owner_gt - String
owner_gte - String
owner_in - [String!]
owner_lt - String
owner_lte - String
owner_not - String
owner_not_contains - String
owner_not_contains_nocase - String
owner_not_ends_with - String
owner_not_ends_with_nocase - String
owner_not_in - [String!]
owner_not_starts_with - String
owner_not_starts_with_nocase - String
owner_starts_with - String
owner_starts_with_nocase - String
token - String
token_ - Token_filter
token_contains - String
token_contains_nocase - String
token_ends_with - String
token_ends_with_nocase - String
token_gt - String
token_gte - String
token_in - [String!]
token_lt - String
token_lte - String
token_not - String
token_not_contains - String
token_not_contains_nocase - String
token_not_ends_with - String
token_not_ends_with_nocase - String
token_not_in - [String!]
token_not_starts_with - String
token_not_starts_with_nocase - String
token_starts_with - String
token_starts_with_nocase - String

Example

{
  "_change_block": BlockChangedFilter,
  "amountDeposited": {},
  "amountDeposited_gt": {},
  "amountDeposited_gte": {},
  "amountDeposited_in": [{}],
  "amountDeposited_lt": {},
  "amountDeposited_lte": {},
  "amountDeposited_not": {},
  "amountDeposited_not_in": [{}],
  "amountOwned": {},
  "amountOwned_gt": {},
  "amountOwned_gte": {},
  "amountOwned_in": [{}],
  "amountOwned_lt": {},
  "amountOwned_lte": {},
  "amountOwned_not": {},
  "amountOwned_not_in": [{}],
  "and": [TokenOwner_filter],
  "id": "4",
  "id_gt": "4",
  "id_gte": "4",
  "id_in": ["4"],
  "id_lt": 4,
  "id_lte": 4,
  "id_not": 4,
  "id_not_in": [4],
  "or": [TokenOwner_filter],
  "owner": "abc123",
  "owner_": Owner_filter,
  "owner_contains": "xyz789",
  "owner_contains_nocase": "xyz789",
  "owner_ends_with": "xyz789",
  "owner_ends_with_nocase": "xyz789",
  "owner_gt": "abc123",
  "owner_gte": "abc123",
  "owner_in": ["xyz789"],
  "owner_lt": "xyz789",
  "owner_lte": "abc123",
  "owner_not": "xyz789",
  "owner_not_contains": "abc123",
  "owner_not_contains_nocase": "xyz789",
  "owner_not_ends_with": "abc123",
  "owner_not_ends_with_nocase": "xyz789",
  "owner_not_in": ["xyz789"],
  "owner_not_starts_with": "abc123",
  "owner_not_starts_with_nocase": "abc123",
  "owner_starts_with": "xyz789",
  "owner_starts_with_nocase": "xyz789",
  "token": "xyz789",
  "token_": Token_filter,
  "token_contains": "abc123",
  "token_contains_nocase": "xyz789",
  "token_ends_with": "abc123",
  "token_ends_with_nocase": "abc123",
  "token_gt": "abc123",
  "token_gte": "abc123",
  "token_in": ["abc123"],
  "token_lt": "xyz789",
  "token_lte": "xyz789",
  "token_not": "xyz789",
  "token_not_contains": "abc123",
  "token_not_contains_nocase": "abc123",
  "token_not_ends_with": "xyz789",
  "token_not_ends_with_nocase": "xyz789",
  "token_not_in": ["abc123"],
  "token_not_starts_with": "xyz789",
  "token_not_starts_with_nocase": "xyz789",
  "token_starts_with": "xyz789",
  "token_starts_with_nocase": "xyz789"
}

Types

Token_filter

Fields

Input Field	Description
_change_block - BlockChangedFilter	Filter for the block changed event.
amount - BigInt
amount_gt - BigInt
amount_gte - BigInt
amount_in - [BigInt!]
amount_lt - BigInt
amount_lte - BigInt
amount_not - BigInt
amount_not_in - [BigInt!]
and - [Token_filter]
collectionContract - String
collectionContract_ - CollectionContract_filter
collectionContract_contains - String
collectionContract_contains_nocase - String
collectionContract_ends_with - String
collectionContract_ends_with_nocase - String
collectionContract_gt - String
collectionContract_gte - String
collectionContract_in - [String!]
collectionContract_lt - String
collectionContract_lte - String
collectionContract_not - String
collectionContract_not_contains - String
collectionContract_not_contains_nocase - String
collectionContract_not_ends_with - String
collectionContract_not_ends_with_nocase - String
collectionContract_not_in - [String!]
collectionContract_not_starts_with - String
collectionContract_not_starts_with_nocase - String
collectionContract_starts_with - String
collectionContract_starts_with_nocase - String
createdAt - String
createdAt_contains - String
createdAt_contains_nocase - String
createdAt_ends_with - String
createdAt_ends_with_nocase - String
createdAt_gt - String
createdAt_gte - String
createdAt_in - [String!]
createdAt_lt - String
createdAt_lte - String
createdAt_not - String
createdAt_not_contains - String
createdAt_not_contains_nocase - String
createdAt_not_ends_with - String
createdAt_not_ends_with_nocase - String
createdAt_not_in - [String!]
createdAt_not_starts_with - String
createdAt_not_starts_with_nocase - String
createdAt_starts_with - String
createdAt_starts_with_nocase - String
id - ID
id_gt - ID
id_gte - ID
id_in - [ID!]
id_lt - ID
id_lte - ID
id_not - ID
id_not_in - [ID!]
listing_ - Listing_filter
minter - Bytes
minter_contains - Bytes
minter_gt - Bytes
minter_gte - Bytes
minter_in - [Bytes!]
minter_lt - Bytes
minter_lte - Bytes
minter_not - Bytes
minter_not_contains - Bytes
minter_not_in - [Bytes!]
or - [Token_filter]
owners_ - TokenOwner_filter
purchases_ - Purchase_filter
royaltyNumerator - BigInt
royaltyNumerator_gt - BigInt
royaltyNumerator_gte - BigInt
royaltyNumerator_in - [BigInt!]
royaltyNumerator_lt - BigInt
royaltyNumerator_lte - BigInt
royaltyNumerator_not - BigInt
royaltyNumerator_not_in - [BigInt!]
royaltyRecipient - Bytes
royaltyRecipient_contains - Bytes
royaltyRecipient_gt - Bytes
royaltyRecipient_gte - Bytes
royaltyRecipient_in - [Bytes!]
royaltyRecipient_lt - Bytes
royaltyRecipient_lte - Bytes
royaltyRecipient_not - Bytes
royaltyRecipient_not_contains - Bytes
royaltyRecipient_not_in - [Bytes!]
tokenId - BigInt
tokenId_gt - BigInt
tokenId_gte - BigInt
tokenId_in - [BigInt!]
tokenId_lt - BigInt
tokenId_lte - BigInt
tokenId_not - BigInt
tokenId_not_in - [BigInt!]
tokenURI - String
tokenURI_contains - String
tokenURI_contains_nocase - String
tokenURI_ends_with - String
tokenURI_ends_with_nocase - String
tokenURI_gt - String
tokenURI_gte - String
tokenURI_in - [String!]
tokenURI_lt - String
tokenURI_lte - String
tokenURI_not - String
tokenURI_not_contains - String
tokenURI_not_contains_nocase - String
tokenURI_not_ends_with - String
tokenURI_not_ends_with_nocase - String
tokenURI_not_in - [String!]
tokenURI_not_starts_with - String
tokenURI_not_starts_with_nocase - String
tokenURI_starts_with - String
tokenURI_starts_with_nocase - String
updatedAt - String
updatedAt_contains - String
updatedAt_contains_nocase - String
updatedAt_ends_with - String
updatedAt_ends_with_nocase - String
updatedAt_gt - String
updatedAt_gte - String
updatedAt_in - [String!]
updatedAt_lt - String
updatedAt_lte - String
updatedAt_not - String
updatedAt_not_contains - String
updatedAt_not_contains_nocase - String
updatedAt_not_ends_with - String
updatedAt_not_ends_with_nocase - String
updatedAt_not_in - [String!]
updatedAt_not_starts_with - String
updatedAt_not_starts_with_nocase - String
updatedAt_starts_with - String
updatedAt_starts_with_nocase - String

Example

{
  "_change_block": BlockChangedFilter,
  "amount": {},
  "amount_gt": {},
  "amount_gte": {},
  "amount_in": [{}],
  "amount_lt": {},
  "amount_lte": {},
  "amount_not": {},
  "amount_not_in": [{}],
  "and": [Token_filter],
  "collectionContract": "abc123",
  "collectionContract_": CollectionContract_filter,
  "collectionContract_contains": "xyz789",
  "collectionContract_contains_nocase": "abc123",
  "collectionContract_ends_with": "abc123",
  "collectionContract_ends_with_nocase": "abc123",
  "collectionContract_gt": "xyz789",
  "collectionContract_gte": "xyz789",
  "collectionContract_in": ["abc123"],
  "collectionContract_lt": "xyz789",
  "collectionContract_lte": "xyz789",
  "collectionContract_not": "abc123",
  "collectionContract_not_contains": "abc123",
  "collectionContract_not_contains_nocase": "xyz789",
  "collectionContract_not_ends_with": "xyz789",
  "collectionContract_not_ends_with_nocase": "xyz789",
  "collectionContract_not_in": ["xyz789"],
  "collectionContract_not_starts_with": "xyz789",
  "collectionContract_not_starts_with_nocase": "xyz789",
  "collectionContract_starts_with": "abc123",
  "collectionContract_starts_with_nocase": "abc123",
  "createdAt": "xyz789",
  "createdAt_contains": "abc123",
  "createdAt_contains_nocase": "xyz789",
  "createdAt_ends_with": "xyz789",
  "createdAt_ends_with_nocase": "xyz789",
  "createdAt_gt": "abc123",
  "createdAt_gte": "abc123",
  "createdAt_in": ["xyz789"],
  "createdAt_lt": "xyz789",
  "createdAt_lte": "xyz789",
  "createdAt_not": "xyz789",
  "createdAt_not_contains": "xyz789",
  "createdAt_not_contains_nocase": "abc123",
  "createdAt_not_ends_with": "xyz789",
  "createdAt_not_ends_with_nocase": "abc123",
  "createdAt_not_in": ["abc123"],
  "createdAt_not_starts_with": "xyz789",
  "createdAt_not_starts_with_nocase": "xyz789",
  "createdAt_starts_with": "abc123",
  "createdAt_starts_with_nocase": "xyz789",
  "id": "4",
  "id_gt": "4",
  "id_gte": "4",
  "id_in": [4],
  "id_lt": 4,
  "id_lte": "4",
  "id_not": 4,
  "id_not_in": [4],
  "listing_": Listing_filter,
  "minter": Bytes,
  "minter_contains": Bytes,
  "minter_gt": Bytes,
  "minter_gte": Bytes,
  "minter_in": [Bytes],
  "minter_lt": Bytes,
  "minter_lte": Bytes,
  "minter_not": Bytes,
  "minter_not_contains": Bytes,
  "minter_not_in": [Bytes],
  "or": [Token_filter],
  "owners_": TokenOwner_filter,
  "purchases_": Purchase_filter,
  "royaltyNumerator": {},
  "royaltyNumerator_gt": {},
  "royaltyNumerator_gte": {},
  "royaltyNumerator_in": [{}],
  "royaltyNumerator_lt": {},
  "royaltyNumerator_lte": {},
  "royaltyNumerator_not": {},
  "royaltyNumerator_not_in": [{}],
  "royaltyRecipient": Bytes,
  "royaltyRecipient_contains": Bytes,
  "royaltyRecipient_gt": Bytes,
  "royaltyRecipient_gte": Bytes,
  "royaltyRecipient_in": [Bytes],
  "royaltyRecipient_lt": Bytes,
  "royaltyRecipient_lte": Bytes,
  "royaltyRecipient_not": Bytes,
  "royaltyRecipient_not_contains": Bytes,
  "royaltyRecipient_not_in": [Bytes],
  "tokenId": {},
  "tokenId_gt": {},
  "tokenId_gte": {},
  "tokenId_in": [{}],
  "tokenId_lt": {},
  "tokenId_lte": {},
  "tokenId_not": {},
  "tokenId_not_in": [{}],
  "tokenURI": "abc123",
  "tokenURI_contains": "abc123",
  "tokenURI_contains_nocase": "xyz789",
  "tokenURI_ends_with": "xyz789",
  "tokenURI_ends_with_nocase": "abc123",
  "tokenURI_gt": "xyz789",
  "tokenURI_gte": "abc123",
  "tokenURI_in": ["xyz789"],
  "tokenURI_lt": "xyz789",
  "tokenURI_lte": "xyz789",
  "tokenURI_not": "xyz789",
  "tokenURI_not_contains": "abc123",
  "tokenURI_not_contains_nocase": "xyz789",
  "tokenURI_not_ends_with": "xyz789",
  "tokenURI_not_ends_with_nocase": "abc123",
  "tokenURI_not_in": ["abc123"],
  "tokenURI_not_starts_with": "abc123",
  "tokenURI_not_starts_with_nocase": "abc123",
  "tokenURI_starts_with": "xyz789",
  "tokenURI_starts_with_nocase": "abc123",
  "updatedAt": "abc123",
  "updatedAt_contains": "abc123",
  "updatedAt_contains_nocase": "abc123",
  "updatedAt_ends_with": "abc123",
  "updatedAt_ends_with_nocase": "xyz789",
  "updatedAt_gt": "xyz789",
  "updatedAt_gte": "abc123",
  "updatedAt_in": ["abc123"],
  "updatedAt_lt": "abc123",
  "updatedAt_lte": "abc123",
  "updatedAt_not": "abc123",
  "updatedAt_not_contains": "abc123",
  "updatedAt_not_contains_nocase": "abc123",
  "updatedAt_not_ends_with": "xyz789",
  "updatedAt_not_ends_with_nocase": "abc123",
  "updatedAt_not_in": ["xyz789"],
  "updatedAt_not_starts_with": "xyz789",
  "updatedAt_not_starts_with_nocase": "xyz789",
  "updatedAt_starts_with": "abc123",
  "updatedAt_starts_with_nocase": "xyz789"
}

Types

Token_orderBy

Values

Enum Value	Description
amount
collectionContract
collectionContract__address
collectionContract__contractURI
collectionContract__createdAt
collectionContract__id
collectionContract__owner
collectionContract__updatedAt
createdAt
id
listing
listing__amountListed
listing__amountRemaining
listing__createdAt
listing__id
listing__onSale
listing__salePrice
listing__updatedAt
minter
owners
purchases
royaltyNumerator
royaltyRecipient
tokenId
tokenURI
updatedAt

Example

"amount"

Types

UpdatePerson

Fields

Input Field	Description
username - String
walletAddress - String

Example

{
  "username": "abc123",
  "walletAddress": "abc123"
}

Types

_SubgraphErrorPolicy_

Values

Enum Value	Description
allow	Data will be returned even if the subgraph has indexing errors
deny	If the subgraph has indexing errors, data will be omitted. The default.

Example

"allow"

Types

collectionContractsQueryArgs

Fields

Input Field	Description
block - Block_height	The block at which the query should be executed. Can either be a { hash: Bytes } value containing a block hash, a { number: Int } containing the block number, or a { number_gte: Int } containing the minimum block number. In the case of number_gte, the query will be executed on the latest block only if the subgraph has progressed to or past the minimum block number. Defaults to the latest block when omitted.
first - Int
orderBy - CollectionContract_orderBy
orderDirection - OrderDirection
skip - Int
subgraphError - _SubgraphErrorPolicy_!	Set to allow to receive data even if the subgraph has skipped over errors while syncing. Default = deny
where - CollectionContract_filter

Example

{
  "block": Block_height,
  "first": 987,
  "orderBy": "address",
  "orderDirection": "asc",
  "skip": 123,
  "subgraphError": "allow",
  "where": CollectionContract_filter
}

Types

tokensInput

Fields

Input Field	Description
network - NetworkName!	Name of the blockchain network on which the transaction occurs
ownedBy - OwnedBy	Parameters filtering tokens by owners. One token can have many owners. The owner does not have to be the creator. The token may not have the creator in the list of owners.
mintedBy - MintedBy	Parameters filtering tokens by minters. One token can have one minter. Minter is the creator of the token or the entity that created the token on behalf of the artist.
byCollectionEntityUri - String	Parameters filtering tokens by collectionEntity. CollectionEntity is the creator of the token, either a creator group to which the minters belong, or an organization that created the tokens on behalf of the artists.
queryParams - tokensQueryArgs	Parameters filtering tokens from subgraph.

Example

{
  "network": "ropsten",
  "ownedBy": OwnedBy,
  "mintedBy": MintedBy,
  "byCollectionEntityUri": "xyz789",
  "queryParams": tokensQueryArgs
}

Types

tokensQueryArgs

Fields

Input Field	Description
block - Block_height	The block at which the query should be executed. Can either be a { hash: Bytes } value containing a block hash, a { number: Int } containing the block number, or a { number_gte: Int } containing the minimum block number. In the case of number_gte, the query will be executed on the latest block only if the subgraph has progressed to or past the minimum block number. Defaults to the latest block when omitted.
first - Int
orderBy - Token_orderBy
orderDirection - OrderDirection
skip - Int
subgraphError - _SubgraphErrorPolicy_!	Set to allow to receive data even if the subgraph has skipped over errors while syncing. Default = deny
where - Token_filter

Example

{
  "block": Block_height,
  "first": 987,
  "orderBy": "amount",
  "orderDirection": "asc",
  "skip": 987,
  "subgraphError": "allow",
  "where": Token_filter
}

Documentation by Anvil SpectaQL