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

Returns a Draw

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

Returns an Alert

Name Description
id - Int!

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

Returns [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

Returns [Alert!]!

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

Returns an Attribute

Name Description
where - AttributeWhereUniqueInput!

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

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

Average token balance of holders chart data
Returns [ChartData!]

Name Description
period - String Default = "1d"
collectionId - String!

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

Collections labeled as bluechip
Returns [Collection!]!

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

Bluechip collection metrics
Returns [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

Returns [Channel!]!

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

Returns a Coupon!

Name Description
planId - String!
couponCode - String!

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

Returns a Collection

Name Description
where - CollectionWhereUniqueInput!

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

List of wallets holding tokens from collection
Returns a CollectionHolders

Name Description
collectionId - String!

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

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

Returns a CollectionWatchlist

Name Description
id - Int!

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

Returns a CollectionWatchlist

Name Description
slug - String!

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

Returns [CollectionWatchlist!]!

Name Description
pinnedOnly - Boolean Default = false

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

Returns [CrateOpen!]!

Name Description
drawId - Int
tokenId - String!

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

Returns [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

Returns [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

Returns [Wallet!]!

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

Returns [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

Returns a Token

Name Description
unopenedCrate - Boolean Default = false

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

Returns a BillingInfo

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

Number of holders chart data
Returns [ChartData!]

Name Description
period - String Default = "1d"
collectionId - String!

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

Returns a Boolean!

Name Description
model - String!
id - String!

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

Returns [Alert!]!

Name Description
tokenId - String!

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

Looksrare marketplace volume over time
Returns [ChartData!]!

Name Description
period - String!

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

Looksrare marketplace volume over time
Returns a JSON!

Name Description
excludeWashTrades - Boolean
period - String!

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

Returns a User

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

Returns a Meta!

Example

Query
query meta {
  meta {
    eth {
      ...SyncStatusFragment
    }
  }
}
Response
{"data": {"meta": {"eth": SyncStatus}}}

mintingCollections

Query collections that minted some tokens in the specified timeframe
Returns [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

Number of collections first minting over time
Returns [ChartData!]!

Name Description
period - String!

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

New vs Returning buyers per day
Returns a JSON!

Name Description
period - String!

Example

Query
query newVsReturningBuyersOverTime($period: String!) {
  newVsReturningBuyersOverTime(period: $period)
}
Variables
{
  "period": "Generated Argument example for newVsReturningBuyersOverTime period"
}
Response
{"data": {"newVsReturningBuyersOverTime": {}}}

notableUser

Returns a NotableUser

Name Description
username - String

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

Opensea marketplace volume over time
Returns [ChartData!]!

Name Description
period - String!

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

Listings chart data
Returns [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

Query pending token sale transactions
Returns [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

Returns [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

Returns [Alert!]!

Name Description
collectionId - String

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

Returns [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

Search across indexed collections. Only returns collections that have their metadata pulled in.
Returns [Collection!]!

Name Description
take - Int Default = 50
query - String!

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

Search across indexed wallets. Only returns collections that have their metadata pulled in.
Returns [Wallet!]!

Name Description
take - Int Default = 50
query - String!

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

Returns a Token

Name Description
where - TokenWhereUniqueInput!

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

Returns [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

Query token transfers with filters.
Returns [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

NFT Index created by Compass that tracks 5 top collections
Returns a JSON!

Name Description
period - String!

Example

Query
query topCollectionsIndex($period: String!) {
  topCollectionsIndex(period: $period)
}
Variables
{
  "period": "Generated Argument example for topCollectionsIndex period"
}
Response
{"data": {"topCollectionsIndex": {}}}

totalValueMintedOverTime

Total ETH spent on minting NFTs per day
Returns a JSON!

Name Description
period - String!

Example

Query
query totalValueMintedOverTime($period: String!) {
  totalValueMintedOverTime(period: $period)
}
Variables
{
  "period": "Generated Argument example for totalValueMintedOverTime period"
}
Response
{"data": {"totalValueMintedOverTime": {}}}

trendingCollections

Query collections with sales activity in the specified timeframe
Returns [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

Unique Buyers and Sellers per day
Returns a JSON!

Name Description
period - String!

Example

Query
query uniqueBuyersAndSellersOverTime($period: String!) {
  uniqueBuyersAndSellersOverTime(period: $period)
}
Variables
{
  "period": "Generated Argument example for uniqueBuyersAndSellersOverTime period"
}
Response
{"data": {"uniqueBuyersAndSellersOverTime": {}}}

userEventsFeed

Get latest events for your favorite wallets and collections
Returns [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

Get latest events for your own wallets
Returns [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

Returns a Wallet

Name Description
where - WalletWhereUniqueInput!

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

Query wallets by ENS name
Returns a Wallet

Name Description
name - String!

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

All owned collections of account. Includes everything from all linked wallets.
Returns [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

Get latest events for your favorite wallets and collections
Returns [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

Returns [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

Returns a WalletWatchlist

Name Description
id - Int!

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

Returns a WalletWatchlist

Name Description
slug - String!

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

Returns [WalletWatchlist!]!

Name Description
pinnedOnly - Boolean Default = false

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

Bluechip collection metrics
Returns [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

X2Y2 marketplace volume over time
Returns [ChartData!]!

Name Description
period - String!

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

Returns a CollectionWatchlist!

Name Description
collectionIds - [String!]!
watchlistId - Int!

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

Returns a WalletWatchlist!

Name Description
walletIds - [String!]!
watchlistId - Int!

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

Returns a Boolean!

Name Description
walletId - String
prizeId - Int!

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

Returns an Alert!

Name Description
data - CreateAlertInput!

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

Returns a BillingInfo!

Name Description
billingInfoData - BillingInfoBaseInput!

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

Returns a Channel!

Name Description
data - ChannelCreateInput!

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

Returns a CollectionWatchlist!

Name Description
name - String!

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

Returns a WalletWatchlist!

Name Description
name - String
walletIds - [String!]!

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

Returns a WalletWatchlist!

Name Description
name - String!

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

Returns a Boolean!

Name Description
id - Int!

Example

Query
mutation deleteAlert($id: Int!) {
  deleteAlert(id: $id)
}
Variables
{"id": 987}
Response
{"data": {"deleteAlert": false}}

deleteAlertChannel

Returns a Boolean!

Name Description
id - Int!

Example

Query
mutation deleteAlertChannel($id: Int!) {
  deleteAlertChannel(id: $id)
}
Variables
{"id": 123}
Response
{"data": {"deleteAlertChannel": false}}

deleteWatchlist

Returns a Boolean!

Name Description
id - Int!

Example

Query
mutation deleteWatchlist($id: Int!) {
  deleteWatchlist(id: $id)
}
Variables
{"id": 987}
Response
{"data": {"deleteWatchlist": false}}

editWalletName

Returns a Boolean!

Name Description
name - String!
walletId - String!

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

Returns a WalletAccessToken!

Name Description
code - String!

Example

Query
mutation loginWithDiscord($code: String!) {
  loginWithDiscord(code: $code) {
    token
  }
}
Variables
{
  "code": "Generated Argument example for loginWithDiscord code"
}
Response
{"data": {"loginWithDiscord": {"token": "xyz789"}}}

openCrate

Returns a CrateOpen!

Name Description
seedHash - String!
tokenId - String!

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

Returns a Boolean!

Name Description
id - Int!

Example

Query
mutation pinWatchlist($id: Int!) {
  pinWatchlist(id: $id)
}
Variables
{"id": 123}
Response
{"data": {"pinWatchlist": false}}

refreshCollectionItems

Returns a Boolean!

Name Description
id - String!

Example

Query
mutation refreshCollectionItems($id: String!) {
  refreshCollectionItems(id: $id)
}
Variables
{
  "id": "Generated Argument example for refreshCollectionItems id"
}
Response
{"data": {"refreshCollectionItems": true}}

refreshCollectionMetadata

Mutation to request collection metadata refresh
Returns a Boolean!

Name Description
id - String!

Example

Query
mutation refreshCollectionMetadata($id: String!) {
  refreshCollectionMetadata(id: $id)
}
Variables
{
  "id": "Generated Argument example for refreshCollectionMetadata id"
}
Response
{"data": {"refreshCollectionMetadata": true}}

refreshTokenListings

Returns [Order!]!

Name Description
tokenId - String!

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

Returns [Token!]!

Name Description
tokenId - String!

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

Returns a CollectionWatchlist!

Name Description
collectionIds - [String!]!
watchlistId - Int!

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

Returns a WalletWatchlist!

Name Description
walletIds - [String!]!
watchlistId - Int!

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

Returns a Boolean!

Name Description
reportData - ReportDataInput!
collectionId - String!

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

Returns a Channel!

Name Description
id - Int!

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
    }
  }
}

toggleCollectionHiddenState

Returns a Boolean!

Name Description
collectionId - String!

Example

Query
mutation toggleCollectionHiddenState($collectionId: String!) {
  toggleCollectionHiddenState(collectionId: $collectionId)
}
Variables
{
  "collectionId": "Generated Argument example for toggleCollectionHiddenState collectionId"
}
Response
{"data": {"toggleCollectionHiddenState": true}}

toggleFavorite

Returns a Boolean!

Name Description
model - String!
id - String!

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

Returns a Boolean!

Name Description
id - Int!

Example

Query
mutation unpinWatchlist($id: Int!) {
  unpinWatchlist(id: $id)
}
Variables
{"id": 987}
Response
{"data": {"unpinWatchlist": true}}

updateAlert

Returns an Alert!

Name Description
data - CreateAlertInput!
id - Int!

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

Returns a BillingInfo!

Name Description
billingInfoData - BillingInfoInput!

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

Returns a CollectionWatchlist!

Name Description
name - String!
id - Int!

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

Returns a WalletWatchlist!

Name Description
status - WatchlistStatus
name - String
id - Int!

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
}

ActivityType

Enum Value Description

mint

burn

transfer

sale

list

bid

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]
}

AlertCount

Field Name Description
channels - Int!
history - Int!
Example
{"channels": 123, "history": 987}

AlertHistory

Field Name Description
id - Int!
alertId - Int!
payload - JSON! Alert payload
createdAt - DateTime! Timestamp of alert event
Example
{
  "id": 987,
  "alertId": 123,
  "payload": {},
  "createdAt": DateTime
}

AlertStatus

Enum Value Description

ACTIVE

INACTIVE

DISABLED

ERROR

FINISHED

AlertType

Enum Value Description

WALLET_ACTIVITY

COLLECTION_ACTIVITY

FEED_ACTIVITY

FLOOR_PRICE

REVEAL

COLLECTION_LISTINGS

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
tokenAttributes - [TokenAttribute!]! Tokens having this attribute
Example
{
  "id": "abc123",
  "collectionId": "abc123",
  "name": "abc123",
  "displayType": "abc123",
  "_count": AttributeCount,
  "valueCount": 987,
  "collection": Collection,
  "values": [AttributeValue],
  "tokenAttributes": [TokenAttribute]
}

AttributeCount

Field Name Description
values - Int!
tokenAttributes - Int!
Example
{"values": 123, "tokenAttributes": 987}

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
}

AttributeScalarFieldEnum

Enum Value Description

id

collectionId

name

displayType

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
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
}

AttributeValueCount

Field Name Description
tokenAttributes - Int!
Example
{"tokenAttributes": 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
}

AttributeValueScalarFieldEnum

Enum Value Description

id

attributeId

value

AttributeValueWhereInput

Example
{
  "AND": [AttributeValueWhereInput],
  "OR": [AttributeValueWhereInput],
  "NOT": [AttributeValueWhereInput],
  "id": StringFilter,
  "attributeId": StringFilter,
  "attribute": AttributeRelationFilter,
  "value": StringFilter,
  "tokenAttributes": TokenAttributeListRelationFilter
}

AttributeValueWhereUniqueInput

Input Field Description
id - String
Example
{"id": "xyz789"}

AttributeWhereInput

Example
{
  "AND": [AttributeWhereInput],
  "OR": [AttributeWhereInput],
  "NOT": [AttributeWhereInput],
  "id": StringFilter,
  "collectionId": StringFilter,
  "collection": CollectionRelationFilter,
  "name": StringFilter,
  "displayType": StringNullableFilter,
  "values": AttributeValueListRelationFilter,
  "tokenAttributes": TokenAttributeListRelationFilter
}

AttributeWhereUniqueInput

Input Field Description
id - String
Example
{"id": "xyz789"}

BigInt

The BigInt scalar type represents non-fractional signed whole numeric values.

Example
object

BigIntFilter

Input Field Description
equals - BigInt
in - [BigInt!]
notIn - [BigInt!]
lt - BigInt
lte - BigInt
gt - BigInt
gte - BigInt
not - NestedBigIntFilter
Example
{
  "equals": BigInt,
  "in": [BigInt],
  "notIn": [BigInt],
  "lt": BigInt,
  "lte": BigInt,
  "gt": BigInt,
  "gte": BigInt,
  "not": NestedBigIntFilter
}

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}

Boolean

The Boolean scalar type represents true or false.

Example
true

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
}

CacheControlScope

Enum Value Description

PUBLIC

PRIVATE

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
}

ChannelCount

Field Name Description
alerts - Int!
Example
{"alerts": 123}

ChannelCreateInput

Input Field Description
name - String!
type - ChannelType!
config - JSON
status - ChannelStatus
Example
{
  "name": "abc123",
  "type": ChannelType,
  "config": {},
  "status": ChannelStatus
}

ChannelStatus

Enum Value Description

ACTIVE

INACTIVE

DISABLED

ERROR

ChannelType

Enum Value Description

PUSH

WEBHOOK

EMAIL

SMS

DISCORD_CHANNEL

SLACK

DISCORD_WEBHOOK

TELEGRAM

DISCORD_DM

ChartData

Field Name Description
key - String!
value - Float!
Example
{"key": "abc123", "value": 987.65}

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
}

CheckoutStatus

Enum Value Description

PENDING

TX_PENDING

CANCELLED

EXPIRED

COMPLETE

ClaimablePrize

Field Name Description
id - Int!
isClaimed - Boolean!
type - PrizeType!
prize - SinglePrize!
Example
{
  "id": 123,
  "isClaimed": false,
  "type": PrizeType,
  "prize": SinglePrize
}

CoinPrize

Field Name Description
amount - Float!
numberOfPackages - Int!
Example
{"amount": 987.65, "numberOfPackages": 123}

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!

Arguments

size - String default = "7d"

period - String default = "1h"

listingsChart - JSON

Arguments

period - String default = "1h"

listingsOverTime - JSON

Arguments

size - String default = "7d"

period - String default = "1h"

transactionsChart - JSON

Arguments

period - String default = "1h"

metrics - CollectionMetrics!

Arguments

period - String default = "1d"

previousMetrics - CollectionMetrics!

Arguments

period - String default = "1d"

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

Arguments

take - Int default = 50

Number of entities to return in response (used for pagination)

skip - Int default = 0

Number of entities to skip (used for pagination)

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

Arguments

orderBy - String

owner - String

owners - [String!]

tokenId - String

tokenIdFrom - String

tokenIdTo - String

priceFrom - Float

priceTo - Float

rarityFrom - Int

rarityTo - Int

listingStatus - String

attributeValueIds - [String!]

attributeCount - Int

take - Int default = 50

Number of entities to return in response (used for pagination)

skip - Int default = 0

Number of entities to skip (used for pagination)

listingEvents - [CollectionListingEvent!]! Listing events

Arguments

take - Int default = 50

Number of entities to return in response (used for pagination)

skip - Int default = 0

Number of entities to skip (used for pagination)

sortBy - String default = "date_desc"

priceFrom - Float

priceTo - Float

rarityFrom - Int

rarityTo - Int

attributeValueIds - [String!]

saleEvents - [CollectionActivityEvent!]! Sale events

Arguments

take - Int default = 50

Number of entities to return in response (used for pagination)

skip - Int default = 0

Number of entities to skip (used for pagination)

sortBy - String default = "date_desc"

priceFrom - Float

priceTo - Float

rarityFrom - Int

rarityTo - Int

attributeValueIds - [String!]

totalVolume - Float! Total lifetime volume of the collection across all supported marketplaces
totalProfits - Float!

Arguments

period - String default = "1d"

liquidityRank - LiquidityRank!
activity - [ActivityItem!]!

Arguments

filters - [FilterArg!]

take - Int default = 50

Number of entities to return in response (used for pagination)

skip - Int default = 0

Number of entities to skip (used for pagination)

tokensV2 - [Token!]!

Arguments

orderDesc - Boolean

orderBy - String

filters - [FilterArg!]

take - Int default = 50

Number of entities to return in response (used for pagination)

skip - Int default = 0

Number of entities to skip (used for pagination)

floorPriceChart - JSON!

Arguments

period - String default = "1d"

orderbookDepth - JSON!

Arguments

dataGrouping - Float default = 0.1

tokenTransfers - [TokenTransfer!]! Token transfers involing tokens of collection
attributes - [Attribute!]! Trait types the collection has
orders - [Order!]!

Arguments

where - OrderWhereInput

take - Int

skip - Int

sales - [Sale!]!

Arguments

where - SaleWhereInput

take - Int

skip - Int

profitLeaderboard - [ProfitLeader!]!

Arguments

filters - [FilterArg!]

take - Int default = 50

Number of entities to return in response (used for pagination)

skip - Int default = 0

Number of entities to skip (used for pagination)

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
}

CollectionActivityEventType

Enum Value Description

LISTING

SALE

CollectionCharts

Field Name Description
volume - JSON!
avgPrice - JSON
medianPrice - JSON
minPrice - JSON
salesCount - JSON
Example
{
  "volume": {},
  "avgPrice": {},
  "medianPrice": {},
  "minPrice": {},
  "salesCount": {}
}

CollectionCount

Field Name Description
tokens - Int!
tokenTransfers - Int!
attributes - Int!
favoritedBy - Int!
orders - Int!
sales - Int!
flips - Int!
Example
{
  "tokens": 123,
  "tokenTransfers": 987,
  "attributes": 123,
  "favoritedBy": 987,
  "orders": 987,
  "sales": 123,
  "flips": 987
}

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]
}

CollectionMetrics

Field Name Description
minPrice - Float
medianPrice - Float
avgPrice - Float
maxPrice - Float
volume - Float
previous - CollectionMetrics
Example
{
  "minPrice": 123.45,
  "medianPrice": 987.65,
  "avgPrice": 123.45,
  "maxPrice": 987.65,
  "volume": 987.65,
  "previous": CollectionMetrics
}

CollectionMinter

Field Name Description
wallet - Wallet!
count - Int!
Example
{"wallet": Wallet, "count": 987}

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

id

isERC721

type

isVerified

isRevealed

revealsAt

revealedAt

name

symbol

maxSupply

slug

imageUrl

bannerImageUrl

description

discordUrl

contractCreatedTimestamp

externalUrl

telegramUrl

mediumUsername

twitterUsername

instagramUsername

devFeeBasisPoints

openseaFeeBasisPoints

updatedAt

orderbookSyncedAt

valuationOptimalLayer

CollectionWatchlist

Field Name Description
id - Int!
name - String!
slug - String!
isPublic - Boolean!
createdAt - DateTime!
status - WatchlistStatus!
isPinned - Boolean!
memberCount - Int!
marketCapOverTime - [ChartData!]!

Arguments

period - String default = "90d"

volumeOverTime - [ChartData!]!

Arguments

period - String default = "90d"

volume - NumberWithChange!

Arguments

period - String default = "1d"

marketCap - NumberWithChange!

Arguments

period - String default = "1d"

uniqueBuyersCount - NumberWithChange!

Arguments

period - String default = "1d"

uniqueSellersCount - NumberWithChange!

Arguments

period - String default = "1d"

imageUrl - String!
isMember - Boolean!

Arguments

id - String!

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

Input Field Description
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
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
}

CollectionWhereUniqueInput

Input Field Description
id - String
Example
{"id": "abc123"}

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
}

Coupon

Field Name Description
discountValue - Float!
Example
{"discountValue": 123.45}

CrateOpen

Field Name Description
id - Int!
prizes - [Prize!]!
Example
{"id": 123, "prizes": [Prize]}

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]
}

