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.

​
Overview

All TxShield analysis endpoints require an API key. There is no unauthenticated public access to production endpoints. Keys are free to generate, tied to your wallet address, and issued instantly — no email signup, no credit card, no waitlist.

​
Generating Your API Key

1

Go to the API Keys page

Head to txshield.xyz/ApiRef
2

Connect your wallet

Click Generate API Key. A Web3 wallet prompt will appear. Connect with MetaMask, Coinbase Wallet, or any WalletConnect-compatible wallet.
3

Sign the message

You will be asked to sign a message to prove wallet ownership. This is a free, gas-less signature — nothing is sent on-chain, no transaction is made.
4

Copy your key

Your API key is generated instantly and displayed once. Store it securely — we do not store or show it again.
Your API key is tied to your wallet address. If you lose your key, you can regenerate one by connecting the same wallet again.

​
Using Your API Key

Pass your key in the Authorization header on every request using Bearer format. 
Authorization: Bearer txs_your_api_key_here

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
  }'

​
Rate Limits

Endpoint TypeFree Tier Limit
/api/simulate, /api/honeypot, /api/phishing10 requests / minute
All other endpoints30 requests / minute
Limits are applied per API key, tracked via a 60-second rolling window.
Need higher limits for a production integration? Reach out at contactcodecommunity@gmail.com or contact us on X for a partner tier key.

​
Error Responses

​
Missing API Key — 401

{
  "success": false,
  "error": "Missing Authorization header"
}

​
Invalid API Key — 403

{
  "success": false,
  "error": "Invalid API key"
}

​
Rate Limit Exceeded — 429

{
  "success": false,
  "error": "Analysis rate limit hit. Max 10 requests per minute."
}

​
Security Best Practices

Never expose your API key in frontend code. If you are building a client-side app, proxy requests through your own backend and keep the key in an environment variable server-side. 
# .env — server side only, never commit this
TXSHIELD_API_KEY=txs_your_api_key_here
Rotate your key if compromised. Visit txshield.xyz/ApiRef, connect the same wallet, and generate a new key. The old key is invalidated immediately.

EVM Simulation

Full reference for the simulation endpoint.

Honeypot Detection

Full reference for the honeypot endpoint.