StatusSupportGet API keyDashboard
Apple MusicPlaylist Search

Apple Music

Apple Music Playlist Search API

Use with AI

Searches Apple Music playlists or radio stations by keyword in any country's store and returns them a page at a time, with who curates each. A playlist has its description, Apple's one-line note, cover, track count, whether it is editorial, when it last changed and its audio format. A station has its kind, band and frequency, whether it streams live and whether only subscribers can play it.

GET /v1/applemusic/search_playlists

Try it

Example

cURL
curl 'https://socialtap.dev/v1/applemusic/search_playlists?query=workout' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
TypeScript SDK
import { SocialTap } from "socialtap";

const client = new SocialTap(); // apiKey defaults to process.env.SOCIALTAP_API_KEY

const res = await client.applemusic.searchPlaylists.list({ query: "workout" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);
Node.js (fetch)
const params = new URLSearchParams({
  query: "workout",
});
const res = await fetch(`https://socialtap.dev/v1/applemusic/search_playlists?${params}`, {
  headers: { "x-api-key": process.env.SOCIALTAP_API_KEY ?? "" },
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
const { data, page, meta } = body;
console.log(data, meta.credits_charged);
Python (requests)
import os

import requests

res = requests.get(
    "https://socialtap.dev/v1/applemusic/search_playlists",
    params={"query": "workout"},
    headers={"x-api-key": os.environ["SOCIALTAP_API_KEY"]},
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
data, page, meta = body["data"], body["page"], body["meta"]
print(data, meta["credits_charged"])
Go (net/http)
package main

import (
	"encoding/json"
	"fmt"
	"log"
	"net/http"
	"net/url"
	"os"
)

func main() {
	q := url.Values{}
	q.Set("query", "workout")
	req, err := http.NewRequest("GET", "https://socialtap.dev/v1/applemusic/search_playlists?"+q.Encode(), nil)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("x-api-key", os.Getenv("SOCIALTAP_API_KEY"))
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer res.Body.Close()
	var body struct {
		Data  json.RawMessage `json:"data"`
		Page  json.RawMessage `json:"page"`
		Meta  map[string]any  `json:"meta"`
		Error *struct {
			Code    string `json:"code"`
			Message string `json:"message"`
		} `json:"error"`
	}
	if err := json.NewDecoder(res.Body).Decode(&body); err != nil {
		log.Fatal(err)
	}
	if body.Error != nil {
		log.Fatalf("%s: %s", body.Error.Code, body.Error.Message)
	}
	fmt.Println(string(body.Data), body.Meta["credits_charged"])
}
PHP
<?php

$query = http_build_query([
    'query' => 'workout',
]);
$ch = curl_init('https://socialtap.dev/v1/applemusic/search_playlists?' . $query);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['x-api-key: ' . getenv('SOCIALTAP_API_KEY')],
]);
$body = json_decode(curl_exec($ch), true);
if (curl_getinfo($ch, CURLINFO_RESPONSE_CODE) >= 400) {
    throw new RuntimeException($body['error']['code'] . ': ' . $body['error']['message']);
}
print_r($body['data']);
echo $body['meta']['credits_charged'], PHP_EOL;
Ruby
require "json"
require "net/http"

uri = URI("https://socialtap.dev/v1/applemusic/search_playlists")
uri.query = URI.encode_www_form('query' => 'workout')
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = ENV.fetch("SOCIALTAP_API_KEY")
res = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") { |http| http.request(req) }
body = JSON.parse(res.body)
raise "#{body["error"]["code"]}: #{body["error"]["message"]}" unless res.is_a?(Net::HTTPSuccess)
pp body["data"]
puts body["meta"]["credits_charged"]
Java
import java.net.URI;
import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;

public class Main {
    public static void main(String[] args) throws Exception {
        String query = "query=" + encode("workout");
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://socialtap.dev/v1/applemusic/search_playlists?" + query))
            .header("x-api-key", System.getenv("SOCIALTAP_API_KEY"))
            .GET()
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        // An error is {"error": {"code", "message", ...}}; success is {data, meta}, meta.credits_charged its price.
        if (response.statusCode() >= 400) throw new RuntimeException(response.body());
        System.out.println(response.body());
    }

    static String encode(String value) {
        return URLEncoder.encode(value, StandardCharsets.UTF_8);
    }
}
.NET
using System.Text.Json;

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("x-api-key", Environment.GetEnvironmentVariable("SOCIALTAP_API_KEY"));

var query = string.Join("&",
    "query=" + Uri.EscapeDataString("workout"));
var res = await http.GetAsync("https://socialtap.dev/v1/applemusic/search_playlists?" + query);
using var body = JsonDocument.Parse(await res.Content.ReadAsStringAsync());
if (!res.IsSuccessStatusCode)
{
    var error = body.RootElement.GetProperty("error");
    throw new Exception($"{error.GetProperty("code")}: {error.GetProperty("message")}");
}
Console.WriteLine(body.RootElement.GetProperty("data"));
Console.WriteLine(body.RootElement.GetProperty("meta").GetProperty("credits_charged"));
Rust
// Cargo.toml: reqwest = { version = "0.12", features = ["blocking", "json"] }, serde_json = "1"
use std::env;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let res = reqwest::blocking::Client::new()
        .get("https://socialtap.dev/v1/applemusic/search_playlists")
        .query(&[("query", "workout")])
        .header("x-api-key", env::var("SOCIALTAP_API_KEY")?)
        .send()?;
    let ok = res.status().is_success();
    let body: serde_json::Value = res.json()?;
    if !ok {
        return Err(format!("{}: {}", body["error"]["code"], body["error"]["message"]).into());
    }
    println!("{} {}", body["data"], body["meta"]["credits_charged"]);
    Ok(())
}
200 OK
{
  "data": [
    {
      "approximate_fields": [],
      "description": "Here’s where you’ll find the best tunes for working out that are making the rounds online. Just like your feed, this playlist is constantly being updated—if you hear a song you like, add it to your library.",
      "id": "pl.ee26872314e349ddaa91050dadbbaaff",
      "is_collaborative": false,
      "metrics": {
        "post_count": 100
      },
      "owner": {
        "avatar_url": "https://is1-ssl.mzstatic.com/image/thumb/Features211/v4/9a/7c/44/9a7c4409-33aa-4b66-f2e7-e4362c01f490/93eac142-43a5-4614-b866-614702fc22ba.png/1080x1080bb.jpg",
        "display_name": "Apple Music Fitness",
        "id": null,
        "is_verified": null,
        "url": "https://music.apple.com/us/curator/apple-music-fitness/1558256909",
        "username": null
      },
      "platform": "applemusic",
      "platform_specific": {
        "applemusic": {
          "audio_traits": [],
          "band": null,
          "curator_id": "1558256909",
          "editorial_kind": null,
          "editorial_sub_kind": null,
          "editorial_summary": "The best tunes from your social feeds for working out.",
          "frequency": null,
          "is_chart": false,
          "is_collaborative": false,
          "is_live": null,
          "is_subscription_required": null,
          "last_modified_at": "2026-10-30T04:02:36Z",
          "media_kind": null,
          "playlist_type": "editorial",
          "rank": null,
          "station_kind": null,
          "storefront": "us"
        }
      },
      "platform_type": "playlist",
      "thumbnail_url": "https://is1-ssl.mzstatic.com/image/thumb/Features126/v4/46/9d/7b/469d7b24-d343-9f0a-27c0-2112b40dc513/d9221f7b-fe58-47c1-a1ea-2f5a19c03168.png/1080x1080SC.DN02.jpg?l=en-US",
      "title": "Viral Workout",
      "type": "playlist",
      "unknown_fields": [],
      "url": "https://music.apple.com/us/playlist/viral-workout/pl.ee26872314e349ddaa91050dadbbaaff"
    },
    {
      "approximate_fields": [],
      "description": "Get your sexy back with pop's divas, rap’s heavy hitters, and more. This playlist is updated regularly with the biggest hits of the 2000s. If you hear something you like, add it to your library.",
      "id": "pl.89b29d098bb64215a3caac990b3d80e0",
      "is_collaborative": false,
      "metrics": {
        "post_count": 100
      },
      "owner": {
        "avatar_url": "https://is1-ssl.mzstatic.com/image/thumb/Features211/v4/9a/7c/44/9a7c4409-33aa-4b66-f2e7-e4362c01f490/93eac142-43a5-4614-b866-614702fc22ba.png/1080x1080bb.jpg",
        "display_name": "Apple Music Fitness",
        "id": null,
        "is_verified": null,
        "url": "https://music.apple.com/us/curator/apple-music-fitness/1558256909",
        "username": null
      },
      "platform": "applemusic",
      "platform_specific": {
        "applemusic": {
          "audio_traits": [],
          "band": null,
          "curator_id": "1558256909",
          "editorial_kind": null,
          "editorial_sub_kind": null,
          "editorial_summary": "Get your sexy back with pop's divas, rap’s heavy hitters, and more.",
          "frequency": null,
          "is_chart": false,
          "is_collaborative": false,
          "is_live": null,
          "is_subscription_required": null,
          "last_modified_at": "2026-08-18T21:11:32Z",
          "media_kind": null,
          "playlist_type": "editorial",
          "rank": null,
          "station_kind": null,
          "storefront": "us"
        }
      },
      "platform_type": "playlist",
      "thumbnail_url": "https://is1-ssl.mzstatic.com/image/thumb/Features116/v4/40/99/84/409984d1-6457-53fe-9575-e1f173f2576c/9180e7c7-6797-4bdd-bc1c-3e6b0d010de7.png/1080x1080SC.DN02.jpg?l=en-US",
      "title": "2000s Workout",
      "type": "playlist",
      "unknown_fields": [],
      "url": "https://music.apple.com/us/playlist/2000s-workout/pl.89b29d098bb64215a3caac990b3d80e0"
    },
    {
      "approximate_fields": [],
      "description": "The best songs for getting you through that final lap or set. Our editors regularly update this playlist—if you hear something you like, add it to your library.",
      "id": "pl.4c62f568a0d64293a9c362037175c09b",
      "is_collaborative": false,
      "metrics": {
        "post_count": 139
      },
      "owner": {
        "avatar_url": "https://is1-ssl.mzstatic.com/image/thumb/Features211/v4/9a/7c/44/9a7c4409-33aa-4b66-f2e7-e4362c01f490/93eac142-43a5-4614-b866-614702fc22ba.png/1080x1080bb.jpg",
        "display_name": "Apple Music Fitness",
        "id": null,
        "is_verified": null,
        "url": "https://music.apple.com/us/curator/apple-music-fitness/1558256909",
        "username": null
      },
      "platform": "applemusic",
      "platform_specific": {
        "applemusic": {
          "audio_traits": [],
          "band": null,
          "curator_id": "1558256909",
          "editorial_kind": null,
          "editorial_sub_kind": null,
          "editorial_summary": "The best songs for getting you through that final lap or set.",
          "frequency": null,
          "is_chart": false,
          "is_collaborative": false,
          "is_live": null,
          "is_subscription_required": null,
          "last_modified_at": "2026-10-23T22:50:48Z",
          "media_kind": null,
          "playlist_type": "editorial",
          "rank": null,
          "station_kind": null,
          "storefront": "us"
        }
      },
      "platform_type": "playlist",
      "thumbnail_url": "https://is1-ssl.mzstatic.com/image/thumb/Features125/v4/b9/18/02/b9180250-a496-520c-70eb-6f01710b083d/U0MtTVMtV1ctSGlwLUhvcF9Xb3Jrb3V0LUFEQU1fSUQ9MTAwNDc4MTM5Ni5wbmc.png/1080x1080SC.DN02.jpg?l=en-US",
      "title": "Hip-Hop Workout",
      "type": "playlist",
      "unknown_fields": [],
      "url": "https://music.apple.com/us/playlist/hip-hop-workout/pl.4c62f568a0d64293a9c362037175c09b"
    }
  ],
  "page": {
    "has_more": true,
    "next_cursor": "c1.EXAMPLE_CURSOR",
    "next_cursor_expires_at": "2026-10-26T12:00:00Z",
    "end_reason": null
  },
  "meta": {
    "request_id": "req_3f9c2a7d1e8b4c6a9f0e2d4b6a8c0e1f",
    "platform": "applemusic",
    "source": "api",
    "is_cached": false,
    "credits_charged": 1,
    "latency_ms": 404,
    "fetched_at": "2026-10-25T12:00:00Z",
    "input": null,
    "credits_remaining": 9999,
    "client_request_id": null,
    "warnings": []
  }
}

Long arrays and strings are shortened for display; real responses are complete.

Authorizations

x-api-keystringheaderrequired

Your API key. Authentication

Query parameters

querystringrequiredmax 500 chars

What to search for: a playlist's or station's name, an artist, a mood, a genre, in any language. Apple matches it as its web player's search box does.

Exampleworkout

kindstring

What to list: playlists (the default) or radio stations. Both come back in the same playlist shape, and platform_type says which it is.

One ofplayliststation

Examplestation

countrystringiso3166-1-alpha-2

Region: an ISO 3166-1 alpha-2 country code such as US or BR (case-insensitive). The Apple Music store to search: the results, their titles and their links differ by store. A country with no Apple Music store returns invalid_input. Default: US. UK is read as GB.

ExampleJP

langstringbcp47

Preferred language: a BCP-47 tag such as en or pt-BR (case-insensitive; _ is read as -). The language of the answer's text, when Apple offers it beside the store's own. Default: the store's own language.

Exampleen-US

limitintegermin 1max 50

Items per page, 1 to the endpoint's page size (its default and maximum; larger values are reduced to it). Omit it: every page costs the same, so a smaller limit means more pages to pay for.

Example50

cursorstring

page.next_cursor from the previous response. Send the same other parameters; omit to start from the first page.

Unknown parameters are rejected with a suggestion, never ignored (Requests). limit and cursor page through the list: see Pagination.

Parameters every endpoint accepts
max_ageintegermin 0

Accept a cached response up to this many seconds old. Cache hits cost 0 credits. Omit to always fetch fresh. The Cache-Control: max-age=N request header is equivalent; max_age wins when both are sent.

fieldsstring

Return only these fields of each item: comma-separated paths in the schema's notation (id,text,metrics.view_count,segments[].text; a parent path keeps the whole object). Unknown paths are rejected. Applied after the cache, so it changes neither the price nor cache hits; page and meta are always returned whole.

Response

application/json

200

{data, page, meta}. data is an array of up to 50 playlist objects, Apple Music's own relevance order for the query; page says how to get the next page; meta describes the request (meta). Fields only Apple Music has are under platform_specific.applemusic.

platformstring

Platform ID (tiktok, youtube, facebook, …).

idstring

Platform-native playlist ID (string): TikTok's playlist (mix) or collection ID, YouTube's list ID (PL…), Facebook's video list ID.

urlstring uri

Canonical playlist URL.

typestring

playlist: a list its owner curates and orders (TikTok playlists, YouTube playlists, Facebook playlists and series); collection: posts an account saved from any creator into a named public folder (TikTok collections). New values may be added; treat unknown values as playlist.

One ofplaylistcollection

platform_typestringnullable

The platform's own label, lowercase (mix, collection, playlist, series, podcast, …).

titlestringnullable

Name its owner gave it.

descriptionstringnullable

Description as plain text; null when it has none or the platform shows none (TikTok).

ownerobject

The account that curates it (for a collection, the account that saved the posts, not their authors). Where a platform's curators are not accounts (Apple Music), what it states of them: a name, perhaps a page and a picture, with id and username null, and every field null when it names no one.

ShowHide 6 child fields
idstringnullable

Platform-native account ID; null when only the handle is known.

usernamestringnullable

Handle without the @; null when the account has none.

display_namestringnullable

Display name shown on the profile.

urlstring urinullable

Canonical profile URL.

avatar_urlstring urinullable

Profile picture URL. Platform CDN URLs can expire within hours.

is_verifiedbooleannullable

Platform verification badge; null where the platform has no badge.

thumbnail_urlstring urinullable

Cover image URL (the owner's chosen cover, else the platform's pick, often the first post's). Platform CDN URLs can expire within hours.

is_collaborativebooleannullable

Whether people its owner invites can add to it as well (a collaborative playlist, a group board); null where the platform doesn't say.

metricsobject

Counts at fetch time; null = hidden or not exposed, 0 = zero.

ShowHide 1 child field
post_countintegernullable

Posts in it as the platform counts them (it may count posts that are no longer public, so a walk of its posts can return fewer).

platform_specificobject

Fields only this platform has, under its ID (platform_specific.<platform>); each null when unknown.

ShowHide 1 child field
applemusicobjectnullable

An Apple Music playlist's or station's own fields.

ShowHide 17 child fields
storefrontstringnullable

The Apple Music store this answer is from, as a lowercase country code (us, jp).

rankintegernullable

Position on the requested chart (1 = top); null off a chart.

editorial_summarystringnullable

Apple's one-line note on it; null when none.

curator_idstringnullable

Apple's ID of the playlist's curator; null when none is linked, as on a station.

playlist_typestringnullable

Who makes the playlist, as Apple says: editorial, external (a curator's), personal-mix, user-shared, …; null on a station. New values may be added.

editorial_kindstringnullable

What Apple says an editorial playlist is built around: artist-franchise (one artist, such as their Essentials or a set list); null when it says nothing, and on a station. New values may be added.

editorial_sub_kindstringnullable

Apple's finer word for that: artist-set-list, artist-created-set-list; null when it says nothing, and on a station. New values may be added.

last_modified_atstring date-timenullable

When the playlist last changed, RFC 3339 UTC; null on a station.

is_chartbooleannullable

The playlist is one of Apple's charts; null on a station.

is_collaborativebooleannullable

Several people edit the playlist; null on a station.

audio_traitsstring[]

The audio formats the playlist comes in; [] on a station or when none. New values may be added.

station_kindstringnullable

A station's kind as Apple says: streaming (a live stream), artistOnly, songSeeded, …; null on a playlist. New values may be added.

media_kindstringnullable

A station's medium, audio or video; null on a playlist.

bandstringnullable

How a live station is carried, as Apple says: FM, AM, DAB, Sat, Stream, …; null when it says nothing, and on a playlist. New values may be added.

frequencystringnullable

A broadcast station's frequency as Apple states it, in its band's usual unit (90.1 on FM, 1026 on AM); a station on several frequencies lists them separated by / (105.1/105.3/105.7); null when it states none, and on a playlist.

is_livebooleannullable

A station that streams live rather than picking songs; null on a playlist.

is_subscription_requiredbooleannullable

A station only subscribers can play; null on a playlist.

approximate_fieldsstring[]

JSON paths of values rounded by the platform, date-only or parsed from display text. [] when all exact.

unknown_fieldsstring[]

JSON paths of lists whose [] means unknown rather than none (a source that cannot see them); null already means unknown for every other field. [] when every list is known.

not_found and private_or_unavailable are item-level: the request was fine, the item can't be returned.

400

400 Bad Request: 2 error codes. Free: errors cost nothing.

invalid_inputNo retry

A parameter is missing or malformed, or the link is not one this endpoint takes.

Fix the parameter named in param as the message says. For a link of the wrong kind, call an endpoint listed in details.endpoints, when there is one.

invalid_cursorNo retry

The cursor is malformed or expired, belongs to another endpoint, or came with other parameters than the request that returned it.

Repeat the original request without cursor to start the list again.

401

401 Unauthorized: 1 error code. Free: errors cost nothing.

unauthorizedNo retry

The x-api-key header is missing, or its key is unknown or revoked. On the dashboard's routes: the session cookie is missing or expired.

Send a valid API key in the x-api-key header. No key yet? A person gets one at details.signup_url; an AI agent follows details.agent_auth_url.

402

402 Payment Required: 2 error codes. Free: errors cost nothing.

insufficient_creditsNo retry

The account does not have enough credits for this request.

Have a person buy credits at details.purchase_url (or make them a checkout link with details.checkout), then repeat the request. Do not retry automatically.

spend_limit_reachedNo retry

The API key reached its spend limit for this period. The account may still have credits.

Wait until details.resets_at, or raise the key's spend limit (PATCH /v1/api_keys/{id}). Do not retry automatically.

403

403 Forbidden: 2 error codes. Free: errors cost nothing.

forbiddenNo retry

The API key is valid but may not make this request, and details.reason says why: the account is suspended, the key lacks the route's scope, waits for its owner to confirm it by email, has expired, or was used from an IP outside its allowlist, or a rotated key's previous secret was used for a call that needs the admin scope. A running job stops with it too when its account is suspended or the key that created it is revoked or expires. It is about the key, never the item: a private item is private_or_unavailable, also 403, so branch on the code.

Act on details.reason. suspended: contact support. scope: use a key with details.required_scope. previous_secret: use the new secret. key_pending: have the owner open the emailed link. key_expired or key_revoked: create a new key. ip_not_allowed: call from an allowed IP.

private_or_unavailableNo retry

The item exists but is not public: it is private, age- or region-restricted, or needs a login to view. It shares 403 with forbidden (which is about the key), so branch on the code.

Only public items can be fetched. Do not retry.

404

404 Not Found: 1 error code. Free: errors cost nothing.

not_foundNo retry

The item does not exist or was deleted. On GET /v1/requests/{id}/response: the response was not kept (details.reason says why).

Check the link or ID. Do not retry.

429

429 Too Many Requests: 1 error code. Free: errors cost nothing.

rate_limitedYes, later

The account passed its runaway-protection ceiling: a high per-account limit that stops a broken client loop (plans have no rate limit). Requests without an API key (signup, the MCP server's tool listing and find_endpoint) are limited per IP address instead. It also stops an account whose failed requests in the last hour cost far more than its successful ones paid for: failures are free within a limit (the message says so), and successes raise it.

Wait the seconds in the retry-after header, then retry. If your steady traffic needs more, ask support to raise the ceiling; without an API key, send one.

500

500 Internal Error: 1 error code. Free: errors cost nothing.

internalYes, later

An unexpected error on SocialTap's side.

Retry with backoff. If it keeps happening, contact support with the request_id.

502

502 Bad Gateway: 1 error code. Free: errors cost nothing.

upstream_errorYes, later

The platform failed, or answered with something we could not read.

Retry with backoff. Failed requests are free.

503

503 Unavailable: 2 error codes. Free: errors cost nothing.

upstream_blockedYes, later

The platform refused every attempt, our own retries included.

Retry later with backoff. Failed requests are free.

overloadedYes, later

SocialTap was at capacity, or paused by its operators, and did not start the request. Nothing was fetched or charged.

Retry after the seconds in the retry-after header. Failed requests are free.

Pagination

Items come in pages, Apple Music's own relevance order for the query. To get the next page, send the same request plus cursor set to page.next_cursor from the previous response. Keep every other parameter the same (limit, max_age and fields may change); anything else that differs is rejected. When page.has_more is false the walk is over, and page.end_reason says why: only end means you have every item (the others say the platform or a page cap stopped the walk early).

Order
Apple Music's own relevance order for the query
Page size
Up to 50 playlists and radio stations (the default; limit lowers it)
Cursor lifetime
24 hours; don't store cursors
Price
Per page, 1 credit

The page object

has_moreboolean

True when another page exists; then next_cursor is set. An empty page with has_more true is not the end.

next_cursorstringnullable

Pass as cursor, with the same other parameters, to get the next page; null at the end.

next_cursor_expires_atstring date-timenullable

When next_cursor stops working, RFC 3339 UTC; null at the end. Don't store cursors.

end_reasonstringnullable

Why there are no more pages; null while has_more is true. end: the list ended, or reached since/until. platform_limit: the platform stops serving further pages although the list goes on. max_pages: SocialTap's cap on pages in one walk. New values may be added. A short or empty page is not the end: only has_more false is.

One ofendplatform_limitmax_pages

Next page

cURL: next page
curl 'https://socialtap.dev/v1/applemusic/search_playlists?query=workout&cursor=c1.EXAMPLE_CURSOR' \
  -H "x-api-key: $SOCIALTAP_API_KEY"
  • The price is per page: each successful page costs the same, whatever limit is and however many items it has. Empty pages are charged too (an empty page with has_more: true is not the end).
  • A limit below 50 doesn't save credits: the next request serves the rest of the same platform page, which is fetched again and charged as a page each time, and items can shift between those requests if the platform changes the list. Omitting limit is the cheapest way to walk the list.
  • Errors are free, including a rejected cursor.
  • Pages served from the cache are free.
  • An expired or altered cursor, or one sent with different parameters, fails with invalid_cursor (HTTP 400): Repeat the original request without cursor to start the list again.

Pagination guide

Pricing

From 1 credit per page. Charged per successful page, whatever its number of items. Errors are free. The price depends on the source that produced the result, reported as meta.source.

SourcePrice per successful pagePer 1,000 pages
Platform API api1 credit$0.75–$1.97
Balance, sources and what you were charged

Your balance must be at least 1 credit to start a request; with less, it is refused with insufficient_credits (HTTP 402) and costs nothing. Only that minimum is set aside when the request starts.

meta.sourceSourceWhat it means
apiPlatform APIThe platform's public, logged-out API.

meta.credits_charged and the x-credits-charged header show what you paid. How credits work · Packs

Endpoint ID applemusic.search_playlists · operationId applemusic.search_playlists.list · Product overview

Last updated