Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Optional include_external

include_external: string

If include_external=audio is specified the response will include any relevant audio content that is hosted externally

By default external content is filtered out from responses

Optional limit

limit: number

The maximum number of results to return

Default: 20, Minimum: 1, Maximum: 50

Note: The limit is applied within each type, not on the total response. For example, if the limit value is 3 and the type is artist,album the response contains 3 artists and 3 albums

Optional market

market: string

An ISO 3166-1 alpha-2 country code. If a country code is specified, only items that are available in that market will be returned

If a valid user access token is specified in the request header, the country associated with the user account will take priority over this parameter

⚠️Note: If neither market nor user country is provided, the content is considered unavailable for the client

Optional offset

offset: number

The index of the first item to return

Default: 0 (the first object)

Use with limit to get the next set of items

q

q: string

Search query keywords and optional field filters and operators

For example: q=roadhouse%20blues

type

type: string[]

A comma-separated list of item types to search across

Valid types are: album, artist, playlist, track, show, and episode

Search results include hits from all the specified item types

For example: q=name:abacab&type=album,track returns both albums and tracks with abacab included in their name

Legend

  • Property

Generated using TypeDoc