Queries

balances


Type: BalancesResponse!

Arguments for balances

NameDescription
input (BalancesInput!)

chartUrls


Type: ChartUrlsResponse

Arguments for chartUrls

NameDescription
input (ChartInput!)

Input required to fetch a pair chart.

filterExchanges


Type: ExchangeFilterConnection

Arguments for filterExchanges

NameDescription
filters (ExchangeFilters)

A set of filters to apply.

limit (Int)

The maximum number of exchanges to return.

offset (Int)

Where in the list the server should start when returning items. Use count+offset from the previous query to request the next page of results.

phrase (String)

A phrase to search for. Can match an exchange address or ID (address:networkId), or partially match an exchange name.

rankings ([ExchangeRanking])

A list of ranking attributes to apply.

filterNftCollections


Type: NftCollectionFilterConnection

Arguments for filterNftCollections

NameDescription
collections ([String])

A list of collection contract addresses or IDs (address:networkId) to filter by.

filters (NftCollectionFilters)

A set of filters to apply.

limit (Int)

The maximum number of NFT collections to return.

offset (Int)

Where in the list the server should start when returning items. Use count+offset from the previous query to request the next page of results.

phrase (String)

A phrase to search for. Can match a collection contract address or ID (address:networkId).

rankings ([NftCollectionRanking])

A list of ranking attributes to apply.

filterNftParallelAssets


Type: ParallelAssetFilterConnection

Arguments for filterNftParallelAssets

NameDescription
filters (ParallelAssetFilters)

A set of filters to apply.

limit (Int)

The maximum number of Parallel assets to return.

match (ParallelAssetMatchers)

A set of parameters to match.

offset (Int)

Where in the list the server should start when returning items. Use count+offset from the previous query to request the next page of results.

phrase (String)

A phrase to search for. Can match a Parallel asset ID (address:tokenId) or partially match a name.

rankings ([ParallelAssetRanking])

A list of ranking attributes to apply.

filterNftPoolCollections


Type: NftPoolCollectionFilterConnection

Arguments for filterNftPoolCollections

NameDescription
filters (NftPoolCollectionFilters)

A set of filters to apply.

limit (Int)

The maximum number of NFT collections to return.

offset (Int)

Where in the list the server should start when returning items. Use count+page from the previous query to request the next page of results.

phrase (String)

A phrase to search for. Can partially match an NFT collection name.

rankings ([NftPoolCollectionRanking])

A list of ranking attributes to apply.

filterNftPools


Type: NftPoolFilterConnection

Arguments for filterNftPools

NameDescription
filters (NftPoolFilters)

A set of filters to apply.

limit (Int)

The maximum number of NFT pools to return.

offset (Int)

Where in the list the server should start when returning items. Use count+page from the previous query to request the next page of results.

phrase (String)

rankings ([NftPoolRanking])

A list of ranking attributes to apply.

filterPairs


Type: PairFilterConnection

Arguments for filterPairs

NameDescription
filters (PairFilters)

A set of filters to apply.

limit (Int)

The maximum number of pairs to return.

matchTokens (PairFilterMatchTokens)

A set of token contract addresses that make up a pair. Can be used in place of a pair contract address.

offset (Int)

Where in the list the server should start when returning items. Use count+offset from the previous query to request the next page of results.

pairs ([String])

A list of pair or token contract addresses or IDs (address:networkId) to filter by.

phrase (String)

A phrase to search for. Can match a token or pair contract address or ID (address:networkId), or partially match a token name or symbol.

rankings ([PairRanking])

A list of ranking attributes to apply.

statsType (TokenPairStatisticsType)

The type of statistics returned. Can be FILTERED or UNFILTERED

filterTokens


Type: TokenFilterConnection

Arguments for filterTokens

NameDescription
filters (TokenFilters)

A set of filters to apply.

limit (Int)

The maximum number of tokens to return.

offset (Int)