Entry

Field Name Description
isOpened - Boolean!
token - Token!
Example
{"isOpened": true, "token": Token}

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
}

Erc20Info

Field Name Description
name - String!
imageUrl - String!
Example
{"name": "xyz789", "imageUrl": "xyz789"}

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]
}

EventType

Enum Value Description

send

receive

buy

sell

mint

burn

list

bid

reveal

sweep

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

number

category

collection

wallet

timestamp

boolean

logical

interval

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

id

marketplace

collectionId

tokenId

walletId

soldFor

soldAt

saleGasPaid

rank

marketplaceFee

saleRoyalties

purchaseType

purchasedFor

purchasedAt

heldFor

purchaseGasPaid

netProfit

saleType

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
}

FlipWhereUniqueInput

Input Field Description
id - String
Example
{"id": "abc123"}

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

IntFilter

Input Field Description
equals - Int
in - [Int!]
notIn - [Int!]
lt - Int
lte - Int
gt - Int
gte - Int
not - NestedIntFilter
Example
{
  "equals": 42,
  "in": [42],
  "notIn": [42],
  "lt": 42,
  "lte": 42,
  "gt": 42,
  "gte": 42,
  "not": NestedIntFilter
}

IntNullableFilter

Input Field Description
equals - Int
in - [Int!]
notIn - [Int!]
lt - Int
lte - Int
gt - Int
gte - Int
not - NestedIntNullableFilter
Example
{
  "equals": 42,
  "in": [42],
  "notIn": [42],
  "lt": 42,
  "lte": 42,
  "gt": 42,
  "gte": 42,
  "not": NestedIntNullableFilter
}

