CryptoGrindCryptoGrindDocs
Open Dashboard

Getting started

Quickstart

Make your first request in under a minute. All you need is an API key and curl.

1. Get a key

Request access from the developers page. Once approved, create a key in your profile → API keys. The secret is shown once — store it safely.

2. Call an endpoint

Fetch the most recent spread events above 10%:

bash
curl -H "apikey: $CRYPTOGRIND_KEY" \
  "https://api.cryptogrindtrade.com/v1/spreads/recent?min_pct=10&spread_type=spot/futures"

3. Stream live

Open a WebSocket for live funding dislocations (Builder tier and up):

javascript
const ws = new WebSocket(
  "wss://api.cryptogrindtrade.com/v1/funding/live?min_delta_pct=2",
  // pass the key via a header-capable client, or Sec-WebSocket-Protocol
);
ws.onmessage = (e) => {
  const event = JSON.parse(e.data);
  console.log(event.base, event.delta_f_pct, event.time_to_funding_min);
};

Tip

Filter params mirror the platform's bot config 1:1 — anything you can set on a SpreadBot/XBot/FundingBot you can pass as a query param here. See each family's reference for the full list.

Next steps