Skip to main content

Frequently Asked Questions

Quick answers to common questions about the Web3 Identity API.


Generalโ€‹

What is the Web3 Identity API?โ€‹

The Web3 Identity API provides 966 endpoints for ENS, Farcaster, DeFi, token prices, and more โ€” all without API keys. It's designed for developers who want to add web3 identity features without managing authentication credentials.

Key features:

  • No signup, no API keys
  • 100 free calls per day
  • Pay-per-use after free tier (x402 protocol)
  • Single API for ENS + Farcaster + DeFi + prices

What is x402?โ€‹

x402 is a protocol for pay-per-request API payments using cryptocurrency. It's named after the HTTP 402 "Payment Required" status code.

How it works:

  1. You make a request
  2. If you've exceeded the free tier, API returns 402 Payment Required
  3. You sign a USDC transfer authorization
  4. Retry the request with the payment header
  5. API settles the payment and returns data

Why x402?

  • No monthly subscriptions
  • Pay only for what you use
  • Works with any wallet
  • No API key management

Learn more: x402 Payments Concept

How much does it cost?โ€‹

Endpoint TypePriceExample
ENS Resolution$0.01/api/ens/vitalik.eth
Token Prices$0.001/api/price/ETH
Farcaster$0.01/api/farcaster/user/dwr
Batch Operations$0.02/api/ens/batch
Historical Data$0.05/api/price/history/ETH

Free tier: 100 calls/day, no payment needed.

Full pricing: Pricing Page


Free Tierโ€‹

How do I get more than 100 calls/day?โ€‹

Option 1: Sign in with Ethereum (SIWE)

  • Authenticate with your wallet
  • Get 200 calls/day (2x the anonymous limit)
  • No cost, just a signature
import { ATVClient } from '@atv-eth/x402-sdk';

const client = new ATVClient({ privateKey: process.env.WALLET_KEY });
await client.signIn();
// Now you have 200 free calls/day

Option 2: Pay per request

  • After free tier, pay with USDC on Base
  • Prices start at $0.001 per call
  • No subscription needed

Option 3: Enterprise plan

How do I check my usage?โ€‹

curl https://api.web3identity.com/api/usage

Response:

{
"used": 42,
"limit": 100,
"remaining": 58,
"tier": "anonymous",
"resetsAt": "2026-02-09T00:00:00Z"
}

When does the free tier reset?โ€‹

Daily at midnight UTC. Check resetsAt in the /api/usage response.

Which endpoints are always free?โ€‹

EndpointDescription
/api/healthAPI health check
/api/usageYour usage stats
/api/sources/healthData source status
/api/gasEthereum gas prices
/docsSwagger documentation

Authenticationโ€‹

Do I need an API key?โ€‹

No! The Web3 Identity API doesn't use API keys. Authentication is optional.

Anonymous users:

  • 100 calls/day
  • IP-based rate limiting

Authenticated users (SIWE):

  • 200 calls/day
  • Wallet-based rate limiting
  • Persists across IPs

How do I authenticate?โ€‹

Sign in with Ethereum (SIWE):

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

const client = new ATVClient({
privateKey: process.env.WALLET_KEY
});

// Sign a message to prove wallet ownership
await client.signIn();

// All subsequent requests are authenticated
const profile = await client.getProfile('vitalik.eth');

Learn more: Authentication Guide

What wallet do I need for payments?โ€‹

Any wallet with USDC on Base (Chain ID 8453):

  • MetaMask
  • Rainbow
  • Coinbase Wallet
  • Any WalletConnect wallet

You need enough USDC to cover your API calls (typical: $0.001-$0.02 per call).


Chains & Networksโ€‹

What chains are supported?โ€‹

ChainIDENSPricesDeFiGas
Ethereum1โœ…โœ…โœ…โœ…
Base8453โœ…*โœ…โœ…โœ…
Arbitrum42161โ€”โœ…โœ…โœ…
Optimism10โ€”โœ…โœ…โœ…
Polygon137โ€”โœ…โœ…โœ…

*Base names (name.base.eth) supported

Do you support testnets?โ€‹

Not currently. We focus on production data for mainnet chains. For testing, use the free tier on mainnet with minimal real data.

What about Solana?โ€‹

Not yet, but it's on our roadmap. The API currently focuses on EVM chains.


Technicalโ€‹

What's the base URL?โ€‹

https://api.web3identity.com

All endpoints are relative to this base.

Is there a rate limit?โ€‹

TierLimitPeriod
Anonymous100 callsPer day
SIWE Authenticated200 callsPer day
Paid (no limit)โ€”Pay per call

Rate limit headers are included in every response:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 58
X-RateLimit-Reset: 2026-02-09T00:00:00Z

Is there an SDK?โ€‹

Yes! Install via npm:

npm install @atv-eth/x402-sdk viem

The SDK handles:

  • Automatic payment for 402 responses
  • SIWE authentication
  • Type-safe methods

Learn more: SDK Overview

What data formats are supported?โ€‹

Response: Always JSON (except image endpoints like QR codes)

Request: Query parameters for GET, JSON body for POST

How fresh is the data?โ€‹

Data TypeFreshness
ENS recordsReal-time (on-chain)
Token prices30 seconds
Farcaster1-5 minutes
DeFi TVL5 minutes
Gas prices12 seconds (per block)

Common Issuesโ€‹

I'm getting 402 errorsโ€‹

This means you've exceeded your free tier. Options:

  1. Wait โ€” Free tier resets at midnight UTC
  2. Authenticate โ€” SIWE gives you 200 calls/day
  3. Pay โ€” Use the SDK with a funded wallet
// SDK handles 402 automatically
const client = new ATVClient({
privateKey: process.env.WALLET_KEY // Needs USDC on Base
});

ENS name returns 404โ€‹

Possible causes:

  • Name not registered
  • Name expired
  • Typo in the name

Check the name on app.ens.domains to verify.

Prices seem wrongโ€‹

We aggregate from multiple sources. If you see discrepancies:

  1. Use /api/price/smart/{symbol} โ€” Multi-source median
  2. Check the source field โ€” Know where data comes from
  3. Report issues โ€” Email support@web3identity.com

My IP changed, lost my free tierโ€‹

Free tier is tracked by IP for anonymous users. Solutions:

  1. Authenticate with SIWE โ€” Tied to wallet, not IP
  2. Use a static IP โ€” For production deployments

API Documentationโ€‹

Where can I try endpoints?โ€‹

Swagger UI: api.web3identity.com/api

Interactive documentation where you can:

  • Browse all 966 endpoints
  • See request/response schemas
  • Test endpoints live
  • Generate code snippets

Is there a Postman collection?โ€‹

Yes! Download Postman Collection

Where's the OpenAPI spec?โ€‹

https://api.web3identity.com/api/openapi.yaml

Import into Postman, Insomnia, or any OpenAPI-compatible tool.


Supportโ€‹

How do I report a bug?โ€‹

Include:

  • Endpoint URL
  • Request parameters
  • Expected vs actual response
  • Timestamp (UTC)

Is there an SLA?โ€‹

Current uptime: 99.95%

We monitor 24/7 but don't offer formal SLAs for the public API. Enterprise customers can negotiate SLAs.

Can I get a custom plan?โ€‹

Yes! Contact support@web3identity.com for:

  • Higher rate limits
  • Dedicated infrastructure
  • Custom endpoints
  • White-label options

Still Have Questions?โ€‹