GraphQL API Reference
GraphQl endpoints for nft-service!
API Endpoints
Copy # devel:
https://nft-service.devel.original.works/graphql
# staging:
https://nft-service.stage.original.works/graphql
# prod:
https://nft-service.original.works/graphql
Queries
balanceOf
Description
🔓 Public
Returns token balance of user
Response
Returns a String!
Arguments
Example
Query
Copy query BalanceOf (
$collectionContract: String ! ,
$tokenId: String ! ,
$userId: String ! ,
$network: NetworkName !
) {
balanceOf(
collectionContract: $collectionContract,
tokenId: $tokenId,
userId: $userId,
network: $network
)
}
Variables
Copy {
"collectionContract" : "abc123" ,
"tokenId" : "xyz789" ,
"userId" : "abc123" ,
"network" : "ropsten"
}
Response
Copy { "data" : { "balanceOf" : "abc123" }}
Queries
collection
Description
🔓 Public
Returns single collection
Response
Returns a Collection
Arguments
Example
Query
Copy 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
Copy { "network" : "ropsten" , "id" : "xyz789" }
Response
Copy {
"data" : {
"collection" : {
"id" : "xyz789" ,
"owner" : "xyz789" ,
"tokens" : [Token] ,
"address" : "xyz789" ,
"contractURI" : "xyz789" ,
"networkName" : "ropsten" ,
"metadata" : CollectionMetadataDto ,
"createdAt" : "xyz789" ,
"updatedAt" : "xyz789"
}
}
}
Queries
collectionMetadata
Description
🔒 JWT Token
Retrieve collection metadata by id
Response
Returns a CollectionMetadataDto!
Arguments
Example
Query
Copy 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
Response
Copy {
"data" : {
"collectionMetadata" : {
"id" : 987 ,
"userSub" : "xyz789" ,
"name" : "xyz789" ,
"symbol" : "abc123" ,
"description" : "abc123" ,
"coverImageS3Key" : "abc123" ,
"coverImageS3Url" : "xyz789" ,
"coverImageIpfsUrl" : "abc123" ,
"coverImageIpfsHash" : "abc123" ,
"bannerImageS3Key" : "xyz789" ,
"bannerImageS3Url" : "abc123" ,
"bannerImageIpfsHash" : "abc123" ,
"bannerImageIpfsUrl" : "abc123" ,
"externalLink" : "xyz789" ,
"defaultRoyalties" : "abc123" ,
"defaultRoyaltyRecipient" : "xyz789" ,
"metadataIpfsHash" : "abc123" ,
"metadataIpfsUrl" : "xyz789" ,
"networkName" : "ropsten" ,
"status" : "PENDING_UPLOAD"
}
}
}
Queries
collections
Description
🔓 Public
Returns collections
Response
Returns [Collection!]!
Arguments
Example
Query
Copy 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
Copy { "input" : CollectionsInput}
Response
Copy {
"data" : {
"collections" : [
{
"id" : "abc123" ,
"owner" : "abc123" ,
"tokens" : [Token] ,
"address" : "abc123" ,
"contractURI" : "xyz789" ,
"networkName" : "ropsten" ,
"metadata" : CollectionMetadataDto ,
"createdAt" : "xyz789" ,
"updatedAt" : "abc123"
}
]
}
}
Queries
currentPerson
Description
🔒 JWT Token
Returns person from the context
Response
Returns a PersonDto!
Example
Query
Copy query CurrentPerson {
currentPerson {
id
walletAddress
smartWalletAddress
username
avatarS3Key
avatarUrl
}
}
Response
Copy {
"data" : {
"currentPerson" : {
"id" : "xyz789" ,
"walletAddress" : "xyz789" ,
"smartWalletAddress" : "xyz789" ,
"username" : "abc123" ,
"avatarS3Key" : "xyz789" ,
"avatarUrl" : "xyz789"
}
}
}
Queries
fees
Description
🔓 Public
Returns market fees
Response
Returns a Fees!
Arguments
Example
Query
Copy query Fees ($network: NetworkName ! ) {
fees(network: $network) {
mintingFee
sellingFee
}
}
Variables
Copy { "network" : "ropsten" }
Response
Copy {
"data" : {
"fees" : {
"mintingFee" : "abc123" ,
"sellingFee" : "abc123"
}
}
}
Queries
listCollectionMetadata
Description
🔒 JWT Token
Returns list of collection metadata
Response
Returns a CollectionMetadataListResDTO!
Arguments
Example
Query
Copy 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
Copy { "pagination" : PaginationParams}
Response
Copy {
"data" : {
"listCollectionMetadata" : {
"items" : [CollectionMetadataDto] ,
"count" : 123.45
}
}
}
Queries
listMetadata
Description
🔒 JWT Token
Returns list of NFT metadata
Response
Returns a NftMetadataListResDTO!
Arguments
Example
Query
Copy query ListMetadata ($pagination: PaginationParams ! ) {
listMetadata(pagination: $pagination) {
items {
id
fileName
title
description
artistId
fileType
networkName
backgroundColor
externalUrl
youtubeUrl
attributes {
... NftMetadataAttributeObjectFragment
}
}
count
}
}
Variables
Copy { "pagination" : PaginationParams}
Response
Copy {
"data" : {
"listMetadata" : {
"items" : [NftMetadataDraftResDTO] ,
"count" : 987.65
}
}
}
Queries
metadata
Description
🔒 JWT Token
Retrieve metadata by id
Response
Returns a NftMetadataDTO!
Arguments
Example
Query
Copy 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
Response
Copy {
"data" : {
"metadata" : {
"id" : 987 ,
"userSub" : "xyz789" ,
"title" : "abc123" ,
"description" : "abc123" ,
"artistId" : "xyz789" ,
"fileType" : "IMAGE" ,
"networkName" : "ropsten" ,
"s3Key" : "xyz789" ,
"s3CoverKey" : "xyz789" ,
"ipfsNftUrl" : "xyz789" ,
"ipfsCoverUrl" : "xyz789" ,
"ipfsMetadataUrl" : "abc123" ,
"ipfsNftHash" : "xyz789" ,
"ipfsCoverHash" : "abc123" ,
"licenceS3Key" : "abc123" ,
"ipfsLicenceHash" : "xyz789" ,
"nftLicence" : NftLicenceDto ,
"ipfsMetadataHash" : "abc123" ,
"status" : "PENDING_UPLOAD" ,
"backgroundColor" : "abc123" ,
"externalUrl" : "xyz789" ,
"youtubeUrl" : "xyz789" ,
"attributes" : [NftMetadataAttributeObject] ,
"ipfsNftPublicUrl" : "xyz789" ,
"ipfsCoverPublicUrl" : "abc123" ,
"ipfsMetadataPublicUrl" : "xyz789" ,
"ipfsLicencePublicUrl" : "xyz789"
}
}
}
Queries
nftUses
Description
🔒 JWT Token
Licensed nft buyer rights
Response
Returns a NftUsesDTO!
Example
Query
Copy query NftUses {
nftUses {
list {
id
name
description
position
nftUseType
}
}
}
Response
Copy { "data" : { "nftUses" : { "list" : [NftUseDTO]}}}
Queries
person
Description
🔓 Public
Returns single person
Response
Returns a PersonDto
Arguments
Example
Query
Copy query Person ($identifier: PersonIdentifier ! ) {
person(identifier: $identifier) {
id
walletAddress
smartWalletAddress
username
avatarS3Key
avatarUrl
}
}
Variables
Copy { "identifier" : PersonIdentifier}
Response
Copy {
"data" : {
"person" : {
"id" : "xyz789" ,
"walletAddress" : "abc123" ,
"smartWalletAddress" : "xyz789" ,
"username" : "abc123" ,
"avatarS3Key" : "xyz789" ,
"avatarUrl" : "xyz789"
}
}
}
Queries
persons
Description
🔓 Public
Returns persons
Response
Returns a Persons!
Arguments
Example
Query
Copy query Persons ($pagination: PaginationParams ! ) {
persons(pagination: $pagination) {
items {
id
walletAddress
smartWalletAddress
username
avatarS3Key
avatarUrl
}
count
}
}
Variables
Copy { "pagination" : PaginationParams}
Response
Copy {
"data" : {
"persons" : { "items" : [PersonDto] , "count" : 123.45 }
}
}
Queries
token
Description
🔓 Public
Returns single token
Response
Returns a Token
Arguments
Example
Query
Copy 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
Copy { "network" : "ropsten" , "id" : "xyz789" }
Response
Copy {
"data" : {
"token" : {
"id" : "xyz789" ,
"tokenId" : "abc123" ,
"collectionContract" : Collection ,
"minter" : "xyz789" ,
"enterprise" : CollectionEntity ,
"artist" : CollectionEntity ,
"amount" : "xyz789" ,
"royaltyRecipient" : "abc123" ,
"royaltyNumerator" : "xyz789" ,
"owners" : [TokenOwner] ,
"ownersWithMetadata" : [OwnerWithMetadata] ,
"listing" : Listing ,
"purchases" : [Purchase] ,
"tokenURI" : "xyz789" ,
"metadata" : NftMetadataDTO ,
"nftUrl" : "abc123" ,
"coverUrl" : "xyz789" ,
"networkName" : "ropsten" ,
"createdAt" : "xyz789" ,
"updatedAt" : "abc123"
}
}
}
Queries
tokens
Description
🔓 Public
Returns tokens
Response
Returns [Token!]!
Arguments
Example
Query
Copy 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
Copy { "input" : tokensInput}
Response
Copy {
"data" : {
"tokens" : [
{
"id" : "abc123" ,
"tokenId" : "abc123" ,
"collectionContract" : Collection ,
"minter" : "xyz789" ,
"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" : "xyz789" ,
"updatedAt" : "xyz789"
}
]
}
}
Mutations
createAvatarUrl
Description
🔒 JWT Token
Creates Avatar URL
Response
Returns an AvatarLinkResDTO!
Arguments
Example
Query
Copy mutation CreateAvatarUrl ($avatarLink: AvatarLinkReqDTO ! ) {
createAvatarUrl(avatarLink: $avatarLink) {
avatarUploadUrl
}
}
Variables
Copy { "avatarLink" : AvatarLinkReqDTO}
Response
Copy {
"data" : {
"createAvatarUrl" : {
"avatarUploadUrl" : "xyz789"
}
}
}
Mutations
createCollectionAssetsUploadUrl
Description
🔒 JWT Token
Creates Metadata URL
Response
Returns a CollectionMetadataLinkResDTO!
Arguments
Name Description id of the collection-metadata draft
Example
Query
Copy mutation CreateCollectionAssetsUploadUrl (
$collectionMetadataLink: CollectionMetadataLinkReqDTO ! ,
$id: Float !
) {
createCollectionAssetsUploadUrl(
collectionMetadataLink: $collectionMetadataLink,
id: $id
) {
coverUploadUrl
bannerUploadUrl
}
}
Variables
Copy {
"collectionMetadataLink" : CollectionMetadataLinkReqDTO ,
"id" : 987.65
}
Response
Copy {
"data" : {
"createCollectionAssetsUploadUrl" : {
"coverUploadUrl" : "abc123" ,
"bannerUploadUrl" : "xyz789"
}
}
}
Mutations
createUrl
Description
🔒 JWT Token
Creates Metadata URL
Response
Returns a NftMetadataLinkResDTO!
Arguments
Name Description id of the nft-metadata draft
Example
Query
Copy mutation CreateUrl (
$nftMetadataLink: NftMetadataLinkReqDTO ! ,
$id: Float !
) {
createUrl(
nftMetadataLink: $nftMetadataLink,
id: $id
) {
uploadUrl
coverUploadUrl
}
}
Variables
Copy { "nftMetadataLink" : NftMetadataLinkReqDTO , "id" : 123.45 }
Response
Copy {
"data": {
"createUrl": {
"uploadUrl": "abc123",
"coverUploadUrl": "xyz789"
}
}
}
Mutations
saveCollectionDraft
Description
🔒 JWT Token
Save collection metadata as a draft. Does not deploy an NFT contract. You can edit the data.
Response
Returns a CollectionMetadataDto!
Arguments
Example
Query
Copy 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
Copy {"collectionMetadataDraft": CollectionMetadataDraftReqDTO}
Response
Copy {
"data": {
"saveCollectionDraft": {
"id": 987,
"userSub": "abc123",
"name": "abc123",
"symbol": "xyz789",
"description": "xyz789",
"coverImageS3Key": "xyz789",
"coverImageS3Url": "xyz789",
"coverImageIpfsUrl": "abc123",
"coverImageIpfsHash": "xyz789",
"bannerImageS3Key": "xyz789",
"bannerImageS3Url": "abc123",
"bannerImageIpfsHash": "xyz789",
"bannerImageIpfsUrl": "xyz789",
"externalLink": "xyz789",
"defaultRoyalties": "abc123",
"defaultRoyaltyRecipient": "abc123",
"metadataIpfsHash": "xyz789",
"metadataIpfsUrl": "abc123",
"networkName": "ropsten",
"status": "PENDING_UPLOAD"
}
}
}
Mutations
saveDraft
Description
🔒 JWT Token
Save nft metadata as a draft. Does not create a token. You can edit the data.
Response
Returns a NftMetadataDraftResDTO!
Arguments
Example
Query
Copy mutation SaveDraft($nftMetadataDraft: NftMetadataDraftReqDTO!) {
saveDraft(nftMetadataDraft: $nftMetadataDraft) {
id
fileName
title
description
artistId
fileType
networkName
backgroundColor
externalUrl
youtubeUrl
attributes {
value
traitType
displayType
}
}
}
Variables
Copy {"nftMetadataDraft": NftMetadataDraftReqDTO}
Response
Copy {
"data": {
"saveDraft": {
"id": 123.45,
"fileName": "abc123",
"title": "abc123",
"description": "xyz789",
"artistId": "xyz789",
"fileType": "IMAGE",
"networkName": "ropsten",
"backgroundColor": "xyz789",
"externalUrl": "abc123",
"youtubeUrl": "abc123",
"attributes": [NftMetadataAttributeObject]
}
}
}
Mutations
updateCollectionDraft
Description
🔒 JWT Token
Updates collection metadata draft
Response
Returns a CollectionMetadataDto!
Arguments
Example
Query
Copy 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
Copy {
"collectionMetadataDraft": CollectionMetadataDraftReqDTO,
"id": 123.45
}
Response
Copy {
"data": {
"updateCollectionDraft": {
"id": 123,
"userSub": "xyz789",
"name": "xyz789",
"symbol": "xyz789",
"description": "abc123",
"coverImageS3Key": "abc123",
"coverImageS3Url": "abc123",
"coverImageIpfsUrl": "xyz789",
"coverImageIpfsHash": "abc123",
"bannerImageS3Key": "abc123",
"bannerImageS3Url": "xyz789",
"bannerImageIpfsHash": "xyz789",
"bannerImageIpfsUrl": "abc123",
"externalLink": "abc123",
"defaultRoyalties": "xyz789",
"defaultRoyaltyRecipient": "abc123",
"metadataIpfsHash": "abc123",
"metadataIpfsUrl": "abc123",
"networkName": "ropsten",
"status": "PENDING_UPLOAD"
}
}
}
Mutations
updateDraft
Description
🔒 JWT Token
Updates nft metadata draft
Response
Returns a NftMetadataDraftResDTO!
Arguments
Example
Query
Copy 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
Copy {
"updateNFTMetadataDraft": NftMetadataDraftReqDTO,
"id": 123.45
}
Response
Copy {
"data": {
"updateDraft": {
"id": 987.65,
"fileName": "abc123",
"title": "abc123",
"description": "abc123",
"artistId": "abc123",
"fileType": "IMAGE",
"networkName": "ropsten",
"backgroundColor": "abc123",
"externalUrl": "xyz789",
"youtubeUrl": "xyz789",
"attributes": [NftMetadataAttributeObject]
}
}
}
Mutations
updatePerson
Description
🔒 JWT Token
Updates person
Response
Returns a PersonDto!
Arguments
Example
Query
Copy mutation UpdatePerson($updatePerson: UpdatePerson!) {
updatePerson(updatePerson: $updatePerson) {
id
walletAddress
smartWalletAddress
username
avatarS3Key
avatarUrl
}
}
Variables
Copy {"updatePerson": UpdatePerson}
Response
Copy {
"data": {
"updatePerson": {
"id": "abc123",
"walletAddress": "abc123",
"smartWalletAddress": "xyz789",
"username": "xyz789",
"avatarS3Key": "xyz789",
"avatarUrl": "abc123"
}
}
}
Types
AddressResolverType
Values
Example
Types
AvatarLinkReqDTO
Fields
Input Field Description the file name must contain its extension -> [name].jpg
mime type of the avatar file -> image/jpeg
Example
Copy {
"fileName": "abc123",
"contentType": "abc123"
}
Types
AvatarLinkResDTO
Fields
Example
Copy {"avatarUploadUrl": "abc123"}
Types
BigInt
Example
Types
BlockChangedFilter
Fields
Example
Types
Block_height
Fields
Example
Copy {"hash": Bytes, "number": 123, "number_gte": 123}
Types
Boolean
Description
The Boolean
scalar type represents true
or false
.
Example
Types
Bytes
Example
Types
Collection
Fields
Example
Copy {
"id": "xyz789",
"owner": "abc123",
"tokens": [Token],
"address": "xyz789",
"contractURI": "xyz789",
"networkName": "ropsten",
"metadata": CollectionMetadataDto,
"createdAt": "abc123",
"updatedAt": "xyz789"
}
Types
CollectionContract_filter
Fields
Input Field Description Filter for the block changed event.
address_not_contains
- Bytes
contractURI_contains_nocase
- String
contractURI_ends_with
- String
contractURI_ends_with_nocase
- String
contractURI_not_contains
- String
contractURI_not_contains_nocase
- String
contractURI_not_ends_with
- String
contractURI_not_ends_with_nocase
- String
contractURI_not_starts_with
- String
contractURI_not_starts_with_nocase
- String
contractURI_starts_with
- String
contractURI_starts_with_nocase
- String
createdAt_contains_nocase
- String
createdAt_ends_with_nocase
- String
createdAt_not_contains
- String
createdAt_not_contains_nocase
- String
createdAt_not_ends_with
- String
createdAt_not_ends_with_nocase
- String
createdAt_not_starts_with
- String
createdAt_not_starts_with_nocase
- String
createdAt_starts_with
- String
createdAt_starts_with_nocase
- String
owner_not_contains
- Bytes
updatedAt_contains_nocase
- String
updatedAt_ends_with_nocase
- String
updatedAt_not_contains
- String
updatedAt_not_contains_nocase
- String
updatedAt_not_ends_with
- String
updatedAt_not_ends_with_nocase
- String
updatedAt_not_starts_with
- String
updatedAt_not_starts_with_nocase
- String
updatedAt_starts_with
- String
updatedAt_starts_with_nocase
- String
Example
Copy {
"_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": "xyz789",
"contractURI_contains_nocase": "abc123",
"contractURI_ends_with": "abc123",
"contractURI_ends_with_nocase": "xyz789",
"contractURI_gt": "xyz789",
"contractURI_gte": "xyz789",
"contractURI_in": ["abc123"],
"contractURI_lt": "abc123",
"contractURI_lte": "xyz789",
"contractURI_not": "abc123",
"contractURI_not_contains": "xyz789",
"contractURI_not_contains_nocase": "abc123",
"contractURI_not_ends_with": "abc123",
"contractURI_not_ends_with_nocase": "abc123",
"contractURI_not_in": ["abc123"],
"contractURI_not_starts_with": "xyz789",
"contractURI_not_starts_with_nocase": "abc123",
"contractURI_starts_with": "abc123",
"contractURI_starts_with_nocase": "xyz789",
"createdAt": "xyz789",
"createdAt_contains": "xyz789",
"createdAt_contains_nocase": "xyz789",
"createdAt_ends_with": "xyz789",
"createdAt_ends_with_nocase": "abc123",
"createdAt_gt": "xyz789",
"createdAt_gte": "xyz789",
"createdAt_in": ["abc123"],
"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": "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": "abc123",
"updatedAt_contains_nocase": "abc123",
"updatedAt_ends_with": "abc123",
"updatedAt_ends_with_nocase": "abc123",
"updatedAt_gt": "xyz789",
"updatedAt_gte": "abc123",
"updatedAt_in": ["abc123"],
"updatedAt_lt": "abc123",
"updatedAt_lte": "xyz789",
"updatedAt_not": "xyz789",
"updatedAt_not_contains": "xyz789",
"updatedAt_not_contains_nocase": "abc123",
"updatedAt_not_ends_with": "abc123",
"updatedAt_not_ends_with_nocase": "abc123",
"updatedAt_not_in": ["abc123"],
"updatedAt_not_starts_with": "xyz789",
"updatedAt_not_starts_with_nocase": "xyz789",
"updatedAt_starts_with": "abc123",
"updatedAt_starts_with_nocase": "xyz789"
}
Types
CollectionContract_orderBy
Values
Example
Types
CollectionEntity
Description
represents an element of the hierarchy within the enterprise.
Fields
Field Name Description Auto-incrementing identifier.
Specifies the type of entry. Represents the hierarchy level within the enterprise.
Tenant ID to which artists, enterprise and labels belong.
avatar url, displayed on the storefront.
banner url, displayed on the storefront.
Time at which the object was created.
Time at which the object was last updated.
Example
Copy {
"id": 4,
"type": "ENTERPRISE",
"entityUri": "xyz789",
"name": "xyz789",
"description": "xyz789",
"avatarUrl": "xyz789",
"bannerUrl": "xyz789",
"createdAt": "xyz789",
"updatedAt": "xyz789"
}
Types
CollectionEntityType
Values
Example
Types
CollectionMetadataDraftReqDTO
Fields
Input Field Description defaultRoyaltyRecipient
- String
Example
Copy {
"name": "abc123",
"symbol": "abc123",
"description": "abc123",
"externalLink": "xyz789",
"defaultRoyalties": "xyz789",
"defaultRoyaltyRecipient": "abc123",
"networkName": "ropsten"
}
Types
CollectionMetadataDto
Fields
Field Name Description description of the collection
s3 key of the cover image
s3 link of the cover image
ipfs link of the cover image
ipfs hash of the cover image
s3 key of the banner image
s3 link of the banner image
ipfs hash of the banner image
ipfs link of the banner image
external link of the collection
default royalty basis point
defaultRoyaltyRecipient
- String
default royalty recipient
ipfs link of contract level metadata
ipfs link of contract level metadata
status of the uploading files
Example
Copy {
"id": 987,
"userSub": "abc123",
"name": "abc123",
"symbol": "abc123",
"description": "xyz789",
"coverImageS3Key": "xyz789",
"coverImageS3Url": "abc123",
"coverImageIpfsUrl": "abc123",
"coverImageIpfsHash": "abc123",
"bannerImageS3Key": "abc123",
"bannerImageS3Url": "xyz789",
"bannerImageIpfsHash": "xyz789",
"bannerImageIpfsUrl": "xyz789",
"externalLink": "xyz789",
"defaultRoyalties": "xyz789",
"defaultRoyaltyRecipient": "xyz789",
"metadataIpfsHash": "abc123",
"metadataIpfsUrl": "abc123",
"networkName": "ropsten",
"status": "PENDING_UPLOAD"
}
Types
CollectionMetadataLinkReqDTO
Fields
Input Field Description the cover of the collection | the cover name must contain its extension -> [name].jpg
mime type of the collection cover file -> image/jpeg
the banner of the collection | the banner name must contain its extension -> [name].jpg
mime type of the collection banner file -> image/jpeg
Example
Copy {
"coverFileName": "xyz789",
"coverFileMimeType": "xyz789",
"bannerFileName": "xyz789",
"bannerFileMimeType": "xyz789"
}
Types
CollectionMetadataLinkResDTO
Fields
Example
Copy {
"coverUploadUrl": "xyz789",
"bannerUploadUrl": "xyz789"
}
Types
CollectionMetadataListResDTO
Fields
Example
Copy {"items": [CollectionMetadataDto], "count": 123.45}
Types
CollectionsInput
Fields
Input Field Description Name of the blockchain network on which the transaction occurs
Parameters filtering collections by owner. One collection can have only one owner.
Parameters filtering collections from subgraph.
Example
Copy {
"network": "ropsten",
"ownedBy": OwnedBy,
"queryParams": collectionContractsQueryArgs
}
Types
DisplayType
Values
Example
Types
Fees
Fields
Example
Copy {
"mintingFee": "xyz789",
"sellingFee": "abc123"
}
Types
FileStatus
Values
Example
Types
FileType
Values
Example
Types
Float
Description
The Float
scalar type represents signed double-precision fractional values as specified by IEEE 754 .
Example
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
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
Types
Listing
Fields
Example
Copy {
"id": "xyz789",
"onSale": true,
"seller": Owner,
"salePrice": "abc123",
"amountListed": "xyz789",
"amountRemaining": "abc123",
"createdAt": "abc123",
"updatedAt": "xyz789"
}
Types
Listing_filter
Fields
Input Field Description Filter for the block changed event.
createdAt_contains_nocase
- String
createdAt_ends_with_nocase
- String
createdAt_not_contains
- String
createdAt_not_contains_nocase
- String
createdAt_not_ends_with
- String
createdAt_not_ends_with_nocase
- String
createdAt_not_starts_with
- String
createdAt_not_starts_with_nocase
- String
createdAt_starts_with
- String
createdAt_starts_with_nocase
- String
seller_contains_nocase
- String
seller_ends_with_nocase
- String
seller_not_contains_nocase
- String
seller_not_ends_with_nocase
- String
seller_not_starts_with
- String
seller_not_starts_with_nocase
- String
seller_starts_with_nocase
- String
token_contains_nocase
- String
token_ends_with_nocase
- String
token_not_contains_nocase
- String
token_not_ends_with_nocase
- String
token_not_starts_with
- String
token_not_starts_with_nocase
- String
token_starts_with_nocase
- String
updatedAt_contains_nocase
- String
updatedAt_ends_with_nocase
- String
updatedAt_not_contains
- String
updatedAt_not_contains_nocase
- String
updatedAt_not_ends_with
- String
updatedAt_not_ends_with_nocase
- String
updatedAt_not_starts_with
- String
updatedAt_not_starts_with_nocase
- String
updatedAt_starts_with
- String
updatedAt_starts_with_nocase
- String
Example
Copy {
"_change_block": BlockChangedFilter,
"amountListed": {},
"amountListed_gt": {},
"amountListed_gte": {},
"amountListed_in": [{}],
"amountListed_lt": {},
"amountListed_lte": {},
"amountListed_not": {},
"amountListed_not_in": [{}],
"amountRemaining": {},
"amountRemaining_gt": {},
"amountRemaining_gte": {},
"amountRemaining_in": [{}],
"amountRemaining_lt": {},
"amountRemaining_lte": {},
"amountRemaining_not": {},
"amountRemaining_not_in": [{}],
"and": [Listing_filter],
"createdAt": "xyz789",
"createdAt_contains": "abc123",
"createdAt_contains_nocase": "abc123",
"createdAt_ends_with": "abc123",
"createdAt_ends_with_nocase": "xyz789",
"createdAt_gt": "xyz789",
"createdAt_gte": "abc123",
"createdAt_in": ["abc123"],
"createdAt_lt": "abc123",
"createdAt_lte": "abc123",
"createdAt_not": "xyz789",
"createdAt_not_contains": "abc123",
"createdAt_not_contains_nocase": "xyz789",
"createdAt_not_ends_with": "xyz789",
"createdAt_not_ends_with_nocase": "xyz789",
"createdAt_not_in": ["xyz789"],
"createdAt_not_starts_with": "xyz789",
"createdAt_not_starts_with_nocase": "abc123",
"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],
"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": "abc123",
"seller_": Owner_filter,
"seller_contains": "xyz789",
"seller_contains_nocase": "xyz789",
"seller_ends_with": "abc123",
"seller_ends_with_nocase": "abc123",
"seller_gt": "abc123",
"seller_gte": "abc123",
"seller_in": ["xyz789"],
"seller_lt": "xyz789",
"seller_lte": "xyz789",
"seller_not": "abc123",
"seller_not_contains": "xyz789",
"seller_not_contains_nocase": "xyz789",
"seller_not_ends_with": "xyz789",
"seller_not_ends_with_nocase": "xyz789",
"seller_not_in": ["xyz789"],
"seller_not_starts_with": "abc123",
"seller_not_starts_with_nocase": "xyz789",
"seller_starts_with": "abc123",
"seller_starts_with_nocase": "xyz789",
"token": "abc123",
"token_": Token_filter,
"token_contains": "abc123",
"token_contains_nocase": "abc123",
"token_ends_with": "xyz789",
"token_ends_with_nocase": "xyz789",
"token_gt": "xyz789",
"token_gte": "xyz789",
"token_in": ["xyz789"],
"token_lt": "xyz789",
"token_lte": "abc123",
"token_not": "xyz789",
"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": "xyz789",
"token_not_starts_with_nocase": "xyz789",
"token_starts_with": "abc123",
"token_starts_with_nocase": "xyz789",
"updatedAt": "xyz789",
"updatedAt_contains": "abc123",
"updatedAt_contains_nocase": "abc123",
"updatedAt_ends_with": "abc123",
"updatedAt_ends_with_nocase": "abc123",
"updatedAt_gt": "abc123",
"updatedAt_gte": "abc123",
"updatedAt_in": ["abc123"],
"updatedAt_lt": "xyz789",
"updatedAt_lte": "xyz789",
"updatedAt_not": "abc123",
"updatedAt_not_contains": "xyz789",
"updatedAt_not_contains_nocase": "xyz789",
"updatedAt_not_ends_with": "xyz789",
"updatedAt_not_ends_with_nocase": "xyz789",
"updatedAt_not_in": ["abc123"],
"updatedAt_not_starts_with": "xyz789",
"updatedAt_not_starts_with_nocase": "xyz789",
"updatedAt_starts_with": "xyz789",
"updatedAt_starts_with_nocase": "xyz789"
}
Types
MintedBy
Fields
Input Field Description 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)
The value by which the tokens/collections are filtered.
Example
Copy {"type": "PERSON_ID", "value": "abc123"}
Types
NetworkName
Values
Example
Types
NftLicenceDto
Fields
Field Name Description revelatorTermsAndConditions
- Boolean
Example
Copy {
"revelatorTermsAndConditions": true,
"nftTitle": "xyz789",
"label": "abc123",
"royaltyRate": "abc123",
"personalUses": [NftUseDTO],
"commercialUses": [NftUseDTO]
}
Types
NftMetadataAttributeInput
Fields
Example
Copy {
"value": "abc123",
"traitType": "xyz789",
"displayType": "DATE"
}
Types
NftMetadataAttributeObject
Fields
Example
Copy {
"value": "xyz789",
"traitType": "abc123",
"displayType": "DATE"
}
Types
NftMetadataDTO
Fields
Field Name Description ipfsMetadataPublicUrl
- String
Example
Copy {
"id": 123,
"userSub": "xyz789",
"title": "xyz789",
"description": "abc123",
"artistId": "abc123",
"fileType": "IMAGE",
"networkName": "ropsten",
"s3Key": "xyz789",
"s3CoverKey": "abc123",
"ipfsNftUrl": "abc123",
"ipfsCoverUrl": "abc123",
"ipfsMetadataUrl": "abc123",
"ipfsNftHash": "abc123",
"ipfsCoverHash": "xyz789",
"licenceS3Key": "abc123",
"ipfsLicenceHash": "xyz789",
"nftLicence": NftLicenceDto,
"ipfsMetadataHash": "abc123",
"status": "PENDING_UPLOAD",
"backgroundColor": "abc123",
"externalUrl": "abc123",
"youtubeUrl": "xyz789",
"attributes": [NftMetadataAttributeObject],
"ipfsNftPublicUrl": "abc123",
"ipfsCoverPublicUrl": "xyz789",
"ipfsMetadataPublicUrl": "xyz789",
"ipfsLicencePublicUrl": "abc123"
}
Types
NftMetadataDraftReqDTO
Fields
Input Field Description revelatorTermsAndConditions
- Boolean
Example
Copy {
"backgroundColor": "xyz789",
"externalUrl": "abc123",
"youtubeUrl": "xyz789",
"attributes": [NftMetadataAttributeInput],
"title": "abc123",
"description": "xyz789",
"artistId": "xyz789",
"fileType": "IMAGE",
"networkName": "ropsten",
"revelatorTermsAndConditions": false,
"personalUses": [123],
"commercialUses": [123]
}
Types
NftMetadataDraftResDTO
Fields
Example
Copy {
"id": 123.45,
"fileName": "xyz789",
"title": "xyz789",
"description": "abc123",
"artistId": "abc123",
"fileType": "IMAGE",
"networkName": "ropsten",
"backgroundColor": "abc123",
"externalUrl": "xyz789",
"youtubeUrl": "abc123",
"attributes": [NftMetadataAttributeObject]
}
Types
NftMetadataLinkReqDTO
Fields
Input Field Description the file name must contain its extension -> [name].jpg
mime type of the nft file -> image/jpeg
the file name must contain its extension -> [name].jpg
mime type of the cover image file -> image/jpeg
Example
Copy {
"fileName": "abc123",
"fileMime": "abc123",
"coverFileName": "abc123",
"coverMime": "xyz789"
}
Types
NftMetadataLinkResDTO
Fields
Example
Copy {
"uploadUrl": "xyz789",
"coverUploadUrl": "abc123"
}
Types
NftMetadataListResDTO
Fields
Example
Copy {"items": [NftMetadataDraftResDTO], "count": 987.65}
Types
NftUseDTO
Fields
Example
Copy {
"id": 123,
"name": "abc123",
"description": "abc123",
"position": 987.65,
"nftUseType": "personal"
}
Types
NftUseType
Values
Example
Types
NftUsesDTO
Fields
Example
Copy {"list": [NftUseDTO]}
Types
OrderDirection
Description
Defines the order direction, either ascending or descending
Values
Example
Types
OwnedBy
Fields
Input Field Description 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)
The value by which the tokens/collections are filtered.
Example
Copy {"type": "PERSON_ID", "value": "xyz789"}
Types
Owner
Fields
Example
Copy {"address": "xyz789"}
Types
OwnerWithMetadata
Fields
Example
Copy {
"amountOwned": "xyz789",
"amountDeposited": "xyz789",
"id": "xyz789",
"walletAddress": "xyz789",
"smartWalletAddress": "abc123",
"username": "abc123",
"avatarS3Key": "xyz789",
"avatarUrl": "abc123"
}
Types
Owner_filter
Fields
Input Field Description Filter for the block changed event.
address_not_contains
- Bytes
Example
Copy {
"_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
Fields
Example
Copy {"startId": 123.45, "limit": 123.45}
Types
PersonDto
Fields
Example
Copy {
"id": "abc123",
"walletAddress": "xyz789",
"smartWalletAddress": "xyz789",
"username": "xyz789",
"avatarS3Key": "xyz789",
"avatarUrl": "abc123"
}
Types
PersonIdentifier
Fields
Example
Copy {
"id": "xyz789",
"walletAddress": "abc123"
}
Types
Persons
Fields
Example
Copy {"items": [PersonDto], "count": 987.65}
Types
Purchase
Fields
Example
Copy {
"id": "abc123",
"amount": "xyz789",
"salePrice": "xyz789",
"value": "xyz789",
"buyer": Owner,
"createdAt": "abc123"
}
Types
Purchase_filter
Fields
Input Field Description Filter for the block changed event.
buyer_contains_nocase
- String
buyer_ends_with_nocase
- String
buyer_not_contains_nocase
- String
buyer_not_ends_with_nocase
- String
buyer_not_starts_with
- String
buyer_not_starts_with_nocase
- String
buyer_starts_with_nocase
- String
createdAt_contains_nocase
- String
createdAt_ends_with_nocase
- String
createdAt_not_contains
- String
createdAt_not_contains_nocase
- String
createdAt_not_ends_with
- String
createdAt_not_ends_with_nocase
- String
createdAt_not_starts_with
- String
createdAt_not_starts_with_nocase
- String
createdAt_starts_with
- String
createdAt_starts_with_nocase
- String
token_contains_nocase
- String
token_ends_with_nocase
- String
token_not_contains_nocase
- String
token_not_ends_with_nocase
- String
token_not_starts_with
- String
token_not_starts_with_nocase
- String
token_starts_with_nocase
- String
Example
Copy {
"_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": "abc123",
"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": ["xyz789"],
"buyer_not_starts_with": "abc123",
"buyer_not_starts_with_nocase": "xyz789",
"buyer_starts_with": "abc123",
"buyer_starts_with_nocase": "xyz789",
"createdAt": "abc123",
"createdAt_contains": "xyz789",
"createdAt_contains_nocase": "xyz789",
"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": "abc123",
"createdAt_not_contains": "xyz789",
"createdAt_not_contains_nocase": "xyz789",
"createdAt_not_ends_with": "xyz789",
"createdAt_not_ends_with_nocase": "xyz789",
"createdAt_not_in": ["abc123"],
"createdAt_not_starts_with": "xyz789",
"createdAt_not_starts_with_nocase": "abc123",
"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": [Purchase_filter],
"salePrice": {},
"salePrice_gt": {},
"salePrice_gte": {},
"salePrice_in": [{}],
"salePrice_lt": {},
"salePrice_lte": {},
"salePrice_not": {},
"salePrice_not_in": [{}],
"token": "abc123",
"token_": Token_filter,
"token_contains": "xyz789",
"token_contains_nocase": "xyz789",
"token_ends_with": "xyz789",
"token_ends_with_nocase": "abc123",
"token_gt": "xyz789",
"token_gte": "xyz789",
"token_in": ["xyz789"],
"token_lt": "abc123",
"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": "xyz789",
"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
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
Types
Token
Fields
Example
Copy {
"id": "abc123",
"tokenId": "abc123",
"collectionContract": Collection,
"minter": "xyz789",
"enterprise": CollectionEntity,
"artist": CollectionEntity,
"amount": "abc123",
"royaltyRecipient": "xyz789",
"royaltyNumerator": "xyz789",
"owners": [TokenOwner],
"ownersWithMetadata": [OwnerWithMetadata],
"listing": Listing,
"purchases": [Purchase],
"tokenURI": "abc123",
"metadata": NftMetadataDTO,
"nftUrl": "xyz789",
"coverUrl": "xyz789",
"networkName": "ropsten",
"createdAt": "xyz789",
"updatedAt": "abc123"
}
Types
TokenOwner
Fields
Example
Copy {
"id": "xyz789",
"owner": Owner,
"amountOwned": "xyz789",
"amountDeposited": "abc123"
}
Types
TokenOwner_filter
Fields
Input Field Description Filter for the block changed event.
owner_contains_nocase
- String
owner_ends_with_nocase
- String
owner_not_contains_nocase
- String
owner_not_ends_with_nocase
- String
owner_not_starts_with
- String
owner_not_starts_with_nocase
- String
owner_starts_with_nocase
- String
token_contains_nocase
- String
token_ends_with_nocase
- String
token_not_contains_nocase
- String
token_not_ends_with_nocase
- String
token_not_starts_with
- String
token_not_starts_with_nocase
- String
token_starts_with_nocase
- String
Example
Copy {
"_change_block": BlockChangedFilter,
"amountDeposited": {},
"amountDeposited_gt": {},
"amountDeposited_gte": {},
"amountDeposited_in": [{}],
"amountDeposited_lt": {},
"amountDeposited_lte": {},
"amountDeposited_not": {},
"amountDeposited_not_in": [{}],
"amountOwned": {},
"amountOwned_gt": {},
"amountOwned_gte": {},
"amountOwned_in": [{}],
"amountOwned_lt": {},
"amountOwned_lte": {},
"amountOwned_not": {},
"amountOwned_not_in": [{}],
"and": [TokenOwner_filter],
"id": "4",
"id_gt": 4,
"id_gte": "4",
"id_in": [4],
"id_lt": 4,
"id_lte": "4",
"id_not": 4,
"id_not_in": ["4"],
"or": [TokenOwner_filter],
"owner": "abc123",
"owner_": Owner_filter,
"owner_contains": "xyz789",
"owner_contains_nocase": "xyz789",
"owner_ends_with": "abc123",
"owner_ends_with_nocase": "abc123",
"owner_gt": "abc123",
"owner_gte": "xyz789",
"owner_in": ["xyz789"],
"owner_lt": "abc123",
"owner_lte": "xyz789",
"owner_not": "xyz789",
"owner_not_contains": "abc123",
"owner_not_contains_nocase": "abc123",
"owner_not_ends_with": "xyz789",
"owner_not_ends_with_nocase": "xyz789",
"owner_not_in": ["xyz789"],
"owner_not_starts_with": "xyz789",
"owner_not_starts_with_nocase": "abc123",
"owner_starts_with": "abc123",
"owner_starts_with_nocase": "xyz789",
"token": "xyz789",
"token_": Token_filter,
"token_contains": "xyz789",
"token_contains_nocase": "abc123",
"token_ends_with": "abc123",
"token_ends_with_nocase": "abc123",
"token_gt": "abc123",
"token_gte": "abc123",
"token_in": ["abc123"],
"token_lt": "xyz789",
"token_lte": "xyz789",
"token_not": "abc123",
"token_not_contains": "abc123",
"token_not_contains_nocase": "xyz789",
"token_not_ends_with": "xyz789",
"token_not_ends_with_nocase": "abc123",
"token_not_in": ["xyz789"],
"token_not_starts_with": "xyz789",
"token_not_starts_with_nocase": "xyz789",
"token_starts_with": "abc123",
"token_starts_with_nocase": "abc123"
}
Types
Token_filter
Fields
Input Field Description Filter for the block changed event.
collectionContract_contains
- String
collectionContract_contains_nocase
- String
collectionContract_ends_with
- String
collectionContract_ends_with_nocase
- String
collectionContract_gt
- String
collectionContract_gte
- String
collectionContract_lt
- String
collectionContract_lte
- String
collectionContract_not
- String
collectionContract_not_contains
- String
collectionContract_not_contains_nocase
- String
collectionContract_not_ends_with
- String
collectionContract_not_ends_with_nocase
- String
collectionContract_not_starts_with
- String
collectionContract_not_starts_with_nocase
- String
collectionContract_starts_with
- String
collectionContract_starts_with_nocase
- String
createdAt_contains_nocase
- String
createdAt_ends_with_nocase
- String
createdAt_not_contains
- String
createdAt_not_contains_nocase
- String
createdAt_not_ends_with
- String
createdAt_not_ends_with_nocase
- String
createdAt_not_starts_with
- String
createdAt_not_starts_with_nocase
- String
createdAt_starts_with
- String
createdAt_starts_with_nocase
- String
minter_not_contains
- Bytes
royaltyRecipient_contains
- Bytes
royaltyRecipient_gt
- Bytes
royaltyRecipient_gte
- Bytes
royaltyRecipient_lt
- Bytes
royaltyRecipient_lte
- Bytes
royaltyRecipient_not
- Bytes
royaltyRecipient_not_contains
- Bytes
tokenURI_contains_nocase
- String
tokenURI_ends_with_nocase
- String
tokenURI_not_contains
- String
tokenURI_not_contains_nocase
- String
tokenURI_not_ends_with
- String
tokenURI_not_ends_with_nocase
- String
tokenURI_not_starts_with
- String
tokenURI_not_starts_with_nocase
- String
tokenURI_starts_with_nocase
- String
updatedAt_contains_nocase
- String
updatedAt_ends_with_nocase
- String
updatedAt_not_contains
- String
updatedAt_not_contains_nocase
- String
updatedAt_not_ends_with
- String
updatedAt_not_ends_with_nocase
- String
updatedAt_not_starts_with
- String
updatedAt_not_starts_with_nocase
- String
updatedAt_starts_with
- String
updatedAt_starts_with_nocase
- String
Example
Copy {
"_change_block": BlockChangedFilter,
"amount": {},
"amount_gt": {},
"amount_gte": {},
"amount_in": [{}],
"amount_lt": {},
"amount_lte": {},
"amount_not": {},
"amount_not_in": [{}],
"and": [Token_filter],
"collectionContract": "abc123",
"collectionContract_": CollectionContract_filter,
"collectionContract_contains": "abc123",
"collectionContract_contains_nocase": "abc123",
"collectionContract_ends_with": "xyz789",
"collectionContract_ends_with_nocase": "abc123",
"collectionContract_gt": "xyz789",
"collectionContract_gte": "abc123",
"collectionContract_in": ["abc123"],
"collectionContract_lt": "xyz789",
"collectionContract_lte": "xyz789",
"collectionContract_not": "abc123",
"collectionContract_not_contains": "abc123",
"collectionContract_not_contains_nocase": "xyz789",
"collectionContract_not_ends_with": "abc123",
"collectionContract_not_ends_with_nocase": "xyz789",
"collectionContract_not_in": ["xyz789"],
"collectionContract_not_starts_with": "abc123",
"collectionContract_not_starts_with_nocase": "xyz789",
"collectionContract_starts_with": "xyz789",
"collectionContract_starts_with_nocase": "xyz789",
"createdAt": "xyz789",
"createdAt_contains": "xyz789",
"createdAt_contains_nocase": "xyz789",
"createdAt_ends_with": "abc123",
"createdAt_ends_with_nocase": "abc123",
"createdAt_gt": "abc123",
"createdAt_gte": "abc123",
"createdAt_in": ["abc123"],
"createdAt_lt": "abc123",
"createdAt_lte": "abc123",
"createdAt_not": "abc123",
"createdAt_not_contains": "abc123",
"createdAt_not_contains_nocase": "xyz789",
"createdAt_not_ends_with": "abc123",
"createdAt_not_ends_with_nocase": "xyz789",
"createdAt_not_in": ["xyz789"],
"createdAt_not_starts_with": "abc123",
"createdAt_not_starts_with_nocase": "abc123",
"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"],
"listing_": Listing_filter,
"minter": Bytes,
"minter_contains": Bytes,
"minter_gt": Bytes,
"minter_gte": Bytes,
"minter_in": [Bytes],
"minter_lt": Bytes,
"minter_lte": Bytes,
"minter_not": Bytes,
"minter_not_contains": Bytes,
"minter_not_in": [Bytes],
"or": [Token_filter],
"owners_": TokenOwner_filter,
"purchases_": Purchase_filter,
"royaltyNumerator": {},
"royaltyNumerator_gt": {},
"royaltyNumerator_gte": {},
"royaltyNumerator_in": [{}],
"royaltyNumerator_lt": {},
"royaltyNumerator_lte": {},
"royaltyNumerator_not": {},
"royaltyNumerator_not_in": [{}],
"royaltyRecipient": Bytes,
"royaltyRecipient_contains": Bytes,
"royaltyRecipient_gt": Bytes,
"royaltyRecipient_gte": Bytes,
"royaltyRecipient_in": [Bytes],
"royaltyRecipient_lt": Bytes,
"royaltyRecipient_lte": Bytes,
"royaltyRecipient_not": Bytes,
"royaltyRecipient_not_contains": Bytes,
"royaltyRecipient_not_in": [Bytes],
"tokenId": {},
"tokenId_gt": {},
"tokenId_gte": {},
"tokenId_in": [{}],
"tokenId_lt": {},
"tokenId_lte": {},
"tokenId_not": {},
"tokenId_not_in": [{}],
"tokenURI": "abc123",
"tokenURI_contains": "abc123",
"tokenURI_contains_nocase": "xyz789",
"tokenURI_ends_with": "xyz789",
"tokenURI_ends_with_nocase": "xyz789",
"tokenURI_gt": "xyz789",
"tokenURI_gte": "abc123",
"tokenURI_in": ["abc123"],
"tokenURI_lt": "xyz789",
"tokenURI_lte": "xyz789",
"tokenURI_not": "abc123",
"tokenURI_not_contains": "xyz789",
"tokenURI_not_contains_nocase": "abc123",
"tokenURI_not_ends_with": "abc123",
"tokenURI_not_ends_with_nocase": "xyz789",
"tokenURI_not_in": ["xyz789"],
"tokenURI_not_starts_with": "abc123",
"tokenURI_not_starts_with_nocase": "xyz789",
"tokenURI_starts_with": "xyz789",
"tokenURI_starts_with_nocase": "abc123",
"updatedAt": "xyz789",
"updatedAt_contains": "abc123",
"updatedAt_contains_nocase": "abc123",
"updatedAt_ends_with": "xyz789",
"updatedAt_ends_with_nocase": "abc123",
"updatedAt_gt": "xyz789",
"updatedAt_gte": "xyz789",
"updatedAt_in": ["abc123"],
"updatedAt_lt": "xyz789",
"updatedAt_lte": "abc123",
"updatedAt_not": "abc123",
"updatedAt_not_contains": "abc123",
"updatedAt_not_contains_nocase": "xyz789",
"updatedAt_not_ends_with": "abc123",
"updatedAt_not_ends_with_nocase": "abc123",
"updatedAt_not_in": ["abc123"],
"updatedAt_not_starts_with": "xyz789",
"updatedAt_not_starts_with_nocase": "xyz789",
"updatedAt_starts_with": "xyz789",
"updatedAt_starts_with_nocase": "abc123"
}
Types
Token_orderBy
Values
Enum Value Description collectionContract__address
collectionContract__contractURI
collectionContract__createdAt
collectionContract__owner
collectionContract__updatedAt
Example
Types
UpdatePerson
Fields
Example
Copy {
"username": "xyz789",
"walletAddress": "abc123"
}
Types
_SubgraphErrorPolicy_
Values
Enum Value Description Data will be returned even if the subgraph has indexing errors
If the subgraph has indexing errors, data will be omitted. The default.
Example
Types
collectionContractsQueryArgs
Fields
Input Field Description 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.
Set to allow
to receive data even if the subgraph has skipped over errors while syncing. Default = deny
Example
Copy {
"block": Block_height,
"first": 987,
"orderBy": "address",
"orderDirection": "asc",
"skip": 987,
"subgraphError": "allow",
"where": CollectionContract_filter
}
Types
tokensInput
Fields
Input Field Description Name of the blockchain network on which the transaction occurs
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.
Parameters filtering tokens by minters. One token can have one minter. Minter is the creator of the token or the entity that created the token on behalf of the artist.
byCollectionEntityUri
- String
Parameters filtering tokens by collectionEntity. CollectionEntity is the creator of the token, either a creator group to which the minters belong, or an organization that created the tokens on behalf of the artists.
Parameters filtering tokens from subgraph.
Example
Copy {
"network": "ropsten",
"ownedBy": OwnedBy,
"mintedBy": MintedBy,
"byCollectionEntityUri": "xyz789",
"queryParams": tokensQueryArgs
}
Types
tokensQueryArgs
Fields
Input Field Description 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.
Set to allow
to receive data even if the subgraph has skipped over errors while syncing. Default = deny
Example
Copy {
"block": Block_height,
"first": 987,
"orderBy": "amount",
"orderDirection": "asc",
"skip": 123,
"subgraphError": "allow",
"where": Token_filter
}
Documentation by Anvil SpectaQL