api.md

AssetPlatforms

Types:

from coingecko_sdk.types import AssetPlatformGetResponse

Methods:

• client.asset_platforms.get(**params) -> AssetPlatformGetResponse

Coins

Types:

from coingecko_sdk.types import CoinGetIDResponse

Methods:

• client.coins.get_id(id, **params) -> CoinGetIDResponse

Categories

Types:

from coingecko_sdk.types.coins import CategoryGetResponse, CategoryGetListResponse

Methods:

• client.coins.categories.get(**params) -> CategoryGetResponse
• client.coins.categories.get_list() -> CategoryGetListResponse

List

Types:

from coingecko_sdk.types.coins import ListGetResponse, ListGetNewResponse

Methods:

• client.coins.list.get(**params) -> ListGetResponse
• client.coins.list.get_new() -> ListGetNewResponse

Markets

Types:

from coingecko_sdk.types.coins import MarketGetResponse

Methods:

• client.coins.markets.get(**params) -> MarketGetResponse

TopGainersLosers

Types:

from coingecko_sdk.types.coins import TopGainersLoserGetResponse

Methods:

• client.coins.top_gainers_losers.get(**params) -> TopGainersLoserGetResponse

CirculatingSupplyChart

Types:

from coingecko_sdk.types.coins import (
    CirculatingSupplyChartGetResponse,
    CirculatingSupplyChartGetRangeResponse,
)

Methods:

• client.coins.circulating_supply_chart.get(id, **params) -> CirculatingSupplyChartGetResponse
• client.coins.circulating_supply_chart.get_range(id, **params) -> CirculatingSupplyChartGetRangeResponse

Contract

Types:

from coingecko_sdk.types.coins import ContractGetResponse

Methods:

• client.coins.contract.get(contract_address, *, id) -> ContractGetResponse

MarketChart

Types:

from coingecko_sdk.types.coins.contract import MarketChartGetResponse, MarketChartGetRangeResponse

Methods:

• client.coins.contract.market_chart.get(contract_address, *, id, **params) -> MarketChartGetResponse
• client.coins.contract.market_chart.get_range(contract_address, *, id, **params) -> MarketChartGetRangeResponse

History

Types:

from coingecko_sdk.types.coins import HistoryGetResponse

Methods:

• client.coins.history.get(id, **params) -> HistoryGetResponse

MarketChart

Types:

from coingecko_sdk.types.coins import MarketChartGetResponse, MarketChartGetRangeResponse

Methods:

• client.coins.market_chart.get(id, **params) -> MarketChartGetResponse
• client.coins.market_chart.get_range(id, **params) -> MarketChartGetRangeResponse

Ohlc

Types:

from coingecko_sdk.types.coins import OhlcGetResponse, OhlcGetRangeResponse

Methods:

• client.coins.ohlc.get(id, **params) -> OhlcGetResponse
• client.coins.ohlc.get_range(id, **params) -> OhlcGetRangeResponse

Tickers

Types:

from coingecko_sdk.types.coins import TickerGetResponse

Methods:

• client.coins.tickers.get(id, **params) -> TickerGetResponse

TotalSupplyChart

Types:

from coingecko_sdk.types.coins import TotalSupplyChartGetResponse, TotalSupplyChartGetRangeResponse

Methods:

• client.coins.total_supply_chart.get(id, **params) -> TotalSupplyChartGetResponse
• client.coins.total_supply_chart.get_range(id, **params) -> TotalSupplyChartGetRangeResponse

Derivatives

Types:

from coingecko_sdk.types import DerivativeGetResponse

Methods:

• client.derivatives.get() -> DerivativeGetResponse

Exchanges

Types:

from coingecko_sdk.types.derivatives import (
    ExchangeGetResponse,
    ExchangeGetIDResponse,
    ExchangeGetListResponse,
)

Methods:

• client.derivatives.exchanges.get(**params) -> ExchangeGetResponse
• client.derivatives.exchanges.get_id(id, **params) -> ExchangeGetIDResponse
• client.derivatives.exchanges.get_list() -> ExchangeGetListResponse

Entities

Types:

from coingecko_sdk.types import EntityGetListResponse

Methods:

• client.entities.get_list(**params) -> EntityGetListResponse

ExchangeRates

Types:

from coingecko_sdk.types import ExchangeRateGetResponse

Methods:

• client.exchange_rates.get() -> ExchangeRateGetResponse

Exchanges

Types:

from coingecko_sdk.types import ExchangeGetResponse, ExchangeGetIDResponse, ExchangeGetListResponse

Methods:

• client.exchanges.get(**params) -> ExchangeGetResponse
• client.exchanges.get_id(id, **params) -> ExchangeGetIDResponse
• client.exchanges.get_list(**params) -> ExchangeGetListResponse

Tickers

Types:

from coingecko_sdk.types.exchanges import TickerGetResponse

Methods:

• client.exchanges.tickers.get(id, **params) -> TickerGetResponse

VolumeChart

Types:

from coingecko_sdk.types.exchanges import VolumeChartGetResponse, VolumeChartGetRangeResponse

