sleuth-sdk
v1.0.0
Published
Official JavaScript/TypeScript SDK for Sleuth Wallet Intelligence Platform
Downloads
86
Maintainers
Readme
Sleuth SDK for JavaScript/TypeScript
Official JavaScript/TypeScript SDK for the Sleuth Wallet Intelligence Platform.
Installation
npm install sleuth-sdk
# or
yarn add sleuth-sdk
# or
pnpm add sleuth-sdkQuick Start
import { SleuthClient } from 'sleuth-sdk';
// Initialize client
const client = new SleuthClient({ apiKey: 'your_api_key' });
// Search a wallet
const profile = await client.wallet.search('0xd8da6bf26964af9d7eed9e03e53415d37aa96045');
console.log(`30d PnL: $${profile.pnl_30d.toLocaleString()}`);
console.log(`Win Rate: ${profile.win_rate}%`);
// Get alpha signals (Premium)
const signals = await client.premium.getSignals({
signalTypes: ['whale_accumulation', 'smart_money_buy'],
minConfidence: 0.8
});
signals.forEach(signal => {
console.log(`${signal.signal_type}: ${signal.token} (${signal.strength})`);
});
// Get top traders to copy
const traders = await client.premium.getTopTraders();
traders.forEach(trader => {
console.log(`${trader.label}: ${trader.pnl_30d}`);
});Real-time Alerts (WebSocket)
import { SleuthWebSocket } from 'sleuth-sdk';
const ws = new SleuthWebSocket({ apiKey: 'your_key' });
ws.onAlert = (alert) => {
console.log(`🚨 ${alert.alert_type}:`, alert.data);
};
ws.onConnect = () => {
console.log('Connected to Sleuth alerts');
// Subscribe to specific alert types
ws.subscribe(['whale_movement', 'alpha_signal', 'rug_detected']);
};
await ws.connect();Available Features
Free Tier
- Wallet search & analysis
- Basic social intel
- Trade history
Premium Tiers
- Alpha signals API
- Wallet labels database (10M+ addresses)
- Token launch scanner
- Copy trade execution
- MEV protection
- Historical backtesting
- Social alpha (CT intelligence)
Error Handling
import { SleuthClient, AuthenticationError, RateLimitError, TrialLimitError } from 'sleuth-sdk';
try {
const profile = await client.wallet.search('0x...');
} catch (error) {
if (error instanceof AuthenticationError) {
console.log('Invalid API key');
} else if (error instanceof TrialLimitError) {
console.log('Trial limit exceeded - upgrade at:', error.upgradeUrl);
} else if (error instanceof RateLimitError) {
console.log('Rate limit hit - slow down');
}
}Documentation
Full documentation at docs.sleuth.io
License
MIT
