Installation

Get SKANNR up and running in your project

Quick Install

Terminal

npm install @skannr/sdk

Installation Options

JavaScript SDK

For web applications and Node.js backends

import { Skannr } from '@skannr/sdk'

const skannr = new Skannr('your-api-key')

Recommended

Browser Extension

For real-time protection while browsing

Install the SKANNR browser extension for automatic token scanning on DeFi platforms.

Requirements

JavaScript/TypeScript

Node.js 16.0.0 or higher
TypeScript 4.5+ (optional)
Modern browser (ES2020+)

Browser Extension

Chrome 88+ or Firefox 85+
Web3 wallet (MetaMask, etc.)
Active internet connection

API Key Setup

1. Get Your API Key

2. Environment Variables

Store your API key securely using environment variables:

.env

SKANNR_API_KEY=your_api_key_here

3. Initialize the SDK

app.js

import { Skannr } from '@skannr/sdk'

const skannr = new Skannr({
  apiKey: process.env.SKANNR_API_KEY,
  network: 'ethereum' // or 'polygon', 'bsc', etc.
}

Verify Installation

Test your installation with a simple token scan:

test.js

import { Skannr } from '@skannr/sdk'

const skannr = new Skannr({
  apiKey: process.env.SKANNR_API_KEY,
  network: 'ethereum'
}

async function testScan() {
  try {
    const result = await skannr.scanToken({
      address: '0xA0b86a33E6441E6C8A2Dd4e5b5b6e8e8e8e8e8e8',
      includeRiskScore: true
    }
    console.log('Scan successful!', result)
  } catch (error) {
    console.error('Scan failed:', error)
  }

testScan()

Troubleshooting

Common Issues

API Key Invalid

Make sure your API key is correct and has the necessary permissions. Check the dashboard for key status.

Network Errors

Ensure your application can make HTTPS requests to api.skannr.com. Check firewall and proxy settings.

Rate Limiting

If you're hitting rate limits, consider upgrading your plan or implementing request queuing.

Next Steps

Quick Start Guide

Learn how to perform your first token scan with SKANNR

API Reference

Explore all available endpoints and methods for SKANNR