Skip to content

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.

cyhole.gecko.schema

Gecko response schemas, grouped by API domain.

__all__ module-attribute 

__all__ = [
    "LinksResponse",
    "RelationshipData",
    "RelationshipList",
    "ResourceRef",
    "TimeBucketedStr",
    "TokenFullInfoAttributes",
    "TokenHoldersDistribution",
    "TokenHoldersInfo",
    "TokenImageSet",
    "TokenScoreDetails",
    "TransactionStats",
    "TransactionsTimeBuckets",
    "GetNetworksResponse",
    "NetworkAttributes",
    "NetworkData",
    "DexAttributes",
    "DexData",
    "GetDexesResponse",
    "GetPoolOhlcvQuery",
    "GetPoolOHLCVResponse",
    "GetTokenOhlcvQuery",
    "GetTokenOHLCVResponse",
    "OhlcvAttributes",
    "OhlcvData",
    "OhlcvMeta",
    "OhlcvMetaToken",
    "GetPoolTradesResponse",
    "GetTokenTradesResponse",
    "TokenTradeAttributes",
    "TokenTradeData",
    "TradeAttributes",
    "TradeData",
    "GetPoolTokenInfoResponse",
    "PoolTokenInfoData",
    "PoolTokenInfoRelationships",
    "GetRecentlyUpdatedTokensResponse",
    "GetTokenDataMultipleResponse",
    "GetTokenDataResponse",
    "LaunchpadDetails",
    "PoolIncluded",
    "PoolIncludedAttributes",
    "PoolIncludedRelationships",
    "RecentlyUpdatedTokenAttributes",
    "RecentlyUpdatedTokenData",
    "RecentlyUpdatedTokenRelationships",
    "TokenDataAttributes",
    "TokenDataMultipleAttributes",
    "TokenDataMultipleResource",
    "TokenDataRelationships",
    "TokenDataResource",
    "TokenDataVolumeUsd",
    "GetTokenInfoResponse",
    "TokenInfoData",
    "GetTokenHoldersChartResponse",
    "GetTopTokenHoldersResponse",
    "TokenHoldersChartAttributes",
    "TokenHoldersChartData",
    "TokenHoldersChartMeta",
    "TokenHoldersChartMetaToken",
    "TopTokenHolder",
    "TopTokenHoldersAttributes",
    "TopTokenHoldersData",
    "GetTopTokenTradersResponse",
    "TopTokenTrader",
    "TopTokenTradersAttributes",
    "TopTokenTradersData",
    "GetSimpleTokenPriceQuery",
    "GetSimpleTokenPriceResponse",
    "SimpleTokenPriceAttributes",
    "SimpleTokenPriceData",
    "GetSearchPoolsResponse",
    "SearchIncluded",
    "SearchIncludedAttributes",
    "SearchPoolAttributes",
    "SearchPoolData",
    "SearchPoolRelationships",
]

LinksResponse

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.LinksResponse[LinksResponse]

              

              click cyhole.gecko.schema.LinksResponse href "" "cyhole.gecko.schema.LinksResponse"

JSON:API pagination block returned by list endpoints (networks, dexes, search/pools).

Attributes:

Name Type Description
first str | None

URL of the first page of results.
prev str | None

URL of the previous page; None when on the first page.
next str | None

URL of the next page; None when on the last page.
last str | None

URL of the last page of results.

first class-attribute instance-attribute 

first: str | None = None

prev class-attribute instance-attribute 

prev: str | None = None

next class-attribute instance-attribute 

next: str | None = None

last class-attribute instance-attribute 

last: str | None = None

RelationshipData

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.RelationshipData[RelationshipData]

              

              click cyhole.gecko.schema.RelationshipData href "" "cyhole.gecko.schema.RelationshipData"

JSON:API single-relationship wrapper of shape { "data": { id, type } }.

Attributes:

Name Type Description
data ResourceRef

resource identifier of the related entity.

data instance-attribute 

data: ResourceRef

RelationshipList

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.RelationshipList[RelationshipList]

              

              click cyhole.gecko.schema.RelationshipList href "" "cyhole.gecko.schema.RelationshipList"

JSON:API to-many relationship wrapper of shape { "data": [ { id, type }, ... ] }.

Attributes:

Name Type Description
data list[ResourceRef]

list of resource identifiers of the related entities.

data instance-attribute 

data: list[ResourceRef]

ResourceRef

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.ResourceRef[ResourceRef]

              

              click cyhole.gecko.schema.ResourceRef href "" "cyhole.gecko.schema.ResourceRef"

JSON:API resource identifier used inside relationships blocks (e.g. { id: "...", type: "token" }).

Attributes:

Name Type Description
id str

identifier of the referenced resource.
type str

type tag of the referenced resource (e.g. "token", "pool", "dex", "network").

id instance-attribute 

id: str

type instance-attribute 

type: str

TimeBucketedStr

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.TimeBucketedStr[TimeBucketedStr]

              

              click cyhole.gecko.schema.TimeBucketedStr href "" "cyhole.gecko.schema.TimeBucketedStr"

String-valued metric bucketed by the standard GeckoTerminal time windows.

Used for price_change_percentage and volume_usd (USD strings) on pool/search resources, and for the volume_usd block on token resources where typically only h24 is populated.

Attributes:

Name Type Description
m5 str | None

value for the trailing 5 minutes; None when not reported.
m15 str | None

value for the trailing 15 minutes; None when not reported.
m30 str | None

value for the trailing 30 minutes; None when not reported.
h1 str | None

value for the trailing 1 hour; None when not reported.
h6 str | None

value for the trailing 6 hours; None when not reported.
h24 str | None

value for the trailing 24 hours; None when not reported.

m5 class-attribute instance-attribute 

m5: str | None = None

m15 class-attribute instance-attribute 

m15: str | None = None

m30 class-attribute instance-attribute 

m30: str | None = None

h1 class-attribute instance-attribute 

h1: str | None = None

h6 class-attribute instance-attribute 

h6: str | None = None

h24 class-attribute instance-attribute 

h24: str | None = None

TokenFullInfoAttributes

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.TokenFullInfoAttributes[TokenFullInfoAttributes]

              

              click cyhole.gecko.schema.TokenFullInfoAttributes href "" "cyhole.gecko.schema.TokenFullInfoAttributes"

Full token metadata block returned by the standalone Token Info endpoint and embedded in every entry of the Pool Tokens Info endpoint.

Attributes:

Name Type Description
address str

token contract address.
name str | None

human-readable token name.
symbol str | None

token ticker symbol.
decimals int | None

number of decimal places used by the token.
image_url str | None

legacy single image URL; superseded by image.
image TokenImageSet | None

image URLs at thumb/small/large sizes.
coingecko_coin_id str | None

CoinGecko coin id linked to this token; None when not mapped.
websites list[str] | None

list of official website URLs declared by the project.
discord_url str | None

project Discord invite URL; None when not provided.
farcaster_url str | None

project Farcaster URL; None when not provided.
zora_url str | None

project Zora URL; None when not provided.
telegram_handle str | None

project Telegram handle; None when not provided.
twitter_handle str | None

project Twitter/X handle; None when not provided.
description str | None

free-text project description.
gt_score float | None

aggregate GeckoTerminal trust score (0–100).
gt_score_details TokenScoreDetails | None

per-dimension breakdown of the trust score.
gt_verified bool | None

whether GeckoTerminal has marked the token as verified.
categories list[str] | None

human-readable category labels.
gt_category_ids list[str] | None

GeckoTerminal category ids.
holders TokenHoldersInfo | None

aggregate holders snapshot.
mint_authority str | None

address with mint authority on the underlying network; None if not applicable.
freeze_authority str | None

address with freeze authority; None if not applicable.
is_honeypot bool | str | None

honeypot flag; the API occasionally returns this as a string instead of a bool.

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

image_url class-attribute instance-attribute 

image_url: str | None = None

image class-attribute instance-attribute 

image: TokenImageSet | None = None

coingecko_coin_id class-attribute instance-attribute 

coingecko_coin_id: str | None = None

websites class-attribute instance-attribute 

websites: list[str] | None = None

discord_url class-attribute instance-attribute 

discord_url: str | None = None

farcaster_url class-attribute instance-attribute 

farcaster_url: str | None = None

zora_url class-attribute instance-attribute 

zora_url: str | None = None

telegram_handle class-attribute instance-attribute 

telegram_handle: str | None = None

twitter_handle class-attribute instance-attribute 

twitter_handle: str | None = None

description class-attribute instance-attribute 

description: str | None = None

gt_score class-attribute instance-attribute 

gt_score: float | None = None

gt_score_details class-attribute instance-attribute 

gt_score_details: TokenScoreDetails | None = None

gt_verified class-attribute instance-attribute 

gt_verified: bool | None = None

categories class-attribute instance-attribute 

categories: list[str] | None = None

