Skip to content

docs: add CoinGeckoTools toolkit documentation #693

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AHMEDDEV2004 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add CoinGeckoTools toolkit documentation #693

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions tools/toolkits/others/coingecko.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
title: CoinGecko
---

**CoinGeckoTools** enable an Agent to access cryptocurrency market data, prices, trending coins, and more from the free CoinGecko API.

## Prerequisites

No additional dependencies are required. CoinGeckoTools uses the free CoinGecko API which does not require an API key.

## Example

The following agent will provide information about cryptocurrency prices and trending coins.

```python cookbook/14_tools/coingecko_tools.py
from agno.agent import Agent
from agno.tools.coingecko import CoinGeckoTools

agent = Agent(
tools=[CoinGeckoTools()],
description="You are a crypto market analyst that researches cryptocurrency prices, market data, and trending coins.",
instructions=["Format your response using markdown and use tables to display data where possible."],
)
agent.print_response("What is the current price of Bitcoin and Ethereum? Also show me trending coins.", markdown=True)
```

## Toolkit Params

| Parameter | Type | Default | Description |
| ------------------ | ----- | ------- | -------------------------------------------------- |
| `enable_price` | bool | True | Enable the get_coin_price function. |
| `enable_search` | bool | True | Enable the search_coins function. |
| `enable_trending` | bool | True | Enable the get_trending function. |
| `enable_market` | bool | True | Enable the get_coin_market_data function. |
| `timeout` | int | 30 | Request timeout in seconds. |

## Toolkit Functions

| Function | Description |
| --------------------- | --------------------------------------------------------------------------- |
| `get_coin_price` | Get the current price of a cryptocurrency in a specified currency (USD, EUR, etc.). |
| `search_coins` | Search for coins by name or symbol and return matching results. |
| `get_trending` | Get the top trending cryptocurrencies on CoinGecko. |
| `get_coin_market_data`| Get detailed market data for a coin including market cap, volume, and price changes. |

You can use `include_tools` or `exclude_tools` to modify the list of tools the agent has access to. Learn more about [selecting tools](/tools/selecting-tools).

## Developer Resources

- View [Tools](https://github.com/agno-agi/agno/blob/main/libs/agno/agno/tools/coingecko.py)