CryptoGrindCryptoGrindDocs
Open Dashboard

API reference

Funding

Cross-exchange funding-rate dislocations (ΔF) and perp↔spot hedge opportunities.

`alert_type` is `cross` (two venues' funding diverge) or `spot_hedge` (perp vs spot on one venue). `delta_f_pct` is the headline edge.

Advice-flavored fields (expected PnL, safety ratio) are intentionally stripped from the public feed — you get the raw rates and timing to compute your own.

GET recent

Last ≤500 funding events in memory, filtered.

GET/v1/funding/recent

Tier: machine-dev (delayed) · builder+

Query parameters

ParameterTypeDescription
min_delta_pctfloatMinimum ΔF percent.
funding_typestringcross | spot_hedge.
max_time_to_funding_minfloatOnly opportunities settling within N minutes.
basestringExact base asset, e.g. BTC.
exclude_basestringBlacklist a base.
exchangestringMatch either leg.
min_volume_usdfloatMinimum leg volume in USD.
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,
      "key": "ORBS:KUCOIN:KUCOIN",
      "alert_type": "spot_hedge",
      "base": "ORBS",
      "long_exchange": "KUCOIN",
      "short_exchange": "KUCOIN",
      "long_rate": 0.0,
      "short_rate": 0.0225,
      "delta_f": 0.0225,
      "delta_f_pct": 2.25,
      "entry_spread_pct": 0.0,
      "funding_next_ts": 1781001633,
      "time_to_funding_min": 27,
      "timestamp": 1781000000
    }
  ]
}

GET history

Durable funding event log, keyset-paginated.

GET/v1/funding/history

Tier: machine-dev (delayed) · builder+

Query parameters

ParameterTypeDescription
funding_typestringcross | spot_hedge.
min_delta_pctfloatMinimum ΔF.
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": [ /* funding events */ ] }

WS live

Filtered live funding stream.

WS/v1/funding/live

Tier: builder+

Query parameters

ParameterTypeDescription
min_delta_pctfloatMinimum ΔF.
funding_typestringcross | spot_hedge.
basestringExact base.
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": "funding", "received_at": 1781000000.0,
  "data": { "base": "ORBS", "alert_type": "spot_hedge", "delta_f_pct": 2.25, "long_exchange": "KUCOIN", "short_exchange": "KUCOIN", "time_to_funding_min": 27 } }

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
alert_typestringcross | spot_hedge.
basestringBase asset.
long_exchange / short_exchangestringVenues for the long / short leg.
long_rate / short_ratefloatPer-venue funding rates (decimal).
delta_f / delta_f_pctfloatFunding edge (decimal / percent).
funding_next_tsintNext settlement unix timestamp.
time_to_funding_minintMinutes to next settlement.