GET /api/supply
API Reference
GET /api/supply
Retrieve complete token supply breakdown with allocation details
GET
GET /api/supply
Overview
The supply endpoints provide complete supply breakdown for launchpad tokens, including detailed allocation information for circulating supply, team performance packages, and liquidity positions.For launchpad tokens, circulating supply excludes the team performance package but includes all liquidity (both FutarchyAMM and Meteora DAMM).
Supply Breakdown
For launchpad tokens, supply is broken down into the following categories:Endpoints
Full Supply Information
Endpoint:GET /api/supply/:mintAddress
Returns complete supply information for a token.
Path Parameters
string
required
The SPL token mint address (Solana PublicKey)Example:
METAwkXcqyXKy1AtsSgJ8JiUHwGCafnZL38n3vYmetaResponse
string
required
The formatted total supply as a string
object
required
Complete supply data object with allocation breakdown
Example Request
Example Response
Total Supply Only
Endpoint:GET /api/supply/:mintAddress/total
Returns just the total supply value as a plain string. Useful for integrations that only need the total supply number.
Example Request
Example Response
This endpoint returns a plain text response, not JSON, for easy integration with tools expecting a simple number.
Circulating Supply Only
Endpoint:GET /api/supply/:mintAddress/circulating
Returns just the circulating supply value as a plain string. This value excludes the team performance package but includes all liquidity positions.
Circulating = Total Supply - Team Performance PackageBoth FutarchyAMM liquidity and Meteora LP liquidity are included in circulating supply since these tokens are actively tradeable.
Example Request
Example Response
This endpoint returns a plain text response, not JSON, for easy integration with price aggregators like CoinGecko and CoinMarketCap.
Use Cases
Price Aggregators
CoinGecko and CoinMarketCap require supply endpoints for market cap calculations
Token Dashboards
Display real-time supply metrics on token information pages
Analytics
Track supply changes over time for tokenomics analysis
DeFi Integrations
Calculate fully diluted valuations and token metrics
Error Handling
Invalid Mint Address
Mint Not Found
Related Documentation
Tickers API
Get pricing and volume data for all DAOs
Volume Aggregate
Get aggregate volume with daily breakdown
API Overview
Learn about the API architecture
Error Handling
Handle API errors properly
