AddEventsByMakerOutput
Response returned by onEventsCreatedByMaker.The address of the maker.
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.The contract address of the pair.
The network ID that the token is deployed on.
The ID of the event (address:networkId). For example, 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2:1.
The token of interest within the pair. Can be token0 or token1.
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.The contract address of the NFT collection.
The network ID the collection is deployed on.
The id of the collection (address:networkId).
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."""Response returned by `onNftPoolEventsCreated`."""
type AddNftPoolEventsOutput {
collectionAddress: String!
exchangeAddress: String!
poolAddress: String!
networkId: Int!
id: String!
events: [NftPoolEvent]!
}
AddTokenEventsOutput
Response returned by onTokenEventsCreated.The ID of the event (address:networkId). For example, 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2:1.
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.events
[TokenLifecycleEvent!]!
required
"""Response returned by `onTokenLifecycleEventsCreated`."""
type AddTokenLifecycleEventsOutput {
id: String!
events: [TokenLifecycleEvent!]!
}
AddUnconfirmedEventsByMakerOutput
Response returned by onUnconfirmedEventsCreatedByMaker.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.The contract address of the pair.
The network ID that the token is deployed on.
The ID of the event (address:networkId). For example, 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2:1.
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
Unique identifier for the token
JWT to be passed into the Authorization header for API requests
ISO time string for the expiry of the token
Number of root fields this api token is allowed to resolve before it’s rate limited
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
}
ArenaTradeData
Protocol specific token ID
type ArenaTradeData {
"""Protocol specific token ID"""
tokenId: String
type: String!
}
Balance
Wallet balance of a token.The ID of the wallet (walletAddress:networkId).
The ID of the token (tokenAddress:networkId).
The contract address of the token.
The balance held by the wallet.
The balance held by the wallet, adjusted by the number of decimals in the token.
The balance held by the wallet in USD.
The time that this address first held a 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
The list of token balances that a wallet has.
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.The volume.This field is deprecated. Use volume field instead
The timestamp for the bar.
The status code for the batch: ok for successful data retrieval and no_data for empty responses signaling the end of server data.
The volume with higher precision.
The volume in the native token for the network
The number of unique buyers
The number of unique sellers
The number of transactions
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.The amount of token0 removed from the pair.
The amount of token1 removed from the pair.
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.
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.
The lower tick boundary of the position. Only applicable for UniswapV3 events.
The upper tick boundary of the position. Only applicable for UniswapV3 events.
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."""The chart url."""
type ChartUrl {
"""The chart url."""
url: String!
}
ChartUrlsResponse
The response type for a chart url query."""The response type for a chart url query."""
type ChartUrlsResponse {
"""The pair chart url."""
pair: ChartUrl!
}
Community gathered proposals for an asset.The contract address of the contract.
The contract after the community note was applied.
The ID of the contract (address:id).
The unix timestamp of when the community note was moderated.
The network ID the contract is deployed on.
The contract before the community note was applied.
The data of the community note.
The ordinal number of the community note.
proposalType
CommunityNoteType!
required
The type of the community note.
The unix timestamp of when the community note was created.
status
ContractProposalStatus!
required
The status of the community note.
"""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!
}
Community notes data.items
[CommunityNote!]!
required
The list of community notes matching the filter parameters.
The number of community notes returned.
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.Greater than or 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.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.The list of price webhooks that were created.
The list of token pair event webhooks that were created.
The list of NFT event webhooks that were created.
The list of raw transaction webhooks that were created.
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.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.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.The contract address of the NFT collection.
The network ID the NFT collection is deployed on.
The marketplace address or all. Can be used to get marketplace-specific metrics.
The breakdown of stats over an hour window.
The breakdown of stats over a 4 hour window.
The breakdown of stats over a 12 hour window.
The breakdown of stats over a 24 hour window.
The breakdown of stats over a 7 day window.
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.The unix timestamp for the start of the window.
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.The percent change between the currentValue and previousValue.
The total value for the most recent duration.
The total value for the previous duration.
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.The percent change between the currentValue and previousValue.
The total value for the most recent duration.
The total value for the previous duration.
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.The contract address of the pair.
The network ID the pair is deployed on.
The token of interest used to calculate token-specific stats.
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.
Number of aggregated buckets specified in input
The timestamp specified as input to the query
"""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.The unix timestamp for the start of the bucket.
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.The percent change between the currentValue and previousValue. Decimal format.
The total value for the most recent duration.
The total value for the previous duration.
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.The percent change between the currentValue and previousValue. Decimal format.
The total value for the most recent duration.
The total value for the previous duration.
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.The ID of the pair (pairAddress:networkId).
The token of interest used to calculate token-specific stats.
statsType
TokenPairStatisticsType!
required
The type of statistics returned. Can be FILTERED or UNFILTERED
The breakdown of stats over a 5 minute window.
The breakdown of stats over an hour window.
The breakdown of stats over a 4 hour window.
The breakdown of stats over a 12 hour window.
The breakdown of stats over a 24 hour window.
Number of aggregated buckets specified in input
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.The unix timestamp for the start of the bucket.
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.The percent change between the currentValue and previousValue. Decimal format.
The total value for the most recent window.
The total value for the previous window.
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.The percent change between the currentValue and previousValue. Decimal format.
The total value for the most recent window.
The total value for the previous window.
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.The last transaction timestamp
The network specific statsThis field is deprecated. Use networkBreakdown instead
The labels associated with the wallet
The likelihood of the wallet being a scammer
The likelihood of the wallet being a bot
The stats for the last day
The stats for the last week
The stats for the last 30 days
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.The ID of the NFT collection (address:networkId).
The contract address of the NFT collection.
The network ID the NFT collection is deployed on.
The token standard. Can be a variation of ERC-721 or ERC-1155.
The name of the NFT collection.
The description of the NFT collection.
The symbol of the NFT collection.
The total supply of the NFT collection.
Community gathered links for the socials of this NFT collection.
The URL for an image of the NFT collection.
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.The contract address of the token.
The token ID on CoinMarketCap.
The precision to which the token can be divided. For example, the smallest unit for USDC is 0.000001 (6 decimals).
The ID of the token (address:networkId).
Whether the token has been flagged as a scam.
The token name. For example, ApeCoin.
The network ID the token is deployed on.
The token symbol. For example, APE.
The total supply of the token.This field is deprecated. Use the TokenInfo type
Community gathered links for the socials of this token.
More metadata about the token.
Information about the token from 3rd party sources.This field is deprecated. Use the TokenInfo type
A list of exchanges where the token has been traded.
The thumbnail token logo URL.This field is deprecated. Use the TokenInfo type
The small token logo URL.This field is deprecated. Use the TokenInfo type
The large token logo URL.This field is deprecated. Use the TokenInfo type
The circulating supply of the token.This field is deprecated. Use the TokenInfo type
The amount of this token in the pair.This field is deprecated. Pooled can be found on the pair instead
The token creator’s wallet address.
The block height the token was created at.
The transaction hash of the token’s creation.
The unix timestamp for the creation of the token.
Whether or not the token is mintable
Whether or not the token is freezable
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.The contract address of the token’s top pair.
The price of the network’s base token.
The hash of the block where the transaction occurred.
The block number for the transaction.
The event-specific data for the transaction. Can be BurnEventData or MintEventData or SwapEventData.
The type of transaction event. Can be Burn, Mint, Swap, Sync, Collect, or CollectProtocol.
The ID of the event (address:networkId). For example, 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2:1.
The contract address of the token with higher liquidity in the token’s top pair.
The index of the log in the block.
The wallet address that performed the transaction.
The network ID that the token is deployed on.
The token of interest within the token’s top pair. Can be token0 or token1.
The unix timestamp for when the transaction occurred.
The address of the event’s token0.
The address of the event’s token1.
The price of token0 paid/received in USD, including any fees.
The price of token1 paid/received in USD, including any fees.
The price of token0 paid/received in the network’s base token, including fees.
The price of token1 paid/received in the network’s base token, including fees.
The updated price of token0 in USD, calculated after the transaction.
The updated price of token1 in USD, calculated after the transaction.
The unique hash for the transaction.
The index of the transaction within the block.
A more specific breakdown of eventType. Splits Swap into Buy or Sell.
Labels attributed to the event.
The age of the wallet in seconds.
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.A list of transactions for a token’s top pair.
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.Specific data for the event label type.
The ID of the pair (address:networkId).
The index of the log in the block.
The network ID the pair is deployed on.
The unix timestamp for the transaction.
The index of the transaction within the block.
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.A list of event labels for a pair.
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.The contract address of the exchange.
The hex string for the exchange color.
The ID of the exchange (address:id).
The name of the exchange.
The version of the exchange, if applicable.
The network ID the exchange is deployed on.
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.The list of exchanges matching the filter parameters.
The number of exchanges returned.
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.The number of transactions on the exchange in the past hour.
The number of transactions on the exchange in the past 4 hours.
The number of transactions on the exchange in the past 12 hours.
The number of transactions on the exchange in the past 24 hours.
The trade volume in USD in the past hour.
The trade volume in USD in the past 4 hours.
The trade volume in USD in the past 12 hours.
The trade volume in USD in the past 24 hours.
The trade volume in the network’s base token in the past hour.
The trade volume in the network’s base token in the past 4 hours.
The trade volume in the network’s base token in the past 12 hours.
The trade volume in the network’s base token in the past 24 hours.
The total unique daily active users.
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.The ID of the token (address:networkId).
Whether the token has been verified on CoinGecko.
A description of the token.
The precision to which the token can be divided.
"""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.The address for the exchange factory contract.
The ID of the exchange (address:networkId).
The name of the exchange.
The version of the exchange. For example, 3 for UniswapV3.
The URL for the exchange’s icon.
The network ID the factory is deployed on.
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.The index of the front-run label. Can be 0 or 1.
The amount of token0 drained in the attack.
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.The network trade volume in USD over the past 24 hours.
The network trade volume in USD over the past 12 hours.
The network trade volume in USD over the past 4 hours.
The network trade volume in USD over the past hour.
The network trade volume in USD over the past 5 minutes.
The network trade volume change over the last 24 hours
The network trade volume change over the last 12 hours
The network trade volume change over the last 4 hours
The network trade volume change over the last hour
The network trade volume change over the last 5 minutes
The network liquidity in USD.
The unique number of transactions in the past 24 hours.
The unique number of transactions in the past 12 hours.
The unique number of transactions in the past 4 hours.
The unique number of transactions in the past hour.
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.
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.
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
}
GetWebhooksResponse
Response returned by getWebhooks.A list of webhooks belonging to a user.
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.The list of wallets holding the token.
The unique count of holders for the token.
A cursor for use in pagination.
Status of holder. Disabled if on unsupported network or there is insufficient holder data.
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.The number of different wallets holding the token.
The ID of the token (tokenAddress:networkId).
The token’s contract address.
The network ID that the token is deployed on.
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.The timestamp for the bar.
The volume with higher precision.
The volume in the network’s base token
The number of unique buyers
The number of unique sellers
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."""Integer equals condition."""
type IntEqualsCondition {
"""The integer to equal."""
eq: Int!
}
LabelsForEvent
Event labels. Can be sandwich or washtrade."""Event labels. Can be `sandwich` or `washtrade`."""
type LabelsForEvent {
sandwich: SandwichLabelForEvent
washtrade: WashtradeLabelForEvent
}
LatestPair
Metadata for a newly listed pair.The contract address for the pair.
The contract address for the exchange.
The ID of the pair (address:networkId).
The listing price, or first known price for the pair, in USD.
The unix timestamp for when liquidity was added to the pair.
The total liquidity in the pair.
The token with higher liquidity within the pair. Can be token0 or token1.
The network ID the pair is deployed on.
The newly added token within the pair. Can be token0 or token1.
The token with lower liquidity within the pair. Can be token0 or token1.
The pre-existing token within the pair. Can be token0 or token1.
The percent price change between the listing price and the current price.
The newly added token price in USD.
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.A list of newly listed pairs.
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.The contract address for the token.
The amount of token currently in the pair.
The precision to which the token can be divided. For example, the smallest unit for USDC is 0.000001 (6 decimals).
The ID of the token (address:networkId).
The initial amount of token added to the pair.
The network ID the token is deployed on.
The ID of the pair (pairAddress:networkId).
The percent change token remaining in the pair since the initial add.
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.The id of the new token. (tokenAddress:networkId)
The contract address of the new token.
The network ID the token is deployed on.
The block number of the token contract’s creation.
The index of the transaction within the block.
The index of the trace within the token contract’s creation transaction.
The unique hash for the token contract’s creation transaction.
The unique hash for the token contract’s creation block.
The unix timestamp for the creation of the token.
The address of the token creator.
The token creator’s network token balance.
The total supply of the token.
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.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.Whether or not a token was able to be succesfully bought during simulation.
Tax paid for a buy transaction during simulation.
Gas used for a buy transaction during simulation.
The maximum token amount an address can buy during simulation.
Whether or not a token was able to be succesfully sold during simulation.
Tax paid for a sell transaction during simulation.
Gas used for a sell transaction during simulation.
The maximum token amount an address can sell during simulation.
Whether or not the contract ownership was able to be transferred during simulation.
Whether or not the contract ownership was able to be renounced during simulation.
Whether or not the contract ownership is already renounced during simulation (owner is 0x0).
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
The name of the launchpad.This field is deprecated. Use launchpadName instead
The name of the launchpad. One of the following: Pump.fun, Bonk, Baseapp, Zora, Zora Creator, Four.meme, Believe, Moonshot, Jupiter Studio, boop, ArenaTrade, Moonit, LaunchLab, MeteoraDBC, Vertigo, Cooking.City, time.fun, BAGS, Circus, Dealr, OhFuckFun, PrintFun, Trend, shout.fun, xApple, Sendshot, DubDub, cults.
The percentage of the pool that was sold to the public.
The unix timestamp when the launchpad was completed.
Indicates if the launchpad is completed.
The slot number when the launchpad was completed.
The slot number when the launchpad was migrated.
The unix timestamp when the launchpad was migrated.
Indicates if the launchpad was migrated.
The pool address after the launchpad was migrated.
The icon URL of the launchpad.
type LaunchpadData {
"""The name of the launchpad."""
name: String @deprecated(reason: "Use launchpadName instead")
"""The name of the launchpad. One of the following: Pump.fun, Bonk, Baseapp, Zora, Zora Creator, Four.meme, Believe, Moonshot, Jupiter Studio, boop, ArenaTrade, Moonit, LaunchLab, MeteoraDBC, Vertigo, Cooking.City, time.fun, BAGS, Circus, Dealr, OhFuckFun, PrintFun, Trend, shout.fun, xApple, Sendshot, DubDub, cults."""
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
"""The icon URL of the launchpad."""
launchpadIconUrl: String
}
LaunchpadTokenEventOutput
Response returned by onLaunchpadTokenEvent.The contract address of the token.
The network ID that the token is deployed on.
The protocol of the token.
The name of the launchpad. One of the following: Pump.fun, Bonk, Baseapp, Zora, Zora Creator, Four.meme, Believe, Moonshot, Jupiter Studio, boop, ArenaTrade, Moonit, LaunchLab, MeteoraDBC, Vertigo, Cooking.City, time.fun, BAGS, Circus, Dealr, OhFuckFun, PrintFun, Trend, shout.fun, xApple, Sendshot, DubDub, cults.
The number of buys in the last 24 hours.
eventType
LaunchpadTokenEventType!
required
The type of event.
The market cap of the token.
The number of sells in the last 24 hours.
The volume of the token in the last 24 hours.
The number of transactions in the last 24 hours.
The liquidity of the token’s top pair.
"""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!
"""The name of the launchpad. One of the following: Pump.fun, Bonk, Baseapp, Zora, Zora Creator, Four.meme, Believe, Moonshot, Jupiter Studio, boop, ArenaTrade, Moonit, LaunchLab, MeteoraDBC, Vertigo, Cooking.City, time.fun, BAGS, Circus, Dealr, OhFuckFun, PrintFun, Trend, shout.fun, xApple, Sendshot, DubDub, cults."""
launchpadName: 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
"""The liquidity of the token's top pair."""
liquidity: String
}
LiquidityData
Data about liquidity in a pair.The active liquidity in the pair.
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.The network ID the pair is deployed on.
The wallet address of the owner.
The address of the locker contract.
The unix timestamp for when the lock was created.
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 pairThis field is deprecated. Use liquidityProtocolV2 instead
The protocol that created the pair
The amount of liquidity locked.
The inital amount of token0 locked.
The inital amount of token1 locked.
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.
The amount of liquidity locked in USD.
The amount of tokens locked in the protocol.
amountLockedTokensShifted
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.
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
}
Metadata about a pair’s liquidity. Includes locked liquidity data.lockedLiquidity
LockedLiquidityData!
required
Data about locked liquidity.
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!
}
Metadata about a token’s liquidity. Includes locked liquidity data for up to 100 pairs that the token is in.The address of the token.
The network ID the token is deployed on.
The total liquidity in USD.
The locked liquidity in USD.
The total amount of tokens in pairs.
totalTokenLiquidityShifted
The total amount of tokens in pairs shifted by number of decimals the token has.
The locked amount of tokens in pairs.
lockedTokenLiquidityShifted
The locked amount of tokens in pairs shifted by number of decimals the token has.
lockedLiquidityPercentage
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.The tokenId of the liquidity position nft.
nftPositionManagerAddress
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.The volume for the pair in USD.
The total liquidity in the pair.
Metadata for token with higher liquidity within the pair.
Metadata for token with lower liquidity within the pair.
Exchange metadata for the pair.
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.
The amount of active liquidity locked.
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.The amount of active liquidity locked.
The amount of inactive liquidity locked.
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.A list of transactions for a token’s top pair.
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.
The market cap condition that must be met in order for the webhook to send.
The circulating market cap condition that must be met in order for the webhook to send.
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
}
The status for a network supported on Defined.The last processed block on the network.
The unix timestamp for the last processed block on 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.The amount of token0 added to the pair.
The amount of token1 added to the pair.
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.
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.
The lower tick boundary of the position. Only applicable for UniswapV3 events.
The upper tick boundary of the position. Only applicable for UniswapV3 events.
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.The name of the network. For example, arbitrum.
The network ID. For example, 42161 for arbitrum.
"""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.The stats for the last day
The stats for the last week
The stats for the last 30 days
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.
The number of wallets returned.
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.The network ID of the wallet
The unix timestamp for the first transaction from this wallet
The unix timestamp for the last transaction from this wallet
The native token balance of the wallet
The labels associated with the wallet
Volume in USD in the past day
Total volume in USD in the past day including all tokens
Realized profit in USD in the past day
averageProfitUsdPerTrade1d
Average profit in USD per trade in the past day
Average swap amount in USD in the past day
realizedProfitPercentage1d
Realized profit percentage in the past day
Number of swaps in the past day
Total number of swaps in the past day including all tokens
Number of unique tokens traded in the past day
Volume in USD in the past week
Total volume in USD in the past week including all tokens
Realized profit in USD in the past week
averageProfitUsdPerTrade1w
Average profit in USD per trade in the past week
Average swap amount in USD in the past week
realizedProfitPercentage1w
Realized profit percentage in the past week
Number of swaps in the past week
Total number of swaps in the past week including all tokens
Number of unique tokens traded in the past week
Win rate in the past week
Volume in USD in the past 30 days
Total volume in USD in the past 30 days including all tokens
Realized profit in USD in the past 30 days
averageProfitUsdPerTrade30d
Average profit in USD per trade in the past 30 days
Average swap amount in USD in the past 30 days
realizedProfitPercentage30d
Realized profit percentage in the past 30 days
Number of swaps in the past 30 days
Total number of swaps in the past 30 days including all tokens
Number of unique tokens traded in the past 30 days
Win rate in the past 30 days
Volume in USD in the past year
Total volume in USD in the past year including all tokens
Realized profit in USD in the past year
averageProfitUsdPerTrade1y
Average profit in USD per trade in the past year
Average swap amount in USD in the past year
realizedProfitPercentage1y
Realized profit percentage in the past year
Number of swaps in the past year
Total number of swaps in the past year including all tokens
Number of unique tokens traded in the past year
Win rate in the past year
The scammer score for the wallet.
The bot score for the wallet.
backfillState
WalletAggregateBackfillState
The backfill state of 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
"""The backfill state of the wallet."""
backfillState: WalletAggregateBackfillState
}
NetworkWalletStats
Native token balance for a wallet on a network."""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.
The network ID the NFT collection is deployed on.
The contract address of the NFT pool.
The contract address of the NFT collection.
The contract address of the liquidity token of the pool (usually WETH).
The wallet address of the pool owner.
The wallet address that will receive the tokens or NFT sent to the pair during swaps.
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.
The initial delta used in the bonding curve.
The pool fee amount in the pool’s liquidity token.
The initial spot price in the pool’s liquidity token.
The initial price at which the pool is willing to buy an NFT in the pool’s liquidity token.
The initial price at which the pool is willing to sell an NFT in the pool’s liquidity token.
The unix timestamp for the time the pool was created.
The number of NFTs in the contract after the block has processed.
The amount of token in the contract after the block has processed in the pool’s liquidity token.
The ratio of the transaction token to the network’s base token.
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.
The network ID the NFT collection is deployed on.
The contract address of the NFT pool.
The contract address of the NFT collection.
The contract address of the liquidity token of the pool (usually WETH).
The wallet address of the pool owner.
The wallet address that will receive the tokens or NFT sent to the pair during swaps.
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.
The initial delta used in the bonding curve.
The pool fee amount in the pool’s liquidity token.
The initial spot price in the pool’s liquidity token.
The initial price at which the pool is willing to buy an NFT in the pool’s liquidity token.
The initial price at which the pool is willing to sell an NFT in the pool’s liquidity token.
The unix timestamp for the time the pool was created.
The amount of token in the contract after the block has processed in the pool’s liquidity token.
The ratio of the transaction token to the network’s base token.
The ratio of the transaction token to USD.
The list of NFT token IDs initially deposited.
The amount of each NFT token initially deposited.
New Param: The list of NFT assets withdrawn. More extensive info than nftTokenIds.
The type of NFT in the pool.
The list of royalties for the pool. Only applicable for SUDOSWAP_V2 pools.
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.The ID of the NFT asset (address:networkId).
The contract address of the NFT collection.
The token ID of the NFT asset.
The network ID the NFT collection is deployed on.
The name of the NFT asset.
The description of the NFT asset.
The source image URI linked by smart contract metadata.
The URI provided by the smart contract. Typically JSON that contains metadata.
The attributes for the NFT asset.
The number of NFT assets with the same NFT token ID. Only applicable for ERC1155 tokens.
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.Suggested class name to use for css styling. An optional attribute of ERC-1155 assets.
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.
The max value, if applicable.
The name of the attribute.
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.The ID of the NFT asset (address:networkId).
The contract address of the NFT collection.
The token ID of the NFT asset.
The network ID the NFT collection is deployed on.
status
NftAssetErrorStatus!
required
The status of the asset error.
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!
}
NFT asset media.The URL for a full size image of the NFT asset.
The URL for small generated thumbnail of the NFT asset.
The URL for large generated thumbnail of the NFT asset.
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.A list of errors encountered while fetching the NFT assets. Errors correspond to null values in items by array index.
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.The address of the wallet.
The ID of the collection (collectionAddress:networkId).
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.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
The average sale price in the time frame.
The opening price for the time frame.
The closing price for the time frame.
The lowest sale price in the time frame.
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.The marketplace that filled the NFT order volume. (ex. OPENSEA, BLUR, etc.)
The amount of the stat traded in the current time frame.
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.The marketplace that filled the NFT order volume. (ex. OPENSEA, BLUR, etc.)
The amount of the stat traded in the current time frame.
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.
The number of NFT collections returned.
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.The ID of the NFT collection (address:networkId).
The contract address of the NFT collection.
The marketplace address or all. Can be used to get marketplace-specific metrics.
The network ID the NFT collection is deployed on.
The name of the NFT collection.
The symbol of the NFT collection.
The unix timestamp for the last event.
The token standard. Can be a variation of ERC-721 or ERC-1155.
The image URL for the collection or one of the assets within the collection.
The total supply of the NFT collection.
The unix timestamp indicating the last time the data was updated. Updates daily.
Stats for the past 4 hours.
Stats for the past 12 hours.
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
}
Response returned by getNftCollectionMetadata.The ID of the NFT collection (address:networkId).
Metadata for the NFT collection.
stats
[NftCollectionWindowStats]
A list of stats for the NFT collection across different time frames.
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.The number of mints over the time frame.
The number of sales over the time frame.
The number of tokens sold over the time frame.
The number of transfers over the time frame.
The number of unique buyers over the time frame.
The number of unique sellers over the time frame.
The number of unique wallets (buyers or sellers) over the time frame.
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.The change in volume between the previous and current time frame.
The change in floor price between the previous and current time frame.
The change in average price between the previous and current time frame.
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.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.
The trade count over the window.
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.The ID of the NFT collection (address:networkId).
The contract address of the NFT collection.
The network ID the NFT collection is deployed on.
The token standard. Can be a variation of ERC-721 or ERC-1155.
The name of the NFT collection.
The description of the NFT collection.
The symbol for the NFT collection.
The total supply of the NFT collection.
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.The ID of the NFT event (contractAddress:tokenId:networkId).
The contract address of the NFT collection.
The network ID the NFT collection is deployed on.
The token ID of the NFT asset involved in the transaction.
The wallet address of the buyer.
The wallet address of the seller.
This field is deprecated. Some events may lack this value - use the nullable totalTradePrice. tokenPrice will return null values as an empty string.
This field is deprecated. 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).
This field is deprecated. Some events may lack this value - use the nullable individualTradePrice. individualTokenPrice will return null values as an empty string.
This field is deprecated. 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.
This field is deprecated. No longer supported
The contract address of the purchasing token.
This field is deprecated. No longer supported
The total trade price for the transaction in USD. (The transaction can include more than 1 token).
This field is deprecated. No longer supported
The price of each individual NFT in USD.
This field is deprecated. No longer supported
totalPriceNetworkBaseToken
The total trade price for the transaction in the network’s base token. (The transaction can include more than 1 token).
individualNetworkBaseTokenPrice
This field is deprecated. No longer supported
individualPriceNetworkBaseToken
The price of each individual NFT in the network’s base token.
The event type of the transaction.
The NFT marketplace address of the transaction.
The sortKey for the event (blockNumber#transactionIndex#logIndex (+ #marketplaceEventLogIndex if applicable), zero padded). For example, 0000000016414564#00000224#00000413#00000414.
The block number for the transaction.
The index of the transaction within the block.
The index of the log in the block.
The unique hash for the transaction.
The unix timestamp for the transaction.
The number of assets involved in the transaction.
The contract address of the marketplace aggregator that routed the transaction.
The contract address of the NFT pool, if applicable.
The name of the marketplace that processed the transaction.
The reason for the price error, if applicable. Can be NO_TOKEN_DATA, NO_TOKEN_PRICE, or LOW_LIQUIDITY_PAIR.
The tokens/NFTs that were offered to make this transaction occur.
The tokens/NFTs that were received in this transaction.
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.The contract address for the NFT.
The number of tokens transferred. (Always 1 for ERC721 NFTs)
The recipient of the NFT.
type
NftEventTradeItemType!
required
The type of item involved in the trade. (Always NFT)
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.A list of transactions for an NFT collection.
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.The contract address for the token.
The number of tokens transferred.
The recipient of the tokens.
type
NftEventTradeItemType!
required
The type of item involved in the trade. (Always TOKEN)
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.
The total trade price for the transaction in the purchasing token. (The transaction can include more than 1 token).
The price of each individual NFT in the purchasing token.
The total trade price for the transaction in USD. (The transaction can include more than 1 token).
The price of each individual NFT in USD.
totalPriceNetworkBaseToken
The total trade price for the transaction in the network’s base token. (The transaction can include more than 1 token).
individualPriceNetworkBaseToken
The price of each individual NFT in the network’s base token.
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.The list of network IDs the webhook is listening on.
The maker wallet address the webhook is listening for.
The NFT collection contract address the webhook is listening for.
The exchange contract address the webhook is listening for.
The token ID the webhook is listening for.
The token contract address the webhook is listening for.
The base token price the webhook is listening for.
The NFT event type the webhook is listening for.
fillSource
NftEventFillSourceCondition
The NFT marketplaces the webhook is listening on.
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.Marketplace that filled the NFT order volume. (ex. OPENSEA, BLUR, etc.)
The total value for the current window.
The total value for the previous window.
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.Marketplace that filled the NFT order volume. (ex. OPENSEA, BLUR, etc.)
The total value for the current window.
The total value for the previous window.
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
The list wallets for a collection.
the unique count of holders for the collection.
A cursor for use in pagination.
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.
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.
The number of NFT collections returned.
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.The ID of the NFT collection (collectionAddress:exchangeAddress:networkId).
The unix timestamp indicating the last time the data was updated. Updates every 2 hours.
The name of the NFT collection.
The symbol for the NFT collection.
The contract address of the NFT AMM marketplace.
The contract address of the NFT collection.
The network ID the NFT collection is deployed on.
The token standard. Can be a variation of ERC-721 or ERC-1155.
The image URL for the collection or one of the assets within the collection.
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.
The number of NFTs in all of the collection’s pools.
The total liquidity of the collection in the network’s base token.
The lowest price at which any of the collection’s pools are willing to sell an NFT in the network’s base token.
The highest price at which any of the collection’s pools are willing to buy an NFT in the network’s base token.
The total liquidity of the collection in USD.
The lowest price at which any of the collection’s pools are willing to sell an NFT in USD.
The highest price at which any of the collection’s pools are willing to buy an NFT in USD.
The total supply of the collection.This field is deprecated. totalSupply is changing from Int to String - use totalSupplyV2 instead.
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.
The number of NFTs sold in any of the collection’s pools over the collection’s lifetime.
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.
The number of NFTs bought in any of the collection’s pools over the collection’s lifetime.
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.
The number of NFTs bought or sold in any of the collection’s pools over the collection’s lifetime.
The total volume of the collection in the network’s base token over the collection’s lifetime.
The total buy volume of the collection in the network’s base token over the collection’s lifetime.
The total sell volume of the collection in the network’s base token over the collection’s lifetime.
The highest sale price within the collection in the network’s base token in the collection’s lifetime.
The lowest sale price within the collection in the network’s base token in the collection’s lifetime.
The sum of pool fees generated by the collection in the network’s base token over the collection’s lifetime.
The sum of protocol fees generated by the collection in the network’s base token over the collection’s lifetime.
The total volume of the collection in USD over the collection’s lifetime.
The total buy volume of the collection in USD over the collection’s lifetime.
The total sell volume of the collection in USD over the collection’s lifetime.
The highest sale price within the collection in USD in the collection’s lifetime.
The lowest sale price within the collection in USD in the collection’s lifetime.
The sum of pool fees generated by the collection in USD over the collection’s lifetime.
The sum of protocol fees generated by the collection in USD over the collection’s lifetime.
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.
The number of NFTs sold in any of the collection’s pools over the past 24 hours.
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.
The number of NFTs bought in any of the collection’s pools over the past 24 hours.
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.
The number of NFTs bought and sold in any of the collection’s pools over the past 24 hours.
The total volume of the collection in the network’s base token over the past 24 hours.
The total buy volume of the collection in the network’s base token over the past 24 hours.
The total sell volume of the collection in the network’s base token over the past 24 hours.
The highest sale price within the collection in the network’s base token in the past 24 hours.
The lowest sale price within the collection in the network’s base token in the past 24 hours.
The sum of pool fees generated by the collection in the network’s base token over the past 24 hours.
The sum of protocol fees generated by the collection in the network’s base token over the past 24 hours.
The total volume of the collection in USD over the past 24 hours.
The total buy volume of the collection in USD over the past 24 hours.
The total sell volume of the collection in USD over the past 24 hours.
The highest sale price within the collection in USD in the past 24 hours.
The lowest sale price within the collection in USD in the past 24 hours.
The sum of pool fees generated by the collection in USD over the past 24 hours.
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.The ID of the NFT collection (collectionAddress:networkId).
The contract address of the NFT collection.
The symbol of the NFT collection.
The ID of the exchange (exchangeAddress:networkId).
The contract address of the NFT AMM marketplace.
The name of the NFT collection.
An image associated with the NFT collection.
The network ID the NFT collection is deployed on.
The lowest price at which any of the NFT collection’s pools are willing to sell an NFT in the network’s base token.
The highest price at which any of the NFT collection’s pools are willing to buy an NFT in the network’s base token.
The total liquidity of the collection in the network’s base token.
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.
The current number of NFTs in all the NFT collection’s pools.
The total volume of the collection in the network’s base token over the collection’s lifetime.
The total volume of the collection in USD over the collection’s lifetime.
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.
The total number of NFTs bought and sold over the collection’s lifetime.
The media for one of the assets within the NFT collection.This field is deprecated. 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.
The sum of protocol fees generated by the collection in USD over the collection’s lifetime.
The sum of pool fees generated by the collection in the network’s base token over the collection’s lifetime.
The sum of pool fees generated by the collection in USD over the collection’s lifetime.
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.
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.
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.The ID of the NFT pool (poolAddress:networkId). For example, 0xdbea289dcc10eed8431e78753414a3d81b8e7201:1.
The contract address of the NFT pool.
The network ID the NFT collection is deployed on.
The contract address of the NFT collection.
The ID of the NFT collection (collectionAddress:networkId).
The contract address of the NFT AMM marketplace.
The contract address of the liquidity token of the pool (usually WETH).
The block number for the transaction.
The index of the log in the block.
The index of the transaction within the block.
The hash of the block where the transaction occurred.
The unique hash for the transaction.
The unix timestamp for the transaction.
The wallet address that transacted.
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.The NFT token ID involved in the transfer.
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.The NFT token ID involved in the transfer.
The number of tokens involved in the transfer.
The number of tokens involved in the transfer.This field is deprecated. nftTokenQuantity is no longer supported - use nftQuantity instead.
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.A list of transactions for an NFT pool.
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.
The updated pool fee in the pool’s liquidity token.
The ratio of the transaction token to the network’s base token.
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.The list of NFT pools matching the filter parameters.
The number of NFT pools returned.
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.The ID of the NFT pool (poolAddress:networkId).
The contract address of the NFT pool.
The unix timestamp indicating the last time the data was updated. Updates every 2 hours.
The contract address of the NFT collection.
The contract address of the NFT AMM marketplace.
The name of the NFT collection.
The symbol of the NFT collection.
The network ID the NFT collection is deployed on.
The wallet address that will receive the tokens or NFT sent to the pair during swaps.
The contract address of the bonding curve.
The delta used in the pool’s bonding curve.
The fee amount for the pool.
The type of liquidity pool.
The contract address of the liquidity token of the pool.
The wallet address of the pool owner.
poolVariant
GraphQlNftPoolVariant!
required
The pool variant. Can be ERC20 or NATIVE.
The list of royalties for the pool. Only applicable for SUDOSWAP_V2 pools.
The property checker contract address for the pool.
The NFT pool contract version. Can be SUDOSWAP_V1 or SUDOSWAP_V2.
The type of NFT in the pool.
For ERC1155 pools, the list of NFT token IDs that are accepted by the pool.
The current number of NFTs in the pool.This field is deprecated. nftBalance is changing from Int to String - use nftBalanceV2 instead.
The current number of NFTs in the pool.
The current pool liquidity in the network’s base token.
The current price at which the pool is willing to sell an NFT.
The current price at which the pool is willing to buy an NFT in the network’s base token.
The current spot price for the pool in the network’s base token.
The current value of the collection in the pool’s liquidity token.
The current price at which the pool is willing to sell an NFT in the network’s base token.
The current price at which the pool is willing to buy an NFT in the pool’s liquidity token.
The current spot price for the pool in the pool’s liquidity token.
The current pool liquidity in USD.
The current price at which the pool is willing to sell an NFT in USD.
The current price at which the pool is willing to buy an NFT in USD.
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.
The total number of NFTs sold over the pool’s lifetime.
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.
The total number of NFTs bought over the pool’s lifetime.
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.
The total number of NFTs bought and sold over the pool’s lifetime.
The total volume of the pool in the network’s base token over the pool’s lifetime.
The total buy volume of the pool in the network’s base token over the pool’s lifetime.
The total sell volume of the pool in the network’s base token over the pool’s lifetime.
The sum of pool fees generated by the pool in the network’s base token over the pool’s lifetime.
The sum of protocol fees generated by the pool in the network’s base token over the pool’s lifetime.
The total volume of the pool in the pool’s liquidity token over the pool’s lifetime.
The total buy volume of the pool in the pool’s liquidity token over the pool’s lifetime.
The total sell volume of the pool in the pool’s liquidity token over the pool’s lifetime.
The sum of pool fees generated by the pool in the pool’s liquidity token over the pool’s lifetime.
The sum of protocol fees generated by the pool in the pool’s liquidity token over the pool’s lifetime.
The total volume of the pool in USD over the pool’s lifetime.
The total buy volume of the pool in USD over the pool’s lifetime.
The total sell volume of the pool in USD over the pool’s lifetime.
The sum of pool fees generated by the pool in USD over the pool’s lifetime.
The sum of protocol fees generated by the pool in USD over the pool’s lifetime.
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.
The total number of NFTs sold by the pool over the past 24 hours.
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.
The total number of NFTs bought by the pool over the past 24 hours.
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.
The total number of NFTs bought and sold over the past 24 hours.
The total volume of the pool in the network’s base token over the past 24 hours.
The total buy volume of the pool in the network’s base token over the past 24 hours.
The total sell volume of the pool in the network’s base token over the past 24 hours.
The sum of pool fees generated by the pool in the network’s base token over the past 24 hours.
The sum of protocol fees generated by the pool in the network’s base token over the past 24 hours.
The total volume of the pool in the pool’s liquidity token over the past 24 hours.
The total buy volume of the pool in the pool’s liquidity token over the past 24 hours.
The total sell volume of the pool in the pool’s liquidity token over the past 24 hours.
The sum of pool fees generated by the pool in the pool’s liquidity token over the past 24 hours.
The sum of protocol fees generated by the pool in the pool’s liquidity token over the past 24 hours.
The total volume of the pool in USD over the past 24 hours.
The total buy volume of the pool in USD over the past 24 hours.
The total sell volume of the pool in USD over the past 24 hours.
The sum of pool fees generated by the pool in USD over the past 24 hours.
The sum of protocol fees generated by the pool in USD over the past 24 hours.
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.
The list of NFT token IDs deposited.
The number of NFTs in the contract after the block has processed.
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.
The list of NFT token IDs deposited.
The amount of each NFT token deposited.
New Param: The list of NFT assets withdrawn. More extensive info than nftTokenIds.
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.
The NFT token IDs withdrawn.
The number of NFTs in the contract after the block has processed.
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.
The list of NFT token IDs withdrawn.
The amount of each NFT token withdrawn.
The amount of token in the contract after the block has processed in the pool’s liquidity token.
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.
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.The ID of the NFT pool (poolAddress:networkId). For example, 0xdbea289dcc10eed8431e78753414a3d81b8e7201:1.
The contract address of the liquidity token of the pool (usually WETH).
The contract address of the NFT collection.
The contract name of the NFT collection.
The symbol of the NFT collection.
The contract address of the NFT AMM marketplace.
The contract address of the NFT pool.
The network ID the NFT collection is deployed on.
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.
The contract address of the bonding curve.
The wallet address that will receive the tokens or NFT sent to the pair during swaps.
The current delta used in the bonding curve.
The wallet address of the pool owner.
The current fee for pool.
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.
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.
The spot price in the network’s base token.
The current pool liquidity in the network’s base token.
The current number of NFTs in the pool.This field is deprecated. nftBalance is changing from Int to String - use nftBalanceV2 instead.
The current number of NFTs in the pool.
The total volume of the pool in the network’s base token over the pool’s lifetime.
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.
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.
The instantaneous price for selling 1 NFT to the pool in the pool’s liquidity token.
The current pool liquidity in the pool’s liquidity token.
The total volume of the pool in the pool’s liquidity token over the pool’s lifetime.
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.
The total number of NFTs bought and sold over the pool’s lifetime.
The list of NFT assets in the pool.
The type of NFT in the pool.
The list of royalties for the pool. Only applicable for SUDOSWAP_V2 pools.
The property checker contract address for the pool.
The NFT pool contract version. Can be SUDOSWAP_V1 or SUDOSWAP_V2.
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.The wallet address of recipient.
"""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.
The updated spot price in the pool’s liquidity token.
The updated price at which the pool is willing to sell an NFT in the pool’s liquidity token.
The updated price at which the pool is willing to buy an NFT in the pool’s liquidity token.
The ratio of the transaction token to the network’s base token.
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.
The updated spot price in the pool’s liquidity token.
The updated price at which the pool is willing to sell an NFT in the pool’s liquidity token.
The updated price at which the pool is willing to buy an NFT in the pool’s liquidity token.
The ratio of the transaction token to the network’s base token.
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.The contract address of the NFT AMM marketplace.
The network ID the NFT collection is deployed on.
The contract address of the NFT collection.
The unix timestamp for the start of the time frame.
The unix timestamp for the end of the time frame.
The contract address of the NFT pool.
The total number of NFTs bought and sold over the time frame.
The total number of NFTs bought over the time frame.
The total number of NFTs sold over the time frame.
The number of NFTs in the pool at the start of the time frame.
The number of NFTs in the pool at the end of the time frame.
The total volume of the pool in the network’s base token over the time frame.
The total buy volume of the pool in the network’s base token over the time frame.
The total sell volume of the pool in the network’s base token over the time frame.
The sum of pool fees generated by the pool in the network’s base token over the time frame.
The sum of protocol fees generated by the pool in the network’s base token over the time frame.
The lowest price at which the pool was willing to sell an NFT in the network’s base token over the time frame.
The highest price at which the pool was willing to sell an NFT in the network’s base token over the time frame.
The lowest price at which the pool was willing to buy an NFT in the network’s base token over the time frame.
The highest price at which the pool was willing to buy an NFT in the network’s base token over the time frame.
The pool liquidity in the network’s base token at the start of the time frame.
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.
The total value of token deposited in the pool’s liquidity token.
The number of NFTs in the contract after the block has processed.
The amount of token in the contract after the block has processed in the pool’s liquidity token.
The ratio of the transaction token to the network’s base token.
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.
The total value of token deposited in the pool’s liquidity token.
The amount of token in the contract after the block has processed in the pool’s liquidity token.
The ratio of the transaction token to the network’s base token.
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.
The total value of token withdrawn in the pool’s liquidity token.
The number of NFTs in the contract after the block has processed.
The amount of token in the contract after the block has processed in the pool’s liquidity token.
The ratio of the transaction token to the network’s base token.
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.
The total value of token withdrawn in the pool’s liquidity token.
The amount of token in the contract after the block has processed in the pool’s liquidity token.
The ratio of the transaction token to the network’s base token.
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.
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.The ID of the NFT collection (address:networkId).
The contract address of the NFT collection.
The network ID the NFT collection is deployed on.
The name of the NFT collection. For example, Bored Ape Yacht Club.
The symbol of the NFT collection. For example, BAYC.
The image URL for the collection or one of the assets within the collection.
The trade volume in USD over the window.
The change in volume between the previous and current window.
The trade count over the window.
The change in trade count between the previous and current window.
The lowest sale price over the window.
The average sale price over the window.
The highest sale price over the window.
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.The total value for the current window.
The total value for the previous window.
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.The total value for the current window.
The total value for the previous window.
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.The unix timestamp for the start of the window.
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.The contract address for the pair.
The network ID the pair is deployed on.
The ID for the pair (pairAddress:networkId).
The unix timestamp for the new bar.
statsType
TokenPairStatisticsType!
required
The type of statistics used. Can be Filtered or Unfiltered.
The sortKey for the bar (blockNumber#transactionIndex#logIndex, zero padded). For example, 0000000016414564#00000224#00000413.
aggregates
ResolutionBarData!
required
Price data broken down by resolution.
The quote token within the pair.
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."""Integer list condition."""
type OneOfNumberCondition {
"""The list of integers."""
oneOf: [Int!]!
}
OnTokenBarsUpdatedResponse
Response returned by onBarsUpdated.The contract address for the pair.
The network ID the pair is deployed on.
The ID for the pair (pairAddress:networkId).
The unix timestamp for the new bar.
statsType
TokenPairStatisticsType!
required
The type of statistics used. Can be Filtered or Unfiltered.
The sortKey for the bar (blockNumber#transactionIndex#logIndex, zero padded). For example, 0000000016414564#00000224#00000413.
aggregates
ResolutionBarData!
required
Price data broken down by resolution.
The quote token within the pair.
The address of the token being quoted
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.The contract address for the pair.
The network ID the pair is deployed on.
The ID for the pair (pairAddress:networkId).
The unix timestamp for the new bar.
The sortKey for the bar (blockNumber#transactionIndex#logIndex, zero padded). For example, 0000000016414564#00000224#00000413.
aggregates
UnconfirmedResolutionBarData!
required
Price data broken down by resolution.
The quote token within the pair.
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.The contract address of the pair.
The address for the exchange factory contract.
The exchange fee for swaps.
The ID for the pair (address:networkId).
The network ID the pair is deployed on.
The amount of required tick separation. Only applicable for pairs on UniswapV3.
The contract address of token0.
The contract address of token1.
The unix timestamp for the creation of the pair.
Metadata for the first token in the pair.
Metadata for the second token in the pair.
The pooled amounts of each token in the pair.
Custom data for the pair, only certain protocols have this. (uniswapv4, arenatrade for example)
The per-protocol data for the pair, if applicableThis field is deprecated. Use protocolData instead
"""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
"""Custom data for the pair, only certain protocols have this. (uniswapv4, arenatrade for example)"""
protocolData: ProtocolData
"""The per-protocol data for the pair, if applicable"""
protocolCustomData: PairProtocolCustomData @deprecated(reason: "Use protocolData instead")
}
PairFilterConnection
Response returned by filterPairs.The list of pairs matching the filter parameters.
The number of pairs returned.
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.The unix timestamp for the creation of the pair.
The unix timestamp for the last transaction to happen on the pair.
The number of buys in the past hour.
The number of buys in the past 4 hours.
The number of buys in the past 12 hours.
The number of buys in the past 24 hours.
Exchange metadata for the pair.
The highest price in USD in the past hour.
The highest price in USD in the past 4 hours.
The highest price in USD in the past 12 hours.
The highest price in USD in the past 24 hours.
Amount of liquidity in the pair.
lockedLiquidityPercentage
The locked liquidity percentage.
The token with higher liquidity in the pair. Can be token0 or token1.
The token of interest. Can be token0 or token1.
The lowest price in USD in the past hour.
The lowest price in USD in the past 4 hours.
The lowest price in USD in the past 12 hours.
The lowest price in USD in the past 24 hours.
The fully diluted market cap.
10^n, where n is the number of decimal places the price has. Max 16. Used for TradingView settings.
The percent price change in the past hour. Decimal format.
The percent price change in the past 4 hours. Decimal format.
The percent price change in the past 12 hours. Decimal format.
The percent price change in the past 24 hours. Decimal format.
The percent volume change in the past hour. Decimal format.
The percent volume change in the past 4 hours. Decimal format.
The percent volume change in the past 12 hours. Decimal format.
The percent volume change in the past 24 hours. Decimal format.
The number of sells in the past hour.
The number of sells in the past 4 hours.
The number of sells in the past 12 hours.
The number of sells in the past 24 hours.
Metadata for the first token in the pair.
Metadata for the second token in the pair.
The number of transactions in the past hour.
The number of transactions in the past 4 hours.
The number of transactions in the past 12 hours.
The number of transactions in the past 24 hours.
The unique number of buys in the past hour.
The unique number of buys in the past 4 hours.
The unique number of buys in the past 12 hours.
The unique number of buys in the past 24 hours.
The unique number of sells in the past hour.
The unique number of sells in the past 4 hours.
The unique number of sells in the past 12 hours.
The unique number of sells in the past 24 hours.
The unique number of transactions in the past hour.
The unique number of transactions in the past 4 hours.
The unique number of transactions in the past 12 hours.
The unique number of transactions in the past 24 hours.
The trade volume in USD in the past hour.
The trade volume in USD in the past 4 hours.
The trade volume in USD in the past 12 hours.
The trade volume in USD in the past 24 hours.
The buy volume in USD in the past hour.
The buy volume in USD in the past 12 hours.
The buy volume in USD in the past 24 hours.
The buy volume in USD in the past 4 hours.
The sell volume in USD in the past hour.
The sell volume in USD in the past 12 hours.
The sell volume in USD in the past 24 hours.
The sell volume in USD in the past 4 hours.
The average age of the wallets that traded in the last 24h
The standard deviation of age of the wallets that traded in the last 24h
The percentage of wallets that are less than 1d old that have traded in the last 24h
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
}
The exchange contract ID.
The exchange fee for swaps.
The ID for the pair (address:networkId).
The token of interest within the pair. Can be token0 or token1.
The network ID the pair is deployed on.
The total liquidity in the pair.
The token with higher liquidity within the pair. Can be token0 or token1.
The token with lower liquidity within the pair. Can be token0 or token1.
The contract address of the pair.
statsType
TokenPairStatisticsType!
required
The type of statistics returned. Can be FILTERED or UNFILTERED
The quote token price in USD.
The percent price change in the past 5 minutes. Decimal format.
The percent price change in the past hour. Decimal format.
The percent price change in the past 4 hours. Decimal format.
The percent price change in the past 12 hours. Decimal format.
The percent price change in the past 24 hours. Decimal format.
The percent price change in the past week. Decimal format.
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.
The trade volume in USD in the past hour.
The trade volume in USD in the past 4 hours.
The trade volume in USD in the past 12 hours.
The trade volume in USD in the past 24 hours.
The trade trade volume in USD in the past week.
The trade volume in USD in the past 5 minutes.
The highest price in USD in the past 5 minutes.
The highest price in USD in the past hour.
The highest price in USD in the past 4 hours.
The highest price in USD in the past 12 hours.
The highest price in USD in the past 24 hours.
The highest price in USD in the past week.
The lowest price in USD in the past 5 minutes.
The lowest price in USD in the past hour.
The lowest price in USD in the past 12 hours.
The lowest price in USD in the past 24 hours.
The lowest price in USD in the past 4 hours.
The lowest price in USD in the past week.
Token metadata for the first token in the pair.
Token metadata for the second token in the pair.
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
}
Metadata for a token in a pair."""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]
}
PairProtocolCustomData
The address of the hook contract for Uniswap V4 pools.
type PairProtocolCustomData {
"""The address of the hook contract for Uniswap V4 pools."""
uniswapV4HookAddress: String
}
ParallelAssetFilterConnection
Response returned by filterNftParallelAssets.results
[ParallelAssetFilterResult]
The list of Parallel assets matching the filter parameters.
The number of Parallel assets returned.
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.The ID of the NFT asset (address:tokenId).
The contract address of the NFT collection.
The token ID of the NFT asset.
The internal Parallel ID of the NFT asset.
The network ID the NFT collection is deployed on.
The name of the NFT asset.
The description of the NFT asset.
The source image URI linked by smart contract metadata.
The URI provided by the smart contract. Typically JSON that contains metadata.
The unix timestamp for the last trade.
The last sale price in USD.
lastPriceNetworkBaseToken
The last sale price in the network’s base token.
The game data for the NFT asset.
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.The rarity of the asset. Can be Common, Uncommon, Rare, Legendary, or Prime.
The Parallel the asset belongs to.
The energy used to play in-game.
The damage dealt when engaged in combat.
The possible damage received before being destroyed.
The card type. Can be Effect, Relic, Unit, Upgrade or Paragon.
The card subtype. Can be Pirate, Vehicle or Clone.
The description of the card’s in-game abilities.
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
}
The card class. Can be Art Card, Asset, Card Back, FE, Masterpiece, PL, or SE.
The total supply of this individual asset.
The asset description, sourced off-chain. Usually equal to the asset’s on-chain description.
The expansion used for naming base and expansion sets.
The paraset the asset belongs to.
The ID used to match other cards with the same name but different class.
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.The token ID of the Parallel asset.
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.The ID used to match other cards with the same name but different class.
The rarity of the asset. Can be Common, Uncommon, Rare, Legendary, or Prime.
The card class. Can be Art Card, Asset, Card Back, FE, Masterpiece, PL, or SE.
The total supply of this individual asset.
The Parallel the asset belongs to.
The energy used to play in-game.
The damage dealt when engaged in combat.
The possible damage received before being destroyed.
The card type. Can be Effect, Relic, Unit, Upgrade or Paragon.
The card subtype. Can be Pirate, Vehicle or Clone.
The description of the card’s in-game abilities.
The description of the card’s passive ability.
The asset description, sourced off-chain. Usually equal to the asset’s on-chain description.
The expansion used for naming base and expansion sets.
The paraset the asset belongs to.
"""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.A cursor for use in pagination.
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.The amount of token0 added or removed from the pair.
The amount of token1 added or from the pair.
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.
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.
The address of token0 in the pair.
The address of token1 in the pair.
The address of account that added or removed liquidity.
The amount of token0 captured by the protocol.
The amount of token1 captured by the protocol.
The amount of token0 now in the pool.
The amount of token1 now in the pool.
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
type PooledTokenValues {
token0: String
token1: String
}
Price
Real-time or historical prices for a token.The contract address of the token.
The network ID the token is deployed on.
The unix timestamp for the price.
The pool that emitted the swap generating this price
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.
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.A list of holders of PRIME. Each request returns 50 results.
The number of holders returned.
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.The ID of the contract-level Prime Pool (poolContractAddress:networkId). For example, 0x89bb49d06610b4b18e355504551809be5177f3d0:1.
The contract address for the Prime Pool.
The network ID the Prime Pool is deployed on.
The ID of the pool within the contract.
Values calculated by Defined using on-chain data.
Values obtained directly from the chain.
When the pool was created by Defined.
The block number for when Defined discovered this pool.
The transaction hash of when Defined discovered this pool.
The contract address for the tokens cached ib the pool.
The type of pool for this Prime Pool.
The Parallel tokenIds required to cache in the pool.
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.The Prime pool asset ID (poolContractAddress:poolId:networkId)
The owner wallet address of the cached Prime pool asset.
The number of cached Prime pool assets of this type by this owner.
The owner wallet address of the cached Prime pool asset.
The owner wallet address of the cached Prime pool asset, and network ID (from:networkId).
The Prime pool ID and Prime pool contract address (poolId:poolContractAddress).
The network ID of the cached Prime pool asset.
THe contract address of the Prime pool.
The amount of ETH the user is not eligible for either from having already harvesting or from not caching in the past.
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.The cursor to use for pagination.
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.
The amount of Prime pool asset(s) cached.
The total supply of assets cached in this Prime pool, including the amount cached in this transaction.
The owner wallet address of the cached Prime pool asset(s).
The total number of Prime pool asset(s) cached in this pool by this owner.
The amount of PRIME the user is not eligible for either from having already harvesting or from not caching in the past.
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.
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
The amount of accumulated PRIME rewards in total for the pool.
The amount of accumulated PRIME rewards per share for the pool.
The amount of accumulated ETH rewards in total for the pool.
The amount of accumulated ETH rewards per share for the pool.
The amount of PRIME for the pool to pay out as caching rewards.
The amount of ETH for the pool to pay out as caching rewards.
The amount of PRIME paid out daily by the pool as caching rewards.
The amount of PRIME paid out per second by the pool as caching rewards.
The amount of ETH paid out daily by the pool as caching rewards.
The amount of ETH paid out per second by the pool as caching rewards.
The amount of PRIME paid out daily by the pool, per share of the pool’s total cached supply.
The amount of PRIME paid out per second by the pool, per share of the pool’s total cached supply.
The amount of ETH paid out daily by the pool, per share of the pool’s total cached supply.
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.Whether caching is paused for this pool.
How much ETH has been claimed for this pool.
How much ETH reward has been accrued for this pool.
The pool’s allocation of the contract’s per-second ETH rewards.
Total share points of the contract’s per-second ETH rewards to the pool.
Caching ETH rewards period start timestamp.
Caching ETH rewards period end timestamp.
Last timestamp at which ETH rewards were assigned.
Minimum number of timed cache seconds per ETH.
The pool’s allocation of the contract’s per second PRIME rewards.
Total share points of the contract’s per second PRIME rewards to the pool.
Caching rewards period start timestamp.
Caching rewards period end timestamp.
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.
The wallet address claiming ETH rewards.
The amount of ETH claimed.
currency
PrimePoolCurrency!
required
The currency type of the event.
The amount of ETH the user is not eligible for either from having already harvesting or from not caching in the past.
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.
The wallet address claiming PRIME rewards.
The amount of PRIME claimed.
currency
PrimePoolCurrency!
required
The currency type of the event.
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.A cursor for use in pagination.
"""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.
The wallet address emergency withdrawing from the pool.
The amount of Prime pool asset(s) emergency withdrawn.
The total supply of assets cached in this Prime pool.
The updated total number of Prime pool asset(s) cached in this pool by this owner.
The amount of PRIME the user is not eligible for either from having already harvesting or from not caching in the past.
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.
The updated ETH reward start timestamp for the pool.
The updated ETH reward end timestamp for the pool.
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.
The updated PRIME reward start timestamp for the pool.
The updated PRIME reward end timestamp for the pool.
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.
The amount of ETH rewards added to the pool.
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.
The amount of ETH rewards set for the pool.
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.The Prime pool event ID (poolContractAddress:poolId:networkId)
The sort key of the Prime pool event (blockNumber:transactionIndex:logIndex).
The blockHash of the Prime pool event.
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.
The Prime pool event’s calling address.
The Prime pool event’s calling address, and network ID (from:networkId).
The logIndex of the Prime pool event.
The network ID of the Prime pool event.
The Prime pool contract address.
The timestamp of the Prime pool event.
The transactionHash of the Prime pool event.
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.The cursor to use for pagination.
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.
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.
The updated alloc point for the pool (the pool’s share of the contract’s total rewards).
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.
The updated reward per second for the pool.
