Quick Start

Get up and running in 2 minutes. No API keys. No signup. Just code.

Developer Tools

• Swagger UI → — Interactive API explorer with 1,634 endpoints
• Playground → — Test requests in your browser
• Postman Collection → — Import all endpoints
• OpenAPI Spec → — Generate clients in any language

---

🎯 Try It Live

Enter any ENS name or Ethereum address to see the API in action:

Try it: web3identity.com/lookup

---

Step 1: Make Your First Request

No setup required. Pick your language:

cURL

curl https://api.web3identity.com/api/ens/resolve/vitalik.eth

JavaScript (Browser)

const response = await fetch('https://api.web3identity.com/api/ens/resolve/vitalik.eth');
const data = await response.json();
console.log(data);

Python

import requests

response = requests.get('https://api.web3identity.com/api/ens/resolve/vitalik.eth')
data = response.json()
print(data)

Response

{
  "success": true,
  "data": {
    "name": "vitalik.eth",
    "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "avatar": "https://metadata.ens.domains/mainnet/avatar/vitalik.eth",
    "records": {
      "twitter": "VitalikButerin",
      "github": "vbuterin",
      "url": "https://vitalik.eth.limo"
    }
  }
}

🎉 That's it! You get 100 free calls per day — no API key needed.

---

Step 2: Explore Popular Endpoints

# 🔍 ENS Resolution
curl https://api.web3identity.com/api/ens/resolve/nick.eth

# 🔄 Reverse Lookup (address → ENS)
curl https://api.web3identity.com/api/ens/reverse/0xb8c2C29ee19D8307cb7255e1Cd9CbDE883A267d5

# 👤 Full Identity Profile (ENS + Farcaster + Lens)
curl https://api.web3identity.com/api/profile/brantly.eth

# 💰 Token Prices
curl https://api.web3identity.com/api/price/ETH
curl "https://api.web3identity.com/api/price/batch?tokens=ETH,BTC,USDC"

# ⛽ Gas Prices
curl https://api.web3identity.com/api/gas

# 📊 DeFi Data
curl https://api.web3identity.com/api/defi/tvl/aave
curl https://api.web3identity.com/api/defi/tvl/uniswap

# 📈 Check Your Usage
curl https://api.web3identity.com/api/usage

See all 1,634 endpoints →

---

Step 3: Scale with x402 Micropayments

When you exceed the free tier, the API returns a 402 Payment Required response. Your client signs a USDC payment on Base, and the request completes automatically.

How it works:

1. Make request → Free tier? ✅ Get response
2. Free tier exceeded? → API returns 402 + payment details
3. Client signs USDC payment (EIP-3009)
4. Retry request with payment header → ✅ Get response

Pricing: $0.005 - $0.05 per call depending on endpoint complexity.

---

Step 4: Install the SDK (Recommended)

The SDK handles authentication, payments, and retries automatically:

npm install @atv-eth/x402-sdk viem

import { ATVClient } from '@atv-eth/x402-sdk';

const client = new ATVClient({
  privateKey: process.env.WALLET_KEY  // Wallet with USDC on Base
});

// SDK handles: free tier → 402 → payment → retry → response
const profile = await client.getProfile('vitalik.eth');
console.log(profile);

// Batch requests
const prices = await client.getPrices(['ETH', 'BTC', 'USDC']);
console.log(prices);

---

Step 5: Authenticate for Higher Limits (Optional)

Sign in with Ethereum (SIWE) to double your free tier:

// Sign in once
await client.signIn();

// Now you get 200 free calls/day instead of 100
const usage = await client.myUsage();
console.log(`${usage.remaining}/${usage.limit} calls remaining`);

Tier	Daily Limit	How to Get
Anonymous	100 calls	Just use the API
SIWE Authenticated	200 calls	Sign in with wallet
API Key	250 calls	Generate at /admin
x402 Payments	Unlimited	Pay per call ($0.005+)

---

🤖 AI Agent Integration

Building an AI agent? Web3 Identity API is designed for autonomous agents with x402 protocol support.

Coinbase Agentic Wallets

import { AgentWallet } from '@coinbase/agentkit';
import { ATVClient } from '@atv-eth/x402-sdk';

// Create agent wallet
const wallet = await AgentWallet.create();

// Connect to Web3 Identity API
const client = new ATVClient({ 
  wallet,
  network: 'base' 
});

// Agent can now autonomously resolve identities & pay for data
const identity = await client.getProfile('user.eth');

OpenAI Function Calling

const tools = [{
  type: "function",
  function: {
    name: "resolve_ens",
    description: "Resolve an ENS name to get wallet address and profile",
    parameters: {
      type: "object",
      properties: {
        name: { type: "string", description: "ENS name like vitalik.eth" }
      },
      required: ["name"]
    }
  }
}];

// In your function handler:
async function resolve_ens({ name }) {
  const res = await fetch(`https://api.web3identity.com/api/ens/resolve/${name}`);
  return res.json();
}

---

What's Next?

Goal	Next Step
Understand the architecture	How It Works
Learn about x402 payments	x402 Protocol
Explore all endpoints	API Reference
Build an ENS profile card	Tutorial

---

Quick Reference

Resource	URL
Base URL	https://api.web3identity.com
Swagger UI	api.web3identity.com/docs
Playground	api.web3identity.com/playground
Status Page	status.web3identity.com
npm SDK	@atv-eth/x402-sdk
Health Check	/api/health

---

Need Help?

• 📧 Email: support@web3identity.com
• 🐦 Twitter: @ATV_eth
• 💬 Farcaster: @atv.eth