Surf

Durably request cancellation of an asynchronous blockchain SQL job and return its current state. Queued jobs become canceled immediately; running queries stop asynchronously, so poll the job until it is canceled or failed.

Submit a read-only ClickHouse SQL query for durable background execution and return its stable job and query identifiers immediately. Equivalent retained queries with the same max_rows, or requests reusing an Idempotency-Key, return the existing job.

Return USD DEX-pool-weighted OHLCV bars for one token identified by chain and contract address. Use this for DEX-native or newly launched tokens; use the standard market price action for major listed assets.

Return standardized balance-sheet periods for a US-listed equity. Each metric includes an availability status, and unavailable values are null.

Return historical OHLCV candles and the latest traded price for a US-listed equity. Candles are ordered by timestamp ascending; historical data and the latest price use independent freshness windows.

Return paginated standardized cash-flow periods for a US-listed equity. The response preserves serving-layer values, status, origin, and period metadata.

Return a standardized stock company profile or ETF product profile, including its business description and source-update metadata.

Return paginated standardized financial ratios, growth measures, per-share values, and valuation metrics for a US-listed equity.

Return standardized income-statement periods for a US-listed equity. The API passes through available periods and does not synthesize missing periods or financial values.

Return the most recently accepted periodic SEC filings across US equities. Includes 10-K, 10-Q, 20-F, 40-F and amendments, excludes 8-K, and returns one filing per reporting series.

Return the most recently published current-serving TTM financials across US equities, optionally filtered by a minimum current market capitalization. Results contain one company per reporting series.

Return lightweight identity, logo, and latest USD price metadata for one or more US-listed stocks or ETFs. Symbols are returned in request order. Company and fund identity is cached for 24 hours; prices are cached independently for 1 minute.

Return a paginated financial overview for a US-listed equity. Values are served as reported or derived by the financial-data serving layer; missing values remain explicit nulls and are not recalculated by this API.

Return bid and ask order-book levels for an exchange market, including spread, spread percentage, mid-price, and total bid and ask depth.

Return historical funding rate records for a perpetual contract.

Return exchange OHLCV candlesticks with high, low, and total-volume statistics for the returned period. Set `type` to a perpetual-market variant to query perpetual contracts instead of spot markets.

Return historical long/short ratios for a perpetual contract.

Return trading pairs available on an exchange, including base and quote currencies, market type, active status, and default fee rates. Use the returned pair values with other exchange actions.

Return a perpetual futures snapshot for a trading pair, including current funding, open interest, mark price, and index price data.

Return the real-time ticker for an exchange trading pair, including the last price, best bid and ask, 24-hour high, low, volume, and price change.

Return a crypto VC fund's full profile, including its description, jurisdiction, unique invested-project count, links, X accounts, team members, and recent research. This does not return individual investments.

Return a Hyperliquid wallet's point-in-time portfolio across perpetuals, spot, vaults, and HYPE staking. Use total_value_usd for the best-effort whole-account value and unpriced_token_count to determine whether it excludes unpriced spot holdings.

Return Hyperliquid market OHLCV candles ordered by open time ascending for a required half-open [from_, to) window. The window may contain at most 5,000 candles, so use a larger interval or narrower dates for long histories. This market-data action does not require a wallet address.

Return a wallet's live resting orders and recent terminal orders. Use the open section to inspect active stops, take-profits, and limits, and the historical section for final filled, canceled, or rejected statuses.

Return a wallet's lifetime funding-excluded realized trading performance, live open positions, unrealized PnL, and perpetual clearinghouse equity. This point-in-time summary has no date window or trade list; use account portfolio data when spot and vault equity must be included.

Return a wallet's open Hyperliquid perpetual positions with leverage, unrealized PnL, ROE, funding, liquidation risk, and its cross-margin summary. When a cross position has no liquidation price, use the account-level margin_ratio as the liquidation-proximity signal.

Return immutable funding and leverage context for one closed Hyperliquid trade using the composite key from the trades action. Use funding_status to distinguish a real zero from unavailable funding history; leverage fields may be omitted when the completed-trade source has no value.

Aggregate a wallet's closed Hyperliquid trades by UTC day, symbol, direction, notional-size tier, or holding-time tier. Returns server-side P&L, fee, funding-coverage, win-rate, and volume rollups in one bounded, non-paginated response; use daily groups for a realized equity curve.

Return daily open-interest history for one Kalshi market over a selected time window. Data refreshes approximately every 30 minutes.

Return hourly or daily OHLC price history for one Kalshi market, or the latest price from recent trades. Surf refreshes this data about every 30 minutes.

Return daily notional trading-volume history for one Kalshi market over a selected time window. Surf refreshes this data about every 30 minutes.

