Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

Optional country

country: string

An ISO 3166-1 alpha-2 country code

Optional limit

limit: number

The maximum number of items to return

Default: 20, Minimum: 1, Maximum: 50

Optional locale

locale: string

The desired language, consisting of an ISO 639-1 language code and an ISO 3166-1 alpha-2 country code, joined by an underscore. For example: es_MX, meaning Spanish (Mexico). Provide this parameter if you want the results returned in a particular language (where available)

Note: If locale is not supplied, or if the specified language is not available, all strings will be returned in the Spotify default language (American English). The locale parameter, combined with the country parameter, may give odd results if not carefully matched. For example country=SE&locale=de_DE will return a list of items relevant to Sweden but as German language strings

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

Optional timestamp

timestamp: string

A timestamp in ISO 8601 format: yyyy-MM-ddTHH:mm:ss. Use this parameter to specify the user’s local time to get results tailored for that specific date and time in the day. If not provided, the response defaults to the current UTC time. Example: 2014-10-23T09:00:00 for a user whose local time is 9AM. If there were no featured playlists (or there is no data) at the specified time, the response will revert to the current UTC time

Legend

  • Property

Generated using TypeDoc