coinglass

Crypto derivatives data: funding rates, open interest, liquidations, long/short ratios. Use when researching perp markets, tracking Hyperliquid whale positions, or comparing ETF flows (e.g. BTC funding, ETH OI, liquidation heatmap).

By starchild-ai-agent · 11,432 installs

npx skills add starchild-ai-agent/official-skills --skill coinglass

Source repository · Upstream listing

Plan Tiers (platform key = Startup, verified 2026 09) The platform injected COINGLASS API KEY is on the Startup plan. Actual endpoint access at the tool layer: ✅ Available on Startup (normal data): Funding rates(v2/v4)、Supported coins/exchanges/pairs、Pairs markets Open interest (current / OHLC history / aggregated history) Long/Short ratios(global / top account / top position) Taker buy/sell volume (single exchange + aggregated; aggregated needs exchange list ) CVD、Net position(v1/v2)、Coin netflow Liquidations: coin list, coin/pair history (pair needs BTCUSDT format), aggregated history (needs exchange list ) ETF flows / lists / premium(BTC、ETH、SOL、XRP、HK) Whale transfers, Hyperliquid whale alerts (alert feed only) Price history (symbol must be pair format, e.g. BTCUSDT) ❌ Not available on Startup (401 "Upgrade plan" — skip these, don't call): api/futures/coins markets (all coin market summary, i.e. cg coins market data ) — do not call ; use "Full market / multi coin OI routing" below api/futures/liquidation/order (individual liquidation orders) api/futures/liquidation/heatmap/model1 + aggregated heatmap/model1 ( liquidation heatmap is entirely unavailable ) api/hyperliquid/position , api/hyperliquid/wallet/position distribution (Hyperliquid position distribution; only whale alerts work) Alternatives (in priority order) : 1. User supplies their own key (Basic+ plan): set COINGLASS API KEY and call https://open api v4.coinglass.com directly, bypassing sc proxy (sc proxy overwrites that header, so a user key has no effect on the proxied path). 2. Apify scraper : use the apify skill to scrape the liquidation heatmap / Hyperliquid position pages on coinglass.com. On a 401 "Upgrade plan" response, cg request raises CoinglassPlanError , and the error message already includes this guidance. Full market / multi coin OI routing (coins markets unavailable) Need Use Notes Current OI and 4h/24h change for one coin cg open interest(symbol) (take the exchangeName=="All" row) Works on Startup Funding for one coin funding rate(symbol) Returns a string with % OI history across coins Per coin OI history, summed by timestamp Label it "Top N aggregate" with the bar interval; never present it as full market Full market current OI total / current OI per coin coingecko skill cg derivatives(include tickers='unexpired') : keep contract type=="perpetual" , sum open interest (USD) by index id Exchange reported, includes small exchanges, runs higher than CoinGlass; current values only, no history; always cite the source in charts and text Do not plot numbers from different sources (CoinGlass Top N, CoinGecko full market, Bloomberg or other third parties) on one chart as comparison or reference lines. Liquidation Heatmap (❌ not available on Startup — archived usage) cg liquidation analysis returns all zeros and is unusable. Both heatmap endpoints ( heatmap/model1 and aggregated heatmap/model1 ) return 401 Upgrade plan on the Startup plan. If heatmap data is needed: have the user bring a Basic+ key and call directly (see Alternatives above), or scrape the page with Apify. Script Usage Script mode skill — read this file, then invoke from a bash block: Read exports.py for the full list of available functions and exact signatures. Common ones: funding rate , long short ratio , cg open interest , cg liquidations , cg liquidation analysis , cg global account ratio , cg top account ratio , cg top position ratio , cg taker exchanges , cg net position , cg supported coins , cg supported exchanges , cg coins market data , cg pair market data , cg ohlc history , cg hyperliquid whale alerts , cg hyperliquid whale positions , cg taker volume history , cg aggregated taker volume , cg cumulative volume delta , cg coin netflow , cg whale transfers , cg btc etf flows , cg eth etf flows , cg sol etf flows . Coinglass Coinglass provides the most comprehensive crypto derivatives and institutional data available. 37 tools covering futures positioning, whale tracking, volume analysis, liquidations, and ETF flows. API Plan : Startup (platform key downgraded; see "Plan Tiers" at the top) Rate Limit : request limits are lower on this plan; keep batch calls modest API Version : V4 (with V2 backward compatibility) Total Tools : 37 across 8 categories Function Reference (full signatures + return shapes) All functions live in exports.py . Most return Optional[List[Dict]] or Optional[Dict] . None means the upstream call failed or returned empty — always check before indexing. ⚠️ Field naming convention (READ THIS FIRST) CoinGlass v4 API uses camelCase for almost all data fields, with a few legacy snake case exceptions in liquidation endpoints. Don't assume snake case — inspect the dict before scripting. camelCase: openInterest , volUsd , longRate , shortVolUsd , exchangeName , nextFundingTime , fundingIntervalHours , oichangePercent , h4OIChangePercent , avgFundingRateBySymbol , tokenAmount , liquidationUsd (in some endpoints) snake case (legacy, only in cg liquidations ): liquidation usd , longLiquidation usd , shortLiquidation usd rate fields (funding) are STRINGS with "+" / " " / "%" — parse with float(r.rstrip('%').lstrip('+')) to compare numerically avgFundingRateBySymbol (in cg open interest rows) is a NUMBER that is already in percent — 0.005313 means 0.0053%/8h. Do NOT multiply by 100. Sanity bound: BTC funding is normally around ±0.01%/8h; anything above ~0.1%/8h is almost certainly a unit bug. timestamps are millisecond unix epoch (e.g. 1777881600000 ) Funding & Open Interest Function Signature funding rate(symbol, exchange=None) dict — keys: symbol , exchange , rate (str), num exchanges , exchanges data (list of { exchangeName , rate , nextFundingTime , fundingIntervalHours , status }) cg open interest(symbol='BTC', interval='0') LIST of dicts (one per exchange) — keys: symbol , openInterest , volUsd , oichangePercent , h4OIChangePercent , h24VolChangePercent , volChangePercent7d , avgFundingRateBySymbol , exchangeName , exchangeLogo Long/Short Ratios Function Signature long short ratio(symbol='BTC', interval='h4') LIST — top item is aggregated; list field inside has per exchange breakdown. Keys: longRate , shortRate , longVolUsd , shortVolUsd , totalVolUsd , list cg global account ratio(symbol='BTC', exchange='Binance', interval='1h') list of historical bars cg top account ratio(symbol='BTC', exchange='Binance', interval='1h') list — top trader account count ratio cg top position ratio(symbol='BTC', exchange='Binance', interval='1h') list — top trader position size ratio cg taker exchanges(symbol='BTC', range type='4h') list — taker buy/sell across exchanges cg net position(symbol='BTC', exchange='Binance', interval='1h') list — net long short USD over time Liquidations Function Signature cg liquidations(symbol='BTC', time type='h24') LIST of dicts (one per exchange + an 'All' row first). Keys: exchange , liquidation usd , longLiquidation usd , shortLiquidation usd (NOTE: snake case legacy fields) cg liquidation analysis(symbol='BTC', time type='h24') dict — aggregated network wide stats cg coin liquidation history(symbol='BTC', interval='h4') list — historical liq bars cg pair liquidation history(symbol='BTC', exchange='Binance', interval='h4') list — historical liq for one pair on one exchange cg liquidation coin list(symbol=None) list of all coins with liq summary cg liquidation orders(symbol='BTC', exchange=None) list — recent individual liq orders Futures Market Data Function Signature cg supported coins() List[str] — symbols supported by CoinGlass cg supported exchanges() list of exchange info dicts cg coins market data(symbol=None) ❌ Not available on Startup (401) — see "Full market / multi coin OI routing" cg pair market data(symbol='BTC', exchange=None) list — pair level snapshot cg ohlc history(symbol='BTC', interval='h4', exchange=None) list of OHLCV bars Hyperliquid Whale Tracking Function Signature cg hyperliquid whale alerts() list — recent large position alerts cg hyperliquid whale positions() list — current open whale positions cg hyperliquid positions by coin(symbol='BTC') list — whales holding a specific coin cg hyperliquid position distribution(symbol='BTC') dict — long/short position size distribution Volume / Flow Function Signature cg taker volume history(symbol='BTC', exchange='Binance', interval='1h', limit=1000, start time=None, end time=None) list — taker buy/sell volume bars cg aggregated taker volume(symbol='BTC', interval='h4') list — aggregated across all exchanges cg cumulative volume delta(symbol='BTC', exchange='Binance', interval='1h', limit=1000, start time=None, end time=None) list — CVD bars cg coin netflow(symbol=None) list — net inflow/outflow per coin cg whale transfers() dict — recent on chain large transfers ETF Flows Function Signature cg btc etf flows() list — daily flows per US BTC ETF cg btc etf history(etf ticker=None) list — historical AUM/flows cg btc etf list() list of BTC ETF tickers + AUM cg btc etf premium discount() list — premium/discount % vs NAV cg hk btc etf flows() list — Hong Kong BTC ETF flows cg eth etf flows() / cg eth etf list() / cg eth etf premium discount() / cg hk eth etf flows() ETH ETF equivalents cg sol etf flows() / cg sol etf list() SOL ETF data cg xrp etf flows() / cg xrp etf list() XRP ETF data Sample responses (most used functions) funding rate(symbol="BTC") : cg liquidations(symbol="BTC", time type="h24") : cg open interest(symbol="BTC") : long short ratio(symbol="BTC", interval="h4") : Tool Selection Guide Decision Tree Step 1: Is this about LIQUIDATIONS? Step 2: Is this about LONG/SHORT RATIO? Step 3: Is this about OPEN INTEREST? Step 4: Is this a MARKET OVERVIEW / SENTIMENT query? Keyword → Tool Lookup Keyword / Pattern Correct Tool ❌ Do NOT use liquidation ranking / today's liquidations / all coins liquidation cg liquidation coin list cg liquidations 24h liquidation summary cg liquidation coin list cg liquidation analysis global account L/S ratio cg global account ratio long short ratio top trader L/S ratio cg top account ratio long short ratio open interest cg open interest cg coins market data market sentiment / positioning analysis funding rate + long short ratio + cg open interest cg coins market data BTC long pre trade checklist funding rate + cg global account ratio + cg liquidation coin list — Common Mistakes Mistake 1 (most common — 8x failure): Using cg liquidations when you need cg liquidation coin list cg liquidations → one coin, one timeframe, basic total only cg liquidation coin list(exchange) → ALL coins, multi timeframe (1h/4h/12h/24h), per exchange breakdown Rule: If the question asks for a ranking, overview, or doesn't specify a single coin → use cg liquidation coin list Mistake 2 (5x failure): Using cg liquidation analysis for liquidation rankings cg liquidation analysis adds a sentiment label to a single coin total — it is NOT a ranking tool Rule: "today's liquidation ranking" / "liquidations by coin" → always cg liquidation coin list Mistake 3 (3x failure): Using long short ratio for historical L/S analysis long short ratio is a curren