# 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 - **Stats:** 236 total users, 21 monthly users, 100.0% runs succeeded, 8 bookmarks - **User rating**: No ratings yet ## Pricing $5.00/month + usage To use this Actor, you pay a monthly rental fee to the developer. The rent is subtracted from your prepaid usage every month after the free trial period.You also pay for the Apify platform usage, which gets cheaper the higher Apify subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#rental-actors ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. 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. Actors are written with capital "A". ## 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. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/platform/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # 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 '' with your token const client = new ApifyClient({ 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 '' with your token. client = ApifyClient("") # 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("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).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": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=augeas/spotify-playlists", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Spotify Playlists", "description": "Get Spotify playlist tracks and metadata, from playlist URLs or search results.", "version": "1.0", "x-build-id": "Ed63kl0kvANfrvtk7" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/augeas~spotify-playlists/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-augeas-spotify-playlists", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/augeas~spotify-playlists/runs": { "post": { "operationId": "runs-sync-augeas-spotify-playlists", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/augeas~spotify-playlists/run-sync": { "post": { "operationId": "run-sync-augeas-spotify-playlists", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "playlist URLs to start with, of the form https://open.spotify.com/playlist/SPOTIFY_PLAYLIST_ID", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "terms": { "title": "terms", "type": "array", "description": "terms to use when searching for playlists" }, "maxTracks": { "title": "maximum tracks", "type": "integer", "description": "maximum number of tracks to retrieve per playlist, default 1000", "default": 1000 }, "maxItems": { "title": "maximum items", "type": "integer", "description": "maximum number of playlists to retrieve per search term, default 100", "default": 100 }, "expand": { "title": "expand playlists", "type": "boolean", "description": "retrieve all the tracks for the playlists returned by searches" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Specifies proxy servers that will be used by the scraper in order to hide its origin.", "default": { "useApifyProxy": false } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```