API Reference
Endpoints grouped by data domain. Open a detail page for summary, parameters, response schema, examples, error codes, and Try it.
Market & Liquidity
Prices, klines, and books — crypto live; US/HK snapshot, kline, top-of-book
- GETReal-time market snapshot/api/v1/markets/snapshot— Query the latest price, change, volume, and order-book summary for an asset or listing.market_data_query (task=snapshot)Asset
- GETHistorical candlesticks (OHLCV)/api/v1/markets/kline— Query the OHLCV candle series for a trading object over the selected interval and time range.market_data_query (task=kline)listing-level
- GETLive order book/api/v1/markets/order-book/current— Query current bid and ask levels, best prices, and the mid-price for a trading object.market_data_query (task=orderbook)listing-level
- GETRecent trades/api/v1/markets/trades/recent— Query recent individual trades for a trading object, including price, size, side, and time.market_data_query (task=trades)listing-level
- GETExchange token liquidity history/api/v1/markets/liquidity/history— Query historical token liquidity changes within exchanges.market_data_query (task=liquidity)listing-level
- GETAggregated market depth/api/v1/markets/cex-depth— Query crypto spot and perpetual bid, ask, and two-sided order-book depth snapshots within a fixed ±2% price band.market_data_query (task=depth)Asset
- GETDerivatives metrics/api/v1/markets/derivatives— Query perpetual funding rates, USD open interest, long-short ratios, and liquidation time series by asset and venue.market_data_query (task=derivatives)Asset
- GETPer-exchange derivatives/api/v1/markets/cex-derivatives— Query historical derivatives volume, open interest, market counts, and fees by centralized exchange.market_data_query (task=cex_derivatives)Aggregate
- GETDerivatives · Liquidation heatmap/api/v1/markets/liquidation-heatmap— Query long and short liquidation intensity across price levels for a trading object, for a liquidation heatmap.market_data_query (task=liquidation_heatmap)Asset
- GETDerivatives · Liquidation events/api/v1/markets/derivatives/liquidations— Query executed derivatives liquidation events by venue, pair, position side, and notional value.market_data_query (task=liquidations)Asset
- GETDerivatives · Liquidation aggregates/api/v1/markets/derivatives/liquidations/aggregates— Query aggregated long and short liquidation data at different time granularities for a pair or a coin across venues.market_data_query (task=liquidation_aggregates)Asset
- GETDEX pair trades/api/v1/markets/dex/trades— Query a token’s DEX buy and sell trades.market_data_query (task=dex_trades)Asset
- GETDEX pool liquidity events/api/v1/markets/dex/liquidity-events— Query DEX pool liquidity additions and removals for a token.market_data_query (task=dex_liquidity_events)Asset
- GETPerp DEX overview/api/v1/markets/dex-derivatives— Query protocol-level Perp DEX volume and open-interest snapshots.market_data_query (task=dex_derivatives)Aggregate
- GETCoin rankings/api/v1/markets/rankings— Query crypto rankings for CEX and DEX assets, sorted by metrics such as 24-hour trading volume.market_data_query (task=rankings)Aggregate
- GETCrypto market overview/api/v1/market-overview— Get a snapshot of the crypto market and sentiment.market_data_query (task=market_overview)Aggregate
- GETGlobal market cap history/api/v1/global-market-cap-chart— Query global crypto market cap and volume history.market_data_query (task=crypto_global_marketcap)Aggregate
- GETIndicator history/api/v1/markets/indicator-history— Query historical series for selected technical indicators.REST-onlyAsset
- GETTrend candles/api/v1/markets/trend-kline— Query trend candles with optional technical indicators.market_data_query (task=trend_kline)Asset
- GETTechnical analysis/api/v1/markets/technical-analysis— Query technical analysis across timeframes.market_data_query (task=technical_analysis)Asset
Coverage:Major crypto venues. Equities (us_equity / hk_equity): snapshot, kline, top-of-book with market=. Trades, depth, derivatives, liquidations: crypto-only. · MCP prefix: /mcp/markets
Prediction
Events, markets, rankings, order books
- GETPrediction events/api/v1/prediction/events— Query tradable prediction events.prediction_markets_query (task=search)Query object
- GETTrending event rankings/api/v1/prediction/rankings— View trending prediction-event rankings.prediction_markets_query (task=rankings)Aggregate
- GETEvent Signal/api/v1/prediction/events/{event_id}/signal— Query event probability and volume change.prediction_markets_query (task=event_signal)Query object
- GETCurrent Order Book/api/v1/prediction/order-book/current— Get the current prediction-market order book.prediction_markets_query (task=order_book)listing-level
Coverage:Events and rankings across Polymarket and predict.fun. Live order book: Polymarket this phase. · MCP prefix: /mcp/signals
Asset & Entity
Assets, companies, protocols, chains, venues
- GETAsset & entity search/api/v1/assets/search— Search assets, entities, and contract information.assets_resolve (task=search)Query object
- GETAsset profile/api/v1/assets/{asset_id}— Get the full profile for a single asset.assets_resolve (task=profile)Query object
- POSTResolve asset objects/api/v1/assets/resolve— Resolve asset objects and retrieve crypto project details.assets_resolve (task=auto)Query object
- GETAsset listings & Gate mapping/api/v1/assets/{asset_id}/listings— View listing information and Gate mappings.assets_resolve (task=listings)Query object
- GETEntity profile/api/v1/entities/{entity_id}— Get a company, project, or protocol profile.Coming soonREST-onlyQuery object
- GETInstrument details/api/v1/instruments/{instrument_id}— Get instrument details and identifiers.Coming soonREST-onlyinstrument-level
- GETVenue reference/api/v1/venues/{venue_id}— Get venue reference data.Coming soonREST-onlyQuery object
- GETCatalog object types/api/v1/catalog/object-types— View supported object types.Coming soonREST-onlyQuery object
Coverage:Mainstream crypto assets, top public companies, major chains / venues / protocols. · MCP prefix: /mcp/assets
Fundamentals
Company profiles, statements, metrics, corporate actions, tokenomics and macro indicators.
- GETFundamentals query/api/v1/fundamentals/query— Query fundamentals in a unified way by task.fundamentals_query (task=auto)Query object
- GETCompany profile/api/v1/fundamentals/profile— Query basic profile data for a public company.fundamentals_query (task=profile)Query object
- GETFinancial statements/api/v1/fundamentals/statements— Get the three financial statements.fundamentals_query (task=statements)Query object
- GETFinancial metrics/api/v1/fundamentals/metrics— Query key financial metrics for a company.fundamentals_query (task=metrics)Query object
- GETValuation metrics/api/v1/fundamentals/valuation-metrics— Query valuation metrics for a company.Coming soonfundamentals_query (task=metrics)Query object
- GETBusiness segments/api/v1/fundamentals/business-segments— Query operating data by business segment.fundamentals_query (task=segments)Query object
- GETCorporate actions/api/v1/fundamentals/corporate-actions— Query splits, dividends, and other corporate actions.fundamentals_query (task=corporate_actions)Query object
- GETTokenomics/api/v1/fundamentals/tokenomics— Query tokenomics and unlock data.fundamentals_query (task=tokenomics)Asset
- GETToken supply/api/v1/fundamentals/supply— Query token supply data.fundamentals_query (task=tokenomics)Asset
- GETMacro indicator/api/v1/fundamentals/macro-indicator— Query a macro indicator for a country.fundamentals_query (task=macro_indicator)Aggregate
- GETMacro summary/api/v1/fundamentals/macro-summary— Get key macro indicators and upcoming economic events.fundamentals_query (task=macro_summary)Aggregate
Coverage:US/HK public company profiles, statements, and metrics; crypto tokenomics batch snapshots. · MCP prefix: /mcp/assets
Estimates & Earnings
Earnings calendar, reported results, and consensus
- GETEarnings calendar/api/v1/earnings/calendar— Query the earnings event calendar.estimates_earnings_query (task=calendar)Asset
- GETEarnings results/api/v1/earnings/results— Compare reported earnings with estimates.estimates_earnings_query (task=results)Asset
- GETConsensus estimates/api/v1/estimates/consensus— Query consensus estimates for earnings and revenue.estimates_earnings_query (task=consensus)Asset
- GETEarnings transcripts/api/v1/earnings/transcripts— Get earnings-call transcripts.Coming soonestimates_earnings_query (task=transcript)Asset
- GETEarnings Screener/api/v1/earnings/screener— Query reported earnings and estimates by reporting period for a single stock.REST-onlyAsset
Coverage:US-equity earnings calendar, reported results, and consensus. · MCP prefix: /mcp/assets
Network & Protocol
Stablecoin supply, bridges, exchange reserves, yield pools, DeFi, chain activity and protocol history.
- GETDeFi overview/api/v1/onchain/defi-overview— Query DeFi TVL, USD-pegged stablecoin supply, DEX volumes, categories and top chains.defi_overview (range=latest)Aggregate
- GETDeFi overview history/api/v1/onchain/defi-overview/history— Query daily DeFi TVL, stablecoin supply and DEX volume snapshots over a historical window.defi_overview (range=window)Aggregate
- GETStablecoin supply/api/v1/onchain/stablecoins— Query circulating stablecoin supply and its per-chain distribution.stablecoin_supplyQuery object
- GETExchange reserves/api/v1/onchain/exchange-reserves— Query the all-exchange BTC reserve total or reserves for one exchange and asset.exchange_reservesQuery object
- GETCross-chain bridges/api/v1/onchain/bridges— Query bridge-volume rankings, covered chains and snapshot times.bridge_flowsQuery object
- GETYield pools/api/v1/onchain/yield-pools— Query DeFi pool TVL, annual percentage yields and pool attributes.yield_poolsQuery object
- GETChain activity/api/v1/onchain/chains/{chain_id}/activity— Query daily active addresses and transaction counts for a chain.onchain_query (task=chain_activity, range=latest)Query object
- GETChain activity history/api/v1/onchain/chains/{chain_id}/activity/history— Query daily active addresses and transaction counts over a historical window.onchain_query (task=chain_activity, range=window)Query object
- GETToken on-chain activities/api/v1/onchain/token-activities— Query CEX flows, DEX trades and liquidity events for token deployments.REST-onlyQuery object
- GETProtocol profile/api/v1/protocols/{protocol_id}— Query a protocol profile, latest TVL and per-chain TVL.defi_protocol (range=latest)Query object
- GETProtocol history/api/v1/protocols/{protocol_id}/history— Query daily protocol TVL over a historical window.defi_protocol (range=window)Query object
- GETChain activity metrics/api/v1/onchain/chain-metrics— Query staking and layer-two network metrics.onchain_query (task=chain_activity)Aggregate
- GETPlatform overview/api/v1/platforms/overview— Query aggregate market metrics by platform category.onchain_query (task=overview)Aggregate
- GETPlatform profile/api/v1/platforms/profile— Query a platform’s profile and metrics.onchain_query (task=profile)Aggregate
- GETPlatform rankings/api/v1/platforms/rankings— Rank platforms by category and chain.onchain_query (task=rankings)Aggregate
Coverage:Coverage by object type: stablecoin / chain / bridge / exchange / yield pool / protocol. · MCP prefix: /mcp/onchain
Flows & Wallets
Institutional and insider ownership, fund holdings, short data, crypto treasuries, ETFs, token holders, wallets and flows.
- GETCrypto asset treasuries/api/v1/treasury— Query corporate and government crypto reserves, totals, and holder details.ownership_flows_query (task=treasuries)Asset
- GETCrypto ETFs/api/v1/crypto-etf— Query crypto ETF totals, individual funds, and asset-level historical net flows.ownership_flows_query (task=crypto_etf)Asset
- GETToken holders/api/v1/onchain/holders— Query holder distribution and concentration.ownership_flows_query (task=holders)Asset
- GETWallet intelligence/api/v1/wallets/{address}— Query wallet balances, labels, and P&L.ownership_flows_query (task=wallet_profile)Query object
- GETExchange token flows/api/v1/flows/token-transfers— Query on-chain token transfers for exchange flow analysis.ownership_flows_query (task=exchange_flows)Asset
- GETInstitutional ownership/api/v1/ownership/institutional— Query institutional stock positions and quarterly aggregates.ownership_flows_query (task=institutional)Asset
- GETInsider activity/api/v1/ownership/insiders— Query insider transactions.ownership_flows_query (task=insiders)Asset
- GETShort Interest/api/v1/ownership/short-interest— Query stock short positions and availability.ownership_flows_query (task=short_interest)Asset
- GETWallet Transactions/api/v1/wallets/transactions— Query wallet trades and transfers.ownership_flows_query (task=wallet_transactions)Query object
- GETMoney Flow/api/v1/flows/money— Query daily northbound and southbound Stock Connect flows.ownership_flows_query (task=money_flow)Aggregate
- GETETF / Fund Holdings/api/v1/funds/holdings— Query ETF holdings, weights and batch summary.ownership_flows_query (task=fund_holdings)Asset
- GETShort Flow/api/v1/ownership/short-flow— Query daily short-sale volume and ratios.ownership_flows_query (task=short_flow)Asset
- GETCrypto institutional metrics/api/v1/crypto-institutional-metrics— Query BTC and ETH ETF, CME and CFTC metrics.Coming soonownership_flows_queryAggregate
Coverage:Address / holdings / fund flows on major EVM chains and Solana. · MCP prefix: /mcp/onchain
Events, News, Sentiment & Signals
News, events, sentiment, and social posts
- GETNews / content search/api/v1/news/search— Search structured market news.events_news_query (task=content_search)Asset
- GETCanonical event search/api/v1/events— Query market and macro events.events_news_query (task=event_search)Asset
- GETSentiment query/api/v1/signals/sentiment— Query social and market sentiment.events_news_query (task=sentiment)Asset
- GETSocial / UGC search/api/v1/signals/ugc/search— Search social posts related to a ticker.events_news_query (task=social_search)Asset
Coverage:News search, events, social sentiment, and social posts. Stock ratings, announcements, and anomaly signals are not in this release. · MCP prefix: /mcp/signals
Risk & Compliance
Open-interest history and snapshots for supported perpetuals, plus token contract security.
- GETRisk observations/api/v1/risk/observations— Query open-interest observations for supported perpetual listings.risk_compliance_query (task=observations)Query object
- GETRisk snapshot/api/v1/risk/snapshot— Query the latest available risk observation at or before an as-of time.risk_compliance_query (task=snapshot)Query object
- GETToken security/api/v1/risk/token-security— Check token contract security, trading taxes and risk-summary fields.risk_compliance_query (task=token_security)Query object
- GETRisk events/api/v1/risk/events— Query risk events; event-data coverage is limited.Coming soonrisk_compliance_query (task=events)Query object
- GETAddress risk screening/api/v1/risk/address— Screen on-chain address risk.Coming soonREST-onlyQuery object
- GETContract security/api/v1/risk/contract— Assess token or contract security risk.Coming soonREST-onlyQuery object
- GETDisclosures/api/v1/disclosures— Query aggregated disclosure records.Coming soonREST-onlyQuery object
- GETSEC filings/api/v1/disclosures/sec-filings— Query US SEC filings.Coming soonREST-onlyQuery object
- GETPolitical disclosures/api/v1/disclosures/political— Query political and lobbying disclosures.Coming soonREST-onlyQuery object
- GETRegulatory events/api/v1/regulatory/events— Query regulatory and enforcement events.Coming soonREST-onlyQuery object
- GETGovernance events/api/v1/governance/events— Query on-chain and corporate governance events.Coming soonREST-onlyQuery object
Coverage:Open interest covers selected perpetual listings; history and freshness vary. Token security depends on chain and contract address. Risk Events accepts queries with limited data coverage. · MCP prefix: /mcp/signals
Coverage matrix
Asset types and source layers covered per domain today.
| Domain | Core | Top 100 | History | MCP |
|---|---|---|---|---|
| Market & Liquidity | ||||
| Prediction | ||||
| Asset & Entity | ||||
| Fundamentals | ||||
| Estimates & Earnings | ||||
| Network & Protocol | ||||
| Flows & Wallets | ||||
| Events, News, Sentiment & Signals | ||||
| Risk & Compliance | Selected perpetual open interest and token contract security | — | OI history and as-of snapshots for supported listings | risk_compliance_query |
Top 100 means CoinMarketCap market-cap top 100. Read each endpoint’s data_status, empty_reason and missing fields; Risk uses its own empty-result rules. Risk empty-result rules