gt_category_ids class-attribute instance-attribute 

gt_category_ids: list[str] | None = None

holders class-attribute instance-attribute 

holders: TokenHoldersInfo | None = None

mint_authority class-attribute instance-attribute 

mint_authority: str | None = None

freeze_authority class-attribute instance-attribute 

freeze_authority: str | None = None

is_honeypot class-attribute instance-attribute 

is_honeypot: bool | str | None = None

TokenHoldersDistribution

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.TokenHoldersDistribution[TokenHoldersDistribution]

              

              click cyhole.gecko.schema.TokenHoldersDistribution href "" "cyhole.gecko.schema.TokenHoldersDistribution"

Percentage split of token supply across holder buckets, as percentage strings (e.g. "15.4").

Attributes:

Name Type Description
top_10 str | None

percentage owned by the top 10 holders.
holders_11_30 str | None

percentage owned by holders ranked 11 through 30 (JSON key "11_30").
holders_31_50 str | None

percentage owned by holders ranked 31 through 50 (JSON key "31_50").
rest str | None

percentage owned by every other holder.

top_10 class-attribute instance-attribute 

top_10: str | None = None

holders_11_30 class-attribute instance-attribute 

holders_11_30: str | None = Field(
    default=None, alias="11_30"
)

holders_31_50 class-attribute instance-attribute 

holders_31_50: str | None = Field(
    default=None, alias="31_50"
)

rest class-attribute instance-attribute 

rest: str | None = None

TokenHoldersInfo

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.TokenHoldersInfo[TokenHoldersInfo]

              

              click cyhole.gecko.schema.TokenHoldersInfo href "" "cyhole.gecko.schema.TokenHoldersInfo"

Aggregate token-holder snapshot embedded in token-info-style responses.

Attributes:

Name Type Description
count int | None

total number of holders.
distribution_percentage TokenHoldersDistribution | None

split of supply across holder rank buckets.
last_updated str | None

ISO-8601 timestamp of the last snapshot.

count class-attribute instance-attribute 

count: int | None = None

distribution_percentage class-attribute instance-attribute 

distribution_percentage: TokenHoldersDistribution | None = (
    None
)

last_updated class-attribute instance-attribute 

last_updated: str | None = None

TokenImageSet

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.TokenImageSet[TokenImageSet]

              

              click cyhole.gecko.schema.TokenImageSet href "" "cyhole.gecko.schema.TokenImageSet"

Token image URLs at multiple sizes, as returned by token-info-style endpoints.

Attributes:

Name Type Description
thumb str | None

URL of the thumbnail image.
small str | None

URL of the small image.
large str | None

URL of the large image.

thumb class-attribute instance-attribute 

thumb: str | None = None

small class-attribute instance-attribute 

small: str | None = None

large class-attribute instance-attribute 

large: str | None = None

TokenScoreDetails

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.TokenScoreDetails[TokenScoreDetails]

              

              click cyhole.gecko.schema.TokenScoreDetails href "" "cyhole.gecko.schema.TokenScoreDetails"

Breakdown of the GeckoTerminal trust score (gt_score) by contributing dimension.

Attributes:

Name Type Description
pool float

subscore from pool quality (liquidity, age, etc.).
transaction float

subscore from on-chain transaction activity.
creation float

subscore from contract-creation signals.
info float

subscore from metadata completeness.
holders float

subscore from holder distribution.

pool instance-attribute 

pool: float

transaction instance-attribute 

transaction: float

creation instance-attribute 

creation: float

info instance-attribute 

info: float

holders instance-attribute 

holders: float

TransactionStats

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.TransactionStats[TransactionStats]

              

              click cyhole.gecko.schema.TransactionStats href "" "cyhole.gecko.schema.TransactionStats"

Per-window transaction count breakdown used in pool/search responses.

Attributes:

Name Type Description
buys int

number of buy trades observed in the window.
sells int

number of sell trades observed in the window.
buyers int

number of distinct buyer addresses observed in the window.
sellers int

number of distinct seller addresses observed in the window.

buys instance-attribute 

buys: int

sells instance-attribute 

sells: int

buyers instance-attribute 

buyers: int

sellers instance-attribute 

sellers: int

TransactionsTimeBuckets

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.TransactionsTimeBuckets[TransactionsTimeBuckets]

              

              click cyhole.gecko.schema.TransactionsTimeBuckets href "" "cyhole.gecko.schema.TransactionsTimeBuckets"

Transaction stats bucketed by the standard GeckoTerminal time windows.

Each bucket carries the TransactionStats aggregates for the corresponding rolling window. All buckets are populated for pool resources.

Attributes:

Name Type Description
m5 TransactionStats

stats for the trailing 5 minutes.
m15 TransactionStats

stats for the trailing 15 minutes.
m30 TransactionStats

stats for the trailing 30 minutes.
h1 TransactionStats

stats for the trailing 1 hour.
h6 TransactionStats

stats for the trailing 6 hours.
h24 TransactionStats

stats for the trailing 24 hours.

m5 instance-attribute 

m5: TransactionStats

m15 instance-attribute 

m15: TransactionStats

m30 instance-attribute 

m30: TransactionStats

h1 instance-attribute 

h1: TransactionStats

h6 instance-attribute 

h6: TransactionStats

h24 instance-attribute 

h24: TransactionStats

GetNetworksResponse

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.GetNetworksResponse[GetNetworksResponse]

              

              click cyhole.gecko.schema.GetNetworksResponse href "" "cyhole.gecko.schema.GetNetworksResponse"

Response payload from the Networks endpoint, returning the paginated list of every network supported by GeckoTerminal.

Attributes:

Name Type Description
data list[NetworkData]

list of supported networks for the current page.
links LinksResponse | None

JSON:API pagination links.

data instance-attribute 

data: list[NetworkData]

links: LinksResponse | None = None

NetworkAttributes

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.NetworkAttributes[NetworkAttributes]

              

              click cyhole.gecko.schema.NetworkAttributes href "" "cyhole.gecko.schema.NetworkAttributes"

Attributes block of a single network resource.

Attributes:

Name Type Description
name str

human-readable network name (e.g. "Ethereum").
coingecko_asset_platform_id str | None

CoinGecko asset platform id mapped to this network; None when not mapped.

name instance-attribute 

name: str

coingecko_asset_platform_id class-attribute instance-attribute 

coingecko_asset_platform_id: str | None = None

NetworkData

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.NetworkData[NetworkData]

              

              click cyhole.gecko.schema.NetworkData href "" "cyhole.gecko.schema.NetworkData"

Single network resource as returned in the data list of the Networks endpoint.

Attributes:

Name Type Description
id str

GeckoTerminal network identifier (e.g. "eth", "solana", "bsc"); used as path parameter in most endpoints.
type str

JSON:API resource type, always "network".
attributes NetworkAttributes

per-network metadata block.

id instance-attribute 

id: str

type instance-attribute 

type: str

attributes instance-attribute 

attributes: NetworkAttributes

DexAttributes

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.DexAttributes[DexAttributes]

              

              click cyhole.gecko.schema.DexAttributes href "" "cyhole.gecko.schema.DexAttributes"

Attributes block of a single DEX resource.

Attributes:

Name Type Description
name str

human-readable DEX name (e.g. "Uniswap V3").

name instance-attribute 

name: str

DexData

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.DexData[DexData]

              

              click cyhole.gecko.schema.DexData href "" "cyhole.gecko.schema.DexData"

Single DEX resource returned by the Dexes-by-network endpoint.

Attributes:

Name Type Description
id str

GeckoTerminal DEX identifier (e.g. "uniswap_v3").
type str

JSON:API resource type, always "dex".
attributes DexAttributes

per-DEX metadata block.

id instance-attribute 

id: str

type instance-attribute 

type: str

attributes instance-attribute 

attributes: DexAttributes

GetDexesResponse

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.GetDexesResponse[GetDexesResponse]

              

              click cyhole.gecko.schema.GetDexesResponse href "" "cyhole.gecko.schema.GetDexesResponse"

Response payload from the Dexes by Network endpoint, returning the paginated list of every decentralized exchange indexed by GeckoTerminal on the requested network.

Attributes:

Name Type Description
data list[DexData]

list of supported DEXes for the current page.
links LinksResponse | None

JSON:API pagination links.

data instance-attribute 

data: list[DexData]

links: LinksResponse | None = None

GetPoolOhlcvQuery

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.GetPoolOhlcvQuery[GetPoolOhlcvQuery]

              

              click cyhole.gecko.schema.GetPoolOhlcvQuery href "" "cyhole.gecko.schema.GetPoolOhlcvQuery"

Query-string bundle for the Pool OHLCV endpoint, exposed as a single model because the endpoint accepts more than three meaningful inputs. Pass it through and any field left at None will be omitted from the request.

Attributes:

Name Type Description
aggregate str | None

