API Documentation

Real-time WebSocket API for monitoring USDT/USDC ban events on Tron and Ethereum networks.

v1.0wss://api.usdtbanlist.com/ws

Getting Started

Connect to the WebSocket endpoint to receive real-time ban events and query address information.

WebSocket Endpoint

wss://api.usdtbanlist.com/ws?apiKey=YOUR_API_KEY

🔑

Get your API key

Go to your Account → Profile to generate an API key, or use @USDTBanBot on Telegram.

Authentication

Include your API key in the connection URL or send an auth message after connecting.

Option 1: URL Parameter (recommended)

wss://api.usdtbanlist.com/ws?apiKey=mk_your_api_key_here

Option 2: Auth Message

{
  "type": "auth",
  "apiKey": "mk_your_api_key_here"
}

Connection Response

{
  "type": "connected",
  "clientId": "client_xxx",
  "authenticated": true,
  "tier": "free"
}

Events

Once connected and authenticated, you'll receive real-time ban events.

⚠️

Important

Real-time events are delivered only for addresses that are in your monitoring list. Add addresses to monitor via @USDTBanBot (Wallets section), the Account dashboard, or the Telegram Mini App.

Event Type	Description	Tier
`ban_submitted`	Ban pending in multisig	Premium
`ban_executed`	Address banned (confirmed)	Free
`unban_submitted`	Unban pending in multisig	Premium
`unban_executed`	Address unbanned	Free
`destroy_submitted`	Funds burn pending in multisig	Premium
`destroy_executed`	Funds burned from banned address	Free

Event Message Format

{
  "type": "event",
  "event": {
    "id": "uuid",
    "network": "trx",
    "eventType": "ban_executed",
    "address": "41...",
    "addressBase58": "T...",
    "symbol": "USDT",
    "txHash": "...",
    "blockNumber": 12345678,
    "timestamp": "2024-01-15T12:00:00Z",
    "amount": "1234.56",
    "amountRaw": "1234560000"
  }
}

JSON-RPC Methods

Send JSON-RPC 2.0 requests to query data and manage subscriptions.

ping

Check connection health

Request

{ "jsonrpc": "2.0", "id": 1, "method": "ping" }

Response

{ "jsonrpc": "2.0", "id": 1, "result": "pong" }

getStatus

Get current connection status and rate limit info

Request

{ "jsonrpc": "2.0", "id": 1, "method": "getStatus" }

Response

{
  "jsonrpc": "2.0", "id": 1,
  "result": {
    "tier": "free",
    "subscriptions": ["all"],
    "rateLimit": { "used": 5, "limit": 10, "windowMs": 60000 }
  }
}

subscribe

Subscribe to event channels

Request

{
  "jsonrpc": "2.0", "id": 1,
  "method": "subscribe",
  "params": { "channels": ["all"] }
}

Response

{ "jsonrpc": "2.0", "id": 1, "result": { "subscribed": ["all"], "total": 1 } }

unsubscribe

Unsubscribe from channels

Request

{
  "jsonrpc": "2.0", "id": 1,
  "method": "unsubscribe",
  "params": { "channels": ["eth"] }
}

Response

{ "jsonrpc": "2.0", "id": 1, "result": { "unsubscribed": ["eth"], "remaining": 1 } }

checkAddress

Check if an address is banned

Request

{
  "jsonrpc": "2.0", "id": 1,
  "method": "checkAddress",
  "params": { "address": "TLJpijVuVyjAtKRahhGTAFkpZxfpzHMtWe" }
}

Response

{
  "jsonrpc": "2.0", "id": 1,
  "result": {
    "address": "TLJpijVuVyjAtKRahhGTAFkpZxfpzHMtWe",
    "network": "trx",
    "isBanned": false,
    "usdt_status": "active",
    "usdt_balance": "0.00",
    "tag": { "type": "Exchange", "tag": "Binance" },
    "events": [{ "event_name": "Block", "volume": "1234.56", "symbol": "USDT", "status": "executed" }],
    "walletScore": { "totalScore": 45, "riskLevel": "medium" },
    "connections": { "totalConnections": 3, "categories": ["Blacklist"] }
  }
}

