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

# REST API

> Use the DerivaDEX REST API for request-response market data, initial snapshots, and signed private request submission.

The REST API is the request-response interface for DerivaDEX. Use it when your client needs to fetch current state, inspect market data, or submit signed and encrypted trading requests.

Realtime is the companion interface for live updates. A trading client usually uses REST first, then subscribes to Realtime for changes.

## Overview

All paths are relative to the DerivaDEX deployment you are integrating against. Choose the base URL for the target environment first, then append the documented path.

| Environment | Base URL                       |
| ----------- | ------------------------------ |
| Testnet     | `https://testnet.derivadex.io` |

| Area   | Use it for                                                                                      |
| ------ | ----------------------------------------------------------------------------------------------- |
| System | Exchange metadata, products, status, time, and supply state.                                    |
| Market | Order books, prices, tickers, volume, funding, insurance-fund history, and market aggregations. |
| Trade  | Trader, strategy, position, fee, account-update, and signed private-request surfaces.           |

## System endpoints

| Method | Path                                          | Use it for                                                            |
| ------ | --------------------------------------------- | --------------------------------------------------------------------- |
| `GET`  | `/exchange/api/v1/exchange_info`              | Global exchange configuration.                                        |
| `GET`  | `/exchange/api/v1/ping`                       | Connectivity check.                                                   |
| `GET`  | `/exchange/api/v1/symbols`                    | Tradable product symbols and active-state filters.                    |
| `GET`  | `/exchange/api/v1/time`                       | Server time for client clock synchronization.                         |
| `GET`  | `/stats/api/v1/status`                        | High-level exchange status.                                           |
| `GET`  | `/stats/api/v1/specs`                         | Current operator configuration settings.                              |
| `GET`  | `/stats/api/v1/supply`                        | DDX circulation information.                                          |
| `GET`  | `/stats/api/v1/tradable_products`             | Available trading products.                                           |
| `GET`  | `/deployment-service/v2/deployment/addresses` | Deployment contract addresses when exposed by the target environment. |

## Market endpoints

| Method | Path                                                 | Use it for                                                                              |
| ------ | ---------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `GET`  | `/exchange/api/v1/mark_prices`                       | Mark price history by symbol, epoch, and paging cursor.                                 |
| `GET`  | `/exchange/api/v1/order_book`                        | Current L3 order book, optionally filtered by trader, strategy, symbol, side, or depth. |
| `GET`  | `/exchange/api/v1/tickers`                           | Market ticker data such as funding rate, open interest, price data, and 24-hour volume. |
| `GET`  | `/stats/api/v1/aggregations/funding_rate_comparison` | Funding-rate comparison between DerivaDEX and major exchanges.                          |
| `GET`  | `/stats/api/v1/aggregations/insurance_fund`          | Insurance fund value aggregation.                                                       |
| `GET`  | `/stats/api/v1/aggregations/traders`                 | Top traders by volume.                                                                  |
| `GET`  | `/stats/api/v1/aggregations/volume`                  | Trading volume aggregation.                                                             |
| `GET`  | `/stats/api/v1/epochs`                               | Epoch history and paging cursors.                                                       |
| `GET`  | `/stats/api/v1/funding_rate_history`                 | Funding rates over time.                                                                |
| `GET`  | `/stats/api/v1/insurance_fund`                       | Insurance fund balance history.                                                         |
| `GET`  | `/stats/api/v1/open_interest_history`                | Open interest over time.                                                                |
| `GET`  | `/stats/api/v1/order_book_l2`                        | Current L2 aggregated order book by symbol, depth, side, and price aggregation.         |
| `GET`  | `/stats/api/v1/price_checkpoints`                    | Price checkpoint history.                                                               |

## Trade endpoints

| Method | Path                                    | Use it for                                                                                                  |
| ------ | --------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `GET`  | `/exchange/api/v1/order_updates`        | Order posts, fills, cancellations, liquidations, and rejection history.                                     |
| `GET`  | `/exchange/api/v1/strategy_updates`     | Strategy update history for collateral, funding, PnL, fees, withdrawals, liquidations, and ADL.             |
| `GET`  | `/exchange/api/v1/trader_updates`       | Trader DDX balance, fee-preference, admission, denial, and profile update history.                          |
| `GET`  | `/stats/api/v1/aggregations/balance`    | Strategy balance changes over a recent lookback window.                                                     |
| `GET`  | `/stats/api/v1/aggregations/collateral` | Collateral inflow and outflow aggregation.                                                                  |
| `GET`  | `/stats/api/v1/aggregations/ddx`        | DDX inflow and outflow aggregation.                                                                         |
| `GET`  | `/stats/api/v1/aggregations/fees`       | Fee aggregation by symbol, fee symbol, period, and grouping.                                                |
| `GET`  | `/stats/api/v1/fees`                    | Maker and taker fee history for a strategy.                                                                 |
| `GET`  | `/stats/api/v1/positions`               | Current positions for a strategy.                                                                           |
| `GET`  | `/stats/api/v1/strategy`                | Current state of a trader strategy.                                                                         |
| `GET`  | `/stats/api/v1/strategies`              | Strategy list for a trader when exposed by the target deployment.                                           |
| `GET`  | `/stats/api/v1/strategy_metrics`        | Strategy KPIs and risk metrics such as margin fraction, leverage, available collateral, and strategy value. |
| `GET`  | `/stats/api/v1/trader`                  | Current trader DDX balance and profile.                                                                     |
| `GET`  | `/v2/encryption-key`                    | Operator public key for encrypted private request submission.                                               |
| `POST` | `/v2/request`                           | Signed and encrypted private order, cancel, cancel-all, profile-update, or withdrawal request submission.   |

See [Signed Private Requests](/api-reference/rest/signed-requests) for the private request envelope, intent fields, receipts, and submission errors.

## REST and Realtime together

| Stage                                                     | Typical API choice |
| --------------------------------------------------------- | ------------------ |
| Bootstrap market or account state                         | REST               |
| Submit a signed trading request                           | REST               |
| Watch order book and mark-price changes                   | Realtime           |
| Track order, strategy, and trader updates after bootstrap | Realtime           |

## Integration notes

| Topic                    | Detail                                                                                                                                       |
| ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
| Endpoint details         | Operation-specific parameter and response schemas appear under the generated REST endpoint pages.                                            |
| Private trading requests | Signed and encrypted write requests use [Signed Private Requests](/api-reference/rest/signed-requests).                                      |
| Pagination               | Historical endpoints commonly use `limit`, `order`, epoch, ordinal, timestamp, cursor, or offset fields.                                     |
| Numeric values           | Decimal quantities are represented as strings where precision matters.                                                                       |
| Limits and errors        | Use [Rate Limits and Access Tiers](/reference-public/rate-limits-and-access-tiers) and [Error Reference](/reference-public/error-reference). |
| Live updates             | Use [Realtime Channels](/api-reference/realtime/channels) after REST bootstrap when a client needs continuous updates.                       |
