# 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.
```
Raw data
{
"_id": null,
"home_page": "https://github.com/amukherjee1991/coingecko_module",
"name": "coingecko-module",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "coingecko cryptocurrency api wrapper",
"author": "Your Name",
"author_email": "arghyazzz@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/6e/96/9c1e45c963247a64b4abd5f097912a90467ab9896f41675db1c360676da9/coingecko_module-0.2.0.tar.gz",
"platform": null,
"description": "# CoinGeckoAPI\n\nThe `CoinGeckoAPI` class provides a simple interface for accessing cryptocurrency prices from the CoinGecko API.\n\n## Initialization\n\nTo 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/`.\n\n```\napi = CoinGeckoAPI(base_url='https://api.coingecko.com/api/v3/)\n```\n## Methods\n\n`get_price_current(coin_id)`\nThis method retrieves the current price of a cryptocurrency based on its `coin_id`.\nget_volume_current and get_marketcap_current are similar and accepts the same Parameters\n\n```Parameters\ncoin_id (str): The ID of the cryptocurrency, as defined by CoinGecko.\nReturns The current price of the cryptocurrency in USD (float).\n```\n`get_coins()`\nThis method retrieves list of coins on coingecko on current date\n\n```Parameters\nThis method do not need any Parameters\n```\n`all_price_data_daily(self,coin_id,days='max'`\n\nThis method retrieves price data for a particular coin based on its `coin_id` and `days`.\ndays is max by default and both the parameters are `str`.\n`all_volume_data_daily` and `all_marketcap_data_daily` does the same for volume and marketcap respectively.\n\n```Parameters\ncoin_id (str): The ID of the cryptocurrency, as defined by CoinGecko.\ndays (str): Number of days for which you want to retrieve the data.\nReturns a list of all price.\n```\n",
"bugtrack_url": null,
"license": null,
"summary": "A Python wrapper for the CoinGecko API",
"version": "0.2.0",
"project_urls": {
"Homepage": "https://github.com/amukherjee1991/coingecko_module"
},
"split_keywords": [
"coingecko",
"cryptocurrency",
"api",
"wrapper"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a218cba12b292d04a2f47d9f3d28db05cd74efd9810d3bd556085c64b2972681",
"md5": "3c109e1a3abe43e811b9580da288e5b6",
"sha256": "e4f405ab325f7f6efdc5cd191c32802593781a3f8d0a1ac593eb856badec9d44"
},
"downloads": -1,
"filename": "coingecko_module-0.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3c109e1a3abe43e811b9580da288e5b6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 1879,
"upload_time": "2024-03-21T02:31:35",
"upload_time_iso_8601": "2024-03-21T02:31:35.410894Z",
"url": "https://files.pythonhosted.org/packages/a2/18/cba12b292d04a2f47d9f3d28db05cd74efd9810d3bd556085c64b2972681/coingecko_module-0.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6e969c1e45c963247a64b4abd5f097912a90467ab9896f41675db1c360676da9",
"md5": "ef6d4dcbce3422a17088b98f8455a38d",
"sha256": "9664aebaa48fc78cff6de1fa2c7019be1e999b97c08f901f6bbf2fd8e4f68961"
},
"downloads": -1,
"filename": "coingecko_module-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "ef6d4dcbce3422a17088b98f8455a38d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 1881,
"upload_time": "2024-03-21T02:31:36",
"upload_time_iso_8601": "2024-03-21T02:31:36.834041Z",
"url": "https://files.pythonhosted.org/packages/6e/96/9c1e45c963247a64b4abd5f097912a90467ab9896f41675db1c360676da9/coingecko_module-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-21 02:31:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "amukherjee1991",
"github_project": "coingecko_module",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "coingecko-module"
}
JSON