JSON

The JSON scalar type represents JSON values as specified by ECMA-404.

Example
{}

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": {}
}

Label

Representation of a single label

Field Name Description
name - String!
displayName - String!
description - String
Example
{"name": "xyz789", "displayName": "abc123", "description": "xyz789"}

LiquidityRank

Enum Value Description

Dead

Low

Medium

High

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
}

ListingType

Enum Value Description

NEW

RELIST

ListingsHistogramData

Field Name Description
marketplace - Int!
priceBin - Float!
count - Int!
totalValue - Float!
totalCount - Int!
Example
{
  "marketplace": 987,
  "priceBin": 123.45,
  "count": 987,
  "totalValue": 987.65,
  "totalCount": 987
}

Meta

Field Name Description
eth - SyncStatus!
Example
{"eth": SyncStatus}

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]
}

NestedBigIntFilter

Input Field Description
equals - BigInt
in - [BigInt!]
notIn - [BigInt!]
lt - BigInt
lte - BigInt
gt - BigInt
gte - BigInt
not - NestedBigIntFilter
Example
{
  "equals": BigInt,
  "in": [BigInt],
  "notIn": [BigInt],
  "lt": BigInt,
  "lte": BigInt,
  "gt": BigInt,
  "gte": BigInt,
  "not": NestedBigIntFilter
}

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
}

NestedIntFilter

Input Field Description
equals - Int
in - [Int!]
notIn - [Int!]
lt - Int
lte - Int
gt - Int
gte - Int
not - NestedIntFilter
Example
{
  "equals": 42,
  "in": [42],
  "notIn": [42],
  "lt": 42,
  "lte": 42,
  "gt": 42,
  "gte": 42,
  "not": NestedIntFilter
}

NestedIntNullableFilter

Input Field Description
equals - Int
in - [Int!]
notIn - [Int!]
lt - Int
lte - Int
gt - Int
gte - Int
not - NestedIntNullableFilter
Example
{
  "equals": 42,
  "in": [42],
  "notIn": [42],
  "lt": 42,
  "lte": 42,
  "gt": 42,
  "gte": 42,
  "not": NestedIntNullableFilter
}

NestedStringFilter

Input Field Description
equals - String
in - [String!]
notIn - [String!]
lt - String
lte - String
gt - String
gte - String
contains - String
startsWith - String
endsWith - String
not - NestedStringFilter
Example
{
  "equals": "xyz789",
  "in": ["xyz789"],
  "notIn": ["xyz789"],
  "lt": "abc123",
  "lte": "abc123",
  "gt": "xyz789",
  "gte": "xyz789",
  "contains": "xyz789",
  "startsWith": "xyz789",
  "endsWith": "abc123",
  "not": NestedStringFilter
}

NestedStringNullableFilter

Input Field Description
equals - String
in - [String!]
notIn - [String!]
lt - String
lte - String
gt - String
gte - String
contains - String
startsWith - String
endsWith - String
not - NestedStringNullableFilter
Example
{
  "equals": "xyz789",
  "in": ["abc123"],
  "notIn": ["xyz789"],
  "lt": "abc123",
  "lte": "abc123",
  "gt": "xyz789",
  "gte": "xyz789",
  "contains": "abc123",
  "startsWith": "abc123",
  "endsWith": "xyz789",
  "not": NestedStringNullableFilter
}

NotableUser

Notable user social data

Field Name Description
id - ID! id of the user
wallet - String! Wallet address of the user
twitterUsername - String! Twitter username of the user
twitterId - String! Twitter Id of the user
lastUpdated - DateTime! Last time the data was updated
tweets - [Tweet] List of Tweets for the user
follows - [FollowedUser] List of Tweeter accounts the user follows
Example
{
  "id": ID,
  "wallet": "xyz789",
  "twitterUsername": "xyz789",
  "twitterId": "abc123",
  "lastUpdated": DateTime,
  "tweets": [Tweet],
  "follows": [FollowedUser]
}

NumberWithChange

Field Name Description
value - Float
previous - Float
Example
{"value": 123.45, "previous": 123.45}

Offer

Field Name Description
id - String!
base_price - Float!
Example
{"id": "abc123", "base_price": 123.45}

Order

Field Name Description
id - String!
side - OrderSide!
marketplace - Int!
makerId - String! Wallet address of order maker
takerId - String! Wallet address of order taker
collectionId - String! Collection address the order belongs to
tokenId - String Unique ID of the token the order belongs to
price - Decimal! Price of the order
status - OrderStatus! Status of the order
filledAt - DateTime
cancelledAt - DateTime
createdAt - DateTime! Timestamp of order creation
expiresAt - DateTime Order expiration timestamp
validFrom - DateTime Order active from timestamp
blockNumber - Int
blockTimestamp - DateTime
metadata - JSON Order metadata required for filling an order
token - Token
maker - Wallet!
taker - Wallet!
collection - Collection!
pendingOrderFills - [PendingFill!]! Query pending token sale transactions
Example
{
  "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": 987,
  "blockTimestamp": DateTime,
  "metadata": {},
  "token": Token,
  "maker": Wallet,
  "taker": Wallet,
  "collection": Collection,
  "pendingOrderFills": [PendingFill]
}

OrderListRelationFilter

Input Field Description
every - OrderWhereInput
some - OrderWhereInput
none - OrderWhereInput
Example
{
  "every": OrderWhereInput,
  "some": OrderWhereInput,
  "none": OrderWhereInput
}

OrderOrderByRelationAggregateInput

Input Field Description
_count - SortOrder
Example
{"_count": SortOrder}

OrderOrderByWithRelationInput

Input Field Description
id - SortOrder
side - SortOrder
marketplace - SortOrder
makerId - SortOrder
takerId - SortOrder
collectionId - SortOrder
tokenId - SortOrder
token - TokenOrderByWithRelationInput
price - SortOrder
status - SortOrder
filledAt - SortOrder
cancelledAt - SortOrder
createdAt - SortOrder
expiresAt - SortOrder
validFrom - SortOrder
blockNumber - SortOrder
blockTimestamp - SortOrder
metadata - SortOrder
maker - WalletOrderByWithRelationInput
taker - WalletOrderByWithRelationInput
collection - CollectionOrderByWithRelationInput
Example
{
  "id": SortOrder,
  "side": SortOrder,
  "marketplace": SortOrder,
  "makerId": SortOrder,
  "takerId": SortOrder,
  "collectionId": SortOrder,
  "tokenId": SortOrder,
  "token": TokenOrderByWithRelationInput,
  "price": SortOrder,
  "status": SortOrder,
  "filledAt": SortOrder,
  "cancelledAt": SortOrder,
  "createdAt": SortOrder,
  "expiresAt": SortOrder,
  "validFrom": SortOrder,
  "blockNumber": SortOrder,
  "blockTimestamp": SortOrder,
  "metadata": SortOrder,
  "maker": WalletOrderByWithRelationInput,
  "taker": WalletOrderByWithRelationInput,
  "collection": CollectionOrderByWithRelationInput
}

OrderScalarFieldEnum

Enum Value Description

id

side

marketplace

makerId

takerId

collectionId

tokenId

price

status

filledAt

cancelledAt

createdAt

expiresAt

validFrom

blockNumber

blockTimestamp

metadata

OrderSide

Enum Value Description

BUY

SELL

OrderStatus

Enum Value Description

ACTIVE

CANCELLED

FILLED

INVALID

OrderWhereInput

Input Field Description
AND - [OrderWhereInput!]
OR - [OrderWhereInput!]
NOT - [OrderWhereInput!]
id - StringFilter
side - EnumOrderSideFilter
marketplace - IntFilter
makerId - StringFilter
takerId - StringFilter
collectionId - StringFilter
tokenId - StringNullableFilter
token - TokenRelationFilter
price - DecimalFilter
status - EnumOrderStatusFilter
filledAt - DateTimeNullableFilter
cancelledAt - DateTimeNullableFilter
createdAt - DateTimeFilter
expiresAt - DateTimeNullableFilter
validFrom - DateTimeNullableFilter
blockNumber - IntNullableFilter
blockTimestamp - DateTimeNullableFilter
metadata - JsonNullableFilter
maker - WalletRelationFilter
taker - WalletRelationFilter
collection - CollectionRelationFilter
Example
{
  "AND": [OrderWhereInput],
  "OR": [OrderWhereInput],
  "NOT": [OrderWhereInput],
  "id": StringFilter,
  "side": EnumOrderSideFilter,
  "marketplace": IntFilter,
  "makerId": StringFilter,
  "takerId": StringFilter,
  "collectionId": StringFilter,
  "tokenId": StringNullableFilter,
  "token": TokenRelationFilter,
  "price": DecimalFilter,
  "status": EnumOrderStatusFilter,
  "filledAt": DateTimeNullableFilter,
  "cancelledAt": DateTimeNullableFilter,
  "createdAt": DateTimeFilter,
  "expiresAt": DateTimeNullableFilter,
  "validFrom": DateTimeNullableFilter,
  "blockNumber": IntNullableFilter,
  "blockTimestamp": DateTimeNullableFilter,
  "metadata": JsonNullableFilter,
  "maker": WalletRelationFilter,
  "taker": WalletRelationFilter,
  "collection": CollectionRelationFilter
}

