Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.codex.io/llms.txt

Use this file to discover all available pages before exploring further.

​
id
String!
The ID of the token (address:networkId).
​
address
String!
The contract address of the token.
​
cmcId
Int
The token ID on CoinMarketCap.
​
decimals
Int!
The precision to which the token can be divided. For example, the smallest unit for USDC is 0.000001 (6 decimals).
​
isScam
Boolean
Whether the token has been flagged as a scam.
​
name
String
The token name. For example, ApeCoin.
​
networkId
Int!
The network ID the token is deployed on.
​
symbol
String
The token symbol. For example, APE.
​
socialLinks
SocialLinks
Community gathered links for the socials of this token. See SocialLinks
​
info
TokenInfo
More metadata about the token. See TokenInfo
​
gridAssetId
String
The Grid asset ID, if this token is linked to a Grid asset.
​
bluechipRating
String
The Grid bluechip rating for this token (e.g. A+, B-).
​
organization
Organization
The Grid organization associated with this token. See Organization
​
asset
Asset
The Grid asset associated with this token. See Asset
​
exchanges
[Exchange!]
A list of exchanges where the token has been traded. See Exchange
​
creatorAddress
String
The token creator’s wallet address.
​
createBlockNumber
Int
The block height the token was created at.
​
createTransactionHash
String
The transaction hash of the token’s creation.
​
createdAt
Int
The unix timestamp for the creation of the token.
​
mintable
String
Returns mint authority address if token is mintable. If null, verify against isMintableValid.
​
freezable
String
Returns freeze authority address if token is freezable. If null, verify against isFreezableValid.
​
isFreezableValid
Boolean
Determines if freezable is a valid address or null value for the authority, or if the freezable state has not yet been determined.
​
isMintableValid
Boolean
Determines if mintable is a valid address or null value for the authority, or if the mintable state has not yet been determined.
​
launchpad
LaunchpadData
The launchpad data for the token, if applicable. See LaunchpadData
​
top10HoldersPercent
Float
The percentage of total supply held by the top 10 holders (excluding exchanges/pairs).
​
profanity
Boolean
Whether the token name or symbol contains profanity.
​
extrema
TokenExtrema
All-time high and low price/market cap data for the token. See TokenExtrema
​
coinCommunity
CoinCommunity
The Coin Community data for the token See CoinCommunity
​
totalSupply
String
deprecated
The total supply of the token.
This field is deprecated. Use the TokenInfo type
​
explorerData
ExplorerTokenData
deprecated
Information about the token from 3rd party sources. See ExplorerTokenData
This field is deprecated. Use the TokenInfo type
​
imageThumbUrl
String
deprecated
The thumbnail token logo URL.
This field is deprecated. Use the TokenInfo type
​
imageSmallUrl
String
deprecated
The small token logo URL.
This field is deprecated. Use the TokenInfo type
​
imageLargeUrl
String
deprecated
The large token logo URL.
This field is deprecated. Use the TokenInfo type
​
circulatingSupply
String
deprecated
The circulating supply of the token.
This field is deprecated. Use the TokenInfo type
​
pooled
String
deprecated
The amount of this token in the pair.
This field is deprecated. Pooled can be found on the pair instead

​
Used By

Returned by
  • balances: Returns list of token balances that a wallet has.
  • filterPairs: Returns a list of pairs based on a variety of filters.
  • filterTokens: Discover, screen, and rank tokens across every supported network using 100+ on-chain signals: trading activity, liquidity, holder behavior, fee economics, and launchpad lifecycle.
  • filterTokenWallets: Returns a list of wallets with stats narrowed down to a specific token.
  • getBars: Returns bar chart data to track price changes over time.
  • getCommunityNotes: Returns community gathered notes.
  • getDetailedPairsStats: Returns bucketed stats for a given token within a list of pairs.
  • getDetailedPairStats: Returns bucketed stats for a given token within a pair.
  • getTokenBars: Returns aggregated bar chart data to track price changes over time.
  • holders: Returns list of wallets that hold a given token, ordered by holdings descending. Also has the unique count of holders for that token.
  • listPairsForToken: Returns a list of pairs containing a given token.
  • listPairsWithMetadataForToken: Returns a list of pair metadata for a token.
  • onBalanceUpdated: Live-streamed balance updates for a given wallet.
  • onFilterTokensUpdated: Live-streamed filter token updates for the current filterTokens result set.
  • onHoldersUpdated: Live-streamed list of wallets that hold a given token. Also has the unique count of holders for that token.
  • onLaunchpadTokenEvent: Live-streamed launchpad token event.
  • onLaunchpadTokenEventBatch: Live-streamed launchpad token events batched (more efficient).
  • onPairMetadataUpdated: Live-streamed stat updates for a given token within a pair.
  • pairMetadata: Returns metadata for a pair of tokens.
  • refreshBalances: Force refreshes the balance for a token in a wallet. EVM only.
  • token: Returns a single token by its address & network id.
  • tokens: Returns a list of tokens by their addresses & network id, with pagination.