index/interfaces/FetchPoolsOptions.md

Public-facing options for fetching pools. type and streamStatus are taken in any case and sent as the backend spells them; a value the backend does not accept is refused with a ValidationError, never dropped.

Since

6.11.0 - Now extends SearchablePaginationOptions for DRY compliance

Updated

9.0.0 - The backend's uppercase spellings; pageSize up to 100

Extends

• SearchablePaginationOptions

Properties

Property	Type	Description	Inherited from
creatorAddress?	string	Only pools created by this address: eth|<40 hex> or client|<24 hex> (a 0x-prefixed or bare 40-hex address is accepted and sent as eth|...). An empty string or any other value is a ValidationError; leave it out for no filter. Since 9.0.0-rc.2	-
cursor?	string	Cursor token for fetching the next page (omit for first page) - for cursor-based pagination	SearchablePaginationOptions.cursor
hasRecordings?	boolean	Only pools that have at least one recording (recordingsCount > 0). Only true is sent (see hasUpcomingShows). Since 5.8.0	-
hasUpcomingShows?	boolean	Only pools with nextLiveStreamAt in the future (has upcoming shows). Only true is sent: the backend reads any value of this parameter as true, so false means "no filter". Since 5.7.0	-
isGraduated?	boolean	Graduation filter: true for graduated pools only, false for pools still on the bonding curve. Both values are sent ("true" / "false": the backend reads this parameter strictly, unlike hasUpcomingShows / hasRecordings); leave it out for no filter. Since 9.0.0-rc.2	-
language?	string	Filter pools by stream language (ISO 639-1 code, e.g., "en", "es", "ja") Since 5.7.0	-
pageSize?	number	Page size for cursor-based pagination (defaults to 50, max 1000)	SearchablePaginationOptions.pageSize
recentlyStreamed?	number	Filter pools that have streamed within the last N hours Examples: 24 for last day, 168 for last week, max 720 (30 days) Since 5.7.0	-
search?	string	Fuzzy search filter (case-insensitive, partial matching)	SearchablePaginationOptions.search
streamStatus?	"IDLE" | "ACTIVE" | "DISABLED" | "idle" | "active" | "disabled"	Filter pools by stream status (IDLE, ACTIVE, DISABLED) Used by overseers for CCTV monitoring grid Since 5.10.0	-
tokenName?	string	Exact match filter (case-sensitive, strict equality)	SearchablePaginationOptions.tokenName
type?	"RECENT" | "POPULAR" | "RECORDINGS" | "SECONDS_STREAMED" | "recent" | "popular" | "recordings" | "seconds_streamed"	Pool type filter - 'RECENT': Sort by creation date (the backend's default) - 'POPULAR': Sort by bonding curve percentage - 'RECORDINGS': Sort by recordings count (highest first) - 'SECONDS_STREAMED': Sort by total seconds streamed (highest first) Since 5.8.0 - Added 'recordings' and 'seconds_streamed' options	-