Skip to main content

Postman Collection

Import our pre-built collection to test all 966 endpoints in Postman.

Quick Import​

Option 1: Download JSON​

  1. Download the collection: Web3-Identity-API.postman_collection.json
  2. Open Postman
  3. Click Import → Upload Files
  4. Select the downloaded JSON file
  5. Start testing!

Option 2: Import from URL​

  1. Open Postman
  2. Click Import → Link
  3. Paste: https://api.web3identity.com/postman/Web3-Identity-API.postman_collection.json
  4. Click Continue → Import

What's Included​

The collection includes all 966 endpoints organized by category:

CategoryEndpointsExamples
ENS25+Resolve names, get profiles, check availability
Farcaster25+Profiles, casts, channels, followers
DeFi80+TVL, yields, protocols, stablecoins
Prices45+Token prices, market data, batch queries
Wallet20+Balances, transactions, NFTs
Security15+Risk scores, contract verification
L225+Layer 2 data, gas prices, bridges
Utilities20+Conversions, QR codes, health

Environment Setup​

Create a Postman environment with these variables:

VariableValueDescription
baseUrlhttps://api.web3identity.comAPI base URL
testAddress0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045Vitalik's address
testENSvitalik.ethTest ENS name
testFID3Farcaster ID (Dan Romero)

Example Requests​

ENS Resolution​

GET {{baseUrl}}/api/ens/resolve/{{testENS}}

Response:

{
  "name": "vitalik.eth",
  "address": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045"
}

Token Price​

GET {{baseUrl}}/api/price/ETH

Response:

{
  "symbol": "ETH",
  "price": 2847.32,
  "change24h": 2.4,
  "source": "coingecko"
}

Farcaster Profile​

GET {{baseUrl}}/api/farcaster/dwr.eth

Testing x402 Payments​

For paid endpoints (after free tier), Postman will receive a 402 Payment Required response:

{
  "status": 402,
  "message": "Payment Required",
  "paymentDetails": {
    "scheme": "x402",
    "network": "base",
    "maxAmountRequired": "1000",
    "resource": "/api/ens/vitalik.eth"
  }
}

To test paid requests, use our SDK or implement x402 payment signing.

Importing to Insomnia​

The collection also works with Insomnia:

  1. Open Insomnia
  2. Go to Application → Preferences → Data
  3. Click Import Data → From File
  4. Select the Postman collection JSON
  5. Insomnia auto-converts the format

OpenAPI Spec​

Prefer OpenAPI? Import directly:

  • YAML: https://api.web3identity.com/openapi.yaml
  • JSON: https://api.web3identity.com/openapi.json

Need Help?​