CoinGeckoClient

class CoinGeckoClient(httpClient: HttpClient)

Constructors

constructor()

Create a CoinGeckoClient with a new HttpClient instance with the default engine. NOTE: Call close to close the HttpClient.

constructor(httpClient: HttpClient)

Create a CoinGeckoClient with an externally managed HttpClient instance, close will NOT close the httpClient.

Types

Companion

object Companion

Functions

fun close()

If this instance uses a default HttpClient, this will close it. When an HttpClient is provided, it must be closed directly.

getAssetPlatforms

suspend fun getAssetPlatforms(): List<AssetPlatform>

getCoinById

suspend fun getCoinById(id: String, localization: Boolean = true, tickers: Boolean = false, marketData: Boolean = false, communityData: Boolean = false, developerData: Boolean = false, sparkline: Boolean = false): CoinFullData

getCoinCategories

suspend fun getCoinCategories(order: String = Order.MARKET_CAP_DESC): List<CoinCategoryAndData>

getCoinCategoriesList

suspend fun getCoinCategoriesList(): List<CoinCategory>

getCoinHistoryById

suspend fun getCoinHistoryById(id: String, date: String, localization: Boolean = false): CoinHistoryById

getCoinInfoByContractAddress

suspend fun getCoinInfoByContractAddress(id: String, contractAddress: String): CoinFullData

getCoinList

suspend fun getCoinList(includePlatform: Boolean = false): List<CoinList>

getCoinMarketChartById

suspend fun getCoinMarketChartById(id: String, vsCurrency: String, days: Double): MarketChart

getCoinMarketChartRangeById

suspend fun getCoinMarketChartRangeById(id: String, vsCurrency: String, from: String, to: String): MarketChart

getCoinMarkets

suspend fun getCoinMarkets(vsCurrency: String, ids: String? = null, order: String? = null, perPage: Int? = null, page: Int? = null, sparkline: Boolean = false, priceChangePercentage: String? = null): CoinMarketsList

getCoinOhlc

suspend fun getCoinOhlc(id: String, vsCurrency: String, days: Int): List<CoinOhlc>

getCoinStatusUpdateById

suspend fun getCoinStatusUpdateById(id: String, perPage: Int? = null, page: Int? = null): StatusUpdates

getCoinTickerById

suspend fun getCoinTickerById(id: String, exchangeIds: String? = null, page: Int? = null, order: String? = null): CoinTickerById

getExchangeRates

suspend fun getExchangeRates(): ExchangeRates

getExchanges

suspend fun getExchanges(page: Int? = null, perPage: Int? = null): ExchangeList

getExchangesById

suspend fun getExchangesById(id: String): Exchange

getExchangesList

suspend fun getExchangesList(): List<ExchangeId>

getExchangesTickersById

suspend fun getExchangesTickersById(id: String, coinIds: String? = null, page: Int? = null, order: String? = null): ExchangesTickersById

getExchangesVolumeChart

suspend fun getExchangesVolumeChart(id: String, days: Int): List<List<String>>

getGlobal

suspend fun getGlobal(): Global

getPrice

suspend fun getPrice(ids: String, vsCurrencies: String, includeMarketCap: Boolean = false, include24hrVol: Boolean = false, include24hrChange: Boolean = false, includeLastUpdatedAt: Boolean = false): Map<String, CoinPrice>

getSupportedVsCurrencies

suspend fun getSupportedVsCurrencies(): List<String>

getTokenPrice

suspend fun getTokenPrice(id: String, contractAddress: String, vsCurrencies: String, includeMarketCap: Boolean = false, include24hrVol: Boolean = false, include24hrChange: Boolean = false, includeLastUpdatedAt: Boolean = false): Map<String, Map<String, Double>>

getTrending

suspend fun getTrending(): TrendingCoinList

ping

suspend fun ping(): Ping

suspend fun search(query: String): SearchResults