> For the complete documentation index, see [llms.txt](https://noiho.gitbook.io/noiho/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://noiho.gitbook.io/noiho/developers/api-consumers/api-overview.md).

# API quickstart

Check the deployment, request a quote, create an order and monitor it.

The API creates asynchronous XMR ↔ XMRn orders. Read deliveryModes for available destinations. It does not trade USDC, BTC, ETH or SOL.

Use the server URL in the [live OpenAPI 3.1 specification](https://api.noiho.xyz/v1/openapi.json), including its network path. Read deployment capabilities before sending funds. Use [Try the API](/noiho/developers/api-consumers/api-playground.md) to check the deployment from this documentation.

```bash
# Read servers[].url from this specification first.
curl --fail https://api.noiho.xyz/v1/openapi.json
# Set BASE to the selected servers[].url, including its network path.
curl --fail "$BASE/v1/capabilities"
```

Each deployment serves one EVM chain and one Monero network. Check chainId, moneroNetwork, assetInfo, delivery, directions, acceptingOrders and maxAmountAtomic. Do not send mainnet funds to a testnet or stagenet deployment.

Check acceptingOrders before creating an order. Existing orders retain their recovery paths when admission stops.

| Step     | Request                                      | Responsibility                                                |
| -------- | -------------------------------------------- | ------------------------------------------------------------- |
| Discover | GET /v1/capabilities                         | Client checks deployment and supported direction.             |
| Quote    | POST /v1/quotes                              | User reviews indicative terms and signs authorizationMessage. |
| Create   | POST /v1/orders                              | Client persists one Idempotency-Key and signed body.          |
| Pay      | Wrap deposit or unsigned unwrap transactions | User pays once on the advertised network.                     |
| Monitor  | GET /v1/orders/{id}                          | Client uses authorized status until settlement or recovery.   |

Read [Authentication](/noiho/developers/api-consumers/wallet-authentication.md), then [Quotes and orders](/noiho/developers/api-consumers/quotes-and-orders.md). Direct contract callers should use [Frontend builders](/noiho/developers/frontend-builders.md).