Sound.xyz GraphQL API Reference
API Endpoints
# Preview:
https://preview.api.sound.xyz/graphql
# Staging:
https://staging.api.sound.xyz/graphql
# Production:
https://api.sound.xyz/graphql
Queries
activityFeed
Description
[PUBLIC] Activity Feed with filter parameters
Response
Returns an
ActivityFeed
Arguments
| Name | Description |
|---|---|
filter -
ActivityFeedFilterArgs!
|
Only get activity feed of certain type. Default = {activityFeedType: GLOBAL} |
Example
Query
query ActivityFeed($filter: ActivityFeedFilterArgs!) {
activityFeed(filter: $filter) {
groups {
edges {
...ActivityFeedGroupConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
id
}
}
Variables
{"filter": {"activityFeedType": "GLOBAL"}}
Response
{
"data": {
"activityFeed": {
"groups": ActivityFeedGroups,
"id": 4
}
}
}
adminAffiliateAggregates
Description
[ADMIN] Affiliate aggregates of authenticated user
Response
Returns
[AffiliateAggregate!]!
Arguments
| Name | Description |
|---|---|
publicAddress -
String!
|
Example
Query
query AdminAffiliateAggregates($publicAddress: String!) {
adminAffiliateAggregates(publicAddress: $publicAddress) {
earningsETH
earningsWei
mintsDriven
releaseArtistName
releaseArtistWebappUri
releaseCoverImageUrl
releaseId
releaseTitle
releaseWebappUri
}
}
Variables
{"publicAddress": "abc123"}
Response
{
"data": {
"adminAffiliateAggregates": [
{
"earningsETH": "xyz789",
"earningsWei": "abc123",
"mintsDriven": 987,
"releaseArtistName": "abc123",
"releaseArtistWebappUri": "abc123",
"releaseCoverImageUrl": "abc123",
"releaseId": "xyz789",
"releaseTitle": "xyz789",
"releaseWebappUri": "abc123"
}
]
}
}
adminFollowRecommendations
Description
[ADMIN] List follow recommendations for a user
Response
Returns
[User!]!
Arguments
| Name | Description |
|---|---|
userId -
UUID!
|
Find follow matches for the given User entity |
weights -
AdminUserFollowRecommendationWeights!
|
Weights to use when determining user interests profile |
Example
Query
query AdminFollowRecommendations(
$userId: UUID!,
$weights: AdminUserFollowRecommendationWeights!
) {
adminFollowRecommendations(
userId: $userId,
weights: $weights
) {
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
avatar {
bucket
dominantColor
id
key
url
}
backedArtists {
edges {
...ArtistCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
bannerImage {
bucket
dominantColor
id
key
url
}
collectedReleases {
edges {
...CollectedReleaseConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
creditSplit {
...CreditSplitFragment
}
id
owner {
...UserFragment
}
percent
roles
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
firstNftOwned {
...NftFragment
}
gaNftsCount
goldenEgg {
...EggGameFragment
}
id
nftsCount
ownedTokens {
...OwnedTokenFragment
}
release {
...ReleaseFragment
}
tierPriority
vipNftsCount
}
followerCount
followers {
edges {
...UserRelationConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
following {
edges {
...UserRelationConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
followingCount
id
instagramHandle
invitedByUser {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
affiliateBuyers {
...PlaylistAffiliateBuyerConnectionFragment
}
coverImage {
...MediaFragment
}
coverReleases {
...ReleaseFragment
}
createdAt
deletedAt
description
extendedFrom {
...ShelfFragment
}
id
index
likedBy {
...UserConnectionFragment
}
likes
linkSlug
name
numLikes
numReferralPurchases
numUsersReferred
orderedReleases {
...ShelfReleaseConnectionFragment
}
playTimeInSeconds
previewReleases {
...ShelfReleaseFragment
}
releaseCount
releaseIds
socialProofReferrals {
...UserFragment
}
trackIds
type
user {
...UserFragment
}
webEmbed
webappUri
}
location {
label
placeId
}
nftsOwned
nftsPaginated {
edges {
...NftConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
nonce
numBackedArtists
postCount
publicAddress
roles {
isAdmin
isArtistRelations
}
shelves {
edges {
...ShelfConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
}
Variables
{
"userId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"weights": AdminUserFollowRecommendationWeights
}
Response
{
"data": {
"adminFollowRecommendations": [
{
"artist": Artist,
"avatar": Media,
"backedArtists": ArtistCollectorConnection,
"bannerImage": Media,
"collectedReleases": CollectedReleaseConnection,
"collectedReleasesCount": 987,
"collectedReleasesIds": ["abc123"],
"collectorPosition": 987,
"createdAt": "2007-12-03T10:15:30Z",
"creditAllocations": [CreditAllocation],
"delegateWalletAddress": "xyz789",
"description": "xyz789",
"displayName": "xyz789",
"email": "xyz789",
"ens": "xyz789",
"farcasterFid": "xyz789",
"farcasterSignerConnected": true,
"featuredReleases": [CollectedRelease],
"followerCount": 987,
"followers": UserRelationConnection,
"following": UserRelationConnection,
"followingCount": 987,
"id": "4",
"instagramHandle": "xyz789",
"invitedByUser": User,
"isTopNotableCollector": true,
"lastReferralWithdrawableBalance": "xyz789",
"likedSounds": Shelf,
"location": GeoLocationPlaceGoogle,
"nftsOwned": 987,
"nftsPaginated": NftConnection,
"nonce": 123,
"numBackedArtists": 987,
"postCount": 123,
"publicAddress": "abc123",
"roles": UserRoles,
"shelves": ShelfConnection,
"shelvesCount": 987,
"showSplitsFeature": false,
"tiktokUrl": "abc123",
"topCollectorPosition": 987,
"twitterHandle": "xyz789",
"username": "xyz789",
"verifiedNotificationEmail": "abc123",
"webappUri": "xyz789"
}
]
}
}
adminUserBlockStatus
Description
[ADMIN] Gets the block status of a user
Response
Returns a
QueryAdminUserBlockStatusResult!
Arguments
| Name | Description |
|---|---|
input -
QueryAdminUserBlockStatusInput!
|
Example
Query
query AdminUserBlockStatus($input: QueryAdminUserBlockStatusInput!) {
adminUserBlockStatus(input: $input)
}
Variables
{"input": QueryAdminUserBlockStatusInput}
Response
{"data": {"adminUserBlockStatus": NotFoundError}}
adminUserNftComments
Description
[ADMIN] Retrieves all NFT comments made by a user
Response
Returns an
NFTCommentConnection!
Arguments
| Name | Description |
|---|---|
input -
QueryAdminUserNftCommentsInput!
|
Example
Query
query AdminUserNftComments($input: QueryAdminUserNftCommentsInput!) {
adminUserNftComments(input: $input) {
edges {
cursor
node {
...CommentFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{"input": QueryAdminUserNftCommentsInput}
Response
{
"data": {
"adminUserNftComments": {
"edges": [NftCommentConnectionEdge],
"pageInfo": PageInfo
}
}
}
adminUserPostCommentsWithoutNFTComments
Description
[ADMIN] Retrieves all post comments and replies made by a user, excluding comments associated with NFT comments
Response
Returns a
PostCommentConnection!
Arguments
| Name | Description |
|---|---|
input -
QueryAdminUserPostCommentsWithoutNFTCommentsInput!
|
Example
Query
query AdminUserPostCommentsWithoutNFTComments($input: QueryAdminUserPostCommentsWithoutNFTCommentsInput!) {
adminUserPostCommentsWithoutNFTComments(input: $input) {
edges {
cursor
node {
...PostCommentFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"input": QueryAdminUserPostCommentsWithoutNFTCommentsInput
}
Response
{
"data": {
"adminUserPostCommentsWithoutNFTComments": {
"edges": [PostCommentConnectionEdge],
"pageInfo": PageInfo
}
}
}
adminUserPosts
Description
[ADMIN] Retrieves all posts made by a user
Response
Returns a
PostConnection!
Arguments
| Name | Description |
|---|---|
input -
QueryAdminUserPostsInput!
|
Example
Query
query AdminUserPosts($input: QueryAdminUserPostsInput!) {
adminUserPosts(input: $input) {
edges {
cursor
node {
...PostFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{"input": QueryAdminUserPostsInput}
Response
{
"data": {
"adminUserPosts": {
"edges": [PostConnectionEdge],
"pageInfo": PageInfo
}
}
}
affiliateAggregates
Description
[AUTHENTICATED] Affiliate aggregates of authenticated user
Response
Returns
[AffiliateAggregate!]!
Example
Query
query AffiliateAggregates {
affiliateAggregates {
earningsETH
earningsWei
mintsDriven
releaseArtistName
releaseArtistWebappUri
releaseCoverImageUrl
releaseId
releaseTitle
releaseWebappUri
}
}
Response
{
"data": {
"affiliateAggregates": [
{
"earningsETH": "abc123",
"earningsWei": "abc123",
"mintsDriven": 987,
"releaseArtistName": "abc123",
"releaseArtistWebappUri": "abc123",
"releaseCoverImageUrl": "xyz789",
"releaseId": "abc123",
"releaseTitle": "abc123",
"releaseWebappUri": "abc123"
}
]
}
}
allChannels
Description
[PUBLIC] All channels
Response
Returns a
ChannelConnection!
Arguments
| Name | Description |
|---|---|
pagination -
CursorConnectionArgs!
|
Pagination parameters. Default = {first: 10, sort: DESC} |
Example
Query
query AllChannels($pagination: CursorConnectionArgs!) {
allChannels(pagination: $pagination) {
edges {
cursor
node {
...ChannelFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{"pagination": {"first": 10, "sort": "DESC"}}
Response
{
"data": {
"allChannels": {
"edges": [ChannelConnectionEdge],
"pageInfo": PageInfo
}
}
}
allCollectors
Description
[PUBLIC] Paginate through all collectors of the system
Response
Returns a
UserConnection!
Arguments
| Name | Description |
|---|---|
input -
AllCollectorsInput!
|
Parameters of all collectors pagination. Default = {filter: {includeArtists: true, onlyWithUsername: false}, pagination: {after: null, first: 10, sort: {createdAt: DESC}}} |
Example
Query
query AllCollectors($input: AllCollectorsInput!) {
allCollectors(input: $input) {
edges {
cursor
node {
...UserFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"input": {
"filter": {"includeArtists": "true", "onlyWithUsername": "false"},
"pagination": {"after": "null", "first": 10, "sort": {"createdAt": "DESC"}}
}
}
Response
{
"data": {
"allCollectors": {
"edges": [UserConnectionEdge],
"pageInfo": PageInfo
}
}
}
allShelves
Description
Paginate through all shelves of the system
Response
Returns a
ShelfConnection!
Arguments
| Name | Description |
|---|---|
input -
AllShelvesInput!
|
Parameters of shelves pagination. Default = {filter: {type: [USER_CREATED]}, pagination: {after: null, first: 10, sort: {createdAt: DESC}}} |
Example
Query
query AllShelves($input: AllShelvesInput!) {
allShelves(input: $input) {
edges {
cursor
node {
...ShelfFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"input": {
"filter": {"type": ["USER_CREATED"]},
"pagination": {"after": "null", "first": 10, "sort": {"createdAt": "DESC"}}
}
}
Response
{
"data": {
"allShelves": {
"edges": [ShelfConnectionEdge],
"pageInfo": PageInfo
}
}
}
artist
Description
[PUBLIC] Artist by UUID
Example
Query
query Artist($id: UUID!) {
artist(id: $id) {
bannerImage {
bucket
dominantColor
id
key
url
}
collectors {
edges {
...ArtistCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
activityFeed {
...ReleaseActionConnectionFragment
}
affiliates {
...ReleaseAffiliateConnectionFragment
}
airdropCount
animatedCoverImage {
...MediaFragment
}
animatedGoldenEggImageOptimized {
...MediaFragment
}
artist {
...ArtistFragment
}
auctionContractType
auctionType
baseMetadataAttributes {
...MetadataAttributeFragment
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
...ReleaseCollectorConnectionFragment
}
collectorsCount
contract {
...ContractFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
creditSplit {
...CreditSplitFragment
}
credits {
...UserFragment
}
draftId
earliestCollector {
...ReleaseCollectorFragment
}
editionId
eggGame {
...EggGameFragment
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
...MediaFragment
}
gaCoverImage {
...MediaFragment
}
genre {
...GenreFragment
}
goldenEggImage {
...MediaFragment
}
goldenEggNft {
...NftFragment
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
...ReleaseCollectorFragment
}
likedBy {
...UserConnectionFragment
}
listeningParty
listing {
...AuctionListingInterfaceFragment
}
marketPlaceUrl
metadataDetails {
...MetadataDetailsFragment
}
mintStartTime
mintStartTimestamp
nftsPaginated {
...NftConnectionFragment
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
...RewardFragment
}
royaltyBps
saleDetails {
...SaleDetailsFragment
}
saleSchedules {
...SaleScheduleFragment
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
...SamConfigFragment
}
samSellBufferBpsOverride
scheduleIds {
...ScheduleIdentifierFragment
}
season
shelves {
...ShelfConnectionFragment
}
socialProofCollectors {
...UserFragment
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
...MediaFragment
}
staticGaCoverImage {
...MediaFragment
}
staticVipCoverImage {
...MediaFragment
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
...TopReleaseCollectorFragment
}
topPosts {
...PostFragment
}
topSpentCollector {
...ReleaseCollectorFragment
}
totalMinted
totalSupply
track {
...TrackFragment
}
type
vipAnimatedCoverImage {
...MediaFragment
}
vipCoverImage {
...MediaFragment
}
webEmbed
webappUri
}
releases {
edges {
...ReleaseConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
userId
webappUri
}
}
Variables
{
"id": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"artist": {
"bannerImage": Media,
"collectors": ArtistCollectorConnection,
"createdAt": "2007-12-03T10:15:30Z",
"gemCollectionUrl": "abc123",
"id": "4",
"name": "xyz789",
"numCollectors": 987,
"numNfts": 987,
"numReleases": 987,
"pickedRelease": Release,
"releases": ReleaseConnection,
"releasesGenres": ["xyz789"],
"season": "xyz789",
"soundHandle": "xyz789",
"spotifyUrl": "xyz789",
"tokenSymbol": "xyz789",
"user": User,
"userId": "abc123",
"webappUri": "xyz789"
}
}
}
artistActivityFeed
Description
[PUBLIC] Artist activity feed
Response
Returns an
ArtistActionConnection!
Arguments
| Name | Description |
|---|---|
artistId -
UUID!
|
Artist id |
filter -
ArtistActivityFeedFilterArgs!
|
Only get activities of given types. Default = {activityTypes: [ALL], types: [ALL]} |
pagination -
CursorConnectionArgs!
|
Pagination parameters. Default = {first: 10, sort: DESC} |
Example
Query
query ArtistActivityFeed(
$artistId: UUID!,
$filter: ArtistActivityFeedFilterArgs!,
$pagination: CursorConnectionArgs!
) {
artistActivityFeed(
artistId: $artistId,
filter: $filter,
pagination: $pagination
) {
edges {
cursor
node {
...ArtistActionFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"artistId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"filter": {"activityTypes": ["ALL"], "types": ["ALL"]},
"pagination": {"first": 10, "sort": "DESC"}
}
Response
{
"data": {
"artistActivityFeed": {
"edges": [ArtistActionConnectionEdge],
"pageInfo": PageInfo
}
}
}
artistApplication
Description
[AUTHENTICATED] Get most recent artist application for authenticated user
Response
Returns an
ArtistApplication
Example
Query
query ArtistApplication {
artistApplication {
createdAt
id
info {
artistName
coverImage {
...MediaUploadStepInfoFragment
}
email
instagramHandle
soundHandle
spotifyUrl
twitterHandle
}
mostRecentApplicationRejectionReason
status
user {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
}
}
Response
{
"data": {
"artistApplication": {
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"info": ArtistApplicationInfo,
"mostRecentApplicationRejectionReason": "xyz789",
"status": "ACCEPTED",
"user": User
}
}
}
artistApplications
Description
[ADMIN | ARTIST_RELATIONS] Get artist applications
Response
Returns an
ArtistApplicationConnection!
Arguments
| Name | Description |
|---|---|
filter -
ArtistApplicationsFilter!
|
Filter the artist releases. Default = {status: [PENDING]} |
pagination -
CursorConnectionArgs!
|
Pagination parameters. Default = {first: 10, sort: DESC} |
Example
Query
query ArtistApplications(
$filter: ArtistApplicationsFilter!,
$pagination: CursorConnectionArgs!
) {
artistApplications(
filter: $filter,
pagination: $pagination
) {
edges {
cursor
node {
...ArtistApplicationFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{"filter": {"status": ["PENDING"]}, "pagination": {"first": 10, "sort": "DESC"}}
Response
{
"data": {
"artistApplications": {
"edges": [ArtistApplicationConnectionEdge],
"pageInfo": PageInfo
}
}
}
artistByHandle
Description
[PUBLIC] Artist by handle
Example
Query
query ArtistByHandle($soundHandle: String!) {
artistByHandle(soundHandle: $soundHandle) {
bannerImage {
bucket
dominantColor
id
key
url
}
collectors {
edges {
...ArtistCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
activityFeed {
...ReleaseActionConnectionFragment
}
affiliates {
...ReleaseAffiliateConnectionFragment
}
airdropCount
animatedCoverImage {
...MediaFragment
}
animatedGoldenEggImageOptimized {
...MediaFragment
}
artist {
...ArtistFragment
}
auctionContractType
auctionType
baseMetadataAttributes {
...MetadataAttributeFragment
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
...ReleaseCollectorConnectionFragment
}
collectorsCount
contract {
...ContractFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
creditSplit {
...CreditSplitFragment
}
credits {
...UserFragment
}
draftId
earliestCollector {
...ReleaseCollectorFragment
}
editionId
eggGame {
...EggGameFragment
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
...MediaFragment
}
gaCoverImage {
...MediaFragment
}
genre {
...GenreFragment
}
goldenEggImage {
...MediaFragment
}
goldenEggNft {
...NftFragment
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
...ReleaseCollectorFragment
}
likedBy {
...UserConnectionFragment
}
listeningParty
listing {
...AuctionListingInterfaceFragment
}
marketPlaceUrl
metadataDetails {
...MetadataDetailsFragment
}
mintStartTime
mintStartTimestamp
nftsPaginated {
...NftConnectionFragment
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
...RewardFragment
}
royaltyBps
saleDetails {
...SaleDetailsFragment
}
saleSchedules {
...SaleScheduleFragment
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
...SamConfigFragment
}
samSellBufferBpsOverride
scheduleIds {
...ScheduleIdentifierFragment
}
season
shelves {
...ShelfConnectionFragment
}
socialProofCollectors {
...UserFragment
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
...MediaFragment
}
staticGaCoverImage {
...MediaFragment
}
staticVipCoverImage {
...MediaFragment
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
...TopReleaseCollectorFragment
}
topPosts {
...PostFragment
}
topSpentCollector {
...ReleaseCollectorFragment
}
totalMinted
totalSupply
track {
...TrackFragment
}
type
vipAnimatedCoverImage {
...MediaFragment
}
vipCoverImage {
...MediaFragment
}
webEmbed
webappUri
}
releases {
edges {
...ReleaseConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
userId
webappUri
}
}
Variables
{"soundHandle": "abc123"}
Response
{
"data": {
"artistByHandle": {
"bannerImage": Media,
"collectors": ArtistCollectorConnection,
"createdAt": "2007-12-03T10:15:30Z",
"gemCollectionUrl": "xyz789",
"id": 4,
"name": "abc123",
"numCollectors": 987,
"numNfts": 123,
"numReleases": 123,
"pickedRelease": Release,
"releases": ReleaseConnection,
"releasesGenres": ["abc123"],
"season": "abc123",
"soundHandle": "abc123",
"spotifyUrl": "xyz789",
"tokenSymbol": "xyz789",
"user": User,
"userId": "abc123",
"webappUri": "xyz789"
}
}
}
artistCommunityCSVUrl
Description
[ARTIST] CDN url CSV of artist community type
Response
Returns a
String
Arguments
| Name | Description |
|---|---|
input -
ArtistCommunityCSVUrlInput!
|
Input parameters |
Example
Query
query ArtistCommunityCSVUrl($input: ArtistCommunityCSVUrlInput!) {
artistCommunityCSVUrl(input: $input)
}
Variables
{"input": ArtistCommunityCSVUrlInput}
Response
{
"data": {
"artistCommunityCSVUrl": "xyz789"
}
}
artistDefaultMintingOptions
Description
[ADMIN | ARTIST_RELATIONS] Default reference artist minting release options of specified artist
Response
Returns an
ArtistDefaultOptions!
Arguments
| Name | Description |
|---|---|
artistAddress -
Address!
|
Artist user wallet public address or artist contract address |
Example
Query
query ArtistDefaultMintingOptions($artistAddress: Address!) {
artistDefaultMintingOptions(artistAddress: $artistAddress) {
auction
}
}
Variables
{"artistAddress": Address}
Response
{
"data": {
"artistDefaultMintingOptions": {
"auction": [FixedAuction]
}
}
}
artistDrafts
Description
[ARTIST] Get artist release drafts
Response
Returns a
DraftConnection!
Arguments
| Name | Description |
|---|---|
input -
ArtistDraftsInput!
|
Input parameters |
Example
Query
query ArtistDrafts($input: ArtistDraftsInput!) {
artistDrafts(input: $input) {
edges {
cursor
node {
...DraftFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{"input": ArtistDraftsInput}
Response
{
"data": {
"artistDrafts": {
"edges": [DraftConnectionEdge],
"pageInfo": PageInfo
}
}
}
artistMintingOptions
Description
[ARTIST | ADMIN | ARTIST_RELATIONS] Get artist minting options of authenticated artist. Given artist id has to match authenticated artist
Response
Returns an
ArtistReleaseOptions!
Arguments
| Name | Description |
|---|---|
artistId -
UUID!
|
Example
Query
query ArtistMintingOptions($artistId: UUID!) {
artistMintingOptions(artistId: $artistId) {
auction
hasNoTimeRestriction
hasSplitsAccess
}
}
Variables
{
"artistId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"artistMintingOptions": {
"auction": [FixedAuction],
"hasNoTimeRestriction": false,
"hasSplitsAccess": false
}
}
}
artistNotificationSubscriptions
Description
[AUTHENTICATED] Get artist subscriptions for the authenticated user
Response
Returns an
ArtistNotificationSubscriptionConnection!
Arguments
| Name | Description |
|---|---|
artists -
[UUID!]
|
Determine if auth user is subscribed to a given set of artists. Up to 51 can be checked at a time |
pagination -
ArtistNotificationSubscriptionCursorConnectionArgs!
|
Pagination parameters. Default = {after: null, first: 20, sort: ASC} |
Example
Query
query ArtistNotificationSubscriptions(
$artists: [UUID!],
$pagination: ArtistNotificationSubscriptionCursorConnectionArgs!
) {
artistNotificationSubscriptions(
artists: $artists,
pagination: $pagination
) {
edges {
cursor
node {
...ArtistNotificationSubscriptionFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"artists": [
"6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
],
"pagination": {"after": "null", "first": 20, "sort": "ASC"}
}
Response
{
"data": {
"artistNotificationSubscriptions": {
"edges": [
ArtistNotificationSubscriptionConnectionEdge
],
"pageInfo": PageInfo
}
}
}
artistPartnership
Description
[PUBLIC] Artist Partnership information
Response
Returns an
ArtistPartnership!
Example
Query
query ArtistPartnership {
artistPartnership {
highlights {
imageLabel
imageUrl
linkUrl
}
id
message
}
}
Response
{
"data": {
"artistPartnership": {
"highlights": [ArtistPartnershipHighlight],
"id": 4,
"message": "abc123"
}
}
}
artistPrivateCommunityMembers
Description
[ARTIST] Members of artist private community
Response
Returns an
ArtistPrivateCommunityMemberConnection!
Arguments
| Name | Description |
|---|---|
input -
ArtistPrivateCommunityMembersInput!
|
Input parameters |
Example
Query
query ArtistPrivateCommunityMembers($input: ArtistPrivateCommunityMembersInput!) {
artistPrivateCommunityMembers(input: $input) {
edges {
cursor
node {
...ArtistPrivateCommunityMemberFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{"input": ArtistPrivateCommunityMembersInput}
Response
{
"data": {
"artistPrivateCommunityMembers": {
"edges": [
ArtistPrivateCommunityMemberConnectionEdge
],
"pageInfo": PageInfo
}
}
}
artists
Description
[PUBLIC] Get all artists of platform.
Response
Returns an
ArtistConnection!
Arguments
| Name | Description |
|---|---|
filter -
ArtistCursorFilterArgs
|
Paginated artists filters |
pagination -
CursorConnectionArgs!
|
Pagination parameters. Default = {first: 10, sort: DESC} |
Example
Query
query Artists(
$filter: ArtistCursorFilterArgs,
$pagination: CursorConnectionArgs!
) {
artists(
filter: $filter,
pagination: $pagination
) {
edges {
cursor
node {
...ArtistFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"filter": ArtistCursorFilterArgs,
"pagination": {"first": 10, "sort": "DESC"}
}
Response
{
"data": {
"artists": {
"edges": [ArtistConnectionEdge],
"pageInfo": PageInfo
}
}
}
authUser
Description
[PUBLIC] Get authenticated user information, if any
Response
Returns a
User
Example
Query
query AuthUser {
authUser {
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
avatar {
bucket
dominantColor
id
key
url
}
backedArtists {
edges {
...ArtistCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
bannerImage {
bucket
dominantColor
id
key
url
}
collectedReleases {
edges {
...CollectedReleaseConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
creditSplit {
...CreditSplitFragment
}
id
owner {
...UserFragment
}
percent
roles
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
firstNftOwned {
...NftFragment
}
gaNftsCount
goldenEgg {
...EggGameFragment
}
id
nftsCount
ownedTokens {
...OwnedTokenFragment
}
release {
...ReleaseFragment
}
tierPriority
vipNftsCount
}
followerCount
followers {
edges {
...UserRelationConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
following {
edges {
...UserRelationConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
followingCount
id
instagramHandle
invitedByUser {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
affiliateBuyers {
...PlaylistAffiliateBuyerConnectionFragment
}
coverImage {
...MediaFragment
}
coverReleases {
...ReleaseFragment
}
createdAt
deletedAt
description
extendedFrom {
...ShelfFragment
}
id
index
likedBy {
...UserConnectionFragment
}
likes
linkSlug
name
numLikes
numReferralPurchases
numUsersReferred
orderedReleases {
...ShelfReleaseConnectionFragment
}
playTimeInSeconds
previewReleases {
...ShelfReleaseFragment
}
releaseCount
releaseIds
socialProofReferrals {
...UserFragment
}
trackIds
type
user {
...UserFragment
}
webEmbed
webappUri
}
location {
label
placeId
}
nftsOwned
nftsPaginated {
edges {
...NftConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
nonce
numBackedArtists
postCount
publicAddress
roles {
isAdmin
isArtistRelations
}
shelves {
edges {
...ShelfConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
}
Response
{
"data": {
"authUser": {
"artist": Artist,
"avatar": Media,
"backedArtists": ArtistCollectorConnection,
"bannerImage": Media,
"collectedReleases": CollectedReleaseConnection,
"collectedReleasesCount": 987,
"collectedReleasesIds": ["abc123"],
"collectorPosition": 987,
"createdAt": "2007-12-03T10:15:30Z",
"creditAllocations": [CreditAllocation],
"delegateWalletAddress": "xyz789",
"description": "abc123",
"displayName": "xyz789",
"email": "xyz789",
"ens": "abc123",
"farcasterFid": "xyz789",
"farcasterSignerConnected": true,
"featuredReleases": [CollectedRelease],
"followerCount": 123,
"followers": UserRelationConnection,
"following": UserRelationConnection,
"followingCount": 123,
"id": 4,
"instagramHandle": "xyz789",
"invitedByUser": User,
"isTopNotableCollector": false,
"lastReferralWithdrawableBalance": "xyz789",
"likedSounds": Shelf,
"location": GeoLocationPlaceGoogle,
"nftsOwned": 987,
"nftsPaginated": NftConnection,
"nonce": 123,
"numBackedArtists": 987,
"postCount": 123,
"publicAddress": "xyz789",
"roles": UserRoles,
"shelves": ShelfConnection,
"shelvesCount": 987,
"showSplitsFeature": false,
"tiktokUrl": "abc123",
"topCollectorPosition": 123,
"twitterHandle": "abc123",
"username": "xyz789",
"verifiedNotificationEmail": "xyz789",
"webappUri": "abc123"
}
}
}
balancesAndEarnings
Description
[AUTHENTICATED] Get the earnings for the authenticated user
Response
Returns
[ChainBalanceAndEarnings!]!
Example
Query
query BalancesAndEarnings {
balancesAndEarnings {
chainId
cummulativeEarned
externalSplitMainBalance
releasesAvailableToWithdraw
releasesSplitMainBalance
totalAvailableToWithdraw
totalSplitMainBalance
}
}
Response
{
"data": {
"balancesAndEarnings": [
{
"chainId": 123,
"cummulativeEarned": "xyz789",
"externalSplitMainBalance": "abc123",
"releasesAvailableToWithdraw": "xyz789",
"releasesSplitMainBalance": "abc123",
"totalAvailableToWithdraw": "xyz789",
"totalSplitMainBalance": "abc123"
}
]
}
}
channelById
Description
[PUBLIC] Channel by ID
Example
Query
query ChannelById($id: UUID!) {
channelById(id: $id) {
animatedProfileImage {
bucket
dominantColor
id
key
url
}
coverImage {
bucket
dominantColor
id
key
url
}
createdAt
description
discordUrl
id
name
nameSlug
profileImage {
bucket
dominantColor
id
key
url
}
published
rules
staticProfileImage {
bucket
dominantColor
id
key
url
}
telegramUrl
tiktokUrl
twitterUrl
webappUri
websiteUrl
}
}
Variables
{
"id": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"channelById": {
"animatedProfileImage": Media,
"coverImage": Media,
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"discordUrl": "xyz789",
"id": 4,
"name": "abc123",
"nameSlug": "abc123",
"profileImage": Media,
"published": false,
"rules": "xyz789",
"staticProfileImage": Media,
"telegramUrl": "xyz789",
"tiktokUrl": "xyz789",
"twitterUrl": "abc123",
"webappUri": "xyz789",
"websiteUrl": "xyz789"
}
}
}
channelBySlug
Description
[PUBLIC] Channel by slug
Example
Query
query ChannelBySlug($nameSlug: String!) {
channelBySlug(nameSlug: $nameSlug) {
animatedProfileImage {
bucket
dominantColor
id
key
url
}
coverImage {
bucket
dominantColor
id
key
url
}
createdAt
description
discordUrl
id
name
nameSlug
profileImage {
bucket
dominantColor
id
key
url
}
published
rules
staticProfileImage {
bucket
dominantColor
id
key
url
}
telegramUrl
tiktokUrl
twitterUrl
webappUri
websiteUrl
}
}
Variables
{"nameSlug": "xyz789"}
Response
{
"data": {
"channelBySlug": {
"animatedProfileImage": Media,
"coverImage": Media,
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"discordUrl": "abc123",
"id": 4,
"name": "xyz789",
"nameSlug": "xyz789",
"profileImage": Media,
"published": false,
"rules": "abc123",
"staticProfileImage": Media,
"telegramUrl": "abc123",
"tiktokUrl": "xyz789",
"twitterUrl": "abc123",
"webappUri": "abc123",
"websiteUrl": "xyz789"
}
}
}
channelCurators
Description
[PUBLIC] Curators of the channel
Response
Returns a
ChannelCuratorConnection!
Arguments
| Name | Description |
|---|---|
channelId -
UUID!
|
Channel identifier |
pagination -
CursorConnectionArgs!
|
Pagination parameters. Default = {first: 10, sort: DESC} |
Example
Query
query ChannelCurators(
$channelId: UUID!,
$pagination: CursorConnectionArgs!
) {
channelCurators(
channelId: $channelId,
pagination: $pagination
) {
edges {
cursor
node {
...ChannelCuratorFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"channelId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"pagination": {"first": 10, "sort": "DESC"}
}
Response
{
"data": {
"channelCurators": {
"edges": [ChannelCuratorConnectionEdge],
"pageInfo": PageInfo
}
}
}
channelMembers
Description
[PUBLIC] Members of the channel
Response
Returns a
ChannelMemberConnection!
Arguments
| Name | Description |
|---|---|
channelId -
UUID!
|
Channel identifier |
pagination -
CursorConnectionArgs!
|
Pagination parameters. Default = {first: 10, sort: DESC} |
Example
Query
query ChannelMembers(
$channelId: UUID!,
$pagination: CursorConnectionArgs!
) {
channelMembers(
channelId: $channelId,
pagination: $pagination
) {
edges {
cursor
node {
...ChannelMemberFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"channelId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"pagination": {"first": 10, "sort": "DESC"}
}
Response
{
"data": {
"channelMembers": {
"edges": [ChannelMemberConnectionEdge],
"pageInfo": PageInfo
}
}
}
channelMembersWhoAreFollowed
Description
[AUTHENTICATED] Gets information about the members of the channel that the current user follows
Response
Returns a
QueryChannelMembersWhoAreFollowedResult!
Arguments
| Name | Description |
|---|---|
input -
ChannelMemberFollowedInput!
|
Example
Query
query ChannelMembersWhoAreFollowed($input: ChannelMemberFollowedInput!) {
channelMembersWhoAreFollowed(input: $input)
}
Variables
{"input": ChannelMemberFollowedInput}
Response
{"data": {"channelMembersWhoAreFollowed": NotFoundError}}
channelPosts
Description
[PUBLIC] Posts made to the channel
Response
Returns a
ChannelPostConnection!
Arguments
| Name | Description |
|---|---|
channelId -
String!
|
Channel ID |
pagination -
CursorConnectionArgs!
|
Pagination parameters. Default = {first: 10, sort: DESC} |
Example
Query
query ChannelPosts(
$channelId: String!,
$pagination: CursorConnectionArgs!
) {
channelPosts(
channelId: $channelId,
pagination: $pagination
) {
edges {
cursor
node {
...PostFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"channelId": "abc123",
"pagination": {"first": 10, "sort": "DESC"}
}
Response
{
"data": {
"channelPosts": {
"edges": [ChannelPostConnectionEdge],
"pageInfo": PageInfo
}
}
}
channelStats
Description
[PUBLIC] Returns stats about the specified channels
Response
Returns
[ChannelStats!]!
Arguments
| Name | Description |
|---|---|
input -
QueryChannelStatsInput!
|
Input for channelStats query |
Example
Query
query ChannelStats($input: QueryChannelStatsInput!) {
channelStats(input: $input) {
channelId
joinStatus
memberCount
notificationStatus
postCount
}
}
Variables
{"input": QueryChannelStatsInput}
Response
{
"data": {
"channelStats": [
{
"channelId": "xyz789",
"joinStatus": "JOINED",
"memberCount": 123,
"notificationStatus": "DISABLED",
"postCount": 987
}
]
}
}
claimableAffiliateEarnings
Description
[AUTHENTICATED] Get withdraw affiliate earnings information of authenticated user
Response
Returns
[WithdrawAffiliateEarnings!]!
Example
Query
query ClaimableAffiliateEarnings {
claimableAffiliateEarnings {
amount
chainId
id
minterAddresses
}
}
Response
{
"data": {
"claimableAffiliateEarnings": [
{
"amount": "xyz789",
"chainId": 987,
"id": 4,
"minterAddresses": ["abc123"]
}
]
}
}
claimedSongSlots
Description
[PUBLIC] Get the total number of claimed song slots
Example
Query
query ClaimedSongSlots($releaseId: UUID!) {
claimedSongSlots(releaseId: $releaseId)
}
Variables
{
"releaseId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{"data": {"claimedSongSlots": [987]}}
collectorActivityFeed
Description
[PUBLIC] Collector activity feed
Response
Returns a
CollectorActionConnection!
Arguments
| Name | Description |
|---|---|
filter -
CollectorActivityFeedFilterArgs!
|
Only get activities of given types. Default = {types: [ALL]} |
pagination -
CursorConnectionArgs!
|
Pagination parameters. Default = {first: 10, sort: DESC} |
userId -
UUID!
|
Collector user id |
Example
Query
query CollectorActivityFeed(
$filter: CollectorActivityFeedFilterArgs!,
$pagination: CursorConnectionArgs!,
$userId: UUID!
) {
collectorActivityFeed(
filter: $filter,
pagination: $pagination,
userId: $userId
) {
edges {
cursor
node {
...CollectorActionFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"filter": {"types": ["ALL"]},
"pagination": {"first": 10, "sort": "DESC"},
"userId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"collectorActivityFeed": {
"edges": [CollectorActionConnectionEdge],
"pageInfo": PageInfo
}
}
}
commentReplies
Description
Replies to a comment on a post
Response
Returns a
PostCommentConnection!
Arguments
| Name | Description |
|---|---|
pagination -
PostCommentCursorConnectionArgs!
|
Pagination parameters. Default = {after: null, first: 30, sort: {createdAt: DESC}} |
parentCommentId -
UUID!
|
Unique PostComment identifier |
postId -
UUID!
|
Unique Post identifier |
Example
Query
query CommentReplies(
$pagination: PostCommentCursorConnectionArgs!,
$parentCommentId: UUID!,
$postId: UUID!
) {
commentReplies(
pagination: $pagination,
parentCommentId: $parentCommentId,
postId: $postId
) {
edges {
cursor
node {
...PostCommentFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"pagination": {"after": "null", "first": 30, "sort": {"createdAt": "DESC"}},
"parentCommentId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"postId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"commentReplies": {
"edges": [PostCommentConnectionEdge],
"pageInfo": PageInfo
}
}
}
creditSplit
Description
[PUBLIC] Get credit split by id
Response
Returns a
CreditSplit
Arguments
| Name | Description |
|---|---|
id -
UUID!
|
Credit split identifier |
Example
Query
query CreditSplit($id: UUID!) {
creditSplit(id: $id) {
creditAllocations {
creditSplit {
...CreditSplitFragment
}
id
owner {
...UserFragment
}
percent
roles
}
id
mintedReleases {
activityFeed {
...ReleaseActionConnectionFragment
}
affiliates {
...ReleaseAffiliateConnectionFragment
}
airdropCount
animatedCoverImage {
...MediaFragment
}
animatedGoldenEggImageOptimized {
...MediaFragment
}
artist {
...ArtistFragment
}
auctionContractType
auctionType
baseMetadataAttributes {
...MetadataAttributeFragment
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
...ReleaseCollectorConnectionFragment
}
collectorsCount
contract {
...ContractFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
creditSplit {
...CreditSplitFragment
}
credits {
...UserFragment
}
draftId
earliestCollector {
...ReleaseCollectorFragment
}
editionId
eggGame {
...EggGameFragment
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
...MediaFragment
}
gaCoverImage {
...MediaFragment
}
genre {
...GenreFragment
}
goldenEggImage {
...MediaFragment
}
goldenEggNft {
...NftFragment
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
...ReleaseCollectorFragment
}
likedBy {
...UserConnectionFragment
}
listeningParty
listing {
...AuctionListingInterfaceFragment
}
marketPlaceUrl
metadataDetails {
...MetadataDetailsFragment
}
mintStartTime
mintStartTimestamp
nftsPaginated {
...NftConnectionFragment
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
...RewardFragment
}
royaltyBps
saleDetails {
...SaleDetailsFragment
}
saleSchedules {
...SaleScheduleFragment
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
...SamConfigFragment
}
samSellBufferBpsOverride
scheduleIds {
...ScheduleIdentifierFragment
}
season
shelves {
...ShelfConnectionFragment
}
socialProofCollectors {
...UserFragment
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
...MediaFragment
}
staticGaCoverImage {
...MediaFragment
}
staticVipCoverImage {
...MediaFragment
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
...TopReleaseCollectorFragment
}
topPosts {
...PostFragment
}
topSpentCollector {
...ReleaseCollectorFragment
}
totalMinted
totalSupply
track {
...TrackFragment
}
type
vipAnimatedCoverImage {
...MediaFragment
}
vipCoverImage {
...MediaFragment
}
webEmbed
webappUri
}
releases {
activityFeed {
...ReleaseActionConnectionFragment
}
affiliates {
...ReleaseAffiliateConnectionFragment
}
airdropCount
animatedCoverImage {
...MediaFragment
}
animatedGoldenEggImageOptimized {
...MediaFragment
}
artist {
...ArtistFragment
}
auctionContractType
auctionType
baseMetadataAttributes {
...MetadataAttributeFragment
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
...ReleaseCollectorConnectionFragment
}
collectorsCount
contract {
...ContractFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
creditSplit {
...CreditSplitFragment
}
credits {
...UserFragment
}
draftId
earliestCollector {
...ReleaseCollectorFragment
}
editionId
eggGame {
...EggGameFragment
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
...MediaFragment
}
gaCoverImage {
...MediaFragment
}
genre {
...GenreFragment
}
goldenEggImage {
...MediaFragment
}
goldenEggNft {
...NftFragment
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
...ReleaseCollectorFragment
}
likedBy {
...UserConnectionFragment
}
listeningParty
listing {
...AuctionListingInterfaceFragment
}
marketPlaceUrl
metadataDetails {
...MetadataDetailsFragment
}
mintStartTime
mintStartTimestamp
nftsPaginated {
...NftConnectionFragment
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
...RewardFragment
}
royaltyBps
saleDetails {
...SaleDetailsFragment
}
saleSchedules {
...SaleScheduleFragment
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
...SamConfigFragment
}
samSellBufferBpsOverride
scheduleIds {
...ScheduleIdentifierFragment
}
season
shelves {
...ShelfConnectionFragment
}
socialProofCollectors {
...UserFragment
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
...MediaFragment
}
staticGaCoverImage {
...MediaFragment
}
staticVipCoverImage {
...MediaFragment
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
...TopReleaseCollectorFragment
}
topPosts {
...PostFragment
}
topSpentCollector {
...ReleaseCollectorFragment
}
totalMinted
totalSupply
track {
...TrackFragment
}
type
vipAnimatedCoverImage {
...MediaFragment
}
vipCoverImage {
...MediaFragment
}
webEmbed
webappUri
}
splitAddress
}
}
Variables
{
"id": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"creditSplit": {
"creditAllocations": [CreditAllocation],
"id": "4",
"mintedReleases": [Release],
"releases": [Release],
"splitAddress": "abc123"
}
}
}
cummulativeAffiliateEarned
Description
[AUTHENTICATED] Total eth in wei earned by the authenticated user on affiliate fees
Response
Returns a
String!
Example
Query
query CummulativeAffiliateEarned {
cummulativeAffiliateEarned
}
Response
{
"data": {
"cummulativeAffiliateEarned": "xyz789"
}
}
currencies
Description
[PUBLIC] Get currencies conversions
Response
Returns a
Currencies!
Example
Query
query Currencies {
currencies {
ethToUsd
}
}
Response
{"data": {"currencies": {"ethToUsd": 987.65}}}
currentPlaylistChart
Description
Get current release chart
Response
Returns a
PlaylistChart!
Example
Query
query CurrentPlaylistChart {
currentPlaylistChart {
chartRanks {
edges {
...PlaylistChartRankConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
id
lastDayOfChartInclusive
periodEndExclusive
periodStartInclusive
}
}
Response
{
"data": {
"currentPlaylistChart": {
"chartRanks": PlaylistChartRankConnection,
"id": "4",
"lastDayOfChartInclusive": "2007-12-03T10:15:30Z",
"periodEndExclusive": "2007-12-03T10:15:30Z",
"periodStartInclusive": "2007-12-03T10:15:30Z"
}
}
}
currentReleaseChart
Description
Get current release chart
Response
Returns a
ReleaseChart!
Example
Query
query CurrentReleaseChart {
currentReleaseChart {
chartRanks {
edges {
...ReleaseChartRankConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
id
lastDayOfChartInclusive
periodEndExclusive
periodStartInclusive
}
}
Response
{
"data": {
"currentReleaseChart": {
"chartRanks": ReleaseChartRankConnection,
"id": "4",
"lastDayOfChartInclusive": "2007-12-03T10:15:30Z",
"periodEndExclusive": "2007-12-03T10:15:30Z",
"periodStartInclusive": "2007-12-03T10:15:30Z"
}
}
}
downloadableTrackURLForAudioReward
Description
[AUTHENTICATED] Owner of NFT can download track's audio
Example
Query
query DownloadableTrackURLForAudioReward($trackId: UUID!) {
downloadableTrackURLForAudioReward(trackId: $trackId)
}
Variables
{
"trackId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"downloadableTrackURLForAudioReward": "xyz789"
}
}
draft
Description
[ARTIST] Get draft of given draft id
Example
Query
query Draft($draftId: UUID!) {
draft(draftId: $draftId) {
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
contractAddressSalt
createdAt
edit {
createdAt
id
info {
...DraftEditInfoFragment
}
updatedAt
}
id
info {
allowListInfo {
...DraftAllowListsInfoFragment
}
auctionConfigurations {
...DraftAuctionConfigurationsInfoFragment
}
numUploadStepsComplete
releaseInfo {
...DraftReleaseInfoFragment
}
rewardsInfo {
...RewardsUploadStepInfoFragment
}
splitsInfo {
...SplitsUploadStepInfoFragment
}
}
release {
activityFeed {
...ReleaseActionConnectionFragment
}
affiliates {
...ReleaseAffiliateConnectionFragment
}
airdropCount
animatedCoverImage {
...MediaFragment
}
animatedGoldenEggImageOptimized {
...MediaFragment
}
artist {
...ArtistFragment
}
auctionContractType
auctionType
baseMetadataAttributes {
...MetadataAttributeFragment
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
...ReleaseCollectorConnectionFragment
}
collectorsCount
contract {
...ContractFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
creditSplit {
...CreditSplitFragment
}
credits {
...UserFragment
}
draftId
earliestCollector {
...ReleaseCollectorFragment
}
editionId
eggGame {
...EggGameFragment
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
...MediaFragment
}
gaCoverImage {
...MediaFragment
}
genre {
...GenreFragment
}
goldenEggImage {
...MediaFragment
}
goldenEggNft {
...NftFragment
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
...ReleaseCollectorFragment
}
likedBy {
...UserConnectionFragment
}
listeningParty
listing {
...AuctionListingInterfaceFragment
}
marketPlaceUrl
metadataDetails {
...MetadataDetailsFragment
}
mintStartTime
mintStartTimestamp
nftsPaginated {
...NftConnectionFragment
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
...RewardFragment
}
royaltyBps
saleDetails {
...SaleDetailsFragment
}
saleSchedules {
...SaleScheduleFragment
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
...SamConfigFragment
}
samSellBufferBpsOverride
scheduleIds {
...ScheduleIdentifierFragment
}
season
shelves {
...ShelfConnectionFragment
}
socialProofCollectors {
...UserFragment
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
...MediaFragment
}
staticGaCoverImage {
...MediaFragment
}
staticVipCoverImage {
...MediaFragment
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
...TopReleaseCollectorFragment
}
topPosts {
...PostFragment
}
topSpentCollector {
...ReleaseCollectorFragment
}
totalMinted
totalSupply
track {
...TrackFragment
}
type
vipAnimatedCoverImage {
...MediaFragment
}
vipCoverImage {
...MediaFragment
}
webEmbed
webappUri
}
slug
type
updatedAt
}
}
Variables
{
"draftId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"draft": {
"artist": Artist,
"contractAddressSalt": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"edit": DraftEdit,
"id": "4",
"info": DraftInfo,
"release": Release,
"slug": "xyz789",
"type": "ALBUM",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
draftAllowList
Description
[ARTIST] Get allowlist of given draftId, sale type, and allowlist type
Response
Returns an
AllowList
Arguments
| Name | Description |
|---|---|
input -
DraftAllowlistInput!
|
Draft allowlist input arguments |
Example
Query
query DraftAllowList($input: DraftAllowlistInput!) {
draftAllowList(input: $input) {
createdAt
id
totalUsers
users {
edges {
...UserConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
}
}
Variables
{"input": DraftAllowlistInput}
Response
{
"data": {
"draftAllowList": {
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"totalUsers": 123,
"users": UserConnection
}
}
}
draftAllowlistFromDraft
Description
[ARTIST] Get DraftAllowList from draft and mintType
Response
Returns a
DraftAllowList
Arguments
| Name | Description |
|---|---|
input -
DraftAllowlistFromDraftInput!
|
DraftAllowlistFromDraft input fields |
Example
Query
query DraftAllowlistFromDraft($input: DraftAllowlistFromDraftInput!) {
draftAllowlistFromDraft(input: $input) {
createdAt
id
info
totalUsers
}
}
Variables
{"input": DraftAllowlistFromDraftInput}
Response
{
"data": {
"draftAllowlistFromDraft": {
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"info": ArtistCollectorsAllowlist,
"totalUsers": 123
}
}
}
draftAllowlistFromRelease
Description
[PUBLIC] Get DraftAllowList from release and mintType
Response
Returns a
DraftAllowList
Arguments
| Name | Description |
|---|---|
input -
DraftAllowlistFromReleaseInput!
|
DraftAllowlistFromRelease input fields |
Example
Query
query DraftAllowlistFromRelease($input: DraftAllowlistFromReleaseInput!) {
draftAllowlistFromRelease(input: $input) {
createdAt
id
info
totalUsers
}
}
Variables
{"input": DraftAllowlistFromReleaseInput}
Response
{
"data": {
"draftAllowlistFromRelease": {
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"info": ArtistCollectorsAllowlist,
"totalUsers": 123
}
}
}
editReleaseAsyncStatus
Description
[ARTIST | ADMIN] Check status of async edit release
Response
Returns a
QueryEditReleaseAsyncStatusResult!
Arguments
| Name | Description |
|---|---|
editReleaseAsyncRequestId -
UUID!
|
Async request ID |
Example
Query
query EditReleaseAsyncStatus($editReleaseAsyncRequestId: UUID!) {
editReleaseAsyncStatus(editReleaseAsyncRequestId: $editReleaseAsyncRequestId)
}
Variables
{
"editReleaseAsyncRequestId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{"data": {"editReleaseAsyncStatus": DuplicatedError}}
editionOwnedTokenIds
Description
Return list of tokenIds owned by user public address
Response
Returns
[String!]!
Arguments
| Name | Description |
|---|---|
input -
EditionOwnedTokenIdsInput!
|
Parameters of editionOwnedTokenIds query |
Example
Query
query EditionOwnedTokenIds($input: EditionOwnedTokenIdsInput!) {
editionOwnedTokenIds(input: $input)
}
Variables
{"input": EditionOwnedTokenIdsInput}
Response
{
"data": {
"editionOwnedTokenIds": ["abc123"]
}
}
eggGame
Description
[PUBLIC] Get EggGame of specified release
Example
Query
query EggGame($releaseId: UUID!) {
eggGame(releaseId: $releaseId) {
animatedGoldenEggImageOptimized {
bucket
dominantColor
id
key
url
}
finalSerialBlockHash
goldenEggImage {
bucket
dominantColor
id
key
url
}
id
nft {
audioUrl
collectorRelease {
...ReleaseCollectorFragment
}
comment {
...CommentFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
createdAtBlockTime
id
isBurned
isGoldenEgg
openSeaMetadataAttributes {
...OpenSeaMetadataAttributeFragment
}
owner {
...UserFragment
}
release {
...ReleaseFragment
}
serialNumber
songSlot
tierNumber
title
tokenId
updatedAt
}
}
}
Variables
{
"releaseId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"eggGame": {
"animatedGoldenEggImageOptimized": Media,
"finalSerialBlockHash": "abc123",
"goldenEggImage": Media,
"id": "4",
"nft": Nft
}
}
}
featureFlag
Description
[PUBLIC] Get feature flag value by name
Response
Returns a
FeatureFlag
Arguments
| Name | Description |
|---|---|
name -
String!
|
Feature flag name |
Example
Query
query FeatureFlag($name: String!) {
featureFlag(name: $name) {
createdAt
id
name
updatedAt
value
}
}
Variables
{"name": "xyz789"}
Response
{
"data": {
"featureFlag": {
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"name": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"value": "abc123"
}
}
}
followedByUsersInUserNotification
Description
[AUTHENTICATED] New followers of user by notification group
Response
Returns a
UserRelationConnection!
Arguments
| Name | Description |
|---|---|
pagination -
CursorConnectionArgs!
|
Pagination parameters. Default = {first: 10, sort: DESC} |
userNotificationId -
UUID!
|
NewFollower UserNotification ID |
Example
Query
query FollowedByUsersInUserNotification(
$pagination: CursorConnectionArgs!,
$userNotificationId: UUID!
) {
followedByUsersInUserNotification(
pagination: $pagination,
userNotificationId: $userNotificationId
) {
edges {
cursor
node {
...UserRelationFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"pagination": {"first": 10, "sort": "DESC"},
"userNotificationId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"followedByUsersInUserNotification": {
"edges": [UserRelationConnectionEdge],
"pageInfo": PageInfo
}
}
}
getUserPersistedData
Description
[AUTHENTICATED] Get persisted custom data for authenticated user
Response
Returns a
JSON!
Example
Query
query GetUserPersistedData {
getUserPersistedData
}
Response
{"data": {"getUserPersistedData": {}}}
highlightedReleases
Description
[PUBLIC] Get the top 5 highlighted releases
Response
Returns
[Release!]!
Example
Query
query HighlightedReleases {
highlightedReleases {
activityFeed {
edges {
...ReleaseActionConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
affiliates {
edges {
...ReleaseAffiliateConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
airdropCount
animatedCoverImage {
bucket
dominantColor
id
key
url
}
animatedGoldenEggImageOptimized {
bucket
dominantColor
id
key
url
}
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
auctionContractType
auctionType
baseMetadataAttributes {
traitType
value
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
edges {
...ReleaseCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
collectorsCount
contract {
contractAddress
contractType
createdAt
id
owner {
...UserFragment
}
ownerPublicAddress
updatedAt
}
contractAddress
coverImage {
bucket
dominantColor
id
key
url
}
createdAt
creditSplit {
creditAllocations {
...CreditAllocationFragment
}
id
mintedReleases {
...ReleaseFragment
}
releases {
...ReleaseFragment
}
splitAddress
}
credits {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
draftId
earliestCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
editionId
eggGame {
animatedGoldenEggImageOptimized {
...MediaFragment
}
finalSerialBlockHash
goldenEggImage {
...MediaFragment
}
id
nft {
...NftFragment
}
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
bucket
dominantColor
id
key
url
}
gaCoverImage {
bucket
dominantColor
id
key
url
}
genre {
createdAt
id
name
updatedAt
}
goldenEggImage {
bucket
dominantColor
id
key
url
}
goldenEggNft {
audioUrl
collectorRelease {
...ReleaseCollectorFragment
}
comment {
...CommentFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
createdAtBlockTime
id
isBurned
isGoldenEgg
openSeaMetadataAttributes {
...OpenSeaMetadataAttributeFragment
}
owner {
...UserFragment
}
release {
...ReleaseFragment
}
serialNumber
songSlot
tierNumber
title
tokenId
updatedAt
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
likedBy {
edges {
...UserConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
listeningParty
listing {
chain
contractAddress
id
}
marketPlaceUrl
metadataDetails {
bpm
key
license
location
lyrics
}
mintStartTime
mintStartTimestamp
nftsPaginated {
edges {
...NftConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
description
id
title
}
royaltyBps
saleDetails {
primaryCollected
primaryRaisedInWei
soundSwapCollected
soundSwapRaisedInWei
totalVolume
}
saleSchedules {
affiliateFeeBPS
affiliateFeePercent
artistContractTotalMinted
endTime
id
isPresale
maxMintable
merkleTreeRoot
mintId
minterAddress
price
startTime
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
affiliateFeeBPS
affiliateFeePercent
artistFeeBPS
artistFeePercent
basePrice
buyFreezeTime
goldenEggFeeBPS
goldenEggFeePercent
id
inflectionPoint
inflectionPrice
maxSupply
platformFeeBPS
platformPerTxFlatFee
samAddress
}
samSellBufferBpsOverride
scheduleIds {
mintIds
minterAddress
}
season
shelves {
edges {
...ShelfConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
socialProofCollectors {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
bucket
dominantColor
id
key
url
}
staticGaCoverImage {
bucket
dominantColor
id
key
url
}
staticVipCoverImage {
bucket
dominantColor
id
key
url
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
firstNftCollectedDate
lowestNftSerialNumber
nftsCount
position
user {
...UserFragment
}
}
topPosts {
authorChannelRole
channel {
...ChannelFragment
}
commentCount
comments {
...PostCommentConnectionFragment
}
content
createdAt
creator {
...UserFragment
}
farcasterHash
id
lexicalContent
repostCount
upvoteCount
webappUri
}
topSpentCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
totalMinted
totalSupply
track {
audio {
...AudioMediaFragment
}
audioOriginal {
...MediaFragment
}
duration
id
normalizedPeaks
release {
...ReleaseFragment
}
releaseId
title
trackNumber
}
type
vipAnimatedCoverImage {
bucket
dominantColor
id
key
url
}
vipCoverImage {
bucket
dominantColor
id
key
url
}
webEmbed
webappUri
}
}
Response
{
"data": {
"highlightedReleases": [
{
"activityFeed": ReleaseActionConnection,
"affiliates": ReleaseAffiliateConnection,
"airdropCount": 987,
"animatedCoverImage": Media,
"animatedGoldenEggImageOptimized": Media,
"artist": Artist,
"auctionContractType": "ARTIST",
"auctionType": "FIXED_QUANTITY",
"baseMetadataAttributes": [MetadataAttribute],
"behindTheMusic": "abc123",
"canCollectorsDownloadAudio": true,
"chainId": 123,
"collectors": ReleaseCollectorConnection,
"collectorsCount": 123,
"contract": Contract,
"contractAddress": "xyz789",
"coverImage": Media,
"createdAt": "2007-12-03T10:15:30Z",
"creditSplit": CreditSplit,
"credits": [User],
"draftId": "xyz789",
"earliestCollector": ReleaseCollector,
"editionId": "xyz789",
"eggGame": EggGame,
"externalUrl": "abc123",
"finalQuantity": 123,
"fundingAddress": "abc123",
"gaAnimatedCoverImage": Media,
"gaCoverImage": Media,
"genre": Genre,
"goldenEggImage": Media,
"goldenEggNft": Nft,
"id": "4",
"isAuctionSoldOut": false,
"isFirstPhaseCompleted": true,
"lastUpdatedAt": "2007-12-03T10:15:30Z",
"latestCollector": ReleaseCollector,
"likedBy": UserConnection,
"listeningParty": 1592577642,
"listing": AuctionListingInterface,
"marketPlaceUrl": "xyz789",
"metadataDetails": MetadataDetails,
"mintStartTime": 123,
"mintStartTimestamp": 1592577642,
"nftsPaginated": NftConnection,
"numSold": 987,
"openseaUrl": "abc123",
"postCount": 123,
"price": "abc123",
"publicAffiliateFeeBPS": 123,
"publicAffiliateFeePercent": "abc123",
"publicMintStart": "2007-12-03T10:15:30Z",
"quantity": 987,
"quantityLowerBound": 123,
"quantityUpperBound": 123,
"rewards": [Reward],
"royaltyBps": 123,
"saleDetails": SaleDetails,
"saleSchedules": [SaleSchedule],
"salesAffiliateFeesPercent": [
"abc123"
],
"samAddress": "xyz789",
"samBuyBufferBpsOverride": 987,
"samConfig": SamConfig,
"samSellBufferBpsOverride": 987,
"scheduleIds": [ScheduleIdentifier],
"season": "abc123",
"shelves": ShelfConnection,
"socialProofCollectors": [User],
"spotifyPresaveCampaign": false,
"spotifyPresaveCount": 123,
"spotifyTrackId": "xyz789",
"staticCoverImage": Media,
"staticGaCoverImage": Media,
"staticVipCoverImage": Media,
"supplyCutoffTimestamp": 1592577642,
"title": "abc123",
"titleSlug": "abc123",
"topCollectors": [TopReleaseCollector],
"topPosts": [Post],
"topSpentCollector": ReleaseCollector,
"totalMinted": 123,
"totalSupply": 123,
"track": Track,
"type": "ALBUM",
"vipAnimatedCoverImage": Media,
"vipCoverImage": Media,
"webEmbed": "abc123",
"webappUri": "xyz789"
}
]
}
}
highlightedReleasesParameters
Description
[ADMIN | ARTIST_RELATIONS] Highlighted Releases parameters
Response
Example
Query
query HighlightedReleasesParameters {
highlightedReleasesParameters
}
Response
{
"data": {
"highlightedReleasesParameters": NotAuthorizedError
}
}
homeFeed
Description
[PUBLIC] Fetch posts for the home for you feed
Response
Returns a
HomeFeedPostConnection!
Arguments
| Name | Description |
|---|---|
pagination -
HomeFeedCursorConnectionArgs!
|
Default = {after: null, first: 50} |
Example
Query
query HomeFeed($pagination: HomeFeedCursorConnectionArgs!) {
homeFeed(pagination: $pagination) {
edges {
cursor
node {
...HomeFeedItemFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
totalCount
}
}
Variables
{"pagination": {"after": "null", "first": 50}}
Response
{
"data": {
"homeFeed": {
"edges": [HomeFeedPostConnectionEdge],
"pageInfo": PageInfo,
"totalCount": 987
}
}
}
isChannelCurator
Description
[AUTHENTICATED] Checks if the current user is a curator of the channels
Response
Returns
[IsChannelCuratorResult!]!
Arguments
| Name | Description |
|---|---|
input -
QueryIsChannelCuratorInput!
|
Example
Query
query IsChannelCurator($input: QueryIsChannelCuratorInput!) {
isChannelCurator(input: $input) {
channelId
result
role
}
}
Variables
{"input": QueryIsChannelCuratorInput}
Response
{
"data": {
"isChannelCurator": [
{
"channelId": "abc123",
"result": true,
"role": "MODERATOR"
}
]
}
}
isChannelMember
Description
[AUTHENTICATED] Checks if the current user is a member of the channels
Response
Returns
[ChannelResult!]!
Arguments
| Name | Description |
|---|---|
input -
QueryIsChannelMemberInput!
|
Example
Query
query IsChannelMember($input: QueryIsChannelMemberInput!) {
isChannelMember(input: $input) {
channelId
result
}
}
Variables
{"input": QueryIsChannelMemberInput}
Response
{
"data": {
"isChannelMember": [
{
"channelId": "abc123",
"result": false
}
]
}
}
isFollowing
Description
[AUTHENTICATED] Returns whether auth user is following input userId
Response
Returns a
Boolean!
Arguments
| Name | Description |
|---|---|
input -
IsFollowingInput!
|
isFollowing inputs |
Example
Query
query IsFollowing($input: IsFollowingInput!) {
isFollowing(input: $input)
}
Variables
{"input": IsFollowingInput}
Response
{"data": {"isFollowing": true}}
isLiked
Description
[AUTHENTICATED] Returns whether an entity is liked by the user or not.
Response
Returns a
Boolean!
Arguments
| Name | Description |
|---|---|
input -
IsLikedInput!
|
isLiked inputs |
Example
Query
query IsLiked($input: IsLikedInput!) {
isLiked(input: $input)
}
Variables
{"input": IsLikedInput}
Response
{"data": {"isLiked": false}}
isSoundHandleAvailable
Description
[AUTHENTICATED] Checks if soundHandle is available to be claimed.
Response
Returns a
Boolean!
Arguments
| Name | Description |
|---|---|
soundHandle -
String!
|
Sound handle to be checked |
Example
Query
query IsSoundHandleAvailable($soundHandle: String!) {
isSoundHandleAvailable(soundHandle: $soundHandle)
}
Variables
{"soundHandle": "xyz789"}
Response
{"data": {"isSoundHandleAvailable": false}}
keyClients
Description
[ADMIN] Get all the existing Key Clients
Response
Returns a
KeyClientConnection!
Arguments
| Name | Description |
|---|---|
filter -
FilterKeyClients
|
Filter paginated results |
pagination -
KeyClientCursorConnectionArgs!
|
Pagination parameters. Default = {after: null, first: 20, sort: ASC} |
Example
Query
query KeyClients(
$filter: FilterKeyClients,
$pagination: KeyClientCursorConnectionArgs!
) {
keyClients(
filter: $filter,
pagination: $pagination
) {
edges {
cursor
node {
...KeyClientFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"filter": FilterKeyClients,
"pagination": {"after": "null", "first": 20, "sort": "ASC"}
}
Response
{
"data": {
"keyClients": {
"edges": [KeyClientConnectionEdge],
"pageInfo": PageInfo
}
}
}
legacyPlaylist
Description
[PUBLIC] Get playlist based on given type and associationId
Response
Returns a
Playlist
Arguments
| Name | Description |
|---|---|
input -
PlaylistInput!
|
Input for playlist query |
Example
Query
query LegacyPlaylist($input: PlaylistInput!) {
legacyPlaylist(input: $input) {
id
tracks {
artistId
id
releaseId
}
}
}
Variables
{"input": PlaylistInput}
Response
{
"data": {
"legacyPlaylist": {"id": 4, "tracks": [PlaylistTrack]}
}
}
likeActivityFeed
Description
[PUBLIC] User like and unlike activity feed
Response
Returns a
LikeActionConnection!
Arguments
| Name | Description |
|---|---|
pagination -
CursorConnectionArgs!
|
Pagination parameters. Default = {first: 10, sort: DESC} |
userId -
UUID!
|
User ID |
Example
Query
query LikeActivityFeed(
$pagination: CursorConnectionArgs!,
$userId: UUID!
) {
likeActivityFeed(
pagination: $pagination,
userId: $userId
) {
edges {
cursor
node {
...LikeActionFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"pagination": {"first": 10, "sort": "DESC"},
"userId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"likeActivityFeed": {
"edges": [LikeActionConnectionEdge],
"pageInfo": PageInfo
}
}
}
likeStatuses
Description
[AUTHENTICATED] Returns authUser's like status for entities up to a maximum of 51
Response
Returns
[LikeStatus!]!
Arguments
| Name | Description |
|---|---|
input -
[IsLikedInput!]!
|
isLiked inputs |
Example
Query
query LikeStatuses($input: [IsLikedInput!]!) {
likeStatuses(input: $input) {
entityId
isLiked
userId
}
}
Variables
{"input": [IsLikedInput]}
Response
{
"data": {
"likeStatuses": [
{
"entityId": "abc123",
"isLiked": true,
"userId": "abc123"
}
]
}
}
link
Description
[PUBLIC] Get a node based on specific slug
Response
Returns a
Node
Arguments
| Name | Description |
|---|---|
input -
LinkInput!
|
Specify parameters for link query |
Example
Query
query Link($input: LinkInput!) {
link(input: $input) {
id
}
}
Variables
{"input": LinkInput}
Response
{"data": {"link": {"id": 4}}}
merkleTreeCSVUrl
Description
[PUBLIC] Allowlisted addresses from merkle tree csv url
merkleTreeFromRoot
Description
[PUBLIC] Get merkle tree information
Response
Returns a
MerkleTree
Arguments
| Name | Description |
|---|---|
root -
String!
|
Merkle tree root input |
Example
Query
query MerkleTreeFromRoot($root: String!) {
merkleTreeFromRoot(root: $root) {
createdAt
id
leafCount
root
unhashedLeaves
}
}
Variables
{"root": "xyz789"}
Response
{
"data": {
"merkleTreeFromRoot": {
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"leafCount": 987,
"root": "abc123",
"unhashedLeaves": ["xyz789"]
}
}
}
merkleTreeProof
Description
[PUBLIC] Get merkle tree information
Response
Returns a
MerkleTreeProof
Example
Query
query MerkleTreeProof(
$root: String!,
$unhashedLeaf: String!
) {
merkleTreeProof(
root: $root,
unhashedLeaf: $unhashedLeaf
) {
proof
unhashedLeaf
}
}
Variables
{
"root": "abc123",
"unhashedLeaf": "abc123"
}
Response
{
"data": {
"merkleTreeProof": {
"proof": ["xyz789"],
"unhashedLeaf": "abc123"
}
}
}
mintedByUsersInUserNotification
Description
[AUTHENTICATED] Mints by users in notification group
Response
Returns a
ReleaseCollectorConnection!
Arguments
| Name | Description |
|---|---|
pagination -
ReleaseCollectorCursorConnectionArgs!
|
Pagination parameters. Default = {after: null, first: 10, sort: {nftsCount: DESC}} |
userNotificationId -
UUID!
|
ReleaseMinted UserNotification ID |
Example
Query
query MintedByUsersInUserNotification(
$pagination: ReleaseCollectorCursorConnectionArgs!,
$userNotificationId: UUID!
) {
mintedByUsersInUserNotification(
pagination: $pagination,
userNotificationId: $userNotificationId
) {
edges {
cursor
node {
...ReleaseCollectorFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"pagination": {"after": "null", "first": 10, "sort": {"nftsCount": "DESC"}},
"userNotificationId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"mintedByUsersInUserNotification": {
"edges": [ReleaseCollectorConnectionEdge],
"pageInfo": PageInfo
}
}
}
mintedRelease
Description
[PUBLIC] Get minted release by Artist sound handle and release title slug
Response
Returns a
Release
Example
Query
query MintedRelease(
$releaseSlug: String!,
$soundHandle: String!
) {
mintedRelease(
releaseSlug: $releaseSlug,
soundHandle: $soundHandle
) {
activityFeed {
edges {
...ReleaseActionConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
affiliates {
edges {
...ReleaseAffiliateConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
airdropCount
animatedCoverImage {
bucket
dominantColor
id
key
url
}
animatedGoldenEggImageOptimized {
bucket
dominantColor
id
key
url
}
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
auctionContractType
auctionType
baseMetadataAttributes {
traitType
value
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
edges {
...ReleaseCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
collectorsCount
contract {
contractAddress
contractType
createdAt
id
owner {
...UserFragment
}
ownerPublicAddress
updatedAt
}
contractAddress
coverImage {
bucket
dominantColor
id
key
url
}
createdAt
creditSplit {
creditAllocations {
...CreditAllocationFragment
}
id
mintedReleases {
...ReleaseFragment
}
releases {
...ReleaseFragment
}
splitAddress
}
credits {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
draftId
earliestCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
editionId
eggGame {
animatedGoldenEggImageOptimized {
...MediaFragment
}
finalSerialBlockHash
goldenEggImage {
...MediaFragment
}
id
nft {
...NftFragment
}
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
bucket
dominantColor
id
key
url
}
gaCoverImage {
bucket
dominantColor
id
key
url
}
genre {
createdAt
id
name
updatedAt
}
goldenEggImage {
bucket
dominantColor
id
key
url
}
goldenEggNft {
audioUrl
collectorRelease {
...ReleaseCollectorFragment
}
comment {
...CommentFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
createdAtBlockTime
id
isBurned
isGoldenEgg
openSeaMetadataAttributes {
...OpenSeaMetadataAttributeFragment
}
owner {
...UserFragment
}
release {
...ReleaseFragment
}
serialNumber
songSlot
tierNumber
title
tokenId
updatedAt
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
likedBy {
edges {
...UserConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
listeningParty
listing {
chain
contractAddress
id
}
marketPlaceUrl
metadataDetails {
bpm
key
license
location
lyrics
}
mintStartTime
mintStartTimestamp
nftsPaginated {
edges {
...NftConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
description
id
title
}
royaltyBps
saleDetails {
primaryCollected
primaryRaisedInWei
soundSwapCollected
soundSwapRaisedInWei
totalVolume
}
saleSchedules {
affiliateFeeBPS
affiliateFeePercent
artistContractTotalMinted
endTime
id
isPresale
maxMintable
merkleTreeRoot
mintId
minterAddress
price
startTime
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
affiliateFeeBPS
affiliateFeePercent
artistFeeBPS
artistFeePercent
basePrice
buyFreezeTime
goldenEggFeeBPS
goldenEggFeePercent
id
inflectionPoint
inflectionPrice
maxSupply
platformFeeBPS
platformPerTxFlatFee
samAddress
}
samSellBufferBpsOverride
scheduleIds {
mintIds
minterAddress
}
season
shelves {
edges {
...ShelfConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
socialProofCollectors {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
bucket
dominantColor
id
key
url
}
staticGaCoverImage {
bucket
dominantColor
id
key
url
}
staticVipCoverImage {
bucket
dominantColor
id
key
url
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
firstNftCollectedDate
lowestNftSerialNumber
nftsCount
position
user {
...UserFragment
}
}
topPosts {
authorChannelRole
channel {
...ChannelFragment
}
commentCount
comments {
...PostCommentConnectionFragment
}
content
createdAt
creator {
...UserFragment
}
farcasterHash
id
lexicalContent
repostCount
upvoteCount
webappUri
}
topSpentCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
totalMinted
totalSupply
track {
audio {
...AudioMediaFragment
}
audioOriginal {
...MediaFragment
}
duration
id
normalizedPeaks
release {
...ReleaseFragment
}
releaseId
title
trackNumber
}
type
vipAnimatedCoverImage {
bucket
dominantColor
id
key
url
}
vipCoverImage {
bucket
dominantColor
id
key
url
}
webEmbed
webappUri
}
}
Variables
{
"releaseSlug": "abc123",
"soundHandle": "abc123"
}
Response
{
"data": {
"mintedRelease": {
"activityFeed": ReleaseActionConnection,
"affiliates": ReleaseAffiliateConnection,
"airdropCount": 123,
"animatedCoverImage": Media,
"animatedGoldenEggImageOptimized": Media,
"artist": Artist,
"auctionContractType": "ARTIST",
"auctionType": "FIXED_QUANTITY",
"baseMetadataAttributes": [MetadataAttribute],
"behindTheMusic": "xyz789",
"canCollectorsDownloadAudio": false,
"chainId": 123,
"collectors": ReleaseCollectorConnection,
"collectorsCount": 987,
"contract": Contract,
"contractAddress": "abc123",
"coverImage": Media,
"createdAt": "2007-12-03T10:15:30Z",
"creditSplit": CreditSplit,
"credits": [User],
"draftId": "xyz789",
"earliestCollector": ReleaseCollector,
"editionId": "abc123",
"eggGame": EggGame,
"externalUrl": "abc123",
"finalQuantity": 123,
"fundingAddress": "abc123",
"gaAnimatedCoverImage": Media,
"gaCoverImage": Media,
"genre": Genre,
"goldenEggImage": Media,
"goldenEggNft": Nft,
"id": 4,
"isAuctionSoldOut": true,
"isFirstPhaseCompleted": true,
"lastUpdatedAt": "2007-12-03T10:15:30Z",
"latestCollector": ReleaseCollector,
"likedBy": UserConnection,
"listeningParty": 1592577642,
"listing": AuctionListingInterface,
"marketPlaceUrl": "xyz789",
"metadataDetails": MetadataDetails,
"mintStartTime": 123,
"mintStartTimestamp": 1592577642,
"nftsPaginated": NftConnection,
"numSold": 987,
"openseaUrl": "abc123",
"postCount": 987,
"price": "xyz789",
"publicAffiliateFeeBPS": 987,
"publicAffiliateFeePercent": "abc123",
"publicMintStart": "2007-12-03T10:15:30Z",
"quantity": 123,
"quantityLowerBound": 987,
"quantityUpperBound": 123,
"rewards": [Reward],
"royaltyBps": 123,
"saleDetails": SaleDetails,
"saleSchedules": [SaleSchedule],
"salesAffiliateFeesPercent": [
"xyz789"
],
"samAddress": "xyz789",
"samBuyBufferBpsOverride": 123,
"samConfig": SamConfig,
"samSellBufferBpsOverride": 987,
"scheduleIds": [ScheduleIdentifier],
"season": "abc123",
"shelves": ShelfConnection,
"socialProofCollectors": [User],
"spotifyPresaveCampaign": true,
"spotifyPresaveCount": 123,
"spotifyTrackId": "xyz789",
"staticCoverImage": Media,
"staticGaCoverImage": Media,
"staticVipCoverImage": Media,
"supplyCutoffTimestamp": 1592577642,
"title": "abc123",
"titleSlug": "xyz789",
"topCollectors": [TopReleaseCollector],
"topPosts": [Post],
"topSpentCollector": ReleaseCollector,
"totalMinted": 987,
"totalSupply": 987,
"track": Track,
"type": "ALBUM",
"vipAnimatedCoverImage": Media,
"vipCoverImage": Media,
"webEmbed": "xyz789",
"webappUri": "abc123"
}
}
}
multiSelectArtists
Description
[ARTIST] Get artists by ids for multiselect
Response
Returns
[ArtistInfo!]!
Arguments
| Name | Description |
|---|---|
ids -
[UUID!]!
|
Artist identifiers |
Example
Query
query MultiSelectArtists($ids: [UUID!]!) {
multiSelectArtists(ids: $ids) {
avatar {
bucket
dominantColor
id
key
url
}
id
name
publicAddress
}
}
Variables
{
"ids": [
"6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
]
}
Response
{
"data": {
"multiSelectArtists": [
{
"avatar": Media,
"id": 4,
"name": "abc123",
"publicAddress": "xyz789"
}
]
}
}
multiSelectReleases
Description
[ARTIST] Get releases by releaseIds for multiselect
Response
Returns
[ReleaseInfo!]!
Arguments
| Name | Description |
|---|---|
ids -
[UUID!]!
|
List of release identifiers |
Example
Query
query MultiSelectReleases($ids: [UUID!]!) {
multiSelectReleases(ids: $ids) {
artistId
artistName
artistUserId
coverImage {
bucket
dominantColor
id
key
url
}
creditUserIds
id
staticCoverImage {
bucket
dominantColor
id
key
url
}
title
}
}
Variables
{
"ids": [
"6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
]
}
Response
{
"data": {
"multiSelectReleases": [
{
"artistId": "xyz789",
"artistName": "xyz789",
"artistUserId": "abc123",
"coverImage": Media,
"creditUserIds": ["abc123"],
"id": 4,
"staticCoverImage": Media,
"title": "xyz789"
}
]
}
}
newChannelMembersInUserNotification
Description
[AUTHENTICATED] New channel members by notification group
Response
Returns a
UserConnection!
Arguments
| Name | Description |
|---|---|
pagination -
UserCursorConnectionArgs!
|
Pagination parameters. Default = {after: null, first: 20, sort: ASC} |
userNotificationId -
UUID!
|
NewChannelMember UserNotification ID |
Example
Query
query NewChannelMembersInUserNotification(
$pagination: UserCursorConnectionArgs!,
$userNotificationId: UUID!
) {
newChannelMembersInUserNotification(
pagination: $pagination,
userNotificationId: $userNotificationId
) {
edges {
cursor
node {
...UserFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"pagination": {"after": "null", "first": 20, "sort": "ASC"},
"userNotificationId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"newChannelMembersInUserNotification": {
"edges": [UserConnectionEdge],
"pageInfo": PageInfo
}
}
}
nft
Description
[PUBLIC] Request nft with contract fields
Response
Returns a
Nft!
Arguments
| Name | Description |
|---|---|
input -
NftInput!
|
Input to get Nft based on contract fields |
Example
Query
query Nft($input: NftInput!) {
nft(input: $input) {
audioUrl
collectorRelease {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
comment {
createdAt
id
message
signature
updatedAt
}
contractAddress
coverImage {
bucket
dominantColor
id
key
url
}
createdAt
createdAtBlockTime
id
isBurned
isGoldenEgg
openSeaMetadataAttributes {
traitType
value
}
owner {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
release {
activityFeed {
...ReleaseActionConnectionFragment
}
affiliates {
...ReleaseAffiliateConnectionFragment
}
airdropCount
animatedCoverImage {
...MediaFragment
}
animatedGoldenEggImageOptimized {
...MediaFragment
}
artist {
...ArtistFragment
}
auctionContractType
auctionType
baseMetadataAttributes {
...MetadataAttributeFragment
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
...ReleaseCollectorConnectionFragment
}
collectorsCount
contract {
...ContractFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
creditSplit {
...CreditSplitFragment
}
credits {
...UserFragment
}
draftId
earliestCollector {
...ReleaseCollectorFragment
}
editionId
eggGame {
...EggGameFragment
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
...MediaFragment
}
gaCoverImage {
...MediaFragment
}
genre {
...GenreFragment
}
goldenEggImage {
...MediaFragment
}
goldenEggNft {
...NftFragment
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
...ReleaseCollectorFragment
}
likedBy {
...UserConnectionFragment
}
listeningParty
listing {
...AuctionListingInterfaceFragment
}
marketPlaceUrl
metadataDetails {
...MetadataDetailsFragment
}
mintStartTime
mintStartTimestamp
nftsPaginated {
...NftConnectionFragment
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
...RewardFragment
}
royaltyBps
saleDetails {
...SaleDetailsFragment
}
saleSchedules {
...SaleScheduleFragment
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
...SamConfigFragment
}
samSellBufferBpsOverride
scheduleIds {
...ScheduleIdentifierFragment
}
season
shelves {
...ShelfConnectionFragment
}
socialProofCollectors {
...UserFragment
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
...MediaFragment
}
staticGaCoverImage {
...MediaFragment
}
staticVipCoverImage {
...MediaFragment
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
...TopReleaseCollectorFragment
}
topPosts {
...PostFragment
}
topSpentCollector {
...ReleaseCollectorFragment
}
totalMinted
totalSupply
track {
...TrackFragment
}
type
vipAnimatedCoverImage {
...MediaFragment
}
vipCoverImage {
...MediaFragment
}
webEmbed
webappUri
}
serialNumber
songSlot
tierNumber
title
tokenId
updatedAt
}
}
Variables
{"input": NftInput}
Response
{
"data": {
"nft": {
"audioUrl": "abc123",
"collectorRelease": ReleaseCollector,
"comment": Comment,
"contractAddress": "abc123",
"coverImage": Media,
"createdAt": "2007-12-03T10:15:30Z",
"createdAtBlockTime": "2007-12-03T10:15:30Z",
"id": "4",
"isBurned": false,
"isGoldenEgg": false,
"openSeaMetadataAttributes": [
OpenSeaMetadataAttribute
],
"owner": User,
"release": Release,
"serialNumber": 123,
"songSlot": 123,
"tierNumber": 123,
"title": "abc123",
"tokenId": 4,
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
nftFromId
Description
[PUBLIC] Request nft from unique sound identifier
Example
Query
query NftFromId($id: UUID!) {
nftFromId(id: $id) {
audioUrl
collectorRelease {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
comment {
createdAt
id
message
signature
updatedAt
}
contractAddress
coverImage {
bucket
dominantColor
id
key
url
}
createdAt
createdAtBlockTime
id
isBurned
isGoldenEgg
openSeaMetadataAttributes {
traitType
value
}
owner {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
release {
activityFeed {
...ReleaseActionConnectionFragment
}
affiliates {
...ReleaseAffiliateConnectionFragment
}
airdropCount
animatedCoverImage {
...MediaFragment
}
animatedGoldenEggImageOptimized {
...MediaFragment
}
artist {
...ArtistFragment
}
auctionContractType
auctionType
baseMetadataAttributes {
...MetadataAttributeFragment
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
...ReleaseCollectorConnectionFragment
}
collectorsCount
contract {
...ContractFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
creditSplit {
...CreditSplitFragment
}
credits {
...UserFragment
}
draftId
earliestCollector {
...ReleaseCollectorFragment
}
editionId
eggGame {
...EggGameFragment
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
...MediaFragment
}
gaCoverImage {
...MediaFragment
}
genre {
...GenreFragment
}
goldenEggImage {
...MediaFragment
}
goldenEggNft {
...NftFragment
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
...ReleaseCollectorFragment
}
likedBy {
...UserConnectionFragment
}
listeningParty
listing {
...AuctionListingInterfaceFragment
}
marketPlaceUrl
metadataDetails {
...MetadataDetailsFragment
}
mintStartTime
mintStartTimestamp
nftsPaginated {
...NftConnectionFragment
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
...RewardFragment
}
royaltyBps
saleDetails {
...SaleDetailsFragment
}
saleSchedules {
...SaleScheduleFragment
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
...SamConfigFragment
}
samSellBufferBpsOverride
scheduleIds {
...ScheduleIdentifierFragment
}
season
shelves {
...ShelfConnectionFragment
}
socialProofCollectors {
...UserFragment
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
...MediaFragment
}
staticGaCoverImage {
...MediaFragment
}
staticVipCoverImage {
...MediaFragment
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
...TopReleaseCollectorFragment
}
topPosts {
...PostFragment
}
topSpentCollector {
...ReleaseCollectorFragment
}
totalMinted
totalSupply
track {
...TrackFragment
}
type
vipAnimatedCoverImage {
...MediaFragment
}
vipCoverImage {
...MediaFragment
}
webEmbed
webappUri
}
serialNumber
songSlot
tierNumber
title
tokenId
updatedAt
}
}
Variables
{
"id": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"nftFromId": {
"audioUrl": "abc123",
"collectorRelease": ReleaseCollector,
"comment": Comment,
"contractAddress": "abc123",
"coverImage": Media,
"createdAt": "2007-12-03T10:15:30Z",
"createdAtBlockTime": "2007-12-03T10:15:30Z",
"id": "4",
"isBurned": true,
"isGoldenEgg": false,
"openSeaMetadataAttributes": [
OpenSeaMetadataAttribute
],
"owner": User,
"release": Release,
"serialNumber": 987,
"songSlot": 123,
"tierNumber": 123,
"title": "xyz789",
"tokenId": 4,
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
notableCollectorsActivityFeed
Description
[PUBLIC] Activity Feed of notable collectors
Response
Returns an
ActivityFeed
Example
Query
query NotableCollectorsActivityFeed {
notableCollectorsActivityFeed {
groups {
edges {
...ActivityFeedGroupConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
id
}
}
Response
{
"data": {
"notableCollectorsActivityFeed": {
"groups": ActivityFeedGroups,
"id": "4"
}
}
}
now
Description
[PUBLIC] Current UNIX date to test caching
Response
Returns an
Int!
Example
Query
query Now {
now
}
Response
{"data": {"now": 123}}
personalizedFollowRecommendations
Description
[AUTHENTICATED] Personalized follow recommendations based on user taste
Response
Returns a
UserConnection
Arguments
| Name | Description |
|---|---|
input -
PersonalizedFollowRecommendationsInput!
|
Pagination parameters. Default = {pagination: {after: null, first: 20, sort: ASC}} |
Example
Query
query PersonalizedFollowRecommendations($input: PersonalizedFollowRecommendationsInput!) {
personalizedFollowRecommendations(input: $input) {
edges {
cursor
node {
...UserFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{"input": {"pagination": {"after": "null", "first": 20, "sort": "ASC"}}}
Response
{
"data": {
"personalizedFollowRecommendations": {
"edges": [UserConnectionEdge],
"pageInfo": PageInfo
}
}
}
personalizedFollowRecommendationsBanner
Description
[AUTHENTICATED] Banner for personalized follow recommendations. Can be dismissed. Once completed, always returns empty results
Response
Returns a
UserFollowRecommendationBatch
Example
Query
query PersonalizedFollowRecommendationsBanner {
personalizedFollowRecommendationsBanner {
type
users {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
}
}
Response
{
"data": {
"personalizedFollowRecommendationsBanner": {
"type": "xyz789",
"users": [User]
}
}
}
playlistAction
Description
PlaylistAction by UUID
Response
Returns a
PlaylistAction
Arguments
| Name | Description |
|---|---|
filter -
PlaylistActionFilterArgs
|
Filter criteria for the action |
id -
UUID!
|
PlaylistAction identifier |
playlistId -
UUID!
|
Playlist identifier |
Example
Query
query PlaylistAction(
$filter: PlaylistActionFilterArgs,
$id: UUID!,
$playlistId: UUID!
) {
playlistAction(
filter: $filter,
id: $id,
playlistId: $playlistId
) {
date
id
playlist {
affiliateBuyers {
...PlaylistAffiliateBuyerConnectionFragment
}
coverImage {
...MediaFragment
}
coverReleases {
...ReleaseFragment
}
createdAt
deletedAt
description
extendedFrom {
...ShelfFragment
}
id
index
likedBy {
...UserConnectionFragment
}
likes
linkSlug
name
numLikes
numReferralPurchases
numUsersReferred
orderedReleases {
...ShelfReleaseConnectionFragment
}
playTimeInSeconds
previewReleases {
...ShelfReleaseFragment
}
releaseCount
releaseIds
socialProofReferrals {
...UserFragment
}
trackIds
type
user {
...UserFragment
}
webEmbed
webappUri
}
user {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
}
}
Variables
{
"filter": PlaylistActionFilterArgs,
"id": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"playlistId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"playlistAction": {
"date": "2007-12-03T10:15:30Z",
"id": "4",
"playlist": Shelf,
"user": User
}
}
}
playlistActivityFeed
Description
[PUBLIC] Activity Feed with filter parameters
Response
Returns a
PlaylistActionConnection!
Arguments
| Name | Description |
|---|---|
pagination -
CursorConnectionArgs!
|
Pagination parameters. Default = {first: 10, sort: DESC} |
playlistId -
UUID!
|
Playlist id |
Example
Query
query PlaylistActivityFeed(
$pagination: CursorConnectionArgs!,
$playlistId: UUID!
) {
playlistActivityFeed(
pagination: $pagination,
playlistId: $playlistId
) {
edges {
cursor
node {
...PlaylistActionFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"pagination": {"first": 10, "sort": "DESC"},
"playlistId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"playlistActivityFeed": {
"edges": [PlaylistActionConnectionEdge],
"pageInfo": PageInfo
}
}
}
playlistV2
Description
[PUBLIC] Get specified shelf by id
Example
Query
query PlaylistV2($id: UUID!) {
playlistV2(id: $id) {
affiliateBuyers {
edges {
...PlaylistAffiliateBuyerConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
coverImage {
bucket
dominantColor
id
key
url
}
coverReleases {
activityFeed {
...ReleaseActionConnectionFragment
}
affiliates {
...ReleaseAffiliateConnectionFragment
}
airdropCount
animatedCoverImage {
...MediaFragment
}
animatedGoldenEggImageOptimized {
...MediaFragment
}
artist {
...ArtistFragment
}
auctionContractType
auctionType
baseMetadataAttributes {
...MetadataAttributeFragment
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
...ReleaseCollectorConnectionFragment
}
collectorsCount
contract {
...ContractFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
creditSplit {
...CreditSplitFragment
}
credits {
...UserFragment
}
draftId
earliestCollector {
...ReleaseCollectorFragment
}
editionId
eggGame {
...EggGameFragment
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
...MediaFragment
}
gaCoverImage {
...MediaFragment
}
genre {
...GenreFragment
}
goldenEggImage {
...MediaFragment
}
goldenEggNft {
...NftFragment
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
...ReleaseCollectorFragment
}
likedBy {
...UserConnectionFragment
}
listeningParty
listing {
...AuctionListingInterfaceFragment
}
marketPlaceUrl
metadataDetails {
...MetadataDetailsFragment
}
mintStartTime
mintStartTimestamp
nftsPaginated {
...NftConnectionFragment
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
...RewardFragment
}
royaltyBps
saleDetails {
...SaleDetailsFragment
}
saleSchedules {
...SaleScheduleFragment
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
...SamConfigFragment
}
samSellBufferBpsOverride
scheduleIds {
...ScheduleIdentifierFragment
}
season
shelves {
...ShelfConnectionFragment
}
socialProofCollectors {
...UserFragment
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
...MediaFragment
}
staticGaCoverImage {
...MediaFragment
}
staticVipCoverImage {
...MediaFragment
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
...TopReleaseCollectorFragment
}
topPosts {
...PostFragment
}
topSpentCollector {
...ReleaseCollectorFragment
}
totalMinted
totalSupply
track {
...TrackFragment
}
type
vipAnimatedCoverImage {
...MediaFragment
}
vipCoverImage {
...MediaFragment
}
webEmbed
webappUri
}
createdAt
deletedAt
description
extendedFrom {
affiliateBuyers {
...PlaylistAffiliateBuyerConnectionFragment
}
coverImage {
...MediaFragment
}
coverReleases {
...ReleaseFragment
}
createdAt
deletedAt
description
extendedFrom {
...ShelfFragment
}
id
index
likedBy {
...UserConnectionFragment
}
likes
linkSlug
name
numLikes
numReferralPurchases
numUsersReferred
orderedReleases {
...ShelfReleaseConnectionFragment
}
playTimeInSeconds
previewReleases {
...ShelfReleaseFragment
}
releaseCount
releaseIds
socialProofReferrals {
...UserFragment
}
trackIds
type
user {
...UserFragment
}
webEmbed
webappUri
}
id
index
likedBy {
edges {
...UserConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
likes
linkSlug
name
numLikes
numReferralPurchases
numUsersReferred
orderedReleases {
edges {
...ShelfReleaseConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
playTimeInSeconds
previewReleases {
addedAt
id
index
ownedFirstNft {
...NftFragment
}
ownedGoldenEgg {
...EggGameFragment
}
ownedTokens {
...OwnedTokenFragment
}
release {
...ReleaseFragment
}
}
releaseCount
releaseIds
socialProofReferrals {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
trackIds
type
user {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
webEmbed
webappUri
}
}
Variables
{
"id": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"playlistV2": {
"affiliateBuyers": PlaylistAffiliateBuyerConnection,
"coverImage": Media,
"coverReleases": [Release],
"createdAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"extendedFrom": [Shelf],
"id": "4",
"index": 987,
"likedBy": UserConnection,
"likes": 123,
"linkSlug": "abc123",
"name": "xyz789",
"numLikes": 987,
"numReferralPurchases": 123,
"numUsersReferred": 123,
"orderedReleases": ShelfReleaseConnection,
"playTimeInSeconds": 987,
"previewReleases": [ShelfRelease],
"releaseCount": 987,
"releaseIds": ["abc123"],
"socialProofReferrals": [User],
"trackIds": ["xyz789"],
"type": "DEFAULT",
"user": User,
"webEmbed": "abc123",
"webappUri": "xyz789"
}
}
}
post
Description
[PUBLIC] Post entity
Example
Query
query Post($postId: UUID!) {
post(postId: $postId) {
authorChannelRole
channel {
animatedProfileImage {
...MediaFragment
}
coverImage {
...MediaFragment
}
createdAt
description
discordUrl
id
name
nameSlug
profileImage {
...MediaFragment
}
published
rules
staticProfileImage {
...MediaFragment
}
telegramUrl
tiktokUrl
twitterUrl
webappUri
websiteUrl
}
commentCount
comments {
edges {
...PostCommentConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
content
createdAt
creator {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
farcasterHash
id
lexicalContent
repostCount
upvoteCount
webappUri
}
}
Variables
{
"postId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"post": {
"authorChannelRole": "MODERATOR",
"channel": Channel,
"commentCount": 123,
"comments": PostCommentConnection,
"content": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"creator": User,
"farcasterHash": "xyz789",
"id": "4",
"lexicalContent": {},
"repostCount": 987,
"upvoteCount": 123,
"webappUri": "xyz789"
}
}
}
postComment
Description
[PUBLIC] PostComment entity
Response
Returns a
PostComment
Arguments
| Name | Description |
|---|---|
commentId -
UUID!
|
Unique Post Comment identifier |
Example
Query
query PostComment($commentId: UUID!) {
postComment(commentId: $commentId) {
author {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
authorChannelRole
authorNftsCountGa
authorNftsCountVip
content
createdAt
currentHolderOfRelease
id
labels
lexicalContent
parentComment {
author {
...UserFragment
}
authorChannelRole
authorNftsCountGa
authorNftsCountVip
content
createdAt
currentHolderOfRelease
id
labels
lexicalContent
parentComment {
...PostCommentFragment
}
post {
...PostFragment
}
repliesCount
updatedAt
upvoteCount
}
post {
authorChannelRole
channel {
...ChannelFragment
}
commentCount
comments {
...PostCommentConnectionFragment
}
content
createdAt
creator {
...UserFragment
}
farcasterHash
id
lexicalContent
repostCount
upvoteCount
webappUri
}
repliesCount
updatedAt
upvoteCount
}
}
Variables
{
"commentId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"postComment": {
"author": User,
"authorChannelRole": "MODERATOR",
"authorNftsCountGa": 123,
"authorNftsCountVip": 123,
"content": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"currentHolderOfRelease": true,
"id": 4,
"labels": ["RELEASE_ARTIST"],
"lexicalContent": {},
"parentComment": PostComment,
"post": Post,
"repliesCount": 123,
"updatedAt": "2007-12-03T10:15:30Z",
"upvoteCount": 987
}
}
}
postCommentUpvotedByUsersInUserNotification
Description
[AUTHENTICATED] Users who upvoted a post comment by notification group
Response
Returns a
UserConnection!
Arguments
| Name | Description |
|---|---|
pagination -
UserCursorConnectionArgs!
|
Pagination parameters. Default = {after: null, first: 20, sort: ASC} |
userNotificationId -
UUID!
|
PostCommentUpvoted UserNotification ID |
Example
Query
query PostCommentUpvotedByUsersInUserNotification(
$pagination: UserCursorConnectionArgs!,
$userNotificationId: UUID!
) {
postCommentUpvotedByUsersInUserNotification(
pagination: $pagination,
userNotificationId: $userNotificationId
) {
edges {
cursor
node {
...UserFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"pagination": {"after": "null", "first": 20, "sort": "ASC"},
"userNotificationId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"postCommentUpvotedByUsersInUserNotification": {
"edges": [UserConnectionEdge],
"pageInfo": PageInfo
}
}
}
postRepostedBy
Description
[PUBLIC] Users who reposted the specified post
Response
Returns a
UserConnection!
Arguments
| Name | Description |
|---|---|
input -
QueryPostRepostedByInput!
|
Input for postRepostedBy query |
Example
Query
query PostRepostedBy($input: QueryPostRepostedByInput!) {
postRepostedBy(input: $input) {
edges {
cursor
node {
...UserFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{"input": QueryPostRepostedByInput}
Response
{
"data": {
"postRepostedBy": {
"edges": [UserConnectionEdge],
"pageInfo": PageInfo
}
}
}
postUpvotedBy
Description
[PUBLIC] Users who upvoted the specified post
Response
Returns a
UserConnection!
Arguments
| Name | Description |
|---|---|
input -
QueryPostUpvotedByInput!
|
Input for postUpvotedBy query |
Example
Query
query PostUpvotedBy($input: QueryPostUpvotedByInput!) {
postUpvotedBy(input: $input) {
edges {
cursor
node {
...UserFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{"input": QueryPostUpvotedByInput}
Response
{
"data": {
"postUpvotedBy": {
"edges": [UserConnectionEdge],
"pageInfo": PageInfo
}
}
}
prepareMintDraftAsyncStatus
Description
[ARTIST] Check status of async prepareMintDraftAsync
Response
Returns a
QueryPrepareMintDraftAsyncStatusResult!
Arguments
| Name | Description |
|---|---|
prepareMintDraftAsyncRequestId -
String!
|
Async request ID |
Example
Query
query PrepareMintDraftAsyncStatus($prepareMintDraftAsyncRequestId: String!) {
prepareMintDraftAsyncStatus(prepareMintDraftAsyncRequestId: $prepareMintDraftAsyncRequestId)
}
Variables
{"prepareMintDraftAsyncRequestId": "abc123"}
Response
{
"data": {
"prepareMintDraftAsyncStatus": AlreadyMintedError
}
}
prepareMintTieredDraftAsyncStatus
Description
[ARTIST] Check status of async prepareMintTieredDraftAsync
Response
Arguments
| Name | Description |
|---|---|
prepareMintTieredDraftAsyncRequestId -
String!
|
Async request ID |
Example
Query
query PrepareMintTieredDraftAsyncStatus($prepareMintTieredDraftAsyncRequestId: String!) {
prepareMintTieredDraftAsyncStatus(prepareMintTieredDraftAsyncRequestId: $prepareMintTieredDraftAsyncRequestId)
}
Variables
{
"prepareMintTieredDraftAsyncRequestId": "abc123"
}
Response
{
"data": {
"prepareMintTieredDraftAsyncStatus": AlreadyMintedError
}
}
presavedByUsersInUserNotification
Description
[AUTHENTICATED] Users who presaved a release by notification group
Response
Returns a
UserConnection!
Arguments
| Name | Description |
|---|---|
pagination -
UserCursorConnectionArgs!
|
Pagination parameters. Default = {after: null, first: 20, sort: ASC} |
userNotificationId -
UUID!
|
ReleasePresave UserNotification ID |
Example
Query
query PresavedByUsersInUserNotification(
$pagination: UserCursorConnectionArgs!,
$userNotificationId: UUID!
) {
presavedByUsersInUserNotification(
pagination: $pagination,
userNotificationId: $userNotificationId
) {
edges {
cursor
node {
...UserFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"pagination": {"after": "null", "first": 20, "sort": "ASC"},
"userNotificationId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"presavedByUsersInUserNotification": {
"edges": [UserConnectionEdge],
"pageInfo": PageInfo
}
}
}
previewCustomizeHighlightedReleases
Description
[ADMIN | ARTIST_RELATIONS] Preview customized highlighted Releases
Response
Arguments
| Name | Description |
|---|---|
params -
JSON!
|
Customization parameters |
Example
Query
query PreviewCustomizeHighlightedReleases($params: JSON!) {
previewCustomizeHighlightedReleases(params: $params)
}
Variables
{"params": {}}
Response
{
"data": {
"previewCustomizeHighlightedReleases": NotAuthorizedError
}
}
purchaseActivityFeed
Description
[PUBLIC] Purchase activity Feed with filter parameters
Response
Returns a
CollectorActionConnection!
Arguments
| Name | Description |
|---|---|
pagination -
CursorConnectionArgs!
|
Pagination parameters. Default = {first: 10, sort: DESC} |
Example
Query
query PurchaseActivityFeed($pagination: CursorConnectionArgs!) {
purchaseActivityFeed(pagination: $pagination) {
edges {
cursor
node {
...CollectorActionFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{"pagination": {"first": 10, "sort": "DESC"}}
Response
{
"data": {
"purchaseActivityFeed": {
"edges": [CollectorActionConnectionEdge],
"pageInfo": PageInfo
}
}
}
recommendedChannels
Description
[PUBLIC] Recommended channels for the current user (includes joined channels if the user is authenticated)
Response
Returns
[RecommendedChannel!]!
Example
Query
query RecommendedChannels {
recommendedChannels {
channel {
animatedProfileImage {
...MediaFragment
}
coverImage {
...MediaFragment
}
createdAt
description
discordUrl
id
name
nameSlug
profileImage {
...MediaFragment
}
published
rules
staticProfileImage {
...MediaFragment
}
telegramUrl
tiktokUrl
twitterUrl
webappUri
websiteUrl
}
hasNewContent
memberCount
}
}
Response
{
"data": {
"recommendedChannels": [
{
"channel": Channel,
"hasNewContent": true,
"memberCount": 987
}
]
}
}
release
Description
[PUBLIC] Get release by id
Example
Query
query Release($id: UUID!) {
release(id: $id) {
activityFeed {
edges {
...ReleaseActionConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
affiliates {
edges {
...ReleaseAffiliateConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
airdropCount
animatedCoverImage {
bucket
dominantColor
id
key
url
}
animatedGoldenEggImageOptimized {
bucket
dominantColor
id
key
url
}
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
auctionContractType
auctionType
baseMetadataAttributes {
traitType
value
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
edges {
...ReleaseCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
collectorsCount
contract {
contractAddress
contractType
createdAt
id
owner {
...UserFragment
}
ownerPublicAddress
updatedAt
}
contractAddress
coverImage {
bucket
dominantColor
id
key
url
}
createdAt
creditSplit {
creditAllocations {
...CreditAllocationFragment
}
id
mintedReleases {
...ReleaseFragment
}
releases {
...ReleaseFragment
}
splitAddress
}
credits {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
draftId
earliestCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
editionId
eggGame {
animatedGoldenEggImageOptimized {
...MediaFragment
}
finalSerialBlockHash
goldenEggImage {
...MediaFragment
}
id
nft {
...NftFragment
}
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
bucket
dominantColor
id
key
url
}
gaCoverImage {
bucket
dominantColor
id
key
url
}
genre {
createdAt
id
name
updatedAt
}
goldenEggImage {
bucket
dominantColor
id
key
url
}
goldenEggNft {
audioUrl
collectorRelease {
...ReleaseCollectorFragment
}
comment {
...CommentFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
createdAtBlockTime
id
isBurned
isGoldenEgg
openSeaMetadataAttributes {
...OpenSeaMetadataAttributeFragment
}
owner {
...UserFragment
}
release {
...ReleaseFragment
}
serialNumber
songSlot
tierNumber
title
tokenId
updatedAt
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
likedBy {
edges {
...UserConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
listeningParty
listing {
chain
contractAddress
id
}
marketPlaceUrl
metadataDetails {
bpm
key
license
location
lyrics
}
mintStartTime
mintStartTimestamp
nftsPaginated {
edges {
...NftConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
description
id
title
}
royaltyBps
saleDetails {
primaryCollected
primaryRaisedInWei
soundSwapCollected
soundSwapRaisedInWei
totalVolume
}
saleSchedules {
affiliateFeeBPS
affiliateFeePercent
artistContractTotalMinted
endTime
id
isPresale
maxMintable
merkleTreeRoot
mintId
minterAddress
price
startTime
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
affiliateFeeBPS
affiliateFeePercent
artistFeeBPS
artistFeePercent
basePrice
buyFreezeTime
goldenEggFeeBPS
goldenEggFeePercent
id
inflectionPoint
inflectionPrice
maxSupply
platformFeeBPS
platformPerTxFlatFee
samAddress
}
samSellBufferBpsOverride
scheduleIds {
mintIds
minterAddress
}
season
shelves {
edges {
...ShelfConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
socialProofCollectors {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
bucket
dominantColor
id
key
url
}
staticGaCoverImage {
bucket
dominantColor
id
key
url
}
staticVipCoverImage {
bucket
dominantColor
id
key
url
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
firstNftCollectedDate
lowestNftSerialNumber
nftsCount
position
user {
...UserFragment
}
}
topPosts {
authorChannelRole
channel {
...ChannelFragment
}
commentCount
comments {
...PostCommentConnectionFragment
}
content
createdAt
creator {
...UserFragment
}
farcasterHash
id
lexicalContent
repostCount
upvoteCount
webappUri
}
topSpentCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
totalMinted
totalSupply
track {
audio {
...AudioMediaFragment
}
audioOriginal {
...MediaFragment
}
duration
id
normalizedPeaks
release {
...ReleaseFragment
}
releaseId
title
trackNumber
}
type
vipAnimatedCoverImage {
bucket
dominantColor
id
key
url
}
vipCoverImage {
bucket
dominantColor
id
key
url
}
webEmbed
webappUri
}
}
Variables
{
"id": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"release": {
"activityFeed": ReleaseActionConnection,
"affiliates": ReleaseAffiliateConnection,
"airdropCount": 987,
"animatedCoverImage": Media,
"animatedGoldenEggImageOptimized": Media,
"artist": Artist,
"auctionContractType": "ARTIST",
"auctionType": "FIXED_QUANTITY",
"baseMetadataAttributes": [MetadataAttribute],
"behindTheMusic": "abc123",
"canCollectorsDownloadAudio": false,
"chainId": 123,
"collectors": ReleaseCollectorConnection,
"collectorsCount": 987,
"contract": Contract,
"contractAddress": "abc123",
"coverImage": Media,
"createdAt": "2007-12-03T10:15:30Z",
"creditSplit": CreditSplit,
"credits": [User],
"draftId": "xyz789",
"earliestCollector": ReleaseCollector,
"editionId": "xyz789",
"eggGame": EggGame,
"externalUrl": "xyz789",
"finalQuantity": 123,
"fundingAddress": "abc123",
"gaAnimatedCoverImage": Media,
"gaCoverImage": Media,
"genre": Genre,
"goldenEggImage": Media,
"goldenEggNft": Nft,
"id": "4",
"isAuctionSoldOut": true,
"isFirstPhaseCompleted": true,
"lastUpdatedAt": "2007-12-03T10:15:30Z",
"latestCollector": ReleaseCollector,
"likedBy": UserConnection,
"listeningParty": 1592577642,
"listing": AuctionListingInterface,
"marketPlaceUrl": "xyz789",
"metadataDetails": MetadataDetails,
"mintStartTime": 123,
"mintStartTimestamp": 1592577642,
"nftsPaginated": NftConnection,
"numSold": 987,
"openseaUrl": "xyz789",
"postCount": 987,
"price": "xyz789",
"publicAffiliateFeeBPS": 123,
"publicAffiliateFeePercent": "abc123",
"publicMintStart": "2007-12-03T10:15:30Z",
"quantity": 123,
"quantityLowerBound": 123,
"quantityUpperBound": 123,
"rewards": [Reward],
"royaltyBps": 123,
"saleDetails": SaleDetails,
"saleSchedules": [SaleSchedule],
"salesAffiliateFeesPercent": [
"abc123"
],
"samAddress": "xyz789",
"samBuyBufferBpsOverride": 123,
"samConfig": SamConfig,
"samSellBufferBpsOverride": 123,
"scheduleIds": [ScheduleIdentifier],
"season": "abc123",
"shelves": ShelfConnection,
"socialProofCollectors": [User],
"spotifyPresaveCampaign": false,
"spotifyPresaveCount": 123,
"spotifyTrackId": "abc123",
"staticCoverImage": Media,
"staticGaCoverImage": Media,
"staticVipCoverImage": Media,
"supplyCutoffTimestamp": 1592577642,
"title": "xyz789",
"titleSlug": "xyz789",
"topCollectors": [TopReleaseCollector],
"topPosts": [Post],
"topSpentCollector": ReleaseCollector,
"totalMinted": 123,
"totalSupply": 987,
"track": Track,
"type": "ALBUM",
"vipAnimatedCoverImage": Media,
"vipCoverImage": Media,
"webEmbed": "xyz789",
"webappUri": "abc123"
}
}
}
releaseActivityFeed
Description
[PUBLIC] Release activity feed
Response
Returns a
ReleaseActionConnection!
Arguments
| Name | Description |
|---|---|
filter -
ReleaseActivityFeedFilterArgs!
|
Only get activities of given types. Default = {types: [ALL]} |
pagination -
CursorConnectionArgs!
|
Pagination parameters. Default = {first: 10, sort: DESC} |
releaseId -
UUID!
|
Release id |
Example
Query
query ReleaseActivityFeed(
$filter: ReleaseActivityFeedFilterArgs!,
$pagination: CursorConnectionArgs!,
$releaseId: UUID!
) {
releaseActivityFeed(
filter: $filter,
pagination: $pagination,
releaseId: $releaseId
) {
edges {
cursor
node {
...ReleaseActionFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"filter": {"types": ["ALL"]},
"pagination": {"first": 10, "sort": "DESC"},
"releaseId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"releaseActivityFeed": {
"edges": [ReleaseActionConnectionEdge],
"pageInfo": PageInfo
}
}
}
releaseAllowlist
Description
[PUBLIC] Get allowlist for release
Response
Returns a
ReleaseMerkleAllowlist
Arguments
| Name | Description |
|---|---|
input -
ReleaseAllowlistInput!
|
Input for release allowlist |
Example
Query
query ReleaseAllowlist($input: ReleaseAllowlistInput!) {
releaseAllowlist(input: $input) {
createdAt
id
info {
allArtistCollaborations
allArtistCollectors
manuallyAddedAddresses
sourceSelectedArtistIds
sourceSelectedReleaseIds
}
manuallyAddedAddresses {
description
id
totalAddresses
}
releaseCollaborationsSources {
edges {
...ReleaseSourceSubAllowlistEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
selectedArtistSources {
edges {
...ArtistSourceSelectedAllowlistEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
selectedReleaseSources {
edges {
...ReleaseSourceSubAllowlistEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
totalUsers
}
}
Variables
{"input": ReleaseAllowlistInput}
Response
{
"data": {
"releaseAllowlist": {
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"info": ReleaseMerkleAllowlistInfo,
"manuallyAddedAddresses": ReleaseManuallyAddedAddressesAllowlist,
"releaseCollaborationsSources": ReleaseSourceSubAllowlistConnection,
"selectedArtistSources": ArtistSourceSelectedAllowlistConnection,
"selectedReleaseSources": ReleaseSourceSubAllowlistConnection,
"totalUsers": 987
}
}
}
releaseAudience
Description
[PUBLIC] Get the release audience members
Response
Returns an
AudienceMemberConnection!
Arguments
| Name | Description |
|---|---|
input -
ReleaseAudienceInput!
|
Release audience input arguments |
Example
Query
query ReleaseAudience($input: ReleaseAudienceInput!) {
releaseAudience(input: $input) {
edges {
cursor
node {
...AudienceMemberFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{"input": ReleaseAudienceInput}
Response
{
"data": {
"releaseAudience": {
"edges": [AudienceMemberConnectionEdge],
"pageInfo": PageInfo
}
}
}
releaseBackersCSVUrl
Description
[ARTIST] CDN url CSV of users that own a release nft or null if no release backers
releaseChart
Description
Get release chart based on input
Response
Returns a
ReleaseChart!
Arguments
| Name | Description |
|---|---|
input -
ReleaseChartInput!
|
Input parameters for releaseChart query |
Example
Query
query ReleaseChart($input: ReleaseChartInput!) {
releaseChart(input: $input) {
chartRanks {
edges {
...ReleaseChartRankConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
id
lastDayOfChartInclusive
periodEndExclusive
periodStartInclusive
}
}
Variables
{"input": ReleaseChartInput}
Response
{
"data": {
"releaseChart": {
"chartRanks": ReleaseChartRankConnection,
"id": 4,
"lastDayOfChartInclusive": "2007-12-03T10:15:30Z",
"periodEndExclusive": "2007-12-03T10:15:30Z",
"periodStartInclusive": "2007-12-03T10:15:30Z"
}
}
}
releaseChartByDate
Description
[PUBLIC] Get release chart based on date input
Response
Returns a
ReleaseChart
Arguments
| Name | Description |
|---|---|
input -
ReleaseChartByLastDayInput!
|
Input parameters for releaseChart query |
Example
Query
query ReleaseChartByDate($input: ReleaseChartByLastDayInput!) {
releaseChartByDate(input: $input) {
chartRanks {
edges {
...ReleaseChartRankConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
id
lastDayOfChartInclusive
periodEndExclusive
periodStartInclusive
}
}
Variables
{"input": ReleaseChartByLastDayInput}
Response
{
"data": {
"releaseChartByDate": {
"chartRanks": ReleaseChartRankConnection,
"id": 4,
"lastDayOfChartInclusive": "2007-12-03T10:15:30Z",
"periodEndExclusive": "2007-12-03T10:15:30Z",
"periodStartInclusive": "2007-12-03T10:15:30Z"
}
}
}
releaseChartById
Description
Get release chart based on identifier
Response
Returns a
ReleaseChart
Arguments
| Name | Description |
|---|---|
chartId -
UUID!
|
Chart identifier |
Example
Query
query ReleaseChartById($chartId: UUID!) {
releaseChartById(chartId: $chartId) {
chartRanks {
edges {
...ReleaseChartRankConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
id
lastDayOfChartInclusive
periodEndExclusive
periodStartInclusive
}
}
Variables
{
"chartId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"releaseChartById": {
"chartRanks": ReleaseChartRankConnection,
"id": "4",
"lastDayOfChartInclusive": "2007-12-03T10:15:30Z",
"periodEndExclusive": "2007-12-03T10:15:30Z",
"periodStartInclusive": "2007-12-03T10:15:30Z"
}
}
}
releaseChartPeriods
Description
[PUBLIC] Latest supported ranges for ReleaseCharts
Response
Returns a
ReleaseChartsPeriodRange!
Example
Query
query ReleaseChartPeriods {
releaseChartPeriods {
earliestPeriodStartInclusive
latestPeriodEndExclusive
}
}
Response
{
"data": {
"releaseChartPeriods": {
"earliestPeriodStartInclusive": "2007-12-03T10:15:30Z",
"latestPeriodEndExclusive": "2007-12-03T10:15:30Z"
}
}
}
releaseChartRank
Description
[PUBLIC] Get release chart rank based on input
Response
Returns a
ReleaseChartRank!
Arguments
| Name | Description |
|---|---|
input -
ReleaseChartRankInput!
|
Input parameters for releaseChartRank query |
Example
Query
query ReleaseChartRank($input: ReleaseChartRankInput!) {
releaseChartRank(input: $input) {
currentRank
id
rankLast
rankPeak
release {
activityFeed {
...ReleaseActionConnectionFragment
}
affiliates {
...ReleaseAffiliateConnectionFragment
}
airdropCount
animatedCoverImage {
...MediaFragment
}
animatedGoldenEggImageOptimized {
...MediaFragment
}
artist {
...ArtistFragment
}
auctionContractType
auctionType
baseMetadataAttributes {
...MetadataAttributeFragment
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
...ReleaseCollectorConnectionFragment
}
collectorsCount
contract {
...ContractFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
creditSplit {
...CreditSplitFragment
}
credits {
...UserFragment
}
draftId
earliestCollector {
...ReleaseCollectorFragment
}
editionId
eggGame {
...EggGameFragment
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
...MediaFragment
}
gaCoverImage {
...MediaFragment
}
genre {
...GenreFragment
}
goldenEggImage {
...MediaFragment
}
goldenEggNft {
...NftFragment
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
...ReleaseCollectorFragment
}
likedBy {
...UserConnectionFragment
}
listeningParty
listing {
...AuctionListingInterfaceFragment
}
marketPlaceUrl
metadataDetails {
...MetadataDetailsFragment
}
mintStartTime
mintStartTimestamp
nftsPaginated {
...NftConnectionFragment
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
...RewardFragment
}
royaltyBps
saleDetails {
...SaleDetailsFragment
}
saleSchedules {
...SaleScheduleFragment
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
...SamConfigFragment
}
samSellBufferBpsOverride
scheduleIds {
...ScheduleIdentifierFragment
}
season
shelves {
...ShelfConnectionFragment
}
socialProofCollectors {
...UserFragment
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
...MediaFragment
}
staticGaCoverImage {
...MediaFragment
}
staticVipCoverImage {
...MediaFragment
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
...TopReleaseCollectorFragment
}
topPosts {
...PostFragment
}
topSpentCollector {
...ReleaseCollectorFragment
}
totalMinted
totalSupply
track {
...TrackFragment
}
type
vipAnimatedCoverImage {
...MediaFragment
}
vipCoverImage {
...MediaFragment
}
webEmbed
webappUri
}
trendingIndicator
trendingStreak
}
}
Variables
{"input": ReleaseChartRankInput}
Response
{
"data": {
"releaseChartRank": {
"currentRank": 123,
"id": "4",
"rankLast": 987,
"rankPeak": 987,
"release": Release,
"trendingIndicator": "DOWN",
"trendingStreak": 123
}
}
}
releaseCharts
Description
[PUBLIC] Get release charts based on input
Response
Returns a
ReleaseChartConnection!
Arguments
| Name | Description |
|---|---|
input -
ReleaseChartsInput!
|
Input parameters for releaseCharts query |
Example
Query
query ReleaseCharts($input: ReleaseChartsInput!) {
releaseCharts(input: $input) {
edges {
cursor
node {
...ReleaseChartFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{"input": ReleaseChartsInput}
Response
{
"data": {
"releaseCharts": {
"edges": [ReleaseChartConnectionEdge],
"pageInfo": PageInfo
}
}
}
releaseCollectedByManyUsers
Description
[PUBLIC] Get all users that collected the same release in one activity feed group.
Response
Returns a
UserConnection!
Arguments
| Name | Description |
|---|---|
activityFeedGroupId -
UUID!
|
Activity feed group id |
pagination -
CursorConnectionArgs!
|
Pagination parameters. Default = {first: 10, sort: DESC} |
Example
Query
query ReleaseCollectedByManyUsers(
$activityFeedGroupId: UUID!,
$pagination: CursorConnectionArgs!
) {
releaseCollectedByManyUsers(
activityFeedGroupId: $activityFeedGroupId,
pagination: $pagination
) {
edges {
cursor
node {
...UserFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"activityFeedGroupId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"pagination": {"first": 10, "sort": "DESC"}
}
Response
{
"data": {
"releaseCollectedByManyUsers": {
"edges": [UserConnectionEdge],
"pageInfo": PageInfo
}
}
}
releaseCollectorFromId
Description
[PUBLIC] Get specified release collector from unique identifier
Response
Returns a
ReleaseCollector
Arguments
| Name | Description |
|---|---|
id -
UUID!
|
Release collector unique identifier |
Example
Query
query ReleaseCollectorFromId($id: UUID!) {
releaseCollectorFromId(id: $id) {
firstNftCollected {
audioUrl
collectorRelease {
...ReleaseCollectorFragment
}
comment {
...CommentFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
createdAtBlockTime
id
isBurned
isGoldenEgg
openSeaMetadataAttributes {
...OpenSeaMetadataAttributeFragment
}
owner {
...UserFragment
}
release {
...ReleaseFragment
}
serialNumber
songSlot
tierNumber
title
tokenId
updatedAt
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
audioUrl
collectorRelease {
...ReleaseCollectorFragment
}
comment {
...CommentFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
createdAtBlockTime
id
isBurned
isGoldenEgg
openSeaMetadataAttributes {
...OpenSeaMetadataAttributeFragment
}
owner {
...UserFragment
}
release {
...ReleaseFragment
}
serialNumber
songSlot
tierNumber
title
tokenId
updatedAt
}
mostRecentNftWithComment {
audioUrl
collectorRelease {
...ReleaseCollectorFragment
}
comment {
...CommentFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
createdAtBlockTime
id
isBurned
isGoldenEgg
openSeaMetadataAttributes {
...OpenSeaMetadataAttributeFragment
}
owner {
...UserFragment
}
release {
...ReleaseFragment
}
serialNumber
songSlot
tierNumber
title
tokenId
updatedAt
}
nftsCount
ownedGoldenEgg {
animatedGoldenEggImageOptimized {
...MediaFragment
}
finalSerialBlockHash
goldenEggImage {
...MediaFragment
}
id
nft {
...NftFragment
}
}
release {
activityFeed {
...ReleaseActionConnectionFragment
}
affiliates {
...ReleaseAffiliateConnectionFragment
}
airdropCount
animatedCoverImage {
...MediaFragment
}
animatedGoldenEggImageOptimized {
...MediaFragment
}
artist {
...ArtistFragment
}
auctionContractType
auctionType
baseMetadataAttributes {
...MetadataAttributeFragment
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
...ReleaseCollectorConnectionFragment
}
collectorsCount
contract {
...ContractFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
creditSplit {
...CreditSplitFragment
}
credits {
...UserFragment
}
draftId
earliestCollector {
...ReleaseCollectorFragment
}
editionId
eggGame {
...EggGameFragment
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
...MediaFragment
}
gaCoverImage {
...MediaFragment
}
genre {
...GenreFragment
}
goldenEggImage {
...MediaFragment
}
goldenEggNft {
...NftFragment
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
...ReleaseCollectorFragment
}
likedBy {
...UserConnectionFragment
}
listeningParty
listing {
...AuctionListingInterfaceFragment
}
marketPlaceUrl
metadataDetails {
...MetadataDetailsFragment
}
mintStartTime
mintStartTimestamp
nftsPaginated {
...NftConnectionFragment
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
...RewardFragment
}
royaltyBps
saleDetails {
...SaleDetailsFragment
}
saleSchedules {
...SaleScheduleFragment
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
...SamConfigFragment
}
samSellBufferBpsOverride
scheduleIds {
...ScheduleIdentifierFragment
}
season
shelves {
...ShelfConnectionFragment
}
socialProofCollectors {
...UserFragment
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
...MediaFragment
}
staticGaCoverImage {
...MediaFragment
}
staticVipCoverImage {
...MediaFragment
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
...TopReleaseCollectorFragment
}
topPosts {
...PostFragment
}
topSpentCollector {
...ReleaseCollectorFragment
}
totalMinted
totalSupply
track {
...TrackFragment
}
type
vipAnimatedCoverImage {
...MediaFragment
}
vipCoverImage {
...MediaFragment
}
webEmbed
webappUri
}
tierPriority
user {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
vipNftsCount
volumeSpent
}
}
Variables
{
"id": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"releaseCollectorFromId": {
"firstNftCollected": Nft,
"firstNftCollectedDate": "2007-12-03T10:15:30Z",
"gaNftsCount": 123,
"id": "4",
"lowestNftSerialNumber": 987,
"lowestSerialNumberNftCollected": Nft,
"mostRecentNftWithComment": Nft,
"nftsCount": 987,
"ownedGoldenEgg": EggGame,
"release": Release,
"tierPriority": 987,
"user": User,
"vipNftsCount": 123,
"volumeSpent": "xyz789"
}
}
}
releaseEarnings
Description
[AUTHENTICATED] Paginated earnings by release
Response
Returns a
ReleaseEarningsConnection!
Arguments
| Name | Description |
|---|---|
filter -
ArtistMintedReleasesFilter!
|
Filter the releases to be counted. Default = {creditSplit: ALL, excludeReleaseIds: [], mintTimeStatus: [PAST, UPCOMING], releaseAlbumRevealStatus: ALL, releaseAuthor: ALL, releaseType: [SINGLE, ALBUM]} |
pagination -
CursorConnectionArgs!
|
Pagination parameters. Default = {first: 10, sort: DESC} |
Example
Query
query ReleaseEarnings(
$filter: ArtistMintedReleasesFilter!,
$pagination: CursorConnectionArgs!
) {
releaseEarnings(
filter: $filter,
pagination: $pagination
) {
edges {
cursor
node {
...ReleaseEarningsFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"filter": {
"creditSplit": "ALL",
"excludeReleaseIds": [""],
"mintTimeStatus": ["PAST", "UPCOMING"],
"releaseAlbumRevealStatus": "ALL",
"releaseAuthor": "ALL",
"releaseType": ["SINGLE", "ALBUM"]
},
"pagination": {"first": 10, "sort": "DESC"}
}
Response
{
"data": {
"releaseEarnings": {
"edges": [ReleaseEarningsConnectionEdge],
"pageInfo": PageInfo
}
}
}
releaseFromContract
Description
[PUBLIC] Get release by contract address
Response
Returns a
Release
Example
Query
query ReleaseFromContract(
$contractAddress: Address!,
$editionId: String
) {
releaseFromContract(
contractAddress: $contractAddress,
editionId: $editionId
) {
activityFeed {
edges {
...ReleaseActionConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
affiliates {
edges {
...ReleaseAffiliateConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
airdropCount
animatedCoverImage {
bucket
dominantColor
id
key
url
}
animatedGoldenEggImageOptimized {
bucket
dominantColor
id
key
url
}
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
auctionContractType
auctionType
baseMetadataAttributes {
traitType
value
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
edges {
...ReleaseCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
collectorsCount
contract {
contractAddress
contractType
createdAt
id
owner {
...UserFragment
}
ownerPublicAddress
updatedAt
}
contractAddress
coverImage {
bucket
dominantColor
id
key
url
}
createdAt
creditSplit {
creditAllocations {
...CreditAllocationFragment
}
id
mintedReleases {
...ReleaseFragment
}
releases {
...ReleaseFragment
}
splitAddress
}
credits {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
draftId
earliestCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
editionId
eggGame {
animatedGoldenEggImageOptimized {
...MediaFragment
}
finalSerialBlockHash
goldenEggImage {
...MediaFragment
}
id
nft {
...NftFragment
}
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
bucket
dominantColor
id
key
url
}
gaCoverImage {
bucket
dominantColor
id
key
url
}
genre {
createdAt
id
name
updatedAt
}
goldenEggImage {
bucket
dominantColor
id
key
url
}
goldenEggNft {
audioUrl
collectorRelease {
...ReleaseCollectorFragment
}
comment {
...CommentFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
createdAtBlockTime
id
isBurned
isGoldenEgg
openSeaMetadataAttributes {
...OpenSeaMetadataAttributeFragment
}
owner {
...UserFragment
}
release {
...ReleaseFragment
}
serialNumber
songSlot
tierNumber
title
tokenId
updatedAt
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
likedBy {
edges {
...UserConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
listeningParty
listing {
chain
contractAddress
id
}
marketPlaceUrl
metadataDetails {
bpm
key
license
location
lyrics
}
mintStartTime
mintStartTimestamp
nftsPaginated {
edges {
...NftConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
description
id
title
}
royaltyBps
saleDetails {
primaryCollected
primaryRaisedInWei
soundSwapCollected
soundSwapRaisedInWei
totalVolume
}
saleSchedules {
affiliateFeeBPS
affiliateFeePercent
artistContractTotalMinted
endTime
id
isPresale
maxMintable
merkleTreeRoot
mintId
minterAddress
price
startTime
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
affiliateFeeBPS
affiliateFeePercent
artistFeeBPS
artistFeePercent
basePrice
buyFreezeTime
goldenEggFeeBPS
goldenEggFeePercent
id
inflectionPoint
inflectionPrice
maxSupply
platformFeeBPS
platformPerTxFlatFee
samAddress
}
samSellBufferBpsOverride
scheduleIds {
mintIds
minterAddress
}
season
shelves {
edges {
...ShelfConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
socialProofCollectors {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
bucket
dominantColor
id
key
url
}
staticGaCoverImage {
bucket
dominantColor
id
key
url
}
staticVipCoverImage {
bucket
dominantColor
id
key
url
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
firstNftCollectedDate
lowestNftSerialNumber
nftsCount
position
user {
...UserFragment
}
}
topPosts {
authorChannelRole
channel {
...ChannelFragment
}
commentCount
comments {
...PostCommentConnectionFragment
}
content
createdAt
creator {
...UserFragment
}
farcasterHash
id
lexicalContent
repostCount
upvoteCount
webappUri
}
topSpentCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
totalMinted
totalSupply
track {
audio {
...AudioMediaFragment
}
audioOriginal {
...MediaFragment
}
duration
id
normalizedPeaks
release {
...ReleaseFragment
}
releaseId
title
trackNumber
}
type
vipAnimatedCoverImage {
bucket
dominantColor
id
key
url
}
vipCoverImage {
bucket
dominantColor
id
key
url
}
webEmbed
webappUri
}
}
Variables
{
"contractAddress": Address,
"editionId": "abc123"
}
Response
{
"data": {
"releaseFromContract": {
"activityFeed": ReleaseActionConnection,
"affiliates": ReleaseAffiliateConnection,
"airdropCount": 123,
"animatedCoverImage": Media,
"animatedGoldenEggImageOptimized": Media,
"artist": Artist,
"auctionContractType": "ARTIST",
"auctionType": "FIXED_QUANTITY",
"baseMetadataAttributes": [MetadataAttribute],
"behindTheMusic": "xyz789",
"canCollectorsDownloadAudio": false,
"chainId": 987,
"collectors": ReleaseCollectorConnection,
"collectorsCount": 987,
"contract": Contract,
"contractAddress": "xyz789",
"coverImage": Media,
"createdAt": "2007-12-03T10:15:30Z",
"creditSplit": CreditSplit,
"credits": [User],
"draftId": "abc123",
"earliestCollector": ReleaseCollector,
"editionId": "xyz789",
"eggGame": EggGame,
"externalUrl": "xyz789",
"finalQuantity": 987,
"fundingAddress": "xyz789",
"gaAnimatedCoverImage": Media,
"gaCoverImage": Media,
"genre": Genre,
"goldenEggImage": Media,
"goldenEggNft": Nft,
"id": 4,
"isAuctionSoldOut": true,
"isFirstPhaseCompleted": false,
"lastUpdatedAt": "2007-12-03T10:15:30Z",
"latestCollector": ReleaseCollector,
"likedBy": UserConnection,
"listeningParty": 1592577642,
"listing": AuctionListingInterface,
"marketPlaceUrl": "xyz789",
"metadataDetails": MetadataDetails,
"mintStartTime": 987,
"mintStartTimestamp": 1592577642,
"nftsPaginated": NftConnection,
"numSold": 123,
"openseaUrl": "abc123",
"postCount": 123,
"price": "xyz789",
"publicAffiliateFeeBPS": 987,
"publicAffiliateFeePercent": "abc123",
"publicMintStart": "2007-12-03T10:15:30Z",
"quantity": 987,
"quantityLowerBound": 987,
"quantityUpperBound": 987,
"rewards": [Reward],
"royaltyBps": 987,
"saleDetails": SaleDetails,
"saleSchedules": [SaleSchedule],
"salesAffiliateFeesPercent": [
"abc123"
],
"samAddress": "xyz789",
"samBuyBufferBpsOverride": 987,
"samConfig": SamConfig,
"samSellBufferBpsOverride": 987,
"scheduleIds": [ScheduleIdentifier],
"season": "abc123",
"shelves": ShelfConnection,
"socialProofCollectors": [User],
"spotifyPresaveCampaign": false,
"spotifyPresaveCount": 123,
"spotifyTrackId": "xyz789",
"staticCoverImage": Media,
"staticGaCoverImage": Media,
"staticVipCoverImage": Media,
"supplyCutoffTimestamp": 1592577642,
"title": "abc123",
"titleSlug": "xyz789",
"topCollectors": [TopReleaseCollector],
"topPosts": [Post],
"topSpentCollector": ReleaseCollector,
"totalMinted": 987,
"totalSupply": 123,
"track": Track,
"type": "ALBUM",
"vipAnimatedCoverImage": Media,
"vipCoverImage": Media,
"webEmbed": "xyz789",
"webappUri": "xyz789"
}
}
}
releaseFromDraft
Description
[ARTIST] Get release of given draft id if it exists
Example
Query
query ReleaseFromDraft($draftId: UUID!) {
releaseFromDraft(draftId: $draftId) {
activityFeed {
edges {
...ReleaseActionConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
affiliates {
edges {
...ReleaseAffiliateConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
airdropCount
animatedCoverImage {
bucket
dominantColor
id
key
url
}
animatedGoldenEggImageOptimized {
bucket
dominantColor
id
key
url
}
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
auctionContractType
auctionType
baseMetadataAttributes {
traitType
value
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
edges {
...ReleaseCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
collectorsCount
contract {
contractAddress
contractType
createdAt
id
owner {
...UserFragment
}
ownerPublicAddress
updatedAt
}
contractAddress
coverImage {
bucket
dominantColor
id
key
url
}
createdAt
creditSplit {
creditAllocations {
...CreditAllocationFragment
}
id
mintedReleases {
...ReleaseFragment
}
releases {
...ReleaseFragment
}
splitAddress
}
credits {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
draftId
earliestCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
editionId
eggGame {
animatedGoldenEggImageOptimized {
...MediaFragment
}
finalSerialBlockHash
goldenEggImage {
...MediaFragment
}
id
nft {
...NftFragment
}
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
bucket
dominantColor
id
key
url
}
gaCoverImage {
bucket
dominantColor
id
key
url
}
genre {
createdAt
id
name
updatedAt
}
goldenEggImage {
bucket
dominantColor
id
key
url
}
goldenEggNft {
audioUrl
collectorRelease {
...ReleaseCollectorFragment
}
comment {
...CommentFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
createdAtBlockTime
id
isBurned
isGoldenEgg
openSeaMetadataAttributes {
...OpenSeaMetadataAttributeFragment
}
owner {
...UserFragment
}
release {
...ReleaseFragment
}
serialNumber
songSlot
tierNumber
title
tokenId
updatedAt
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
likedBy {
edges {
...UserConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
listeningParty
listing {
chain
contractAddress
id
}
marketPlaceUrl
metadataDetails {
bpm
key
license
location
lyrics
}
mintStartTime
mintStartTimestamp
nftsPaginated {
edges {
...NftConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
description
id
title
}
royaltyBps
saleDetails {
primaryCollected
primaryRaisedInWei
soundSwapCollected
soundSwapRaisedInWei
totalVolume
}
saleSchedules {
affiliateFeeBPS
affiliateFeePercent
artistContractTotalMinted
endTime
id
isPresale
maxMintable
merkleTreeRoot
mintId
minterAddress
price
startTime
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
affiliateFeeBPS
affiliateFeePercent
artistFeeBPS
artistFeePercent
basePrice
buyFreezeTime
goldenEggFeeBPS
goldenEggFeePercent
id
inflectionPoint
inflectionPrice
maxSupply
platformFeeBPS
platformPerTxFlatFee
samAddress
}
samSellBufferBpsOverride
scheduleIds {
mintIds
minterAddress
}
season
shelves {
edges {
...ShelfConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
socialProofCollectors {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
bucket
dominantColor
id
key
url
}
staticGaCoverImage {
bucket
dominantColor
id
key
url
}
staticVipCoverImage {
bucket
dominantColor
id
key
url
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
firstNftCollectedDate
lowestNftSerialNumber
nftsCount
position
user {
...UserFragment
}
}
topPosts {
authorChannelRole
channel {
...ChannelFragment
}
commentCount
comments {
...PostCommentConnectionFragment
}
content
createdAt
creator {
...UserFragment
}
farcasterHash
id
lexicalContent
repostCount
upvoteCount
webappUri
}
topSpentCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
totalMinted
totalSupply
track {
audio {
...AudioMediaFragment
}
audioOriginal {
...MediaFragment
}
duration
id
normalizedPeaks
release {
...ReleaseFragment
}
releaseId
title
trackNumber
}
type
vipAnimatedCoverImage {
bucket
dominantColor
id
key
url
}
vipCoverImage {
bucket
dominantColor
id
key
url
}
webEmbed
webappUri
}
}
Variables
{
"draftId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"releaseFromDraft": {
"activityFeed": ReleaseActionConnection,
"affiliates": ReleaseAffiliateConnection,
"airdropCount": 123,
"animatedCoverImage": Media,
"animatedGoldenEggImageOptimized": Media,
"artist": Artist,
"auctionContractType": "ARTIST",
"auctionType": "FIXED_QUANTITY",
"baseMetadataAttributes": [MetadataAttribute],
"behindTheMusic": "xyz789",
"canCollectorsDownloadAudio": false,
"chainId": 123,
"collectors": ReleaseCollectorConnection,
"collectorsCount": 987,
"contract": Contract,
"contractAddress": "abc123",
"coverImage": Media,
"createdAt": "2007-12-03T10:15:30Z",
"creditSplit": CreditSplit,
"credits": [User],
"draftId": "abc123",
"earliestCollector": ReleaseCollector,
"editionId": "xyz789",
"eggGame": EggGame,
"externalUrl": "xyz789",
"finalQuantity": 123,
"fundingAddress": "abc123",
"gaAnimatedCoverImage": Media,
"gaCoverImage": Media,
"genre": Genre,
"goldenEggImage": Media,
"goldenEggNft": Nft,
"id": "4",
"isAuctionSoldOut": true,
"isFirstPhaseCompleted": false,
"lastUpdatedAt": "2007-12-03T10:15:30Z",
"latestCollector": ReleaseCollector,
"likedBy": UserConnection,
"listeningParty": 1592577642,
"listing": AuctionListingInterface,
"marketPlaceUrl": "abc123",
"metadataDetails": MetadataDetails,
"mintStartTime": 987,
"mintStartTimestamp": 1592577642,
"nftsPaginated": NftConnection,
"numSold": 123,
"openseaUrl": "abc123",
"postCount": 987,
"price": "abc123",
"publicAffiliateFeeBPS": 987,
"publicAffiliateFeePercent": "abc123",
"publicMintStart": "2007-12-03T10:15:30Z",
"quantity": 987,
"quantityLowerBound": 123,
"quantityUpperBound": 123,
"rewards": [Reward],
"royaltyBps": 123,
"saleDetails": SaleDetails,
"saleSchedules": [SaleSchedule],
"salesAffiliateFeesPercent": [
"abc123"
],
"samAddress": "xyz789",
"samBuyBufferBpsOverride": 987,
"samConfig": SamConfig,
"samSellBufferBpsOverride": 123,
"scheduleIds": [ScheduleIdentifier],
"season": "xyz789",
"shelves": ShelfConnection,
"socialProofCollectors": [User],
"spotifyPresaveCampaign": false,
"spotifyPresaveCount": 123,
"spotifyTrackId": "abc123",
"staticCoverImage": Media,
"staticGaCoverImage": Media,
"staticVipCoverImage": Media,
"supplyCutoffTimestamp": 1592577642,
"title": "abc123",
"titleSlug": "xyz789",
"topCollectors": [TopReleaseCollector],
"topPosts": [Post],
"topSpentCollector": ReleaseCollector,
"totalMinted": 987,
"totalSupply": 987,
"track": Track,
"type": "ALBUM",
"vipAnimatedCoverImage": Media,
"vipCoverImage": Media,
"webEmbed": "xyz789",
"webappUri": "xyz789"
}
}
}
releaseFromToken
Description
[PUBLIC] Get the release that's associated with the specific token parameters
Response
Returns a
Release
Arguments
| Name | Description |
|---|---|
input -
ReleaseFromTokenInput!
|
Token parameters |
Example
Query
query ReleaseFromToken($input: ReleaseFromTokenInput!) {
releaseFromToken(input: $input) {
activityFeed {
edges {
...ReleaseActionConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
affiliates {
edges {
...ReleaseAffiliateConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
airdropCount
animatedCoverImage {
bucket
dominantColor
id
key
url
}
animatedGoldenEggImageOptimized {
bucket
dominantColor
id
key
url
}
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
auctionContractType
auctionType
baseMetadataAttributes {
traitType
value
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
edges {
...ReleaseCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
collectorsCount
contract {
contractAddress
contractType
createdAt
id
owner {
...UserFragment
}
ownerPublicAddress
updatedAt
}
contractAddress
coverImage {
bucket
dominantColor
id
key
url
}
createdAt
creditSplit {
creditAllocations {
...CreditAllocationFragment
}
id
mintedReleases {
...ReleaseFragment
}
releases {
...ReleaseFragment
}
splitAddress
}
credits {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
draftId
earliestCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
editionId
eggGame {
animatedGoldenEggImageOptimized {
...MediaFragment
}
finalSerialBlockHash
goldenEggImage {
...MediaFragment
}
id
nft {
...NftFragment
}
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
bucket
dominantColor
id
key
url
}
gaCoverImage {
bucket
dominantColor
id
key
url
}
genre {
createdAt
id
name
updatedAt
}
goldenEggImage {
bucket
dominantColor
id
key
url
}
goldenEggNft {
audioUrl
collectorRelease {
...ReleaseCollectorFragment
}
comment {
...CommentFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
createdAtBlockTime
id
isBurned
isGoldenEgg
openSeaMetadataAttributes {
...OpenSeaMetadataAttributeFragment
}
owner {
...UserFragment
}
release {
...ReleaseFragment
}
serialNumber
songSlot
tierNumber
title
tokenId
updatedAt
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
likedBy {
edges {
...UserConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
listeningParty
listing {
chain
contractAddress
id
}
marketPlaceUrl
metadataDetails {
bpm
key
license
location
lyrics
}
mintStartTime
mintStartTimestamp
nftsPaginated {
edges {
...NftConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
description
id
title
}
royaltyBps
saleDetails {
primaryCollected
primaryRaisedInWei
soundSwapCollected
soundSwapRaisedInWei
totalVolume
}
saleSchedules {
affiliateFeeBPS
affiliateFeePercent
artistContractTotalMinted
endTime
id
isPresale
maxMintable
merkleTreeRoot
mintId
minterAddress
price
startTime
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
affiliateFeeBPS
affiliateFeePercent
artistFeeBPS
artistFeePercent
basePrice
buyFreezeTime
goldenEggFeeBPS
goldenEggFeePercent
id
inflectionPoint
inflectionPrice
maxSupply
platformFeeBPS
platformPerTxFlatFee
samAddress
}
samSellBufferBpsOverride
scheduleIds {
mintIds
minterAddress
}
season
shelves {
edges {
...ShelfConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
socialProofCollectors {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
bucket
dominantColor
id
key
url
}
staticGaCoverImage {
bucket
dominantColor
id
key
url
}
staticVipCoverImage {
bucket
dominantColor
id
key
url
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
firstNftCollectedDate
lowestNftSerialNumber
nftsCount
position
user {
...UserFragment
}
}
topPosts {
authorChannelRole
channel {
...ChannelFragment
}
commentCount
comments {
...PostCommentConnectionFragment
}
content
createdAt
creator {
...UserFragment
}
farcasterHash
id
lexicalContent
repostCount
upvoteCount
webappUri
}
topSpentCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
totalMinted
totalSupply
track {
audio {
...AudioMediaFragment
}
audioOriginal {
...MediaFragment
}
duration
id
normalizedPeaks
release {
...ReleaseFragment
}
releaseId
title
trackNumber
}
type
vipAnimatedCoverImage {
bucket
dominantColor
id
key
url
}
vipCoverImage {
bucket
dominantColor
id
key
url
}
webEmbed
webappUri
}
}
Variables
{"input": ReleaseFromTokenInput}
Response
{
"data": {
"releaseFromToken": {
"activityFeed": ReleaseActionConnection,
"affiliates": ReleaseAffiliateConnection,
"airdropCount": 123,
"animatedCoverImage": Media,
"animatedGoldenEggImageOptimized": Media,
"artist": Artist,
"auctionContractType": "ARTIST",
"auctionType": "FIXED_QUANTITY",
"baseMetadataAttributes": [MetadataAttribute],
"behindTheMusic": "abc123",
"canCollectorsDownloadAudio": false,
"chainId": 987,
"collectors": ReleaseCollectorConnection,
"collectorsCount": 123,
"contract": Contract,
"contractAddress": "abc123",
"coverImage": Media,
"createdAt": "2007-12-03T10:15:30Z",
"creditSplit": CreditSplit,
"credits": [User],
"draftId": "xyz789",
"earliestCollector": ReleaseCollector,
"editionId": "abc123",
"eggGame": EggGame,
"externalUrl": "abc123",
"finalQuantity": 123,
"fundingAddress": "abc123",
"gaAnimatedCoverImage": Media,
"gaCoverImage": Media,
"genre": Genre,
"goldenEggImage": Media,
"goldenEggNft": Nft,
"id": 4,
"isAuctionSoldOut": false,
"isFirstPhaseCompleted": true,
"lastUpdatedAt": "2007-12-03T10:15:30Z",
"latestCollector": ReleaseCollector,
"likedBy": UserConnection,
"listeningParty": 1592577642,
"listing": AuctionListingInterface,
"marketPlaceUrl": "abc123",
"metadataDetails": MetadataDetails,
"mintStartTime": 123,
"mintStartTimestamp": 1592577642,
"nftsPaginated": NftConnection,
"numSold": 123,
"openseaUrl": "abc123",
"postCount": 123,
"price": "xyz789",
"publicAffiliateFeeBPS": 123,
"publicAffiliateFeePercent": "xyz789",
"publicMintStart": "2007-12-03T10:15:30Z",
"quantity": 987,
"quantityLowerBound": 987,
"quantityUpperBound": 123,
"rewards": [Reward],
"royaltyBps": 123,
"saleDetails": SaleDetails,
"saleSchedules": [SaleSchedule],
"salesAffiliateFeesPercent": [
"xyz789"
],
"samAddress": "abc123",
"samBuyBufferBpsOverride": 987,
"samConfig": SamConfig,
"samSellBufferBpsOverride": 123,
"scheduleIds": [ScheduleIdentifier],
"season": "abc123",
"shelves": ShelfConnection,
"socialProofCollectors": [User],
"spotifyPresaveCampaign": false,
"spotifyPresaveCount": 123,
"spotifyTrackId": "abc123",
"staticCoverImage": Media,
"staticGaCoverImage": Media,
"staticVipCoverImage": Media,
"supplyCutoffTimestamp": 1592577642,
"title": "xyz789",
"titleSlug": "xyz789",
"topCollectors": [TopReleaseCollector],
"topPosts": [Post],
"topSpentCollector": ReleaseCollector,
"totalMinted": 123,
"totalSupply": 987,
"track": Track,
"type": "ALBUM",
"vipAnimatedCoverImage": Media,
"vipCoverImage": Media,
"webEmbed": "xyz789",
"webappUri": "abc123"
}
}
}
releaseGenres
Description
[PUBLIC] List of genres that have at least 1 release
Response
Returns
[Genre!]!
Example
Query
query ReleaseGenres {
releaseGenres {
createdAt
id
name
updatedAt
}
}
Response
{
"data": {
"releaseGenres": [
{
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"name": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
releasePosts
Description
posts related to the release
Response
Returns a
PostConnection!
Arguments
| Name | Description |
|---|---|
pagination -
PostCursorConnectionArgs!
|
Pagination parameters. Default = {after: null, first: 10, sort: {createdAt: DESC}} |
releaseId -
UUID!
|
Release identifier |
Example
Query
query ReleasePosts(
$pagination: PostCursorConnectionArgs!,
$releaseId: UUID!
) {
releasePosts(
pagination: $pagination,
releaseId: $releaseId
) {
edges {
cursor
node {
...PostFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"pagination": {"after": "null", "first": 10, "sort": {"createdAt": "DESC"}},
"releaseId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"releasePosts": {
"edges": [PostConnectionEdge],
"pageInfo": PageInfo
}
}
}
releaseTotalAffiliatePurchases
Description
[AUTHENTICATED] Total affiliate purchases of specific release of authenticated user
Response
Returns a
ReleaseAffiliateTotalPurchases
Arguments
| Name | Description |
|---|---|
releaseId -
UUID!
|
Unique release identifier |
Example
Query
query ReleaseTotalAffiliatePurchases($releaseId: UUID!) {
releaseTotalAffiliatePurchases(releaseId: $releaseId) {
affiliate {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
earningsETH
earningsWei
id
purchasesQuantity
referredCollectors {
edges {
...ReleaseReferredCollectorEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
release {
activityFeed {
...ReleaseActionConnectionFragment
}
affiliates {
...ReleaseAffiliateConnectionFragment
}
airdropCount
animatedCoverImage {
...MediaFragment
}
animatedGoldenEggImageOptimized {
...MediaFragment
}
artist {
...ArtistFragment
}
auctionContractType
auctionType
baseMetadataAttributes {
...MetadataAttributeFragment
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
...ReleaseCollectorConnectionFragment
}
collectorsCount
contract {
...ContractFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
creditSplit {
...CreditSplitFragment
}
credits {
...UserFragment
}
draftId
earliestCollector {
...ReleaseCollectorFragment
}
editionId
eggGame {
...EggGameFragment
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
...MediaFragment
}
gaCoverImage {
...MediaFragment
}
genre {
...GenreFragment
}
goldenEggImage {
...MediaFragment
}
goldenEggNft {
...NftFragment
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
...ReleaseCollectorFragment
}
likedBy {
...UserConnectionFragment
}
listeningParty
listing {
...AuctionListingInterfaceFragment
}
marketPlaceUrl
metadataDetails {
...MetadataDetailsFragment
}
mintStartTime
mintStartTimestamp
nftsPaginated {
...NftConnectionFragment
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
...RewardFragment
}
royaltyBps
saleDetails {
...SaleDetailsFragment
}
saleSchedules {
...SaleScheduleFragment
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
...SamConfigFragment
}
samSellBufferBpsOverride
scheduleIds {
...ScheduleIdentifierFragment
}
season
shelves {
...ShelfConnectionFragment
}
socialProofCollectors {
...UserFragment
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
...MediaFragment
}
staticGaCoverImage {
...MediaFragment
}
staticVipCoverImage {
...MediaFragment
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
...TopReleaseCollectorFragment
}
topPosts {
...PostFragment
}
topSpentCollector {
...ReleaseCollectorFragment
}
totalMinted
totalSupply
track {
...TrackFragment
}
type
vipAnimatedCoverImage {
...MediaFragment
}
vipCoverImage {
...MediaFragment
}
webEmbed
webappUri
}
}
}
Variables
{
"releaseId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"releaseTotalAffiliatePurchases": {
"affiliate": User,
"earningsETH": "xyz789",
"earningsWei": "xyz789",
"id": 4,
"purchasesQuantity": 987,
"referredCollectors": ReleaseReferredCollectorConnection,
"release": Release
}
}
}
releaseWaveformPosts
Description
posts on release waveform
Response
Arguments
| Name | Description |
|---|---|
releaseId -
UUID!
|
Release id |
Example
Query
query ReleaseWaveformPosts($releaseId: UUID!) {
releaseWaveformPosts(releaseId: $releaseId) {
content
gaNftsCount
id
lexicalContent
nftsCount
postId
songSlot
updatedAt
user {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
vipNftsCount
}
}
Variables
{
"releaseId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"releaseWaveformPosts": [
{
"content": "xyz789",
"gaNftsCount": 987,
"id": 4,
"lexicalContent": {},
"nftsCount": 123,
"postId": 4,
"songSlot": 123,
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"vipNftsCount": 987
}
]
}
}
releases
Description
[PUBLIC] Get all releases
Response
Returns a
ReleaseConnection!
Arguments
| Name | Description |
|---|---|
filter -
ReleasesCursorFilterArgs
|
Filter releases |
pagination -
ReleasesCursorConnectionArgs!
|
Pagination parameters. Default = {first: 10, sort: {mintStartTime: DESC}} |
Example
Query
query Releases(
$filter: ReleasesCursorFilterArgs,
$pagination: ReleasesCursorConnectionArgs!
) {
releases(
filter: $filter,
pagination: $pagination
) {
edges {
cursor
node {
...ReleaseFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"filter": ReleasesCursorFilterArgs,
"pagination": {"first": 10, "sort": {"mintStartTime": "DESC"}}
}
Response
{
"data": {
"releases": {
"edges": [ReleaseConnectionEdge],
"pageInfo": PageInfo
}
}
}
releasesCollectorsAlsoMinted
Description
[PUBLIC] Get all releases that collectors of a given release have also minted
Response
Returns
[Release!]!
Arguments
| Name | Description |
|---|---|
releaseId -
UUID!
|
Identifier of release |
Example
Query
query ReleasesCollectorsAlsoMinted($releaseId: UUID!) {
releasesCollectorsAlsoMinted(releaseId: $releaseId) {
activityFeed {
edges {
...ReleaseActionConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
affiliates {
edges {
...ReleaseAffiliateConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
airdropCount
animatedCoverImage {
bucket
dominantColor
id
key
url
}
animatedGoldenEggImageOptimized {
bucket
dominantColor
id
key
url
}
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
auctionContractType
auctionType
baseMetadataAttributes {
traitType
value
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
edges {
...ReleaseCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
collectorsCount
contract {
contractAddress
contractType
createdAt
id
owner {
...UserFragment
}
ownerPublicAddress
updatedAt
}
contractAddress
coverImage {
bucket
dominantColor
id
key
url
}
createdAt
creditSplit {
creditAllocations {
...CreditAllocationFragment
}
id
mintedReleases {
...ReleaseFragment
}
releases {
...ReleaseFragment
}
splitAddress
}
credits {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
draftId
earliestCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
editionId
eggGame {
animatedGoldenEggImageOptimized {
...MediaFragment
}
finalSerialBlockHash
goldenEggImage {
...MediaFragment
}
id
nft {
...NftFragment
}
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
bucket
dominantColor
id
key
url
}
gaCoverImage {
bucket
dominantColor
id
key
url
}
genre {
createdAt
id
name
updatedAt
}
goldenEggImage {
bucket
dominantColor
id
key
url
}
goldenEggNft {
audioUrl
collectorRelease {
...ReleaseCollectorFragment
}
comment {
...CommentFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
createdAtBlockTime
id
isBurned
isGoldenEgg
openSeaMetadataAttributes {
...OpenSeaMetadataAttributeFragment
}
owner {
...UserFragment
}
release {
...ReleaseFragment
}
serialNumber
songSlot
tierNumber
title
tokenId
updatedAt
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
likedBy {
edges {
...UserConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
listeningParty
listing {
chain
contractAddress
id
}
marketPlaceUrl
metadataDetails {
bpm
key
license
location
lyrics
}
mintStartTime
mintStartTimestamp
nftsPaginated {
edges {
...NftConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
description
id
title
}
royaltyBps
saleDetails {
primaryCollected
primaryRaisedInWei
soundSwapCollected
soundSwapRaisedInWei
totalVolume
}
saleSchedules {
affiliateFeeBPS
affiliateFeePercent
artistContractTotalMinted
endTime
id
isPresale
maxMintable
merkleTreeRoot
mintId
minterAddress
price
startTime
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
affiliateFeeBPS
affiliateFeePercent
artistFeeBPS
artistFeePercent
basePrice
buyFreezeTime
goldenEggFeeBPS
goldenEggFeePercent
id
inflectionPoint
inflectionPrice
maxSupply
platformFeeBPS
platformPerTxFlatFee
samAddress
}
samSellBufferBpsOverride
scheduleIds {
mintIds
minterAddress
}
season
shelves {
edges {
...ShelfConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
socialProofCollectors {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
bucket
dominantColor
id
key
url
}
staticGaCoverImage {
bucket
dominantColor
id
key
url
}
staticVipCoverImage {
bucket
dominantColor
id
key
url
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
firstNftCollectedDate
lowestNftSerialNumber
nftsCount
position
user {
...UserFragment
}
}
topPosts {
authorChannelRole
channel {
...ChannelFragment
}
commentCount
comments {
...PostCommentConnectionFragment
}
content
createdAt
creator {
...UserFragment
}
farcasterHash
id
lexicalContent
repostCount
upvoteCount
webappUri
}
topSpentCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
totalMinted
totalSupply
track {
audio {
...AudioMediaFragment
}
audioOriginal {
...MediaFragment
}
duration
id
normalizedPeaks
release {
...ReleaseFragment
}
releaseId
title
trackNumber
}
type
vipAnimatedCoverImage {
bucket
dominantColor
id
key
url
}
vipCoverImage {
bucket
dominantColor
id
key
url
}
webEmbed
webappUri
}
}
Variables
{
"releaseId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"releasesCollectorsAlsoMinted": [
{
"activityFeed": ReleaseActionConnection,
"affiliates": ReleaseAffiliateConnection,
"airdropCount": 987,
"animatedCoverImage": Media,
"animatedGoldenEggImageOptimized": Media,
"artist": Artist,
"auctionContractType": "ARTIST",
"auctionType": "FIXED_QUANTITY",
"baseMetadataAttributes": [MetadataAttribute],
"behindTheMusic": "abc123",
"canCollectorsDownloadAudio": true,
"chainId": 987,
"collectors": ReleaseCollectorConnection,
"collectorsCount": 987,
"contract": Contract,
"contractAddress": "xyz789",
"coverImage": Media,
"createdAt": "2007-12-03T10:15:30Z",
"creditSplit": CreditSplit,
"credits": [User],
"draftId": "xyz789",
"earliestCollector": ReleaseCollector,
"editionId": "abc123",
"eggGame": EggGame,
"externalUrl": "abc123",
"finalQuantity": 123,
"fundingAddress": "xyz789",
"gaAnimatedCoverImage": Media,
"gaCoverImage": Media,
"genre": Genre,
"goldenEggImage": Media,
"goldenEggNft": Nft,
"id": 4,
"isAuctionSoldOut": true,
"isFirstPhaseCompleted": false,
"lastUpdatedAt": "2007-12-03T10:15:30Z",
"latestCollector": ReleaseCollector,
"likedBy": UserConnection,
"listeningParty": 1592577642,
"listing": AuctionListingInterface,
"marketPlaceUrl": "xyz789",
"metadataDetails": MetadataDetails,
"mintStartTime": 987,
"mintStartTimestamp": 1592577642,
"nftsPaginated": NftConnection,
"numSold": 987,
"openseaUrl": "xyz789",
"postCount": 123,
"price": "xyz789",
"publicAffiliateFeeBPS": 123,
"publicAffiliateFeePercent": "abc123",
"publicMintStart": "2007-12-03T10:15:30Z",
"quantity": 123,
"quantityLowerBound": 123,
"quantityUpperBound": 987,
"rewards": [Reward],
"royaltyBps": 987,
"saleDetails": SaleDetails,
"saleSchedules": [SaleSchedule],
"salesAffiliateFeesPercent": [
"xyz789"
],
"samAddress": "xyz789",
"samBuyBufferBpsOverride": 987,
"samConfig": SamConfig,
"samSellBufferBpsOverride": 987,
"scheduleIds": [ScheduleIdentifier],
"season": "abc123",
"shelves": ShelfConnection,
"socialProofCollectors": [User],
"spotifyPresaveCampaign": true,
"spotifyPresaveCount": 987,
"spotifyTrackId": "xyz789",
"staticCoverImage": Media,
"staticGaCoverImage": Media,
"staticVipCoverImage": Media,
"supplyCutoffTimestamp": 1592577642,
"title": "xyz789",
"titleSlug": "xyz789",
"topCollectors": [TopReleaseCollector],
"topPosts": [Post],
"topSpentCollector": ReleaseCollector,
"totalMinted": 123,
"totalSupply": 123,
"track": Track,
"type": "ALBUM",
"vipAnimatedCoverImage": Media,
"vipCoverImage": Media,
"webEmbed": "abc123",
"webappUri": "xyz789"
}
]
}
}
search
Description
[PUBLIC] Search releases or artists based on text inputs
Response
Returns a
SearchResult!
Arguments
| Name | Description |
|---|---|
input -
SearchInput!
|
Search text input |
Example
Query
query Search($input: SearchInput!) {
search(input: $input) {
artistsPaginated {
edges {
...ArtistConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
collectors {
edges {
...UserConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
id
releasesPaginated {
edges {
...ReleaseConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
shelves {
edges {
...ShelfConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
}
}
Variables
{"input": SearchInput}
Response
{
"data": {
"search": {
"artistsPaginated": ArtistConnection,
"collectors": UserConnection,
"id": 4,
"releasesPaginated": ReleaseConnection,
"shelves": ShelfConnection
}
}
}
seasonDefaultMintingOptions
Description
[ADMIN | ARTIST_RELATIONS] Get default reference season-based auction options
Response
Returns a
SeasonDefaultOptions!
Arguments
| Name | Description |
|---|---|
seasonName -
String!
|
Season for default minting options |
Example
Query
query SeasonDefaultMintingOptions($seasonName: String!) {
seasonDefaultMintingOptions(seasonName: $seasonName) {
auction
}
}
Variables
{"seasonName": "abc123"}
Response
{
"data": {
"seasonDefaultMintingOptions": {
"auction": [FixedAuction]
}
}
}
shelf
Description
[PUBLIC] Get specified shelf by id
Example
Query
query Shelf($id: UUID!) {
shelf(id: $id) {
affiliateBuyers {
edges {
...PlaylistAffiliateBuyerConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
coverImage {
bucket
dominantColor
id
key
url
}
coverReleases {
activityFeed {
...ReleaseActionConnectionFragment
}
affiliates {
...ReleaseAffiliateConnectionFragment
}
airdropCount
animatedCoverImage {
...MediaFragment
}
animatedGoldenEggImageOptimized {
...MediaFragment
}
artist {
...ArtistFragment
}
auctionContractType
auctionType
baseMetadataAttributes {
...MetadataAttributeFragment
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
...ReleaseCollectorConnectionFragment
}
collectorsCount
contract {
...ContractFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
creditSplit {
...CreditSplitFragment
}
credits {
...UserFragment
}
draftId
earliestCollector {
...ReleaseCollectorFragment
}
editionId
eggGame {
...EggGameFragment
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
...MediaFragment
}
gaCoverImage {
...MediaFragment
}
genre {
...GenreFragment
}
goldenEggImage {
...MediaFragment
}
goldenEggNft {
...NftFragment
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
...ReleaseCollectorFragment
}
likedBy {
...UserConnectionFragment
}
listeningParty
listing {
...AuctionListingInterfaceFragment
}
marketPlaceUrl
metadataDetails {
...MetadataDetailsFragment
}
mintStartTime
mintStartTimestamp
nftsPaginated {
...NftConnectionFragment
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
...RewardFragment
}
royaltyBps
saleDetails {
...SaleDetailsFragment
}
saleSchedules {
...SaleScheduleFragment
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
...SamConfigFragment
}
samSellBufferBpsOverride
scheduleIds {
...ScheduleIdentifierFragment
}
season
shelves {
...ShelfConnectionFragment
}
socialProofCollectors {
...UserFragment
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
...MediaFragment
}
staticGaCoverImage {
...MediaFragment
}
staticVipCoverImage {
...MediaFragment
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
...TopReleaseCollectorFragment
}
topPosts {
...PostFragment
}
topSpentCollector {
...ReleaseCollectorFragment
}
totalMinted
totalSupply
track {
...TrackFragment
}
type
vipAnimatedCoverImage {
...MediaFragment
}
vipCoverImage {
...MediaFragment
}
webEmbed
webappUri
}
createdAt
deletedAt
description
extendedFrom {
affiliateBuyers {
...PlaylistAffiliateBuyerConnectionFragment
}
coverImage {
...MediaFragment
}
coverReleases {
...ReleaseFragment
}
createdAt
deletedAt
description
extendedFrom {
...ShelfFragment
}
id
index
likedBy {
...UserConnectionFragment
}
likes
linkSlug
name
numLikes
numReferralPurchases
numUsersReferred
orderedReleases {
...ShelfReleaseConnectionFragment
}
playTimeInSeconds
previewReleases {
...ShelfReleaseFragment
}
releaseCount
releaseIds
socialProofReferrals {
...UserFragment
}
trackIds
type
user {
...UserFragment
}
webEmbed
webappUri
}
id
index
likedBy {
edges {
...UserConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
likes
linkSlug
name
numLikes
numReferralPurchases
numUsersReferred
orderedReleases {
edges {
...ShelfReleaseConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
playTimeInSeconds
previewReleases {
addedAt
id
index
ownedFirstNft {
...NftFragment
}
ownedGoldenEgg {
...EggGameFragment
}
ownedTokens {
...OwnedTokenFragment
}
release {
...ReleaseFragment
}
}
releaseCount
releaseIds
socialProofReferrals {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
trackIds
type
user {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
webEmbed
webappUri
}
}
Variables
{
"id": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"shelf": {
"affiliateBuyers": PlaylistAffiliateBuyerConnection,
"coverImage": Media,
"coverReleases": [Release],
"createdAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"extendedFrom": [Shelf],
"id": 4,
"index": 123,
"likedBy": UserConnection,
"likes": 987,
"linkSlug": "abc123",
"name": "abc123",
"numLikes": 987,
"numReferralPurchases": 123,
"numUsersReferred": 123,
"orderedReleases": ShelfReleaseConnection,
"playTimeInSeconds": 123,
"previewReleases": [ShelfRelease],
"releaseCount": 987,
"releaseIds": ["xyz789"],
"socialProofReferrals": [User],
"trackIds": ["xyz789"],
"type": "DEFAULT",
"user": User,
"webEmbed": "xyz789",
"webappUri": "abc123"
}
}
}
shouldDeployNewSplit
Description
[ARTIST] Check if draft splitInfo matches already deployed credit split for specified draft
Response
Returns a
QueryShouldDeployNewSplitResult!
Arguments
| Name | Description |
|---|---|
draftId -
UUID!
|
Draft identifier |
Example
Query
query ShouldDeployNewSplit($draftId: UUID!) {
shouldDeployNewSplit(draftId: $draftId)
}
Variables
{
"draftId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{"data": {"shouldDeployNewSplit": NotFoundError}}
signedUploadParams
Description
[AUTHENTICATED] Request media upload
Response
Returns an
AWSPresignedPost!
Arguments
| Name | Description |
|---|---|
uploadRequest -
UploadRequest!
|
Upload request information |
Example
Query
query SignedUploadParams($uploadRequest: UploadRequest!) {
signedUploadParams(uploadRequest: $uploadRequest) {
fields
uploadKey
url
}
}
Variables
{"uploadRequest": UploadRequest}
Response
{
"data": {
"signedUploadParams": {
"fields": {},
"uploadKey": "abc123",
"url": "xyz789"
}
}
}
spotifyConnection
Description
[AUTHENTICATED] Returns the user's Spotify authorization connection basic information if available
Response
Returns a
SpotifyAuthConnection
Example
Query
query SpotifyConnection {
spotifyConnection {
createdAt
id
lastValidationAt
spotifyUserId
}
}
Response
{
"data": {
"spotifyConnection": {
"createdAt": "2007-12-03T10:15:30Z",
"id": 4,
"lastValidationAt": "2007-12-03T10:15:30Z",
"spotifyUserId": "xyz789"
}
}
}
stats
Description
[ADMIN | ARTIST_RELATIONS] Get basic stats
Response
Returns a
Stats!
Example
Query
query Stats {
stats {
totalArtists
totalUniqueCollectors
totalUsers
}
}
Response
{
"data": {
"stats": {
"totalArtists": 123.45,
"totalUniqueCollectors": 987.65,
"totalUsers": 987.65
}
}
}
tieredDraftMetadataUploadAsyncStatus
Description
[ARTIST] Check status of async tieredDraftMetadataUploadAsync
Response
Arguments
| Name | Description |
|---|---|
tieredDraftMetadataUploadAsyncRequestId -
String!
|
Async request ID |
Example
Query
query TieredDraftMetadataUploadAsyncStatus($tieredDraftMetadataUploadAsyncRequestId: String!) {
tieredDraftMetadataUploadAsyncStatus(tieredDraftMetadataUploadAsyncRequestId: $tieredDraftMetadataUploadAsyncRequestId)
}
Variables
{
"tieredDraftMetadataUploadAsyncRequestId": "xyz789"
}
Response
{
"data": {
"tieredDraftMetadataUploadAsyncStatus": NotFoundError
}
}
topAffiliateCurators
Description
[PUBLIC] Top affiliate curators list
Response
Returns
[AffiliateCurator!]!
Arguments
| Name | Description |
|---|---|
input -
TopAffiliateCuratorsInput!
|
Input for top curators information |
Example
Query
query TopAffiliateCurators($input: TopAffiliateCuratorsInput!) {
topAffiliateCurators(input: $input) {
affiliateEarned
mintsQuantity
soundsReferred
totalVolume
user {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
}
}
Variables
{"input": TopAffiliateCuratorsInput}
Response
{
"data": {
"topAffiliateCurators": [
{
"affiliateEarned": "abc123",
"mintsQuantity": 987,
"soundsReferred": 987,
"totalVolume": "xyz789",
"user": User
}
]
}
}
topArtistsV2
Description
[PUBLIC] Get top artists
Response
Returns
[TrendingArtistInfo!]!
Arguments
| Name | Description |
|---|---|
input -
TopArtistsInput!
|
Input for top artists query |
Example
Query
query TopArtistsV2($input: TopArtistsInput!) {
topArtistsV2(input: $input) {
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
artistId
nftsSold
primarySales
primarySalesUsd
secondarySales
secondarySalesUsd
totalSales
totalSalesUsd
uniqueCollectors
}
}
Variables
{"input": TopArtistsInput}
Response
{
"data": {
"topArtistsV2": [
{
"artist": Artist,
"artistId": 4,
"nftsSold": 987,
"primarySales": "xyz789",
"primarySalesUsd": 123.45,
"secondarySales": "xyz789",
"secondarySalesUsd": 987.65,
"totalSales": "xyz789",
"totalSalesUsd": 987.65,
"uniqueCollectors": 987
}
]
}
}
topCollectorsV2
Description
[PUBLIC] Get top collectors information based on currently owned NFTs
Response
Returns
[TrendingCollectorInfo!]!
Arguments
| Name | Description |
|---|---|
limit -
PositiveInt!
|
Limit the amount to be returned, Up to 100. Default = 100 |
sort -
TrendingCollectorsSortEnum!
|
Sort logic used |
timePeriod -
TopChartTimePeriodEnum!
|
For what time period the data should come from |
Example
Query
query TopCollectorsV2(
$limit: PositiveInt!,
$sort: TrendingCollectorsSortEnum!,
$timePeriod: TopChartTimePeriodEnum!
) {
topCollectorsV2(
limit: $limit,
sort: $sort,
timePeriod: $timePeriod
) {
creatorsSupported
nftsBought
totalSpent
totalSpentUsd
user {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
userAddress
}
}
Variables
{"limit": 100, "sort": "CREATORS_SUPPORTED", "timePeriod": "ALL_TIME"}
Response
{
"data": {
"topCollectorsV2": [
{
"creatorsSupported": 987,
"nftsBought": 123,
"totalSpent": "abc123",
"totalSpentUsd": 987.65,
"user": User,
"userAddress": "abc123"
}
]
}
}
topPlaylists
Description
[PUBLIC] Get trending playlists
Response
Returns
[TrendingPlaylistInfo!]!
Arguments
| Name | Description |
|---|---|
input -
TopPlaylistsInput!
|
Input for trending playlists |
Example
Query
query TopPlaylists($input: TopPlaylistsInput!) {
topPlaylists(input: $input) {
numLikes
playlist {
affiliateBuyers {
...PlaylistAffiliateBuyerConnectionFragment
}
coverImage {
...MediaFragment
}
coverReleases {
...ReleaseFragment
}
createdAt
deletedAt
description
extendedFrom {
...ShelfFragment
}
id
index
likedBy {
...UserConnectionFragment
}
likes
linkSlug
name
numLikes
numReferralPurchases
numUsersReferred
orderedReleases {
...ShelfReleaseConnectionFragment
}
playTimeInSeconds
previewReleases {
...ShelfReleaseFragment
}
releaseCount
releaseIds
socialProofReferrals {
...UserFragment
}
trackIds
type
user {
...UserFragment
}
webEmbed
webappUri
}
}
}
Variables
{"input": TopPlaylistsInput}
Response
{
"data": {
"topPlaylists": [{"numLikes": 987, "playlist": Shelf}]
}
}
topReleases
Description
[PUBLIC] Get trending releases
Response
Returns
[TrendingReleaseInfo!]!
Arguments
| Name | Description |
|---|---|
sort -
TrendingReleasesSortEnum!
|
Sort logic used |
timePeriod -
TimePeriodAggEnum!
|
For what time period the data should come from |
Example
Query
query TopReleases(
$sort: TrendingReleasesSortEnum!,
$timePeriod: TimePeriodAggEnum!
) {
topReleases(
sort: $sort,
timePeriod: $timePeriod
) {
nftsSold
primarySales
primarySalesUsd
release {
activityFeed {
...ReleaseActionConnectionFragment
}
affiliates {
...ReleaseAffiliateConnectionFragment
}
airdropCount
animatedCoverImage {
...MediaFragment
}
animatedGoldenEggImageOptimized {
...MediaFragment
}
artist {
...ArtistFragment
}
auctionContractType
auctionType
baseMetadataAttributes {
...MetadataAttributeFragment
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
...ReleaseCollectorConnectionFragment
}
collectorsCount
contract {
...ContractFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
creditSplit {
...CreditSplitFragment
}
credits {
...UserFragment
}
draftId
earliestCollector {
...ReleaseCollectorFragment
}
editionId
eggGame {
...EggGameFragment
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
...MediaFragment
}
gaCoverImage {
...MediaFragment
}
genre {
...GenreFragment
}
goldenEggImage {
...MediaFragment
}
goldenEggNft {
...NftFragment
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
...ReleaseCollectorFragment
}
likedBy {
...UserConnectionFragment
}
listeningParty
listing {
...AuctionListingInterfaceFragment
}
marketPlaceUrl
metadataDetails {
...MetadataDetailsFragment
}
mintStartTime
mintStartTimestamp
nftsPaginated {
...NftConnectionFragment
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
...RewardFragment
}
royaltyBps
saleDetails {
...SaleDetailsFragment
}
saleSchedules {
...SaleScheduleFragment
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
...SamConfigFragment
}
samSellBufferBpsOverride
scheduleIds {
...ScheduleIdentifierFragment
}
season
shelves {
...ShelfConnectionFragment
}
socialProofCollectors {
...UserFragment
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
...MediaFragment
}
staticGaCoverImage {
...MediaFragment
}
staticVipCoverImage {
...MediaFragment
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
...TopReleaseCollectorFragment
}
topPosts {
...PostFragment
}
topSpentCollector {
...ReleaseCollectorFragment
}
totalMinted
totalSupply
track {
...TrackFragment
}
type
vipAnimatedCoverImage {
...MediaFragment
}
vipCoverImage {
...MediaFragment
}
webEmbed
webappUri
}
secondarySales
secondarySalesUsd
totalSales
totalSalesUsd
uniqueCollectors
}
}
Variables
{"sort": "NFTS_SOLD", "timePeriod": "ALL_TIME"}
Response
{
"data": {
"topReleases": [
{
"nftsSold": 987,
"primarySales": "xyz789",
"primarySalesUsd": 987.65,
"release": Release,
"secondarySales": "abc123",
"secondarySalesUsd": 987.65,
"totalSales": "xyz789",
"totalSalesUsd": 987.65,
"uniqueCollectors": 987
}
]
}
}
topTrendingPosts
Description
[PUBLIC] Top trending Post entities
Response
Returns
[Post!]!
Example
Query
query TopTrendingPosts {
topTrendingPosts {
authorChannelRole
channel {
animatedProfileImage {
...MediaFragment
}
coverImage {
...MediaFragment
}
createdAt
description
discordUrl
id
name
nameSlug
profileImage {
...MediaFragment
}
published
rules
staticProfileImage {
...MediaFragment
}
telegramUrl
tiktokUrl
twitterUrl
webappUri
websiteUrl
}
commentCount
comments {
edges {
...PostCommentConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
content
createdAt
creator {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
farcasterHash
id
lexicalContent
repostCount
upvoteCount
webappUri
}
}
Response
{
"data": {
"topTrendingPosts": [
{
"authorChannelRole": "MODERATOR",
"channel": Channel,
"commentCount": 987,
"comments": PostCommentConnection,
"content": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"creator": User,
"farcasterHash": "abc123",
"id": 4,
"lexicalContent": {},
"repostCount": 987,
"upvoteCount": 123,
"webappUri": "abc123"
}
]
}
}
totalAffiliatePurchases
Description
[AUTHENTICATED] Total affiliate purchases of authenticated user
Response
Arguments
| Name | Description |
|---|---|
input -
TotalAffiliatePurchasesInput!
|
Input for totalAffiliatePurchases. Default = {pagination: {after: null, first: 10, sort: {blockNumber: DESC}}} |
Example
Query
query TotalAffiliatePurchases($input: TotalAffiliatePurchasesInput!) {
totalAffiliatePurchases(input: $input) {
edges {
cursor
node {
...ReleaseAffiliateTotalPurchasesFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"input": {
"pagination": {
"after": "null",
"first": 10,
"sort": {"blockNumber": "DESC"}
}
}
}
Response
{
"data": {
"totalAffiliatePurchases": {
"edges": [ReleaseAffiliateTotalPurchasesEdge],
"pageInfo": PageInfo
}
}
}
totalRaisedPlatform
Description
[PUBLIC] Get total raised of the whole platform
Response
Returns a
TotalRaisedPlatform!
Example
Query
query TotalRaisedPlatform {
totalRaisedPlatform {
ethInWei
usd
}
}
Response
{
"data": {
"totalRaisedPlatform": {
"ethInWei": "xyz789",
"usd": 987.65
}
}
}
totalReleasesCount
Description
[PUBLIC] Total count of minted releases
Response
Returns an
Int!
Arguments
| Name | Description |
|---|---|
filter -
MintedReleasesCursorFilterArgs
|
Filter the releases to be counted |
Example
Query
query TotalReleasesCount($filter: MintedReleasesCursorFilterArgs) {
totalReleasesCount(filter: $filter)
}
Variables
{"filter": MintedReleasesCursorFilterArgs}
Response
{"data": {"totalReleasesCount": 123}}
track
Description
[PUBLIC] Get track by id
Example
Query
query Track($id: UUID!) {
track(id: $id) {
audio {
audio128k {
...MediaFragment
}
audio192k {
...MediaFragment
}
audio256k {
...MediaFragment
}
audioHls {
...MediaFragment
}
audioOriginal {
...MediaFragment
}
}
audioOriginal {
bucket
dominantColor
id
key
url
}
duration
id
normalizedPeaks
release {
activityFeed {
...ReleaseActionConnectionFragment
}
affiliates {
...ReleaseAffiliateConnectionFragment
}
airdropCount
animatedCoverImage {
...MediaFragment
}
animatedGoldenEggImageOptimized {
...MediaFragment
}
artist {
...ArtistFragment
}
auctionContractType
auctionType
baseMetadataAttributes {
...MetadataAttributeFragment
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
...ReleaseCollectorConnectionFragment
}
collectorsCount
contract {
...ContractFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
creditSplit {
...CreditSplitFragment
}
credits {
...UserFragment
}
draftId
earliestCollector {
...ReleaseCollectorFragment
}
editionId
eggGame {
...EggGameFragment
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
...MediaFragment
}
gaCoverImage {
...MediaFragment
}
genre {
...GenreFragment
}
goldenEggImage {
...MediaFragment
}
goldenEggNft {
...NftFragment
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
...ReleaseCollectorFragment
}
likedBy {
...UserConnectionFragment
}
listeningParty
listing {
...AuctionListingInterfaceFragment
}
marketPlaceUrl
metadataDetails {
...MetadataDetailsFragment
}
mintStartTime
mintStartTimestamp
nftsPaginated {
...NftConnectionFragment
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
...RewardFragment
}
royaltyBps
saleDetails {
...SaleDetailsFragment
}
saleSchedules {
...SaleScheduleFragment
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
...SamConfigFragment
}
samSellBufferBpsOverride
scheduleIds {
...ScheduleIdentifierFragment
}
season
shelves {
...ShelfConnectionFragment
}
socialProofCollectors {
...UserFragment
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
...MediaFragment
}
staticGaCoverImage {
...MediaFragment
}
staticVipCoverImage {
...MediaFragment
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
...TopReleaseCollectorFragment
}
topPosts {
...PostFragment
}
topSpentCollector {
...ReleaseCollectorFragment
}
totalMinted
totalSupply
track {
...TrackFragment
}
type
vipAnimatedCoverImage {
...MediaFragment
}
vipCoverImage {
...MediaFragment
}
webEmbed
webappUri
}
releaseId
title
trackNumber
}
}
Variables
{
"id": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"track": {
"audio": AudioMedia,
"audioOriginal": Media,
"duration": 987,
"id": 4,
"normalizedPeaks": [123],
"release": Release,
"releaseId": "4",
"title": "abc123",
"trackNumber": 123
}
}
}
trendingPostsPreview
Description
[PUBLIC] Preview of the current trending posts.
Response
Returns
[ActivityFeedGroup!]!
Example
Query
query TrendingPostsPreview {
trendingPostsPreview {
id
information
latestActivityOccurenceAt
rankingScore
}
}
Response
{
"data": {
"trendingPostsPreview": [
{
"id": "4",
"information": ReleaseDroppedAggregate,
"latestActivityOccurenceAt": 1592577642,
"rankingScore": 987
}
]
}
}
trendingPostsRecommendedFollows
Description
[PUBLIC] Returns follow suggestions based on trending posts
Response
Returns
[User!]!
Example
Query
query TrendingPostsRecommendedFollows {
trendingPostsRecommendedFollows {
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
avatar {
bucket
dominantColor
id
key
url
}
backedArtists {
edges {
...ArtistCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
bannerImage {
bucket
dominantColor
id
key
url
}
collectedReleases {
edges {
...CollectedReleaseConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
creditSplit {
...CreditSplitFragment
}
id
owner {
...UserFragment
}
percent
roles
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
firstNftOwned {
...NftFragment
}
gaNftsCount
goldenEgg {
...EggGameFragment
}
id
nftsCount
ownedTokens {
...OwnedTokenFragment
}
release {
...ReleaseFragment
}
tierPriority
vipNftsCount
}
followerCount
followers {
edges {
...UserRelationConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
following {
edges {
...UserRelationConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
followingCount
id
instagramHandle
invitedByUser {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
affiliateBuyers {
...PlaylistAffiliateBuyerConnectionFragment
}
coverImage {
...MediaFragment
}
coverReleases {
...ReleaseFragment
}
createdAt
deletedAt
description
extendedFrom {
...ShelfFragment
}
id
index
likedBy {
...UserConnectionFragment
}
likes
linkSlug
name
numLikes
numReferralPurchases
numUsersReferred
orderedReleases {
...ShelfReleaseConnectionFragment
}
playTimeInSeconds
previewReleases {
...ShelfReleaseFragment
}
releaseCount
releaseIds
socialProofReferrals {
...UserFragment
}
trackIds
type
user {
...UserFragment
}
webEmbed
webappUri
}
location {
label
placeId
}
nftsOwned
nftsPaginated {
edges {
...NftConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
nonce
numBackedArtists
postCount
publicAddress
roles {
isAdmin
isArtistRelations
}
shelves {
edges {
...ShelfConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
}
Response
{
"data": {
"trendingPostsRecommendedFollows": [
{
"artist": Artist,
"avatar": Media,
"backedArtists": ArtistCollectorConnection,
"bannerImage": Media,
"collectedReleases": CollectedReleaseConnection,
"collectedReleasesCount": 123,
"collectedReleasesIds": ["xyz789"],
"collectorPosition": 123,
"createdAt": "2007-12-03T10:15:30Z",
"creditAllocations": [CreditAllocation],
"delegateWalletAddress": "abc123",
"description": "xyz789",
"displayName": "abc123",
"email": "xyz789",
"ens": "xyz789",
"farcasterFid": "abc123",
"farcasterSignerConnected": false,
"featuredReleases": [CollectedRelease],
"followerCount": 123,
"followers": UserRelationConnection,
"following": UserRelationConnection,
"followingCount": 987,
"id": 4,
"instagramHandle": "abc123",
"invitedByUser": User,
"isTopNotableCollector": true,
"lastReferralWithdrawableBalance": "abc123",
"likedSounds": Shelf,
"location": GeoLocationPlaceGoogle,
"nftsOwned": 123,
"nftsPaginated": NftConnection,
"nonce": 987,
"numBackedArtists": 123,
"postCount": 987,
"publicAddress": "abc123",
"roles": UserRoles,
"shelves": ShelfConnection,
"shelvesCount": 123,
"showSplitsFeature": false,
"tiktokUrl": "xyz789",
"topCollectorPosition": 123,
"twitterHandle": "xyz789",
"username": "xyz789",
"verifiedNotificationEmail": "xyz789",
"webappUri": "abc123"
}
]
}
}
upvotedByUsersInUserNotification
Description
[AUTHENTICATED] Users who upvoted a post by notification group
Response
Returns a
UserConnection!
Arguments
| Name | Description |
|---|---|
pagination -
UserCursorConnectionArgs!
|
Pagination parameters. Default = {after: null, first: 20, sort: ASC} |
userNotificationId -
UUID!
|
NewFollower UserNotification ID |
Example
Query
query UpvotedByUsersInUserNotification(
$pagination: UserCursorConnectionArgs!,
$userNotificationId: UUID!
) {
upvotedByUsersInUserNotification(
pagination: $pagination,
userNotificationId: $userNotificationId
) {
edges {
cursor
node {
...UserFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"pagination": {"after": "null", "first": 20, "sort": "ASC"},
"userNotificationId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"upvotedByUsersInUserNotification": {
"edges": [UserConnectionEdge],
"pageInfo": PageInfo
}
}
}
user
Description
[PUBLIC] Get specified user by id
Example
Query
query User($id: UUID!) {
user(id: $id) {
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
avatar {
bucket
dominantColor
id
key
url
}
backedArtists {
edges {
...ArtistCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
bannerImage {
bucket
dominantColor
id
key
url
}
collectedReleases {
edges {
...CollectedReleaseConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
creditSplit {
...CreditSplitFragment
}
id
owner {
...UserFragment
}
percent
roles
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
firstNftOwned {
...NftFragment
}
gaNftsCount
goldenEgg {
...EggGameFragment
}
id
nftsCount
ownedTokens {
...OwnedTokenFragment
}
release {
...ReleaseFragment
}
tierPriority
vipNftsCount
}
followerCount
followers {
edges {
...UserRelationConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
following {
edges {
...UserRelationConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
followingCount
id
instagramHandle
invitedByUser {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
affiliateBuyers {
...PlaylistAffiliateBuyerConnectionFragment
}
coverImage {
...MediaFragment
}
coverReleases {
...ReleaseFragment
}
createdAt
deletedAt
description
extendedFrom {
...ShelfFragment
}
id
index
likedBy {
...UserConnectionFragment
}
likes
linkSlug
name
numLikes
numReferralPurchases
numUsersReferred
orderedReleases {
...ShelfReleaseConnectionFragment
}
playTimeInSeconds
previewReleases {
...ShelfReleaseFragment
}
releaseCount
releaseIds
socialProofReferrals {
...UserFragment
}
trackIds
type
user {
...UserFragment
}
webEmbed
webappUri
}
location {
label
placeId
}
nftsOwned
nftsPaginated {
edges {
...NftConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
nonce
numBackedArtists
postCount
publicAddress
roles {
isAdmin
isArtistRelations
}
shelves {
edges {
...ShelfConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
}
Variables
{
"id": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"user": {
"artist": Artist,
"avatar": Media,
"backedArtists": ArtistCollectorConnection,
"bannerImage": Media,
"collectedReleases": CollectedReleaseConnection,
"collectedReleasesCount": 123,
"collectedReleasesIds": ["abc123"],
"collectorPosition": 987,
"createdAt": "2007-12-03T10:15:30Z",
"creditAllocations": [CreditAllocation],
"delegateWalletAddress": "abc123",
"description": "abc123",
"displayName": "xyz789",
"email": "xyz789",
"ens": "abc123",
"farcasterFid": "xyz789",
"farcasterSignerConnected": false,
"featuredReleases": [CollectedRelease],
"followerCount": 123,
"followers": UserRelationConnection,
"following": UserRelationConnection,
"followingCount": 123,
"id": "4",
"instagramHandle": "xyz789",
"invitedByUser": User,
"isTopNotableCollector": true,
"lastReferralWithdrawableBalance": "abc123",
"likedSounds": Shelf,
"location": GeoLocationPlaceGoogle,
"nftsOwned": 123,
"nftsPaginated": NftConnection,
"nonce": 123,
"numBackedArtists": 987,
"postCount": 987,
"publicAddress": "xyz789",
"roles": UserRoles,
"shelves": ShelfConnection,
"shelvesCount": 123,
"showSplitsFeature": false,
"tiktokUrl": "abc123",
"topCollectorPosition": 987,
"twitterHandle": "abc123",
"username": "xyz789",
"verifiedNotificationEmail": "abc123",
"webappUri": "abc123"
}
}
}
userByAddress
Description
[PUBLIC] Get specified user by public address or ens, if both args provided mismatch, returns null
Response
Returns a
User
Example
Query
query UserByAddress(
$ens: ENS,
$publicAddress: Address
) {
userByAddress(
ens: $ens,
publicAddress: $publicAddress
) {
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
avatar {
bucket
dominantColor
id
key
url
}
backedArtists {
edges {
...ArtistCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
bannerImage {
bucket
dominantColor
id
key
url
}
collectedReleases {
edges {
...CollectedReleaseConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
creditSplit {
...CreditSplitFragment
}
id
owner {
...UserFragment
}
percent
roles
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
firstNftOwned {
...NftFragment
}
gaNftsCount
goldenEgg {
...EggGameFragment
}
id
nftsCount
ownedTokens {
...OwnedTokenFragment
}
release {
...ReleaseFragment
}
tierPriority
vipNftsCount
}
followerCount
followers {
edges {
...UserRelationConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
following {
edges {
...UserRelationConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
followingCount
id
instagramHandle
invitedByUser {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
affiliateBuyers {
...PlaylistAffiliateBuyerConnectionFragment
}
coverImage {
...MediaFragment
}
coverReleases {
...ReleaseFragment
}
createdAt
deletedAt
description
extendedFrom {
...ShelfFragment
}
id
index
likedBy {
...UserConnectionFragment
}
likes
linkSlug
name
numLikes
numReferralPurchases
numUsersReferred
orderedReleases {
...ShelfReleaseConnectionFragment
}
playTimeInSeconds
previewReleases {
...ShelfReleaseFragment
}
releaseCount
releaseIds
socialProofReferrals {
...UserFragment
}
trackIds
type
user {
...UserFragment
}
webEmbed
webappUri
}
location {
label
placeId
}
nftsOwned
nftsPaginated {
edges {
...NftConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
nonce
numBackedArtists
postCount
publicAddress
roles {
isAdmin
isArtistRelations
}
shelves {
edges {
...ShelfConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
}
Variables
{
"ens": ENS,
"publicAddress": Address
}
Response
{
"data": {
"userByAddress": {
"artist": Artist,
"avatar": Media,
"backedArtists": ArtistCollectorConnection,
"bannerImage": Media,
"collectedReleases": CollectedReleaseConnection,
"collectedReleasesCount": 987,
"collectedReleasesIds": ["abc123"],
"collectorPosition": 123,
"createdAt": "2007-12-03T10:15:30Z",
"creditAllocations": [CreditAllocation],
"delegateWalletAddress": "xyz789",
"description": "abc123",
"displayName": "xyz789",
"email": "xyz789",
"ens": "xyz789",
"farcasterFid": "abc123",
"farcasterSignerConnected": true,
"featuredReleases": [CollectedRelease],
"followerCount": 987,
"followers": UserRelationConnection,
"following": UserRelationConnection,
"followingCount": 123,
"id": 4,
"instagramHandle": "abc123",
"invitedByUser": User,
"isTopNotableCollector": true,
"lastReferralWithdrawableBalance": "abc123",
"likedSounds": Shelf,
"location": GeoLocationPlaceGoogle,
"nftsOwned": 987,
"nftsPaginated": NftConnection,
"nonce": 987,
"numBackedArtists": 987,
"postCount": 123,
"publicAddress": "abc123",
"roles": UserRoles,
"shelves": ShelfConnection,
"shelvesCount": 123,
"showSplitsFeature": false,
"tiktokUrl": "abc123",
"topCollectorPosition": 123,
"twitterHandle": "abc123",
"username": "abc123",
"verifiedNotificationEmail": "xyz789",
"webappUri": "xyz789"
}
}
}
userByArtistHandle
Description
[PUBLIC] Get specified user by sound handle
Example
Query
query UserByArtistHandle($soundHandle: String!) {
userByArtistHandle(soundHandle: $soundHandle) {
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
avatar {
bucket
dominantColor
id
key
url
}
backedArtists {
edges {
...ArtistCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
bannerImage {
bucket
dominantColor
id
key
url
}
collectedReleases {
edges {
...CollectedReleaseConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
creditSplit {
...CreditSplitFragment
}
id
owner {
...UserFragment
}
percent
roles
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
firstNftOwned {
...NftFragment
}
gaNftsCount
goldenEgg {
...EggGameFragment
}
id
nftsCount
ownedTokens {
...OwnedTokenFragment
}
release {
...ReleaseFragment
}
tierPriority
vipNftsCount
}
followerCount
followers {
edges {
...UserRelationConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
following {
edges {
...UserRelationConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
followingCount
id
instagramHandle
invitedByUser {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
affiliateBuyers {
...PlaylistAffiliateBuyerConnectionFragment
}
coverImage {
...MediaFragment
}
coverReleases {
...ReleaseFragment
}
createdAt
deletedAt
description
extendedFrom {
...ShelfFragment
}
id
index
likedBy {
...UserConnectionFragment
}
likes
linkSlug
name
numLikes
numReferralPurchases
numUsersReferred
orderedReleases {
...ShelfReleaseConnectionFragment
}
playTimeInSeconds
previewReleases {
...ShelfReleaseFragment
}
releaseCount
releaseIds
socialProofReferrals {
...UserFragment
}
trackIds
type
user {
...UserFragment
}
webEmbed
webappUri
}
location {
label
placeId
}
nftsOwned
nftsPaginated {
edges {
...NftConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
nonce
numBackedArtists
postCount
publicAddress
roles {
isAdmin
isArtistRelations
}
shelves {
edges {
...ShelfConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
}
Variables
{"soundHandle": "xyz789"}
Response
{
"data": {
"userByArtistHandle": {
"artist": Artist,
"avatar": Media,
"backedArtists": ArtistCollectorConnection,
"bannerImage": Media,
"collectedReleases": CollectedReleaseConnection,
"collectedReleasesCount": 987,
"collectedReleasesIds": ["xyz789"],
"collectorPosition": 987,
"createdAt": "2007-12-03T10:15:30Z",
"creditAllocations": [CreditAllocation],
"delegateWalletAddress": "abc123",
"description": "xyz789",
"displayName": "abc123",
"email": "abc123",
"ens": "xyz789",
"farcasterFid": "abc123",
"farcasterSignerConnected": false,
"featuredReleases": [CollectedRelease],
"followerCount": 123,
"followers": UserRelationConnection,
"following": UserRelationConnection,
"followingCount": 123,
"id": 4,
"instagramHandle": "abc123",
"invitedByUser": User,
"isTopNotableCollector": true,
"lastReferralWithdrawableBalance": "xyz789",
"likedSounds": Shelf,
"location": GeoLocationPlaceGoogle,
"nftsOwned": 123,
"nftsPaginated": NftConnection,
"nonce": 987,
"numBackedArtists": 987,
"postCount": 987,
"publicAddress": "xyz789",
"roles": UserRoles,
"shelves": ShelfConnection,
"shelvesCount": 123,
"showSplitsFeature": false,
"tiktokUrl": "abc123",
"topCollectorPosition": 123,
"twitterHandle": "xyz789",
"username": "abc123",
"verifiedNotificationEmail": "abc123",
"webappUri": "abc123"
}
}
}
userChannels
Description
[AUTHENTICATED] All channels user is a member of
Response
Returns a
ChannelConnection!
Arguments
| Name | Description |
|---|---|
pagination -
CursorConnectionArgs!
|
Pagination parameters. Default = {first: 10, sort: DESC} |
Example
Query
query UserChannels($pagination: CursorConnectionArgs!) {
userChannels(pagination: $pagination) {
edges {
cursor
node {
...ChannelFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{"pagination": {"first": 10, "sort": "DESC"}}
Response
{
"data": {
"userChannels": {
"edges": [ChannelConnectionEdge],
"pageInfo": PageInfo
}
}
}
userLikeActivityFeed
Description
[PUBLIC] User like and unlike activity feed
Response
Returns a
CollectorActionConnection!
Arguments
| Name | Description |
|---|---|
pagination -
CursorConnectionArgs!
|
Pagination parameters. Default = {first: 10, sort: DESC} |
userId -
UUID!
|
User ID |
Example
Query
query UserLikeActivityFeed(
$pagination: CursorConnectionArgs!,
$userId: UUID!
) {
userLikeActivityFeed(
pagination: $pagination,
userId: $userId
) {
edges {
cursor
node {
...CollectorActionFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"pagination": {"first": 10, "sort": "DESC"},
"userId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"userLikeActivityFeed": {
"edges": [CollectorActionConnectionEdge],
"pageInfo": PageInfo
}
}
}
userNotificationPreferences
Description
[AUTHENTICATED] Get authenticated user notification preferences
Response
Returns a
UserNotificationPreferences
Example
Query
query UserNotificationPreferences {
userNotificationPreferences {
email
emailVerificationStatus
receiveArtistUpdateEmails
receiveMentionUpdateEmails
receivePushNotifications
}
}
Response
{
"data": {
"userNotificationPreferences": {
"email": "abc123",
"emailVerificationStatus": "EXPIRED",
"receiveArtistUpdateEmails": false,
"receiveMentionUpdateEmails": false,
"receivePushNotifications": true
}
}
}
userNotifications
Description
[AUTHENTICATED] User notifications for authenticated user
Response
Returns a
UserNotificationConnection!
Arguments
| Name | Description |
|---|---|
pagination -
CursorConnectionArgs!
|
Pagination parameters |
Example
Query
query UserNotifications($pagination: CursorConnectionArgs!) {
userNotifications(pagination: $pagination) {
edges {
cursor
node {
...UserNotificationFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{"pagination": CursorConnectionArgs}
Response
{
"data": {
"userNotifications": {
"edges": [UserNotificationConnectionEdge],
"pageInfo": PageInfo
}
}
}
userNotificationsStatus
Description
[AUTHENTICATED] Status of user notifications for authenticated user
Response
Returns a
UserNotificationsStatus!
Example
Query
query UserNotificationsStatus {
userNotificationsStatus {
hasUnreadNotifications
id
lastReadTimestamp
user {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
}
}
Response
{
"data": {
"userNotificationsStatus": {
"hasUnreadNotifications": true,
"id": "4",
"lastReadTimestamp": 1592577642,
"user": User
}
}
}
userPostStatus
Description
[AUTHENTICATED] Indicates the current status of the authenticated user on the specified posts
Response
Returns
[UserPostStatus!]!
Arguments
| Name | Description |
|---|---|
input -
QueryUserPostStatusInput!
|
Input for userPostStatus query |
Example
Query
query UserPostStatus($input: QueryUserPostStatusInput!) {
userPostStatus(input: $input) {
postId
repostCount
repostStatus
upvoteCount
voteStatus
}
}
Variables
{"input": QueryUserPostStatusInput}
Response
{
"data": {
"userPostStatus": [
{
"postId": "abc123",
"repostCount": 987,
"repostStatus": "NOT_REPOSTED",
"upvoteCount": 123,
"voteStatus": "NO_VOTE"
}
]
}
}
userPosts
Description
posts from the user
Response
Returns a
PostConnection!
Arguments
| Name | Description |
|---|---|
pagination -
PostCursorConnectionArgs!
|
Pagination parameters. Default = {after: null, first: 10, sort: {createdAt: DESC}} |
userId -
UUID!
|
User identifier |
Example
Query
query UserPosts(
$pagination: PostCursorConnectionArgs!,
$userId: UUID!
) {
userPosts(
pagination: $pagination,
userId: $userId
) {
edges {
cursor
node {
...PostFragment
}
}
pageInfo {
endCursor
hasNextPage
hasPreviousPage
startCursor
}
}
}
Variables
{
"pagination": {"after": "null", "first": 10, "sort": {"createdAt": "DESC"}},
"userId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"userPosts": {
"edges": [PostConnectionEdge],
"pageInfo": PageInfo
}
}
}
userRelationStatuses
Description
[AUTHENTICATED] Check status of relationship of authenticated user with specified users up to a maximum of 51
Response
Returns
[UserRelationStatus!]!
Arguments
| Name | Description |
|---|---|
users -
[UUID!]!
|
Up to 51 user identifiers to check if auth user is following |
Example
Query
query UserRelationStatuses($users: [UUID!]!) {
userRelationStatuses(users: $users) {
isFollowing
userId
}
}
Variables
{
"users": [
"6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
]
}
Response
{
"data": {
"userRelationStatuses": [
{
"isFollowing": false,
"userId": "abc123"
}
]
}
}
userReleaseStatus
Description
[AUTHENTICATED] Get the current status of the releases for the user
Response
Returns
[UserReleaseStatus!]!
Arguments
| Name | Description |
|---|---|
input -
QueryUserReleaseStatusInput!
|
Input for userReleaseStatus query |
Example
Query
query UserReleaseStatus($input: QueryUserReleaseStatusInput!) {
userReleaseStatus(input: $input) {
isPreSaved
releaseId
}
}
Variables
{"input": QueryUserReleaseStatusInput}
Response
{
"data": {
"userReleaseStatus": [
{
"isPreSaved": true,
"releaseId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
]
}
}
userTopFollowers
Description
[PUBLIC] List of top 3 followers of user by follower count
Example
Query
query UserTopFollowers($id: UUID!) {
userTopFollowers(id: $id) {
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
avatar {
bucket
dominantColor
id
key
url
}
backedArtists {
edges {
...ArtistCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
bannerImage {
bucket
dominantColor
id
key
url
}
collectedReleases {
edges {
...CollectedReleaseConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
creditSplit {
...CreditSplitFragment
}
id
owner {
...UserFragment
}
percent
roles
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
firstNftOwned {
...NftFragment
}
gaNftsCount
goldenEgg {
...EggGameFragment
}
id
nftsCount
ownedTokens {
...OwnedTokenFragment
}
release {
...ReleaseFragment
}
tierPriority
vipNftsCount
}
followerCount
followers {
edges {
...UserRelationConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
following {
edges {
...UserRelationConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
followingCount
id
instagramHandle
invitedByUser {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
affiliateBuyers {
...PlaylistAffiliateBuyerConnectionFragment
}
coverImage {
...MediaFragment
}
coverReleases {
...ReleaseFragment
}
createdAt
deletedAt
description
extendedFrom {
...ShelfFragment
}
id
index
likedBy {
...UserConnectionFragment
}
likes
linkSlug
name
numLikes
numReferralPurchases
numUsersReferred
orderedReleases {
...ShelfReleaseConnectionFragment
}
playTimeInSeconds
previewReleases {
...ShelfReleaseFragment
}
releaseCount
releaseIds
socialProofReferrals {
...UserFragment
}
trackIds
type
user {
...UserFragment
}
webEmbed
webappUri
}
location {
label
placeId
}
nftsOwned
nftsPaginated {
edges {
...NftConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
nonce
numBackedArtists
postCount
publicAddress
roles {
isAdmin
isArtistRelations
}
shelves {
edges {
...ShelfConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
}
Variables
{
"id": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"userTopFollowers": [
{
"artist": Artist,
"avatar": Media,
"backedArtists": ArtistCollectorConnection,
"bannerImage": Media,
"collectedReleases": CollectedReleaseConnection,
"collectedReleasesCount": 987,
"collectedReleasesIds": ["xyz789"],
"collectorPosition": 987,
"createdAt": "2007-12-03T10:15:30Z",
"creditAllocations": [CreditAllocation],
"delegateWalletAddress": "abc123",
"description": "xyz789",
"displayName": "abc123",
"email": "xyz789",
"ens": "abc123",
"farcasterFid": "abc123",
"farcasterSignerConnected": true,
"featuredReleases": [CollectedRelease],
"followerCount": 987,
"followers": UserRelationConnection,
"following": UserRelationConnection,
"followingCount": 123,
"id": "4",
"instagramHandle": "abc123",
"invitedByUser": User,
"isTopNotableCollector": false,
"lastReferralWithdrawableBalance": "abc123",
"likedSounds": Shelf,
"location": GeoLocationPlaceGoogle,
"nftsOwned": 123,
"nftsPaginated": NftConnection,
"nonce": 987,
"numBackedArtists": 123,
"postCount": 987,
"publicAddress": "xyz789",
"roles": UserRoles,
"shelves": ShelfConnection,
"shelvesCount": 123,
"showSplitsFeature": false,
"tiktokUrl": "abc123",
"topCollectorPosition": 987,
"twitterHandle": "abc123",
"username": "xyz789",
"verifiedNotificationEmail": "xyz789",
"webappUri": "xyz789"
}
]
}
}
userVoteOnPostComment
Description
[AUTHENTICATED] Indicates if the current user has voted on the post
Response
Returns
[UserVoteOnPostComment!]!
Arguments
| Name | Description |
|---|---|
input -
QueryUserVoteOnPostCommentInput!
|
Example
Query
query UserVoteOnPostComment($input: QueryUserVoteOnPostCommentInput!) {
userVoteOnPostComment(input: $input) {
postCommentId
upvoteCount
voteStatus
}
}
Variables
{"input": QueryUserVoteOnPostCommentInput}
Response
{
"data": {
"userVoteOnPostComment": [
{
"postCommentId": "abc123",
"upvoteCount": 987,
"voteStatus": "NO_VOTE"
}
]
}
}
versionStatus
Description
[PUBLIC] Get platform version status
Response
Returns a
VersionStatusResponse!
Arguments
| Name | Description |
|---|---|
input -
VersionStatusInput!
|
Input for query |
Example
Query
query VersionStatus($input: VersionStatusInput!) {
versionStatus(input: $input)
}
Variables
{"input": VersionStatusInput}
Response
{"data": {"versionStatus": NotSupportedVersion}}
withdrawableEarningsForChain
Description
[AUTHENTICATED] Withdrawable earnings for all releases, ignores dust amounts that are not worth withdrawing
Response
Returns an
AllWithdrawableEarnings!
Arguments
| Name | Description |
|---|---|
chain -
ChainType!
|
the chain for the transaction |
Example
Query
query WithdrawableEarningsForChain($chain: ChainType!) {
withdrawableEarningsForChain(chain: $chain) {
artistContracts {
balanceForUser
contractAddress
editionId
totalBalance
}
editionContracts {
balanceForUser
contractAddress
totalBalance
}
splitContracts {
balanceForUser
contractAddress
distributorFee
participantAddresses
participantAllocations
totalBalance
}
}
}
Variables
{"chain": "BASE"}
Response
{
"data": {
"withdrawableEarningsForChain": {
"artistContracts": [ArtistContractEarning],
"editionContracts": [EditionContractEarning],
"splitContracts": [SplitsContractEarning]
}
}
}
withdrawableEarningsForRelease
Description
[AUTHENTICATED] Withdrawable earnings for a given release, returns null for values if contract contain dust amounts that are not worth withdrawing
Response
Returns a
WithdrawableEarnings!
Arguments
| Name | Description |
|---|---|
releaseId -
UUID!
|
Release identifier |
Example
Query
query WithdrawableEarningsForRelease($releaseId: UUID!) {
withdrawableEarningsForRelease(releaseId: $releaseId) {
releaseContract
splitContract {
balanceForUser
contractAddress
distributorFee
participantAddresses
participantAllocations
totalBalance
}
}
}
Variables
{
"releaseId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"withdrawableEarningsForRelease": {
"releaseContract": ArtistContractEarning,
"splitContract": SplitsContractEarning
}
}
}
Mutations
abortMultipartUpload
Description
[AUTHENTICATED] Abort a multi-part upload request
Response
Returns a
MutationAbortMultipartUploadResult!
Arguments
| Name | Description |
|---|---|
input -
AbortMultipartUploadRequest!
|
Multi-part upload abort parameters |
Example
Query
mutation AbortMultipartUpload($input: AbortMultipartUploadRequest!) {
abortMultipartUpload(input: $input)
}
Variables
{"input": AbortMultipartUploadRequest}
Response
{"data": {"abortMultipartUpload": AwsRequestError}}
acceptArtistApplication
Description
[ADMIN | ARTIST_RELATIONS] Accept artist application
Response
Returns a
MutationAcceptArtistApplicationResult!
Arguments
| Name | Description |
|---|---|
input -
AcceptArtistApplicationInput!
|
Accept artist application input arguments |
Example
Query
mutation AcceptArtistApplication($input: AcceptArtistApplicationInput!) {
acceptArtistApplication(input: $input)
}
Variables
{"input": AcceptArtistApplicationInput}
Response
{
"data": {
"acceptArtistApplication": MutationAcceptArtistApplicationSuccess
}
}
addPostComment
Description
[AUTHENTICATED] Creates a new post comment (rate limited to 1/s)
Response
Returns a
MutationAddPostCommentResult!
Arguments
| Name | Description |
|---|---|
input -
CreatePostCommentInput!
|
Input to create a post comment |
Example
Query
mutation AddPostComment($input: CreatePostCommentInput!) {
addPostComment(input: $input)
}
Variables
{"input": CreatePostCommentInput}
Response
{"data": {"addPostComment": DidNotGoThroughError}}
addPostCommentReply
Description
[AUTHENTICATED] Creates a new reply to a post comment (rate limited to 1/s)
Response
Returns a
MutationAddPostCommentReplyResult!
Arguments
| Name | Description |
|---|---|
input -
MutationAddPostCommentReplyInput!
|
Example
Query
mutation AddPostCommentReply($input: MutationAddPostCommentReplyInput!) {
addPostCommentReply(input: $input)
}
Variables
{"input": MutationAddPostCommentReplyInput}
Response
{"data": {"addPostCommentReply": DidNotGoThroughError}}
addReleaseToShelf
Description
[AUTHENTICATED] Add specified release into the bottom of owned shelf
Response
Returns a
MutationAddReleaseToShelfResult!
Arguments
| Name | Description |
|---|---|
input -
AddReleaseToShelfInput!
|
Information of shelf and release to be added |
Example
Query
mutation AddReleaseToShelf($input: AddReleaseToShelfInput!) {
addReleaseToShelf(input: $input)
}
Variables
{"input": AddReleaseToShelfInput}
Response
{"data": {"addReleaseToShelf": DuplicatedError}}
addUsersToDraftAllowlist
Description
[ARTIST] Add users to given draft with allowlist type
Response
Returns a
MutationAddUsersToDraftAllowlistResult!
Arguments
| Name | Description |
|---|---|
input -
AddUsersToDraftAllowlistInput!
|
Add users to draft allowlist input arguments |
Example
Query
mutation AddUsersToDraftAllowlist($input: AddUsersToDraftAllowlistInput!) {
addUsersToDraftAllowlist(input: $input)
}
Variables
{"input": AddUsersToDraftAllowlistInput}
Response
{"data": {"addUsersToDraftAllowlist": AlreadyMintedError}}
adminAllowUserToPost
Description
[ADMIN] Allows a user to make content
Response
Returns a
MutationAdminAllowUserToPostResult!
Arguments
| Name | Description |
|---|---|
input -
MutationAdminAllowUserToPostInput!
|
Example
Query
mutation AdminAllowUserToPost($input: MutationAdminAllowUserToPostInput!) {
adminAllowUserToPost(input: $input)
}
Variables
{"input": MutationAdminAllowUserToPostInput}
Response
{
"data": {
"adminAllowUserToPost": MutationAdminAllowUserToPostSuccess
}
}
adminDeleteAllUserContent
Description
[ADMIN] Deletes all posts and comments made by a user
Response
Returns a
MutationAdminDeleteAllUserContentResult!
Arguments
| Name | Description |
|---|---|
input -
MutationAdminDeleteAllUserContentInput!
|
Example
Query
mutation AdminDeleteAllUserContent($input: MutationAdminDeleteAllUserContentInput!) {
adminDeleteAllUserContent(input: $input)
}
Variables
{"input": MutationAdminDeleteAllUserContentInput}
Response
{
"data": {
"adminDeleteAllUserContent": MutationAdminDeleteAllUserContentSuccess
}
}
adminDeletePost
Description
[ADMIN] Delete a post
Response
Returns a
MutationAdminDeletePostResult!
Arguments
| Name | Description |
|---|---|
input -
MutationAdminDeletePostInput!
|
Example
Query
mutation AdminDeletePost($input: MutationAdminDeletePostInput!) {
adminDeletePost(input: $input)
}
Variables
{"input": MutationAdminDeletePostInput}
Response
{
"data": {
"adminDeletePost": MutationAdminDeletePostSuccess
}
}
adminDeletePostComment
Description
[ADMIN] Delete a post comment
Response
Returns a
MutationAdminDeletePostCommentResult!
Arguments
| Name | Description |
|---|---|
input -
MutationAdminDeletePostCommentInput!
|
Example
Query
mutation AdminDeletePostComment($input: MutationAdminDeletePostCommentInput!) {
adminDeletePostComment(input: $input)
}
Variables
{"input": MutationAdminDeletePostCommentInput}
Response
{
"data": {
"adminDeletePostComment": MutationAdminDeletePostCommentSuccess
}
}
adminDeletePostCommentReply
Description
[ADMIN] Delete a post comment reply
Response
Arguments
| Name | Description |
|---|---|
input -
MutationAdminDeletePostCommentReplyInput!
|
Example
Query
mutation AdminDeletePostCommentReply($input: MutationAdminDeletePostCommentReplyInput!) {
adminDeletePostCommentReply(input: $input)
}
Variables
{"input": MutationAdminDeletePostCommentReplyInput}
Response
{
"data": {
"adminDeletePostCommentReply": MutationAdminDeletePostCommentReplySuccess
}
}
adminDisallowUserToPost
Description
[ADMIN] Disallows a user to make content
Response
Returns a
MutationAdminDisallowUserToPostResult!
Arguments
| Name | Description |
|---|---|
input -
MutationAdminDisallowUserToPostInput!
|
Example
Query
mutation AdminDisallowUserToPost($input: MutationAdminDisallowUserToPostInput!) {
adminDisallowUserToPost(input: $input)
}
Variables
{"input": MutationAdminDisallowUserToPostInput}
Response
{
"data": {
"adminDisallowUserToPost": MutationAdminDisallowUserToPostSuccess
}
}
albumRevealMetadataFromDraft
Description
[ADMIN] Upload metadata to Arweave from release draft info
Response
Returns a
NonEmptyString!
Arguments
| Name | Description |
|---|---|
releaseId -
UUID!
|
Release identifier |
Example
Query
mutation AlbumRevealMetadataFromDraft($releaseId: UUID!) {
albumRevealMetadataFromDraft(releaseId: $releaseId)
}
Variables
{
"releaseId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"albumRevealMetadataFromDraft": "string"
}
}
artistAuctionMeta
Description
[ADMIN | ARTIST_RELATIONS] Configure auction meta options of specific artist
Response
Returns an
ArtistAuctionOverrides!
Arguments
| Name | Description |
|---|---|
artistAddress -
Address!
|
Artist public address or Artist contract address |
metaType -
AuctionMetaInput
|
Auction meta options |
Example
Query
mutation ArtistAuctionMeta(
$artistAddress: Address!,
$metaType: AuctionMetaInput
) {
artistAuctionMeta(
artistAddress: $artistAddress,
metaType: $metaType
) {
artistAddress
createdAt
id
}
}
Variables
{
"artistAddress": Address,
"metaType": AuctionMetaInput
}
Response
{
"data": {
"artistAuctionMeta": {
"artistAddress": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"id": 4
}
}
}
artistMintingOption
Description
[ADMIN | ARTIST_RELATIONS] Configure specific artist minting options
Response
Returns an
ArtistAuctionOverrides!
Arguments
| Name | Description |
|---|---|
artistAddress -
Address!
|
Artist user wallet public address or artist contract address |
auctionType -
AuctionInputRef!
|
Auction sale types to configure |
Example
Query
mutation ArtistMintingOption(
$artistAddress: Address!,
$auctionType: AuctionInputRef!
) {
artistMintingOption(
artistAddress: $artistAddress,
auctionType: $auctionType
) {
artistAddress
createdAt
id
}
}
Variables
{
"artistAddress": Address,
"auctionType": AuctionInputRef
}
Response
{
"data": {
"artistMintingOption": {
"artistAddress": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"id": 4
}
}
}
changeRoleForUser
Description
[ADMIN] Change the role of a specified user
Response
Returns a
UserRoles!
Arguments
| Name | Description |
|---|---|
input -
ChangeRoleInput!
|
Example
Query
mutation ChangeRoleForUser($input: ChangeRoleInput!) {
changeRoleForUser(input: $input) {
isAdmin
isArtistRelations
}
}
Variables
{"input": ChangeRoleInput}
Response
{"data": {"changeRoleForUser": {"isAdmin": true, "isArtistRelations": true}}}
clientConfirmedDraftUpsert
Description
[ARTIST] Upsert release edition based on transaction
Response
Returns a
Release
Arguments
| Name | Description |
|---|---|
chain -
ChainType!
|
Chain for the transaction |
hash -
String!
|
Transaction hash |
Example
Query
mutation ClientConfirmedDraftUpsert(
$chain: ChainType!,
$hash: String!
) {
clientConfirmedDraftUpsert(
chain: $chain,
hash: $hash
) {
activityFeed {
edges {
...ReleaseActionConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
affiliates {
edges {
...ReleaseAffiliateConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
airdropCount
animatedCoverImage {
bucket
dominantColor
id
key
url
}
animatedGoldenEggImageOptimized {
bucket
dominantColor
id
key
url
}
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
auctionContractType
auctionType
baseMetadataAttributes {
traitType
value
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
edges {
...ReleaseCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
collectorsCount
contract {
contractAddress
contractType
createdAt
id
owner {
...UserFragment
}
ownerPublicAddress
updatedAt
}
contractAddress
coverImage {
bucket
dominantColor
id
key
url
}
createdAt
creditSplit {
creditAllocations {
...CreditAllocationFragment
}
id
mintedReleases {
...ReleaseFragment
}
releases {
...ReleaseFragment
}
splitAddress
}
credits {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
draftId
earliestCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
editionId
eggGame {
animatedGoldenEggImageOptimized {
...MediaFragment
}
finalSerialBlockHash
goldenEggImage {
...MediaFragment
}
id
nft {
...NftFragment
}
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
bucket
dominantColor
id
key
url
}
gaCoverImage {
bucket
dominantColor
id
key
url
}
genre {
createdAt
id
name
updatedAt
}
goldenEggImage {
bucket
dominantColor
id
key
url
}
goldenEggNft {
audioUrl
collectorRelease {
...ReleaseCollectorFragment
}
comment {
...CommentFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
createdAtBlockTime
id
isBurned
isGoldenEgg
openSeaMetadataAttributes {
...OpenSeaMetadataAttributeFragment
}
owner {
...UserFragment
}
release {
...ReleaseFragment
}
serialNumber
songSlot
tierNumber
title
tokenId
updatedAt
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
likedBy {
edges {
...UserConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
listeningParty
listing {
chain
contractAddress
id
}
marketPlaceUrl
metadataDetails {
bpm
key
license
location
lyrics
}
mintStartTime
mintStartTimestamp
nftsPaginated {
edges {
...NftConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
description
id
title
}
royaltyBps
saleDetails {
primaryCollected
primaryRaisedInWei
soundSwapCollected
soundSwapRaisedInWei
totalVolume
}
saleSchedules {
affiliateFeeBPS
affiliateFeePercent
artistContractTotalMinted
endTime
id
isPresale
maxMintable
merkleTreeRoot
mintId
minterAddress
price
startTime
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
affiliateFeeBPS
affiliateFeePercent
artistFeeBPS
artistFeePercent
basePrice
buyFreezeTime
goldenEggFeeBPS
goldenEggFeePercent
id
inflectionPoint
inflectionPrice
maxSupply
platformFeeBPS
platformPerTxFlatFee
samAddress
}
samSellBufferBpsOverride
scheduleIds {
mintIds
minterAddress
}
season
shelves {
edges {
...ShelfConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
socialProofCollectors {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
bucket
dominantColor
id
key
url
}
staticGaCoverImage {
bucket
dominantColor
id
key
url
}
staticVipCoverImage {
bucket
dominantColor
id
key
url
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
firstNftCollectedDate
lowestNftSerialNumber
nftsCount
position
user {
...UserFragment
}
}
topPosts {
authorChannelRole
channel {
...ChannelFragment
}
commentCount
comments {
...PostCommentConnectionFragment
}
content
createdAt
creator {
...UserFragment
}
farcasterHash
id
lexicalContent
repostCount
upvoteCount
webappUri
}
topSpentCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
totalMinted
totalSupply
track {
audio {
...AudioMediaFragment
}
audioOriginal {
...MediaFragment
}
duration
id
normalizedPeaks
release {
...ReleaseFragment
}
releaseId
title
trackNumber
}
type
vipAnimatedCoverImage {
bucket
dominantColor
id
key
url
}
vipCoverImage {
bucket
dominantColor
id
key
url
}
webEmbed
webappUri
}
}
Variables
{"chain": "BASE", "hash": "xyz789"}
Response
{
"data": {
"clientConfirmedDraftUpsert": {
"activityFeed": ReleaseActionConnection,
"affiliates": ReleaseAffiliateConnection,
"airdropCount": 987,
"animatedCoverImage": Media,
"animatedGoldenEggImageOptimized": Media,
"artist": Artist,
"auctionContractType": "ARTIST",
"auctionType": "FIXED_QUANTITY",
"baseMetadataAttributes": [MetadataAttribute],
"behindTheMusic": "xyz789",
"canCollectorsDownloadAudio": true,
"chainId": 987,
"collectors": ReleaseCollectorConnection,
"collectorsCount": 123,
"contract": Contract,
"contractAddress": "abc123",
"coverImage": Media,
"createdAt": "2007-12-03T10:15:30Z",
"creditSplit": CreditSplit,
"credits": [User],
"draftId": "abc123",
"earliestCollector": ReleaseCollector,
"editionId": "xyz789",
"eggGame": EggGame,
"externalUrl": "abc123",
"finalQuantity": 123,
"fundingAddress": "abc123",
"gaAnimatedCoverImage": Media,
"gaCoverImage": Media,
"genre": Genre,
"goldenEggImage": Media,
"goldenEggNft": Nft,
"id": 4,
"isAuctionSoldOut": true,
"isFirstPhaseCompleted": true,
"lastUpdatedAt": "2007-12-03T10:15:30Z",
"latestCollector": ReleaseCollector,
"likedBy": UserConnection,
"listeningParty": 1592577642,
"listing": AuctionListingInterface,
"marketPlaceUrl": "abc123",
"metadataDetails": MetadataDetails,
"mintStartTime": 123,
"mintStartTimestamp": 1592577642,
"nftsPaginated": NftConnection,
"numSold": 987,
"openseaUrl": "abc123",
"postCount": 123,
"price": "xyz789",
"publicAffiliateFeeBPS": 123,
"publicAffiliateFeePercent": "abc123",
"publicMintStart": "2007-12-03T10:15:30Z",
"quantity": 987,
"quantityLowerBound": 123,
"quantityUpperBound": 987,
"rewards": [Reward],
"royaltyBps": 987,
"saleDetails": SaleDetails,
"saleSchedules": [SaleSchedule],
"salesAffiliateFeesPercent": [
"xyz789"
],
"samAddress": "xyz789",
"samBuyBufferBpsOverride": 123,
"samConfig": SamConfig,
"samSellBufferBpsOverride": 123,
"scheduleIds": [ScheduleIdentifier],
"season": "abc123",
"shelves": ShelfConnection,
"socialProofCollectors": [User],
"spotifyPresaveCampaign": true,
"spotifyPresaveCount": 123,
"spotifyTrackId": "abc123",
"staticCoverImage": Media,
"staticGaCoverImage": Media,
"staticVipCoverImage": Media,
"supplyCutoffTimestamp": 1592577642,
"title": "xyz789",
"titleSlug": "abc123",
"topCollectors": [TopReleaseCollector],
"topPosts": [Post],
"topSpentCollector": ReleaseCollector,
"totalMinted": 987,
"totalSupply": 987,
"track": Track,
"type": "ALBUM",
"vipAnimatedCoverImage": Media,
"vipCoverImage": Media,
"webEmbed": "abc123",
"webappUri": "abc123"
}
}
}
clientDraftSplitUpsert
Description
[AUTHENTICATED] Upsert created draft split address from the client-side. An alternative to wait until the transaction is completed and automatically acknowledged on background processes
Response
Returns a
Draft
Arguments
| Name | Description |
|---|---|
txHash -
String!
|
Transaction hash associated to operation |
Example
Query
mutation ClientDraftSplitUpsert($txHash: String!) {
clientDraftSplitUpsert(txHash: $txHash) {
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
contractAddressSalt
createdAt
edit {
createdAt
id
info {
...DraftEditInfoFragment
}
updatedAt
}
id
info {
allowListInfo {
...DraftAllowListsInfoFragment
}
auctionConfigurations {
...DraftAuctionConfigurationsInfoFragment
}
numUploadStepsComplete
releaseInfo {
...DraftReleaseInfoFragment
}
rewardsInfo {
...RewardsUploadStepInfoFragment
}
splitsInfo {
...SplitsUploadStepInfoFragment
}
}
release {
activityFeed {
...ReleaseActionConnectionFragment
}
affiliates {
...ReleaseAffiliateConnectionFragment
}
airdropCount
animatedCoverImage {
...MediaFragment
}
animatedGoldenEggImageOptimized {
...MediaFragment
}
artist {
...ArtistFragment
}
auctionContractType
auctionType
baseMetadataAttributes {
...MetadataAttributeFragment
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
...ReleaseCollectorConnectionFragment
}
collectorsCount
contract {
...ContractFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
creditSplit {
...CreditSplitFragment
}
credits {
...UserFragment
}
draftId
earliestCollector {
...ReleaseCollectorFragment
}
editionId
eggGame {
...EggGameFragment
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
...MediaFragment
}
gaCoverImage {
...MediaFragment
}
genre {
...GenreFragment
}
goldenEggImage {
...MediaFragment
}
goldenEggNft {
...NftFragment
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
...ReleaseCollectorFragment
}
likedBy {
...UserConnectionFragment
}
listeningParty
listing {
...AuctionListingInterfaceFragment
}
marketPlaceUrl
metadataDetails {
...MetadataDetailsFragment
}
mintStartTime
mintStartTimestamp
nftsPaginated {
...NftConnectionFragment
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
...RewardFragment
}
royaltyBps
saleDetails {
...SaleDetailsFragment
}
saleSchedules {
...SaleScheduleFragment
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
...SamConfigFragment
}
samSellBufferBpsOverride
scheduleIds {
...ScheduleIdentifierFragment
}
season
shelves {
...ShelfConnectionFragment
}
socialProofCollectors {
...UserFragment
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
...MediaFragment
}
staticGaCoverImage {
...MediaFragment
}
staticVipCoverImage {
...MediaFragment
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
...TopReleaseCollectorFragment
}
topPosts {
...PostFragment
}
topSpentCollector {
...ReleaseCollectorFragment
}
totalMinted
totalSupply
track {
...TrackFragment
}
type
vipAnimatedCoverImage {
...MediaFragment
}
vipCoverImage {
...MediaFragment
}
webEmbed
webappUri
}
slug
type
updatedAt
}
}
Variables
{"txHash": "xyz789"}
Response
{
"data": {
"clientDraftSplitUpsert": {
"artist": Artist,
"contractAddressSalt": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"edit": DraftEdit,
"id": 4,
"info": DraftInfo,
"release": Release,
"slug": "xyz789",
"type": "ALBUM",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
clientNftUpsert
Description
[AUTHENTICATED] Upsert bought NFT entity from the client-side. An alternative to wait until the transaction is completed and automatically acknowledged on background processes
Response
Returns a
Nft
Arguments
| Name | Description |
|---|---|
chain -
ChainType!
|
the chain to do clientNftUpsert on |
txHash -
String!
|
Transaction hash associated to operation |
Example
Query
mutation ClientNftUpsert(
$chain: ChainType!,
$txHash: String!
) {
clientNftUpsert(
chain: $chain,
txHash: $txHash
) {
audioUrl
collectorRelease {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
comment {
createdAt
id
message
signature
updatedAt
}
contractAddress
coverImage {
bucket
dominantColor
id
key
url
}
createdAt
createdAtBlockTime
id
isBurned
isGoldenEgg
openSeaMetadataAttributes {
traitType
value
}
owner {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
release {
activityFeed {
...ReleaseActionConnectionFragment
}
affiliates {
...ReleaseAffiliateConnectionFragment
}
airdropCount
animatedCoverImage {
...MediaFragment
}
animatedGoldenEggImageOptimized {
...MediaFragment
}
artist {
...ArtistFragment
}
auctionContractType
auctionType
baseMetadataAttributes {
...MetadataAttributeFragment
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
...ReleaseCollectorConnectionFragment
}
collectorsCount
contract {
...ContractFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
creditSplit {
...CreditSplitFragment
}
credits {
...UserFragment
}
draftId
earliestCollector {
...ReleaseCollectorFragment
}
editionId
eggGame {
...EggGameFragment
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
...MediaFragment
}
gaCoverImage {
...MediaFragment
}
genre {
...GenreFragment
}
goldenEggImage {
...MediaFragment
}
goldenEggNft {
...NftFragment
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
...ReleaseCollectorFragment
}
likedBy {
...UserConnectionFragment
}
listeningParty
listing {
...AuctionListingInterfaceFragment
}
marketPlaceUrl
metadataDetails {
...MetadataDetailsFragment
}
mintStartTime
mintStartTimestamp
nftsPaginated {
...NftConnectionFragment
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
...RewardFragment
}
royaltyBps
saleDetails {
...SaleDetailsFragment
}
saleSchedules {
...SaleScheduleFragment
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
...SamConfigFragment
}
samSellBufferBpsOverride
scheduleIds {
...ScheduleIdentifierFragment
}
season
shelves {
...ShelfConnectionFragment
}
socialProofCollectors {
...UserFragment
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
...MediaFragment
}
staticGaCoverImage {
...MediaFragment
}
staticVipCoverImage {
...MediaFragment
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
...TopReleaseCollectorFragment
}
topPosts {
...PostFragment
}
topSpentCollector {
...ReleaseCollectorFragment
}
totalMinted
totalSupply
track {
...TrackFragment
}
type
vipAnimatedCoverImage {
...MediaFragment
}
vipCoverImage {
...MediaFragment
}
webEmbed
webappUri
}
serialNumber
songSlot
tierNumber
title
tokenId
updatedAt
}
}
Variables
{"chain": "BASE", "txHash": "xyz789"}
Response
{
"data": {
"clientNftUpsert": {
"audioUrl": "abc123",
"collectorRelease": ReleaseCollector,
"comment": Comment,
"contractAddress": "xyz789",
"coverImage": Media,
"createdAt": "2007-12-03T10:15:30Z",
"createdAtBlockTime": "2007-12-03T10:15:30Z",
"id": "4",
"isBurned": true,
"isGoldenEgg": true,
"openSeaMetadataAttributes": [
OpenSeaMetadataAttribute
],
"owner": User,
"release": Release,
"serialNumber": 123,
"songSlot": 987,
"tierNumber": 987,
"title": "xyz789",
"tokenId": 4,
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
completeMultipartUpload
Description
[AUTHENTICATED] Complete a multi-part upload request
Response
Returns a
MutationCompleteMultipartUploadResult!
Arguments
| Name | Description |
|---|---|
input -
CompleteMultipartUploadRequest!
|
Multi-part upload complete parameters |
Example
Query
mutation CompleteMultipartUpload($input: CompleteMultipartUploadRequest!) {
completeMultipartUpload(input: $input)
}
Variables
{"input": CompleteMultipartUploadRequest}
Response
{"data": {"completeMultipartUpload": AwsRequestError}}
connectFarcaster
Description
[AUTHENTICATED] Connect Farcaster
Response
Returns a
MutationConnectFarcasterResult!
Arguments
| Name | Description |
|---|---|
signerUUID -
UUID!
|
Signer UUID from Neynar. |
Example
Query
mutation ConnectFarcaster($signerUUID: UUID!) {
connectFarcaster(signerUUID: $signerUUID)
}
Variables
{
"signerUUID": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"connectFarcaster": MutationConnectFarcasterSuccess
}
}
connectSpotify
Description
[AUTHENTICATED] Connects a user's Spotify account with currently authenticated user
Response
Returns a
MutationConnectSpotifyResult!
Arguments
| Name | Description |
|---|---|
input -
MutationConnectSpotifyInput!
|
Input for connectSpotify mutation |
Example
Query
mutation ConnectSpotify($input: MutationConnectSpotifyInput!) {
connectSpotify(input: $input)
}
Variables
{"input": MutationConnectSpotifyInput}
Response
{
"data": {
"connectSpotify": MutationConnectSpotifySuccess
}
}
createArtistApplication
Description
[AUTHENTICATED] Create artist application for authenticated user
Response
Returns a
MutationCreateArtistApplicationResult!
Arguments
| Name | Description |
|---|---|
input -
CreateArtistApplicationInput!
|
Create artist application input arguments |
Example
Query
mutation CreateArtistApplication($input: CreateArtistApplicationInput!) {
createArtistApplication(input: $input)
}
Variables
{"input": CreateArtistApplicationInput}
Response
{
"data": {
"createArtistApplication": MutationCreateArtistApplicationSuccess
}
}
createDraft
Description
[ARTIST] Create draft release
Response
Returns a
MutationCreateDraftResult!
Arguments
| Name | Description |
|---|---|
input -
CreateDraftInput!
|
Create draft input arguments |
Example
Query
mutation CreateDraft($input: CreateDraftInput!) {
createDraft(input: $input)
}
Variables
{"input": CreateDraftInput}
Response
{"data": {"createDraft": DuplicatedError}}
createGeneralPost
Description
[AUTHENTICATED] Creates a new release post (rate limited to 1/s)
Response
Returns a
MutationCreateGeneralPostResult!
Arguments
| Name | Description |
|---|---|
input -
CreateGeneralPostInput!
|
Input to create a release post |
Example
Query
mutation CreateGeneralPost($input: CreateGeneralPostInput!) {
createGeneralPost(input: $input)
}
Variables
{"input": CreateGeneralPostInput}
Response
{"data": {"createGeneralPost": DidNotGoThroughError}}
createKeyClient
Description
[ADMIN] Create Key Client
Response
Returns a
KeyClient!
Arguments
| Name | Description |
|---|---|
input -
CreateKeyClient!
|
Data of new Key Client to be created |
Example
Query
mutation CreateKeyClient($input: CreateKeyClient!) {
createKeyClient(input: $input) {
createdAt
id
key
name
status
updatedAt
}
}
Variables
{"input": CreateKeyClient}
Response
{
"data": {
"createKeyClient": {
"createdAt": "2007-12-03T10:15:30Z",
"id": 4,
"key": "abc123",
"name": "xyz789",
"status": "ACTIVE",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
createMultipartUpload
Description
[AUTHENTICATED] Initiate a multi-part upload request
Response
Returns a
MutationCreateMultipartUploadResult!
Arguments
| Name | Description |
|---|---|
input -
MultipartUploadRequest!
|
Multi-part upload initiation parameters |
Example
Query
mutation CreateMultipartUpload($input: MultipartUploadRequest!) {
createMultipartUpload(input: $input)
}
Variables
{"input": MultipartUploadRequest}
Response
{"data": {"createMultipartUpload": AwsRequestError}}
createPlaylistPost
Description
[AUTHENTICATED] Creates a new playlist post (rate limited to 1/s)
Response
Returns a
MutationCreatePlaylistPostResult!
Arguments
| Name | Description |
|---|---|
input -
CreatePlaylistPostInput!
|
Input to create a playlist post |
Example
Query
mutation CreatePlaylistPost($input: CreatePlaylistPostInput!) {
createPlaylistPost(input: $input)
}
Variables
{"input": CreatePlaylistPostInput}
Response
{"data": {"createPlaylistPost": DidNotGoThroughError}}
createReleasePost
Description
[AUTHENTICATED] Creates a new release post (rate limited to 1/s)
Response
Returns a
MutationCreateReleasePostResult!
Arguments
| Name | Description |
|---|---|
input -
CreateReleasePostInput!
|
Input to create a release post |
Example
Query
mutation CreateReleasePost($input: CreateReleasePostInput!) {
createReleasePost(input: $input)
}
Variables
{"input": CreateReleasePostInput}
Response
{"data": {"createReleasePost": DidNotGoThroughError}}
createReleasePostOnWaveform
Description
[AUTHENTICATED] Release collectors only. Creates a new release post and pins to the waveform
Response
Arguments
| Name | Description |
|---|---|
input -
CreateReleasePostOnWaveformInput!
|
Input to create a release post on waveform |
Example
Query
mutation CreateReleasePostOnWaveform($input: CreateReleasePostOnWaveformInput!) {
createReleasePostOnWaveform(input: $input)
}
Variables
{"input": CreateReleasePostOnWaveformInput}
Response
{
"data": {
"createReleasePostOnWaveform": DidNotGoThroughError
}
}
createTieredDraft
Description
[ARTIST] Create draft for a tiered release
Response
Returns a
MutationCreateTieredDraftResult!
Arguments
| Name | Description |
|---|---|
input -
MutationCreateTieredDraftInput!
|
Input for createTieredDraft mutation |
Example
Query
mutation CreateTieredDraft($input: MutationCreateTieredDraftInput!) {
createTieredDraft(input: $input)
}
Variables
{"input": MutationCreateTieredDraftInput}
Response
{"data": {"createTieredDraft": AuthorizationError}}
customizeHighlightedReleases
Description
[ADMIN | ARTIST_RELATIONS] Customize Highlighted Releases
Response
Arguments
| Name | Description |
|---|---|
params -
JSON!
|
Customization parameters |
Example
Query
mutation CustomizeHighlightedReleases($params: JSON!) {
customizeHighlightedReleases(params: $params)
}
Variables
{"params": {}}
Response
{
"data": {
"customizeHighlightedReleases": MutationCustomizeHighlightedReleasesSuccess
}
}
deleteAllUsersFromDraftAllowlist
Description
[ARTIST] Delete all users from given draft and allowlist type
Response
Arguments
| Name | Description |
|---|---|
input -
DeleteAllUsersFromDraftAllowlistInput!
|
Delete all users from draft allowlist input arguments |
Example
Query
mutation DeleteAllUsersFromDraftAllowlist($input: DeleteAllUsersFromDraftAllowlistInput!) {
deleteAllUsersFromDraftAllowlist(input: $input)
}
Variables
{"input": DeleteAllUsersFromDraftAllowlistInput}
Response
{
"data": {
"deleteAllUsersFromDraftAllowlist": AlreadyMintedError
}
}
deleteArtist
Description
[ADMIN] Remove artist using their public address
Response
Returns a
MutationDeleteArtistResult!
Arguments
| Name | Description |
|---|---|
input -
DeleteArtistInput!
|
Example
Query
mutation DeleteArtist($input: DeleteArtistInput!) {
deleteArtist(input: $input)
}
Variables
{"input": DeleteArtistInput}
Response
{"data": {"deleteArtist": MutationDeleteArtistSuccess}}
deleteDraft
Description
[ARTIST] Delete unminted draft
Response
Returns a
MutationDeleteDraftResult!
Arguments
| Name | Description |
|---|---|
id -
UUID!
|
Draft identifier |
Example
Query
mutation DeleteDraft($id: UUID!) {
deleteDraft(id: $id)
}
Variables
{
"id": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{"data": {"deleteDraft": AlreadyMintedError}}
deletePost
Description
[AUTHENTICATED] Deletes a post
Response
Returns a
MutationDeletePostResult!
Arguments
| Name | Description |
|---|---|
input -
MutationDeletePostInput!
|
Example
Query
mutation DeletePost($input: MutationDeletePostInput!) {
deletePost(input: $input)
}
Variables
{"input": MutationDeletePostInput}
Response
{"data": {"deletePost": MutationDeletePostSuccess}}
deleteRelease
Description
[ADMIN] Remove a release based on its ID
Response
Returns a
MutationDeleteReleaseResult!
Arguments
| Name | Description |
|---|---|
input -
DeleteReleaseInput!
|
Example
Query
mutation DeleteRelease($input: DeleteReleaseInput!) {
deleteRelease(input: $input)
}
Variables
{"input": DeleteReleaseInput}
Response
{"data": {"deleteRelease": MutationDeleteReleaseSuccess}}
deleteShelf
Description
[AUTHENTICATED] Delete shelf for user
Response
Returns a
Void
Arguments
| Name | Description |
|---|---|
input -
DeleteShelfInput!
|
Delete shelf input |
Example
Query
mutation DeleteShelf($input: DeleteShelfInput!) {
deleteShelf(input: $input)
}
Variables
{"input": DeleteShelfInput}
Response
{"data": {"deleteShelf": null}}
deleteUsersFromDraftAllowlist
Description
[ARTIST] Delete users from given draft and allowlist type
Response
Arguments
| Name | Description |
|---|---|
input -
DeleteUsersFromDraftAllowlistInput!
|
Delete users from draft allowlist input arguments |
Example
Query
mutation DeleteUsersFromDraftAllowlist($input: DeleteUsersFromDraftAllowlistInput!) {
deleteUsersFromDraftAllowlist(input: $input)
}
Variables
{"input": DeleteUsersFromDraftAllowlistInput}
Response
{
"data": {
"deleteUsersFromDraftAllowlist": AlreadyMintedError
}
}
dismissRecommendedFollowBanner
Description
[AUTHENTICATED] Dismiss the recommended follow banner
Response
Example
Query
mutation DismissRecommendedFollowBanner {
dismissRecommendedFollowBanner
}
Response
{
"data": {
"dismissRecommendedFollowBanner": AuthorizationError
}
}
dismissSubscribeEmailUserNotification
Description
[AUTHENTICATED] Mark the subscribe email notification as explicitly dismissed
Response
Returns a
User!
Example
Query
mutation DismissSubscribeEmailUserNotification {
dismissSubscribeEmailUserNotification {
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
avatar {
bucket
dominantColor
id
key
url
}
backedArtists {
edges {
...ArtistCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
bannerImage {
bucket
dominantColor
id
key
url
}
collectedReleases {
edges {
...CollectedReleaseConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
creditSplit {
...CreditSplitFragment
}
id
owner {
...UserFragment
}
percent
roles
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
firstNftOwned {
...NftFragment
}
gaNftsCount
goldenEgg {
...EggGameFragment
}
id
nftsCount
ownedTokens {
...OwnedTokenFragment
}
release {
...ReleaseFragment
}
tierPriority
vipNftsCount
}
followerCount
followers {
edges {
...UserRelationConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
following {
edges {
...UserRelationConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
followingCount
id
instagramHandle
invitedByUser {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
affiliateBuyers {
...PlaylistAffiliateBuyerConnectionFragment
}
coverImage {
...MediaFragment
}
coverReleases {
...ReleaseFragment
}
createdAt
deletedAt
description
extendedFrom {
...ShelfFragment
}
id
index
likedBy {
...UserConnectionFragment
}
likes
linkSlug
name
numLikes
numReferralPurchases
numUsersReferred
orderedReleases {
...ShelfReleaseConnectionFragment
}
playTimeInSeconds
previewReleases {
...ShelfReleaseFragment
}
releaseCount
releaseIds
socialProofReferrals {
...UserFragment
}
trackIds
type
user {
...UserFragment
}
webEmbed
webappUri
}
location {
label
placeId
}
nftsOwned
nftsPaginated {
edges {
...NftConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
nonce
numBackedArtists
postCount
publicAddress
roles {
isAdmin
isArtistRelations
}
shelves {
edges {
...ShelfConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
}
Response
{
"data": {
"dismissSubscribeEmailUserNotification": {
"artist": Artist,
"avatar": Media,
"backedArtists": ArtistCollectorConnection,
"bannerImage": Media,
"collectedReleases": CollectedReleaseConnection,
"collectedReleasesCount": 987,
"collectedReleasesIds": ["abc123"],
"collectorPosition": 987,
"createdAt": "2007-12-03T10:15:30Z",
"creditAllocations": [CreditAllocation],
"delegateWalletAddress": "abc123",
"description": "xyz789",
"displayName": "xyz789",
"email": "xyz789",
"ens": "abc123",
"farcasterFid": "xyz789",
"farcasterSignerConnected": false,
"featuredReleases": [CollectedRelease],
"followerCount": 987,
"followers": UserRelationConnection,
"following": UserRelationConnection,
"followingCount": 987,
"id": 4,
"instagramHandle": "xyz789",
"invitedByUser": User,
"isTopNotableCollector": false,
"lastReferralWithdrawableBalance": "xyz789",
"likedSounds": Shelf,
"location": GeoLocationPlaceGoogle,
"nftsOwned": 987,
"nftsPaginated": NftConnection,
"nonce": 987,
"numBackedArtists": 123,
"postCount": 123,
"publicAddress": "abc123",
"roles": UserRoles,
"shelves": ShelfConnection,
"shelvesCount": 123,
"showSplitsFeature": true,
"tiktokUrl": "xyz789",
"topCollectorPosition": 123,
"twitterHandle": "abc123",
"username": "xyz789",
"verifiedNotificationEmail": "xyz789",
"webappUri": "xyz789"
}
}
}
draftMetadataUpload
Description
[ADMIN | ARTIST] Upload draft metadata to Arweave
Response
Returns a
MutationDraftMetadataUploadResult!
Arguments
| Name | Description |
|---|---|
input -
DraftMetadataUploadInput!
|
Input for deployDraft |
Example
Query
mutation DraftMetadataUpload($input: DraftMetadataUploadInput!) {
draftMetadataUpload(input: $input)
}
Variables
{"input": DraftMetadataUploadInput}
Response
{
"data": {
"draftMetadataUpload": ArweavePerUserBudgetExceededError
}
}
draftSplitUpsert
Description
[ARTIST] Associate a split transaction with a draft
Response
Returns a
Draft
Arguments
| Name | Description |
|---|---|
chain -
ChainType!
|
Chain for the transaction |
draftId -
UUID!
|
Draft identifier |
txHash -
String!
|
Transaction hash associated to operation |
Example
Query
mutation DraftSplitUpsert(
$chain: ChainType!,
$draftId: UUID!,
$txHash: String!
) {
draftSplitUpsert(
chain: $chain,
draftId: $draftId,
txHash: $txHash
) {
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
contractAddressSalt
createdAt
edit {
createdAt
id
info {
...DraftEditInfoFragment
}
updatedAt
}
id
info {
allowListInfo {
...DraftAllowListsInfoFragment
}
auctionConfigurations {
...DraftAuctionConfigurationsInfoFragment
}
numUploadStepsComplete
releaseInfo {
...DraftReleaseInfoFragment
}
rewardsInfo {
...RewardsUploadStepInfoFragment
}
splitsInfo {
...SplitsUploadStepInfoFragment
}
}
release {
activityFeed {
...ReleaseActionConnectionFragment
}
affiliates {
...ReleaseAffiliateConnectionFragment
}
airdropCount
animatedCoverImage {
...MediaFragment
}
animatedGoldenEggImageOptimized {
...MediaFragment
}
artist {
...ArtistFragment
}
auctionContractType
auctionType
baseMetadataAttributes {
...MetadataAttributeFragment
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
...ReleaseCollectorConnectionFragment
}
collectorsCount
contract {
...ContractFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
creditSplit {
...CreditSplitFragment
}
credits {
...UserFragment
}
draftId
earliestCollector {
...ReleaseCollectorFragment
}
editionId
eggGame {
...EggGameFragment
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
...MediaFragment
}
gaCoverImage {
...MediaFragment
}
genre {
...GenreFragment
}
goldenEggImage {
...MediaFragment
}
goldenEggNft {
...NftFragment
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
...ReleaseCollectorFragment
}
likedBy {
...UserConnectionFragment
}
listeningParty
listing {
...AuctionListingInterfaceFragment
}
marketPlaceUrl
metadataDetails {
...MetadataDetailsFragment
}
mintStartTime
mintStartTimestamp
nftsPaginated {
...NftConnectionFragment
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
...RewardFragment
}
royaltyBps
saleDetails {
...SaleDetailsFragment
}
saleSchedules {
...SaleScheduleFragment
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
...SamConfigFragment
}
samSellBufferBpsOverride
scheduleIds {
...ScheduleIdentifierFragment
}
season
shelves {
...ShelfConnectionFragment
}
socialProofCollectors {
...UserFragment
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
...MediaFragment
}
staticGaCoverImage {
...MediaFragment
}
staticVipCoverImage {
...MediaFragment
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
...TopReleaseCollectorFragment
}
topPosts {
...PostFragment
}
topSpentCollector {
...ReleaseCollectorFragment
}
totalMinted
totalSupply
track {
...TrackFragment
}
type
vipAnimatedCoverImage {
...MediaFragment
}
vipCoverImage {
...MediaFragment
}
webEmbed
webappUri
}
slug
type
updatedAt
}
}
Variables
{
"chain": "BASE",
"draftId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"txHash": "abc123"
}
Response
{
"data": {
"draftSplitUpsert": {
"artist": Artist,
"contractAddressSalt": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"edit": DraftEdit,
"id": "4",
"info": DraftInfo,
"release": Release,
"slug": "xyz789",
"type": "ALBUM",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
editRelease
Description
[ARTIST] Edit an existing release
Response
Returns a
MutationEditReleaseResult!
Arguments
| Name | Description |
|---|---|
input -
EditReleaseInput!
|
Input for editRelease mutation |
Example
Query
mutation EditRelease($input: EditReleaseInput!) {
editRelease(input: $input)
}
Variables
{"input": EditReleaseInput}
Response
{
"data": {
"editRelease": ArweavePerUserBudgetExceededError
}
}
editReleaseAsync
Description
[ARTIST] Send request to edit release based on inputs
Response
Returns a
MutationEditReleaseAsyncResult!
Arguments
| Name | Description |
|---|---|
input -
MutationEditReleaseAsyncInput!
|
Example
Query
mutation EditReleaseAsync($input: MutationEditReleaseAsyncInput!) {
editReleaseAsync(input: $input)
}
Variables
{"input": MutationEditReleaseAsyncInput}
Response
{
"data": {
"editReleaseAsync": MutationEditReleaseAsyncSuccess
}
}
editionUpdateSchedules
Description
[ADMIN] Update the sales schedules of the specified edition
Response
Returns a
Release!
Arguments
| Name | Description |
|---|---|
chain -
ChainType!
|
Chain for the transaction |
editionAddress -
String
|
|
releaseId -
String
|
Example
Query
mutation EditionUpdateSchedules(
$chain: ChainType!,
$editionAddress: String,
$releaseId: String
) {
editionUpdateSchedules(
chain: $chain,
editionAddress: $editionAddress,
releaseId: $releaseId
) {
activityFeed {
edges {
...ReleaseActionConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
affiliates {
edges {
...ReleaseAffiliateConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
airdropCount
animatedCoverImage {
bucket
dominantColor
id
key
url
}
animatedGoldenEggImageOptimized {
bucket
dominantColor
id
key
url
}
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
auctionContractType
auctionType
baseMetadataAttributes {
traitType
value
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
edges {
...ReleaseCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
collectorsCount
contract {
contractAddress
contractType
createdAt
id
owner {
...UserFragment
}
ownerPublicAddress
updatedAt
}
contractAddress
coverImage {
bucket
dominantColor
id
key
url
}
createdAt
creditSplit {
creditAllocations {
...CreditAllocationFragment
}
id
mintedReleases {
...ReleaseFragment
}
releases {
...ReleaseFragment
}
splitAddress
}
credits {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
draftId
earliestCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
editionId
eggGame {
animatedGoldenEggImageOptimized {
...MediaFragment
}
finalSerialBlockHash
goldenEggImage {
...MediaFragment
}
id
nft {
...NftFragment
}
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
bucket
dominantColor
id
key
url
}
gaCoverImage {
bucket
dominantColor
id
key
url
}
genre {
createdAt
id
name
updatedAt
}
goldenEggImage {
bucket
dominantColor
id
key
url
}
goldenEggNft {
audioUrl
collectorRelease {
...ReleaseCollectorFragment
}
comment {
...CommentFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
createdAtBlockTime
id
isBurned
isGoldenEgg
openSeaMetadataAttributes {
...OpenSeaMetadataAttributeFragment
}
owner {
...UserFragment
}
release {
...ReleaseFragment
}
serialNumber
songSlot
tierNumber
title
tokenId
updatedAt
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
likedBy {
edges {
...UserConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
listeningParty
listing {
chain
contractAddress
id
}
marketPlaceUrl
metadataDetails {
bpm
key
license
location
lyrics
}
mintStartTime
mintStartTimestamp
nftsPaginated {
edges {
...NftConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
description
id
title
}
royaltyBps
saleDetails {
primaryCollected
primaryRaisedInWei
soundSwapCollected
soundSwapRaisedInWei
totalVolume
}
saleSchedules {
affiliateFeeBPS
affiliateFeePercent
artistContractTotalMinted
endTime
id
isPresale
maxMintable
merkleTreeRoot
mintId
minterAddress
price
startTime
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
affiliateFeeBPS
affiliateFeePercent
artistFeeBPS
artistFeePercent
basePrice
buyFreezeTime
goldenEggFeeBPS
goldenEggFeePercent
id
inflectionPoint
inflectionPrice
maxSupply
platformFeeBPS
platformPerTxFlatFee
samAddress
}
samSellBufferBpsOverride
scheduleIds {
mintIds
minterAddress
}
season
shelves {
edges {
...ShelfConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
socialProofCollectors {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
bucket
dominantColor
id
key
url
}
staticGaCoverImage {
bucket
dominantColor
id
key
url
}
staticVipCoverImage {
bucket
dominantColor
id
key
url
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
firstNftCollectedDate
lowestNftSerialNumber
nftsCount
position
user {
...UserFragment
}
}
topPosts {
authorChannelRole
channel {
...ChannelFragment
}
commentCount
comments {
...PostCommentConnectionFragment
}
content
createdAt
creator {
...UserFragment
}
farcasterHash
id
lexicalContent
repostCount
upvoteCount
webappUri
}
topSpentCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
totalMinted
totalSupply
track {
audio {
...AudioMediaFragment
}
audioOriginal {
...MediaFragment
}
duration
id
normalizedPeaks
release {
...ReleaseFragment
}
releaseId
title
trackNumber
}
type
vipAnimatedCoverImage {
bucket
dominantColor
id
key
url
}
vipCoverImage {
bucket
dominantColor
id
key
url
}
webEmbed
webappUri
}
}
Variables
{
"chain": "BASE",
"editionAddress": "abc123",
"releaseId": "xyz789"
}
Response
{
"data": {
"editionUpdateSchedules": {
"activityFeed": ReleaseActionConnection,
"affiliates": ReleaseAffiliateConnection,
"airdropCount": 987,
"animatedCoverImage": Media,
"animatedGoldenEggImageOptimized": Media,
"artist": Artist,
"auctionContractType": "ARTIST",
"auctionType": "FIXED_QUANTITY",
"baseMetadataAttributes": [MetadataAttribute],
"behindTheMusic": "xyz789",
"canCollectorsDownloadAudio": false,
"chainId": 123,
"collectors": ReleaseCollectorConnection,
"collectorsCount": 987,
"contract": Contract,
"contractAddress": "xyz789",
"coverImage": Media,
"createdAt": "2007-12-03T10:15:30Z",
"creditSplit": CreditSplit,
"credits": [User],
"draftId": "abc123",
"earliestCollector": ReleaseCollector,
"editionId": "abc123",
"eggGame": EggGame,
"externalUrl": "xyz789",
"finalQuantity": 987,
"fundingAddress": "abc123",
"gaAnimatedCoverImage": Media,
"gaCoverImage": Media,
"genre": Genre,
"goldenEggImage": Media,
"goldenEggNft": Nft,
"id": 4,
"isAuctionSoldOut": true,
"isFirstPhaseCompleted": true,
"lastUpdatedAt": "2007-12-03T10:15:30Z",
"latestCollector": ReleaseCollector,
"likedBy": UserConnection,
"listeningParty": 1592577642,
"listing": AuctionListingInterface,
"marketPlaceUrl": "abc123",
"metadataDetails": MetadataDetails,
"mintStartTime": 987,
"mintStartTimestamp": 1592577642,
"nftsPaginated": NftConnection,
"numSold": 123,
"openseaUrl": "xyz789",
"postCount": 123,
"price": "xyz789",
"publicAffiliateFeeBPS": 987,
"publicAffiliateFeePercent": "abc123",
"publicMintStart": "2007-12-03T10:15:30Z",
"quantity": 123,
"quantityLowerBound": 123,
"quantityUpperBound": 987,
"rewards": [Reward],
"royaltyBps": 123,
"saleDetails": SaleDetails,
"saleSchedules": [SaleSchedule],
"salesAffiliateFeesPercent": [
"xyz789"
],
"samAddress": "abc123",
"samBuyBufferBpsOverride": 123,
"samConfig": SamConfig,
"samSellBufferBpsOverride": 123,
"scheduleIds": [ScheduleIdentifier],
"season": "abc123",
"shelves": ShelfConnection,
"socialProofCollectors": [User],
"spotifyPresaveCampaign": false,
"spotifyPresaveCount": 987,
"spotifyTrackId": "abc123",
"staticCoverImage": Media,
"staticGaCoverImage": Media,
"staticVipCoverImage": Media,
"supplyCutoffTimestamp": 1592577642,
"title": "abc123",
"titleSlug": "xyz789",
"topCollectors": [TopReleaseCollector],
"topPosts": [Post],
"topSpentCollector": ReleaseCollector,
"totalMinted": 123,
"totalSupply": 987,
"track": Track,
"type": "ALBUM",
"vipAnimatedCoverImage": Media,
"vipCoverImage": Media,
"webEmbed": "xyz789",
"webappUri": "abc123"
}
}
}
extendShelf
Description
[AUTHENTICATED] Extend all the existing releases of a shelf into another shelf
Response
Returns a
MutationExtendShelfResult!
Arguments
| Name | Description |
|---|---|
input -
ExtendShelfInput!
|
Specify source and target shelf |
Example
Query
mutation ExtendShelf($input: ExtendShelfInput!) {
extendShelf(input: $input)
}
Variables
{"input": ExtendShelfInput}
Response
{"data": {"extendShelf": MutationExtendShelfSuccess}}
followAllRecommendedUsers
Description
[AUTHENTICATED] Follow all recommended users in banner
Response
Returns a
MutationFollowAllRecommendedUsersResult
Example
Query
mutation FollowAllRecommendedUsers {
followAllRecommendedUsers
}
Response
{
"data": {
"followAllRecommendedUsers": AuthorizationError
}
}
followUser
Description
[AUTHENTICATED] Follow user of input userId
Response
Returns a
UserRelation!
Arguments
| Name | Description |
|---|---|
input -
FollowUserInput!
|
Follow user inputs |
Example
Query
mutation FollowUser($input: FollowUserInput!) {
followUser(input: $input) {
createdAt
id
relation
userA {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
userB {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
}
}
Variables
{"input": FollowUserInput}
Response
{
"data": {
"followUser": {
"createdAt": "2007-12-03T10:15:30Z",
"id": 4,
"relation": "FOLLOWING",
"userA": User,
"userB": User
}
}
}
generateAuthChallenge
Description
[PUBLIC] Generate auth challenge for given public address and give back new nonce
generatePersonalizedFollowRecommendations
Description
[AUTHENTICATED] Generate personalized follow recommendations based on user taste
Response
Returns a
UserFollowRecommendationBatch
Example
Query
mutation GeneratePersonalizedFollowRecommendations {
generatePersonalizedFollowRecommendations {
type
users {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
}
}
Response
{
"data": {
"generatePersonalizedFollowRecommendations": {
"type": "xyz789",
"users": [User]
}
}
}
likeRelease
Description
[AUTHENTICATED] Like a release.
Response
Returns a
MutationLikeReleaseResult!
Arguments
| Name | Description |
|---|---|
input -
LikeReleaseInput!
|
Like release inputs |
Example
Query
mutation LikeRelease($input: LikeReleaseInput!) {
likeRelease(input: $input)
}
Variables
{"input": LikeReleaseInput}
Response
{"data": {"likeRelease": MutationLikeReleaseSuccess}}
likeShelf
Description
[AUTHENTICATED] Like a shelf.
Response
Returns a
MutationLikeShelfResult!
Arguments
| Name | Description |
|---|---|
input -
LikeShelfInput!
|
Like release inputs |
Example
Query
mutation LikeShelf($input: LikeShelfInput!) {
likeShelf(input: $input)
}
Variables
{"input": LikeShelfInput}
Response
{"data": {"likeShelf": MutationLikeShelfSuccess}}
logout
Description
[AUTHENTICATED] Terminate current session
Response
Returns a
MutationLogoutResult!
Example
Query
mutation Logout {
logout
}
Response
{"data": {"logout": AuthorizationError}}
markAllUserNotificationsRead
Description
[AUTHENTICATED] Mark all current user notifications as read
Response
Returns a
UserNotificationsStatus!
Example
Query
mutation MarkAllUserNotificationsRead {
markAllUserNotificationsRead {
hasUnreadNotifications
id
lastReadTimestamp
user {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
}
}
Response
{
"data": {
"markAllUserNotificationsRead": {
"hasUnreadNotifications": true,
"id": "4",
"lastReadTimestamp": 1592577642,
"user": User
}
}
}
paperMerkleMinterV2SdkClientSecret
Description
[AUTHENTICATED] Generate Paper SDK client secret for MerkleDrop Minter V2 sales.
Response
Arguments
| Name | Description |
|---|---|
input -
PaperMerkleDropMinterV2SdkClientSecretInput!
|
Information needed to generate the client secret |
Example
Query
mutation PaperMerkleMinterV2SdkClientSecret($input: PaperMerkleDropMinterV2SdkClientSecretInput!) {
paperMerkleMinterV2SdkClientSecret(input: $input)
}
Variables
{"input": PaperMerkleDropMinterV2SdkClientSecretInput}
Response
{
"data": {
"paperMerkleMinterV2SdkClientSecret": MutationPaperMerkleMinterV2SdkClientSecretSuccess
}
}
paperMinterAdapterSdkClientSecret
Description
[AUTHENTICATED] Generate Paper SDK client secret for Minter Adapter sales.
Response
Arguments
| Name | Description |
|---|---|
input -
PaperMinterAdapterSdkClientSecretInput!
|
Information needed to generate the client secret |
Example
Query
mutation PaperMinterAdapterSdkClientSecret($input: PaperMinterAdapterSdkClientSecretInput!) {
paperMinterAdapterSdkClientSecret(input: $input)
}
Variables
{"input": PaperMinterAdapterSdkClientSecretInput}
Response
{
"data": {
"paperMinterAdapterSdkClientSecret": MutationPaperMinterAdapterSdkClientSecretSuccess
}
}
paperRangeMinterV2SdkClientSecret
Description
[AUTHENTICATED] Generate Paper SDK client secret for Ranged Minter V2 sales.
Response
Arguments
| Name | Description |
|---|---|
input -
PaperRangedMinterV2SdkClientSecretInput!
|
Information needed to generate the client secret |
Example
Query
mutation PaperRangeMinterV2SdkClientSecret($input: PaperRangedMinterV2SdkClientSecretInput!) {
paperRangeMinterV2SdkClientSecret(input: $input)
}
Variables
{"input": PaperRangedMinterV2SdkClientSecretInput}
Response
{
"data": {
"paperRangeMinterV2SdkClientSecret": MutationPaperRangeMinterV2SdkClientSecretSuccess
}
}
paperSoundSwapSdkClientSecret
Description
[AUTHENTICATED] Generate Paper SDK client secret for Sound Swap sales.
Response
Arguments
| Name | Description |
|---|---|
input -
PaperSoundSwapSdkClientSecretInput!
|
Information needed to generate the client secret |
Example
Query
mutation PaperSoundSwapSdkClientSecret($input: PaperSoundSwapSdkClientSecretInput!) {
paperSoundSwapSdkClientSecret(input: $input)
}
Variables
{"input": PaperSoundSwapSdkClientSecretInput}
Response
{
"data": {
"paperSoundSwapSdkClientSecret": MutationPaperSoundSwapSdkClientSecretSuccess
}
}
paperSuperMinterSdkClientSecret
Description
[AUTHENTICATED] Generate Paper SDK client secret for Super Minter sales.
Response
Arguments
| Name | Description |
|---|---|
input -
PaperSuperMinterSdkClientSecretInput!
|
Information needed to generate the client secret |
Example
Query
mutation PaperSuperMinterSdkClientSecret($input: PaperSuperMinterSdkClientSecretInput!) {
paperSuperMinterSdkClientSecret(input: $input)
}
Variables
{"input": PaperSuperMinterSdkClientSecretInput}
Response
{
"data": {
"paperSuperMinterSdkClientSecret": MutationPaperSuperMinterSdkClientSecretSuccess
}
}
pinReleasePostToWaveform
Description
[AUTHENTICATED] Release collectors only. Pins a release post to the waveform
Response
Returns a
MutationPinReleasePostToWaveformResult!
Arguments
| Name | Description |
|---|---|
input -
PinReleasePostToWaveformInput!
|
Input to pin a release post to the waveform |
Example
Query
mutation PinReleasePostToWaveform($input: PinReleasePostToWaveformInput!) {
pinReleasePostToWaveform(input: $input)
}
Variables
{"input": PinReleasePostToWaveformInput}
Response
{
"data": {
"pinReleasePostToWaveform": DidNotGoThroughError
}
}
prepareMintDraft
Description
[ADMIN | ARTIST] Prepare draft before minting, creating merkle trees based on the allowlists specified on the draft info.
Response
Returns a
MutationPrepareMintDraftResult!
Arguments
| Name | Description |
|---|---|
input -
PrepareMintDraftInput!
|
Input for prepareMintDraft |
Example
Query
mutation PrepareMintDraft($input: PrepareMintDraftInput!) {
prepareMintDraft(input: $input)
}
Variables
{"input": PrepareMintDraftInput}
Response
{"data": {"prepareMintDraft": AlreadyMintedError}}
prepareMintDraftAsync
Description
[ADMIN | ARTIST] Async prepare draft before minting, creating merkle trees based on the allowlists specified on the draft info.
Response
Returns a
MutationPrepareMintDraftAsyncResult!
Arguments
| Name | Description |
|---|---|
input -
PrepareMintDraftAsyncInput!
|
Input for prepareMintDraftAsync |
Example
Query
mutation PrepareMintDraftAsync($input: PrepareMintDraftAsyncInput!) {
prepareMintDraftAsync(input: $input)
}
Variables
{"input": PrepareMintDraftAsyncInput}
Response
{"data": {"prepareMintDraftAsync": AlreadyMintedError}}
prepareMintTieredDraftAsync
Description
[ADMIN | ARTIST] Async prepare draft before minting, creating merkle trees based on the allowlists specified on the draft info.
Response
Arguments
| Name | Description |
|---|---|
input -
MutationPrepareMintTieredDraftAsyncInput!
|
Input for prepareMintTieredDraftAsync mutation |
Example
Query
mutation PrepareMintTieredDraftAsync($input: MutationPrepareMintTieredDraftAsyncInput!) {
prepareMintTieredDraftAsync(input: $input)
}
Variables
{"input": MutationPrepareMintTieredDraftAsyncInput}
Response
{
"data": {
"prepareMintTieredDraftAsync": AlreadyMintedError
}
}
presaveRelease
Description
[AUTHENTICATED] Spotify presave a release
Response
Returns a
MutationPresaveReleaseResult!
Arguments
| Name | Description |
|---|---|
input -
MutationPresaveReleaseInput!
|
Input for presaveRelease mutation |
Example
Query
mutation PresaveRelease($input: MutationPresaveReleaseInput!) {
presaveRelease(input: $input)
}
Variables
{"input": MutationPresaveReleaseInput}
Response
{"data": {"presaveRelease": AuthorizationError}}
recoverShelf
Description
[AUTHENTICATED] Recover a deleted shelf
Response
Returns a
MutationRecoverShelfResult!
Arguments
| Name | Description |
|---|---|
deletedShelfId -
UUID!
|
Unique identifier of deleted shelf |
Example
Query
mutation RecoverShelf($deletedShelfId: UUID!) {
recoverShelf(deletedShelfId: $deletedShelfId)
}
Variables
{
"deletedShelfId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{"data": {"recoverShelf": MutationRecoverShelfSuccess}}
registerDraftCreateSplitTx
Description
[ARTIST] Manually register draft split transaction
Response
Returns a
Transaction!
Arguments
| Name | Description |
|---|---|
chain -
ChainType!
|
the chain for the transaction |
draftId -
UUID!
|
Draft entity identifier |
hash -
String!
|
Transaction hash |
Example
Query
mutation RegisterDraftCreateSplitTx(
$chain: ChainType!,
$draftId: UUID!,
$hash: String!
) {
registerDraftCreateSplitTx(
chain: $chain,
draftId: $draftId,
hash: $hash
) {
chainId
contractMethod
hash
id
releaseId
status
}
}
Variables
{
"chain": "BASE",
"draftId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"hash": "xyz789"
}
Response
{
"data": {
"registerDraftCreateSplitTx": {
"chainId": 123,
"contractMethod": "AFFILIATE__WITHDRAW",
"hash": "xyz789",
"id": "4",
"releaseId": "xyz789",
"status": "xyz789"
}
}
}
registerMobileDeviceToken
Description
[AUTHENTICATED] Register mobile device token for user
Response
Returns a
String!
Arguments
| Name | Description |
|---|---|
registration -
RegisterMobileDeviceInput!
|
Device registration input |
Example
Query
mutation RegisterMobileDeviceToken($registration: RegisterMobileDeviceInput!) {
registerMobileDeviceToken(registration: $registration)
}
Variables
{"registration": RegisterMobileDeviceInput}
Response
{
"data": {
"registerMobileDeviceToken": "xyz789"
}
}
rejectArtistApplication
Description
[ADMIN | ARTIST_RELATIONS] Reject artist application
Response
Returns a
MutationRejectArtistApplicationResult!
Arguments
| Name | Description |
|---|---|
input -
RejectArtistApplicationInput!
|
Reject artist application input arguments |
Example
Query
mutation RejectArtistApplication($input: RejectArtistApplicationInput!) {
rejectArtistApplication(input: $input)
}
Variables
{"input": RejectArtistApplicationInput}
Response
{
"data": {
"rejectArtistApplication": MutationRejectArtistApplicationSuccess
}
}
removePostComment
Description
[AUTHENTICATED] Deletes a post comment
Response
Returns a
MutationRemovePostCommentResult!
Arguments
| Name | Description |
|---|---|
input -
MutationRemovePostCommentInput!
|
Example
Query
mutation RemovePostComment($input: MutationRemovePostCommentInput!) {
removePostComment(input: $input)
}
Variables
{"input": MutationRemovePostCommentInput}
Response
{
"data": {
"removePostComment": MutationRemovePostCommentSuccess
}
}
removePostCommentReply
Description
[AUTHENTICATED] Deletes a post comment reply
Response
Returns a
MutationRemovePostCommentReplyResult!
Arguments
| Name | Description |
|---|---|
input -
MutationRemovePostCommentReplyInput!
|
Example
Query
mutation RemovePostCommentReply($input: MutationRemovePostCommentReplyInput!) {
removePostCommentReply(input: $input)
}
Variables
{"input": MutationRemovePostCommentReplyInput}
Response
{
"data": {
"removePostCommentReply": MutationRemovePostCommentReplySuccess
}
}
removeReleaseFromShelf
Description
[AUTHENTICATED] Remove specified release from the owned shelf
Response
Returns a
MutationRemoveReleaseFromShelfResult!
Arguments
| Name | Description |
|---|---|
input -
RemoveReleaseFromShelfInput!
|
Information of shelf and release to be removed |
Example
Query
mutation RemoveReleaseFromShelf($input: RemoveReleaseFromShelfInput!) {
removeReleaseFromShelf(input: $input)
}
Variables
{"input": RemoveReleaseFromShelfInput}
Response
{
"data": {
"removeReleaseFromShelf": MutationRemoveReleaseFromShelfSuccess
}
}
reportPlayStopped
Description
[PUBLIC] Report a track play session stop
Response
Returns a
Void
Arguments
| Name | Description |
|---|---|
input -
ReportPlayStoppedInput!
|
Input for reportPlayStopped |
Example
Query
mutation ReportPlayStopped($input: ReportPlayStoppedInput!) {
reportPlayStopped(input: $input)
}
Variables
{"input": ReportPlayStoppedInput}
Response
{"data": {"reportPlayStopped": null}}
repost
Description
[AUTHENTICATED] Repost a existing post.
Response
Returns a
MutationRepostResult!
Arguments
| Name | Description |
|---|---|
input -
MutationRepostInput!
|
Input for repost mutation |
Example
Query
mutation Repost($input: MutationRepostInput!) {
repost(input: $input)
}
Variables
{"input": MutationRepostInput}
Response
{"data": {"repost": MutationRepostSuccess}}
resetInstagramHandle
Description
[AUTHENTICATED] Reset instagram handle of authenticated user
Response
Returns a
MutationResetInstagramHandleResult!
Example
Query
mutation ResetInstagramHandle {
resetInstagramHandle
}
Response
{
"data": {
"resetInstagramHandle": MutationResetInstagramHandleSuccess
}
}
resetTwitterHandle
Description
[AUTHENTICATED] Reset twitter handle of authenticated user
Response
Returns a
MutationResetTwitterHandleResult!
Example
Query
mutation ResetTwitterHandle {
resetTwitterHandle
}
Response
{
"data": {
"resetTwitterHandle": MutationResetTwitterHandleSuccess
}
}
seasonAuctionMeta
Description
[ADMIN] Configure season-based meta-auction options
Response
Returns a
SeasonAuctionDefaults!
Arguments
| Name | Description |
|---|---|
metaType -
AuctionMetaInput
|
Meta options |
seasonName -
String!
|
Season to configure |
Example
Query
mutation SeasonAuctionMeta(
$metaType: AuctionMetaInput,
$seasonName: String!
) {
seasonAuctionMeta(
metaType: $metaType,
seasonName: $seasonName
) {
createdAt
id
season
}
}
Variables
{
"metaType": AuctionMetaInput,
"seasonName": "abc123"
}
Response
{
"data": {
"seasonAuctionMeta": {
"createdAt": "2007-12-03T10:15:30Z",
"id": 4,
"season": "xyz789"
}
}
}
seasonMintingOption
Description
[ADMIN] Change season-based auction options
Response
Returns a
SeasonAuctionDefaults!
Arguments
| Name | Description |
|---|---|
auctionType -
AuctionInputRef!
|
Auction sale types to customize |
seasonName -
String!
|
Season to customize minting options |
Example
Query
mutation SeasonMintingOption(
$auctionType: AuctionInputRef!,
$seasonName: String!
) {
seasonMintingOption(
auctionType: $auctionType,
seasonName: $seasonName
) {
createdAt
id
season
}
}
Variables
{
"auctionType": AuctionInputRef,
"seasonName": "xyz789"
}
Response
{
"data": {
"seasonMintingOption": {
"createdAt": "2007-12-03T10:15:30Z",
"id": 4,
"season": "xyz789"
}
}
}
selectSongSlotUsingNftId
Description
[AUTHENTICATED] Select song slot for owned NFT
Response
Returns a
MutationSelectSongSlotUsingNftIdResult!
Example
Query
mutation SelectSongSlotUsingNftId(
$nftId: UUID!,
$songSlot: Int!
) {
selectSongSlotUsingNftId(
nftId: $nftId,
songSlot: $songSlot
)
}
Variables
{
"nftId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"songSlot": 123
}
Response
{"data": {"selectSongSlotUsingNftId": AuthorizationError}}
setAffiliatePurchaseSource
Description
[AUTHENTICATED] Set the source of an affiliate purchase. Returns the count of current affiliate purchases updated
Response
Arguments
| Name | Description |
|---|---|
input -
AffiliateSourceInput!
|
Input to set affiliate source to a purchase transaction |
Example
Query
mutation SetAffiliatePurchaseSource($input: AffiliateSourceInput!) {
setAffiliatePurchaseSource(input: $input)
}
Variables
{"input": AffiliateSourceInput}
Response
{
"data": {
"setAffiliatePurchaseSource": MutationSetAffiliatePurchaseSourceSuccess
}
}
setArtistMeta
Description
[ARTIST_RELATIONS | ADMIN] Set artist metadata
Response
Returns an
Artist!
Arguments
| Name | Description |
|---|---|
input -
SetArtistMetaInput!
|
Input for setArtistMeta mutation |
Example
Query
mutation SetArtistMeta($input: SetArtistMetaInput!) {
setArtistMeta(input: $input) {
bannerImage {
bucket
dominantColor
id
key
url
}
collectors {
edges {
...ArtistCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
activityFeed {
...ReleaseActionConnectionFragment
}
affiliates {
...ReleaseAffiliateConnectionFragment
}
airdropCount
animatedCoverImage {
...MediaFragment
}
animatedGoldenEggImageOptimized {
...MediaFragment
}
artist {
...ArtistFragment
}
auctionContractType
auctionType
baseMetadataAttributes {
...MetadataAttributeFragment
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
...ReleaseCollectorConnectionFragment
}
collectorsCount
contract {
...ContractFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
creditSplit {
...CreditSplitFragment
}
credits {
...UserFragment
}
draftId
earliestCollector {
...ReleaseCollectorFragment
}
editionId
eggGame {
...EggGameFragment
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
...MediaFragment
}
gaCoverImage {
...MediaFragment
}
genre {
...GenreFragment
}
goldenEggImage {
...MediaFragment
}
goldenEggNft {
...NftFragment
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
...ReleaseCollectorFragment
}
likedBy {
...UserConnectionFragment
}
listeningParty
listing {
...AuctionListingInterfaceFragment
}
marketPlaceUrl
metadataDetails {
...MetadataDetailsFragment
}
mintStartTime
mintStartTimestamp
nftsPaginated {
...NftConnectionFragment
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
...RewardFragment
}
royaltyBps
saleDetails {
...SaleDetailsFragment
}
saleSchedules {
...SaleScheduleFragment
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
...SamConfigFragment
}
samSellBufferBpsOverride
scheduleIds {
...ScheduleIdentifierFragment
}
season
shelves {
...ShelfConnectionFragment
}
socialProofCollectors {
...UserFragment
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
...MediaFragment
}
staticGaCoverImage {
...MediaFragment
}
staticVipCoverImage {
...MediaFragment
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
...TopReleaseCollectorFragment
}
topPosts {
...PostFragment
}
topSpentCollector {
...ReleaseCollectorFragment
}
totalMinted
totalSupply
track {
...TrackFragment
}
type
vipAnimatedCoverImage {
...MediaFragment
}
vipCoverImage {
...MediaFragment
}
webEmbed
webappUri
}
releases {
edges {
...ReleaseConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
userId
webappUri
}
}
Variables
{"input": SetArtistMetaInput}
Response
{
"data": {
"setArtistMeta": {
"bannerImage": Media,
"collectors": ArtistCollectorConnection,
"createdAt": "2007-12-03T10:15:30Z",
"gemCollectionUrl": "xyz789",
"id": 4,
"name": "xyz789",
"numCollectors": 123,
"numNfts": 987,
"numReleases": 987,
"pickedRelease": Release,
"releases": ReleaseConnection,
"releasesGenres": ["xyz789"],
"season": "abc123",
"soundHandle": "abc123",
"spotifyUrl": "abc123",
"tokenSymbol": "abc123",
"user": User,
"userId": "abc123",
"webappUri": "abc123"
}
}
}
setArtistOnboardedByPublicAddressMeta
Description
Set artist onboardedByPublicAddress metadata
Response
Returns an
Artist!
Arguments
| Name | Description |
|---|---|
input -
SetArtistOnboardedByPublicAddressMetaInput!
|
Input for setArtistOnboardedByPublicAddresMeta mutation |
Example
Query
mutation SetArtistOnboardedByPublicAddressMeta($input: SetArtistOnboardedByPublicAddressMetaInput!) {
setArtistOnboardedByPublicAddressMeta(input: $input) {
bannerImage {
bucket
dominantColor
id
key
url
}
collectors {
edges {
...ArtistCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
activityFeed {
...ReleaseActionConnectionFragment
}
affiliates {
...ReleaseAffiliateConnectionFragment
}
airdropCount
animatedCoverImage {
...MediaFragment
}
animatedGoldenEggImageOptimized {
...MediaFragment
}
artist {
...ArtistFragment
}
auctionContractType
auctionType
baseMetadataAttributes {
...MetadataAttributeFragment
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
...ReleaseCollectorConnectionFragment
}
collectorsCount
contract {
...ContractFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
creditSplit {
...CreditSplitFragment
}
credits {
...UserFragment
}
draftId
earliestCollector {
...ReleaseCollectorFragment
}
editionId
eggGame {
...EggGameFragment
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
...MediaFragment
}
gaCoverImage {
...MediaFragment
}
genre {
...GenreFragment
}
goldenEggImage {
...MediaFragment
}
goldenEggNft {
...NftFragment
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
...ReleaseCollectorFragment
}
likedBy {
...UserConnectionFragment
}
listeningParty
listing {
...AuctionListingInterfaceFragment
}
marketPlaceUrl
metadataDetails {
...MetadataDetailsFragment
}
mintStartTime
mintStartTimestamp
nftsPaginated {
...NftConnectionFragment
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
...RewardFragment
}
royaltyBps
saleDetails {
...SaleDetailsFragment
}
saleSchedules {
...SaleScheduleFragment
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
...SamConfigFragment
}
samSellBufferBpsOverride
scheduleIds {
...ScheduleIdentifierFragment
}
season
shelves {
...ShelfConnectionFragment
}
socialProofCollectors {
...UserFragment
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
...MediaFragment
}
staticGaCoverImage {
...MediaFragment
}
staticVipCoverImage {
...MediaFragment
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
...TopReleaseCollectorFragment
}
topPosts {
...PostFragment
}
topSpentCollector {
...ReleaseCollectorFragment
}
totalMinted
totalSupply
track {
...TrackFragment
}
type
vipAnimatedCoverImage {
...MediaFragment
}
vipCoverImage {
...MediaFragment
}
webEmbed
webappUri
}
releases {
edges {
...ReleaseConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
userId
webappUri
}
}
Variables
{"input": SetArtistOnboardedByPublicAddressMetaInput}
Response
{
"data": {
"setArtistOnboardedByPublicAddressMeta": {
"bannerImage": Media,
"collectors": ArtistCollectorConnection,
"createdAt": "2007-12-03T10:15:30Z",
"gemCollectionUrl": "xyz789",
"id": 4,
"name": "abc123",
"numCollectors": 123,
"numNfts": 987,
"numReleases": 123,
"pickedRelease": Release,
"releases": ReleaseConnection,
"releasesGenres": ["abc123"],
"season": "xyz789",
"soundHandle": "abc123",
"spotifyUrl": "abc123",
"tokenSymbol": "xyz789",
"user": User,
"userId": "xyz789",
"webappUri": "xyz789"
}
}
}
setArtistPickedRelease
Description
[ARTIST] Set picked release to show in profile. If releaseId is null, the picked release will be removed.
Response
Returns a
MutationSetArtistPickedReleaseResult
Arguments
| Name | Description |
|---|---|
releaseId -
UUID
|
Release id |
Example
Query
mutation SetArtistPickedRelease($releaseId: UUID) {
setArtistPickedRelease(releaseId: $releaseId)
}
Variables
{
"releaseId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{"data": {"setArtistPickedRelease": AuthorizationError}}
setAudioDownloadReward
Description
[ARTIST] Set status to toggle audio download reward for collectors
Response
Returns a
MutationSetAudioDownloadRewardResult!
Arguments
| Name | Description |
|---|---|
input -
SetAudioDownloadRewardInput!
|
Input for setAudioDownloadReward mutation |
Example
Query
mutation SetAudioDownloadReward($input: SetAudioDownloadRewardInput!) {
setAudioDownloadReward(input: $input)
}
Variables
{"input": SetAudioDownloadRewardInput}
Response
{
"data": {
"setAudioDownloadReward": MutationSetAudioDownloadRewardSuccess
}
}
setBlockNumber
Description
[ADMIN] Manually set the last processed block number, used primarily by sound.xyz watcher
setComment
Description
[AUTHENTICATED] Set comment for specified Nft
Response
Returns a
Nft!
Example
Query
mutation SetComment(
$message: String!,
$nftId: UUID!,
$signature: String
) {
setComment(
message: $message,
nftId: $nftId,
signature: $signature
) {
audioUrl
collectorRelease {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
comment {
createdAt
id
message
signature
updatedAt
}
contractAddress
coverImage {
bucket
dominantColor
id
key
url
}
createdAt
createdAtBlockTime
id
isBurned
isGoldenEgg
openSeaMetadataAttributes {
traitType
value
}
owner {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
release {
activityFeed {
...ReleaseActionConnectionFragment
}
affiliates {
...ReleaseAffiliateConnectionFragment
}
airdropCount
animatedCoverImage {
...MediaFragment
}
animatedGoldenEggImageOptimized {
...MediaFragment
}
artist {
...ArtistFragment
}
auctionContractType
auctionType
baseMetadataAttributes {
...MetadataAttributeFragment
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
...ReleaseCollectorConnectionFragment
}
collectorsCount
contract {
...ContractFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
creditSplit {
...CreditSplitFragment
}
credits {
...UserFragment
}
draftId
earliestCollector {
...ReleaseCollectorFragment
}
editionId
eggGame {
...EggGameFragment
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
...MediaFragment
}
gaCoverImage {
...MediaFragment
}
genre {
...GenreFragment
}
goldenEggImage {
...MediaFragment
}
goldenEggNft {
...NftFragment
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
...ReleaseCollectorFragment
}
likedBy {
...UserConnectionFragment
}
listeningParty
listing {
...AuctionListingInterfaceFragment
}
marketPlaceUrl
metadataDetails {
...MetadataDetailsFragment
}
mintStartTime
mintStartTimestamp
nftsPaginated {
...NftConnectionFragment
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
...RewardFragment
}
royaltyBps
saleDetails {
...SaleDetailsFragment
}
saleSchedules {
...SaleScheduleFragment
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
...SamConfigFragment
}
samSellBufferBpsOverride
scheduleIds {
...ScheduleIdentifierFragment
}
season
shelves {
...ShelfConnectionFragment
}
socialProofCollectors {
...UserFragment
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
...MediaFragment
}
staticGaCoverImage {
...MediaFragment
}
staticVipCoverImage {
...MediaFragment
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
...TopReleaseCollectorFragment
}
topPosts {
...PostFragment
}
topSpentCollector {
...ReleaseCollectorFragment
}
totalMinted
totalSupply
track {
...TrackFragment
}
type
vipAnimatedCoverImage {
...MediaFragment
}
vipCoverImage {
...MediaFragment
}
webEmbed
webappUri
}
serialNumber
songSlot
tierNumber
title
tokenId
updatedAt
}
}
Variables
{
"message": "xyz789",
"nftId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"signature": "abc123"
}
Response
{
"data": {
"setComment": {
"audioUrl": "xyz789",
"collectorRelease": ReleaseCollector,
"comment": Comment,
"contractAddress": "xyz789",
"coverImage": Media,
"createdAt": "2007-12-03T10:15:30Z",
"createdAtBlockTime": "2007-12-03T10:15:30Z",
"id": "4",
"isBurned": true,
"isGoldenEgg": false,
"openSeaMetadataAttributes": [
OpenSeaMetadataAttribute
],
"owner": User,
"release": Release,
"serialNumber": 987,
"songSlot": 987,
"tierNumber": 987,
"title": "abc123",
"tokenId": 4,
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
setDelegateAddress
Description
[AUTHENTICATED] Delegate address of user to be used. Set to NULL to remove the delegate address from the account.
Response
Returns a
User!
Arguments
| Name | Description |
|---|---|
delegateAddress -
Address
|
Delegate address of user to be used |
Example
Query
mutation SetDelegateAddress($delegateAddress: Address) {
setDelegateAddress(delegateAddress: $delegateAddress) {
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
avatar {
bucket
dominantColor
id
key
url
}
backedArtists {
edges {
...ArtistCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
bannerImage {
bucket
dominantColor
id
key
url
}
collectedReleases {
edges {
...CollectedReleaseConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
creditSplit {
...CreditSplitFragment
}
id
owner {
...UserFragment
}
percent
roles
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
firstNftOwned {
...NftFragment
}
gaNftsCount
goldenEgg {
...EggGameFragment
}
id
nftsCount
ownedTokens {
...OwnedTokenFragment
}
release {
...ReleaseFragment
}
tierPriority
vipNftsCount
}
followerCount
followers {
edges {
...UserRelationConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
following {
edges {
...UserRelationConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
followingCount
id
instagramHandle
invitedByUser {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
affiliateBuyers {
...PlaylistAffiliateBuyerConnectionFragment
}
coverImage {
...MediaFragment
}
coverReleases {
...ReleaseFragment
}
createdAt
deletedAt
description
extendedFrom {
...ShelfFragment
}
id
index
likedBy {
...UserConnectionFragment
}
likes
linkSlug
name
numLikes
numReferralPurchases
numUsersReferred
orderedReleases {
...ShelfReleaseConnectionFragment
}
playTimeInSeconds
previewReleases {
...ShelfReleaseFragment
}
releaseCount
releaseIds
socialProofReferrals {
...UserFragment
}
trackIds
type
user {
...UserFragment
}
webEmbed
webappUri
}
location {
label
placeId
}
nftsOwned
nftsPaginated {
edges {
...NftConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
nonce
numBackedArtists
postCount
publicAddress
roles {
isAdmin
isArtistRelations
}
shelves {
edges {
...ShelfConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
}
Variables
{"delegateAddress": Address}
Response
{
"data": {
"setDelegateAddress": {
"artist": Artist,
"avatar": Media,
"backedArtists": ArtistCollectorConnection,
"bannerImage": Media,
"collectedReleases": CollectedReleaseConnection,
"collectedReleasesCount": 123,
"collectedReleasesIds": ["abc123"],
"collectorPosition": 123,
"createdAt": "2007-12-03T10:15:30Z",
"creditAllocations": [CreditAllocation],
"delegateWalletAddress": "abc123",
"description": "xyz789",
"displayName": "xyz789",
"email": "abc123",
"ens": "xyz789",
"farcasterFid": "abc123",
"farcasterSignerConnected": true,
"featuredReleases": [CollectedRelease],
"followerCount": 987,
"followers": UserRelationConnection,
"following": UserRelationConnection,
"followingCount": 987,
"id": "4",
"instagramHandle": "xyz789",
"invitedByUser": User,
"isTopNotableCollector": true,
"lastReferralWithdrawableBalance": "xyz789",
"likedSounds": Shelf,
"location": GeoLocationPlaceGoogle,
"nftsOwned": 987,
"nftsPaginated": NftConnection,
"nonce": 987,
"numBackedArtists": 987,
"postCount": 123,
"publicAddress": "abc123",
"roles": UserRoles,
"shelves": ShelfConnection,
"shelvesCount": 987,
"showSplitsFeature": true,
"tiktokUrl": "abc123",
"topCollectorPosition": 987,
"twitterHandle": "xyz789",
"username": "xyz789",
"verifiedNotificationEmail": "xyz789",
"webappUri": "xyz789"
}
}
}
setFeaturedSounds
Description
[AUTHENTICATED] Update releases to be returned in featured sounds
Response
Returns a
User!
Arguments
| Name | Description |
|---|---|
releaseIds -
[UUID!]!
|
List of releases that can not exceed length of 1 |
Example
Query
mutation SetFeaturedSounds($releaseIds: [UUID!]!) {
setFeaturedSounds(releaseIds: $releaseIds) {
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
avatar {
bucket
dominantColor
id
key
url
}
backedArtists {
edges {
...ArtistCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
bannerImage {
bucket
dominantColor
id
key
url
}
collectedReleases {
edges {
...CollectedReleaseConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
creditSplit {
...CreditSplitFragment
}
id
owner {
...UserFragment
}
percent
roles
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
firstNftOwned {
...NftFragment
}
gaNftsCount
goldenEgg {
...EggGameFragment
}
id
nftsCount
ownedTokens {
...OwnedTokenFragment
}
release {
...ReleaseFragment
}
tierPriority
vipNftsCount
}
followerCount
followers {
edges {
...UserRelationConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
following {
edges {
...UserRelationConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
followingCount
id
instagramHandle
invitedByUser {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
affiliateBuyers {
...PlaylistAffiliateBuyerConnectionFragment
}
coverImage {
...MediaFragment
}
coverReleases {
...ReleaseFragment
}
createdAt
deletedAt
description
extendedFrom {
...ShelfFragment
}
id
index
likedBy {
...UserConnectionFragment
}
likes
linkSlug
name
numLikes
numReferralPurchases
numUsersReferred
orderedReleases {
...ShelfReleaseConnectionFragment
}
playTimeInSeconds
previewReleases {
...ShelfReleaseFragment
}
releaseCount
releaseIds
socialProofReferrals {
...UserFragment
}
trackIds
type
user {
...UserFragment
}
webEmbed
webappUri
}
location {
label
placeId
}
nftsOwned
nftsPaginated {
edges {
...NftConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
nonce
numBackedArtists
postCount
publicAddress
roles {
isAdmin
isArtistRelations
}
shelves {
edges {
...ShelfConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
}
Variables
{
"releaseIds": [
"6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
]
}
Response
{
"data": {
"setFeaturedSounds": {
"artist": Artist,
"avatar": Media,
"backedArtists": ArtistCollectorConnection,
"bannerImage": Media,
"collectedReleases": CollectedReleaseConnection,
"collectedReleasesCount": 987,
"collectedReleasesIds": ["xyz789"],
"collectorPosition": 987,
"createdAt": "2007-12-03T10:15:30Z",
"creditAllocations": [CreditAllocation],
"delegateWalletAddress": "abc123",
"description": "xyz789",
"displayName": "abc123",
"email": "abc123",
"ens": "xyz789",
"farcasterFid": "xyz789",
"farcasterSignerConnected": false,
"featuredReleases": [CollectedRelease],
"followerCount": 987,
"followers": UserRelationConnection,
"following": UserRelationConnection,
"followingCount": 123,
"id": 4,
"instagramHandle": "abc123",
"invitedByUser": User,
"isTopNotableCollector": false,
"lastReferralWithdrawableBalance": "xyz789",
"likedSounds": Shelf,
"location": GeoLocationPlaceGoogle,
"nftsOwned": 123,
"nftsPaginated": NftConnection,
"nonce": 123,
"numBackedArtists": 123,
"postCount": 987,
"publicAddress": "abc123",
"roles": UserRoles,
"shelves": ShelfConnection,
"shelvesCount": 123,
"showSplitsFeature": true,
"tiktokUrl": "abc123",
"topCollectorPosition": 987,
"twitterHandle": "abc123",
"username": "abc123",
"verifiedNotificationEmail": "abc123",
"webappUri": "abc123"
}
}
}
setHidePostsFromTrendingStatus
Description
[ADMIN] Hide or unhide posts by user from trending
Response
Returns a
Void
Arguments
| Name | Description |
|---|---|
input -
HidePostsFromTrendingStatusInput!
|
Hide status input |
Example
Query
mutation SetHidePostsFromTrendingStatus($input: HidePostsFromTrendingStatusInput!) {
setHidePostsFromTrendingStatus(input: $input)
}
Variables
{"input": HidePostsFromTrendingStatusInput}
Response
{"data": {"setHidePostsFromTrendingStatus": null}}
setInvitedByUser
Description
[AUTHENTICATED] Set user that invited authenticated user
Response
Returns a
MutationSetInvitedByUserResult!
Arguments
| Name | Description |
|---|---|
invitedBy -
UUID
|
Invited user input. Set null to remove invited user. |
Example
Query
mutation SetInvitedByUser($invitedBy: UUID) {
setInvitedByUser(invitedBy: $invitedBy)
}
Variables
{
"invitedBy": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"setInvitedByUser": MutationSetInvitedByUserSuccess
}
}
setReceiveArtistUpdateEmails
Description
[AUTHENTICATED] Subscribe and unsubscribe authenticated user from artist update emails
Response
Arguments
| Name | Description |
|---|---|
enable -
Boolean!
|
Enable or disable artist update emails |
Example
Query
mutation SetReceiveArtistUpdateEmails($enable: Boolean!) {
setReceiveArtistUpdateEmails(enable: $enable)
}
Variables
{"enable": true}
Response
{
"data": {
"setReceiveArtistUpdateEmails": CustomerIoAPICallError
}
}
setReceiveMentionUpdateEmails
Description
[AUTHENTICATED] Subscribe and unsubscribe authenticated user from mention update emails
Response
Arguments
| Name | Description |
|---|---|
enable -
Boolean!
|
Enable or disable mention update emails. |
Example
Query
mutation SetReceiveMentionUpdateEmails($enable: Boolean!) {
setReceiveMentionUpdateEmails(enable: $enable)
}
Variables
{"enable": true}
Response
{
"data": {
"setReceiveMentionUpdateEmails": CustomerIoAPICallError
}
}
setReceivePushNotifications
Description
[AUTHENTICATED] Enable or disable push notifications.
Response
Returns a
UserNotificationPreferences!
Arguments
| Name | Description |
|---|---|
enable -
Boolean!
|
Enable or disable push notifications |
Example
Query
mutation SetReceivePushNotifications($enable: Boolean!) {
setReceivePushNotifications(enable: $enable) {
email
emailVerificationStatus
receiveArtistUpdateEmails
receiveMentionUpdateEmails
receivePushNotifications
}
}
Variables
{"enable": false}
Response
{
"data": {
"setReceivePushNotifications": {
"email": "xyz789",
"emailVerificationStatus": "EXPIRED",
"receiveArtistUpdateEmails": false,
"receiveMentionUpdateEmails": false,
"receivePushNotifications": true
}
}
}
setReleaseDetails
Description
[ADMIN | ARTIST_RELATIONS] Set details of release
Response
Returns a
Release!
Arguments
| Name | Description |
|---|---|
input -
SetReleaseDetailsInput!
|
Release details info |
Example
Query
mutation SetReleaseDetails($input: SetReleaseDetailsInput!) {
setReleaseDetails(input: $input) {
activityFeed {
edges {
...ReleaseActionConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
affiliates {
edges {
...ReleaseAffiliateConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
airdropCount
animatedCoverImage {
bucket
dominantColor
id
key
url
}
animatedGoldenEggImageOptimized {
bucket
dominantColor
id
key
url
}
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
auctionContractType
auctionType
baseMetadataAttributes {
traitType
value
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
edges {
...ReleaseCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
collectorsCount
contract {
contractAddress
contractType
createdAt
id
owner {
...UserFragment
}
ownerPublicAddress
updatedAt
}
contractAddress
coverImage {
bucket
dominantColor
id
key
url
}
createdAt
creditSplit {
creditAllocations {
...CreditAllocationFragment
}
id
mintedReleases {
...ReleaseFragment
}
releases {
...ReleaseFragment
}
splitAddress
}
credits {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
draftId
earliestCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
editionId
eggGame {
animatedGoldenEggImageOptimized {
...MediaFragment
}
finalSerialBlockHash
goldenEggImage {
...MediaFragment
}
id
nft {
...NftFragment
}
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
bucket
dominantColor
id
key
url
}
gaCoverImage {
bucket
dominantColor
id
key
url
}
genre {
createdAt
id
name
updatedAt
}
goldenEggImage {
bucket
dominantColor
id
key
url
}
goldenEggNft {
audioUrl
collectorRelease {
...ReleaseCollectorFragment
}
comment {
...CommentFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
createdAtBlockTime
id
isBurned
isGoldenEgg
openSeaMetadataAttributes {
...OpenSeaMetadataAttributeFragment
}
owner {
...UserFragment
}
release {
...ReleaseFragment
}
serialNumber
songSlot
tierNumber
title
tokenId
updatedAt
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
likedBy {
edges {
...UserConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
listeningParty
listing {
chain
contractAddress
id
}
marketPlaceUrl
metadataDetails {
bpm
key
license
location
lyrics
}
mintStartTime
mintStartTimestamp
nftsPaginated {
edges {
...NftConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
description
id
title
}
royaltyBps
saleDetails {
primaryCollected
primaryRaisedInWei
soundSwapCollected
soundSwapRaisedInWei
totalVolume
}
saleSchedules {
affiliateFeeBPS
affiliateFeePercent
artistContractTotalMinted
endTime
id
isPresale
maxMintable
merkleTreeRoot
mintId
minterAddress
price
startTime
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
affiliateFeeBPS
affiliateFeePercent
artistFeeBPS
artistFeePercent
basePrice
buyFreezeTime
goldenEggFeeBPS
goldenEggFeePercent
id
inflectionPoint
inflectionPrice
maxSupply
platformFeeBPS
platformPerTxFlatFee
samAddress
}
samSellBufferBpsOverride
scheduleIds {
mintIds
minterAddress
}
season
shelves {
edges {
...ShelfConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
socialProofCollectors {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
bucket
dominantColor
id
key
url
}
staticGaCoverImage {
bucket
dominantColor
id
key
url
}
staticVipCoverImage {
bucket
dominantColor
id
key
url
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
firstNftCollectedDate
lowestNftSerialNumber
nftsCount
position
user {
...UserFragment
}
}
topPosts {
authorChannelRole
channel {
...ChannelFragment
}
commentCount
comments {
...PostCommentConnectionFragment
}
content
createdAt
creator {
...UserFragment
}
farcasterHash
id
lexicalContent
repostCount
upvoteCount
webappUri
}
topSpentCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
totalMinted
totalSupply
track {
audio {
...AudioMediaFragment
}
audioOriginal {
...MediaFragment
}
duration
id
normalizedPeaks
release {
...ReleaseFragment
}
releaseId
title
trackNumber
}
type
vipAnimatedCoverImage {
bucket
dominantColor
id
key
url
}
vipCoverImage {
bucket
dominantColor
id
key
url
}
webEmbed
webappUri
}
}
Variables
{"input": SetReleaseDetailsInput}
Response
{
"data": {
"setReleaseDetails": {
"activityFeed": ReleaseActionConnection,
"affiliates": ReleaseAffiliateConnection,
"airdropCount": 123,
"animatedCoverImage": Media,
"animatedGoldenEggImageOptimized": Media,
"artist": Artist,
"auctionContractType": "ARTIST",
"auctionType": "FIXED_QUANTITY",
"baseMetadataAttributes": [MetadataAttribute],
"behindTheMusic": "abc123",
"canCollectorsDownloadAudio": true,
"chainId": 123,
"collectors": ReleaseCollectorConnection,
"collectorsCount": 987,
"contract": Contract,
"contractAddress": "abc123",
"coverImage": Media,
"createdAt": "2007-12-03T10:15:30Z",
"creditSplit": CreditSplit,
"credits": [User],
"draftId": "abc123",
"earliestCollector": ReleaseCollector,
"editionId": "xyz789",
"eggGame": EggGame,
"externalUrl": "abc123",
"finalQuantity": 987,
"fundingAddress": "abc123",
"gaAnimatedCoverImage": Media,
"gaCoverImage": Media,
"genre": Genre,
"goldenEggImage": Media,
"goldenEggNft": Nft,
"id": 4,
"isAuctionSoldOut": true,
"isFirstPhaseCompleted": true,
"lastUpdatedAt": "2007-12-03T10:15:30Z",
"latestCollector": ReleaseCollector,
"likedBy": UserConnection,
"listeningParty": 1592577642,
"listing": AuctionListingInterface,
"marketPlaceUrl": "xyz789",
"metadataDetails": MetadataDetails,
"mintStartTime": 123,
"mintStartTimestamp": 1592577642,
"nftsPaginated": NftConnection,
"numSold": 123,
"openseaUrl": "abc123",
"postCount": 123,
"price": "abc123",
"publicAffiliateFeeBPS": 987,
"publicAffiliateFeePercent": "xyz789",
"publicMintStart": "2007-12-03T10:15:30Z",
"quantity": 987,
"quantityLowerBound": 123,
"quantityUpperBound": 987,
"rewards": [Reward],
"royaltyBps": 987,
"saleDetails": SaleDetails,
"saleSchedules": [SaleSchedule],
"salesAffiliateFeesPercent": [
"abc123"
],
"samAddress": "xyz789",
"samBuyBufferBpsOverride": 987,
"samConfig": SamConfig,
"samSellBufferBpsOverride": 987,
"scheduleIds": [ScheduleIdentifier],
"season": "xyz789",
"shelves": ShelfConnection,
"socialProofCollectors": [User],
"spotifyPresaveCampaign": true,
"spotifyPresaveCount": 987,
"spotifyTrackId": "abc123",
"staticCoverImage": Media,
"staticGaCoverImage": Media,
"staticVipCoverImage": Media,
"supplyCutoffTimestamp": 1592577642,
"title": "abc123",
"titleSlug": "abc123",
"topCollectors": [TopReleaseCollector],
"topPosts": [Post],
"topSpentCollector": ReleaseCollector,
"totalMinted": 987,
"totalSupply": 123,
"track": Track,
"type": "ALBUM",
"vipAnimatedCoverImage": Media,
"vipCoverImage": Media,
"webEmbed": "xyz789",
"webappUri": "abc123"
}
}
}
setReleaseMeta
Description
[ADMIN | ARTIST_RELATIONS] Set special metadata of release
Response
Returns a
Release!
Arguments
| Name | Description |
|---|---|
input -
SetReleaseMetaInput!
|
Metadata info |
Example
Query
mutation SetReleaseMeta($input: SetReleaseMetaInput!) {
setReleaseMeta(input: $input) {
activityFeed {
edges {
...ReleaseActionConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
affiliates {
edges {
...ReleaseAffiliateConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
airdropCount
animatedCoverImage {
bucket
dominantColor
id
key
url
}
animatedGoldenEggImageOptimized {
bucket
dominantColor
id
key
url
}
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
auctionContractType
auctionType
baseMetadataAttributes {
traitType
value
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
edges {
...ReleaseCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
collectorsCount
contract {
contractAddress
contractType
createdAt
id
owner {
...UserFragment
}
ownerPublicAddress
updatedAt
}
contractAddress
coverImage {
bucket
dominantColor
id
key
url
}
createdAt
creditSplit {
creditAllocations {
...CreditAllocationFragment
}
id
mintedReleases {
...ReleaseFragment
}
releases {
...ReleaseFragment
}
splitAddress
}
credits {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
draftId
earliestCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
editionId
eggGame {
animatedGoldenEggImageOptimized {
...MediaFragment
}
finalSerialBlockHash
goldenEggImage {
...MediaFragment
}
id
nft {
...NftFragment
}
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
bucket
dominantColor
id
key
url
}
gaCoverImage {
bucket
dominantColor
id
key
url
}
genre {
createdAt
id
name
updatedAt
}
goldenEggImage {
bucket
dominantColor
id
key
url
}
goldenEggNft {
audioUrl
collectorRelease {
...ReleaseCollectorFragment
}
comment {
...CommentFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
createdAtBlockTime
id
isBurned
isGoldenEgg
openSeaMetadataAttributes {
...OpenSeaMetadataAttributeFragment
}
owner {
...UserFragment
}
release {
...ReleaseFragment
}
serialNumber
songSlot
tierNumber
title
tokenId
updatedAt
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
likedBy {
edges {
...UserConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
listeningParty
listing {
chain
contractAddress
id
}
marketPlaceUrl
metadataDetails {
bpm
key
license
location
lyrics
}
mintStartTime
mintStartTimestamp
nftsPaginated {
edges {
...NftConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
description
id
title
}
royaltyBps
saleDetails {
primaryCollected
primaryRaisedInWei
soundSwapCollected
soundSwapRaisedInWei
totalVolume
}
saleSchedules {
affiliateFeeBPS
affiliateFeePercent
artistContractTotalMinted
endTime
id
isPresale
maxMintable
merkleTreeRoot
mintId
minterAddress
price
startTime
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
affiliateFeeBPS
affiliateFeePercent
artistFeeBPS
artistFeePercent
basePrice
buyFreezeTime
goldenEggFeeBPS
goldenEggFeePercent
id
inflectionPoint
inflectionPrice
maxSupply
platformFeeBPS
platformPerTxFlatFee
samAddress
}
samSellBufferBpsOverride
scheduleIds {
mintIds
minterAddress
}
season
shelves {
edges {
...ShelfConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
socialProofCollectors {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
bucket
dominantColor
id
key
url
}
staticGaCoverImage {
bucket
dominantColor
id
key
url
}
staticVipCoverImage {
bucket
dominantColor
id
key
url
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
firstNftCollectedDate
lowestNftSerialNumber
nftsCount
position
user {
...UserFragment
}
}
topPosts {
authorChannelRole
channel {
...ChannelFragment
}
commentCount
comments {
...PostCommentConnectionFragment
}
content
createdAt
creator {
...UserFragment
}
farcasterHash
id
lexicalContent
repostCount
upvoteCount
webappUri
}
topSpentCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
totalMinted
totalSupply
track {
audio {
...AudioMediaFragment
}
audioOriginal {
...MediaFragment
}
duration
id
normalizedPeaks
release {
...ReleaseFragment
}
releaseId
title
trackNumber
}
type
vipAnimatedCoverImage {
bucket
dominantColor
id
key
url
}
vipCoverImage {
bucket
dominantColor
id
key
url
}
webEmbed
webappUri
}
}
Variables
{"input": SetReleaseMetaInput}
Response
{
"data": {
"setReleaseMeta": {
"activityFeed": ReleaseActionConnection,
"affiliates": ReleaseAffiliateConnection,
"airdropCount": 987,
"animatedCoverImage": Media,
"animatedGoldenEggImageOptimized": Media,
"artist": Artist,
"auctionContractType": "ARTIST",
"auctionType": "FIXED_QUANTITY",
"baseMetadataAttributes": [MetadataAttribute],
"behindTheMusic": "abc123",
"canCollectorsDownloadAudio": true,
"chainId": 123,
"collectors": ReleaseCollectorConnection,
"collectorsCount": 987,
"contract": Contract,
"contractAddress": "abc123",
"coverImage": Media,
"createdAt": "2007-12-03T10:15:30Z",
"creditSplit": CreditSplit,
"credits": [User],
"draftId": "abc123",
"earliestCollector": ReleaseCollector,
"editionId": "abc123",
"eggGame": EggGame,
"externalUrl": "abc123",
"finalQuantity": 987,
"fundingAddress": "abc123",
"gaAnimatedCoverImage": Media,
"gaCoverImage": Media,
"genre": Genre,
"goldenEggImage": Media,
"goldenEggNft": Nft,
"id": "4",
"isAuctionSoldOut": false,
"isFirstPhaseCompleted": true,
"lastUpdatedAt": "2007-12-03T10:15:30Z",
"latestCollector": ReleaseCollector,
"likedBy": UserConnection,
"listeningParty": 1592577642,
"listing": AuctionListingInterface,
"marketPlaceUrl": "xyz789",
"metadataDetails": MetadataDetails,
"mintStartTime": 987,
"mintStartTimestamp": 1592577642,
"nftsPaginated": NftConnection,
"numSold": 123,
"openseaUrl": "abc123",
"postCount": 987,
"price": "xyz789",
"publicAffiliateFeeBPS": 987,
"publicAffiliateFeePercent": "abc123",
"publicMintStart": "2007-12-03T10:15:30Z",
"quantity": 123,
"quantityLowerBound": 123,
"quantityUpperBound": 123,
"rewards": [Reward],
"royaltyBps": 123,
"saleDetails": SaleDetails,
"saleSchedules": [SaleSchedule],
"salesAffiliateFeesPercent": [
"xyz789"
],
"samAddress": "xyz789",
"samBuyBufferBpsOverride": 123,
"samConfig": SamConfig,
"samSellBufferBpsOverride": 987,
"scheduleIds": [ScheduleIdentifier],
"season": "xyz789",
"shelves": ShelfConnection,
"socialProofCollectors": [User],
"spotifyPresaveCampaign": true,
"spotifyPresaveCount": 123,
"spotifyTrackId": "xyz789",
"staticCoverImage": Media,
"staticGaCoverImage": Media,
"staticVipCoverImage": Media,
"supplyCutoffTimestamp": 1592577642,
"title": "xyz789",
"titleSlug": "abc123",
"topCollectors": [TopReleaseCollector],
"topPosts": [Post],
"topSpentCollector": ReleaseCollector,
"totalMinted": 987,
"totalSupply": 123,
"track": Track,
"type": "ALBUM",
"vipAnimatedCoverImage": Media,
"vipCoverImage": Media,
"webEmbed": "abc123",
"webappUri": "abc123"
}
}
}
setSamBuyBufferBpsOverride
Description
[ADMIN] Override the buffer in basis points (bps) applied to totalBuyPrice
Response
Returns a
Release!
Arguments
| Name | Description |
|---|---|
input -
SetSamBuyBufferBpsOverrideInput!
|
Input for setSamBuyBufferBpsOverride mutation |
Example
Query
mutation SetSamBuyBufferBpsOverride($input: SetSamBuyBufferBpsOverrideInput!) {
setSamBuyBufferBpsOverride(input: $input) {
activityFeed {
edges {
...ReleaseActionConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
affiliates {
edges {
...ReleaseAffiliateConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
airdropCount
animatedCoverImage {
bucket
dominantColor
id
key
url
}
animatedGoldenEggImageOptimized {
bucket
dominantColor
id
key
url
}
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
auctionContractType
auctionType
baseMetadataAttributes {
traitType
value
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
edges {
...ReleaseCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
collectorsCount
contract {
contractAddress
contractType
createdAt
id
owner {
...UserFragment
}
ownerPublicAddress
updatedAt
}
contractAddress
coverImage {
bucket
dominantColor
id
key
url
}
createdAt
creditSplit {
creditAllocations {
...CreditAllocationFragment
}
id
mintedReleases {
...ReleaseFragment
}
releases {
...ReleaseFragment
}
splitAddress
}
credits {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
draftId
earliestCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
editionId
eggGame {
animatedGoldenEggImageOptimized {
...MediaFragment
}
finalSerialBlockHash
goldenEggImage {
...MediaFragment
}
id
nft {
...NftFragment
}
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
bucket
dominantColor
id
key
url
}
gaCoverImage {
bucket
dominantColor
id
key
url
}
genre {
createdAt
id
name
updatedAt
}
goldenEggImage {
bucket
dominantColor
id
key
url
}
goldenEggNft {
audioUrl
collectorRelease {
...ReleaseCollectorFragment
}
comment {
...CommentFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
createdAtBlockTime
id
isBurned
isGoldenEgg
openSeaMetadataAttributes {
...OpenSeaMetadataAttributeFragment
}
owner {
...UserFragment
}
release {
...ReleaseFragment
}
serialNumber
songSlot
tierNumber
title
tokenId
updatedAt
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
likedBy {
edges {
...UserConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
listeningParty
listing {
chain
contractAddress
id
}
marketPlaceUrl
metadataDetails {
bpm
key
license
location
lyrics
}
mintStartTime
mintStartTimestamp
nftsPaginated {
edges {
...NftConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
description
id
title
}
royaltyBps
saleDetails {
primaryCollected
primaryRaisedInWei
soundSwapCollected
soundSwapRaisedInWei
totalVolume
}
saleSchedules {
affiliateFeeBPS
affiliateFeePercent
artistContractTotalMinted
endTime
id
isPresale
maxMintable
merkleTreeRoot
mintId
minterAddress
price
startTime
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
affiliateFeeBPS
affiliateFeePercent
artistFeeBPS
artistFeePercent
basePrice
buyFreezeTime
goldenEggFeeBPS
goldenEggFeePercent
id
inflectionPoint
inflectionPrice
maxSupply
platformFeeBPS
platformPerTxFlatFee
samAddress
}
samSellBufferBpsOverride
scheduleIds {
mintIds
minterAddress
}
season
shelves {
edges {
...ShelfConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
socialProofCollectors {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
bucket
dominantColor
id
key
url
}
staticGaCoverImage {
bucket
dominantColor
id
key
url
}
staticVipCoverImage {
bucket
dominantColor
id
key
url
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
firstNftCollectedDate
lowestNftSerialNumber
nftsCount
position
user {
...UserFragment
}
}
topPosts {
authorChannelRole
channel {
...ChannelFragment
}
commentCount
comments {
...PostCommentConnectionFragment
}
content
createdAt
creator {
...UserFragment
}
farcasterHash
id
lexicalContent
repostCount
upvoteCount
webappUri
}
topSpentCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
totalMinted
totalSupply
track {
audio {
...AudioMediaFragment
}
audioOriginal {
...MediaFragment
}
duration
id
normalizedPeaks
release {
...ReleaseFragment
}
releaseId
title
trackNumber
}
type
vipAnimatedCoverImage {
bucket
dominantColor
id
key
url
}
vipCoverImage {
bucket
dominantColor
id
key
url
}
webEmbed
webappUri
}
}
Variables
{"input": SetSamBuyBufferBpsOverrideInput}
Response
{
"data": {
"setSamBuyBufferBpsOverride": {
"activityFeed": ReleaseActionConnection,
"affiliates": ReleaseAffiliateConnection,
"airdropCount": 123,
"animatedCoverImage": Media,
"animatedGoldenEggImageOptimized": Media,
"artist": Artist,
"auctionContractType": "ARTIST",
"auctionType": "FIXED_QUANTITY",
"baseMetadataAttributes": [MetadataAttribute],
"behindTheMusic": "xyz789",
"canCollectorsDownloadAudio": true,
"chainId": 123,
"collectors": ReleaseCollectorConnection,
"collectorsCount": 123,
"contract": Contract,
"contractAddress": "xyz789",
"coverImage": Media,
"createdAt": "2007-12-03T10:15:30Z",
"creditSplit": CreditSplit,
"credits": [User],
"draftId": "abc123",
"earliestCollector": ReleaseCollector,
"editionId": "abc123",
"eggGame": EggGame,
"externalUrl": "abc123",
"finalQuantity": 123,
"fundingAddress": "abc123",
"gaAnimatedCoverImage": Media,
"gaCoverImage": Media,
"genre": Genre,
"goldenEggImage": Media,
"goldenEggNft": Nft,
"id": "4",
"isAuctionSoldOut": false,
"isFirstPhaseCompleted": true,
"lastUpdatedAt": "2007-12-03T10:15:30Z",
"latestCollector": ReleaseCollector,
"likedBy": UserConnection,
"listeningParty": 1592577642,
"listing": AuctionListingInterface,
"marketPlaceUrl": "abc123",
"metadataDetails": MetadataDetails,
"mintStartTime": 123,
"mintStartTimestamp": 1592577642,
"nftsPaginated": NftConnection,
"numSold": 987,
"openseaUrl": "xyz789",
"postCount": 987,
"price": "xyz789",
"publicAffiliateFeeBPS": 987,
"publicAffiliateFeePercent": "xyz789",
"publicMintStart": "2007-12-03T10:15:30Z",
"quantity": 123,
"quantityLowerBound": 123,
"quantityUpperBound": 123,
"rewards": [Reward],
"royaltyBps": 987,
"saleDetails": SaleDetails,
"saleSchedules": [SaleSchedule],
"salesAffiliateFeesPercent": [
"xyz789"
],
"samAddress": "xyz789",
"samBuyBufferBpsOverride": 987,
"samConfig": SamConfig,
"samSellBufferBpsOverride": 123,
"scheduleIds": [ScheduleIdentifier],
"season": "xyz789",
"shelves": ShelfConnection,
"socialProofCollectors": [User],
"spotifyPresaveCampaign": false,
"spotifyPresaveCount": 123,
"spotifyTrackId": "xyz789",
"staticCoverImage": Media,
"staticGaCoverImage": Media,
"staticVipCoverImage": Media,
"supplyCutoffTimestamp": 1592577642,
"title": "xyz789",
"titleSlug": "abc123",
"topCollectors": [TopReleaseCollector],
"topPosts": [Post],
"topSpentCollector": ReleaseCollector,
"totalMinted": 987,
"totalSupply": 987,
"track": Track,
"type": "ALBUM",
"vipAnimatedCoverImage": Media,
"vipCoverImage": Media,
"webEmbed": "abc123",
"webappUri": "xyz789"
}
}
}
setSamSellBufferBpsOverride
Description
[ADMIN] Override the buffer in basis points (bps) applied to totalSellPrice
Response
Returns a
Release!
Arguments
| Name | Description |
|---|---|
input -
SetSamSellBufferBpsOverrideInput!
|
Input for setSamSellBufferBpsOverride mutation |
Example
Query
mutation SetSamSellBufferBpsOverride($input: SetSamSellBufferBpsOverrideInput!) {
setSamSellBufferBpsOverride(input: $input) {
activityFeed {
edges {
...ReleaseActionConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
affiliates {
edges {
...ReleaseAffiliateConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
airdropCount
animatedCoverImage {
bucket
dominantColor
id
key
url
}
animatedGoldenEggImageOptimized {
bucket
dominantColor
id
key
url
}
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
auctionContractType
auctionType
baseMetadataAttributes {
traitType
value
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
edges {
...ReleaseCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
collectorsCount
contract {
contractAddress
contractType
createdAt
id
owner {
...UserFragment
}
ownerPublicAddress
updatedAt
}
contractAddress
coverImage {
bucket
dominantColor
id
key
url
}
createdAt
creditSplit {
creditAllocations {
...CreditAllocationFragment
}
id
mintedReleases {
...ReleaseFragment
}
releases {
...ReleaseFragment
}
splitAddress
}
credits {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
draftId
earliestCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
editionId
eggGame {
animatedGoldenEggImageOptimized {
...MediaFragment
}
finalSerialBlockHash
goldenEggImage {
...MediaFragment
}
id
nft {
...NftFragment
}
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
bucket
dominantColor
id
key
url
}
gaCoverImage {
bucket
dominantColor
id
key
url
}
genre {
createdAt
id
name
updatedAt
}
goldenEggImage {
bucket
dominantColor
id
key
url
}
goldenEggNft {
audioUrl
collectorRelease {
...ReleaseCollectorFragment
}
comment {
...CommentFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
createdAtBlockTime
id
isBurned
isGoldenEgg
openSeaMetadataAttributes {
...OpenSeaMetadataAttributeFragment
}
owner {
...UserFragment
}
release {
...ReleaseFragment
}
serialNumber
songSlot
tierNumber
title
tokenId
updatedAt
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
likedBy {
edges {
...UserConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
listeningParty
listing {
chain
contractAddress
id
}
marketPlaceUrl
metadataDetails {
bpm
key
license
location
lyrics
}
mintStartTime
mintStartTimestamp
nftsPaginated {
edges {
...NftConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
description
id
title
}
royaltyBps
saleDetails {
primaryCollected
primaryRaisedInWei
soundSwapCollected
soundSwapRaisedInWei
totalVolume
}
saleSchedules {
affiliateFeeBPS
affiliateFeePercent
artistContractTotalMinted
endTime
id
isPresale
maxMintable
merkleTreeRoot
mintId
minterAddress
price
startTime
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
affiliateFeeBPS
affiliateFeePercent
artistFeeBPS
artistFeePercent
basePrice
buyFreezeTime
goldenEggFeeBPS
goldenEggFeePercent
id
inflectionPoint
inflectionPrice
maxSupply
platformFeeBPS
platformPerTxFlatFee
samAddress
}
samSellBufferBpsOverride
scheduleIds {
mintIds
minterAddress
}
season
shelves {
edges {
...ShelfConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
socialProofCollectors {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
bucket
dominantColor
id
key
url
}
staticGaCoverImage {
bucket
dominantColor
id
key
url
}
staticVipCoverImage {
bucket
dominantColor
id
key
url
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
firstNftCollectedDate
lowestNftSerialNumber
nftsCount
position
user {
...UserFragment
}
}
topPosts {
authorChannelRole
channel {
...ChannelFragment
}
commentCount
comments {
...PostCommentConnectionFragment
}
content
createdAt
creator {
...UserFragment
}
farcasterHash
id
lexicalContent
repostCount
upvoteCount
webappUri
}
topSpentCollector {
firstNftCollected {
...NftFragment
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
...NftFragment
}
mostRecentNftWithComment {
...NftFragment
}
nftsCount
ownedGoldenEgg {
...EggGameFragment
}
release {
...ReleaseFragment
}
tierPriority
user {
...UserFragment
}
vipNftsCount
volumeSpent
}
totalMinted
totalSupply
track {
audio {
...AudioMediaFragment
}
audioOriginal {
...MediaFragment
}
duration
id
normalizedPeaks
release {
...ReleaseFragment
}
releaseId
title
trackNumber
}
type
vipAnimatedCoverImage {
bucket
dominantColor
id
key
url
}
vipCoverImage {
bucket
dominantColor
id
key
url
}
webEmbed
webappUri
}
}
Variables
{"input": SetSamSellBufferBpsOverrideInput}
Response
{
"data": {
"setSamSellBufferBpsOverride": {
"activityFeed": ReleaseActionConnection,
"affiliates": ReleaseAffiliateConnection,
"airdropCount": 123,
"animatedCoverImage": Media,
"animatedGoldenEggImageOptimized": Media,
"artist": Artist,
"auctionContractType": "ARTIST",
"auctionType": "FIXED_QUANTITY",
"baseMetadataAttributes": [MetadataAttribute],
"behindTheMusic": "abc123",
"canCollectorsDownloadAudio": true,
"chainId": 123,
"collectors": ReleaseCollectorConnection,
"collectorsCount": 987,
"contract": Contract,
"contractAddress": "abc123",
"coverImage": Media,
"createdAt": "2007-12-03T10:15:30Z",
"creditSplit": CreditSplit,
"credits": [User],
"draftId": "xyz789",
"earliestCollector": ReleaseCollector,
"editionId": "abc123",
"eggGame": EggGame,
"externalUrl": "abc123",
"finalQuantity": 987,
"fundingAddress": "abc123",
"gaAnimatedCoverImage": Media,
"gaCoverImage": Media,
"genre": Genre,
"goldenEggImage": Media,
"goldenEggNft": Nft,
"id": 4,
"isAuctionSoldOut": false,
"isFirstPhaseCompleted": false,
"lastUpdatedAt": "2007-12-03T10:15:30Z",
"latestCollector": ReleaseCollector,
"likedBy": UserConnection,
"listeningParty": 1592577642,
"listing": AuctionListingInterface,
"marketPlaceUrl": "abc123",
"metadataDetails": MetadataDetails,
"mintStartTime": 987,
"mintStartTimestamp": 1592577642,
"nftsPaginated": NftConnection,
"numSold": 987,
"openseaUrl": "abc123",
"postCount": 123,
"price": "xyz789",
"publicAffiliateFeeBPS": 123,
"publicAffiliateFeePercent": "xyz789",
"publicMintStart": "2007-12-03T10:15:30Z",
"quantity": 123,
"quantityLowerBound": 123,
"quantityUpperBound": 987,
"rewards": [Reward],
"royaltyBps": 123,
"saleDetails": SaleDetails,
"saleSchedules": [SaleSchedule],
"salesAffiliateFeesPercent": [
"abc123"
],
"samAddress": "abc123",
"samBuyBufferBpsOverride": 123,
"samConfig": SamConfig,
"samSellBufferBpsOverride": 987,
"scheduleIds": [ScheduleIdentifier],
"season": "xyz789",
"shelves": ShelfConnection,
"socialProofCollectors": [User],
"spotifyPresaveCampaign": false,
"spotifyPresaveCount": 987,
"spotifyTrackId": "abc123",
"staticCoverImage": Media,
"staticGaCoverImage": Media,
"staticVipCoverImage": Media,
"supplyCutoffTimestamp": 1592577642,
"title": "xyz789",
"titleSlug": "abc123",
"topCollectors": [TopReleaseCollector],
"topPosts": [Post],
"topSpentCollector": ReleaseCollector,
"totalMinted": 123,
"totalSupply": 987,
"track": Track,
"type": "ALBUM",
"vipAnimatedCoverImage": Media,
"vipCoverImage": Media,
"webEmbed": "xyz789",
"webappUri": "xyz789"
}
}
}
setSeasonForArtist
Description
[ADMIN] Set season for specified artist
Response
Returns an
Artist!
Example
Query
mutation SetSeasonForArtist(
$artistId: UUID!,
$season: String!
) {
setSeasonForArtist(
artistId: $artistId,
season: $season
) {
bannerImage {
bucket
dominantColor
id
key
url
}
collectors {
edges {
...ArtistCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
activityFeed {
...ReleaseActionConnectionFragment
}
affiliates {
...ReleaseAffiliateConnectionFragment
}
airdropCount
animatedCoverImage {
...MediaFragment
}
animatedGoldenEggImageOptimized {
...MediaFragment
}
artist {
...ArtistFragment
}
auctionContractType
auctionType
baseMetadataAttributes {
...MetadataAttributeFragment
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
...ReleaseCollectorConnectionFragment
}
collectorsCount
contract {
...ContractFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
creditSplit {
...CreditSplitFragment
}
credits {
...UserFragment
}
draftId
earliestCollector {
...ReleaseCollectorFragment
}
editionId
eggGame {
...EggGameFragment
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
...MediaFragment
}
gaCoverImage {
...MediaFragment
}
genre {
...GenreFragment
}
goldenEggImage {
...MediaFragment
}
goldenEggNft {
...NftFragment
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
...ReleaseCollectorFragment
}
likedBy {
...UserConnectionFragment
}
listeningParty
listing {
...AuctionListingInterfaceFragment
}
marketPlaceUrl
metadataDetails {
...MetadataDetailsFragment
}
mintStartTime
mintStartTimestamp
nftsPaginated {
...NftConnectionFragment
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
...RewardFragment
}
royaltyBps
saleDetails {
...SaleDetailsFragment
}
saleSchedules {
...SaleScheduleFragment
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
...SamConfigFragment
}
samSellBufferBpsOverride
scheduleIds {
...ScheduleIdentifierFragment
}
season
shelves {
...ShelfConnectionFragment
}
socialProofCollectors {
...UserFragment
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
...MediaFragment
}
staticGaCoverImage {
...MediaFragment
}
staticVipCoverImage {
...MediaFragment
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
...TopReleaseCollectorFragment
}
topPosts {
...PostFragment
}
topSpentCollector {
...ReleaseCollectorFragment
}
totalMinted
totalSupply
track {
...TrackFragment
}
type
vipAnimatedCoverImage {
...MediaFragment
}
vipCoverImage {
...MediaFragment
}
webEmbed
webappUri
}
releases {
edges {
...ReleaseConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
userId
webappUri
}
}
Variables
{
"artistId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"season": "xyz789"
}
Response
{
"data": {
"setSeasonForArtist": {
"bannerImage": Media,
"collectors": ArtistCollectorConnection,
"createdAt": "2007-12-03T10:15:30Z",
"gemCollectionUrl": "abc123",
"id": 4,
"name": "xyz789",
"numCollectors": 123,
"numNfts": 123,
"numReleases": 987,
"pickedRelease": Release,
"releases": ReleaseConnection,
"releasesGenres": ["xyz789"],
"season": "xyz789",
"soundHandle": "xyz789",
"spotifyUrl": "xyz789",
"tokenSymbol": "xyz789",
"user": User,
"userId": "xyz789",
"webappUri": "xyz789"
}
}
}
setShelfReleases
Description
[AUTHENTICATED] Set input list of releaseIds to input shelfId
Response
Returns a
MutationSetShelfReleasesResult!
Arguments
| Name | Description |
|---|---|
input -
SetReleasesForShelfInput!
|
SetReleasesForShelf inputs |
Example
Query
mutation SetShelfReleases($input: SetReleasesForShelfInput!) {
setShelfReleases(input: $input)
}
Variables
{"input": SetReleasesForShelfInput}
Response
{
"data": {
"setShelfReleases": MutationSetShelfReleasesSuccess
}
}
setUploadBlockStatus
Description
[ADMIN] Block or unblock user from uploading content into the system
Response
Returns a
Void
Arguments
| Name | Description |
|---|---|
input -
UploadBlockStatusInput!
|
Information of upload block status |
Example
Query
mutation SetUploadBlockStatus($input: UploadBlockStatusInput!) {
setUploadBlockStatus(input: $input)
}
Variables
{"input": UploadBlockStatusInput}
Response
{"data": {"setUploadBlockStatus": null}}
setUserDisplayName
Description
[AUTHENTICATED] Update authenticated user display name
Response
Returns a
MutationSetUserDisplayNameResult!
Arguments
| Name | Description |
|---|---|
displayName -
String!
|
New user display name |
Example
Query
mutation SetUserDisplayName($displayName: String!) {
setUserDisplayName(displayName: $displayName)
}
Variables
{"displayName": "xyz789"}
Response
{
"data": {
"setUserDisplayName": MutationSetUserDisplayNameSuccess
}
}
setUserEngagementOnChannel
Description
[AUTHENTICATED] Allows a user to set their engagement on a channel
Response
Returns a
MutationSetUserEngagementOnChannelResult
Arguments
| Name | Description |
|---|---|
channelId -
UUID!
|
ID of the channel |
Example
Query
mutation SetUserEngagementOnChannel($channelId: UUID!) {
setUserEngagementOnChannel(channelId: $channelId)
}
Variables
{
"channelId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"setUserEngagementOnChannel": MutationSetUserEngagementOnChannelSuccess
}
}
setUserJoinStatusOnChannel
Description
[AUTHENTICATED] Allows a user to join or leave a channel
Response
Example
Query
mutation SetUserJoinStatusOnChannel(
$channelId: UUID!,
$join: Boolean!
) {
setUserJoinStatusOnChannel(
channelId: $channelId,
join: $join
)
}
Variables
{
"channelId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"join": true
}
Response
{
"data": {
"setUserJoinStatusOnChannel": MutationSetUserJoinStatusOnChannelSuccess
}
}
setUserLocation
Description
[AUTHENTICATED] Set public location of authenticated user
Response
Returns a
MutationSetUserLocationResult!
Arguments
| Name | Description |
|---|---|
location -
GeoLocationInput
|
User location input. Set null to remove location |
Example
Query
mutation SetUserLocation($location: GeoLocationInput) {
setUserLocation(location: $location)
}
Variables
{"location": GeoLocationInput}
Response
{"data": {"setUserLocation": GoogleAPICallError}}
setUserMedia
Description
[ADMIN] Set the media of the specified user
Response
Returns a
User!
Arguments
| Name | Description |
|---|---|
content -
UploadedMedia!
|
|
userPublicAddress -
Address!
|
Public address of the user to receive the media change |
Example
Query
mutation SetUserMedia(
$content: UploadedMedia!,
$userPublicAddress: Address!
) {
setUserMedia(
content: $content,
userPublicAddress: $userPublicAddress
) {
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
avatar {
bucket
dominantColor
id
key
url
}
backedArtists {
edges {
...ArtistCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
bannerImage {
bucket
dominantColor
id
key
url
}
collectedReleases {
edges {
...CollectedReleaseConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
creditSplit {
...CreditSplitFragment
}
id
owner {
...UserFragment
}
percent
roles
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
firstNftOwned {
...NftFragment
}
gaNftsCount
goldenEgg {
...EggGameFragment
}
id
nftsCount
ownedTokens {
...OwnedTokenFragment
}
release {
...ReleaseFragment
}
tierPriority
vipNftsCount
}
followerCount
followers {
edges {
...UserRelationConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
following {
edges {
...UserRelationConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
followingCount
id
instagramHandle
invitedByUser {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
affiliateBuyers {
...PlaylistAffiliateBuyerConnectionFragment
}
coverImage {
...MediaFragment
}
coverReleases {
...ReleaseFragment
}
createdAt
deletedAt
description
extendedFrom {
...ShelfFragment
}
id
index
likedBy {
...UserConnectionFragment
}
likes
linkSlug
name
numLikes
numReferralPurchases
numUsersReferred
orderedReleases {
...ShelfReleaseConnectionFragment
}
playTimeInSeconds
previewReleases {
...ShelfReleaseFragment
}
releaseCount
releaseIds
socialProofReferrals {
...UserFragment
}
trackIds
type
user {
...UserFragment
}
webEmbed
webappUri
}
location {
label
placeId
}
nftsOwned
nftsPaginated {
edges {
...NftConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
nonce
numBackedArtists
postCount
publicAddress
roles {
isAdmin
isArtistRelations
}
shelves {
edges {
...ShelfConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
}
Variables
{
"content": UploadedMedia,
"userPublicAddress": Address
}
Response
{
"data": {
"setUserMedia": {
"artist": Artist,
"avatar": Media,
"backedArtists": ArtistCollectorConnection,
"bannerImage": Media,
"collectedReleases": CollectedReleaseConnection,
"collectedReleasesCount": 987,
"collectedReleasesIds": ["xyz789"],
"collectorPosition": 987,
"createdAt": "2007-12-03T10:15:30Z",
"creditAllocations": [CreditAllocation],
"delegateWalletAddress": "abc123",
"description": "abc123",
"displayName": "xyz789",
"email": "xyz789",
"ens": "abc123",
"farcasterFid": "xyz789",
"farcasterSignerConnected": false,
"featuredReleases": [CollectedRelease],
"followerCount": 987,
"followers": UserRelationConnection,
"following": UserRelationConnection,
"followingCount": 123,
"id": "4",
"instagramHandle": "xyz789",
"invitedByUser": User,
"isTopNotableCollector": true,
"lastReferralWithdrawableBalance": "abc123",
"likedSounds": Shelf,
"location": GeoLocationPlaceGoogle,
"nftsOwned": 123,
"nftsPaginated": NftConnection,
"nonce": 123,
"numBackedArtists": 987,
"postCount": 987,
"publicAddress": "abc123",
"roles": UserRoles,
"shelves": ShelfConnection,
"shelvesCount": 987,
"showSplitsFeature": true,
"tiktokUrl": "xyz789",
"topCollectorPosition": 987,
"twitterHandle": "abc123",
"username": "abc123",
"verifiedNotificationEmail": "abc123",
"webappUri": "abc123"
}
}
}
setUserNotificationPreferencesOnChannel
Description
[AUTHENTICATED] Allows a user to set their notification preferences for a channel
Response
Returns a
MutationSetUserNotificationPreferencesOnChannelResult!
Arguments
| Name | Description |
|---|---|
channelId -
UUID!
|
ID of the channel |
status -
ChannelNotificationStatus!
|
The notification preference to set |
Example
Query
mutation SetUserNotificationPreferencesOnChannel(
$channelId: UUID!,
$status: ChannelNotificationStatus!
) {
setUserNotificationPreferencesOnChannel(
channelId: $channelId,
status: $status
)
}
Variables
{
"channelId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"status": "DISABLED"
}
Response
{
"data": {
"setUserNotificationPreferencesOnChannel": MutationSetUserNotificationPreferencesOnChannelSuccess
}
}
setUserPersistedData
Description
[AUTHENTICATED] Set persisted custom data for authenticated user
Response
Returns a
MutationSetUserPersistedDataResult!
Arguments
| Name | Description |
|---|---|
data -
JSON!
|
Data to be persisted, Make sure to follow the shared schema |
Example
Query
mutation SetUserPersistedData($data: JSON!) {
setUserPersistedData(data: $data)
}
Variables
{"data": {}}
Response
{
"data": {
"setUserPersistedData": MutationSetUserPersistedDataSuccess
}
}
sponsoredAffiliateWithdraw
Description
[AUTHENTICATED] Transaction payload to withdraw referrals
Response
Arguments
| Name | Description |
|---|---|
input -
MutationSponsoredAffiliateWithdrawInput!
|
Example
Query
mutation SponsoredAffiliateWithdraw($input: MutationSponsoredAffiliateWithdrawInput!) {
sponsoredAffiliateWithdraw(input: $input)
}
Variables
{"input": MutationSponsoredAffiliateWithdrawInput}
Response
{"data": {"sponsoredAffiliateWithdraw": ForbiddenError}}
sponsoredUpload
Description
[ARTIST] Transact signed payload to upload a song
Response
Returns a
MutationSponsoredUploadResult!
Arguments
| Name | Description |
|---|---|
chain -
L2ChainType!
|
The chain for the transaction |
data -
String!
|
Signed payload |
editionAddress -
Address!
|
Edition address |
soundCreatorAddress -
Address!
|
Creator address |
Example
Query
mutation SponsoredUpload(
$chain: L2ChainType!,
$data: String!,
$editionAddress: Address!,
$soundCreatorAddress: Address!
) {
sponsoredUpload(
chain: $chain,
data: $data,
editionAddress: $editionAddress,
soundCreatorAddress: $soundCreatorAddress
)
}
Variables
{
"chain": "BASE",
"data": "xyz789",
"editionAddress": Address,
"soundCreatorAddress": Address
}
Response
{"data": {"sponsoredUpload": ForbiddenError}}
sponsoredWithdraw
Description
[AUTHENTICATED] Transaction payload to withdraw releases
Response
Returns a
MutationSponsoredWithdrawResult!
Arguments
| Name | Description |
|---|---|
input -
MutationSponsoredWithdrawInput!
|
Example
Query
mutation SponsoredWithdraw($input: MutationSponsoredWithdrawInput!) {
sponsoredWithdraw(input: $input)
}
Variables
{"input": MutationSponsoredWithdrawInput}
Response
{"data": {"sponsoredWithdraw": ForbiddenError}}
subscribeArtistActivityNotification
Description
[AUTHENTICATED] Subscribe to updates from a specific artist
Response
Returns a
MutationSubscribeArtistActivityNotificationResult!
Arguments
| Name | Description |
|---|---|
input -
SubscribeArtistActivityNotificationInput!
|
Subscribe to artist input |
Example
Query
mutation SubscribeArtistActivityNotification($input: SubscribeArtistActivityNotificationInput!) {
subscribeArtistActivityNotification(input: $input)
}
Variables
{"input": SubscribeArtistActivityNotificationInput}
Response
{
"data": {
"subscribeArtistActivityNotification": CustomerIoAPICallError
}
}
syncUserNftsForEdition
Description
[AUTHENTICATED] Synchronize the nfts owned by authenticated user on specified edition. If specified edition could not be found this returns null instead.
Response
Returns a
ReleaseCollector
Arguments
| Name | Description |
|---|---|
input -
MutationSyncUserNftsForEditionInput!
|
Input for edition to synchronize |
Example
Query
mutation SyncUserNftsForEdition($input: MutationSyncUserNftsForEditionInput!) {
syncUserNftsForEdition(input: $input) {
firstNftCollected {
audioUrl
collectorRelease {
...ReleaseCollectorFragment
}
comment {
...CommentFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
createdAtBlockTime
id
isBurned
isGoldenEgg
openSeaMetadataAttributes {
...OpenSeaMetadataAttributeFragment
}
owner {
...UserFragment
}
release {
...ReleaseFragment
}
serialNumber
songSlot
tierNumber
title
tokenId
updatedAt
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
audioUrl
collectorRelease {
...ReleaseCollectorFragment
}
comment {
...CommentFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
createdAtBlockTime
id
isBurned
isGoldenEgg
openSeaMetadataAttributes {
...OpenSeaMetadataAttributeFragment
}
owner {
...UserFragment
}
release {
...ReleaseFragment
}
serialNumber
songSlot
tierNumber
title
tokenId
updatedAt
}
mostRecentNftWithComment {
audioUrl
collectorRelease {
...ReleaseCollectorFragment
}
comment {
...CommentFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
createdAtBlockTime
id
isBurned
isGoldenEgg
openSeaMetadataAttributes {
...OpenSeaMetadataAttributeFragment
}
owner {
...UserFragment
}
release {
...ReleaseFragment
}
serialNumber
songSlot
tierNumber
title
tokenId
updatedAt
}
nftsCount
ownedGoldenEgg {
animatedGoldenEggImageOptimized {
...MediaFragment
}
finalSerialBlockHash
goldenEggImage {
...MediaFragment
}
id
nft {
...NftFragment
}
}
release {
activityFeed {
...ReleaseActionConnectionFragment
}
affiliates {
...ReleaseAffiliateConnectionFragment
}
airdropCount
animatedCoverImage {
...MediaFragment
}
animatedGoldenEggImageOptimized {
...MediaFragment
}
artist {
...ArtistFragment
}
auctionContractType
auctionType
baseMetadataAttributes {
...MetadataAttributeFragment
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
...ReleaseCollectorConnectionFragment
}
collectorsCount
contract {
...ContractFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
creditSplit {
...CreditSplitFragment
}
credits {
...UserFragment
}
draftId
earliestCollector {
...ReleaseCollectorFragment
}
editionId
eggGame {
...EggGameFragment
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
...MediaFragment
}
gaCoverImage {
...MediaFragment
}
genre {
...GenreFragment
}
goldenEggImage {
...MediaFragment
}
goldenEggNft {
...NftFragment
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
...ReleaseCollectorFragment
}
likedBy {
...UserConnectionFragment
}
listeningParty
listing {
...AuctionListingInterfaceFragment
}
marketPlaceUrl
metadataDetails {
...MetadataDetailsFragment
}
mintStartTime
mintStartTimestamp
nftsPaginated {
...NftConnectionFragment
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
...RewardFragment
}
royaltyBps
saleDetails {
...SaleDetailsFragment
}
saleSchedules {
...SaleScheduleFragment
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
...SamConfigFragment
}
samSellBufferBpsOverride
scheduleIds {
...ScheduleIdentifierFragment
}
season
shelves {
...ShelfConnectionFragment
}
socialProofCollectors {
...UserFragment
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
...MediaFragment
}
staticGaCoverImage {
...MediaFragment
}
staticVipCoverImage {
...MediaFragment
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
...TopReleaseCollectorFragment
}
topPosts {
...PostFragment
}
topSpentCollector {
...ReleaseCollectorFragment
}
totalMinted
totalSupply
track {
...TrackFragment
}
type
vipAnimatedCoverImage {
...MediaFragment
}
vipCoverImage {
...MediaFragment
}
webEmbed
webappUri
}
tierPriority
user {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
vipNftsCount
volumeSpent
}
}
Variables
{"input": MutationSyncUserNftsForEditionInput}
Response
{
"data": {
"syncUserNftsForEdition": {
"firstNftCollected": Nft,
"firstNftCollectedDate": "2007-12-03T10:15:30Z",
"gaNftsCount": 123,
"id": "4",
"lowestNftSerialNumber": 123,
"lowestSerialNumberNftCollected": Nft,
"mostRecentNftWithComment": Nft,
"nftsCount": 987,
"ownedGoldenEgg": EggGame,
"release": Release,
"tierPriority": 987,
"user": User,
"vipNftsCount": 987,
"volumeSpent": "abc123"
}
}
}
syncUserNftsForEditionAdmin
Description
[ADMIN] Synchronize the nfts owned by user on specified edition. If specified edition could not be found this returns null instead.
Response
Returns a
ReleaseCollector
Arguments
| Name | Description |
|---|---|
input -
MutationSyncUserNftsForEditionAdminInput!
|
Input for edition and collector to synchronize |
Example
Query
mutation SyncUserNftsForEditionAdmin($input: MutationSyncUserNftsForEditionAdminInput!) {
syncUserNftsForEditionAdmin(input: $input) {
firstNftCollected {
audioUrl
collectorRelease {
...ReleaseCollectorFragment
}
comment {
...CommentFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
createdAtBlockTime
id
isBurned
isGoldenEgg
openSeaMetadataAttributes {
...OpenSeaMetadataAttributeFragment
}
owner {
...UserFragment
}
release {
...ReleaseFragment
}
serialNumber
songSlot
tierNumber
title
tokenId
updatedAt
}
firstNftCollectedDate
gaNftsCount
id
lowestNftSerialNumber
lowestSerialNumberNftCollected {
audioUrl
collectorRelease {
...ReleaseCollectorFragment
}
comment {
...CommentFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
createdAtBlockTime
id
isBurned
isGoldenEgg
openSeaMetadataAttributes {
...OpenSeaMetadataAttributeFragment
}
owner {
...UserFragment
}
release {
...ReleaseFragment
}
serialNumber
songSlot
tierNumber
title
tokenId
updatedAt
}
mostRecentNftWithComment {
audioUrl
collectorRelease {
...ReleaseCollectorFragment
}
comment {
...CommentFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
createdAtBlockTime
id
isBurned
isGoldenEgg
openSeaMetadataAttributes {
...OpenSeaMetadataAttributeFragment
}
owner {
...UserFragment
}
release {
...ReleaseFragment
}
serialNumber
songSlot
tierNumber
title
tokenId
updatedAt
}
nftsCount
ownedGoldenEgg {
animatedGoldenEggImageOptimized {
...MediaFragment
}
finalSerialBlockHash
goldenEggImage {
...MediaFragment
}
id
nft {
...NftFragment
}
}
release {
activityFeed {
...ReleaseActionConnectionFragment
}
affiliates {
...ReleaseAffiliateConnectionFragment
}
airdropCount
animatedCoverImage {
...MediaFragment
}
animatedGoldenEggImageOptimized {
...MediaFragment
}
artist {
...ArtistFragment
}
auctionContractType
auctionType
baseMetadataAttributes {
...MetadataAttributeFragment
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
...ReleaseCollectorConnectionFragment
}
collectorsCount
contract {
...ContractFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
creditSplit {
...CreditSplitFragment
}
credits {
...UserFragment
}
draftId
earliestCollector {
...ReleaseCollectorFragment
}
editionId
eggGame {
...EggGameFragment
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
...MediaFragment
}
gaCoverImage {
...MediaFragment
}
genre {
...GenreFragment
}
goldenEggImage {
...MediaFragment
}
goldenEggNft {
...NftFragment
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
...ReleaseCollectorFragment
}
likedBy {
...UserConnectionFragment
}
listeningParty
listing {
...AuctionListingInterfaceFragment
}
marketPlaceUrl
metadataDetails {
...MetadataDetailsFragment
}
mintStartTime
mintStartTimestamp
nftsPaginated {
...NftConnectionFragment
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
...RewardFragment
}
royaltyBps
saleDetails {
...SaleDetailsFragment
}
saleSchedules {
...SaleScheduleFragment
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
...SamConfigFragment
}
samSellBufferBpsOverride
scheduleIds {
...ScheduleIdentifierFragment
}
season
shelves {
...ShelfConnectionFragment
}
socialProofCollectors {
...UserFragment
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
...MediaFragment
}
staticGaCoverImage {
...MediaFragment
}
staticVipCoverImage {
...MediaFragment
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
...TopReleaseCollectorFragment
}
topPosts {
...PostFragment
}
topSpentCollector {
...ReleaseCollectorFragment
}
totalMinted
totalSupply
track {
...TrackFragment
}
type
vipAnimatedCoverImage {
...MediaFragment
}
vipCoverImage {
...MediaFragment
}
webEmbed
webappUri
}
tierPriority
user {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
vipNftsCount
volumeSpent
}
}
Variables
{"input": MutationSyncUserNftsForEditionAdminInput}
Response
{
"data": {
"syncUserNftsForEditionAdmin": {
"firstNftCollected": Nft,
"firstNftCollectedDate": "2007-12-03T10:15:30Z",
"gaNftsCount": 987,
"id": "4",
"lowestNftSerialNumber": 123,
"lowestSerialNumberNftCollected": Nft,
"mostRecentNftWithComment": Nft,
"nftsCount": 123,
"ownedGoldenEgg": EggGame,
"release": Release,
"tierPriority": 987,
"user": User,
"vipNftsCount": 123,
"volumeSpent": "xyz789"
}
}
}
tieredDraftMetadataUpload
Description
[ADMIN | ARTIST] Upload tiered draft metadata to Arweave
Response
Returns a
MutationTieredDraftMetadataUploadResult!
Arguments
| Name | Description |
|---|---|
input -
MutationTieredDraftMetadataUploadInput!
|
Input for tieredDraftMetadataUpload mutation |
Example
Query
mutation TieredDraftMetadataUpload($input: MutationTieredDraftMetadataUploadInput!) {
tieredDraftMetadataUpload(input: $input)
}
Variables
{"input": MutationTieredDraftMetadataUploadInput}
Response
{
"data": {
"tieredDraftMetadataUpload": ArweavePerUserBudgetExceededError
}
}
tieredDraftMetadataUploadAsync
Description
[ADMIN | ARTIST] Upload tiered draft metadata to Arweave
Response
Arguments
| Name | Description |
|---|---|
input -
MutationTieredDraftMetadataUploadAsyncInput!
|
Input for tieredDraftMetadataUploadAsync mutation |
Example
Query
mutation TieredDraftMetadataUploadAsync($input: MutationTieredDraftMetadataUploadAsyncInput!) {
tieredDraftMetadataUploadAsync(input: $input)
}
Variables
{"input": MutationTieredDraftMetadataUploadAsyncInput}
Response
{
"data": {
"tieredDraftMetadataUploadAsync": ArweavePerUserBudgetExceededError
}
}
undoRepost
Description
[AUTHENTICATED] Undo a repost. It returns the original post.
Response
Returns a
Post
Arguments
| Name | Description |
|---|---|
postId -
UUID!
|
ID of the post to not have a repost anymore |
Example
Query
mutation UndoRepost($postId: UUID!) {
undoRepost(postId: $postId) {
authorChannelRole
channel {
animatedProfileImage {
...MediaFragment
}
coverImage {
...MediaFragment
}
createdAt
description
discordUrl
id
name
nameSlug
profileImage {
...MediaFragment
}
published
rules
staticProfileImage {
...MediaFragment
}
telegramUrl
tiktokUrl
twitterUrl
webappUri
websiteUrl
}
commentCount
comments {
edges {
...PostCommentConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
content
createdAt
creator {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
farcasterHash
id
lexicalContent
repostCount
upvoteCount
webappUri
}
}
Variables
{
"postId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"undoRepost": {
"authorChannelRole": "MODERATOR",
"channel": Channel,
"commentCount": 123,
"comments": PostCommentConnection,
"content": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"creator": User,
"farcasterHash": "abc123",
"id": 4,
"lexicalContent": {},
"repostCount": 987,
"upvoteCount": 123,
"webappUri": "abc123"
}
}
}
unfollowUser
Description
[AUTHENTICATED] Unfollow user of input userId
Response
Returns a
UserRelation!
Arguments
| Name | Description |
|---|---|
input -
UnfollowUserInput!
|
Unfollow user inputs |
Example
Query
mutation UnfollowUser($input: UnfollowUserInput!) {
unfollowUser(input: $input) {
createdAt
id
relation
userA {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
userB {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
}
}
Variables
{"input": UnfollowUserInput}
Response
{
"data": {
"unfollowUser": {
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"relation": "FOLLOWING",
"userA": User,
"userB": User
}
}
}
unlikeRelease
Description
[AUTHENTICATED] Unlike a release.
Response
Returns a
MutationUnlikeReleaseResult!
Arguments
| Name | Description |
|---|---|
input -
UnlikeReleaseInput!
|
UnLike release inputs |
Example
Query
mutation UnlikeRelease($input: UnlikeReleaseInput!) {
unlikeRelease(input: $input)
}
Variables
{"input": UnlikeReleaseInput}
Response
{"data": {"unlikeRelease": MutationUnlikeReleaseSuccess}}
unlikeShelf
Description
[AUTHENTICATED] Unlike a shelf.
Response
Returns a
MutationUnlikeShelfResult!
Arguments
| Name | Description |
|---|---|
input -
UnlikeShelfInput!
|
UnLike shelf inputs |
Example
Query
mutation UnlikeShelf($input: UnlikeShelfInput!) {
unlikeShelf(input: $input)
}
Variables
{"input": UnlikeShelfInput}
Response
{"data": {"unlikeShelf": MutationUnlikeShelfSuccess}}
unpinReleasePostFromWaveform
Description
[AUTHENTICATED] Unpins a release post from the waveform
Response
Arguments
| Name | Description |
|---|---|
postId -
UUID!
|
ID of the post to unpin |
Example
Query
mutation UnpinReleasePostFromWaveform($postId: UUID!) {
unpinReleasePostFromWaveform(postId: $postId)
}
Variables
{
"postId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"unpinReleasePostFromWaveform": MutationUnpinReleasePostFromWaveformSuccess
}
}
unsubscribeArtistActivityNotification
Description
[AUTHENTICATED] Unsubscribe to updates from a specific artist. Noop if the user is not subscribed to the given artist. Returns number of cancelled artist subscriptions
Response
Returns a
MutationUnsubscribeArtistActivityNotificationResult!
Arguments
| Name | Description |
|---|---|
input -
UnsubscribeArtistActivityNotificationInput!
|
Unsubscribe to artist input |
Example
Query
mutation UnsubscribeArtistActivityNotification($input: UnsubscribeArtistActivityNotificationInput!) {
unsubscribeArtistActivityNotification(input: $input)
}
Variables
{"input": UnsubscribeArtistActivityNotificationInput}
Response
{
"data": {
"unsubscribeArtistActivityNotification": CustomerIoAPICallError
}
}
updateChannelSettings
Description
[AUTHENTICATED] Allows the channel owner to update the channel settings
Response
Returns a
MutationUpdateChannelSettingsResult!
Arguments
| Name | Description |
|---|---|
input -
UpdateChannelSettingsInput!
|
Input to update the channel settings |
Example
Query
mutation UpdateChannelSettings($input: UpdateChannelSettingsInput!) {
updateChannelSettings(input: $input)
}
Variables
{"input": UpdateChannelSettingsInput}
Response
{
"data": {
"updateChannelSettings": MutationUpdateChannelSettingsSuccess
}
}
updateDescription
Description
[AUTHENTICATED] Update authenticated user description
Example
Query
mutation UpdateDescription($description: String!) {
updateDescription(description: $description) {
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
avatar {
bucket
dominantColor
id
key
url
}
backedArtists {
edges {
...ArtistCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
bannerImage {
bucket
dominantColor
id
key
url
}
collectedReleases {
edges {
...CollectedReleaseConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
creditSplit {
...CreditSplitFragment
}
id
owner {
...UserFragment
}
percent
roles
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
firstNftOwned {
...NftFragment
}
gaNftsCount
goldenEgg {
...EggGameFragment
}
id
nftsCount
ownedTokens {
...OwnedTokenFragment
}
release {
...ReleaseFragment
}
tierPriority
vipNftsCount
}
followerCount
followers {
edges {
...UserRelationConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
following {
edges {
...UserRelationConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
followingCount
id
instagramHandle
invitedByUser {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
affiliateBuyers {
...PlaylistAffiliateBuyerConnectionFragment
}
coverImage {
...MediaFragment
}
coverReleases {
...ReleaseFragment
}
createdAt
deletedAt
description
extendedFrom {
...ShelfFragment
}
id
index
likedBy {
...UserConnectionFragment
}
likes
linkSlug
name
numLikes
numReferralPurchases
numUsersReferred
orderedReleases {
...ShelfReleaseConnectionFragment
}
playTimeInSeconds
previewReleases {
...ShelfReleaseFragment
}
releaseCount
releaseIds
socialProofReferrals {
...UserFragment
}
trackIds
type
user {
...UserFragment
}
webEmbed
webappUri
}
location {
label
placeId
}
nftsOwned
nftsPaginated {
edges {
...NftConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
nonce
numBackedArtists
postCount
publicAddress
roles {
isAdmin
isArtistRelations
}
shelves {
edges {
...ShelfConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
}
Variables
{"description": "abc123"}
Response
{
"data": {
"updateDescription": {
"artist": Artist,
"avatar": Media,
"backedArtists": ArtistCollectorConnection,
"bannerImage": Media,
"collectedReleases": CollectedReleaseConnection,
"collectedReleasesCount": 987,
"collectedReleasesIds": ["xyz789"],
"collectorPosition": 123,
"createdAt": "2007-12-03T10:15:30Z",
"creditAllocations": [CreditAllocation],
"delegateWalletAddress": "abc123",
"description": "abc123",
"displayName": "xyz789",
"email": "xyz789",
"ens": "xyz789",
"farcasterFid": "xyz789",
"farcasterSignerConnected": false,
"featuredReleases": [CollectedRelease],
"followerCount": 123,
"followers": UserRelationConnection,
"following": UserRelationConnection,
"followingCount": 123,
"id": 4,
"instagramHandle": "abc123",
"invitedByUser": User,
"isTopNotableCollector": false,
"lastReferralWithdrawableBalance": "xyz789",
"likedSounds": Shelf,
"location": GeoLocationPlaceGoogle,
"nftsOwned": 987,
"nftsPaginated": NftConnection,
"nonce": 987,
"numBackedArtists": 987,
"postCount": 123,
"publicAddress": "abc123",
"roles": UserRoles,
"shelves": ShelfConnection,
"shelvesCount": 123,
"showSplitsFeature": true,
"tiktokUrl": "abc123",
"topCollectorPosition": 987,
"twitterHandle": "abc123",
"username": "abc123",
"verifiedNotificationEmail": "xyz789",
"webappUri": "xyz789"
}
}
}
updateDraftInfo
Description
[ARTIST] Update draft info of given draftId
Response
Returns a
MutationUpdateDraftInfoResult!
Arguments
| Name | Description |
|---|---|
input -
UpdateDraftInfoInput!
|
Update draft info input arguments |
Example
Query
mutation UpdateDraftInfo($input: UpdateDraftInfoInput!) {
updateDraftInfo(input: $input)
}
Variables
{"input": UpdateDraftInfoInput}
Response
{"data": {"updateDraftInfo": AlreadyMintedError}}
updateKeyClient
Description
[ADMIN] Update existing Key Client
Response
Returns a
KeyClient!
Arguments
| Name | Description |
|---|---|
input -
UpdateKeyClient!
|
Data of Key Client to be updated |
Example
Query
mutation UpdateKeyClient($input: UpdateKeyClient!) {
updateKeyClient(input: $input) {
createdAt
id
key
name
status
updatedAt
}
}
Variables
{"input": UpdateKeyClient}
Response
{
"data": {
"updateKeyClient": {
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"key": "xyz789",
"name": "abc123",
"status": "ACTIVE",
"updatedAt": "2007-12-03T10:15:30Z"
}
}
}
updateNotificationEmail
Description
[AUTHENTICATED] Update authenticated user notifications email
Response
Returns a
MutationUpdateNotificationEmailResult!
Arguments
| Name | Description |
|---|---|
email -
EmailAddress
|
New email for notifications. Results in a verification prompt before it can be used |
Example
Query
mutation UpdateNotificationEmail($email: EmailAddress) {
updateNotificationEmail(email: $email)
}
Variables
{"email": "test@test.com"}
Response
{
"data": {
"updateNotificationEmail": MutationUpdateNotificationEmailSuccess
}
}
updateReferralWithdrawableBalance
Description
[AUTHENTICATED] Update the last tracked referral withdrawable balance of the authenticated user
Response
Returns a
User!
Example
Query
mutation UpdateReferralWithdrawableBalance {
updateReferralWithdrawableBalance {
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
avatar {
bucket
dominantColor
id
key
url
}
backedArtists {
edges {
...ArtistCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
bannerImage {
bucket
dominantColor
id
key
url
}
collectedReleases {
edges {
...CollectedReleaseConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
creditSplit {
...CreditSplitFragment
}
id
owner {
...UserFragment
}
percent
roles
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
firstNftOwned {
...NftFragment
}
gaNftsCount
goldenEgg {
...EggGameFragment
}
id
nftsCount
ownedTokens {
...OwnedTokenFragment
}
release {
...ReleaseFragment
}
tierPriority
vipNftsCount
}
followerCount
followers {
edges {
...UserRelationConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
following {
edges {
...UserRelationConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
followingCount
id
instagramHandle
invitedByUser {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
affiliateBuyers {
...PlaylistAffiliateBuyerConnectionFragment
}
coverImage {
...MediaFragment
}
coverReleases {
...ReleaseFragment
}
createdAt
deletedAt
description
extendedFrom {
...ShelfFragment
}
id
index
likedBy {
...UserConnectionFragment
}
likes
linkSlug
name
numLikes
numReferralPurchases
numUsersReferred
orderedReleases {
...ShelfReleaseConnectionFragment
}
playTimeInSeconds
previewReleases {
...ShelfReleaseFragment
}
releaseCount
releaseIds
socialProofReferrals {
...UserFragment
}
trackIds
type
user {
...UserFragment
}
webEmbed
webappUri
}
location {
label
placeId
}
nftsOwned
nftsPaginated {
edges {
...NftConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
nonce
numBackedArtists
postCount
publicAddress
roles {
isAdmin
isArtistRelations
}
shelves {
edges {
...ShelfConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
}
Response
{
"data": {
"updateReferralWithdrawableBalance": {
"artist": Artist,
"avatar": Media,
"backedArtists": ArtistCollectorConnection,
"bannerImage": Media,
"collectedReleases": CollectedReleaseConnection,
"collectedReleasesCount": 987,
"collectedReleasesIds": ["abc123"],
"collectorPosition": 123,
"createdAt": "2007-12-03T10:15:30Z",
"creditAllocations": [CreditAllocation],
"delegateWalletAddress": "xyz789",
"description": "abc123",
"displayName": "xyz789",
"email": "abc123",
"ens": "abc123",
"farcasterFid": "abc123",
"farcasterSignerConnected": false,
"featuredReleases": [CollectedRelease],
"followerCount": 123,
"followers": UserRelationConnection,
"following": UserRelationConnection,
"followingCount": 987,
"id": "4",
"instagramHandle": "abc123",
"invitedByUser": User,
"isTopNotableCollector": false,
"lastReferralWithdrawableBalance": "xyz789",
"likedSounds": Shelf,
"location": GeoLocationPlaceGoogle,
"nftsOwned": 123,
"nftsPaginated": NftConnection,
"nonce": 987,
"numBackedArtists": 987,
"postCount": 123,
"publicAddress": "abc123",
"roles": UserRoles,
"shelves": ShelfConnection,
"shelvesCount": 987,
"showSplitsFeature": true,
"tiktokUrl": "xyz789",
"topCollectorPosition": 123,
"twitterHandle": "abc123",
"username": "xyz789",
"verifiedNotificationEmail": "xyz789",
"webappUri": "xyz789"
}
}
}
updateSpotifyArtistUrl
Description
[ARTIST] Update authenticated artist Spotify URL
Response
Returns a
MutationUpdateSpotifyArtistUrlResult!
Arguments
| Name | Description |
|---|---|
spotifyUrl -
URL
|
Spotify URL |
Example
Query
mutation UpdateSpotifyArtistUrl($spotifyUrl: URL) {
updateSpotifyArtistUrl(spotifyUrl: $spotifyUrl)
}
Variables
{"spotifyUrl": "http://www.test.com/"}
Response
{
"data": {
"updateSpotifyArtistUrl": MutationUpdateSpotifyArtistUrlSuccess
}
}
updateTiktokUrl
Description
[AUTHENTICATED] Update Tiktok URL
Response
Returns a
MutationUpdateTiktokUrlResult!
Arguments
| Name | Description |
|---|---|
tiktokUrl -
URL
|
Tiktok URL |
Example
Query
mutation UpdateTiktokUrl($tiktokUrl: URL) {
updateTiktokUrl(tiktokUrl: $tiktokUrl)
}
Variables
{"tiktokUrl": "http://www.test.com/"}
Response
{
"data": {
"updateTiktokUrl": MutationUpdateTiktokUrlSuccess
}
}
uploadUserMedia
Description
[AUTHENTICATED] Upload media content for authenticated user's profile
Response
Returns a
User!
Arguments
| Name | Description |
|---|---|
content -
UploadedMedia!
|
Example
Query
mutation UploadUserMedia($content: UploadedMedia!) {
uploadUserMedia(content: $content) {
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
avatar {
bucket
dominantColor
id
key
url
}
backedArtists {
edges {
...ArtistCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
bannerImage {
bucket
dominantColor
id
key
url
}
collectedReleases {
edges {
...CollectedReleaseConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
creditSplit {
...CreditSplitFragment
}
id
owner {
...UserFragment
}
percent
roles
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
firstNftOwned {
...NftFragment
}
gaNftsCount
goldenEgg {
...EggGameFragment
}
id
nftsCount
ownedTokens {
...OwnedTokenFragment
}
release {
...ReleaseFragment
}
tierPriority
vipNftsCount
}
followerCount
followers {
edges {
...UserRelationConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
following {
edges {
...UserRelationConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
followingCount
id
instagramHandle
invitedByUser {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
affiliateBuyers {
...PlaylistAffiliateBuyerConnectionFragment
}
coverImage {
...MediaFragment
}
coverReleases {
...ReleaseFragment
}
createdAt
deletedAt
description
extendedFrom {
...ShelfFragment
}
id
index
likedBy {
...UserConnectionFragment
}
likes
linkSlug
name
numLikes
numReferralPurchases
numUsersReferred
orderedReleases {
...ShelfReleaseConnectionFragment
}
playTimeInSeconds
previewReleases {
...ShelfReleaseFragment
}
releaseCount
releaseIds
socialProofReferrals {
...UserFragment
}
trackIds
type
user {
...UserFragment
}
webEmbed
webappUri
}
location {
label
placeId
}
nftsOwned
nftsPaginated {
edges {
...NftConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
nonce
numBackedArtists
postCount
publicAddress
roles {
isAdmin
isArtistRelations
}
shelves {
edges {
...ShelfConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
}
Variables
{"content": UploadedMedia}
Response
{
"data": {
"uploadUserMedia": {
"artist": Artist,
"avatar": Media,
"backedArtists": ArtistCollectorConnection,
"bannerImage": Media,
"collectedReleases": CollectedReleaseConnection,
"collectedReleasesCount": 123,
"collectedReleasesIds": ["xyz789"],
"collectorPosition": 123,
"createdAt": "2007-12-03T10:15:30Z",
"creditAllocations": [CreditAllocation],
"delegateWalletAddress": "abc123",
"description": "abc123",
"displayName": "xyz789",
"email": "abc123",
"ens": "xyz789",
"farcasterFid": "xyz789",
"farcasterSignerConnected": false,
"featuredReleases": [CollectedRelease],
"followerCount": 123,
"followers": UserRelationConnection,
"following": UserRelationConnection,
"followingCount": 987,
"id": 4,
"instagramHandle": "abc123",
"invitedByUser": User,
"isTopNotableCollector": false,
"lastReferralWithdrawableBalance": "abc123",
"likedSounds": Shelf,
"location": GeoLocationPlaceGoogle,
"nftsOwned": 123,
"nftsPaginated": NftConnection,
"nonce": 987,
"numBackedArtists": 987,
"postCount": 987,
"publicAddress": "abc123",
"roles": UserRoles,
"shelves": ShelfConnection,
"shelvesCount": 987,
"showSplitsFeature": true,
"tiktokUrl": "abc123",
"topCollectorPosition": 987,
"twitterHandle": "abc123",
"username": "abc123",
"verifiedNotificationEmail": "abc123",
"webappUri": "xyz789"
}
}
}
upsertArtistBannerImage
Description
[ARTIST] Upsert artist banner image
Response
Returns an
Artist!
Arguments
| Name | Description |
|---|---|
bannerImage -
UploadedMedia!
|
Uploaded banner image |
Example
Query
mutation UpsertArtistBannerImage($bannerImage: UploadedMedia!) {
upsertArtistBannerImage(bannerImage: $bannerImage) {
bannerImage {
bucket
dominantColor
id
key
url
}
collectors {
edges {
...ArtistCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
activityFeed {
...ReleaseActionConnectionFragment
}
affiliates {
...ReleaseAffiliateConnectionFragment
}
airdropCount
animatedCoverImage {
...MediaFragment
}
animatedGoldenEggImageOptimized {
...MediaFragment
}
artist {
...ArtistFragment
}
auctionContractType
auctionType
baseMetadataAttributes {
...MetadataAttributeFragment
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
...ReleaseCollectorConnectionFragment
}
collectorsCount
contract {
...ContractFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
creditSplit {
...CreditSplitFragment
}
credits {
...UserFragment
}
draftId
earliestCollector {
...ReleaseCollectorFragment
}
editionId
eggGame {
...EggGameFragment
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
...MediaFragment
}
gaCoverImage {
...MediaFragment
}
genre {
...GenreFragment
}
goldenEggImage {
...MediaFragment
}
goldenEggNft {
...NftFragment
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
...ReleaseCollectorFragment
}
likedBy {
...UserConnectionFragment
}
listeningParty
listing {
...AuctionListingInterfaceFragment
}
marketPlaceUrl
metadataDetails {
...MetadataDetailsFragment
}
mintStartTime
mintStartTimestamp
nftsPaginated {
...NftConnectionFragment
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
...RewardFragment
}
royaltyBps
saleDetails {
...SaleDetailsFragment
}
saleSchedules {
...SaleScheduleFragment
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
...SamConfigFragment
}
samSellBufferBpsOverride
scheduleIds {
...ScheduleIdentifierFragment
}
season
shelves {
...ShelfConnectionFragment
}
socialProofCollectors {
...UserFragment
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
...MediaFragment
}
staticGaCoverImage {
...MediaFragment
}
staticVipCoverImage {
...MediaFragment
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
...TopReleaseCollectorFragment
}
topPosts {
...PostFragment
}
topSpentCollector {
...ReleaseCollectorFragment
}
totalMinted
totalSupply
track {
...TrackFragment
}
type
vipAnimatedCoverImage {
...MediaFragment
}
vipCoverImage {
...MediaFragment
}
webEmbed
webappUri
}
releases {
edges {
...ReleaseConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
userId
webappUri
}
}
Variables
{"bannerImage": UploadedMedia}
Response
{
"data": {
"upsertArtistBannerImage": {
"bannerImage": Media,
"collectors": ArtistCollectorConnection,
"createdAt": "2007-12-03T10:15:30Z",
"gemCollectionUrl": "abc123",
"id": "4",
"name": "xyz789",
"numCollectors": 123,
"numNfts": 987,
"numReleases": 987,
"pickedRelease": Release,
"releases": ReleaseConnection,
"releasesGenres": ["abc123"],
"season": "abc123",
"soundHandle": "abc123",
"spotifyUrl": "xyz789",
"tokenSymbol": "abc123",
"user": User,
"userId": "abc123",
"webappUri": "abc123"
}
}
}
upsertShelf
Description
[AUTHENTICATED] Upsert shelf for user. If id is passed in as input, mutation will update shelf. Otherwise, mutation will create new shelf
Response
Returns a
Shelf!
Arguments
| Name | Description |
|---|---|
input -
UpsertShelfInput!
|
Upsert shelf inputs |
Example
Query
mutation UpsertShelf($input: UpsertShelfInput!) {
upsertShelf(input: $input) {
affiliateBuyers {
edges {
...PlaylistAffiliateBuyerConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
coverImage {
bucket
dominantColor
id
key
url
}
coverReleases {
activityFeed {
...ReleaseActionConnectionFragment
}
affiliates {
...ReleaseAffiliateConnectionFragment
}
airdropCount
animatedCoverImage {
...MediaFragment
}
animatedGoldenEggImageOptimized {
...MediaFragment
}
artist {
...ArtistFragment
}
auctionContractType
auctionType
baseMetadataAttributes {
...MetadataAttributeFragment
}
behindTheMusic
canCollectorsDownloadAudio
chainId
collectors {
...ReleaseCollectorConnectionFragment
}
collectorsCount
contract {
...ContractFragment
}
contractAddress
coverImage {
...MediaFragment
}
createdAt
creditSplit {
...CreditSplitFragment
}
credits {
...UserFragment
}
draftId
earliestCollector {
...ReleaseCollectorFragment
}
editionId
eggGame {
...EggGameFragment
}
externalUrl
finalQuantity
fundingAddress
gaAnimatedCoverImage {
...MediaFragment
}
gaCoverImage {
...MediaFragment
}
genre {
...GenreFragment
}
goldenEggImage {
...MediaFragment
}
goldenEggNft {
...NftFragment
}
id
isAuctionSoldOut
isFirstPhaseCompleted
lastUpdatedAt
latestCollector {
...ReleaseCollectorFragment
}
likedBy {
...UserConnectionFragment
}
listeningParty
listing {
...AuctionListingInterfaceFragment
}
marketPlaceUrl
metadataDetails {
...MetadataDetailsFragment
}
mintStartTime
mintStartTimestamp
nftsPaginated {
...NftConnectionFragment
}
numSold
openseaUrl
postCount
price
publicAffiliateFeeBPS
publicAffiliateFeePercent
publicMintStart
quantity
quantityLowerBound
quantityUpperBound
rewards {
...RewardFragment
}
royaltyBps
saleDetails {
...SaleDetailsFragment
}
saleSchedules {
...SaleScheduleFragment
}
salesAffiliateFeesPercent
samAddress
samBuyBufferBpsOverride
samConfig {
...SamConfigFragment
}
samSellBufferBpsOverride
scheduleIds {
...ScheduleIdentifierFragment
}
season
shelves {
...ShelfConnectionFragment
}
socialProofCollectors {
...UserFragment
}
spotifyPresaveCampaign
spotifyPresaveCount
spotifyTrackId
staticCoverImage {
...MediaFragment
}
staticGaCoverImage {
...MediaFragment
}
staticVipCoverImage {
...MediaFragment
}
supplyCutoffTimestamp
title
titleSlug
topCollectors {
...TopReleaseCollectorFragment
}
topPosts {
...PostFragment
}
topSpentCollector {
...ReleaseCollectorFragment
}
totalMinted
totalSupply
track {
...TrackFragment
}
type
vipAnimatedCoverImage {
...MediaFragment
}
vipCoverImage {
...MediaFragment
}
webEmbed
webappUri
}
createdAt
deletedAt
description
extendedFrom {
affiliateBuyers {
...PlaylistAffiliateBuyerConnectionFragment
}
coverImage {
...MediaFragment
}
coverReleases {
...ReleaseFragment
}
createdAt
deletedAt
description
extendedFrom {
...ShelfFragment
}
id
index
likedBy {
...UserConnectionFragment
}
likes
linkSlug
name
numLikes
numReferralPurchases
numUsersReferred
orderedReleases {
...ShelfReleaseConnectionFragment
}
playTimeInSeconds
previewReleases {
...ShelfReleaseFragment
}
releaseCount
releaseIds
socialProofReferrals {
...UserFragment
}
trackIds
type
user {
...UserFragment
}
webEmbed
webappUri
}
id
index
likedBy {
edges {
...UserConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
likes
linkSlug
name
numLikes
numReferralPurchases
numUsersReferred
orderedReleases {
edges {
...ShelfReleaseConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
playTimeInSeconds
previewReleases {
addedAt
id
index
ownedFirstNft {
...NftFragment
}
ownedGoldenEgg {
...EggGameFragment
}
ownedTokens {
...OwnedTokenFragment
}
release {
...ReleaseFragment
}
}
releaseCount
releaseIds
socialProofReferrals {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
trackIds
type
user {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
webEmbed
webappUri
}
}
Variables
{"input": UpsertShelfInput}
Response
{
"data": {
"upsertShelf": {
"affiliateBuyers": PlaylistAffiliateBuyerConnection,
"coverImage": Media,
"coverReleases": [Release],
"createdAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"extendedFrom": [Shelf],
"id": "4",
"index": 987,
"likedBy": UserConnection,
"likes": 123,
"linkSlug": "xyz789",
"name": "abc123",
"numLikes": 987,
"numReferralPurchases": 987,
"numUsersReferred": 987,
"orderedReleases": ShelfReleaseConnection,
"playTimeInSeconds": 987,
"previewReleases": [ShelfRelease],
"releaseCount": 987,
"releaseIds": ["abc123"],
"socialProofReferrals": [User],
"trackIds": ["xyz789"],
"type": "DEFAULT",
"user": User,
"webEmbed": "abc123",
"webappUri": "abc123"
}
}
}
upsertShelfCoverImage
Description
[AUTHENTICATED] Upsert shelf cover image with the specified shelf id
Response
Returns a
MutationUpsertShelfCoverImageResult
Arguments
| Name | Description |
|---|---|
input -
MutationUpsertShelfCoverImageInput!
|
Example
Query
mutation UpsertShelfCoverImage($input: MutationUpsertShelfCoverImageInput!) {
upsertShelfCoverImage(input: $input)
}
Variables
{"input": MutationUpsertShelfCoverImageInput}
Response
{
"data": {
"upsertShelfCoverImage": MutationUpsertShelfCoverImageSuccess
}
}
upsertUserBannerImage
Description
[AUTHENTICATED] Upsert user banner image
Response
Returns a
User!
Arguments
| Name | Description |
|---|---|
bannerImage -
UploadedMedia!
|
Uploaded banner image |
Example
Query
mutation UpsertUserBannerImage($bannerImage: UploadedMedia!) {
upsertUserBannerImage(bannerImage: $bannerImage) {
artist {
bannerImage {
...MediaFragment
}
collectors {
...ArtistCollectorConnectionFragment
}
createdAt
gemCollectionUrl
id
name
numCollectors
numNfts
numReleases
pickedRelease {
...ReleaseFragment
}
releases {
...ReleaseConnectionFragment
}
releasesGenres
season
soundHandle
spotifyUrl
tokenSymbol
user {
...UserFragment
}
userId
webappUri
}
avatar {
bucket
dominantColor
id
key
url
}
backedArtists {
edges {
...ArtistCollectorConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
bannerImage {
bucket
dominantColor
id
key
url
}
collectedReleases {
edges {
...CollectedReleaseConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
creditSplit {
...CreditSplitFragment
}
id
owner {
...UserFragment
}
percent
roles
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
firstNftOwned {
...NftFragment
}
gaNftsCount
goldenEgg {
...EggGameFragment
}
id
nftsCount
ownedTokens {
...OwnedTokenFragment
}
release {
...ReleaseFragment
}
tierPriority
vipNftsCount
}
followerCount
followers {
edges {
...UserRelationConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
following {
edges {
...UserRelationConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
followingCount
id
instagramHandle
invitedByUser {
artist {
...ArtistFragment
}
avatar {
...MediaFragment
}
backedArtists {
...ArtistCollectorConnectionFragment
}
bannerImage {
...MediaFragment
}
collectedReleases {
...CollectedReleaseConnectionFragment
}
collectedReleasesCount
collectedReleasesIds
collectorPosition
createdAt
creditAllocations {
...CreditAllocationFragment
}
delegateWalletAddress
description
displayName
email
ens
farcasterFid
farcasterSignerConnected
featuredReleases {
...CollectedReleaseFragment
}
followerCount
followers {
...UserRelationConnectionFragment
}
following {
...UserRelationConnectionFragment
}
followingCount
id
instagramHandle
invitedByUser {
...UserFragment
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
...ShelfFragment
}
location {
...GeoLocationPlaceGoogleFragment
}
nftsOwned
nftsPaginated {
...NftConnectionFragment
}
nonce
numBackedArtists
postCount
publicAddress
roles {
...UserRolesFragment
}
shelves {
...ShelfConnectionFragment
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
isTopNotableCollector
lastReferralWithdrawableBalance
likedSounds {
affiliateBuyers {
...PlaylistAffiliateBuyerConnectionFragment
}
coverImage {
...MediaFragment
}
coverReleases {
...ReleaseFragment
}
createdAt
deletedAt
description
extendedFrom {
...ShelfFragment
}
id
index
likedBy {
...UserConnectionFragment
}
likes
linkSlug
name
numLikes
numReferralPurchases
numUsersReferred
orderedReleases {
...ShelfReleaseConnectionFragment
}
playTimeInSeconds
previewReleases {
...ShelfReleaseFragment
}
releaseCount
releaseIds
socialProofReferrals {
...UserFragment
}
trackIds
type
user {
...UserFragment
}
webEmbed
webappUri
}
location {
label
placeId
}
nftsOwned
nftsPaginated {
edges {
...NftConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
nonce
numBackedArtists
postCount
publicAddress
roles {
isAdmin
isArtistRelations
}
shelves {
edges {
...ShelfConnectionEdgeFragment
}
pageInfo {
...PageInfoFragment
}
}
shelvesCount
showSplitsFeature
tiktokUrl
topCollectorPosition
twitterHandle
username
verifiedNotificationEmail
webappUri
}
}
Variables
{"bannerImage": UploadedMedia}
Response
{
"data": {
"upsertUserBannerImage": {
"artist": Artist,
"avatar": Media,
"backedArtists": ArtistCollectorConnection,
"bannerImage": Media,
"collectedReleases": CollectedReleaseConnection,
"collectedReleasesCount": 987,
"collectedReleasesIds": ["xyz789"],
"collectorPosition": 123,
"createdAt": "2007-12-03T10:15:30Z",
"creditAllocations": [CreditAllocation],
"delegateWalletAddress": "xyz789",
"description": "abc123",
"displayName": "abc123",
"email": "xyz789",
"ens": "xyz789",
"farcasterFid": "abc123",
"farcasterSignerConnected": false,
"featuredReleases": [CollectedRelease],
"followerCount": 987,
"followers": UserRelationConnection,
"following": UserRelationConnection,
"followingCount": 987,
"id": "4",
"instagramHandle": "xyz789",
"invitedByUser": User,
"isTopNotableCollector": false,
"lastReferralWithdrawableBalance": "xyz789",
"likedSounds": Shelf,
"location": GeoLocationPlaceGoogle,
"nftsOwned": 123,
"nftsPaginated": NftConnection,
"nonce": 987,
"numBackedArtists": 987,
"postCount": 123,
"publicAddress": "abc123",
"roles": UserRoles,
"shelves": ShelfConnection,
"shelvesCount": 123,
"showSplitsFeature": true,
"tiktokUrl": "xyz789",
"topCollectorPosition": 987,
"twitterHandle": "abc123",
"username": "xyz789",
"verifiedNotificationEmail": "abc123",
"webappUri": "abc123"
}
}
}
verifyAuthChallenge
Description
[PUBLIC] Verify given auth challenge
Response
Returns a
String!
Example
Query
mutation VerifyAuthChallenge(
$publicAddress: String!,
$signedMessage: String!
) {
verifyAuthChallenge(
publicAddress: $publicAddress,
signedMessage: $signedMessage
)
}
Variables
{
"publicAddress": "abc123",
"signedMessage": "abc123"
}
Response
{"data": {"verifyAuthChallenge": "abc123"}}
verifyDynamicJWT
Description
[PUBLIC] Verify JWT from Dynamic
Example
Query
mutation VerifyDynamicJWT($jwt: JWT!) {
verifyDynamicJWT(jwt: $jwt)
}
Variables
{
"jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwiaWF0IjoxNTE2MjM5MDIyLCJwcm9qZWN0IjoiZ3JhcGhxbC1zY2FsYXJzIn0.nYdrSfE2nNRAgpiEU1uKgn2AYYKLo28Z0nhPXvsuIww"
}
Response
{"data": {"verifyDynamicJWT": "xyz789"}}
verifyInstagram
Description
[AUTHENTICATED] Verify instagram handle
Response
Returns a
MutationVerifyInstagramResult!
Example
Query
mutation VerifyInstagram(
$authorizationCode: String!,
$redirectURI: String!
) {
verifyInstagram(
authorizationCode: $authorizationCode,
redirectURI: $redirectURI
)
}
Variables
{
"authorizationCode": "abc123",
"redirectURI": "abc123"
}
Response
{"data": {"verifyInstagram": InstagramAPIError}}
verifyNotificationEmail
Description
[PUBLIC] Verifies user notifications token
Response
Returns a
MutationVerifyNotificationEmailResult!
Arguments
| Name | Description |
|---|---|
token -
String!
|
A valid notification verification token |
Example
Query
mutation VerifyNotificationEmail($token: String!) {
verifyNotificationEmail(token: $token)
}
Variables
{"token": "xyz789"}
Response
{
"data": {
"verifyNotificationEmail": MutationVerifyNotificationEmailSuccess
}
}
verifyTwitterHandle
Description
[AUTHENTICATED] Verify twitter handle
Response
Returns a
MutationVerifyTwitterHandleResult!
Example
Query
mutation VerifyTwitterHandle(
$authorizationCode: String!,
$redirectURI: String!
) {
verifyTwitterHandle(
authorizationCode: $authorizationCode,
redirectURI: $redirectURI
)
}
Variables
{
"authorizationCode": "abc123",
"redirectURI": "abc123"
}
Response
{
"data": {
"verifyTwitterHandle": MutationVerifyTwitterHandleSuccess
}
}
voteOnPostComment
Description
[AUTHENTICATED] Sets the vote state on a post comment
Response
Returns a
MutationVoteOnPostCommentResult
Arguments
| Name | Description |
|---|---|
input -
SetVoteOnPostCommentInput!
|
Input to vote on a post comment |
Example
Query
mutation VoteOnPostComment($input: SetVoteOnPostCommentInput!) {
voteOnPostComment(input: $input)
}
Variables
{"input": SetVoteOnPostCommentInput}
Response
{
"data": {
"voteOnPostComment": MutationVoteOnPostCommentSuccess
}
}
voteOnPostRL
Description
[AUTHENTICATED] Sets the vote state on a post (rate limited to 10/s)
Response
Returns an
MutationVoteOnPostRLResult
Arguments
| Name | Description |
|---|---|
input -
SetVoteOnPostInput!
|
Input to vote on a post |
Example
Query
mutation VoteOnPostRL($input: SetVoteOnPostInput!) {
voteOnPostRL(input: $input)
}
Variables
{"input": SetVoteOnPostInput}
Response
{"data": {"voteOnPostRL": MutationVoteOnPostRLSuccess}}
Types
AWSPresignedPost
AbortMultipartUploadOutput
AbortMultipartUploadRequest
AcceptArtistApplicationInput
Description
Input options for acceptArtistApplication mutation
Fields
| Input Field | Description |
|---|---|
artistApplicationId -
UUID!
|
Artist application entity id |
Example
{
"artistApplicationId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
ActivityFeed
Description
Activity Feed entity
Fields
| Field Name | Description |
|---|---|
groups -
ActivityFeedGroups!
|
Paginated activity feed groups of activity feed. |
Arguments
|
|
id -
ID!
|
Activity feed UUID |
Example
{"groups": ActivityFeedGroups, "id": 4}
ActivityFeedFilterArgs
Description
Filter activity feed
Fields
| Input Field | Description |
|---|---|
activityFeedType -
ActivityFeedType!
|
Only get activity feed of certain type |
Example
{"activityFeedType": "GLOBAL"}
ActivityFeedGroup
Description
Activity Feed Group entity
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
Activity feed group UUID |
information -
ActivityFeedGroupInfo!
|
Activity feed group info |
latestActivityOccurenceAt -
Timestamp!
|
Activity feed group timestamp of most recent activity occurrence |
rankingScore -
Int!
|
Activity feed group ranking score |
Example
{
"id": "4",
"information": ReleaseDroppedAggregate,
"latestActivityOccurenceAt": 1592577642,
"rankingScore": 987
}
ActivityFeedGroupBackingPost
Description
Post backing an activity feed group
Fields
| Field Name | Description |
|---|---|
activityFeedGroup -
ActivityFeedGroup!
|
The activity feed group associated with the post |
authorChannelRole -
ChannelCuratorRole
|
Channel role of the author (null if they are not a curator) |
channel -
Channel
|
Channel that the post was posted to |
commentCount -
Int!
|
Number of comments on the post |
comments -
PostCommentConnection!
|
Comments on the post |
Arguments
|
|
content -
String!
|
Content of the post |
createdAt -
DateTime!
|
Creation date of entity |
creator -
User!
|
User who created the post |
farcasterHash -
String
|
Farcaster hash of the post |
id -
ID!
|
Unique identifier of the Post |
lexicalContent -
JSON
|
Lexical content of the post |
repostCount -
Int!
|
Number of reposts on the post |
upvoteCount -
Int!
|
Number of upvotes on the post |
webappUri -
String!
|
Webapp URI of Post |
Example
{
"activityFeedGroup": ActivityFeedGroup,
"authorChannelRole": "MODERATOR",
"channel": Channel,
"commentCount": 987,
"comments": PostCommentConnection,
"content": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"creator": User,
"farcasterHash": "abc123",
"id": "4",
"lexicalContent": {},
"repostCount": 987,
"upvoteCount": 123,
"webappUri": "xyz789"
}
ActivityFeedGroupCollectedRelease
Description
Activity feed group collected release entity
Fields
| Field Name | Description |
|---|---|
amountPaidInWei -
String!
|
Amount paid in Wei for all purchases of a single release within activity feed group |
hasGoldenEgg -
Boolean!
|
Returns whether user has purchased the golden egg within the activity feed group |
mostRecentPurchasedFromUser -
User!
|
Most recent user that release was purchased from |
release -
Release!
|
Release corresponding to activity feed group collected release entity |
totalOwnedEditions -
Int!
|
Amount of nfts of a single release within activity feed group |
totalUsersPurchasedFrom -
Int!
|
Total number of unique users that release was purchased from |
Example
{
"amountPaidInWei": "xyz789",
"hasGoldenEgg": true,
"mostRecentPurchasedFromUser": User,
"release": Release,
"totalOwnedEditions": 987,
"totalUsersPurchasedFrom": 987
}
ActivityFeedGroupConnectionEdge
Description
Edge of Activity Feed Group Connection
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Cursor to be used for pagination |
node -
ActivityFeedGroup!
|
Activity Feed Group node |
Example
{
"cursor": "xyz789",
"node": ActivityFeedGroup
}
ActivityFeedGroupFeaturedCollector
Description
Activity feed group featured collector entity
Example
{
"amountPaidInWei": "abc123",
"nftsCount": 987,
"user": User
}
ActivityFeedGroupFilterArgs
Description
Filter activity feed groups
Fields
| Input Field | Description |
|---|---|
types -
[ActivityFeedGroupFilterOption!]!
|
Only get activity feed groups of certain type |
Example
{"types": ["ADDED_TO_PLAYLIST"]}
ActivityFeedGroupFilterOption
Description
Activity feed group filter option
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ADDED_TO_PLAYLIST"
ActivityFeedGroupInfo
Description
Union of activity feed group info
Example
ReleaseDroppedAggregate
ActivityFeedGroups
Description
Paginated activity feed group connection
Fields
| Field Name | Description |
|---|---|
edges -
[ActivityFeedGroupConnectionEdge]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [ActivityFeedGroupConnectionEdge],
"pageInfo": PageInfo
}
ActivityFeedType
Description
Activity feed type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"GLOBAL"
AddReleaseToShelfInput
Description
Input for addReleaseToShelf mutation
Fields
| Input Field | Description |
|---|---|
index -
NonNegativeInt
|
Specify index to insert the release within the shelf |
releaseId -
UUID!
|
Release identifier to be added |
shelfId -
UUID!
|
Identifier of owned target shelf to receive the new release |
Example
{
"index": 123,
"releaseId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"shelfId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
AddUsersToDraftAllowlistInput
Description
Input for addUsersToDraftAllowlist mutation
Fields
| Input Field | Description |
|---|---|
addresses -
[AllowedAddressInput!]!
|
Draft info input |
draftId -
UUID!
|
Draft identifier |
mintType -
MintingAccessConfigMintingType!
|
Draft allowlist sale type |
Example
{
"addresses": [AllowedAddressInput],
"draftId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"mintType": "FREE"
}
AddUsersToDraftAllowlistOutput
Description
Output entity of AddUsersToDraftAllowlist mutation
Fields
| Field Name | Description |
|---|---|
allowList -
AllowList!
|
Allowlist entity |
softErrorMessages -
[String!]
|
Soft error messages of mutation |
Example
{
"allowList": AllowList,
"softErrorMessages": ["xyz789"]
}
Address
Description
Ethereum address
Example
Address
AdminUserFollowRecommendationWeights
Description
Weights for determining user follow recommendations
Fields
| Input Field | Description |
|---|---|
listen -
Int!
|
Weight of listen activity |
listenDurationMin -
Int!
|
Minimum listen duration to qualify (seconds) |
listenDurationUnit -
Int!
|
Aggregate listen duration that results in a single unit of activity (seconds) |
purchase -
Int!
|
Weight of purchase activity |
releasePost -
Int!
|
Weight of release post activity |
Example
{
"listen": 987,
"listenDurationMin": 987,
"listenDurationUnit": 123,
"purchase": 123,
"releasePost": 123
}
AffiliateAggregate
Description
Release affiliate aggregate
Fields
| Field Name | Description |
|---|---|
earningsETH -
String!
|
Total of affiliate earnings in eth |
earningsWei -
String!
|
Total of affiliate earnings in wei |
mintsDriven -
Int!
|
Amount of referred mints |
releaseArtistName -
String!
|
Release artist name |
releaseArtistWebappUri -
String!
|
Webapp URI of Artist |
releaseCoverImageUrl -
String!
|
Release cover image url |
releaseId -
String!
|
ID of the Release |
releaseTitle -
String!
|
Release title |
releaseWebappUri -
String!
|
Webapp URI of Release |
Example
{
"earningsETH": "xyz789",
"earningsWei": "xyz789",
"mintsDriven": 123,
"releaseArtistName": "abc123",
"releaseArtistWebappUri": "xyz789",
"releaseCoverImageUrl": "abc123",
"releaseId": "xyz789",
"releaseTitle": "abc123",
"releaseWebappUri": "xyz789"
}
AffiliateCurator
Description
Affiliate Curator
Fields
| Field Name | Description |
|---|---|
affiliateEarned -
String!
|
Total volume spent through referrals in wei |
mintsQuantity -
Int!
|
Total referred mints quantity |
soundsReferred -
Int!
|
Count of different sounds referred |
totalVolume -
String!
|
Total volume spent through referrals in wei |
user -
User
|
User entity of affiliate curator |
Example
{
"affiliateEarned": "xyz789",
"mintsQuantity": 123,
"soundsReferred": 123,
"totalVolume": "xyz789",
"user": User
}
AffiliateSourceInput
Description
Input for setAffiliatePurchaseSource mutation
Fields
| Input Field | Description |
|---|---|
chain -
ChainType!
|
Chain of the transaction |
referralSource -
String!
|
Param value of referral source |
txHash -
TransactionHash!
|
Transaction hash associated with affiliate purchase |
Example
{
"chain": "BASE",
"referralSource": "abc123",
"txHash": TransactionHash
}
Airdrop
Description
Collector release added to playlist action entity
Fields
| Field Name | Description |
|---|---|
date -
DateTime!
|
Date of action |
fromSerialNumber -
Int
|
Starting serial number of NFT for airdrop |
fromTokenId -
Int!
|
Starting token ID of NFT for airdrop |
id -
ID!
|
Action id |
quantity -
Int!
|
Number of sequential tokens purchased |
release -
Release!
|
Release corresponding to collector airdrop action entity |
serialNumber -
Int!
|
Serial number of nft airdrop |
tierNumber -
Int
|
tierNumber of the NFT |
toSerialNumber -
Int
|
Ending serial number of NFT for airdrop |
toTokenId -
Int!
|
Ending token ID of NFT for airdrop |
user -
User!
|
User corresponding to collector action entity |
Example
{
"date": "2007-12-03T10:15:30Z",
"fromSerialNumber": 987,
"fromTokenId": 987,
"id": 4,
"quantity": 123,
"release": Release,
"serialNumber": 123,
"tierNumber": 123,
"toSerialNumber": 987,
"toTokenId": 123,
"user": User
}
AllCollectorsCursorConnectionArgs
Description
Pagination parameters for allCollectors
Fields
| Input Field | Description |
|---|---|
after -
String
|
Start forwards pagination since "after" cursor |
before -
String
|
Start backwards pagination since "before" cursor |
first -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "after", with a maximum of 51 nodes. |
last -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "before", with a maximum of 51 nodes. |
sort -
AllCollectorsCursorConnectionSort!
|
Customize sort behavior |
Example
{
"after": "abc123",
"before": "abc123",
"first": 123,
"last": 123,
"sort": AllCollectorsCursorConnectionSort
}
AllCollectorsCursorConnectionSort
Description
Customize sort of collectors
Fields
| Input Field | Description |
|---|---|
createdAt -
SortOrder
|
Sort by date of user first being connected in platform |
Example
{"createdAt": "ASC"}
AllCollectorsFilter
Description
Filter the allCollectors result
Fields
| Input Field | Description |
|---|---|
genres -
[Genres!]
|
Genre names to filter on for collector's releases |
includeArtists -
Boolean!
|
Should it include artists as collectors |
locationIds -
[String!]
|
Location ids to filter on for collector's releases |
onlyWithUsername -
Boolean!
|
Should it only include collectors with a valid username (twitterHandle, ens or displayName) |
Example
{
"genres": ["AFROBEAT"],
"includeArtists": true,
"locationIds": ["xyz789"],
"onlyWithUsername": true
}
AllCollectorsInput
Description
Input for allCollectors query
Fields
| Input Field | Description |
|---|---|
filter -
AllCollectorsFilter!
|
Filter the collectors |
pagination -
AllCollectorsCursorConnectionArgs!
|
Pagination parameters of collectors |
Example
{
"filter": AllCollectorsFilter,
"pagination": AllCollectorsCursorConnectionArgs
}
AllShelvesCursorConnectionArgs
Description
Pagination parameters for allShelves
Fields
| Input Field | Description |
|---|---|
after -
String
|
Start forwards pagination since "after" cursor |
before -
String
|
Start backwards pagination since "before" cursor |
first -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "after", with a maximum of 51 nodes. |
last -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "before", with a maximum of 51 nodes. |
sort -
AllShelvesCursorConnectionSort!
|
Customize sort behavior |
Example
{
"after": "xyz789",
"before": "xyz789",
"first": 123,
"last": 123,
"sort": AllShelvesCursorConnectionSort
}
AllShelvesCursorConnectionSort
Description
Customize sort of shelves
Fields
| Input Field | Description |
|---|---|
createdAt -
SortOrder
|
Sort by date of playlist being created |
Example
{"createdAt": "ASC"}
AllShelvesFilter
Description
Filter the shelves of allShelves query
Fields
| Input Field | Description |
|---|---|
genres -
[Genres!]
|
Genre names to filter on for shelf songs |
type -
[ShelfTypeFilter!]!
|
Filter the shelves based on the expected types |
Example
{"genres": ["AFROBEAT"], "type": ["ALL"]}
AllShelvesInput
Description
Input for allShelves query
Fields
| Input Field | Description |
|---|---|
filter -
AllShelvesFilter!
|
Filter the shelves, by default it gives all the user created shelves |
pagination -
AllShelvesCursorConnectionArgs!
|
Pagination parameters, by default it gives the last 10 shelves created |
Example
{
"filter": AllShelvesFilter,
"pagination": AllShelvesCursorConnectionArgs
}
AllWithdrawableEarnings
Description
Withdrawable contract earnings, returns null for values if contract contain dust amounts that are not worth withdrawing
Fields
| Field Name | Description |
|---|---|
artistContracts -
[ArtistContractEarning!]!
|
Artist contract earnings |
editionContracts -
[EditionContractEarning!]!
|
Edition contract earnings |
splitContracts -
[SplitsContractEarning!]!
|
Split contract earnings |
Example
{
"artistContracts": [ArtistContractEarning],
"editionContracts": [EditionContractEarning],
"splitContracts": [SplitsContractEarning]
}
Allocation
Description
Allocation input for credit split creation
Fields
| Input Field | Description |
|---|---|
ownerAddress -
Address!
|
Owner address of allocation |
percent -
Float!
|
Percent of allocation |
roles -
[String!]!
|
Roles associated with credit allocation |
Example
{
"ownerAddress": Address,
"percent": 123.45,
"roles": ["abc123"]
}
AllowList
Description
Allowlist entity
Fields
| Field Name | Description |
|---|---|
createdAt -
DateTime!
|
Allowlist creation date |
id -
ID!
|
Allowlist identifier |
totalUsers -
Int!
|
Total number of users in allowlist |
users -
UserConnection!
|
Paginate through all users of the allowlist |
Arguments
|
|
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"id": 4,
"totalUsers": 987,
"users": UserConnection
}
AllowedAddressInput
Description
Address to be added in allowlist
Fields
| Input Field | Description |
|---|---|
address -
Address!
|
Public address included in allowlist |
source -
AllowlistSourceType!
|
Source of the address added in allowlist |
Example
{"address": Address, "source": "ARTIST_SOUND_HOLDER"}
AllowlistSourceType
Description
Source of allowlist address
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ARTIST_SOUND_HOLDER"
AllowlistType
Description
Allow list types
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ARTIST_COLLECTORS"
AlreadyMintedError
Description
Returned when the user attempts to update a release that was already minted
Fields
| Field Name | Description |
|---|---|
message -
String!
|
Descriptive message of error |
Example
{"message": "abc123"}
AlterRole
Description
Possible options of role update input
Values
| Enum Value | Description |
|---|---|
|
|
Administrator of platform |
|
|
Member of artist relations team |
Example
"ADMIN"
Artist
Description
Artist Entity
Fields
| Field Name | Description |
|---|---|
bannerImage -
Media
|
Banner image of artist page |
collectors -
ArtistCollectorConnection!
|
Collectors of artist. |
Arguments
|
|
createdAt -
DateTime!
|
Creation date of artist entity |
gemCollectionUrl -
String
|
Gem Collection URL |
id -
ID!
|
Artist identifier |
name -
String!
|
Name of artist |
numCollectors -
Int!
|
Number of unique nft collectors of artist |
numNfts -
Int!
|
Number of nfts minted of artist |
numReleases -
Int!
|
Number of artist releases |
Arguments
|
|
pickedRelease -
Release
|
Picked release of artist |
releases -
ReleaseConnection!
|
Paginated releases of artist. |
Arguments
|
|
releasesGenres -
[String!]!
|
Genres of artist releases, with the most common genres first |
season -
String
|
Season associated with artist |
soundHandle -
String!
|
Sound handle to be used on URLs |
spotifyUrl -
String
|
Spotify URL |
tokenSymbol -
String
|
Token symbol of contract |
user -
User!
|
User entity of artist |
userId -
String!
|
User identifier of artist |
webappUri -
String!
|
Webapp URI of Artist |
Example
{
"bannerImage": Media,
"collectors": ArtistCollectorConnection,
"createdAt": "2007-12-03T10:15:30Z",
"gemCollectionUrl": "abc123",
"id": 4,
"name": "xyz789",
"numCollectors": 987,
"numNfts": 123,
"numReleases": 123,
"pickedRelease": Release,
"releases": ReleaseConnection,
"releasesGenres": ["abc123"],
"season": "abc123",
"soundHandle": "xyz789",
"spotifyUrl": "abc123",
"tokenSymbol": "abc123",
"user": User,
"userId": "abc123",
"webappUri": "abc123"
}
ArtistAction
ArtistActionConnection
Description
Paginated artist action connection
Fields
| Field Name | Description |
|---|---|
edges -
[ArtistActionConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [ArtistActionConnectionEdge],
"pageInfo": PageInfo
}
ArtistActionConnectionEdge
Description
Edge of artist action connection
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Cursor to be used for pagination |
node -
ArtistAction!
|
artist action node |
Example
{
"cursor": "xyz789",
"node": ArtistAction
}
ArtistActivityFeedActivityTypeFilterOption
Description
Artist activity feed action type filter option
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ALL"
ArtistActivityFeedFilterArgs
Description
Filter artist activity types
Fields
| Input Field | Description |
|---|---|
activityTypes -
[ArtistActivityFeedActivityTypeFilterOption!]!
|
Only get activity of given action type |
types -
[ArtistActivityFeedTypeFilterOption!]!
|
Only get activity by the given group |
Example
{"activityTypes": ["ALL"], "types": ["ALL"]}
ArtistActivityFeedTypeFilterOption
Description
Artist activity feed type filter option
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ALL"
ArtistApplication
Description
User appliction to be an artist
Fields
| Field Name | Description |
|---|---|
createdAt -
DateTime!
|
Creation date of entity |
id -
ID!
|
Artist application entity identifier |
info -
ArtistApplicationInfo
|
Application info |
mostRecentApplicationRejectionReason -
String
|
Most recent previously rejected application reason for user |
status -
ArtistApplicationStatus!
|
Application status |
user -
User!
|
User who created the application. |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"info": ArtistApplicationInfo,
"mostRecentApplicationRejectionReason": "xyz789",
"status": "ACCEPTED",
"user": User
}
ArtistApplicationConnection
Description
Paginated artist application connection
Fields
| Field Name | Description |
|---|---|
edges -
[ArtistApplicationConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [ArtistApplicationConnectionEdge],
"pageInfo": PageInfo
}
ArtistApplicationConnectionEdge
Description
Edge of artist application connection
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Cursor to be used for pagination |
node -
ArtistApplication!
|
Artist application node |
Example
{
"cursor": "xyz789",
"node": ArtistApplication
}
ArtistApplicationInfo
Description
Artist application info
Example
{
"artistName": "xyz789",
"coverImage": MediaUploadStepInfo,
"email": "abc123",
"instagramHandle": "abc123",
"soundHandle": "xyz789",
"spotifyUrl": "xyz789",
"twitterHandle": "xyz789"
}
ArtistApplicationStatus
Description
Artist application status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ACCEPTED"
ArtistApplicationsFilter
Description
Filter of Query.artistApplications paginated field
Fields
| Input Field | Description |
|---|---|
status -
[ArtistApplicationStatus!]!
|
Filters on application status |
Example
{"status": ["ACCEPTED"]}
ArtistAuctionOverrides
Description
Data for Artist minting auction process
Example
{
"artistAddress": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"id": "4"
}
ArtistCollector
Description
ArtistCollector
Example
{
"artist": Artist,
"firstNftCollected": Nft,
"firstNftCollectedDate": "2007-12-03T10:15:30Z",
"id": 4,
"nftsCount": 123,
"user": User
}
ArtistCollectorConnection
Description
Paginated connection of Artist Collectors
Fields
| Field Name | Description |
|---|---|
edges -
[ArtistCollectorConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [ArtistCollectorConnectionEdge],
"pageInfo": PageInfo
}
ArtistCollectorConnectionEdge
Description
Edge of Artist Collector Connection
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Cursor to be used for pagination |
node -
ArtistCollector!
|
ArtistCollector node |
Example
{
"cursor": "abc123",
"node": ArtistCollector
}
ArtistCollectorCursorConnectionArgs
Description
Pagination paramaters for artist collectors
Fields
| Input Field | Description |
|---|---|
after -
String
|
Start forwards pagination since "after" cursor |
before -
String
|
Start backwards pagination since "before" cursor |
first -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "after", with a maximum of 51 nodes. |
last -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "before", with a maximum of 51 nodes. |
sort -
ArtistCollectorCursorConnectionSort!
|
Customize sort behavior |
Example
{
"after": "abc123",
"before": "xyz789",
"first": 123,
"last": 123,
"sort": ArtistCollectorCursorConnectionSort
}
ArtistCollectorCursorConnectionSort
ArtistCollectorsAllowlist
Description
Info associated with artist draft allowlist
Fields
| Field Name | Description |
|---|---|
allArtistCollectors -
Boolean!
|
Flag to include or not include all collectors of release artist |
allCollaboratingArtists -
Boolean!
|
Flag to include or not include all collaborating artists of the release |
filteredArtists -
ArtistConnection!
|
Paginated artists of draftAllowlist taking into account user toggles |
totalCollectors -
Int!
|
Total number of artist collector users in draft allowlist |
Example
{
"allArtistCollectors": false,
"allCollaboratingArtists": false,
"filteredArtists": ArtistConnection,
"totalCollectors": 123
}
ArtistCommunityCSVUrlInput
Description
Input for artistCommunityCSVUrl mutation
Fields
| Input Field | Description |
|---|---|
communityType -
ArtistCommunityType!
|
Artist community type |
Example
{"communityType": "COLLECTORS"}
ArtistCommunityType
Description
Artist community types
Values
| Enum Value | Description |
|---|---|
|
|
Example
"COLLECTORS"
ArtistConnection
Description
Paginated connection of Artists
Fields
| Field Name | Description |
|---|---|
edges -
[ArtistConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [ArtistConnectionEdge],
"pageInfo": PageInfo
}
ArtistConnectionEdge
ArtistContractEarning
Description
Artist contract earnings
Example
{
"balanceForUser": "abc123",
"contractAddress": "xyz789",
"editionId": "abc123",
"totalBalance": "abc123"
}
ArtistCursorFilterArgs
Description
Filter for paginated artists
Fields
| Input Field | Description |
|---|---|
genres -
[Genres!]
|
Genre names to filter on for artist's releases |
hasCollector -
Boolean
|
Specify whether artist already has at least one collector (minted release) |
hasRelease -
Boolean
|
Specify whether artist already has at least one release |
locationIds -
[String!]
|
Location IDs from Google Places API to filter on for artist's releases |
season -
ArtistSeason
|
Specify season to be filtered |
Example
{
"genres": ["AFROBEAT"],
"hasCollector": false,
"hasRelease": true,
"locationIds": ["xyz789"],
"season": "GENESIS"
}
ArtistDefaultOptions
Description
Default reference artist minting release options for administration
Fields
| Field Name | Description |
|---|---|
auction -
[Auction!]!
|
Auction options union based on type |
Example
{"auction": [FixedAuction]}
ArtistDraftsInput
Description
Input for artistDrafts query
Fields
| Input Field | Description |
|---|---|
pagination -
DraftCursorConnectionArgs!
|
Cursor connection parameters |
Example
{"pagination": DraftCursorConnectionArgs}
ArtistDropPost
Description
ArtistDropPost entity
Fields
| Field Name | Description |
|---|---|
authorChannelRole -
ChannelCuratorRole
|
Channel role of the author (null if they are not a curator) |
channel -
Channel
|
Channel that the post was posted to |
commentCount -
Int!
|
Number of comments on the post |
comments -
PostCommentConnection!
|
Comments on the post |
Arguments
|
|
content -
String!
|
Content of the post |
createdAt -
DateTime!
|
Creation date of entity |
creator -
User!
|
User who created the post |
farcasterHash -
String
|
Farcaster hash of the post |
id -
ID!
|
Unique identifier of the Post |
lexicalContent -
JSON
|
Lexical content of the post |
release -
Release!
|
The release associated with the post |
repostCount -
Int!
|
Number of reposts on the post |
upvoteCount -
Int!
|
Number of upvotes on the post |
webappUri -
String!
|
Webapp URI of Post |
Example
{
"authorChannelRole": "MODERATOR",
"channel": Channel,
"commentCount": 123,
"comments": PostCommentConnection,
"content": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"creator": User,
"farcasterHash": "xyz789",
"id": "4",
"lexicalContent": {},
"release": Release,
"repostCount": 987,
"upvoteCount": 123,
"webappUri": "abc123"
}
ArtistInfo
Description
Simplified version of Artist entity
Example
{
"avatar": Media,
"id": "4",
"name": "xyz789",
"publicAddress": "xyz789"
}
ArtistMetaInput
Description
Artist meta configuration input
Fields
| Input Field | Description |
|---|---|
gemCollectionUrl -
URL
|
Gem Collection URL |
Example
{"gemCollectionUrl": "http://www.test.com/"}
ArtistMintedReleasesAuthorFilterOption
Description
Artist minted releases author filter option
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ALL"
ArtistMintedReleasesCreditSplitFilterOption
Description
Artist minted releases credit split filter option
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ALL"
ArtistMintedReleasesFilter
Description
Filter for artist minted releases. Default is only for artist sounds.
Fields
| Input Field | Description |
|---|---|
creditSplit -
ArtistMintedReleasesCreditSplitFilterOption!
|
Filters on release credit split status |
excludeReleaseIds -
[UUID!]!
|
Excludes specific releaseIds |
mintTimeStatus -
[MintTimeStatus!]!
|
Filters on release with specified mint time status |
releaseAlbumRevealStatus -
ReleaseAlbumRevealFilterOption!
|
Filters on whether album releases have been revealed or not |
releaseAuthor -
ArtistMintedReleasesAuthorFilterOption!
|
Filters on release author status |
releaseType -
[ReleaseType!]!
|
Filters on release type |
Example
{
"creditSplit": "ALL",
"excludeReleaseIds": [
"6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
],
"mintTimeStatus": ["PAST"],
"releaseAlbumRevealStatus": "ALL",
"releaseAuthor": "ALL",
"releaseType": ["ALBUM"]
}
ArtistNotificationSubscription
Description
Artist notification subscription entity that indicates a user has subscribed to updates from a specific artist
Example
{
"artist": Artist,
"artistId": 4,
"createdAt": "2007-12-03T10:15:30Z",
"id": "4"
}
ArtistNotificationSubscriptionConnection
Description
Paginated connection of ArtistNotificationSubscriptions
Fields
| Field Name | Description |
|---|---|
edges -
[ArtistNotificationSubscriptionConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [ArtistNotificationSubscriptionConnectionEdge],
"pageInfo": PageInfo
}
ArtistNotificationSubscriptionConnectionEdge
Description
Edge of ArtistNotificationSubscription Connection
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Cursor to be used for pagination |
node -
ArtistNotificationSubscription!
|
ArtistNotificationSubscription node |
Example
{
"cursor": "abc123",
"node": ArtistNotificationSubscription
}
ArtistNotificationSubscriptionCursorConnectionArgs
Description
Cursor connection parameters
Fields
| Input Field | Description |
|---|---|
after -
String
|
Start forwards pagination since "after" cursor |
before -
String
|
Start backwards pagination since "before" cursor |
first -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "after", with a maximum of 51 nodes. |
last -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "before", with a maximum of 51 nodes. |
sort -
SortOrder!
|
Sort the ArtistNotificationSubscriptions ascending or descending relative to the entity creation date |
Example
{
"after": "abc123",
"before": "xyz789",
"first": 123,
"last": 123,
"sort": "ASC"
}
ArtistPartnership
Description
Artist Partnership call to action information
Fields
| Field Name | Description |
|---|---|
highlights -
[ArtistPartnershipHighlight!]
|
Highlighted partnerships |
id -
ID!
|
Unique identifier |
message -
String!
|
Dynamic call-to-action message |
Example
{
"highlights": [ArtistPartnershipHighlight],
"id": "4",
"message": "xyz789"
}
ArtistPartnershipHighlight
Description
Artist Partnership Highlight
Example
{
"imageLabel": "xyz789",
"imageUrl": "xyz789",
"linkUrl": "xyz789"
}
ArtistPrivateCommunityMember
Description
Artist private community user member only to be accessed by the artist.
Fields
| Field Name | Description |
|---|---|
artistCollector -
ArtistCollector!
|
Artist community collector |
id -
ID!
|
Unique id of user |
subscriptionEmail -
String
|
Verified email address of user if subscribed to artist |
Example
{
"artistCollector": ArtistCollector,
"id": 4,
"subscriptionEmail": "xyz789"
}
ArtistPrivateCommunityMemberConnection
Description
Paginated connection of Artist Private Community Member
Fields
| Field Name | Description |
|---|---|
edges -
[ArtistPrivateCommunityMemberConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [ArtistPrivateCommunityMemberConnectionEdge],
"pageInfo": PageInfo
}
ArtistPrivateCommunityMemberConnectionEdge
Description
Edge of Artist Private Community Member Connection
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Cursor to be used for pagination |
node -
ArtistPrivateCommunityMember!
|
ArtistPrivateCommunityMember node |
Example
{
"cursor": "abc123",
"node": ArtistPrivateCommunityMember
}
ArtistPrivateCommunityMembersInput
Description
Input for artistPrivateCommunityMembers query
Fields
| Input Field | Description |
|---|---|
pagination -
ArtistCollectorCursorConnectionArgs!
|
Pagination parameters |
Example
{"pagination": ArtistCollectorCursorConnectionArgs}
ArtistReleaseOptions
Description
Artist minting release options
Fields
| Field Name | Description |
|---|---|
auction -
[Auction!]!
|
Auction options union based on type |
hasNoTimeRestriction -
Boolean!
|
Artist has no time restriction for minting |
hasSplitsAccess -
Boolean!
|
Does the artist have access to splits functionality |
Example
{
"auction": [FixedAuction],
"hasNoTimeRestriction": false,
"hasSplitsAccess": true
}
ArtistReleasePosted
Description
A release by the user was posted to feed by another user
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
UserNotification UUID |
post -
Post
|
Post entity |
release -
Release
|
Posted release entity |
timestamp -
Timestamp!
|
Timestamp for notification |
user -
User
|
Recipient user entity |
Example
{
"id": 4,
"post": Post,
"release": Release,
"timestamp": 1592577642,
"user": User
}
ArtistReleasesAuthorFilterOption
Description
Artist releases author filter option
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ALL"
ArtistReleasesCreditSplitFilterOption
Description
Artist releases credit split filter option
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ALL"
ArtistReleasesFilter
Description
Filter for artist releases. Default is only for artist sounds.
Fields
| Input Field | Description |
|---|---|
creditSplit -
ArtistReleasesCreditSplitFilterOption!
|
Filters on release credit split status |
excludeReleaseIds -
[UUID!]!
|
Excludes specific releaseIds |
mintTimeStatus -
[MintTimeStatus!]!
|
Filters on release with specified mint time status |
releaseAlbumRevealStatus -
ReleaseAlbumRevealFilterOption!
|
Filters on whether album releases have been revealed or not |
releaseAuthor -
ArtistReleasesAuthorFilterOption!
|
Filters on release author status |
releaseType -
[ReleaseType!]!
|
Filters on release type |
Example
{
"creditSplit": "ALL",
"excludeReleaseIds": [
"6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
],
"mintTimeStatus": ["PAST"],
"releaseAlbumRevealStatus": "ALL",
"releaseAuthor": "ALL",
"releaseType": ["ALBUM"]
}
ArtistSearchFilter
Description
Filter the artists to be searched
Example
{
"genres": ["AFROBEAT"],
"hasCollectors": true,
"locationIds": ["abc123"]
}
ArtistSeason
Description
Types of seasons for artists
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"GENESIS"
ArtistSortInput
Description
Defines sort order of Artist fields, array index defines tiebreaking
Fields
| Input Field | Description |
|---|---|
field -
SearchArtistsSortEnum!
|
Field to be sorted |
order -
SortOrder!
|
Sort ascending or descending |
Example
{"field": "CREATED_AT", "order": "ASC"}
ArtistSourceSelectedAllowlistConnection
Description
Connection entity of artist source selected allowlist
Fields
| Field Name | Description |
|---|---|
edges -
[ArtistSourceSelectedAllowlistEdge!]!
|
List of edges of pagination |
pageInfo -
PageInfo!
|
Pagination info helpers |
Example
{
"edges": [ArtistSourceSelectedAllowlistEdge],
"pageInfo": PageInfo
}
ArtistSourceSelectedAllowlistEdge
Description
Edge of connection for artist source selected allowlist
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Pagination cursor |
node -
ArtistSourceSubAllowlist!
|
Pagination node |
Example
{
"cursor": "abc123",
"node": ArtistSourceSubAllowlist
}
ArtistSourceSubAllowlist
Description
Allowlists of artists used as source of collectors
Example
{
"id": "4",
"sourceArtist": Artist,
"totalAddresses": 987
}
ArweaveEditOutput
Description
Output from edited metadata
Fields
| Field Name | Description |
|---|---|
coreEditionArweaveHash -
String
|
Arweave hash associated with non-tiered release edition |
storefrontArweaveHash -
String!
|
Arweave hash associatiated with storefront of contract |
tiers -
[TieredReleaseArweaveOutputs!]
|
Arweave outputs from tiered editions |
Example
{
"coreEditionArweaveHash": "abc123",
"storefrontArweaveHash": "xyz789",
"tiers": [TieredReleaseArweaveOutputs]
}
ArweavePerUserBudgetExceededError
Description
Arweave per-user upload budget allocation exceeded error
Fields
| Field Name | Description |
|---|---|
message -
String!
|
Descriptive message of error |
Example
{"message": "abc123"}
Auction
Description
Union of auction sale types
Types
| Union Types |
|---|
Example
FixedAuction
AuctionConfigurationInput
Description
Draft auction configuration input values
Fields
| Input Field | Description |
|---|---|
endTime -
Timestamp
|
Auction end time |
endTimeDays -
Int
|
Auction end time in days |
maxMintsPerWallet -
PositiveInt!
|
Max mints per wallet for auction |
price -
NonNegativeFloat!
|
Price per mint |
quantity -
PositiveInt!
|
Max supply for auction |
startTime -
Timestamp!
|
Auction start time |
Example
{
"endTime": 1592577642,
"endTimeDays": 987,
"maxMintsPerWallet": 123,
"price": 123.45,
"quantity": 123,
"startTime": 1592577642
}
AuctionConfigurationsInput
Description
Tiered Draft auction configurations input values
Fields
| Input Field | Description |
|---|---|
auctionType -
AuctionType!
|
Type of auction |
enabledSAM -
Boolean
|
Toggle to enable SAM for auction |
maxMintable -
PositiveInt!
|
Max mint supply of auction |
minQuantity -
PositiveInt!
|
Min mint supply of auction |
presaleMint -
AuctionConfigurationInput
|
Presale mint auction configurations |
publicMint -
AuctionConfigurationInput!
|
Public mint auction configurations |
quantityBreakdown -
[PositiveInt!]
|
Breakdown of mint quantities |
Example
{
"auctionType": "FIXED_QUANTITY",
"enabledSAM": true,
"maxMintable": 123,
"minQuantity": 123,
"presaleMint": AuctionConfigurationInput,
"publicMint": AuctionConfigurationInput,
"quantityBreakdown": [123]
}
AuctionInputRef
Description
Customize auction options based on type of sale
Fields
| Input Field | Description |
|---|---|
fixed -
FixedAuctionInput
|
fixed sales |
openEdition -
OpenEditionAuctionInput
|
open editions |
openEditionWithSam -
OpenEditionAuctionWithSAMInput
|
Open edition with SAM auction configurations |
Example
{
"fixed": FixedAuctionInput,
"openEdition": OpenEditionAuctionInput,
"openEditionWithSam": OpenEditionAuctionWithSAMInput
}
AuctionListingInterface
Description
Auction listing for releases
Fields
| Field Name | Description |
|---|---|
chain -
ChainType!
|
Chain associated with contract |
contractAddress -
String!
|
Contract address associated with auction |
id -
ID!
|
Unique auction listing identifier |
Possible Types
| AuctionListingInterface Types |
|---|
Example
{
"chain": "BASE",
"contractAddress": "xyz789",
"id": "4"
}
AuctionMetaInput
Description
Special meta options relation to auction
Fields
| Input Field | Description |
|---|---|
hasSplitsAccess -
Boolean!
|
Allow split functionality |
Example
{"hasSplitsAccess": false}
AuctionType
Description
Types of release sales
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"FIXED_QUANTITY"
AudienceMember
Description
Release audience member
Fields
| Field Name | Description |
|---|---|
firstActivityDate -
DateTime!
|
Earliest of first nft collected or first post |
gaNftsCount -
Int!
|
Amount of ga nfts owned |
id -
ID!
|
Unique id of audience member |
isGoldenEggWinner -
Boolean!
|
If the user is a golden egg winner |
mostRecentReleasePost -
ReleasePost
|
Most recent release post |
nftsCount -
Int!
|
Amount of release nfts owned |
postCount -
Int!
|
Amount of release posts |
user -
User!
|
User that is an audience member |
vipNftsCount -
Int!
|
Amount of vip nfts owned |
Example
{
"firstActivityDate": "2007-12-03T10:15:30Z",
"gaNftsCount": 123,
"id": 4,
"isGoldenEggWinner": false,
"mostRecentReleasePost": ReleasePost,
"nftsCount": 123,
"postCount": 123,
"user": User,
"vipNftsCount": 123
}
AudienceMemberConnection
Description
Paginated connection of audience members
Fields
| Field Name | Description |
|---|---|
edges -
[AudienceMemberConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [AudienceMemberConnectionEdge],
"pageInfo": PageInfo
}
AudienceMemberConnectionEdge
Description
Edge of Release Collector Connection
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Cursor to be used for pagination |
node -
AudienceMember!
|
AudienceMember node |
Example
{
"cursor": "abc123",
"node": AudienceMember
}
AudienceMemberCursorConnectionArgs
Description
Pagination parameters for audience members
Fields
| Input Field | Description |
|---|---|
after -
String
|
Start forwards pagination since "after" cursor |
before -
String
|
Start backwards pagination since "before" cursor |
first -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "after", with a maximum of 51 nodes. |
last -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "before", with a maximum of 51 nodes. |
sort -
AudienceMemberCursorConnectionSort!
|
Customize sort behavior |
tier -
NftTier
|
The NFT tier you want to select for AudienceMembers, defaults All |
Example
{
"after": "xyz789",
"before": "abc123",
"first": 123,
"last": 123,
"sort": AudienceMemberCursorConnectionSort,
"tier": "ALL"
}
AudienceMemberCursorConnectionSort
Description
Customize sort of audience members
Fields
| Input Field | Description |
|---|---|
firstActivityDate -
SortOrder
|
Sort by earliest activity date |
gaNftsCount -
SortOrder
|
Sort by amount ga nfts collected, with tie-breaker of earliest collector first |
priorityTop -
SortOrder
|
Sort by vips first, then ga, tie-breaker most nfts collected |
vipNftsCount -
SortOrder
|
Sort by amount vip nfts collected, with tie-breaker of earliest collector first |
Example
{
"firstActivityDate": "ASC",
"gaNftsCount": "ASC",
"priorityTop": "ASC",
"vipNftsCount": "ASC"
}
AudioMedia
Description
Audio Media (including all encodings)
Fields
| Field Name | Description |
|---|---|
audio128k -
Media
|
Track audio, AAC 128k if available |
audio192k -
Media
|
Track audio, AAC 192k if available |
audio256k -
Media
|
Track audio, AAC 256k if available |
audioHls -
Media
|
Track audio, HLS playlist if available |
audioOriginal -
Media!
|
Track audio, original non-transcoded version |
Example
{
"audio128k": Media,
"audio192k": Media,
"audio256k": Media,
"audioHls": Media,
"audioOriginal": Media
}
AuthorizationError
Description
Returned when the user attempts to access a resource they are not authorized for
Fields
| Field Name | Description |
|---|---|
message -
String!
|
Descriptive message of error |
Example
{"message": "abc123"}
AwsRequestError
BaseError
BondingCurveSale
Description
Bonding curve sale collector action entity
Fields
| Field Name | Description |
|---|---|
amountPaidInWei -
String!
|
Amount paid in Wei for bonding curve sale |
date -
DateTime!
|
Date of action |
fromSerialNumber -
Int
|
Starting serial number of NFT for bonding curve sale purchase |
fromTokenId -
Int!
|
Starting token ID of NFT for bonding curve sale purchase |
id -
ID!
|
Action id |
quantity -
Int!
|
Number of sequential tokens purchased |
release -
Release!
|
Release corresponding to collector bonding curve sale action entity |
serialNumber -
Int!
|
Starting serial number of nft bonding curve sale purchase |
tierNumber -
Int
|
tierNumber of the NFT |
toSerialNumber -
Int
|
Ending serial number of NFT for bonding curve sale purchase |
toTokenId -
Int!
|
Ending token ID of NFT for bonding curve sale purchase |
user -
User!
|
User corresponding to collector action entity |
Example
{
"amountPaidInWei": "xyz789",
"date": "2007-12-03T10:15:30Z",
"fromSerialNumber": 123,
"fromTokenId": 123,
"id": 4,
"quantity": 987,
"release": Release,
"serialNumber": 987,
"tierNumber": 987,
"toSerialNumber": 123,
"toTokenId": 123,
"user": User
}
BondingCurveSold
Description
Token sold to bonding curve collector action entity
Fields
| Field Name | Description |
|---|---|
date -
DateTime!
|
Date of action |
firstTokenId -
Int!
|
First token ID in the unordered batch of sold tokens |
id -
ID!
|
Action id |
paymentInWei -
String!
|
Payment received in Wei |
quantity -
Int!
|
Number of tokens sold |
release -
Release!
|
Release corresponding to collector bonding curve sold action entity |
user -
User!
|
User corresponding to collector action entity |
Example
{
"date": "2007-12-03T10:15:30Z",
"firstTokenId": 987,
"id": "4",
"paymentInWei": "xyz789",
"quantity": 987,
"release": Release,
"user": User
}
Boolean
Description
The Boolean scalar type represents true or false.
Example
true
ChainBalanceAndEarnings
Description
Earnings aggregates
Fields
| Field Name | Description |
|---|---|
chainId -
Int!
|
Chain ID on which release is minted on |
cummulativeEarned -
String!
|
Total eth earned by the user |
externalSplitMainBalance -
String!
|
Portion of split main balance unrelated to sound releases |
releasesAvailableToWithdraw -
String!
|
Total eth available for the user to withdraw from sound releases |
releasesSplitMainBalance -
String!
|
Portion of split main balance related to sound releases |
totalAvailableToWithdraw -
String!
|
Total eth available for the user to withdraw, includes sound releases and external split main balance |
totalSplitMainBalance -
String!
|
Total eth on the split main contract |
Example
{
"chainId": 987,
"cummulativeEarned": "xyz789",
"externalSplitMainBalance": "xyz789",
"releasesAvailableToWithdraw": "abc123",
"releasesSplitMainBalance": "abc123",
"totalAvailableToWithdraw": "abc123",
"totalSplitMainBalance": "abc123"
}
ChainType
Description
Chain name supported on the platform
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BASE"
ChangeRoleInput
Description
Input of "changeRoleForUser" mutation
Fields
| Input Field | Description |
|---|---|
publicAddress -
Address!
|
Wallet public address of user |
role -
AlterRole!
|
Role to be set for specified user |
value -
Boolean!
|
Set if specified role is going to be enabled or disabled |
Example
{
"publicAddress": Address,
"role": "ADMIN",
"value": false
}
Channel
Description
Channel entity
Fields
| Field Name | Description |
|---|---|
animatedProfileImage -
Media
|
Animated version of the profile image if it is a GIF. Otherwise, null |
coverImage -
Media
|
Cover image of Channel |
createdAt -
DateTime!
|
Creation date of entity |
description -
String
|
Description of the channel |
discordUrl -
String
|
Discord Url |
id -
ID!
|
Unique identifier of the Channel |
name -
String!
|
Name of the channel |
nameSlug -
String!
|
Name slug of the channel |
profileImage -
Media
|
Profile image of Channel |
published -
Boolean!
|
Whether the channel is published or not |
rules -
String
|
Rules of the channel |
staticProfileImage -
Media
|
Static version of animated profile image if it is a GIF. Otherwise, null |
telegramUrl -
String
|
Telegram or Guild Url |
tiktokUrl -
String
|
Tiktok Url |
twitterUrl -
String
|
Twitter Url |
webappUri -
String!
|
Webapp URI of Channel |
websiteUrl -
String
|
Website Url |
Example
{
"animatedProfileImage": Media,
"coverImage": Media,
"createdAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"discordUrl": "xyz789",
"id": "4",
"name": "xyz789",
"nameSlug": "xyz789",
"profileImage": Media,
"published": false,
"rules": "abc123",
"staticProfileImage": Media,
"telegramUrl": "xyz789",
"tiktokUrl": "abc123",
"twitterUrl": "xyz789",
"webappUri": "abc123",
"websiteUrl": "xyz789"
}
ChannelConnection
Description
Paginated connection of channels
Fields
| Field Name | Description |
|---|---|
edges -
[ChannelConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [ChannelConnectionEdge],
"pageInfo": PageInfo
}
ChannelConnectionEdge
ChannelCurator
Description
Channel curator
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
Node identifier |
role -
ChannelCuratorRole!
|
The role of the curator |
user -
User!
|
The curator user |
Example
{"id": 4, "role": "MODERATOR", "user": User}
ChannelCuratorConnection
Description
Paginated connection of channel Curators
Fields
| Field Name | Description |
|---|---|
edges -
[ChannelCuratorConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [ChannelCuratorConnectionEdge],
"pageInfo": PageInfo
}
ChannelCuratorConnectionEdge
Description
Edge of Channel Curator Connection
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Cursor to be used for pagination |
node -
ChannelCurator!
|
ChannelCurator node |
Example
{
"cursor": "xyz789",
"node": ChannelCurator
}
ChannelCuratorRole
Description
The role of the channel curator
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"MODERATOR"
ChannelMember
ChannelMemberConnection
Description
Paginated connection of channel members
Fields
| Field Name | Description |
|---|---|
edges -
[ChannelMemberConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [ChannelMemberConnectionEdge],
"pageInfo": PageInfo
}
ChannelMemberConnectionEdge
Description
Edge of Channel Member Connection
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Cursor to be used for pagination |
node -
ChannelMember!
|
ChannelMember node |
Example
{
"cursor": "abc123",
"node": ChannelMember
}
ChannelMemberFollowedInput
Description
Input for "channelMembersWhoAreFollowed" query
Fields
| Input Field | Description |
|---|---|
channelId -
UUID!
|
Channel identifier |
Example
{
"channelId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
ChannelMembersWhoAreFollowedResult
Description
Search result
Fields
| Field Name | Description |
|---|---|
count -
Int!
|
[AUTHENTICATED] Number of members of the channel who the current user follows |
members -
ChannelMemberConnection!
|
[AUTHENTICATED] Members of the channel who the current user follows |
Arguments
|
|
Example
{"count": 123, "members": ChannelMemberConnection}
ChannelNotificationStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DISABLED"
ChannelPostConnection
Description
Paginated connection of channel posts
Fields
| Field Name | Description |
|---|---|
edges -
[ChannelPostConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [ChannelPostConnectionEdge],
"pageInfo": PageInfo
}
ChannelPostConnectionEdge
ChannelResult
ChannelStats
Description
Channel Stats
Fields
| Field Name | Description |
|---|---|
channelId -
String!
|
ID of the channel |
joinStatus -
CurrentUserChannelJoinStatus
|
Join status of the channel by the user (if authenticated) |
memberCount -
Int!
|
Number of members on the channel |
notificationStatus -
ChannelNotificationStatus
|
Notification status of the channel by the user (if authenticated) |
postCount -
Int!
|
Number of posts on the channel |
Example
{
"channelId": "xyz789",
"joinStatus": "JOINED",
"memberCount": 987,
"notificationStatus": "DISABLED",
"postCount": 987
}
CollectedRelease
Description
Simplified version of Release entity filtered on the owner public address
Fields
| Field Name | Description |
|---|---|
firstNftOwned -
Nft
|
First backed nft of collected release |
gaNftsCount -
Int!
|
Amount of ga nfts owned |
goldenEgg -
EggGame
|
Returns golden egg if user owns, otherwise null |
id -
ID!
|
Unique identifier of release |
nftsCount -
Int!
|
Amount of nfts owned |
ownedTokens -
[OwnedToken!]
|
List of possible owned tokens in ascending tokenId order. If user does not own the release, it returns null |
release -
Release!
|
Release entity |
tierPriority -
Int!
|
The priority of the NFTs the user owns |
vipNftsCount -
Int!
|
Amount of vip nfts owned |
Example
{
"firstNftOwned": Nft,
"gaNftsCount": 987,
"goldenEgg": EggGame,
"id": 4,
"nftsCount": 123,
"ownedTokens": [OwnedToken],
"release": Release,
"tierPriority": 987,
"vipNftsCount": 987
}
CollectedReleaseConnection
Description
Paginated collected releases connection
Fields
| Field Name | Description |
|---|---|
edges -
[CollectedReleaseConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [CollectedReleaseConnectionEdge],
"pageInfo": PageInfo
}
CollectedReleaseConnectionEdge
Description
Edge of Collected Release Connection
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Cursor to be used for pagination |
node -
CollectedRelease!
|
Collected Release node |
Example
{
"cursor": "abc123",
"node": CollectedRelease
}
CollectionMarketType
Description
Name of the collection market
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"AIRDROP"
CollectorAction
CollectorActionConnection
Description
Paginated collector action connection
Fields
| Field Name | Description |
|---|---|
edges -
[CollectorActionConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [CollectorActionConnectionEdge],
"pageInfo": PageInfo
}
CollectorActionConnectionEdge
Description
Edge of collector action connection
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Cursor to be used for pagination |
node -
CollectorAction!
|
Collector action node |
Example
{
"cursor": "xyz789",
"node": CollectorAction
}
CollectorActivityFeedFilterArgs
Description
Filter collector feed activity types
Fields
| Input Field | Description |
|---|---|
types -
[CollectorActivityFeedTypeFilterOption!]!
|
Only get activity of given type |
Example
{"types": ["ALL"]}
CollectorActivityFeedTypeFilterOption
Description
Collector activity feed type filter option
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ALL"
CollectorComment
Description
CollectorComment entity
Fields
| Field Name | Description |
|---|---|
collector -
ReleaseCollector!
|
Collector who made the comment |
comment -
Comment!
|
Comment of NFT |
id -
ID!
|
Node identifier |
nft -
Nft!
|
Nft associated with comment |
normalizedSongSlot -
Int!
|
Song slot reserved by NFT |
postComment -
PostComment!
|
Post comment of NFT |
Example
{
"collector": ReleaseCollector,
"comment": Comment,
"id": 4,
"nft": Nft,
"normalizedSongSlot": 987,
"postComment": PostComment
}
CollectorSearchFilter
CollectorSortInput
Description
Defines sort order of Collector fields, array index defines tiebreaking
Fields
| Input Field | Description |
|---|---|
field -
SearchCollectorsSortEnum!
|
Field to be sorted |
order -
SortOrder!
|
Sort ascending or descending |
Example
{"field": "ARTISTS_BACKED", "order": "ASC"}
CollectorUpdateInfo
Description
Information of collector from release
Fields
| Field Name | Description |
|---|---|
gaNftsCount -
Int!
|
Amount of ga release nfts owned |
goldenEggSerialNumber -
Int
|
If collector owns golden egg, the serial number of the golden egg |
id -
ID!
|
Unique identifier of collector from release |
lowestNftSerialNumber -
Int!
|
Lowest serial number collected on release |
mostRecentCommentMessage -
String
|
Most recent comment message, if any |
nftsCount -
Int!
|
Amount of NFTs collected of release |
nftsCountGa -
Int!
|
Amount of GA NFTs collected of release |
nftsCountVip -
Int!
|
Amount of VIP NFTs collected of release |
userArtistId -
ID
|
If user is an artist, the artist unique identifier |
userArtistName -
String
|
If user is an artist, the artist name |
userArtistSoundHandle -
String
|
If user is an artist, the artist sound handle |
userAvatarUrl -
String
|
Avatar URL of collecotr |
userId -
ID!
|
Unique user identifier of collector |
userPublicAddress -
String!
|
Wallet public address of user |
userWebappUri -
String!
|
Webapp URI of collector |
username -
String!
|
Username of collector |
vipNftsCount -
Int!
|
Amount of vip release nfts owned |
Example
{
"gaNftsCount": 987,
"goldenEggSerialNumber": 987,
"id": 4,
"lowestNftSerialNumber": 123,
"mostRecentCommentMessage": "abc123",
"nftsCount": 987,
"nftsCountGa": 987,
"nftsCountVip": 123,
"userArtistId": 4,
"userArtistName": "xyz789",
"userArtistSoundHandle": "abc123",
"userAvatarUrl": "xyz789",
"userId": 4,
"userPublicAddress": "abc123",
"userWebappUri": "abc123",
"username": "abc123",
"vipNftsCount": 987
}
Comment
Description
Comment entity
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"message": "abc123",
"signature": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
CompleteMultipartUploadOutput
CompleteMultipartUploadRequest
Description
Mark the provided multi-part upload as complete
Fields
| Input Field | Description |
|---|---|
parts -
[CompletedMultipartUploadPart!]!
|
Ordered list of uploaded multi-part parts to associate with the final object |
uploadId -
String!
|
Upload ID to use for each upload part of the final object |
uploadKey -
String!
|
Upload key for the final upload object |
Example
{
"parts": [CompletedMultipartUploadPart],
"uploadId": "xyz789",
"uploadKey": "xyz789"
}
CompletedMultipartUploadPart
Contract
Description
Contract entity
Fields
| Field Name | Description |
|---|---|
contractAddress -
String!
|
Contract address |
contractType -
ContractType!
|
Type of contract |
createdAt -
DateTime!
|
Date of creation |
id -
ID!
|
Contract entity unique identifier |
owner -
User!
|
Contract owner |
ownerPublicAddress -
String!
|
Public address of contract owner |
updatedAt -
DateTime!
|
Date of last update |
Example
{
"contractAddress": "abc123",
"contractType": "ARTIST",
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"owner": User,
"ownerPublicAddress": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
ContractMethod
Description
Contract methods of transactions
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AFFILIATE__WITHDRAW"
ContractReleaseInput
ContractType
Description
Contract type on chain
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ARTIST"
CountryCode
Description
A string that cannot be passed as an empty value
Example
"US"
CreateArtistApplicationInput
Description
Input options for creating artist application
Fields
| Input Field | Description |
|---|---|
artistName -
String!
|
Artist name |
coverImage -
UploadedMedia!
|
Cover image |
email -
EmailAddress
|
Email address |
instagramHandle -
String
|
Instagram handle |
soundHandle -
String!
|
Sound handle |
spotifyUrl -
URL
|
Spotify URL |
twitterHandle -
String
|
Twitter handle |
Example
{
"artistName": "abc123",
"coverImage": UploadedMedia,
"email": "test@test.com",
"instagramHandle": "abc123",
"soundHandle": "abc123",
"spotifyUrl": "http://www.test.com/",
"twitterHandle": "abc123"
}
CreateDraftInput
Description
Input for createDraft mutation
Fields
| Input Field | Description |
|---|---|
releaseInfo -
ReleaseInfoUploadStepInput
|
Release info upload step inputs |
releaseType -
ReleaseType!
|
Draft release type |
title -
String!
|
Draft Title |
Example
{
"releaseInfo": ReleaseInfoUploadStepInput,
"releaseType": "ALBUM",
"title": "xyz789"
}
CreateGeneralPostInput
Description
Input for createGeneralPost mutation
Example
{
"channelId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"content": "abc123",
"lexicalContent": {}
}
CreateKeyClient
Description
Input for createKeyClient mutation
Fields
| Input Field | Description |
|---|---|
name -
NonEmptyString!
|
Human-readable name of Key Client to be created |
status -
KeyClientStatus!
|
Set the initial status of the specified Key Client |
Example
{"name": "string", "status": "ACTIVE"}
CreatePlaylistPostInput
Description
Input for createPlaylistPost mutation
Example
{
"channelId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"content": "xyz789",
"lexicalContent": {},
"shelfId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
CreatePostCommentInput
Description
Input for createPostComment mutation
Example
{
"content": "abc123",
"lexicalContent": {},
"postId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
CreateReleasePostInput
Description
Input for createReleasePost mutation
Example
{
"channelId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"content": "xyz789",
"lexicalContent": {},
"releaseId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
CreateReleasePostOnWaveformInput
Description
Input for createReleasePostOnWaveform mutation. Only for release collectors.
Fields
| Input Field | Description |
|---|---|
channelId -
UUID
|
Optional ID of the channel to post to |
content -
String
|
Content of the post |
lexicalContent -
JSON
|
Lexical content of the post |
releaseId -
UUID!
|
ID of the release to associate with the post |
songSlot -
NonNegativeInt!
|
Slot numbered 0 to 99 for pinning a post to the release waveform. |
Example
{
"channelId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"content": "abc123",
"lexicalContent": {},
"releaseId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"songSlot": 123
}
CreatedPlaylistPost
Description
Playlist Post created action entity
Example
{
"date": "2007-12-03T10:15:30Z",
"id": 4,
"playlist": Shelf,
"post": Post,
"user": User
}
CreatedPost
CreditAllocation
Description
Credit allocation entity
Fields
| Field Name | Description |
|---|---|
creditSplit -
CreditSplit!
|
Credit split associated with credit allocation |
id -
ID!
|
Credit allocation entity identifier |
owner -
User!
|
Owner of credit allocation |
percent -
Float!
|
Percent of allocation |
roles -
[String!]!
|
Roles associated with credit allocation |
Example
{
"creditSplit": CreditSplit,
"id": 4,
"owner": User,
"percent": 123.45,
"roles": ["abc123"]
}
CreditAllocationUploadStepInfo
Description
Credit allocation upload step info
Fields
| Field Name | Description |
|---|---|
owner -
User!
|
Owner of allocation |
ownerAddress -
String!
|
Owner public address of allocation |
percent -
Float!
|
Percent of allocation |
roles -
[CreditRoleType!]!
|
Roles associated with credit allocation |
Example
{
"owner": User,
"ownerAddress": "abc123",
"percent": 123.45,
"roles": ["ARTIST"]
}
CreditRoleType
Description
Credit role type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ARTIST"
CreditSplit
Description
Credit split entity
Fields
| Field Name | Description |
|---|---|
creditAllocations -
[CreditAllocation!]!
|
Credit allocation of credit split |
id -
ID!
|
Credit split identifier |
mintedReleases -
[Release!]!
|
Releases associated with credit split that are minted |
releases -
[Release!]!
|
Releases associated with credit split |
splitAddress -
String
|
Split contract address |
Example
{
"creditAllocations": [CreditAllocation],
"id": "4",
"mintedReleases": [Release],
"releases": [Release],
"splitAddress": "xyz789"
}
Currencies
Description
Currencies conversions
Fields
| Field Name | Description |
|---|---|
ethToUsd -
Float!
|
Example
{"ethToUsd": 987.65}
CurrentUserChannelJoinStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"JOINED"
CurrentUserPostRepostStatusType
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"NOT_REPOSTED"
CurrentUserPostVoteStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"NO_VOTE"
CursorConnectionArgs
Description
Base cursor connection arguments
Fields
| Input Field | Description |
|---|---|
after -
String
|
Start forwards pagination since "after" cursor |
before -
String
|
Start backwards pagination since "before" cursor |
first -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "after", with a maximum of 51 nodes. |
last -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "before", with a maximum of 51 nodes. |
sort -
SortOrder!
|
Sort the connection ascending or descending |
Example
{
"after": "abc123",
"before": "abc123",
"first": 123,
"last": 123,
"sort": "ASC"
}
CustomerIoAPICallError
Description
Internal Customer.io API call error
Fields
| Field Name | Description |
|---|---|
message -
String!
|
Descriptive message of error |
Example
{"message": "abc123"}
DateTime
Description
A date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.
Example
"2007-12-03T10:15:30Z"
DeleteAllUsersFromDraftAllowlistInput
Description
Input for deleteAllUsersFromDraftAllowlist mutation
Fields
| Input Field | Description |
|---|---|
draftId -
UUID!
|
Draft identifier |
mintType -
MintingAccessConfigMintingType!
|
Draft allowlist mint type |
Example
{
"draftId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"mintType": "FREE"
}
DeleteArtistInput
Description
Input of "deleteArtist" mutation
Fields
| Input Field | Description |
|---|---|
publicAddress -
Address!
|
Wallet public address of the artist |
Example
{"publicAddress": Address}
DeleteReleaseInput
Description
Input of "deleteReleaase" mutation
Fields
| Input Field | Description |
|---|---|
releaseId -
UUID!
|
ID of the release to remove |
Example
{
"releaseId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
DeleteShelfInput
Description
Input fields to delete shelf
Fields
| Input Field | Description |
|---|---|
shelfId -
UUID!
|
Shelf id to delete |
Example
{
"shelfId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
DeleteUsersFromDraftAllowlistInput
Description
Input for deleteUsersFromDraftAllowlist mutation
Fields
| Input Field | Description |
|---|---|
addresses -
[Address!]!
|
Public addresses to be deleted |
draftId -
UUID!
|
Draft identifier |
mintType -
MintingAccessConfigMintingType!
|
Draft allowlist mint type |
Example
{
"addresses": [Address],
"draftId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"mintType": "FREE"
}
DevicePlatformInfoInput
Description
Update info about a given device
Example
{
"appBuild": 987,
"appVersion": "xyz789",
"deviceType": "xyz789",
"platform": "abc123",
"timezone": "xyz789"
}
DidNotGoThroughError
Description
Returned when an operation could not go through for unspecified reasons
Fields
| Field Name | Description |
|---|---|
message -
String!
|
Descriptive message of error |
Example
{"message": "abc123"}
Draft
Description
Draft entity
Fields
| Field Name | Description |
|---|---|
artist -
Artist!
|
Artist of draft |
contractAddressSalt -
String!
|
Salt for contract address |
createdAt -
DateTime!
|
Draft creation date |
edit -
DraftEdit
|
Post deployment edits |
id -
ID!
|
Draft identifier |
info -
DraftInfo
|
Draft info |
release -
Release
|
Release associated with draft |
slug -
String!
|
Draft slug to be used for release entity |
type -
ReleaseType!
|
Type of Release |
updatedAt -
DateTime!
|
Draft updated date |
Example
{
"artist": Artist,
"contractAddressSalt": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"edit": DraftEdit,
"id": 4,
"info": DraftInfo,
"release": Release,
"slug": "abc123",
"type": "ALBUM",
"updatedAt": "2007-12-03T10:15:30Z"
}
DraftAllowList
Description
DraftAllowlist entity
Fields
| Field Name | Description |
|---|---|
createdAt -
DateTime!
|
DraftAllowlist creation date |
id -
ID!
|
DraftAllowlist identifier |
info -
DraftAllowlistInfo!
|
DraftAllowlist info |
Arguments
|
|
totalUsers -
Int!
|
Total number of users in draft allowlist |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"id": 4,
"info": ArtistCollectorsAllowlist,
"totalUsers": 123
}
DraftAllowListInfo
Description
Draft allowlist info
Fields
| Field Name | Description |
|---|---|
collectorsOfArtists -
DraftCollectorsOfArtistsInfo
|
Collectors of artists allowlist configuration |
collectorsOfReleases -
DraftCollectorsOfReleasesInfo
|
Collectors of releases allowlist configuration |
manuallyAddedAllowlist -
DraftManuallyAddedAllowlistInfo
|
Info for manually added draft allow list |
Example
{
"collectorsOfArtists": DraftCollectorsOfArtistsInfo,
"collectorsOfReleases": DraftCollectorsOfReleasesInfo,
"manuallyAddedAllowlist": DraftManuallyAddedAllowlistInfo
}
DraftAllowListInput
Description
Draft allow list inputs
Fields
| Input Field | Description |
|---|---|
collectorsOfArtists -
DraftCollectorsOfArtistsInput
|
Draft collectors of artists |
collectorsOfReleases -
DraftCollectorsOfReleasesInput
|
Draft collectors of releases |
manuallyAddedAllowlist -
DraftManuallyAddedAllowlistInput
|
Draft manually added allowlist releases |
Example
{
"collectorsOfArtists": DraftCollectorsOfArtistsInput,
"collectorsOfReleases": DraftCollectorsOfReleasesInput,
"manuallyAddedAllowlist": DraftManuallyAddedAllowlistInput
}
DraftAllowListsInfo
Description
Draft allow lists info
Fields
| Field Name | Description |
|---|---|
presaleMint -
DraftAllowListInfo
|
Presale mint allowlist configurations |
Example
{"presaleMint": DraftAllowListInfo}
DraftAllowListsInput
Description
Draft allowlists configurations
Fields
| Input Field | Description |
|---|---|
presaleMint -
DraftAllowListInput
|
Presale mint draft allowlist configuration |
Example
{"presaleMint": DraftAllowListInput}
DraftAllowlistFromDraftInput
Description
Input for draftAllowListFromDraft query
Fields
| Input Field | Description |
|---|---|
draftId -
UUID!
|
Draft identifier |
mintType -
MintingAccessConfigMintingType!
|
Draft allowlist mint type |
Example
{
"draftId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"mintType": "FREE"
}
DraftAllowlistFromReleaseInput
DraftAllowlistInfo
Description
Union of draft allowlist infos
Example
ArtistCollectorsAllowlist
DraftAllowlistInput
Description
Input for draftAllowlistInput query
Fields
| Input Field | Description |
|---|---|
allowlistType -
AllowlistType!
|
Allowlist type |
draftId -
String!
|
Draft identifier |
mintType -
MintingAccessConfigMintingType!
|
Draft allowlist mint type |
Example
{
"allowlistType": "ARTIST_COLLECTORS",
"draftId": "xyz789",
"mintType": "FREE"
}
DraftAllowlistType
Description
Different draft allow list types
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ARTIST_COLLECTORS"
DraftAuctionConfigurationInfo
Description
Draft auction configuration step info
Example
{
"endTime": 987,
"maxMintsPerWallet": 123,
"price": 123.45,
"quantity": 123,
"startTime": 987
}
DraftAuctionConfigurationsInfo
Description
Release info upload step info
Fields
| Field Name | Description |
|---|---|
auctionType -
AuctionType!
|
Type of auction |
enabledSAM -
Boolean
|
Toggle to enable SAM for auction |
maxMintable -
Int!
|
Max mint supply of auction |
minQuantity -
Int!
|
Min mint supply of auction |
presaleMint -
DraftAuctionConfigurationInfo
|
Presale mint auction configurations |
publicMint -
DraftPublicSaleAuctionConfigurationInfo!
|
Public mint auction configurations |
quantityBreakdown -
[Int!]
|
Breakdown of mint quantities |
Example
{
"auctionType": "FIXED_QUANTITY",
"enabledSAM": true,
"maxMintable": 123,
"minQuantity": 123,
"presaleMint": DraftAuctionConfigurationInfo,
"publicMint": DraftPublicSaleAuctionConfigurationInfo,
"quantityBreakdown": [987]
}
DraftCollectorsOfArtistsInfo
Description
Draft collectors of artists info
Fields
| Field Name | Description |
|---|---|
allArtistCollectors -
Boolean!
|
Toggle to include or not include all artist releases |
allCollaboratingArtists -
Boolean!
|
Toggle to include or not include all the collectors of all artists that given artist collaborated with |
selectedArtists -
[ArtistInfo!]!
|
Selected artist entities for allowlist artist collectors |
Example
{
"allArtistCollectors": true,
"allCollaboratingArtists": true,
"selectedArtists": [ArtistInfo]
}
DraftCollectorsOfArtistsInput
Description
Draft collectors of artists inputs
Fields
| Input Field | Description |
|---|---|
allArtistCollectors -
Boolean!
|
Toggle to include or not include all artist collectors |
allCollaboratingArtists -
Boolean!
|
Toggle to include or not include all the collectors of all artists that given artist collaborated with |
selectedArtistIds -
[UUID!]!
|
Select artist identifiers |
Example
{
"allArtistCollectors": false,
"allCollaboratingArtists": true,
"selectedArtistIds": [
"6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
]
}
DraftCollectorsOfReleasesInfo
Description
Draft collectors of releases info
Fields
| Field Name | Description |
|---|---|
allArtistCollaborations -
Boolean!
|
Toggle to include or not include all artist collaborations |
allArtistReleases -
Boolean!
|
Toggle to include or not include all artist releases |
selectedReleases -
[ReleaseInfo!]!
|
Selected release entities for allowlist release collectors |
Example
{
"allArtistCollaborations": false,
"allArtistReleases": false,
"selectedReleases": [ReleaseInfo]
}
DraftCollectorsOfReleasesInput
Description
Draft collectors of releases inputs
Example
{
"allArtistCollaborations": false,
"allArtistReleases": true,
"selectedReleaseIds": [
"6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
]
}
DraftConnection
Description
Paginated releases connection
Fields
| Field Name | Description |
|---|---|
edges -
[DraftConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [DraftConnectionEdge],
"pageInfo": PageInfo
}
DraftConnectionEdge
DraftCursorConnectionArgs
Description
Cursor connection parameters
Fields
| Input Field | Description |
|---|---|
after -
String
|
Start forwards pagination since "after" cursor |
before -
String
|
Start backwards pagination since "before" cursor |
first -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "after", with a maximum of 51 nodes. |
last -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "before", with a maximum of 51 nodes. |
sort -
DraftCursorConnectionSort!
|
Sort the users ascending or descending relative to the user creation date |
Example
{
"after": "abc123",
"before": "abc123",
"first": 123,
"last": 123,
"sort": DraftCursorConnectionSort
}
DraftCursorConnectionSort
Description
Customize the sort behavior of drafts pagination
Fields
| Input Field | Description |
|---|---|
createdAt -
SortOrder
|
Sort by date of draft creation |
Example
{"createdAt": "ASC"}
DraftEdit
Description
Draft post deployment edits
Fields
| Field Name | Description |
|---|---|
createdAt -
DateTime!
|
Draft creation date |
id -
ID!
|
Node identifier |
info -
DraftEditInfo
|
Draft Edit info |
updatedAt -
DateTime!
|
Draft updated date |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"id": 4,
"info": DraftEditInfo,
"updatedAt": "2007-12-03T10:15:30Z"
}
DraftEditAllowListInfo
Description
Draft edit allowlist info
Fields
| Field Name | Description |
|---|---|
collectorsOfArtists -
DraftEditCollectorsOfArtistsInfo
|
Collectors of artists allowlist configuration |
collectorsOfReleases -
DraftEditCollectorsOfReleasesInfo
|
Collectors of releases allowlist configuration |
manuallyAddedAllowlist -
DraftEditManuallyAddedAllowlistInfo
|
Info for manually added draft allow list |
merkleRoot -
String
|
Merkle root of edited allowlist |
unhashedLeaves -
[String!]
|
Unhashed leaves of allowlist merkle tree |
Example
{
"collectorsOfArtists": DraftEditCollectorsOfArtistsInfo,
"collectorsOfReleases": DraftEditCollectorsOfReleasesInfo,
"manuallyAddedAllowlist": DraftEditManuallyAddedAllowlistInfo,
"merkleRoot": "abc123",
"unhashedLeaves": ["abc123"]
}
DraftEditAllowListsInfo
Description
Draft Edit allow lists info
Fields
| Field Name | Description |
|---|---|
presaleMint -
DraftEditAllowListInfo
|
Presale mint allowlist configurations |
Example
{"presaleMint": DraftEditAllowListInfo}
DraftEditCollectorsOfArtistsInfo
Description
Draft Edit for allowlist in collectors of artists section
Fields
| Field Name | Description |
|---|---|
allArtistCollectors -
Boolean!
|
Toggle to include or not include all artist releases |
allCollaboratingArtists -
Boolean!
|
Toggle to include or not include all the collectors of all artists that given artist collaborated with |
selectedArtists -
[ArtistInfo!]!
|
Selected artist entities for allowlist artist collectors |
Example
{
"allArtistCollectors": false,
"allCollaboratingArtists": false,
"selectedArtists": [ArtistInfo]
}
DraftEditCollectorsOfReleasesInfo
Description
Draft edit for allowlist in collectors of releases section
Fields
| Field Name | Description |
|---|---|
allArtistCollaborations -
Boolean!
|
Toggle to include or not include all artist collaborations |
allArtistReleases -
Boolean!
|
Toggle to include or not include all artist releases |
selectedReleases -
[ReleaseInfo!]!
|
Selected release entities for allowlist release collectors |
Example
{
"allArtistCollaborations": false,
"allArtistReleases": false,
"selectedReleases": [ReleaseInfo]
}
DraftEditInfo
Description
Draft Edit info
Fields
| Field Name | Description |
|---|---|
allowlistInfo -
DraftEditAllowListsInfo
|
Draft possibly edited allowlist info |
arweaveHash -
String
|
Draft arweave hash associated with changes if needed |
gaArweaveHash -
String
|
Draft GA arweave hash associated with changes if needed |
releaseInfo -
DraftEditReleaseInfo
|
Draft possibly edited release info |
rewardsInfo -
RewardsEditStepInfo
|
Draft possibly edited rewards info |
splitsInfo -
SplitsUploadStepInfo
|
Draft possibly edited splits info |
storefrontArweaveHash -
String
|
Draft storefront arweave hash associated with changes if needed |
Example
{
"allowlistInfo": DraftEditAllowListsInfo,
"arweaveHash": "abc123",
"gaArweaveHash": "abc123",
"releaseInfo": DraftEditReleaseInfo,
"rewardsInfo": RewardsEditStepInfo,
"splitsInfo": SplitsUploadStepInfo,
"storefrontArweaveHash": "xyz789"
}
DraftEditManuallyAddedAllowlistInfo
Description
Draft Edit of allowlist in manually added allowlist section
Fields
| Field Name | Description |
|---|---|
description -
String
|
Description for draft manually added allowlist |
list -
[String!]!
|
List of manually allowlisted addresses |
Example
{
"description": "xyz789",
"list": ["abc123"]
}
DraftEditReleaseInfo
Description
Draft edit release info
Fields
| Field Name | Description |
|---|---|
beatsPerMinute -
Int
|
Release beats per minute |
behindTheMusic -
String
|
Behind the music text |
coverImage -
MediaUploadStepInfo
|
Cover image |
gaCoverImage -
MediaUploadStepInfo
|
GA Cover image |
gaStaticCoverImage -
MediaUploadStepInfo
|
Static version of animated GA cover image of release if the cover is a GIF |
genre -
String
|
Genre |
key -
SongKeyType
|
Release key |
license -
LicenseType
|
License for the release |
location -
CountryCode
|
Location where the release was created |
lyrics -
String
|
Release lyrics |
staticCoverImage -
MediaUploadStepInfo
|
Static version of animated cover image of release if the cover is a GIF |
title -
String
|
Title |
tokenSymbol -
String
|
Token symbol |
tracks -
[TrackUploadStepInfo!]
|
Uploaded tracks |
type -
String
|
Release type |
Example
{
"beatsPerMinute": 987,
"behindTheMusic": "abc123",
"coverImage": MediaUploadStepInfo,
"gaCoverImage": MediaUploadStepInfo,
"gaStaticCoverImage": MediaUploadStepInfo,
"genre": "xyz789",
"key": "A_FLAT_MAJOR",
"license": "ALL_RIGHTS_RESERVED",
"location": "US",
"lyrics": "xyz789",
"staticCoverImage": MediaUploadStepInfo,
"title": "abc123",
"tokenSymbol": "abc123",
"tracks": [TrackUploadStepInfo],
"type": "xyz789"
}
DraftInfo
Description
Draft info
Fields
| Field Name | Description |
|---|---|
allowListInfo -
DraftAllowListsInfo
|
Draft allowlist info |
auctionConfigurations -
DraftAuctionConfigurationsInfo
|
Draft auction configurations info |
numUploadStepsComplete -
Int!
|
Number of draft upload steps already complete |
releaseInfo -
DraftReleaseInfo
|
Draft release info |
rewardsInfo -
RewardsUploadStepInfo
|
Draft rewards info |
splitsInfo -
SplitsUploadStepInfo
|
Draft splits info |
Example
{
"allowListInfo": DraftAllowListsInfo,
"auctionConfigurations": DraftAuctionConfigurationsInfo,
"numUploadStepsComplete": 987,
"releaseInfo": DraftReleaseInfo,
"rewardsInfo": RewardsUploadStepInfo,
"splitsInfo": SplitsUploadStepInfo
}
DraftInfoInput
Description
Different upload steps for a release
Fields
| Input Field | Description |
|---|---|
allowListsInfo -
DraftAllowListsInput
|
Allowlists inputs |
auctionConfigurations -
AuctionConfigurationsInput
|
Auction configuration inputs |
releaseInfo -
ReleaseInfoUploadStepInput
|
Release info upload step inputs |
rewardsInfo -
RewardsUploadStepInput
|
Rewards upload step inputs |
splitsInfo -
SplitsUploadStepInput
|
Credit allocations of credit split |
Example
{
"allowListsInfo": DraftAllowListsInput,
"auctionConfigurations": AuctionConfigurationsInput,
"releaseInfo": ReleaseInfoUploadStepInput,
"rewardsInfo": RewardsUploadStepInput,
"splitsInfo": SplitsUploadStepInput
}
DraftManuallyAddedAllowlistInfo
Description
Draft manually added allowlist info
Fields
| Field Name | Description |
|---|---|
description -
String
|
Description for draft manually added allowlist |
Example
{"description": "abc123"}
DraftManuallyAddedAllowlistInput
Description
Draft manually added allowlist inputs
Fields
| Input Field | Description |
|---|---|
description -
String
|
Draft manually added allowlist description |
Example
{"description": "xyz789"}
DraftMetadataUploadInput
Description
Input for draftMetadataUpload mutation
Fields
| Input Field | Description |
|---|---|
draftId -
UUID!
|
Draft identifier |
Example
{
"draftId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
DraftPublicSaleAuctionConfigurationInfo
Description
Draft public sale auction configuration step info
Example
{
"endTime": 987,
"endTimeDays": 987,
"maxMintsPerWallet": 123,
"price": 987.65,
"quantity": 987,
"startTime": 123
}
DraftReleaseInfo
Description
Draft release info
Fields
| Field Name | Description |
|---|---|
beatsPerMinute -
Int
|
Release beats per minute |
behindTheMusic -
String!
|
Behind the music text |
coverImage -
MediaUploadStepInfo!
|
Cover image |
gaCoverImage -
MediaUploadStepInfo
|
GA Cover image |
gaStaticCoverImage -
MediaUploadStepInfo
|
Static version of animated GA cover image of release if the cover is a GIF |
genre -
String!
|
Genre |
goldenEggImage -
MediaUploadStepInfo
|
Special golden image |
key -
SongKeyType
|
Release key |
license -
LicenseType
|
License for the release |
location -
CountryCode
|
Location where the release was created |
lyrics -
String
|
Release lyrics |
spotifyPresaveCampaign -
Boolean
|
Spotify presave campaign |
spotifyTrackId -
String
|
Spotify album uri |
staticCoverImage -
MediaUploadStepInfo
|
Static version of animated cover image of release if the cover is a GIF |
title -
String!
|
Title |
tokenSymbol -
String!
|
Token symbol |
tracks -
[TrackUploadStepInfo!]!
|
Uploaded tracks |
type -
String!
|
Release type |
Example
{
"beatsPerMinute": 987,
"behindTheMusic": "xyz789",
"coverImage": MediaUploadStepInfo,
"gaCoverImage": MediaUploadStepInfo,
"gaStaticCoverImage": MediaUploadStepInfo,
"genre": "xyz789",
"goldenEggImage": MediaUploadStepInfo,
"key": "A_FLAT_MAJOR",
"license": "ALL_RIGHTS_RESERVED",
"location": "US",
"lyrics": "xyz789",
"spotifyPresaveCampaign": false,
"spotifyTrackId": "abc123",
"staticCoverImage": MediaUploadStepInfo,
"title": "abc123",
"tokenSymbol": "abc123",
"tracks": [TrackUploadStepInfo],
"type": "abc123"
}
DuplicatedError
Description
Given paramater already exists and can't be duplicated
Fields
| Field Name | Description |
|---|---|
message -
String!
|
Descriptive message of error |
Example
{"message": "xyz789"}
ENS
Description
Ethereum name service value with .eth suffix
Example
ENS
EditReleaseAsyncOutput
EditReleaseAsyncResult
Description
Output result from processing or completed edited release
Fields
| Field Name | Description |
|---|---|
arweave -
ArweaveEditOutput
|
Arweave upload from edit release request |
mainPresaleMerkleTreeRoot -
String
|
Main presale merkle tree root |
Example
{
"arweave": ArweaveEditOutput,
"mainPresaleMerkleTreeRoot": "abc123"
}
EditReleaseAsyncStatusPending
EditReleaseAsyncStatusProcessing
Description
Success status for async edit release
Fields
| Field Name | Description |
|---|---|
editReleaseAsyncRequestId -
String!
|
Async request ID for tracking |
outputs -
EditReleaseAsyncResult!
|
Outputs associated with edit release request |
processingCount -
Int!
|
How many processes are pending to be completed |
release -
Release!
|
Release entity |
Example
{
"editReleaseAsyncRequestId": "abc123",
"outputs": EditReleaseAsyncResult,
"processingCount": 123,
"release": Release
}
EditReleaseAsyncStatusResult
Description
Status of edit release async request
Example
EditReleaseAsyncStatusPending
EditReleaseAsyncStatusSuccess
Description
Success status for async edit release
Fields
| Field Name | Description |
|---|---|
editReleaseAsyncRequestId -
String!
|
Async request ID for tracking |
outputs -
EditReleaseAsyncResult!
|
Outputs associated with edit release request |
release -
Release!
|
Release entity |
Example
{
"editReleaseAsyncRequestId": "abc123",
"outputs": EditReleaseAsyncResult,
"release": Release
}
EditReleaseInput
EditedReleaseResult
EditionContractEarning
Description
Edition contract earnings
Example
{
"balanceForUser": "xyz789",
"contractAddress": "xyz789",
"totalBalance": "xyz789"
}
EditionOwnedTokenIdsFilter
Description
Filter the edition owned tokenIds result
Fields
| Input Field | Description |
|---|---|
includeGoldenEgg -
Boolean!
|
Should it include golden egg |
Example
{"includeGoldenEgg": true}
EditionOwnedTokenIdsInput
Description
Input for editionOwnedTokenIds query
Fields
| Input Field | Description |
|---|---|
editionContractAddress -
Address!
|
Edition contract address |
filter -
EditionOwnedTokenIdsFilter!
|
Filter the tokenIds |
limit -
PositiveInt
|
Limit the amount of token ids to be returned. By default there is no limit |
ownerPublicAddress -
Address!
|
Public address of owner |
sort -
NftCursorConnectionSort!
|
Customize sort behavior |
Example
{
"editionContractAddress": Address,
"filter": EditionOwnedTokenIdsFilter,
"limit": 123,
"ownerPublicAddress": Address,
"sort": NftCursorConnectionSort
}
EggGame
Description
EggGame Entity
Fields
| Field Name | Description |
|---|---|
animatedGoldenEggImageOptimized -
Media
|
Animated golden egg image optimized for client rendering |
finalSerialBlockHash -
String!
|
Block hash of egg game calculation |
goldenEggImage -
Media
|
Special golden egg image |
id -
ID!
|
EggGame identifier |
nft -
Nft!
|
Nft of egg game winner |
Example
{
"animatedGoldenEggImageOptimized": Media,
"finalSerialBlockHash": "xyz789",
"goldenEggImage": Media,
"id": 4,
"nft": Nft
}
EmailAddress
Description
A field whose value conforms to the standard internet email address format as specified in RFC822: https://www.w3.org/Protocols/rfc822/.
Example
"test@test.com"
EmailVerificationStatus
Description
Notification email verification status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"EXPIRED"
EmptyMerkleTreeError
Description
No public addresses for merkle tree creation attempt
Fields
| Field Name | Description |
|---|---|
message -
String!
|
Descriptive message of error |
Example
{"message": "abc123"}
ExceedsMaxAllowlistError
Description
Maximum allowlist size exceeded
Fields
| Field Name | Description |
|---|---|
message -
String!
|
Descriptive message of error |
Example
{"message": "xyz789"}
ExtendShelfInput
Description
Input for extendShelf mutation
Example
{
"sourceShelfId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"targetShelfId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
FeatureFlag
Description
Feature flag entity to describe flagged functionality
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"name": "abc123",
"updatedAt": "2007-12-03T10:15:30Z",
"value": "abc123"
}
FilterKeyClients
Description
Filter Key Clients pagination
Fields
| Input Field | Description |
|---|---|
status -
[KeyClientStatus!]
|
Example
{"status": ["ACTIVE"]}
FixedAuction
Description
Auction options associated with fixed sales
Fields
| Field Name | Description |
|---|---|
maxPresaleMaxMintsPerWallet -
Int!
|
Maximum presale max mints per wallet |
maxPrice -
Float!
|
Maximum price for sale |
maxPublicSaleMaxMintsPerWallet -
Int!
|
Maximum public sale max mints per wallet |
maxQuantity -
Int!
|
Maximum quantity for sale |
minPresaleMaxMintsPerWallet -
Int!
|
Minimum presale max mints per wallet |
minPrice -
Float!
|
Minimum price for sale |
minPublicSaleMaxMintsPerWallet -
Int!
|
Minimum public sale max mints per wallet |
minQuantity -
Int!
|
Minimum quantity for sale |
mintingStartsInDays -
[Int!]!
|
List of different days for public sale to start in |
presaleMaxMintsPerWalletOptions -
[Int!]!
|
List of different max mints per wallet quantity options for presale |
presaleMaxPrice -
Float!
|
Maximum price for presale |
presaleMinPrice -
Float!
|
Minimum price for presale |
priceOptions -
[Float!]!
|
List of different eth prices options for public sale |
publicSaleMaxMintsPerWalletOptions -
[Int!]!
|
List of different max mints per wallet quantity options for public sale |
quantityOptions -
[Int!]!
|
List of different quantity options for public sale |
Example
{
"maxPresaleMaxMintsPerWallet": 987,
"maxPrice": 123.45,
"maxPublicSaleMaxMintsPerWallet": 123,
"maxQuantity": 987,
"minPresaleMaxMintsPerWallet": 123,
"minPrice": 123.45,
"minPublicSaleMaxMintsPerWallet": 987,
"minQuantity": 987,
"mintingStartsInDays": [123],
"presaleMaxMintsPerWalletOptions": [123],
"presaleMaxPrice": 123.45,
"presaleMinPrice": 123.45,
"priceOptions": [987.65],
"publicSaleMaxMintsPerWalletOptions": [123],
"quantityOptions": [987]
}
FixedAuctionInput
Description
Input options to customize fixed auctions
Fields
| Input Field | Description |
|---|---|
freeSaleMaxMintsPerWalletOptions -
[Int!]!
|
List of different max mints per wallet quantity options for free sale |
maxPresaleMaxMintsPerWallet -
Int!
|
Maximum presale max mints per wallet |
maxPrice -
Float
|
Maximum price for sale |
maxPublicSaleMaxMintsPerWallet -
Int!
|
Maximum public sale max mints per wallet |
maxQuantity -
Int
|
Maximum quantity option for public sale |
minPresaleMaxMintsPerWallet -
Int!
|
Minimum presale max mints per wallet |
minPrice -
Float
|
Minimum price for sale |
minPublicSaleMaxMintsPerWallet -
Int!
|
Minimum public sale max mints per wallet |
minQuantity -
Int
|
Minimum quantity option for public sale |
mintingStartsInDays -
[Int!]
|
List of different days for public sale to start in |
presaleMaxMintsPerWalletOptions -
[Int!]!
|
List of different max mints per wallet quantity options for presale |
presaleMaxPrice -
Float
|
Maximum price for presale |
presaleMinPrice -
Float
|
Minimum price for presale |
priceOptions -
[Float!]
|
List of different eth prices options for public sale |
publicSaleMaxMintsPerWalletOptions -
[Int!]!
|
List of different max mints per wallet quantity options for public sale |
quantityOptions -
[Int!]!
|
List of different quantity options for public sale |
Example
{
"freeSaleMaxMintsPerWalletOptions": [123],
"maxPresaleMaxMintsPerWallet": 123,
"maxPrice": 123.45,
"maxPublicSaleMaxMintsPerWallet": 987,
"maxQuantity": 987,
"minPresaleMaxMintsPerWallet": 123,
"minPrice": 123.45,
"minPublicSaleMaxMintsPerWallet": 987,
"minQuantity": 123,
"mintingStartsInDays": [987],
"presaleMaxMintsPerWalletOptions": [987],
"presaleMaxPrice": 987.65,
"presaleMinPrice": 987.65,
"priceOptions": [987.65],
"publicSaleMaxMintsPerWalletOptions": [987],
"quantityOptions": [987]
}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by
IEEE 754.
Example
123.45
FollowUserInput
Description
Input fields to follow user
Fields
| Input Field | Description |
|---|---|
user -
UUID!
|
User id to follow |
Example
{
"user": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
ForbiddenError
Description
Arbitrary forbidden error
Fields
| Field Name | Description |
|---|---|
message -
String!
|
Example
{"message": "xyz789"}
GelatoAPIError
GeneralPost
Description
GeneralPost entity
Fields
| Field Name | Description |
|---|---|
authorChannelRole -
ChannelCuratorRole
|
Channel role of the author (null if they are not a curator) |
channel -
Channel
|
Channel that the post was posted to |
commentCount -
Int!
|
Number of comments on the post |
comments -
PostCommentConnection!
|
Comments on the post |
Arguments
|
|
content -
String!
|
Content of the post |
createdAt -
DateTime!
|
Creation date of entity |
creator -
User!
|
User who created the post |
farcasterHash -
String
|
Farcaster hash of the post |
id -
ID!
|
Unique identifier of the Post |
lexicalContent -
JSON
|
Lexical content of the post |
repostCount -
Int!
|
Number of reposts on the post |
upvoteCount -
Int!
|
Number of upvotes on the post |
webappUri -
String!
|
Webapp URI of Post |
Example
{
"authorChannelRole": "MODERATOR",
"channel": Channel,
"commentCount": 987,
"comments": PostCommentConnection,
"content": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"creator": User,
"farcasterHash": "xyz789",
"id": "4",
"lexicalContent": {},
"repostCount": 987,
"upvoteCount": 987,
"webappUri": "abc123"
}
Genre
Description
Genre entity
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"name": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
Genres
Description
List of genres available on the platform
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"AFROBEAT"
GeoLocationInput
GeoLocationPlaceGoogle
GoldenEggWon
Description
User won the golden egg for a release
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
UserNotification UUID |
release -
Release
|
Release entity |
timestamp -
Timestamp!
|
Timestamp for notification |
user -
User
|
Recipient user entity |
Example
{
"id": 4,
"release": Release,
"timestamp": 1592577642,
"user": User
}
GoogleAPICallError
Description
Internal Google API call error
Fields
| Field Name | Description |
|---|---|
message -
String!
|
Descriptive message of error |
Example
{"message": "xyz789"}
HidePostsFromTrendingOption
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"Hide"
HidePostsFromTrendingStatusInput
Description
Input for setHidePostsFromTrendingStatus mutation
Fields
| Input Field | Description |
|---|---|
option -
HidePostsFromTrendingOption!
|
Trending posts supression status |
publicAddress -
Address!
|
Public address of user |
Example
{"option": "Hide", "publicAddress": Address}
HighlightedReleasesCustomization
Description
Highlighted releases customization parameters
Example
{
"lastUpdatedAt": "2007-12-03T10:15:30Z",
"pinnedReleases": {},
"viralChartsWeights": {},
"weights": {}
}
HomeFeedCursorConnectionArgs
Description
Arguments for home feed cursor connection
Fields
| Input Field | Description |
|---|---|
after -
String
|
|
before -
String
|
|
first -
NonNegativeInt
|
|
last -
NonNegativeInt
|
Example
{
"after": "abc123",
"before": "abc123",
"first": 123,
"last": 123
}
HomeFeedItem
Description
Home feed item
Fields
| Field Name | Description |
|---|---|
feedItem -
HomeFeedUnion!
|
|
id -
ID!
|
Example
{
"feedItem": HomeFeedPost,
"id": "4"
}
HomeFeedPost
Description
Home feed post
Fields
| Field Name | Description |
|---|---|
post -
Post!
|
The post |
Example
{"post": Post}
HomeFeedPostConnection
Description
Home feed post connection
Fields
| Field Name | Description |
|---|---|
edges -
[HomeFeedPostConnectionEdge!]!
|
|
pageInfo -
PageInfo!
|
|
totalCount -
Int!
|
Example
{
"edges": [HomeFeedPostConnectionEdge],
"pageInfo": PageInfo,
"totalCount": 123
}
HomeFeedPostConnectionEdge
Description
Edge of Home Feed Post Connection
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Cursor to be used for pagination |
node -
HomeFeedItem!
|
HomeFeedPost node |
Example
{
"cursor": "abc123",
"node": HomeFeedItem
}
HomeFeedUnion
Description
Union of home feed objects
Types
| Union Types |
|---|
Example
HomeFeedPost
ID
Description
The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.
Example
"4"
IframeHtmlParameters
InstagramAPIError
Int
Description
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
987
IsChannelCuratorResult
Description
Result of boolean operation on channel
Fields
| Field Name | Description |
|---|---|
channelId -
String!
|
ID of the channel |
result -
Boolean!
|
Result of the operation |
role -
ChannelCuratorRole
|
Role of the curator (if the user is a curator) |
Example
{
"channelId": "xyz789",
"result": false,
"role": "MODERATOR"
}
IsFollowingInput
Description
Input field to check if auth user is following
Fields
| Input Field | Description |
|---|---|
user -
UUID!
|
User id to check if auth user is following |
Example
{
"user": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
IsLikedInput
Description
Input for isLiked query
Fields
| Input Field | Description |
|---|---|
id -
UUID!
|
Identifier to be checked |
Example
{
"id": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
JSON
Description
The JSON scalar type represents JSON values as specified by
ECMA-404.
Example
{}
JWT
Description
A field whose value is a JSON Web Token (JWT): https://jwt.io/introduction.
Example
"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwiaWF0IjoxNTE2MjM5MDIyLCJwcm9qZWN0IjoiZ3JhcGhxbC1zY2FsYXJzIn0.nYdrSfE2nNRAgpiEU1uKgn2AYYKLo28Z0nhPXvsuIww"
KeyClient
Description
Client key management entity
Fields
| Field Name | Description |
|---|---|
createdAt -
DateTime!
|
Date of creation |
id -
ID!
|
Unique identifier of client key |
key -
String!
|
Key associated to client for authentication process |
name -
String!
|
Human-readable identifier of key client |
status -
KeyClientStatus!
|
Status of Key Client |
updatedAt -
DateTime!
|
Date of last update |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"id": 4,
"key": "abc123",
"name": "xyz789",
"status": "ACTIVE",
"updatedAt": "2007-12-03T10:15:30Z"
}
KeyClientConnection
Description
Paginated connection of Key Clients
Fields
| Field Name | Description |
|---|---|
edges -
[KeyClientConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [KeyClientConnectionEdge],
"pageInfo": PageInfo
}
KeyClientConnectionEdge
Description
Edge of Key Client Connection
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Cursor to be used for pagination |
node -
KeyClient!
|
Key Client node |
Example
{
"cursor": "xyz789",
"node": KeyClient
}
KeyClientCursorConnectionArgs
Description
Cursor connection parameters
Fields
| Input Field | Description |
|---|---|
after -
String
|
Start forwards pagination since "after" cursor |
before -
String
|
Start backwards pagination since "before" cursor |
first -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "after", with a maximum of 51 nodes. |
last -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "before", with a maximum of 51 nodes. |
sort -
SortOrder!
|
Sort the key clients ascending or descending relative to the entity creation date |
Example
{
"after": "xyz789",
"before": "abc123",
"first": 123,
"last": 123,
"sort": "ASC"
}
KeyClientStatus
Description
Status of Key Client
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ACTIVE"
L2ChainType
Description
Chain name supported on the platform: L2 only
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BASE"
LicenseType
Description
License for the release
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ALL_RIGHTS_RESERVED"
LikeAction
LikeActionConnection
Description
Paginated like action connection
Fields
| Field Name | Description |
|---|---|
edges -
[LikeActionConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [LikeActionConnectionEdge],
"pageInfo": PageInfo
}
LikeActionConnectionEdge
Description
Edge of like action connection
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Cursor to be used for pagination |
node -
LikeAction!
|
Like action node |
Example
{
"cursor": "abc123",
"node": LikeAction
}
LikeReleaseInput
Description
Input for likeRelease mutation
Fields
| Input Field | Description |
|---|---|
releaseId -
UUID!
|
Release identifier to be liked |
Example
{
"releaseId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
LikeShelfInput
Description
Input for likeShelf mutation
Fields
| Input Field | Description |
|---|---|
shelfId -
UUID!
|
Shelf identifier to be liked |
Example
{
"shelfId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
LikeStatus
LinkInput
Description
Input used for link query
Fields
| Input Field | Description |
|---|---|
slug -
NonEmptyString!
|
Link slug |
Example
{"slug": "string"}
ManuallyAddedCollectorsAllowlist
Description
Info associated with manually added draft allowlist
Fields
| Field Name | Description |
|---|---|
description -
String
|
Description for manually added allowlist |
totalCollectors -
Int!
|
Total number of manually added users in draft allowlist |
users -
UserConnection!
|
Paginated manually added users of draftAllowlist |
Example
{
"description": "abc123",
"totalCollectors": 987,
"users": UserConnection
}
MaxValueError
Media
Description
Media entity
Example
{
"bucket": "xyz789",
"dominantColor": "abc123",
"id": "4",
"key": "xyz789",
"url": "abc123"
}
MediaType
Description
Type of media entity, either Images or Audio
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ARTIST_BANNER_IMAGE"
MediaUploadStepInfo
Description
Release info upload step info
Fields
| Field Name | Description |
|---|---|
mediaType -
MediaType!
|
Media type to be uploaded |
uploadKey -
String!
|
Upload key received from Query.signedUploadParams |
Example
{
"mediaType": "ARTIST_BANNER_IMAGE",
"uploadKey": "xyz789"
}
MentionedInPost
Description
User was mentioned in a post
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
UserNotification UUID |
mentionedBy -
User
|
User who made the mention |
post -
Post
|
Post entity |
timestamp -
Timestamp!
|
Timestamp for notification |
user -
User
|
Recipient user entity |
Example
{
"id": 4,
"mentionedBy": User,
"post": Post,
"timestamp": 1592577642,
"user": User
}
MentionedInPostComment
Description
User was mentioned in a post comment
Fields
| Field Name | Description |
|---|---|
comment -
PostComment
|
Post comment entity. Can be null if deleted |
id -
ID!
|
UserNotification UUID |
mentionedBy -
User
|
User who made the mention |
post -
Post
|
Post entity |
timestamp -
Timestamp!
|
Timestamp for notification |
user -
User
|
Recipient user entity |
Example
{
"comment": PostComment,
"id": 4,
"mentionedBy": User,
"post": Post,
"timestamp": 1592577642,
"user": User
}
MentionedInPostCommentReply
Description
User was mentioned in a post comment reply
Fields
| Field Name | Description |
|---|---|
comment -
PostComment
|
Post comment entity. Can be null if deleted |
id -
ID!
|
UserNotification UUID |
mentionedBy -
User
|
User who made the mention |
parentComment -
PostComment
|
Parent post comment entity. Can be null if it's deleted |
post -
Post
|
Post entity |
timestamp -
Timestamp!
|
Timestamp for notification |
user -
User
|
Recipient user entity |
Example
{
"comment": PostComment,
"id": 4,
"mentionedBy": User,
"parentComment": PostComment,
"post": Post,
"timestamp": 1592577642,
"user": User
}
MerkleTree
Description
Merkle tree entity
Fields
| Field Name | Description |
|---|---|
createdAt -
DateTime!
|
Upload step creation date |
id -
ID!
|
Upload step identifier |
leafCount -
Int!
|
Number of leaves for merkle tree |
root -
String!
|
Merkle tree root |
unhashedLeaves -
[String!]!
|
List of unhashed leaves for merkle tree |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"leafCount": 987,
"root": "abc123",
"unhashedLeaves": ["xyz789"]
}
MerkleTreeProof
Description
Merkle tree proof information
Fields
| Field Name | Description |
|---|---|
proof -
[String!]!
|
Merkle proof |
unhashedLeaf -
String!
|
Unhashed leaf in merkle tree |
Example
{
"proof": ["abc123"],
"unhashedLeaf": "xyz789"
}
MetadataAttribute
MetadataDetails
Description
Metadata details of song
Example
{
"bpm": 123.45,
"key": "abc123",
"license": "abc123",
"location": "abc123",
"lyrics": "abc123"
}
MinValueError
MintTimeStatus
Description
Mint current time status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"PAST"
MintedReleasesCursorFilterArgs
Description
Filter minted releases
Fields
| Input Field | Description |
|---|---|
contracts -
[ContractReleaseInput!]
|
Specify up to 50 contracts to filter the releases |
genres -
[Genres!]
|
Only get releases from specified genres |
locationIds -
[String!]
|
Location ids to filter on for releases |
mintTimeMaxDate -
Timestamp
|
Only get releases less or equal to than specified mint time |
mintTimeMinDate -
Timestamp
|
Only get releases greater than or equal to specified mint time |
mintTimeStatus -
[MintTimeStatus!]
|
Only get release with specified mint time status |
releaseAlbumRevealStatus -
ReleaseAlbumRevealFilterOption
|
Filters on whether album releases have been revealed or not |
releaseStatus -
[ReleaseStatus!]
|
Only get release with specified status |
releaseType -
[ReleaseType!]!
|
Filters on release type |
season -
[ArtistSeason!]
|
Only get releases from specified seasons |
Example
{
"contracts": [ContractReleaseInput],
"genres": ["AFROBEAT"],
"locationIds": ["abc123"],
"mintTimeMaxDate": 1592577642,
"mintTimeMinDate": 1592577642,
"mintTimeStatus": ["PAST"],
"releaseAlbumRevealStatus": "ALL",
"releaseStatus": ["AVAILABLE_TO_MINT"],
"releaseType": ["ALBUM"],
"season": ["GENESIS"]
}
MintingAccessConfigMintingType
Description
Different minting types for mintingAccessConfig query
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"FREE"
MulticallArgInput
MultipartUploadOutput
Description
Multi-part upload initiation information.
Fields
| Field Name | Description |
|---|---|
signedUrls -
[SignedMultipartUrl!]!
|
Signed multi-part URLs for each part number |
uploadId -
String!
|
Upload ID to use for each upload part of the final object |
uploadKey -
String!
|
Upload key for the final upload object |
Example
{
"signedUrls": [SignedMultipartUrl],
"uploadId": "abc123",
"uploadKey": "abc123"
}
MultipartUploadRequest
Description
Input for signedUploadParams mutation
Fields
| Input Field | Description |
|---|---|
fileName -
String!
|
File name of media to be uploaded |
mediaType -
MediaType!
|
Media type to be uploaded |
totalPartsCount -
Int!
|
Number of parts to use for multi-part upload |
Example
{
"fileName": "abc123",
"mediaType": "ARTIST_BANNER_IMAGE",
"totalPartsCount": 987
}
MutationAbortMultipartUploadResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
AwsRequestError
MutationAbortMultipartUploadSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
AbortMultipartUploadOutput!
|
Example
{"data": AbortMultipartUploadOutput}
MutationAcceptArtistApplicationResult
Description
Auto-generated result union type for the mutation or query with the same name
Example
MutationAcceptArtistApplicationSuccess
MutationAcceptArtistApplicationSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
ArtistApplication!
|
Example
{"data": ArtistApplication}
MutationAddPostCommentReplyInput
MutationAddPostCommentReplyResult
Description
Auto-generated result union type for the mutation or query with the same name
Example
DidNotGoThroughError
MutationAddPostCommentReplySuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
PostComment!
|
Example
{"data": PostComment}
MutationAddPostCommentResult
Description
Auto-generated result union type for the mutation or query with the same name
Example
DidNotGoThroughError
MutationAddPostCommentSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
PostComment!
|
Example
{"data": PostComment}
MutationAddReleaseToShelfResult
Description
Auto-generated result union type for the mutation or query with the same name
Example
DuplicatedError
MutationAddReleaseToShelfSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Shelf!
|
Example
{"data": Shelf}
MutationAddUsersToDraftAllowlistResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
AlreadyMintedError
MutationAddUsersToDraftAllowlistSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
AddUsersToDraftAllowlistOutput!
|
Example
{"data": AddUsersToDraftAllowlistOutput}
MutationAdminAllowUserToPostInput
Fields
| Input Field | Description |
|---|---|
userId -
UUID!
|
User ID |
Example
{
"userId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
MutationAdminAllowUserToPostResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationAdminAllowUserToPostSuccess
MutationAdminAllowUserToPostSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Boolean!
|
Example
{"data": true}
MutationAdminDeleteAllUserContentInput
Fields
| Input Field | Description |
|---|---|
userId -
UUID!
|
User ID |
Example
{
"userId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
MutationAdminDeleteAllUserContentResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationAdminDeleteAllUserContentSuccess
MutationAdminDeleteAllUserContentSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Boolean!
|
Example
{"data": false}
MutationAdminDeletePostCommentInput
Fields
| Input Field | Description |
|---|---|
postCommentId -
UUID!
|
Post Comment ID |
Example
{
"postCommentId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
MutationAdminDeletePostCommentReplyInput
Fields
| Input Field | Description |
|---|---|
postCommentId -
UUID!
|
Post comment reply ID |
Example
{
"postCommentId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
MutationAdminDeletePostCommentReplyResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationAdminDeletePostCommentReplySuccess
MutationAdminDeletePostCommentReplySuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Boolean!
|
Example
{"data": true}
MutationAdminDeletePostCommentResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationAdminDeletePostCommentSuccess
MutationAdminDeletePostCommentSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Boolean!
|
Example
{"data": false}
MutationAdminDeletePostInput
Fields
| Input Field | Description |
|---|---|
postId -
UUID!
|
Post ID |
Example
{
"postId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
MutationAdminDeletePostResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationAdminDeletePostSuccess
MutationAdminDeletePostSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Boolean!
|
Example
{"data": false}
MutationAdminDisallowUserToPostInput
Fields
| Input Field | Description |
|---|---|
userId -
UUID!
|
User ID |
Example
{
"userId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
MutationAdminDisallowUserToPostResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationAdminDisallowUserToPostSuccess
MutationAdminDisallowUserToPostSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Boolean!
|
Example
{"data": false}
MutationCompleteMultipartUploadResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
AwsRequestError
MutationCompleteMultipartUploadSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
CompleteMultipartUploadOutput!
|
Example
{"data": CompleteMultipartUploadOutput}
MutationConnectFarcasterResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationConnectFarcasterSuccess
MutationConnectFarcasterSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
User!
|
Example
{"data": User}
MutationConnectSpotifyInput
Description
Input for connectSpotify mutation
Example
{
"code": "xyz789",
"overrideAccount": true,
"redirectUri": "http://www.test.com/"
}
MutationConnectSpotifyResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationConnectSpotifySuccess
MutationConnectSpotifySuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
User!
|
Example
{"data": User}
MutationCreateArtistApplicationResult
Description
Auto-generated result union type for the mutation or query with the same name
Example
MutationCreateArtistApplicationSuccess
MutationCreateArtistApplicationSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
ArtistApplication!
|
Example
{"data": ArtistApplication}
MutationCreateDraftResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
DuplicatedError
MutationCreateDraftSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Draft!
|
Example
{"data": Draft}
MutationCreateGeneralPostResult
Description
Auto-generated result union type for the mutation or query with the same name
Example
DidNotGoThroughError
MutationCreateGeneralPostSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Post!
|
Example
{"data": Post}
MutationCreateMultipartUploadResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
AwsRequestError
MutationCreateMultipartUploadSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
MultipartUploadOutput!
|
Example
{"data": MultipartUploadOutput}
MutationCreatePlaylistPostResult
Description
Auto-generated result union type for the mutation or query with the same name
Example
DidNotGoThroughError
MutationCreatePlaylistPostSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Post!
|
Example
{"data": Post}
MutationCreateReleasePostOnWaveformResult
Description
Auto-generated result union type for the mutation or query with the same name
Example
DidNotGoThroughError
MutationCreateReleasePostOnWaveformSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
ReleaseCollectorWaveformPostAttr!
|
Example
{"data": ReleaseCollectorWaveformPostAttr}
MutationCreateReleasePostResult
Description
Auto-generated result union type for the mutation or query with the same name
Example
DidNotGoThroughError
MutationCreateReleasePostSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Post!
|
Example
{"data": Post}
MutationCreateTieredDraftInput
Description
Input for createTieredDraft mutation
Fields
| Input Field | Description |
|---|---|
allowListsInfo -
TieredDraftAllowListsInput!
|
Allowlists inputs |
auctionConfigurations -
TieredAuctionConfigurationsInput!
|
Auction configuration inputs |
chain -
ChainType!
|
Chain associated with contract |
contractAddress -
Address!
|
Contract address to be deployed |
releaseInfo -
TieredReleaseInfoUploadStepInput!
|
Release info upload inputs |
rewardsInfo -
TieredRewardsUploadStepInput!
|
Rewards upload inputs |
shouldCreateRelease -
Boolean!
|
Should release be created |
splitsInfo -
TieredSplitsUploadStepInput
|
Credit allocations of credit split |
Example
{
"allowListsInfo": TieredDraftAllowListsInput,
"auctionConfigurations": TieredAuctionConfigurationsInput,
"chain": "BASE",
"contractAddress": Address,
"releaseInfo": TieredReleaseInfoUploadStepInput,
"rewardsInfo": TieredRewardsUploadStepInput,
"shouldCreateRelease": true,
"splitsInfo": TieredSplitsUploadStepInput
}
MutationCreateTieredDraftResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
AuthorizationError
MutationCreateTieredDraftSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Draft!
|
Example
{"data": Draft}
MutationCustomizeHighlightedReleasesResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationCustomizeHighlightedReleasesSuccess
MutationCustomizeHighlightedReleasesSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
HighlightedReleasesCustomization!
|
Example
{"data": HighlightedReleasesCustomization}
MutationDeleteAllUsersFromDraftAllowlistResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
AlreadyMintedError
MutationDeleteAllUsersFromDraftAllowlistSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
AllowList!
|
Example
{"data": AllowList}
MutationDeleteArtistResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationDeleteArtistSuccess
MutationDeleteArtistSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Boolean!
|
Example
{"data": true}
MutationDeleteDraftResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
AlreadyMintedError
MutationDeleteDraftSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Draft!
|
Example
{"data": Draft}
MutationDeletePostInput
Fields
| Input Field | Description |
|---|---|
postId -
UUID!
|
ID of the post to delete |
Example
{
"postId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
MutationDeletePostResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationDeletePostSuccess
MutationDeletePostSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Boolean!
|
Example
{"data": true}
MutationDeleteReleaseResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationDeleteReleaseSuccess
MutationDeleteReleaseSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Boolean!
|
Example
{"data": true}
MutationDeleteUsersFromDraftAllowlistResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
AlreadyMintedError
MutationDeleteUsersFromDraftAllowlistSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
AllowList!
|
Example
{"data": AllowList}
MutationDismissRecommendedFollowBannerResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
AuthorizationError
MutationDismissRecommendedFollowBannerSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
DateTime!
|
Example
{"data": "2007-12-03T10:15:30Z"}
MutationDraftMetadataUploadResult
Description
Auto-generated result union type for the mutation or query with the same name
Example
ArweavePerUserBudgetExceededError
MutationDraftMetadataUploadSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
ReleaseArweaveOutputs!
|
Example
{"data": ReleaseArweaveOutputs}
MutationEditReleaseAsyncInput
MutationEditReleaseAsyncResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationEditReleaseAsyncSuccess
MutationEditReleaseAsyncSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
EditReleaseAsyncOutput!
|
Example
{"data": EditReleaseAsyncOutput}
MutationEditReleaseResult
Description
Auto-generated result union type for the mutation or query with the same name
Example
ArweavePerUserBudgetExceededError
MutationEditReleaseSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
EditedReleaseResult!
|
Example
{"data": EditedReleaseResult}
MutationExtendShelfResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationExtendShelfSuccess
MutationExtendShelfSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Shelf!
|
Example
{"data": Shelf}
MutationFollowAllRecommendedUsersResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
AuthorizationError
MutationFollowAllRecommendedUsersSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Void!
|
Example
{"data": null}
MutationLikeReleaseResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationLikeReleaseSuccess
MutationLikeReleaseSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Release!
|
Example
{"data": Release}
MutationLikeShelfResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationLikeShelfSuccess
MutationLikeShelfSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Shelf!
|
Example
{"data": Shelf}
MutationLogoutResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
AuthorizationError
MutationLogoutSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Boolean!
|
Example
{"data": true}
MutationPaperMerkleMinterV2SdkClientSecretResult
Description
Auto-generated result union type for the mutation or query with the same name
Example
MutationPaperMerkleMinterV2SdkClientSecretSuccess
MutationPaperMerkleMinterV2SdkClientSecretSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
String!
|
Example
{"data": "xyz789"}
MutationPaperMinterAdapterSdkClientSecretResult
Description
Auto-generated result union type for the mutation or query with the same name
Example
MutationPaperMinterAdapterSdkClientSecretSuccess
MutationPaperMinterAdapterSdkClientSecretSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
String!
|
Example
{"data": "abc123"}
MutationPaperRangeMinterV2SdkClientSecretResult
Description
Auto-generated result union type for the mutation or query with the same name
Example
MutationPaperRangeMinterV2SdkClientSecretSuccess
MutationPaperRangeMinterV2SdkClientSecretSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
String!
|
Example
{"data": "abc123"}
MutationPaperSoundSwapSdkClientSecretResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationPaperSoundSwapSdkClientSecretSuccess
MutationPaperSoundSwapSdkClientSecretSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
String!
|
Example
{"data": "abc123"}
MutationPaperSuperMinterSdkClientSecretResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationPaperSuperMinterSdkClientSecretSuccess
MutationPaperSuperMinterSdkClientSecretSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
String!
|
Example
{"data": "xyz789"}
MutationPinReleasePostToWaveformResult
Description
Auto-generated result union type for the mutation or query with the same name
Example
DidNotGoThroughError
MutationPinReleasePostToWaveformSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
ReleaseCollectorWaveformPostAttr!
|
Example
{"data": ReleaseCollectorWaveformPostAttr}
MutationPrepareMintDraftAsyncResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
AlreadyMintedError
MutationPrepareMintDraftAsyncSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
PrepareMintDraftAsyncOutput!
|
Example
{"data": PrepareMintDraftAsyncOutput}
MutationPrepareMintDraftResult
Description
Auto-generated result union type for the mutation or query with the same name
Example
AlreadyMintedError
MutationPrepareMintDraftSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
PrepareMintDraftOutput!
|
Example
{"data": PrepareMintDraftOutput}
MutationPrepareMintTieredDraftAsyncInput
Description
Input for prepareMintTieredDraftAsync mutation
Fields
| Input Field | Description |
|---|---|
draftId -
UUID!
|
Draft identifier |
Example
{
"draftId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
MutationPrepareMintTieredDraftAsyncResult
Description
Auto-generated result union type for the mutation or query with the same name
Example
AlreadyMintedError
MutationPrepareMintTieredDraftAsyncSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
PrepareMintTieredDraftAsyncOutput!
|
Example
{"data": PrepareMintTieredDraftAsyncOutput}
MutationPresaveReleaseInput
Description
Input for presaveRelease mutation
Fields
| Input Field | Description |
|---|---|
releaseId -
UUID!
|
Release identifier to be liked |
Example
{
"releaseId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
MutationPresaveReleaseResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
AuthorizationError
MutationPresaveReleaseSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
UserReleaseStatus!
|
Example
{"data": UserReleaseStatus}
MutationRecoverShelfResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationRecoverShelfSuccess
MutationRecoverShelfSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Shelf!
|
Example
{"data": Shelf}
MutationRejectArtistApplicationResult
Description
Auto-generated result union type for the mutation or query with the same name
Example
MutationRejectArtistApplicationSuccess
MutationRejectArtistApplicationSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
ArtistApplication!
|
Example
{"data": ArtistApplication}
MutationRemovePostCommentInput
Fields
| Input Field | Description |
|---|---|
postCommentId -
UUID!
|
ID of the post comment to delete |
Example
{
"postCommentId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
MutationRemovePostCommentReplyInput
Fields
| Input Field | Description |
|---|---|
replyPostCommentId -
UUID!
|
ID of the post comment's reply to delete |
Example
{
"replyPostCommentId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
MutationRemovePostCommentReplyResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationRemovePostCommentReplySuccess
MutationRemovePostCommentReplySuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Boolean!
|
Example
{"data": true}
MutationRemovePostCommentResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationRemovePostCommentSuccess
MutationRemovePostCommentSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Boolean!
|
Example
{"data": true}
MutationRemoveReleaseFromShelfResult
Description
Auto-generated result union type for the mutation or query with the same name
Example
MutationRemoveReleaseFromShelfSuccess
MutationRemoveReleaseFromShelfSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Shelf!
|
Example
{"data": Shelf}
MutationRepostInput
Description
Input for repost mutation
Fields
| Input Field | Description |
|---|---|
postId -
UUID!
|
ID of the post to be reposted |
Example
{
"postId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
MutationRepostResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationRepostSuccess
MutationRepostSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Repost!
|
Example
{"data": Repost}
MutationResetInstagramHandleResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationResetInstagramHandleSuccess
MutationResetInstagramHandleSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
User!
|
Example
{"data": User}
MutationResetTwitterHandleResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationResetTwitterHandleSuccess
MutationResetTwitterHandleSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
User!
|
Example
{"data": User}
MutationSelectSongSlotUsingNftIdResult
Description
Auto-generated result union type for the mutation or query with the same name
Example
AuthorizationError
MutationSelectSongSlotUsingNftIdSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Nft!
|
Example
{"data": Nft}
MutationSetAffiliatePurchaseSourceResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationSetAffiliatePurchaseSourceSuccess
MutationSetAffiliatePurchaseSourceSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Int!
|
Example
{"data": 123}
MutationSetArtistPickedReleaseResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
AuthorizationError
MutationSetArtistPickedReleaseSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Release!
|
Example
{"data": Release}
MutationSetAudioDownloadRewardResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationSetAudioDownloadRewardSuccess
MutationSetAudioDownloadRewardSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Release!
|
Example
{"data": Release}
MutationSetInvitedByUserResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationSetInvitedByUserSuccess
MutationSetInvitedByUserSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
User!
|
Example
{"data": User}
MutationSetReceiveArtistUpdateEmailsResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
CustomerIoAPICallError
MutationSetReceiveArtistUpdateEmailsSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
UserNotificationPreferences!
|
Example
{"data": UserNotificationPreferences}
MutationSetReceiveMentionUpdateEmailsResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
CustomerIoAPICallError
MutationSetReceiveMentionUpdateEmailsSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
UserNotificationPreferences!
|
Example
{"data": UserNotificationPreferences}
MutationSetShelfReleasesResult
Description
Auto-generated result union type for the mutation or query with the same name
Example
MutationSetShelfReleasesSuccess
MutationSetShelfReleasesSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Shelf!
|
Example
{"data": Shelf}
MutationSetUserDisplayNameResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationSetUserDisplayNameSuccess
MutationSetUserDisplayNameSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
User!
|
Example
{"data": User}
MutationSetUserEngagementOnChannelResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationSetUserEngagementOnChannelSuccess
MutationSetUserEngagementOnChannelSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Boolean!
|
Example
{"data": false}
MutationSetUserJoinStatusOnChannelResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationSetUserJoinStatusOnChannelSuccess
MutationSetUserJoinStatusOnChannelSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Boolean!
|
Example
{"data": true}
MutationSetUserLocationResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
GoogleAPICallError
MutationSetUserLocationSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
User!
|
Example
{"data": User}
MutationSetUserNotificationPreferencesOnChannelResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationSetUserNotificationPreferencesOnChannelSuccess
MutationSetUserNotificationPreferencesOnChannelSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
ChannelNotificationStatus!
|
Example
{"data": "DISABLED"}
MutationSetUserPersistedDataResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationSetUserPersistedDataSuccess
MutationSetUserPersistedDataSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
JSON!
|
Example
{"data": {}}
MutationSponsoredAffiliateWithdrawInput
Fields
| Input Field | Description |
|---|---|
chain -
L2ChainType!
|
The chain for the transaction |
multiCallArgs -
[MulticallArgInput!]!
|
Array of multicall entries |
Example
{"chain": "BASE", "multiCallArgs": [MulticallArgInput]}
MutationSponsoredAffiliateWithdrawResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
ForbiddenError
MutationSponsoredAffiliateWithdrawSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
SponsoredTransaction!
|
Example
{"data": SponsoredTransaction}
MutationSponsoredUploadResult
Description
Auto-generated result union type for the mutation or query with the same name
Example
ForbiddenError
MutationSponsoredUploadSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
SponsoredTransaction!
|
Example
{"data": SponsoredTransaction}
MutationSponsoredWithdrawInput
Fields
| Input Field | Description |
|---|---|
chain -
L2ChainType!
|
The chain for the transaction |
multiCallArgs -
[MulticallArgInput!]!
|
Array of multicall entries |
Example
{"chain": "BASE", "multiCallArgs": [MulticallArgInput]}
MutationSponsoredWithdrawResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
ForbiddenError
MutationSponsoredWithdrawSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
SponsoredTransaction!
|
Example
{"data": SponsoredTransaction}
MutationSubscribeArtistActivityNotificationResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
CustomerIoAPICallError
MutationSubscribeArtistActivityNotificationSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
ArtistNotificationSubscription!
|
Example
{"data": ArtistNotificationSubscription}
MutationSyncUserNftsForEditionAdminInput
Description
Input for syncUserNftsForEditionAdmin mutation
Fields
| Input Field | Description |
|---|---|
chain -
ChainType!
|
Chain associated with edition |
contractAddress -
Address!
|
Edition address |
userPublicAddress -
Address!
|
Public address possibly owner of the edition |
Example
{
"chain": "BASE",
"contractAddress": Address,
"userPublicAddress": Address
}
MutationSyncUserNftsForEditionInput
Description
Input for syncUserNftsForEdition mutation
Fields
| Input Field | Description |
|---|---|
chain -
ChainType!
|
Chain associated with edition |
contractAddress -
Address!
|
Edition address |
Example
{"chain": "BASE", "contractAddress": Address}
MutationTieredDraftMetadataUploadAsyncInput
Description
Input for tieredDraftMetadataUploadAsync mutation
Fields
| Input Field | Description |
|---|---|
draftId -
UUID!
|
Draft identifier |
Example
{
"draftId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
MutationTieredDraftMetadataUploadAsyncResult
Description
Auto-generated result union type for the mutation or query with the same name
Example
ArweavePerUserBudgetExceededError
MutationTieredDraftMetadataUploadAsyncSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
TieredDraftMetadataUploadAsyncOutput!
|
Example
{"data": TieredDraftMetadataUploadAsyncOutput}
MutationTieredDraftMetadataUploadInput
Description
Input for tieredDraftMetadataUpload mutation
Fields
| Input Field | Description |
|---|---|
draftId -
UUID!
|
Draft identifier |
Example
{
"draftId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
MutationTieredDraftMetadataUploadResult
Description
Auto-generated result union type for the mutation or query with the same name
Example
ArweavePerUserBudgetExceededError
MutationTieredDraftMetadataUploadSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
TieredDraftMetadataUploadResult!
|
Example
{"data": TieredDraftMetadataUploadResult}
MutationUnlikeReleaseResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationUnlikeReleaseSuccess
MutationUnlikeReleaseSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Release!
|
Example
{"data": Release}
MutationUnlikeShelfResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationUnlikeShelfSuccess
MutationUnlikeShelfSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Shelf!
|
Example
{"data": Shelf}
MutationUnpinReleasePostFromWaveformResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationUnpinReleasePostFromWaveformSuccess
MutationUnpinReleasePostFromWaveformSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Boolean!
|
Example
{"data": true}
MutationUnsubscribeArtistActivityNotificationResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
CustomerIoAPICallError
MutationUnsubscribeArtistActivityNotificationSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Int!
|
Example
{"data": 123}
MutationUpdateChannelSettingsResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationUpdateChannelSettingsSuccess
MutationUpdateChannelSettingsSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Channel!
|
Example
{"data": Channel}
MutationUpdateDraftInfoResult
Description
Auto-generated result union type for the mutation or query with the same name
Example
AlreadyMintedError
MutationUpdateDraftInfoSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Draft!
|
Example
{"data": Draft}
MutationUpdateNotificationEmailResult
Description
Auto-generated result union type for the mutation or query with the same name
Example
MutationUpdateNotificationEmailSuccess
MutationUpdateNotificationEmailSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
UserNotificationPreferences!
|
Example
{"data": UserNotificationPreferences}
MutationUpdateSpotifyArtistUrlResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationUpdateSpotifyArtistUrlSuccess
MutationUpdateSpotifyArtistUrlSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Artist!
|
Example
{"data": Artist}
MutationUpdateTiktokUrlResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationUpdateTiktokUrlSuccess
MutationUpdateTiktokUrlSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
User!
|
Example
{"data": User}
MutationUpsertShelfCoverImageInput
Fields
| Input Field | Description |
|---|---|
coverImage -
UploadedMedia
|
Uploaded cover image |
id -
String!
|
Shelf Id |
Example
{
"coverImage": UploadedMedia,
"id": "xyz789"
}
MutationUpsertShelfCoverImageResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationUpsertShelfCoverImageSuccess
MutationUpsertShelfCoverImageSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Shelf!
|
Example
{"data": Shelf}
MutationVerifyInstagramResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
InstagramAPIError
MutationVerifyInstagramSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
User!
|
Example
{"data": User}
MutationVerifyNotificationEmailResult
Description
Auto-generated result union type for the mutation or query with the same name
Example
MutationVerifyNotificationEmailSuccess
MutationVerifyNotificationEmailSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Boolean!
|
Example
{"data": false}
MutationVerifyTwitterHandleResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationVerifyTwitterHandleSuccess
MutationVerifyTwitterHandleSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
User!
|
Example
{"data": User}
MutationVoteOnPostCommentResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationVoteOnPostCommentSuccess
MutationVoteOnPostCommentSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Void!
|
Example
{"data": null}
MutationVoteOnPostRLResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
MutationVoteOnPostRLSuccess
MutationVoteOnPostRLSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Void!
|
Example
{"data": null}
NFTCommentConnection
Description
Paginated NFT Comments connection
Fields
| Field Name | Description |
|---|---|
edges -
[NftCommentConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [NftCommentConnectionEdge],
"pageInfo": PageInfo
}
NewChannelMember
Description
A new user joined a channel
Example
{
"channel": Channel,
"featuredUsers": [User],
"id": "4",
"numUsers": 987,
"timestamp": 1592577642,
"user": User
}
NewChannelPost
Description
A new post was created in a channel that the user follows
Fields
| Field Name | Description |
|---|---|
channel -
Channel
|
Channel entity |
id -
ID!
|
UserNotification UUID |
post -
Post
|
Post entity |
timestamp -
Timestamp!
|
Timestamp for notification |
user -
User
|
Recipient user entity |
Example
{
"channel": Channel,
"id": 4,
"post": Post,
"timestamp": 1592577642,
"user": User
}
NewCommentOnRelease
Description
Release has received a new comment
Fields
| Field Name | Description |
|---|---|
comment -
PostComment
|
Post comment entity. Can be null if deleted |
id -
ID!
|
UserNotification UUID |
post -
Post
|
Post entity |
timestamp -
Timestamp!
|
Timestamp for notification |
user -
User
|
Recipient user entity |
Example
{
"comment": PostComment,
"id": "4",
"post": Post,
"timestamp": 1592577642,
"user": User
}
NewFollower
Description
User received a new follower
Fields
| Field Name | Description |
|---|---|
featuredFollowers -
[User!]!
|
Featured new followers |
id -
ID!
|
UserNotification UUID |
numNewFollowers -
Int!
|
Number of new followers in this group |
timestamp -
Timestamp!
|
Timestamp for notification |
user -
User
|
Recipient user entity |
Example
{
"featuredFollowers": [User],
"id": 4,
"numNewFollowers": 123,
"timestamp": 1592577642,
"user": User
}
NewPostComment
Description
User has received a new comment on their post
Fields
| Field Name | Description |
|---|---|
comment -
PostComment
|
Post comment entity. Can be null if deleted |
id -
ID!
|
UserNotification UUID |
post -
Post
|
Post entity |
timestamp -
Timestamp!
|
Timestamp for notification |
user -
User
|
Recipient user entity |
Example
{
"comment": PostComment,
"id": "4",
"post": Post,
"timestamp": 1592577642,
"user": User
}
NewPostCommentReply
Description
User has received a new comment on their post
Fields
| Field Name | Description |
|---|---|
comment -
PostComment
|
Post comment entity. Can be null if deleted |
id -
ID!
|
UserNotification UUID |
parentComment -
PostComment
|
Parent post comment entity. Can be null if it's deleted |
post -
Post
|
Post entity |
timestamp -
Timestamp!
|
Timestamp for notification |
user -
User
|
Recipient user entity |
Example
{
"comment": PostComment,
"id": "4",
"parentComment": PostComment,
"post": Post,
"timestamp": 1592577642,
"user": User
}
NewPostCommentUpvote
Description
User has received a new upvote on their post's comment
Fields
| Field Name | Description |
|---|---|
comment -
PostComment
|
Post comment entity. Can be null if deleted |
featuredUsers -
[User!]!
|
Featured users |
id -
ID!
|
UserNotification UUID |
numUsers -
Int!
|
Number of users that created an upvote on the post comment within the group |
post -
Post
|
Post entity |
timestamp -
Timestamp!
|
Timestamp for notification |
user -
User
|
Recipient user entity |
Example
{
"comment": PostComment,
"featuredUsers": [User],
"id": 4,
"numUsers": 987,
"post": Post,
"timestamp": 1592577642,
"user": User
}
NewPostUpvote
Description
User has received a new upvote on their post
Example
{
"featuredUsers": [User],
"id": 4,
"numUsers": 987,
"post": Post,
"timestamp": 1592577642,
"user": User
}
NewRepost
Description
User has received a new repost on their post
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
UserNotification UUID |
post -
Post
|
Post entity |
reposter -
User
|
User that reposted the post |
timestamp -
Timestamp!
|
Timestamp for notification |
user -
User
|
Recipient user entity |
Example
{
"id": "4",
"post": Post,
"reposter": User,
"timestamp": 1592577642,
"user": User
}
Nft
Description
NFT Entity
Fields
| Field Name | Description |
|---|---|
audioUrl -
String
|
Audio of Nft |
collectorRelease -
ReleaseCollector
|
Release collector entity associated with NFT ownership |
comment -
Comment
|
Comment set for NFT |
contractAddress -
String!
|
Contract address |
coverImage -
Media!
|
Cover image of NFT |
createdAt -
DateTime!
|
Date of creation of NFT entity |
createdAtBlockTime -
DateTime
|
Blockchain created date of NFT |
id -
ID!
|
Nft UUID |
isBurned -
Boolean!
|
Was the NFT burned. Shortcut for owner.publicAddress === 0x000.... |
isGoldenEgg -
Boolean!
|
Is the NFT a golden egg |
openSeaMetadataAttributes -
[OpenSeaMetadataAttribute!]!
|
OpenSea metadata attributes. |
owner -
User!
|
Owner of NFT |
release -
Release!
|
Release associated with NFT |
serialNumber -
Int!
|
Serial number |
songSlot -
Int
|
Song slot reserved by NFT |
tierNumber -
Int
|
Tier number |
title -
String!
|
Title of Nft |
tokenId -
ID!
|
Unique chain token identifier |
updatedAt -
DateTime!
|
Last update date of NFT |
Example
{
"audioUrl": "abc123",
"collectorRelease": ReleaseCollector,
"comment": Comment,
"contractAddress": "xyz789",
"coverImage": Media,
"createdAt": "2007-12-03T10:15:30Z",
"createdAtBlockTime": "2007-12-03T10:15:30Z",
"id": "4",
"isBurned": false,
"isGoldenEgg": false,
"openSeaMetadataAttributes": [OpenSeaMetadataAttribute],
"owner": User,
"release": Release,
"serialNumber": 123,
"songSlot": 987,
"tierNumber": 123,
"title": "xyz789",
"tokenId": 4,
"updatedAt": "2007-12-03T10:15:30Z"
}
NftCommentConnectionEdge
NftCommentCursorConnectionArgs
Description
Cursor connection parameters for Nft Comments
Fields
| Input Field | Description |
|---|---|
after -
String
|
Start forwards pagination since "after" cursor |
before -
String
|
Start backwards pagination since "before" cursor |
first -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "after", with a maximum of 51 nodes. |
last -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "before", with a maximum of 51 nodes. |
sort -
NftCommentCursorConnectionSort!
|
Customize sort behavior |
Example
{
"after": "abc123",
"before": "abc123",
"first": 123,
"last": 123,
"sort": NftCommentCursorConnectionSort
}
NftCommentCursorConnectionSort
Description
Customize the sort behavior of Post Comments pagination
Fields
| Input Field | Description |
|---|---|
createdAt -
SortOrder
|
Sort by created date |
Example
{"createdAt": "ASC"}
NftConnection
Description
Paginated NFTs connection
Fields
| Field Name | Description |
|---|---|
edges -
[NftConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [NftConnectionEdge],
"pageInfo": PageInfo
}
NftConnectionEdge
NftCursorConnectionArgs
Description
Cursor connection parameters for NFTs
Fields
| Input Field | Description |
|---|---|
after -
String
|
Start forwards pagination since "after" cursor |
before -
String
|
Start backwards pagination since "before" cursor |
first -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "after", with a maximum of 51 nodes. |
last -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "before", with a maximum of 51 nodes. |
sort -
NftCursorConnectionSort!
|
Customize sort behavior |
Example
{
"after": "abc123",
"before": "abc123",
"first": 123,
"last": 123,
"sort": NftCursorConnectionSort
}
NftCursorConnectionSort
Description
Customize the sort behavior of Nfts pagination
Example
{"primarySaleDate": "ASC", "secondarySaleDate": "ASC", "serialNumber": "ASC"}
NftInput
NftTier
Description
The Tier of the NFT owned by Audience Member
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ALL"
Node
Description
Base node
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
Node identifier |
Possible Types
| Node Types |
|---|
Example
{"id": 4}
NonEmptyString
Description
A string that cannot be passed as an empty value
Example
"string"
NonNegativeFloat
Description
Floats that will have a value of 0 or more.
Example
123.45
NonNegativeInt
Description
Integers that will have a value of 0 or more.
Example
123
NotAllowedError
Description
Operation is not allowed.
Fields
| Field Name | Description |
|---|---|
message -
String!
|
Descriptive message of error |
Example
{"message": "abc123"}
NotAuthorizedError
Description
Returned when an operation is not allowed by authenticated user
Fields
| Field Name | Description |
|---|---|
message -
String!
|
Descriptive message of error |
Example
{"message": "xyz789"}
NotFoundError
Description
Returned when a resource is not found
Fields
| Field Name | Description |
|---|---|
message -
String!
|
Descriptive message of error |
Example
{"message": "abc123"}
NotSupportedVersion
NotificationEmailAlreadyClaimedError
Description
Returned when the user attempts to claim an email for notifications that is already claimed by another user
Fields
| Field Name | Description |
|---|---|
message -
String!
|
Descriptive message of error |
Example
{"message": "abc123"}
NotificationEmailFailedToSendError
Description
Returned when an unexpected error occurs while attempting to send an email. May be safe to retry
Fields
| Field Name | Description |
|---|---|
message -
String!
|
Descriptive message of error |
Example
{"message": "xyz789"}
NotificationEmailTokenExpiredOrInvalidError
Description
Returned when the user attempts to claim a token that has already been claimed or is expired
Fields
| Field Name | Description |
|---|---|
message -
String!
|
Descriptive message of error |
Example
{"message": "abc123"}
NotificationEmailTokenInvalidForUserError
Description
Returned when the user attempts to claim a token that is not valid for the user
Fields
| Field Name | Description |
|---|---|
message -
String!
|
Descriptive message of error |
Example
{"message": "abc123"}
OpenEditionAuction
Description
Auction options associated with open edition sales
Fields
| Field Name | Description |
|---|---|
maxPrice -
Float!
|
Maximum price for sale |
minOptions -
[Int!]!
|
List of different options of minimum quantity for public sale |
minPrice -
Float!
|
Minimum price for sale |
mintingPeriodDays -
[Int!]!
|
List of different duration in days for public sale |
mintingStartsInDays -
[Int!]!
|
List of different days for public sale to start in |
presaleMaxMintsPerWalletOptions -
[Int!]!
|
List of different max mints per wallet quantity options for presale No max mints per wallet options for open edition |
presaleMaxPrice -
Float!
|
Maximum price for presale |
presaleMinPrice -
Float!
|
Minimum price for presale |
priceOptions -
[Float!]!
|
List of different eth prices options for public sale |
publicSaleMaxMintsPerWalletOptions -
[Int!]!
|
List of different max mints per wallet quantity options for public sale No max mints per wallet options for open edition |
Example
{
"maxPrice": 123.45,
"minOptions": [123],
"minPrice": 123.45,
"mintingPeriodDays": [123],
"mintingStartsInDays": [987],
"presaleMaxMintsPerWalletOptions": [987],
"presaleMaxPrice": 987.65,
"presaleMinPrice": 123.45,
"priceOptions": [123.45],
"publicSaleMaxMintsPerWalletOptions": [123]
}
OpenEditionAuctionInput
Description
Input options to customize open edition auctions
Fields
| Input Field | Description |
|---|---|
freeSaleMaxMintsPerWalletOptions -
[Int!]
|
List of different max mints per wallet quantity options for free sale |
maxPrice -
Float
|
Maximum price for sale |
minOptions -
[Int!]!
|
List of different options of minimum quantity for public sale |
minPrice -
Float
|
Minimum price for sale |
mintingPeriodDays -
[Int!]
|
List of different duration in days for public sale |
mintingStartsInDays -
[Int!]
|
List of different days for public sale to start in |
presaleMaxMintsPerWalletOptions -
[Int!]
|
List of different max mints per wallet quantity options for presale |
presaleMaxPrice -
Float
|
Maximum price for presale |
presaleMinPrice -
Float
|
Minimum price for presale |
priceOptions -
[Float!]
|
List of different eth prices options for public sale |
publicSaleMaxMintsPerWalletOptions -
[Int!]
|
List of different max mints per wallet quantity options for public sale |
Example
{
"freeSaleMaxMintsPerWalletOptions": [123],
"maxPrice": 123.45,
"minOptions": [987],
"minPrice": 123.45,
"mintingPeriodDays": [123],
"mintingStartsInDays": [123],
"presaleMaxMintsPerWalletOptions": [123],
"presaleMaxPrice": 987.65,
"presaleMinPrice": 123.45,
"priceOptions": [123.45],
"publicSaleMaxMintsPerWalletOptions": [123]
}
OpenEditionAuctionWithSAMInput
Description
Input options to customize open edition auctions with SAM
Fields
| Input Field | Description |
|---|---|
freeSaleMaxMintsPerWalletOptions -
[Int!]
|
List of different max mints per wallet quantity options for free sale |
inflectionCountSAM -
Int!
|
Inflection count for SAM |
inflectionMultipleBPS -
Int!
|
Inflection multiple BPS for SAM |
linearPriceSlope -
String!
|
Linear price slope for SAM |
maxPrice -
Float
|
Maximum price for sale |
minOptions -
[Int!]!
|
List of different options of minimum quantity for public sale |
minPrice -
Float
|
Minimum price for sale |
mintingPeriodDays -
[Int!]
|
List of different duration in days for public sale |
mintingStartsInDays -
[Int!]
|
List of different days for public sale to start in |
presaleMaxMintsPerWalletOptions -
[Int!]
|
List of different max mints per wallet quantity options for presale |
presaleMaxPrice -
Float
|
Maximum price for presale |
presaleMinPrice -
Float
|
Minimum price for presale |
priceOptions -
[Float!]
|
List of different eth prices options for public sale |
publicSaleMaxMintsPerWalletOptions -
[Int!]
|
List of different max mints per wallet quantity options for public sale |
Example
{
"freeSaleMaxMintsPerWalletOptions": [123],
"inflectionCountSAM": 987,
"inflectionMultipleBPS": 123,
"linearPriceSlope": "xyz789",
"maxPrice": 987.65,
"minOptions": [987],
"minPrice": 123.45,
"mintingPeriodDays": [987],
"mintingStartsInDays": [987],
"presaleMaxMintsPerWalletOptions": [123],
"presaleMaxPrice": 987.65,
"presaleMinPrice": 987.65,
"priceOptions": [123.45],
"publicSaleMaxMintsPerWalletOptions": [987]
}
OpenEditionWithSAMAuction
Description
Auction options associated with open edition with SAM
Fields
| Field Name | Description |
|---|---|
inflectionCountSAM -
Int!
|
Inflection count for SAM |
inflectionMultipleBPS -
Int!
|
Inflection multiple BPS for SAM |
linearPriceSlope -
String!
|
Linear price slope for SAM |
maxPrice -
Float!
|
Maximum price for sale |
minOptions -
[Int!]!
|
List of different options of minimum quantity for public sale |
minPrice -
Float!
|
Minimum price for sale |
mintingPeriodDays -
[Int!]!
|
List of different duration in days for public sale |
mintingStartsInDays -
[Int!]!
|
List of different days for public sale to start in |
presaleMaxMintsPerWalletOptions -
[Int!]!
|
List of different max mints per wallet quantity options for presale No max mints per wallet options for open edition |
presaleMaxPrice -
Float!
|
Maximum price for presale |
presaleMinPrice -
Float!
|
Minimum price for presale |
priceOptions -
[Float!]!
|
List of different eth prices options for public sale |
publicSaleMaxMintsPerWalletOptions -
[Int!]!
|
List of different max mints per wallet quantity options for public sale No max mints per wallet options for open edition |
Example
{
"inflectionCountSAM": 987,
"inflectionMultipleBPS": 987,
"linearPriceSlope": "abc123",
"maxPrice": 123.45,
"minOptions": [987],
"minPrice": 123.45,
"mintingPeriodDays": [123],
"mintingStartsInDays": [987],
"presaleMaxMintsPerWalletOptions": [987],
"presaleMaxPrice": 987.65,
"presaleMinPrice": 123.45,
"priceOptions": [123.45],
"publicSaleMaxMintsPerWalletOptions": [987]
}
OpenSeaMetadataAttribute
OwnedToken
Description
Owned token by the user in release
Example
{
"isGoldenEgg": true,
"serialNumber": 123,
"tierNumber": 987,
"tokenId": "abc123"
}
PageInfo
Description
Pagination helper information
Fields
| Field Name | Description |
|---|---|
endCursor -
String
|
Cursor shorthand of the last node from current page |
hasNextPage -
Boolean!
|
Does the current connection have a next page |
hasPreviousPage -
Boolean!
|
Does the current connection have a previous page |
startCursor -
String
|
Cursor shorthand of the first node from current page |
Example
{
"endCursor": "abc123",
"hasNextPage": false,
"hasPreviousPage": false,
"startCursor": "abc123"
}
PaperCheckoutType
Description
Possible options for Paper Checkout
Values
| Enum Value | Description |
|---|---|
|
|
Checkout with Credit Card |
|
|
Checkout with ETH Mainnet |
Example
"CREDIT_CARD"
PaperMerkleDropMinterV2SdkClientSecretInput
Description
Input for paperMerkleMinterV2SdkClientSecret mutation
Fields
| Input Field | Description |
|---|---|
affiliate -
Address!
|
Address of the affiliate to receive the commission. |
merkleRoot -
String!
|
Merkle root of the drop |
mintId -
NonNegativeInt!
|
ID from the mint schedule to mint |
quantity -
PositiveInt!
|
Quantity of editions to mint |
releaseId -
UUID!
|
ID of the release to mint |
totalPrice -
String!
|
Total price of the sale in Ether |
type -
PaperCheckoutType!
|
Checkout option |
Example
{
"affiliate": Address,
"merkleRoot": "abc123",
"mintId": 123,
"quantity": 123,
"releaseId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"totalPrice": "abc123",
"type": "CREDIT_CARD"
}
PaperMinterAdapterSdkClientSecretInput
Description
Input for paperMinterAdapterSdkClientSecret mutation
Fields
| Input Field | Description |
|---|---|
affiliate -
Address!
|
Address of the affiliate to receive the commission. |
giftTo -
Address
|
Address of the recipient of the gift |
mintId -
NonNegativeInt!
|
ID from the mint schedule to mint |
minter -
Address!
|
Address of the minter to mint from. |
quantity -
PositiveInt!
|
Quantity of editions to mint |
releaseId -
UUID!
|
ID of the release to mint |
totalPrice -
String!
|
Total price of the sale in Ether |
type -
PaperCheckoutType!
|
Checkout option |
Example
{
"affiliate": Address,
"giftTo": Address,
"mintId": 123,
"minter": Address,
"quantity": 123,
"releaseId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"totalPrice": "abc123",
"type": "CREDIT_CARD"
}
PaperRangedMinterV2SdkClientSecretInput
Description
Input for paperRangeMinterV2SdkClientSecret mutation
Fields
| Input Field | Description |
|---|---|
affiliate -
Address!
|
Address of the affiliate to receive the commission. |
giftTo -
Address
|
Address of the recipient of the gift |
mintId -
NonNegativeInt!
|
ID from the mint schedule to mint |
quantity -
PositiveInt!
|
Quantity of editions to mint |
releaseId -
UUID!
|
ID of the release to mint |
totalPrice -
String!
|
Total price of the sale in Ether |
type -
PaperCheckoutType!
|
Checkout option |
Example
{
"affiliate": Address,
"giftTo": Address,
"mintId": 123,
"quantity": 123,
"releaseId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"totalPrice": "abc123",
"type": "CREDIT_CARD"
}
PaperSoundSwapSdkClientSecretInput
Description
Input for paperSoundSwapSdkClientSecret mutation
Fields
| Input Field | Description |
|---|---|
affiliate -
Address!
|
Address of the affiliate to receive the commission. |
giftTo -
Address
|
Address of the recipient of the gift |
quantity -
PositiveInt!
|
Quantity of editions to mint |
releaseId -
UUID!
|
ID of the release to mint |
totalPrice -
String!
|
Total price of the sale in Ether |
type -
PaperCheckoutType!
|
Checkout option |
Example
{
"affiliate": Address,
"giftTo": Address,
"quantity": 123,
"releaseId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"totalPrice": "abc123",
"type": "CREDIT_CARD"
}
PaperSuperMinterSdkClientSecretInput
Description
Input for paperSuperMinterSdkClientSecretInput mutation
Fields
| Input Field | Description |
|---|---|
affiliate -
Address!
|
Address of the affiliate to receive the commission. |
chain -
ChainType!
|
Chain of the edition to mint |
editionAddress -
Address!
|
Address of the edition to mint |
giftTo -
Address
|
Address of the recipient of the gift |
quantity -
PositiveInt!
|
Quantity of editions to mint |
releaseId -
UUID!
|
ID of the release to mint |
scheduleNumber -
NonNegativeInt!
|
Schedule number to mint |
tierNumber -
NonNegativeInt!
|
Tier number to mint |
totalPrice -
String!
|
Total price of the sale in Ether |
type -
PaperCheckoutType!
|
Checkout option |
Example
{
"affiliate": Address,
"chain": "BASE",
"editionAddress": Address,
"giftTo": Address,
"quantity": 123,
"releaseId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"scheduleNumber": 123,
"tierNumber": 123,
"totalPrice": "abc123",
"type": "CREDIT_CARD"
}
PersonalizedFollowRecommendationsInput
Description
Input for generating personalized follow recommendations
Fields
| Input Field | Description |
|---|---|
pagination -
UserCursorConnectionArgs!
|
Pagination parameters of collectors |
Example
{"pagination": UserCursorConnectionArgs}
PinReleasePostToWaveformInput
Description
Input for createReleasePost mutation
Fields
| Input Field | Description |
|---|---|
postId -
UUID!
|
ID of the post to pin |
releaseId -
UUID!
|
ID of the release to associate with the post |
songSlot -
NonNegativeInt!
|
Slot numbered 0 to 99 for pinning a post to the release waveform. Only applies for release collectors. |
Example
{
"postId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"releaseId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"songSlot": 123
}
PlatformType
Description
Platform type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ANDROID"
Playlist
Description
Playlist entity that contains tracks
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
Ephemeral Unique UUID. Since right now the playlists are not being persisted, it's a completely randomly created UUID created on memory |
tracks -
[PlaylistTrack!]!
|
Track list |
Possible Types
| Playlist Types |
|---|
Example
{
"id": "4",
"tracks": [PlaylistTrack]
}
PlaylistAction
Description
Playlist action entity
Fields
| Field Name | Description |
|---|---|
date -
DateTime!
|
Date of action |
id -
ID!
|
Playlist action id |
playlist -
Shelf
|
Shelf entity |
user -
User!
|
User corresponding to action entity |
Possible Types
| PlaylistAction Types |
|---|
Example
{
"date": "2007-12-03T10:15:30Z",
"id": 4,
"playlist": Shelf,
"user": User
}
PlaylistActionConnection
Description
Paginated playlist action connection
Fields
| Field Name | Description |
|---|---|
edges -
[PlaylistActionConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [PlaylistActionConnectionEdge],
"pageInfo": PageInfo
}
PlaylistActionConnectionEdge
Description
Edge of playlist action connection
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Cursor to be used for pagination |
node -
PlaylistAction!
|
Playlist action node |
Example
{
"cursor": "xyz789",
"node": PlaylistAction
}
PlaylistActionFilterArgs
Description
Filter PlaylistAction details
Fields
| Input Field | Description |
|---|---|
releaseArtistId -
UUID
|
If set, only show artist owned releases in paginated release results. Does not apply if the playlist is owned by the artist |
Example
{
"releaseArtistId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
PlaylistActionReleasesCursorConnectionArgs
Description
Cursor connection parameters
Fields
| Input Field | Description |
|---|---|
after -
String
|
Start forwards pagination since "after" cursor |
before -
String
|
Start backwards pagination since "before" cursor |
first -
NonNegativeInt
|
Limit the number of nodes to be fetched, to be used with "after", with a maximum of 25 nodes |
last -
NonNegativeInt
|
Limit the number of nodes to be fetched, to be used with "before", with a maximum of 25 nodes |
sort -
SortOrder!
|
Sort the releases ascending or descending by release creation date |
Example
{
"after": "abc123",
"before": "xyz789",
"first": 123,
"last": 123,
"sort": "ASC"
}
PlaylistAffiliateBuyer
Description
Playlist affiliate buyer entity
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
Unique identifier of playlist affiliate buyer |
mostRecentAffiliatePurchaseDate -
DateTime
|
Most recent affiliate purchase date by user from playlist referral. |
numAffiliateNftsPurchased -
Int
|
Number of nfts purchased by user from playlist referral. |
user -
User!
|
User buyer entity |
Example
{
"id": 4,
"mostRecentAffiliatePurchaseDate": "2007-12-03T10:15:30Z",
"numAffiliateNftsPurchased": 987,
"user": User
}
PlaylistAffiliateBuyerConnection
Description
Paginated playlist affiliate buyers connection
Fields
| Field Name | Description |
|---|---|
edges -
[PlaylistAffiliateBuyerConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [PlaylistAffiliateBuyerConnectionEdge],
"pageInfo": PageInfo
}
PlaylistAffiliateBuyerConnectionEdge
Description
Edge of Playlist Affiliate Buyer Connection
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Cursor to be used for pagination |
node -
PlaylistAffiliateBuyer!
|
Playlist Affiliate Buyer node |
Example
{
"cursor": "abc123",
"node": PlaylistAffiliateBuyer
}
PlaylistArtist
Description
Playlist of tracks of an artist
Fields
| Field Name | Description |
|---|---|
artistId -
ID!
|
|
id -
ID!
|
Ephemeral Unique UUID. Since right now the playlists are not being persisted, it's a completely randomly created UUID created on memory |
tracks -
[PlaylistTrack!]!
|
Track list |
Example
{"artistId": 4, "id": 4, "tracks": [PlaylistTrack]}
PlaylistChart
Description
Playlist chart entity
Fields
| Field Name | Description |
|---|---|
chartRanks -
PlaylistChartRankConnection!
|
Chart ranks of release chart |
Arguments
|
|
id -
ID!
|
UUID of Playlist chart entity |
lastDayOfChartInclusive -
DateTime!
|
Last full day of the chart period (inclusive) |
periodEndExclusive -
DateTime!
|
Playlist chart period end exclusive |
periodStartInclusive -
DateTime!
|
Playlist chart period start inclusive |
Example
{
"chartRanks": PlaylistChartRankConnection,
"id": 4,
"lastDayOfChartInclusive": "2007-12-03T10:15:30Z",
"periodEndExclusive": "2007-12-03T10:15:30Z",
"periodStartInclusive": "2007-12-03T10:15:30Z"
}
PlaylistChartRank
Description
Playlist chart rank entity
Fields
| Field Name | Description |
|---|---|
currentRank -
Int!
|
Current ranking of release |
id -
ID!
|
UUID of Playlist chart entity |
playlist -
Shelf!
|
Chart rank release |
rankLast -
Int
|
Last ranking of release |
rankPeak -
Int
|
Peak ranking of release |
trendingIndicator -
TrendingIndicator!
|
Trending indicator of release |
trendingStreak -
Int!
|
Trending streak of release |
Example
{
"currentRank": 123,
"id": "4",
"playlist": Shelf,
"rankLast": 987,
"rankPeak": 123,
"trendingIndicator": "DOWN",
"trendingStreak": 123
}
PlaylistChartRankConnection
Description
Paginated connection of Playlist Chart Ranks
Fields
| Field Name | Description |
|---|---|
edges -
[PlaylistChartRankConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [PlaylistChartRankConnectionEdge],
"pageInfo": PageInfo
}
PlaylistChartRankConnectionEdge
Description
Edge of Playlist Chart Rank Connection
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Cursor to be used for pagination |
node -
PlaylistChartRank!
|
Playlist Chart Rank node |
Example
{
"cursor": "abc123",
"node": PlaylistChartRank
}
PlaylistChartRankCursorConnectionArgs
Description
Pagination paramaters for release chart ranks
Fields
| Input Field | Description |
|---|---|
after -
String
|
Start forwards pagination since "after" cursor |
before -
String
|
Start backwards pagination since "before" cursor |
first -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "after", with a maximum of 51 nodes. |
last -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "before", with a maximum of 51 nodes. |
sort -
PlaylistChartRankCursorConnectionSort!
|
Customize sort behavior |
Example
{
"after": "xyz789",
"before": "xyz789",
"first": 123,
"last": 123,
"sort": PlaylistChartRankCursorConnectionSort
}
PlaylistChartRankCursorConnectionSort
Description
Customize sort of collectors
Fields
| Input Field | Description |
|---|---|
currentRank -
SortOrder
|
Sort by playlist chart current rank |
Example
{"currentRank": "ASC"}
PlaylistCreated
PlaylistHolder
Description
Playlist of tracks of a holder's NFTs
Fields
| Field Name | Description |
|---|---|
holderPublicAddress -
String!
|
Holder public address |
id -
ID!
|
Ephemeral Unique UUID. Since right now the playlists are not being persisted, it's a completely randomly created UUID created on memory |
tracks -
[PlaylistTrack!]!
|
Track list |
Example
{
"holderPublicAddress": "abc123",
"id": "4",
"tracks": [PlaylistTrack]
}
PlaylistHome
Description
Playlist used for Homepage and fallback for extra pages
Fields
| Field Name | Description |
|---|---|
createdAt -
DateTime!
|
|
id -
ID!
|
Ephemeral Unique UUID. Since right now the playlists are not being persisted, it's a completely randomly created UUID created on memory |
tracks -
[PlaylistTrack!]!
|
Track list |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"tracks": [PlaylistTrack]
}
PlaylistInput
Description
Playlist input
Fields
| Input Field | Description |
|---|---|
associationId -
String
|
Association ID based on type of playlist |
type -
PlaylistType!
|
Type of playlist |
Example
{
"associationId": "abc123",
"type": "ARTIST"
}
PlaylistLiked
Description
Playlist liked action entity
Example
{
"date": "2007-12-03T10:15:30Z",
"id": "4",
"playlist": Shelf,
"user": User
}
PlaylistPost
Description
Playlist Post entity
Fields
| Field Name | Description |
|---|---|
authorChannelRole -
ChannelCuratorRole
|
Channel role of the author (null if they are not a curator) |
channel -
Channel
|
Channel that the post was posted to |
commentCount -
Int!
|
Number of comments on the post |
comments -
PostCommentConnection!
|
Comments on the post |
Arguments
|
|
content -
String!
|
Content of the post |
createdAt -
DateTime!
|
Creation date of entity |
creator -
User!
|
User who created the post |
farcasterHash -
String
|
Farcaster hash of the post |
id -
ID!
|
Unique identifier of the Post |
lexicalContent -
JSON
|
Lexical content of the post |
optionalShelf -
Shelf
|
The shelf associated with the post |
repostCount -
Int!
|
Number of reposts on the post |
upvoteCount -
Int!
|
Number of upvotes on the post |
webappUri -
String!
|
Webapp URI of Post |
Example
{
"authorChannelRole": "MODERATOR",
"channel": Channel,
"commentCount": 987,
"comments": PostCommentConnection,
"content": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"creator": User,
"farcasterHash": "xyz789",
"id": 4,
"lexicalContent": {},
"optionalShelf": Shelf,
"repostCount": 987,
"upvoteCount": 123,
"webappUri": "xyz789"
}
PlaylistPosted
Description
A playlist by the user was posted to feed by another user
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
UserNotification UUID |
post -
Post
|
Post entity |
shelf -
Shelf
|
Posted shelf entity |
timestamp -
Timestamp!
|
Timestamp for notification |
user -
User
|
Recipient user entity |
Example
{
"id": "4",
"post": Post,
"shelf": Shelf,
"timestamp": 1592577642,
"user": User
}
PlaylistTrack
PlaylistType
Description
Currently supported playlists
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ARTIST"
PositiveInt
Description
Integers that will have a value greater than 0.
Example
123
Post
Description
Post entity
Fields
| Field Name | Description |
|---|---|
authorChannelRole -
ChannelCuratorRole
|
Channel role of the author (null if they are not a curator) |
channel -
Channel
|
Channel that the post was posted to |
commentCount -
Int!
|
Number of comments on the post |
comments -
PostCommentConnection!
|
Comments on the post |
Arguments
|
|
content -
String!
|
Content of the post |
createdAt -
DateTime!
|
Creation date of entity |
creator -
User!
|
User who created the post |
farcasterHash -
String
|
Farcaster hash of the post |
id -
ID!
|
Unique identifier of the Post |
lexicalContent -
JSON
|
Lexical content of the post |
repostCount -
Int!
|
Number of reposts on the post |
upvoteCount -
Int!
|
Number of upvotes on the post |
webappUri -
String!
|
Webapp URI of Post |
Possible Types
| Post Types |
|---|
Example
{
"authorChannelRole": "MODERATOR",
"channel": Channel,
"commentCount": 123,
"comments": PostCommentConnection,
"content": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"creator": User,
"farcasterHash": "abc123",
"id": "4",
"lexicalContent": {},
"repostCount": 987,
"upvoteCount": 123,
"webappUri": "abc123"
}
PostComment
Description
Post Comment entity
Fields
| Field Name | Description |
|---|---|
author -
User!
|
User who created the comment |
authorChannelRole -
ChannelCuratorRole
|
Channel role of the author (null if they are not a curator) |
authorNftsCountGa -
Int
|
Number of ga nfts of the associated release the author holds |
authorNftsCountVip -
Int
|
Number of vip nfts of the associated release the author holds |
content -
String!
|
Content of the comment |
createdAt -
DateTime!
|
Creation date of the comment |
currentHolderOfRelease -
Boolean!
|
Is the author the current holder of linked release in the Post? |
id -
ID!
|
Unique identifier of the Post Comment |
labels -
[PostCommentLabel!]!
|
Comment labels |
lexicalContent -
JSON
|
Lexical content of the post |
parentComment -
PostComment
|
Comment which this comment is a reply to |
post -
Post!
|
Post which the comment belongs to |
repliesCount -
Int!
|
Number of replies on the comment |
updatedAt -
DateTime!
|
Last update date of the comment |
upvoteCount -
Int!
|
Number of upvotes on the comment |
Example
{
"author": User,
"authorChannelRole": "MODERATOR",
"authorNftsCountGa": 123,
"authorNftsCountVip": 987,
"content": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"currentHolderOfRelease": true,
"id": "4",
"labels": ["RELEASE_ARTIST"],
"lexicalContent": {},
"parentComment": PostComment,
"post": Post,
"repliesCount": 123,
"updatedAt": "2007-12-03T10:15:30Z",
"upvoteCount": 987
}
PostCommentConnection
Description
Paginated Post Comments connection
Fields
| Field Name | Description |
|---|---|
edges -
[PostCommentConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [PostCommentConnectionEdge],
"pageInfo": PageInfo
}
PostCommentConnectionEdge
Description
Post Comment Node edge
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Cursor to be used for pagination |
node -
PostComment!
|
Post Comment Entity |
Example
{
"cursor": "xyz789",
"node": PostComment
}
PostCommentCursorConnectionArgs
Description
Cursor connection parameters for Post Comments
Fields
| Input Field | Description |
|---|---|
after -
String
|
Start forwards pagination since "after" cursor |
before -
String
|
Start backwards pagination since "before" cursor |
first -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "after", with a maximum of 51 nodes. |
last -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "before", with a maximum of 51 nodes. |
sort -
PostCommentCursorConnectionSort!
|
Customize sort behavior |
Example
{
"after": "abc123",
"before": "abc123",
"first": 123,
"last": 123,
"sort": PostCommentCursorConnectionSort
}
PostCommentCursorConnectionSort
Description
Customize the sort behavior of Post Comments pagination
Fields
| Input Field | Description |
|---|---|
createdAt -
SortOrder
|
Sort by created date |
Example
{"createdAt": "ASC"}
PostCommentLabel
Description
Post Comment label type
Values
| Enum Value | Description |
|---|---|
|
|
Example
"RELEASE_ARTIST"
PostConnection
Description
Paginated Posts connection
Fields
| Field Name | Description |
|---|---|
edges -
[PostConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [PostConnectionEdge],
"pageInfo": PageInfo
}
PostConnectionEdge
PostCursorConnectionArgs
Description
Cursor connection parameters for Posts
Fields
| Input Field | Description |
|---|---|
after -
String
|
Start forwards pagination since "after" cursor |
before -
String
|
Start backwards pagination since "before" cursor |
first -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "after", with a maximum of 51 nodes. |
last -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "before", with a maximum of 51 nodes. |
sort -
PostCursorConnectionSort!
|
Customize sort behavior |
Example
{
"after": "xyz789",
"before": "abc123",
"first": 123,
"last": 123,
"sort": PostCursorConnectionSort
}
PostCursorConnectionSort
Description
Customize the sort behavior of Posts pagination
Fields
| Input Field | Description |
|---|---|
createdAt -
SortOrder
|
Sort by created date |
Example
{"createdAt": "ASC"}
PostReposted
Description
Repost done action entity
Example
{
"date": "2007-12-03T10:15:30Z",
"id": 4,
"originalPost": Post,
"repost": Post,
"user": User
}
PostVoteChange
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"REMOVE_VOTE"
PrepareMintDraftAsyncInput
Description
Input for prepareMintDraftAsync mutation
Fields
| Input Field | Description |
|---|---|
chain -
ChainType!
|
Chain where the draft will be deployed |
draftId -
UUID!
|
Draft identifier |
Example
{
"chain": "BASE",
"draftId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
PrepareMintDraftAsyncOutput
PrepareMintDraftAsyncStatusPending
Description
Pending status for async prepare mint draft request
Example
{
"draft": Draft,
"prepareMintDraftAsyncRequestId": "xyz789",
"result": "abc123"
}
PrepareMintDraftAsyncStatusResult
Types
| Union Types |
|---|
Example
PrepareMintDraftAsyncStatusPending
PrepareMintDraftAsyncStatusSuccess
Description
Success status for async prepare mint draft request
Example
{
"draft": Draft,
"merkleTreeRoot": "abc123",
"prepareMintDraftAsyncRequestId": "abc123",
"result": "abc123"
}
PrepareMintDraftInput
Description
Input for prepareMintDraft mutation
Fields
| Input Field | Description |
|---|---|
chain -
ChainType!
|
Chain where the draft will be deployed |
draftId -
UUID!
|
Draft identifier |
Example
{
"chain": "BASE",
"draftId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
PrepareMintDraftOutput
PrepareMintTieredDraftAsyncOutput
PrepareMintTieredDraftAsyncStatusPending
PrepareMintTieredDraftAsyncStatusResult
Example
PrepareMintTieredDraftAsyncStatusPending
PrepareMintTieredDraftAsyncStatusSuccess
Description
Success status for async prepare mint tiered draft request
Example
{
"draft": Draft,
"merkleTreeRoot": "xyz789",
"prepareMintTieredDraftAsyncRequestId": "xyz789"
}
PresaleStarted
Description
A subscribed artist release presale has dropped and user is eligible
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
UserNotification UUID |
release -
Release
|
Dropped presale release entity |
timestamp -
Timestamp!
|
Timestamp for notification |
user -
User
|
Recipient user entity |
Example
{
"id": 4,
"release": Release,
"timestamp": 1592577642,
"user": User
}
PresaveDropStarted
Description
A drop with presave enabled has started
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
UserNotification UUID |
release -
Release!
|
Presave drop release entity |
timestamp -
Timestamp!
|
Timestamp for notification |
user -
User
|
Recipient user entity |
Example
{
"id": 4,
"release": Release,
"timestamp": 1592577642,
"user": User
}
PresaveGiftReceived
Description
User has received a presave gift
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
UserNotification UUID |
release -
Release!
|
Presaved release entity |
timestamp -
Timestamp!
|
Timestamp for notification |
user -
User
|
Recipient user entity |
Example
{
"id": 4,
"release": Release,
"timestamp": 1592577642,
"user": User
}
PrimarySale
Description
Primary sale collector action entity
Fields
| Field Name | Description |
|---|---|
amountPaidInWei -
String!
|
Amount paid in Wei for primary sale |
date -
DateTime!
|
Date of action |
fromSerialNumber -
Int
|
Starting serial number of NFT for primary sale purchase |
fromTokenId -
Int!
|
Starting token ID of NFT for primary sale purchase |
id -
ID!
|
Action id |
quantity -
Int!
|
Number of sequential tokens purchased |
release -
Release!
|
Release corresponding to collector primary sale action entity |
serialNumber -
Int!
|
Serial number of nft primary sale purchase |
tierNumber -
Int
|
tierNumber of the NFT |
toSerialNumber -
Int
|
Ending serial Number of NFT for primary sale purchase |
toTokenId -
Int!
|
Ending token ID of NFT for primary sale purchase |
user -
User!
|
User corresponding to collector action entity |
Example
{
"amountPaidInWei": "abc123",
"date": "2007-12-03T10:15:30Z",
"fromSerialNumber": 123,
"fromTokenId": 987,
"id": "4",
"quantity": 987,
"release": Release,
"serialNumber": 987,
"tierNumber": 123,
"toSerialNumber": 123,
"toTokenId": 123,
"user": User
}
PublicSaleStarted
Description
A subscribed artist release has dropped
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
UserNotification UUID |
release -
Release
|
Dropped release entity |
timestamp -
Timestamp!
|
Timestamp for notification |
user -
User
|
Recipient user entity |
Example
{
"id": 4,
"release": Release,
"timestamp": 1592577642,
"user": User
}
QueryAdminUserBlockStatusInput
Fields
| Input Field | Description |
|---|---|
userId -
UUID!
|
User ID |
Example
{
"userId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
QueryAdminUserBlockStatusResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
NotFoundError
QueryAdminUserBlockStatusSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Boolean!
|
Example
{"data": false}
QueryAdminUserNftCommentsInput
Fields
| Input Field | Description |
|---|---|
pagination -
NftCommentCursorConnectionArgs!
|
Pagination parameters |
userId -
UUID!
|
User ID |
Example
{
"pagination": NftCommentCursorConnectionArgs,
"userId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
QueryAdminUserPostCommentsWithoutNFTCommentsInput
Fields
| Input Field | Description |
|---|---|
pagination -
PostCommentCursorConnectionArgs!
|
Pagination parameters |
userId -
UUID!
|
User ID |
Example
{
"pagination": PostCommentCursorConnectionArgs,
"userId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
QueryAdminUserPostsInput
Fields
| Input Field | Description |
|---|---|
pagination -
PostCursorConnectionArgs!
|
Pagination parameters |
userId -
UUID!
|
User ID |
Example
{
"pagination": PostCursorConnectionArgs,
"userId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
QueryChannelMembersWhoAreFollowedResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
NotFoundError
QueryChannelMembersWhoAreFollowedSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
ChannelMembersWhoAreFollowedResult!
|
Example
{"data": ChannelMembersWhoAreFollowedResult}
QueryChannelStatsInput
Fields
| Input Field | Description |
|---|---|
channelIds -
[UUID!]!
|
Unique Channel identifier |
Example
{
"channelIds": [
"6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
]
}
QueryEditReleaseAsyncStatusResult
Description
Auto-generated result union type for the mutation or query with the same name
Example
DuplicatedError
QueryEditReleaseAsyncStatusSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
EditReleaseAsyncStatusResult!
|
Example
{"data": EditReleaseAsyncStatusPending}
QueryHighlightedReleasesParametersResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
NotAuthorizedError
QueryHighlightedReleasesParametersSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
HighlightedReleasesCustomization!
|
Example
{"data": HighlightedReleasesCustomization}
QueryIsChannelCuratorInput
Fields
| Input Field | Description |
|---|---|
channelIds -
[UUID!]!
|
Unique Channel identifier |
Example
{
"channelIds": [
"6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
]
}
QueryIsChannelMemberInput
Fields
| Input Field | Description |
|---|---|
channelIds -
[UUID!]!
|
Unique Channel identifier |
Example
{
"channelIds": [
"6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
]
}
QueryPostRepostedByInput
Description
Input for postRepostedBy query
Fields
| Input Field | Description |
|---|---|
pagination -
UserCursorConnectionArgs!
|
Pagination parameters |
postId -
UUID!
|
Post identifier |
Example
{
"pagination": UserCursorConnectionArgs,
"postId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
QueryPostUpvotedByInput
Description
Input for postUpvotedBy query
Fields
| Input Field | Description |
|---|---|
pagination -
UserCursorConnectionArgs!
|
Pagination parameters |
postId -
UUID!
|
Post identifier |
Example
{
"pagination": UserCursorConnectionArgs,
"postId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
QueryPrepareMintDraftAsyncStatusResult
Description
Auto-generated result union type for the mutation or query with the same name
Example
AlreadyMintedError
QueryPrepareMintDraftAsyncStatusSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
PrepareMintDraftAsyncStatusResult!
|
Example
{"data": PrepareMintDraftAsyncStatusPending}
QueryPrepareMintTieredDraftAsyncStatusResult
Description
Auto-generated result union type for the mutation or query with the same name
Example
AlreadyMintedError
QueryPrepareMintTieredDraftAsyncStatusSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
PrepareMintTieredDraftAsyncStatusResult!
|
Example
{"data": PrepareMintTieredDraftAsyncStatusPending}
QueryPreviewCustomizeHighlightedReleasesResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
NotAuthorizedError
QueryPreviewCustomizeHighlightedReleasesSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
[Release!]!
|
Example
{"data": [Release]}
QueryShouldDeployNewSplitResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
NotFoundError
QueryShouldDeployNewSplitSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
Boolean!
|
Example
{"data": false}
QueryTieredDraftMetadataUploadAsyncStatusResult
Description
Auto-generated result union type for the mutation or query with the same name
Types
| Union Types |
|---|
Example
NotFoundError
QueryTieredDraftMetadataUploadAsyncStatusSuccess
Description
Auto-generated success type for the mutation or query with the same name
Fields
| Field Name | Description |
|---|---|
data -
TieredDraftMetadataUploadAsyncStatusResult!
|
Example
{"data": TieredDraftMetadataUploadAsyncStatusPending}
QueryUserPostStatusInput
Description
Input for userPostStatus query
Fields
| Input Field | Description |
|---|---|
postIds -
[UUID!]!
|
Unique Post identifier |
Example
{
"postIds": [
"6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
]
}
QueryUserReleaseStatusInput
Description
Input for userReleaseStatus query
Fields
| Input Field | Description |
|---|---|
releaseIds -
[UUID!]!
|
List of release identifiers |
Example
{
"releaseIds": [
"6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
]
}
QueryUserVoteOnPostCommentInput
Fields
| Input Field | Description |
|---|---|
postCommentIds -
[UUID!]!
|
Unique Post Comment identifiers |
Example
{
"postCommentIds": [
"6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
]
}
RateLimitError
RecommendedChannel
ReferralReceivedNotification
Description
Referrals received notification
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
UserNotification UUID |
timestamp -
Timestamp!
|
Timestamp for notification |
totalReceivedWei -
String
|
Total received for grouped referrals in WEI |
user -
User
|
Recipient user entity |
Example
{
"id": "4",
"timestamp": 1592577642,
"totalReceivedWei": "xyz789",
"user": User
}
ReferredUsersCursorConnectionArgs
Description
Pagination parameters of referred users
Fields
| Input Field | Description |
|---|---|
after -
String
|
Start forwards pagination since "after" cursor |
before -
String
|
Start backwards pagination since "before" cursor |
first -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "after", with a maximum of 25 nodes. |
last -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "before", with a maximum of 25 nodes. |
sort -
ReferredUsersCursorConnectionSort!
|
Customize sort behavior |
Example
{
"after": "xyz789",
"before": "xyz789",
"first": 123,
"last": 123,
"sort": ReferredUsersCursorConnectionSort
}
ReferredUsersCursorConnectionSort
Description
Customize the sort behavior of release affiliates total purchases
Fields
| Input Field | Description |
|---|---|
blockNumber -
SortOrder
|
Sort by purchase block number |
Example
{"blockNumber": "ASC"}
ReferredUsersInput
Description
Input for referred users within release affiliate total purchases
Fields
| Input Field | Description |
|---|---|
pagination -
ReferredUsersCursorConnectionArgs!
|
Pagination parameters |
Example
{"pagination": ReferredUsersCursorConnectionArgs}
RegisterMobileDeviceInput
Description
Mobile device registration input
Fields
| Input Field | Description |
|---|---|
firebaseToken -
String!
|
Firebase device token for mobile notifications |
isLoggedIn -
Boolean!
|
Indicates if the device is currently considered logged in |
platformInfo -
DevicePlatformInfoInput
|
Device platform info (optional) |
pushPermissionsEnabled -
Boolean!
|
Enable or disable push notification permissions |
Example
{
"firebaseToken": "xyz789",
"isLoggedIn": false,
"platformInfo": DevicePlatformInfoInput,
"pushPermissionsEnabled": true
}
RejectArtistApplicationInput
Description
Input options for rejectArtistApplication mutation
Example
{
"artistApplicationId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"rejectionReason": "abc123"
}
Release
Description
Release entity
Fields
| Field Name | Description |
|---|---|
activityFeed -
ReleaseActionConnection!
|
Release activity feed |
Arguments
|
|
affiliates -
ReleaseAffiliateConnection!
|
Referral affiliates of release |
Arguments
|
|
airdropCount -
Int!
|
Number of nfts airdropped |
animatedCoverImage -
Media
|
Animated cover image of the release if the cover is a GIF. Otherwise, null |
animatedGoldenEggImageOptimized -
Media
|
Animated golden egg image optimized for client rendering |
artist -
Artist!
|
Artist of release |
auctionContractType -
ContractType
|
Type of auction contract |
auctionType -
AuctionType
|
Auction type defined on upload flow |
baseMetadataAttributes -
[MetadataAttribute!]!
|
Base metadata attributes (non golden egg). |
behindTheMusic -
String!
|
Behind the music text |
canCollectorsDownloadAudio -
Boolean!
|
Can collectors download audio |
chainId -
Int!
|
Chain ID on which release is minted on |
collectors -
ReleaseCollectorConnection!
|
Collectors of release |
Arguments
|
|
collectorsCount -
Int!
|
Amount of unique collectors of release |
contract -
Contract!
|
Contract associated to Sound Edition |
contractAddress -
String!
|
Contract address |
coverImage -
Media!
|
Cover image of release |
createdAt -
DateTime!
|
Release creation date |
creditSplit -
CreditSplit
|
Credit split associated with release, if any |
credits -
[User!]!
|
Users with credits of release |
draftId -
String
|
Draft id associated to release |
earliestCollector -
ReleaseCollector
|
Earliest Collector of release |
editionId -
String
|
Edition ID |
eggGame -
EggGame
|
EggGame of Release |
externalUrl -
String
|
Associated external url |
finalQuantity -
Int
|
Final quantity for a release. Will be defined as soon as a max quantity has been determined |
fundingAddress -
String!
|
Address set as funds recipient on the contract |
gaAnimatedCoverImage -
Media
|
Animated GA cover image of the release if the cover is a GIF. Otherwise, null |
gaCoverImage -
Media
|
GA Cover image of release for tiered editions |
genre -
Genre!
|
Genre of Release |
goldenEggImage -
Media!
|
Special golden egg image |
goldenEggNft -
Nft
|
Golden egg NFT |
id -
ID!
|
Release identifier |
isAuctionSoldOut -
Boolean
|
Is the auction listing currently sold out. If the release doesn't have an auction associated, it returns null instead |
isFirstPhaseCompleted -
Boolean!
|
Is release sold out relative to the final quantity on first phase |
lastUpdatedAt -
DateTime
|
Release last updated at timestamp |
latestCollector -
ReleaseCollector
|
Latest Collector of release |
likedBy -
UserConnection!
|
Paginate through users who like this release. |
Arguments
|
|
listeningParty -
Timestamp
|
Listening party time of release in milliseconds since epoch |
listing -
AuctionListingInterface
|
Auction listing associated with release |
marketPlaceUrl -
String
|
Associated market place url |
metadataDetails -
MetadataDetails
|
Metadata details associated of song |
mintStartTime -
Int!
|
Public sale start time in UNIX timestamp |
mintStartTimestamp -
Timestamp!
|
Public sale start timestamp |
nftsPaginated -
NftConnection!
|
NFTs of Release |
Arguments
|
|
numSold -
Int!
|
Amount of sold NFTs |
openseaUrl -
String
|
Associated opensea url |
postCount -
Int!
|
Amount of posts |
price -
String!
|
Price in Wei |
publicAffiliateFeeBPS -
Int
|
Affiliate fee in basis points of the first non-merkle-drop schedule |
publicAffiliateFeePercent -
String
|
Affiliate fee in percent of the first non-merkle-drop schedule |
publicMintStart -
DateTime!
|
Public minting start time |
quantity -
Int!
|
Quantity of available NFTs |
quantityLowerBound -
Int!
|
Lower bound quantity for a releases main sale. |
quantityUpperBound -
Int!
|
Upper bound quantity for a releases main sale. |
rewards -
[Reward!]!
|
Rewards of Release |
royaltyBps -
Int!
|
Creator royalty basis points |
saleDetails -
SaleDetails!
|
Sale details for release |
saleSchedules -
[SaleSchedule!]!
|
Minting periods |
salesAffiliateFeesPercent -
[String!]!
|
Unique list of affiliate fees percent ordered by start time of sale schedule |
samAddress -
String
|
Sound Automated Market (SAM) address associated with the release |
samBuyBufferBpsOverride -
Int
|
Override for the SAM buy buffer in basis points (bps) for this release |
samConfig -
SamConfig
|
SAM configuration if enabled for edition |
samSellBufferBpsOverride -
Int
|
Override for the SAM sell buffer in basis points (bps) for this release |
scheduleIds -
[ScheduleIdentifier!]
|
Edition schedule identifiers, used to optimize chain calls |
season -
String
|
Season associated to release |
shelves -
ShelfConnection!
|
Shelves where the release has been added to |
Arguments
|
|
socialProofCollectors -
[User!]!
|
Release collectors that are prioritized based on followers status |
Arguments
|
|
spotifyPresaveCampaign -
Boolean!
|
Does the release have a spotify presave campaign |
spotifyPresaveCount -
Int!
|
Amount of presaves done on this release |
spotifyTrackId -
String
|
Spotify album uri |
staticCoverImage -
Media
|
Static version of animated cover image of release if the cover is a GIF. Otherwise, null |
staticGaCoverImage -
Media
|
Static version of animated GA cover image of release if the cover is a GIF. Otherwise, null |
staticVipCoverImage -
Media
|
Static version of animated VIP cover image of release if the cover is a GIF. Otherwise, null |
supplyCutoffTimestamp -
Timestamp
|
Time when supply is fixed for open/range based auctions. This is irrelevant for fixed supply auctions. |
title -
String!
|
Release title |
titleSlug -
String!
|
Slugified title |
topCollectors -
[TopReleaseCollector!]!
|
Top 5 collectors, sorted by nft count descendingly followed by lowest serial number ascendingly |
topPosts -
[Post!]!
|
Top 3 release posts |
topSpentCollector -
ReleaseCollector
|
Most VolumeSpent Collector of release |
totalMinted -
Int!
|
Total minted NFTs |
totalSupply -
Int!
|
Total supply of NFTs |
track -
Track!
|
Track of release |
type -
ReleaseType!
|
Type of Release |
vipAnimatedCoverImage -
Media
|
Animated VIP cover image of the release if the cover is a GIF. Otherwise, null |
vipCoverImage -
Media
|
VIP Cover image of release for tiered editions |
webEmbed -
String!
|
Web HTML iframe embed |
Arguments
|
|
webappUri -
String!
|
Webapp URI of Release |
Arguments
|
|
Example
{
"activityFeed": ReleaseActionConnection,
"affiliates": ReleaseAffiliateConnection,
"airdropCount": 123,
"animatedCoverImage": Media,
"animatedGoldenEggImageOptimized": Media,
"artist": Artist,
"auctionContractType": "ARTIST",
"auctionType": "FIXED_QUANTITY",
"baseMetadataAttributes": [MetadataAttribute],
"behindTheMusic": "abc123",
"canCollectorsDownloadAudio": false,
"chainId": 987,
"collectors": ReleaseCollectorConnection,
"collectorsCount": 123,
"contract": Contract,
"contractAddress": "xyz789",
"coverImage": Media,
"createdAt": "2007-12-03T10:15:30Z",
"creditSplit": CreditSplit,
"credits": [User],
"draftId": "xyz789",
"earliestCollector": ReleaseCollector,
"editionId": "xyz789",
"eggGame": EggGame,
"externalUrl": "abc123",
"finalQuantity": 123,
"fundingAddress": "xyz789",
"gaAnimatedCoverImage": Media,
"gaCoverImage": Media,
"genre": Genre,
"goldenEggImage": Media,
"goldenEggNft": Nft,
"id": 4,
"isAuctionSoldOut": false,
"isFirstPhaseCompleted": true,
"lastUpdatedAt": "2007-12-03T10:15:30Z",
"latestCollector": ReleaseCollector,
"likedBy": UserConnection,
"listeningParty": 1592577642,
"listing": AuctionListingInterface,
"marketPlaceUrl": "xyz789",
"metadataDetails": MetadataDetails,
"mintStartTime": 987,
"mintStartTimestamp": 1592577642,
"nftsPaginated": NftConnection,
"numSold": 987,
"openseaUrl": "xyz789",
"postCount": 987,
"price": "abc123",
"publicAffiliateFeeBPS": 123,
"publicAffiliateFeePercent": "abc123",
"publicMintStart": "2007-12-03T10:15:30Z",
"quantity": 123,
"quantityLowerBound": 987,
"quantityUpperBound": 987,
"rewards": [Reward],
"royaltyBps": 987,
"saleDetails": SaleDetails,
"saleSchedules": [SaleSchedule],
"salesAffiliateFeesPercent": ["abc123"],
"samAddress": "xyz789",
"samBuyBufferBpsOverride": 987,
"samConfig": SamConfig,
"samSellBufferBpsOverride": 987,
"scheduleIds": [ScheduleIdentifier],
"season": "abc123",
"shelves": ShelfConnection,
"socialProofCollectors": [User],
"spotifyPresaveCampaign": false,
"spotifyPresaveCount": 987,
"spotifyTrackId": "abc123",
"staticCoverImage": Media,
"staticGaCoverImage": Media,
"staticVipCoverImage": Media,
"supplyCutoffTimestamp": 1592577642,
"title": "xyz789",
"titleSlug": "xyz789",
"topCollectors": [TopReleaseCollector],
"topPosts": [Post],
"topSpentCollector": ReleaseCollector,
"totalMinted": 987,
"totalSupply": 123,
"track": Track,
"type": "ALBUM",
"vipAnimatedCoverImage": Media,
"vipCoverImage": Media,
"webEmbed": "xyz789",
"webappUri": "xyz789"
}
ReleaseAction
ReleaseActionConnection
Description
Paginated collector action connection
Fields
| Field Name | Description |
|---|---|
edges -
[ReleaseActionConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [ReleaseActionConnectionEdge],
"pageInfo": PageInfo
}
ReleaseActionConnectionEdge
Description
Edge of collector action connection
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Cursor to be used for pagination |
node -
ReleaseAction!
|
Release action node |
Example
{
"cursor": "abc123",
"node": ReleaseAction
}
ReleaseActivityFeedFilterArgs
Description
Filter release activity types
Fields
| Input Field | Description |
|---|---|
types -
[ReleaseActivityFeedTypeFilterOption!]!
|
Only get activity of given type |
Example
{"types": ["ALL"]}
ReleaseActivityFeedInput
Description
Release activity feed input parameters
Fields
| Input Field | Description |
|---|---|
filter -
ReleaseActivityFeedFilterArgs!
|
Only get activities of given types |
pagination -
CursorConnectionArgs!
|
Pagination parameters |
Example
{
"filter": ReleaseActivityFeedFilterArgs,
"pagination": CursorConnectionArgs
}
ReleaseActivityFeedTypeFilterOption
Description
Release activity feed type filter option
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ALL"
ReleaseAffiliate
Description
Release Affiliate entity
Fields
| Field Name | Description |
|---|---|
affiliateAddress -
String!
|
Address of the affiliate |
affiliateFeeEarned -
String!
|
Affiliate fee earned in wei for sales driven |
affiliateUser -
User!
|
User that is an affiliate. |
grossSalesDriven -
String!
|
Gross purchase volume driven in wei |
grossSalesDrivenUsd -
Float!
|
Gross purchase volume driven in usd |
id -
ID!
|
UUID of Release Affiliate entity |
nftQuantityDriven -
Int!
|
Count of nfts from sales driven |
release -
Release!
|
Release entity |
Example
{
"affiliateAddress": "abc123",
"affiliateFeeEarned": "xyz789",
"affiliateUser": User,
"grossSalesDriven": "xyz789",
"grossSalesDrivenUsd": 987.65,
"id": "4",
"nftQuantityDriven": 123,
"release": Release
}
ReleaseAffiliateConnection
Description
Paginated connection of Release Affiliates
Fields
| Field Name | Description |
|---|---|
edges -
[ReleaseAffiliateConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [ReleaseAffiliateConnectionEdge],
"pageInfo": PageInfo
}
ReleaseAffiliateConnectionEdge
Description
Edge of Release Affiliate Connection
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Cursor to be used for pagination |
node -
ReleaseAffiliate!
|
ReleaseAffiliate node |
Example
{
"cursor": "xyz789",
"node": ReleaseAffiliate
}
ReleaseAffiliateCursorConnectionArgs
Description
Pagination parameters for release affiliates
Fields
| Input Field | Description |
|---|---|
after -
String
|
Start forwards pagination since "after" cursor |
before -
String
|
Start backwards pagination since "before" cursor |
first -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "after", with a maximum of 51 nodes. |
last -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "before", with a maximum of 51 nodes. |
sort -
ReleaseAffiliateCursorConnectionSort!
|
Customize sort behavior |
Example
{
"after": "xyz789",
"before": "abc123",
"first": 123,
"last": 123,
"sort": ReleaseAffiliateCursorConnectionSort
}
ReleaseAffiliateCursorConnectionSort
Description
Customize sort of release affiliates
Fields
| Input Field | Description |
|---|---|
nftQuantityDriven -
SortOrder
|
Sort by amount nfts referred |
Example
{"nftQuantityDriven": "ASC"}
ReleaseAffiliateTotalPurchases
Description
Aggregate of all affiliate purchases of specific affiliate user and release
Fields
| Field Name | Description |
|---|---|
affiliate -
User!
|
Affiliate that referred the purchase |
earningsETH -
String!
|
Total of earnings in eth associated with affiliate purchases |
earningsWei -
String!
|
Total of earnings in wei associated with affiliate purchases |
id -
ID!
|
Unique identifier from release id and affiliate address |
purchasesQuantity -
Int!
|
Quantity of purchases |
referredCollectors -
ReleaseReferredCollectorConnection!
|
Referred users of release |
Arguments
|
|
release -
Release!
|
Release associated to affiliate purchases |
Example
{
"affiliate": User,
"earningsETH": "abc123",
"earningsWei": "xyz789",
"id": 4,
"purchasesQuantity": 123,
"referredCollectors": ReleaseReferredCollectorConnection,
"release": Release
}
ReleaseAffiliateTotalPurchasesConnection
Description
Paginated release affiliates total purchases connection
Fields
| Field Name | Description |
|---|---|
edges -
[ReleaseAffiliateTotalPurchasesEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [ReleaseAffiliateTotalPurchasesEdge],
"pageInfo": PageInfo
}
ReleaseAffiliateTotalPurchasesCursorConnectionArgs
Description
Pagination parameters for total release affiliate purchases
Fields
| Input Field | Description |
|---|---|
after -
String
|
Start forwards pagination since "after" cursor |
before -
String
|
Start backwards pagination since "before" cursor |
first -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "after", with a maximum of 25 nodes. |
last -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "before", with a maximum of 25 nodes. |
sort -
ReleaseAffiliateTotalPurchasesCursorConnectionSort!
|
Customize sort behavior |
Example
{
"after": "abc123",
"before": "abc123",
"first": 123,
"last": 123,
"sort": ReleaseAffiliateTotalPurchasesCursorConnectionSort
}
ReleaseAffiliateTotalPurchasesCursorConnectionSort
Description
Customize the sort behavior of release affiliates total purchases
Fields
| Input Field | Description |
|---|---|
blockNumber -
SortOrder
|
Sort by block number |
Example
{"blockNumber": "ASC"}
ReleaseAffiliateTotalPurchasesEdge
Description
ReleaseAffiliateTotalPurchases edge
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Cursor to be used for pagination |
node -
ReleaseAffiliateTotalPurchases!
|
ReleaseAffiliateTotalPurchases Entity |
Example
{
"cursor": "xyz789",
"node": ReleaseAffiliateTotalPurchases
}
ReleaseAlbumRevealFilterOption
Description
Release album reveal filter option
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ALL"
ReleaseAllowlistInput
ReleaseArweaveOutputs
ReleaseAudienceInput
Fields
| Input Field | Description |
|---|---|
nftTier -
NftTier
|
The NFT tier you want to select for AudienceMembers |
pagination -
AudienceMemberCursorConnectionArgs!
|
Pagination parameters |
releaseId -
UUID!
|
Release identifier |
Example
{
"nftTier": "ALL",
"pagination": AudienceMemberCursorConnectionArgs,
"releaseId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
ReleaseChart
Description
Release chart entity
Fields
| Field Name | Description |
|---|---|
chartRanks -
ReleaseChartRankConnection!
|
Chart ranks of release chart |
Arguments
|
|
id -
ID!
|
UUID of Release chart entity |
lastDayOfChartInclusive -
DateTime!
|
Last full day of the chart period (inclusive) |
periodEndExclusive -
DateTime!
|
Release chart period end exclusive |
periodStartInclusive -
DateTime!
|
Release chart period start inclusive |
Example
{
"chartRanks": ReleaseChartRankConnection,
"id": 4,
"lastDayOfChartInclusive": "2007-12-03T10:15:30Z",
"periodEndExclusive": "2007-12-03T10:15:30Z",
"periodStartInclusive": "2007-12-03T10:15:30Z"
}
ReleaseChartByLastDayInput
Description
Input for releaseChart query
Fields
| Input Field | Description |
|---|---|
lastDayOfChartInclusive -
DateTime!
|
Locate chart using the last date of the period (inclusive) |
Example
{
"lastDayOfChartInclusive": "2007-12-03T10:15:30Z"
}
ReleaseChartConnection
Description
Paginated connection of Release Charts
Fields
| Field Name | Description |
|---|---|
edges -
[ReleaseChartConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [ReleaseChartConnectionEdge],
"pageInfo": PageInfo
}
ReleaseChartConnectionEdge
Description
Edge of Release Chart Connection
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Cursor to be used for pagination |
node -
ReleaseChart!
|
Release Chart node |
Example
{
"cursor": "abc123",
"node": ReleaseChart
}
ReleaseChartCursorConnectionArgs
Description
Pagination paramaters for release charts
Fields
| Input Field | Description |
|---|---|
after -
String
|
Start forwards pagination since "after" cursor |
before -
String
|
Start backwards pagination since "before" cursor |
first -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "after", with a maximum of 51 nodes. |
last -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "before", with a maximum of 51 nodes. |
sort -
ReleaseChartCursorConnectionSort!
|
Customize sort behavior |
Example
{
"after": "xyz789",
"before": "xyz789",
"first": 123,
"last": 123,
"sort": ReleaseChartCursorConnectionSort
}
ReleaseChartCursorConnectionSort
Description
Customize sort of release charts
Fields
| Input Field | Description |
|---|---|
periodEndExclusive -
SortOrder
|
Sort by release chart period end exclusive |
Example
{"periodEndExclusive": "ASC"}
ReleaseChartInput
Description
Input for releaseChart query
Fields
| Input Field | Description |
|---|---|
periodEndExclusive -
DateTime!
|
Filter on periodEnd date |
Example
{
"periodEndExclusive": "2007-12-03T10:15:30Z"
}
ReleaseChartRank
Description
Release chart rank entity
Fields
| Field Name | Description |
|---|---|
currentRank -
Int!
|
Current ranking of release |
id -
ID!
|
UUID of Release chart entity |
rankLast -
Int
|
Last ranking of release |
rankPeak -
Int
|
Peak ranking of release |
release -
Release!
|
Chart rank release |
trendingIndicator -
TrendingIndicator!
|
Trending indicator of release |
trendingStreak -
Int!
|
Trending streak of release |
Example
{
"currentRank": 123,
"id": "4",
"rankLast": 987,
"rankPeak": 123,
"release": Release,
"trendingIndicator": "DOWN",
"trendingStreak": 987
}
ReleaseChartRankConnection
Description
Paginated connection of Release Chart Ranks
Fields
| Field Name | Description |
|---|---|
edges -
[ReleaseChartRankConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [ReleaseChartRankConnectionEdge],
"pageInfo": PageInfo
}
ReleaseChartRankConnectionEdge
Description
Edge of Release Chart Rank Connection
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Cursor to be used for pagination |
node -
ReleaseChartRank!
|
Release Chart Rank node |
Example
{
"cursor": "xyz789",
"node": ReleaseChartRank
}
ReleaseChartRankCursorConnectionArgs
Description
Pagination paramaters for release chart ranks
Fields
| Input Field | Description |
|---|---|
after -
String
|
Start forwards pagination since "after" cursor |
before -
String
|
Start backwards pagination since "before" cursor |
first -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "after", with a maximum of 51 nodes. |
last -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "before", with a maximum of 51 nodes. |
sort -
ReleaseChartRankCursorConnectionSort!
|
Customize sort behavior |
Example
{
"after": "abc123",
"before": "xyz789",
"first": 123,
"last": 123,
"sort": ReleaseChartRankCursorConnectionSort
}
ReleaseChartRankCursorConnectionSort
Description
Customize sort of collectors
Fields
| Input Field | Description |
|---|---|
currentRank -
SortOrder
|
Sort by release chart current rank |
Example
{"currentRank": "ASC"}
ReleaseChartRankInput
Description
Input for releaseChartRank query
Fields
| Input Field | Description |
|---|---|
id -
UUID!
|
Release Chart Rank entity id |
Example
{
"id": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
ReleaseChartsInput
Description
Input for releaseChart query
Fields
| Input Field | Description |
|---|---|
pagination -
ReleaseChartCursorConnectionArgs!
|
Cursor connection parameters |
Example
{"pagination": ReleaseChartCursorConnectionArgs}
ReleaseChartsPeriodRange
Description
Latest supported ranges for ReleaseCharts
Example
{
"earliestPeriodStartInclusive": "2007-12-03T10:15:30Z",
"latestPeriodEndExclusive": "2007-12-03T10:15:30Z"
}
ReleaseCollector
Description
Release collector
Fields
| Field Name | Description |
|---|---|
firstNftCollected -
Nft!
|
First release nft collected by user |
firstNftCollectedDate -
DateTime!
|
Date of first nft collected |
gaNftsCount -
Int!
|
Amount of ga release nfts owned |
id -
ID!
|
Unique id of release collector |
lowestNftSerialNumber -
Int!
|
Lowest nft serial number collected |
lowestSerialNumberNftCollected -
Nft!
|
Lowest serial number release nft collected by user |
mostRecentNftWithComment -
Nft
|
Most recent release nft collected by user with a comment |
nftsCount -
Int!
|
Amount of release nfts owned |
ownedGoldenEgg -
EggGame
|
Returns golden egg of release if user owns, otherwise null |
release -
Release!
|
Release entity |
tierPriority -
Int!
|
Tier priority of the nft |
user -
User!
|
Collector user |
vipNftsCount -
Int!
|
Amount of vip release nfts owned |
volumeSpent -
String!
|
Amount spent on nfts owned |
Example
{
"firstNftCollected": Nft,
"firstNftCollectedDate": "2007-12-03T10:15:30Z",
"gaNftsCount": 123,
"id": 4,
"lowestNftSerialNumber": 987,
"lowestSerialNumberNftCollected": Nft,
"mostRecentNftWithComment": Nft,
"nftsCount": 987,
"ownedGoldenEgg": EggGame,
"release": Release,
"tierPriority": 987,
"user": User,
"vipNftsCount": 123,
"volumeSpent": "abc123"
}
ReleaseCollectorConnection
Description
Paginated connection of Release Collectors
Fields
| Field Name | Description |
|---|---|
edges -
[ReleaseCollectorConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [ReleaseCollectorConnectionEdge],
"pageInfo": PageInfo
}
ReleaseCollectorConnectionEdge
Description
Edge of Release Collector Connection
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Cursor to be used for pagination |
node -
ReleaseCollector!
|
ReleaseCollector node |
Example
{
"cursor": "abc123",
"node": ReleaseCollector
}
ReleaseCollectorCursorConnectionArgs
Description
Pagination parameters for release collectors
Fields
| Input Field | Description |
|---|---|
after -
String
|
Start forwards pagination since "after" cursor |
before -
String
|
Start backwards pagination since "before" cursor |
first -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "after", with a maximum of 51 nodes. |
last -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "before", with a maximum of 51 nodes. |
sort -
ReleaseCollectorCursorConnectionSort!
|
Customize sort behavior |
tier -
TierNFT
|
The NFT tier you want to select for ReleaseCollectors, defaults All |
Example
{
"after": "abc123",
"before": "xyz789",
"first": 123,
"last": 123,
"sort": ReleaseCollectorCursorConnectionSort,
"tier": "ALL"
}
ReleaseCollectorCursorConnectionSort
Description
Customize sort of collectors
Fields
| Input Field | Description |
|---|---|
firstNftCollectedDate -
SortOrder
|
Sort by first nft collected date |
gaNftsCount -
SortOrder
|
Sort by amount ga nfts collected, with tie-breaker of earliest collector first |
lowestOwnedSerialNumber -
SortOrder
|
Sort by lowest owned serial number |
nftsCount -
SortOrder
|
Sort by amount nfts collected, with tie-breaker of earliest collector first |
priorityFirstNftDate -
SortOrder
|
Sort by vips first, then ga, tie-breaker of first nft collected date |
priorityTop -
SortOrder
|
Sort by vips first, then ga, tie-breaker most nfts collected |
vipNftsCount -
SortOrder
|
Sort by amount vip nfts collected, with tie-breaker of earliest collector first |
Example
{
"firstNftCollectedDate": "ASC",
"gaNftsCount": "ASC",
"lowestOwnedSerialNumber": "ASC",
"nftsCount": "ASC",
"priorityFirstNftDate": "ASC",
"priorityTop": "ASC",
"vipNftsCount": "ASC"
}
ReleaseCollectorUpdates
Description
Release collector updates from subscription
Fields
| Field Name | Description |
|---|---|
collector -
CollectorUpdateInfo
|
Release collector information. null if user is no longer collector |
releaseId -
ID!
|
Release unique identifier |
userPublicAddress -
String!
|
Wallet public address of user |
Example
{
"collector": CollectorUpdateInfo,
"releaseId": "4",
"userPublicAddress": "xyz789"
}
ReleaseCollectorWaveformPostAttr
Description
Release collector waveform post
Fields
| Field Name | Description |
|---|---|
content -
String!
|
Content of the post |
gaNftsCount -
Int!
|
Amount of ga nfts owned |
id -
ID!
|
ReleaseCollectorWaveformPost identifier |
lexicalContent -
JSON
|
Lexical content of the post |
nftsCount -
Int!
|
Amount of nfts owned |
postId -
ID!
|
Post identifier |
songSlot -
Int!
|
Selected song slot (0-99) associated with the post |
updatedAt -
DateTime!
|
Date of last update |
user -
User!
|
Collector user |
vipNftsCount -
Int!
|
Amount of vip nfts owned |
Example
{
"content": "xyz789",
"gaNftsCount": 987,
"id": "4",
"lexicalContent": {},
"nftsCount": 987,
"postId": 4,
"songSlot": 987,
"updatedAt": "2007-12-03T10:15:30Z",
"user": User,
"vipNftsCount": 123
}
ReleaseCollectorsAllowlist
Description
Info associated with release draft allowlist
Fields
| Field Name | Description |
|---|---|
allArtistCollaborations -
Boolean!
|
Flag to include or not include all artist collaborations |
allArtistReleases -
Boolean!
|
Flag to include or not include all artist releases |
filteredReleases -
ReleaseConnection!
|
Paginated releases of draftAllowlist taking into account artist releases and collaborator flags |
totalCollectors -
Int!
|
Total number of release collector users in draft allowlist |
Example
{
"allArtistCollaborations": true,
"allArtistReleases": true,
"filteredReleases": ReleaseConnection,
"totalCollectors": 987
}
ReleaseConnection
Description
Paginated releases connection
Fields
| Field Name | Description |
|---|---|
edges -
[ReleaseConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [ReleaseConnectionEdge],
"pageInfo": PageInfo
}
ReleaseConnectionEdge
ReleaseContractEarning
Description
Union of release contract types
Types
| Union Types |
|---|
Example
ArtistContractEarning
ReleaseDetailsInput
Description
Input values for release admin update
Example
{
"behindTheMusic": "abc123",
"description": "xyz789",
"season": "abc123",
"title": "abc123",
"titleSlug": "xyz789",
"type": "xyz789"
}
ReleaseDropped
Description
Release dropped action entity
Example
{
"date": "2007-12-03T10:15:30Z",
"id": 4,
"release": Release,
"user": User
}
ReleaseDroppedAggregate
Description
Release dropped aggregate
Fields
| Field Name | Description |
|---|---|
post -
Post
|
Post backing this particular activity feed group. Used for upvote, comment interactions. It is always NULL if this activity feed group is in a personal feed. Otherwise NULL if no backing post exists |
release -
Release!
|
Release dropped action in activity feed group |
Example
{"post": Post, "release": Release}
ReleaseEarnings
Description
Release earnings of a user
Fields
| Field Name | Description |
|---|---|
earning -
ReleaseContractEarning!
|
Earnings on a contract. |
id -
ID!
|
Id of the associated release |
ownershipPercent -
Float!
|
Ownership percentage of the user in the release |
primaryRevenue -
String!
|
release primary revenue |
release -
Release!
|
Release entity |
secondaryRoyalties -
String!
|
Release secondary royalties |
splitContract -
SplitsContractEarning
|
Split contract earnings associated to release. |
splitMainBalanceFromRelease -
String!
|
Split main balance attributable to release |
totalWithdrawableForUser -
String!
|
Total withdrawable amount for user |
Example
{
"earning": ArtistContractEarning,
"id": "4",
"ownershipPercent": 123.45,
"primaryRevenue": "xyz789",
"release": Release,
"secondaryRoyalties": "xyz789",
"splitContract": SplitsContractEarning,
"splitMainBalanceFromRelease": "abc123",
"totalWithdrawableForUser": "abc123"
}
ReleaseEarningsConnection
Description
Paginated connection of Release Earnings
Fields
| Field Name | Description |
|---|---|
edges -
[ReleaseEarningsConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [ReleaseEarningsConnectionEdge],
"pageInfo": PageInfo
}
ReleaseEarningsConnectionEdge
Description
Edge of Release Earnings Connection
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Cursor to be used for pagination |
node -
ReleaseEarnings!
|
Release Earnings node |
Example
{
"cursor": "xyz789",
"node": ReleaseEarnings
}
ReleaseFeaturedStatus
Description
Release featured status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ALL"
ReleaseFromTokenInput
ReleaseInfo
Description
Simplified version of Release entity
Fields
| Field Name | Description |
|---|---|
artistId -
String!
|
Release artistId |
artistName -
String!
|
Artist name of release |
artistUserId -
String!
|
Artist user id |
coverImage -
Media!
|
Cover image of release |
creditUserIds -
[String!]!
|
User ids of release credits |
id -
ID!
|
Unique identifier of Artist |
staticCoverImage -
Media
|
Static version of animated cover image of release if the cover is a GIF. Otherwise, null |
title -
String!
|
Release title |
Example
{
"artistId": "xyz789",
"artistName": "abc123",
"artistUserId": "xyz789",
"coverImage": Media,
"creditUserIds": ["abc123"],
"id": "4",
"staticCoverImage": Media,
"title": "xyz789"
}
ReleaseInfoUploadStepInput
Description
Release info upload step input values
Fields
| Input Field | Description |
|---|---|
beatsPerMinute -
NonNegativeInt
|
Release beats per minute |
behindTheMusic -
String!
|
Behind the music text |
coverImage -
UploadedMedia!
|
Cover image |
genre -
String!
|
Release genre |
key -
SongKeyType
|
Release key |
license -
LicenseType
|
License for the release |
location -
CountryCode
|
Location where the release was created |
lyrics -
String
|
Release lyrics |
staticCoverImage -
UploadedMedia
|
Static cover image to use in place of animated cover image |
title -
String!
|
Title |
tokenSymbol -
String!
|
Token symbol |
tracks -
[TrackUpload!]!
|
Uploaded tracks |
type -
ReleaseType!
|
Release type |
Example
{
"beatsPerMinute": 123,
"behindTheMusic": "xyz789",
"coverImage": UploadedMedia,
"genre": "abc123",
"key": "A_FLAT_MAJOR",
"license": "ALL_RIGHTS_RESERVED",
"location": "US",
"lyrics": "abc123",
"staticCoverImage": UploadedMedia,
"title": "abc123",
"tokenSymbol": "abc123",
"tracks": [TrackUpload],
"type": "ALBUM"
}
ReleaseLiked
Description
Release liked action entity
Example
{
"date": "2007-12-03T10:15:30Z",
"id": "4",
"release": Release,
"user": User
}
ReleaseManuallyAddedAddressesAllowlist
Description
Allowlist containing all manually added addresses
Example
{
"description": "abc123",
"id": "4",
"totalAddresses": 987
}
ReleaseMerkleAllowlist
Description
Release allowlist behind merkle tree
Fields
| Field Name | Description |
|---|---|
createdAt -
DateTime!
|
Creation date of allowlist |
id -
ID!
|
Unique identifier of merkle allowlist of release |
info -
ReleaseMerkleAllowlistInfo!
|
Static information associated with allowlist |
manuallyAddedAddresses -
ReleaseManuallyAddedAddressesAllowlist
|
Manually added addresses by artist |
releaseCollaborationsSources -
ReleaseSourceSubAllowlistConnection
|
Pagination of releases from collaborations |
Arguments
|
|
selectedArtistSources -
ArtistSourceSelectedAllowlistConnection
|
Pagination of manually selected artists |
Arguments
|
|
selectedReleaseSources -
ReleaseSourceSubAllowlistConnection
|
Pagination of manually selected releases |
Arguments
|
|
totalUsers -
Int!
|
Total number of users in allowlist |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"id": 4,
"info": ReleaseMerkleAllowlistInfo,
"manuallyAddedAddresses": ReleaseManuallyAddedAddressesAllowlist,
"releaseCollaborationsSources": ReleaseSourceSubAllowlistConnection,
"selectedArtistSources": ArtistSourceSelectedAllowlistConnection,
"selectedReleaseSources": ReleaseSourceSubAllowlistConnection,
"totalUsers": 123
}
ReleaseMerkleAllowlistInfo
Description
Release allowlist information
Fields
| Field Name | Description |
|---|---|
allArtistCollaborations -
Boolean!
|
Flag to include or not include all artist collaborations |
allArtistCollectors -
Boolean!
|
Flag to include or not include all collectors of release artist |
manuallyAddedAddresses -
[String!]
|
Manually added addresses |
sourceSelectedArtistIds -
[String!]
|
Manually selected artist identifiers |
sourceSelectedReleaseIds -
[String!]
|
Manually selected release identifiers |
Example
{
"allArtistCollaborations": true,
"allArtistCollectors": false,
"manuallyAddedAddresses": ["xyz789"],
"sourceSelectedArtistIds": ["xyz789"],
"sourceSelectedReleaseIds": ["abc123"]
}
ReleaseMetaInput
ReleaseMinted
Description
A release was minted by users
Fields
| Field Name | Description |
|---|---|
featuredCollectors -
[User!]!
|
Featured collectors |
id -
ID!
|
UserNotification UUID |
numTotalCollectors -
Int!
|
Number of total collectors in this group |
numTotalMints -
Int!
|
Number of total mints in this group |
release -
Release
|
Minted release entity |
timestamp -
Timestamp!
|
Timestamp for notification |
user -
User
|
Recipient user entity |
Example
{
"featuredCollectors": [User],
"id": 4,
"numTotalCollectors": 123,
"numTotalMints": 987,
"release": Release,
"timestamp": 1592577642,
"user": User
}
ReleaseNftWithCommentUpdate
Description
Release NFT Update
Fields
| Field Name | Description |
|---|---|
commentMessage -
String!
|
Possible comment associated with NFT |
contractAddress -
String!
|
Contract address associated with nft |
id -
ID!
|
Unique identifier of NFT |
isBurned -
Boolean!
|
Was the NFT burned |
isGoldenEgg -
Boolean!
|
Is the NFT the golden egg |
ownerArtistId -
ID
|
If user is an artist, the artist unique identifier |
ownerArtistName -
String
|
If user is an artist, the artist name |
ownerArtistSoundHandle -
String
|
If user is an artist, the artist sound handle |
ownerAvatarUrl -
String
|
Possible avatar URL of NFT owner |
ownerPublicAddress -
String!
|
User wallet public address |
ownerReleaseLowestNftSerialNumber -
Int!
|
Serial number of the lowest owned nft of the collected release |
ownerReleaseNftCount -
Int!
|
Amount of NFTs owned by collector on the same release |
ownerUserId -
ID!
|
User unique identifier of owner |
ownerUsername -
String!
|
Username of NFT owner |
ownerWebappUri -
String!
|
User webapp uri |
serialNumber -
Int!
|
Serial number of nft within release |
songSlot -
Int!
|
Selected song slot associated with nft |
tokenId -
String!
|
Unique token identifier of nft |
updatedAt -
DateTime!
|
Date of last ownership transfer |
Example
{
"commentMessage": "abc123",
"contractAddress": "abc123",
"id": "4",
"isBurned": false,
"isGoldenEgg": false,
"ownerArtistId": "4",
"ownerArtistName": "xyz789",
"ownerArtistSoundHandle": "abc123",
"ownerAvatarUrl": "abc123",
"ownerPublicAddress": "xyz789",
"ownerReleaseLowestNftSerialNumber": 987,
"ownerReleaseNftCount": 123,
"ownerUserId": 4,
"ownerUsername": "xyz789",
"ownerWebappUri": "xyz789",
"serialNumber": 987,
"songSlot": 987,
"tokenId": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
ReleasePost
Description
Release Post entity
Fields
| Field Name | Description |
|---|---|
authorChannelRole -
ChannelCuratorRole
|
Channel role of the author (null if they are not a curator) |
authorNftsCountGa -
Int
|
Number of ga nfts of the associated release the author holds |
authorNftsCountVip -
Int
|
Number of vip nfts of the associated release the author holds |
channel -
Channel
|
Channel that the post was posted to |
commentCount -
Int!
|
Number of comments on the post |
comments -
PostCommentConnection!
|
Comments on the post |
Arguments
|
|
content -
String!
|
Content of the post |
createdAt -
DateTime!
|
Creation date of entity |
creator -
User!
|
User who created the post |
farcasterHash -
String
|
Farcaster hash of the post |
id -
ID!
|
Unique identifier of the Post |
lexicalContent -
JSON
|
Lexical content of the post |
optionalRelease -
Release
|
The release associated with the post |
repostCount -
Int!
|
Number of reposts on the post |
upvoteCount -
Int!
|
Number of upvotes on the post |
waveformPostAttr -
ReleaseCollectorWaveformPostAttr
|
Waveform post attribute |
webappUri -
String!
|
Webapp URI of Post |
Example
{
"authorChannelRole": "MODERATOR",
"authorNftsCountGa": 123,
"authorNftsCountVip": 123,
"channel": Channel,
"commentCount": 123,
"comments": PostCommentConnection,
"content": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"creator": User,
"farcasterHash": "abc123",
"id": "4",
"lexicalContent": {},
"optionalRelease": Release,
"repostCount": 123,
"upvoteCount": 987,
"waveformPostAttr": ReleaseCollectorWaveformPostAttr,
"webappUri": "abc123"
}
ReleasePresaved
Description
A release was presaved by one or more users
Fields
| Field Name | Description |
|---|---|
featuredUsers -
[User!]!
|
Featured users that presaved the release |
id -
ID!
|
UserNotification UUID |
numUsers -
Int!
|
Number of users that presaved within the group |
release -
Release!
|
Presaved release entity |
timestamp -
Timestamp!
|
Timestamp for notification |
user -
User
|
Recipient user entity |
Example
{
"featuredUsers": [User],
"id": "4",
"numUsers": 987,
"release": Release,
"timestamp": 1592577642,
"user": User
}
ReleaseReferredCollector
Description
Referred collector data within a release
Fields
| Field Name | Description |
|---|---|
earningsETH -
String!
|
Total of earnings in eth associated with affiliate purchases |
earningsWei -
String!
|
Total of earnings in wei associated with affiliate purchases |
id -
ID!
|
Unique identifier on referred collector within release and affiliate |
purchasesQuantity -
Int!
|
Amount of editions sold by referred collector for release and affiliate |
user -
User!
|
User entity of referred collector |
Example
{
"earningsETH": "abc123",
"earningsWei": "abc123",
"id": "4",
"purchasesQuantity": 987,
"user": User
}
ReleaseReferredCollectorConnection
Description
Paginated connection of referred collectors
Fields
| Field Name | Description |
|---|---|
edges -
[ReleaseReferredCollectorEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [ReleaseReferredCollectorEdge],
"pageInfo": PageInfo
}
ReleaseReferredCollectorEdge
Description
Edge of ReleaseReferredCollector
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Cursor to be used for pagination |
node -
ReleaseReferredCollector!
|
Release referred collector node |
Example
{
"cursor": "xyz789",
"node": ReleaseReferredCollector
}
ReleaseSearchFilter
Description
Filter the releases to be searched
Fields
| Input Field | Description |
|---|---|
artistIds -
[UUID!]
|
Filter releases that are made by specified artists. You can only specify up to 51 artists. |
genres -
[Genres!]
|
Genre names to filter on for releases |
hasCollectors -
Boolean
|
Only include releases that either have or don't have collectors |
locationIds -
[String!]
|
Location ids to filter on for releases |
releaseStatus -
[ReleaseStatus!]
|
Only get release with specified status |
type -
[ReleaseType!]
|
Filters on release type |
Example
{
"artistIds": [
"6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
],
"genres": ["AFROBEAT"],
"hasCollectors": false,
"locationIds": ["xyz789"],
"releaseStatus": ["AVAILABLE_TO_MINT"],
"type": ["ALBUM"]
}
ReleaseShelvesCursorConnectionArgs
Description
Pagination parameters of release shelves
Fields
| Input Field | Description |
|---|---|
after -
String
|
Start forwards pagination since "after" cursor |
before -
String
|
Start backwards pagination since "before" cursor |
first -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "after", with a maximum of 51 nodes. |
last -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "before", with a maximum of 51 nodes. |
sort -
ReleaseShelvesCursorConnectionSort!
|
Customize sort behavior |
Example
{
"after": "abc123",
"before": "xyz789",
"first": 123,
"last": 123,
"sort": ReleaseShelvesCursorConnectionSort
}
ReleaseShelvesCursorConnectionSort
ReleaseShelvesFilter
Description
Filter release shelves
Fields
| Input Field | Description |
|---|---|
shelfIds -
[UUID!]
|
Filter shelves to be included by identifier. You can only specify up to 51 shelves. |
type -
[ShelfType!]
|
Filter shelves types to be included |
Example
{
"shelfIds": [
"6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
],
"type": ["DEFAULT"]
}
ReleaseSortInput
Description
Defines sort order of Release fields, array index defines tiebreaking
Fields
| Input Field | Description |
|---|---|
field -
SearchReleasesSortEnum!
|
Field to be sorted |
order -
SortOrder!
|
Sort ascending or descending |
Example
{"field": "MINT_START_TIME", "order": "ASC"}
ReleaseSourceSubAllowlist
Description
Allowlists of releases used as source of collectors
Example
{"id": 4, "sourceRelease": Release, "totalAddresses": 123}
ReleaseSourceSubAllowlistConnection
Description
Connection entity of release source allowlist
Fields
| Field Name | Description |
|---|---|
edges -
[ReleaseSourceSubAllowlistEdge!]!
|
List of edges of pagination |
pageInfo -
PageInfo!
|
Pagination info helpers |
Example
{
"edges": [ReleaseSourceSubAllowlistEdge],
"pageInfo": PageInfo
}
ReleaseSourceSubAllowlistEdge
Description
Edge of connection for release source allowlist
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Pagination cursor |
node -
ReleaseSourceSubAllowlist!
|
Pagination node |
Example
{
"cursor": "xyz789",
"node": ReleaseSourceSubAllowlist
}
ReleaseStatus
Description
Release current status type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"AVAILABLE_TO_MINT"
ReleaseType
Description
Release type, currently the platform only supports "SINGLE"
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ALBUM"
ReleaseUnliked
Description
Release unliked action entity
Example
{
"date": "2007-12-03T10:15:30Z",
"id": 4,
"release": Release,
"user": User
}
ReleaseUpdates
Description
Release updates from subscription
Fields
| Field Name | Description |
|---|---|
chainId -
Int!
|
Chain ID on which release is minted on |
finalQuantity -
Int
|
Final quantity for a release. Will be defined as soon as a max quantity has been determined |
id -
ID!
|
Release identifier |
isFirstPhaseCompleted -
Boolean!
|
Is release sold out relative to the final quantity on first phase |
mintStartTimestamp -
Timestamp!
|
Public sale start timestamp |
numSold -
Int!
|
Amount of sold NFTs |
primaryCollected -
Int!
|
Number of nfts collected during primary sale |
primaryRaisedInWei -
String!
|
Aggregate raised during primary sale |
samBuyBufferBpsOverride -
Int
|
Override for the SAM buy buffer in basis points (bps) for this release |
samSellBufferBpsOverride -
Int
|
Override for the SAM sell buffer in basis points (bps) for this release |
soundSwapCollected -
Int!
|
Number of nfts collected during sound swap sale |
soundSwapRaisedInWei -
String!
|
Aggregate raised during sound swap sale |
title -
String!
|
Title of release |
totalMinted -
Int!
|
Total minted NFTs |
totalSupply -
Int!
|
Total supply of NFTs |
totalVolume -
String!
|
Aggregate raised during sound swap sale |
Example
{
"chainId": 123,
"finalQuantity": 123,
"id": 4,
"isFirstPhaseCompleted": false,
"mintStartTimestamp": 1592577642,
"numSold": 123,
"primaryCollected": 123,
"primaryRaisedInWei": "abc123",
"samBuyBufferBpsOverride": 987,
"samSellBufferBpsOverride": 123,
"soundSwapCollected": 987,
"soundSwapRaisedInWei": "xyz789",
"title": "abc123",
"totalMinted": 987,
"totalSupply": 123,
"totalVolume": "xyz789"
}
ReleaseWebEmbedInput
Description
Input for Release.webEmbed
Fields
| Input Field | Description |
|---|---|
html -
IframeHtmlParameters!
|
Customize html parameters |
referralAddress -
Address
|
Referral address |
Example
{
"html": IframeHtmlParameters,
"referralAddress": Address
}
ReleaseWebappUriInput
Description
Customize webapp uri parameters of release
Fields
| Input Field | Description |
|---|---|
referralAddress -
Address
|
Referral address |
Example
{"referralAddress": Address}
ReleasesAddedRemovedFromPlaylist
Description
Releases added AND removed to a playlist in the same playlist action entity
Fields
| Field Name | Description |
|---|---|
addedReleases -
ReleaseConnection!
|
Releases added to playlist |
Arguments
|
|
date -
DateTime!
|
Date of action |
id -
ID!
|
Action id |
numAddedReleases -
Int!
|
Total number of releases added to the playlist |
numRemovedReleases -
Int!
|
Total number of releases removed from the playlist |
playlist -
Shelf
|
Shelf entity |
removedReleases -
ReleaseConnection!
|
Releases removed from playlist |
Arguments
|
|
user -
User!
|
User corresponding to action entity |
Example
{
"addedReleases": ReleaseConnection,
"date": "2007-12-03T10:15:30Z",
"id": 4,
"numAddedReleases": 123,
"numRemovedReleases": 987,
"playlist": Shelf,
"removedReleases": ReleaseConnection,
"user": User
}
ReleasesAddedToPlaylist
Description
Releases added to playlist action entity
Fields
| Field Name | Description |
|---|---|
addedReleases -
ReleaseConnection!
|
New releases added to playlist |
Arguments
|
|
date -
DateTime!
|
Date of action |
id -
ID!
|
Action id |
isPlaylistCreated -
Boolean!
|
Returns whether playlist was created with this action |
numAddedReleases -
Int!
|
Total number of releases added to the playlist |
playlist -
Shelf
|
Shelf entity |
user -
User!
|
User corresponding to action entity |
Example
{
"addedReleases": ReleaseConnection,
"date": "2007-12-03T10:15:30Z",
"id": 4,
"isPlaylistCreated": true,
"numAddedReleases": 987,
"playlist": Shelf,
"user": User
}
ReleasesAddedToShelfAggregate
Description
Releases added to shelf aggregate
Fields
| Field Name | Description |
|---|---|
releasesAdded -
[ShelfRelease!]!
|
New releases added to shelf in an activity feed group |
shelf -
Shelf
|
Shelf that releases are added to in activity feed group |
Example
{
"releasesAdded": [ShelfRelease],
"shelf": Shelf
}
ReleasesCollectorSortEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"FIRST_NFT_COLLECTED_DATE"
ReleasesCursorConnectionArgs
Description
Pagination parameters for releases connection
Fields
| Input Field | Description |
|---|---|
after -
String
|
Start forwards pagination since "after" cursor |
before -
String
|
Start backwards pagination since "before" cursor |
first -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "after", with a maximum of 51 nodes. |
last -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "before", with a maximum of 51 nodes. |
skip -
NonNegativeInt
|
Start after the first "skip" entities based. It can't be specified alongside "after" or "before" |
sort -
ReleasesCursorConnectionSort!
|
Customize sort behavior of releases pagination |
Example
{
"after": "abc123",
"before": "xyz789",
"first": 123,
"last": 123,
"skip": 123,
"sort": ReleasesCursorConnectionSort
}
ReleasesCursorConnectionSort
ReleasesCursorFilterArgs
Description
Filter releases
Fields
| Input Field | Description |
|---|---|
artistFollowedByUser -
UUID
|
Filter by getting releases of the artists followed by the specified user identifier |
contracts -
[ContractReleaseInput!]
|
Specify up to 50 contracts to filter the releases |
featuredStatus -
ReleaseFeaturedStatus
|
Filters on release featured status |
genres -
[Genres!]
|
Only get releases from specified genres |
hideFeatured -
Boolean
|
Remove currently-featured releases from results |
locationIds -
[String!]
|
Location ids to filter on for releases |
mintTimeMaxDate -
Timestamp
|
Only get releases less or equal to than specified mint time |
mintTimeMinDate -
Timestamp
|
Only get releases greater than or equal to specified mint time |
mintTimeStatus -
[MintTimeStatus!]
|
Only get release with specified mint time status |
releaseAlbumRevealStatus -
ReleaseAlbumRevealFilterOption
|
Filters on whether album releases have been revealed or not |
releaseStatus -
[ReleaseStatus!]
|
Only get release with specified status |
releaseType -
[ReleaseType!]
|
Filters on release type |
season -
[ArtistSeason!]
|
Only get releases from specified seasons |
Example
{
"artistFollowedByUser": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"contracts": [ContractReleaseInput],
"featuredStatus": "ALL",
"genres": ["AFROBEAT"],
"hideFeatured": true,
"locationIds": ["xyz789"],
"mintTimeMaxDate": 1592577642,
"mintTimeMinDate": 1592577642,
"mintTimeStatus": ["PAST"],
"releaseAlbumRevealStatus": "ALL",
"releaseStatus": ["AVAILABLE_TO_MINT"],
"releaseType": ["ALBUM"],
"season": ["GENESIS"]
}
ReleasesRemovedFromPlaylist
Description
Release removed from playlist entity
Fields
| Field Name | Description |
|---|---|
date -
DateTime!
|
Date of action |
id -
ID!
|
Action id |
numRemovedReleases -
Int!
|
Total number of releases removed from the playlist |
playlist -
Shelf
|
Shelf entity |
releaseRemoved -
Release!
|
First release removed from playlist |
removedReleases -
ReleaseConnection!
|
Releases removed from playlist |
Arguments
|
|
user -
User!
|
User corresponding to action entity |
Example
{
"date": "2007-12-03T10:15:30Z",
"id": "4",
"numRemovedReleases": 123,
"playlist": Shelf,
"releaseRemoved": Release,
"removedReleases": ReleaseConnection,
"user": User
}
RemoveReleaseFromShelfInput
ReportPlayStoppedInput
Description
Input for reportPlayStopped mutation
Fields
| Input Field | Description |
|---|---|
finish -
Timestamp!
|
End of play session |
listenDuration -
Int!
|
Duration of play in seconds |
pauseCount -
Int!
|
Amount of pauses on the same session |
start -
Timestamp!
|
Start of play session |
trackId -
UUID!
|
Track UUID |
uuid -
String!
|
Random UUID generated by client-side |
Example
{
"finish": 1592577642,
"listenDuration": 987,
"pauseCount": 123,
"start": 1592577642,
"trackId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"uuid": "abc123"
}
Repost
Description
Repost of another existing post entity
Fields
| Field Name | Description |
|---|---|
authorChannelRole -
ChannelCuratorRole
|
Channel role of the author (null if they are not a curator) |
channel -
Channel
|
Channel that the post was posted to |
commentCount -
Int!
|
Number of comments on the post |
comments -
PostCommentConnection!
|
Comments on the post |
Arguments
|
|
content -
String!
|
Content of the post |
createdAt -
DateTime!
|
Creation date of entity |
creator -
User!
|
User who created the post |
farcasterHash -
String
|
Farcaster hash of the post |
id -
ID!
|
Unique identifier of the Post |
lexicalContent -
JSON
|
Lexical content of the post |
originalPost -
Post
|
The original post that was reposted |
repostCount -
Int!
|
Number of reposts on the post |
reposterNftsCountGa -
Int
|
Number of ga nfts of the associated release the reposter holds |
reposterNftsCountVip -
Int
|
Number of vip nfts of the associated release the reposter holds |
upvoteCount -
Int!
|
Number of upvotes on the post |
webappUri -
String!
|
Webapp URI of Post |
Example
{
"authorChannelRole": "MODERATOR",
"channel": Channel,
"commentCount": 123,
"comments": PostCommentConnection,
"content": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"creator": User,
"farcasterHash": "abc123",
"id": "4",
"lexicalContent": {},
"originalPost": Post,
"repostCount": 123,
"reposterNftsCountGa": 987,
"reposterNftsCountVip": 123,
"upvoteCount": 123,
"webappUri": "abc123"
}
Reward
RewardInput
RewardUploadStepInfo
RewardsEditStepInfo
Description
Release edit info upload step info
Fields
| Field Name | Description |
|---|---|
canCollectorsDownloadAudio -
Boolean
|
Can collectors download audio |
curatorRewardsEnabled -
Boolean
|
Toggle for curator rewards |
goldenEggImages -
[MediaUploadStepInfo!]
|
Special golden egg images |
rewards -
[RewardUploadStepInfo!]
|
Custom rewards |
Example
{
"canCollectorsDownloadAudio": false,
"curatorRewardsEnabled": true,
"goldenEggImages": [MediaUploadStepInfo],
"rewards": [RewardUploadStepInfo]
}
RewardsUploadStepInfo
Description
Release info upload step info
Fields
| Field Name | Description |
|---|---|
canCollectorsDownloadAudio -
Boolean!
|
Can collectors download audio |
curatorRewardsEnabled -
Boolean!
|
Toggle for curator rewards |
goldenEggImages -
[MediaUploadStepInfo!]!
|
Special golden egg images |
rewards -
[RewardUploadStepInfo!]!
|
Custom rewards |
Example
{
"canCollectorsDownloadAudio": true,
"curatorRewardsEnabled": true,
"goldenEggImages": [MediaUploadStepInfo],
"rewards": [RewardUploadStepInfo]
}
RewardsUploadStepInput
Description
Release rewards upload step input values
Fields
| Input Field | Description |
|---|---|
canCollectorsDownloadAudio -
Boolean
|
Whether collectors can download audio |
curatorRewardsEnabled -
Boolean
|
Toggle for curator rewards |
goldenEggImages -
[UploadedMedia!]!
|
Special golden egg images |
rewards -
[RewardInput!]
|
Custom rewards |
Example
{
"canCollectorsDownloadAudio": false,
"curatorRewardsEnabled": false,
"goldenEggImages": [UploadedMedia],
"rewards": [RewardInput]
}
SaleDetails
Description
Release sale details
Fields
| Field Name | Description |
|---|---|
primaryCollected -
Int!
|
Number of nfts collected during primary sale |
primaryRaisedInWei -
String!
|
Aggregate raised during primary sale |
soundSwapCollected -
Int!
|
Number of nfts collected during sound swap sale |
soundSwapRaisedInWei -
String!
|
Aggregate raised during sound swap sale |
totalVolume -
String!
|
Aggregate raised during sound swap sale |
Example
{
"primaryCollected": 123,
"primaryRaisedInWei": "abc123",
"soundSwapCollected": 987,
"soundSwapRaisedInWei": "xyz789",
"totalVolume": "abc123"
}
SaleSchedule
Description
Single sale schedule information of Release Presale Configuration
Fields
| Field Name | Description |
|---|---|
affiliateFeeBPS -
Int!
|
Affiliate fee in basis points within schedule sales |
affiliateFeePercent -
String!
|
Percentage of affiliate fee within schedule sales |
artistContractTotalMinted -
Int
|
Total minted for specific sale schedule associated with artist contracts. To not be used for new editions |
endTime -
DateTime!
|
End Time of Sale Schedule |
id -
ID!
|
UUID of Sale Schedule entity |
isPresale -
Boolean!
|
Is the current sale schedule presale |
maxMintable -
Int!
|
Amount to be allowed to be sold for sale schedule |
merkleTreeRoot -
String
|
Merkle tree root hash derived from sale schedule allowlist |
mintId -
Int
|
Mint id for the minter config |
minterAddress -
String
|
Minter contract address for the schedule |
price -
String!
|
Price for the specific sale schedule |
startTime -
DateTime!
|
Start Time of Sale Schedule |
Example
{
"affiliateFeeBPS": 987,
"affiliateFeePercent": "abc123",
"artistContractTotalMinted": 123,
"endTime": "2007-12-03T10:15:30Z",
"id": 4,
"isPresale": true,
"maxMintable": 987,
"merkleTreeRoot": "abc123",
"mintId": 123,
"minterAddress": "xyz789",
"price": "abc123",
"startTime": "2007-12-03T10:15:30Z"
}
SamConfig
Description
Sam configuration within edition
Fields
| Field Name | Description |
|---|---|
affiliateFeeBPS -
Int!
|
Fee BPS applied for share affiliate |
affiliateFeePercent -
String!
|
Fee in percent applied for share affiliate |
artistFeeBPS -
Int!
|
Artist fee BPS |
artistFeePercent -
String!
|
Artist fee in percent |
basePrice -
String!
|
Base price |
buyFreezeTime -
Timestamp!
|
When is the SAM to be frozen and not allow purchases |
goldenEggFeeBPS -
Int!
|
Fee BPS applied for golden egg holders |
goldenEggFeePercent -
String!
|
Fee in percent applied for share affiliate |
id -
ID!
|
SAM edition configuration identifier |
inflectionPoint -
Int!
|
Inflection point |
inflectionPrice -
String!
|
Inflection price |
maxSupply -
Int!
|
Max supply of tokens that SAM can provide |
platformFeeBPS -
Int!
|
Fee BPS applied for platform |
platformPerTxFlatFee -
String!
|
Flat fee applied for platform per transaction |
samAddress -
String!
|
SAM Contract address |
Example
{
"affiliateFeeBPS": 123,
"affiliateFeePercent": "xyz789",
"artistFeeBPS": 987,
"artistFeePercent": "abc123",
"basePrice": "abc123",
"buyFreezeTime": 1592577642,
"goldenEggFeeBPS": 987,
"goldenEggFeePercent": "xyz789",
"id": "4",
"inflectionPoint": 987,
"inflectionPrice": "xyz789",
"maxSupply": 987,
"platformFeeBPS": 987,
"platformPerTxFlatFee": "abc123",
"samAddress": "xyz789"
}
ScheduleIdentifier
SearchArtistsSortEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CREATED_AT"
SearchCollectorsSortEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"ARTISTS_BACKED"
SearchConnectionArgs
Description
Pagination arguments for search
Fields
| Input Field | Description |
|---|---|
after -
String
|
Start forwards pagination since "after" cursor |
first -
PositiveInt!
|
Limit the amount of nodes to be fetched, to be used with "after", with a maximum of 20 nodes. |
Example
{"after": "abc123", "first": 123}
SearchInput
Description
Input for "search" query
Fields
| Input Field | Description |
|---|---|
limit -
PositiveInt!
|
How many entities to be fetched for fixed lists, maximum of 20 |
text -
String
|
Text search |
Example
{"limit": 123, "text": "abc123"}
SearchReleasesSortEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"MINT_START_TIME"
SearchResult
Description
Search result
Fields
| Field Name | Description |
|---|---|
artistsPaginated -
ArtistConnection!
|
Paginated artists that match the search input, including artists where any of their releases matches the given input |
Arguments
|
|
collectors -
UserConnection!
|
Paginated collectors that match the search input within the ens, twitter handle, displayName and publicAddress |
Arguments
|
|
id -
ID!
|
Unique identifier of search result |
releasesPaginated -
ReleaseConnection!
|
Paginated releases that match the search input, including releases where the artist name matches the given input |
Arguments
|
|
shelves -
ShelfConnection!
|
Paginated shelves that match the search input within the shelf name, releases titles and artists names |
Arguments
|
|
Example
{
"artistsPaginated": ArtistConnection,
"collectors": UserConnection,
"id": "4",
"releasesPaginated": ReleaseConnection,
"shelves": ShelfConnection
}
SearchShelvesSortEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CREATED_AT"
SeasonAuctionDefaults
SeasonDefaultOptions
Description
Default reference season-based auction options for administration
Fields
| Field Name | Description |
|---|---|
auction -
[Auction!]!
|
Auction options union based on type |
Example
{"auction": [FixedAuction]}
SecondarySale
Description
Collector release added to playlist action entity
Fields
| Field Name | Description |
|---|---|
amountPaidInWei -
String!
|
Amount paid in Wei for secondary sale |
date -
DateTime!
|
Date of action |
fromSerialNumber -
Int
|
Starting serial number of NFT for secondary sale purchase |
fromTokenId -
Int!
|
Starting token ID of NFT for secondary sale purchase |
id -
ID!
|
Action id |
purchasedFromUser -
User!
|
User that nft was purchased from for secondary sale action |
quantity -
Int!
|
Number of sequential tokens purchased |
release -
Release!
|
Release corresponding to collector secondary sale action entity |
serialNumber -
Int!
|
Serial number of nft secondary sale purchase |
tierNumber -
Int
|
tierNumber of the nft |
toSerialNumber -
Int
|
Ending serial number of NFT for secondary sale purchase |
toTokenId -
Int!
|
Ending token ID of NFT for secondary sale purchase |
user -
User!
|
User corresponding to collector action entity |
Example
{
"amountPaidInWei": "xyz789",
"date": "2007-12-03T10:15:30Z",
"fromSerialNumber": 123,
"fromTokenId": 123,
"id": 4,
"purchasedFromUser": User,
"quantity": 987,
"release": Release,
"serialNumber": 123,
"tierNumber": 123,
"toSerialNumber": 987,
"toTokenId": 123,
"user": User
}
SemanticVersion
Description
Semantic version string
Example
SemanticVersion
SetArtistMetaInput
Description
Input for setArtistMeta mutation
Fields
| Input Field | Description |
|---|---|
artistId -
String!
|
Artist identifier |
metaType -
ArtistMetaInput
|
Artist meta configuration data |
Example
{
"artistId": "abc123",
"metaType": ArtistMetaInput
}
SetArtistOnboardedByPublicAddressMetaInput
SetAudioDownloadRewardInput
SetReleaseDetailsInput
Description
Input for setReleaseDetails mutation
Fields
| Input Field | Description |
|---|---|
releaseDetails -
ReleaseDetailsInput!
|
Release details input values |
releaseId -
String!
|
Release identifier |
Example
{
"releaseDetails": ReleaseDetailsInput,
"releaseId": "abc123"
}
SetReleaseMetaInput
Description
Input for setReleaseMeta mutation
Fields
| Input Field | Description |
|---|---|
metaType -
ReleaseMetaInput
|
Meta input values |
releaseId -
String!
|
Release identifier |
Example
{
"metaType": ReleaseMetaInput,
"releaseId": "xyz789"
}
SetReleasesForShelfInput
Description
Input fields to set releases to shelf
Example
{
"releaseIds": [
"6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
],
"shelfId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
SetSamBuyBufferBpsOverrideInput
Description
Input for setSamBuyBufferBpsOverride mutation
Example
{
"releaseId": "xyz789",
"samBuyBufferBpsOverride": 987
}
SetSamSellBufferBpsOverrideInput
Description
Input for setSamSellBufferBpsOverride mutation
Example
{
"releaseId": "xyz789",
"samSellBufferBpsOverride": 987
}
SetVoteOnPostCommentInput
Description
Input for setVoteOnPostComment mutation
Fields
| Input Field | Description |
|---|---|
postCommentId -
UUID!
|
ID of the post comment |
voteStatus -
PostVoteChange!
|
New state to set the vote status to. |
Example
{
"postCommentId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"voteStatus": "REMOVE_VOTE"
}
SetVoteOnPostInput
Description
Input for setVoteOnPost mutation
Fields
| Input Field | Description |
|---|---|
postId -
UUID!
|
ID of the post |
voteStatus -
PostVoteChange!
|
New state to set the vote status to. |
Example
{
"postId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"voteStatus": "REMOVE_VOTE"
}
Shelf
Description
Shelf entity
Fields
| Field Name | Description |
|---|---|
affiliateBuyers -
PlaylistAffiliateBuyerConnection!
|
Paginate through affiliate buyers of this shelf. |
Arguments
|
|
coverImage -
Media
|
Cover image of Shelf |
coverReleases -
[Release!]!
|
Top 4 releases to be used as cover for shelf |
createdAt -
DateTime!
|
Shelf creation date |
deletedAt -
DateTime
|
Shelf deletion date |
description -
String
|
Description of shelf |
extendedFrom -
[Shelf]
|
Return shelves from where it was possibly extended. If the source shelf is not currently available, it's returned as null |
id -
ID!
|
Shelf identifier |
index -
Int!
|
Relative ordering of the shelves for each user |
likedBy -
UserConnection!
|
Paginate through users who like this shelf. |
Arguments
|
|
likes -
Int!
|
Number of likes for the shelf. |
linkSlug -
String!
|
Link slug used to reference and request specific shelf |
name -
String!
|
Shelf name |
numLikes -
Int!
|
Number of likes for the shelf. |
numReferralPurchases -
Int!
|
Number of mints driven by shelf referral. |
numUsersReferred -
Int!
|
Number of users that collected from shelf referral. |
orderedReleases -
ShelfReleaseConnection!
|
Paginated releases of shelf ordered depending on shelfType |
Arguments
|
|
playTimeInSeconds -
Int!
|
Total play time of all releases in a shelf in seconds |
previewReleases -
[ShelfRelease!]!
|
Top 4 releases to be used as preview for shelf |
releaseCount -
Int!
|
Number of releases in a shelf |
releaseIds -
[String!]!
|
List of release identifiers in the shelf ordered depending on shelfType |
Arguments
|
|
socialProofReferrals -
[User!]!
|
Playlist affiliate purchase users ordered by follower count |
Arguments
|
|
trackIds -
[String!]!
|
List of track identifiers in the shelf ordered depending on shelfType |
Arguments
|
|
type -
ShelfType!
|
Type of shelf |
user -
User!
|
Owner of shelf |
webEmbed -
String!
|
Web HTML iframe embed |
Arguments
|
|
webappUri -
String!
|
Webapp URI of Shelf |
Example
{
"affiliateBuyers": PlaylistAffiliateBuyerConnection,
"coverImage": Media,
"coverReleases": [Release],
"createdAt": "2007-12-03T10:15:30Z",
"deletedAt": "2007-12-03T10:15:30Z",
"description": "abc123",
"extendedFrom": [Shelf],
"id": 4,
"index": 123,
"likedBy": UserConnection,
"likes": 123,
"linkSlug": "xyz789",
"name": "abc123",
"numLikes": 987,
"numReferralPurchases": 987,
"numUsersReferred": 123,
"orderedReleases": ShelfReleaseConnection,
"playTimeInSeconds": 123,
"previewReleases": [ShelfRelease],
"releaseCount": 987,
"releaseIds": ["xyz789"],
"socialProofReferrals": [User],
"trackIds": ["abc123"],
"type": "DEFAULT",
"user": User,
"webEmbed": "xyz789",
"webappUri": "abc123"
}
ShelfConnection
Description
Paginated shelves connection
Fields
| Field Name | Description |
|---|---|
edges -
[ShelfConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [ShelfConnectionEdge],
"pageInfo": PageInfo
}
ShelfConnectionEdge
ShelfCreatedAggregate
Description
Shelf created aggregate
Fields
| Field Name | Description |
|---|---|
shelf -
Shelf
|
Shelf creation action in activity feed group |
Example
{"shelf": Shelf}
ShelfCursorConnectionArgs
Description
Cursor connection parameters for shelves
Fields
| Input Field | Description |
|---|---|
after -
String
|
Start forwards pagination since "after" cursor |
before -
String
|
Start backwards pagination since "before" cursor |
first -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "after", with a maximum of 51 nodes. |
last -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "before", with a maximum of 51 nodes. |
sort -
ShelfCursorConnectionSort!
|
Customize sort behavior |
Example
{
"after": "abc123",
"before": "xyz789",
"first": 123,
"last": 123,
"sort": ShelfCursorConnectionSort
}
ShelfCursorConnectionSort
ShelfOrderedReleaseCursorConnectionArgs
Description
Cursor connection parameters for shelf ordered releases
Fields
| Input Field | Description |
|---|---|
after -
String
|
Start forwards pagination since "after" cursor |
before -
String
|
Start backwards pagination since "before" cursor |
first -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "after", with a maximum of 51 nodes. |
last -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "before", with a maximum of 51 nodes. |
Example
{
"after": "xyz789",
"before": "abc123",
"first": 123,
"last": 123
}
ShelfRelease
Description
Shelf release entity
Fields
| Field Name | Description |
|---|---|
addedAt -
Timestamp!
|
Date of release being added in shelf |
id -
ID!
|
Shelf Release identifier |
index -
Int!
|
Index of release within shelf |
ownedFirstNft -
Nft
|
First backed nft of possibly collected release |
ownedGoldenEgg -
EggGame
|
Returns golden egg if user owns, otherwise null |
ownedTokens -
[OwnedToken!]
|
List of possible owned tokens in ascending tokenId order. If user does not own the release, it returns null |
release -
Release!
|
Release of the shelf |
Example
{
"addedAt": 1592577642,
"id": "4",
"index": 987,
"ownedFirstNft": Nft,
"ownedGoldenEgg": EggGame,
"ownedTokens": [OwnedToken],
"release": Release
}
ShelfReleaseConnection
Description
Paginated shelf release connection
Fields
| Field Name | Description |
|---|---|
edges -
[ShelfReleaseConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [ShelfReleaseConnectionEdge],
"pageInfo": PageInfo
}
ShelfReleaseConnectionEdge
Description
Shelf release node edge
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Cursor to be used for pagination |
node -
ShelfRelease!
|
Shelf release entity |
Example
{
"cursor": "xyz789",
"node": ShelfRelease
}
ShelfReleasesSort
Description
Customize sort behavior of shelf releases
Fields
| Input Field | Description |
|---|---|
addedToShelfDate -
SortOrder
|
Sort by release added to shelf date |
index -
SortOrder!
|
Sort by release index of shelf |
Example
{"addedToShelfDate": "ASC", "index": "ASC"}
ShelfSearchFilter
Description
Filter the shelf to be searched
Fields
| Input Field | Description |
|---|---|
genres -
[Genres!]
|
Genre names to filter on for shelf songs |
Example
{"genres": ["AFROBEAT"]}
ShelfSortInput
Description
Defines sort order of Shelf fields, array index defines tiebreaking
Fields
| Input Field | Description |
|---|---|
field -
SearchShelvesSortEnum!
|
Field to be sorted |
order -
SortOrder!
|
Sort ascending or descending |
Example
{"field": "CREATED_AT", "order": "ASC"}
ShelfType
Description
Shelf type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"DEFAULT"
ShelfTypeFilter
Description
Filter based the type of shelf
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ALL"
ShelfWebEmbedInput
Description
Input for Shelf.webEmbed
Fields
| Input Field | Description |
|---|---|
html -
IframeHtmlParameters!
|
Customize html parameters |
Example
{"html": IframeHtmlParameters}
SignedMultipartUrl
SongCollectedByManyAggregate
Description
Song collected by many aggregate
Fields
| Field Name | Description |
|---|---|
collectedRelease -
ActivityFeedGroupCollectedRelease!
|
Release corresponding to most recent purchase action in activity feed group |
featuredCollectors -
[ActivityFeedGroupFeaturedCollector!]!
|
Featured collectors that purchased same release in an activity feed group |
numCollectors -
Int!
|
Number of collectors that purchased same release in an activity feed group |
Example
{
"collectedRelease": ActivityFeedGroupCollectedRelease,
"featuredCollectors": [
ActivityFeedGroupFeaturedCollector
],
"numCollectors": 123
}
SongKeyType
Description
Key the release was written in
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"A_FLAT_MAJOR"
SortOrder
Description
Ascending or Descending sort
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ASC"
SplitsContractEarning
Description
Splits contract earnings
Fields
| Field Name | Description |
|---|---|
balanceForUser -
String!
|
Users split of eth on the contract |
contractAddress -
String!
|
Address of the split wallet |
distributorFee -
Int!
|
Distributor fee of the split |
participantAddresses -
[String!]!
|
List of addresses that are on the split. Sorted for passing into distributeEth transaction |
participantAllocations -
[Int!]!
|
List of allocations for each participant. Matches ordering of participantAddresses |
totalBalance -
String!
|
Total eth on the contract |
Example
{
"balanceForUser": "xyz789",
"contractAddress": "xyz789",
"distributorFee": 123,
"participantAddresses": ["xyz789"],
"participantAllocations": [123],
"totalBalance": "xyz789"
}
SplitsUploadStepInfo
Description
Splits upload step info
Fields
| Field Name | Description |
|---|---|
splitContractAddress -
String
|
Split contract address |
splits -
[CreditAllocationUploadStepInfo!]!
|
Splits auction configurations |
Example
{
"splitContractAddress": "xyz789",
"splits": [CreditAllocationUploadStepInfo]
}
SplitsUploadStepInput
Description
Splits upload step input values
Fields
| Input Field | Description |
|---|---|
splits -
[Allocation!]!
|
Credit allocations of credit split |
Example
{"splits": [Allocation]}
SponsoredTransaction
SpotifyAPIError
SpotifyAuthConnection
Description
Spotify authorization connection
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"id": 4,
"lastValidationAt": "2007-12-03T10:15:30Z",
"spotifyUserId": "abc123"
}
Stats
Description
Basic stats information
Example
{"totalArtists": 123.45, "totalUniqueCollectors": 123.45, "totalUsers": 123.45}
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
"xyz789"
SubscribeArtistActivityNotificationInput
Description
Subscribe to artist updates input
Fields
| Input Field | Description |
|---|---|
artist -
UUID!
|
ID of the artist to subscribe current user to |
Example
{
"artist": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
SubscribeToEmailCTA
Description
Subscribe with email notification
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
UserNotification UUID |
timestamp -
Timestamp!
|
Timestamp for notification |
user -
User
|
Recipient user entity |
Example
{"id": 4, "timestamp": 1592577642, "user": User}
SubscriptionNewActivityFeedGroup
Description
Entity of new activity feed group created
Example
{
"activityFeedGroupId": "abc123",
"activityFeedGroupInformationTypename": "abc123"
}
SupportedVersion
Description
Info for supported versions
Fields
| Field Name | Description |
|---|---|
recommendedVersion -
String!
|
Recommended version |
Example
{"recommendedVersion": "xyz789"}
Tier
Description
Tier associated with tiered edition listing
Fields
| Field Name | Description |
|---|---|
chain -
ChainType!
|
Chain associated with auction |
cutoffTime -
DateTime!
|
Cutoff timestamp of auction tier |
editionAddress -
String!
|
Contract address associated with edition auction |
id -
ID!
|
Unique identifier |
isFrozen -
Boolean!
|
Is the minting of the tier frozen |
isGA -
Boolean!
|
Is the tier considered GA (General Admission) |
isGoldenEggEnabled -
Boolean!
|
Is golden egg enabled for tier |
maxMintableLower -
Int!
|
Minimum amount of editions to be sold within range of cutoff time |
maxMintableUpper -
Int!
|
Maximum amount of editions to be sold within before cutoff time |
mintConcluded -
Boolean!
|
Is the tier minting considered finished |
schedules -
[TierSchedule!]!
|
All schedules within tier |
tierNumber -
Int!
|
Unique tier number associated within edition contract |
totalMinted -
Int!
|
Total amount of minted editions within tier |
Example
{
"chain": "BASE",
"cutoffTime": "2007-12-03T10:15:30Z",
"editionAddress": "xyz789",
"id": 4,
"isFrozen": false,
"isGA": false,
"isGoldenEggEnabled": true,
"maxMintableLower": 123,
"maxMintableUpper": 123,
"mintConcluded": true,
"schedules": [TierSchedule],
"tierNumber": 123,
"totalMinted": 987
}
TierNFT
Description
The Tier of the NFT owned by ReleaseCollector
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ALL"
TierSchedule
Description
Schedule associated with Tier of auction Listing
Fields
| Field Name | Description |
|---|---|
affiliateFeeBPS -
Int!
|
Affiliate fee in basis per point for schedule |
chain -
ChainType!
|
Chain associated with auction |
editionAddress -
String!
|
Contract address associated with edition auction |
endTime -
DateTime!
|
End timestamp for minting on schedule |
id -
ID!
|
Unique identifier |
isPaused -
Boolean!
|
Is minting on schedule paused |
maxMintable -
Int!
|
Fixed amount of maximum mintable editions within schedule |
maxMintablePerAccount -
Int!
|
Limit of mints per account within schedule |
merkleTreeRoot -
String
|
Merkle tree root associated with tier schedule |
minterAddress -
String!
|
Address of minter associated with schedule |
mode -
TierScheduleMode!
|
Mode of minting associated with schedule |
priceInWei -
String!
|
Price for minting on schedule |
scheduleNumber -
Int!
|
Unique schedule number associated within edition contract and tier |
startTime -
DateTime!
|
Start timestamp for minting on schedule |
tier -
Tier!
|
Tier associated for schedule |
tierNumber -
Int!
|
Unique tier number associated within edition contract |
totalMinted -
Int!
|
Total amount of minted editions within schedule |
Example
{
"affiliateFeeBPS": 123,
"chain": "BASE",
"editionAddress": "xyz789",
"endTime": "2007-12-03T10:15:30Z",
"id": "4",
"isPaused": true,
"maxMintable": 123,
"maxMintablePerAccount": 123,
"merkleTreeRoot": "abc123",
"minterAddress": "abc123",
"mode": "DEFAULT",
"priceInWei": "abc123",
"scheduleNumber": 987,
"startTime": "2007-12-03T10:15:30Z",
"tier": Tier,
"tierNumber": 987,
"totalMinted": 987
}
TierScheduleMode
Description
Mode that differentiates behavior of tier schedule
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DEFAULT"
TieredAllocation
Description
Allocation input for credit split of tiered edition
Fields
| Input Field | Description |
|---|---|
ownerAddress -
Address!
|
Owner address of allocation |
percent -
Float!
|
Percent of allocation |
roles -
[CreditRoleType!]!
|
Roles associated with credit allocation |
Example
{
"ownerAddress": Address,
"percent": 123.45,
"roles": ["ARTIST"]
}
TieredAuctionConfigurationInput
Description
TieredDraft auction configuration input values
Fields
| Input Field | Description |
|---|---|
endTime -
Timestamp
|
Auction end time |
endTimeDays -
Int
|
Auction end time in days |
maxMintsPerWallet -
PositiveInt!
|
Max mints per wallet for auction |
price -
NonNegativeFloat!
|
Price per mint |
quantity -
PositiveInt!
|
Max supply for auction |
startTime -
Timestamp!
|
Auction start time |
Example
{
"endTime": 1592577642,
"endTimeDays": 987,
"maxMintsPerWallet": 123,
"price": 123.45,
"quantity": 123,
"startTime": 1592577642
}
TieredAuctionConfigurationsInput
Description
Tiered Draft auction configurations input values
Fields
| Input Field | Description |
|---|---|
auctionType -
TieredAuctionType!
|
Type of auction |
maxMintable -
PositiveInt!
|
Max mint supply of auction |
minQuantity -
PositiveInt!
|
Min mint supply of auction |
presaleMint -
TieredAuctionConfigurationInput
|
Presale mint auction configurations |
publicMint -
TieredAuctionConfigurationInput!
|
Public mint auction configurations |
quantityBreakdown -
[PositiveInt!]
|
Breakdown of mint quantities |
Example
{
"auctionType": "FIXED_QUANTITY",
"maxMintable": 123,
"minQuantity": 123,
"presaleMint": TieredAuctionConfigurationInput,
"publicMint": TieredAuctionConfigurationInput,
"quantityBreakdown": [123]
}
TieredAuctionType
Description
Types of tiered release sales
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"FIXED_QUANTITY"
TieredDraftAllowListInput
Description
TieredDraft allow list inputs
Fields
| Input Field | Description |
|---|---|
collectorsOfArtists -
TieredDraftCollectorsOfArtistsInput
|
Draft collectors of artists |
collectorsOfReleases -
TieredDraftCollectorsOfReleasesInput
|
Draft collectors of releases |
manuallyAddedAllowlist -
TieredDraftManuallyAddedAllowlistInput
|
Draft manually added allowlist releases |
Example
{
"collectorsOfArtists": TieredDraftCollectorsOfArtistsInput,
"collectorsOfReleases": TieredDraftCollectorsOfReleasesInput,
"manuallyAddedAllowlist": TieredDraftManuallyAddedAllowlistInput
}
TieredDraftAllowListsInput
Description
Tiered Draft allowlists configurations
Fields
| Input Field | Description |
|---|---|
presaleMint -
TieredDraftAllowListInput
|
Presale mint draft allowlist configuration |
Example
{"presaleMint": TieredDraftAllowListInput}
TieredDraftCollectorsOfArtistsInput
Description
Tiered Draft collectors of artists inputs
Example
{
"allArtistCollectors": true,
"selectedArtistIds": [
"6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
]
}
TieredDraftCollectorsOfReleasesInput
Description
Tiered Draft collectors of releases inputs
Example
{
"allArtistCollaborations": true,
"selectedReleaseIds": [
"6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
]
}
TieredDraftManuallyAddedAllowlistInput
Description
Tiered Draft manually added allowlist inputs
Fields
| Input Field | Description |
|---|---|
addresses -
[Address!]
|
Addresses manually added by artist |
description -
String
|
Tiered Draft manually added allowlist description |
Example
{
"addresses": [Address],
"description": "abc123"
}
TieredDraftMetadataUploadAsyncOutput
TieredDraftMetadataUploadAsyncStatusPending
TieredDraftMetadataUploadAsyncStatusResult
Example
TieredDraftMetadataUploadAsyncStatusPending
TieredDraftMetadataUploadAsyncStatusSuccess
Description
Success status for async tiered metadata upload request
Fields
| Field Name | Description |
|---|---|
draft -
Draft!
|
Draft entity |
tieredDraftMetadataUploadAsyncRequestId -
String!
|
Async request ID for tracking |
uploadResult -
TieredDraftMetadataUploadResult!
|
Upload result of tiered metadata |
Example
{
"draft": Draft,
"tieredDraftMetadataUploadAsyncRequestId": "abc123",
"uploadResult": TieredDraftMetadataUploadResult
}
TieredDraftMetadataUploadResult
Description
Result for tieredDraftMetadataUpload mutation
Fields
| Field Name | Description |
|---|---|
storefrontArweaveHash -
String!
|
Storefront arweave hash of release |
tiers -
[TieredReleaseArweaveOutputs!]!
|
Uploaded arweave hashes for each tier |
Example
{
"storefrontArweaveHash": "xyz789",
"tiers": [TieredReleaseArweaveOutputs]
}
TieredEditionListing
Description
Tiered Edition Auction Listing
Fields
| Field Name | Description |
|---|---|
chain -
ChainType!
|
Chain associated with auction |
contractAddress -
String!
|
Contract address associated with edition auction |
hasGA -
Boolean!
|
Has the tier auction enabled GA |
id -
ID!
|
Unique identifier |
name -
String!
|
Name associated on contract information |
presalePriceWei -
String
|
Price of earliest public merkle schedule if present |
presaleStartTime -
DateTime
|
Start time of earliest merkle schedule if present |
publicPriceWei -
String
|
Price of earliest public schedule if present |
publicStartTime -
DateTime
|
Start time of earliest public schedule if present |
royaltyBPS -
Int!
|
Royalty basis per point |
schedules -
[TierSchedule!]!
|
All schedules associated with tiered edition |
tiers -
[Tier!]!
|
Tiers associated with tiered edition auction |
totalBurned -
Int!
|
Total amount of burned editions |
totalMinted -
Int!
|
Total amount of minted editions |
totalSupply -
Int!
|
Total amount of minted editions that are not burned |
Example
{
"chain": "BASE",
"contractAddress": "xyz789",
"hasGA": false,
"id": "4",
"name": "abc123",
"presalePriceWei": "xyz789",
"presaleStartTime": "2007-12-03T10:15:30Z",
"publicPriceWei": "xyz789",
"publicStartTime": "2007-12-03T10:15:30Z",
"royaltyBPS": 987,
"schedules": [TierSchedule],
"tiers": [Tier],
"totalBurned": 987,
"totalMinted": 987,
"totalSupply": 987
}
TieredReleaseArweaveOutputs
TieredReleaseInfoUploadStepInput
Description
Tiered Release info upload step input values
Fields
| Input Field | Description |
|---|---|
beatsPerMinute -
NonNegativeInt
|
Release beats per minute |
behindTheMusic -
String!
|
Behind the music text |
coverImage -
UploadedMedia!
|
Cover image |
gaCoverImage -
UploadedMedia
|
General Admission cover image |
gaStaticCoverImage -
UploadedMedia
|
General Admission static cover image |
genre -
Genres!
|
Release genre |
goldenEggImage -
UploadedMedia
|
Special golden egg image |
key -
SongKeyType
|
Release key |
license -
LicenseType
|
License for the release |
listeningPartyPublicSaleStartTime -
Boolean!
|
Whether a listening party should be added and synchronized with the public sale's start time |
location -
CountryCode
|
Location where the release was created |
lyrics -
String
|
Release lyrics |
spotifyTrackId -
String
|
Spotify album uri |
staticCoverImage -
UploadedMedia
|
Static cover image to use in place of animated cover image |
title -
String!
|
Title |
tokenSymbol -
String!
|
Token symbol |
track -
TrackUpload!
|
Uploaded track |
Example
{
"beatsPerMinute": 123,
"behindTheMusic": "abc123",
"coverImage": UploadedMedia,
"gaCoverImage": UploadedMedia,
"gaStaticCoverImage": UploadedMedia,
"genre": "AFROBEAT",
"goldenEggImage": UploadedMedia,
"key": "A_FLAT_MAJOR",
"license": "ALL_RIGHTS_RESERVED",
"listeningPartyPublicSaleStartTime": true,
"location": "US",
"lyrics": "xyz789",
"spotifyTrackId": "xyz789",
"staticCoverImage": UploadedMedia,
"title": "xyz789",
"tokenSymbol": "abc123",
"track": TrackUpload
}
TieredRewardsUploadStepInput
Description
Release rewards upload step input values
Fields
| Input Field | Description |
|---|---|
canCollectorsDownloadAudio -
Boolean
|
Whether collectors can download audio |
curatorRewardsEnabled -
Boolean
|
Toggle for curator rewards |
goldenEggImages -
[UploadedMedia!]
|
Special golden egg images |
rewards -
[RewardInput!]
|
Custom rewards |
Example
{
"canCollectorsDownloadAudio": false,
"curatorRewardsEnabled": false,
"goldenEggImages": [UploadedMedia],
"rewards": [RewardInput]
}
TieredSplitsUploadStepInput
Description
Tiered Splits upload step input values
Fields
| Input Field | Description |
|---|---|
splits -
[TieredAllocation!]!
|
Credit allocations of credit split |
Example
{"splits": [TieredAllocation]}
TimePeriodAggEnum
Description
Time period to aggregate trending table queries
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"ALL_TIME"
Timestamp
Description
The javascript Date as integer. Type represents date and time as number of milliseconds from start of UNIX epoch.
Example
1592577642
TopAffiliateCuratorsInput
Description
Input for top affiliate curators query
Fields
| Input Field | Description |
|---|---|
limit -
PositiveInt!
|
Limit the amount to be returned, Up to 100 |
sort -
TopCuratorsSortEnum!
|
Sort logic used |
timePeriod -
TopChartTimePeriodEnum!
|
For what time period the data should come from |
Example
{"limit": 123, "sort": "MINTS", "timePeriod": "ALL_TIME"}
TopArtistsInput
Description
Input for top artists query
Fields
| Input Field | Description |
|---|---|
limit -
PositiveInt!
|
Limit the amount to be returned, Up to 100 |
sort -
TrendingArtistsSortEnum!
|
Sort logic used |
timePeriod -
TopChartTimePeriodEnum!
|
For what time period the data should come from |
Example
{"limit": 123, "sort": "NFTS_SOLD", "timePeriod": "ALL_TIME"}
TopChartTimePeriodEnum
Description
Time period to aggregate top chart queries
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ALL_TIME"
TopCuratorsSortEnum
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"MINTS"
TopPlaylistsInput
Description
Input for topPlaylists query
Fields
| Input Field | Description |
|---|---|
limit -
PositiveInt!
|
Limit the amount to be returned, Up to 100 |
sort -
TrendingPlaylistsSortEnum!
|
Sort logic used |
timePeriod -
TimePeriodAggEnum!
|
For what time period the data should come from |
Example
{"limit": 123, "sort": "LIKES", "timePeriod": "ALL_TIME"}
TopReleaseCollector
Description
Top Release Collector
Example
{
"firstNftCollectedDate": "2007-12-03T10:15:30Z",
"lowestNftSerialNumber": 123,
"nftsCount": 987,
"position": 123,
"user": User
}
TotalAffiliatePurchasesInput
Description
Input for totalAffiliatePurchases query
Fields
| Input Field | Description |
|---|---|
pagination -
ReleaseAffiliateTotalPurchasesCursorConnectionArgs!
|
Pagination parameters |
Example
{
"pagination": ReleaseAffiliateTotalPurchasesCursorConnectionArgs
}
TotalRaisedPlatform
Track
Description
Track entity
Fields
| Field Name | Description |
|---|---|
audio -
AudioMedia!
|
Audio of Track |
audioOriginal -
Media
|
Original audio (non-transcoded) |
duration -
Int!
|
Duration in seconds |
id -
ID!
|
Track identifier |
normalizedPeaks -
[Int!]!
|
Normalized peaks of song |
release -
Release!
|
Track's Release |
releaseId -
ID!
|
Release Identifier |
title -
String!
|
Track title |
trackNumber -
Int!
|
Track number relative to other tracks (unused) |
Example
{
"audio": AudioMedia,
"audioOriginal": Media,
"duration": 987,
"id": 4,
"normalizedPeaks": [123],
"release": Release,
"releaseId": "4",
"title": "abc123",
"trackNumber": 123
}
TrackUpload
Description
Uploaded track information
Fields
| Input Field | Description |
|---|---|
coverImage -
UploadedMedia
|
Cover image |
duration -
Int!
|
Duration of track in seconds |
fileDetail -
UploadedMedia!
|
Details of uploaded track file |
normalizedPeaks -
[Int!]!
|
Normalized peaks of track |
title -
String!
|
Title of track |
Example
{
"coverImage": UploadedMedia,
"duration": 123,
"fileDetail": UploadedMedia,
"normalizedPeaks": [123],
"title": "xyz789"
}
TrackUploadStepInfo
Description
Release info upload step info
Fields
| Field Name | Description |
|---|---|
coverImage -
MediaUploadStepInfo
|
Details of uploaded track cover image |
duration -
Int!
|
Duration of track in seconds |
fileDetail -
MediaUploadStepInfo!
|
Details of uploaded track file |
normalizedPeaks -
[Int!]!
|
Normalized peaks of track |
title -
String!
|
Title |
Example
{
"coverImage": MediaUploadStepInfo,
"duration": 123,
"fileDetail": MediaUploadStepInfo,
"normalizedPeaks": [987],
"title": "abc123"
}
Transaction
Description
Transaction entity
Fields
| Field Name | Description |
|---|---|
chainId -
Int!
|
Chain identifier used for transaction |
contractMethod -
ContractMethod!
|
Contract method of transaction |
hash -
String!
|
Transaction hash on chain |
id -
ID!
|
Transaction identifier |
releaseId -
String
|
Release identifier |
status -
String!
|
Transaction status, "pending", "failed" or "confirmed") |
Example
{
"chainId": 987,
"contractMethod": "AFFILIATE__WITHDRAW",
"hash": "xyz789",
"id": "4",
"releaseId": "xyz789",
"status": "xyz789"
}
TransactionHash
Description
A valid Ethereum transaction hash string
Example
TransactionHash
TrendingArtistInfo
Description
Trending Artist Info
Fields
| Field Name | Description |
|---|---|
artist -
Artist
|
Artist entity |
artistId -
ID!
|
Artist identifier |
nftsSold -
Int!
|
Amount of NFTs sold |
primarySales -
String!
|
Primary sales of artist in Wei |
primarySalesUsd -
Float!
|
Primary sales of artist in USD |
secondarySales -
String!
|
Secondary sales of artist in Wei |
secondarySalesUsd -
Float!
|
Secondary sales of artist in USD |
totalSales -
String!
|
Sum of primary and secondary sales in Wei |
totalSalesUsd -
Float!
|
Sum of primary and secondary sales in USD |
uniqueCollectors -
Int!
|
Amount of unique collectors |
Example
{
"artist": Artist,
"artistId": "4",
"nftsSold": 987,
"primarySales": "xyz789",
"primarySalesUsd": 987.65,
"secondarySales": "abc123",
"secondarySalesUsd": 987.65,
"totalSales": "xyz789",
"totalSalesUsd": 987.65,
"uniqueCollectors": 123
}
TrendingArtistsSortEnum
Description
Type of sort parameter used for trending artists
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NFTS_SOLD"
TrendingCollectorInfo
Description
Trending Collector information
Fields
| Field Name | Description |
|---|---|
creatorsSupported -
Int!
|
Amount of unique creators supported |
nftsBought -
Int!
|
Amount of NFTs bought |
totalSpent -
String!
|
Total spent in Wei |
totalSpentUsd -
Float!
|
Total spent in USD |
user -
User
|
Collector user entity |
userAddress -
String!
|
User public address of the collector |
Example
{
"creatorsSupported": 987,
"nftsBought": 987,
"totalSpent": "abc123",
"totalSpentUsd": 123.45,
"user": User,
"userAddress": "xyz789"
}
TrendingCollectorsSortEnum
Description
Type of sort paratemer used for trending collectors
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"CREATORS_SUPPORTED"
TrendingIndicator
Description
Trending indicator type
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
Example
"DOWN"
TrendingPlaylistInfo
TrendingPlaylistsSortEnum
Description
Type of sort paratemer used for trending playlists
Values
| Enum Value | Description |
|---|---|
|
|
Example
"LIKES"
TrendingReleaseInfo
Description
Trending Release Info
Fields
| Field Name | Description |
|---|---|
nftsSold -
Int!
|
Amount of NFTs sold |
primarySales -
String!
|
Primary sales of release in Wei |
primarySalesUsd -
Float!
|
Primary sales of release in USD |
release -
Release!
|
release entity |
secondarySales -
String!
|
Secondary sales of release in Wei |
secondarySalesUsd -
Float!
|
Secondary sales of release in USD |
totalSales -
String!
|
Sum of primary and secondary sales in Wei |
totalSalesUsd -
Float!
|
Sum of primary and secondary sales in USD |
uniqueCollectors -
Int!
|
Amount of unique collectors |
Example
{
"nftsSold": 123,
"primarySales": "abc123",
"primarySalesUsd": 123.45,
"release": Release,
"secondarySales": "abc123",
"secondarySalesUsd": 123.45,
"totalSales": "xyz789",
"totalSalesUsd": 987.65,
"uniqueCollectors": 123
}
TrendingReleasesSortEnum
Description
Type of sort paratemer used for trending releases
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NFTS_SOLD"
TwitterAPIError
TypeOfRelation
Description
User relation type
Values
| Enum Value | Description |
|---|---|
|
|
Example
"FOLLOWING"
URL
Description
A field whose value conforms to the standard URL format as specified in RFC3986: https://www.ietf.org/rfc/rfc3986.txt.
Example
"http://www.test.com/"
UUID
Description
UUID v4
Example
"6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
UnexpectedValueError
Description
Returned when a value on an entity is not within the expected range for the operation to succeed
Fields
| Field Name | Description |
|---|---|
message -
String!
|
Descriptive message of error |
Example
{"message": "xyz789"}
UnfollowUserInput
Description
Input fields to unfollow user
Fields
| Input Field | Description |
|---|---|
user -
UUID!
|
User id to unfollow |
Example
{
"user": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
UniqueConstraintError
Description
Returned when a unique constraint is violated
Fields
| Field Name | Description |
|---|---|
fields -
[String!]!
|
|
message -
String!
|
Descriptive message of error |
meta -
JSON!
|
Example
{
"fields": ["abc123"],
"message": "abc123",
"meta": {}
}
UnlikeReleaseInput
Description
Input for unlikeRelease mutation
Fields
| Input Field | Description |
|---|---|
releaseId -
UUID!
|
Release identifier to be un-liked |
Example
{
"releaseId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
UnlikeShelfInput
Description
Input for unlikeShelf mutation
Fields
| Input Field | Description |
|---|---|
shelfId -
UUID!
|
Shelf identifier to be un-liked |
Example
{
"shelfId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
UnsubscribeArtistActivityNotificationInput
Description
Unsubscribe to artist updates input
Fields
| Input Field | Description |
|---|---|
artists -
[UUID!]!
|
Unsubscribe current user to up to 51 artists at a time |
Example
{
"artists": [
"6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
]
}
UpdateChannelSettingsInput
Description
Input for updateChannelSettings mutation
Fields
| Input Field | Description |
|---|---|
channelId -
UUID!
|
ID of the channel |
coverImage -
UploadedMedia
|
Uploaded cover image |
description -
String!
|
Description of the channel |
discordUrl -
URL
|
discord URL |
moderatorUserIds -
[UUID!]!
|
User IDs of the channel moderators |
name -
String!
|
Name of the channel |
nameSlug -
String!
|
The URL slug of the channel |
profileImage -
UploadedMedia
|
Uploaded profile image |
rules -
String
|
Rules of the channel |
telegramUrl -
URL
|
Telegram or Guild URL |
tiktokUrl -
URL
|
tiktok URL |
twitterUrl -
URL
|
twitter URL |
websiteUrl -
URL
|
website URL |
Example
{
"channelId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"coverImage": UploadedMedia,
"description": "xyz789",
"discordUrl": "http://www.test.com/",
"moderatorUserIds": [
"6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
],
"name": "abc123",
"nameSlug": "xyz789",
"profileImage": UploadedMedia,
"rules": "xyz789",
"telegramUrl": "http://www.test.com/",
"tiktokUrl": "http://www.test.com/",
"twitterUrl": "http://www.test.com/",
"websiteUrl": "http://www.test.com/"
}
UpdateDraftInfoInput
Description
Input for updateDraftInfo mutation
Fields
| Input Field | Description |
|---|---|
draftId -
String!
|
Draft identifier |
info -
DraftInfoInput!
|
Draft info input |
stepNumber -
PositiveInt!
|
Step number |
Example
{
"draftId": "xyz789",
"info": DraftInfoInput,
"stepNumber": 123
}
UpdateKeyClient
Description
Input for updateKeyClient
Fields
| Input Field | Description |
|---|---|
id -
UUID!
|
Identifier of existing Key Client |
name -
NonEmptyString
|
Change the name of the specified Key Client |
status -
KeyClientStatus
|
Change the status of the specified Key Client |
Example
{
"id": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"name": "string",
"status": "ACTIVE"
}
UploadBlockStatusInput
Description
Input for setUploadBlockStatus mutation
Example
{
"isBlocked": true,
"publicAddress": Address,
"reason": "xyz789"
}
UploadRequest
Description
Input for signedUploadParams mutation
Fields
| Input Field | Description |
|---|---|
fileName -
String!
|
File name of media to be uploaded |
mediaType -
MediaType!
|
Media type to be uploaded |
Example
{
"fileName": "abc123",
"mediaType": "ARTIST_BANNER_IMAGE"
}
UploadedMedia
Description
Media to be uploaded
Fields
| Input Field | Description |
|---|---|
mediaType -
MediaType!
|
Media type to be uploaded |
uploadKey -
String!
|
Upload key received from Query.signedUploadParams |
Example
{
"mediaType": "ARTIST_BANNER_IMAGE",
"uploadKey": "xyz789"
}
UpsertShelfInput
Description
Input fields to upsert shelf
Fields
| Input Field | Description |
|---|---|
coverImage -
UploadedMedia
|
Upsert shelf Cover image |
description -
String
|
Upsert shelf description |
id -
UUID
|
Shelf id to update |
name -
String
|
Upsert shelf name |
type -
ShelfType
|
Upsert shelf type |
Example
{
"coverImage": UploadedMedia,
"description": "abc123",
"id": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36",
"name": "xyz789",
"type": "DEFAULT"
}
User
Description
User entity
Fields
| Field Name | Description |
|---|---|
artist -
Artist
|
Optional artist entity for users with artist profile |
avatar -
Media
|
User avatar |
backedArtists -
ArtistCollectorConnection!
|
Artists backed by user |
Arguments
|
|
bannerImage -
Media
|
Banner image for user profile |
collectedReleases -
CollectedReleaseConnection!
|
Paginated collected releases of user |
Arguments
|
|
collectedReleasesCount -
Int!
|
Total amount of collected release of user |
collectedReleasesIds -
[String!]
|
List of all the identifiers of releases currently collected by the user. If no releases have been collected yet, it returns null instead of an empty list |
collectorPosition -
Int
|
Rank of user for number of bought nfts |
createdAt -
DateTime!
|
User entity creation |
creditAllocations -
[CreditAllocation!]!
|
Credit allocations associated with user |
delegateWalletAddress -
String
|
Delegate wallet public address |
description -
String
|
User custom description |
displayName -
String
|
Custom display name |
email -
String
|
Optional user email |
ens -
String
|
User's ethereum name service domain |
farcasterFid -
String
|
Farcaster FID |
farcasterSignerConnected -
Boolean!
|
User has created a Sound Signer on Farcaster Protocol? |
featuredReleases -
[CollectedRelease!]
|
List of releases in featured sounds |
followerCount -
Int!
|
How many followers a user has |
followers -
UserRelationConnection!
|
Paginated followers of user |
Arguments
|
|
following -
UserRelationConnection!
|
Paginated following of user |
Arguments
|
|
followingCount -
Int!
|
How many users a user is following |
id -
ID!
|
User UUID |
instagramHandle -
String
|
User instagram handle |
invitedByUser -
User
|
User ID of the user who invited this user |
isTopNotableCollector -
Boolean!
|
Is top notable collector |
lastReferralWithdrawableBalance -
String
|
Last tracked referral withdrawable balance. Only available for own authenticated user |
likedSounds -
Shelf
|
An autogenerated playlist that contains all the releases the user liked |
location -
GeoLocationPlaceGoogle
|
User provided location |
nftsOwned -
Int!
|
How many nfts a user owns |
nftsPaginated -
NftConnection!
|
Paginated NFTs owned by user |
Arguments
|
|
nonce -
Int!
|
Nonce for authentication purposes |
numBackedArtists -
Int!
|
Number of artists backed by user |
postCount -
Int!
|
Amount of posts |
publicAddress -
String!
|
Wallet public address |
roles -
UserRoles!
|
Possible roles for user |
shelves -
ShelfConnection!
|
Paginated shelves of user |
Arguments
|
|
shelvesCount -
Int!
|
Shelves count of the user |
Arguments
|
|
showSplitsFeature -
Boolean!
|
Should the user show the splits feature |
tiktokUrl -
String
|
User tiktok url |
topCollectorPosition -
Int
|
Rank of user by total spent. Rank is capped at 200. |
twitterHandle -
String
|
Verifier twitter handle |
username -
String!
|
Returns user username |
verifiedNotificationEmail -
String
|
Verified notification email if set. This value will only be available if authenticated user matches the returned user |
webappUri -
String!
|
Webapp URI of User. |
Example
{
"artist": Artist,
"avatar": Media,
"backedArtists": ArtistCollectorConnection,
"bannerImage": Media,
"collectedReleases": CollectedReleaseConnection,
"collectedReleasesCount": 123,
"collectedReleasesIds": ["abc123"],
"collectorPosition": 987,
"createdAt": "2007-12-03T10:15:30Z",
"creditAllocations": [CreditAllocation],
"delegateWalletAddress": "xyz789",
"description": "abc123",
"displayName": "abc123",
"email": "xyz789",
"ens": "abc123",
"farcasterFid": "abc123",
"farcasterSignerConnected": false,
"featuredReleases": [CollectedRelease],
"followerCount": 123,
"followers": UserRelationConnection,
"following": UserRelationConnection,
"followingCount": 987,
"id": "4",
"instagramHandle": "abc123",
"invitedByUser": User,
"isTopNotableCollector": true,
"lastReferralWithdrawableBalance": "xyz789",
"likedSounds": Shelf,
"location": GeoLocationPlaceGoogle,
"nftsOwned": 123,
"nftsPaginated": NftConnection,
"nonce": 987,
"numBackedArtists": 123,
"postCount": 123,
"publicAddress": "xyz789",
"roles": UserRoles,
"shelves": ShelfConnection,
"shelvesCount": 123,
"showSplitsFeature": true,
"tiktokUrl": "xyz789",
"topCollectorPosition": 987,
"twitterHandle": "abc123",
"username": "xyz789",
"verifiedNotificationEmail": "xyz789",
"webappUri": "abc123"
}
UserCollectedManySongsAggregate
Description
User collected many songs aggregate
Fields
| Field Name | Description |
|---|---|
collectedReleases -
[ActivityFeedGroupCollectedRelease!]!
|
Releases corresponding to user collected many songs activity feed group |
collectionTypes -
[CollectionMarketType!]!
|
Set of the distinct market classifications grouped in the aggregate |
numReleases -
Int!
|
Number of releases that a user purchased in an activity feed group |
post -
Post
|
Post backing this particular activity feed group. Used for upvote, comment interactions. It is always NULL if this activity feed group is in a personal feed. Otherwise NULL if no backing post exists |
user -
User!
|
User that collected many songs in activity feed group |
Example
{
"collectedReleases": [
ActivityFeedGroupCollectedRelease
],
"collectionTypes": ["AIRDROP"],
"numReleases": 123,
"post": Post,
"user": User
}
UserCollectedReleasesFilter
Description
Filter of User.collectedReleases paginated field
Fields
| Input Field | Description |
|---|---|
genres -
[Genres!]
|
Filters on a list of specified genres |
releaseAlbumRevealStatus -
ReleaseAlbumRevealFilterOption!
|
Filters on whether album releases have been revealed or not |
releaseIds -
[UUID!]
|
Filter on a list of specified release ids |
text -
NonEmptyString
|
Text search on release title or artist's name or handle |
type -
[ReleaseType!]
|
Filters on release type |
Example
{
"genres": ["AFROBEAT"],
"releaseAlbumRevealStatus": "ALL",
"releaseIds": [
"6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
],
"text": "string",
"type": ["ALBUM"]
}
UserConnection
Description
Paginated connection of Users
Fields
| Field Name | Description |
|---|---|
edges -
[UserConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [UserConnectionEdge],
"pageInfo": PageInfo
}
UserConnectionEdge
UserCreatedPostAggregate
Description
User created post aggregate
Fields
| Field Name | Description |
|---|---|
post -
Post
|
Post that the user created. Can be NULL if the post was deleted |
Example
{"post": Post}
UserCursorConnectionArgs
Description
Cursor connection parameters
Fields
| Input Field | Description |
|---|---|
after -
String
|
Start forwards pagination since "after" cursor |
before -
String
|
Start backwards pagination since "before" cursor |
first -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "after", with a maximum of 51 nodes. |
last -
NonNegativeInt
|
Limit the amount of nodes to be fetched, to be used with "before", with a maximum of 51 nodes. |
sort -
SortOrder!
|
Sort the users ascending or descending relative to the user creation date |
Example
{
"after": "xyz789",
"before": "abc123",
"first": 123,
"last": 123,
"sort": "ASC"
}
UserFollowRecommendationBatch
UserLikedPlaylistAggregate
UserLikedSongsAggregate
Description
User liked releases aggregate
Fields
| Field Name | Description |
|---|---|
releasesLiked -
[ShelfRelease!]!
|
Releases liked in an activity feed group |
shelf -
Shelf
|
Shelf that releases are added to in activity feed group |
user -
User!
|
User that liked the releases |
Example
{
"releasesLiked": [ShelfRelease],
"shelf": Shelf,
"user": User
}
UserNftsConnectionFilters
Description
Filter the NFTs of User
Fields
| Input Field | Description |
|---|---|
releases -
[UUID!]
|
Only include Nfts from specified releases |
Example
{
"releases": [
"6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
]
}
UserNotification
Description
Entity that represents user notifications
Fields
| Field Name | Description |
|---|---|
id -
ID!
|
UserNotification UUID |
timestamp -
Timestamp!
|
Timestamp for notification |
user -
User
|
Recipient user entity |
Possible Types
| UserNotification Types |
|---|
Example
{
"id": "4",
"timestamp": 1592577642,
"user": User
}
UserNotificationConnection
Description
Paginated UserNotification connection
Fields
| Field Name | Description |
|---|---|
edges -
[UserNotificationConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [UserNotificationConnectionEdge],
"pageInfo": PageInfo
}
UserNotificationConnectionEdge
Description
Edge of UserNotification connection
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Cursor to be used for pagination |
node -
UserNotification!
|
UserNotification node |
Example
{
"cursor": "abc123",
"node": UserNotification
}
UserNotificationPreferences
Description
User notification preferences
Fields
| Field Name | Description |
|---|---|
email -
String
|
Desired notification email |
emailVerificationStatus -
EmailVerificationStatus!
|
Email verification status |
receiveArtistUpdateEmails -
Boolean!
|
Opt in to receive artist drop updates via email. |
receiveMentionUpdateEmails -
Boolean!
|
Opt in to receive updates via email anytime you are mentioned on Sound. |
receivePushNotifications -
Boolean!
|
Send push notifications when new notifications are available. |
Example
{
"email": "abc123",
"emailVerificationStatus": "EXPIRED",
"receiveArtistUpdateEmails": false,
"receiveMentionUpdateEmails": false,
"receivePushNotifications": true
}
UserNotificationsRealtimeUpdate
Description
New or updated user notification
Fields
| Field Name | Description |
|---|---|
notificationTimestamp -
Timestamp
|
Timestamp for the latest notification timestamp. NULL if there is no latest notification |
Example
{"notificationTimestamp": 1592577642}
UserNotificationsStatus
Description
Current state of user notifications
Fields
| Field Name | Description |
|---|---|
hasUnreadNotifications -
Boolean!
|
True if the user has unread notifications |
id -
ID!
|
Unique user identifier for notifications status |
lastReadTimestamp -
Timestamp
|
Timestamp for the latest read notification. NULL if user has never read any notifications |
user -
User!
|
User associated with the current status |
Example
{
"hasUnreadNotifications": true,
"id": "4",
"lastReadTimestamp": 1592577642,
"user": User
}
UserPostStatus
Description
Unique post status for user
Fields
| Field Name | Description |
|---|---|
postId -
String!
|
ID of the post |
repostCount -
Int!
|
Number of reposts on the post |
repostStatus -
CurrentUserPostRepostStatusType!
|
Repost status by the user |
upvoteCount -
Int!
|
Number of upvotes on the post |
voteStatus -
CurrentUserPostVoteStatus!
|
Vote status of the post by the user |
Example
{
"postId": "xyz789",
"repostCount": 987,
"repostStatus": "NOT_REPOSTED",
"upvoteCount": 987,
"voteStatus": "NO_VOTE"
}
UserPresavedRelease
Description
User presaved release action entity
Example
{
"date": "2007-12-03T10:15:30Z",
"id": 4,
"release": Release,
"user": User
}
UserRelation
Description
User relation entity
Fields
| Field Name | Description |
|---|---|
createdAt -
DateTime!
|
User relation creation date |
id -
ID!
|
User relation identifier |
relation -
TypeOfRelation!
|
Type of user relation |
userA -
User!
|
UserA of relation |
userB -
User!
|
UserB of relation |
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"id": 4,
"relation": "FOLLOWING",
"userA": User,
"userB": User
}
UserRelationConnection
Description
Paginated user relation connection
Fields
| Field Name | Description |
|---|---|
edges -
[UserRelationConnectionEdge!]!
|
Edges of current page |
pageInfo -
PageInfo!
|
Pagination helpers information |
Example
{
"edges": [UserRelationConnectionEdge],
"pageInfo": PageInfo
}
UserRelationConnectionEdge
Description
User Relation Node edge
Fields
| Field Name | Description |
|---|---|
cursor -
String!
|
Cursor to be used for pagination |
node -
UserRelation!
|
User Relation Entity |
Example
{
"cursor": "abc123",
"node": UserRelation
}
UserRelationStatus
UserReleaseStatus
UserRoles
UserShelvesFilter
Description
Filter the shelves of a user
Fields
| Input Field | Description |
|---|---|
text -
NonEmptyString
|
Case-insensitive text search on shelves names |
type -
ShelfTypeFilter!
|
Filter by different types of shelves available for users. |
Example
{"text": "string", "type": "ALL"}
UserVoteOnPostComment
Description
Like status of entityId for user
Fields
| Field Name | Description |
|---|---|
postCommentId -
String!
|
ID of the post comment |
upvoteCount -
Int!
|
Number of upvotes on the post |
voteStatus -
CurrentUserPostVoteStatus!
|
Vote status of the post by the user |
Example
{
"postCommentId": "abc123",
"upvoteCount": 123,
"voteStatus": "NO_VOTE"
}
ValidationError
Description
Arbitrary validation error
Fields
| Field Name | Description |
|---|---|
message -
String!
|
Example
{"message": "abc123"}
VersionStatusInput
Description
Input of VersionSupported query
Fields
| Input Field | Description |
|---|---|
platform -
PlatformType!
|
Platform type |
version -
SemanticVersion!
|
Semantic version |
Example
{"platform": "ANDROID", "version": SemanticVersion}
VersionStatusResponse
Description
Union of version status response types
Types
| Union Types |
|---|
Example
NotSupportedVersion
ViralMintsReached
Description
A release has reached viral mints status
Fields
| Field Name | Description |
|---|---|
featuredCollectors -
[User!]!
|
Featured collectors |
id -
ID!
|
UserNotification UUID |
release -
Release
|
Viral mints release entity |
timestamp -
Timestamp!
|
Timestamp for notification |
user -
User
|
Recipient user entity |
Example
{
"featuredCollectors": [User],
"id": "4",
"release": Release,
"timestamp": 1592577642,
"user": User
}
ViralPresave
Description
A release has reached viral presaves status
Fields
| Field Name | Description |
|---|---|
featuredPresavers -
[User!]!
|
Featured presavers |
id -
ID!
|
UserNotification UUID |
release -
Release!
|
Viral mints release entity |
timestamp -
Timestamp!
|
Timestamp for notification |
user -
User
|
Recipient user entity |
Example
{
"featuredPresavers": [User],
"id": 4,
"release": Release,
"timestamp": 1592577642,
"user": User
}
Void
Description
Represents NULL values
WeeklyRateLimitError
WithdrawAffiliateEarnings
Description
Withdraw affiliate earnings information
Fields
| Field Name | Description |
|---|---|
amount -
String!
|
Total withdrawable amount of eth in wei |
chainId -
Int!
|
Chain ID on which release is minted on |
id -
ID!
|
Unique user identifier of affiliate earnings |
minterAddresses -
[String!]!
|
Minter addresses with withdrawable affiliate fees for the authenticated user. |
Example
{
"amount": "abc123",
"chainId": 987,
"id": 4,
"minterAddresses": ["xyz789"]
}
WithdrawableEarnings
Description
Withdrawable contract earnings, returns null for values if contract contain dust amounts that are not worth withdrawing
Fields
| Field Name | Description |
|---|---|
releaseContract -
ReleaseContractEarning
|
Release contract earnings |
splitContract -
SplitsContractEarning
|
Split contract earnings |
Example
{
"releaseContract": ArtistContractEarning,
"splitContract": SplitsContractEarning
}
ZodValidationError
Description
Validation error on meta schema
Fields
| Field Name | Description |
|---|---|
errors -
[BaseError!]!
|
Specific errors found on validation |
message -
String!
|
Example
{
"errors": [BaseError],
"message": "abc123"
}
Subscriptions
activityFeedNewGroup
Description
Subscribe to new activity feed groups added to a particular activity feed
Response
Returns a
SubscriptionNewActivityFeedGroup!
Arguments
| Name | Description |
|---|---|
activityFeedId -
UUID!
|
Activity Feed identifier |
Example
Query
subscription ActivityFeedNewGroup($activityFeedId: UUID!) {
activityFeedNewGroup(activityFeedId: $activityFeedId) {
activityFeedGroupId
activityFeedGroupInformationTypename
}
}
Variables
{
"activityFeedId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"activityFeedNewGroup": {
"activityFeedGroupId": "abc123",
"activityFeedGroupInformationTypename": "xyz789"
}
}
}
count
globalUserNotificationUpdates
Description
[AUTHENTICATED] Subscribe to global user notification updates
Response
Returns a
UserNotificationsRealtimeUpdate!
Example
Query
subscription GlobalUserNotificationUpdates {
globalUserNotificationUpdates {
notificationTimestamp
}
}
Response
{
"data": {
"globalUserNotificationUpdates": {"notificationTimestamp": 1592577642}
}
}
releaseCollectorUpdates
Description
Subscribe to updates of release collectors
Response
Returns a
ReleaseCollectorUpdates!
Arguments
| Name | Description |
|---|---|
releaseId -
UUID!
|
Release identifier |
Example
Query
subscription ReleaseCollectorUpdates($releaseId: UUID!) {
releaseCollectorUpdates(releaseId: $releaseId) {
collector {
gaNftsCount
goldenEggSerialNumber
id
lowestNftSerialNumber
mostRecentCommentMessage
nftsCount
nftsCountGa
nftsCountVip
userArtistId
userArtistName
userArtistSoundHandle
userAvatarUrl
userId
userPublicAddress
userWebappUri
username
vipNftsCount
}
releaseId
userPublicAddress
}
}
Variables
{
"releaseId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"releaseCollectorUpdates": {
"collector": CollectorUpdateInfo,
"releaseId": 4,
"userPublicAddress": "abc123"
}
}
}
releaseNftCommentUpdate
Description
Subscribe to NFTs comments updates of specified release
Response
Returns
[ReleaseNftWithCommentUpdate!]!
Arguments
| Name | Description |
|---|---|
releaseId -
UUID!
|
Release identifier |
Example
Query
subscription ReleaseNftCommentUpdate($releaseId: UUID!) {
releaseNftCommentUpdate(releaseId: $releaseId) {
commentMessage
contractAddress
id
isBurned
isGoldenEgg
ownerArtistId
ownerArtistName
ownerArtistSoundHandle
ownerAvatarUrl
ownerPublicAddress
ownerReleaseLowestNftSerialNumber
ownerReleaseNftCount
ownerUserId
ownerUsername
ownerWebappUri
serialNumber
songSlot
tokenId
updatedAt
}
}
Variables
{
"releaseId": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"releaseNftCommentUpdate": [
{
"commentMessage": "abc123",
"contractAddress": "xyz789",
"id": 4,
"isBurned": true,
"isGoldenEgg": true,
"ownerArtistId": 4,
"ownerArtistName": "abc123",
"ownerArtistSoundHandle": "abc123",
"ownerAvatarUrl": "xyz789",
"ownerPublicAddress": "xyz789",
"ownerReleaseLowestNftSerialNumber": 987,
"ownerReleaseNftCount": 123,
"ownerUserId": 4,
"ownerUsername": "xyz789",
"ownerWebappUri": "xyz789",
"serialNumber": 123,
"songSlot": 123,
"tokenId": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
]
}
}
releaseUpdates
Description
Subscribe to release updates
Response
Returns a
ReleaseUpdates!
Arguments
| Name | Description |
|---|---|
id -
UUID!
|
Release identifier |
Example
Query
subscription ReleaseUpdates($id: UUID!) {
releaseUpdates(id: $id) {
chainId
finalQuantity
id
isFirstPhaseCompleted
mintStartTimestamp
numSold
primaryCollected
primaryRaisedInWei
samBuyBufferBpsOverride
samSellBufferBpsOverride
soundSwapCollected
soundSwapRaisedInWei
title
totalMinted
totalSupply
totalVolume
}
}
Variables
{
"id": "6d3b2bf2-f37e-4d41-ba14-ba2715aebb36"
}
Response
{
"data": {
"releaseUpdates": {
"chainId": 987,
"finalQuantity": 987,
"id": 4,
"isFirstPhaseCompleted": false,
"mintStartTimestamp": 1592577642,
"numSold": 123,
"primaryCollected": 987,
"primaryRaisedInWei": "xyz789",
"samBuyBufferBpsOverride": 987,
"samSellBufferBpsOverride": 123,
"soundSwapCollected": 987,
"soundSwapRaisedInWei": "xyz789",
"title": "xyz789",
"totalMinted": 123,
"totalSupply": 987,
"totalVolume": "xyz789"
}
}
}
userNotificationUpdates
Description
[AUTHENTICATED] Subscribe to user notification updates
Response
Returns a
UserNotificationsRealtimeUpdate!
Example
Query
subscription UserNotificationUpdates {
userNotificationUpdates {
notificationTimestamp
}
}
Response
{"data": {"userNotificationUpdates": {"notificationTimestamp": 1592577642}}}