clanker-sdk 1.5.0 → 1.7.0

package/README.md

@@ -24,11 +24,14 @@ Create a `.env` file in your project root:
 # Clanker API Key (required for token operations)
 CLANKER_API_KEY=your_api_key_here
 
-# Dune Analytics API Key (required for market data)
+# Dune Analytics API Key (optional)
 DUNE_API_KEY=your_dune_api_key_here
 
-# The Graph API Key (optional, for Uniswap data)
+# The Graph API Key (optional)
 GRAPH_API_KEY=your_graph_api_key_here
+
+# CoinGecko Pro API Key (optional)
+COINGECKO_API_KEY=your_coingecko_api_key_here
 ```
 
 Copy the `.env.example` file to get started:
@@ -41,7 +44,10 @@ Make sure to add your API keys to the `.env` file and never commit it to version
 
 ### 3. Getting Your API Keys
 
-#### Dune Analytics API Key
+#### Clanker API Key
+Contact `btayengco` on Telegram or Warpcast to request access.
+
+#### Dune Analytics API Key (Optional)
 To access market data features:
 1. Visit [dune.xyz](https://dune.xyz) and sign up for an account
 2. Go to your [API Keys page](https://dune.com/settings/api)
@@ -57,6 +63,15 @@ To access Uniswap data:
 3. Create an API key
 4. Add the key to your `.env` file as `GRAPH_API_KEY`
 
+#### CoinGecko Pro API Key (Optional)
+To access CoinGecko's comprehensive market data:
+1. Visit [CoinGecko](https://www.coingecko.com) and create an account
+2. Go to your [Developer Dashboard](https://www.coingecko.com/en/api/pricing)
+3. Choose a subscription plan and create an API key
+4. Add the key to your `.env` file as `COINGECKO_API_KEY`
+
+For detailed instructions on setting up your CoinGecko API key, visit their [official documentation](https://docs.coingecko.com/reference/setting-up-your-api-key).
+
 ### 4. Basic Usage
 
 ```typescript
@@ -66,25 +81,55 @@ import { ClankerSDK, MarketDataClient } from 'clanker-sdk';
 // Load environment variables
 dotenv.config();
 
-// Initialize SDK for token operations
-const clanker = new ClankerSDK(process.env.CLANKER_API_KEY);
-
-// Initialize market data client with both Dune and Graph API keys
+// Initialize market data client (CoinGecko API key required for token prices)
 const marketData = new MarketDataClient(
-  process.env.DUNE_API_KEY,
-  process.env.GRAPH_API_KEY
+  process.env.DUNE_API_KEY,      // Optional: For Dune Analytics data
+  process.env.GRAPH_API_KEY,     // Optional: For Uniswap data
+  process.env.COINGECKO_API_KEY  // Required for token price lookups
 );
 
+// Example 1: Get price for your token on Base/Ethereum
+const tokenAddress = '0x1234567890123456789012345678901234567890'; // Your token address
+
+// Direct CoinGecko API usage
+const url = 'https://pro-api.coingecko.com/api/v3/simple/token_price/id';
+const options = {
+  method: 'GET',
+  headers: {
+    'accept': 'application/json',
+    'x-cg-pro-api-key': process.env.COINGECKO_API_KEY
+  }
+};
+
+// You can use the API directly
+fetch(url, options)
+  .then(res => res.json())
+  .then(json => console.log('Token price:', json))
+  .catch(err => console.error('Error:', err));
+
+// Or use our SDK wrapper for easier handling
+const tokenPrices = await marketData.getGeckoTokenPrice({
+  'ethereum': [tokenAddress]  // For tokens on Base/Ethereum
+});
+console.log('Token prices:', tokenPrices);
+
+// Example 2: Other SDK features (optional)
+const clanker = new ClankerSDK(process.env.CLANKER_API_KEY);
+
 // Deploy a token
 const token = await clanker.deployToken({
   name: "Community Token",
   symbol: "CMTY",
   image: "https://example.com/token.png",
-  requestorAddress: "0x1234567890123456789012345678901234567890", // Address receiving 40% creator rewards
+  requestorAddress: "0x1234567890123456789012345678901234567890"
 });
 
-// Get market data for your tokens
-const marketStats = await marketData.getClankerDictionary();
+// Get additional market data
+const additionalData = await Promise.all([
+  marketData.getClankerDictionary(),
+  marketData.getDexPairStats('ethereum', token.contractAddress),
+  marketData.getUniswapData([token.contractAddress])
+]);
 ```
 
 ## Features
@@ -100,6 +145,39 @@ const marketStats = await marketData.getClankerDictionary();
 
 The SDK provides access to comprehensive market data through multiple sources:
 
+### CoinGecko Market Data
+Get token prices by contract address on Base/Ethereum:
+
+```typescript
+// Example 1: Get price for your token (RECOMMENDED)
+const tokenAddress = '0x1234567890123456789012345678901234567890'; // Your token address
+
+// The SDK uses this CoinGecko endpoint under the hood:
+// GET https://pro-api.coingecko.com/api/v3/simple/token_price/id
+// You can also use it directly:
+const url = 'https://pro-api.coingecko.com/api/v3/simple/token_price/id';
+const options = {
+  method: 'GET',
+  headers: {
+    'accept': 'application/json',
+    'x-cg-pro-api-key': process.env.COINGECKO_API_KEY
+  }
+};
+
+// Direct API usage
+fetch(url, options)
+  .then(res => res.json())
+  .then(json => console.log(json))
+  .catch(err => console.error(err));
+
+// Or use our SDK wrapper (handles authentication and error handling)
+const tokenPrices = await marketData.getGeckoTokenPrice({
+  'ethereum': [tokenAddress]  // For tokens on Base/Ethereum
+});
+```
+
+This endpoint is specifically designed for getting token prices on Base/Ethereum. For other data sources or chains, see below.
+
 ### Clanker Dictionary
 Get detailed information about all Clanker tokens:
 ```typescript

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "clanker-sdk",
-  "version": "1.5.0",
+  "version": "1.7.0",
   "description": "A lightweight TypeScript SDK for interacting with the Clanker API",
   "main": "dist/index.js",
   "module": "dist/index.mjs",