candle aggregation step within the chosen timeframe. Allowed values depend on the timeframe — day: "1"; hour: "1", "4", "12"; minute: "1", "5", "15"; second: "1", "15", "30". Defaults to "1" server-side.
before_timestamp int | None

unix timestamp (seconds) used as an upper bound on the returned candles; useful to walk backwards through history.
limit int | None

maximum number of candles to return. Server default is 100; valid range is 1–1000.
currency str | None

candle denomination, either "usd" (default) or "token"; see GeckoCurrency.
token str | None

which side of the pool to quote prices on. "base", "quote" (see GeckoTokenSide) or a token contract address.
include_empty_intervals bool | None

when True, the server returns zero-volume candles in periods with no trades; when False (default) these intervals are omitted.

aggregate class-attribute instance-attribute 

aggregate: str | None = None

before_timestamp class-attribute instance-attribute 

before_timestamp: int | None = None

limit class-attribute instance-attribute 

limit: int | None = None

currency class-attribute instance-attribute 

currency: str | None = None

token class-attribute instance-attribute 

token: str | None = None

include_empty_intervals class-attribute instance-attribute 

include_empty_intervals: bool | None = None

GetPoolOHLCVResponse

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.GetPoolOHLCVResponse[GetPoolOHLCVResponse]

              

              click cyhole.gecko.schema.GetPoolOHLCVResponse href "" "cyhole.gecko.schema.GetPoolOHLCVResponse"

Response payload from the Pool OHLCV endpoint, returning historical candlestick data for the requested pool at the chosen timeframe. The candles are returned newest-first up to the configured limit and can be denominated in USD or quoted in the pool's token.

Attributes:

Name Type Description
data OhlcvData

candle series payload.
meta OhlcvMeta

base/quote reference info for the underlying pool.

data instance-attribute 

data: OhlcvData

meta instance-attribute 

meta: OhlcvMeta

GetTokenOhlcvQuery

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.GetTokenOhlcvQuery[GetTokenOhlcvQuery]

              

              click cyhole.gecko.schema.GetTokenOhlcvQuery href "" "cyhole.gecko.schema.GetTokenOhlcvQuery"

Query-string bundle for the Token OHLCV endpoint.

Attributes:

Name Type Description
aggregate str | None

candle aggregation step — same allowed values as GetPoolOhlcvQuery.aggregate.
before_timestamp int | None

unix timestamp (seconds) used as an upper bound on the returned candles.
limit int | None

maximum number of candles to return. Server default is 100; valid range is 1–1000.
currency str | None

candle denomination, either "usd" (default) or "token".
include_empty_intervals bool | None

when True, the server returns zero-volume candles in periods with no trades; defaults to False server-side.
include_inactive_source bool | None

when True, include data from sources GeckoTerminal has flagged as inactive; defaults to False.

aggregate class-attribute instance-attribute 

aggregate: str | None = None

before_timestamp class-attribute instance-attribute 

before_timestamp: int | None = None

limit class-attribute instance-attribute 

limit: int | None = None

currency class-attribute instance-attribute 

currency: str | None = None

include_empty_intervals class-attribute instance-attribute 

include_empty_intervals: bool | None = None

include_inactive_source class-attribute instance-attribute 

include_inactive_source: bool | None = None

GetTokenOHLCVResponse

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.GetTokenOHLCVResponse[GetTokenOHLCVResponse]

              

              click cyhole.gecko.schema.GetTokenOHLCVResponse href "" "cyhole.gecko.schema.GetTokenOHLCVResponse"

Response payload from the Token OHLCV endpoint, returning aggregated candlestick data for the requested token across the most-relevant pool on the network. The shape mirrors the Pool OHLCV response.

Attributes:

Name Type Description
data OhlcvData

candle series payload.
meta OhlcvMeta

base/quote reference info for the underlying pool selected by GeckoTerminal.

data instance-attribute 

data: OhlcvData

meta instance-attribute 

meta: OhlcvMeta

OhlcvAttributes

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.OhlcvAttributes[OhlcvAttributes]

              

              click cyhole.gecko.schema.OhlcvAttributes href "" "cyhole.gecko.schema.OhlcvAttributes"

Attributes block of an OHLCV resource.

Attributes:

Name Type Description
ohlcv_list list[list[float]]

ordered list of candles; each candle is a 6-element list [timestamp_unix_seconds, open, high, low, close, volume] with the timestamp as an integer and the four price components plus volume as floats.

ohlcv_list instance-attribute 

ohlcv_list: list[list[float]]

OhlcvData

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.OhlcvData[OhlcvData]

              

              click cyhole.gecko.schema.OhlcvData href "" "cyhole.gecko.schema.OhlcvData"

Top-level data block of an OHLCV response.

Attributes:

Name Type Description
id str

identifier of the OHLCV series.
type str

JSON:API resource type.
attributes OhlcvAttributes

candle list payload.

id instance-attribute 

id: str

type instance-attribute 

type: str

attributes instance-attribute 

attributes: OhlcvAttributes

OhlcvMeta

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.OhlcvMeta[OhlcvMeta]

              

              click cyhole.gecko.schema.OhlcvMeta href "" "cyhole.gecko.schema.OhlcvMeta"

meta block of an OHLCV response identifying the base and quote tokens.

Attributes:

Name Type Description
base OhlcvMetaToken

metadata of the base token of the underlying pool.
quote OhlcvMetaToken

metadata of the quote token of the underlying pool.

base instance-attribute 

base: OhlcvMetaToken

quote instance-attribute 

quote: OhlcvMetaToken

OhlcvMetaToken

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.OhlcvMetaToken[OhlcvMetaToken]

              

              click cyhole.gecko.schema.OhlcvMetaToken href "" "cyhole.gecko.schema.OhlcvMetaToken"

Reference info for one side (base or quote) of an OHLCV series.

Attributes:

Name Type Description
address str

token contract address.
name str

human-readable token name.
symbol str

token ticker symbol.
coingecko_coin_id str | None

CoinGecko coin id mapped to this token; None when not mapped.

address instance-attribute 

address: str

name instance-attribute 

name: str

symbol instance-attribute 

symbol: str

coingecko_coin_id class-attribute instance-attribute 

coingecko_coin_id: str | None = None

GetPoolTradesResponse

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.GetPoolTradesResponse[GetPoolTradesResponse]

              

              click cyhole.gecko.schema.GetPoolTradesResponse href "" "cyhole.gecko.schema.GetPoolTradesResponse"

Response payload from the Pool Trades endpoint, returning the trade history of the requested pool over the trailing 24 hours, optionally filtered by minimum USD volume.

Attributes:

Name Type Description
data list[TradeData]

list of trades, ordered newest-first.

data instance-attribute 

data: list[TradeData]

GetTokenTradesResponse

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.GetTokenTradesResponse[GetTokenTradesResponse]

              

              click cyhole.gecko.schema.GetTokenTradesResponse href "" "cyhole.gecko.schema.GetTokenTradesResponse"

Response payload from the Token Trades endpoint, returning the trade history involving the requested token across every indexed pool over the trailing 24 hours.

Attributes:

Name Type Description
data list[TokenTradeData]

list of trades, ordered newest-first; each entry also reports the pool that executed it.

data instance-attribute 

data: list[TokenTradeData]

TokenTradeAttributes

Bases: TradeAttributes


              flowchart TD
              cyhole.gecko.schema.TokenTradeAttributes[TokenTradeAttributes]
              cyhole.gecko.schema.trades.TradeAttributes[TradeAttributes]

                              cyhole.gecko.schema.trades.TradeAttributes --> cyhole.gecko.schema.TokenTradeAttributes
                


              click cyhole.gecko.schema.TokenTradeAttributes href "" "cyhole.gecko.schema.TokenTradeAttributes"
              click cyhole.gecko.schema.trades.TradeAttributes href "" "cyhole.gecko.schema.trades.TradeAttributes"

Attributes block of a single trade resource as returned by the Token Trades endpoint.

Extends TradeAttributes with the pool the trade was routed through.

Attributes:

Name Type Description
pool_address str | None

contract address of the pool that executed the trade.
pool_dex str | None

identifier of the DEX the pool belongs to.

pool_address class-attribute instance-attribute 

pool_address: str | None = None

pool_dex class-attribute instance-attribute 

pool_dex: str | None = None

TokenTradeData

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.TokenTradeData[TokenTradeData]

              

              click cyhole.gecko.schema.TokenTradeData href "" "cyhole.gecko.schema.TokenTradeData"

Single trade resource from the Token Trades endpoint.

Attributes:

Name Type Description
id str

identifier of the trade.
type str

JSON:API resource type.
attributes TokenTradeAttributes

trade payload extended with pool_address and pool_dex.

id instance-attribute 

id: str

type instance-attribute 

type: str

attributes instance-attribute 

attributes: TokenTradeAttributes

