Developers

Three requests, no setup

Nothing to register for and nothing to configure. In the first two, https://your-deployment stands for whichever origin is serving you this page — swap it in and they work right now. The third is plain browser JavaScript against a relative URL, so it runs from any page on this site exactly as written.

1. 1

   Ask whether the data path is live

   Not “is the web server up” — that stays green while every price is an hour stale. This reports whether the ingest worker is writing, and answers 503 when it is not.

   curl -i 'https://your-deployment/api/health'

2. 2

   Pull real candles

   Eight intervals, up to 1,000 bars, straight off the venue. Note that time comes back in seconds — the charting convention, and the one unit surprise in this API.

   curl 'https://your-deployment/api/klines?symbol=BTCUSDT&interval=1h&limit=3'

3. 3

   Open a live stream

   The order book, the trade tape and the forming 1-minute candle for one symbol. Plain server-sent events, so a browser needs no library at all.

   const stream = new EventSource('/api/stream/symbol/BTCUSDT')
   
   stream.addEventListener('snapshot', (event) => {
     const { ticker, book, trades } = JSON.parse(event.data)
     render(ticker, book, trades)
   })
   
   stream.addEventListener('trade', (event) => {
     appendToTape(JSON.parse(event.data))
   })

The whole API, on one screen

Twelve routes is a small surface, and seeing all of it at once is a more useful answer than a search box — you will know in ten seconds whether the thing you came for exists. Every row links into the reference.

Every route has a client you can watch

This is the spot terminal at /trade/BTCUSDT, rendering live venue data. Five panels, five things documented in the reference — open it in another tab and you are watching these endpoints deliver.

12345