Simple Dart wrapper for the CoinGecko API

Table of contents #

• Installation
• Usage
• Documentation
  • Query results
  • Sections
    • ping
    • simple
    • coins
    • contract
    • asset_platforms
    • categories
    • exchanges
    • indexes
    • derivatives
    • exchange_rates
    • search
    • trending
    • global
    • companies
  • Full Example
  • Tests
  • Roadmap
  • Contributing
  • License
  • Contact

Installation #

Add the dependency to your Dart / Flutter project:

dependencies:
  coingecko_api: ^1.1.0

Usage #

1. Create an instance of the API wrapper:

   CoinGeckoApi api = CoinGeckoApi();
   

2. Use any methods provided by wrapper. The methods are divided into sections, just as the CoinGecko does.

   final marketChart = await api.coins.getCoinMarketChart(
     id: 'bitcoin',
     vsCurrency: 'usd',
     days: 7,
   );
   

3. Work with the result as you see fit:

   if (!marketChart.isError) {
     marketChart.data.forEach((item) {
       print('Price: ${item.price}, Market Cap: ${item.marketCap}');
     });
   }
   

Documentation #

All methods are asynchronous and use Future, so you need to use await to get the result.

Query results #

The result of each method is a special object of type CoinGeckoResult. This is a kind of wrapper that allows you to first find out how successful the request was using its isError property. If isError is false, then we can use the data property of this object to get the processed data itself. Otherwise, we can view the error code and error message using properties errorCode and errorMessage.

Sections #

All methods are divided into sections for easier understanding of the purpose of each method. To call any method, we first need to specify a section.

General scheme:

final result = await api./*section name*/./*method name*/(/*parameters*/);

All sections fully correspond to those in the CoinGecko API documentation itself: https://www.coingecko.com/api/documentation

Let's take a closer look at each of the sections and a set of methods in them. Each section will contain a table indicating the method, a short description of the method and the corresponding query string from the official CoinGecko website.

ping #

simple #

coins #

contract #

asset_platforms #

categories #

exchanges #

indexes #

derivatives #

exchange_rates #

search #

trending #

global #

companies #

Full Example #

final result = await api.coins.getCoinOHLC(
    id: 'bitcoin',
    vsCurrency: 'usd',
    days: 7,
);
if (!result.isError) {
    print('getCoinOHLC method returned result');
    result.data.forEach(
        (item) => print(
            '${item.timestamp}: open = ${item.open}, high = ${item.high}, low = ${item.low}, close = ${item.close}',
        ),
    );
} else {
    print('getCoinOHLC method returned error ${result.errorCode}: ${result.errorMessage}');
}

Tests #

Each method is covered by a separate test using native dart testing platform dart test.

Roadmap #

See the open issues for a list of proposed features and known issues.

Contributing #

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the project
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License #

Distributed under the MIT License. See LICENSE for more information.

Contact #

Yegor Pelykh

E-mail: [email protected]

Project Link: github.com/yegor-pelykh/coingecko_api