/spotify/playlists

POST /api/spotify/playlists

Price: 5 credits

Get Spotify playlist details and tracks by id, URL or URI

How to use it

Get a Spotify playlist by playlist id, URL or URI. Returns playlist name, description, owner, save count, cover image, total track count and the tracks (each with the date it was added, artists, album, duration and play count).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• playlist string required — Spotify playlist id, URL or URI (examples: "37i9dQZF1DXcBWIGoYBM5M", "https://open.spotify.com/playlist/37i9dQZF1DXcBWIGoYBM5M", "spotify:playlist:37i9dQZF1DXcBWIGoYBM5M"; minLength: 1)
• count integer required — Max number of tracks to return (min: 1)

Response

• @type string (default: "SpotifyPlaylist")
• id string required
• name string nullable
• uri string required
• url string required
• description string nullable
• save_count integer nullable
• total_track_count integer nullable
• image string nullable
• owner object nullable
  • @type string (default: "SpotifyOwnerRef")
  • id string required
  • name string nullable
  • uri string required
  • url string required
  • alias string nullable
  • image string nullable
• tracks array (default: [])
  • @type string (default: "SpotifyPlaylistTrack")
  • added_at string nullable
  • track object required
    • @type string (default: "SpotifyTrack")
    • id string required
    • name string nullable
    • uri string required
    • url string required
    • duration_seconds integer nullable
    • play_count integer nullable
    • track_number integer nullable
    • disc_number integer nullable
    • is_explicit boolean (default: false)
    • is_playable boolean (default: false)
    • has_video boolean (default: false)
    • artists array (default: [])
    • album object nullable
      • @type string (default: "SpotifyAlbumRef")
      • id string required
      • name string nullable
      • uri string required
      • url string required
      • album_type string nullable
      • label string nullable
      • release_date string nullable
      • release_year integer nullable
      • total_track_count integer nullable
      • image string nullable
      • artists array (default: [])
    • image string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Playlist not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.