Learn about Maxy / Overview
Product stack
Everything Maxy offers, and where each piece is documented. Every piece uses the same keys and the same order states.
| Piece | What it does | Read |
|---|---|---|
| HTTP API | Prices, quotes, orders and status over plain HTTPS | API routes |
| TypeScript SDK | One call runs a whole order, signatures included | Flow helpers |
| React and Python | A price, a quote or a full order from a React app or a Python service | React and Python |
| Command line | Prices, swaps, test keys and webhooks from a terminal, with --json for scripts | Command line |
| Sandbox | Every route with test keys and no testnet coins | Sandbox |
| Webhooks | One signed event for each change of an order | Webhooks |
| MaxyLock | Loans against Bitcoin that stays on the Bitcoin network | How MaxyLock works |
| Maxy Mint | BTC.R on Robinhood Chain, minted against a proven Bitcoin payment | How Maxy Mint works |
| Status page | Live health of every route | Status |
What stays the same
- The BTC arrives at the user's own Bitcoin address. Nothing is wrapped.
- The user's coins wait in the settler, a contract on their own chain, until the BTC is proven paid.
- A test key comes from
POST /sandbox/keyswith no sign-up. Your partner kit adds a live key.