Quick Start

Get up and running with SKANNR in 10 minutes

Prerequisites

Before You Start

  • Node.js 16+ installed
  • SKANNR API key
  • Basic JavaScript knowledge

What You'll Learn

  • Install and configure Skannr
  • Perform your first token scan
  • Understand scan results

1Install SKANNR SDK

First, install the Skannr SDK in your project:

Terminal
npm install @skannr/sdk

2Initialize SKANNR

Create a new file and initialize the Skannr client:

scanner.js
import { Skannr } from '@skannr/sdk'

// Initialize Skannr with your API key
const skannr = new Skannr({
apiKey: 'your-api-key-here',
network: 'ethereum' // or 'polygon', 'bsc', 'arbitrum', etc.
}

console.log('Skannr initialized successfully!')

Pro Tip

Store your API key in environment variables for security. Use process.env.SKANNR_API_KEY instead of hardcoding it.

3Perform Your First Scan

Now let's scan a token for potential security risks:

basic-scan.js
async function scanToken() {
try {
// Scan a token address
const result = await skannr.scanToken({
address: '0xA0b86a33E6441E6C8A2Dd4e5b5b6e8e8e8e8e8e8'
}

console.log('Scan Result:', result)
console.log('Is Honeypot:', result.isHoneypot)
console.log('Risk Score:', result.riskScore)

} catch (error) {
console.error('Scan failed:', error.message)
}
}

// Run the scan
scanToken()

4Understanding Scan Results

Here's what each field in the scan result means:

isHoneypot

Boolean indicating if the token has sell restrictions or other honeypot characteristics.

riskScore

Numerical score from 0-100. Higher scores indicate higher risk.

riskFactors

Array of specific risk factors detected in the token contract.

metadata

Token information including name, symbol, decimals, and total supply.

liquidity

Liquidity pool information and trading volume data.

verified

Whether the token contract has been verified on block explorers.

Example Output

Here's what a typical scan result looks like:

{
"isHoneypot": false,
"riskScore": 25,
"riskFactors": ["high_tax", "low_liquidity"],
"metadata": {
"name": "Example Token",
"symbol": "EXT",
"decimals": 18
},
"liquidity": {
"total": "$45,230",
"volume24h": "$12,450"
},
"verified": true
}

Risk Score Interpretation

Low Risk (0-30)
  • • Verified contract
  • • Good liquidity
  • • No honeypot signs
  • • Reasonable taxes
Medium Risk (31-70)
  • • Some risk factors
  • • Moderate liquidity
  • • Higher taxes
  • • Proceed with caution
High Risk (71-100)
  • • Multiple risk factors
  • • Potential honeypot
  • • Low/locked liquidity
  • • Avoid trading

What's Next?