Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.txshield.xyz/llms.txt

Use this file to discover all available pages before exploring further.

​
Before You Start

You need an API key. Head to txshield.xyz/ApiRef, connect your wallet, and generate one free — takes 30 seconds. 
Authorization: Bearer txs_your_api_key_here
Base URL: https://api.txshield.xyz
All analysis endpoints: POST with JSON body
Required payload for all EVM endpoints: { targetContractAddress, chainId }

​
Your First Request — EVM Token Analysis

This single call runs simulation + bytecode analysis + transaction history in one shot. 
curl -X POST https://api.txshield.xyz/api/simulate/execute-simulation \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer txs_your_api_key_here" \
  -d '{
    "targetContractAddress": "0x3e391e5cb8ea766c93134faf486e6393158032c2",
    "chainId": 1
  }'
What you get back: 
{
  "success": true,
  "checks": {
    "simulateResult": {
      "success": true,
      "ethDelta": "0",
      "tokenDelta": "-856779799660784235",
      "isProfit": true,
      "estimatedTax": "0",
      "gasUsed": "185464",
      "isReentrancy": false,
      "isHoneypot": false
    },
    "byteCodeResult": {
      "isContract": true,
      "trustStatus": "Critical Risk",
      "humanWarning": "EXTREME DANGER: This contract contains a kill-switch or severely malicious logic.",
      "riskFlags": [
        {
          "threatLevel": "HIGH",
          "title": "Kill Switch Detected",
          "description": "The creator can delete this token at any time, instantly wiping its value."
        },
        {
          "threatLevel": "HIGH",
          "title": "Hidden Logic (Proxy)",
          "description": "The contract can execute code from other hidden contracts."
        }
      ]
    },
    "transactionHistoryResult": {
      "success": true,
      "activityPulse": "Dead / No Activity",
      "message": "No recent token transfers found.",
      "recentTransfers": []
    }
  }
}
Even though simulateResult.success is true here, the byteCodeResult flags a Kill Switch and Hidden Logic. Always check all three result objects — a token can simulate cleanly but still be malicious.

​
Honeypot Check

curl -X POST https://api.txshield.xyz/api/honeypot/honeypot-checks \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer txs_your_api_key_here" \
  -d '{
    "targetContractAddress": "0x3e391e5cb8ea766c93134faf486e6393158032c2",
    "chainId": 1
  }'

{
  "success": true,
  "honeypotResponse": {
    "riskScore": 0,
    "buyTax": 0,
    "sellTax": 0,
    "isTimeHoneypot": false,
    "timeTravelResults": [
      { "label": "Immediate", "buyTax": 0, "sellTax": 0, "riskScore": 0 },
      { "label": "24 Hours",  "buyTax": 0, "sellTax": 0, "riskScore": 0 },
      { "label": "7 Days",    "buyTax": 0, "sellTax": 0, "riskScore": 0 }
    ]
  }
}
timeTravelResults simulates the token’s behavior across three future time windows. A token with 0% tax now may show 99% sell tax at “7 Days” — that’s a time-delayed honeypot.

​
Supported Chain IDs

ChainchainId
Ethereum1
BNB Smart Chain56
Base8453
Arbitrum42161
Solana"SOL"

​
Response Structure — Every Endpoint

{
  "success": true | false,
  "errorReason": "only present if success is false",
  "...": "endpoint-specific result data"
}
Always check success first. If false, read errorReason for the exact failure.

​
Rate Limits

Endpoint TypeLimit
/api/simulate, /api/honeypot, /api/phishing10 req / min
All other endpoints30 req / min
Exceeded your limit? You’ll receive a 429 response. Contact us for a partner tier key with higher limits.

Authentication

How API key auth works and how to pass your key correctly.

EVM Simulation

Full simulation endpoint reference with all response fields explained.

Honeypot Detection

Complete honeypot endpoint docs with time-travel analysis explained.

Phishing Detection

Complete Phishing endpoint docs with Allowance drain, permit abuse, and ETH forwarding checks.

Error Reference

All error codes and what they mean.