# Web3 Identity API Documentation - Comprehensive LLM Context # https://docs.web3identity.com/llms-full.txt # Last updated: 2026-02-09 > Complete documentation guide for the Web3 Identity API. This file provides comprehensive context for LLMs to understand and help users navigate the documentation. --- ## Site Overview **URL:** https://docs.web3identity.com **Purpose:** Official documentation for the Web3 Identity API **Built with:** Docusaurus **Total Pages:** 75+ --- ## Documentation Structure ### /docs/getting-started/ Introduction and setup guides. | Page | Path | Content | |------|------|---------| | Prerequisites | /docs/getting-started/prerequisites | What you need before starting | | Installation | /docs/getting-started/installation | SDK setup (npm, CDN) | | Quickstart | /docs/getting-started/quickstart | First API call tutorial | | First Request | /docs/getting-started/first-request | Detailed first request guide | ### /docs/auth/ Authentication methods and implementation. | Page | Path | Content | |------|------|---------| | Overview | /docs/auth/overview | Auth methods comparison | **Authentication Methods:** 1. **Anonymous Access** - No authentication required - 100 requests/day per IP - 30 requests/minute rate limit - Best for: Testing, low-volume apps 2. **SIWE (Sign-In with Ethereum)** - Sign message with wallet - 200 requests/day - 60 requests/minute - Best for: Web3 native apps 3. **API Keys** - Include `X-API-Key` header - 250 requests/day - 60 requests/minute - Best for: Server-side apps 4. **x402 Micropayments** - Pay per request with USDC on Base - Unlimited requests - 120 requests/minute - Best for: High-volume, production apps ### /docs/concepts/ Core concepts and explanations. | Page | Path | Content | |------|------|---------| | Rate Limits | /docs/concepts/rate-limits | Limits by tier, handling 429s | | x402 Payments | /docs/concepts/x402-payments | Micropayment system explained | | Errors | /docs/concepts/errors | Error codes and handling | | Versioning | /docs/concepts/versioning | API version policy | ### /docs/api/ Complete API reference by category. #### Identity Endpoints | Page | Path | Endpoints | |------|------|-----------| | ENS Resolution | /docs/api/identity/ens-resolution | resolve, reverse, avatar, records | | Text Records | /docs/api/identity/text-records | ENS text record retrieval | | Contenthash | /docs/api/identity/contenthash-resolution | IPFS/IPNS resolution | #### Price Endpoints | Page | Path | Endpoints | |------|------|-----------| | Prices | /docs/api/market/prices | price, batch, smart | #### DeFi Endpoints | Page | Path | Endpoints | |------|------|-----------| | DeFi Overview | /docs/api/defi | TVL, protocols | | TVL | /docs/api/defi/tvl | Total value locked | #### Chain Endpoints | Page | Path | Endpoints | |------|------|-----------| | Gas Prices | /docs/api/chains/gas | Ethereum gas | #### Wallet Endpoints | Page | Path | Endpoints | |------|------|-----------| | Balances | /docs/api/wallet/balances | ETH and token balances | #### Social Endpoints | Page | Path | Endpoints | |------|------|-----------| | Farcaster | /docs/api/social/farcaster | Farcaster profiles | #### Security Endpoints | Page | Path | Endpoints | |------|------|-----------| | Token Analysis | /docs/api/security/token-analysis | Token security checks | #### Utility Endpoints | Page | Path | Endpoints | |------|------|-----------| | Health | /docs/api/utilities/health | API health check | ### /docs/guides/ How-to guides and best practices. | Page | Path | Content | |------|------|---------| | Authentication | /docs/guides/authentication | Implement auth flows | | API Keys | /docs/guides/api-keys | Manage API keys | | x402 Payments | /docs/guides/x402-payments | Implement micropayments | | Rate Limits | /docs/guides/rate-limits | Handle rate limiting | | Error Handling | /docs/guides/error-handling | Error response handling | | Best Practices | /docs/guides/best-practices | Production tips | | Security | /docs/guides/security | Secure your integration | | Testing | /docs/guides/testing | Test your integration | | Troubleshooting | /docs/guides/troubleshooting | Common issues | | Supported Chains | /docs/guides/supported-chains | Multi-chain support | | Data Freshness | /docs/guides/data-freshness | Caching and TTLs | | Pagination | /docs/guides/pagination | Handle large responses | | Migration | /docs/guides/migrating-from-other-apis | Switch from other APIs | ### /docs/tutorials/ Step-by-step tutorials. | Page | Path | Content | |------|------|---------| | Price Ticker | /docs/tutorials/price-ticker | Build a live price ticker | | Wallet Tracker | /docs/tutorials/wallet-tracker | Track wallet activity | ### /docs/sdk/ SDK documentation. | Page | Path | Content | |------|------|---------| | Overview | /docs/sdk/overview | SDK introduction | | Methods | /docs/sdk/methods | Available methods | ### /docs/overview/ Product overview pages. | Page | Path | Content | |------|------|---------| | Introduction | /docs/overview/introduction | What is Web3 Identity API | | Features | /docs/overview/features | Key features | | How It Works | /docs/overview/how-it-works | Architecture overview | | Pricing | /docs/overview/pricing | Pricing tiers | ### /docs/resources/ Additional resources. | Page | Path | Content | |------|------|---------| | FAQ | /docs/resources/faq | Frequently asked questions | | Glossary | /docs/resources/glossary | Term definitions | | Examples | /docs/resources/examples | Code examples | | Postman | /docs/resources/postman | Postman collection | | Changelog | /docs/resources/changelog | Version history | | Contributing | /docs/resources/contributing | Contribute to docs | ### /docs/legal/ Legal documents. | Page | Path | Content | |------|------|---------| | Terms | /docs/legal/terms | Terms of Service | | Privacy | /docs/legal/privacy | Privacy Policy | | SLA | /docs/legal/sla | Service Level Agreement | | Support | /docs/legal/support | Support Policy | --- ## Common User Questions ### "How do I get started?" Direct to: /docs/getting-started/quickstart ```bash curl https://api.web3identity.com/api/ens/resolve/vitalik.eth ``` ### "What authentication should I use?" - Testing/Hobby: Anonymous (no auth needed) - Web3 App: SIWE (wallet signature) - Server App: API Key - Production/High Volume: x402 micropayments ### "I'm getting rate limited (429)" Direct to: /docs/guides/rate-limits - Check current tier limits - Implement exponential backoff - Consider upgrading to x402 for unlimited ### "How do I pay for API calls?" Direct to: /docs/concepts/x402-payments - x402 uses USDC on Base network - Sign EIP-712 typed data - Payment included in request header ### "What's the pricing?" Direct to: /docs/overview/pricing - Anonymous: Free (100/day) - SIWE: Free (200/day) - API Key: Free (250/day) - x402: $0.001-$0.050 per request ### "How do I resolve an ENS name?" Direct to: /docs/api/identity/ens-resolution ```bash curl https://api.web3identity.com/api/ens/resolve/{name} ``` ### "How do I get token prices?" Direct to: /docs/api/market/prices ```bash curl https://api.web3identity.com/api/price/ethereum ``` ### "What chains are supported?" Direct to: /docs/guides/supported-chains - Ethereum, Arbitrum, Optimism, Base, Polygon - Avalanche, BSC, Fantom, Gnosis - Linea, Scroll, zkSync, Mantle, Blast - Solana, Sui, Aptos, Near, Cosmos --- ## API Quick Reference ### Base URL ``` https://api.web3identity.com ``` ### Headers ``` X-API-Key: your-api-key # For API key auth Authorization: Bearer # For SIWE auth X-Payment: # For x402 payments ``` ### Response Format ```json { "data": { ... }, "source": "provider-name", "cached": true, "timestamp": "2026-02-09T00:00:00.000Z" } ``` ### Error Format ```json { "error": true, "code": "ERROR_CODE", "message": "Description", "timestamp": "2026-02-09T00:00:00.000Z" } ``` --- ## Search Tips Users searching for: - "ENS" → /docs/api/identity/ens-resolution - "price" → /docs/api/market/prices - "auth" → /docs/auth/overview - "rate limit" → /docs/concepts/rate-limits - "error" → /docs/concepts/errors - "x402" → /docs/concepts/x402-payments - "wallet" → /docs/api/wallet/balances - "DeFi" → /docs/api/defi - "gas" → /docs/api/chains/gas --- ## Related Resources - **Main Site:** https://web3identity.com - **API Base:** https://api.web3identity.com - **OpenAPI:** https://api.web3identity.com/openapi.json - **Swagger UI:** https://api.web3identity.com/api - **Status:** https://status.web3identity.com - **Support:** support@web3identity.com - **Twitter:** @ATV_eth --- *This documentation helps developers integrate the Web3 Identity API. For the API itself, see https://web3identity.com/llms-full.txt*