> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nxos.io/llms.txt
> Use this file to discover all available pages before exploring further.

# API reference

> Complete reference for all Nxos API endpoints.

## Base URLs

| Environment | Base URL                      |
| ----------- | ----------------------------- |
| Sandbox     | `https://api.sandbox.nxos.io` |
| Production  | `https://api.nxos.io`         |

Both environments expose the same endpoints. Use sandbox for development and testing — no real funds are involved.

## Authentication

All requests require a Bearer token in the `Authorization` header:

```
Authorization: Bearer nxos_sk_test_...
```

See [Authentication](/concepts/authentication) for details on key management.

## Request format

* Request bodies use `Content-Type: application/json`
* All IDs are prefixed strings (e.g., `acct_`, `bene_`, `quote_`, `txn_`)
* Amounts are decimal strings in major units (e.g., `"10.50"`)

## Response format

* Successful responses return the resource directly (single object) or a [paginated list](/concepts/conventions#pagination)
* Error responses follow a [standard envelope](/concepts/errors) with `code`, `message`, and `requestId`
* Every object includes an `object` field identifying its type

## Endpoints

### Accounts

| Method | Path                       | Description                                              |
| ------ | -------------------------- | -------------------------------------------------------- |
| `GET`  | `/v1/accounts`             | [List accounts](/api-reference/accounts/list)            |
| `GET`  | `/v1/accounts/{accountId}` | [Get account with balances](/api-reference/accounts/get) |

### Quotes

| Method | Path                           | Description                                      |
| ------ | ------------------------------ | ------------------------------------------------ |
| `POST` | `/v1/quotes`                   | [Create a quote](/api-reference/quotes/create)   |
| `GET`  | `/v1/quotes/{quoteId}`         | [Get a quote](/api-reference/quotes/get)         |
| `POST` | `/v1/quotes/{quoteId}/execute` | [Execute a quote](/api-reference/quotes/execute) |

### Beneficiaries

| Method   | Path                                | Description                                                             |
| -------- | ----------------------------------- | ----------------------------------------------------------------------- |
| `GET`    | `/v1/beneficiaries`                 | [List beneficiaries](/api-reference/beneficiaries/list)                 |
| `POST`   | `/v1/beneficiaries/crypto`          | [Create crypto beneficiary](/api-reference/beneficiaries/create-crypto) |
| `POST`   | `/v1/beneficiaries/bank`            | [Create bank beneficiary](/api-reference/beneficiaries/create-bank)     |
| `GET`    | `/v1/beneficiaries/{beneficiaryId}` | [Get beneficiary](/api-reference/beneficiaries/get)                     |
| `PATCH`  | `/v1/beneficiaries/{beneficiaryId}` | [Update beneficiary](/api-reference/beneficiaries/update)               |
| `DELETE` | `/v1/beneficiaries/{beneficiaryId}` | [Archive beneficiary](/api-reference/beneficiaries/archive)             |

### Payouts

| Method | Path                              | Description                                                    |
| ------ | --------------------------------- | -------------------------------------------------------------- |
| `POST` | `/v1/transactions/fiat-payouts`   | [Initiate fiat payout](/api-reference/fiat-payouts/initiate)   |
| `POST` | `/v1/transactions/crypto-payouts` | [Execute crypto payout](/api-reference/crypto-payouts/execute) |