@jamaalbuilds/lunarcrush-api
v1.0.1
Published
TypeScript/JavaScript SDK for LunarCrush API v4 with GraphQL and MCP support for AI workflows
Downloads
39
Maintainers
Readme
🌙 LunarCrush API SDK
Get crypto data instantly. GraphQL API + MCP Integration. No setup required.
Keywords: crypto API, cryptocurrency data, bitcoin API, social sentiment, trading data, GraphQL SDK, MCP integration, AI workflows, LLM integration, TypeScript crypto library, blockchain analytics, market intelligence
npm install @jamaalbuilds/lunarcrush-apiimport LunarCrush from '@jamaalbuilds/lunarcrush-api';
const lc = new LunarCrush('your-api-key');
// Get a general snapshot of LunarCrush metrics on the entire list of tracked coins
const coinsList = await lc.coins.list();
console.log(coinsList[0]); // Bitcoin data with price & sentiment
// Get an individual coin
const bitcoin = await lc.coins.get('BTC');
console.log(`Bitcoin galaxy_score: ${bitcoin.galaxy_score}`);🚀 Get Started (30 seconds)
Step 1: Get Your API Key
Important: You need a LunarCrush subscription to get an API key.
- Sign up for LunarCrush
- Enter your email and verify it
- Complete onboarding (select categories, create profile)
- Select a subscription plan (required for API access)
- Generate your API key from the authentication page
Step 2: Install & Use
npm install @jamaalbuilds/lunarcrush-apiimport LunarCrush from '@jamaalbuilds/lunarcrush-api';
const lc = new LunarCrush('your-api-key-here');
const coinsList = await lc.coins.list();That's it! You now have live crypto data.
🔥 What You Get
// List the cryptocurrencies we track
const coinsList = await lc.coins.list();
// Retrieve coin data
const bitcoin = await lc.coins.get('BTC');
// Trending social topics
const topicsList = await lc.topics.list();
// Get stock data
const appleStock = await lc.stocks.get('aapl');💡 Copy-Paste Examples
Crypto Dashboard
const top10 = await lc.coins.list();
top10.slice(0, 10).forEach(coin => {
console.log(`${coin.symbol}: $${coin.price} (Galaxy Score: ${coin.galaxy_score}/100)`);
});Supply Tracker
//Total number of coins or tokens
//that are actively available
const coins = ['btc', 'eth', 'sol'];
for (const symbol of coins) {
const data = await lc.coins.get(symbol);
console.log(`${symbol}: ${data.circulating_supply}`);
}Next.js API Route
// pages/api/crypto.js
import LunarCrush from '@jamaalbuilds/lunarcrush-api';
const lc = new LunarCrush(process.env.LUNARCRUSH_API_KEY);
export default async function handler(req, res) {
const coinsList = await lc.coins.list();
res.json(coinsList.slice(0, 20));
}🤖 MCP (Model Context Protocol)
Real-Time Social Data for AI Workflows
Connect directly to live crypto social intelligence with clean, simple API:
import { createLunarCrushMCP } from '@jamaalbuilds/lunarcrush-api';
// Create MCP client for AI workflows
const mcp = await createLunarCrushMCP('your-api-key');
// Clean, direct API calls - no .get() or .list() needed!
const bitcoinData = await mcp.topics('bitcoin');
console.log(bitcoinData.metadata.title); // "Bitcoin (BTC)"
console.log(bitcoinData.tables.length); // 20+ parsed tables
console.log(bitcoinData.raw); // Full markdown content
// Time series data as structured TSV
const sentiment = await mcp.timeSeries('bitcoin', {
metrics: ['sentiment', 'interactions'],
interval: '1w' // '1d' | '1w' | '1m' | '3m' | '6m' | '1y' | 'all'
});
console.log(sentiment.tsv); // Array of {time, sentiment, interactions}
// Get AI cryptocurrencies ranked by social sentiment
const aiCryptos = await mcp.cryptocurrencies({
filter: 'ai',
sort: 'galaxy_score',
limit: 10
});
console.log(aiCryptos.tables); // Structured crypto data
// Social creators analysis
const creator = await mcp.creators('elonmusk', 'x');
console.log(creator.metadata.title); // Creator profile data
// Search across all topics
const search = await mcp.search('bitcoin AI trends');
console.log(search.raw); // Relevant social mentions
// Get specific post details
const post = await mcp.posts('1234567890', 'x');
console.log(post.raw); // Post analysis
// Get topic categories
const categories = await mcp.list('cryptocurrencies');
console.log(categories.tables); // Category listings
// Always close the connection
await mcp.close();GraphQL vs MCP: Choose Your Integration
| Feature | GraphQL SDK | MCP Integration | | ------------------ | --------------- | ------------------------ | | Best For | Web/mobile apps | AI assistants & LLMs | | Data Format | Structured JSON | Parsed markdown + tables | | Connection | HTTP requests | Server-sent events | | Use Case | UI components | AI data processing | | Learning Curve | Traditional API | AI-native workflows |
Dual API Usage
Both APIs use the same LunarCrush subscription:
// Use both approaches with one API key
const graphqlClient = createLunarCrush('your-api-key');
const mcp = await createLunarCrushMCP('your-api-key');
// GraphQL: Perfect for app UIs
const appData = await graphqlClient.coins.list({ limit: 10 });
// MCP: Perfect for AI analysis with clean API
const aiData = await mcp.cryptocurrencies({
filter: 'ai',
sort: 'galaxy_score',
limit: 5
});
// MCP provides richer, AI-friendly formats
console.log(aiData.tables); // Structured tables
console.log(aiData.metadata); // Extracted metadata
console.log(aiData.tsv); // Time series dataComplete MCP API Reference
🎯 All 11 LunarCrush MCP Tools - Clean & Simple:
// Topic analysis
await mcp.topics('bitcoin') // Full topic details with tables
await mcp.timeSeries('bitcoin', opts) // Historical data as TSV
await mcp.topicPosts('bitcoin', opts) // Popular posts for topic
// Market data
await mcp.cryptocurrencies(opts) // Sorted crypto lists with filters
await mcp.stocks(opts) // Stock social sentiment data
await mcp.list('cryptocurrencies') // Topic categories
// Social intelligence
await mcp.creators('elonmusk', 'x') // Influencer analysis
await mcp.posts('1234567890', 'x') // Specific post details
await mcp.search('AI crypto') // Universal social search
// Direct access
await mcp.fetch('/topic/bitcoin') // Direct API path access📋 Complete Parameter Reference
🪙 Cryptocurrency Filters (mcp.cryptocurrencies({ filter: "..." }))
Popular Categories:
'ai'- AI & Machine Learning tokens'defi'- Decentralized Finance'meme'- Meme coins (DOGE, SHIB, etc.)'gaming'- Gaming & Metaverse tokens'layer-1'- Layer 1 blockchains (ETH, SOL, etc.)'layer-2'- Layer 2 scaling solutions
All 40+ Available Filters:
'stablecoin', 'nft', 'dot', 'bsc', 'algorand', 'dao', 'wallets', 'lending-borrowing', 'liquid-staking-tokens', 'brc20', 'exchange-tokens', 'real-world-assets', 'depin', 'fan', 'gambling', 'runes', 'desci', 'sports', 'socialfi', 'analytics', 'events', 'real-estate', 'bitcoin-ecosystem', 'stacks-ecosystem', 'base-ecosystem', 'solana-ecosystem', 'ai-agents', 'defai', 'zk', 'oracle', 'storage', 'made-in-usa', 'sui', 'inj', 'cardano', 'pow', 'pos', 'music', 'insurance', 'privacy', 'energy', 'pump-fun', 'prediction', 'entertainment', 'healthcare', 'btcfi', 'interoperability', 'move-to-earn'
📈 Stock Sectors (mcp.stocks({ sector: "..." }))
Popular Sectors:
'technology'- Tech companies (AAPL, MSFT, etc.)'healthcare'- Healthcare & biotech'energy'- Energy companies'financial-services'- Banks & financial services
All Available Sectors:
'basic-materials', 'communication-services', 'consumer-cyclical', 'consumer-defensive', 'industrials', 'real-estate', 'utilities', 'banks', 'etf', 'bitcoin-spot-etf', 'bitcoin-futures-etf', 'ethereum-spot-etf', 'bitcoin-treasuries', 'crypto-etfs'
📊 Sort Options (for both crypto & stocks)
Popular Sorts:
'galaxy_score'- LunarCrush's proprietary social score'market_cap'- Market capitalization'sentiment'- Social sentiment (0-100)'interactions'- Total social engagements
All Sort Options:
'alt_rank' (AltRank™), 'close' (Price), 'percent_change_1h', 'percent_change_24h', 'percent_change_7d', 'posts_active' (Mentions), 'contributors_active' (Creators), 'social_dominance', 'market_dominance', 'volume_24h' (Trading Volume), 'circulating_supply', 'topic_rank' (TopicRank™)
⏰ Time Intervals (mcp.timeSeries('bitcoin', { interval: "..." }))
'1d'- Last 24 hours (hourly data)'1w'- Last week (hourly data)'1m'- Last month (daily data)'3m'- Last 3 months (daily data)'6m'- Last 6 months (daily data)'1y'- Last year (daily data)'all'- All available history
📊 Time Series Metrics (mcp.timeSeries('topic', { metrics: [...] }))
Popular Metrics:
'sentiment'- Social sentiment score'interactions'- Total social engagements'social_dominance'- Share of total crypto discussion'galaxy_score'- LunarCrush proprietary score
All Available Metrics:
'alt_rank', 'close', 'percent_change_1h', 'percent_change_24h', 'percent_change_7d', 'interactions_24h', 'posts_active', 'contributors_active', 'market_cap', 'market_dominance', 'volume', 'volume_24h', 'circulating_supply', 'topic_rank'
💡 Practical Examples
// Get top 10 AI cryptocurrencies by social sentiment
const aiCryptos = await mcp.cryptocurrencies({
filter: 'ai',
sort: 'galaxy_score',
limit: 10
});
// Get Tesla stock data with technology sector context
const techStocks = await mcp.stocks({
sector: 'technology',
sort: 'market_cap',
limit: 5
});
// Get Bitcoin sentiment over the last week
const btcSentiment = await mcp.timeSeries('bitcoin', {
metrics: ['sentiment', 'interactions', 'social_dominance'],
interval: '1w'
});
// Get popular Bitcoin posts from the last day
const recentPosts = await mcp.topicPosts('bitcoin', {
interval: '1d'
});All responses include:
raw- Complete markdown content for AI processingtables- Parsed table data as structured objectstsv- Time series data as structured arraysmetadata- Extracted titles, images, and context
Why MCP is Perfect for AI
✅ Direct Integration - No API parsing needed ✅ Rich Context - Markdown with tables, images, links ✅ Structured Data - Pre-parsed tables and time series ✅ Real-time - Live social intelligence via SSE ✅ AI-Optimized - Designed for LLM consumption
🆘 Need Help?
Can't get data?
- Check your API key: Make sure you have a LunarCrush subscription and valid API key
- Test it live: Try in browser to verify queries work
- Copy working examples: Use the code samples above as starting points
Want more data?
- Test queries: Interactive playground
- Review our docs: Browse here
🎯 Works Everywhere
✅ Node.js ✅ React ✅ Next.js ✅ Vite ✅ Browser ✅ TypeScript ✅ AI/MCP Integration ✅ And More
📞 Support
- FAQ: LunarCrush Support
- SDK Questions: GitHub Issues
- Test Your Setup: Live Playground
- Docs: LunarCrush GraphQL Docs
- Community: GitHub Discussions
🏷️ Keywords & Tags
For LLM Discovery: crypto-api, cryptocurrency-data, bitcoin-api, ethereum-api, social-sentiment, trading-api, blockchain-data, crypto-intelligence, typescript-sdk, graphql-client, @jamaalbuilds/lunarcrush-api, crypto-trading, market-data, social-analytics, mcp-integration, ai-workflows, model-context-protocol
Ready to build? Subscribe to LunarCrush and copy the examples above! 🚀
