Docs menu

Watchlists & screener

Your saved lists and screens, and a screener over every Hyperliquid market.

Updated

list_watchlists

Your saved watchlists and screener screens, with live figures for each market if asked.

  • Reads only

Inputs

  • withMarketDatatrue or false

    Default false.

What the AI app reads

The user's watchlists saved to their account (id, name, sections, markets, the columns the list shows) and their saved screener screens (id, name, rules). Markets are symbols like BTC-PERP, xyz:AAPL-PERP or HYPE-SPOT. With withMarketData: true each market also carries its last price, 24h change in %, funding in % per 8 h, 24h volume and open interest in dollars.

edit_watchlist

Makes, changes or deletes a watchlist: add or remove markets, choose its columns and sort.

  • Makes changes
  • Two steps to delete a list
  • A deleted list can’t come back

Inputs

  • listIdtext (letters, digits, - and _, up to 64)

    From list_watchlists; favs is Favourites. Leave out, with a name, to make a new list.

  • nametext (not empty, up to 40 characters)
  • addlist of up to 500; each text (not empty, up to 60 characters)
  • sectiontext (up to 40 characters)
  • removelist of up to 500; each text (not empty, up to 60 characters)
  • columnslist of up to 5; each one of last, chg, funding, vol, oi
  • sortone of manual, chg, price
  • deletetrue or false

    true deletes the list, together with confirm.

  • confirmtrue or false

    Needed with delete. Without it the tool asks the AI app to name the list and how many markets it holds first. Default false.

What the AI app reads

Make, change or delete one of the user's watchlists saved to their account. Leave listId out and give a name to make a new list. add and remove take markets as BTC-PERP, HYPE-SPOT, xyz:AAPL-PERP or a plain name (a plain name means the perpetual when there is one); add puts them in section (found by name, made when new; none = the first section). run_screen's allMatched can go straight into add. columns = the figures the list shows (last, chg, funding, vol, oi); sort = manual, chg or price. Favourites (listId "favs") can be changed but not renamed or deleted. Deleting can't be undone: tell the user which list first.

run_screen

Screens every Hyperliquid market by change, volume, open interest, funding, RSI or distance from an average, or runs one of your saved screens.

  • Reads only

Inputs

  • screenIdtext (letters, digits, - and _, up to 64)

    From list_watchlists.

  • screenNametext (not empty, up to 60 characters)
  • rulesobject
    • kindone of all, perps, spot, hip3
    • chgMinnumber or null
    • chgMaxnumber or null
    • volMinnumber (at least 0) or null
    • oiMinnumber (at least 0) or null
    • fundMinnumber or null
    • fundMaxnumber or null
    • tfone of 15m, 1h, 4h, 1d
    • rsiLenwhole number (2 to 100)
    • rsiMinnumber (0 to 100) or null
    • rsiMaxnumber (0 to 100) or null
    • maTypeone of sma, ema
    • maLenwhole number (2 to 200)
    • maDistMinnumber or null
    • maDistMaxnumber or null
  • sortByone of market, last, chg, funding, vol, oi, rsi, maDist
  • sortDirone of asc, desc
  • limitwhole number (1 to 50)

    Default 20.

What the AI app reads

Screen every Hyperliquid market (main perpetuals, HIP-3 markets and spot) by rules, or run one of the user's saved screens (screenId or screenName from list_watchlists). Rules: kind all|perps|spot|hip3; chgMin / chgMax = 24h change in %; volMin = 24h volume and oiMin = open interest, both in MILLIONS of dollars; fundMin / fundMax = funding in % per 8 h. Indicator rules are read on the last closed bar of tf (15m, 1h, 4h or 1d; default 1h): rsiMin / rsiMax with rsiLen (default 14), and maDistMin / maDistMax = how far the close is from its average, in %, with maType sma|ema and maLen (default 50). No rules = every market. Most traded first unless sortBy says otherwise. Markets whose price history could not be read are listed as not checked, with the reason — say so rather than treating them as failing. allMatched can go straight into edit_watchlist's add.

↑↓ to move↵ to openEsc to closeAll help