Response Schema¶

Each response has been mapped into a pydantic schema in a way that makes it easy to read and write codes that use them.

The classes identifying the response schema of an endpoint are the only ones ending with Response word, all other sub-schemes are used to identify the structures obtained from the responses.

Schema Enhancement

If some schema are incorrect or needs to be enhanced (optional/mandatory fields changes, incorrect datatype or schema update) feel free to open a pull request or issue by attaching:

- method
- endpoint call executed
- response obtained

cyhole.birdeye.schema ¶

Birdeye response/body schemas, grouped by API domain.

all `module-attribute` ¶

__all__ = [
    "GetTokenListInfo",
    "GetTokenListData",
    "GetTokenListResponse",
    "V3TokenListExtensions",
    "V3TokenListItem",
    "GetV3TokenListData",
    "GetV3TokenListResponse",
    "GetV3TokenListQuery",
    "GetV3TokenListScrollData",
    "GetV3TokenListScrollResponse",
    "GetV3TokenListScrollQuery",
    "GetV2TokensNewListingItem",
    "GetV2TokensNewListingData",
    "GetV2TokensNewListingResponse",
    "GetV2MarketsTokenSide",
    "GetV2MarketsItem",
    "GetV2MarketsData",
    "GetV2MarketsResponse",
    "GetV2TopTradersItem",
    "GetV2TopTradersData",
    "GetV2TopTradersResponse",
    "GetTokenSecurityDataSolana",
    "GetTokenSecurityResponse",
    "GetTokenOverviewData",
    "GetTokenOverviewResponse",
    "GetV3TokenMetaDataItem",
    "GetV3TokenMetaDataResponse",
    "GetV3TokenMetaDataMultipleResponse",
    "GetV3TokenMarketDataItem",
    "GetV3TokenMarketDataResponse",
    "GetV3TokenMarketDataMultipleResponse",
    "GetV3TokenTradeDataItem",
    "GetV3TokenTradeDataResponse",
    "GetV3TokenTradeDataMultipleResponse",
    "GetV3TokenExitLiquidityPrice",
    "GetV3TokenExitLiquidityItem",
    "GetV3TokenExitLiquidityResponse",
    "GetV3TokenExitLiquidityMultipleData",
    "GetV3TokenExitLiquidityMultipleResponse",
    "GetV3AllTimeTradesItem",
    "GetV3AllTimeTradesResponse",
    "GetTokenCreationInfoData",
    "GetTokenCreationInfoResponse",
    "GetTokenTrendingItem",
    "GetTokenTrendingData",
    "GetTokenTrendingResponse",
    "GetPriceData",
    "GetPriceResponse",
    "GetPriceMultipleData",
    "GetPriceMultipleResponse",
    "GetPriceHistoricalMeasure",
    "GetPriceHistoricalData",
    "GetPriceHistoricalResponse",
    "GetPriceVolumeSingleData",
    "GetPriceVolumeSingleResponse",
    "PostPriceVolumeMultiData",
    "PostPriceVolumeMultiResponse",
    "GetTradesTokenTradeToken",
    "GetTradesTokenTrade",
    "GetTradesTokenData",
    "GetTradesTokenResponse",
    "GetTradesPairTradeToken",
    "GetTradesPairTrade",
    "GetTradesPairData",
    "GetTradesPairResponse",
    "GetOHLCVInterval",
    "GetOHLCVTokenPairInterval",
    "GetOHLCVTokenPairData",
    "GetOHLCVTokenPairResponse",
    "GetOHLCVBaseQuoteInterval",
    "GetOHLCVBaseQuoteData",
    "GetOHLCVBaseQuoteResponse",
    "GetV3TokenMintBurnTxsItem",
    "GetV3TokenMintBurnTxsData",
    "GetV3TokenMintBurnTxsResponse",
    "GetTokenHolderItem",
    "GetTokenHolderData",
    "GetTokenHolderResponse",
    "PostTokenHolderBatchItem",
    "PostTokenHolderBatchData",
    "PostTokenHolderBatchBody",
    "PostTokenHolderBatchResponse",
    "GetHolderDistributionEntry",
    "GetHolderDistributionPagination",
    "GetHolderDistributionRange",
    "GetHolderDistributionSummary",
    "GetHolderDistributionData",
    "GetHolderDistributionResponse",
    "GetHolderProfileSummary",
    "GetHolderProfileTagBreakdown",
    "GetHolderProfileTokenTopHolder",
    "GetHolderProfileToken",
    "GetHolderProfileData",
    "GetHolderProfileResponse",
    "GetTokenHolderPositionItem",
    "GetTokenHolderPositionsResponse",
    "GetTokenHolderChartItem",
    "GetTokenHolderChartResponse",
    "PostTokenTransferBody",
    "PostTokenTransferItemTokenInfo",
    "PostTokenTransferItem",
    "PostTokenTransferResponse",
    "PostTokenTransferTotalBody",
    "PostTokenTransferTotalData",
    "PostTokenTransferTotalResponse",
    "GetWalletSupportedNetworksResponse",
    "GetV3SearchQuery",
    "GetV3SearchResultItem",
    "GetV3SearchItem",
    "GetV3SearchData",
    "GetV3SearchResponse",
    "GetUtilsV1CreditsBreakdown",
    "GetUtilsV1CreditsData",
    "GetUtilsV1CreditsResponse",
    "GetV3TokenMemeDetailSingleTxRef",
    "GetV3TokenMemeDetailSinglePool",
    "GetV3TokenMemeDetailSingleMemeInfo",
    "GetV3TokenMemeDetailSingleData",
    "GetV3TokenMemeDetailSingleResponse",
    "GetV3TokenMemeListQuery",
    "GetV3TokenMemeListMemeInfo",
    "GetV3TokenMemeListItem",
    "GetV3TokenMemeListData",
    "GetV3TokenMemeListResponse",
]

GetTokenListInfo ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetTokenListInfo[GetTokenListInfo]

              

              click cyhole.birdeye.schema.GetTokenListInfo href "" "cyhole.birdeye.schema.GetTokenListInfo"

name `class-attribute` `instance-attribute` ¶

name: str | None = None

symbol `class-attribute` `instance-attribute` ¶

symbol: str | None = None

price `instance-attribute` ¶

price: float

address `instance-attribute` ¶

address: str

decimals `instance-attribute` ¶

decimals: int

liquidity `instance-attribute` ¶

liquidity: float

volume_24h_usd `class-attribute` `instance-attribute` ¶

volume_24h_usd: float = Field(alias='v24hUSD')

market_cap `class-attribute` `instance-attribute` ¶

market_cap: float = Field(alias='mc')

volume_24h_change `class-attribute` `instance-attribute` ¶

volume_24h_change: float | None = Field(
    alias="v24hChangePercent", default=None
)

last_trade_unix_time `class-attribute` `instance-attribute` ¶

last_trade_unix_time: float = Field(
    alias="lastTradeUnixTime"
)

logo_uri `class-attribute` `instance-attribute` ¶

logo_uri: str | None = Field(alias='logoURI', default=None)

GetTokenListData ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetTokenListData[GetTokenListData]

              

              click cyhole.birdeye.schema.GetTokenListData href "" "cyhole.birdeye.schema.GetTokenListData"

total `class-attribute` `instance-attribute` ¶

total: int | None = None

update_time `class-attribute` `instance-attribute` ¶

update_time: datetime = Field(alias='updateTime')

update_unix_time `class-attribute` `instance-attribute` ¶

update_unix_time: int = Field(alias='updateUnixTime')

tokens `instance-attribute` ¶

tokens: list[GetTokenListInfo]

parse_update_time ¶

parse_update_time(
    update_time_raw: str | datetime,
) -> datetime

Source code in src/cyhole/birdeye/schema/token_list.py

@field_validator("update_time")
def parse_update_time(cls, update_time_raw: str | datetime) -> datetime:
    if isinstance(update_time_raw, str):
        return datetime.strptime(update_time_raw, "%Y-%m-%dT%H:%M:%S")
    return update_time_raw

GetTokenListResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetTokenListResponse[GetTokenListResponse]

              

              click cyhole.birdeye.schema.GetTokenListResponse href "" "cyhole.birdeye.schema.GetTokenListResponse"

Model used to represent the Token - List endpoint from birdeye API.

data `instance-attribute` ¶

data: GetTokenListData

success `instance-attribute` ¶

success: bool

V3TokenListExtensions ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.V3TokenListExtensions[V3TokenListExtensions]

              

              click cyhole.birdeye.schema.V3TokenListExtensions href "" "cyhole.birdeye.schema.V3TokenListExtensions"

Optional free-form metadata bag returned alongside each v3 token list item.

Every key is optional and may be missing or None. Most tokens carry only a subset of these links.

Attributes:

Name	Type	Description
`coingecko_id`	`str \| None`	CoinGecko identifier for the token; `None` if untracked there.
`serum_v3_usdc`	`str \| None`	Serum V3 market address vs USDC (Solana specific); `None` if unavailable.
`serum_v3_usdt`	`str \| None`	Serum V3 market address vs USDT (Solana specific); `None` if unavailable.
`website`	`str \| None`	official website URL of the token project; `None` if unknown.
`telegram`	`str \| None`	official Telegram URL; `None` if unknown.
`twitter`	`str \| None`	official Twitter/X URL; `None` if unknown.
`description`	`str \| None`	textual description of the token; `None` if unknown.
`discord`	`str \| None`	official Discord URL; `None` if unknown.
`medium`	`str \| None`	official Medium URL; `None` if unknown.
`github`	`str \| None`	official GitHub URL; `None` if unknown.

coingecko_id `class-attribute` `instance-attribute` ¶

coingecko_id: str | None = None

serum_v3_usdc `class-attribute` `instance-attribute` ¶

serum_v3_usdc: str | None = None

serum_v3_usdt `class-attribute` `instance-attribute` ¶

serum_v3_usdt: str | None = None

website `class-attribute` `instance-attribute` ¶

website: str | None = None

telegram `class-attribute` `instance-attribute` ¶

telegram: str | None = None

twitter `class-attribute` `instance-attribute` ¶

twitter: str | None = None

description `class-attribute` `instance-attribute` ¶

description: str | None = None

discord `class-attribute` `instance-attribute` ¶

discord: str | None = None

medium `class-attribute` `instance-attribute` ¶

medium: str | None = None

github `class-attribute` `instance-attribute` ¶

github: str | None = None

model_config `class-attribute` `instance-attribute` ¶

model_config = {'extra': 'allow'}

V3TokenListItem ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.V3TokenListItem[V3TokenListItem]

              

              click cyhole.birdeye.schema.V3TokenListItem href "" "cyhole.birdeye.schema.V3TokenListItem"

Single token entry returned by the v3 Token - List and Token - List Scroll endpoints.

Bundles token identity (address, symbol, name, social links), supply, liquidity, price, holder count, and per-window trade/volume aggregates for the trailing 1m, 5m, 30m, 1h, 2h, 4h, 8h, 24h, 7d and 30d windows together with the equivalent percent change vs the previous window. The 24h, 7d and 30d windows additionally expose buy- and sell-side breakdowns.

Attributes:

Name	Type	Description
`address`	`str`	contract address of the token on the selected chain.
`logo_uri`	`str \| None`	URL of the token logo; `None` if Birdeye does not have a logo for the token.
`name`	`str \| None`	human-readable name of the token; `None` if unknown.
`symbol`	`str \| None`	ticker symbol of the token; `None` if unknown.
`decimals`	`int`	number of decimal places used by the token.
`extensions`	`V3TokenListExtensions \| None`	free-form metadata bag (CoinGecko id, website, socials, ...); `None` when Birdeye has no extra metadata.
`market_cap`	`float \| None`	current market capitalisation of the token in USD; `None` when Birdeye cannot compute it.
`fdv`	`float \| None`	fully-diluted valuation in USD; `None` when Birdeye cannot compute it.
`total_supply`	`float \| None`	total on-chain supply of the token in UI units; `None` if undetermined.
`circulating_supply`	`float \| None`	currently circulating supply of the token in UI units; `None` if undetermined.
`liquidity`	`float \| None`	total on-chain liquidity of the token in USD; `None` if undetermined.
`last_trade_unix_time`	`int \| None`	unix-second timestamp of the last observed trade; `None` if no trades have been recorded.
`volume_1m_usd`	`float \| None`	traded volume during the trailing 1m window expressed in USD; `None` when no activity in that window.
`volume_1m_change_percent`	`float \| None`	percent change of traded USD volume between the current and previous 1m windows; `None` if change cannot be computed.
`volume_5m_usd`	`float \| None`	traded volume during the trailing 5m window expressed in USD; `None` when no activity in that window.
`volume_5m_change_percent`	`float \| None`	percent change of traded USD volume between the current and previous 5m windows; `None` if change cannot be computed.
`volume_30m_usd`	`float \| None`	traded volume during the trailing 30m window expressed in USD; `None` when no activity in that window.
`volume_30m_change_percent`	`float \| None`	percent change of traded USD volume between the current and previous 30m windows; `None` if change cannot be computed.
`volume_1h_usd`	`float \| None`	traded volume during the trailing 1h window expressed in USD; `None` when no activity in that window.
`volume_1h_change_percent`	`float \| None`	percent change of traded USD volume between the current and previous 1h windows; `None` if change cannot be computed.
`volume_2h_usd`	`float \| None`	traded volume during the trailing 2h window expressed in USD; `None` when no activity in that window.
`volume_2h_change_percent`	`float \| None`	percent change of traded USD volume between the current and previous 2h windows; `None` if change cannot be computed.
`volume_4h_usd`	`float \| None`	traded volume during the trailing 4h window expressed in USD; `None` when no activity in that window.
`volume_4h_change_percent`	`float \| None`	percent change of traded USD volume between the current and previous 4h windows; `None` if change cannot be computed.
`volume_8h_usd`	`float \| None`	traded volume during the trailing 8h window expressed in USD; `None` when no activity in that window.
`volume_8h_change_percent`	`float \| None`	percent change of traded USD volume between the current and previous 8h windows; `None` if change cannot be computed.
`volume_24h_usd`	`float \| None`	traded volume during the trailing 24h window expressed in USD; `None` when no activity in that window.
`volume_24h_change_percent`	`float \| None`	percent change of traded USD volume between the current and previous 24h windows; `None` if change cannot be computed.
`volume_7d_usd`	`float \| None`	traded volume during the trailing 7d window expressed in USD; `None` when no activity in that window.
`volume_7d_change_percent`	`float \| None`	percent change of traded USD volume between the current and previous 7d windows; `None` if change cannot be computed.
`volume_30d_usd`	`float \| None`	traded volume during the trailing 30d window expressed in USD; `None` when no activity in that window.
`volume_30d_change_percent`	`float \| None`	percent change of traded USD volume between the current and previous 30d windows; `None` if change cannot be computed.
`trade_1m_count`	`int \| None`	total number of trades during the trailing 1m window; `None` when no activity in that window.
`trade_5m_count`	`int \| None`	total number of trades during the trailing 5m window; `None` when no activity in that window.
`trade_30m_count`	`int \| None`	total number of trades during the trailing 30m window; `None` when no activity in that window.
`trade_1h_count`	`int \| None`	total number of trades during the trailing 1h window; `None` when no activity in that window.
`trade_2h_count`	`int \| None`	total number of trades during the trailing 2h window; `None` when no activity in that window.
`trade_4h_count`	`int \| None`	total number of trades during the trailing 4h window; `None` when no activity in that window.
`trade_8h_count`	`int \| None`	total number of trades during the trailing 8h window; `None` when no activity in that window.
`trade_24h_count`	`int \| None`	total number of trades during the trailing 24h window; `None` when no activity in that window.
`trade_7d_count`	`int \| None`	total number of trades during the trailing 7d window; `None` when no activity in that window.
`trade_30d_count`	`int \| None`	total number of trades during the trailing 30d window; `None` when no activity in that window.
`buy_24h`	`int \| None`	number of buy trades during the trailing 24h window; `None` when no activity in that window.
`buy_24h_change_percent`	`float \| None`	percent change of buy trade count between the current and previous 24h windows; `None` if change cannot be computed.
`volume_buy_24h_usd`	`float \| None`	buy-side traded volume during the trailing 24h window in USD; `None` when no activity in that window.
`volume_buy_24h_change_percent`	`float \| None`	percent change of buy-side traded USD volume between the current and previous 24h windows; `None` if change cannot be computed.
`buy_7d`	`int \| None`	number of buy trades during the trailing 7d window; `None` when no activity in that window.
`buy_7d_change_percent`	`float \| None`	percent change of buy trade count between the current and previous 7d windows; `None` if change cannot be computed.
`volume_buy_7d_usd`	`float \| None`	buy-side traded volume during the trailing 7d window in USD; `None` when no activity in that window.
`volume_buy_7d_change_percent`	`float \| None`	percent change of buy-side traded USD volume between the current and previous 7d windows; `None` if change cannot be computed.
`buy_30d`	`int \| None`	number of buy trades during the trailing 30d window; `None` when no activity in that window.
`buy_30d_change_percent`	`float \| None`	percent change of buy trade count between the current and previous 30d windows; `None` if change cannot be computed.
`volume_buy_30d_usd`	`float \| None`	buy-side traded volume during the trailing 30d window in USD; `None` when no activity in that window.
`volume_buy_30d_change_percent`	`float \| None`	percent change of buy-side traded USD volume between the current and previous 30d windows; `None` if change cannot be computed.
`sell_24h`	`int \| None`	number of sell trades during the trailing 24h window; `None` when no activity in that window.
`sell_24h_change_percent`	`float \| None`	percent change of sell trade count between the current and previous 24h windows; `None` if change cannot be computed.
`volume_sell_24h_usd`	`float \| None`	sell-side traded volume during the trailing 24h window in USD; `None` when no activity in that window.
`volume_sell_24h_change_percent`	`float \| None`	percent change of sell-side traded USD volume between the current and previous 24h windows; `None` if change cannot be computed.
`sell_7d`	`int \| None`	number of sell trades during the trailing 7d window; `None` when no activity in that window.
`sell_7d_change_percent`	`float \| None`	percent change of sell trade count between the current and previous 7d windows; `None` if change cannot be computed.
`volume_sell_7d_usd`	`float \| None`	sell-side traded volume during the trailing 7d window in USD; `None` when no activity in that window.
`volume_sell_7d_change_percent`	`float \| None`	percent change of sell-side traded USD volume between the current and previous 7d windows; `None` if change cannot be computed.
`sell_30d`	`int \| None`	number of sell trades during the trailing 30d window; `None` when no activity in that window.
`sell_30d_change_percent`	`float \| None`	percent change of sell trade count between the current and previous 30d windows; `None` if change cannot be computed.
`volume_sell_30d_usd`	`float \| None`	sell-side traded volume during the trailing 30d window in USD; `None` when no activity in that window.
`volume_sell_30d_change_percent`	`float \| None`	percent change of sell-side traded USD volume between the current and previous 30d windows; `None` if change cannot be computed.
`unique_wallet_24h`	`int \| None`	count of unique wallets that traded the token during the trailing 24h window; `None` if undetermined.
`unique_wallet_24h_change_percent`	`float \| None`	percent change of unique wallets between the current and previous 24h windows; `None` if change cannot be computed.
`price`	`float \| None`	latest known price of the token in USD; `None` if no price datapoint is available.
`price_change_1m_percent`	`float \| None`	price change versus the start of the trailing 1m window expressed in percent; `None` if change cannot be computed.
`price_change_5m_percent`	`float \| None`	price change versus the start of the trailing 5m window expressed in percent; `None` if change cannot be computed.
`price_change_30m_percent`	`float \| None`	price change versus the start of the trailing 30m window expressed in percent; `None` if change cannot be computed.
`price_change_1h_percent`	`float \| None`	price change versus the start of the trailing 1h window expressed in percent; `None` if change cannot be computed.
`price_change_2h_percent`	`float \| None`	price change versus the start of the trailing 2h window expressed in percent; `None` if change cannot be computed.
`price_change_4h_percent`	`float \| None`	price change versus the start of the trailing 4h window expressed in percent; `None` if change cannot be computed.
`price_change_8h_percent`	`float \| None`	price change versus the start of the trailing 8h window expressed in percent; `None` if change cannot be computed.
`price_change_24h_percent`	`float \| None`	price change versus the start of the trailing 24h window expressed in percent; `None` if change cannot be computed.
`price_change_7d_percent`	`float \| None`	price change versus the start of the trailing 7d window expressed in percent; `None` if change cannot be computed.
`price_change_30d_percent`	`float \| None`	price change versus the start of the trailing 30d window expressed in percent; `None` if change cannot be computed.
`holder`	`int \| None`	number of distinct holders of the token on the chain; `None` if undetermined.
`recent_listing_time`	`int \| None`	unix-second timestamp at which Birdeye first detected listings for the token; `None` if not tracked.
`is_scaled_ui_token`	`bool \| None`	`True` when the token is a scaled-UI-amount SPL token (Solana only); `None` outside Solana or undetermined.
`multiplier`	`float \| None`	scaling multiplier applied by the API to UI amounts of scaled-UI-amount tokens; `None` when not applicable.
`creation_time`	`int \| None`	unix-second timestamp at which the token was first created on the chain; only populated by the scroll endpoint, `None` otherwise.

address `class-attribute` `instance-attribute` ¶

address: str = None

logo_uri `class-attribute` `instance-attribute` ¶

logo_uri: str | None = None

name `class-attribute` `instance-attribute` ¶

name: str | None = None

symbol `class-attribute` `instance-attribute` ¶

symbol: str | None = None

decimals `class-attribute` `instance-attribute` ¶

decimals: int = None

extensions `class-attribute` `instance-attribute` ¶

extensions: V3TokenListExtensions | None = None

market_cap `class-attribute` `instance-attribute` ¶

market_cap: float | None = None

fdv `class-attribute` `instance-attribute` ¶

fdv: float | None = None

total_supply `class-attribute` `instance-attribute` ¶

total_supply: float | None = None

circulating_supply `class-attribute` `instance-attribute` ¶

circulating_supply: float | None = None

liquidity `class-attribute` `instance-attribute` ¶

liquidity: float | None = None

last_trade_unix_time `class-attribute` `instance-attribute` ¶

last_trade_unix_time: int | None = None

volume_1m_usd `class-attribute` `instance-attribute` ¶

volume_1m_usd: float | None = None

volume_1m_change_percent `class-attribute` `instance-attribute` ¶

volume_1m_change_percent: float | None = None

volume_5m_usd `class-attribute` `instance-attribute` ¶

volume_5m_usd: float | None = None

volume_5m_change_percent `class-attribute` `instance-attribute` ¶

volume_5m_change_percent: float | None = None

volume_30m_usd `class-attribute` `instance-attribute` ¶

volume_30m_usd: float | None = None

volume_30m_change_percent `class-attribute` `instance-attribute` ¶

volume_30m_change_percent: float | None = None

volume_1h_usd `class-attribute` `instance-attribute` ¶

volume_1h_usd: float | None = None

volume_1h_change_percent `class-attribute` `instance-attribute` ¶

volume_1h_change_percent: float | None = None

volume_2h_usd `class-attribute` `instance-attribute` ¶

volume_2h_usd: float | None = None

volume_2h_change_percent `class-attribute` `instance-attribute` ¶

volume_2h_change_percent: float | None = None

volume_4h_usd `class-attribute` `instance-attribute` ¶

volume_4h_usd: float | None = None

volume_4h_change_percent `class-attribute` `instance-attribute` ¶

volume_4h_change_percent: float | None = None

volume_8h_usd `class-attribute` `instance-attribute` ¶

volume_8h_usd: float | None = None

volume_8h_change_percent `class-attribute` `instance-attribute` ¶

volume_8h_change_percent: float | None = None

volume_24h_usd `class-attribute` `instance-attribute` ¶

volume_24h_usd: float | None = None

volume_24h_change_percent `class-attribute` `instance-attribute` ¶

volume_24h_change_percent: float | None = None

volume_7d_usd `class-attribute` `instance-attribute` ¶

volume_7d_usd: float | None = None

volume_7d_change_percent `class-attribute` `instance-attribute` ¶

volume_7d_change_percent: float | None = None

volume_30d_usd `class-attribute` `instance-attribute` ¶

volume_30d_usd: float | None = None

volume_30d_change_percent `class-attribute` `instance-attribute` ¶

volume_30d_change_percent: float | None = None

trade_1m_count `class-attribute` `instance-attribute` ¶

trade_1m_count: int | None = None

trade_5m_count `class-attribute` `instance-attribute` ¶

trade_5m_count: int | None = None

trade_30m_count `class-attribute` `instance-attribute` ¶

trade_30m_count: int | None = None

trade_1h_count `class-attribute` `instance-attribute` ¶

trade_1h_count: int | None = None

trade_2h_count `class-attribute` `instance-attribute` ¶

trade_2h_count: int | None = None

trade_4h_count `class-attribute` `instance-attribute` ¶

trade_4h_count: int | None = None

trade_8h_count `class-attribute` `instance-attribute` ¶

trade_8h_count: int | None = None

trade_24h_count `class-attribute` `instance-attribute` ¶

trade_24h_count: int | None = None

trade_7d_count `class-attribute` `instance-attribute` ¶

trade_7d_count: int | None = None

trade_30d_count `class-attribute` `instance-attribute` ¶

trade_30d_count: int | None = None

buy_24h `class-attribute` `instance-attribute` ¶

buy_24h: int | None = None

buy_24h_change_percent `class-attribute` `instance-attribute` ¶

buy_24h_change_percent: float | None = None

volume_buy_24h_usd `class-attribute` `instance-attribute` ¶

volume_buy_24h_usd: float | None = None

volume_buy_24h_change_percent `class-attribute` `instance-attribute` ¶

volume_buy_24h_change_percent: float | None = None

buy_7d `class-attribute` `instance-attribute` ¶

buy_7d: int | None = None

buy_7d_change_percent `class-attribute` `instance-attribute` ¶

buy_7d_change_percent: float | None = None

volume_buy_7d_usd `class-attribute` `instance-attribute` ¶

volume_buy_7d_usd: float | None = None

volume_buy_7d_change_percent `class-attribute` `instance-attribute` ¶

volume_buy_7d_change_percent: float | None = None

buy_30d `class-attribute` `instance-attribute` ¶

buy_30d: int | None = None

buy_30d_change_percent `class-attribute` `instance-attribute` ¶

buy_30d_change_percent: float | None = None

volume_buy_30d_usd `class-attribute` `instance-attribute` ¶

volume_buy_30d_usd: float | None = None

volume_buy_30d_change_percent `class-attribute` `instance-attribute` ¶

volume_buy_30d_change_percent: float | None = None

sell_24h `class-attribute` `instance-attribute` ¶

sell_24h: int | None = None

sell_24h_change_percent `class-attribute` `instance-attribute` ¶

sell_24h_change_percent: float | None = None

volume_sell_24h_usd `class-attribute` `instance-attribute` ¶

volume_sell_24h_usd: float | None = None

volume_sell_24h_change_percent `class-attribute` `instance-attribute` ¶

volume_sell_24h_change_percent: float | None = None

sell_7d `class-attribute` `instance-attribute` ¶

sell_7d: int | None = None

sell_7d_change_percent `class-attribute` `instance-attribute` ¶

sell_7d_change_percent: float | None = None

volume_sell_7d_usd `class-attribute` `instance-attribute` ¶

volume_sell_7d_usd: float | None = None

volume_sell_7d_change_percent `class-attribute` `instance-attribute` ¶

volume_sell_7d_change_percent: float | None = None

sell_30d `class-attribute` `instance-attribute` ¶

sell_30d: int | None = None

sell_30d_change_percent `class-attribute` `instance-attribute` ¶

sell_30d_change_percent: float | None = None

volume_sell_30d_usd `class-attribute` `instance-attribute` ¶

volume_sell_30d_usd: float | None = None

volume_sell_30d_change_percent `class-attribute` `instance-attribute` ¶

volume_sell_30d_change_percent: float | None = None

unique_wallet_24h `class-attribute` `instance-attribute` ¶

unique_wallet_24h: int | None = None

unique_wallet_24h_change_percent `class-attribute` `instance-attribute` ¶

unique_wallet_24h_change_percent: float | None = None

price `class-attribute` `instance-attribute` ¶

price: float | None = None

price_change_1m_percent `class-attribute` `instance-attribute` ¶

price_change_1m_percent: float | None = None

price_change_5m_percent `class-attribute` `instance-attribute` ¶

price_change_5m_percent: float | None = None

price_change_30m_percent `class-attribute` `instance-attribute` ¶

price_change_30m_percent: float | None = None

price_change_1h_percent `class-attribute` `instance-attribute` ¶

price_change_1h_percent: float | None = None

price_change_2h_percent `class-attribute` `instance-attribute` ¶

price_change_2h_percent: float | None = None

price_change_4h_percent `class-attribute` `instance-attribute` ¶

price_change_4h_percent: float | None = None

price_change_8h_percent `class-attribute` `instance-attribute` ¶

price_change_8h_percent: float | None = None

price_change_24h_percent `class-attribute` `instance-attribute` ¶

price_change_24h_percent: float | None = None

price_change_7d_percent `class-attribute` `instance-attribute` ¶

price_change_7d_percent: float | None = None

price_change_30d_percent `class-attribute` `instance-attribute` ¶

price_change_30d_percent: float | None = None

holder `class-attribute` `instance-attribute` ¶

holder: int | None = None

recent_listing_time `class-attribute` `instance-attribute` ¶

recent_listing_time: int | None = None

is_scaled_ui_token `class-attribute` `instance-attribute` ¶

is_scaled_ui_token: bool | None = None

multiplier `class-attribute` `instance-attribute` ¶

multiplier: float | None = None

creation_time `class-attribute` `instance-attribute` ¶

creation_time: int | None = None

GetV3TokenListData ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenListData[GetV3TokenListData]

              

              click cyhole.birdeye.schema.GetV3TokenListData href "" "cyhole.birdeye.schema.GetV3TokenListData"

Payload of the v3 Token - List response.

Attributes:

Name	Type	Description
`items`	`list[V3TokenListItem]`	list of token entries matching the request filters.
`has_next`	`bool`	`True` when more pages are available; advance with the next offset (aliased to `hasNext`).

items `instance-attribute` ¶

items: list[V3TokenListItem]

has_next `class-attribute` `instance-attribute` ¶

has_next: bool = Field(alias='hasNext')

GetV3TokenListResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenListResponse[GetV3TokenListResponse]

              

              click cyhole.birdeye.schema.GetV3TokenListResponse href "" "cyhole.birdeye.schema.GetV3TokenListResponse"

Model used to represent the Token - List (V3) endpoint from birdeye API.

Attributes:

Name	Type	Description
`data`	`GetV3TokenListData`	paginated list of token entries.
`success`	`bool`	`True` when the API call completed without errors.

data `instance-attribute` ¶

data: GetV3TokenListData

success `instance-attribute` ¶

success: bool

GetV3TokenListQuery ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenListQuery[GetV3TokenListQuery]

              

              click cyhole.birdeye.schema.GetV3TokenListQuery href "" "cyhole.birdeye.schema.GetV3TokenListQuery"

Query-parameter bag for the v3 Token - List endpoint.

Every filter is optional and only sent when set. The base call returns the top 100 tokens sorted by liquidity descending.

Attributes:

Name	Type	Description
`sort_by`	`str`	metric used to rank the returned tokens. Pick one of the constants on `BirdeyeV3TokenListSortBy`.
`sort_type`	`str`	ascending or descending order. Pick one of the constants on `BirdeyeOrder`.
`offset`	`int`	zero-based pagination offset. Birdeye requires `offset + limit <= 10000`.
`limit`	`int`	number of records to return (1..100).
`min_liquidity`	`float \| None`	inclusive lower bound on token liquidity in USD; `None` to disable the filter.
`max_liquidity`	`float \| None`	inclusive upper bound on token liquidity in USD; `None` to disable the filter.
`min_market_cap`	`float \| None`	inclusive lower bound on market cap in USD; `None` to disable the filter.
`max_market_cap`	`float \| None`	inclusive upper bound on market cap in USD; `None` to disable the filter.
`min_fdv`	`float \| None`	inclusive lower bound on FDV in USD; `None` to disable the filter.
`max_fdv`	`float \| None`	inclusive upper bound on FDV in USD; `None` to disable the filter.
`min_recent_listing_time`	`int \| None`	inclusive lower bound (unix seconds) on the token recent-listing timestamp; `None` to disable the filter.
`max_recent_listing_time`	`int \| None`	inclusive upper bound (unix seconds) on the token recent-listing timestamp; `None` to disable the filter.
`min_last_trade_unix_time`	`int \| None`	inclusive lower bound (unix seconds) on the last-trade timestamp; `None` to disable the filter.
`max_last_trade_unix_time`	`int \| None`	inclusive upper bound (unix seconds) on the last-trade timestamp; `None` to disable the filter.
`min_holder`	`int \| None`	inclusive minimum number of distinct token holders; `None` to disable the filter.
`ui_amount_mode`	`str \| None`	how to format scaled-UI-amount token figures on Solana; pick a `BirdeyeUIAmountMode` member or leave `None` for the server default (`scaled`).
`min_volume_1m_usd`	`float \| None`	inclusive minimum USD volume in the trailing 1m window; `None` to disable the filter.
`min_volume_5m_usd`	`float \| None`	inclusive minimum USD volume in the trailing 5m window; `None` to disable the filter.
`min_volume_30m_usd`	`float \| None`	inclusive minimum USD volume in the trailing 30m window; `None` to disable the filter.
`min_volume_1h_usd`	`float \| None`	inclusive minimum USD volume in the trailing 1h window; `None` to disable the filter.
`min_volume_2h_usd`	`float \| None`	inclusive minimum USD volume in the trailing 2h window; `None` to disable the filter.
`min_volume_4h_usd`	`float \| None`	inclusive minimum USD volume in the trailing 4h window; `None` to disable the filter.
`min_volume_8h_usd`	`float \| None`	inclusive minimum USD volume in the trailing 8h window; `None` to disable the filter.
`min_volume_24h_usd`	`float \| None`	inclusive minimum USD volume in the trailing 24h window; `None` to disable the filter.
`min_volume_7d_usd`	`float \| None`	inclusive minimum USD volume in the trailing 7d window; `None` to disable the filter.
`min_volume_30d_usd`	`float \| None`	inclusive minimum USD volume in the trailing 30d window; `None` to disable the filter.
`min_volume_1m_change_percent`	`float \| None`	inclusive minimum percent change of USD volume between the current and previous 1m windows; `None` to disable the filter.
`min_volume_5m_change_percent`	`float \| None`	inclusive minimum percent change of USD volume between the current and previous 5m windows; `None` to disable the filter.
`min_volume_30m_change_percent`	`float \| None`	inclusive minimum percent change of USD volume between the current and previous 30m windows; `None` to disable the filter.
`min_volume_1h_change_percent`	`float \| None`	inclusive minimum percent change of USD volume between the current and previous 1h windows; `None` to disable the filter.
`min_volume_2h_change_percent`	`float \| None`	inclusive minimum percent change of USD volume between the current and previous 2h windows; `None` to disable the filter.
`min_volume_4h_change_percent`	`float \| None`	inclusive minimum percent change of USD volume between the current and previous 4h windows; `None` to disable the filter.
`min_volume_8h_change_percent`	`float \| None`	inclusive minimum percent change of USD volume between the current and previous 8h windows; `None` to disable the filter.
`min_volume_24h_change_percent`	`float \| None`	inclusive minimum percent change of USD volume between the current and previous 24h windows; `None` to disable the filter.
`min_volume_7d_change_percent`	`float \| None`	inclusive minimum percent change of USD volume between the current and previous 7d windows; `None` to disable the filter.
`min_volume_30d_change_percent`	`float \| None`	inclusive minimum percent change of USD volume between the current and previous 30d windows; `None` to disable the filter.
`min_price_change_1m_percent`	`float \| None`	inclusive minimum percent price change vs the start of the trailing 1m window; `None` to disable the filter.
`min_price_change_5m_percent`	`float \| None`	inclusive minimum percent price change vs the start of the trailing 5m window; `None` to disable the filter.
`min_price_change_30m_percent`	`float \| None`	inclusive minimum percent price change vs the start of the trailing 30m window; `None` to disable the filter.
`min_price_change_1h_percent`	`float \| None`	inclusive minimum percent price change vs the start of the trailing 1h window; `None` to disable the filter.
`min_price_change_2h_percent`	`float \| None`	inclusive minimum percent price change vs the start of the trailing 2h window; `None` to disable the filter.
`min_price_change_4h_percent`	`float \| None`	inclusive minimum percent price change vs the start of the trailing 4h window; `None` to disable the filter.
`min_price_change_8h_percent`	`float \| None`	inclusive minimum percent price change vs the start of the trailing 8h window; `None` to disable the filter.
`min_price_change_24h_percent`	`float \| None`	inclusive minimum percent price change vs the start of the trailing 24h window; `None` to disable the filter.
`min_price_change_7d_percent`	`float \| None`	inclusive minimum percent price change vs the start of the trailing 7d window; `None` to disable the filter.
`min_price_change_30d_percent`	`float \| None`	inclusive minimum percent price change vs the start of the trailing 30d window; `None` to disable the filter.
`min_trade_1m_count`	`int \| None`	inclusive minimum number of trades during the trailing 1m window; `None` to disable the filter.
`min_trade_5m_count`	`int \| None`	inclusive minimum number of trades during the trailing 5m window; `None` to disable the filter.
`min_trade_30m_count`	`int \| None`	inclusive minimum number of trades during the trailing 30m window; `None` to disable the filter.
`min_trade_1h_count`	`int \| None`	inclusive minimum number of trades during the trailing 1h window; `None` to disable the filter.
`min_trade_2h_count`	`int \| None`	inclusive minimum number of trades during the trailing 2h window; `None` to disable the filter.
`min_trade_4h_count`	`int \| None`	inclusive minimum number of trades during the trailing 4h window; `None` to disable the filter.
`min_trade_8h_count`	`int \| None`	inclusive minimum number of trades during the trailing 8h window; `None` to disable the filter.
`min_trade_24h_count`	`int \| None`	inclusive minimum number of trades during the trailing 24h window; `None` to disable the filter.
`min_trade_7d_count`	`int \| None`	inclusive minimum number of trades during the trailing 7d window; `None` to disable the filter.
`min_trade_30d_count`	`int \| None`	inclusive minimum number of trades during the trailing 30d window; `None` to disable the filter.

sort_by `class-attribute` `instance-attribute` ¶

sort_by: str = BirdeyeV3TokenListSortBy.LIQUIDITY.value

sort_type `class-attribute` `instance-attribute` ¶

sort_type: str = BirdeyeOrder.DESCENDING.value

offset `class-attribute` `instance-attribute` ¶

offset: int = 0

limit `class-attribute` `instance-attribute` ¶

limit: int = 100

min_liquidity `class-attribute` `instance-attribute` ¶

min_liquidity: float | None = None

max_liquidity `class-attribute` `instance-attribute` ¶

max_liquidity: float | None = None

min_market_cap `class-attribute` `instance-attribute` ¶

min_market_cap: float | None = None

max_market_cap `class-attribute` `instance-attribute` ¶

max_market_cap: float | None = None

min_fdv `class-attribute` `instance-attribute` ¶

min_fdv: float | None = None

max_fdv `class-attribute` `instance-attribute` ¶

max_fdv: float | None = None

min_recent_listing_time `class-attribute` `instance-attribute` ¶

min_recent_listing_time: int | None = None

max_recent_listing_time `class-attribute` `instance-attribute` ¶

max_recent_listing_time: int | None = None

min_last_trade_unix_time `class-attribute` `instance-attribute` ¶

min_last_trade_unix_time: int | None = None

max_last_trade_unix_time `class-attribute` `instance-attribute` ¶

max_last_trade_unix_time: int | None = None

min_holder `class-attribute` `instance-attribute` ¶

min_holder: int | None = None

ui_amount_mode `class-attribute` `instance-attribute` ¶

ui_amount_mode: str | None = None

min_volume_1m_usd `class-attribute` `instance-attribute` ¶

min_volume_1m_usd: float | None = None

min_volume_5m_usd `class-attribute` `instance-attribute` ¶

min_volume_5m_usd: float | None = None

min_volume_30m_usd `class-attribute` `instance-attribute` ¶

min_volume_30m_usd: float | None = None

min_volume_1h_usd `class-attribute` `instance-attribute` ¶

min_volume_1h_usd: float | None = None

min_volume_2h_usd `class-attribute` `instance-attribute` ¶

min_volume_2h_usd: float | None = None

min_volume_4h_usd `class-attribute` `instance-attribute` ¶

min_volume_4h_usd: float | None = None

min_volume_8h_usd `class-attribute` `instance-attribute` ¶

min_volume_8h_usd: float | None = None

min_volume_24h_usd `class-attribute` `instance-attribute` ¶

min_volume_24h_usd: float | None = None

min_volume_7d_usd `class-attribute` `instance-attribute` ¶

min_volume_7d_usd: float | None = None

min_volume_30d_usd `class-attribute` `instance-attribute` ¶

min_volume_30d_usd: float | None = None

min_volume_1m_change_percent `class-attribute` `instance-attribute` ¶

min_volume_1m_change_percent: float | None = None

min_volume_5m_change_percent `class-attribute` `instance-attribute` ¶

min_volume_5m_change_percent: float | None = None

min_volume_30m_change_percent `class-attribute` `instance-attribute` ¶

min_volume_30m_change_percent: float | None = None

min_volume_1h_change_percent `class-attribute` `instance-attribute` ¶

min_volume_1h_change_percent: float | None = None

min_volume_2h_change_percent `class-attribute` `instance-attribute` ¶

min_volume_2h_change_percent: float | None = None

min_volume_4h_change_percent `class-attribute` `instance-attribute` ¶

min_volume_4h_change_percent: float | None = None

min_volume_8h_change_percent `class-attribute` `instance-attribute` ¶

min_volume_8h_change_percent: float | None = None

min_volume_24h_change_percent `class-attribute` `instance-attribute` ¶

min_volume_24h_change_percent: float | None = None

min_volume_7d_change_percent `class-attribute` `instance-attribute` ¶

min_volume_7d_change_percent: float | None = None

min_volume_30d_change_percent `class-attribute` `instance-attribute` ¶

min_volume_30d_change_percent: float | None = None

min_price_change_1m_percent `class-attribute` `instance-attribute` ¶

min_price_change_1m_percent: float | None = None

min_price_change_5m_percent `class-attribute` `instance-attribute` ¶

min_price_change_5m_percent: float | None = None

min_price_change_30m_percent `class-attribute` `instance-attribute` ¶

min_price_change_30m_percent: float | None = None

min_price_change_1h_percent `class-attribute` `instance-attribute` ¶

min_price_change_1h_percent: float | None = None

min_price_change_2h_percent `class-attribute` `instance-attribute` ¶

min_price_change_2h_percent: float | None = None

min_price_change_4h_percent `class-attribute` `instance-attribute` ¶

min_price_change_4h_percent: float | None = None

min_price_change_8h_percent `class-attribute` `instance-attribute` ¶

min_price_change_8h_percent: float | None = None

min_price_change_24h_percent `class-attribute` `instance-attribute` ¶

min_price_change_24h_percent: float | None = None

min_price_change_7d_percent `class-attribute` `instance-attribute` ¶

min_price_change_7d_percent: float | None = None

min_price_change_30d_percent `class-attribute` `instance-attribute` ¶

min_price_change_30d_percent: float | None = None

min_trade_1m_count `class-attribute` `instance-attribute` ¶

min_trade_1m_count: int | None = None

min_trade_5m_count `class-attribute` `instance-attribute` ¶

min_trade_5m_count: int | None = None

min_trade_30m_count `class-attribute` `instance-attribute` ¶

min_trade_30m_count: int | None = None

min_trade_1h_count `class-attribute` `instance-attribute` ¶

min_trade_1h_count: int | None = None

min_trade_2h_count `class-attribute` `instance-attribute` ¶

min_trade_2h_count: int | None = None

min_trade_4h_count `class-attribute` `instance-attribute` ¶

min_trade_4h_count: int | None = None

min_trade_8h_count `class-attribute` `instance-attribute` ¶

min_trade_8h_count: int | None = None

min_trade_24h_count `class-attribute` `instance-attribute` ¶

min_trade_24h_count: int | None = None

min_trade_7d_count `class-attribute` `instance-attribute` ¶

min_trade_7d_count: int | None = None

min_trade_30d_count `class-attribute` `instance-attribute` ¶

min_trade_30d_count: int | None = None

GetV3TokenListScrollData ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenListScrollData[GetV3TokenListScrollData]

              

              click cyhole.birdeye.schema.GetV3TokenListScrollData href "" "cyhole.birdeye.schema.GetV3TokenListScrollData"

Payload of the v3 Token - List Scroll response.

The scroll endpoint pages results via a server-issued opaque cursor instead of an offset. Pass the returned next_scroll_id back as the scroll_id query parameter on the next call to continue the same scroll session.

Attributes:

Name	Type	Description
`items`	`list[V3TokenListItem]`	list of token entries returned in this batch.
`next_scroll_id`	`str \| None`	opaque cursor to fetch the next batch; `None` (or missing) when no additional batches are available.
`scroll_time`	`str \| None`	server-side scroll session expiration timestamp; `None` (or missing) when not provided by the API.
`has_next`	`bool \| None`	convenience flag indicating whether at least one more batch is available (aliased to `hasNext`); `None` when the API does not include the flag.

items `instance-attribute` ¶

items: list[V3TokenListItem]

next_scroll_id `class-attribute` `instance-attribute` ¶

next_scroll_id: str | None = None

scroll_time `class-attribute` `instance-attribute` ¶

scroll_time: str | None = None

has_next `class-attribute` `instance-attribute` ¶

has_next: bool | None = Field(alias="hasNext", default=None)

GetV3TokenListScrollResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenListScrollResponse[GetV3TokenListScrollResponse]

              

              click cyhole.birdeye.schema.GetV3TokenListScrollResponse href "" "cyhole.birdeye.schema.GetV3TokenListScrollResponse"

Model used to represent the Token - List (V3) Scroll endpoint from birdeye API.

Attributes:

Name	Type	Description
`data`	`GetV3TokenListScrollData`	scroll payload (current batch + cursor metadata).
`success`	`bool`	`True` when the API call completed without errors.

data `instance-attribute` ¶

data: GetV3TokenListScrollData

success `instance-attribute` ¶

success: bool

GetV3TokenListScrollQuery ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenListScrollQuery[GetV3TokenListScrollQuery]

              

              click cyhole.birdeye.schema.GetV3TokenListScrollQuery href "" "cyhole.birdeye.schema.GetV3TokenListScrollQuery"

Query-parameter bag for the v3 Token - List Scroll endpoint.

Pagination is cursor-based: leave scroll_id None for the first call (then any other filter is honoured), and pass back the next_scroll_id value from the previous response on subsequent calls (filters are ignored once scroll_id is set).

Attributes:

Name	Type	Description
`scroll_id`	`str \| None`	cursor returned by a previous scroll response (`next_scroll_id`). When set, all other filters are ignored and Birdeye returns the next page of the original scroll session; `None` to start a fresh scroll. Birdeye limits a given API key to one active scroll per 30 seconds.
`sort_by`	`str`	metric used to rank the returned tokens. Pick one of the constants on `BirdeyeV3TokenListSortBy`.
`sort_type`	`str`	ascending or descending order. Pick one of the constants on `BirdeyeOrder`.
`limit`	`int`	number of records to return per batch (1..5000).
`min_liquidity`	`float \| None`	inclusive lower bound on token liquidity in USD; `None` to disable the filter.
`max_liquidity`	`float \| None`	inclusive upper bound on token liquidity in USD; `None` to disable the filter.
`min_market_cap`	`float \| None`	inclusive lower bound on market cap in USD; `None` to disable the filter.
`max_market_cap`	`float \| None`	inclusive upper bound on market cap in USD; `None` to disable the filter.
`min_fdv`	`float \| None`	inclusive lower bound on FDV in USD; `None` to disable the filter.
`max_fdv`	`float \| None`	inclusive upper bound on FDV in USD; `None` to disable the filter.
`min_recent_listing_time`	`int \| None`	inclusive lower bound (unix seconds) on the token recent-listing timestamp; `None` to disable the filter.
`max_recent_listing_time`	`int \| None`	inclusive upper bound (unix seconds) on the token recent-listing timestamp; `None` to disable the filter.
`min_last_trade_unix_time`	`int \| None`	inclusive lower bound (unix seconds) on the last-trade timestamp; `None` to disable the filter.
`max_last_trade_unix_time`	`int \| None`	inclusive upper bound (unix seconds) on the last-trade timestamp; `None` to disable the filter.
`min_holder`	`int \| None`	inclusive minimum number of distinct token holders; `None` to disable the filter.
`ui_amount_mode`	`str \| None`	how to format scaled-UI-amount token figures on Solana; pick a `BirdeyeUIAmountMode` member or leave `None` for the server default (`scaled`).
`min_volume_1m_usd`	`float \| None`	inclusive minimum USD volume in the trailing 1m window; `None` to disable the filter.
`min_volume_5m_usd`	`float \| None`	inclusive minimum USD volume in the trailing 5m window; `None` to disable the filter.
`min_volume_30m_usd`	`float \| None`	inclusive minimum USD volume in the trailing 30m window; `None` to disable the filter.
`min_volume_1h_usd`	`float \| None`	inclusive minimum USD volume in the trailing 1h window; `None` to disable the filter.
`min_volume_2h_usd`	`float \| None`	inclusive minimum USD volume in the trailing 2h window; `None` to disable the filter.
`min_volume_4h_usd`	`float \| None`	inclusive minimum USD volume in the trailing 4h window; `None` to disable the filter.
`min_volume_8h_usd`	`float \| None`	inclusive minimum USD volume in the trailing 8h window; `None` to disable the filter.
`min_volume_24h_usd`	`float \| None`	inclusive minimum USD volume in the trailing 24h window; `None` to disable the filter.
`min_volume_7d_usd`	`float \| None`	inclusive minimum USD volume in the trailing 7d window; `None` to disable the filter.
`min_volume_30d_usd`	`float \| None`	inclusive minimum USD volume in the trailing 30d window; `None` to disable the filter.
`min_volume_1m_change_percent`	`float \| None`	inclusive minimum percent change of USD volume between the current and previous 1m windows; `None` to disable the filter.
`min_volume_5m_change_percent`	`float \| None`	inclusive minimum percent change of USD volume between the current and previous 5m windows; `None` to disable the filter.
`min_volume_30m_change_percent`	`float \| None`	inclusive minimum percent change of USD volume between the current and previous 30m windows; `None` to disable the filter.
`min_volume_1h_change_percent`	`float \| None`	inclusive minimum percent change of USD volume between the current and previous 1h windows; `None` to disable the filter.
`min_volume_2h_change_percent`	`float \| None`	inclusive minimum percent change of USD volume between the current and previous 2h windows; `None` to disable the filter.
`min_volume_4h_change_percent`	`float \| None`	inclusive minimum percent change of USD volume between the current and previous 4h windows; `None` to disable the filter.
`min_volume_8h_change_percent`	`float \| None`	inclusive minimum percent change of USD volume between the current and previous 8h windows; `None` to disable the filter.
`min_volume_24h_change_percent`	`float \| None`	inclusive minimum percent change of USD volume between the current and previous 24h windows; `None` to disable the filter.
`min_volume_7d_change_percent`	`float \| None`	inclusive minimum percent change of USD volume between the current and previous 7d windows; `None` to disable the filter.
`min_volume_30d_change_percent`	`float \| None`	inclusive minimum percent change of USD volume between the current and previous 30d windows; `None` to disable the filter.
`min_price_change_1m_percent`	`float \| None`	inclusive minimum percent price change vs the start of the trailing 1m window; `None` to disable the filter.
`min_price_change_5m_percent`	`float \| None`	inclusive minimum percent price change vs the start of the trailing 5m window; `None` to disable the filter.
`min_price_change_30m_percent`	`float \| None`	inclusive minimum percent price change vs the start of the trailing 30m window; `None` to disable the filter.
`min_price_change_1h_percent`	`float \| None`	inclusive minimum percent price change vs the start of the trailing 1h window; `None` to disable the filter.
`min_price_change_2h_percent`	`float \| None`	inclusive minimum percent price change vs the start of the trailing 2h window; `None` to disable the filter.
`min_price_change_4h_percent`	`float \| None`	inclusive minimum percent price change vs the start of the trailing 4h window; `None` to disable the filter.
`min_price_change_8h_percent`	`float \| None`	inclusive minimum percent price change vs the start of the trailing 8h window; `None` to disable the filter.
`min_price_change_24h_percent`	`float \| None`	inclusive minimum percent price change vs the start of the trailing 24h window; `None` to disable the filter.
`min_price_change_7d_percent`	`float \| None`	inclusive minimum percent price change vs the start of the trailing 7d window; `None` to disable the filter.
`min_price_change_30d_percent`	`float \| None`	inclusive minimum percent price change vs the start of the trailing 30d window; `None` to disable the filter.
`min_trade_1m_count`	`int \| None`	inclusive minimum number of trades during the trailing 1m window; `None` to disable the filter.
`min_trade_5m_count`	`int \| None`	inclusive minimum number of trades during the trailing 5m window; `None` to disable the filter.
`min_trade_30m_count`	`int \| None`	inclusive minimum number of trades during the trailing 30m window; `None` to disable the filter.
`min_trade_1h_count`	`int \| None`	inclusive minimum number of trades during the trailing 1h window; `None` to disable the filter.
`min_trade_2h_count`	`int \| None`	inclusive minimum number of trades during the trailing 2h window; `None` to disable the filter.
`min_trade_4h_count`	`int \| None`	inclusive minimum number of trades during the trailing 4h window; `None` to disable the filter.
`min_trade_8h_count`	`int \| None`	inclusive minimum number of trades during the trailing 8h window; `None` to disable the filter.
`min_trade_24h_count`	`int \| None`	inclusive minimum number of trades during the trailing 24h window; `None` to disable the filter.
`min_trade_7d_count`	`int \| None`	inclusive minimum number of trades during the trailing 7d window; `None` to disable the filter.
`min_trade_30d_count`	`int \| None`	inclusive minimum number of trades during the trailing 30d window; `None` to disable the filter.

scroll_id `class-attribute` `instance-attribute` ¶

scroll_id: str | None = None

sort_by `class-attribute` `instance-attribute` ¶

sort_by: str = BirdeyeV3TokenListSortBy.LIQUIDITY.value

sort_type `class-attribute` `instance-attribute` ¶

sort_type: str = BirdeyeOrder.DESCENDING.value

limit `class-attribute` `instance-attribute` ¶

limit: int = 5000

min_liquidity `class-attribute` `instance-attribute` ¶

min_liquidity: float | None = None

max_liquidity `class-attribute` `instance-attribute` ¶

max_liquidity: float | None = None

min_market_cap `class-attribute` `instance-attribute` ¶

min_market_cap: float | None = None

max_market_cap `class-attribute` `instance-attribute` ¶

max_market_cap: float | None = None

min_fdv `class-attribute` `instance-attribute` ¶

min_fdv: float | None = None

max_fdv `class-attribute` `instance-attribute` ¶

max_fdv: float | None = None

min_recent_listing_time `class-attribute` `instance-attribute` ¶

min_recent_listing_time: int | None = None

max_recent_listing_time `class-attribute` `instance-attribute` ¶

max_recent_listing_time: int | None = None

min_last_trade_unix_time `class-attribute` `instance-attribute` ¶

min_last_trade_unix_time: int | None = None

max_last_trade_unix_time `class-attribute` `instance-attribute` ¶

max_last_trade_unix_time: int | None = None

min_holder `class-attribute` `instance-attribute` ¶

min_holder: int | None = None

ui_amount_mode `class-attribute` `instance-attribute` ¶

ui_amount_mode: str | None = None

min_volume_1m_usd `class-attribute` `instance-attribute` ¶

min_volume_1m_usd: float | None = None

min_volume_5m_usd `class-attribute` `instance-attribute` ¶

min_volume_5m_usd: float | None = None

min_volume_30m_usd `class-attribute` `instance-attribute` ¶

min_volume_30m_usd: float | None = None

min_volume_1h_usd `class-attribute` `instance-attribute` ¶

min_volume_1h_usd: float | None = None

min_volume_2h_usd `class-attribute` `instance-attribute` ¶

min_volume_2h_usd: float | None = None

min_volume_4h_usd `class-attribute` `instance-attribute` ¶

min_volume_4h_usd: float | None = None

min_volume_8h_usd `class-attribute` `instance-attribute` ¶

min_volume_8h_usd: float | None = None

min_volume_24h_usd `class-attribute` `instance-attribute` ¶

min_volume_24h_usd: float | None = None

min_volume_7d_usd `class-attribute` `instance-attribute` ¶

min_volume_7d_usd: float | None = None

min_volume_30d_usd `class-attribute` `instance-attribute` ¶

min_volume_30d_usd: float | None = None

min_volume_1m_change_percent `class-attribute` `instance-attribute` ¶

min_volume_1m_change_percent: float | None = None

min_volume_5m_change_percent `class-attribute` `instance-attribute` ¶

min_volume_5m_change_percent: float | None = None

min_volume_30m_change_percent `class-attribute` `instance-attribute` ¶

min_volume_30m_change_percent: float | None = None

min_volume_1h_change_percent `class-attribute` `instance-attribute` ¶

min_volume_1h_change_percent: float | None = None

min_volume_2h_change_percent `class-attribute` `instance-attribute` ¶

min_volume_2h_change_percent: float | None = None

min_volume_4h_change_percent `class-attribute` `instance-attribute` ¶

min_volume_4h_change_percent: float | None = None

min_volume_8h_change_percent `class-attribute` `instance-attribute` ¶

min_volume_8h_change_percent: float | None = None

min_volume_24h_change_percent `class-attribute` `instance-attribute` ¶

min_volume_24h_change_percent: float | None = None

min_volume_7d_change_percent `class-attribute` `instance-attribute` ¶

min_volume_7d_change_percent: float | None = None

min_volume_30d_change_percent `class-attribute` `instance-attribute` ¶

min_volume_30d_change_percent: float | None = None

min_price_change_1m_percent `class-attribute` `instance-attribute` ¶

min_price_change_1m_percent: float | None = None

min_price_change_5m_percent `class-attribute` `instance-attribute` ¶

min_price_change_5m_percent: float | None = None

min_price_change_30m_percent `class-attribute` `instance-attribute` ¶

min_price_change_30m_percent: float | None = None

min_price_change_1h_percent `class-attribute` `instance-attribute` ¶

min_price_change_1h_percent: float | None = None

min_price_change_2h_percent `class-attribute` `instance-attribute` ¶

min_price_change_2h_percent: float | None = None

min_price_change_4h_percent `class-attribute` `instance-attribute` ¶

min_price_change_4h_percent: float | None = None

min_price_change_8h_percent `class-attribute` `instance-attribute` ¶

min_price_change_8h_percent: float | None = None

min_price_change_24h_percent `class-attribute` `instance-attribute` ¶

min_price_change_24h_percent: float | None = None

min_price_change_7d_percent `class-attribute` `instance-attribute` ¶

min_price_change_7d_percent: float | None = None

min_price_change_30d_percent `class-attribute` `instance-attribute` ¶

min_price_change_30d_percent: float | None = None

min_trade_1m_count `class-attribute` `instance-attribute` ¶

min_trade_1m_count: int | None = None

min_trade_5m_count `class-attribute` `instance-attribute` ¶

min_trade_5m_count: int | None = None

min_trade_30m_count `class-attribute` `instance-attribute` ¶

min_trade_30m_count: int | None = None

min_trade_1h_count `class-attribute` `instance-attribute` ¶

min_trade_1h_count: int | None = None

min_trade_2h_count `class-attribute` `instance-attribute` ¶

min_trade_2h_count: int | None = None

min_trade_4h_count `class-attribute` `instance-attribute` ¶

min_trade_4h_count: int | None = None

min_trade_8h_count `class-attribute` `instance-attribute` ¶

min_trade_8h_count: int | None = None

min_trade_24h_count `class-attribute` `instance-attribute` ¶

min_trade_24h_count: int | None = None

min_trade_7d_count `class-attribute` `instance-attribute` ¶

min_trade_7d_count: int | None = None

min_trade_30d_count `class-attribute` `instance-attribute` ¶

min_trade_30d_count: int | None = None

GetV2TokensNewListingItem ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV2TokensNewListingItem[GetV2TokensNewListingItem]

              

              click cyhole.birdeye.schema.GetV2TokensNewListingItem href "" "cyhole.birdeye.schema.GetV2TokensNewListingItem"

Single newly-listed token entry returned by the v2 Token - New Listing endpoint.

Attributes:

Name	Type	Description
`address`	`str`	contract address of the freshly listed token on the selected chain.
`symbol`	`str`	ticker symbol of the token.
`name`	`str`	human-readable name of the token.
`decimals`	`int`	number of decimal places used by the token.
`source`	`str`	name of the venue (DEX/aggregator) Birdeye picked up the listing from.
`liquidity_added_at`	`str`	ISO-8601 timestamp of the listing event (alias `liquidityAddedAt`).
`logo_uri`	`str \| None`	URL of the token logo (alias `logoURI`); `None` if Birdeye has no logo for the token.
`liquidity`	`float`	total liquidity of the token at listing time, expressed in USD.

address `instance-attribute` ¶

address: str

symbol `instance-attribute` ¶

symbol: str

name `instance-attribute` ¶

name: str

decimals `instance-attribute` ¶

decimals: int

source `instance-attribute` ¶

source: str

liquidity_added_at `class-attribute` `instance-attribute` ¶

liquidity_added_at: str = Field(alias='liquidityAddedAt')

logo_uri `class-attribute` `instance-attribute` ¶

logo_uri: str | None = Field(alias='logoURI', default=None)

liquidity `instance-attribute` ¶

liquidity: float

GetV2TokensNewListingData ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV2TokensNewListingData[GetV2TokensNewListingData]

              

              click cyhole.birdeye.schema.GetV2TokensNewListingData href "" "cyhole.birdeye.schema.GetV2TokensNewListingData"

Payload of the v2 Token - New Listing response.

Attributes:

Name	Type	Description
`items`	`list[GetV2TokensNewListingItem]`	list of newly-listed tokens, ordered most-recent-first.

items `instance-attribute` ¶

items: list[GetV2TokensNewListingItem]

GetV2TokensNewListingResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV2TokensNewListingResponse[GetV2TokensNewListingResponse]

              

              click cyhole.birdeye.schema.GetV2TokensNewListingResponse href "" "cyhole.birdeye.schema.GetV2TokensNewListingResponse"

Model used to represent the Token - New Listing endpoint from birdeye API.

Attributes:

Name	Type	Description
`data`	`GetV2TokensNewListingData`	payload containing the list of newly-listed tokens.
`success`	`bool`	`True` when the API call completed without errors.

data `instance-attribute` ¶

data: GetV2TokensNewListingData

success `instance-attribute` ¶

success: bool

GetV2MarketsTokenSide ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV2MarketsTokenSide[GetV2MarketsTokenSide]

              

              click cyhole.birdeye.schema.GetV2MarketsTokenSide href "" "cyhole.birdeye.schema.GetV2MarketsTokenSide"

Identity of one side (base or quote) of a market returned by the v2 Token - All Market List endpoint.

Attributes:

Name	Type	Description
`address`	`str`	contract address of the token making up this side of the market.
`decimals`	`int`	number of decimal places used by the token.
`symbol`	`str \| None`	ticker symbol of the token; `None` if Birdeye does not know it.
`icon`	`str \| None`	URL of the token logo; `None` if Birdeye does not have a logo for the token.

address `instance-attribute` ¶

address: str

decimals `instance-attribute` ¶

decimals: int

symbol `class-attribute` `instance-attribute` ¶

symbol: str | None = None

icon `class-attribute` `instance-attribute` ¶

icon: str | None = None

GetV2MarketsItem ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV2MarketsItem[GetV2MarketsItem]

              

              click cyhole.birdeye.schema.GetV2MarketsItem href "" "cyhole.birdeye.schema.GetV2MarketsItem"

Single market (trading pair) entry returned by the v2 Token - All Market List endpoint.

Attributes:

Name	Type	Description
`address`	`str`	on-chain address of the market/pool.
`base`	`GetV2MarketsTokenSide`	identity of the base side of the market.
`quote`	`GetV2MarketsTokenSide`	identity of the quote side of the market.
`created_at`	`str`	ISO-8601 timestamp at which Birdeye first observed the market (alias `createdAt`).
`liquidity`	`float`	total liquidity of the market in USD.
`name`	`str`	human-readable market name (e.g. `JitoSOL-SOL`).
`price`	`float \| None`	current price of the market quoted in USD; `None` when Birdeye cannot compute it.
`source`	`str`	name of the venue (DEX/aggregator) that hosts the market.
`trade_24h`	`int`	total number of trades on the market during the trailing 24h window (alias `trade24h`).
`trade_24h_change_percent`	`float`	percent change of the 24h trade count vs the previous 24h window (alias `trade24hChangePercent`).
`unique_wallet_24h`	`int`	number of unique wallets that traded the market in the trailing 24h window (alias `uniqueWallet24h`).
`unique_wallet_24h_change_percent`	`float`	percent change of unique wallets vs the previous 24h window (alias `uniqueWallet24hChangePercent`).
`volume_24h`	`float`	traded volume during the trailing 24h window expressed in USD (alias `volume24h`).

address `instance-attribute` ¶

address: str

base `instance-attribute` ¶

base: GetV2MarketsTokenSide

quote `instance-attribute` ¶

quote: GetV2MarketsTokenSide

created_at `class-attribute` `instance-attribute` ¶

created_at: str = Field(alias='createdAt')

liquidity `instance-attribute` ¶

liquidity: float

name `instance-attribute` ¶

name: str

price `class-attribute` `instance-attribute` ¶

price: float | None = None

source `instance-attribute` ¶

source: str

trade_24h `class-attribute` `instance-attribute` ¶

trade_24h: int = Field(alias='trade24h')

trade_24h_change_percent `class-attribute` `instance-attribute` ¶

trade_24h_change_percent: float = Field(
    alias="trade24hChangePercent"
)

unique_wallet_24h `class-attribute` `instance-attribute` ¶

unique_wallet_24h: int = Field(alias='uniqueWallet24h')

unique_wallet_24h_change_percent `class-attribute` `instance-attribute` ¶

unique_wallet_24h_change_percent: float = Field(
    alias="uniqueWallet24hChangePercent"
)

volume_24h `class-attribute` `instance-attribute` ¶

volume_24h: float = Field(alias='volume24h')

GetV2MarketsData ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV2MarketsData[GetV2MarketsData]

              

              click cyhole.birdeye.schema.GetV2MarketsData href "" "cyhole.birdeye.schema.GetV2MarketsData"

Payload of the v2 Token - All Market List response.

Attributes:

Name	Type	Description
`total`	`int`	total number of markets known to Birdeye for the requested token.
`items`	`list[GetV2MarketsItem]`	paginated list of markets matching the request, ranked per `sort_by` / `sort_type`.

total `instance-attribute` ¶

total: int

items `instance-attribute` ¶

items: list[GetV2MarketsItem]

GetV2MarketsResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV2MarketsResponse[GetV2MarketsResponse]

              

              click cyhole.birdeye.schema.GetV2MarketsResponse href "" "cyhole.birdeye.schema.GetV2MarketsResponse"

Model used to represent the Token - All Market List endpoint from birdeye API.

Attributes:

Name	Type	Description
`data`	`GetV2MarketsData`	paginated list of markets for the requested token.
`success`	`bool`	`True` when the API call completed without errors.

data `instance-attribute` ¶

data: GetV2MarketsData

success `instance-attribute` ¶

success: bool

GetV2TopTradersItem ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV2TopTradersItem[GetV2TopTradersItem]

              

              click cyhole.birdeye.schema.GetV2TopTradersItem href "" "cyhole.birdeye.schema.GetV2TopTradersItem"

Single trader entry returned by the v2 Token - Top Traders endpoint.

Numeric fields with pnl in their name and volume_usd are only meaningful on the Solana chain — on other chains Birdeye returns them but they may be 0 or unreliable.

Attributes:

Name	Type	Description
`token_address`	`str`	contract address of the token the trader has been ranked for (alias `tokenAddress`).
`owner`	`str`	on-chain wallet address of the trader.
`type`	`str`	time frame the metrics in this entry refer to (mirrors the request `time_frame`).
`tags`	`list[str]`	list of optional Birdeye tags attached to the wallet (e.g. `whale`, `bot`); empty when no tags are assigned.
`trade`	`int`	total number of trades the wallet executed on the token within the time frame.
`trade_buy`	`int`	number of buy trades within the time frame (alias `tradeBuy`).
`trade_sell`	`int`	number of sell trades within the time frame (alias `tradeSell`).
`volume`	`float`	total traded volume in the token's UI units.
`volume_buy`	`float`	buy-side traded volume in the token's UI units (alias `volumeBuy`).
`volume_sell`	`float`	sell-side traded volume in the token's UI units (alias `volumeSell`).
`volume_usd`	`float`	total traded volume expressed in USD (alias `volumeUsd`).
`volume_buy_usd`	`float`	buy-side traded volume expressed in USD (alias `volumeBuyUSD`).
`volume_sell_usd`	`float`	sell-side traded volume expressed in USD (alias `volumeSellUSD`).
`total_pnl`	`float`	total profit-and-loss of the wallet on the token over the time frame, in USD (alias `totalPnl`); Solana-only, may be `0` on other chains.
`realized_pnl`	`float`	realised profit-and-loss in USD (alias `realizedPnl`); Solana-only.
`unrealized_pnl`	`float`	unrealised profit-and-loss in USD (alias `unrealizedPnl`); Solana-only.
`is_scaled_ui_token`	`bool \| None`	`True` when the underlying token is a scaled-UI-amount SPL token (Solana only) (alias `isScaledUiToken`); `None` outside Solana or undetermined.
`multiplier`	`float \| None`	scaling multiplier applied to UI amounts for scaled-UI-amount tokens; `None` when not applicable.

token_address `class-attribute` `instance-attribute` ¶

token_address: str = Field(alias='tokenAddress')

owner `instance-attribute` ¶

owner: str

type `instance-attribute` ¶

type: str

tags `class-attribute` `instance-attribute` ¶

tags: list[str] = []

trade `instance-attribute` ¶

trade: int

trade_buy `class-attribute` `instance-attribute` ¶

trade_buy: int = Field(alias='tradeBuy')

trade_sell `class-attribute` `instance-attribute` ¶

trade_sell: int = Field(alias='tradeSell')

volume `instance-attribute` ¶

volume: float

volume_buy `class-attribute` `instance-attribute` ¶

volume_buy: float = Field(alias='volumeBuy')

volume_sell `class-attribute` `instance-attribute` ¶

volume_sell: float = Field(alias='volumeSell')

volume_usd `class-attribute` `instance-attribute` ¶

volume_usd: float = Field(alias='volumeUsd')

volume_buy_usd `class-attribute` `instance-attribute` ¶

volume_buy_usd: float = Field(alias='volumeBuyUSD')

volume_sell_usd `class-attribute` `instance-attribute` ¶

volume_sell_usd: float = Field(alias='volumeSellUSD')

total_pnl `class-attribute` `instance-attribute` ¶

total_pnl: float = Field(alias='totalPnl')

realized_pnl `class-attribute` `instance-attribute` ¶

realized_pnl: float = Field(alias='realizedPnl')

unrealized_pnl `class-attribute` `instance-attribute` ¶

unrealized_pnl: float = Field(alias='unrealizedPnl')

is_scaled_ui_token `class-attribute` `instance-attribute` ¶

is_scaled_ui_token: bool | None = Field(
    alias="isScaledUiToken", default=None
)

multiplier `class-attribute` `instance-attribute` ¶

multiplier: float | None = None

GetV2TopTradersData ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV2TopTradersData[GetV2TopTradersData]

              

              click cyhole.birdeye.schema.GetV2TopTradersData href "" "cyhole.birdeye.schema.GetV2TopTradersData"

Payload of the v2 Token - Top Traders response.

Attributes:

Name	Type	Description
`items`	`list[GetV2TopTradersItem]`	ranked list of trader entries matching the request.

items `instance-attribute` ¶

items: list[GetV2TopTradersItem]

GetV2TopTradersResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV2TopTradersResponse[GetV2TopTradersResponse]

              

              click cyhole.birdeye.schema.GetV2TopTradersResponse href "" "cyhole.birdeye.schema.GetV2TopTradersResponse"

Model used to represent the Token - Top Traders endpoint from birdeye API.

Attributes:

Name	Type	Description
`data`	`GetV2TopTradersData`	payload containing the ranked trader list.
`success`	`bool`	`True` when the API call completed without errors.

data `instance-attribute` ¶

data: GetV2TopTradersData

success `instance-attribute` ¶

success: bool

GetTokenSecurityDataSolana ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetTokenSecurityDataSolana[GetTokenSecurityDataSolana]

              

              click cyhole.birdeye.schema.GetTokenSecurityDataSolana href "" "cyhole.birdeye.schema.GetTokenSecurityDataSolana"

Solana-specific security/risk profile of a token returned by the Birdeye Token - Security endpoint.

All ownership and authority fields are optional because Birdeye returns null for them when the token has renounced/cleared the corresponding on-chain authority. Balance and percentage fields refer to the holdings of the related authority over the token's total supply.

Attributes:

Name	Type	Description
`creator_address`	`str \| None`	address that created the token (alias `creatorAddress`); `None` if unknown.
`creator_owner_address`	`str \| None`	owner of `creator_address` at the time of token creation (alias `creatorOwnerAddress`); `None` if the creator was an EOA or no longer tracked.
`owner_address`	`str \| None`	current on-chain owner of the token authority (alias `ownerAddress`); `None` when ownership has been renounced.
`owner_of_owner_address`	`str \| None`	owner of `owner_address` (alias `ownerOfOwnerAddress`); `None` if owner is an EOA or ownership has been renounced.
`creation_transaction`	`str \| None`	signature of the transaction that created the token (alias `creationTx`); `None` if unknown.
`creation_time_unix`	`int \| None`	unix-second timestamp of the creation transaction (alias `creationTime`).
`creation_slot`	`int \| None`	slot of the creation transaction (alias `creationSlot`).
`mint_transaction`	`str \| None`	signature of the mint transaction (alias `mintTx`).
`mint_time_unix`	`int \| None`	unix-second timestamp of the mint transaction (alias `mintTime`).
`mint_slot`	`int \| None`	slot of the mint transaction (alias `mintSlot`).
`mintable`	`bool \| None`	whether the token can still be minted; `None` if the API cannot determine it.
`renounce`	`bool \| None`	whether the mint authority has been renounced; `None` if undetermined.
`creator_balance`	`float \| None`	token balance currently held by the creator address (alias `creatorBalance`).
`creator_percentage`	`float \| None`	creator balance expressed as a fraction (0..1) of total supply (alias `creatorPercentage`).
`owner_balance`	`float \| None`	token balance currently held by the owner address (alias `ownerBalance`).
`owner_percentage`	`float \| None`	owner balance expressed as a fraction (0..1) of total supply (alias `ownerPercentage`).
`metaplex_update_authority`	`str`	Metaplex metadata update authority (alias `metaplexUpdateAuthority`).
`metaplex_owner_update_authority`	`str \| None`	owner of the Metaplex update authority address (alias `metaplexOwnerUpdateAuthority`); `None` when no upstream owner is tracked.
`metaplex_update_balance`	`float`	token balance held by the Metaplex update authority (alias `metaplexUpdateAuthorityBalance`).
`metaplex_update_percentage`	`float`	Metaplex update authority balance expressed as a fraction (0..1) of total supply (alias `metaplexUpdateAuthorityPercent`).
`mutable_metadata`	`bool`	whether the on-chain Metaplex metadata of the token is still mutable (alias `mutableMetadata`).
`top_10_holder_balance`	`float`	cumulative token balance of the top-10 holders (alias `top10HolderBalance`).
`top_10_holder_percentage`	`float`	top-10 holders' cumulative balance as a fraction (0..1) of total supply (alias `top10HolderPercent`).
`top_10_user_balance`	`float`	cumulative token balance of the top-10 user wallets (excluding programs) (alias `top10UserBalance`).
`top_10_user_percentage`	`float`	top-10 users' cumulative balance as a fraction (0..1) of total supply (alias `top10UserPercent`).
`is_true_token`	`bool \| None`	Birdeye flag marking the token as one of its verified entries (alias `isTrueToken`); `None` when unverified.
`fake_token`	`bool \| None`	Birdeye flag marking the token as a known scam/fake (alias `fakeToken`); `None` when Birdeye has not categorised it.
`total_supply`	`float`	total on-chain supply of the token, expressed in UI units (alias `totalSupply`).
`pre_market_holder`	`list[str]`	list of addresses that received tokens before any public market existed (alias `preMarketHolder`).
`lock_info`	`Any \| None`	free-form payload describing on-chain locks (e.g. team vesting); `None` when no lock information is known (alias `lockInfo`).
`freezeable`	`bool \| None`	whether the SPL freeze authority can still freeze accounts; `None` if undetermined.
`freeze_authority`	`str \| None`	address that owns the freeze authority (alias `freezeAuthority`); `None` when the freeze authority has been renounced.
`transfer_fee_enable`	`bool \| None`	whether the Token-2022 transfer-fee extension is active (alias `transferFeeEnable`); `None` if the extension is absent or undetermined.
`transfer_fee_data`	`Any \| None`	free-form payload describing the active transfer-fee parameters (alias `transferFeeData`); `None` when no fee data is available.
`is_token_2022`	`bool`	whether the token is an SPL Token-2022 mint (alias `isToken2022`).
`non_transferable`	`bool \| None`	whether the Token-2022 non-transferable extension is active (alias `nonTransferable`); `None` if undetermined.
`jup_strict_list`	`bool \| None`	whether the token is part of Jupiter's strict token list (alias `jupStrictList`); `None` when Birdeye did not populate the flag.

creator_address `class-attribute` `instance-attribute` ¶

creator_address: str | None = Field(
    alias="creatorAddress", default=None
)

creator_owner_address `class-attribute` `instance-attribute` ¶

creator_owner_address: str | None = Field(
    alias="creatorOwnerAddress", default=None
)

owner_address `class-attribute` `instance-attribute` ¶

owner_address: str | None = Field(
    alias="ownerAddress", default=None
)

owner_of_owner_address `class-attribute` `instance-attribute` ¶

owner_of_owner_address: str | None = Field(
    alias="ownerOfOwnerAddress", default=None
)

creation_transaction `class-attribute` `instance-attribute` ¶

creation_transaction: str | None = Field(
    alias="creationTx", default=None
)

creation_time_unix `class-attribute` `instance-attribute` ¶

creation_time_unix: int | None = Field(
    alias="creationTime", default=None
)

creation_slot `class-attribute` `instance-attribute` ¶

creation_slot: int | None = Field(
    alias="creationSlot", default=None
)

mint_transaction `class-attribute` `instance-attribute` ¶

mint_transaction: str | None = Field(
    alias="mintTx", default=None
)

mint_time_unix `class-attribute` `instance-attribute` ¶

mint_time_unix: int | None = Field(
    alias="mintTime", default=None
)

mint_slot `class-attribute` `instance-attribute` ¶

mint_slot: int | None = Field(
    alias="mintSlot", default=None
)

mintable `class-attribute` `instance-attribute` ¶

mintable: bool | None = None

renounce `class-attribute` `instance-attribute` ¶

renounce: bool | None = None

creator_balance `class-attribute` `instance-attribute` ¶

creator_balance: float | None = Field(
    alias="creatorBalance", default=None
)

creator_percentage `class-attribute` `instance-attribute` ¶

creator_percentage: float | None = Field(
    alias="creatorPercentage", default=None
)

owner_balance `class-attribute` `instance-attribute` ¶

owner_balance: float | None = Field(
    alias="ownerBalance", default=None
)

owner_percentage `class-attribute` `instance-attribute` ¶

owner_percentage: float | None = Field(
    alias="ownerPercentage", default=None
)

metaplex_update_authority `class-attribute` `instance-attribute` ¶

metaplex_update_authority: str = Field(
    alias="metaplexUpdateAuthority"
)

metaplex_owner_update_authority `class-attribute` `instance-attribute` ¶

metaplex_owner_update_authority: str | None = Field(
    alias="metaplexOwnerUpdateAuthority", default=None
)

metaplex_update_balance `class-attribute` `instance-attribute` ¶

metaplex_update_balance: float = Field(
    alias="metaplexUpdateAuthorityBalance"
)

metaplex_update_percentage `class-attribute` `instance-attribute` ¶

metaplex_update_percentage: float = Field(
    alias="metaplexUpdateAuthorityPercent"
)

mutable_metadata `class-attribute` `instance-attribute` ¶

mutable_metadata: bool = Field(alias='mutableMetadata')

top_10_holder_balance `class-attribute` `instance-attribute` ¶

top_10_holder_balance: float = Field(
    alias="top10HolderBalance"
)

top_10_holder_percentage `class-attribute` `instance-attribute` ¶

top_10_holder_percentage: float = Field(
    alias="top10HolderPercent"
)

top_10_user_balance `class-attribute` `instance-attribute` ¶

top_10_user_balance: float = Field(alias="top10UserBalance")

top_10_user_percentage `class-attribute` `instance-attribute` ¶

top_10_user_percentage: float = Field(
    alias="top10UserPercent"
)

is_true_token `class-attribute` `instance-attribute` ¶

is_true_token: bool | None = Field(
    alias="isTrueToken", default=None
)

fake_token `class-attribute` `instance-attribute` ¶

fake_token: bool | None = Field(
    alias="fakeToken", default=None
)

total_supply `class-attribute` `instance-attribute` ¶

total_supply: float = Field(alias='totalSupply')

pre_market_holder `class-attribute` `instance-attribute` ¶

pre_market_holder: list[str] = Field(
    alias="preMarketHolder"
)

lock_info `class-attribute` `instance-attribute` ¶

lock_info: Any | None = Field(
    alias="lockInfo", default=None
)

freezeable `class-attribute` `instance-attribute` ¶

freezeable: bool | None = None

freeze_authority `class-attribute` `instance-attribute` ¶

freeze_authority: str | None = Field(
    alias="freezeAuthority", default=None
)

transfer_fee_enable `class-attribute` `instance-attribute` ¶

transfer_fee_enable: bool | None = Field(
    alias="transferFeeEnable", default=None
)

transfer_fee_data `class-attribute` `instance-attribute` ¶

transfer_fee_data: Any | None = Field(
    alias="transferFeeData", default=None
)

is_token_2022 `class-attribute` `instance-attribute` ¶

is_token_2022: bool = Field(alias='isToken2022')

non_transferable `class-attribute` `instance-attribute` ¶

non_transferable: bool | None = Field(
    alias="nonTransferable", default=None
)

jup_strict_list `class-attribute` `instance-attribute` ¶

jup_strict_list: bool | None = Field(
    alias="jupStrictList", default=None
)

GetTokenSecurityResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetTokenSecurityResponse[GetTokenSecurityResponse]

              

              click cyhole.birdeye.schema.GetTokenSecurityResponse href "" "cyhole.birdeye.schema.GetTokenSecurityResponse"

Model used to represent the Token - Security endpoint from birdeye API.

Attributes:

Name	Type	Description
`data`	`GetTokenSecurityDataSolana \| dict[str, Any]`	security profile of the token. When the request targets Solana the payload is parsed into the typed `GetTokenSecurityDataSolana` schema; for every other supported chain the payload is left as a free-form dictionary because Birdeye returns a chain-specific (EVM-style) shape.
`success`	`bool`	`True` when the API call completed without errors.

data `instance-attribute` ¶

data: GetTokenSecurityDataSolana | dict[str, Any]

success `instance-attribute` ¶

success: bool

GetTokenOverviewData ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetTokenOverviewData[GetTokenOverviewData]

              

              click cyhole.birdeye.schema.GetTokenOverviewData href "" "cyhole.birdeye.schema.GetTokenOverviewData"

Token-level analytics payload returned by the Birdeye Token - Overview endpoint.

The payload bundles identity (address, symbol, name, social links), pricing (current price plus history snapshots at 1m, 5m, 30m, 1h, 2h, 4h, 6h, 8h, 12h and 24h), liquidity, supply (total, circulating, number of holders), unique-wallet counts and per-side trade activity (sell, buy, volume both in token UI units and USD) for the trailing 1m, 5m, 30m, 1h, 2h, 4h, 8h and 24h windows. For every activity window Birdeye also returns the equivalent metric over the immediately preceding window (the *_history fields) and a precomputed percent change between the two.

Attributes:

Name	Type	Description
`address`	`str`	contract address of the token.
`decimals`	`int`	number of decimal places used by the token.
`symbol`	`str`	ticker symbol of the token.
`name`	`str`	human-readable name of the token.
`market_cap`	`float \| None`	current market capitalisation of the token in USD; `None` when Birdeye cannot compute it. (alias `marketCap`)
`fdv`	`float \| None`	fully-diluted valuation of the token in USD; `None` when Birdeye cannot compute it.
`extensions`	`dict[str, str \| None] \| None`	free-form dictionary of optional metadata (CoinGecko id, website, social links, etc.); individual values may be `None`, and the whole dict can be `None` when Birdeye has no extra metadata for the token.
`logo_uri`	`str \| None`	URL of the token logo; `None` if Birdeye does not have a logo for the token. (alias `logoURI`)
`liquidity`	`float`	total on-chain liquidity of the token expressed in USD.
`last_trade_unix_time`	`int`	unix-second timestamp of the last observed trade involving the token. (alias `lastTradeUnixTime`)
`last_trade_human_time`	`datetime`	ISO-8601 timestamp of the last observed trade involving the token. (alias `lastTradeHumanTime`)
`price`	`float`	latest known price of the token expressed in USD.
`history_1m_price`	`float \| None`	snapshot price of the token in USD at the start of the trailing 1m window; `None` if the API has no price datapoint for the start of that window. (alias `history1mPrice`)
`price_change_1m_percent`	`float \| None`	price change versus the start of the trailing 1m window, expressed in percent; `None` if the change cannot be computed. (alias `priceChange1mPercent`)
`history_5m_price`	`float \| None`	snapshot price of the token in USD at the start of the trailing 5m window; `None` if the API has no price datapoint for the start of that window. (alias `history5mPrice`)
`price_change_5m_percent`	`float \| None`	price change versus the start of the trailing 5m window, expressed in percent; `None` if the change cannot be computed. (alias `priceChange5mPercent`)
`history_30m_price`	`float \| None`	snapshot price of the token in USD at the start of the trailing 30m window; `None` if the API has no price datapoint for the start of that window. (alias `history30mPrice`)
`price_change_30m_percent`	`float \| None`	price change versus the start of the trailing 30m window, expressed in percent; `None` if the change cannot be computed. (alias `priceChange30mPercent`)
`history_1h_price`	`float \| None`	snapshot price of the token in USD at the start of the trailing 1h window; `None` if the API has no price datapoint for the start of that window. (alias `history1hPrice`)
`price_change_1h_percent`	`float \| None`	price change versus the start of the trailing 1h window, expressed in percent; `None` if the change cannot be computed. (alias `priceChange1hPercent`)
`history_2h_price`	`float \| None`	snapshot price of the token in USD at the start of the trailing 2h window; `None` if the API has no price datapoint for the start of that window. (alias `history2hPrice`)
`price_change_2h_percent`	`float \| None`	price change versus the start of the trailing 2h window, expressed in percent; `None` if the change cannot be computed. (alias `priceChange2hPercent`)
`history_4h_price`	`float \| None`	snapshot price of the token in USD at the start of the trailing 4h window; `None` if the API has no price datapoint for the start of that window. (alias `history4hPrice`)
`price_change_4h_percent`	`float \| None`	price change versus the start of the trailing 4h window, expressed in percent; `None` if the change cannot be computed. (alias `priceChange4hPercent`)
`history_6h_price`	`float \| None`	snapshot price of the token in USD at the start of the trailing 6h window; `None` if the API has no price datapoint for the start of that window. (alias `history6hPrice`)
`price_change_6h_percent`	`float \| None`	price change versus the start of the trailing 6h window, expressed in percent; `None` if the change cannot be computed. (alias `priceChange6hPercent`)
`history_8h_price`	`float \| None`	snapshot price of the token in USD at the start of the trailing 8h window; `None` if the API has no price datapoint for the start of that window. (alias `history8hPrice`)
`price_change_8h_percent`	`float \| None`	price change versus the start of the trailing 8h window, expressed in percent; `None` if the change cannot be computed. (alias `priceChange8hPercent`)
`history_12h_price`	`float \| None`	snapshot price of the token in USD at the start of the trailing 12h window; `None` if the API has no price datapoint for the start of that window. (alias `history12hPrice`)
`price_change_12h_percent`	`float \| None`	price change versus the start of the trailing 12h window, expressed in percent; `None` if the change cannot be computed. (alias `priceChange12hPercent`)
`history_24h_price`	`float \| None`	snapshot price of the token in USD at the start of the trailing 24h window; `None` if the API has no price datapoint for the start of that window. (alias `history24hPrice`)
`price_change_24h_percent`	`float \| None`	price change versus the start of the trailing 24h window, expressed in percent; `None` if the change cannot be computed. (alias `priceChange24hPercent`)
`unique_wallet_1m`	`int \| None`	count of unique wallets that traded the token during the trailing 1m window; `None` if Birdeye has not computed the metric for that window. (alias `uniqueWallet1m`)
`unique_wallet_history_1m`	`int \| None`	count of unique wallets that traded the token during the previous 1m window; `None` if not available. (alias `uniqueWalletHistory1m`)
`unique_wallet_1m_change_percent`	`float \| None`	percent change of unique wallets between the current and previous 1m windows; `None` if either window is missing. (alias `uniqueWallet1mChangePercent`)
`unique_wallet_5m`	`int \| None`	count of unique wallets that traded the token during the trailing 5m window; `None` if Birdeye has not computed the metric for that window. (alias `uniqueWallet5m`)
`unique_wallet_history_5m`	`int \| None`	count of unique wallets that traded the token during the previous 5m window; `None` if not available. (alias `uniqueWalletHistory5m`)
`unique_wallet_5m_change_percent`	`float \| None`	percent change of unique wallets between the current and previous 5m windows; `None` if either window is missing. (alias `uniqueWallet5mChangePercent`)
`unique_wallet_30m`	`int \| None`	count of unique wallets that traded the token during the trailing 30m window; `None` if Birdeye has not computed the metric for that window. (alias `uniqueWallet30m`)
`unique_wallet_history_30m`	`int \| None`	count of unique wallets that traded the token during the previous 30m window; `None` if not available. (alias `uniqueWalletHistory30m`)
`unique_wallet_30m_change_percent`	`float \| None`	percent change of unique wallets between the current and previous 30m windows; `None` if either window is missing. (alias `uniqueWallet30mChangePercent`)
`unique_wallet_1h`	`int \| None`	count of unique wallets that traded the token during the trailing 1h window; `None` if Birdeye has not computed the metric for that window. (alias `uniqueWallet1h`)
`unique_wallet_history_1h`	`int \| None`	count of unique wallets that traded the token during the previous 1h window; `None` if not available. (alias `uniqueWalletHistory1h`)
`unique_wallet_1h_change_percent`	`float \| None`	percent change of unique wallets between the current and previous 1h windows; `None` if either window is missing. (alias `uniqueWallet1hChangePercent`)
`unique_wallet_2h`	`int \| None`	count of unique wallets that traded the token during the trailing 2h window; `None` if Birdeye has not computed the metric for that window. (alias `uniqueWallet2h`)
`unique_wallet_history_2h`	`int \| None`	count of unique wallets that traded the token during the previous 2h window; `None` if not available. (alias `uniqueWalletHistory2h`)
`unique_wallet_2h_change_percent`	`float \| None`	percent change of unique wallets between the current and previous 2h windows; `None` if either window is missing. (alias `uniqueWallet2hChangePercent`)
`unique_wallet_4h`	`int \| None`	count of unique wallets that traded the token during the trailing 4h window; `None` if Birdeye has not computed the metric for that window. (alias `uniqueWallet4h`)
`unique_wallet_history_4h`	`int \| None`	count of unique wallets that traded the token during the previous 4h window; `None` if not available. (alias `uniqueWalletHistory4h`)
`unique_wallet_4h_change_percent`	`float \| None`	percent change of unique wallets between the current and previous 4h windows; `None` if either window is missing. (alias `uniqueWallet4hChangePercent`)
`unique_wallet_8h`	`int \| None`	count of unique wallets that traded the token during the trailing 8h window; `None` if Birdeye has not computed the metric for that window. (alias `uniqueWallet8h`)
`unique_wallet_history_8h`	`int \| None`	count of unique wallets that traded the token during the previous 8h window; `None` if not available. (alias `uniqueWalletHistory8h`)
`unique_wallet_8h_change_percent`	`float \| None`	percent change of unique wallets between the current and previous 8h windows; `None` if either window is missing. (alias `uniqueWallet8hChangePercent`)
`unique_wallet_24h`	`int \| None`	count of unique wallets that traded the token during the trailing 24h window; `None` if Birdeye has not computed the metric for that window. (alias `uniqueWallet24h`)
`unique_wallet_history_24h`	`int \| None`	count of unique wallets that traded the token during the previous 24h window; `None` if not available. (alias `uniqueWalletHistory24h`)
`unique_wallet_24h_change_percent`	`float \| None`	percent change of unique wallets between the current and previous 24h windows; `None` if either window is missing. (alias `uniqueWallet24hChangePercent`)
`total_supply`	`float \| None`	total on-chain supply of the token in UI units; `None` if undetermined. (alias `totalSupply`)
`circulating_supply`	`float \| None`	currently circulating supply of the token in UI units; `None` if undetermined. (alias `circulatingSupply`)
`holder`	`int \| None`	number of distinct holders of the token on the chain; `None` if undetermined.
`trade_1m`	`int \| None`	total number of trades involving the token during the trailing 1m window. (alias `trade1m`)
`trade_history_1m`	`int \| None`	total number of trades during the previous 1m window. (alias `tradeHistory1m`)
`trade_1m_change_percent`	`float \| None`	percent change of trade count between the current and previous 1m windows. (alias `trade1mChangePercent`)
`sell_1m`	`int \| None`	number of sell trades during the trailing 1m window. (alias `sell1m`)
`sell_history_1m`	`int \| None`	number of sell trades during the previous 1m window. (alias `sellHistory1m`)
`sell_1m_change_percent`	`float \| None`	percent change of sell count between the current and previous 1m windows. (alias `sell1mChangePercent`)
`buy_1m`	`int \| None`	number of buy trades during the trailing 1m window. (alias `buy1m`)
`buy_history_1m`	`int \| None`	number of buy trades during the previous 1m window. (alias `buyHistory1m`)
`buy_1m_change_percent`	`float \| None`	percent change of buy count between the current and previous 1m windows. (alias `buy1mChangePercent`)
`volume_1m`	`float \| None`	traded volume during the trailing 1m window, expressed in the token UI units. (alias `v1m`)
`volume_1m_usd`	`float \| None`	traded volume during the trailing 1m window, expressed in USD. (alias `v1mUSD`)
`volume_history_1m`	`float \| None`	traded volume during the previous 1m window, expressed in the token UI units. (alias `vHistory1m`)
`volume_history_1m_usd`	`float \| None`	traded volume during the previous 1m window, expressed in USD. (alias `vHistory1mUSD`)
`volume_1m_change_percent`	`float \| None`	percent change of traded volume between the current and previous 1m windows. (alias `v1mChangePercent`)
`volume_buy_1m`	`float \| None`	buy-side traded volume during the trailing 1m window, in the token UI units. (alias `vBuy1m`)
`volume_buy_1m_usd`	`float \| None`	buy-side traded volume during the trailing 1m window, in USD. (alias `vBuy1mUSD`)
`volume_buy_history_1m`	`float \| None`	buy-side traded volume during the previous 1m window, in the token UI units. (alias `vBuyHistory1m`)
`volume_buy_history_1m_usd`	`float \| None`	buy-side traded volume during the previous 1m window, in USD. (alias `vBuyHistory1mUSD`)
`volume_buy_1m_change_percent`	`float \| None`	percent change of buy-side traded volume between the current and previous 1m windows. (alias `vBuy1mChangePercent`)
`volume_sell_1m`	`float \| None`	sell-side traded volume during the trailing 1m window, in the token UI units. (alias `vSell1m`)
`volume_sell_1m_usd`	`float \| None`	sell-side traded volume during the trailing 1m window, in USD. (alias `vSell1mUSD`)
`volume_sell_history_1m`	`float \| None`	sell-side traded volume during the previous 1m window, in the token UI units. (alias `vSellHistory1m`)
`volume_sell_history_1m_usd`	`float \| None`	sell-side traded volume during the previous 1m window, in USD. (alias `vSellHistory1mUSD`)
`volume_sell_1m_change_percent`	`float \| None`	percent change of sell-side traded volume between the current and previous 1m windows. (alias `vSell1mChangePercent`)
`trade_5m`	`int \| None`	total number of trades involving the token during the trailing 5m window. (alias `trade5m`)
`trade_history_5m`	`int \| None`	total number of trades during the previous 5m window. (alias `tradeHistory5m`)
`trade_5m_change_percent`	`float \| None`	percent change of trade count between the current and previous 5m windows. (alias `trade5mChangePercent`)
`sell_5m`	`int \| None`	number of sell trades during the trailing 5m window. (alias `sell5m`)
`sell_history_5m`	`int \| None`	number of sell trades during the previous 5m window. (alias `sellHistory5m`)
`sell_5m_change_percent`	`float \| None`	percent change of sell count between the current and previous 5m windows. (alias `sell5mChangePercent`)
`buy_5m`	`int \| None`	number of buy trades during the trailing 5m window. (alias `buy5m`)
`buy_history_5m`	`int \| None`	number of buy trades during the previous 5m window. (alias `buyHistory5m`)
`buy_5m_change_percent`	`float \| None`	percent change of buy count between the current and previous 5m windows. (alias `buy5mChangePercent`)
`volume_5m`	`float \| None`	traded volume during the trailing 5m window, expressed in the token UI units. (alias `v5m`)
`volume_5m_usd`	`float \| None`	traded volume during the trailing 5m window, expressed in USD. (alias `v5mUSD`)
`volume_history_5m`	`float \| None`	traded volume during the previous 5m window, expressed in the token UI units. (alias `vHistory5m`)
`volume_history_5m_usd`	`float \| None`	traded volume during the previous 5m window, expressed in USD. (alias `vHistory5mUSD`)
`volume_5m_change_percent`	`float \| None`	percent change of traded volume between the current and previous 5m windows. (alias `v5mChangePercent`)
`volume_buy_5m`	`float \| None`	buy-side traded volume during the trailing 5m window, in the token UI units. (alias `vBuy5m`)
`volume_buy_5m_usd`	`float \| None`	buy-side traded volume during the trailing 5m window, in USD. (alias `vBuy5mUSD`)
`volume_buy_history_5m`	`float \| None`	buy-side traded volume during the previous 5m window, in the token UI units. (alias `vBuyHistory5m`)
`volume_buy_history_5m_usd`	`float \| None`	buy-side traded volume during the previous 5m window, in USD. (alias `vBuyHistory5mUSD`)
`volume_buy_5m_change_percent`	`float \| None`	percent change of buy-side traded volume between the current and previous 5m windows. (alias `vBuy5mChangePercent`)
`volume_sell_5m`	`float \| None`	sell-side traded volume during the trailing 5m window, in the token UI units. (alias `vSell5m`)
`volume_sell_5m_usd`	`float \| None`	sell-side traded volume during the trailing 5m window, in USD. (alias `vSell5mUSD`)
`volume_sell_history_5m`	`float \| None`	sell-side traded volume during the previous 5m window, in the token UI units. (alias `vSellHistory5m`)
`volume_sell_history_5m_usd`	`float \| None`	sell-side traded volume during the previous 5m window, in USD. (alias `vSellHistory5mUSD`)
`volume_sell_5m_change_percent`	`float \| None`	percent change of sell-side traded volume between the current and previous 5m windows. (alias `vSell5mChangePercent`)
`trade_30m`	`int \| None`	total number of trades involving the token during the trailing 30m window. (alias `trade30m`)
`trade_history_30m`	`int \| None`	total number of trades during the previous 30m window. (alias `tradeHistory30m`)
`trade_30m_change_percent`	`float \| None`	percent change of trade count between the current and previous 30m windows. (alias `trade30mChangePercent`)
`sell_30m`	`int \| None`	number of sell trades during the trailing 30m window. (alias `sell30m`)
`sell_history_30m`	`int \| None`	number of sell trades during the previous 30m window. (alias `sellHistory30m`)
`sell_30m_change_percent`	`float \| None`	percent change of sell count between the current and previous 30m windows. (alias `sell30mChangePercent`)
`buy_30m`	`int \| None`	number of buy trades during the trailing 30m window. (alias `buy30m`)
`buy_history_30m`	`int \| None`	number of buy trades during the previous 30m window. (alias `buyHistory30m`)
`buy_30m_change_percent`	`float \| None`	percent change of buy count between the current and previous 30m windows. (alias `buy30mChangePercent`)
`volume_30m`	`float \| None`	traded volume during the trailing 30m window, expressed in the token UI units. (alias `v30m`)
`volume_30m_usd`	`float \| None`	traded volume during the trailing 30m window, expressed in USD. (alias `v30mUSD`)
`volume_history_30m`	`float \| None`	traded volume during the previous 30m window, expressed in the token UI units. (alias `vHistory30m`)
`volume_history_30m_usd`	`float \| None`	traded volume during the previous 30m window, expressed in USD. (alias `vHistory30mUSD`)
`volume_30m_change_percent`	`float \| None`	percent change of traded volume between the current and previous 30m windows. (alias `v30mChangePercent`)
`volume_buy_30m`	`float \| None`	buy-side traded volume during the trailing 30m window, in the token UI units. (alias `vBuy30m`)
`volume_buy_30m_usd`	`float \| None`	buy-side traded volume during the trailing 30m window, in USD. (alias `vBuy30mUSD`)
`volume_buy_history_30m`	`float \| None`	buy-side traded volume during the previous 30m window, in the token UI units. (alias `vBuyHistory30m`)
`volume_buy_history_30m_usd`	`float \| None`	buy-side traded volume during the previous 30m window, in USD. (alias `vBuyHistory30mUSD`)
`volume_buy_30m_change_percent`	`float \| None`	percent change of buy-side traded volume between the current and previous 30m windows. (alias `vBuy30mChangePercent`)
`volume_sell_30m`	`float \| None`	sell-side traded volume during the trailing 30m window, in the token UI units. (alias `vSell30m`)
`volume_sell_30m_usd`	`float \| None`	sell-side traded volume during the trailing 30m window, in USD. (alias `vSell30mUSD`)
`volume_sell_history_30m`	`float \| None`	sell-side traded volume during the previous 30m window, in the token UI units. (alias `vSellHistory30m`)
`volume_sell_history_30m_usd`	`float \| None`	sell-side traded volume during the previous 30m window, in USD. (alias `vSellHistory30mUSD`)
`volume_sell_30m_change_percent`	`float \| None`	percent change of sell-side traded volume between the current and previous 30m windows. (alias `vSell30mChangePercent`)
`trade_1h`	`int \| None`	total number of trades involving the token during the trailing 1h window. (alias `trade1h`)
`trade_history_1h`	`int \| None`	total number of trades during the previous 1h window. (alias `tradeHistory1h`)
`trade_1h_change_percent`	`float \| None`	percent change of trade count between the current and previous 1h windows. (alias `trade1hChangePercent`)
`sell_1h`	`int \| None`	number of sell trades during the trailing 1h window. (alias `sell1h`)
`sell_history_1h`	`int \| None`	number of sell trades during the previous 1h window. (alias `sellHistory1h`)
`sell_1h_change_percent`	`float \| None`	percent change of sell count between the current and previous 1h windows. (alias `sell1hChangePercent`)
`buy_1h`	`int \| None`	number of buy trades during the trailing 1h window. (alias `buy1h`)
`buy_history_1h`	`int \| None`	number of buy trades during the previous 1h window. (alias `buyHistory1h`)
`buy_1h_change_percent`	`float \| None`	percent change of buy count between the current and previous 1h windows. (alias `buy1hChangePercent`)
`volume_1h`	`float \| None`	traded volume during the trailing 1h window, expressed in the token UI units. (alias `v1h`)
`volume_1h_usd`	`float \| None`	traded volume during the trailing 1h window, expressed in USD. (alias `v1hUSD`)
`volume_history_1h`	`float \| None`	traded volume during the previous 1h window, expressed in the token UI units. (alias `vHistory1h`)
`volume_history_1h_usd`	`float \| None`	traded volume during the previous 1h window, expressed in USD. (alias `vHistory1hUSD`)
`volume_1h_change_percent`	`float \| None`	percent change of traded volume between the current and previous 1h windows. (alias `v1hChangePercent`)
`volume_buy_1h`	`float \| None`	buy-side traded volume during the trailing 1h window, in the token UI units. (alias `vBuy1h`)
`volume_buy_1h_usd`	`float \| None`	buy-side traded volume during the trailing 1h window, in USD. (alias `vBuy1hUSD`)
`volume_buy_history_1h`	`float \| None`	buy-side traded volume during the previous 1h window, in the token UI units. (alias `vBuyHistory1h`)
`volume_buy_history_1h_usd`	`float \| None`	buy-side traded volume during the previous 1h window, in USD. (alias `vBuyHistory1hUSD`)
`volume_buy_1h_change_percent`	`float \| None`	percent change of buy-side traded volume between the current and previous 1h windows. (alias `vBuy1hChangePercent`)
`volume_sell_1h`	`float \| None`	sell-side traded volume during the trailing 1h window, in the token UI units. (alias `vSell1h`)
`volume_sell_1h_usd`	`float \| None`	sell-side traded volume during the trailing 1h window, in USD. (alias `vSell1hUSD`)
`volume_sell_history_1h`	`float \| None`	sell-side traded volume during the previous 1h window, in the token UI units. (alias `vSellHistory1h`)
`volume_sell_history_1h_usd`	`float \| None`	sell-side traded volume during the previous 1h window, in USD. (alias `vSellHistory1hUSD`)
`volume_sell_1h_change_percent`	`float \| None`	percent change of sell-side traded volume between the current and previous 1h windows. (alias `vSell1hChangePercent`)
`trade_2h`	`int \| None`	total number of trades involving the token during the trailing 2h window. (alias `trade2h`)
`trade_history_2h`	`int \| None`	total number of trades during the previous 2h window. (alias `tradeHistory2h`)
`trade_2h_change_percent`	`float \| None`	percent change of trade count between the current and previous 2h windows. (alias `trade2hChangePercent`)
`sell_2h`	`int \| None`	number of sell trades during the trailing 2h window. (alias `sell2h`)
`sell_history_2h`	`int \| None`	number of sell trades during the previous 2h window. (alias `sellHistory2h`)
`sell_2h_change_percent`	`float \| None`	percent change of sell count between the current and previous 2h windows. (alias `sell2hChangePercent`)
`buy_2h`	`int \| None`	number of buy trades during the trailing 2h window. (alias `buy2h`)
`buy_history_2h`	`int \| None`	number of buy trades during the previous 2h window. (alias `buyHistory2h`)
`buy_2h_change_percent`	`float \| None`	percent change of buy count between the current and previous 2h windows. (alias `buy2hChangePercent`)
`volume_2h`	`float \| None`	traded volume during the trailing 2h window, expressed in the token UI units. (alias `v2h`)
`volume_2h_usd`	`float \| None`	traded volume during the trailing 2h window, expressed in USD. (alias `v2hUSD`)
`volume_history_2h`	`float \| None`	traded volume during the previous 2h window, expressed in the token UI units. (alias `vHistory2h`)
`volume_history_2h_usd`	`float \| None`	traded volume during the previous 2h window, expressed in USD. (alias `vHistory2hUSD`)
`volume_2h_change_percent`	`float \| None`	percent change of traded volume between the current and previous 2h windows. (alias `v2hChangePercent`)
`volume_buy_2h`	`float \| None`	buy-side traded volume during the trailing 2h window, in the token UI units. (alias `vBuy2h`)
`volume_buy_2h_usd`	`float \| None`	buy-side traded volume during the trailing 2h window, in USD. (alias `vBuy2hUSD`)
`volume_buy_history_2h`	`float \| None`	buy-side traded volume during the previous 2h window, in the token UI units. (alias `vBuyHistory2h`)
`volume_buy_history_2h_usd`	`float \| None`	buy-side traded volume during the previous 2h window, in USD. (alias `vBuyHistory2hUSD`)
`volume_buy_2h_change_percent`	`float \| None`	percent change of buy-side traded volume between the current and previous 2h windows. (alias `vBuy2hChangePercent`)
`volume_sell_2h`	`float \| None`	sell-side traded volume during the trailing 2h window, in the token UI units. (alias `vSell2h`)
`volume_sell_2h_usd`	`float \| None`	sell-side traded volume during the trailing 2h window, in USD. (alias `vSell2hUSD`)
`volume_sell_history_2h`	`float \| None`	sell-side traded volume during the previous 2h window, in the token UI units. (alias `vSellHistory2h`)
`volume_sell_history_2h_usd`	`float \| None`	sell-side traded volume during the previous 2h window, in USD. (alias `vSellHistory2hUSD`)
`volume_sell_2h_change_percent`	`float \| None`	percent change of sell-side traded volume between the current and previous 2h windows. (alias `vSell2hChangePercent`)
`trade_4h`	`int \| None`	total number of trades involving the token during the trailing 4h window. (alias `trade4h`)
`trade_history_4h`	`int \| None`	total number of trades during the previous 4h window. (alias `tradeHistory4h`)
`trade_4h_change_percent`	`float \| None`	percent change of trade count between the current and previous 4h windows. (alias `trade4hChangePercent`)
`sell_4h`	`int \| None`	number of sell trades during the trailing 4h window. (alias `sell4h`)
`sell_history_4h`	`int \| None`	number of sell trades during the previous 4h window. (alias `sellHistory4h`)
`sell_4h_change_percent`	`float \| None`	percent change of sell count between the current and previous 4h windows. (alias `sell4hChangePercent`)
`buy_4h`	`int \| None`	number of buy trades during the trailing 4h window. (alias `buy4h`)
`buy_history_4h`	`int \| None`	number of buy trades during the previous 4h window. (alias `buyHistory4h`)
`buy_4h_change_percent`	`float \| None`	percent change of buy count between the current and previous 4h windows. (alias `buy4hChangePercent`)
`volume_4h`	`float \| None`	traded volume during the trailing 4h window, expressed in the token UI units. (alias `v4h`)
`volume_4h_usd`	`float \| None`	traded volume during the trailing 4h window, expressed in USD. (alias `v4hUSD`)
`volume_history_4h`	`float \| None`	traded volume during the previous 4h window, expressed in the token UI units. (alias `vHistory4h`)
`volume_history_4h_usd`	`float \| None`	traded volume during the previous 4h window, expressed in USD. (alias `vHistory4hUSD`)
`volume_4h_change_percent`	`float \| None`	percent change of traded volume between the current and previous 4h windows. (alias `v4hChangePercent`)
`volume_buy_4h`	`float \| None`	buy-side traded volume during the trailing 4h window, in the token UI units. (alias `vBuy4h`)
`volume_buy_4h_usd`	`float \| None`	buy-side traded volume during the trailing 4h window, in USD. (alias `vBuy4hUSD`)
`volume_buy_history_4h`	`float \| None`	buy-side traded volume during the previous 4h window, in the token UI units. (alias `vBuyHistory4h`)
`volume_buy_history_4h_usd`	`float \| None`	buy-side traded volume during the previous 4h window, in USD. (alias `vBuyHistory4hUSD`)
`volume_buy_4h_change_percent`	`float \| None`	percent change of buy-side traded volume between the current and previous 4h windows. (alias `vBuy4hChangePercent`)
`volume_sell_4h`	`float \| None`	sell-side traded volume during the trailing 4h window, in the token UI units. (alias `vSell4h`)
`volume_sell_4h_usd`	`float \| None`	sell-side traded volume during the trailing 4h window, in USD. (alias `vSell4hUSD`)
`volume_sell_history_4h`	`float \| None`	sell-side traded volume during the previous 4h window, in the token UI units. (alias `vSellHistory4h`)
`volume_sell_history_4h_usd`	`float \| None`	sell-side traded volume during the previous 4h window, in USD. (alias `vSellHistory4hUSD`)
`volume_sell_4h_change_percent`	`float \| None`	percent change of sell-side traded volume between the current and previous 4h windows. (alias `vSell4hChangePercent`)
`trade_8h`	`int \| None`	total number of trades involving the token during the trailing 8h window. (alias `trade8h`)
`trade_history_8h`	`int \| None`	total number of trades during the previous 8h window. (alias `tradeHistory8h`)
`trade_8h_change_percent`	`float \| None`	percent change of trade count between the current and previous 8h windows. (alias `trade8hChangePercent`)
`sell_8h`	`int \| None`	number of sell trades during the trailing 8h window. (alias `sell8h`)
`sell_history_8h`	`int \| None`	number of sell trades during the previous 8h window. (alias `sellHistory8h`)
`sell_8h_change_percent`	`float \| None`	percent change of sell count between the current and previous 8h windows. (alias `sell8hChangePercent`)
`buy_8h`	`int \| None`	number of buy trades during the trailing 8h window. (alias `buy8h`)
`buy_history_8h`	`int \| None`	number of buy trades during the previous 8h window. (alias `buyHistory8h`)
`buy_8h_change_percent`	`float \| None`	percent change of buy count between the current and previous 8h windows. (alias `buy8hChangePercent`)
`volume_8h`	`float \| None`	traded volume during the trailing 8h window, expressed in the token UI units. (alias `v8h`)
`volume_8h_usd`	`float \| None`	traded volume during the trailing 8h window, expressed in USD. (alias `v8hUSD`)
`volume_history_8h`	`float \| None`	traded volume during the previous 8h window, expressed in the token UI units. (alias `vHistory8h`)
`volume_history_8h_usd`	`float \| None`	traded volume during the previous 8h window, expressed in USD. (alias `vHistory8hUSD`)
`volume_8h_change_percent`	`float \| None`	percent change of traded volume between the current and previous 8h windows. (alias `v8hChangePercent`)
`volume_buy_8h`	`float \| None`	buy-side traded volume during the trailing 8h window, in the token UI units. (alias `vBuy8h`)
`volume_buy_8h_usd`	`float \| None`	buy-side traded volume during the trailing 8h window, in USD. (alias `vBuy8hUSD`)
`volume_buy_history_8h`	`float \| None`	buy-side traded volume during the previous 8h window, in the token UI units. (alias `vBuyHistory8h`)
`volume_buy_history_8h_usd`	`float \| None`	buy-side traded volume during the previous 8h window, in USD. (alias `vBuyHistory8hUSD`)
`volume_buy_8h_change_percent`	`float \| None`	percent change of buy-side traded volume between the current and previous 8h windows. (alias `vBuy8hChangePercent`)
`volume_sell_8h`	`float \| None`	sell-side traded volume during the trailing 8h window, in the token UI units. (alias `vSell8h`)
`volume_sell_8h_usd`	`float \| None`	sell-side traded volume during the trailing 8h window, in USD. (alias `vSell8hUSD`)
`volume_sell_history_8h`	`float \| None`	sell-side traded volume during the previous 8h window, in the token UI units. (alias `vSellHistory8h`)
`volume_sell_history_8h_usd`	`float \| None`	sell-side traded volume during the previous 8h window, in USD. (alias `vSellHistory8hUSD`)
`volume_sell_8h_change_percent`	`float \| None`	percent change of sell-side traded volume between the current and previous 8h windows. (alias `vSell8hChangePercent`)
`trade_24h`	`int \| None`	total number of trades involving the token during the trailing 24h window. (alias `trade24h`)
`trade_history_24h`	`int \| None`	total number of trades during the previous 24h window. (alias `tradeHistory24h`)
`trade_24h_change_percent`	`float \| None`	percent change of trade count between the current and previous 24h windows. (alias `trade24hChangePercent`)
`sell_24h`	`int \| None`	number of sell trades during the trailing 24h window. (alias `sell24h`)
`sell_history_24h`	`int \| None`	number of sell trades during the previous 24h window. (alias `sellHistory24h`)
`sell_24h_change_percent`	`float \| None`	percent change of sell count between the current and previous 24h windows. (alias `sell24hChangePercent`)
`buy_24h`	`int \| None`	number of buy trades during the trailing 24h window. (alias `buy24h`)
`buy_history_24h`	`int \| None`	number of buy trades during the previous 24h window. (alias `buyHistory24h`)
`buy_24h_change_percent`	`float \| None`	percent change of buy count between the current and previous 24h windows. (alias `buy24hChangePercent`)
`volume_24h`	`float \| None`	traded volume during the trailing 24h window, expressed in the token UI units. (alias `v24h`)
`volume_24h_usd`	`float \| None`	traded volume during the trailing 24h window, expressed in USD. (alias `v24hUSD`)
`volume_history_24h`	`float \| None`	traded volume during the previous 24h window, expressed in the token UI units. (alias `vHistory24h`)
`volume_history_24h_usd`	`float \| None`	traded volume during the previous 24h window, expressed in USD. (alias `vHistory24hUSD`)
`volume_24h_change_percent`	`float \| None`	percent change of traded volume between the current and previous 24h windows. (alias `v24hChangePercent`)
`volume_buy_24h`	`float \| None`	buy-side traded volume during the trailing 24h window, in the token UI units. (alias `vBuy24h`)
`volume_buy_24h_usd`	`float \| None`	buy-side traded volume during the trailing 24h window, in USD. (alias `vBuy24hUSD`)
`volume_buy_history_24h`	`float \| None`	buy-side traded volume during the previous 24h window, in the token UI units. (alias `vBuyHistory24h`)
`volume_buy_history_24h_usd`	`float \| None`	buy-side traded volume during the previous 24h window, in USD. (alias `vBuyHistory24hUSD`)
`volume_buy_24h_change_percent`	`float \| None`	percent change of buy-side traded volume between the current and previous 24h windows. (alias `vBuy24hChangePercent`)
`volume_sell_24h`	`float \| None`	sell-side traded volume during the trailing 24h window, in the token UI units. (alias `vSell24h`)
`volume_sell_24h_usd`	`float \| None`	sell-side traded volume during the trailing 24h window, in USD. (alias `vSell24hUSD`)
`volume_sell_history_24h`	`float \| None`	sell-side traded volume during the previous 24h window, in the token UI units. (alias `vSellHistory24h`)
`volume_sell_history_24h_usd`	`float \| None`	sell-side traded volume during the previous 24h window, in USD. (alias `vSellHistory24hUSD`)
`volume_sell_24h_change_percent`	`float \| None`	percent change of sell-side traded volume between the current and previous 24h windows. (alias `vSell24hChangePercent`)
`number_markets`	`int \| None`	number of active markets (trading pairs) Birdeye tracks for the token; `None` if undetermined. (alias `numberMarkets`)
`is_scaled_ui_token`	`bool \| None`	`True` when the token is a scaled-UI-amount SPL token (Solana only); `None` outside Solana or when undetermined. (alias `isScaledUiToken`)
`multiplier`	`float \| None`	scaling multiplier applied by the API to UI amounts of scaled-UI-amount tokens; `None` when not applicable.

address `instance-attribute` ¶

address: str

decimals `instance-attribute` ¶

decimals: int

symbol `instance-attribute` ¶

symbol: str

name `instance-attribute` ¶

name: str

market_cap `class-attribute` `instance-attribute` ¶

market_cap: float | None = Field(
    alias="marketCap", default=None
)

fdv `class-attribute` `instance-attribute` ¶

fdv: float | None = None

extensions `class-attribute` `instance-attribute` ¶

extensions: dict[str, str | None] | None = None

logo_uri `class-attribute` `instance-attribute` ¶

logo_uri: str | None = Field(alias='logoURI', default=None)

liquidity `instance-attribute` ¶

liquidity: float

last_trade_unix_time `class-attribute` `instance-attribute` ¶

last_trade_unix_time: int = Field(alias="lastTradeUnixTime")

last_trade_human_time `class-attribute` `instance-attribute` ¶

last_trade_human_time: datetime = Field(
    alias="lastTradeHumanTime"
)

price `instance-attribute` ¶

price: float

history_1m_price `class-attribute` `instance-attribute` ¶

history_1m_price: float | None = Field(
    alias="history1mPrice", default=None
)

price_change_1m_percent `class-attribute` `instance-attribute` ¶

price_change_1m_percent: float | None = Field(
    alias="priceChange1mPercent", default=None
)

history_5m_price `class-attribute` `instance-attribute` ¶

history_5m_price: float | None = Field(
    alias="history5mPrice", default=None
)

price_change_5m_percent `class-attribute` `instance-attribute` ¶

price_change_5m_percent: float | None = Field(
    alias="priceChange5mPercent", default=None
)

history_30m_price `class-attribute` `instance-attribute` ¶

history_30m_price: float | None = Field(
    alias="history30mPrice", default=None
)

price_change_30m_percent `class-attribute` `instance-attribute` ¶

price_change_30m_percent: float | None = Field(
    alias="priceChange30mPercent", default=None
)

history_1h_price `class-attribute` `instance-attribute` ¶

history_1h_price: float | None = Field(
    alias="history1hPrice", default=None
)

price_change_1h_percent `class-attribute` `instance-attribute` ¶

price_change_1h_percent: float | None = Field(
    alias="priceChange1hPercent", default=None
)

history_2h_price `class-attribute` `instance-attribute` ¶

history_2h_price: float | None = Field(
    alias="history2hPrice", default=None
)

price_change_2h_percent `class-attribute` `instance-attribute` ¶

price_change_2h_percent: float | None = Field(
    alias="priceChange2hPercent", default=None
)

history_4h_price `class-attribute` `instance-attribute` ¶

history_4h_price: float | None = Field(
    alias="history4hPrice", default=None
)

price_change_4h_percent `class-attribute` `instance-attribute` ¶

price_change_4h_percent: float | None = Field(
    alias="priceChange4hPercent", default=None
)

history_6h_price `class-attribute` `instance-attribute` ¶

history_6h_price: float | None = Field(
    alias="history6hPrice", default=None
)

price_change_6h_percent `class-attribute` `instance-attribute` ¶

price_change_6h_percent: float | None = Field(
    alias="priceChange6hPercent", default=None
)

history_8h_price `class-attribute` `instance-attribute` ¶

history_8h_price: float | None = Field(
    alias="history8hPrice", default=None
)

price_change_8h_percent `class-attribute` `instance-attribute` ¶

price_change_8h_percent: float | None = Field(
    alias="priceChange8hPercent", default=None
)

history_12h_price `class-attribute` `instance-attribute` ¶

history_12h_price: float | None = Field(
    alias="history12hPrice", default=None
)

price_change_12h_percent `class-attribute` `instance-attribute` ¶

price_change_12h_percent: float | None = Field(
    alias="priceChange12hPercent", default=None
)

history_24h_price `class-attribute` `instance-attribute` ¶

history_24h_price: float | None = Field(
    alias="history24hPrice", default=None
)

price_change_24h_percent `class-attribute` `instance-attribute` ¶

price_change_24h_percent: float | None = Field(
    alias="priceChange24hPercent", default=None
)

unique_wallet_1m `class-attribute` `instance-attribute` ¶

unique_wallet_1m: int | None = Field(
    alias="uniqueWallet1m", default=None
)

unique_wallet_history_1m `class-attribute` `instance-attribute` ¶

unique_wallet_history_1m: int | None = Field(
    alias="uniqueWalletHistory1m", default=None
)

unique_wallet_1m_change_percent `class-attribute` `instance-attribute` ¶

unique_wallet_1m_change_percent: float | None = Field(
    alias="uniqueWallet1mChangePercent", default=None
)

unique_wallet_5m `class-attribute` `instance-attribute` ¶

unique_wallet_5m: int | None = Field(
    alias="uniqueWallet5m", default=None
)

unique_wallet_history_5m `class-attribute` `instance-attribute` ¶

unique_wallet_history_5m: int | None = Field(
    alias="uniqueWalletHistory5m", default=None
)

unique_wallet_5m_change_percent `class-attribute` `instance-attribute` ¶

unique_wallet_5m_change_percent: float | None = Field(
    alias="uniqueWallet5mChangePercent", default=None
)

unique_wallet_30m `class-attribute` `instance-attribute` ¶

unique_wallet_30m: int | None = Field(
    alias="uniqueWallet30m", default=None
)

unique_wallet_history_30m `class-attribute` `instance-attribute` ¶

unique_wallet_history_30m: int | None = Field(
    alias="uniqueWalletHistory30m", default=None
)

unique_wallet_30m_change_percent `class-attribute` `instance-attribute` ¶

unique_wallet_30m_change_percent: float | None = Field(
    alias="uniqueWallet30mChangePercent", default=None
)

unique_wallet_1h `class-attribute` `instance-attribute` ¶

unique_wallet_1h: int | None = Field(
    alias="uniqueWallet1h", default=None
)

unique_wallet_history_1h `class-attribute` `instance-attribute` ¶

unique_wallet_history_1h: int | None = Field(
    alias="uniqueWalletHistory1h", default=None
)

unique_wallet_1h_change_percent `class-attribute` `instance-attribute` ¶

unique_wallet_1h_change_percent: float | None = Field(
    alias="uniqueWallet1hChangePercent", default=None
)

unique_wallet_2h `class-attribute` `instance-attribute` ¶

unique_wallet_2h: int | None = Field(
    alias="uniqueWallet2h", default=None
)

unique_wallet_history_2h `class-attribute` `instance-attribute` ¶

unique_wallet_history_2h: int | None = Field(
    alias="uniqueWalletHistory2h", default=None
)

unique_wallet_2h_change_percent `class-attribute` `instance-attribute` ¶

unique_wallet_2h_change_percent: float | None = Field(
    alias="uniqueWallet2hChangePercent", default=None
)

unique_wallet_4h `class-attribute` `instance-attribute` ¶

unique_wallet_4h: int | None = Field(
    alias="uniqueWallet4h", default=None
)

unique_wallet_history_4h `class-attribute` `instance-attribute` ¶

unique_wallet_history_4h: int | None = Field(
    alias="uniqueWalletHistory4h", default=None
)

unique_wallet_4h_change_percent `class-attribute` `instance-attribute` ¶

unique_wallet_4h_change_percent: float | None = Field(
    alias="uniqueWallet4hChangePercent", default=None
)

unique_wallet_8h `class-attribute` `instance-attribute` ¶

unique_wallet_8h: int | None = Field(
    alias="uniqueWallet8h", default=None
)

unique_wallet_history_8h `class-attribute` `instance-attribute` ¶

unique_wallet_history_8h: int | None = Field(
    alias="uniqueWalletHistory8h", default=None
)

unique_wallet_8h_change_percent `class-attribute` `instance-attribute` ¶

unique_wallet_8h_change_percent: float | None = Field(
    alias="uniqueWallet8hChangePercent", default=None
)

unique_wallet_24h `class-attribute` `instance-attribute` ¶

unique_wallet_24h: int | None = Field(
    alias="uniqueWallet24h", default=None
)

unique_wallet_history_24h `class-attribute` `instance-attribute` ¶

unique_wallet_history_24h: int | None = Field(
    alias="uniqueWalletHistory24h", default=None
)

unique_wallet_24h_change_percent `class-attribute` `instance-attribute` ¶

unique_wallet_24h_change_percent: float | None = Field(
    alias="uniqueWallet24hChangePercent", default=None
)

total_supply `class-attribute` `instance-attribute` ¶

total_supply: float | None = Field(
    alias="totalSupply", default=None
)

circulating_supply `class-attribute` `instance-attribute` ¶

circulating_supply: float | None = Field(
    alias="circulatingSupply", default=None
)

holder `class-attribute` `instance-attribute` ¶

holder: int | None = None

trade_1m `class-attribute` `instance-attribute` ¶

trade_1m: int | None = Field(alias='trade1m', default=None)

trade_history_1m `class-attribute` `instance-attribute` ¶

trade_history_1m: int | None = Field(
    alias="tradeHistory1m", default=None
)

trade_1m_change_percent `class-attribute` `instance-attribute` ¶

trade_1m_change_percent: float | None = Field(
    alias="trade1mChangePercent", default=None
)

sell_1m `class-attribute` `instance-attribute` ¶

sell_1m: int | None = Field(alias='sell1m', default=None)

sell_history_1m `class-attribute` `instance-attribute` ¶

sell_history_1m: int | None = Field(
    alias="sellHistory1m", default=None
)

sell_1m_change_percent `class-attribute` `instance-attribute` ¶

sell_1m_change_percent: float | None = Field(
    alias="sell1mChangePercent", default=None
)

buy_1m `class-attribute` `instance-attribute` ¶

buy_1m: int | None = Field(alias='buy1m', default=None)

buy_history_1m `class-attribute` `instance-attribute` ¶

buy_history_1m: int | None = Field(
    alias="buyHistory1m", default=None
)

buy_1m_change_percent `class-attribute` `instance-attribute` ¶

buy_1m_change_percent: float | None = Field(
    alias="buy1mChangePercent", default=None
)

volume_1m `class-attribute` `instance-attribute` ¶

volume_1m: float | None = Field(alias='v1m', default=None)

volume_1m_usd `class-attribute` `instance-attribute` ¶

volume_1m_usd: float | None = Field(
    alias="v1mUSD", default=None
)

volume_history_1m `class-attribute` `instance-attribute` ¶

volume_history_1m: float | None = Field(
    alias="vHistory1m", default=None
)

volume_history_1m_usd `class-attribute` `instance-attribute` ¶

volume_history_1m_usd: float | None = Field(
    alias="vHistory1mUSD", default=None
)

volume_1m_change_percent `class-attribute` `instance-attribute` ¶

volume_1m_change_percent: float | None = Field(
    alias="v1mChangePercent", default=None
)

volume_buy_1m `class-attribute` `instance-attribute` ¶

volume_buy_1m: float | None = Field(
    alias="vBuy1m", default=None
)

volume_buy_1m_usd `class-attribute` `instance-attribute` ¶

volume_buy_1m_usd: float | None = Field(
    alias="vBuy1mUSD", default=None
)

volume_buy_history_1m `class-attribute` `instance-attribute` ¶

volume_buy_history_1m: float | None = Field(
    alias="vBuyHistory1m", default=None
)

volume_buy_history_1m_usd `class-attribute` `instance-attribute` ¶

volume_buy_history_1m_usd: float | None = Field(
    alias="vBuyHistory1mUSD", default=None
)

volume_buy_1m_change_percent `class-attribute` `instance-attribute` ¶

volume_buy_1m_change_percent: float | None = Field(
    alias="vBuy1mChangePercent", default=None
)

volume_sell_1m `class-attribute` `instance-attribute` ¶

volume_sell_1m: float | None = Field(
    alias="vSell1m", default=None
)

volume_sell_1m_usd `class-attribute` `instance-attribute` ¶

volume_sell_1m_usd: float | None = Field(
    alias="vSell1mUSD", default=None
)

volume_sell_history_1m `class-attribute` `instance-attribute` ¶

volume_sell_history_1m: float | None = Field(
    alias="vSellHistory1m", default=None
)

volume_sell_history_1m_usd `class-attribute` `instance-attribute` ¶

volume_sell_history_1m_usd: float | None = Field(
    alias="vSellHistory1mUSD", default=None
)

volume_sell_1m_change_percent `class-attribute` `instance-attribute` ¶

volume_sell_1m_change_percent: float | None = Field(
    alias="vSell1mChangePercent", default=None
)

trade_5m `class-attribute` `instance-attribute` ¶

trade_5m: int | None = Field(alias='trade5m', default=None)

trade_history_5m `class-attribute` `instance-attribute` ¶

trade_history_5m: int | None = Field(
    alias="tradeHistory5m", default=None
)

trade_5m_change_percent `class-attribute` `instance-attribute` ¶

trade_5m_change_percent: float | None = Field(
    alias="trade5mChangePercent", default=None
)

sell_5m `class-attribute` `instance-attribute` ¶

sell_5m: int | None = Field(alias='sell5m', default=None)

sell_history_5m `class-attribute` `instance-attribute` ¶

sell_history_5m: int | None = Field(
    alias="sellHistory5m", default=None
)

sell_5m_change_percent `class-attribute` `instance-attribute` ¶

sell_5m_change_percent: float | None = Field(
    alias="sell5mChangePercent", default=None
)

buy_5m `class-attribute` `instance-attribute` ¶

buy_5m: int | None = Field(alias='buy5m', default=None)

buy_history_5m `class-attribute` `instance-attribute` ¶

buy_history_5m: int | None = Field(
    alias="buyHistory5m", default=None
)

buy_5m_change_percent `class-attribute` `instance-attribute` ¶

buy_5m_change_percent: float | None = Field(
    alias="buy5mChangePercent", default=None
)

volume_5m `class-attribute` `instance-attribute` ¶

volume_5m: float | None = Field(alias='v5m', default=None)

volume_5m_usd `class-attribute` `instance-attribute` ¶

volume_5m_usd: float | None = Field(
    alias="v5mUSD", default=None
)

volume_history_5m `class-attribute` `instance-attribute` ¶

volume_history_5m: float | None = Field(
    alias="vHistory5m", default=None
)

volume_history_5m_usd `class-attribute` `instance-attribute` ¶

volume_history_5m_usd: float | None = Field(
    alias="vHistory5mUSD", default=None
)

volume_5m_change_percent `class-attribute` `instance-attribute` ¶

volume_5m_change_percent: float | None = Field(
    alias="v5mChangePercent", default=None
)

volume_buy_5m `class-attribute` `instance-attribute` ¶

volume_buy_5m: float | None = Field(
    alias="vBuy5m", default=None
)

volume_buy_5m_usd `class-attribute` `instance-attribute` ¶

volume_buy_5m_usd: float | None = Field(
    alias="vBuy5mUSD", default=None
)

volume_buy_history_5m `class-attribute` `instance-attribute` ¶

volume_buy_history_5m: float | None = Field(
    alias="vBuyHistory5m", default=None
)

volume_buy_history_5m_usd `class-attribute` `instance-attribute` ¶

volume_buy_history_5m_usd: float | None = Field(
    alias="vBuyHistory5mUSD", default=None
)

volume_buy_5m_change_percent `class-attribute` `instance-attribute` ¶

volume_buy_5m_change_percent: float | None = Field(
    alias="vBuy5mChangePercent", default=None
)

volume_sell_5m `class-attribute` `instance-attribute` ¶

volume_sell_5m: float | None = Field(
    alias="vSell5m", default=None
)

volume_sell_5m_usd `class-attribute` `instance-attribute` ¶

volume_sell_5m_usd: float | None = Field(
    alias="vSell5mUSD", default=None
)

volume_sell_history_5m `class-attribute` `instance-attribute` ¶

volume_sell_history_5m: float | None = Field(
    alias="vSellHistory5m", default=None
)

volume_sell_history_5m_usd `class-attribute` `instance-attribute` ¶

volume_sell_history_5m_usd: float | None = Field(
    alias="vSellHistory5mUSD", default=None
)

volume_sell_5m_change_percent `class-attribute` `instance-attribute` ¶

volume_sell_5m_change_percent: float | None = Field(
    alias="vSell5mChangePercent", default=None
)

trade_30m `class-attribute` `instance-attribute` ¶

trade_30m: int | None = Field(
    alias="trade30m", default=None
)

trade_history_30m `class-attribute` `instance-attribute` ¶

trade_history_30m: int | None = Field(
    alias="tradeHistory30m", default=None
)

trade_30m_change_percent `class-attribute` `instance-attribute` ¶

trade_30m_change_percent: float | None = Field(
    alias="trade30mChangePercent", default=None
)

sell_30m `class-attribute` `instance-attribute` ¶

sell_30m: int | None = Field(alias='sell30m', default=None)

sell_history_30m `class-attribute` `instance-attribute` ¶

sell_history_30m: int | None = Field(
    alias="sellHistory30m", default=None
)

sell_30m_change_percent `class-attribute` `instance-attribute` ¶

sell_30m_change_percent: float | None = Field(
    alias="sell30mChangePercent", default=None
)

buy_30m `class-attribute` `instance-attribute` ¶

buy_30m: int | None = Field(alias='buy30m', default=None)

buy_history_30m `class-attribute` `instance-attribute` ¶

buy_history_30m: int | None = Field(
    alias="buyHistory30m", default=None
)

buy_30m_change_percent `class-attribute` `instance-attribute` ¶

buy_30m_change_percent: float | None = Field(
    alias="buy30mChangePercent", default=None
)

volume_30m `class-attribute` `instance-attribute` ¶

volume_30m: float | None = Field(alias="v30m", default=None)

volume_30m_usd `class-attribute` `instance-attribute` ¶

volume_30m_usd: float | None = Field(
    alias="v30mUSD", default=None
)

volume_history_30m `class-attribute` `instance-attribute` ¶

volume_history_30m: float | None = Field(
    alias="vHistory30m", default=None
)

volume_history_30m_usd `class-attribute` `instance-attribute` ¶

volume_history_30m_usd: float | None = Field(
    alias="vHistory30mUSD", default=None
)

volume_30m_change_percent `class-attribute` `instance-attribute` ¶

volume_30m_change_percent: float | None = Field(
    alias="v30mChangePercent", default=None
)

volume_buy_30m `class-attribute` `instance-attribute` ¶

volume_buy_30m: float | None = Field(
    alias="vBuy30m", default=None
)

volume_buy_30m_usd `class-attribute` `instance-attribute` ¶

volume_buy_30m_usd: float | None = Field(
    alias="vBuy30mUSD", default=None
)

volume_buy_history_30m `class-attribute` `instance-attribute` ¶

volume_buy_history_30m: float | None = Field(
    alias="vBuyHistory30m", default=None
)

volume_buy_history_30m_usd `class-attribute` `instance-attribute` ¶

volume_buy_history_30m_usd: float | None = Field(
    alias="vBuyHistory30mUSD", default=None
)

volume_buy_30m_change_percent `class-attribute` `instance-attribute` ¶

volume_buy_30m_change_percent: float | None = Field(
    alias="vBuy30mChangePercent", default=None
)

volume_sell_30m `class-attribute` `instance-attribute` ¶

volume_sell_30m: float | None = Field(
    alias="vSell30m", default=None
)

volume_sell_30m_usd `class-attribute` `instance-attribute` ¶

volume_sell_30m_usd: float | None = Field(
    alias="vSell30mUSD", default=None
)

volume_sell_history_30m `class-attribute` `instance-attribute` ¶

volume_sell_history_30m: float | None = Field(
    alias="vSellHistory30m", default=None
)

volume_sell_history_30m_usd `class-attribute` `instance-attribute` ¶

volume_sell_history_30m_usd: float | None = Field(
    alias="vSellHistory30mUSD", default=None
)

volume_sell_30m_change_percent `class-attribute` `instance-attribute` ¶

volume_sell_30m_change_percent: float | None = Field(
    alias="vSell30mChangePercent", default=None
)

trade_1h `class-attribute` `instance-attribute` ¶

trade_1h: int | None = Field(alias='trade1h', default=None)

trade_history_1h `class-attribute` `instance-attribute` ¶

trade_history_1h: int | None = Field(
    alias="tradeHistory1h", default=None
)

trade_1h_change_percent `class-attribute` `instance-attribute` ¶

trade_1h_change_percent: float | None = Field(
    alias="trade1hChangePercent", default=None
)

sell_1h `class-attribute` `instance-attribute` ¶

sell_1h: int | None = Field(alias='sell1h', default=None)

sell_history_1h `class-attribute` `instance-attribute` ¶

sell_history_1h: int | None = Field(
    alias="sellHistory1h", default=None
)

sell_1h_change_percent `class-attribute` `instance-attribute` ¶

sell_1h_change_percent: float | None = Field(
    alias="sell1hChangePercent", default=None
)

buy_1h `class-attribute` `instance-attribute` ¶

buy_1h: int | None = Field(alias='buy1h', default=None)

buy_history_1h `class-attribute` `instance-attribute` ¶

buy_history_1h: int | None = Field(
    alias="buyHistory1h", default=None
)

buy_1h_change_percent `class-attribute` `instance-attribute` ¶

buy_1h_change_percent: float | None = Field(
    alias="buy1hChangePercent", default=None
)

volume_1h `class-attribute` `instance-attribute` ¶

volume_1h: float | None = Field(alias='v1h', default=None)

volume_1h_usd `class-attribute` `instance-attribute` ¶

volume_1h_usd: float | None = Field(
    alias="v1hUSD", default=None
)

volume_history_1h `class-attribute` `instance-attribute` ¶

volume_history_1h: float | None = Field(
    alias="vHistory1h", default=None
)

volume_history_1h_usd `class-attribute` `instance-attribute` ¶

volume_history_1h_usd: float | None = Field(
    alias="vHistory1hUSD", default=None
)

volume_1h_change_percent `class-attribute` `instance-attribute` ¶

volume_1h_change_percent: float | None = Field(
    alias="v1hChangePercent", default=None
)

volume_buy_1h `class-attribute` `instance-attribute` ¶

volume_buy_1h: float | None = Field(
    alias="vBuy1h", default=None
)

volume_buy_1h_usd `class-attribute` `instance-attribute` ¶

volume_buy_1h_usd: float | None = Field(
    alias="vBuy1hUSD", default=None
)

volume_buy_history_1h `class-attribute` `instance-attribute` ¶

volume_buy_history_1h: float | None = Field(
    alias="vBuyHistory1h", default=None
)

volume_buy_history_1h_usd `class-attribute` `instance-attribute` ¶

volume_buy_history_1h_usd: float | None = Field(
    alias="vBuyHistory1hUSD", default=None
)

volume_buy_1h_change_percent `class-attribute` `instance-attribute` ¶

volume_buy_1h_change_percent: float | None = Field(
    alias="vBuy1hChangePercent", default=None
)

volume_sell_1h `class-attribute` `instance-attribute` ¶

volume_sell_1h: float | None = Field(
    alias="vSell1h", default=None
)

volume_sell_1h_usd `class-attribute` `instance-attribute` ¶

volume_sell_1h_usd: float | None = Field(
    alias="vSell1hUSD", default=None
)

volume_sell_history_1h `class-attribute` `instance-attribute` ¶

volume_sell_history_1h: float | None = Field(
    alias="vSellHistory1h", default=None
)

volume_sell_history_1h_usd `class-attribute` `instance-attribute` ¶

volume_sell_history_1h_usd: float | None = Field(
    alias="vSellHistory1hUSD", default=None
)

volume_sell_1h_change_percent `class-attribute` `instance-attribute` ¶

volume_sell_1h_change_percent: float | None = Field(
    alias="vSell1hChangePercent", default=None
)

trade_2h `class-attribute` `instance-attribute` ¶

trade_2h: int | None = Field(alias='trade2h', default=None)

trade_history_2h `class-attribute` `instance-attribute` ¶

trade_history_2h: int | None = Field(
    alias="tradeHistory2h", default=None
)

trade_2h_change_percent `class-attribute` `instance-attribute` ¶

trade_2h_change_percent: float | None = Field(
    alias="trade2hChangePercent", default=None
)

sell_2h `class-attribute` `instance-attribute` ¶

sell_2h: int | None = Field(alias='sell2h', default=None)

sell_history_2h `class-attribute` `instance-attribute` ¶

sell_history_2h: int | None = Field(
    alias="sellHistory2h", default=None
)

sell_2h_change_percent `class-attribute` `instance-attribute` ¶

sell_2h_change_percent: float | None = Field(
    alias="sell2hChangePercent", default=None
)

buy_2h `class-attribute` `instance-attribute` ¶

buy_2h: int | None = Field(alias='buy2h', default=None)

buy_history_2h `class-attribute` `instance-attribute` ¶

buy_history_2h: int | None = Field(
    alias="buyHistory2h", default=None
)

buy_2h_change_percent `class-attribute` `instance-attribute` ¶

buy_2h_change_percent: float | None = Field(
    alias="buy2hChangePercent", default=None
)

volume_2h `class-attribute` `instance-attribute` ¶

volume_2h: float | None = Field(alias='v2h', default=None)

volume_2h_usd `class-attribute` `instance-attribute` ¶

volume_2h_usd: float | None = Field(
    alias="v2hUSD", default=None
)

volume_history_2h `class-attribute` `instance-attribute` ¶

volume_history_2h: float | None = Field(
    alias="vHistory2h", default=None
)

volume_history_2h_usd `class-attribute` `instance-attribute` ¶

volume_history_2h_usd: float | None = Field(
    alias="vHistory2hUSD", default=None
)

volume_2h_change_percent `class-attribute` `instance-attribute` ¶

volume_2h_change_percent: float | None = Field(
    alias="v2hChangePercent", default=None
)

volume_buy_2h `class-attribute` `instance-attribute` ¶

volume_buy_2h: float | None = Field(
    alias="vBuy2h", default=None
)

volume_buy_2h_usd `class-attribute` `instance-attribute` ¶

volume_buy_2h_usd: float | None = Field(
    alias="vBuy2hUSD", default=None
)

volume_buy_history_2h `class-attribute` `instance-attribute` ¶

volume_buy_history_2h: float | None = Field(
    alias="vBuyHistory2h", default=None
)

volume_buy_history_2h_usd `class-attribute` `instance-attribute` ¶

volume_buy_history_2h_usd: float | None = Field(
    alias="vBuyHistory2hUSD", default=None
)

volume_buy_2h_change_percent `class-attribute` `instance-attribute` ¶

volume_buy_2h_change_percent: float | None = Field(
    alias="vBuy2hChangePercent", default=None
)

volume_sell_2h `class-attribute` `instance-attribute` ¶

volume_sell_2h: float | None = Field(
    alias="vSell2h", default=None
)

volume_sell_2h_usd `class-attribute` `instance-attribute` ¶

volume_sell_2h_usd: float | None = Field(
    alias="vSell2hUSD", default=None
)

volume_sell_history_2h `class-attribute` `instance-attribute` ¶

volume_sell_history_2h: float | None = Field(
    alias="vSellHistory2h", default=None
)

volume_sell_history_2h_usd `class-attribute` `instance-attribute` ¶

volume_sell_history_2h_usd: float | None = Field(
    alias="vSellHistory2hUSD", default=None
)

volume_sell_2h_change_percent `class-attribute` `instance-attribute` ¶

volume_sell_2h_change_percent: float | None = Field(
    alias="vSell2hChangePercent", default=None
)

trade_4h `class-attribute` `instance-attribute` ¶

trade_4h: int | None = Field(alias='trade4h', default=None)

trade_history_4h `class-attribute` `instance-attribute` ¶

trade_history_4h: int | None = Field(
    alias="tradeHistory4h", default=None
)

trade_4h_change_percent `class-attribute` `instance-attribute` ¶

trade_4h_change_percent: float | None = Field(
    alias="trade4hChangePercent", default=None
)

sell_4h `class-attribute` `instance-attribute` ¶

sell_4h: int | None = Field(alias='sell4h', default=None)

sell_history_4h `class-attribute` `instance-attribute` ¶

sell_history_4h: int | None = Field(
    alias="sellHistory4h", default=None
)

sell_4h_change_percent `class-attribute` `instance-attribute` ¶

sell_4h_change_percent: float | None = Field(
    alias="sell4hChangePercent", default=None
)

buy_4h `class-attribute` `instance-attribute` ¶

buy_4h: int | None = Field(alias='buy4h', default=None)

buy_history_4h `class-attribute` `instance-attribute` ¶

buy_history_4h: int | None = Field(
    alias="buyHistory4h", default=None
)

buy_4h_change_percent `class-attribute` `instance-attribute` ¶

buy_4h_change_percent: float | None = Field(
    alias="buy4hChangePercent", default=None
)

volume_4h `class-attribute` `instance-attribute` ¶

volume_4h: float | None = Field(alias='v4h', default=None)

volume_4h_usd `class-attribute` `instance-attribute` ¶

volume_4h_usd: float | None = Field(
    alias="v4hUSD", default=None
)

volume_history_4h `class-attribute` `instance-attribute` ¶

volume_history_4h: float | None = Field(
    alias="vHistory4h", default=None
)

volume_history_4h_usd `class-attribute` `instance-attribute` ¶

volume_history_4h_usd: float | None = Field(
    alias="vHistory4hUSD", default=None
)

volume_4h_change_percent `class-attribute` `instance-attribute` ¶

volume_4h_change_percent: float | None = Field(
    alias="v4hChangePercent", default=None
)

volume_buy_4h `class-attribute` `instance-attribute` ¶

volume_buy_4h: float | None = Field(
    alias="vBuy4h", default=None
)

volume_buy_4h_usd `class-attribute` `instance-attribute` ¶

volume_buy_4h_usd: float | None = Field(
    alias="vBuy4hUSD", default=None
)

volume_buy_history_4h `class-attribute` `instance-attribute` ¶

volume_buy_history_4h: float | None = Field(
    alias="vBuyHistory4h", default=None
)

volume_buy_history_4h_usd `class-attribute` `instance-attribute` ¶

volume_buy_history_4h_usd: float | None = Field(
    alias="vBuyHistory4hUSD", default=None
)

volume_buy_4h_change_percent `class-attribute` `instance-attribute` ¶

volume_buy_4h_change_percent: float | None = Field(
    alias="vBuy4hChangePercent", default=None
)

volume_sell_4h `class-attribute` `instance-attribute` ¶

volume_sell_4h: float | None = Field(
    alias="vSell4h", default=None
)

volume_sell_4h_usd `class-attribute` `instance-attribute` ¶

volume_sell_4h_usd: float | None = Field(
    alias="vSell4hUSD", default=None
)

volume_sell_history_4h `class-attribute` `instance-attribute` ¶

volume_sell_history_4h: float | None = Field(
    alias="vSellHistory4h", default=None
)

volume_sell_history_4h_usd `class-attribute` `instance-attribute` ¶

volume_sell_history_4h_usd: float | None = Field(
    alias="vSellHistory4hUSD", default=None
)

volume_sell_4h_change_percent `class-attribute` `instance-attribute` ¶

volume_sell_4h_change_percent: float | None = Field(
    alias="vSell4hChangePercent", default=None
)

trade_8h `class-attribute` `instance-attribute` ¶

trade_8h: int | None = Field(alias='trade8h', default=None)

trade_history_8h `class-attribute` `instance-attribute` ¶

trade_history_8h: int | None = Field(
    alias="tradeHistory8h", default=None
)

trade_8h_change_percent `class-attribute` `instance-attribute` ¶

trade_8h_change_percent: float | None = Field(
    alias="trade8hChangePercent", default=None
)

sell_8h `class-attribute` `instance-attribute` ¶

sell_8h: int | None = Field(alias='sell8h', default=None)

sell_history_8h `class-attribute` `instance-attribute` ¶

sell_history_8h: int | None = Field(
    alias="sellHistory8h", default=None
)

sell_8h_change_percent `class-attribute` `instance-attribute` ¶

sell_8h_change_percent: float | None = Field(
    alias="sell8hChangePercent", default=None
)

buy_8h `class-attribute` `instance-attribute` ¶

buy_8h: int | None = Field(alias='buy8h', default=None)

buy_history_8h `class-attribute` `instance-attribute` ¶

buy_history_8h: int | None = Field(
    alias="buyHistory8h", default=None
)

buy_8h_change_percent `class-attribute` `instance-attribute` ¶

buy_8h_change_percent: float | None = Field(
    alias="buy8hChangePercent", default=None
)

volume_8h `class-attribute` `instance-attribute` ¶

volume_8h: float | None = Field(alias='v8h', default=None)

volume_8h_usd `class-attribute` `instance-attribute` ¶

volume_8h_usd: float | None = Field(
    alias="v8hUSD", default=None
)

volume_history_8h `class-attribute` `instance-attribute` ¶

volume_history_8h: float | None = Field(
    alias="vHistory8h", default=None
)

volume_history_8h_usd `class-attribute` `instance-attribute` ¶

volume_history_8h_usd: float | None = Field(
    alias="vHistory8hUSD", default=None
)

volume_8h_change_percent `class-attribute` `instance-attribute` ¶

volume_8h_change_percent: float | None = Field(
    alias="v8hChangePercent", default=None
)

volume_buy_8h `class-attribute` `instance-attribute` ¶

volume_buy_8h: float | None = Field(
    alias="vBuy8h", default=None
)

volume_buy_8h_usd `class-attribute` `instance-attribute` ¶

volume_buy_8h_usd: float | None = Field(
    alias="vBuy8hUSD", default=None
)

volume_buy_history_8h `class-attribute` `instance-attribute` ¶

volume_buy_history_8h: float | None = Field(
    alias="vBuyHistory8h", default=None
)

volume_buy_history_8h_usd `class-attribute` `instance-attribute` ¶

volume_buy_history_8h_usd: float | None = Field(
    alias="vBuyHistory8hUSD", default=None
)

volume_buy_8h_change_percent `class-attribute` `instance-attribute` ¶

volume_buy_8h_change_percent: float | None = Field(
    alias="vBuy8hChangePercent", default=None
)

volume_sell_8h `class-attribute` `instance-attribute` ¶

volume_sell_8h: float | None = Field(
    alias="vSell8h", default=None
)

volume_sell_8h_usd `class-attribute` `instance-attribute` ¶

volume_sell_8h_usd: float | None = Field(
    alias="vSell8hUSD", default=None
)

volume_sell_history_8h `class-attribute` `instance-attribute` ¶

volume_sell_history_8h: float | None = Field(
    alias="vSellHistory8h", default=None
)

volume_sell_history_8h_usd `class-attribute` `instance-attribute` ¶

volume_sell_history_8h_usd: float | None = Field(
    alias="vSellHistory8hUSD", default=None
)

volume_sell_8h_change_percent `class-attribute` `instance-attribute` ¶

volume_sell_8h_change_percent: float | None = Field(
    alias="vSell8hChangePercent", default=None
)

trade_24h `class-attribute` `instance-attribute` ¶

trade_24h: int | None = Field(
    alias="trade24h", default=None
)

trade_history_24h `class-attribute` `instance-attribute` ¶

trade_history_24h: int | None = Field(
    alias="tradeHistory24h", default=None
)

trade_24h_change_percent `class-attribute` `instance-attribute` ¶

trade_24h_change_percent: float | None = Field(
    alias="trade24hChangePercent", default=None
)

sell_24h `class-attribute` `instance-attribute` ¶

sell_24h: int | None = Field(alias='sell24h', default=None)

sell_history_24h `class-attribute` `instance-attribute` ¶

sell_history_24h: int | None = Field(
    alias="sellHistory24h", default=None
)

sell_24h_change_percent `class-attribute` `instance-attribute` ¶

sell_24h_change_percent: float | None = Field(
    alias="sell24hChangePercent", default=None
)

buy_24h `class-attribute` `instance-attribute` ¶

buy_24h: int | None = Field(alias='buy24h', default=None)

buy_history_24h `class-attribute` `instance-attribute` ¶

buy_history_24h: int | None = Field(
    alias="buyHistory24h", default=None
)

buy_24h_change_percent `class-attribute` `instance-attribute` ¶

buy_24h_change_percent: float | None = Field(
    alias="buy24hChangePercent", default=None
)

volume_24h `class-attribute` `instance-attribute` ¶

volume_24h: float | None = Field(alias="v24h", default=None)

volume_24h_usd `class-attribute` `instance-attribute` ¶

volume_24h_usd: float | None = Field(
    alias="v24hUSD", default=None
)

volume_history_24h `class-attribute` `instance-attribute` ¶

volume_history_24h: float | None = Field(
    alias="vHistory24h", default=None
)

volume_history_24h_usd `class-attribute` `instance-attribute` ¶

volume_history_24h_usd: float | None = Field(
    alias="vHistory24hUSD", default=None
)

volume_24h_change_percent `class-attribute` `instance-attribute` ¶

volume_24h_change_percent: float | None = Field(
    alias="v24hChangePercent", default=None
)

volume_buy_24h `class-attribute` `instance-attribute` ¶

volume_buy_24h: float | None = Field(
    alias="vBuy24h", default=None
)

volume_buy_24h_usd `class-attribute` `instance-attribute` ¶

volume_buy_24h_usd: float | None = Field(
    alias="vBuy24hUSD", default=None
)

volume_buy_history_24h `class-attribute` `instance-attribute` ¶

volume_buy_history_24h: float | None = Field(
    alias="vBuyHistory24h", default=None
)

volume_buy_history_24h_usd `class-attribute` `instance-attribute` ¶

volume_buy_history_24h_usd: float | None = Field(
    alias="vBuyHistory24hUSD", default=None
)

volume_buy_24h_change_percent `class-attribute` `instance-attribute` ¶

volume_buy_24h_change_percent: float | None = Field(
    alias="vBuy24hChangePercent", default=None
)

volume_sell_24h `class-attribute` `instance-attribute` ¶

volume_sell_24h: float | None = Field(
    alias="vSell24h", default=None
)

volume_sell_24h_usd `class-attribute` `instance-attribute` ¶

volume_sell_24h_usd: float | None = Field(
    alias="vSell24hUSD", default=None
)

volume_sell_history_24h `class-attribute` `instance-attribute` ¶

volume_sell_history_24h: float | None = Field(
    alias="vSellHistory24h", default=None
)

volume_sell_history_24h_usd `class-attribute` `instance-attribute` ¶

volume_sell_history_24h_usd: float | None = Field(
    alias="vSellHistory24hUSD", default=None
)

volume_sell_24h_change_percent `class-attribute` `instance-attribute` ¶

volume_sell_24h_change_percent: float | None = Field(
    alias="vSell24hChangePercent", default=None
)

number_markets `class-attribute` `instance-attribute` ¶

number_markets: int | None = Field(
    alias="numberMarkets", default=None
)

is_scaled_ui_token `class-attribute` `instance-attribute` ¶

is_scaled_ui_token: bool | None = Field(
    alias="isScaledUiToken", default=None
)

multiplier `class-attribute` `instance-attribute` ¶

multiplier: float | None = None

parse_last_trade_human_time ¶

parse_last_trade_human_time(
    dt_raw: str | datetime,
) -> datetime

Source code in src/cyhole/birdeye/schema/token_stats.py

@field_validator("last_trade_human_time")
def parse_last_trade_human_time(cls, dt_raw: str | datetime) -> datetime:
    if isinstance(dt_raw, str):
        return datetime.fromisoformat(dt_raw.replace("Z", "+00:00"))
    return dt_raw

GetTokenOverviewResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetTokenOverviewResponse[GetTokenOverviewResponse]

              

              click cyhole.birdeye.schema.GetTokenOverviewResponse href "" "cyhole.birdeye.schema.GetTokenOverviewResponse"

Model used to represent the Token - Overview endpoint from birdeye API.

Attributes:

Name	Type	Description
`data`	`GetTokenOverviewData`	token analytics payload (identity, price, liquidity, supply, per-window trade/volume activity, etc.).
`success`	`bool`	`True` when the API call completed without errors.

data `instance-attribute` ¶

data: GetTokenOverviewData

success `instance-attribute` ¶

success: bool

GetV3TokenMetaDataItem ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenMetaDataItem[GetV3TokenMetaDataItem]

              

              click cyhole.birdeye.schema.GetV3TokenMetaDataItem href "" "cyhole.birdeye.schema.GetV3TokenMetaDataItem"

Metadata payload of a single token returned by the v3 Token - Metadata endpoint (whether the single-address or multiple-address variant was called).

Attributes:

Name	Type	Description
`address`	`str`	contract address of the token on the selected chain.
`symbol`	`str \| None`	ticker symbol of the token; `None` if unknown.
`name`	`str \| None`	human-readable name of the token; `None` if unknown.
`decimals`	`int`	number of decimal places used by the token.
`extensions`	`dict[str, str \| None] \| None`	free-form metadata bag (CoinGecko id, website, social links, ...); individual values may be `None`. `None` itself when Birdeye has no extra metadata.
`logo_uri`	`str \| None`	URL of the token logo; `None` if Birdeye has no logo for the token.

address `instance-attribute` ¶

address: str

symbol `class-attribute` `instance-attribute` ¶

symbol: str | None = None

name `class-attribute` `instance-attribute` ¶

name: str | None = None

decimals `instance-attribute` ¶

decimals: int

extensions `class-attribute` `instance-attribute` ¶

extensions: dict[str, str | None] | None = None

logo_uri `class-attribute` `instance-attribute` ¶

logo_uri: str | None = None

GetV3TokenMetaDataResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenMetaDataResponse[GetV3TokenMetaDataResponse]

              

              click cyhole.birdeye.schema.GetV3TokenMetaDataResponse href "" "cyhole.birdeye.schema.GetV3TokenMetaDataResponse"

Model used to represent the Token - Metadata (Single) endpoint from birdeye API.

Attributes:

Name	Type	Description
`data`	`GetV3TokenMetaDataItem`	metadata of the requested token.
`success`	`bool`	`True` when the API call completed without errors.

data `instance-attribute` ¶

data: GetV3TokenMetaDataItem

success `instance-attribute` ¶

success: bool

GetV3TokenMetaDataMultipleResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenMetaDataMultipleResponse[GetV3TokenMetaDataMultipleResponse]

              

              click cyhole.birdeye.schema.GetV3TokenMetaDataMultipleResponse href "" "cyhole.birdeye.schema.GetV3TokenMetaDataMultipleResponse"

Model used to represent the Token - Metadata (Multiple) endpoint from birdeye API.

Attributes:

Name	Type	Description
`data`	`dict[str, GetV3TokenMetaDataItem]`	dictionary keyed by token contract address; each value is the metadata payload for that token. Addresses that Birdeye does not recognise are omitted from the dict.
`success`	`bool`	`True` when the API call completed without errors.

data `instance-attribute` ¶

data: dict[str, GetV3TokenMetaDataItem]

success `instance-attribute` ¶

success: bool

GetV3TokenMarketDataItem ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenMarketDataItem[GetV3TokenMarketDataItem]

              

              click cyhole.birdeye.schema.GetV3TokenMarketDataItem href "" "cyhole.birdeye.schema.GetV3TokenMarketDataItem"

Per-token market snapshot returned by the v3 Token - Market Data endpoints.

Attributes:

Name	Type	Description
`address`	`str`	contract address of the token on the selected chain.
`price`	`float \| None`	latest known price of the token in USD; `None` if no price datapoint is available.
`liquidity`	`float \| None`	total on-chain liquidity of the token in USD; `None` if undetermined.
`total_supply`	`float \| None`	total on-chain supply of the token in UI units; `None` if undetermined.
`circulating_supply`	`float \| None`	currently circulating supply of the token in UI units; `None` if undetermined.
`fdv`	`float \| None`	fully-diluted valuation in USD; `None` when Birdeye cannot compute it.
`market_cap`	`float \| None`	current market capitalisation in USD; `None` when Birdeye cannot compute it.
`holder`	`int \| None`	number of distinct holders of the token; `None` if undetermined.
`is_scaled_ui_token`	`bool \| None`	`True` when the token is a scaled-UI-amount SPL token (Solana only); `None` outside Solana or when undetermined.
`multiplier`	`float \| None`	scaling multiplier applied by the API to UI amounts of scaled-UI-amount tokens; `None` when not applicable.

address `instance-attribute` ¶

address: str

price `class-attribute` `instance-attribute` ¶

price: float | None = None

liquidity `class-attribute` `instance-attribute` ¶

liquidity: float | None = None

total_supply `class-attribute` `instance-attribute` ¶

total_supply: float | None = None

circulating_supply `class-attribute` `instance-attribute` ¶

circulating_supply: float | None = None

fdv `class-attribute` `instance-attribute` ¶

fdv: float | None = None

market_cap `class-attribute` `instance-attribute` ¶

market_cap: float | None = None

holder `class-attribute` `instance-attribute` ¶

holder: int | None = None

is_scaled_ui_token `class-attribute` `instance-attribute` ¶

is_scaled_ui_token: bool | None = None

multiplier `class-attribute` `instance-attribute` ¶

multiplier: float | None = None

GetV3TokenMarketDataResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenMarketDataResponse[GetV3TokenMarketDataResponse]

              

              click cyhole.birdeye.schema.GetV3TokenMarketDataResponse href "" "cyhole.birdeye.schema.GetV3TokenMarketDataResponse"

Model used to represent the Token - Market Data (Single) endpoint from birdeye API.

Attributes:

Name	Type	Description
`data`	`GetV3TokenMarketDataItem`	market snapshot of the requested token.
`success`	`bool`	`True` when the API call completed without errors.

data `instance-attribute` ¶

data: GetV3TokenMarketDataItem

success `instance-attribute` ¶

success: bool

GetV3TokenMarketDataMultipleResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenMarketDataMultipleResponse[GetV3TokenMarketDataMultipleResponse]

              

              click cyhole.birdeye.schema.GetV3TokenMarketDataMultipleResponse href "" "cyhole.birdeye.schema.GetV3TokenMarketDataMultipleResponse"

Model used to represent the Token - Market Data (Multiple) endpoint from birdeye API.

Attributes:

Name	Type	Description
`data`	`dict[str, GetV3TokenMarketDataItem]`	dictionary keyed by token contract address; each value is the market snapshot for that token. Unrecognised addresses are omitted from the dict.
`success`	`bool`	`True` when the API call completed without errors.

data `instance-attribute` ¶

data: dict[str, GetV3TokenMarketDataItem]

success `instance-attribute` ¶

success: bool

GetV3TokenTradeDataItem ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenTradeDataItem[GetV3TokenTradeDataItem]

              

              click cyhole.birdeye.schema.GetV3TokenTradeDataItem href "" "cyhole.birdeye.schema.GetV3TokenTradeDataItem"

Per-token trading-activity snapshot returned by the v3 Token - Trade Data endpoints.

Bundles holder count, market count, latest price, price history at 1m/5m/30m/1h/2h/4h/6h/8h/12h/24h windows together with per-window (1m/5m/30m/1h/2h/4h/8h/24h) unique-wallet counts and full sell/buy/volume breakdowns vs the previous window. All field names are snake_case to mirror the API's JSON shape; no aliases are needed.

Attributes:

Name	Type	Description
`address`	`str`	contract address of the token on the selected chain.
`holder`	`int \| None`	number of distinct holders of the token; `None` if undetermined.
`market`	`int \| None`	number of active markets (trading pairs) Birdeye tracks for the token; `None` if undetermined.
`last_trade_unix_time`	`int \| None`	unix-second timestamp of the last observed trade; `None` if no trades have been recorded.
`last_trade_human_time`	`datetime \| None`	ISO-8601 timestamp of the last observed trade; `None` if no trades have been recorded.
`price`	`float \| None`	latest known price of the token in USD; `None` if no price datapoint is available.
`history_1m_price`	`float \| None`	snapshot price of the token in USD at the start of the trailing 1m window; `None` if no datapoint for that window.
`price_change_1m_percent`	`float \| None`	price change vs the start of the trailing 1m window expressed in percent; `None` if the change cannot be computed.
`history_5m_price`	`float \| None`	snapshot price of the token in USD at the start of the trailing 5m window; `None` if no datapoint for that window.
`price_change_5m_percent`	`float \| None`	price change vs the start of the trailing 5m window expressed in percent; `None` if the change cannot be computed.
`history_30m_price`	`float \| None`	snapshot price of the token in USD at the start of the trailing 30m window; `None` if no datapoint for that window.
`price_change_30m_percent`	`float \| None`	price change vs the start of the trailing 30m window expressed in percent; `None` if the change cannot be computed.
`history_1h_price`	`float \| None`	snapshot price of the token in USD at the start of the trailing 1h window; `None` if no datapoint for that window.
`price_change_1h_percent`	`float \| None`	price change vs the start of the trailing 1h window expressed in percent; `None` if the change cannot be computed.
`history_2h_price`	`float \| None`	snapshot price of the token in USD at the start of the trailing 2h window; `None` if no datapoint for that window.
`price_change_2h_percent`	`float \| None`	price change vs the start of the trailing 2h window expressed in percent; `None` if the change cannot be computed.
`history_4h_price`	`float \| None`	snapshot price of the token in USD at the start of the trailing 4h window; `None` if no datapoint for that window.
`price_change_4h_percent`	`float \| None`	price change vs the start of the trailing 4h window expressed in percent; `None` if the change cannot be computed.
`history_6h_price`	`float \| None`	snapshot price of the token in USD at the start of the trailing 6h window; `None` if no datapoint for that window.
`price_change_6h_percent`	`float \| None`	price change vs the start of the trailing 6h window expressed in percent; `None` if the change cannot be computed.
`history_8h_price`	`float \| None`	snapshot price of the token in USD at the start of the trailing 8h window; `None` if no datapoint for that window.
`price_change_8h_percent`	`float \| None`	price change vs the start of the trailing 8h window expressed in percent; `None` if the change cannot be computed.
`history_12h_price`	`float \| None`	snapshot price of the token in USD at the start of the trailing 12h window; `None` if no datapoint for that window.
`price_change_12h_percent`	`float \| None`	price change vs the start of the trailing 12h window expressed in percent; `None` if the change cannot be computed.
`history_24h_price`	`float \| None`	snapshot price of the token in USD at the start of the trailing 24h window; `None` if no datapoint for that window.
`price_change_24h_percent`	`float \| None`	price change vs the start of the trailing 24h window expressed in percent; `None` if the change cannot be computed.
`unique_wallet_1m`	`int \| None`	count of unique wallets that traded the token during the trailing 1m window.
`unique_wallet_history_1m`	`int \| None`	count of unique wallets that traded the token during the previous 1m window.
`unique_wallet_1m_change_percent`	`float \| None`	percent change of unique wallets between the current and previous 1m windows; `None` if it cannot be computed.
`unique_wallet_5m`	`int \| None`	count of unique wallets that traded the token during the trailing 5m window.
`unique_wallet_history_5m`	`int \| None`	count of unique wallets that traded the token during the previous 5m window.
`unique_wallet_5m_change_percent`	`float \| None`	percent change of unique wallets between the current and previous 5m windows; `None` if it cannot be computed.
`unique_wallet_30m`	`int \| None`	count of unique wallets that traded the token during the trailing 30m window.
`unique_wallet_history_30m`	`int \| None`	count of unique wallets that traded the token during the previous 30m window.
`unique_wallet_30m_change_percent`	`float \| None`	percent change of unique wallets between the current and previous 30m windows; `None` if it cannot be computed.
`unique_wallet_1h`	`int \| None`	count of unique wallets that traded the token during the trailing 1h window.
`unique_wallet_history_1h`	`int \| None`	count of unique wallets that traded the token during the previous 1h window.
`unique_wallet_1h_change_percent`	`float \| None`	percent change of unique wallets between the current and previous 1h windows; `None` if it cannot be computed.
`unique_wallet_2h`	`int \| None`	count of unique wallets that traded the token during the trailing 2h window.
`unique_wallet_history_2h`	`int \| None`	count of unique wallets that traded the token during the previous 2h window.
`unique_wallet_2h_change_percent`	`float \| None`	percent change of unique wallets between the current and previous 2h windows; `None` if it cannot be computed.
`unique_wallet_4h`	`int \| None`	count of unique wallets that traded the token during the trailing 4h window.
`unique_wallet_history_4h`	`int \| None`	count of unique wallets that traded the token during the previous 4h window.
`unique_wallet_4h_change_percent`	`float \| None`	percent change of unique wallets between the current and previous 4h windows; `None` if it cannot be computed.
`unique_wallet_8h`	`int \| None`	count of unique wallets that traded the token during the trailing 8h window.
`unique_wallet_history_8h`	`int \| None`	count of unique wallets that traded the token during the previous 8h window.
`unique_wallet_8h_change_percent`	`float \| None`	percent change of unique wallets between the current and previous 8h windows; `None` if it cannot be computed.
`unique_wallet_24h`	`int \| None`	count of unique wallets that traded the token during the trailing 24h window.
`unique_wallet_history_24h`	`int \| None`	count of unique wallets that traded the token during the previous 24h window.
`unique_wallet_24h_change_percent`	`float \| None`	percent change of unique wallets between the current and previous 24h windows; `None` if it cannot be computed.
`trade_1m`	`int \| None`	total number of trades during the trailing 1m window.
`trade_history_1m`	`int \| None`	total number of trades during the previous 1m window.
`trade_1m_change_percent`	`float \| None`	percent change of trade count between the current and previous 1m windows.
`sell_1m`	`int \| None`	number of sell trades during the trailing 1m window.
`sell_history_1m`	`int \| None`	number of sell trades during the previous 1m window.
`sell_1m_change_percent`	`float \| None`	percent change of sell count between the current and previous 1m windows.
`buy_1m`	`int \| None`	number of buy trades during the trailing 1m window.
`buy_history_1m`	`int \| None`	number of buy trades during the previous 1m window.
`buy_1m_change_percent`	`float \| None`	percent change of buy count between the current and previous 1m windows.
`volume_1m`	`float \| None`	traded volume during the trailing 1m window in token UI units.
`volume_1m_usd`	`float \| None`	traded volume during the trailing 1m window in USD.
`volume_history_1m`	`float \| None`	traded volume during the previous 1m window in token UI units.
`volume_history_1m_usd`	`float \| None`	traded volume during the previous 1m window in USD.
`volume_1m_change_percent`	`float \| None`	percent change of traded volume between the current and previous 1m windows.
`volume_buy_1m`	`float \| None`	buy-side traded volume during the trailing 1m window in token UI units.
`volume_buy_1m_usd`	`float \| None`	buy-side traded volume during the trailing 1m window in USD.
`volume_buy_history_1m`	`float \| None`	buy-side traded volume during the previous 1m window in token UI units.
`volume_buy_history_1m_usd`	`float \| None`	buy-side traded volume during the previous 1m window in USD.
`volume_buy_1m_change_percent`	`float \| None`	percent change of buy-side traded volume between the current and previous 1m windows.
`volume_sell_1m`	`float \| None`	sell-side traded volume during the trailing 1m window in token UI units.
`volume_sell_1m_usd`	`float \| None`	sell-side traded volume during the trailing 1m window in USD.
`volume_sell_history_1m`	`float \| None`	sell-side traded volume during the previous 1m window in token UI units.
`volume_sell_history_1m_usd`	`float \| None`	sell-side traded volume during the previous 1m window in USD.
`volume_sell_1m_change_percent`	`float \| None`	percent change of sell-side traded volume between the current and previous 1m windows.
`trade_5m`	`int \| None`	total number of trades during the trailing 5m window.
`trade_history_5m`	`int \| None`	total number of trades during the previous 5m window.
`trade_5m_change_percent`	`float \| None`	percent change of trade count between the current and previous 5m windows.
`sell_5m`	`int \| None`	number of sell trades during the trailing 5m window.
`sell_history_5m`	`int \| None`	number of sell trades during the previous 5m window.
`sell_5m_change_percent`	`float \| None`	percent change of sell count between the current and previous 5m windows.
`buy_5m`	`int \| None`	number of buy trades during the trailing 5m window.
`buy_history_5m`	`int \| None`	number of buy trades during the previous 5m window.
`buy_5m_change_percent`	`float \| None`	percent change of buy count between the current and previous 5m windows.
`volume_5m`	`float \| None`	traded volume during the trailing 5m window in token UI units.
`volume_5m_usd`	`float \| None`	traded volume during the trailing 5m window in USD.
`volume_history_5m`	`float \| None`	traded volume during the previous 5m window in token UI units.
`volume_history_5m_usd`	`float \| None`	traded volume during the previous 5m window in USD.
`volume_5m_change_percent`	`float \| None`	percent change of traded volume between the current and previous 5m windows.
`volume_buy_5m`	`float \| None`	buy-side traded volume during the trailing 5m window in token UI units.
`volume_buy_5m_usd`	`float \| None`	buy-side traded volume during the trailing 5m window in USD.
`volume_buy_history_5m`	`float \| None`	buy-side traded volume during the previous 5m window in token UI units.
`volume_buy_history_5m_usd`	`float \| None`	buy-side traded volume during the previous 5m window in USD.
`volume_buy_5m_change_percent`	`float \| None`	percent change of buy-side traded volume between the current and previous 5m windows.
`volume_sell_5m`	`float \| None`	sell-side traded volume during the trailing 5m window in token UI units.
`volume_sell_5m_usd`	`float \| None`	sell-side traded volume during the trailing 5m window in USD.
`volume_sell_history_5m`	`float \| None`	sell-side traded volume during the previous 5m window in token UI units.
`volume_sell_history_5m_usd`	`float \| None`	sell-side traded volume during the previous 5m window in USD.
`volume_sell_5m_change_percent`	`float \| None`	percent change of sell-side traded volume between the current and previous 5m windows.
`trade_30m`	`int \| None`	total number of trades during the trailing 30m window.
`trade_history_30m`	`int \| None`	total number of trades during the previous 30m window.
`trade_30m_change_percent`	`float \| None`	percent change of trade count between the current and previous 30m windows.
`sell_30m`	`int \| None`	number of sell trades during the trailing 30m window.
`sell_history_30m`	`int \| None`	number of sell trades during the previous 30m window.
`sell_30m_change_percent`	`float \| None`	percent change of sell count between the current and previous 30m windows.
`buy_30m`	`int \| None`	number of buy trades during the trailing 30m window.
`buy_history_30m`	`int \| None`	number of buy trades during the previous 30m window.
`buy_30m_change_percent`	`float \| None`	percent change of buy count between the current and previous 30m windows.
`volume_30m`	`float \| None`	traded volume during the trailing 30m window in token UI units.
`volume_30m_usd`	`float \| None`	traded volume during the trailing 30m window in USD.
`volume_history_30m`	`float \| None`	traded volume during the previous 30m window in token UI units.
`volume_history_30m_usd`	`float \| None`	traded volume during the previous 30m window in USD.
`volume_30m_change_percent`	`float \| None`	percent change of traded volume between the current and previous 30m windows.
`volume_buy_30m`	`float \| None`	buy-side traded volume during the trailing 30m window in token UI units.
`volume_buy_30m_usd`	`float \| None`	buy-side traded volume during the trailing 30m window in USD.
`volume_buy_history_30m`	`float \| None`	buy-side traded volume during the previous 30m window in token UI units.
`volume_buy_history_30m_usd`	`float \| None`	buy-side traded volume during the previous 30m window in USD.
`volume_buy_30m_change_percent`	`float \| None`	percent change of buy-side traded volume between the current and previous 30m windows.
`volume_sell_30m`	`float \| None`	sell-side traded volume during the trailing 30m window in token UI units.
`volume_sell_30m_usd`	`float \| None`	sell-side traded volume during the trailing 30m window in USD.
`volume_sell_history_30m`	`float \| None`	sell-side traded volume during the previous 30m window in token UI units.
`volume_sell_history_30m_usd`	`float \| None`	sell-side traded volume during the previous 30m window in USD.
`volume_sell_30m_change_percent`	`float \| None`	percent change of sell-side traded volume between the current and previous 30m windows.
`trade_1h`	`int \| None`	total number of trades during the trailing 1h window.
`trade_history_1h`	`int \| None`	total number of trades during the previous 1h window.
`trade_1h_change_percent`	`float \| None`	percent change of trade count between the current and previous 1h windows.
`sell_1h`	`int \| None`	number of sell trades during the trailing 1h window.
`sell_history_1h`	`int \| None`	number of sell trades during the previous 1h window.
`sell_1h_change_percent`	`float \| None`	percent change of sell count between the current and previous 1h windows.
`buy_1h`	`int \| None`	number of buy trades during the trailing 1h window.
`buy_history_1h`	`int \| None`	number of buy trades during the previous 1h window.
`buy_1h_change_percent`	`float \| None`	percent change of buy count between the current and previous 1h windows.
`volume_1h`	`float \| None`	traded volume during the trailing 1h window in token UI units.
`volume_1h_usd`	`float \| None`	traded volume during the trailing 1h window in USD.
`volume_history_1h`	`float \| None`	traded volume during the previous 1h window in token UI units.
`volume_history_1h_usd`	`float \| None`	traded volume during the previous 1h window in USD.
`volume_1h_change_percent`	`float \| None`	percent change of traded volume between the current and previous 1h windows.
`volume_buy_1h`	`float \| None`	buy-side traded volume during the trailing 1h window in token UI units.
`volume_buy_1h_usd`	`float \| None`	buy-side traded volume during the trailing 1h window in USD.
`volume_buy_history_1h`	`float \| None`	buy-side traded volume during the previous 1h window in token UI units.
`volume_buy_history_1h_usd`	`float \| None`	buy-side traded volume during the previous 1h window in USD.
`volume_buy_1h_change_percent`	`float \| None`	percent change of buy-side traded volume between the current and previous 1h windows.
`volume_sell_1h`	`float \| None`	sell-side traded volume during the trailing 1h window in token UI units.
`volume_sell_1h_usd`	`float \| None`	sell-side traded volume during the trailing 1h window in USD.
`volume_sell_history_1h`	`float \| None`	sell-side traded volume during the previous 1h window in token UI units.
`volume_sell_history_1h_usd`	`float \| None`	sell-side traded volume during the previous 1h window in USD.
`volume_sell_1h_change_percent`	`float \| None`	percent change of sell-side traded volume between the current and previous 1h windows.
`trade_2h`	`int \| None`	total number of trades during the trailing 2h window.
`trade_history_2h`	`int \| None`	total number of trades during the previous 2h window.
`trade_2h_change_percent`	`float \| None`	percent change of trade count between the current and previous 2h windows.
`sell_2h`	`int \| None`	number of sell trades during the trailing 2h window.
`sell_history_2h`	`int \| None`	number of sell trades during the previous 2h window.
`sell_2h_change_percent`	`float \| None`	percent change of sell count between the current and previous 2h windows.
`buy_2h`	`int \| None`	number of buy trades during the trailing 2h window.
`buy_history_2h`	`int \| None`	number of buy trades during the previous 2h window.
`buy_2h_change_percent`	`float \| None`	percent change of buy count between the current and previous 2h windows.
`volume_2h`	`float \| None`	traded volume during the trailing 2h window in token UI units.
`volume_2h_usd`	`float \| None`	traded volume during the trailing 2h window in USD.
`volume_history_2h`	`float \| None`	traded volume during the previous 2h window in token UI units.
`volume_history_2h_usd`	`float \| None`	traded volume during the previous 2h window in USD.
`volume_2h_change_percent`	`float \| None`	percent change of traded volume between the current and previous 2h windows.
`volume_buy_2h`	`float \| None`	buy-side traded volume during the trailing 2h window in token UI units.
`volume_buy_2h_usd`	`float \| None`	buy-side traded volume during the trailing 2h window in USD.
`volume_buy_history_2h`	`float \| None`	buy-side traded volume during the previous 2h window in token UI units.
`volume_buy_history_2h_usd`	`float \| None`	buy-side traded volume during the previous 2h window in USD.
`volume_buy_2h_change_percent`	`float \| None`	percent change of buy-side traded volume between the current and previous 2h windows.
`volume_sell_2h`	`float \| None`	sell-side traded volume during the trailing 2h window in token UI units.
`volume_sell_2h_usd`	`float \| None`	sell-side traded volume during the trailing 2h window in USD.
`volume_sell_history_2h`	`float \| None`	sell-side traded volume during the previous 2h window in token UI units.
`volume_sell_history_2h_usd`	`float \| None`	sell-side traded volume during the previous 2h window in USD.
`volume_sell_2h_change_percent`	`float \| None`	percent change of sell-side traded volume between the current and previous 2h windows.
`trade_4h`	`int \| None`	total number of trades during the trailing 4h window.
`trade_history_4h`	`int \| None`	total number of trades during the previous 4h window.
`trade_4h_change_percent`	`float \| None`	percent change of trade count between the current and previous 4h windows.
`sell_4h`	`int \| None`	number of sell trades during the trailing 4h window.
`sell_history_4h`	`int \| None`	number of sell trades during the previous 4h window.
`sell_4h_change_percent`	`float \| None`	percent change of sell count between the current and previous 4h windows.
`buy_4h`	`int \| None`	number of buy trades during the trailing 4h window.
`buy_history_4h`	`int \| None`	number of buy trades during the previous 4h window.
`buy_4h_change_percent`	`float \| None`	percent change of buy count between the current and previous 4h windows.
`volume_4h`	`float \| None`	traded volume during the trailing 4h window in token UI units.
`volume_4h_usd`	`float \| None`	traded volume during the trailing 4h window in USD.
`volume_history_4h`	`float \| None`	traded volume during the previous 4h window in token UI units.
`volume_history_4h_usd`	`float \| None`	traded volume during the previous 4h window in USD.
`volume_4h_change_percent`	`float \| None`	percent change of traded volume between the current and previous 4h windows.
`volume_buy_4h`	`float \| None`	buy-side traded volume during the trailing 4h window in token UI units.
`volume_buy_4h_usd`	`float \| None`	buy-side traded volume during the trailing 4h window in USD.
`volume_buy_history_4h`	`float \| None`	buy-side traded volume during the previous 4h window in token UI units.
`volume_buy_history_4h_usd`	`float \| None`	buy-side traded volume during the previous 4h window in USD.
`volume_buy_4h_change_percent`	`float \| None`	percent change of buy-side traded volume between the current and previous 4h windows.
`volume_sell_4h`	`float \| None`	sell-side traded volume during the trailing 4h window in token UI units.
`volume_sell_4h_usd`	`float \| None`	sell-side traded volume during the trailing 4h window in USD.
`volume_sell_history_4h`	`float \| None`	sell-side traded volume during the previous 4h window in token UI units.
`volume_sell_history_4h_usd`	`float \| None`	sell-side traded volume during the previous 4h window in USD.
`volume_sell_4h_change_percent`	`float \| None`	percent change of sell-side traded volume between the current and previous 4h windows.
`trade_8h`	`int \| None`	total number of trades during the trailing 8h window.
`trade_history_8h`	`int \| None`	total number of trades during the previous 8h window.
`trade_8h_change_percent`	`float \| None`	percent change of trade count between the current and previous 8h windows.
`sell_8h`	`int \| None`	number of sell trades during the trailing 8h window.
`sell_history_8h`	`int \| None`	number of sell trades during the previous 8h window.
`sell_8h_change_percent`	`float \| None`	percent change of sell count between the current and previous 8h windows.
`buy_8h`	`int \| None`	number of buy trades during the trailing 8h window.
`buy_history_8h`	`int \| None`	number of buy trades during the previous 8h window.
`buy_8h_change_percent`	`float \| None`	percent change of buy count between the current and previous 8h windows.
`volume_8h`	`float \| None`	traded volume during the trailing 8h window in token UI units.
`volume_8h_usd`	`float \| None`	traded volume during the trailing 8h window in USD.
`volume_history_8h`	`float \| None`	traded volume during the previous 8h window in token UI units.
`volume_history_8h_usd`	`float \| None`	traded volume during the previous 8h window in USD.
`volume_8h_change_percent`	`float \| None`	percent change of traded volume between the current and previous 8h windows.
`volume_buy_8h`	`float \| None`	buy-side traded volume during the trailing 8h window in token UI units.
`volume_buy_8h_usd`	`float \| None`	buy-side traded volume during the trailing 8h window in USD.
`volume_buy_history_8h`	`float \| None`	buy-side traded volume during the previous 8h window in token UI units.
`volume_buy_history_8h_usd`	`float \| None`	buy-side traded volume during the previous 8h window in USD.
`volume_buy_8h_change_percent`	`float \| None`	percent change of buy-side traded volume between the current and previous 8h windows.
`volume_sell_8h`	`float \| None`	sell-side traded volume during the trailing 8h window in token UI units.
`volume_sell_8h_usd`	`float \| None`	sell-side traded volume during the trailing 8h window in USD.
`volume_sell_history_8h`	`float \| None`	sell-side traded volume during the previous 8h window in token UI units.
`volume_sell_history_8h_usd`	`float \| None`	sell-side traded volume during the previous 8h window in USD.
`volume_sell_8h_change_percent`	`float \| None`	percent change of sell-side traded volume between the current and previous 8h windows.
`trade_24h`	`int \| None`	total number of trades during the trailing 24h window.
`trade_history_24h`	`int \| None`	total number of trades during the previous 24h window.
`trade_24h_change_percent`	`float \| None`	percent change of trade count between the current and previous 24h windows.
`sell_24h`	`int \| None`	number of sell trades during the trailing 24h window.
`sell_history_24h`	`int \| None`	number of sell trades during the previous 24h window.
`sell_24h_change_percent`	`float \| None`	percent change of sell count between the current and previous 24h windows.
`buy_24h`	`int \| None`	number of buy trades during the trailing 24h window.
`buy_history_24h`	`int \| None`	number of buy trades during the previous 24h window.
`buy_24h_change_percent`	`float \| None`	percent change of buy count between the current and previous 24h windows.
`volume_24h`	`float \| None`	traded volume during the trailing 24h window in token UI units.
`volume_24h_usd`	`float \| None`	traded volume during the trailing 24h window in USD.
`volume_history_24h`	`float \| None`	traded volume during the previous 24h window in token UI units.
`volume_history_24h_usd`	`float \| None`	traded volume during the previous 24h window in USD.
`volume_24h_change_percent`	`float \| None`	percent change of traded volume between the current and previous 24h windows.
`volume_buy_24h`	`float \| None`	buy-side traded volume during the trailing 24h window in token UI units.
`volume_buy_24h_usd`	`float \| None`	buy-side traded volume during the trailing 24h window in USD.
`volume_buy_history_24h`	`float \| None`	buy-side traded volume during the previous 24h window in token UI units.
`volume_buy_history_24h_usd`	`float \| None`	buy-side traded volume during the previous 24h window in USD.
`volume_buy_24h_change_percent`	`float \| None`	percent change of buy-side traded volume between the current and previous 24h windows.
`volume_sell_24h`	`float \| None`	sell-side traded volume during the trailing 24h window in token UI units.
`volume_sell_24h_usd`	`float \| None`	sell-side traded volume during the trailing 24h window in USD.
`volume_sell_history_24h`	`float \| None`	sell-side traded volume during the previous 24h window in token UI units.
`volume_sell_history_24h_usd`	`float \| None`	sell-side traded volume during the previous 24h window in USD.
`volume_sell_24h_change_percent`	`float \| None`	percent change of sell-side traded volume between the current and previous 24h windows.
`is_scaled_ui_token`	`bool \| None`	`True` when the token is a scaled-UI-amount SPL token (Solana only); `None` outside Solana or when undetermined.
`multiplier`	`float \| None`	scaling multiplier applied by the API to UI amounts of scaled-UI-amount tokens; `None` when not applicable.

address `class-attribute` `instance-attribute` ¶

address: str = None

holder `class-attribute` `instance-attribute` ¶

holder: int | None = None

market `class-attribute` `instance-attribute` ¶

market: int | None = None

last_trade_unix_time `class-attribute` `instance-attribute` ¶

last_trade_unix_time: int | None = None

last_trade_human_time `class-attribute` `instance-attribute` ¶

last_trade_human_time: datetime | None = None

price `class-attribute` `instance-attribute` ¶

price: float | None = None

history_1m_price `class-attribute` `instance-attribute` ¶

history_1m_price: float | None = None

price_change_1m_percent `class-attribute` `instance-attribute` ¶

price_change_1m_percent: float | None = None

history_5m_price `class-attribute` `instance-attribute` ¶

history_5m_price: float | None = None

price_change_5m_percent `class-attribute` `instance-attribute` ¶

price_change_5m_percent: float | None = None

history_30m_price `class-attribute` `instance-attribute` ¶

history_30m_price: float | None = None

price_change_30m_percent `class-attribute` `instance-attribute` ¶

price_change_30m_percent: float | None = None

history_1h_price `class-attribute` `instance-attribute` ¶

history_1h_price: float | None = None

price_change_1h_percent `class-attribute` `instance-attribute` ¶

price_change_1h_percent: float | None = None

history_2h_price `class-attribute` `instance-attribute` ¶

history_2h_price: float | None = None

price_change_2h_percent `class-attribute` `instance-attribute` ¶

price_change_2h_percent: float | None = None

history_4h_price `class-attribute` `instance-attribute` ¶

history_4h_price: float | None = None

price_change_4h_percent `class-attribute` `instance-attribute` ¶

price_change_4h_percent: float | None = None

history_6h_price `class-attribute` `instance-attribute` ¶

history_6h_price: float | None = None

price_change_6h_percent `class-attribute` `instance-attribute` ¶

price_change_6h_percent: float | None = None

history_8h_price `class-attribute` `instance-attribute` ¶

history_8h_price: float | None = None

price_change_8h_percent `class-attribute` `instance-attribute` ¶

price_change_8h_percent: float | None = None

history_12h_price `class-attribute` `instance-attribute` ¶

history_12h_price: float | None = None

price_change_12h_percent `class-attribute` `instance-attribute` ¶

price_change_12h_percent: float | None = None

history_24h_price `class-attribute` `instance-attribute` ¶

history_24h_price: float | None = None

price_change_24h_percent `class-attribute` `instance-attribute` ¶

price_change_24h_percent: float | None = None

unique_wallet_1m `class-attribute` `instance-attribute` ¶

unique_wallet_1m: int | None = None

unique_wallet_history_1m `class-attribute` `instance-attribute` ¶

unique_wallet_history_1m: int | None = None

unique_wallet_1m_change_percent `class-attribute` `instance-attribute` ¶

unique_wallet_1m_change_percent: float | None = None

unique_wallet_5m `class-attribute` `instance-attribute` ¶

unique_wallet_5m: int | None = None

unique_wallet_history_5m `class-attribute` `instance-attribute` ¶

unique_wallet_history_5m: int | None = None

unique_wallet_5m_change_percent `class-attribute` `instance-attribute` ¶

unique_wallet_5m_change_percent: float | None = None

unique_wallet_30m `class-attribute` `instance-attribute` ¶

unique_wallet_30m: int | None = None

unique_wallet_history_30m `class-attribute` `instance-attribute` ¶

unique_wallet_history_30m: int | None = None

unique_wallet_30m_change_percent `class-attribute` `instance-attribute` ¶

unique_wallet_30m_change_percent: float | None = None

unique_wallet_1h `class-attribute` `instance-attribute` ¶

unique_wallet_1h: int | None = None

unique_wallet_history_1h `class-attribute` `instance-attribute` ¶

unique_wallet_history_1h: int | None = None

unique_wallet_1h_change_percent `class-attribute` `instance-attribute` ¶

unique_wallet_1h_change_percent: float | None = None

unique_wallet_2h `class-attribute` `instance-attribute` ¶

unique_wallet_2h: int | None = None

unique_wallet_history_2h `class-attribute` `instance-attribute` ¶

unique_wallet_history_2h: int | None = None

unique_wallet_2h_change_percent `class-attribute` `instance-attribute` ¶

unique_wallet_2h_change_percent: float | None = None

unique_wallet_4h `class-attribute` `instance-attribute` ¶

unique_wallet_4h: int | None = None

unique_wallet_history_4h `class-attribute` `instance-attribute` ¶

unique_wallet_history_4h: int | None = None

unique_wallet_4h_change_percent `class-attribute` `instance-attribute` ¶

unique_wallet_4h_change_percent: float | None = None

unique_wallet_8h `class-attribute` `instance-attribute` ¶

unique_wallet_8h: int | None = None

unique_wallet_history_8h `class-attribute` `instance-attribute` ¶

unique_wallet_history_8h: int | None = None

unique_wallet_8h_change_percent `class-attribute` `instance-attribute` ¶

unique_wallet_8h_change_percent: float | None = None

unique_wallet_24h `class-attribute` `instance-attribute` ¶

unique_wallet_24h: int | None = None

unique_wallet_history_24h `class-attribute` `instance-attribute` ¶

unique_wallet_history_24h: int | None = None

unique_wallet_24h_change_percent `class-attribute` `instance-attribute` ¶

unique_wallet_24h_change_percent: float | None = None

trade_1m `class-attribute` `instance-attribute` ¶

trade_1m: int | None = None

trade_history_1m `class-attribute` `instance-attribute` ¶

trade_history_1m: int | None = None

trade_1m_change_percent `class-attribute` `instance-attribute` ¶

trade_1m_change_percent: float | None = None

sell_1m `class-attribute` `instance-attribute` ¶

sell_1m: int | None = None

sell_history_1m `class-attribute` `instance-attribute` ¶

sell_history_1m: int | None = None

sell_1m_change_percent `class-attribute` `instance-attribute` ¶

sell_1m_change_percent: float | None = None

buy_1m `class-attribute` `instance-attribute` ¶

buy_1m: int | None = None

buy_history_1m `class-attribute` `instance-attribute` ¶

buy_history_1m: int | None = None

buy_1m_change_percent `class-attribute` `instance-attribute` ¶

buy_1m_change_percent: float | None = None

volume_1m `class-attribute` `instance-attribute` ¶

volume_1m: float | None = None

volume_1m_usd `class-attribute` `instance-attribute` ¶

volume_1m_usd: float | None = None

volume_history_1m `class-attribute` `instance-attribute` ¶

volume_history_1m: float | None = None

volume_history_1m_usd `class-attribute` `instance-attribute` ¶

volume_history_1m_usd: float | None = None

volume_1m_change_percent `class-attribute` `instance-attribute` ¶

volume_1m_change_percent: float | None = None

volume_buy_1m `class-attribute` `instance-attribute` ¶

volume_buy_1m: float | None = None

volume_buy_1m_usd `class-attribute` `instance-attribute` ¶

volume_buy_1m_usd: float | None = None

volume_buy_history_1m `class-attribute` `instance-attribute` ¶

volume_buy_history_1m: float | None = None

volume_buy_history_1m_usd `class-attribute` `instance-attribute` ¶

volume_buy_history_1m_usd: float | None = None

volume_buy_1m_change_percent `class-attribute` `instance-attribute` ¶

volume_buy_1m_change_percent: float | None = None

volume_sell_1m `class-attribute` `instance-attribute` ¶

volume_sell_1m: float | None = None

volume_sell_1m_usd `class-attribute` `instance-attribute` ¶

volume_sell_1m_usd: float | None = None

volume_sell_history_1m `class-attribute` `instance-attribute` ¶

volume_sell_history_1m: float | None = None

volume_sell_history_1m_usd `class-attribute` `instance-attribute` ¶

volume_sell_history_1m_usd: float | None = None

volume_sell_1m_change_percent `class-attribute` `instance-attribute` ¶

volume_sell_1m_change_percent: float | None = None

trade_5m `class-attribute` `instance-attribute` ¶

trade_5m: int | None = None

trade_history_5m `class-attribute` `instance-attribute` ¶

trade_history_5m: int | None = None

trade_5m_change_percent `class-attribute` `instance-attribute` ¶

trade_5m_change_percent: float | None = None

sell_5m `class-attribute` `instance-attribute` ¶

sell_5m: int | None = None

sell_history_5m `class-attribute` `instance-attribute` ¶

sell_history_5m: int | None = None

sell_5m_change_percent `class-attribute` `instance-attribute` ¶

sell_5m_change_percent: float | None = None

buy_5m `class-attribute` `instance-attribute` ¶

buy_5m: int | None = None

buy_history_5m `class-attribute` `instance-attribute` ¶

buy_history_5m: int | None = None

buy_5m_change_percent `class-attribute` `instance-attribute` ¶

buy_5m_change_percent: float | None = None

volume_5m `class-attribute` `instance-attribute` ¶

volume_5m: float | None = None

volume_5m_usd `class-attribute` `instance-attribute` ¶

volume_5m_usd: float | None = None

volume_history_5m `class-attribute` `instance-attribute` ¶

volume_history_5m: float | None = None

volume_history_5m_usd `class-attribute` `instance-attribute` ¶

volume_history_5m_usd: float | None = None

volume_5m_change_percent `class-attribute` `instance-attribute` ¶

volume_5m_change_percent: float | None = None

volume_buy_5m `class-attribute` `instance-attribute` ¶

volume_buy_5m: float | None = None

volume_buy_5m_usd `class-attribute` `instance-attribute` ¶

volume_buy_5m_usd: float | None = None

volume_buy_history_5m `class-attribute` `instance-attribute` ¶

volume_buy_history_5m: float | None = None

volume_buy_history_5m_usd `class-attribute` `instance-attribute` ¶

volume_buy_history_5m_usd: float | None = None

volume_buy_5m_change_percent `class-attribute` `instance-attribute` ¶

volume_buy_5m_change_percent: float | None = None

volume_sell_5m `class-attribute` `instance-attribute` ¶

volume_sell_5m: float | None = None

volume_sell_5m_usd `class-attribute` `instance-attribute` ¶

volume_sell_5m_usd: float | None = None

volume_sell_history_5m `class-attribute` `instance-attribute` ¶

volume_sell_history_5m: float | None = None

volume_sell_history_5m_usd `class-attribute` `instance-attribute` ¶

volume_sell_history_5m_usd: float | None = None

volume_sell_5m_change_percent `class-attribute` `instance-attribute` ¶

volume_sell_5m_change_percent: float | None = None

trade_30m `class-attribute` `instance-attribute` ¶

trade_30m: int | None = None

trade_history_30m `class-attribute` `instance-attribute` ¶

trade_history_30m: int | None = None

trade_30m_change_percent `class-attribute` `instance-attribute` ¶

trade_30m_change_percent: float | None = None

sell_30m `class-attribute` `instance-attribute` ¶

sell_30m: int | None = None

sell_history_30m `class-attribute` `instance-attribute` ¶

sell_history_30m: int | None = None

sell_30m_change_percent `class-attribute` `instance-attribute` ¶

sell_30m_change_percent: float | None = None

buy_30m `class-attribute` `instance-attribute` ¶

buy_30m: int | None = None

buy_history_30m `class-attribute` `instance-attribute` ¶

buy_history_30m: int | None = None

buy_30m_change_percent `class-attribute` `instance-attribute` ¶

buy_30m_change_percent: float | None = None

volume_30m `class-attribute` `instance-attribute` ¶

volume_30m: float | None = None

volume_30m_usd `class-attribute` `instance-attribute` ¶

volume_30m_usd: float | None = None

volume_history_30m `class-attribute` `instance-attribute` ¶

volume_history_30m: float | None = None

volume_history_30m_usd `class-attribute` `instance-attribute` ¶

volume_history_30m_usd: float | None = None

volume_30m_change_percent `class-attribute` `instance-attribute` ¶

volume_30m_change_percent: float | None = None

volume_buy_30m `class-attribute` `instance-attribute` ¶

volume_buy_30m: float | None = None

volume_buy_30m_usd `class-attribute` `instance-attribute` ¶

volume_buy_30m_usd: float | None = None

volume_buy_history_30m `class-attribute` `instance-attribute` ¶

volume_buy_history_30m: float | None = None

volume_buy_history_30m_usd `class-attribute` `instance-attribute` ¶

volume_buy_history_30m_usd: float | None = None

volume_buy_30m_change_percent `class-attribute` `instance-attribute` ¶

volume_buy_30m_change_percent: float | None = None

volume_sell_30m `class-attribute` `instance-attribute` ¶

volume_sell_30m: float | None = None

volume_sell_30m_usd `class-attribute` `instance-attribute` ¶

volume_sell_30m_usd: float | None = None

volume_sell_history_30m `class-attribute` `instance-attribute` ¶

volume_sell_history_30m: float | None = None

volume_sell_history_30m_usd `class-attribute` `instance-attribute` ¶

volume_sell_history_30m_usd: float | None = None

volume_sell_30m_change_percent `class-attribute` `instance-attribute` ¶

volume_sell_30m_change_percent: float | None = None

trade_1h `class-attribute` `instance-attribute` ¶

trade_1h: int | None = None

trade_history_1h `class-attribute` `instance-attribute` ¶

trade_history_1h: int | None = None

trade_1h_change_percent `class-attribute` `instance-attribute` ¶

trade_1h_change_percent: float | None = None

sell_1h `class-attribute` `instance-attribute` ¶

sell_1h: int | None = None

sell_history_1h `class-attribute` `instance-attribute` ¶

sell_history_1h: int | None = None

sell_1h_change_percent `class-attribute` `instance-attribute` ¶

sell_1h_change_percent: float | None = None

buy_1h `class-attribute` `instance-attribute` ¶

buy_1h: int | None = None

buy_history_1h `class-attribute` `instance-attribute` ¶

buy_history_1h: int | None = None

buy_1h_change_percent `class-attribute` `instance-attribute` ¶

buy_1h_change_percent: float | None = None

volume_1h `class-attribute` `instance-attribute` ¶

volume_1h: float | None = None

volume_1h_usd `class-attribute` `instance-attribute` ¶

volume_1h_usd: float | None = None

volume_history_1h `class-attribute` `instance-attribute` ¶

volume_history_1h: float | None = None

volume_history_1h_usd `class-attribute` `instance-attribute` ¶

volume_history_1h_usd: float | None = None

volume_1h_change_percent `class-attribute` `instance-attribute` ¶

volume_1h_change_percent: float | None = None

volume_buy_1h `class-attribute` `instance-attribute` ¶

volume_buy_1h: float | None = None

volume_buy_1h_usd `class-attribute` `instance-attribute` ¶

volume_buy_1h_usd: float | None = None

volume_buy_history_1h `class-attribute` `instance-attribute` ¶

volume_buy_history_1h: float | None = None

volume_buy_history_1h_usd `class-attribute` `instance-attribute` ¶

volume_buy_history_1h_usd: float | None = None

volume_buy_1h_change_percent `class-attribute` `instance-attribute` ¶

volume_buy_1h_change_percent: float | None = None

volume_sell_1h `class-attribute` `instance-attribute` ¶

volume_sell_1h: float | None = None

volume_sell_1h_usd `class-attribute` `instance-attribute` ¶

volume_sell_1h_usd: float | None = None

volume_sell_history_1h `class-attribute` `instance-attribute` ¶

volume_sell_history_1h: float | None = None

volume_sell_history_1h_usd `class-attribute` `instance-attribute` ¶

volume_sell_history_1h_usd: float | None = None

volume_sell_1h_change_percent `class-attribute` `instance-attribute` ¶

volume_sell_1h_change_percent: float | None = None

trade_2h `class-attribute` `instance-attribute` ¶

trade_2h: int | None = None

trade_history_2h `class-attribute` `instance-attribute` ¶

trade_history_2h: int | None = None

trade_2h_change_percent `class-attribute` `instance-attribute` ¶

trade_2h_change_percent: float | None = None

sell_2h `class-attribute` `instance-attribute` ¶

sell_2h: int | None = None

sell_history_2h `class-attribute` `instance-attribute` ¶

sell_history_2h: int | None = None

sell_2h_change_percent `class-attribute` `instance-attribute` ¶

sell_2h_change_percent: float | None = None

buy_2h `class-attribute` `instance-attribute` ¶

buy_2h: int | None = None

buy_history_2h `class-attribute` `instance-attribute` ¶

buy_history_2h: int | None = None

buy_2h_change_percent `class-attribute` `instance-attribute` ¶

buy_2h_change_percent: float | None = None

volume_2h `class-attribute` `instance-attribute` ¶

volume_2h: float | None = None

volume_2h_usd `class-attribute` `instance-attribute` ¶

volume_2h_usd: float | None = None

volume_history_2h `class-attribute` `instance-attribute` ¶

volume_history_2h: float | None = None

volume_history_2h_usd `class-attribute` `instance-attribute` ¶

volume_history_2h_usd: float | None = None

volume_2h_change_percent `class-attribute` `instance-attribute` ¶

volume_2h_change_percent: float | None = None

volume_buy_2h `class-attribute` `instance-attribute` ¶

volume_buy_2h: float | None = None

volume_buy_2h_usd `class-attribute` `instance-attribute` ¶

volume_buy_2h_usd: float | None = None

volume_buy_history_2h `class-attribute` `instance-attribute` ¶

volume_buy_history_2h: float | None = None

volume_buy_history_2h_usd `class-attribute` `instance-attribute` ¶

volume_buy_history_2h_usd: float | None = None

volume_buy_2h_change_percent `class-attribute` `instance-attribute` ¶

volume_buy_2h_change_percent: float | None = None

volume_sell_2h `class-attribute` `instance-attribute` ¶

volume_sell_2h: float | None = None

volume_sell_2h_usd `class-attribute` `instance-attribute` ¶

volume_sell_2h_usd: float | None = None

volume_sell_history_2h `class-attribute` `instance-attribute` ¶

volume_sell_history_2h: float | None = None

volume_sell_history_2h_usd `class-attribute` `instance-attribute` ¶

volume_sell_history_2h_usd: float | None = None

volume_sell_2h_change_percent `class-attribute` `instance-attribute` ¶

volume_sell_2h_change_percent: float | None = None

trade_4h `class-attribute` `instance-attribute` ¶

trade_4h: int | None = None

trade_history_4h `class-attribute` `instance-attribute` ¶

trade_history_4h: int | None = None

trade_4h_change_percent `class-attribute` `instance-attribute` ¶

trade_4h_change_percent: float | None = None

sell_4h `class-attribute` `instance-attribute` ¶

sell_4h: int | None = None

sell_history_4h `class-attribute` `instance-attribute` ¶

sell_history_4h: int | None = None

sell_4h_change_percent `class-attribute` `instance-attribute` ¶

sell_4h_change_percent: float | None = None

buy_4h `class-attribute` `instance-attribute` ¶

buy_4h: int | None = None

buy_history_4h `class-attribute` `instance-attribute` ¶

buy_history_4h: int | None = None

buy_4h_change_percent `class-attribute` `instance-attribute` ¶

buy_4h_change_percent: float | None = None

volume_4h `class-attribute` `instance-attribute` ¶

volume_4h: float | None = None

volume_4h_usd `class-attribute` `instance-attribute` ¶

volume_4h_usd: float | None = None

volume_history_4h `class-attribute` `instance-attribute` ¶

volume_history_4h: float | None = None

volume_history_4h_usd `class-attribute` `instance-attribute` ¶

volume_history_4h_usd: float | None = None

volume_4h_change_percent `class-attribute` `instance-attribute` ¶

volume_4h_change_percent: float | None = None

volume_buy_4h `class-attribute` `instance-attribute` ¶

volume_buy_4h: float | None = None

volume_buy_4h_usd `class-attribute` `instance-attribute` ¶

volume_buy_4h_usd: float | None = None

volume_buy_history_4h `class-attribute` `instance-attribute` ¶

volume_buy_history_4h: float | None = None

volume_buy_history_4h_usd `class-attribute` `instance-attribute` ¶

volume_buy_history_4h_usd: float | None = None

volume_buy_4h_change_percent `class-attribute` `instance-attribute` ¶

volume_buy_4h_change_percent: float | None = None

volume_sell_4h `class-attribute` `instance-attribute` ¶

volume_sell_4h: float | None = None

volume_sell_4h_usd `class-attribute` `instance-attribute` ¶

volume_sell_4h_usd: float | None = None

volume_sell_history_4h `class-attribute` `instance-attribute` ¶

volume_sell_history_4h: float | None = None

volume_sell_history_4h_usd `class-attribute` `instance-attribute` ¶

volume_sell_history_4h_usd: float | None = None

volume_sell_4h_change_percent `class-attribute` `instance-attribute` ¶

volume_sell_4h_change_percent: float | None = None

trade_8h `class-attribute` `instance-attribute` ¶

trade_8h: int | None = None

trade_history_8h `class-attribute` `instance-attribute` ¶

trade_history_8h: int | None = None

trade_8h_change_percent `class-attribute` `instance-attribute` ¶

trade_8h_change_percent: float | None = None

sell_8h `class-attribute` `instance-attribute` ¶

sell_8h: int | None = None

sell_history_8h `class-attribute` `instance-attribute` ¶

sell_history_8h: int | None = None

sell_8h_change_percent `class-attribute` `instance-attribute` ¶

sell_8h_change_percent: float | None = None

buy_8h `class-attribute` `instance-attribute` ¶

buy_8h: int | None = None

buy_history_8h `class-attribute` `instance-attribute` ¶

buy_history_8h: int | None = None

buy_8h_change_percent `class-attribute` `instance-attribute` ¶

buy_8h_change_percent: float | None = None

volume_8h `class-attribute` `instance-attribute` ¶

volume_8h: float | None = None

volume_8h_usd `class-attribute` `instance-attribute` ¶

volume_8h_usd: float | None = None

volume_history_8h `class-attribute` `instance-attribute` ¶

volume_history_8h: float | None = None

volume_history_8h_usd `class-attribute` `instance-attribute` ¶

volume_history_8h_usd: float | None = None

volume_8h_change_percent `class-attribute` `instance-attribute` ¶

volume_8h_change_percent: float | None = None

volume_buy_8h `class-attribute` `instance-attribute` ¶

volume_buy_8h: float | None = None

volume_buy_8h_usd `class-attribute` `instance-attribute` ¶

volume_buy_8h_usd: float | None = None

volume_buy_history_8h `class-attribute` `instance-attribute` ¶

volume_buy_history_8h: float | None = None

volume_buy_history_8h_usd `class-attribute` `instance-attribute` ¶

volume_buy_history_8h_usd: float | None = None

volume_buy_8h_change_percent `class-attribute` `instance-attribute` ¶

volume_buy_8h_change_percent: float | None = None

volume_sell_8h `class-attribute` `instance-attribute` ¶

volume_sell_8h: float | None = None

volume_sell_8h_usd `class-attribute` `instance-attribute` ¶

volume_sell_8h_usd: float | None = None

volume_sell_history_8h `class-attribute` `instance-attribute` ¶

volume_sell_history_8h: float | None = None

volume_sell_history_8h_usd `class-attribute` `instance-attribute` ¶

volume_sell_history_8h_usd: float | None = None

volume_sell_8h_change_percent `class-attribute` `instance-attribute` ¶

volume_sell_8h_change_percent: float | None = None

trade_24h `class-attribute` `instance-attribute` ¶

trade_24h: int | None = None

trade_history_24h `class-attribute` `instance-attribute` ¶

trade_history_24h: int | None = None

trade_24h_change_percent `class-attribute` `instance-attribute` ¶

trade_24h_change_percent: float | None = None

sell_24h `class-attribute` `instance-attribute` ¶

sell_24h: int | None = None

sell_history_24h `class-attribute` `instance-attribute` ¶

sell_history_24h: int | None = None

sell_24h_change_percent `class-attribute` `instance-attribute` ¶

sell_24h_change_percent: float | None = None

buy_24h `class-attribute` `instance-attribute` ¶

buy_24h: int | None = None

buy_history_24h `class-attribute` `instance-attribute` ¶

buy_history_24h: int | None = None

buy_24h_change_percent `class-attribute` `instance-attribute` ¶

buy_24h_change_percent: float | None = None

volume_24h `class-attribute` `instance-attribute` ¶

volume_24h: float | None = None

volume_24h_usd `class-attribute` `instance-attribute` ¶

volume_24h_usd: float | None = None

volume_history_24h `class-attribute` `instance-attribute` ¶

volume_history_24h: float | None = None

volume_history_24h_usd `class-attribute` `instance-attribute` ¶

volume_history_24h_usd: float | None = None

volume_24h_change_percent `class-attribute` `instance-attribute` ¶

volume_24h_change_percent: float | None = None

volume_buy_24h `class-attribute` `instance-attribute` ¶

volume_buy_24h: float | None = None

volume_buy_24h_usd `class-attribute` `instance-attribute` ¶

volume_buy_24h_usd: float | None = None

volume_buy_history_24h `class-attribute` `instance-attribute` ¶

volume_buy_history_24h: float | None = None

volume_buy_history_24h_usd `class-attribute` `instance-attribute` ¶

volume_buy_history_24h_usd: float | None = None

volume_buy_24h_change_percent `class-attribute` `instance-attribute` ¶

volume_buy_24h_change_percent: float | None = None

volume_sell_24h `class-attribute` `instance-attribute` ¶

volume_sell_24h: float | None = None

volume_sell_24h_usd `class-attribute` `instance-attribute` ¶

volume_sell_24h_usd: float | None = None

volume_sell_history_24h `class-attribute` `instance-attribute` ¶

volume_sell_history_24h: float | None = None

volume_sell_history_24h_usd `class-attribute` `instance-attribute` ¶

volume_sell_history_24h_usd: float | None = None

volume_sell_24h_change_percent `class-attribute` `instance-attribute` ¶

volume_sell_24h_change_percent: float | None = None

is_scaled_ui_token `class-attribute` `instance-attribute` ¶

is_scaled_ui_token: bool | None = None

multiplier `class-attribute` `instance-attribute` ¶

multiplier: float | None = None

parse_last_trade_human_time ¶

parse_last_trade_human_time(
    dt_raw: str | datetime | None,
) -> datetime | None

Source code in src/cyhole/birdeye/schema/token_stats.py

@field_validator("last_trade_human_time")
def parse_last_trade_human_time(cls, dt_raw: str | datetime | None) -> datetime | None:
    if isinstance(dt_raw, str):
        return datetime.fromisoformat(dt_raw.replace("Z", "+00:00"))
    return dt_raw

GetV3TokenTradeDataResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenTradeDataResponse[GetV3TokenTradeDataResponse]

              

              click cyhole.birdeye.schema.GetV3TokenTradeDataResponse href "" "cyhole.birdeye.schema.GetV3TokenTradeDataResponse"

Model used to represent the Token - Trade Data (Single) endpoint from birdeye API.

Attributes:

Name	Type	Description
`data`	`GetV3TokenTradeDataItem`	trading-activity snapshot of the requested token.
`success`	`bool`	`True` when the API call completed without errors.

data `instance-attribute` ¶

data: GetV3TokenTradeDataItem

success `instance-attribute` ¶

success: bool

GetV3TokenTradeDataMultipleResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenTradeDataMultipleResponse[GetV3TokenTradeDataMultipleResponse]

              

              click cyhole.birdeye.schema.GetV3TokenTradeDataMultipleResponse href "" "cyhole.birdeye.schema.GetV3TokenTradeDataMultipleResponse"

Model used to represent the Token - Trade Data (Multiple) endpoint from birdeye API.

Attributes:

Name	Type	Description
`data`	`dict[str, GetV3TokenTradeDataItem]`	dictionary keyed by token contract address; each value is the trading-activity snapshot for that token. Unrecognised addresses are omitted from the dict.
`success`	`bool`	`True` when the API call completed without errors.

data `instance-attribute` ¶

data: dict[str, GetV3TokenTradeDataItem]

success `instance-attribute` ¶

success: bool

GetV3TokenExitLiquidityPrice ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenExitLiquidityPrice[GetV3TokenExitLiquidityPrice]

              

              click cyhole.birdeye.schema.GetV3TokenExitLiquidityPrice href "" "cyhole.birdeye.schema.GetV3TokenExitLiquidityPrice"

Latest price datapoint used by the Birdeye exit-liquidity computation.

Attributes:

Name	Type	Description
`value`	`float`	the price expressed in the response's `currency` (typically USD).
`update_unix_time`	`int`	unix-second timestamp at which Birdeye last refreshed the price.
`update_human_time`	`str`	ISO-8601 timestamp matching `update_unix_time`.
`update_in_slot`	`int`	chain slot at which the price was observed.

value `instance-attribute` ¶

value: float

update_unix_time `instance-attribute` ¶

update_unix_time: int

update_human_time `instance-attribute` ¶

update_human_time: str

update_in_slot `instance-attribute` ¶

update_in_slot: int

GetV3TokenExitLiquidityItem ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenExitLiquidityItem[GetV3TokenExitLiquidityItem]

              

              click cyhole.birdeye.schema.GetV3TokenExitLiquidityItem href "" "cyhole.birdeye.schema.GetV3TokenExitLiquidityItem"

Single token entry of the Birdeye Token - Liquidity (exit liquidity) endpoint.

The exit-liquidity figure is Birdeye's estimate of how much value the largest holders could realistically extract by selling without crashing the price, computed from the on-chain liquidity profile of the token's biggest markets.

Attributes:

Name	Type	Description
`token`	`str`	contract address of the token (mirrors `address` and is kept for API compatibility).
`exit_liquidity`	`float`	estimated value, in `currency`, that the biggest holders could exit without wrecking the price.
`liquidity`	`float`	total on-chain liquidity of the token expressed in `currency`.
`price`	`GetV3TokenExitLiquidityPrice`	latest price datapoint used to derive `exit_liquidity` and `liquidity`.
`currency`	`str`	ISO-style currency code the numeric fields above are expressed in (typically `USD`).
`address`	`str`	contract address of the token on the selected chain.
`name`	`str \| None`	human-readable name of the token; `None` if unknown.
`symbol`	`str \| None`	ticker symbol of the token; `None` if unknown.
`decimals`	`int`	number of decimal places used by the token.
`extensions`	`dict[str, str \| None] \| None`	free-form metadata bag (website, social links, ...); individual values may be `None`, and the whole dict can be `None` when Birdeye has no extra metadata.
`logo_uri`	`str \| None`	URL of the token logo; `None` if Birdeye does not have a logo for the token.

token `instance-attribute` ¶

token: str

exit_liquidity `instance-attribute` ¶

exit_liquidity: float

liquidity `instance-attribute` ¶

liquidity: float

price `instance-attribute` ¶

price: GetV3TokenExitLiquidityPrice

currency `instance-attribute` ¶

currency: str

address `instance-attribute` ¶

address: str

name `class-attribute` `instance-attribute` ¶

name: str | None = None

symbol `class-attribute` `instance-attribute` ¶

symbol: str | None = None

decimals `instance-attribute` ¶

decimals: int

extensions `class-attribute` `instance-attribute` ¶

extensions: dict[str, str | None] | None = None

logo_uri `class-attribute` `instance-attribute` ¶

logo_uri: str | None = None

GetV3TokenExitLiquidityResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenExitLiquidityResponse[GetV3TokenExitLiquidityResponse]

              

              click cyhole.birdeye.schema.GetV3TokenExitLiquidityResponse href "" "cyhole.birdeye.schema.GetV3TokenExitLiquidityResponse"

Model used to represent the Token - Liquidity (Single) endpoint from birdeye API.

Attributes:

Name	Type	Description
`data`	`GetV3TokenExitLiquidityItem`	exit-liquidity payload of the requested token.
`success`	`bool`	`True` when the API call completed without errors.

data `instance-attribute` ¶

data: GetV3TokenExitLiquidityItem

success `instance-attribute` ¶

success: bool

GetV3TokenExitLiquidityMultipleData ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenExitLiquidityMultipleData[GetV3TokenExitLiquidityMultipleData]

              

              click cyhole.birdeye.schema.GetV3TokenExitLiquidityMultipleData href "" "cyhole.birdeye.schema.GetV3TokenExitLiquidityMultipleData"

Payload of the Token - Liquidity (Multiple) response.

Attributes:

Name	Type	Description
`items`	`list[GetV3TokenExitLiquidityItem]`	list of exit-liquidity entries, one per requested token. Unrecognised addresses are omitted from the list.

items `instance-attribute` ¶

items: list[GetV3TokenExitLiquidityItem]

GetV3TokenExitLiquidityMultipleResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenExitLiquidityMultipleResponse[GetV3TokenExitLiquidityMultipleResponse]

              

              click cyhole.birdeye.schema.GetV3TokenExitLiquidityMultipleResponse href "" "cyhole.birdeye.schema.GetV3TokenExitLiquidityMultipleResponse"

Model used to represent the Token - Liquidity (Multiple) endpoint from birdeye API.

Attributes:

Name	Type	Description
`data`	`GetV3TokenExitLiquidityMultipleData`	payload containing the list of exit-liquidity entries.
`success`	`bool`	`True` when the API call completed without errors.

data `instance-attribute` ¶

data: GetV3TokenExitLiquidityMultipleData

success `instance-attribute` ¶

success: bool

GetV3AllTimeTradesItem ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3AllTimeTradesItem[GetV3AllTimeTradesItem]

              

              click cyhole.birdeye.schema.GetV3AllTimeTradesItem href "" "cyhole.birdeye.schema.GetV3AllTimeTradesItem"

Aggregate trade statistics for a single token over the requested time frame, as returned by the Birdeye v3 All-Time Trades endpoints.

Attributes:

Name	Type	Description
`address`	`str \| None`	contract address of the token on the selected chain; `None` when the address is used as the key of the enclosing dict in the multiple response.
`total_volume`	`float \| None`	cumulative traded volume in token UI units over the time frame; `None` if not available.
`total_volume_usd`	`float \| None`	cumulative traded volume expressed in USD over the time frame; `None` if not available.
`volume_buy`	`float \| None`	buy-side volume in token UI units over the time frame; `None` if not available.
`volume_buy_usd`	`float \| None`	buy-side volume in USD over the time frame; `None` if not available.
`volume_sell`	`float \| None`	sell-side volume in token UI units over the time frame; `None` if not available.
`volume_sell_usd`	`float \| None`	sell-side volume in USD over the time frame; `None` if not available.
`total_trade`	`int \| None`	total number of trades (buys + sells) over the time frame; `None` if not available.
`buy`	`int \| None`	number of buy-side trades over the time frame; `None` if not available.
`sell`	`int \| None`	number of sell-side trades over the time frame; `None` if not available.

address `class-attribute` `instance-attribute` ¶

address: str | None = None

total_volume `class-attribute` `instance-attribute` ¶

total_volume: float | None = None

total_volume_usd `class-attribute` `instance-attribute` ¶

total_volume_usd: float | None = None

volume_buy `class-attribute` `instance-attribute` ¶

volume_buy: float | None = None

volume_buy_usd `class-attribute` `instance-attribute` ¶

volume_buy_usd: float | None = None

volume_sell `class-attribute` `instance-attribute` ¶

volume_sell: float | None = None

volume_sell_usd `class-attribute` `instance-attribute` ¶

volume_sell_usd: float | None = None

total_trade `class-attribute` `instance-attribute` ¶

total_trade: int | None = None

buy `class-attribute` `instance-attribute` ¶

buy: int | None = None

sell `class-attribute` `instance-attribute` ¶

sell: int | None = None

GetV3AllTimeTradesResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3AllTimeTradesResponse[GetV3AllTimeTradesResponse]

              

              click cyhole.birdeye.schema.GetV3AllTimeTradesResponse href "" "cyhole.birdeye.schema.GetV3AllTimeTradesResponse"

Model used to represent both the All-Time Trades (Single) and All-Time Trades (Multiple) endpoints from the Birdeye v3 API. Both variants return the same envelope: a list of per-token trade-statistics items for the selected time frame.

Attributes:

Name	Type	Description
`data`	`list[GetV3AllTimeTradesItem]`	list of trade-statistics items; one entry per requested token address.
`success`	`bool`	`True` when the API call completed without errors.

data `instance-attribute` ¶

data: list[GetV3AllTimeTradesItem]

success `instance-attribute` ¶

success: bool

GetTokenCreationInfoData ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetTokenCreationInfoData[GetTokenCreationInfoData]

              

              click cyhole.birdeye.schema.GetTokenCreationInfoData href "" "cyhole.birdeye.schema.GetTokenCreationInfoData"

Creation metadata of a token returned by the Birdeye Token - Creation Token Info endpoint.

Attributes:

Name	Type	Description
`transaction_hash`	`str`	hash of the on-chain transaction that minted the token (alias `txHash`).
`slot`	`int`	slot in which the mint transaction was processed (Solana-style ordinal).
`token_address`	`str`	contract address of the freshly created token (alias `tokenAddress`).
`decimals`	`int`	number of decimal places used by the token.
`owner`	`str`	address that signed and paid for the creation transaction.
`block_unix_time`	`int`	timestamp of the block containing the creation transaction, expressed as unix seconds (alias `blockUnixTime`).
`block_human_time`	`datetime`	human-readable ISO-8601 timestamp of the same block as `block_unix_time` (alias `blockHumanTime`).

transaction_hash `class-attribute` `instance-attribute` ¶

transaction_hash: str = Field(alias='txHash')

slot `instance-attribute` ¶

slot: int

token_address `class-attribute` `instance-attribute` ¶

token_address: str = Field(alias='tokenAddress')

decimals `instance-attribute` ¶

decimals: int

owner `instance-attribute` ¶

owner: str

block_unix_time `class-attribute` `instance-attribute` ¶

block_unix_time: int = Field(alias='blockUnixTime')

block_human_time `class-attribute` `instance-attribute` ¶

block_human_time: datetime = Field(alias='blockHumanTime')

parse_block_human_time ¶

parse_block_human_time(dt_raw: str | datetime) -> datetime

Source code in src/cyhole/birdeye/schema/creation_trending.py

@field_validator("block_human_time")
def parse_block_human_time(cls, dt_raw: str | datetime) -> datetime:
    if isinstance(dt_raw, str):
        # Birdeye returns ISO timestamps with a trailing "Z" and optional milliseconds.
        return datetime.fromisoformat(dt_raw.replace("Z", "+00:00"))
    return dt_raw

GetTokenCreationInfoResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetTokenCreationInfoResponse[GetTokenCreationInfoResponse]

              

              click cyhole.birdeye.schema.GetTokenCreationInfoResponse href "" "cyhole.birdeye.schema.GetTokenCreationInfoResponse"

Model used to represent the Token - Creation Token Info endpoint from birdeye API.

Attributes:

Name	Type	Description
`data`	`GetTokenCreationInfoData`	token creation metadata payload.
`success`	`bool`	`True` when the API call completed without errors.

data `instance-attribute` ¶

data: GetTokenCreationInfoData

success `instance-attribute` ¶

success: bool

GetTokenTrendingItem ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetTokenTrendingItem[GetTokenTrendingItem]

              

              click cyhole.birdeye.schema.GetTokenTrendingItem href "" "cyhole.birdeye.schema.GetTokenTrendingItem"

Single trending-token entry returned by the Birdeye Token - Trending List endpoint.

Attributes:

Name	Type	Description
`rank`	`int`	Birdeye's internal trending rank (1 = top trending).
`address`	`str`	contract address of the token on the selected chain.
`symbol`	`str`	ticker symbol of the token.
`name`	`str`	human-readable name of the token.
`decimals`	`int`	number of decimal places used by the token.
`logo_uri`	`str \| None`	URL of the token logo (alias `logoURI`); `None` when Birdeye does not have a logo for the token.
`price`	`float`	latest known price of the token in USD.
`liquidity`	`float`	total on-chain liquidity in USD.
`marketcap`	`float`	current market capitalisation in USD.
`fdv`	`float`	fully-diluted valuation in USD.
`volume_24h_usd`	`float`	USD traded volume over the trailing 24h window (alias `volume24hUSD`).
`volume_24h_change_percent`	`float`	percent change of 24h USD volume vs the previous 24h window (alias `volume24hChangePercent`).
`price_24h_change_percent`	`float`	percent price change vs 24h ago (alias `price24hChangePercent`).

rank `instance-attribute` ¶

rank: int

address `instance-attribute` ¶

address: str

symbol `instance-attribute` ¶

symbol: str

name `instance-attribute` ¶

name: str

decimals `instance-attribute` ¶

decimals: int

logo_uri `class-attribute` `instance-attribute` ¶

logo_uri: str | None = Field(alias='logoURI', default=None)

price `instance-attribute` ¶

price: float

liquidity `instance-attribute` ¶

liquidity: float

marketcap `instance-attribute` ¶

marketcap: float

fdv `instance-attribute` ¶

fdv: float

volume_24h_usd `class-attribute` `instance-attribute` ¶

volume_24h_usd: float = Field(alias='volume24hUSD')

volume_24h_change_percent `class-attribute` `instance-attribute` ¶

volume_24h_change_percent: float = Field(
    alias="volume24hChangePercent"
)

price_24h_change_percent `class-attribute` `instance-attribute` ¶

price_24h_change_percent: float = Field(
    alias="price24hChangePercent"
)

GetTokenTrendingData ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetTokenTrendingData[GetTokenTrendingData]

              

              click cyhole.birdeye.schema.GetTokenTrendingData href "" "cyhole.birdeye.schema.GetTokenTrendingData"

Payload of the Token - Trending List response.

Attributes:

Name	Type	Description
`update_unix_time`	`int`	unix-second timestamp at which Birdeye last refreshed the trending list (alias `updateUnixTime`).
`update_time`	`str`	human-readable timestamp matching `update_unix_time` (alias `updateTime`).
`total`	`int`	total number of tokens in Birdeye's trending universe (not the page size).
`tokens`	`list[GetTokenTrendingItem]`	ranked list of trending tokens returned in this page.

update_unix_time `class-attribute` `instance-attribute` ¶

update_unix_time: int = Field(alias='updateUnixTime')

update_time `class-attribute` `instance-attribute` ¶

update_time: str = Field(alias='updateTime')

total `instance-attribute` ¶

total: int

tokens `instance-attribute` ¶

tokens: list[GetTokenTrendingItem]

GetTokenTrendingResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetTokenTrendingResponse[GetTokenTrendingResponse]

              

              click cyhole.birdeye.schema.GetTokenTrendingResponse href "" "cyhole.birdeye.schema.GetTokenTrendingResponse"

Model used to represent the Token - Trending List endpoint from birdeye API.

Attributes:

Name	Type	Description
`data`	`GetTokenTrendingData`	trending-list payload (refresh timestamp + ranked tokens).
`success`	`bool`	`True` when the API call completed without errors.

data `instance-attribute` ¶

data: GetTokenTrendingData

success `instance-attribute` ¶

success: bool

GetPriceData ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetPriceData[GetPriceData]

              

              click cyhole.birdeye.schema.GetPriceData href "" "cyhole.birdeye.schema.GetPriceData"

value `instance-attribute` ¶

value: float

liquidity `class-attribute` `instance-attribute` ¶

liquidity: float | None = None

update_human_time `class-attribute` `instance-attribute` ¶

update_human_time: datetime = Field(alias="updateHumanTime")

update_unix_time `class-attribute` `instance-attribute` ¶

update_unix_time: int = Field(alias='updateUnixTime')

parse_update_human_time ¶

parse_update_human_time(
    update_human_time_raw: str | datetime,
) -> datetime

Source code in src/cyhole/birdeye/schema/price.py

@field_validator("update_human_time")
def parse_update_human_time(cls, update_human_time_raw: str | datetime) -> datetime:
    if isinstance(update_human_time_raw, str):
        return datetime.strptime(update_human_time_raw, "%Y-%m-%dT%H:%M:%S")
    return update_human_time_raw

GetPriceResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetPriceResponse[GetPriceResponse]

              

              click cyhole.birdeye.schema.GetPriceResponse href "" "cyhole.birdeye.schema.GetPriceResponse"

Model used to represent the Price endpoint from birdeye API.

data `instance-attribute` ¶

data: GetPriceData

success `instance-attribute` ¶

success: bool

GetPriceMultipleData ¶

Bases: GetPriceData


              flowchart TD
              cyhole.birdeye.schema.GetPriceMultipleData[GetPriceMultipleData]
              cyhole.birdeye.schema.price.GetPriceData[GetPriceData]

                              cyhole.birdeye.schema.price.GetPriceData --> cyhole.birdeye.schema.GetPriceMultipleData
                


              click cyhole.birdeye.schema.GetPriceMultipleData href "" "cyhole.birdeye.schema.GetPriceMultipleData"
              click cyhole.birdeye.schema.price.GetPriceData href "" "cyhole.birdeye.schema.price.GetPriceData"

price_change_24h `class-attribute` `instance-attribute` ¶

price_change_24h: float = Field(alias='priceChange24h')

GetPriceMultipleResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetPriceMultipleResponse[GetPriceMultipleResponse]

              

              click cyhole.birdeye.schema.GetPriceMultipleResponse href "" "cyhole.birdeye.schema.GetPriceMultipleResponse"

Model used to represent the Price - Multiple endpoint from birdeye API.

data `instance-attribute` ¶

data: dict[str, GetPriceMultipleData]

success `instance-attribute` ¶

success: bool

GetPriceHistoricalMeasure ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetPriceHistoricalMeasure[GetPriceHistoricalMeasure]

              

              click cyhole.birdeye.schema.GetPriceHistoricalMeasure href "" "cyhole.birdeye.schema.GetPriceHistoricalMeasure"

unix_time `class-attribute` `instance-attribute` ¶

unix_time: int = Field(alias='unixTime')

value `instance-attribute` ¶

value: float

GetPriceHistoricalData ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetPriceHistoricalData[GetPriceHistoricalData]

              

              click cyhole.birdeye.schema.GetPriceHistoricalData href "" "cyhole.birdeye.schema.GetPriceHistoricalData"

items `instance-attribute` ¶

items: list[GetPriceHistoricalMeasure]

GetPriceHistoricalResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetPriceHistoricalResponse[GetPriceHistoricalResponse]

              

              click cyhole.birdeye.schema.GetPriceHistoricalResponse href "" "cyhole.birdeye.schema.GetPriceHistoricalResponse"

Model used to represent the Price - Historical endpoint from birdeye API.

data `instance-attribute` ¶

data: GetPriceHistoricalData

success `instance-attribute` ¶

success: bool

GetPriceVolumeSingleData ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetPriceVolumeSingleData[GetPriceVolumeSingleData]

              

              click cyhole.birdeye.schema.GetPriceVolumeSingleData href "" "cyhole.birdeye.schema.GetPriceVolumeSingleData"

price `instance-attribute` ¶

price: float

update_unix_time `class-attribute` `instance-attribute` ¶

update_unix_time: int = Field(alias='updateUnixTime')

update_human_time `class-attribute` `instance-attribute` ¶

update_human_time: datetime = Field(alias="updateHumanTime")

volume_usd `class-attribute` `instance-attribute` ¶

volume_usd: float = Field(alias='volumeUSD')

volume_change_percent `class-attribute` `instance-attribute` ¶

volume_change_percent: float = Field(
    alias="volumeChangePercent"
)

price_change_percent `class-attribute` `instance-attribute` ¶

price_change_percent: float = Field(
    alias="priceChangePercent"
)

parse_update_human_time ¶

parse_update_human_time(
    update_human_time_raw: str | datetime,
) -> datetime

Source code in src/cyhole/birdeye/schema/price.py

@field_validator("update_human_time")
def parse_update_human_time(cls, update_human_time_raw: str | datetime) -> datetime:
    if isinstance(update_human_time_raw, str):
        return datetime.strptime(update_human_time_raw, "%Y-%m-%dT%H:%M:%S")
    return update_human_time_raw

GetPriceVolumeSingleResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetPriceVolumeSingleResponse[GetPriceVolumeSingleResponse]

              

              click cyhole.birdeye.schema.GetPriceVolumeSingleResponse href "" "cyhole.birdeye.schema.GetPriceVolumeSingleResponse"

Model used to represent the Price Volume - Single Token endpoint from birdeye API.

data `instance-attribute` ¶

data: GetPriceVolumeSingleData

success `instance-attribute` ¶

success: bool

PostPriceVolumeMultiData ¶

Bases: GetPriceVolumeSingleData


              flowchart TD
              cyhole.birdeye.schema.PostPriceVolumeMultiData[PostPriceVolumeMultiData]
              cyhole.birdeye.schema.price.GetPriceVolumeSingleData[GetPriceVolumeSingleData]

                              cyhole.birdeye.schema.price.GetPriceVolumeSingleData --> cyhole.birdeye.schema.PostPriceVolumeMultiData
                


              click cyhole.birdeye.schema.PostPriceVolumeMultiData href "" "cyhole.birdeye.schema.PostPriceVolumeMultiData"
              click cyhole.birdeye.schema.price.GetPriceVolumeSingleData href "" "cyhole.birdeye.schema.price.GetPriceVolumeSingleData"

address `instance-attribute` ¶

address: str

PostPriceVolumeMultiResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.PostPriceVolumeMultiResponse[PostPriceVolumeMultiResponse]

              

              click cyhole.birdeye.schema.PostPriceVolumeMultiResponse href "" "cyhole.birdeye.schema.PostPriceVolumeMultiResponse"

Model used to represent the Price Volume - Multiple Token endpoint from birdeye API.

data `instance-attribute` ¶

data: list[PostPriceVolumeMultiData]

GetTradesTokenTradeToken ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetTradesTokenTradeToken[GetTradesTokenTradeToken]

              

              click cyhole.birdeye.schema.GetTradesTokenTradeToken href "" "cyhole.birdeye.schema.GetTradesTokenTradeToken"

symbol `instance-attribute` ¶

symbol: str

decimals `instance-attribute` ¶

decimals: int

address `instance-attribute` ¶

address: str

amount `instance-attribute` ¶

amount: int

type `instance-attribute` ¶

type: str

type_swap `class-attribute` `instance-attribute` ¶

type_swap: str = Field(alias='typeSwap')

ui_amount `class-attribute` `instance-attribute` ¶

ui_amount: float = Field(alias='uiAmount')

price `class-attribute` `instance-attribute` ¶

price: float | None = None

nearest_price `class-attribute` `instance-attribute` ¶

nearest_price: float = Field(alias='nearestPrice')

change_amount `class-attribute` `instance-attribute` ¶

change_amount: float = Field(alias='changeAmount')

ui_change_amount `class-attribute` `instance-attribute` ¶

ui_change_amount: float = Field(alias='uiChangeAmount')

icon `class-attribute` `instance-attribute` ¶

icon: str | None = None

GetTradesTokenTrade ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetTradesTokenTrade[GetTradesTokenTrade]

              

              click cyhole.birdeye.schema.GetTradesTokenTrade href "" "cyhole.birdeye.schema.GetTradesTokenTrade"

volume `instance-attribute` ¶

volume: float

volume_usd `class-attribute` `instance-attribute` ¶

volume_usd: float = Field(alias='volumeUSD')

trade_hash `class-attribute` `instance-attribute` ¶

trade_hash: str = Field(alias='txHash')

slot `instance-attribute` ¶

slot: int

source `instance-attribute` ¶

source: str

block_unix_time `class-attribute` `instance-attribute` ¶

block_unix_time: int = Field(alias='blockUnixTime')

block_human_time `class-attribute` `instance-attribute` ¶

block_human_time: datetime = Field(alias='blockHumanTime')

trade_type `class-attribute` `instance-attribute` ¶

trade_type: str = Field(alias='txType')

address `instance-attribute` ¶

address: str

owner `instance-attribute` ¶

owner: str

trade_status `class-attribute` `instance-attribute` ¶

trade_status: str = Field(alias='txStatus')

outliers `instance-attribute` ¶

outliers: bool

nearest_price_base_coin `class-attribute` `instance-attribute` ¶

nearest_price_base_coin: float = Field(
    alias="nearestPriceBaseCoin"
)

nearest_price_quote_coin `class-attribute` `instance-attribute` ¶

nearest_price_quote_coin: float = Field(
    alias="nearestPriceQuoteCoin"
)

ins_index `class-attribute` `instance-attribute` ¶

ins_index: int = Field(alias='insIndex')

inner_ins_index `class-attribute` `instance-attribute` ¶

inner_ins_index: int | None = Field(
    alias="innerInsIndex", default=None
)

be_bevenue `class-attribute` `instance-attribute` ¶

be_bevenue: str | None = Field(
    alias="beRevenue", default=None
)

event_type `class-attribute` `instance-attribute` ¶

event_type: str = Field(alias='eventType')

side `instance-attribute` ¶

side: str

price_pair `class-attribute` `instance-attribute` ¶

price_pair: float = Field(alias='pricePair')

alias `class-attribute` `instance-attribute` ¶

alias: str | None = None

platform `instance-attribute` ¶

platform: str

toke_price `class-attribute` `instance-attribute` ¶

toke_price: float = Field(alias='tokenPrice')

proce_mark `class-attribute` `instance-attribute` ¶

proce_mark: bool = Field(alias='priceMark')

network `instance-attribute` ¶

network: str

trade_from `class-attribute` `instance-attribute` ¶

trade_from: GetTradesTokenTradeToken = Field(alias='from')

trade_to `class-attribute` `instance-attribute` ¶

trade_to: GetTradesTokenTradeToken = Field(alias='to')

parse_update_human_time ¶

parse_update_human_time(dt_raw: str | datetime) -> datetime

Source code in src/cyhole/birdeye/schema/transactions.py

@field_validator("block_human_time")
def parse_update_human_time(cls, dt_raw: str | datetime) -> datetime:
    if isinstance(dt_raw, str):
        return datetime.strptime(dt_raw, "%Y-%m-%dT%H:%M:%S")
    return dt_raw

GetTradesTokenData ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetTradesTokenData[GetTradesTokenData]

              

              click cyhole.birdeye.schema.GetTradesTokenData href "" "cyhole.birdeye.schema.GetTradesTokenData"

items `instance-attribute` ¶

items: list[GetTradesTokenTrade]

has_next `class-attribute` `instance-attribute` ¶

has_next: bool = Field(alias='hasNext')

GetTradesTokenResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetTradesTokenResponse[GetTradesTokenResponse]

              

              click cyhole.birdeye.schema.GetTradesTokenResponse href "" "cyhole.birdeye.schema.GetTradesTokenResponse"

Model used to represent the Trades - Token endpoint from birdeye API.

data `instance-attribute` ¶

data: GetTradesTokenData

success `instance-attribute` ¶

success: bool

GetTradesPairTradeToken ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetTradesPairTradeToken[GetTradesPairTradeToken]

              

              click cyhole.birdeye.schema.GetTradesPairTradeToken href "" "cyhole.birdeye.schema.GetTradesPairTradeToken"

symbol `instance-attribute` ¶

symbol: str

decimals `instance-attribute` ¶

decimals: int

address `instance-attribute` ¶

address: str

amount `instance-attribute` ¶

amount: int

type `instance-attribute` ¶

type: str

type_swap `class-attribute` `instance-attribute` ¶

type_swap: str = Field(alias='typeSwap')

ui_amount `class-attribute` `instance-attribute` ¶

ui_amount: float = Field(alias='uiAmount')

price `class-attribute` `instance-attribute` ¶

price: float | None = None

nearest_price `class-attribute` `instance-attribute` ¶

nearest_price: float = Field(alias='nearestPrice')

change_amount `class-attribute` `instance-attribute` ¶

change_amount: float = Field(alias='changeAmount')

ui_change_amount `class-attribute` `instance-attribute` ¶

ui_change_amount: float = Field(alias='uiChangeAmount')

GetTradesPairTrade ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetTradesPairTrade[GetTradesPairTrade]

              

              click cyhole.birdeye.schema.GetTradesPairTrade href "" "cyhole.birdeye.schema.GetTradesPairTrade"

trade_hash `class-attribute` `instance-attribute` ¶

trade_hash: str = Field(alias='txHash')

source `instance-attribute` ¶

source: str

block_unix_time `class-attribute` `instance-attribute` ¶

block_unix_time: int = Field(alias='blockUnixTime')

address `instance-attribute` ¶

address: str

owner `instance-attribute` ¶

owner: str

trade_from `class-attribute` `instance-attribute` ¶

trade_from: GetTradesPairTradeToken = Field(alias='from')

trade_to `class-attribute` `instance-attribute` ¶

trade_to: GetTradesPairTradeToken = Field(alias='to')

GetTradesPairData ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetTradesPairData[GetTradesPairData]

              

              click cyhole.birdeye.schema.GetTradesPairData href "" "cyhole.birdeye.schema.GetTradesPairData"

items `instance-attribute` ¶

items: list[GetTradesPairTrade]

has_next `class-attribute` `instance-attribute` ¶

has_next: bool = Field(alias='hasNext')

GetTradesPairResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetTradesPairResponse[GetTradesPairResponse]

              

              click cyhole.birdeye.schema.GetTradesPairResponse href "" "cyhole.birdeye.schema.GetTradesPairResponse"

Model used to represent the Trades - Pair endpoint from birdeye API.

data `instance-attribute` ¶

data: GetTradesPairData

success `instance-attribute` ¶

success: bool

GetOHLCVInterval ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetOHLCVInterval[GetOHLCVInterval]

              

              click cyhole.birdeye.schema.GetOHLCVInterval href "" "cyhole.birdeye.schema.GetOHLCVInterval"

close `class-attribute` `instance-attribute` ¶

close: float = Field(alias='c')

high `class-attribute` `instance-attribute` ¶

high: float = Field(alias='h')

low `class-attribute` `instance-attribute` ¶

low: float = Field(alias='l')

open `class-attribute` `instance-attribute` ¶

open: float = Field(alias='o')

type `instance-attribute` ¶

type: str

unix_time `class-attribute` `instance-attribute` ¶

unix_time: int = Field(alias='unixTime')

GetOHLCVTokenPairInterval ¶

Bases: GetOHLCVInterval


              flowchart TD
              cyhole.birdeye.schema.GetOHLCVTokenPairInterval[GetOHLCVTokenPairInterval]
              cyhole.birdeye.schema.transactions.GetOHLCVInterval[GetOHLCVInterval]

                              cyhole.birdeye.schema.transactions.GetOHLCVInterval --> cyhole.birdeye.schema.GetOHLCVTokenPairInterval
                


              click cyhole.birdeye.schema.GetOHLCVTokenPairInterval href "" "cyhole.birdeye.schema.GetOHLCVTokenPairInterval"
              click cyhole.birdeye.schema.transactions.GetOHLCVInterval href "" "cyhole.birdeye.schema.transactions.GetOHLCVInterval"

address `instance-attribute` ¶

address: str

volume `class-attribute` `instance-attribute` ¶

volume: float = Field(alias='v')

GetOHLCVTokenPairData ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetOHLCVTokenPairData[GetOHLCVTokenPairData]

              

              click cyhole.birdeye.schema.GetOHLCVTokenPairData href "" "cyhole.birdeye.schema.GetOHLCVTokenPairData"

items `instance-attribute` ¶

items: list[GetOHLCVTokenPairInterval]

GetOHLCVTokenPairResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetOHLCVTokenPairResponse[GetOHLCVTokenPairResponse]

              

              click cyhole.birdeye.schema.GetOHLCVTokenPairResponse href "" "cyhole.birdeye.schema.GetOHLCVTokenPairResponse"

Model used to represent the OHLCV - Token/Pair endpoint from birdeye API.

data `instance-attribute` ¶

data: GetOHLCVTokenPairData

success `instance-attribute` ¶

success: bool

GetOHLCVBaseQuoteInterval ¶

Bases: GetOHLCVInterval


              flowchart TD
              cyhole.birdeye.schema.GetOHLCVBaseQuoteInterval[GetOHLCVBaseQuoteInterval]
              cyhole.birdeye.schema.transactions.GetOHLCVInterval[GetOHLCVInterval]

                              cyhole.birdeye.schema.transactions.GetOHLCVInterval --> cyhole.birdeye.schema.GetOHLCVBaseQuoteInterval
                


              click cyhole.birdeye.schema.GetOHLCVBaseQuoteInterval href "" "cyhole.birdeye.schema.GetOHLCVBaseQuoteInterval"
              click cyhole.birdeye.schema.transactions.GetOHLCVInterval href "" "cyhole.birdeye.schema.transactions.GetOHLCVInterval"

base_address `class-attribute` `instance-attribute` ¶

base_address: str = Field(alias='baseAddress')

quote_address `class-attribute` `instance-attribute` ¶

quote_address: str = Field(alias='quoteAddress')

base_volume `class-attribute` `instance-attribute` ¶

base_volume: float = Field(alias='vBase')

quote_volume `class-attribute` `instance-attribute` ¶

quote_volume: float = Field(alias='vQuote')

GetOHLCVBaseQuoteData ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetOHLCVBaseQuoteData[GetOHLCVBaseQuoteData]

              

              click cyhole.birdeye.schema.GetOHLCVBaseQuoteData href "" "cyhole.birdeye.schema.GetOHLCVBaseQuoteData"

items `instance-attribute` ¶

items: list[GetOHLCVBaseQuoteInterval]

GetOHLCVBaseQuoteResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetOHLCVBaseQuoteResponse[GetOHLCVBaseQuoteResponse]

              

              click cyhole.birdeye.schema.GetOHLCVBaseQuoteResponse href "" "cyhole.birdeye.schema.GetOHLCVBaseQuoteResponse"

Model used to represent the OHLCV - Token/Pair endpoint from birdeye API.

data `instance-attribute` ¶

data: GetOHLCVBaseQuoteData

GetV3TokenMintBurnTxsItem ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenMintBurnTxsItem[GetV3TokenMintBurnTxsItem]

              

              click cyhole.birdeye.schema.GetV3TokenMintBurnTxsItem href "" "cyhole.birdeye.schema.GetV3TokenMintBurnTxsItem"

Single mint or burn transaction returned by the v3 Token - Mint/Burn endpoint.

Attributes:

Name	Type	Description
`common_type`	`str`	kind of supply change, either `"mint"` or `"burn"`.
`tx_hash`	`str`	signature of the on-chain transaction that performed the mint/burn.
`slot`	`int`	Solana slot at which the transaction was processed.
`block_time`	`int`	unix-second timestamp of the block containing the transaction.
`block_human_time`	`str`	ISO-8601 timestamp of the same block as `block_time`.
`mint`	`str`	contract address of the affected SPL token mint.
`program_id`	`str`	address of the on-chain program that emitted the mint/burn instruction (usually the SPL Token program).
`amount`	`str`	raw amount minted or burned, expressed in the token's smallest units (string).
`decimals`	`int`	number of decimal places used by the token.
`ui_amount`	`float`	UI-formatted amount (i.e. `amount` divided by `10 ** decimals`) as a number.
`ui_amount_string`	`str`	UI-formatted amount as a string (preserves precision for very large values).

common_type `instance-attribute` ¶

common_type: str

tx_hash `instance-attribute` ¶

tx_hash: str

slot `instance-attribute` ¶

slot: int

block_time `instance-attribute` ¶

block_time: int

block_human_time `instance-attribute` ¶

block_human_time: str

mint `instance-attribute` ¶

mint: str

program_id `instance-attribute` ¶

program_id: str

amount `instance-attribute` ¶

amount: str

decimals `instance-attribute` ¶

decimals: int

ui_amount `instance-attribute` ¶

ui_amount: float

ui_amount_string `instance-attribute` ¶

ui_amount_string: str

GetV3TokenMintBurnTxsData ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenMintBurnTxsData[GetV3TokenMintBurnTxsData]

              

              click cyhole.birdeye.schema.GetV3TokenMintBurnTxsData href "" "cyhole.birdeye.schema.GetV3TokenMintBurnTxsData"

Payload of the v3 Token - Mint/Burn response.

Attributes:

Name	Type	Description
`items`	`list[GetV3TokenMintBurnTxsItem]`	list of mint/burn transactions matching the request, ranked per `sort_by` / `sort_type` (default: most recent first).

items `instance-attribute` ¶

items: list[GetV3TokenMintBurnTxsItem]

GetV3TokenMintBurnTxsResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenMintBurnTxsResponse[GetV3TokenMintBurnTxsResponse]

              

              click cyhole.birdeye.schema.GetV3TokenMintBurnTxsResponse href "" "cyhole.birdeye.schema.GetV3TokenMintBurnTxsResponse"

Model used to represent the Token - Mint/Burn endpoint from birdeye API.

Attributes:

Name	Type	Description
`data`	`GetV3TokenMintBurnTxsData`	payload containing the list of mint/burn transactions.
`success`	`bool`	`True` when the API call completed without errors.

data `instance-attribute` ¶

data: GetV3TokenMintBurnTxsData

success `instance-attribute` ¶

success: bool

GetTokenHolderItem ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetTokenHolderItem[GetTokenHolderItem]

              

              click cyhole.birdeye.schema.GetTokenHolderItem href "" "cyhole.birdeye.schema.GetTokenHolderItem"

Single top-holder entry returned by the v3 Token - Holder endpoint.

Attributes:

Name	Type	Description
`mint`	`str`	contract address of the SPL token being held.
`owner`	`str`	wallet address that owns the token balance.
`token_account`	`str`	SPL token account address holding the balance for `owner`.
`amount`	`str`	raw amount held, expressed in the token's smallest units (string).
`decimals`	`int`	number of decimal places used by the token.
`ui_amount`	`float`	UI-formatted amount (i.e. `amount` divided by `10 ** decimals`) as a number.
`is_scaled_ui_token`	`bool \| None`	`True` when the token is a scaled-UI-amount SPL token; `None` if undetermined.
`multiplier`	`float \| None`	scaling multiplier applied to UI amounts of scaled-UI-amount tokens; `None` when not applicable.

mint `instance-attribute` ¶

mint: str

owner `instance-attribute` ¶

owner: str

token_account `instance-attribute` ¶

token_account: str

amount `instance-attribute` ¶

amount: str

decimals `instance-attribute` ¶

decimals: int

ui_amount `instance-attribute` ¶

ui_amount: float

is_scaled_ui_token `class-attribute` `instance-attribute` ¶

is_scaled_ui_token: bool | None = None

multiplier `class-attribute` `instance-attribute` ¶

multiplier: float | None = None

GetTokenHolderData ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetTokenHolderData[GetTokenHolderData]

              

              click cyhole.birdeye.schema.GetTokenHolderData href "" "cyhole.birdeye.schema.GetTokenHolderData"

Payload of the v3 Token - Holder response.

Attributes:

Name	Type	Description
`items`	`list[GetTokenHolderItem]`	ranked list of top holder entries (largest balance first by default).

items `instance-attribute` ¶

items: list[GetTokenHolderItem]

GetTokenHolderResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetTokenHolderResponse[GetTokenHolderResponse]

              

              click cyhole.birdeye.schema.GetTokenHolderResponse href "" "cyhole.birdeye.schema.GetTokenHolderResponse"

Model used to represent the Token - Holder endpoint from birdeye API.

Attributes:

Name	Type	Description
`data`	`GetTokenHolderData`	payload containing the ranked top-holder list.
`success`	`bool`	`True` when the API call completed without errors.

data `instance-attribute` ¶

data: GetTokenHolderData

success `instance-attribute` ¶

success: bool

PostTokenHolderBatchItem ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.PostTokenHolderBatchItem[PostTokenHolderBatchItem]

              

              click cyhole.birdeye.schema.PostTokenHolderBatchItem href "" "cyhole.birdeye.schema.PostTokenHolderBatchItem"

Single wallet/token balance entry returned by the POST Token - Holder (Batch) endpoint.

Attributes:

Name	Type	Description
`mint`	`str`	contract address of the SPL token being held.
`owner`	`str`	wallet address whose balance is being reported.
`amount`	`float`	UI-formatted balance (numeric).
`balance`	`str`	raw balance expressed in the token's smallest units (string).
`decimals`	`int`	number of decimal places used by the token.

mint `instance-attribute` ¶

mint: str

owner `instance-attribute` ¶

owner: str

amount `instance-attribute` ¶

amount: float

balance `instance-attribute` ¶

balance: str

decimals `instance-attribute` ¶

decimals: int

PostTokenHolderBatchData ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.PostTokenHolderBatchData[PostTokenHolderBatchData]

              

              click cyhole.birdeye.schema.PostTokenHolderBatchData href "" "cyhole.birdeye.schema.PostTokenHolderBatchData"

Payload of the POST Token - Holder (Batch) response.

Attributes:

Name	Type	Description
`items`	`list[PostTokenHolderBatchItem]`	list of balance entries, one per `(owner, mint)` combination requested. Owners that have never held the token are omitted from the list.

items `instance-attribute` ¶

items: list[PostTokenHolderBatchItem]

PostTokenHolderBatchBody ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.PostTokenHolderBatchBody[PostTokenHolderBatchBody]

              

              click cyhole.birdeye.schema.PostTokenHolderBatchBody href "" "cyhole.birdeye.schema.PostTokenHolderBatchBody"

Request body for the POST Token - Holder (Batch) endpoint.

Attributes:

Name	Type	Description
`token_address`	`str`	contract address of the SPL token whose balances must be looked up.
`wallets`	`list[str]`	list of wallet addresses whose balance in `token_address` should be returned.

token_address `instance-attribute` ¶

token_address: str

wallets `instance-attribute` ¶

wallets: list[str]

PostTokenHolderBatchResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.PostTokenHolderBatchResponse[PostTokenHolderBatchResponse]

              

              click cyhole.birdeye.schema.PostTokenHolderBatchResponse href "" "cyhole.birdeye.schema.PostTokenHolderBatchResponse"

Model used to represent the Token - Holder (Batch) endpoint from birdeye API.

Attributes:

Name	Type	Description
`data`	`PostTokenHolderBatchData`	payload containing the balance entries.
`success`	`bool`	`True` when the API call completed without errors.

data `instance-attribute` ¶

data: PostTokenHolderBatchData

success `instance-attribute` ¶

success: bool

GetHolderDistributionEntry ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetHolderDistributionEntry[GetHolderDistributionEntry]

              

              click cyhole.birdeye.schema.GetHolderDistributionEntry href "" "cyhole.birdeye.schema.GetHolderDistributionEntry"

Single holder entry in a Token - Holder Distribution response.

Attributes:

Name	Type	Description
`wallet`	`str`	wallet (or SPL token-account, depending on the request `address_type`) address.
`holding`	`str`	balance of the holder expressed in UI units, as a string to preserve precision.
`percent_of_supply`	`float`	share of the token's total supply held, expressed as a fraction in `[0, 1]`.

wallet `instance-attribute` ¶

wallet: str

holding `instance-attribute` ¶

holding: str

percent_of_supply `instance-attribute` ¶

percent_of_supply: float

GetHolderDistributionPagination ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetHolderDistributionPagination[GetHolderDistributionPagination]

              

              click cyhole.birdeye.schema.GetHolderDistributionPagination href "" "cyhole.birdeye.schema.GetHolderDistributionPagination"

Pagination block of a Token - Holder Distribution response.

Attributes:

Name	Type	Description
`offset`	`int`	zero-based offset of the current batch within the full result set.
`limit`	`int`	maximum number of entries returned per call.
`total`	`int`	total number of entries that match the request filters across all pages.

offset `instance-attribute` ¶

offset: int

limit `instance-attribute` ¶

limit: int

total `instance-attribute` ¶

total: int

GetHolderDistributionRange ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetHolderDistributionRange[GetHolderDistributionRange]

              

              click cyhole.birdeye.schema.GetHolderDistributionRange href "" "cyhole.birdeye.schema.GetHolderDistributionRange"

Supply-share range applied by Birdeye when filtering the distribution.

Attributes:

Name	Type	Description
`min_percent`	`float`	inclusive lower bound on `percent_of_supply` (in `percent` mode); echoes the request parameter or Birdeye's default.
`max_percent`	`float`	inclusive upper bound on `percent_of_supply` (in `percent` mode); echoes the request parameter or Birdeye's default.

min_percent `instance-attribute` ¶

min_percent: float

max_percent `instance-attribute` ¶

max_percent: float

GetHolderDistributionSummary ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetHolderDistributionSummary[GetHolderDistributionSummary]

              

              click cyhole.birdeye.schema.GetHolderDistributionSummary href "" "cyhole.birdeye.schema.GetHolderDistributionSummary"

Aggregate summary of the holders matching the distribution filters.

Attributes:

Name	Type	Description
`total_holding`	`str`	cumulative balance of matched holders in UI units, as a string to preserve precision.
`percent_of_supply`	`float`	cumulative `total_holding` expressed as a fraction (`[0, 1]`) of total supply.
`wallet_count`	`int`	number of distinct holders that matched the filter range.

total_holding `instance-attribute` ¶

total_holding: str

percent_of_supply `instance-attribute` ¶

percent_of_supply: float

wallet_count `instance-attribute` ¶

wallet_count: int

GetHolderDistributionData ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetHolderDistributionData[GetHolderDistributionData]

              

              click cyhole.birdeye.schema.GetHolderDistributionData href "" "cyhole.birdeye.schema.GetHolderDistributionData"

Payload of the Token - Holder Distribution response.

Attributes:

Name	Type	Description
`token_address`	`str`	contract address of the token the distribution refers to.
`mode`	`str`	filter mode actually applied (`top` or `percent`).
`range`	`GetHolderDistributionRange`	supply-share range used by the filter.
`holders`	`list[GetHolderDistributionEntry]`	list of individual holder entries (empty when `include_list=false`).
`pagination`	`GetHolderDistributionPagination`	pagination metadata describing the returned batch and total match count.
`summary`	`GetHolderDistributionSummary`	cumulative figures over the holders that matched the filter range.

token_address `instance-attribute` ¶

token_address: str

mode `instance-attribute` ¶

mode: str

range `instance-attribute` ¶

range: GetHolderDistributionRange

holders `instance-attribute` ¶

holders: list[GetHolderDistributionEntry]

pagination `instance-attribute` ¶

pagination: GetHolderDistributionPagination

summary `instance-attribute` ¶

summary: GetHolderDistributionSummary

GetHolderDistributionResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetHolderDistributionResponse[GetHolderDistributionResponse]

              

              click cyhole.birdeye.schema.GetHolderDistributionResponse href "" "cyhole.birdeye.schema.GetHolderDistributionResponse"

Model used to represent the Token - Holder Distribution endpoint from birdeye API.

Attributes:

Name	Type	Description
`data`	`GetHolderDistributionData`	holder-distribution payload.
`success`	`bool`	`True` when the API call completed without errors.

data `instance-attribute` ¶

data: GetHolderDistributionData

success `instance-attribute` ¶

success: bool

GetHolderProfileSummary ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetHolderProfileSummary[GetHolderProfileSummary]

              

              click cyhole.birdeye.schema.GetHolderProfileSummary href "" "cyhole.birdeye.schema.GetHolderProfileSummary"

Headline counts of the holders aggregated by the Token - Holder Profile endpoint.

Attributes:

Name	Type	Description
`total_holder`	`int`	total number of distinct holders Birdeye has observed for the token.
`total_holding`	`float`	cumulative balance of all holders, in UI units.
`percent_of_supply`	`float`	cumulative `total_holding` expressed as a percent (`[0, 100]`) of the token total supply.

total_holder `instance-attribute` ¶

total_holder: int

total_holding `instance-attribute` ¶

total_holding: float

percent_of_supply `instance-attribute` ¶

percent_of_supply: float

GetHolderProfileTagBreakdown ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetHolderProfileTagBreakdown[GetHolderProfileTagBreakdown]

              

              click cyhole.birdeye.schema.GetHolderProfileTagBreakdown href "" "cyhole.birdeye.schema.GetHolderProfileTagBreakdown"

Aggregate trading and holding figures for one Birdeye holder-tag bucket (bundler, sniper, insider, dev, smart_trader).

Attributes:

Name	Type	Description
`tag`	`str`	name of the tag this row describes.
`holder_count`	`int`	number of distinct wallets currently classified under `tag`.
`hold_amount`	`str`	cumulative holding of wallets in this tag, in UI units (string).
`percent_of_supply`	`float`	cumulative `hold_amount` expressed as a percent (`[0, 100]`) of total supply.
`avg_buy_price`	`str`	average buy price (USD) across the wallets in this tag (string).
`buy_volume`	`str`	cumulative buy volume of wallets in this tag, in the token UI units (string).
`buy_volume_usd`	`str`	cumulative buy volume of wallets in this tag, expressed in USD (string).
`sell_volume`	`str`	cumulative sell volume of wallets in this tag, in the token UI units (string).
`sell_volume_usd`	`str`	cumulative sell volume of wallets in this tag, expressed in USD (string).
`pnl`	`str`	cumulative profit-and-loss of wallets in this tag, in USD (string).

tag `instance-attribute` ¶

tag: str

holder_count `instance-attribute` ¶

holder_count: int

hold_amount `instance-attribute` ¶

hold_amount: str

percent_of_supply `instance-attribute` ¶

percent_of_supply: float

avg_buy_price `instance-attribute` ¶

avg_buy_price: str

buy_volume `instance-attribute` ¶

buy_volume: str

buy_volume_usd `instance-attribute` ¶

buy_volume_usd: str

sell_volume `instance-attribute` ¶

sell_volume: str

sell_volume_usd `instance-attribute` ¶

sell_volume_usd: str

pnl `instance-attribute` ¶

pnl: str

GetHolderProfileTokenTopHolder ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetHolderProfileTokenTopHolder[GetHolderProfileTokenTopHolder]

              

              click cyhole.birdeye.schema.GetHolderProfileTokenTopHolder href "" "cyhole.birdeye.schema.GetHolderProfileTokenTopHolder"

Top-10 holder concentration block of the Token - Holder Profile response.

Attributes:

Name	Type	Description
`hold_amount`	`str`	cumulative balance of the top-10 holders, in UI units (string).
`percent_of_supply`	`float`	cumulative `hold_amount` expressed as a percent (`[0, 100]`) of total supply.

hold_amount `instance-attribute` ¶

hold_amount: str

percent_of_supply `instance-attribute` ¶

percent_of_supply: float

GetHolderProfileToken ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetHolderProfileToken[GetHolderProfileToken]

              

              click cyhole.birdeye.schema.GetHolderProfileToken href "" "cyhole.birdeye.schema.GetHolderProfileToken"

Token-level market snapshot returned alongside the holder profile.

Attributes:

Name	Type	Description
`creation_time`	`int`	unix-second timestamp at which Birdeye first detected the token.
`liquidity`	`float`	total on-chain liquidity in USD.
`market_cap`	`float`	current market capitalisation in USD.
`volume_1h`	`float`	traded volume over the trailing 1h window in the token UI units.
`volume_1h_usd`	`float`	traded volume over the trailing 1h window in USD.
`buy_volume_1h`	`float`	buy-side traded volume over the trailing 1h window in the token UI units.
`buy_volume_1h_usd`	`float`	buy-side traded volume over the trailing 1h window in USD.
`sell_volume_1h`	`float`	sell-side traded volume over the trailing 1h window in the token UI units.
`sell_volume_1h_usd`	`float`	sell-side traded volume over the trailing 1h window in USD.
`is_scaled_ui_token`	`bool \| None`	`True` when the token is a scaled-UI-amount SPL token; `None` if undetermined.
`top10_holder`	`GetHolderProfileTokenTopHolder`	cumulative-holding snapshot of the top-10 holders.

creation_time `instance-attribute` ¶

creation_time: int

liquidity `instance-attribute` ¶

liquidity: float

market_cap `instance-attribute` ¶

market_cap: float

volume_1h `instance-attribute` ¶

volume_1h: float

volume_1h_usd `instance-attribute` ¶

volume_1h_usd: float

buy_volume_1h `instance-attribute` ¶

buy_volume_1h: float

buy_volume_1h_usd `instance-attribute` ¶

buy_volume_1h_usd: float

sell_volume_1h `instance-attribute` ¶

sell_volume_1h: float

sell_volume_1h_usd `instance-attribute` ¶

sell_volume_1h_usd: float

is_scaled_ui_token `class-attribute` `instance-attribute` ¶

is_scaled_ui_token: bool | None = None

top10_holder `instance-attribute` ¶

top10_holder: GetHolderProfileTokenTopHolder

GetHolderProfileData ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetHolderProfileData[GetHolderProfileData]

              

              click cyhole.birdeye.schema.GetHolderProfileData href "" "cyhole.birdeye.schema.GetHolderProfileData"

Payload of the Token - Holder Profile response.

Attributes:

Name	Type	Description
`token`	`GetHolderProfileToken`	token-level market snapshot (creation time, liquidity, 1h volume breakdown, top-10 holder concentration).
`holder_summary`	`GetHolderProfileSummary`	headline holder counts for the token.
`tags`	`list[GetHolderProfileTagBreakdown]`	per-tag breakdown of holder and trading figures (always five entries: `bundler`, `sniper`, `insider`, `dev`, `smart_trader`).

token `instance-attribute` ¶

token: GetHolderProfileToken

holder_summary `instance-attribute` ¶

holder_summary: GetHolderProfileSummary

tags `instance-attribute` ¶

tags: list[GetHolderProfileTagBreakdown]

GetHolderProfileResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetHolderProfileResponse[GetHolderProfileResponse]

              

              click cyhole.birdeye.schema.GetHolderProfileResponse href "" "cyhole.birdeye.schema.GetHolderProfileResponse"

Model used to represent the Token - Holder Profile endpoint from birdeye API.

Attributes:

Name	Type	Description
`data`	`GetHolderProfileData`	holder-profile payload.
`success`	`bool`	`True` when the API call completed without errors.

data `instance-attribute` ¶

data: GetHolderProfileData

success `instance-attribute` ¶

success: bool

GetTokenHolderPositionItem ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetTokenHolderPositionItem[GetTokenHolderPositionItem]

              

              click cyhole.birdeye.schema.GetTokenHolderPositionItem href "" "cyhole.birdeye.schema.GetTokenHolderPositionItem"

Single per-wallet position entry returned by the v1 Token - Holder Positions endpoint.

Numeric fields are returned by Birdeye as strings to preserve precision.

Attributes:

Name	Type	Description
`wallet_address`	`str`	wallet that holds the position.
`labels`	`list[str]`	list of Birdeye holder tags attached to the wallet (e.g. `bundler`, `sniper`, `insider`, `dev`, `smart_trader`); empty when no tags are assigned.
`hold_amount`	`str`	current balance of the wallet in the token, in UI units (string).
`percent_of_supply`	`float`	current balance expressed as a percent (`[0, 100]`) of total supply.
`avg_buy_price`	`str`	volume-weighted average buy price across all of the wallet's buy trades, in USD (string).
`buy_count`	`int`	number of buy trades executed by the wallet on the token over the lookup window.
`buy_volume`	`str`	cumulative buy volume in the token UI units (string).
`buy_volume_usd`	`str`	cumulative buy volume in USD (string).
`sell_count`	`int`	number of sell trades executed by the wallet on the token over the lookup window.
`sell_volume`	`str`	cumulative sell volume in the token UI units (string).
`sell_volume_usd`	`str`	cumulative sell volume in USD (string).
`pnl`	`str`	cumulative profit-and-loss for this wallet on the token, in USD (string).
`first_trade_at`	`str`	ISO-8601 timestamp of the wallet's first observed trade on the token.

wallet_address `instance-attribute` ¶

wallet_address: str

labels `class-attribute` `instance-attribute` ¶

labels: list[str] = []

hold_amount `instance-attribute` ¶

hold_amount: str

percent_of_supply `instance-attribute` ¶

percent_of_supply: float

avg_buy_price `instance-attribute` ¶

avg_buy_price: str

buy_count `instance-attribute` ¶

buy_count: int

buy_volume `instance-attribute` ¶

buy_volume: str

buy_volume_usd `instance-attribute` ¶

buy_volume_usd: str

sell_count `instance-attribute` ¶

sell_count: int

sell_volume `instance-attribute` ¶

sell_volume: str

sell_volume_usd `instance-attribute` ¶

sell_volume_usd: str

pnl `instance-attribute` ¶

pnl: str

first_trade_at `instance-attribute` ¶

first_trade_at: str

GetTokenHolderPositionsResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetTokenHolderPositionsResponse[GetTokenHolderPositionsResponse]

              

              click cyhole.birdeye.schema.GetTokenHolderPositionsResponse href "" "cyhole.birdeye.schema.GetTokenHolderPositionsResponse"

Model used to represent the Token - Holder Positions endpoint from birdeye API.

Attributes:

Name	Type	Description
`data`	`list[GetTokenHolderPositionItem]`	paginated list of per-wallet position entries; the API returns the list directly under `data` (no wrapping `items` key).
`success`	`bool`	`True` when the API call completed without errors.

data `instance-attribute` ¶

data: list[GetTokenHolderPositionItem]

success `instance-attribute` ¶

success: bool

GetTokenHolderChartItem ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetTokenHolderChartItem[GetTokenHolderChartItem]

              

              click cyhole.birdeye.schema.GetTokenHolderChartItem href "" "cyhole.birdeye.schema.GetTokenHolderChartItem"

Single time-series data point returned by the Token - Holder Chart endpoint.

Attributes:

Name	Type	Description
`timestamp`	`int`	unix-second timestamp at which the holder count was observed.
`holder`	`int`	holder count at `timestamp`.
`net_change`	`int`	absolute change in holder count versus the previous data point (positive = holders added).
`percent_change`	`float`	relative change versus the reference point chosen via `percent_mode` (beginning of the window or previous point), expressed as a fraction (`-1..1+`).

timestamp `instance-attribute` ¶

timestamp: int

holder `instance-attribute` ¶

holder: int

net_change `instance-attribute` ¶

net_change: int

percent_change `instance-attribute` ¶

percent_change: float

GetTokenHolderChartResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetTokenHolderChartResponse[GetTokenHolderChartResponse]

              

              click cyhole.birdeye.schema.GetTokenHolderChartResponse href "" "cyhole.birdeye.schema.GetTokenHolderChartResponse"

Model used to represent the Token - Holder Chart endpoint from birdeye API.

Attributes:

Name	Type	Description
`data`	`list[GetTokenHolderChartItem]`	time-series of holder-count data points. The API returns the list directly under `data` (no wrapping `items` key).
`success`	`bool`	`True` when the API call completed without errors.

data `instance-attribute` ¶

data: list[GetTokenHolderChartItem]

success `instance-attribute` ¶

success: bool

PostTokenTransferBody ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.PostTokenTransferBody[PostTokenTransferBody]

              

              click cyhole.birdeye.schema.PostTokenTransferBody href "" "cyhole.birdeye.schema.PostTokenTransferBody"

Request body for the POST Token - Transfer List endpoint.

Every field except token_address is optional and acts as a filter on the returned list.

Attributes:

Name	Type	Description
`token_address`	`str`	contract address of the SPL token whose transfers must be listed.
`time_from`	`int \| None`	optional inclusive lower bound on the transfer time, in unix seconds; `None` to disable the filter.
`time_to`	`int \| None`	optional inclusive upper bound on the transfer time, in unix seconds; `None` to disable the filter.
`from_amount`	`float \| None`	optional inclusive lower bound on the transfer amount in UI units; `None` to disable.
`to_amount`	`float \| None`	optional inclusive upper bound on the transfer amount in UI units; `None` to disable.
`from_value`	`float \| None`	optional inclusive lower bound on the transfer USD value; `None` to disable.
`to_value`	`float \| None`	optional inclusive upper bound on the transfer USD value; `None` to disable.
`from_wallet`	`str \| None`	optional sender wallet address to filter by; `None` to disable the filter.
`to_wallet`	`str \| None`	optional receiver wallet address to filter by; `None` to disable the filter.
`cursor`	`str \| None`	opaque pagination cursor returned by a previous call; leave `None` for the first page.
`limit`	`int \| None`	maximum number of transfers to return per call; `None` defers to Birdeye's server-side default.

token_address `instance-attribute` ¶

token_address: str

time_from `class-attribute` `instance-attribute` ¶

time_from: int | None = None

time_to `class-attribute` `instance-attribute` ¶

time_to: int | None = None

from_amount `class-attribute` `instance-attribute` ¶

from_amount: float | None = None

to_amount `class-attribute` `instance-attribute` ¶

to_amount: float | None = None

from_value `class-attribute` `instance-attribute` ¶

from_value: float | None = None

to_value `class-attribute` `instance-attribute` ¶

to_value: float | None = None

from_wallet `class-attribute` `instance-attribute` ¶

from_wallet: str | None = None

to_wallet `class-attribute` `instance-attribute` ¶

to_wallet: str | None = None

cursor `class-attribute` `instance-attribute` ¶

cursor: str | None = None

limit `class-attribute` `instance-attribute` ¶

limit: int | None = None

PostTokenTransferItemTokenInfo ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.PostTokenTransferItemTokenInfo[PostTokenTransferItemTokenInfo]

              

              click cyhole.birdeye.schema.PostTokenTransferItemTokenInfo href "" "cyhole.birdeye.schema.PostTokenTransferItemTokenInfo"

Compact identity payload Birdeye attaches to every transfer entry.

Attributes:

Name	Type	Description
`address`	`str`	contract address of the SPL token transferred.
`decimals`	`int`	number of decimal places used by the token.
`symbol`	`str \| None`	ticker symbol of the token; `None` if unknown.
`name`	`str \| None`	human-readable name of the token; `None` if unknown.
`logo_uri`	`str \| None`	URL of the token logo; `None` if Birdeye does not have a logo for the token.

address `instance-attribute` ¶

address: str

decimals `instance-attribute` ¶

decimals: int

symbol `class-attribute` `instance-attribute` ¶

symbol: str | None = None

name `class-attribute` `instance-attribute` ¶

name: str | None = None

logo_uri `class-attribute` `instance-attribute` ¶

logo_uri: str | None = None

PostTokenTransferItem ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.PostTokenTransferItem[PostTokenTransferItem]

              

              click cyhole.birdeye.schema.PostTokenTransferItem href "" "cyhole.birdeye.schema.PostTokenTransferItem"

Single SPL token transfer transaction returned by the POST Token - Transfer List endpoint.

Attributes:

Name	Type	Description
`tx_hash`	`str`	signature of the on-chain transaction that produced the transfer.
`block_number`	`int`	slot/block number in which the transaction was processed.
`time`	`str`	ISO-8601 timestamp of the transfer.
`unix_time`	`int`	unix-second timestamp matching `time`.
`action`	`str`	high-level classification of the on-chain action (e.g. `transfer`).
`flow`	`str`	direction of the transfer relative to the queried token (`in` / `out`).
`token_address`	`str`	contract address of the SPL token transferred.
`token_info`	`PostTokenTransferItemTokenInfo`	compact identity payload (`address`, `decimals`, `symbol`, ...) of the token.
`from_address`	`str`	wallet address that sent the tokens.
`from_token_account`	`str`	SPL token account on the sender side.
`to_address`	`str`	wallet address that received the tokens.
`to_token_account`	`str`	SPL token account on the receiver side.
`amount`	`str`	raw amount transferred, in the token's smallest units (string).
`ui_amount`	`float`	UI-formatted amount (i.e. `amount / 10**decimals`).
`price`	`float`	per-token price in USD at the time of the transfer.
`value`	`float`	total USD value of the transfer (`ui_amount * price`).

tx_hash `instance-attribute` ¶

tx_hash: str

block_number `instance-attribute` ¶

block_number: int

time `instance-attribute` ¶

time: str

unix_time `instance-attribute` ¶

unix_time: int

action `instance-attribute` ¶

action: str

flow `instance-attribute` ¶

flow: str

token_address `instance-attribute` ¶

token_address: str

token_info `instance-attribute` ¶

token_info: PostTokenTransferItemTokenInfo

from_address `instance-attribute` ¶

from_address: str

from_token_account `instance-attribute` ¶

from_token_account: str

to_address `instance-attribute` ¶

to_address: str

to_token_account `instance-attribute` ¶

to_token_account: str

amount `instance-attribute` ¶

amount: str

ui_amount `instance-attribute` ¶

ui_amount: float

price `instance-attribute` ¶

price: float

value `instance-attribute` ¶

value: float

PostTokenTransferResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.PostTokenTransferResponse[PostTokenTransferResponse]

              

              click cyhole.birdeye.schema.PostTokenTransferResponse href "" "cyhole.birdeye.schema.PostTokenTransferResponse"

Model used to represent the Token - Transfer List endpoint from birdeye API.

Attributes:

Name	Type	Description
`data`	`list[PostTokenTransferItem]`	paginated list of transfer entries; the API returns the list directly under `data` (no wrapping `items` key). To fetch the next page, reissue the call with the appropriate `cursor` value.
`success`	`bool`	`True` when the API call completed without errors.

data `instance-attribute` ¶

data: list[PostTokenTransferItem]

success `instance-attribute` ¶

success: bool

PostTokenTransferTotalBody ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.PostTokenTransferTotalBody[PostTokenTransferTotalBody]

              

              click cyhole.birdeye.schema.PostTokenTransferTotalBody href "" "cyhole.birdeye.schema.PostTokenTransferTotalBody"

Request body for the POST Token - Transfer Total endpoint.

Mirrors PostTokenTransferBody minus the pagination fields (cursor, limit), since the endpoint returns only an aggregate count.

Attributes:

Name	Type	Description
`token_address`	`str`	contract address of the SPL token whose transfer count must be returned.
`time_from`	`int \| None`	optional inclusive lower bound on the transfer time, in unix seconds; `None` to disable the filter.
`time_to`	`int \| None`	optional inclusive upper bound on the transfer time, in unix seconds; `None` to disable the filter.
`from_amount`	`float \| None`	optional inclusive lower bound on the transfer amount in UI units; `None` to disable.
`to_amount`	`float \| None`	optional inclusive upper bound on the transfer amount in UI units; `None` to disable.
`from_value`	`float \| None`	optional inclusive lower bound on the transfer USD value; `None` to disable.
`to_value`	`float \| None`	optional inclusive upper bound on the transfer USD value; `None` to disable.
`from_wallet`	`str \| None`	optional sender wallet address to filter by; `None` to disable the filter.
`to_wallet`	`str \| None`	optional receiver wallet address to filter by; `None` to disable the filter.

token_address `instance-attribute` ¶

token_address: str

time_from `class-attribute` `instance-attribute` ¶

time_from: int | None = None

time_to `class-attribute` `instance-attribute` ¶

time_to: int | None = None

from_amount `class-attribute` `instance-attribute` ¶

from_amount: float | None = None

to_amount `class-attribute` `instance-attribute` ¶

to_amount: float | None = None

from_value `class-attribute` `instance-attribute` ¶

from_value: float | None = None

to_value `class-attribute` `instance-attribute` ¶

to_value: float | None = None

from_wallet `class-attribute` `instance-attribute` ¶

from_wallet: str | None = None

to_wallet `class-attribute` `instance-attribute` ¶

to_wallet: str | None = None

PostTokenTransferTotalData ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.PostTokenTransferTotalData[PostTokenTransferTotalData]

              

              click cyhole.birdeye.schema.PostTokenTransferTotalData href "" "cyhole.birdeye.schema.PostTokenTransferTotalData"

Payload of the POST Token - Transfer Total response.

Attributes:

Name	Type	Description
`total`	`int`	total number of transfers matching the request filters.

total `instance-attribute` ¶

total: int

PostTokenTransferTotalResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.PostTokenTransferTotalResponse[PostTokenTransferTotalResponse]

              

              click cyhole.birdeye.schema.PostTokenTransferTotalResponse href "" "cyhole.birdeye.schema.PostTokenTransferTotalResponse"

Model used to represent the Token - Transfer Total endpoint from birdeye API.

Attributes:

Name	Type	Description
`data`	`PostTokenTransferTotalData`	aggregate-count payload.
`success`	`bool`	`True` when the API call completed without errors.

data `instance-attribute` ¶

data: PostTokenTransferTotalData

success `instance-attribute` ¶

success: bool

GetWalletSupportedNetworksResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetWalletSupportedNetworksResponse[GetWalletSupportedNetworksResponse]

              

              click cyhole.birdeye.schema.GetWalletSupportedNetworksResponse href "" "cyhole.birdeye.schema.GetWalletSupportedNetworksResponse"

Model used to represent the Wallet - Supported Networks endpoint from birdeye API.

data `instance-attribute` ¶

data: list[str]

success `instance-attribute` ¶

success: bool

GetV3SearchQuery ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3SearchQuery[GetV3SearchQuery]

              

              click cyhole.birdeye.schema.GetV3SearchQuery href "" "cyhole.birdeye.schema.GetV3SearchQuery"

Query-parameter bag for the Birdeye v3 Search endpoint.

Every field is optional and only sent when set. The default call returns all matching tokens and markets sorted by 24h USD volume descending, using exact symbol matching across all supported chains.

Attributes:

Name	Type	Description
`chain`	`str \| None`	chain to restrict the search to; pass a `BirdeyeChain` value, or `"all"` to search every supported chain (server default when `None`).
`keyword`	`str \| None`	search term — token name, symbol, or contract address.
`target`	`str \| None`	result type to return. Use `BirdeyeSearchTarget` constants. `None` → server defaults to `"all"` (tokens and markets).
`search_mode`	`str \| None`	matching behaviour — `"exact"` or `"fuzzy"`. Use `BirdeyeSearchMode` constants. `None` → server defaults to `"exact"`.
`search_by`	`str \| None`	field to match the keyword against — `"combination"`, `"address"`, `"name"`, or `"symbol"`. Use `BirdeyeSearchBy` constants. `None` → server defaults to `"symbol"`.
`sort_by`	`str \| None`	metric used to rank results. Use `BirdeyeSearchSortBy` constants. `None` → server defaults to `"volume_24h_usd"`.
`sort_type`	`str \| None`	ascending or descending direction. Use `BirdeyeOrder` constants. `None` → server defaults to `"desc"`.
`verify_token`	`bool \| None`	when `True`, restrict results to Birdeye-verified tokens (Solana only). `None` → no verification filter applied.
`markets`	`str \| None`	comma-separated list of DEX/market sources to restrict results to (e.g. `"Raydium,Orca"`). `None` → no market-source filter.
`offset`	`int \| None`	zero-based pagination offset. `None` → server defaults to `0`.
`limit`	`int \| None`	number of results per page (1–20). `None` → server defaults to `20`.
`ui_amount_mode`	`str \| None`	how to format scaled-UI-amount token figures on Solana. Use `BirdeyeUIAmountMode` constants. `None` → server defaults to `"scaled"`.

chain `class-attribute` `instance-attribute` ¶

chain: str | None = None

keyword `class-attribute` `instance-attribute` ¶

keyword: str | None = None

target `class-attribute` `instance-attribute` ¶

target: str | None = None

search_mode `class-attribute` `instance-attribute` ¶

search_mode: str | None = None

search_by `class-attribute` `instance-attribute` ¶

search_by: str | None = None

sort_by `class-attribute` `instance-attribute` ¶

sort_by: str | None = None

sort_type `class-attribute` `instance-attribute` ¶

sort_type: str | None = None

verify_token `class-attribute` `instance-attribute` ¶

verify_token: bool | None = None

markets `class-attribute` `instance-attribute` ¶

markets: str | None = None

offset `class-attribute` `instance-attribute` ¶

offset: int | None = None

limit `class-attribute` `instance-attribute` ¶

limit: int | None = None

ui_amount_mode `class-attribute` `instance-attribute` ¶

ui_amount_mode: str | None = None

GetV3SearchResultItem ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3SearchResultItem[GetV3SearchResultItem]

              

              click cyhole.birdeye.schema.GetV3SearchResultItem href "" "cyhole.birdeye.schema.GetV3SearchResultItem"

Single result item inside a v3 Search response bucket.

This model covers both token and market result types. Fields that belong to only one type are None when the other type is returned. Inspect the parent GetV3SearchItem.type field (either "token" or "market") to determine which subset of fields is populated.

Attributes:

Name	Type	Description
`name`	`str \| None`	human-readable name of the token or market pair.
`symbol`	`str \| None`	ticker symbol; present for token results, `None` for market results.
`address`	`str \| None`	contract address of the token, or market (pair) address.
`decimals`	`int \| None`	on-chain decimal places of the token; `None` for market results.
`fdv`	`float \| None`	fully-diluted valuation in USD; present for token results, `None` otherwise.
`market_cap`	`float \| None`	market capitalisation in USD; present for token results, `None` otherwise.
`liquidity`	`float \| None`	current on-chain liquidity in USD; `None` when not available.
`price`	`float \| None`	latest price in USD; `None` when not available.
`price_change_24h_percent`	`float \| None`	percent price change over the trailing 24h window; `None` when not available.
`volume_24h_usd`	`float \| None`	USD traded volume during the trailing 24h window; `None` when not available.
`volume_24h_change_percent`	`float \| None`	percent change of USD volume vs the previous 24h window; `None` when not available.
`trade_24h`	`int \| None`	total number of trades during the trailing 24h window; `None` when not available.
`trade_24h_change_percent`	`float \| None`	percent change of trade count vs the previous 24h window; `None` when not available.
`buy_24h`	`int \| None`	number of buy-side trades during the trailing 24h window; `None` when not available.
`buy_24h_change_percent`	`float \| None`	percent change of buy trades vs the previous 24h window; `None` when not available.
`sell_24h`	`int \| None`	number of sell-side trades during the trailing 24h window; `None` when not available.
`sell_24h_change_percent`	`float \| None`	percent change of sell trades vs the previous 24h window; `None` when not available.
`unique_wallet_24h`	`int \| None`	unique wallets that traded during the trailing 24h window; `None` when not available.
`unique_view_24h_change_percent`	`float \| None`	percent change of unique wallet count vs the previous 24h window; `None` when not available.
`last_trade_unix_time`	`int \| None`	unix-second timestamp of the most recent trade; `None` when not available.
`logo_uri`	`str \| None`	URL of the token or market logo; `None` when Birdeye has no image. (alias `logoURI`)
`network`	`str \| None`	chain identifier the result belongs to (e.g. `"solana"`, `"ethereum"`); `None` when not provided by the API.
`verify_status`	`str \| None`	Birdeye verification status (e.g. `"verified"`); `None` for market results or unverified tokens.
`created_at`	`str \| None`	ISO-8601 creation timestamp of the token or market; `None` when unknown.
`num_markets`	`int \| None`	number of DEX markets that list this token; present for token results, `None` otherwise.
`source`	`str \| None`	DEX or AMM name the market belongs to; present for market results, `None` for token results.
`base_address`	`str \| None`	base token address of the market pair; present for market results, `None` for token results.
`quote_address`	`str \| None`	quote token address of the market pair; present for market results, `None` for token results.

model_config `class-attribute` `instance-attribute` ¶

model_config = {'extra': 'allow', 'populate_by_name': True}

name `class-attribute` `instance-attribute` ¶

name: str | None = None

symbol `class-attribute` `instance-attribute` ¶

symbol: str | None = None

address `class-attribute` `instance-attribute` ¶

address: str | None = None

decimals `class-attribute` `instance-attribute` ¶

decimals: int | None = None

fdv `class-attribute` `instance-attribute` ¶

fdv: float | None = None

market_cap `class-attribute` `instance-attribute` ¶

market_cap: float | None = None

liquidity `class-attribute` `instance-attribute` ¶

liquidity: float | None = None

price `class-attribute` `instance-attribute` ¶

price: float | None = None

price_change_24h_percent `class-attribute` `instance-attribute` ¶

price_change_24h_percent: float | None = None

volume_24h_usd `class-attribute` `instance-attribute` ¶

volume_24h_usd: float | None = None

volume_24h_change_percent `class-attribute` `instance-attribute` ¶

volume_24h_change_percent: float | None = None

trade_24h `class-attribute` `instance-attribute` ¶

trade_24h: int | None = None

trade_24h_change_percent `class-attribute` `instance-attribute` ¶

trade_24h_change_percent: float | None = None

buy_24h `class-attribute` `instance-attribute` ¶

buy_24h: int | None = None

buy_24h_change_percent `class-attribute` `instance-attribute` ¶

buy_24h_change_percent: float | None = None

sell_24h `class-attribute` `instance-attribute` ¶

sell_24h: int | None = None

sell_24h_change_percent `class-attribute` `instance-attribute` ¶

sell_24h_change_percent: float | None = None

unique_wallet_24h `class-attribute` `instance-attribute` ¶

unique_wallet_24h: int | None = None

unique_view_24h_change_percent `class-attribute` `instance-attribute` ¶

unique_view_24h_change_percent: float | None = None

last_trade_unix_time `class-attribute` `instance-attribute` ¶

last_trade_unix_time: int | None = None

logo_uri `class-attribute` `instance-attribute` ¶

logo_uri: str | None = Field(default=None, alias='logoURI')

network `class-attribute` `instance-attribute` ¶

network: str | None = None

verify_status `class-attribute` `instance-attribute` ¶

verify_status: str | None = None

created_at `class-attribute` `instance-attribute` ¶

created_at: str | None = None

num_markets `class-attribute` `instance-attribute` ¶

num_markets: int | None = None

source `class-attribute` `instance-attribute` ¶

source: str | None = None

base_address `class-attribute` `instance-attribute` ¶

base_address: str | None = None

quote_address `class-attribute` `instance-attribute` ¶

quote_address: str | None = None

GetV3SearchItem ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3SearchItem[GetV3SearchItem]

              

              click cyhole.birdeye.schema.GetV3SearchItem href "" "cyhole.birdeye.schema.GetV3SearchItem"

One entity-type bucket in the v3 Search response data payload.

The search endpoint groups results by type — tokens and markets are returned in separate buckets. Each bucket holds all matching items of its type.

Attributes:

Name	Type	Description
`type`	`str`	entity type for the results in this bucket; either `"token"` or `"market"`.
`result`	`list[GetV3SearchResultItem]`	list of matching items for this bucket type.

type `instance-attribute` ¶

type: str

result `instance-attribute` ¶

result: list[GetV3SearchResultItem]

GetV3SearchData ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3SearchData[GetV3SearchData]

              

              click cyhole.birdeye.schema.GetV3SearchData href "" "cyhole.birdeye.schema.GetV3SearchData"

Data wrapper for the Birdeye v3 Search response.

Attributes:

Name	Type	Description
`items`	`list[GetV3SearchItem]`	list of result buckets, one per entity type returned by the query. Depending on the `target` filter, this typically contains a `"token"` bucket, a `"market"` bucket, or both.

items `instance-attribute` ¶

items: list[GetV3SearchItem]

GetV3SearchResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3SearchResponse[GetV3SearchResponse]

              

              click cyhole.birdeye.schema.GetV3SearchResponse href "" "cyhole.birdeye.schema.GetV3SearchResponse"

Model used to represent the Search endpoint from the Birdeye API.

Attributes:

Name	Type	Description
`data`	`GetV3SearchData`	search result buckets grouped by entity type.
`success`	`bool`	`True` when the API processed the request successfully.

data `instance-attribute` ¶

data: GetV3SearchData

success `instance-attribute` ¶

success: bool

GetUtilsV1CreditsBreakdown ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetUtilsV1CreditsBreakdown[GetUtilsV1CreditsBreakdown]

              

              click cyhole.birdeye.schema.GetUtilsV1CreditsBreakdown href "" "cyhole.birdeye.schema.GetUtilsV1CreditsBreakdown"

Credit breakdown by channel for one of the usage, remaining, overage_usage or overage_cost sub-objects in the Utils v1 Credits response.

Attributes:

Name	Type	Description
`api`	`float \| None`	value attributed to REST API calls; `None` when not reported.
`ws`	`float \| None`	value attributed to WebSocket connections; `None` when not reported.
`total`	`float \| None`	combined value across all channels; `None` when not reported.

api `class-attribute` `instance-attribute` ¶

api: float | None = None

ws `class-attribute` `instance-attribute` ¶

ws: float | None = None

total `class-attribute` `instance-attribute` ¶

total: float | None = None

GetUtilsV1CreditsData ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetUtilsV1CreditsData[GetUtilsV1CreditsData]

              

              click cyhole.birdeye.schema.GetUtilsV1CreditsData href "" "cyhole.birdeye.schema.GetUtilsV1CreditsData"

Credit usage payload returned by the Birdeye Utils v1 Credits endpoint.

Attributes:

Name	Type	Description
`start_time`	`int \| None`	unix-second timestamp of the start of the reported period; `None` when not provided.
`end_time`	`int \| None`	unix-second timestamp of the end of the reported period; `None` when not provided.
`usage`	`GetUtilsV1CreditsBreakdown \| None`	credits consumed during the period, broken down by channel; `None` when not reported.
`remaining`	`GetUtilsV1CreditsBreakdown \| None`	credits still available, broken down by channel; `None` when not reported.
`overage_usage`	`GetUtilsV1CreditsBreakdown \| None`	credits consumed beyond the plan limit during the period, broken down by channel; `None` when not reported.
`overage_cost`	`GetUtilsV1CreditsBreakdown \| None`	monetary cost incurred by overage usage, broken down by channel; `None` when not reported.

start_time `class-attribute` `instance-attribute` ¶

start_time: int | None = None

end_time `class-attribute` `instance-attribute` ¶

end_time: int | None = None

usage `class-attribute` `instance-attribute` ¶

usage: GetUtilsV1CreditsBreakdown | None = None

remaining `class-attribute` `instance-attribute` ¶

remaining: GetUtilsV1CreditsBreakdown | None = None

overage_usage `class-attribute` `instance-attribute` ¶

overage_usage: GetUtilsV1CreditsBreakdown | None = None

overage_cost `class-attribute` `instance-attribute` ¶

overage_cost: GetUtilsV1CreditsBreakdown | None = None

GetUtilsV1CreditsResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetUtilsV1CreditsResponse[GetUtilsV1CreditsResponse]

              

              click cyhole.birdeye.schema.GetUtilsV1CreditsResponse href "" "cyhole.birdeye.schema.GetUtilsV1CreditsResponse"

Model used to represent the Utils v1 Credits endpoint from the Birdeye API.

Attributes:

Name	Type	Description
`data`	`GetUtilsV1CreditsData`	credit usage statistics for the current account.
`success`	`bool`	`True` when the API processed the request successfully.

data `instance-attribute` ¶

data: GetUtilsV1CreditsData

success `instance-attribute` ¶

success: bool

GetV3TokenMemeDetailSingleTxRef ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenMemeDetailSingleTxRef[GetV3TokenMemeDetailSingleTxRef]

              

              click cyhole.birdeye.schema.GetV3TokenMemeDetailSingleTxRef href "" "cyhole.birdeye.schema.GetV3TokenMemeDetailSingleTxRef"

Reference to a blockchain transaction associated with a meme token lifecycle event (creation, last update, or graduation). All fields are None when the event has not yet occurred.

Attributes:

Name	Type	Description
`tx_hash`	`str \| None`	base-58 transaction signature; `None` when the event has not occurred.
`slot`	`int \| None`	Solana slot number in which the transaction was confirmed; `None` when not yet confirmed or not applicable.
`block_time`	`int \| None`	unix timestamp (seconds) of the block that included the transaction; `None` when not available.

tx_hash `class-attribute` `instance-attribute` ¶

tx_hash: str | None = None

slot `class-attribute` `instance-attribute` ¶

slot: int | None = None

block_time `class-attribute` `instance-attribute` ¶

block_time: int | None = None

GetV3TokenMemeDetailSinglePool ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenMemeDetailSinglePool[GetV3TokenMemeDetailSinglePool]

              

              click cyhole.birdeye.schema.GetV3TokenMemeDetailSinglePool href "" "cyhole.birdeye.schema.GetV3TokenMemeDetailSinglePool"

On-chain pool (bonding curve) state for a meme token at the time of the API call. Reserve values are returned as decimal strings because they are large integers that cannot be represented exactly as JSON numbers.

Attributes:

Name	Type	Description
`address`	`str`	contract address of the bonding-curve pool.
`real_sol_reserves`	`str`	actual SOL reserves held in the pool, in lamports (as string).
`real_token_reserves`	`str`	actual token reserves held in the pool, in the token's raw (non-UI) units (as string).
`token_total_supply`	`str`	total token supply tracked by the pool, in raw units (as string).
`virtual_token_reserves`	`str`	virtual token reserves used by the bonding-curve pricing formula, in raw units (as string).

address `instance-attribute` ¶

address: str

real_sol_reserves `instance-attribute` ¶

real_sol_reserves: str

real_token_reserves `instance-attribute` ¶

real_token_reserves: str

token_total_supply `instance-attribute` ¶

token_total_supply: str

virtual_token_reserves `instance-attribute` ¶

virtual_token_reserves: str

GetV3TokenMemeDetailSingleMemeInfo ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenMemeDetailSingleMemeInfo[GetV3TokenMemeDetailSingleMemeInfo]

              

              click cyhole.birdeye.schema.GetV3TokenMemeDetailSingleMemeInfo href "" "cyhole.birdeye.schema.GetV3TokenMemeDetailSingleMemeInfo"

Meme-platform-specific metadata for a token, covering its origin, lifecycle events, current bonding-curve state, and graduation status.

Attributes:

Name	Type	Description
`source`	`str \| None`	meme launchpad that originated the token (e.g. `"pump_dot_fun"`); `None` if not determined.
`platform_id`	`str \| None`	contract address of the launchpad program on the chain; `None` if not available.
`created_at`	`GetV3TokenMemeDetailSingleTxRef \| None`	transaction reference for the token creation event; `None` if not available.
`creation_time`	`int \| None`	unix timestamp (seconds) of the token creation; `None` if not available.
`creator`	`str \| None`	wallet address that deployed the token; `None` if not available.
`updated_at`	`GetV3TokenMemeDetailSingleTxRef \| None`	transaction reference for the most recent on-chain update; `None` if not available.
`graduated_at`	`GetV3TokenMemeDetailSingleTxRef \| None`	transaction reference for the graduation event (migration from the bonding curve to a DEX pool); all fields are `None` while the token has not yet graduated.
`graduated`	`bool \| None`	`True` once the token has graduated to a DEX pool.
`graduated_time`	`int \| None`	unix timestamp (seconds) of the graduation event; `None` before graduation.
`pool`	`GetV3TokenMemeDetailSinglePool \| None`	current bonding-curve pool state; `None` if pool data is unavailable.
`progress_percent`	`float \| None`	percentage of the bonding-curve funding target that has been reached (0–100); `None` if not available.
`address`	`str \| None`	contract address of the meme token (mirrors the top-level `data.address` field); `None` if not available.

source `class-attribute` `instance-attribute` ¶

source: str | None = None

platform_id `class-attribute` `instance-attribute` ¶

platform_id: str | None = None

created_at `class-attribute` `instance-attribute` ¶

created_at: GetV3TokenMemeDetailSingleTxRef | None = None

creation_time `class-attribute` `instance-attribute` ¶

creation_time: int | None = None

creator `class-attribute` `instance-attribute` ¶

creator: str | None = None

updated_at `class-attribute` `instance-attribute` ¶

updated_at: GetV3TokenMemeDetailSingleTxRef | None = None

graduated_at `class-attribute` `instance-attribute` ¶

graduated_at: GetV3TokenMemeDetailSingleTxRef | None = None

graduated `class-attribute` `instance-attribute` ¶

graduated: bool | None = None

graduated_time `class-attribute` `instance-attribute` ¶

graduated_time: int | None = None

pool `class-attribute` `instance-attribute` ¶

pool: GetV3TokenMemeDetailSinglePool | None = None

progress_percent `class-attribute` `instance-attribute` ¶

progress_percent: float | None = None

address `class-attribute` `instance-attribute` ¶

address: str | None = None

GetV3TokenMemeDetailSingleData ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenMemeDetailSingleData[GetV3TokenMemeDetailSingleData]

              

              click cyhole.birdeye.schema.GetV3TokenMemeDetailSingleData href "" "cyhole.birdeye.schema.GetV3TokenMemeDetailSingleData"

Full detail payload for a single meme token as returned by the Birdeye v3 Meme Token Detail endpoint.

Attributes:

Name	Type	Description
`address`	`str`	contract address of the meme token on the selected chain.
`name`	`str \| None`	human-readable name of the token; `None` if not available.
`symbol`	`str \| None`	ticker symbol of the token; `None` if not available.
`decimals`	`int \| None`	number of decimal places used by the token; `None` if not available.
`extensions`	`dict[str, str \| None] \| None`	free-form metadata bag containing optional social and descriptive fields (e.g. `twitter`, `website`, `description`); individual values may be `None`, and the whole dict is `None` when Birdeye has no metadata.
`logo_uri`	`str \| None`	URL of the token logo image; `None` if not available.
`price`	`float \| None`	latest known price of the token in USD; `None` if not available.
`liquidity`	`float \| None`	current on-chain liquidity of the token in USD; `None` if not available.
`circulating_supply`	`float \| None`	circulating token supply in UI units; `None` if not available.
`market_cap`	`float \| None`	market capitalisation in USD; `None` if not available.
`total_supply`	`float \| None`	total token supply in UI units; `None` if not available.
`fdv`	`float \| None`	fully-diluted valuation in USD; `None` if not available.
`meme_info`	`GetV3TokenMemeDetailSingleMemeInfo \| None`	meme-platform-specific metadata including launchpad origin, bonding-curve pool state, and graduation status; `None` if not available.

address `instance-attribute` ¶

address: str

name `class-attribute` `instance-attribute` ¶

name: str | None = None

symbol `class-attribute` `instance-attribute` ¶

symbol: str | None = None

decimals `class-attribute` `instance-attribute` ¶

decimals: int | None = None

extensions `class-attribute` `instance-attribute` ¶

extensions: dict[str, str | None] | None = None

logo_uri `class-attribute` `instance-attribute` ¶

logo_uri: str | None = None

price `class-attribute` `instance-attribute` ¶

price: float | None = None

liquidity `class-attribute` `instance-attribute` ¶

liquidity: float | None = None

circulating_supply `class-attribute` `instance-attribute` ¶

circulating_supply: float | None = None

market_cap `class-attribute` `instance-attribute` ¶

market_cap: float | None = None

total_supply `class-attribute` `instance-attribute` ¶

total_supply: float | None = None

fdv `class-attribute` `instance-attribute` ¶

fdv: float | None = None

meme_info `class-attribute` `instance-attribute` ¶

meme_info: GetV3TokenMemeDetailSingleMemeInfo | None = None

GetV3TokenMemeDetailSingleResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenMemeDetailSingleResponse[GetV3TokenMemeDetailSingleResponse]

              

              click cyhole.birdeye.schema.GetV3TokenMemeDetailSingleResponse href "" "cyhole.birdeye.schema.GetV3TokenMemeDetailSingleResponse"

Model used to represent the Meme Token Detail - Single endpoint from the Birdeye v3 API.

Attributes:

Name	Type	Description
`data`	`GetV3TokenMemeDetailSingleData`	full detail payload for the requested meme token.
`success`	`bool`	`True` when the API call completed without errors.

data `instance-attribute` ¶

data: GetV3TokenMemeDetailSingleData

success `instance-attribute` ¶

success: bool

GetV3TokenMemeListQuery ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenMemeListQuery[GetV3TokenMemeListQuery]

              

              click cyhole.birdeye.schema.GetV3TokenMemeListQuery href "" "cyhole.birdeye.schema.GetV3TokenMemeListQuery"

Query parameters for the Birdeye v3 Meme Token - List endpoint.

All filter fields are optional; unset fields are excluded from the request. sort_by and sort_type default to progress_percent descending.

Attributes:

Name	Type	Description
`sort_by`	`str`	metric to sort the result set by; defaults to `BirdeyeV3MemeListSortBy.PROGRESS_PERCENT`.
`sort_type`	`str`	sort direction; defaults to `BirdeyeOrder.DESCENDING`.
`source`	`str \| None`	restrict results to a specific launchpad; defaults to `BirdeyeV3MemeSource.ALL` (all platforms).
`creator`	`str \| None`	filter by token creator wallet address.
`platform_id`	`str \| None`	filter by launchpad program address on the chain.
`graduated`	`bool \| None`	when `True` return only graduated tokens; when `False` return only non-graduated tokens; `None` returns all.
`min_progress_percent`	`float \| None`	lower bound on bonding-curve progress (0–100).
`max_progress_percent`	`float \| None`	upper bound on bonding-curve progress (0–100).
`min_graduated_time`	`int \| None`	lower bound on graduation unix timestamp.
`max_graduated_time`	`int \| None`	upper bound on graduation unix timestamp.
`min_creation_time`	`int \| None`	lower bound on token creation unix timestamp.
`max_creation_time`	`int \| None`	upper bound on token creation unix timestamp.
`min_liquidity`	`float \| None`	lower bound on current liquidity (USD).
`max_liquidity`	`float \| None`	upper bound on current liquidity (USD).
`min_market_cap`	`float \| None`	lower bound on market cap (USD).
`max_market_cap`	`float \| None`	upper bound on market cap (USD).
`min_fdv`	`float \| None`	lower bound on fully-diluted valuation (USD).
`max_fdv`	`float \| None`	upper bound on fully-diluted valuation (USD).
`min_recent_listing_time`	`int \| None`	lower bound on the Birdeye listing unix timestamp.
`max_recent_listing_time`	`int \| None`	upper bound on the Birdeye listing unix timestamp.
`min_last_trade_unix_time`	`int \| None`	lower bound on the last trade unix timestamp.
`max_last_trade_unix_time`	`int \| None`	upper bound on the last trade unix timestamp.
`min_holder`	`int \| None`	minimum number of distinct token holders.
`min_volume_1m_usd`	`float \| None`	minimum USD volume over the trailing 1 minute window.
`min_volume_5m_usd`	`float \| None`	minimum USD volume over the trailing 5 minute window.
`min_volume_30m_usd`	`float \| None`	minimum USD volume over the trailing 30 minute window.
`min_volume_1h_usd`	`float \| None`	minimum USD volume over the trailing 1 hour window.
`min_volume_2h_usd`	`float \| None`	minimum USD volume over the trailing 2 hour window.
`min_volume_4h_usd`	`float \| None`	minimum USD volume over the trailing 4 hour window.
`min_volume_8h_usd`	`float \| None`	minimum USD volume over the trailing 8 hour window.
`min_volume_24h_usd`	`float \| None`	minimum USD volume over the trailing 24 hour window.
`min_volume_7d_usd`	`float \| None`	minimum USD volume over the trailing 7 day window.
`min_volume_30d_usd`	`float \| None`	minimum USD volume over the trailing 30 day window.
`min_volume_1m_change_percent`	`float \| None`	minimum 1 minute volume change percentage.
`min_volume_5m_change_percent`	`float \| None`	minimum 5 minute volume change percentage.
`min_volume_30m_change_percent`	`float \| None`	minimum 30 minute volume change percentage.
`min_volume_1h_change_percent`	`float \| None`	minimum 1 hour volume change percentage.
`min_volume_2h_change_percent`	`float \| None`	minimum 2 hour volume change percentage.
`min_volume_4h_change_percent`	`float \| None`	minimum 4 hour volume change percentage.
`min_volume_8h_change_percent`	`float \| None`	minimum 8 hour volume change percentage.
`min_volume_24h_change_percent`	`float \| None`	minimum 24 hour volume change percentage.
`min_volume_7d_change_percent`	`float \| None`	minimum 7 day volume change percentage.
`min_volume_30d_change_percent`	`float \| None`	minimum 30 day volume change percentage.
`min_price_change_1m_percent`	`float \| None`	minimum 1 minute price change percentage.
`min_price_change_5m_percent`	`float \| None`	minimum 5 minute price change percentage.
`min_price_change_30m_percent`	`float \| None`	minimum 30 minute price change percentage.
`min_price_change_1h_percent`	`float \| None`	minimum 1 hour price change percentage.
`min_price_change_2h_percent`	`float \| None`	minimum 2 hour price change percentage.
`min_price_change_4h_percent`	`float \| None`	minimum 4 hour price change percentage.
`min_price_change_8h_percent`	`float \| None`	minimum 8 hour price change percentage.
`min_price_change_24h_percent`	`float \| None`	minimum 24 hour price change percentage.
`min_price_change_7d_percent`	`float \| None`	minimum 7 day price change percentage.
`min_price_change_30d_percent`	`float \| None`	minimum 30 day price change percentage.
`min_trade_1m_count`	`int \| None`	minimum number of trades in the trailing 1 minute window.
`min_trade_5m_count`	`int \| None`	minimum number of trades in the trailing 5 minute window.
`min_trade_30m_count`	`int \| None`	minimum number of trades in the trailing 30 minute window.
`min_trade_1h_count`	`int \| None`	minimum number of trades in the trailing 1 hour window.
`min_trade_2h_count`	`int \| None`	minimum number of trades in the trailing 2 hour window.
`min_trade_4h_count`	`int \| None`	minimum number of trades in the trailing 4 hour window.
`min_trade_8h_count`	`int \| None`	minimum number of trades in the trailing 8 hour window.
`min_trade_24h_count`	`int \| None`	minimum number of trades in the trailing 24 hour window.
`min_trade_7d_count`	`int \| None`	minimum number of trades in the trailing 7 day window.
`min_trade_30d_count`	`int \| None`	minimum number of trades in the trailing 30 day window.
`offset`	`int \| None`	number of items to skip for pagination; defaults to 0 (max 10000).
`limit`	`int \| None`	maximum number of items to return; defaults to 100 (max 100).

sort_by `class-attribute` `instance-attribute` ¶

sort_by: str = (
    BirdeyeV3MemeListSortBy.PROGRESS_PERCENT.value
)

sort_type `class-attribute` `instance-attribute` ¶

sort_type: str = BirdeyeOrder.DESCENDING.value

source `class-attribute` `instance-attribute` ¶

source: str | None = BirdeyeV3MemeSource.ALL.value

creator `class-attribute` `instance-attribute` ¶

creator: str | None = None

platform_id `class-attribute` `instance-attribute` ¶

platform_id: str | None = None

graduated `class-attribute` `instance-attribute` ¶

graduated: bool | None = None

min_progress_percent `class-attribute` `instance-attribute` ¶

min_progress_percent: float | None = None

max_progress_percent `class-attribute` `instance-attribute` ¶

max_progress_percent: float | None = None

min_graduated_time `class-attribute` `instance-attribute` ¶

min_graduated_time: int | None = None

max_graduated_time `class-attribute` `instance-attribute` ¶

max_graduated_time: int | None = None

min_creation_time `class-attribute` `instance-attribute` ¶

min_creation_time: int | None = None

max_creation_time `class-attribute` `instance-attribute` ¶

max_creation_time: int | None = None

min_liquidity `class-attribute` `instance-attribute` ¶

min_liquidity: float | None = None

max_liquidity `class-attribute` `instance-attribute` ¶

max_liquidity: float | None = None

min_market_cap `class-attribute` `instance-attribute` ¶

min_market_cap: float | None = None

max_market_cap `class-attribute` `instance-attribute` ¶

max_market_cap: float | None = None

min_fdv `class-attribute` `instance-attribute` ¶

min_fdv: float | None = None

max_fdv `class-attribute` `instance-attribute` ¶

max_fdv: float | None = None

min_recent_listing_time `class-attribute` `instance-attribute` ¶

min_recent_listing_time: int | None = None

max_recent_listing_time `class-attribute` `instance-attribute` ¶

max_recent_listing_time: int | None = None

min_last_trade_unix_time `class-attribute` `instance-attribute` ¶

min_last_trade_unix_time: int | None = None

max_last_trade_unix_time `class-attribute` `instance-attribute` ¶

max_last_trade_unix_time: int | None = None

min_holder `class-attribute` `instance-attribute` ¶

min_holder: int | None = None

min_volume_1m_usd `class-attribute` `instance-attribute` ¶

min_volume_1m_usd: float | None = None

min_volume_5m_usd `class-attribute` `instance-attribute` ¶

min_volume_5m_usd: float | None = None

min_volume_30m_usd `class-attribute` `instance-attribute` ¶

min_volume_30m_usd: float | None = None

min_volume_1h_usd `class-attribute` `instance-attribute` ¶

min_volume_1h_usd: float | None = None

min_volume_2h_usd `class-attribute` `instance-attribute` ¶

min_volume_2h_usd: float | None = None

min_volume_4h_usd `class-attribute` `instance-attribute` ¶

min_volume_4h_usd: float | None = None

min_volume_8h_usd `class-attribute` `instance-attribute` ¶

min_volume_8h_usd: float | None = None

min_volume_24h_usd `class-attribute` `instance-attribute` ¶

min_volume_24h_usd: float | None = None

min_volume_7d_usd `class-attribute` `instance-attribute` ¶

min_volume_7d_usd: float | None = None

min_volume_30d_usd `class-attribute` `instance-attribute` ¶

min_volume_30d_usd: float | None = None

min_volume_1m_change_percent `class-attribute` `instance-attribute` ¶

min_volume_1m_change_percent: float | None = None

min_volume_5m_change_percent `class-attribute` `instance-attribute` ¶

min_volume_5m_change_percent: float | None = None

min_volume_30m_change_percent `class-attribute` `instance-attribute` ¶

min_volume_30m_change_percent: float | None = None

min_volume_1h_change_percent `class-attribute` `instance-attribute` ¶

min_volume_1h_change_percent: float | None = None

min_volume_2h_change_percent `class-attribute` `instance-attribute` ¶

min_volume_2h_change_percent: float | None = None

min_volume_4h_change_percent `class-attribute` `instance-attribute` ¶

min_volume_4h_change_percent: float | None = None

min_volume_8h_change_percent `class-attribute` `instance-attribute` ¶

min_volume_8h_change_percent: float | None = None

min_volume_24h_change_percent `class-attribute` `instance-attribute` ¶

min_volume_24h_change_percent: float | None = None

min_volume_7d_change_percent `class-attribute` `instance-attribute` ¶

min_volume_7d_change_percent: float | None = None

min_volume_30d_change_percent `class-attribute` `instance-attribute` ¶

min_volume_30d_change_percent: float | None = None

min_price_change_1m_percent `class-attribute` `instance-attribute` ¶

min_price_change_1m_percent: float | None = None

min_price_change_5m_percent `class-attribute` `instance-attribute` ¶

min_price_change_5m_percent: float | None = None

min_price_change_30m_percent `class-attribute` `instance-attribute` ¶

min_price_change_30m_percent: float | None = None

min_price_change_1h_percent `class-attribute` `instance-attribute` ¶

min_price_change_1h_percent: float | None = None

min_price_change_2h_percent `class-attribute` `instance-attribute` ¶

min_price_change_2h_percent: float | None = None

min_price_change_4h_percent `class-attribute` `instance-attribute` ¶

min_price_change_4h_percent: float | None = None

min_price_change_8h_percent `class-attribute` `instance-attribute` ¶

min_price_change_8h_percent: float | None = None

min_price_change_24h_percent `class-attribute` `instance-attribute` ¶

min_price_change_24h_percent: float | None = None

min_price_change_7d_percent `class-attribute` `instance-attribute` ¶

min_price_change_7d_percent: float | None = None

min_price_change_30d_percent `class-attribute` `instance-attribute` ¶

min_price_change_30d_percent: float | None = None

min_trade_1m_count `class-attribute` `instance-attribute` ¶

min_trade_1m_count: int | None = None

min_trade_5m_count `class-attribute` `instance-attribute` ¶

min_trade_5m_count: int | None = None

min_trade_30m_count `class-attribute` `instance-attribute` ¶

min_trade_30m_count: int | None = None

min_trade_1h_count `class-attribute` `instance-attribute` ¶

min_trade_1h_count: int | None = None

min_trade_2h_count `class-attribute` `instance-attribute` ¶

min_trade_2h_count: int | None = None

min_trade_4h_count `class-attribute` `instance-attribute` ¶

min_trade_4h_count: int | None = None

min_trade_8h_count `class-attribute` `instance-attribute` ¶

min_trade_8h_count: int | None = None

min_trade_24h_count `class-attribute` `instance-attribute` ¶

min_trade_24h_count: int | None = None

min_trade_7d_count `class-attribute` `instance-attribute` ¶

min_trade_7d_count: int | None = None

min_trade_30d_count `class-attribute` `instance-attribute` ¶

min_trade_30d_count: int | None = None

offset `class-attribute` `instance-attribute` ¶

offset: int | None = None

limit `class-attribute` `instance-attribute` ¶

limit: int | None = None

GetV3TokenMemeListMemeInfo ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenMemeListMemeInfo[GetV3TokenMemeListMemeInfo]

              

              click cyhole.birdeye.schema.GetV3TokenMemeListMemeInfo href "" "cyhole.birdeye.schema.GetV3TokenMemeListMemeInfo"

Meme-platform-specific metadata embedded in each item of the Meme Token - List response. Covers the token's origin platform, creator, bonding-curve state, and graduation status.

Attributes:

Name	Type	Description
`created_at`	`GetV3TokenMemeDetailSingleTxRef \| None`	transaction reference for the token creation event; `None` if not available.
`creator`	`str \| None`	wallet address that deployed the token; `None` if not available.
`address`	`str \| None`	contract address of the meme token; `None` if not available.
`creation_time`	`int \| None`	unix timestamp (seconds) of the token creation; `None` if not available.
`graduated`	`bool \| None`	`True` once the token has graduated to a DEX pool; `None` if not available.
`pool`	`GetV3TokenMemeDetailSinglePool \| None`	current bonding-curve pool state; `None` if pool data is unavailable.
`progress_percent`	`float \| None`	percentage of the bonding-curve funding target that has been reached (0–100); `None` if not available.
`source`	`str \| None`	meme launchpad that originated the token (e.g. `"pump_dot_fun"`); `None` if not determined.
`platform_id`	`str \| None`	contract address of the launchpad program on the chain; `None` if not available.
`graduated_time`	`int \| None`	unix timestamp (seconds) of the graduation event; `None` before graduation.

created_at `class-attribute` `instance-attribute` ¶

created_at: GetV3TokenMemeDetailSingleTxRef | None = None

creator `class-attribute` `instance-attribute` ¶

creator: str | None = None

address `class-attribute` `instance-attribute` ¶

address: str | None = None

creation_time `class-attribute` `instance-attribute` ¶

creation_time: int | None = None

graduated `class-attribute` `instance-attribute` ¶

graduated: bool | None = None

pool `class-attribute` `instance-attribute` ¶

pool: GetV3TokenMemeDetailSinglePool | None = None

progress_percent `class-attribute` `instance-attribute` ¶

progress_percent: float | None = None

source `class-attribute` `instance-attribute` ¶

source: str | None = None

platform_id `class-attribute` `instance-attribute` ¶

platform_id: str | None = None

graduated_time `class-attribute` `instance-attribute` ¶

graduated_time: int | None = None

GetV3TokenMemeListItem ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenMemeListItem[GetV3TokenMemeListItem]

              

              click cyhole.birdeye.schema.GetV3TokenMemeListItem href "" "cyhole.birdeye.schema.GetV3TokenMemeListItem"

A single meme token record returned in the Birdeye v3 Meme Token - List response.

Each item combines standard token identity and market metrics with meme-platform- specific data (bonding-curve progress, graduation status, creator) nested under meme_info.

Attributes:

Name	Type	Description
`address`	`str`	on-chain contract address of the meme token.
`logo_uri`	`str \| None`	URL of the token logo image; `None` if not available.
`name`	`str \| None`	human-readable name of the token; `None` if not available.
`symbol`	`str \| None`	ticker symbol; `None` if not available.
`decimals`	`int \| None`	number of decimal places; `None` if not available.
`extensions`	`dict[str, str \| None] \| None`	free-form metadata bag (social links, description); individual values may be `None`, and the whole dict is `None` when Birdeye has no metadata.
`market_cap`	`float \| None`	market capitalisation in USD; `None` if not available.
`fdv`	`float \| None`	fully-diluted valuation in USD; `None` if not available.
`total_supply`	`float \| None`	total token supply in UI units; `None` if not available.
`circulating_supply`	`float \| None`	circulating supply in UI units; `None` if not available.
`liquidity`	`float \| None`	current on-chain liquidity in USD; `None` if not available.
`last_trade_unix_time`	`int \| None`	unix timestamp (seconds) of the most recent trade; `None` if not available.
`volume_1m_usd`	`float \| None`	USD traded volume over the trailing 1 minute; `None` if not available.
`volume_5m_usd`	`float \| None`	USD traded volume over the trailing 5 minutes; `None` if not available.
`volume_30m_usd`	`float \| None`	USD traded volume over the trailing 30 minutes; `None` if not available.
`volume_1m_change_percent`	`float \| None`	volume percent change vs previous 1 minute window; `None` if not available.
`volume_5m_change_percent`	`float \| None`	volume percent change vs previous 5 minute window; `None` if not available.
`volume_30m_change_percent`	`float \| None`	volume percent change vs previous 30 minute window; `None` if not available.
`volume_1h_usd`	`float \| None`	USD traded volume over the trailing 1 hour; `None` if not available.
`volume_1h_change_percent`	`float \| None`	volume percent change vs previous 1 hour window; `None` if not available.
`volume_2h_usd`	`float \| None`	USD traded volume over the trailing 2 hours; `None` if not available.
`volume_2h_change_percent`	`float \| None`	volume percent change vs previous 2 hour window; `None` if not available.
`volume_4h_usd`	`float \| None`	USD traded volume over the trailing 4 hours; `None` if not available.
`volume_4h_change_percent`	`float \| None`	volume percent change vs previous 4 hour window; `None` if not available.
`volume_8h_usd`	`float \| None`	USD traded volume over the trailing 8 hours; `None` if not available.
`volume_8h_change_percent`	`float \| None`	volume percent change vs previous 8 hour window; `None` if not available.
`volume_24h_usd`	`float \| None`	USD traded volume over the trailing 24 hours; `None` if not available.
`volume_24h_change_percent`	`float \| None`	volume percent change vs previous 24 hour window; `None` if not available.
`volume_7d_usd`	`float \| None`	USD traded volume over the trailing 7 days; `None` if not available.
`volume_7d_change_percent`	`float \| None`	volume percent change vs previous 7 day window; `None` if not available.
`volume_30d_usd`	`float \| None`	USD traded volume over the trailing 30 days; `None` if not available.
`volume_30d_change_percent`	`float \| None`	volume percent change vs previous 30 day window; `None` if not available.
`trade_1m_count`	`int \| None`	number of trades in the trailing 1 minute window; `None` if not available.
`trade_5m_count`	`int \| None`	number of trades in the trailing 5 minute window; `None` if not available.
`trade_30m_count`	`int \| None`	number of trades in the trailing 30 minute window; `None` if not available.
`trade_1h_count`	`int \| None`	number of trades in the trailing 1 hour window; `None` if not available.
`trade_2h_count`	`int \| None`	number of trades in the trailing 2 hour window; `None` if not available.
`trade_4h_count`	`int \| None`	number of trades in the trailing 4 hour window; `None` if not available.
`trade_8h_count`	`int \| None`	number of trades in the trailing 8 hour window; `None` if not available.
`trade_24h_count`	`int \| None`	number of trades in the trailing 24 hour window; `None` if not available.
`trade_7d_count`	`int \| None`	number of trades in the trailing 7 day window; `None` if not available.
`trade_30d_count`	`int \| None`	number of trades in the trailing 30 day window; `None` if not available.
`buy_24h`	`int \| None`	number of buy transactions in the trailing 24 hours; `None` if not available.
`buy_24h_change_percent`	`float \| None`	buy count percent change vs previous 24h window; `None` if not available.
`volume_buy_24h_usd`	`float \| None`	USD volume of buy transactions in the trailing 24 hours; `None` if not available.
`volume_buy_24h_change_percent`	`float \| None`	buy volume percent change vs previous 24h window; `None` if not available.
`buy_7d`	`int \| None`	number of buy transactions in the trailing 7 days; `None` if not available.
`buy_7d_change_percent`	`float \| None`	buy count percent change vs previous 7d window; `None` if not available.
`volume_buy_7d_usd`	`float \| None`	USD volume of buy transactions in the trailing 7 days; `None` if not available.
`volume_buy_7d_change_percent`	`float \| None`	buy volume percent change vs previous 7d window; `None` if not available.
`buy_30d`	`int \| None`	number of buy transactions in the trailing 30 days; `None` if not available.
`buy_30d_change_percent`	`float \| None`	buy count percent change vs previous 30d window; `None` if not available.
`volume_buy_30d_usd`	`float \| None`	USD volume of buy transactions in the trailing 30 days; `None` if not available.
`volume_buy_30d_change_percent`	`float \| None`	buy volume percent change vs previous 30d window; `None` if not available.
`sell_24h`	`int \| None`	number of sell transactions in the trailing 24 hours; `None` if not available.
`sell_24h_change_percent`	`float \| None`	sell count percent change vs previous 24h window; `None` if not available.
`volume_sell_24h_usd`	`float \| None`	USD volume of sell transactions in the trailing 24 hours; `None` if not available.
`volume_sell_24h_change_percent`	`float \| None`	sell volume percent change vs previous 24h window; `None` if not available.
`sell_7d`	`int \| None`	number of sell transactions in the trailing 7 days; `None` if not available.
`sell_7d_change_percent`	`float \| None`	sell count percent change vs previous 7d window; `None` if not available.
`volume_sell_7d_usd`	`float \| None`	USD volume of sell transactions in the trailing 7 days; `None` if not available.
`volume_sell_7d_change_percent`	`float \| None`	sell volume percent change vs previous 7d window; `None` if not available.
`sell_30d`	`int \| None`	number of sell transactions in the trailing 30 days; `None` if not available.
`sell_30d_change_percent`	`float \| None`	sell count percent change vs previous 30d window; `None` if not available.
`volume_sell_30d_usd`	`float \| None`	USD volume of sell transactions in the trailing 30 days; `None` if not available.
`volume_sell_30d_change_percent`	`float \| None`	sell volume percent change vs previous 30d window; `None` if not available.
`unique_wallet_24h`	`int \| None`	number of unique wallets that traded in the trailing 24 hours; `None` if not available.
`unique_wallet_24h_change_percent`	`float \| None`	unique wallet count percent change vs previous 24h window; `None` if not available.
`price`	`float \| None`	latest known price in USD; `None` if not available.
`price_change_1m_percent`	`float \| None`	price percent change over the trailing 1 minute; `None` if not available.
`price_change_5m_percent`	`float \| None`	price percent change over the trailing 5 minutes; `None` if not available.
`price_change_30m_percent`	`float \| None`	price percent change over the trailing 30 minutes; `None` if not available.
`price_change_1h_percent`	`float \| None`	price percent change over the trailing 1 hour; `None` if not available.
`price_change_2h_percent`	`float \| None`	price percent change over the trailing 2 hours; `None` if not available.
`price_change_4h_percent`	`float \| None`	price percent change over the trailing 4 hours; `None` if not available.
`price_change_8h_percent`	`float \| None`	price percent change over the trailing 8 hours; `None` if not available.
`price_change_24h_percent`	`float \| None`	price percent change over the trailing 24 hours; `None` if not available.
`price_change_7d_percent`	`float \| None`	price percent change over the trailing 7 days; `None` if not available.
`price_change_30d_percent`	`float \| None`	price percent change over the trailing 30 days; `None` if not available.
`holder`	`int \| None`	number of distinct token holders; `None` if not available.
`recent_listing_time`	`int \| None`	unix timestamp (seconds) when Birdeye first detected this token listing; `None` if not available.
`meme_info`	`GetV3TokenMemeListMemeInfo \| None`	meme-platform-specific metadata (origin, pool state, graduation status); `None` if not available.

address `instance-attribute` ¶

address: str

logo_uri `class-attribute` `instance-attribute` ¶

logo_uri: str | None = None

name `class-attribute` `instance-attribute` ¶

name: str | None = None

symbol `class-attribute` `instance-attribute` ¶

symbol: str | None = None

decimals `class-attribute` `instance-attribute` ¶

decimals: int | None = None

extensions `class-attribute` `instance-attribute` ¶

extensions: dict[str, str | None] | None = None

market_cap `class-attribute` `instance-attribute` ¶

market_cap: float | None = None

fdv `class-attribute` `instance-attribute` ¶

fdv: float | None = None

total_supply `class-attribute` `instance-attribute` ¶

total_supply: float | None = None

circulating_supply `class-attribute` `instance-attribute` ¶

circulating_supply: float | None = None

liquidity `class-attribute` `instance-attribute` ¶

liquidity: float | None = None

last_trade_unix_time `class-attribute` `instance-attribute` ¶

last_trade_unix_time: int | None = None

volume_1m_usd `class-attribute` `instance-attribute` ¶

volume_1m_usd: float | None = None

volume_5m_usd `class-attribute` `instance-attribute` ¶

volume_5m_usd: float | None = None

volume_30m_usd `class-attribute` `instance-attribute` ¶

volume_30m_usd: float | None = None

volume_1m_change_percent `class-attribute` `instance-attribute` ¶

volume_1m_change_percent: float | None = None

volume_5m_change_percent `class-attribute` `instance-attribute` ¶

volume_5m_change_percent: float | None = None

volume_30m_change_percent `class-attribute` `instance-attribute` ¶

volume_30m_change_percent: float | None = None

volume_1h_usd `class-attribute` `instance-attribute` ¶

volume_1h_usd: float | None = None

volume_1h_change_percent `class-attribute` `instance-attribute` ¶

volume_1h_change_percent: float | None = None

volume_2h_usd `class-attribute` `instance-attribute` ¶

volume_2h_usd: float | None = None

volume_2h_change_percent `class-attribute` `instance-attribute` ¶

volume_2h_change_percent: float | None = None

volume_4h_usd `class-attribute` `instance-attribute` ¶

volume_4h_usd: float | None = None

volume_4h_change_percent `class-attribute` `instance-attribute` ¶

volume_4h_change_percent: float | None = None

volume_8h_usd `class-attribute` `instance-attribute` ¶

volume_8h_usd: float | None = None

volume_8h_change_percent `class-attribute` `instance-attribute` ¶

volume_8h_change_percent: float | None = None

volume_24h_usd `class-attribute` `instance-attribute` ¶

volume_24h_usd: float | None = None

volume_24h_change_percent `class-attribute` `instance-attribute` ¶

volume_24h_change_percent: float | None = None

volume_7d_usd `class-attribute` `instance-attribute` ¶

volume_7d_usd: float | None = None

volume_7d_change_percent `class-attribute` `instance-attribute` ¶

volume_7d_change_percent: float | None = None

volume_30d_usd `class-attribute` `instance-attribute` ¶

volume_30d_usd: float | None = None

volume_30d_change_percent `class-attribute` `instance-attribute` ¶

volume_30d_change_percent: float | None = None

trade_1m_count `class-attribute` `instance-attribute` ¶

trade_1m_count: int | None = None

trade_5m_count `class-attribute` `instance-attribute` ¶

trade_5m_count: int | None = None

trade_30m_count `class-attribute` `instance-attribute` ¶

trade_30m_count: int | None = None

trade_1h_count `class-attribute` `instance-attribute` ¶

trade_1h_count: int | None = None

trade_2h_count `class-attribute` `instance-attribute` ¶

trade_2h_count: int | None = None

trade_4h_count `class-attribute` `instance-attribute` ¶

trade_4h_count: int | None = None

trade_8h_count `class-attribute` `instance-attribute` ¶

trade_8h_count: int | None = None

trade_24h_count `class-attribute` `instance-attribute` ¶

trade_24h_count: int | None = None

trade_7d_count `class-attribute` `instance-attribute` ¶

trade_7d_count: int | None = None

trade_30d_count `class-attribute` `instance-attribute` ¶

trade_30d_count: int | None = None

buy_24h `class-attribute` `instance-attribute` ¶

buy_24h: int | None = None

buy_24h_change_percent `class-attribute` `instance-attribute` ¶

buy_24h_change_percent: float | None = None

volume_buy_24h_usd `class-attribute` `instance-attribute` ¶

volume_buy_24h_usd: float | None = None

volume_buy_24h_change_percent `class-attribute` `instance-attribute` ¶

volume_buy_24h_change_percent: float | None = None

buy_7d `class-attribute` `instance-attribute` ¶

buy_7d: int | None = None

buy_7d_change_percent `class-attribute` `instance-attribute` ¶

buy_7d_change_percent: float | None = None

volume_buy_7d_usd `class-attribute` `instance-attribute` ¶

volume_buy_7d_usd: float | None = None

volume_buy_7d_change_percent `class-attribute` `instance-attribute` ¶

volume_buy_7d_change_percent: float | None = None

buy_30d `class-attribute` `instance-attribute` ¶

buy_30d: int | None = None

buy_30d_change_percent `class-attribute` `instance-attribute` ¶

buy_30d_change_percent: float | None = None

volume_buy_30d_usd `class-attribute` `instance-attribute` ¶

volume_buy_30d_usd: float | None = None

volume_buy_30d_change_percent `class-attribute` `instance-attribute` ¶

volume_buy_30d_change_percent: float | None = None

sell_24h `class-attribute` `instance-attribute` ¶

sell_24h: int | None = None

sell_24h_change_percent `class-attribute` `instance-attribute` ¶

sell_24h_change_percent: float | None = None

volume_sell_24h_usd `class-attribute` `instance-attribute` ¶

volume_sell_24h_usd: float | None = None

volume_sell_24h_change_percent `class-attribute` `instance-attribute` ¶

volume_sell_24h_change_percent: float | None = None

sell_7d `class-attribute` `instance-attribute` ¶

sell_7d: int | None = None

sell_7d_change_percent `class-attribute` `instance-attribute` ¶

sell_7d_change_percent: float | None = None

volume_sell_7d_usd `class-attribute` `instance-attribute` ¶

volume_sell_7d_usd: float | None = None

volume_sell_7d_change_percent `class-attribute` `instance-attribute` ¶

volume_sell_7d_change_percent: float | None = None

sell_30d `class-attribute` `instance-attribute` ¶

sell_30d: int | None = None

sell_30d_change_percent `class-attribute` `instance-attribute` ¶

sell_30d_change_percent: float | None = None

volume_sell_30d_usd `class-attribute` `instance-attribute` ¶

volume_sell_30d_usd: float | None = None

volume_sell_30d_change_percent `class-attribute` `instance-attribute` ¶

volume_sell_30d_change_percent: float | None = None

unique_wallet_24h `class-attribute` `instance-attribute` ¶

unique_wallet_24h: int | None = None

unique_wallet_24h_change_percent `class-attribute` `instance-attribute` ¶

unique_wallet_24h_change_percent: float | None = None

price `class-attribute` `instance-attribute` ¶

price: float | None = None

price_change_1m_percent `class-attribute` `instance-attribute` ¶

price_change_1m_percent: float | None = None

price_change_5m_percent `class-attribute` `instance-attribute` ¶

price_change_5m_percent: float | None = None

price_change_30m_percent `class-attribute` `instance-attribute` ¶

price_change_30m_percent: float | None = None

price_change_1h_percent `class-attribute` `instance-attribute` ¶

price_change_1h_percent: float | None = None

price_change_2h_percent `class-attribute` `instance-attribute` ¶

price_change_2h_percent: float | None = None

price_change_4h_percent `class-attribute` `instance-attribute` ¶

price_change_4h_percent: float | None = None

price_change_8h_percent `class-attribute` `instance-attribute` ¶

price_change_8h_percent: float | None = None

price_change_24h_percent `class-attribute` `instance-attribute` ¶

price_change_24h_percent: float | None = None

price_change_7d_percent `class-attribute` `instance-attribute` ¶

price_change_7d_percent: float | None = None

price_change_30d_percent `class-attribute` `instance-attribute` ¶

price_change_30d_percent: float | None = None

holder `class-attribute` `instance-attribute` ¶

holder: int | None = None

recent_listing_time `class-attribute` `instance-attribute` ¶

recent_listing_time: int | None = None

meme_info `class-attribute` `instance-attribute` ¶

meme_info: GetV3TokenMemeListMemeInfo | None = None

GetV3TokenMemeListData ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenMemeListData[GetV3TokenMemeListData]

              

              click cyhole.birdeye.schema.GetV3TokenMemeListData href "" "cyhole.birdeye.schema.GetV3TokenMemeListData"

Data wrapper for the Birdeye v3 Meme Token - List response.

Attributes:

Name	Type	Description
`items`	`list[GetV3TokenMemeListItem]`	list of meme token records matching the requested filters and sort order.
`has_next`	`bool`	`True` when additional pages are available beyond the current `offset`.

items `instance-attribute` ¶

items: list[GetV3TokenMemeListItem]

has_next `instance-attribute` ¶

has_next: bool

GetV3TokenMemeListResponse ¶

Bases: BaseModel


              flowchart TD
              cyhole.birdeye.schema.GetV3TokenMemeListResponse[GetV3TokenMemeListResponse]

              

              click cyhole.birdeye.schema.GetV3TokenMemeListResponse href "" "cyhole.birdeye.schema.GetV3TokenMemeListResponse"

Model used to represent the Meme Token - List endpoint from the Birdeye v3 API.

Attributes:

Name	Type	Description
`data`	`GetV3TokenMemeListData`	paginated list of meme tokens with market and launchpad metadata.
`success`	`bool`	`True` when the API call completed without errors.

data `instance-attribute` ¶

data: GetV3TokenMemeListData

success `instance-attribute` ¶

success: bool

Response Schema¶

cyhole.birdeye.schema ¶

__all__ module-attribute ¶

GetTokenListInfo ¶

name class-attribute instance-attribute ¶

symbol class-attribute instance-attribute ¶

price instance-attribute ¶

address instance-attribute ¶

decimals instance-attribute ¶

liquidity instance-attribute ¶

volume_24h_usd class-attribute instance-attribute ¶

market_cap class-attribute instance-attribute ¶

volume_24h_change class-attribute instance-attribute ¶

last_trade_unix_time class-attribute instance-attribute ¶

logo_uri class-attribute instance-attribute ¶

GetTokenListData ¶

total class-attribute instance-attribute ¶

update_time class-attribute instance-attribute ¶

update_unix_time class-attribute instance-attribute ¶

tokens instance-attribute ¶

parse_update_time ¶

GetTokenListResponse ¶

data instance-attribute ¶

success instance-attribute ¶

V3TokenListExtensions ¶

coingecko_id class-attribute instance-attribute ¶

serum_v3_usdc class-attribute instance-attribute ¶

serum_v3_usdt class-attribute instance-attribute ¶

website class-attribute instance-attribute ¶

telegram class-attribute instance-attribute ¶

twitter class-attribute instance-attribute ¶

description class-attribute instance-attribute ¶

discord class-attribute instance-attribute ¶

medium class-attribute instance-attribute ¶

github class-attribute instance-attribute ¶

model_config class-attribute instance-attribute ¶

V3TokenListItem ¶

address class-attribute instance-attribute ¶

logo_uri class-attribute instance-attribute ¶

name class-attribute instance-attribute ¶

symbol class-attribute instance-attribute ¶

decimals class-attribute instance-attribute ¶

extensions class-attribute instance-attribute ¶

market_cap class-attribute instance-attribute ¶

fdv class-attribute instance-attribute ¶

total_supply class-attribute instance-attribute ¶

circulating_supply class-attribute instance-attribute ¶

liquidity class-attribute instance-attribute ¶

last_trade_unix_time class-attribute instance-attribute ¶

volume_1m_usd class-attribute instance-attribute ¶

volume_1m_change_percent class-attribute instance-attribute ¶

volume_5m_usd class-attribute instance-attribute ¶

volume_5m_change_percent class-attribute instance-attribute ¶

volume_30m_usd class-attribute instance-attribute ¶

volume_30m_change_percent class-attribute instance-attribute ¶

volume_1h_usd class-attribute instance-attribute ¶

volume_1h_change_percent class-attribute instance-attribute ¶

volume_2h_usd class-attribute instance-attribute ¶

volume_2h_change_percent class-attribute instance-attribute ¶

volume_4h_usd class-attribute instance-attribute ¶

volume_4h_change_percent class-attribute instance-attribute ¶

volume_8h_usd class-attribute instance-attribute ¶

volume_8h_change_percent class-attribute instance-attribute ¶

volume_24h_usd class-attribute instance-attribute ¶

volume_24h_change_percent class-attribute instance-attribute ¶

volume_7d_usd class-attribute instance-attribute ¶

volume_7d_change_percent class-attribute instance-attribute ¶

volume_30d_usd class-attribute instance-attribute ¶

volume_30d_change_percent class-attribute instance-attribute ¶

trade_1m_count class-attribute instance-attribute ¶

trade_5m_count class-attribute instance-attribute ¶

trade_30m_count class-attribute instance-attribute ¶

trade_1h_count class-attribute instance-attribute ¶

trade_2h_count class-attribute instance-attribute ¶

trade_4h_count class-attribute instance-attribute ¶

trade_8h_count class-attribute instance-attribute ¶

trade_24h_count class-attribute instance-attribute ¶

trade_7d_count class-attribute instance-attribute ¶

trade_30d_count class-attribute instance-attribute ¶

buy_24h class-attribute instance-attribute ¶

all `module-attribute` ¶

name `class-attribute` `instance-attribute` ¶

symbol `class-attribute` `instance-attribute` ¶

price `instance-attribute` ¶

address `instance-attribute` ¶

decimals `instance-attribute` ¶

liquidity `instance-attribute` ¶

volume_24h_usd `class-attribute` `instance-attribute` ¶

market_cap `class-attribute` `instance-attribute` ¶

volume_24h_change `class-attribute` `instance-attribute` ¶

last_trade_unix_time `class-attribute` `instance-attribute` ¶

logo_uri `class-attribute` `instance-attribute` ¶

total `class-attribute` `instance-attribute` ¶

update_time `class-attribute` `instance-attribute` ¶

update_unix_time `class-attribute` `instance-attribute` ¶

tokens `instance-attribute` ¶

data `instance-attribute` ¶

success `instance-attribute` ¶

coingecko_id `class-attribute` `instance-attribute` ¶

serum_v3_usdc `class-attribute` `instance-attribute` ¶

serum_v3_usdt `class-attribute` `instance-attribute` ¶

website `class-attribute` `instance-attribute` ¶

telegram `class-attribute` `instance-attribute` ¶

twitter `class-attribute` `instance-attribute` ¶

description `class-attribute` `instance-attribute` ¶

discord `class-attribute` `instance-attribute` ¶

medium `class-attribute` `instance-attribute` ¶

github `class-attribute` `instance-attribute` ¶

model_config `class-attribute` `instance-attribute` ¶

address `class-attribute` `instance-attribute` ¶

logo_uri `class-attribute` `instance-attribute` ¶

name `class-attribute` `instance-attribute` ¶

symbol `class-attribute` `instance-attribute` ¶

decimals `class-attribute` `instance-attribute` ¶

extensions `class-attribute` `instance-attribute` ¶

market_cap `class-attribute` `instance-attribute` ¶

fdv `class-attribute` `instance-attribute` ¶

total_supply `class-attribute` `instance-attribute` ¶

circulating_supply `class-attribute` `instance-attribute` ¶

liquidity `class-attribute` `instance-attribute` ¶

last_trade_unix_time `class-attribute` `instance-attribute` ¶

volume_1m_usd `class-attribute` `instance-attribute` ¶

volume_1m_change_percent `class-attribute` `instance-attribute` ¶

volume_5m_usd `class-attribute` `instance-attribute` ¶

volume_5m_change_percent `class-attribute` `instance-attribute` ¶

volume_30m_usd `class-attribute` `instance-attribute` ¶

volume_30m_change_percent `class-attribute` `instance-attribute` ¶

volume_1h_usd `class-attribute` `instance-attribute` ¶

volume_1h_change_percent `class-attribute` `instance-attribute` ¶

volume_2h_usd `class-attribute` `instance-attribute` ¶

volume_2h_change_percent `class-attribute` `instance-attribute` ¶

volume_4h_usd `class-attribute` `instance-attribute` ¶

volume_4h_change_percent `class-attribute` `instance-attribute` ¶

volume_8h_usd `class-attribute` `instance-attribute` ¶

volume_8h_change_percent `class-attribute` `instance-attribute` ¶

volume_24h_usd `class-attribute` `instance-attribute` ¶

volume_24h_change_percent `class-attribute` `instance-attribute` ¶

volume_7d_usd `class-attribute` `instance-attribute` ¶

volume_7d_change_percent `class-attribute` `instance-attribute` ¶

volume_30d_usd `class-attribute` `instance-attribute` ¶

volume_30d_change_percent `class-attribute` `instance-attribute` ¶

trade_1m_count `class-attribute` `instance-attribute` ¶

trade_5m_count `class-attribute` `instance-attribute` ¶

trade_30m_count `class-attribute` `instance-attribute` ¶

trade_1h_count `class-attribute` `instance-attribute` ¶

trade_2h_count `class-attribute` `instance-attribute` ¶

trade_4h_count `class-attribute` `instance-attribute` ¶

trade_8h_count `class-attribute` `instance-attribute` ¶

trade_24h_count `class-attribute` `instance-attribute` ¶

trade_7d_count `class-attribute` `instance-attribute` ¶

trade_30d_count `class-attribute` `instance-attribute` ¶

buy_24h `class-attribute` `instance-attribute` ¶

buy_24h_change_percent `class-attribute` `instance-attribute` ¶

volume_buy_24h_usd `class-attribute` `instance-attribute` ¶

volume_buy_24h_change_percent `class-attribute` `instance-attribute` ¶

buy_7d `class-attribute` `instance-attribute` ¶

buy_7d_change_percent `class-attribute` `instance-attribute` ¶

volume_buy_7d_usd `class-attribute` `instance-attribute` ¶

volume_buy_7d_change_percent `class-attribute` `instance-attribute` ¶

buy_30d `class-attribute` `instance-attribute` ¶