x402 Payment Protocol

Use the npx awal@latest x402 commands to discover, inspect, and call paid API endpoints using the X402 payment protocol. Payments are made in USDC on Base.

Workflow

The typical x402 workflow is:

1. Find a service - Search the bazaar or get details for a known endpoint
2. Check requirements - Inspect price, method, and input schema
3. Make the request - Call the endpoint with automatic USDC payment

Commands

Search the Bazaar

Find paid services by keyword using BM25 relevance search:

bash
1npx awal@latest x402 bazaar search <query> [-k <n>] [--force-refresh] [--json]

Results are cached locally at ~/.config/awal/bazaar/ and auto-refresh after 12 hours.

List Bazaar Resources

Browse all available resources:

bash
1awal x402 bazaar list [--network <network>] [--full] [--json]

Discover Payment Requirements

Inspect an endpoint's x402 payment requirements without paying:

bash
1awal x402 details <url> [--json]

Auto-detects the correct HTTP method (GET, POST, PUT, DELETE, PATCH) by trying each until it gets a 402 response, then displays price, accepted payment schemes, network, and input/output schemas.

Make a Paid Request

Call an x402 endpoint with automatic USDC payment:

bash
1awal x402 pay <url> [-X <method>] [-d <json>] [-q <params>] [-h <json>] [--max-amount <n>] [--json]

Examples

bash
1# Search for weather-related paid APIs
2awal x402 bazaar search "weather"
3
4# Search with more results
5awal x402 bazaar search "sentiment analysis" -k 10
6
7# Check what an endpoint costs
8awal x402 details https://example.com/api/weather
9
10# Make a GET request (auto-pays)
11awal x402 pay https://example.com/api/weather
12
13# Make a POST request with body
14awal x402 pay https://example.com/api/sentiment -X POST -d '{"text": "I love this product"}'
15
16# Limit max payment to $0.10
17awal x402 pay https://example.com/api/data --max-amount 100000
18
19# Browse all bazaar resources with full details
20awal x402 bazaar list --full

USDC Amounts

X402 uses USDC atomic units (6 decimals):

Prerequisites

• Search/Details: No authentication needed
• Pay: Must be authenticated (awal auth login <email>) with sufficient USDC balance (awal balance)

Error Handling

• "Not authenticated" - Run awal auth login <email> first
• "No X402 payment requirements found" - URL may not be an x402 endpoint
• "CDP API returned 429" - Rate limited; cached data will be used if available
• "Insufficient balance" - Fund wallet with USDC (awal balance to check)