OrderWhereUniqueInput

Input Field Description
id - String
Example
{"id": "abc123"}

PendingFill

Field Name Description
id - String!
orderHash - String!
firstSeen - DateTime!
collectionId - String!
tokenId - String!
gasPrice - String!
maxFeePerGas - String
maxPriorityFeePerGas - String
from - String!
transactionHash - String!
status - String!
Example
{
  "id": "abc123",
  "orderHash": "abc123",
  "firstSeen": DateTime,
  "collectionId": "abc123",
  "tokenId": "abc123",
  "gasPrice": "abc123",
  "maxFeePerGas": "xyz789",
  "maxPriorityFeePerGas": "abc123",
  "from": "xyz789",
  "transactionHash": "xyz789",
  "status": "xyz789"
}

PersonalAccessToken

Field Name Description
id - Int!
name - String!
expiresAt - DateTime!
createdAt - DateTime!
Example
{
  "id": 123,
  "name": "abc123",
  "expiresAt": DateTime,
  "createdAt": DateTime
}

Plan

Field Name Description
id - String!
displayName - String!
price - Float!
periodLength - Int!
Example
{"id": "xyz789", "displayName": "xyz789", "price": 987.65, "periodLength": 123}

PortfolioItem

Field Name Description
id - String!
collection - Collection!
tokenCount - Int!
totalRevenue - Float
totalInvested - Float
avgInvested - Float
estimatedValue - Float
totalGasSpent - Float
Example
{
  "id": "abc123",
  "collection": Collection,
  "tokenCount": 987,
  "totalRevenue": 987.65,
  "totalInvested": 123.45,
  "avgInvested": 987.65,
  "estimatedValue": 987.65,
  "totalGasSpent": 123.45
}

PortfolioValue

Field Name Description
liquidity - LiquidityRank!
value - Float!
Example
{"liquidity": LiquidityRank, "value": 987.65}

PrizeType

Enum Value Description

erc20

erc721

erc1155

whitelist

coin

ProfitLeader

Field Name Description
id - String!
wallet - Wallet!
totalProfit - Float!
avgProfit - Float!
minSalePrice - Float!
maxSalePrice - Float!
minPurchasePrice - Float!
avgSalePrice - Float!
avgPurchasePrice - Float!
maxPurchasePrice - Float!
avgHeldFor - Float!
uniqueTokensFlipped - Float!
purchases - [PurchaseBreakdown!]!
rank - Int!
firstPurchasedAt - DateTime!
Example
{
  "id": "xyz789",
  "wallet": Wallet,
  "totalProfit": 123.45,
  "avgProfit": 123.45,
  "minSalePrice": 123.45,
  "maxSalePrice": 987.65,
  "minPurchasePrice": 123.45,
  "avgSalePrice": 123.45,
  "avgPurchasePrice": 987.65,
  "maxPurchasePrice": 123.45,
  "avgHeldFor": 987.65,
  "uniqueTokensFlipped": 123.45,
  "purchases": [PurchaseBreakdown],
  "rank": 987,
  "firstPurchasedAt": DateTime
}

ProfitLeaderboardItem

Field Name Description
id - String!
totalProfit - Float!
avgProfit - Float!
minProfit - Float!
maxProfit - Float!
totalRoyalties - Float!
tokensFlipped - Float!
collectionsFlipped - Float!
totalGasPaid - Float!
avgPurchasedFor - Float!
totalSpent - Float!
profitableFlips - Float!
purchases - [PurchaseBreakdown!]!
wallet - Wallet
Example
{
  "id": "xyz789",
  "totalProfit": 987.65,
  "avgProfit": 987.65,
  "minProfit": 987.65,
  "maxProfit": 987.65,
  "totalRoyalties": 123.45,
  "tokensFlipped": 123.45,
  "collectionsFlipped": 123.45,
  "totalGasPaid": 123.45,
  "avgPurchasedFor": 987.65,
  "totalSpent": 987.65,
  "profitableFlips": 123.45,
  "purchases": [PurchaseBreakdown],
  "wallet": Wallet
}

PurchaseBreakdown

Field Name Description
type - String!
count - Int!
rate - Float!
Example
{"type": "xyz789", "count": 987, "rate": 987.65}

QueryMode

Enum Value Description

default

insensitive

ReceiveEvent

Field Name Description
id - String!
type - EventType!
value - Float
timestamp - DateTime!
transaction - Transaction
collection - Collection
token - Token
wallet - Wallet
sender - Wallet
Example
{
  "id": "xyz789",
  "type": EventType,
  "value": 987.65,
  "timestamp": DateTime,
  "transaction": Transaction,
  "collection": Collection,
  "token": Token,
  "wallet": Wallet,
  "sender": Wallet
}

ReportDataInput

Input Field Description
reason - ReportReason!
Example
{"reason": ReportReason}

ReportReason

The reason why this collection is marked as reported

Enum Value Description

Scam

FakeCollection

NotShowingAsRevealed

WrongMetrics

WrongLinks

WrongMetadata

Sale

Sale events from the blockchain

Field Name Description
id - String! Unique ID of the sale composed by transaction id, sale log index and transfer log index
transactionId - String! Transaction hash
collectionId - String!
tokenId - String!
marketplace - Int! Marketplace on which the sale occured (0: Opensea v2, 1: Looksrare, 2: Opensea v2.3)
price - Decimal! Total sale amount in ETH
amount - Decimal!
tokensSold - Int! Number of tokens sold (in case of a bundle)
seller - String!
recipient - String!
buyer - String!
type - String!
blockTimestamp - DateTime! Timestamp of the block
blockNumber - BigInt! Block number the sale was included in
marketplaceFee - Decimal
royalties - Decimal
_count - SaleCount
collection - Collection!
tokenTransfers - [SaleTokenTransfer!]!
transaction - Transaction!
flip - Flip
Example
{
  "id": "abc123",
  "transactionId": "abc123",
  "collectionId": "abc123",
  "tokenId": "xyz789",
  "marketplace": 123,
  "price": Decimal,
  "amount": Decimal,
  "tokensSold": 987,
  "seller": "xyz789",
  "recipient": "abc123",
  "buyer": "xyz789",
  "type": "xyz789",
  "blockTimestamp": DateTime,
  "blockNumber": BigInt,
  "marketplaceFee": Decimal,
  "royalties": Decimal,
  "_count": SaleCount,
  "collection": Collection,
  "tokenTransfers": [SaleTokenTransfer],
  "transaction": Transaction,
  "flip": Flip
}

SaleCount

Field Name Description
tokenTransfers - Int!
Example
{"tokenTransfers": 123}

SaleListRelationFilter

Input Field Description
every - SaleWhereInput
some - SaleWhereInput
none - SaleWhereInput
Example
{
  "every": SaleWhereInput,
  "some": SaleWhereInput,
  "none": SaleWhereInput
}

SaleOrderByRelationAggregateInput

Input Field Description
_count - SortOrder
Example
{"_count": SortOrder}

SaleOrderByWithRelationInput

Input Field Description
id - SortOrder
transactionId - SortOrder
collectionId - SortOrder
tokenId - SortOrder
marketplace - SortOrder
price - SortOrder
amount - SortOrder
tokensSold - SortOrder
seller - SortOrder
recipient - SortOrder
buyer - SortOrder
type - SortOrder
blockTimestamp - SortOrder
blockNumber - SortOrder
marketplaceFee - SortOrder
royalties - SortOrder
collection - CollectionOrderByWithRelationInput
tokenTransfers - SaleTokenTransferOrderByRelationAggregateInput
transaction - TransactionOrderByWithRelationInput
Example
{
  "id": SortOrder,
  "transactionId": SortOrder,
  "collectionId": SortOrder,
  "tokenId": SortOrder,
  "marketplace": SortOrder,
  "price": SortOrder,
  "amount": SortOrder,
  "tokensSold": SortOrder,
  "seller": SortOrder,
  "recipient": SortOrder,
  "buyer": SortOrder,
  "type": SortOrder,
  "blockTimestamp": SortOrder,
  "blockNumber": SortOrder,
  "marketplaceFee": SortOrder,
  "royalties": SortOrder,
  "collection": CollectionOrderByWithRelationInput,
  "tokenTransfers": SaleTokenTransferOrderByRelationAggregateInput,
  "transaction": TransactionOrderByWithRelationInput
}

SaleRelationFilter

Input Field Description
is - SaleWhereInput
isNot - SaleWhereInput
Example
{
  "is": SaleWhereInput,
  "isNot": SaleWhereInput
}

SaleScalarFieldEnum

Enum Value Description

id

transactionId

collectionId

tokenId

marketplace

price

amount

tokensSold

seller

recipient

buyer

type

blockTimestamp

blockNumber

marketplaceFee

royalties

SaleTokenTransfer

Pivot model connecting sales events and token transfers

Field Name Description
tokenTransferId - String!
saleId - String!
sale - Sale!
tokenTransfer - TokenTransfer!
Example
{
  "tokenTransferId": "xyz789",
  "saleId": "abc123",
  "sale": Sale,
  "tokenTransfer": TokenTransfer
}

SaleTokenTransferListRelationFilter

Example
{
  "every": SaleTokenTransferWhereInput,
  "some": SaleTokenTransferWhereInput,
  "none": SaleTokenTransferWhereInput
}

SaleTokenTransferOrderByRelationAggregateInput

Input Field Description
_count - SortOrder
Example
{"_count": SortOrder}

SaleTokenTransferOrderByWithRelationInput

Input Field Description
tokenTransferId - SortOrder
saleId - SortOrder
sale - SaleOrderByWithRelationInput
tokenTransfer - TokenTransferOrderByWithRelationInput
Example
{
  "tokenTransferId": SortOrder,
  "saleId": SortOrder,
  "sale": SaleOrderByWithRelationInput,
  "tokenTransfer": TokenTransferOrderByWithRelationInput
}

