Find something... ⌘K

Reference / HTTP API

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; every route is in the integration guide PDF, and GET /openapi.json is the same as OpenAPI 3.1.

Method and pathKeyWhat it does
GET /noThis list as JSON, with the command that gets a test key
POST /sandbox/keysnoA test key and a test publishable key, with no sign-up (the body can be left out, or { name, origins }). Shown once
GET /chainsyesBitcoin, the EVM chains with a settler, and Solana
GET /tokens?chain=baseyesSymbol, address and decimals of each token
GET /pairsyesEvery pair, in words (USDC on Base → BTC), with its route, settler, smallest order, confirmations and CAIP-19 ids
GET /priceyesWhat arrives for an amount; no wallet needed
GET /prices/streamyesThe same question as server-sent events, every 5 seconds or more (or ?ticket=, from a browser)
POST /prices/stream-ticketyesA ticket for that stream from a browser (EventSource cannot send a key): one pair, any amount, 10 minutes
GET /quoteyesThe quote for an order about to be placed (fromAddress, toAddress): quoteId, expiresAt, the steps and signing
POST /quotes/batchyesUp to 20 prices or quotes in one call, with an answer or an error for each
POST /ordersyesThe signed order: back comes the transaction to send (or, gasless, the solver takes it)
POST /orders/submityesAfter the escrow or bridge transaction: tell Maxy (the solver also watches the chain)
POST /orders/{id}/signatureyesThe same as POST /orders, for the order in the path
POST /orders/{id}/cancelyesThe transaction that takes back an escrow no solver committed to; 409 order_state once one has
GET /orders/{id}/eventsyesThe order's states so far, with times
GET /orders/{id}/events/streamyesThe order's state as server-sent events, until it ends (or ?ticket=, from a browser)
POST /orders/{id}/stream-ticketyesA ticket for that stream from a browser (EventSource cannot send a key): this order, 10 minutes, answers the URL to open
GET /statusyesWhere an order is, by orderId or by txHash (any transaction of the order)
GET /orders/{id}yesThe same, by path
GET /orders/{id}/refundyesThe transaction that takes an expired escrow back to the user, simulated (chainId)
GET /orders/{id}/deposityesSelling BTC: where and how much to pay, read from the settler (chainId)
GET /orders/{id}/claimyesSelling BTC: the transaction that proves the payment and releases the payout, simulated (chainId)
GET /orders/{id}/bridgeyesSelling BTC for a coin with no settler: the bridge transaction, after the settler has paid
GET /orders/{id}/stepsyesSolana: where the offer is and what is left to sign
POST /orders/{id}/stepsyesSolana: the next stage, or a signed transaction to send
GET /ordersyesYour orders, newest first: limit, cursor, from, to, state, wallet, externalId, externalCustomerId; format=csv for a spreadsheet
POST /orders/watchyesFollow any order for your webhooks (orderId, chainId?, route?, toChainId?)
POST /webhooksyesGet signed order.updated events at your HTTPS endpoint
GET /webhooksyesYour endpoints, without their secrets
DELETE /webhooks/{id}yesStop sending to an endpoint
POST /webhooks/{id}/testyesSend a signed webhook.test event now
GET /webhooks/{id}/eventsyesThe last 25 events of an endpoint (signed=1 adds each one signed now)
POST /webhooks/{id}/events/{eventId}/replayyesSend a past event again, with the same event id
GET /keyyesYour key, its class, scopes, origins and order size cap
GET /limitsyesYour key's class and order size cap, the smallest order per route, the quote lifetime and your rate limits right now
GET /addresses/validateyesWhether an address is well formed and a Maxy order can pay it (chain, address), with a reason
GET /accountyesYour account: keys, usage and limit requests (a secret key)
GET /usageyesYour calls per day (days=30)
POST /keysyesA new publishable key { kind: "publishable", origins } (with a test key, another test key). Shown once
POST /keys/rotateyesA new secret key with the same cap; the old one works until you revoke it
POST /keys/{prefix}/originsyesThe sites a publishable key may be used from
DELETE /keys/{prefix}yesRevoke a key of your account
POST /limits/requestsyesAsk for a higher order size cap { wantedUsd, note }
GET /limits/requestsyesWhat you asked for, and the answers
GET /statementsyesA month of your orders with totals (month=2026-11, format=json, csv or pdf)
GET /explorer/{query}yesOne order by order id, intent hash, chain transaction or Bitcoin txid: states, times and links
GET /checkout/verifynoHosted checkout: whether a signed URL is what the partner signed
GET /system/statusnoThe status page: every component now, open incidents and maintenance (also /system/history, /incidents, /maintenance, /verified, /feed.xml)
GET /healthnoThe solver, Bitcoin and each chain's verifier, with a degraded flag
GET /openapi.jsonnoThis API as OpenAPI 3.1
GET /sandbox/scenariostest keyThe outcomes you can force in the sandbox
GET /sandbox/ratestest keyLive BTC, ETH and USDC prices in dollars
POST /sandbox/orders/{id}/advancetest keyMove a sandbox order to its next state now, or to { "to": "completed" }