Where in the list the server should start when returning items. Use count+page from the previous query to request the next page of results.

phrase (String)

A phrase to search for. Can match a token contract address or partially match a token's name or symbol.

rankings ([TokenRanking])

A list of ranking attributes to apply.

statsType (TokenPairStatisticsType)

The type of statistics returned. Can be FILTERED or UNFILTERED

tokens ([String])

A list of token IDs (address:networkId). Can be left blank to discover new tokens.

getBars


Type: BarsResponse

Arguments for getBars

NameDescription
currencyCode (String)

The currency to use for the response. Can be USD (default) or TOKEN.

from (Int!)

The unix timestamp for the start of the requested range.

quoteToken (QuoteToken)

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

removeLeadingNullValues (Boolean)

Whether to remove leading null values from the response. To fetch a token's entire history, set resolution to 1D, from value to 0 and removeLeadingNullValues to true. Default is false`.

resolution (String!)

The time frame for each candle. Available options are 1, 5, 15, 30, 60, 240, 720, 1D and 7D.

statsType (TokenPairStatisticsType)

The type of statistics returned. Can be FILTERED or UNFILTERED

symbol (String!)

The ID of the pair or token (pairAddress:networkId or tokenAddress:networkId). If a token contract address is provided, the token's top pair is used. For example, 0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2:1 returns WETH's top pair on Ethereum.

to (Int!)

The unix timestamp for the end of the requested range.

getCommunityNotes


Type: CommunityNotesResponse!

Arguments for getCommunityNotes

NameDescription
input (CommunityNotesInput)

getDetailedNftStats


Type: DetailedNftStats

Arguments for getDetailedNftStats

NameDescription
bucketCount (Int)

The number of aggregated values to receive.
Note: Each duration has predetermined bucket sizes.
The first n-1 buckets are historical. The last bucket is a snapshot of current data.
duration day1: 6 buckets (4 hours each) plus 1 partial bucket
duration hour12: 12 buckets (1 hour each) plus 1 partial bucket
duration hour4: 8 buckets (30 min each) plus 1 partial bucket
duration hour1: 12 buckets (5 min each) plus 1 partial bucket
duration min5: 5 buckets (1 min each) plus 1 partial bucket
For example, requesting 11 buckets for a min5 duration will return the last 10 minutes worth of data plus a snapshot for the current minute.

collectionAddress (String!)

The contract address of the NFT collection.

durations ([DetailedNftStatsDuration])

The list of durations to get detailed pair stats for.

grouping (String)

The marketplace address to filter by. Can be used to get marketplace-specific metrics, otherwise uses all.

networkId (Int!)

The network ID the NFT collection is deployed on.

timestamp (Int)

The unix timestamp for the stats. Defaults to current.

getDetailedPairsStats


Type: [DetailedPairStats]

Arguments for getDetailedPairsStats

NameDescription
input ([GetDetailedPairsStatsInput!]!)

getDetailedPairStats


Type: DetailedPairStats

Arguments for getDetailedPairStats

NameDescription
bucketCount (Int)

The number of aggregated values to receive. Note: Each duration has predetermined bucket sizes.
The first n-1 buckets are historical. The last bucket is a snapshot of current data.
duration day1: 6 buckets (4 hours each) plus 1 partial bucket
duration hour12: 12 buckets (1 hour each) plus 1 partial bucket
duration hour4: 8 buckets (30 min each) plus 1 partial bucket
duration hour1: 12 buckets (5 min each) plus 1 partial bucket
duration min5: 5 buckets (1 min each) plus 1 partial bucket
For example, requesting 11 buckets for a min5 duration will return the last 10 minutes worth of data plus a snapshot for the current minute.

durations ([DetailedPairStatsDuration])

The list of durations to get detailed pair stats for.

networkId (Int!)

The network ID the pair is deployed on.

pairAddress (String!)

The contract address of the pair.

statsType (TokenPairStatisticsType)