TradeAttributes

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.TradeAttributes[TradeAttributes]

              

              click cyhole.gecko.schema.TradeAttributes href "" "cyhole.gecko.schema.TradeAttributes"

Attributes block of a single trade resource as returned by the Pool Trades endpoint.

Attributes:

Name Type Description
block_number int

on-chain block number containing the trade.
tx_hash str

transaction hash on the underlying network.
tx_from_address str

signer/sender address of the transaction.
from_token_amount str

input-token amount of the trade (decimal string).
to_token_amount str

output-token amount of the trade (decimal string).
price_from_in_currency_token str

price of from_token quoted in the chosen currency token.
price_to_in_currency_token str

price of to_token quoted in the chosen currency token.
price_from_in_usd str

price of from_token in USD at the time of the trade.
price_to_in_usd str

price of to_token in USD at the time of the trade.
block_timestamp str

ISO-8601 timestamp of the block.
kind str

trade direction relative to the pool's base token ("buy" or "sell").
volume_in_usd str

USD value of the trade.
from_token_address str

contract address of from_token.
to_token_address str

contract address of to_token.

block_number instance-attribute 

block_number: int

tx_hash instance-attribute 

tx_hash: str

tx_from_address instance-attribute 

tx_from_address: str

from_token_amount instance-attribute 

from_token_amount: str

to_token_amount instance-attribute 

to_token_amount: str

price_from_in_currency_token instance-attribute 

price_from_in_currency_token: str

price_to_in_currency_token instance-attribute 

price_to_in_currency_token: str

price_from_in_usd instance-attribute 

price_from_in_usd: str

price_to_in_usd instance-attribute 

price_to_in_usd: str

block_timestamp instance-attribute 

block_timestamp: str

kind instance-attribute 

kind: str

volume_in_usd instance-attribute 

volume_in_usd: str

from_token_address instance-attribute 

from_token_address: str

to_token_address instance-attribute 

to_token_address: str

TradeData

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.TradeData[TradeData]

              

              click cyhole.gecko.schema.TradeData href "" "cyhole.gecko.schema.TradeData"

Single trade resource from the Pool Trades endpoint.

Attributes:

Name Type Description
id str

identifier of the trade.
type str

JSON:API resource type.
attributes TradeAttributes

trade payload.

id instance-attribute 

id: str

type instance-attribute 

type: str

attributes instance-attribute 

attributes: TradeAttributes

GetPoolTokenInfoResponse

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.GetPoolTokenInfoResponse[GetPoolTokenInfoResponse]

              

              click cyhole.gecko.schema.GetPoolTokenInfoResponse href "" "cyhole.gecko.schema.GetPoolTokenInfoResponse"

Response payload from the Pool Tokens Info endpoint, returning the full metadata of every token that participates in the requested pool (base + quote). Useful to enrich a pool view with social links, trust scores, and holder distribution without making a separate request per token.

Attributes:

Name Type Description
data list[PoolTokenInfoData]

list of token entries (typically two — base and quote — for standard pools).

data instance-attribute 

data: list[PoolTokenInfoData]

PoolTokenInfoData

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.PoolTokenInfoData[PoolTokenInfoData]

              

              click cyhole.gecko.schema.PoolTokenInfoData href "" "cyhole.gecko.schema.PoolTokenInfoData"

Single token entry inside the Pool Tokens Info response (one per side of the pool).

Attributes:

Name Type Description
id str

GeckoTerminal token identifier (e.g. "eth_0x....").
type str

JSON:API resource type, always "token".
attributes TokenFullInfoAttributes

full token metadata payload.
relationships PoolTokenInfoRelationships | None

link back to the parent pool.

id instance-attribute 

id: str

type instance-attribute 

type: str

attributes instance-attribute 

attributes: TokenFullInfoAttributes

relationships class-attribute instance-attribute 

relationships: PoolTokenInfoRelationships | None = None

PoolTokenInfoRelationships

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.PoolTokenInfoRelationships[PoolTokenInfoRelationships]

              

              click cyhole.gecko.schema.PoolTokenInfoRelationships href "" "cyhole.gecko.schema.PoolTokenInfoRelationships"

Relationships block of a Pool Tokens Info entry.

Attributes:

Name Type Description
pool RelationshipData

pointer to the parent pool resource.

pool instance-attribute 

pool: RelationshipData

GetRecentlyUpdatedTokensResponse

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.GetRecentlyUpdatedTokensResponse[GetRecentlyUpdatedTokensResponse]

              

              click cyhole.gecko.schema.GetRecentlyUpdatedTokensResponse href "" "cyhole.gecko.schema.GetRecentlyUpdatedTokensResponse"

Response payload from the Recently Updated Tokens endpoint, returning tokens whose metadata (description, links, score, etc.) was updated most recently on the requested network. Useful for surfacing newly enriched projects.

Attributes:

Name Type Description
data list[RecentlyUpdatedTokenData]

list of recently updated tokens.

data instance-attribute 

data: list[RecentlyUpdatedTokenData]

GetTokenDataMultipleResponse

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.GetTokenDataMultipleResponse[GetTokenDataMultipleResponse]

              

              click cyhole.gecko.schema.GetTokenDataMultipleResponse href "" "cyhole.gecko.schema.GetTokenDataMultipleResponse"

Response payload from the multiple Token Data endpoint, returning the same metrics as the single endpoint for up to ~50 tokens at once, plus the optional launchpad_details block. Use this when you need to fetch many tokens efficiently.

Attributes:

Name Type Description
data list[TokenDataMultipleResource]

list of token data resources.
included list[PoolIncluded] | None

optional list of pool resources when include=top_pools was requested; None otherwise.

data instance-attribute 

data: list[TokenDataMultipleResource]

included class-attribute instance-attribute 

included: list[PoolIncluded] | None = None

GetTokenDataResponse

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.GetTokenDataResponse[GetTokenDataResponse]

              

              click cyhole.gecko.schema.GetTokenDataResponse href "" "cyhole.gecko.schema.GetTokenDataResponse"

Response payload from the single Token Data endpoint, returning current price, supply, liquidity, and volume metrics for one token on a given network. When include=top_pools is set, the most relevant pools are listed in relationships.top_pools and their full details are expanded inside included.

Attributes:

Name Type Description
data TokenDataResource

token data resource.
included list[PoolIncluded] | None

optional list of pool resources when include=top_pools was requested; None otherwise.

data instance-attribute 

data: TokenDataResource

included class-attribute instance-attribute 

included: list[PoolIncluded] | None = None

LaunchpadDetails

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.LaunchpadDetails[LaunchpadDetails]

              

              click cyhole.gecko.schema.LaunchpadDetails href "" "cyhole.gecko.schema.LaunchpadDetails"

Launchpad progress metadata included on the multi-token endpoint when relevant.

Attributes:

Name Type Description
graduation_percentage float | None

percentage of the launchpad bonding curve completed (0–100).
completed bool | None

whether the launchpad sale has concluded.
completed_at str | None

ISO-8601 timestamp of completion; None while the sale is in progress.
migrated_destination_pool_address str | None

address of the AMM pool the token migrated to after the sale; None until migration occurs.

graduation_percentage class-attribute instance-attribute 

graduation_percentage: float | None = None

completed class-attribute instance-attribute 

completed: bool | None = None

completed_at class-attribute instance-attribute 

completed_at: str | None = None

migrated_destination_pool_address class-attribute instance-attribute 

migrated_destination_pool_address: str | None = None

PoolIncluded

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.PoolIncluded[PoolIncluded]

              

              click cyhole.gecko.schema.PoolIncluded href "" "cyhole.gecko.schema.PoolIncluded"

Pool resource as it appears inside the JSON:API included array.

Attributes:

Name Type Description
id str

GeckoTerminal pool identifier.
type str

JSON:API resource type, always "pool".
attributes PoolIncludedAttributes

pool-stats payload.
relationships PoolIncludedRelationships | None

pointers to base/quote token and DEX.

id instance-attribute 

id: str

type instance-attribute 

type: str

attributes instance-attribute 

attributes: PoolIncludedAttributes

relationships class-attribute instance-attribute 

relationships: PoolIncludedRelationships | None = None

PoolIncludedAttributes

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.PoolIncludedAttributes[PoolIncludedAttributes]

              

              click cyhole.gecko.schema.PoolIncludedAttributes href "" "cyhole.gecko.schema.PoolIncludedAttributes"

Attributes block of a pool resource that appears in the JSON:API included array when callers request include=top_pools on the token-data endpoints.

Attributes:

Name Type Description
base_token_price_usd str | None

USD price of the pool's base token.
base_token_price_native_currency str | None

base-token price expressed in the network native currency.
base_token_balance str | None

pool reserve of the base token (decimal string).
base_token_liquidity_usd str | None

USD value of the base-token reserve.
quote_token_price_usd str | None

USD price of the pool's quote token.
quote_token_price_native_currency str | None

