{ "openapi": "3.0.1", "info": { "title": "Spotify Scraper — Play Counts, Monthly Listeners & Playlists", "description": "Scrape Spotify tracks, artists, albums, playlists and podcasts: play counts, monthly listeners, followers, world rank, top cities, playlist tracks. No login.", "version": "0.1", "x-build-id": "oSQpmOgFCdVjkXvXN" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tortuga~spotify-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tortuga-spotify-scraper", "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/tortuga~spotify-scraper/runs": { "post": { "operationId": "runs-sync-tortuga-spotify-scraper", "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/tortuga~spotify-scraper/run-sync": { "post": { "operationId": "run-sync-tortuga-spotify-scraper", "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": { "urls": { "title": "Spotify URLs, URIs or IDs", "type": "array", "description": "Track, artist, album, playlist, podcast (show) or episode links from open.spotify.com, spotify: URIs (spotify:artist:0gxyHStUsqpMadRV0Di1Qt) or spotify.link short links. A bare 22-character ID is read as a track ID. Tracks give play counts; artists give monthly listeners, followers, world rank, top cities, top tracks and discography; albums give every track with its play count; playlists give their details plus every track with the date it was added.", "items": { "type": "string" } }, "searchQueries": { "title": "Search terms", "type": "array", "description": "Keywords to search on Spotify, e.g. lofi hip hop or workout playlist. Each term returns results of the type chosen below, in Spotify's own ranking (up to the per-term limit).", "items": { "type": "string" } }, "searchType": { "title": "Search for", "enum": [ "tracks", "artists", "albums", "playlists", "podcasts", "episodes" ], "type": "string", "description": "What the search terms should return.", "default": "tracks" }, "maxResultsPerSearch": { "title": "Max results per search term", "minimum": 1, "maximum": 1000, "type": "integer", "description": "How many results to take per search term. Spotify's search itself usually stops after about 100 results per term and type.", "default": 50 }, "searchDetails": { "title": "Full details for search results", "type": "boolean", "description": "Open every search result to add what the search list does not show: play counts for tracks, monthly listeners/followers/top cities for artists, label and per-track play counts for albums, followers and track count for playlists, episode count for podcasts. One extra request per result; turn off for faster, lighter results.", "default": true }, "includeDiscography": { "title": "Full artist discography", "type": "boolean", "description": "For artist URLs, list every album, single and compilation with its release date (otherwise only the 10 latest of each, as shown on the artist page).", "default": true }, "playlistTracks": { "title": "Output playlist tracks", "type": "boolean", "description": "For playlist URLs, also output every track of the playlist as its own row (position, date added, added by, play count, BPM, key). Off = only the playlist's details (followers, owner, description, track count).", "default": true }, "maxTracksPerPlaylist": { "title": "Max tracks per playlist", "minimum": 1, "type": "integer", "description": "Stop after this many tracks of each playlist (in playlist order). Empty = all tracks." }, "maxEpisodesPerShow": { "title": "Episodes per podcast", "minimum": 0, "type": "integer", "description": "For podcast (show) URLs, how many of the latest episodes to output as rows (title, description, release date, duration). 0 = only the show's details.", "default": 20 }, "maxItems": { "title": "Max items", "minimum": 1, "type": "integer", "description": "Stop after this many dataset rows in total (tracks, artists, albums, playlists, playlist tracks, shows, episodes). Keeps cost predictable.", "default": 100 }, "onlyNewOrChanged": { "title": "Only new or changed items", "type": "boolean", "description": "Remember what earlier runs of this input returned and output only new items or items whose numbers changed: track play counts, artist monthly listeners/followers/world rank, album play totals, playlist followers/track count, and tracks newly added to a playlist. Use with a Schedule; unchanged items are not charged.", "default": false }, "monitoringKey": { "title": "Monitoring key", "type": "string", "description": "Name for this watch, so several schedules on the same search stay separate; defaults to a key derived from the search input" }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Apify Proxy (datacenter) works for Spotify and is the default; no residential proxy needed.", "default": { "useApifyProxy": true } } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }