Surf
Surf provides AI-ready financial, crypto, prediction-market, equity, on-chain, news, search, and web data through a unified API.
122 actionsAPI key
What your bot can do in Surf
Looks up
- Account PortfolioReturn a Hyperliquid wallet's point-in-time portfolio across perpetuals, spot, vaults, and HYPE staking.
- Aggregated Project DetailReturn a crypto project's profile with selectable overview, token market, legacy tokenomics, funding, team, contract, social, and…
- Aggregated Wallet DetailReturn a wallet's cross-chain portfolio with selectable balance, token, label, NFT, and approval sub-resources, plus its per-chain USD…
- Airdrop ActivitiesReturn one page of airdrop activities with project, reward, status, fundraising, and social metrics.
- Airdrop SearchReturn one page of airdrop opportunities filtered by project keyword, lifecycle phase, reward type, task type, or open-task availability.
- Blockchain SQL QuerySynchronously run one read-only ClickHouse SELECT or WITH query against Surf's blockchain tables with a 30-second timeout.
- Blockchain Structured QueryQuery an on-chain table with structured fields, filters, sorting, and row limits instead of raw SQL.
- Bridge Protocol RankingReturn one page of bridge protocols ranked by USD transfer volume over a selected time range, including transfer counts.
- Closed Trade Funding and LeverageReturn immutable funding and leverage context for one closed Hyperliquid trade using the composite key from the trades action.
- Closed TradesReturn one page of a wallet's closed Hyperliquid position lifecycles, newest close first, with entry and exit prices, size, hold time,…
Show 110 more
- Closed Trades AggregateAggregate a wallet's closed Hyperliquid trades by UTC day, symbol, direction, notional-size tier, or holding-time tier.
- Cross-Platform Daily Comparison (Polymarket <> Kalshi)Return one page of daily volume and open-interest comparisons for a specific matched Polymarket and Kalshi market pair.
- Cross-Platform Prediction Market MatcherReturn one page of matching Polymarket and Kalshi markets with match confidence, activity, volume, current probabilities, and price spread.
- Crypto News FeedReturn one page of crypto news from major sources, optionally filtered by publisher, project, or publication time.
- Current Onchain Gas PriceReturn the current gas price for one supported EVM chain in both wei and Gwei.
- DeFi Protocol RankingReturn one page of DeFi protocols ranked by TVL, fees, revenue, volume, or users.
- DEX Protocol ActivityReturn active traders, trade count, and USD volume for one DEX protocol or router contract as either a total aggregate or a newest-first…
- DEX Token OHLCV PriceReturn USD DEX-pool-weighted OHLCV bars for one token identified by chain and contract address.
- Download Asynchronous Blockchain SQL ResultsReturn a completed asynchronous blockchain SQL job's retained results as structured JSON or a downloadable CSV.
- Equity Balance SheetReturn standardized balance-sheet periods for a US-listed equity.
- Equity Cash FlowReturn paginated standardized cash-flow periods for a US-listed equity.
- Equity Financial MetricsReturn paginated standardized financial ratios, growth measures, per-share values, and valuation metrics for a US-listed equity.
- Equity Financial OverviewReturn a paginated financial overview for a US-listed equity.
- Equity Income StatementReturn standardized income-statement periods for a US-listed equity.
- Equity ListingsReturn one page of current verified active stock listings for the issuer resolved from the requested ticker.
- Equity MetadataReturn lightweight identity, logo, and latest USD price metadata for one or more US-listed stocks or ETFs.
- Equity Price CandlesReturn historical OHLCV candles and the latest traded price for a US-listed equity.
- Equity ProfileReturn a standardized stock company profile or ETF product profile, including its business description and source-update metadata.
- Equity SEC FilingsReturn one page of verified periodic SEC filings for a US equity, including canonical filing metadata, document URLs, statement coverage,…
- Equity Segment FinancialsReturn one page of provider-reported product and operating or geographic segment facts for a US-listed equity.
- ETF Flow HistoryReturn daily spot ETF flow history for BTC, ETH, XRP, SOL, or HYPE, including net USD flow, closing token price, settlement status, and…
- ETF HoldingsReturn one page from a stored ETF or index-fund portfolio snapshot plus its immediately previous snapshot, ordered newest to oldest.
- Exchange Flow ExchangesReturn one page of Surf's curated aggregate and high-coverage individual exchange filters for BTC or ETH exchange-flow metrics.
- Exchange Funding Rate HistoryReturn historical funding rate records for a perpetual contract.
- Exchange Historical CandlesReturn one page of persisted OHLCV candles for a covered Bithumb, Upbit, HashKey, bitFlyer, Coinone, or Korbit spot market.
- Exchange Listing EventsReturn one page of historical exchange listing and delisting events, filtered by date range and optionally by token, exchange, product, or…
- Exchange Long/Short Ratio HistoryReturn historical long/short ratios for a perpetual contract.
- Exchange Market CoverageReturn one page of covered spot markets on Bithumb, Upbit, HashKey, bitFlyer, Coinone, and Korbit with ticker metrics, candle…
- Exchange OHLCV CandlesticksReturn exchange OHLCV candlesticks with high, low, and total-volume statistics for the returned period.
- Exchange Order Book DepthReturn bid and ask order-book levels for an exchange market, including spread, spread percentage, mid-price, and total bid and ask depth.
- Exchange Perpetual Contract SnapshotReturn a perpetual futures snapshot for a trading pair, including current funding, open interest, mark price, and index price data.
- Exchange Ticker 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…
- Exchange Trading PairsReturn trading pairs available on an exchange, including base and quote currencies, market type, active status, and default fee rates.
- Fear & Greed Index HistoryReturn Bitcoin Fear and Greed Index history, including each 0-100 index value, its classification, and the Bitcoin price at that time.
- FillsReturn one page of a wallet's individual Hyperliquid fills with realized PnL, fees, liquidity direction, and an opaque cursor.
- Fund PortfolioReturn one page of a fund's investment rounds, sorted by the selected field.
- Fund Profile DetailReturn a crypto VC fund's full profile, including its description, jurisdiction, unique invested-project count, links, X accounts, team…
- 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.
- Fund SearchReturn one page of crypto investment funds matching a name keyword, including fund identity, tier, type, logo, and top invested projects.
- Fundraising Event SearchReturn one page of source-backed fundraising and token-sale events, or the latest fundraising timeline when no query is provided.
- Futures Market OverviewReturn a single ranked snapshot of futures market data across all tracked tokens, including open interest, funding rate, long/short ratio,…
- Get Asynchronous Blockchain SQL JobReturn durable job status, elapsed time, ClickHouse progress counters, retry semantics, and result links for an asynchronous blockchain…
- Get Wallet Labels BatchReturn entity names, entity types, and labels for up to 100 wallet addresses in one request.
- Kalshi EventsReturn one page of Kalshi events with their nested markets, optionally filtered by event ticker.
- Kalshi MarketsReturn one page of Kalshi markets with status, payout type, volume, and open interest.
- Kalshi Open Interest HistoryReturn daily open-interest history for one Kalshi market over a selected time window.
- Kalshi Orderbook HistoryReturn one page of historical YES-side bid and ask snapshots for a Kalshi market.
- Kalshi Price HistoryReturn hourly or daily OHLC price history for one Kalshi market, or the latest price from recent trades.
- Kalshi TradesReturn one page of real-time individual trades for a Kalshi market, with taker side, outcome prices, notional volume, and timestamp.
- Kalshi Volume HistoryReturn daily notional trading-volume history for one Kalshi market over a selected time window.
- Large Liquidation OrdersReturn one offset page of individual large liquidation orders above a USD threshold.
- Latest Equity FilingsReturn the most recently accepted periodic SEC filings across US equities.
- Latest Equity FinancialsReturn the most recently published current-serving TTM financials across US equities, optionally filtered by a minimum current market…
- Liquidation by ExchangeReturn a single ranked snapshot of total, long-side, and short-side liquidation volumes by exchange for a token and aggregation window.
- Liquidation ChartReturn time-bucketed aggregate long- and short-side liquidation volumes for a token on a specific exchange and interval.
- Market CandlesReturn Hyperliquid market OHLCV candles ordered by open time ascending for a required half-open [from_, to) window.
- Market CorrelationsReturn one page of 30-day Pearson price-correlation pairs between Polymarket markets in one category.
- News Article DetailReturn the full content and metadata of one news article by an ID obtained from Surf news feed or search results.
- News Article SearchReturn one page of crypto news articles matching a keyword or phrase, ranked by relevance with matching fragments highlighted when…
- On-Chain IndicatorReturn daily on-chain indicator history for BTC or ETH, including NUPL, SOPR, MVRV, Puell Multiple, NVM, NVT, NVT Golden Cross, and…
- On-Chain Table SchemaDiscover logical on-chain tables and columns before writing SQL or structured queries.
- Open & Recent OrdersReturn a wallet's live resting orders and recent terminal orders.
- Open PositionsReturn a wallet's open Hyperliquid perpetual positions with leverage, unrealized PnL, ROE, funding, liquidation risk, and its cross-margin…
- Options Market DataReturn options market data for one supported token, including open interest, 24-hour volume, put/call ratio, and max pain price by exchange.
- Polymarket EventsReturn one page of Polymarket events with aggregated status and volume plus their nested markets and outcomes, filtered by event slug.
- Polymarket LeaderboardReturn one page of Polymarket traders ranked by realized PnL, trading volume, or trade count, including aggregate position outcomes.
- Polymarket MarketsReturn one page of Polymarket markets with outcomes, status, volume, and condition identifiers, filtered by market slug.
- Polymarket OHLCV CandlesticksReturn OHLCV candlesticks for a Polymarket market for price-chart and bar visualizations.
- Polymarket Open Interest HistoryReturn daily open-interest history in USD for one Polymarket market over a selected time window.
- Polymarket Orderbook HistoryReturn one page of historical bid and ask depth snapshots for a Polymarket token.
- Polymarket Price HistoryReturn hourly or daily outcome-price history for one Polymarket market, or its latest price snapshot.
- Polymarket Smart MoneyReturn one page of Polymarket smart-wallet analytics.
- Polymarket TradesReturn one page of Polymarket trades or wallet activity, filtered by market, wallet, outcome, minimum amount, or time range.
- Polymarket Volume HistoryReturn aggregate Polymarket trading volume in USD and trade count as a time series for volume-trend analysis.
- Polymarket Volume Split (YES/NO)Return Polymarket trading volume split into YES and NO outcome sides for hourly, daily, or weekly intervals, including total volume and…
- Polymarket Wallet PositionsReturn one page of open Polymarket positions for a specific proxy wallet, including market identifiers, share size, valuation, and profit…
- Prediction Market AnalyticsReturn one page of prediction-market analytics with daily trends, top markets by open interest, momentum distribution, and per-market…
- Preflight Blockchain SQL QueryValidate and estimate a read-only ClickHouse SELECT or WITH query without executing it.
- Project AI NewsReturn one page of AI-generated news and signal analysis for a project identified by Surf UUID or fuzzy name.
- Project DeFi MetricsReturn one page of historical metric points for a single DeFi protocol.
- Project Event SearchReturn one page of project events for a Surf project identified by exact UUID or fuzzy name, optionally filtered by event type.
- Project SearchReturn one page of crypto projects matching a project name or token ticker.
- Public Sale / CrowdsaleReturn public sale information for a project resolved by Surf UUID, name, or token symbol, including sale type, status, dates, token…
- Search Prediction MarketsReturn one page of Polymarket and Kalshi markets with identifiers, status, volume, open interest, trade counts, current probability, and…
- Signal DetailReturn one project signal card by Surf token UUID or project slug, including its score, classified state, score dimensions, market data,…
- Signal ProjectsReturn one page of ranked project signal cards for a 24-hour or 7-day window.
- Technical IndicatorReturn a technical indicator for a trading pair on a given exchange and candlestick interval.
- Token DEX Trade HistoryReturn one page of recent DEX swaps for a token contract on Ethereum, Base, BSC, Arbitrum, or Tron.
- Token Generation EventReturn Token Generation Event status for a project resolved by Surf UUID, name, or token symbol, including the current status, last…
- Token HoldersReturn one page of top token holders for a contract address.
- Token Price HistoryReturn historical prices for one listed token in a selected quote currency.
- Token RankingsReturn one page of tokens ranked by market capitalization, 24-hour price change, or 24-hour trading volume, optionally filtered by token…
- Token Symbol ResolutionResolve an exact token ticker symbol to one page of likely contract-address candidates on supported chains.
- Token Transfer Activity SummaryReturn aggregate transfer activity for a token contract over a selected window, including transfer count, approximate unique senders and…
- Token Transfer HistoryReturn one page of recent transfers for a token contract on Ethereum, Base, Solana, Tron, BSC, or Arbitrum.
- Token Unlock ScheduleReturn token unlock time-series with cumulative amounts, allocation breakdowns, total supply denominator, and unlocked-supply percentage.
- Top Token SignalsReturn one page of daily or weekly top-token project signal cards with latest price, price changes, dimension scores, compact signals, and…
- Top 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.
- Trader LeaderboardReturn one page of Hyperliquid traders ranked by PnL, win rate, or volume, with trade activity, account age, human-likeness, and market…
- Trading PerformanceReturn a wallet's lifetime funding-excluded realized trading performance, live open positions, unrealized PnL, and perpetual clearinghouse…
- Transaction Details by HashLook up one EVM transaction by chain and hash.
- Wallet DeFi Protocol PositionsReturn one page of a wallet's DeFi protocol positions across lending, staking, liquidity pools, and farming, including token breakdowns…
- Wallet Net Worth HistoryReturn about 24 hours of total wallet net worth in USD at five-minute intervals for one EVM address.
- Wallet SearchReturn one page of wallet entities matching an ENS name, address label, or wallet-address prefix, including associated labels and known…
- Wallet Transaction HistoryReturn one page of a wallet's on-chain transactions, classified by type and valued in the chain's native token.
- Wallet Transfer HistoryReturn one page of ERC-20 or SPL token transfers involving a wallet, with token identity, USD value, and incoming or outgoing flow.
- Web Page FetchFetch one web page and convert its content to clean markdown, optionally limiting extraction, removing elements, or waiting for dynamic…
- Web SearchReturn one page of web pages matching a keyword or phrase, optionally restricted to specific domains and including full page content.
- X Tweets by IDsReturn normalized X posts by numeric ID.
- Yield Pool RankingReturn one page of individual DeFi yield pools ranked by APY or TVL, optionally filtered by protocol.
Takes action
- Cancel Asynchronous Blockchain SQL JobDurably request cancellation of an asynchronous blockchain SQL job and return its current state.
- Submit Asynchronous Blockchain SQL JobSubmit a read-only ClickHouse SQL query for durable background execution and return its stable job and query identifiers immediately.