quote-token price expressed in the network native currency.
quote_token_balance str | None

pool reserve of the quote token.
quote_token_liquidity_usd str | None

USD value of the quote-token reserve.
base_token_price_quote_token str | None

base/quote price ratio.
quote_token_price_base_token str | None

quote/base price ratio.
address str | None

pool contract address.
name str | None

human-readable pool name.
pool_created_at str | None

ISO-8601 creation timestamp.
token_price_usd str | None

pool-level token USD price (single-endpoint only; None on multi responses).
fdv_usd str | None

pool-implied FDV in USD; None when not computable.
market_cap_usd str | None

pool-implied market cap; None when supply data is unavailable.
price_change_percentage TimeBucketedStr | None

% change of base price per time window.
transactions TransactionsTimeBuckets | None

transaction-count breakdown per time window.
volume_usd TimeBucketedStr | None

USD volume per time window.
reserve_in_usd str | None

aggregate USD reserve.

base_token_price_usd class-attribute instance-attribute 

base_token_price_usd: str | None = None

base_token_price_native_currency class-attribute instance-attribute 

base_token_price_native_currency: str | None = None

base_token_balance class-attribute instance-attribute 

base_token_balance: str | None = None

base_token_liquidity_usd class-attribute instance-attribute 

base_token_liquidity_usd: str | None = None

quote_token_price_usd class-attribute instance-attribute 

quote_token_price_usd: str | None = None

quote_token_price_native_currency class-attribute instance-attribute 

quote_token_price_native_currency: str | None = None

quote_token_balance class-attribute instance-attribute 

quote_token_balance: str | None = None

quote_token_liquidity_usd class-attribute instance-attribute 

quote_token_liquidity_usd: str | None = None

base_token_price_quote_token class-attribute instance-attribute 

base_token_price_quote_token: str | None = None

quote_token_price_base_token class-attribute instance-attribute 

quote_token_price_base_token: str | None = None

address class-attribute instance-attribute 

address: str | None = None

name class-attribute instance-attribute 

name: str | None = None

pool_created_at class-attribute instance-attribute 

pool_created_at: str | None = None

token_price_usd class-attribute instance-attribute 

token_price_usd: str | None = None

fdv_usd class-attribute instance-attribute 

fdv_usd: str | None = None

market_cap_usd class-attribute instance-attribute 

market_cap_usd: str | None = None

price_change_percentage class-attribute instance-attribute 

price_change_percentage: TimeBucketedStr | None = None

transactions class-attribute instance-attribute 

transactions: TransactionsTimeBuckets | None = None

volume_usd class-attribute instance-attribute 

volume_usd: TimeBucketedStr | None = None

reserve_in_usd class-attribute instance-attribute 

reserve_in_usd: str | None = None

PoolIncludedRelationships

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.PoolIncludedRelationships[PoolIncludedRelationships]

              

              click cyhole.gecko.schema.PoolIncludedRelationships href "" "cyhole.gecko.schema.PoolIncludedRelationships"

Relationships block of a pool resource embedded in included.

Attributes:

Name Type Description
base_token RelationshipData | None

pointer to the base token of the pool.
quote_token RelationshipData | None

pointer to the quote token of the pool.
dex RelationshipData | None

pointer to the DEX hosting the pool.

base_token class-attribute instance-attribute 

base_token: RelationshipData | None = None

quote_token class-attribute instance-attribute 

quote_token: RelationshipData | None = None

dex class-attribute instance-attribute 

dex: RelationshipData | None = None

RecentlyUpdatedTokenAttributes

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.RecentlyUpdatedTokenAttributes[RecentlyUpdatedTokenAttributes]

              

              click cyhole.gecko.schema.RecentlyUpdatedTokenAttributes href "" "cyhole.gecko.schema.RecentlyUpdatedTokenAttributes"

Attributes block of a token returned by the Recently Updated Tokens endpoint.

Attributes:

Name Type Description
address str

token contract address.
name str | None

human-readable token name.
symbol str | None

token ticker symbol.
decimals int | None

number of decimal places used by the token.
image_url str | None

token image URL.
coingecko_coin_id str | None

CoinGecko coin id mapped to this token; None when not mapped.
websites list[str] | None

list of official website URLs.
discord_url str | None

project Discord invite; None when not provided.
farcaster_url str | None

project Farcaster URL; None when not provided.
zora_url str | None

project Zora URL; None when not provided.
telegram_handle str | None

project Telegram handle; None when not provided.
twitter_handle str | None

project Twitter/X handle; None when not provided.
description str | None

free-text project description.
gt_score float | None

aggregate GeckoTerminal trust score.
metadata_updated_at str | None

ISO-8601 timestamp of the latest metadata update.

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

image_url class-attribute instance-attribute 

image_url: str | None = None

coingecko_coin_id class-attribute instance-attribute 

coingecko_coin_id: str | None = None

websites class-attribute instance-attribute 

websites: list[str] | None = None

discord_url class-attribute instance-attribute 

discord_url: str | None = None

farcaster_url class-attribute instance-attribute 

farcaster_url: str | None = None

zora_url class-attribute instance-attribute 

zora_url: str | None = None

telegram_handle class-attribute instance-attribute 

telegram_handle: str | None = None

twitter_handle class-attribute instance-attribute 

twitter_handle: str | None = None

description class-attribute instance-attribute 

description: str | None = None

gt_score class-attribute instance-attribute 

gt_score: float | None = None

metadata_updated_at class-attribute instance-attribute 

metadata_updated_at: str | None = None

RecentlyUpdatedTokenData

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.RecentlyUpdatedTokenData[RecentlyUpdatedTokenData]

              

              click cyhole.gecko.schema.RecentlyUpdatedTokenData href "" "cyhole.gecko.schema.RecentlyUpdatedTokenData"

Single token entry returned by the Recently Updated Tokens endpoint.

Attributes:

Name Type Description
id str

GeckoTerminal token identifier.
type str

JSON:API resource type, always "token".
attributes RecentlyUpdatedTokenAttributes

token metadata payload.
relationships RecentlyUpdatedTokenRelationships | None

pointer to the network resource.

id instance-attribute 

id: str

type instance-attribute 

type: str

attributes instance-attribute 

attributes: RecentlyUpdatedTokenAttributes

relationships class-attribute instance-attribute 

relationships: RecentlyUpdatedTokenRelationships | None = (
    None
)

RecentlyUpdatedTokenRelationships

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.RecentlyUpdatedTokenRelationships[RecentlyUpdatedTokenRelationships]

              

              click cyhole.gecko.schema.RecentlyUpdatedTokenRelationships href "" "cyhole.gecko.schema.RecentlyUpdatedTokenRelationships"

Relationships block of a recently-updated-tokens entry.

Attributes:

Name Type Description
network RelationshipData | None

pointer to the network the token belongs to.

network class-attribute instance-attribute 

network: RelationshipData | None = None

TokenDataAttributes

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.TokenDataAttributes[TokenDataAttributes]

              

              click cyhole.gecko.schema.TokenDataAttributes href "" "cyhole.gecko.schema.TokenDataAttributes"

Attributes block returned by the single Token Data endpoint.

Attributes:

Name Type Description
address str

token contract address.
name str | None

human-readable token name.
symbol str | None

token ticker symbol.
decimals int | None

number of decimal places used by the token.
image_url str | None

token image URL.
coingecko_coin_id str | None

CoinGecko coin id mapped to this token; None when not mapped.
total_supply str | None

total supply in raw integer units (decimal string).
normalized_total_supply str | None

total supply rescaled by decimals (decimal string).
price_usd str | None

latest USD price (decimal string).
fdv_usd str | None

fully-diluted valuation in USD; None when not computable.
total_reserve_in_usd str | None

aggregate USD reserve across all indexed pools.
volume_usd TokenDataVolumeUsd | None

USD volume by time window (typically only h24).
market_cap_usd str | None

USD market cap; None when supply data is unavailable.
last_trade_timestamp int | None

unix timestamp (seconds) of the most recent trade.

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

image_url class-attribute instance-attribute 

image_url: str | None = None

coingecko_coin_id class-attribute instance-attribute 

coingecko_coin_id: str | None = None

total_supply class-attribute instance-attribute 

total_supply: str | None = None

normalized_total_supply class-attribute instance-attribute 

normalized_total_supply: str | None = None

price_usd class-attribute instance-attribute 

price_usd: str | None = None

fdv_usd class-attribute instance-attribute 

fdv_usd: str | None = None

total_reserve_in_usd class-attribute instance-attribute 

total_reserve_in_usd: str | None = None

volume_usd class-attribute instance-attribute 

volume_usd: TokenDataVolumeUsd | None = None

market_cap_usd class-attribute instance-attribute 

market_cap_usd: str | None = None

last_trade_timestamp class-attribute instance-attribute 

last_trade_timestamp: int | None = None

TokenDataMultipleAttributes

