API Reference

Complete documentation for the SKANNR API

v2.1.0

Base URL & Authentication

Base URL
Production
https://api.skannr.com
Authentication
Header
Authorization: Bearer YOUR_API_KEY

Endpoints Overview

/v1/scan/token
POST
Scan a token for security risks
/v1/token/{address}
GET
Get token metadata and basic info
/v1/scan/batch
POST
Scan multiple tokens in one request
/v1/risk-factors
GET
List all available risk factors

Token Scan

POST /v1/scan/token
Core Endpoint
Scan a token address for security risks, honeypot detection, and risk assessment

Request Body

JSON
{
"address": "0x...",
"network": "ethereum",
"includeRiskScore": true,
"includeMetadata": true,
"deepAnalysis": false,
"checkLiquidity": true
}

Parameters

Required
address

Token contract address to scan

Optional
network

Blockchain network (ethereum, polygon, bsc, arbitrum)

Optional
includeRiskScore

Include numerical risk score (0-100)

Optional
deepAnalysis

Perform deep contract analysis (slower, more detailed)

Rate Limits

Free Tier

100 requests per hour

$0/month

Pro Tier

1,000 requests per hour

$29/month

Enterprise

Custom limits

Contact us

Error Handling

All API errors follow a consistent format:

{
"success": false,
"error": {
"code": "INVALID_ADDRESS",
"message": "The provided token address is invalid"
}
}

Common Error Codes

INVALID_ADDRESSToken address format is invalid
TOKEN_NOT_FOUNDToken does not exist on the specified network
RATE_LIMIT_EXCEEDEDToo many requests, please slow down
INSUFFICIENT_PERMISSIONSAPI key lacks required permissions

Official SDKs

JavaScript/TypeScript
Official SDK for web and Node.js applications
npm install @skannr/sdk
Python
Python SDK for data analysis and backend integration
pip install skannr-python