{"uid":"cap_hN-FyWhjaFWfnmuiK6DXc","slug":"nansen-perp-screener-2161c134","name":"Nansen Perp Screener","description":"Discover and screen perpetual contracts on Hyperliquid with advanced filtering capabilities. This endpoint helps identify trending perpetual contracts, trading activity, funding rates, and smart money movements by combining metrics like volume, open interest, funding rates, and position data.\n\n**What it helps to answer:**\n\n1. **Which perpetual contracts are experiencing significant trading volume and activity?**\n2. **How do funding rates correlate with trading patterns and smart money positions?**\n3. **What perpetual contracts show strong fundamentals in terms of open interest and trading patterns?**\n4. **Which perpetual contracts are attracting smart money participation with long/short positions?**","url":"https://api.nansen.ai/api/v1/perp-screener?utm_source=zero.xyz","method":"POST","headers":{},"bodySchema":{"type":"object","title":"PerpScreenerRequest","required":["date"],"properties":{"date":{"type":"object","title":"DateRange","properties":{"to":{"anyOf":[{"type":"string"}],"title":"To","examples":["2025-01-31T23:59:59Z"],"description":"End date in ISO 8601 format (e.g., 2025-01-31T23:59:59Z or 2025-01-31)"},"from":{"anyOf":[{"type":"string"}],"title":"From","examples":["2025-01-01T00:00:00Z"],"description":"Start date in ISO 8601 format (e.g., 2025-01-01T00:00:00Z or 2025-01-01)"}},"description":"Date range model matching the API schema."},"filters":{"anyOf":[{"type":"object","title":"PerpScreenerFilters","properties":{"volume":{"anyOf":[{"type":"object","title":"NumericRangeFilter","properties":{"max":{"anyOf":[{"type":"number"}],"title":"Max","examples":[50000,10000000,100],"description":"Maximum value (inclusive)"},"min":{"anyOf":[{"type":"number"}],"title":"Min","examples":[1000,1000000,-50,0],"description":"Minimum value (inclusive)"}},"description":"Filter for numeric values (floats) with optional min/max bounds.\nUse for prices, volumes, ratios, and other decimal values. - Values between -10.5 and 100.75"}],"examples":[{"min":1000000}],"description":"Total traded notional in USD range filter"},"funding":{"anyOf":[{"type":"object","title":"NumericRangeFilter","properties":{"max":{"anyOf":[{"type":"number"}],"title":"Max","examples":[50000,10000000,100],"description":"Maximum value (inclusive)"},"min":{"anyOf":[{"type":"number"}],"title":"Min","examples":[1000,1000000,-50,0],"description":"Minimum value (inclusive)"}},"description":"Filter for numeric values (floats) with optional min/max bounds.\nUse for prices, volumes, ratios, and other decimal values. - Values between -10.5 and 100.75"}],"examples":[{"max":0.01,"min":-0.01}],"description":"Latest funding rate range filter"},"buy_volume":{"anyOf":[{"type":"object","title":"NumericRangeFilter","properties":{"max":{"anyOf":[{"type":"number"}],"title":"Max","examples":[50000,10000000,100],"description":"Maximum value (inclusive)"},"min":{"anyOf":[{"type":"number"}],"title":"Min","examples":[1000,1000000,-50,0],"description":"Minimum value (inclusive)"}},"description":"Filter for numeric values (floats) with optional min/max bounds.\nUse for prices, volumes, ratios, and other decimal values. - Values between -10.5 and 100.75"}],"examples":[{"min":500000}],"description":"Total USD value of market buy trades range filter"},"mark_price":{"anyOf":[{"type":"object","title":"NumericRangeFilter","properties":{"max":{"anyOf":[{"type":"number"}],"title":"Max","examples":[50000,10000000,100],"description":"Maximum value (inclusive)"},"min":{"anyOf":[{"type":"number"}],"title":"Min","examples":[1000,1000000,-50,0],"description":"Minimum value (inclusive)"}},"description":"Filter for numeric values (floats) with optional min/max bounds.\nUse for prices, volumes, ratios, and other decimal values. - Values between -10.5 and 100.75"}],"examples":[{"max":100000,"min":0.01}],"description":"Latest mark price range filter"},"sell_volume":{"anyOf":[{"type":"object","title":"NumericRangeFilter","properties":{"max":{"anyOf":[{"type":"number"}],"title":"Max","examples":[50000,10000000,100],"description":"Maximum value (inclusive)"},"min":{"anyOf":[{"type":"number"}],"title":"Min","examples":[1000,1000000,-50,0],"description":"Minimum value (inclusive)"}},"description":"Filter for numeric values (floats) with optional min/max bounds.\nUse for prices, volumes, ratios, and other decimal values. - Values between -10.5 and 100.75"}],"examples":[{"min":500000}],"description":"Total USD value of market sell trades range filter"},"trader_type":{"anyOf":[{"enum":["all","sm","whale","public_figure","high_winrate_hl_perps_trader"],"type":"string","title":"PerpTraderType","description":"Trader type for perp screener."}],"examples":["whale"],"description":"Filter by trader type. Overrides only_smart_money when provided. Values: all, sm, whale, public_figure, high_winrate_hl_perps_trader."},"token_symbol":{"anyOf":[{"type":"string"}],"title":"Token Symbol","examples":["BTC","ETH"],"description":"Asset symbol filter (e.g., BTC, ETH)"},"trader_count":{"anyOf":[{"type":"object","title":"IntegerRangeFilter","properties":{"max":{"anyOf":[{"type":"integer"}],"title":"Max","examples":[100,1000,10000],"description":"Maximum value (inclusive)"},"min":{"anyOf":[{"type":"integer"}],"title":"Min","examples":[10,100,1000],"description":"Minimum value (inclusive)"}},"description":"Filter for integer values with optional min/max bounds.\nUse for counts, numbers of items, and other whole number values. - Values between 5 and 100"}],"examples":[{"min":10}],"description":"Number of unique traders range filter"},"open_interest":{"anyOf":[{"type":"object","title":"NumericRangeFilter","properties":{"max":{"anyOf":[{"type":"number"}],"title":"Max","examples":[50000,10000000,100],"description":"Maximum value (inclusive)"},"min":{"anyOf":[{"type":"number"}],"title":"Min","examples":[1000,1000000,-50,0],"description":"Minimum value (inclusive)"}},"description":"Filter for numeric values (floats) with optional min/max bounds.\nUse for prices, volumes, ratios, and other decimal values. - Values between -10.5 and 100.75"}],"examples":[{"min":1000000}],"description":"Latest open interest range filter"},"sectors_filter":{"anyOf":[{"type":"array","items":{"type":"string"}}],"title":"Sectors Filter","examples":[["Crypto:DeFi"]],"description":"Filter by sector in category:subcategory format (e.g. Crypto:DeFi, Crypto:AI, TradFi:Stocks). Values in any other format are rejected. Note: this differs from the token screener's sectors filter, which uses bare sector names. Applied server-side."},"sm_label_filter":{"anyOf":[{"type":"array","items":{"type":"string"}}],"title":"Sm Label Filter","examples":[["30D Smart Trader"]],"description":"Filter by Nansen smart money label. Applies when trader_type is all or sm; ignored for other trader types. Applied server-side."},"only_smart_money":{"anyOf":[{"type":"boolean"}],"title":"Only Smart Money","default":false,"examples":[true],"deprecated":true,"description":"Deprecated: Use 'trader_type=sm' instead."},"buy_sell_pressure":{"anyOf":[{"type":"object","title":"NumericRangeFilter","properties":{"max":{"anyOf":[{"type":"number"}],"title":"Max","examples":[50000,10000000,100],"description":"Maximum value (inclusive)"},"min":{"anyOf":[{"type":"number"}],"title":"Min","examples":[1000,1000000,-50,0],"description":"Minimum value (inclusive)"}},"description":"Filter for numeric values (floats) with optional min/max bounds.\nUse for prices, volumes, ratios, and other decimal values. - Values between -10.5 and 100.75"}],"examples":[{"max":1000000,"min":-1000000}],"description":"Net USD flow range filter"},"previous_price_usd":{"anyOf":[{"type":"object","title":"NumericRangeFilter","properties":{"max":{"anyOf":[{"type":"number"}],"title":"Max","examples":[50000,10000000,100],"description":"Maximum value (inclusive)"},"min":{"anyOf":[{"type":"number"}],"title":"Min","examples":[1000,1000000,-50,0],"description":"Minimum value (inclusive)"}},"description":"Filter for numeric values (floats) with optional min/max bounds.\nUse for prices, volumes, ratios, and other decimal values. - Values between -10.5 and 100.75"}],"examples":[{"max":100000,"min":0.01}],"description":"Window-start mark price range filter: the close of the last complete 5-minute bucket ending at or before date.from (UTC). Rows with a null start price match only a filter with no max and a min of 0 or less."},"smart_money_volume":{"anyOf":[{"type":"object","title":"NumericRangeFilter","properties":{"max":{"anyOf":[{"type":"number"}],"title":"Max","examples":[50000,10000000,100],"description":"Maximum value (inclusive)"},"min":{"anyOf":[{"type":"number"}],"title":"Min","examples":[1000,1000000,-50,0],"description":"Minimum value (inclusive)"}},"description":"Filter for numeric values (floats) with optional min/max bounds.\nUse for prices, volumes, ratios, and other decimal values. - Values between -10.5 and 100.75"}],"examples":[{"min":100000}],"description":"Total traded notional in USD by Smart Money range filter"},"net_position_change":{"anyOf":[{"type":"object","title":"NumericRangeFilter","properties":{"max":{"anyOf":[{"type":"number"}],"title":"Max","examples":[50000,10000000,100],"description":"Maximum value (inclusive)"},"min":{"anyOf":[{"type":"number"}],"title":"Min","examples":[1000,1000000,-50,0],"description":"Minimum value (inclusive)"}},"description":"Filter for numeric values (floats) with optional min/max bounds.\nUse for prices, volumes, ratios, and other decimal values. - Values between -10.5 and 100.75"}],"examples":[{"max":1000000,"min":-1000000}],"description":"Net USD flow (buy_market_vol - sell_market_vol) range filter"},"trader_label_filter":{"anyOf":[{"type":"array","items":{"type":"string"}}],"title":"Trader Label Filter","examples":[["HL Perps Whale"]],"description":"Filter by Hyperliquid perps trader label (e.g. HL Perps Whale, HL Perps Swing Trader). Applies when trader_type is all or sm; ignored for other trader types. Applied server-side."},"smart_money_buy_volume":{"anyOf":[{"type":"object","title":"NumericRangeFilter","properties":{"max":{"anyOf":[{"type":"number"}],"title":"Max","examples":[50000,10000000,100],"description":"Maximum value (inclusive)"},"min":{"anyOf":[{"type":"number"}],"title":"Min","examples":[1000,1000000,-50,0],"description":"Minimum value (inclusive)"}},"description":"Filter for numeric values (floats) with optional min/max bounds.\nUse for prices, volumes, ratios, and other decimal values. - Values between -10.5 and 100.75"}],"examples":[{"min":50000}],"description":"Total USD value of Smart Money market buy trades range filter"},"smart_money_longs_count":{"anyOf":[{"type":"object","title":"IntegerRangeFilter","properties":{"max":{"anyOf":[{"type":"integer"}],"title":"Max","examples":[100,1000,10000],"description":"Maximum value (inclusive)"},"min":{"anyOf":[{"type":"integer"}],"title":"Min","examples":[10,100,1000],"description":"Minimum value (inclusive)"}},"description":"Filter for integer values with optional min/max bounds.\nUse for counts, numbers of items, and other whole number values. - Values between 5 and 100"}],"examples":[{"min":0}],"description":"Number of Smart Money accounts with net long position range filter"},"smart_money_sell_volume":{"anyOf":[{"type":"object","title":"NumericRangeFilter","properties":{"max":{"anyOf":[{"type":"number"}],"title":"Max","examples":[50000,10000000,100],"description":"Maximum value (inclusive)"},"min":{"anyOf":[{"type":"number"}],"title":"Min","examples":[1000,1000000,-50,0],"description":"Minimum value (inclusive)"}},"description":"Filter for numeric values (floats) with optional min/max bounds.\nUse for prices, volumes, ratios, and other decimal values. - Values between -10.5 and 100.75"}],"examples":[{"min":50000}],"description":"Total USD value of Smart Money market sell trades range filter"},"smart_money_shorts_count":{"anyOf":[{"type":"object","title":"IntegerRangeFilter","properties":{"max":{"anyOf":[{"type":"integer"}],"title":"Max","examples":[100,1000,10000],"description":"Maximum value (inclusive)"},"min":{"anyOf":[{"type":"integer"}],"title":"Min","examples":[10,100,1000],"description":"Minimum value (inclusive)"}},"description":"Filter for integer values with optional min/max bounds.\nUse for counts, numbers of items, and other whole number values. - Values between 5 and 100"}],"examples":[{"min":0}],"description":"Number of Smart Money accounts with net short position range filter"},"current_smart_money_position_longs_usd":{"anyOf":[{"type":"object","title":"NumericRangeFilter","properties":{"max":{"anyOf":[{"type":"number"}],"title":"Max","examples":[50000,10000000,100],"description":"Maximum value (inclusive)"},"min":{"anyOf":[{"type":"number"}],"title":"Min","examples":[1000,1000000,-50,0],"description":"Minimum value (inclusive)"}},"description":"Filter for numeric values (floats) with optional min/max bounds.\nUse for prices, volumes, ratios, and other decimal values. - Values between -10.5 and 100.75"}],"examples":[{"min":0}],"description":"Aggregate USD value of Smart Money long positions range filter"},"current_smart_money_position_shorts_usd":{"anyOf":[{"type":"object","title":"NumericRangeFilter","properties":{"max":{"anyOf":[{"type":"number"}],"title":"Max","examples":[50000,10000000,100],"description":"Maximum value (inclusive)"},"min":{"anyOf":[{"type":"number"}],"title":"Min","examples":[1000,1000000,-50,0],"description":"Minimum value (inclusive)"}},"description":"Filter for numeric values (floats) with optional min/max bounds.\nUse for prices, volumes, ratios, and other decimal values. - Values between -10.5 and 100.75"}],"examples":[{"min":0}],"description":"Aggregate USD value of Smart Money short positions range filter"}},"description":"Filters for perp screener endpoints.\n\nThese filters control which perpetual contracts are included in the screening\nresults based on various criteria.","additionalProperties":false}],"examples":[{"volume":{"min":10000},"token_symbol":"BTC"}],"description":"Additional filters to apply"},"order_by":{"anyOf":[{"type":"array","items":{"type":"object","title":"PerpScreenerSortOrder","required":["field","direction"],"properties":{"field":{"anyOf":[{"enum":["token_symbol","volume","buy_volume","sell_volume","buy_sell_pressure","trader_count","mark_price","funding","previous_price_usd","price_change","open_interest"],"type":"string","title":"PerpScreenerSortFieldDefault","description":"Sort fields available for default perp screener data (only_smart_money=False)."},{"enum":["token_symbol","smart_money_volume","smart_money_buy_volume","smart_money_sell_volume","net_position_change","trader_count","mark_price","funding","previous_price_usd","price_change","open_interest","current_smart_money_position_longs_usd","current_smart_money_position_shorts_usd","smart_money_longs_count","smart_money_shorts_count"],"type":"string","title":"PerpScreenerSortFieldSmartMoney","description":"Sort fields available for smart money perp screener data (only_smart_money=True)."},{"enum":["token_symbol","volume","buy_volume","sell_volume","net_position_change","trader_count","mark_price","funding","previous_price_usd","price_change","open_interest","current_position_longs_usd","current_position_shorts_usd","longs_count","shorts_count"],"type":"string","title":"PerpScreenerSortFieldNotableLabel","description":"Sort fields available for notable-label perp screener data (trader_type whale/public_figure/high_winrate_hl_perps_trader)."}],"title":"Field","description":"Field to sort by"},"direction":{"enum":["ASC","DESC"],"type":"string","title":"SortDirection","description":"Enum for sort directions."}}}}],"title":"Order By","examples":[[{"field":"buy_sell_pressure","direction":"DESC"}]],"description":"Custom sort order to override the endpoint's default ordering.\n\nExamples:\n- [{\"field\": \"volume\", \"direction\": \"DESC\"}] - Sort by volume descending\n- [{\"field\": \"net_position_change\", \"direction\": \"DESC\"}] - Sort by net_position_change descending\n- [{\"field\": \"buy_sell_pressure\", \"direction\": \"DESC\"}] - Sort by buy/sell pressure descending\n- [{\"field\": \"price_change\", \"direction\": \"DESC\"}] - Top gainers first\n\nAvailable sort fields depend on trader_type: buy_sell_pressure only applies to\ntrader_type all, net_position_change to the other trader types. price_change\napplies to every trader type. Rows with a null price_change (outcome contracts,\nmissing prices) sort last in both directions, and token_symbol ASC\nis added as a final tie-breaker so pages don't overlap.\n\nDefault behavior:\n- trader_type all (or unset): sorts by buy_sell_pressure DESC\n- all other trader types: sorts by net_position_change DESC"},"pagination":{"type":"object","title":"PaginationRequest","properties":{"page":{"type":"integer","title":"Page","default":1,"minimum":1,"description":"Page number (1-based)"},"per_page":{"type":"integer","title":"Per Page","default":10,"maximum":1000,"minimum":1,"description":"Number of records per page (max 1000)"}},"description":"Pagination parameters for API requests."},"include_price_change":{"type":"boolean","title":"Include Price Change","default":false,"description":"Return previous_price_usd, window_end_price_usd and price_change for notable-label trader cohorts even when not sorting or filtering by price. These fields are otherwise null unless price_change or previous_price_usd is used for sorting, or previous_price_usd is used for filtering. All and Smart Money results always include these fields."}},"description":"Request model for Perp Screener endpoint.","additionalProperties":false},"responseSchema":{"type":"object","title":"PerpScreenerResponse","required":["data","pagination"],"properties":{"data":{"type":"array","items":{"anyOf":[{"type":"object","title":"PerpScreenerDataDefault","required":["token_symbol"],"properties":{"volume":{"anyOf":[{"type":"number"}],"title":"Volume","examples":[427486.75766,1250000.45,2500000,500000,750000],"description":"Total traded notional in USD over the recent window."},"funding":{"anyOf":[{"type":"number"}],"title":"Funding","examples":[0.0000125,0.0001,-0.0001,0.0005,-0.0005,0.001,-0.001,0.0002,-0.0002,0.0003],"description":"Latest funding rate/value for the coin."},"buy_volume":{"anyOf":[{"type":"number"}],"title":"Buy Volume","examples":[216502.59923,625000.25,1250000,250000,375000],"description":"Total USD value of market buy trades over the recent window."},"mark_price":{"anyOf":[{"type":"number"}],"title":"Mark Price","examples":[0.3301,45000,3000,100,25,0.5,0.01,15,8,150],"description":"Latest mark price for the coin."},"sell_volume":{"anyOf":[{"type":"number"}],"title":"Sell Volume","examples":[210984.15843,625000.2,1250000,250000,375000],"description":"Total USD value of market sell trades over the recent window."},"price_change":{"anyOf":[{"type":"number"}],"title":"Price Change","examples":[-0.2055,0.0227,0.0345],"description":"Signed ratio change over the date window, window_end_price_usd / previous_price_usd - 1 (0.05 = +5%, -0.2 = -20%). Both prices are 5-minute Hyperliquid closes at the window boundaries and do not depend on which traders were active, so a coin and window have the same value in every trader_type. A historical window uses its own end price, not the latest mark. Null for outcome contracts (symbols starting with '#') and when either boundary price is missing, zero, or negative."},"token_symbol":{"type":"string","title":"Token Symbol","examples":["ARK","BTC","ETH","SOL","AVAX","MATIC","DOT","LINK","UNI","AAVE"],"description":"Asset symbol (e.g., BTC, ETH) on Hyperliquid."},"trader_count":{"anyOf":[{"type":"integer"}],"title":"Trader Count","examples":[109,250,500,1000,1500],"description":"Number of unique traders active over the recent window."},"open_interest":{"anyOf":[{"type":"number"}],"title":"Open Interest","examples":[261310.461,1000000,5000000,2500000,7500000,10000000,15000000,20000000,30000000,50000000],"description":"Latest open interest for the coin."},"buy_sell_pressure":{"anyOf":[{"type":"number"}],"title":"Buy Sell Pressure","examples":[5518.4408,25000,-15000,50000,-25000],"description":"Changes in position by Market Orders. Buys and sells through market orders (top of orderbook) indicate a rush into adjusting the position."},"previous_price_usd":{"anyOf":[{"type":"number"}],"title":"Previous Price Usd","examples":[0.4155,44000,2900,95,24,0.48,0.009,14.5,7.8,145],"description":"Window-start mark price: the close of the last complete 5-minute bucket ending at or before date.from (UTC). A 09:00 or 09:02 start uses the 08:55 to 09:00 bucket. Null when that bucket is missing or its price is not positive; no later or earlier price substitutes. HIP-3 markets (symbols like xyz:NAME) have no mark history before 2026-03-12, so their closes before then are the last trade in the bucket."},"window_end_price_usd":{"anyOf":[{"type":"number"}],"title":"Window End Price Usd","examples":[0.3301,45000,3000,100,25,0.5,0.01,15,8,150],"description":"Window-end mark price: the close of the last complete 5-minute bucket ending at or before date.to, capped at now (UTC). For a window ending now this is the latest complete bucket, not the live mark_price. Null when that bucket is missing or its price is not positive. HIP-3 markets (symbols like xyz:NAME) have no mark history before 2026-03-12, so their closes before then are the last trade in the bucket."}},"description":"Data model for perp screener results when only_smart_money is False."},{"type":"object","title":"PerpScreenerDataSmartMoney","required":["token_symbol"],"properties":{"funding":{"anyOf":[{"type":"number"}],"title":"Funding","examples":[0.0000125,0.0001,-0.0001,0.0005,-0.0005,0.001,-0.001,0.0002,-0.0002,0.0003],"description":"Latest funding rate/value for the coin."},"mark_price":{"anyOf":[{"type":"number"}],"title":"Mark Price","examples":[0.3301,45000,3000,100,25,0.5,0.01,15,8,150],"description":"Latest mark price for the coin."},"price_change":{"anyOf":[{"type":"number"}],"title":"Price Change","examples":[0.0345,-0.2055,0.0227],"description":"Signed ratio change over the date window, window_end_price_usd / previous_price_usd - 1 (0.05 = +5%, -0.2 = -20%). Both prices are 5-minute Hyperliquid closes at the window boundaries and do not depend on which traders were active, so a coin and window have the same value in every trader_type. A historical window uses its own end price, not the latest mark. Null for outcome contracts (symbols starting with '#') and when either boundary price is missing, zero, or negative."},"token_symbol":{"type":"string","title":"Token Symbol","examples":["ARK","BTC","ETH","SOL","AVAX","MATIC","DOT","LINK","UNI","AAVE"],"description":"Asset symbol (e.g., BTC, ETH) on Hyperliquid."},"trader_count":{"anyOf":[{"type":"integer"}],"title":"Trader Count","examples":[15,25,50,100,200],"description":"Number of unique Smart Money traders active over the window."},"open_interest":{"anyOf":[{"type":"number"}],"title":"Open Interest","examples":[261310.461,1000000,5000000,2500000,7500000,10000000,15000000,20000000,30000000,50000000],"description":"Latest open interest in USD (open_interest × mark_price)."},"previous_price_usd":{"anyOf":[{"type":"number"}],"title":"Previous Price Usd","examples":[0.4155,44000,2900,95,24,0.48,0.009,14.5,7.8,145],"description":"Window-start mark price: the close of the last complete 5-minute bucket ending at or before date.from (UTC). A 09:00 or 09:02 start uses the 08:55 to 09:00 bucket. Null when that bucket is missing or its price is not positive; no later or earlier price substitutes. HIP-3 markets (symbols like xyz:NAME) have no mark history before 2026-03-12, so their closes before then are the last trade in the bucket."},"smart_money_volume":{"anyOf":[{"type":"number"}],"title":"Smart Money Volume","examples":[150000,500000,1000000,2000000,5000000],"description":"Total traded notional in USD by Smart Money over the window."},"net_position_change":{"anyOf":[{"type":"number"}],"title":"Net Position Change","examples":[25000,-15000,100000,-50000,200000,-100000],"description":"Net USD flow (buy_market_vol - sell_market_vol) over the window."},"window_end_price_usd":{"anyOf":[{"type":"number"}],"title":"Window End Price Usd","examples":[0.3301,45000,3000,100,25,0.5,0.01,15,8,150],"description":"Window-end mark price: the close of the last complete 5-minute bucket ending at or before date.to, capped at now (UTC). For a window ending now this is the latest complete bucket, not the live mark_price. Null when that bucket is missing or its price is not positive. HIP-3 markets (symbols like xyz:NAME) have no mark history before 2026-03-12, so their closes before then are the last trade in the bucket."},"smart_money_buy_volume":{"anyOf":[{"type":"number"}],"title":"Smart Money Buy Volume","examples":[75000,250000,500000,1000000,2500000],"description":"Total USD value of Smart Money market buy trades over the window."},"smart_money_longs_count":{"anyOf":[{"type":"integer"}],"title":"Smart Money Longs Count","examples":[5,10,20,50,100],"description":"Number of Smart Money accounts with a net long position."},"smart_money_sell_volume":{"anyOf":[{"type":"number"}],"title":"Smart Money Sell Volume","examples":[75000,250000,500000,1000000,2500000],"description":"Total USD value of Smart Money market sell trades over the window."},"smart_money_shorts_count":{"anyOf":[{"type":"integer"}],"title":"Smart Money Shorts Count","examples":[5,10,20,50,100],"description":"Number of Smart Money accounts with a net short position."},"current_smart_money_position_longs_usd":{"anyOf":[{"type":"number"}],"title":"Current Smart Money Position Longs Usd","examples":[500000,1000000,2000000,5000000,10000000],"description":"Aggregate USD value of Smart Money long positions for the coin."},"current_smart_money_position_shorts_usd":{"anyOf":[{"type":"number"}],"title":"Current Smart Money Position Shorts Usd","examples":[-500000,-1000000,-2000000,-5000000,-10000000],"description":"Aggregate USD value of Smart Money short positions for the coin (negative)."}},"description":"Data model for perp screener results when only_smart_money is True."},{"type":"object","title":"PerpScreenerDataNotableLabel","required":["token_symbol"],"properties":{"volume":{"anyOf":[{"type":"number"}],"title":"Volume","examples":[427486.75766,1250000.45],"description":"Total traded notional in USD by the selected trader cohort over the window."},"funding":{"anyOf":[{"type":"number"}],"title":"Funding","examples":[0.0000125,-0.0001],"description":"Latest funding rate/value for the coin."},"buy_volume":{"anyOf":[{"type":"number"}],"title":"Buy Volume","examples":[216502.59923,625000.25],"description":"Total USD value of buys by the selected trader cohort over the window."},"mark_price":{"anyOf":[{"type":"number"}],"title":"Mark Price","examples":[0.3301,45000],"description":"Latest mark price for the coin."},"longs_count":{"anyOf":[{"type":"integer"}],"title":"Longs Count","examples":[5,10,20],"description":"Number of cohort accounts with a net long position."},"sell_volume":{"anyOf":[{"type":"number"}],"title":"Sell Volume","examples":[210984.15843,625000.2],"description":"Total USD value of sells by the selected trader cohort over the window."},"price_change":{"anyOf":[{"type":"number"}],"title":"Price Change","examples":[0.0227,-0.2055],"description":"Signed ratio change over the date window, window_end_price_usd / previous_price_usd - 1 (0.05 = +5%, -0.2 = -20%). Both prices are 5-minute Hyperliquid closes at the window boundaries and do not depend on which traders were active, so a coin and window have the same value in every trader_type. A historical window uses its own end price, not the latest mark. Null for outcome contracts (symbols starting with '#') and when either boundary price is missing, zero, or negative. Null unless price fields are requested with include_price_change, sorting or filtering."},"shorts_count":{"anyOf":[{"type":"integer"}],"title":"Shorts Count","examples":[5,10,20],"description":"Number of cohort accounts with a net short position."},"token_symbol":{"type":"string","title":"Token Symbol","examples":["BTC","ETH","SOL"],"description":"Asset symbol (e.g., BTC, ETH) on Hyperliquid."},"trader_count":{"anyOf":[{"type":"integer"}],"title":"Trader Count","examples":[109,250],"description":"Number of unique cohort traders active over the window."},"open_interest":{"anyOf":[{"type":"number"}],"title":"Open Interest","examples":[261310.461,5000000],"description":"Latest open interest for the coin."},"previous_price_usd":{"anyOf":[{"type":"number"}],"title":"Previous Price Usd","examples":[44000,2900],"description":"Window-start mark price: the close of the last complete 5-minute bucket ending at or before date.from (UTC). A 09:00 or 09:02 start uses the 08:55 to 09:00 bucket. Null when that bucket is missing or its price is not positive; no later or earlier price substitutes. HIP-3 markets (symbols like xyz:NAME) have no mark history before 2026-03-12, so their closes before then are the last trade in the bucket. Null unless price fields are requested with include_price_change, sorting or filtering."},"net_position_change":{"anyOf":[{"type":"number"}],"title":"Net Position Change","examples":[5518.4408,-25000],"description":"Net USD flow (buys minus sells) by the selected trader cohort over the window."},"window_end_price_usd":{"anyOf":[{"type":"number"}],"title":"Window End Price Usd","examples":[45000,3000],"description":"Window-end mark price: the close of the last complete 5-minute bucket ending at or before date.to, capped at now (UTC). For a window ending now this is the latest complete bucket, not the live mark_price. Null when that bucket is missing or its price is not positive. HIP-3 markets (symbols like xyz:NAME) have no mark history before 2026-03-12, so their closes before then are the last trade in the bucket. Null unless price fields are requested with include_price_change, sorting or filtering."},"current_position_longs_usd":{"anyOf":[{"type":"number"}],"title":"Current Position Longs Usd","examples":[500000,1000000],"description":"Aggregate USD value of cohort long positions for the coin."},"current_position_shorts_usd":{"anyOf":[{"type":"number"}],"title":"Current Position Shorts Usd","examples":[-500000,-1000000],"description":"Aggregate USD value of cohort short positions for the coin (negative)."}},"description":"Data model for perp screener when trader_type is whale, public_figure or high_winrate_hl_perps_trader."}]},"title":"Data","examples":[[{"volume":427486.75766,"funding":0.0000125,"buy_volume":216502.59923,"mark_price":0.3301,"sell_volume":210984.15843,"price_change":-0.2055,"token_symbol":"ARK","trader_count":109,"open_interest":261310.461,"buy_sell_pressure":5518.4408,"previous_price_usd":0.4155,"window_end_price_usd":0.3301},{"volume":2500000,"funding":0.0001,"buy_volume":1250000,"mark_price":45000,"sell_volume":1250000,"price_change":0.0227,"token_symbol":"BTC","trader_count":500,"open_interest":5000000,"buy_sell_pressure":25000,"previous_price_usd":44000,"window_end_price_usd":45000},{"funding":-0.0001,"mark_price":3000,"price_change":0.0345,"token_symbol":"ETH","trader_count":15,"open_interest":2000000,"previous_price_usd":2900,"smart_money_volume":150000,"net_position_change":25000,"window_end_price_usd":3000,"smart_money_buy_volume":75000,"smart_money_longs_count":5,"smart_money_sell_volume":75000,"smart_money_shorts_count":5,"current_smart_money_position_longs_usd":500000,"current_smart_money_position_shorts_usd":-500000}]],"description":"List of perp screening results"},"pagination":{"type":"object","title":"PaginationInfo","properties":{"page":{"type":"integer","title":"Page","default":1,"minimum":1,"description":"Current page number"},"per_page":{"type":"integer","title":"Per Page","default":10,"maximum":1000,"minimum":1,"description":"Number of records per page"},"is_last_page":{"type":"boolean","title":"Is Last Page","default":true,"description":"Whether this is the last page"}},"description":"Pagination information for API responses."}},"description":"Response model for perp screener endpoint."},"example":null,"exampleRequest":null,"tags":["blockchain","smart-money","wallet","tokens","defi","analytics","profiler","dex","pnl","onchain","prediction-market","data"],"displayCostAmount":"0.01","displayCostAsset":"USDC","priceDynamic":false,"priceHint":null,"priceStatus":"priced","priceSource":"probe","requiresHandshake":false,"reviewCount":0,"rating":{"score":"0.00","successRate":"0.00","reviews":0,"stars":null,"state":"unrated"},"availabilityStatus":"unknown","priceObserved":null,"sessionDeposit":null,"pricing":{"kind":"static","summary":"$0.01/call","primary":{"kind":"static","protocol":"mpp","network":"tempo","amountUsd":"0.01","per":"call","confidence":"exact"},"accepted":[{"kind":"static","protocol":"mpp","network":"tempo","amountUsd":"0.01","per":"call","confidence":"exact"}]},"paymentMethods":[{"uid":"pm_i1HpIKoh89S-AAGH3gFU9","protocol":"mpp","methodType":"crypto","chain":"tempo","mode":"charge","costAmount":"0.01","costPer":"request","priority":0,"asset":"0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913","unit":"request","depositMicros":null,"planRef":null}],"brandName":"Nansen","brandSlug":"nansen","brandBaseUrl":"https://nansen.ai","brandDocsUrl":"https://docs.nansen.ai","whatItDoes":"Screen and filter perpetual contracts on Hyperliquid by volume, open interest, funding rates, and smart money activity over a specified date range.","exampleAgentPrompt":"Can you screen Hyperliquid perpetual contracts for January 2025 and show me the ones with at least $1M in volume and positive funding rates — I want to see which ones are attracting the most smart money activity?","exampleUseCases":null,"resultDescription":"Returns a paginated list of perpetual contract records for the specified date range, each including token symbol, total volume, buy/sell volume breakdown, mark price, funding rate, open interest, trader count, buy/sell pressure, and smart money long/short position metrics. Supports filtering on all key metrics.","failureModes":["Missing required 'date' field returns 422 validation error","Invalid date format returns parsing error","Overly restrictive filters return empty data array","Date range too large may result in timeout or truncated results","Invalid filter field types (e.g. string instead of number) return schema validation error"],"whenToPreferThis":"Use this endpoint when you need to discover or rank perpetual contracts on Hyperliquid based on quantitative metrics like volume, open interest, funding rates, or smart money positioning. Prefer this over the Perp Trades endpoint (which shows individual trades for a specific token) when you want a broad market overview or want to identify which contracts to investigate further.","instructions":null,"reviewSummary":null,"reviewSummaryHighlights":null,"reviewSummaryConcerns":null,"reviewSummaryGeneratedAt":null,"activationCount":0,"lastUsedAt":null,"lastSuccessfullyRanAt":null,"lastHealthCheckAt":"2026-10-10T06:38:12.172Z","isFirstParty":false,"canonicalSlug":"nansen-perp-screener-2161c134"}