The type of statistics returned. Can be FILTERED or UNFILTERED

timestamp (Int)

The unix timestamp for the stats. Defaults to current.

tokenOfInterest (TokenOfInterest)

The token of interest used to calculate token-specific stats for the pair. Can be token0 or token1.

getDetailedStats

πŸ”΄ DEPRECATED πŸ”΄
Use getDetailedPairStats instead, it has more resolutions and better support


Type: DetailedStats

Arguments for getDetailedStats

NameDescription
bucketCount (Int)

The number of aggregated values to receive. Note: Each duration has predetermined bucket sizes.
The first n-1 buckets are historical. The last bucket is a snapshot of current data.
duration day1: 6 buckets (4 hours each) plus 1 partial bucket
duration hour12: 12 buckets (1 hour each) plus 1 partial bucket
duration hour4: 8 buckets (30 min each) plus 1 partial bucket
duration hour1: 12 buckets (5 min each) plus 1 partial bucket
duration min5: 5 buckets (1 min each) plus 1 partial bucket
For example, requesting 11 buckets for a min5 duration will return the last 10 minutes worth of data plus a snapshot for the current minute.

pairId (String!)

The ID of the pair (address:networkId).

statsType (TokenPairStatisticsType)

The type of statistics returned. Can be FILTERED or UNFILTERED

timestamp (Int)

The unix timestamp for the stats. Defaults to current.

tokenOfInterest (TokenOfInterest)

The token of interest used to calculate token-specific stats for the pair. Can be token0 or token1.

windowSizes ([DetailedStatsWindowSize])

The list of window sizes to get detailed stats for.

getEventLabels


Type: EventLabelConnection

Arguments for getEventLabels

NameDescription
cursor (String)

The cursor to use for pagination.

direction (RankingDirection)

The order to receive the token event labels. Can be DESC (default) or ASC.

id (String!)

The ID of the pair (address:networkId).

limit (Int)

The maximum number of event labels to return.

getExchanges


Type: [Exchange!]!

Arguments for getExchanges

None

getLatestPairs


Type: LatestPairConnection

Arguments for getLatestPairs

NameDescription
cursor (String)

The cursor to use for pagination.

exchangeFilter ([String!])

The list of exchanges to filter by.

limit (Int)

The maximum number of tokens to return.

minLiquidityFilter (Int)

The minimum amount of liquidity to filter by.

networkFilter ([Int!])

The list of network IDs to filter by.

getLatestTokens


Type: LatestTokenConnection

Arguments for getLatestTokens

NameDescription
limit (Int)

The maximum number of tokens to return. Maximum number of tokens is 50.

networkFilter ([Int!])

The list of network IDs to filter by.

offset (Int)

The offset to use for pagination.

getNetworks


Type: [Network!]!

Arguments for getNetworks

None

getNetworkStatus


Type: [MetadataResponse!]

Arguments for getNetworkStatus

NameDescription
networkIds ([Int!]!)

The list of network IDs.

getNftAssets


Type: NftAssetsConnection

Arguments for getNftAssets

NameDescription
address (String!)

The contract address of the NFT collection.

cursor (String)

The cursor to use for pagination.

fetchMissingAssets (Boolean)

Whether to trigger fetching onchain metadata for missing assets. Defaults to false. Fetch results are delayed and can be ingested realtime via onNftAssetsCreated subscription. Free tier API users are limited to 1 missing asset fetch per request, and may only retry fetching a missing asset once per week. To remove these limitations, please upgrade your API plan at https://www.dashboard.defined.fi/plan.

limit (Int)

The maximum number of NFT assets to return.

networkId (Int!)

The network ID the NFT collection is deployed on.

tokenIds ([String])

An optional list of token IDs to filter by.

getNftCollectionMetadata


Type: NftCollectionMetadataResponse

Arguments for getNftCollectionMetadata

NameDescription
address (String)

