Publish your API · xpayapi.com

Set your network, where the proxy runs, your API, prices, and wallet. The install command updates as you go — copy it when every step is done.

Takes about 5 minutes.

1. Where will the proxy run?

For a public server with Caddy, create a DNS A/AAAA record pointing your domain to this server's public IP before launch.
For a server without public inbound access, use Cloudflare Tunnel. Quick tunnel is good for testing; named tunnel is better for a stable hostname.
For an existing reverse proxy, run the proxy as a local service and point your own Caddy/Nginx/ingress at it.
curl, git, Docker Compose, and outbound internet access. The installer can add Docker when it is missing.

Local Service Run only on a local/private address. Use this if you already have your own reverse proxy or networking.

Public Service With Caddy ? Use this when this server has a public IP address and you have a domain/subdomain available.

Public Service With Cloudflare Tunnel Use this when this server has no public IP address, you do not want inbound ports, or you want a temporary public URL for testing.

Public domain callers will use

Use the domain that your existing reverse proxy will route to this local service. The generated command sets PUBLIC_BASE_URL from it.

Enter only the domain name, without http:// or https://. Examples: api.example.com, crypto-api.example.com. Do not include paths such as /v1 or /api.

2. Your API address

Enter an upstream address this server can reach, such as localhost:8000, a LAN IP, or a private DNS name. Choose http:// or https:// below.

Does your API need a key to call it?

Fetch openapi.json from a URL the proxy container can reach.

OpenAPI document URL

Point at a file or folder on the install host. The installer copies openapi.json or swagger.json into the proxy data volume.

File or folder on your server Example: /opt/my-api/openapi.json or a directory that contains openapi.json.

Per-route prices can't auto-import from a local path in your browser. To price individual routes below, upload the same openapi.json, paste its JSON, or add rows by hand.

3. Set your prices

These values are added to the generated command. You can still edit them on your server later.

Default price per request

When OpenAPI is loaded from a URL, routes import automatically. Otherwise upload a file, paste JSON, or add rows manually.

Upload openapi.json Paste OpenAPI JSON

Use	Method	Path	Price	Summary	Remove

Preview ROUTE_PRICES value

4. Set your settlement wallet

Payments settle on-chain to this address. The install command stays locked until you replace the placeholder with your own wallet.

Network

Start on testnet with free funds. Switch to mainnet only when you are ready to take real payments.

Tempo testnet Use pathUSD on Tempo Moderato for testing before real funds. Tempo mainnet Use USDC on Tempo mainnet when you are ready for production payments.

Wallet address to receive payment

Checking balance... Tempo testnet

curl -X POST https://api.xpayapi.com/api/faucets/tempo-moderato/fund \
  -H "Content-Type: application/json" \
  -d '{"address": "<YOUR_ADDRESS>"}'

Advanced — change the stablecoin token (most operators keep the default)

Stablecoin contract address pathUSD

5. List on the xpayapi directory? List this API on xpayapi.com When your domain is reachable, the proxy submits your public URL, pricing, and OpenAPI metadata so callers can discover you. Uncheck to keep the API private.

6. Run this on your server

This command is enough to install the proxy, apply your choices, and start it with Docker Compose.

# Set your wallet address above to generate the install command.

Your choices above are baked into the command. After it finishes, the proxy is running and (if you opted in) listed on xpayapi.com.

7. Confirm it works

Once the proxy is running, check it answers and that paid routes ask for payment.

# Health check — replace with your domain
curl https://crypto-api.example.com/health

# A paid route returns 402 Payment Required until payment is attached
curl -i https://crypto-api.example.com/openapi.json

To make a real paid call, point a wallet-enabled client (mppx/client, tempo request, or AgentCash) at the same route — it pays the quote and retries automatically.

Clone the proxy, edit config by hand, then start it yourself. Use this when you want full control over every file.

Install the open-source proxy

Clone the proxy repository and run the setup wizard yourself.

Loading...

Set wallet, routes, prices, and directory credentials

Edit the JSONC config for API routes and pricing. The proxy handles 402 challenges, payment verification, forwarding, and receipts.

Loading...

Put secrets, PUBLIC_BASE_URL, and xpayapi auto-publish credentials in .env:

Loading...

Start the proxy and auto-publish

When the proxy starts, it submits its public URL to xpayapi.com. xpayapi.com checks /health, reads endpoint metadata, pricing, examples, and schemas from /openapi.json, then generates the API profile and docs page. Callers can use mppx/client, tempo request, AgentCash, or raw cURL.

Keep your stack	Put the open-source proxy in front of a HTTP service.
Pick your billing	Charge fixed prices for routes. AI usage metering by input and output tokens is coming soon.
Generated listing	The proxy publishes your endpoint metadata so xpayapi.com can build the API profile and docs page automatically.
Own the revenue	Payments settle on-chain to the wallet address you configure. The directory helps callers discover you.

Turn any API into a paid endpoint.

How the proxy works

What you'll do

Get your proxy running

OpenAPI specification

6. Run this on your server

7. Confirm it works

Install the open-source proxy

Set wallet, routes, prices, and directory credentials

Start the proxy and auto-publish

What you get

Restart after .env or config changes

Stop local service

Stop Caddy or tunnel profile