# Spotify Playlists (`augeas/spotify-playlists`) Actor

Get Spotify playlist tracks and metadata, from playlist URLs or search results.

- **URL**: https://apify.com/augeas/spotify-playlists.md
- **Developed by:** [Giles Greenway](https://apify.com/augeas) (community)
- **Categories:** Other
- **Features:** Limited permissions
- **Stats:** 314 total users, 37 monthly users, 99.8% runs succeeded, 9 bookmarks
- **User rating**: No ratings yet

## Pricing

from $3.20 / 1,000 playlists

This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events.
Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have.

Learn more: https://docs.apify.com/actors/running/actors-in-store.md#pay-per-event

## What's an Apify Actor?

An Actor is a serverless cloud program that runs on the Apify platform. It has two run modes.
In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours,
and optionally produces a well-defined JSON output, datasets with results, or files in key-value store.
In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server.

Apify vocabulary and the platform model are defined once, in the agent quickstart at https://apify.com/agents.md.

## How to integrate an Actor?

If asked about integration, you help developers integrate Actors into their projects.
You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready.

Do not guess an integration path. Every one of them is in the agent quickstart at https://apify.com/agents.md: the Apify MCP server, Agent Skills with the Apify CLI, the JavaScript and Python clients, the REST API, and the account-free path for an agent with no human to sign in. It also carries the rule on stating cost before the first paid run.

For examples already wired to this Actor's own input schema, see the [API](#api) section below.

Each client library has reference documentation the quickstart does not restate: [JavaScript/TypeScript](https://docs.apify.com/api/client/js/docs.md) (`npm install apify-client`) and [Python](https://docs.apify.com/api/client/python/docs.md) (`pip install apify-client`).

# README

### Spotify Playlists

The [Spotify Playlist API](https://developer.spotify.com/documentation/web-api/reference/get-featured-playlists) has generous rate-limits, but doesn't actually include an API for an artists' featured playlists. For that, you can use the [Spotify Monthly Listeners Actor](https://apify.com/augeas/spotify-monthly-listeners). (Curiously, there is *still* no API for monthly listeners either.) You *could* get an API key and make multiple calls to their playlist API to retrieve metadata and every track, but why bother when you can get them all at once here? You can *also* retrieve playlists by searching.

#### Input Fields

- startURLs: URLs in the form `https://open.spotify.com/playlist/SPOTIFY_PLAYLIST_ID`, eg: [`https://open.spotify.com/playlist/64K9TrsSg4xuaIxkZTOqz3`](https://open.spotify.com/playlist/64K9TrsSg4xuaIxkZTOqz3)
- terms: an array of search terms to use, eg: `["vapourwave", "minimalwave"]`
- maxTracks: the maximum number of tracks to retrieve per playlist, defaults to 1000
  (Be warned that at most 50 tracks can be retrieved per request, and some playlists are rather large.)
- maxItems: the maximum number of playlists to return when searching, defaults to 100
- pageSize: number of results to return per request when searching, defaults to the maximum of 50
- expand: whether to retrieve all the tracks for the search results, defaults to `true`, subject to `maxTracks`

#### Output Format

If you specify playlist URLs, you get playlist metadata and tracks:

```json
[
  {
    "playlistId": "64K9TrsSg4xuaIxkZTOqz3",
    "playlistName": "Splatter Platters & Death Discs",
    "description": "Death discs have come under a variety of names over the years...",
    "ownerName": "mrs.sharpadero",
    "ownerId": "mrs.sharpadero",
    "ownerImage": "https://i.scdn.co/image/ab6775700000ee850d450b68ca03d533137a0fe2",
    "images": [
      "https://image-cdn-ak.spotifycdn.com/image/ab67706c0000da84f92649defe46fc1b8aab47f9"
    ],
    "timestamp": "2024-09-24T21:12:06.301621",
    "followers": 214,
    "totalTracks": 70,
    "tracks": [
      {
        "trackName": "Leader Of The Pack",
        "trackId": "6O5PIO5pAWxdoxvaUFQ02G",
        "artists": [
          {
            "artistName": "The Shangri-Las",
            "artistId": "1WvziZcLLYLoMMdmQx7qcN"
         }
        ],
        "plays": "35181107",
        "trackDuration": 171333,
        "albumName": "The Best Of The Shangri-Las",
        "albumId": "76fF3MnSilSrvfW1fAWHAZ",
        "albumArt": "https://i.scdn.co/image/ab67616d0000b2739bd4306ef696c6fcfd8e417b",
        "contentRating": "NONE",
        "addedAt": "2022-07-05T06:10:46+00:00",
        "trackNumber": 2
      }
    ]
  }
]
```

Results from searches will also include the `searchTerms` and `searchRank`. Unless `expand` is set `true`, the output will be somewhat restricted.

# Actor input Schema

## `startUrls` (type: `array`):

playlist URLs to start with, of the form https://open.spotify.com/playlist/SPOTIFY_PLAYLIST_ID

## `terms` (type: `array`):

terms to use when searching for playlists

## `maxTracks` (type: `integer`):

maximum number of tracks to retrieve per playlist, default 1000

## `maxItems` (type: `integer`):

maximum number of playlists to retrieve per search term, default 100

## `expand` (type: `boolean`):

retrieve all the tracks for the playlists returned by searches

## `proxyConfiguration` (type: `object`):

Specifies proxy servers that will be used by the scraper in order to hide its origin.

## Actor input object example

```json
{
  "startUrls": [
    {
      "url": "https://open.spotify.com/playlist/64K9TrsSg4xuaIxkZTOqz3"
    }
  ],
  "maxTracks": 1000,
  "maxItems": 100,
  "expand": true,
  "proxyConfiguration": {
    "useApifyProxy": false
  }
}
```

# API

You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup.

## JavaScript example

```javascript
import { ApifyClient } from 'apify-client';

// Initialize the ApifyClient with your Apify API token
// Replace the '<YOUR_API_TOKEN>' with your token
const client = new ApifyClient({
    token: '<YOUR_API_TOKEN>',
});

// Prepare Actor input
const input = {
    "startUrls": [
        {
            "url": "https://open.spotify.com/playlist/64K9TrsSg4xuaIxkZTOqz3"
        }
    ],
    "expand": true,
    "proxyConfiguration": {
        "useApifyProxy": false
    }
};

// Run the Actor and wait for it to finish
const run = await client.actor("augeas/spotify-playlists").call(input);

// Fetch and print Actor results from the run's dataset (if any)
console.log('Results from dataset');
console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`);
const { items } = await client.dataset(run.defaultDatasetId).listItems();
items.forEach((item) => {
    console.dir(item);
});

// 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs

```

## Python example

```python
from apify_client import ApifyClient

# Initialize the ApifyClient with your Apify API token
# Replace '<YOUR_API_TOKEN>' with your token.
client = ApifyClient("<YOUR_API_TOKEN>")

# Prepare the Actor input
run_input = {
    "startUrls": [{ "url": "https://open.spotify.com/playlist/64K9TrsSg4xuaIxkZTOqz3" }],
    "expand": True,
    "proxyConfiguration": { "useApifyProxy": False },
}

# Run the Actor and wait for it to finish
run = client.actor("augeas/spotify-playlists").call(run_input=run_input)

# Fetch and print Actor results from the run's dataset (if there are any)
print(f"💾 Check your data here: https://console.apify.com/storage/datasets/{run.default_dataset_id}")
for item in client.dataset(run.default_dataset_id).iterate_items():
    print(item)

# 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start

```

## CLI example

```bash
echo '{
  "startUrls": [
    {
      "url": "https://open.spotify.com/playlist/64K9TrsSg4xuaIxkZTOqz3"
    }
  ],
  "expand": true,
  "proxyConfiguration": {
    "useApifyProxy": false
  }
}' |
apify call augeas/spotify-playlists --silent --output-dataset

```

## MCP server setup

```json
{
    "mcpServers": {
        "apify": {
            "type": "http",
            "url": "https://mcp.apify.com/?tools=fetch-actor-details,augeas/spotify-playlists"
        }
    }
}
```

The hosted server signs you in with OAuth on first connect, so no API token belongs in this config. Clients without OAuth support can send an `Authorization: Bearer <APIFY_API_TOKEN>` header instead, using a token from API & Integrations in Apify Console (https://console.apify.com/settings/integrations).

## OpenAPI specification

Download the OpenAPI definition: https://api.apify.com/v2/actors/gA5xAuvu1Kusnsc5S/builds/JcffOLeJcquWje0z8/openapi.json