SaleTokenTransferScalarFieldEnum

Enum Value Description

tokenTransferId

saleId

SaleTokenTransferTokenTransferIdSaleIdCompoundUniqueInput

Input Field Description
tokenTransferId - String!
saleId - String!
Example
{"tokenTransferId": "abc123", "saleId": "xyz789"}

SaleTokenTransferWhereInput

Example
{
  "AND": [SaleTokenTransferWhereInput],
  "OR": [SaleTokenTransferWhereInput],
  "NOT": [SaleTokenTransferWhereInput],
  "tokenTransferId": StringFilter,
  "saleId": StringFilter,
  "sale": SaleRelationFilter,
  "tokenTransfer": TokenTransferRelationFilter
}

SaleTokenTransferWhereUniqueInput

Input Field Description
tokenTransferId_saleId - SaleTokenTransferTokenTransferIdSaleIdCompoundUniqueInput
Example
{
  "tokenTransferId_saleId": SaleTokenTransferTokenTransferIdSaleIdCompoundUniqueInput
}

SaleType

Enum Value Description

BID

PURCHASE

SaleWhereInput

Input Field Description
AND - [SaleWhereInput!]
OR - [SaleWhereInput!]
NOT - [SaleWhereInput!]
id - StringFilter
transactionId - StringFilter
collectionId - StringFilter
tokenId - StringFilter
marketplace - IntFilter
price - DecimalFilter
amount - DecimalFilter
tokensSold - IntFilter
seller - StringFilter
recipient - StringFilter
buyer - StringFilter
type - StringFilter
blockTimestamp - DateTimeFilter
blockNumber - BigIntFilter
marketplaceFee - DecimalNullableFilter
royalties - DecimalNullableFilter
collection - CollectionRelationFilter
tokenTransfers - SaleTokenTransferListRelationFilter
transaction - TransactionRelationFilter
Example
{
  "AND": [SaleWhereInput],
  "OR": [SaleWhereInput],
  "NOT": [SaleWhereInput],
  "id": StringFilter,
  "transactionId": StringFilter,
  "collectionId": StringFilter,
  "tokenId": StringFilter,
  "marketplace": IntFilter,
  "price": DecimalFilter,
  "amount": DecimalFilter,
  "tokensSold": IntFilter,
  "seller": StringFilter,
  "recipient": StringFilter,
  "buyer": StringFilter,
  "type": StringFilter,
  "blockTimestamp": DateTimeFilter,
  "blockNumber": BigIntFilter,
  "marketplaceFee": DecimalNullableFilter,
  "royalties": DecimalNullableFilter,
  "collection": CollectionRelationFilter,
  "tokenTransfers": SaleTokenTransferListRelationFilter,
  "transaction": TransactionRelationFilter
}

SaleWhereUniqueInput

Input Field Description
id - String
Example
{"id": "xyz789"}

SellEvent

Field Name Description
id - String!
type - EventType!
value - Float
timestamp - DateTime!
transaction - Transaction
collection - Collection
token - Token
wallet - Wallet
buyer - Wallet
sale - Sale
flip - Flip
Example
{
  "id": "abc123",
  "type": EventType,
  "value": 123.45,
  "timestamp": DateTime,
  "transaction": Transaction,
  "collection": Collection,
  "token": Token,
  "wallet": Wallet,
  "buyer": Wallet,
  "sale": Sale,
  "flip": Flip
}

SendEvent

Field Name Description
id - String!
type - EventType!
value - Float
timestamp - DateTime!
transaction - Transaction
collection - Collection
token - Token
wallet - Wallet
recipient - Wallet
Example
{
  "id": "abc123",
  "type": EventType,
  "value": 987.65,
  "timestamp": DateTime,
  "transaction": Transaction,
  "collection": Collection,
  "token": Token,
  "wallet": Wallet,
  "recipient": Wallet
}

SingleCoinPrize

Field Name Description
id - Int!
amount - Float!
Example
{"id": 987, "amount": 123.45}

SingleTokenPrize

Field Name Description
id - Int!
token - Token
erc20Info - Erc20Info
contractAddress - String!
amount - Int!
Example
{
  "id": 123,
  "token": Token,
  "erc20Info": Erc20Info,
  "contractAddress": "xyz789",
  "amount": 987
}

SingleWhitelistCollectionPrize

Field Name Description
id - Int!
upcomingCollection - UpcomingCollection!
Example
{"id": 987, "upcomingCollection": UpcomingCollection}

SortOrder

Enum Value Description

asc

desc

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

StringFilter

Input Field Description
equals - String
in - [String!]
notIn - [String!]
lt - String
lte - String
gt - String
gte - String
contains - String
startsWith - String
endsWith - String
mode - QueryMode
not - NestedStringFilter
Example
{
  "equals": "abc123",
  "in": ["xyz789"],
  "notIn": ["abc123"],
  "lt": "abc123",
  "lte": "abc123",
  "gt": "xyz789",
  "gte": "xyz789",
  "contains": "abc123",
  "startsWith": "xyz789",
  "endsWith": "abc123",
  "mode": QueryMode,
  "not": NestedStringFilter
}

StringNullableFilter

Input Field Description
equals - String
in - [String!]
notIn - [String!]
lt - String
lte - String
gt - String
gte - String
contains - String
startsWith - String
endsWith - String
mode - QueryMode
not - NestedStringNullableFilter
Example
{
  "equals": "abc123",
  "in": ["xyz789"],
  "notIn": ["abc123"],
  "lt": "xyz789",
  "lte": "xyz789",
  "gt": "abc123",
  "gte": "abc123",
  "contains": "abc123",
  "startsWith": "xyz789",
  "endsWith": "xyz789",
  "mode": QueryMode,
  "not": NestedStringNullableFilter
}

SyncStatus

Field Name Description
latestBlock - Int!
lastBlockSynced - Int!
blockBehind - Int!
Example
{"latestBlock": 987, "lastBlockSynced": 987, "blockBehind": 123}

Token

Single token of a collection

Field Name Description
id - String! Unique ID of token that is composed by contract address and numerical token id
collectionAddress - String!
tokenId - String! Token ID of collection
ownerAddress - String Wallet address of current holder
mintTimestamp - DateTime
_count - TokenCount
collection - Collection!
transfers - [TokenTransfer!]! All token transfers involving the token
attributes - [TokenAttribute!]! Token traits
orders - [Order!]! All token listings

Arguments

where - OrderWhereInput

take - Int

skip - Int

flips - [Flip!]!

Arguments

where - FlipWhereInput

take - Int

skip - Int

isReported - Boolean!
rarityRank - Int Token rarity rank
rarityScore - Decimal Token rarity score
rarityRankNormalized - Int Token rarity rank
rarityScoreNormalized - Decimal Token rarity score
image - String Image of the token
previewImageUrl - String Image URL of the token
fullImageUrl - String Image URL of the token
name - String Name of the token
description - String Description of the token
metadata - JSON Token metadata
tokenUri - String Token metadata URL
price - Float Current price of token if listed
listings - [Order!] All active listings of token
owner - Wallet The owner wallet of the token
lastSale - Sale Last sale event for the token
activity - [ActivityItem!]!

Arguments

filters - [FilterArg!]

take - Int default = 50

Number of entities to return in response (used for pagination)

skip - Int default = 0

Number of entities to skip (used for pagination)

activityChart - JSON Token activity chart
eventFeed - [EventFeedItem!]!

Arguments

take - Int default = 20

skip - Int default = 0

types - [EventType!]

Example
{
  "id": "abc123",
  "collectionAddress": "abc123",
  "tokenId": "xyz789",
  "ownerAddress": "xyz789",
  "mintTimestamp": DateTime,
  "_count": TokenCount,
  "collection": Collection,
  "transfers": [TokenTransfer],
  "attributes": [TokenAttribute],
  "orders": [Order],
  "flips": [Flip],
  "isReported": false,
  "rarityRank": 123,
  "rarityScore": Decimal,
  "rarityRankNormalized": 987,
  "rarityScoreNormalized": Decimal,
  "image": "abc123",
  "previewImageUrl": "xyz789",
  "fullImageUrl": "abc123",
  "name": "xyz789",
  "description": "xyz789",
  "metadata": {},
  "tokenUri": "xyz789",
  "price": 987.65,
  "listings": [Order],
  "owner": Wallet,
  "lastSale": Sale,
  "activity": [ActivityItem],
  "activityChart": {},
  "eventFeed": [EventFeedItem]
}

TokenAttribute

Token <-> attribute association

Field Name Description
attributeId - String!
attributeValueId - String!
tokenId - String!
attribute - Attribute!
attributeValue - AttributeValue!
token - Token!
Example
{
  "attributeId": "abc123",
  "attributeValueId": "xyz789",
  "tokenId": "abc123",
  "attribute": Attribute,
  "attributeValue": AttributeValue,
  "token": Token
}

TokenAttributeAttributeIdAttributeValueIdTokenIdCompoundUniqueInput

Input Field Description
attributeId - String!
attributeValueId - String!
tokenId - String!
Example
{"attributeId": "abc123", "attributeValueId": "abc123", "tokenId": "xyz789"}

TokenAttributeListRelationFilter

Input Field Description
every - TokenAttributeWhereInput
some - TokenAttributeWhereInput
none - TokenAttributeWhereInput
Example
{
  "every": TokenAttributeWhereInput,
  "some": TokenAttributeWhereInput,
  "none": TokenAttributeWhereInput
}

TokenAttributeOrderByRelationAggregateInput

Input Field Description
_count - SortOrder
Example
{"_count": SortOrder}

TokenAttributeOrderByWithRelationInput

Input Field Description
attributeId - SortOrder
attribute - AttributeOrderByWithRelationInput
attributeValueId - SortOrder
attributeValue - AttributeValueOrderByWithRelationInput
tokenId - SortOrder
token - TokenOrderByWithRelationInput
Example
{
  "attributeId": SortOrder,
  "attribute": AttributeOrderByWithRelationInput,
  "attributeValueId": SortOrder,
  "attributeValue": AttributeValueOrderByWithRelationInput,
  "tokenId": SortOrder,
  "token": TokenOrderByWithRelationInput
}

TokenAttributeScalarFieldEnum