Bases: TokenDataAttributes


              flowchart TD
              cyhole.gecko.schema.TokenDataMultipleAttributes[TokenDataMultipleAttributes]
              cyhole.gecko.schema.tokens.TokenDataAttributes[TokenDataAttributes]

                              cyhole.gecko.schema.tokens.TokenDataAttributes --> cyhole.gecko.schema.TokenDataMultipleAttributes
                


              click cyhole.gecko.schema.TokenDataMultipleAttributes href "" "cyhole.gecko.schema.TokenDataMultipleAttributes"
              click cyhole.gecko.schema.tokens.TokenDataAttributes href "" "cyhole.gecko.schema.tokens.TokenDataAttributes"

Attributes block returned by the multiple Token Data endpoint.

Extends TokenDataAttributes with launchpad metadata only the multi endpoint provides.

Attributes:

Name Type Description
launchpad_details LaunchpadDetails | None

launchpad progress info; None for tokens that were not launched via a tracked launchpad.

launchpad_details class-attribute instance-attribute 

launchpad_details: LaunchpadDetails | None = None

TokenDataMultipleResource

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.TokenDataMultipleResource[TokenDataMultipleResource]

              

              click cyhole.gecko.schema.TokenDataMultipleResource href "" "cyhole.gecko.schema.TokenDataMultipleResource"

Single token resource for the Token Data (multiple) endpoint, with launchpad_details available.

id instance-attribute 

id: str

type instance-attribute 

type: str

attributes instance-attribute 

attributes: TokenDataMultipleAttributes

relationships class-attribute instance-attribute 

relationships: TokenDataRelationships | None = None

TokenDataRelationships

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.TokenDataRelationships[TokenDataRelationships]

              

              click cyhole.gecko.schema.TokenDataRelationships href "" "cyhole.gecko.schema.TokenDataRelationships"

Relationships block of a token-data resource.

Attributes:

Name Type Description
top_pools RelationshipList | None

pointers to the related top pools; populated only when include=top_pools is set.

top_pools class-attribute instance-attribute 

top_pools: RelationshipList | None = None

TokenDataResource

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.TokenDataResource[TokenDataResource]

              

              click cyhole.gecko.schema.TokenDataResource href "" "cyhole.gecko.schema.TokenDataResource"

Single token resource for the Token Data (single) endpoint.

Attributes:

Name Type Description
id str

GeckoTerminal token identifier.
type str

JSON:API resource type, always "token".
attributes TokenDataAttributes

token data payload.
relationships TokenDataRelationships | None

optional pointers to related top pools.

id instance-attribute 

id: str

type instance-attribute 

type: str

attributes instance-attribute 

attributes: TokenDataAttributes

relationships class-attribute instance-attribute 

relationships: TokenDataRelationships | None = None

TokenDataVolumeUsd

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.TokenDataVolumeUsd[TokenDataVolumeUsd]

              

              click cyhole.gecko.schema.TokenDataVolumeUsd href "" "cyhole.gecko.schema.TokenDataVolumeUsd"

Volume bucket returned inside a token-data attributes block.

Token Data endpoints typically return only the trailing 24-hour bucket. Modelled as TimeBucketedStr for consistency with pool resources.

Attributes:

Name Type Description
h24 str | None

trailing 24-hour USD volume; None when not reported.

h24 class-attribute instance-attribute 

h24: str | None = None

GetTokenInfoResponse

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.GetTokenInfoResponse[GetTokenInfoResponse]

              

              click cyhole.gecko.schema.GetTokenInfoResponse href "" "cyhole.gecko.schema.GetTokenInfoResponse"

Response payload from the Token Info endpoint, returning the complete metadata block of a single token: image set, GeckoTerminal trust score breakdown, holders distribution, social links, description and authorities. Use this to enrich a token view without making multiple requests.

Attributes:

Name Type Description
data TokenInfoData

token info resource.

data instance-attribute 

data: TokenInfoData

TokenInfoData

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.TokenInfoData[TokenInfoData]

              

              click cyhole.gecko.schema.TokenInfoData href "" "cyhole.gecko.schema.TokenInfoData"

Single token resource returned by the Token Info endpoint.

Attributes:

Name Type Description
id str

GeckoTerminal token identifier.
type str

JSON:API resource type, always "token".
attributes TokenFullInfoAttributes

full token metadata block (image set, scores, holders, socials, ...).

id instance-attribute 

id: str

type instance-attribute 

type: str

attributes instance-attribute 

attributes: TokenFullInfoAttributes

GetTokenHoldersChartResponse

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.GetTokenHoldersChartResponse[GetTokenHoldersChartResponse]

              

              click cyhole.gecko.schema.GetTokenHoldersChartResponse href "" "cyhole.gecko.schema.GetTokenHoldersChartResponse"

Response payload from the Token Holders Chart endpoint, returning the historical holders count for the requested token across the chosen window (7, 30 or max days). Useful to track adoption or sell-off pressure over time.

Attributes:

Name Type Description
data TokenHoldersChartData

time-series payload of holder counts.
meta TokenHoldersChartMeta

token identification block.

data instance-attribute 

data: TokenHoldersChartData

meta instance-attribute 

meta: TokenHoldersChartMeta

GetTopTokenHoldersResponse

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.GetTopTokenHoldersResponse[GetTopTokenHoldersResponse]

              

              click cyhole.gecko.schema.GetTopTokenHoldersResponse href "" "cyhole.gecko.schema.GetTopTokenHoldersResponse"

Response payload from the Top Token Holders endpoint, returning the top wallets holding the requested token along with realised/unrealised PnL details when include_pnl_details=true.

Attributes:

Name Type Description
data TopTokenHoldersData

top holders payload.

data instance-attribute 

data: TopTokenHoldersData

TokenHoldersChartAttributes

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.TokenHoldersChartAttributes[TokenHoldersChartAttributes]

              

              click cyhole.gecko.schema.TokenHoldersChartAttributes href "" "cyhole.gecko.schema.TokenHoldersChartAttributes"

Attributes block of the Token Holders Chart resource.

Attributes:

Name Type Description
token_holders_list list[list[str]]

ordered list of [timestamp_iso8601, holders_count_string] pairs. Both values are strings as returned by the API.

token_holders_list instance-attribute 

token_holders_list: list[list[str]]

TokenHoldersChartData

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.TokenHoldersChartData[TokenHoldersChartData]

              

              click cyhole.gecko.schema.TokenHoldersChartData href "" "cyhole.gecko.schema.TokenHoldersChartData"

Top-level data block of the Token Holders Chart response.

Attributes:

Name Type Description
id str

identifier of the holders-chart series.
type str

JSON:API resource type.
attributes TokenHoldersChartAttributes

time-series payload.

id instance-attribute 

id: str

type instance-attribute 

type: str

attributes instance-attribute 

attributes: TokenHoldersChartAttributes

TokenHoldersChartMeta

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.TokenHoldersChartMeta[TokenHoldersChartMeta]

              

              click cyhole.gecko.schema.TokenHoldersChartMeta href "" "cyhole.gecko.schema.TokenHoldersChartMeta"

meta block of the Token Holders Chart response.

Attributes:

Name Type Description
token TokenHoldersChartMetaToken

identification of the token whose holders chart is returned.

token instance-attribute 

token: TokenHoldersChartMetaToken

TokenHoldersChartMetaToken

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.TokenHoldersChartMetaToken[TokenHoldersChartMetaToken]

              

              click cyhole.gecko.schema.TokenHoldersChartMetaToken href "" "cyhole.gecko.schema.TokenHoldersChartMetaToken"

Reference info for the token whose holders chart is returned.

Attributes:

Name Type Description
name str

human-readable token name.
symbol str

token ticker symbol.
coingecko_coin_id str | None

CoinGecko coin id; None when not mapped.
address str

token contract address.

name instance-attribute 

name: str

symbol instance-attribute 

symbol: str

coingecko_coin_id class-attribute instance-attribute 

coingecko_coin_id: str | None = None

address instance-attribute 

address: str

TopTokenHolder

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.TopTokenHolder[TopTokenHolder]

              

              click cyhole.gecko.schema.TopTokenHolder href "" "cyhole.gecko.schema.TopTokenHolder"

Single entry in the Top Token Holders list.

Attributes:

Name Type Description
rank int

1-based rank of the holder by token balance.
address str

holder wallet address.
label str | None

descriptive label assigned by GeckoTerminal (e.g. exchange wallet); None when unlabelled.
amount str | None

token amount held (decimal string, decimals applied).
percentage str | None

holder share of total supply, as a percentage string.
value str | None

USD value of the holding (decimal string).
average_buy_price_usd str | None

estimated average USD buy price of the position.
total_buy_count int | None

number of buy trades observed for this address.
total_sell_count int | None

number of sell trades observed for this address.
unrealized_pnl_usd str | None

unrealized PnL in USD for the current position.
unrealized_pnl_percentage str | None