Methods:

• client.exchanges.volume_chart.get(id, **params) -> VolumeChartGetResponse
• client.exchanges.volume_chart.get_range(id, **params) -> VolumeChartGetRangeResponse

Global

Types:

from coingecko_sdk.types import GlobalGetResponse

Methods:

• client.global*.get() -> GlobalGetResponse

DecentralizedFinanceDefi

Types:

from coingecko_sdk.types.global_ import DecentralizedFinanceDefiGetResponse

Methods:

• client.global*.decentralized_finance_defi.get() -> DecentralizedFinanceDefiGetResponse

MarketCapChart

Types:

from coingecko_sdk.types.global_ import MarketCapChartGetResponse

Methods:

• client.global*.market_cap_chart.get(**params) -> MarketCapChartGetResponse

Key

Types:

from coingecko_sdk.types import KeyGetResponse

Methods:

• client.key.get() -> KeyGetResponse

NFTs

Types:

from coingecko_sdk.types import NFTGetIDResponse, NFTGetListResponse, NFTGetMarketsResponse

Methods:

• client.nfts.get_id(id) -> NFTGetIDResponse
• client.nfts.get_list(**params) -> NFTGetListResponse
• client.nfts.get_markets(**params) -> NFTGetMarketsResponse

Contract

Types:

from coingecko_sdk.types.nfts import ContractGetContractAddressResponse

Methods:

• client.nfts.contract.get_contract_address(contract_address, *, asset_platform_id) -> ContractGetContractAddressResponse

MarketChart

Types:

from coingecko_sdk.types.nfts.contract import MarketChartGetResponse

Methods:

• client.nfts.contract.market_chart.get(contract_address, *, asset_platform_id, **params) -> MarketChartGetResponse

MarketChart

Types:

from coingecko_sdk.types.nfts import MarketChartGetResponse

Methods:

• client.nfts.market_chart.get(id, **params) -> MarketChartGetResponse

Tickers

Types:

from coingecko_sdk.types.nfts import TickerGetResponse

Methods:

• client.nfts.tickers.get(id) -> TickerGetResponse

Onchain

Categories

Types:

from coingecko_sdk.types.onchain import CategoryGetResponse, CategoryGetPoolsResponse

Methods:

• client.onchain.categories.get(**params) -> CategoryGetResponse
• client.onchain.categories.get_pools(category_id, **params) -> CategoryGetPoolsResponse

Networks

Types:

from coingecko_sdk.types.onchain import NetworkGetResponse

Methods:

• client.onchain.networks.get(**params) -> NetworkGetResponse

NewPools

Types:

from coingecko_sdk.types.onchain.networks import NewPoolGetResponse, NewPoolGetNetworkResponse

Methods:

• client.onchain.networks.new_pools.get(**params) -> NewPoolGetResponse
• client.onchain.networks.new_pools.get_network(network, **params) -> NewPoolGetNetworkResponse

TrendingPools

Types:

from coingecko_sdk.types.onchain.networks import (
    TrendingPoolGetResponse,
    TrendingPoolGetNetworkResponse,
)

Methods:

• client.onchain.networks.trending_pools.get(**params) -> TrendingPoolGetResponse
• client.onchain.networks.trending_pools.get_network(network, **params) -> TrendingPoolGetNetworkResponse

Dexes

Types:

from coingecko_sdk.types.onchain.networks import DexGetResponse, DexGetPoolsResponse

Methods:

• client.onchain.networks.dexes.get(network, **params) -> DexGetResponse
• client.onchain.networks.dexes.get_pools(dex, *, network, **params) -> DexGetPoolsResponse

Pools

Types:

from coingecko_sdk.types.onchain.networks import PoolGetResponse, PoolGetAddressResponse

Methods:

• client.onchain.networks.pools.get(network, **params) -> PoolGetResponse
• client.onchain.networks.pools.get_address(address, *, network, **params) -> PoolGetAddressResponse

Multi

Types:

from coingecko_sdk.types.onchain.networks.pools import MultiGetAddressesResponse

Methods:

• client.onchain.networks.pools.multi.get_addresses(addresses, *, network, **params) -> MultiGetAddressesResponse

Info

Types:

from coingecko_sdk.types.onchain.networks.pools import InfoGetResponse

Methods:

• client.onchain.networks.pools.info.get(pool_address, *, network, **params) -> InfoGetResponse

Ohlcv

Types:

from coingecko_sdk.types.onchain.networks.pools import OhlcvGetTimeframeResponse

Methods:

• client.onchain.networks.pools.ohlcv.get_timeframe(timeframe, *, network, pool_address, **params) -> OhlcvGetTimeframeResponse

Trades

Types:

from coingecko_sdk.types.onchain.networks.pools import TradeGetResponse

Methods:

• client.onchain.networks.pools.trades.get(pool_address, *, network, **params) -> TradeGetResponse

Tokens

Types:

from coingecko_sdk.types.onchain.networks import TokenGetAddressResponse

Methods:

• client.onchain.networks.tokens.get_address(address, *, network, **params) -> TokenGetAddressResponse