Enum Value Description

attributeId

attributeValueId

tokenId

TokenAttributeWhereInput

Input Field Description
AND - [TokenAttributeWhereInput!]
OR - [TokenAttributeWhereInput!]
NOT - [TokenAttributeWhereInput!]
attributeId - StringFilter
attribute - AttributeRelationFilter
attributeValueId - StringFilter
attributeValue - AttributeValueRelationFilter
tokenId - StringFilter
token - TokenRelationFilter
Example
{
  "AND": [TokenAttributeWhereInput],
  "OR": [TokenAttributeWhereInput],
  "NOT": [TokenAttributeWhereInput],
  "attributeId": StringFilter,
  "attribute": AttributeRelationFilter,
  "attributeValueId": StringFilter,
  "attributeValue": AttributeValueRelationFilter,
  "tokenId": StringFilter,
  "token": TokenRelationFilter
}

TokenAttributeWhereUniqueInput

Input Field Description
attributeId_attributeValueId_tokenId - TokenAttributeAttributeIdAttributeValueIdTokenIdCompoundUniqueInput
Example
{
  "attributeId_attributeValueId_tokenId": TokenAttributeAttributeIdAttributeValueIdTokenIdCompoundUniqueInput
}

TokenCount

Field Name Description
transfers - Int!
attributes - Int!
orders - Int!
flips - Int!
Example
{"transfers": 987, "attributes": 987, "orders": 123, "flips": 123}

TokenListRelationFilter

Input Field Description
every - TokenWhereInput
some - TokenWhereInput
none - TokenWhereInput
Example
{
  "every": TokenWhereInput,
  "some": TokenWhereInput,
  "none": TokenWhereInput
}

TokenOrderByRelationAggregateInput

Input Field Description
_count - SortOrder
Example
{"_count": SortOrder}

TokenOrderByWithRelationInput

Example
{
  "id": SortOrder,
  "collection": CollectionOrderByWithRelationInput,
  "collectionAddress": SortOrder,
  "tokenId": SortOrder,
  "owner": WalletOrderByWithRelationInput,
  "ownerAddress": SortOrder,
  "mintTimestamp": SortOrder,
  "transfers": TokenTransferOrderByRelationAggregateInput,
  "attributes": TokenAttributeOrderByRelationAggregateInput,
  "orders": OrderOrderByRelationAggregateInput,
  "flips": FlipOrderByRelationAggregateInput
}

TokenPrize

Field Name Description
isClaimed - Boolean!
token - Token
erc20Info - Erc20Info
type - PrizeType!
contractAddress - String!
amount - Int!
Example
{
  "isClaimed": true,
  "token": Token,
  "erc20Info": Erc20Info,
  "type": PrizeType,
  "contractAddress": "abc123",
  "amount": 987
}

TokenRelationFilter

Input Field Description
is - TokenWhereInput
isNot - TokenWhereInput
Example
{
  "is": TokenWhereInput,
  "isNot": TokenWhereInput
}

TokenScalarFieldEnum

Enum Value Description

id

collectionAddress

tokenId

ownerAddress

mintTimestamp

TokenTransfer

Token transfer event model indexed from the blockchain

Field Name Description
id - String! Unique ID of event composed of transaction ID and log index
transactionId - String! ID of transaction that emited this event
collectionAddress - String!
tokenId - String!
fromAddress - String! Sender wallet address
toAddress - String! Recipient wallet address
timestamp - DateTime! Timestamp of block the transaction was included in
value - Decimal Number of tokens transferred (used for ERC1155 transfers)
_count - TokenTransferCount
transaction - Transaction!
token - Token!
from - Wallet! Sender wallet
to - Wallet! Recipient wallet
sales - [SaleTokenTransfer!]!
collection - Collection!
sale - Sale
Example
{
  "id": "xyz789",
  "transactionId": "abc123",
  "collectionAddress": "xyz789",
  "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
}

TokenTransferCount

Field Name Description
sales - Int!
Example
{"sales": 123}

TokenTransferListRelationFilter

Input Field Description
every - TokenTransferWhereInput
some - TokenTransferWhereInput
none - TokenTransferWhereInput
Example
{
  "every": TokenTransferWhereInput,
  "some": TokenTransferWhereInput,
  "none": TokenTransferWhereInput
}

TokenTransferOrderByRelationAggregateInput

Input Field Description
_count - SortOrder
Example
{"_count": SortOrder}

TokenTransferOrderByWithRelationInput

Input Field Description
id - SortOrder
transactionId - SortOrder
transaction - TransactionOrderByWithRelationInput
collection - CollectionOrderByWithRelationInput
collectionAddress - SortOrder
token - TokenOrderByWithRelationInput
tokenId - SortOrder
from - WalletOrderByWithRelationInput
fromAddress - SortOrder
to - WalletOrderByWithRelationInput
toAddress - SortOrder
timestamp - SortOrder
sales - SaleTokenTransferOrderByRelationAggregateInput
value - SortOrder
Example
{
  "id": SortOrder,
  "transactionId": SortOrder,
  "transaction": TransactionOrderByWithRelationInput,
  "collection": CollectionOrderByWithRelationInput,
  "collectionAddress": SortOrder,
  "token": TokenOrderByWithRelationInput,
  "tokenId": SortOrder,
  "from": WalletOrderByWithRelationInput,
  "fromAddress": SortOrder,
  "to": WalletOrderByWithRelationInput,
  "toAddress": SortOrder,
  "timestamp": SortOrder,
  "sales": SaleTokenTransferOrderByRelationAggregateInput,
  "value": SortOrder
}

TokenTransferRelationFilter

Input Field Description
is - TokenTransferWhereInput
isNot - TokenTransferWhereInput
Example
{
  "is": TokenTransferWhereInput,
  "isNot": TokenTransferWhereInput
}

TokenTransferRoot

Field Name Description
id - String! Unique ID of event composed of transaction ID and log index
transactionId - String! ID of transaction that emited this event
collectionAddress - String!
tokenId - String!
fromAddress - String! Sender wallet address
toAddress - String! Recipient wallet address
timestamp - DateTime! Timestamp of block the transaction was included in
value - Decimal Number of tokens transferred (used for ERC1155 transfers)
_count - TokenTransferCount
transaction - Transaction!
token - Token!
from - Wallet! Sender wallet
to - Wallet! Recipient wallet
sales - [SaleTokenTransfer!]!
collection - Collection!
sale - Sale
type - String!
transactionValue - Float
gasPrice - Float
Example
{
  "id": "abc123",
  "transactionId": "xyz789",
  "collectionAddress": "abc123",
  "tokenId": "abc123",
  "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": "xyz789",
  "transactionValue": 123.45,
  "gasPrice": 987.65
}

TokenTransferScalarFieldEnum

Enum Value Description

id

transactionId

collectionAddress

tokenId

fromAddress

toAddress

timestamp

value

TokenTransferWhereInput

Example
{
  "AND": [TokenTransferWhereInput],
  "OR": [TokenTransferWhereInput],
  "NOT": [TokenTransferWhereInput],
  "id": StringFilter,
  "transactionId": StringFilter,
  "transaction": TransactionRelationFilter,
  "collection": CollectionRelationFilter,
  "collectionAddress": StringFilter,
  "token": TokenRelationFilter,
  "tokenId": StringFilter,
  "from": WalletRelationFilter,
  "fromAddress": StringFilter,
  "to": WalletRelationFilter,
  "toAddress": StringFilter,
  "timestamp": DateTimeFilter,
  "sales": SaleTokenTransferListRelationFilter,
  "value": DecimalNullableFilter
}

TokenTransferWhereUniqueInput

Input Field Description
id - String
Example
{"id": "abc123"}

TokenTransfersRootFilters

Input Field Description
transactionType - [String!]

Filter transactions by type.

fromAddress - String

Filter transactions by from walleet.

toAddress - String

Filter transactions by to wallet.

minValue - Float

Filter transactions by min value.

maxValue - Float

Filter transactions by max value.

fromDate - String

Filter transactions by starting date.

toDate - String

Filter transactions by end date.

tokenId - String

Filter transactions by token.

collectionName - String

Filter transactions by collection.

Example
{
  "transactionType": ["abc123"],
  "fromAddress": "abc123",
  "toAddress": "abc123",
  "minValue": 123.45,
  "maxValue": 987.65,
  "fromDate": "xyz789",
  "toDate": "abc123",
  "tokenId": "xyz789",
  "collectionName": "xyz789"
}

TokenWhereInput

Example
{
  "AND": [TokenWhereInput],
  "OR": [TokenWhereInput],
  "NOT": [TokenWhereInput],
  "id": StringFilter,
  "collection": CollectionRelationFilter,
  "collectionAddress": StringFilter,
  "tokenId": StringFilter,
  "owner": WalletRelationFilter,
  "ownerAddress": StringNullableFilter,
  "mintTimestamp": DateTimeNullableFilter,
  "transfers": TokenTransferListRelationFilter,
  "attributes": TokenAttributeListRelationFilter,
  "orders": OrderListRelationFilter,
  "flips": FlipListRelationFilter
}

TokenWhereUniqueInput

Input Field Description
id - String
Example
{"id": "abc123"}

Transaction

Blockchain transactions

Field Name Description
id - String! Transaction hash from the blockchain
blockNumber - BigInt! Block number the transaction was included in
blockTimestamp - DateTime! Timestamp of the block
value - Decimal! Value of transaction in ETH
gasUsed - BigInt! Amount of gas used
gasPrice - Decimal! Gas price in gwei
gasInEth - Decimal! Total gas used in ETH
fromAddress - String! Address of the wallet that sent the transaction
_count - TransactionCount
gas_in_eth - Decimal! Use gasInEth instead
gas_used - BigInt! Use gasUsed instead
gas_price - Decimal! Use gasPrice instead
Example
{
  "id": "xyz789",
  "blockNumber": BigInt,
  "blockTimestamp": DateTime,
  "value": Decimal,
  "gasUsed": BigInt,
  "gasPrice": Decimal,
  "gasInEth": Decimal,
  "fromAddress": "xyz789",
  "_count": TransactionCount,
  "gas_in_eth": Decimal,
  "gas_used": BigInt,
  "gas_price": Decimal
}

TransactionCount

