Compass API Reference
Welcome to the Compass GraphQL API documentation.
You can view query and response examples in the area to the right. We provide these examples for nearly all available methods of the Compass API.
To use the Compass API, get a Compass Lifetime Pass from OpenSea
Contact
API Support
api@compass.art
Terms of Service: https://compass.art/legal/terms
API Endpoints
Production:
https://api.compass.art/graphql
Authentication
Some queries and fields require you to authenticate and validate premium access.
To authenticate,
create an api token and pass it with each request in the headers: Authorization: Bearer YOUR_API_TOKEN.
Get started
You can validate your API token by sending the
me query. You should see information about your user account in the response.
Next, fetch the currently trending collections (
trendingCollections).
Queries
activeDraw
Example
Query
query activeDraw {
activeDraw {
id
seedHash
isActive
startsAt
endsAt
coinPrizes {
...CoinPrizeFragment
}
whitelistPrizes {
...WhitelistCollectionPrizeFragment
}
tokenPrizes {
...TokenPrizeFragment
}
prizesWon {
...ClaimablePrizeFragment
}
entries {
...EntryFragment
}
}
}
Response
{
"data": {
"activeDraw": {
"id": 123,
"seedHash": "xyz789",
"isActive": false,
"startsAt": DateTime,
"endsAt": DateTime,
"coinPrizes": [CoinPrize],
"whitelistPrizes": [WhitelistCollectionPrize],
"tokenPrizes": [TokenPrize],
"prizesWon": [ClaimablePrize],
"entries": [Entry]
}
}
}
alert
Example
Query
query alert($id: Int!) {
alert(id: $id) {
id
userId
name
type
config
lastCheckedAt
lastEvaluatedAt
lastValue
createdAt
externalUserId
status
_count {
...AlertCountFragment
}
channels
}
}
Variables
{"id": 123}
Response
{
"data": {
"alert": {
"id": 123,
"userId": "xyz789",
"name": "xyz789",
"type": AlertType,
"config": {},
"lastCheckedAt": DateTime,
"lastEvaluatedAt": DateTime,
"lastValue": 987.65,
"createdAt": DateTime,
"externalUserId": 123,
"status": AlertStatus,
"_count": AlertCount,
"channels": [123]
}
}
}
alertHistory
[AlertHistory!]!
| Name | Description |
|---|---|
take -
Int
|
Number of entities to return in response (used for pagination). Default = 50 |
skip -
Int
|
Number of entities to skip (used for pagination). Default = 0 |
id -
Int!
|
Example
Query
query alertHistory($take: Int, $skip: Int, $id: Int!) {
alertHistory(take: $take, skip: $skip, id: $id) {
id
alertId
payload
createdAt
}
}
Variables
{"take": 50, "skip": 0, "id": 123}
Response
{
"data": {
"alertHistory": [
{
"id": 987,
"alertId": 987,
"payload": {},
"createdAt": DateTime
}
]
}
}
alerts
Example
Query
query alerts {
alerts {
id
userId
name
type
config
lastCheckedAt
lastEvaluatedAt
lastValue
createdAt
externalUserId
status
_count {
...AlertCountFragment
}
channels
}
}
Response
{
"data": {
"alerts": [
{
"id": 123,
"userId": "abc123",
"name": "abc123",
"type": AlertType,
"config": {},
"lastCheckedAt": DateTime,
"lastEvaluatedAt": DateTime,
"lastValue": 987.65,
"createdAt": DateTime,
"externalUserId": 123,
"status": AlertStatus,
"_count": AlertCount,
"channels": [123]
}
]
}
}
attribute
Example
Query
query attribute($where: AttributeWhereUniqueInput!) {
attribute(where: $where) {
id
collectionId
name
displayType
_count {
...AttributeCountFragment
}
valueCount
collection {
...CollectionFragment
}
values {
...AttributeValueFragment
}
tokenAttributes {
...TokenAttributeFragment
}
}
}
Variables
{"where": AttributeWhereUniqueInput}
Response
{
"data": {
"attribute": {
"id": "xyz789",
"collectionId": "xyz789",
"name": "xyz789",
"displayType": "xyz789",
"_count": AttributeCount,
"valueCount": 987,
"collection": Collection,
"values": [AttributeValue],
"tokenAttributes": [TokenAttribute]
}
}
}
attributeValues
[AttributeValue!]!
| Name | Description |
|---|---|
where -
AttributeValueWhereInput
|
|
orderBy -
[AttributeValueOrderByWithRelationInput!]
|
|
cursor -
AttributeValueWhereUniqueInput
|
|
take -
Int
|
|
skip -
Int
|
|
distinct -
[AttributeValueScalarFieldEnum!]
|
Example
Query
query attributeValues($where: AttributeValueWhereInput, $orderBy: [AttributeValueOrderByWithRelationInput!], $cursor: AttributeValueWhereUniqueInput, $take: Int, $skip: Int, $distinct: [AttributeValueScalarFieldEnum!]) {
attributeValues(where: $where, orderBy: $orderBy, cursor: $cursor, take: $take, skip: $skip, distinct: $distinct) {
id
attributeId
value
_count {
...AttributeValueCountFragment
}
attribute {
...AttributeFragment
}
tokenAttributes {
...TokenAttributeFragment
}
sales {
...AttributeValueSalesFragment
}
volumeChart {
...ChartDataFragment
}
tokenCount
}
}
Variables
{
"where": AttributeValueWhereInput,
"orderBy": [AttributeValueOrderByWithRelationInput],
"cursor": AttributeValueWhereUniqueInput,
"take": 987,
"skip": 123,
"distinct": [AttributeValueScalarFieldEnum]
}
Response
{
"data": {
"attributeValues": [
{
"id": "abc123",
"attributeId": "abc123",
"value": "xyz789",
"_count": AttributeValueCount,
"attribute": Attribute,
"tokenAttributes": [TokenAttribute],
"sales": AttributeValueSales,
"volumeChart": [ChartData],
"tokenCount": 123
}
]
}
}
avgBalanceOverTime
Example
Query
query avgBalanceOverTime($period: String, $collectionId: String!) {
avgBalanceOverTime(period: $period, collectionId: $collectionId) {
key
value
}
}
Variables
{
"period": "1d",
"collectionId": "Generated Argument example for avgBalanceOverTime collectionId"
}
Response
{"data": {"avgBalanceOverTime": [{"key": "abc123", "value": 987.65}]}}
bluechipCollections
Example
Query
query bluechipCollections {
bluechipCollections {
id
type
isVerified
isRevealed
revealsAt
revealedAt
name
symbol
maxSupply
slug
imageUrl
bannerImageUrl
description
discordUrl
contractCreatedTimestamp
externalUrl
telegramUrl
mediumUsername
twitterUsername
instagramUsername
devFeeBasisPoints
openseaFeeBasisPoints
updatedAt
orderbookSyncedAt
_count {
...CollectionCountFragment
}
charts {
...CollectionChartsFragment
}
listingsChart
listingsOverTime
transactionsChart
metrics {
...CollectionMetricsFragment
}
previousMetrics {
...CollectionMetricsFragment
}
salesFloor
previousSalesFloor
isRefreshingTokenMetadata
totalSupply
mintMetrics {
...MintingCollectionWithChartFragment
}
minters {
...CollectionMinterFragment
}
revealProgress
isSyncingOrders
totalTokensListed
listedFloor
topOffer
previousListedFloor
tokensListedPastDay
tokens {
...TokenFragment
}
listingEvents {
...CollectionListingEventFragment
}
saleEvents {
...CollectionActivityEventFragment
}
totalVolume
totalProfits
liquidityRank
activity {
...ActivityItemFragment
}
tokensV2 {
...TokenFragment
}
floorPriceChart
orderbookDepth
tokenTransfers {
...TokenTransferFragment
}
attributes {
...AttributeFragment
}
orders {
...OrderFragment
}
sales {
...SaleFragment
}
profitLeaderboard {
...ProfitLeaderFragment
}
socialMetricsLastUpdatedAt
twitterMetrics {
...TwitterMetricsFragment
}
discordMetrics {
...DiscordMetricsFragment
}
tweets {
...TweetMentionFragment
}
followedBy {
...FollowedByFragment
}
isReportedByUser
isReported
reportReason
isPremiumRequired
}
}
Response
{
"data": {
"bluechipCollections": [
{
"id": "abc123",
"type": "xyz789",
"isVerified": false,
"isRevealed": false,
"revealsAt": DateTime,
"revealedAt": DateTime,
"name": "xyz789",
"symbol": "xyz789",
"maxSupply": 123,
"slug": "abc123",
"imageUrl": "xyz789",
"bannerImageUrl": "xyz789",
"description": "abc123",
"discordUrl": "abc123",
"contractCreatedTimestamp": DateTime,
"externalUrl": "abc123",
"telegramUrl": "xyz789",
"mediumUsername": "xyz789",
"twitterUsername": "abc123",
"instagramUsername": "abc123",
"devFeeBasisPoints": 123,
"openseaFeeBasisPoints": 123,
"updatedAt": DateTime,
"orderbookSyncedAt": DateTime,
"_count": CollectionCount,
"charts": CollectionCharts,
"listingsChart": {},
"listingsOverTime": {},
"transactionsChart": {},
"metrics": CollectionMetrics,
"previousMetrics": CollectionMetrics,
"salesFloor": 123.45,
"previousSalesFloor": 123.45,
"isRefreshingTokenMetadata": true,
"totalSupply": 987,
"mintMetrics": MintingCollectionWithChart,
"minters": [CollectionMinter],
"revealProgress": 123.45,
"isSyncingOrders": true,
"totalTokensListed": 123,
"listedFloor": 123.45,
"topOffer": 987.65,
"previousListedFloor": 123.45,
"tokensListedPastDay": 123,
"tokens": [Token],
"listingEvents": [CollectionListingEvent],
"saleEvents": [CollectionActivityEvent],
"totalVolume": 123.45,
"totalProfits": 987.65,
"liquidityRank": LiquidityRank,
"activity": [ActivityItem],
"tokensV2": [Token],
"floorPriceChart": {},
"orderbookDepth": {},
"tokenTransfers": [TokenTransfer],
"attributes": [Attribute],
"orders": [Order],
"sales": [Sale],
"profitLeaderboard": [ProfitLeader],
"socialMetricsLastUpdatedAt": DateTime,
"twitterMetrics": [TwitterMetrics],
"discordMetrics": [DiscordMetrics],
"tweets": [TweetMention],
"followedBy": [FollowedBy],
"isReportedByUser": false,
"isReported": false,
"reportReason": ReportReason,
"isPremiumRequired": true
}
]
}
}
bluechipCollectionsSales
[CollectionWithStats!]!
| Name | Description |
|---|---|
take -
Int
|
Number of entities to return in response (used for pagination). Default = 50 |
skip -
Int
|
Number of entities to skip (used for pagination). Default = 0 |
period -
String
|
Date range of data. Example: "1h", "1d", "7d". Units supported: minute - m, hour - h, day - d. Default = "1h" |
sortBy -
String
|
Default = "salesCount" |
sortDesc -
Boolean
|
Default = true |
Example
Query
query bluechipCollectionsSales($take: Int, $skip: Int, $period: String, $sortBy: String, $sortDesc: Boolean) {
bluechipCollectionsSales(take: $take, skip: $skip, period: $period, sortBy: $sortBy, sortDesc: $sortDesc) {
id
collection {
...CollectionFragment
}
volume
salesCount
avgPrice
minPrice
maxPrice
medianPrice
previous {
...CollectionWithStatsFragment
}
}
}
Variables
{
"take": 50,
"skip": 0,
"period": "1h",
"sortBy": "salesCount",
"sortDesc": true
}
Response
{
"data": {
"bluechipCollectionsSales": [
{
"id": "abc123",
"collection": Collection,
"volume": 123.45,
"salesCount": 123,
"avgPrice": 123.45,
"minPrice": 123.45,
"maxPrice": 987.65,
"medianPrice": 123.45,
"previous": CollectionWithStats
}
]
}
}
channels
Example
Query
query channels {
channels {
id
userId
name
type
config
status
externalUserId
_count {
...ChannelCountFragment
}
}
}
Response
{
"data": {
"channels": [
{
"id": 987,
"userId": "abc123",
"name": "abc123",
"type": ChannelType,
"config": {},
"status": ChannelStatus,
"externalUserId": 987,
"_count": ChannelCount
}
]
}
}
checkCoupon
Example
Query
query checkCoupon($planId: String!, $couponCode: String!) {
checkCoupon(planId: $planId, couponCode: $couponCode) {
discountValue
}
}
Variables
{
"planId": "Generated Argument example for checkCoupon planId",
"couponCode": "Generated Argument example for checkCoupon couponCode"
}
Response
{"data": {"checkCoupon": {"discountValue": 123.45}}}
collection
Example
Query
query collection($where: CollectionWhereUniqueInput!) {
collection(where: $where) {
id
type
isVerified
isRevealed
revealsAt
revealedAt
name
symbol
maxSupply
slug
imageUrl
bannerImageUrl
description
discordUrl
contractCreatedTimestamp
externalUrl
telegramUrl
mediumUsername
twitterUsername
instagramUsername
devFeeBasisPoints
openseaFeeBasisPoints
updatedAt
orderbookSyncedAt
_count {
...CollectionCountFragment
}
charts {
...CollectionChartsFragment
}
listingsChart
listingsOverTime
transactionsChart
metrics {
...CollectionMetricsFragment
}
previousMetrics {
...CollectionMetricsFragment
}
salesFloor
previousSalesFloor
isRefreshingTokenMetadata
totalSupply
mintMetrics {
...MintingCollectionWithChartFragment
}
minters {
...CollectionMinterFragment
}
revealProgress
isSyncingOrders
totalTokensListed
listedFloor
topOffer
previousListedFloor
tokensListedPastDay
tokens {
...TokenFragment
}
listingEvents {
...CollectionListingEventFragment
}
saleEvents {
...CollectionActivityEventFragment
}
totalVolume
totalProfits
liquidityRank
activity {
...ActivityItemFragment
}
tokensV2 {
...TokenFragment
}
floorPriceChart
orderbookDepth
tokenTransfers {
...TokenTransferFragment
}
attributes {
...AttributeFragment
}
orders {
...OrderFragment
}
sales {
...SaleFragment
}
profitLeaderboard {
...ProfitLeaderFragment
}
socialMetricsLastUpdatedAt
twitterMetrics {
...TwitterMetricsFragment
}
discordMetrics {
...DiscordMetricsFragment
}
tweets {
...TweetMentionFragment
}
followedBy {
...FollowedByFragment
}
isReportedByUser
isReported
reportReason
isPremiumRequired
}
}
Variables
{"where": CollectionWhereUniqueInput}
Response
{
"data": {
"collection": {
"id": "xyz789",
"type": "xyz789",
"isVerified": false,
"isRevealed": true,
"revealsAt": DateTime,
"revealedAt": DateTime,
"name": "xyz789",
"symbol": "xyz789",
"maxSupply": 123,
"slug": "abc123",
"imageUrl": "xyz789",
"bannerImageUrl": "abc123",
"description": "abc123",
"discordUrl": "abc123",
"contractCreatedTimestamp": DateTime,
"externalUrl": "abc123",
"telegramUrl": "xyz789",
"mediumUsername": "abc123",
"twitterUsername": "abc123",
"instagramUsername": "abc123",
"devFeeBasisPoints": 987,
"openseaFeeBasisPoints": 987,
"updatedAt": DateTime,
"orderbookSyncedAt": DateTime,
"_count": CollectionCount,
"charts": CollectionCharts,
"listingsChart": {},
"listingsOverTime": {},
"transactionsChart": {},
"metrics": CollectionMetrics,
"previousMetrics": CollectionMetrics,
"salesFloor": 123.45,
"previousSalesFloor": 123.45,
"isRefreshingTokenMetadata": true,
"totalSupply": 123,
"mintMetrics": MintingCollectionWithChart,
"minters": [CollectionMinter],
"revealProgress": 123.45,
"isSyncingOrders": true,
"totalTokensListed": 987,
"listedFloor": 987.65,
"topOffer": 987.65,
"previousListedFloor": 987.65,
"tokensListedPastDay": 987,
"tokens": [Token],
"listingEvents": [CollectionListingEvent],
"saleEvents": [CollectionActivityEvent],
"totalVolume": 987.65,
"totalProfits": 123.45,
"liquidityRank": LiquidityRank,
"activity": [ActivityItem],
"tokensV2": [Token],
"floorPriceChart": {},
"orderbookDepth": {},
"tokenTransfers": [TokenTransfer],
"attributes": [Attribute],
"orders": [Order],
"sales": [Sale],
"profitLeaderboard": [ProfitLeader],
"socialMetricsLastUpdatedAt": DateTime,
"twitterMetrics": [TwitterMetrics],
"discordMetrics": [DiscordMetrics],
"tweets": [TweetMention],
"followedBy": [FollowedBy],
"isReportedByUser": false,
"isReported": true,
"reportReason": ReportReason,
"isPremiumRequired": true
}
}
}
collectionHolders
Example
Query
query collectionHolders($collectionId: String!) {
collectionHolders(collectionId: $collectionId) {
wallets {
...WalletBalanceFragment
}
count
bluechipHoldersCount
avgBalance
singleTokenWalletCount
}
}
Variables
{
"collectionId": "Generated Argument example for collectionHolders collectionId"
}
Response
{
"data": {
"collectionHolders": {
"wallets": [WalletBalance],
"count": 987,
"bluechipHoldersCount": 123,
"avgBalance": 987.65,
"singleTokenWalletCount": 987
}
}
}
collections
[Collection!]!
| Name | Description |
|---|---|
where -
CollectionWhereInput
|
|
orderBy -
[CollectionOrderByWithRelationInput!]
|
|
cursor -
CollectionWhereUniqueInput
|
|
take -
Int
|
|
skip -
Int
|
|
distinct -
[CollectionScalarFieldEnum!]
|
Example
Query
query collections($where: CollectionWhereInput, $orderBy: [CollectionOrderByWithRelationInput!], $cursor: CollectionWhereUniqueInput, $take: Int, $skip: Int, $distinct: [CollectionScalarFieldEnum!]) {
collections(where: $where, orderBy: $orderBy, cursor: $cursor, take: $take, skip: $skip, distinct: $distinct) {
id
type
isVerified
isRevealed
revealsAt
revealedAt
name
symbol
maxSupply
slug
imageUrl
bannerImageUrl
description
discordUrl
contractCreatedTimestamp
externalUrl
telegramUrl
mediumUsername
twitterUsername
instagramUsername
devFeeBasisPoints
openseaFeeBasisPoints
updatedAt
orderbookSyncedAt
_count {
...CollectionCountFragment
}
charts {
...CollectionChartsFragment
}
listingsChart
listingsOverTime
transactionsChart
metrics {
...CollectionMetricsFragment
}
previousMetrics {
...CollectionMetricsFragment
}
salesFloor
previousSalesFloor
isRefreshingTokenMetadata
totalSupply
mintMetrics {
...MintingCollectionWithChartFragment
}
minters {
...CollectionMinterFragment
}
revealProgress
isSyncingOrders
totalTokensListed
listedFloor
topOffer
previousListedFloor
tokensListedPastDay
tokens {
...TokenFragment
}
listingEvents {
...CollectionListingEventFragment
}
saleEvents {
...CollectionActivityEventFragment
}
totalVolume
totalProfits
liquidityRank
activity {
...ActivityItemFragment
}
tokensV2 {
...TokenFragment
}
floorPriceChart
orderbookDepth
tokenTransfers {
...TokenTransferFragment
}
attributes {
...AttributeFragment
}
orders {
...OrderFragment
}
sales {
...SaleFragment
}
profitLeaderboard {
...ProfitLeaderFragment
}
socialMetricsLastUpdatedAt
twitterMetrics {
...TwitterMetricsFragment
}
discordMetrics {
...DiscordMetricsFragment
}
tweets {
...TweetMentionFragment
}
followedBy {
...FollowedByFragment
}
isReportedByUser
isReported
reportReason
isPremiumRequired
}
}
Variables
{
"where": CollectionWhereInput,
"orderBy": [CollectionOrderByWithRelationInput],
"cursor": CollectionWhereUniqueInput,
"take": 123,
"skip": 123,
"distinct": [CollectionScalarFieldEnum]
}
Response
{
"data": {
"collections": [
{
"id": "abc123",
"type": "xyz789",
"isVerified": true,
"isRevealed": false,
"revealsAt": DateTime,
"revealedAt": DateTime,
"name": "abc123",
"symbol": "xyz789",
"maxSupply": 123,
"slug": "xyz789",
"imageUrl": "xyz789",
"bannerImageUrl": "abc123",
"description": "abc123",
"discordUrl": "abc123",
"contractCreatedTimestamp": DateTime,
"externalUrl": "abc123",
"telegramUrl": "xyz789",
"mediumUsername": "xyz789",
"twitterUsername": "xyz789",
"instagramUsername": "xyz789",
"devFeeBasisPoints": 123,
"openseaFeeBasisPoints": 987,
"updatedAt": DateTime,
"orderbookSyncedAt": DateTime,
"_count": CollectionCount,
"charts": CollectionCharts,
"listingsChart": {},
"listingsOverTime": {},
"transactionsChart": {},
"metrics": CollectionMetrics,
"previousMetrics": CollectionMetrics,
"salesFloor": 123.45,
"previousSalesFloor": 123.45,
"isRefreshingTokenMetadata": true,
"totalSupply": 987,
"mintMetrics": MintingCollectionWithChart,
"minters": [CollectionMinter],
"revealProgress": 123.45,
"isSyncingOrders": true,
"totalTokensListed": 123,
"listedFloor": 987.65,
"topOffer": 123.45,
"previousListedFloor": 123.45,
"tokensListedPastDay": 123,
"tokens": [Token],
"listingEvents": [CollectionListingEvent],
"saleEvents": [CollectionActivityEvent],
"totalVolume": 123.45,
"totalProfits": 123.45,
"liquidityRank": LiquidityRank,
"activity": [ActivityItem],
"tokensV2": [Token],
"floorPriceChart": {},
"orderbookDepth": {},
"tokenTransfers": [TokenTransfer],
"attributes": [Attribute],
"orders": [Order],
"sales": [Sale],
"profitLeaderboard": [ProfitLeader],
"socialMetricsLastUpdatedAt": DateTime,
"twitterMetrics": [TwitterMetrics],
"discordMetrics": [DiscordMetrics],
"tweets": [TweetMention],
"followedBy": [FollowedBy],
"isReportedByUser": false,
"isReported": false,
"reportReason": ReportReason,
"isPremiumRequired": false
}
]
}
}
collectionWatchlist
Example
Query
query collectionWatchlist($id: Int!) {
collectionWatchlist(id: $id) {
id
name
slug
isPublic
createdAt
status
isPinned
memberCount
marketCapOverTime {
...ChartDataFragment
}
volumeOverTime {
...ChartDataFragment
}
volume {
...NumberWithChangeFragment
}
marketCap {
...NumberWithChangeFragment
}
uniqueBuyersCount {
...NumberWithChangeFragment
}
uniqueSellersCount {
...NumberWithChangeFragment
}
imageUrl
isMember
members {
...CollectionFragment
}
}
}
Variables
{"id": 987}
Response
{
"data": {
"collectionWatchlist": {
"id": 987,
"name": "abc123",
"slug": "xyz789",
"isPublic": true,
"createdAt": DateTime,
"status": WatchlistStatus,
"isPinned": false,
"memberCount": 987,
"marketCapOverTime": [ChartData],
"volumeOverTime": [ChartData],
"volume": NumberWithChange,
"marketCap": NumberWithChange,
"uniqueBuyersCount": NumberWithChange,
"uniqueSellersCount": NumberWithChange,
"imageUrl": "xyz789",
"isMember": false,
"members": [Collection]
}
}
}
collectionWatchlistBySlug
Example
Query
query collectionWatchlistBySlug($slug: String!) {
collectionWatchlistBySlug(slug: $slug) {
id
name
slug
isPublic
createdAt
status
isPinned
memberCount
marketCapOverTime {
...ChartDataFragment
}
volumeOverTime {
...ChartDataFragment
}
volume {
...NumberWithChangeFragment
}
marketCap {
...NumberWithChangeFragment
}
uniqueBuyersCount {
...NumberWithChangeFragment
}
uniqueSellersCount {
...NumberWithChangeFragment
}
imageUrl
isMember
members {
...CollectionFragment
}
}
}
Variables
{
"slug": "Generated Argument example for collectionWatchlistBySlug slug"
}
Response
{
"data": {
"collectionWatchlistBySlug": {
"id": 123,
"name": "abc123",
"slug": "xyz789",
"isPublic": true,
"createdAt": DateTime,
"status": WatchlistStatus,
"isPinned": false,
"memberCount": 123,
"marketCapOverTime": [ChartData],
"volumeOverTime": [ChartData],
"volume": NumberWithChange,
"marketCap": NumberWithChange,
"uniqueBuyersCount": NumberWithChange,
"uniqueSellersCount": NumberWithChange,
"imageUrl": "xyz789",
"isMember": true,
"members": [Collection]
}
}
}
collectionWatchlists
Example
Query
query collectionWatchlists($pinnedOnly: Boolean) {
collectionWatchlists(pinnedOnly: $pinnedOnly) {
id
name
slug
isPublic
createdAt
status
isPinned
memberCount
marketCapOverTime {
...ChartDataFragment
}
volumeOverTime {
...ChartDataFragment
}
volume {
...NumberWithChangeFragment
}
marketCap {
...NumberWithChangeFragment
}
uniqueBuyersCount {
...NumberWithChangeFragment
}
uniqueSellersCount {
...NumberWithChangeFragment
}
imageUrl
isMember
members {
...CollectionFragment
}
}
}
Variables
{"pinnedOnly": false}
Response
{
"data": {
"collectionWatchlists": [
{
"id": 987,
"name": "abc123",
"slug": "abc123",
"isPublic": true,
"createdAt": DateTime,
"status": WatchlistStatus,
"isPinned": true,
"memberCount": 123,
"marketCapOverTime": [ChartData],
"volumeOverTime": [ChartData],
"volume": NumberWithChange,
"marketCap": NumberWithChange,
"uniqueBuyersCount": NumberWithChange,
"uniqueSellersCount": NumberWithChange,
"imageUrl": "xyz789",
"isMember": false,
"members": [Collection]
}
]
}
}
crateOpens
Example
Query
query crateOpens($drawId: Int, $tokenId: String!) {
crateOpens(drawId: $drawId, tokenId: $tokenId) {
id
prizes
}
}
Variables
{
"drawId": 123,
"tokenId": "Generated Argument example for crateOpens tokenId"
}
Response
{"data": {"crateOpens": [{"id": 123, "prizes": [Prize]}]}}
favoriteCollections
[CollectionWithStats!]!
| Name | Description |
|---|---|
take -
Int
|
Number of entities to return in response (used for pagination). Default = 50 |
skip -
Int
|
Number of entities to skip (used for pagination). Default = 0 |
period -
String
|
Date range of data. Example: "1h", "1d", "7d". Units supported: minute - m, hour - h, day - d. Default = "1h" |
sortBy -
String
|
Default = "salesCount" |
sortDesc -
Boolean
|
Default = true |
Example
Query
query favoriteCollections($take: Int, $skip: Int, $period: String, $sortBy: String, $sortDesc: Boolean) {
favoriteCollections(take: $take, skip: $skip, period: $period, sortBy: $sortBy, sortDesc: $sortDesc) {
id
collection {
...CollectionFragment
}
volume
salesCount
avgPrice
minPrice
maxPrice
medianPrice
previous {
...CollectionWithStatsFragment
}
}
}
Variables
{
"take": 50,
"skip": 0,
"period": "1h",
"sortBy": "salesCount",
"sortDesc": true
}
Response
{
"data": {
"favoriteCollections": [
{
"id": "xyz789",
"collection": Collection,
"volume": 123.45,
"salesCount": 123,
"avgPrice": 123.45,
"minPrice": 987.65,
"maxPrice": 123.45,
"medianPrice": 123.45,
"previous": CollectionWithStats
}
]
}
}
favoriteWalletActivityFeed
[WalletActivityFeedItem!]
| Name | Description |
|---|---|
types -
[String!]
|
|
take -
Int
|
Number of entities to return in response (used for pagination). Default = 50 |
skip -
Int
|
Number of entities to skip (used for pagination). Default = 0 |
Example
Query
query favoriteWalletActivityFeed($types: [String!], $take: Int, $skip: Int) {
favoriteWalletActivityFeed(types: $types, take: $take, skip: $skip) {
wallet {
...WalletFragment
}
tokenTransfers {
...TokenTransferFragment
}
collection {
...CollectionFragment
}
transaction {
...TransactionFragment
}
type
}
}
Variables
{
"types": [
"Generated Argument example for favoriteWalletActivityFeed types"
],
"take": 50,
"skip": 0
}
Response
{
"data": {
"favoriteWalletActivityFeed": [
{
"wallet": Wallet,
"tokenTransfers": [TokenTransfer],
"collection": Collection,
"transaction": Transaction,
"type": "xyz789"
}
]
}
}
favoriteWallets
Example
Query
query favoriteWallets {
favoriteWallets {
id
name
openseaProfile
updatedAt
_count {
...WalletCountFragment
}
displayName
tokenTransfers {
...TokenTransferFragment
}
realizedGains {
...WalletRealizedGainsByCollectionFragment
}
portfolio {
...PortfolioItemFragment
}
activityChart
totalPortfolioValue
totalPortfolioValueByLiquidity {
...PortfolioValueFragment
}
analytics {
...WalletAnalyticsFragment
}
offers {
...OfferFragment
}
profitAndLossOverTime
profitSource
collectionBalanceAndFloorOverTime
positionChanges {
...WalletPositionChangeFragment
}
portfolioValueOverTime
collections {
...WalletCollectionFragment
}
tokens {
...TokenFragment
}
transfersFrom {
...TokenTransferFragment
}
transfersTo {
...TokenTransferFragment
}
transactions {
...TransactionFragment
}
ordersAsMaker {
...OrderFragment
}
ordersAsTaker {
...OrderFragment
}
relatedWallets {
...WalletFragment
}
relatedWalletsV2 {
...WalletRelationFragment
}
ethBalance
lastActivityAt
activity {
...ActivityItemFragment
}
tokensV2 {
...TokenFragment
}
flips {
...FlipFragment
}
nonce
userId
passBalance
labels {
...LabelFragment
}
}
}
Response
{
"data": {
"favoriteWallets": [
{
"id": "abc123",
"name": "abc123",
"openseaProfile": {},
"updatedAt": DateTime,
"_count": WalletCount,
"displayName": "abc123",
"tokenTransfers": [TokenTransfer],
"realizedGains": [
WalletRealizedGainsByCollection
],
"portfolio": [PortfolioItem],
"activityChart": {},
"totalPortfolioValue": 123.45,
"totalPortfolioValueByLiquidity": [
PortfolioValue
],
"analytics": WalletAnalytics,
"offers": [Offer],
"profitAndLossOverTime": {},
"profitSource": {},
"collectionBalanceAndFloorOverTime": {},
"positionChanges": [WalletPositionChange],
"portfolioValueOverTime": {},
"collections": [WalletCollection],
"tokens": [Token],
"transfersFrom": [TokenTransfer],
"transfersTo": [TokenTransfer],
"transactions": [Transaction],
"ordersAsMaker": [Order],
"ordersAsTaker": [Order],
"relatedWallets": [Wallet],
"relatedWalletsV2": [WalletRelation],
"ethBalance": 123.45,
"lastActivityAt": DateTime,
"activity": [ActivityItem],
"tokensV2": [Token],
"flips": [Flip],
"nonce": "xyz789",
"userId": 123,
"passBalance": 987,
"labels": [Label]
}
]
}
}
flips
[Flip!]!
| Name | Description |
|---|---|
filters -
[FilterArg!]
|
|
orderDesc -
Boolean
|
Default = true |
orderBy -
String
|
Default = "netProfit" |
marketplace -
Int
|
|
collectionId -
String
|
|
walletId -
String
|
|
take -
Int
|
Number of entities to return in response (used for pagination). Default = 50 |
skip -
Int
|
Number of entities to skip (used for pagination). Default = 0 |
Example
Query
query flips($filters: [FilterArg!], $orderDesc: Boolean, $orderBy: String, $marketplace: Int, $collectionId: String, $walletId: String, $take: Int, $skip: Int) {
flips(filters: $filters, orderDesc: $orderDesc, orderBy: $orderBy, marketplace: $marketplace, collectionId: $collectionId, walletId: $walletId, take: $take, skip: $skip) {
id
marketplace
collectionId
tokenId
walletId
soldFor
soldAt
saleGasPaid
rank
marketplaceFee
saleRoyalties
purchaseType
purchasedFor
purchasedAt
heldFor
purchaseGasPaid
netProfit
saleType
collection {
...CollectionFragment
}
token {
...TokenFragment
}
wallet {
...WalletFragment
}
}
}
Variables
{
"filters": [FilterArg],
"orderDesc": true,
"orderBy": "netProfit",
"marketplace": 123,
"collectionId": "Generated Argument example for flips collectionId",
"walletId": "Generated Argument example for flips walletId",
"take": 50,
"skip": 0
}
Response
{
"data": {
"flips": [
{
"id": "abc123",
"marketplace": 123,
"collectionId": "xyz789",
"tokenId": "abc123",
"walletId": "xyz789",
"soldFor": Decimal,
"soldAt": DateTime,
"saleGasPaid": Decimal,
"rank": BigInt,
"marketplaceFee": Decimal,
"saleRoyalties": Decimal,
"purchaseType": "xyz789",
"purchasedFor": Decimal,
"purchasedAt": DateTime,
"heldFor": 987,
"purchaseGasPaid": Decimal,
"netProfit": Decimal,
"saleType": "abc123",
"collection": Collection,
"token": Token,
"wallet": Wallet
}
]
}
}
floorLifetimePass
Example
Query
query floorLifetimePass($unopenedCrate: Boolean) {
floorLifetimePass(unopenedCrate: $unopenedCrate) {
id
collectionAddress
tokenId
ownerAddress
mintTimestamp
_count {
...TokenCountFragment
}
collection {
...CollectionFragment
}
transfers {
...TokenTransferFragment
}
attributes {
...TokenAttributeFragment
}
orders {
...OrderFragment
}
flips {
...FlipFragment
}
isReported
rarityRank
rarityScore
rarityRankNormalized
rarityScoreNormalized
image
previewImageUrl
fullImageUrl
name
description
metadata
tokenUri
price
listings {
...OrderFragment
}
owner {
...WalletFragment
}
lastSale {
...SaleFragment
}
activity {
...ActivityItemFragment
}
activityChart
eventFeed {
...EventFeedItemFragment
}
}
}
Variables
{"unopenedCrate": false}
Response
{
"data": {
"floorLifetimePass": {
"id": "xyz789",
"collectionAddress": "abc123",
"tokenId": "xyz789",
"ownerAddress": "abc123",
"mintTimestamp": DateTime,
"_count": TokenCount,
"collection": Collection,
"transfers": [TokenTransfer],
"attributes": [TokenAttribute],
"orders": [Order],
"flips": [Flip],
"isReported": true,
"rarityRank": 987,
"rarityScore": Decimal,
"rarityRankNormalized": 123,
"rarityScoreNormalized": Decimal,
"image": "xyz789",
"previewImageUrl": "xyz789",
"fullImageUrl": "abc123",
"name": "xyz789",
"description": "abc123",
"metadata": {},
"tokenUri": "abc123",
"price": 123.45,
"listings": [Order],
"owner": Wallet,
"lastSale": Sale,
"activity": [ActivityItem],
"activityChart": {},
"eventFeed": [EventFeedItem]
}
}
}
getBillingInfo
Example
Query
query getBillingInfo {
getBillingInfo {
id
name
addressLine1
addressLine2
city
state
zipCode
country
vatNumber
createdAt
updatedAt
address
}
}
Response
{
"data": {
"getBillingInfo": {
"id": 987,
"name": "xyz789",
"addressLine1": "abc123",
"addressLine2": "xyz789",
"city": "xyz789",
"state": "xyz789",
"zipCode": "xyz789",
"country": "xyz789",
"vatNumber": "abc123",
"createdAt": DateTime,
"updatedAt": DateTime,
"address": "xyz789"
}
}
}
holdersOverTime
Example
Query
query holdersOverTime($period: String, $collectionId: String!) {
holdersOverTime(period: $period, collectionId: $collectionId) {
key
value
}
}
Variables
{
"period": "1d",
"collectionId": "Generated Argument example for holdersOverTime collectionId"
}
Response
{"data": {"holdersOverTime": [{"key": "xyz789", "value": 123.45}]}}
isFavorite
Example
Query
query isFavorite($model: String!, $id: String!) {
isFavorite(model: $model, id: $id)
}
Variables
{
"model": "Generated Argument example for isFavorite model",
"id": "Generated Argument example for isFavorite id"
}
Response
{"data": {"isFavorite": false}}
listingAlerts
Example
Query
query listingAlerts($tokenId: String!) {
listingAlerts(tokenId: $tokenId) {
id
userId
name
type
config
lastCheckedAt
lastEvaluatedAt
lastValue
createdAt
externalUserId
status
_count {
...AlertCountFragment
}
channels
}
}
Variables
{
"tokenId": "Generated Argument example for listingAlerts tokenId"
}
Response
{
"data": {
"listingAlerts": [
{
"id": 987,
"userId": "abc123",
"name": "xyz789",
"type": AlertType,
"config": {},
"lastCheckedAt": DateTime,
"lastEvaluatedAt": DateTime,
"lastValue": 987.65,
"createdAt": DateTime,
"externalUserId": 987,
"status": AlertStatus,
"_count": AlertCount,
"channels": [123]
}
]
}
}
looksrareVolume
Example
Query
query looksrareVolume($period: String!) {
looksrareVolume(period: $period) {
key
value
}
}
Variables
{
"period": "Generated Argument example for looksrareVolume period"
}
Response
{"data": {"looksrareVolume": [{"key": "xyz789", "value": 123.45}]}}
marketplaceVolume
Example
Query
query marketplaceVolume($excludeWashTrades: Boolean, $period: String!) {
marketplaceVolume(excludeWashTrades: $excludeWashTrades, period: $period)
}
Variables
{
"excludeWashTrades": true,
"period": "Generated Argument example for marketplaceVolume period"
}
Response
{"data": {"marketplaceVolume": {}}}
me
Example
Query
query me {
me {
id
role
premiumExpiresAt
createdAt
passBalance
isDiscordLinked
isPremium
wallets {
...WalletFragment
}
walletId
wallet {
...WalletFragment
}
collectionBalance
isCollectionHidden
}
}
Response
{
"data": {
"me": {
"id": 987,
"role": "abc123",
"premiumExpiresAt": DateTime,
"createdAt": DateTime,
"passBalance": 123,
"isDiscordLinked": false,
"isPremium": false,
"wallets": [Wallet],
"walletId": "abc123",
"wallet": Wallet,
"collectionBalance": 987,
"isCollectionHidden": false
}
}
}
meta
Example
Query
query meta {
meta {
eth {
...SyncStatusFragment
}
}
}
Response
{"data": {"meta": {"eth": SyncStatus}}}
mintingCollections
[MintingCollection!]!
| Name | Description |
|---|---|
take -
Int
|
Number of entities to return in response (used for pagination). Default = 50 |
skip -
Int
|
Number of entities to skip (used for pagination). Default = 0 |
period -
String
|
Date range of data. Example: "1h", "1d", "7d". Units supported: minute - m, hour - h, day - d. Default = "1h" |
sortBy -
String
|
Default = "salesCount" |
sortDesc -
Boolean
|
Default = true |
Example
Query
query mintingCollections($take: Int, $skip: Int, $period: String, $sortBy: String, $sortDesc: Boolean) {
mintingCollections(take: $take, skip: $skip, period: $period, sortBy: $sortBy, sortDesc: $sortDesc) {
id
collection {
...CollectionFragment
}
mintCount
firstMintTimestamp
lastMintTimestamp
uniqueMintersCount
avgPrice
avgGas
mintsPerHour
totalValue
isNewMint
}
}
Variables
{
"take": 50,
"skip": 0,
"period": "1h",
"sortBy": "salesCount",
"sortDesc": true
}
Response
{
"data": {
"mintingCollections": [
{
"id": "abc123",
"collection": Collection,
"mintCount": 987,
"firstMintTimestamp": "abc123",
"lastMintTimestamp": "xyz789",
"uniqueMintersCount": 123,
"avgPrice": 987.65,
"avgGas": 123.45,
"mintsPerHour": 987.65,
"totalValue": 123.45,
"isNewMint": false
}
]
}
}
newMintsPerDay
Example
Query
query newMintsPerDay($period: String!) {
newMintsPerDay(period: $period) {
key
value
}
}
Variables
{
"period": "Generated Argument example for newMintsPerDay period"
}
Response
{"data": {"newMintsPerDay": [{"key": "xyz789", "value": 987.65}]}}
newVsReturningBuyersOverTime
Example
Query
query newVsReturningBuyersOverTime($period: String!) {
newVsReturningBuyersOverTime(period: $period)
}
Variables
{
"period": "Generated Argument example for newVsReturningBuyersOverTime period"
}
Response
{"data": {"newVsReturningBuyersOverTime": {}}}
notableUser
Example
Query
query notableUser($username: String) {
notableUser(username: $username) {
id
wallet
twitterUsername
twitterId
lastUpdated
tweets {
...TweetFragment
}
follows {
...FollowedUserFragment
}
}
}
Variables
{
"username": "Generated Argument example for notableUser username"
}
Response
{
"data": {
"notableUser": {
"id": ID,
"wallet": "xyz789",
"twitterUsername": "xyz789",
"twitterId": "xyz789",
"lastUpdated": DateTime,
"tweets": [Tweet],
"follows": [FollowedUser]
}
}
}
openseaVolume
Example
Query
query openseaVolume($period: String!) {
openseaVolume(period: $period) {
key
value
}
}
Variables
{
"period": "Generated Argument example for openseaVolume period"
}
Response
{"data": {"openseaVolume": [{"key": "abc123", "value": 123.45}]}}
ordersHistogram
[ListingsHistogramData!]
| Name | Description |
|---|---|
dataGrouping -
Float
|
Default = 0.1 |
collectionId -
String!
|
Example
Query
query ordersHistogram($dataGrouping: Float, $collectionId: String!) {
ordersHistogram(dataGrouping: $dataGrouping, collectionId: $collectionId) {
marketplace
priceBin
count
totalValue
totalCount
}
}
Variables
{
"dataGrouping": 0.1,
"collectionId": "Generated Argument example for ordersHistogram collectionId"
}
Response
{
"data": {
"ordersHistogram": [
{
"marketplace": 123,
"priceBin": 123.45,
"count": 987,
"totalValue": 123.45,
"totalCount": 123
}
]
}
}
pendingOrderFills
[PendingFill!]!
| Name | Description |
|---|---|
orderHash -
String
|
|
tokenId -
String!
|
|
collectionId -
String!
|
Example
Query
query pendingOrderFills($orderHash: String, $tokenId: String!, $collectionId: String!) {
pendingOrderFills(orderHash: $orderHash, tokenId: $tokenId, collectionId: $collectionId) {
id
orderHash
firstSeen
collectionId
tokenId
gasPrice
maxFeePerGas
maxPriorityFeePerGas
from
transactionHash
status
}
}
Variables
{
"orderHash": "Generated Argument example for pendingOrderFills orderHash",
"tokenId": "Generated Argument example for pendingOrderFills tokenId",
"collectionId": "Generated Argument example for pendingOrderFills collectionId"
}
Response
{
"data": {
"pendingOrderFills": [
{
"id": "xyz789",
"orderHash": "xyz789",
"firstSeen": DateTime,
"collectionId": "abc123",
"tokenId": "abc123",
"gasPrice": "abc123",
"maxFeePerGas": "abc123",
"maxPriorityFeePerGas": "abc123",
"from": "xyz789",
"transactionHash": "abc123",
"status": "xyz789"
}
]
}
}
profitLeaderboard
[ProfitLeaderboardItem!]!
| Name | Description |
|---|---|
orderDesc -
Boolean
|
|
orderBy -
String
|
|
take -
Int
|
Number of entities to return in response (used for pagination). Default = 50 |
skip -
Int
|
Number of entities to skip (used for pagination). Default = 0 |
filters -
[FilterArg!]
|
|
period -
String
|
Example
Query
query profitLeaderboard($orderDesc: Boolean, $orderBy: String, $take: Int, $skip: Int, $filters: [FilterArg!], $period: String) {
profitLeaderboard(orderDesc: $orderDesc, orderBy: $orderBy, take: $take, skip: $skip, filters: $filters, period: $period) {
id
totalProfit
avgProfit
minProfit
maxProfit
totalRoyalties
tokensFlipped
collectionsFlipped
totalGasPaid
avgPurchasedFor
totalSpent
profitableFlips
purchases {
...PurchaseBreakdownFragment
}
wallet {
...WalletFragment
}
}
}
Variables
{
"orderDesc": false,
"orderBy": "Generated Argument example for profitLeaderboard orderBy",
"take": 50,
"skip": 0,
"filters": [FilterArg],
"period": "Generated Argument example for profitLeaderboard period"
}
Response
{
"data": {
"profitLeaderboard": [
{
"id": "xyz789",
"totalProfit": 987.65,
"avgProfit": 123.45,
"minProfit": 987.65,
"maxProfit": 123.45,
"totalRoyalties": 987.65,
"tokensFlipped": 987.65,
"collectionsFlipped": 123.45,
"totalGasPaid": 123.45,
"avgPurchasedFor": 987.65,
"totalSpent": 987.65,
"profitableFlips": 987.65,
"purchases": [PurchaseBreakdown],
"wallet": Wallet
}
]
}
}
revealAlerts
Example
Query
query revealAlerts($collectionId: String) {
revealAlerts(collectionId: $collectionId) {
id
userId
name
type
config
lastCheckedAt
lastEvaluatedAt
lastValue
createdAt
externalUserId
status
_count {
...AlertCountFragment
}
channels
}
}
Variables
{
"collectionId": "Generated Argument example for revealAlerts collectionId"
}
Response
{
"data": {
"revealAlerts": [
{
"id": 987,
"userId": "xyz789",
"name": "xyz789",
"type": AlertType,
"config": {},
"lastCheckedAt": DateTime,
"lastEvaluatedAt": DateTime,
"lastValue": 987.65,
"createdAt": DateTime,
"externalUserId": 123,
"status": AlertStatus,
"_count": AlertCount,
"channels": [123]
}
]
}
}
sales
[Sale!]!
| Name | Description |
|---|---|
where -
SaleWhereInput
|
|
orderBy -
[SaleOrderByWithRelationInput!]
|
|
cursor -
SaleWhereUniqueInput
|
|
take -
Int
|
|
skip -
Int
|
|
distinct -
[SaleScalarFieldEnum!]
|
Example
Query
query sales($where: SaleWhereInput, $orderBy: [SaleOrderByWithRelationInput!], $cursor: SaleWhereUniqueInput, $take: Int, $skip: Int, $distinct: [SaleScalarFieldEnum!]) {
sales(where: $where, orderBy: $orderBy, cursor: $cursor, take: $take, skip: $skip, distinct: $distinct) {
id
transactionId
collectionId
tokenId
marketplace
price
amount
tokensSold
seller
recipient
buyer
type
blockTimestamp
blockNumber
marketplaceFee
royalties
_count {
...SaleCountFragment
}
collection {
...CollectionFragment
}
tokenTransfers {
...SaleTokenTransferFragment
}
transaction {
...TransactionFragment
}
flip {
...FlipFragment
}
}
}
Variables
{
"where": SaleWhereInput,
"orderBy": [SaleOrderByWithRelationInput],
"cursor": SaleWhereUniqueInput,
"take": 123,
"skip": 987,
"distinct": [SaleScalarFieldEnum]
}
Response
{
"data": {
"sales": [
{
"id": "xyz789",
"transactionId": "xyz789",
"collectionId": "xyz789",
"tokenId": "abc123",
"marketplace": 123,
"price": Decimal,
"amount": Decimal,
"tokensSold": 123,
"seller": "abc123",
"recipient": "xyz789",
"buyer": "xyz789",
"type": "abc123",
"blockTimestamp": DateTime,
"blockNumber": BigInt,
"marketplaceFee": Decimal,
"royalties": Decimal,
"_count": SaleCount,
"collection": Collection,
"tokenTransfers": [SaleTokenTransfer],
"transaction": Transaction,
"flip": Flip
}
]
}
}
searchCollections
Example
Query
query searchCollections($take: Int, $query: String!) {
searchCollections(take: $take, query: $query) {
id
type
isVerified
isRevealed
revealsAt
revealedAt
name
symbol
maxSupply
slug
imageUrl
bannerImageUrl
description
discordUrl
contractCreatedTimestamp
externalUrl
telegramUrl
mediumUsername
twitterUsername
instagramUsername
devFeeBasisPoints
openseaFeeBasisPoints
updatedAt
orderbookSyncedAt
_count {
...CollectionCountFragment
}
charts {
...CollectionChartsFragment
}
listingsChart
listingsOverTime
transactionsChart
metrics {
...CollectionMetricsFragment
}
previousMetrics {
...CollectionMetricsFragment
}
salesFloor
previousSalesFloor
isRefreshingTokenMetadata
totalSupply
mintMetrics {
...MintingCollectionWithChartFragment
}
minters {
...CollectionMinterFragment
}
revealProgress
isSyncingOrders
totalTokensListed
listedFloor
topOffer
previousListedFloor
tokensListedPastDay
tokens {
...TokenFragment
}
listingEvents {
...CollectionListingEventFragment
}
saleEvents {
...CollectionActivityEventFragment
}
totalVolume
totalProfits
liquidityRank
activity {
...ActivityItemFragment
}
tokensV2 {
...TokenFragment
}
floorPriceChart
orderbookDepth
tokenTransfers {
...TokenTransferFragment
}
attributes {
...AttributeFragment
}
orders {
...OrderFragment
}
sales {
...SaleFragment
}
profitLeaderboard {
...ProfitLeaderFragment
}
socialMetricsLastUpdatedAt
twitterMetrics {
...TwitterMetricsFragment
}
discordMetrics {
...DiscordMetricsFragment
}
tweets {
...TweetMentionFragment
}
followedBy {
...FollowedByFragment
}
isReportedByUser
isReported
reportReason
isPremiumRequired
}
}
Variables
{
"take": 50,
"query": "Generated Argument example for searchCollections query"
}
Response
{
"data": {
"searchCollections": [
{
"id": "abc123",
"type": "abc123",
"isVerified": true,
"isRevealed": false,
"revealsAt": DateTime,
"revealedAt": DateTime,
"name": "abc123",
"symbol": "xyz789",
"maxSupply": 123,
"slug": "abc123",
"imageUrl": "xyz789",
"bannerImageUrl": "xyz789",
"description": "xyz789",
"discordUrl": "abc123",
"contractCreatedTimestamp": DateTime,
"externalUrl": "xyz789",
"telegramUrl": "abc123",
"mediumUsername": "abc123",
"twitterUsername": "xyz789",
"instagramUsername": "xyz789",
"devFeeBasisPoints": 987,
"openseaFeeBasisPoints": 123,
"updatedAt": DateTime,
"orderbookSyncedAt": DateTime,
"_count": CollectionCount,
"charts": CollectionCharts,
"listingsChart": {},
"listingsOverTime": {},
"transactionsChart": {},
"metrics": CollectionMetrics,
"previousMetrics": CollectionMetrics,
"salesFloor": 987.65,
"previousSalesFloor": 987.65,
"isRefreshingTokenMetadata": false,
"totalSupply": 987,
"mintMetrics": MintingCollectionWithChart,
"minters": [CollectionMinter],
"revealProgress": 123.45,
"isSyncingOrders": true,
"totalTokensListed": 987,
"listedFloor": 123.45,
"topOffer": 123.45,
"previousListedFloor": 987.65,
"tokensListedPastDay": 987,
"tokens": [Token],
"listingEvents": [CollectionListingEvent],
"saleEvents": [CollectionActivityEvent],
"totalVolume": 123.45,
"totalProfits": 123.45,
"liquidityRank": LiquidityRank,
"activity": [ActivityItem],
"tokensV2": [Token],
"floorPriceChart": {},
"orderbookDepth": {},
"tokenTransfers": [TokenTransfer],
"attributes": [Attribute],
"orders": [Order],
"sales": [Sale],
"profitLeaderboard": [ProfitLeader],
"socialMetricsLastUpdatedAt": DateTime,
"twitterMetrics": [TwitterMetrics],
"discordMetrics": [DiscordMetrics],
"tweets": [TweetMention],
"followedBy": [FollowedBy],
"isReportedByUser": true,
"isReported": false,
"reportReason": ReportReason,
"isPremiumRequired": true
}
]
}
}
searchWallets
Example
Query
query searchWallets($take: Int, $query: String!) {
searchWallets(take: $take, query: $query) {
id
name
openseaProfile
updatedAt
_count {
...WalletCountFragment
}
displayName
tokenTransfers {
...TokenTransferFragment
}
realizedGains {
...WalletRealizedGainsByCollectionFragment
}
portfolio {
...PortfolioItemFragment
}
activityChart
totalPortfolioValue
totalPortfolioValueByLiquidity {
...PortfolioValueFragment
}
analytics {
...WalletAnalyticsFragment
}
offers {
...OfferFragment
}
profitAndLossOverTime
profitSource
collectionBalanceAndFloorOverTime
positionChanges {
...WalletPositionChangeFragment
}
portfolioValueOverTime
collections {
...WalletCollectionFragment
}
tokens {
...TokenFragment
}
transfersFrom {
...TokenTransferFragment
}
transfersTo {
...TokenTransferFragment
}
transactions {
...TransactionFragment
}
ordersAsMaker {
...OrderFragment
}
ordersAsTaker {
...OrderFragment
}
relatedWallets {
...WalletFragment
}
relatedWalletsV2 {
...WalletRelationFragment
}
ethBalance
lastActivityAt
activity {
...ActivityItemFragment
}
tokensV2 {
...TokenFragment
}
flips {
...FlipFragment
}
nonce
userId
passBalance
labels {
...LabelFragment
}
}
}
Variables
{
"take": 50,
"query": "Generated Argument example for searchWallets query"
}
Response
{
"data": {
"searchWallets": [
{
"id": "abc123",
"name": "abc123",
"openseaProfile": {},
"updatedAt": DateTime,
"_count": WalletCount,
"displayName": "xyz789",
"tokenTransfers": [TokenTransfer],
"realizedGains": [
WalletRealizedGainsByCollection
],
"portfolio": [PortfolioItem],
"activityChart": {},
"totalPortfolioValue": 987.65,
"totalPortfolioValueByLiquidity": [
PortfolioValue
],
"analytics": WalletAnalytics,
"offers": [Offer],
"profitAndLossOverTime": {},
"profitSource": {},
"collectionBalanceAndFloorOverTime": {},
"positionChanges": [WalletPositionChange],
"portfolioValueOverTime": {},
"collections": [WalletCollection],
"tokens": [Token],
"transfersFrom": [TokenTransfer],
"transfersTo": [TokenTransfer],
"transactions": [Transaction],
"ordersAsMaker": [Order],
"ordersAsTaker": [Order],
"relatedWallets": [Wallet],
"relatedWalletsV2": [WalletRelation],
"ethBalance": 987.65,
"lastActivityAt": DateTime,
"activity": [ActivityItem],
"tokensV2": [Token],
"flips": [Flip],
"nonce": "abc123",
"userId": 987,
"passBalance": 123,
"labels": [Label]
}
]
}
}
token
Example
Query
query token($where: TokenWhereUniqueInput!) {
token(where: $where) {
id
collectionAddress
tokenId
ownerAddress
mintTimestamp
_count {
...TokenCountFragment
}
collection {
...CollectionFragment
}
transfers {
...TokenTransferFragment
}
attributes {
...TokenAttributeFragment
}
orders {
...OrderFragment
}
flips {
...FlipFragment
}
isReported
rarityRank
rarityScore
rarityRankNormalized
rarityScoreNormalized
image
previewImageUrl
fullImageUrl
name
description
metadata
tokenUri
price
listings {
...OrderFragment
}
owner {
...WalletFragment
}
lastSale {
...SaleFragment
}
activity {
...ActivityItemFragment
}
activityChart
eventFeed {
...EventFeedItemFragment
}
}
}
Variables
{"where": TokenWhereUniqueInput}
Response
{
"data": {
"token": {
"id": "xyz789",
"collectionAddress": "xyz789",
"tokenId": "xyz789",
"ownerAddress": "abc123",
"mintTimestamp": DateTime,
"_count": TokenCount,
"collection": Collection,
"transfers": [TokenTransfer],
"attributes": [TokenAttribute],
"orders": [Order],
"flips": [Flip],
"isReported": false,
"rarityRank": 987,
"rarityScore": Decimal,
"rarityRankNormalized": 987,
"rarityScoreNormalized": Decimal,
"image": "abc123",
"previewImageUrl": "xyz789",
"fullImageUrl": "abc123",
"name": "abc123",
"description": "abc123",
"metadata": {},
"tokenUri": "xyz789",
"price": 987.65,
"listings": [Order],
"owner": Wallet,
"lastSale": Sale,
"activity": [ActivityItem],
"activityChart": {},
"eventFeed": [EventFeedItem]
}
}
}
tokens
[Token!]!
| Name | Description |
|---|---|
take -
Int
|
Number of entities to return in response (used for pagination). Default = 50 |
skip -
Int
|
Number of entities to skip (used for pagination). Default = 0 |
ids -
[String!]
|
Filter tokens by token ID. Default = [] |
Example
Query
query tokens($take: Int, $skip: Int, $ids: [String!]) {
tokens(take: $take, skip: $skip, ids: $ids) {
id
collectionAddress
tokenId
ownerAddress
mintTimestamp
_count {
...TokenCountFragment
}
collection {
...CollectionFragment
}
transfers {
...TokenTransferFragment
}
attributes {
...TokenAttributeFragment
}
orders {
...OrderFragment
}
flips {
...FlipFragment
}
isReported
rarityRank
rarityScore
rarityRankNormalized
rarityScoreNormalized
image
previewImageUrl
fullImageUrl
name
description
metadata
tokenUri
price
listings {
...OrderFragment
}
owner {
...WalletFragment
}
lastSale {
...SaleFragment
}
activity {
...ActivityItemFragment
}
activityChart
eventFeed {
...EventFeedItemFragment
}
}
}
Variables
{"take": 50, "skip": 0, "ids": [[]]}
Response
{
"data": {
"tokens": [
{
"id": "xyz789",
"collectionAddress": "xyz789",
"tokenId": "xyz789",
"ownerAddress": "xyz789",
"mintTimestamp": DateTime,
"_count": TokenCount,
"collection": Collection,
"transfers": [TokenTransfer],
"attributes": [TokenAttribute],
"orders": [Order],
"flips": [Flip],
"isReported": false,
"rarityRank": 987,
"rarityScore": Decimal,
"rarityRankNormalized": 987,
"rarityScoreNormalized": Decimal,
"image": "abc123",
"previewImageUrl": "abc123",
"fullImageUrl": "abc123",
"name": "xyz789",
"description": "xyz789",
"metadata": {},
"tokenUri": "xyz789",
"price": 123.45,
"listings": [Order],
"owner": Wallet,
"lastSale": Sale,
"activity": [ActivityItem],
"activityChart": {},
"eventFeed": [EventFeedItem]
}
]
}
}
tokenTransfersRoot
[TokenTransferRoot!]!
| Name | Description |
|---|---|
walletId -
String
|
Token transfers for a wallet |
collectionId -
String
|
Token transfers for a collection |
orderBy -
TokenTransferOrderByWithRelationInput
|
Order by |
filters -
TokenTransfersRootFilters
|
Token transfers filters |
take -
Int
|
Number of entities to return in response (used for pagination). Default = 50 |
skip -
Int
|
Number of entities to skip (used for pagination). Default = 0 |
Example
Query
query tokenTransfersRoot($walletId: String, $collectionId: String, $orderBy: TokenTransferOrderByWithRelationInput, $filters: TokenTransfersRootFilters, $take: Int, $skip: Int) {
tokenTransfersRoot(walletId: $walletId, collectionId: $collectionId, orderBy: $orderBy, filters: $filters, take: $take, skip: $skip) {
id
transactionId
collectionAddress
tokenId
fromAddress
toAddress
timestamp
value
_count {
...TokenTransferCountFragment
}
transaction {
...TransactionFragment
}
token {
...TokenFragment
}
from {
...WalletFragment
}
to {
...WalletFragment
}
sales {
...SaleTokenTransferFragment
}
collection {
...CollectionFragment
}
sale {
...SaleFragment
}
type
transactionValue
gasPrice
}
}
Variables
{
"walletId": "Generated Argument example for tokenTransfersRoot walletId",
"collectionId": "Generated Argument example for tokenTransfersRoot collectionId",
"orderBy": TokenTransferOrderByWithRelationInput,
"filters": TokenTransfersRootFilters,
"take": 50,
"skip": 0
}
Response
{
"data": {
"tokenTransfersRoot": [
{
"id": "abc123",
"transactionId": "abc123",
"collectionAddress": "abc123",
"tokenId": "xyz789",
"fromAddress": "xyz789",
"toAddress": "abc123",
"timestamp": DateTime,
"value": Decimal,
"_count": TokenTransferCount,
"transaction": Transaction,
"token": Token,
"from": Wallet,
"to": Wallet,
"sales": [SaleTokenTransfer],
"collection": Collection,
"sale": Sale,
"type": "abc123",
"transactionValue": 987.65,
"gasPrice": 987.65
}
]
}
}
topCollectionsIndex
Example
Query
query topCollectionsIndex($period: String!) {
topCollectionsIndex(period: $period)
}
Variables
{
"period": "Generated Argument example for topCollectionsIndex period"
}
Response
{"data": {"topCollectionsIndex": {}}}
totalValueMintedOverTime
Example
Query
query totalValueMintedOverTime($period: String!) {
totalValueMintedOverTime(period: $period)
}
Variables
{
"period": "Generated Argument example for totalValueMintedOverTime period"
}
Response
{"data": {"totalValueMintedOverTime": {}}}
trendingCollections
[CollectionWithStats!]!
| Name | Description |
|---|---|
take -
Int
|
Number of entities to return in response (used for pagination). Default = 50 |
skip -
Int
|
Number of entities to skip (used for pagination). Default = 0 |
period -
String
|
Date range of data. Example: "1h", "1d", "7d". Units supported: minute - m, hour - h, day - d. Default = "1h" |
sortBy -
String
|
Default = "salesCount" |
sortDesc -
Boolean
|
Default = true |
Example
Query
query trendingCollections($take: Int, $skip: Int, $period: String, $sortBy: String, $sortDesc: Boolean) {
trendingCollections(take: $take, skip: $skip, period: $period, sortBy: $sortBy, sortDesc: $sortDesc) {
id
collection {
...CollectionFragment
}
volume
salesCount
avgPrice
minPrice
maxPrice
medianPrice
previous {
...CollectionWithStatsFragment
}
}
}
Variables
{
"take": 50,
"skip": 0,
"period": "1h",
"sortBy": "salesCount",
"sortDesc": true
}
Response
{
"data": {
"trendingCollections": [
{
"id": "xyz789",
"collection": Collection,
"volume": 987.65,
"salesCount": 123,
"avgPrice": 987.65,
"minPrice": 987.65,
"maxPrice": 123.45,
"medianPrice": 987.65,
"previous": CollectionWithStats
}
]
}
}
uniqueBuyersAndSellersOverTime
Example
Query
query uniqueBuyersAndSellersOverTime($period: String!) {
uniqueBuyersAndSellersOverTime(period: $period)
}
Variables
{
"period": "Generated Argument example for uniqueBuyersAndSellersOverTime period"
}
Response
{"data": {"uniqueBuyersAndSellersOverTime": {}}}
userEventsFeed
[EventFeedItem!]!
| Name | Description |
|---|---|
take -
Int
|
Default = 20 |
skip -
Int
|
Default = 0 |
types -
[EventType!]
|
Example
Query
query userEventsFeed($take: Int, $skip: Int, $types: [EventType!]) {
userEventsFeed(take: $take, skip: $skip, types: $types) {
id
type
timestamp
value
wallet {
...WalletFragment
}
collection {
...CollectionFragment
}
transaction {
...TransactionFragment
}
tokenCount
events
}
}
Variables
{"take": 20, "skip": 0, "types": [EventType]}
Response
{
"data": {
"userEventsFeed": [
{
"id": "xyz789",
"type": EventType,
"timestamp": DateTime,
"value": 987.65,
"wallet": Wallet,
"collection": Collection,
"transaction": Transaction,
"tokenCount": 987,
"events": [Event]
}
]
}
}
userWalletsEventsFeed
[EventFeedItem!]!
| Name | Description |
|---|---|
take -
Int
|
Default = 20 |
skip -
Int
|
Default = 0 |
types -
[EventType!]
|
Example
Query
query userWalletsEventsFeed($take: Int, $skip: Int, $types: [EventType!]) {
userWalletsEventsFeed(take: $take, skip: $skip, types: $types) {
id
type
timestamp
value
wallet {
...WalletFragment
}
collection {
...CollectionFragment
}
transaction {
...TransactionFragment
}
tokenCount
events
}
}
Variables
{"take": 20, "skip": 0, "types": [EventType]}
Response
{
"data": {
"userWalletsEventsFeed": [
{
"id": "abc123",
"type": EventType,
"timestamp": DateTime,
"value": 987.65,
"wallet": Wallet,
"collection": Collection,
"transaction": Transaction,
"tokenCount": 987,
"events": [Event]
}
]
}
}
wallet
Example
Query
query wallet($where: WalletWhereUniqueInput!) {
wallet(where: $where) {
id
name
openseaProfile
updatedAt
_count {
...WalletCountFragment
}
displayName
tokenTransfers {
...TokenTransferFragment
}
realizedGains {
...WalletRealizedGainsByCollectionFragment
}
portfolio {
...PortfolioItemFragment
}
activityChart
totalPortfolioValue
totalPortfolioValueByLiquidity {
...PortfolioValueFragment
}
analytics {
...WalletAnalyticsFragment
}
offers {
...OfferFragment
}
profitAndLossOverTime
profitSource
collectionBalanceAndFloorOverTime
positionChanges {
...WalletPositionChangeFragment
}
portfolioValueOverTime
collections {
...WalletCollectionFragment
}
tokens {
...TokenFragment
}
transfersFrom {
...TokenTransferFragment
}
transfersTo {
...TokenTransferFragment
}
transactions {
...TransactionFragment
}
ordersAsMaker {
...OrderFragment
}
ordersAsTaker {
...OrderFragment
}
relatedWallets {
...WalletFragment
}
relatedWalletsV2 {
...WalletRelationFragment
}
ethBalance
lastActivityAt
activity {
...ActivityItemFragment
}
tokensV2 {
...TokenFragment
}
flips {
...FlipFragment
}
nonce
userId
passBalance
labels {
...LabelFragment
}
}
}
Variables
{"where": WalletWhereUniqueInput}
Response
{
"data": {
"wallet": {
"id": "abc123",
"name": "xyz789",
"openseaProfile": {},
"updatedAt": DateTime,
"_count": WalletCount,
"displayName": "abc123",
"tokenTransfers": [TokenTransfer],
"realizedGains": [WalletRealizedGainsByCollection],
"portfolio": [PortfolioItem],
"activityChart": {},
"totalPortfolioValue": 123.45,
"totalPortfolioValueByLiquidity": [PortfolioValue],
"analytics": WalletAnalytics,
"offers": [Offer],
"profitAndLossOverTime": {},
"profitSource": {},
"collectionBalanceAndFloorOverTime": {},
"positionChanges": [WalletPositionChange],
"portfolioValueOverTime": {},
"collections": [WalletCollection],
"tokens": [Token],
"transfersFrom": [TokenTransfer],
"transfersTo": [TokenTransfer],
"transactions": [Transaction],
"ordersAsMaker": [Order],
"ordersAsTaker": [Order],
"relatedWallets": [Wallet],
"relatedWalletsV2": [WalletRelation],
"ethBalance": 987.65,
"lastActivityAt": DateTime,
"activity": [ActivityItem],
"tokensV2": [Token],
"flips": [Flip],
"nonce": "xyz789",
"userId": 123,
"passBalance": 987,
"labels": [Label]
}
}
}
walletByEns
Example
Query
query walletByEns($name: String!) {
walletByEns(name: $name) {
id
name
openseaProfile
updatedAt
_count {
...WalletCountFragment
}
displayName
tokenTransfers {
...TokenTransferFragment
}
realizedGains {
...WalletRealizedGainsByCollectionFragment
}
portfolio {
...PortfolioItemFragment
}
activityChart
totalPortfolioValue
totalPortfolioValueByLiquidity {
...PortfolioValueFragment
}
analytics {
...WalletAnalyticsFragment
}
offers {
...OfferFragment
}
profitAndLossOverTime
profitSource
collectionBalanceAndFloorOverTime
positionChanges {
...WalletPositionChangeFragment
}
portfolioValueOverTime
collections {
...WalletCollectionFragment
}
tokens {
...TokenFragment
}
transfersFrom {
...TokenTransferFragment
}
transfersTo {
...TokenTransferFragment
}
transactions {
...TransactionFragment
}
ordersAsMaker {
...OrderFragment
}
ordersAsTaker {
...OrderFragment
}
relatedWallets {
...WalletFragment
}
relatedWalletsV2 {
...WalletRelationFragment
}
ethBalance
lastActivityAt
activity {
...ActivityItemFragment
}
tokensV2 {
...TokenFragment
}
flips {
...FlipFragment
}
nonce
userId
passBalance
labels {
...LabelFragment
}
}
}
Variables
{
"name": "Generated Argument example for walletByEns name"
}
Response
{
"data": {
"walletByEns": {
"id": "abc123",
"name": "abc123",
"openseaProfile": {},
"updatedAt": DateTime,
"_count": WalletCount,
"displayName": "xyz789",
"tokenTransfers": [TokenTransfer],
"realizedGains": [WalletRealizedGainsByCollection],
"portfolio": [PortfolioItem],
"activityChart": {},
"totalPortfolioValue": 123.45,
"totalPortfolioValueByLiquidity": [PortfolioValue],
"analytics": WalletAnalytics,
"offers": [Offer],
"profitAndLossOverTime": {},
"profitSource": {},
"collectionBalanceAndFloorOverTime": {},
"positionChanges": [WalletPositionChange],
"portfolioValueOverTime": {},
"collections": [WalletCollection],
"tokens": [Token],
"transfersFrom": [TokenTransfer],
"transfersTo": [TokenTransfer],
"transactions": [Transaction],
"ordersAsMaker": [Order],
"ordersAsTaker": [Order],
"relatedWallets": [Wallet],
"relatedWalletsV2": [WalletRelation],
"ethBalance": 123.45,
"lastActivityAt": DateTime,
"activity": [ActivityItem],
"tokensV2": [Token],
"flips": [Flip],
"nonce": "abc123",
"userId": 123,
"passBalance": 123,
"labels": [Label]
}
}
}
walletCollections
[CollectionWithStats!]!
| Name | Description |
|---|---|
includeHidden -
Boolean
|
Default = false |
take -
Int
|
Number of entities to return in response (used for pagination). Default = 50 |
skip -
Int
|
Number of entities to skip (used for pagination). Default = 0 |
period -
String
|
Date range of data. Example: "1h", "1d", "7d". Units supported: minute - m, hour - h, day - d. Default = "1h" |
sortBy -
String
|
Default = "salesCount" |
sortDesc -
Boolean
|
Default = true |
Example
Query
query walletCollections($includeHidden: Boolean, $take: Int, $skip: Int, $period: String, $sortBy: String, $sortDesc: Boolean) {
walletCollections(includeHidden: $includeHidden, take: $take, skip: $skip, period: $period, sortBy: $sortBy, sortDesc: $sortDesc) {
id
collection {
...CollectionFragment
}
volume
salesCount
avgPrice
minPrice
maxPrice
medianPrice
previous {
...CollectionWithStatsFragment
}
}
}
Variables
{
"includeHidden": false,
"take": 50,
"skip": 0,
"period": "1h",
"sortBy": "salesCount",
"sortDesc": true
}
Response
{
"data": {
"walletCollections": [
{
"id": "xyz789",
"collection": Collection,
"volume": 123.45,
"salesCount": 123,
"avgPrice": 123.45,
"minPrice": 123.45,
"maxPrice": 123.45,
"medianPrice": 987.65,
"previous": CollectionWithStats
}
]
}
}
walletEventsFeed
[EventFeedItem!]!
| Name | Description |
|---|---|
walletId -
String!
|
|
take -
Int
|
Default = 20 |
skip -
Int
|
Default = 0 |
types -
[EventType!]
|
Example
Query
query walletEventsFeed($walletId: String!, $take: Int, $skip: Int, $types: [EventType!]) {
walletEventsFeed(walletId: $walletId, take: $take, skip: $skip, types: $types) {
id
type
timestamp
value
wallet {
...WalletFragment
}
collection {
...CollectionFragment
}
transaction {
...TransactionFragment
}
tokenCount
events
}
}
Variables
{
"walletId": "Generated Argument example for walletEventsFeed walletId",
"take": 20,
"skip": 0,
"types": [EventType]
}
Response
{
"data": {
"walletEventsFeed": [
{
"id": "abc123",
"type": EventType,
"timestamp": DateTime,
"value": 987.65,
"wallet": Wallet,
"collection": Collection,
"transaction": Transaction,
"tokenCount": 987,
"events": [Event]
}
]
}
}
wallets
[Wallet!]!
| Name | Description |
|---|---|
where -
WalletWhereInput
|
|
orderBy -
[WalletOrderByWithRelationInput!]
|
|
cursor -
WalletWhereUniqueInput
|
|
take -
Int
|
|
skip -
Int
|
|
distinct -
[WalletScalarFieldEnum!]
|
Example
Query
query wallets($where: WalletWhereInput, $orderBy: [WalletOrderByWithRelationInput!], $cursor: WalletWhereUniqueInput, $take: Int, $skip: Int, $distinct: [WalletScalarFieldEnum!]) {
wallets(where: $where, orderBy: $orderBy, cursor: $cursor, take: $take, skip: $skip, distinct: $distinct) {
id
name
openseaProfile
updatedAt
_count {
...WalletCountFragment
}
displayName
tokenTransfers {
...TokenTransferFragment
}
realizedGains {
...WalletRealizedGainsByCollectionFragment
}
portfolio {
...PortfolioItemFragment
}
activityChart
totalPortfolioValue
totalPortfolioValueByLiquidity {
...PortfolioValueFragment
}
analytics {
...WalletAnalyticsFragment
}
offers {
...OfferFragment
}
profitAndLossOverTime
profitSource
collectionBalanceAndFloorOverTime
positionChanges {
...WalletPositionChangeFragment
}
portfolioValueOverTime
collections {
...WalletCollectionFragment
}
tokens {
...TokenFragment
}
transfersFrom {
...TokenTransferFragment
}
transfersTo {
...TokenTransferFragment
}
transactions {
...TransactionFragment
}
ordersAsMaker {
...OrderFragment
}
ordersAsTaker {
...OrderFragment
}
relatedWallets {
...WalletFragment
}
relatedWalletsV2 {
...WalletRelationFragment
}
ethBalance
lastActivityAt
activity {
...ActivityItemFragment
}
tokensV2 {
...TokenFragment
}
flips {
...FlipFragment
}
nonce
userId
passBalance
labels {
...LabelFragment
}
}
}
Variables
{
"where": WalletWhereInput,
"orderBy": [WalletOrderByWithRelationInput],
"cursor": WalletWhereUniqueInput,
"take": 987,
"skip": 123,
"distinct": [WalletScalarFieldEnum]
}
Response
{
"data": {
"wallets": [
{
"id": "abc123",
"name": "xyz789",
"openseaProfile": {},
"updatedAt": DateTime,
"_count": WalletCount,
"displayName": "xyz789",
"tokenTransfers": [TokenTransfer],
"realizedGains": [
WalletRealizedGainsByCollection
],
"portfolio": [PortfolioItem],
"activityChart": {},
"totalPortfolioValue": 123.45,
"totalPortfolioValueByLiquidity": [
PortfolioValue
],
"analytics": WalletAnalytics,
"offers": [Offer],
"profitAndLossOverTime": {},
"profitSource": {},
"collectionBalanceAndFloorOverTime": {},
"positionChanges": [WalletPositionChange],
"portfolioValueOverTime": {},
"collections": [WalletCollection],
"tokens": [Token],
"transfersFrom": [TokenTransfer],
"transfersTo": [TokenTransfer],
"transactions": [Transaction],
"ordersAsMaker": [Order],
"ordersAsTaker": [Order],
"relatedWallets": [Wallet],
"relatedWalletsV2": [WalletRelation],
"ethBalance": 987.65,
"lastActivityAt": DateTime,
"activity": [ActivityItem],
"tokensV2": [Token],
"flips": [Flip],
"nonce": "xyz789",
"userId": 123,
"passBalance": 987,
"labels": [Label]
}
]
}
}
walletWatchlist
Example
Query
query walletWatchlist($id: Int!) {
walletWatchlist(id: $id) {
id
name
slug
isPublic
createdAt
status
isPinned
memberCount
isMember
members {
...WalletFragment
}
flips {
...FlipFragment
}
totalPortfolioValue
totalPortfolioValueByLiquidity {
...PortfolioValueFragment
}
analytics {
...WalletAnalyticsFragment
}
profitAndLossOverTime
profitSource
collectionBalanceAndFloorOverTime
positionChanges {
...WalletPositionChangeFragment
}
portfolioValueOverTime
activityChart
tokens {
...TokenFragment
}
activity {
...ActivityItemFragment
}
collections {
...WalletCollectionFragment
}
relatedWallets {
...WalletRelationFragment
}
feed {
...EventFeedItemFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"walletWatchlist": {
"id": 987,
"name": "abc123",
"slug": "abc123",
"isPublic": false,
"createdAt": DateTime,
"status": WatchlistStatus,
"isPinned": false,
"memberCount": 987,
"isMember": false,
"members": [Wallet],
"flips": [Flip],
"totalPortfolioValue": 987.65,
"totalPortfolioValueByLiquidity": [PortfolioValue],
"analytics": WalletAnalytics,
"profitAndLossOverTime": {},
"profitSource": {},
"collectionBalanceAndFloorOverTime": {},
"positionChanges": [WalletPositionChange],
"portfolioValueOverTime": {},
"activityChart": {},
"tokens": [Token],
"activity": [ActivityItem],
"collections": [WalletCollection],
"relatedWallets": [WalletRelation],
"feed": [EventFeedItem]
}
}
}
walletWatchlistBySlug
Example
Query
query walletWatchlistBySlug($slug: String!) {
walletWatchlistBySlug(slug: $slug) {
id
name
slug
isPublic
createdAt
status
isPinned
memberCount
isMember
members {
...WalletFragment
}
flips {
...FlipFragment
}
totalPortfolioValue
totalPortfolioValueByLiquidity {
...PortfolioValueFragment
}
analytics {
...WalletAnalyticsFragment
}
profitAndLossOverTime
profitSource
collectionBalanceAndFloorOverTime
positionChanges {
...WalletPositionChangeFragment
}
portfolioValueOverTime
activityChart
tokens {
...TokenFragment
}
activity {
...ActivityItemFragment
}
collections {
...WalletCollectionFragment
}
relatedWallets {
...WalletRelationFragment
}
feed {
...EventFeedItemFragment
}
}
}
Variables
{
"slug": "Generated Argument example for walletWatchlistBySlug slug"
}
Response
{
"data": {
"walletWatchlistBySlug": {
"id": 123,
"name": "abc123",
"slug": "abc123",
"isPublic": false,
"createdAt": DateTime,
"status": WatchlistStatus,
"isPinned": true,
"memberCount": 987,
"isMember": true,
"members": [Wallet],
"flips": [Flip],
"totalPortfolioValue": 987.65,
"totalPortfolioValueByLiquidity": [PortfolioValue],
"analytics": WalletAnalytics,
"profitAndLossOverTime": {},
"profitSource": {},
"collectionBalanceAndFloorOverTime": {},
"positionChanges": [WalletPositionChange],
"portfolioValueOverTime": {},
"activityChart": {},
"tokens": [Token],
"activity": [ActivityItem],
"collections": [WalletCollection],
"relatedWallets": [WalletRelation],
"feed": [EventFeedItem]
}
}
}
walletWatchlists
Example
Query
query walletWatchlists($pinnedOnly: Boolean) {
walletWatchlists(pinnedOnly: $pinnedOnly) {
id
name
slug
isPublic
createdAt
status
isPinned
memberCount
isMember
members {
...WalletFragment
}
flips {
...FlipFragment
}
totalPortfolioValue
totalPortfolioValueByLiquidity {
...PortfolioValueFragment
}
analytics {
...WalletAnalyticsFragment
}
profitAndLossOverTime
profitSource
collectionBalanceAndFloorOverTime
positionChanges {
...WalletPositionChangeFragment
}
portfolioValueOverTime
activityChart
tokens {
...TokenFragment
}
activity {
...ActivityItemFragment
}
collections {
...WalletCollectionFragment
}
relatedWallets {
...WalletRelationFragment
}
feed {
...EventFeedItemFragment
}
}
}
Variables
{"pinnedOnly": false}
Response
{
"data": {
"walletWatchlists": [
{
"id": 123,
"name": "abc123",
"slug": "abc123",
"isPublic": true,
"createdAt": DateTime,
"status": WatchlistStatus,
"isPinned": false,
"memberCount": 987,
"isMember": true,
"members": [Wallet],
"flips": [Flip],
"totalPortfolioValue": 123.45,
"totalPortfolioValueByLiquidity": [
PortfolioValue
],
"analytics": WalletAnalytics,
"profitAndLossOverTime": {},
"profitSource": {},
"collectionBalanceAndFloorOverTime": {},
"positionChanges": [WalletPositionChange],
"portfolioValueOverTime": {},
"activityChart": {},
"tokens": [Token],
"activity": [ActivityItem],
"collections": [WalletCollection],
"relatedWallets": [WalletRelation],
"feed": [EventFeedItem]
}
]
}
}
watchlistCollectionsSales
[CollectionWithStats!]!
| Name | Description |
|---|---|
watchlistId -
Int!
|
|
take -
Int
|
Number of entities to return in response (used for pagination). Default = 50 |
skip -
Int
|
Number of entities to skip (used for pagination). Default = 0 |
period -
String
|
Date range of data. Example: "1h", "1d", "7d". Units supported: minute - m, hour - h, day - d. Default = "1h" |
sortBy -
String
|
Default = "salesCount" |
sortDesc -
Boolean
|
Default = true |
Example
Query
query watchlistCollectionsSales($watchlistId: Int!, $take: Int, $skip: Int, $period: String, $sortBy: String, $sortDesc: Boolean) {
watchlistCollectionsSales(watchlistId: $watchlistId, take: $take, skip: $skip, period: $period, sortBy: $sortBy, sortDesc: $sortDesc) {
id
collection {
...CollectionFragment
}
volume
salesCount
avgPrice
minPrice
maxPrice
medianPrice
previous {
...CollectionWithStatsFragment
}
}
}
Variables
{
"watchlistId": 987,
"take": 50,
"skip": 0,
"period": "1h",
"sortBy": "salesCount",
"sortDesc": true
}
Response
{
"data": {
"watchlistCollectionsSales": [
{
"id": "xyz789",
"collection": Collection,
"volume": 987.65,
"salesCount": 987,
"avgPrice": 123.45,
"minPrice": 123.45,
"maxPrice": 987.65,
"medianPrice": 123.45,
"previous": CollectionWithStats
}
]
}
}
x2y2Volume
Example
Query
query x2y2Volume($period: String!) {
x2y2Volume(period: $period) {
key
value
}
}
Variables
{
"period": "Generated Argument example for x2y2Volume period"
}
Response
{"data": {"x2y2Volume": [{"key": "abc123", "value": 987.65}]}}
Mutations
addCollectionsToWatchlist
Example
Query
mutation addCollectionsToWatchlist($collectionIds: [String!]!, $watchlistId: Int!) {
addCollectionsToWatchlist(collectionIds: $collectionIds, watchlistId: $watchlistId) {
id
name
slug
isPublic
createdAt
status
isPinned
memberCount
marketCapOverTime {
...ChartDataFragment
}
volumeOverTime {
...ChartDataFragment
}
volume {
...NumberWithChangeFragment
}
marketCap {
...NumberWithChangeFragment
}
uniqueBuyersCount {
...NumberWithChangeFragment
}
uniqueSellersCount {
...NumberWithChangeFragment
}
imageUrl
isMember
members {
...CollectionFragment
}
}
}
Variables
{
"collectionIds": [
"Generated Argument example for addCollectionsToWatchlist collectionIds"
],
"watchlistId": 123
}
Response
{
"data": {
"addCollectionsToWatchlist": {
"id": 987,
"name": "xyz789",
"slug": "xyz789",
"isPublic": false,
"createdAt": DateTime,
"status": WatchlistStatus,
"isPinned": false,
"memberCount": 987,
"marketCapOverTime": [ChartData],
"volumeOverTime": [ChartData],
"volume": NumberWithChange,
"marketCap": NumberWithChange,
"uniqueBuyersCount": NumberWithChange,
"uniqueSellersCount": NumberWithChange,
"imageUrl": "xyz789",
"isMember": true,
"members": [Collection]
}
}
}
addWalletsToWatchlist
Example
Query
mutation addWalletsToWatchlist($walletIds: [String!]!, $watchlistId: Int!) {
addWalletsToWatchlist(walletIds: $walletIds, watchlistId: $watchlistId) {
id
name
slug
isPublic
createdAt
status
isPinned
memberCount
isMember
members {
...WalletFragment
}
flips {
...FlipFragment
}
totalPortfolioValue
totalPortfolioValueByLiquidity {
...PortfolioValueFragment
}
analytics {
...WalletAnalyticsFragment
}
profitAndLossOverTime
profitSource
collectionBalanceAndFloorOverTime
positionChanges {
...WalletPositionChangeFragment
}
portfolioValueOverTime
activityChart
tokens {
...TokenFragment
}
activity {
...ActivityItemFragment
}
collections {
...WalletCollectionFragment
}
relatedWallets {
...WalletRelationFragment
}
feed {
...EventFeedItemFragment
}
}
}
Variables
{
"walletIds": [
"Generated Argument example for addWalletsToWatchlist walletIds"
],
"watchlistId": 123
}
Response
{
"data": {
"addWalletsToWatchlist": {
"id": 987,
"name": "abc123",
"slug": "abc123",
"isPublic": false,
"createdAt": DateTime,
"status": WatchlistStatus,
"isPinned": false,
"memberCount": 987,
"isMember": true,
"members": [Wallet],
"flips": [Flip],
"totalPortfolioValue": 123.45,
"totalPortfolioValueByLiquidity": [PortfolioValue],
"analytics": WalletAnalytics,
"profitAndLossOverTime": {},
"profitSource": {},
"collectionBalanceAndFloorOverTime": {},
"positionChanges": [WalletPositionChange],
"portfolioValueOverTime": {},
"activityChart": {},
"tokens": [Token],
"activity": [ActivityItem],
"collections": [WalletCollection],
"relatedWallets": [WalletRelation],
"feed": [EventFeedItem]
}
}
}
claimCratePrize
Example
Query
mutation claimCratePrize($walletId: String, $prizeId: Int!) {
claimCratePrize(walletId: $walletId, prizeId: $prizeId)
}
Variables
{
"walletId": "Generated Argument example for claimCratePrize walletId",
"prizeId": 987
}
Response
{"data": {"claimCratePrize": false}}
createAlert
Example
Query
mutation createAlert($data: CreateAlertInput!) {
createAlert(data: $data) {
id
userId
name
type
config
lastCheckedAt
lastEvaluatedAt
lastValue
createdAt
externalUserId
status
_count {
...AlertCountFragment
}
channels
}
}
Variables
{"data": CreateAlertInput}
Response
{
"data": {
"createAlert": {
"id": 987,
"userId": "abc123",
"name": "xyz789",
"type": AlertType,
"config": {},
"lastCheckedAt": DateTime,
"lastEvaluatedAt": DateTime,
"lastValue": 123.45,
"createdAt": DateTime,
"externalUserId": 123,
"status": AlertStatus,
"_count": AlertCount,
"channels": [123]
}
}
}
createBillingInfo
Example
Query
mutation createBillingInfo($billingInfoData: BillingInfoBaseInput!) {
createBillingInfo(billingInfoData: $billingInfoData) {
id
name
addressLine1
addressLine2
city
state
zipCode
country
vatNumber
createdAt
updatedAt
address
}
}
Variables
{"billingInfoData": BillingInfoBaseInput}
Response
{
"data": {
"createBillingInfo": {
"id": 123,
"name": "xyz789",
"addressLine1": "xyz789",
"addressLine2": "xyz789",
"city": "xyz789",
"state": "abc123",
"zipCode": "abc123",
"country": "xyz789",
"vatNumber": "xyz789",
"createdAt": DateTime,
"updatedAt": DateTime,
"address": "xyz789"
}
}
}
createChannel
Example
Query
mutation createChannel($data: ChannelCreateInput!) {
createChannel(data: $data) {
id
userId
name
type
config
status
externalUserId
_count {
...ChannelCountFragment
}
}
}
Variables
{"data": ChannelCreateInput}
Response
{
"data": {
"createChannel": {
"id": 123,
"userId": "xyz789",
"name": "xyz789",
"type": ChannelType,
"config": {},
"status": ChannelStatus,
"externalUserId": 987,
"_count": ChannelCount
}
}
}
createCollectionWatchlist
Example
Query
mutation createCollectionWatchlist($name: String!) {
createCollectionWatchlist(name: $name) {
id
name
slug
isPublic
createdAt
status
isPinned
memberCount
marketCapOverTime {
...ChartDataFragment
}
volumeOverTime {
...ChartDataFragment
}
volume {
...NumberWithChangeFragment
}
marketCap {
...NumberWithChangeFragment
}
uniqueBuyersCount {
...NumberWithChangeFragment
}
uniqueSellersCount {
...NumberWithChangeFragment
}
imageUrl
isMember
members {
...CollectionFragment
}
}
}
Variables
{
"name": "Generated Argument example for createCollectionWatchlist name"
}
Response
{
"data": {
"createCollectionWatchlist": {
"id": 123,
"name": "abc123",
"slug": "xyz789",
"isPublic": true,
"createdAt": DateTime,
"status": WatchlistStatus,
"isPinned": true,
"memberCount": 123,
"marketCapOverTime": [ChartData],
"volumeOverTime": [ChartData],
"volume": NumberWithChange,
"marketCap": NumberWithChange,
"uniqueBuyersCount": NumberWithChange,
"uniqueSellersCount": NumberWithChange,
"imageUrl": "xyz789",
"isMember": true,
"members": [Collection]
}
}
}
createOrGetWalletWatchlist
Example
Query
mutation createOrGetWalletWatchlist($name: String, $walletIds: [String!]!) {
createOrGetWalletWatchlist(name: $name, walletIds: $walletIds) {
id
name
slug
isPublic
createdAt
status
isPinned
memberCount
isMember
members {
...WalletFragment
}
flips {
...FlipFragment
}
totalPortfolioValue
totalPortfolioValueByLiquidity {
...PortfolioValueFragment
}
analytics {
...WalletAnalyticsFragment
}
profitAndLossOverTime
profitSource
collectionBalanceAndFloorOverTime
positionChanges {
...WalletPositionChangeFragment
}
portfolioValueOverTime
activityChart
tokens {
...TokenFragment
}
activity {
...ActivityItemFragment
}
collections {
...WalletCollectionFragment
}
relatedWallets {
...WalletRelationFragment
}
feed {
...EventFeedItemFragment
}
}
}
Variables
{
"name": "Generated Argument example for createOrGetWalletWatchlist name",
"walletIds": [
"Generated Argument example for createOrGetWalletWatchlist walletIds"
]
}
Response
{
"data": {
"createOrGetWalletWatchlist": {
"id": 987,
"name": "abc123",
"slug": "abc123",
"isPublic": true,
"createdAt": DateTime,
"status": WatchlistStatus,
"isPinned": false,
"memberCount": 987,
"isMember": false,
"members": [Wallet],
"flips": [Flip],
"totalPortfolioValue": 987.65,
"totalPortfolioValueByLiquidity": [PortfolioValue],
"analytics": WalletAnalytics,
"profitAndLossOverTime": {},
"profitSource": {},
"collectionBalanceAndFloorOverTime": {},
"positionChanges": [WalletPositionChange],
"portfolioValueOverTime": {},
"activityChart": {},
"tokens": [Token],
"activity": [ActivityItem],
"collections": [WalletCollection],
"relatedWallets": [WalletRelation],
"feed": [EventFeedItem]
}
}
}
createWalletWatchlist
Example
Query
mutation createWalletWatchlist($name: String!) {
createWalletWatchlist(name: $name) {
id
name
slug
isPublic
createdAt
status
isPinned
memberCount
isMember
members {
...WalletFragment
}
flips {
...FlipFragment
}
totalPortfolioValue
totalPortfolioValueByLiquidity {
...PortfolioValueFragment
}
analytics {
...WalletAnalyticsFragment
}
profitAndLossOverTime
profitSource
collectionBalanceAndFloorOverTime
positionChanges {
...WalletPositionChangeFragment
}
portfolioValueOverTime
activityChart
tokens {
...TokenFragment
}
activity {
...ActivityItemFragment
}
collections {
...WalletCollectionFragment
}
relatedWallets {
...WalletRelationFragment
}
feed {
...EventFeedItemFragment
}
}
}
Variables
{
"name": "Generated Argument example for createWalletWatchlist name"
}
Response
{
"data": {
"createWalletWatchlist": {
"id": 123,
"name": "xyz789",
"slug": "abc123",
"isPublic": false,
"createdAt": DateTime,
"status": WatchlistStatus,
"isPinned": false,
"memberCount": 123,
"isMember": true,
"members": [Wallet],
"flips": [Flip],
"totalPortfolioValue": 987.65,
"totalPortfolioValueByLiquidity": [PortfolioValue],
"analytics": WalletAnalytics,
"profitAndLossOverTime": {},
"profitSource": {},
"collectionBalanceAndFloorOverTime": {},
"positionChanges": [WalletPositionChange],
"portfolioValueOverTime": {},
"activityChart": {},
"tokens": [Token],
"activity": [ActivityItem],
"collections": [WalletCollection],
"relatedWallets": [WalletRelation],
"feed": [EventFeedItem]
}
}
}
deleteAlert
Example
Query
mutation deleteAlert($id: Int!) {
deleteAlert(id: $id)
}
Variables
{"id": 987}
Response
{"data": {"deleteAlert": false}}
deleteAlertChannel
Example
Query
mutation deleteAlertChannel($id: Int!) {
deleteAlertChannel(id: $id)
}
Variables
{"id": 123}
Response
{"data": {"deleteAlertChannel": false}}
deleteWatchlist
Example
Query
mutation deleteWatchlist($id: Int!) {
deleteWatchlist(id: $id)
}
Variables
{"id": 987}
Response
{"data": {"deleteWatchlist": false}}
editWalletName
Example
Query
mutation editWalletName($name: String!, $walletId: String!) {
editWalletName(name: $name, walletId: $walletId)
}
Variables
{
"name": "Generated Argument example for editWalletName name",
"walletId": "Generated Argument example for editWalletName walletId"
}
Response
{"data": {"editWalletName": false}}
loginWithDiscord
Example
Query
mutation loginWithDiscord($code: String!) {
loginWithDiscord(code: $code) {
token
}
}
Variables
{
"code": "Generated Argument example for loginWithDiscord code"
}
Response
{"data": {"loginWithDiscord": {"token": "xyz789"}}}
openCrate
Example
Query
mutation openCrate($seedHash: String!, $tokenId: String!) {
openCrate(seedHash: $seedHash, tokenId: $tokenId) {
id
prizes
}
}
Variables
{
"seedHash": "Generated Argument example for openCrate seedHash",
"tokenId": "Generated Argument example for openCrate tokenId"
}
Response
{"data": {"openCrate": {"id": 987, "prizes": [Prize]}}}
pinWatchlist
Example
Query
mutation pinWatchlist($id: Int!) {
pinWatchlist(id: $id)
}
Variables
{"id": 123}
Response
{"data": {"pinWatchlist": false}}
refreshCollectionItems
Example
Query
mutation refreshCollectionItems($id: String!) {
refreshCollectionItems(id: $id)
}
Variables
{
"id": "Generated Argument example for refreshCollectionItems id"
}
Response
{"data": {"refreshCollectionItems": true}}
refreshCollectionMetadata
Example
Query
mutation refreshCollectionMetadata($id: String!) {
refreshCollectionMetadata(id: $id)
}
Variables
{
"id": "Generated Argument example for refreshCollectionMetadata id"
}
Response
{"data": {"refreshCollectionMetadata": true}}
refreshTokenListings
Example
Query
mutation refreshTokenListings($tokenId: String!) {
refreshTokenListings(tokenId: $tokenId) {
id
side
marketplace
makerId
takerId
collectionId
tokenId
price
status
filledAt
cancelledAt
createdAt
expiresAt
validFrom
blockNumber
blockTimestamp
metadata
token {
...TokenFragment
}
maker {
...WalletFragment
}
taker {
...WalletFragment
}
collection {
...CollectionFragment
}
pendingOrderFills {
...PendingFillFragment
}
}
}
Variables
{
"tokenId": "Generated Argument example for refreshTokenListings tokenId"
}
Response
{
"data": {
"refreshTokenListings": [
{
"id": "abc123",
"side": OrderSide,
"marketplace": 123,
"makerId": "xyz789",
"takerId": "xyz789",
"collectionId": "xyz789",
"tokenId": "xyz789",
"price": Decimal,
"status": OrderStatus,
"filledAt": DateTime,
"cancelledAt": DateTime,
"createdAt": DateTime,
"expiresAt": DateTime,
"validFrom": DateTime,
"blockNumber": 123,
"blockTimestamp": DateTime,
"metadata": {},
"token": Token,
"maker": Wallet,
"taker": Wallet,
"collection": Collection,
"pendingOrderFills": [PendingFill]
}
]
}
}
refreshTokenMetadata
Example
Query
mutation refreshTokenMetadata($tokenId: String!) {
refreshTokenMetadata(tokenId: $tokenId) {
id
collectionAddress
tokenId
ownerAddress
mintTimestamp
_count {
...TokenCountFragment
}
collection {
...CollectionFragment
}
transfers {
...TokenTransferFragment
}
attributes {
...TokenAttributeFragment
}
orders {
...OrderFragment
}
flips {
...FlipFragment
}
isReported
rarityRank
rarityScore
rarityRankNormalized
rarityScoreNormalized
image
previewImageUrl
fullImageUrl
name
description
metadata
tokenUri
price
listings {
...OrderFragment
}
owner {
...WalletFragment
}
lastSale {
...SaleFragment
}
activity {
...ActivityItemFragment
}
activityChart
eventFeed {
...EventFeedItemFragment
}
}
}
Variables
{
"tokenId": "Generated Argument example for refreshTokenMetadata tokenId"
}
Response
{
"data": {
"refreshTokenMetadata": [
{
"id": "abc123",
"collectionAddress": "xyz789",
"tokenId": "abc123",
"ownerAddress": "abc123",
"mintTimestamp": DateTime,
"_count": TokenCount,
"collection": Collection,
"transfers": [TokenTransfer],
"attributes": [TokenAttribute],
"orders": [Order],
"flips": [Flip],
"isReported": true,
"rarityRank": 123,
"rarityScore": Decimal,
"rarityRankNormalized": 123,
"rarityScoreNormalized": Decimal,
"image": "abc123",
"previewImageUrl": "abc123",
"fullImageUrl": "xyz789",
"name": "abc123",
"description": "xyz789",
"metadata": {},
"tokenUri": "abc123",
"price": 987.65,
"listings": [Order],
"owner": Wallet,
"lastSale": Sale,
"activity": [ActivityItem],
"activityChart": {},
"eventFeed": [EventFeedItem]
}
]
}
}
removeCollectionsFromWatchlist
Example
Query
mutation removeCollectionsFromWatchlist($collectionIds: [String!]!, $watchlistId: Int!) {
removeCollectionsFromWatchlist(collectionIds: $collectionIds, watchlistId: $watchlistId) {
id
name
slug
isPublic
createdAt
status
isPinned
memberCount
marketCapOverTime {
...ChartDataFragment
}
volumeOverTime {
...ChartDataFragment
}
volume {
...NumberWithChangeFragment
}
marketCap {
...NumberWithChangeFragment
}
uniqueBuyersCount {
...NumberWithChangeFragment
}
uniqueSellersCount {
...NumberWithChangeFragment
}
imageUrl
isMember
members {
...CollectionFragment
}
}
}
Variables
{
"collectionIds": [
"Generated Argument example for removeCollectionsFromWatchlist collectionIds"
],
"watchlistId": 123
}
Response
{
"data": {
"removeCollectionsFromWatchlist": {
"id": 987,
"name": "xyz789",
"slug": "xyz789",
"isPublic": false,
"createdAt": DateTime,
"status": WatchlistStatus,
"isPinned": true,
"memberCount": 987,
"marketCapOverTime": [ChartData],
"volumeOverTime": [ChartData],
"volume": NumberWithChange,
"marketCap": NumberWithChange,
"uniqueBuyersCount": NumberWithChange,
"uniqueSellersCount": NumberWithChange,
"imageUrl": "xyz789",
"isMember": true,
"members": [Collection]
}
}
}
removeWalletsFromWatchlist
Example
Query
mutation removeWalletsFromWatchlist($walletIds: [String!]!, $watchlistId: Int!) {
removeWalletsFromWatchlist(walletIds: $walletIds, watchlistId: $watchlistId) {
id
name
slug
isPublic
createdAt
status
isPinned
memberCount
isMember
members {
...WalletFragment
}
flips {
...FlipFragment
}
totalPortfolioValue
totalPortfolioValueByLiquidity {
...PortfolioValueFragment
}
analytics {
...WalletAnalyticsFragment
}
profitAndLossOverTime
profitSource
collectionBalanceAndFloorOverTime
positionChanges {
...WalletPositionChangeFragment
}
portfolioValueOverTime
activityChart
tokens {
...TokenFragment
}
activity {
...ActivityItemFragment
}
collections {
...WalletCollectionFragment
}
relatedWallets {
...WalletRelationFragment
}
feed {
...EventFeedItemFragment
}
}
}
Variables
{
"walletIds": [
"Generated Argument example for removeWalletsFromWatchlist walletIds"
],
"watchlistId": 987
}
Response
{
"data": {
"removeWalletsFromWatchlist": {
"id": 123,
"name": "xyz789",
"slug": "abc123",
"isPublic": false,
"createdAt": DateTime,
"status": WatchlistStatus,
"isPinned": false,
"memberCount": 987,
"isMember": false,
"members": [Wallet],
"flips": [Flip],
"totalPortfolioValue": 123.45,
"totalPortfolioValueByLiquidity": [PortfolioValue],
"analytics": WalletAnalytics,
"profitAndLossOverTime": {},
"profitSource": {},
"collectionBalanceAndFloorOverTime": {},
"positionChanges": [WalletPositionChange],
"portfolioValueOverTime": {},
"activityChart": {},
"tokens": [Token],
"activity": [ActivityItem],
"collections": [WalletCollection],
"relatedWallets": [WalletRelation],
"feed": [EventFeedItem]
}
}
}
reportCollection
Example
Query
mutation reportCollection($reportData: ReportDataInput!, $collectionId: String!) {
reportCollection(reportData: $reportData, collectionId: $collectionId)
}
Variables
{
"reportData": ReportDataInput,
"collectionId": "Generated Argument example for reportCollection collectionId"
}
Response
{"data": {"reportCollection": false}}
testChannel
Example
Query
mutation testChannel($id: Int!) {
testChannel(id: $id) {
id
userId
name
type
config
status
externalUserId
_count {
...ChannelCountFragment
}
}
}
Variables
{"id": 123}
Response
{
"data": {
"testChannel": {
"id": 987,
"userId": "abc123",
"name": "abc123",
"type": ChannelType,
"config": {},
"status": ChannelStatus,
"externalUserId": 123,
"_count": ChannelCount
}
}
}
toggleFavorite
Example
Query
mutation toggleFavorite($model: String!, $id: String!) {
toggleFavorite(model: $model, id: $id)
}
Variables
{
"model": "Generated Argument example for toggleFavorite model",
"id": "Generated Argument example for toggleFavorite id"
}
Response
{"data": {"toggleFavorite": true}}
unpinWatchlist
Example
Query
mutation unpinWatchlist($id: Int!) {
unpinWatchlist(id: $id)
}
Variables
{"id": 987}
Response
{"data": {"unpinWatchlist": true}}
updateAlert
Example
Query
mutation updateAlert($data: CreateAlertInput!, $id: Int!) {
updateAlert(data: $data, id: $id) {
id
userId
name
type
config
lastCheckedAt
lastEvaluatedAt
lastValue
createdAt
externalUserId
status
_count {
...AlertCountFragment
}
channels
}
}
Variables
{"data": CreateAlertInput, "id": 987}
Response
{
"data": {
"updateAlert": {
"id": 123,
"userId": "abc123",
"name": "xyz789",
"type": AlertType,
"config": {},
"lastCheckedAt": DateTime,
"lastEvaluatedAt": DateTime,
"lastValue": 987.65,
"createdAt": DateTime,
"externalUserId": 123,
"status": AlertStatus,
"_count": AlertCount,
"channels": [123]
}
}
}
updateBillingInfo
Example
Query
mutation updateBillingInfo($billingInfoData: BillingInfoInput!) {
updateBillingInfo(billingInfoData: $billingInfoData) {
id
name
addressLine1
addressLine2
city
state
zipCode
country
vatNumber
createdAt
updatedAt
address
}
}
Variables
{"billingInfoData": BillingInfoInput}
Response
{
"data": {
"updateBillingInfo": {
"id": 123,
"name": "xyz789",
"addressLine1": "xyz789",
"addressLine2": "abc123",
"city": "abc123",
"state": "xyz789",
"zipCode": "abc123",
"country": "xyz789",
"vatNumber": "abc123",
"createdAt": DateTime,
"updatedAt": DateTime,
"address": "xyz789"
}
}
}
updateCollectionWatchlist
Example
Query
mutation updateCollectionWatchlist($name: String!, $id: Int!) {
updateCollectionWatchlist(name: $name, id: $id) {
id
name
slug
isPublic
createdAt
status
isPinned
memberCount
marketCapOverTime {
...ChartDataFragment
}
volumeOverTime {
...ChartDataFragment
}
volume {
...NumberWithChangeFragment
}
marketCap {
...NumberWithChangeFragment
}
uniqueBuyersCount {
...NumberWithChangeFragment
}
uniqueSellersCount {
...NumberWithChangeFragment
}
imageUrl
isMember
members {
...CollectionFragment
}
}
}
Variables
{
"name": "Generated Argument example for updateCollectionWatchlist name",
"id": 987
}
Response
{
"data": {
"updateCollectionWatchlist": {
"id": 987,
"name": "xyz789",
"slug": "xyz789",
"isPublic": true,
"createdAt": DateTime,
"status": WatchlistStatus,
"isPinned": true,
"memberCount": 987,
"marketCapOverTime": [ChartData],
"volumeOverTime": [ChartData],
"volume": NumberWithChange,
"marketCap": NumberWithChange,
"uniqueBuyersCount": NumberWithChange,
"uniqueSellersCount": NumberWithChange,
"imageUrl": "xyz789",
"isMember": false,
"members": [Collection]
}
}
}
updateWalletWatchlist
Example
Query
mutation updateWalletWatchlist($status: WatchlistStatus, $name: String, $id: Int!) {
updateWalletWatchlist(status: $status, name: $name, id: $id) {
id
name
slug
isPublic
createdAt
status
isPinned
memberCount
isMember
members {
...WalletFragment
}
flips {
...FlipFragment
}
totalPortfolioValue
totalPortfolioValueByLiquidity {
...PortfolioValueFragment
}
analytics {
...WalletAnalyticsFragment
}
profitAndLossOverTime
profitSource
collectionBalanceAndFloorOverTime
positionChanges {
...WalletPositionChangeFragment
}
portfolioValueOverTime
activityChart
tokens {
...TokenFragment
}
activity {
...ActivityItemFragment
}
collections {
...WalletCollectionFragment
}
relatedWallets {
...WalletRelationFragment
}
feed {
...EventFeedItemFragment
}
}
}
Variables
{
"status": WatchlistStatus,
"name": "Generated Argument example for updateWalletWatchlist name",
"id": 123
}
Response
{
"data": {
"updateWalletWatchlist": {
"id": 987,
"name": "xyz789",
"slug": "abc123",
"isPublic": false,
"createdAt": DateTime,
"status": WatchlistStatus,
"isPinned": false,
"memberCount": 987,
"isMember": false,
"members": [Wallet],
"flips": [Flip],
"totalPortfolioValue": 123.45,
"totalPortfolioValueByLiquidity": [PortfolioValue],
"analytics": WalletAnalytics,
"profitAndLossOverTime": {},
"profitSource": {},
"collectionBalanceAndFloorOverTime": {},
"positionChanges": [WalletPositionChange],
"portfolioValueOverTime": {},
"activityChart": {},
"tokens": [Token],
"activity": [ActivityItem],
"collections": [WalletCollection],
"relatedWallets": [WalletRelation],
"feed": [EventFeedItem]
}
}
}
Types
ActivityItem
| Field Name | Description |
|---|---|
id -
String!
|
|
type -
ActivityType!
|
|
timestamp -
DateTime!
|
|
value -
Float
|
|
gasSpent -
Float
|
|
royalties -
Float
|
|
marketplaceFee -
Float
|
|
fromAddress -
String
|
|
toAddress -
String
|
|
collection -
Collection
|
|
transaction -
Transaction
|
|
token -
Token
|
|
sale -
Sale
|
|
listing -
Order
|
|
offer -
Order
|
|
from -
Wallet
|
|
to -
Wallet
|
|
floorDelta -
Float
|
Example
{
"id": "abc123",
"type": ActivityType,
"timestamp": DateTime,
"value": 123.45,
"gasSpent": 987.65,
"royalties": 123.45,
"marketplaceFee": 123.45,
"fromAddress": "xyz789",
"toAddress": "abc123",
"collection": Collection,
"transaction": Transaction,
"token": Token,
"sale": Sale,
"listing": Order,
"offer": Order,
"from": Wallet,
"to": Wallet,
"floorDelta": 123.45
}
Alert
| Field Name | Description |
|---|---|
id -
Int!
|
|
userId -
String
|
|
name -
String
|
The name of the alert |
type -
AlertType!
|
Type of alert |
config -
JSON
|
Configuration of the alert - raw JSON |
lastCheckedAt -
DateTime!
|
Checkpoint field used for some alert types |
lastEvaluatedAt -
DateTime
|
Timestamp of last evaluation |
lastValue -
Float
|
Last value used for reference for some alert types |
createdAt -
DateTime!
|
Timestamp of alert creation |
externalUserId -
Int!
|
|
status -
AlertStatus!
|
Current status of the alert |
_count -
AlertCount
|
|
channels -
[Int!]!
|
Example
{
"id": 123,
"userId": "abc123",
"name": "abc123",
"type": AlertType,
"config": {},
"lastCheckedAt": DateTime,
"lastEvaluatedAt": DateTime,
"lastValue": 123.45,
"createdAt": DateTime,
"externalUserId": 123,
"status": AlertStatus,
"_count": AlertCount,
"channels": [987]
}
AlertType
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Attribute
Token trait type
| Field Name | Description |
|---|---|
id -
String!
|
|
collectionId -
String!
|
|
name -
String!
|
Name of the trait |
displayType -
String
|
Display type of the trait |
_count -
AttributeCount
|
|
valueCount -
Int
|
Number of possible values for the trait |
collection -
Collection!
|
|
values -
[AttributeValue!]!
|
Possible values of the trait |
|
Arguments
|
|
tokenAttributes -
[TokenAttribute!]!
|
Tokens having this attribute |
|
Arguments
|
|
Example
{
"id": "abc123",
"collectionId": "abc123",
"name": "abc123",
"displayType": "abc123",
"_count": AttributeCount,
"valueCount": 987,
"collection": Collection,
"values": [AttributeValue],
"tokenAttributes": [TokenAttribute]
}
AttributeListRelationFilter
| Input Field | Description |
|---|---|
every -
AttributeWhereInput
|
|
some -
AttributeWhereInput
|
|
none -
AttributeWhereInput
|
Example
{
"every": AttributeWhereInput,
"some": AttributeWhereInput,
"none": AttributeWhereInput
}
AttributeOrderByRelationAggregateInput
| Input Field | Description |
|---|---|
_count -
SortOrder
|
Example
{"_count": SortOrder}
AttributeOrderByWithRelationInput
| Input Field | Description |
|---|---|
id -
SortOrder
|
|
collectionId -
SortOrder
|
|
collection -
CollectionOrderByWithRelationInput
|
|
name -
SortOrder
|
|
displayType -
SortOrder
|
|
values -
AttributeValueOrderByRelationAggregateInput
|
|
tokenAttributes -
TokenAttributeOrderByRelationAggregateInput
|
Example
{
"id": SortOrder,
"collectionId": SortOrder,
"collection": CollectionOrderByWithRelationInput,
"name": SortOrder,
"displayType": SortOrder,
"values": AttributeValueOrderByRelationAggregateInput,
"tokenAttributes": TokenAttributeOrderByRelationAggregateInput
}
AttributeRelationFilter
| Input Field | Description |
|---|---|
is -
AttributeWhereInput
|
|
isNot -
AttributeWhereInput
|
Example
{
"is": AttributeWhereInput,
"isNot": AttributeWhereInput
}
AttributeValue
Token trait value
| Field Name | Description |
|---|---|
id -
String!
|
|
attributeId -
String!
|
|
value -
String!
|
Value of token attribute |
_count -
AttributeValueCount
|
|
attribute -
Attribute!
|
|
tokenAttributes -
[TokenAttribute!]!
|
Tokens having this attribute value |
|
Arguments
|
|
sales -
AttributeValueSales
|
|
volumeChart -
[ChartData!]
|
|
tokenCount -
Int
|
Number of tokens having this trait value |
Example
{
"id": "xyz789",
"attributeId": "xyz789",
"value": "xyz789",
"_count": AttributeValueCount,
"attribute": Attribute,
"tokenAttributes": [TokenAttribute],
"sales": AttributeValueSales,
"volumeChart": [ChartData],
"tokenCount": 987
}
AttributeValueListRelationFilter
| Input Field | Description |
|---|---|
every -
AttributeValueWhereInput
|
|
some -
AttributeValueWhereInput
|
|
none -
AttributeValueWhereInput
|
Example
{
"every": AttributeValueWhereInput,
"some": AttributeValueWhereInput,
"none": AttributeValueWhereInput
}
AttributeValueOrderByRelationAggregateInput
| Input Field | Description |
|---|---|
_count -
SortOrder
|
Example
{"_count": SortOrder}
AttributeValueOrderByWithRelationInput
| Input Field | Description |
|---|---|
id -
SortOrder
|
|
attributeId -
SortOrder
|
|
attribute -
AttributeOrderByWithRelationInput
|
|
value -
SortOrder
|
|
tokenAttributes -
TokenAttributeOrderByRelationAggregateInput
|
Example
{
"id": SortOrder,
"attributeId": SortOrder,
"attribute": AttributeOrderByWithRelationInput,
"value": SortOrder,
"tokenAttributes": TokenAttributeOrderByRelationAggregateInput
}
AttributeValueRelationFilter
| Input Field | Description |
|---|---|
is -
AttributeValueWhereInput
|
|
isNot -
AttributeValueWhereInput
|
Example
{
"is": AttributeValueWhereInput,
"isNot": AttributeValueWhereInput
}
AttributeValueSales
Sale metrics for trait value
| Field Name | Description |
|---|---|
count -
Int
|
Number of sales |
uniqueTokensCount -
Int
|
Unique tokens transacted |
minPrice -
Float
|
Lowest price |
maxPrice -
Float
|
Highest price |
avgPrice -
Float
|
Average price |
volume -
Float
|
Total volume |
floorPrice -
Float
|
Floor price of trait |
Example
{
"count": 123,
"uniqueTokensCount": 987,
"minPrice": 123.45,
"maxPrice": 123.45,
"avgPrice": 123.45,
"volume": 987.65,
"floorPrice": 123.45
}
AttributeValueWhereInput
| Input Field | Description |
|---|---|
AND -
[AttributeValueWhereInput!]
|
|
OR -
[AttributeValueWhereInput!]
|
|
NOT -
[AttributeValueWhereInput!]
|
|
id -
StringFilter
|
|
attributeId -
StringFilter
|
|
attribute -
AttributeRelationFilter
|
|
value -
StringFilter
|
|
tokenAttributes -
TokenAttributeListRelationFilter
|
Example
{
"AND": [AttributeValueWhereInput],
"OR": [AttributeValueWhereInput],
"NOT": [AttributeValueWhereInput],
"id": StringFilter,
"attributeId": StringFilter,
"attribute": AttributeRelationFilter,
"value": StringFilter,
"tokenAttributes": TokenAttributeListRelationFilter
}
AttributeWhereInput
| Input Field | Description |
|---|---|
AND -
[AttributeWhereInput!]
|
|
OR -
[AttributeWhereInput!]
|
|
NOT -
[AttributeWhereInput!]
|
|
id -
StringFilter
|
|
collectionId -
StringFilter
|
|
collection -
CollectionRelationFilter
|
|
name -
StringFilter
|
|
displayType -
StringNullableFilter
|
|
values -
AttributeValueListRelationFilter
|
|
tokenAttributes -
TokenAttributeListRelationFilter
|
Example
{
"AND": [AttributeWhereInput],
"OR": [AttributeWhereInput],
"NOT": [AttributeWhereInput],
"id": StringFilter,
"collectionId": StringFilter,
"collection": CollectionRelationFilter,
"name": StringFilter,
"displayType": StringNullableFilter,
"values": AttributeValueListRelationFilter,
"tokenAttributes": TokenAttributeListRelationFilter
}
BigIntNullableFilter
| Input Field | Description |
|---|---|
equals -
BigInt
|
|
in -
[BigInt!]
|
|
notIn -
[BigInt!]
|
|
lt -
BigInt
|
|
lte -
BigInt
|
|
gt -
BigInt
|
|
gte -
BigInt
|
|
not -
NestedBigIntNullableFilter
|
Example
{
"equals": BigInt,
"in": [BigInt],
"notIn": [BigInt],
"lt": BigInt,
"lte": BigInt,
"gt": BigInt,
"gte": BigInt,
"not": NestedBigIntNullableFilter
}
BillingInfo
| Field Name | Description |
|---|---|
id -
Int!
|
|
name -
String!
|
|
addressLine1 -
String!
|
|
addressLine2 -
String
|
|
city -
String
|
|
state -
String
|
|
zipCode -
String
|
|
country -
String!
|
|
vatNumber -
String
|
|
createdAt -
DateTime!
|
|
updatedAt -
DateTime
|
|
address -
String!
|
Example
{
"id": 987,
"name": "xyz789",
"addressLine1": "abc123",
"addressLine2": "abc123",
"city": "xyz789",
"state": "xyz789",
"zipCode": "abc123",
"country": "abc123",
"vatNumber": "abc123",
"createdAt": DateTime,
"updatedAt": DateTime,
"address": "xyz789"
}
BillingInfoBaseInput
| Input Field | Description |
|---|---|
name -
String!
|
|
addressLine1 -
String!
|
|
addressLine2 -
String
|
|
city -
String!
|
|
state -
String
|
|
zipCode -
String
|
|
country -
String!
|
|
vatNumber -
String default = "" |
Example
{
"name": "xyz789",
"addressLine1": "abc123",
"addressLine2": "xyz789",
"city": "xyz789",
"state": "xyz789",
"zipCode": "abc123",
"country": "xyz789",
"vatNumber":
}
BillingInfoInput
| Input Field | Description |
|---|---|
name -
String!
|
|
addressLine1 -
String!
|
|
addressLine2 -
String
|
|
city -
String!
|
|
state -
String
|
|
zipCode -
String
|
|
country -
String!
|
|
vatNumber -
String default = "" |
|
id -
Float!
|
Example
{
"name": "xyz789",
"addressLine1": "abc123",
"addressLine2": "xyz789",
"city": "abc123",
"state": "xyz789",
"zipCode": "xyz789",
"country": "abc123",
"vatNumber": ,
"id": 123.45
}
BoolFilter
| Input Field | Description |
|---|---|
equals -
Boolean
|
|
not -
NestedBoolFilter
|
Example
{"equals": false, "not": NestedBoolFilter}
BoolNullableFilter
| Input Field | Description |
|---|---|
equals -
Boolean
|
|
not -
NestedBoolNullableFilter
|
Example
{"equals": false, "not": NestedBoolNullableFilter}
BurnEvent
| Field Name | Description |
|---|---|
id -
String!
|
|
type -
EventType!
|
|
value -
Float
|
|
timestamp -
DateTime!
|
|
transaction -
Transaction
|
|
collection -
Collection
|
|
token -
Token
|
|
wallet -
Wallet
|
Example
{
"id": "abc123",
"type": EventType,
"value": 123.45,
"timestamp": DateTime,
"transaction": Transaction,
"collection": Collection,
"token": Token,
"wallet": Wallet
}
BuyEvent
| Field Name | Description |
|---|---|
id -
String!
|
|
type -
EventType!
|
|
value -
Float
|
|
timestamp -
DateTime!
|
|
transaction -
Transaction
|
|
collection -
Collection
|
|
token -
Token
|
|
wallet -
Wallet
|
|
seller -
Wallet
|
|
sale -
Sale
|
|
flip -
Flip
|
Example
{
"id": "xyz789",
"type": EventType,
"value": 987.65,
"timestamp": DateTime,
"transaction": Transaction,
"collection": Collection,
"token": Token,
"wallet": Wallet,
"seller": Wallet,
"sale": Sale,
"flip": Flip
}
Channel
Alert notification channel
| Field Name | Description |
|---|---|
id -
Int!
|
|
userId -
String
|
|
name -
String!
|
Name of the alert notification channel |
type -
ChannelType!
|
Channel type |
config -
JSON
|
Channel configuration - raw JSON |
status -
ChannelStatus!
|
|
externalUserId -
Int!
|
|
_count -
ChannelCount
|
Example
{
"id": 123,
"userId": "xyz789",
"name": "xyz789",
"type": ChannelType,
"config": {},
"status": ChannelStatus,
"externalUserId": 987,
"_count": ChannelCount
}
ChannelCreateInput
| Input Field | Description |
|---|---|
name -
String!
|
|
type -
ChannelType!
|
|
config -
JSON
|
|
status -
ChannelStatus
|
Example
{
"name": "abc123",
"type": ChannelType,
"config": {},
"status": ChannelStatus
}
ChannelType
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Checkout
| Field Name | Description |
|---|---|
id -
Int!
|
|
paymentAddress -
String!
|
|
status -
CheckoutStatus!
|
|
planId -
String!
|
|
value -
Float!
|
|
paidAt -
DateTime
|
|
createdAt -
DateTime!
|
|
updatedAt -
DateTime!
|
|
billingInfo -
BillingInfo
|
Example
{
"id": 987,
"paymentAddress": "xyz789",
"status": CheckoutStatus,
"planId": "xyz789",
"value": 987.65,
"paidAt": DateTime,
"createdAt": DateTime,
"updatedAt": DateTime,
"billingInfo": BillingInfo
}
ClaimablePrize
| Field Name | Description |
|---|---|
id -
Int!
|
|
isClaimed -
Boolean!
|
|
type -
PrizeType!
|
|
prize -
SinglePrize!
|
Example
{
"id": 123,
"isClaimed": false,
"type": PrizeType,
"prize": SinglePrize
}
Collection
Model representing an NFT collection
| Field Name | Description |
|---|---|
id -
String!
|
ID of the collection (contract address) |
type -
String!
|
Type of the collection. Currently either erc721 or erc1155 |
isVerified -
Boolean!
|
Flag that indicates if the collection is verified on OpenSea |
isRevealed -
Boolean!
|
Flag that indicates if the collection is revealed |
revealsAt -
DateTime
|
Expected timestamp reveal |
revealedAt -
DateTime
|
Timestamp of reveal |
name -
String
|
Name of the collection |
symbol -
String
|
Contract symbol |
maxSupply -
Int
|
Maximum supply allowed by contract. This is not the same as total supply. |
slug -
String
|
The OpenSea URL slug of the collection |
imageUrl -
String
|
Avatar of collection |
bannerImageUrl -
String
|
Cover image of collection |
description -
String
|
Short description of the collection |
discordUrl -
String
|
Invite link to the Discord guild of the collection |
contractCreatedTimestamp -
DateTime
|
Timestamp of contract deployment |
externalUrl -
String
|
Website URL |
telegramUrl -
String
|
|
mediumUsername -
String
|
|
twitterUsername -
String
|
|
instagramUsername -
String
|
|
devFeeBasisPoints -
Int
|
Royalties set by the project owner (in basis points) |
openseaFeeBasisPoints -
Int
|
Fees Opensea collects for this collection |
updatedAt -
DateTime
|
|
orderbookSyncedAt -
DateTime
|
|
_count -
CollectionCount
|
|
charts -
CollectionCharts!
|
|
listingsChart -
JSON
|
|
|
Arguments
|
|
listingsOverTime -
JSON
|
|
transactionsChart -
JSON
|
|
|
Arguments
|
|
metrics -
CollectionMetrics!
|
|
|
Arguments
|
|
previousMetrics -
CollectionMetrics!
|
|
|
Arguments
|
|
salesFloor -
Float
|
|
previousSalesFloor -
Float
|
|
isRefreshingTokenMetadata -
Boolean!
|
|
totalSupply -
Int!
|
Total number of active minted tokens |
mintMetrics -
MintingCollectionWithChart
|
|
minters -
[CollectionMinter!]!
|
List of wallets that minted the collection |
revealProgress -
Float!
|
|
isSyncingOrders -
Boolean!
|
Flag that indicates if the initial orderbook sync is currently running |
totalTokensListed -
Int
|
Total number of tokens listed |
listedFloor -
Float
|
The floor price of the collection. Price of the lowest active listing |
topOffer -
Float
|
The price of the best collection offer |
previousListedFloor -
Float
|
Previous day floor price of the collection. |
tokensListedPastDay -
Int
|
Number of tokens listed in the past 24 hours |
tokens -
[Token!]!
|
List of tokens in the collection |
listingEvents -
[CollectionListingEvent!]!
|
Listing events |
saleEvents -
[CollectionActivityEvent!]!
|
Sale events |
totalVolume -
Float!
|
Total lifetime volume of the collection across all supported marketplaces |
totalProfits -
Float!
|
|
|
Arguments
|
|
liquidityRank -
LiquidityRank!
|
|
activity -
[ActivityItem!]!
|
|
|
Arguments
|
|
tokensV2 -
[Token!]!
|
|
floorPriceChart -
JSON!
|
|
|
Arguments
|
|
orderbookDepth -
JSON!
|
|
|
Arguments
|
|
tokenTransfers -
[TokenTransfer!]!
|
Token transfers involing tokens of collection |
|
Arguments
|
|
attributes -
[Attribute!]!
|
Trait types the collection has |
|
Arguments
|
|
orders -
[Order!]!
|
|
|
Arguments
|
|
sales -
[Sale!]!
|
|
|
Arguments
|
|
profitLeaderboard -
[ProfitLeader!]!
|
|
|
Arguments
|
|
socialMetricsLastUpdatedAt -
DateTime!
|
Last time the data was updated |
twitterMetrics -
[TwitterMetrics]
|
List of Twitter metrics for this collection |
discordMetrics -
[DiscordMetrics]
|
List of Discord metrics for this collection |
tweets -
[TweetMention]
|
List of Tweets mentioning this collection |
followedBy -
[FollowedBy]
|
List of users following this collection |
isReportedByUser -
Boolean!
|
|
isReported -
Boolean!
|
|
reportReason -
ReportReason
|
|
isPremiumRequired -
Boolean!
|
If false most collection has all metrics unlocked with no delays |
Example
{
"id": "xyz789",
"type": "abc123",
"isVerified": false,
"isRevealed": false,
"revealsAt": DateTime,
"revealedAt": DateTime,
"name": "abc123",
"symbol": "abc123",
"maxSupply": 123,
"slug": "xyz789",
"imageUrl": "abc123",
"bannerImageUrl": "xyz789",
"description": "xyz789",
"discordUrl": "xyz789",
"contractCreatedTimestamp": DateTime,
"externalUrl": "xyz789",
"telegramUrl": "xyz789",
"mediumUsername": "xyz789",
"twitterUsername": "abc123",
"instagramUsername": "abc123",
"devFeeBasisPoints": 987,
"openseaFeeBasisPoints": 987,
"updatedAt": DateTime,
"orderbookSyncedAt": DateTime,
"_count": CollectionCount,
"charts": CollectionCharts,
"listingsChart": {},
"listingsOverTime": {},
"transactionsChart": {},
"metrics": CollectionMetrics,
"previousMetrics": CollectionMetrics,
"salesFloor": 987.65,
"previousSalesFloor": 123.45,
"isRefreshingTokenMetadata": true,
"totalSupply": 987,
"mintMetrics": MintingCollectionWithChart,
"minters": [CollectionMinter],
"revealProgress": 123.45,
"isSyncingOrders": true,
"totalTokensListed": 987,
"listedFloor": 123.45,
"topOffer": 123.45,
"previousListedFloor": 123.45,
"tokensListedPastDay": 123,
"tokens": [Token],
"listingEvents": [CollectionListingEvent],
"saleEvents": [CollectionActivityEvent],
"totalVolume": 123.45,
"totalProfits": 987.65,
"liquidityRank": LiquidityRank,
"activity": [ActivityItem],
"tokensV2": [Token],
"floorPriceChart": {},
"orderbookDepth": {},
"tokenTransfers": [TokenTransfer],
"attributes": [Attribute],
"orders": [Order],
"sales": [Sale],
"profitLeaderboard": [ProfitLeader],
"socialMetricsLastUpdatedAt": DateTime,
"twitterMetrics": [TwitterMetrics],
"discordMetrics": [DiscordMetrics],
"tweets": [TweetMention],
"followedBy": [FollowedBy],
"isReportedByUser": false,
"isReported": true,
"reportReason": ReportReason,
"isPremiumRequired": false
}
CollectionActivityEvent
Activity event model (sale or listing)
| Field Name | Description |
|---|---|
timestamp -
DateTime!
|
Event timestamp |
type -
CollectionActivityEventType!
|
Type of event |
tokenId -
String
|
Internal unique token ID |
token -
Token
|
|
value -
Float!
|
Event value (sale/listing price) |
marketplace -
Int!
|
Marketplace where this event happened |
saleType -
SaleType
|
|
listingType -
ListingType
|
Example
{
"timestamp": DateTime,
"type": CollectionActivityEventType,
"tokenId": "abc123",
"token": Token,
"value": 123.45,
"marketplace": 987,
"saleType": SaleType,
"listingType": ListingType
}
CollectionHolders
| Field Name | Description |
|---|---|
wallets -
[WalletBalance!]!
|
|
count -
Int!
|
|
bluechipHoldersCount -
Int!
|
|
avgBalance -
Float
|
|
singleTokenWalletCount -
Int
|
Example
{
"wallets": [WalletBalance],
"count": 123,
"bluechipHoldersCount": 987,
"avgBalance": 987.65,
"singleTokenWalletCount": 987
}
CollectionListingEvent
Listing event model
| Field Name | Description |
|---|---|
timestamp -
DateTime!
|
Event timestamp |
type -
CollectionActivityEventType!
|
Type of event |
tokenId -
String
|
Internal unique token ID |
token -
Token
|
|
value -
Float!
|
Event value (sale/listing price) |
marketplace -
Int!
|
Marketplace where this event happened |
saleType -
SaleType
|
|
listingType -
ListingType
|
|
orderHash -
String!
|
|
pendingOrderFills -
[PendingFill!]!
|
Query pending token sale transactions |
Example
{
"timestamp": DateTime,
"type": CollectionActivityEventType,
"tokenId": "xyz789",
"token": Token,
"value": 987.65,
"marketplace": 123,
"saleType": SaleType,
"listingType": ListingType,
"orderHash": "xyz789",
"pendingOrderFills": [PendingFill]
}
CollectionOrderByWithRelationInput
| Input Field | Description |
|---|---|
id -
SortOrder
|
|
isERC721 -
SortOrder
|
|
tokens -
TokenOrderByRelationAggregateInput
|
|
tokenTransfers -
TokenTransferOrderByRelationAggregateInput
|
|
type -
SortOrder
|
|
isVerified -
SortOrder
|
|
isRevealed -
SortOrder
|
|
revealsAt -
SortOrder
|
|
revealedAt -
SortOrder
|
|
name -
SortOrder
|
|
symbol -
SortOrder
|
|
maxSupply -
SortOrder
|
|
slug -
SortOrder
|
|
imageUrl -
SortOrder
|
|
bannerImageUrl -
SortOrder
|
|
description -
SortOrder
|
|
discordUrl -
SortOrder
|
|
contractCreatedTimestamp -
SortOrder
|
|
externalUrl -
SortOrder
|
|
telegramUrl -
SortOrder
|
|
mediumUsername -
SortOrder
|
|
twitterUsername -
SortOrder
|
|
instagramUsername -
SortOrder
|
|
devFeeBasisPoints -
SortOrder
|
|
openseaFeeBasisPoints -
SortOrder
|
|
updatedAt -
SortOrder
|
|
orderbookSyncedAt -
SortOrder
|
|
attributes -
AttributeOrderByRelationAggregateInput
|
|
orders -
OrderOrderByRelationAggregateInput
|
|
sales -
SaleOrderByRelationAggregateInput
|
|
flips -
FlipOrderByRelationAggregateInput
|
Example
{
"id": SortOrder,
"isERC721": SortOrder,
"tokens": TokenOrderByRelationAggregateInput,
"tokenTransfers": TokenTransferOrderByRelationAggregateInput,
"type": SortOrder,
"isVerified": SortOrder,
"isRevealed": SortOrder,
"revealsAt": SortOrder,
"revealedAt": SortOrder,
"name": SortOrder,
"symbol": SortOrder,
"maxSupply": SortOrder,
"slug": SortOrder,
"imageUrl": SortOrder,
"bannerImageUrl": SortOrder,
"description": SortOrder,
"discordUrl": SortOrder,
"contractCreatedTimestamp": SortOrder,
"externalUrl": SortOrder,
"telegramUrl": SortOrder,
"mediumUsername": SortOrder,
"twitterUsername": SortOrder,
"instagramUsername": SortOrder,
"devFeeBasisPoints": SortOrder,
"openseaFeeBasisPoints": SortOrder,
"updatedAt": SortOrder,
"orderbookSyncedAt": SortOrder,
"attributes": AttributeOrderByRelationAggregateInput,
"orders": OrderOrderByRelationAggregateInput,
"sales": SaleOrderByRelationAggregateInput,
"flips": FlipOrderByRelationAggregateInput
}
CollectionRelationFilter
| Input Field | Description |
|---|---|
is -
CollectionWhereInput
|
|
isNot -
CollectionWhereInput
|
Example
{
"is": CollectionWhereInput,
"isNot": CollectionWhereInput
}
CollectionScalarFieldEnum
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
CollectionWatchlist
| Field Name | Description |
|---|---|
id -
Int!
|
|
name -
String!
|
|
slug -
String!
|
|
isPublic -
Boolean!
|
|
createdAt -
DateTime!
|
|
status -
WatchlistStatus!
|
|
isPinned -
Boolean!
|
|
memberCount -
Int!
|
|
marketCapOverTime -
[ChartData!]!
|
|
|
Arguments
|
|
volumeOverTime -
[ChartData!]!
|
|
|
Arguments
|
|
volume -
NumberWithChange!
|
|
|
Arguments
|
|
marketCap -
NumberWithChange!
|
|
|
Arguments
|
|
uniqueBuyersCount -
NumberWithChange!
|
|
|
Arguments
|
|
uniqueSellersCount -
NumberWithChange!
|
|
|
Arguments
|
|
imageUrl -
String!
|
|
isMember -
Boolean!
|
|
|
Arguments
|
|
members -
[Collection!]!
|
|
Example
{
"id": 123,
"name": "abc123",
"slug": "xyz789",
"isPublic": true,
"createdAt": DateTime,
"status": WatchlistStatus,
"isPinned": true,
"memberCount": 987,
"marketCapOverTime": [ChartData],
"volumeOverTime": [ChartData],
"volume": NumberWithChange,
"marketCap": NumberWithChange,
"uniqueBuyersCount": NumberWithChange,
"uniqueSellersCount": NumberWithChange,
"imageUrl": "abc123",
"isMember": false,
"members": [Collection]
}
CollectionWhereInput
Example
{
"AND": [CollectionWhereInput],
"OR": [CollectionWhereInput],
"NOT": [CollectionWhereInput],
"id": StringFilter,
"isERC721": BoolNullableFilter,
"tokens": TokenListRelationFilter,
"tokenTransfers": TokenTransferListRelationFilter,
"type": StringFilter,
"isVerified": BoolFilter,
"isRevealed": BoolFilter,
"revealsAt": DateTimeNullableFilter,
"revealedAt": DateTimeNullableFilter,
"name": StringNullableFilter,
"symbol": StringNullableFilter,
"maxSupply": IntNullableFilter,
"slug": StringNullableFilter,
"imageUrl": StringNullableFilter,
"bannerImageUrl": StringNullableFilter,
"description": StringNullableFilter,
"discordUrl": StringNullableFilter,
"contractCreatedTimestamp": DateTimeNullableFilter,
"externalUrl": StringNullableFilter,
"telegramUrl": StringNullableFilter,
"mediumUsername": StringNullableFilter,
"twitterUsername": StringNullableFilter,
"instagramUsername": StringNullableFilter,
"devFeeBasisPoints": IntNullableFilter,
"openseaFeeBasisPoints": IntNullableFilter,
"updatedAt": DateTimeNullableFilter,
"orderbookSyncedAt": DateTimeNullableFilter,
"attributes": AttributeListRelationFilter,
"orders": OrderListRelationFilter,
"sales": SaleListRelationFilter,
"flips": FlipListRelationFilter
}
CollectionWithStats
| Field Name | Description |
|---|---|
id -
String!
|
|
collection -
Collection!
|
|
volume -
Float
|
|
salesCount -
Int
|
|
avgPrice -
Float
|
|
minPrice -
Float
|
|
maxPrice -
Float
|
|
medianPrice -
Float
|
|
previous -
CollectionWithStats
|
Example
{
"id": "xyz789",
"collection": Collection,
"volume": 123.45,
"salesCount": 123,
"avgPrice": 987.65,
"minPrice": 123.45,
"maxPrice": 123.45,
"medianPrice": 987.65,
"previous": CollectionWithStats
}
CreateAlertInput
| Input Field | Description |
|---|---|
name -
String!
|
|
type -
AlertType!
|
|
config -
JSON
|
|
channels -
[Int!]!
|
Example
{
"name": "abc123",
"type": AlertType,
"config": {},
"channels": [42]
}
DateTime
The javascript Date as string. Type represents date and time as the ISO Date string.
Example
"2016-10-07T01:08:03.420Z"
DateTimeFilter
| Input Field | Description |
|---|---|
equals -
DateTime
|
|
in -
[DateTime!]
|
|
notIn -
[DateTime!]
|
|
lt -
DateTime
|
|
lte -
DateTime
|
|
gt -
DateTime
|
|
gte -
DateTime
|
|
not -
NestedDateTimeFilter
|
Example
{
"equals": DateTime,
"in": [DateTime],
"notIn": [DateTime],
"lt": DateTime,
"lte": DateTime,
"gt": DateTime,
"gte": DateTime,
"not": NestedDateTimeFilter
}
DateTimeNullableFilter
| Input Field | Description |
|---|---|
equals -
DateTime
|
|
in -
[DateTime!]
|
|
notIn -
[DateTime!]
|
|
lt -
DateTime
|
|
lte -
DateTime
|
|
gt -
DateTime
|
|
gte -
DateTime
|
|
not -
NestedDateTimeNullableFilter
|
Example
{
"equals": DateTime,
"in": [DateTime],
"notIn": [DateTime],
"lt": DateTime,
"lte": DateTime,
"gt": DateTime,
"gte": DateTime,
"not": NestedDateTimeNullableFilter
}
Decimal
GraphQL Scalar representing the Prisma.Decimal type, based on Decimal.js library.
Example
object
DecimalFilter
| Input Field | Description |
|---|---|
equals -
Decimal
|
|
in -
[Decimal!]
|
|
notIn -
[Decimal!]
|
|
lt -
Decimal
|
|
lte -
Decimal
|
|
gt -
Decimal
|
|
gte -
Decimal
|
|
not -
NestedDecimalFilter
|
Example
{
"equals": Decimal,
"in": [Decimal],
"notIn": [Decimal],
"lt": Decimal,
"lte": Decimal,
"gt": Decimal,
"gte": Decimal,
"not": NestedDecimalFilter
}
DecimalNullableFilter
| Input Field | Description |
|---|---|
equals -
Decimal
|
|
in -
[Decimal!]
|
|
notIn -
[Decimal!]
|
|
lt -
Decimal
|
|
lte -
Decimal
|
|
gt -
Decimal
|
|
gte -
Decimal
|
|
not -
NestedDecimalNullableFilter
|
Example
{
"equals": Decimal,
"in": [Decimal],
"notIn": [Decimal],
"lt": Decimal,
"lte": Decimal,
"gt": Decimal,
"gte": Decimal,
"not": NestedDecimalNullableFilter
}
DiscordMetrics
Discord metrics for given NFT collection
| Field Name | Description |
|---|---|
id -
ID!
|
id of the entry in DB |
code -
String!
|
Discord Server(GUILD) Invite code |
memberCount -
Int!
|
Aproximate Discord Server members count |
presenceCount -
Int!
|
Aproximate Discord Server active members count |
timestamp -
DateTime!
|
Time of data |
Example
{
"id": ID,
"code": "abc123",
"memberCount": 987,
"presenceCount": 123,
"timestamp": DateTime
}
Draw
| Field Name | Description |
|---|---|
id -
Int!
|
|
seedHash -
String!
|
|
isActive -
Boolean!
|
|
startsAt -
DateTime!
|
|
endsAt -
DateTime!
|
|
coinPrizes -
[CoinPrize!]!
|
|
whitelistPrizes -
[WhitelistCollectionPrize!]!
|
|
tokenPrizes -
[TokenPrize!]!
|
|
prizesWon -
[ClaimablePrize!]
|
|
entries -
[Entry!]
|
Example
{
"id": 123,
"seedHash": "xyz789",
"isActive": false,
"startsAt": DateTime,
"endsAt": DateTime,
"coinPrizes": [CoinPrize],
"whitelistPrizes": [WhitelistCollectionPrize],
"tokenPrizes": [TokenPrize],
"prizesWon": [ClaimablePrize],
"entries": [Entry]
}
EnumOrderSideFilter
| Input Field | Description |
|---|---|
equals -
OrderSide
|
|
in -
[OrderSide!]
|
|
notIn -
[OrderSide!]
|
|
not -
NestedEnumOrderSideFilter
|
Example
{
"equals": OrderSide,
"in": [OrderSide],
"notIn": [OrderSide],
"not": NestedEnumOrderSideFilter
}
EnumOrderStatusFilter
| Input Field | Description |
|---|---|
equals -
OrderStatus
|
|
in -
[OrderStatus!]
|
|
notIn -
[OrderStatus!]
|
|
not -
NestedEnumOrderStatusFilter
|
Example
{
"equals": OrderStatus,
"in": [OrderStatus],
"notIn": [OrderStatus],
"not": NestedEnumOrderStatusFilter
}
EventFeedItem
| Field Name | Description |
|---|---|
id -
String!
|
|
type -
EventType!
|
|
timestamp -
DateTime!
|
|
value -
Float
|
|
wallet -
Wallet
|
|
collection -
Collection
|
|
transaction -
Transaction
|
|
tokenCount -
Int
|
|
events -
[Event!]!
|
Example
{
"id": "abc123",
"type": EventType,
"timestamp": DateTime,
"value": 987.65,
"wallet": Wallet,
"collection": Collection,
"transaction": Transaction,
"tokenCount": 123,
"events": [Event]
}
FilterArg
| Input Field | Description |
|---|---|
key -
String
|
Key of field that is being filtered |
value -
JSON
|
Value of filter |
type -
FilterType
|
Type of filter |
Example
{
"key": "abc123",
"value": {},
"type": FilterType
}
FilterType
Type of filter
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Flip
| Field Name | Description |
|---|---|
id -
String!
|
|
marketplace -
Int!
|
|
collectionId -
String!
|
|
tokenId -
String!
|
|
walletId -
String!
|
|
soldFor -
Decimal
|
|
soldAt -
DateTime
|
|
saleGasPaid -
Decimal
|
|
rank -
BigInt
|
|
marketplaceFee -
Decimal
|
|
saleRoyalties -
Decimal
|
|
purchaseType -
String
|
|
purchasedFor -
Decimal
|
|
purchasedAt -
DateTime
|
|
heldFor -
Int!
|
|
purchaseGasPaid -
Decimal
|
|
netProfit -
Decimal
|
|
saleType -
String
|
|
collection -
Collection!
|
|
token -
Token!
|
|
wallet -
Wallet!
|
Example
{
"id": "abc123",
"marketplace": 987,
"collectionId": "abc123",
"tokenId": "abc123",
"walletId": "abc123",
"soldFor": Decimal,
"soldAt": DateTime,
"saleGasPaid": Decimal,
"rank": BigInt,
"marketplaceFee": Decimal,
"saleRoyalties": Decimal,
"purchaseType": "abc123",
"purchasedFor": Decimal,
"purchasedAt": DateTime,
"heldFor": 123,
"purchaseGasPaid": Decimal,
"netProfit": Decimal,
"saleType": "xyz789",
"collection": Collection,
"token": Token,
"wallet": Wallet
}
FlipListRelationFilter
| Input Field | Description |
|---|---|
every -
FlipWhereInput
|
|
some -
FlipWhereInput
|
|
none -
FlipWhereInput
|
Example
{
"every": FlipWhereInput,
"some": FlipWhereInput,
"none": FlipWhereInput
}
FlipOrderByRelationAggregateInput
| Input Field | Description |
|---|---|
_count -
SortOrder
|
Example
{"_count": SortOrder}
FlipOrderByWithRelationInput
| Input Field | Description |
|---|---|
id -
SortOrder
|
|
marketplace -
SortOrder
|
|
collectionId -
SortOrder
|
|
collection -
CollectionOrderByWithRelationInput
|
|
tokenId -
SortOrder
|
|
token -
TokenOrderByWithRelationInput
|
|
walletId -
SortOrder
|
|
wallet -
WalletOrderByWithRelationInput
|
|
soldFor -
SortOrder
|
|
soldAt -
SortOrder
|
|
saleGasPaid -
SortOrder
|
|
rank -
SortOrder
|
|
marketplaceFee -
SortOrder
|
|
saleRoyalties -
SortOrder
|
|
purchaseType -
SortOrder
|
|
purchasedFor -
SortOrder
|
|
purchasedAt -
SortOrder
|
|
heldFor -
SortOrder
|
|
purchaseGasPaid -
SortOrder
|
|
netProfit -
SortOrder
|
|
saleType -
SortOrder
|
Example
{
"id": SortOrder,
"marketplace": SortOrder,
"collectionId": SortOrder,
"collection": CollectionOrderByWithRelationInput,
"tokenId": SortOrder,
"token": TokenOrderByWithRelationInput,
"walletId": SortOrder,
"wallet": WalletOrderByWithRelationInput,
"soldFor": SortOrder,
"soldAt": SortOrder,
"saleGasPaid": SortOrder,
"rank": SortOrder,
"marketplaceFee": SortOrder,
"saleRoyalties": SortOrder,
"purchaseType": SortOrder,
"purchasedFor": SortOrder,
"purchasedAt": SortOrder,
"heldFor": SortOrder,
"purchaseGasPaid": SortOrder,
"netProfit": SortOrder,
"saleType": SortOrder
}
FlipScalarFieldEnum
| Enum Value | Description |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
FlipWhereInput
| Input Field | Description |
|---|---|
AND -
[FlipWhereInput!]
|
|
OR -
[FlipWhereInput!]
|
|
NOT -
[FlipWhereInput!]
|
|
id -
StringFilter
|
|
marketplace -
IntFilter
|
|
collectionId -
StringFilter
|
|
collection -
CollectionRelationFilter
|
|
tokenId -
StringFilter
|
|
token -
TokenRelationFilter
|
|
walletId -
StringFilter
|
|
wallet -
WalletRelationFilter
|
|
soldFor -
DecimalNullableFilter
|
|
soldAt -
DateTimeNullableFilter
|
|
saleGasPaid -
DecimalNullableFilter
|
|
rank -
BigIntNullableFilter
|
|
marketplaceFee -
DecimalNullableFilter
|
|
saleRoyalties -
DecimalNullableFilter
|
|
purchaseType -
StringNullableFilter
|
|
purchasedFor -
DecimalNullableFilter
|
|
purchasedAt -
DateTimeNullableFilter
|
|
heldFor -
IntFilter
|
|
purchaseGasPaid -
DecimalNullableFilter
|
|
netProfit -
DecimalNullableFilter
|
|
saleType -
StringNullableFilter
|
Example
{
"AND": [FlipWhereInput],
"OR": [FlipWhereInput],
"NOT": [FlipWhereInput],
"id": StringFilter,
"marketplace": IntFilter,
"collectionId": StringFilter,
"collection": CollectionRelationFilter,
"tokenId": StringFilter,
"token": TokenRelationFilter,
"walletId": StringFilter,
"wallet": WalletRelationFilter,
"soldFor": DecimalNullableFilter,
"soldAt": DateTimeNullableFilter,
"saleGasPaid": DecimalNullableFilter,
"rank": BigIntNullableFilter,
"marketplaceFee": DecimalNullableFilter,
"saleRoyalties": DecimalNullableFilter,
"purchaseType": StringNullableFilter,
"purchasedFor": DecimalNullableFilter,
"purchasedAt": DateTimeNullableFilter,
"heldFor": IntFilter,
"purchaseGasPaid": DecimalNullableFilter,
"netProfit": DecimalNullableFilter,
"saleType": StringNullableFilter
}
Float
The Float scalar type represents signed double-precision fractional values as specified by
IEEE 754.
Example
123.45
FollowedBy
User that is followed
| Field Name | Description |
|---|---|
id -
ID!
|
id of the entry in DB |
twitterId -
String!
|
Twitter API unique identifier of the account |
followedById -
String!
|
Twitter API account unique identifier of the account who follows this |
followedBy -
NotableUser!
|
Notable user that follows this twitter account |
timestamp -
DateTime!
|
Time of data |
Example
{
"id": ID,
"twitterId": "xyz789",
"followedById": "abc123",
"followedBy": NotableUser,
"timestamp": DateTime
}
FollowedUser
User that is followed
| Field Name | Description |
|---|---|
id -
ID!
|
id of the entry in DB |
twitterId -
String!
|
Twitter API unique identifier of the account |
username -
String!
|
Twitter API account username |
followedByUsername -
String!
|
Twitter API account username |
followedBy -
String!
|
Twitter API account unique identifier of the account who follows this |
timestamp -
DateTime!
|
Time of data |
Example
{
"id": ID,
"twitterId": "abc123",
"username": "abc123",
"followedByUsername": "abc123",
"followedBy": "xyz789",
"timestamp": DateTime
}
ID
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
object
Int
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
Example
42
JsonNullableFilter
| Input Field | Description |
|---|---|
equals -
JSON
|
|
path -
[String!]
|
|
string_contains -
String
|
|
string_starts_with -
String
|
|
string_ends_with -
String
|
|
array_contains -
JSON
|
|
array_starts_with -
JSON
|
|
array_ends_with -
JSON
|
|
lt -
JSON
|
|
lte -
JSON
|
|
gt -
JSON
|
|
gte -
JSON
|
|
not -
JSON
|
Example
{
"equals": {},
"path": ["abc123"],
"string_contains": "abc123",
"string_starts_with": "abc123",
"string_ends_with": "abc123",
"array_contains": {},
"array_starts_with": {},
"array_ends_with": {},
"lt": {},
"lte": {},
"gt": {},
"gte": {},
"not": {}
}
ListEvent
| Field Name | Description |
|---|---|
id -
String!
|
|
type -
EventType!
|
|
value -
Float
|
|
timestamp -
DateTime!
|
|
transaction -
Transaction
|
|
collection -
Collection
|
|
token -
Token
|
|
wallet -
Wallet
|
|
listing -
Order
|
Example
{
"id": "xyz789",
"type": EventType,
"value": 987.65,
"timestamp": DateTime,
"transaction": Transaction,
"collection": Collection,
"token": Token,
"wallet": Wallet,
"listing": Order
}
MintEvent
| Field Name | Description |
|---|---|
id -
String!
|
|
type -
EventType!
|
|
value -
Float
|
|
timestamp -
DateTime!
|
|
transaction -
Transaction
|
|
collection -
Collection
|
|
token -
Token
|
|
wallet -
Wallet
|
Example
{
"id": "xyz789",
"type": EventType,
"value": 123.45,
"timestamp": DateTime,
"transaction": Transaction,
"collection": Collection,
"token": Token,
"wallet": Wallet
}
MintingCollection
| Field Name | Description |
|---|---|
id -
String!
|
|
collection -
Collection!
|
|
mintCount -
Int!
|
|
firstMintTimestamp -
String
|
|
lastMintTimestamp -
String
|
|
uniqueMintersCount -
Int!
|
|
avgPrice -
Float!
|
|
avgGas -
Float!
|
|
mintsPerHour -
Float
|
|
totalValue -
Float!
|
|
isNewMint -
Boolean!
|
Example
{
"id": "abc123",
"collection": Collection,
"mintCount": 987,
"firstMintTimestamp": "xyz789",
"lastMintTimestamp": "xyz789",
"uniqueMintersCount": 123,
"avgPrice": 987.65,
"avgGas": 987.65,
"mintsPerHour": 987.65,
"totalValue": 123.45,
"isNewMint": false
}
MintingCollectionWithChart
| Field Name | Description |
|---|---|
id -
String!
|
|
collection -
Collection!
|
|
firstMintTimestamp -
String
|
|
lastMintTimestamp -
String
|
|
totalValue -
Float!
|
|
mintCount -
Int!
|
|
uniqueMintersCount -
Int!
|
|
medianTokensPerTransaction -
Int!
|
|
avgGas -
Float!
|
|
avgPrice -
Float!
|
|
isNewMint -
Boolean!
|
|
mintsPerHour -
Float!
|
|
mintPrice -
Float
|
|
mintRateChart -
[ChartData!]
|
Number of mints over time |
avgGasChart -
[ChartData!]
|
Average gas spent for minting over time |
Example
{
"id": "abc123",
"collection": Collection,
"firstMintTimestamp": "xyz789",
"lastMintTimestamp": "xyz789",
"totalValue": 987.65,
"mintCount": 987,
"uniqueMintersCount": 123,
"medianTokensPerTransaction": 987,
"avgGas": 987.65,
"avgPrice": 987.65,
"isNewMint": false,
"mintsPerHour": 987.65,
"mintPrice": 123.45,
"mintRateChart": [ChartData],
"avgGasChart": [ChartData]
}
NestedBigIntNullableFilter
| Input Field | Description |
|---|---|
equals -
BigInt
|
|
in -
[BigInt!]
|
|
notIn -
[BigInt!]
|
|
lt -
BigInt
|
|
lte -
BigInt
|
|
gt -
BigInt
|
|
gte -
BigInt
|
|
not -
NestedBigIntNullableFilter
|
Example
{
"equals": BigInt,
"in": [BigInt],
"notIn": [BigInt],
"lt": BigInt,
"lte": BigInt,
"gt": BigInt,
"gte": BigInt,
"not": NestedBigIntNullableFilter
}
NestedBoolFilter
| Input Field | Description |
|---|---|
equals -
Boolean
|
|
not -
NestedBoolFilter
|
Example
{"equals": false, "not": NestedBoolFilter}
NestedBoolNullableFilter
| Input Field | Description |
|---|---|
equals -
Boolean
|
|
not -
NestedBoolNullableFilter
|
Example
{"equals": true, "not": NestedBoolNullableFilter}
NestedDateTimeFilter
| Input Field | Description |
|---|---|
equals -
DateTime
|
|
in -
[DateTime!]
|
|
notIn -
[DateTime!]
|
|
lt -
DateTime
|
|
lte -
DateTime
|
|
gt -
DateTime
|
|
gte -
DateTime
|
|
not -
NestedDateTimeFilter
|
Example
{
"equals": DateTime,
"in": [DateTime],
"notIn": [DateTime],
"lt": DateTime,
"lte": DateTime,
"gt": DateTime,
"gte": DateTime,
"not": NestedDateTimeFilter
}
NestedDateTimeNullableFilter
| Input Field | Description |
|---|---|
equals -
DateTime
|
|
in -
[DateTime!]
|
|
notIn -
[DateTime!]
|
|
lt -
DateTime
|
|
lte -
DateTime
|
|
gt -
DateTime
|
|
gte -
DateTime
|
|
not -
NestedDateTimeNullableFilter
|
Example
{
"equals": DateTime,
"in": [DateTime],
"notIn": [DateTime],
"lt": DateTime,
"lte": DateTime,
"gt": DateTime,
"gte": DateTime,
"not": NestedDateTimeNullableFilter
}
NestedDecimalFilter
| Input Field | Description |
|---|---|
equals -
Decimal
|
|
in -
[Decimal!]
|
|
notIn -
[Decimal!]
|
|
lt -
Decimal
|
|
lte -
Decimal
|
|
gt -
Decimal
|
|
gte -
Decimal
|
|
not -
NestedDecimalFilter
|
Example
{
"equals": Decimal,
"in": [Decimal],
"notIn": [Decimal],
"lt": Decimal,
"lte": Decimal,
"gt": Decimal,
"gte": Decimal,
"not": NestedDecimalFilter
}
NestedDecimalNullableFilter
| Input Field | Description |
|---|---|
equals -
Decimal
|
|
in -
[Decimal!]
|
|
notIn -
[Decimal!]
|
|
lt -
Decimal
|
|
lte -
Decimal
|
|
gt -
Decimal
|
|
gte -
Decimal
|
|
not -
NestedDecimalNullableFilter
|
Example
{
"equals": Decimal,
"in": [Decimal],
"notIn": [Decimal],
"lt": Decimal,
"lte": Decimal,
"gt": Decimal,
"gte": Decimal,
"not": NestedDecimalNullableFilter
}
NestedEnumOrderSideFilter
| Input Field | Description |
|---|---|
equals -
OrderSide
|
|
in -
[OrderSide!]
|
|
notIn -
[OrderSide!]
|
|
not -
NestedEnumOrderSideFilter
|
Example
{
"equals": OrderSide,
"in": [OrderSide],
"notIn": [OrderSide],
"not": NestedEnumOrderSideFilter
}
NestedEnumOrderStatusFilter
| Input Field | Description |
|---|---|
equals -
OrderStatus
|
|
in -
[OrderStatus!]
|
|
notIn -
[OrderStatus!]
|
|
not -
NestedEnumOrderStatusFilter
|
Example
{
"equals": OrderStatus,
"in": [OrderStatus],
"notIn": [OrderStatus],
"not": NestedEnumOrderStatusFilter
}