The contract address of the NFT collection.

collectionId (String)

The ID of the NFT collection (address:networkId). For example, 0xbc4ca0eda7647a8ab7c2061c2e118a18a936f13d:1.

πŸ”΄ DEPRECATED πŸ”΄
Use address & networkId instead.

networkId (Int)

The network ID the NFT collection is deployed on.

getNftContracts


Type: [EnhancedNftContract]

Arguments for getNftContracts

NameDescription
contracts ([NftContractInput])

A list of NFT contract address and network IDs.

getNftEvents


Type: NftEventsConnection

Arguments for getNftEvents

NameDescription
address (String)

The contract address of the NFT collection.

cursor (String)

The cursor to use for pagination.

exchangeAddress (String)

The NFT marketplace address to filter by.

includeTransfers (Boolean)

limit (Int)

The maximum number of NFT events to return.

networkId (Int!)

The network ID the NFT collection is deployed on.

poolAddress (String)

The NFT pool address to filter by.

timestamp (EventQueryTimestampInput)

The time range to filter by.

tokenId (String)

The token ID to filter by.

getNftPool


Type: NftPoolResponse

Arguments for getNftPool

NameDescription
address (String!)

The contract address of the NFT pool.

networkId (Int!)

The network ID the NFT collection is deployed on.

getNftPoolCollection


Type: NftPoolCollectionResponse

Arguments for getNftPoolCollection

NameDescription
collectionAddress (String!)

The contract address of the NFT collection.

exchangeAddress (String!)

The NFT AMM marketplace address to filter by.

networkId (Int!)

The network ID the NFT collection is deployed on.

getNftPoolCollectionsByExchange


Type: GetNftPoolCollectionsResponse

Arguments for getNftPoolCollectionsByExchange

NameDescription
cursor (String)

The cursor to use for pagination.

exchangeAddress (String!)

The NFT AMM marketplace address to filter by.

limit (Int)

The maximum number of NFT collections to return.

networkId (Int!)

The network ID the NFT collection is deployed on.

getNftPoolEvents


Type: NftPoolEventsResponse

Arguments for getNftPoolEvents

NameDescription
collectionAddress (String)

The contract address of the NFT collection.

cursor (String)

The cursor to use for pagination.

eventTypes ([NftPoolEventType!])

The event types to filter by.

exchangeAddress (String)

The NFT AMM marketplace address to filter by.

limit (Int)

The maximum number of NFT pool events to return.

networkId (Int!)

The network ID the NFT collection is deployed on.

poolAddress (String)

The NFT pool address to filter by.

getNftPoolsByCollectionAndExchange


Type: GetNftPoolsResponse

Arguments for getNftPoolsByCollectionAndExchange

NameDescription
collectionAddress (String!)

The contract address of the NFT collection.

cursor (String)

The cursor to use for pagination.

exchangeAddress (String!)

The NFT AMM marketplace address to filter by.

limit (Int)

The maximum number of NFT pools to return.

networkId (Int!)

The network ID the NFT collection is deployed on.

getNftPoolsByOwner


Type: GetNftPoolsResponse

Arguments for getNftPoolsByOwner

NameDescription
cursor (String)

The cursor to use for pagination.

exchangeAddress (String)

The NFT AMM marketplace address to filter by.

limit (Int)

The maximum number of NFT pools to return.

networkId (Int!)

The network ID the NFT collection is deployed on.

ownerAddress (String!)

The contract address of the pool owner.

getNftPoolStats


Type: NftPoolStatsResponse

Arguments for getNftPoolStats

NameDescription
collectionAddress (String!)

The contract address of the NFT collection.

endTime (Int!)

The unix timestamp for the end of the requested range.

exchangeAddress (String!)

The NFT AMM marketplace address to filter by.

networkId (Int!)

The network ID the NFT collection is deployed on.

poolAddress (String)

The NFT pool address to filter by.

startTime (Int!)