Field Name Description
tokenTransfers - Int!
sales - Int!
Example
{"tokenTransfers": 123, "sales": 987}

TransactionListRelationFilter

Input Field Description
every - TransactionWhereInput
some - TransactionWhereInput
none - TransactionWhereInput
Example
{
  "every": TransactionWhereInput,
  "some": TransactionWhereInput,
  "none": TransactionWhereInput
}

TransactionOrderByRelationAggregateInput

Input Field Description
_count - SortOrder
Example
{"_count": SortOrder}

TransactionOrderByWithRelationInput

Input Field Description
id - SortOrder
blockNumber - SortOrder
blockTimestamp - SortOrder
value - SortOrder
gasUsed - SortOrder
gasPrice - SortOrder
gasInEth - SortOrder
from - WalletOrderByWithRelationInput
fromAddress - SortOrder
tokenTransfers - TokenTransferOrderByRelationAggregateInput
sales - SaleOrderByRelationAggregateInput
Example
{
  "id": SortOrder,
  "blockNumber": SortOrder,
  "blockTimestamp": SortOrder,
  "value": SortOrder,
  "gasUsed": SortOrder,
  "gasPrice": SortOrder,
  "gasInEth": SortOrder,
  "from": WalletOrderByWithRelationInput,
  "fromAddress": SortOrder,
  "tokenTransfers": TokenTransferOrderByRelationAggregateInput,
  "sales": SaleOrderByRelationAggregateInput
}

TransactionRelationFilter

Input Field Description
is - TransactionWhereInput
isNot - TransactionWhereInput
Example
{
  "is": TransactionWhereInput,
  "isNot": TransactionWhereInput
}

TransactionScalarFieldEnum

Enum Value Description

id

blockNumber

blockTimestamp

value

gasUsed

gasPrice

gasInEth

fromAddress

TransactionWhereInput

Input Field Description
AND - [TransactionWhereInput!]
OR - [TransactionWhereInput!]
NOT - [TransactionWhereInput!]
id - StringFilter
blockNumber - BigIntFilter
blockTimestamp - DateTimeFilter
value - DecimalFilter
gasUsed - BigIntFilter
gasPrice - DecimalFilter
gasInEth - DecimalFilter
from - WalletRelationFilter
fromAddress - StringFilter
tokenTransfers - TokenTransferListRelationFilter
sales - SaleListRelationFilter
Example
{
  "AND": [TransactionWhereInput],
  "OR": [TransactionWhereInput],
  "NOT": [TransactionWhereInput],
  "id": StringFilter,
  "blockNumber": BigIntFilter,
  "blockTimestamp": DateTimeFilter,
  "value": DecimalFilter,
  "gasUsed": BigIntFilter,
  "gasPrice": DecimalFilter,
  "gasInEth": DecimalFilter,
  "from": WalletRelationFilter,
  "fromAddress": StringFilter,
  "tokenTransfers": TokenTransferListRelationFilter,
  "sales": SaleListRelationFilter
}

TransactionWhereUniqueInput

Input Field Description
id - String
Example
{"id": "abc123"}

Tweet

Tweet of notable user

Field Name Description
id - ID! id of the entry in DB
tweetId - String! Twitter API Tweet unique identifier
ownerId - String! Twitter API account unique identifier
timestamp - DateTime! Time of data
mentions - [TweetMention] List of collections mentioned in this tweet
Example
{
  "id": ID,
  "tweetId": "abc123",
  "ownerId": "abc123",
  "timestamp": DateTime,
  "mentions": [TweetMention]
}

TweetMention

Minimal information for mentioned username in tweet

Field Name Description
tweetId - String! Tweet id
username - String! Twitter username
Example
{"tweetId": "xyz789", "username": "abc123"}

TwitterMetrics

Twitter metrics for given NFT collection

Field Name Description
id - ID! id of the entry in DB
username - String! Twitter account username
twitterId - String! Twitter API account unique identifier
followersCount - Int! Followers count for this twitter account
followingCount - Int! Following count for this twitter account
tweetCount - Int! Tweets count for this twitter account
listedCount - Int! The number of public lists that this user is a member of
timestamp - DateTime! Time of data
Example
{
  "id": ID,
  "username": "xyz789",
  "twitterId": "xyz789",
  "followersCount": 123,
  "followingCount": 987,
  "tweetCount": 123,
  "listedCount": 123,
  "timestamp": DateTime
}

UpcomingCollection

Field Name Description
id - Int!
name - String!
imageUrl - String
externalUrl - String
discordUrl - String
maxSupply - Int
mintPrice - Float
Example
{
  "id": 987,
  "name": "abc123",
  "imageUrl": "xyz789",
  "externalUrl": "abc123",
  "discordUrl": "abc123",
  "maxSupply": 123,
  "mintPrice": 987.65
}

User

Field Name Description
id - Int!
role - String!
premiumExpiresAt - DateTime
createdAt - DateTime!
passBalance - Int
isDiscordLinked - Boolean
isPremium - Boolean
wallets - [Wallet!]!
walletId - String!
wallet - Wallet!
collectionBalance - Int!

Arguments

collectionId - String!

isCollectionHidden - Boolean!

Arguments

collectionId - String!

Example
{
  "id": 987,
  "role": "xyz789",
  "premiumExpiresAt": DateTime,
  "createdAt": DateTime,
  "passBalance": 987,
  "isDiscordLinked": true,
  "isPremium": true,
  "wallets": [Wallet],
  "walletId": "abc123",
  "wallet": Wallet,
  "collectionBalance": 123,
  "isCollectionHidden": false
}

Wallet

Model representing a wallet on the blockchain

Field Name Description
id - String! ID of wallet (wallet address)
name - String Name of wallet
openseaProfile - JSON The Opensea profile of the wallet. Available fields: 'profilePictureUrl', 'username', 'isVerified'
updatedAt - DateTime
_count - WalletCount
displayName - String! Suggested name for the wallet. Overriden if user specified a custom display name
tokenTransfers - [TokenTransfer!]! Token transfers involving wallet
realizedGains - [WalletRealizedGainsByCollection!]! Wallet realized gains. Includes collections where no gain was realized yet.

Arguments

filters - [FilterArg!]

searchTerm - String

orderDesc - Boolean default = true

orderBy - String default = "realizedGains"

take - Int default = 50

Number of entities to return in response (used for pagination)

skip - Int default = 0

Number of entities to skip (used for pagination)

portfolio - [PortfolioItem!]! Wallet collections held

Arguments

filters - [FilterArg!]

orderDesc - Boolean default = true

orderBy - String default = "estimatedValue"

search - String

take - Int default = 50

Number of entities to return in response (used for pagination)

skip - Int default = 0

Number of entities to skip (used for pagination)

activityChart - JSON Chart data for wallet buys, sells and listings

Arguments

filters - [FilterArg!]

collectionId - String

Filter activity by collection

period - String

totalPortfolioValue - Float Total portfolio value

Arguments

filters - [FilterArg!]

totalPortfolioValueByLiquidity - [PortfolioValue!] Total portfolio value by liquidity
analytics - WalletAnalytics! Wallet NFT activity metrics

Arguments

filters - [FilterArg!]

offers - [Offer!]
profitAndLossOverTime - JSON!

Arguments

filters - [FilterArg!]

collectionId - String

period - String default = "1y"

profitSource - JSON!

Arguments

filters - [FilterArg!]

collectionBalanceAndFloorOverTime - JSON!

Arguments

collectionId - String!

positionChanges - [WalletPositionChange!]!

Arguments

take - Int default = 50

Number of entities to return in response (used for pagination)

skip - Int default = 0

Number of entities to skip (used for pagination)

filters - [FilterArg!]

orderDesc - Boolean default = true

orderBy - String default = "tokenCountChange"

period - String default = "7d"

portfolioValueOverTime - JSON!

Arguments

filters - [FilterArg!]

collections - [WalletCollection!]!

Arguments

filters - [FilterArg!]

searchTerm - String

orderDesc - Boolean default = true

orderBy - String default = "realizedGains"

take - Int default = 50

Number of entities to return in response (used for pagination)

skip - Int default = 0

Number of entities to skip (used for pagination)

tokens - [Token!]! Tokens that the wallet currently holds

Arguments

owner - String

owners - [String!]

tokenId - String

tokenIdFrom - String

tokenIdTo - String

priceFrom - Float

priceTo - Float

rarityFrom - Int

rarityTo - Int

listingStatus - String

attributeValueIds - [String!]

attributeCount - Int

hideSpam - Boolean default = true

where - TokenWhereInput

take - Int

skip - Int

transfersFrom - [TokenTransfer!]! Token transfers where the wallet was the sender
transfersTo - [TokenTransfer!]! Token transfers where the wallet was the recipient
transactions - [Transaction!]! All blockchain transactions sent by wallet
ordersAsMaker - [Order!]! Token transfers where the wallet is the maker

Arguments

where - OrderWhereInput

take - Int

skip - Int

ordersAsTaker - [Order!]! Token transfers where the wallet is the taker

Arguments

where - OrderWhereInput

take - Int

skip - Int

relatedWallets - [Wallet!]!

Arguments

take - Int default = 50

Number of entities to return in response (used for pagination)

skip - Int default = 0

Number of entities to skip (used for pagination)

relatedWalletsV2 - [WalletRelation!]!

Arguments

take - Int default = 50

Number of entities to return in response (used for pagination)

skip - Int default = 0

Number of entities to skip (used for pagination)

ethBalance - Float!
lastActivityAt - DateTime
activity - [ActivityItem!]!

Arguments

filters - [FilterArg!]

take - Int default = 50

Number of entities to return in response (used for pagination)

skip - Int default = 0

Number of entities to skip (used for pagination)

tokensV2 - [Token!]!

Arguments

filters - [FilterArg!]

take - Int default = 50

Number of entities to return in response (used for pagination)

skip - Int default = 0

Number of entities to skip (used for pagination)

flips - [Flip!]!

Arguments

orderDesc - Boolean default = true

orderBy - String default = "soldAt"

filters - [FilterArg!]

take - Int default = 50

Number of entities to return in response (used for pagination)

skip - Int default = 0

Number of entities to skip (used for pagination)