unrealized PnL as a percentage string.
realized_pnl_usd str | None

realized PnL in USD across closed positions.
realized_pnl_percentage str | None

realized PnL as a percentage string.
explorer_url str | None

blockchain explorer URL for the wallet on its network.

rank instance-attribute 

rank: int

address instance-attribute 

address: str

label class-attribute instance-attribute 

label: str | None = None

amount class-attribute instance-attribute 

amount: str | None = None

percentage class-attribute instance-attribute 

percentage: str | None = None

value class-attribute instance-attribute 

value: str | None = None

average_buy_price_usd class-attribute instance-attribute 

average_buy_price_usd: str | None = None

total_buy_count class-attribute instance-attribute 

total_buy_count: int | None = None

total_sell_count class-attribute instance-attribute 

total_sell_count: int | None = None

unrealized_pnl_usd class-attribute instance-attribute 

unrealized_pnl_usd: str | None = None

unrealized_pnl_percentage class-attribute instance-attribute 

unrealized_pnl_percentage: str | None = None

realized_pnl_usd class-attribute instance-attribute 

realized_pnl_usd: str | None = None

realized_pnl_percentage class-attribute instance-attribute 

realized_pnl_percentage: str | None = None

explorer_url class-attribute instance-attribute 

explorer_url: str | None = None

TopTokenHoldersAttributes

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.TopTokenHoldersAttributes[TopTokenHoldersAttributes]

              

              click cyhole.gecko.schema.TopTokenHoldersAttributes href "" "cyhole.gecko.schema.TopTokenHoldersAttributes"

Attributes block of the Top Token Holders resource.

Attributes:

Name Type Description
last_updated_at str | None

ISO-8601 timestamp of the snapshot.
holders list[TopTokenHolder]

ordered list of top holders.

last_updated_at class-attribute instance-attribute 

last_updated_at: str | None = None

holders instance-attribute 

holders: list[TopTokenHolder]

TopTokenHoldersData

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.TopTokenHoldersData[TopTokenHoldersData]

              

              click cyhole.gecko.schema.TopTokenHoldersData href "" "cyhole.gecko.schema.TopTokenHoldersData"

Top-level data block of the Top Token Holders response.

Attributes:

Name Type Description
id str

identifier of the holders snapshot.
type str

JSON:API resource type.
attributes TopTokenHoldersAttributes

list of top holders + snapshot timestamp.

id instance-attribute 

id: str

type instance-attribute 

type: str

attributes instance-attribute 

attributes: TopTokenHoldersAttributes

GetTopTokenTradersResponse

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.GetTopTokenTradersResponse[GetTopTokenTradersResponse]

              

              click cyhole.gecko.schema.GetTopTokenTradersResponse href "" "cyhole.gecko.schema.GetTopTokenTradersResponse"

Response payload from the Top Token Traders endpoint, returning the highest-performing wallets on the requested token by realised PnL, unrealised PnL, total buy or total sell USD. Useful for smart-money / whale-watching strategies.

Attributes:

Name Type Description
data TopTokenTradersData

top traders payload.

data instance-attribute 

data: TopTokenTradersData

TopTokenTrader

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.TopTokenTrader[TopTokenTrader]

              

              click cyhole.gecko.schema.TopTokenTrader href "" "cyhole.gecko.schema.TopTokenTrader"

Single entry in the Top Token Traders list.

Attributes:

Name Type Description
address str

trader wallet address.
name str | None

human-readable wallet name; None when unknown.
label str | None

descriptive label (e.g. exchange / smart-money tag); None when unlabelled.
type str | None

classification tag assigned by GeckoTerminal (e.g. "wallet", "contract").
realized_pnl_usd str | None

realized PnL in USD across closed trades on the token.
unrealized_pnl_usd str | None

unrealized PnL in USD for the open position; None when no position remains.
token_balance str | None

current token balance held; None when the position is closed.
average_buy_price_usd str | None

average USD buy price across all buy fills.
average_sell_price_usd str | None

average USD sell price across all sell fills.
total_buy_count int | None

number of buy trades.
total_sell_count int | None

number of sell trades.
total_buy_token_amount str | None

aggregate token amount bought (decimal string).
total_sell_token_amount str | None

aggregate token amount sold (decimal string).
total_buy_usd str | None

aggregate USD value bought.
total_sell_usd str | None

aggregate USD value sold.
explorer_url str | None

blockchain explorer URL for the wallet.

address instance-attribute 

address: str

name class-attribute instance-attribute 

name: str | None = None

label class-attribute instance-attribute 

label: str | None = None

type class-attribute instance-attribute 

type: str | None = None

realized_pnl_usd class-attribute instance-attribute 

realized_pnl_usd: str | None = None

unrealized_pnl_usd class-attribute instance-attribute 

unrealized_pnl_usd: str | None = None

token_balance class-attribute instance-attribute 

token_balance: str | None = None

average_buy_price_usd class-attribute instance-attribute 

average_buy_price_usd: str | None = None

average_sell_price_usd class-attribute instance-attribute 

average_sell_price_usd: str | None = None

total_buy_count class-attribute instance-attribute 

total_buy_count: int | None = None

total_sell_count class-attribute instance-attribute 

total_sell_count: int | None = None

total_buy_token_amount class-attribute instance-attribute 

total_buy_token_amount: str | None = None

total_sell_token_amount class-attribute instance-attribute 

total_sell_token_amount: str | None = None

total_buy_usd class-attribute instance-attribute 

total_buy_usd: str | None = None

total_sell_usd class-attribute instance-attribute 

total_sell_usd: str | None = None

explorer_url class-attribute instance-attribute 

explorer_url: str | None = None

TopTokenTradersAttributes

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.TopTokenTradersAttributes[TopTokenTradersAttributes]

              

              click cyhole.gecko.schema.TopTokenTradersAttributes href "" "cyhole.gecko.schema.TopTokenTradersAttributes"

Attributes block of the Top Token Traders resource.

Attributes:

Name Type Description
traders list[TopTokenTrader]

ordered list of top traders, sorted by the requested sort criterion.

traders instance-attribute 

traders: list[TopTokenTrader]

TopTokenTradersData

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.TopTokenTradersData[TopTokenTradersData]

              

              click cyhole.gecko.schema.TopTokenTradersData href "" "cyhole.gecko.schema.TopTokenTradersData"

Top-level data block of the Top Token Traders response.

Attributes:

Name Type Description
id str

identifier of the traders snapshot.
type str

JSON:API resource type.
attributes TopTokenTradersAttributes

top-traders payload.

id instance-attribute 

id: str

type instance-attribute 

type: str

attributes instance-attribute 

attributes: TopTokenTradersAttributes

GetSimpleTokenPriceQuery

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.GetSimpleTokenPriceQuery[GetSimpleTokenPriceQuery]

              

              click cyhole.gecko.schema.GetSimpleTokenPriceQuery href "" "cyhole.gecko.schema.GetSimpleTokenPriceQuery"

Query-string bundle for the Onchain Simple Token Price endpoint, exposed as a model because the endpoint accepts six optional include_* flags.

Attributes:

Name Type Description
include_market_cap bool | None

when True, the response carries a market_cap_usd map keyed by address.
mcap_fdv_fallback bool | None

when True together with include_market_cap, the server returns FDV for tokens lacking a market cap so the field is never missing.
include_24hr_vol bool | None

when True, the response carries a h24_volume_usd map keyed by address.
include_24hr_price_change bool | None

when True, the response carries a h24_price_change_percentage map.
include_total_reserve_in_usd bool | None

when True, the response carries a total_reserve_in_usd map.
include_inactive_source bool | None

when True, include data from sources GeckoTerminal has flagged as inactive.

include_market_cap class-attribute instance-attribute 

include_market_cap: bool | None = None

mcap_fdv_fallback class-attribute instance-attribute 

mcap_fdv_fallback: bool | None = None

include_24hr_vol class-attribute instance-attribute 

include_24hr_vol: bool | None = None

include_24hr_price_change class-attribute instance-attribute 

include_24hr_price_change: bool | None = None

include_total_reserve_in_usd class-attribute instance-attribute 

include_total_reserve_in_usd: bool | None = None

include_inactive_source class-attribute instance-attribute 

include_inactive_source: bool | None = None

GetSimpleTokenPriceResponse

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.GetSimpleTokenPriceResponse[GetSimpleTokenPriceResponse]

              

              click cyhole.gecko.schema.GetSimpleTokenPriceResponse href "" "cyhole.gecko.schema.GetSimpleTokenPriceResponse"

Response payload from the Onchain Simple Token Price endpoint, returning current USD prices (and optional metrics) for up to 100 tokens on a single network in one request. Designed for lightweight quote lookups when the full Token Data payload is not needed.

Attributes:

Name Type Description
data SimpleTokenPriceData

per-token price and metric maps.

