Use LavaSearch

Lyra supports the LavaSearch plugin, which provides rich search results including tracks, albums, artists, playlists, and text suggestions from a single query.

Important

LavaSearch must be installed on your Lavalink server. See the LavaSearch installation guide for instructions.

You must also pass search=True when creating your node:

await NodePool.create_node(
    bot=bot,
    host="127.0.0.1",
    port=2333,
    password="youshallnotpass",
    identifier="MAIN",
    search=True,
)

Accessing the SearchManager

The SearchManager is available from any Node via Node.search:

node = await NodePool.get_node(identifier="MAIN")
search_manager = node.search

Performing a search

Use SearchManager.load_search() to run a rich search query:

from lava_lyra import LavaSearchType, SearchType

result = await search_manager.load_search(
    query="architects animals",
    types=[LavaSearchType.TRACK, LavaSearchType.ALBUM],
    search_type=SearchType.ytsearch,
    ctx=ctx,
)

if result:
    print(f"Tracks found: {len(result.tracks)}")
    print(f"Albums found: {len(result.albums)}")

Parameters

Name	Type	Description
query	str	The search query string.
types	List[LavaSearchType]	The types of results to return. At least one must be specified.
search_type	Optional[SearchType]	The search platform to use (e.g. ytsearch, spsearch, scsearch). Uses the server default if not provided.
ctx	Optional[Context]	Optional Discord context to attach to result tracks.

Search types (LavaSearchType)

Value	Description
LavaSearchType.TRACK	Returns individual tracks.
LavaSearchType.ALBUM	Returns albums.
LavaSearchType.ARTIST	Returns artists.
LavaSearchType.PLAYLIST	Returns playlists.
LavaSearchType.TEXT	Returns text-based search suggestions.

The SearchResult object

load_search() returns a SearchResult object with the following attributes:

Attribute	Type	Description
tracks	List[Track]	The tracks found.
albums	List[Playlist]	The albums found.
artists	List[Playlist]	The artists found.
playlists	List[Playlist]	The playlists found.
texts	List[Text]	Text suggestions returned by the plugin.
plugin_info	dict	Raw plugin metadata from the response.

Example: search and play the first result

from lava_lyra import LavaSearchType, SearchType

@commands.command(name="search")
async def search(self, ctx, *, query: str):
    if not ctx.voice_client:
        await ctx.invoke(self.join)

    player = ctx.voice_client
    node = player.node

    result = await node.search.load_search(
        query=query,
        types=[LavaSearchType.TRACK],
        search_type=SearchType.ytsearch,
        ctx=ctx,
    )

    if not result or not result.tracks:
        await ctx.send("No results found.")
        return

    track = result.tracks[0]
    await player.play(track=track)
    await ctx.send(f"Now playing: **{track.title}**")

Example: search Spotify for a track and album

result = await node.search.load_search(
    query="metallica",
    types=[LavaSearchType.TRACK, LavaSearchType.ALBUM, LavaSearchType.ARTIST],
    search_type=SearchType.spsearch,
    ctx=ctx,
)

if result:
    if result.tracks:
        print("Top track:", result.tracks[0].title)
    if result.albums:
        print("Top album:", result.albums[0].name)
    if result.artists:
        print("Top artist:", result.artists[0].name)

Note

Albums, artists, and playlists returned by load_search() do not include their full track lists — only the metadata. Use Node.get_tracks() with the playlist URL to load the full contents of an album or playlist.