CoinGecko MCP Server

> This project is a fork of pycoingecko.

> CoinGecko MCP Server wraps PyCoinGecko which wraps CoinGecko API. All in Python Supports both Public and Pro API:

Installation

PyPI

pip install -U pycoingecko

or from source

git clone https://github.com/man-c/pycoingecko.git
cd pycoingecko
python3 setup.py install

Usage

For free Public API:

from pycoingecko import CoinGeckoAPI
    cg = CoinGeckoAPI()

from pycoingecko import CoinGeckoAPI
    cg = CoinGeckoAPI(demo_api_key='YOUR_DEMO_API_KEY')

For Pro API:

from pycoingecko import CoinGeckoAPI
    cg = CoinGeckoAPI(api_key='YOUR_PRO_API_KEY')

Examples

The required parameters for each endpoint are defined as required (mandatory) parameters for the corresponding functions.\

Any optional parameters can be passed using same names, as defined in CoinGecko API doc (https://www.coingecko.com/en/api/documentation).

For any parameter:

• *Lists are supported as input for multiple-valued comma-separated parameters\

(e.g. see /simple/price usage examples).*

• *Booleans are supported as input for boolean type parameters; they can be `str` ('true', 'false'') or `bool` (`True`, `False`)\

(e.g. see /simple/price usage examples).*

Usage examples:

# /simple/price endpoint with the required parameters
>>> cg.get_price(ids='bitcoin', vs_currencies='usd')
{'bitcoin': {'usd': 3462.04}}

>>> cg.get_price(ids='bitcoin,litecoin,ethereum', vs_currencies='usd')
# OR (lists can be used for multiple-valued arguments)
>>> cg.get_price(ids=['bitcoin', 'litecoin', 'ethereum'], vs_currencies='usd')
{'bitcoin': {'usd': 3461.27}, 'ethereum': {'usd': 106.92}, 'litecoin': {'usd': 32.72}}

>>> cg.get_price(ids='bitcoin,litecoin,ethereum', vs_currencies='usd,eur')
# OR (lists can be used for multiple-valued arguments)
>>> cg.get_price(ids=['bitcoin', 'litecoin', 'ethereum'], vs_currencies=['usd', 'eur'])
{'bitcoin': {'usd': 3459.39, 'eur': 3019.33}, 'ethereum': {'usd': 106.91, 'eur': 93.31}, 'litecoin': {'usd': 32.72, 'eur': 28.56}}

# optional parameters can be passed as defined in the API doc (https://www.coingecko.com/api/docs/v3)
>>> cg.get_price(ids='bitcoin', vs_currencies='usd', include_market_cap='true', include_24hr_vol='true', include_24hr_change='true', include_last_updated_at='true')
{'bitcoin': {'usd': 3458.74, 'usd_market_cap': 60574330199.29028, 'usd_24h_vol': 4182664683.6247883, 'usd_24h_change': 1.2295378479069035, 'last_updated_at': 1549071865}}
# OR (also booleans can be used for boolean type arguments)
>>> cg.get_price(ids='bitcoin', vs_currencies='usd', include_market_cap=True, include_24hr_vol=True, include_24hr_change=True, include_last_updated_at=True)
{'bitcoin': {'usd': 3458.74, 'usd_market_cap': 60574330199.29028, 'usd_24h_vol': 4182664683.6247883, 'usd_24h_change': 1.2295378479069035, 'last_updated_at': 1549071865}}

API documentation

https://www.coingecko.com/en/api/documentation

📡 Endpoints included

> :warning: Endpoints documentation: To make sure that you are using properly each endpoint you should check the API documentation. Return behaviour and parameters of the endpoints, such as *pagination*, might have changed. Any optional parameters defined in CoinGecko API doc can be passed as function parameters using same parameters names with the API *(see Examples above)*.

ping

• /ping

_Check API server status_

cg.ping()

key

• [Pro API] 💼 /key

_Monitor your account's API usage, including rate limits, monthly total credits, remaining credits, and more_

cg.key()

simple

• /simple/price

_Get the current price of any cryptocurrencies in any other supported currencies that you need_

cg.get_price()

• /simple/token_price/{id}

_Get current price of tokens (using contract addresses) for a given platform in any other currency that you need_

cg.get_token_price()

• /simple/supported_vs_currencies

_Get list of supported_vs_currencies_

cg.get_supported_vs_currencies()

coins

• /coins/list

_List all supported coins id, name and symbol (no pagination required)_

cg.get_coins_list()

• [Pro API] 💼 /coins/top_gainers_losers

_Query the top 30 coins with largest price gain and loss by a specific time duration_

cg.get_coin_top_gainers_losers()

• [Pro API] 💼 /coins/list/new

_Query the latest 200 coins that recently listed on CoinGecko_

cg.get_coins_list_new()

• /coins/markets

_List all supported coins price, market cap, volume, and market related data_

cg.get_coins_markets()

• /coins/{id}

_Get current data (name, price, market, ... including exchange tickers) for a coin_

cg.get_coin_by_id()

• /coins/{id}/tickers

_Get coin tickers (paginated to 100 items)_

cg.get_coin_ticker_by_id()

• /coins/{id}/history

_Get historical data (name, price, market, stats) at a given date for a coin_

cg.get_coin_history_by_id()

• /coins/{id}/market_chart

_Get historical market data include price, market cap, and 24h volume (granularity auto)_

cg.get_coin_market_chart_by_id()

• /coins/{id}/market_chart/range

_Get historical market data include price, market cap, and 24h volume within a range of timestamp (granularity auto)_

cg.get_coin_market_chart_range_by_id()

[//]: # (* /coins/{id}/status_updates (Get status updates for a given coin (beta)))

[//]: # ( ```python)

[//]: # ( cg.get_coin_status_updates_by_id())

[//]: # ( ```)

• /coins/{id}/ohlc

_Get the OHLC chart (Open, High, Low, Close) of a coin based on particular coin id_

cg.get_coin_ohlc_by_id()

• [Pro API] 💼 /coins/{id}/ohlc/range

_Get the OHLC chart (Open, High, Low, Close) of a coin within a range of timestamp based on particular coin id_

cg.get_coin_ohlc_by_id_range()

• [Pro API] 👑 /coins/{id}/circulating_supply_chart

_Query historical circulating supply of a coin by number of days away from now based on provided coin id_

cg.get_coin_circulating_supply_chart()

• [Pro API] 👑 /coins/{id}/circulating_supply_chart/range

_Query historical circulating supply of a coin, within a range of timestamp based on the provided coin id_

cg.get_coin_circulating_supply_chart_range()

• [Pro API] 👑 /coins/{id}/total_supply_chart

_Query historical total supply of a coin by number of days away from now based on provided coin id_

cg.get_coin_total_supply_chart()

• [Pro API] 👑 /coins/{id}/total_supply_chart/range

_Query historical total supply of a coin, within a range of timestamp based on the provided coin id_

cg.get_coin_total_supply_chart_range()

contract

• /coins/{id}/contract/{contract_address}

_Get coin info from contract address_

cg.get_coin_info_from_contract_address_by_id()

• /coins/{id}/contract/{contract_address}/market_chart/

_Get historical market data include price, market cap, and 24h volume (granularity auto) from a contract address_

cg.get_coin_market_chart_from_contract_address_by_id()

• /coins/{id}/contract/{contract_address}/market_chart/range

_Get historical market data include price, market cap, and 24h volume within a range of timestamp (granularity auto) from a contract address_

cg.get_coin_market_chart_range_from_contract_address_by_id()

asset_platforms

• /asset_platforms

_List all asset platforms (Blockchain networks)_

cg.get_asset_platforms()

• [Pro API] 👑 /token_lists/{asset_platform_id}/all.json

_Get full list of tokens of a blockchain network (asset platform) that is supported by Ethereum token list standard_

cg.get_asset_platform_by_id()

categories

• /coins/categories/list

_List all categories_

cg.get_coins_categories_list()

• coins/categories

_List all categories with market data_

cg.get_coins_categories()

exchanges

• /exchanges

_List all exchanges_

cg.get_exchanges_list()

• /exchanges/list

_List all supported markets id and name (no pagination required)_

cg.get_exchanges_id_name_list()

• /exchanges/{id}

_Get exchange volume in BTC and top 100 tickers only_

cg.get_exchanges_by_id()

• /exchanges/{id}/tickers

_Get exchange tickers (paginated, 100 tickers per page)_

cg.get_exchanges_tickers_by_id()

[//]: # (* /exchanges/{id}/status_updates (Get status updates for a given exchange (beta)))

[//]: # ( ```python)

[//]: # ( cg.get_exchanges_status_updates_by_id())

[//]: # ( ```)

• /exchanges/{id}/volume_chart

_Get volume_chart data for a given exchange_

cg.get_exchanges_volume_chart_by_id()

• [Pro API] 💼 /exchanges/{id}/volume_chart/range

_Query the historical volume chart data in BTC by specifying date range in UNIX based on exchange’s id_

cg.get_exchanges_volume_chart_by_id_within_time_range()

[//]: # (finance)

[//]: # ()

[//]: # ()

[//]: # (* /finance_platforms (List all finance platforms))

[//]: # ( ```python)

[//]: # ( cg.get_finance_platforms())

[//]: # ( ```)

[//]: # (* /finance_products (List all finance products))

[//]: # ( ```python)

[//]: # ( cg.get_finance_products())

[//]: # ( ```)

[//]: # ()

indexes

• /indexes

_List all market indexes_

cg.get_indexes()

• /indexes/{market_id}/{id}

_Get market index by market id and index id_

cg.get_indexes_by_market_id_and_index_id()

• /indexes/list

_List market indexes id and name_

cg.get_indexes_list()

derivatives

• /derivatives

_List all derivative tickers_

cg.get_derivatives()

• /derivatives/exchanges

_List all derivative exchanges_

cg.get_derivatives_exchanges()

• /derivatives/exchanges/{id}

_Show derivative exchange data_

cg.get_derivatives_exchanges_by_id()

• /derivatives/exchanges/list

_List all derivative exchanges name and identifier_

cg.get_derivatives_exchanges_list()

nfts (beta)

• /nfts/list

_List all supported NFT ids, paginated by 100 items per page, paginated to 100 items_

cg.get_nfts_list()

• /nfts/{id}

_Get current data (name, price_floor, volume_24h ...) for an NFT collection. native_currency (string) is only a representative of the currency_

cg.get_nfts_by_id()

• /nfts/{asset_platform_id}/contract/{contract_address}

_Get current data (name, price_floor, volume_24h ...) for an NFT collection. native_currency (string) is only a representative of the currency_

cg.get_nfts_collection_by_asset_platform_id_and_contract_address()

• [Pro API] 💼 /nfts/markets

_Query all the supported NFT collections with floor price, market cap, volume and market related data on CoinGecko_

cg.get_nfts_markets()

• [Pro API] 💼 /nfts/{id}/market_chart

_Query historical market data of a NFT collection, including floor price, market cap, and 24h volume, by number of days away from now_

cg.get_nfts_market_chart_by_id()

• [Pro API] 💼 /nfts/{asset_platform_id}/contract/{contract_address}/market_chart

_Query historical market data of a NFT collection, including floor price, market cap, and 24h volume, by number of days away from now based on the provided contract address_

cg.get_ntfs_market_chart_by_asset_platform_id_and_contract_address()

• [Pro API] 💼 /nfts/{id}/tickers

_Query the latest floor price and 24h volume of a NFT collection, on each NFT marketplace, e.g. OpenSea and LooksRare_

cg.get_nfts_tickers_by_id()

[//]: # (status_updates)

[//]: # ()

[//]: # ()

[//]: # (* /status_updates (List all status_updates with data (description, category, created_at, user, user_title and pin)))

[//]: # ( ```python)

[//]: # ( cg.get_status_updates())

[//]: # ( ```)

[//]: # ()

[//]: # (events)

[//]: # ()

[//]: # ()

[//]: # (* /events (Get events, paginated by 100))

[//]: # ( ```python)

[//]: # ( cg.get_events())

[//]: # ( ```)

[//]: # (* /events/countries (Get list of event countries))

[//]: # ( ```python)

[//]: # ( cg.get_events_countries())

[//]: # ( ```)

[//]: # (* /events/types (Get list of events types))

[//]: # ( ```python)

[//]: # ( cg.get_events_types())

[//]: # ( ```)

[//]: # ()

exchange_rates

• /exchange_rates

_Get BTC-to-Currency exchange rates_

cg.get_exchange_rates()

search

• /search

_Search for coins, categories and markets on CoinGecko_

cg.search()

trending

• /search/trending

_Get trending search coins (Top-7) on CoinGecko in the last 24 hours_

cg.get_search_trending()

global

• /global

_Get cryptocurrency global data_

cg.get_global()

• /global/decentralized_finance_defi

_Get cryptocurrency global decentralized finance(defi) data_

cg.get_global_decentralized_finance_defi()

• [Pro API] 💼 /global/market_cap_chart

_Query historical global market cap and volume data by number of days away from now)_

cg.get_global_market_cap_chart()

companies (beta)

• /companies/public_treasury/{coin_id}

_Query public companies’ bitcoin or ethereum holdings_

cg.get_companies_public_treasury_by_coin_id()

Test

Installation

Install required packages for testing using:

pip install pytest responses

Usage

Run unit tests with:

# after installing pytest and responses using pip3
pytest tests

License

MIT