data instance-attribute 

data: SimpleTokenPriceData

SimpleTokenPriceAttributes

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.SimpleTokenPriceAttributes[SimpleTokenPriceAttributes]

              

              click cyhole.gecko.schema.SimpleTokenPriceAttributes href "" "cyhole.gecko.schema.SimpleTokenPriceAttributes"

Attributes block of the Simple Token Price response.

Every map is keyed by the lower-cased token contract address. Optional maps are only present when the corresponding include_* query flag is set on the request.

Attributes:

Name Type Description
token_prices dict[str, str | None] | None

USD price per token (decimal string).
market_cap_usd dict[str, str | None] | None

USD market cap per token; present when include_market_cap=true. With mcap_fdv_fallback=true returns FDV when market cap is unavailable.
h24_volume_usd dict[str, str | None] | None

trailing-24h USD volume per token; present when include_24hr_vol=true.
h24_price_change_percentage dict[str, str | None] | None

trailing-24h price change per token (percentage string); present when include_24hr_price_change=true.
total_reserve_in_usd dict[str, str | None] | None

aggregate pool reserve in USD per token; present when include_total_reserve_in_usd=true.
last_trade_timestamp dict[str, int | None] | None

unix timestamp (seconds) of the latest trade per token.

token_prices class-attribute instance-attribute 

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

market_cap_usd class-attribute instance-attribute 

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

h24_volume_usd class-attribute instance-attribute 

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

h24_price_change_percentage class-attribute instance-attribute 

h24_price_change_percentage: (
    dict[str, str | None] | None
) = None

total_reserve_in_usd class-attribute instance-attribute 

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

last_trade_timestamp class-attribute instance-attribute 

last_trade_timestamp: dict[str, int | None] | None = None

SimpleTokenPriceData

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.SimpleTokenPriceData[SimpleTokenPriceData]

              

              click cyhole.gecko.schema.SimpleTokenPriceData href "" "cyhole.gecko.schema.SimpleTokenPriceData"

Top-level data block of the Simple Token Price response.

Attributes:

Name Type Description
id str

identifier of the response.
type str

JSON:API resource type.
attributes SimpleTokenPriceAttributes

per-address price + optional metric maps.

id instance-attribute 

id: str

type instance-attribute 

type: str

attributes instance-attribute 

attributes: SimpleTokenPriceAttributes

GetSearchPoolsResponse

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.GetSearchPoolsResponse[GetSearchPoolsResponse]

              

              click cyhole.gecko.schema.GetSearchPoolsResponse href "" "cyhole.gecko.schema.GetSearchPoolsResponse"

Response payload from the Search Pools endpoint, returning the pools matching the requested query (pool address, token name, symbol, or token contract address) optionally constrained to a given network. When include is provided, the linked token/DEX resources are expanded inline.

Attributes:

Name Type Description
data list[SearchPoolData]

list of matching pool resources.
included list[SearchIncluded] | None

embedded token/DEX resources for the requested include relationships; None otherwise.
links LinksResponse | None

JSON:API pagination links.

data instance-attribute 

data: list[SearchPoolData]

included class-attribute instance-attribute 

included: list[SearchIncluded] | None = None

links: LinksResponse | None = None

SearchIncluded

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.SearchIncluded[SearchIncluded]

              

              click cyhole.gecko.schema.SearchIncluded href "" "cyhole.gecko.schema.SearchIncluded"

Single resource embedded in the search response's included array (typed "token" or "dex").

Attributes:

Name Type Description
id str

resource identifier.
type str

JSON:API resource type ("token" or "dex").
attributes SearchIncludedAttributes

resource attributes.

id instance-attribute 

id: str

type instance-attribute 

type: str

attributes instance-attribute 

attributes: SearchIncludedAttributes

SearchIncludedAttributes

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.SearchIncludedAttributes[SearchIncludedAttributes]

              

              click cyhole.gecko.schema.SearchIncludedAttributes href "" "cyhole.gecko.schema.SearchIncludedAttributes"

Attributes block of a resource embedded inside the search response's included array (token or DEX). Fields not relevant to a given resource type are None.

Attributes:

Name Type Description
address str | None

token contract address; None for DEX resources.
name str | None

human-readable name (token or DEX).
symbol str | None

token ticker symbol; None for DEX resources.
decimals int | None

token decimals; None for DEX resources.
image_url str | None

token image URL; None for DEX resources.
coingecko_coin_id str | None

CoinGecko coin id mapped to the token; None for DEX resources or unmapped tokens.

address class-attribute instance-attribute 

address: 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

image_url class-attribute instance-attribute 

image_url: str | None = None

coingecko_coin_id class-attribute instance-attribute 

coingecko_coin_id: str | None = None

SearchPoolAttributes

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.SearchPoolAttributes[SearchPoolAttributes]

              

              click cyhole.gecko.schema.SearchPoolAttributes href "" "cyhole.gecko.schema.SearchPoolAttributes"

Attributes block of a pool resource returned by the Search Pools endpoint.

Attributes:

Name Type Description
base_token_price_usd str | None

USD price of the pool's base token.
base_token_price_native_currency str | None

base-token price expressed in the network native currency.
quote_token_price_usd str | None

USD price of the pool's quote token.
quote_token_price_native_currency str | None

quote-token price expressed in the network native currency.
base_token_price_quote_token str | None

base/quote price ratio.
quote_token_price_base_token str | None

quote/base price ratio.
address str | None

pool contract address.
name str | None

human-readable pool name.
pool_created_at str | None

ISO-8601 creation timestamp.
fdv_usd str | None

fully-diluted valuation in USD; None when not computable.
market_cap_usd str | None

market cap in USD; None when supply data is unavailable.
price_change_percentage TimeBucketedStr | None

% change of the base price per time window.
transactions TransactionsTimeBuckets | None

transaction-count breakdown per time window.
volume_usd TimeBucketedStr | None

USD volume per time window.
reserve_in_usd str | None

aggregate USD reserve.

base_token_price_usd class-attribute instance-attribute 

base_token_price_usd: str | None = None

base_token_price_native_currency class-attribute instance-attribute 

base_token_price_native_currency: str | None = None

quote_token_price_usd class-attribute instance-attribute 

quote_token_price_usd: str | None = None

quote_token_price_native_currency class-attribute instance-attribute 

quote_token_price_native_currency: str | None = None

base_token_price_quote_token class-attribute instance-attribute 

base_token_price_quote_token: str | None = None

quote_token_price_base_token class-attribute instance-attribute 

quote_token_price_base_token: str | None = None

address class-attribute instance-attribute 

address: str | None = None

name class-attribute instance-attribute 

name: str | None = None

pool_created_at class-attribute instance-attribute 

pool_created_at: str | None = None

fdv_usd class-attribute instance-attribute 

fdv_usd: str | None = None

market_cap_usd class-attribute instance-attribute 

market_cap_usd: str | None = None

price_change_percentage class-attribute instance-attribute 

price_change_percentage: TimeBucketedStr | None = None

transactions class-attribute instance-attribute 

transactions: TransactionsTimeBuckets | None = None

volume_usd class-attribute instance-attribute 

volume_usd: TimeBucketedStr | None = None

reserve_in_usd class-attribute instance-attribute 

reserve_in_usd: str | None = None

SearchPoolData

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.SearchPoolData[SearchPoolData]

              

              click cyhole.gecko.schema.SearchPoolData href "" "cyhole.gecko.schema.SearchPoolData"

Single pool resource returned by the Search Pools endpoint.

Attributes:

Name Type Description
id str

GeckoTerminal pool identifier (e.g. "eth_0x....").
type str

JSON:API resource type, always "pool".
attributes SearchPoolAttributes

pool-stats payload.
relationships SearchPoolRelationships | None

pointers to base/quote token, network, and DEX.

id instance-attribute 

id: str

type instance-attribute 

type: str

attributes instance-attribute 

attributes: SearchPoolAttributes

relationships class-attribute instance-attribute 

relationships: SearchPoolRelationships | None = None

SearchPoolRelationships

Bases: BaseModel


              flowchart TD
              cyhole.gecko.schema.SearchPoolRelationships[SearchPoolRelationships]

              

              click cyhole.gecko.schema.SearchPoolRelationships href "" "cyhole.gecko.schema.SearchPoolRelationships"

Relationships block of a search-pools entry.

Attributes:

Name Type Description
base_token RelationshipData | None

pointer to the base token resource.
quote_token RelationshipData | None

pointer to the quote token resource.
network RelationshipData | None

pointer to the network resource.
dex RelationshipData | None

pointer to the DEX resource.

base_token class-attribute instance-attribute 

base_token: RelationshipData | None = None

quote_token class-attribute instance-attribute 

quote_token: RelationshipData | None = None

network class-attribute instance-attribute 

network: RelationshipData | None = None

dex class-attribute instance-attribute 

dex: RelationshipData | None = None