AddEventsOutput
AddEventsOutput
Response returned by onEventsCreated
.
Fields for AddEventsOutput
AddEventsOutput
Name | Description |
---|---|
address (String!) | The contract address of the pair. |
events ([Event]!) | A list of transactions for the token. |
id (String!) | The ID of the event ( |
networkId (Int!) | The network ID that the token is deployed on. |
quoteToken (QuoteToken) | The token of interest within the pair. Can be |
AddNftEventsOutput
AddNftEventsOutput
Response returned by onNftEventsCreated
.
Fields for AddNftEventsOutput
AddNftEventsOutput
AddNftPoolEventsOutput
AddNftPoolEventsOutput
Fields for AddNftPoolEventsOutput
AddNftPoolEventsOutput
AddTokenEventsOutput
AddTokenEventsOutput
Fields for AddTokenEventsOutput
AddTokenEventsOutput
AddTokenLifecycleEventsOutput
AddTokenLifecycleEventsOutput
Fields for AddTokenLifecycleEventsOutput
AddTokenLifecycleEventsOutput
Name | Description |
---|---|
events ([TokenLifecycleEvent!]!) | |
id (String!) |
AddUnconfirmedEventsOutput
AddUnconfirmedEventsOutput
Response returned by onUnconfirmedEventsCreated
.
Fields for AddUnconfirmedEventsOutput
AddUnconfirmedEventsOutput
Name | Description |
---|---|
address (String!) | The contract address of the pair. |
events ([UnconfirmedEvent]!) | A list of transactions for the token. |
id (String!) | The ID of the event ( |
networkId (Int!) | The network ID that the token is deployed on. |
quoteToken (QuoteToken) | The token of interest within the pair. Can be |
ApiToken
ApiToken
Fields for ApiToken
ApiToken
Name | Description |
---|---|
expiresTimeString (String!) | ISO time string for the expiry of the token |
id (String!) | Unique identifier for the token |
remaining (String) | Approximate number of remaining resolutions before this token is rate limited |
requestLimit (String!) | Number of root fields this api token is allowed to resolve before it's rate limited |
token (String!) | JWT to be passed into the Authorization header for API requests |
Balance
Balance
Wallet balance of a token.
Fields for Balance
Balance
Name | Description |
---|---|
balance (String!) | The balance held by the wallet. |
firstHeldTimestamp (Int) | The time that this address first held a token |
shiftedBalance (Float!) | The balance held by the wallet, adjusted by the number of decimals in the token. |
tokenId (String!) | The ID of the token ( |
walletId (String!) | The ID of the wallet ( |
BalancesResponse
BalancesResponse
Fields for BalancesResponse
BalancesResponse
BarsResponse
BarsResponse
Bar chart data to track price changes over time.
Fields for BarsResponse
BarsResponse
Name | Description |
---|---|
buyers ([Int]!) | The number of unique buyers |
buys ([Int]!) | The number of buys |
buyVolume ([String]!) | The buy volume in USD |
c ([Float]!) | The closing price. |
h ([Float]!) | The high price. |
l ([Float]!) | The low price. |
liquidity ([String]!) | Liqudity in USD |
o ([Float]!) | The opening price. |
s (String!) | The status code for the batch: |
sellers ([Int]!) | The number of unique sellers |
sells ([Int]!) | The number of sells |
sellVolume ([String]!) | The sell volume in USD |
t ([Int!]!) | The timestamp for the bar. |
traders ([Int]!) | The number of traders |
transactions ([Int]!) | The number of transactions |
v ([Int]!) | The volume. |
volume ([String]) | The volume with higher precision. |
volumeNativeToken ([String]) | The volume in the native token for the network |
BurnEventData
BurnEventData
Event data for a token burn event.
Fields for BurnEventData
BurnEventData
Name | Description |
---|---|
amount0 (String) | The amount of |
amount0Shifted (String) | The amount of |
amount1 (String) | The amount of |
amount1Shifted (String) | The amount of |
tickLower (String) | The lower tick boundary of the position. Only applicable for UniswapV3 events. |
tickUpper (String) | The upper tick boundary of the position. Only applicable for UniswapV3 events. |
type (EventType!) | The type of token event, |
ChartUrl
ChartUrl
The chart url.
Fields for ChartUrl
ChartUrl
Name | Description |
---|---|
url (String!) | The chart url. |
ChartUrlsResponse
ChartUrlsResponse
The response type for a chart url query.
Fields for ChartUrlsResponse
ChartUrlsResponse
Name | Description |
---|---|
pair (ChartUrl!) | The pair chart url. |
CommunityNote
CommunityNote
Community gathered proposals for an asset.
Fields for CommunityNote
CommunityNote
Name | Description |
---|---|
address (String!) | The contract address of the contract. |
contractType (ContractType!) | |
currentContract (EnhancedContract) | |
currentData (JSON) | The contract after the community note was applied. |
id (String!) | The ID of the contract ( |
moderatedAt (Int) | The unix timestamp of when the community note was moderated. |
networkId (Int!) | The network ID the contract is deployed on. |
previousData (JSON) | The contract before the community note was applied. |
proposalData (JSON!) | The data of the community note. |
proposalNum (Int!) | The ordinal number of the community note. |
proposalType (CommunityNoteType!) | The type of the community note. |
proposedAt (Int!) | The unix timestamp of when the community note was created. |
sortKey (String!) | |
status (ContractProposalStatus!) | The status of the community note. |
CommunityNotesResponse
CommunityNotesResponse
Community notes data
Fields for CommunityNotesResponse
CommunityNotesResponse
Name | Description |
---|---|
count (Int!) | The number of community notes returned. |
cursor (String) | A cursor for use in pagination. |
items ([CommunityNote!]!) | The list of community notes matching the filter parameters. |
ComparisonOperator
ComparisonOperator
Fields for ComparisonOperator
ComparisonOperator
ContractLabel
ContractLabel
Metadata for a contract label.
Fields for ContractLabel
ContractLabel
Name | Description |
---|---|
createdAt (Int!) | The unix timestamp for when the contract label was created. |
subType (ContractLabelSubType!) | The contract label sub-type. Can be |
type (ContractLabelType!) | The contract label type. Can be |
CreateWebhooksOutput
CreateWebhooksOutput
Fields for CreateWebhooksOutput
CreateWebhooksOutput
CurrencyBarData
CurrencyBarData
Price data for a bar at a specific resolution.
Fields for CurrencyBarData
CurrencyBarData
Name | Description |
---|---|
t (Int!) | The timestamp for the bar. |
token (IndividualBarData!) | Bar chart data in the network's base token. |
usd (IndividualBarData!) | Bar chart data in USD. |
DeleteWebhooksOutput
DeleteWebhooksOutput
Fields for DeleteWebhooksOutput
DeleteWebhooksOutput
Name | Description |
---|---|
deletedIds ([String]) |
DetailedNftStats
DetailedNftStats
Detailed stats for an NFT collection.
Fields for DetailedNftStats
DetailedNftStats
Name | Description |
---|---|
collectionAddress (String!) | The contract address of the NFT collection. |
grouping (String) | The marketplace address or |
networkId (Int!) | The network ID the NFT collection is deployed on. |
stats_day1 (WindowedDetailedNftStats) | The breakdown of stats over a 24 hour window. |
stats_day30 (WindowedDetailedNftStats) | The breakdown of stats over a 30 day window. |
stats_hour1 (WindowedDetailedNftStats) | The breakdown of stats over an hour window. |
stats_hour4 (WindowedDetailedNftStats) | The breakdown of stats over a 4 hour window. |
stats_hour12 (WindowedDetailedNftStats) | The breakdown of stats over a 12 hour window. |
stats_week1 (WindowedDetailedNftStats) | The breakdown of stats over a 7 day window. |
DetailedNftStatsBucketTimestamp
DetailedNftStatsBucketTimestamp
The start/end timestamp for a given bucket within the window.
Fields for DetailedNftStatsBucketTimestamp
DetailedNftStatsBucketTimestamp
DetailedNftStatsNumberMetrics
DetailedNftStatsNumberMetrics
Number metrics for detailed NFT stats.
Fields for DetailedNftStatsNumberMetrics
DetailedNftStatsNumberMetrics
DetailedNftStatsStringMetrics
DetailedNftStatsStringMetrics
String metrics for detailed NFT stats.
Fields for DetailedNftStatsStringMetrics
DetailedNftStatsStringMetrics
DetailedPairStats
DetailedPairStats
Detailed stats for a token within a pair.
Fields for DetailedPairStats
DetailedPairStats
Name | Description |
---|---|
bucketCount (Int) | Number of aggregated buckets specified in input |
lastTransaction (Int) | The unix timestamp for the last transaction to happen on the pair. |
networkId (Int!) | The network ID the pair is deployed on. |
pair (Pair) | |
pairAddress (String!) | The contract address of the pair. |
queryTimestamp (Int) | The timestamp specified as input to the query |
stats_day1 (WindowedDetailedPairStats) | The breakdown of stats over a 24 hour window. |
stats_day30 (WindowedDetailedPairStats) | The breakdown of stats over a 30 day 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_min5 (WindowedDetailedPairStats) | The breakdown of stats over a 5 minute window. |
stats_min15 (WindowedDetailedPairStats) | The breakdown of stats over a 15 minute window. |
stats_week1 (WindowedDetailedPairStats) | The breakdown of stats over a 7 day window. |
statsType (TokenPairStatisticsType!) | The type of statistics returned. Can be |
tokenOfInterest (TokenOfInterest) | The token of interest used to calculate token-specific stats. |
DetailedPairStatsBucketTimestamp
DetailedPairStatsBucketTimestamp
The start/end timestamp for a given bucket within the window.
Fields for DetailedPairStatsBucketTimestamp
DetailedPairStatsBucketTimestamp
DetailedPairStatsNumberMetrics
DetailedPairStatsNumberMetrics
Number metrics for detailed pair stats.
Fields for DetailedPairStatsNumberMetrics
DetailedPairStatsNumberMetrics
DetailedPairStatsStringMetrics
DetailedPairStatsStringMetrics
String metrics for detailed pair stats.
Fields for DetailedPairStatsStringMetrics
DetailedPairStatsStringMetrics
Name | Description |
---|---|
buckets ([String]!) | The list of aggregated values for each bucket. |
change (Float) | The percent change between the |
currentValue (String) | The total value for the most recent duration. |
previousValue (String) | The total value for the previous duration. |
DetailedStats
DetailedStats
Detailed stats for a token within a pair.
Fields for DetailedStats
DetailedStats
Name | Description |
---|---|
bucketCount (Int) | Number of aggregated buckets specified in input |
pairId (String!) | The ID of the pair ( |
queryTimestamp (Int) | The timestamp specified as input to the query |
stats_day1 (WindowedDetailedStats) | The breakdown of stats over a 24 hour window. |
stats_hour1 (WindowedDetailedStats) | The breakdown of stats over an hour window. |
stats_hour4 (WindowedDetailedStats) | The breakdown of stats over a 4 hour window. |
stats_hour12 (WindowedDetailedStats) | The breakdown of stats over a 12 hour window. |
stats_min5 (WindowedDetailedStats) | The breakdown of stats over a 5 minute window. |
statsType (TokenPairStatisticsType!) | The type of statistics returned. Can be |
tokenOfInterest (TokenOfInterest!) | The token of interest used to calculate token-specific stats. |
DetailedStatsBucketTimestamp
DetailedStatsBucketTimestamp
The start/end timestamp for a given bucket within the window.
Fields for DetailedStatsBucketTimestamp
DetailedStatsBucketTimestamp
DetailedStatsNumberMetrics
DetailedStatsNumberMetrics
Number metrics for detailed stats.
Fields for DetailedStatsNumberMetrics
DetailedStatsNumberMetrics
DetailedStatsStringMetrics
DetailedStatsStringMetrics
String metrics for detailed stats.
Fields for DetailedStatsStringMetrics
DetailedStatsStringMetrics
Name | Description |
---|---|
buckets ([String]!) | The list of aggregated values for each bucket. |
change (Float!) | The percent change between the |
currentValue (String!) | The total value for the most recent window. |
previousValue (String!) | The total value for the previous window. |
EnhancedNftContract
EnhancedNftContract
Metadata for an NFT collection.
Fields for EnhancedNftContract
EnhancedNftContract
Name | Description |
---|---|
address (String!) | The contract address of the NFT collection. |
description (String) | The description of the NFT collection. |
ercType (String!) | The token standard. Can be a variation of |
id (String!) | The ID of the NFT collection ( |
image (String) | The URL for an image of the NFT collection. |
labels ([ContractLabel]) | A list of labels for the NFT collection. |
name (String) | The name of the NFT collection. |
networkId (Int!) | The network ID the NFT collection is deployed on. |
socialLinks (SocialLinks) | Community gathered links for the socials of this NFT collection. |
symbol (String) | The symbol of the NFT collection. |
totalSupply (String) | The total supply of the NFT collection. |
EnhancedToken
EnhancedToken
Metadata for a token.
Fields for EnhancedToken
EnhancedToken
Name | Description |
---|---|
address (String!) | The contract address of the token. |
circulatingSupply (String) | The circulating supply of the token. 🔴 DEPRECATED 🔴 |
cmcId (Int) | The token ID on CoinMarketCap. |
createBlockNumber (Int) | The block height the token was created at. |
createdAt (Int) | The unix timestamp for the creation of the token. |
createTransactionHash (String) | The transaction hash of the token's creation. |
creatorAddress (String) | The token creator's wallet address. |
decimals (Int!) | The precision to which the token can be divided. For example, the smallest unit for USDC is 0.000001 (6 decimals). |
exchanges ([Exchange!]) | A list of exchanges where the token has been traded. |
explorerData (ExplorerTokenData) | Information about the token from 3rd party sources. 🔴 DEPRECATED 🔴 |
id (String!) | The ID of the token ( |
imageLargeUrl (String) | The large token logo URL. 🔴 DEPRECATED 🔴 |
imageSmallUrl (String) | The small token logo URL. 🔴 DEPRECATED 🔴 |
imageThumbUrl (String) | The thumbnail token logo URL. 🔴 DEPRECATED 🔴 |
info (TokenInfo) | More metadata about the token. |
isScam (Boolean) | Whether the token has been flagged as a scam. |
name (String) | The token name. For example, |
networkId (Int!) | The network ID the token is deployed on. |
pooled (String) | The amount of this token in the pair. 🔴 DEPRECATED 🔴 |
socialLinks (SocialLinks) | Community gathered links for the socials of this token. |
symbol (String) | The token symbol. For example, |
totalSupply (String) | The total supply of the token. 🔴 DEPRECATED 🔴 |
Event
Event
A token transaction.
Fields for Event
Event
Name | Description |
---|---|
address (String!) | The contract address of the token's top pair. |
baseTokenPrice (String) | The price of the network's base token. |
blockHash (String!) | The hash of the block where the transaction occurred. |
blockNumber (Int!) | The block number for the transaction. |
data (EventData) | The event-specific data for the transaction. Can be |
eventDisplayType (EventDisplayType) | A more specific breakdown of |
eventType (EventType!) | The type of transaction event. Can be |
id (String!) | The ID of the event ( |
labels (LabelsForEvent) | Labels attributed to the event. |
liquidityToken (String) | The contract address of the token with higher liquidity in the token's top pair. |
logIndex (Int!) | The index of the log in the block. |
maker (String) | The wallet address that performed the transaction. |
networkId (Int!) | The network ID that the token is deployed on. |
quoteToken (QuoteToken) | The token of interest within the token's top pair. Can be |
timestamp (Int!) | The unix timestamp for when the transaction occurred. |
token0PoolValueUsd (String) | The updated price of |
token0SwapValueUsd (String) | The price of |
token0ValueBase (String) | The price of |
token1PoolValueUsd (String) | The updated price of |
token1SwapValueUsd (String) | The price of |
token1ValueBase (String) | The price of |
transactionHash (String!) | The unique hash for the transaction. |
transactionIndex (Int!) | The index of the transaction within the block. |
EventConnection
EventConnection
Response returned by getTokenEvents
.
Fields for EventConnection
EventConnection
EventLabel
EventLabel
Metadata for an event label.
Fields for EventLabel
EventLabel
Name | Description |
---|---|
data (EventLabelData!) | Specific data for the event label type. |
id (String!) | The ID of the pair ( |
label (EventLabelType!) | The event label type. |
logIndex (Int!) | The index of the log in the block. |
networkId (Int!) | The network ID the pair is deployed on. |
timestamp (Int!) | The unix timestamp for the transaction. |
transactionHash (String!) | The unique hash for the transaction. |
transactionIndex (Int!) | The index of the transaction within the block. |
EventLabelConnection
EventLabelConnection
Response returned by getEventLabels
.
Fields for EventLabelConnection
EventLabelConnection
Name | Description |
---|---|
cursor (String) | The cursor to use for pagination. |
items ([EventLabel]) | A list of event labels for a pair. |
Exchange
Exchange
Metadata for a decentralized exchange.
Fields for Exchange
Exchange
Name | Description |
---|---|
address (String!) | The contract address of the exchange. |
color (String) | The hex string for the exchange color. |
exchangeVersion (String) | The version of the exchange, if applicable. |
iconUrl (String) | The exchange logo URL. |
id (String!) | The ID of the exchange ( |
name (String) | The name of the exchange. |
networkId (Int!) | The network ID the exchange is deployed on. |
tradeUrl (String) | The URL for the exchange. |
ExchangeFilterConnection
ExchangeFilterConnection
Response returned by filterExchanges
.
Fields for ExchangeFilterConnection
ExchangeFilterConnection
Name | Description |
---|---|
count (Int) | The number of exchanges returned. |
offset (Int) | Where in the list the server started when returning items. |
results ([ExchangeFilterResult]) | The list of exchanges matching the filter parameters. |
ExchangeFilterResult
ExchangeFilterResult
An exchange matching a set of filter parameters.
Fields for ExchangeFilterResult
ExchangeFilterResult
Name | Description |
---|---|
dailyActiveUsers (Int) | The total unique daily active users. |
exchange (FilterExchange) | Exchange metadata. |
monthlyActiveUsers (Int) | The total unique monthly active users (30 days). |
txnCount1 (String) | The number of transactions on the exchange in the past hour. |
txnCount4 (String) | The number of transactions on the exchange in the past 4 hours. |
txnCount12 (String) | The number of transactions on the exchange in the past 12 hours. |
txnCount24 (String) | The number of transactions on the exchange in the past 24 hours. |
volumeNBT1 (String) | The trade volume in the network's base token in the past hour. |
volumeNBT4 (String) | The trade volume in the network's base token in the past 4 hours. |
volumeNBT12 (String) | The trade volume in the network's base token in the past 12 hours. |
volumeNBT24 (String) | The trade volume in the network's base token in the past 24 hours. |
volumeUSD1 (String) | The trade volume in USD in the past hour. |
volumeUSD4 (String) | The trade volume in USD in the past 4 hours. |
volumeUSD12 (String) | The trade volume in USD in the past 12 hours. |
volumeUSD24 (String) | The trade volume in USD in the past 24 hours. |
ExplorerTokenData
ExplorerTokenData
Third party token data sourced from off chain.
Fields for ExplorerTokenData
ExplorerTokenData
Name | Description |
---|---|
blueCheckmark (Boolean) | Whether the token has been verified on CoinGecko. |
description (String) | A description of the token. |
divisor (String) | The precision to which the token can be divided. |
id (String!) | The ID of the token ( |
tokenPriceUSD (String) | The token price in USD. |
tokenType (String) | The token type. |
Feature
Feature
Fields for Feature
Feature
FilterExchange
FilterExchange
Metadata for an exchange.
Fields for FilterExchange
FilterExchange
Name | Description |
---|---|
address (String!) | The address for the exchange factory contract. |
exchangeVersion (String) | The version of the exchange. For example, |
iconUrl (String) | The URL for the exchange's icon. |
id (String!) | The ID of the exchange ( |
name (String) | The name of the exchange. |
networkId (Int!) | The network ID the factory is deployed on. |
tradeUrl (String) | The URL for the exchange's trading platform. |
FrontRunLabelData
FrontRunLabelData
Metadata for a front-run label.
Fields for FrontRunLabelData
FrontRunLabelData
GasEstimate
GasEstimate
Fields for GasEstimate
GasEstimate
GasFee
GasFee
Fields for GasFee
GasFee
GasFees
GasFees
Fields for GasFees
GasFees
GetNetworkStatsResponse
GetNetworkStatsResponse
Response returned by getNetworkStats
.
Fields for GetNetworkStatsResponse
GetNetworkStatsResponse
GetNftPoolCollectionsResponse
GetNftPoolCollectionsResponse
Response returned by getNftPoolCollectionsByExchange
.
Fields for GetNftPoolCollectionsResponse
GetNftPoolCollectionsResponse
Name | Description |
---|---|
cursor (String) | A cursor for use in pagination. |
items ([NftPoolCollectionResponse]) | A list of NFT collections. |
GetNftPoolsResponse
GetNftPoolsResponse
Response returned by getNftPoolsByCollectionAndExchange
and getNftPoolsByOwner
.
Fields for GetNftPoolsResponse
GetNftPoolsResponse
Name | Description |
---|---|
cursor (String) | A cursor for use in pagination. |
items ([NftPoolResponse]!) | A list of NFT pools. |
GetSimulateTokenContractResultsConnection
GetSimulateTokenContractResultsConnection
Fields for GetSimulateTokenContractResultsConnection
GetSimulateTokenContractResultsConnection
Name | Description |
---|---|
cursor (String) | |
results ([SimulateTokenContractResult!]!) |
GetWebhooksResponse
GetWebhooksResponse
Fields for GetWebhooksResponse
GetWebhooksResponse
HoldersResponse
HoldersResponse
Fields for HoldersResponse
HoldersResponse
Name | Description |
---|---|
count (Int!) | the unique count of holders for the token. |
cursor (String) | A cursor for use in pagination. |
items ([Balance!]!) | The list wallets for a token. |
status (HoldersStatus!) | Status of holder. Disabled if on unsupported network or there is insufficient holder data. |
IndividualBarData
IndividualBarData
Bar chart data.
Fields for IndividualBarData
IndividualBarData
Name | Description |
---|---|
buyers (Int!) | The number of unique buyers |
buys (Int!) | The number of buys |
buyVolume (String!) | The buy volume in USD |
c (Float!) | The closing price. |
h (Float!) | The high price. |
l (Float!) | The low price. |
liquidity (String!) | Liqudity in USD |
o (Float!) | The opening price. |
sellers (Int!) | The number of unique sellers |
sells (Int!) | The number of sells |
sellVolume (String!) | The sell volume in USD |
t (Int!) | The timestamp for the bar. |
traders (Int!) | The number of traders |
transactions (Int!) | The number of transactions |
v (Int) | The volume. |
volume (String!) | The volume with higher precision. |
volumeNativeToken (String!) | The volume in the network's base token |
IntEqualsCondition
IntEqualsCondition
Fields for IntEqualsCondition
IntEqualsCondition
Name | Description |
---|---|
eq (Int!) |
LabelsForEvent
LabelsForEvent
Event labels. Can be sandwich
or washtrade
.
Fields for LabelsForEvent
LabelsForEvent
Name | Description |
---|---|
sandwich (SandwichLabelForEvent) | |
washtrade (WashtradeLabelForEvent) |
LatestPair
LatestPair
Metadata for a newly listed pair.
Fields for LatestPair
LatestPair
Name | Description |
---|---|
address (String!) | The contract address for the pair. |
exchangeHash (String!) | The contract address for the exchange. |
id (String!) | The ID of the pair ( |
initialPriceUsd (String!) | The listing price, or first known price for the pair, in USD. |
liquidAt (Int) | The unix timestamp for when liquidity was added to the pair. |
liquidity (String!) | The total liquidity in the pair. |
liquidityToken (String) | The token with higher liquidity within the pair. Can be |
networkId (Int!) | The network ID the pair is deployed on. |
newToken (String!) | The newly added token within the pair. Can be |
nonLiquidityToken (String) | The token with lower liquidity within the pair. Can be |
oldToken (String!) | The pre-existing token within the pair. Can be |
priceChange (Float!) | The percent price change between the listing price and the current price. |
priceUsd (String!) | The newly added token price in USD. |
token0 (LatestPairToken!) | Metadata for |
token1 (LatestPairToken!) | Metadata for |
transactionHash (String!) | The unique hash for the transaction that added liquidity, if applicable, otherwise the transaction that added the pair. |
LatestPairConnection
LatestPairConnection
Response returned by getLatestPairs
.
Fields for LatestPairConnection
LatestPairConnection
Name | Description |
---|---|
cursor (String) | A cursor for use in pagination. |
items ([LatestPair!]!) | A list of newly listed pairs. |
LatestPairToken
LatestPairToken
Metadata for a token within a newly listed pair.
Fields for LatestPairToken
LatestPairToken
Name | Description |
---|---|
address (String!) | The contract address for the token. |
currentPoolAmount (String!) | The amount of |
decimals (Int!) | The precision to which the token can be divided. For example, the smallest unit for USDC is 0.000001 (6 decimals). |
id (String!) | The ID of the token ( |
initialPoolAmount (String!) | The initial amount of |
name (String!) | The name of the token. |
networkId (Int!) | The network ID the token is deployed on. |
pairId (String!) | The ID of the pair ( |
poolVariation (Float!) | The percent change |
symbol (String!) | The symbol for the token. |
LatestToken
LatestToken
Metadata for a newly created token.
Fields for LatestToken
LatestToken
Name | Description |
---|---|
blockHash (String!) | The unique hash for the token contract's creation block. |
blockNumber (Int!) | The block number of the token contract's creation. |
creatorAddress (String!) | The address of the token creator. |
creatorBalance (String!) | The token creator's network token balance. |
decimals (Int!) | The token's number of decimals. |
id (String!) | The id of the new token. (tokenAddress:networkId) |
networkId (Int!) | The network ID the token is deployed on. |
simulationResults ([LatestTokenSimResults!]!) | Simulated token contract results, if available. |
timeCreated (Int!) | The unix timestamp for the creation of the token. |
tokenAddress (String!) | The contract address of the new token. |
tokenName (String!) | The name of the token. |
tokenSymbol (String!) | The symbol of the token. |
totalSupply (String!) | The total supply of the token. |
traceIndex (Int!) | The index of the trace within the token contract's creation transaction. |
transactionHash (String!) | The unique hash for the token contract's creation transaction. |
transactionIndex (Int!) | The index of the transaction within the block. |
LatestTokenConnection
LatestTokenConnection
Response returned by getLatestTokens
.
Fields for LatestTokenConnection
LatestTokenConnection
Name | Description |
---|---|
items ([LatestToken!]!) | A list of newly created tokens. |
LatestTokenSimResults
LatestTokenSimResults
Fields for LatestTokenSimResults
LatestTokenSimResults
Name | Description |
---|---|
buyGasUsed (String) | Gas used for a buy transaction during simulation. |
buySuccess (Boolean) | Whether or not a token was able to be succesfully bought during simulation. |
buyTax (String) | Tax paid for a buy transaction during simulation. |
canRenounceOwnership (Boolean) | Whether or not the contract ownership was able to be renounced during simulation. |
canTransferOwnership (Boolean) | Whether or not the contract ownership was able to be transferred during simulation. |
isOwnerRenounced (Boolean) | Whether or not the contract ownership is already renounced during simulation (owner is 0x0). |
maxBuyAmount (String) | The maximum token amount an address can buy during simulation. |
maxSellAmount (String) | The maximum token amount an address can sell during simulation. |
openTradingCall (String) | If a call was found to trigger liquidity & trading, this is the call name. |
sellGasUsed (String) | Gas used for a sell transaction during simulation. |
sellSuccess (Boolean) | Whether or not a token was able to be succesfully sold during simulation. |
sellTax (String) | Tax paid for a sell transaction during simulation. |
LiquidityData
LiquidityData
Fields for LiquidityData
LiquidityData
LiquidityLock
LiquidityLock
A record of locked liquidity
Fields for LiquidityLock
LiquidityLock
Name | Description |
---|---|
createdAt (Int!) | The unix timestamp for when the lock was created. |
initialAmountToken0 (String!) | The inital amount of token0 locked. |
initialAmountToken1 (String!) | The inital amount of token1 locked. |
liquidityAmount (String!) | The amount of liquidity locked. |
liquidityNftData (LiquidityNftData) | If the liquidity position is represented by an NFT, this will contain the NFT data. |
liquidityProtocol (LiquidityProtocol!) | The protocol that created the pair |
lockerAddress (String!) | The address of the locker contract. |
lockProtocol (LiquidityLockProtocol!) | The protocol with which the liquidity is locked. |
networkId (Int!) | The network ID the pair is deployed on. |
ownerAddress (String!) | The wallet address of the owner. |
pairAddress (String!) | The pair address. |
unlockAt (Int) | The unix timestamp for when the lock expires. |
LiquidityLockConnection
LiquidityLockConnection
Fields for LiquidityLockConnection
LiquidityLockConnection
Name | Description |
---|---|
cursor (String) | A cursor for use in pagination. |
items ([LiquidityLock!]!) | A list of liquidity locks. |
LiquidityMetadata
LiquidityMetadata
Metadata about a pair's liquidity. Includes locked liquidity data.
Fields for LiquidityMetadata
LiquidityMetadata
Name | Description |
---|---|
liquidity (LiquidityData!) | Data about unlocked liquidity. |
lockedLiquidity (LockedLiquidityData!) | Data about locked liquidity. |
LiquidityNftData
LiquidityNftData
Liquidity NFT position data
Fields for LiquidityNftData
LiquidityNftData
ListPairsForTokenResponse
ListPairsForTokenResponse
Response returned by listPairsWithMetadataForToken
.
Fields for ListPairsForTokenResponse
ListPairsForTokenResponse
Name | Description |
---|---|
results ([ListPairsForTokenValue!]!) | A list of pairs containing a given token. |
ListPairsForTokenValue
ListPairsForTokenValue
Metadata for a pair containing a given token.
Fields for ListPairsForTokenValue
ListPairsForTokenValue
Name | Description |
---|---|
backingToken (EnhancedToken!) | Metadata for token with lower liquidity within the pair. |
exchange (Exchange!) | Exchange metadata for the pair. |
liquidity (String!) | The total liquidity in the pair. |
pair (Pair!) | Metadata for the pair. |
quoteToken (QuoteToken) | The token of interest within the pair. Can be |
token (EnhancedToken!) | Metadata for token with higher liquidity within the pair. |
volume (String!) | The volume for the pair in USD. |
LockBreakdown
LockBreakdown
Breakdown of how much and where liquidity is locked.
Fields for LockBreakdown
LockBreakdown
Name | Description |
---|---|
active (String!) | The amount of active liquidity locked. |
inactive (String!) | The amount of inactive liquidity locked. |
lockProtocol (LiquidityLockProtocol!) | The protocol with which the liquidity is locked. |
LockedLiquidityData
LockedLiquidityData
Data about locked liquidity.
Fields for LockedLiquidityData
LockedLiquidityData
Name | Description |
---|---|
active (String!) | The amount of active liquidity locked. |
inactive (String!) | The amount of inactive liquidity locked. |
lockBreakdown ([LockBreakdown]!) | A breakdown of how much and where liquidity is locked. |
MetadataResponse
MetadataResponse
The status for a network supported on Defined.
Fields for MetadataResponse
MetadataResponse
MintEventData
MintEventData
Event data for a token mint event.
Fields for MintEventData
MintEventData
Name | Description |
---|---|
amount0 (String) | The amount of |
amount0Shifted (String) | The amount of |
amount1 (String) | The amount of |
amount1Shifted (String) | The amount of |
tickLower (String) | The lower tick boundary of the position. Only applicable for UniswapV3 events. |
tickUpper (String) | The upper tick boundary of the position. Only applicable for UniswapV3 events. |
type (EventType!) | The type of token event, |
Network
Network
A network supported on Defined.
Fields for Network
Network
NewPoolEventData
NewPoolEventData
Event data for creating a new NFT pool.
Fields for NewPoolEventData
NewPoolEventData
Name | Description |
---|---|
assetRecipientAddress (String!) | The wallet address that will receive the tokens or NFT sent to the pair during swaps. |
bondingCurveAddress (String!) | The contract address of the bonding curve. |
bondingCurveType (BondingCurveType!) | The bonding curve type that defines how the prices of NFTs change after each buy or sell within a pool. |
buyPriceT (String!) | The initial price at which the pool is willing to buy an NFT in the pool's liquidity token. |
collectionAddress (String!) | The contract address of the NFT collection. |
createdAt (Int!) | The unix timestamp for the time the pool was created. |
delta (String!) | The initial delta used in the bonding curve. |
feeAmountT (String!) | The pool fee amount in the pool's liquidity token. |
nbtRatio (String!) | The ratio of the transaction token to the network's base token. |
networkId (Int!) | The network ID the NFT collection is deployed on. |
nftTokenBalance (String!) | The number of NFTs in the contract after the block has processed. |
ownerAddress (String!) | The wallet address of the pool owner. |
poolAddress (String!) | The contract address of the NFT pool. |
sellPriceT (String!) | The initial price at which the pool is willing to sell an NFT in the pool's liquidity token. |
startPriceT (String!) | The initial spot price in the pool's liquidity token. |
tokenAddress (String!) | The contract address of the liquidity token of the pool (usually WETH). |
tokenBalanceT (String!) | The amount of token in the contract after the block has processed in the pool's liquidity token. |
type (NftPoolEventType!) | The type of NFT pool event, |
usdRatio (String!) | The ratio of the transaction token to USD. |
NewPoolEventDataV2
NewPoolEventDataV2
Event data for creating a new NFT pool.
Fields for NewPoolEventDataV2
NewPoolEventDataV2
Name | Description |
---|---|
assetRecipientAddress (String!) | The wallet address that will receive the tokens or NFT sent to the pair during swaps. |
bondingCurveAddress (String!) | The contract address of the bonding curve. |
bondingCurveType (BondingCurveType!) | The bonding curve type that defines how the prices of NFTs change after each buy or sell within a pool. |
buyPriceT (String!) | The initial price at which the pool is willing to buy an NFT in the pool's liquidity token. |
collectionAddress (String!) | The contract address of the NFT collection. |
createdAt (Int!) | The unix timestamp for the time the pool was created. |
delta (String!) | The initial delta used in the bonding curve. |
feeAmountT (String!) | The pool fee amount in the pool's liquidity token. |
nbtRatio (String!) | The ratio of the transaction token to the network's base token. |
networkId (Int!) | The network ID the NFT collection is deployed on. |
nftAssets ([NftAsset]) | New Param: The list of NFT assets withdrawn. More extensive info than nftTokenIds. |
nftTokenIds ([String!]!) | The list of NFT token IDs initially deposited. |
nftTokenQuantities ([String]!) | The amount of each NFT token initially deposited. |
ownerAddress (String!) | The wallet address of the pool owner. |
poolAddress (String!) | The contract address of the NFT pool. |
poolNftType (PoolNftType!) | The type of NFT in the pool. |
propertyChecker (String) | The property checker contract address for the pool. |
royalties ([NftPoolRoyalty]) | The list of royalties for the pool. Only applicable for |
sellPriceT (String!) | The initial price at which the pool is willing to sell an NFT in the pool's liquidity token. |
startPriceT (String!) | The initial spot price in the pool's liquidity token. |
tokenAddress (String!) | The contract address of the liquidity token of the pool (usually WETH). |
tokenBalanceT (String!) | The amount of token in the contract after the block has processed in the pool's liquidity token. |
type (NftPoolEventType!) | The type of NFT pool event, |
usdRatio (String!) | The ratio of the transaction token to USD. |
NftAsset
NftAsset
An NFT asset.
Fields for NftAsset
NftAsset
Name | Description |
---|---|
address (String!) | The contract address of the NFT collection. |
attributes ([NftAssetAttribute!]) | The attributes for the NFT asset. |
description (String) | The description of the NFT asset. |
id (String!) | The ID of the NFT asset ( |
media (NftAssetMedia) | The NFT asset media. |
name (String) | The name of the NFT asset. |
networkId (Int!) | The network ID the NFT collection is deployed on. |
originalImage (String) | The source image URI linked by smart contract metadata. |
quantity (String) | The number of NFT assets with the same NFT token ID. Only applicable for ERC1155 tokens. |
rawAssetData (RawNftAssetData) | Raw NFT metadata from the smart contract. |
tokenId (String!) | The token ID of the NFT asset. |
uri (String) | The URI provided by the smart contract. Typically JSON that contains metadata. |
NftAssetAttribute
NftAssetAttribute
Attributes for an NFT asset.
Fields for NftAssetAttribute
NftAssetAttribute
Name | Description |
---|---|
class (String) | Suggested class name to use for css styling. An optional attribute of ERC-1155 assets. |
css (String) | Suggested CSS styling. An optional attribute of ERC-1155 assets. |
displayType (NftAssetAttributeDisplayType!) | The attribute display type. Can be |
maxValue (String) | The max value, if applicable. |
name (String!) | The name of the attribute. |
value (String!) | The value of the attribute. |
valueType (NftAssetAttributeType!) | The type for the |
NftAssetError
NftAssetError
Fields for NftAssetError
NftAssetError
Name | Description |
---|---|
address (String!) | The contract address of the NFT collection. |
id (String!) | The ID of the NFT asset ( |
message (String!) | The message of the asset error. |
networkId (Int!) | The network ID the NFT collection is deployed on. |
status (NftAssetErrorStatus!) | The status of the asset error. |
tokenId (String!) | The token ID of the NFT asset. |
NftAssetMedia
NftAssetMedia
NFT asset media.
Fields for NftAssetMedia
NftAssetMedia
NftAssetsConnection
NftAssetsConnection
Response returned by getNftAssets
.
Fields for NftAssetsConnection
NftAssetsConnection
Name | Description |
---|---|
cursor (String) | A cursor for use in pagination. |
itemErrors ([NftAssetError]) | A list of errors encountered while fetching the NFT assets. Errors correspond to null values in |
items ([NftAsset]) | A list of NFT assets. |
NftBalance
NftBalance
Wallet balance of an Nft Collection.
Fields for NftBalance
NftBalance
NftCollectionCurrencyStats
NftCollectionCurrencyStats
Price stats for an NFT collection over a time frame. Either in USD or the network's base token.
Fields for NftCollectionCurrencyStats
NftCollectionCurrencyStats
Name | Description |
---|---|
average (NftStatsStringMetrics) | The average sale price in the time frame. |
close (NftStatsStringMetrics) | The closing price for the time frame. |
highestSale (NftStatsStringMetrics) | The highest sale price in the time frame. |
lowestSale (NftStatsStringMetrics) | The lowest sale price in the time frame. |
open (NftStatsStringMetrics) | The opening price for the time frame. |
volume (NftStatsStringMetrics) | The volume over the time frame. |
volumeByFillsource ([NftFillsourceStatsStringMetrics]) | The volume partitioned by fillsource over the time frame |
volumePercentByFillsource ([NftFillsourceStatsNumberMetrics]) | The percentages of total volume partitioned by fillsource over the time frame |
NftCollectionFillsourceNumberStat
NftCollectionFillsourceNumberStat
Stat and change for a string based fillsource amount.
Fields for NftCollectionFillsourceNumberStat
NftCollectionFillsourceNumberStat
NftCollectionFillsourceStringStat
NftCollectionFillsourceStringStat
Stat and change for a string based fillsource amount.
Fields for NftCollectionFillsourceStringStat
NftCollectionFillsourceStringStat
NftCollectionFilterConnection
NftCollectionFilterConnection
Response returned by filterNftCollections
.
Fields for NftCollectionFilterConnection
NftCollectionFilterConnection
Name | Description |
---|---|
count (Int) | The number of NFT collections returned. |
offset (Int) | Where in the list the server started when returning items. |
results ([NftCollectionFilterResult]) | The list of NFT collections matching the filter parameters. |
NftCollectionFilterResult
NftCollectionFilterResult
An NFT collection matching a set of filter parameters.
Fields for NftCollectionFilterResult
NftCollectionFilterResult
Name | Description |
---|---|
address (String) | The contract address of the NFT collection. |
ercType (String) | The token standard. Can be a variation of |
grouping (String) | The marketplace address or |
id (String) | The ID of the NFT collection ( |
imageUrl (String) | The image URL for the collection or one of the assets within the collection. |
lastEventTimestamp (Int) | The unix timestamp for the last event. |
name (String) | The name of the NFT collection. |
networkId (Int) | The network ID the NFT collection is deployed on. |
stats1h (NftStatsWindowWithChange) | Stats for the past hour. |
stats4h (NftStatsWindowWithChange) | Stats for the past 4 hours. |
stats12h (NftStatsWindowWithChange) | Stats for the past 12 hours. |
stats24h (NftStatsWindowWithChange) | Stats for the past 24 hours. |
symbol (String) | The symbol of the NFT collection. |
timestamp (Int) | The unix timestamp indicating the last time the data was updated. Updates daily. |
totalSupply (String) | The total supply of the NFT collection. |
NftCollectionMetadataResponse
NftCollectionMetadataResponse
Response returned by getNftCollectionMetadata
.
Fields for NftCollectionMetadataResponse
NftCollectionMetadataResponse
Name | Description |
---|---|
contract (NftContract!) | Metadata for the NFT collection. |
id (String!) | The ID of the NFT collection ( |
media (NftAssetMedia) | The media for one of the assets within the NFT collection. |
stats ([NftCollectionWindowStats]) | A list of stats for the NFT collection across different time frames. |
NftCollectionNonCurrencyStats
NftCollectionNonCurrencyStats
Numerical stats for an NFT collection over a time frame.
Fields for NftCollectionNonCurrencyStats
NftCollectionNonCurrencyStats
Name | Description |
---|---|
mints (NftStatsNumberMetrics) | The number of mints over the time frame. |
sales (NftStatsNumberMetrics) | The number of sales over the time frame. |
tokensSold (NftStatsStringMetrics) | The number of tokens sold over the time frame. |
transfers (NftStatsNumberMetrics) | The number of transfers over the time frame. |
uniqueBuyers (NftStatsNumberMetrics) | The number of unique buyers over the time frame. |
uniqueMinters (NftStatsNumberMetrics) | The number of unique minters over the time frame. |
uniqueSalesWallets (NftStatsNumberMetrics) | The number of unique wallets (buyers or sellers) over the time frame. |
uniqueSellers (NftStatsNumberMetrics) | The number of unique sellers over the time frame. |
NftCollectionPriceStats
NftCollectionPriceStats
Price stats for an NFT collection over a time frame. Either in USD or the network's base token.
Fields for NftCollectionPriceStats
NftCollectionPriceStats
Name | Description |
---|---|
average (String!) | The average sale price. |
averageChange (Float) | The change in average price between the previous and current time frame. |
ceiling (String!) | The highest sale price. |
ceilingChange (Float) | The change in ceiling price between the previous and current time frame. |
floor (String!) | The lowest sale price. |
floorChange (Float) | The change in floor price between the previous and current time frame. |
volume (String!) | The trade volume. |
volumeByFillsource ([NftCollectionFillsourceStringStat]) | The volume partitioned by fillsource over the time frame |
volumeChange (Float) | The change in volume between the previous and current time frame. |
volumePercentByFillsource ([NftCollectionFillsourceNumberStat]) | The percentages of total volume partitioned by fillsource over the time frame |
NftCollectionWindowStats
NftCollectionWindowStats
Stats for an NFT collection for a time frame.
Fields for NftCollectionWindowStats
NftCollectionWindowStats
Name | Description |
---|---|
networkBaseTokenPriceStats (NftCollectionPriceStats!) | The price stats for the NFT collection in the network's base token. |
tradeCount (String!) | The trade count over the |
tradeCountChange (Float!) | The change in trade count between the previous and current |
usdPriceStats (NftCollectionPriceStats!) | The price stats for the NFT collection in USD. |
window (String!) | The time frame used to calculate the stats. |
NftContract
NftContract
Metadata for an NFT collection.
Fields for NftContract
NftContract
Name | Description |
---|---|
address (String!) | The contract address of the NFT collection. |
description (String) | The description of the NFT collection. |
ercType (String!) | The token standard. Can be a variation of |
id (String!) | The ID of the NFT collection ( |
image (String) | The URL for an image of the NFT collection. |
name (String) | The name of the NFT collection. |
networkId (Int!) | The network ID the NFT collection is deployed on. |
symbol (String) | The symbol for the NFT collection. |
totalSupply (String) | The total supply of the NFT collection. |
NftEvent
NftEvent
An NFT collection transaction.
Fields for NftEvent
NftEvent
Name | Description |
---|---|
aggregatorAddress (String) | The contract address of the marketplace aggregator that routed the transaction. |
baseTokenAddress (String!) | 🔴 DEPRECATED 🔴 |
baseTokenPrice (String) | 🔴 DEPRECATED 🔴 |
blockNumber (Int!) | The block number for the transaction. |
contractAddress (String!) | The contract address of the NFT collection. |
eventType (String!) | The event type of the transaction. |
exchangeAddress (String!) | The NFT marketplace address of the transaction. |
fillSource (String) | The name of the marketplace that processed the transaction. |
id (String!) | The ID of the NFT event ( |
individualBaseTokenPrice (String) | 🔴 DEPRECATED 🔴 |
individualNetworkBaseTokenPrice (String) | 🔴 DEPRECATED 🔴 |
individualPrice (String) | 🔴 DEPRECATED 🔴 |
individualPriceNetworkBaseToken (String) | The price of each individual NFT in the network's base token. |
individualPriceUsd (String) | The price of each individual NFT in USD. |
individualTokenPrice (String) | 🔴 DEPRECATED 🔴 |
individualTradePrice (String) | The price of each individual NFT in the purchasing token. |
logIndex (Int!) | The index of the log in the block. |
maker (String!) | The wallet address of the buyer. |
networkBaseTokenPrice (String) | 🔴 DEPRECATED 🔴 |
networkId (Int!) | The network ID the NFT collection is deployed on. |
numberOfTokens (String) | The number of assets involved in the transaction. |
orderDirection (NftEventOrderDirection) | The direction of the order. One of 'BUY', 'SELL', or 'OFFER_ACCEPTED'. |
paymentTokenAddress (String!) | The contract address of the purchasing token. |
poolAddress (String) | The contract address of the NFT pool, if applicable. |
priceError (String) | The reason for the price error, if applicable. Can be |
sortKey (String!) | The sortKey for the event ( |
taker (String!) | The wallet address of the seller. |
timestamp (Int!) | The unix timestamp for the transaction. |
tokenId (String!) | The token ID of the NFT asset involved in the transaction. |
tokenPrice (String!) | 🔴 DEPRECATED 🔴 |
totalPrice (String!) | 🔴 DEPRECATED 🔴 |
totalPriceNetworkBaseToken (String) | The total trade price for the transaction in the network's base token. (The transaction can include more than 1 token). |
totalPriceUsd (String) | The total trade price for the transaction in USD. (The transaction can include more than 1 token). |
totalTradePrice (String) | The total trade price for the transaction in the purchasing token. (The transaction can include more than 1 token). |
tradeOffer ([NftEventTradeItem!]) | The tokens/NFTs that were offered to make this transaction occur. |
tradeReceived ([NftEventTradeItem!]) | The tokens/NFTs that were received in this transaction. |
transactionHash (String!) | The unique hash for the transaction. |
transactionIndex (Int!) | The index of the transaction within the block. |
NftEventFillSourceCondition
NftEventFillSourceCondition
Fields for NftEventFillSourceCondition
NftEventFillSourceCondition
Name | Description |
---|---|
oneOf ([WebhookNftEventFillSource!]!) |
NftEventNftTradeItem
NftEventNftTradeItem
Details for an NFT offered or received as part of an nft trade.
Fields for NftEventNftTradeItem
NftEventNftTradeItem
Name | Description |
---|---|
address (String!) | The contract address for the NFT. |
amount (String!) | The number of tokens transferred. (Always 1 for ERC721 NFTs) |
recipient (String) | The recipient of the NFT. |
tokenId (String!) | The token ID of the exchanged NFT |
type (NftEventTradeItemType!) | The type of item involved in the trade. (Always NFT) |
NftEventsConnection
NftEventsConnection
Response returned by getNftEvents
.
Fields for NftEventsConnection
NftEventsConnection
NftEventTokenTradeItem
NftEventTokenTradeItem
Details for a token(s) offered or received as part of an nft trade.
Fields for NftEventTokenTradeItem
NftEventTokenTradeItem
Name | Description |
---|---|
address (String!) | The contract address for the token. |
amount (String!) | The number of tokens transferred. |
individualPriceNetworkBaseToken (String) | The price of each individual NFT in the network's base token. |
individualPriceUsd (String) | The price of each individual NFT in USD. |
individualTradePrice (String) | The price of each individual NFT in the purchasing token. |
isPrice (Boolean!) | 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 |
priceError (String) | The reason for the price error, if applicable. Can be |
recipient (String) | The recipient of the tokens. |
totalPriceNetworkBaseToken (String) | The total trade price for the transaction in the network's base token. (The transaction can include more than 1 token). |
totalPriceUsd (String) | The total trade price for the transaction in USD. (The transaction can include more than 1 token). |
totalTradePrice (String) | The total trade price for the transaction in the purchasing token. (The transaction can include more than 1 token). |
type (NftEventTradeItemType!) | The type of item involved in the trade. (Always TOKEN) |
NftEventTypeCondition
NftEventTypeCondition
Fields for NftEventTypeCondition
NftEventTypeCondition
Name | Description |
---|---|
eq (WebhookNftEventType!) |
NftEventWebhookCondition
NftEventWebhookCondition
Fields for NftEventWebhookCondition
NftEventWebhookCondition
Name | Description |
---|---|
contractAddress (StringEqualsCondition) | |
eventType (NftEventTypeCondition) | |
exchangeAddress (StringEqualsCondition) | |
fillSource (NftEventFillSourceCondition) | |
ignoreTransfers (Boolean) | |
individualBaseTokenPrice (ComparisonOperator) | |
maker (StringEqualsCondition) | |
networkId (OneOfNumberCondition) | |
tokenAddress (StringEqualsCondition) | |
tokenId (StringEqualsCondition) |
NftFillsourceStatsNumberMetrics
NftFillsourceStatsNumberMetrics
Number metrics for NFT fillsource stats.
Fields for NftFillsourceStatsNumberMetrics
NftFillsourceStatsNumberMetrics
NftFillsourceStatsStringMetrics
NftFillsourceStatsStringMetrics
String metrics for NFT stats.
Fields for NftFillsourceStatsStringMetrics
NftFillsourceStatsStringMetrics
NftHoldersResponse
NftHoldersResponse
Fields for NftHoldersResponse
NftHoldersResponse
Name | Description |
---|---|
count (Int!) | the unique count of holders for the collection. |
cursor (String) | A cursor for use in pagination. |
items ([NftBalance!]!) | The list wallets for a collection. |
status (HoldersStatus!) | Status of holder. Disabled if on unsupported network or there is insufficient holder data. |
NftPoolAssetRecipientUpdateEventData
NftPoolAssetRecipientUpdateEventData
Event data for updating the asset recipient of a pool.
Fields for NftPoolAssetRecipientUpdateEventData
NftPoolAssetRecipientUpdateEventData
Name | Description |
---|---|
newAssetRecipient (String!) | The updated wallet address that will receive the tokens or NFT sent to the pair during swaps. |
type (NftPoolEventType!) | The type of NFT pool event, |
NftPoolCollectionFilterConnection
NftPoolCollectionFilterConnection
Response returned by filterNftPoolCollections
.
Fields for NftPoolCollectionFilterConnection
NftPoolCollectionFilterConnection
Name | Description |
---|---|
count (Int) | The number of NFT collections returned. |
page (Int) | Where in the list the server started when returning items. |
results ([NftPoolCollectionFilterResult]) | The list of NFT collections matching the filter parameters. |
NftPoolCollectionFilterResult
NftPoolCollectionFilterResult
An NFT pool collection.
Fields for NftPoolCollectionFilterResult
NftPoolCollectionFilterResult
Name | Description |
---|---|
balanceNBT (String) | The total liquidity of the collection in the network's base token. |
balanceUSD (String) | The total liquidity of the collection in USD. |
collectionAddress (String) | The contract address of the NFT collection. |
ercType (String) | The token standard. Can be a variation of |
exchangeAddress (String) | The contract address of the NFT AMM marketplace. |
expenseNBT24 (String) | The total sell volume of the collection in the network's base token over the past 24 hours. |
expenseNBTAll (String) | The total sell volume of the collection in the network's base token over the collection's lifetime. |
expenseUSD24 (String) | The total sell volume of the collection in USD over the past 24 hours. |
expenseUSDAll (String) | The total sell volume of the collection in USD over the collection's lifetime. |
floorNBT (String) | The lowest price at which any of the collection's pools are willing to sell an NFT in the network's base token. |
floorUSD (String) | The lowest price at which any of the collection's pools are willing to sell an NFT in USD. |
highPriceNBT24 (String) | The highest sale price within the collection in the network's base token in the past 24 hours. |
highPriceNBTAll (String) | The highest sale price within the collection in the network's base token in the collection's lifetime. |
highPriceUSD24 (String) | The highest sale price within the collection in USD in the past 24 hours. |
highPriceUSDAll (String) | The highest sale price within the collection in USD in the collection's lifetime. |
id (String!) | The ID of the NFT collection ( |
imageUrl (String) | The image URL for the collection or one of the assets within the collection. |
lowPriceNBT24 (String) | The lowest sale price within the collection in the network's base token in the past 24 hours. |
lowPriceNBTAll (String) | The lowest sale price within the collection in the network's base token in the collection's lifetime. |
lowPriceUSD24 (String) | The lowest sale price within the collection in USD in the past 24 hours. |
lowPriceUSDAll (String) | The lowest sale price within the collection in USD in the collection's lifetime. |
name (String) | The name of the NFT collection. |
networkId (Int) | The network ID the NFT collection is deployed on. |
nftBalance (Int) | The number of NFTs in all of the collection's pools. 🔴 DEPRECATED 🔴 |
nftBalanceV2 (String) | The number of NFTs in all of the collection's pools. |
nftsBought24 (Int) | The number of NFTs bought in any of the collection's pools over the past 24 hours. 🔴 DEPRECATED 🔴 |
nftsBought24V2 (String) | The number of NFTs bought in any of the collection's pools over the past 24 hours. |
nftsBoughtAll (Int) | The number of NFTs bought in any of the collection's pools over the collection's lifetime. 🔴 DEPRECATED 🔴 |
nftsBoughtAllV2 (String) | The number of NFTs bought in any of the collection's pools over the collection's lifetime. |
nftsSold24 (Int) | The number of NFTs sold in any of the collection's pools over the past 24 hours. 🔴 DEPRECATED 🔴 |
nftsSold24V2 (String) | The number of NFTs sold in any of the collection's pools over the past 24 hours. |
nftsSoldAll (Int) | The number of NFTs sold in any of the collection's pools over the collection's lifetime. 🔴 DEPRECATED 🔴 |
nftsSoldAllV2 (String) | The number of NFTs sold in any of the collection's pools over the collection's lifetime. |
nftVolume24 (Int) | The number of NFTs bought and sold in any of the collection's pools over the past 24 hours. 🔴 DEPRECATED 🔴 |
nftVolume24V2 (String) | The number of NFTs bought and sold in any of the collection's pools over the past 24 hours. |
nftVolumeAll (Int) | The number of NFTs bought or sold in any of the collection's pools over the collection's lifetime. 🔴 DEPRECATED 🔴 |
nftVolumeAllV2 (String) | The number of NFTs bought or sold in any of the collection's pools over the collection's lifetime. |
offerNBT (String) | The highest price at which any of the collection's pools are willing to buy an NFT in the network's base token. |
offerUSD (String) | The highest price at which any of the collection's pools are willing to buy an NFT in USD. |
poolFeesNBT24 (String) | The sum of pool fees generated by the collection in the network's base token over the past 24 hours. |
poolFeesNBTAll (String) | The sum of pool fees generated by the collection in the network's base token over the collection's lifetime. |
poolFeesUSD24 (String) | The sum of pool fees generated by the collection in USD over the past 24 hours. |
poolFeesUSDAll (String) | The sum of pool fees generated by the collection in USD over the collection's lifetime. |
protocolFeesNBT24 (String) | The sum of protocol fees generated by the collection in the network's base token over the past 24 hours. |
protocolFeesNBTAll (String) | The sum of protocol fees generated by the collection in the network's base token over the collection's lifetime. |
protocolFeesUSD24 (String) | The sum of protocol fees generated by the collection in USD over the past 24 hours. |
protocolFeesUSDAll (String) | The sum of protocol fees generated by the collection in USD over the collection's lifetime. |
revenueNBT24 (String) | The total buy volume of the collection in the network's base token over the past 24 hours. |
revenueNBTAll (String) | The total buy volume of the collection in the network's base token over the collection's lifetime. |
revenueUSD24 (String) | The total buy volume of the collection in USD over the past 24 hours. |
revenueUSDAll (String) | The total buy volume of the collection in USD over the collection's lifetime. |
symbol (String) | The symbol for the NFT collection. |
timestamp (Int) | The unix timestamp indicating the last time the data was updated. Updates every 2 hours. |
totalSupply (Int) | The total supply of the collection. 🔴 DEPRECATED 🔴 |
totalSupplyV2 (String) | |
volumeNBT24 (String) | The total volume of the collection in the network's base token over the past 24 hours. |
volumeNBTAll (String) | The total volume of the collection in the network's base token over the collection's lifetime. |
volumeUSD24 (String) | The total volume of the collection in USD over the past 24 hours. |
volumeUSDAll (String) | The total volume of the collection in USD over the collection's lifetime. |
NftPoolCollectionResponse
NftPoolCollectionResponse
An NFT collection in an NFT pool.
Fields for NftPoolCollectionResponse
NftPoolCollectionResponse
Name | Description |
---|---|
balanceNBT (String!) | The total liquidity of the collection in the network's base token. |
collectionAddress (String!) | The contract address of the NFT collection. |
collectionId (String!) | The ID of the NFT collection ( |
collectionSymbol (String!) | The symbol of the NFT collection. |
exchangeAddress (String!) | The contract address of the NFT AMM marketplace. |
exchangeId (String!) | The ID of the exchange ( |
floorNBT (String) | The lowest price at which any of the NFT collection's pools are willing to sell an NFT in the network's base token. |
image (String) | An image associated with the NFT collection. |
media (NftAssetMedia) | The media for one of the assets within the NFT collection. 🔴 DEPRECATED 🔴 |
name (String) | The name of the NFT collection. |
networkId (Int!) | The network ID the NFT collection is deployed on. |
nftBalance (Int!) | The current number of NFTs in all the NFT collection's pools. 🔴 DEPRECATED 🔴 |
nftBalanceV2 (String!) | The current number of NFTs in all the NFT collection's pools. |
nftVolumeAllTime (Int) | The total number of NFTs bought and sold over the collection's lifetime. 🔴 DEPRECATED 🔴 |
nftVolumeAllTimeV2 (String) | The total number of NFTs bought and sold over the collection's lifetime. |
offerNBT (String) | The highest price at which any of the NFT collection's pools are willing to buy an NFT in the network's base token. |
poolFeesNBTAll (String) | The sum of pool fees generated by the collection in the network's base token over the collection's lifetime. |
poolFeesUSDAll (String) | The sum of pool fees generated by the collection in USD over the collection's lifetime. |
protocolFeesNBTAll (String) | The sum of protocol fees generated by the collection in the network's base token over the collection's lifetime. |
protocolFeesUSDAll (String) | The sum of protocol fees generated by the collection in USD over the collection's lifetime. |
royaltiesNBTAllEstimate (String) | As estimated sum in the network's base token of the collection's royalties paid to creators by pool swaps over the collection's lifetime. |
royaltiesUSDAllEstimate (String) | An estimated sum in USD of the collection's royalties paid to creators by pool swaps over the collection's lifetime. |
volumeAllTimeNBT (String) | The total volume of the collection in the network's base token over the collection's lifetime. |
volumeAllTimeUSD (String) | The total volume of the collection in USD over the collection's lifetime. |
NftPoolDeltaUpdateEventData
NftPoolDeltaUpdateEventData
Event data for updating the delta of a pool.
Fields for NftPoolDeltaUpdateEventData
NftPoolDeltaUpdateEventData
Name | Description |
---|---|
newDelta (String!) | The updated delta used in the bonding curve. |
type (NftPoolEventType!) | The type of NFT pool event, |
NftPoolEvent
NftPoolEvent
An NFT pool transaction.
Fields for NftPoolEvent
NftPoolEvent
Name | Description |
---|---|
blockHash (String!) | The hash of the block where the transaction occurred. |
blockNumber (Int!) | The block number for the transaction. |
collectionAddress (String!) | The contract address of the NFT collection. |
collectionId (String!) | The ID of the NFT collection ( |
data (NftPoolEventData!) | The event-specific data for the transaction. |
eventType (NftPoolEventType!) | The event type of the transaction. |
exchangeAddress (String!) | The contract address of the NFT AMM marketplace. |
id (String!) | The ID of the NFT pool ( |
logIndex (Int!) | The index of the log in the block. |
maker (String!) | The wallet address that transacted. |
networkId (Int!) | The network ID the NFT collection is deployed on. |
poolAddress (String!) | The contract address of the NFT pool. |
poolType (NftPoolType!) | The type of liquidity pool. |
timestamp (Int!) | The unix timestamp for the transaction. |
tokenAddress (String!) | The contract address of the liquidity token of the pool (usually WETH). |
transactionHash (String!) | The unique hash for the transaction. |
transactionIndex (Int!) | The index of the transaction within the block. |
NftPoolEventNftTransfer
NftPoolEventNftTransfer
Metadata for an NFT transfer.
Fields for NftPoolEventNftTransfer
NftPoolEventNftTransfer
NftPoolEventNftTransferV2
NftPoolEventNftTransferV2
Metadata for an NFT transfer.
Fields for NftPoolEventNftTransferV2
NftPoolEventNftTransferV2
Name | Description |
---|---|
amountT (String!) | The value of the token at the time of transfer. |
nftQuantity (String!) | The number of tokens involved in the transfer. |
nftTokenId (String!) | The NFT token ID involved in the transfer. |
nftTokenQuantity (String!) | The number of tokens involved in the transfer. 🔴 DEPRECATED 🔴 |
NftPoolEventsResponse
NftPoolEventsResponse
Response returned by getNftPoolEvents
.
Fields for NftPoolEventsResponse
NftPoolEventsResponse
Name | Description |
---|---|
cursor (String) | A cursor for use in pagination. |
items ([NftPoolEvent]) | A list of transactions for an NFT pool. |
NftPoolFeeUpdateEventData
NftPoolFeeUpdateEventData
Event data for updating the fee of a pool.
Fields for NftPoolFeeUpdateEventData
NftPoolFeeUpdateEventData
Name | Description |
---|---|
nbtRatio (String!) | The ratio of the transaction token to the network's base token. |
newFeeT (String!) | The updated pool fee in the pool's liquidity token. |
type (NftPoolEventType!) | The type of NFT pool event, |
usdRatio (String!) | The ratio of the transaction token to USD. |
NftPoolFilterConnection
NftPoolFilterConnection
Response returned by filterNftPools
.
Fields for NftPoolFilterConnection
NftPoolFilterConnection
Name | Description |
---|---|
count (Int) | The number of NFT pools returned. |
page (Int) | Where in the list the server started when returning items. |
results ([NftPoolFilterResult]) | The list of NFT pools matching the filter parameters. |
NftPoolFilterResult
NftPoolFilterResult
An NFT pool matching a set of filter parameters.
Fields for NftPoolFilterResult
NftPoolFilterResult
Name | Description |
---|---|
acceptedNftTokenIds ([String]) | For ERC1155 pools, the list of NFT token IDs that are accepted by the pool. |
assetRecipientAddress (String) | The wallet address that will receive the tokens or NFT sent to the pair during swaps. |
balanceNBT (String) | The current pool liquidity in the network's base token. |
balanceT (String) | The current value of the collection in the pool's liquidity token. |
balanceUSD (String) | The current pool liquidity in USD. |
bondingCurveAddress (String!) | The contract address of the bonding curve. |
collectionAddress (String!) | The contract address of the NFT collection. |
collectionName (String!) | The name of the NFT collection. |
collectionSymbol (String!) | The symbol of the NFT collection. |
delta (String!) | The delta used in the pool's bonding curve. |
exchangeAddress (String!) | The contract address of the NFT AMM marketplace. |
expenseNBT24 (String) | The total sell volume of the pool in the network's base token over the past 24 hours. |
expenseNBTAll (String) | The total sell volume of the pool in the network's base token over the pool's lifetime. |
expenseT24 (String) | The total sell volume of the pool in the pool's liquidity token over the past 24 hours. |
expenseTAll (String) | The total sell volume of the pool in the pool's liquidity token over the pool's lifetime. |
expenseUSD24 (String) | The total sell volume of the pool in USD over the past 24 hours. |
expenseUSDAll (String) | The total sell volume of the pool in USD over the pool's lifetime. |
feeAmount (String!) | The fee amount for the pool. |
id (String!) | The ID of the NFT pool ( |
networkId (Int!) | The network ID the NFT collection is deployed on. |
nftAssets ([NftAsset]) | The list of NFT assets in the pool. |
nftBalance (Int) | The current number of NFTs in the pool. 🔴 DEPRECATED 🔴 |
nftBalanceV2 (String) | The current number of NFTs in the pool. |
nftsBought24 (Int) | The total number of NFTs bought by the pool over the past 24 hours. 🔴 DEPRECATED 🔴 |
nftsBought24V2 (String) | The total number of NFTs bought by the pool over the past 24 hours. |
nftsBoughtAll (Int) | The total number of NFTs bought over the pool's lifetime. 🔴 DEPRECATED 🔴 |
nftsBoughtAllV2 (String) | The total number of NFTs bought over the pool's lifetime. |
nftsSold24 (Int) | The total number of NFTs sold by the pool over the past 24 hours. 🔴 DEPRECATED 🔴 |
nftsSold24V2 (String) | The total number of NFTs sold by the pool over the past 24 hours. |
nftsSoldAll (Int) | The total number of NFTs sold over the pool's lifetime. 🔴 DEPRECATED 🔴 |
nftsSoldAllV2 (String) | The total number of NFTs sold over the pool's lifetime. |
nftVolume24 (Int) | The total number of NFTs bought and sold over the past 24 hours. 🔴 DEPRECATED 🔴 |
nftVolume24V2 (String) | The total number of NFTs bought and sold over the past 24 hours. |
nftVolumeAll (Int) | The total number of NFTs bought and sold over the pool's lifetime. 🔴 DEPRECATED 🔴 |
nftVolumeAllV2 (String) | The total number of NFTs bought and sold over the pool's lifetime. |
offerNBT (String) | The current price at which the pool is willing to buy an NFT in the network's base token. |
offerT (String) | The current price at which the pool is willing to buy an NFT in the pool's liquidity token. |
offerUSD (String) | The current price at which the pool is willing to buy an NFT in USD. |
ownerAddress (String!) | The wallet address of the pool owner. |
poolAddress (String!) | The contract address of the NFT pool. |
poolFeesNBT24 (String) | The sum of pool fees generated by the pool in the network's base token over the past 24 hours. |
poolFeesNBTAll (String) | The sum of pool fees generated by the pool in the network's base token over the pool's lifetime. |
poolFeesT24 (String) | The sum of pool fees generated by the pool in the pool's liquidity token over the past 24 hours. |
poolFeesTAll (String) | The sum of pool fees generated by the pool in the pool's liquidity token over the pool's lifetime. |
poolFeesUSD24 (String) | The sum of pool fees generated by the pool in USD over the past 24 hours. |
poolFeesUSDAll (String) | The sum of pool fees generated by the pool in USD over the pool's lifetime. |
poolNftType (PoolNftType) | The type of NFT in the pool. |
poolType (NftPoolType!) | The type of liquidity pool. |
poolVariant (GraphQlNftPoolVariant!) | The pool variant. Can be |
propertyChecker (String) | The property checker contract address for the pool. |
protocolFeesNBT24 (String) | The sum of protocol fees generated by the pool in the network's base token over the past 24 hours. |
protocolFeesNBTAll (String) | The sum of protocol fees generated by the pool in the network's base token over the pool's lifetime. |
protocolFeesT24 (String) | The sum of protocol fees generated by the pool in the pool's liquidity token over the past 24 hours. |
protocolFeesTAll (String) | The sum of protocol fees generated by the pool in the pool's liquidity token over the pool's lifetime. |
protocolFeesUSD24 (String) | The sum of protocol fees generated by the pool in USD over the past 24 hours. |
protocolFeesUSDAll (String) | The sum of protocol fees generated by the pool in USD over the pool's lifetime. |
revenueNBT24 (String) | The total buy volume of the pool in the network's base token over the past 24 hours. |
revenueNBTAll (String) | The total buy volume of the pool in the network's base token over the pool's lifetime. |
revenueT24 (String) | The total buy volume of the pool in the pool's liquidity token over the past 24 hours. |
revenueTAll (String) | The total buy volume of the pool in the pool's liquidity token over the pool's lifetime. |
revenueUSD24 (String) | The total buy volume of the pool in USD over the past 24 hours. |
revenueUSDAll (String) | The total buy volume of the pool in USD over the pool's lifetime. |
royalties ([NftPoolRoyalty]) | The list of royalties for the pool. Only applicable for |
sellNBT (String) | The current price at which the pool is willing to sell an NFT. |
sellT (String) | The current price at which the pool is willing to sell an NFT in the network's base token. |
sellUSD (String) | The current price at which the pool is willing to sell an NFT in USD. |
spotNBT (String) | The current spot price for the pool in the network's base token. |
spotT (String) | The current spot price for the pool in the pool's liquidity token. |
timestamp (Int!) | The unix timestamp indicating the last time the data was updated. Updates every 2 hours. |
tokenAddress (String!) | The contract address of the liquidity token of the pool. |
version (NftPoolContractVersion) | The NFT pool contract version. Can be |
volumeNBT24 (String) | The total volume of the pool in the network's base token over the past 24 hours. |
volumeNBTAll (String) | The total volume of the pool in the network's base token over the pool's lifetime. |
volumeT24 (String) | The total volume of the pool in the pool's liquidity token over the past 24 hours. |
volumeTAll (String) | The total volume of the pool in the pool's liquidity token over the pool's lifetime. |
volumeUSD24 (String) | The total volume of the pool in USD over the past 24 hours. |
volumeUSDAll (String) | The total volume of the pool in USD over the pool's lifetime. |
NftPoolNftDepositEventData
NftPoolNftDepositEventData
Event data for depositing an NFT into a pool.
Fields for NftPoolNftDepositEventData
NftPoolNftDepositEventData
Name | Description |
---|---|
nftTokenBalance (String!) | The number of NFTs in the contract after the block has processed. |
nftTokenIds ([String!]!) | The list of NFT token IDs deposited. |
tokenBalanceT (String!) | The amount of token in the contract after the block has processed in the pool's liquidity token. |
type (NftPoolEventType!) | The type of NFT pool event, |
NftPoolNftDepositEventDataV2
NftPoolNftDepositEventDataV2
Event data for depositing an NFT into a pool.
Fields for NftPoolNftDepositEventDataV2
NftPoolNftDepositEventDataV2
Name | Description |
---|---|
nftAssets ([NftAsset]) | New Param: The list of NFT assets withdrawn. More extensive info than nftTokenIds. |
nftTokenAmounts ([String!]!) | The amount of each NFT token deposited. |
nftTokenIds ([String!]!) | The list of NFT token IDs deposited. |
tokenBalanceT (String!) | The amount of token in the contract after the block has processed in the pool's liquidity token. |
type (NftPoolEventType!) | The type of NFT pool event, |
NftPoolNftWithdrawalEventData
NftPoolNftWithdrawalEventData
Event data for withdrawing an NFT from a pool.
Fields for NftPoolNftWithdrawalEventData
NftPoolNftWithdrawalEventData
Name | Description |
---|---|
nftTokenBalance (String!) | The number of NFTs in the contract after the block has processed. |
nftTokenIds ([String!]!) | The NFT token IDs withdrawn. |
tokenBalanceT (String!) | The amount of token in the contract after the block has processed in the pool's liquidity token. |
type (NftPoolEventType!) | The type of NFT pool event, |
NftPoolNftWithdrawalEventDataV2
NftPoolNftWithdrawalEventDataV2
Event data for withdrawing an NFT from a pool.
Fields for NftPoolNftWithdrawalEventDataV2
NftPoolNftWithdrawalEventDataV2
Name | Description |
---|---|
nftAssets ([NftAsset]) | New Param: The list of NFT assets withdrawn. More extensive info than nftTokenIds. |
nftTokenAmounts ([String!]!) | The amount of each NFT token withdrawn. |
nftTokenIds ([String!]!) | The list of NFT token IDs withdrawn. |
tokenBalanceT (String!) | The amount of token in the contract after the block has processed in the pool's liquidity token. |
type (NftPoolEventType!) | The type of NFT pool event, |
NftPoolOwnershipTransferredEventDataV2
NftPoolOwnershipTransferredEventDataV2
Fields for NftPoolOwnershipTransferredEventDataV2
NftPoolOwnershipTransferredEventDataV2
Name | Description |
---|---|
newOwner (String!) | The new owner of the pool. |
type (NftPoolEventType!) | The type of NFT pool event, |
NftPoolResponse
NftPoolResponse
An NFT pool.
Fields for NftPoolResponse
NftPoolResponse
Name | Description |
---|---|
acceptedNftTokenIds ([String]) | For ERC1155 pools, the list of NFT token IDs that are accepted by the pool. |
assetRecipientAddress (String!) | The wallet address that will receive the tokens or NFT sent to the pair during swaps. |
balanceNBT (String!) | The current pool liquidity in the network's base token. |
balanceT (String!) | The current pool liquidity in the pool's liquidity token. |
bondingCurveAddress (String!) | The contract address of the bonding curve. |
bondingCurveType (BondingCurveType!) | The bonding curve type that defines how the prices of NFTs change after each buy or sell within a pool. |
collectionAddress (String!) | The contract address of the NFT collection. |
collectionName (String!) | The contract name of the NFT collection. |
collectionSymbol (String) | The symbol of the NFT collection. |
delta (String!) | The current delta used in the bonding curve. |
exchangeAddress (String!) | The contract address of the NFT AMM marketplace. |
fee (String!) | The current fee for pool. |
floorNBT (String) | The current price at which the pool is willing to sell an NFT in the network's base token. Only applicable for |
floorT (String) | The current price at which the pool is willing to sell an NFT in the pool's liquidity token. Only applicable for |
networkId (Int!) | The network ID the NFT collection is deployed on. |
nftAssets ([NftAsset]) | The list of NFT assets in the pool. |
nftBalance (Int) | The current number of NFTs in the pool. 🔴 DEPRECATED 🔴 |
nftBalanceV2 (String!) | The current number of NFTs in the pool. |
nftVolumeAllTime (Int!) | The total number of NFTs bought and sold over the pool's lifetime. 🔴 DEPRECATED 🔴 |
nftVolumeAllTimeV2 (String!) | The total number of NFTs bought and sold over the pool's lifetime. |
offerNBT (String) | The current price at which the pool is willing to buy an NFT in the network's base token. Only applicable for |
offerT (String) | The current price at which the pool is willing to buy an NFT in the pool's liquidity token. Only applicable for |
owner (String!) | The wallet address of the pool owner. |
poolAddress (String!) | The contract address of the NFT pool. |
poolFeesAllTimeNBT (String) | |
poolFeesAllTimeT (String) | |
poolId (String!) | The ID of the NFT pool ( |
poolNftType (PoolNftType) | The type of NFT in the pool. |
poolType (NftPoolType!) | The type of liquidity pool. |
poolVariant (GraphQlNftPoolVariant!) | The pool variant. Can be |
propertyChecker (String) | The property checker contract address for the pool. |
royalties ([NftPoolRoyalty]) | The list of royalties for the pool. Only applicable for |
spotPriceNBT (String!) | The spot price in the network's base token. |
spotPriceT (String!) | The instantaneous price for selling 1 NFT to the pool in the pool's liquidity token. |
tokenAddress (String!) | The contract address of the liquidity token of the pool (usually WETH). |
version (NftPoolContractVersion) | The NFT pool contract version. Can be |
volumeAllTimeNBT (String!) | The total volume of the pool in the network's base token over the pool's lifetime. |
volumeAllTimeT (String!) | The total volume of the pool in the pool's liquidity token over the pool's lifetime. |
NftPoolRoyalty
NftPoolRoyalty
The royalty for a SUDOSWAP_V2 pool.
Fields for NftPoolRoyalty
NftPoolRoyalty
NftPoolSpotPriceUpdateEventData
NftPoolSpotPriceUpdateEventData
Event data for updating the spot price of a pool.
Fields for NftPoolSpotPriceUpdateEventData
NftPoolSpotPriceUpdateEventData
Name | Description |
---|---|
nbtRatio (String!) | The ratio of the transaction token to the network's base token. |
newBuyPriceT (String!) | The updated price at which the pool is willing to buy an NFT in the pool's liquidity token. |
newSellPriceT (String!) | The updated price at which the pool is willing to sell an NFT in the pool's liquidity token. |
newSpotPriceT (String!) | The updated spot price in the pool's liquidity token. |
type (NftPoolEventType!) | The type of NFT pool event, |
usdRatio (String!) | The ratio of the transaction token to USD. |
NftPoolSpotPriceUpdateEventDataV2
NftPoolSpotPriceUpdateEventDataV2
Event data for updating the spot price of a pool.
Fields for NftPoolSpotPriceUpdateEventDataV2
NftPoolSpotPriceUpdateEventDataV2
Name | Description |
---|---|
nbtRatio (String!) | The ratio of the transaction token to the network's base token. |
newBuyPriceT (String!) | The updated price at which the pool is willing to buy an NFT in the pool's liquidity token. |
newSellPriceT (String!) | The updated price at which the pool is willing to sell an NFT in the pool's liquidity token. |
newSpotPriceT (String!) | The updated spot price in the pool's liquidity token. |
type (NftPoolEventType!) | The type of NFT pool event, |
usdRatio (String!) | The ratio of the transaction token to USD. |
NftPoolStatsResponse
NftPoolStatsResponse
Stats for an NFT pool.
Fields for NftPoolStatsResponse
NftPoolStatsResponse
Name | Description |
---|---|
closeBalanceNBT (String) | The pool liquidity in the network's base token at the end of the time frame. |
closeNftBalanceV2 (String) | The number of NFTs in the pool at the end of the time frame. |
collectionAddress (String!) | The contract address of the NFT collection. |
endTime (Int!) | The unix timestamp for the end of the time frame. |
exchangeAddress (String!) | The contract address of the NFT AMM marketplace. |
expenseNBT (String) | The total sell volume of the pool in the network's base token over the time frame. |
highFloorNBT (String) | The highest price at which the pool was willing to sell an NFT in the network's base token over the time frame. |
highOfferNBT (String) | The highest price at which the pool was willing to buy an NFT in the network's base token over the time frame. |
lowFloorNBT (String) | The lowest price at which the pool was willing to sell an NFT in the network's base token over the time frame. |
lowOfferNBT (String) | The lowest price at which the pool was willing to buy an NFT in the network's base token over the time frame. |
networkId (Int!) | The network ID the NFT collection is deployed on. |
nftsBoughtV2 (String) | The total number of NFTs bought over the time frame. |
nftsSoldV2 (String) | The total number of NFTs sold over the time frame. |
nftVolumeV2 (String) | The total number of NFTs bought and sold over the time frame. |
openBalanceNBT (String) | The pool liquidity in the network's base token at the start of the time frame. |
openNftBalanceV2 (String) | The number of NFTs in the pool at the start of the time frame. |
poolAddress (String) | The contract address of the NFT pool. |
poolFeesNBT (String) | The sum of pool fees generated by the pool in the network's base token over the time frame. |
protocolFeesNBT (String) | The sum of protocol fees generated by the pool in the network's base token over the time frame. |
revenueNBT (String) | The total buy volume of the pool in the network's base token over the time frame. |
startTime (Int!) | The unix timestamp for the start of the time frame. |
volumeNBT (String) | The total volume of the pool in the network's base token over the time frame. |
NftPoolTokenDepositEventData
NftPoolTokenDepositEventData
Event data for depositing a token into a pool.
Fields for NftPoolTokenDepositEventData
NftPoolTokenDepositEventData
Name | Description |
---|---|
amountT (String!) | The total value of token deposited in the pool's liquidity token. |
nbtRatio (String!) | The ratio of the transaction token to the network's base token. |
nftTokenBalance (String!) | The number of NFTs in the contract after the block has processed. |
tokenBalanceT (String!) | The amount of token in the contract after the block has processed in the pool's liquidity token. |
type (NftPoolEventType!) | The type of NFT pool event, |
usdRatio (String!) | The ratio of the transaction token to USD. |
NftPoolTokenDepositEventDataV2
NftPoolTokenDepositEventDataV2
Event data for depositing a token into a pool.
Fields for NftPoolTokenDepositEventDataV2
NftPoolTokenDepositEventDataV2
Name | Description |
---|---|
amountT (String!) | The total value of token deposited in the pool's liquidity token. |
nbtRatio (String!) | The ratio of the transaction token to the network's base token. |
tokenBalanceT (String!) | The amount of token in the contract after the block has processed in the pool's liquidity token. |
type (NftPoolEventType!) | The type of NFT pool event, |
usdRatio (String!) | The ratio of the transaction token to USD. |
NftPoolTokenWithdrawalEventData
NftPoolTokenWithdrawalEventData
Event data for withdrawing a token from a pool.
Fields for NftPoolTokenWithdrawalEventData
NftPoolTokenWithdrawalEventData
Name | Description |
---|---|
amountT (String!) | The total value of token withdrawn in the pool's liquidity token. |
nbtRatio (String!) | The ratio of the transaction token to the network's base token. |
nftTokenBalance (String!) | The number of NFTs in the contract after the block has processed. |
tokenBalanceT (String!) | The amount of token in the contract after the block has processed in the pool's liquidity token. |
type (NftPoolEventType!) | The type of NFT pool event, |
usdRatio (String!) | The ratio of the transaction token to USD. |
NftPoolTokenWithdrawalEventDataV2
NftPoolTokenWithdrawalEventDataV2
Event data for withdrawing a token from a pool.
Fields for NftPoolTokenWithdrawalEventDataV2
NftPoolTokenWithdrawalEventDataV2
Name | Description |
---|---|
amountT (String!) | The total value of token withdrawn in the pool's liquidity token. |
nbtRatio (String!) | The ratio of the transaction token to the network's base token. |
tokenBalanceT (String!) | The amount of token in the contract after the block has processed in the pool's liquidity token. |
type (NftPoolEventType!) | The type of NFT pool event, |
usdRatio (String!) | The ratio of the transaction token to USD. |
NftSearchResponse
NftSearchResponse
Response returned by searchNfts
.
Fields for NftSearchResponse
NftSearchResponse
Name | Description |
---|---|
hasMore (Int!) | The number of additional results found. |
items ([NftSearchResponseCollection]) | A list of NFT collections matching a given query string. |
NftSearchResponseCollection
NftSearchResponseCollection
An NFT collection matching a given query string.
Fields for NftSearchResponseCollection
NftSearchResponseCollection
Name | Description |
---|---|
address (String!) | The contract address of the NFT collection. |
average (String!) | The average sale price over the |
ceiling (String!) | The highest sale price over the |
floor (String!) | The lowest sale price over the |
id (String!) | The ID of the NFT collection ( |
imageUrl (String) | The image URL for the collection or one of the assets within the collection. |
name (String) | The name of the NFT collection. For example, |
networkId (Int!) | The network ID the NFT collection is deployed on. |
symbol (String) | The symbol of the NFT collection. For example, |
tradeCount (String!) | The trade count over the |
tradeCountChange (Float!) | The change in trade count between the previous and current |
volume (String!) | The trade volume in USD over the |
volumeChange (Float!) | The change in volume between the previous and current |
window (String!) | The time frame used for calculating stats. |
NftStatsNumberMetrics
NftStatsNumberMetrics
Number metrics for NFT stats.
Fields for NftStatsNumberMetrics
NftStatsNumberMetrics
NftStatsStringMetrics
NftStatsStringMetrics
String metrics for NFT stats.
Fields for NftStatsStringMetrics
NftStatsStringMetrics
NftStatsWindowWithChange
NftStatsWindowWithChange
NFT stats over a time frame.
Fields for NftStatsWindowWithChange
NftStatsWindowWithChange
Name | Description |
---|---|
endTime (Int) | The unix timestamp for the end of the window. |
networkBaseToken (NftCollectionCurrencyStats) | The currency stats in the network's base token, such as volume. |
nonCurrency (NftCollectionNonCurrencyStats) | The numerical stats, such as number of sales. |
startTime (Int) | The unix timestamp for the start of the window. |
usd (NftCollectionCurrencyStats) | The currency stats in USD, such as volume. |
OnBarsUpdatedResponse
OnBarsUpdatedResponse
Response returned by onBarsUpdated
.
Fields for OnBarsUpdatedResponse
OnBarsUpdatedResponse
Name | Description |
---|---|
aggregates (ResolutionBarData!) | Price data broken down by resolution. |
eventSortKey (String!) | The sortKey for the bar ( |
networkId (Int!) | The network ID the pair is deployed on. |
pairAddress (String!) | The contract address for the pair. |
pairId (String!) | The ID for the pair ( |
quoteToken (QuoteToken) | The quote token within the pair. |
statsType (TokenPairStatisticsType!) | The type of statistics used. Can be |
timestamp (Int!) | The unix timestamp for the new bar. |
OneOfNumberCondition
OneOfNumberCondition
Fields for OneOfNumberCondition
OneOfNumberCondition
Name | Description |
---|---|
oneOf ([Int!]!) |
Pair
Pair
Metadata for a token pair.
Fields for Pair
Pair
Name | Description |
---|---|
address (String!) | The contract address of the pair. |
createdAt (Int) | The unix timestamp for the creation of the pair. |
exchangeHash (String!) | The address for the exchange factory contract. |
fee (Int) | The exchange fee for swaps. |
id (String!) | The ID for the pair ( |
networkId (Int!) | The network ID the pair is deployed on. |
pooled (PooledTokenValues) | The pooled amounts of each token in the pair. |
tickSpacing (Int) | The amount of required tick separation. Only applicable for pairs on UniswapV3. |
token0 (String!) | The contract address of |
token0Data (EnhancedToken) | |
token1 (String!) | The contract address of |
token1Data (EnhancedToken) |
PairFilterConnection
PairFilterConnection
Response returned by filterPairs
.
Fields for PairFilterConnection
PairFilterConnection
Name | Description |
---|---|
count (Int) | The number of pairs returned. |
offset (Int) | Where in the list the server started when returning items. |
results ([PairFilterResult]) | The list of pairs matching the filter parameters. |
PairFilterResult
PairFilterResult
A pair matching a set of filter parameters.
Fields for PairFilterResult
PairFilterResult
Name | Description |
---|---|
buyCount1 (Int) | The number of buys in the past hour. |
buyCount4 (Int) | The number of buys in the past 4 hours. |
buyCount12 (Int) | The number of buys in the past 12 hours. |
buyCount24 (Int) | The number of buys in the past 24 hours. |
createdAt (Int) | The unix timestamp for the creation of the pair. |
exchange (FilterExchange) | Exchange metadata for the pair. |
highPrice1 (String) | The highest price in USD in the past hour. |
highPrice4 (String) | The highest price in USD in the past 4 hours. |
highPrice12 (String) | The highest price in USD in the past 12 hours. |
highPrice24 (String) | The highest price in USD in the past 24 hours. |
lastTransaction (Int) | The unix timestamp for the last transaction to happen on the pair. |
liquidity (String) | Amount of liquidity in the pair. |
liquidityToken (String) | The token with higher liquidity in the pair. Can be |
lockedLiquidityPercentage (Float!) | The locked liquidity percentage. |
lowPrice1 (String) | The lowest price in USD in the past hour. |
lowPrice4 (String) | The lowest price in USD in the past 4 hours. |
lowPrice12 (String) | The lowest price in USD in the past 12 hours. |
lowPrice24 (String) | The lowest price in USD in the past 24 hours. |
marketCap (String) | The fully diluted market cap. |
pair (Pair) | Metadata for the pair. |
price (String) | The token price in USD. |
priceChange1 (String) | The percent price change in the past hour. Decimal format. |
priceChange4 (String) | The percent price change in the past 4 hours. Decimal format. |
priceChange12 (String) | The percent price change in the past 12 hours. Decimal format. |
priceChange24 (String) | The percent price change in the past 24 hours. Decimal format. |
priceScale (String) | 10^n, where n is the number of decimal places the price has. Max 16. Used for TradingView settings. |
quoteToken (String) | The token of interest. Can be |
sellCount1 (Int) | The number of sells in the past hour. |
sellCount4 (Int) | The number of sells in the past 4 hours. |
sellCount12 (Int) | The number of sells in the past 12 hours. |
sellCount24 (Int) | The number of sells in the past 24 hours. |
token0 (EnhancedToken) | Metadata for the first token in the pair. |
token1 (EnhancedToken) | Metadata for the second token in the pair. |
txnCount1 (Int) | The number of transactions in the past hour. |
txnCount4 (Int) | The number of transactions in the past 4 hours. |
txnCount12 (Int) | The number of transactions in the past 12 hours. |
txnCount24 (Int) | The number of transactions in the past 24 hours. |
uniqueBuys1 (Int) | The unique number of buys in the past hour. |
uniqueBuys4 (Int) | The unique number of buys in the past 4 hours. |
uniqueBuys12 (Int) | The unique number of buys in the past 12 hours. |
uniqueBuys24 (Int) | The unique number of buys in the past 24 hours. |
uniqueSells1 (Int) | The unique number of sells in the past hour. |
uniqueSells4 (Int) | The unique number of sells in the past 4 hours. |
uniqueSells12 (Int) | The unique number of sells in the past 12 hours. |
uniqueSells24 (Int) | The unique number of sells in the past 24 hours. |
uniqueTransactions1 (Int) | The unique number of transactions in the past hour. |
uniqueTransactions4 (Int) | The unique number of transactions in the past 4 hours. |
uniqueTransactions12 (Int) | The unique number of transactions in the past 12 hours. |
uniqueTransactions24 (Int) | The unique number of transactions in the past 24 hours. |
volumeUSD1 (String) | The trade volume in USD in the past hour. |
volumeUSD4 (String) | The trade volume in USD in the past 4 hours. |
volumeUSD12 (String) | The trade volume in USD in the past 12 hours. |
volumeUSD24 (String) | The trade volume in USD in the past 24 hours. |
PairMetadata
PairMetadata
Fields for PairMetadata
PairMetadata
Name | Description |
---|---|
exchangeId (String) | |
fee (Int) | |
highPrice1 (String) | |
highPrice1w (String) | |
highPrice4 (String) | |
highPrice12 (String) | |
highPrice24 (String) | |
id (String!) | |
liquidity (String!) | |
liquidityToken (String) | |
lowPrice1 (String) | |
lowPrice1w (String) | |
lowPrice4 (String) | |
lowPrice12 (String) | |
lowPrice24 (String) | |
networkId (Int) | |
nonLiquidityToken (String) | |
pairAddress (String!) | |
price (String!) | |
priceChange1 (Float) | |
priceChange1w (Float) | |
priceChange4 (Float) | |
priceChange5m (Float) | |
priceChange12 (Float) | |
priceChange24 (Float) | |
quoteToken (QuoteToken) | |
statsType (TokenPairStatisticsType!) | |
tickSpacing (Int) | |
token0 (PairMetadataToken!) | |
token1 (PairMetadataToken!) | |
volume1 (String) | |
volume1w (String) | |
volume4 (String) | |
volume12 (String) | |
volume24 (String) |
PairMetadataToken
PairMetadataToken
Fields for PairMetadataToken
PairMetadataToken
ParallelAsset
ParallelAsset
A Parallel asset.
Fields for ParallelAsset
ParallelAsset
Name | Description |
---|---|
address (String!) | The contract address of the NFT collection. |
attributes ([NftAssetAttribute!]) | The attributes for the NFT asset. |
description (String) | The description of the NFT asset. |
gameData (ParallelAssetGameData) | The game data for the NFT asset. |
id (String!) | The ID of the NFT asset ( |
media (NftAssetMedia) | The NFT asset media. |
metadata (ParallelAssetMetadata) | Metadata for the NFT asset. |
name (String) | The name of the NFT asset. |
networkId (Int!) | The network ID the NFT collection is deployed on. |
originalImage (String) | The source image URI linked by smart contract metadata. |
tokenId (String!) | The token ID of the NFT asset. |
uri (String) | The URI provided by the smart contract. Typically JSON that contains metadata. |
ParallelAssetFilterConnection
ParallelAssetFilterConnection
Response returned by filterNftParallelAssets
.
Fields for ParallelAssetFilterConnection
ParallelAssetFilterConnection
Name | Description |
---|---|
count (Int) | The number of Parallel assets returned. |
offset (Int) | Where in the list the server started when returning items. |
results ([ParallelAssetFilterResult]) | The list of Parallel assets matching the filter parameters. |
ParallelAssetFilterResult
ParallelAssetFilterResult
A Parallel asset matching a set of filter parameters.
Fields for ParallelAssetFilterResult
ParallelAssetFilterResult
Name | Description |
---|---|
address (String!) | The contract address of the NFT collection. |
description (String) | The description of the NFT asset. |
gameData (ParallelAssetGameData) | The game data for the NFT asset. |
id (String!) | The ID of the NFT asset ( |
lastPriceNetworkBaseToken (String) | The last sale price in the network's base token. |
lastPriceUsd (String) | The last sale price in USD. |
media (NftAssetMedia) | The NFT asset media. |
metadata (ParallelAssetMetadata) | Metadata for the NFT asset. |
name (String) | The name of the NFT asset. |
networkId (Int!) | The network ID the NFT collection is deployed on. |
originalImage (String) | The source image URI linked by smart contract metadata. |
parallelId (Int!) | The internal Parallel ID of the NFT asset. |
timestamp (Int) | The unix timestamp for the last trade. |
tokenId (String!) | The token ID of the NFT asset. |
uri (String) | The URI provided by the smart contract. Typically JSON that contains metadata. |
ParallelAssetGameData
ParallelAssetGameData
Game data for a Parallel asset.
Fields for ParallelAssetGameData
ParallelAssetGameData
Name | Description |
---|---|
attack (String) | The damage dealt when engaged in combat. |
cardType (String) | The card type. Can be |
cost (String) | The energy used to play in-game. |
functionText (String) | The description of the card's in-game abilities. |
health (String) | The possible damage received before being destroyed. |
parallel (String) | The Parallel the asset belongs to. |
passiveAbility (String) | The description of the card's passive ability. |
rarity (String) | The rarity of the asset. Can be |
subtype (String) | The card subtype. Can be |
ParallelAssetMetadata
ParallelAssetMetadata
Fields for ParallelAssetMetadata
ParallelAssetMetadata
Name | Description |
---|---|
artist (String) | The artist name. |
class (String) | The card class. Can be |
expansion (String) | The expansion used for naming base and expansion sets. |
flavourText (String) | The asset description, sourced off-chain. Usually equal to the asset's on-chain |
parallelId (String) | The ID used to match other cards with the same name but different class. |
paraset (String) | The paraset the asset belongs to. |
supply (String) | The total supply of this individual asset. |
ParallelAssetsConnection
ParallelAssetsConnection
Response returned by getParallelAssets
.
Fields for ParallelAssetsConnection
ParallelAssetsConnection
Name | Description |
---|---|
cursor (String) | A cursor for use in pagination. |
items ([ParallelAsset]) | A list of Parallel assets. |
ParallelCardChange
ParallelCardChange
Tracked changes made to a Parallel card.
Fields for ParallelCardChange
ParallelCardChange
Name | Description |
---|---|
diff (ParallelCardChangeDiff!) | The Parallel card metadata before and after the card change. |
timestamp (Int!) | The unix timestamp for the card change. |
tokenId (String!) | The token ID of the Parallel asset. |
ParallelCardChangeDiff
ParallelCardChangeDiff
Parallel card metadata before and after a card change.
Fields for ParallelCardChangeDiff
ParallelCardChangeDiff
Name | Description |
---|---|
new (ParallelCardChangeFields!) | Metadata for a Parallel card after the card change. |
old (ParallelCardChangeFields!) | Metadata for a Parallel card before the card change. |
ParallelCardChangeFields
ParallelCardChangeFields
Metadata for a Parallel card.
Fields for ParallelCardChangeFields
ParallelCardChangeFields
Name | Description |
---|---|
artist (String) | The artist name. |
attack (String) | The damage dealt when engaged in combat. |
cardType (String) | The card type. Can be |
class (String) | The card class. Can be |
cost (String) | The energy used to play in-game. |
expansion (String) | The expansion used for naming base and expansion sets. |
flavourText (String) | The asset description, sourced off-chain. Usually equal to the asset's on-chain |
functionText (String) | The description of the card's in-game abilities. |
health (String) | The possible damage received before being destroyed. |
parallel (String) | The Parallel the asset belongs to. |
parallelId (String) | The ID used to match other cards with the same name but different class. |
paraset (String) | The paraset the asset belongs to. |
passiveAbility (String) | The description of the card's passive ability. |
rarity (String) | The rarity of the asset. Can be |
subtype (String) | The card subtype. Can be |
supply (String) | The total supply of this individual asset. |
ParallelCardChangesConnection
ParallelCardChangesConnection
Response returned by getParallelCardChanges
.
Fields for ParallelCardChangesConnection
ParallelCardChangesConnection
Name | Description |
---|---|
cursor (String) | A cursor for use in pagination. |
items ([ParallelCardChange]) | A list of tracked changes made to a Parallel card. |
PoolBalanceChangedEventData
PoolBalanceChangedEventData
Event data for a BalancerV2 Pool Balance Changed event.
Fields for PoolBalanceChangedEventData
PoolBalanceChangedEventData
Name | Description |
---|---|
amount0 (String) | The amount of |
amount0Shifted (String) | The amount of |
amount1 (String) | The amount of |
amount1Shifted (String) | The amount of |
liquidity0 (String) | The amount of token0 now in the pool. |
liquidity1 (String) | The amount of token1 now in the pool. |
protocolFeeAmount0 (String) | The amount of token0 captured by the protocol. |
protocolFeeAmount1 (String) | The amount of token1 captured by the protocol. |
sender (String) | The address of account that added or removed liquidity. |
token0 (String) | The address of |
token1 (String) | The address of |
type (EventType!) | The type of token event, |
PooledTokenValues
PooledTokenValues
Fields for PooledTokenValues
PooledTokenValues
Price
Price
Real-time or historical prices for a token.
Fields for Price
Price
PriceEventWebhookCondition
PriceEventWebhookCondition
Fields for PriceEventWebhookCondition
PriceEventWebhookCondition
Name | Description |
---|---|
networkId (IntEqualsCondition!) | |
priceUsd (ComparisonOperator!) | |
tokenAddress (StringEqualsCondition!) |
PrimeHolders
PrimeHolders
Response returned by primeHolders
.
Fields for PrimeHolders
PrimeHolders
PrimePool
PrimePool
An Echelon Prime Pool.
Fields for PrimePool
PrimePool
Name | Description |
---|---|
calcData (PrimePoolCalcData) | Values calculated by Defined using on-chain data. |
chainData (PrimePoolChainData) | Values obtained directly from the chain. |
createdAt (Int) | When the pool was created by Defined. |
discoveryBlockNumber (Int) | The block number for when Defined discovered this pool. |
discoveryTransactionHash (String) | The transaction hash of when Defined discovered this pool. |
id (String) | The ID of the contract-level Prime Pool (poolContractAddress:networkId). For example, |
networkId (Int) | The network ID the Prime Pool is deployed on. |
nftContractAddress (String) | The contract address for the tokens cached ib the pool. |
poolContractAddress (String) | The contract address for the Prime Pool. |
poolId (String) | The ID of the pool within the contract. |
poolType (String) | The type of pool for this Prime Pool. |
tokenIds ([String]) | The Parallel tokenIds required to cache in the pool. |
totalSupply (String) | The # of cached sets in the pool. |
PrimePoolAsset
PrimePoolAsset
A cached Prime pool asset.
Fields for PrimePoolAsset
PrimePoolAsset
Name | Description |
---|---|
amount (String!) | The number of cached Prime pool assets of this type by this owner. |
ethRewardDebt (String) | The amount of ETH the user is not eligible for either from having already harvesting or from not caching in the past. |
from (String!) | The owner wallet address of the cached Prime pool asset. |
fromHashKey (String!) | The owner wallet address of the cached Prime pool asset, and network ID (from:networkId). |
fromSortKey (String!) | The Prime pool ID and Prime pool contract address (poolId:poolContractAddress). |
id (String!) | The Prime pool asset ID (poolContractAddress:poolId:networkId) |
networkId (Int!) | The network ID of the cached Prime pool asset. |
poolContractAddress (String!) | THe contract address of the Prime pool. |
poolId (String!) | The Prime pool ID. |
primeRewardDebt (String) | The amount of PRIME the user is not eligible for either from having already harvesting or from not caching in the past. |
sortKey (String!) | The owner wallet address of the cached Prime pool asset. |
PrimePoolAssetConnection
PrimePoolAssetConnection
Response returned by getPrimePoolAssets
.
Fields for PrimePoolAssetConnection
PrimePoolAssetConnection
Name | Description |
---|---|
cursor (String) | The cursor to use for pagination. |
items ([PrimePoolAsset]) | The list of cached Prime pool assets returned by the query. |
PrimePoolCacheData
PrimePoolCacheData
Event-specific data for a Prime pool Cache transaction.
Fields for PrimePoolCacheData
PrimePoolCacheData
Name | Description |
---|---|
eventAmount (String!) | The amount of Prime pool asset(s) cached. |
totalSupply (String!) | The total supply of assets cached in this Prime pool, including the amount cached in this transaction. |
type (PrimePoolEventType!) | The Prime pool event type. |
user (String!) | The owner wallet address of the cached Prime pool asset(s). |
userCachedAmount (String!) | The total number of Prime pool asset(s) cached in this pool by this owner. |
userEthRewardDebt (String!) | The amount of ETH the user is not eligible for either from having already harvesting or from not caching in the past. |
userPrimeRewardDebt (String!) | The amount of PRIME the user is not eligible for either from having already harvesting or from not caching in the past. |
PrimePoolCachingPausedData
PrimePoolCachingPausedData
Event-specific data for a Prime pool CachingPaused transaction.
Fields for PrimePoolCachingPausedData
PrimePoolCachingPausedData
Name | Description |
---|---|
cachingPaused (Boolean!) | The state of caching paused set on the pool. |
type (PrimePoolEventType!) | The Prime pool event type. |
PrimePoolCalcData
PrimePoolCalcData
Fields for PrimePoolCalcData
PrimePoolCalcData
Name | Description |
---|---|
poolAccumulatedEth (String) | The amount of accumulated ETH rewards in total for the pool. |
poolAccumulatedPrime (String) | The amount of accumulated PRIME rewards in total for the pool. |
poolEthAmount (String) | The amount of ETH for the pool to pay out as caching rewards. |
poolEthPerDay (String) | The amount of ETH paid out daily by the pool as caching rewards. |
poolEthPerSecond (String) | The amount of ETH paid out per second by the pool as caching rewards. |
poolPrimeAmount (String) | The amount of PRIME for the pool to pay out as caching rewards. |
poolPrimePerDay (String) | The amount of PRIME paid out daily by the pool as caching rewards. |
poolPrimePerSecond (String) | The amount of PRIME paid out per second by the pool as caching rewards. |
shareAccumulatedEth (String) | The amount of accumulated ETH rewards per share for the pool. |
shareAccumulatedPrime (String) | The amount of accumulated PRIME rewards per share for the pool. |
shareEthPerDay (String) | The amount of ETH paid out daily by the pool, per share of the pool's total cached supply. |
shareEthPerSecond (String) | The amount of ETH paid out per second by the pool, per share of the pool's total cached supply. |
sharePrimePerDay (String) | The amount of PRIME paid out daily by the pool, per share of the pool's total cached supply. |
sharePrimePerSecond (String) | The amount of PRIME paid out per second by the pool, per share of the pool's total cached supply. |
PrimePoolChainData
PrimePoolChainData
Values obtained directly from the chain.
Fields for PrimePoolChainData
PrimePoolChainData
Name | Description |
---|---|
cachingPaused (Boolean) | Whether caching is paused for this pool. |
ethAllocPoint (String) | The pool's allocation of the contract's per-second ETH rewards. |
ethClaimed (String) | How much ETH has been claimed for this pool. |
ethEndTimestamp (Int) | Caching ETH rewards period end timestamp. |
ethLastRewardTimestamp (Int) | Last timestamp at which ETH rewards were assigned. |
ethReward (String) | How much ETH reward has been accrued for this pool. |
ethStartTimestamp (Int) | Caching ETH rewards period start timestamp. |
ethTimedCachePeriod (String) | Minimum number of timed cache seconds per ETH. |
ethTotalAllocPoint (String) | Total share points of the contract's per-second ETH rewards to the pool. |
primeAllocPoint (String) | The pool's allocation of the contract's per second PRIME rewards. |
primeEndTimestamp (Int) | Caching rewards period end timestamp. |
primeLastRewardTimestamp (Int) | Last timestamp at which PRIME rewards were assigned. |
primeStartTimestamp (String) | Caching rewards period start timestamp. |
primeTotalAllocPoint (String) | Total share points of the contract's per second PRIME rewards to the pool. |
PrimePoolClaimEthData
PrimePoolClaimEthData
Event-specific data for a Prime pool ClaimEth transaction.
Fields for PrimePoolClaimEthData
PrimePoolClaimEthData
Name | Description |
---|---|
currency (PrimePoolCurrency!) | The currency type of the event. |
ethClaimed (String) | The total amount of ETH claimed for a pool. |
eventAmount (String!) | The amount of ETH claimed. |
type (PrimePoolEventType!) | The Prime pool event type. |
user (String!) | The wallet address claiming ETH rewards. |
userEthRewardDebt (String!) | The amount of ETH the user is not eligible for either from having already harvesting or from not caching in the past. |
PrimePoolClaimPrimeData
PrimePoolClaimPrimeData
Event-specific data for a Prime pool ClaimPrime transaction.
Fields for PrimePoolClaimPrimeData
PrimePoolClaimPrimeData
Name | Description |
---|---|
currency (PrimePoolCurrency!) | The currency type of the event. |
eventAmount (String!) | The amount of PRIME claimed. |
type (PrimePoolEventType!) | The Prime pool event type. |
user (String!) | The wallet address claiming PRIME rewards. |
userPrimeRewardDebt (String!) | The total amount of PRIME claimed for a pool. |
PrimePoolConnection
PrimePoolConnection
Response returned by getPrimePools
.
Fields for PrimePoolConnection
PrimePoolConnection
PrimePoolEmergencyWithdrawData
PrimePoolEmergencyWithdrawData
Event-specific data for a Prime pool EmergencyWithdraw transaction.
Fields for PrimePoolEmergencyWithdrawData
PrimePoolEmergencyWithdrawData
Name | Description |
---|---|
eventAmount (String!) | The amount of Prime pool asset(s) emergency withdrawn. |
totalSupply (String!) | The total supply of assets cached in this Prime pool. |
type (PrimePoolEventType!) | The Prime pool event type. |
user (String!) | The wallet address emergency withdrawing from the pool. |
userCachedAmount (String!) | The updated total number of Prime pool asset(s) cached in this pool by this owner. |
userEthRewardDebt (String!) | The amount of ETH the user is not eligible for either from having already harvesting or from not caching in the past. |
userPrimeRewardDebt (String!) | The amount of PRIME the user is not eligible for either from having already harvesting or from not caching in the past. |
PrimePoolEndTimestampUpdatedEthData
PrimePoolEndTimestampUpdatedEthData
Event-specific data for a Prime pool EndTimestampUpdatedEth transaction.
Fields for PrimePoolEndTimestampUpdatedEthData
PrimePoolEndTimestampUpdatedEthData
Name | Description |
---|---|
currency (PrimePoolCurrency!) | The currency type of the event. |
ethEndTimestamp (Int!) | The updated ETH reward end timestamp for the pool. |
ethPerSecond (String!) | The updated reward per second for the pool. |
ethStartTimestamp (Int!) | The updated ETH reward start timestamp for the pool. |
type (PrimePoolEventType!) | The Prime pool event type. |
PrimePoolEndTimestampUpdatedPrimeData
PrimePoolEndTimestampUpdatedPrimeData
Event-specific data for a Prime pool EndTimestampUpdatedPrime transaction.
Fields for PrimePoolEndTimestampUpdatedPrimeData
PrimePoolEndTimestampUpdatedPrimeData
Name | Description |
---|---|
currency (PrimePoolCurrency!) | The currency type of the event. |
primeEndTimestamp (Int!) | The updated PRIME reward end timestamp for the pool. |
primePerSecond (String!) | The updated reward per second for the pool. |
primeStartTimestamp (Int!) | The updated PRIME reward start timestamp for the pool. |
type (PrimePoolEventType!) | The Prime pool event type. |
PrimePoolEthRewardsAddedData
PrimePoolEthRewardsAddedData
Event-specific data for a Prime pool LogUpdatePool transaction.
Fields for PrimePoolEthRewardsAddedData
PrimePoolEthRewardsAddedData
Name | Description |
---|---|
amount (String!) | The amount of ETH rewards added to the pool. |
totalRewards (String!) | The total ETH rewards for the pool. |
type (PrimePoolEventType!) | The Prime pool event type. |
PrimePoolEthRewardsSetData
PrimePoolEthRewardsSetData
Event-specific data for a Prime pool EthRewardsSet transaction.
Fields for PrimePoolEthRewardsSetData
PrimePoolEthRewardsSetData
Name | Description |
---|---|
amount (String!) | The amount of ETH rewards set for the pool. |
totalRewards (String!) | The total ETH rewards for the pool. |
type (PrimePoolEventType!) | The Prime pool event type. |
PrimePoolEvent
PrimePoolEvent
A Prime pool event.
Fields for PrimePoolEvent
PrimePoolEvent
Name | Description |
---|---|
blockHash (String!) | The blockHash of the Prime pool event. |
blockNumber (Int!) | The blockNumber of the Prime pool event. |
data (PrimePoolEventData!) | The event data for the Prime pool event. |
eventType (PrimePoolEventType!) | The Prime pool event type. |
from (String!) | The Prime pool event's calling address. |
fromHashKey (String!) | The Prime pool event's calling address, and network ID (from:networkId). |
id (String!) | The Prime pool event ID (poolContractAddress:poolId:networkId) |
logIndex (Int!) | The logIndex of the Prime pool event. |
networkId (Int!) | The network ID of the Prime pool event. |
poolContractAddress (String!) | The Prime pool contract address. |
poolId (String!) | The Prime pool ID. |
poolType (PrimePoolType!) | The Prime pool type. |
sortKey (String!) | The sort key of the Prime pool event (blockNumber:transactionIndex:logIndex). |
timestamp (Int!) | The timestamp of the Prime pool event. |
transactionHash (String!) | The transactionHash of the Prime pool event. |
transactionIndex (Int!) | The transactionIndex of the Prime pool event. |
PrimePoolEventConnection
PrimePoolEventConnection
Response returned by getPrimePoolEvents
.
Fields for PrimePoolEventConnection
PrimePoolEventConnection
Name | Description |
---|---|
cursor (String) | The cursor to use for pagination. |
items ([PrimePoolEvent]) | The list of Prime pool events returned by the query. |
PrimePoolLogPoolAdditionData
PrimePoolLogPoolAdditionData
Event-specific data for a Prime pool LogPoolAddition (new Prime pool) transaction.
Fields for PrimePoolLogPoolAdditionData
PrimePoolLogPoolAdditionData
Name | Description |
---|---|
tokenIds ([String!]!) | The token ID's added to the new Prime pool. |
type (PrimePoolEventType!) | The Prime pool event type. |
PrimePoolLogPoolSetAllocPointData
PrimePoolLogPoolSetAllocPointData
Event-specific data for a Prime pool LogPoolSetAllocPoint transaction.
Fields for PrimePoolLogPoolSetAllocPointData
PrimePoolLogPoolSetAllocPointData
Name | Description |
---|---|
allocPoint (String!) | The updated alloc point for the pool (the pool's share of the contract's total rewards). |
currency (PrimePoolCurrency!) | The currency type of the event. |
totalAllocPoint (String!) | The updated total alloc point for the pool (the sum of all pools' alloc points). |
type (PrimePoolEventType!) | The Prime pool event type. |
PrimePoolLogSetPerSecondData
PrimePoolLogSetPerSecondData
Event-specific data for a Prime pool LogSetPerSecond transaction.
Fields for PrimePoolLogSetPerSecondData
PrimePoolLogSetPerSecondData
Name | Description |
---|---|
amount (String!) | The updated reward per second for the pool. |
currency (PrimePoolCurrency!) | The currency type of the event. |
endTimestamp (Int!) | The updated reward end timestamp for the pool. |
ethAmountPerSecond (String) | The updated ETH reward per second for the pool. |
primeAmountPerSecond (String) | The updated PRIME reward per second for the pool. |
startTimestamp (Int!) | The updated reward start timestamp for the pool. |
type (PrimePoolEventType!) | The Prime pool event type. |
PrimePoolLogUpdatePoolData
PrimePoolLogUpdatePoolData
Event-specific data for a Prime pool LogUpdatePool transaction.
Fields for PrimePoolLogUpdatePoolData
PrimePoolLogUpdatePoolData
Name | Description |
---|---|
accPerShare (String!) | The amount of accumulated rewards per share. |
currency (PrimePoolCurrency!) | The currency type of the event. |
ethAmount (String) | The ETH amount of the pool. |
lastRewardTimestamp (Int!) | The timestamp at which rewards were last assigned. |
primeAmount (String) | The PRIME amount of the pool. |
supply (String!) | The total amount of assets cached in the pool (emitted by the event, before the transaction). |
totalSupply (String!) | The total amount of assets cached in the pool (queried from the pool after the transaction). |
type (PrimePoolEventType!) | The Prime pool event type. |
PrimePoolRewardDecreaseData
PrimePoolRewardDecreaseData
Event-specific data for a Prime pool RewardDecrease transaction.
Fields for PrimePoolRewardDecreaseData
PrimePoolRewardDecreaseData
Name | Description |
---|---|
currency (PrimePoolCurrency!) | The currency type of the event. |
eventAmount (String!) | The amount of rewards decreased. |
type (PrimePoolEventType!) | The Prime pool event type. |
updatedAmount (String!) | The updated total rewards for the pool. |
PrimePoolRewardIncreaseData
PrimePoolRewardIncreaseData
Event-specific data for a Prime pool RewardIncrease transaction.
Fields for PrimePoolRewardIncreaseData
PrimePoolRewardIncreaseData
Name | Description |
---|---|
currency (PrimePoolCurrency!) | The currency type of the event. |
eventAmount (String!) | The amount of rewards increased. |
type (PrimePoolEventType!) | The Prime pool event type. |
updatedAmount (String!) | The updated total rewards for the pool. |
PrimePoolTimeCachePeriodUpdateData
PrimePoolTimeCachePeriodUpdateData
Event-specific data for a Prime pool TimeCachePeriodUpdate transaction.
Fields for PrimePoolTimeCachePeriodUpdateData
PrimePoolTimeCachePeriodUpdateData
Name | Description |
---|---|
currency (PrimePoolCurrency!) | The currency type of the event. |
timedCachePeriod (String!) | The minimum number of timed cache seconds per ETH reward. |
type (PrimePoolEventType!) | The Prime pool event type. |
PrimePoolWithdrawData
PrimePoolWithdrawData
Event-specific data for a Prime pool Withdraw transaction.
Fields for PrimePoolWithdrawData
PrimePoolWithdrawData
Name | Description |
---|---|
eventAmount (String!) | The amount of assets withdrawn. |
totalSupply (String!) | The updated total assets for the pool after the withdrawal. |
type (PrimePoolEventType!) | The Prime pool event type. |
user (String!) | The address of the wallet who withdrew. |
userCachedAmount (String!) | The amount of cached asset the user has in the pool, following the withdrawal. |
userEthRewardDebt (String!) | The amount of ETH the user is not eligible for either from having already harvesting or from not caching in the past. |
userPrimeRewardDebt (String!) | The amount of PRIME the user is not eligible for either from having already harvesting or from not caching in the past. |
Quote
Quote
Fields for Quote
Quote
QuoteExchange
QuoteExchange
Fields for QuoteExchange
QuoteExchange
QuoteV2
QuoteV2
Fields for QuoteV2
QuoteV2
RawNftAssetData
RawNftAssetData
Fields for RawNftAssetData
RawNftAssetData
Name | Description |
---|---|
animationUrl (String) | An optional image field that may or may not be present on the requested NFT asset smart contract. |
externalUrl (String) | An optional field that may or may not be present on the requested NFT asset smart contract. |
imageData (String) | An optional image field that may or may not be present on the requested NFT asset smart contract. |
imageUrl (String) | An optional image field that may or may not be present on the requested NFT asset smart contract. |
RawTransactionWebhookCondition
RawTransactionWebhookCondition
Fields for RawTransactionWebhookCondition
RawTransactionWebhookCondition
Name | Description |
---|---|
from (StringEqualsCondition) | |
ignoreNftEvents (Boolean) | |
ignoreTokenPairEvents (Boolean) | |
input (StringContainsCondition) | |
networkId (OneOfNumberCondition) | |
to (StringEqualsCondition) | |
toOrFrom (StringEqualsCondition) |
ResolutionBarData
ResolutionBarData
Price data for each supported resolution.
Fields for ResolutionBarData
ResolutionBarData
Name | Description |
---|---|
r1 (CurrencyBarData) | 1 minute resolution. |
r1D (CurrencyBarData) | 1 day resolution. |
r1S (CurrencyBarData) | 1 second resolution. |
r5 (CurrencyBarData) | 5 minute resolution. |
r5S (CurrencyBarData) | 5 second resolution. |
r7D (CurrencyBarData) | 1 week resolution. |
r15 (CurrencyBarData) | 15 minute resolution. |
r15S (CurrencyBarData) | 15 second resolution. |
r30 (CurrencyBarData) | 30 minute resolution. |
r60 (CurrencyBarData) | 60 minute resolution. |
r240 (CurrencyBarData) | 4 hour resolution. |
r720 (CurrencyBarData) | 12 hour resolution. |
RetrySettings
RetrySettings
Fields for RetrySettings
RetrySettings
SandwichedLabelData
SandwichedLabelData
Metadata for a sandwich label.
Fields for SandwichedLabelData
SandwichedLabelData
SandwichLabelForEvent
SandwichLabelForEvent
Metadata for a sandwich label.
Fields for SandwichLabelForEvent
SandwichLabelForEvent
Name | Description |
---|---|
label (String!) | The label type, 'sandwiched'. |
sandwichType (SandwichLabelForEventType!) | The sandwich event label types. |
token0DrainedAmount (String!) | The amount of |
token1DrainedAmount (String!) | The amount of |
SimulateContractBalanceErrorsType
SimulateContractBalanceErrorsType
Fields for SimulateContractBalanceErrorsType
SimulateContractBalanceErrorsType
SimulateContractBalanceType
SimulateContractBalanceType
Fields for SimulateContractBalanceType
SimulateContractBalanceType
SimulateCreatorErrorsType
SimulateCreatorErrorsType
Fields for SimulateCreatorErrorsType
SimulateCreatorErrorsType
SimulateCreatorType
SimulateCreatorType
Fields for SimulateCreatorType
SimulateCreatorType
SimulateDeployErrorsType
SimulateDeployErrorsType
Fields for SimulateDeployErrorsType
SimulateDeployErrorsType
SimulateDeployType
SimulateDeployType
Fields for SimulateDeployType
SimulateDeployType
SimulateLiquidityErrorsType
SimulateLiquidityErrorsType
Fields for SimulateLiquidityErrorsType
SimulateLiquidityErrorsType
SimulateLiquidityType
SimulateLiquidityType
Fields for SimulateLiquidityType
SimulateLiquidityType
Name | Description |
---|---|
addLiquiditySuccess (Boolean) | |
liquiditySetByPreLiquidityOpenTradingCall (Boolean) | |
lpTotalSupply (String) | |
pairAddress (String) | |
postLiquidityEnableTradingCall (String) | |
postLiquidityEnableTradingSuccess (Boolean) | |
preLiquidityEnableTradingCall (String) | |
preLiquidityEnableTradingSuccess (Boolean) | |
preLiquidityEnableTradingSupportsTransfer (Boolean) |
SimulateOwnerErrorsType
SimulateOwnerErrorsType
Fields for SimulateOwnerErrorsType
SimulateOwnerErrorsType
SimulateOwnerType
SimulateOwnerType
Fields for SimulateOwnerType
SimulateOwnerType
SimulateSwapErrorsType
SimulateSwapErrorsType
Fields for SimulateSwapErrorsType
SimulateSwapErrorsType
Name | Description |
---|---|
buyError (String) | |
buyErrorEnum (SimulateTokenContractBuySellErrorEnum) | |
sellError (String) | |
sellErrorEnum (SimulateTokenContractBuySellErrorEnum) |
SimulateSwapType
SimulateSwapType
Fields for SimulateSwapType
SimulateSwapType
SimulateTokenContractErrors
SimulateTokenContractErrors
Fields for SimulateTokenContractErrors
SimulateTokenContractErrors
Name | Description |
---|---|
contractBalanceErrors (SimulateContractBalanceErrorsType!) | |
creatorErrors (SimulateCreatorErrorsType!) | |
deployErrors (SimulateDeployErrorsType!) | |
liquidityErrors (SimulateLiquidityErrorsType!) | |
ownerErrors (SimulateOwnerErrorsType!) | |
simulatorError (String) | |
swapErrors (SimulateSwapErrorsType!) | |
tokenErrors (SimulateTokenErrorsType!) | |
transferErrors (SimulateTransferErrorsType!) |
SimulateTokenContractResponse
SimulateTokenContractResponse
Fields for SimulateTokenContractResponse
SimulateTokenContractResponse
SimulateTokenContractResult
SimulateTokenContractResult
Fields for SimulateTokenContractResult
SimulateTokenContractResult
Name | Description |
---|---|
analysisType (Int!) | |
blockNumber (String!) | |
contractBalance (SimulateContractBalanceType!) | |
contractHashKey (String!) | |
creator (SimulateCreatorType!) | |
deploy (SimulateDeployType!) | |
errors (SimulateTokenContractErrors!) | |
id (String!) | |
liquidity (SimulateLiquidityType!) | |
networkId (Int!) | |
owner (SimulateOwnerType!) | |
sortKey (String!) | |
status (SimulateTokenContractResultStatusEnum!) | |
swap (SimulateSwapType!) | |
timestamp (Int!) | |
token (SimulateTokenType!) | |
transfer (SimulateTransferType!) | |
uuid (String!) | |
uuidHashKey (String!) |
SimulateTokenErrorsType
SimulateTokenErrorsType
Fields for SimulateTokenErrorsType
SimulateTokenErrorsType
SimulateTokenType
SimulateTokenType
Fields for SimulateTokenType
SimulateTokenType
SimulateTransferErrorsType
SimulateTransferErrorsType
Fields for SimulateTransferErrorsType
SimulateTransferErrorsType
SimulateTransferType
SimulateTransferType
Fields for SimulateTransferType
SimulateTransferType
SocialLinks
SocialLinks
Community gathered social links of tokens/NFTs.
Fields for SocialLinks
SocialLinks
Name | Description |
---|---|
bitcointalk (String) | |
blog (String) | |
coingecko (String) | |
coinmarketcap (String) | |
discord (String) | |
email (String) | |
facebook (String) | |
github (String) | |
instagram (String) | |
linkedin (String) | |
reddit (String) | |
slack (String) | |
telegram (String) | |
twitch (String) | |
twitter (String) | |
website (String) | |
wechat (String) | |
whitepaper (String) | |
youtube (String) |
SparklineValue
SparklineValue
Fields for SparklineValue
SparklineValue
StringContainsCondition
StringContainsCondition
Fields for StringContainsCondition
StringContainsCondition
StringEqualsCondition
StringEqualsCondition
Fields for StringEqualsCondition
StringEqualsCondition
Name | Description |
---|---|
eq (String!) |
SwapEventData
SwapEventData
Event data for a token swap event.
Fields for SwapEventData
SwapEventData
Name | Description |
---|---|
amount0 (String) | The amount of |
amount0In (String) | The amount of |
amount0Out (String) | The amount of |
amount1 (String) | The amount of |
amount1In (String) | The amount of |
amount1Out (String) | The amount of |
amountNonLiquidityToken (String) | The amount of |
priceBaseToken (String) | The price per |
priceBaseTokenTotal (String) | The total amount of |
priceUsd (String) | The price per |
priceUsdTotal (String) | The total amount of |
tick (String) | The tick index that the swap occurred in. Only applicable for UniswapV3 events. |
type (EventType!) | The type of token event, |
SwapNftInPoolEventData
SwapNftInPoolEventData
Event data for swapping an NFT into a pool.
Fields for SwapNftInPoolEventData
SwapNftInPoolEventData
Name | Description |
---|---|
amountT (String!) | The total value of all NFTs involved in the swap in the pool's liquidity token. |
nbtRatio (String!) | The ratio of the transaction token to the network's base token. |
newBuyPriceT (String!) | The updated price at which the pool is willing to buy an NFT in the pool's liquidity token. |
newDelta (String!) | The updated delta used in the bonding curve. |
newSellPriceT (String!) | The updated price at which the pool is willing to sell an NFT in the pool's liquidity token. |
newSpotPriceT (String!) | The updated spot price in the pool's liquidity token. |
nftsTransfered ([NftPoolEventNftTransfer]) | Metadata for each of the NFTs involved in the swap. |
nftTokenBalance (String!) | The number of NFTs in the contract after the block has processed. |
poolFeeT (String!) | The fee for the pool in the pool's liquidity token. |
protocolFeeT (String!) | The protocol fee in the pool's liquidity token. |
tokenBalanceT (String!) | The amount of token in the contract after the block has processed in the pool's liquidity token. |
tokenId (String!) | The ID of the token involved in the swap ( |
type (NftPoolEventType!) | The type of NFT pool event, |
usdRatio (String!) | The ratio of the transaction token to USD. |
SwapNftInPoolEventDataV2
SwapNftInPoolEventDataV2
Event data for swapping an NFT into a pool.
Fields for SwapNftInPoolEventDataV2
SwapNftInPoolEventDataV2
Name | Description |
---|---|
amountT (String!) | The total value of all NFTs involved in the swap in the pool's liquidity token. |
nbtRatio (String!) | The ratio of the transaction token to the network's base token. |
newBuyPriceT (String!) | The updated price at which the pool is willing to buy an NFT in the pool's liquidity token. |
newDelta (String!) | The updated delta used in the bonding curve. |
newSellPriceT (String!) | The updated price at which the pool is willing to sell an NFT in the pool's liquidity token. |
newSpotPriceT (String!) | The updated spot price in the pool's liquidity token. |
nftAssets ([NftAsset]) | New Param: The list of NFT assets withdrawn. More extensive info than nftTokenIds. |
nftsTransfered ([NftPoolEventNftTransferV2]) | Metadata for each of the NFTs involved in the swap. |
poolFeeT (String!) | The fee for the pool in the pool's liquidity token. |
protocolFeeT (String!) | The protocol fee in the pool's liquidity token. |
tokenBalanceT (String!) | The amount of token in the contract after the block has processed in the pool's liquidity token. |
tokenId (String!) | The ID of the token involved in the swap ( |
type (NftPoolEventType!) | The type of NFT pool event, |
usdRatio (String!) | The ratio of the transaction token to USD. |
SwapNftOutPoolEventData
SwapNftOutPoolEventData
Event data for swapping an NFT out of a pool.
Fields for SwapNftOutPoolEventData
SwapNftOutPoolEventData
Name | Description |
---|---|
amountT (String!) | The total value of all NFTs involved in the swap in the pool's liquidity token. |
nbtRatio (String!) | The ratio of the transaction token to the network's base token. |
newBuyPriceT (String!) | The updated price at which the pool is willing to buy an NFT in the pool's liquidity token. |
newDelta (String!) | The updated delta used in the bonding curve. |
newSellPriceT (String!) | The updated price at which the pool is willing to sell an NFT in the pool's liquidity token. |
newSpotPriceT (String!) | The updated spot price in the pool's liquidity token. |
nftsTransfered ([NftPoolEventNftTransfer]) | Metadata for each of the NFTs involved in the swap. |
nftTokenBalance (String!) | The number of NFTs in the contract after the block has processed. |
poolFeeT (String!) | The fee for the pool in the pool's liquidity token. |
protocolFeeT (String!) | The protocol fee in the pool's liquidity token. |
tokenBalanceT (String!) | The amount of token in the contract after the block has processed in the pool's liquidity token. |
tokenId (String!) | The ID of the token involved in the swap ( |
type (NftPoolEventType!) | The type of NFT pool event, |
usdRatio (String!) | The ratio of the transaction token to USD. |
SwapNftOutPoolEventDataV2
SwapNftOutPoolEventDataV2
Event data for swapping an NFT out of a pool.
Fields for SwapNftOutPoolEventDataV2
SwapNftOutPoolEventDataV2
Name | Description |
---|---|
amountT (String!) | The total value of all NFTs involved in the swap in the pool's liquidity token. |
nbtRatio (String!) | The ratio of the transaction token to the network's base token. |
newBuyPriceT (String!) | The updated price at which the pool is willing to buy an NFT in the pool's liquidity token. |
newDelta (String!) | The updated delta used in the bonding curve. |
newSellPriceT (String!) | The updated price at which the pool is willing to sell an NFT in the pool's liquidity token. |
newSpotPriceT (String!) | The updated spot price in the pool's liquidity token. |
nftAssets ([NftAsset]) | New Param: The list of NFT assets withdrawn. More extensive info than nftTokenIds. |
nftsTransfered ([NftPoolEventNftTransferV2]) | Metadata for each of the NFTs involved in the swap. |
poolFeeT (String!) | The fee for the pool in the pool's liquidity token. |
protocolFeeT (String!) | The protocol fee in the pool's liquidity token. |
tokenBalanceT (String!) | The amount of token in the contract after the block has processed in the pool's liquidity token. |
tokenId (String!) | The ID of the token involved in the swap ( |
type (NftPoolEventType!) | The type of NFT pool event, |
usdRatio (String!) | The ratio of the transaction token to USD. |
SymbolResponse
SymbolResponse
Response returned by getSymbol
.
Fields for SymbolResponse
SymbolResponse
Name | Description |
---|---|
currency_code (String!) | The currencyCode argument passed in ( |
description (String!) | The trading pair. If currencyCode is TOKEN, the base token will be used, otherwise USD. |
name (String!) | The symbols of the pair. |
original_currency_code (String!) | The base token symbol. |
pricescale (Float!) | 10^n, where n is the number of decimal places the price has. Max 16. Used for charting. |
supported_resolutions ([String!]!) | The list of time frames supported for the symbol in other charting endpoints, eg. getBars. |
ticker (String!) | The ID of the pair ( |
TokenBurnEventData
TokenBurnEventData
Token burn event data.
Fields for TokenBurnEventData
TokenBurnEventData
TokenFilterConnection
TokenFilterConnection
Response returned by filterTokens
.
Fields for TokenFilterConnection
TokenFilterConnection
Name | Description |
---|---|
count (Int) | The number of tokens returned. |
page (Int) | Where in the list the server started when returning items. |
results ([TokenFilterResult]) | The list of tokens matching the filter parameters. |
TokenFilterResult
TokenFilterResult
A token matching a set of filter parameters.
Fields for TokenFilterResult
TokenFilterResult
Name | Description |
---|---|
age (Int) | 🔴 DEPRECATED 🔴 |
buyCount1 (Int) | The number of buys in the past hour. |
buyCount4 (Int) | The number of buys in the past 4 hours. |
buyCount12 (Int) | The number of buys in the past 12 hours. |
buyCount24 (Int) | The number of buys in the past 24 hours. |
change1 (String) | The percent price change in the past hour. Decimal format. |
change4 (String) | The percent price change in the past 4 hours. Decimal format. |
change12 (String) | The percent price change in the past 12 hours. Decimal format. |
change24 (String) | The percent price change in the past 24 hours. Decimal format. |
createdAt (Int) | The unix timestamp for the creation of the token's first pair. |
exchanges ([Exchange]) | The exchanges the token is listed on. |
fdv (String) | 🔴 DEPRECATED 🔴 |
high1 (String) | The highest price in USD in the past hour. |
high4 (String) | The highest price in USD in the past 4 hours. |
high12 (String) | The highest price in USD in the past 12 hours. |
high24 (String) | The highest price in USD in the past 24 hours. |
holders (Int) | The number of different wallets holding the token. |
isScam (Boolean) | Whether the token has been flagged as a scam. |
lastTransaction (Int) | The unix timestamp for the token's last transaction. |
liquidity (String) | Amount of liquidity in the token's top pair. |
low1 (String) | The lowest price in USD in the past hour. |
low4 (String) | The lowest price in USD in the past 4 hours. |
low12 (String) | The lowest price in USD in the past 12 hours. |
low24 (String) | The lowest price in USD in the past 24 hours. |
marketCap (String) | The fully diluted market cap. For circulating market cap multiply |
pair (Pair) | Metadata for the token's top pair. |
priceUSD (String) | The token price in USD. |
quoteToken (String) | The token of interest. Can be |
sellCount1 (Int) | The number of sells in the past hour. |
sellCount4 (Int) | The number of sells in the past 4 hours. |
sellCount12 (Int) | The number of sells in the past 12 hours. |
sellCount24 (Int) | The number of sells in the past 24 hours. |
token (EnhancedToken) | Metadata for the token. |
txnCount1 (Int) | The number of transactions in the past hour. |
txnCount4 (Int) | The number of transactions in the past 4 hours. |
txnCount12 (Int) | The number of transactions in the past 12 hours. |
txnCount24 (Int) | The number of transactions in the past 24 hours. |
uniqueBuys1 (Int) | The unique number of buys in the past hour. |
uniqueBuys4 (Int) | The unique number of buys in the past 4 hours. |
uniqueBuys12 (Int) | The unique number of buys in the past 12 hours. |
uniqueBuys24 (Int) | The unique number of buys in the past 24 hours. |
uniqueSells1 (Int) | The unique number of sells in the past hour. |
uniqueSells4 (Int) | The unique number of sells in the past 4 hours. |
uniqueSells12 (Int) | The unique number of sells in the past 12 hours. |
uniqueSells24 (Int) | The unique number of sells in the past 24 hours. |
uniqueTransactions1 (Int) | The unique number of transactions in the past hour. |
uniqueTransactions4 (Int) | The unique number of transactions in the past 4 hours. |
uniqueTransactions12 (Int) | The unique number of transactions in the past 12 hours. |
uniqueTransactions24 (Int) | The unique number of transactions in the past 24 hours. |
volume1 (String) | The trade volume in USD in the past hour. |
volume4 (String) | The trade volume in USD in the past 4 hours. |
volume12 (String) | The trade volume in USD in the past 12 hours. |
volume24 (String) | The trade volume in USD in the past 24 hours. |
TokenInfo
TokenInfo
Metadata for a token.
Fields for TokenInfo
TokenInfo
Name | Description |
---|---|
address (String!) | The contract address of the token. |
circulatingSupply (String) | The circulating supply of the token. |
cmcId (Int) | The token ID on CoinMarketCap. |
description (String) | A description of the token. |
id (String!) | Uniquely identifies the token. |
imageLargeUrl (String) | The large token logo URL. |
imageSmallUrl (String) | The small token logo URL. |
imageThumbUrl (String) | The thumbnail token logo URL. |
isScam (Boolean) | Whether the token has been flagged as a scam. |
name (String) | The token name. For example, |
networkId (Int!) | The network ID the token is deployed on. |
symbol (String!) | The token symbol. For example, |
totalSupply (String) | The total supply of the token. |
TokenLifecycleEvent
TokenLifecycleEvent
Events that occur during a token's lifecycle. Only Mint and Burn events right now.
Fields for TokenLifecycleEvent
TokenLifecycleEvent
Name | Description |
---|---|
blockHash (String!) | The hash of the block where the transaction occurred. |
blockNumber (Int!) | The block number for the transaction. |
data (TokenLifecycleEventData!) | The event data, depends on the type of event |
eventType (TokenLifecycleEventType!) | The type of event. |
id (String!) | The ID of the event ( |
logIndex (Int!) | The index of the log in the block. |
maker (String) | The wallet address that performed the transaction. |
networkId (Int!) | The network ID that the token is deployed on. |
timestamp (Int!) | The unix timestamp for when the transaction occurred. |
tokenAddress (String!) | The token's contract address. |
transactionHash (String!) | The unique hash for the transaction. |
transactionIndex (Int!) | The index of the transaction within the block. |
TokenLifecycleEventConnection
TokenLifecycleEventConnection
Response returned by TokenLifecycleEvents
.
Fields for TokenLifecycleEventConnection
TokenLifecycleEventConnection
Name | Description |
---|---|
cursor (String) | |
items ([TokenLifecycleEvent]!) |
TokenMintEventData
TokenMintEventData
Token mint event data.
Fields for TokenMintEventData
TokenMintEventData
TokenPairEventTypeCondition
TokenPairEventTypeCondition
Fields for TokenPairEventTypeCondition
TokenPairEventTypeCondition
Name | Description |
---|---|
oneOf ([TokenPairEventType!]!) |
TokenPairEventWebhookCondition
TokenPairEventWebhookCondition
Fields for TokenPairEventWebhookCondition
TokenPairEventWebhookCondition
Name | Description |
---|---|
eventType (TokenPairEventTypeCondition) | |
exchangeAddress (StringEqualsCondition) | |
maker (StringEqualsCondition) | |
networkId (OneOfNumberCondition) | |
pairAddress (StringEqualsCondition) | |
swapValue (ComparisonOperator) | |
tokenAddress (StringEqualsCondition) |
TokenSearchResponse
TokenSearchResponse
Response returned by searchTokens
.
Fields for TokenSearchResponse
TokenSearchResponse
Name | Description |
---|---|
hasMore (Int) | The number of additional high volume results found. Only used if |
hasMoreLowVolume (Int) | If |
tokens ([TokenWithMetadata!]) | A list of tokens. |
TokenSparkline
TokenSparkline
Fields for TokenSparkline
TokenSparkline
Name | Description |
---|---|
attribute (SparklineAttribute) | Which attribute the sparkline is charting. Defaults to |
id (String!) | The token id |
sparkline ([SparklineValue!]!) | List of sparkline values to chart |
TokenWithMetadata
TokenWithMetadata
A token with metadata.
Fields for TokenWithMetadata
TokenWithMetadata
Name | Description |
---|---|
address (String!) | The contract address of the token. |
createdAt (Int) | The unix timestamp for the creation of the token's first pair. |
decimals (Int) | The precision to which the token can be divided. For example, the smallest unit for USDC is 0.000001 (6 decimals). |
exchanges ([Exchange!]!) | The exchanges the token is listed on. |
id (String!) | The ID of the token ( |
imageLargeUrl (String) | The token logo URL. |
imageSmallUrl (String) | The token logo URL. |
imageThumbUrl (String) | The token logo URL. |
isScam (Boolean) | Whether the token has been flagged as a scam. |
lastTransaction (Int) | The unix timestamp for the token's last transaction. |
liquidity (String!) | The total liquidity of the token's top pair in USD. |
marketCap (String) | The market cap of circulating supply. |
name (String!) | The name of the token. |
networkId (Int!) | The network ID the token is deployed on. |
price (Float!) | The token price in USD. |
priceChange (Float!) | The percent price change for the time frame requested. Decimal format. |
priceChange1 (Float) | The percent price change in the past hour. Decimal format. |
priceChange4 (Float) | The percent price change in the past 4 hours. Decimal format. |
priceChange12 (Float) | The percent price change in the past 12 hours. Decimal format. |
priceChange24 (Float) | The percent price change in the past 24 hours. Decimal format. |
quoteToken (QuoteToken) | The token of interest. Can be |
resolution (String!) | The time frame for the results. |
symbol (String!) | The symbol for the token. |
topPairId (String!) | The ID of the token's top pair ( |
txnCount1 (Int) | The number of transactions in the past hour. |
txnCount4 (Int) | The number of transactions in the past 4 hours. |
txnCount12 (Int) | The number of transactions in the past 12 hours. |
txnCount24 (Int) | The number of transactions in the past 24 hours. |
uniqueBuys1 (Int) | The unique number of buys in the past hour. |
uniqueBuys4 (Int) | The unique number of buys in the past 4 hours. |
uniqueBuys12 (Int) | The unique number of buys in the past 12 hours. |
uniqueBuys24 (Int) | The unique number of buys in the past 24 hours. |
uniqueSells1 (Int) | The unique number of sells in the past hour. |
uniqueSells4 (Int) | The unique number of sells in the past 4 hours. |
uniqueSells12 (Int) | The unique number of sells in the past 12 hours. |
uniqueSells24 (Int) | The unique number of sells in the past 24 hours. |
volume (String!) | The volume over the time frame requested in USD. |
UnconfirmedEvent
UnconfirmedEvent
An unconfirmed token transaction.
Fields for UnconfirmedEvent
UnconfirmedEvent
Name | Description |
---|---|
address (String!) | The contract address of the token's top pair. |
blockHash (String!) | The hash of the block where the transaction occurred. |
blockNumber (Int!) | The block number for the transaction. |
data (UnconfirmedEventData) | The event-specific data for the transaction. |
eventDisplayType (EventDisplayType) | A more specific breakdown of |
eventType (EventType!) | The type of transaction event. Can be |
id (String!) | The ID of the event ( |
logIndex (Int!) | The index of the log in the block. |
maker (String) | The wallet address that performed the transaction. |
networkId (Int!) | The network ID that the token is deployed on. |
quoteToken (QuoteToken) | The token of interest within the token's top pair. Can be |
supplementalIndex (Int) | A optional unique identifier of where the event is within the transaction. |
timestamp (Int!) | The unix timestamp for when the transaction occurred. |
transactionHash (String!) | The unique hash for the transaction. |
transactionIndex (Int!) | The index of the transaction within the block. |
UnconfirmedLiquidityChangeEventData
UnconfirmedLiquidityChangeEventData
Fields for UnconfirmedLiquidityChangeEventData
UnconfirmedLiquidityChangeEventData
Name | Description |
---|---|
amount0 (String) | The amount of |
amount0Shifted (String) | The amount of |
amount1 (String) | The amount of |
amount1Shifted (String) | The amount of |
type (EventType!) | The type of token event, |
UnconfirmedSwapEventData
UnconfirmedSwapEventData
Fields for UnconfirmedSwapEventData
UnconfirmedSwapEventData
UniV3Tick
UniV3Tick
Fields for UniV3Tick
UniV3Tick
UniV3TickConnection
UniV3TickConnection
Response returned by getUniV3Ticks
.
Fields for UniV3TickConnection
UniV3TickConnection
WalletNftCollection
WalletNftCollection
Fields for WalletNftCollection
WalletNftCollection
WalletNftCollectionAsset
WalletNftCollectionAsset
Fields for WalletNftCollectionAsset
WalletNftCollectionAsset
WalletNftCollectionAssetsResponse
WalletNftCollectionAssetsResponse
Fields for WalletNftCollectionAssetsResponse
WalletNftCollectionAssetsResponse
Name | Description |
---|---|
collectionId (String!) | The collection ID ( |
cursor (String) | A cursor for use in pagination. |
items ([WalletNftCollectionAsset]!) | The list of nft assets for a wallet. |
walletAddress (String!) | The address of the wallet. |
WalletNftCollectionsResponse
WalletNftCollectionsResponse
Fields for WalletNftCollectionsResponse
WalletNftCollectionsResponse
Name | Description |
---|---|
cursor (String) | A cursor for use in pagination. |
items ([WalletNftCollection!]!) | The list of collections for a wallet. |
WashtradeLabelForEvent
WashtradeLabelForEvent
Metadata for a washtrade label.
Fields for WashtradeLabelForEvent
WashtradeLabelForEvent
Name | Description |
---|---|
label (String!) | The label type, 'washtrade' |
Webhook
Webhook
Fields for Webhook
Webhook
Name | Description |
---|---|
alertRecurrence (AlertRecurrence!) | |
bucketId (String) | |
bucketSortkey (String) | |
callbackUrl (String!) | |
conditions (WebhookCondition!) | |
created (Int!) | |
groupId (String) | |
id (String!) | |
name (String!) | |
publishingType (PublishingType) | |
retrySettings (RetrySettings) | |
status (String!) | |
webhookType (WebhookType!) |
WindowedDetailedCurrencyPairStats
WindowedDetailedCurrencyPairStats
Price stats for a pair over a time frame.
Fields for WindowedDetailedCurrencyPairStats
WindowedDetailedCurrencyPairStats
Name | Description |
---|---|
buyVolume (DetailedPairStatsStringMetrics) | The buy volume over the time frame. |
close (DetailedPairStatsStringMetrics) | The closing price for the time frame. |
highest (DetailedPairStatsStringMetrics) | The highest price in USD in the time frame. |
liquidity (DetailedPairStatsStringMetrics) | The liquidity for the time frame. |
lowest (DetailedPairStatsStringMetrics) | The lowest price in USD in the time frame. |
open (DetailedPairStatsStringMetrics) | The opening price for the time frame. |
sellVolume (DetailedPairStatsStringMetrics) | The sell volume over the time frame. |
volume (DetailedPairStatsStringMetrics) | The volume over the time frame. |
WindowedDetailedNftCurrencyStats
WindowedDetailedNftCurrencyStats
Price stats for an NFT collection over a time frame. Either in USD or the network's base token.
Fields for WindowedDetailedNftCurrencyStats
WindowedDetailedNftCurrencyStats
Name | Description |
---|---|
average (DetailedNftStatsStringMetrics) | The average sale price in the time frame. |
close (DetailedNftStatsStringMetrics) | The closing price for the time frame. |
highestSale (DetailedNftStatsStringMetrics) | The highest sale price in the time frame. |
lowestSale (DetailedNftStatsStringMetrics) | The lowest sale price in the time frame. |
open (DetailedNftStatsStringMetrics) | The opening price for the time frame. |
volume (DetailedNftStatsStringMetrics) | The volume over the time frame. |
WindowedDetailedNftNonCurrencyStats
WindowedDetailedNftNonCurrencyStats
Numerical stats for an NFT collection over a time frame.
Fields for WindowedDetailedNftNonCurrencyStats
WindowedDetailedNftNonCurrencyStats
Name | Description |
---|---|
mints (DetailedNftStatsNumberMetrics) | The number of mints over the time frame. |
sales (DetailedNftStatsNumberMetrics) | The number of sales over the time frame. |
tokensSold (DetailedNftStatsStringMetrics) | The number of tokens sold over the time frame. |
transfers (DetailedNftStatsNumberMetrics) | The number of transfers over the time frame. |
uniqueBuyers (DetailedNftStatsNumberMetrics) | The number of unique buyers over the time frame. |
uniqueMinters (DetailedNftStatsNumberMetrics) | The number of unique minters over the time frame. |
uniqueSalesWallets (DetailedNftStatsNumberMetrics) | The number of unique wallets (buyers or sellers) over the time frame. |
uniqueSellers (DetailedNftStatsNumberMetrics) | The number of unique sellers over the time frame. |
WindowedDetailedNftStats
WindowedDetailedNftStats
Detailed NFT stats over a time frame.
Fields for WindowedDetailedNftStats
WindowedDetailedNftStats
Name | Description |
---|---|
duration (DetailedNftStatsDuration!) | The duration used to request detailed NFT stats. |
end (Int!) | The unix timestamp for the end of the window. |
start (Int!) | The unix timestamp for the start of the window. |
statsNetworkBaseToken (WindowedDetailedNftCurrencyStats!) | The currency stats in the network's base token, such as volume. |
statsNonCurrency (WindowedDetailedNftNonCurrencyStats!) | The numerical stats, such as number of buyers. |
statsUsd (WindowedDetailedNftCurrencyStats!) | The currency stats in USD, such as volume. |
timestamps ([DetailedNftStatsBucketTimestamp]!) | The list of start/end timestamps broken down for each bucket within the window. |
WindowedDetailedNonCurrencyPairStats
WindowedDetailedNonCurrencyPairStats
Numerical stats for a pair over a time frame.
Fields for WindowedDetailedNonCurrencyPairStats
WindowedDetailedNonCurrencyPairStats
Name | Description |
---|---|
buyers (DetailedPairStatsNumberMetrics) | The number of unique buyers over the time frame. |
buys (DetailedPairStatsNumberMetrics) | The number of buys over the time frame. |
sellers (DetailedPairStatsNumberMetrics) | The number of unique sellers over the time frame. |
sells (DetailedPairStatsNumberMetrics) | The number of sells over the time frame. |
traders (DetailedPairStatsNumberMetrics) | The number of unique traders over the time frame. |
transactions (DetailedPairStatsNumberMetrics) | The transaction count over the time frame. |
WindowedDetailedPairStats
WindowedDetailedPairStats
Detailed pair stats over a time frame.
Fields for WindowedDetailedPairStats
WindowedDetailedPairStats
Name | Description |
---|---|
duration (DetailedPairStatsDuration!) | The duration used to request detailed pair stats. |
end (Int!) | The unix timestamp for the end of the window. |
start (Int!) | The unix timestamp for the start of the window. |
statsNonCurrency (WindowedDetailedNonCurrencyPairStats!) | The numerical stats, such as number of buyers. |
statsUsd (WindowedDetailedCurrencyPairStats!) | The currency stats in USD, such as volume. |
timestamps ([DetailedPairStatsBucketTimestamp]!) | The list of start/end timestamps broken down for each bucket within the window. |
WindowedDetailedStats
WindowedDetailedStats
Detailed stats over a window.
Fields for WindowedDetailedStats
WindowedDetailedStats
Name | Description |
---|---|
buckets ([DetailedStatsBucketTimestamp]!) | The list of start/end timestamps broken down for each bucket within the window. |
buyers (DetailedStatsNumberMetrics!) | The number of unique buyers over the window. |
buys (DetailedStatsNumberMetrics!) | The number of buys over the window. |
buyVolume (DetailedStatsStringMetrics) | The buy volume over the window. |
endTimestamp (Int!) | The unix timestamp for the end of the window. |
sellers (DetailedStatsNumberMetrics!) | The number of unique sellers over the window. |
sells (DetailedStatsNumberMetrics!) | The number of sells over the window. |
sellVolume (DetailedStatsStringMetrics) | The sell volume over the window. |
timestamp (Int!) | The unix timestamp for the start of the window. |
traders (DetailedStatsNumberMetrics) | The number of unique traders over the window. |
transactions (DetailedStatsNumberMetrics!) | The transaction count over the window. |
volume (DetailedStatsStringMetrics!) | The volume over the window. |
windowSize (DetailedStatsWindowSize!) | The window size used to request detailed stats. |