> For the complete documentation index, see [llms.txt](https://docs.heyhal.xyz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.heyhal.xyz/api-documentation/get-token-details.md). # Get Token Details **Endpoint:** `GET /api/v1/coin/details` ### Description This endpoint retrieves detailed information about a specific token, including its metadata, comments, creator information, AI agent configuration, and price history (OHLC data). ### Authentication Required: No Type: None ### Request #### Headers #### Content-Type: application/json #### Query Parameters | Parameter | Type | Required | Description | | --------- | ------ | -------- | ----------------------------- | | token | string | Yes | The mint address of the token | Example Request: GET /api/v1/coin/details?token=TokenMintAddress123... ### Response #### Success Response Status Code: 200 OK Content-Type: application/json interface TokenDetailsResponse { // Token Basic Info mintAddress: string; name: string; symbol: string; description: string; metaDataUrl: string; imageUrl: string; creatorWalletAddress: string; status: string; // Token State tx: string | null; signature: string | null; migrationStatus: string | null; kingOfTheHillTimeStamp: string | null; marketCap: string | null; // Timestamps createdAt: string; updatedAt: string; // Related Entities comments: Array<{ id: number; content: string; createdAt: string; updatedAt: string; userId: string; coinId: string; }>; creator: { walletAddress: string; username: string; role: string; lastLogin: string; }; agent: { id: number; name: string; description: string; personality: string; instruction: string; knowledge: string; points: number; usedPoints: number; telegramUrl: string; twitterUrl: string; websiteUrl: string; createdAt: string; updatedAt: string; } | null; ohlc: Array<{ timestamp: string; open: string; high: string; low: string; close: string; volume: string; }>; } #### Error Response Status Code: 500 Internal Server Error { "error": "An internal error occurred. Please try again later." } ### Example Usage ### // Basic token details fetcher ### async function getTokenDetails(tokenMintAddress: string) { ### try { ### const response = await fetch( ### \` ### ); ### ### if (!response.ok) { ### throw new Error(\`HTTP error! status: ${response.status}\`); ### } ### ### const tokenDetails = await response.json(); ### return tokenDetails; ### } catch (error) { ### console.error('Error fetching token details:', error); ### throw error; ### } ### } ### // Token Details Manager with caching ### class TokenDetailsManager { ### private cache: Map\ = new Map(); ### ### private readonly CACHE\_DURATION = 30000; // 30 seconds ### ### async getDetails(tokenMintAddress: string): Promise\ { ### // Check cache ### const cached = this.cache.get(tokenMintAddress); ### if (cached && Date.now() - cached.timestamp < this.CACHE\_DURATION) { ### return cached.data; ### } ### ### // Fetch fresh data ### const details = await getTokenDetails(tokenMintAddress); ### ### // Update cache ### this.cache.set(tokenMintAddress, { ### data: details, ### timestamp: Date.now() ### }); ### ### return details; ### } ### ### clearCache(tokenMintAddress?: string) { ### if (tokenMintAddress) { ### this.cache.delete(tokenMintAddress); ### } else { ### this.cache.clear(); ### } ### } ### } ### Implementation Notes 1\. Data Processing Utilities // Token status helper function getTokenStatus(details: TokenDetailsResponse) { if (details.migrationStatus === 'completed') { return 'MIGRATED'; } if (details.kingOfTheHillTimeStamp) { return 'KING\_OF\_HILL'; } if (details.status === 'success') { return 'ACTIVE'; } return 'PENDING'; } // Price history formatter function formatPriceHistory(details: TokenDetailsResponse) { return details.ohlc.map(candle => ({ timestamp: new Date(candle.timestamp).getTime(), open: parseFloat(candle.open), high: parseFloat(candle.high), low: parseFloat(candle.low), close: parseFloat(candle.close), volume: parseFloat(candle.volume) })); } // Social links aggregator function getSocialLinks(details: TokenDetailsResponse) { return { telegram: details.agent?.telegramUrl || null, twitter: details.agent?.twitterUrl || null, website: details.agent?.websiteUrl || null }; } Data Display Components // React component example interface TokenInfoProps { tokenMintAddress: string; } function TokenInfo({ tokenMintAddress }: TokenInfoProps) { const \[details, setDetails] = useState\(null); const \[loading, setLoading] = useState(true); const \[error, setError] = useState\(null); useEffect(() => { async function fetchDetails() { try { const data = await getTokenDetails(tokenMintAddress); setDetails(data); } catch (err) { setError(err.message); } finally { setLoading(false); } } fetchDetails(); }, \[tokenMintAddress]); if (loading) return \

Loading...\

; if (error) return \

Error: {error}\

; if (!details) return \

No data found\

; return ( \

{details.name} ({details.symbol})\

{details.description}\

Market Data\

Market Cap: {details.marketCap || 'N/A'}\

Comments ({details.comments.length})\

{details.comments.map(comment => ( \

{comment.content}\

\ Posted on {new Date(comment.createdAt).toLocaleDateString()} \ \

))} {details.agent && ( \

AI Agent\

Name: {details.agent.name}\

Description: {details.agent.description}\

Points: {details.agent.points - details.agent.usedPoints}\

)} \

); } Real-time Updates class TokenDetailsWatcher { private ws: WebSocket | null = null; private listeners: Set<(details: TokenDetailsResponse) => void> = new Set(); constructor(private tokenMintAddress: string) {} connect() { this.ws = new WebSocket('wss\://api.heyhal.xyz/ws'); this.ws.onopen = () => { this.ws?.send(JSON.stringify({ type: 'subscribe', token: this.tokenMintAddress })); }; this.ws.onmessage = (event) => { const data = JSON.parse(event.data); this.notifyListeners(data); }; } addListener(callback: (details: TokenDetailsResponse) => void) { this.listeners.add(callback); } removeListener(callback: (details: TokenDetailsResponse) => void) { this.listeners.delete(callback); } private notifyListeners(data: TokenDetailsResponse) { this.listeners.forEach(listener => listener(data)); } disconnect() { this.ws?.close(); this.ws = null; } }
--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.heyhal.xyz/api-documentation/get-token-details.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.