$search
$search
will search for tracks.
Usage
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.artworkUrl} | string | Artist artwork url (if any) |
{artist.url} | string | Artist url (if any) |
Example(s)
This will search for video/song titles with the name of “Reckless”:
This will search for video/song titles with the name of “Reckless”: