Builder Tools
Integrate ZKScore into your dApp with our comprehensive SDK, APIs, and developer tools. Build the future of on-chain reputation with 300 free credits to kickstart your journey.
Quick Start
Get started with ZKScore in minutes. Choose your integration method and start building.
Install SDK
npm install @zkscore/sdkInstall our TypeScript SDK with full type safety and comprehensive documentation.
Basic Usage
import { ZKScore } from '@zkscore/sdk';
const zkscore = new ZKScore({
apiKey: 'your-api-key',
network: 'mainnet'
});
const score = await zkscore.getScore(
'0x742d35Cc6634C0532925a3b8d4'
);Simple, intuitive API that gets you up and running in minutes.
SDK Features
Everything you need to integrate reputation scoring into your application.
Zero-Knowledge Proofs
Generate and verify ZK proofs for reputation claims without revealing sensitive data.
Multi-Chain Support
Query reputation data across Ethereum, Base, Polygon, Arbitrum, and more.
Real-time Updates
Subscribe to live reputation updates with WebSocket connections.
TypeScript First
Full type safety with comprehensive TypeScript definitions and IntelliSense.
CLI Tools
Command-line interface for testing, deployment, and reputation management.
Rich Documentation
Interactive docs with live examples, tutorials, and comprehensive API reference.
Code Examples
Ready-to-use code snippets for common use cases.
Get User Score
// Get comprehensive reputation score for a user
const userScore = await zkscore.getScore('0x742d35Cc6634C0532925a3b8d4');
console.log({
overall: userScore.overall, // 750
lending: userScore.lending, // 650
trading: userScore.trading, // 820
staking: userScore.staking, // 780
level: userScore.level, // "Gold"
percentile: userScore.percentile // 85
});Generate ZK Proof
// Generate zero-knowledge proof for reputation claim
const proof = await zkscore.generateProof({
user: '0x742d35Cc6634C0532925a3b8d4',
claim: 'score_above_500',
includePrivateData: false
});
// Verify proof without revealing actual score
const isValid = await zkscore.verifyProof(proof);
console.log('Proof valid:', isValid); // trueReal-time Updates
// Subscribe to real-time score updates
const subscription = zkscore.subscribe('0x742d35Cc6634C0532925a3b8d4', {
onScoreUpdate: (newScore) => {
console.log('Score updated:', newScore);
updateUI(newScore);
},
onAchievement: (achievement) => {
console.log('New achievement:', achievement);
showNotification(achievement);
}
});
// Unsubscribe when component unmounts
subscription.unsubscribe();Developer Resources
Everything you need to build successfully with ZKScore.
Ready to Build?
Join hundreds of developers building the future of on-chain reputation. Get started today with 300 free credits and comprehensive documentation.