$search

$search will search for tracks.

Usage

$search[query;type?;format?;limit?;separator?;page?]

Parameters

Field	Type	Description	Required
query	string	The query to search for.	true
type?	string	Source type: youtube, youtubemusic, applemusic, soundcloud, spotify, deezer, etc. depends on your lavalink node	false
format?	string	format to display information about the songs (read bellow)	false
limit?	number	The maximum amount of songs that will be returned. default is 10	false
separator?	string	The separator between songs	false
page?	number	Search page. default is 1	false

Formatting

Field	Returns	Description
{position}	number	Song position in the queue
{title}	string	Song title
{thumbnail}	string	Song thumbnail (if any)
{url}	string	Song url
{duration}	string	Song duration
{artist}	string	Song author
{platform}	string	Track player platform
{identifier}	string	Track identifier
{isSeekable}	boolean	Return true if the track is seekable
{isStream}	boolean	Return true if the track is streaming
{isrc}	string	Track isrc
{durationMs}	number	Song duration in milliseconds
{queueLength}	number	Player queue length
{albumName}	string	Song album name (if any)
{albumUrl}	string	Song album url (if any)
{artist.avatar}	string	Artist artwork url (if any)
{artist.url}	string	Artist url (if any)
{playlist.name}	string	Track playlist name
{playlist.author}	string	Track playlist author
{playlist.thumbnail}	string	Track playlist thumbnail
{playlist.tracks}	number	Total tracks in the playlist
{playlist.url}	string	Playlist URL

Example(s)

Default

This will search for video/song titles with the name of “Reckless”:

client.command({
    name: 'search',
    code: `
    $search[Reckless;youtube;{title} by {artist};10]
  `
});

Command Handler

This will search for video/song titles with the name of “Reckless”:

module.exports = [{
    name: "search",
    code: `
    $search[Reckless;youtube;{title} by {artist};10]
  `
}]