The unix timestamp for the start of the requested range.

getParallelAssets


Type: ParallelAssetsConnection

Arguments for getParallelAssets

NameDescription
cursor (String)

The cursor to use for pagination.

limit (Int)

The maximum number of Parallel assets to return.

tokenIds ([String])

An optional list of token IDs to filter by.

getParallelCardChanges


Type: ParallelCardChangesConnection

Arguments for getParallelCardChanges

NameDescription
cursor (String)

The cursor to use for pagination.

limit (Int)

The maximum number of Parallel card changes to return.

timestamp (ParallelCardChangeQueryTimestampInput)

The time frame to request card changes.

tokenId (String)

The token ID for a Parallel asset.

getPrimePoolAssets


Type: PrimePoolAssetConnection

Arguments for getPrimePoolAssets

NameDescription
cursor (String)

The cursor to use for pagination.

limit (Int)

The maximum number of Prime Pool assets to return.

networkId (Int!)

The network ID the Prime pool is deployed on.

poolContractAddress (String)

The contract address of the Prime pool.

poolId (String)

The pool ID for the Prime pool, within the contract.

walletAddress (String)

The owner wallet address to filter assets by.

getPrimePoolEvents


Type: PrimePoolEventConnection

Arguments for getPrimePoolEvents

NameDescription
cursor (String)

The cursor to use for pagination.

eventTypes ([PrimePoolEventType])

The event types to query for.

limit (Int)

The maximum number of Prime Pool events to return.

networkId (Int!)

The network ID the Prime pool is deployed on.

poolContractAddress (String)

The contract address of the Prime pool.

poolId (String)

The pool ID for the Prime pool, within the contract.

walletAddress (String)

The calling wallet address to filter events by.

getPrimePools


Type: PrimePoolConnection

Arguments for getPrimePools

NameDescription
address (String!)

The contract address for the prime pool.

cursor (String)

The cursor to use for pagination.

limit (Int)

The maximum number of Prime pools to return.

networkId (Int!)

The network ID the prime pool is deployed on.

poolIds ([String])

An optional list of pool IDs to filter by.

getSimulateTokenContractResults


Type: GetSimulateTokenContractResultsConnection!

Arguments for getSimulateTokenContractResults

NameDescription
contractAddress (String!)

cursor (String)

limit (Int)

networkId (Int!)

simulationId (String)

getSymbol


Type: SymbolResponse

Arguments for getSymbol

NameDescription
currencyCode (String)

The currency to use for the response. Can be USD (default) or TOKEN.

symbol (String!)

The ID of the pair (address:networkId).

getTokenCount


Type: String!

Arguments for getTokenCount

None

getTokenEvents


Type: EventConnection

Arguments for getTokenEvents

NameDescription
cursor (String)

The cursor to use for pagination.

direction (RankingDirection)

The order to receive the token events. Can be DESC (default) or ASC.

limit (Int)

The maximum number of transactions to return.

query (EventsQueryInput!)

The query filters to apply to the results.

getTokenInfo


Type: TokenInfo

Arguments for getTokenInfo

NameDescription
address (String!)

The contract address of the token.

networkId (Int!)

The network ID the token is deployed on.

getTokenPrices


Type: [Price]

Arguments for getTokenPrices

NameDescription
inputs ([GetPriceInput])

A list of GetPriceInputs. Accepts a maximum of 25 inputs (anything over will be truncated).

getTokensInfo


Type: [TokenInfo]

Arguments for getTokensInfo

NameDescription
input ([GetTokensInfoInput!]!)

A list of GetTokensInfoInputs. Accepts a maximum of 25 inputs (anything over will be truncated).

getUniV3Ticks


Type: UniV3TickConnection

Arguments for getUniV3Ticks

NameDescription
limit (Int)

The maximum number of ticks to return. Max is 1000.

networkId (Int!)

