- Category: artificial intelligence
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 122
- Triggers: 0
- Slug:
SURF - Version: 20261101_00
- Instant: Supported on the latest version. Support varies by tool.
Tools
Cancel Asynchronous Blockchain SQL Job
Cancel Asynchronous Blockchain SQL Job
Submit Asynchronous Blockchain SQL Job
Submit Asynchronous Blockchain SQL Job
SURF_CREATE_ONCHAIN_SQL_JOBSubmit 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.Input Parameters
Output
DEX Token OHLCV Price
DEX Token OHLCV Price
SURF_GET_DEX_TOKEN_PRICEReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 4 credits ($0.024) per requestInput Parameters
from_; together they override time_range.ethereum, base, bsc, arbitrum, optimism, polygon, avalanche, or solana.to; together they override time_range.1m through 4h are typically best for active DEX analysis.max returns at most 1500 bars for the selected interval. Ignored when both from_ and to are set.Output
Equity Balance Sheet
Equity Balance Sheet
SURF_GET_EQUITY_BALANCE_SHEETReturn standardized balance-sheet periods for a US-listed equity. Each metric includes an availability status, and unavailable values are null.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 6 credits ($0.036) per requestInput Parameters
Output
Equity Price Candles
Equity Price Candles
SURF_GET_EQUITY_CANDLESReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 2 credits ($0.012) per requestInput Parameters
Output
Equity Cash Flow
Equity Cash Flow
SURF_GET_EQUITY_CASH_FLOWReturn standardized cash-flow periods for a US-listed equity, with serving-layer values, status, origin, and period metadata.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 6 credits ($0.036) per requestInput Parameters
Output
Equity Profile
Equity Profile
SURF_GET_EQUITY_COMPANY_PROFILEReturn a standardized stock company profile or ETF product profile, including its business description and source-update metadata.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 2 credits ($0.012) per requestInput Parameters
Output
Equity Financial Metrics
Equity Financial Metrics
SURF_GET_EQUITY_FINANCIAL_METRICSReturn standardized financial ratios, growth measures, per-share values, and valuation metrics for a US-listed equity.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 4 credits ($0.024) per requestInput Parameters
Output
Equity Income Statement
Equity Income Statement
SURF_GET_EQUITY_INCOME_STATEMENTReturn standardized income-statement periods for a US-listed equity. The API passes through available periods and does not synthesize missing periods or financial values.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 6 credits ($0.036) per requestInput Parameters
Output
Latest Equity Filings
Latest Equity Filings
SURF_GET_EQUITY_LATEST_FILINGSReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 2 credits ($0.012) per requestInput Parameters
Output
Latest Equity Financials
Latest Equity Financials
SURF_GET_EQUITY_LATEST_FINANCIALSReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 4 credits ($0.024) per requestInput Parameters
Output
Equity Metadata
Equity Metadata
SURF_GET_EQUITY_METAReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 2 credits ($0.012) per requestInput Parameters
Output
Equity Financial Overview
Equity Financial Overview
SURF_GET_EQUITY_OVERVIEWReturn a financial overview for a US-listed equity for a selected period and date, with a limit on the number of financial periods. Values are served as reported or derived; missing values remain explicit nulls.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 4 credits ($0.024) per requestInput Parameters
Output
Exchange Order Book Depth
Exchange Order Book Depth
SURF_GET_EXCHANGE_DEPTHReturn bid and ask order-book levels for an exchange market, including spread, spread percentage, mid-price, and total bid and ask depth.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
spot for spot trading or swap, perpetual, or perp for perpetual contracts.Output
Exchange Funding Rate History
Exchange Funding Rate History
SURF_GET_EXCHANGE_FUNDING_HISTORYReturn historical funding rate records for a perpetual contract.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Exchange OHLCV Candlesticks
Exchange OHLCV Candlesticks
SURF_GET_EXCHANGE_KLINESReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
spot for spot trading or swap, perpetual, or perp for perpetual contracts.from_ set to the last returned candle timestamp.time_range; use from_ and limit to control the window.Output
Exchange Long/Short Ratio History
Exchange Long/Short Ratio History
SURF_GET_EXCHANGE_LONG_SHORT_RATIOReturn historical long/short ratios for a perpetual contract.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Exchange Trading Pairs
Exchange Trading Pairs
SURF_GET_EXCHANGE_MARKETSReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
perpetual and perp are aliases for swap markets.Output
Exchange Perpetual Contract Snapshot
Exchange Perpetual Contract Snapshot
SURF_GET_EXCHANGE_PERPReturn a perpetual futures snapshot for a trading pair, including current funding, open interest, mark price, and index price data.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
funding for current funding data and oi for open interest. Each group may be selected at most once.Output
Exchange Ticker Price
Exchange Ticker Price
SURF_GET_EXCHANGE_PRICEReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
spot for spot trading or swap, perpetual, or perp for perpetual contracts.Output
Fund Profile Detail
Fund Profile Detail
SURF_GET_FUND_DETAILReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Account Portfolio
Account Portfolio
SURF_GET_HYPERLIQUID_ACCOUNTReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 3 credits ($0.018) per requestInput Parameters
Output
Market Candles
Market Candles
SURF_GET_HYPERLIQUID_CANDLESReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 4 credits ($0.024) per requestInput Parameters
Output
Open & Recent Orders
Open & Recent Orders
SURF_GET_HYPERLIQUID_ORDERSReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 2 credits ($0.012) per requestInput Parameters
historical_total reports the count before this limit is applied.Output
Trading Performance
Trading Performance
SURF_GET_HYPERLIQUID_PERFORMANCEReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 3 credits ($0.018) per requestInput Parameters
Output
Open Positions
Open Positions
SURF_GET_HYPERLIQUID_POSITIONSReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 2 credits ($0.012) per requestInput Parameters
main_dex for Hyperliquid’s native market; otherwise select a builder market.Output
Closed Trade Funding and Leverage
Closed Trade Funding and Leverage
SURF_GET_HYPERLIQUID_TRADE_CONTEXTReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 4 credits ($0.024) per requestInput Parameters
Output
Closed Trades Aggregate
Closed Trades Aggregate
SURF_GET_HYPERLIQUID_TRADES_AGGREGATEAggregate 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 4 credits ($0.024) per requestInput Parameters
Output
Kalshi Open Interest History
Kalshi Open Interest History
SURF_GET_KALSHI_OPEN_INTERESTReturn daily open-interest history for one Kalshi market over a selected time window. Data refreshes approximately every 30 minutes.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Kalshi Price History
Kalshi Price History
SURF_GET_KALSHI_PRICESReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 2 credits ($0.012) per requestInput Parameters
1h for hourly OHLC, 1d for daily OHLC, or latest for the most recent trade price.interval is latest; distinct from the interval bucket size.Output
Kalshi Volume History
Kalshi Volume History
SURF_GET_KALSHI_VOLUMESReturn daily notional trading-volume history for one Kalshi market over a selected time window. Surf refreshes this data about every 30 minutes.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
7d, 30d, 90d, 180d, or 1y. This endpoint returns daily points and does not accept an interval parameter.Output
ETF Flow History
ETF Flow History
SURF_GET_MARKET_ETFReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Fear & Greed Index History
Fear & Greed Index History
SURF_GET_MARKET_FEAR_GREEDReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Futures Market Overview
Futures Market Overview
SURF_GET_MARKET_FUTURESReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Liquidation Chart
Liquidation Chart
SURF_GET_MARKET_LIQUIDATION_CHARTReturn time-bucketed aggregate long- and short-side liquidation volumes for a token on a specific exchange and interval.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
time_range; use from_ and to to bound the series.Output
Liquidation by Exchange
Liquidation by Exchange
SURF_GET_MARKET_LIQUIDATION_EXCHANGE_LISTReturn a single ranked snapshot of total, long-side, and short-side liquidation volumes by exchange for a token and aggregation window.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
On-Chain Indicator
On-Chain Indicator
SURF_GET_MARKET_ONCHAIN_INDICATORReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
exchange-flows/.Output
Options Market Data
Options Market Data
SURF_GET_MARKET_OPTIONSReturn options market data for one supported token, including open interest, 24-hour volume, put/call ratio, and max pain price by exchange.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Token Price History
Token Price History
SURF_GET_MARKET_PRICEReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
from_; together they override time_range.to; together they override time_range.from_ and to are set.Output
Technical Indicator
Technical Indicator
SURF_GET_MARKET_PRICE_INDICATORReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Public Sale / Crowdsale
Public Sale / Crowdsale
SURF_GET_MARKET_PUBLIC_SALEReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 2 credits ($0.012) per requestInput Parameters
project_id or project_name must be non-empty; prefer this exact identifier when available.project_id or project_name must be non-empty.Output
Token Generation Event
Token Generation Event
SURF_GET_MARKET_TGEReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 2 credits ($0.012) per requestInput Parameters
Output
News Article Detail
News Article Detail
DEX Protocol Activity
DEX Protocol Activity
SURF_GET_ONCHAIN_DEX_ACTIVITYReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 2 credits ($0.012) per requestInput Parameters
uniswap, pancakeswap, or aerodrome. Provide exactly one of project or address.Output
Current Onchain Gas Price
Current Onchain Gas Price
SURF_GET_ONCHAIN_GAS_PRICEReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
On-Chain Table Schema
On-Chain Table Schema
SURF_GET_ONCHAIN_SCHEMADiscover 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Get Asynchronous Blockchain SQL Job
Get Asynchronous Blockchain SQL Job
Download Asynchronous Blockchain SQL Results
Download Asynchronous Blockchain SQL Results
Transaction Details by Hash
Transaction Details by Hash
SURF_GET_ONCHAIN_TXLook 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Polymarket Open Interest History
Polymarket Open Interest History
SURF_GET_POLYMARKET_OPEN_INTERESTReturn daily open-interest history in USD for one Polymarket market over a selected time window. The series is sparse, containing rows only on days with open-interest changes; data refreshes approximately every 30 minutes.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 2 credits ($0.012) per requestInput Parameters
Output
Polymarket OHLCV Candlesticks
Polymarket OHLCV Candlesticks
SURF_GET_POLYMARKET_PRICE_OHLCVReturn 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.Instant: Supported on the latest version.Instant pricing: $0.024 per requestInput Parameters
Output
Polymarket Price History
Polymarket Price History
SURF_GET_POLYMARKET_PRICESReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 2 credits ($0.012) per requestInput Parameters
1h for hourly points, 1d for daily points, or latest for one most-recent snapshot.interval is latest; distinct from the interval bucket size.Output
Polymarket Volume History
Polymarket Volume History
SURF_GET_POLYMARKET_VOLUMESReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 2 credits ($0.012) per requestInput Parameters
1h for hourly or 1d for daily. Distinct from the history window.token_id or condition_id; both may be supplied. Surf resolves it to the market condition.7d, 30d, 90d, 180d, or 1y. Distinct from the interval bucket size.day, week, month, year, or all. Use as an alternative to interval.condition_id or token_id; both may be supplied.Output
Polymarket Volume Split (YES/NO)
Polymarket Volume Split (YES/NO)
SURF_GET_POLYMARKET_VOLUME_SPLITReturn 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.Instant: Supported on the latest version.Instant pricing: $0.024 per requestInput Parameters
Output
Aggregated Project Detail
Aggregated Project Detail
SURF_GET_PROJECT_DETAILReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Signal Detail
Signal Detail
SURF_GET_SIGNAL_DETAILReturn one project signal card by Surf token UUID or project slug, including its score, classified state, score dimensions, market data, and summaries.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Token Transfer Activity Summary
Token Transfer Activity Summary
SURF_GET_TOKEN_TRANSFER_STATSReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 4 credits ($0.024) per requestInput Parameters
Output
Token Unlock Schedule
Token Unlock Schedule
SURF_GET_TOKEN_UNLOCK_SCHEDULEReturn 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.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
project_id or symbol is required. Prefer this when available from a previous response; it takes priority over symbol.Output
Aggregated Wallet Detail
Aggregated Wallet Detail
SURF_GET_WALLET_DETAILReturn a wallet’s cross-chain portfolio with selectable balance, token, label, NFT, and approval sub-resources, plus its per-chain USD breakdown.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Get Wallet Labels Batch
Get Wallet Labels Batch
Wallet Net Worth History
Wallet Net Worth History
Web Page Fetch
Web Page Fetch
SURF_GET_WEB_FETCHFetch one web page and convert its content to clean markdown, optionally limiting extraction, removing elements, or waiting for dynamic content with CSS selectors.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 2 credits ($0.012) per requestInput Parameters
Output
X Tweets by IDs
X Tweets by IDs
SURF_GET_X_TWEETS_BY_IDSReturn normalized X posts by numeric ID. Authentication is required. Each request costs at least 7 credits per unique requested ID; the actual cost reflects plan and tenant pricing. Repeated IDs are billed and looked up once. Unavailable IDs are billed and omitted from data; returned posts preserve first-input order.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 7 credits ($0.042) per requestInput Parameters
Output
Airdrop Activities
Airdrop Activities
SURF_LIST_AIRDROP_ACTIVITIESReturn one page of airdrop activities with project, reward, status, fundraising, and social metrics.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
ETF Holdings
ETF Holdings
SURF_LIST_EQUITY_ETF_HOLDINGSReturn one page from a stored ETF or index-fund portfolio snapshot plus its immediately previous snapshot, ordered newest to oldest. Available quarterly periods describe the stored holdings history. Set offset explicitly for another page; total_holdings is unfiltered and does not establish whether filtered results continue.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 4 credits ($0.024) per requestInput Parameters
Output
Equity SEC Filings
Equity SEC Filings
SURF_LIST_EQUITY_FILINGSReturn one page of verified periodic SEC filings for a US equity, including canonical filing metadata, document URLs, statement coverage, and provenance.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 2 credits ($0.012) per requestInput Parameters
Output
Equity Listings
Equity Listings
SURF_LIST_EQUITY_LISTINGSReturn one page of current verified active stock listings for the issuer resolved from the requested ticker. Ticker alone is not treated as a durable listing identity.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 2 credits ($0.012) per requestInput Parameters
Output
Equity Segment Financials
Equity Segment Financials
SURF_LIST_EQUITY_SEGMENTSReturn one page of provider-reported product and operating or geographic segment facts for a US-listed equity. Provider labels and missing-value status are preserved; values are not added across incompatible dimensions.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 6 credits ($0.036) per requestInput Parameters
Output
Exchange Historical Candles
Exchange Historical Candles
SURF_LIST_EXCHANGE_CANDLESReturn one page of persisted OHLCV candles for a covered Bithumb, Upbit, HashKey, bitFlyer, Coinone, or Korbit spot market. Results are ordered newest first.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Exchange Market Coverage
Exchange Market Coverage
SURF_LIST_EXCHANGE_COVERAGEReturn one page of covered spot markets on Bithumb, Upbit, HashKey, bitFlyer, Coinone, and Korbit with ticker metrics, candle availability, technical score, and data status. Inspect data_status and data_actionability before using sparse or stale market data.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Fund Portfolio
Fund Portfolio
SURF_LIST_FUND_PORTFOLIOReturn one page of a fund’s investment rounds, sorted by the selected field. A project may appear more than once when the fund participated in multiple rounds. Prefer an exact fund id over a fuzzy name query.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Fund Ranking
Fund Ranking
SURF_LIST_FUND_RANKINGReturn one page of crypto VC funds ranked by fund tier or number of invested projects, including up to five top portfolio projects per fund.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
tier ranks lower tiers first; portfolio_count ranks by number of invested projects.Output
Fills
Fills
SURF_LIST_HYPERLIQUID_FILLSReturn one page of a wallet’s individual Hyperliquid fills with realized PnL, fees, liquidity direction, and an opaque cursor. Use ascending order with from_ and follow next_cursor for complete history; descending order is a recent capped feed.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 2 credits ($0.012) per requestInput Parameters
Output
Trader Leaderboard
Trader Leaderboard
SURF_LIST_HYPERLIQUID_LEADERBOARDReturn one page of Hyperliquid traders ranked by PnL, win rate, or volume, with trade activity, account age, human-likeness, and market filters. Leaderboard PnL includes funding and must not be treated as equivalent to the funding-excluded PnL from Hyperliquid performance or trade actions.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 3 credits ($0.018) per requestInput Parameters
main_dex for Hyperliquid’s native market; otherwise select a builder market.all includes data from 2025-08-01 onward.Output
Closed Trades
Closed Trades
SURF_LIST_HYPERLIQUID_TRADESReturn one page of a wallet’s closed Hyperliquid position lifecycles, newest close first, with entry and exit prices, size, hold time, fees, and realized PnL. net_pnl excludes funding; inspect funding_pnl and funding_status separately. Follow next_cursor for older trades. Use Closed Trades Aggregate for symbol, direction, or market-scoped rollups.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 3 credits ($0.018) per requestInput Parameters
Output
Kalshi Events
Kalshi Events
SURF_LIST_KALSHI_EVENTSReturn one page of Kalshi events with their nested markets, optionally filtered by event ticker. Omit event_ticker to browse top active events by volume. Surf refreshes this data approximately every 30 minutes.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Kalshi Markets
Kalshi Markets
SURF_LIST_KALSHI_MARKETSReturn one page of Kalshi markets with status, payout type, volume, and open interest. Filter by an exact market ticker, or omit it to browse top active markets by volume. Data refreshes approximately every 30 minutes.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Kalshi Orderbook History
Kalshi Orderbook History
SURF_LIST_KALSHI_ORDERBOOKSReturn one page of historical YES-side bid and ask snapshots for a Kalshi market. Timestamps are Unix milliseconds and prices are cents. Follow next_cursor with pagination_key to retrieve additional snapshots.Instant: Supported on the latest version.Instant pricing: $0.024 per requestInput Parameters
Output
Kalshi Trades
Kalshi Trades
SURF_LIST_KALSHI_TRADESReturn one page of individual trades for a Kalshi market, with taker side, outcome prices, notional volume, and timestamp; Kalshi data may lag by about six hours. Filter by side, minimum notional, or time range, and follow next_cursor for more trades.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 2 credits ($0.012) per requestInput Parameters
Output
Exchange Flow Exchanges
Exchange Flow Exchanges
SURF_LIST_MARKET_EXCHANGE_FLOW_EXCHANGESReturn one page of Surf’s curated aggregate and high-coverage individual exchange filters for BTC or ETH exchange-flow metrics. Use a returned symbol as the exchange parameter for exchange-flow metrics in the market on-chain indicator action.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Large Liquidation Orders
Large Liquidation Orders
SURF_LIST_MARKET_LIQUIDATION_ORDERReturn one offset page of individual large liquidation orders above a USD threshold. The provider exposes a bounded recent window; after its offset pages are exhausted, page backward by setting to to the oldest returned timestamp plus one and de-duplicating on order_id.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Exchange Listing Events
Exchange Listing Events
SURF_LIST_MARKET_LISTINGSReturn one page of historical exchange listing and delisting events, filtered by date range and optionally by token, exchange, product, or event type.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 2 credits ($0.012) per requestInput Parameters
Output
Token Rankings
Token Rankings
SURF_LIST_MARKET_RANKINGReturn one page of tokens ranked by market capitalization, 24-hour price change, or 24-hour trading volume, optionally filtered by token category.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Cross-Platform Daily Comparison (Polymarket <> Kalshi)
Cross-Platform Daily Comparison (Polymarket <> Kalshi)
SURF_LIST_MATCHING_MARKET_DAILYReturn one page of daily volume and open-interest comparisons for a specific matched Polymarket and Kalshi market pair. Use matching-market pairs to discover the required identifiers first. Polymarket values are in USD; Kalshi values are in contracts.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Cross-Platform Prediction Market Matcher
Cross-Platform Prediction Market Matcher
SURF_LIST_MATCHING_MARKET_PAIRSReturn one page of matching Polymarket and Kalshi markets with match confidence, activity, volume, current probabilities, and price spread. Filter by category, match type, confidence, or a specific market ID; sort by spread_pct to find the widest current spreads. Data refreshes approximately every five minutes.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Crypto News Feed
Crypto News Feed
SURF_LIST_NEWS_FEEDReturn one page of crypto news from major sources, optionally filtered by publisher, project, or publication time. Use an article ID with the news detail action to fetch full content.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Bridge Protocol Ranking
Bridge Protocol Ranking
SURF_LIST_ONCHAIN_BRIDGE_RANKINGReturn one page of bridge protocols ranked by USD transfer volume over a selected time range, including transfer counts.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 4 credits ($0.024) per requestInput Parameters
Output
Yield Pool Ranking
Yield Pool Ranking
SURF_LIST_ONCHAIN_YIELD_RANKINGReturn one page of individual DeFi yield pools ranked by APY or TVL, optionally filtered by protocol.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 4 credits ($0.024) per requestInput Parameters
Output
Polymarket Events
Polymarket Events
SURF_LIST_POLYMARKET_EVENTSReturn one page of Polymarket events with aggregated status and volume plus their nested markets and outcomes, filtered by event slug. Surf refreshes this data approximately every 30 minutes.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 2 credits ($0.012) per requestInput Parameters
Output
Polymarket Leaderboard
Polymarket Leaderboard
SURF_LIST_POLYMARKET_LEADERBOARDReturn one page of Polymarket traders ranked by realized PnL, trading volume, or trade count, including aggregate position outcomes. Data refreshes approximately every five minutes.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 4 credits ($0.024) per requestInput Parameters
Output
Polymarket Markets
Polymarket Markets
SURF_LIST_POLYMARKET_MARKETSReturn one page of Polymarket markets with outcomes, status, volume, and condition identifiers, filtered by market slug. Use condition_id with the Polymarket prices action for current prices. Surf refreshes this data approximately every 30 minutes.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 2 credits ($0.012) per requestInput Parameters
Output
Polymarket Orderbook History
Polymarket Orderbook History
SURF_LIST_POLYMARKET_ORDERBOOKSReturn one page of historical bid and ask depth snapshots for a Polymarket token. Timestamps are Unix milliseconds and prices range from 0 to 1. Follow next_cursor with pagination_key to retrieve additional snapshots. Surf refreshes this data approximately every five minutes.Instant: Supported on the latest version.Instant pricing: $0.024 per requestInput Parameters
Output
Polymarket Wallet Positions
Polymarket Wallet Positions
SURF_LIST_POLYMARKET_POSITIONSReturn one page of open Polymarket positions for a specific proxy wallet, including market identifiers, share size, valuation, and profit and loss. Surf refreshes this data approximately every 30 minutes.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 2 credits ($0.012) per requestInput Parameters
Output
Polymarket Smart Money
Polymarket Smart Money
SURF_LIST_POLYMARKET_SMART_MONEYReturn one page of Polymarket smart-wallet analytics. The positioning view aggregates bullish or bearish direction and conviction by market; the trades view returns individual trades of at least $10,000 with wallet metadata. Surf refreshes this data approximately every five minutes.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 4 credits ($0.024) per requestInput Parameters
Output
Polymarket Trades
Polymarket Trades
SURF_LIST_POLYMARKET_TRADESReturn one page of Polymarket trades or wallet activity, filtered by market, wallet, outcome, minimum amount, or time range. Redemption and all activity views require a wallet address; redemption includes splits, merges, and redemptions, and Surf refreshes this data approximately every five minutes.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 2 credits ($0.012) per requestInput Parameters
Output
Prediction Market Analytics
Prediction Market Analytics
SURF_LIST_PREDICTION_MARKET_ANALYTICSReturn one page of prediction-market analytics with daily trends, top markets by open interest, momentum distribution, and per-market momentum signals. Omit category for platform-wide totals, and use platform for an exchange-specific view. Set offset explicitly to request another momentum-markets page because the response has no continuation metadata. Use prediction-market search instead to browse individual markets.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 4 credits ($0.024) per requestInput Parameters
Output
Market Correlations
Market Correlations
SURF_LIST_PREDICTION_MARKET_CORRELATIONSReturn one page of 30-day Pearson price-correlation pairs between Polymarket markets in one category. Results cover the top 100 markets by 7-day volume globally; lower-volume markets may have no correlation data. Filter by condition_id to find markets correlated with one market.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 4 credits ($0.024) per requestInput Parameters
Output
Project AI News
Project AI News
SURF_LIST_PROJECT_AI_NEWSReturn one page of AI-generated news and signal analysis for a project identified by Surf UUID or fuzzy name. Results include price-analysis and funding signals; social and X-derived items are excluded by Surf.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Project DeFi Metrics
Project DeFi Metrics
SURF_LIST_PROJECT_DEFI_METRICSReturn one page of historical metric points for a single DeFi protocol. Look up the protocol by exact Surf project UUID when available or by fuzzy name, then filter by metric, chain, and time range.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
fee is an alias for fees.Output
DeFi Protocol Ranking
DeFi Protocol Ranking
SURF_LIST_PROJECT_DEFI_RANKINGReturn one page of DeFi protocols ranked by TVL, fees, revenue, volume, or users. For individual pool or vault yields, use the on-chain yield ranking action instead.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 2 credits ($0.012) per requestInput Parameters
Output
Signal Projects
Signal Projects
SURF_LIST_SIGNAL_PROJECTSReturn one page of ranked project signal cards for a 24-hour or 7-day window. Each card can include project identity, score, latest price, price changes, classified state, dimension scores, compact token signals, AI summaries, and supporting market metrics.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Top Token Signals
Top Token Signals
SURF_LIST_SIGNAL_TOP_TOKENSReturn one page of daily or weekly top-token project signal cards with latest price, price changes, dimension scores, compact signals, and AI summaries.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Token DEX Trade History
Token DEX Trade History
SURF_LIST_TOKEN_DEX_TRADESReturn one page of recent DEX swaps for a token contract on Ethereum or Base. Trades include the pair, bought and sold amounts, USD value, taker, transaction hash, and DEX; optionally request taker labels and follow the continuation cursor.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 2 credits ($0.012) per requestInput Parameters
Output
Token Holders
Token Holders
SURF_LIST_TOKEN_HOLDERSReturn one page of top token holders for a contract address.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Top Transfer Counterparties
Top Transfer Counterparties
SURF_LIST_TOKEN_TRANSFER_COUNTERPARTIESReturn one page of a token’s top receivers or senders over a selected window, ranked by transfer count, token amount, or USD value. Optionally attach entity labels or exclude common infrastructure categories.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 4 credits ($0.024) per requestInput Parameters
Output
Token Transfer History
Token Transfer History
SURF_LIST_TOKEN_TRANSFERSReturn one page of recent transfers for a token contract on Ethereum, Base, Tron, BSC, or Arbitrum. Filter by date range, optionally attach sender and recipient labels, and follow the continuation cursor for more transfers.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Wallet Transaction History
Wallet Transaction History
SURF_LIST_WALLET_HISTORYReturn one page of a wallet’s on-chain transactions, classified by type and valued in the chain’s native token. Use wallet transfer history instead for token identity and USD-valued ERC-20 or SPL transfers. Use before for deep pagination and deduplicate by tx_hash when paging across a shared timestamp.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Wallet DeFi Protocol Positions
Wallet DeFi Protocol Positions
SURF_LIST_WALLET_PROTOCOLSReturn one page of a wallet’s DeFi protocol positions across lending, staking, liquidity pools, and farming, including token breakdowns and USD values.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Wallet Transfer History
Wallet Transfer History
SURF_LIST_WALLET_TRANSFERSReturn one page of ERC-20 or SPL token transfers involving a wallet, with token identity, USD value, and incoming or outgoing flow. Use wallet transaction history instead for all transaction types and native values.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Preflight Blockchain SQL Query
Preflight Blockchain SQL Query
SURF_PREFLIGHT_ONCHAIN_SQLValidate and estimate a read-only ClickHouse SELECT or WITH query without executing it. Returns the server-bounded SQL, physical scan estimate, budgets, and guardrail warnings. This preflight consumes Surf credits.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 4 credits ($0.024) per requestInput Parameters
Output
Blockchain Structured Query
Blockchain Structured Query
SURF_QUERY_ONCHAIN_DATAQuery an on-chain table with structured fields, filters, sorting, and row limits instead of raw SQL. Discover tables and columns first with Surf’s on-chain schema action. Use qualified agent.<table> sources, include a block_date filter for large tables, and avoid unindexed symbol filters.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 5 credits ($0.030) per requestInput Parameters
agent.ethereum_yields_daily. Use Surf’s on-chain schema action to discover available tables.Output
Blockchain SQL Query
Blockchain SQL Query
SURF_QUERY_ONCHAIN_SQLSynchronously run one read-only ClickHouse SELECT or WITH query against Surf’s blockchain tables with a 30-second timeout. Use SURF_CREATE_ONCHAIN_SQL_JOB instead for durable asynchronous work. Never automatically retry a synchronous timeout.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 5 credits ($0.030) per requestInput Parameters
agent database and filter on block_date or block_number. Discover valid tables and columns with the on-chain schema action first.Output
Airdrop Search
Airdrop Search
SURF_SEARCH_AIRDROPReturn one page of airdrop opportunities filtered by project keyword, lifecycle phase, reward type, task type, or open-task availability. Full task details can be included when needed.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 2 credits ($0.012) per requestInput Parameters
Output
Project Event Search
Project Event Search
SURF_SEARCH_EVENTSReturn one page of project events for a Surf project identified by exact UUID or fuzzy name, optionally filtered by event type.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Fund Search
Fund Search
SURF_SEARCH_FUNDReturn one page of crypto investment funds matching a name keyword, including fund identity, tier, type, logo, and top invested projects.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Fundraising Event Search
Fundraising Event Search
SURF_SEARCH_FUNDRAISINGReturn one page of source-backed fundraising and token-sale events, or the latest fundraising timeline when no query is provided.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
News Article Search
News Article Search
SURF_SEARCH_NEWSReturn one page of crypto news articles matching a keyword or phrase, ranked by relevance with matching fragments highlighted when available.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Search Prediction Markets
Search Prediction Markets
SURF_SEARCH_PREDICTION_MARKETReturn one page of Polymarket and Kalshi markets with identifiers, status, volume, open interest, trade counts, current probability, and smart-money signals. Filter by platform, category, status, keyword, or exact platform identifier. Data refreshes approximately every five minutes.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 4 credits ($0.024) per requestInput Parameters
Output
Project Search
Project Search
SURF_SEARCH_PROJECTReturn one page of crypto projects matching a project name or token ticker. Results include Surf project UUIDs for exact follow-up lookups.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Token Symbol Resolution
Token Symbol Resolution
SURF_SEARCH_TOKENResolve an exact token ticker symbol to one page of likely contract-address candidates on supported chains. Use the returned chain and address before calling token endpoints that require a contract address.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Wallet Search
Wallet Search
SURF_SEARCH_WALLETReturn one page of wallet entities matching an ENS name, address label, or wallet-address prefix, including associated labels and known addresses.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 1 credit ($0.006) per requestInput Parameters
Output
Web Search
Web Search
SURF_SEARCH_WEBReturn one page of web pages matching a keyword or phrase, optionally restricted to specific domains and including full page content.Instant: Supported on the latest version.Instant pricing: $0.006 per credit used; typically 3 credits ($0.018) per request