Contents
Core REST Explorer
Run historical and aggregate endpoints
→
Streaming Explorer
Subscribe, snapshot, and stream live data
→

Quickstart

Before you start

You need a Zealous Markets account on the Pro or Enterprise plan.

1. Create a key

Sign in at zealous.markets and open Profile → API keys. Click Create key, give it a name, and copy the plaintext shown in the modal.

The plaintext is shown once. If you lose it, revoke the key and create a new one — the server only stores a salted hash. All keys are prefixed zm_live_.

2. Make your first request

Series endpoints take their parameters in a JSON request body via POST — this keeps long parameter sets out of the URL. Replace $ZM_KEY with the key you just minted.

shell
curl -s https://zealous.markets/api/v1/market/candlestick \
  -X POST \
  -H "Authorization: Bearer $ZM_KEY" \
  -H "Content-Type: application/json" \
  -d '{"exchange":"binance","symbol":"BTC-USDT","start":"2024-01-01","end":"2024-01-31"}' \
  | jq '.meta, .data[0:3]'

Returns a meta envelope and a data array of 31 daily candlesticks.

Or run the same request from the API Explorer — it picks up your minted key automatically.

3. Try TOON

Switch the response to TOON with one header — or a "format" field in the body — same data, fewer tokens.

shell
curl -s https://zealous.markets/api/v1/market/candlestick \
  -X POST \
  -H "Authorization: Bearer $ZM_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/toon" \
  -d '{"exchange":"binance","symbol":"BTC-USDT","start":"2024-01-01","end":"2024-01-31"}'

4. Check your usage

shell
curl -s https://zealous.markets/api/v1/me/usage \
  -H "Authorization: Bearer $ZM_KEY" | jq

Each request increments requests.used; each response body adds to bytes.used. Both reset at the start of every UTC month and are echoed on every response in the X-Quota-* headers.

Next