amlCheck$1.50

AML compliance check — risk score, fund sources, transaction analysis

Request

{
  "jsonrpc": "2.0", "id": 1,
  "method": "amlCheck",
  "params": { "address": "TGpnJAXqxmMoPQhaKcPN3jc6nDYbbiyYCz" }
}

Response

{
  "jsonrpc": "2.0", "id": 1,
  "result": {
    "address": "TGpnJAXqxmMoPQhaKcPN3jc6nDYbbiyYCz",
    "network": "tron",
    "riskScore": 75,
    "riskLevel": "high",
    "sources": {
      "byType": [{ "name": "Cross-chain protocol", "share": 85.2 }, { "name": "Exchange", "share": 14.8 }],
      "byName": [{ "name": "Swft Swap", "share": 85.2 }, { "name": "OKX", "share": 14.8 }]
    },
    "details": {
      "directTxCount": 14, "depth": 3, "totalVolume": 225046.97,
      "flags": ["risky", "has_risky_sources"], "riskySourcesCount": 9
    },
    "price": 1.50,
    "balanceAfter": 8.50
  }
}

getAddressInfo

Get detailed information about an address

Request

{
  "jsonrpc": "2.0", "id": 1,
  "method": "getAddressInfo",
  "params": { "address": "T...", "network": "trx" }
}

Response

{
  "jsonrpc": "2.0", "id": 1,
  "result": {
    "address": "T...", "network": "trx",
    "info": { "label": "Exchange", "firstSeen": "2023-01-15" },
    "cached": true
  }
}

Rate Limits

Tier	RPC Requests	Events
Free	10 / minute	Executed only
Premium	100 / minute	All events (pending + executed)

Error Codes

Errors follow JSON-RPC 2.0 format with numeric codes.

Code	Message	Description
`-32000`	Rate limit exceeded	Too many requests per minute
`-32003`	Authentication required	Missing or invalid API key
`-32010`	Insufficient balance	Not enough balance for paid method (amlCheck)
`-32600`	Invalid request	Malformed JSON-RPC request
`-32601`	Method not found	Unknown method name
`-32602`	Invalid params	Missing or invalid parameters
`-32603`	Internal error	Server-side error

Error Response Example

{
  "jsonrpc": "2.0", "id": 1,
  "error": {
    "code": -32010,
    "message": "Insufficient balance",
    "data": { "balance": 0, "price": 1.5 }
  }
}

Examples

JavaScript / Node.js

example.js

const WebSocket = require('ws');

const API_KEY = 'mk_your_api_key';
const ws = new WebSocket(`wss://api.usdtbanlist.com/ws?apiKey=${API_KEY}`);

ws.on('open', () => {
  console.log('Connected');
  // Subscribe to TRX events
  ws.send(JSON.stringify({ jsonrpc: '2.0', id: 1, method: 'subscribe', params: { channels: ['trx'] } }));
  // AML check (costs $1.50)
  ws.send(JSON.stringify({ jsonrpc: '2.0', id: 2, method: 'amlCheck', params: { address: 'T...' } }));
});

ws.on('message', (data) => {
  const msg = JSON.parse(data);
  if (msg.type === 'event') console.log('Ban event:', msg.event.eventType, msg.event.addressBase58);
  if (msg.id === 2 && msg.result) console.log('AML Risk:', msg.result.riskScore, msg.result.riskLevel);
});

Python

example.py

import json, websocket

API_KEY = 'mk_your_api_key'

def on_message(ws, message):
    msg = json.loads(message)
    if msg.get('type') == 'event':
        print(f"Ban: {msg['event']['eventType']} - {msg['event'].get('addressBase58', msg['event']['address'])}")
    if msg.get('type') == 'connected' and msg.get('authenticated'):
        ws.send(json.dumps({ 'jsonrpc': '2.0', 'id': 1, 'method': 'amlCheck', 'params': {'address': 'T...'} }))

ws = websocket.WebSocketApp(f"wss://api.usdtbanlist.com/ws?apiKey={API_KEY}", on_message=on_message)
ws.run_forever()

Need Help?

Contact Support