index/interfaces/PoolData.md

Pool data structure from backend

Indexable

[key: string]: unknown

Pool metadata

Properties

Property	Type	Description
amount	string	Token amount
assets?	TokenAssetUrls | null	Convenience asset URLs
badges?	PoolBadges	The volume and engagement badge ladders of the token, every rung with whether it is earned (the backend builds them in constructResponse for GET /v1/tokens and GET /v1/tokens/:tokenName) Since 9.0.0
bondingCurvePercentage	string	Bonding curve completion percentage (0-100)
circulatingSupply	string	Circulating supply of tokens
createdAt	string	Creation timestamp
creatorAddress	string	Creator address
currentViewerCount?	number	Current viewer count for active streams Since 5.7.0
deltaSupply	string	Change in supply (delta)
description	string	Token description
engagementBadge?	string | null	The highest engagement badge earned (the stored column; badges.engagement holds the ladder), or null Since 9.0.0
facebookUrl	string	Facebook page URL
galaInPool	string	Total GALA tokens currently in pool
galaPrice	string	Current price in GALA
hasReverseBondingCurveFee?	boolean	Boolean flag indicating if reverse bonding curve fees are non-zero
id	string	Pool identifier
image	string	Token image/logo URL
initialBuyAmount	number	Initial buy amount at pool creation
instagramUrl	string	Instagram profile URL
isFinalized	boolean	Whether pool is finalized
isGraduated	boolean	Whether token has graduated to full DEX trading
lastStreamedAt?	string | null	Timestamp when the pool last had an active stream (ISO 8601) Used for recentlyStreamed filter Since 5.7.0
marketCapGala	string	Market capitalization in GALA
marketCapUsd	string	Market capitalization in USD
muxPlaybackId?	string | null	Mux playback ID of the token's stream: '' or null until a stream exists Since 9.0.0 (was typed playbackId, a name the backend does not send)
muxStreamAspectRatio?	string | null	Video aspect ratio (e.g., "16:9", "9:16"), captured from Mux when the stream goes active Since 9.0.0 (was typed aspectRatio, a name the backend does not send)
muxStreamStatus?	StreamStatus	Current stream status ('IDLE' | 'ACTIVE' | 'DISABLED') Since 6.0.0
nextLiveStreamAt?	string | null	Next scheduled live stream time (ISO 8601 string) or null if not set Since 6.0.0
peakViewerCount?	number	Highest viewer count during current/last stream session Reset when a new stream starts Since 5.7.0
recordingsCount?	number	Count of recordings for this pool (synced from Mux) Since 5.8.0
redditUrl	string	Reddit community URL
reverseBondingCurveMaxFeePortion?	string	Reverse bonding curve maximum fee portion (flattened, coalesced to "0" if null)
reverseBondingCurveMinFeePortion?	string	Reverse bonding curve minimum fee portion (flattened, coalesced to "0" if null)
streamLanguage?	string | null	Stream language (ISO 639-1 code, e.g., "en", "es", "ja") Since 9.0.0 (was typed language, a name the backend does not send)
streamStartedAt?	string | null	Timestamp when stream status changed to ACTIVE (ISO 8601) Used to calculate stream duration Since 5.7.0
symbol	string	Token symbol
telegramUrl	string	Telegram channel URL
tiktokUrl	string	TikTok profile URL
tokenName	string	Token name
totalSecondsStreamed?	number	Cumulative seconds streamed across all stream sessions Since 5.8.0
twitterUrl	string	Twitter profile URL
usdPrice	string	Current price in USD
vaultAddress	string	Vault address
volume	string	Total trading volume (all-time)
volume1h	string	Trading volume in last 1 hour
volumeBadge?	string | null	The highest volume badge earned (the stored column; badges.volume holds the ladder), or null Since 9.0.0
websiteUrl	string	Project website URL