# API routes

Every route of the HTTP API. Each takes your key as `x-maxy-key`, apart from the index, the spec, `/health`, the status page and `POST /sandbox/keys`, which gives you a test key with no sign-up.

Base URL: `https://whhxyutitykcsdpvdgcd.supabase.co/functions/v1/maxy-api`. Add each path below to it: `$BASE/price`, `$BASE/orders/{id}`. Parameters, samples and a real answer for each route an integration uses are on [API reference](https://maxy.co/docs/api-reference); every route is in the [integration guide PDF](https://maxy.co/guides/maxy-integration-guide.pdf), and `GET /openapi.json` is the same as OpenAPI 3.1.

| Method and path | Key | What it does |
| --- | --- | --- |
| `GET /` | no | This list as JSON, with the command that gets a test key |
| `POST /sandbox/keys` | no | A test key and a test publishable key, with no sign-up (the body can be left out, or `{ name, origins }`). Shown once |
| `GET /chains` | yes | Bitcoin, the EVM chains with a settler, and Solana |
| `GET /tokens?chain=base` | yes | Symbol, address and decimals of each token |
| `GET /pairs` | yes | Every pair, in words (`USDC on Base → BTC`), with its route, settler, smallest order, confirmations and CAIP-19 ids |
| `GET /price` | yes | What arrives for an amount; no wallet needed |
| `GET /prices/stream` | yes | The same question as server-sent events, every 5 seconds or more (or `?ticket=`, from a browser) |
| `POST /prices/stream-ticket` | yes | A ticket for that stream from a browser (`EventSource` cannot send a key): one pair, any amount, 10 minutes |
| `GET /quote` | yes | The quote for an order about to be placed (`fromAddress`, `toAddress`): `quoteId`, `expiresAt`, the steps and `signing` |
| `POST /quotes/batch` | yes | Up to 20 prices or quotes in one call, with an answer or an error for each |
| `POST /orders` | yes | The signed order: back comes the transaction to send (or, gasless, the solver takes it) |
| `POST /orders/submit` | yes | After the escrow or bridge transaction: tell Maxy (the solver also watches the chain) |
| `POST /orders/{id}/signature` | yes | The same as `POST /orders`, for the order in the path |
| `POST /orders/{id}/cancel` | yes | The transaction that takes back an escrow no solver committed to; `409 order_state` once one has |
| `GET /orders/{id}/events` | yes | The order's states so far, with times |
| `GET /orders/{id}/events/stream` | yes | The order's state as server-sent events, until it ends (or `?ticket=`, from a browser) |
| `POST /orders/{id}/stream-ticket` | yes | A ticket for that stream from a browser (`EventSource` cannot send a key): this order, 10 minutes, answers the URL to open |
| `GET /status` | yes | Where an order is, by `orderId` or by `txHash` (any transaction of the order) |
| `GET /orders/{id}` | yes | The same, by path |
| `GET /orders/{id}/refund` | yes | The transaction that takes an expired escrow back to the user, simulated (`chainId`) |
| `GET /orders/{id}/deposit` | yes | Selling BTC: where and how much to pay, read from the settler (`chainId`) |
| `GET /orders/{id}/claim` | yes | Selling BTC: the transaction that proves the payment and releases the payout, simulated (`chainId`) |
| `GET /orders/{id}/bridge` | yes | Selling BTC for a coin with no settler: the bridge transaction, after the settler has paid |
| `GET /orders/{id}/steps` | yes | Solana: where the offer is and what is left to sign |
| `POST /orders/{id}/steps` | yes | Solana: the next stage, or a signed transaction to send |
| `GET /orders` | yes | Your orders, newest first: `limit`, `cursor`, `from`, `to`, `state`, `wallet`, `externalId`, `externalCustomerId`; `format=csv` for a spreadsheet |
| `POST /orders/watch` | yes | Follow any order for your webhooks (`orderId`, `chainId?`, `route?`, `toChainId?`) |
| `POST /webhooks` | yes | Get signed `order.updated` events at your HTTPS endpoint |
| `GET /webhooks` | yes | Your endpoints, without their secrets |
| `DELETE /webhooks/{id}` | yes | Stop sending to an endpoint |
| `POST /webhooks/{id}/test` | yes | Send a signed `webhook.test` event now |
| `GET /webhooks/{id}/events` | yes | The last 25 events of an endpoint (`signed=1` adds each one signed now) |
| `POST /webhooks/{id}/events/{eventId}/replay` | yes | Send a past event again, with the same event id |
| `GET /key` | yes | Your key, its class, scopes, origins and order size cap |
| `GET /limits` | yes | Your key's class and order size cap, the smallest order per route, the quote lifetime and your rate limits right now |
| `GET /addresses/validate` | yes | Whether an address is well formed and a Maxy order can pay it (`chain`, `address`), with a reason |
| `GET /account` | yes | Your account: keys, usage and limit requests (a secret key) |
| `GET /usage` | yes | Your calls per day (`days=30`) |
| `POST /keys` | yes | A new publishable key `{ kind: "publishable", origins }` (with a test key, another test key). Shown once |
| `POST /keys/rotate` | yes | A new secret key with the same cap; the old one works until you revoke it |
| `POST /keys/{prefix}/origins` | yes | The sites a publishable key may be used from |
| `DELETE /keys/{prefix}` | yes | Revoke a key of your account |
| `POST /limits/requests` | yes | Ask for a higher order size cap `{ wantedUsd, note }` |
| `GET /limits/requests` | yes | What you asked for, and the answers |
| `GET /statements` | yes | A month of your orders with totals (`month=2026-11`, `format=json`, `csv` or `pdf`) |
| `GET /explorer/{query}` | yes | One order by order id, intent hash, chain transaction or Bitcoin txid: states, times and links |
| `GET /checkout/verify` | no | Hosted checkout: whether a signed URL is what the partner signed |
| `GET /system/status` | no | The status page: every component now, open incidents and maintenance (also `/system/history`, `/incidents`, `/maintenance`, `/verified`, `/feed.xml`) |
| `GET /health` | no | The solver, Bitcoin and each chain's verifier, with a `degraded` flag |
| `GET /openapi.json` | no | This API as OpenAPI 3.1 |
| `GET /sandbox/scenarios` | test key | The outcomes you can force in the sandbox |
| `GET /sandbox/rates` | test key | Live BTC, ETH and USDC prices in dollars |
| `POST /sandbox/orders/{id}/advance` | test key | Move a sandbox order to its next state now, or to `{ "to": "completed" }` |

---
Source: https://maxy.co/docs/api-routes (Maxy Docs › Reference › HTTP API)