nonce - String!
userId - Int!
passBalance - Int!
labels - [Label!]!
Example
{
  "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": 987.65,
  "lastActivityAt": DateTime,
  "activity": [ActivityItem],
  "tokensV2": [Token],
  "flips": [Flip],
  "nonce": "xyz789",
  "userId": 987,
  "passBalance": 987,
  "labels": [Label]
}

WalletAccessToken

Field Name Description
token - String!
Example
{"token": "abc123"}

WalletActivityFeedItem

Field Name Description
wallet - Wallet!
tokenTransfers - [TokenTransfer!]!
collection - Collection!
transaction - Transaction!
type - String!
Example
{
  "wallet": Wallet,
  "tokenTransfers": [TokenTransfer],
  "collection": Collection,
  "transaction": Transaction,
  "type": "xyz789"
}

WalletAnalytics

Field Name Description
totalSpent - Float Total ETH spent on NFTs
totalRevenue - Float Total ETH received from selling NFTs
totalProfit - Float Total profit of wallet
totalRealizedGains - Float Total realized gains
totalGasSpent - Float Total gas spent
Example
{
  "totalSpent": 987.65,
  "totalRevenue": 123.45,
  "totalProfit": 123.45,
  "totalRealizedGains": 987.65,
  "totalGasSpent": 987.65
}

WalletBalance

Field Name Description
wallet - Wallet!
collectionId - Collection!
balance - Int
change6h - Int
change1d - Int
change3d - Int
change7d - Int
profitAndLoss - Float
unrealizedProfitAndLoss - Float
Example
{
  "wallet": Wallet,
  "collectionId": Collection,
  "balance": 123,
  "change6h": 987,
  "change1d": 123,
  "change3d": 987,
  "change7d": 123,
  "profitAndLoss": 123.45,
  "unrealizedProfitAndLoss": 987.65
}

WalletCollection

Field Name Description
id - String!
collection - Collection!
avgInvested - Float
totalInvested - Float
totalGasSpent - Float
totalReceived - Float
tokensIn - Int
tokensOut - Int
balance - Int
estimatedValue - Float
tokensSold - Int
realizedGains - Float
unrealizedGains - Float
Example
{
  "id": "xyz789",
  "collection": Collection,
  "avgInvested": 987.65,
  "totalInvested": 987.65,
  "totalGasSpent": 987.65,
  "totalReceived": 123.45,
  "tokensIn": 123,
  "tokensOut": 987,
  "balance": 987,
  "estimatedValue": 987.65,
  "tokensSold": 987,
  "realizedGains": 987.65,
  "unrealizedGains": 123.45
}

WalletCount

Field Name Description
tokens - Int!
transfersFrom - Int!
transfersTo - Int!
transactions - Int!
favoriteWallets - Int!
favoritedBy - Int!
favoriteCollections - Int!
alerts - Int!
channels - Int!
ordersAsMaker - Int!
ordersAsTaker - Int!
flips - Int!
WashTradersByMarketplaceMV - Int!
Example
{
  "tokens": 123,
  "transfersFrom": 987,
  "transfersTo": 123,
  "transactions": 987,
  "favoriteWallets": 987,
  "favoritedBy": 123,
  "favoriteCollections": 987,
  "alerts": 123,
  "channels": 123,
  "ordersAsMaker": 987,
  "ordersAsTaker": 987,
  "flips": 987,
  "WashTradersByMarketplaceMV": 987
}

WalletOrderByWithRelationInput

Example
{
  "id": SortOrder,
  "tokens": TokenOrderByRelationAggregateInput,
  "transfersFrom": TokenTransferOrderByRelationAggregateInput,
  "transfersTo": TokenTransferOrderByRelationAggregateInput,
  "transactions": TransactionOrderByRelationAggregateInput,
  "name": SortOrder,
  "openseaProfile": SortOrder,
  "updatedAt": SortOrder,
  "ordersAsMaker": OrderOrderByRelationAggregateInput,
  "ordersAsTaker": OrderOrderByRelationAggregateInput,
  "flips": FlipOrderByRelationAggregateInput,
  "WashTradersByMarketplaceMV": WashTradersByMarketplaceMVOrderByRelationAggregateInput
}

WalletPositionChange

Field Name Description
id - String!
collection - Collection!
positionChange - Float!
tokenCountChange - Int!
Example
{
  "id": "abc123",
  "collection": Collection,
  "positionChange": 987.65,
  "tokenCountChange": 123
}

WalletRealizedGainsByCollection

Field Name Description
id - String!
collection - Collection!
totalPaid - Float
totalGasSpent - Float
totalReceived - Float
tokensIn - Int
tokensOut - Int
tokensSold - Int
realizedGains - Float
Example
{
  "id": "xyz789",
  "collection": Collection,
  "totalPaid": 987.65,
  "totalGasSpent": 987.65,
  "totalReceived": 987.65,
  "tokensIn": 987,
  "tokensOut": 987,
  "tokensSold": 123,
  "realizedGains": 987.65
}

WalletRelation

Field Name Description
wallet - Wallet!
transferCount - Int!
Example
{"wallet": Wallet, "transferCount": 987}

WalletRelationFilter

Input Field Description
is - WalletWhereInput
isNot - WalletWhereInput
Example
{
  "is": WalletWhereInput,
  "isNot": WalletWhereInput
}

WalletScalarFieldEnum

Enum Value Description

id

name

openseaProfile

updatedAt

nonce

WalletWatchlist

Field Name Description
id - Int!
name - String!
slug - String!
isPublic - Boolean!
createdAt - DateTime!
status - WatchlistStatus!
isPinned - Boolean!
memberCount - Int!
isMember - Boolean!

Arguments

id - String!

members - [Wallet!]!
flips - [Flip!]!

Arguments

orderDesc - Boolean default = true

orderBy - String default = "soldAt"

filters - [FilterArg!]

take - Int default = 50

Number of entities to return in response (used for pagination)

skip - Int default = 0

Number of entities to skip (used for pagination)

totalPortfolioValue - Float Total portfolio value

Arguments

filters - [FilterArg!]

totalPortfolioValueByLiquidity - [PortfolioValue!] Total portfolio value by liquidity
analytics - WalletAnalytics! Wallet NFT activity metrics

Arguments

filters - [FilterArg!]

profitAndLossOverTime - JSON!

Arguments

filters - [FilterArg!]

collectionId - String

period - String default = "1y"

profitSource - JSON!

Arguments

filters - [FilterArg!]

collectionBalanceAndFloorOverTime - JSON!

Arguments

collectionId - String!

positionChanges - [WalletPositionChange!]!

Arguments

take - Int default = 50

Number of entities to return in response (used for pagination)

skip - Int default = 0

Number of entities to skip (used for pagination)

filters - [FilterArg!]

orderDesc - Boolean default = true

orderBy - String default = "tokenCountChange"

period - String default = "7d"

portfolioValueOverTime - JSON!

Arguments

filters - [FilterArg!]

activityChart - JSON Chart data for watchlist buys, sells and listings

Arguments

filters - [FilterArg!]

collectionId - String

Filter activity by collection

period - String

tokens - [Token!]!

Arguments

filters - [FilterArg!]

take - Int default = 50

Number of entities to return in response (used for pagination)

skip - Int default = 0

Number of entities to skip (used for pagination)

activity - [ActivityItem!]!

Arguments

filters - [FilterArg!]

take - Int default = 50

Number of entities to return in response (used for pagination)

skip - Int default = 0

Number of entities to skip (used for pagination)

collections - [WalletCollection!]!

Arguments

filters - [FilterArg!]

searchTerm - String

orderDesc - Boolean default = true

orderBy - String default = "realizedGains"

take - Int default = 50

Number of entities to return in response (used for pagination)

skip - Int default = 0

Number of entities to skip (used for pagination)

relatedWallets - [WalletRelation!]!

Arguments

take - Int default = 50

Number of entities to return in response (used for pagination)

skip - Int default = 0

Number of entities to skip (used for pagination)

feed - [EventFeedItem!]! Get latest events for your favorite wallets and collections

Arguments

take - Int default = 20

skip - Int default = 0

types - [EventType!]

Example
{
  "id": 123,
  "name": "xyz789",
  "slug": "xyz789",
  "isPublic": false,
  "createdAt": DateTime,
  "status": WatchlistStatus,
  "isPinned": true,
  "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]
}

WalletWhereInput

Example
{
  "AND": [WalletWhereInput],
  "OR": [WalletWhereInput],
  "NOT": [WalletWhereInput],
  "id": StringFilter,
  "tokens": TokenListRelationFilter,
  "transfersFrom": TokenTransferListRelationFilter,
  "transfersTo": TokenTransferListRelationFilter,
  "transactions": TransactionListRelationFilter,
  "name": StringNullableFilter,
  "openseaProfile": JsonNullableFilter,
  "updatedAt": DateTimeNullableFilter,
  "ordersAsMaker": OrderListRelationFilter,
  "ordersAsTaker": OrderListRelationFilter,
  "flips": FlipListRelationFilter,
  "WashTradersByMarketplaceMV": WashTradersByMarketplaceMVListRelationFilter
}

WalletWhereUniqueInput

Input Field Description
id - String
Example
{"id": "xyz789"}

WashTradersByMarketplaceMVListRelationFilter

Example
{
  "every": WashTradersByMarketplaceMVWhereInput,
  "some": WashTradersByMarketplaceMVWhereInput,
  "none": WashTradersByMarketplaceMVWhereInput
}

WashTradersByMarketplaceMVOrderByRelationAggregateInput

Input Field Description
_count - SortOrder
Example
{"_count": SortOrder}

WashTradersByMarketplaceMVWhereInput

Example
{
  "AND": [WashTradersByMarketplaceMVWhereInput],
  "OR": [WashTradersByMarketplaceMVWhereInput],
  "NOT": [WashTradersByMarketplaceMVWhereInput],
  "marketplace": IntFilter,
  "walletId": StringFilter,
  "wallet": WalletRelationFilter,
  "count": IntFilter
}

WatchlistStatus

Enum Value Description

DRAFT

PUBLISHED

WhitelistCollectionPrize

Field Name Description
upcomingCollection - UpcomingCollection!
numberOfSpots - Int!
numberOfSpotsRemaining - Int!
Example
{
  "upcomingCollection": UpcomingCollection,
  "numberOfSpots": 987,
  "numberOfSpotsRemaining": 987
}