The network ID the pool is deployed on. Currently getUniV3Ticks is only supported on Ethereum mainnet (1).

offset (Int)

Offset for pagination of ticks.

poolAddress (String!)

The contract address of the pool.

getWebhooks


Type: GetWebhooksResponse

Arguments for getWebhooks

NameDescription
bucketId (String)

bucketSortkey (String)

cursor (String)

limit (Int)

webhookId (String)

holders


Type: HoldersResponse!

Arguments for holders

NameDescription
input (HoldersInput!)

listFavoriteTokens


Type: [TokenWithMetadata!]

Arguments for listFavoriteTokens

NameDescription
keys ([String!]!)

The list of token IDs to filter by (address:networkId).

networkFilter ([Int!])

The list of network IDs to filter by.

resolution (String)

The time frame for trending results. Can be 1, 5, 15, 30, 60, 240, 720, or 1D.

listPairsForToken


Type: [Pair]!

Arguments for listPairsForToken

NameDescription
limit (Int)

The maximum number of pairs to return.

networkId (Int!)

The network ID the token is deployed on.

tokenAddress (String!)

The contract address of the token.

listPairsWithMetadataForToken


Type: ListPairsForTokenResponse!

Arguments for listPairsWithMetadataForToken

NameDescription
limit (Int)

The maximum number of pairs to return.

networkId (Int!)

The network ID the token is deployed on.

tokenAddress (String!)

The contract address of the token.

listTopTokens


Type: [TokenWithMetadata!]

Arguments for listTopTokens

NameDescription
limit (Int)

The maximum number of tokens to return. Max is 50.

networkFilter ([Int!])

The list of network IDs to filter by.

resolution (String)

The time frame for trending results. Can be 1, 5, 15, 30, 60, 240, 720, or 1D.

pairMetadata


Type: PairMetadata!

Arguments for pairMetadata

NameDescription
pairId (String!)

The ID of the pair (address:networkId).

quoteToken (QuoteToken)

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

statsType (TokenPairStatisticsType)

The type of statistics returned. Can be FILTERED or UNFILTERED

primeBalance


Type: BalancesResponse!

Arguments for primeBalance

NameDescription
walletAddress (String!)

primeHolders


Type: PrimeHolders!

Arguments for primeHolders

NameDescription
cursor (String)

Included in the results. Use the string as an argument to paginate through all the holders.

searchNfts


Type: NftSearchResponse

Arguments for searchNfts

NameDescription
filterWashTrading (Boolean)

Whether to filter collections that could be linked to wash trading

include ([NftSearchable!])

The level of NFTs to include in the search. Can be Asset or Collection.

limit (Int)

The maximum number of NFTs to return.

networkFilter ([Int!])

The list of network IDs to filter by.

search (String)

The query string to search for. Can match an NFT collection contract address or partially match a collection's name or symbol.

window (String)

The time frame to use for calculating stats. Can be 1h, 4h, 12h, or 1d (default).

searchTokens


Type: TokenSearchResponse

Arguments for searchTokens

NameDescription
limit (Int)

The maximum number of tokens to return.

lowVolumeFilter (Boolean)

Whether to filter out low volume results from the response. Low volume is less than $500 USD. This setting has no effect when only low volume results are found. Default is true.

networkFilter ([Int!])

The list of network IDs to filter by.

resolution (String)

The time frame to use for token metadata. Can be 60, 240, 720, or 1D.

search (String!)

The query string to search for. Can match a token or pair contract address or partially match a token's name or symbol. Automatically filters out tokens marked as scams.

token


Type: EnhancedToken!

Arguments for token

NameDescription
input (TokenInput!)

Input for a token ID.

tokens


Type: [EnhancedToken]!

Arguments for tokens

NameDescription
ids ([TokenInput!])

A list of token ID input.

tokenSparklines


Type: [TokenSparkline!]!

Arguments for tokenSparklines

NameDescription
input (TokenSparklineInput!)