Quick Start

Get up and running in 2 minutes.

Developer Tools

• Swagger UI → — Interactive API explorer
• Postman Collection → — Import 966 endpoints
• OpenAPI Spec → — Generate clients

Step 1: Make a Free Request

No setup required. Just make a request:

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

Response:

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

You get 100 free calls per day.

Step 2: Try More Endpoints

# Get gas prices
curl https://api.web3identity.com/api/gas

# Get token price
curl https://api.web3identity.com/api/price/ETH

# Get DeFi protocol TVL
curl https://api.web3identity.com/api/defi/tvl/aave

# Check your usage
curl https://api.web3identity.com/api/usage

Step 3: Install the SDK (Optional)

For production use with automatic payments:

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 → response
const profile = await client.getProfile('vitalik.eth');
console.log(profile);

Step 4: Authenticate for 2x Limits (Optional)

Sign in with Ethereum to double your free tier:

await client.signIn();

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

What's Next?

Goal	Next Step
Learn the concepts	How It Works
Understand payments	x402 Protocol
Explore endpoints	API Reference
Build a project	Guides

Quick Links

• Base URL: https://api.web3identity.com
• Swagger UI: api.web3identity.com/api
• npm SDK: @atv-eth/x402-sdk
• Health: api.web3identity.com/health