Returns a list of tokens based on a variety of filters.
Endpoint: filterTokens
Method: POST
Arguments
| Name | Type | Description |
|---|---|---|
| excludeTokens | [String] | A list of token IDs to exclude from results ( |
| 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 |
| 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 |
| tokens | [String] | A list of token IDs ( |
Response
| Name | Type | 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. |
| Name | Type | 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. |
| 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. |
| 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 token { info { circulatingSupply } } by priceUSD. |
| pair | Pair | Metadata for the token's top pair. |
| priceUSD | String | The token price in USD. |
| quoteToken | String | The token of interest. Can be token0 or token1. |
| 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. |
Explore
Ask questions, share what you're working on and request new features 👬👭