CryptoGrindCryptoGrindDocs
Open Dashboard

API reference

Splash

Price-spike and dump events (pumps & crashes) detected on 1-second candles across CEX and DEX.

The canonical splash stream deliberately includes sub-threshold spikes (the bots use them for automation); the public feed re-gates on `min_pct`, so set it explicitly.

`kind` distinguishes `pump` from `dump`. `max_window_s` caps how fast the move happened.

GET recent

Last ≤500 splash events in memory, filtered.

GET/v1/splash/recent

Tier: machine-dev (delayed) · builder+

Query parameters

ParameterTypeDescription
kindstringpump | dump.
min_pctfloatMinimum absolute percent move.
max_pctfloatMaximum absolute percent move.
max_window_sfloatCap on the spike window in seconds.
marketstringspot | futures.
exchangestringExact exchange.
symbolstringExact symbol.
exclude_symbolstringBlacklist a symbol.
min_volume_24hfloatMinimum 24h volume.
delayint (s)Hide events fresher than N seconds. Your tier clamps the minimum (see Access tiers).
limitintMax events to return. Capped server-side (recent ≤ 500, history per-tier).

Response

json
{
  "meta": { "trace": "c_4f2a…", "as_of": 1781000000.42, "count": 1, "delay_seconds": 0 },
  "data": [
    {
      "received_at": 1781000000.0,
      "id": "x_8821",
      "symbol": "PEPE_USDT",
      "exchange": "BINANCE",
      "market": "futures",
      "kind": "pump",
      "pct": 11.4,
      "window_s": 42,
      "start_price": 0.0000089,
      "spot_price": 0.00000991,
      "futures_price": 0.00000994,
      "volume_24h": 18250000.0,
      "source": "xbot",
      "timestamp": 1781000000
    }
  ]
}

GET history

Durable splash event log, keyset-paginated.

GET/v1/splash/history

Tier: machine-dev (delayed) · builder+

Query parameters

ParameterTypeDescription
kindstringpump | dump.
min_pctfloatMinimum absolute move.
marketstringspot | futures.
sinceint (ts)Return events at or after this unix timestamp.
beforeint (ts)Keyset pagination cursor — return events strictly older than this unix timestamp.
limitintMax events to return. Capped server-side (recent ≤ 500, history per-tier).

Response

json
{ "meta": { "trace": "c_4f2a…", "count": 100, "next_before": 1780990000 }, "data": [ /* splash events */ ] }

WS live

Filtered live splash stream.

WS/v1/splash/live

Tier: builder+

Query parameters

ParameterTypeDescription
kindstringpump | dump.
min_pctfloatMinimum move.
max_pctfloatMaximum move.
exchangestringExact exchange.
delayint (s)Hide events fresher than N seconds. Your tier clamps the minimum (see Access tiers).

Response

json
// Typed event frame (curated event under "data"):
{ "type": "event", "family": "splash", "received_at": 1781000000.0,
  "data": { "id": "x_8821", "symbol": "PEPE_USDT", "kind": "pump", "pct": 11.4, "window_s": 42, "exchange": "BINANCE", "timestamp": 1781000000 } }

Event fields

Payloads are curated — only the fields below are exposed. New upstream fields never leak by default (allowlist policy). Every response carries a per-consumer trace watermark.

ParameterTypeDescription
kindstringpump | dump.
pctfloatSigned percent move over the window.
window_sintSeconds the move took.
start_price / spot_price / futures_pricefloatWindow-start and current prices.
volume_24hfloat24h quote volume.
extra.cex_metaobject?Leverage cap, funding, max size (when available).