coingecko_client #

Coingecko API client for Dart #

A simple and intuitive package to access the CoinGecko REST API Service.

Table of Contents #

1. API Version Support
2. Requirements
3. Installation
4. Usage
5. Endpoints
   • ping
   • coins
   • exchanges
   • simple
   • derivatives
   • indexes
   • nfts
   • contract
   • asset_platforms
   • categories
   • global
   • exchange rates
   • companies
   • trending
   • search
6. Issues / Bugs / Improvements
7. Contacts

API Version Support #

• ✔️ API v3
• ✔️ Community

Requirements #

• ✔️ dart sdk: >= 2.19.3

Installation #

Add the dependency to your Dart / Flutter project:
(under the dependencies, add the following)

coingecko_client: ^1.0.4

Usage #

• Import the library and initialize the client class.

import 'package:coingecko_client/coingecko_client.dart';

var client = CoinGeckoClient();

• Use any of the client properties to access the endpoint to use. (use coins for this case)
• All results are returned by a Future object so await is always necessary.

var coinHistory = await client.coins.getHistory(
    id: 'bitcoin',
    date: DateTime.now()
);

• Access the result's object

print(coinHistory);
print(coinHistory.name);

• Result varies depending on the endpoint.
• TIP: Most editor supports object reflection. You can hover on the result object to get all the available properties you can use.
• ( Checkout the example folder for more samples. )

🌐 ping #

📤 /ping #

client.ping.getResult();

Endpoints #

🌐 coins #

📤 /coins/list #

client.coins.getBasicList();

📤 /coins/{id}/history #

client.coins.getHistory(
    id: 'bitcoin',
    date: DateTime.now()
);

📤 /coins/markets #

client.coins.getMarketList(
    vsCurrency: Currencies.php
);

📤 /coins/{id} #

client.coins.getInfo(id: 'verus-coin');

📤 /coins/{id}/tickers #

client.coins.getTickers(id: 'bitcoin');

📤 /coins/{id}/market_chart #

client.coins.getMarketHistory(
    id: 'bitcoin',
    vsCurrency: Currencies.php,
    days: DataRange.in1Day,
    interval: 'daily'
);

📤 /coins/{id}/market_chart/range #

client.coins.getMarketHistoryWithDateRange(
    id: 'bitcoin',
    vsCurrency: Currencies.php,
    from: DateTime.fromMillisecondsSinceEpoch(1392577232),
    to: DateTime.fromMillisecondsSinceEpoch(1396587232)
);

📤 /coins/{id}/ohlc #

client.coins.getOhlcList(
    id: 'bitcoin',
    vsCurrency: Currencies.php,
    days: DataRange.max
);

🌐 exchanges #

📤 /exchanges #

client.exchanges.getList();

📤 /exchanges/list #

client.exchanges.getBasicList();

📤 /exchanges/{id} #

client.exchanges.getInfo(id: 'binance');

📤 /exchanges/{id}/tickers #

client.exchanges.getTickerList(
    id: 'binance',
    coinIds: ['bitcoin', 'ethereum'],
    includeExchangeLogo: true,
    page: 1,
    depth: true,
    order: ExchangeDataOrdering.trustScoreDesc
);

📤 /exchanges/{id}/volume_chart #

client.exchanges.getVolumeChartList(
    id: 'binance',
    days: DataRange.in1Day
);

🌐 simple #

📤 /simple/price #

client.simple.getCoinPrice(
    ids: ['bitcoin', 'ethereum', 'verus-coin'],
    vsCurrencies: [ Currencies.jpy, Currencies.usd, Currencies.php ],
    includeMarketCap: true,
    include24hrVol: true,
    include24hrChange: true,
    includeLastUpdatedAt: true,
    precision: 18
);

📤 /simple/token_price/{id} #

client.simple.getTokenPrice(
    id: 'avalanche',
    contractAddresses: ['0x2098fABE9C82eb5280AF4841a5000f373E99a498'],
    vsCurrencies: [ CryptoCurrencies.btc, CryptoCurrencies.eth ],
    includeMarketCap: true,
    include24hrVol: true,
    include24hrChange: true,
    includeLastUpdatedAt: true,
    precision: 18
);

📤 /simple/supported_vs_currencies #

client.simple.getSupportedVsCurrencies();

🌐 derivatives #

📤 /derivatives #

client.derivatives.getList(
    includeTickers: DerivativesTickers.unexpired
);

📤 /derivatives/exchanges #

client.derivatives.getExchangeList(
    order: DerivativesExchangeOrdering.nameAsc,
    perPage: 10,
    page: 2
);

📤 /derivatives/exchanges/{id} #

client.derivatives.getExchange(
    id: "bybit",
    includeTickers: DerivativesTickers.unexpired
);

📤 /derivatives/exchanges/list #

client.derivatives.getExchangeBasicInfoList();

🌐 indexes #

📤 /indexes #

client.indexes.getList(
    perPage: 10,
    page: 2
);

📤 /indexes/{market_id}/{id} #

client.indexes.getInfo(
    marketId: 'bybit',
    id: 'HOT',
);

📤 /indexes/list #

client.indexes.getBasicInfo();

🌐 nfts #

📤 /nfts/list #

client.nfts.getBasicList(
    perPage: 10,
    page: 2
);

📤 /nfts/{id} #

client.nfts.getInfo(
    id: 'meebits',
);

📤 /nfts/{asset_platform_id}/contract/{contract_address} #

client.nfts.getContractInfo(
    assetPlatformId: 'ethereum',
    contractAddress: '0x36F379400DE6c6BCDF4408B282F8b685c56adc60',
);

🌐 contract #

📤 /coins/{id}/contract/{contract_address}/market_chart #

client.contract.getMarketHistory(
    id: 'ethereum',
    contractAddress: '0x1f9840a85d5af5bf1d1762f925bdaddc4201f984',
    vsCurrency: Currencies.jpy,
    days: DataRange.in2Weeks,
);

📤 /coins/{id}/contract/{contract_address}/market_chart/range #

client.contract.getMarketHistoryWithDateRange(
    id: 'ethereum',
    contractAddress: '0x1f9840a85d5af5bf1d1762f925bdaddc4201f984',
    vsCurrency: Currencies.php,
    from: DateTime.fromMillisecondsSinceEpoch(1683175446, isUtc: true),
    to: DateTime.fromMillisecondsSinceEpoch(1683262856, isUtc: true),
);

🌐 asset_platforms #

📤 /asset_platforms #

client.assetPlatforms.getList();

🌐 categories #

📤 /coins/categories/list #

client.categories.getBasicList();

📤 /coins/categories #

client.categories.getList(
    order: CoinCategoriesDataOrdering.marketCapAsc
);

🌐 global #

📤 /global #

client.global.getCryptoInfo();

📤 /global/decentralized_finance_defi #

client.global.getDefiInfo();

🌐 exchange rates #

📤 /exchange_rates #

client.exchangeRates.getList();

🌐 companies #

📤 /companies/public_treasury/{coin_id} #

client.companies.getList(
    coinId: 'ethereum'
);

🌐 trending #

📤 /search/trending #

client.trending.getResult();

🌐 search #

📤 /search #

client.search.getResult(query: 'bybit');

🐞 Issues / Bugs / Improvements #

• If you found any issues or bugs, please let me know.
• If you require an urgent fix, raise an issue and I'll try to find time to resolve it.
• Should you decide to make your own change, create your own branch and raise a PR to the master branch.
• If you have any suggestions or concerns, you can contact me directly using discord.

Contacts #