Multi

Types:

from coingecko_sdk.types.onchain.networks.tokens import MultiGetAddressesResponse

Methods:

• client.onchain.networks.tokens.multi.get_addresses(addresses, *, network, **params) -> MultiGetAddressesResponse

Info

Types:

from coingecko_sdk.types.onchain.networks.tokens import InfoGetResponse

Methods:

• client.onchain.networks.tokens.info.get(address, *, network) -> InfoGetResponse

TopHolders

Types:

from coingecko_sdk.types.onchain.networks.tokens import TopHolderGetResponse

Methods:

• client.onchain.networks.tokens.top_holders.get(address, *, network, **params) -> TopHolderGetResponse

HoldersChart

Types:

from coingecko_sdk.types.onchain.networks.tokens import HoldersChartGetResponse

Methods:

• client.onchain.networks.tokens.holders_chart.get(token_address, *, network, **params) -> HoldersChartGetResponse

Ohlcv

Types:

from coingecko_sdk.types.onchain.networks.tokens import OhlcvGetTimeframeResponse

Methods:

• client.onchain.networks.tokens.ohlcv.get_timeframe(timeframe, *, network, token_address, **params) -> OhlcvGetTimeframeResponse

Pools

Types:

from coingecko_sdk.types.onchain.networks.tokens import PoolGetResponse

Methods:

• client.onchain.networks.tokens.pools.get(token_address, *, network, **params) -> PoolGetResponse

Trades

Types:

from coingecko_sdk.types.onchain.networks.tokens import TradeGetResponse

Methods:

• client.onchain.networks.tokens.trades.get(token_address, *, network, **params) -> TradeGetResponse

TopTraders

Types:

from coingecko_sdk.types.onchain.networks.tokens import TopTraderGetResponse

Methods:

• client.onchain.networks.tokens.top_traders.get(token_address, *, network_id, **params) -> TopTraderGetResponse

Pools

Megafilter

Types:

from coingecko_sdk.types.onchain.pools import MegafilterGetResponse

Methods:

• client.onchain.pools.megafilter.get(**params) -> MegafilterGetResponse

TrendingSearch

Types:

from coingecko_sdk.types.onchain.pools import TrendingSearchGetResponse

Methods:

• client.onchain.pools.trending_search.get(**params) -> TrendingSearchGetResponse

Search

Pools

Types:

from coingecko_sdk.types.onchain.search import PoolGetResponse

Methods:

• client.onchain.search.pools.get(**params) -> PoolGetResponse

Simple

Networks

TokenPrice

Types:

from coingecko_sdk.types.onchain.simple.networks import TokenPriceGetAddressesResponse

Methods:

• client.onchain.simple.networks.token_price.get_addresses(addresses, *, network, **params) -> TokenPriceGetAddressesResponse

Tokens

InfoRecentlyUpdated

Types:

from coingecko_sdk.types.onchain.tokens import InfoRecentlyUpdatedGetResponse

Methods:

• client.onchain.tokens.info_recently_updated.get(**params) -> InfoRecentlyUpdatedGetResponse

Ping

Types:

from coingecko_sdk.types import PingGetResponse

Methods:

• client.ping.get() -> PingGetResponse

PublicTreasury

Types:

from coingecko_sdk.types import (
    PublicTreasuryGetCoinIDResponse,
    PublicTreasuryGetEntityIDResponse,
    PublicTreasuryGetHoldingChartResponse,
    PublicTreasuryGetTransactionHistoryResponse,
)

Methods:

• client.public_treasury.get_coin_id(coin_id, *, entity, **params) -> PublicTreasuryGetCoinIDResponse
• client.public_treasury.get_entity_id(entity_id, **params) -> PublicTreasuryGetEntityIDResponse
• client.public_treasury.get_holding_chart(coin_id, *, entity_id, **params) -> PublicTreasuryGetHoldingChartResponse
• client.public_treasury.get_transaction_history(entity_id, **params) -> PublicTreasuryGetTransactionHistoryResponse

Search

Types:

from coingecko_sdk.types import SearchGetResponse

Methods:

• client.search.get(**params) -> SearchGetResponse

Trending

Types:

from coingecko_sdk.types.search import TrendingGetResponse

Methods:

• client.search.trending.get(**params) -> TrendingGetResponse

Simple

Price

Types:

from coingecko_sdk.types.simple import PriceGetResponse

Methods:

• client.simple.price.get(**params) -> PriceGetResponse

SupportedVsCurrencies

Types:

from coingecko_sdk.types.simple import SupportedVsCurrencyGetResponse

Methods:

• client.simple.supported_vs_currencies.get() -> SupportedVsCurrencyGetResponse

TokenPrice

Types:

from coingecko_sdk.types.simple import TokenPriceGetIDResponse

Methods:

• client.simple.token_price.get_id(id, **params) -> TokenPriceGetIDResponse

TokenLists

Types:

from coingecko_sdk.types import TokenListGetAllJsonResponse

Methods:

• client.token_lists.get_all_json(asset_platform_id) -> TokenListGetAllJsonResponse