> For the complete documentation index, see [llms.txt](https://docs.revelator.com/pro/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.revelator.com/pro/resources/web3/production/nft-service-api.md). # 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!`](#definition-String) **Arguments** | Name | Description | | ------------------------------------------------------ | ----------- | | `collectionContract` - [`String!`](#definition-String) | | | `tokenId` - [`String!`](#definition-String) | | | `userId` - [`String!`](#definition-String) | | | `network` - [`NetworkName!`](#definition-NetworkName) | | **Example** **Query** ```gql query BalanceOf( $collectionContract: String!, $tokenId: String!, $userId: String!, $network: NetworkName! ) { balanceOf( collectionContract: $collectionContract, tokenId: $tokenId, userId: $userId, network: $network ) } ``` **Variables** ```json { "collectionContract": "abc123", "tokenId": "abc123", "userId": "abc123", "network": "ropsten" } ``` **Response** ```json {"data": {"balanceOf": "xyz789"}} ``` [Queries](#group-Operations-Queries) ### `collection` **Description** 🔓 Public Returns single collection **Response** Returns a [`Collection`](#definition-Collection) **Arguments** | Name | Description | | ----------------------------------------------------- | ----------- | | `network` - [`NetworkName!`](#definition-NetworkName) | | | `id` - [`String!`](#definition-String) | | **Example** **Query** ```gql 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** ```json {"network": "ropsten", "id": "abc123"} ``` **Response** ```json { "data": { "collection": { "id": "abc123", "owner": "abc123", "tokens": [Token], "address": "abc123", "contractURI": "xyz789", "networkName": "ropsten", "metadata": CollectionMetadataDto, "createdAt": "abc123", "updatedAt": "abc123" } } } ``` [Queries](#group-Operations-Queries) ### `collectionMetadata` **Description** 🔒 JWT Token Retrieve collection metadata by id **Response** Returns a [`CollectionMetadataDto!`](#definition-CollectionMetadataDto) **Arguments** | Name | Description | | ------------------------------------ | ----------- | | `id` - [`Float!`](#definition-Float) | | **Example** **Query** ```gql 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** ```json {"id": 123.45} ``` **Response** ```json { "data": { "collectionMetadata": { "id": 123, "userSub": "xyz789", "name": "abc123", "symbol": "xyz789", "description": "abc123", "coverImageS3Key": "xyz789", "coverImageS3Url": "xyz789", "coverImageIpfsUrl": "xyz789", "coverImageIpfsHash": "abc123", "bannerImageS3Key": "abc123", "bannerImageS3Url": "xyz789", "bannerImageIpfsHash": "xyz789", "bannerImageIpfsUrl": "abc123", "externalLink": "abc123", "defaultRoyalties": "xyz789", "defaultRoyaltyRecipient": "abc123", "metadataIpfsHash": "abc123", "metadataIpfsUrl": "xyz789", "networkName": "ropsten", "status": "PENDING_UPLOAD" } } } ``` [Queries](#group-Operations-Queries) ### `collections` **Description** 🔓 Public Returns collections **Response** Returns [`[Collection!]!`](#definition-Collection) **Arguments** | Name | Description | | ------------------------------------------------------------- | ----------- | | `input` - [`CollectionsInput!`](#definition-CollectionsInput) | | **Example** **Query** ```gql 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** ```json {"input": CollectionsInput} ``` **Response** ```json { "data": { "collections": [ { "id": "abc123", "owner": "xyz789", "tokens": [Token], "address": "xyz789", "contractURI": "abc123", "networkName": "ropsten", "metadata": CollectionMetadataDto, "createdAt": "xyz789", "updatedAt": "xyz789" } ] } } ``` [Queries](#group-Operations-Queries) ### `currentPerson` **Description** 🔒 JWT Token Returns person from the context **Response** Returns a [`PersonDto!`](#definition-PersonDto) **Example** **Query** ```gql query CurrentPerson { currentPerson { id walletAddress smartWalletAddress username avatarS3Key avatarUrl } } ``` **Response** ```json { "data": { "currentPerson": { "id": "abc123", "walletAddress": "xyz789", "smartWalletAddress": "xyz789", "username": "xyz789", "avatarS3Key": "abc123", "avatarUrl": "abc123" } } } ``` [Queries](#group-Operations-Queries) ### `fees` **Description** 🔓 Public Returns market fees **Response** Returns a [`Fees!`](#definition-Fees) **Arguments** | Name | Description | | ----------------------------------------------------- | ----------- | | `network` - [`NetworkName!`](#definition-NetworkName) | | **Example** **Query** ```gql query Fees($network: NetworkName!) { fees(network: $network) { mintingFee sellingFee } } ``` **Variables** ```json {"network": "ropsten"} ``` **Response** ```json { "data": { "fees": { "mintingFee": "abc123", "sellingFee": "xyz789" } } } ``` [Queries](#group-Operations-Queries) ### `listCollectionMetadata` **Description** 🔒 JWT Token Returns list of collection metadata **Response** Returns a [`CollectionMetadataListResDTO!`](#definition-CollectionMetadataListResDTO) **Arguments** | Name | Description | | ------------------------------------------------------------------ | ----------- | | `pagination` - [`PaginationParams!`](#definition-PaginationParams) | | **Example** **Query** ```gql 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** ```json {"pagination": PaginationParams} ``` **Response** ```json { "data": { "listCollectionMetadata": { "items": [CollectionMetadataDto], "count": 123.45 } } } ``` [Queries](#group-Operations-Queries) ### `listMetadata` **Description** 🔒 JWT Token Returns list of NFT metadata **Response** Returns a [`NftMetadataListResDTO!`](#definition-NftMetadataListResDTO) **Arguments** | Name | Description | | ------------------------------------------------------------------ | ----------- | | `pagination` - [`PaginationParams!`](#definition-PaginationParams) | | **Example** **Query** ```gql query ListMetadata($pagination: PaginationParams!) { listMetadata(pagination: $pagination) { items { id fileName title description artistId fileType networkName backgroundColor externalUrl youtubeUrl attributes { ...NftMetadataAttributeObjectFragment } } count } } ``` **Variables** ```json {"pagination": PaginationParams} ``` **Response** ```json { "data": { "listMetadata": { "items": [NftMetadataDraftResDTO], "count": 123.45 } } } ``` [Queries](#group-Operations-Queries) ### `metadata` **Description** 🔒 JWT Token Retrieve metadata by id **Response** Returns a [`NftMetadataDTO!`](#definition-NftMetadataDTO) **Arguments** | Name | Description | | ------------------------------------ | ----------- | | `id` - [`Float!`](#definition-Float) | | **Example** **Query** ```gql 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** ```json {"id": 987.65} ``` **Response** ```json { "data": { "metadata": { "id": 123, "userSub": "xyz789", "title": "xyz789", "description": "xyz789", "artistId": "abc123", "fileType": "IMAGE", "networkName": "ropsten", "s3Key": "xyz789", "s3CoverKey": "xyz789", "ipfsNftUrl": "xyz789", "ipfsCoverUrl": "abc123", "ipfsMetadataUrl": "xyz789", "ipfsNftHash": "abc123", "ipfsCoverHash": "xyz789", "licenceS3Key": "xyz789", "ipfsLicenceHash": "xyz789", "nftLicence": NftLicenceDto, "ipfsMetadataHash": "xyz789", "status": "PENDING_UPLOAD", "backgroundColor": "xyz789", "externalUrl": "abc123", "youtubeUrl": "abc123", "attributes": [NftMetadataAttributeObject], "ipfsNftPublicUrl": "xyz789", "ipfsCoverPublicUrl": "xyz789", "ipfsMetadataPublicUrl": "abc123", "ipfsLicencePublicUrl": "abc123" } } } ``` [Queries](#group-Operations-Queries) ### `nftUses` **Description** 🔒 JWT Token Licensed nft buyer rights **Response** Returns a [`NftUsesDTO!`](#definition-NftUsesDTO) **Example** **Query** ```gql query NftUses { nftUses { list { id name description position nftUseType } } } ``` **Response** ```json {"data": {"nftUses": {"list": [NftUseDTO]}}} ``` [Queries](#group-Operations-Queries) ### `person` **Description** 🔓 Public Returns single person **Response** Returns a [`PersonDto`](#definition-PersonDto) **Arguments** | Name | Description | | ------------------------------------------------------------------ | ----------- | | `identifier` - [`PersonIdentifier!`](#definition-PersonIdentifier) | | **Example** **Query** ```gql query Person($identifier: PersonIdentifier!) { person(identifier: $identifier) { id walletAddress smartWalletAddress username avatarS3Key avatarUrl } } ``` **Variables** ```json {"identifier": PersonIdentifier} ``` **Response** ```json { "data": { "person": { "id": "abc123", "walletAddress": "abc123", "smartWalletAddress": "abc123", "username": "abc123", "avatarS3Key": "xyz789", "avatarUrl": "xyz789" } } } ``` [Queries](#group-Operations-Queries) ### `persons` **Description** 🔓 Public Returns persons **Response** Returns a [`Persons!`](#definition-Persons) **Arguments** | Name | Description | | ------------------------------------------------------------------ | ----------- | | `pagination` - [`PaginationParams!`](#definition-PaginationParams) | | **Example** **Query** ```gql query Persons($pagination: PaginationParams!) { persons(pagination: $pagination) { items { id walletAddress smartWalletAddress username avatarS3Key avatarUrl } count } } ``` **Variables** ```json {"pagination": PaginationParams} ``` **Response** ```json { "data": { "persons": {"items": [PersonDto], "count": 987.65} } } ``` [Queries](#group-Operations-Queries) ### `token` **Description** 🔓 Public Returns single token **Response** Returns a [`Token`](#definition-Token) **Arguments** | Name | Description | | ----------------------------------------------------- | ----------- | | `network` - [`NetworkName!`](#definition-NetworkName) | | | `id` - [`String!`](#definition-String) | | **Example** **Query** ```gql 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** ```json {"network": "ropsten", "id": "xyz789"} ``` **Response** ```json { "data": { "token": { "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": "xyz789", "metadata": NftMetadataDTO, "nftUrl": "abc123", "coverUrl": "xyz789", "networkName": "ropsten", "createdAt": "xyz789", "updatedAt": "xyz789" } } } ``` [Queries](#group-Operations-Queries) ### `tokens` **Description** 🔓 Public Returns tokens **Response** Returns [`[Token!]!`](#definition-Token) **Arguments** | Name | Description | | --------------------------------------------------- | ----------- | | `input` - [`tokensInput!`](#definition-tokensInput) | | **Example** **Query** ```gql 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** ```json {"input": tokensInput} ``` **Response** ```json { "data": { "tokens": [ { "id": "xyz789", "tokenId": "xyz789", "collectionContract": Collection, "minter": "xyz789", "enterprise": CollectionEntity, "artist": CollectionEntity, "amount": "xyz789", "royaltyRecipient": "abc123", "royaltyNumerator": "abc123", "owners": [TokenOwner], "ownersWithMetadata": [OwnerWithMetadata], "listing": Listing, "purchases": [Purchase], "tokenURI": "xyz789", "metadata": NftMetadataDTO, "nftUrl": "abc123", "coverUrl": "abc123", "networkName": "ropsten", "createdAt": "xyz789", "updatedAt": "abc123" } ] } } ``` ## Mutations ### `createAvatarUrl` **Description** 🔒 JWT Token Creates Avatar URL **Response** Returns an [`AvatarLinkResDTO!`](#definition-AvatarLinkResDTO) **Arguments** | Name | Description | | ------------------------------------------------------------------ | ----------- | | `avatarLink` - [`AvatarLinkReqDTO!`](#definition-AvatarLinkReqDTO) | | **Example** **Query** ```gql mutation CreateAvatarUrl($avatarLink: AvatarLinkReqDTO!) { createAvatarUrl(avatarLink: $avatarLink) { avatarUploadUrl } } ``` **Variables** ```json {"avatarLink": AvatarLinkReqDTO} ``` **Response** ```json { "data": { "createAvatarUrl": { "avatarUploadUrl": "abc123" } } } ``` [Mutations](#group-Operations-Mutations) ### `createCollectionAssetsUploadUrl` **Description** 🔒 JWT Token Creates Metadata URL **Response** Returns a [`CollectionMetadataLinkResDTO!`](#definition-CollectionMetadataLinkResDTO) **Arguments** | Name | Description | | ------------------------------------------------------------------------------------------------------ | ----------------------------------- | | `collectionMetadataLink` - [`CollectionMetadataLinkReqDTO!`](#definition-CollectionMetadataLinkReqDTO) | | | `id` - [`Float!`](#definition-Float) | id of the collection-metadata draft | **Example** **Query** ```gql mutation CreateCollectionAssetsUploadUrl( $collectionMetadataLink: CollectionMetadataLinkReqDTO!, $id: Float! ) { createCollectionAssetsUploadUrl( collectionMetadataLink: $collectionMetadataLink, id: $id ) { coverUploadUrl bannerUploadUrl } } ``` **Variables** ```json { "collectionMetadataLink": CollectionMetadataLinkReqDTO, "id": 987.65 } ``` **Response** ```json { "data": { "createCollectionAssetsUploadUrl": { "coverUploadUrl": "abc123", "bannerUploadUrl": "xyz789" } } } ``` [Mutations](#group-Operations-Mutations) ### `createUrl` **Description** 🔒 JWT Token Creates Metadata URL **Response** Returns a [`NftMetadataLinkResDTO!`](#definition-NftMetadataLinkResDTO) **Arguments** | Name | Description | | --------------------------------------------------------------------------------- | ---------------------------- | | `nftMetadataLink` - [`NftMetadataLinkReqDTO!`](#definition-NftMetadataLinkReqDTO) | | | `id` - [`Float!`](#definition-Float) | id of the nft-metadata draft | **Example** **Query** ```gql mutation CreateUrl( $nftMetadataLink: NftMetadataLinkReqDTO!, $id: Float! ) { createUrl( nftMetadataLink: $nftMetadataLink, id: $id ) { uploadUrl coverUploadUrl } } ``` **Variables** ```json {"nftMetadataLink": NftMetadataLinkReqDTO, "id": 987.65} ``` **Response** ```json { "data": { "createUrl": { "uploadUrl": "abc123", "coverUploadUrl": "abc123" } } } ``` [Mutations](#group-Operations-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!`](#definition-CollectionMetadataDto) **Arguments** | Name | Description | | --------------------------------------------------------------------------------------------------------- | ----------- | | `collectionMetadataDraft` - [`CollectionMetadataDraftReqDTO!`](#definition-CollectionMetadataDraftReqDTO) | | **Example** **Query** ```gql 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** ```json {"collectionMetadataDraft": CollectionMetadataDraftReqDTO} ``` **Response** ```json { "data": { "saveCollectionDraft": { "id": 987, "userSub": "xyz789", "name": "abc123", "symbol": "xyz789", "description": "abc123", "coverImageS3Key": "xyz789", "coverImageS3Url": "abc123", "coverImageIpfsUrl": "xyz789", "coverImageIpfsHash": "abc123", "bannerImageS3Key": "xyz789", "bannerImageS3Url": "abc123", "bannerImageIpfsHash": "abc123", "bannerImageIpfsUrl": "xyz789", "externalLink": "abc123", "defaultRoyalties": "abc123", "defaultRoyaltyRecipient": "abc123", "metadataIpfsHash": "abc123", "metadataIpfsUrl": "xyz789", "networkName": "ropsten", "status": "PENDING_UPLOAD" } } } ``` [Mutations](#group-Operations-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!`](#definition-NftMetadataDraftResDTO) **Arguments** | Name | Description | | ------------------------------------------------------------------------------------ | ----------- | | `nftMetadataDraft` - [`NftMetadataDraftReqDTO!`](#definition-NftMetadataDraftReqDTO) | | **Example** **Query** ```gql mutation SaveDraft($nftMetadataDraft: NftMetadataDraftReqDTO!) { saveDraft(nftMetadataDraft: $nftMetadataDraft) { id fileName title description artistId fileType networkName backgroundColor externalUrl youtubeUrl attributes { value traitType displayType } } } ``` **Variables** ```json {"nftMetadataDraft": NftMetadataDraftReqDTO} ``` **Response** ```json { "data": { "saveDraft": { "id": 123.45, "fileName": "xyz789", "title": "abc123", "description": "abc123", "artistId": "xyz789", "fileType": "IMAGE", "networkName": "ropsten", "backgroundColor": "xyz789", "externalUrl": "xyz789", "youtubeUrl": "xyz789", "attributes": [NftMetadataAttributeObject] } } } ``` [Mutations](#group-Operations-Mutations) ### `updateCollectionDraft` **Description** 🔒 JWT Token Updates collection metadata draft **Response** Returns a [`CollectionMetadataDto!`](#definition-CollectionMetadataDto) **Arguments** | Name | Description | | --------------------------------------------------------------------------------------------------------- | ----------- | | `collectionMetadataDraft` - [`CollectionMetadataDraftReqDTO!`](#definition-CollectionMetadataDraftReqDTO) | | | `id` - [`Float!`](#definition-Float) | | **Example** **Query** ```gql 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** ```json { "collectionMetadataDraft": CollectionMetadataDraftReqDTO, "id": 123.45 } ``` **Response** ```json { "data": { "updateCollectionDraft": { "id": 987, "userSub": "xyz789", "name": "abc123", "symbol": "abc123", "description": "xyz789", "coverImageS3Key": "abc123", "coverImageS3Url": "abc123", "coverImageIpfsUrl": "abc123", "coverImageIpfsHash": "abc123", "bannerImageS3Key": "abc123", "bannerImageS3Url": "abc123", "bannerImageIpfsHash": "xyz789", "bannerImageIpfsUrl": "abc123", "externalLink": "abc123", "defaultRoyalties": "xyz789", "defaultRoyaltyRecipient": "abc123", "metadataIpfsHash": "xyz789", "metadataIpfsUrl": "abc123", "networkName": "ropsten", "status": "PENDING_UPLOAD" } } } ``` [Mutations](#group-Operations-Mutations) ### `updateDraft` **Description** 🔒 JWT Token Updates nft metadata draft **Response** Returns a [`NftMetadataDraftResDTO!`](#definition-NftMetadataDraftResDTO) **Arguments** | Name | Description | | ------------------------------------------------------------------------------------------ | ----------- | | `updateNFTMetadataDraft` - [`NftMetadataDraftReqDTO!`](#definition-NftMetadataDraftReqDTO) | | | `id` - [`Float!`](#definition-Float) | | **Example** **Query** ```gql 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** ```json { "updateNFTMetadataDraft": NftMetadataDraftReqDTO, "id": 987.65 } ``` **Response** ```json { "data": { "updateDraft": { "id": 987.65, "fileName": "xyz789", "title": "abc123", "description": "xyz789", "artistId": "xyz789", "fileType": "IMAGE", "networkName": "ropsten", "backgroundColor": "abc123", "externalUrl": "xyz789", "youtubeUrl": "abc123", "attributes": [NftMetadataAttributeObject] } } } ``` [Mutations](#group-Operations-Mutations) ### `updatePerson` **Description** 🔒 JWT Token Updates person **Response** Returns a [`PersonDto!`](#definition-PersonDto) **Arguments** | Name | Description | | ------------------------------------------------------------ | ----------- | | `updatePerson` - [`UpdatePerson!`](#definition-UpdatePerson) | | **Example** **Query** ```gql mutation UpdatePerson($updatePerson: UpdatePerson!) { updatePerson(updatePerson: $updatePerson) { id walletAddress smartWalletAddress username avatarS3Key avatarUrl } } ``` **Variables** ```json {"updatePerson": UpdatePerson} ``` **Response** ```json { "data": { "updatePerson": { "id": "xyz789", "walletAddress": "xyz789", "smartWalletAddress": "abc123", "username": "xyz789", "avatarS3Key": "abc123", "avatarUrl": "abc123" } } } ``` ## Types ### AddressResolverType **Values** | Enum Value | Description | | ----------- | ----------- | | `PERSON_ID` | | | `OWNER_URI` | | **Example** ```gql "PERSON_ID" ``` [Types](#group-Types) ### AvatarLinkReqDTO **Fields** | Input Field | Description | | ----------------------------------------------- | ------------------------------------------------------- | | `fileName` - [`String!`](#definition-String) | the file name must contain its extension -> \[name].jpg | | `contentType` - [`String!`](#definition-String) | mime type of the avatar file -> image/jpeg | **Example** ```json { "fileName": "abc123", "contentType": "abc123" } ``` [Types](#group-Types) ### AvatarLinkResDTO **Fields** | Field Name | Description | | --------------------------------------------------- | ----------- | | `avatarUploadUrl` - [`String!`](#definition-String) | | **Example** ```json {"avatarUploadUrl": "xyz789"} ``` [Types](#group-Types) ### BigInt **Example** ```json {} ``` [Types](#group-Types) ### BlockChangedFilter **Fields** | Input Field | Description | | ---------------------------------------- | ----------- | | `number_gte` - [`Int!`](#definition-Int) | | **Example** ```json {"number_gte": 987} ``` [Types](#group-Types) ### Block\_height **Fields** | Input Field | Description | | --------------------------------------- | ----------- | | `hash` - [`Bytes`](#definition-Bytes) | | | `number` - [`Int`](#definition-Int) | | | `number_gte` - [`Int`](#definition-Int) | | **Example** ```json {"hash": Bytes, "number": 123, "number_gte": 123} ``` [Types](#group-Types) ### Boolean **Description** The `Boolean` scalar type represents `true` or `false`. **Example** ```json true ``` [Types](#group-Types) ### Bytes **Example** ```gql Bytes ``` [Types](#group-Types) ### Collection **Fields** | Field Name | Description | | ------------------------------------------------------------------------- | ----------- | | `id` - [`String!`](#definition-String) | | | `owner` - [`String!`](#definition-String) | | | `tokens` - [`[Token!]`](#definition-Token) | | | `address` - [`String!`](#definition-String) | | | `contractURI` - [`String!`](#definition-String) | | | `networkName` - [`NetworkName!`](#definition-NetworkName) | | | `metadata` - [`CollectionMetadataDto`](#definition-CollectionMetadataDto) | | | `createdAt` - [`String!`](#definition-String) | | | `updatedAt` - [`String!`](#definition-String) | | **Example** ```json { "id": "xyz789", "owner": "abc123", "tokens": [Token], "address": "abc123", "contractURI": "xyz789", "networkName": "ropsten", "metadata": CollectionMetadataDto, "createdAt": "xyz789", "updatedAt": "abc123" } ``` [Types](#group-Types) ### CollectionContract\_filter **Fields** | Input Field | Description | | ------------------------------------------------------------------------------ | ----------------------------------- | | `_change_block` - [`BlockChangedFilter`](#definition-BlockChangedFilter) | Filter for the block changed event. | | `address` - [`Bytes`](#definition-Bytes) | | | `address_contains` - [`Bytes`](#definition-Bytes) | | | `address_gt` - [`Bytes`](#definition-Bytes) | | | `address_gte` - [`Bytes`](#definition-Bytes) | | | `address_in` - [`[Bytes!]`](#definition-Bytes) | | | `address_lt` - [`Bytes`](#definition-Bytes) | | | `address_lte` - [`Bytes`](#definition-Bytes) | | | `address_not` - [`Bytes`](#definition-Bytes) | | | `address_not_contains` - [`Bytes`](#definition-Bytes) | | | `address_not_in` - [`[Bytes!]`](#definition-Bytes) | | | `and` - [`[CollectionContract_filter]`](#definition-CollectionContract_filter) | | | `contractURI` - [`String`](#definition-String) | | | `contractURI_contains` - [`String`](#definition-String) | | | `contractURI_contains_nocase` - [`String`](#definition-String) | | | `contractURI_ends_with` - [`String`](#definition-String) | | | `contractURI_ends_with_nocase` - [`String`](#definition-String) | | | `contractURI_gt` - [`String`](#definition-String) | | | `contractURI_gte` - [`String`](#definition-String) | | | `contractURI_in` - [`[String!]`](#definition-String) | | | `contractURI_lt` - [`String`](#definition-String) | | | `contractURI_lte` - [`String`](#definition-String) | | | `contractURI_not` - [`String`](#definition-String) | | | `contractURI_not_contains` - [`String`](#definition-String) | | | `contractURI_not_contains_nocase` - [`String`](#definition-String) | | | `contractURI_not_ends_with` - [`String`](#definition-String) | | | `contractURI_not_ends_with_nocase` - [`String`](#definition-String) | | | `contractURI_not_in` - [`[String!]`](#definition-String) | | | `contractURI_not_starts_with` - [`String`](#definition-String) | | | `contractURI_not_starts_with_nocase` - [`String`](#definition-String) | | | `contractURI_starts_with` - [`String`](#definition-String) | | | `contractURI_starts_with_nocase` - [`String`](#definition-String) | | | `createdAt` - [`String`](#definition-String) | | | `createdAt_contains` - [`String`](#definition-String) | | | `createdAt_contains_nocase` - [`String`](#definition-String) | | | `createdAt_ends_with` - [`String`](#definition-String) | | | `createdAt_ends_with_nocase` - [`String`](#definition-String) | | | `createdAt_gt` - [`String`](#definition-String) | | | `createdAt_gte` - [`String`](#definition-String) | | | `createdAt_in` - [`[String!]`](#definition-String) | | | `createdAt_lt` - [`String`](#definition-String) | | | `createdAt_lte` - [`String`](#definition-String) | | | `createdAt_not` - [`String`](#definition-String) | | | `createdAt_not_contains` - [`String`](#definition-String) | | | `createdAt_not_contains_nocase` - [`String`](#definition-String) | | | `createdAt_not_ends_with` - [`String`](#definition-String) | | | `createdAt_not_ends_with_nocase` - [`String`](#definition-String) | | | `createdAt_not_in` - [`[String!]`](#definition-String) | | | `createdAt_not_starts_with` - [`String`](#definition-String) | | | `createdAt_not_starts_with_nocase` - [`String`](#definition-String) | | | `createdAt_starts_with` - [`String`](#definition-String) | | | `createdAt_starts_with_nocase` - [`String`](#definition-String) | | | `id` - [`ID`](#definition-ID) | | | `id_gt` - [`ID`](#definition-ID) | | | `id_gte` - [`ID`](#definition-ID) | | | `id_in` - [`[ID!]`](#definition-ID) | | | `id_lt` - [`ID`](#definition-ID) | | | `id_lte` - [`ID`](#definition-ID) | | | `id_not` - [`ID`](#definition-ID) | | | `id_not_in` - [`[ID!]`](#definition-ID) | | | `or` - [`[CollectionContract_filter]`](#definition-CollectionContract_filter) | | | `owner` - [`Bytes`](#definition-Bytes) | | | `owner_contains` - [`Bytes`](#definition-Bytes) | | | `owner_gt` - [`Bytes`](#definition-Bytes) | | | `owner_gte` - [`Bytes`](#definition-Bytes) | | | `owner_in` - [`[Bytes!]`](#definition-Bytes) | | | `owner_lt` - [`Bytes`](#definition-Bytes) | | | `owner_lte` - [`Bytes`](#definition-Bytes) | | | `owner_not` - [`Bytes`](#definition-Bytes) | | | `owner_not_contains` - [`Bytes`](#definition-Bytes) | | | `owner_not_in` - [`[Bytes!]`](#definition-Bytes) | | | `tokens_` - [`Token_filter`](#definition-Token_filter) | | | `updatedAt` - [`String`](#definition-String) | | | `updatedAt_contains` - [`String`](#definition-String) | | | `updatedAt_contains_nocase` - [`String`](#definition-String) | | | `updatedAt_ends_with` - [`String`](#definition-String) | | | `updatedAt_ends_with_nocase` - [`String`](#definition-String) | | | `updatedAt_gt` - [`String`](#definition-String) | | | `updatedAt_gte` - [`String`](#definition-String) | | | `updatedAt_in` - [`[String!]`](#definition-String) | | | `updatedAt_lt` - [`String`](#definition-String) | | | `updatedAt_lte` - [`String`](#definition-String) | | | `updatedAt_not` - [`String`](#definition-String) | | | `updatedAt_not_contains` - [`String`](#definition-String) | | | `updatedAt_not_contains_nocase` - [`String`](#definition-String) | | | `updatedAt_not_ends_with` - [`String`](#definition-String) | | | `updatedAt_not_ends_with_nocase` - [`String`](#definition-String) | | | `updatedAt_not_in` - [`[String!]`](#definition-String) | | | `updatedAt_not_starts_with` - [`String`](#definition-String) | | | `updatedAt_not_starts_with_nocase` - [`String`](#definition-String) | | | `updatedAt_starts_with` - [`String`](#definition-String) | | | `updatedAt_starts_with_nocase` - [`String`](#definition-String) | | **Example** ```json { "_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": "xyz789", "contractURI_contains": "abc123", "contractURI_contains_nocase": "xyz789", "contractURI_ends_with": "abc123", "contractURI_ends_with_nocase": "abc123", "contractURI_gt": "xyz789", "contractURI_gte": "xyz789", "contractURI_in": ["abc123"], "contractURI_lt": "abc123", "contractURI_lte": "xyz789", "contractURI_not": "xyz789", "contractURI_not_contains": "abc123", "contractURI_not_contains_nocase": "xyz789", "contractURI_not_ends_with": "xyz789", "contractURI_not_ends_with_nocase": "xyz789", "contractURI_not_in": ["xyz789"], "contractURI_not_starts_with": "xyz789", "contractURI_not_starts_with_nocase": "xyz789", "contractURI_starts_with": "abc123", "contractURI_starts_with_nocase": "xyz789", "createdAt": "abc123", "createdAt_contains": "abc123", "createdAt_contains_nocase": "xyz789", "createdAt_ends_with": "abc123", "createdAt_ends_with_nocase": "xyz789", "createdAt_gt": "xyz789", "createdAt_gte": "abc123", "createdAt_in": ["xyz789"], "createdAt_lt": "abc123", "createdAt_lte": "abc123", "createdAt_not": "xyz789", "createdAt_not_contains": "xyz789", "createdAt_not_contains_nocase": "xyz789", "createdAt_not_ends_with": "abc123", "createdAt_not_ends_with_nocase": "abc123", "createdAt_not_in": ["xyz789"], "createdAt_not_starts_with": "abc123", "createdAt_not_starts_with_nocase": "xyz789", "createdAt_starts_with": "xyz789", "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": "xyz789", "updatedAt_contains_nocase": "xyz789", "updatedAt_ends_with": "abc123", "updatedAt_ends_with_nocase": "abc123", "updatedAt_gt": "xyz789", "updatedAt_gte": "xyz789", "updatedAt_in": ["xyz789"], "updatedAt_lt": "abc123", "updatedAt_lte": "abc123", "updatedAt_not": "xyz789", "updatedAt_not_contains": "xyz789", "updatedAt_not_contains_nocase": "xyz789", "updatedAt_not_ends_with": "xyz789", "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": "xyz789" } ``` [Types](#group-Types) ### CollectionContract\_orderBy **Values** | Enum Value | Description | | ------------- | ----------- | | `address` | | | `contractURI` | | | `createdAt` | | | `id` | | | `owner` | | | `tokens` | | | `updatedAt` | | **Example** ```gql "address" ``` [Types](#group-Types) ### CollectionEntity **Description** represents an element of the hierarchy within the enterprise. **Fields** | Field Name | Description | | -------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | | `id` - [`ID!`](#definition-ID) | Auto-incrementing identifier. | | `type` - [`CollectionEntityType!`](#definition-CollectionEntityType) | Specifies the type of entry. Represents the hierarchy level within the enterprise. | | `entityUri` - [`String`](#definition-String) | Tenant ID to which artists, enterprise and labels belong. | | `name` - [`String!`](#definition-String) | Entity name. | | `description` - [`String`](#definition-String) | Entity description. | | `avatarUrl` - [`String`](#definition-String) | avatar url, displayed on the storefront. | | `bannerUrl` - [`String`](#definition-String) | banner url, displayed on the storefront. | | `createdAt` - [`String!`](#definition-String) | Time at which the object was created. | | `updatedAt` - [`String!`](#definition-String) | Time at which the object was last updated. | **Example** ```json { "id": "4", "type": "ENTERPRISE", "entityUri": "abc123", "name": "abc123", "description": "abc123", "avatarUrl": "abc123", "bannerUrl": "xyz789", "createdAt": "xyz789", "updatedAt": "abc123" } ``` [Types](#group-Types) ### CollectionEntityType **Values** | Enum Value | Description | | ------------ | ----------- | | `ENTERPRISE` | | | `ARTIST` | | | `LABEL` | | **Example** ```gql "ENTERPRISE" ``` [Types](#group-Types) ### CollectionMetadataDraftReqDTO **Fields** | Input Field | Description | | ---------------------------------------------------------- | ----------- | | `name` - [`String!`](#definition-String) | | | `symbol` - [`String`](#definition-String) | | | `description` - [`String`](#definition-String) | | | `externalLink` - [`String`](#definition-String) | | | `defaultRoyalties` - [`String`](#definition-String) | | | `defaultRoyaltyRecipient` - [`String`](#definition-String) | | | `networkName` - [`NetworkName!`](#definition-NetworkName) | | **Example** ```json { "name": "xyz789", "symbol": "xyz789", "description": "xyz789", "externalLink": "abc123", "defaultRoyalties": "abc123", "defaultRoyaltyRecipient": "abc123", "networkName": "ropsten" } ``` [Types](#group-Types) ### CollectionMetadataDto **Fields** | Field Name | Description | | ---------------------------------------------------------- | ------------------------------------ | | `id` - [`Int`](#definition-Int) | id of the collection | | `userSub` - [`String`](#definition-String) | sub of the user | | `name` - [`String`](#definition-String) | name of the collection | | `symbol` - [`String`](#definition-String) | symbol of the collection | | `description` - [`String`](#definition-String) | description of the collection | | `coverImageS3Key` - [`String`](#definition-String) | s3 key of the cover image | | `coverImageS3Url` - [`String`](#definition-String) | s3 link of the cover image | | `coverImageIpfsUrl` - [`String`](#definition-String) | ipfs link of the cover image | | `coverImageIpfsHash` - [`String`](#definition-String) | ipfs hash of the cover image | | `bannerImageS3Key` - [`String`](#definition-String) | s3 key of the banner image | | `bannerImageS3Url` - [`String`](#definition-String) | s3 link of the banner image | | `bannerImageIpfsHash` - [`String`](#definition-String) | ipfs hash of the banner image | | `bannerImageIpfsUrl` - [`String`](#definition-String) | ipfs link of the banner image | | `externalLink` - [`String`](#definition-String) | external link of the collection | | `defaultRoyalties` - [`String`](#definition-String) | default royalty basis point | | `defaultRoyaltyRecipient` - [`String`](#definition-String) | default royalty recipient | | `metadataIpfsHash` - [`String`](#definition-String) | ipfs link of contract level metadata | | `metadataIpfsUrl` - [`String`](#definition-String) | ipfs link of contract level metadata | | `networkName` - [`NetworkName`](#definition-NetworkName) | name of the network | | `status` - [`FileStatus`](#definition-FileStatus) | status of the uploading files | **Example** ```json { "id": 123, "userSub": "xyz789", "name": "abc123", "symbol": "xyz789", "description": "abc123", "coverImageS3Key": "abc123", "coverImageS3Url": "abc123", "coverImageIpfsUrl": "xyz789", "coverImageIpfsHash": "xyz789", "bannerImageS3Key": "xyz789", "bannerImageS3Url": "abc123", "bannerImageIpfsHash": "abc123", "bannerImageIpfsUrl": "abc123", "externalLink": "abc123", "defaultRoyalties": "abc123", "defaultRoyaltyRecipient": "abc123", "metadataIpfsHash": "xyz789", "metadataIpfsUrl": "xyz789", "networkName": "ropsten", "status": "PENDING_UPLOAD" } ``` [Types](#group-Types) ### CollectionMetadataLinkReqDTO **Fields** | Input Field | Description | | ----------------------------------------------------- | ----------------------------------------------------------------------------------------- | | `coverFileName` - [`String!`](#definition-String) | the cover of the collection \| the cover name must contain its extension -> \[name].jpg | | `coverFileMimeType` - [`String!`](#definition-String) | mime type of the collection cover file -> image/jpeg | | `bannerFileName` - [`String`](#definition-String) | the banner of the collection \| the banner name must contain its extension -> \[name].jpg | | `bannerFileMimeType` - [`String`](#definition-String) | mime type of the collection banner file -> image/jpeg | **Example** ```json { "coverFileName": "abc123", "coverFileMimeType": "abc123", "bannerFileName": "xyz789", "bannerFileMimeType": "abc123" } ``` [Types](#group-Types) ### CollectionMetadataLinkResDTO **Fields** | Field Name | Description | | -------------------------------------------------- | ----------- | | `coverUploadUrl` - [`String`](#definition-String) | | | `bannerUploadUrl` - [`String`](#definition-String) | | **Example** ```json { "coverUploadUrl": "abc123", "bannerUploadUrl": "xyz789" } ``` [Types](#group-Types) ### CollectionMetadataListResDTO **Fields** | Field Name | Description | | -------------------------------------------------------------------------- | ----------- | | `items` - [`[CollectionMetadataDto!]!`](#definition-CollectionMetadataDto) | | | `count` - [`Float`](#definition-Float) | | **Example** ```json {"items": [CollectionMetadataDto], "count": 987.65} ``` [Types](#group-Types) ### CollectionsInput **Fields** | Input Field | Description | | ------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------- | | `network` - [`NetworkName!`](#definition-NetworkName) | Name of the blockchain network on which the transaction occurs | | `ownedBy` - [`OwnedBy`](#definition-OwnedBy) | Parameters filtering collections by owner. One collection can have only one owner. | | `queryParams` - [`collectionContractsQueryArgs`](#definition-collectionContractsQueryArgs) | Parameters filtering collections from subgraph. | **Example** ```json { "network": "ropsten", "ownedBy": OwnedBy, "queryParams": collectionContractsQueryArgs } ``` [Types](#group-Types) ### DisplayType **Values** | Enum Value | Description | | ------------------ | ----------- | | `DATE` | | | `NUMBER` | | | `BOOST_NUMBER` | | | `BOOST_PERCENTAGE` | | **Example** ```gql "DATE" ``` [Types](#group-Types) ### Fees **Fields** | Field Name | Description | | ---------------------------------------------- | ----------- | | `mintingFee` - [`String!`](#definition-String) | | | `sellingFee` - [`String!`](#definition-String) | | **Example** ```json { "mintingFee": "xyz789", "sellingFee": "xyz789" } ``` [Types](#group-Types) ### FileStatus **Values** | Enum Value | Description | | ---------------- | ----------- | | `PENDING_UPLOAD` | | | `UPLOADED` | | | `DRAFT` | | **Example** ```gql "PENDING_UPLOAD" ``` [Types](#group-Types) ### FileType **Values** | Enum Value | Description | | ---------- | ----------- | | `IMAGE` | | | `MEDIA` | | **Example** ```gql "IMAGE" ``` [Types](#group-Types) ### Float **Description** The `Float` scalar type represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point). **Example** ```json 987.65 ``` [Types](#group-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** ```gql "4" ``` [Types](#group-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** ```json 123 ``` [Types](#group-Types) ### Listing **Fields** | Field Name | Description | | --------------------------------------------------- | ----------- | | `id` - [`String!`](#definition-String) | | | `onSale` - [`Boolean!`](#definition-Boolean) | | | `seller` - [`Owner!`](#definition-Owner) | | | `salePrice` - [`String!`](#definition-String) | | | `amountListed` - [`String!`](#definition-String) | | | `amountRemaining` - [`String!`](#definition-String) | | | `createdAt` - [`String!`](#definition-String) | | | `updatedAt` - [`String!`](#definition-String) | | **Example** ```json { "id": "abc123", "onSale": false, "seller": Owner, "salePrice": "xyz789", "amountListed": "xyz789", "amountRemaining": "abc123", "createdAt": "abc123", "updatedAt": "abc123" } ``` [Types](#group-Types) ### Listing\_filter **Fields** | Input Field | Description | | ------------------------------------------------------------------------ | ----------------------------------- | | `_change_block` - [`BlockChangedFilter`](#definition-BlockChangedFilter) | Filter for the block changed event. | | `amountListed` - [`BigInt`](#definition-BigInt) | | | `amountListed_gt` - [`BigInt`](#definition-BigInt) | | | `amountListed_gte` - [`BigInt`](#definition-BigInt) | | | `amountListed_in` - [`[BigInt!]`](#definition-BigInt) | | | `amountListed_lt` - [`BigInt`](#definition-BigInt) | | | `amountListed_lte` - [`BigInt`](#definition-BigInt) | | | `amountListed_not` - [`BigInt`](#definition-BigInt) | | | `amountListed_not_in` - [`[BigInt!]`](#definition-BigInt) | | | `amountRemaining` - [`BigInt`](#definition-BigInt) | | | `amountRemaining_gt` - [`BigInt`](#definition-BigInt) | | | `amountRemaining_gte` - [`BigInt`](#definition-BigInt) | | | `amountRemaining_in` - [`[BigInt!]`](#definition-BigInt) | | | `amountRemaining_lt` - [`BigInt`](#definition-BigInt) | | | `amountRemaining_lte` - [`BigInt`](#definition-BigInt) | | | `amountRemaining_not` - [`BigInt`](#definition-BigInt) | | | `amountRemaining_not_in` - [`[BigInt!]`](#definition-BigInt) | | | `and` - [`[Listing_filter]`](#definition-Listing_filter) | | | `createdAt` - [`String`](#definition-String) | | | `createdAt_contains` - [`String`](#definition-String) | | | `createdAt_contains_nocase` - [`String`](#definition-String) | | | `createdAt_ends_with` - [`String`](#definition-String) | | | `createdAt_ends_with_nocase` - [`String`](#definition-String) | | | `createdAt_gt` - [`String`](#definition-String) | | | `createdAt_gte` - [`String`](#definition-String) | | | `createdAt_in` - [`[String!]`](#definition-String) | | | `createdAt_lt` - [`String`](#definition-String) | | | `createdAt_lte` - [`String`](#definition-String) | | | `createdAt_not` - [`String`](#definition-String) | | | `createdAt_not_contains` - [`String`](#definition-String) | | | `createdAt_not_contains_nocase` - [`String`](#definition-String) | | | `createdAt_not_ends_with` - [`String`](#definition-String) | | | `createdAt_not_ends_with_nocase` - [`String`](#definition-String) | | | `createdAt_not_in` - [`[String!]`](#definition-String) | | | `createdAt_not_starts_with` - [`String`](#definition-String) | | | `createdAt_not_starts_with_nocase` - [`String`](#definition-String) | | | `createdAt_starts_with` - [`String`](#definition-String) | | | `createdAt_starts_with_nocase` - [`String`](#definition-String) | | | `id` - [`ID`](#definition-ID) | | | `id_gt` - [`ID`](#definition-ID) | | | `id_gte` - [`ID`](#definition-ID) | | | `id_in` - [`[ID!]`](#definition-ID) | | | `id_lt` - [`ID`](#definition-ID) | | | `id_lte` - [`ID`](#definition-ID) | | | `id_not` - [`ID`](#definition-ID) | | | `id_not_in` - [`[ID!]`](#definition-ID) | | | `onSale` - [`Boolean`](#definition-Boolean) | | | `onSale_in` - [`[Boolean!]`](#definition-Boolean) | | | `onSale_not` - [`Boolean`](#definition-Boolean) | | | `onSale_not_in` - [`[Boolean!]`](#definition-Boolean) | | | `or` - [`[Listing_filter]`](#definition-Listing_filter) | | | `salePrice` - [`BigInt`](#definition-BigInt) | | | `salePrice_gt` - [`BigInt`](#definition-BigInt) | | | `salePrice_gte` - [`BigInt`](#definition-BigInt) | | | `salePrice_in` - [`[BigInt!]`](#definition-BigInt) | | | `salePrice_lt` - [`BigInt`](#definition-BigInt) | | | `salePrice_lte` - [`BigInt`](#definition-BigInt) | | | `salePrice_not` - [`BigInt`](#definition-BigInt) | | | `salePrice_not_in` - [`[BigInt!]`](#definition-BigInt) | | | `seller` - [`String`](#definition-String) | | | `seller_` - [`Owner_filter`](#definition-Owner_filter) | | | `seller_contains` - [`String`](#definition-String) | | | `seller_contains_nocase` - [`String`](#definition-String) | | | `seller_ends_with` - [`String`](#definition-String) | | | `seller_ends_with_nocase` - [`String`](#definition-String) | | | `seller_gt` - [`String`](#definition-String) | | | `seller_gte` - [`String`](#definition-String) | | | `seller_in` - [`[String!]`](#definition-String) | | | `seller_lt` - [`String`](#definition-String) | | | `seller_lte` - [`String`](#definition-String) | | | `seller_not` - [`String`](#definition-String) | | | `seller_not_contains` - [`String`](#definition-String) | | | `seller_not_contains_nocase` - [`String`](#definition-String) | | | `seller_not_ends_with` - [`String`](#definition-String) | | | `seller_not_ends_with_nocase` - [`String`](#definition-String) | | | `seller_not_in` - [`[String!]`](#definition-String) | | | `seller_not_starts_with` - [`String`](#definition-String) | | | `seller_not_starts_with_nocase` - [`String`](#definition-String) | | | `seller_starts_with` - [`String`](#definition-String) | | | `seller_starts_with_nocase` - [`String`](#definition-String) | | | `token` - [`String`](#definition-String) | | | `token_` - [`Token_filter`](#definition-Token_filter) | | | `token_contains` - [`String`](#definition-String) | | | `token_contains_nocase` - [`String`](#definition-String) | | | `token_ends_with` - [`String`](#definition-String) | | | `token_ends_with_nocase` - [`String`](#definition-String) | | | `token_gt` - [`String`](#definition-String) | | | `token_gte` - [`String`](#definition-String) | | | `token_in` - [`[String!]`](#definition-String) | | | `token_lt` - [`String`](#definition-String) | | | `token_lte` - [`String`](#definition-String) | | | `token_not` - [`String`](#definition-String) | | | `token_not_contains` - [`String`](#definition-String) | | | `token_not_contains_nocase` - [`String`](#definition-String) | | | `token_not_ends_with` - [`String`](#definition-String) | | | `token_not_ends_with_nocase` - [`String`](#definition-String) | | | `token_not_in` - [`[String!]`](#definition-String) | | | `token_not_starts_with` - [`String`](#definition-String) | | | `token_not_starts_with_nocase` - [`String`](#definition-String) | | | `token_starts_with` - [`String`](#definition-String) | | | `token_starts_with_nocase` - [`String`](#definition-String) | | | `updatedAt` - [`String`](#definition-String) | | | `updatedAt_contains` - [`String`](#definition-String) | | | `updatedAt_contains_nocase` - [`String`](#definition-String) | | | `updatedAt_ends_with` - [`String`](#definition-String) | | | `updatedAt_ends_with_nocase` - [`String`](#definition-String) | | | `updatedAt_gt` - [`String`](#definition-String) | | | `updatedAt_gte` - [`String`](#definition-String) | | | `updatedAt_in` - [`[String!]`](#definition-String) | | | `updatedAt_lt` - [`String`](#definition-String) | | | `updatedAt_lte` - [`String`](#definition-String) | | | `updatedAt_not` - [`String`](#definition-String) | | | `updatedAt_not_contains` - [`String`](#definition-String) | | | `updatedAt_not_contains_nocase` - [`String`](#definition-String) | | | `updatedAt_not_ends_with` - [`String`](#definition-String) | | | `updatedAt_not_ends_with_nocase` - [`String`](#definition-String) | | | `updatedAt_not_in` - [`[String!]`](#definition-String) | | | `updatedAt_not_starts_with` - [`String`](#definition-String) | | | `updatedAt_not_starts_with_nocase` - [`String`](#definition-String) | | | `updatedAt_starts_with` - [`String`](#definition-String) | | | `updatedAt_starts_with_nocase` - [`String`](#definition-String) | | **Example** ```json { "_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": "xyz789", "createdAt_contains_nocase": "xyz789", "createdAt_ends_with": "abc123", "createdAt_ends_with_nocase": "abc123", "createdAt_gt": "xyz789", "createdAt_gte": "xyz789", "createdAt_in": ["abc123"], "createdAt_lt": "xyz789", "createdAt_lte": "xyz789", "createdAt_not": "xyz789", "createdAt_not_contains": "abc123", "createdAt_not_contains_nocase": "xyz789", "createdAt_not_ends_with": "xyz789", "createdAt_not_ends_with_nocase": "abc123", "createdAt_not_in": ["xyz789"], "createdAt_not_starts_with": "abc123", "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], "onSale": true, "onSale_in": [false], "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": "xyz789", "seller_": Owner_filter, "seller_contains": "xyz789", "seller_contains_nocase": "abc123", "seller_ends_with": "xyz789", "seller_ends_with_nocase": "abc123", "seller_gt": "xyz789", "seller_gte": "xyz789", "seller_in": ["abc123"], "seller_lt": "xyz789", "seller_lte": "xyz789", "seller_not": "abc123", "seller_not_contains": "xyz789", "seller_not_contains_nocase": "xyz789", "seller_not_ends_with": "abc123", "seller_not_ends_with_nocase": "xyz789", "seller_not_in": ["abc123"], "seller_not_starts_with": "abc123", "seller_not_starts_with_nocase": "xyz789", "seller_starts_with": "xyz789", "seller_starts_with_nocase": "xyz789", "token": "abc123", "token_": Token_filter, "token_contains": "abc123", "token_contains_nocase": "xyz789", "token_ends_with": "xyz789", "token_ends_with_nocase": "abc123", "token_gt": "abc123", "token_gte": "abc123", "token_in": ["abc123"], "token_lt": "xyz789", "token_lte": "abc123", "token_not": "abc123", "token_not_contains": "abc123", "token_not_contains_nocase": "xyz789", "token_not_ends_with": "xyz789", "token_not_ends_with_nocase": "abc123", "token_not_in": ["abc123"], "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": "xyz789", "updatedAt_gte": "xyz789", "updatedAt_in": ["xyz789"], "updatedAt_lt": "abc123", "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": "xyz789", "updatedAt_not_in": ["xyz789"], "updatedAt_not_starts_with": "abc123", "updatedAt_not_starts_with_nocase": "abc123", "updatedAt_starts_with": "abc123", "updatedAt_starts_with_nocase": "abc123" } ``` [Types](#group-Types) ### MintedBy **Fields** | Input Field | Description | | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `type` - [`AddressResolverType`](#definition-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`](#definition-String) | The value by which the tokens/collections are filtered. | **Example** ```json {"type": "PERSON_ID", "value": "xyz789"} ``` [Types](#group-Types) ### NetworkName **Values** | Enum Value | Description | | ------------- | ----------- | | `ropsten` | | | `kovan` | | | `ownet` | | | `mainnet` | | | `binance` | | | `bnbtest` | | | `sepolia` | | | `local` | | | `test` | | | `polygon` | | | `goerli` | | | `mumbai` | | | `ethereum` | | | `shibuya` | | | `amoy` | | | `base` | | | `baseSepolia` | | **Example** ```gql "ropsten" ``` [Types](#group-Types) ### NftLicenceDto **Fields** | Field Name | Description | | ---------------------------------------------------------------- | ----------- | | `revelatorTermsAndConditions` - [`Boolean`](#definition-Boolean) | | | `nftTitle` - [`String`](#definition-String) | | | `label` - [`String`](#definition-String) | | | `royaltyRate` - [`String`](#definition-String) | | | `personalUses` - [`[NftUseDTO!]`](#definition-NftUseDTO) | | | `commercialUses` - [`[NftUseDTO!]`](#definition-NftUseDTO) | | **Example** ```json { "revelatorTermsAndConditions": false, "nftTitle": "xyz789", "label": "abc123", "royaltyRate": "xyz789", "personalUses": [NftUseDTO], "commercialUses": [NftUseDTO] } ``` [Types](#group-Types) ### NftMetadataAttributeInput **Fields** | Input Field | Description | | -------------------------------------------------------- | ----------- | | `value` - [`String!`](#definition-String) | | | `traitType` - [`String`](#definition-String) | | | `displayType` - [`DisplayType`](#definition-DisplayType) | | **Example** ```json { "value": "xyz789", "traitType": "xyz789", "displayType": "DATE" } ``` [Types](#group-Types) ### NftMetadataAttributeObject **Fields** | Field Name | Description | | -------------------------------------------------------- | ----------- | | `value` - [`String`](#definition-String) | | | `traitType` - [`String`](#definition-String) | | | `displayType` - [`DisplayType`](#definition-DisplayType) | | **Example** ```json { "value": "abc123", "traitType": "xyz789", "displayType": "DATE" } ``` [Types](#group-Types) ### NftMetadataDTO **Fields** | Field Name | Description | | ---------------------------------------------------------------------------------------- | ----------- | | `id` - [`Int`](#definition-Int) | | | `userSub` - [`String`](#definition-String) | | | `title` - [`String`](#definition-String) | | | `description` - [`String`](#definition-String) | | | `artistId` - [`String`](#definition-String) | | | `fileType` - [`FileType`](#definition-FileType) | | | `networkName` - [`NetworkName`](#definition-NetworkName) | | | `s3Key` - [`String`](#definition-String) | | | `s3CoverKey` - [`String`](#definition-String) | | | `ipfsNftUrl` - [`String`](#definition-String) | | | `ipfsCoverUrl` - [`String`](#definition-String) | | | `ipfsMetadataUrl` - [`String`](#definition-String) | | | `ipfsNftHash` - [`String`](#definition-String) | | | `ipfsCoverHash` - [`String`](#definition-String) | | | `licenceS3Key` - [`String`](#definition-String) | | | `ipfsLicenceHash` - [`String`](#definition-String) | | | `nftLicence` - [`NftLicenceDto`](#definition-NftLicenceDto) | | | `ipfsMetadataHash` - [`String`](#definition-String) | | | `status` - [`FileStatus`](#definition-FileStatus) | | | `backgroundColor` - [`String`](#definition-String) | | | `externalUrl` - [`String`](#definition-String) | | | `youtubeUrl` - [`String`](#definition-String) | | | `attributes` - [`[NftMetadataAttributeObject!]`](#definition-NftMetadataAttributeObject) | | | `ipfsNftPublicUrl` - [`String`](#definition-String) | | | `ipfsCoverPublicUrl` - [`String`](#definition-String) | | | `ipfsMetadataPublicUrl` - [`String`](#definition-String) | | | `ipfsLicencePublicUrl` - [`String`](#definition-String) | | **Example** ```json { "id": 987, "userSub": "abc123", "title": "abc123", "description": "xyz789", "artistId": "abc123", "fileType": "IMAGE", "networkName": "ropsten", "s3Key": "xyz789", "s3CoverKey": "abc123", "ipfsNftUrl": "xyz789", "ipfsCoverUrl": "xyz789", "ipfsMetadataUrl": "abc123", "ipfsNftHash": "abc123", "ipfsCoverHash": "xyz789", "licenceS3Key": "abc123", "ipfsLicenceHash": "abc123", "nftLicence": NftLicenceDto, "ipfsMetadataHash": "abc123", "status": "PENDING_UPLOAD", "backgroundColor": "abc123", "externalUrl": "abc123", "youtubeUrl": "xyz789", "attributes": [NftMetadataAttributeObject], "ipfsNftPublicUrl": "abc123", "ipfsCoverPublicUrl": "abc123", "ipfsMetadataPublicUrl": "xyz789", "ipfsLicencePublicUrl": "abc123" } ``` [Types](#group-Types) ### NftMetadataDraftReqDTO **Fields** | Input Field | Description | | -------------------------------------------------------------------------------------- | ----------- | | `backgroundColor` - [`String`](#definition-String) | | | `externalUrl` - [`String`](#definition-String) | | | `youtubeUrl` - [`String`](#definition-String) | | | `attributes` - [`[NftMetadataAttributeInput!]`](#definition-NftMetadataAttributeInput) | | | `title` - [`String!`](#definition-String) | | | `description` - [`String`](#definition-String) | | | `artistId` - [`String`](#definition-String) | | | `fileType` - [`FileType!`](#definition-FileType) | | | `networkName` - [`NetworkName!`](#definition-NetworkName) | | | `revelatorTermsAndConditions` - [`Boolean`](#definition-Boolean) | | | `personalUses` - [`[Int!]`](#definition-Int) | | | `commercialUses` - [`[Int!]`](#definition-Int) | | **Example** ```json { "backgroundColor": "xyz789", "externalUrl": "abc123", "youtubeUrl": "abc123", "attributes": [NftMetadataAttributeInput], "title": "xyz789", "description": "abc123", "artistId": "abc123", "fileType": "IMAGE", "networkName": "ropsten", "revelatorTermsAndConditions": true, "personalUses": [123], "commercialUses": [987] } ``` [Types](#group-Types) ### NftMetadataDraftResDTO **Fields** | Field Name | Description | | ---------------------------------------------------------------------------------------- | ----------- | | `id` - [`Float`](#definition-Float) | | | `fileName` - [`String`](#definition-String) | | | `title` - [`String`](#definition-String) | | | `description` - [`String`](#definition-String) | | | `artistId` - [`String`](#definition-String) | | | `fileType` - [`FileType`](#definition-FileType) | | | `networkName` - [`NetworkName`](#definition-NetworkName) | | | `backgroundColor` - [`String`](#definition-String) | | | `externalUrl` - [`String`](#definition-String) | | | `youtubeUrl` - [`String`](#definition-String) | | | `attributes` - [`[NftMetadataAttributeObject!]`](#definition-NftMetadataAttributeObject) | | **Example** ```json { "id": 123.45, "fileName": "abc123", "title": "xyz789", "description": "abc123", "artistId": "xyz789", "fileType": "IMAGE", "networkName": "ropsten", "backgroundColor": "xyz789", "externalUrl": "xyz789", "youtubeUrl": "abc123", "attributes": [NftMetadataAttributeObject] } ``` [Types](#group-Types) ### NftMetadataLinkReqDTO **Fields** | Input Field | Description | | ------------------------------------------------ | ------------------------------------------------------- | | `fileName` - [`String!`](#definition-String) | the file name must contain its extension -> \[name].jpg | | `fileMime` - [`String!`](#definition-String) | mime type of the nft file -> image/jpeg | | `coverFileName` - [`String`](#definition-String) | the file name must contain its extension -> \[name].jpg | | `coverMime` - [`String`](#definition-String) | mime type of the cover image file -> image/jpeg | **Example** ```json { "fileName": "xyz789", "fileMime": "xyz789", "coverFileName": "xyz789", "coverMime": "xyz789" } ``` [Types](#group-Types) ### NftMetadataLinkResDTO **Fields** | Field Name | Description | | ------------------------------------------------- | ----------- | | `uploadUrl` - [`String!`](#definition-String) | | | `coverUploadUrl` - [`String`](#definition-String) | | **Example** ```json { "uploadUrl": "xyz789", "coverUploadUrl": "xyz789" } ``` [Types](#group-Types) ### NftMetadataListResDTO **Fields** | Field Name | Description | | ---------------------------------------------------------------------------- | ----------- | | `items` - [`[NftMetadataDraftResDTO!]!`](#definition-NftMetadataDraftResDTO) | | | `count` - [`Float`](#definition-Float) | | **Example** ```json {"items": [NftMetadataDraftResDTO], "count": 123.45} ``` [Types](#group-Types) ### NftUseDTO **Fields** | Field Name | Description | | ----------------------------------------------------- | ----------- | | `id` - [`Int`](#definition-Int) | | | `name` - [`String`](#definition-String) | | | `description` - [`String`](#definition-String) | | | `position` - [`Float`](#definition-Float) | | | `nftUseType` - [`NftUseType`](#definition-NftUseType) | | **Example** ```json { "id": 123, "name": "abc123", "description": "abc123", "position": 987.65, "nftUseType": "personal" } ``` [Types](#group-Types) ### NftUseType **Values** | Enum Value | Description | | ------------ | ----------- | | `personal` | | | `commercial` | | **Example** ```gql "personal" ``` [Types](#group-Types) ### NftUsesDTO **Fields** | Field Name | Description | | ------------------------------------------------- | ----------- | | `list` - [`[NftUseDTO!]!`](#definition-NftUseDTO) | | **Example** ```json {"list": [NftUseDTO]} ``` [Types](#group-Types) ### OrderDirection **Description** Defines the order direction, either ascending or descending **Values** | Enum Value | Description | | ---------- | ----------- | | `asc` | | | `desc` | | **Example** ```gql "asc" ``` [Types](#group-Types) ### OwnedBy **Fields** | Input Field | Description | | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `type` - [`AddressResolverType`](#definition-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`](#definition-String) | The value by which the tokens/collections are filtered. | **Example** ```json {"type": "PERSON_ID", "value": "abc123"} ``` [Types](#group-Types) ### Owner **Fields** | Field Name | Description | | ------------------------------------------- | ----------- | | `address` - [`String!`](#definition-String) | | **Example** ```json {"address": "xyz789"} ``` [Types](#group-Types) ### OwnerWithMetadata **Fields** | Field Name | Description | | ----------------------------------------------------- | ----------- | | `amountOwned` - [`String!`](#definition-String) | | | `amountDeposited` - [`String!`](#definition-String) | | | `id` - [`String`](#definition-String) | | | `walletAddress` - [`String`](#definition-String) | | | `smartWalletAddress` - [`String`](#definition-String) | | | `username` - [`String`](#definition-String) | | | `avatarS3Key` - [`String`](#definition-String) | | | `avatarUrl` - [`String`](#definition-String) | | **Example** ```json { "amountOwned": "abc123", "amountDeposited": "xyz789", "id": "abc123", "walletAddress": "abc123", "smartWalletAddress": "xyz789", "username": "abc123", "avatarS3Key": "abc123", "avatarUrl": "xyz789" } ``` [Types](#group-Types) ### Owner\_filter **Fields** | Input Field | Description | | ------------------------------------------------------------------------ | ----------------------------------- | | `_change_block` - [`BlockChangedFilter`](#definition-BlockChangedFilter) | Filter for the block changed event. | | `address` - [`Bytes`](#definition-Bytes) | | | `address_contains` - [`Bytes`](#definition-Bytes) | | | `address_gt` - [`Bytes`](#definition-Bytes) | | | `address_gte` - [`Bytes`](#definition-Bytes) | | | `address_in` - [`[Bytes!]`](#definition-Bytes) | | | `address_lt` - [`Bytes`](#definition-Bytes) | | | `address_lte` - [`Bytes`](#definition-Bytes) | | | `address_not` - [`Bytes`](#definition-Bytes) | | | `address_not_contains` - [`Bytes`](#definition-Bytes) | | | `address_not_in` - [`[Bytes!]`](#definition-Bytes) | | | `and` - [`[Owner_filter]`](#definition-Owner_filter) | | | `id` - [`ID`](#definition-ID) | | | `id_gt` - [`ID`](#definition-ID) | | | `id_gte` - [`ID`](#definition-ID) | | | `id_in` - [`[ID!]`](#definition-ID) | | | `id_lt` - [`ID`](#definition-ID) | | | `id_lte` - [`ID`](#definition-ID) | | | `id_not` - [`ID`](#definition-ID) | | | `id_not_in` - [`[ID!]`](#definition-ID) | | | `listings_` - [`Listing_filter`](#definition-Listing_filter) | | | `or` - [`[Owner_filter]`](#definition-Owner_filter) | | | `purchases_` - [`Purchase_filter`](#definition-Purchase_filter) | | | `tokens_` - [`TokenOwner_filter`](#definition-TokenOwner_filter) | | **Example** ```json { "_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](#group-Types) ### PaginationParams **Fields** | Input Field | Description | | ---------------------------------------- | ----------- | | `startId` - [`Float`](#definition-Float) | | | `limit` - [`Float`](#definition-Float) | | **Example** ```json {"startId": 987.65, "limit": 123.45} ``` [Types](#group-Types) ### PersonDto **Fields** | Field Name | Description | | ----------------------------------------------------- | ----------- | | `id` - [`String`](#definition-String) | | | `walletAddress` - [`String`](#definition-String) | | | `smartWalletAddress` - [`String`](#definition-String) | | | `username` - [`String`](#definition-String) | | | `avatarS3Key` - [`String`](#definition-String) | | | `avatarUrl` - [`String`](#definition-String) | | **Example** ```json { "id": "xyz789", "walletAddress": "xyz789", "smartWalletAddress": "abc123", "username": "abc123", "avatarS3Key": "xyz789", "avatarUrl": "xyz789" } ``` [Types](#group-Types) ### PersonIdentifier **Fields** | Input Field | Description | | ------------------------------------------------ | ----------- | | `id` - [`String`](#definition-String) | | | `walletAddress` - [`String`](#definition-String) | | **Example** ```json { "id": "xyz789", "walletAddress": "abc123" } ``` [Types](#group-Types) ### Persons **Fields** | Field Name | Description | | ------------------------------------------------- | ----------- | | `items` - [`[PersonDto!]`](#definition-PersonDto) | | | `count` - [`Float`](#definition-Float) | | **Example** ```json {"items": [PersonDto], "count": 987.65} ``` [Types](#group-Types) ### Purchase **Fields** | Field Name | Description | | --------------------------------------------- | ----------- | | `id` - [`String!`](#definition-String) | | | `amount` - [`String!`](#definition-String) | | | `salePrice` - [`String!`](#definition-String) | | | `value` - [`String!`](#definition-String) | | | `buyer` - [`Owner!`](#definition-Owner) | | | `createdAt` - [`String!`](#definition-String) | | **Example** ```json { "id": "xyz789", "amount": "xyz789", "salePrice": "xyz789", "value": "xyz789", "buyer": Owner, "createdAt": "xyz789" } ``` [Types](#group-Types) ### Purchase\_filter **Fields** | Input Field | Description | | ------------------------------------------------------------------------ | ----------------------------------- | | `_change_block` - [`BlockChangedFilter`](#definition-BlockChangedFilter) | Filter for the block changed event. | | `amount` - [`BigInt`](#definition-BigInt) | | | `amount_gt` - [`BigInt`](#definition-BigInt) | | | `amount_gte` - [`BigInt`](#definition-BigInt) | | | `amount_in` - [`[BigInt!]`](#definition-BigInt) | | | `amount_lt` - [`BigInt`](#definition-BigInt) | | | `amount_lte` - [`BigInt`](#definition-BigInt) | | | `amount_not` - [`BigInt`](#definition-BigInt) | | | `amount_not_in` - [`[BigInt!]`](#definition-BigInt) | | | `and` - [`[Purchase_filter]`](#definition-Purchase_filter) | | | `buyer` - [`String`](#definition-String) | | | `buyer_` - [`Owner_filter`](#definition-Owner_filter) | | | `buyer_contains` - [`String`](#definition-String) | | | `buyer_contains_nocase` - [`String`](#definition-String) | | | `buyer_ends_with` - [`String`](#definition-String) | | | `buyer_ends_with_nocase` - [`String`](#definition-String) | | | `buyer_gt` - [`String`](#definition-String) | | | `buyer_gte` - [`String`](#definition-String) | | | `buyer_in` - [`[String!]`](#definition-String) | | | `buyer_lt` - [`String`](#definition-String) | | | `buyer_lte` - [`String`](#definition-String) | | | `buyer_not` - [`String`](#definition-String) | | | `buyer_not_contains` - [`String`](#definition-String) | | | `buyer_not_contains_nocase` - [`String`](#definition-String) | | | `buyer_not_ends_with` - [`String`](#definition-String) | | | `buyer_not_ends_with_nocase` - [`String`](#definition-String) | | | `buyer_not_in` - [`[String!]`](#definition-String) | | | `buyer_not_starts_with` - [`String`](#definition-String) | | | `buyer_not_starts_with_nocase` - [`String`](#definition-String) | | | `buyer_starts_with` - [`String`](#definition-String) | | | `buyer_starts_with_nocase` - [`String`](#definition-String) | | | `createdAt` - [`String`](#definition-String) | | | `createdAt_contains` - [`String`](#definition-String) | | | `createdAt_contains_nocase` - [`String`](#definition-String) | | | `createdAt_ends_with` - [`String`](#definition-String) | | | `createdAt_ends_with_nocase` - [`String`](#definition-String) | | | `createdAt_gt` - [`String`](#definition-String) | | | `createdAt_gte` - [`String`](#definition-String) | | | `createdAt_in` - [`[String!]`](#definition-String) | | | `createdAt_lt` - [`String`](#definition-String) | | | `createdAt_lte` - [`String`](#definition-String) | | | `createdAt_not` - [`String`](#definition-String) | | | `createdAt_not_contains` - [`String`](#definition-String) | | | `createdAt_not_contains_nocase` - [`String`](#definition-String) | | | `createdAt_not_ends_with` - [`String`](#definition-String) | | | `createdAt_not_ends_with_nocase` - [`String`](#definition-String) | | | `createdAt_not_in` - [`[String!]`](#definition-String) | | | `createdAt_not_starts_with` - [`String`](#definition-String) | | | `createdAt_not_starts_with_nocase` - [`String`](#definition-String) | | | `createdAt_starts_with` - [`String`](#definition-String) | | | `createdAt_starts_with_nocase` - [`String`](#definition-String) | | | `id` - [`ID`](#definition-ID) | | | `id_gt` - [`ID`](#definition-ID) | | | `id_gte` - [`ID`](#definition-ID) | | | `id_in` - [`[ID!]`](#definition-ID) | | | `id_lt` - [`ID`](#definition-ID) | | | `id_lte` - [`ID`](#definition-ID) | | | `id_not` - [`ID`](#definition-ID) | | | `id_not_in` - [`[ID!]`](#definition-ID) | | | `or` - [`[Purchase_filter]`](#definition-Purchase_filter) | | | `salePrice` - [`BigInt`](#definition-BigInt) | | | `salePrice_gt` - [`BigInt`](#definition-BigInt) | | | `salePrice_gte` - [`BigInt`](#definition-BigInt) | | | `salePrice_in` - [`[BigInt!]`](#definition-BigInt) | | | `salePrice_lt` - [`BigInt`](#definition-BigInt) | | | `salePrice_lte` - [`BigInt`](#definition-BigInt) | | | `salePrice_not` - [`BigInt`](#definition-BigInt) | | | `salePrice_not_in` - [`[BigInt!]`](#definition-BigInt) | | | `token` - [`String`](#definition-String) | | | `token_` - [`Token_filter`](#definition-Token_filter) | | | `token_contains` - [`String`](#definition-String) | | | `token_contains_nocase` - [`String`](#definition-String) | | | `token_ends_with` - [`String`](#definition-String) | | | `token_ends_with_nocase` - [`String`](#definition-String) | | | `token_gt` - [`String`](#definition-String) | | | `token_gte` - [`String`](#definition-String) | | | `token_in` - [`[String!]`](#definition-String) | | | `token_lt` - [`String`](#definition-String) | | | `token_lte` - [`String`](#definition-String) | | | `token_not` - [`String`](#definition-String) | | | `token_not_contains` - [`String`](#definition-String) | | | `token_not_contains_nocase` - [`String`](#definition-String) | | | `token_not_ends_with` - [`String`](#definition-String) | | | `token_not_ends_with_nocase` - [`String`](#definition-String) | | | `token_not_in` - [`[String!]`](#definition-String) | | | `token_not_starts_with` - [`String`](#definition-String) | | | `token_not_starts_with_nocase` - [`String`](#definition-String) | | | `token_starts_with` - [`String`](#definition-String) | | | `token_starts_with_nocase` - [`String`](#definition-String) | | | `value` - [`BigInt`](#definition-BigInt) | | | `value_gt` - [`BigInt`](#definition-BigInt) | | | `value_gte` - [`BigInt`](#definition-BigInt) | | | `value_in` - [`[BigInt!]`](#definition-BigInt) | | | `value_lt` - [`BigInt`](#definition-BigInt) | | | `value_lte` - [`BigInt`](#definition-BigInt) | | | `value_not` - [`BigInt`](#definition-BigInt) | | | `value_not_in` - [`[BigInt!]`](#definition-BigInt) | | **Example** ```json { "_change_block": BlockChangedFilter, "amount": {}, "amount_gt": {}, "amount_gte": {}, "amount_in": [{}], "amount_lt": {}, "amount_lte": {}, "amount_not": {}, "amount_not_in": [{}], "and": [Purchase_filter], "buyer": "xyz789", "buyer_": Owner_filter, "buyer_contains": "abc123", "buyer_contains_nocase": "xyz789", "buyer_ends_with": "abc123", "buyer_ends_with_nocase": "abc123", "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": "xyz789", "buyer_not_ends_with_nocase": "xyz789", "buyer_not_in": ["abc123"], "buyer_not_starts_with": "abc123", "buyer_not_starts_with_nocase": "abc123", "buyer_starts_with": "abc123", "buyer_starts_with_nocase": "xyz789", "createdAt": "xyz789", "createdAt_contains": "xyz789", "createdAt_contains_nocase": "abc123", "createdAt_ends_with": "abc123", "createdAt_ends_with_nocase": "xyz789", "createdAt_gt": "abc123", "createdAt_gte": "xyz789", "createdAt_in": ["xyz789"], "createdAt_lt": "abc123", "createdAt_lte": "abc123", "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": "xyz789", "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], "or": [Purchase_filter], "salePrice": {}, "salePrice_gt": {}, "salePrice_gte": {}, "salePrice_in": [{}], "salePrice_lt": {}, "salePrice_lte": {}, "salePrice_not": {}, "salePrice_not_in": [{}], "token": "xyz789", "token_": Token_filter, "token_contains": "xyz789", "token_contains_nocase": "abc123", "token_ends_with": "abc123", "token_ends_with_nocase": "xyz789", "token_gt": "xyz789", "token_gte": "xyz789", "token_in": ["xyz789"], "token_lt": "xyz789", "token_lte": "xyz789", "token_not": "abc123", "token_not_contains": "abc123", "token_not_contains_nocase": "abc123", "token_not_ends_with": "abc123", "token_not_ends_with_nocase": "xyz789", "token_not_in": ["abc123"], "token_not_starts_with": "abc123", "token_not_starts_with_nocase": "xyz789", "token_starts_with": "abc123", "token_starts_with_nocase": "abc123", "value": {}, "value_gt": {}, "value_gte": {}, "value_in": [{}], "value_lt": {}, "value_lte": {}, "value_not": {}, "value_not_in": [{}] } ``` [Types](#group-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** ```gql "xyz789" ``` [Types](#group-Types) ### Token **Fields** | Field Name | Description | | ------------------------------------------------------------------------------ | ----------- | | `id` - [`String!`](#definition-String) | | | `tokenId` - [`String!`](#definition-String) | | | `collectionContract` - [`Collection`](#definition-Collection) | | | `minter` - [`String!`](#definition-String) | | | `enterprise` - [`CollectionEntity`](#definition-CollectionEntity) | | | `artist` - [`CollectionEntity`](#definition-CollectionEntity) | | | `amount` - [`String!`](#definition-String) | | | `royaltyRecipient` - [`String`](#definition-String) | | | `royaltyNumerator` - [`String`](#definition-String) | | | `owners` - [`[TokenOwner!]!`](#definition-TokenOwner) | | | `ownersWithMetadata` - [`[OwnerWithMetadata!]`](#definition-OwnerWithMetadata) | | | `listing` - [`Listing!`](#definition-Listing) | | | `purchases` - [`[Purchase!]!`](#definition-Purchase) | | | `tokenURI` - [`String!`](#definition-String) | | | `metadata` - [`NftMetadataDTO`](#definition-NftMetadataDTO) | | | `nftUrl` - [`String`](#definition-String) | | | `coverUrl` - [`String`](#definition-String) | | | `networkName` - [`NetworkName!`](#definition-NetworkName) | | | `createdAt` - [`String!`](#definition-String) | | | `updatedAt` - [`String!`](#definition-String) | | **Example** ```json { "id": "xyz789", "tokenId": "xyz789", "collectionContract": Collection, "minter": "abc123", "enterprise": CollectionEntity, "artist": CollectionEntity, "amount": "abc123", "royaltyRecipient": "abc123", "royaltyNumerator": "xyz789", "owners": [TokenOwner], "ownersWithMetadata": [OwnerWithMetadata], "listing": Listing, "purchases": [Purchase], "tokenURI": "abc123", "metadata": NftMetadataDTO, "nftUrl": "abc123", "coverUrl": "abc123", "networkName": "ropsten", "createdAt": "abc123", "updatedAt": "abc123" } ``` [Types](#group-Types) ### TokenOwner **Fields** | Field Name | Description | | --------------------------------------------------- | ----------- | | `id` - [`String!`](#definition-String) | | | `owner` - [`Owner!`](#definition-Owner) | | | `amountOwned` - [`String!`](#definition-String) | | | `amountDeposited` - [`String!`](#definition-String) | | **Example** ```json { "id": "abc123", "owner": Owner, "amountOwned": "abc123", "amountDeposited": "abc123" } ``` [Types](#group-Types) ### TokenOwner\_filter **Fields** | Input Field | Description | | ------------------------------------------------------------------------ | ----------------------------------- | | `_change_block` - [`BlockChangedFilter`](#definition-BlockChangedFilter) | Filter for the block changed event. | | `amountDeposited` - [`BigInt`](#definition-BigInt) | | | `amountDeposited_gt` - [`BigInt`](#definition-BigInt) | | | `amountDeposited_gte` - [`BigInt`](#definition-BigInt) | | | `amountDeposited_in` - [`[BigInt!]`](#definition-BigInt) | | | `amountDeposited_lt` - [`BigInt`](#definition-BigInt) | | | `amountDeposited_lte` - [`BigInt`](#definition-BigInt) | | | `amountDeposited_not` - [`BigInt`](#definition-BigInt) | | | `amountDeposited_not_in` - [`[BigInt!]`](#definition-BigInt) | | | `amountOwned` - [`BigInt`](#definition-BigInt) | | | `amountOwned_gt` - [`BigInt`](#definition-BigInt) | | | `amountOwned_gte` - [`BigInt`](#definition-BigInt) | | | `amountOwned_in` - [`[BigInt!]`](#definition-BigInt) | | | `amountOwned_lt` - [`BigInt`](#definition-BigInt) | | | `amountOwned_lte` - [`BigInt`](#definition-BigInt) | | | `amountOwned_not` - [`BigInt`](#definition-BigInt) | | | `amountOwned_not_in` - [`[BigInt!]`](#definition-BigInt) | | | `and` - [`[TokenOwner_filter]`](#definition-TokenOwner_filter) | | | `id` - [`ID`](#definition-ID) | | | `id_gt` - [`ID`](#definition-ID) | | | `id_gte` - [`ID`](#definition-ID) | | | `id_in` - [`[ID!]`](#definition-ID) | | | `id_lt` - [`ID`](#definition-ID) | | | `id_lte` - [`ID`](#definition-ID) | | | `id_not` - [`ID`](#definition-ID) | | | `id_not_in` - [`[ID!]`](#definition-ID) | | | `or` - [`[TokenOwner_filter]`](#definition-TokenOwner_filter) | | | `owner` - [`String`](#definition-String) | | | `owner_` - [`Owner_filter`](#definition-Owner_filter) | | | `owner_contains` - [`String`](#definition-String) | | | `owner_contains_nocase` - [`String`](#definition-String) | | | `owner_ends_with` - [`String`](#definition-String) | | | `owner_ends_with_nocase` - [`String`](#definition-String) | | | `owner_gt` - [`String`](#definition-String) | | | `owner_gte` - [`String`](#definition-String) | | | `owner_in` - [`[String!]`](#definition-String) | | | `owner_lt` - [`String`](#definition-String) | | | `owner_lte` - [`String`](#definition-String) | | | `owner_not` - [`String`](#definition-String) | | | `owner_not_contains` - [`String`](#definition-String) | | | `owner_not_contains_nocase` - [`String`](#definition-String) | | | `owner_not_ends_with` - [`String`](#definition-String) | | | `owner_not_ends_with_nocase` - [`String`](#definition-String) | | | `owner_not_in` - [`[String!]`](#definition-String) | | | `owner_not_starts_with` - [`String`](#definition-String) | | | `owner_not_starts_with_nocase` - [`String`](#definition-String) | | | `owner_starts_with` - [`String`](#definition-String) | | | `owner_starts_with_nocase` - [`String`](#definition-String) | | | `token` - [`String`](#definition-String) | | | `token_` - [`Token_filter`](#definition-Token_filter) | | | `token_contains` - [`String`](#definition-String) | | | `token_contains_nocase` - [`String`](#definition-String) | | | `token_ends_with` - [`String`](#definition-String) | | | `token_ends_with_nocase` - [`String`](#definition-String) | | | `token_gt` - [`String`](#definition-String) | | | `token_gte` - [`String`](#definition-String) | | | `token_in` - [`[String!]`](#definition-String) | | | `token_lt` - [`String`](#definition-String) | | | `token_lte` - [`String`](#definition-String) | | | `token_not` - [`String`](#definition-String) | | | `token_not_contains` - [`String`](#definition-String) | | | `token_not_contains_nocase` - [`String`](#definition-String) | | | `token_not_ends_with` - [`String`](#definition-String) | | | `token_not_ends_with_nocase` - [`String`](#definition-String) | | | `token_not_in` - [`[String!]`](#definition-String) | | | `token_not_starts_with` - [`String`](#definition-String) | | | `token_not_starts_with_nocase` - [`String`](#definition-String) | | | `token_starts_with` - [`String`](#definition-String) | | | `token_starts_with_nocase` - [`String`](#definition-String) | | **Example** ```json { "_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": "xyz789", "owner_": Owner_filter, "owner_contains": "xyz789", "owner_contains_nocase": "abc123", "owner_ends_with": "abc123", "owner_ends_with_nocase": "xyz789", "owner_gt": "abc123", "owner_gte": "xyz789", "owner_in": ["abc123"], "owner_lt": "xyz789", "owner_lte": "abc123", "owner_not": "abc123", "owner_not_contains": "xyz789", "owner_not_contains_nocase": "abc123", "owner_not_ends_with": "xyz789", "owner_not_ends_with_nocase": "abc123", "owner_not_in": ["xyz789"], "owner_not_starts_with": "abc123", "owner_not_starts_with_nocase": "xyz789", "owner_starts_with": "xyz789", "owner_starts_with_nocase": "abc123", "token": "xyz789", "token_": Token_filter, "token_contains": "abc123", "token_contains_nocase": "xyz789", "token_ends_with": "xyz789", "token_ends_with_nocase": "abc123", "token_gt": "xyz789", "token_gte": "abc123", "token_in": ["xyz789"], "token_lt": "abc123", "token_lte": "abc123", "token_not": "abc123", "token_not_contains": "abc123", "token_not_contains_nocase": "abc123", "token_not_ends_with": "abc123", "token_not_ends_with_nocase": "abc123", "token_not_in": ["xyz789"], "token_not_starts_with": "abc123", "token_not_starts_with_nocase": "abc123", "token_starts_with": "xyz789", "token_starts_with_nocase": "xyz789" } ``` [Types](#group-Types) ### Token\_filter **Fields** | Input Field | Description | | -------------------------------------------------------------------------------------------- | ----------------------------------- | | `_change_block` - [`BlockChangedFilter`](#definition-BlockChangedFilter) | Filter for the block changed event. | | `amount` - [`BigInt`](#definition-BigInt) | | | `amount_gt` - [`BigInt`](#definition-BigInt) | | | `amount_gte` - [`BigInt`](#definition-BigInt) | | | `amount_in` - [`[BigInt!]`](#definition-BigInt) | | | `amount_lt` - [`BigInt`](#definition-BigInt) | | | `amount_lte` - [`BigInt`](#definition-BigInt) | | | `amount_not` - [`BigInt`](#definition-BigInt) | | | `amount_not_in` - [`[BigInt!]`](#definition-BigInt) | | | `and` - [`[Token_filter]`](#definition-Token_filter) | | | `collectionContract` - [`String`](#definition-String) | | | `collectionContract_` - [`CollectionContract_filter`](#definition-CollectionContract_filter) | | | `collectionContract_contains` - [`String`](#definition-String) | | | `collectionContract_contains_nocase` - [`String`](#definition-String) | | | `collectionContract_ends_with` - [`String`](#definition-String) | | | `collectionContract_ends_with_nocase` - [`String`](#definition-String) | | | `collectionContract_gt` - [`String`](#definition-String) | | | `collectionContract_gte` - [`String`](#definition-String) | | | `collectionContract_in` - [`[String!]`](#definition-String) | | | `collectionContract_lt` - [`String`](#definition-String) | | | `collectionContract_lte` - [`String`](#definition-String) | | | `collectionContract_not` - [`String`](#definition-String) | | | `collectionContract_not_contains` - [`String`](#definition-String) | | | `collectionContract_not_contains_nocase` - [`String`](#definition-String) | | | `collectionContract_not_ends_with` - [`String`](#definition-String) | | | `collectionContract_not_ends_with_nocase` - [`String`](#definition-String) | | | `collectionContract_not_in` - [`[String!]`](#definition-String) | | | `collectionContract_not_starts_with` - [`String`](#definition-String) | | | `collectionContract_not_starts_with_nocase` - [`String`](#definition-String) | | | `collectionContract_starts_with` - [`String`](#definition-String) | | | `collectionContract_starts_with_nocase` - [`String`](#definition-String) | | | `createdAt` - [`String`](#definition-String) | | | `createdAt_contains` - [`String`](#definition-String) | | | `createdAt_contains_nocase` - [`String`](#definition-String) | | | `createdAt_ends_with` - [`String`](#definition-String) | | | `createdAt_ends_with_nocase` - [`String`](#definition-String) | | | `createdAt_gt` - [`String`](#definition-String) | | | `createdAt_gte` - [`String`](#definition-String) | | | `createdAt_in` - [`[String!]`](#definition-String) | | | `createdAt_lt` - [`String`](#definition-String) | | | `createdAt_lte` - [`String`](#definition-String) | | | `createdAt_not` - [`String`](#definition-String) | | | `createdAt_not_contains` - [`String`](#definition-String) | | | `createdAt_not_contains_nocase` - [`String`](#definition-String) | | | `createdAt_not_ends_with` - [`String`](#definition-String) | | | `createdAt_not_ends_with_nocase` - [`String`](#definition-String) | | | `createdAt_not_in` - [`[String!]`](#definition-String) | | | `createdAt_not_starts_with` - [`String`](#definition-String) | | | `createdAt_not_starts_with_nocase` - [`String`](#definition-String) | | | `createdAt_starts_with` - [`String`](#definition-String) | | | `createdAt_starts_with_nocase` - [`String`](#definition-String) | | | `id` - [`ID`](#definition-ID) | | | `id_gt` - [`ID`](#definition-ID) | | | `id_gte` - [`ID`](#definition-ID) | | | `id_in` - [`[ID!]`](#definition-ID) | | | `id_lt` - [`ID`](#definition-ID) | | | `id_lte` - [`ID`](#definition-ID) | | | `id_not` - [`ID`](#definition-ID) | | | `id_not_in` - [`[ID!]`](#definition-ID) | | | `listing_` - [`Listing_filter`](#definition-Listing_filter) | | | `minter` - [`Bytes`](#definition-Bytes) | | | `minter_contains` - [`Bytes`](#definition-Bytes) | | | `minter_gt` - [`Bytes`](#definition-Bytes) | | | `minter_gte` - [`Bytes`](#definition-Bytes) | | | `minter_in` - [`[Bytes!]`](#definition-Bytes) | | | `minter_lt` - [`Bytes`](#definition-Bytes) | | | `minter_lte` - [`Bytes`](#definition-Bytes) | | | `minter_not` - [`Bytes`](#definition-Bytes) | | | `minter_not_contains` - [`Bytes`](#definition-Bytes) | | | `minter_not_in` - [`[Bytes!]`](#definition-Bytes) | | | `or` - [`[Token_filter]`](#definition-Token_filter) | | | `owners_` - [`TokenOwner_filter`](#definition-TokenOwner_filter) | | | `purchases_` - [`Purchase_filter`](#definition-Purchase_filter) | | | `royaltyNumerator` - [`BigInt`](#definition-BigInt) | | | `royaltyNumerator_gt` - [`BigInt`](#definition-BigInt) | | | `royaltyNumerator_gte` - [`BigInt`](#definition-BigInt) | | | `royaltyNumerator_in` - [`[BigInt!]`](#definition-BigInt) | | | `royaltyNumerator_lt` - [`BigInt`](#definition-BigInt) | | | `royaltyNumerator_lte` - [`BigInt`](#definition-BigInt) | | | `royaltyNumerator_not` - [`BigInt`](#definition-BigInt) | | | `royaltyNumerator_not_in` - [`[BigInt!]`](#definition-BigInt) | | | `royaltyRecipient` - [`Bytes`](#definition-Bytes) | | | `royaltyRecipient_contains` - [`Bytes`](#definition-Bytes) | | | `royaltyRecipient_gt` - [`Bytes`](#definition-Bytes) | | | `royaltyRecipient_gte` - [`Bytes`](#definition-Bytes) | | | `royaltyRecipient_in` - [`[Bytes!]`](#definition-Bytes) | | | `royaltyRecipient_lt` - [`Bytes`](#definition-Bytes) | | | `royaltyRecipient_lte` - [`Bytes`](#definition-Bytes) | | | `royaltyRecipient_not` - [`Bytes`](#definition-Bytes) | | | `royaltyRecipient_not_contains` - [`Bytes`](#definition-Bytes) | | | `royaltyRecipient_not_in` - [`[Bytes!]`](#definition-Bytes) | | | `tokenId` - [`BigInt`](#definition-BigInt) | | | `tokenId_gt` - [`BigInt`](#definition-BigInt) | | | `tokenId_gte` - [`BigInt`](#definition-BigInt) | | | `tokenId_in` - [`[BigInt!]`](#definition-BigInt) | | | `tokenId_lt` - [`BigInt`](#definition-BigInt) | | | `tokenId_lte` - [`BigInt`](#definition-BigInt) | | | `tokenId_not` - [`BigInt`](#definition-BigInt) | | | `tokenId_not_in` - [`[BigInt!]`](#definition-BigInt) | | | `tokenURI` - [`String`](#definition-String) | | | `tokenURI_contains` - [`String`](#definition-String) | | | `tokenURI_contains_nocase` - [`String`](#definition-String) | | | `tokenURI_ends_with` - [`String`](#definition-String) | | | `tokenURI_ends_with_nocase` - [`String`](#definition-String) | | | `tokenURI_gt` - [`String`](#definition-String) | | | `tokenURI_gte` - [`String`](#definition-String) | | | `tokenURI_in` - [`[String!]`](#definition-String) | | | `tokenURI_lt` - [`String`](#definition-String) | | | `tokenURI_lte` - [`String`](#definition-String) | | | `tokenURI_not` - [`String`](#definition-String) | | | `tokenURI_not_contains` - [`String`](#definition-String) | | | `tokenURI_not_contains_nocase` - [`String`](#definition-String) | | | `tokenURI_not_ends_with` - [`String`](#definition-String) | | | `tokenURI_not_ends_with_nocase` - [`String`](#definition-String) | | | `tokenURI_not_in` - [`[String!]`](#definition-String) | | | `tokenURI_not_starts_with` - [`String`](#definition-String) | | | `tokenURI_not_starts_with_nocase` - [`String`](#definition-String) | | | `tokenURI_starts_with` - [`String`](#definition-String) | | | `tokenURI_starts_with_nocase` - [`String`](#definition-String) | | | `updatedAt` - [`String`](#definition-String) | | | `updatedAt_contains` - [`String`](#definition-String) | | | `updatedAt_contains_nocase` - [`String`](#definition-String) | | | `updatedAt_ends_with` - [`String`](#definition-String) | | | `updatedAt_ends_with_nocase` - [`String`](#definition-String) | | | `updatedAt_gt` - [`String`](#definition-String) | | | `updatedAt_gte` - [`String`](#definition-String) | | | `updatedAt_in` - [`[String!]`](#definition-String) | | | `updatedAt_lt` - [`String`](#definition-String) | | | `updatedAt_lte` - [`String`](#definition-String) | | | `updatedAt_not` - [`String`](#definition-String) | | | `updatedAt_not_contains` - [`String`](#definition-String) | | | `updatedAt_not_contains_nocase` - [`String`](#definition-String) | | | `updatedAt_not_ends_with` - [`String`](#definition-String) | | | `updatedAt_not_ends_with_nocase` - [`String`](#definition-String) | | | `updatedAt_not_in` - [`[String!]`](#definition-String) | | | `updatedAt_not_starts_with` - [`String`](#definition-String) | | | `updatedAt_not_starts_with_nocase` - [`String`](#definition-String) | | | `updatedAt_starts_with` - [`String`](#definition-String) | | | `updatedAt_starts_with_nocase` - [`String`](#definition-String) | | **Example** ```json { "_change_block": BlockChangedFilter, "amount": {}, "amount_gt": {}, "amount_gte": {}, "amount_in": [{}], "amount_lt": {}, "amount_lte": {}, "amount_not": {}, "amount_not_in": [{}], "and": [Token_filter], "collectionContract": "xyz789", "collectionContract_": CollectionContract_filter, "collectionContract_contains": "abc123", "collectionContract_contains_nocase": "abc123", "collectionContract_ends_with": "xyz789", "collectionContract_ends_with_nocase": "xyz789", "collectionContract_gt": "abc123", "collectionContract_gte": "xyz789", "collectionContract_in": ["abc123"], "collectionContract_lt": "xyz789", "collectionContract_lte": "xyz789", "collectionContract_not": "abc123", "collectionContract_not_contains": "abc123", "collectionContract_not_contains_nocase": "abc123", "collectionContract_not_ends_with": "abc123", "collectionContract_not_ends_with_nocase": "abc123", "collectionContract_not_in": ["abc123"], "collectionContract_not_starts_with": "xyz789", "collectionContract_not_starts_with_nocase": "abc123", "collectionContract_starts_with": "xyz789", "collectionContract_starts_with_nocase": "xyz789", "createdAt": "xyz789", "createdAt_contains": "abc123", "createdAt_contains_nocase": "xyz789", "createdAt_ends_with": "abc123", "createdAt_ends_with_nocase": "abc123", "createdAt_gt": "abc123", "createdAt_gte": "abc123", "createdAt_in": ["xyz789"], "createdAt_lt": "abc123", "createdAt_lte": "xyz789", "createdAt_not": "xyz789", "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": "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"], "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": "xyz789", "tokenURI_contains_nocase": "xyz789", "tokenURI_ends_with": "abc123", "tokenURI_ends_with_nocase": "xyz789", "tokenURI_gt": "abc123", "tokenURI_gte": "xyz789", "tokenURI_in": ["xyz789"], "tokenURI_lt": "abc123", "tokenURI_lte": "xyz789", "tokenURI_not": "xyz789", "tokenURI_not_contains": "xyz789", "tokenURI_not_contains_nocase": "xyz789", "tokenURI_not_ends_with": "xyz789", "tokenURI_not_ends_with_nocase": "abc123", "tokenURI_not_in": ["xyz789"], "tokenURI_not_starts_with": "abc123", "tokenURI_not_starts_with_nocase": "abc123", "tokenURI_starts_with": "abc123", "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": "abc123", "updatedAt_gte": "abc123", "updatedAt_in": ["abc123"], "updatedAt_lt": "abc123", "updatedAt_lte": "abc123", "updatedAt_not": "xyz789", "updatedAt_not_contains": "abc123", "updatedAt_not_contains_nocase": "abc123", "updatedAt_not_ends_with": "abc123", "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": "abc123" } ``` [Types](#group-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** ```gql "amount" ``` [Types](#group-Types) ### UpdatePerson **Fields** | Input Field | Description | | ------------------------------------------------ | ----------- | | `username` - [`String`](#definition-String) | | | `walletAddress` - [`String`](#definition-String) | | **Example** ```json { "username": "abc123", "walletAddress": "xyz789" } ``` [Types](#group-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** ```gql "allow" ``` [Types](#group-Types) ### collectionContractsQueryArgs **Fields** | Input Field | Description | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `block` - [`Block_height`](#definition-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`](#definition-Int) | | | `orderBy` - [`CollectionContract_orderBy`](#definition-CollectionContract_orderBy) | | | `orderDirection` - [`OrderDirection`](#definition-OrderDirection) | | | `skip` - [`Int`](#definition-Int) | | | `subgraphError` - [`_SubgraphErrorPolicy_!`](#definition-_SubgraphErrorPolicy_) | Set to `allow` to receive data even if the subgraph has skipped over errors while syncing. Default = `deny` | | `where` - [`CollectionContract_filter`](#definition-CollectionContract_filter) | | **Example** ```json { "block": Block_height, "first": 123, "orderBy": "address", "orderDirection": "asc", "skip": 123, "subgraphError": "allow", "where": CollectionContract_filter } ``` [Types](#group-Types) ### tokensInput **Fields** | Input Field | Description | | ---------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `network` - [`NetworkName!`](#definition-NetworkName) | Name of the blockchain network on which the transaction occurs | | `ownedBy` - [`OwnedBy`](#definition-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`](#definition-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`](#definition-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`](#definition-tokensQueryArgs) | Parameters filtering tokens from subgraph. | **Example** ```json { "network": "ropsten", "ownedBy": OwnedBy, "mintedBy": MintedBy, "byCollectionEntityUri": "abc123", "queryParams": tokensQueryArgs } ``` [Types](#group-Types) ### tokensQueryArgs **Fields** | Input Field | Description | | ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `block` - [`Block_height`](#definition-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`](#definition-Int) | | | `orderBy` - [`Token_orderBy`](#definition-Token_orderBy) | | | `orderDirection` - [`OrderDirection`](#definition-OrderDirection) | | | `skip` - [`Int`](#definition-Int) | | | `subgraphError` - [`_SubgraphErrorPolicy_!`](#definition-_SubgraphErrorPolicy_) | Set to `allow` to receive data even if the subgraph has skipped over errors while syncing. Default = `deny` | | `where` - [`Token_filter`](#definition-Token_filter) | | **Example** ```json { "block": Block_height, "first": 987, "orderBy": "amount", "orderDirection": "asc", "skip": 123, "subgraphError": "allow", "where": Token_filter } ``` [Documentation by Anvil SpectaQL](https://github.com/anvilco/spectaql) --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.revelator.com/pro/resources/web3/production/nft-service-api.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.