REST API reference
Every public REST endpoint, generated from the backend's route table, with code samples and a live playground.
The RealTime REST API serves market data, candles, your account, notifications and service status. Every endpoint page is generated from the backend's Express router together with reviewed descriptions, and lists only endpoints that return real data.
Base URL
| Network | Arc Testnet Live |
|---|---|
| REST | https://arc-testnet-api.realtime.exchange |
| WebSocket (Socket.IO) | wss://arc-testnet-api.realtime.exchange path /socket.io |
The hosted API serves routes at the root (for example GET /markets). See Developer overview for conventions, errors and rate limits.
Authentication
Market data, candles and service endpoints are public. Account and notification endpoints need an API key: send it as the API-KEY and API-SECRET headers. Create an API key →
Try it
Each endpoint page has code samples in several languages (your choice is remembered) and a Try it playground that sends a real request from your browser. For endpoints that need a key, paste a testnet API key into the playground: it is kept only in this browser tab and sent only to the API above.
Endpoints
Market data
Public, no authentication. Values are read from the indexer, the chain and the price oracle.
- GET/markets
- GET/markets
/{instrument_id} - GET/instrument
/{instrument_name} - GET/markets
/{instrument_id} /orderbook - GET/orderbook
/{instrument_name} - GET/orderbook
- GET/markets
/{instrument_id} /trades - GET/instrument
/{instrument_name} /trade-history - GET/statistics
/{asset} /{instrument_type} - GET/statistics
- GET/funding
/{instrument_name} - GET/funding
- GET/funding-history
/{instrument_name} - GET/funding-history
- GET/index
/{asset} - GET/index
- GET/assets
- GET/markets-summary
Candles and charting
Candles are built from this venue's own fills. Only periods that traded are returned (no forward-fill).
Account
Requires your account identity. Authenticate with an API key (see Authentication).
Registration
Notifications
Requires authentication. Notifications are stored per chain.