# RealTime Exchange documentation

> High-performance decentralized exchange on Arc.

Documentation for RealTime Exchange on Arc Testnet, generated from the product source code. Each link is the Markdown version of a page. Trading on Arc Mainnet coming soon; no mainnet exchange values are published yet.

## User Guide

- [Welcome to RealTime Exchange](https://docs.realtime.exchange/guide.md): What you can do on this exchange, and where to start.
- [Quick start](https://docs.realtime.exchange/guide/getting-started/quick-start.md): From connecting a wallet to watching your first position, step by step.
- [Network](https://docs.realtime.exchange/guide/getting-started/network.md): The network this app runs on, and what your wallet needs.
- [Connect a wallet](https://docs.realtime.exchange/guide/account/connect-wallet.md): Connect a wallet, switch to the right network, and what to do if connecting fails.
- [Enable trading (sign in)](https://docs.realtime.exchange/guide/account/enable-trading.md): The one-time, gas-free signature that lets the app trade for you, and how long it lasts.
- [One-Click Trading](https://docs.realtime.exchange/guide/account/one-click-trading.md): Approve a browser session key once so orders are signed without wallet pop-ups.
- [Get testnet funds](https://docs.realtime.exchange/guide/funds/testnet-funds.md): How the automatic testnet faucet tops up your wallet when you connect.
- [Deposit](https://docs.realtime.exchange/guide/funds/deposit.md): Fund your trading balance from your wallet — what you need, the steps, what to expect and how to fix a failed deposit.
- [Withdraw](https://docs.realtime.exchange/guide/funds/withdraw.md): Take funds back to your wallet — what you need, the steps, what to expect and how to recover from a failed withdrawal.
- [Transfer to another account](https://docs.realtime.exchange/guide/funds/transfer.md): Move funds to another address's trading balance on the exchange — what you need, the steps, and what to do if a transfer fails.
- [Find a market](https://docs.realtime.exchange/guide/trading/find-a-market.md): Search markets, use the watchlist and read a market's trading rules.
- [Place an order](https://docs.realtime.exchange/guide/trading/place-an-order.md): Place a market or limit order on a perpetual market, with optional Reduce Only and take-profit / stop-loss.
- [Leverage and margin mode](https://docs.realtime.exchange/guide/trading/leverage-and-margin.md): Choose cross or isolated margin and set leverage for a perpetual market.
- [Charts and order book](https://docs.realtime.exchange/guide/trading/charts-and-order-book.md): Read the price chart, depth and funding charts, the order book, recent trades and the market header.
- [Spot trading](https://docs.realtime.exchange/guide/trading/spot-trading.md): Buy and sell spot markets — how the spot form differs from perpetuals.
- [Manage positions](https://docs.realtime.exchange/guide/positions/manage-positions.md): Read the positions table, close a position at market or limit, and share your PnL.
- [Take profit and stop loss](https://docs.realtime.exchange/guide/positions/take-profit-stop-loss.md): Set automatic exit prices on a new order or an open position, and what happens when they trigger.
- [Open orders](https://docs.realtime.exchange/guide/positions/open-orders.md): See, cancel and cancel-all your resting limit orders.
- [History](https://docs.realtime.exchange/guide/positions/history.md): Position, trade, order, funding and transfer history — what each tab shows.
- [Margin and liquidation](https://docs.realtime.exchange/guide/risk/liquidation.md): How margin works, when a position is liquidated, and the warnings the app gives you first.
- [Funding](https://docs.realtime.exchange/guide/risk/funding.md): How funding works on perpetual markets and where to see what you paid or received.
- [Fees](https://docs.realtime.exchange/guide/risk/fees.md): Where trading fees come from and where to see them before you trade.
- [Portfolio](https://docs.realtime.exchange/guide/account-tools/portfolio.md): Your balances, margin health, positions and history in one place.
- [Leaderboard](https://docs.realtime.exchange/guide/account-tools/leaderboard.md): Top traders by volume, PnL or number of trades.
- [Referrals](https://docs.realtime.exchange/guide/account-tools/referrals.md): Share a referral link or code and see who joined through you.
- [Watchlist](https://docs.realtime.exchange/guide/account-tools/watchlist.md): Star markets to keep them one click away.
- [Notifications](https://docs.realtime.exchange/guide/account-tools/notifications.md): Fill, funds, TP/SL and liquidation alerts, and how to control them.
- [Settings and preferences](https://docs.realtime.exchange/guide/settings/preferences.md): Slippage, up/down colours, sounds, signing keys and notification settings.
- [Keyboard shortcuts](https://docs.realtime.exchange/guide/settings/keyboard-shortcuts.md): Every keyboard shortcut in the app, generated from the app's shortcut registry.
- [Troubleshooting](https://docs.realtime.exchange/guide/help/troubleshooting.md): What the app's messages mean and how to fix them, grouped by task.
- [Security and safety](https://docs.realtime.exchange/guide/help/security.md): What the app stores, what signatures mean, and how to keep your account safe.
- [Frequently asked questions](https://docs.realtime.exchange/guide/help/faq.md): Short answers to common questions.
- [Glossary](https://docs.realtime.exchange/guide/help/glossary.md): Terms used in the app and these docs.
- [Network and contracts](https://docs.realtime.exchange/guide/reference/network-and-contracts.md): Chain ID, explorer, token addresses and the contract addresses the app uses.
- [What's available on Arc Testnet](https://docs.realtime.exchange/guide/reference/availability.md): Which features and services are part of the exchange on this network.

## Developers

- [Developer overview](https://docs.realtime.exchange/developers/overview.md): Base URL, conventions and error format of the <BrandName short /> API.
- [Authentication](https://docs.realtime.exchange/developers/authentication.md): How to register a signing key and authenticate REST and WebSocket requests with an API key.
- [REST API reference](https://docs.realtime.exchange/developers/rest-api.md): Every public REST endpoint, generated from the backend's route table, with code samples and a live playground.
- [GET /markets](https://docs.realtime.exchange/developers/api-reference/market/get-markets.md): All listed markets (spot and perpetual) with their trading rules.
- [GET /markets/:instrument_id](https://docs.realtime.exchange/developers/api-reference/market/get-markets-instrument-id.md): One market.
- [GET /instrument/:instrument_name](https://docs.realtime.exchange/developers/api-reference/market/get-instrument-instrument-name.md): Alias of GET /markets/{instrument_id}.
- [GET /markets/:instrument_id/orderbook](https://docs.realtime.exchange/developers/api-reference/market/get-markets-instrument-id-orderbook.md): Alias of GET /orderbook/{instrument_name}.
- [GET /orderbook/:instrument_name](https://docs.realtime.exchange/developers/api-reference/market/get-orderbook-instrument-name.md): Aggregated order book (open and partially filled orders).
- [GET /orderbook](https://docs.realtime.exchange/developers/api-reference/market/get-orderbook.md): Same as GET /orderbook/{instrument_name}, with the instrument as a query parameter.
- [GET /markets/:instrument_id/trades](https://docs.realtime.exchange/developers/api-reference/market/get-markets-instrument-id-trades.md): Recent trades for a market.
- [GET /instrument/:instrument_name/trade-history](https://docs.realtime.exchange/developers/api-reference/market/get-instrument-instrument-name-trade-history.md): Recent trades for a market, wrapped with a count.
- [GET /statistics/:asset/:instrument_type](https://docs.realtime.exchange/developers/api-reference/market/get-statistics-asset-instrument-type.md): 24-hour statistics for a market.
- [GET /statistics](https://docs.realtime.exchange/developers/api-reference/market/get-statistics.md): Same as above with query parameters.
- [GET /funding/:instrument_name](https://docs.realtime.exchange/developers/api-reference/market/get-funding-instrument-name.md): Current funding rate of a perpetual market (per hour).
- [GET /funding](https://docs.realtime.exchange/developers/api-reference/market/get-funding.md): Same as above with instrument_name as a query parameter.
- [GET /funding-history/:instrument_name](https://docs.realtime.exchange/developers/api-reference/market/get-funding-history-instrument-name.md): Recent hourly funding rates of a perpetual market.
- [GET /funding-history](https://docs.realtime.exchange/developers/api-reference/market/get-funding-history.md): Same as above with instrument_name as a query parameter.
- [GET /index/:asset](https://docs.realtime.exchange/developers/api-reference/market/get-index-asset.md): Index (oracle) price of an asset.
- [GET /index](https://docs.realtime.exchange/developers/api-reference/market/get-index.md): Index prices for every token the indexer knows (see GET /assets), or one asset via ?asset=.
- [GET /assets](https://docs.realtime.exchange/developers/api-reference/market/get-assets.md): Tokens known to the indexer.
- [GET /markets-summary](https://docs.realtime.exchange/developers/api-reference/market/get-markets-summary.md): Per-asset summary of spot and perpetual prices and volumes.
- [GET /candles](https://docs.realtime.exchange/developers/api-reference/candles/get-candles.md): OHLCV candles built from this venue's fills.
- [GET /last-traded-tradingview/history](https://docs.realtime.exchange/developers/api-reference/candles/get-last-traded-tradingview-history.md): The same candles in TradingView UDF format.
- [GET /last-traded-tradingview/config](https://docs.realtime.exchange/developers/api-reference/candles/get-last-traded-tradingview-config.md): TradingView UDF datafeed configuration (supported resolutions).
- [GET /account](https://docs.realtime.exchange/developers/api-reference/account/get-account.md): Account overview — balances, equity, margin, positions, fee structures.
- [GET /positions](https://docs.realtime.exchange/developers/api-reference/account/get-positions.md): Open positions, cursor-paginated.
- [GET /open-orders](https://docs.realtime.exchange/developers/api-reference/account/get-open-orders.md): Open and partially filled orders, cursor-paginated.
- [GET /orders](https://docs.realtime.exchange/developers/api-reference/account/get-orders.md): Your open and partially filled orders, unpaginated (at most the 200 most recent).
- [GET /orders/:order_id](https://docs.realtime.exchange/developers/api-reference/account/get-orders-order-id.md): One of your open orders.
- [GET /trade-history](https://docs.realtime.exchange/developers/api-reference/account/get-trade-history.md): Your fills, cursor-paginated.
- [GET /order-history](https://docs.realtime.exchange/developers/api-reference/account/get-order-history.md): Filled, partially filled and cancelled orders, cursor-paginated.
- [GET /position-history](https://docs.realtime.exchange/developers/api-reference/account/get-position-history.md): Closed perpetual positions (one row per position cycle), cursor-paginated.
- [GET /transaction-history](https://docs.realtime.exchange/developers/api-reference/account/get-transaction-history.md): Deposits, withdrawals and transfers.
- [GET /account/accumulated-fundings](https://docs.realtime.exchange/developers/api-reference/account/get-account-accumulated-fundings.md): Funding accumulated on your open perpetual positions.
- [GET /balance-history](https://docs.realtime.exchange/developers/api-reference/account/get-balance-history.md): Your recorded account equity over time (the portfolio chart).
- [POST /register](https://docs.realtime.exchange/developers/api-reference/auth/post-register.md): Register a signing key for your wallet and receive an API key + secret.
- [DELETE /api-key](https://docs.realtime.exchange/developers/api-reference/auth/delete-api-key.md): Revoke an API key of your account, or all of them.
- [GET /notifications](https://docs.realtime.exchange/developers/api-reference/notifications/get-notifications.md): Your notifications, newest first.
- [POST /mark-as-read](https://docs.realtime.exchange/developers/api-reference/notifications/post-mark-as-read.md): Mark all notifications as read.
- [POST /notifications/clear](https://docs.realtime.exchange/developers/api-reference/notifications/post-notifications-clear.md): Clear the list (older notifications are hidden, not deleted).
- [POST /notifications/:id/read](https://docs.realtime.exchange/developers/api-reference/notifications/post-notifications-id-read.md): Mark one notification as read.
- [DELETE /notifications/:id](https://docs.realtime.exchange/developers/api-reference/notifications/delete-notifications-id.md): Delete one notification.
- [GET /notification-preferences](https://docs.realtime.exchange/developers/api-reference/notifications/get-notification-preferences.md): Your notification preferences.
- [PUT /notification-preferences](https://docs.realtime.exchange/developers/api-reference/notifications/put-notification-preferences.md): Update notification preferences.
- [GET /health](https://docs.realtime.exchange/developers/api-reference/service/get-health.md): Liveness.
- [GET /ready](https://docs.realtime.exchange/developers/api-reference/service/get-ready.md): Readiness.
- [GET /version](https://docs.realtime.exchange/developers/api-reference/service/get-version.md): Backend version and runtime.
- [GET /time](https://docs.realtime.exchange/developers/api-reference/service/get-time.md): Server time.
- [WebSocket API](https://docs.realtime.exchange/developers/websocket.md): Real-time order book, trades, candles, tickers and private account channels over Socket.IO.
- [Candles and market data](https://docs.realtime.exchange/developers/market-data.md): How candles are built, supported resolutions and the TradingView datafeed.

## API

- [OpenAPI 3.1](https://docs.realtime.exchange/openapi.json): machine-readable reference of the public REST API
- [Postman collection](https://docs.realtime.exchange/postman.json): every public request

## Optional

- [Full text](https://docs.realtime.exchange/llms-full.txt): every page above in one file