You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: packages/plugin-coingecko/README.md
+60-11
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,9 @@ A plugin for fetching cryptocurrency price data from the CoinGecko API.
4
4
5
5
## Overview
6
6
7
-
The Plugin CoinGecko provides a simple interface to get real-time cryptocurrency prices. It integrates with CoinGecko's API to fetch current prices for various cryptocurrencies in different fiat currencies.
7
+
The Plugin CoinGecko provides a simple interface to get real-time cryptocurrency data. It integrates with CoinGecko's API to fetch current prices, market data, trending coins, and top gainers/losers for various cryptocurrencies in different fiat currencies.
8
+
9
+
This plugin uses the [CoinGecko Pro API](https://docs.coingecko.com/reference/introduction). Please refer to their documentation for detailed information about rate limits, available endpoints, and response formats.
8
10
9
11
## Installation
10
12
@@ -18,7 +20,8 @@ Set up your environment with the required CoinGecko API key:
18
20
19
21
| Variable Name | Description |
20
22
| ------------------- | ---------------------- |
21
-
|`COINGECKO_API_KEY`| Your CoinGecko API key |
23
+
|`COINGECKO_API_KEY`| Your CoinGecko Pro API key |
24
+
|`COINGECKO_PRO_API_KEY`| Your CoinGecko Pro API key |
22
25
23
26
## Usage
24
27
@@ -27,23 +30,69 @@ import { coingeckoPlugin } from "@elizaos/plugin-coingecko";
27
30
28
31
// Initialize the plugin
29
32
const plugin =coingeckoPlugin;
30
-
31
-
// The plugin provides the GET_PRICE action which can be used to fetch prices
32
-
// Supported coins: BTC, ETH, USDC, and more
33
33
```
34
34
35
35
## Actions
36
36
37
37
### GET_PRICE
38
38
39
-
Fetches the current price of a cryptocurrency.
39
+
Fetches the current price and market data for one or more cryptocurrencies.
40
40
41
-
Examples:
41
+
Features:
42
+
- Multiple currency support (e.g., USD, EUR, JPY)
43
+
- Optional market cap data
44
+
- Optional 24h volume data
45
+
- Optional 24h price change data
46
+
- Optional last update timestamp
42
47
48
+
Examples:
43
49
- "What's the current price of Bitcoin?"
44
-
- "Check ETH price in EUR"
45
-
- "What's USDC worth?"
50
+
- "Check ETH price in EUR with market cap"
51
+
- "Show me BTC and ETH prices in USD and EUR"
52
+
- "What's USDC worth with 24h volume and price change?"
53
+
54
+
### GET_TRENDING
55
+
56
+
Fetches the current trending cryptocurrencies on CoinGecko.
46
57
47
-
## License
58
+
Features:
59
+
- Includes trending coins with market data
60
+
- Optional NFT inclusion
61
+
- Optional category inclusion
48
62
49
-
MIT
63
+
Examples:
64
+
- "What's trending in crypto?"
65
+
- "Show me trending coins only"
66
+
- "What are the hot cryptocurrencies right now?"
67
+
68
+
### GET_TOP_GAINERS_LOSERS
69
+
70
+
Fetches the top gaining and losing cryptocurrencies by price change.
71
+
72
+
Features:
73
+
- Customizable time range (1h, 24h, 7d, 14d, 30d, 60d, 1y)
74
+
- Configurable number of top coins to include
75
+
- Multiple currency support
76
+
- Market cap ranking included
77
+
78
+
Examples:
79
+
- "Show me the biggest gainers and losers today"
80
+
- "What are the top movers in EUR for the past week?"
0 commit comments