Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Consume live public trades, depth changes, tickers, and one-minute candles.
wss://api.paperdrill.dev
| Channel | Message |
|---|---|
trade:SYMBOL | Completed public trade |
depth:SYMBOL | Changed order-book levels only |
ticker:SYMBOL | Updated rolling 24-hour statistics |
candle:SYMBOL | Current one-minute candle, updated on each trade |
GET /markets.
SUBSCRIBE message after the connection opens. One message can contain multiple channels.
const channels = ["trade:SOL_USD", "ticker:SOL_USD"];
const socket = new WebSocket("wss://api.paperdrill.dev");
socket.addEventListener("open", () => {
socket.send(JSON.stringify({ method: "SUBSCRIBE", params: channels }));
});
socket.addEventListener("message", ({ data }) => {
const message = JSON.parse(data);
console.log(message.event, message);
});
UNSUBSCRIBE.
{
"event": "trade",
"symbol": "SOL_USD",
"id": "fill_123",
"price": "125.50",
"qty": "1.25",
"maker": false,
"timestamp": 1789812000000
}
time, symbol, open, high, low, close, volume, and event: "candle".
const channels = ["trade:SOL_USD", "ticker:SOL_USD"];
let attempt = 0;
function connect() {
const socket = new WebSocket("wss://api.paperdrill.dev");
socket.addEventListener("open", () => {
attempt = 0;
socket.send(JSON.stringify({ method: "SUBSCRIBE", params: channels }));
});
socket.addEventListener("message", ({ data }) => {
const message = JSON.parse(data);
console.log(message);
});
socket.addEventListener("close", () => {
const delay = Math.min(30_000, 1_000 * 2 ** attempt++);
setTimeout(connect, delay + Math.random() * 500);
});
}
connect();