Return daily spot ETF flow history for BTC, ETH, XRP, SOL, or HYPE, including net USD flow, closing token price, settlement status, and per-ticker flow breakdowns.

Return Bitcoin Fear and Greed Index history, including each 0-100 index value, its classification, and the Bitcoin price at that time. Results are sorted newest first and can be bounded by a date or Unix-time range.

Return a single ranked snapshot of futures market data across all tracked tokens, including open interest, funding rate, long/short ratio, and 24-hour volume. The endpoint returns the complete list and does not support symbol filtering or pagination.

Return time-bucketed aggregate long- and short-side liquidation volumes for a token on a specific exchange and interval.

Return a single ranked snapshot of total, long-side, and short-side liquidation volumes by exchange for a token and aggregation window.

Return daily on-chain indicator history for BTC or ETH, including NUPL, SOPR, MVRV, Puell Multiple, NVM, NVT, NVT Golden Cross, and exchange-flow metrics. Responses are capped at about 100 points; when meta.has_more is true, split the requested date range into smaller windows.

Return options market data for one supported token, including open interest, 24-hour volume, put/call ratio, and max pain price by exchange.

Return historical prices for one listed token in a selected quote currency. Use a predefined window or paired custom bounds; Surf automatically chooses 5-minute, hourly, or daily granularity based on the range.

Return a technical indicator for a trading pair on a given exchange and candlestick interval. Omit from_ and to for the latest value, or provide a time range for a bounded series.

Return public sale information for a project resolved by Surf UUID, name, or token symbol, including sale type, status, dates, token price, funds raised, supply allocation, launchpad, and all-time-high ROI.

Return Token Generation Event status for a project resolved by Surf UUID, name, or token symbol, including the current status, last status-change time, and launch exchanges.

Return the full content and metadata of one news article by an ID obtained from Surf news feed or search results.

Return active traders, trade count, and USD volume for one DEX protocol or router contract as either a total aggregate or a newest-first daily series. USD volume can lag by about three days; use enriched_ratio to assess completeness.

Return the current gas price for one supported EVM chain in both wei and Gwei. Surf reads the latest value from the chain's eth_gasPrice JSON-RPC method.

Discover logical on-chain tables and columns before writing SQL or structured queries. Filter by table to include its bounded physical source metadata. Transfer-table amount values are decimal-adjusted display units; amount_raw contains the original base-unit value.

Return durable job status, elapsed time, ClickHouse progress counters, retry semantics, and result links for an asynchronous blockchain SQL job. Polling this action never starts another ClickHouse execution.

Return a completed asynchronous blockchain SQL job's retained results as structured JSON or a downloadable CSV. Results remain available for 24 hours and are isolated to the authenticated tenant or user.

Look up one EVM transaction by chain and hash. Numeric transaction fields are returned as hexadecimal strings; request the labels enrichment to attach known sender and recipient entities.

Return daily open-interest history in USD for one Polymarket market over a selected time window. Data refreshes approximately every 30 minutes.

Return OHLCV candlesticks for a Polymarket market for price-chart and bar visualizations. Each candle includes open, high, low, close, volume, and trade count. Use Polymarket price history instead for one price per interval. Surf refreshes this data approximately every 30 minutes.

Return hourly or daily outcome-price history for one Polymarket market, or its latest price snapshot. Use Polymarket OHLCV instead for candlestick data. Surf refreshes this data approximately every 30 minutes.

Return aggregate Polymarket trading volume in USD and trade count as a time series for volume-trend analysis. Use Polymarket volume split for a YES/NO outcome-side breakdown. Surf refreshes this data about every 30 minutes.

Return Polymarket trading volume split into YES and NO outcome sides for hourly, daily, or weekly intervals, including total volume and trade count. Use Polymarket volume history instead for aggregate volume without an outcome-side breakdown. Surf refreshes this data approximately every 30 minutes.

Return a crypto project's profile with selectable overview, token market, legacy tokenomics, funding, team, contract, social, and token-generation sections. Use the dedicated project DeFi metrics action for TVL, fees, revenue, volume, users, and per-chain metrics.

Return one project signal card by Surf token UUID or project slug, including its score, classified state, score dimensions, market data, and summaries.

Return aggregate transfer activity for a token contract over a selected window, including transfer count, approximate unique senders and receivers, token amount, activity bounds, and USD-enrichment coverage. Set include=series for a newest-first daily breakdown.

Return token unlock time-series with cumulative amounts, allocation breakdowns, total supply denominator, and unlocked-supply percentage. Look up by Surf project UUID or token symbol and optionally bound the date range. `unlock_amount` is already cumulative and must not be summed across rows.

Return a wallet's cross-chain portfolio with selectable balance, token, label, NFT, and approval sub-resources, plus its per-chain USD breakdown.

Return entity names, entity types, and labels for up to 100 wallet addresses in one request.