Parameters¶
Some endpoints require input parameters belonging to specific domains. On this page, all domains can be found in order to be in line with the standards required by the API.
Bases: CyholeParam
flowchart TD
cyhole.birdeye.param.BirdeyeChain[BirdeyeChain]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.birdeye.param.BirdeyeChain
click cyhole.birdeye.param.BirdeyeChain href "" "cyhole.birdeye.param.BirdeyeChain"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Enum class to get the supported Birdeye's chains.
class-attribute
instance-attribute
¶
SOLANA = 'solana'
Identifier of the Solana chain in Birdeye API.
class-attribute
instance-attribute
¶
ETHEREUM = 'ethereum'
Identifier of the Ethereum chain in Birdeye API.
class-attribute
instance-attribute
¶
ARBITRUM = 'arbitrum'
Identifier of the Arbitrum chain in Birdeye API.
class-attribute
instance-attribute
¶
AVALANCHE = 'avalanche'
Identifier of the Avalanche chain in Birdeye API.
class-attribute
instance-attribute
¶
BSC = 'bsc'
Identifier of the BSC (Binance Smart Chain) chain in Birdeye API.
class-attribute
instance-attribute
¶
OPTIMISM = 'optimism'
Identifier of the Optimism chain in Birdeye API.
class-attribute
instance-attribute
¶
POLYGON = 'polygon'
Identifier of the Polygon chain in Birdeye API.
class-attribute
instance-attribute
¶
BASE = 'base'
Identifier of the Base chain in Birdeye API.
class-attribute
instance-attribute
¶
ZKSYNC = 'zksync'
Identifier of the zkSync chain in Birdeye API.
class-attribute
instance-attribute
¶
MONAD = 'monad'
Identifier of the Monad chain in Birdeye API.
class-attribute
instance-attribute
¶
HYPERVM = 'hypervm'
Identifier of the HyperEVM chain in Birdeye API.
class-attribute
instance-attribute
¶
APTOS = 'aptos'
Identifier of the Aptos chain in Birdeye API.
class-attribute
instance-attribute
¶
FOGO = 'fogo'
Identifier of the Fogo chain in Birdeye API.
class-attribute
instance-attribute
¶
MANTLE = 'mantle'
Identifier of the Mantle chain in Birdeye API.
class-attribute
instance-attribute
¶
MEGAETH = 'megaeth'
Identifier of the MegaETH chain in Birdeye API.
Bases: CyholeParam
flowchart TD
cyhole.birdeye.param.BirdeyeOrder[BirdeyeOrder]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.birdeye.param.BirdeyeOrder
click cyhole.birdeye.param.BirdeyeOrder href "" "cyhole.birdeye.param.BirdeyeOrder"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Enum class to get the supported Birdeye's orders.
Bases: CyholeParam
flowchart TD
cyhole.birdeye.param.BirdeyeSort[BirdeyeSort]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.birdeye.param.BirdeyeSort
click cyhole.birdeye.param.BirdeyeSort href "" "cyhole.birdeye.param.BirdeyeSort"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Enum class to get the supported Birdeye's sorting types.
class-attribute
instance-attribute
¶
SORT_V24HUSD = 'v24hUSD'
Sort the results by USD Volume in the last 24h
class-attribute
instance-attribute
¶
SORT_V24HCHANGEPERCENT = 'v24hChangePercent'
Sort the results by percent changing in the last 24h
class-attribute
instance-attribute
¶
SORT_LIQUIDITY = 'liquidity'
Sort the results by Liquidity
Bases: CyholeParam
flowchart TD
cyhole.birdeye.param.BirdeyeUIAmountMode[BirdeyeUIAmountMode]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.birdeye.param.BirdeyeUIAmountMode
click cyhole.birdeye.param.BirdeyeUIAmountMode href "" "cyhole.birdeye.param.BirdeyeUIAmountMode"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Enum class to get the supported Birdeye's UI amount modes.
Only used on Solana chain to indicate whether the API should return the raw token amounts or the scaled UI amounts for scaled-UI-amount tokens.
class-attribute
instance-attribute
¶
RAW = 'raw'
Return raw on-chain token amounts (no UI scaling applied).
class-attribute
instance-attribute
¶
SCALED = 'scaled'
Return UI-scaled token amounts (default Birdeye behaviour).
class-attribute
instance-attribute
¶
BOTH = 'both'
Return both raw and UI-scaled amounts. Supported on endpoints that accept this mode.
Bases: CyholeParam
flowchart TD
cyhole.birdeye.param.BirdeyeTimeFrame[BirdeyeTimeFrame]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.birdeye.param.BirdeyeTimeFrame
click cyhole.birdeye.param.BirdeyeTimeFrame href "" "cyhole.birdeye.param.BirdeyeTimeFrame"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Enum class to get the supported Birdeye's timeframe sizes.
Bases: CyholeParam
flowchart TD
cyhole.birdeye.param.BirdeyeHourTimeFrame[BirdeyeHourTimeFrame]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.birdeye.param.BirdeyeHourTimeFrame
click cyhole.birdeye.param.BirdeyeHourTimeFrame href "" "cyhole.birdeye.param.BirdeyeHourTimeFrame"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Enum class to get the supported Birdeye's timeframe sizes with hour as unit size.
Bases: CyholeParam
flowchart TD
cyhole.birdeye.param.BirdeyeAddressType[BirdeyeAddressType]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.birdeye.param.BirdeyeAddressType
click cyhole.birdeye.param.BirdeyeAddressType href "" "cyhole.birdeye.param.BirdeyeAddressType"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Enum class to get the supported Birdeye's address' types.
Bases: CyholeParam
flowchart TD
cyhole.birdeye.param.BirdeyeTradeType[BirdeyeTradeType]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.birdeye.param.BirdeyeTradeType
click cyhole.birdeye.param.BirdeyeTradeType href "" "cyhole.birdeye.param.BirdeyeTradeType"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Enum class to get the supported Birdeye's transactions' types.
Bases: CyholeParam
flowchart TD
cyhole.birdeye.param.BirdeyeV2MarketsSortBy[BirdeyeV2MarketsSortBy]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.birdeye.param.BirdeyeV2MarketsSortBy
click cyhole.birdeye.param.BirdeyeV2MarketsSortBy href "" "cyhole.birdeye.param.BirdeyeV2MarketsSortBy"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Enum class to get the supported sorting metrics of the Birdeye v2 Token - All Market List endpoint.
Bases: CyholeParam
flowchart TD
cyhole.birdeye.param.BirdeyeTokenTrendingSortBy[BirdeyeTokenTrendingSortBy]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.birdeye.param.BirdeyeTokenTrendingSortBy
click cyhole.birdeye.param.BirdeyeTokenTrendingSortBy href "" "cyhole.birdeye.param.BirdeyeTokenTrendingSortBy"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Enum class to get the supported sorting metrics of the Birdeye Token - Trending List endpoint.
class-attribute
instance-attribute
¶
RANK = 'rank'
Sort tokens by Birdeye's internal trending rank.
class-attribute
instance-attribute
¶
VOLUME_USD = 'volumeUSD'
Sort tokens by USD traded volume over the selected interval.
class-attribute
instance-attribute
¶
LIQUIDITY = 'liquidity'
Sort tokens by current liquidity (USD).
Bases: CyholeParam
flowchart TD
cyhole.birdeye.param.BirdeyeTokenTrendingInterval[BirdeyeTokenTrendingInterval]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.birdeye.param.BirdeyeTokenTrendingInterval
click cyhole.birdeye.param.BirdeyeTokenTrendingInterval href "" "cyhole.birdeye.param.BirdeyeTokenTrendingInterval"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Enum class to select the trending time window of the Birdeye Token - Trending List endpoint.
Bases: CyholeParam
flowchart TD
cyhole.birdeye.param.BirdeyeHolderChartType[BirdeyeHolderChartType]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.birdeye.param.BirdeyeHolderChartType
click cyhole.birdeye.param.BirdeyeHolderChartType href "" "cyhole.birdeye.param.BirdeyeHolderChartType"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Enum class to select the resolution of the Birdeye Token - Holder Chart endpoint.
Bases: CyholeParam
flowchart TD
cyhole.birdeye.param.BirdeyeHolderChartMode[BirdeyeHolderChartMode]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.birdeye.param.BirdeyeHolderChartMode
click cyhole.birdeye.param.BirdeyeHolderChartMode href "" "cyhole.birdeye.param.BirdeyeHolderChartMode"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Enum class to control how the Birdeye Token - Holder Chart endpoint fills missing data points.
Bases: CyholeParam
flowchart TD
cyhole.birdeye.param.BirdeyeHolderChartPercentMode[BirdeyeHolderChartPercentMode]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.birdeye.param.BirdeyeHolderChartPercentMode
click cyhole.birdeye.param.BirdeyeHolderChartPercentMode href "" "cyhole.birdeye.param.BirdeyeHolderChartPercentMode"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Enum class to control how the Birdeye Token - Holder Chart endpoint computes the
percent_change field returned for each data point.
Bases: CyholeParam
flowchart TD
cyhole.birdeye.param.BirdeyeHolderDistributionAddressType[BirdeyeHolderDistributionAddressType]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.birdeye.param.BirdeyeHolderDistributionAddressType
click cyhole.birdeye.param.BirdeyeHolderDistributionAddressType href "" "cyhole.birdeye.param.BirdeyeHolderDistributionAddressType"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Enum class to select the address type used by the Birdeye Token - Holder Distribution endpoint.
Bases: CyholeParam
flowchart TD
cyhole.birdeye.param.BirdeyeHolderDistributionMode[BirdeyeHolderDistributionMode]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.birdeye.param.BirdeyeHolderDistributionMode
click cyhole.birdeye.param.BirdeyeHolderDistributionMode href "" "cyhole.birdeye.param.BirdeyeHolderDistributionMode"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Enum class to select the filter mode of the Birdeye Token - Holder Distribution endpoint.
Bases: CyholeParam
flowchart TD
cyhole.birdeye.param.BirdeyeV2TopTradersSortBy[BirdeyeV2TopTradersSortBy]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.birdeye.param.BirdeyeV2TopTradersSortBy
click cyhole.birdeye.param.BirdeyeV2TopTradersSortBy href "" "cyhole.birdeye.param.BirdeyeV2TopTradersSortBy"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Enum class to get the supported sorting metrics of the Birdeye v2 Token - Top Traders endpoint.
The PnL-based metrics (total_pnl, unrealized_pnl, realized_pnl, volume_usd) and the
long time frames (2d..90d) are restricted by Birdeye to the Solana chain at the time of writing.
class-attribute
instance-attribute
¶
VOLUME = 'volume'
Sort traders by raw traded volume in the token's UI units.
class-attribute
instance-attribute
¶
TRADE = 'trade'
Sort traders by number of trades on the token.
class-attribute
instance-attribute
¶
TOTAL_PNL = 'total_pnl'
Sort traders by total profit-and-loss (Solana-only).
class-attribute
instance-attribute
¶
UNREALIZED_PNL = 'unrealized_pnl'
Sort traders by unrealised profit-and-loss (Solana-only).
class-attribute
instance-attribute
¶
REALIZED_PNL = 'realized_pnl'
Sort traders by realised profit-and-loss (Solana-only).
class-attribute
instance-attribute
¶
VOLUME_USD = 'volume_usd'
Sort traders by traded volume expressed in USD (Solana-only).
Bases: CyholeParam
flowchart TD
cyhole.birdeye.param.BirdeyeV2TopTradersTimeFrame[BirdeyeV2TopTradersTimeFrame]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.birdeye.param.BirdeyeV2TopTradersTimeFrame
click cyhole.birdeye.param.BirdeyeV2TopTradersTimeFrame href "" "cyhole.birdeye.param.BirdeyeV2TopTradersTimeFrame"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Enum class to get the supported time frames of the Birdeye v2 Token - Top Traders endpoint.
Frames longer than 24h (2d..90d) are restricted by Birdeye to the Solana chain.
Bases: CyholeParam
flowchart TD
cyhole.birdeye.param.BirdeyeMintBurnType[BirdeyeMintBurnType]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.birdeye.param.BirdeyeMintBurnType
click cyhole.birdeye.param.BirdeyeMintBurnType href "" "cyhole.birdeye.param.BirdeyeMintBurnType"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Enum class to filter the Birdeye v3 Token Mint/Burn endpoint by transaction type.
Bases: CyholeParam
flowchart TD
cyhole.birdeye.param.BirdeyeV3TokenListSortBy[BirdeyeV3TokenListSortBy]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.birdeye.param.BirdeyeV3TokenListSortBy
click cyhole.birdeye.param.BirdeyeV3TokenListSortBy href "" "cyhole.birdeye.param.BirdeyeV3TokenListSortBy"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Enum class to get the supported sorting metrics of the Birdeye v3 Token - List endpoint.
The endpoint supports a single sort metric per request; pick one of the constants below
and pair it with a BirdeyeOrder direction.
class-attribute
instance-attribute
¶
LIQUIDITY = 'liquidity'
Sort by current liquidity (USD).
class-attribute
instance-attribute
¶
MARKET_CAP = 'market_cap'
Sort by market capitalisation (USD).
class-attribute
instance-attribute
¶
RECENT_LISTING_TIME = 'recent_listing_time'
Sort by the time Birdeye first detected the token listing.
class-attribute
instance-attribute
¶
LAST_TRADE_UNIX_TIME = 'last_trade_unix_time'
Sort by the unix timestamp of the last observed trade.
class-attribute
instance-attribute
¶
HOLDER = 'holder'
Sort by the number of distinct token holders.
class-attribute
instance-attribute
¶
VOLUME_1M_USD = 'volume_1m_usd'
Sort by USD traded volume during the trailing 1m window.
class-attribute
instance-attribute
¶
VOLUME_5M_USD = 'volume_5m_usd'
Sort by USD traded volume during the trailing 5m window.
class-attribute
instance-attribute
¶
VOLUME_30M_USD = 'volume_30m_usd'
Sort by USD traded volume during the trailing 30m window.
class-attribute
instance-attribute
¶
VOLUME_1H_USD = 'volume_1h_usd'
Sort by USD traded volume during the trailing 1h window.
class-attribute
instance-attribute
¶
VOLUME_2H_USD = 'volume_2h_usd'
Sort by USD traded volume during the trailing 2h window.
class-attribute
instance-attribute
¶
VOLUME_4H_USD = 'volume_4h_usd'
Sort by USD traded volume during the trailing 4h window.
class-attribute
instance-attribute
¶
VOLUME_8H_USD = 'volume_8h_usd'
Sort by USD traded volume during the trailing 8h window.
class-attribute
instance-attribute
¶
VOLUME_24H_USD = 'volume_24h_usd'
Sort by USD traded volume during the trailing 24h window.
class-attribute
instance-attribute
¶
VOLUME_7D_USD = 'volume_7d_usd'
Sort by USD traded volume during the trailing 7d window.
class-attribute
instance-attribute
¶
VOLUME_30D_USD = 'volume_30d_usd'
Sort by USD traded volume during the trailing 30d window.
class-attribute
instance-attribute
¶
VOLUME_1M_CHANGE_PERCENT = 'volume_1m_change_percent'
Sort by percent change of USD volume vs the previous 1m window.
class-attribute
instance-attribute
¶
VOLUME_5M_CHANGE_PERCENT = 'volume_5m_change_percent'
Sort by percent change of USD volume vs the previous 5m window.
class-attribute
instance-attribute
¶
VOLUME_30M_CHANGE_PERCENT = 'volume_30m_change_percent'
Sort by percent change of USD volume vs the previous 30m window.
class-attribute
instance-attribute
¶
VOLUME_1H_CHANGE_PERCENT = 'volume_1h_change_percent'
Sort by percent change of USD volume vs the previous 1h window.
class-attribute
instance-attribute
¶
VOLUME_2H_CHANGE_PERCENT = 'volume_2h_change_percent'
Sort by percent change of USD volume vs the previous 2h window.
class-attribute
instance-attribute
¶
VOLUME_4H_CHANGE_PERCENT = 'volume_4h_change_percent'
Sort by percent change of USD volume vs the previous 4h window.
class-attribute
instance-attribute
¶
VOLUME_8H_CHANGE_PERCENT = 'volume_8h_change_percent'
Sort by percent change of USD volume vs the previous 8h window.
class-attribute
instance-attribute
¶
VOLUME_24H_CHANGE_PERCENT = 'volume_24h_change_percent'
Sort by percent change of USD volume vs the previous 24h window.
class-attribute
instance-attribute
¶
VOLUME_7D_CHANGE_PERCENT = 'volume_7d_change_percent'
Sort by percent change of USD volume vs the previous 7d window.
class-attribute
instance-attribute
¶
VOLUME_30D_CHANGE_PERCENT = 'volume_30d_change_percent'
Sort by percent change of USD volume vs the previous 30d window.
class-attribute
instance-attribute
¶
PRICE_CHANGE_1M_PERCENT = 'price_change_1m_percent'
Sort by percent price change over the trailing 1m window.
class-attribute
instance-attribute
¶
PRICE_CHANGE_5M_PERCENT = 'price_change_5m_percent'
Sort by percent price change over the trailing 5m window.
class-attribute
instance-attribute
¶
PRICE_CHANGE_30M_PERCENT = 'price_change_30m_percent'
Sort by percent price change over the trailing 30m window.
class-attribute
instance-attribute
¶
PRICE_CHANGE_1H_PERCENT = 'price_change_1h_percent'
Sort by percent price change over the trailing 1h window.
class-attribute
instance-attribute
¶
PRICE_CHANGE_2H_PERCENT = 'price_change_2h_percent'
Sort by percent price change over the trailing 2h window.
class-attribute
instance-attribute
¶
PRICE_CHANGE_4H_PERCENT = 'price_change_4h_percent'
Sort by percent price change over the trailing 4h window.
class-attribute
instance-attribute
¶
PRICE_CHANGE_8H_PERCENT = 'price_change_8h_percent'
Sort by percent price change over the trailing 8h window.
class-attribute
instance-attribute
¶
PRICE_CHANGE_24H_PERCENT = 'price_change_24h_percent'
Sort by percent price change over the trailing 24h window.
class-attribute
instance-attribute
¶
PRICE_CHANGE_7D_PERCENT = 'price_change_7d_percent'
Sort by percent price change over the trailing 7d window.
class-attribute
instance-attribute
¶
PRICE_CHANGE_30D_PERCENT = 'price_change_30d_percent'
Sort by percent price change over the trailing 30d window.
class-attribute
instance-attribute
¶
TRADE_1M_COUNT = 'trade_1m_count'
Sort by the number of trades during the trailing 1m window.
class-attribute
instance-attribute
¶
TRADE_5M_COUNT = 'trade_5m_count'
Sort by the number of trades during the trailing 5m window.
class-attribute
instance-attribute
¶
TRADE_30M_COUNT = 'trade_30m_count'
Sort by the number of trades during the trailing 30m window.
class-attribute
instance-attribute
¶
TRADE_1H_COUNT = 'trade_1h_count'
Sort by the number of trades during the trailing 1h window.
class-attribute
instance-attribute
¶
TRADE_2H_COUNT = 'trade_2h_count'
Sort by the number of trades during the trailing 2h window.
class-attribute
instance-attribute
¶
TRADE_4H_COUNT = 'trade_4h_count'
Sort by the number of trades during the trailing 4h window.
class-attribute
instance-attribute
¶
TRADE_8H_COUNT = 'trade_8h_count'
Sort by the number of trades during the trailing 8h window.
class-attribute
instance-attribute
¶
TRADE_24H_COUNT = 'trade_24h_count'
Sort by the number of trades during the trailing 24h window.
class-attribute
instance-attribute
¶
TRADE_7D_COUNT = 'trade_7d_count'
Sort by the number of trades during the trailing 7d window.
class-attribute
instance-attribute
¶
TRADE_30D_COUNT = 'trade_30d_count'
Sort by the number of trades during the trailing 30d window.
Bases: CyholeParam
flowchart TD
cyhole.birdeye.param.BirdeyeSearchTarget[BirdeyeSearchTarget]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.birdeye.param.BirdeyeSearchTarget
click cyhole.birdeye.param.BirdeyeSearchTarget href "" "cyhole.birdeye.param.BirdeyeSearchTarget"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Enum class to select which entity type the Birdeye v3 Search endpoint should return.
Bases: CyholeParam
flowchart TD
cyhole.birdeye.param.BirdeyeSearchMode[BirdeyeSearchMode]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.birdeye.param.BirdeyeSearchMode
click cyhole.birdeye.param.BirdeyeSearchMode href "" "cyhole.birdeye.param.BirdeyeSearchMode"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Enum class to control the matching behaviour of the Birdeye v3 Search endpoint.
Bases: CyholeParam
flowchart TD
cyhole.birdeye.param.BirdeyeSearchBy[BirdeyeSearchBy]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.birdeye.param.BirdeyeSearchBy
click cyhole.birdeye.param.BirdeyeSearchBy href "" "cyhole.birdeye.param.BirdeyeSearchBy"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Enum class to select which field the Birdeye v3 Search endpoint should match against.
class-attribute
instance-attribute
¶
COMBINATION = 'combination'
Match against name, symbol, and address together.
class-attribute
instance-attribute
¶
ADDRESS = 'address'
Match against the token or market contract address.
class-attribute
instance-attribute
¶
SYMBOL = 'symbol'
Match against the token ticker symbol (default behaviour).
Bases: CyholeParam
flowchart TD
cyhole.birdeye.param.BirdeyeSearchSortBy[BirdeyeSearchSortBy]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.birdeye.param.BirdeyeSearchSortBy
click cyhole.birdeye.param.BirdeyeSearchSortBy href "" "cyhole.birdeye.param.BirdeyeSearchSortBy"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Enum class to select the sort metric for the Birdeye v3 Search endpoint.
class-attribute
instance-attribute
¶
MARKETCAP = 'marketcap'
Sort by market capitalisation (USD).
class-attribute
instance-attribute
¶
LIQUIDITY = 'liquidity'
Sort by current on-chain liquidity (USD).
class-attribute
instance-attribute
¶
PRICE_CHANGE_24H_PERCENT = 'price_change_24h_percent'
Sort by percent price change over the trailing 24h window.
class-attribute
instance-attribute
¶
TRADE_24H = 'trade_24h'
Sort by number of trades during the trailing 24h window.
class-attribute
instance-attribute
¶
TRADE_24H_CHANGE_PERCENT = 'trade_24h_change_percent'
Sort by percent change of trade count vs the previous 24h window.
class-attribute
instance-attribute
¶
BUY_24H = 'buy_24h'
Sort by number of buy-side trades during the trailing 24h window.
class-attribute
instance-attribute
¶
BUY_24H_CHANGE_PERCENT = 'buy_24h_change_percent'
Sort by percent change of buy trades vs the previous 24h window.
class-attribute
instance-attribute
¶
SELL_24H = 'sell_24h'
Sort by number of sell-side trades during the trailing 24h window.
class-attribute
instance-attribute
¶
SELL_24H_CHANGE_PERCENT = 'sell_24h_change_percent'
Sort by percent change of sell trades vs the previous 24h window.
class-attribute
instance-attribute
¶
UNIQUE_WALLET_24H = 'unique_wallet_24h'
Sort by number of unique wallets that traded during the trailing 24h window.
class-attribute
instance-attribute
¶
UNIQUE_VIEW_24H_CHANGE_PERCENT = (
"unique_view_24h_change_percent"
)
Sort by percent change of unique wallet count vs the previous 24h window.
class-attribute
instance-attribute
¶
LAST_TRADE_UNIX_TIME = 'last_trade_unix_time'
Sort by the unix timestamp of the last observed trade.
class-attribute
instance-attribute
¶
VOLUME_24H_USD = 'volume_24h_usd'
Sort by USD traded volume during the trailing 24h window (default behaviour).
class-attribute
instance-attribute
¶
VOLUME_24H_CHANGE_PERCENT = 'volume_24h_change_percent'
Sort by percent change of USD volume vs the previous 24h window.
Bases: CyholeParam
flowchart TD
cyhole.birdeye.param.BirdeyeAllTimeTradesTimeFrame[BirdeyeAllTimeTradesTimeFrame]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.birdeye.param.BirdeyeAllTimeTradesTimeFrame
click cyhole.birdeye.param.BirdeyeAllTimeTradesTimeFrame href "" "cyhole.birdeye.param.BirdeyeAllTimeTradesTimeFrame"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Enum class to get the supported time-frame intervals for the Birdeye v3 All-Time Trades endpoints (single and multiple).
Each value selects the cumulative window over which trade statistics are
aggregated. Use ALL_TIME to retrieve statistics spanning the token's
entire trading history.
class-attribute
instance-attribute
¶
ALL_TIME = 'alltime'
Full token trading history since inception.
Bases: CyholeParam
flowchart TD
cyhole.birdeye.param.BirdeyeV3MemeListSortBy[BirdeyeV3MemeListSortBy]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.birdeye.param.BirdeyeV3MemeListSortBy
click cyhole.birdeye.param.BirdeyeV3MemeListSortBy href "" "cyhole.birdeye.param.BirdeyeV3MemeListSortBy"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Enum class to get the supported sorting metrics of the Birdeye v3 Meme Token - List endpoint.
The endpoint supports a single sort metric per request; pick one of the constants below
and pair it with a BirdeyeOrder direction.
class-attribute
instance-attribute
¶
PROGRESS_PERCENT = 'progress_percent'
Sort by bonding-curve funding progress (0–100 %).
class-attribute
instance-attribute
¶
GRADUATED_TIME = 'graduated_time'
Sort by the unix timestamp at which the token graduated to a DEX pool.
class-attribute
instance-attribute
¶
CREATION_TIME = 'creation_time'
Sort by token creation time (unix timestamp).
class-attribute
instance-attribute
¶
LIQUIDITY = 'liquidity'
Sort by current on-chain liquidity (USD).
class-attribute
instance-attribute
¶
MARKET_CAP = 'market_cap'
Sort by market capitalisation (USD).
class-attribute
instance-attribute
¶
RECENT_LISTING_TIME = 'recent_listing_time'
Sort by the time Birdeye first detected the token listing.
class-attribute
instance-attribute
¶
LAST_TRADE_UNIX_TIME = 'last_trade_unix_time'
Sort by the unix timestamp of the last observed trade.
class-attribute
instance-attribute
¶
HOLDER = 'holder'
Sort by the number of distinct token holders.
class-attribute
instance-attribute
¶
VOLUME_1M_USD = 'volume_1m_usd'
Sort by USD traded volume during the trailing 1 minute window.
class-attribute
instance-attribute
¶
VOLUME_5M_USD = 'volume_5m_usd'
Sort by USD traded volume during the trailing 5 minute window.
class-attribute
instance-attribute
¶
VOLUME_30M_USD = 'volume_30m_usd'
Sort by USD traded volume during the trailing 30 minute window.
class-attribute
instance-attribute
¶
VOLUME_1H_USD = 'volume_1h_usd'
Sort by USD traded volume during the trailing 1 hour window.
class-attribute
instance-attribute
¶
VOLUME_2H_USD = 'volume_2h_usd'
Sort by USD traded volume during the trailing 2 hour window.
class-attribute
instance-attribute
¶
VOLUME_4H_USD = 'volume_4h_usd'
Sort by USD traded volume during the trailing 4 hour window.
class-attribute
instance-attribute
¶
VOLUME_8H_USD = 'volume_8h_usd'
Sort by USD traded volume during the trailing 8 hour window.
class-attribute
instance-attribute
¶
VOLUME_24H_USD = 'volume_24h_usd'
Sort by USD traded volume during the trailing 24 hour window.
class-attribute
instance-attribute
¶
VOLUME_7D_USD = 'volume_7d_usd'
Sort by USD traded volume during the trailing 7 day window.
class-attribute
instance-attribute
¶
VOLUME_30D_USD = 'volume_30d_usd'
Sort by USD traded volume during the trailing 30 day window.
class-attribute
instance-attribute
¶
VOLUME_1M_CHANGE_PERCENT = 'volume_1m_change_percent'
Sort by percent change of USD volume vs the previous 1 minute window.
class-attribute
instance-attribute
¶
VOLUME_5M_CHANGE_PERCENT = 'volume_5m_change_percent'
Sort by percent change of USD volume vs the previous 5 minute window.
class-attribute
instance-attribute
¶
VOLUME_30M_CHANGE_PERCENT = 'volume_30m_change_percent'
Sort by percent change of USD volume vs the previous 30 minute window.
class-attribute
instance-attribute
¶
VOLUME_1H_CHANGE_PERCENT = 'volume_1h_change_percent'
Sort by percent change of USD volume vs the previous 1 hour window.
class-attribute
instance-attribute
¶
VOLUME_2H_CHANGE_PERCENT = 'volume_2h_change_percent'
Sort by percent change of USD volume vs the previous 2 hour window.
class-attribute
instance-attribute
¶
VOLUME_4H_CHANGE_PERCENT = 'volume_4h_change_percent'
Sort by percent change of USD volume vs the previous 4 hour window.
class-attribute
instance-attribute
¶
VOLUME_8H_CHANGE_PERCENT = 'volume_8h_change_percent'
Sort by percent change of USD volume vs the previous 8 hour window.
class-attribute
instance-attribute
¶
VOLUME_24H_CHANGE_PERCENT = 'volume_24h_change_percent'
Sort by percent change of USD volume vs the previous 24 hour window.
class-attribute
instance-attribute
¶
VOLUME_7D_CHANGE_PERCENT = 'volume_7d_change_percent'
Sort by percent change of USD volume vs the previous 7 day window.
class-attribute
instance-attribute
¶
VOLUME_30D_CHANGE_PERCENT = 'volume_30d_change_percent'
Sort by percent change of USD volume vs the previous 30 day window.
class-attribute
instance-attribute
¶
PRICE_CHANGE_1M_PERCENT = 'price_change_1m_percent'
Sort by percent price change over the trailing 1 minute window.
class-attribute
instance-attribute
¶
PRICE_CHANGE_5M_PERCENT = 'price_change_5m_percent'
Sort by percent price change over the trailing 5 minute window.
class-attribute
instance-attribute
¶
PRICE_CHANGE_30M_PERCENT = 'price_change_30m_percent'
Sort by percent price change over the trailing 30 minute window.
class-attribute
instance-attribute
¶
PRICE_CHANGE_1H_PERCENT = 'price_change_1h_percent'
Sort by percent price change over the trailing 1 hour window.
class-attribute
instance-attribute
¶
PRICE_CHANGE_2H_PERCENT = 'price_change_2h_percent'
Sort by percent price change over the trailing 2 hour window.
class-attribute
instance-attribute
¶
PRICE_CHANGE_4H_PERCENT = 'price_change_4h_percent'
Sort by percent price change over the trailing 4 hour window.
class-attribute
instance-attribute
¶
PRICE_CHANGE_8H_PERCENT = 'price_change_8h_percent'
Sort by percent price change over the trailing 8 hour window.
class-attribute
instance-attribute
¶
PRICE_CHANGE_24H_PERCENT = 'price_change_24h_percent'
Sort by percent price change over the trailing 24 hour window.
class-attribute
instance-attribute
¶
PRICE_CHANGE_7D_PERCENT = 'price_change_7d_percent'
Sort by percent price change over the trailing 7 day window.
class-attribute
instance-attribute
¶
PRICE_CHANGE_30D_PERCENT = 'price_change_30d_percent'
Sort by percent price change over the trailing 30 day window.
class-attribute
instance-attribute
¶
TRADE_1M_COUNT = 'trade_1m_count'
Sort by the number of trades during the trailing 1 minute window.
class-attribute
instance-attribute
¶
TRADE_5M_COUNT = 'trade_5m_count'
Sort by the number of trades during the trailing 5 minute window.
class-attribute
instance-attribute
¶
TRADE_30M_COUNT = 'trade_30m_count'
Sort by the number of trades during the trailing 30 minute window.
class-attribute
instance-attribute
¶
TRADE_1H_COUNT = 'trade_1h_count'
Sort by the number of trades during the trailing 1 hour window.
class-attribute
instance-attribute
¶
TRADE_2H_COUNT = 'trade_2h_count'
Sort by the number of trades during the trailing 2 hour window.
class-attribute
instance-attribute
¶
TRADE_4H_COUNT = 'trade_4h_count'
Sort by the number of trades during the trailing 4 hour window.
class-attribute
instance-attribute
¶
TRADE_8H_COUNT = 'trade_8h_count'
Sort by the number of trades during the trailing 8 hour window.
class-attribute
instance-attribute
¶
TRADE_24H_COUNT = 'trade_24h_count'
Sort by the number of trades during the trailing 24 hour window.
class-attribute
instance-attribute
¶
TRADE_7D_COUNT = 'trade_7d_count'
Sort by the number of trades during the trailing 7 day window.
class-attribute
instance-attribute
¶
TRADE_30D_COUNT = 'trade_30d_count'
Sort by the number of trades during the trailing 30 day window.
Bases: CyholeParam
flowchart TD
cyhole.birdeye.param.BirdeyeV3MemeSource[BirdeyeV3MemeSource]
cyhole.core.param.CyholeParam[CyholeParam]
cyhole.core.param.CyholeParam --> cyhole.birdeye.param.BirdeyeV3MemeSource
click cyhole.birdeye.param.BirdeyeV3MemeSource href "" "cyhole.birdeye.param.BirdeyeV3MemeSource"
click cyhole.core.param.CyholeParam href "" "cyhole.core.param.CyholeParam"
Enum class to get the supported meme-token launchpad sources for the Birdeye v3 Meme Token - List endpoint.
Pass one of these values as the source filter to restrict results to
tokens originating from a specific launchpad platform.
class-attribute
instance-attribute
¶
ALL = 'all'
No source filter — includes tokens from every supported launchpad.
class-attribute
instance-attribute
¶
PUMP_DOT_FUN = 'pump_dot_fun'
Tokens launched on the pump.fun platform.
class-attribute
instance-attribute
¶
MOONSHOT = 'moonshot'
Tokens launched on the Moonshot platform.
class-attribute
instance-attribute
¶
RAYDIUM_LAUNCHLAB = 'raydium_launchlab'
Tokens launched on Raydium LaunchLab.
class-attribute
instance-attribute
¶
METEORA_DYNAMIC_BONDING_CURVE = (
"meteora_dynamic_bonding_curve"
)
Tokens launched via Meteora's dynamic bonding curve.
class-attribute
instance-attribute
¶
FOUR_MEME = 'four.meme'
Tokens launched on the four.meme platform.
class-attribute
instance-attribute
¶
NAD_FUN = 'nad.fun'
Tokens launched on the nad.fun platform.
class-attribute
instance-attribute
¶
SOMETHING = 'something'
Tokens from the 'something' launchpad.
class-attribute
instance-attribute
¶
LFJ_TOKEN_MILL = 'lfj_token_mill'
Tokens launched via LFJ Token Mill.