AddEventsByMakerOutput

Response returned by onEventsCreatedByMaker.

makerAddress
String!
required

The address of the maker.

events
[Event!]!
required

A list of transactions for the maker.

"""Response returned by `onEventsCreatedByMaker`."""
type AddEventsByMakerOutput {
  """The address of the maker."""
  makerAddress: String!
  """A list of transactions for the maker."""
  events: [Event!]!
}

AddEventsOutput

Response returned by onEventsCreated.

address
String!
required

The contract address of the pair.

networkId
Int!
required

The network ID that the token is deployed on.

id
String!
required

The ID of the event (address:networkId). For example, 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2:1.

quoteToken
QuoteToken

The token of interest within the pair. Can be token0 or token1.

events
[Event]!
required

A list of transactions for the token.

"""Response returned by `onEventsCreated`."""
type AddEventsOutput {
  """The contract address of the pair."""
  address: String!
  """The network ID that the token is deployed on."""
  networkId: Int!
  """The ID of the event (`address`:`networkId`). For example, `0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2:1`."""
  id: String!
  """The token of interest within the pair. Can be `token0` or `token1`."""
  quoteToken: QuoteToken
  """A list of transactions for the token."""
  events: [Event]!
}

AddNftEventsOutput

Response returned by onNftEventsCreated.

address
String!
required

The contract address of the NFT collection.

networkId
Int!
required

The network ID the collection is deployed on.

id
String!
required

The id of the collection (address:networkId).

events
[NftEvent]!
required

A list of NFT transactions streaming real-time.

"""Response returned by `onNftEventsCreated`."""
type AddNftEventsOutput {
  """The contract address of the NFT collection."""
  address: String!
  """The network ID the collection is deployed on."""
  networkId: Int!
  """The id of the collection (`address`:`networkId`)."""
  id: String!
  """A list of NFT transactions streaming real-time."""
  events: [NftEvent]!
}

AddNftPoolEventsOutput

Response returned by onNftPoolEventsCreated.

collectionAddress
String!
required

No description provided

exchangeAddress
String!
required

No description provided

poolAddress
String!
required

No description provided

networkId
Int!
required

No description provided

id
String!
required

No description provided

events
[NftPoolEvent]!
required

No description provided

"""Response returned by `onNftPoolEventsCreated`."""
type AddNftPoolEventsOutput {
  collectionAddress: String!
  exchangeAddress: String!
  poolAddress: String!
  networkId: Int!
  id: String!
  events: [NftPoolEvent]!
}

AddTokenEventsOutput

Response returned by onTokenEventsCreated.

id
String!
required

The ID of the event (address:networkId). For example, 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2:1.

events
[Event!]!
required

A list of transactions for the token.

"""Response returned by `onTokenEventsCreated`."""
type AddTokenEventsOutput {
  """The ID of the event (`address`:`networkId`). For example, `0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2:1`."""
  id: String!
  """A list of transactions for the token."""
  events: [Event!]!
}

AddTokenLifecycleEventsOutput

Response returned by onTokenLifecycleEventsCreated.

id
String!
required

No description provided

events
[TokenLifecycleEvent!]!
required

No description provided

"""Response returned by `onTokenLifecycleEventsCreated`."""
type AddTokenLifecycleEventsOutput {
  id: String!
  events: [TokenLifecycleEvent!]!
}

AddUnconfirmedEventsByMakerOutput

Response returned by onUnconfirmedEventsCreatedByMaker.

makerAddress
String!
required

The wallet address of the maker.

events
[UnconfirmedEvent!]!
required

A list of transactions for the maker.

"""Response returned by `onUnconfirmedEventsCreatedByMaker`."""
type AddUnconfirmedEventsByMakerOutput {
  """The wallet address of the maker."""
  makerAddress: String!
  """A list of transactions for the maker."""
  events: [UnconfirmedEvent!]!
}

AddUnconfirmedEventsOutput

Response returned by onUnconfirmedEventsCreated.

address
String!
required

The contract address of the pair.

networkId
Int!
required

The network ID that the token is deployed on.

id
String!
required

The ID of the event (address:networkId). For example, 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2:1.

quoteToken
QuoteToken

The token of interest within the pair. Can be token0 or token1.

events
[UnconfirmedEvent]!
required

A list of transactions for the token.

"""Response returned by `onUnconfirmedEventsCreated`."""
type AddUnconfirmedEventsOutput {
  """The contract address of the pair."""
  address: String!
  """The network ID that the token is deployed on."""
  networkId: Int!
  """The ID of the event (`address`:`networkId`). For example, `0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2:1`."""
  id: String!
  """The token of interest within the pair. Can be `token0` or `token1`."""
  quoteToken: QuoteToken
  """A list of transactions for the token."""
  events: [UnconfirmedEvent]!
}

ApiToken

id
String!
required

Unique identifier for the token

token
String!
required

JWT to be passed into the Authorization header for API requests

expiresTimeString
String!
required

ISO time string for the expiry of the token

requestLimit
String!
required

Number of root fields this api token is allowed to resolve before it’s rate limited

remaining
String

Approximate number of remaining resolutions before this token is rate limited

type ApiToken {
  """Unique identifier for the token"""
  id: String!
  """JWT to be passed into the Authorization header for API requests"""
  token: String!
  """ISO time string for the expiry of the token"""
  expiresTimeString: String!
  """Number of root fields this api token is allowed to resolve before it's rate limited"""
  requestLimit: String!
  """Approximate number of remaining resolutions before this token is rate limited"""
  remaining: String
}

Balance

Wallet balance of a token.

walletId
String!
required

The ID of the wallet (walletAddress:networkId).

tokenId
String!
required

The ID of the token (tokenAddress:networkId).

address
String!
required

The wallet address.

networkId
Int!
required

The wallet network.

tokenAddress
String!
required

The contract address of the token.

balance
String!
required

The balance held by the wallet.

shiftedBalance
Float!
required

The balance held by the wallet, adjusted by the number of decimals in the token.

balanceUsd
String

The balance held by the wallet in USD.

tokenPriceUsd
String

The token price in USD.

firstHeldTimestamp
Int

The time that this address first held a token.

token
EnhancedToken

Metadata for the token.

"""Wallet balance of a token."""
type Balance {
  """The ID of the wallet (`walletAddress:networkId`)."""
  walletId: String!
  """The ID of the token (`tokenAddress:networkId`)."""
  tokenId: String!
  """The wallet address."""
  address: String!
  """The wallet network."""
  networkId: Int!
  """The contract address of the token."""
  tokenAddress: String!
  """The balance held by the wallet."""
  balance: String!
  """The balance held by the wallet, adjusted by the number of decimals in the token."""
  shiftedBalance: Float!
  """The balance held by the wallet in USD."""
  balanceUsd: String
  """The token price in USD."""
  tokenPriceUsd: String
  """The time that this address first held a token."""
  firstHeldTimestamp: Int
  """Metadata for the token."""
  token: EnhancedToken
}

BalancesResponse

items
[Balance!]!
required

The list of token balances that a wallet has.

cursor
String

A cursor for use in pagination.

type BalancesResponse {
  """The list of token balances that a wallet has."""
  items: [Balance!]!
  """A cursor for use in pagination."""
  cursor: String
}

BarsResponse

Bar chart data to track price changes over time.

o
[Float]!
required

The opening price.

h
[Float]!
required

The high price.

l
[Float]!
required

The low price.

c
[Float]!
required

The closing price.

v
[Int]!
required

The volume.

This field is deprecated. Use volume field instead

t
[Int!]!
required

The timestamp for the bar.

s
String!
required

The status code for the batch: ok for successful data retrieval and no_data for empty responses signaling the end of server data.

volume
[String]

The volume with higher precision.

volumeNativeToken
[String]

The volume in the native token for the network

buyers
[Int]!
required

The number of unique buyers

buys
[Int]!
required

The number of buys

buyVolume
[String]!
required

The buy volume in USD

sellers
[Int]!
required

The number of unique sellers

sells
[Int]!
required

The number of sells

sellVolume
[String]!
required

The sell volume in USD

liquidity
[String]!
required

Liquidity in USD

traders
[Int]!
required

The number of traders

transactions
[Int]!
required

The number of transactions

pair
Pair!
required

The pair that is being returned

"""Bar chart data to track price changes over time."""
type BarsResponse {
  """The opening price."""
  o: [Float]!
  """The high price."""
  h: [Float]!
  """The low price."""
  l: [Float]!
  """The closing price."""
  c: [Float]!
  """The volume."""
  v: [Int]! @deprecated(reason: "Use volume field instead")
  """The timestamp for the bar."""
  t: [Int!]!
  """The status code for the batch: `ok` for successful data retrieval and `no_data` for empty responses signaling the end of server data."""
  s: String!
  """The volume with higher precision."""
  volume: [String]
  """The volume in the native token for the network"""
  volumeNativeToken: [String]
  """The number of unique buyers"""
  buyers: [Int]!
  """The number of buys"""
  buys: [Int]!
  """The buy volume in USD"""
  buyVolume: [String]!
  """The number of unique sellers"""
  sellers: [Int]!
  """The number of sells"""
  sells: [Int]!
  """The sell volume in USD"""
  sellVolume: [String]!
  """Liquidity in USD"""
  liquidity: [String]!
  """The number of traders"""
  traders: [Int]!
  """The number of transactions"""
  transactions: [Int]!
  """The pair that is being returned"""
  pair: Pair!
}

BurnEventData

Event data for a token burn event.

amount0
String

The amount of token0 removed from the pair.

amount1
String

The amount of token1 removed from the pair.

amount0Shifted
String

The amount of token0 removed from the pair, adjusted by the number of decimals in the token. For example, if amount0 is in WEI, amount0Shifted will be in ETH.

amount1Shifted
String

The amount of token1 removed from the pair, adjusted by the number of decimals in the token. For example, USDC amount1Shifted will be by 6 decimals.

tickLower
String

The lower tick boundary of the position. Only applicable for UniswapV3 events.

tickUpper
String

The upper tick boundary of the position. Only applicable for UniswapV3 events.

type
EventType!
required

The type of token event, Burn.

"""Event data for a token burn event."""
type BurnEventData {
  """The amount of `token0` removed from the pair."""
  amount0: String
  """The amount of `token1` removed from the pair."""
  amount1: String
  """The amount of `token0` removed from the pair, adjusted by the number of decimals in the token. For example, if `amount0` is in WEI, `amount0Shifted` will be in ETH."""
  amount0Shifted: String
  """The amount of `token1` removed from the pair, adjusted by the number of decimals in the token. For example, USDC `amount1Shifted` will be by 6 decimals."""
  amount1Shifted: String
  """The lower tick boundary of the position. Only applicable for UniswapV3 events."""
  tickLower: String
  """The upper tick boundary of the position. Only applicable for UniswapV3 events."""
  tickUpper: String
  """The type of token event, `Burn`."""
  type: EventType!
}

ChartUrl

The chart url.

url
String!
required

The chart url.

"""The chart url."""
type ChartUrl {
  """The chart url."""
  url: String!
}

ChartUrlsResponse

The response type for a chart url query.

pair
ChartUrl!
required

The pair chart url.

"""The response type for a chart url query."""
type ChartUrlsResponse {
  """The pair chart url."""
  pair: ChartUrl!
}

CommunityNote

Community gathered proposals for an asset.

address
String!
required

The contract address of the contract.

contractType
ContractType!
required

No description provided

currentContract
EnhancedContract

No description provided

currentData
JSON

The contract after the community note was applied.

id
String!
required

The ID of the contract (address:id).

moderatedAt
Int

The unix timestamp of when the community note was moderated.

networkId
Int!
required

The network ID the contract is deployed on.

previousData
JSON

The contract before the community note was applied.

proposalData
JSON!
required

The data of the community note.

proposalNum
Int!
required

The ordinal number of the community note.

proposalType
CommunityNoteType!
required

The type of the community note.

proposedAt
Int!
required

The unix timestamp of when the community note was created.

status
ContractProposalStatus!
required

The status of the community note.

sortKey
String!
required

No description provided

"""Community gathered proposals for an asset."""
type CommunityNote {
  """The contract address of the contract."""
  address: String!
  contractType: ContractType!
  currentContract: EnhancedContract
  """The contract after the community note was applied."""
  currentData: JSON
  """The ID of the contract (`address:id`)."""
  id: String!
  """The unix timestamp of when the community note was moderated."""
  moderatedAt: Int
  """The network ID the contract is deployed on."""
  networkId: Int!
  """The contract before the community note was applied."""
  previousData: JSON
  """The data of the community note."""
  proposalData: JSON!
  """The ordinal number of the community note."""
  proposalNum: Int!
  """The type of the community note."""
  proposalType: CommunityNoteType!
  """The unix timestamp of when the community note was created."""
  proposedAt: Int!
  """The status of the community note."""
  status: ContractProposalStatus!
  sortKey: String!
}

CommunityNotesResponse

Community notes data.

items
[CommunityNote!]!
required

The list of community notes matching the filter parameters.

count
Int!
required

The number of community notes returned.

cursor
String

A cursor for use in pagination.

"""Community notes data."""
type CommunityNotesResponse {
  """The list of community notes matching the filter parameters."""
  items: [CommunityNote!]!
  """The number of community notes returned."""
  count: Int!
  """A cursor for use in pagination."""
  cursor: String
}

ComparisonOperator

Comparison operators.

gt
String

Greater than.

gte
String

Greater than or equal to.

lt
String

Less than.

lte
String

Less than or equal to.

eq
String

Equal to.

"""Comparison operators."""
type ComparisonOperator {
  """Greater than."""
  gt: String
  """Greater than or equal to."""
  gte: String
  """Less than."""
  lt: String
  """Less than or equal to."""
  lte: String
  """Equal to."""
  eq: String
}

ContractLabel

Metadata for a contract label.

createdAt
Int!
required

The unix timestamp for when the contract label was created.

subType
ContractLabelSubType!
required

The contract label sub-type. Can be Generic, HighTax, HoneyPot or Imitator.

type
ContractLabelType!
required

The contract label type. Can be Scam.

"""Metadata for a contract label."""
type ContractLabel {
  """The unix timestamp for when the contract label was created."""
  createdAt: Int!
  """The contract label sub-type. Can be `Generic`, `HighTax`, `HoneyPot` or `Imitator`."""
  subType: ContractLabelSubType!
  """The contract label type. Can be `Scam`."""
  type: ContractLabelType!
}

CreateWebhooksOutput

Result returned by createWebhooks.

priceWebhooks
[Webhook]!
required

The list of price webhooks that were created.

tokenPairEventWebhooks
[Webhook]!
required

The list of token pair event webhooks that were created.

nftEventWebhooks
[Webhook]!
required

The list of NFT event webhooks that were created.

rawTransactionWebhooks
[Webhook]!
required

The list of raw transaction webhooks that were created.

marketCapWebhooks
[Webhook]!
required

The list of market cap event webhooks that were created.

"""Result returned by `createWebhooks`."""
type CreateWebhooksOutput {
  """The list of price webhooks that were created."""
  priceWebhooks: [Webhook]!
  """The list of token pair event webhooks that were created."""
  tokenPairEventWebhooks: [Webhook]!
  """The list of NFT event webhooks that were created."""
  nftEventWebhooks: [Webhook]!
  """The list of raw transaction webhooks that were created."""
  rawTransactionWebhooks: [Webhook]!
  """The list of market cap event webhooks that were created."""
  marketCapWebhooks: [Webhook]!
}

CurrencyBarData

Price data for a bar at a specific resolution.

t
Int!
required

The timestamp for the bar.

usd
IndividualBarData!
required

Bar chart data in USD.

token
IndividualBarData!
required

Bar chart data in the network’s base token.

"""Price data for a bar at a specific resolution."""
type CurrencyBarData {
  """The timestamp for the bar."""
  t: Int!
  """Bar chart data in USD."""
  usd: IndividualBarData!
  """Bar chart data in the network's base token."""
  token: IndividualBarData!
}

DeleteWebhooksOutput

Result returned by deleteWebhooks.

deletedIds
[String]

The list of webhook IDs that were deleted.

"""Result returned by `deleteWebhooks`."""
type DeleteWebhooksOutput {
  """The list of webhook IDs that were deleted."""
  deletedIds: [String]
}

DetailedNftStats

Detailed stats for an NFT collection.

collectionAddress
String!
required

The contract address of the NFT collection.

networkId
Int!
required

The network ID the NFT collection is deployed on.

grouping
String

The marketplace address or all. Can be used to get marketplace-specific metrics.

stats_hour1
WindowedDetailedNftStats

The breakdown of stats over an hour window.

stats_hour4
WindowedDetailedNftStats

The breakdown of stats over a 4 hour window.

stats_hour12
WindowedDetailedNftStats

The breakdown of stats over a 12 hour window.

stats_day1
WindowedDetailedNftStats

The breakdown of stats over a 24 hour window.

stats_week1
WindowedDetailedNftStats

The breakdown of stats over a 7 day window.

stats_day30
WindowedDetailedNftStats

The breakdown of stats over a 30 day window.

"""Detailed stats for an NFT collection."""
type DetailedNftStats {
  """The contract address of the NFT collection."""
  collectionAddress: String!
  """The network ID the NFT collection is deployed on."""
  networkId: Int!
  """The marketplace address or `all`. Can be used to get marketplace-specific metrics."""
  grouping: String
  """The breakdown of stats over an hour window."""
  stats_hour1: WindowedDetailedNftStats
  """The breakdown of stats over a 4 hour window."""
  stats_hour4: WindowedDetailedNftStats
  """The breakdown of stats over a 12 hour window."""
  stats_hour12: WindowedDetailedNftStats
  """The breakdown of stats over a 24 hour window."""
  stats_day1: WindowedDetailedNftStats
  """The breakdown of stats over a 7 day window."""
  stats_week1: WindowedDetailedNftStats
  """The breakdown of stats over a 30 day window."""
  stats_day30: WindowedDetailedNftStats
}

DetailedNftStatsBucketTimestamp

The start/end timestamp for a given bucket within the window.

start
Int!
required

The unix timestamp for the start of the window.

end
Int!
required

The unix timestamp for the end of the window.

"""The start/end timestamp for a given bucket within the window."""
type DetailedNftStatsBucketTimestamp {
  """The unix timestamp for the start of the window."""
  start: Int!
  """The unix timestamp for the end of the window."""
  end: Int!
}

DetailedNftStatsNumberMetrics

Number metrics for detailed NFT stats.

change
Float

The percent change between the currentValue and previousValue.

currentValue
Int

The total value for the most recent duration.

previousValue
Int

The total value for the previous duration.

buckets
[Int]!
required

The list of aggregated values for each bucket.

"""Number metrics for detailed NFT stats."""
type DetailedNftStatsNumberMetrics {
  """The percent change between the `currentValue` and `previousValue`."""
  change: Float
  """The total value for the most recent duration."""
  currentValue: Int
  """The total value for the previous duration."""
  previousValue: Int
  """The list of aggregated values for each bucket."""
  buckets: [Int]!
}

DetailedNftStatsStringMetrics

String metrics for detailed NFT stats.

change
Float

The percent change between the currentValue and previousValue.

currentValue
String

The total value for the most recent duration.

previousValue
String

The total value for the previous duration.

buckets
[String]!
required

The list of aggregated values for each bucket.

"""String metrics for detailed NFT stats."""
type DetailedNftStatsStringMetrics {
  """The percent change between the `currentValue` and `previousValue`."""
  change: Float
  """The total value for the most recent duration."""
  currentValue: String
  """The total value for the previous duration."""
  previousValue: String
  """The list of aggregated values for each bucket."""
  buckets: [String]!
}

DetailedPairStats

Detailed stats for a token within a pair.

pairAddress
String!
required

The contract address of the pair.

networkId
Int!
required

The network ID the pair is deployed on.

tokenOfInterest
TokenOfInterest

The token of interest used to calculate token-specific stats.

lastTransaction
Int

The unix timestamp for the last transaction to happen on the pair.

statsType
TokenPairStatisticsType!
required

The type of statistics returned. Can be FILTERED or UNFILTERED

stats_min5
WindowedDetailedPairStats

The breakdown of stats over a 5 minute window.

stats_min15
WindowedDetailedPairStats

The breakdown of stats over a 15 minute window.

stats_hour1
WindowedDetailedPairStats

The breakdown of stats over an hour window.

stats_hour4
WindowedDetailedPairStats

The breakdown of stats over a 4 hour window.

stats_hour12
WindowedDetailedPairStats

The breakdown of stats over a 12 hour window.

stats_day1
WindowedDetailedPairStats

The breakdown of stats over a 24 hour window.

stats_week1
WindowedDetailedPairStats

The breakdown of stats over a 7 day window.

stats_day30
WindowedDetailedPairStats

The breakdown of stats over a 30 day window.

bucketCount
Int

Number of aggregated buckets specified in input

queryTimestamp
Int

The timestamp specified as input to the query

pair
Pair

No description provided

"""Detailed stats for a token within a pair."""
type DetailedPairStats {
  """The contract address of the pair."""
  pairAddress: String!
  """The network ID the pair is deployed on."""
  networkId: Int!
  """The token of interest used to calculate token-specific stats."""
  tokenOfInterest: TokenOfInterest
  """The unix timestamp for the last transaction to happen on the pair."""
  lastTransaction: Int
  """The type of statistics returned. Can be `FILTERED` or `UNFILTERED`"""
  statsType: TokenPairStatisticsType!
  """The breakdown of stats over a 5 minute window."""
  stats_min5: WindowedDetailedPairStats
  """The breakdown of stats over a 15 minute window."""
  stats_min15: WindowedDetailedPairStats
  """The breakdown of stats over an hour window."""
  stats_hour1: WindowedDetailedPairStats
  """The breakdown of stats over a 4 hour window."""
  stats_hour4: WindowedDetailedPairStats
  """The breakdown of stats over a 12 hour window."""
  stats_hour12: WindowedDetailedPairStats
  """The breakdown of stats over a 24 hour window."""
  stats_day1: WindowedDetailedPairStats
  """The breakdown of stats over a 7 day window."""
  stats_week1: WindowedDetailedPairStats
  """The breakdown of stats over a 30 day window."""
  stats_day30: WindowedDetailedPairStats
  """Number of aggregated buckets specified in input"""
  bucketCount: Int
  """The timestamp specified as input to the query"""
  queryTimestamp: Int
  pair: Pair
}

DetailedPairStatsBucketTimestamp

The start/end timestamp for a given bucket within the window.

start
Int!
required

The unix timestamp for the start of the bucket.

end
Int!
required

The unix timestamp for the start of the bucket.

"""The start/end timestamp for a given bucket within the window."""
type DetailedPairStatsBucketTimestamp {
  """The unix timestamp for the start of the bucket."""
  start: Int!
  """The unix timestamp for the start of the bucket."""
  end: Int!
}

DetailedPairStatsNumberMetrics

Number metrics for detailed pair stats.

change
Float

The percent change between the currentValue and previousValue. Decimal format.

currentValue
Int

The total value for the most recent duration.

previousValue
Int

The total value for the previous duration.

buckets
[Int]!
required

The list of aggregated values for each bucket.

"""Number metrics for detailed pair stats."""
type DetailedPairStatsNumberMetrics {
  """The percent change between the `currentValue` and `previousValue`. Decimal format."""
  change: Float
  """The total value for the most recent duration."""
  currentValue: Int
  """The total value for the previous duration."""
  previousValue: Int
  """The list of aggregated values for each bucket."""
  buckets: [Int]!
}

DetailedPairStatsStringMetrics

String metrics for detailed pair stats.

change
Float

The percent change between the currentValue and previousValue. Decimal format.

currentValue
String

The total value for the most recent duration.

previousValue
String

The total value for the previous duration.

buckets
[String]!
required

The list of aggregated values for each bucket.

"""String metrics for detailed pair stats."""
type DetailedPairStatsStringMetrics {
  """The percent change between the `currentValue` and `previousValue`. Decimal format."""
  change: Float
  """The total value for the most recent duration."""
  currentValue: String
  """The total value for the previous duration."""
  previousValue: String
  """The list of aggregated values for each bucket."""
  buckets: [String]!
}

DetailedStats

Detailed stats for a token within a pair.

pairId
String!
required

The ID of the pair (pairAddress:networkId).

tokenOfInterest
TokenOfInterest!
required

The token of interest used to calculate token-specific stats.

statsType
TokenPairStatisticsType!
required

The type of statistics returned. Can be FILTERED or UNFILTERED

stats_min5
WindowedDetailedStats

The breakdown of stats over a 5 minute window.

stats_hour1
WindowedDetailedStats

The breakdown of stats over an hour window.

stats_hour4
WindowedDetailedStats

The breakdown of stats over a 4 hour window.

stats_hour12
WindowedDetailedStats

The breakdown of stats over a 12 hour window.

stats_day1
WindowedDetailedStats

The breakdown of stats over a 24 hour window.

bucketCount
Int

Number of aggregated buckets specified in input

queryTimestamp
Int

The timestamp specified as input to the query

"""Detailed stats for a token within a pair."""
type DetailedStats {
  """The ID of the pair (`pairAddress:networkId`)."""
  pairId: String!
  """The token of interest used to calculate token-specific stats."""
  tokenOfInterest: TokenOfInterest!
  """The type of statistics returned. Can be `FILTERED` or `UNFILTERED`"""
  statsType: TokenPairStatisticsType!
  """The breakdown of stats over a 5 minute window."""
  stats_min5: WindowedDetailedStats
  """The breakdown of stats over an hour window."""
  stats_hour1: WindowedDetailedStats
  """The breakdown of stats over a 4 hour window."""
  stats_hour4: WindowedDetailedStats
  """The breakdown of stats over a 12 hour window."""
  stats_hour12: WindowedDetailedStats
  """The breakdown of stats over a 24 hour window."""
  stats_day1: WindowedDetailedStats
  """Number of aggregated buckets specified in input"""
  bucketCount: Int
  """The timestamp specified as input to the query"""
  queryTimestamp: Int
}

DetailedStatsBucketTimestamp

The start/end timestamp for a given bucket within the window.

start
Int!
required

The unix timestamp for the start of the bucket.

end
Int!
required

The unix timestamp for the start of the bucket.

"""The start/end timestamp for a given bucket within the window."""
type DetailedStatsBucketTimestamp {
  """The unix timestamp for the start of the bucket."""
  start: Int!
  """The unix timestamp for the start of the bucket."""
  end: Int!
}

DetailedStatsNumberMetrics

Number metrics for detailed stats.

change
Float!
required

The percent change between the currentValue and previousValue. Decimal format.

currentValue
Int!
required

The total value for the most recent window.

previousValue
Int!
required

The total value for the previous window.

buckets
[Int]!
required

The list of aggregated values for each bucket.

"""Number metrics for detailed stats."""
type DetailedStatsNumberMetrics {
  """The percent change between the `currentValue` and `previousValue`. Decimal format."""
  change: Float!
  """The total value for the most recent window."""
  currentValue: Int!
  """The total value for the previous window."""
  previousValue: Int!
  """The list of aggregated values for each bucket."""
  buckets: [Int]!
}

DetailedStatsStringMetrics

String metrics for detailed stats.

change
Float!
required

The percent change between the currentValue and previousValue. Decimal format.

currentValue
String!
required

The total value for the most recent window.

previousValue
String!
required

The total value for the previous window.

buckets
[String]!
required

The list of aggregated values for each bucket.

"""String metrics for detailed stats."""
type DetailedStatsStringMetrics {
  """The percent change between the `currentValue` and `previousValue`. Decimal format."""
  change: Float!
  """The total value for the most recent window."""
  currentValue: String!
  """The total value for the previous window."""
  previousValue: String!
  """The list of aggregated values for each bucket."""
  buckets: [String]!
}

DetailedWalletStats

The detailed stats for a wallet.

walletAddress
String!
required

The wallet address

lastTransactionAt
Int!
required

The last transaction timestamp

networkSpecificStats
[NetworkWalletStats!]

The network specific stats

This field is deprecated. Use networkBreakdown instead

networkBreakdown
[NetworkBreakdown!]

The network breakdown

labels
[String!]!
required

The labels associated with the wallet

scammerScore
Int

The likelihood of the wallet being a scammer

botScore
Int

The likelihood of the wallet being a bot

statsDay1
WindowedWalletStats

The stats for the last day

statsWeek1
WindowedWalletStats

The stats for the last week

statsDay30
WindowedWalletStats

The stats for the last 30 days

statsYear1
WindowedWalletStats

The stats for the last year

"""The detailed stats for a wallet."""
type DetailedWalletStats {
  """The wallet address"""
  walletAddress: String!
  """The last transaction timestamp"""
  lastTransactionAt: Int!
  """The network specific stats"""
  networkSpecificStats: [NetworkWalletStats!] @deprecated(reason: "Use networkBreakdown instead")
  """The network breakdown"""
  networkBreakdown: [NetworkBreakdown!]
  """The labels associated with the wallet"""
  labels: [String!]!
  """The likelihood of the wallet being a scammer"""
  scammerScore: Int
  """The likelihood of the wallet being a bot"""
  botScore: Int
  """The stats for the last day"""
  statsDay1: WindowedWalletStats
  """The stats for the last week"""
  statsWeek1: WindowedWalletStats
  """The stats for the last 30 days"""
  statsDay30: WindowedWalletStats
  """The stats for the last year"""
  statsYear1: WindowedWalletStats
}

EnhancedNftContract

Metadata for an NFT collection.

id
String!
required

The ID of the NFT collection (address:networkId).

address
String!
required

The contract address of the NFT collection.

networkId
Int!
required

The network ID the NFT collection is deployed on.

ercType
String!
required

The token standard. Can be a variation of ERC-721 or ERC-1155.

name
String

The name of the NFT collection.

description
String

The description of the NFT collection.

symbol
String

The symbol of the NFT collection.

totalSupply
String

The total supply of the NFT collection.

Community gathered links for the socials of this NFT collection.

image
String

The URL for an image of the NFT collection.

labels
[ContractLabel]

A list of labels for the NFT collection.

"""Metadata for an NFT collection."""
type EnhancedNftContract {
  """The ID of the NFT collection (`address`:`networkId`)."""
  id: String!
  """The contract address of the NFT collection."""
  address: String!
  """The network ID the NFT collection is deployed on."""
  networkId: Int!
  """The token standard. Can be a variation of `ERC-721` or `ERC-1155`."""
  ercType: String!
  """The name of the NFT collection."""
  name: String
  """The description of the NFT collection."""
  description: String
  """The symbol of the NFT collection."""
  symbol: String
  """The total supply of the NFT collection."""
  totalSupply: String
  """Community gathered links for the socials of this NFT collection."""
  socialLinks: SocialLinks
  """The URL for an image of the NFT collection."""
  image: String
  """A list of labels for the NFT collection."""
  labels: [ContractLabel]
}

EnhancedToken

Metadata for a token.

address
String!
required

The contract address of the token.

cmcId
Int

The token ID on CoinMarketCap.

decimals
Int!
required

The precision to which the token can be divided. For example, the smallest unit for USDC is 0.000001 (6 decimals).

id
String!
required

The ID of the token (address:networkId).

isScam
Boolean

Whether the token has been flagged as a scam.

name
String

The token name. For example, ApeCoin.

networkId
Int!
required

The network ID the token is deployed on.

symbol
String

The token symbol. For example, APE.

totalSupply
String

The total supply of the token.

This field is deprecated. Use the TokenInfo type

Community gathered links for the socials of this token.

info
TokenInfo

More metadata about the token.

explorerData
ExplorerTokenData

Information about the token from 3rd party sources.

This field is deprecated. Use the TokenInfo type

exchanges
[Exchange!]

A list of exchanges where the token has been traded.

imageThumbUrl
String

The thumbnail token logo URL.

This field is deprecated. Use the TokenInfo type

imageSmallUrl
String

The small token logo URL.

This field is deprecated. Use the TokenInfo type

imageLargeUrl
String

The large token logo URL.

This field is deprecated. Use the TokenInfo type

circulatingSupply
String

The circulating supply of the token.

This field is deprecated. Use the TokenInfo type

pooled
String

The amount of this token in the pair.

This field is deprecated. Pooled can be found on the pair instead

creatorAddress
String

The token creator’s wallet address.

createBlockNumber
Int

The block height the token was created at.

createTransactionHash
String

The transaction hash of the token’s creation.

createdAt
Int

The unix timestamp for the creation of the token.

mintable
String

Whether or not the token is mintable

freezable
String

Whether or not the token is freezable

launchpad
LaunchpadData

The launchpad data for the token, if applicable.

"""Metadata for a token."""
type EnhancedToken {
  """The contract address of the token."""
  address: String!
  """The token ID on CoinMarketCap."""
  cmcId: Int
  """The precision to which the token can be divided. For example, the smallest unit for USDC is 0.000001 (6 decimals)."""
  decimals: Int!
  """The ID of the token (`address:networkId`)."""
  id: String!
  """Whether the token has been flagged as a scam."""
  isScam: Boolean
  """The token name. For example, `ApeCoin`."""
  name: String
  """The network ID the token is deployed on."""
  networkId: Int!
  """The token symbol. For example, `APE`."""
  symbol: String
  """The total supply of the token."""
  totalSupply: String @deprecated(reason: "Use the TokenInfo type")
  """Community gathered links for the socials of this token."""
  socialLinks: SocialLinks
  """More metadata about the token."""
  info: TokenInfo
  """Information about the token from 3rd party sources."""
  explorerData: ExplorerTokenData @deprecated(reason: "Use the TokenInfo type")
  """A list of exchanges where the token has been traded."""
  exchanges: [Exchange!]
  """The thumbnail token logo URL."""
  imageThumbUrl: String @deprecated(reason: "Use the TokenInfo type")
  """The small token logo URL."""
  imageSmallUrl: String @deprecated(reason: "Use the TokenInfo type")
  """The large token logo URL."""
  imageLargeUrl: String @deprecated(reason: "Use the TokenInfo type")
  """The circulating supply of the token."""
  circulatingSupply: String @deprecated(reason: "Use the TokenInfo type")
  """The amount of this token in the pair."""
  pooled: String @deprecated(reason: "Pooled can be found on the pair instead")
  """The token creator's wallet address."""
  creatorAddress: String
  """The block height the token was created at."""
  createBlockNumber: Int
  """The transaction hash of the token's creation."""
  createTransactionHash: String
  """The unix timestamp for the creation of the token."""
  createdAt: Int
  """Whether or not the token is mintable"""
  mintable: String
  """Whether or not the token is freezable"""
  freezable: String
  """The launchpad data for the token, if applicable."""
  launchpad: LaunchpadData
}

Event

A token transaction.

address
String!
required

The contract address of the token’s top pair.

baseTokenPrice
String

The price of the network’s base token.

blockHash
String!
required

The hash of the block where the transaction occurred.

blockNumber
Int!
required

The block number for the transaction.

data
EventData

The event-specific data for the transaction. Can be BurnEventData or MintEventData or SwapEventData.

eventType
EventType!
required

The type of transaction event. Can be Burn, Mint, Swap, Sync, Collect, or CollectProtocol.

id
String!
required

The ID of the event (address:networkId). For example, 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2:1.

liquidityToken
String

The contract address of the token with higher liquidity in the token’s top pair.

logIndex
Int!
required

The index of the log in the block.

maker
String

The wallet address that performed the transaction.

networkId
Int!
required

The network ID that the token is deployed on.

quoteToken
QuoteToken

The token of interest within the token’s top pair. Can be token0 or token1.

timestamp
Int!
required

The unix timestamp for when the transaction occurred.

token0Address
String

The address of the event’s token0.

token1Address
String

The address of the event’s token1.

token0SwapValueUsd
String

The price of token0 paid/received in USD, including any fees.

token1SwapValueUsd
String

The price of token1 paid/received in USD, including any fees.

token0ValueBase
String

The price of token0 paid/received in the network’s base token, including fees.

token1ValueBase
String

The price of token1 paid/received in the network’s base token, including fees.

token0PoolValueUsd
String

The updated price of token0 in USD, calculated after the transaction.

token1PoolValueUsd
String

The updated price of token1 in USD, calculated after the transaction.

transactionHash
String!
required

The unique hash for the transaction.

transactionIndex
Int!
required

The index of the transaction within the block.

eventDisplayType
EventDisplayType

A more specific breakdown of eventType. Splits Swap into Buy or Sell.

labels
LabelsForEvent

Labels attributed to the event.

walletAge
Int

The age of the wallet in seconds.

walletLabels
[String!]

Labels attributed to the wallet.

"""A token transaction."""
type Event {
  """The contract address of the token's top pair."""
  address: String!
  """The price of the network's base token."""
  baseTokenPrice: String
  """The hash of the block where the transaction occurred."""
  blockHash: String!
  """The block number for the transaction."""
  blockNumber: Int!
  """The event-specific data for the transaction. Can be `BurnEventData` or `MintEventData` or `SwapEventData`."""
  data: EventData
  """The type of transaction event. Can be `Burn`, `Mint`, `Swap`, `Sync`, `Collect`, or `CollectProtocol`."""
  eventType: EventType!
  """The ID of the event (`address:networkId`). For example, `0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2:1`."""
  id: String!
  """The contract address of the token with higher liquidity in the token's top pair."""
  liquidityToken: String
  """The index of the log in the block."""
  logIndex: Int!
  """The wallet address that performed the transaction."""
  maker: String
  """The network ID that the token is deployed on."""
  networkId: Int!
  """The token of interest within the token's top pair. Can be `token0` or `token1`."""
  quoteToken: QuoteToken
  """The unix timestamp for when the transaction occurred."""
  timestamp: Int!
  """The address of the event's token0."""
  token0Address: String
  """The address of the event's token1."""
  token1Address: String
  """The price of `token0` paid/received in USD, including any fees."""
  token0SwapValueUsd: String
  """The price of `token1` paid/received in USD, including any fees."""
  token1SwapValueUsd: String
  """The price of `token0` paid/received in the network's base token, including fees."""
  token0ValueBase: String
  """The price of `token1` paid/received in the network's base token, including fees."""
  token1ValueBase: String
  """The updated price of `token0` in USD, calculated after the transaction."""
  token0PoolValueUsd: String
  """The updated price of `token1` in USD, calculated after the transaction."""
  token1PoolValueUsd: String
  """The unique hash for the transaction."""
  transactionHash: String!
  """The index of the transaction within the block."""
  transactionIndex: Int!
  """A more specific breakdown of `eventType`. Splits `Swap` into `Buy` or `Sell`."""
  eventDisplayType: EventDisplayType
  """Labels attributed to the event."""
  labels: LabelsForEvent
  """The age of the wallet in seconds."""
  walletAge: Int
  """Labels attributed to the wallet."""
  walletLabels: [String!]
}

EventConnection

Response returned by getTokenEvents.

items
[Event]

A list of transactions for a token’s top pair.

cursor
String

A cursor for use in pagination.

"""Response returned by `getTokenEvents`."""
type EventConnection {
  """A list of transactions for a token's top pair."""
  items: [Event]
  """A cursor for use in pagination."""
  cursor: String
}

EventLabel

Metadata for an event label.

data
EventLabelData!
required

Specific data for the event label type.

id
String!
required

The ID of the pair (address:networkId).

label
EventLabelType!
required

The event label type.

logIndex
Int!
required

The index of the log in the block.

networkId
Int!
required

The network ID the pair is deployed on.

timestamp
Int!
required

The unix timestamp for the transaction.

transactionIndex
Int!
required

The index of the transaction within the block.

transactionHash
String!
required

The unique hash for the transaction.

"""Metadata for an event label."""
type EventLabel {
  """Specific data for the event label type."""
  data: EventLabelData!
  """The ID of the pair (`address:networkId`)."""
  id: String!
  """The event label type."""
  label: EventLabelType!
  """The index of the log in the block."""
  logIndex: Int!
  """The network ID the pair is deployed on."""
  networkId: Int!
  """The unix timestamp for the transaction."""
  timestamp: Int!
  """The index of the transaction within the block."""
  transactionIndex: Int!
  """The unique hash for the transaction."""
  transactionHash: String!
}

EventLabelConnection

Response returned by getEventLabels.

items
[EventLabel]

A list of event labels for a pair.

cursor
String

The cursor to use for pagination.

"""Response returned by `getEventLabels`."""
type EventLabelConnection {
  """A list of event labels for a pair."""
  items: [EventLabel]
  """The cursor to use for pagination."""
  cursor: String
}

Exchange

Metadata for a decentralized exchange.

address
String!
required

The contract address of the exchange.

color
String

The hex string for the exchange color.

id
String!
required

The ID of the exchange (address:id).

name
String

The name of the exchange.

exchangeVersion
String

The version of the exchange, if applicable.

iconUrl
String

The exchange logo URL.

networkId
Int!
required

The network ID the exchange is deployed on.

tradeUrl
String

The URL for the exchange.

"""Metadata for a decentralized exchange."""
type Exchange {
  """The contract address of the exchange."""
  address: String!
  """The hex string for the exchange color."""
  color: String
  """The ID of the exchange (`address:id`)."""
  id: String!
  """The name of the exchange."""
  name: String
  """The version of the exchange, if applicable."""
  exchangeVersion: String
  """The exchange logo URL."""
  iconUrl: String
  """The network ID the exchange is deployed on."""
  networkId: Int!
  """The URL for the exchange."""
  tradeUrl: String
}

ExchangeFilterConnection

Response returned by filterExchanges.

results
[ExchangeFilterResult]

The list of exchanges matching the filter parameters.

count
Int

The number of exchanges returned.

offset
Int

Where in the list the server started when returning items.

"""Response returned by `filterExchanges`."""
type ExchangeFilterConnection {
  """The list of exchanges matching the filter parameters."""
  results: [ExchangeFilterResult]
  """The number of exchanges returned."""
  count: Int
  """Where in the list the server started when returning items."""
  offset: Int
}

ExchangeFilterResult

An exchange matching a set of filter parameters.

exchange
FilterExchange

Exchange metadata.

txnCount1
String

The number of transactions on the exchange in the past hour.

txnCount4
String

The number of transactions on the exchange in the past 4 hours.

txnCount12
String

The number of transactions on the exchange in the past 12 hours.

txnCount24
String

The number of transactions on the exchange in the past 24 hours.

volumeUSD1
String

The trade volume in USD in the past hour.

volumeUSD4
String

The trade volume in USD in the past 4 hours.

volumeUSD12
String

The trade volume in USD in the past 12 hours.

volumeUSD24
String

The trade volume in USD in the past 24 hours.

volumeNBT1
String

The trade volume in the network’s base token in the past hour.

volumeNBT4
String

The trade volume in the network’s base token in the past 4 hours.

volumeNBT12
String

The trade volume in the network’s base token in the past 12 hours.

volumeNBT24
String

The trade volume in the network’s base token in the past 24 hours.

dailyActiveUsers
Int

The total unique daily active users.

monthlyActiveUsers
Int

The total unique monthly active users (30 days).

"""An exchange matching a set of filter parameters."""
type ExchangeFilterResult {
  """Exchange metadata."""
  exchange: FilterExchange
  """The number of transactions on the exchange in the past hour."""
  txnCount1: String
  """The number of transactions on the exchange in the past 4 hours."""
  txnCount4: String
  """The number of transactions on the exchange in the past 12 hours."""
  txnCount12: String
  """The number of transactions on the exchange in the past 24 hours."""
  txnCount24: String
  """The trade volume in USD in the past hour."""
  volumeUSD1: String
  """The trade volume in USD in the past 4 hours."""
  volumeUSD4: String
  """The trade volume in USD in the past 12 hours."""
  volumeUSD12: String
  """The trade volume in USD in the past 24 hours."""
  volumeUSD24: String
  """The trade volume in the network's base token in the past hour."""
  volumeNBT1: String
  """The trade volume in the network's base token in the past 4 hours."""
  volumeNBT4: String
  """The trade volume in the network's base token in the past 12 hours."""
  volumeNBT12: String
  """The trade volume in the network's base token in the past 24 hours."""
  volumeNBT24: String
  """The total unique daily active users."""
  dailyActiveUsers: Int
  """The total unique monthly active users (30 days)."""
  monthlyActiveUsers: Int
}

ExplorerTokenData

Third party token data sourced from off chain.

id
String!
required

The ID of the token (address:networkId).

blueCheckmark
Boolean

Whether the token has been verified on CoinGecko.

description
String

A description of the token.

divisor
String

The precision to which the token can be divided.

tokenPriceUSD
String

The token price in USD.

tokenType
String

The token type.

"""Third party token data sourced from off chain."""
type ExplorerTokenData {
  """The ID of the token (`address:networkId`)."""
  id: String!
  """Whether the token has been verified on CoinGecko."""
  blueCheckmark: Boolean
  """A description of the token."""
  description: String
  """The precision to which the token can be divided."""
  divisor: String
  """The token price in USD."""
  tokenPriceUSD: String
  """The token type."""
  tokenType: String
}

FilterExchange

Metadata for an exchange.

address
String!
required

The address for the exchange factory contract.

id
String!
required

The ID of the exchange (address:networkId).

name
String

The name of the exchange.

exchangeVersion
String

The version of the exchange. For example, 3 for UniswapV3.

iconUrl
String

The URL for the exchange’s icon.

networkId
Int!
required

The network ID the factory is deployed on.

tradeUrl
String

The URL for the exchange’s trading platform.

"""Metadata for an exchange."""
type FilterExchange {
  """The address for the exchange factory contract."""
  address: String!
  """The ID of the exchange (`address:networkId`)."""
  id: String!
  """The name of the exchange."""
  name: String
  """The version of the exchange. For example, `3` for UniswapV3."""
  exchangeVersion: String
  """The URL for the exchange's icon."""
  iconUrl: String
  """The network ID the factory is deployed on."""
  networkId: Int!
  """The URL for the exchange's trading platform."""
  tradeUrl: String
}

FrontRunLabelData

Metadata for a front-run label.

index
Int

The index of the front-run label. Can be 0 or 1.

token0DrainedAmount
String!
required

The amount of token0 drained in the attack.

token1DrainedAmount
String!
required

The amount of token1 drained in the attack.

"""Metadata for a front-run label."""
type FrontRunLabelData {
  """The index of the front-run label. Can be 0 or 1."""
  index: Int
  """The amount of `token0` drained in the attack."""
  token0DrainedAmount: String!
  """The amount of `token1` drained in the attack."""
  token1DrainedAmount: String!
}

GetNetworkStatsResponse

Response returned by getNetworkStats.

volume24
Float!
required

The network trade volume in USD over the past 24 hours.

volume12
Float!
required

The network trade volume in USD over the past 12 hours.

volume4
Float!
required

The network trade volume in USD over the past 4 hours.

volume1
Float!
required

The network trade volume in USD over the past hour.

volume5m
Float!
required

The network trade volume in USD over the past 5 minutes.

volumeChange24
Float!
required

The network trade volume change over the last 24 hours

volumeChange12
Float!
required

The network trade volume change over the last 12 hours

volumeChange4
Float!
required

The network trade volume change over the last 4 hours

volumeChange1
Float!
required

The network trade volume change over the last hour

volumeChange5m
Float!
required

The network trade volume change over the last 5 minutes

liquidity
Float!
required

The network liquidity in USD.

transactions24
Int!
required

The unique number of transactions in the past 24 hours.

transactions12
Int!
required

The unique number of transactions in the past 12 hours.

transactions4
Int!
required

The unique number of transactions in the past 4 hours.

transactions1
Int!
required

The unique number of transactions in the past hour.

transactions5m
Int!
required

The unique number of transactions in the past 5 minutes.

"""Response returned by `getNetworkStats`."""
type GetNetworkStatsResponse {
  """The network trade volume in USD over the past 24 hours."""
  volume24: Float!
  """The network trade volume in USD over the past 12 hours."""
  volume12: Float!
  """The network trade volume in USD over the past 4 hours."""
  volume4: Float!
  """The network trade volume in USD over the past hour."""
  volume1: Float!
  """The network trade volume in USD over the past 5 minutes."""
  volume5m: Float!
  """The network trade volume change over the last 24 hours"""
  volumeChange24: Float!
  """The network trade volume change over the last 12 hours"""
  volumeChange12: Float!
  """The network trade volume change over the last 4 hours"""
  volumeChange4: Float!
  """The network trade volume change over the last hour"""
  volumeChange1: Float!
  """The network trade volume change over the last 5 minutes"""
  volumeChange5m: Float!
  """The network liquidity in USD."""
  liquidity: Float!
  """The unique number of transactions in the past 24 hours."""
  transactions24: Int!
  """The unique number of transactions in the past 12 hours."""
  transactions12: Int!
  """The unique number of transactions in the past 4 hours."""
  transactions4: Int!
  """The unique number of transactions in the past hour."""
  transactions1: Int!
  """The unique number of transactions in the past 5 minutes."""
  transactions5m: Int!
}

GetNftPoolCollectionsResponse

Response returned by getNftPoolCollectionsByExchange.

items
[NftPoolCollectionResponse]

A list of NFT collections.

cursor
String

A cursor for use in pagination.

"""Response returned by `getNftPoolCollectionsByExchange`."""
type GetNftPoolCollectionsResponse {
  """A list of NFT collections."""
  items: [NftPoolCollectionResponse]
  """A cursor for use in pagination."""
  cursor: String
}

GetNftPoolsResponse

Response returned by getNftPoolsByCollectionAndExchange and getNftPoolsByOwner.

items
[NftPoolResponse]!
required

A list of NFT pools.

cursor
String

A cursor for use in pagination.

"""Response returned by `getNftPoolsByCollectionAndExchange` and `getNftPoolsByOwner`."""
type GetNftPoolsResponse {
  """A list of NFT pools."""
  items: [NftPoolResponse]!
  """A cursor for use in pagination."""
  cursor: String
}

GetSimulateTokenContractResultsConnection

Response returned by simulateTokenContract.

results
[SimulateTokenContractResult!]!
required

No description provided

cursor
String

No description provided

"""Response returned by `simulateTokenContract`."""
type GetSimulateTokenContractResultsConnection {
  results: [SimulateTokenContractResult!]!
  cursor: String
}

GetWebhooksResponse

Response returned by getWebhooks.

items
[Webhook]

A list of webhooks belonging to a user.

cursor
String

A cursor for use in pagination.

"""Response returned by `getWebhooks`."""
type GetWebhooksResponse {
  """A list of webhooks belonging to a user."""
  items: [Webhook]
  """A cursor for use in pagination."""
  cursor: String
}

HoldersResponse

Response returned by holders.

items
[Balance!]!
required

The list of wallets holding the token.

count
Int!
required

The unique count of holders for the token.

cursor
String

A cursor for use in pagination.

status
HoldersStatus!
required

Status of holder. Disabled if on unsupported network or there is insufficient holder data.

top10HoldersPercent
Float

What percentage of the total supply do the top 10 holders hold.

"""Response returned by `holders`."""
type HoldersResponse {
  """The list of wallets holding the token."""
  items: [Balance!]!
  """The unique count of holders for the token."""
  count: Int!
  """A cursor for use in pagination."""
  cursor: String
  """Status of holder. Disabled if on unsupported network or there is insufficient holder data."""
  status: HoldersStatus!
  """What percentage of the total supply do the top 10 holders hold."""
  top10HoldersPercent: Float
}

HoldersUpdate

Response returned by onHoldersUpdated.

holders
Int!
required

The number of different wallets holding the token.

tokenId
String!
required

The ID of the token (tokenAddress:networkId).

tokenAddress
String!
required

The token’s contract address.

networkId
Int!
required

The network ID that the token is deployed on.

balances
[Balance!]!
required

The list of wallets holding the token.

"""Response returned by `onHoldersUpdated`."""
type HoldersUpdate {
  """The number of different wallets holding the token."""
  holders: Int!
  """The ID of the token (`tokenAddress:networkId`)."""
  tokenId: String!
  """The token's contract address."""
  tokenAddress: String!
  """The network ID that the token is deployed on."""
  networkId: Int!
  """The list of wallets holding the token."""
  balances: [Balance!]!
}

IndividualBarData

Bar chart data.

o
Float!
required

The opening price.

h
Float!
required

The high price.

l
Float!
required

The low price.

c
Float!
required

The closing price.

v
Int

The volume.

t
Int!
required

The timestamp for the bar.

volume
String!
required

The volume with higher precision.

volumeNativeToken
String!
required

The volume in the network’s base token

buyers
Int!
required

The number of unique buyers

buys
Int!
required

The number of buys

buyVolume
String!
required

The buy volume in USD

sellers
Int!
required

The number of unique sellers

sells
Int!
required

The number of sells

sellVolume
String!
required

The sell volume in USD

liquidity
String!
required

Liquidity in USD

traders
Int!
required

The number of traders

transactions
Int!
required

The number of transactions

"""Bar chart data."""
type IndividualBarData {
  """The opening price."""
  o: Float!
  """The high price."""
  h: Float!
  """The low price."""
  l: Float!
  """The closing price."""
  c: Float!
  """The volume."""
  v: Int
  """The timestamp for the bar."""
  t: Int!
  """The volume with higher precision."""
  volume: String!
  """The volume in the network's base token"""
  volumeNativeToken: String!
  """The number of unique buyers"""
  buyers: Int!
  """The number of buys"""
  buys: Int!
  """The buy volume in USD"""
  buyVolume: String!
  """The number of unique sellers"""
  sellers: Int!
  """The number of sells"""
  sells: Int!
  """The sell volume in USD"""
  sellVolume: String!
  """Liquidity in USD"""
  liquidity: String!
  """The number of traders"""
  traders: Int!
  """The number of transactions"""
  transactions: Int!
}

IntEqualsCondition

Integer equals condition.

eq
Int!
required

The integer to equal.

"""Integer equals condition."""
type IntEqualsCondition {
  """The integer to equal."""
  eq: Int!
}

LabelsForEvent

Event labels. Can be sandwich or washtrade.

sandwich
SandwichLabelForEvent

No description provided

washtrade
WashtradeLabelForEvent

No description provided

"""Event labels. Can be `sandwich` or `washtrade`."""
type LabelsForEvent {
  sandwich: SandwichLabelForEvent
  washtrade: WashtradeLabelForEvent
}

LatestPair

Metadata for a newly listed pair.

address
String!
required

The contract address for the pair.

exchangeHash
String!
required

The contract address for the exchange.

id
String!
required

The ID of the pair (address:networkId).

initialPriceUsd
String!
required

The listing price, or first known price for the pair, in USD.

liquidAt
Int

The unix timestamp for when liquidity was added to the pair.

liquidity
String!
required

The total liquidity in the pair.

liquidityToken
String

The token with higher liquidity within the pair. Can be token0 or token1.

networkId
Int!
required

The network ID the pair is deployed on.

newToken
String!
required

The newly added token within the pair. Can be token0 or token1.

nonLiquidityToken
String

The token with lower liquidity within the pair. Can be token0 or token1.

oldToken
String!
required

The pre-existing token within the pair. Can be token0 or token1.

priceChange
Float!
required

The percent price change between the listing price and the current price.

priceUsd
String!
required

The newly added token price in USD.

token0
LatestPairToken!
required

Metadata for token0.

token1
LatestPairToken!
required

Metadata for token1.

transactionHash
String!
required

The unique hash for the transaction that added liquidity, if applicable, otherwise the transaction that added the pair.

"""Metadata for a newly listed pair."""
type LatestPair {
  """The contract address for the pair."""
  address: String!
  """The contract address for the exchange."""
  exchangeHash: String!
  """The ID of the pair (`address:networkId`)."""
  id: String!
  """The listing price, or first known price for the pair, in USD."""
  initialPriceUsd: String!
  """The unix timestamp for when liquidity was added to the pair."""
  liquidAt: Int
  """The total liquidity in the pair."""
  liquidity: String!
  """The token with higher liquidity within the pair. Can be `token0` or `token1`."""
  liquidityToken: String
  """The network ID the pair is deployed on."""
  networkId: Int!
  """The newly added token within the pair. Can be `token0` or `token1`."""
  newToken: String!
  """The token with lower liquidity within the pair. Can be `token0` or `token1`."""
  nonLiquidityToken: String
  """The pre-existing token within the pair. Can be `token0` or `token1`."""
  oldToken: String!
  """The percent price change between the listing price and the current price."""
  priceChange: Float!
  """The newly added token price in USD."""
  priceUsd: String!
  """Metadata for `token0`."""
  token0: LatestPairToken!
  """Metadata for `token1`."""
  token1: LatestPairToken!
  """The unique hash for the transaction that added liquidity, if applicable, otherwise the transaction that added the pair."""
  transactionHash: String!
}

LatestPairConnection

Response returned by getLatestPairs.

items
[LatestPair!]!
required

A list of newly listed pairs.

cursor
String

A cursor for use in pagination.

"""Response returned by `getLatestPairs`."""
type LatestPairConnection {
  """A list of newly listed pairs."""
  items: [LatestPair!]!
  """A cursor for use in pagination."""
  cursor: String
}

LatestPairToken

Metadata for a token within a newly listed pair.

address
String!
required

The contract address for the token.

currentPoolAmount
String!
required

The amount of token currently in the pair.

decimals
Int!
required

The precision to which the token can be divided. For example, the smallest unit for USDC is 0.000001 (6 decimals).

id
String!
required

The ID of the token (address:networkId).

initialPoolAmount
String!
required

The initial amount of token added to the pair.

name
String!
required

The name of the token.

networkId
Int!
required

The network ID the token is deployed on.

pairId
String!
required

The ID of the pair (pairAddress:networkId).

poolVariation
Float!
required

The percent change token remaining in the pair since the initial add.

symbol
String!
required

The symbol for the token.

"""Metadata for a token within a newly listed pair."""
type LatestPairToken {
  """The contract address for the token."""
  address: String!
  """The amount of `token` currently in the pair."""
  currentPoolAmount: String!
  """The precision to which the token can be divided. For example, the smallest unit for USDC is 0.000001 (6 decimals)."""
  decimals: Int!
  """The ID of the token (`address:networkId`)."""
  id: String!
  """The initial amount of `token` added to the pair."""
  initialPoolAmount: String!
  """The name of the token."""
  name: String!
  """The network ID the token is deployed on."""
  networkId: Int!
  """The ID of the pair (`pairAddress:networkId`)."""
  pairId: String!
  """The percent change `token` remaining in the pair since the initial add."""
  poolVariation: Float!
  """The symbol for the token."""
  symbol: String!
}

LatestToken

Metadata for a newly created token.

id
String!
required

The id of the new token. (tokenAddress:networkId)

tokenAddress
String!
required

The contract address of the new token.

networkId
Int!
required

The network ID the token is deployed on.

blockNumber
Int!
required

The block number of the token contract’s creation.

transactionIndex
Int!
required

The index of the transaction within the block.

traceIndex
Int!
required

The index of the trace within the token contract’s creation transaction.

transactionHash
String!
required

The unique hash for the token contract’s creation transaction.

blockHash
String!
required

The unique hash for the token contract’s creation block.

timeCreated
Int!
required

The unix timestamp for the creation of the token.

creatorAddress
String!
required

The address of the token creator.

creatorBalance
String!
required

The token creator’s network token balance.

tokenName
String!
required

The name of the token.

totalSupply
String!
required

The total supply of the token.

tokenSymbol
String!
required

The symbol of the token.

decimals
Int!
required

The token’s number of decimals.

simulationResults
[LatestTokenSimResults!]!
required

Simulated token contract results, if available.

"""Metadata for a newly created token."""
type LatestToken {
  """The id of the new token. (tokenAddress:networkId)"""
  id: String!
  """The contract address of the new token."""
  tokenAddress: String!
  """The network ID the token is deployed on."""
  networkId: Int!
  """The block number of the token contract's creation."""
  blockNumber: Int!
  """The index of the transaction within the block."""
  transactionIndex: Int!
  """The index of the trace within the token contract's creation transaction."""
  traceIndex: Int!
  """The unique hash for the token contract's creation transaction."""
  transactionHash: String!
  """The unique hash for the token contract's creation block."""
  blockHash: String!
  """The unix timestamp for the creation of the token."""
  timeCreated: Int!
  """The address of the token creator."""
  creatorAddress: String!
  """The token creator's network token balance."""
  creatorBalance: String!
  """The name of the token."""
  tokenName: String!
  """The total supply of the token."""
  totalSupply: String!
  """The symbol of the token."""
  tokenSymbol: String!
  """The token's number of decimals."""
  decimals: Int!
  """Simulated token contract results, if available."""
  simulationResults: [LatestTokenSimResults!]!
}

LatestTokenConnection

Response returned by getLatestTokens.

items
[LatestToken!]!
required

A list of newly created tokens.

"""Response returned by `getLatestTokens`."""
type LatestTokenConnection {
  """A list of newly created tokens."""
  items: [LatestToken!]!
}

LatestTokenSimResults

Metadata for a newly created token.

buySuccess
Boolean

Whether or not a token was able to be succesfully bought during simulation.

buyTax
String

Tax paid for a buy transaction during simulation.

buyGasUsed
String

Gas used for a buy transaction during simulation.

maxBuyAmount
String

The maximum token amount an address can buy during simulation.

sellSuccess
Boolean

Whether or not a token was able to be succesfully sold during simulation.

sellTax
String

Tax paid for a sell transaction during simulation.

sellGasUsed
String

Gas used for a sell transaction during simulation.

maxSellAmount
String

The maximum token amount an address can sell during simulation.

canTransferOwnership
Boolean

Whether or not the contract ownership was able to be transferred during simulation.

canRenounceOwnership
Boolean

Whether or not the contract ownership was able to be renounced during simulation.

isOwnerRenounced
Boolean

Whether or not the contract ownership is already renounced during simulation (owner is 0x0).

openTradingCall
String

If a call was found to trigger liquidity & trading, this is the call name.

"""Metadata for a newly created token."""
type LatestTokenSimResults {
  """Whether or not a token was able to be succesfully bought during simulation."""
  buySuccess: Boolean
  """Tax paid for a buy transaction during simulation."""
  buyTax: String
  """Gas used for a buy transaction during simulation."""
  buyGasUsed: String
  """The maximum token amount an address can buy during simulation."""
  maxBuyAmount: String
  """Whether or not a token was able to be succesfully sold during simulation."""
  sellSuccess: Boolean
  """Tax paid for a sell transaction during simulation."""
  sellTax: String
  """Gas used for a sell transaction during simulation."""
  sellGasUsed: String
  """The maximum token amount an address can sell during simulation."""
  maxSellAmount: String
  """Whether or not the contract ownership was able to be transferred during simulation."""
  canTransferOwnership: Boolean
  """Whether or not the contract ownership was able to be renounced during simulation."""
  canRenounceOwnership: Boolean
  """Whether or not the contract ownership is already renounced during simulation (owner is 0x0)."""
  isOwnerRenounced: Boolean
  """If a call was found to trigger liquidity & trading, this is the call name."""
  openTradingCall: String
}

LaunchpadData

name
String

The name of the launchpad.

This field is deprecated. Use launchpadName instead

launchpadName
String

The name of the launchpad.

graduationPercent
Float

The percentage of the pool that was sold to the public.

poolAddress
String

The address of the pool.

completedAt
Int

The unix timestamp when the launchpad was completed.

completed
Boolean

Indicates if the launchpad is completed.

completedSlot
Int

The slot number when the launchpad was completed.

migratedSlot
Int

The slot number when the launchpad was migrated.

migratedAt
Int

The unix timestamp when the launchpad was migrated.

migrated
Boolean

Indicates if the launchpad was migrated.

migratedPoolAddress
String

The pool address after the launchpad was migrated.

launchpadProtocol
String

The launchpad protocol

type LaunchpadData {
  """The name of the launchpad."""
  name: String @deprecated(reason: "Use launchpadName instead")
  """The name of the launchpad."""
  launchpadName: String
  """The percentage of the pool that was sold to the public."""
  graduationPercent: Float
  """The address of the pool."""
  poolAddress: String
  """The unix timestamp when the launchpad was completed."""
  completedAt: Int
  """Indicates if the launchpad is completed."""
  completed: Boolean
  """The slot number when the launchpad was completed."""
  completedSlot: Int
  """The slot number when the launchpad was migrated."""
  migratedSlot: Int
  """The unix timestamp when the launchpad was migrated."""
  migratedAt: Int
  """Indicates if the launchpad was migrated."""
  migrated: Boolean
  """The pool address after the launchpad was migrated."""
  migratedPoolAddress: String
  """The launchpad protocol"""
  launchpadProtocol: String
}

LaunchpadTokenEventOutput

Response returned by onLaunchpadTokenEvent.

address
String!
required

The contract address of the token.

networkId
Int!
required

The network ID that the token is deployed on.

protocol
String!
required

The protocol of the token.

token
EnhancedToken!
required

Metadata for the token.

buyCount1
Int

The number of buys in the last 24 hours.

eventType
LaunchpadTokenEventType!
required

The type of event.

holders
Int

The number of holders.

marketCap
String

The market cap of the token.

price
Float

The price of the token.

sellCount1
Int

The number of sells in the last 24 hours.

volume1
Int

The volume of the token in the last 24 hours.

transactions1
Int

The number of transactions in the last 24 hours.

"""Response returned by `onLaunchpadTokenEvent`."""
type LaunchpadTokenEventOutput {
  """The contract address of the token."""
  address: String!
  """The network ID that the token is deployed on."""
  networkId: Int!
  """The protocol of the token."""
  protocol: String!
  """Metadata for the token."""
  token: EnhancedToken!
  """The number of buys in the last 24 hours."""
  buyCount1: Int
  """The type of event."""
  eventType: LaunchpadTokenEventType!
  """The number of holders."""
  holders: Int
  """The market cap of the token."""
  marketCap: String
  """The price of the token."""
  price: Float
  """The number of sells in the last 24 hours."""
  sellCount1: Int
  """The volume of the token in the last 24 hours."""
  volume1: Int
  """The number of transactions in the last 24 hours."""
  transactions1: Int
}

LiquidityData

Data about liquidity in a pair.

active
String!
required

The active liquidity in the pair.

inactive
String!
required

The inactive liquidity in the pair.

"""Data about liquidity in a pair."""
type LiquidityData {
  """The active liquidity in the pair."""
  active: String!
  """The inactive liquidity in the pair."""
  inactive: String!
}

LiquidityLock

A record of locked liquidity.

pairAddress
String!
required

The pair address.

networkId
Int!
required

The network ID the pair is deployed on.

ownerAddress
String!
required

The wallet address of the owner.

lockerAddress
String!
required

The address of the locker contract.

createdAt
Int!
required

The unix timestamp for when the lock was created.

unlockAt
Int

The unix timestamp for when the lock expires.

lockProtocol
LiquidityLockProtocol!
required

The protocol with which the liquidity is locked.

liquidityProtocol
LiquidityProtocol!
required

The protocol that created the pair

This field is deprecated. Use liquidityProtocolV2 instead

liquidityProtocolV2
String!
required

The protocol that created the pair

liquidityAmount
String!
required

The amount of liquidity locked.

initialAmountToken0
String!
required

The inital amount of token0 locked.

initialAmountToken1
String!
required

The inital amount of token1 locked.

liquidityNftData
LiquidityNftData

If the liquidity position is represented by an NFT, this will contain the NFT data.

"""A record of locked liquidity."""
type LiquidityLock {
  """The pair address."""
  pairAddress: String!
  """The network ID the pair is deployed on."""
  networkId: Int!
  """The wallet address of the owner."""
  ownerAddress: String!
  """The address of the locker contract."""
  lockerAddress: String!
  """The unix timestamp for when the lock was created."""
  createdAt: Int!
  """The unix timestamp for when the lock expires."""
  unlockAt: Int
  """The protocol with which the liquidity is locked."""
  lockProtocol: LiquidityLockProtocol!
  """The protocol that created the pair"""
  liquidityProtocol: LiquidityProtocol! @deprecated(reason: "Use liquidityProtocolV2 instead")
  """The protocol that created the pair"""
  liquidityProtocolV2: String!
  """The amount of liquidity locked."""
  liquidityAmount: String!
  """The inital amount of token0 locked."""
  initialAmountToken0: String!
  """The inital amount of token1 locked."""
  initialAmountToken1: String!
  """If the liquidity position is represented by an NFT, this will contain the NFT data."""
  liquidityNftData: LiquidityNftData
}

LiquidityLockBreakdownForToken

A breakdown of how much and where liquidity is locked.

lockProtocol
LiquidityLockProtocol!
required

The protocol with which the liquidity is locked.

amountLockedUsd
String!
required

The amount of liquidity locked in USD.

amountLockedTokens
String!
required

The amount of tokens locked in the protocol.

amountLockedTokensShifted
String!
required

The amount of tokens locked in the protocol shifted by number of decimals the token has.

"""A breakdown of how much and where liquidity is locked."""
type LiquidityLockBreakdownForToken {
  """The protocol with which the liquidity is locked."""
  lockProtocol: LiquidityLockProtocol!
  """The amount of liquidity locked in USD."""
  amountLockedUsd: String!
  """The amount of tokens locked in the protocol."""
  amountLockedTokens: String!
  """The amount of tokens locked in the protocol shifted by number of decimals the token has."""
  amountLockedTokensShifted: String!
}

LiquidityLockConnection

Response returned by liquidityLocks.

items
[LiquidityLock!]!
required

A list of liquidity locks.

cursor
String

A cursor for use in pagination.

"""Response returned by `liquidityLocks`."""
type LiquidityLockConnection {
  """A list of liquidity locks."""
  items: [LiquidityLock!]!
  """A cursor for use in pagination."""
  cursor: String
}

LiquidityMetadata

Metadata about a pair’s liquidity. Includes locked liquidity data.

lockedLiquidity
LockedLiquidityData!
required

Data about locked liquidity.

liquidity
LiquidityData!
required

Data about unlocked liquidity.

"""Metadata about a pair's liquidity. Includes locked liquidity data."""
type LiquidityMetadata {
  """Data about locked liquidity."""
  lockedLiquidity: LockedLiquidityData!
  """Data about unlocked liquidity."""
  liquidity: LiquidityData!
}

LiquidityMetadataByToken

Metadata about a token’s liquidity. Includes locked liquidity data for up to 100 pairs that the token is in.

tokenAddress
String!
required

The address of the token.

networkId
Int!
required

The network ID the token is deployed on.

totalLiquidityUsd
String!
required

The total liquidity in USD.

lockedLiquidityUsd
String!
required

The locked liquidity in USD.

totalTokenLiquidity
String!
required

The total amount of tokens in pairs.

totalTokenLiquidityShifted
String!
required

The total amount of tokens in pairs shifted by number of decimals the token has.

lockedTokenLiquidity
String!
required

The locked amount of tokens in pairs.

lockedTokenLiquidityShifted
String!
required

The locked amount of tokens in pairs shifted by number of decimals the token has.

lockedLiquidityPercentage
Float!
required

The percentage of liquidity that is locked.

lockBreakdown
[LiquidityLockBreakdownForToken]!
required

A breakdown of how much and where liquidity is locked.

"""Metadata about a token's liquidity. Includes locked liquidity data for up to 100 pairs that the token is in."""
type LiquidityMetadataByToken {
  """The address of the token."""
  tokenAddress: String!
  """The network ID the token is deployed on."""
  networkId: Int!
  """The total liquidity in USD."""
  totalLiquidityUsd: String!
  """The locked liquidity in USD."""
  lockedLiquidityUsd: String!
  """The total amount of tokens in pairs."""
  totalTokenLiquidity: String!
  """The total amount of tokens in pairs shifted by number of decimals the token has."""
  totalTokenLiquidityShifted: String!
  """The locked amount of tokens in pairs."""
  lockedTokenLiquidity: String!
  """The locked amount of tokens in pairs shifted by number of decimals the token has."""
  lockedTokenLiquidityShifted: String!
  """The percentage of liquidity that is locked."""
  lockedLiquidityPercentage: Float!
  """A breakdown of how much and where liquidity is locked."""
  lockBreakdown: [LiquidityLockBreakdownForToken]!
}

LiquidityNftData

Liquidity NFT position data.

nftTokenId
String!
required

The tokenId of the liquidity position nft.

nftPositionManagerAddress
String!
required

The address of the nft position manager contract.

"""Liquidity NFT position data."""
type LiquidityNftData {
  """The tokenId of the liquidity position nft."""
  nftTokenId: String!
  """The address of the nft position manager contract."""
  nftPositionManagerAddress: String!
}

ListPairsForTokenResponse

Response returned by listPairsWithMetadataForToken.

results
[ListPairsForTokenValue!]!
required

A list of pairs containing a given token.

"""Response returned by `listPairsWithMetadataForToken`."""
type ListPairsForTokenResponse {
  """A list of pairs containing a given token."""
  results: [ListPairsForTokenValue!]!
}

ListPairsForTokenValue

Metadata for a pair containing a given token.

volume
String!
required

The volume for the pair in USD.

liquidity
String!
required

The total liquidity in the pair.

token
EnhancedToken!
required

Metadata for token with higher liquidity within the pair.

backingToken
EnhancedToken!
required

Metadata for token with lower liquidity within the pair.

pair
Pair!
required

Metadata for the pair.

exchange
Exchange!
required

Exchange metadata for the pair.

quoteToken
QuoteToken

The token of interest within the pair. Can be token0 or token1.

"""Metadata for a pair containing a given token."""
type ListPairsForTokenValue {
  """The volume for the pair in USD."""
  volume: String!
  """The total liquidity in the pair."""
  liquidity: String!
  """Metadata for token with higher liquidity within the pair."""
  token: EnhancedToken!
  """Metadata for token with lower liquidity within the pair."""
  backingToken: EnhancedToken!
  """Metadata for the pair."""
  pair: Pair!
  """Exchange metadata for the pair."""
  exchange: Exchange!
  """The token of interest within the pair. Can be `token0` or `token1`."""
  quoteToken: QuoteToken
}

LockBreakdown

Breakdown of how much and where liquidity is locked.

lockProtocol
LiquidityLockProtocol!
required

The protocol with which the liquidity is locked.

active
String!
required

The amount of active liquidity locked.

inactive
String!
required

The amount of inactive liquidity locked.

"""Breakdown of how much and where liquidity is locked."""
type LockBreakdown {
  """The protocol with which the liquidity is locked."""
  lockProtocol: LiquidityLockProtocol!
  """The amount of active liquidity locked."""
  active: String!
  """The amount of inactive liquidity locked."""
  inactive: String!
}

LockedLiquidityData

Data about locked liquidity.

active
String!
required

The amount of active liquidity locked.

inactive
String!
required

The amount of inactive liquidity locked.

lockBreakdown
[LockBreakdown]!
required

A breakdown of how much and where liquidity is locked.

"""Data about locked liquidity."""
type LockedLiquidityData {
  """The amount of active liquidity locked."""
  active: String!
  """The amount of inactive liquidity locked."""
  inactive: String!
  """A breakdown of how much and where liquidity is locked."""
  lockBreakdown: [LockBreakdown]!
}

MakerEventConnection

Response returned by getTokenEventsForMaker.

items
[Event]

A list of transactions for a token’s top pair.

cursor
String

A cursor for use in pagination.

"""Response returned by `getTokenEventsForMaker`."""
type MakerEventConnection {
  """A list of transactions for a token's top pair."""
  items: [Event]
  """A cursor for use in pagination."""
  cursor: String
}

MarketCapEventWebhookCondition

Webhook conditions for a market cap event.

tokenAddress
StringEqualsCondition!
required

The token contract address the webhook is listening for.

networkId
IntEqualsCondition!
required

The network ID the webhook is listening on.

fdvMarketCapUsd
ComparisonOperator

The market cap condition that must be met in order for the webhook to send.

circulatingMarketCapUsd
ComparisonOperator

The circulating market cap condition that must be met in order for the webhook to send.

pairAddress
StringEqualsCondition

The pair contract address the webhook is listening for.

"""Webhook conditions for a market cap event."""
type MarketCapEventWebhookCondition {
  """The token contract address the webhook is listening for."""
  tokenAddress: StringEqualsCondition!
  """The network ID the webhook is listening on."""
  networkId: IntEqualsCondition!
  """The market cap condition that must be met in order for the webhook to send."""
  fdvMarketCapUsd: ComparisonOperator
  """The circulating market cap condition that must be met in order for the webhook to send."""
  circulatingMarketCapUsd: ComparisonOperator
  """The pair contract address the webhook is listening for."""
  pairAddress: StringEqualsCondition
}

MetadataResponse

The status for a network supported on Defined.

lastProcessedBlock
Int

The last processed block on the network.

lastProcessedTimestamp
Int

The unix timestamp for the last processed block on the network.

networkId
Int!
required

The network ID.

networkName
String!
required

The name of the network.

"""The status for a network supported on Defined."""
type MetadataResponse {
  """The last processed block on the network."""
  lastProcessedBlock: Int
  """The unix timestamp for the last processed block on the network."""
  lastProcessedTimestamp: Int
  """The network ID."""
  networkId: Int!
  """The name of the network."""
  networkName: String!
}

MintEventData

Event data for a token mint event.

amount0
String

The amount of token0 added to the pair.

amount1
String

The amount of token1 added to the pair.

amount0Shifted
String

The amount of token0 added to the pair, adjusted by the number of decimals in the token. For example, if amount0 is in WEI, amount0Shifted will be in ETH.

amount1Shifted
String

The amount of token1 added to the pair, adjusted by the number of decimals in the token. For example, USDC amount1Shifted will be by 6 decimals.

tickLower
String

The lower tick boundary of the position. Only applicable for UniswapV3 events.

tickUpper
String

The upper tick boundary of the position. Only applicable for UniswapV3 events.

type
EventType!
required

The type of token event, Mint.

"""Event data for a token mint event."""
type MintEventData {
  """The amount of `token0` added to the pair."""
  amount0: String
  """The amount of `token1` added to the pair."""
  amount1: String
  """The amount of `token0` added to the pair, adjusted by the number of decimals in the token. For example, if `amount0` is in WEI, `amount0Shifted` will be in ETH."""
  amount0Shifted: String
  """The amount of `token1` added to the pair, adjusted by the number of decimals in the token. For example, USDC `amount1Shifted` will be by 6 decimals."""
  amount1Shifted: String
  """The lower tick boundary of the position. Only applicable for UniswapV3 events."""
  tickLower: String
  """The upper tick boundary of the position. Only applicable for UniswapV3 events."""
  tickUpper: String
  """The type of token event, `Mint`."""
  type: EventType!
}

Network

A network supported on Defined.

name
String!
required

The name of the network. For example, arbitrum.

id
Int!
required

The network ID. For example, 42161 for arbitrum.

networkShortName
String

No description provided

"""A network supported on Defined."""
type Network {
  """The name of the network. For example, `arbitrum`."""
  name: String!
  """The network ID. For example, `42161` for `arbitrum`."""
  id: Int!
  networkShortName: String
}

NetworkBreakdown

A breakdown of the wallet’s activity by network.

networkId
Int!
required

The network ID

nativeTokenBalance
String!
required

The native token balance

statsDay1
WindowedWalletStats

The stats for the last day

statsWeek1
WindowedWalletStats

The stats for the last week

statsDay30
WindowedWalletStats

The stats for the last 30 days

statsYear1
WindowedWalletStats

The stats for the last year

"""A breakdown of the wallet's activity by network."""
type NetworkBreakdown {
  """The network ID"""
  networkId: Int!
  """The native token balance"""
  nativeTokenBalance: String!
  """The stats for the last day"""
  statsDay1: WindowedWalletStats
  """The stats for the last week"""
  statsWeek1: WindowedWalletStats
  """The stats for the last 30 days"""
  statsDay30: WindowedWalletStats
  """The stats for the last year"""
  statsYear1: WindowedWalletStats
}

NetworkWalletFilterConnection

A connection of wallets matching a filter on a specific network.

results
[NetworkWalletFilterResult!]!
required

The list of wallets matching the filter parameters.

count
Int!
required

The number of wallets returned.

offset
Int!
required

Where in the list the server started when returning items.

"""A connection of wallets matching a filter on a specific network."""
type NetworkWalletFilterConnection {
  """The list of wallets matching the filter parameters."""
  results: [NetworkWalletFilterResult!]!
  """The number of wallets returned."""
  count: Int!
  """Where in the list the server started when returning items."""
  offset: Int!
}

NetworkWalletFilterResult

A wallet matching a filter on a specific network.

address
String!
required

The wallet address

networkId
Int!
required

The network ID of the wallet

firstTransactionAt
Int

The unix timestamp for the first transaction from this wallet

lastTransactionAt
Int!
required

The unix timestamp for the last transaction from this wallet

nativeTokenBalance
String!
required

The native token balance of the wallet

labels
[String!]!
required

The labels associated with the wallet

volumeUsd1d
String!
required

Volume in USD in the past day

volumeUsdAll1d
String!
required

Total volume in USD in the past day including all tokens

realizedProfitUsd1d
String!
required

Realized profit in USD in the past day

averageProfitUsdPerTrade1d
String!
required

Average profit in USD per trade in the past day

averageSwapAmountUsd1d
String!
required

Average swap amount in USD in the past day

realizedProfitPercentage1d
Float!
required

Realized profit percentage in the past day

swaps1d
Int!
required

Number of swaps in the past day

swapsAll1d
Int!
required

Total number of swaps in the past day including all tokens

uniqueTokens1d
Int!
required

Number of unique tokens traded in the past day

winRate1d
Float!
required

Win rate in the past day

volumeUsd1w
String!
required

Volume in USD in the past week

volumeUsdAll1w
String!
required

Total volume in USD in the past week including all tokens

realizedProfitUsd1w
String!
required

Realized profit in USD in the past week

averageProfitUsdPerTrade1w
String!
required

Average profit in USD per trade in the past week

averageSwapAmountUsd1w
String!
required

Average swap amount in USD in the past week

realizedProfitPercentage1w
Float!
required

Realized profit percentage in the past week

swaps1w
Int!
required

Number of swaps in the past week

swapsAll1w
Int!
required

Total number of swaps in the past week including all tokens

uniqueTokens1w
Int!
required

Number of unique tokens traded in the past week

winRate1w
Float!
required

Win rate in the past week

volumeUsd30d
String!
required

Volume in USD in the past 30 days

volumeUsdAll30d
String!
required

Total volume in USD in the past 30 days including all tokens

realizedProfitUsd30d
String!
required

Realized profit in USD in the past 30 days

averageProfitUsdPerTrade30d
String!
required

Average profit in USD per trade in the past 30 days

averageSwapAmountUsd30d
String!
required

Average swap amount in USD in the past 30 days

realizedProfitPercentage30d
Float!
required

Realized profit percentage in the past 30 days

swaps30d
Int!
required

Number of swaps in the past 30 days

swapsAll30d
Int!
required

Total number of swaps in the past 30 days including all tokens

uniqueTokens30d
Int!
required

Number of unique tokens traded in the past 30 days

winRate30d
Float!
required

Win rate in the past 30 days

volumeUsd1y
String!
required

Volume in USD in the past year

volumeUsdAll1y
String!
required

Total volume in USD in the past year including all tokens

realizedProfitUsd1y
String!
required

Realized profit in USD in the past year

averageProfitUsdPerTrade1y
String!
required

Average profit in USD per trade in the past year

averageSwapAmountUsd1y
String!
required

Average swap amount in USD in the past year

realizedProfitPercentage1y
Float!
required

Realized profit percentage in the past year

swaps1y
Int!
required

Number of swaps in the past year

swapsAll1y
Int!
required

Total number of swaps in the past year including all tokens

uniqueTokens1y
Int!
required

Number of unique tokens traded in the past year

winRate1y
Float!
required

Win rate in the past year

scammerScore
Int

The scammer score for the wallet.

botScore
Int

The bot score for the wallet.

"""A wallet matching a filter on a specific network."""
type NetworkWalletFilterResult {
  """The wallet address"""
  address: String!
  """The network ID of the wallet"""
  networkId: Int!
  """The unix timestamp for the first transaction from this wallet"""
  firstTransactionAt: Int
  """The unix timestamp for the last transaction from this wallet"""
  lastTransactionAt: Int!
  """The native token balance of the wallet"""
  nativeTokenBalance: String!
  """The labels associated with the wallet"""
  labels: [String!]!
  """Volume in USD in the past day"""
  volumeUsd1d: String!
  """Total volume in USD in the past day including all tokens"""
  volumeUsdAll1d: String!
  """Realized profit in USD in the past day"""
  realizedProfitUsd1d: String!
  """Average profit in USD per trade in the past day"""
  averageProfitUsdPerTrade1d: String!
  """Average swap amount in USD in the past day"""
  averageSwapAmountUsd1d: String!
  """Realized profit percentage in the past day"""
  realizedProfitPercentage1d: Float!
  """Number of swaps in the past day"""
  swaps1d: Int!
  """Total number of swaps in the past day including all tokens"""
  swapsAll1d: Int!
  """Number of unique tokens traded in the past day"""
  uniqueTokens1d: Int!
  """Win rate in the past day"""
  winRate1d: Float!
  """Volume in USD in the past week"""
  volumeUsd1w: String!
  """Total volume in USD in the past week including all tokens"""
  volumeUsdAll1w: String!
  """Realized profit in USD in the past week"""
  realizedProfitUsd1w: String!
  """Average profit in USD per trade in the past week"""
  averageProfitUsdPerTrade1w: String!
  """Average swap amount in USD in the past week"""
  averageSwapAmountUsd1w: String!
  """Realized profit percentage in the past week"""
  realizedProfitPercentage1w: Float!
  """Number of swaps in the past week"""
  swaps1w: Int!
  """Total number of swaps in the past week including all tokens"""
  swapsAll1w: Int!
  """Number of unique tokens traded in the past week"""
  uniqueTokens1w: Int!
  """Win rate in the past week"""
  winRate1w: Float!
  """Volume in USD in the past 30 days"""
  volumeUsd30d: String!
  """Total volume in USD in the past 30 days including all tokens"""
  volumeUsdAll30d: String!
  """Realized profit in USD in the past 30 days"""
  realizedProfitUsd30d: String!
  """Average profit in USD per trade in the past 30 days"""
  averageProfitUsdPerTrade30d: String!
  """Average swap amount in USD in the past 30 days"""
  averageSwapAmountUsd30d: String!
  """Realized profit percentage in the past 30 days"""
  realizedProfitPercentage30d: Float!
  """Number of swaps in the past 30 days"""
  swaps30d: Int!
  """Total number of swaps in the past 30 days including all tokens"""
  swapsAll30d: Int!
  """Number of unique tokens traded in the past 30 days"""
  uniqueTokens30d: Int!
  """Win rate in the past 30 days"""
  winRate30d: Float!
  """Volume in USD in the past year"""
  volumeUsd1y: String!
  """Total volume in USD in the past year including all tokens"""
  volumeUsdAll1y: String!
  """Realized profit in USD in the past year"""
  realizedProfitUsd1y: String!
  """Average profit in USD per trade in the past year"""
  averageProfitUsdPerTrade1y: String!
  """Average swap amount in USD in the past year"""
  averageSwapAmountUsd1y: String!
  """Realized profit percentage in the past year"""
  realizedProfitPercentage1y: Float!
  """Number of swaps in the past year"""
  swaps1y: Int!
  """Total number of swaps in the past year including all tokens"""
  swapsAll1y: Int!
  """Number of unique tokens traded in the past year"""
  uniqueTokens1y: Int!
  """Win rate in the past year"""
  winRate1y: Float!
  """The scammer score for the wallet."""
  scammerScore: Int
  """The bot score for the wallet."""
  botScore: Int
}

NetworkWalletStats

Native token balance for a wallet on a network.

networkId
Int!
required

The network ID

nativeTokenBalance
String!
required

The native token balance

"""Native token balance for a wallet on a network."""
type NetworkWalletStats {
  """The network ID"""
  networkId: Int!
  """The native token balance"""
  nativeTokenBalance: String!
}

NewPoolEventData

Event data for creating a new NFT pool.

type
NftPoolEventType!
required

The type of NFT pool event, NEW_POOL.

networkId
Int!
required

The network ID the NFT collection is deployed on.

poolAddress
String!
required

The contract address of the NFT pool.

collectionAddress
String!
required

The contract address of the NFT collection.

tokenAddress
String!
required

The contract address of the liquidity token of the pool (usually WETH).

ownerAddress
String!
required

The wallet address of the pool owner.

assetRecipientAddress
String!
required

The wallet address that will receive the tokens or NFT sent to the pair during swaps.

bondingCurveAddress
String!
required

The contract address of the bonding curve.

bondingCurveType
BondingCurveType!
required

The bonding curve type that defines how the prices of NFTs change after each buy or sell within a pool.

delta
String!
required

The initial delta used in the bonding curve.

feeAmountT
String!
required

The pool fee amount in the pool’s liquidity token.

startPriceT
String!
required

The initial spot price in the pool’s liquidity token.

buyPriceT
String!
required

The initial price at which the pool is willing to buy an NFT in the pool’s liquidity token.

sellPriceT
String!
required

The initial price at which the pool is willing to sell an NFT in the pool’s liquidity token.

createdAt
Int!
required

The unix timestamp for the time the pool was created.

nftTokenBalance
String!
required

The number of NFTs in the contract after the block has processed.

tokenBalanceT
String!
required

The amount of token in the contract after the block has processed in the pool’s liquidity token.

nbtRatio
String!
required

The ratio of the transaction token to the network’s base token.

usdRatio
String!
required

The ratio of the transaction token to USD.

"""Event data for creating a new NFT pool."""
type NewPoolEventData {
  """The type of NFT pool event, `NEW_POOL`."""
  type: NftPoolEventType!
  """The network ID the NFT collection is deployed on."""
  networkId: Int!
  """The contract address of the NFT pool."""
  poolAddress: String!
  """The contract address of the NFT collection."""
  collectionAddress: String!
  """The contract address of the liquidity token of the pool (usually WETH)."""
  tokenAddress: String!
  """The wallet address of the pool owner."""
  ownerAddress: String!
  """The wallet address that will receive the tokens or NFT sent to the pair during swaps."""
  assetRecipientAddress: String!
  """The contract address of the bonding curve."""
  bondingCurveAddress: String!
  """The bonding curve type that defines how the prices of NFTs change after each buy or sell within a pool."""
  bondingCurveType: BondingCurveType!
  """The initial delta used in the bonding curve."""
  delta: String!
  """The pool fee amount in the pool's liquidity token."""
  feeAmountT: String!
  """The initial spot price in the pool's liquidity token."""
  startPriceT: String!
  """The initial price at which the pool is willing to buy an NFT in the pool's liquidity token."""
  buyPriceT: String!
  """The initial price at which the pool is willing to sell an NFT in the pool's liquidity token."""
  sellPriceT: String!
  """The unix timestamp for the time the pool was created."""
  createdAt: Int!
  """The number of NFTs in the contract after the block has processed."""
  nftTokenBalance: String!
  """The amount of token in the contract after the block has processed in the pool's liquidity token."""
  tokenBalanceT: String!
  """The ratio of the transaction token to the network's base token."""
  nbtRatio: String!
  """The ratio of the transaction token to USD."""
  usdRatio: String!
}

NewPoolEventDataV2

Event data for creating a new NFT pool.

type
NftPoolEventType!
required

The type of NFT pool event, NEW_POOL.

networkId
Int!
required

The network ID the NFT collection is deployed on.

poolAddress
String!
required

The contract address of the NFT pool.

collectionAddress
String!
required

The contract address of the NFT collection.

tokenAddress
String!
required

The contract address of the liquidity token of the pool (usually WETH).

ownerAddress
String!
required

The wallet address of the pool owner.

assetRecipientAddress
String!
required

The wallet address that will receive the tokens or NFT sent to the pair during swaps.

bondingCurveAddress
String!
required

The contract address of the bonding curve.

bondingCurveType
BondingCurveType!
required

The bonding curve type that defines how the prices of NFTs change after each buy or sell within a pool.

delta
String!
required

The initial delta used in the bonding curve.

feeAmountT
String!
required

The pool fee amount in the pool’s liquidity token.

startPriceT
String!
required

The initial spot price in the pool’s liquidity token.

buyPriceT
String!
required

The initial price at which the pool is willing to buy an NFT in the pool’s liquidity token.

sellPriceT
String!
required

The initial price at which the pool is willing to sell an NFT in the pool’s liquidity token.

createdAt
Int!
required

The unix timestamp for the time the pool was created.

tokenBalanceT
String!
required

The amount of token in the contract after the block has processed in the pool’s liquidity token.

nbtRatio
String!
required

The ratio of the transaction token to the network’s base token.

usdRatio
String!
required

The ratio of the transaction token to USD.

nftTokenIds
[String!]!
required

The list of NFT token IDs initially deposited.

nftTokenQuantities
[String]!
required

The amount of each NFT token initially deposited.

nftAssets
[NftAsset]

New Param: The list of NFT assets withdrawn. More extensive info than nftTokenIds.

poolNftType
PoolNftType!
required

The type of NFT in the pool.

royalties
[NftPoolRoyalty]

The list of royalties for the pool. Only applicable for SUDOSWAP_V2 pools.

propertyChecker
String

The property checker contract address for the pool.

"""Event data for creating a new NFT pool."""
type NewPoolEventDataV2 {
  """The type of NFT pool event, `NEW_POOL`."""
  type: NftPoolEventType!
  """The network ID the NFT collection is deployed on."""
  networkId: Int!
  """The contract address of the NFT pool."""
  poolAddress: String!
  """The contract address of the NFT collection."""
  collectionAddress: String!
  """The contract address of the liquidity token of the pool (usually WETH)."""
  tokenAddress: String!
  """The wallet address of the pool owner."""
  ownerAddress: String!
  """The wallet address that will receive the tokens or NFT sent to the pair during swaps."""
  assetRecipientAddress: String!
  """The contract address of the bonding curve."""
  bondingCurveAddress: String!
  """The bonding curve type that defines how the prices of NFTs change after each buy or sell within a pool."""
  bondingCurveType: BondingCurveType!
  """The initial delta used in the bonding curve."""
  delta: String!
  """The pool fee amount in the pool's liquidity token."""
  feeAmountT: String!
  """The initial spot price in the pool's liquidity token."""
  startPriceT: String!
  """The initial price at which the pool is willing to buy an NFT in the pool's liquidity token."""
  buyPriceT: String!
  """The initial price at which the pool is willing to sell an NFT in the pool's liquidity token."""
  sellPriceT: String!
  """The unix timestamp for the time the pool was created."""
  createdAt: Int!
  """The amount of token in the contract after the block has processed in the pool's liquidity token."""
  tokenBalanceT: String!
  """The ratio of the transaction token to the network's base token."""
  nbtRatio: String!
  """The ratio of the transaction token to USD."""
  usdRatio: String!
  """The list of NFT token IDs initially deposited."""
  nftTokenIds: [String!]!
  """The amount of each NFT token initially deposited."""
  nftTokenQuantities: [String]!
  """*New Param*: The list of NFT assets withdrawn. More extensive info than nftTokenIds."""
  nftAssets: [NftAsset]
  """The type of NFT in the pool."""
  poolNftType: PoolNftType!
  """The list of royalties for the pool. Only applicable for `SUDOSWAP_V2` pools."""
  royalties: [NftPoolRoyalty]
  """The property checker contract address for the pool."""
  propertyChecker: String
}

NftAsset

An NFT asset.

id
String!
required

The ID of the NFT asset (address:networkId).

address
String!
required

The contract address of the NFT collection.

tokenId
String!
required

The token ID of the NFT asset.

networkId
Int!
required

The network ID the NFT collection is deployed on.

media
NftAssetMedia

The NFT asset media.

name
String

The name of the NFT asset.

description
String

The description of the NFT asset.

originalImage
String

The source image URI linked by smart contract metadata.

uri
String

The URI provided by the smart contract. Typically JSON that contains metadata.

attributes
[NftAssetAttribute!]

The attributes for the NFT asset.

quantity
String

The number of NFT assets with the same NFT token ID. Only applicable for ERC1155 tokens.

rawAssetData
RawNftAssetData

Raw NFT metadata from the smart contract.

"""An NFT asset."""
type NftAsset {
  """The ID of the NFT asset (`address`:`networkId`)."""
  id: String!
  """The contract address of the NFT collection."""
  address: String!
  """The token ID of the NFT asset."""
  tokenId: String!
  """The network ID the NFT collection is deployed on."""
  networkId: Int!
  """The NFT asset media."""
  media: NftAssetMedia
  """The name of the NFT asset."""
  name: String
  """The description of the NFT asset."""
  description: String
  """The source image URI linked by smart contract metadata."""
  originalImage: String
  """The URI provided by the smart contract. Typically JSON that contains metadata."""
  uri: String
  """The attributes for the NFT asset."""
  attributes: [NftAssetAttribute!]
  """The number of NFT assets with the same NFT token ID. Only applicable for ERC1155 tokens."""
  quantity: String
  """Raw NFT metadata from the smart contract."""
  rawAssetData: RawNftAssetData
}

NftAssetAttribute

Attributes for an NFT asset.

class
String

Suggested class name to use for css styling. An optional attribute of ERC-1155 assets.

css
String

Suggested CSS styling. An optional attribute of ERC-1155 assets.

displayType
NftAssetAttributeDisplayType!
required

The attribute display type. Can be Trait, Stat, Ranking, BoostNumber, BoostPercentage or Date.

maxValue
String

The max value, if applicable.

name
String!
required

The name of the attribute.

value
String!
required

The value of the attribute.

valueType
NftAssetAttributeType!
required

The type for the value field. Can be String, Number or Array.

"""Attributes for an NFT asset."""
type NftAssetAttribute {
  """Suggested class name to use for css styling. An optional attribute of ERC-1155 assets."""
  class: String
  """Suggested CSS styling. An optional attribute of ERC-1155 assets."""
  css: String
  """The attribute display type. Can be `Trait`, `Stat`, `Ranking`, `BoostNumber`, `BoostPercentage` or `Date`."""
  displayType: NftAssetAttributeDisplayType!
  """The max value, if applicable."""
  maxValue: String
  """The name of the attribute."""
  name: String!
  """The value of the attribute."""
  value: String!
  """The type for the `value` field. Can be `String`, `Number` or `Array`."""
  valueType: NftAssetAttributeType!
}

NftAssetError

An NFT asset error.

id
String!
required

The ID of the NFT asset (address:networkId).

address
String!
required

The contract address of the NFT collection.

tokenId
String!
required

The token ID of the NFT asset.

networkId
Int!
required

The network ID the NFT collection is deployed on.

status
NftAssetErrorStatus!
required

The status of the asset error.

message
String!
required

The message of the asset error.

"""An NFT asset error."""
type NftAssetError {
  """The ID of the NFT asset (`address`:`networkId`)."""
  id: String!
  """The contract address of the NFT collection."""
  address: String!
  """The token ID of the NFT asset."""
  tokenId: String!
  """The network ID the NFT collection is deployed on."""
  networkId: Int!
  """The status of the asset error."""
  status: NftAssetErrorStatus!
  """The message of the asset error."""
  message: String!
}

NftAssetMedia

NFT asset media.

image
String!
required

The URL for a full size image of the NFT asset.

thumbSm
String!
required

The URL for small generated thumbnail of the NFT asset.

thumbLg
String!
required

The URL for large generated thumbnail of the NFT asset.

processed
Boolean

Whether the NFT asset media has finished processing.

"""NFT asset media."""
type NftAssetMedia {
  """The URL for a full size image of the NFT asset."""
  image: String!
  """The URL for small generated thumbnail of the NFT asset."""
  thumbSm: String!
  """The URL for large generated thumbnail of the NFT asset."""
  thumbLg: String!
  """Whether the NFT asset media has finished processing."""
  processed: Boolean
}

NftAssetsConnection

Response returned by getNftAssets.

items
[NftAsset]

A list of NFT assets.

itemErrors
[NftAssetError]

A list of errors encountered while fetching the NFT assets. Errors correspond to null values in items by array index.

cursor
String

A cursor for use in pagination.

"""Response returned by `getNftAssets`."""
type NftAssetsConnection {
  """A list of NFT assets."""
  items: [NftAsset]
  """A list of errors encountered while fetching the NFT assets. Errors correspond to null values in `items` by array index."""
  itemErrors: [NftAssetError]
  """A cursor for use in pagination."""
  cursor: String
}

NftBalance

Wallet balance of an Nft Collection.

walletAddress
String!
required

The address of the wallet.

collectionId
String!
required

The ID of the collection (collectionAddress:networkId).

balance
String!
required

The number of items held by the wallet.

"""Wallet balance of an Nft Collection."""
type NftBalance {
  """The address of the wallet."""
  walletAddress: String!
  """The ID of the collection (`collectionAddress:networkId`)."""
  collectionId: String!
  """The number of items held by the wallet."""
  balance: String!
}

NftCollectionCurrencyStats

Price stats for an NFT collection over a time frame. Either in USD or the network’s base token.

volume
NftStatsStringMetrics

The volume over the time frame.

volumeByFillsource
[NftFillsourceStatsStringMetrics]

The volume partitioned by fillsource over the time frame

volumePercentByFillsource
[NftFillsourceStatsNumberMetrics]

The percentages of total volume partitioned by fillsource over the time frame

average
NftStatsStringMetrics

The average sale price in the time frame.

open
NftStatsStringMetrics

The opening price for the time frame.

close
NftStatsStringMetrics

The closing price for the time frame.

lowestSale
NftStatsStringMetrics

The lowest sale price in the time frame.

highestSale
NftStatsStringMetrics

The highest sale price in the time frame.

"""Price stats for an NFT collection over a time frame. Either in USD or the network's base token."""
type NftCollectionCurrencyStats {
  """The volume over the time frame."""
  volume: NftStatsStringMetrics
  """The volume partitioned by fillsource over the time frame"""
  volumeByFillsource: [NftFillsourceStatsStringMetrics]
  """The percentages of total volume partitioned by fillsource over the time frame"""
  volumePercentByFillsource: [NftFillsourceStatsNumberMetrics]
  """The average sale price in the time frame."""
  average: NftStatsStringMetrics
  """The opening price for the time frame."""
  open: NftStatsStringMetrics
  """The closing price for the time frame."""
  close: NftStatsStringMetrics
  """The lowest sale price in the time frame."""
  lowestSale: NftStatsStringMetrics
  """The highest sale price in the time frame."""
  highestSale: NftStatsStringMetrics
}

NftCollectionFillsourceNumberStat

Stat and change for a string based fillsource amount.

fillsource
String!
required

The marketplace that filled the NFT order volume. (ex. OPENSEA, BLUR, etc.)

amount
Float!
required

The amount of the stat traded in the current time frame.

change
Float

The change in fillsource volume between the previous and current time frame.

"""Stat and change for a string based fillsource amount."""
type NftCollectionFillsourceNumberStat {
  """The marketplace that filled the NFT order volume. (ex. OPENSEA, BLUR, etc.)"""
  fillsource: String!
  """The amount of the stat traded in the current time frame."""
  amount: Float!
  """The change in fillsource volume between the previous and current time frame."""
  change: Float
}

NftCollectionFillsourceStringStat

Stat and change for a string based fillsource amount.

fillsource
String!
required

The marketplace that filled the NFT order volume. (ex. OPENSEA, BLUR, etc.)

amount
String!
required

The amount of the stat traded in the current time frame.

change
Float

The change in fillsource volume between the previous and current time frame.

"""Stat and change for a string based fillsource amount."""
type NftCollectionFillsourceStringStat {
  """The marketplace that filled the NFT order volume. (ex. OPENSEA, BLUR, etc.)"""
  fillsource: String!
  """The amount of the stat traded in the current time frame."""
  amount: String!
  """The change in fillsource volume between the previous and current time frame."""
  change: Float
}

NftCollectionFilterConnection

Response returned by filterNftCollections.

results
[NftCollectionFilterResult]

The list of NFT collections matching the filter parameters.

count
Int

The number of NFT collections returned.

offset
Int

Where in the list the server started when returning items.

"""Response returned by `filterNftCollections`."""
type NftCollectionFilterConnection {
  """The list of NFT collections matching the filter parameters."""
  results: [NftCollectionFilterResult]
  """The number of NFT collections returned."""
  count: Int
  """Where in the list the server started when returning items."""
  offset: Int
}

NftCollectionFilterResult

An NFT collection matching a set of filter parameters.

id
String

The ID of the NFT collection (address:networkId).

address
String

The contract address of the NFT collection.

grouping
String

The marketplace address or all. Can be used to get marketplace-specific metrics.

networkId
Int

The network ID the NFT collection is deployed on.

name
String

The name of the NFT collection.

symbol
String

The symbol of the NFT collection.

lastEventTimestamp
Int

The unix timestamp for the last event.

ercType
String

The token standard. Can be a variation of ERC-721 or ERC-1155.

imageUrl
String

The image URL for the collection or one of the assets within the collection.

totalSupply
String

The total supply of the NFT collection.

timestamp
Int

The unix timestamp indicating the last time the data was updated. Updates daily.

stats1h
NftStatsWindowWithChange

Stats for the past hour.

stats4h
NftStatsWindowWithChange

Stats for the past 4 hours.

stats12h
NftStatsWindowWithChange

Stats for the past 12 hours.

stats24h
NftStatsWindowWithChange

Stats for the past 24 hours.

"""An NFT collection matching a set of filter parameters."""
type NftCollectionFilterResult {
  """The ID of the NFT collection (`address`:`networkId`)."""
  id: String
  """The contract address of the NFT collection."""
  address: String
  """The marketplace address or `all`. Can be used to get marketplace-specific metrics."""
  grouping: String
  """The network ID the NFT collection is deployed on."""
  networkId: Int
  """The name of the NFT collection."""
  name: String
  """The symbol of the NFT collection."""
  symbol: String
  """The unix timestamp for the last event."""
  lastEventTimestamp: Int
  """The token standard. Can be a variation of `ERC-721` or `ERC-1155`."""
  ercType: String
  """The image URL for the collection or one of the assets within the collection."""
  imageUrl: String
  """The total supply of the NFT collection."""
  totalSupply: String
  """The unix timestamp indicating the last time the data was updated. Updates daily."""
  timestamp: Int
  """Stats for the past hour."""
  stats1h: NftStatsWindowWithChange
  """Stats for the past 4 hours."""
  stats4h: NftStatsWindowWithChange
  """Stats for the past 12 hours."""
  stats12h: NftStatsWindowWithChange
  """Stats for the past 24 hours."""
  stats24h: NftStatsWindowWithChange
}

NftCollectionMetadataResponse

Response returned by getNftCollectionMetadata.

id
String!
required

The ID of the NFT collection (address:networkId).

contract
NftContract!
required

Metadata for the NFT collection.

stats
[NftCollectionWindowStats]

A list of stats for the NFT collection across different time frames.

media
NftAssetMedia

The media for one of the assets within the NFT collection.

"""Response returned by `getNftCollectionMetadata`."""
type NftCollectionMetadataResponse {
  """The ID of the NFT collection (`address`:`networkId`)."""
  id: String!
  """Metadata for the NFT collection."""
  contract: NftContract!
  """A list of stats for the NFT collection across different time frames."""
  stats: [NftCollectionWindowStats]
  """The media for one of the assets within the NFT collection."""
  media: NftAssetMedia
}

NftCollectionNonCurrencyStats

Numerical stats for an NFT collection over a time frame.

mints
NftStatsNumberMetrics

The number of mints over the time frame.

sales
NftStatsNumberMetrics

The number of sales over the time frame.

tokensSold
NftStatsStringMetrics

The number of tokens sold over the time frame.

transfers
NftStatsNumberMetrics

The number of transfers over the time frame.

uniqueBuyers
NftStatsNumberMetrics

The number of unique buyers over the time frame.

uniqueSellers
NftStatsNumberMetrics

The number of unique sellers over the time frame.

uniqueSalesWallets
NftStatsNumberMetrics

The number of unique wallets (buyers or sellers) over the time frame.

uniqueMinters
NftStatsNumberMetrics

The number of unique minters over the time frame.

"""Numerical stats for an NFT collection over a time frame."""
type NftCollectionNonCurrencyStats {
  """The number of mints over the time frame."""
  mints: NftStatsNumberMetrics
  """The number of sales over the time frame."""
  sales: NftStatsNumberMetrics
  """The number of tokens sold over the time frame."""
  tokensSold: NftStatsStringMetrics
  """The number of transfers over the time frame."""
  transfers: NftStatsNumberMetrics
  """The number of unique buyers over the time frame."""
  uniqueBuyers: NftStatsNumberMetrics
  """The number of unique sellers over the time frame."""
  uniqueSellers: NftStatsNumberMetrics
  """The number of unique wallets (buyers or sellers) over the time frame."""
  uniqueSalesWallets: NftStatsNumberMetrics
  """The number of unique minters over the time frame."""
  uniqueMinters: NftStatsNumberMetrics
}

NftCollectionPriceStats

Price stats for an NFT collection over a time frame. Either in USD or the network’s base token.

volume
String!
required

The trade volume.

floor
String!
required

The lowest sale price.

average
String!
required

The average sale price.

ceiling
String!
required

The highest sale price.

volumeChange
Float

The change in volume between the previous and current time frame.

floorChange
Float

The change in floor price between the previous and current time frame.

averageChange
Float

The change in average price between the previous and current time frame.

ceilingChange
Float

The change in ceiling price between the previous and current time frame.

volumeByFillsource
[NftCollectionFillsourceStringStat]

The volume partitioned by fillsource over the time frame

volumePercentByFillsource
[NftCollectionFillsourceNumberStat]

The percentages of total volume partitioned by fillsource over the time frame

"""Price stats for an NFT collection over a time frame. Either in USD or the network's base token."""
type NftCollectionPriceStats {
  """The trade volume."""
  volume: String!
  """The lowest sale price."""
  floor: String!
  """The average sale price."""
  average: String!
  """The highest sale price."""
  ceiling: String!
  """The change in volume between the previous and current time frame."""
  volumeChange: Float
  """The change in floor price between the previous and current time frame."""
  floorChange: Float
  """The change in average price between the previous and current time frame."""
  averageChange: Float
  """The change in ceiling price between the previous and current time frame."""
  ceilingChange: Float
  """The volume partitioned by fillsource over the time frame"""
  volumeByFillsource: [NftCollectionFillsourceStringStat]
  """The percentages of total volume partitioned by fillsource over the time frame"""
  volumePercentByFillsource: [NftCollectionFillsourceNumberStat]
}

NftCollectionWindowStats

Stats for an NFT collection for a time frame.

window
String!
required

The time frame used to calculate the stats.

usdPriceStats
NftCollectionPriceStats!
required

The price stats for the NFT collection in USD.

networkBaseTokenPriceStats
NftCollectionPriceStats!
required

The price stats for the NFT collection in the network’s base token.

tradeCount
String!
required

The trade count over the window.

tradeCountChange
Float!
required

The change in trade count between the previous and current window.

"""Stats for an NFT collection for a time frame."""
type NftCollectionWindowStats {
  """The time frame used to calculate the stats."""
  window: String!
  """The price stats for the NFT collection in USD."""
  usdPriceStats: NftCollectionPriceStats!
  """The price stats for the NFT collection in the network's base token."""
  networkBaseTokenPriceStats: NftCollectionPriceStats!
  """The trade count over the `window`."""
  tradeCount: String!
  """The change in trade count between the previous and current `window`."""
  tradeCountChange: Float!
}

NftContract

Metadata for an NFT collection.

id
String!
required

The ID of the NFT collection (address:networkId).

address
String!
required

The contract address of the NFT collection.

networkId
Int!
required

The network ID the NFT collection is deployed on.

ercType
String!
required

The token standard. Can be a variation of ERC-721 or ERC-1155.

name
String

The name of the NFT collection.

description
String

The description of the NFT collection.

symbol
String

The symbol for the NFT collection.

totalSupply
String

The total supply of the NFT collection.

image
String

The URL for an image of the NFT collection.

"""Metadata for an NFT collection."""
type NftContract {
  """The ID of the NFT collection (`address`:`networkId`)."""
  id: String!
  """The contract address of the NFT collection."""
  address: String!
  """The network ID the NFT collection is deployed on."""
  networkId: Int!
  """The token standard. Can be a variation of `ERC-721` or `ERC-1155`."""
  ercType: String!
  """The name of the NFT collection."""
  name: String
  """The description of the NFT collection."""
  description: String
  """The symbol for the NFT collection."""
  symbol: String
  """The total supply of the NFT collection."""
  totalSupply: String
  """The URL for an image of the NFT collection."""
  image: String
}

NftEvent

An NFT collection transaction.

id
String!
required

The ID of the NFT event (contractAddress:tokenId:networkId).

contractAddress
String!
required

The contract address of the NFT collection.

networkId
Int!
required

The network ID the NFT collection is deployed on.

tokenId
String!
required

The token ID of the NFT asset involved in the transaction.

maker
String!
required

The wallet address of the buyer.

taker
String!
required

The wallet address of the seller.

tokenPrice
String!
required

No description provided

This field is deprecated. Some events may lack this value - use the nullable totalTradePrice. tokenPrice will return null values as an empty string.

totalPrice
String!
required

No description provided

This field is deprecated. Some events may lack this value - use the nullable totalTradePrice. totalPrice will return null values as an empty string.

totalTradePrice
String

The total trade price for the transaction in the purchasing token. (The transaction can include more than 1 token).

individualTokenPrice
String

No description provided

This field is deprecated. Some events may lack this value - use the nullable individualTradePrice. individualTokenPrice will return null values as an empty string.

individualPrice
String

No description provided

This field is deprecated. Some events may lack this value - use the nullable individualTradePrice. individualPrice will return null values as an empty string.

individualTradePrice
String

The price of each individual NFT in the purchasing token.

baseTokenAddress
String!
required

No description provided

This field is deprecated. No longer supported

paymentTokenAddress
String!
required

The contract address of the purchasing token.

baseTokenPrice
String

No description provided

This field is deprecated. No longer supported

totalPriceUsd
String

The total trade price for the transaction in USD. (The transaction can include more than 1 token).

individualBaseTokenPrice
String

No description provided

This field is deprecated. No longer supported

individualPriceUsd
String

The price of each individual NFT in USD.

networkBaseTokenPrice
String

No description provided

This field is deprecated. No longer supported

totalPriceNetworkBaseToken
String

The total trade price for the transaction in the network’s base token. (The transaction can include more than 1 token).

individualNetworkBaseTokenPrice
String

No description provided

This field is deprecated. No longer supported

individualPriceNetworkBaseToken
String

The price of each individual NFT in the network’s base token.

eventType
String!
required

The event type of the transaction.

exchangeAddress
String!
required

The NFT marketplace address of the transaction.

sortKey
String!
required

The sortKey for the event (blockNumber#transactionIndex#logIndex (+ #marketplaceEventLogIndex if applicable), zero padded). For example, 0000000016414564#00000224#00000413#00000414.

blockNumber
Int!
required

The block number for the transaction.

transactionIndex
Int!
required

The index of the transaction within the block.

logIndex
Int!
required

The index of the log in the block.

transactionHash
String!
required

The unique hash for the transaction.

timestamp
Int!
required

The unix timestamp for the transaction.

numberOfTokens
String

The number of assets involved in the transaction.

aggregatorAddress
String

The contract address of the marketplace aggregator that routed the transaction.

poolAddress
String

The contract address of the NFT pool, if applicable.

fillSource
String

The name of the marketplace that processed the transaction.

priceError
String

The reason for the price error, if applicable. Can be NO_TOKEN_DATA, NO_TOKEN_PRICE, or LOW_LIQUIDITY_PAIR.

tradeOffer
[NftEventTradeItem!]

The tokens/NFTs that were offered to make this transaction occur.

tradeReceived
[NftEventTradeItem!]

The tokens/NFTs that were received in this transaction.

orderDirection
NftEventOrderDirection

The direction of the order. One of ‘BUY’, ‘SELL’, or ‘OFFER_ACCEPTED’.

"""An NFT collection transaction."""
type NftEvent {
  """The ID of the NFT event (`contractAddress`:`tokenId`:`networkId`)."""
  id: String!
  """The contract address of the NFT collection."""
  contractAddress: String!
  """The network ID the NFT collection is deployed on."""
  networkId: Int!
  """The token ID of the NFT asset involved in the transaction."""
  tokenId: String!
  """The wallet address of the buyer."""
  maker: String!
  """The wallet address of the seller."""
  taker: String!
  tokenPrice: String! @deprecated(reason: "Some events may lack this value - use the nullable totalTradePrice. tokenPrice will return null values as an empty string.")
  totalPrice: String! @deprecated(reason: "Some events may lack this value - use the nullable totalTradePrice. totalPrice will return null values as an empty string.")
  """The total trade price for the transaction in the purchasing token. (The transaction can include more than 1 token)."""
  totalTradePrice: String
  individualTokenPrice: String @deprecated(reason: "Some events may lack this value - use the nullable individualTradePrice. individualTokenPrice will return null values as an empty string.")
  individualPrice: String @deprecated(reason: "Some events may lack this value - use the nullable individualTradePrice. individualPrice will return null values as an empty string.")
  """The price of each individual NFT in the purchasing token."""
  individualTradePrice: String
  baseTokenAddress: String! @deprecated(reason: "No longer supported")
  """The contract address of the purchasing token."""
  paymentTokenAddress: String!
  baseTokenPrice: String @deprecated(reason: "No longer supported")
  """The total trade price for the transaction in USD. (The transaction can include more than 1 token)."""
  totalPriceUsd: String
  individualBaseTokenPrice: String @deprecated(reason: "No longer supported")
  """The price of each individual NFT in USD."""
  individualPriceUsd: String
  networkBaseTokenPrice: String @deprecated(reason: "No longer supported")
  """The total trade price for the transaction in the network's base token. (The transaction can include more than 1 token)."""
  totalPriceNetworkBaseToken: String
  individualNetworkBaseTokenPrice: String @deprecated(reason: "No longer supported")
  """The price of each individual NFT in the network's base token."""
  individualPriceNetworkBaseToken: String
  """The event type of the transaction."""
  eventType: String!
  """The NFT marketplace address of the transaction."""
  exchangeAddress: String!
  """The sortKey for the event (`blockNumber`#`transactionIndex`#`logIndex` (+ #`marketplaceEventLogIndex` if applicable), zero padded). For example, `0000000016414564#00000224#00000413#00000414`."""
  sortKey: String!
  """The block number for the transaction."""
  blockNumber: Int!
  """The index of the transaction within the block."""
  transactionIndex: Int!
  """The index of the log in the block."""
  logIndex: Int!
  """The unique hash for the transaction."""
  transactionHash: String!
  """The unix timestamp for the transaction."""
  timestamp: Int!
  """The number of assets involved in the transaction."""
  numberOfTokens: String
  """The contract address of the marketplace aggregator that routed the transaction."""
  aggregatorAddress: String
  """The contract address of the NFT pool, if applicable."""
  poolAddress: String
  """The name of the marketplace that processed the transaction."""
  fillSource: String
  """The reason for the price error, if applicable. Can be `NO_TOKEN_DATA`, `NO_TOKEN_PRICE`, or `LOW_LIQUIDITY_PAIR`."""
  priceError: String
  """The tokens/NFTs that were offered to make this transaction occur."""
  tradeOffer: [NftEventTradeItem!]
  """The tokens/NFTs that were received in this transaction."""
  tradeReceived: [NftEventTradeItem!]
  """The direction of the order. One of 'BUY', 'SELL', or 'OFFER_ACCEPTED'."""
  orderDirection: NftEventOrderDirection
}

NftEventFillSourceCondition

NFT marketplaces for a webhook to listen on.

oneOf
[WebhookNftEventFillSource!]!
required

The list of NFT marketplaces.

"""NFT marketplaces for a webhook to listen on."""
type NftEventFillSourceCondition {
  """The list of NFT marketplaces."""
  oneOf: [WebhookNftEventFillSource!]!
}

NftEventNftTradeItem

Details for an NFT offered or received as part of an nft trade.

address
String!
required

The contract address for the NFT.

amount
String!
required

The number of tokens transferred. (Always 1 for ERC721 NFTs)

recipient
String

The recipient of the NFT.

type
NftEventTradeItemType!
required

The type of item involved in the trade. (Always NFT)

tokenId
String!
required

The token ID of the exchanged NFT

"""Details for an NFT offered or received as part of an nft trade."""
type NftEventNftTradeItem {
  """The contract address for the NFT."""
  address: String!
  """The number of tokens transferred. (Always 1 for ERC721 NFTs)"""
  amount: String!
  """The recipient of the NFT."""
  recipient: String
  """The type of item involved in the trade. (Always NFT)"""
  type: NftEventTradeItemType!
  """The token ID of the exchanged NFT"""
  tokenId: String!
}

NftEventsConnection

Response returned by getNftEvents.

items
[NftEvent]

A list of transactions for an NFT collection.

cursor
String

A cursor for use in pagination.

"""Response returned by `getNftEvents`."""
type NftEventsConnection {
  """A list of transactions for an NFT collection."""
  items: [NftEvent]
  """A cursor for use in pagination."""
  cursor: String
}

NftEventTokenTradeItem

Details for a token(s) offered or received as part of an nft trade.

address
String!
required

The contract address for the token.

amount
String!
required

The number of tokens transferred.

recipient
String

The recipient of the tokens.

type
NftEventTradeItemType!
required

The type of item involved in the trade. (Always TOKEN)

isPrice
Boolean!
required

Whether this should be summed to calculate the price of the NFT received in the base event. Tokens that are payment fees or involved with other sales in the transaction are often represented in sales and would have a value of false.

totalTradePrice
String

The total trade price for the transaction in the purchasing token. (The transaction can include more than 1 token).

individualTradePrice
String

The price of each individual NFT in the purchasing token.

totalPriceUsd
String

The total trade price for the transaction in USD. (The transaction can include more than 1 token).

individualPriceUsd
String

The price of each individual NFT in USD.

totalPriceNetworkBaseToken
String

The total trade price for the transaction in the network’s base token. (The transaction can include more than 1 token).

individualPriceNetworkBaseToken
String

The price of each individual NFT in the network’s base token.

priceError
String

The reason for the price error, if applicable. Can be NO_TOKEN_DATA, NO_TOKEN_PRICE, or LOW_LIQUIDITY_PAIR.

"""Details for a token(s) offered or received as part of an nft trade."""
type NftEventTokenTradeItem {
  """The contract address for the token."""
  address: String!
  """The number of tokens transferred."""
  amount: String!
  """The recipient of the tokens."""
  recipient: String
  """The type of item involved in the trade. (Always TOKEN)"""
  type: NftEventTradeItemType!
  """Whether this should be summed to calculate the price of the NFT received in the base event. Tokens that are payment fees or involved with other sales in the transaction are often represented in sales and would have a value of `false`."""
  isPrice: Boolean!
  """The total trade price for the transaction in the purchasing token. (The transaction can include more than 1 token)."""
  totalTradePrice: String
  """The price of each individual NFT in the purchasing token."""
  individualTradePrice: String
  """The total trade price for the transaction in USD. (The transaction can include more than 1 token)."""
  totalPriceUsd: String
  """The price of each individual NFT in USD."""
  individualPriceUsd: String
  """The total trade price for the transaction in the network's base token. (The transaction can include more than 1 token)."""
  totalPriceNetworkBaseToken: String
  """The price of each individual NFT in the network's base token."""
  individualPriceNetworkBaseToken: String
  """The reason for the price error, if applicable. Can be `NO_TOKEN_DATA`, `NO_TOKEN_PRICE`, or `LOW_LIQUIDITY_PAIR`."""
  priceError: String
}

NftEventTypeCondition

An NFT event type for a webhook to listen for.

eq
WebhookNftEventType!
required

The NFT event type.

"""An NFT event type for a webhook to listen for."""
type NftEventTypeCondition {
  """The NFT event type."""
  eq: WebhookNftEventType!
}

NftEventWebhookCondition

Webhook conditions for an NFT event.

networkId
OneOfNumberCondition

The list of network IDs the webhook is listening on.

maker
StringEqualsCondition

The maker wallet address the webhook is listening for.

contractAddress
StringEqualsCondition

The NFT collection contract address the webhook is listening for.

exchangeAddress
StringEqualsCondition

The exchange contract address the webhook is listening for.

tokenId
StringEqualsCondition

The token ID the webhook is listening for.

tokenAddress
StringEqualsCondition

The token contract address the webhook is listening for.

individualBaseTokenPrice
ComparisonOperator

The base token price the webhook is listening for.

eventType
NftEventTypeCondition

The NFT event type the webhook is listening for.

fillSource
NftEventFillSourceCondition

The NFT marketplaces the webhook is listening on.

ignoreTransfers
Boolean

Option to ignore all nft transfer events

"""Webhook conditions for an NFT event."""
type NftEventWebhookCondition {
  """The list of network IDs the webhook is listening on."""
  networkId: OneOfNumberCondition
  """The maker wallet address the webhook is listening for."""
  maker: StringEqualsCondition
  """The NFT collection contract address the webhook is listening for."""
  contractAddress: StringEqualsCondition
  """The exchange contract address the webhook is listening for."""
  exchangeAddress: StringEqualsCondition
  """The token ID the webhook is listening for."""
  tokenId: StringEqualsCondition
  """The token contract address the webhook is listening for."""
  tokenAddress: StringEqualsCondition
  """The base token price the webhook is listening for."""
  individualBaseTokenPrice: ComparisonOperator
  """The NFT event type the webhook is listening for."""
  eventType: NftEventTypeCondition
  """The NFT marketplaces the webhook is listening on."""
  fillSource: NftEventFillSourceCondition
  """Option to ignore all nft transfer events"""
  ignoreTransfers: Boolean
}

NftFillsourceStatsNumberMetrics

Number metrics for NFT fillsource stats.

fillsource
String

Marketplace that filled the NFT order volume. (ex. OPENSEA, BLUR, etc.)

current
Float

The total value for the current window.

previous
Float

The total value for the previous window.

change
Float

The percent change between the current and previous.

"""Number metrics for NFT fillsource stats."""
type NftFillsourceStatsNumberMetrics {
  """Marketplace that filled the NFT order volume. (ex. OPENSEA, BLUR, etc.)"""
  fillsource: String
  """The total value for the current window."""
  current: Float
  """The total value for the previous window."""
  previous: Float
  """The percent change between the `current` and `previous`."""
  change: Float
}

NftFillsourceStatsStringMetrics

String metrics for NFT stats.

fillsource
String

Marketplace that filled the NFT order volume. (ex. OPENSEA, BLUR, etc.)

current
String

The total value for the current window.

previous
String

The total value for the previous window.

change
Float

The percent change between the current and previous.

"""String metrics for NFT stats."""
type NftFillsourceStatsStringMetrics {
  """Marketplace that filled the NFT order volume. (ex. OPENSEA, BLUR, etc.)"""
  fillsource: String
  """The total value for the current window."""
  current: String
  """The total value for the previous window."""
  previous: String
  """The percent change between the `current` and `previous`."""
  change: Float
}

NftHoldersResponse

items
[NftBalance!]!
required

The list wallets for a collection.

count
Int!
required

the unique count of holders for the collection.

cursor
String

A cursor for use in pagination.

status
HoldersStatus!
required

Status of holder. Disabled if on unsupported network or there is insufficient holder data.

type NftHoldersResponse {
  """The list wallets for a collection."""
  items: [NftBalance!]!
  """the unique count of holders for the collection."""
  count: Int!
  """A cursor for use in pagination."""
  cursor: String
  """Status of holder. Disabled if on unsupported network or there is insufficient holder data."""
  status: HoldersStatus!
}

NftPoolAssetRecipientUpdateEventData

Event data for updating the asset recipient of a pool.

type
NftPoolEventType!
required

The type of NFT pool event, ASSET_RECIPIENT_CHANGE.

newAssetRecipient
String!
required

The updated wallet address that will receive the tokens or NFT sent to the pair during swaps.

"""Event data for updating the asset recipient of a pool."""
type NftPoolAssetRecipientUpdateEventData {
  """The type of NFT pool event, `ASSET_RECIPIENT_CHANGE`."""
  type: NftPoolEventType!
  """The updated wallet address that will receive the tokens or NFT sent to the pair during swaps."""
  newAssetRecipient: String!
}

NftPoolCollectionFilterConnection

Response returned by filterNftPoolCollections.

results
[NftPoolCollectionFilterResult]

The list of NFT collections matching the filter parameters.

count
Int

The number of NFT collections returned.

page
Int

Where in the list the server started when returning items.

"""Response returned by `filterNftPoolCollections`."""
type NftPoolCollectionFilterConnection {
  """The list of NFT collections matching the filter parameters."""
  results: [NftPoolCollectionFilterResult]
  """The number of NFT collections returned."""
  count: Int
  """Where in the list the server started when returning items."""
  page: Int
}

NftPoolCollectionFilterResult

An NFT pool collection.

id
String!
required

The ID of the NFT collection (collectionAddress:exchangeAddress:networkId).

timestamp
Int

The unix timestamp indicating the last time the data was updated. Updates every 2 hours.

name
String

The name of the NFT collection.

symbol
String

The symbol for the NFT collection.

exchangeAddress
String

The contract address of the NFT AMM marketplace.

collectionAddress
String

The contract address of the NFT collection.

networkId
Int

The network ID the NFT collection is deployed on.

ercType
String

The token standard. Can be a variation of ERC-721 or ERC-1155.

imageUrl
String

The image URL for the collection or one of the assets within the collection.

nftBalance
Int

The number of NFTs in all of the collection’s pools.

This field is deprecated. nftBalance is changing from Int to String - use nftBalanceV2 instead.

nftBalanceV2
String

The number of NFTs in all of the collection’s pools.

balanceNBT
String

The total liquidity of the collection in the network’s base token.

floorNBT
String

The lowest price at which any of the collection’s pools are willing to sell an NFT in the network’s base token.

offerNBT
String

The highest price at which any of the collection’s pools are willing to buy an NFT in the network’s base token.

balanceUSD
String

The total liquidity of the collection in USD.

floorUSD
String

The lowest price at which any of the collection’s pools are willing to sell an NFT in USD.

offerUSD
String

The highest price at which any of the collection’s pools are willing to buy an NFT in USD.

totalSupply
Int

The total supply of the collection.

This field is deprecated. totalSupply is changing from Int to String - use totalSupplyV2 instead.

totalSupplyV2
String

No description provided

nftsSoldAll
Int

The number of NFTs sold in any of the collection’s pools over the collection’s lifetime.

This field is deprecated. nftsSoldAll is changing from Int to String - use nftsSoldAllV2 instead.

nftsSoldAllV2
String

The number of NFTs sold in any of the collection’s pools over the collection’s lifetime.

nftsBoughtAll
Int

The number of NFTs bought in any of the collection’s pools over the collection’s lifetime.

This field is deprecated. nftsBoughtAll is changing from Int to String - use nftsBoughtAllV2 instead.

nftsBoughtAllV2
String

The number of NFTs bought in any of the collection’s pools over the collection’s lifetime.

nftVolumeAll
Int

The number of NFTs bought or sold in any of the collection’s pools over the collection’s lifetime.

This field is deprecated. nftVolumeAll is changing from Int to String - use nftVolumeAllV2 instead.

nftVolumeAllV2
String

The number of NFTs bought or sold in any of the collection’s pools over the collection’s lifetime.

volumeNBTAll
String

The total volume of the collection in the network’s base token over the collection’s lifetime.

revenueNBTAll
String

The total buy volume of the collection in the network’s base token over the collection’s lifetime.

expenseNBTAll
String

The total sell volume of the collection in the network’s base token over the collection’s lifetime.

highPriceNBTAll
String

The highest sale price within the collection in the network’s base token in the collection’s lifetime.

lowPriceNBTAll
String

The lowest sale price within the collection in the network’s base token in the collection’s lifetime.

poolFeesNBTAll
String

The sum of pool fees generated by the collection in the network’s base token over the collection’s lifetime.

protocolFeesNBTAll
String

The sum of protocol fees generated by the collection in the network’s base token over the collection’s lifetime.

volumeUSDAll
String

The total volume of the collection in USD over the collection’s lifetime.

revenueUSDAll
String

The total buy volume of the collection in USD over the collection’s lifetime.

expenseUSDAll
String

The total sell volume of the collection in USD over the collection’s lifetime.

highPriceUSDAll
String

The highest sale price within the collection in USD in the collection’s lifetime.

lowPriceUSDAll
String

The lowest sale price within the collection in USD in the collection’s lifetime.

poolFeesUSDAll
String

The sum of pool fees generated by the collection in USD over the collection’s lifetime.

protocolFeesUSDAll
String

The sum of protocol fees generated by the collection in USD over the collection’s lifetime.

nftsSold24
Int

The number of NFTs sold in any of the collection’s pools over the past 24 hours.

This field is deprecated. nftsSold24 is changing from Int to String - use nftsSold24V2 instead.

nftsSold24V2
String

The number of NFTs sold in any of the collection’s pools over the past 24 hours.

nftsBought24
Int

The number of NFTs bought in any of the collection’s pools over the past 24 hours.

This field is deprecated. nftsBought24 is changing from Int to String - use nftsBought24V2 instead.

nftsBought24V2
String

The number of NFTs bought in any of the collection’s pools over the past 24 hours.

nftVolume24
Int

The number of NFTs bought and sold in any of the collection’s pools over the past 24 hours.

This field is deprecated. nftVolume24 is changing from Int to String - use nftVolume24V2 instead.

nftVolume24V2
String

The number of NFTs bought and sold in any of the collection’s pools over the past 24 hours.

volumeNBT24
String

The total volume of the collection in the network’s base token over the past 24 hours.

revenueNBT24
String

The total buy volume of the collection in the network’s base token over the past 24 hours.

expenseNBT24
String

The total sell volume of the collection in the network’s base token over the past 24 hours.

highPriceNBT24
String

The highest sale price within the collection in the network’s base token in the past 24 hours.

lowPriceNBT24
String

The lowest sale price within the collection in the network’s base token in the past 24 hours.

poolFeesNBT24
String

The sum of pool fees generated by the collection in the network’s base token over the past 24 hours.

protocolFeesNBT24
String

The sum of protocol fees generated by the collection in the network’s base token over the past 24 hours.

volumeUSD24
String

The total volume of the collection in USD over the past 24 hours.

revenueUSD24
String

The total buy volume of the collection in USD over the past 24 hours.

expenseUSD24
String

The total sell volume of the collection in USD over the past 24 hours.

highPriceUSD24
String

The highest sale price within the collection in USD in the past 24 hours.

lowPriceUSD24
String

The lowest sale price within the collection in USD in the past 24 hours.

poolFeesUSD24
String

The sum of pool fees generated by the collection in USD over the past 24 hours.

protocolFeesUSD24
String

The sum of protocol fees generated by the collection in USD over the past 24 hours.

"""An NFT pool collection."""
type NftPoolCollectionFilterResult {
  """The ID of the NFT collection (`collectionAddress`:`exchangeAddress`:`networkId`)."""
  id: String!
  """The unix timestamp indicating the last time the data was updated. Updates every 2 hours."""
  timestamp: Int
  """The name of the NFT collection."""
  name: String
  """The symbol for the NFT collection."""
  symbol: String
  """The contract address of the NFT AMM marketplace."""
  exchangeAddress: String
  """The contract address of the NFT collection."""
  collectionAddress: String
  """The network ID the NFT collection is deployed on."""
  networkId: Int
  """The token standard. Can be a variation of `ERC-721` or `ERC-1155`."""
  ercType: String
  """The image URL for the collection or one of the assets within the collection."""
  imageUrl: String
  """The number of NFTs in all of the collection's pools."""
  nftBalance: Int @deprecated(reason: "nftBalance is changing from Int to String - use nftBalanceV2 instead.")
  """The number of NFTs in all of the collection's pools."""
  nftBalanceV2: String
  """The total liquidity of the collection in the network's base token."""
  balanceNBT: String
  """The lowest price at which any of the collection's pools are willing to sell an NFT in the network's base token."""
  floorNBT: String
  """The highest price at which any of the collection's pools are willing to buy an NFT in the network's base token."""
  offerNBT: String
  """The total liquidity of the collection in USD."""
  balanceUSD: String
  """The lowest price at which any of the collection's pools are willing to sell an NFT in USD."""
  floorUSD: String
  """The highest price at which any of the collection's pools are willing to buy an NFT in USD."""
  offerUSD: String
  """The total supply of the collection."""
  totalSupply: Int @deprecated(reason: "totalSupply is changing from Int to String - use totalSupplyV2 instead.")
  totalSupplyV2: String
  """The number of NFTs sold in any of the collection's pools over the collection's lifetime."""
  nftsSoldAll: Int @deprecated(reason: "nftsSoldAll is changing from Int to String - use nftsSoldAllV2 instead.")
  """The number of NFTs sold in any of the collection's pools over the collection's lifetime."""
  nftsSoldAllV2: String
  """The number of NFTs bought in any of the collection's pools over the collection's lifetime."""
  nftsBoughtAll: Int @deprecated(reason: "nftsBoughtAll is changing from Int to String - use nftsBoughtAllV2 instead.")
  """The number of NFTs bought in any of the collection's pools over the collection's lifetime."""
  nftsBoughtAllV2: String
  """The number of NFTs bought or sold in any of the collection's pools over the collection's lifetime."""
  nftVolumeAll: Int @deprecated(reason: "nftVolumeAll is changing from Int to String - use nftVolumeAllV2 instead.")
  """The number of NFTs bought or sold in any of the collection's pools over the collection's lifetime."""
  nftVolumeAllV2: String
  """The total volume of the collection in the network's base token over the collection's lifetime."""
  volumeNBTAll: String
  """The total buy volume of the collection in the network's base token over the collection's lifetime."""
  revenueNBTAll: String
  """The total sell volume of the collection in the network's base token over the collection's lifetime."""
  expenseNBTAll: String
  """The highest sale price within the collection in the network's base token in the collection's lifetime."""
  highPriceNBTAll: String
  """The lowest sale price within the collection in the network's base token in the collection's lifetime."""
  lowPriceNBTAll: String
  """The sum of pool fees generated by the collection in the network's base token over the collection's lifetime."""
  poolFeesNBTAll: String
  """The sum of protocol fees generated by the collection in the network's base token over the collection's lifetime."""
  protocolFeesNBTAll: String
  """The total volume of the collection in USD over the collection's lifetime."""
  volumeUSDAll: String
  """The total buy volume of the collection in USD over the collection's lifetime."""
  revenueUSDAll: String
  """The total sell volume of the collection in USD over the collection's lifetime."""
  expenseUSDAll: String
  """The highest sale price within the collection in USD in the collection's lifetime."""
  highPriceUSDAll: String
  """The lowest sale price within the collection in USD in the collection's lifetime."""
  lowPriceUSDAll: String
  """The sum of pool fees generated by the collection in USD over the collection's lifetime."""
  poolFeesUSDAll: String
  """The sum of protocol fees generated by the collection in USD over the collection's lifetime."""
  protocolFeesUSDAll: String
  """The number of NFTs sold in any of the collection's pools over the past 24 hours."""
  nftsSold24: Int @deprecated(reason: "nftsSold24 is changing from Int to String - use nftsSold24V2 instead.")
  """The number of NFTs sold in any of the collection's pools over the past 24 hours."""
  nftsSold24V2: String
  """The number of NFTs bought in any of the collection's pools over the past 24 hours."""
  nftsBought24: Int @deprecated(reason: "nftsBought24 is changing from Int to String - use nftsBought24V2 instead.")
  """The number of NFTs bought in any of the collection's pools over the past 24 hours."""
  nftsBought24V2: String
  """The number of NFTs bought and sold in any of the collection's pools over the past 24 hours."""
  nftVolume24: Int @deprecated(reason: "nftVolume24 is changing from Int to String - use nftVolume24V2 instead.")
  """The number of NFTs bought and sold in any of the collection's pools over the past 24 hours."""
  nftVolume24V2: String
  """The total volume of the collection in the network's base token over the past 24 hours."""
  volumeNBT24: String
  """The total buy volume of the collection in the network's base token over the past 24 hours."""
  revenueNBT24: String
  """The total sell volume of the collection in the network's base token over the past 24 hours."""
  expenseNBT24: String
  """The highest sale price within the collection in the network's base token in the past 24 hours."""
  highPriceNBT24: String
  """The lowest sale price within the collection in the network's base token in the past 24 hours."""
  lowPriceNBT24: String
  """The sum of pool fees generated by the collection in the network's base token over the past 24 hours."""
  poolFeesNBT24: String
  """The sum of protocol fees generated by the collection in the network's base token over the past 24 hours."""
  protocolFeesNBT24: String
  """The total volume of the collection in USD over the past 24 hours."""
  volumeUSD24: String
  """The total buy volume of the collection in USD over the past 24 hours."""
  revenueUSD24: String
  """The total sell volume of the collection in USD over the past 24 hours."""
  expenseUSD24: String
  """The highest sale price within the collection in USD in the past 24 hours."""
  highPriceUSD24: String
  """The lowest sale price within the collection in USD in the past 24 hours."""
  lowPriceUSD24: String
  """The sum of pool fees generated by the collection in USD over the past 24 hours."""
  poolFeesUSD24: String
  """The sum of protocol fees generated by the collection in USD over the past 24 hours."""
  protocolFeesUSD24: String
}

NftPoolCollectionResponse

An NFT collection in an NFT pool.

collectionId
String!
required

The ID of the NFT collection (collectionAddress:networkId).

collectionAddress
String!
required

The contract address of the NFT collection.

collectionSymbol
String!
required

The symbol of the NFT collection.

exchangeId
String!
required

The ID of the exchange (exchangeAddress:networkId).

exchangeAddress
String!
required

The contract address of the NFT AMM marketplace.

name
String

The name of the NFT collection.

image
String

An image associated with the NFT collection.

networkId
Int!
required

The network ID the NFT collection is deployed on.

floorNBT
String

The lowest price at which any of the NFT collection’s pools are willing to sell an NFT in the network’s base token.

offerNBT
String

The highest price at which any of the NFT collection’s pools are willing to buy an NFT in the network’s base token.

balanceNBT
String!
required

The total liquidity of the collection in the network’s base token.

nftBalance
Int!
required

The current number of NFTs in all the NFT collection’s pools.

This field is deprecated. nftBalance is changing from Int to String - use nftBalanceV2 instead.

nftBalanceV2
String!
required

The current number of NFTs in all the NFT collection’s pools.

volumeAllTimeNBT
String

The total volume of the collection in the network’s base token over the collection’s lifetime.

volumeAllTimeUSD
String

The total volume of the collection in USD over the collection’s lifetime.

nftVolumeAllTime
Int

The total number of NFTs bought and sold over the collection’s lifetime.

This field is deprecated. nftVolumeAllTime is changing from Int to String - use nftVolumeAllTimeV2 instead.

nftVolumeAllTimeV2
String

The total number of NFTs bought and sold over the collection’s lifetime.

media
NftAssetMedia

The media for one of the assets within the NFT collection.

This field is deprecated. Use image from NftContract instead.

protocolFeesNBTAll
String

The sum of protocol fees generated by the collection in the network’s base token over the collection’s lifetime.

protocolFeesUSDAll
String

The sum of protocol fees generated by the collection in USD over the collection’s lifetime.

poolFeesNBTAll
String

The sum of pool fees generated by the collection in the network’s base token over the collection’s lifetime.

poolFeesUSDAll
String

The sum of pool fees generated by the collection in USD over the collection’s lifetime.

royaltiesNBTAllEstimate
String

As estimated sum in the network’s base token of the collection’s royalties paid to creators by pool swaps over the collection’s lifetime.

royaltiesUSDAllEstimate
String

An estimated sum in USD of the collection’s royalties paid to creators by pool swaps over the collection’s lifetime.

"""An NFT collection in an NFT pool."""
type NftPoolCollectionResponse {
  """The ID of the NFT collection (`collectionAddress`:`networkId`)."""
  collectionId: String!
  """The contract address of the NFT collection."""
  collectionAddress: String!
  """The symbol of the NFT collection."""
  collectionSymbol: String!
  """The ID of the exchange (`exchangeAddress`:`networkId`)."""
  exchangeId: String!
  """The contract address of the NFT AMM marketplace."""
  exchangeAddress: String!
  """The name of the NFT collection."""
  name: String
  """An image associated with the NFT collection."""
  image: String
  """The network ID the NFT collection is deployed on."""
  networkId: Int!
  """The lowest price at which any of the NFT collection's pools are willing to sell an NFT in the network's base token."""
  floorNBT: String
  """The highest price at which any of the NFT collection's pools are willing to buy an NFT in the network's base token."""
  offerNBT: String
  """The total liquidity of the collection in the network's base token."""
  balanceNBT: String!
  """The current number of NFTs in all the NFT collection's pools."""
  nftBalance: Int! @deprecated(reason: "nftBalance is changing from Int to String - use nftBalanceV2 instead.")
  """The current number of NFTs in all the NFT collection's pools."""
  nftBalanceV2: String!
  """The total volume of the collection in the network's base token over the collection's lifetime."""
  volumeAllTimeNBT: String
  """The total volume of the collection in USD over the collection's lifetime."""
  volumeAllTimeUSD: String
  """The total number of NFTs bought and sold over the collection's lifetime."""
  nftVolumeAllTime: Int @deprecated(reason: "nftVolumeAllTime is changing from Int to String - use nftVolumeAllTimeV2 instead.")
  """The total number of NFTs bought and sold over the collection's lifetime."""
  nftVolumeAllTimeV2: String
  """The media for one of the assets within the NFT collection."""
  media: NftAssetMedia @deprecated(reason: "Use `image` from `NftContract` instead.")
  """The sum of protocol fees generated by the collection in the network's base token over the collection's lifetime."""
  protocolFeesNBTAll: String
  """The sum of protocol fees generated by the collection in USD over the collection's lifetime."""
  protocolFeesUSDAll: String
  """The sum of pool fees generated by the collection in the network's base token over the collection's lifetime."""
  poolFeesNBTAll: String
  """The sum of pool fees generated by the collection in USD over the collection's lifetime."""
  poolFeesUSDAll: String
  """As estimated sum in the network's base token of the collection's royalties paid to creators by pool swaps over the collection's lifetime."""
  royaltiesNBTAllEstimate: String
  """An estimated sum in USD of the collection's royalties paid to creators by pool swaps over the collection's lifetime."""
  royaltiesUSDAllEstimate: String
}

NftPoolDeltaUpdateEventData

Event data for updating the delta of a pool.

type
NftPoolEventType!
required

The type of NFT pool event, DELTA_UPDATE.

newDelta
String!
required

The updated delta used in the bonding curve.

"""Event data for updating the delta of a pool."""
type NftPoolDeltaUpdateEventData {
  """The type of NFT pool event, `DELTA_UPDATE`."""
  type: NftPoolEventType!
  """The updated delta used in the bonding curve."""
  newDelta: String!
}

NftPoolEvent

An NFT pool transaction.

id
String!
required

The ID of the NFT pool (poolAddress:networkId). For example, 0xdbea289dcc10eed8431e78753414a3d81b8e7201:1.

poolAddress
String!
required

The contract address of the NFT pool.

networkId
Int!
required

The network ID the NFT collection is deployed on.

collectionAddress
String!
required

The contract address of the NFT collection.

collectionId
String!
required

The ID of the NFT collection (collectionAddress:networkId).

exchangeAddress
String!
required

The contract address of the NFT AMM marketplace.

tokenAddress
String!
required

The contract address of the liquidity token of the pool (usually WETH).

blockNumber
Int!
required

The block number for the transaction.

logIndex
Int!
required

The index of the log in the block.

transactionIndex
Int!
required

The index of the transaction within the block.

blockHash
String!
required

The hash of the block where the transaction occurred.

transactionHash
String!
required

The unique hash for the transaction.

timestamp
Int!
required

The unix timestamp for the transaction.

maker
String!
required

The wallet address that transacted.

poolType
NftPoolType!
required

The type of liquidity pool.

eventType
NftPoolEventType!
required

The event type of the transaction.

data
NftPoolEventData!
required

The event-specific data for the transaction.

"""An NFT pool transaction."""
type NftPoolEvent {
  """The ID of the NFT pool (`poolAddress`:`networkId`). For example, `0xdbea289dcc10eed8431e78753414a3d81b8e7201:1`."""
  id: String!
  """The contract address of the NFT pool."""
  poolAddress: String!
  """The network ID the NFT collection is deployed on."""
  networkId: Int!
  """The contract address of the NFT collection."""
  collectionAddress: String!
  """The ID of the NFT collection (`collectionAddress`:`networkId`)."""
  collectionId: String!
  """The contract address of the NFT AMM marketplace."""
  exchangeAddress: String!
  """The contract address of the liquidity token of the pool (usually WETH)."""
  tokenAddress: String!
  """The block number for the transaction."""
  blockNumber: Int!
  """The index of the log in the block."""
  logIndex: Int!
  """The index of the transaction within the block."""
  transactionIndex: Int!
  """The hash of the block where the transaction occurred."""
  blockHash: String!
  """The unique hash for the transaction."""
  transactionHash: String!
  """The unix timestamp for the transaction."""
  timestamp: Int!
  """The wallet address that transacted."""
  maker: String!
  """The type of liquidity pool."""
  poolType: NftPoolType!
  """The event type of the transaction."""
  eventType: NftPoolEventType!
  """The event-specific data for the transaction."""
  data: NftPoolEventData!
}

NftPoolEventNftTransfer

Metadata for an NFT transfer.

nftTokenId
String!
required

The NFT token ID involved in the transfer.

amountT
String!
required

The value of the NFT at the time of transfer.

"""Metadata for an NFT transfer."""
type NftPoolEventNftTransfer {
  """The NFT token ID involved in the transfer."""
  nftTokenId: String!
  """The value of the NFT at the time of transfer."""
  amountT: String!
}

NftPoolEventNftTransferV2

Metadata for an NFT transfer.

nftTokenId
String!
required

The NFT token ID involved in the transfer.

nftQuantity
String!
required

The number of tokens involved in the transfer.

nftTokenQuantity
String!
required

The number of tokens involved in the transfer.

This field is deprecated. nftTokenQuantity is no longer supported - use nftQuantity instead.

amountT
String!
required

The value of the token at the time of transfer.

"""Metadata for an NFT transfer."""
type NftPoolEventNftTransferV2 {
  """The NFT token ID involved in the transfer."""
  nftTokenId: String!
  """The number of tokens involved in the transfer."""
  nftQuantity: String!
  """The number of tokens involved in the transfer."""
  nftTokenQuantity: String! @deprecated(reason: "nftTokenQuantity is no longer supported - use nftQuantity instead.")
  """The value of the token at the time of transfer."""
  amountT: String!
}

NftPoolEventsResponse

Response returned by getNftPoolEvents.

items
[NftPoolEvent]

A list of transactions for an NFT pool.

cursor
String

A cursor for use in pagination.

"""Response returned by `getNftPoolEvents`."""
type NftPoolEventsResponse {
  """A list of transactions for an NFT pool."""
  items: [NftPoolEvent]
  """A cursor for use in pagination."""
  cursor: String
}

NftPoolFeeUpdateEventData

Event data for updating the fee of a pool.

type
NftPoolEventType!
required

The type of NFT pool event, FEE_UPDATE.

newFeeT
String!
required

The updated pool fee in the pool’s liquidity token.

nbtRatio
String!
required

The ratio of the transaction token to the network’s base token.

usdRatio
String!
required

The ratio of the transaction token to USD.

"""Event data for updating the fee of a pool."""
type NftPoolFeeUpdateEventData {
  """The type of NFT pool event, `FEE_UPDATE`."""
  type: NftPoolEventType!
  """The updated pool fee in the pool's liquidity token."""
  newFeeT: String!
  """The ratio of the transaction token to the network's base token."""
  nbtRatio: String!
  """The ratio of the transaction token to USD."""
  usdRatio: String!
}

NftPoolFilterConnection

Response returned by filterNftPools.

results
[NftPoolFilterResult]

The list of NFT pools matching the filter parameters.

count
Int

The number of NFT pools returned.

page
Int

Where in the list the server started when returning items.

"""Response returned by `filterNftPools`."""
type NftPoolFilterConnection {
  """The list of NFT pools matching the filter parameters."""
  results: [NftPoolFilterResult]
  """The number of NFT pools returned."""
  count: Int
  """Where in the list the server started when returning items."""
  page: Int
}

NftPoolFilterResult

An NFT pool matching a set of filter parameters.

id
String!
required

The ID of the NFT pool (poolAddress:networkId).

poolAddress
String!
required

The contract address of the NFT pool.

timestamp
Int!
required

The unix timestamp indicating the last time the data was updated. Updates every 2 hours.

collectionAddress
String!
required

The contract address of the NFT collection.

exchangeAddress
String!
required

The contract address of the NFT AMM marketplace.

collectionName
String!
required

The name of the NFT collection.

collectionSymbol
String!
required

The symbol of the NFT collection.

networkId
Int!
required

The network ID the NFT collection is deployed on.

assetRecipientAddress
String

The wallet address that will receive the tokens or NFT sent to the pair during swaps.

bondingCurveAddress
String!
required

The contract address of the bonding curve.

delta
String!
required

The delta used in the pool’s bonding curve.

feeAmount
String!
required

The fee amount for the pool.

poolType
NftPoolType!
required

The type of liquidity pool.

tokenAddress
String!
required

The contract address of the liquidity token of the pool.

ownerAddress
String!
required

The wallet address of the pool owner.

poolVariant
GraphQlNftPoolVariant!
required

The pool variant. Can be ERC20 or NATIVE.

royalties
[NftPoolRoyalty]

The list of royalties for the pool. Only applicable for SUDOSWAP_V2 pools.

propertyChecker
String

The property checker contract address for the pool.

version
NftPoolContractVersion

The NFT pool contract version. Can be SUDOSWAP_V1 or SUDOSWAP_V2.

poolNftType
PoolNftType

The type of NFT in the pool.

acceptedNftTokenIds
[String]

For ERC1155 pools, the list of NFT token IDs that are accepted by the pool.

nftBalance
Int

The current number of NFTs in the pool.

This field is deprecated. nftBalance is changing from Int to String - use nftBalanceV2 instead.

nftBalanceV2
String

The current number of NFTs in the pool.

balanceNBT
String

The current pool liquidity in the network’s base token.

sellNBT
String

The current price at which the pool is willing to sell an NFT.

offerNBT
String

The current price at which the pool is willing to buy an NFT in the network’s base token.

spotNBT
String

The current spot price for the pool in the network’s base token.

balanceT
String

The current value of the collection in the pool’s liquidity token.

sellT
String

The current price at which the pool is willing to sell an NFT in the network’s base token.

offerT
String

The current price at which the pool is willing to buy an NFT in the pool’s liquidity token.

spotT
String

The current spot price for the pool in the pool’s liquidity token.

balanceUSD
String

The current pool liquidity in USD.

sellUSD
String

The current price at which the pool is willing to sell an NFT in USD.

offerUSD
String

The current price at which the pool is willing to buy an NFT in USD.

nftsSoldAll
Int

The total number of NFTs sold over the pool’s lifetime.

This field is deprecated. nftsSoldAll is changing from Int to String - use nftsSoldAllV2 instead.

nftsSoldAllV2
String

The total number of NFTs sold over the pool’s lifetime.

nftsBoughtAll
Int

The total number of NFTs bought over the pool’s lifetime.

This field is deprecated. nftsBoughtAll is changing from Int to String - use nftsBoughtAllV2 instead.

nftsBoughtAllV2
String

The total number of NFTs bought over the pool’s lifetime.

nftVolumeAll
Int

The total number of NFTs bought and sold over the pool’s lifetime.

This field is deprecated. nftVolumeAll is changing from Int to String - use nftVolumeAllV2 instead.

nftVolumeAllV2
String

The total number of NFTs bought and sold over the pool’s lifetime.

volumeNBTAll
String

The total volume of the pool in the network’s base token over the pool’s lifetime.

revenueNBTAll
String

The total buy volume of the pool in the network’s base token over the pool’s lifetime.

expenseNBTAll
String

The total sell volume of the pool in the network’s base token over the pool’s lifetime.

poolFeesNBTAll
String

The sum of pool fees generated by the pool in the network’s base token over the pool’s lifetime.

protocolFeesNBTAll
String

The sum of protocol fees generated by the pool in the network’s base token over the pool’s lifetime.

volumeTAll
String

The total volume of the pool in the pool’s liquidity token over the pool’s lifetime.

revenueTAll
String

The total buy volume of the pool in the pool’s liquidity token over the pool’s lifetime.

expenseTAll
String

The total sell volume of the pool in the pool’s liquidity token over the pool’s lifetime.

poolFeesTAll
String

The sum of pool fees generated by the pool in the pool’s liquidity token over the pool’s lifetime.

protocolFeesTAll
String

The sum of protocol fees generated by the pool in the pool’s liquidity token over the pool’s lifetime.

volumeUSDAll
String

The total volume of the pool in USD over the pool’s lifetime.

revenueUSDAll
String

The total buy volume of the pool in USD over the pool’s lifetime.

expenseUSDAll
String

The total sell volume of the pool in USD over the pool’s lifetime.

poolFeesUSDAll
String

The sum of pool fees generated by the pool in USD over the pool’s lifetime.

protocolFeesUSDAll
String

The sum of protocol fees generated by the pool in USD over the pool’s lifetime.

nftsSold24
Int

The total number of NFTs sold by the pool over the past 24 hours.

This field is deprecated. nftsSold24 is changing from Int to String - use nftsSold24V2 instead.

nftsSold24V2
String

The total number of NFTs sold by the pool over the past 24 hours.

nftsBought24
Int

The total number of NFTs bought by the pool over the past 24 hours.

This field is deprecated. nftsBought24 is changing from Int to String - use nftsBought24V2 instead.

nftsBought24V2
String

The total number of NFTs bought by the pool over the past 24 hours.

nftVolume24
Int

The total number of NFTs bought and sold over the past 24 hours.

This field is deprecated. nftVolume24 is changing from Int to String - use nftVolume24V2 instead.

nftVolume24V2
String

The total number of NFTs bought and sold over the past 24 hours.

volumeNBT24
String

The total volume of the pool in the network’s base token over the past 24 hours.

revenueNBT24
String

The total buy volume of the pool in the network’s base token over the past 24 hours.

expenseNBT24
String

The total sell volume of the pool in the network’s base token over the past 24 hours.

poolFeesNBT24
String

The sum of pool fees generated by the pool in the network’s base token over the past 24 hours.

protocolFeesNBT24
String

The sum of protocol fees generated by the pool in the network’s base token over the past 24 hours.

volumeT24
String

The total volume of the pool in the pool’s liquidity token over the past 24 hours.

revenueT24
String

The total buy volume of the pool in the pool’s liquidity token over the past 24 hours.

expenseT24
String

The total sell volume of the pool in the pool’s liquidity token over the past 24 hours.

poolFeesT24
String

The sum of pool fees generated by the pool in the pool’s liquidity token over the past 24 hours.

protocolFeesT24
String

The sum of protocol fees generated by the pool in the pool’s liquidity token over the past 24 hours.

volumeUSD24
String

The total volume of the pool in USD over the past 24 hours.

revenueUSD24
String

The total buy volume of the pool in USD over the past 24 hours.

expenseUSD24
String

The total sell volume of the pool in USD over the past 24 hours.

poolFeesUSD24
String

The sum of pool fees generated by the pool in USD over the past 24 hours.

protocolFeesUSD24
String

The sum of protocol fees generated by the pool in USD over the past 24 hours.

nftAssets
[NftAsset]

The list of NFT assets in the pool.

"""An NFT pool matching a set of filter parameters."""
type NftPoolFilterResult {
  """The ID of the NFT pool (`poolAddress`:`networkId`)."""
  id: String!
  """The contract address of the NFT pool."""
  poolAddress: String!
  """The unix timestamp indicating the last time the data was updated. Updates every 2 hours."""
  timestamp: Int!
  """The contract address of the NFT collection."""
  collectionAddress: String!
  """The contract address of the NFT AMM marketplace."""
  exchangeAddress: String!
  """The name of the NFT collection."""
  collectionName: String!
  """The symbol of the NFT collection."""
  collectionSymbol: String!
  """The network ID the NFT collection is deployed on."""
  networkId: Int!
  """The wallet address that will receive the tokens or NFT sent to the pair during swaps."""
  assetRecipientAddress: String
  """The contract address of the bonding curve."""
  bondingCurveAddress: String!
  """The delta used in the pool's bonding curve."""
  delta: String!
  """The fee amount for the pool."""
  feeAmount: String!
  """The type of liquidity pool."""
  poolType: NftPoolType!
  """The contract address of the liquidity token of the pool."""
  tokenAddress: String!
  """The wallet address of the pool owner."""
  ownerAddress: String!
  """The pool variant. Can be `ERC20` or `NATIVE`."""
  poolVariant: GraphQlNftPoolVariant!
  """The list of royalties for the pool. Only applicable for `SUDOSWAP_V2` pools."""
  royalties: [NftPoolRoyalty]
  """The property checker contract address for the pool."""
  propertyChecker: String
  """The NFT pool contract version. Can be `SUDOSWAP_V1` or `SUDOSWAP_V2`."""
  version: NftPoolContractVersion
  """The type of NFT in the pool."""
  poolNftType: PoolNftType
  """For ERC1155 pools, the list of NFT token IDs that are accepted by the pool."""
  acceptedNftTokenIds: [String]
  """The current number of NFTs in the pool."""
  nftBalance: Int @deprecated(reason: "nftBalance is changing from Int to String - use nftBalanceV2 instead.")
  """The current number of NFTs in the pool."""
  nftBalanceV2: String
  """The current pool liquidity in the network's base token."""
  balanceNBT: String
  """The current price at which the pool is willing to sell an NFT."""
  sellNBT: String
  """The current price at which the pool is willing to buy an NFT in the network's base token."""
  offerNBT: String
  """The current spot price for the pool in the network's base token."""
  spotNBT: String
  """The current value of the collection in the pool's liquidity token."""
  balanceT: String
  """The current price at which the pool is willing to sell an NFT in the network's base token."""
  sellT: String
  """The current price at which the pool is willing to buy an NFT in the pool's liquidity token."""
  offerT: String
  """The current spot price for the pool in the pool's liquidity token."""
  spotT: String
  """The current pool liquidity in USD."""
  balanceUSD: String
  """The current price at which the pool is willing to sell an NFT in USD."""
  sellUSD: String
  """The current price at which the pool is willing to buy an NFT in USD."""
  offerUSD: String
  """The total number of NFTs sold over the pool's lifetime."""
  nftsSoldAll: Int @deprecated(reason: "nftsSoldAll is changing from Int to String - use nftsSoldAllV2 instead.")
  """The total number of NFTs sold over the pool's lifetime."""
  nftsSoldAllV2: String
  """The total number of NFTs bought over the pool's lifetime."""
  nftsBoughtAll: Int @deprecated(reason: "nftsBoughtAll is changing from Int to String - use nftsBoughtAllV2 instead.")
  """The total number of NFTs bought over the pool's lifetime."""
  nftsBoughtAllV2: String
  """The total number of NFTs bought and sold over the pool's lifetime."""
  nftVolumeAll: Int @deprecated(reason: "nftVolumeAll is changing from Int to String - use nftVolumeAllV2 instead.")
  """The total number of NFTs bought and sold over the pool's lifetime."""
  nftVolumeAllV2: String
  """The total volume of the pool in the network's base token over the pool's lifetime."""
  volumeNBTAll: String
  """The total buy volume of the pool in the network's base token over the pool's lifetime."""
  revenueNBTAll: String
  """The total sell volume of the pool in the network's base token over the pool's lifetime."""
  expenseNBTAll: String
  """The sum of pool fees generated by the pool in the network's base token over the pool's lifetime."""
  poolFeesNBTAll: String
  """The sum of protocol fees generated by the pool in the network's base token over the pool's lifetime."""
  protocolFeesNBTAll: String
  """The total volume of the pool in the pool's liquidity token over the pool's lifetime."""
  volumeTAll: String
  """The total buy volume of the pool in the pool's liquidity token over the pool's lifetime."""
  revenueTAll: String
  """The total sell volume of the pool in the pool's liquidity token over the pool's lifetime."""
  expenseTAll: String
  """The sum of pool fees generated by the pool in the pool's liquidity token over the pool's lifetime."""
  poolFeesTAll: String
  """The sum of protocol fees generated by the pool in the pool's liquidity token over the pool's lifetime."""
  protocolFeesTAll: String
  """The total volume of the pool in USD over the pool's lifetime."""
  volumeUSDAll: String
  """The total buy volume of the pool in USD over the pool's lifetime."""
  revenueUSDAll: String
  """The total sell volume of the pool in USD over the pool's lifetime."""
  expenseUSDAll: String
  """The sum of pool fees generated by the pool in USD over the pool's lifetime."""
  poolFeesUSDAll: String
  """The sum of protocol fees generated by the pool in USD over the pool's lifetime."""
  protocolFeesUSDAll: String
  """The total number of NFTs sold by the pool over the past 24 hours."""
  nftsSold24: Int @deprecated(reason: "nftsSold24 is changing from Int to String - use nftsSold24V2 instead.")
  """The total number of NFTs sold by the pool over the past 24 hours."""
  nftsSold24V2: String
  """The total number of NFTs bought by the pool over the past 24 hours."""
  nftsBought24: Int @deprecated(reason: "nftsBought24 is changing from Int to String - use nftsBought24V2 instead.")
  """The total number of NFTs bought by the pool over the past 24 hours."""
  nftsBought24V2: String
  """The total number of NFTs bought and sold over the past 24 hours."""
  nftVolume24: Int @deprecated(reason: "nftVolume24 is changing from Int to String - use nftVolume24V2 instead.")
  """The total number of NFTs bought and sold over the past 24 hours."""
  nftVolume24V2: String
  """The total volume of the pool in the network's base token over the past 24 hours."""
  volumeNBT24: String
  """The total buy volume of the pool in the network's base token over the past 24 hours."""
  revenueNBT24: String
  """The total sell volume of the pool in the network's base token over the past 24 hours."""
  expenseNBT24: String
  """The sum of pool fees generated by the pool in the network's base token over the past 24 hours."""
  poolFeesNBT24: String
  """The sum of protocol fees generated by the pool in the network's base token over the past 24 hours."""
  protocolFeesNBT24: String
  """The total volume of the pool in the pool's liquidity token over the past 24 hours."""
  volumeT24: String
  """The total buy volume of the pool in the pool's liquidity token over the past 24 hours."""
  revenueT24: String
  """The total sell volume of the pool in the pool's liquidity token over the past 24 hours."""
  expenseT24: String
  """The sum of pool fees generated by the pool in the pool's liquidity token over the past 24 hours."""
  poolFeesT24: String
  """The sum of protocol fees generated by the pool in the pool's liquidity token over the past 24 hours."""
  protocolFeesT24: String
  """The total volume of the pool in USD over the past 24 hours."""
  volumeUSD24: String
  """The total buy volume of the pool in USD over the past 24 hours."""
  revenueUSD24: String
  """The total sell volume of the pool in USD over the past 24 hours."""
  expenseUSD24: String
  """The sum of pool fees generated by the pool in USD over the past 24 hours."""
  poolFeesUSD24: String
  """The sum of protocol fees generated by the pool in USD over the past 24 hours."""
  protocolFeesUSD24: String
  """The list of NFT assets in the pool."""
  nftAssets: [NftAsset]
}

NftPoolNftDepositEventData

Event data for depositing an NFT into a pool.

type
NftPoolEventType!
required

The type of NFT pool event, NFT_DEPOSIT.

nftTokenIds
[String!]!
required

The list of NFT token IDs deposited.

nftTokenBalance
String!
required

The number of NFTs in the contract after the block has processed.

tokenBalanceT
String!
required

The amount of token in the contract after the block has processed in the pool’s liquidity token.

"""Event data for depositing an NFT into a pool."""
type NftPoolNftDepositEventData {
  """The type of NFT pool event, `NFT_DEPOSIT`."""
  type: NftPoolEventType!
  """The list of NFT token IDs deposited."""
  nftTokenIds: [String!]!
  """The number of NFTs in the contract after the block has processed."""
  nftTokenBalance: String!
  """The amount of token in the contract after the block has processed in the pool's liquidity token."""
  tokenBalanceT: String!
}

NftPoolNftDepositEventDataV2

Event data for depositing an NFT into a pool.

type
NftPoolEventType!
required

The type of NFT pool event, NFT_DEPOSIT.

nftTokenIds
[String!]!
required

The list of NFT token IDs deposited.

nftTokenAmounts
[String!]!
required

The amount of each NFT token deposited.

nftAssets
[NftAsset]

New Param: The list of NFT assets withdrawn. More extensive info than nftTokenIds.

tokenBalanceT
String!
required

The amount of token in the contract after the block has processed in the pool’s liquidity token.

"""Event data for depositing an NFT into a pool."""
type NftPoolNftDepositEventDataV2 {
  """The type of NFT pool event, `NFT_DEPOSIT`."""
  type: NftPoolEventType!
  """The list of NFT token IDs deposited."""
  nftTokenIds: [String!]!
  """The amount of each NFT token deposited."""
  nftTokenAmounts: [String!]!
  """*New Param*: The list of NFT assets withdrawn. More extensive info than nftTokenIds."""
  nftAssets: [NftAsset]
  """The amount of token in the contract after the block has processed in the pool's liquidity token."""
  tokenBalanceT: String!
}

NftPoolNftWithdrawalEventData

Event data for withdrawing an NFT from a pool.

type
NftPoolEventType!
required

The type of NFT pool event, NFT_WITHDRAWAL.

nftTokenIds
[String!]!
required

The NFT token IDs withdrawn.

nftTokenBalance
String!
required

The number of NFTs in the contract after the block has processed.

tokenBalanceT
String!
required

The amount of token in the contract after the block has processed in the pool’s liquidity token.

"""Event data for withdrawing an NFT from a pool."""
type NftPoolNftWithdrawalEventData {
  """The type of NFT pool event, `NFT_WITHDRAWAL`."""
  type: NftPoolEventType!
  """The NFT token IDs withdrawn."""
  nftTokenIds: [String!]!
  """The number of NFTs in the contract after the block has processed."""
  nftTokenBalance: String!
  """The amount of token in the contract after the block has processed in the pool's liquidity token."""
  tokenBalanceT: String!
}

NftPoolNftWithdrawalEventDataV2

Event data for withdrawing an NFT from a pool.

type
NftPoolEventType!
required

The type of NFT pool event, NFT_WITHDRAWAL.

nftTokenIds
[String!]!
required

The list of NFT token IDs withdrawn.

nftTokenAmounts
[String!]!
required

The amount of each NFT token withdrawn.

tokenBalanceT
String!
required

The amount of token in the contract after the block has processed in the pool’s liquidity token.

nftAssets
[NftAsset]

New Param: The list of NFT assets withdrawn. More extensive info than nftTokenIds.

"""Event data for withdrawing an NFT from a pool."""
type NftPoolNftWithdrawalEventDataV2 {
  """The type of NFT pool event, `NFT_WITHDRAWAL`."""
  type: NftPoolEventType!
  """The list of NFT token IDs withdrawn."""
  nftTokenIds: [String!]!
  """The amount of each NFT token withdrawn."""
  nftTokenAmounts: [String!]!
  """The amount of token in the contract after the block has processed in the pool's liquidity token."""
  tokenBalanceT: String!
  """*New Param*: The list of NFT assets withdrawn. More extensive info than nftTokenIds."""
  nftAssets: [NftAsset]
}

NftPoolOwnershipTransferredEventDataV2

Event data for transferring ownership of a pool.

type
NftPoolEventType!
required

The type of NFT pool event, OWNERSHIP_TRANSFERRED.

newOwner
String!
required

The new owner of the pool.

"""Event data for transferring ownership of a pool."""
type NftPoolOwnershipTransferredEventDataV2 {
  """The type of NFT pool event, `OWNERSHIP_TRANSFERRED`."""
  type: NftPoolEventType!
  """The new owner of the pool."""
  newOwner: String!
}

NftPoolResponse

An NFT pool.

poolId
String!
required

The ID of the NFT pool (poolAddress:networkId). For example, 0xdbea289dcc10eed8431e78753414a3d81b8e7201:1.

tokenAddress
String!
required

The contract address of the liquidity token of the pool (usually WETH).

collectionAddress
String!
required

The contract address of the NFT collection.

collectionName
String!
required

The contract name of the NFT collection.

collectionSymbol
String

The symbol of the NFT collection.

exchangeAddress
String!
required

The contract address of the NFT AMM marketplace.

poolAddress
String!
required

The contract address of the NFT pool.

networkId
Int!
required

The network ID the NFT collection is deployed on.

poolType
NftPoolType!
required

The type of liquidity pool.

poolVariant
GraphQlNftPoolVariant!
required

The pool variant. Can be ERC20 or NATIVE.

bondingCurveType
BondingCurveType!
required

The bonding curve type that defines how the prices of NFTs change after each buy or sell within a pool.

bondingCurveAddress
String!
required

The contract address of the bonding curve.

assetRecipientAddress
String!
required

The wallet address that will receive the tokens or NFT sent to the pair during swaps.

delta
String!
required

The current delta used in the bonding curve.

owner
String!
required

The wallet address of the pool owner.

fee
String!
required

The current fee for pool.

poolFeesAllTimeT
String

No description provided

poolFeesAllTimeNBT
String

No description provided

floorNBT
String

The current price at which the pool is willing to sell an NFT in the network’s base token. Only applicable for SELL and BUY_AND_SELL pool types.

offerNBT
String

The current price at which the pool is willing to buy an NFT in the network’s base token. Only applicable for BUY and BUY_AND_SELL pool types.

spotPriceNBT
String!
required

The spot price in the network’s base token.

balanceNBT
String!
required

The current pool liquidity in the network’s base token.

nftBalance
Int

The current number of NFTs in the pool.

This field is deprecated. nftBalance is changing from Int to String - use nftBalanceV2 instead.

nftBalanceV2
String!
required

The current number of NFTs in the pool.

volumeAllTimeNBT
String!
required

The total volume of the pool in the network’s base token over the pool’s lifetime.

floorT
String

The current price at which the pool is willing to sell an NFT in the pool’s liquidity token. Only applicable for SELL and BUY_AND_SELL pool types.

offerT
String

The current price at which the pool is willing to buy an NFT in the pool’s liquidity token. Only applicable for BUY and BUY_AND_SELL pool types.

spotPriceT
String!
required

The instantaneous price for selling 1 NFT to the pool in the pool’s liquidity token.

balanceT
String!
required

The current pool liquidity in the pool’s liquidity token.

volumeAllTimeT
String!
required

The total volume of the pool in the pool’s liquidity token over the pool’s lifetime.

nftVolumeAllTime
Int!
required

The total number of NFTs bought and sold over the pool’s lifetime.

This field is deprecated. nftVolumeAllTime is changing from Int to String - use nftVolumeAllTimeV2 instead.

nftVolumeAllTimeV2
String!
required

The total number of NFTs bought and sold over the pool’s lifetime.

nftAssets
[NftAsset]

The list of NFT assets in the pool.

poolNftType
PoolNftType

The type of NFT in the pool.

royalties
[NftPoolRoyalty]

The list of royalties for the pool. Only applicable for SUDOSWAP_V2 pools.

propertyChecker
String

The property checker contract address for the pool.

version
NftPoolContractVersion

The NFT pool contract version. Can be SUDOSWAP_V1 or SUDOSWAP_V2.

acceptedNftTokenIds
[String]

For ERC1155 pools, the list of NFT token IDs that are accepted by the pool.

"""An NFT pool."""
type NftPoolResponse {
  """The ID of the NFT pool (`poolAddress`:`networkId`). For example, `0xdbea289dcc10eed8431e78753414a3d81b8e7201:1`."""
  poolId: String!
  """The contract address of the liquidity token of the pool (usually WETH)."""
  tokenAddress: String!
  """The contract address of the NFT collection."""
  collectionAddress: String!
  """The contract name of the NFT collection."""
  collectionName: String!
  """The symbol of the NFT collection."""
  collectionSymbol: String
  """The contract address of the NFT AMM marketplace."""
  exchangeAddress: String!
  """The contract address of the NFT pool."""
  poolAddress: String!
  """The network ID the NFT collection is deployed on."""
  networkId: Int!
  """The type of liquidity pool."""
  poolType: NftPoolType!
  """The pool variant. Can be `ERC20` or `NATIVE`."""
  poolVariant: GraphQlNftPoolVariant!
  """The bonding curve type that defines how the prices of NFTs change after each buy or sell within a pool."""
  bondingCurveType: BondingCurveType!
  """The contract address of the bonding curve."""
  bondingCurveAddress: String!
  """The wallet address that will receive the tokens or NFT sent to the pair during swaps."""
  assetRecipientAddress: String!
  """The current delta used in the bonding curve."""
  delta: String!
  """The wallet address of the pool owner."""
  owner: String!
  """The current fee for pool."""
  fee: String!
  poolFeesAllTimeT: String
  poolFeesAllTimeNBT: String
  """The current price at which the pool is willing to sell an NFT in the network's base token. Only applicable for `SELL` and `BUY_AND_SELL` pool types."""
  floorNBT: String
  """The current price at which the pool is willing to buy an NFT in the network's base token. Only applicable for `BUY` and `BUY_AND_SELL` pool types."""
  offerNBT: String
  """The spot price in the network's base token."""
  spotPriceNBT: String!
  """The current pool liquidity in the network's base token."""
  balanceNBT: String!
  """The current number of NFTs in the pool."""
  nftBalance: Int @deprecated(reason: "nftBalance is changing from Int to String - use nftBalanceV2 instead.")
  """The current number of NFTs in the pool."""
  nftBalanceV2: String!
  """The total volume of the pool in the network's base token over the pool's lifetime."""
  volumeAllTimeNBT: String!
  """The current price at which the pool is willing to sell an NFT in the pool's liquidity token. Only applicable for `SELL` and `BUY_AND_SELL` pool types."""
  floorT: String
  """The current price at which the pool is willing to buy an NFT in the pool's liquidity token. Only applicable for `BUY` and `BUY_AND_SELL` pool types."""
  offerT: String
  """The instantaneous price for selling 1 NFT to the pool in the pool's liquidity token."""
  spotPriceT: String!
  """The current pool liquidity in the pool's liquidity token."""
  balanceT: String!
  """The total volume of the pool in the pool's liquidity token over the pool's lifetime."""
  volumeAllTimeT: String!
  """The total number of NFTs bought and sold over the pool's lifetime."""
  nftVolumeAllTime: Int! @deprecated(reason: "nftVolumeAllTime is changing from Int to String - use nftVolumeAllTimeV2 instead.")
  """The total number of NFTs bought and sold over the pool's lifetime."""
  nftVolumeAllTimeV2: String!
  """The list of NFT assets in the pool."""
  nftAssets: [NftAsset]
  """The type of NFT in the pool."""
  poolNftType: PoolNftType
  """The list of royalties for the pool. Only applicable for `SUDOSWAP_V2` pools."""
  royalties: [NftPoolRoyalty]
  """The property checker contract address for the pool."""
  propertyChecker: String
  """The NFT pool contract version. Can be `SUDOSWAP_V1` or `SUDOSWAP_V2`."""
  version: NftPoolContractVersion
  """For ERC1155 pools, the list of NFT token IDs that are accepted by the pool."""
  acceptedNftTokenIds: [String]
}

NftPoolRoyalty

The royalty for a SUDOSWAP_V2 pool.

recipient
String

The wallet address of recipient.

percent
String

The royalty percent.

"""The royalty for a SUDOSWAP_V2 pool."""
type NftPoolRoyalty {
  """The wallet address of recipient."""
  recipient: String
  """The royalty percent."""
  percent: String
}

NftPoolSpotPriceUpdateEventData

Event data for updating the spot price of a pool.

type
NftPoolEventType!
required

The type of NFT pool event, SPOT_PRICE_UPDATE.

newSpotPriceT
String!
required

The updated spot price in the pool’s liquidity token.

newSellPriceT
String!
required

The updated price at which the pool is willing to sell an NFT in the pool’s liquidity token.

newBuyPriceT
String!
required

The updated price at which the pool is willing to buy an NFT in the pool’s liquidity token.

nbtRatio
String!
required

The ratio of the transaction token to the network’s base token.

usdRatio
String!
required

The ratio of the transaction token to USD.

"""Event data for updating the spot price of a pool."""
type NftPoolSpotPriceUpdateEventData {
  """The type of NFT pool event, `SPOT_PRICE_UPDATE`."""
  type: NftPoolEventType!
  """The updated spot price in the pool's liquidity token."""
  newSpotPriceT: String!
  """The updated price at which the pool is willing to sell an NFT in the pool's liquidity token."""
  newSellPriceT: String!
  """The updated price at which the pool is willing to buy an NFT in the pool's liquidity token."""
  newBuyPriceT: String!
  """The ratio of the transaction token to the network's base token."""
  nbtRatio: String!
  """The ratio of the transaction token to USD."""
  usdRatio: String!
}

NftPoolSpotPriceUpdateEventDataV2

Event data for updating the spot price of a pool.

type
NftPoolEventType!
required

The type of NFT pool event, SPOT_PRICE_UPDATE.

newSpotPriceT
String!
required

The updated spot price in the pool’s liquidity token.

newSellPriceT
String!
required

The updated price at which the pool is willing to sell an NFT in the pool’s liquidity token.

newBuyPriceT
String!
required

The updated price at which the pool is willing to buy an NFT in the pool’s liquidity token.

nbtRatio
String!
required

The ratio of the transaction token to the network’s base token.

usdRatio
String!
required

The ratio of the transaction token to USD.

"""Event data for updating the spot price of a pool."""
type NftPoolSpotPriceUpdateEventDataV2 {
  """The type of NFT pool event, `SPOT_PRICE_UPDATE`."""
  type: NftPoolEventType!
  """The updated spot price in the pool's liquidity token."""
  newSpotPriceT: String!
  """The updated price at which the pool is willing to sell an NFT in the pool's liquidity token."""
  newSellPriceT: String!
  """The updated price at which the pool is willing to buy an NFT in the pool's liquidity token."""
  newBuyPriceT: String!
  """The ratio of the transaction token to the network's base token."""
  nbtRatio: String!
  """The ratio of the transaction token to USD."""
  usdRatio: String!
}

NftPoolStatsResponse

Stats for an NFT pool.

exchangeAddress
String!
required

The contract address of the NFT AMM marketplace.

networkId
Int!
required

The network ID the NFT collection is deployed on.

collectionAddress
String!
required

The contract address of the NFT collection.

startTime
Int!
required

The unix timestamp for the start of the time frame.

endTime
Int!
required

The unix timestamp for the end of the time frame.

poolAddress
String

The contract address of the NFT pool.

nftVolumeV2
String

The total number of NFTs bought and sold over the time frame.

nftsBoughtV2
String

The total number of NFTs bought over the time frame.

nftsSoldV2
String

The total number of NFTs sold over the time frame.

openNftBalanceV2
String

The number of NFTs in the pool at the start of the time frame.

closeNftBalanceV2
String

The number of NFTs in the pool at the end of the time frame.

volumeNBT
String

The total volume of the pool in the network’s base token over the time frame.

revenueNBT
String

The total buy volume of the pool in the network’s base token over the time frame.

expenseNBT
String

The total sell volume of the pool in the network’s base token over the time frame.

poolFeesNBT
String

The sum of pool fees generated by the pool in the network’s base token over the time frame.

protocolFeesNBT
String

The sum of protocol fees generated by the pool in the network’s base token over the time frame.

lowFloorNBT
String

The lowest price at which the pool was willing to sell an NFT in the network’s base token over the time frame.

highFloorNBT
String

The highest price at which the pool was willing to sell an NFT in the network’s base token over the time frame.

lowOfferNBT
String

The lowest price at which the pool was willing to buy an NFT in the network’s base token over the time frame.

highOfferNBT
String

The highest price at which the pool was willing to buy an NFT in the network’s base token over the time frame.

openBalanceNBT
String

The pool liquidity in the network’s base token at the start of the time frame.

closeBalanceNBT
String

The pool liquidity in the network’s base token at the end of the time frame.

"""Stats for an NFT pool."""
type NftPoolStatsResponse {
  """The contract address of the NFT AMM marketplace."""
  exchangeAddress: String!
  """The network ID the NFT collection is deployed on."""
  networkId: Int!
  """The contract address of the NFT collection."""
  collectionAddress: String!
  """The unix timestamp for the start of the time frame."""
  startTime: Int!
  """The unix timestamp for the end of the time frame."""
  endTime: Int!
  """The contract address of the NFT pool."""
  poolAddress: String
  """The total number of NFTs bought and sold over the time frame."""
  nftVolumeV2: String
  """The total number of NFTs bought over the time frame."""
  nftsBoughtV2: String
  """The total number of NFTs sold over the time frame."""
  nftsSoldV2: String
  """The number of NFTs in the pool at the start of the time frame."""
  openNftBalanceV2: String
  """The number of NFTs in the pool at the end of the time frame."""
  closeNftBalanceV2: String
  """The total volume of the pool in the network's base token over the time frame."""
  volumeNBT: String
  """The total buy volume of the pool in the network's base token over the time frame."""
  revenueNBT: String
  """The total sell volume of the pool in the network's base token over the time frame."""
  expenseNBT: String
  """The sum of pool fees generated by the pool in the network's base token over the time frame."""
  poolFeesNBT: String
  """The sum of protocol fees generated by the pool in the network's base token over the time frame."""
  protocolFeesNBT: String
  """The lowest price at which the pool was willing to sell an NFT in the network's base token over the time frame."""
  lowFloorNBT: String
  """The highest price at which the pool was willing to sell an NFT in the network's base token over the time frame."""
  highFloorNBT: String
  """The lowest price at which the pool was willing to buy an NFT in the network's base token over the time frame."""
  lowOfferNBT: String
  """The highest price at which the pool was willing to buy an NFT in the network's base token over the time frame."""
  highOfferNBT: String
  """The pool liquidity in the network's base token at the start of the time frame."""
  openBalanceNBT: String
  """The pool liquidity in the network's base token at the end of the time frame."""
  closeBalanceNBT: String
}

NftPoolTokenDepositEventData

Event data for depositing a token into a pool.

type
NftPoolEventType!
required

The type of NFT pool event, TOKEN_DEPOSIT.

amountT
String!
required

The total value of token deposited in the pool’s liquidity token.

nftTokenBalance
String!
required

The number of NFTs in the contract after the block has processed.

tokenBalanceT
String!
required

The amount of token in the contract after the block has processed in the pool’s liquidity token.

nbtRatio
String!
required

The ratio of the transaction token to the network’s base token.

usdRatio
String!
required

The ratio of the transaction token to USD.

"""Event data for depositing a token into a pool."""
type NftPoolTokenDepositEventData {
  """The type of NFT pool event, `TOKEN_DEPOSIT`."""
  type: NftPoolEventType!
  """The total value of token deposited in the pool's liquidity token."""
  amountT: String!
  """The number of NFTs in the contract after the block has processed."""
  nftTokenBalance: String!
  """The amount of token in the contract after the block has processed in the pool's liquidity token."""
  tokenBalanceT: String!
  """The ratio of the transaction token to the network's base token."""
  nbtRatio: String!
  """The ratio of the transaction token to USD."""
  usdRatio: String!
}

NftPoolTokenDepositEventDataV2

Event data for depositing a token into a pool.

type
NftPoolEventType!
required

The type of NFT pool event, TOKEN_DEPOSIT.

amountT
String!
required

The total value of token deposited in the pool’s liquidity token.

tokenBalanceT
String!
required

The amount of token in the contract after the block has processed in the pool’s liquidity token.

nbtRatio
String!
required

The ratio of the transaction token to the network’s base token.

usdRatio
String!
required

The ratio of the transaction token to USD.

"""Event data for depositing a token into a pool."""
type NftPoolTokenDepositEventDataV2 {
  """The type of NFT pool event, `TOKEN_DEPOSIT`."""
  type: NftPoolEventType!
  """The total value of token deposited in the pool's liquidity token."""
  amountT: String!
  """The amount of token in the contract after the block has processed in the pool's liquidity token."""
  tokenBalanceT: String!
  """The ratio of the transaction token to the network's base token."""
  nbtRatio: String!
  """The ratio of the transaction token to USD."""
  usdRatio: String!
}

NftPoolTokenWithdrawalEventData

Event data for withdrawing a token from a pool.

type
NftPoolEventType!
required

The type of NFT pool event, TOKEN_WITHDRAWAL.

amountT
String!
required

The total value of token withdrawn in the pool’s liquidity token.

nftTokenBalance
String!
required

The number of NFTs in the contract after the block has processed.

tokenBalanceT
String!
required

The amount of token in the contract after the block has processed in the pool’s liquidity token.

nbtRatio
String!
required

The ratio of the transaction token to the network’s base token.

usdRatio
String!
required

The ratio of the transaction token to USD.

"""Event data for withdrawing a token from a pool."""
type NftPoolTokenWithdrawalEventData {
  """The type of NFT pool event, `TOKEN_WITHDRAWAL`."""
  type: NftPoolEventType!
  """The total value of token withdrawn in the pool's liquidity token."""
  amountT: String!
  """The number of NFTs in the contract after the block has processed."""
  nftTokenBalance: String!
  """The amount of token in the contract after the block has processed in the pool's liquidity token."""
  tokenBalanceT: String!
  """The ratio of the transaction token to the network's base token."""
  nbtRatio: String!
  """The ratio of the transaction token to USD."""
  usdRatio: String!
}

NftPoolTokenWithdrawalEventDataV2

Event data for withdrawing a token from a pool.

type
NftPoolEventType!
required

The type of NFT pool event, TOKEN_WITHDRAWAL.

amountT
String!
required

The total value of token withdrawn in the pool’s liquidity token.

tokenBalanceT
String!
required

The amount of token in the contract after the block has processed in the pool’s liquidity token.

nbtRatio
String!
required

The ratio of the transaction token to the network’s base token.

usdRatio
String!
required

The ratio of the transaction token to USD.

"""Event data for withdrawing a token from a pool."""
type NftPoolTokenWithdrawalEventDataV2 {
  """The type of NFT pool event, `TOKEN_WITHDRAWAL`."""
  type: NftPoolEventType!
  """The total value of token withdrawn in the pool's liquidity token."""
  amountT: String!
  """The amount of token in the contract after the block has processed in the pool's liquidity token."""
  tokenBalanceT: String!
  """The ratio of the transaction token to the network's base token."""
  nbtRatio: String!
  """The ratio of the transaction token to USD."""
  usdRatio: String!
}

NftSearchResponse

Response returned by searchNfts.

items
[NftSearchResponseCollection]

A list of NFT collections matching a given query string.

hasMore
Int!
required

The number of additional results found.

"""Response returned by `searchNfts`."""
type NftSearchResponse {
  """A list of NFT collections matching a given query string."""
  items: [NftSearchResponseCollection]
  """The number of additional results found."""
  hasMore: Int!
}

NftSearchResponseCollection

An NFT collection matching a given query string.

id
String!
required

The ID of the NFT collection (address:networkId).

address
String!
required

The contract address of the NFT collection.

networkId
Int!
required

The network ID the NFT collection is deployed on.

name
String

The name of the NFT collection. For example, Bored Ape Yacht Club.

symbol
String

The symbol of the NFT collection. For example, BAYC.

imageUrl
String

The image URL for the collection or one of the assets within the collection.

volume
String!
required

The trade volume in USD over the window.

volumeChange
Float!
required

The change in volume between the previous and current window.

tradeCount
String!
required

The trade count over the window.

tradeCountChange
Float!
required

The change in trade count between the previous and current window.

floor
String!
required

The lowest sale price over the window.

average
String!
required

The average sale price over the window.

ceiling
String!
required

The highest sale price over the window.

window
String!
required

The time frame used for calculating stats.

"""An NFT collection matching a given query string."""
type NftSearchResponseCollection {
  """The ID of the NFT collection (`address`:`networkId`)."""
  id: String!
  """The contract address of the NFT collection."""
  address: String!
  """The network ID the NFT collection is deployed on."""
  networkId: Int!
  """The name of the NFT collection. For example, `Bored Ape Yacht Club`."""
  name: String
  """The symbol of the NFT collection. For example, `BAYC`."""
  symbol: String
  """The image URL for the collection or one of the assets within the collection."""
  imageUrl: String
  """The trade volume in USD over the `window`."""
  volume: String!
  """The change in volume between the previous and current `window`."""
  volumeChange: Float!
  """The trade count over the `window`."""
  tradeCount: String!
  """The change in trade count between the previous and current `window`."""
  tradeCountChange: Float!
  """The lowest sale price over the `window`."""
  floor: String!
  """The average sale price over the `window`."""
  average: String!
  """The highest sale price over the `window`."""
  ceiling: String!
  """The time frame used for calculating stats."""
  window: String!
}

NftStatsNumberMetrics

Number metrics for NFT stats.

current
Float

The total value for the current window.

previous
Float

The total value for the previous window.

change
Float

The percent change between the current and previous.

"""Number metrics for NFT stats."""
type NftStatsNumberMetrics {
  """The total value for the current window."""
  current: Float
  """The total value for the previous window."""
  previous: Float
  """The percent change between the `current` and `previous`."""
  change: Float
}

NftStatsStringMetrics

String metrics for NFT stats.

current
String

The total value for the current window.

previous
String

The total value for the previous window.

change
Float

The percent change between the current and previous.

"""String metrics for NFT stats."""
type NftStatsStringMetrics {
  """The total value for the current window."""
  current: String
  """The total value for the previous window."""
  previous: String
  """The percent change between the `current` and `previous`."""
  change: Float
}

NftStatsWindowWithChange

NFT stats over a time frame.

startTime
Int

The unix timestamp for the start of the window.

endTime
Int

The unix timestamp for the end of the window.

usd
NftCollectionCurrencyStats

The currency stats in USD, such as volume.

networkBaseToken
NftCollectionCurrencyStats

The currency stats in the network’s base token, such as volume.

nonCurrency
NftCollectionNonCurrencyStats

The numerical stats, such as number of sales.

"""NFT stats over a time frame."""
type NftStatsWindowWithChange {
  """The unix timestamp for the start of the window."""
  startTime: Int
  """The unix timestamp for the end of the window."""
  endTime: Int
  """The currency stats in USD, such as volume."""
  usd: NftCollectionCurrencyStats
  """The currency stats in the network's base token, such as volume."""
  networkBaseToken: NftCollectionCurrencyStats
  """The numerical stats, such as number of sales."""
  nonCurrency: NftCollectionNonCurrencyStats
}

OnBarsUpdatedResponse

Response returned by onBarsUpdated.

pairAddress
String!
required

The contract address for the pair.

networkId
Int!
required

The network ID the pair is deployed on.

pairId
String!
required

The ID for the pair (pairAddress:networkId).

timestamp
Int!
required

The unix timestamp for the new bar.

statsType
TokenPairStatisticsType!
required

The type of statistics used. Can be Filtered or Unfiltered.

eventSortKey
String!
required

The sortKey for the bar (blockNumber#transactionIndex#logIndex, zero padded). For example, 0000000016414564#00000224#00000413.

aggregates
ResolutionBarData!
required

Price data broken down by resolution.

quoteToken
QuoteToken

The quote token within the pair.

quoteTokenAddress
String!
required

The address of the token being quoted

"""Response returned by `onBarsUpdated`."""
type OnBarsUpdatedResponse {
  """The contract address for the pair."""
  pairAddress: String!
  """The network ID the pair is deployed on."""
  networkId: Int!
  """The ID for the pair (`pairAddress`:`networkId`)."""
  pairId: String!
  """The unix timestamp for the new bar."""
  timestamp: Int!
  """The type of statistics used. Can be `Filtered` or `Unfiltered`."""
  statsType: TokenPairStatisticsType!
  """The sortKey for the bar (`blockNumber`#`transactionIndex`#`logIndex`, zero padded). For example, `0000000016414564#00000224#00000413`."""
  eventSortKey: String!
  """Price data broken down by resolution."""
  aggregates: ResolutionBarData!
  """The quote token within the pair."""
  quoteToken: QuoteToken
  """The address of the token being quoted"""
  quoteTokenAddress: String!
}

OneOfNumberCondition

Integer list condition.

oneOf
[Int!]!
required

The list of integers.

"""Integer list condition."""
type OneOfNumberCondition {
  """The list of integers."""
  oneOf: [Int!]!
}

OnTokenBarsUpdatedResponse

Response returned by onBarsUpdated.

pairAddress
String!
required

The contract address for the pair.

networkId
Int!
required

The network ID the pair is deployed on.

pairId
String!
required

The ID for the pair (pairAddress:networkId).

timestamp
Int!
required

The unix timestamp for the new bar.

statsType
TokenPairStatisticsType!
required

The type of statistics used. Can be Filtered or Unfiltered.

eventSortKey
String!
required

The sortKey for the bar (blockNumber#transactionIndex#logIndex, zero padded). For example, 0000000016414564#00000224#00000413.

aggregates
ResolutionBarData!
required

Price data broken down by resolution.

quoteToken
QuoteToken

The quote token within the pair.

tokenAddress
String!
required

The address of the token being quoted

tokenId
String!
required

The address of the token being quoted

"""Response returned by `onBarsUpdated`."""
type OnTokenBarsUpdatedResponse {
  """The contract address for the pair."""
  pairAddress: String!
  """The network ID the pair is deployed on."""
  networkId: Int!
  """The ID for the pair (`pairAddress`:`networkId`)."""
  pairId: String!
  """The unix timestamp for the new bar."""
  timestamp: Int!
  """The type of statistics used. Can be `Filtered` or `Unfiltered`."""
  statsType: TokenPairStatisticsType!
  """The sortKey for the bar (`blockNumber`#`transactionIndex`#`logIndex`, zero padded). For example, `0000000016414564#00000224#00000413`."""
  eventSortKey: String!
  """Price data broken down by resolution."""
  aggregates: ResolutionBarData!
  """The quote token within the pair."""
  quoteToken: QuoteToken
  """The address of the token being quoted"""
  tokenAddress: String!
  """The address of the token being quoted"""
  tokenId: String!
}

OnUnconfirmedBarsUpdated

Response returned by onUnconfirmedBarsUpdated.

pairAddress
String!
required

The contract address for the pair.

networkId
Int!
required

The network ID the pair is deployed on.

pairId
String!
required

The ID for the pair (pairAddress:networkId).

timestamp
Int!
required

The unix timestamp for the new bar.

eventSortKey
String!
required

The sortKey for the bar (blockNumber#transactionIndex#logIndex, zero padded). For example, 0000000016414564#00000224#00000413.

aggregates
UnconfirmedResolutionBarData!
required

Price data broken down by resolution.

quoteToken
QuoteToken

The quote token within the pair.

quoteTokenAddress
String!
required

The address of the token being quoted

"""Response returned by `onUnconfirmedBarsUpdated`."""
type OnUnconfirmedBarsUpdated {
  """The contract address for the pair."""
  pairAddress: String!
  """The network ID the pair is deployed on."""
  networkId: Int!
  """The ID for the pair (`pairAddress`:`networkId`)."""
  pairId: String!
  """The unix timestamp for the new bar."""
  timestamp: Int!
  """The sortKey for the bar (`blockNumber`#`transactionIndex`#`logIndex`, zero padded). For example, `0000000016414564#00000224#00000413`."""
  eventSortKey: String!
  """Price data broken down by resolution."""
  aggregates: UnconfirmedResolutionBarData!
  """The quote token within the pair."""
  quoteToken: QuoteToken
  """The address of the token being quoted"""
  quoteTokenAddress: String!
}

Pair

Metadata for a token pair.

address
String!
required

The contract address of the pair.

exchangeHash
String!
required

The address for the exchange factory contract.

fee
Int

The exchange fee for swaps.

id
String!
required

The ID for the pair (address:networkId).

networkId
Int!
required

The network ID the pair is deployed on.

tickSpacing
Int

The amount of required tick separation. Only applicable for pairs on UniswapV3.

token0
String!
required

The contract address of token0.

token1
String!
required

The contract address of token1.

createdAt
Int

The unix timestamp for the creation of the pair.

token0Data
EnhancedToken

Metadata for the first token in the pair.

token1Data
EnhancedToken

Metadata for the second token in the pair.

pooled
PooledTokenValues

The pooled amounts of each token in the pair.

"""Metadata for a token pair."""
type Pair {
  """The contract address of the pair."""
  address: String!
  """The address for the exchange factory contract."""
  exchangeHash: String!
  """The exchange fee for swaps."""
  fee: Int
  """The ID for the pair (`address:networkId`)."""
  id: String!
  """The network ID the pair is deployed on."""
  networkId: Int!
  """The amount of required tick separation. Only applicable for pairs on UniswapV3."""
  tickSpacing: Int
  """The contract address of `token0`."""
  token0: String!
  """The contract address of `token1`."""
  token1: String!
  """The unix timestamp for the creation of the pair."""
  createdAt: Int
  """Metadata for the first token in the pair."""
  token0Data: EnhancedToken
  """Metadata for the second token in the pair."""
  token1Data: EnhancedToken
  """The pooled amounts of each token in the pair."""
  pooled: PooledTokenValues
}

PairFilterConnection

Response returned by filterPairs.

results
[PairFilterResult]

The list of pairs matching the filter parameters.

count
Int

The number of pairs returned.

offset
Int

Where in the list the server started when returning items.

"""Response returned by `filterPairs`."""
type PairFilterConnection {
  """The list of pairs matching the filter parameters."""
  results: [PairFilterResult]
  """The number of pairs returned."""
  count: Int
  """Where in the list the server started when returning items."""
  offset: Int
}

PairFilterResult

A pair matching a set of filter parameters.

createdAt
Int

The unix timestamp for the creation of the pair.

lastTransaction
Int

The unix timestamp for the last transaction to happen on the pair.

buyCount1
Int

The number of buys in the past hour.

buyCount4
Int

The number of buys in the past 4 hours.

buyCount12
Int

The number of buys in the past 12 hours.

buyCount24
Int

The number of buys in the past 24 hours.

exchange
FilterExchange

Exchange metadata for the pair.

highPrice1
String

The highest price in USD in the past hour.

highPrice4
String

The highest price in USD in the past 4 hours.

highPrice12
String

The highest price in USD in the past 12 hours.

highPrice24
String

The highest price in USD in the past 24 hours.

liquidity
String

Amount of liquidity in the pair.

lockedLiquidityPercentage
Float!
required

The locked liquidity percentage.

liquidityToken
String

The token with higher liquidity in the pair. Can be token0 or token1.

quoteToken
String

The token of interest. Can be token0 or token1.

lowPrice1
String

The lowest price in USD in the past hour.

lowPrice4
String

The lowest price in USD in the past 4 hours.

lowPrice12
String

The lowest price in USD in the past 12 hours.

lowPrice24
String

The lowest price in USD in the past 24 hours.

marketCap
String

The fully diluted market cap.

pair
Pair

Metadata for the pair.

price
String

The token price in USD.

priceScale
String

10^n, where n is the number of decimal places the price has. Max 16. Used for TradingView settings.

priceChange1
String

The percent price change in the past hour. Decimal format.

priceChange4
String

The percent price change in the past 4 hours. Decimal format.

priceChange12
String

The percent price change in the past 12 hours. Decimal format.

priceChange24
String

The percent price change in the past 24 hours. Decimal format.

volumeChange1
String

The percent volume change in the past hour. Decimal format.

volumeChange4
String

The percent volume change in the past 4 hours. Decimal format.

volumeChange12
String

The percent volume change in the past 12 hours. Decimal format.

volumeChange24
String

The percent volume change in the past 24 hours. Decimal format.

sellCount1
Int

The number of sells in the past hour.

sellCount4
Int

The number of sells in the past 4 hours.

sellCount12
Int

The number of sells in the past 12 hours.

sellCount24
Int

The number of sells in the past 24 hours.

token0
EnhancedToken

Metadata for the first token in the pair.

token1
EnhancedToken

Metadata for the second token in the pair.

txnCount1
Int

The number of transactions in the past hour.

txnCount4
Int

The number of transactions in the past 4 hours.

txnCount12
Int

The number of transactions in the past 12 hours.

txnCount24
Int

The number of transactions in the past 24 hours.

uniqueBuys1
Int

The unique number of buys in the past hour.

uniqueBuys4
Int

The unique number of buys in the past 4 hours.

uniqueBuys12
Int

The unique number of buys in the past 12 hours.

uniqueBuys24
Int

The unique number of buys in the past 24 hours.

uniqueSells1
Int

The unique number of sells in the past hour.

uniqueSells4
Int

The unique number of sells in the past 4 hours.

uniqueSells12
Int

The unique number of sells in the past 12 hours.

uniqueSells24
Int

The unique number of sells in the past 24 hours.

uniqueTransactions1
Int

The unique number of transactions in the past hour.

uniqueTransactions4
Int

The unique number of transactions in the past 4 hours.

uniqueTransactions12
Int

The unique number of transactions in the past 12 hours.

uniqueTransactions24
Int

The unique number of transactions in the past 24 hours.

volumeUSD1
String

The trade volume in USD in the past hour.

volumeUSD4
String

The trade volume in USD in the past 4 hours.

volumeUSD12
String

The trade volume in USD in the past 12 hours.

volumeUSD24
String

The trade volume in USD in the past 24 hours.

buyVolumeUSD1
String

The buy volume in USD in the past hour.

buyVolumeUSD12
String

The buy volume in USD in the past 12 hours.

buyVolumeUSD24
String

The buy volume in USD in the past 24 hours.

buyVolumeUSD4
String

The buy volume in USD in the past 4 hours.

sellVolumeUSD1
String

The sell volume in USD in the past hour.

sellVolumeUSD12
String

The sell volume in USD in the past 12 hours.

sellVolumeUSD24
String

The sell volume in USD in the past 24 hours.

sellVolumeUSD4
String

The sell volume in USD in the past 4 hours.

walletAgeAvg
String

The average age of the wallets that traded in the last 24h

walletAgeStd
String

The standard deviation of age of the wallets that traded in the last 24h

swapPct1dOldWallet
String

The percentage of wallets that are less than 1d old that have traded in the last 24h

swapPct7dOldWallet
String

The percentage of wallets that are less than 7d old that have traded in the last 24h

"""A pair matching a set of filter parameters."""
type PairFilterResult {
  """The unix timestamp for the creation of the pair."""
  createdAt: Int
  """The unix timestamp for the last transaction to happen on the pair."""
  lastTransaction: Int
  """The number of buys in the past hour."""
  buyCount1: Int
  """The number of buys in the past 4 hours."""
  buyCount4: Int
  """The number of buys in the past 12 hours."""
  buyCount12: Int
  """The number of buys in the past 24 hours."""
  buyCount24: Int
  """Exchange metadata for the pair."""
  exchange: FilterExchange
  """The highest price in USD in the past hour."""
  highPrice1: String
  """The highest price in USD in the past 4 hours."""
  highPrice4: String
  """The highest price in USD in the past 12 hours."""
  highPrice12: String
  """The highest price in USD in the past 24 hours."""
  highPrice24: String
  """Amount of liquidity in the pair."""
  liquidity: String
  """The locked liquidity percentage."""
  lockedLiquidityPercentage: Float!
  """The token with higher liquidity in the pair. Can be `token0` or `token1`."""
  liquidityToken: String
  """The token of interest. Can be `token0` or `token1`."""
  quoteToken: String
  """The lowest price in USD in the past hour."""
  lowPrice1: String
  """The lowest price in USD in the past 4 hours."""
  lowPrice4: String
  """The lowest price in USD in the past 12 hours."""
  lowPrice12: String
  """The lowest price in USD in the past 24 hours."""
  lowPrice24: String
  """The fully diluted market cap."""
  marketCap: String
  """Metadata for the pair."""
  pair: Pair
  """The token price in USD."""
  price: String
  """10^n, where n is the number of decimal places the price has. Max 16. Used for TradingView settings."""
  priceScale: String
  """The percent price change in the past hour. Decimal format."""
  priceChange1: String
  """The percent price change in the past 4 hours. Decimal format."""
  priceChange4: String
  """The percent price change in the past 12 hours. Decimal format."""
  priceChange12: String
  """The percent price change in the past 24 hours. Decimal format."""
  priceChange24: String
  """The percent volume change in the past hour. Decimal format."""
  volumeChange1: String
  """The percent volume change in the past 4 hours. Decimal format."""
  volumeChange4: String
  """The percent volume change in the past 12 hours. Decimal format."""
  volumeChange12: String
  """The percent volume change in the past 24 hours. Decimal format."""
  volumeChange24: String
  """The number of sells in the past hour."""
  sellCount1: Int
  """The number of sells in the past 4 hours."""
  sellCount4: Int
  """The number of sells in the past 12 hours."""
  sellCount12: Int
  """The number of sells in the past 24 hours."""
  sellCount24: Int
  """Metadata for the first token in the pair."""
  token0: EnhancedToken
  """Metadata for the second token in the pair."""
  token1: EnhancedToken
  """The number of transactions in the past hour."""
  txnCount1: Int
  """The number of transactions in the past 4 hours."""
  txnCount4: Int
  """The number of transactions in the past 12 hours."""
  txnCount12: Int
  """The number of transactions in the past 24 hours."""
  txnCount24: Int
  """The unique number of buys in the past hour."""
  uniqueBuys1: Int
  """The unique number of buys in the past 4 hours."""
  uniqueBuys4: Int
  """The unique number of buys in the past 12 hours."""
  uniqueBuys12: Int
  """The unique number of buys in the past 24 hours."""
  uniqueBuys24: Int
  """The unique number of sells in the past hour."""
  uniqueSells1: Int
  """The unique number of sells in the past 4 hours."""
  uniqueSells4: Int
  """The unique number of sells in the past 12 hours."""
  uniqueSells12: Int
  """The unique number of sells in the past 24 hours."""
  uniqueSells24: Int
  """The unique number of transactions in the past hour."""
  uniqueTransactions1: Int
  """The unique number of transactions in the past 4 hours."""
  uniqueTransactions4: Int
  """The unique number of transactions in the past 12 hours."""
  uniqueTransactions12: Int
  """The unique number of transactions in the past 24 hours."""
  uniqueTransactions24: Int
  """The trade volume in USD in the past hour."""
  volumeUSD1: String
  """The trade volume in USD in the past 4 hours."""
  volumeUSD4: String
  """The trade volume in USD in the past 12 hours."""
  volumeUSD12: String
  """The trade volume in USD in the past 24 hours."""
  volumeUSD24: String
  """The buy volume in USD in the past hour."""
  buyVolumeUSD1: String
  """The buy volume in USD in the past 12 hours."""
  buyVolumeUSD12: String
  """The buy volume in USD in the past 24 hours."""
  buyVolumeUSD24: String
  """The buy volume in USD in the past 4 hours."""
  buyVolumeUSD4: String
  """The sell volume in USD in the past hour."""
  sellVolumeUSD1: String
  """The sell volume in USD in the past 12 hours."""
  sellVolumeUSD12: String
  """The sell volume in USD in the past 24 hours."""
  sellVolumeUSD24: String
  """The sell volume in USD in the past 4 hours."""
  sellVolumeUSD4: String
  """The average age of the wallets that traded in the last 24h"""
  walletAgeAvg: String
  """The standard deviation of age of the wallets that traded in the last 24h"""
  walletAgeStd: String
  """The percentage of wallets that are less than 1d old that have traded in the last 24h"""
  swapPct1dOldWallet: String
  """The percentage of wallets that are less than 7d old that have traded in the last 24h"""
  swapPct7dOldWallet: String
}

PairMetadata

exchangeId
String

The exchange contract ID.

fee
Int

The exchange fee for swaps.

id
String!
required

The ID for the pair (address:networkId).

quoteToken
QuoteToken

The token of interest within the pair. Can be token0 or token1.

networkId
Int

The network ID the pair is deployed on.

liquidity
String!
required

The total liquidity in the pair.

liquidityToken
String

The token with higher liquidity within the pair. Can be token0 or token1.

nonLiquidityToken
String

The token with lower liquidity within the pair. Can be token0 or token1.

pairAddress
String!
required

The contract address of the pair.

statsType
TokenPairStatisticsType!
required

The type of statistics returned. Can be FILTERED or UNFILTERED

price
String!
required

The quote token price in USD.

priceChange5m
Float

The percent price change in the past 5 minutes. Decimal format.

priceChange1
Float

The percent price change in the past hour. Decimal format.

priceChange4
Float

The percent price change in the past 4 hours. Decimal format.

priceChange12
Float

The percent price change in the past 12 hours. Decimal format.

priceChange24
Float

The percent price change in the past 24 hours. Decimal format.

priceChange1w
Float

The percent price change in the past week. Decimal format.

tickSpacing
Int

The amount of required tick separation. Only applicable for pairs on UniswapV3.

token0
PairMetadataToken!
required

Pair metadata for the first token in the pair.

token1
PairMetadataToken!
required

Pair metadata for the second token in the pair.

volume1
String

The trade volume in USD in the past hour.

volume4
String

The trade volume in USD in the past 4 hours.

volume12
String

The trade volume in USD in the past 12 hours.

volume24
String

The trade volume in USD in the past 24 hours.

volume1w
String

The trade trade volume in USD in the past week.

volume5m
String

The trade volume in USD in the past 5 minutes.

highPrice5m
String

The highest price in USD in the past 5 minutes.

highPrice1
String

The highest price in USD in the past hour.

highPrice4
String

The highest price in USD in the past 4 hours.

highPrice12
String

The highest price in USD in the past 12 hours.

highPrice24
String

The highest price in USD in the past 24 hours.

highPrice1w
String

The highest price in USD in the past week.

lowPrice5m
String

The lowest price in USD in the past 5 minutes.

lowPrice1
String

The lowest price in USD in the past hour.

lowPrice12
String

The lowest price in USD in the past 12 hours.

lowPrice24
String

The lowest price in USD in the past 24 hours.

lowPrice4
String

The lowest price in USD in the past 4 hours.

lowPrice1w
String

The lowest price in USD in the past week.

enhancedToken0
EnhancedToken

Token metadata for the first token in the pair.

enhancedToken1
EnhancedToken

Token metadata for the second token in the pair.

createdAt
Int

The unix timestamp for the creation of the pair.

type PairMetadata {
  """The exchange contract ID."""
  exchangeId: String
  """The exchange fee for swaps."""
  fee: Int
  """The ID for the pair (`address:networkId`)."""
  id: String!
  """The token of interest within the pair. Can be `token0` or `token1`."""
  quoteToken: QuoteToken
  """The network ID the pair is deployed on."""
  networkId: Int
  """The total liquidity in the pair."""
  liquidity: String!
  """The token with higher liquidity within the pair. Can be `token0` or `token1`."""
  liquidityToken: String
  """The token with lower liquidity within the pair. Can be `token0` or `token1`."""
  nonLiquidityToken: String
  """The contract address of the pair."""
  pairAddress: String!
  """The type of statistics returned. Can be `FILTERED` or `UNFILTERED`"""
  statsType: TokenPairStatisticsType!
  """The quote token price in USD."""
  price: String!
  """The percent price change in the past 5 minutes. Decimal format."""
  priceChange5m: Float
  """The percent price change in the past hour. Decimal format."""
  priceChange1: Float
  """The percent price change in the past 4 hours. Decimal format."""
  priceChange4: Float
  """The percent price change in the past 12 hours. Decimal format."""
  priceChange12: Float
  """The percent price change in the past 24 hours. Decimal format."""
  priceChange24: Float
  """The percent price change in the past week. Decimal format."""
  priceChange1w: Float
  """The amount of required tick separation. Only applicable for pairs on UniswapV3."""
  tickSpacing: Int
  """Pair metadata for the first token in the pair."""
  token0: PairMetadataToken!
  """Pair metadata for the second token in the pair."""
  token1: PairMetadataToken!
  """The trade volume in USD in the past hour."""
  volume1: String
  """The trade volume in USD in the past 4 hours."""
  volume4: String
  """The trade volume in USD in the past 12 hours."""
  volume12: String
  """The trade volume in USD in the past 24 hours."""
  volume24: String
  """The trade trade volume in USD in the past week."""
  volume1w: String
  """The trade volume in USD in the past 5 minutes."""
  volume5m: String
  """The highest price in USD in the past 5 minutes."""
  highPrice5m: String
  """The highest price in USD in the past hour."""
  highPrice1: String
  """The highest price in USD in the past 4 hours."""
  highPrice4: String
  """The highest price in USD in the past 12 hours."""
  highPrice12: String
  """The highest price in USD in the past 24 hours."""
  highPrice24: String
  """The highest price in USD in the past week."""
  highPrice1w: String
  """The lowest price in USD in the past 5 minutes."""
  lowPrice5m: String
  """The lowest price in USD in the past hour."""
  lowPrice1: String
  """The lowest price in USD in the past 12 hours."""
  lowPrice12: String
  """The lowest price in USD in the past 24 hours."""
  lowPrice24: String
  """The lowest price in USD in the past 4 hours."""
  lowPrice4: String
  """The lowest price in USD in the past week."""
  lowPrice1w: String
  """Token metadata for the first token in the pair."""
  enhancedToken0: EnhancedToken
  """Token metadata for the second token in the pair."""
  enhancedToken1: EnhancedToken
  """The unix timestamp for the creation of the pair."""
  createdAt: Int
}

PairMetadataToken

Metadata for a token in a pair.

address
String!
required

No description provided

decimals
Int

No description provided

name
String!
required

No description provided

networkId
Int!
required

No description provided

pooled
String!
required

No description provided

price
String!
required

No description provided

symbol
String!
required

No description provided

labels
[ContractLabel]

No description provided

"""Metadata for a token in a pair."""
type PairMetadataToken {
  address: String!
  decimals: Int
  name: String!
  networkId: Int!
  pooled: String!
  price: String!
  symbol: String!
  labels: [ContractLabel]
}

ParallelAssetFilterConnection

Response returned by filterNftParallelAssets.

results
[ParallelAssetFilterResult]

The list of Parallel assets matching the filter parameters.

count
Int

The number of Parallel assets returned.

offset
Int

Where in the list the server started when returning items.

"""Response returned by `filterNftParallelAssets`."""
type ParallelAssetFilterConnection {
  """The list of Parallel assets matching the filter parameters."""
  results: [ParallelAssetFilterResult]
  """The number of Parallel assets returned."""
  count: Int
  """Where in the list the server started when returning items."""
  offset: Int
}

ParallelAssetFilterResult

A Parallel asset matching a set of filter parameters.

id
String!
required

The ID of the NFT asset (address:tokenId).

address
String!
required

The contract address of the NFT collection.

tokenId
String!
required

The token ID of the NFT asset.

parallelId
Int!
required

The internal Parallel ID of the NFT asset.

networkId
Int!
required

The network ID the NFT collection is deployed on.

media
NftAssetMedia

The NFT asset media.

name
String

The name of the NFT asset.

description
String

The description of the NFT asset.

originalImage
String

The source image URI linked by smart contract metadata.

uri
String

The URI provided by the smart contract. Typically JSON that contains metadata.

timestamp
Int

The unix timestamp for the last trade.

lastPriceUsd
String

The last sale price in USD.

lastPriceNetworkBaseToken
String

The last sale price in the network’s base token.

gameData
ParallelAssetGameData

The game data for the NFT asset.

metadata
ParallelAssetMetadata

Metadata for the NFT asset.

"""A Parallel asset matching a set of filter parameters."""
type ParallelAssetFilterResult {
  """The ID of the NFT asset (`address`:`tokenId`)."""
  id: String!
  """The contract address of the NFT collection."""
  address: String!
  """The token ID of the NFT asset."""
  tokenId: String!
  """The internal Parallel ID of the NFT asset."""
  parallelId: Int!
  """The network ID the NFT collection is deployed on."""
  networkId: Int!
  """The NFT asset media."""
  media: NftAssetMedia
  """The name of the NFT asset."""
  name: String
  """The description of the NFT asset."""
  description: String
  """The source image URI linked by smart contract metadata."""
  originalImage: String
  """The URI provided by the smart contract. Typically JSON that contains metadata."""
  uri: String
  """The unix timestamp for the last trade."""
  timestamp: Int
  """The last sale price in USD."""
  lastPriceUsd: String
  """The last sale price in the network's base token."""
  lastPriceNetworkBaseToken: String
  """The game data for the NFT asset."""
  gameData: ParallelAssetGameData
  """Metadata for the NFT asset."""
  metadata: ParallelAssetMetadata
}

ParallelAssetGameData

Game data for a Parallel asset.

rarity
String

The rarity of the asset. Can be Common, Uncommon, Rare, Legendary, or Prime.

parallel
String

The Parallel the asset belongs to.

cost
String

The energy used to play in-game.

attack
String

The damage dealt when engaged in combat.

health
String

The possible damage received before being destroyed.

cardType
String

The card type. Can be Effect, Relic, Unit, Upgrade or Paragon.

subtype
String

The card subtype. Can be Pirate, Vehicle or Clone.

functionText
String

The description of the card’s in-game abilities.

passiveAbility
String

The description of the card’s passive ability.

"""Game data for a Parallel asset."""
type ParallelAssetGameData {
  """The rarity of the asset. Can be `Common`, `Uncommon`, `Rare`, `Legendary`, or `Prime`."""
  rarity: String
  """The Parallel the asset belongs to."""
  parallel: String
  """The energy used to play in-game."""
  cost: String
  """The damage dealt when engaged in combat."""
  attack: String
  """The possible damage received before being destroyed."""
  health: String
  """The card type. Can be `Effect`, `Relic`, `Unit`, `Upgrade` or `Paragon`."""
  cardType: String
  """The card subtype. Can be `Pirate`, `Vehicle` or `Clone`."""
  subtype: String
  """The description of the card's in-game abilities."""
  functionText: String
  """The description of the card's passive ability."""
  passiveAbility: String
}

ParallelAssetMetadata

class
String

The card class. Can be Art Card, Asset, Card Back, FE, Masterpiece, PL, or SE.

supply
String

The total supply of this individual asset.

flavourText
String

The asset description, sourced off-chain. Usually equal to the asset’s on-chain description.

expansion
String

The expansion used for naming base and expansion sets.

paraset
String

The paraset the asset belongs to.

parallelId
String

The ID used to match other cards with the same name but different class.

artist
String

The artist name.

type ParallelAssetMetadata {
  """The card class. Can be `Art Card`, `Asset`, `Card Back`, `FE`, `Masterpiece`, `PL`, or `SE`."""
  class: String
  """The total supply of this individual asset."""
  supply: String
  """The asset description, sourced off-chain. Usually equal to the asset's on-chain `description`."""
  flavourText: String
  """The expansion used for naming base and expansion sets."""
  expansion: String
  """The paraset the asset belongs to."""
  paraset: String
  """The ID used to match other cards with the same name but different class."""
  parallelId: String
  """The artist name."""
  artist: String
}

ParallelCardChange

Tracked changes made to a Parallel card.

tokenId
String!
required

The token ID of the Parallel asset.

timestamp
Int!
required

The unix timestamp for the card change.

diff
ParallelCardChangeDiff!
required

The Parallel card metadata before and after the card change.

"""Tracked changes made to a Parallel card."""
type ParallelCardChange {
  """The token ID of the Parallel asset."""
  tokenId: String!
  """The unix timestamp for the card change."""
  timestamp: Int!
  """The Parallel card metadata before and after the card change."""
  diff: ParallelCardChangeDiff!
}

ParallelCardChangeDiff

Parallel card metadata before and after a card change.

old
ParallelCardChangeFields!
required

Metadata for a Parallel card before the card change.

new
ParallelCardChangeFields!
required

Metadata for a Parallel card after the card change.

"""Parallel card metadata before and after a card change."""
type ParallelCardChangeDiff {
  """Metadata for a Parallel card before the card change."""
  old: ParallelCardChangeFields!
  """Metadata for a Parallel card after the card change."""
  new: ParallelCardChangeFields!
}

ParallelCardChangeFields

Metadata for a Parallel card.

parallelId
String

The ID used to match other cards with the same name but different class.

rarity
String

The rarity of the asset. Can be Common, Uncommon, Rare, Legendary, or Prime.

class
String

The card class. Can be Art Card, Asset, Card Back, FE, Masterpiece, PL, or SE.

supply
String

The total supply of this individual asset.

parallel
String

The Parallel the asset belongs to.

cost
String

The energy used to play in-game.

attack
String

The damage dealt when engaged in combat.

health
String

The possible damage received before being destroyed.

cardType
String

The card type. Can be Effect, Relic, Unit, Upgrade or Paragon.

subtype
String

The card subtype. Can be Pirate, Vehicle or Clone.

functionText
String

The description of the card’s in-game abilities.

passiveAbility
String

The description of the card’s passive ability.

flavourText
String

The asset description, sourced off-chain. Usually equal to the asset’s on-chain description.

expansion
String

The expansion used for naming base and expansion sets.

paraset
String

The paraset the asset belongs to.

artist
String

The artist name.

"""Metadata for a Parallel card."""
type ParallelCardChangeFields {
  """The ID used to match other cards with the same name but different class."""
  parallelId: String
  """The rarity of the asset. Can be `Common`, `Uncommon`, `Rare`, `Legendary`, or `Prime`."""
  rarity: String
  """The card class. Can be `Art Card`, `Asset`, `Card Back`, `FE`, `Masterpiece`, `PL`, or `SE`."""
  class: String
  """The total supply of this individual asset."""
  supply: String
  """The Parallel the asset belongs to."""
  parallel: String
  """The energy used to play in-game."""
  cost: String
  """The damage dealt when engaged in combat."""
  attack: String
  """The possible damage received before being destroyed."""
  health: String
  """The card type. Can be `Effect`, `Relic`, `Unit`, `Upgrade` or `Paragon`."""
  cardType: String
  """The card subtype. Can be `Pirate`, `Vehicle` or `Clone`."""
  subtype: String
  """The description of the card's in-game abilities."""
  functionText: String
  """The description of the card's passive ability."""
  passiveAbility: String
  """The asset description, sourced off-chain. Usually equal to the asset's on-chain `description`."""
  flavourText: String
  """The expansion used for naming base and expansion sets."""
  expansion: String
  """The paraset the asset belongs to."""
  paraset: String
  """The artist name."""
  artist: String
}

ParallelCardChangesConnection

Response returned by getParallelCardChanges.

cursor
String

A cursor for use in pagination.

items
[ParallelCardChange]

A list of tracked changes made to a Parallel card.

"""Response returned by `getParallelCardChanges`."""
type ParallelCardChangesConnection {
  """A cursor for use in pagination."""
  cursor: String
  """A list of tracked changes made to a Parallel card."""
  items: [ParallelCardChange]
}

PoolBalanceChangedEventData

Event data for a BalancerV2 Pool Balance Changed event.

amount0
String

The amount of token0 added or removed from the pair.

amount1
String

The amount of token1 added or from the pair.

amount0Shifted
String

The amount of token0 added or removed from the pair, adjusted by the number of decimals in the token. For example, if amount0 is in WEI, amount0Shifted will be in ETH.

amount1Shifted
String

The amount of token1 added or removed from the pair, adjusted by the number of decimals in the token. For example, USDC amount1Shifted will be by 6 decimals.

token0
String

The address of token0 in the pair.

token1
String

The address of token1 in the pair.

sender
String

The address of account that added or removed liquidity.

protocolFeeAmount0
String

The amount of token0 captured by the protocol.

protocolFeeAmount1
String

The amount of token1 captured by the protocol.

liquidity0
String

The amount of token0 now in the pool.

liquidity1
String

The amount of token1 now in the pool.

type
EventType!
required

The type of token event, Burn.

"""Event data for a BalancerV2 Pool Balance Changed event."""
type PoolBalanceChangedEventData {
  """The amount of `token0` added or removed from the pair."""
  amount0: String
  """The amount of `token1` added or from the pair."""
  amount1: String
  """The amount of `token0` added or removed from the pair, adjusted by the number of decimals in the token. For example, if `amount0` is in WEI, `amount0Shifted` will be in ETH."""
  amount0Shifted: String
  """The amount of `token1` added or removed from the pair, adjusted by the number of decimals in the token. For example, USDC `amount1Shifted` will be by 6 decimals."""
  amount1Shifted: String
  """The address of `token0` in the pair."""
  token0: String
  """The address of `token1` in the pair."""
  token1: String
  """The address of account that added or removed liquidity."""
  sender: String
  """The amount of token0 captured by the protocol."""
  protocolFeeAmount0: String
  """The amount of token1 captured by the protocol."""
  protocolFeeAmount1: String
  """The amount of token0 now in the pool."""
  liquidity0: String
  """The amount of token1 now in the pool."""
  liquidity1: String
  """The type of token event, `Burn`."""
  type: EventType!
}

PooledTokenValues

token0
String

No description provided

token1
String

No description provided

type PooledTokenValues {
  token0: String
  token1: String
}

Price

Real-time or historical prices for a token.

address
String!
required

The contract address of the token.

networkId
Int!
required

The network ID the token is deployed on.

priceUsd
Float!
required

The token price in USD.

timestamp
Int

The unix timestamp for the price.

poolAddress
String!
required

The pool that emitted the swap generating this price

confidence
Float

Ratio of how confident we are in the price

"""Real-time or historical prices for a token."""
type Price {
  """The contract address of the token."""
  address: String!
  """The network ID the token is deployed on."""
  networkId: Int!
  """The token price in USD."""
  priceUsd: Float!
  """The unix timestamp for the price."""
  timestamp: Int
  """The pool that emitted the swap generating this price"""
  poolAddress: String!
  """Ratio of how confident we are in the price"""
  confidence: Float
}

PriceEventWebhookCondition

Webhook conditions for a price event.

tokenAddress
StringEqualsCondition!
required

The token contract address the webhook is listening for.

networkId
IntEqualsCondition!
required

The network ID the webhook is listening on.

priceUsd
ComparisonOperator!
required

The price condition that must be met in order for the webhook to send.

pairAddress
StringEqualsCondition

The pair contract address the webhook is listening for.

"""Webhook conditions for a price event."""
type PriceEventWebhookCondition {
  """The token contract address the webhook is listening for."""
  tokenAddress: StringEqualsCondition!
  """The network ID the webhook is listening on."""
  networkId: IntEqualsCondition!
  """The price condition that must be met in order for the webhook to send."""
  priceUsd: ComparisonOperator!
  """The pair contract address the webhook is listening for."""
  pairAddress: StringEqualsCondition
}

PrimeHolders

Response returned by primeHolders.

items
[Balance!]!
required

A list of holders of PRIME. Each request returns 50 results.

count
Int!
required

The number of holders returned.

cursor
String

The cursor to use for pagination.

"""Response returned by `primeHolders`."""
type PrimeHolders {
  """A list of holders of PRIME. Each request returns 50 results."""
  items: [Balance!]!
  """The number of holders returned."""
  count: Int!
  """The cursor to use for pagination."""
  cursor: String
}

PrimePool

An Echelon Prime Pool.

id
String

The ID of the contract-level Prime Pool (poolContractAddress:networkId). For example, 0x89bb49d06610b4b18e355504551809be5177f3d0:1.

poolContractAddress
String

The contract address for the Prime Pool.

networkId
Int

The network ID the Prime Pool is deployed on.

poolId
String

The ID of the pool within the contract.

calcData
PrimePoolCalcData

Values calculated by Defined using on-chain data.

chainData
PrimePoolChainData

Values obtained directly from the chain.

createdAt
Int

When the pool was created by Defined.

discoveryBlockNumber
Int

The block number for when Defined discovered this pool.

discoveryTransactionHash
String

The transaction hash of when Defined discovered this pool.

nftContractAddress
String

The contract address for the tokens cached ib the pool.

poolType
String

The type of pool for this Prime Pool.

tokenIds
[String]

The Parallel tokenIds required to cache in the pool.

totalSupply
String

The # of cached sets in the pool.

"""An Echelon Prime Pool."""
type PrimePool {
  """The ID of the contract-level Prime Pool (poolContractAddress:networkId). For example, `0x89bb49d06610b4b18e355504551809be5177f3d0:1`."""
  id: String
  """The contract address for the Prime Pool."""
  poolContractAddress: String
  """The network ID the Prime Pool is deployed on."""
  networkId: Int
  """The ID of the pool within the contract."""
  poolId: String
  """Values calculated by Defined using on-chain data."""
  calcData: PrimePoolCalcData
  """Values obtained directly from the chain."""
  chainData: PrimePoolChainData
  """When the pool was created by Defined."""
  createdAt: Int
  """The block number for when Defined discovered this pool."""
  discoveryBlockNumber: Int
  """The transaction hash of when Defined discovered this pool."""
  discoveryTransactionHash: String
  """The contract address for the tokens cached ib the pool."""
  nftContractAddress: String
  """The type of pool for this Prime Pool."""
  poolType: String
  """The Parallel tokenIds required to cache in the pool."""
  tokenIds: [String]
  """The # of cached sets in the pool."""
  totalSupply: String
}

PrimePoolAsset

A cached Prime pool asset.

id
String!
required

The Prime pool asset ID (poolContractAddress:poolId:networkId)

sortKey
String!
required

The owner wallet address of the cached Prime pool asset.

amount
String!
required

The number of cached Prime pool assets of this type by this owner.

from
String!
required

The owner wallet address of the cached Prime pool asset.

fromHashKey
String!
required

The owner wallet address of the cached Prime pool asset, and network ID (from:networkId).

fromSortKey
String!
required

The Prime pool ID and Prime pool contract address (poolId:poolContractAddress).

networkId
Int!
required

The network ID of the cached Prime pool asset.

poolContractAddress
String!
required

THe contract address of the Prime pool.

poolId
String!
required

The Prime pool ID.

ethRewardDebt
String

The amount of ETH the user is not eligible for either from having already harvesting or from not caching in the past.

primeRewardDebt
String

The amount of PRIME the user is not eligible for either from having already harvesting or from not caching in the past.

"""A cached Prime pool asset."""
type PrimePoolAsset {
  """The Prime pool asset ID (poolContractAddress:poolId:networkId)"""
  id: String!
  """The owner wallet address of the cached Prime pool asset."""
  sortKey: String!
  """The number of cached Prime pool assets of this type by this owner."""
  amount: String!
  """The owner wallet address of the cached Prime pool asset."""
  from: String!
  """The owner wallet address of the cached Prime pool asset, and network ID (from:networkId)."""
  fromHashKey: String!
  """The Prime pool ID and Prime pool contract address (poolId:poolContractAddress)."""
  fromSortKey: String!
  """The network ID of the cached Prime pool asset."""
  networkId: Int!
  """THe contract address of the Prime pool."""
  poolContractAddress: String!
  """The Prime pool ID."""
  poolId: String!
  """The amount of ETH the user is not eligible for either from having already harvesting or from not caching in the past."""
  ethRewardDebt: String
  """The amount of PRIME the user is not eligible for either from having already harvesting or from not caching in the past."""
  primeRewardDebt: String
}

PrimePoolAssetConnection

Response returned by getPrimePoolAssets.

cursor
String

The cursor to use for pagination.

items
[PrimePoolAsset]

The list of cached Prime pool assets returned by the query.

"""Response returned by `getPrimePoolAssets`."""
type PrimePoolAssetConnection {
  """The cursor to use for pagination."""
  cursor: String
  """The list of cached Prime pool assets returned by the query."""
  items: [PrimePoolAsset]
}

PrimePoolCacheData

Event-specific data for a Prime pool Cache transaction.

type
PrimePoolEventType!
required

The Prime pool event type.

eventAmount
String!
required

The amount of Prime pool asset(s) cached.

totalSupply
String!
required

The total supply of assets cached in this Prime pool, including the amount cached in this transaction.

user
String!
required

The owner wallet address of the cached Prime pool asset(s).

userCachedAmount
String!
required

The total number of Prime pool asset(s) cached in this pool by this owner.

userPrimeRewardDebt
String!
required

The amount of PRIME the user is not eligible for either from having already harvesting or from not caching in the past.

userEthRewardDebt
String!
required

The amount of ETH the user is not eligible for either from having already harvesting or from not caching in the past.

"""Event-specific data for a Prime pool Cache transaction."""
type PrimePoolCacheData {
  """The Prime pool event type."""
  type: PrimePoolEventType!
  """The amount of Prime pool asset(s) cached."""
  eventAmount: String!
  """The total supply of assets cached in this Prime pool, including the amount cached in this transaction."""
  totalSupply: String!
  """The owner wallet address of the cached Prime pool asset(s)."""
  user: String!
  """The total number of Prime pool asset(s) cached in this pool by this owner."""
  userCachedAmount: String!
  """The amount of PRIME the user is not eligible for either from having already harvesting or from not caching in the past."""
  userPrimeRewardDebt: String!
  """The amount of ETH the user is not eligible for either from having already harvesting or from not caching in the past."""
  userEthRewardDebt: String!
}

PrimePoolCachingPausedData

Event-specific data for a Prime pool CachingPaused transaction.

type
PrimePoolEventType!
required

The Prime pool event type.

cachingPaused
Boolean!
required

The state of caching paused set on the pool.

"""Event-specific data for a Prime pool CachingPaused transaction."""
type PrimePoolCachingPausedData {
  """The Prime pool event type."""
  type: PrimePoolEventType!
  """The state of caching paused set on the pool."""
  cachingPaused: Boolean!
}

PrimePoolCalcData

poolAccumulatedPrime
String

The amount of accumulated PRIME rewards in total for the pool.

shareAccumulatedPrime
String

The amount of accumulated PRIME rewards per share for the pool.

poolAccumulatedEth
String

The amount of accumulated ETH rewards in total for the pool.

shareAccumulatedEth
String

The amount of accumulated ETH rewards per share for the pool.

poolPrimeAmount
String

The amount of PRIME for the pool to pay out as caching rewards.

poolEthAmount
String

The amount of ETH for the pool to pay out as caching rewards.

poolPrimePerDay
String

The amount of PRIME paid out daily by the pool as caching rewards.

poolPrimePerSecond
String

The amount of PRIME paid out per second by the pool as caching rewards.

poolEthPerDay
String

The amount of ETH paid out daily by the pool as caching rewards.

poolEthPerSecond
String

The amount of ETH paid out per second by the pool as caching rewards.

sharePrimePerDay
String

The amount of PRIME paid out daily by the pool, per share of the pool’s total cached supply.

sharePrimePerSecond
String

The amount of PRIME paid out per second by the pool, per share of the pool’s total cached supply.

shareEthPerDay
String

The amount of ETH paid out daily by the pool, per share of the pool’s total cached supply.

shareEthPerSecond
String

The amount of ETH paid out per second by the pool, per share of the pool’s total cached supply.

type PrimePoolCalcData {
  """The amount of accumulated PRIME rewards in total for the pool."""
  poolAccumulatedPrime: String
  """The amount of accumulated PRIME rewards per share for the pool."""
  shareAccumulatedPrime: String
  """The amount of accumulated ETH rewards in total for the pool."""
  poolAccumulatedEth: String
  """The amount of accumulated ETH rewards per share for the pool."""
  shareAccumulatedEth: String
  """The amount of PRIME for the pool to pay out as caching rewards."""
  poolPrimeAmount: String
  """The amount of ETH for the pool to pay out as caching rewards."""
  poolEthAmount: String
  """The amount of PRIME paid out daily by the pool as caching rewards."""
  poolPrimePerDay: String
  """The amount of PRIME paid out per second by the pool as caching rewards."""
  poolPrimePerSecond: String
  """The amount of ETH paid out daily by the pool as caching rewards."""
  poolEthPerDay: String
  """The amount of ETH paid out per second by the pool as caching rewards."""
  poolEthPerSecond: String
  """The amount of PRIME paid out daily by the pool, per share of the pool's total cached supply."""
  sharePrimePerDay: String
  """The amount of PRIME paid out per second by the pool, per share of the pool's total cached supply."""
  sharePrimePerSecond: String
  """The amount of ETH paid out daily by the pool, per share of the pool's total cached supply."""
  shareEthPerDay: String
  """The amount of ETH paid out per second by the pool, per share of the pool's total cached supply."""
  shareEthPerSecond: String
}

PrimePoolChainData

Values obtained directly from the chain.

cachingPaused
Boolean

Whether caching is paused for this pool.

ethClaimed
String

How much ETH has been claimed for this pool.

ethReward
String

How much ETH reward has been accrued for this pool.

ethAllocPoint
String

The pool’s allocation of the contract’s per-second ETH rewards.

ethTotalAllocPoint
String

Total share points of the contract’s per-second ETH rewards to the pool.

ethStartTimestamp
Int

Caching ETH rewards period start timestamp.

ethEndTimestamp
Int

Caching ETH rewards period end timestamp.

ethLastRewardTimestamp
Int

Last timestamp at which ETH rewards were assigned.

ethTimedCachePeriod
String

Minimum number of timed cache seconds per ETH.

primeAllocPoint
String

The pool’s allocation of the contract’s per second PRIME rewards.

primeTotalAllocPoint
String

Total share points of the contract’s per second PRIME rewards to the pool.

primeStartTimestamp
String

Caching rewards period start timestamp.

primeEndTimestamp
Int

Caching rewards period end timestamp.

primeLastRewardTimestamp
Int

Last timestamp at which PRIME rewards were assigned.

"""Values obtained directly from the chain."""
type PrimePoolChainData {
  """Whether caching is paused for this pool."""
  cachingPaused: Boolean
  """How much ETH has been claimed for this pool."""
  ethClaimed: String
  """How much ETH reward has been accrued for this pool."""
  ethReward: String
  """The pool's allocation of the contract's per-second ETH rewards."""
  ethAllocPoint: String
  """Total share points of the contract's per-second ETH rewards to the pool."""
  ethTotalAllocPoint: String
  """Caching ETH rewards period start timestamp."""
  ethStartTimestamp: Int
  """Caching ETH rewards period end timestamp."""
  ethEndTimestamp: Int
  """Last timestamp at which ETH rewards were assigned."""
  ethLastRewardTimestamp: Int
  """Minimum number of timed cache seconds per ETH."""
  ethTimedCachePeriod: String
  """The pool's allocation of the contract's per second PRIME rewards."""
  primeAllocPoint: String
  """Total share points of the contract's per second PRIME rewards to the pool."""
  primeTotalAllocPoint: String
  """Caching rewards period start timestamp."""
  primeStartTimestamp: String
  """Caching rewards period end timestamp."""
  primeEndTimestamp: Int
  """Last timestamp at which PRIME rewards were assigned."""
  primeLastRewardTimestamp: Int
}

PrimePoolClaimEthData

Event-specific data for a Prime pool ClaimEth transaction.

type
PrimePoolEventType!
required

The Prime pool event type.

user
String!
required

The wallet address claiming ETH rewards.

eventAmount
String!
required

The amount of ETH claimed.

currency
PrimePoolCurrency!
required

The currency type of the event.

userEthRewardDebt
String!
required

The amount of ETH the user is not eligible for either from having already harvesting or from not caching in the past.

ethClaimed
String

The total amount of ETH claimed for a pool.

"""Event-specific data for a Prime pool ClaimEth transaction."""
type PrimePoolClaimEthData {
  """The Prime pool event type."""
  type: PrimePoolEventType!
  """The wallet address claiming ETH rewards."""
  user: String!
  """The amount of ETH claimed."""
  eventAmount: String!
  """The currency type of the event."""
  currency: PrimePoolCurrency!
  """The amount of ETH the user is not eligible for either from having already harvesting or from not caching in the past."""
  userEthRewardDebt: String!
  """The total amount of ETH claimed for a pool."""
  ethClaimed: String
}

PrimePoolClaimPrimeData

Event-specific data for a Prime pool ClaimPrime transaction.

type
PrimePoolEventType!
required

The Prime pool event type.

user
String!
required

The wallet address claiming PRIME rewards.

eventAmount
String!
required

The amount of PRIME claimed.

currency
PrimePoolCurrency!
required

The currency type of the event.

userPrimeRewardDebt
String!
required

The total amount of PRIME claimed for a pool.

"""Event-specific data for a Prime pool ClaimPrime transaction."""
type PrimePoolClaimPrimeData {
  """The Prime pool event type."""
  type: PrimePoolEventType!
  """The wallet address claiming PRIME rewards."""
  user: String!
  """The amount of PRIME claimed."""
  eventAmount: String!
  """The currency type of the event."""
  currency: PrimePoolCurrency!
  """The total amount of PRIME claimed for a pool."""
  userPrimeRewardDebt: String!
}

PrimePoolConnection

Response returned by getPrimePools.

cursor
String

A cursor for use in pagination.

items
[PrimePool]

A list of prime pools.

"""Response returned by `getPrimePools`."""
type PrimePoolConnection {
  """A cursor for use in pagination."""
  cursor: String
  """A list of prime pools."""
  items: [PrimePool]
}

PrimePoolEmergencyWithdrawData

Event-specific data for a Prime pool EmergencyWithdraw transaction.

type
PrimePoolEventType!
required

The Prime pool event type.

user
String!
required

The wallet address emergency withdrawing from the pool.

eventAmount
String!
required

The amount of Prime pool asset(s) emergency withdrawn.

totalSupply
String!
required

The total supply of assets cached in this Prime pool.

userCachedAmount
String!
required

The updated total number of Prime pool asset(s) cached in this pool by this owner.

userPrimeRewardDebt
String!
required

The amount of PRIME the user is not eligible for either from having already harvesting or from not caching in the past.

userEthRewardDebt
String!
required

The amount of ETH the user is not eligible for either from having already harvesting or from not caching in the past.

"""Event-specific data for a Prime pool EmergencyWithdraw transaction."""
type PrimePoolEmergencyWithdrawData {
  """The Prime pool event type."""
  type: PrimePoolEventType!
  """The wallet address emergency withdrawing from the pool."""
  user: String!
  """The amount of Prime pool asset(s) emergency withdrawn."""
  eventAmount: String!
  """The total supply of assets cached in this Prime pool."""
  totalSupply: String!
  """The updated total number of Prime pool asset(s) cached in this pool by this owner."""
  userCachedAmount: String!
  """The amount of PRIME the user is not eligible for either from having already harvesting or from not caching in the past."""
  userPrimeRewardDebt: String!
  """The amount of ETH the user is not eligible for either from having already harvesting or from not caching in the past."""
  userEthRewardDebt: String!
}

PrimePoolEndTimestampUpdatedEthData

Event-specific data for a Prime pool EndTimestampUpdatedEth transaction.

type
PrimePoolEventType!
required

The Prime pool event type.

currency
PrimePoolCurrency!
required

The currency type of the event.

ethStartTimestamp
Int!
required

The updated ETH reward start timestamp for the pool.

ethEndTimestamp
Int!
required

The updated ETH reward end timestamp for the pool.

ethPerSecond
String!
required

The updated reward per second for the pool.

"""Event-specific data for a Prime pool EndTimestampUpdatedEth transaction."""
type PrimePoolEndTimestampUpdatedEthData {
  """The Prime pool event type."""
  type: PrimePoolEventType!
  """The currency type of the event."""
  currency: PrimePoolCurrency!
  """The updated ETH reward start timestamp for the pool."""
  ethStartTimestamp: Int!
  """The updated ETH reward end timestamp for the pool."""
  ethEndTimestamp: Int!
  """The updated reward per second for the pool."""
  ethPerSecond: String!
}

PrimePoolEndTimestampUpdatedPrimeData

Event-specific data for a Prime pool EndTimestampUpdatedPrime transaction.

type
PrimePoolEventType!
required

The Prime pool event type.

currency
PrimePoolCurrency!
required

The currency type of the event.

primeStartTimestamp
Int!
required

The updated PRIME reward start timestamp for the pool.

primeEndTimestamp
Int!
required

The updated PRIME reward end timestamp for the pool.

primePerSecond
String!
required

The updated reward per second for the pool.

"""Event-specific data for a Prime pool EndTimestampUpdatedPrime transaction."""
type PrimePoolEndTimestampUpdatedPrimeData {
  """The Prime pool event type."""
  type: PrimePoolEventType!
  """The currency type of the event."""
  currency: PrimePoolCurrency!
  """The updated PRIME reward start timestamp for the pool."""
  primeStartTimestamp: Int!
  """The updated PRIME reward end timestamp for the pool."""
  primeEndTimestamp: Int!
  """The updated reward per second for the pool."""
  primePerSecond: String!
}

PrimePoolEthRewardsAddedData

Event-specific data for a Prime pool LogUpdatePool transaction.

type
PrimePoolEventType!
required

The Prime pool event type.

amount
String!
required

The amount of ETH rewards added to the pool.

totalRewards
String!
required

The total ETH rewards for the pool.

"""Event-specific data for a Prime pool LogUpdatePool transaction."""
type PrimePoolEthRewardsAddedData {
  """The Prime pool event type."""
  type: PrimePoolEventType!
  """The amount of ETH rewards added to the pool."""
  amount: String!
  """The total ETH rewards for the pool."""
  totalRewards: String!
}

PrimePoolEthRewardsSetData

Event-specific data for a Prime pool EthRewardsSet transaction.

type
PrimePoolEventType!
required

The Prime pool event type.

amount
String!
required

The amount of ETH rewards set for the pool.

totalRewards
String!
required

The total ETH rewards for the pool.

"""Event-specific data for a Prime pool EthRewardsSet transaction."""
type PrimePoolEthRewardsSetData {
  """The Prime pool event type."""
  type: PrimePoolEventType!
  """The amount of ETH rewards set for the pool."""
  amount: String!
  """The total ETH rewards for the pool."""
  totalRewards: String!
}

PrimePoolEvent

A Prime pool event.

id
String!
required

The Prime pool event ID (poolContractAddress:poolId:networkId)

sortKey
String!
required

The sort key of the Prime pool event (blockNumber:transactionIndex:logIndex).

blockHash
String!
required

The blockHash of the Prime pool event.

blockNumber
Int!
required

The blockNumber of the Prime pool event.

data
PrimePoolEventData!
required

The event data for the Prime pool event.

eventType
PrimePoolEventType!
required

The Prime pool event type.

from
String!
required

The Prime pool event’s calling address.

fromHashKey
String!
required

The Prime pool event’s calling address, and network ID (from:networkId).

logIndex
Int!
required

The logIndex of the Prime pool event.

networkId
Int!
required

The network ID of the Prime pool event.

poolContractAddress
String!
required

The Prime pool contract address.

poolId
String!
required

The Prime pool ID.

poolType
PrimePoolType!
required

The Prime pool type.

timestamp
Int!
required

The timestamp of the Prime pool event.

transactionHash
String!
required

The transactionHash of the Prime pool event.

transactionIndex
Int!
required

The transactionIndex of the Prime pool event.

"""A Prime pool event."""
type PrimePoolEvent {
  """The Prime pool event ID (poolContractAddress:poolId:networkId)"""
  id: String!
  """The sort key of the Prime pool event (blockNumber:transactionIndex:logIndex)."""
  sortKey: String!
  """The blockHash of the Prime pool event."""
  blockHash: String!
  """The blockNumber of the Prime pool event."""
  blockNumber: Int!
  """The event data for the Prime pool event."""
  data: PrimePoolEventData!
  """The Prime pool event type."""
  eventType: PrimePoolEventType!
  """The Prime pool event's calling address."""
  from: String!
  """The Prime pool event's calling address, and network ID (from:networkId)."""
  fromHashKey: String!
  """The logIndex of the Prime pool event."""
  logIndex: Int!
  """The network ID of the Prime pool event."""
  networkId: Int!
  """The Prime pool contract address."""
  poolContractAddress: String!
  """The Prime pool ID."""
  poolId: String!
  """The Prime pool type."""
  poolType: PrimePoolType!
  """The timestamp of the Prime pool event."""
  timestamp: Int!
  """The transactionHash of the Prime pool event."""
  transactionHash: String!
  """The transactionIndex of the Prime pool event."""
  transactionIndex: Int!
}

PrimePoolEventConnection

Response returned by getPrimePoolEvents.

cursor
String

The cursor to use for pagination.

items
[PrimePoolEvent]

The list of Prime pool events returned by the query.

"""Response returned by `getPrimePoolEvents`."""
type PrimePoolEventConnection {
  """The cursor to use for pagination."""
  cursor: String
  """The list of Prime pool events returned by the query."""
  items: [PrimePoolEvent]
}

PrimePoolLogPoolAdditionData

Event-specific data for a Prime pool LogPoolAddition (new Prime pool) transaction.

type
PrimePoolEventType!
required

The Prime pool event type.

tokenIds
[String!]!
required

The token ID’s added to the new Prime pool.

"""Event-specific data for a Prime pool LogPoolAddition (new Prime pool) transaction."""
type PrimePoolLogPoolAdditionData {
  """The Prime pool event type."""
  type: PrimePoolEventType!
  """The token ID's added to the new Prime pool."""
  tokenIds: [String!]!
}

PrimePoolLogPoolSetAllocPointData

Event-specific data for a Prime pool LogPoolSetAllocPoint transaction.

type
PrimePoolEventType!
required

The Prime pool event type.

currency
PrimePoolCurrency!
required

The currency type of the event.

allocPoint
String!
required

The updated alloc point for the pool (the pool’s share of the contract’s total rewards).

totalAllocPoint
String!
required

The updated total alloc point for the pool (the sum of all pools’ alloc points).

"""Event-specific data for a Prime pool LogPoolSetAllocPoint transaction."""
type PrimePoolLogPoolSetAllocPointData {
  """The Prime pool event type."""
  type: PrimePoolEventType!
  """The currency type of the event."""
  currency: PrimePoolCurrency!
  """The updated alloc point for the pool (the pool's share of the contract's total rewards)."""
  allocPoint: String!
  """The updated total alloc point for the pool (the sum of all pools' alloc points)."""
  totalAllocPoint: String!
}

PrimePoolLogSetPerSecondData

Event-specific data for a Prime pool LogSetPerSecond transaction.

type
PrimePoolEventType!
required

The Prime pool event type.

currency
PrimePoolCurrency!
required

The currency type of the event.

amount
String!
required

The updated reward per second for the pool.

startTimestamp
Int!
required

The updated reward start timestamp for the pool.

endTimestamp
Int!
required

The updated reward end timestamp for the pool.

primeAmountPerSecond
String

The updated PRIME reward per second for the pool.

ethAmountPerSecond
String

The updated ETH reward per second for the pool.

"""Event-specific data for a Prime pool LogSetPerSecond transaction."""
type PrimePoolLogSetPerSecondData {
  """The Prime pool event type."""
  type: PrimePoolEventType!
  """The currency type of the event."""
  currency: PrimePoolCurrency!
  """The updated reward per second for the pool."""
  amount: String!
  """The updated reward start timestamp for the pool."""
  startTimestamp: Int!
  """The updated reward end timestamp for the pool."""
  endTimestamp: Int!
  """The updated PRIME reward per second for the pool."""
  primeAmountPerSecond: String
  """The updated ETH reward per second for the pool."""
  ethAmountPerSecond: String
}

PrimePoolLogUpdatePoolData

Event-specific data for a Prime pool LogUpdatePool transaction.

type
PrimePoolEventType!
required

The Prime pool event type.

lastRewardTimestamp
Int!
required

The timestamp at which rewards were last assigned.

supply
String!
required

The total amount of assets cached in the pool (emitted by the event, before the transaction).

totalSupply
String!
required

The total amount of assets cached in the pool (queried from the pool after the transaction).

accPerShare
String!
required

The amount of accumulated rewards per share.

currency
PrimePoolCurrency!
required

The currency type of the event.

primeAmount
String

The PRIME amount of the pool.

ethAmount
String

The ETH amount of the pool.

"""Event-specific data for a Prime pool LogUpdatePool transaction."""
type PrimePoolLogUpdatePoolData {
  """The Prime pool event type."""
  type: PrimePoolEventType!
  """The timestamp at which rewards were last assigned."""
  lastRewardTimestamp: Int!
  """The total amount of assets cached in the pool (emitted by the event, before the transaction)."""
  supply: String!
  """The total amount of assets cached in the pool (queried from the pool after the transaction)."""
  totalSupply: String!
  """The amount of accumulated rewards per share."""
  accPerShare: String!
  """The currency type of the event."""
  currency: PrimePoolCurrency!
  """The PRIME amount of the pool."""
  primeAmount: String
  """The ETH amount of the pool."""
  ethAmount: String
}

PrimePoolRewardDecreaseData

Event-specific data for a Prime pool RewardDecrease transaction.

type
PrimePoolEventType!
required

The Prime pool event type.

currency
PrimePoolCurrency!
required

The currency type of the event.

eventAmount
String!
required

The amount of rewards decreased.

updatedAmount
String!
required

The updated total rewards for the pool.

"""Event-specific data for a Prime pool RewardDecrease transaction."""
type PrimePoolRewardDecreaseData {
  """The Prime pool event type."""
  type: PrimePoolEventType!
  """The currency type of the event."""
  currency: PrimePoolCurrency!
  """The amount of rewards decreased."""
  eventAmount: String!
  """The updated total rewards for the pool."""
  updatedAmount: String!
}

PrimePoolRewardIncreaseData

Event-specific data for a Prime pool RewardIncrease transaction.

type
PrimePoolEventType!
required

The Prime pool event type.

currency
PrimePoolCurrency!
required

The currency type of the event.

eventAmount
String!
required

The amount of rewards increased.

updatedAmount
String!
required

The updated total rewards for the pool.

"""Event-specific data for a Prime pool RewardIncrease transaction."""
type PrimePoolRewardIncreaseData {
  """The Prime pool event type."""
  type: PrimePoolEventType!
  """The currency type of the event."""
  currency: PrimePoolCurrency!
  """The amount of rewards increased."""
  eventAmount: String!
  """The updated total rewards for the pool."""
  updatedAmount: String!
}

PrimePoolTimeCachePeriodUpdateData

Event-specific data for a Prime pool TimeCachePeriodUpdate transaction.

type
PrimePoolEventType!
required

The Prime pool event type.

currency
PrimePoolCurrency!
required

The currency type of the event.

timedCachePeriod
String!
required

The minimum number of timed cache seconds per ETH reward.

"""Event-specific data for a Prime pool TimeCachePeriodUpdate transaction."""
type PrimePoolTimeCachePeriodUpdateData {
  """The Prime pool event type."""
  type: PrimePoolEventType!
  """The currency type of the event."""
  currency: PrimePoolCurrency!
  """The minimum number of timed cache seconds per ETH reward."""
  timedCachePeriod: String!
}

PrimePoolWithdrawData

Event-specific data for a Prime pool Withdraw transaction.

type
PrimePoolEventType!
required

The Prime pool event type.

user
String!
required

The address of the wallet who withdrew.

eventAmount
String!
required

The amount of assets withdrawn.

totalSupply
String!
required

The updated total assets for the pool after the withdrawal.

userPrimeRewardDebt
String!
required

The amount of PRIME the user is not eligible for either from having already harvesting or from not caching in the past.

userEthRewardDebt
String!
required

The amount of ETH the user is not eligible for either from having already harvesting or from not caching in the past.

userCachedAmount
String!
required

The amount of cached asset the user has in the pool, following the withdrawal.

"""Event-specific data for a Prime pool Withdraw transaction."""
type PrimePoolWithdrawData {
  """The Prime pool event type."""
  type: PrimePoolEventType!
  """The address of the wallet who withdrew."""
  user: String!
  """The amount of assets withdrawn."""
  eventAmount: String!
  """The updated total assets for the pool after the withdrawal."""
  totalSupply: String!
  """The amount of PRIME the user is not eligible for either from having already harvesting or from not caching in the past."""
  userPrimeRewardDebt: String!
  """The amount of ETH the user is not eligible for either from having already harvesting or from not caching in the past."""
  userEthRewardDebt: String!
  """The amount of cached asset the user has in the pool, following the withdrawal."""
  userCachedAmount: String!
}

RawNftAssetData

Raw NFT asset data.

imageUrl
String

An optional image field that may or may not be present on the requested NFT asset smart contract.

imageData
String

An optional image field that may or may not be present on the requested NFT asset smart contract.

animationUrl
String

An optional image field that may or may not be present on the requested NFT asset smart contract.

externalUrl
String

An optional field that may or may not be present on the requested NFT asset smart contract.

"""Raw NFT asset data."""
type RawNftAssetData {
  """An optional image field that may or may not be present on the requested NFT asset smart contract."""
  imageUrl: String
  """An optional image field that may or may not be present on the requested NFT asset smart contract."""
  imageData: String
  """An optional image field that may or may not be present on the requested NFT asset smart contract."""
  animationUrl: String
  """An optional field that may or may not be present on the requested NFT asset smart contract."""
  externalUrl: String
}

RawTransactionWebhookCondition

Webhook conditions for a raw transaction.

networkId
OneOfNumberCondition

A list of network IDs to listen on.

to
StringEqualsCondition

The to address to listen for.

from
StringEqualsCondition

The from address to listen for.

toOrFrom
StringEqualsCondition

Trigger the webhook if either the to or the from address matches.

input
StringContainsCondition

Trigger the webhook if the contains or doesn’t contain the specified string.

ignoreTokenPairEvents
Boolean

Do not trigger the webhook if the raw transaction is handled by the TokenPairEvent webhook.

ignoreNftEvents
Boolean

Do not trigger the webhook if the raw transaction is handled by the NftEvent webhook.

"""Webhook conditions for a raw transaction."""
type RawTransactionWebhookCondition {
  """A list of network IDs to listen on."""
  networkId: OneOfNumberCondition
  """The to address to listen for."""
  to: StringEqualsCondition
  """The from address to listen for."""
  from: StringEqualsCondition
  """Trigger the webhook if either the to or the from address matches."""
  toOrFrom: StringEqualsCondition
  """Trigger the webhook if the contains or doesn't contain the specified string."""
  input: StringContainsCondition
  """Do not trigger the webhook if the raw transaction is handled by the TokenPairEvent webhook."""
  ignoreTokenPairEvents: Boolean
  """Do not trigger the webhook if the raw transaction is handled by the NftEvent webhook."""
  ignoreNftEvents: Boolean
}

ResolutionBarData

Price data for each supported resolution.

r1S
CurrencyBarData

1 second resolution.

r5S
CurrencyBarData

5 second resolution.

r15S
CurrencyBarData

15 second resolution.

r30S
CurrencyBarData

30 second resolution.

r1
CurrencyBarData

1 minute resolution.

r5
CurrencyBarData

5 minute resolution.

r15
CurrencyBarData

15 minute resolution.

r30
CurrencyBarData

30 minute resolution.

r60
CurrencyBarData

60 minute resolution.

r240
CurrencyBarData

4 hour resolution.

r720
CurrencyBarData

12 hour resolution.

r1D
CurrencyBarData

1 day resolution.

r7D
CurrencyBarData

1 week resolution.

"""Price data for each supported resolution."""
type ResolutionBarData {
  """1 second resolution."""
  r1S: CurrencyBarData
  """5 second resolution."""
  r5S: CurrencyBarData
  """15 second resolution."""
  r15S: CurrencyBarData
  """30 second resolution."""
  r30S: CurrencyBarData
  """1 minute resolution."""
  r1: CurrencyBarData
  """5 minute resolution."""
  r5: CurrencyBarData
  """15 minute resolution."""
  r15: CurrencyBarData
  """30 minute resolution."""
  r30: CurrencyBarData
  """60 minute resolution."""
  r60: CurrencyBarData
  """4 hour resolution."""
  r240: CurrencyBarData
  """12 hour resolution."""
  r720: CurrencyBarData
  """1 day resolution."""
  r1D: CurrencyBarData
  """1 week resolution."""
  r7D: CurrencyBarData
}

RetrySettings

Config for retrying failed webhook messages.

maxTimeElapsed
Int

The maximum time in seconds that the webhook will retry sending a message

minRetryDelay
Int

The minimum time in seconds that the webhook will wait before retrying a failed message

maxRetryDelay
Int

The maximum time in seconds that the webhook will wait before retrying a failed message

maxRetries
Int

The maximum number of times the webhook will retry sending a message

"""Config for retrying failed webhook messages."""
type RetrySettings {
  """The maximum time in seconds that the webhook will retry sending a message"""
  maxTimeElapsed: Int
  """The minimum time in seconds that the webhook will wait before retrying a failed message"""
  minRetryDelay: Int
  """The maximum time in seconds that the webhook will wait before retrying a failed message"""
  maxRetryDelay: Int
  """The maximum number of times the webhook will retry sending a message"""
  maxRetries: Int
}

SandwichedLabelData

Metadata for a sandwich label.

token0DrainedAmount
String

The amount of token0 drained in the attack.

token1DrainedAmount
String

The amount of token1 drained in the attack.

"""Metadata for a sandwich label."""
type SandwichedLabelData {
  """The amount of `token0` drained in the attack."""
  token0DrainedAmount: String
  """The amount of `token1` drained in the attack."""
  token1DrainedAmount: String
}

SandwichLabelForEvent

Metadata for a sandwich label.

label
String!
required

The label type, ‘sandwiched’.

sandwichType
SandwichLabelForEventType!
required

The sandwich event label types.

token0DrainedAmount
String!
required

The amount of token0 drained in the attack.

token1DrainedAmount
String!
required

The amount of token1 drained in the attack.

"""Metadata for a sandwich label."""
type SandwichLabelForEvent {
  """The label type, 'sandwiched'."""
  label: String!
  """The sandwich event label types."""
  sandwichType: SandwichLabelForEventType!
  """The amount of `token0` drained in the attack."""
  token0DrainedAmount: String!
  """The amount of `token1` drained in the attack."""
  token1DrainedAmount: String!
}

SimulateContractBalanceErrorsType

Errors for a token contract balance.

tokenContractTokenBalanceError
String

No description provided

tokenContractEthBalanceError
String

No description provided

"""Errors for a token contract balance."""
type SimulateContractBalanceErrorsType {
  tokenContractTokenBalanceError: String
  tokenContractEthBalanceError: String
}

SimulateContractBalanceType

Result of a token contract balance.

tokenContractTokenBalance
String

No description provided

tokenContractEthBalance
String

No description provided

"""Result of a token contract balance."""
type SimulateContractBalanceType {
  tokenContractTokenBalance: String
  tokenContractEthBalance: String
}

SimulateCreatorErrorsType

Errors for a token contract creator.

creatorTokenBalanceError
String

No description provided

creatorEthBalanceError
String

No description provided

"""Errors for a token contract creator."""
type SimulateCreatorErrorsType {
  creatorTokenBalanceError: String
  creatorEthBalanceError: String
}

SimulateCreatorType

Result of a token contract creator.

creatorAddress
String

No description provided

creatorTokenBalance
String

No description provided

creatorEthBalance
String

No description provided

"""Result of a token contract creator."""
type SimulateCreatorType {
  creatorAddress: String
  creatorTokenBalance: String
  creatorEthBalance: String
}

SimulateDeployErrorsType

Errors for a token contract deploy.

deployError
String

No description provided

tokenMintedToDeployerError
String

No description provided

"""Errors for a token contract deploy."""
type SimulateDeployErrorsType {
  deployError: String
  tokenMintedToDeployerError: String
}

SimulateDeployType

Result of a token contract deploy.

deploySuccess
Boolean

No description provided

tokenMintedToDeployer
String

No description provided

"""Result of a token contract deploy."""
type SimulateDeployType {
  deploySuccess: Boolean
  tokenMintedToDeployer: String
}

SimulateLiquidityErrorsType

Errors for a token contract liquidity.

lpTotalSupplyError
String

No description provided

preLiquidityEnableTradingError
String

No description provided

postLiquidityEnableTradingError
String

No description provided

addLiquidityError
String

No description provided

"""Errors for a token contract liquidity."""
type SimulateLiquidityErrorsType {
  lpTotalSupplyError: String
  preLiquidityEnableTradingError: String
  postLiquidityEnableTradingError: String
  addLiquidityError: String
}

SimulateLiquidityType

Result of a token contract liquidity.

pairAddress
String

No description provided

lpTotalSupply
String

No description provided

preLiquidityEnableTradingCall
String

No description provided

preLiquidityEnableTradingSuccess
Boolean

No description provided

preLiquidityEnableTradingSupportsTransfer
Boolean

No description provided

liquiditySetByPreLiquidityOpenTradingCall
Boolean

No description provided

postLiquidityEnableTradingCall
String

No description provided

postLiquidityEnableTradingSuccess
Boolean

No description provided

addLiquiditySuccess
Boolean

No description provided

"""Result of a token contract liquidity."""
type SimulateLiquidityType {
  pairAddress: String
  lpTotalSupply: String
  preLiquidityEnableTradingCall: String
  preLiquidityEnableTradingSuccess: Boolean
  preLiquidityEnableTradingSupportsTransfer: Boolean
  liquiditySetByPreLiquidityOpenTradingCall: Boolean
  postLiquidityEnableTradingCall: String
  postLiquidityEnableTradingSuccess: Boolean
  addLiquiditySuccess: Boolean
}

SimulateOwnerErrorsType

Errors for a token contract owner.

ownerAddressError
String

No description provided

ownerTokenBalanceError
String

No description provided

ownerEthBalanceError
String

No description provided

"""Errors for a token contract owner."""
type SimulateOwnerErrorsType {
  ownerAddressError: String
  ownerTokenBalanceError: String
  ownerEthBalanceError: String
}

SimulateOwnerType

Result of a token contract owner.

ownerAddress
String

No description provided

ownerTokenBalance
String

No description provided

ownerEthBalance
String

No description provided

"""Result of a token contract owner."""
type SimulateOwnerType {
  ownerAddress: String
  ownerTokenBalance: String
  ownerEthBalance: String
}

SimulateSwapErrorsType

Errors for a token contract swap.

buyError
String

No description provided

buyErrorEnum
SimulateTokenContractBuySellErrorEnum

No description provided

sellError
String

No description provided

sellErrorEnum
SimulateTokenContractBuySellErrorEnum

No description provided

"""Errors for a token contract swap."""
type SimulateSwapErrorsType {
  buyError: String
  buyErrorEnum: SimulateTokenContractBuySellErrorEnum
  sellError: String
  sellErrorEnum: SimulateTokenContractBuySellErrorEnum
}

SimulateSwapType

Result of a token contract swap.

buySuccess
Boolean

No description provided

buyTax
String

No description provided

buyGasUsed
String

No description provided

maxBuyAmount
String

No description provided

sellSuccess
Boolean

No description provided

sellTax
String

No description provided

sellGasUsed
String

No description provided

maxSellAmount
String

No description provided

"""Result of a token contract swap."""
type SimulateSwapType {
  buySuccess: Boolean
  buyTax: String
  buyGasUsed: String
  maxBuyAmount: String
  sellSuccess: Boolean
  sellTax: String
  sellGasUsed: String
  maxSellAmount: String
}

SimulateTokenContractErrors

Errors for a token contract buy/sell.

simulatorError
String

No description provided

tokenErrors
SimulateTokenErrorsType!
required

No description provided

deployErrors
SimulateDeployErrorsType!
required

No description provided

contractBalanceErrors
SimulateContractBalanceErrorsType!
required

No description provided

liquidityErrors
SimulateLiquidityErrorsType!
required

No description provided

transferErrors
SimulateTransferErrorsType!
required

No description provided

swapErrors
SimulateSwapErrorsType!
required

No description provided

ownerErrors
SimulateOwnerErrorsType!
required

No description provided

creatorErrors
SimulateCreatorErrorsType!
required

No description provided

"""Errors for a token contract buy/sell."""
type SimulateTokenContractErrors {
  simulatorError: String
  tokenErrors: SimulateTokenErrorsType!
  deployErrors: SimulateDeployErrorsType!
  contractBalanceErrors: SimulateContractBalanceErrorsType!
  liquidityErrors: SimulateLiquidityErrorsType!
  transferErrors: SimulateTransferErrorsType!
  swapErrors: SimulateSwapErrorsType!
  ownerErrors: SimulateOwnerErrorsType!
  creatorErrors: SimulateCreatorErrorsType!
}

SimulateTokenContractResponse

Response returned by simulateTokenContract.

result
Boolean!
required

No description provided

simulationId
String

No description provided

error
String

No description provided

"""Response returned by `simulateTokenContract`."""
type SimulateTokenContractResponse {
  result: Boolean!
  simulationId: String
  error: String
}

SimulateTokenContractResult

Result of a token contract buy/sell.

id
String!
required

No description provided

sortKey
String!
required

No description provided

contractHashKey
String!
required

No description provided

uuidHashKey
String!
required

No description provided

blockNumber
String!
required

No description provided

networkId
Int!
required

No description provided

analysisType
Int!
required

No description provided

timestamp
Int!
required

No description provided

status
SimulateTokenContractResultStatusEnum!
required

No description provided

errors
SimulateTokenContractErrors!
required

No description provided

uuid
String!
required

No description provided

token
SimulateTokenType!
required

No description provided

deploy
SimulateDeployType!
required

No description provided

contractBalance
SimulateContractBalanceType!
required

No description provided

liquidity
SimulateLiquidityType!
required

No description provided

transfer
SimulateTransferType!
required

No description provided

swap
SimulateSwapType!
required

No description provided

owner
SimulateOwnerType!
required

No description provided

creator
SimulateCreatorType!
required

No description provided

"""Result of a token contract buy/sell."""
type SimulateTokenContractResult {
  id: String!
  sortKey: String!
  contractHashKey: String!
  uuidHashKey: String!
  blockNumber: String!
  networkId: Int!
  analysisType: Int!
  timestamp: Int!
  status: SimulateTokenContractResultStatusEnum!
  errors: SimulateTokenContractErrors!
  uuid: String!
  token: SimulateTokenType!
  deploy: SimulateDeployType!
  contractBalance: SimulateContractBalanceType!
  liquidity: SimulateLiquidityType!
  transfer: SimulateTransferType!
  swap: SimulateSwapType!
  owner: SimulateOwnerType!
  creator: SimulateCreatorType!
}

SimulateTokenErrorsType

Errors for a token contract.

tokenSymbolError
String

No description provided

decimalsError
String

No description provided

tokenNameError
String

No description provided

totalSupplyError
String

No description provided

canTransferOwnershipError
String

No description provided

canRenounceOwnershipError
String

No description provided

"""Errors for a token contract."""
type SimulateTokenErrorsType {
  tokenSymbolError: String
  decimalsError: String
  tokenNameError: String
  totalSupplyError: String
  canTransferOwnershipError: String
  canRenounceOwnershipError: String
}

SimulateTokenType

Result of a token contract.

contractAddress
String!
required

No description provided

tokenSymbol
String

No description provided

decimals
Int

No description provided

tokenName
String

No description provided

totalSupply
String

No description provided

canTransferOwnership
Boolean

No description provided

canRenounceOwnership
Boolean

No description provided

isOwnerRenounced
Boolean

No description provided

"""Result of a token contract."""
type SimulateTokenType {
  contractAddress: String!
  tokenSymbol: String
  decimals: Int
  tokenName: String
  totalSupply: String
  canTransferOwnership: Boolean
  canRenounceOwnership: Boolean
  isOwnerRenounced: Boolean
}

SimulateTransferErrorsType

Errors for a token contract transfer.

tokenContractApprovalError
String

No description provided

tokenTransferredToContractError
String

No description provided

userApprovalError
String

No description provided

"""Errors for a token contract transfer."""
type SimulateTransferErrorsType {
  tokenContractApprovalError: String
  tokenTransferredToContractError: String
  userApprovalError: String
}

SimulateTransferType

Result of a token contract transfer.

tokenContractApprovalSuccess
Boolean

No description provided

tokenTransferredToContractSuccess
Boolean

No description provided

userApprovalSuccess
Boolean

No description provided

"""Result of a token contract transfer."""
type SimulateTransferType {
  tokenContractApprovalSuccess: Boolean
  tokenTransferredToContractSuccess: Boolean
  userApprovalSuccess: Boolean
}

Social links for a token.

bitcointalk
String

No description provided

blog
String

No description provided

coingecko
String

No description provided

coinmarketcap
String

No description provided

discord
String

No description provided

email
String

No description provided

facebook
String

No description provided

github
String

No description provided

instagram
String

No description provided

linkedin
String

No description provided

reddit
String

No description provided

slack
String

No description provided

telegram
String

No description provided

twitch
String

No description provided

twitter
String

No description provided

website
String

No description provided

wechat
String

No description provided

whitepaper
String

No description provided

youtube
String

No description provided

"""Social links for a token."""
type SocialLinks {
  bitcointalk: String
  blog: String
  coingecko: String
  coinmarketcap: String
  discord: String
  email: String
  facebook: String
  github: String
  instagram: String
  linkedin: String
  reddit: String
  slack: String
  telegram: String
  twitch: String
  twitter: String
  website: String
  wechat: String
  whitepaper: String
  youtube: String
}

SparklineValue

A value in a sparkline.

timestamp
Int!
required

No description provided

value
Float!
required

No description provided

"""A value in a sparkline."""
type SparklineValue {
  timestamp: Int!
  value: Float!
}

StringContainsCondition

String contains condition.

contains
[String!]

A list of substrings included within the string.

notContains
[String!]

A list of substrings not included within the string.

"""String contains condition."""
type StringContainsCondition {
  """A list of substrings included within the string."""
  contains: [String!]
  """A list of substrings not included within the string."""
  notContains: [String!]
}

StringEqualsCondition

String equals condition.

eq
String!
required

The string to equal.

"""String equals condition."""
type StringEqualsCondition {
  """The string to equal."""
  eq: String!
}

SwapEventData

Event data for a token swap event.

amount0
String

The amount of token0 involved in the swap. Only applicable for UniswapV3 events.

amount0In
String

The amount of token0 that was sold. Only applicable for UniswapV2 events.

amount0Out
String

The amount of token0 that was bought. Only applicable for UniswapV2 events.

amount1
String

The amount of token1 involved in the swap. Only applicable for UniswapV3 events.

amount1In
String

The amount of token1 that was sold. Only applicable for UniswapV2 events.

amount1Out
String

The amount of token1 that was bought. Only applicable for UniswapV2 events.

amountNonLiquidityToken
String

The amount of quoteToken involved in the swap. For example, if quoteToken is USDC for a USDC/WETH pair, amountNonLiquidityToken would be the amount of USDC involved in the swap.

priceBaseToken
String

The price per quoteToken at the time of the swap in the network’s base token. For example, if quoteToken is USDC for a USDC/WETH pair on ETH network, priceBaseToken would the price of USDC in ETH.

priceBaseTokenTotal
String

The total amount of quoteToken involved in the swap in the network’s base token (amountNonLiquidityToken x priceBaseToken).

priceUsd
String

The price per quoteToken at the time of the swap in USD. For example, if quoteToken is USDC for a USDC/WETH pair on ETH network, priceBaseToken would the price of USDC in USD ($1.00).

priceUsdTotal
String

The total amount of quoteToken involved in the swap in USD (amountNonLiquidityToken x priceUsd).

tick
String

The tick index that the swap occurred in. Only applicable for UniswapV3 events.

type
EventType!
required

The type of token event, Swap.

"""Event data for a token swap event."""
type SwapEventData {
  """The amount of `token0` involved in the swap. Only applicable for UniswapV3 events."""
  amount0: String
  """The amount of `token0` that was sold. Only applicable for UniswapV2 events."""
  amount0In: String
  """The amount of `token0` that was bought. Only applicable for UniswapV2 events."""
  amount0Out: String
  """The amount of `token1` involved in the swap. Only applicable for UniswapV3 events."""
  amount1: String
  """The amount of `token1` that was sold. Only applicable for UniswapV2 events."""
  amount1In: String
  """The amount of `token1` that was bought. Only applicable for UniswapV2 events."""
  amount1Out: String
  """The amount of `quoteToken` involved in the swap. For example, if `quoteToken` is USDC for a USDC/WETH pair, `amountNonLiquidityToken` would be the amount of USDC involved in the swap."""
  amountNonLiquidityToken: String
  """The price per `quoteToken` at the time of the swap in the network's base token. For example, if `quoteToken` is USDC for a USDC/WETH pair on ETH network, `priceBaseToken` would the price of USDC in ETH."""
  priceBaseToken: String
  """The total amount of `quoteToken` involved in the swap in the network's base token (`amountNonLiquidityToken` x `priceBaseToken`)."""
  priceBaseTokenTotal: String
  """The price per `quoteToken` at the time of the swap in USD. For example, if `quoteToken` is USDC for a USDC/WETH pair on ETH network, `priceBaseToken` would the price of USDC in USD ($1.00)."""
  priceUsd: String
  """The total amount of `quoteToken` involved in the swap in USD (`amountNonLiquidityToken` x `priceUsd`)."""
  priceUsdTotal: String
  """The tick index that the swap occurred in. Only applicable for UniswapV3 events."""
  tick: String
  """The type of token event, `Swap`."""
  type: EventType!
}

SwapNftInPoolEventData

Event data for swapping an NFT into a pool.

type
NftPoolEventType!
required

The type of NFT pool event, SWAP_NFT_IN_POOL.

tokenId
String!
required

The ID of the token involved in the swap (address:networkId).

newDelta
String!
required

The updated delta used in the bonding curve.

poolFeeT
String!
required

The fee for the pool in the pool’s liquidity token.

protocolFeeT
String!
required

The protocol fee in the pool’s liquidity token.

nftsTransfered
[NftPoolEventNftTransfer]

Metadata for each of the NFTs involved in the swap.

newSpotPriceT
String!
required

The updated spot price in the pool’s liquidity token.

newSellPriceT
String!
required

The updated price at which the pool is willing to sell an NFT in the pool’s liquidity token.

newBuyPriceT
String!
required

The updated price at which the pool is willing to buy an NFT in the pool’s liquidity token.

amountT
String!
required

The total value of all NFTs involved in the swap in the pool’s liquidity token.

nftTokenBalance
String!
required

The number of NFTs in the contract after the block has processed.

tokenBalanceT
String!
required

The amount of token in the contract after the block has processed in the pool’s liquidity token.

nbtRatio
String!
required

The ratio of the transaction token to the network’s base token.

usdRatio
String!
required

The ratio of the transaction token to USD.

"""Event data for swapping an NFT into a pool."""
type SwapNftInPoolEventData {
  """The type of NFT pool event, `SWAP_NFT_IN_POOL`."""
  type: NftPoolEventType!
  """The ID of the token involved in the swap (`address`:`networkId`)."""
  tokenId: String!
  """The updated delta used in the bonding curve."""
  newDelta: String!
  """The fee for the pool in the pool's liquidity token."""
  poolFeeT: String!
  """The protocol fee in the pool's liquidity token."""
  protocolFeeT: String!
  """Metadata for each of the NFTs involved in the swap."""
  nftsTransfered: [NftPoolEventNftTransfer]
  """The updated spot price in the pool's liquidity token."""
  newSpotPriceT: String!
  """The updated price at which the pool is willing to sell an NFT in the pool's liquidity token."""
  newSellPriceT: String!
  """The updated price at which the pool is willing to buy an NFT in the pool's liquidity token."""
  newBuyPriceT: String!
  """The total value of all NFTs involved in the swap in the pool's liquidity token."""
  amountT: String!
  """The number of NFTs in the contract after the block has processed."""
  nftTokenBalance: String!
  """The amount of token in the contract after the block has processed in the pool's liquidity token."""
  tokenBalanceT: String!
  """The ratio of the transaction token to the network's base token."""
  nbtRatio: String!
  """The ratio of the transaction token to USD."""
  usdRatio: String!
}

SwapNftInPoolEventDataV2

Event data for swapping an NFT into a pool.

type
NftPoolEventType!
required

The type of NFT pool event, SWAP_NFT_IN_POOL.

tokenId
String!
required

The ID of the token involved in the swap (address:networkId).

newDelta
String!
required

The updated delta used in the bonding curve.

poolFeeT
String!
required

The fee for the pool in the pool’s liquidity token.

protocolFeeT
String!
required

The protocol fee in the pool’s liquidity token.

nftsTransfered
[NftPoolEventNftTransferV2]

Metadata for each of the NFTs involved in the swap.

nftAssets
[NftAsset]

New Param: The list of NFT assets withdrawn. More extensive info than nftTokenIds.

newSpotPriceT
String!
required

The updated spot price in the pool’s liquidity token.

newSellPriceT
String!
required

The updated price at which the pool is willing to sell an NFT in the pool’s liquidity token.

newBuyPriceT
String!
required

The updated price at which the pool is willing to buy an NFT in the pool’s liquidity token.

amountT
String!
required

The total value of all NFTs involved in the swap in the pool’s liquidity token.

tokenBalanceT
String!
required

The amount of token in the contract after the block has processed in the pool’s liquidity token.

nbtRatio
String!
required

The ratio of the transaction token to the network’s base token.

usdRatio
String!
required

The ratio of the transaction token to USD.

"""Event data for swapping an NFT into a pool."""
type SwapNftInPoolEventDataV2 {
  """The type of NFT pool event, `SWAP_NFT_IN_POOL`."""
  type: NftPoolEventType!
  """The ID of the token involved in the swap (`address`:`networkId`)."""
  tokenId: String!
  """The updated delta used in the bonding curve."""
  newDelta: String!
  """The fee for the pool in the pool's liquidity token."""
  poolFeeT: String!
  """The protocol fee in the pool's liquidity token."""
  protocolFeeT: String!
  """Metadata for each of the NFTs involved in the swap."""
  nftsTransfered: [NftPoolEventNftTransferV2]
  """*New Param*: The list of NFT assets withdrawn. More extensive info than nftTokenIds."""
  nftAssets: [NftAsset]
  """The updated spot price in the pool's liquidity token."""
  newSpotPriceT: String!
  """The updated price at which the pool is willing to sell an NFT in the pool's liquidity token."""
  newSellPriceT: String!
  """The updated price at which the pool is willing to buy an NFT in the pool's liquidity token."""
  newBuyPriceT: String!
  """The total value of all NFTs involved in the swap in the pool's liquidity token."""
  amountT: String!
  """The amount of token in the contract after the block has processed in the pool's liquidity token."""
  tokenBalanceT: String!
  """The ratio of the transaction token to the network's base token."""
  nbtRatio: String!
  """The ratio of the transaction token to USD."""
  usdRatio: String!
}

SwapNftOutPoolEventData

Event data for swapping an NFT out of a pool.

type
NftPoolEventType!
required

The type of NFT pool event, SWAP_NFT_OUT_POOL.

tokenId
String!
required

The ID of the token involved in the swap (address:networkId).

newDelta
String!
required

The updated delta used in the bonding curve.

poolFeeT
String!
required

The fee for the pool in the pool’s liquidity token.

protocolFeeT
String!
required

The protocol fee in the pool’s liquidity token.

nftsTransfered
[NftPoolEventNftTransfer]

Metadata for each of the NFTs involved in the swap.

newSpotPriceT
String!
required

The updated spot price in the pool’s liquidity token.

newSellPriceT
String!
required

The updated price at which the pool is willing to sell an NFT in the pool’s liquidity token.

newBuyPriceT
String!
required

The updated price at which the pool is willing to buy an NFT in the pool’s liquidity token.

amountT
String!
required

The total value of all NFTs involved in the swap in the pool’s liquidity token.

nftTokenBalance
String!
required

The number of NFTs in the contract after the block has processed.

tokenBalanceT
String!
required

The amount of token in the contract after the block has processed in the pool’s liquidity token.

nbtRatio
String!
required

The ratio of the transaction token to the network’s base token.

usdRatio
String!
required

The ratio of the transaction token to USD.

"""Event data for swapping an NFT out of a pool."""
type SwapNftOutPoolEventData {
  """The type of NFT pool event, `SWAP_NFT_OUT_POOL`."""
  type: NftPoolEventType!
  """The ID of the token involved in the swap (`address`:`networkId`)."""
  tokenId: String!
  """The updated delta used in the bonding curve."""
  newDelta: String!
  """The fee for the pool in the pool's liquidity token."""
  poolFeeT: String!
  """The protocol fee in the pool's liquidity token."""
  protocolFeeT: String!
  """Metadata for each of the NFTs involved in the swap."""
  nftsTransfered: [NftPoolEventNftTransfer]
  """The updated spot price in the pool's liquidity token."""
  newSpotPriceT: String!
  """The updated price at which the pool is willing to sell an NFT in the pool's liquidity token."""
  newSellPriceT: String!
  """The updated price at which the pool is willing to buy an NFT in the pool's liquidity token."""
  newBuyPriceT: String!
  """The total value of all NFTs involved in the swap in the pool's liquidity token."""
  amountT: String!
  """The number of NFTs in the contract after the block has processed."""
  nftTokenBalance: String!
  """The amount of token in the contract after the block has processed in the pool's liquidity token."""
  tokenBalanceT: String!
  """The ratio of the transaction token to the network's base token."""
  nbtRatio: String!
  """The ratio of the transaction token to USD."""
  usdRatio: String!
}

SwapNftOutPoolEventDataV2

Event data for swapping an NFT out of a pool.

type
NftPoolEventType!
required

The type of NFT pool event, SWAP_NFT_OUT_POOL.

tokenId
String!
required

The ID of the token involved in the swap (address:networkId).

newDelta
String!
required

The updated delta used in the bonding curve.

poolFeeT
String!
required

The fee for the pool in the pool’s liquidity token.

protocolFeeT
String!
required

The protocol fee in the pool’s liquidity token.

nftsTransfered
[NftPoolEventNftTransferV2]

Metadata for each of the NFTs involved in the swap.

nftAssets
[NftAsset]

New Param: The list of NFT assets withdrawn. More extensive info than nftTokenIds.

newSpotPriceT
String!
required

The updated spot price in the pool’s liquidity token.

newSellPriceT
String!
required

The updated price at which the pool is willing to sell an NFT in the pool’s liquidity token.

newBuyPriceT
String!
required

The updated price at which the pool is willing to buy an NFT in the pool’s liquidity token.

amountT
String!
required

The total value of all NFTs involved in the swap in the pool’s liquidity token.

tokenBalanceT
String!
required

The amount of token in the contract after the block has processed in the pool’s liquidity token.

nbtRatio
String!
required

The ratio of the transaction token to the network’s base token.

usdRatio
String!
required

The ratio of the transaction token to USD.

"""Event data for swapping an NFT out of a pool."""
type SwapNftOutPoolEventDataV2 {
  """The type of NFT pool event, `SWAP_NFT_OUT_POOL`."""
  type: NftPoolEventType!
  """The ID of the token involved in the swap (`address`:`networkId`)."""
  tokenId: String!
  """The updated delta used in the bonding curve."""
  newDelta: String!
  """The fee for the pool in the pool's liquidity token."""
  poolFeeT: String!
  """The protocol fee in the pool's liquidity token."""
  protocolFeeT: String!
  """Metadata for each of the NFTs involved in the swap."""
  nftsTransfered: [NftPoolEventNftTransferV2]
  """*New Param*: The list of NFT assets withdrawn. More extensive info than nftTokenIds."""
  nftAssets: [NftAsset]
  """The updated spot price in the pool's liquidity token."""
  newSpotPriceT: String!
  """The updated price at which the pool is willing to sell an NFT in the pool's liquidity token."""
  newSellPriceT: String!
  """The updated price at which the pool is willing to buy an NFT in the pool's liquidity token."""
  newBuyPriceT: String!
  """The total value of all NFTs involved in the swap in the pool's liquidity token."""
  amountT: String!
  """The amount of token in the contract after the block has processed in the pool's liquidity token."""
  tokenBalanceT: String!
  """The ratio of the transaction token to the network's base token."""
  nbtRatio: String!
  """The ratio of the transaction token to USD."""
  usdRatio: String!
}

SymbolResponse

Response returned by getSymbol.

currency_code
String!
required

The currencyCode argument passed in (TOKEN or USD).

description
String!
required

The trading pair. If currencyCode is TOKEN, the base token will be used, otherwise USD.

name
String!
required

The symbols of the pair.

original_currency_code
String!
required

The base token symbol.

pricescale
Float!
required

10^n, where n is the number of decimal places the price has. Max 16. Used for charting.

ticker
String!
required

The ID of the pair (address:networkId).

supported_resolutions
[String!]!
required

The list of time frames supported for the symbol in other charting endpoints, eg. getBars.

"""Response returned by `getSymbol`."""
type SymbolResponse {
  """The currencyCode argument passed in (`TOKEN` or `USD`)."""
  currency_code: String!
  """The trading pair. If currencyCode is TOKEN, the base token will be used, otherwise USD."""
  description: String!
  """The symbols of the pair."""
  name: String!
  """The base token symbol."""
  original_currency_code: String!
  """10^n, where n is the number of decimal places the price has. Max 16. Used for charting."""
  pricescale: Float!
  """The ID of the pair (`address:networkId`)."""
  ticker: String!
  """The list of time frames supported for the symbol in other charting endpoints, eg. getBars."""
  supported_resolutions: [String!]!
}

TokenBurnEventData

Token burn event data.

amount
String!
required

The amount of tokens burned.

totalSupply
String

The new total supply for the token.

circulatingSupply
String

The new circulating supply for the token.

"""Token burn event data."""
type TokenBurnEventData {
  """The amount of tokens burned."""
  amount: String!
  """The new total supply for the token."""
  totalSupply: String
  """The new circulating supply for the token."""
  circulatingSupply: String
}

TokenFilterConnection

Response returned by filterTokens.

results
[TokenFilterResult]

The list of tokens matching the filter parameters.

count
Int

The number of tokens returned.

page
Int

Where in the list the server started when returning items.

"""Response returned by `filterTokens`."""
type TokenFilterConnection {
  """The list of tokens matching the filter parameters."""
  results: [TokenFilterResult]
  """The number of tokens returned."""
  count: Int
  """Where in the list the server started when returning items."""
  page: Int
}

TokenFilterResult

A token matching a set of filter parameters.

createdAt
Int

The unix timestamp for the creation of the token’s first pair.

lastTransaction
Int

The unix timestamp for the token’s last transaction.

age
Int

No description provided

This field is deprecated. Age isn’t supported - use createdAt instead

buyCount5m
Int

The number of buys in the past 5 minutes.

buyCount1
Int

The number of buys in the past hour.

buyCount12
Int

The number of buys in the past 12 hours.

buyCount24
Int

The number of buys in the past 24 hours.

buyCount4
Int

The number of buys in the past 4 hours.

change5m
String

The percent price change in the past 5 minutes. Decimal format.

change1
String

The percent price change in the past hour. Decimal format.

change12
String

The percent price change in the past 12 hours. Decimal format.

change24
String

The percent price change in the past 24 hours. Decimal format.

change4
String

The percent price change in the past 4 hours. Decimal format.

volumeChange5m
String

The percent volume change in the past 5 minutes. Decimal format.

volumeChange1
String

The percent volume change in the past hour. Decimal format.

volumeChange4
String

The percent volume change in the past 4 hours. Decimal format.

volumeChange12
String

The percent volume change in the past 12 hours. Decimal format.

volumeChange24
String

The percent volume change in the past 24 hours. Decimal format.

exchanges
[Exchange]

The exchanges the token is listed on.

fdv
String

No description provided

This field is deprecated. FDV isn’t supported - use marketCap instead

high5m
String

The highest price in USD in the past 5 minutes.

high1
String

The highest price in USD in the past hour.

high12
String

The highest price in USD in the past 12 hours.

high24
String

The highest price in USD in the past 24 hours.

high4
String

The highest price in USD in the past 4 hours.

liquidity
String

Amount of liquidity in the token’s top pair.

quoteToken
String

The token of interest. Can be token0 or token1.

low5m
String

The lowest price in USD in the past 5 minutes.

low1
String

The lowest price in USD in the past hour.

low12
String

The lowest price in USD in the past 12 hours.

low24
String

The lowest price in USD in the past 24 hours.

low4
String

The lowest price in USD in the past 4 hours.

marketCap
String

The fully diluted market cap.

circulatingMarketCap
String

The circulating market cap.

pair
Pair

Metadata for the token’s top pair.

priceUSD
String

The token price in USD.

sellCount5m
Int

The number of sells in the past 5 minutes.

sellCount1
Int

The number of sells in the past hour.

sellCount12
Int

The number of sells in the past 12 hours.

sellCount24
Int

The number of sells in the past 24 hours.

sellCount4
Int

The number of sells in the past 4 hours.

token
EnhancedToken

Metadata for the token.

txnCount5m
Int

The number of transactions in the past 5 minutes.

txnCount1
Int

The number of transactions in the past hour.

txnCount12
Int

The number of transactions in the past 12 hours.

txnCount24
Int

The number of transactions in the past 24 hours.

txnCount4
Int

The number of transactions in the past 4 hours.

uniqueBuys5m
Int

The unique number of buys in the past 5 minutes.

uniqueBuys1
Int

The unique number of buys in the past hour.

uniqueBuys12
Int

The unique number of buys in the past 12 hours.

uniqueBuys24
Int

The unique number of buys in the past 24 hours.

uniqueBuys4
Int

The unique number of buys in the past 4 hours.

uniqueSells5m
Int

The unique number of sells in the past 5 minutes.

uniqueSells1
Int

The unique number of sells in the past hour.

uniqueSells12
Int

The unique number of sells in the past 12 hours.

uniqueSells24
Int

The unique number of sells in the past 24 hours.

uniqueSells4
Int

The unique number of sells in the past 4 hours.

uniqueTransactions5m
Int

The unique number of transactions in the past 5 minutes.

uniqueTransactions1
Int

The unique number of transactions in the past hour.

uniqueTransactions12
Int

The unique number of transactions in the past 12 hours.

uniqueTransactions24
Int

The unique number of transactions in the past 24 hours.

uniqueTransactions4
Int

The unique number of transactions in the past 4 hours.

volume1
String

The trade volume in USD in the past hour.

volume5m
String

The trade volume in USD in the past 5 minutes.

volume12
String

The trade volume in USD in the past 12 hours.

volume24
String

The trade volume in USD in the past 24 hours.

volume4
String

The trade volume in USD in the past 4 hours.

buyVolume1
String

The buy volume in USD in the past hour.

buyVolume12
String

The buy volume in USD in the past 12 hours.

buyVolume24
String

The buy volume in USD in the past 24 hours.

buyVolume4
String

The buy volume in USD in the past 4 hours.

buyVolume5m
String

The buy volume in USD in the past 5 minutes.

sellVolume1
String

The sell volume in USD in the past hour.

sellVolume12
String

The sell volume in USD in the past 12 hours.

sellVolume24
String

The sell volume in USD in the past 24 hours.

sellVolume4
String

The sell volume in USD in the past 4 hours.

sellVolume5m
String

The sell volume in USD in the past 5 minutes.

isScam
Boolean

Whether the token has been flagged as a scam.

holders
Int

The number of different wallets holding the token.

walletAgeAvg
String

The average age of the wallets that traded in the last 24h

walletAgeStd
String

The standard deviation of age of the wallets that traded in the last 24h

swapPct1dOldWallet
String

The percentage of wallets that are less than 1d old that have traded in the last 24h

swapPct7dOldWallet
String

The percentage of wallets that are less than 7d old that have traded in the last 24h

"""A token matching a set of filter parameters."""
type TokenFilterResult {
  """The unix timestamp for the creation of the token's first pair."""
  createdAt: Int
  """The unix timestamp for the token's last transaction."""
  lastTransaction: Int
  age: Int @deprecated(reason: "Age isn't supported - use createdAt instead")
  """The number of buys in the past 5 minutes."""
  buyCount5m: Int
  """The number of buys in the past hour."""
  buyCount1: Int
  """The number of buys in the past 12 hours."""
  buyCount12: Int
  """The number of buys in the past 24 hours."""
  buyCount24: Int
  """The number of buys in the past 4 hours."""
  buyCount4: Int
  """The percent price change in the past 5 minutes. Decimal format."""
  change5m: String
  """The percent price change in the past hour. Decimal format."""
  change1: String
  """The percent price change in the past 12 hours. Decimal format."""
  change12: String
  """The percent price change in the past 24 hours. Decimal format."""
  change24: String
  """The percent price change in the past 4 hours. Decimal format."""
  change4: String
  """The percent volume change in the past 5 minutes. Decimal format."""
  volumeChange5m: String
  """The percent volume change in the past hour. Decimal format."""
  volumeChange1: String
  """The percent volume change in the past 4 hours. Decimal format."""
  volumeChange4: String
  """The percent volume change in the past 12 hours. Decimal format."""
  volumeChange12: String
  """The percent volume change in the past 24 hours. Decimal format."""
  volumeChange24: String
  """The exchanges the token is listed on."""
  exchanges: [Exchange]
  fdv: String @deprecated(reason: "FDV isn't supported - use marketCap instead")
  """The highest price in USD in the past 5 minutes."""
  high5m: String
  """The highest price in USD in the past hour."""
  high1: String
  """The highest price in USD in the past 12 hours."""
  high12: String
  """The highest price in USD in the past 24 hours."""
  high24: String
  """The highest price in USD in the past 4 hours."""
  high4: String
  """Amount of liquidity in the token's top pair."""
  liquidity: String
  """The token of interest. Can be `token0` or `token1`."""
  quoteToken: String
  """The lowest price in USD in the past 5 minutes."""
  low5m: String
  """The lowest price in USD in the past hour."""
  low1: String
  """The lowest price in USD in the past 12 hours."""
  low12: String
  """The lowest price in USD in the past 24 hours."""
  low24: String
  """The lowest price in USD in the past 4 hours."""
  low4: String
  """The fully diluted market cap."""
  marketCap: String
  """The circulating market cap."""
  circulatingMarketCap: String
  """Metadata for the token's top pair."""
  pair: Pair
  """The token price in USD."""
  priceUSD: String
  """The number of sells in the past 5 minutes."""
  sellCount5m: Int
  """The number of sells in the past hour."""
  sellCount1: Int
  """The number of sells in the past 12 hours."""
  sellCount12: Int
  """The number of sells in the past 24 hours."""
  sellCount24: Int
  """The number of sells in the past 4 hours."""
  sellCount4: Int
  """Metadata for the token."""
  token: EnhancedToken
  """The number of transactions in the past 5 minutes."""
  txnCount5m: Int
  """The number of transactions in the past hour."""
  txnCount1: Int
  """The number of transactions in the past 12 hours."""
  txnCount12: Int
  """The number of transactions in the past 24 hours."""
  txnCount24: Int
  """The number of transactions in the past 4 hours."""
  txnCount4: Int
  """The unique number of buys in the past 5 minutes."""
  uniqueBuys5m: Int
  """The unique number of buys in the past hour."""
  uniqueBuys1: Int
  """The unique number of buys in the past 12 hours."""
  uniqueBuys12: Int
  """The unique number of buys in the past 24 hours."""
  uniqueBuys24: Int
  """The unique number of buys in the past 4 hours."""
  uniqueBuys4: Int
  """The unique number of sells in the past 5 minutes."""
  uniqueSells5m: Int
  """The unique number of sells in the past hour."""
  uniqueSells1: Int
  """The unique number of sells in the past 12 hours."""
  uniqueSells12: Int
  """The unique number of sells in the past 24 hours."""
  uniqueSells24: Int
  """The unique number of sells in the past 4 hours."""
  uniqueSells4: Int
  """The unique number of transactions in the past 5 minutes."""
  uniqueTransactions5m: Int
  """The unique number of transactions in the past hour."""
  uniqueTransactions1: Int
  """The unique number of transactions in the past 12 hours."""
  uniqueTransactions12: Int
  """The unique number of transactions in the past 24 hours."""
  uniqueTransactions24: Int
  """The unique number of transactions in the past 4 hours."""
  uniqueTransactions4: Int
  """The trade volume in USD in the past hour."""
  volume1: String
  """The trade volume in USD in the past 5 minutes."""
  volume5m: String
  """The trade volume in USD in the past 12 hours."""
  volume12: String
  """The trade volume in USD in the past 24 hours."""
  volume24: String
  """The trade volume in USD in the past 4 hours."""
  volume4: String
  """The buy volume in USD in the past hour."""
  buyVolume1: String
  """The buy volume in USD in the past 12 hours."""
  buyVolume12: String
  """The buy volume in USD in the past 24 hours."""
  buyVolume24: String
  """The buy volume in USD in the past 4 hours."""
  buyVolume4: String
  """The buy volume in USD in the past 5 minutes."""
  buyVolume5m: String
  """The sell volume in USD in the past hour."""
  sellVolume1: String
  """The sell volume in USD in the past 12 hours."""
  sellVolume12: String
  """The sell volume in USD in the past 24 hours."""
  sellVolume24: String
  """The sell volume in USD in the past 4 hours."""
  sellVolume4: String
  """The sell volume in USD in the past 5 minutes."""
  sellVolume5m: String
  """Whether the token has been flagged as a scam."""
  isScam: Boolean
  """The number of different wallets holding the token."""
  holders: Int
  """The average age of the wallets that traded in the last 24h"""
  walletAgeAvg: String
  """The standard deviation of age of the wallets that traded in the last 24h"""
  walletAgeStd: String
  """The percentage of wallets that are less than 1d old that have traded in the last 24h"""
  swapPct1dOldWallet: String
  """The percentage of wallets that are less than 7d old that have traded in the last 24h"""
  swapPct7dOldWallet: String
}

TokenInfo

Metadata for a token.

id
String!
required

Uniquely identifies the token.

address
String!
required

The contract address of the token.

circulatingSupply
String

The circulating supply of the token.

cmcId
Int

The token ID on CoinMarketCap.

isScam
Boolean

Whether the token has been flagged as a scam.

name
String

The token name. For example, ApeCoin.

networkId
Int!
required

The network ID the token is deployed on.

symbol
String!
required

The token symbol. For example, APE.

totalSupply
String

The total supply of the token.

imageThumbUrl
String

The thumbnail token logo URL.

imageSmallUrl
String

The small token logo URL.

imageLargeUrl
String

The large token logo URL.

imageBannerUrl
String

The token banner URL.

description
String

A description of the token.

"""Metadata for a token."""
type TokenInfo {
  """Uniquely identifies the token."""
  id: String!
  """The contract address of the token."""
  address: String!
  """The circulating supply of the token."""
  circulatingSupply: String
  """The token ID on CoinMarketCap."""
  cmcId: Int
  """Whether the token has been flagged as a scam."""
  isScam: Boolean
  """The token name. For example, `ApeCoin`."""
  name: String
  """The network ID the token is deployed on."""
  networkId: Int!
  """The token symbol. For example, `APE`."""
  symbol: String!
  """The total supply of the token."""
  totalSupply: String
  """The thumbnail token logo URL."""
  imageThumbUrl: String
  """The small token logo URL."""
  imageSmallUrl: String
  """The large token logo URL."""
  imageLargeUrl: String
  """The token banner URL."""
  imageBannerUrl: String
  """A description of the token."""
  description: String
}

TokenLifecycleEvent

Events that occur during a token’s lifecycle. Only Mint and Burn events right now.

tokenAddress
String!
required

The token’s contract address.

networkId
Int!
required

The network ID that the token is deployed on.

blockHash
String!
required

The hash of the block where the transaction occurred.

blockNumber
Int!
required

The block number for the transaction.

id
String!
required

The ID of the event (address:networkId). For example, 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2:1.

logIndex
Int!
required

The index of the log in the block.

maker
String

The wallet address that performed the transaction.

timestamp
Int!
required

The unix timestamp for when the transaction occurred.

transactionHash
String!
required

The unique hash for the transaction.

transactionIndex
Int!
required

The index of the transaction within the block.

eventType
TokenLifecycleEventType!
required

The type of event.

data
TokenLifecycleEventData!
required

The event data, depends on the type of event

"""Events that occur during a token's lifecycle. Only Mint and Burn events right now."""
type TokenLifecycleEvent {
  """The token's contract address."""
  tokenAddress: String!
  """The network ID that the token is deployed on."""
  networkId: Int!
  """The hash of the block where the transaction occurred."""
  blockHash: String!
  """The block number for the transaction."""
  blockNumber: Int!
  """The ID of the event (`address:networkId`). For example, `0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2:1`."""
  id: String!
  """The index of the log in the block."""
  logIndex: Int!
  """The wallet address that performed the transaction."""
  maker: String
  """The unix timestamp for when the transaction occurred."""
  timestamp: Int!
  """The unique hash for the transaction."""
  transactionHash: String!
  """The index of the transaction within the block."""
  transactionIndex: Int!
  """The type of event."""
  eventType: TokenLifecycleEventType!
  """The event data, depends on the type of event"""
  data: TokenLifecycleEventData!
}

TokenLifecycleEventConnection

Response returned by tokenLifecycleEvents.

items
[TokenLifecycleEvent]!
required

A list of transactions for a token’s top pair.

cursor
String

A cursor for use in pagination.

"""Response returned by `tokenLifecycleEvents`."""
type TokenLifecycleEventConnection {
  """A list of transactions for a token's top pair."""
  items: [TokenLifecycleEvent]!
  """A cursor for use in pagination."""
  cursor: String
}

TokenMintEventData

Token mint event data.

amount
String!
required

The amount of tokens minted.

totalSupply
String

The new total supply for the token.

circulatingSupply
String

The new circulating supply for the token.

"""Token mint event data."""
type TokenMintEventData {
  """The amount of tokens minted."""
  amount: String!
  """The new total supply for the token."""
  totalSupply: String
  """The new circulating supply for the token."""
  circulatingSupply: String
}

TokenPairEventTypeCondition

Webhook condition for token pair event type.

oneOf
[TokenPairEventType!]!
required

The list of token pair event types.

"""Webhook condition for token pair event type."""
type TokenPairEventTypeCondition {
  """The list of token pair event types."""
  oneOf: [TokenPairEventType!]!
}

TokenPairEventWebhookCondition

Webhook conditions for a token pair event.

tokenAddress
StringEqualsCondition

The token contract address the webhook is listening for.

networkId
OneOfNumberCondition

The list of network IDs the webhook is listening on.

swapValue
ComparisonOperator

The swap values the webhook is listening for.

maker
StringEqualsCondition

The maker wallet address the webhook is listening for.

pairAddress
StringEqualsCondition

The pair contract address the webhook is listening for.

exchangeAddress
StringEqualsCondition

The exchange contract address the webhook is listening for.

eventType
TokenPairEventTypeCondition

The event type the webhook is listening for.

"""Webhook conditions for a token pair event."""
type TokenPairEventWebhookCondition {
  """The token contract address the webhook is listening for."""
  tokenAddress: StringEqualsCondition
  """The list of network IDs the webhook is listening on."""
  networkId: OneOfNumberCondition
  """The swap values the webhook is listening for."""
  swapValue: ComparisonOperator
  """The maker wallet address the webhook is listening for."""
  maker: StringEqualsCondition
  """The pair contract address the webhook is listening for."""
  pairAddress: StringEqualsCondition
  """The exchange contract address the webhook is listening for."""
  exchangeAddress: StringEqualsCondition
  """The event type the webhook is listening for."""
  eventType: TokenPairEventTypeCondition
}

TokenSearchResponse

Response returned by searchTokens.

hasMore
Int

The number of additional high volume results found. Only used if lowVolumeFilter is set to true.

hasMoreLowVolume
Int

If lowVolumeFilter is set to true, the number of additional low volume results found. If lowVolumeFilter is set to false, the number of additional high and low volume results found.

tokens
[TokenWithMetadata!]

A list of tokens.

"""Response returned by `searchTokens`."""
type TokenSearchResponse {
  """The number of additional high volume results found. Only used if `lowVolumeFilter` is set to `true`."""
  hasMore: Int
  """If `lowVolumeFilter` is set to `true`, the number of additional low volume results found. If `lowVolumeFilter` is set to `false`, the number of additional high and low volume results found."""
  hasMoreLowVolume: Int
  """A list of tokens."""
  tokens: [TokenWithMetadata!]
}

TokenSparkline

A sparkline for a token.

id
String!
required

The token id

attribute
SparklineAttribute

Which attribute the sparkline is charting. Defaults to PRICE

sparkline
[SparklineValue!]!
required

List of sparkline values to chart

"""A sparkline for a token."""
type TokenSparkline {
  """The token id"""
  id: String!
  """Which attribute the sparkline is charting. Defaults to `PRICE`"""
  attribute: SparklineAttribute
  """List of sparkline values to chart"""
  sparkline: [SparklineValue!]!
}

TokenTopTrader

A top trader for a token.

walletAddress
String!
required

The wallet address of the trader.

tokenAddress
String!
required

The token address.

networkId
Int!
required

The network ID.

tokenAmountBought
String!
required

The amount of tokens bought.

tokenAmountSold
String!
required

The amount of tokens sold.

amountBoughtUsd
String!
required

The amount of tokens bought in USD.

amountSoldUsd
String!
required

The amount of tokens sold in USD.

volumeUsd
String!
required

The volume of tokens bought and sold in USD.

realizedProfitUsd
String!
required

The realized profit in USD.

realizedProfitPercentage
Float!
required

The realized profit percentage.

singleTokenAcquisitionCostUsd
String!
required

The single token acquisition cost in USD.

buys
Int!
required

The number of buys.

sells
Int!
required

The number of sells.

tokenBalance
String!
required

The token balance of the trader.

firstTransactionAt
Int

The unix timestamp for the first transaction from this wallet.

lastTransactionAt
Int!
required

The unix timestamp for the last transaction from this wallet.

"""A top trader for a token."""
type TokenTopTrader {
  """The wallet address of the trader."""
  walletAddress: String!
  """The token address."""
  tokenAddress: String!
  """The network ID."""
  networkId: Int!
  """The amount of tokens bought."""
  tokenAmountBought: String!
  """The amount of tokens sold."""
  tokenAmountSold: String!
  """The amount of tokens bought in USD."""
  amountBoughtUsd: String!
  """The amount of tokens sold in USD."""
  amountSoldUsd: String!
  """The volume of tokens bought and sold in USD."""
  volumeUsd: String!
  """The realized profit in USD."""
  realizedProfitUsd: String!
  """The realized profit percentage."""
  realizedProfitPercentage: Float!
  """The single token acquisition cost in USD."""
  singleTokenAcquisitionCostUsd: String!
  """The number of buys."""
  buys: Int!
  """The number of sells."""
  sells: Int!
  """The token balance of the trader."""
  tokenBalance: String!
  """The unix timestamp for the first transaction from this wallet."""
  firstTransactionAt: Int
  """The unix timestamp for the last transaction from this wallet."""
  lastTransactionAt: Int!
}

TokenTopTradersConnection

A paginated list of top traders for a token.

tokenAddress
String!
required

The token address.

networkId
Int!
required

The network ID.

tradingPeriod
TradingPeriod!
required

The trading period.

items
[TokenTopTrader]!
required

The list of top traders.

offset
Int

The offset of the first trader in the connection.

"""A paginated list of top traders for a token."""
type TokenTopTradersConnection {
  """The token address."""
  tokenAddress: String!
  """The network ID."""
  networkId: Int!
  """The trading period."""
  tradingPeriod: TradingPeriod!
  """The list of top traders."""
  items: [TokenTopTrader]!
  """The offset of the first trader in the connection."""
  offset: Int
}

TokenWalletFilterConnection

A connection of wallets matching a filter on a specific token.

results
[TokenWalletFilterResult!]!
required

The list of wallets matching the filter parameters.

count
Int!
required

The number of wallets returned.

offset
Int!
required

Where in the list the server started when returning items.

"""A connection of wallets matching a filter on a specific token."""
type TokenWalletFilterConnection {
  """The list of wallets matching the filter parameters."""
  results: [TokenWalletFilterResult!]!
  """The number of wallets returned."""
  count: Int!
  """Where in the list the server started when returning items."""
  offset: Int!
}

TokenWalletFilterResult

The result for filtering wallets for a token.

address
String!
required

The wallet address

tokenAddress
String!
required

The token address

networkId
Int!
required

The network ID

firstTransactionAt
Int

The unix timestamp for the first transaction from this wallet

lastTransactionAt
Int!
required

The unix timestamp for the last transaction from this wallet

labels
[String!]!
required

The labels associated with the wallet

tokenAmountBought1d
String!
required

Token amount bought in the past day

tokenAmountSold1d
String!
required

Token amount sold in the past day

tokenAmountSoldAll1d
String!
required

Token amount sold all in the past day

amountBoughtUsd1d
String!
required

Amount bought in USD in the past day

amountSoldUsd1d
String!
required

Amount sold in USD in the past day

amountSoldUsdAll1d
String!
required

Amount sold USD all in the past day

realizedProfitUsd1d
String!
required

Realized profit in USD in the past day

realizedProfitPercentage1d
Float!
required

Realized profit percentage in the past day

buys1d
Int!
required

Number of buys in the past day

sells1d
Int!
required

Number of sells in the past day

sellsAll1d
Int!
required

Number of sells all in the past day

tokenAmountBought1w
String!
required

Token amount bought in the past week

tokenAmountSold1w
String!
required

Token amount sold in the past week

tokenAmountSoldAll1w
String!
required

Token amount sold all in the past week

amountBoughtUsd1w
String!
required

Amount bought in USD in the past week

amountSoldUsd1w
String!
required

Amount sold in USD in the past week

amountSoldUsdAll1w
String!
required

Amount sold USD all in the past week

realizedProfitUsd1w
String!
required

Realized profit in USD in the past week

realizedProfitPercentage1w
Float!
required

Realized profit percentage in the past week

buys1w
Int!
required

Number of buys in the past week

sells1w
Int!
required

Number of sells in the past week

sellsAll1w
Int!
required

Number of sells all in the past week

tokenAmountBought30d
String!
required

Token amount bought in the past 30 days

tokenAmountSold30d
String!
required

Token amount sold in the past 30 days

tokenAmountSoldAll30d
String!
required

Token amount sold all in the past 30 days

amountBoughtUsd30d
String!
required

Amount bought in USD in the past 30 days

amountSoldUsd30d
String!
required

Amount sold in USD in the past 30 days

amountSoldUsdAll30d
String!
required

Amount sold USD all in the past 30 days

realizedProfitUsd30d
String!
required

Realized profit in USD in the past 30 days

realizedProfitPercentage30d
Float!
required

Realized profit percentage in the past 30 days

buys30d
Int!
required

Number of buys in the past 30 days

sells30d
Int!
required

Number of sells in the past 30 days

sellsAll30d
Int!
required

Number of sells all in the past 30 days

tokenAmountBought1y
String!
required

Token amount bought in the past year

tokenAmountSold1y
String!
required

Token amount sold in the past year

tokenAmountSoldAll1y
String!
required

Token amount sold all in the past year

amountBoughtUsd1y
String!
required

Amount bought in USD in the past year

amountSoldUsd1y
String!
required

Amount sold in USD in the past year

amountSoldUsdAll1y
String!
required

Amount sold USD all in the past year

realizedProfitUsd1y
String!
required

Realized profit in USD in the past year

realizedProfitPercentage1y
Float!
required

Realized profit percentage in the past year

buys1y
Int!
required

Number of buys in the past year

sells1y
Int!
required

Number of sells in the past year

sellsAll1y
Int!
required

Number of sells all in the past year

purchasedTokenBalance
String!
required

The purchased token balance

tokenAcquisitionCostUsd
String!
required

The token acquisition cost in USD

tokenBalance
String!
required

The current token balance

token
EnhancedToken!
required

The token metadata

scammerScore
Int

The scammer score for the wallet.

botScore
Int

The bot score for the wallet.

"""The result for filtering wallets for a token."""
type TokenWalletFilterResult {
  """The wallet address"""
  address: String!
  """The token address"""
  tokenAddress: String!
  """The network ID"""
  networkId: Int!
  """The unix timestamp for the first transaction from this wallet"""
  firstTransactionAt: Int
  """The unix timestamp for the last transaction from this wallet"""
  lastTransactionAt: Int!
  """The labels associated with the wallet"""
  labels: [String!]!
  """Token amount bought in the past day"""
  tokenAmountBought1d: String!
  """Token amount sold in the past day"""
  tokenAmountSold1d: String!
  """Token amount sold all in the past day"""
  tokenAmountSoldAll1d: String!
  """Amount bought in USD in the past day"""
  amountBoughtUsd1d: String!
  """Amount sold in USD in the past day"""
  amountSoldUsd1d: String!
  """Amount sold USD all in the past day"""
  amountSoldUsdAll1d: String!
  """Realized profit in USD in the past day"""
  realizedProfitUsd1d: String!
  """Realized profit percentage in the past day"""
  realizedProfitPercentage1d: Float!
  """Number of buys in the past day"""
  buys1d: Int!
  """Number of sells in the past day"""
  sells1d: Int!
  """Number of sells all in the past day"""
  sellsAll1d: Int!
  """Token amount bought in the past week"""
  tokenAmountBought1w: String!
  """Token amount sold in the past week"""
  tokenAmountSold1w: String!
  """Token amount sold all in the past week"""
  tokenAmountSoldAll1w: String!
  """Amount bought in USD in the past week"""
  amountBoughtUsd1w: String!
  """Amount sold in USD in the past week"""
  amountSoldUsd1w: String!
  """Amount sold USD all in the past week"""
  amountSoldUsdAll1w: String!
  """Realized profit in USD in the past week"""
  realizedProfitUsd1w: String!
  """Realized profit percentage in the past week"""
  realizedProfitPercentage1w: Float!
  """Number of buys in the past week"""
  buys1w: Int!
  """Number of sells in the past week"""
  sells1w: Int!
  """Number of sells all in the past week"""
  sellsAll1w: Int!
  """Token amount bought in the past 30 days"""
  tokenAmountBought30d: String!
  """Token amount sold in the past 30 days"""
  tokenAmountSold30d: String!
  """Token amount sold all in the past 30 days"""
  tokenAmountSoldAll30d: String!
  """Amount bought in USD in the past 30 days"""
  amountBoughtUsd30d: String!
  """Amount sold in USD in the past 30 days"""
  amountSoldUsd30d: String!
  """Amount sold USD all in the past 30 days"""
  amountSoldUsdAll30d: String!
  """Realized profit in USD in the past 30 days"""
  realizedProfitUsd30d: String!
  """Realized profit percentage in the past 30 days"""
  realizedProfitPercentage30d: Float!
  """Number of buys in the past 30 days"""
  buys30d: Int!
  """Number of sells in the past 30 days"""
  sells30d: Int!
  """Number of sells all in the past 30 days"""
  sellsAll30d: Int!
  """Token amount bought in the past year"""
  tokenAmountBought1y: String!
  """Token amount sold in the past year"""
  tokenAmountSold1y: String!
  """Token amount sold all in the past year"""
  tokenAmountSoldAll1y: String!
  """Amount bought in USD in the past year"""
  amountBoughtUsd1y: String!
  """Amount sold in USD in the past year"""
  amountSoldUsd1y: String!
  """Amount sold USD all in the past year"""
  amountSoldUsdAll1y: String!
  """Realized profit in USD in the past year"""
  realizedProfitUsd1y: String!
  """Realized profit percentage in the past year"""
  realizedProfitPercentage1y: Float!
  """Number of buys in the past year"""
  buys1y: Int!
  """Number of sells in the past year"""
  sells1y: Int!
  """Number of sells all in the past year"""
  sellsAll1y: Int!
  """The purchased token balance"""
  purchasedTokenBalance: String!
  """The token acquisition cost in USD"""
  tokenAcquisitionCostUsd: String!
  """The current token balance"""
  tokenBalance: String!
  """The token metadata"""
  token: EnhancedToken!
  """The scammer score for the wallet."""
  scammerScore: Int
  """The bot score for the wallet."""
  botScore: Int
}

TokenWithMetadata

A token with metadata.

address
String!
required

The contract address of the token.

decimals
Int

The precision to which the token can be divided. For example, the smallest unit for USDC is 0.000001 (6 decimals).

exchanges
[Exchange!]!
required

The exchanges the token is listed on.

id
String!
required

The ID of the token (address:networkId). For example, 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2:1.

liquidity
String!
required

The total liquidity of the token’s top pair in USD.

name
String!
required

The name of the token.

networkId
Int!
required

The network ID the token is deployed on.

price
Float!
required

The token price in USD.

priceChange
Float!
required

The percent price change for the time frame requested. Decimal format.

isScam
Boolean

Whether the token has been flagged as a scam.

priceChange1
Float

The percent price change in the past hour. Decimal format.

priceChange12
Float

The percent price change in the past 12 hours. Decimal format.

priceChange24
Float

The percent price change in the past 24 hours. Decimal format.

priceChange4
Float

The percent price change in the past 4 hours. Decimal format.

quoteToken
QuoteToken

The token of interest. Can be token0 or token1.

marketCap
String

The market cap of circulating supply.

txnCount1
Int

The number of transactions in the past hour.

txnCount12
Int

The number of transactions in the past 12 hours.

txnCount24
Int

The number of transactions in the past 24 hours.

txnCount4
Int

The number of transactions in the past 4 hours.

uniqueBuys1
Int

The unique number of buys in the past hour.

uniqueBuys12
Int

The unique number of buys in the past 12 hours.

uniqueBuys24
Int

The unique number of buys in the past 24 hours.

uniqueBuys4
Int

The unique number of buys in the past 4 hours.

uniqueSells1
Int

The unique number of sells in the past hour.

uniqueSells12
Int

The unique number of sells in the past 12 hours.

uniqueSells24
Int

The unique number of sells in the past 24 hours.

uniqueSells4
Int

The unique number of sells in the past 4 hours.

resolution
String!
required

The time frame for the results.

symbol
String!
required

The symbol for the token.

topPairId
String!
required

The ID of the token’s top pair (pairAddress:networkId).

volume
String!
required

The volume over the time frame requested in USD.

imageThumbUrl
String

The token logo URL.

imageSmallUrl
String

The token logo URL.

imageLargeUrl
String

The token logo URL.

imageBannerUrl
String

The token banner URL.

createdAt
Int

The unix timestamp for the creation of the token’s first pair.

lastTransaction
Int

The unix timestamp for the token’s last transaction.

"""A token with metadata."""
type TokenWithMetadata {
  """The contract address of the token."""
  address: String!
  """The precision to which the token can be divided. For example, the smallest unit for USDC is 0.000001 (6 decimals)."""
  decimals: Int
  """The exchanges the token is listed on."""
  exchanges: [Exchange!]!
  """The ID of the token (`address:networkId`). For example, `0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2:1`."""
  id: String!
  """The total liquidity of the token's top pair in USD."""
  liquidity: String!
  """The name of the token."""
  name: String!
  """The network ID the token is deployed on."""
  networkId: Int!
  """The token price in USD."""
  price: Float!
  """The percent price change for the time frame requested. Decimal format."""
  priceChange: Float!
  """Whether the token has been flagged as a scam."""
  isScam: Boolean
  """The percent price change in the past hour. Decimal format."""
  priceChange1: Float
  """The percent price change in the past 12 hours. Decimal format."""
  priceChange12: Float
  """The percent price change in the past 24 hours. Decimal format."""
  priceChange24: Float
  """The percent price change in the past 4 hours. Decimal format."""
  priceChange4: Float
  """The token of interest. Can be `token0` or `token1`."""
  quoteToken: QuoteToken
  """The market cap of circulating supply."""
  marketCap: String
  """The number of transactions in the past hour."""
  txnCount1: Int
  """The number of transactions in the past 12 hours."""
  txnCount12: Int
  """The number of transactions in the past 24 hours."""
  txnCount24: Int
  """The number of transactions in the past 4 hours."""
  txnCount4: Int
  """The unique number of buys in the past hour."""
  uniqueBuys1: Int
  """The unique number of buys in the past 12 hours."""
  uniqueBuys12: Int
  """The unique number of buys in the past 24 hours."""
  uniqueBuys24: Int
  """The unique number of buys in the past 4 hours."""
  uniqueBuys4: Int
  """The unique number of sells in the past hour."""
  uniqueSells1: Int
  """The unique number of sells in the past 12 hours."""
  uniqueSells12: Int
  """The unique number of sells in the past 24 hours."""
  uniqueSells24: Int
  """The unique number of sells in the past 4 hours."""
  uniqueSells4: Int
  """The time frame for the results."""
  resolution: String!
  """The symbol for the token."""
  symbol: String!
  """The ID of the token's top pair (`pairAddress:networkId`)."""
  topPairId: String!
  """The volume over the time frame requested in USD."""
  volume: String!
  """The token logo URL."""
  imageThumbUrl: String
  """The token logo URL."""
  imageSmallUrl: String
  """The token logo URL."""
  imageLargeUrl: String
  """The token banner URL."""
  imageBannerUrl: String
  """The unix timestamp for the creation of the token's first pair."""
  createdAt: Int
  """The unix timestamp for the token's last transaction."""
  lastTransaction: Int
}

UnconfirmedEvent

An unconfirmed token transaction.

address
String!
required

The contract address of the token’s top pair.

blockHash
String!
required

The hash of the block where the transaction occurred.

blockNumber
Int!
required

The block number for the transaction.

eventType
EventType!
required

The type of transaction event. Can be Burn, Mint, Swap, Sync, Collect, or CollectProtocol.

id
String!
required

The ID of the event (address:networkId). For example, 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2:1.

logIndex
Int!
required

The index of the log in the block.

maker
String

The wallet address that performed the transaction.

networkId
Int!
required

The network ID that the token is deployed on.

quoteToken
QuoteToken

The token of interest within the token’s top pair. Can be token0 or token1.

timestamp
Int!
required

The unix timestamp for when the transaction occurred.

transactionHash
String!
required

The unique hash for the transaction.

transactionIndex
Int!
required

The index of the transaction within the block.

supplementalIndex
Int

A optional unique identifier of where the event is within the transaction.

eventDisplayType
EventDisplayType

A more specific breakdown of eventType. Splits Swap into Buy or Sell.

data
UnconfirmedEventData

The event-specific data for the transaction.

"""An unconfirmed token transaction."""
type UnconfirmedEvent {
  """The contract address of the token's top pair."""
  address: String!
  """The hash of the block where the transaction occurred."""
  blockHash: String!
  """The block number for the transaction."""
  blockNumber: Int!
  """The type of transaction event. Can be `Burn`, `Mint`, `Swap`, `Sync`, `Collect`, or `CollectProtocol`."""
  eventType: EventType!
  """The ID of the event (`address:networkId`). For example, `0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2:1`."""
  id: String!
  """The index of the log in the block."""
  logIndex: Int!
  """The wallet address that performed the transaction."""
  maker: String
  """The network ID that the token is deployed on."""
  networkId: Int!
  """The token of interest within the token's top pair. Can be `token0` or `token1`."""
  quoteToken: QuoteToken
  """The unix timestamp for when the transaction occurred."""
  timestamp: Int!
  """The unique hash for the transaction."""
  transactionHash: String!
  """The index of the transaction within the block."""
  transactionIndex: Int!
  """A optional unique identifier of where the event is within the transaction."""
  supplementalIndex: Int
  """A more specific breakdown of `eventType`. Splits `Swap` into `Buy` or `Sell`."""
  eventDisplayType: EventDisplayType
  """The event-specific data for the transaction."""
  data: UnconfirmedEventData
}

UnconfirmedIndividualBarData

Unconfirmed bar chart data.

o
Float!
required

The opening price.

h
Float!
required

The high price.

l
Float!
required

The low price.

c
Float!
required

The closing price.

v
Int

The volume.

volume
String!
required

The volume with higher precision.

t
Int!
required

The timestamp for the bar.

"""Unconfirmed bar chart data."""
type UnconfirmedIndividualBarData {
  """The opening price."""
  o: Float!
  """The high price."""
  h: Float!
  """The low price."""
  l: Float!
  """The closing price."""
  c: Float!
  """The volume."""
  v: Int
  """The volume with higher precision."""
  volume: String!
  """The timestamp for the bar."""
  t: Int!
}

UnconfirmedLiquidityChangeEventData

Event data for a token liquidity change event.

amount0
String

The amount of token0 added or removed from the pair.

amount1
String

The amount of token1 added or removed from the pair.

amount0Shifted
String

The amount of token0 added or removed from the pair, adjusted by the number of decimals in the token. For example, if amount0 is in WEI, amount0Shifted will be in ETH.

amount1Shifted
String

The amount of token1 added or removed from the pair, adjusted by the number of decimals in the token. For example, USDC amount1Shifted will be by 6 decimals.

type
EventType!
required

The type of token event, Mint or ‘Burn’.

"""Event data for a token liquidity change event."""
type UnconfirmedLiquidityChangeEventData {
  """The amount of `token0` added or removed from the pair."""
  amount0: String
  """The amount of `token1` added or removed from the pair."""
  amount1: String
  """The amount of `token0` added or removed from the pair, adjusted by the number of decimals in the token. For example, if `amount0` is in WEI, `amount0Shifted` will be in ETH."""
  amount0Shifted: String
  """The amount of `token1` added or removed from the pair, adjusted by the number of decimals in the token. For example, USDC `amount1Shifted` will be by 6 decimals."""
  amount1Shifted: String
  """The type of token event, `Mint` or 'Burn'."""
  type: EventType!
}

UnconfirmedResolutionBarData

Unconfirmed price data for each supported resolution.

r1S
UnconfirmedIndividualBarData

1 second resolution.

r5S
UnconfirmedIndividualBarData

5 second resolution.

r15S
UnconfirmedIndividualBarData

15 second resolution.

r1
UnconfirmedIndividualBarData

1 minute resolution.

r5
UnconfirmedIndividualBarData

5 minute resolution.

r15
UnconfirmedIndividualBarData

15 minute resolution.

"""Unconfirmed price data for each supported resolution."""
type UnconfirmedResolutionBarData {
  """1 second resolution."""
  r1S: UnconfirmedIndividualBarData
  """5 second resolution."""
  r5S: UnconfirmedIndividualBarData
  """15 second resolution."""
  r15S: UnconfirmedIndividualBarData
  """1 minute resolution."""
  r1: UnconfirmedIndividualBarData
  """5 minute resolution."""
  r5: UnconfirmedIndividualBarData
  """15 minute resolution."""
  r15: UnconfirmedIndividualBarData
}

UnconfirmedSwapEventData

Event data for a token swap event.

amountNonLiquidityToken
String

The amount of quoteToken involved in the swap. For example, if quoteToken is USDC for a USDC/WETH pair, amountNonLiquidityToken would be the amount of USDC involved in the swap.

priceBaseToken
String

The price per quoteToken at the time of the swap in the network’s base token. For example, if quoteToken is USDC for a USDC/WETH pair on ETH network, priceBaseToken would the price of USDC in ETH.

priceBaseTokenTotal
String

The total amount of quoteToken involved in the swap in the network’s base token (amountNonLiquidityToken x priceBaseToken).

priceUsd
String

The price per quoteToken at the time of the swap in USD. For example, if quoteToken is USDC for a USDC/WETH pair on ETH network, priceBaseToken would the price of USDC in USD ($1.00).

priceUsdTotal
String

The total amount of quoteToken involved in the swap in USD (amountNonLiquidityToken x priceUsd).

type
EventType!
required

The type of token event, Swap.

amountBaseToken
String

The amount of baseToken involved in the swap

"""Event data for a token swap event."""
type UnconfirmedSwapEventData {
  """The amount of `quoteToken` involved in the swap. For example, if `quoteToken` is USDC for a USDC/WETH pair, `amountNonLiquidityToken` would be the amount of USDC involved in the swap."""
  amountNonLiquidityToken: String
  """The price per `quoteToken` at the time of the swap in the network's base token. For example, if `quoteToken` is USDC for a USDC/WETH pair on ETH network, `priceBaseToken` would the price of USDC in ETH."""
  priceBaseToken: String
  """The total amount of `quoteToken` involved in the swap in the network's base token (`amountNonLiquidityToken` x `priceBaseToken`)."""
  priceBaseTokenTotal: String
  """The price per `quoteToken` at the time of the swap in USD. For example, if `quoteToken` is USDC for a USDC/WETH pair on ETH network, `priceBaseToken` would the price of USDC in USD ($1.00)."""
  priceUsd: String
  """The total amount of `quoteToken` involved in the swap in USD (`amountNonLiquidityToken` x `priceUsd`)."""
  priceUsdTotal: String
  """The type of token event, `Swap`."""
  type: EventType!
  """The amount of `baseToken` involved in the swap"""
  amountBaseToken: String
}

WalletChartData

The data for a chart of a wallet’s activity.

timestamp
Int!
required

The timestamp

resolution
String!
required

The resolution

volumeUsd
String!
required

The volume in USD

volumeUsdAll
String!
required

The volume in USD including tokens sold for which we do not have a price

realizedProfitUsd
String!
required

The realized profit in USD

swaps
Int!
required

The number of swaps

"""The data for a chart of a wallet's activity."""
type WalletChartData {
  """The timestamp"""
  timestamp: Int!
  """The resolution"""
  resolution: String!
  """The volume in USD"""
  volumeUsd: String!
  """The volume in USD including tokens sold for which we do not have a price"""
  volumeUsdAll: String!
  """The realized profit in USD"""
  realizedProfitUsd: String!
  """The number of swaps"""
  swaps: Int!
}

WalletChartRange

The range of time for a chart.

start
Int!
required

No description provided

end
Int!
required

No description provided

"""The range of time for a chart."""
type WalletChartRange {
  start: Int!
  end: Int!
}

WalletChartResponse

The response for a chart of a wallet’s activity.

walletAddress
String!
required

The wallet address

networkId
Int

The network ID

range
WalletChartRange!
required

The range of time for the chart

resolution
String!
required

The resolution of the chart

data
[WalletChartData!]!
required

The data for the chart

"""The response for a chart of a wallet's activity."""
type WalletChartResponse {
  """The wallet address"""
  walletAddress: String!
  """The network ID"""
  networkId: Int
  """The range of time for the chart"""
  range: WalletChartRange!
  """The resolution of the chart"""
  resolution: String!
  """The data for the chart"""
  data: [WalletChartData!]!
}

WalletFilterConnection

A connection of wallets matching a filter.

results
[WalletFilterResult!]!
required

The list of wallets matching the filter parameters.

count
Int!
required

The number of wallets returned.

offset
Int!
required

Where in the list the server started when returning items.

"""A connection of wallets matching a filter."""
type WalletFilterConnection {
  """The list of wallets matching the filter parameters."""
  results: [WalletFilterResult!]!
  """The number of wallets returned."""
  count: Int!
  """Where in the list the server started when returning items."""
  offset: Int!
}

WalletFilterResult

A wallet matching a filter.

address
String!
required

The wallet address

firstTransactionAt
Int

The unix timestamp for the first transaction from this wallet

lastTransactionAt
Int!
required

The unix timestamp for the last transaction from this wallet

labels
[String!]!
required

The labels associated with the wallet

volumeUsd1d
String!
required

Volume in USD in the past day

volumeUsdAll1d
String!
required

Total volume in USD in the past day including all tokens

realizedProfitUsd1d
String!
required

Realized profit in USD in the past day

averageProfitUsdPerTrade1d
String!
required

Average profit in USD per trade in the past day

averageSwapAmountUsd1d
String!
required

Average swap amount in USD in the past day

realizedProfitPercentage1d
Float!
required

Realized profit percentage in the past day

swaps1d
Int!
required

Number of swaps in the past day

swapsAll1d
Int!
required

Total number of swaps in the past day including all tokens

uniqueTokens1d
Int!
required

Number of unique tokens traded in the past day

winRate1d
Float!
required

Win rate in the past day

volumeUsd1w
String!
required

Volume in USD in the past week

volumeUsdAll1w
String!
required

Total volume in USD in the past week including all tokens

realizedProfitUsd1w
String!
required

Realized profit in USD in the past week

averageProfitUsdPerTrade1w
String!
required

Average profit in USD per trade in the past week

averageSwapAmountUsd1w
String!
required

Average swap amount in USD in the past week

realizedProfitPercentage1w
Float!
required

Realized profit percentage in the past week

swaps1w
Int!
required

Number of swaps in the past week

swapsAll1w
Int!
required

Total number of swaps in the past week including all tokens

uniqueTokens1w
Int!
required

Number of unique tokens traded in the past week

winRate1w
Float!
required

Win rate in the past week

volumeUsd30d
String!
required

Volume in USD in the past 30 days

volumeUsdAll30d
String!
required

Total volume in USD in the past 30 days including all tokens

realizedProfitUsd30d
String!
required

Realized profit in USD in the past 30 days

averageProfitUsdPerTrade30d
String!
required

Average profit in USD per trade in the past 30 days

averageSwapAmountUsd30d
String!
required

Average swap amount in USD in the past 30 days

realizedProfitPercentage30d
Float!
required

Realized profit percentage in the past 30 days

swaps30d
Int!
required

Number of swaps in the past 30 days

swapsAll30d
Int!
required

Total number of swaps in the past 30 days including all tokens

uniqueTokens30d
Int!
required

Number of unique tokens traded in the past 30 days

winRate30d
Float!
required

Win rate in the past 30 days

volumeUsd1y
String!
required

Volume in USD in the past year

volumeUsdAll1y
String!
required

Total volume in USD in the past year including all tokens

realizedProfitUsd1y
String!
required

Realized profit in USD in the past year

averageProfitUsdPerTrade1y
String!
required

Average profit in USD per trade in the past year

averageSwapAmountUsd1y
String!
required

Average swap amount in USD in the past year

realizedProfitPercentage1y
Float!
required

Realized profit percentage in the past year

swaps1y
Int!
required

Number of swaps in the past year

swapsAll1y
Int!
required

Total number of swaps in the past year including all tokens

uniqueTokens1y
Int!
required

Number of unique tokens traded in the past year

winRate1y
Float!
required

Win rate in the past year

scammerScore
Int

The scammer score for the wallet.

botScore
Int

The bot score for the wallet.

networkId
Int

The network ID of the wallet (only present if filtered by network)

nativeTokenBalance
String

The native token balance of the wallet (only present if filtered by network)

"""A wallet matching a filter."""
type WalletFilterResult {
  """The wallet address"""
  address: String!
  """The unix timestamp for the first transaction from this wallet"""
  firstTransactionAt: Int
  """The unix timestamp for the last transaction from this wallet"""
  lastTransactionAt: Int!
  """The labels associated with the wallet"""
  labels: [String!]!
  """Volume in USD in the past day"""
  volumeUsd1d: String!
  """Total volume in USD in the past day including all tokens"""
  volumeUsdAll1d: String!
  """Realized profit in USD in the past day"""
  realizedProfitUsd1d: String!
  """Average profit in USD per trade in the past day"""
  averageProfitUsdPerTrade1d: String!
  """Average swap amount in USD in the past day"""
  averageSwapAmountUsd1d: String!
  """Realized profit percentage in the past day"""
  realizedProfitPercentage1d: Float!
  """Number of swaps in the past day"""
  swaps1d: Int!
  """Total number of swaps in the past day including all tokens"""
  swapsAll1d: Int!
  """Number of unique tokens traded in the past day"""
  uniqueTokens1d: Int!
  """Win rate in the past day"""
  winRate1d: Float!
  """Volume in USD in the past week"""
  volumeUsd1w: String!
  """Total volume in USD in the past week including all tokens"""
  volumeUsdAll1w: String!
  """Realized profit in USD in the past week"""
  realizedProfitUsd1w: String!
  """Average profit in USD per trade in the past week"""
  averageProfitUsdPerTrade1w: String!
  """Average swap amount in USD in the past week"""
  averageSwapAmountUsd1w: String!
  """Realized profit percentage in the past week"""
  realizedProfitPercentage1w: Float!
  """Number of swaps in the past week"""
  swaps1w: Int!
  """Total number of swaps in the past week including all tokens"""
  swapsAll1w: Int!
  """Number of unique tokens traded in the past week"""
  uniqueTokens1w: Int!
  """Win rate in the past week"""
  winRate1w: Float!
  """Volume in USD in the past 30 days"""
  volumeUsd30d: String!
  """Total volume in USD in the past 30 days including all tokens"""
  volumeUsdAll30d: String!
  """Realized profit in USD in the past 30 days"""
  realizedProfitUsd30d: String!
  """Average profit in USD per trade in the past 30 days"""
  averageProfitUsdPerTrade30d: String!
  """Average swap amount in USD in the past 30 days"""
  averageSwapAmountUsd30d: String!
  """Realized profit percentage in the past 30 days"""
  realizedProfitPercentage30d: Float!
  """Number of swaps in the past 30 days"""
  swaps30d: Int!
  """Total number of swaps in the past 30 days including all tokens"""
  swapsAll30d: Int!
  """Number of unique tokens traded in the past 30 days"""
  uniqueTokens30d: Int!
  """Win rate in the past 30 days"""
  winRate30d: Float!
  """Volume in USD in the past year"""
  volumeUsd1y: String!
  """Total volume in USD in the past year including all tokens"""
  volumeUsdAll1y: String!
  """Realized profit in USD in the past year"""
  realizedProfitUsd1y: String!
  """Average profit in USD per trade in the past year"""
  averageProfitUsdPerTrade1y: String!
  """Average swap amount in USD in the past year"""
  averageSwapAmountUsd1y: String!
  """Realized profit percentage in the past year"""
  realizedProfitPercentage1y: Float!
  """Number of swaps in the past year"""
  swaps1y: Int!
  """Total number of swaps in the past year including all tokens"""
  swapsAll1y: Int!
  """Number of unique tokens traded in the past year"""
  uniqueTokens1y: Int!
  """Win rate in the past year"""
  winRate1y: Float!
  """The scammer score for the wallet."""
  scammerScore: Int
  """The bot score for the wallet."""
  botScore: Int
  """The network ID of the wallet (only present if filtered by network)"""
  networkId: Int
  """The native token balance of the wallet (only present if filtered by network)"""
  nativeTokenBalance: String
}

WalletNftCollection

walletAddress
String!
required

The address of the wallet.

collectionId
String!
required

The collection ID (collectionAddress:networkId).

quantity
String!
required

The number of items held by the wallet.

type WalletNftCollection {
  """The address of the wallet."""
  walletAddress: String!
  """The collection ID (`collectionAddress:networkId`)."""
  collectionId: String!
  """The number of items held by the wallet."""
  quantity: String!
}

WalletNftCollectionAsset

tokenId
String!
required

The id of the nft asset.

quantity
String!
required

The number of instances of the nft held by the wallet (Applicable to ERC1155 NFTs).

type WalletNftCollectionAsset {
  """The id of the nft asset."""
  tokenId: String!
  """The number of instances of the nft held by the wallet (Applicable to ERC1155 NFTs)."""
  quantity: String!
}

WalletNftCollectionAssetsResponse

items
[WalletNftCollectionAsset]!
required

The list of nft assets for a wallet.

walletAddress
String!
required

The address of the wallet.

collectionId
String!
required

The collection ID (collectionAddress:networkId).

cursor
String

A cursor for use in pagination.

type WalletNftCollectionAssetsResponse {
  """The list of nft assets for a wallet."""
  items: [WalletNftCollectionAsset]!
  """The address of the wallet."""
  walletAddress: String!
  """The collection ID (`collectionAddress:networkId`)."""
  collectionId: String!
  """A cursor for use in pagination."""
  cursor: String
}

WalletNftCollectionsResponse

items
[WalletNftCollection!]!
required

The list of collections for a wallet.

cursor
String

A cursor for use in pagination.

type WalletNftCollectionsResponse {
  """The list of collections for a wallet."""
  items: [WalletNftCollection!]!
  """A cursor for use in pagination."""
  cursor: String
}

WashtradeLabelForEvent

Metadata for a washtrade label.

label
String!
required

The label type, ‘washtrade’

"""Metadata for a washtrade label."""
type WashtradeLabelForEvent {
  """The label type, 'washtrade'"""
  label: String!
}

Webhook

Metadata for a webhook.

id
String!
required

The ID of the webhook.

webhookType
WebhookType!
required

The type of webhook. Can be PRICE_EVENT, NFT_EVENT, or TOKEN_PAIR_EVENT.

name
String!
required

The given name of the webhook.

created
Int!
required

The unix timestamp for the time the webhook was created.

alertRecurrence
AlertRecurrence!
required

The recurrence of the webhook. Can be INDEFINITE or ONCE.

callbackUrl
String!
required

The url to which the webhook message should be sent.

status
String!
required

The status of the webhook. Can be ACTIVE or INACTIVE.

groupId
String

The webhook group ID used to group webhooks together for ordered message sending.

conditions
WebhookCondition!
required

The conditions which must be met in order for the webhook to send a message.

retrySettings
RetrySettings

The settings for retrying failed webhook messages.

bucketId
String

An optional bucket ID (max 64 characters). Can be used to query for subgroups of webhooks (useful if you have a large number of webhooks).

bucketSortkey
String

An optional bucket sort key (max 64 characters). Can be used to query for subgroups of webhooks (useful if you have a large number of webhooks).

publishingType
PublishingType

The type of publishing for the webhook. If not set, it defaults to SINGLE.

"""Metadata for a webhook."""
type Webhook {
  """The ID of the webhook."""
  id: String!
  """The type of webhook. Can be `PRICE_EVENT`, `NFT_EVENT`, or `TOKEN_PAIR_EVENT`."""
  webhookType: WebhookType!
  """The given name of the webhook."""
  name: String!
  """The unix timestamp for the time the webhook was created."""
  created: Int!
  """The recurrence of the webhook. Can be `INDEFINITE` or `ONCE`."""
  alertRecurrence: AlertRecurrence!
  """The url to which the webhook message should be sent."""
  callbackUrl: String!
  """The status of the webhook. Can be `ACTIVE` or `INACTIVE`."""
  status: String!
  """The webhook group ID used to group webhooks together for ordered message sending."""
  groupId: String
  """The conditions which must be met in order for the webhook to send a message."""
  conditions: WebhookCondition!
  """The settings for retrying failed webhook messages."""
  retrySettings: RetrySettings
  """An optional bucket ID (max 64 characters). Can be used to query for subgroups of webhooks (useful if you have a large number of webhooks)."""
  bucketId: String
  """An optional bucket sort key (max 64 characters). Can be used to query for subgroups of webhooks (useful if you have a large number of webhooks)."""
  bucketSortkey: String
  """The type of publishing for the webhook. If not set, it defaults to `SINGLE`."""
  publishingType: PublishingType
}

WindowedDetailedCurrencyPairStats

Price stats for a pair over a time frame.

volume
DetailedPairStatsStringMetrics

The volume over the time frame.

buyVolume
DetailedPairStatsStringMetrics

The buy volume over the time frame.

sellVolume
DetailedPairStatsStringMetrics

The sell volume over the time frame.

open
DetailedPairStatsStringMetrics

The opening price for the time frame.

highest
DetailedPairStatsStringMetrics

The highest price in USD in the time frame.

lowest
DetailedPairStatsStringMetrics

The lowest price in USD in the time frame.

close
DetailedPairStatsStringMetrics

The closing price forr the time frame.

liquidity
DetailedPairStatsStringMetrics

The liquidity for the time frame.

"""Price stats for a pair over a time frame."""
type WindowedDetailedCurrencyPairStats {
  """The volume over the time frame."""
  volume: DetailedPairStatsStringMetrics
  """The buy volume over the time frame."""
  buyVolume: DetailedPairStatsStringMetrics
  """The sell volume over the time frame."""
  sellVolume: DetailedPairStatsStringMetrics
  """The opening price for the time frame."""
  open: DetailedPairStatsStringMetrics
  """The highest price in USD in the time frame."""
  highest: DetailedPairStatsStringMetrics
  """The lowest price in USD in the time frame."""
  lowest: DetailedPairStatsStringMetrics
  """The closing price forr the time frame."""
  close: DetailedPairStatsStringMetrics
  """The liquidity for the time frame."""
  liquidity: DetailedPairStatsStringMetrics
}

WindowedDetailedCurrencyWalletStats

The currency stats for a wallet over a time window.

volumeUsd
String!
required

The volume in USD

volumeUsdAll
String!
required

The volume in USD including tokens sold for which we do not have a price

heldTokenAcquisitionCostUsd
String!
required

The cost of tokens held in the wallet

soldTokenAcquisitionCostUsd
String!
required

The cost of tokens sold during the period

realizedProfitUsd
String!
required

The realized profit in USD

averageProfitUsdPerTrade
String!
required

The average profit in USD per trade

averageSwapAmountUsd
String!
required

The average swap amount in USD

realizedProfitPercentage
Float!
required

The realized profit percentage

"""The currency stats for a wallet over a time window."""
type WindowedDetailedCurrencyWalletStats {
  """The volume in USD"""
  volumeUsd: String!
  """The volume in USD including tokens sold for which we do not have a price"""
  volumeUsdAll: String!
  """The cost of tokens held in the wallet"""
  heldTokenAcquisitionCostUsd: String!
  """The cost of tokens sold during the period"""
  soldTokenAcquisitionCostUsd: String!
  """The realized profit in USD"""
  realizedProfitUsd: String!
  """The average profit in USD per trade"""
  averageProfitUsdPerTrade: String!
  """The average swap amount in USD"""
  averageSwapAmountUsd: String!
  """The realized profit percentage"""
  realizedProfitPercentage: Float!
}

WindowedDetailedNftCurrencyStats

Price stats for an NFT collection over a time frame. Either in USD or the network’s base token.

volume
DetailedNftStatsStringMetrics

The volume over the time frame.

average
DetailedNftStatsStringMetrics

The average sale price in the time frame.

open
DetailedNftStatsStringMetrics

The opening price for the time frame.

highestSale
DetailedNftStatsStringMetrics

The highest sale price in the time frame.

lowestSale
DetailedNftStatsStringMetrics

The lowest sale price in the time frame.

close
DetailedNftStatsStringMetrics

The closing price for the time frame.

"""Price stats for an NFT collection over a time frame. Either in USD or the network's base token."""
type WindowedDetailedNftCurrencyStats {
  """The volume over the time frame."""
  volume: DetailedNftStatsStringMetrics
  """The average sale price in the time frame."""
  average: DetailedNftStatsStringMetrics
  """The opening price for the time frame."""
  open: DetailedNftStatsStringMetrics
  """The highest sale price in the time frame."""
  highestSale: DetailedNftStatsStringMetrics
  """The lowest sale price in the time frame."""
  lowestSale: DetailedNftStatsStringMetrics
  """The closing price for the time frame."""
  close: DetailedNftStatsStringMetrics
}

WindowedDetailedNftNonCurrencyStats

Numerical stats for an NFT collection over a time frame.

mints
DetailedNftStatsNumberMetrics

The number of mints over the time frame.

sales
DetailedNftStatsNumberMetrics

The number of sales over the time frame.

transfers
DetailedNftStatsNumberMetrics

The number of transfers over the time frame.

tokensSold
DetailedNftStatsStringMetrics

The number of tokens sold over the time frame.

uniqueBuyers
DetailedNftStatsNumberMetrics

The number of unique buyers over the time frame.

uniqueSellers
DetailedNftStatsNumberMetrics

The number of unique sellers over the time frame.

uniqueSalesWallets
DetailedNftStatsNumberMetrics

The number of unique wallets (buyers or sellers) over the time frame.

uniqueMinters
DetailedNftStatsNumberMetrics

The number of unique minters over the time frame.

"""Numerical stats for an NFT collection over a time frame."""
type WindowedDetailedNftNonCurrencyStats {
  """The number of mints over the time frame."""
  mints: DetailedNftStatsNumberMetrics
  """The number of sales over the time frame."""
  sales: DetailedNftStatsNumberMetrics
  """The number of transfers over the time frame."""
  transfers: DetailedNftStatsNumberMetrics
  """The number of tokens sold over the time frame."""
  tokensSold: DetailedNftStatsStringMetrics
  """The number of unique buyers over the time frame."""
  uniqueBuyers: DetailedNftStatsNumberMetrics
  """The number of unique sellers over the time frame."""
  uniqueSellers: DetailedNftStatsNumberMetrics
  """The number of unique wallets (buyers or sellers) over the time frame."""
  uniqueSalesWallets: DetailedNftStatsNumberMetrics
  """The number of unique minters over the time frame."""
  uniqueMinters: DetailedNftStatsNumberMetrics
}

WindowedDetailedNftStats

Detailed NFT stats over a time frame.

duration
DetailedNftStatsDuration!
required

The duration used to request detailed NFT stats.

start
Int!
required

The unix timestamp for the start of the window.

end
Int!
required

The unix timestamp for the end of the window.

timestamps
[DetailedNftStatsBucketTimestamp]!
required

The list of start/end timestamps broken down for each bucket within the window.

statsUsd
WindowedDetailedNftCurrencyStats!
required

The currency stats in USD, such as volume.

statsNetworkBaseToken
WindowedDetailedNftCurrencyStats!
required

The currency stats in the network’s base token, such as volume.

statsNonCurrency
WindowedDetailedNftNonCurrencyStats!
required

The numerical stats, such as number of buyers.

"""Detailed NFT stats over a time frame."""
type WindowedDetailedNftStats {
  """The duration used to request detailed NFT stats."""
  duration: DetailedNftStatsDuration!
  """The unix timestamp for the start of the window."""
  start: Int!
  """The unix timestamp for the end of the window."""
  end: Int!
  """The list of start/end timestamps broken down for each bucket within the window."""
  timestamps: [DetailedNftStatsBucketTimestamp]!
  """The currency stats in USD, such as volume."""
  statsUsd: WindowedDetailedNftCurrencyStats!
  """The currency stats in the network's base token, such as volume."""
  statsNetworkBaseToken: WindowedDetailedNftCurrencyStats!
  """The numerical stats, such as number of buyers."""
  statsNonCurrency: WindowedDetailedNftNonCurrencyStats!
}

WindowedDetailedNonCurrencyPairStats

Numerical stats for a pair over a time frame.

transactions
DetailedPairStatsNumberMetrics

The transaction count over the time frame.

buys
DetailedPairStatsNumberMetrics

The number of buys over the time frame.

sells
DetailedPairStatsNumberMetrics

The number of sells over the time frame.

traders
DetailedPairStatsNumberMetrics

The number of unique traders over the time frame.

buyers
DetailedPairStatsNumberMetrics

The number of unique buyers over the time frame.

sellers
DetailedPairStatsNumberMetrics

The number of unique sellers over the time frame.

"""Numerical stats for a pair over a time frame."""
type WindowedDetailedNonCurrencyPairStats {
  """The transaction count over the time frame."""
  transactions: DetailedPairStatsNumberMetrics
  """The number of buys over the time frame."""
  buys: DetailedPairStatsNumberMetrics
  """The number of sells over the time frame."""
  sells: DetailedPairStatsNumberMetrics
  """The number of unique traders over the time frame."""
  traders: DetailedPairStatsNumberMetrics
  """The number of unique buyers over the time frame."""
  buyers: DetailedPairStatsNumberMetrics
  """The number of unique sellers over the time frame."""
  sellers: DetailedPairStatsNumberMetrics
}

WindowedDetailedNonCurrencyWalletStats

The non-currency stats for a wallet over a time window.

swaps
Int!
required

The number of swaps

uniqueTokens
Int!
required

The number of unique tokens

wins
Int!
required

The number of wins

losses
Int!
required

The number of losses

"""The non-currency stats for a wallet over a time window."""
type WindowedDetailedNonCurrencyWalletStats {
  """The number of swaps"""
  swaps: Int!
  """The number of unique tokens"""
  uniqueTokens: Int!
  """The number of wins"""
  wins: Int!
  """The number of losses"""
  losses: Int!
}

WindowedDetailedPairStats

Detailed pair stats over a time frame.

duration
DetailedPairStatsDuration!
required

The duration used to request detailed pair stats.

start
Int!
required

The unix timestamp for the start of the window.

end
Int!
required

The unix timestamp for the end of the window.

timestamps
[DetailedPairStatsBucketTimestamp]!
required

The list of start/end timestamps broken down for each bucket within the window.

statsUsd
WindowedDetailedCurrencyPairStats!
required

The currency stats in USD, such as volume.

statsNonCurrency
WindowedDetailedNonCurrencyPairStats!
required

The numerical stats, such as number of buyers.

"""Detailed pair stats over a time frame."""
type WindowedDetailedPairStats {
  """The duration used to request detailed pair stats."""
  duration: DetailedPairStatsDuration!
  """The unix timestamp for the start of the window."""
  start: Int!
  """The unix timestamp for the end of the window."""
  end: Int!
  """The list of start/end timestamps broken down for each bucket within the window."""
  timestamps: [DetailedPairStatsBucketTimestamp]!
  """The currency stats in USD, such as volume."""
  statsUsd: WindowedDetailedCurrencyPairStats!
  """The numerical stats, such as number of buyers."""
  statsNonCurrency: WindowedDetailedNonCurrencyPairStats!
}

WindowedDetailedStats

Detailed stats over a window.

windowSize
DetailedStatsWindowSize!
required

The window size used to request detailed stats.

timestamp
Int!
required

The unix timestamp for the start of the window.

endTimestamp
Int!
required

The unix timestamp for the end of the window.

buckets
[DetailedStatsBucketTimestamp]!
required

The list of start/end timestamps broken down for each bucket within the window.

transactions
DetailedStatsNumberMetrics!
required

The transaction count over the window.

volume
DetailedStatsStringMetrics!
required

The volume over the window.

buys
DetailedStatsNumberMetrics!
required

The number of buys over the window.

sells
DetailedStatsNumberMetrics!
required

The number of sells over the window.

buyers
DetailedStatsNumberMetrics!
required

The number of unique buyers over the window.

sellers
DetailedStatsNumberMetrics!
required

The number of unique sellers over the window.

traders
DetailedStatsNumberMetrics

The number of unique traders over the window.

buyVolume
DetailedStatsStringMetrics

The buy volume over the window.

sellVolume
DetailedStatsStringMetrics

The sell volume over the window.

"""Detailed stats over a window."""
type WindowedDetailedStats {
  """The window size used to request detailed stats."""
  windowSize: DetailedStatsWindowSize!
  """The unix timestamp for the start of the window."""
  timestamp: Int!
  """The unix timestamp for the end of the window."""
  endTimestamp: Int!
  """The list of start/end timestamps broken down for each bucket within the window."""
  buckets: [DetailedStatsBucketTimestamp]!
  """The transaction count over the window."""
  transactions: DetailedStatsNumberMetrics!
  """The volume over the window."""
  volume: DetailedStatsStringMetrics!
  """The number of buys over the window."""
  buys: DetailedStatsNumberMetrics!
  """The number of sells over the window."""
  sells: DetailedStatsNumberMetrics!
  """The number of unique buyers over the window."""
  buyers: DetailedStatsNumberMetrics!
  """The number of unique sellers over the window."""
  sellers: DetailedStatsNumberMetrics!
  """The number of unique traders over the window."""
  traders: DetailedStatsNumberMetrics
  """The buy volume over the window."""
  buyVolume: DetailedStatsStringMetrics
  """The sell volume over the window."""
  sellVolume: DetailedStatsStringMetrics
}

WindowedWalletStats

The stats for a wallet over a time window.

walletAddress
String!
required

The wallet address

networkId
Int

The network ID

start
Int!
required

The start timestamp

end
Int!
required

The end timestamp

lastTransactionAt
Int!
required

The last transaction timestamp

statsUsd
WindowedDetailedCurrencyWalletStats!
required

The stats related to currency

statsNonCurrency
WindowedDetailedNonCurrencyWalletStats!
required

The stats related to non-currency

"""The stats for a wallet over a time window."""
type WindowedWalletStats {
  """The wallet address"""
  walletAddress: String!
  """The network ID"""
  networkId: Int
  """The start timestamp"""
  start: Int!
  """The end timestamp"""
  end: Int!
  """The last transaction timestamp"""
  lastTransactionAt: Int!
  """The stats related to currency"""
  statsUsd: WindowedDetailedCurrencyWalletStats!
  """The stats related to non-currency"""
  statsNonCurrency: WindowedDetailedNonCurrencyWalletStats!
}