Metadata-Version: 2.1
Name: coingecko_module
Version: 0.1.0
Summary: A Python wrapper for the CoinGecko API
Home-page: https://github.com/amukherjee1991/coingecko_module
Author: Your Name
Author-email: arghyazzz@gmail.com
Keywords: coingecko cryptocurrency api wrapper
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Description-Content-Type: text/markdown
Requires-Dist: pandas

# CoinGeckoAPI

The `CoinGeckoAPI` class provides a simple interface for accessing cryptocurrency prices from the CoinGecko API.

## Initialization

To create a new instance of the `CoinGeckoAPI` class, you can optionally specify the `base_url` parameter. If not specified, the default base URL is `https://api.coingecko.com/api/v3/`.

```
api = CoinGeckoAPI(base_url='https://api.coingecko.com/api/v3/)
```
## Methods

`get_price_current(coin_id)`
This method retrieves the current price of a cryptocurrency based on its `coin_id`.
get_volume_current and get_marketcap_current are similar and accepts the same Parameters

```Parameters
coin_id (str): The ID of the cryptocurrency, as defined by CoinGecko.
Returns The current price of the cryptocurrency in USD (float).
```
`get_coins()`
This method retrieves list of coins on coingecko on current date

```Parameters
This method do not need any Parameters
```
`all_price_data_daily(self,coin_id,days='max'`

This method retrieves price data for a particular coin based on its `coin_id` and `days`.
days is max by default and both the parameters are `str`.
`all_volume_data_daily` and `all_marketcap_data_daily` does the same for volume and marketcap respectively.

```Parameters
coin_id (str): The ID of the cryptocurrency, as defined by CoinGecko.
days (str): Number of days for which you want to retrieve the data.
Returns a list of all price.
```
