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"
}
}
}
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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
Response
{
"data": {
"artist": {
"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": ["abc123"],
"season": "xyz789",
"soundHandle": "abc123",
"spotifyUrl": "abc123",
"tokenSymbol": "xyz789",
"user": User,
"userId": "abc123",
"webappUri": "abc123"
}
}
}
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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01",
"filter": {"activityTypes": ["ALL"], "types": ["ALL"]},
"pagination": {"first": 10, "sort": "DESC"}
}
Response
{
"data": {
"artistActivityFeed": {
"edges": [ArtistActionConnectionEdge],
"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": "xyz789"}
Response
{
"data": {
"artistByHandle": {
"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": "abc123",
"soundHandle": "abc123",
"spotifyUrl": "xyz789",
"tokenSymbol": "abc123",
"user": User,
"userId": "abc123",
"webappUri": "xyz789"
}
}
}
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": "xyz789"
}
}
}
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": ["xyz789"],
"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": "abc123",
"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"
}
}
}
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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
Response
{
"data": {
"channelById": {
"animatedProfileImage": Media,
"coverImage": Media,
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"discordUrl": "xyz789",
"id": 4,
"name": "abc123",
"nameSlug": "xyz789",
"profileImage": Media,
"published": true,
"rules": "xyz789",
"staticProfileImage": Media,
"telegramUrl": "abc123",
"tiktokUrl": "xyz789",
"twitterUrl": "xyz789",
"webappUri": "xyz789",
"websiteUrl": "abc123"
}
}
}
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": "abc123"}
Response
{
"data": {
"channelBySlug": {
"animatedProfileImage": Media,
"coverImage": Media,
"createdAt": "2007-12-03T10:15:30Z",
"description": "xyz789",
"discordUrl": "abc123",
"id": "4",
"name": "xyz789",
"nameSlug": "abc123",
"profileImage": Media,
"published": true,
"rules": "abc123",
"staticProfileImage": Media,
"telegramUrl": "xyz789",
"tiktokUrl": "abc123",
"twitterUrl": "xyz789",
"webappUri": "abc123",
"websiteUrl": "abc123"
}
}
}
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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01",
"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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01",
"pagination": {"first": 10, "sort": "DESC"}
}
Response
{
"data": {
"channelMembers": {
"edges": [ChannelMemberConnectionEdge],
"pageInfo": PageInfo
}
}
}
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": "xyz789",
"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": 987,
"notificationStatus": "DISABLED",
"postCount": 123
}
]
}
}
claimedSongSlots
Description
[PUBLIC] Get the total number of claimed song slots
Example
Query
query ClaimedSongSlots($releaseId: UUID!) {
claimedSongSlots(releaseId: $releaseId)
}
Variables
{
"releaseId": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
Response
{"data": {"claimedSongSlots": [123]}}
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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01",
"postId": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
Response
{
"data": {
"creditSplit": {
"creditAllocations": [CreditAllocation],
"id": 4,
"mintedReleases": [Release],
"releases": [Release],
"splitAddress": "abc123"
}
}
}
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"
}
}
}
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
}
}
}
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": ["xyz789"]
}
}
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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
Response
{
"data": {
"eggGame": {
"animatedGoldenEggImageOptimized": Media,
"finalSerialBlockHash": "xyz789",
"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"
}
}
}
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": "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": "xyz789",
"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": 123,
"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": 987,
"saleDetails": SaleDetails,
"saleSchedules": [SaleSchedule],
"salesAffiliateFeesPercent": [
"xyz789"
],
"samAddress": "xyz789",
"samBuyBufferBpsOverride": 987,
"samConfig": SamConfig,
"samSellBufferBpsOverride": 987,
"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": "abc123",
"webappUri": "abc123"
}
]
}
}
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
}
}
}
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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
Response
{
"data": {
"likeActivityFeed": {
"edges": [LikeActionConnectionEdge],
"pageInfo": PageInfo
}
}
}
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": "abc123"}
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": "xyz789",
"unhashedLeaf": "xyz789"
}
Response
{
"data": {
"merkleTreeProof": {
"proof": ["xyz789"],
"unhashedLeaf": "abc123"
}
}
}
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": "xyz789",
"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": 987,
"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": "xyz789",
"finalQuantity": 123,
"fundingAddress": "xyz789",
"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": 123,
"mintStartTimestamp": 1592577642,
"nftsPaginated": NftConnection,
"numSold": 123,
"openseaUrl": "xyz789",
"postCount": 123,
"price": "xyz789",
"publicAffiliateFeeBPS": 123,
"publicAffiliateFeePercent": "xyz789",
"publicMintStart": "2007-12-03T10:15:30Z",
"quantity": 987,
"quantityLowerBound": 123,
"quantityUpperBound": 123,
"rewards": [Reward],
"royaltyBps": 123,
"saleDetails": SaleDetails,
"saleSchedules": [SaleSchedule],
"salesAffiliateFeesPercent": [
"xyz789"
],
"samAddress": "abc123",
"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": "xyz789",
"topCollectors": [TopReleaseCollector],
"topPosts": [Post],
"topSpentCollector": ReleaseCollector,
"totalMinted": 987,
"totalSupply": 987,
"track": Track,
"type": "ALBUM",
"vipAnimatedCoverImage": Media,
"vipCoverImage": Media,
"webEmbed": "xyz789",
"webappUri": "xyz789"
}
}
}
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": "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": true,
"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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
Response
{
"data": {
"nftFromId": {
"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": false,
"isGoldenEgg": false,
"openSeaMetadataAttributes": [
OpenSeaMetadataAttribute
],
"owner": User,
"release": Release,
"serialNumber": 987,
"songSlot": 123,
"tierNumber": 987,
"title": "abc123",
"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": 987}}
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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01",
"playlistId": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
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": 123,
"likedBy": UserConnection,
"likes": 987,
"linkSlug": "abc123",
"name": "abc123",
"numLikes": 123,
"numReferralPurchases": 987,
"numUsersReferred": 987,
"orderedReleases": ShelfReleaseConnection,
"playTimeInSeconds": 123,
"previewReleases": [ShelfRelease],
"releaseCount": 123,
"releaseIds": ["abc123"],
"socialProofReferrals": [User],
"trackIds": ["abc123"],
"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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
Response
{
"data": {
"post": {
"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": "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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
Response
{
"data": {
"postComment": {
"author": User,
"authorChannelRole": "MODERATOR",
"authorNftsCountGa": 123,
"authorNftsCountVip": 987,
"content": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"currentHolderOfRelease": false,
"id": "4",
"labels": ["RELEASE_ARTIST"],
"lexicalContent": {},
"parentComment": PostComment,
"post": Post,
"repliesCount": 123,
"updatedAt": "2007-12-03T10:15:30Z",
"upvoteCount": 987
}
}
}
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
}
}
}
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": false,
"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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
Response
{
"data": {
"release": {
"activityFeed": ReleaseActionConnection,
"affiliates": ReleaseAffiliateConnection,
"airdropCount": 987,
"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": "xyz789",
"eggGame": EggGame,
"externalUrl": "xyz789",
"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": 123,
"openseaUrl": "abc123",
"postCount": 123,
"price": "abc123",
"publicAffiliateFeeBPS": 123,
"publicAffiliateFeePercent": "xyz789",
"publicMintStart": "2007-12-03T10:15:30Z",
"quantity": 123,
"quantityLowerBound": 987,
"quantityUpperBound": 987,
"rewards": [Reward],
"royaltyBps": 987,
"saleDetails": SaleDetails,
"saleSchedules": [SaleSchedule],
"salesAffiliateFeesPercent": [
"xyz789"
],
"samAddress": "abc123",
"samBuyBufferBpsOverride": 123,
"samConfig": SamConfig,
"samSellBufferBpsOverride": 987,
"scheduleIds": [ScheduleIdentifier],
"season": "abc123",
"shelves": ShelfConnection,
"socialProofCollectors": [User],
"spotifyPresaveCampaign": true,
"spotifyPresaveCount": 987,
"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": "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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
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": 123
}
}
}
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
}
}
}
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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
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": 123,
"release": Release,
"trendingIndicator": "DOWN",
"trendingStreak": 987
}
}
}
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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01",
"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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
Response
{
"data": {
"releaseCollectorFromId": {
"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"
}
}
}
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": "xyz789"
}
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": "abc123",
"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": false,
"isFirstPhaseCompleted": false,
"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": "xyz789",
"postCount": 987,
"price": "xyz789",
"publicAffiliateFeeBPS": 987,
"publicAffiliateFeePercent": "abc123",
"publicMintStart": "2007-12-03T10:15:30Z",
"quantity": 987,
"quantityLowerBound": 987,
"quantityUpperBound": 123,
"rewards": [Reward],
"royaltyBps": 123,
"saleDetails": SaleDetails,
"saleSchedules": [SaleSchedule],
"salesAffiliateFeesPercent": [
"abc123"
],
"samAddress": "abc123",
"samBuyBufferBpsOverride": 123,
"samConfig": SamConfig,
"samSellBufferBpsOverride": 987,
"scheduleIds": [ScheduleIdentifier],
"season": "abc123",
"shelves": ShelfConnection,
"socialProofCollectors": [User],
"spotifyPresaveCampaign": false,
"spotifyPresaveCount": 987,
"spotifyTrackId": "xyz789",
"staticCoverImage": Media,
"staticGaCoverImage": Media,
"staticVipCoverImage": Media,
"supplyCutoffTimestamp": 1592577642,
"title": "abc123",
"titleSlug": "xyz789",
"topCollectors": [TopReleaseCollector],
"topPosts": [Post],
"topSpentCollector": ReleaseCollector,
"totalMinted": 123,
"totalSupply": 123,
"track": Track,
"type": "ALBUM",
"vipAnimatedCoverImage": Media,
"vipCoverImage": Media,
"webEmbed": "xyz789",
"webappUri": "abc123"
}
}
}
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": 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": "abc123",
"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": false,
"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": "abc123",
"postCount": 987,
"price": "xyz789",
"publicAffiliateFeeBPS": 987,
"publicAffiliateFeePercent": "xyz789",
"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": false,
"spotifyPresaveCount": 123,
"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": "abc123",
"webappUri": "xyz789"
}
}
}
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": "abc123",
"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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
Response
{
"data": {
"releasePosts": {
"edges": [PostConnectionEdge],
"pageInfo": PageInfo
}
}
}
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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
Response
{
"data": {
"releaseWaveformPosts": [
{
"content": "abc123",
"gaNftsCount": 987,
"id": 4,
"lexicalContent": {},
"nftsCount": 123,
"postId": "4",
"songSlot": 987,
"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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
Response
{
"data": {
"releasesCollectorsAlsoMinted": [
{
"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": 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": "xyz789",
"finalQuantity": 987,
"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": 123,
"mintStartTimestamp": 1592577642,
"nftsPaginated": NftConnection,
"numSold": 987,
"openseaUrl": "abc123",
"postCount": 987,
"price": "xyz789",
"publicAffiliateFeeBPS": 987,
"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": 987,
"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": 123,
"track": Track,
"type": "ALBUM",
"vipAnimatedCoverImage": Media,
"vipCoverImage": Media,
"webEmbed": "abc123",
"webappUri": "abc123"
}
]
}
}
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
}
}
}
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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
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": 123,
"linkSlug": "xyz789",
"name": "xyz789",
"numLikes": 987,
"numReferralPurchases": 123,
"numUsersReferred": 987,
"orderedReleases": ShelfReleaseConnection,
"playTimeInSeconds": 123,
"previewReleases": [ShelfRelease],
"releaseCount": 123,
"releaseIds": ["xyz789"],
"socialProofReferrals": [User],
"trackIds": ["abc123"],
"type": "DEFAULT",
"user": User,
"webEmbed": "xyz789",
"webappUri": "xyz789"
}
}
}
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": 123,
"totalVolume": "abc123",
"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": 123,
"primarySales": "abc123",
"primarySalesUsd": 987.65,
"secondarySales": "xyz789",
"secondarySalesUsd": 123.45,
"totalSales": "abc123",
"totalSalesUsd": 123.45,
"uniqueCollectors": 123
}
]
}
}
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": 987,
"totalSpent": "xyz789",
"totalSpentUsd": 987.65,
"user": User,
"userAddress": "xyz789"
}
]
}
}
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": 123, "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": 123.45,
"release": Release,
"secondarySales": "abc123",
"secondarySalesUsd": 123.45,
"totalSales": "abc123",
"totalSalesUsd": 123.45,
"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": 123,
"comments": PostCommentConnection,
"content": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"creator": User,
"farcasterHash": "xyz789",
"id": "4",
"lexicalContent": {},
"repostCount": 123,
"upvoteCount": 987,
"webappUri": "abc123"
}
]
}
}
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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
Response
{
"data": {
"track": {
"audio": AudioMedia,
"audioOriginal": Media,
"duration": 987,
"id": "4",
"normalizedPeaks": [987],
"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": 987,
"collectedReleasesIds": ["xyz789"],
"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": 987,
"publicAddress": "xyz789",
"roles": UserRoles,
"shelves": ShelfConnection,
"shelvesCount": 987,
"showSplitsFeature": false,
"tiktokUrl": "xyz789",
"topCollectorPosition": 987,
"twitterHandle": "abc123",
"username": "xyz789",
"verifiedNotificationEmail": "xyz789",
"webappUri": "xyz789"
}
]
}
}
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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
Response
{
"data": {
"user": {
"artist": Artist,
"avatar": Media,
"backedArtists": ArtistCollectorConnection,
"bannerImage": Media,
"collectedReleases": CollectedReleaseConnection,
"collectedReleasesCount": 123,
"collectedReleasesIds": ["xyz789"],
"collectorPosition": 987,
"createdAt": "2007-12-03T10:15:30Z",
"creditAllocations": [CreditAllocation],
"delegateWalletAddress": "abc123",
"description": "xyz789",
"displayName": "abc123",
"email": "xyz789",
"ens": "abc123",
"farcasterFid": "xyz789",
"farcasterSignerConnected": true,
"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": 987,
"nftsPaginated": NftConnection,
"nonce": 987,
"numBackedArtists": 123,
"postCount": 123,
"publicAddress": "abc123",
"roles": UserRoles,
"shelves": ShelfConnection,
"shelvesCount": 123,
"showSplitsFeature": false,
"tiktokUrl": "abc123",
"topCollectorPosition": 123,
"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": 123,
"collectedReleasesIds": ["xyz789"],
"collectorPosition": 987,
"createdAt": "2007-12-03T10:15:30Z",
"creditAllocations": [CreditAllocation],
"delegateWalletAddress": "xyz789",
"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": "abc123",
"invitedByUser": User,
"isTopNotableCollector": true,
"lastReferralWithdrawableBalance": "xyz789",
"likedSounds": Shelf,
"location": GeoLocationPlaceGoogle,
"nftsOwned": 987,
"nftsPaginated": NftConnection,
"nonce": 123,
"numBackedArtists": 123,
"postCount": 987,
"publicAddress": "abc123",
"roles": UserRoles,
"shelves": ShelfConnection,
"shelvesCount": 123,
"showSplitsFeature": true,
"tiktokUrl": "xyz789",
"topCollectorPosition": 987,
"twitterHandle": "xyz789",
"username": "abc123",
"verifiedNotificationEmail": "xyz789",
"webappUri": "abc123"
}
}
}
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": "abc123"}
Response
{
"data": {
"userByArtistHandle": {
"artist": Artist,
"avatar": Media,
"backedArtists": ArtistCollectorConnection,
"bannerImage": Media,
"collectedReleases": CollectedReleaseConnection,
"collectedReleasesCount": 123,
"collectedReleasesIds": ["xyz789"],
"collectorPosition": 987,
"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": 123,
"id": 4,
"instagramHandle": "xyz789",
"invitedByUser": User,
"isTopNotableCollector": false,
"lastReferralWithdrawableBalance": "abc123",
"likedSounds": Shelf,
"location": GeoLocationPlaceGoogle,
"nftsOwned": 123,
"nftsPaginated": NftConnection,
"nonce": 123,
"numBackedArtists": 123,
"postCount": 123,
"publicAddress": "abc123",
"roles": UserRoles,
"shelves": ShelfConnection,
"shelvesCount": 123,
"showSplitsFeature": false,
"tiktokUrl": "abc123",
"topCollectorPosition": 123,
"twitterHandle": "xyz789",
"username": "abc123",
"verifiedNotificationEmail": "xyz789",
"webappUri": "abc123"
}
}
}
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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
Response
{
"data": {
"userLikeActivityFeed": {
"edges": [CollectorActionConnectionEdge],
"pageInfo": PageInfo
}
}
}
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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
Response
{
"data": {
"userPosts": {
"edges": [PostConnectionEdge],
"pageInfo": PageInfo
}
}
}
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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
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": "xyz789",
"description": "xyz789",
"displayName": "abc123",
"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": "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": 987,
"twitterHandle": "xyz789",
"username": "xyz789",
"verifiedNotificationEmail": "xyz789",
"webappUri": "abc123"
}
]
}
}
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}}
Mutations
generateAuthChallenge
Description
[PUBLIC] Generate auth challenge for given public address and give back new nonce
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}}
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": "abc123",
"id": 4,
"name": "xyz789",
"numCollectors": 987,
"numNfts": 987,
"numReleases": 123,
"pickedRelease": Release,
"releases": ReleaseConnection,
"releasesGenres": ["xyz789"],
"season": "xyz789",
"soundHandle": "abc123",
"spotifyUrl": "xyz789",
"tokenSymbol": "abc123",
"user": User,
"userId": "xyz789",
"webappUri": "xyz789"
}
}
}
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": "xyz789",
"signedMessage": "xyz789"
}
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": "abc123"}}
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": "abc123"}
Response
{
"data": {
"verifyNotificationEmail": MutationVerifyNotificationEmailSuccess
}
}
Types
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": 123
}
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": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"creator": User,
"farcasterHash": "xyz789",
"id": 4,
"lexicalContent": {},
"repostCount": 123,
"upvoteCount": 123,
"webappUri": "abc123"
}
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": "abc123",
"hasGoldenEgg": true,
"mostRecentPurchasedFromUser": User,
"release": Release,
"totalOwnedEditions": 123,
"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": "abc123",
"node": ActivityFeedGroup
}
ActivityFeedGroupFeaturedCollector
Description
Activity feed group featured collector entity
Example
{
"amountPaidInWei": "abc123",
"nftsCount": 123,
"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"
Address
Description
Ethereum address
Example
Address
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": "abc123",
"mintsQuantity": 987,
"soundsReferred": 987,
"totalVolume": "abc123",
"user": User
}
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": 123,
"fromTokenId": 987,
"id": "4",
"quantity": 987,
"release": Release,
"serialNumber": 123,
"tierNumber": 987,
"toSerialNumber": 123,
"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": false,
"locationIds": ["abc123"],
"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": "abc123",
"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
}
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
}
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": "xyz789",
"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": "xyz789",
"webappUri": "xyz789"
}
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": "abc123",
"status": "ACCEPTED",
"user": User
}
ArtistApplicationInfo
Description
Artist application info
Example
{
"artistName": "abc123",
"coverImage": MediaUploadStepInfo,
"email": "abc123",
"instagramHandle": "abc123",
"soundHandle": "xyz789",
"spotifyUrl": "xyz789",
"twitterHandle": "xyz789"
}
ArtistApplicationStatus
Description
Artist application status
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ACCEPTED"
ArtistCollector
Description
ArtistCollector
Example
{
"artist": Artist,
"firstNftCollected": Nft,
"firstNftCollectedDate": "2007-12-03T10:15:30Z",
"id": "4",
"nftsCount": 987,
"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": "xyz789",
"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
}
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": "xyz789",
"contractAddress": "abc123",
"editionId": "xyz789",
"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": ["abc123"],
"season": "GENESIS"
}
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": 987,
"webappUri": "abc123"
}
ArtistInfo
Description
Simplified version of Artist entity
Example
{
"avatar": Media,
"id": 4,
"name": "abc123",
"publicAddress": "xyz789"
}
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
}
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": "abc123"
}
ArtistPartnershipHighlight
Description
Artist Partnership Highlight
Example
{
"imageLabel": "xyz789",
"imageUrl": "abc123",
"linkUrl": "abc123"
}
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": "abc123"
}
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": [
"30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
],
"mintTimeStatus": ["PAST"],
"releaseAlbumRevealStatus": "ALL",
"releaseAuthor": "ALL",
"releaseType": ["ALBUM"]
}
ArtistSearchFilter
Description
Filter the artists to be searched
Example
{
"genres": ["AFROBEAT"],
"hasCollectors": false,
"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": 123
}
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": "abc123",
"id": "4"
}
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": true,
"mostRecentReleasePost": ReleasePost,
"nftsCount": 987,
"postCount": 987,
"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": "xyz789",
"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
}
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": 987,
"fromTokenId": 123,
"id": 4,
"quantity": 987,
"release": Release,
"serialNumber": 123,
"tierNumber": 123,
"toSerialNumber": 987,
"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
ChainType
Description
Chain name supported on the platform
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"BASE"
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": "xyz789",
"discordUrl": "xyz789",
"id": "4",
"name": "abc123",
"nameSlug": "xyz789",
"profileImage": Media,
"published": true,
"rules": "xyz789",
"staticProfileImage": Media,
"telegramUrl": "abc123",
"tiktokUrl": "abc123",
"twitterUrl": "xyz789",
"webappUri": "xyz789",
"websiteUrl": "abc123"
}
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
}
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
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": "abc123",
"joinStatus": "JOINED",
"memberCount": 987,
"notificationStatus": "DISABLED",
"postCount": 123
}
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": 123,
"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": "xyz789",
"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": "abc123",
"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": 123,
"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": 123,
"goldenEggSerialNumber": 987,
"id": "4",
"lowestNftSerialNumber": 123,
"mostRecentCommentMessage": "abc123",
"nftsCount": 987,
"nftsCountGa": 123,
"nftsCountVip": 987,
"userArtistId": "4",
"userArtistName": "xyz789",
"userArtistSoundHandle": "xyz789",
"userAvatarUrl": "abc123",
"userId": 4,
"userPublicAddress": "xyz789",
"userWebappUri": "abc123",
"username": "abc123",
"vipNftsCount": 123
}
Comment
Description
Comment entity
Example
{
"createdAt": "2007-12-03T10:15:30Z",
"id": 4,
"message": "xyz789",
"signature": "abc123",
"updatedAt": "2007-12-03T10:15:30Z"
}
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": "xyz789",
"contractType": "ARTIST",
"createdAt": "2007-12-03T10:15:30Z",
"id": "4",
"owner": User,
"ownerPublicAddress": "xyz789",
"updatedAt": "2007-12-03T10:15:30Z"
}
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"
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": ["xyz789"]
}
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": "xyz789",
"percent": 987.65,
"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": "abc123"
}
Currencies
Description
Currencies conversions
Fields
| Field Name | Description |
|---|---|
ethToUsd -
Float!
|
Example
{"ethToUsd": 987.65}
CurrentUserChannelJoinStatus
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"JOINED"
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": "xyz789",
"before": "xyz789",
"first": 123,
"last": 123,
"sort": "ASC"
}
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"
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": "xyz789",
"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
}
DraftAllowListsInfo
Description
Draft allow lists info
Fields
| Field Name | Description |
|---|---|
presaleMint -
DraftAllowListInfo
|
Presale mint allowlist configurations |
Example
{"presaleMint": DraftAllowListInfo}
DraftAllowlistFromReleaseInput
DraftAllowlistInfo
Description
Union of draft allowlist infos
Example
ArtistCollectorsAllowlist
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": 987,
"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": 987,
"minQuantity": 123,
"presaleMint": DraftAuctionConfigurationInfo,
"publicMint": DraftPublicSaleAuctionConfigurationInfo,
"quantityBreakdown": [123]
}
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": false,
"selectedArtists": [ArtistInfo]
}
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]
}
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": "xyz789",
"unhashedLeaves": ["xyz789"]
}
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": "xyz789",
"releaseInfo": DraftEditReleaseInfo,
"rewardsInfo": RewardsEditStepInfo,
"splitsInfo": SplitsUploadStepInfo,
"storefrontArweaveHash": "abc123"
}
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": "xyz789",
"tokenSymbol": "xyz789",
"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
}
DraftManuallyAddedAllowlistInfo
Description
Draft manually added allowlist info
Fields
| Field Name | Description |
|---|---|
description -
String
|
Description for draft manually added allowlist |
Example
{"description": "xyz789"}
DraftPublicSaleAuctionConfigurationInfo
Description
Draft public sale auction configuration step info
Example
{
"endTime": 123,
"endTimeDays": 987,
"maxMintsPerWallet": 987,
"price": 123.45,
"quantity": 123,
"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": "abc123",
"coverImage": MediaUploadStepInfo,
"gaCoverImage": MediaUploadStepInfo,
"gaStaticCoverImage": MediaUploadStepInfo,
"genre": "abc123",
"goldenEggImage": MediaUploadStepInfo,
"key": "A_FLAT_MAJOR",
"license": "ALL_RIGHTS_RESERVED",
"location": "US",
"lyrics": "xyz789",
"spotifyPresaveCampaign": true,
"spotifyTrackId": "abc123",
"staticCoverImage": MediaUploadStepInfo,
"title": "abc123",
"tokenSymbol": "abc123",
"tracks": [TrackUploadStepInfo],
"type": "xyz789"
}
ENS
Description
Ethereum name service value with .eth suffix
Example
ENS
EditionContractEarning
Description
Edition contract earnings
Example
{
"balanceForUser": "xyz789",
"contractAddress": "abc123",
"totalBalance": "xyz789"
}
EditionOwnedTokenIdsFilter
Description
Filter the edition owned tokenIds result
Fields
| Input Field | Description |
|---|---|
includeGoldenEgg -
Boolean!
|
Should it include golden egg |
Example
{"includeGoldenEgg": false}
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": "abc123",
"goldenEggImage": Media,
"id": "4",
"nft": Nft
}
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"
}
Float
Description
The Float scalar type represents signed double-precision fractional values as specified by
IEEE 754.
Example
123.45
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": 123,
"comments": PostCommentConnection,
"content": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"creator": User,
"farcasterHash": "abc123",
"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"
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
}
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": "xyz789",
"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
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
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": "abc123",
"status": "ACTIVE",
"updatedAt": "2007-12-03T10:15:30Z"
}
KeyClientStatus
Description
Status of Key Client
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
Example
"ACTIVE"
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
}
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
}
Media
Description
Media entity
Example
{
"bucket": "xyz789",
"dominantColor": "xyz789",
"id": 4,
"key": "abc123",
"url": "xyz789"
}
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": 123,
"root": "xyz789",
"unhashedLeaves": ["abc123"]
}
MerkleTreeProof
Description
Merkle tree proof information
Fields
| Field Name | Description |
|---|---|
proof -
[String!]!
|
Merkle proof |
unhashedLeaf -
String!
|
Unhashed leaf in merkle tree |
Example
{
"proof": ["xyz789"],
"unhashedLeaf": "xyz789"
}
MetadataAttribute
MetadataDetails
Description
Metadata details of song
Example
{
"bpm": 123.45,
"key": "abc123",
"license": "xyz789",
"location": "xyz789",
"lyrics": "abc123"
}
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": ["xyz789"],
"mintTimeMaxDate": 1592577642,
"mintTimeMinDate": 1592577642,
"mintTimeStatus": ["PAST"],
"releaseAlbumRevealStatus": "ALL",
"releaseStatus": ["AVAILABLE_TO_MINT"],
"releaseType": ["ALBUM"],
"season": ["GENESIS"]
}
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": true}
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": 987,
"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": 123,
"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": true,
"openSeaMetadataAttributes": [OpenSeaMetadataAttribute],
"owner": User,
"release": Release,
"serialNumber": 123,
"songSlot": 123,
"tierNumber": 123,
"title": "xyz789",
"tokenId": "4",
"updatedAt": "2007-12-03T10:15:30Z"
}
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": "xyz789",
"before": "xyz789",
"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"
NonNegativeInt
Description
Integers that will have a value of 0 or more.
Example
123
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": "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": "xyz789"}
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": "xyz789"}
OpenSeaMetadataAttribute
OwnedToken
Description
Owned token by the user in release
Example
{
"isGoldenEgg": true,
"serialNumber": 987,
"tierNumber": 123,
"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": "xyz789",
"hasNextPage": true,
"hasPreviousPage": false,
"startCursor": "abc123"
}
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": "abc123",
"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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
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": 987,
"id": "4",
"playlist": Shelf,
"rankLast": 123,
"rankPeak": 987,
"trendingIndicator": "DOWN",
"trendingStreak": 987
}
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": "xyz789",
"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": "abc123",
"before": "abc123",
"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": "abc123",
"id": 4,
"lexicalContent": {},
"optionalShelf": Shelf,
"repostCount": 987,
"upvoteCount": 987,
"webappUri": "abc123"
}
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": "abc123",
"createdAt": "2007-12-03T10:15:30Z",
"creator": User,
"farcasterHash": "abc123",
"id": 4,
"lexicalContent": {},
"repostCount": 987,
"upvoteCount": 123,
"webappUri": "xyz789"
}
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": 987,
"authorNftsCountVip": 123,
"content": "xyz789",
"createdAt": "2007-12-03T10:15:30Z",
"currentHolderOfRelease": false,
"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": "xyz789",
"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": "abc123",
"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
}
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": "xyz789",
"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
}
QueryChannelStatsInput
Fields
| Input Field | Description |
|---|---|
channelIds -
[UUID!]!
|
Unique Channel identifier |
Example
{
"channelIds": [
"30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
]
}
QueryPostRepostedByInput
Description
Input for postRepostedBy query
Fields
| Input Field | Description |
|---|---|
pagination -
UserCursorConnectionArgs!
|
Pagination parameters |
postId -
UUID!
|
Post identifier |
Example
{
"pagination": UserCursorConnectionArgs,
"postId": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
QueryPostUpvotedByInput
Description
Input for postUpvotedBy query
Fields
| Input Field | Description |
|---|---|
pagination -
UserCursorConnectionArgs!
|
Pagination parameters |
postId -
UUID!
|
Post identifier |
Example
{
"pagination": UserCursorConnectionArgs,
"postId": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
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": "abc123",
"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}
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": "xyz789",
"canCollectorsDownloadAudio": false,
"chainId": 987,
"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": "xyz789",
"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": 123,
"mintStartTimestamp": 1592577642,
"nftsPaginated": NftConnection,
"numSold": 123,
"openseaUrl": "xyz789",
"postCount": 123,
"price": "abc123",
"publicAffiliateFeeBPS": 987,
"publicAffiliateFeePercent": "xyz789",
"publicMintStart": "2007-12-03T10:15:30Z",
"quantity": 987,
"quantityLowerBound": 987,
"quantityUpperBound": 123,
"rewards": [Reward],
"royaltyBps": 987,
"saleDetails": SaleDetails,
"saleSchedules": [SaleSchedule],
"salesAffiliateFeesPercent": ["abc123"],
"samAddress": "abc123",
"samBuyBufferBpsOverride": 123,
"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": "abc123",
"topCollectors": [TopReleaseCollector],
"topPosts": [Post],
"topSpentCollector": ReleaseCollector,
"totalMinted": 987,
"totalSupply": 123,
"track": Track,
"type": "ALBUM",
"vipAnimatedCoverImage": Media,
"vipCoverImage": Media,
"webEmbed": "xyz789",
"webappUri": "abc123"
}
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": "xyz789",
"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": "abc123",
"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": "abc123",
"before": "xyz789",
"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": "abc123",
"id": 4,
"purchasesQuantity": 123,
"referredCollectors": ReleaseReferredCollectorConnection,
"release": Release
}
ReleaseAlbumRevealFilterOption
Description
Release album reveal filter option
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"ALL"
ReleaseAllowlistInput
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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
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": 987,
"id": "4",
"rankLast": 987,
"rankPeak": 987,
"release": Release,
"trendingIndicator": "DOWN",
"trendingStreak": 123
}
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": "abc123",
"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": "abc123",
"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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
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": 987,
"volumeSpent": "xyz789"
}
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": "abc123",
"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": "abc123"
}
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": 123,
"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": 123
}
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
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": "abc123",
"release": Release,
"secondaryRoyalties": "xyz789",
"splitContract": SplitsContractEarning,
"splitMainBalanceFromRelease": "abc123",
"totalWithdrawableForUser": "xyz789"
}
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": "abc123",
"coverImage": Media,
"creditUserIds": ["xyz789"],
"id": 4,
"staticCoverImage": Media,
"title": "abc123"
}
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": ["abc123"],
"sourceSelectedArtistIds": ["abc123"],
"sourceSelectedReleaseIds": ["xyz789"]
}
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": 987,
"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": true,
"isGoldenEgg": true,
"ownerArtistId": 4,
"ownerArtistName": "xyz789",
"ownerArtistSoundHandle": "abc123",
"ownerAvatarUrl": "xyz789",
"ownerPublicAddress": "xyz789",
"ownerReleaseLowestNftSerialNumber": 987,
"ownerReleaseNftCount": 123,
"ownerUserId": 4,
"ownerUsername": "xyz789",
"ownerWebappUri": "xyz789",
"serialNumber": 987,
"songSlot": 987,
"tokenId": "xyz789",
"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": 987,
"upvoteCount": 123,
"waveformPostAttr": ReleaseCollectorWaveformPostAttr,
"webappUri": "xyz789"
}
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": 123,
"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": "xyz789",
"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": "abc123",
"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": [
"30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
],
"genres": ["AFROBEAT"],
"hasCollectors": false,
"locationIds": ["abc123"],
"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": "abc123",
"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": [
"30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
],
"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": 987}
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": true,
"mintStartTimestamp": 1592577642,
"numSold": 123,
"primaryCollected": 123,
"primaryRaisedInWei": "abc123",
"samBuyBufferBpsOverride": 123,
"samSellBufferBpsOverride": 123,
"soundSwapCollected": 123,
"soundSwapRaisedInWei": "abc123",
"title": "abc123",
"totalMinted": 123,
"totalSupply": 987,
"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": 987,
"numRemovedReleases": 123,
"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": false,
"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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01",
"contracts": [ContractReleaseInput],
"featuredStatus": "ALL",
"genres": ["AFROBEAT"],
"hideFeatured": true,
"locationIds": ["abc123"],
"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": 987,
"playlist": Shelf,
"releaseRemoved": Release,
"removedReleases": ReleaseConnection,
"user": User
}
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": 987,
"start": 1592577642,
"trackId": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01",
"uuid": "xyz789"
}
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": "xyz789",
"id": "4",
"lexicalContent": {},
"originalPost": Post,
"repostCount": 123,
"reposterNftsCountGa": 123,
"reposterNftsCountVip": 123,
"upvoteCount": 123,
"webappUri": "abc123"
}
Reward
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": true,
"curatorRewardsEnabled": false,
"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]
}
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": 987,
"primaryRaisedInWei": "abc123",
"soundSwapCollected": 123,
"soundSwapRaisedInWei": "abc123",
"totalVolume": "xyz789"
}
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": 123,
"affiliateFeePercent": "xyz789",
"artistContractTotalMinted": 123,
"endTime": "2007-12-03T10:15:30Z",
"id": 4,
"isPresale": true,
"maxMintable": 987,
"merkleTreeRoot": "abc123",
"mintId": 987,
"minterAddress": "xyz789",
"price": "xyz789",
"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": 987,
"affiliateFeePercent": "abc123",
"artistFeeBPS": 123,
"artistFeePercent": "abc123",
"basePrice": "xyz789",
"buyFreezeTime": 1592577642,
"goldenEggFeeBPS": 123,
"goldenEggFeePercent": "abc123",
"id": 4,
"inflectionPoint": 987,
"inflectionPrice": "abc123",
"maxSupply": 987,
"platformFeeBPS": 987,
"platformPerTxFlatFee": "xyz789",
"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": "xyz789"}
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"
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": 987,
"fromTokenId": 987,
"id": "4",
"purchasedFromUser": User,
"quantity": 987,
"release": Release,
"serialNumber": 987,
"tierNumber": 987,
"toSerialNumber": 123,
"toTokenId": 123,
"user": User
}
SemanticVersion
Description
Semantic version string
Example
SemanticVersion
SetArtistOnboardedByPublicAddressMetaInput
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": "xyz789",
"extendedFrom": [Shelf],
"id": "4",
"index": 987,
"likedBy": UserConnection,
"likes": 123,
"linkSlug": "xyz789",
"name": "abc123",
"numLikes": 123,
"numReferralPurchases": 987,
"numUsersReferred": 987,
"orderedReleases": ShelfReleaseConnection,
"playTimeInSeconds": 987,
"previewReleases": [ShelfRelease],
"releaseCount": 123,
"releaseIds": ["abc123"],
"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": "xyz789",
"before": "abc123",
"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}
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": "abc123",
"distributorFee": 987,
"participantAddresses": ["abc123"],
"participantAllocations": [987],
"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]
}
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"
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": "xyz789"
}
SupportedVersion
Description
Info for supported versions
Fields
| Field Name | Description |
|---|---|
recommendedVersion -
String!
|
Recommended version |
Example
{"recommendedVersion": "abc123"}
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": false,
"maxMintableLower": 123,
"maxMintableUpper": 123,
"mintConcluded": false,
"schedules": [TierSchedule],
"tierNumber": 123,
"totalMinted": 123
}
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": "abc123",
"endTime": "2007-12-03T10:15:30Z",
"id": 4,
"isPaused": true,
"maxMintable": 987,
"maxMintablePerAccount": 987,
"merkleTreeRoot": "xyz789",
"minterAddress": "xyz789",
"mode": "DEFAULT",
"priceInWei": "xyz789",
"scheduleNumber": 987,
"startTime": "2007-12-03T10:15:30Z",
"tier": Tier,
"tierNumber": 123,
"totalMinted": 123
}
TierScheduleMode
Description
Mode that differentiates behavior of tier schedule
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
Example
"DEFAULT"
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": true,
"id": 4,
"name": "xyz789",
"presalePriceWei": "xyz789",
"presaleStartTime": "2007-12-03T10:15:30Z",
"publicPriceWei": "abc123",
"publicStartTime": "2007-12-03T10:15:30Z",
"royaltyBPS": 123,
"schedules": [TierSchedule],
"tiers": [Tier],
"totalBurned": 987,
"totalMinted": 987,
"totalSupply": 123
}
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": 987,
"nftsCount": 987,
"position": 123,
"user": User
}
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": "xyz789",
"trackNumber": 123
}
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": [123],
"title": "xyz789"
}
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": "abc123",
"primarySalesUsd": 987.65,
"secondarySales": "abc123",
"secondarySalesUsd": 987.65,
"totalSales": "xyz789",
"totalSalesUsd": 987.65,
"uniqueCollectors": 987
}
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": 123,
"totalSpent": "abc123",
"totalSpentUsd": 987.65,
"user": User,
"userAddress": "abc123"
}
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": 987.65,
"release": Release,
"secondarySales": "abc123",
"secondarySalesUsd": 123.45,
"totalSales": "abc123",
"totalSalesUsd": 123.45,
"uniqueCollectors": 123
}
TrendingReleasesSortEnum
Description
Type of sort paratemer used for trending releases
Values
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example
"NFTS_SOLD"
TypeOfRelation
Description
User relation type
Values
| Enum Value | Description |
|---|---|
|
|
Example
"FOLLOWING"
UUID
Description
UUID v4
Example
"30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
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": "abc123",
"description": "xyz789",
"displayName": "abc123",
"email": "abc123",
"ens": "xyz789",
"farcasterFid": "xyz789",
"farcasterSignerConnected": true,
"featuredReleases": [CollectedRelease],
"followerCount": 123,
"followers": UserRelationConnection,
"following": UserRelationConnection,
"followingCount": 987,
"id": 4,
"instagramHandle": "xyz789",
"invitedByUser": User,
"isTopNotableCollector": true,
"lastReferralWithdrawableBalance": "abc123",
"likedSounds": Shelf,
"location": GeoLocationPlaceGoogle,
"nftsOwned": 123,
"nftsPaginated": NftConnection,
"nonce": 987,
"numBackedArtists": 123,
"postCount": 123,
"publicAddress": "xyz789",
"roles": UserRoles,
"shelves": ShelfConnection,
"shelvesCount": 123,
"showSplitsFeature": false,
"tiktokUrl": "xyz789",
"topCollectorPosition": 123,
"twitterHandle": "abc123",
"username": "abc123",
"verifiedNotificationEmail": "abc123",
"webappUri": "xyz789"
}
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": [
"30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
],
"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"
}
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": [
"30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
]
}
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": "xyz789",
"node": UserRelation
}
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"}
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
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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
Response
{
"data": {
"activityFeedNewGroup": {
"activityFeedGroupId": "xyz789",
"activityFeedGroupInformationTypename": "xyz789"
}
}
}
count
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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
Response
{
"data": {
"releaseNftCommentUpdate": [
{
"commentMessage": "abc123",
"contractAddress": "xyz789",
"id": 4,
"isBurned": true,
"isGoldenEgg": false,
"ownerArtistId": 4,
"ownerArtistName": "xyz789",
"ownerArtistSoundHandle": "abc123",
"ownerAvatarUrl": "xyz789",
"ownerPublicAddress": "abc123",
"ownerReleaseLowestNftSerialNumber": 123,
"ownerReleaseNftCount": 123,
"ownerUserId": "4",
"ownerUsername": "xyz789",
"ownerWebappUri": "xyz789",
"serialNumber": 123,
"songSlot": 123,
"tokenId": "abc123",
"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": "30b00d53-2dc7-46fc-8ec9-be3a1129dc01"
}
Response
{
"data": {
"releaseUpdates": {
"chainId": 123,
"finalQuantity": 123,
"id": 4,
"isFirstPhaseCompleted": true,
"mintStartTimestamp": 1592577642,
"numSold": 123,
"primaryCollected": 123,
"primaryRaisedInWei": "xyz789",
"samBuyBufferBpsOverride": 123,
"samSellBufferBpsOverride": 123,
"soundSwapCollected": 123,
"soundSwapRaisedInWei": "abc123",
"title": "xyz789",
"totalMinted": 123,
"totalSupply": 123,
"totalVolume": "xyz789"
}
}
}