{ "openapi": "3.0.1", "info": { "title": "Songsterr scraper", "description": "Download Songsterr tabs as Guitar Pro (GP5) files, track JSON, lyrics and chords. Scrape a single song or a full artist catalog.", "version": "0.0", "x-build-id": "ge6vKi3TfRtSLfVKT" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrapescape~songsterr-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrapescape-songsterr-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/scrapescape~songsterr-scraper/runs": { "post": { "operationId": "runs-sync-scrapescape-songsterr-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/scrapescape~songsterr-scraper/run-sync": { "post": { "operationId": "run-sync-scrapescape-songsterr-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": { "startUrls": { "title": "Songsterr URLs", "type": "array", "description": "Song URLs (e.g. https://www.songsterr.com/a/wsa/led-zeppelin-stairway-to-heaven-tab-s27) and/or artist URLs (e.g. https://www.songsterr.com/a/wsa/metallica-tabs-a20). Artist URLs scrape the whole catalog.", "default": [], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "searchQueries": { "title": "Song search queries", "type": "array", "description": "Free text such as \"Metallica - One\", \"One by Metallica\" or \"stairway to heaven\". By default only the best match is scraped.", "default": [], "items": { "type": "string" } }, "searchMode": { "title": "Search mode", "enum": [ "bestMatch", "allResults" ], "type": "string", "description": "Scrape only the best matching song per query, or every result up to the limit below.", "default": "bestMatch" }, "maxResultsPerQuery": { "title": "Max results per query", "minimum": 1, "maximum": 100, "type": "integer", "description": "Used with \"All results\" search mode.", "default": 10 }, "artists": { "title": "Artists (full catalog)", "type": "array", "description": "Artist names or numeric Songsterr artist IDs. Scrapes every song by the artist.", "default": [], "items": { "type": "string" } }, "songIds": { "title": "Song IDs", "type": "array", "description": "Numeric Songsterr song IDs (the number after \"-s\" in a song URL).", "default": [], "items": { "type": "string" } }, "maxSongsPerArtist": { "title": "Max songs per artist", "minimum": 0, "type": "integer", "description": "Limit for each artist catalog, most popular songs first. 0 means no limit.", "default": 0 }, "maxSongs": { "title": "Max songs in total", "minimum": 0, "type": "integer", "description": "Overall limit across all inputs. 0 means no limit.", "default": 0 }, "revisionId": { "title": "Specific revision ID", "minimum": 0, "type": "integer", "description": "Scrape this revision instead of the current one. Only used when exactly one song is requested. 0 means the current revision.", "default": 0 }, "downloadTracks": { "title": "Save track JSON files", "type": "boolean", "description": "Save each track's raw JSON (notes, measures, effects) as .json.", "default": true }, "trackInstruments": { "title": "Track instruments", "type": "array", "description": "Only download these kinds of tracks. The filter also applies to the generated Guitar Pro file.", "items": { "type": "string", "enum": [ "guitar", "bass", "drums", "vocals", "other" ], "enumTitles": [ "Guitar", "Bass", "Drums", "Vocals", "Other (keys, strings, ...)" ] }, "default": [ "guitar", "bass", "drums", "vocals", "other" ] }, "downloadLyrics": { "title": "Lyrics", "type": "boolean", "description": "Save lyrics.json (from the legacy lyrics file or the vocal tracks) and a plain-text lyrics.txt.", "default": true }, "downloadOriginalGp": { "title": "Original Guitar Pro file", "type": "boolean", "description": "Download the Guitar Pro file that was uploaded to Songsterr. Revisions edited in Songsterr's editor have none (see the next option).", "default": true }, "gpFallbackToOlderRevision": { "title": "Use older uploads when the current revision has no GP file", "type": "boolean", "description": "Use the newest earlier revision that was imported from Guitar Pro. That tab may be older than the current one; the output records which revision it came from.", "default": true }, "buildGpFromJson": { "title": "Build a Guitar Pro 5 file from the current tab", "type": "boolean", "description": "Convert the current revision's track JSONs into generated.gp5 (notes, rhythms, tunings, repeats, markers, tempo changes, common effects and lyrics).", "default": true }, "downloadChords": { "title": "Chords (ChordPro)", "type": "boolean", "description": "Save the chord sheet as chords.chordpro when the song has one.", "default": true }, "includeRevisionHistory": { "title": "Revision history", "type": "boolean", "description": "Save the song's full revision list as revisions.json.", "default": false }, "encodeDadaGP": { "title": "DadaGP tokens", "type": "boolean", "description": "Encode the song into DadaGP machine-learning tokens (dadagp.txt). DadaGP supports at most 3 distorted guitars, 2 clean guitars, 1 bass and drums, so the most-viewed compatible tracks are picked.", "default": false }, "dadaGpSource": { "title": "DadaGP source", "enum": [ "auto", "generated", "original" ], "type": "string", "description": "Which Guitar Pro file DadaGP encodes. \"Auto\" uses the original upload if it is GP3-GP5 and otherwise the file generated from the current tab. Most Songsterr uploads are GP7, which DadaGP cannot read.", "default": "auto" }, "bundleZip": { "title": "ZIP per song", "type": "boolean", "description": "Also save one ZIP per song containing all of the files above.", "default": true }, "maxConcurrency": { "title": "Songs scraped in parallel", "minimum": 1, "maximum": 20, "type": "integer", "description": "How many songs are scraped at the same time.", "default": 5 }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Songsterr usually works without a proxy. Turn one on if requests get blocked.", "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 }, "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 } } } } } } } } } }