{ "openapi": "3.0.1", "info": { "title": "SoundCloud Scraper — Tracks, Playlists, Artists & Comments", "description": "HTTP-only, no-login SoundCloud scraper via public api-v2. Tracks, playlists, artists, search, comments, likes & reposts feeds. Adds resolved MP3/HLS stream URLs, engagement analytics, dedup & monitoring.", "version": "0.0", "x-build-id": "lUdHNzahXiHqoEVWd" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/brilliant_gum~soundcloud-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-brilliant_gum-soundcloud-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/brilliant_gum~soundcloud-scraper/runs": { "post": { "operationId": "runs-sync-brilliant_gum-soundcloud-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/brilliant_gum~soundcloud-scraper/run-sync": { "post": { "operationId": "run-sync-brilliant_gum-soundcloud-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", "required": [ "mode" ], "properties": { "mode": { "title": "Mode", "enum": [ "searchTracks", "searchPlaylists", "searchUsers", "trackUrl", "playlistUrl", "userUrl", "userLikes", "userReposts", "trackComments", "relatedTracks", "resolveUrl" ], "type": "string", "description": "What to scrape. Search modes use Search queries; the other modes use Start URLs. Extra modes beyond a basic scraper: user likes feed, user reposts feed, a track's comments, related tracks, and resolve any SoundCloud URL.", "default": "searchTracks" }, "searchQueries": { "title": "Search queries", "type": "array", "description": "Search terms to find tracks, playlists, or users/artists (depending on the selected search mode). One query per line.", "default": [], "items": { "type": "string" } }, "startUrls": { "title": "Start URLs", "type": "array", "description": "SoundCloud track, playlist/set, or user profile URLs to scrape directly. Used with Track/Playlist/User URL modes and the likes, reposts, comments and related modes.", "default": [], "items": { "type": "string" } }, "maxResults": { "title": "Max results per query/URL", "minimum": 0, "type": "integer", "description": "Maximum number of items to extract per search query or per start URL. Use 0 for unlimited (fetch every page).", "default": 100 }, "includeUserDetails": { "title": "Include full creator details", "type": "boolean", "description": "Include the full creator/artist profile (followers, bio, city, badges) embedded in each track result. Slightly slower but richer.", "default": true }, "includePlaylistTracks": { "title": "Expand playlist child tracks", "type": "boolean", "description": "In Playlist/Set URL mode, emit each public child track (fully hydrated) after the playlist metadata row. maxResults then limits child tracks per playlist.", "default": false }, "resolveStreamUrls": { "title": "Resolve stream URLs (MP3/HLS)", "type": "boolean", "description": "Resolve the real, playable progressive MP3 URL and HLS URL for each public track (signed, expiring CDN links). Adds one extra request per track.", "default": false }, "includeComments": { "title": "Attach comments sample to tracks", "type": "boolean", "description": "Attach a sample of the newest comments (see Comments limit) to each track result. Adds one extra request per track.", "default": false }, "commentsLimit": { "title": "Comments limit", "minimum": 1, "type": "integer", "description": "Number of comments to attach per track when 'Attach comments sample' is on, and the number of comment rows returned in Track comments mode.", "default": 10 }, "includeAnalytics": { "title": "Include engagement analytics", "type": "boolean", "description": "Add computed engagement metrics to each track: plays per day since upload, like/repost/comment rates and a combined engagement rate.", "default": true }, "searchGenreFilter": { "title": "Search genre filter", "type": "string", "description": "Optional server-side genre filter applied to search modes, e.g. 'Techno', 'Hip-hop & Rap', 'Ambient'. Leave empty for no filter.", "default": "" }, "dedupResults": { "title": "Deduplicate results", "type": "boolean", "description": "Drop duplicate items (by SoundCloud id) within a single run so the same track/user/playlist is not pushed twice.", "default": true }, "clientId": { "title": "SoundCloud client_id (optional)", "type": "string", "description": "Optional override for the SoundCloud web client_id. Leave empty to auto-resolve one at runtime (recommended).", "default": "" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Apify Proxy. The default (datacenter) is usually enough; switch to Residential if you hit rate limits.", "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 } } } } } } } } } }