Quickstart
Every paid route is an ordinary HTTP call made twice.
# 1. Read the catalog: every route, its price, the assets and the address to pay curl -s https://algorand-api.pxke.me/api/v1/x402 # 2. Call a paid route with no payment: HTTP 402, the offer is in PAYMENT-REQUIRED curl -si 'https://algorand-api.pxke.me/api/v1/x402/news/search?q=algorand' # 3. Sign an Algorand transfer for that offer, then repeat with PAYMENT-SIGNATURE curl -s 'https://algorand-api.pxke.me/api/v1/x402/news/search?q=algorand' -H "PAYMENT-SIGNATURE: $SIGNED"
# pip install https://algorand-api.pxke.me/sdk/pxke_x402-<version>.tar.gz (the current tarball is linked below)
from pxke_x402 import PxkeClient
client = PxkeClient(mnemonic=MNEMONIC) # a funded mainnet wallet; omit for free reads
print(client.catalog()["routes"][0])
hits = client.search_news("algorand") # 402, sign, retry: all inside this call
print(hits["settlement_tx_id"])
Discovery documents
One document lists every route, its price, the accepted assets and the address to pay. Fetch it first.
- OpenAPI 3.1
- https://algorand-api.pxke.me/openapi.json
- Network
- mainnet (algorand:wGHE2Pwdvd7S12BL5FaOP20EGYesN73ktiC1qzkkit8=)
- Pay to
KSAVOYTVNB7A6NKCM4W2WBOOGFHWH2SEGR5T6OGB7THCAT5E36LDFEBTII- Facilitator
- https://facilitator.goplausible.xyz/
Settlement is performed by the facilitator. Its merchant page is the independent record of every settled payment.
Routes and prices
Scan
| Route | Price |
|---|---|
POST / | $0.01 |
Storage
| Route | Price |
|---|---|
POST / | free |
POST / | free |
POST / | $0.002 / MB / 90 days |
GET / | free |
GET / | free |
POST / | $0.002 / MB / 90 days |
POST / | $0.002 / MB / 90 days |
GET / | free |
GET / | free |
DELETE / | free |
News
| Route | Price |
|---|---|
GET / | free |
GET / | free |
GET / | $0.001 |
GET / | free |
Python client
A thin client for the free reads and the x402-signed paid calls, with the payTo allowlist and a payment ceiling built in.
- mirror
- /sdk/
free preview
Add ?preview=true for a free, redacted example of the response shape. Nothing is fetched, nothing is charged.
curl -s 'https://algorand-api.pxke.me/api/v1/x402/news/search?q=algorand&preview=true'
Recent settlements
Real payments from other wallets across every product, newest first. Our own probes are excluded.
GET /api/v1/x402/settlements/recent
No settlements in the recent window. The full count is on the facilitator’s merchant page.