Start / Overview
What Maxy is
Maxy swaps native Bitcoin with coins on Base, Arbitrum, BNB Chain, Avalanche, Robinhood Chain and Solana, through an HTTP API and a TypeScript SDK. It also lends against Bitcoin (MaxyLock) and mints BTC.R (Maxy Mint).
- The BTC arrives as an ordinary Bitcoin transaction at the user's own address. Nothing is wrapped.
- Buying needs no Maxy account and no new wallet.
- Until the BTC is proven paid, the user's coins sit in the settler, a contract on their own chain, never with Maxy.
- The solver, the party that fills orders, pays the BTC first. The settler pays it only against a proof of that payment.
- If the solver is late, the user takes their coins back.
To start you need a test key: POST /sandbox/keys, no sign-up. Nothing real can move with one. Your partner kit from Maxy adds a live key, the SDK and Python packages, and runnable examples.
Find your path
Find the row that sounds like you, and read its pages in that order. Every path ends at the launch checklist.
| You are | Do this | Read |
|---|---|---|
| An aggregator or router | Add Maxy as a source: map a quote, read /pairs, skip a size with liquidityAvailable: false, track by txHash | Buy BTC, Order states |
| A wallet, exchange or on-ramp | Put a BTC buy in your product, update your ledger from webhooks | Flow helpers, Webhooks |
| A DeFi or DEX frontend | Add a Buy BTC button on your wallet connection, keep your key on your server | React and Python, Keys and limits |
| A backend that signs with its own keys | Sign on your server, reconcile monthly | Buy BTC, Order states |
| A security or compliance reviewer | Decide on Maxy as a vendor | Security, Contracts |
Where things are
| You may look for | Use |
|---|---|
| A testnet | The sandbox, which needs no testnet coins |
| A dashboard | GET /account: your keys and calls per day |
| A status page | Status |
| A drop-in widget | React and widget |
| npm and PyPI packages | From maxy.co: Install |
The same material as one long read: the integration guide PDF.